system.hh revision 12262:a58c0c323e4f
1/* 2 * Copyright (c) 2012, 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) 2002-2005 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 * Rick Strong 45 */ 46 47#ifndef __SYSTEM_HH__ 48#define __SYSTEM_HH__ 49 50#include <string> 51#include <unordered_map> 52#include <utility> 53#include <vector> 54 55#include "arch/isa_traits.hh" 56#include "base/loader/symtab.hh" 57#include "base/statistics.hh" 58#include "config/the_isa.hh" 59#include "enums/MemoryMode.hh" 60#include "mem/mem_object.hh" 61#include "mem/physical.hh" 62#include "mem/port.hh" 63#include "mem/port_proxy.hh" 64#include "params/System.hh" 65#include "sim/futex_map.hh" 66#include "sim/se_signal.hh" 67 68/** 69 * To avoid linking errors with LTO, only include the header if we 70 * actually have the definition. 71 */ 72#if THE_ISA != NULL_ISA 73#include "cpu/pc_event.hh" 74 75#endif 76 77class BaseRemoteGDB; 78class GDBListener; 79class KvmVM; 80class ObjectFile; 81class ThreadContext; 82 83class System : public MemObject 84{ 85 private: 86 87 /** 88 * Private class for the system port which is only used as a 89 * master for debug access and for non-structural entities that do 90 * not have a port of their own. 91 */ 92 class SystemPort : public MasterPort 93 { 94 public: 95 96 /** 97 * Create a system port with a name and an owner. 98 */ 99 SystemPort(const std::string &_name, MemObject *_owner) 100 : MasterPort(_name, _owner) 101 { } 102 bool recvTimingResp(PacketPtr pkt) override 103 { panic("SystemPort does not receive timing!\n"); return false; } 104 void recvReqRetry() override 105 { panic("SystemPort does not expect retry!\n"); } 106 }; 107 108 SystemPort _systemPort; 109 110 public: 111 112 /** 113 * After all objects have been created and all ports are 114 * connected, check that the system port is connected. 115 */ 116 void init() override; 117 118 /** 119 * Get a reference to the system port that can be used by 120 * non-structural simulation objects like processes or threads, or 121 * external entities like loaders and debuggers, etc, to access 122 * the memory system. 123 * 124 * @return a reference to the system port we own 125 */ 126 MasterPort& getSystemPort() { return _systemPort; } 127 128 /** 129 * Additional function to return the Port of a memory object. 130 */ 131 BaseMasterPort& getMasterPort(const std::string &if_name, 132 PortID idx = InvalidPortID) override; 133 134 /** @{ */ 135 /** 136 * Is the system in atomic mode? 137 * 138 * There are currently two different atomic memory modes: 139 * 'atomic', which supports caches; and 'atomic_noncaching', which 140 * bypasses caches. The latter is used by hardware virtualized 141 * CPUs. SimObjects are expected to use Port::sendAtomic() and 142 * Port::recvAtomic() when accessing memory in this mode. 143 */ 144 bool isAtomicMode() const { 145 return memoryMode == Enums::atomic || 146 memoryMode == Enums::atomic_noncaching; 147 } 148 149 /** 150 * Is the system in timing mode? 151 * 152 * SimObjects are expected to use Port::sendTiming() and 153 * Port::recvTiming() when accessing memory in this mode. 154 */ 155 bool isTimingMode() const { 156 return memoryMode == Enums::timing; 157 } 158 159 /** 160 * Should caches be bypassed? 161 * 162 * Some CPUs need to bypass caches to allow direct memory 163 * accesses, which is required for hardware virtualization. 164 */ 165 bool bypassCaches() const { 166 return memoryMode == Enums::atomic_noncaching; 167 } 168 /** @} */ 169 170 /** @{ */ 171 /** 172 * Get the memory mode of the system. 173 * 174 * \warn This should only be used by the Python world. The C++ 175 * world should use one of the query functions above 176 * (isAtomicMode(), isTimingMode(), bypassCaches()). 177 */ 178 Enums::MemoryMode getMemoryMode() const { return memoryMode; } 179 180 /** 181 * Change the memory mode of the system. 182 * 183 * \warn This should only be called by the Python! 184 * 185 * @param mode Mode to change to (atomic/timing/...) 186 */ 187 void setMemoryMode(Enums::MemoryMode mode); 188 /** @} */ 189 190 /** 191 * Get the cache line size of the system. 192 */ 193 unsigned int cacheLineSize() const { return _cacheLineSize; } 194 195#if THE_ISA != NULL_ISA 196 PCEventQueue pcEventQueue; 197#endif 198 199 std::vector<ThreadContext *> threadContexts; 200 int _numContexts; 201 const bool multiThread; 202 203 ThreadContext *getThreadContext(ContextID tid) 204 { 205 return threadContexts[tid]; 206 } 207 208 int numContexts() 209 { 210 assert(_numContexts == (int)threadContexts.size()); 211 return _numContexts; 212 } 213 214 /** Return number of running (non-halted) thread contexts in 215 * system. These threads could be Active or Suspended. */ 216 int numRunningContexts(); 217 218 Addr pagePtr; 219 220 uint64_t init_param; 221 222 /** Port to physical memory used for writing object files into ram at 223 * boot.*/ 224 PortProxy physProxy; 225 226 /** kernel symbol table */ 227 SymbolTable *kernelSymtab; 228 229 /** Object pointer for the kernel code */ 230 ObjectFile *kernel; 231 232 /** Additional object files */ 233 std::vector<ObjectFile *> kernelExtras; 234 235 /** Beginning of kernel code */ 236 Addr kernelStart; 237 238 /** End of kernel code */ 239 Addr kernelEnd; 240 241 /** Entry point in the kernel to start at */ 242 Addr kernelEntry; 243 244 /** Mask that should be anded for binary/symbol loading. 245 * This allows one two different OS requirements for the same ISA to be 246 * handled. Some OSes are compiled for a virtual address and need to be 247 * loaded into physical memory that starts at address 0, while other 248 * bare metal tools generate images that start at address 0. 249 */ 250 Addr loadAddrMask; 251 252 /** Offset that should be used for binary/symbol loading. 253 * This further allows more flexibility than the loadAddrMask allows alone 254 * in loading kernels and similar. The loadAddrOffset is applied after the 255 * loadAddrMask. 256 */ 257 Addr loadAddrOffset; 258 259 public: 260 /** 261 * Get a pointer to the Kernel Virtual Machine (KVM) SimObject, 262 * if present. 263 */ 264 KvmVM* getKvmVM() { 265 return kvmVM; 266 } 267 268 /** Verify gem5 configuration will support KVM emulation */ 269 bool validKvmEnvironment() const; 270 271 /** Get a pointer to access the physical memory of the system */ 272 PhysicalMemory& getPhysMem() { return physmem; } 273 274 /** Amount of physical memory that is still free */ 275 Addr freeMemSize() const; 276 277 /** Amount of physical memory that exists */ 278 Addr memSize() const; 279 280 /** 281 * Check if a physical address is within a range of a memory that 282 * is part of the global address map. 283 * 284 * @param addr A physical address 285 * @return Whether the address corresponds to a memory 286 */ 287 bool isMemAddr(Addr addr) const; 288 289 /** 290 * Get the architecture. 291 */ 292 Arch getArch() const { return Arch::TheISA; } 293 294 /** 295 * Get the page bytes for the ISA. 296 */ 297 Addr getPageBytes() const { return TheISA::PageBytes; } 298 299 /** 300 * Get the number of bits worth of in-page address for the ISA. 301 */ 302 Addr getPageShift() const { return TheISA::PageShift; } 303 304 /** 305 * The thermal model used for this system (if any). 306 */ 307 ThermalModel * getThermalModel() const { return thermalModel; } 308 309 protected: 310 311 KvmVM *const kvmVM; 312 313 PhysicalMemory physmem; 314 315 Enums::MemoryMode memoryMode; 316 317 const unsigned int _cacheLineSize; 318 319 uint64_t workItemsBegin; 320 uint64_t workItemsEnd; 321 uint32_t numWorkIds; 322 std::vector<bool> activeCpus; 323 324 /** This array is a per-system list of all devices capable of issuing a 325 * memory system request and an associated string for each master id. 326 * It's used to uniquely id any master in the system by name for things 327 * like cache statistics. 328 */ 329 std::vector<std::string> masterIds; 330 331 ThermalModel * thermalModel; 332 333 public: 334 335 /** Request an id used to create a request object in the system. All objects 336 * that intend to issues requests into the memory system must request an id 337 * in the init() phase of startup. All master ids must be fixed by the 338 * regStats() phase that immediately precedes it. This allows objects in 339 * the memory system to understand how many masters may exist and 340 * appropriately name the bins of their per-master stats before the stats 341 * are finalized 342 */ 343 MasterID getMasterId(std::string req_name); 344 345 /** Get the name of an object for a given request id. 346 */ 347 std::string getMasterName(MasterID master_id); 348 349 /** Get the number of masters registered in the system */ 350 MasterID maxMasters() 351 { 352 return masterIds.size(); 353 } 354 355 void regStats() override; 356 /** 357 * Called by pseudo_inst to track the number of work items started by this 358 * system. 359 */ 360 uint64_t 361 incWorkItemsBegin() 362 { 363 return ++workItemsBegin; 364 } 365 366 /** 367 * Called by pseudo_inst to track the number of work items completed by 368 * this system. 369 */ 370 uint64_t 371 incWorkItemsEnd() 372 { 373 return ++workItemsEnd; 374 } 375 376 /** 377 * Called by pseudo_inst to mark the cpus actively executing work items. 378 * Returns the total number of cpus that have executed work item begin or 379 * ends. 380 */ 381 int 382 markWorkItem(int index) 383 { 384 int count = 0; 385 assert(index < activeCpus.size()); 386 activeCpus[index] = true; 387 for (std::vector<bool>::iterator i = activeCpus.begin(); 388 i < activeCpus.end(); i++) { 389 if (*i) count++; 390 } 391 return count; 392 } 393 394 inline void workItemBegin(uint32_t tid, uint32_t workid) 395 { 396 std::pair<uint32_t,uint32_t> p(tid, workid); 397 lastWorkItemStarted[p] = curTick(); 398 } 399 400 void workItemEnd(uint32_t tid, uint32_t workid); 401 402 /** 403 * Fix up an address used to match PCs for hooking simulator 404 * events on to target function executions. See comment in 405 * system.cc for details. 406 */ 407 virtual Addr fixFuncEventAddr(Addr addr) 408 { 409 panic("Base fixFuncEventAddr not implemented.\n"); 410 } 411 412 /** @{ */ 413 /** 414 * Add a function-based event to the given function, to be looked 415 * up in the specified symbol table. 416 * 417 * The ...OrPanic flavor of the method causes the simulator to 418 * panic if the symbol can't be found. 419 * 420 * @param symtab Symbol table to use for look up. 421 * @param lbl Function to hook the event to. 422 * @param desc Description to be passed to the event. 423 * @param args Arguments to be forwarded to the event constructor. 424 */ 425 template <class T, typename... Args> 426 T *addFuncEvent(const SymbolTable *symtab, const char *lbl, 427 const std::string &desc, Args... args) 428 { 429 Addr addr M5_VAR_USED = 0; // initialize only to avoid compiler warning 430 431#if THE_ISA != NULL_ISA 432 if (symtab->findAddress(lbl, addr)) { 433 T *ev = new T(&pcEventQueue, desc, fixFuncEventAddr(addr), 434 std::forward<Args>(args)...); 435 return ev; 436 } 437#endif 438 439 return NULL; 440 } 441 442 template <class T> 443 T *addFuncEvent(const SymbolTable *symtab, const char *lbl) 444 { 445 return addFuncEvent<T>(symtab, lbl, lbl); 446 } 447 448 template <class T, typename... Args> 449 T *addFuncEventOrPanic(const SymbolTable *symtab, const char *lbl, 450 Args... args) 451 { 452 T *e(addFuncEvent<T>(symtab, lbl, std::forward<Args>(args)...)); 453 if (!e) 454 panic("Failed to find symbol '%s'", lbl); 455 return e; 456 } 457 /** @} */ 458 459 /** @{ */ 460 /** 461 * Add a function-based event to a kernel symbol. 462 * 463 * These functions work like their addFuncEvent() and 464 * addFuncEventOrPanic() counterparts. The only difference is that 465 * they automatically use the kernel symbol table. All arguments 466 * are forwarded to the underlying method. 467 * 468 * @see addFuncEvent() 469 * @see addFuncEventOrPanic() 470 * 471 * @param lbl Function to hook the event to. 472 * @param args Arguments to be passed to addFuncEvent 473 */ 474 template <class T, typename... Args> 475 T *addKernelFuncEvent(const char *lbl, Args... args) 476 { 477 return addFuncEvent<T>(kernelSymtab, lbl, 478 std::forward<Args>(args)...); 479 } 480 481 template <class T, typename... Args> 482 T *addKernelFuncEventOrPanic(const char *lbl, Args... args) 483 { 484 T *e(addFuncEvent<T>(kernelSymtab, lbl, 485 std::forward<Args>(args)...)); 486 if (!e) 487 panic("Failed to find kernel symbol '%s'", lbl); 488 return e; 489 } 490 /** @} */ 491 492 public: 493 std::vector<BaseRemoteGDB *> remoteGDB; 494 std::vector<GDBListener *> gdbListen; 495 bool breakpoint(); 496 497 public: 498 typedef SystemParams Params; 499 500 protected: 501 Params *_params; 502 503 public: 504 System(Params *p); 505 ~System(); 506 507 void initState() override; 508 509 const Params *params() const { return (const Params *)_params; } 510 511 public: 512 513 /** 514 * Returns the address the kernel starts at. 515 * @return address the kernel starts at 516 */ 517 Addr getKernelStart() const { return kernelStart; } 518 519 /** 520 * Returns the address the kernel ends at. 521 * @return address the kernel ends at 522 */ 523 Addr getKernelEnd() const { return kernelEnd; } 524 525 /** 526 * Returns the address the entry point to the kernel code. 527 * @return entry point of the kernel code 528 */ 529 Addr getKernelEntry() const { return kernelEntry; } 530 531 /// Allocate npages contiguous unused physical pages 532 /// @return Starting address of first page 533 Addr allocPhysPages(int npages); 534 535 ContextID registerThreadContext(ThreadContext *tc, 536 ContextID assigned = InvalidContextID); 537 void replaceThreadContext(ThreadContext *tc, ContextID context_id); 538 539 void serialize(CheckpointOut &cp) const override; 540 void unserialize(CheckpointIn &cp) override; 541 542 void drainResume() override; 543 544 public: 545 Counter totalNumInsts; 546 EventQueue instEventQueue; 547 std::map<std::pair<uint32_t,uint32_t>, Tick> lastWorkItemStarted; 548 std::map<uint32_t, Stats::Histogram*> workItemStats; 549 550 //////////////////////////////////////////// 551 // 552 // STATIC GLOBAL SYSTEM LIST 553 // 554 //////////////////////////////////////////// 555 556 static std::vector<System *> systemList; 557 static int numSystemsRunning; 558 559 static void printSystems(); 560 561 FutexMap futexMap; 562 563 static const int maxPID = 32768; 564 565 /** Process set to track which PIDs have already been allocated */ 566 std::set<int> PIDs; 567 568 // By convention, all signals are owned by the receiving process. The 569 // receiver will delete the signal upon reception. 570 std::list<BasicSignal> signalList; 571 572 protected: 573 574 /** 575 * If needed, serialize additional symbol table entries for a 576 * specific subclass of this system. Currently this is used by 577 * Alpha and MIPS. 578 * 579 * @param os stream to serialize to 580 */ 581 virtual void serializeSymtab(CheckpointOut &os) const {} 582 583 /** 584 * If needed, unserialize additional symbol table entries for a 585 * specific subclass of this system. 586 * 587 * @param cp checkpoint to unserialize from 588 * @param section relevant section in the checkpoint 589 */ 590 virtual void unserializeSymtab(CheckpointIn &cp) {} 591 592}; 593 594void printSystems(); 595 596#endif // __SYSTEM_HH__ 597