src/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  * Authors: Nathan Binkert
  29  *          Steve Reinhardt
  30  */
  31
  32 #ifndef __PROCESS_HH__
  33 #define __PROCESS_HH__
  34
  35 //
  36 // The purpose of this code is to fake the loader & syscall mechanism
  37 // when there's no OS: thus there's no reason to use it in FULL_SYSTEM
  38 // mode when we do have an OS.
  39 //
  40 #include "config/full_system.hh"
  41
  42 #if !FULL_SYSTEM
  43
  44 #include <string>
  45 #include <vector>
  46
  47 #include "base/statistics.hh"
  48 #include "sim/host.hh"
  49 #include "sim/sim_object.hh"
  50
  51 class ThreadContext;
  52 class SyscallDesc;
  53 class PageTable;
  54 class TranslatingPort;
  55 class System;
  56 class GDBListener;
  57 namespace TheISA
  58 {
  59     class RemoteGDB;
  60 }
  61
  62 class Process : public SimObject
  63 {
  64   public:
  65
  66     /// Pointer to object representing the system this process is
  67     /// running on.
  68     System *system;
  69
  70     // have we initialized a thread context from this process?  If
  71     // yes, subsequent contexts are assumed to be for dynamically
  72     // created threads and are not initialized.
  73     bool initialContextLoaded;
  74
  75     // thread contexts associated with this process
  76     std::vector<ThreadContext *> threadContexts;
  77
  78     // remote gdb objects
  79     std::vector<TheISA::RemoteGDB *> remoteGDB;
  80     std::vector<GDBListener *> gdbListen;
  81     bool breakpoint();
  82
  83     // number of CPUs (esxec contexts, really) assigned to this process.
  84     unsigned int numCpus() { return threadContexts.size(); }
  85
  86     // record of blocked context
  87     struct WaitRec
  88     {
  89         Addr waitChan;
  90         ThreadContext *waitingContext;
  91
  92         WaitRec(Addr chan, ThreadContext *ctx)
  93             : waitChan(chan), waitingContext(ctx)
  94         {       }
  95     };
  96
  97     // list of all blocked contexts
  98     std::list<WaitRec> waitList;
  99
 100     Addr brk_point;             // top of the data segment
 101
 102     Addr stack_base;            // stack segment base (highest address)
 103     unsigned stack_size;        // initial stack size
 104     Addr stack_min;             // lowest address accessed on the stack
 105
 106     // addr to use for next stack region (for multithreaded apps)
 107     Addr next_thread_stack_base;
 108
 109     // Base of region for mmaps (when user doesn't specify an address).
 110     Addr mmap_start;
 111     Addr mmap_end;
 112
 113     // Base of region for nxm data
 114     Addr nxm_start;
 115     Addr nxm_end;
 116
 117     std::string prog_fname;     // file name
 118
 119     Stats::Scalar<> num_syscalls;       // number of syscalls executed
 120
 121
 122   protected:
 123     // constructor
 124     Process(const std::string &nm,
 125             System *_system,
 126             int stdin_fd,       // initial I/O descriptors
 127             int stdout_fd,
 128             int stderr_fd);
 129
 130     // post initialization startup
 131     virtual void startup();
 132
 133   protected:
 134     /// Memory object for initialization (image loading)
 135     TranslatingPort *initVirtMem;
 136
 137   public:
 138     PageTable *pTable;
 139
 140   private:
 141     // file descriptor remapping support
 142     static const int MAX_FD = 256;      // max legal fd value
 143     int fd_map[MAX_FD+1];
 144
 145   public:
 146     // static helper functions to generate file descriptors for constructor
 147     static int openInputFile(const std::string &filename);
 148     static int openOutputFile(const std::string &filename);
 149
 150     // override of virtual SimObject method: register statistics
 151     virtual void regStats();
 152
 153     // register a thread context for this process.
 154     // returns tc's cpu number (index into threadContexts[])
 155     int registerThreadContext(ThreadContext *tc);
 156
 157
 158     void replaceThreadContext(ThreadContext *tc, int tcIndex);
 159
 160     // map simulator fd sim_fd to target fd tgt_fd
 161     void dup_fd(int sim_fd, int tgt_fd);
 162
 163     // generate new target fd for sim_fd
 164     int alloc_fd(int sim_fd);
 165
 166     // free target fd (e.g., after close)
 167     void free_fd(int tgt_fd);
 168
 169     // look up simulator fd for given target fd
 170     int sim_fd(int tgt_fd);
 171
 172     virtual void syscall(int64_t callnum, ThreadContext *tc) = 0;
 173
 174     // check if the this addr is on the next available page and allocate it
 175     // if it's not we'll panic
 176     bool checkAndAllocNextPage(Addr vaddr);
 177
 178     void serialize(std::ostream &os);
 179     void unserialize(Checkpoint *cp, const std::string &section);
 180 };
 181
 182 //
 183 // "Live" process with system calls redirected to host system
 184 //
 185 class ObjectFile;
 186 class LiveProcess : public Process
 187 {
 188   protected:
 189     ObjectFile *objFile;
 190     std::vector<std::string> argv;
 191     std::vector<std::string> envp;
 192     std::string cwd;
 193
 194     LiveProcess(const std::string &nm, ObjectFile *objFile,
 195                 System *_system, int stdin_fd, int stdout_fd, int stderr_fd,
 196                 std::vector<std::string> &argv,
 197                 std::vector<std::string> &envp,
 198                 const std::string &cwd,
 199                 uint64_t _uid, uint64_t _euid,
 200                 uint64_t _gid, uint64_t _egid,
 201                 uint64_t _pid, uint64_t _ppid);
 202
 203     virtual void argsInit(int intSize, int pageSize);
 204
 205     // Id of the owner of the process
 206     uint64_t __uid;
 207     uint64_t __euid;
 208     uint64_t __gid;
 209     uint64_t __egid;
 210
 211     // pid of the process and it's parent
 212     uint64_t __pid;
 213     uint64_t __ppid;
 214
 215   public:
 216
 217     enum AuxiliaryVectorType {
 218         M5_AT_NULL = 0,
 219         M5_AT_IGNORE = 1,
 220         M5_AT_EXECFD = 2,
 221         M5_AT_PHDR = 3,
 222         M5_AT_PHENT = 4,
 223         M5_AT_PHNUM = 5,
 224         M5_AT_PAGESZ = 6,
 225         M5_AT_BASE = 7,
 226         M5_AT_FLAGS = 8,
 227         M5_AT_ENTRY = 9,
 228         M5_AT_NOTELF = 10,
 229         M5_AT_UID = 11,
 230         M5_AT_EUID = 12,
 231         M5_AT_GID = 13,
 232         M5_AT_EGID = 14,
 233         // The following may be specific to Linux
 234         M5_AT_PLATFORM = 15,
 235         M5_AT_HWCAP = 16,
 236         M5_AT_CLKTCK = 17,
 237
 238         M5_AT_SECURE = 23,
 239
 240         M5_AT_VECTOR_SIZE = 44
 241     };
 242
 243     inline uint64_t uid() {return __uid;}
 244     inline uint64_t euid() {return __euid;}
 245     inline uint64_t gid() {return __gid;}
 246     inline uint64_t egid() {return __egid;}
 247     inline uint64_t pid() {return __pid;}
 248     inline uint64_t ppid() {return __ppid;}
 249
 250     std::string
 251     fullPath(const std::string &filename)
 252     {
 253         if (filename[0] == '/' || cwd.empty())
 254             return filename;
 255
 256         std::string full = cwd;
 257
 258         if (cwd[cwd.size() - 1] != '/')
 259             full += '/';
 260
 261         return full + filename;
 262     }
 263
 264     virtual void syscall(int64_t callnum, ThreadContext *tc);
 265
 266     virtual SyscallDesc* getDesc(int callnum) = 0;
 267
 268     // this function is used to create the LiveProcess object, since
 269     // we can't tell which subclass of LiveProcess to use until we
 270     // open and look at the object file.
 271     static LiveProcess *create(const std::string &nm,
 272                                System *_system,
 273                                int stdin_fd, int stdout_fd, int stderr_fd,
 274                                std::string executable,
 275                                std::vector<std::string> &argv,
 276                                std::vector<std::string> &envp,
 277                                const std::string &cwd,
 278                                uint64_t _uid, uint64_t _euid,
 279                                uint64_t _gid, uint64_t _egid,
 280                                uint64_t _pid, uint64_t _ppid);
 281 };
 282
 283
 284 #endif // !FULL_SYSTEM
 285
 286 #endif // __PROCESS_HH__