process.hh revision 7532
112855Sgabeblack@google.com/* 212855Sgabeblack@google.com * Copyright (c) 2001-2005 The Regents of The University of Michigan 312855Sgabeblack@google.com * All rights reserved. 412855Sgabeblack@google.com * 512855Sgabeblack@google.com * Redistribution and use in source and binary forms, with or without 612855Sgabeblack@google.com * modification, are permitted provided that the following conditions are 712855Sgabeblack@google.com * met: redistributions of source code must retain the above copyright 812855Sgabeblack@google.com * notice, this list of conditions and the following disclaimer; 912855Sgabeblack@google.com * redistributions in binary form must reproduce the above copyright 1012855Sgabeblack@google.com * notice, this list of conditions and the following disclaimer in the 1112855Sgabeblack@google.com * documentation and/or other materials provided with the distribution; 1212855Sgabeblack@google.com * neither the name of the copyright holders nor the names of its 1312855Sgabeblack@google.com * contributors may be used to endorse or promote products derived from 1412855Sgabeblack@google.com * this software without specific prior written permission. 1512855Sgabeblack@google.com * 1612855Sgabeblack@google.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1712855Sgabeblack@google.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 1812855Sgabeblack@google.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 1912855Sgabeblack@google.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 2012855Sgabeblack@google.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2112855Sgabeblack@google.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 2212855Sgabeblack@google.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2312855Sgabeblack@google.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2412855Sgabeblack@google.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2512855Sgabeblack@google.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 2612855Sgabeblack@google.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 2712855Sgabeblack@google.com * 2812855Sgabeblack@google.com * Authors: Nathan Binkert 2912855Sgabeblack@google.com * Steve Reinhardt 3012855Sgabeblack@google.com */ 3112855Sgabeblack@google.com 3212855Sgabeblack@google.com#ifndef __PROCESS_HH__ 3312855Sgabeblack@google.com#define __PROCESS_HH__ 3412855Sgabeblack@google.com 3512855Sgabeblack@google.com// 3612855Sgabeblack@google.com// The purpose of this code is to fake the loader & syscall mechanism 3712855Sgabeblack@google.com// when there's no OS: thus there's no reason to use it in FULL_SYSTEM 3812855Sgabeblack@google.com// mode when we do have an OS. 3912855Sgabeblack@google.com// 4012855Sgabeblack@google.com#include "config/full_system.hh" 4112855Sgabeblack@google.com 4212855Sgabeblack@google.com#if !FULL_SYSTEM 4312855Sgabeblack@google.com 4412855Sgabeblack@google.com#include <string> 4512855Sgabeblack@google.com#include <vector> 4612855Sgabeblack@google.com 4712855Sgabeblack@google.com#include "arch/registers.hh" 4812855Sgabeblack@google.com#include "base/statistics.hh" 4912855Sgabeblack@google.com#include "base/types.hh" 5012855Sgabeblack@google.com#include "config/the_isa.hh" 5112855Sgabeblack@google.com#include "sim/sim_object.hh" 5212855Sgabeblack@google.com#include "sim/syscallreturn.hh" 5312855Sgabeblack@google.com 5412855Sgabeblack@google.comclass PageTable; 5512855Sgabeblack@google.comclass ProcessParams; 5612855Sgabeblack@google.comclass LiveProcessParams; 5712855Sgabeblack@google.comclass SyscallDesc; 5812855Sgabeblack@google.comclass System; 5912855Sgabeblack@google.comclass ThreadContext; 6012855Sgabeblack@google.comclass TranslatingPort; 6112855Sgabeblack@google.com 6212855Sgabeblack@google.comtemplate<class IntType> 6312855Sgabeblack@google.comstruct AuxVector 6412855Sgabeblack@google.com{ 6512855Sgabeblack@google.com IntType a_type; 6612855Sgabeblack@google.com IntType a_val; 6712855Sgabeblack@google.com 6812855Sgabeblack@google.com AuxVector() 6912855Sgabeblack@google.com {} 7012855Sgabeblack@google.com 7112855Sgabeblack@google.com AuxVector(IntType type, IntType val); 7212855Sgabeblack@google.com}; 7312855Sgabeblack@google.com 7412855Sgabeblack@google.comclass Process : public SimObject 7512855Sgabeblack@google.com{ 7612855Sgabeblack@google.com public: 7712855Sgabeblack@google.com 7812855Sgabeblack@google.com /// Pointer to object representing the system this process is 7912855Sgabeblack@google.com /// running on. 8012855Sgabeblack@google.com System *system; 8112855Sgabeblack@google.com 8212855Sgabeblack@google.com // thread contexts associated with this process 8312855Sgabeblack@google.com std::vector<int> contextIds; 8412855Sgabeblack@google.com 8512855Sgabeblack@google.com // number of CPUs (esxec contexts, really) assigned to this process. 8612855Sgabeblack@google.com unsigned int numCpus() { return contextIds.size(); } 8712855Sgabeblack@google.com 8812855Sgabeblack@google.com // record of blocked context 8912855Sgabeblack@google.com struct WaitRec 9012855Sgabeblack@google.com { 9112855Sgabeblack@google.com Addr waitChan; 9212855Sgabeblack@google.com ThreadContext *waitingContext; 9312855Sgabeblack@google.com 9412855Sgabeblack@google.com WaitRec(Addr chan, ThreadContext *ctx) 9512855Sgabeblack@google.com : waitChan(chan), waitingContext(ctx) 9612855Sgabeblack@google.com { } 9712855Sgabeblack@google.com }; 9812855Sgabeblack@google.com 9912855Sgabeblack@google.com // list of all blocked contexts 10012855Sgabeblack@google.com std::list<WaitRec> waitList; 10112855Sgabeblack@google.com 10212855Sgabeblack@google.com Addr brk_point; // top of the data segment 10312855Sgabeblack@google.com 10412855Sgabeblack@google.com Addr stack_base; // stack segment base (highest address) 10512855Sgabeblack@google.com unsigned stack_size; // initial stack size 10612855Sgabeblack@google.com Addr stack_min; // lowest address accessed on the stack 10712855Sgabeblack@google.com 10812855Sgabeblack@google.com // The maximum size allowed for the stack. 10912855Sgabeblack@google.com Addr max_stack_size; 11012855Sgabeblack@google.com 11112855Sgabeblack@google.com // addr to use for next stack region (for multithreaded apps) 11212855Sgabeblack@google.com Addr next_thread_stack_base; 11312855Sgabeblack@google.com 11412855Sgabeblack@google.com // Base of region for mmaps (when user doesn't specify an address). 11512855Sgabeblack@google.com Addr mmap_start; 11612855Sgabeblack@google.com Addr mmap_end; 11712855Sgabeblack@google.com 11812855Sgabeblack@google.com // Base of region for nxm data 11912855Sgabeblack@google.com Addr nxm_start; 12012855Sgabeblack@google.com Addr nxm_end; 12112855Sgabeblack@google.com 12212855Sgabeblack@google.com std::string prog_fname; // file name 12312855Sgabeblack@google.com 12412855Sgabeblack@google.com Stats::Scalar num_syscalls; // number of syscalls executed 12512855Sgabeblack@google.com 12612855Sgabeblack@google.com 12712855Sgabeblack@google.com protected: 12812855Sgabeblack@google.com // constructor 12912855Sgabeblack@google.com Process(ProcessParams * params); 13012855Sgabeblack@google.com 13112855Sgabeblack@google.com virtual void initState(); 13212855Sgabeblack@google.com 13312855Sgabeblack@google.com protected: 13412855Sgabeblack@google.com /// Memory object for initialization (image loading) 13512855Sgabeblack@google.com TranslatingPort *initVirtMem; 13612855Sgabeblack@google.com 13712855Sgabeblack@google.com public: 13812855Sgabeblack@google.com PageTable *pTable; 13912855Sgabeblack@google.com 14012855Sgabeblack@google.com //This id is assigned by m5 and is used to keep process' tlb entries 14112855Sgabeblack@google.com //separated. 14212855Sgabeblack@google.com uint64_t M5_pid; 14312855Sgabeblack@google.com 14412855Sgabeblack@google.com class FdMap 14512855Sgabeblack@google.com { 14612855Sgabeblack@google.com public: 14712855Sgabeblack@google.com int fd; 14812855Sgabeblack@google.com std::string filename; 14912855Sgabeblack@google.com int mode; 15012855Sgabeblack@google.com int flags; 15112855Sgabeblack@google.com bool isPipe; 15212855Sgabeblack@google.com int readPipeSource; 15312855Sgabeblack@google.com uint64_t fileOffset; 15412855Sgabeblack@google.com 15512855Sgabeblack@google.com 15612855Sgabeblack@google.com FdMap() 15712855Sgabeblack@google.com { 15812855Sgabeblack@google.com fd = -1; 15912855Sgabeblack@google.com filename = "NULL"; 16012855Sgabeblack@google.com mode = 0; 16112855Sgabeblack@google.com flags = 0; 16212855Sgabeblack@google.com isPipe = false; 16312855Sgabeblack@google.com readPipeSource = 0; 16412855Sgabeblack@google.com fileOffset = 0; 16512855Sgabeblack@google.com 16612855Sgabeblack@google.com } 16712855Sgabeblack@google.com 16812855Sgabeblack@google.com void serialize(std::ostream &os); 16912855Sgabeblack@google.com void unserialize(Checkpoint *cp, const std::string §ion); 17012855Sgabeblack@google.com 17112855Sgabeblack@google.com }; 17212855Sgabeblack@google.com 17312855Sgabeblack@google.com private: 17412855Sgabeblack@google.com // file descriptor remapping support 17512855Sgabeblack@google.com static const int MAX_FD = 256; // max legal fd value 17612855Sgabeblack@google.com 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