system.cc revision 11522:348411ec525a 
1/*
2 * Copyright (c) 2011-2014 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 "arch/remote_gdb.hh"
49#include "arch/utility.hh"
50#include "base/loader/object_file.hh"
51#include "base/loader/symtab.hh"
52#include "base/str.hh"
53#include "base/trace.hh"
54#include "cpu/thread_context.hh"
55#include "debug/Loader.hh"
56#include "debug/WorkItems.hh"
57#include "mem/abstract_mem.hh"
58#include "mem/physical.hh"
59#include "params/System.hh"
60#include "sim/byteswap.hh"
61#include "sim/debug.hh"
62#include "sim/full_system.hh"
63#include "sim/system.hh"
64
65/**
66 * To avoid linking errors with LTO, only include the header if we
67 * actually have a definition.
68 */
69#if THE_ISA != NULL_ISA
70#include "kern/kernel_stats.hh"
71#endif
72
73using namespace std;
74using namespace TheISA;
75
76vector<System *> System::systemList;
77
78int System::numSystemsRunning = 0;
79
80System::System(Params *p)
81    : MemObject(p), _systemPort("system_port", this),
82      _numContexts(0),
83      multiThread(p->multi_thread),
84      pagePtr(0),
85      init_param(p->init_param),
86      physProxy(_systemPort, p->cache_line_size),
87      kernelSymtab(nullptr),
88      kernel(nullptr),
89      loadAddrMask(p->load_addr_mask),
90      loadAddrOffset(p->load_offset),
91      nextPID(0),
92      physmem(name() + ".physmem", p->memories, p->mmap_using_noreserve),
93      memoryMode(p->mem_mode),
94      _cacheLineSize(p->cache_line_size),
95      workItemsBegin(0),
96      workItemsEnd(0),
97      numWorkIds(p->num_work_ids),
98      thermalModel(p->thermal_model),
99      _params(p),
100      totalNumInsts(0),
101      instEventQueue("system instruction-based event queue")
102{
103    // add self to global system list
104    systemList.push_back(this);
105
106    if (FullSystem) {
107        kernelSymtab = new SymbolTable;
108        if (!debugSymbolTable)
109            debugSymbolTable = new SymbolTable;
110    }
111
112    // check if the cache line size is a value known to work
113    if (!(_cacheLineSize == 16 || _cacheLineSize == 32 ||
114          _cacheLineSize == 64 || _cacheLineSize == 128))
115        warn_once("Cache line size is neither 16, 32, 64 nor 128 bytes.\n");
116
117    // Get the generic system master IDs
118    MasterID tmp_id M5_VAR_USED;
119    tmp_id = getMasterId("writebacks");
120    assert(tmp_id == Request::wbMasterId);
121    tmp_id = getMasterId("functional");
122    assert(tmp_id == Request::funcMasterId);
123    tmp_id = getMasterId("interrupt");
124    assert(tmp_id == Request::intMasterId);
125
126    if (FullSystem) {
127        if (params()->kernel == "") {
128            inform("No kernel set for full system simulation. "
129                   "Assuming you know what you're doing\n");
130        } else {
131            // Get the kernel code
132            kernel = createObjectFile(params()->kernel);
133            inform("kernel located at: %s", params()->kernel);
134
135            if (kernel == NULL)
136                fatal("Could not load kernel file %s", params()->kernel);
137
138            // setup entry points
139            kernelStart = kernel->textBase();
140            kernelEnd = kernel->bssBase() + kernel->bssSize();
141            kernelEntry = kernel->entryPoint();
142
143            // load symbols
144            if (!kernel->loadGlobalSymbols(kernelSymtab))
145                fatal("could not load kernel symbols\n");
146
147            if (!kernel->loadLocalSymbols(kernelSymtab))
148                fatal("could not load kernel local symbols\n");
149
150            if (!kernel->loadGlobalSymbols(debugSymbolTable))
151                fatal("could not load kernel symbols\n");
152
153            if (!kernel->loadLocalSymbols(debugSymbolTable))
154                fatal("could not load kernel local symbols\n");
155
156            // Loading only needs to happen once and after memory system is
157            // connected so it will happen in initState()
158        }
159    }
160
161    // increment the number of running systms
162    numSystemsRunning++;
163
164    // Set back pointers to the system in all memories
165    for (int x = 0; x < params()->memories.size(); x++)
166        params()->memories[x]->system(this);
167}
168
169System::~System()
170{
171    delete kernelSymtab;
172    delete kernel;
173
174    for (uint32_t j = 0; j < numWorkIds; j++)
175        delete workItemStats[j];
176}
177
178void
179System::init()
180{
181    // check that the system port is connected
182    if (!_systemPort.isConnected())
183        panic("System port on %s is not connected.\n", name());
184}
185
186BaseMasterPort&
187System::getMasterPort(const std::string &if_name, PortID idx)
188{
189    // no need to distinguish at the moment (besides checking)
190    return _systemPort;
191}
192
193void
194System::setMemoryMode(Enums::MemoryMode mode)
195{
196    assert(drainState() == DrainState::Drained);
197    memoryMode = mode;
198}
199
200bool System::breakpoint()
201{
202    if (remoteGDB.size())
203        return remoteGDB[0]->breakpoint();
204    return false;
205}
206
207/**
208 * Setting rgdb_wait to a positive integer waits for a remote debugger to
209 * connect to that context ID before continuing.  This should really
210   be a parameter on the CPU object or something...
211 */
212int rgdb_wait = -1;
213
214ContextID
215System::registerThreadContext(ThreadContext *tc, ContextID assigned)
216{
217    int id;
218    if (assigned == InvalidContextID) {
219        for (id = 0; id < threadContexts.size(); id++) {
220            if (!threadContexts[id])
221                break;
222        }
223
224        if (threadContexts.size() <= id)
225            threadContexts.resize(id + 1);
226    } else {
227        if (threadContexts.size() <= assigned)
228            threadContexts.resize(assigned + 1);
229        id = assigned;
230    }
231
232    if (threadContexts[id])
233        fatal("Cannot have two CPUs with the same id (%d)\n", id);
234
235    threadContexts[id] = tc;
236    _numContexts++;
237
238#if THE_ISA != NULL_ISA
239    int port = getRemoteGDBPort();
240    if (port) {
241        RemoteGDB *rgdb = new RemoteGDB(this, tc);
242        GDBListener *gdbl = new GDBListener(rgdb, port + id);
243        gdbl->listen();
244
245        if (rgdb_wait != -1 && rgdb_wait == id)
246            gdbl->accept();
247
248        if (remoteGDB.size() <= id) {
249            remoteGDB.resize(id + 1);
250        }
251
252        remoteGDB[id] = rgdb;
253    }
254#endif
255
256    activeCpus.push_back(false);
257
258    return id;
259}
260
261int
262System::numRunningContexts()
263{
264    int running = 0;
265    for (int i = 0; i < _numContexts; ++i) {
266        if (threadContexts[i]->status() != ThreadContext::Halted)
267            ++running;
268    }
269    return running;
270}
271
272void
273System::initState()
274{
275    if (FullSystem) {
276        for (int i = 0; i < threadContexts.size(); i++)
277            TheISA::startupCPU(threadContexts[i], i);
278        // Moved from the constructor to here since it relies on the
279        // address map being resolved in the interconnect
280        /**
281         * Load the kernel code into memory
282         */
283        if (params()->kernel != "")  {
284            if (params()->kernel_addr_check) {
285                // Validate kernel mapping before loading binary
286                if (!(isMemAddr((kernelStart & loadAddrMask) +
287                                loadAddrOffset) &&
288                      isMemAddr((kernelEnd & loadAddrMask) +
289                                loadAddrOffset))) {
290                    fatal("Kernel is mapped to invalid location (not memory). "
291                          "kernelStart 0x(%x) - kernelEnd 0x(%x) %#x:%#x\n",
292                          kernelStart,
293                          kernelEnd, (kernelStart & loadAddrMask) +
294                          loadAddrOffset,
295                          (kernelEnd & loadAddrMask) + loadAddrOffset);
296                }
297            }
298            // Load program sections into memory
299            kernel->loadSections(physProxy, loadAddrMask, loadAddrOffset);
300
301            DPRINTF(Loader, "Kernel start = %#x\n", kernelStart);
302            DPRINTF(Loader, "Kernel end   = %#x\n", kernelEnd);
303            DPRINTF(Loader, "Kernel entry = %#x\n", kernelEntry);
304            DPRINTF(Loader, "Kernel loaded...\n");
305        }
306    }
307}
308
309void
310System::replaceThreadContext(ThreadContext *tc, ContextID context_id)
311{
312    if (context_id >= threadContexts.size()) {
313        panic("replaceThreadContext: bad id, %d >= %d\n",
314              context_id, threadContexts.size());
315    }
316
317    threadContexts[context_id] = tc;
318    if (context_id < remoteGDB.size())
319        remoteGDB[context_id]->replaceThreadContext(tc);
320}
321
322Addr
323System::allocPhysPages(int npages)
324{
325    Addr return_addr = pagePtr << PageShift;
326    pagePtr += npages;
327
328    Addr next_return_addr = pagePtr << PageShift;
329
330    AddrRange m5opRange(0xffff0000, 0xffffffff);
331    if (m5opRange.contains(next_return_addr)) {
332        warn("Reached m5ops MMIO region\n");
333        return_addr = 0xffffffff;
334        pagePtr = 0xffffffff >> PageShift;
335    }
336
337    if ((pagePtr << PageShift) > physmem.totalSize())
338        fatal("Out of memory, please increase size of physical memory.");
339    return return_addr;
340}
341
342Addr
343System::memSize() const
344{
345    return physmem.totalSize();
346}
347
348Addr
349System::freeMemSize() const
350{
351   return physmem.totalSize() - (pagePtr << PageShift);
352}
353
354bool
355System::isMemAddr(Addr addr) const
356{
357    return physmem.isMemAddr(addr);
358}
359
360void
361System::drainResume()
362{
363    totalNumInsts = 0;
364}
365
366void
367System::serialize(CheckpointOut &cp) const
368{
369    if (FullSystem)
370        kernelSymtab->serialize("kernel_symtab", cp);
371    SERIALIZE_SCALAR(pagePtr);
372    SERIALIZE_SCALAR(nextPID);
373    serializeSymtab(cp);
374
375    // also serialize the memories in the system
376    physmem.serializeSection(cp, "physmem");
377}
378
379
380void
381System::unserialize(CheckpointIn &cp)
382{
383    if (FullSystem)
384        kernelSymtab->unserialize("kernel_symtab", cp);
385    UNSERIALIZE_SCALAR(pagePtr);
386    UNSERIALIZE_SCALAR(nextPID);
387    unserializeSymtab(cp);
388
389    // also unserialize the memories in the system
390    physmem.unserializeSection(cp, "physmem");
391}
392
393void
394System::regStats()
395{
396    MemObject::regStats();
397
398    for (uint32_t j = 0; j < numWorkIds ; j++) {
399        workItemStats[j] = new Stats::Histogram();
400        stringstream namestr;
401        ccprintf(namestr, "work_item_type%d", j);
402        workItemStats[j]->init(20)
403                         .name(name() + "." + namestr.str())
404                         .desc("Run time stat for" + namestr.str())
405                         .prereq(*workItemStats[j]);
406    }
407}
408
409void
410System::workItemEnd(uint32_t tid, uint32_t workid)
411{
412    std::pair<uint32_t,uint32_t> p(tid, workid);
413    if (!lastWorkItemStarted.count(p))
414        return;
415
416    Tick samp = curTick() - lastWorkItemStarted[p];
417    DPRINTF(WorkItems, "Work item end: %d\t%d\t%lld\n", tid, workid, samp);
418
419    if (workid >= numWorkIds)
420        fatal("Got workid greater than specified in system configuration\n");
421
422    workItemStats[workid]->sample(samp);
423    lastWorkItemStarted.erase(p);
424}
425
426void
427System::printSystems()
428{
429    ios::fmtflags flags(cerr.flags());
430
431    vector<System *>::iterator i = systemList.begin();
432    vector<System *>::iterator end = systemList.end();
433    for (; i != end; ++i) {
434        System *sys = *i;
435        cerr << "System " << sys->name() << ": " << hex << sys << endl;
436    }
437
438    cerr.flags(flags);
439}
440
441void
442printSystems()
443{
444    System::printSystems();
445}
446
447MasterID
448System::getMasterId(std::string master_name)
449{
450    // strip off system name if the string starts with it
451    if (startswith(master_name, name()))
452        master_name = master_name.erase(0, name().size() + 1);
453
454    // CPUs in switch_cpus ask for ids again after switching
455    for (int i = 0; i < masterIds.size(); i++) {
456        if (masterIds[i] == master_name) {
457            return i;
458        }
459    }
460
461    // Verify that the statistics haven't been enabled yet
462    // Otherwise objects will have sized their stat buckets and
463    // they will be too small
464
465    if (Stats::enabled()) {
466        fatal("Can't request a masterId after regStats(). "
467                "You must do so in init().\n");
468    }
469
470    masterIds.push_back(master_name);
471
472    return masterIds.size() - 1;
473}
474
475std::string
476System::getMasterName(MasterID master_id)
477{
478    if (master_id >= masterIds.size())
479        fatal("Invalid master_id passed to getMasterName()\n");
480
481    return masterIds[master_id];
482}
483
484System *
485SystemParams::create()
486{
487    return new System(this);
488}
489