sim-se: Add default to SyscallDesc constructor
[gem5.git] / src / sim / system.hh
index 6dc8d73e0cb752a2ba895ef9b0c892c38bafe31c..acd3108a0117296cfd6ae7841e7c42b839077e1c 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2012 ARM Limited
+ * Copyright (c) 2012, 2014 ARM Limited
  * All rights reserved
  *
  * The license below extends only to copyright in the software and shall
 #define __SYSTEM_HH__
 
 #include <string>
+#include <unordered_map>
+#include <utility>
 #include <vector>
 
+#include "arch/isa_traits.hh"
 #include "base/loader/symtab.hh"
-#include "base/misc.hh"
 #include "base/statistics.hh"
-#include "cpu/pc_event.hh"
+#include "config/the_isa.hh"
 #include "enums/MemoryMode.hh"
-#include "kern/system_events.hh"
-#include "mem/fs_translating_port_proxy.hh"
 #include "mem/mem_object.hh"
-#include "mem/port.hh"
 #include "mem/physical.hh"
+#include "mem/port.hh"
+#include "mem/port_proxy.hh"
 #include "params/System.hh"
+#include "sim/futex_map.hh"
+#include "sim/se_signal.hh"
+
+/**
+ * To avoid linking errors with LTO, only include the header if we
+ * actually have the definition.
+ */
+#if THE_ISA != NULL_ISA
+#include "cpu/pc_event.hh"
+
+#endif
 
-class BaseCPU;
 class BaseRemoteGDB;
 class GDBListener;
+class KvmVM;
 class ObjectFile;
-class Platform;
 class ThreadContext;
 
 class System : public MemObject
@@ -88,9 +99,9 @@ class System : public MemObject
         SystemPort(const std::string &_name, MemObject *_owner)
             : MasterPort(_name, _owner)
         { }
-        bool recvTimingResp(PacketPtr pkt)
+        bool recvTimingResp(PacketPtr pkt) override
         { panic("SystemPort does not receive timing!\n"); return false; }
-        void recvRetry()
+        void recvReqRetry() override
         { panic("SystemPort does not expect retry!\n"); }
     };
 
@@ -102,7 +113,7 @@ class System : public MemObject
      * After all objects have been created and all ports are
      * connected, check that the system port is connected.
      */
-    virtual void init();
+    void init() override;
 
     /**
      * Get a reference to the system port that can be used by
@@ -117,29 +128,79 @@ class System : public MemObject
     /**
      * Additional function to return the Port of a memory object.
      */
-    MasterPort& getMasterPort(const std::string &if_name, int idx = -1);
+    BaseMasterPort& getMasterPort(const std::string &if_name,
+                                  PortID idx = InvalidPortID) override;
+
+    /** @{ */
+    /**
+     * Is the system in atomic mode?
+     *
+     * There are currently two different atomic memory modes:
+     * 'atomic', which supports caches; and 'atomic_noncaching', which
+     * bypasses caches. The latter is used by hardware virtualized
+     * CPUs. SimObjects are expected to use Port::sendAtomic() and
+     * Port::recvAtomic() when accessing memory in this mode.
+     */
+    bool isAtomicMode() const {
+        return memoryMode == Enums::atomic ||
+            memoryMode == Enums::atomic_noncaching;
+    }
 
-    static const char *MemoryModeStrings[3];
+    /**
+     * Is the system in timing mode?
+     *
+     * SimObjects are expected to use Port::sendTiming() and
+     * Port::recvTiming() when accessing memory in this mode.
+     */
+    bool isTimingMode() const {
+        return memoryMode == Enums::timing;
+    }
 
-    Enums::MemoryMode
-    getMemoryMode()
-    {
-        assert(memoryMode);
-        return memoryMode;
+    /**
+     * Should caches be bypassed?
+     *
+     * Some CPUs need to bypass caches to allow direct memory
+     * accesses, which is required for hardware virtualization.
+     */
+    bool bypassCaches() const {
+        return memoryMode == Enums::atomic_noncaching;
     }
+    /** @} */
 
-    /** Change the memory mode of the system. This should only be called by the
-     * python!!
-     * @param mode Mode to change to (atomic/timing)
+    /** @{ */
+    /**
+     * Get the memory mode of the system.
+     *
+     * \warn This should only be used by the Python world. The C++
+     * world should use one of the query functions above
+     * (isAtomicMode(), isTimingMode(), bypassCaches()).
+     */
+    Enums::MemoryMode getMemoryMode() const { return memoryMode; }
+
+    /**
+     * Change the memory mode of the system.
+     *
+     * \warn This should only be called by the Python!
+     *
+     * @param mode Mode to change to (atomic/timing/...)
      */
     void setMemoryMode(Enums::MemoryMode mode);
+    /** @} */
 
+    /**
+     * Get the cache line size of the system.
+     */
+    unsigned int cacheLineSize() const { return _cacheLineSize; }
+
+#if THE_ISA != NULL_ISA
     PCEventQueue pcEventQueue;
+#endif
 
     std::vector<ThreadContext *> threadContexts;
     int _numContexts;
+    const bool multiThread;
 
-    ThreadContext *getThreadContext(ThreadID tid)
+    ThreadContext *getThreadContext(ContextID tid)
     {
         return threadContexts[tid];
     }
@@ -161,7 +222,6 @@ class System : public MemObject
     /** Port to physical memory used for writing object files into ram at
      * boot.*/
     PortProxy physProxy;
-    FSTranslatingPortProxy virtProxy;
 
     /** kernel symbol table */
     SymbolTable *kernelSymtab;
@@ -169,7 +229,10 @@ class System : public MemObject
     /** Object pointer for the kernel code */
     ObjectFile *kernel;
 
-    /** Begining of kernel code */
+    /** Additional object files */
+    std::vector<ObjectFile *> kernelExtras;
+
+    /** Beginning of kernel code */
     Addr kernelStart;
 
     /** End of kernel code */
@@ -186,15 +249,25 @@ class System : public MemObject
      */
     Addr loadAddrMask;
 
-  protected:
-    uint64_t nextPID;
+    /** Offset that should be used for binary/symbol loading.
+     * This further allows more flexibility than the loadAddrMask allows alone
+     * in loading kernels and similar. The loadAddrOffset is applied after the
+     * loadAddrMask.
+     */
+    Addr loadAddrOffset;
 
   public:
-    uint64_t allocatePID()
-    {
-        return nextPID++;
+    /**
+     * Get a pointer to the Kernel Virtual Machine (KVM) SimObject,
+     * if present.
+     */
+    KvmVM* getKvmVM() {
+        return kvmVM;
     }
 
+    /** Verify gem5 configuration will support KVM emulation */
+    bool validKvmEnvironment() const;
+
     /** Get a pointer to access the physical memory of the system */
     PhysicalMemory& getPhysMem() { return physmem; }
 
@@ -213,30 +286,57 @@ class System : public MemObject
      */
     bool isMemAddr(Addr addr) const;
 
+    /**
+     * Get the architecture.
+     */
+    Arch getArch() const { return Arch::TheISA; }
+
+     /**
+     * Get the page bytes for the ISA.
+     */
+    Addr getPageBytes() const { return TheISA::PageBytes; }
+
+    /**
+     * Get the number of bits worth of in-page address for the ISA.
+     */
+    Addr getPageShift() const { return TheISA::PageShift; }
+
+    /**
+     * The thermal model used for this system (if any).
+     */
+    ThermalModel * getThermalModel() const { return thermalModel; }
+
   protected:
 
+    KvmVM *const kvmVM;
+
     PhysicalMemory physmem;
 
     Enums::MemoryMode memoryMode;
+
+    const unsigned int _cacheLineSize;
+
     uint64_t workItemsBegin;
     uint64_t workItemsEnd;
     uint32_t numWorkIds;
     std::vector<bool> activeCpus;
 
-    /** This array is a per-sytem list of all devices capable of issuing a
+    /** This array is a per-system list of all devices capable of issuing a
      * memory system request and an associated string for each master id.
      * It's used to uniquely id any master in the system by name for things
      * like cache statistics.
      */
     std::vector<std::string> masterIds;
 
+    ThermalModel * thermalModel;
+
   public:
 
     /** Request an id used to create a request object in the system. All objects
      * that intend to issues requests into the memory system must request an id
      * in the init() phase of startup. All master ids must be fixed by the
-     * regStats() phase that immediately preceeds it. This allows objects in the
-     * memory system to understand how many masters may exist and
+     * regStats() phase that immediately precedes it. This allows objects in
+     * the memory system to understand how many masters may exist and
      * appropriately name the bins of their per-master stats before the stats
      * are finalized
      */
@@ -252,7 +352,7 @@ class System : public MemObject
         return masterIds.size();
     }
 
-    virtual void regStats();
+    void regStats() override;
     /**
      * Called by pseudo_inst to track the number of work items started by this
      * system.
@@ -267,7 +367,7 @@ class System : public MemObject
      * Called by pseudo_inst to track the number of work items completed by
      * this system.
      */
-    uint64_t 
+    uint64_t
     incWorkItemsEnd()
     {
         return ++workItemsEnd;
@@ -278,13 +378,13 @@ class System : public MemObject
      * Returns the total number of cpus that have executed work item begin or
      * ends.
      */
-    int 
+    int
     markWorkItem(int index)
     {
         int count = 0;
         assert(index < activeCpus.size());
         activeCpus[index] = true;
-        for (std::vector<bool>::iterator i = activeCpus.begin(); 
+        for (std::vector<bool>::iterator i = activeCpus.begin();
              i < activeCpus.end(); i++) {
             if (*i) count++;
         }
@@ -309,29 +409,85 @@ class System : public MemObject
         panic("Base fixFuncEventAddr not implemented.\n");
     }
 
+    /** @{ */
     /**
      * Add a function-based event to the given function, to be looked
      * up in the specified symbol table.
+     *
+     * The ...OrPanic flavor of the method causes the simulator to
+     * panic if the symbol can't be found.
+     *
+     * @param symtab Symbol table to use for look up.
+     * @param lbl Function to hook the event to.
+     * @param desc Description to be passed to the event.
+     * @param args Arguments to be forwarded to the event constructor.
      */
-    template <class T>
-    T *addFuncEvent(SymbolTable *symtab, const char *lbl)
+    template <class T, typename... Args>
+    T *addFuncEvent(const SymbolTable *symtab, const char *lbl,
+                    const std::string &desc, Args... args)
     {
-        Addr addr = 0; // initialize only to avoid compiler warning
+        Addr addr M5_VAR_USED = 0; // initialize only to avoid compiler warning
 
+#if THE_ISA != NULL_ISA
         if (symtab->findAddress(lbl, addr)) {
-            T *ev = new T(&pcEventQueue, lbl, fixFuncEventAddr(addr));
+            T *ev = new T(&pcEventQueue, desc, fixFuncEventAddr(addr),
+                          std::forward<Args>(args)...);
             return ev;
         }
+#endif
 
         return NULL;
     }
 
-    /** Add a function-based event to kernel code. */
     template <class T>
-    T *addKernelFuncEvent(const char *lbl)
+    T *addFuncEvent(const SymbolTable *symtab, const char *lbl)
+    {
+        return addFuncEvent<T>(symtab, lbl, lbl);
+    }
+
+    template <class T, typename... Args>
+    T *addFuncEventOrPanic(const SymbolTable *symtab, const char *lbl,
+                           Args... args)
+    {
+        T *e(addFuncEvent<T>(symtab, lbl, std::forward<Args>(args)...));
+        if (!e)
+            panic("Failed to find symbol '%s'", lbl);
+        return e;
+    }
+    /** @} */
+
+    /** @{ */
+    /**
+     * Add a function-based event to a kernel symbol.
+     *
+     * These functions work like their addFuncEvent() and
+     * addFuncEventOrPanic() counterparts. The only difference is that
+     * they automatically use the kernel symbol table. All arguments
+     * are forwarded to the underlying method.
+     *
+     * @see addFuncEvent()
+     * @see addFuncEventOrPanic()
+     *
+     * @param lbl Function to hook the event to.
+     * @param args Arguments to be passed to addFuncEvent
+     */
+    template <class T, typename... Args>
+    T *addKernelFuncEvent(const char *lbl, Args... args)
+    {
+        return addFuncEvent<T>(kernelSymtab, lbl,
+                               std::forward<Args>(args)...);
+    }
+
+    template <class T, typename... Args>
+    T *addKernelFuncEventOrPanic(const char *lbl, Args... args)
     {
-        return addFuncEvent<T>(kernelSymtab, lbl);
+        T *e(addFuncEvent<T>(kernelSymtab, lbl,
+                             std::forward<Args>(args)...));
+        if (!e)
+            panic("Failed to find kernel symbol '%s'", lbl);
+        return e;
     }
+    /** @} */
 
   public:
     std::vector<BaseRemoteGDB *> remoteGDB;
@@ -348,26 +504,26 @@ class System : public MemObject
     System(Params *p);
     ~System();
 
-    void initState();
+    void initState() override;
 
     const Params *params() const { return (const Params *)_params; }
 
   public:
 
     /**
-     * Returns the addess the kernel starts at.
+     * Returns the address the kernel starts at.
      * @return address the kernel starts at
      */
     Addr getKernelStart() const { return kernelStart; }
 
     /**
-     * Returns the addess the kernel ends at.
+     * Returns the address the kernel ends at.
      * @return address the kernel ends at
      */
     Addr getKernelEnd() const { return kernelEnd; }
 
     /**
-     * Returns the addess the entry point to the kernel code.
+     * Returns the address the entry point to the kernel code.
      * @return entry point of the kernel code
      */
     Addr getKernelEntry() const { return kernelEntry; }
@@ -376,12 +532,14 @@ class System : public MemObject
     /// @return Starting address of first page
     Addr allocPhysPages(int npages);
 
-    int registerThreadContext(ThreadContext *tc, int assigned=-1);
-    void replaceThreadContext(ThreadContext *tc, int context_id);
+    ContextID registerThreadContext(ThreadContext *tc,
+                                    ContextID assigned = InvalidContextID);
+    void replaceThreadContext(ThreadContext *tc, ContextID context_id);
 
-    void serialize(std::ostream &os);
-    void unserialize(Checkpoint *cp, const std::string &section);
-    virtual void resume();
+    void serialize(CheckpointOut &cp) const override;
+    void unserialize(CheckpointIn &cp) override;
+
+    void drainResume() override;
 
   public:
     Counter totalNumInsts;
@@ -400,7 +558,39 @@ class System : public MemObject
 
     static void printSystems();
 
+    FutexMap futexMap;
+
+    static const int maxPID = 32768;
+
+    /** Process set to track which PIDs have already been allocated */
+    std::set<int> PIDs;
+
+    // By convention, all signals are owned by the receiving process. The
+    // receiver will delete the signal upon reception.
+    std::list<BasicSignal> signalList;
+
+  protected:
+
+    /**
+     * If needed, serialize additional symbol table entries for a
+     * specific subclass of this system. Currently this is used by
+     * Alpha and MIPS.
+     *
+     * @param os stream to serialize to
+     */
+    virtual void serializeSymtab(CheckpointOut &os) const {}
+
+    /**
+     * If needed, unserialize additional symbol table entries for a
+     * specific subclass of this system.
+     *
+     * @param cp checkpoint to unserialize from
+     * @param section relevant section in the checkpoint
+     */
+    virtual void unserializeSymtab(CheckpointIn &cp) {}
 
 };
 
+void printSystems();
+
 #endif // __SYSTEM_HH__