src/sim/process.hh

   1 /*
   2  * Copyright (c) 2001-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: Nathan Binkert
  29  *          Steve Reinhardt
  30  */
  31
  32 #ifndef __PROCESS_HH__
  33 #define __PROCESS_HH__
  34
  35 #include <string>
  36 #include <vector>
  37
  38 #include "arch/registers.hh"
  39 #include "base/statistics.hh"
  40 #include "base/types.hh"
  41 #include "config/the_isa.hh"
  42 #include "mem/se_translating_port_proxy.hh"
  43 #include "sim/sim_object.hh"
  44 #include "sim/syscallreturn.hh"
  45
  46 class PageTable;
  47 struct ProcessParams;
  48 struct LiveProcessParams;
  49 class SyscallDesc;
  50 class System;
  51 class ThreadContext;
  52
  53 template<class IntType>
  54 struct AuxVector
  55 {
  56     IntType a_type;
  57     IntType a_val;
  58
  59     AuxVector()
  60     {}
  61
  62     AuxVector(IntType type, IntType val);
  63 };
  64
  65 class Process : public SimObject
  66 {
  67   public:
  68
  69     /// Pointer to object representing the system this process is
  70     /// running on.
  71     System *system;
  72
  73     // thread contexts associated with this process
  74     std::vector<int> contextIds;
  75
  76     // number of CPUs (esxec contexts, really) assigned to this process.
  77     unsigned int numCpus() { return contextIds.size(); }
  78
  79     // record of blocked context
  80     struct WaitRec
  81     {
  82         Addr waitChan;
  83         ThreadContext *waitingContext;
  84
  85         WaitRec(Addr chan, ThreadContext *ctx)
  86             : waitChan(chan), waitingContext(ctx)
  87         {       }
  88     };
  89
  90     // list of all blocked contexts
  91     std::list<WaitRec> waitList;
  92
  93     Addr brk_point;             // top of the data segment
  94
  95     Addr stack_base;            // stack segment base (highest address)
  96     unsigned stack_size;        // initial stack size
  97     Addr stack_min;             // lowest address accessed on the stack
  98
  99     // The maximum size allowed for the stack.
 100     Addr max_stack_size;
 101
 102     // addr to use for next stack region (for multithreaded apps)
 103     Addr next_thread_stack_base;
 104
 105     // Base of region for mmaps (when user doesn't specify an address).
 106     Addr mmap_start;
 107     Addr mmap_end;
 108
 109     // Base of region for nxm data
 110     Addr nxm_start;
 111     Addr nxm_end;
 112
 113     Stats::Scalar num_syscalls;       // number of syscalls executed
 114
 115   protected:
 116     // constructor
 117     Process(ProcessParams *params);
 118
 119     virtual void initState();
 120
 121   public:
 122
 123     //This id is assigned by m5 and is used to keep process' tlb entries
 124     //separated.
 125     uint64_t M5_pid;
 126
 127     PageTable* pTable;
 128
 129     class FdMap
 130     {
 131       public:
 132         int fd;
 133         std::string filename;
 134         int mode;
 135         int flags;
 136         bool isPipe;
 137         int readPipeSource;
 138         uint64_t fileOffset;
 139
 140         FdMap()
 141             : fd(-1), filename("NULL"), mode(0), flags(0),
 142               isPipe(false), readPipeSource(0), fileOffset(0)
 143         { }
 144
 145         void serialize(std::ostream &os);
 146         void unserialize(Checkpoint *cp, const std::string &section);
 147     };
 148
 149   protected:
 150     /// Memory proxy for initialization (image loading)
 151     SETranslatingPortProxy initVirtMem;
 152
 153   private:
 154     // file descriptor remapping support
 155     static const int MAX_FD = 256;    // max legal fd value
 156     FdMap fd_map[MAX_FD+1];
 157
 158
 159   public:
 160     // static helper functions to generate file descriptors for constructor
 161     static int openInputFile(const std::string &filename);
 162     static int openOutputFile(const std::string &filename);
 163
 164     // override of virtual SimObject method: register statistics
 165     virtual void regStats();
 166
 167     // After getting registered with system object, tell process which
 168     // system-wide context id it is assigned.
 169     void assignThreadContext(int context_id)
 170     {
 171         contextIds.push_back(context_id);
 172     }
 173
 174     // Find a free context to use
 175     ThreadContext *findFreeContext();
 176
 177     // provide program name for debug messages
 178     virtual const char *progName() const { return "<unknown>"; }
 179
 180     // map simulator fd sim_fd to target fd tgt_fd
 181     void dup_fd(int sim_fd, int tgt_fd);
 182
 183     // generate new target fd for sim_fd
 184     int alloc_fd(int sim_fd, std::string filename, int flags, int mode,
 185                  bool pipe);
 186
 187     // free target fd (e.g., after close)
 188     void free_fd(int tgt_fd);
 189
 190     // look up simulator fd for given target fd
 191     int sim_fd(int tgt_fd);
 192
 193     // look up simulator fd_map object for a given target fd
 194     FdMap *sim_fd_obj(int tgt_fd);
 195
 196     // fix all offsets for currently open files and save them
 197     void fix_file_offsets();
 198
 199     // find all offsets for currently open files and save them
 200     void find_file_offsets();
 201
 202     // set the source of this read pipe for a checkpoint resume
 203     void setReadPipeSource(int read_pipe_fd, int source_fd);
 204
 205     virtual void syscall(int64_t callnum, ThreadContext *tc) = 0;
 206
 207     void allocateMem(Addr vaddr, int64_t size, bool clobber = false);
 208
 209     /// Attempt to fix up a fault at vaddr by allocating a page on the stack.
 210     /// @return Whether the fault has been fixed.
 211     bool fixupStackFault(Addr vaddr);
 212
 213     /**
 214      * Map a contiguous range of virtual addresses in this process's
 215      * address space to a contiguous range of physical addresses.
 216      * This function exists primarily to enable exposing the map
 217      * operation to python, so that configuration scripts can set up
 218      * mappings in SE mode.
 219      *
 220      * @param vaddr The starting virtual address of the range.
 221      * @param paddr The starting physical address of the range.
 222      * @param size The length of the range in bytes.
 223      * @return True if the map operation was successful.  (At this
 224      *           point in time, the map operation always succeeds.)
 225      */
 226     bool map(Addr vaddr, Addr paddr, int size);
 227
 228     void serialize(std::ostream &os);
 229     void unserialize(Checkpoint *cp, const std::string &section);
 230 };
 231
 232 //
 233 // "Live" process with system calls redirected to host system
 234 //
 235 class ObjectFile;
 236 class LiveProcess : public Process
 237 {
 238   protected:
 239     ObjectFile *objFile;
 240     std::vector<std::string> argv;
 241     std::vector<std::string> envp;
 242     std::string cwd;
 243
 244     LiveProcess(LiveProcessParams *params, ObjectFile *objFile);
 245
 246     // Id of the owner of the process
 247     uint64_t __uid;
 248     uint64_t __euid;
 249     uint64_t __gid;
 250     uint64_t __egid;
 251
 252     // pid of the process and it's parent
 253     uint64_t __pid;
 254     uint64_t __ppid;
 255
 256   public:
 257
 258     enum AuxiliaryVectorType {
 259         M5_AT_NULL = 0,
 260         M5_AT_IGNORE = 1,
 261         M5_AT_EXECFD = 2,
 262         M5_AT_PHDR = 3,
 263         M5_AT_PHENT = 4,
 264         M5_AT_PHNUM = 5,
 265         M5_AT_PAGESZ = 6,
 266         M5_AT_BASE = 7,
 267         M5_AT_FLAGS = 8,
 268         M5_AT_ENTRY = 9,
 269         M5_AT_NOTELF = 10,
 270         M5_AT_UID = 11,
 271         M5_AT_EUID = 12,
 272         M5_AT_GID = 13,
 273         M5_AT_EGID = 14,
 274         // The following may be specific to Linux
 275         M5_AT_PLATFORM = 15,
 276         M5_AT_HWCAP = 16,
 277         M5_AT_CLKTCK = 17,
 278
 279         M5_AT_SECURE = 23,
 280         M5_BASE_PLATFORM = 24,
 281         M5_AT_RANDOM = 25,
 282
 283         M5_AT_EXECFN = 31,
 284
 285         M5_AT_VECTOR_SIZE = 44
 286     };
 287
 288     inline uint64_t uid() {return __uid;}
 289     inline uint64_t euid() {return __euid;}
 290     inline uint64_t gid() {return __gid;}
 291     inline uint64_t egid() {return __egid;}
 292     inline uint64_t pid() {return __pid;}
 293     inline uint64_t ppid() {return __ppid;}
 294
 295     // provide program name for debug messages
 296     virtual const char *progName() const { return argv[0].c_str(); }
 297
 298     std::string
 299     fullPath(const std::string &filename)
 300     {
 301         if (filename[0] == '/' || cwd.empty())
 302             return filename;
 303
 304         std::string full = cwd;
 305
 306         if (cwd[cwd.size() - 1] != '/')
 307             full += '/';
 308
 309         return full + filename;
 310     }
 311
 312     std::string getcwd() const { return cwd; }
 313
 314     virtual void syscall(int64_t callnum, ThreadContext *tc);
 315
 316     virtual TheISA::IntReg getSyscallArg(ThreadContext *tc, int &i) = 0;
 317     virtual TheISA::IntReg getSyscallArg(ThreadContext *tc, int &i, int width);
 318     virtual void setSyscallArg(ThreadContext *tc,
 319             int i, TheISA::IntReg val) = 0;
 320     virtual void setSyscallReturn(ThreadContext *tc,
 321             SyscallReturn return_value) = 0;
 322
 323     virtual SyscallDesc *getDesc(int callnum) = 0;
 324
 325     // this function is used to create the LiveProcess object, since
 326     // we can't tell which subclass of LiveProcess to use until we
 327     // open and look at the object file.
 328     static LiveProcess *create(LiveProcessParams *params);
 329 };
 330
 331
 332 #endif // __PROCESS_HH__