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