src/sim/system.cc

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