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