process.hh revision 10554
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 364117Sgblack@eecs.umich.edu#include <string> 37180SN/A#include <vector> 382SN/A 396329Sgblack@eecs.umich.edu#include "arch/registers.hh" 402378SN/A#include "base/statistics.hh" 416214Snate@binkert.org#include "base/types.hh" 426658Snate@binkert.org#include "config/the_isa.hh" 438852Sandreas.hansson@arm.com#include "mem/se_translating_port_proxy.hh" 4456SN/A#include "sim/sim_object.hh" 455958Sgblack@eecs.umich.edu#include "sim/syscallreturn.hh" 462SN/A 475154Sgblack@eecs.umich.educlass PageTable; 488737Skoansin.tan@gmail.comstruct ProcessParams; 498737Skoansin.tan@gmail.comstruct LiveProcessParams; 505154Sgblack@eecs.umich.educlass SyscallDesc; 515154Sgblack@eecs.umich.educlass System; 522680Sktlim@umich.educlass ThreadContext; 5310496Ssteve.reinhardt@amd.comclass EmulatedDriver; 542378SN/A 555758Shsul@eecs.umich.edutemplate<class IntType> 565771Shsul@eecs.umich.edustruct AuxVector 575758Shsul@eecs.umich.edu{ 585758Shsul@eecs.umich.edu IntType a_type; 595771Shsul@eecs.umich.edu IntType a_val; 605758Shsul@eecs.umich.edu 615771Shsul@eecs.umich.edu AuxVector() 625758Shsul@eecs.umich.edu {} 635758Shsul@eecs.umich.edu 645771Shsul@eecs.umich.edu AuxVector(IntType type, IntType val); 655758Shsul@eecs.umich.edu}; 665758Shsul@eecs.umich.edu 672SN/Aclass Process : public SimObject 682SN/A{ 692SN/A public: 702SN/A 712378SN/A /// Pointer to object representing the system this process is 722378SN/A /// running on. 732378SN/A System *system; 742378SN/A 752680Sktlim@umich.edu // thread contexts associated with this process 765713Shsul@eecs.umich.edu std::vector<int> contextIds; 77180SN/A 78180SN/A // number of CPUs (esxec contexts, really) assigned to this process. 795713Shsul@eecs.umich.edu unsigned int numCpus() { return contextIds.size(); } 802SN/A 812SN/A // record of blocked context 822SN/A struct WaitRec 832SN/A { 842SN/A Addr waitChan; 852680Sktlim@umich.edu ThreadContext *waitingContext; 862SN/A 872680Sktlim@umich.edu WaitRec(Addr chan, ThreadContext *ctx) 882SN/A : waitChan(chan), waitingContext(ctx) 895543Ssaidi@eecs.umich.edu { } 902SN/A }; 912SN/A 922SN/A // list of all blocked contexts 932SN/A std::list<WaitRec> waitList; 942SN/A 955543Ssaidi@eecs.umich.edu Addr brk_point; // top of the data segment 962SN/A 975543Ssaidi@eecs.umich.edu Addr stack_base; // stack segment base (highest address) 985543Ssaidi@eecs.umich.edu unsigned stack_size; // initial stack size 995543Ssaidi@eecs.umich.edu Addr stack_min; // lowest address accessed on the stack 1002SN/A 1015154Sgblack@eecs.umich.edu // The maximum size allowed for the stack. 1025154Sgblack@eecs.umich.edu Addr max_stack_size; 1035154Sgblack@eecs.umich.edu 1042SN/A // addr to use for next stack region (for multithreaded apps) 1052SN/A Addr next_thread_stack_base; 1062SN/A 107360SN/A // Base of region for mmaps (when user doesn't specify an address). 1081408SN/A Addr mmap_start; 1091408SN/A Addr mmap_end; 110360SN/A 1111514SN/A // Base of region for nxm data 1121514SN/A Addr nxm_start; 1131514SN/A Addr nxm_end; 1141514SN/A 1155999Snate@binkert.org Stats::Scalar num_syscalls; // number of syscalls executed 1162SN/A 1172SN/A protected: 1182SN/A // constructor 1198325Ssteve.reinhardt@amd.com Process(ProcessParams *params); 1202SN/A 1217532Ssteve.reinhardt@amd.com virtual void initState(); 1222SN/A 1232378SN/A public: 1242SN/A 1254997Sgblack@eecs.umich.edu //This id is assigned by m5 and is used to keep process' tlb entries 1264997Sgblack@eecs.umich.edu //separated. 1274997Sgblack@eecs.umich.edu uint64_t M5_pid; 1284997Sgblack@eecs.umich.edu 12910299Salexandru.dutu@amd.com // flag for using architecture specific page table 13010299Salexandru.dutu@amd.com bool useArchPT; 13110554Salexandru.dutu@amd.com // running KvmCPU in SE mode requires special initialization 13210554Salexandru.dutu@amd.com bool kvmInSE; 13310554Salexandru.dutu@amd.com 13410298Salexandru.dutu@amd.com PageTableBase* pTable; 1358852Sandreas.hansson@arm.com 1365282Srstrong@cs.ucsd.edu class FdMap 1375282Srstrong@cs.ucsd.edu { 1385282Srstrong@cs.ucsd.edu public: 1398325Ssteve.reinhardt@amd.com int fd; 1408325Ssteve.reinhardt@amd.com std::string filename; 1418325Ssteve.reinhardt@amd.com int mode; 1428325Ssteve.reinhardt@amd.com int flags; 1438325Ssteve.reinhardt@amd.com bool isPipe; 1448325Ssteve.reinhardt@amd.com int readPipeSource; 1458325Ssteve.reinhardt@amd.com uint64_t fileOffset; 14610496Ssteve.reinhardt@amd.com EmulatedDriver *driver; 1475282Srstrong@cs.ucsd.edu 1488325Ssteve.reinhardt@amd.com FdMap() 1498325Ssteve.reinhardt@amd.com : fd(-1), filename("NULL"), mode(0), flags(0), 15010496Ssteve.reinhardt@amd.com isPipe(false), readPipeSource(0), fileOffset(0), driver(NULL) 1518325Ssteve.reinhardt@amd.com { } 1525282Srstrong@cs.ucsd.edu 1535282Srstrong@cs.ucsd.edu void serialize(std::ostream &os); 1545282Srstrong@cs.ucsd.edu void unserialize(Checkpoint *cp, const std::string §ion); 1555282Srstrong@cs.ucsd.edu }; 1565282Srstrong@cs.ucsd.edu 1578852Sandreas.hansson@arm.com protected: 1588852Sandreas.hansson@arm.com /// Memory proxy for initialization (image loading) 1598852Sandreas.hansson@arm.com SETranslatingPortProxy initVirtMem; 1608852Sandreas.hansson@arm.com 1612SN/A private: 1622SN/A // file descriptor remapping support 1635282Srstrong@cs.ucsd.edu static const int MAX_FD = 256; // max legal fd value 1645282Srstrong@cs.ucsd.edu FdMap fd_map[MAX_FD+1]; 1655282Srstrong@cs.ucsd.edu 1662SN/A 1672SN/A public: 1682SN/A // static helper functions to generate file descriptors for constructor 1692SN/A static int openInputFile(const std::string &filename); 1702SN/A static int openOutputFile(const std::string &filename); 1712SN/A 1722SN/A // override of virtual SimObject method: register statistics 1732SN/A virtual void regStats(); 1742SN/A 1755713Shsul@eecs.umich.edu // After getting registered with system object, tell process which 1765713Shsul@eecs.umich.edu // system-wide context id it is assigned. 1775713Shsul@eecs.umich.edu void assignThreadContext(int context_id) 1785713Shsul@eecs.umich.edu { 1795713Shsul@eecs.umich.edu contextIds.push_back(context_id); 1805713Shsul@eecs.umich.edu } 181180SN/A 1825713Shsul@eecs.umich.edu // Find a free context to use 1838325Ssteve.reinhardt@amd.com ThreadContext *findFreeContext(); 1842SN/A 1859144Ssteve.reinhardt@amd.com // provide program name for debug messages 1869144Ssteve.reinhardt@amd.com virtual const char *progName() const { return "<unknown>"; } 1879144Ssteve.reinhardt@amd.com 1882SN/A // map simulator fd sim_fd to target fd tgt_fd 1892SN/A void dup_fd(int sim_fd, int tgt_fd); 1902SN/A 1912SN/A // generate new target fd for sim_fd 1928325Ssteve.reinhardt@amd.com int alloc_fd(int sim_fd, std::string filename, int flags, int mode, 1938325Ssteve.reinhardt@amd.com bool pipe); 1941970SN/A 1951970SN/A // free target fd (e.g., after close) 1961970SN/A void free_fd(int tgt_fd); 1972SN/A 1982SN/A // look up simulator fd for given target fd 1992SN/A int sim_fd(int tgt_fd); 2002SN/A 2015282Srstrong@cs.ucsd.edu // look up simulator fd_map object for a given target fd 2028325Ssteve.reinhardt@amd.com FdMap *sim_fd_obj(int tgt_fd); 2035282Srstrong@cs.ucsd.edu 2045282Srstrong@cs.ucsd.edu // fix all offsets for currently open files and save them 2055282Srstrong@cs.ucsd.edu void fix_file_offsets(); 2065282Srstrong@cs.ucsd.edu 2075282Srstrong@cs.ucsd.edu // find all offsets for currently open files and save them 2085282Srstrong@cs.ucsd.edu void find_file_offsets(); 2095282Srstrong@cs.ucsd.edu 2105282Srstrong@cs.ucsd.edu // set the source of this read pipe for a checkpoint resume 2115282Srstrong@cs.ucsd.edu void setReadPipeSource(int read_pipe_fd, int source_fd); 2125282Srstrong@cs.ucsd.edu 2132680Sktlim@umich.edu virtual void syscall(int64_t callnum, ThreadContext *tc) = 0; 2143311Ssaidi@eecs.umich.edu 2158601Ssteve.reinhardt@amd.com void allocateMem(Addr vaddr, int64_t size, bool clobber = false); 2168601Ssteve.reinhardt@amd.com 2178539Sgblack@eecs.umich.edu /// Attempt to fix up a fault at vaddr by allocating a page on the stack. 2188539Sgblack@eecs.umich.edu /// @return Whether the fault has been fixed. 2198539Sgblack@eecs.umich.edu bool fixupStackFault(Addr vaddr); 2204434Ssaidi@eecs.umich.edu 2219110Ssteve.reinhardt@amd.com /** 2229110Ssteve.reinhardt@amd.com * Map a contiguous range of virtual addresses in this process's 2239110Ssteve.reinhardt@amd.com * address space to a contiguous range of physical addresses. 2249110Ssteve.reinhardt@amd.com * This function exists primarily to enable exposing the map 2259110Ssteve.reinhardt@amd.com * operation to python, so that configuration scripts can set up 2269110Ssteve.reinhardt@amd.com * mappings in SE mode. 2279110Ssteve.reinhardt@amd.com * 2289110Ssteve.reinhardt@amd.com * @param vaddr The starting virtual address of the range. 2299110Ssteve.reinhardt@amd.com * @param paddr The starting physical address of the range. 2309110Ssteve.reinhardt@amd.com * @param size The length of the range in bytes. 2319110Ssteve.reinhardt@amd.com * @return True if the map operation was successful. (At this 2329110Ssteve.reinhardt@amd.com * point in time, the map operation always succeeds.) 2339110Ssteve.reinhardt@amd.com */ 2349110Ssteve.reinhardt@amd.com bool map(Addr vaddr, Addr paddr, int size); 2359110Ssteve.reinhardt@amd.com 2363311Ssaidi@eecs.umich.edu void serialize(std::ostream &os); 2373311Ssaidi@eecs.umich.edu void unserialize(Checkpoint *cp, const std::string §ion); 2382SN/A}; 2392SN/A 2402SN/A// 2412SN/A// "Live" process with system calls redirected to host system 2422SN/A// 243360SN/Aclass ObjectFile; 2442SN/Aclass LiveProcess : public Process 2452SN/A{ 246360SN/A protected: 2472378SN/A ObjectFile *objFile; 2482378SN/A std::vector<std::string> argv; 2492378SN/A std::vector<std::string> envp; 2503669Sbinkertn@umich.edu std::string cwd; 2512378SN/A 2528325Ssteve.reinhardt@amd.com LiveProcess(LiveProcessParams *params, ObjectFile *objFile); 2532SN/A 2543114Sgblack@eecs.umich.edu // Id of the owner of the process 2553114Sgblack@eecs.umich.edu uint64_t __uid; 2563114Sgblack@eecs.umich.edu uint64_t __euid; 2573114Sgblack@eecs.umich.edu uint64_t __gid; 2583114Sgblack@eecs.umich.edu uint64_t __egid; 2593114Sgblack@eecs.umich.edu 2603114Sgblack@eecs.umich.edu // pid of the process and it's parent 2613114Sgblack@eecs.umich.edu uint64_t __pid; 2623114Sgblack@eecs.umich.edu uint64_t __ppid; 2633114Sgblack@eecs.umich.edu 26410496Ssteve.reinhardt@amd.com // Emulated drivers available to this process 26510496Ssteve.reinhardt@amd.com std::vector<EmulatedDriver *> drivers; 26610496Ssteve.reinhardt@amd.com 267360SN/A public: 2683114Sgblack@eecs.umich.edu 2694793Sgblack@eecs.umich.edu enum AuxiliaryVectorType { 2704793Sgblack@eecs.umich.edu M5_AT_NULL = 0, 2714793Sgblack@eecs.umich.edu M5_AT_IGNORE = 1, 2724793Sgblack@eecs.umich.edu M5_AT_EXECFD = 2, 2734793Sgblack@eecs.umich.edu M5_AT_PHDR = 3, 2744793Sgblack@eecs.umich.edu M5_AT_PHENT = 4, 2754793Sgblack@eecs.umich.edu M5_AT_PHNUM = 5, 2764793Sgblack@eecs.umich.edu M5_AT_PAGESZ = 6, 2774793Sgblack@eecs.umich.edu M5_AT_BASE = 7, 2784793Sgblack@eecs.umich.edu M5_AT_FLAGS = 8, 2794793Sgblack@eecs.umich.edu M5_AT_ENTRY = 9, 2804793Sgblack@eecs.umich.edu M5_AT_NOTELF = 10, 2814793Sgblack@eecs.umich.edu M5_AT_UID = 11, 2824793Sgblack@eecs.umich.edu M5_AT_EUID = 12, 2834793Sgblack@eecs.umich.edu M5_AT_GID = 13, 2844793Sgblack@eecs.umich.edu M5_AT_EGID = 14, 2854793Sgblack@eecs.umich.edu // The following may be specific to Linux 2864793Sgblack@eecs.umich.edu M5_AT_PLATFORM = 15, 2874793Sgblack@eecs.umich.edu M5_AT_HWCAP = 16, 2884793Sgblack@eecs.umich.edu M5_AT_CLKTCK = 17, 2894793Sgblack@eecs.umich.edu 2904793Sgblack@eecs.umich.edu M5_AT_SECURE = 23, 2916399Sgblack@eecs.umich.edu M5_BASE_PLATFORM = 24, 2926399Sgblack@eecs.umich.edu M5_AT_RANDOM = 25, 2936399Sgblack@eecs.umich.edu 2946399Sgblack@eecs.umich.edu M5_AT_EXECFN = 31, 2954793Sgblack@eecs.umich.edu 2964793Sgblack@eecs.umich.edu M5_AT_VECTOR_SIZE = 44 2974793Sgblack@eecs.umich.edu }; 2984793Sgblack@eecs.umich.edu 2993114Sgblack@eecs.umich.edu inline uint64_t uid() {return __uid;} 3003114Sgblack@eecs.umich.edu inline uint64_t euid() {return __euid;} 3013114Sgblack@eecs.umich.edu inline uint64_t gid() {return __gid;} 3023114Sgblack@eecs.umich.edu inline uint64_t egid() {return __egid;} 3033114Sgblack@eecs.umich.edu inline uint64_t pid() {return __pid;} 3043114Sgblack@eecs.umich.edu inline uint64_t ppid() {return __ppid;} 3053114Sgblack@eecs.umich.edu 3069144Ssteve.reinhardt@amd.com // provide program name for debug messages 3079144Ssteve.reinhardt@amd.com virtual const char *progName() const { return argv[0].c_str(); } 3089144Ssteve.reinhardt@amd.com 3093669Sbinkertn@umich.edu std::string 3103669Sbinkertn@umich.edu fullPath(const std::string &filename) 3113669Sbinkertn@umich.edu { 3123669Sbinkertn@umich.edu if (filename[0] == '/' || cwd.empty()) 3133669Sbinkertn@umich.edu return filename; 3143669Sbinkertn@umich.edu 3153669Sbinkertn@umich.edu std::string full = cwd; 3163669Sbinkertn@umich.edu 3173669Sbinkertn@umich.edu if (cwd[cwd.size() - 1] != '/') 3183669Sbinkertn@umich.edu full += '/'; 3193669Sbinkertn@umich.edu 3203669Sbinkertn@umich.edu return full + filename; 3213669Sbinkertn@umich.edu } 3223669Sbinkertn@umich.edu 3235513SMichael.Adler@intel.com std::string getcwd() const { return cwd; } 3245513SMichael.Adler@intel.com 3252680Sktlim@umich.edu virtual void syscall(int64_t callnum, ThreadContext *tc); 3266701Sgblack@eecs.umich.edu 3276701Sgblack@eecs.umich.edu virtual TheISA::IntReg getSyscallArg(ThreadContext *tc, int &i) = 0; 3286701Sgblack@eecs.umich.edu virtual TheISA::IntReg getSyscallArg(ThreadContext *tc, int &i, int width); 3295958Sgblack@eecs.umich.edu virtual void setSyscallArg(ThreadContext *tc, 3305958Sgblack@eecs.umich.edu int i, TheISA::IntReg val) = 0; 3315958Sgblack@eecs.umich.edu virtual void setSyscallReturn(ThreadContext *tc, 3325958Sgblack@eecs.umich.edu SyscallReturn return_value) = 0; 3332093SN/A 3348325Ssteve.reinhardt@amd.com virtual SyscallDesc *getDesc(int callnum) = 0; 3352715Sstever@eecs.umich.edu 33610496Ssteve.reinhardt@amd.com /** 33710496Ssteve.reinhardt@amd.com * Find an emulated device driver. 33810496Ssteve.reinhardt@amd.com * 33910496Ssteve.reinhardt@amd.com * @param filename Name of the device (under /dev) 34010496Ssteve.reinhardt@amd.com * @return Pointer to driver object if found, else NULL 34110496Ssteve.reinhardt@amd.com */ 34210496Ssteve.reinhardt@amd.com EmulatedDriver *findDriver(std::string filename); 34310496Ssteve.reinhardt@amd.com 3442715Sstever@eecs.umich.edu // this function is used to create the LiveProcess object, since 3452715Sstever@eecs.umich.edu // we can't tell which subclass of LiveProcess to use until we 3462715Sstever@eecs.umich.edu // open and look at the object file. 3478325Ssteve.reinhardt@amd.com static LiveProcess *create(LiveProcessParams *params); 3482SN/A}; 3492SN/A 350360SN/A 351360SN/A#endif // __PROCESS_HH__ 352