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