sim/process.hh

   1 /*
   2  * Copyright (c) 2001-2004 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 #ifndef FULL_SYSTEM
  38
  39 #include <vector>
  40
  41 #include "targetarch/isa_traits.hh"
  42 #include "sim/sim_object.hh"
  43 #include "sim/stats.hh"
  44 #include "base/statistics.hh"
  45
  46 class ExecContext;
  47 class FunctionalMemory;
  48 class Process : public SimObject
  49 {
  50   public:
  51
  52     // have we initialized an execution context from this process?  If
  53     // yes, subsequent contexts are assumed to be for dynamically
  54     // created threads and are not initialized.
  55     bool initialContextLoaded;
  56
  57     // execution contexts associated with this process
  58     std::vector<ExecContext *> execContexts;
  59
  60     // number of CPUs (esxec contexts, really) assigned to this process.
  61     unsigned int numCpus() { return execContexts.size(); }
  62
  63     // record of blocked context
  64     struct WaitRec
  65     {
  66         Addr waitChan;
  67         ExecContext *waitingContext;
  68
  69         WaitRec(Addr chan, ExecContext *ctx)
  70             : waitChan(chan), waitingContext(ctx)
  71         {
  72         }
  73     };
  74
  75     // list of all blocked contexts
  76     std::list<WaitRec> waitList;
  77
  78     RegFile *init_regs;         // initial register contents
  79
  80     Addr text_base;             // text (code) segment base
  81     unsigned text_size;         // text (code) size in bytes
  82
  83     Addr data_base;             // initialized data segment base
  84     unsigned data_size;         // initialized data + bss size in bytes
  85
  86     Addr brk_point;             // top of the data segment
  87
  88     Addr stack_base;            // stack segment base (highest address)
  89     unsigned stack_size;        // initial stack size
  90     Addr stack_min;             // lowest address accessed on the stack
  91
  92     // addr to use for next stack region (for multithreaded apps)
  93     Addr next_thread_stack_base;
  94
  95     // Base of region for mmaps (when user doesn't specify an address).
  96     Addr mmap_start;
  97     Addr mmap_end;
  98
  99     std::string prog_fname;     // file name
 100     Addr prog_entry;            // entry point (initial PC)
 101
 102     Stats::Scalar<> num_syscalls;       // number of syscalls executed
 103
 104
 105   protected:
 106     // constructor
 107     Process(const std::string &name,
 108             int stdin_fd,       // initial I/O descriptors
 109             int stdout_fd,
 110             int stderr_fd);
 111
 112     // post initialization startup
 113     virtual void startup();
 114
 115   protected:
 116     FunctionalMemory *memory;
 117
 118   private:
 119     // file descriptor remapping support
 120     static const int MAX_FD = 100;      // max legal fd value
 121     int fd_map[MAX_FD+1];
 122
 123   public:
 124     // static helper functions to generate file descriptors for constructor
 125     static int openInputFile(const std::string &filename);
 126     static int openOutputFile(const std::string &filename);
 127
 128     // override of virtual SimObject method: register statistics
 129     virtual void regStats();
 130
 131     // register an execution context for this process.
 132     // returns xc's cpu number (index into execContexts[])
 133     int registerExecContext(ExecContext *xc);
 134
 135
 136     void replaceExecContext(ExecContext *xc, int xcIndex);
 137
 138     // map simulator fd sim_fd to target fd tgt_fd
 139     void dup_fd(int sim_fd, int tgt_fd);
 140
 141     // generate new target fd for sim_fd
 142     int open_fd(int sim_fd);
 143
 144     // look up simulator fd for given target fd
 145     int sim_fd(int tgt_fd);
 146
 147     // is this a valid instruction fetch address?
 148     bool validInstAddr(Addr addr)
 149     {
 150         return (text_base <= addr &&
 151                 addr < text_base + text_size &&
 152                 !(addr & (sizeof(MachInst)-1)));
 153     }
 154
 155     // is this a valid address? (used to filter data fetches)
 156     // note that we just assume stack size <= 16MB
 157     // this may be alpha-specific
 158     bool validDataAddr(Addr addr)
 159     {
 160         return ((data_base <= addr && addr < brk_point) ||
 161                 ((stack_base - 16*1024*1024) <= addr && addr < stack_base) ||
 162                 (text_base <= addr && addr < (text_base + text_size)) ||
 163                 (mmap_start <= addr && addr < mmap_end));
 164     }
 165
 166     virtual void syscall(ExecContext *xc) = 0;
 167
 168     virtual FunctionalMemory *getMemory() { return memory; }
 169 };
 170
 171 //
 172 // "Live" process with system calls redirected to host system
 173 //
 174 class ObjectFile;
 175 class LiveProcess : public Process
 176 {
 177   protected:
 178     LiveProcess(const std::string &name, ObjectFile *objFile,
 179                 int stdin_fd, int stdout_fd, int stderr_fd,
 180                 std::vector<std::string> &argv,
 181                 std::vector<std::string> &envp);
 182
 183   public:
 184     // this function is used to create the LiveProcess object, since
 185     // we can't tell which subclass of LiveProcess to use until we
 186     // open and look at the object file.
 187     static LiveProcess *create(const std::string &name,
 188                                int stdin_fd, int stdout_fd, int stderr_fd,
 189                                std::vector<std::string> &argv,
 190                                std::vector<std::string> &envp);
 191 };
 192
 193
 194 #endif // !FULL_SYSTEM
 195
 196 #endif // __PROCESS_HH__