sim/prog.hh

   1 /*
   2  * Copyright (c) 2003 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 __PROG_HH__
  30 #define __PROG_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/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
  93     // addr to use for next stack region (for multithreaded apps)
  94     Addr next_thread_stack_base;
  95
  96     std::string prog_fname;     // file name
  97     Addr prog_entry;            // entry point (initial PC)
  98
  99     Statistics::Scalar<> num_syscalls;  // number of syscalls executed
 100
 101
 102   protected:
 103     // constructor
 104     Process(const std::string &name,
 105             int stdin_fd,       // initial I/O descriptors
 106             int stdout_fd,
 107             int stderr_fd);
 108
 109
 110   protected:
 111     FunctionalMemory *memory;
 112
 113   private:
 114     // file descriptor remapping support
 115     static const int MAX_FD = 100;      // max legal fd value
 116     int fd_map[MAX_FD+1];
 117
 118   public:
 119     // static helper functions to generate file descriptors for constructor
 120     static int openInputFile(const std::string &filename);
 121     static int openOutputFile(const std::string &filename);
 122
 123     // override of virtual SimObject method: register statistics
 124     virtual void regStats();
 125
 126     // register an execution context for this process.
 127     // returns xc's cpu number (index into execContexts[])
 128     int registerExecContext(ExecContext *xc);
 129
 130
 131     void replaceExecContext(int xcIndex, ExecContext *xc);
 132
 133     // map simulator fd sim_fd to target fd tgt_fd
 134     void dup_fd(int sim_fd, int tgt_fd);
 135
 136     // generate new target fd for sim_fd
 137     int open_fd(int sim_fd);
 138
 139     // look up simulator fd for given target fd
 140     int sim_fd(int tgt_fd);
 141
 142     // is this a valid instruction fetch address?
 143     bool validInstAddr(Addr addr)
 144     {
 145         return (text_base <= addr &&
 146                 addr < text_base + text_size &&
 147                 !(addr & (sizeof(MachInst)-1)));
 148     }
 149
 150     // is this a valid address? (used to filter data fetches)
 151     // note that we just assume stack size <= 16MB
 152     // this may be alpha-specific
 153     bool validDataAddr(Addr addr)
 154     {
 155         return ((data_base <= addr && addr < brk_point) ||
 156                 ((stack_base - 16*1024*1024) <= addr && addr < stack_base) ||
 157                 (text_base <= addr && addr < (text_base + text_size)));
 158     }
 159
 160     virtual void syscall(ExecContext *xc) = 0;
 161
 162     virtual FunctionalMemory *getMemory() { return memory; }
 163 };
 164
 165 //
 166 // "Live" process with system calls redirected to host system
 167 //
 168 class MainMemory;
 169 class LiveProcess : public Process
 170 {
 171   public:
 172     LiveProcess(const std::string &name,
 173                 int stdin_fd, int stdout_fd, int stderr_fd,
 174                 std::vector<std::string> &argv,
 175                 std::vector<std::string> &envp);
 176
 177     virtual void syscall(ExecContext *xc);
 178 };
 179
 180 #endif // !FULL_SYSTEM
 181
 182 #endif // __PROG_HH__