process.hh revision 6701
110263Satgutier@umich.edu/* 210941Sdavid.guillen@arm.com * Copyright (c) 2001-2005 The Regents of The University of Michigan 310263Satgutier@umich.edu * All rights reserved. 410263Satgutier@umich.edu * 510263Satgutier@umich.edu * Redistribution and use in source and binary forms, with or without 610263Satgutier@umich.edu * modification, are permitted provided that the following conditions are 710263Satgutier@umich.edu * met: redistributions of source code must retain the above copyright 810263Satgutier@umich.edu * notice, this list of conditions and the following disclaimer; 910263Satgutier@umich.edu * redistributions in binary form must reproduce the above copyright 1010263Satgutier@umich.edu * notice, this list of conditions and the following disclaimer in the 1110263Satgutier@umich.edu * documentation and/or other materials provided with the distribution; 1210263Satgutier@umich.edu * neither the name of the copyright holders nor the names of its 1310263Satgutier@umich.edu * contributors may be used to endorse or promote products derived from 1410263Satgutier@umich.edu * this software without specific prior written permission. 1510263Satgutier@umich.edu * 1610263Satgutier@umich.edu * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1710263Satgutier@umich.edu * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 1810263Satgutier@umich.edu * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 1910263Satgutier@umich.edu * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 2010263Satgutier@umich.edu * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2110263Satgutier@umich.edu * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 2210263Satgutier@umich.edu * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2310263Satgutier@umich.edu * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2410263Satgutier@umich.edu * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2510263Satgutier@umich.edu * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 2610263Satgutier@umich.edu * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 2710263Satgutier@umich.edu * 2810263Satgutier@umich.edu * Authors: Nathan Binkert 2910263Satgutier@umich.edu * Steve Reinhardt 3010263Satgutier@umich.edu */ 3110263Satgutier@umich.edu 3210263Satgutier@umich.edu#ifndef __PROCESS_HH__ 3310263Satgutier@umich.edu#define __PROCESS_HH__ 3410263Satgutier@umich.edu 3510263Satgutier@umich.edu// 3610263Satgutier@umich.edu// The purpose of this code is to fake the loader & syscall mechanism 3710263Satgutier@umich.edu// when there's no OS: thus there's no reason to use it in FULL_SYSTEM 3810263Satgutier@umich.edu// mode when we do have an OS. 3910263Satgutier@umich.edu// 4010263Satgutier@umich.edu#include "config/full_system.hh" 4110263Satgutier@umich.edu 4210263Satgutier@umich.edu#if !FULL_SYSTEM 4310263Satgutier@umich.edu 4410263Satgutier@umich.edu#include <string> 4510263Satgutier@umich.edu#include <vector> 4610263Satgutier@umich.edu 4710263Satgutier@umich.edu#include "arch/registers.hh" 4810263Satgutier@umich.edu#include "base/statistics.hh" 4910263Satgutier@umich.edu#include "base/types.hh" 5010263Satgutier@umich.edu#include "config/the_isa.hh" 5110263Satgutier@umich.edu#include "sim/sim_object.hh" 5210263Satgutier@umich.edu#include "sim/syscallreturn.hh" 5310263Satgutier@umich.edu 5410263Satgutier@umich.educlass BaseRemoteGDB; 5510263Satgutier@umich.educlass GDBListener; 5610263Satgutier@umich.educlass PageTable; 5710263Satgutier@umich.educlass ProcessParams; 5810263Satgutier@umich.educlass LiveProcessParams; 5910263Satgutier@umich.educlass SyscallDesc; 6010263Satgutier@umich.educlass System; 6110263Satgutier@umich.educlass ThreadContext; 6210263Satgutier@umich.educlass TranslatingPort; 6310263Satgutier@umich.edu 6410263Satgutier@umich.edutemplate<class IntType> 6510263Satgutier@umich.edustruct AuxVector 6610263Satgutier@umich.edu{ 6710263Satgutier@umich.edu IntType a_type; 6810263Satgutier@umich.edu IntType a_val; 6910263Satgutier@umich.edu 7010263Satgutier@umich.edu AuxVector() 7110263Satgutier@umich.edu {} 7210263Satgutier@umich.edu 7310263Satgutier@umich.edu AuxVector(IntType type, IntType val); 7410263Satgutier@umich.edu}; 7510263Satgutier@umich.edu 7610263Satgutier@umich.educlass Process : public SimObject 7710263Satgutier@umich.edu{ 7810263Satgutier@umich.edu public: 7910263Satgutier@umich.edu 8010263Satgutier@umich.edu /// Pointer to object representing the system this process is 8110263Satgutier@umich.edu /// running on. 8210263Satgutier@umich.edu System *system; 8310263Satgutier@umich.edu 8410263Satgutier@umich.edu // have we initialized a thread context from this process? If 8510263Satgutier@umich.edu // yes, subsequent contexts are assumed to be for dynamically 8610263Satgutier@umich.edu // created threads and are not initialized. 8710263Satgutier@umich.edu bool initialContextLoaded; 8810263Satgutier@umich.edu 8910263Satgutier@umich.edu bool checkpointRestored; 9010941Sdavid.guillen@arm.com 9110941Sdavid.guillen@arm.com // thread contexts associated with this process 9210263Satgutier@umich.edu std::vector<int> contextIds; 9310263Satgutier@umich.edu 9410263Satgutier@umich.edu // remote gdb objects 9510263Satgutier@umich.edu std::vector<BaseRemoteGDB *> remoteGDB; 9610263Satgutier@umich.edu std::vector<GDBListener *> gdbListen; 9710263Satgutier@umich.edu bool breakpoint(); 9810263Satgutier@umich.edu 9910263Satgutier@umich.edu // number of CPUs (esxec contexts, really) assigned to this process. 10010263Satgutier@umich.edu unsigned int numCpus() { return contextIds.size(); } 10110263Satgutier@umich.edu 10210263Satgutier@umich.edu // record of blocked context 10310263Satgutier@umich.edu struct WaitRec 10410263Satgutier@umich.edu { 10510263Satgutier@umich.edu Addr waitChan; 10610263Satgutier@umich.edu ThreadContext *waitingContext; 10710263Satgutier@umich.edu 10810263Satgutier@umich.edu WaitRec(Addr chan, ThreadContext *ctx) 10910263Satgutier@umich.edu : waitChan(chan), waitingContext(ctx) 11010263Satgutier@umich.edu { } 11110263Satgutier@umich.edu }; 11210263Satgutier@umich.edu 11310263Satgutier@umich.edu // list of all blocked contexts 11410263Satgutier@umich.edu std::list<WaitRec> waitList; 11510263Satgutier@umich.edu 11610263Satgutier@umich.edu Addr brk_point; // top of the data segment 11710263Satgutier@umich.edu 11810263Satgutier@umich.edu Addr stack_base; // stack segment base (highest address) 11910263Satgutier@umich.edu unsigned stack_size; // initial stack size 12010263Satgutier@umich.edu Addr stack_min; // lowest address accessed on the stack 12110263Satgutier@umich.edu 12210263Satgutier@umich.edu // The maximum size allowed for the stack. 12310263Satgutier@umich.edu Addr max_stack_size; 12410263Satgutier@umich.edu 12510263Satgutier@umich.edu // addr to use for next stack region (for multithreaded apps) 12610263Satgutier@umich.edu Addr next_thread_stack_base; 12710263Satgutier@umich.edu 12810263Satgutier@umich.edu // Base of region for mmaps (when user doesn't specify an address). 12910263Satgutier@umich.edu Addr mmap_start; 13010263Satgutier@umich.edu Addr mmap_end; 13110263Satgutier@umich.edu 13210263Satgutier@umich.edu // Base of region for nxm data 13310263Satgutier@umich.edu Addr nxm_start; 13410263Satgutier@umich.edu Addr nxm_end; 13510263Satgutier@umich.edu 13610263Satgutier@umich.edu std::string prog_fname; // file name 13710263Satgutier@umich.edu 13810263Satgutier@umich.edu Stats::Scalar num_syscalls; // number of syscalls executed 13910263Satgutier@umich.edu 14010263Satgutier@umich.edu 14110263Satgutier@umich.edu protected: 14210263Satgutier@umich.edu // constructor 14310263Satgutier@umich.edu Process(ProcessParams * params); 14410263Satgutier@umich.edu 14510263Satgutier@umich.edu // post initialization startup 14610263Satgutier@umich.edu virtual void startup(); 14710263Satgutier@umich.edu 14810263Satgutier@umich.edu protected: 14910263Satgutier@umich.edu /// Memory object for initialization (image loading) 15010263Satgutier@umich.edu TranslatingPort *initVirtMem; 15110941Sdavid.guillen@arm.com 15210941Sdavid.guillen@arm.com public: 15310941Sdavid.guillen@arm.com PageTable *pTable; 15410941Sdavid.guillen@arm.com 15511169Sandreas.hansson@arm.com //This id is assigned by m5 and is used to keep process' tlb entries 15610941Sdavid.guillen@arm.com //separated. 15710941Sdavid.guillen@arm.com uint64_t M5_pid; 15810941Sdavid.guillen@arm.com 15910941Sdavid.guillen@arm.com class FdMap 16010941Sdavid.guillen@arm.com { 16110941Sdavid.guillen@arm.com public: 16210941Sdavid.guillen@arm.com int fd; 16310941Sdavid.guillen@arm.com std::string filename; 16410941Sdavid.guillen@arm.com int mode; 16511169Sandreas.hansson@arm.com int flags; 16610941Sdavid.guillen@arm.com bool isPipe; 16710941Sdavid.guillen@arm.com int readPipeSource; 16810941Sdavid.guillen@arm.com uint64_t fileOffset; 16910941Sdavid.guillen@arm.com 17010941Sdavid.guillen@arm.com 17110941Sdavid.guillen@arm.com FdMap() 17210941Sdavid.guillen@arm.com { 17310941Sdavid.guillen@arm.com fd = -1; 17410941Sdavid.guillen@arm.com filename = "NULL"; 17510941Sdavid.guillen@arm.com mode = 0; 17611169Sandreas.hansson@arm.com flags = 0; 17710941Sdavid.guillen@arm.com isPipe = false; 17810941Sdavid.guillen@arm.com readPipeSource = 0; 17910263Satgutier@umich.edu fileOffset = 0; 18010263Satgutier@umich.edu 18110263Satgutier@umich.edu } 18211169Sandreas.hansson@arm.com 18310263Satgutier@umich.edu void serialize(std::ostream &os); 18410263Satgutier@umich.edu void unserialize(Checkpoint *cp, const std::string §ion); 18510263Satgutier@umich.edu 18610263Satgutier@umich.edu }; 18710263Satgutier@umich.edu 18810263Satgutier@umich.edu private: 18910263Satgutier@umich.edu // file descriptor remapping support 19010263Satgutier@umich.edu static const int MAX_FD = 256; // max legal fd value 19110263Satgutier@umich.edu FdMap fd_map[MAX_FD+1]; 19210263Satgutier@umich.edu 19310263Satgutier@umich.edu 19410263Satgutier@umich.edu public: 19510263Satgutier@umich.edu // static helper functions to generate file descriptors for constructor 19610263Satgutier@umich.edu static int openInputFile(const std::string &filename); 19710263Satgutier@umich.edu static int openOutputFile(const std::string &filename); 19810263Satgutier@umich.edu 19910263Satgutier@umich.edu // override of virtual SimObject method: register statistics 20010263Satgutier@umich.edu virtual void regStats(); 20110263Satgutier@umich.edu 20210263Satgutier@umich.edu // After getting registered with system object, tell process which 20310263Satgutier@umich.edu // system-wide context id it is assigned. 20410263Satgutier@umich.edu void assignThreadContext(int context_id) 20510815Sdavid.guillen@arm.com { 20611169Sandreas.hansson@arm.com contextIds.push_back(context_id); 20710263Satgutier@umich.edu } 20810263Satgutier@umich.edu 20910263Satgutier@umich.edu // Find a free context to use 21010263Satgutier@umich.edu ThreadContext * findFreeContext(); 21110693SMarco.Balboni@ARM.com 21210263Satgutier@umich.edu // map simulator fd sim_fd to target fd tgt_fd 21310263Satgutier@umich.edu void dup_fd(int sim_fd, int tgt_fd); 21410263Satgutier@umich.edu 21510263Satgutier@umich.edu // generate new target fd for sim_fd 21610941Sdavid.guillen@arm.com int alloc_fd(int sim_fd, std::string filename, int flags, int mode, bool pipe); 21710263Satgutier@umich.edu 21810263Satgutier@umich.edu // free target fd (e.g., after close) 21910263Satgutier@umich.edu void free_fd(int tgt_fd); 22010263Satgutier@umich.edu 22110263Satgutier@umich.edu // look up simulator fd for given target fd 22210941Sdavid.guillen@arm.com int sim_fd(int tgt_fd); 22310263Satgutier@umich.edu 22410263Satgutier@umich.edu // look up simulator fd_map object for a given target fd 22510263Satgutier@umich.edu FdMap * sim_fd_obj(int tgt_fd); 22610263Satgutier@umich.edu 22710263Satgutier@umich.edu // fix all offsets for currently open files and save them 22810693SMarco.Balboni@ARM.com void fix_file_offsets(); 22910263Satgutier@umich.edu 23010263Satgutier@umich.edu // find all offsets for currently open files and save them 23110263Satgutier@umich.edu void find_file_offsets(); 23210263Satgutier@umich.edu 23310263Satgutier@umich.edu // set the source of this read pipe for a checkpoint resume 23410263Satgutier@umich.edu void setReadPipeSource(int read_pipe_fd, int source_fd); 23510263Satgutier@umich.edu 23610263Satgutier@umich.edu virtual void syscall(int64_t callnum, ThreadContext *tc) = 0; 23710263Satgutier@umich.edu 23810263Satgutier@umich.edu // check if the this addr is on the next available page and allocate it 23910263Satgutier@umich.edu // if it's not we'll panic 24010263Satgutier@umich.edu bool checkAndAllocNextPage(Addr vaddr); 24110263Satgutier@umich.edu 24210263Satgutier@umich.edu void serialize(std::ostream &os); 24310263Satgutier@umich.edu void unserialize(Checkpoint *cp, const std::string §ion); 24410263Satgutier@umich.edu}; 24511169Sandreas.hansson@arm.com 24610263Satgutier@umich.edu// 24710263Satgutier@umich.edu// "Live" process with system calls redirected to host system 24810263Satgutier@umich.edu// 24910263Satgutier@umich.educlass ObjectFile; 25010263Satgutier@umich.educlass LiveProcess : public Process 25110263Satgutier@umich.edu{ 25210263Satgutier@umich.edu protected: 25310263Satgutier@umich.edu ObjectFile *objFile; 25411169Sandreas.hansson@arm.com std::vector<std::string> argv; 25510263Satgutier@umich.edu std::vector<std::string> envp; 25610263Satgutier@umich.edu std::string cwd; 25710263Satgutier@umich.edu 25810263Satgutier@umich.edu LiveProcess(LiveProcessParams * params, ObjectFile *objFile); 25910263Satgutier@umich.edu 26010941Sdavid.guillen@arm.com virtual void argsInit(int intSize, int pageSize); 26110263Satgutier@umich.edu 26210941Sdavid.guillen@arm.com // Id of the owner of the process 26310263Satgutier@umich.edu uint64_t __uid; 26410263Satgutier@umich.edu uint64_t __euid; 26510263Satgutier@umich.edu uint64_t __gid; 26610263Satgutier@umich.edu uint64_t __egid; 26710263Satgutier@umich.edu 26810263Satgutier@umich.edu // pid of the process and it's parent 26910263Satgutier@umich.edu uint64_t __pid; 27010263Satgutier@umich.edu uint64_t __ppid; 27110263Satgutier@umich.edu 27210263Satgutier@umich.edu public: 27310263Satgutier@umich.edu 27411169Sandreas.hansson@arm.com enum AuxiliaryVectorType { 27510263Satgutier@umich.edu M5_AT_NULL = 0, 27610263Satgutier@umich.edu M5_AT_IGNORE = 1, 27710263Satgutier@umich.edu M5_AT_EXECFD = 2, 27810263Satgutier@umich.edu M5_AT_PHDR = 3, 27910274Smitch.hayenga@arm.com M5_AT_PHENT = 4, 28010263Satgutier@umich.edu M5_AT_PHNUM = 5, 28110263Satgutier@umich.edu M5_AT_PAGESZ = 6, 28210263Satgutier@umich.edu M5_AT_BASE = 7, 28310263Satgutier@umich.edu M5_AT_FLAGS = 8, 28410263Satgutier@umich.edu M5_AT_ENTRY = 9, 28510263Satgutier@umich.edu M5_AT_NOTELF = 10, 28610263Satgutier@umich.edu M5_AT_UID = 11, 28710263Satgutier@umich.edu M5_AT_EUID = 12, 28810263Satgutier@umich.edu M5_AT_GID = 13, 28910263Satgutier@umich.edu M5_AT_EGID = 14, 29010263Satgutier@umich.edu // The following may be specific to Linux 29110263Satgutier@umich.edu M5_AT_PLATFORM = 15, 29210263Satgutier@umich.edu M5_AT_HWCAP = 16, 29310263Satgutier@umich.edu M5_AT_CLKTCK = 17, 29410263Satgutier@umich.edu 29510263Satgutier@umich.edu M5_AT_SECURE = 23, 29610263Satgutier@umich.edu M5_BASE_PLATFORM = 24, 29710263Satgutier@umich.edu M5_AT_RANDOM = 25, 29810263Satgutier@umich.edu 29910263Satgutier@umich.edu M5_AT_EXECFN = 31, 30010263Satgutier@umich.edu 30110263Satgutier@umich.edu M5_AT_VECTOR_SIZE = 44 30210263Satgutier@umich.edu }; 30310263Satgutier@umich.edu 30410263Satgutier@umich.edu inline uint64_t uid() {return __uid;} 30510263Satgutier@umich.edu inline uint64_t euid() {return __euid;} 30610263Satgutier@umich.edu inline uint64_t gid() {return __gid;} 30710274Smitch.hayenga@arm.com inline uint64_t egid() {return __egid;} 30810263Satgutier@umich.edu inline uint64_t pid() {return __pid;} 30910263Satgutier@umich.edu inline uint64_t ppid() {return __ppid;} 31010263Satgutier@umich.edu 31110263Satgutier@umich.edu std::string 31210263Satgutier@umich.edu fullPath(const std::string &filename) 31310263Satgutier@umich.edu { 31410263Satgutier@umich.edu if (filename[0] == '/' || cwd.empty()) 31510263Satgutier@umich.edu return filename; 31610263Satgutier@umich.edu 31710263Satgutier@umich.edu std::string full = cwd; 31810263Satgutier@umich.edu 31910263Satgutier@umich.edu if (cwd[cwd.size() - 1] != '/') 32010263Satgutier@umich.edu full += '/'; 32110263Satgutier@umich.edu 32210263Satgutier@umich.edu return full + filename; 32310263Satgutier@umich.edu } 32410941Sdavid.guillen@arm.com 32510941Sdavid.guillen@arm.com std::string getcwd() const { return cwd; } 32610941Sdavid.guillen@arm.com 32711169Sandreas.hansson@arm.com virtual void syscall(int64_t callnum, ThreadContext *tc); 32810941Sdavid.guillen@arm.com 32910941Sdavid.guillen@arm.com virtual TheISA::IntReg getSyscallArg(ThreadContext *tc, int &i) = 0; 33010941Sdavid.guillen@arm.com virtual TheISA::IntReg getSyscallArg(ThreadContext *tc, int &i, int width); 33110941Sdavid.guillen@arm.com virtual void setSyscallArg(ThreadContext *tc, 33210941Sdavid.guillen@arm.com int i, TheISA::IntReg val) = 0; 33310941Sdavid.guillen@arm.com virtual void setSyscallReturn(ThreadContext *tc, 33410941Sdavid.guillen@arm.com SyscallReturn return_value) = 0; 33510941Sdavid.guillen@arm.com 33610941Sdavid.guillen@arm.com virtual SyscallDesc* getDesc(int callnum) = 0; 33711169Sandreas.hansson@arm.com 33810941Sdavid.guillen@arm.com // this function is used to create the LiveProcess object, since 33910941Sdavid.guillen@arm.com // we can't tell which subclass of LiveProcess to use until we 34010941Sdavid.guillen@arm.com // open and look at the object file. 34110941Sdavid.guillen@arm.com static LiveProcess *create(LiveProcessParams * params); 34210941Sdavid.guillen@arm.com}; 34310263Satgutier@umich.edu 34410263Satgutier@umich.edu 34510263Satgutier@umich.edu#endif // !FULL_SYSTEM 34610263Satgutier@umich.edu 34711169Sandreas.hansson@arm.com#endif // __PROCESS_HH__ 34810263Satgutier@umich.edu