process.hh revision 5999:3cf8e71257e0
111723Sar4jc@virginia.edu/* 211723Sar4jc@virginia.edu * Copyright (c) 2001-2005 The Regents of The University of Michigan 311723Sar4jc@virginia.edu * All rights reserved. 411723Sar4jc@virginia.edu * 511723Sar4jc@virginia.edu * Redistribution and use in source and binary forms, with or without 611723Sar4jc@virginia.edu * modification, are permitted provided that the following conditions are 711723Sar4jc@virginia.edu * met: redistributions of source code must retain the above copyright 811723Sar4jc@virginia.edu * notice, this list of conditions and the following disclaimer; 911723Sar4jc@virginia.edu * redistributions in binary form must reproduce the above copyright 1011723Sar4jc@virginia.edu * notice, this list of conditions and the following disclaimer in the 1111723Sar4jc@virginia.edu * documentation and/or other materials provided with the distribution; 1211723Sar4jc@virginia.edu * neither the name of the copyright holders nor the names of its 1311723Sar4jc@virginia.edu * contributors may be used to endorse or promote products derived from 1411723Sar4jc@virginia.edu * this software without specific prior written permission. 1511723Sar4jc@virginia.edu * 1611723Sar4jc@virginia.edu * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1711723Sar4jc@virginia.edu * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 1811723Sar4jc@virginia.edu * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 1911723Sar4jc@virginia.edu * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 2011723Sar4jc@virginia.edu * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2111723Sar4jc@virginia.edu * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 2211723Sar4jc@virginia.edu * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2311723Sar4jc@virginia.edu * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2411723Sar4jc@virginia.edu * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2511723Sar4jc@virginia.edu * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 2611723Sar4jc@virginia.edu * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 2711723Sar4jc@virginia.edu * 2811723Sar4jc@virginia.edu * Authors: Nathan Binkert 2911723Sar4jc@virginia.edu * Steve Reinhardt 3011723Sar4jc@virginia.edu */ 3111723Sar4jc@virginia.edu 3211723Sar4jc@virginia.edu#ifndef __PROCESS_HH__ 3311723Sar4jc@virginia.edu#define __PROCESS_HH__ 3411723Sar4jc@virginia.edu 3511723Sar4jc@virginia.edu// 3611964Sar4jc@virginia.edu// The purpose of this code is to fake the loader & syscall mechanism 3711964Sar4jc@virginia.edu// when there's no OS: thus there's no reason to use it in FULL_SYSTEM 3811964Sar4jc@virginia.edu// mode when we do have an OS. 3911964Sar4jc@virginia.edu// 4011964Sar4jc@virginia.edu#include "config/full_system.hh" 4111723Sar4jc@virginia.edu 4211723Sar4jc@virginia.edu#if !FULL_SYSTEM 4311723Sar4jc@virginia.edu 4411723Sar4jc@virginia.edu#include <string> 4511723Sar4jc@virginia.edu#include <vector> 4611723Sar4jc@virginia.edu 4711723Sar4jc@virginia.edu#include "arch/types.hh" 4811964Sar4jc@virginia.edu#include "base/statistics.hh" 4911723Sar4jc@virginia.edu#include "sim/host.hh" 5011964Sar4jc@virginia.edu#include "sim/sim_object.hh" 5111854Sbrandon.potter@amd.com#include "sim/syscallreturn.hh" 5211723Sar4jc@virginia.edu 5311723Sar4jc@virginia.educlass GDBListener; 5411800Sbrandon.potter@amd.comclass PageTable; 5511723Sar4jc@virginia.educlass ProcessParams; 5611723Sar4jc@virginia.educlass LiveProcessParams; 5711723Sar4jc@virginia.educlass SyscallDesc; 5811723Sar4jc@virginia.educlass System; 5911723Sar4jc@virginia.educlass ThreadContext; 6011851Sbrandon.potter@amd.comclass TranslatingPort; 6111851Sbrandon.potter@amd.comnamespace TheISA 6211723Sar4jc@virginia.edu{ 6311970Sar4jc@virginia.edu class RemoteGDB; 6411964Sar4jc@virginia.edu} 6511964Sar4jc@virginia.edu 6611964Sar4jc@virginia.edutemplate<class IntType> 6711964Sar4jc@virginia.edustruct AuxVector 6811970Sar4jc@virginia.edu{ 6911905SBrandon.Potter@amd.com IntType a_type; 7011964Sar4jc@virginia.edu IntType a_val; 7111723Sar4jc@virginia.edu 7211723Sar4jc@virginia.edu AuxVector() 7311723Sar4jc@virginia.edu {} 7411851Sbrandon.potter@amd.com 7511723Sar4jc@virginia.edu AuxVector(IntType type, IntType val); 7611851Sbrandon.potter@amd.com}; 7711723Sar4jc@virginia.edu 7811723Sar4jc@virginia.educlass Process : public SimObject 7911723Sar4jc@virginia.edu{ 8011723Sar4jc@virginia.edu public: 8111723Sar4jc@virginia.edu 8211851Sbrandon.potter@amd.com /// Pointer to object representing the system this process is 8311723Sar4jc@virginia.edu /// running on. 8411723Sar4jc@virginia.edu System *system; 8511964Sar4jc@virginia.edu 8611964Sar4jc@virginia.edu // have we initialized a thread context from this process? If 8711964Sar4jc@virginia.edu // yes, subsequent contexts are assumed to be for dynamically 8811723Sar4jc@virginia.edu // created threads and are not initialized. 8911964Sar4jc@virginia.edu bool initialContextLoaded; 9011964Sar4jc@virginia.edu 9111964Sar4jc@virginia.edu bool checkpointRestored; 9211964Sar4jc@virginia.edu 9311964Sar4jc@virginia.edu // thread contexts associated with this process 9411964Sar4jc@virginia.edu std::vector<int> contextIds; 9511964Sar4jc@virginia.edu 9611723Sar4jc@virginia.edu // remote gdb objects 9711964Sar4jc@virginia.edu std::vector<TheISA::RemoteGDB *> remoteGDB; 9811964Sar4jc@virginia.edu std::vector<GDBListener *> gdbListen; 9911964Sar4jc@virginia.edu bool breakpoint(); 10011964Sar4jc@virginia.edu 10111964Sar4jc@virginia.edu // number of CPUs (esxec contexts, really) assigned to this process. 10211964Sar4jc@virginia.edu unsigned int numCpus() { return contextIds.size(); } 10311964Sar4jc@virginia.edu 10411964Sar4jc@virginia.edu // record of blocked context 10511964Sar4jc@virginia.edu struct WaitRec 10611964Sar4jc@virginia.edu { 10711964Sar4jc@virginia.edu Addr waitChan; 10811964Sar4jc@virginia.edu ThreadContext *waitingContext; 10911964Sar4jc@virginia.edu 11011964Sar4jc@virginia.edu WaitRec(Addr chan, ThreadContext *ctx) 11111964Sar4jc@virginia.edu : waitChan(chan), waitingContext(ctx) 11211964Sar4jc@virginia.edu { } 11311964Sar4jc@virginia.edu }; 11411964Sar4jc@virginia.edu 11511964Sar4jc@virginia.edu // list of all blocked contexts 11611964Sar4jc@virginia.edu std::list<WaitRec> waitList; 11711964Sar4jc@virginia.edu 11811964Sar4jc@virginia.edu Addr brk_point; // top of the data segment 11911964Sar4jc@virginia.edu 12011964Sar4jc@virginia.edu Addr stack_base; // stack segment base (highest address) 12111964Sar4jc@virginia.edu unsigned stack_size; // initial stack size 12211964Sar4jc@virginia.edu Addr stack_min; // lowest address accessed on the stack 12311964Sar4jc@virginia.edu 12411964Sar4jc@virginia.edu // The maximum size allowed for the stack. 12511964Sar4jc@virginia.edu Addr max_stack_size; 12611964Sar4jc@virginia.edu 12711964Sar4jc@virginia.edu // addr to use for next stack region (for multithreaded apps) 12811964Sar4jc@virginia.edu Addr next_thread_stack_base; 12911964Sar4jc@virginia.edu 13011964Sar4jc@virginia.edu // Base of region for mmaps (when user doesn't specify an address). 13111964Sar4jc@virginia.edu Addr mmap_start; 13211964Sar4jc@virginia.edu Addr mmap_end; 13311964Sar4jc@virginia.edu 13411964Sar4jc@virginia.edu // Base of region for nxm data 13511964Sar4jc@virginia.edu Addr nxm_start; 13611964Sar4jc@virginia.edu Addr nxm_end; 13711964Sar4jc@virginia.edu 13811964Sar4jc@virginia.edu std::string prog_fname; // file name 13911964Sar4jc@virginia.edu 14011964Sar4jc@virginia.edu Stats::Scalar num_syscalls; // number of syscalls executed 14111964Sar4jc@virginia.edu 14211964Sar4jc@virginia.edu 14311964Sar4jc@virginia.edu protected: 14411964Sar4jc@virginia.edu // constructor 14511964Sar4jc@virginia.edu Process(ProcessParams * params); 14611964Sar4jc@virginia.edu 14711964Sar4jc@virginia.edu // post initialization startup 14811964Sar4jc@virginia.edu virtual void startup(); 14911964Sar4jc@virginia.edu 15011964Sar4jc@virginia.edu protected: 15111964Sar4jc@virginia.edu /// Memory object for initialization (image loading) 15211964Sar4jc@virginia.edu TranslatingPort *initVirtMem; 15311964Sar4jc@virginia.edu 15411964Sar4jc@virginia.edu public: 15511964Sar4jc@virginia.edu PageTable *pTable; 15611964Sar4jc@virginia.edu 15711964Sar4jc@virginia.edu //This id is assigned by m5 and is used to keep process' tlb entries 15811964Sar4jc@virginia.edu //separated. 15911964Sar4jc@virginia.edu uint64_t M5_pid; 16011964Sar4jc@virginia.edu 16111964Sar4jc@virginia.edu class FdMap 16211964Sar4jc@virginia.edu { 16311964Sar4jc@virginia.edu public: 16411964Sar4jc@virginia.edu int fd; 16511964Sar4jc@virginia.edu std::string filename; 16611964Sar4jc@virginia.edu int mode; 16711723Sar4jc@virginia.edu int flags; 16811723Sar4jc@virginia.edu bool isPipe; 16911964Sar4jc@virginia.edu int readPipeSource; 17011964Sar4jc@virginia.edu uint64_t fileOffset; 17111964Sar4jc@virginia.edu 17211964Sar4jc@virginia.edu 17311964Sar4jc@virginia.edu FdMap() 17411723Sar4jc@virginia.edu { 17511723Sar4jc@virginia.edu fd = -1; 17611964Sar4jc@virginia.edu filename = "NULL"; 17711964Sar4jc@virginia.edu mode = 0; 17811964Sar4jc@virginia.edu flags = 0; 17911964Sar4jc@virginia.edu isPipe = false; 18011964Sar4jc@virginia.edu readPipeSource = 0; 18111964Sar4jc@virginia.edu fileOffset = 0; 18211964Sar4jc@virginia.edu 18311964Sar4jc@virginia.edu } 18411964Sar4jc@virginia.edu 18511964Sar4jc@virginia.edu void serialize(std::ostream &os); 18611964Sar4jc@virginia.edu void unserialize(Checkpoint *cp, const std::string §ion); 18711964Sar4jc@virginia.edu 18811964Sar4jc@virginia.edu }; 18911964Sar4jc@virginia.edu 19011964Sar4jc@virginia.edu private: 19111964Sar4jc@virginia.edu // file descriptor remapping support 19211964Sar4jc@virginia.edu static const int MAX_FD = 256; // max legal fd value 19311964Sar4jc@virginia.edu FdMap fd_map[MAX_FD+1]; 19411723Sar4jc@virginia.edu 19511723Sar4jc@virginia.edu 19611723Sar4jc@virginia.edu public: 19711905SBrandon.Potter@amd.com // static helper functions to generate file descriptors for constructor 19811723Sar4jc@virginia.edu static int openInputFile(const std::string &filename); 19911964Sar4jc@virginia.edu static int openOutputFile(const std::string &filename); 20011964Sar4jc@virginia.edu 20111723Sar4jc@virginia.edu // override of virtual SimObject method: register statistics 20211723Sar4jc@virginia.edu virtual void regStats(); 20311723Sar4jc@virginia.edu 20411851Sbrandon.potter@amd.com // After getting registered with system object, tell process which 20511723Sar4jc@virginia.edu // system-wide context id it is assigned. 20611806Sar4jc@virginia.edu void assignThreadContext(int context_id) 20711806Sar4jc@virginia.edu { 20811806Sar4jc@virginia.edu contextIds.push_back(context_id); 20911806Sar4jc@virginia.edu } 21011806Sar4jc@virginia.edu 21111806Sar4jc@virginia.edu // Find a free context to use 21211806Sar4jc@virginia.edu ThreadContext * findFreeContext(); 21311723Sar4jc@virginia.edu 21411723Sar4jc@virginia.edu // map simulator fd sim_fd to target fd tgt_fd 21511723Sar4jc@virginia.edu void dup_fd(int sim_fd, int tgt_fd); 21611851Sbrandon.potter@amd.com 21711723Sar4jc@virginia.edu // generate new target fd for sim_fd 21811723Sar4jc@virginia.edu int alloc_fd(int sim_fd, std::string filename, int flags, int mode, bool pipe); 21911723Sar4jc@virginia.edu 22011723Sar4jc@virginia.edu // free target fd (e.g., after close) 22111723Sar4jc@virginia.edu void free_fd(int tgt_fd); 22211851Sbrandon.potter@amd.com 22311723Sar4jc@virginia.edu // look up simulator fd for given target fd 22411723Sar4jc@virginia.edu int sim_fd(int tgt_fd); 22511723Sar4jc@virginia.edu 22611723Sar4jc@virginia.edu // look up simulator fd_map object for a given target fd 22711723Sar4jc@virginia.edu FdMap * sim_fd_obj(int tgt_fd); 22811723Sar4jc@virginia.edu 22911723Sar4jc@virginia.edu // fix all offsets for currently open files and save them 23011723Sar4jc@virginia.edu void fix_file_offsets(); 23111723Sar4jc@virginia.edu 232 // find all offsets for currently open files and save them 233 void find_file_offsets(); 234 235 // set the source of this read pipe for a checkpoint resume 236 void setReadPipeSource(int read_pipe_fd, int source_fd); 237 238 virtual void syscall(int64_t callnum, ThreadContext *tc) = 0; 239 240 // check if the this addr is on the next available page and allocate it 241 // if it's not we'll panic 242 bool checkAndAllocNextPage(Addr vaddr); 243 244 void serialize(std::ostream &os); 245 void unserialize(Checkpoint *cp, const std::string §ion); 246}; 247 248// 249// "Live" process with system calls redirected to host system 250// 251class ObjectFile; 252class LiveProcess : public Process 253{ 254 protected: 255 ObjectFile *objFile; 256 std::vector<std::string> argv; 257 std::vector<std::string> envp; 258 std::string cwd; 259 260 LiveProcess(LiveProcessParams * params, ObjectFile *objFile); 261 262 virtual void argsInit(int intSize, int pageSize); 263 264 // Id of the owner of the process 265 uint64_t __uid; 266 uint64_t __euid; 267 uint64_t __gid; 268 uint64_t __egid; 269 270 // pid of the process and it's parent 271 uint64_t __pid; 272 uint64_t __ppid; 273 274 public: 275 276 enum AuxiliaryVectorType { 277 M5_AT_NULL = 0, 278 M5_AT_IGNORE = 1, 279 M5_AT_EXECFD = 2, 280 M5_AT_PHDR = 3, 281 M5_AT_PHENT = 4, 282 M5_AT_PHNUM = 5, 283 M5_AT_PAGESZ = 6, 284 M5_AT_BASE = 7, 285 M5_AT_FLAGS = 8, 286 M5_AT_ENTRY = 9, 287 M5_AT_NOTELF = 10, 288 M5_AT_UID = 11, 289 M5_AT_EUID = 12, 290 M5_AT_GID = 13, 291 M5_AT_EGID = 14, 292 // The following may be specific to Linux 293 M5_AT_PLATFORM = 15, 294 M5_AT_HWCAP = 16, 295 M5_AT_CLKTCK = 17, 296 297 M5_AT_SECURE = 23, 298 299 M5_AT_VECTOR_SIZE = 44 300 }; 301 302 inline uint64_t uid() {return __uid;} 303 inline uint64_t euid() {return __euid;} 304 inline uint64_t gid() {return __gid;} 305 inline uint64_t egid() {return __egid;} 306 inline uint64_t pid() {return __pid;} 307 inline uint64_t ppid() {return __ppid;} 308 309 std::string 310 fullPath(const std::string &filename) 311 { 312 if (filename[0] == '/' || cwd.empty()) 313 return filename; 314 315 std::string full = cwd; 316 317 if (cwd[cwd.size() - 1] != '/') 318 full += '/'; 319 320 return full + filename; 321 } 322 323 std::string getcwd() const { return cwd; } 324 325 virtual void syscall(int64_t callnum, ThreadContext *tc); 326 virtual TheISA::IntReg getSyscallArg(ThreadContext *tc, int i) = 0; 327 virtual void setSyscallArg(ThreadContext *tc, 328 int i, TheISA::IntReg val) = 0; 329 virtual void setSyscallReturn(ThreadContext *tc, 330 SyscallReturn return_value) = 0; 331 332 virtual SyscallDesc* getDesc(int callnum) = 0; 333 334 // this function is used to create the LiveProcess object, since 335 // we can't tell which subclass of LiveProcess to use until we 336 // open and look at the object file. 337 static LiveProcess *create(LiveProcessParams * params); 338}; 339 340 341#endif // !FULL_SYSTEM 342 343#endif // __PROCESS_HH__ 344