process.hh revision 7488:cf7c4345ea82
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 "arch/registers.hh" 48#include "base/statistics.hh" 49#include "base/types.hh" 50#include "config/the_isa.hh" 51#include "sim/sim_object.hh" 52#include "sim/syscallreturn.hh" 53 54class PageTable; 55class ProcessParams; 56class LiveProcessParams; 57class SyscallDesc; 58class System; 59class ThreadContext; 60class TranslatingPort; 61 62template<class IntType> 63struct AuxVector 64{ 65 IntType a_type; 66 IntType a_val; 67 68 AuxVector() 69 {} 70 71 AuxVector(IntType type, IntType val); 72}; 73 74class Process : public SimObject 75{ 76 public: 77 78 /// Pointer to object representing the system this process is 79 /// running on. 80 System *system; 81 82 bool checkpointRestored; 83 84 // thread contexts associated with this process 85 std::vector<int> contextIds; 86 87 // number of CPUs (esxec contexts, really) assigned to this process. 88 unsigned int numCpus() { return contextIds.size(); } 89 90 // record of blocked context 91 struct WaitRec 92 { 93 Addr waitChan; 94 ThreadContext *waitingContext; 95 96 WaitRec(Addr chan, ThreadContext *ctx) 97 : waitChan(chan), waitingContext(ctx) 98 { } 99 }; 100 101 // list of all blocked contexts 102 std::list<WaitRec> waitList; 103 104 Addr brk_point; // top of the data segment 105 106 Addr stack_base; // stack segment base (highest address) 107 unsigned stack_size; // initial stack size 108 Addr stack_min; // lowest address accessed on the stack 109 110 // The maximum size allowed for the stack. 111 Addr max_stack_size; 112 113 // addr to use for next stack region (for multithreaded apps) 114 Addr next_thread_stack_base; 115 116 // Base of region for mmaps (when user doesn't specify an address). 117 Addr mmap_start; 118 Addr mmap_end; 119 120 // Base of region for nxm data 121 Addr nxm_start; 122 Addr nxm_end; 123 124 std::string prog_fname; // file name 125 126 Stats::Scalar num_syscalls; // number of syscalls executed 127 128 129 protected: 130 // constructor 131 Process(ProcessParams * params); 132 133 // post initialization startup 134 virtual void startup(); 135 136 protected: 137 /// Memory object for initialization (image loading) 138 TranslatingPort *initVirtMem; 139 140 public: 141 PageTable *pTable; 142 143 //This id is assigned by m5 and is used to keep process' tlb entries 144 //separated. 145 uint64_t M5_pid; 146 147 class FdMap 148 { 149 public: 150 int fd; 151 std::string filename; 152 int mode; 153 int flags; 154 bool isPipe; 155 int readPipeSource; 156 uint64_t fileOffset; 157 158 159 FdMap() 160 { 161 fd = -1; 162 filename = "NULL"; 163 mode = 0; 164 flags = 0; 165 isPipe = false; 166 readPipeSource = 0; 167 fileOffset = 0; 168 169 } 170 171 void serialize(std::ostream &os); 172 void unserialize(Checkpoint *cp, const std::string §ion); 173 174 }; 175 176 private: 177 // file descriptor remapping support 178 static const int MAX_FD = 256; // max legal fd value 179 FdMap fd_map[MAX_FD+1]; 180 181 182 public: 183 // static helper functions to generate file descriptors for constructor 184 static int openInputFile(const std::string &filename); 185 static int openOutputFile(const std::string &filename); 186 187 // override of virtual SimObject method: register statistics 188 virtual void regStats(); 189 190 // After getting registered with system object, tell process which 191 // system-wide context id it is assigned. 192 void assignThreadContext(int context_id) 193 { 194 contextIds.push_back(context_id); 195 } 196 197 // Find a free context to use 198 ThreadContext * findFreeContext(); 199 200 // map simulator fd sim_fd to target fd tgt_fd 201 void dup_fd(int sim_fd, int tgt_fd); 202 203 // generate new target fd for sim_fd 204 int alloc_fd(int sim_fd, std::string filename, int flags, int mode, bool pipe); 205 206 // free target fd (e.g., after close) 207 void free_fd(int tgt_fd); 208 209 // look up simulator fd for given target fd 210 int sim_fd(int tgt_fd); 211 212 // look up simulator fd_map object for a given target fd 213 FdMap * sim_fd_obj(int tgt_fd); 214 215 // fix all offsets for currently open files and save them 216 void fix_file_offsets(); 217 218 // find all offsets for currently open files and save them 219 void find_file_offsets(); 220 221 // set the source of this read pipe for a checkpoint resume 222 void setReadPipeSource(int read_pipe_fd, int source_fd); 223 224 virtual void syscall(int64_t callnum, ThreadContext *tc) = 0; 225 226 // check if the this addr is on the next available page and allocate it 227 // if it's not we'll panic 228 bool checkAndAllocNextPage(Addr vaddr); 229 230 void serialize(std::ostream &os); 231 void unserialize(Checkpoint *cp, const std::string §ion); 232}; 233 234// 235// "Live" process with system calls redirected to host system 236// 237class ObjectFile; 238class LiveProcess : public Process 239{ 240 protected: 241 ObjectFile *objFile; 242 std::vector<std::string> argv; 243 std::vector<std::string> envp; 244 std::string cwd; 245 246 LiveProcess(LiveProcessParams * params, ObjectFile *objFile); 247 248 // Id of the owner of the process 249 uint64_t __uid; 250 uint64_t __euid; 251 uint64_t __gid; 252 uint64_t __egid; 253 254 // pid of the process and it's parent 255 uint64_t __pid; 256 uint64_t __ppid; 257 258 public: 259 260 enum AuxiliaryVectorType { 261 M5_AT_NULL = 0, 262 M5_AT_IGNORE = 1, 263 M5_AT_EXECFD = 2, 264 M5_AT_PHDR = 3, 265 M5_AT_PHENT = 4, 266 M5_AT_PHNUM = 5, 267 M5_AT_PAGESZ = 6, 268 M5_AT_BASE = 7, 269 M5_AT_FLAGS = 8, 270 M5_AT_ENTRY = 9, 271 M5_AT_NOTELF = 10, 272 M5_AT_UID = 11, 273 M5_AT_EUID = 12, 274 M5_AT_GID = 13, 275 M5_AT_EGID = 14, 276 // The following may be specific to Linux 277 M5_AT_PLATFORM = 15, 278 M5_AT_HWCAP = 16, 279 M5_AT_CLKTCK = 17, 280 281 M5_AT_SECURE = 23, 282 M5_BASE_PLATFORM = 24, 283 M5_AT_RANDOM = 25, 284 285 M5_AT_EXECFN = 31, 286 287 M5_AT_VECTOR_SIZE = 44 288 }; 289 290 inline uint64_t uid() {return __uid;} 291 inline uint64_t euid() {return __euid;} 292 inline uint64_t gid() {return __gid;} 293 inline uint64_t egid() {return __egid;} 294 inline uint64_t pid() {return __pid;} 295 inline uint64_t ppid() {return __ppid;} 296 297 std::string 298 fullPath(const std::string &filename) 299 { 300 if (filename[0] == '/' || cwd.empty()) 301 return filename; 302 303 std::string full = cwd; 304 305 if (cwd[cwd.size() - 1] != '/') 306 full += '/'; 307 308 return full + filename; 309 } 310 311 std::string getcwd() const { return cwd; } 312 313 virtual void syscall(int64_t callnum, ThreadContext *tc); 314 315 virtual TheISA::IntReg getSyscallArg(ThreadContext *tc, int &i) = 0; 316 virtual TheISA::IntReg getSyscallArg(ThreadContext *tc, int &i, int width); 317 virtual void setSyscallArg(ThreadContext *tc, 318 int i, TheISA::IntReg val) = 0; 319 virtual void setSyscallReturn(ThreadContext *tc, 320 SyscallReturn return_value) = 0; 321 322 virtual SyscallDesc* getDesc(int callnum) = 0; 323 324 // this function is used to create the LiveProcess object, since 325 // we can't tell which subclass of LiveProcess to use until we 326 // open and look at the object file. 327 static LiveProcess *create(LiveProcessParams * params); 328}; 329 330 331#endif // !FULL_SYSTEM 332 333#endif // __PROCESS_HH__ 334