process.hh revision 10930
12SN/A/* 210298Salexandru.dutu@amd.com * Copyright (c) 2014 Advanced Micro Devices, Inc. 31762SN/A * Copyright (c) 2001-2005 The Regents of The University of Michigan 42SN/A * All rights reserved. 52SN/A * 62SN/A * Redistribution and use in source and binary forms, with or without 72SN/A * modification, are permitted provided that the following conditions are 82SN/A * met: redistributions of source code must retain the above copyright 92SN/A * notice, this list of conditions and the following disclaimer; 102SN/A * redistributions in binary form must reproduce the above copyright 112SN/A * notice, this list of conditions and the following disclaimer in the 122SN/A * documentation and/or other materials provided with the distribution; 132SN/A * neither the name of the copyright holders nor the names of its 142SN/A * contributors may be used to endorse or promote products derived from 152SN/A * this software without specific prior written permission. 162SN/A * 172SN/A * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 182SN/A * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 192SN/A * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 202SN/A * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 212SN/A * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 222SN/A * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 232SN/A * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 242SN/A * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 252SN/A * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 262SN/A * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 272SN/A * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 282665Ssaidi@eecs.umich.edu * 292665Ssaidi@eecs.umich.edu * Authors: Nathan Binkert 302665Ssaidi@eecs.umich.edu * Steve Reinhardt 312SN/A */ 322SN/A 33360SN/A#ifndef __PROCESS_HH__ 34360SN/A#define __PROCESS_HH__ 352SN/A 3610930Sbrandon.potter@amd.com#include <array> 374117Sgblack@eecs.umich.edu#include <string> 38180SN/A#include <vector> 392SN/A 406329Sgblack@eecs.umich.edu#include "arch/registers.hh" 412378SN/A#include "base/statistics.hh" 426214Snate@binkert.org#include "base/types.hh" 436658Snate@binkert.org#include "config/the_isa.hh" 448852Sandreas.hansson@arm.com#include "mem/se_translating_port_proxy.hh" 4510930Sbrandon.potter@amd.com#include "sim/fd_entry.hh" 4656SN/A#include "sim/sim_object.hh" 475958Sgblack@eecs.umich.edu#include "sim/syscallreturn.hh" 482SN/A 495154Sgblack@eecs.umich.educlass PageTable; 508737Skoansin.tan@gmail.comstruct ProcessParams; 518737Skoansin.tan@gmail.comstruct LiveProcessParams; 525154Sgblack@eecs.umich.educlass SyscallDesc; 535154Sgblack@eecs.umich.educlass System; 542680Sktlim@umich.educlass ThreadContext; 5510496Ssteve.reinhardt@amd.comclass EmulatedDriver; 562378SN/A 575758Shsul@eecs.umich.edutemplate<class IntType> 585771Shsul@eecs.umich.edustruct AuxVector 595758Shsul@eecs.umich.edu{ 605758Shsul@eecs.umich.edu IntType a_type; 615771Shsul@eecs.umich.edu IntType a_val; 625758Shsul@eecs.umich.edu 635771Shsul@eecs.umich.edu AuxVector() 645758Shsul@eecs.umich.edu {} 655758Shsul@eecs.umich.edu 665771Shsul@eecs.umich.edu AuxVector(IntType type, IntType val); 675758Shsul@eecs.umich.edu}; 685758Shsul@eecs.umich.edu 692SN/Aclass Process : public SimObject 702SN/A{ 712SN/A public: 722SN/A 732378SN/A /// Pointer to object representing the system this process is 742378SN/A /// running on. 752378SN/A System *system; 762378SN/A 772680Sktlim@umich.edu // thread contexts associated with this process 785713Shsul@eecs.umich.edu std::vector<int> contextIds; 79180SN/A 80180SN/A // number of CPUs (esxec contexts, really) assigned to this process. 815713Shsul@eecs.umich.edu unsigned int numCpus() { return contextIds.size(); } 822SN/A 832SN/A // record of blocked context 842SN/A struct WaitRec 852SN/A { 862SN/A Addr waitChan; 872680Sktlim@umich.edu ThreadContext *waitingContext; 882SN/A 892680Sktlim@umich.edu WaitRec(Addr chan, ThreadContext *ctx) 902SN/A : waitChan(chan), waitingContext(ctx) 915543Ssaidi@eecs.umich.edu { } 922SN/A }; 932SN/A 942SN/A // list of all blocked contexts 952SN/A std::list<WaitRec> waitList; 962SN/A 975543Ssaidi@eecs.umich.edu Addr brk_point; // top of the data segment 982SN/A 995543Ssaidi@eecs.umich.edu Addr stack_base; // stack segment base (highest address) 1005543Ssaidi@eecs.umich.edu unsigned stack_size; // initial stack size 1015543Ssaidi@eecs.umich.edu Addr stack_min; // lowest address accessed on the stack 1022SN/A 1035154Sgblack@eecs.umich.edu // The maximum size allowed for the stack. 1045154Sgblack@eecs.umich.edu Addr max_stack_size; 1055154Sgblack@eecs.umich.edu 1062SN/A // addr to use for next stack region (for multithreaded apps) 1072SN/A Addr next_thread_stack_base; 1082SN/A 109360SN/A // Base of region for mmaps (when user doesn't specify an address). 1101408SN/A Addr mmap_start; 1111408SN/A Addr mmap_end; 112360SN/A 1131514SN/A // Base of region for nxm data 1141514SN/A Addr nxm_start; 1151514SN/A Addr nxm_end; 1161514SN/A 1175999Snate@binkert.org Stats::Scalar num_syscalls; // number of syscalls executed 1182SN/A 1192SN/A protected: 1202SN/A // constructor 1218325Ssteve.reinhardt@amd.com Process(ProcessParams *params); 1222SN/A 1237532Ssteve.reinhardt@amd.com virtual void initState(); 1242SN/A 12510913Sandreas.sandberg@arm.com DrainState drain() M5_ATTR_OVERRIDE; 12610905Sandreas.sandberg@arm.com 1272378SN/A public: 1282SN/A 1294997Sgblack@eecs.umich.edu //This id is assigned by m5 and is used to keep process' tlb entries 1304997Sgblack@eecs.umich.edu //separated. 1314997Sgblack@eecs.umich.edu uint64_t M5_pid; 1324997Sgblack@eecs.umich.edu 13310299Salexandru.dutu@amd.com // flag for using architecture specific page table 13410299Salexandru.dutu@amd.com bool useArchPT; 13510554Salexandru.dutu@amd.com // running KvmCPU in SE mode requires special initialization 13610554Salexandru.dutu@amd.com bool kvmInSE; 13710554Salexandru.dutu@amd.com 13810298Salexandru.dutu@amd.com PageTableBase* pTable; 1398852Sandreas.hansson@arm.com 1408852Sandreas.hansson@arm.com protected: 1418852Sandreas.hansson@arm.com /// Memory proxy for initialization (image loading) 1428852Sandreas.hansson@arm.com SETranslatingPortProxy initVirtMem; 1438852Sandreas.hansson@arm.com 1442SN/A private: 14510929Sbrandon.potter@amd.com static const int NUM_FDS = 1024; 1465282Srstrong@cs.ucsd.edu 14710929Sbrandon.potter@amd.com // File descriptor remapping support. 14810930Sbrandon.potter@amd.com std::shared_ptr<std::array<FDEntry, NUM_FDS>> fd_array; 14910930Sbrandon.potter@amd.com 15010930Sbrandon.potter@amd.com // Standard file descriptor options for initialization and checkpoints. 15110930Sbrandon.potter@amd.com std::map<std::string, int> imap; 15210930Sbrandon.potter@amd.com std::map<std::string, int> oemap; 1532SN/A 1542SN/A public: 15510930Sbrandon.potter@amd.com // inherit file descriptor map from another process (necessary for clone) 15610930Sbrandon.potter@amd.com void inheritFdArray(Process *p); 1572SN/A 1582SN/A // override of virtual SimObject method: register statistics 1592SN/A virtual void regStats(); 1602SN/A 1615713Shsul@eecs.umich.edu // After getting registered with system object, tell process which 1625713Shsul@eecs.umich.edu // system-wide context id it is assigned. 1635713Shsul@eecs.umich.edu void assignThreadContext(int context_id) 1645713Shsul@eecs.umich.edu { 1655713Shsul@eecs.umich.edu contextIds.push_back(context_id); 1665713Shsul@eecs.umich.edu } 167180SN/A 1685713Shsul@eecs.umich.edu // Find a free context to use 1698325Ssteve.reinhardt@amd.com ThreadContext *findFreeContext(); 1702SN/A 1719144Ssteve.reinhardt@amd.com // provide program name for debug messages 1729144Ssteve.reinhardt@amd.com virtual const char *progName() const { return "<unknown>"; } 1739144Ssteve.reinhardt@amd.com 1742SN/A // generate new target fd for sim_fd 17510782Snilay@cs.wisc.edu int alloc_fd(int sim_fd, const std::string& filename, int flags, int mode, 1768325Ssteve.reinhardt@amd.com bool pipe); 1771970SN/A 17810929Sbrandon.potter@amd.com // disassociate target fd with simulator fd and cleanup subsidiary fields 17910930Sbrandon.potter@amd.com void reset_fd_entry(int tgt_fd); 1802SN/A 1812SN/A // look up simulator fd for given target fd 1822SN/A int sim_fd(int tgt_fd); 1832SN/A 18410930Sbrandon.potter@amd.com // look up fd entry for a given target fd 18510930Sbrandon.potter@amd.com FDEntry *get_fd_entry(int tgt_fd); 1865282Srstrong@cs.ucsd.edu 18710929Sbrandon.potter@amd.com // look up target fd for given host fd 18810929Sbrandon.potter@amd.com // Assumes a 1:1 mapping between target file descriptor and host file 18910929Sbrandon.potter@amd.com // descriptor. Given the current API, this must be true given that it's 19010929Sbrandon.potter@amd.com // not possible to map multiple target file descriptors to the same host 19110929Sbrandon.potter@amd.com // file descriptor 19210929Sbrandon.potter@amd.com int tgt_fd(int sim_fd); 19310929Sbrandon.potter@amd.com 1945282Srstrong@cs.ucsd.edu // fix all offsets for currently open files and save them 1955282Srstrong@cs.ucsd.edu void fix_file_offsets(); 1965282Srstrong@cs.ucsd.edu 1975282Srstrong@cs.ucsd.edu // find all offsets for currently open files and save them 1985282Srstrong@cs.ucsd.edu void find_file_offsets(); 1995282Srstrong@cs.ucsd.edu 2005282Srstrong@cs.ucsd.edu // set the source of this read pipe for a checkpoint resume 2015282Srstrong@cs.ucsd.edu void setReadPipeSource(int read_pipe_fd, int source_fd); 2025282Srstrong@cs.ucsd.edu 2032680Sktlim@umich.edu virtual void syscall(int64_t callnum, ThreadContext *tc) = 0; 2043311Ssaidi@eecs.umich.edu 2058601Ssteve.reinhardt@amd.com void allocateMem(Addr vaddr, int64_t size, bool clobber = false); 2068601Ssteve.reinhardt@amd.com 2078539Sgblack@eecs.umich.edu /// Attempt to fix up a fault at vaddr by allocating a page on the stack. 2088539Sgblack@eecs.umich.edu /// @return Whether the fault has been fixed. 2098539Sgblack@eecs.umich.edu bool fixupStackFault(Addr vaddr); 2104434Ssaidi@eecs.umich.edu 2119110Ssteve.reinhardt@amd.com /** 21210558Salexandru.dutu@amd.com * Maps a contiguous range of virtual addresses in this process's 2139110Ssteve.reinhardt@amd.com * address space to a contiguous range of physical addresses. 21410558Salexandru.dutu@amd.com * This function exists primarily to expose the map operation to 21510558Salexandru.dutu@amd.com * python, so that configuration scripts can set up mappings in SE mode. 2169110Ssteve.reinhardt@amd.com * 2179110Ssteve.reinhardt@amd.com * @param vaddr The starting virtual address of the range. 2189110Ssteve.reinhardt@amd.com * @param paddr The starting physical address of the range. 2199110Ssteve.reinhardt@amd.com * @param size The length of the range in bytes. 22010558Salexandru.dutu@amd.com * @param cacheable Specifies whether accesses are cacheable. 2219110Ssteve.reinhardt@amd.com * @return True if the map operation was successful. (At this 2229110Ssteve.reinhardt@amd.com * point in time, the map operation always succeeds.) 2239110Ssteve.reinhardt@amd.com */ 22410558Salexandru.dutu@amd.com bool map(Addr vaddr, Addr paddr, int size, bool cacheable = true); 2259110Ssteve.reinhardt@amd.com 22610905Sandreas.sandberg@arm.com void serialize(CheckpointOut &cp) const M5_ATTR_OVERRIDE; 22710905Sandreas.sandberg@arm.com void unserialize(CheckpointIn &cp) M5_ATTR_OVERRIDE; 2282SN/A}; 2292SN/A 2302SN/A// 2312SN/A// "Live" process with system calls redirected to host system 2322SN/A// 233360SN/Aclass ObjectFile; 2342SN/Aclass LiveProcess : public Process 2352SN/A{ 236360SN/A protected: 2372378SN/A ObjectFile *objFile; 2382378SN/A std::vector<std::string> argv; 2392378SN/A std::vector<std::string> envp; 2403669Sbinkertn@umich.edu std::string cwd; 2412378SN/A 2428325Ssteve.reinhardt@amd.com LiveProcess(LiveProcessParams *params, ObjectFile *objFile); 2432SN/A 2443114Sgblack@eecs.umich.edu // Id of the owner of the process 2453114Sgblack@eecs.umich.edu uint64_t __uid; 2463114Sgblack@eecs.umich.edu uint64_t __euid; 2473114Sgblack@eecs.umich.edu uint64_t __gid; 2483114Sgblack@eecs.umich.edu uint64_t __egid; 2493114Sgblack@eecs.umich.edu 2503114Sgblack@eecs.umich.edu // pid of the process and it's parent 2513114Sgblack@eecs.umich.edu uint64_t __pid; 2523114Sgblack@eecs.umich.edu uint64_t __ppid; 2533114Sgblack@eecs.umich.edu 25410496Ssteve.reinhardt@amd.com // Emulated drivers available to this process 25510496Ssteve.reinhardt@amd.com std::vector<EmulatedDriver *> drivers; 25610496Ssteve.reinhardt@amd.com 257360SN/A public: 2583114Sgblack@eecs.umich.edu 2594793Sgblack@eecs.umich.edu enum AuxiliaryVectorType { 2604793Sgblack@eecs.umich.edu M5_AT_NULL = 0, 2614793Sgblack@eecs.umich.edu M5_AT_IGNORE = 1, 2624793Sgblack@eecs.umich.edu M5_AT_EXECFD = 2, 2634793Sgblack@eecs.umich.edu M5_AT_PHDR = 3, 2644793Sgblack@eecs.umich.edu M5_AT_PHENT = 4, 2654793Sgblack@eecs.umich.edu M5_AT_PHNUM = 5, 2664793Sgblack@eecs.umich.edu M5_AT_PAGESZ = 6, 2674793Sgblack@eecs.umich.edu M5_AT_BASE = 7, 2684793Sgblack@eecs.umich.edu M5_AT_FLAGS = 8, 2694793Sgblack@eecs.umich.edu M5_AT_ENTRY = 9, 2704793Sgblack@eecs.umich.edu M5_AT_NOTELF = 10, 2714793Sgblack@eecs.umich.edu M5_AT_UID = 11, 2724793Sgblack@eecs.umich.edu M5_AT_EUID = 12, 2734793Sgblack@eecs.umich.edu M5_AT_GID = 13, 2744793Sgblack@eecs.umich.edu M5_AT_EGID = 14, 2754793Sgblack@eecs.umich.edu // The following may be specific to Linux 2764793Sgblack@eecs.umich.edu M5_AT_PLATFORM = 15, 2774793Sgblack@eecs.umich.edu M5_AT_HWCAP = 16, 2784793Sgblack@eecs.umich.edu M5_AT_CLKTCK = 17, 2794793Sgblack@eecs.umich.edu 2804793Sgblack@eecs.umich.edu M5_AT_SECURE = 23, 2816399Sgblack@eecs.umich.edu M5_BASE_PLATFORM = 24, 2826399Sgblack@eecs.umich.edu M5_AT_RANDOM = 25, 2836399Sgblack@eecs.umich.edu 2846399Sgblack@eecs.umich.edu M5_AT_EXECFN = 31, 2854793Sgblack@eecs.umich.edu 2864793Sgblack@eecs.umich.edu M5_AT_VECTOR_SIZE = 44 2874793Sgblack@eecs.umich.edu }; 2884793Sgblack@eecs.umich.edu 2893114Sgblack@eecs.umich.edu inline uint64_t uid() {return __uid;} 2903114Sgblack@eecs.umich.edu inline uint64_t euid() {return __euid;} 2913114Sgblack@eecs.umich.edu inline uint64_t gid() {return __gid;} 2923114Sgblack@eecs.umich.edu inline uint64_t egid() {return __egid;} 2933114Sgblack@eecs.umich.edu inline uint64_t pid() {return __pid;} 2943114Sgblack@eecs.umich.edu inline uint64_t ppid() {return __ppid;} 2953114Sgblack@eecs.umich.edu 2969144Ssteve.reinhardt@amd.com // provide program name for debug messages 2979144Ssteve.reinhardt@amd.com virtual const char *progName() const { return argv[0].c_str(); } 2989144Ssteve.reinhardt@amd.com 2993669Sbinkertn@umich.edu std::string 3003669Sbinkertn@umich.edu fullPath(const std::string &filename) 3013669Sbinkertn@umich.edu { 3023669Sbinkertn@umich.edu if (filename[0] == '/' || cwd.empty()) 3033669Sbinkertn@umich.edu return filename; 3043669Sbinkertn@umich.edu 3053669Sbinkertn@umich.edu std::string full = cwd; 3063669Sbinkertn@umich.edu 3073669Sbinkertn@umich.edu if (cwd[cwd.size() - 1] != '/') 3083669Sbinkertn@umich.edu full += '/'; 3093669Sbinkertn@umich.edu 3103669Sbinkertn@umich.edu return full + filename; 3113669Sbinkertn@umich.edu } 3123669Sbinkertn@umich.edu 3135513SMichael.Adler@intel.com std::string getcwd() const { return cwd; } 3145513SMichael.Adler@intel.com 3152680Sktlim@umich.edu virtual void syscall(int64_t callnum, ThreadContext *tc); 3166701Sgblack@eecs.umich.edu 3176701Sgblack@eecs.umich.edu virtual TheISA::IntReg getSyscallArg(ThreadContext *tc, int &i) = 0; 3186701Sgblack@eecs.umich.edu virtual TheISA::IntReg getSyscallArg(ThreadContext *tc, int &i, int width); 3195958Sgblack@eecs.umich.edu virtual void setSyscallArg(ThreadContext *tc, 3205958Sgblack@eecs.umich.edu int i, TheISA::IntReg val) = 0; 3215958Sgblack@eecs.umich.edu virtual void setSyscallReturn(ThreadContext *tc, 3225958Sgblack@eecs.umich.edu SyscallReturn return_value) = 0; 3232093SN/A 3248325Ssteve.reinhardt@amd.com virtual SyscallDesc *getDesc(int callnum) = 0; 3252715Sstever@eecs.umich.edu 32610496Ssteve.reinhardt@amd.com /** 32710496Ssteve.reinhardt@amd.com * Find an emulated device driver. 32810496Ssteve.reinhardt@amd.com * 32910496Ssteve.reinhardt@amd.com * @param filename Name of the device (under /dev) 33010496Ssteve.reinhardt@amd.com * @return Pointer to driver object if found, else NULL 33110496Ssteve.reinhardt@amd.com */ 33210496Ssteve.reinhardt@amd.com EmulatedDriver *findDriver(std::string filename); 33310496Ssteve.reinhardt@amd.com 3342715Sstever@eecs.umich.edu // this function is used to create the LiveProcess object, since 3352715Sstever@eecs.umich.edu // we can't tell which subclass of LiveProcess to use until we 3362715Sstever@eecs.umich.edu // open and look at the object file. 3378325Ssteve.reinhardt@amd.com static LiveProcess *create(LiveProcessParams *params); 3382SN/A}; 3392SN/A 340360SN/A 341360SN/A#endif // __PROCESS_HH__ 342