2 * Copyright (c) 2011-2014,2017-2018 ARM Limited
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.
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.
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.
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.
41 * Authors: Steve Reinhardt
48 #include "sim/system.hh"
52 #include "arch/remote_gdb.hh"
53 #include "arch/utility.hh"
54 #include "base/loader/object_file.hh"
55 #include "base/loader/symtab.hh"
56 #include "base/str.hh"
57 #include "base/trace.hh"
58 #include "config/use_kvm.hh"
60 #include "cpu/kvm/base.hh"
61 #include "cpu/kvm/vm.hh"
63 #include "cpu/base.hh"
64 #include "cpu/thread_context.hh"
65 #include "debug/Loader.hh"
66 #include "debug/WorkItems.hh"
67 #include "mem/abstract_mem.hh"
68 #include "mem/physical.hh"
69 #include "params/System.hh"
70 #include "sim/byteswap.hh"
71 #include "sim/debug.hh"
72 #include "sim/full_system.hh"
73 #include "sim/redirect_path.hh"
76 * To avoid linking errors with LTO, only include the header if we
77 * actually have a definition.
79 #if THE_ISA != NULL_ISA
80 #include "kern/kernel_stats.hh"
85 using namespace TheISA
;
87 vector
<System
*> System::systemList
;
89 int System::numSystemsRunning
= 0;
91 System::System(Params
*p
)
92 : SimObject(p
), _systemPort("system_port", this),
93 multiThread(p
->multi_thread
),
95 init_param(p
->init_param
),
96 physProxy(_systemPort
, p
->cache_line_size
),
97 kernelSymtab(nullptr),
99 loadAddrMask(p
->load_addr_mask
),
100 loadAddrOffset(p
->load_offset
),
106 physmem(name() + ".physmem", p
->memories
, p
->mmap_using_noreserve
),
107 memoryMode(p
->mem_mode
),
108 _cacheLineSize(p
->cache_line_size
),
111 numWorkIds(p
->num_work_ids
),
112 thermalModel(p
->thermal_model
),
115 instEventQueue("system instruction-based event queue"),
116 redirectPaths(p
->redirect_paths
)
119 // add self to global system list
120 systemList
.push_back(this);
124 kvmVM
->setSystem(this);
129 kernelSymtab
= new SymbolTable
;
130 if (!debugSymbolTable
)
131 debugSymbolTable
= new SymbolTable
;
134 // check if the cache line size is a value known to work
135 if (!(_cacheLineSize
== 16 || _cacheLineSize
== 32 ||
136 _cacheLineSize
== 64 || _cacheLineSize
== 128))
137 warn_once("Cache line size is neither 16, 32, 64 nor 128 bytes.\n");
139 // Get the generic system master IDs
140 MasterID tmp_id M5_VAR_USED
;
141 tmp_id
= getMasterId(this, "writebacks");
142 assert(tmp_id
== Request::wbMasterId
);
143 tmp_id
= getMasterId(this, "functional");
144 assert(tmp_id
== Request::funcMasterId
);
145 tmp_id
= getMasterId(this, "interrupt");
146 assert(tmp_id
== Request::intMasterId
);
149 if (params()->kernel
== "") {
150 inform("No kernel set for full system simulation. "
151 "Assuming you know what you're doing\n");
153 // Get the kernel code
154 kernel
= createObjectFile(params()->kernel
);
155 inform("kernel located at: %s", params()->kernel
);
158 fatal("Could not load kernel file %s", params()->kernel
);
160 // setup entry points
161 kernelStart
= kernel
->textBase();
162 kernelEnd
= kernel
->bssBase() + kernel
->bssSize();
163 kernelEntry
= kernel
->entryPoint();
165 // If load_addr_mask is set to 0x0, then auto-calculate
166 // the smallest mask to cover all kernel addresses so gem5
167 // can relocate the kernel to a new offset.
168 if (loadAddrMask
== 0) {
169 Addr shift_amt
= findMsbSet(kernelEnd
- kernelStart
) + 1;
170 loadAddrMask
= ((Addr
)1 << shift_amt
) - 1;
174 if (!kernel
->loadGlobalSymbols(kernelSymtab
))
175 fatal("could not load kernel symbols\n");
177 if (!kernel
->loadLocalSymbols(kernelSymtab
))
178 fatal("could not load kernel local symbols\n");
180 if (!kernel
->loadGlobalSymbols(debugSymbolTable
))
181 fatal("could not load kernel symbols\n");
183 if (!kernel
->loadLocalSymbols(debugSymbolTable
))
184 fatal("could not load kernel local symbols\n");
186 // Loading only needs to happen once and after memory system is
187 // connected so it will happen in initState()
190 for (const auto &obj_name
: p
->kernel_extras
) {
191 inform("Loading additional kernel object: %s", obj_name
);
192 ObjectFile
*obj
= createObjectFile(obj_name
);
193 fatal_if(!obj
, "Failed to additional kernel object '%s'.\n",
195 kernelExtras
.push_back(obj
);
199 // increment the number of running systems
202 // Set back pointers to the system in all memories
203 for (int x
= 0; x
< params()->memories
.size(); x
++)
204 params()->memories
[x
]->system(this);
212 for (uint32_t j
= 0; j
< numWorkIds
; j
++)
213 delete workItemStats
[j
];
219 // check that the system port is connected
220 if (!_systemPort
.isConnected())
221 panic("System port on %s is not connected.\n", name());
225 System::getPort(const std::string
&if_name
, PortID idx
)
227 // no need to distinguish at the moment (besides checking)
232 System::setMemoryMode(Enums::MemoryMode mode
)
234 assert(drainState() == DrainState::Drained
);
238 bool System::breakpoint()
240 if (remoteGDB
.size())
241 return remoteGDB
[0]->breakpoint();
246 System::registerThreadContext(ThreadContext
*tc
, ContextID assigned
)
249 if (id
== InvalidContextID
) {
250 // Find an unused context ID for this thread.
252 while (id
< threadContexts
.size() && threadContexts
[id
])
256 if (threadContexts
.size() <= id
)
257 threadContexts
.resize(id
+ 1);
259 fatal_if(threadContexts
[id
],
260 "Cannot have two CPUs with the same id (%d)\n", id
);
262 threadContexts
[id
] = tc
;
264 #if THE_ISA != NULL_ISA
265 int port
= getRemoteGDBPort();
267 RemoteGDB
*rgdb
= new RemoteGDB(this, tc
, port
+ id
);
270 BaseCPU
*cpu
= tc
->getCpuPtr();
271 if (cpu
->waitForRemoteGDB()) {
272 inform("%s: Waiting for a remote GDB connection on port %d.\n",
273 cpu
->name(), rgdb
->port());
277 if (remoteGDB
.size() <= id
) {
278 remoteGDB
.resize(id
+ 1);
281 remoteGDB
[id
] = rgdb
;
285 activeCpus
.push_back(false);
291 System::numRunningContexts()
293 return std::count_if(
294 threadContexts
.cbegin(),
295 threadContexts
.cend(),
296 [] (ThreadContext
* tc
) {
297 return ((tc
->status() != ThreadContext::Halted
) &&
298 (tc
->status() != ThreadContext::Halting
));
307 for (int i
= 0; i
< threadContexts
.size(); i
++)
308 TheISA::startupCPU(threadContexts
[i
], i
);
309 // Moved from the constructor to here since it relies on the
310 // address map being resolved in the interconnect
312 * Load the kernel code into memory
314 if (params()->kernel
!= "") {
315 if (params()->kernel_addr_check
) {
316 // Validate kernel mapping before loading binary
317 if (!(isMemAddr((kernelStart
& loadAddrMask
) +
319 isMemAddr((kernelEnd
& loadAddrMask
) +
321 fatal("Kernel is mapped to invalid location (not memory). "
322 "kernelStart 0x(%x) - kernelEnd 0x(%x) %#x:%#x\n",
324 kernelEnd
, (kernelStart
& loadAddrMask
) +
326 (kernelEnd
& loadAddrMask
) + loadAddrOffset
);
329 // Load program sections into memory
330 kernel
->loadSections(physProxy
, loadAddrMask
, loadAddrOffset
);
331 for (const auto &extra_kernel
: kernelExtras
) {
332 extra_kernel
->loadSections(physProxy
, loadAddrMask
,
336 DPRINTF(Loader
, "Kernel start = %#x\n", kernelStart
);
337 DPRINTF(Loader
, "Kernel end = %#x\n", kernelEnd
);
338 DPRINTF(Loader
, "Kernel entry = %#x\n", kernelEntry
);
339 DPRINTF(Loader
, "Kernel loaded...\n");
345 System::replaceThreadContext(ThreadContext
*tc
, ContextID context_id
)
347 if (context_id
>= threadContexts
.size()) {
348 panic("replaceThreadContext: bad id, %d >= %d\n",
349 context_id
, threadContexts
.size());
352 threadContexts
[context_id
] = tc
;
353 if (context_id
< remoteGDB
.size())
354 remoteGDB
[context_id
]->replaceThreadContext(tc
);
358 System::validKvmEnvironment() const
361 if (threadContexts
.empty())
364 for (auto tc
: threadContexts
) {
365 if (dynamic_cast<BaseKvmCPU
*>(tc
->getCpuPtr()) == nullptr) {
376 System::allocPhysPages(int npages
)
378 Addr return_addr
= pagePtr
<< PageShift
;
381 Addr next_return_addr
= pagePtr
<< PageShift
;
383 AddrRange
m5opRange(0xffff0000, 0xffffffff);
384 if (m5opRange
.contains(next_return_addr
)) {
385 warn("Reached m5ops MMIO region\n");
386 return_addr
= 0xffffffff;
387 pagePtr
= 0xffffffff >> PageShift
;
390 if ((pagePtr
<< PageShift
) > physmem
.totalSize())
391 fatal("Out of memory, please increase size of physical memory.");
396 System::memSize() const
398 return physmem
.totalSize();
402 System::freeMemSize() const
404 return physmem
.totalSize() - (pagePtr
<< PageShift
);
408 System::isMemAddr(Addr addr
) const
410 return physmem
.isMemAddr(addr
);
414 System::drainResume()
420 System::serialize(CheckpointOut
&cp
) const
423 kernelSymtab
->serialize("kernel_symtab", cp
);
424 SERIALIZE_SCALAR(pagePtr
);
427 // also serialize the memories in the system
428 physmem
.serializeSection(cp
, "physmem");
433 System::unserialize(CheckpointIn
&cp
)
436 kernelSymtab
->unserialize("kernel_symtab", cp
);
437 UNSERIALIZE_SCALAR(pagePtr
);
438 unserializeSymtab(cp
);
440 // also unserialize the memories in the system
441 physmem
.unserializeSection(cp
, "physmem");
447 SimObject::regStats();
449 for (uint32_t j
= 0; j
< numWorkIds
; j
++) {
450 workItemStats
[j
] = new Stats::Histogram();
451 stringstream namestr
;
452 ccprintf(namestr
, "work_item_type%d", j
);
453 workItemStats
[j
]->init(20)
454 .name(name() + "." + namestr
.str())
455 .desc("Run time stat for" + namestr
.str())
456 .prereq(*workItemStats
[j
]);
461 System::workItemEnd(uint32_t tid
, uint32_t workid
)
463 std::pair
<uint32_t,uint32_t> p(tid
, workid
);
464 if (!lastWorkItemStarted
.count(p
))
467 Tick samp
= curTick() - lastWorkItemStarted
[p
];
468 DPRINTF(WorkItems
, "Work item end: %d\t%d\t%lld\n", tid
, workid
, samp
);
470 if (workid
>= numWorkIds
)
471 fatal("Got workid greater than specified in system configuration\n");
473 workItemStats
[workid
]->sample(samp
);
474 lastWorkItemStarted
.erase(p
);
478 System::printSystems()
480 ios::fmtflags
flags(cerr
.flags());
482 vector
<System
*>::iterator i
= systemList
.begin();
483 vector
<System
*>::iterator end
= systemList
.end();
484 for (; i
!= end
; ++i
) {
486 cerr
<< "System " << sys
->name() << ": " << hex
<< sys
<< endl
;
495 System::printSystems();
499 System::stripSystemName(const std::string
& master_name
) const
501 if (startswith(master_name
, name())) {
502 return master_name
.substr(name().size());
509 System::lookupMasterId(const SimObject
* obj
) const
511 MasterID id
= Request::invldMasterId
;
513 // number of occurrences of the SimObject pointer
514 // in the master list.
517 for (int i
= 0; i
< masters
.size(); i
++) {
518 if (masters
[i
].obj
== obj
) {
524 fatal_if(obj_number
> 1,
525 "Cannot lookup MasterID by SimObject pointer: "
526 "More than one master is sharing the same SimObject\n");
532 System::lookupMasterId(const std::string
& master_name
) const
534 std::string name
= stripSystemName(master_name
);
536 for (int i
= 0; i
< masters
.size(); i
++) {
537 if (masters
[i
].masterName
== name
) {
542 return Request::invldMasterId
;
546 System::getGlobalMasterId(const std::string
& master_name
)
548 return _getMasterId(nullptr, master_name
);
552 System::getMasterId(const SimObject
* master
, std::string submaster
)
554 auto master_name
= leafMasterName(master
, submaster
);
555 return _getMasterId(master
, master_name
);
559 System::_getMasterId(const SimObject
* master
, const std::string
& master_name
)
561 std::string name
= stripSystemName(master_name
);
563 // CPUs in switch_cpus ask for ids again after switching
564 for (int i
= 0; i
< masters
.size(); i
++) {
565 if (masters
[i
].masterName
== name
) {
570 // Verify that the statistics haven't been enabled yet
571 // Otherwise objects will have sized their stat buckets and
572 // they will be too small
574 if (Stats::enabled()) {
575 fatal("Can't request a masterId after regStats(). "
576 "You must do so in init().\n");
579 // Generate a new MasterID incrementally
580 MasterID master_id
= masters
.size();
582 // Append the new Master metadata to the group of system Masters.
583 masters
.emplace_back(master
, name
, master_id
);
585 return masters
.back().masterId
;
589 System::leafMasterName(const SimObject
* master
, const std::string
& submaster
)
591 if (submaster
.empty()) {
592 return master
->name();
594 // Get the full master name by appending the submaster name to
595 // the root SimObject master name
596 return master
->name() + "." + submaster
;
601 System::getMasterName(MasterID master_id
)
603 if (master_id
>= masters
.size())
604 fatal("Invalid master_id passed to getMasterName()\n");
606 const auto& master_info
= masters
[master_id
];
607 return master_info
.masterName
;
611 SystemParams::create()
613 return new System(this);