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
  29 #ifndef __PROCESS_HH__
  30 #define __PROCESS_HH__
  31
  32 //
  33 // The purpose of this code is to fake the loader & syscall mechanism
  34 // when there's no OS: thus there's no reason to use it in FULL_SYSTEM
  35 // mode when we do have an OS.
  36 //
  37 #include "config/full_system.hh"
  38
  39 #if !FULL_SYSTEM
  40
  41 #include <vector>
  42
  43 #include "base/statistics.hh"
  44 #include "sim/sim_object.hh"
  45
  46 class CPUExecContext;
  47 class ExecContext;
  48 class SyscallDesc;
  49 class PageTable;
  50 class TranslatingPort;
  51 class System;
  52
  53 void
  54 copyStringArray(std::vector<std::string> &strings, Addr array_ptr,
  55         Addr data_ptr, TranslatingPort* memPort);
  56
  57 class Process : public SimObject
  58 {
  59   public:
  60
  61     /// Pointer to object representing the system this process is
  62     /// running on.
  63     System *system;
  64
  65     // have we initialized an execution context from this process?  If
  66     // yes, subsequent contexts are assumed to be for dynamically
  67     // created threads and are not initialized.
  68     bool initialContextLoaded;
  69
  70     // execution contexts associated with this process
  71     std::vector<ExecContext *> execContexts;
  72
  73     // number of CPUs (esxec contexts, really) assigned to this process.
  74     unsigned int numCpus() { return execContexts.size(); }
  75
  76     // record of blocked context
  77     struct WaitRec
  78     {
  79         Addr waitChan;
  80         ExecContext *waitingContext;
  81
  82         WaitRec(Addr chan, ExecContext *ctx)
  83             : waitChan(chan), waitingContext(ctx)
  84         {       }
  85     };
  86
  87     // list of all blocked contexts
  88     std::list<WaitRec> waitList;
  89
  90     Addr brk_point;             // top of the data segment
  91
  92     Addr stack_base;            // stack segment base (highest address)
  93     unsigned stack_size;        // initial stack size
  94     Addr stack_min;             // lowest address accessed on the stack
  95
  96     // addr to use for next stack region (for multithreaded apps)
  97     Addr next_thread_stack_base;
  98
  99     // Base of region for mmaps (when user doesn't specify an address).
 100     Addr mmap_start;
 101     Addr mmap_end;
 102
 103     // Base of region for nxm data
 104     Addr nxm_start;
 105     Addr nxm_end;
 106
 107     std::string prog_fname;     // file name
 108
 109     Stats::Scalar<> num_syscalls;       // number of syscalls executed
 110
 111
 112   protected:
 113     // constructor
 114     Process(const std::string &nm,
 115             System *_system,
 116             int stdin_fd,       // initial I/O descriptors
 117             int stdout_fd,
 118             int stderr_fd);
 119
 120     // post initialization startup
 121     virtual void startup();
 122
 123   protected:
 124     /// Memory object for initialization (image loading)
 125     TranslatingPort *initVirtMem;
 126
 127   public:
 128     PageTable *pTable;
 129
 130   private:
 131     // file descriptor remapping support
 132     static const int MAX_FD = 256;      // max legal fd value
 133     int fd_map[MAX_FD+1];
 134
 135   public:
 136     // static helper functions to generate file descriptors for constructor
 137     static int openInputFile(const std::string &filename);
 138     static int openOutputFile(const std::string &filename);
 139
 140     // override of virtual SimObject method: register statistics
 141     virtual void regStats();
 142
 143     // register an execution context for this process.
 144     // returns xc's cpu number (index into execContexts[])
 145     int registerExecContext(ExecContext *xc);
 146
 147
 148     void replaceExecContext(ExecContext *xc, int xcIndex);
 149
 150     // map simulator fd sim_fd to target fd tgt_fd
 151     void dup_fd(int sim_fd, int tgt_fd);
 152
 153     // generate new target fd for sim_fd
 154     int alloc_fd(int sim_fd);
 155
 156     // free target fd (e.g., after close)
 157     void free_fd(int tgt_fd);
 158
 159     // look up simulator fd for given target fd
 160     int sim_fd(int tgt_fd);
 161
 162     virtual void syscall(int64_t callnum, ExecContext *xc) = 0;
 163 };
 164
 165 //
 166 // "Live" process with system calls redirected to host system
 167 //
 168 class ObjectFile;
 169 class LiveProcess : public Process
 170 {
 171   protected:
 172     ObjectFile *objFile;
 173     std::vector<std::string> argv;
 174     std::vector<std::string> envp;
 175
 176     LiveProcess(const std::string &nm, ObjectFile *objFile,
 177                 System *_system, int stdin_fd, int stdout_fd, int stderr_fd,
 178                 std::vector<std::string> &argv,
 179                 std::vector<std::string> &envp);
 180
 181     virtual void argsInit(int intSize, int pageSize);
 182
 183   public:
 184     virtual void syscall(int64_t callnum, ExecContext *xc);
 185
 186     virtual SyscallDesc* getDesc(int callnum) = 0;
 187 };
 188
 189
 190 #endif // !FULL_SYSTEM
 191
 192 #endif // __PROCESS_HH__