2 * Copyright (c) 2011-2014,2017-2019 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
),
114 _m5opRange(p
->m5ops_base
?
115 RangeSize(p
->m5ops_base
, 0x10000) :
116 AddrRange(1, 0)), // Create an empty range if disabled
118 redirectPaths(p
->redirect_paths
)
121 // add self to global system list
122 systemList
.push_back(this);
126 kvmVM
->setSystem(this);
131 kernelSymtab
= new SymbolTable
;
132 if (!debugSymbolTable
)
133 debugSymbolTable
= new SymbolTable
;
136 // check if the cache line size is a value known to work
137 if (!(_cacheLineSize
== 16 || _cacheLineSize
== 32 ||
138 _cacheLineSize
== 64 || _cacheLineSize
== 128))
139 warn_once("Cache line size is neither 16, 32, 64 nor 128 bytes.\n");
141 // Get the generic system master IDs
142 MasterID tmp_id M5_VAR_USED
;
143 tmp_id
= getMasterId(this, "writebacks");
144 assert(tmp_id
== Request::wbMasterId
);
145 tmp_id
= getMasterId(this, "functional");
146 assert(tmp_id
== Request::funcMasterId
);
147 tmp_id
= getMasterId(this, "interrupt");
148 assert(tmp_id
== Request::intMasterId
);
151 if (params()->kernel
== "") {
152 inform("No kernel set for full system simulation. "
153 "Assuming you know what you're doing\n");
155 // Get the kernel code
156 kernel
= createObjectFile(params()->kernel
);
157 inform("kernel located at: %s", params()->kernel
);
160 fatal("Could not load kernel file %s", params()->kernel
);
162 kernelImage
= kernel
->buildImage();
164 // setup entry points
165 kernelStart
= kernelImage
.minAddr();
166 kernelEnd
= kernelImage
.maxAddr();
167 kernelEntry
= kernel
->entryPoint();
169 // If load_addr_mask is set to 0x0, then auto-calculate
170 // the smallest mask to cover all kernel addresses so gem5
171 // can relocate the kernel to a new offset.
172 if (loadAddrMask
== 0) {
173 Addr shift_amt
= findMsbSet(kernelEnd
- kernelStart
) + 1;
174 loadAddrMask
= ((Addr
)1 << shift_amt
) - 1;
177 kernelImage
.move([this](Addr a
) {
178 return (a
& loadAddrMask
) + loadAddrOffset
;
182 if (!kernel
->loadGlobalSymbols(kernelSymtab
))
183 fatal("could not load kernel symbols\n");
185 if (!kernel
->loadLocalSymbols(kernelSymtab
))
186 fatal("could not load kernel local symbols\n");
188 if (!kernel
->loadGlobalSymbols(debugSymbolTable
))
189 fatal("could not load kernel symbols\n");
191 if (!kernel
->loadLocalSymbols(debugSymbolTable
))
192 fatal("could not load kernel local symbols\n");
194 // Loading only needs to happen once and after memory system is
195 // connected so it will happen in initState()
198 if (p
->kernel_extras_addrs
.empty())
199 p
->kernel_extras_addrs
.resize(p
->kernel_extras
.size(), MaxAddr
);
200 fatal_if(p
->kernel_extras
.size() != p
->kernel_extras_addrs
.size(),
201 "Additional kernel objects, not all load addresses specified\n");
202 for (int ker_idx
= 0; ker_idx
< p
->kernel_extras
.size(); ker_idx
++) {
203 const std::string
&obj_name
= p
->kernel_extras
[ker_idx
];
204 const bool raw
= p
->kernel_extras_addrs
[ker_idx
] != MaxAddr
;
205 ObjectFile
*obj
= createObjectFile(obj_name
, raw
);
206 fatal_if(!obj
, "Failed to build additional kernel object '%s'.\n",
208 kernelExtras
.push_back(obj
);
212 // increment the number of running systems
215 // Set back pointers to the system in all memories
216 for (int x
= 0; x
< params()->memories
.size(); x
++)
217 params()->memories
[x
]->system(this);
225 for (uint32_t j
= 0; j
< numWorkIds
; j
++)
226 delete workItemStats
[j
];
232 // check that the system port is connected
233 if (!_systemPort
.isConnected())
234 panic("System port on %s is not connected.\n", name());
238 System::getPort(const std::string
&if_name
, PortID idx
)
240 // no need to distinguish at the moment (besides checking)
245 System::setMemoryMode(Enums::MemoryMode mode
)
247 assert(drainState() == DrainState::Drained
);
251 bool System::breakpoint()
253 if (remoteGDB
.size())
254 return remoteGDB
[0]->breakpoint();
259 System::registerThreadContext(ThreadContext
*tc
, ContextID assigned
)
262 if (id
== InvalidContextID
) {
263 // Find an unused context ID for this thread.
265 while (id
< threadContexts
.size() && threadContexts
[id
])
269 if (threadContexts
.size() <= id
)
270 threadContexts
.resize(id
+ 1);
272 fatal_if(threadContexts
[id
],
273 "Cannot have two CPUs with the same id (%d)\n", id
);
275 threadContexts
[id
] = tc
;
276 for (auto *e
: liveEvents
)
279 #if THE_ISA != NULL_ISA
280 int port
= getRemoteGDBPort();
282 RemoteGDB
*rgdb
= new RemoteGDB(this, tc
, port
+ id
);
285 BaseCPU
*cpu
= tc
->getCpuPtr();
286 if (cpu
->waitForRemoteGDB()) {
287 inform("%s: Waiting for a remote GDB connection on port %d.\n",
288 cpu
->name(), rgdb
->port());
292 if (remoteGDB
.size() <= id
) {
293 remoteGDB
.resize(id
+ 1);
296 remoteGDB
[id
] = rgdb
;
300 activeCpus
.push_back(false);
306 System::findFreeContext()
308 for (auto &it
: threadContexts
) {
309 if (ThreadContext::Halted
== it
->status())
316 System::schedule(PCEvent
*event
)
319 liveEvents
.push_back(event
);
320 for (auto *tc
: threadContexts
)
321 all
= tc
->schedule(event
) && all
;
326 System::remove(PCEvent
*event
)
329 liveEvents
.remove(event
);
330 for (auto *tc
: threadContexts
)
331 all
= tc
->remove(event
) && all
;
336 System::numRunningContexts()
338 return std::count_if(
339 threadContexts
.cbegin(),
340 threadContexts
.cend(),
341 [] (ThreadContext
* tc
) {
342 return ((tc
->status() != ThreadContext::Halted
) &&
343 (tc
->status() != ThreadContext::Halting
));
352 // Moved from the constructor to here since it relies on the
353 // address map being resolved in the interconnect
355 * Load the kernel code into memory
357 auto mapper
= [this](Addr a
) {
358 return (a
& loadAddrMask
) + loadAddrOffset
;
360 if (params()->kernel
!= "") {
361 if (params()->kernel_addr_check
) {
362 // Validate kernel mapping before loading binary
363 if (!isMemAddr(mapper(kernelStart
)) ||
364 !isMemAddr(mapper(kernelEnd
))) {
365 fatal("Kernel is mapped to invalid location (not memory). "
366 "kernelStart 0x(%x) - kernelEnd 0x(%x) %#x:%#x\n",
367 kernelStart
, kernelEnd
,
368 mapper(kernelStart
), mapper(kernelEnd
));
371 // Load program sections into memory
372 kernelImage
.write(physProxy
);
374 DPRINTF(Loader
, "Kernel start = %#x\n", kernelStart
);
375 DPRINTF(Loader
, "Kernel end = %#x\n", kernelEnd
);
376 DPRINTF(Loader
, "Kernel entry = %#x\n", kernelEntry
);
377 DPRINTF(Loader
, "Kernel loaded...\n");
379 std::function
<Addr(Addr
)> extra_mapper
;
380 for (auto ker_idx
= 0; ker_idx
< kernelExtras
.size(); ker_idx
++) {
381 const Addr load_addr
= params()->kernel_extras_addrs
[ker_idx
];
382 auto image
= kernelExtras
[ker_idx
]->buildImage();
383 if (load_addr
!= MaxAddr
)
384 image
= image
.offset(load_addr
);
386 image
= image
.move(mapper
);
387 image
.write(physProxy
);
393 System::replaceThreadContext(ThreadContext
*tc
, ContextID context_id
)
395 if (context_id
>= threadContexts
.size()) {
396 panic("replaceThreadContext: bad id, %d >= %d\n",
397 context_id
, threadContexts
.size());
400 for (auto *e
: liveEvents
) {
401 threadContexts
[context_id
]->remove(e
);
404 threadContexts
[context_id
] = tc
;
405 if (context_id
< remoteGDB
.size())
406 remoteGDB
[context_id
]->replaceThreadContext(tc
);
410 System::validKvmEnvironment() const
413 if (threadContexts
.empty())
416 for (auto tc
: threadContexts
) {
417 if (dynamic_cast<BaseKvmCPU
*>(tc
->getCpuPtr()) == nullptr) {
428 System::allocPhysPages(int npages
)
430 Addr return_addr
= pagePtr
<< PageShift
;
433 Addr next_return_addr
= pagePtr
<< PageShift
;
435 if (_m5opRange
.contains(next_return_addr
)) {
436 warn("Reached m5ops MMIO region\n");
437 return_addr
= 0xffffffff;
438 pagePtr
= 0xffffffff >> PageShift
;
441 if ((pagePtr
<< PageShift
) > physmem
.totalSize())
442 fatal("Out of memory, please increase size of physical memory.");
447 System::memSize() const
449 return physmem
.totalSize();
453 System::freeMemSize() const
455 return physmem
.totalSize() - (pagePtr
<< PageShift
);
459 System::isMemAddr(Addr addr
) const
461 return physmem
.isMemAddr(addr
);
465 System::drainResume()
471 System::serialize(CheckpointOut
&cp
) const
474 kernelSymtab
->serialize("kernel_symtab", cp
);
475 SERIALIZE_SCALAR(pagePtr
);
478 // also serialize the memories in the system
479 physmem
.serializeSection(cp
, "physmem");
484 System::unserialize(CheckpointIn
&cp
)
487 kernelSymtab
->unserialize("kernel_symtab", cp
);
488 UNSERIALIZE_SCALAR(pagePtr
);
489 unserializeSymtab(cp
);
491 // also unserialize the memories in the system
492 physmem
.unserializeSection(cp
, "physmem");
498 SimObject::regStats();
500 for (uint32_t j
= 0; j
< numWorkIds
; j
++) {
501 workItemStats
[j
] = new Stats::Histogram();
502 stringstream namestr
;
503 ccprintf(namestr
, "work_item_type%d", j
);
504 workItemStats
[j
]->init(20)
505 .name(name() + "." + namestr
.str())
506 .desc("Run time stat for" + namestr
.str())
507 .prereq(*workItemStats
[j
]);
512 System::workItemEnd(uint32_t tid
, uint32_t workid
)
514 std::pair
<uint32_t,uint32_t> p(tid
, workid
);
515 if (!lastWorkItemStarted
.count(p
))
518 Tick samp
= curTick() - lastWorkItemStarted
[p
];
519 DPRINTF(WorkItems
, "Work item end: %d\t%d\t%lld\n", tid
, workid
, samp
);
521 if (workid
>= numWorkIds
)
522 fatal("Got workid greater than specified in system configuration\n");
524 workItemStats
[workid
]->sample(samp
);
525 lastWorkItemStarted
.erase(p
);
529 System::printSystems()
531 ios::fmtflags
flags(cerr
.flags());
533 vector
<System
*>::iterator i
= systemList
.begin();
534 vector
<System
*>::iterator end
= systemList
.end();
535 for (; i
!= end
; ++i
) {
537 cerr
<< "System " << sys
->name() << ": " << hex
<< sys
<< endl
;
546 System::printSystems();
550 System::stripSystemName(const std::string
& master_name
) const
552 if (startswith(master_name
, name())) {
553 return master_name
.substr(name().size());
560 System::lookupMasterId(const SimObject
* obj
) const
562 MasterID id
= Request::invldMasterId
;
564 // number of occurrences of the SimObject pointer
565 // in the master list.
568 for (int i
= 0; i
< masters
.size(); i
++) {
569 if (masters
[i
].obj
== obj
) {
575 fatal_if(obj_number
> 1,
576 "Cannot lookup MasterID by SimObject pointer: "
577 "More than one master is sharing the same SimObject\n");
583 System::lookupMasterId(const std::string
& master_name
) const
585 std::string name
= stripSystemName(master_name
);
587 for (int i
= 0; i
< masters
.size(); i
++) {
588 if (masters
[i
].masterName
== name
) {
593 return Request::invldMasterId
;
597 System::getGlobalMasterId(const std::string
& master_name
)
599 return _getMasterId(nullptr, master_name
);
603 System::getMasterId(const SimObject
* master
, std::string submaster
)
605 auto master_name
= leafMasterName(master
, submaster
);
606 return _getMasterId(master
, master_name
);
610 System::_getMasterId(const SimObject
* master
, const std::string
& master_name
)
612 std::string name
= stripSystemName(master_name
);
614 // CPUs in switch_cpus ask for ids again after switching
615 for (int i
= 0; i
< masters
.size(); i
++) {
616 if (masters
[i
].masterName
== name
) {
621 // Verify that the statistics haven't been enabled yet
622 // Otherwise objects will have sized their stat buckets and
623 // they will be too small
625 if (Stats::enabled()) {
626 fatal("Can't request a masterId after regStats(). "
627 "You must do so in init().\n");
630 // Generate a new MasterID incrementally
631 MasterID master_id
= masters
.size();
633 // Append the new Master metadata to the group of system Masters.
634 masters
.emplace_back(master
, name
, master_id
);
636 return masters
.back().masterId
;
640 System::leafMasterName(const SimObject
* master
, const std::string
& submaster
)
642 if (submaster
.empty()) {
643 return master
->name();
645 // Get the full master name by appending the submaster name to
646 // the root SimObject master name
647 return master
->name() + "." + submaster
;
652 System::getMasterName(MasterID master_id
)
654 if (master_id
>= masters
.size())
655 fatal("Invalid master_id passed to getMasterName()\n");
657 const auto& master_info
= masters
[master_id
];
658 return master_info
.masterName
;
662 SystemParams::create()
664 return new System(this);