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 //
  36 // The purpose of this code is to fake the loader & syscall mechanism
  37 // when there's no OS: thus there's no reason to use it in FULL_SYSTEM
  38 // mode when we do have an OS.
  39 //
  40 #include "config/full_system.hh"
  41
  42 #if !FULL_SYSTEM
  43
  44 #include <vector>
  45
  46 #include "base/statistics.hh"
  47 #include "sim/sim_object.hh"
  48
  49 class ThreadContext;
  50 class SyscallDesc;
  51 class PageTable;
  52 class TranslatingPort;
  53 class System;
  54
  55 void
  56 copyStringArray(std::vector<std::string> &strings, Addr array_ptr,
  57         Addr data_ptr, TranslatingPort* memPort);
  58
  59 class Process : public SimObject
  60 {
  61   public:
  62
  63     /// Pointer to object representing the system this process is
  64     /// running on.
  65     System *system;
  66
  67     // have we initialized a thread context from this process?  If
  68     // yes, subsequent contexts are assumed to be for dynamically
  69     // created threads and are not initialized.
  70     bool initialContextLoaded;
  71
  72     // thread contexts associated with this process
  73     std::vector<ThreadContext *> threadContexts;
  74
  75     // number of CPUs (esxec contexts, really) assigned to this process.
  76     unsigned int numCpus() { return threadContexts.size(); }
  77
  78     // record of blocked context
  79     struct WaitRec
  80     {
  81         Addr waitChan;
  82         ThreadContext *waitingContext;
  83
  84         WaitRec(Addr chan, ThreadContext *ctx)
  85             : waitChan(chan), waitingContext(ctx)
  86         {       }
  87     };
  88
  89     // list of all blocked contexts
  90     std::list<WaitRec> waitList;
  91
  92     Addr brk_point;             // top of the data segment
  93
  94     Addr stack_base;            // stack segment base (highest address)
  95     unsigned stack_size;        // initial stack size
  96     Addr stack_min;             // lowest address accessed on the stack
  97
  98     // addr to use for next stack region (for multithreaded apps)
  99     Addr next_thread_stack_base;
 100
 101     // Base of region for mmaps (when user doesn't specify an address).
 102     Addr mmap_start;
 103     Addr mmap_end;
 104
 105     // Base of region for nxm data
 106     Addr nxm_start;
 107     Addr nxm_end;
 108
 109     std::string prog_fname;     // file name
 110
 111     Stats::Scalar<> num_syscalls;       // number of syscalls executed
 112
 113
 114   protected:
 115     // constructor
 116     Process(const std::string &nm,
 117             System *_system,
 118             int stdin_fd,       // initial I/O descriptors
 119             int stdout_fd,
 120             int stderr_fd);
 121
 122     // post initialization startup
 123     virtual void startup();
 124
 125   protected:
 126     /// Memory object for initialization (image loading)
 127     TranslatingPort *initVirtMem;
 128
 129   public:
 130     PageTable *pTable;
 131
 132   private:
 133     // file descriptor remapping support
 134     static const int MAX_FD = 256;      // max legal fd value
 135     int fd_map[MAX_FD+1];
 136
 137   public:
 138     // static helper functions to generate file descriptors for constructor
 139     static int openInputFile(const std::string &filename);
 140     static int openOutputFile(const std::string &filename);
 141
 142     // override of virtual SimObject method: register statistics
 143     virtual void regStats();
 144
 145     // register a thread context for this process.
 146     // returns tc's cpu number (index into threadContexts[])
 147     int registerThreadContext(ThreadContext *tc);
 148
 149
 150     void replaceThreadContext(ThreadContext *tc, int tcIndex);
 151
 152     // map simulator fd sim_fd to target fd tgt_fd
 153     void dup_fd(int sim_fd, int tgt_fd);
 154
 155     // generate new target fd for sim_fd
 156     int alloc_fd(int sim_fd);
 157
 158     // free target fd (e.g., after close)
 159     void free_fd(int tgt_fd);
 160
 161     // look up simulator fd for given target fd
 162     int sim_fd(int tgt_fd);
 163
 164     virtual void syscall(int64_t callnum, ThreadContext *tc) = 0;
 165
 166     void serialize(std::ostream &os);
 167     void unserialize(Checkpoint *cp, const std::string &section);
 168 };
 169
 170 //
 171 // "Live" process with system calls redirected to host system
 172 //
 173 class ObjectFile;
 174 class LiveProcess : public Process
 175 {
 176   protected:
 177     ObjectFile *objFile;
 178     std::vector<std::string> argv;
 179     std::vector<std::string> envp;
 180
 181     LiveProcess(const std::string &nm, ObjectFile *objFile,
 182                 System *_system, int stdin_fd, int stdout_fd, int stderr_fd,
 183                 std::vector<std::string> &argv,
 184                 std::vector<std::string> &envp,
 185                 uint64_t _uid, uint64_t _euid,
 186                 uint64_t _gid, uint64_t _egid,
 187                 uint64_t _pid, uint64_t _ppid);
 188
 189     virtual void argsInit(int intSize, int pageSize);
 190
 191     // Id of the owner of the process
 192     uint64_t __uid;
 193     uint64_t __euid;
 194     uint64_t __gid;
 195     uint64_t __egid;
 196
 197     // pid of the process and it's parent
 198     uint64_t __pid;
 199     uint64_t __ppid;
 200
 201   public:
 202
 203     inline uint64_t uid() {return __uid;}
 204     inline uint64_t euid() {return __euid;}
 205     inline uint64_t gid() {return __gid;}
 206     inline uint64_t egid() {return __egid;}
 207     inline uint64_t pid() {return __pid;}
 208     inline uint64_t ppid() {return __ppid;}
 209
 210     virtual void syscall(int64_t callnum, ThreadContext *tc);
 211
 212     virtual SyscallDesc* getDesc(int callnum) = 0;
 213
 214     // this function is used to create the LiveProcess object, since
 215     // we can't tell which subclass of LiveProcess to use until we
 216     // open and look at the object file.
 217     static LiveProcess *create(const std::string &nm,
 218                                System *_system,
 219                                int stdin_fd, int stdout_fd, int stderr_fd,
 220                                std::string executable,
 221                                std::vector<std::string> &argv,
 222                                std::vector<std::string> &envp,
 223                                uint64_t _uid, uint64_t _euid,
 224                                uint64_t _gid, uint64_t _egid,
 225                                uint64_t _pid, uint64_t _ppid);
 226 };
 227
 228
 229 #endif // !FULL_SYSTEM
 230
 231 #endif // __PROCESS_HH__