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, port + id);
265 rgdb->listen();
266
267 BaseCPU *cpu = tc->getCpuPtr();
268 if (cpu->waitForRemoteGDB()) {
269 inform("%s: Waiting for a remote GDB connection on port %d.\n",
270 cpu->name(), rgdb->port());
271
272 rgdb->connect();
273 }
274 if (remoteGDB.size() <= id) {
275 remoteGDB.resize(id + 1);
276 }
277
278 remoteGDB[id] = rgdb;
279 }
280#endif
281
282 activeCpus.push_back(false);
283
284 return id;
285}
286
287int
288System::numRunningContexts()
289{
290 int running = 0;
291 for (int i = 0; i < _numContexts; ++i) {
292 if (threadContexts[i]->status() != ThreadContext::Halted)
293 ++running;
294 }
295 return running;
296}
297
298void
299System::initState()
300{
301 if (FullSystem) {
302 for (int i = 0; i < threadContexts.size(); i++)
303 TheISA::startupCPU(threadContexts[i], i);
304 // Moved from the constructor to here since it relies on the
305 // address map being resolved in the interconnect
306 /**
307 * Load the kernel code into memory
308 */
309 if (params()->kernel != "") {
310 if (params()->kernel_addr_check) {
311 // Validate kernel mapping before loading binary
312 if (!(isMemAddr((kernelStart & loadAddrMask) +
313 loadAddrOffset) &&
314 isMemAddr((kernelEnd & loadAddrMask) +
315 loadAddrOffset))) {
316 fatal("Kernel is mapped to invalid location (not memory). "
317 "kernelStart 0x(%x) - kernelEnd 0x(%x) %#x:%#x\n",
318 kernelStart,
319 kernelEnd, (kernelStart & loadAddrMask) +
320 loadAddrOffset,
321 (kernelEnd & loadAddrMask) + loadAddrOffset);
322 }
323 }
324 // Load program sections into memory
325 kernel->loadSections(physProxy, loadAddrMask, loadAddrOffset);
326 for (const auto &extra_kernel : kernelExtras) {
327 extra_kernel->loadSections(physProxy, loadAddrMask,
328 loadAddrOffset);
329 }
330
331 DPRINTF(Loader, "Kernel start = %#x\n", kernelStart);
332 DPRINTF(Loader, "Kernel end = %#x\n", kernelEnd);
333 DPRINTF(Loader, "Kernel entry = %#x\n", kernelEntry);
334 DPRINTF(Loader, "Kernel loaded...\n");
335 }
336 }
337}
338
339void
340System::replaceThreadContext(ThreadContext *tc, ContextID context_id)
341{
342 if (context_id >= threadContexts.size()) {
343 panic("replaceThreadContext: bad id, %d >= %d\n",
344 context_id, threadContexts.size());
345 }
346
347 threadContexts[context_id] = tc;
348 if (context_id < remoteGDB.size())
349 remoteGDB[context_id]->replaceThreadContext(tc);
350}
351
352bool
353System::validKvmEnvironment() const
354{
355#if USE_KVM
356 if (threadContexts.empty())
357 return false;
358
359 for (auto tc : threadContexts) {
360 if (dynamic_cast<BaseKvmCPU*>(tc->getCpuPtr()) == nullptr) {
361 return false;
362 }
363 }
364 return true;
365#else
366 return false;
367#endif
368}
369
370Addr
371System::allocPhysPages(int npages)
372{
373 Addr return_addr = pagePtr << PageShift;
374 pagePtr += npages;
375
376 Addr next_return_addr = pagePtr << PageShift;
377
378 AddrRange m5opRange(0xffff0000, 0xffffffff);
379 if (m5opRange.contains(next_return_addr)) {
380 warn("Reached m5ops MMIO region\n");
381 return_addr = 0xffffffff;
382 pagePtr = 0xffffffff >> PageShift;
383 }
384
385 if ((pagePtr << PageShift) > physmem.totalSize())
386 fatal("Out of memory, please increase size of physical memory.");
387 return return_addr;
388}
389
390Addr
391System::memSize() const
392{
393 return physmem.totalSize();
394}
395
396Addr
397System::freeMemSize() const
398{
399 return physmem.totalSize() - (pagePtr << PageShift);
400}
401
402bool
403System::isMemAddr(Addr addr) const
404{
405 return physmem.isMemAddr(addr);
406}
407
408void
409System::drainResume()
410{
411 totalNumInsts = 0;
412}
413
414void
415System::serialize(CheckpointOut &cp) const
416{
417 if (FullSystem)
418 kernelSymtab->serialize("kernel_symtab", cp);
419 SERIALIZE_SCALAR(pagePtr);
420 serializeSymtab(cp);
421
422 // also serialize the memories in the system
423 physmem.serializeSection(cp, "physmem");
424}
425
426
427void
428System::unserialize(CheckpointIn &cp)
429{
430 if (FullSystem)
431 kernelSymtab->unserialize("kernel_symtab", cp);
432 UNSERIALIZE_SCALAR(pagePtr);
433 unserializeSymtab(cp);
434
435 // also unserialize the memories in the system
436 physmem.unserializeSection(cp, "physmem");
437}
438
439void
440System::regStats()
441{
442 MemObject::regStats();
443
444 for (uint32_t j = 0; j < numWorkIds ; j++) {
445 workItemStats[j] = new Stats::Histogram();
446 stringstream namestr;
447 ccprintf(namestr, "work_item_type%d", j);
448 workItemStats[j]->init(20)
449 .name(name() + "." + namestr.str())
450 .desc("Run time stat for" + namestr.str())
451 .prereq(*workItemStats[j]);
452 }
453}
454
455void
456System::workItemEnd(uint32_t tid, uint32_t workid)
457{
458 std::pair<uint32_t,uint32_t> p(tid, workid);
459 if (!lastWorkItemStarted.count(p))
460 return;
461
462 Tick samp = curTick() - lastWorkItemStarted[p];
463 DPRINTF(WorkItems, "Work item end: %d\t%d\t%lld\n", tid, workid, samp);
464
465 if (workid >= numWorkIds)
466 fatal("Got workid greater than specified in system configuration\n");
467
468 workItemStats[workid]->sample(samp);
469 lastWorkItemStarted.erase(p);
470}
471
472void
473System::printSystems()
474{
475 ios::fmtflags flags(cerr.flags());
476
477 vector<System *>::iterator i = systemList.begin();
478 vector<System *>::iterator end = systemList.end();
479 for (; i != end; ++i) {
480 System *sys = *i;
481 cerr << "System " << sys->name() << ": " << hex << sys << endl;
482 }
483
484 cerr.flags(flags);
485}
486
487void
488printSystems()
489{
490 System::printSystems();
491}
492
493MasterID
494System::getMasterId(std::string master_name)
495{
496 // strip off system name if the string starts with it
497 if (startswith(master_name, name()))
498 master_name = master_name.erase(0, name().size() + 1);
499
500 // CPUs in switch_cpus ask for ids again after switching
501 for (int i = 0; i < masterIds.size(); i++) {
502 if (masterIds[i] == master_name) {
503 return i;
504 }
505 }
506
507 // Verify that the statistics haven't been enabled yet
508 // Otherwise objects will have sized their stat buckets and
509 // they will be too small
510
511 if (Stats::enabled()) {
512 fatal("Can't request a masterId after regStats(). "
513 "You must do so in init().\n");
514 }
515
516 masterIds.push_back(master_name);
517
518 return masterIds.size() - 1;
519}
520
521std::string
522System::getMasterName(MasterID master_id)
523{
524 if (master_id >= masterIds.size())
525 fatal("Invalid master_id passed to getMasterName()\n");
526
527 return masterIds[master_id];
528}
529
530System *
531SystemParams::create()
532{
533 return new System(this);
534}