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