system.cc revision 12443:0479f5e6f8bd 
1/*
2 * Copyright (c) 2011-2014,2017 ARM Limited
3 * All rights reserved
4 *
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder.  You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
13 *
14 * Copyright (c) 2003-2006 The Regents of The University of Michigan
15 * Copyright (c) 2011 Regents of the University of California
16 * All rights reserved.
17 *
18 * Redistribution and use in source and binary forms, with or without
19 * modification, are permitted provided that the following conditions are
20 * met: redistributions of source code must retain the above copyright
21 * notice, this list of conditions and the following disclaimer;
22 * redistributions in binary form must reproduce the above copyright
23 * notice, this list of conditions and the following disclaimer in the
24 * documentation and/or other materials provided with the distribution;
25 * neither the name of the copyright holders nor the names of its
26 * contributors may be used to endorse or promote products derived from
27 * this software without specific prior written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
30 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
31 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
32 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
33 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
34 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
35 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
36 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
37 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
38 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
39 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40 *
41 * Authors: Steve Reinhardt
42 *          Lisa Hsu
43 *          Nathan Binkert
44 *          Ali Saidi
45 *          Rick Strong
46 */
47
48#include "sim/system.hh"
49
50#include "arch/remote_gdb.hh"
51#include "arch/utility.hh"
52#include "base/loader/object_file.hh"
53#include "base/loader/symtab.hh"
54#include "base/str.hh"
55#include "base/trace.hh"
56#include "config/use_kvm.hh"
57#if USE_KVM
58#include "cpu/kvm/base.hh"
59#include "cpu/kvm/vm.hh"
60#endif
61#include "cpu/base.hh"
62#include "cpu/thread_context.hh"
63#include "debug/Loader.hh"
64#include "debug/WorkItems.hh"
65#include "mem/abstract_mem.hh"
66#include "mem/physical.hh"
67#include "params/System.hh"
68#include "sim/byteswap.hh"
69#include "sim/debug.hh"
70#include "sim/full_system.hh"
71
72/**
73 * To avoid linking errors with LTO, only include the header if we
74 * actually have a definition.
75 */
76#if THE_ISA != NULL_ISA
77#include "kern/kernel_stats.hh"
78
79#endif
80
81using namespace std;
82using namespace TheISA;
83
84vector<System *> System::systemList;
85
86int System::numSystemsRunning = 0;
87
88System::System(Params *p)
89    : MemObject(p), _systemPort("system_port", this),
90      _numContexts(0),
91      multiThread(p->multi_thread),
92      pagePtr(0),
93      init_param(p->init_param),
94      physProxy(_systemPort, p->cache_line_size),
95      kernelSymtab(nullptr),
96      kernel(nullptr),
97      loadAddrMask(p->load_addr_mask),
98      loadAddrOffset(p->load_offset),
99#if USE_KVM
100      kvmVM(p->kvm_vm),
101#else
102      kvmVM(nullptr),
103#endif
104      physmem(name() + ".physmem", p->memories, p->mmap_using_noreserve),
105      memoryMode(p->mem_mode),
106      _cacheLineSize(p->cache_line_size),
107      workItemsBegin(0),
108      workItemsEnd(0),
109      numWorkIds(p->num_work_ids),
110      thermalModel(p->thermal_model),
111      _params(p),
112      totalNumInsts(0),
113      instEventQueue("system instruction-based event queue")
114{
115    // add self to global system list
116    systemList.push_back(this);
117
118#if USE_KVM
119    if (kvmVM) {
120        kvmVM->setSystem(this);
121    }
122#endif
123
124    if (FullSystem) {
125        kernelSymtab = new SymbolTable;
126        if (!debugSymbolTable)
127            debugSymbolTable = new SymbolTable;
128    }
129
130    // check if the cache line size is a value known to work
131    if (!(_cacheLineSize == 16 || _cacheLineSize == 32 ||
132          _cacheLineSize == 64 || _cacheLineSize == 128))
133        warn_once("Cache line size is neither 16, 32, 64 nor 128 bytes.\n");
134
135    // Get the generic system master IDs
136    MasterID tmp_id M5_VAR_USED;
137    tmp_id = getMasterId("writebacks");
138    assert(tmp_id == Request::wbMasterId);
139    tmp_id = getMasterId("functional");
140    assert(tmp_id == Request::funcMasterId);
141    tmp_id = getMasterId("interrupt");
142    assert(tmp_id == Request::intMasterId);
143
144    if (FullSystem) {
145        if (params()->kernel == "") {
146            inform("No kernel set for full system simulation. "
147                   "Assuming you know what you're doing\n");
148        } else {
149            // Get the kernel code
150            kernel = createObjectFile(params()->kernel);
151            inform("kernel located at: %s", params()->kernel);
152
153            if (kernel == NULL)
154                fatal("Could not load kernel file %s", params()->kernel);
155
156            // setup entry points
157            kernelStart = kernel->textBase();
158            kernelEnd = kernel->bssBase() + kernel->bssSize();
159            kernelEntry = kernel->entryPoint();
160
161            // If load_addr_mask is set to 0x0, then auto-calculate
162            // the smallest mask to cover all kernel addresses so gem5
163            // can relocate the kernel to a new offset.
164            if (loadAddrMask == 0) {
165                Addr shift_amt = findMsbSet(kernelEnd - kernelStart) + 1;
166                loadAddrMask = ((Addr)1 << shift_amt) - 1;
167            }
168
169            // load symbols
170            if (!kernel->loadGlobalSymbols(kernelSymtab))
171                fatal("could not load kernel symbols\n");
172
173            if (!kernel->loadLocalSymbols(kernelSymtab))
174                fatal("could not load kernel local symbols\n");
175
176            if (!kernel->loadGlobalSymbols(debugSymbolTable))
177                fatal("could not load kernel symbols\n");
178
179            if (!kernel->loadLocalSymbols(debugSymbolTable))
180                fatal("could not load kernel local symbols\n");
181
182            // Loading only needs to happen once and after memory system is
183            // connected so it will happen in initState()
184        }
185
186        for (const auto &obj_name : p->kernel_extras) {
187            inform("Loading additional kernel object: %s", obj_name);
188            ObjectFile *obj = createObjectFile(obj_name);
189            fatal_if(!obj, "Failed to additional kernel object '%s'.\n",
190                     obj_name);
191            kernelExtras.push_back(obj);
192        }
193    }
194
195    // increment the number of running systems
196    numSystemsRunning++;
197
198    // Set back pointers to the system in all memories
199    for (int x = 0; x < params()->memories.size(); x++)
200        params()->memories[x]->system(this);
201}
202
203System::~System()
204{
205    delete kernelSymtab;
206    delete kernel;
207
208    for (uint32_t j = 0; j < numWorkIds; j++)
209        delete workItemStats[j];
210}
211
212void
213System::init()
214{
215    // check that the system port is connected
216    if (!_systemPort.isConnected())
217        panic("System port on %s is not connected.\n", name());
218}
219
220BaseMasterPort&
221System::getMasterPort(const std::string &if_name, PortID idx)
222{
223    // no need to distinguish at the moment (besides checking)
224    return _systemPort;
225}
226
227void
228System::setMemoryMode(Enums::MemoryMode mode)
229{
230    assert(drainState() == DrainState::Drained);
231    memoryMode = mode;
232}
233
234bool System::breakpoint()
235{
236    if (remoteGDB.size())
237        return remoteGDB[0]->breakpoint();
238    return false;
239}
240
241ContextID
242System::registerThreadContext(ThreadContext *tc, ContextID assigned)
243{
244    int id = assigned;
245    if (id == InvalidContextID) {
246        // Find an unused context ID for this thread.
247        id = 0;
248        while (id < threadContexts.size() && threadContexts[id])
249            id++;
250    }
251
252    if (threadContexts.size() <= id)
253        threadContexts.resize(id + 1);
254
255    fatal_if(threadContexts[id],
256             "Cannot have two CPUs with the same id (%d)\n", id);
257
258    threadContexts[id] = tc;
259    _numContexts++;
260
261#if THE_ISA != NULL_ISA
262    int port = getRemoteGDBPort();
263    if (port) {
264        RemoteGDB *rgdb = new RemoteGDB(this, tc);
265        GDBListener *gdbl = new GDBListener(rgdb, port + id);
266        gdbl->listen();
267
268        BaseCPU *cpu = tc->getCpuPtr();
269        if (cpu->waitForRemoteGDB()) {
270            inform("%s: Waiting for a remote GDB connection on port %d.\n",
271                   cpu->name(), gdbl->getPort());
272
273            gdbl->accept();
274        }
275        if (remoteGDB.size() <= id) {
276            remoteGDB.resize(id + 1);
277        }
278
279        remoteGDB[id] = rgdb;
280    }
281#endif
282
283    activeCpus.push_back(false);
284
285    return id;
286}
287
288int
289System::numRunningContexts()
290{
291    int running = 0;
292    for (int i = 0; i < _numContexts; ++i) {
293        if (threadContexts[i]->status() != ThreadContext::Halted)
294            ++running;
295    }
296    return running;
297}
298
299void
300System::initState()
301{
302    if (FullSystem) {
303        for (int i = 0; i < threadContexts.size(); i++)
304            TheISA::startupCPU(threadContexts[i], i);
305        // Moved from the constructor to here since it relies on the
306        // address map being resolved in the interconnect
307        /**
308         * Load the kernel code into memory
309         */
310        if (params()->kernel != "")  {
311            if (params()->kernel_addr_check) {
312                // Validate kernel mapping before loading binary
313                if (!(isMemAddr((kernelStart & loadAddrMask) +
314                                loadAddrOffset) &&
315                      isMemAddr((kernelEnd & loadAddrMask) +
316                                loadAddrOffset))) {
317                    fatal("Kernel is mapped to invalid location (not memory). "
318                          "kernelStart 0x(%x) - kernelEnd 0x(%x) %#x:%#x\n",
319                          kernelStart,
320                          kernelEnd, (kernelStart & loadAddrMask) +
321                          loadAddrOffset,
322                          (kernelEnd & loadAddrMask) + loadAddrOffset);
323                }
324            }
325            // Load program sections into memory
326            kernel->loadSections(physProxy, loadAddrMask, loadAddrOffset);
327            for (const auto &extra_kernel : kernelExtras) {
328                extra_kernel->loadSections(physProxy, loadAddrMask,
329                                           loadAddrOffset);
330            }
331
332            DPRINTF(Loader, "Kernel start = %#x\n", kernelStart);
333            DPRINTF(Loader, "Kernel end   = %#x\n", kernelEnd);
334            DPRINTF(Loader, "Kernel entry = %#x\n", kernelEntry);
335            DPRINTF(Loader, "Kernel loaded...\n");
336        }
337    }
338}
339
340void
341System::replaceThreadContext(ThreadContext *tc, ContextID context_id)
342{
343    if (context_id >= threadContexts.size()) {
344        panic("replaceThreadContext: bad id, %d >= %d\n",
345              context_id, threadContexts.size());
346    }
347
348    threadContexts[context_id] = tc;
349    if (context_id < remoteGDB.size())
350        remoteGDB[context_id]->replaceThreadContext(tc);
351}
352
353bool
354System::validKvmEnvironment() const
355{
356#if USE_KVM
357    if (threadContexts.empty())
358        return false;
359
360    for (auto tc : threadContexts) {
361        if (dynamic_cast<BaseKvmCPU*>(tc->getCpuPtr()) == nullptr) {
362            return false;
363        }
364    }
365    return true;
366#else
367    return false;
368#endif
369}
370
371Addr
372System::allocPhysPages(int npages)
373{
374    Addr return_addr = pagePtr << PageShift;
375    pagePtr += npages;
376
377    Addr next_return_addr = pagePtr << PageShift;
378
379    AddrRange m5opRange(0xffff0000, 0xffffffff);
380    if (m5opRange.contains(next_return_addr)) {
381        warn("Reached m5ops MMIO region\n");
382        return_addr = 0xffffffff;
383        pagePtr = 0xffffffff >> PageShift;
384    }
385
386    if ((pagePtr << PageShift) > physmem.totalSize())
387        fatal("Out of memory, please increase size of physical memory.");
388    return return_addr;
389}
390
391Addr
392System::memSize() const
393{
394    return physmem.totalSize();
395}
396
397Addr
398System::freeMemSize() const
399{
400   return physmem.totalSize() - (pagePtr << PageShift);
401}
402
403bool
404System::isMemAddr(Addr addr) const
405{
406    return physmem.isMemAddr(addr);
407}
408
409void
410System::drainResume()
411{
412    totalNumInsts = 0;
413}
414
415void
416System::serialize(CheckpointOut &cp) const
417{
418    if (FullSystem)
419        kernelSymtab->serialize("kernel_symtab", cp);
420    SERIALIZE_SCALAR(pagePtr);
421    serializeSymtab(cp);
422
423    // also serialize the memories in the system
424    physmem.serializeSection(cp, "physmem");
425}
426
427
428void
429System::unserialize(CheckpointIn &cp)
430{
431    if (FullSystem)
432        kernelSymtab->unserialize("kernel_symtab", cp);
433    UNSERIALIZE_SCALAR(pagePtr);
434    unserializeSymtab(cp);
435
436    // also unserialize the memories in the system
437    physmem.unserializeSection(cp, "physmem");
438}
439
440void
441System::regStats()
442{
443    MemObject::regStats();
444
445    for (uint32_t j = 0; j < numWorkIds ; j++) {
446        workItemStats[j] = new Stats::Histogram();
447        stringstream namestr;
448        ccprintf(namestr, "work_item_type%d", j);
449        workItemStats[j]->init(20)
450                         .name(name() + "." + namestr.str())
451                         .desc("Run time stat for" + namestr.str())
452                         .prereq(*workItemStats[j]);
453    }
454}
455
456void
457System::workItemEnd(uint32_t tid, uint32_t workid)
458{
459    std::pair<uint32_t,uint32_t> p(tid, workid);
460    if (!lastWorkItemStarted.count(p))
461        return;
462
463    Tick samp = curTick() - lastWorkItemStarted[p];
464    DPRINTF(WorkItems, "Work item end: %d\t%d\t%lld\n", tid, workid, samp);
465
466    if (workid >= numWorkIds)
467        fatal("Got workid greater than specified in system configuration\n");
468
469    workItemStats[workid]->sample(samp);
470    lastWorkItemStarted.erase(p);
471}
472
473void
474System::printSystems()
475{
476    ios::fmtflags flags(cerr.flags());
477
478    vector<System *>::iterator i = systemList.begin();
479    vector<System *>::iterator end = systemList.end();
480    for (; i != end; ++i) {
481        System *sys = *i;
482        cerr << "System " << sys->name() << ": " << hex << sys << endl;
483    }
484
485    cerr.flags(flags);
486}
487
488void
489printSystems()
490{
491    System::printSystems();
492}
493
494MasterID
495System::getMasterId(std::string master_name)
496{
497    // strip off system name if the string starts with it
498    if (startswith(master_name, name()))
499        master_name = master_name.erase(0, name().size() + 1);
500
501    // CPUs in switch_cpus ask for ids again after switching
502    for (int i = 0; i < masterIds.size(); i++) {
503        if (masterIds[i] == master_name) {
504            return i;
505        }
506    }
507
508    // Verify that the statistics haven't been enabled yet
509    // Otherwise objects will have sized their stat buckets and
510    // they will be too small
511
512    if (Stats::enabled()) {
513        fatal("Can't request a masterId after regStats(). "
514                "You must do so in init().\n");
515    }
516
517    masterIds.push_back(master_name);
518
519    return masterIds.size() - 1;
520}
521
522std::string
523System::getMasterName(MasterID master_id)
524{
525    if (master_id >= masterIds.size())
526        fatal("Invalid master_id passed to getMasterName()\n");
527
528    return masterIds[master_id];
529}
530
531System *
532SystemParams::create()
533{
534    return new System(this);
535}
536