src/sim/system.hh

   1 /*
   2  * Copyright (c) 2002-2005 The Regents of The University of Michigan
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met: redistributions of source code must retain the above copyright
   8  * notice, this list of conditions and the following disclaimer;
   9  * redistributions in binary form must reproduce the above copyright
  10  * notice, this list of conditions and the following disclaimer in the
  11  * documentation and/or other materials provided with the distribution;
  12  * neither the name of the copyright holders nor the names of its
  13  * contributors may be used to endorse or promote products derived from
  14  * this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  * Authors: Steve Reinhardt
  29  *          Lisa Hsu
  30  *          Nathan Binkert
  31  */
  32
  33 #ifndef __SYSTEM_HH__
  34 #define __SYSTEM_HH__
  35
  36 #include <string>
  37 #include <vector>
  38
  39 #include "base/loader/symtab.hh"
  40 #include "base/misc.hh"
  41 #include "base/statistics.hh"
  42 #include "config/full_system.hh"
  43 #include "cpu/pc_event.hh"
  44 #include "mem/port.hh"
  45 #include "sim/sim_object.hh"
  46 #if FULL_SYSTEM
  47 #include "kern/system_events.hh"
  48 #include "mem/vport.hh"
  49 #endif
  50
  51 class BaseCPU;
  52 class ThreadContext;
  53 class ObjectFile;
  54 class PhysicalMemory;
  55
  56 #if FULL_SYSTEM
  57 class Platform;
  58 class GDBListener;
  59 namespace TheISA
  60 {
  61     class RemoteGDB;
  62 }
  63 #endif
  64
  65 class System : public SimObject
  66 {
  67   public:
  68
  69     static const char *MemoryModeStrings[3];
  70
  71     SimObject::MemoryMode getMemoryMode() { assert(memoryMode); return memoryMode; }
  72
  73     /** Change the memory mode of the system. This should only be called by the
  74      * python!!
  75      * @param mode Mode to change to (atomic/timing)
  76      */
  77     void setMemoryMode(SimObject::MemoryMode mode);
  78
  79     PhysicalMemory *physmem;
  80     PCEventQueue pcEventQueue;
  81
  82     std::vector<ThreadContext *> threadContexts;
  83     int numcpus;
  84
  85     int getNumCPUs()
  86     {
  87         if (numcpus != threadContexts.size())
  88             panic("cpu array not fully populated!");
  89
  90         return numcpus;
  91     }
  92
  93 #if FULL_SYSTEM
  94     Platform *platform;
  95     uint64_t init_param;
  96
  97     /** Port to physical memory used for writing object files into ram at
  98      * boot.*/
  99     FunctionalPort functionalPort;
 100     VirtualPort virtPort;
 101
 102     /** kernel symbol table */
 103     SymbolTable *kernelSymtab;
 104
 105     /** Object pointer for the kernel code */
 106     ObjectFile *kernel;
 107
 108     /** Begining of kernel code */
 109     Addr kernelStart;
 110
 111     /** End of kernel code */
 112     Addr kernelEnd;
 113
 114     /** Entry point in the kernel to start at */
 115     Addr kernelEntry;
 116
 117 #else
 118
 119     int page_ptr;
 120
 121
 122 #endif // FULL_SYSTEM
 123
 124   protected:
 125
 126     SimObject::MemoryMode memoryMode;
 127
 128 #if FULL_SYSTEM
 129     /**
 130      * Fix up an address used to match PCs for hooking simulator
 131      * events on to target function executions.  See comment in
 132      * system.cc for details.
 133      */
 134     virtual Addr fixFuncEventAddr(Addr addr) = 0;
 135
 136     /**
 137      * Add a function-based event to the given function, to be looked
 138      * up in the specified symbol table.
 139      */
 140     template <class T>
 141     T *addFuncEvent(SymbolTable *symtab, const char *lbl)
 142     {
 143         Addr addr = 0; // initialize only to avoid compiler warning
 144
 145         if (symtab->findAddress(lbl, addr)) {
 146             T *ev = new T(&pcEventQueue, lbl, fixFuncEventAddr(addr));
 147             return ev;
 148         }
 149
 150         return NULL;
 151     }
 152
 153     /** Add a function-based event to kernel code. */
 154     template <class T>
 155     T *addKernelFuncEvent(const char *lbl)
 156     {
 157         return addFuncEvent<T>(kernelSymtab, lbl);
 158     }
 159
 160 #endif
 161   public:
 162 #if FULL_SYSTEM
 163     std::vector<TheISA::RemoteGDB *> remoteGDB;
 164     std::vector<GDBListener *> gdbListen;
 165     virtual bool breakpoint() = 0;
 166 #endif // FULL_SYSTEM
 167
 168   public:
 169     struct Params
 170     {
 171         std::string name;
 172         PhysicalMemory *physmem;
 173         SimObject::MemoryMode mem_mode;
 174
 175 #if FULL_SYSTEM
 176         Tick boot_cpu_frequency;
 177         std::string boot_osflags;
 178         uint64_t init_param;
 179
 180         std::string kernel_path;
 181         std::string readfile;
 182         std::string symbolfile;
 183 #endif
 184     };
 185
 186   protected:
 187     Params *_params;
 188
 189   public:
 190     System(Params *p);
 191     ~System();
 192
 193     void startup();
 194
 195     const Params *params() const { return (const Params *)_params; }
 196
 197   public:
 198
 199 #if FULL_SYSTEM
 200     /**
 201      * Returns the addess the kernel starts at.
 202      * @return address the kernel starts at
 203      */
 204     Addr getKernelStart() const { return kernelStart; }
 205
 206     /**
 207      * Returns the addess the kernel ends at.
 208      * @return address the kernel ends at
 209      */
 210     Addr getKernelEnd() const { return kernelEnd; }
 211
 212     /**
 213      * Returns the addess the entry point to the kernel code.
 214      * @return entry point of the kernel code
 215      */
 216     Addr getKernelEntry() const { return kernelEntry; }
 217
 218 #else
 219
 220     Addr new_page();
 221
 222 #endif // FULL_SYSTEM
 223
 224     int registerThreadContext(ThreadContext *tc, int tcIndex);
 225     void replaceThreadContext(ThreadContext *tc, int tcIndex);
 226
 227     void serialize(std::ostream &os);
 228     void unserialize(Checkpoint *cp, const std::string &section);
 229
 230   public:
 231     ////////////////////////////////////////////
 232     //
 233     // STATIC GLOBAL SYSTEM LIST
 234     //
 235     ////////////////////////////////////////////
 236
 237     static std::vector<System *> systemList;
 238     static int numSystemsRunning;
 239
 240     static void printSystems();
 241
 242
 243 };
 244
 245 #endif // __SYSTEM_HH__