base: refactor process class (specifically FdMap and friends)
[gem5.git] / src / sim / process.hh
index 1226db81b9b4644800e72526e85aa05c6071e74b..2de83565ca709fb33c33995625f333c9bcc26489 100644 (file)
@@ -1,4 +1,5 @@
 /*
+ * Copyright (c) 2014 Advanced Micro Devices, Inc.
  * Copyright (c) 2001-2005 The Regents of The University of Michigan
  * All rights reserved.
  *
 #ifndef __PROCESS_HH__
 #define __PROCESS_HH__
 
-//
-// The purpose of this code is to fake the loader & syscall mechanism
-// when there's no OS: thus there's no reason to use it in FULL_SYSTEM
-// mode when we do have an OS.
-//
-#include "config/full_system.hh"
-
-#if !FULL_SYSTEM
-
+#include <array>
+#include <string>
 #include <vector>
 
+#include "arch/registers.hh"
 #include "base/statistics.hh"
-#include "sim/host.hh"
+#include "base/types.hh"
+#include "config/the_isa.hh"
+#include "mem/se_translating_port_proxy.hh"
+#include "sim/fd_entry.hh"
 #include "sim/sim_object.hh"
+#include "sim/syscallreturn.hh"
 
-class ThreadContext;
-class SyscallDesc;
 class PageTable;
-class TranslatingPort;
+struct ProcessParams;
+struct LiveProcessParams;
+class SyscallDesc;
 class System;
-class GDBListener;
-namespace TheISA
+class ThreadContext;
+class EmulatedDriver;
+
+template<class IntType>
+struct AuxVector
 {
-    class RemoteGDB;
-}
+    IntType a_type;
+    IntType a_val;
 
-void
-copyStringArray(std::vector<std::string> &strings, Addr array_ptr,
-        Addr data_ptr, TranslatingPort* memPort, int ptr_size = sizeof(Addr));
+    AuxVector()
+    {}
+
+    AuxVector(IntType type, IntType val);
+};
 
 class Process : public SimObject
 {
@@ -70,21 +74,11 @@ class Process : public SimObject
     /// running on.
     System *system;
 
-    // have we initialized a thread context from this process?  If
-    // yes, subsequent contexts are assumed to be for dynamically
-    // created threads and are not initialized.
-    bool initialContextLoaded;
-
     // thread contexts associated with this process
-    std::vector<ThreadContext *> threadContexts;
-
-    // remote gdb objects
-    std::vector<TheISA::RemoteGDB *> remoteGDB;
-    std::vector<GDBListener *> gdbListen;
-    bool breakpoint();
+    std::vector<int> contextIds;
 
     // number of CPUs (esxec contexts, really) assigned to this process.
-    unsigned int numCpus() { return threadContexts.size(); }
+    unsigned int numCpus() { return contextIds.size(); }
 
     // record of blocked context
     struct WaitRec
@@ -94,17 +88,20 @@ class Process : public SimObject
 
         WaitRec(Addr chan, ThreadContext *ctx)
             : waitChan(chan), waitingContext(ctx)
-        {      }
+        {       }
     };
 
     // list of all blocked contexts
     std::list<WaitRec> waitList;
 
-    Addr brk_point;            // top of the data segment
+    Addr brk_point;             // top of the data segment
+
+    Addr stack_base;            // stack segment base (highest address)
+    unsigned stack_size;        // initial stack size
+    Addr stack_min;             // lowest address accessed on the stack
 
-    Addr stack_base;           // stack segment base (highest address)
-    unsigned stack_size;       // initial stack size
-    Addr stack_min;            // lowest address accessed on the stack
+    // The maximum size allowed for the stack.
+    Addr max_stack_size;
 
     // addr to use for next stack region (for multithreaded apps)
     Addr next_thread_stack_base;
@@ -117,65 +114,117 @@ class Process : public SimObject
     Addr nxm_start;
     Addr nxm_end;
 
-    std::string prog_fname;    // file name
-
-    Stats::Scalar<> num_syscalls;      // number of syscalls executed
-
+    Stats::Scalar num_syscalls;       // number of syscalls executed
 
   protected:
     // constructor
-    Process(const std::string &nm,
-            System *_system,
-            int stdin_fd,      // initial I/O descriptors
-            int stdout_fd,
-            int stderr_fd);
+    Process(ProcessParams *params);
 
-    // post initialization startup
-    virtual void startup();
+    virtual void initState();
 
-  protected:
-    /// Memory object for initialization (image loading)
-    TranslatingPort *initVirtMem;
+    DrainState drain() M5_ATTR_OVERRIDE;
 
   public:
-    PageTable *pTable;
+
+    //This id is assigned by m5 and is used to keep process' tlb entries
+    //separated.
+    uint64_t M5_pid;
+
+    // flag for using architecture specific page table
+    bool useArchPT;
+    // running KvmCPU in SE mode requires special initialization
+    bool kvmInSE;
+
+    PageTableBase* pTable;
+
+  protected:
+    /// Memory proxy for initialization (image loading)
+    SETranslatingPortProxy initVirtMem;
 
   private:
-    // file descriptor remapping support
-    static const int MAX_FD = 256;     // max legal fd value
-    int fd_map[MAX_FD+1];
+    static const int NUM_FDS = 1024;
+
+    // File descriptor remapping support.
+    std::shared_ptr<std::array<FDEntry, NUM_FDS>> fd_array;
+
+    // Standard file descriptor options for initialization and checkpoints.
+    std::map<std::string, int> imap;
+    std::map<std::string, int> oemap;
 
   public:
-    // static helper functions to generate file descriptors for constructor
-    static int openInputFile(const std::string &filename);
-    static int openOutputFile(const std::string &filename);
+    // inherit file descriptor map from another process (necessary for clone)
+    void inheritFdArray(Process *p);
 
     // override of virtual SimObject method: register statistics
     virtual void regStats();
 
-    // register a thread context for this process.
-    // returns tc's cpu number (index into threadContexts[])
-    int registerThreadContext(ThreadContext *tc);
-
+    // After getting registered with system object, tell process which
+    // system-wide context id it is assigned.
+    void assignThreadContext(int context_id)
+    {
+        contextIds.push_back(context_id);
+    }
 
-    void replaceThreadContext(ThreadContext *tc, int tcIndex);
+    // Find a free context to use
+    ThreadContext *findFreeContext();
 
-    // map simulator fd sim_fd to target fd tgt_fd
-    void dup_fd(int sim_fd, int tgt_fd);
+    // provide program name for debug messages
+    virtual const char *progName() const { return "<unknown>"; }
 
     // generate new target fd for sim_fd
-    int alloc_fd(int sim_fd);
+    int alloc_fd(int sim_fd, const std::string& filename, int flags, int mode,
+                 bool pipe);
 
-    // free target fd (e.g., after close)
-    void free_fd(int tgt_fd);
+    // disassociate target fd with simulator fd and cleanup subsidiary fields
+    void reset_fd_entry(int tgt_fd);
 
     // look up simulator fd for given target fd
     int sim_fd(int tgt_fd);
 
+    // look up fd entry for a given target fd
+    FDEntry *get_fd_entry(int tgt_fd);
+
+    // look up target fd for given host fd
+    // Assumes a 1:1 mapping between target file descriptor and host file
+    // descriptor. Given the current API, this must be true given that it's
+    // not possible to map multiple target file descriptors to the same host
+    // file descriptor
+    int tgt_fd(int sim_fd);
+
+    // fix all offsets for currently open files and save them
+    void fix_file_offsets();
+
+    // find all offsets for currently open files and save them
+    void find_file_offsets();
+
+    // set the source of this read pipe for a checkpoint resume
+    void setReadPipeSource(int read_pipe_fd, int source_fd);
+
     virtual void syscall(int64_t callnum, ThreadContext *tc) = 0;
 
-    void serialize(std::ostream &os);
-    void unserialize(Checkpoint *cp, const std::string &section);
+    void allocateMem(Addr vaddr, int64_t size, bool clobber = false);
+
+    /// Attempt to fix up a fault at vaddr by allocating a page on the stack.
+    /// @return Whether the fault has been fixed.
+    bool fixupStackFault(Addr vaddr);
+
+    /**
+     * Maps a contiguous range of virtual addresses in this process's
+     * address space to a contiguous range of physical addresses.
+     * This function exists primarily to expose the map operation to
+     * python, so that configuration scripts can set up mappings in SE mode.
+     *
+     * @param vaddr The starting virtual address of the range.
+     * @param paddr The starting physical address of the range.
+     * @param size The length of the range in bytes.
+     * @param cacheable Specifies whether accesses are cacheable.
+     * @return True if the map operation was successful.  (At this
+     *           point in time, the map operation always succeeds.)
+     */
+    bool map(Addr vaddr, Addr paddr, int size, bool cacheable = true);
+
+    void serialize(CheckpointOut &cp) const M5_ATTR_OVERRIDE;
+    void unserialize(CheckpointIn &cp) M5_ATTR_OVERRIDE;
 };
 
 //
@@ -190,16 +239,7 @@ class LiveProcess : public Process
     std::vector<std::string> envp;
     std::string cwd;
 
-    LiveProcess(const std::string &nm, ObjectFile *objFile,
-                System *_system, int stdin_fd, int stdout_fd, int stderr_fd,
-                std::vector<std::string> &argv,
-                std::vector<std::string> &envp,
-                const std::string &cwd,
-                uint64_t _uid, uint64_t _euid,
-                uint64_t _gid, uint64_t _egid,
-                uint64_t _pid, uint64_t _ppid);
-
-    virtual void argsInit(int intSize, int pageSize);
+    LiveProcess(LiveProcessParams *params, ObjectFile *objFile);
 
     // Id of the owner of the process
     uint64_t __uid;
@@ -211,8 +251,41 @@ class LiveProcess : public Process
     uint64_t __pid;
     uint64_t __ppid;
 
+    // Emulated drivers available to this process
+    std::vector<EmulatedDriver *> drivers;
+
   public:
 
+    enum AuxiliaryVectorType {
+        M5_AT_NULL = 0,
+        M5_AT_IGNORE = 1,
+        M5_AT_EXECFD = 2,
+        M5_AT_PHDR = 3,
+        M5_AT_PHENT = 4,
+        M5_AT_PHNUM = 5,
+        M5_AT_PAGESZ = 6,
+        M5_AT_BASE = 7,
+        M5_AT_FLAGS = 8,
+        M5_AT_ENTRY = 9,
+        M5_AT_NOTELF = 10,
+        M5_AT_UID = 11,
+        M5_AT_EUID = 12,
+        M5_AT_GID = 13,
+        M5_AT_EGID = 14,
+        // The following may be specific to Linux
+        M5_AT_PLATFORM = 15,
+        M5_AT_HWCAP = 16,
+        M5_AT_CLKTCK = 17,
+
+        M5_AT_SECURE = 23,
+        M5_BASE_PLATFORM = 24,
+        M5_AT_RANDOM = 25,
+
+        M5_AT_EXECFN = 31,
+
+        M5_AT_VECTOR_SIZE = 44
+    };
+
     inline uint64_t uid() {return __uid;}
     inline uint64_t euid() {return __euid;}
     inline uint64_t gid() {return __gid;}
@@ -220,6 +293,9 @@ class LiveProcess : public Process
     inline uint64_t pid() {return __pid;}
     inline uint64_t ppid() {return __ppid;}
 
+    // provide program name for debug messages
+    virtual const char *progName() const { return argv[0].c_str(); }
+
     std::string
     fullPath(const std::string &filename)
     {
@@ -234,26 +310,32 @@ class LiveProcess : public Process
         return full + filename;
     }
 
+    std::string getcwd() const { return cwd; }
+
     virtual void syscall(int64_t callnum, ThreadContext *tc);
 
-    virtual SyscallDesc* getDesc(int callnum) = 0;
+    virtual TheISA::IntReg getSyscallArg(ThreadContext *tc, int &i) = 0;
+    virtual TheISA::IntReg getSyscallArg(ThreadContext *tc, int &i, int width);
+    virtual void setSyscallArg(ThreadContext *tc,
+            int i, TheISA::IntReg val) = 0;
+    virtual void setSyscallReturn(ThreadContext *tc,
+            SyscallReturn return_value) = 0;
+
+    virtual SyscallDesc *getDesc(int callnum) = 0;
+
+    /**
+     * Find an emulated device driver.
+     *
+     * @param filename Name of the device (under /dev)
+     * @return Pointer to driver object if found, else NULL
+     */
+    EmulatedDriver *findDriver(std::string filename);
 
     // this function is used to create the LiveProcess object, since
     // we can't tell which subclass of LiveProcess to use until we
     // open and look at the object file.
-    static LiveProcess *create(const std::string &nm,
-                               System *_system,
-                               int stdin_fd, int stdout_fd, int stderr_fd,
-                               std::string executable,
-                               std::vector<std::string> &argv,
-                               std::vector<std::string> &envp,
-                               const std::string &cwd,
-                               uint64_t _uid, uint64_t _euid,
-                               uint64_t _gid, uint64_t _egid,
-                               uint64_t _pid, uint64_t _ppid);
+    static LiveProcess *create(LiveProcessParams *params);
 };
 
 
-#endif // !FULL_SYSTEM
-
 #endif // __PROCESS_HH__