X-Git-Url: https://git.libre-soc.org/?a=blobdiff_plain;f=src%2Fsim%2Fprocess.hh;h=c9e6a8b752593facd60877ae859d3c40d8b9b27b;hb=refs%2Fheads%2Fdevelop-power;hp=fa46b9c952e2d466cd110a94afa03f3915e8adbc;hpb=6d199f0b25e2e8c46f626187bb6f5f06d7bcc55c;p=gem5.git diff --git a/src/sim/process.hh b/src/sim/process.hh index fa46b9c95..c9e6a8b75 100644 --- a/src/sim/process.hh +++ b/src/sim/process.hh @@ -1,4 +1,5 @@ /* + * Copyright (c) 2014-2016 Advanced Micro Devices, Inc. * Copyright (c) 2001-2005 The Regents of The University of Michigan * All rights reserved. * @@ -24,237 +25,264 @@ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - * - * Authors: Nathan Binkert - * Steve Reinhardt */ #ifndef __PROCESS_HH__ #define __PROCESS_HH__ -// -// The purpose of this code is to fake the loader & syscall mechanism -// when there's no OS: thus there's no reason to use it in FULL_SYSTEM -// mode when we do have an OS. -// -#include "config/full_system.hh" - -#if !FULL_SYSTEM +#include +#include +#include #include #include +#include "arch/registers.hh" +#include "base/loader/memory_image.hh" #include "base/statistics.hh" -#include "sim/host.hh" +#include "base/types.hh" +#include "config/the_isa.hh" +#include "mem/se_translating_port_proxy.hh" +#include "sim/fd_array.hh" +#include "sim/fd_entry.hh" +#include "sim/mem_state.hh" #include "sim/sim_object.hh" -class ThreadContext; +namespace Loader +{ +class ObjectFile; +} // namespace Loader + +struct ProcessParams; + +class EmulatedDriver; +class EmulationPageTable; class SyscallDesc; -class PageTable; -class TranslatingPort; +class SyscallReturn; class System; -class GDBListener; -namespace TheISA -{ - class RemoteGDB; -} +class ThreadContext; class Process : public SimObject { public: + Process(const ProcessParams ¶ms, EmulationPageTable *pTable, + ::Loader::ObjectFile *obj_file); + + void serialize(CheckpointOut &cp) const override; + void unserialize(CheckpointIn &cp) override; + + void init() override; + void initState() override; + DrainState drain() override; + + virtual void syscall(ThreadContext *tc) { numSyscalls++; } + + inline uint64_t uid() { return _uid; } + inline uint64_t euid() { return _euid; } + inline uint64_t gid() { return _gid; } + inline uint64_t egid() { return _egid; } + inline uint64_t pid() { return _pid; } + inline uint64_t ppid() { return _ppid; } + inline uint64_t pgid() { return _pgid; } + inline void pgid(uint64_t pgid) { _pgid = pgid; } + inline uint64_t tgid() { return _tgid; } + + const char *progName() const { return executable.c_str(); } + + /** + * Find an emulated device driver. + * + * @param filename Name of the device (under /dev) + * @return Pointer to driver object if found, else nullptr + */ + EmulatedDriver *findDriver(std::string filename); + + // This function acts as a callback to update the bias value in + // the object file because the parameters needed to calculate the + // bias are not available when the object file is created. + void updateBias(); + Addr getBias(); + Addr getStartPC(); + ::Loader::ObjectFile *getInterpreter(); + + void allocateMem(Addr vaddr, int64_t size, bool clobber = false); + + /// Attempt to fix up a fault at vaddr by allocating a page on the stack. + /// @return Whether the fault has been fixed. + bool fixupFault(Addr vaddr); + + // After getting registered with system object, tell process which + // system-wide context id it is assigned. + void + assignThreadContext(ContextID context_id) + { + contextIds.push_back(context_id); + } - /// Pointer to object representing the system this process is - /// running on. - System *system; - - // have we initialized a thread context from this process? If - // yes, subsequent contexts are assumed to be for dynamically - // created threads and are not initialized. - bool initialContextLoaded; + /** + * After delegating a thread context to a child process + * no longer should relate to the ThreadContext + */ + void revokeThreadContext(int context_id); + + /** + * Does mmap region grow upward or downward from mmapEnd? Most + * platforms grow downward, but a few (such as Alpha) grow upward + * instead, so they can override this method to return false. + */ + virtual bool mmapGrowsDown() const { return true; } + + /** + * Maps a contiguous range of virtual addresses in this process's + * address space to a contiguous range of physical addresses. + * This function exists primarily to expose the map operation to + * python, so that configuration scripts can set up mappings in SE mode. + * + * @param vaddr The starting virtual address of the range. + * @param paddr The starting physical address of the range. + * @param size The length of the range in bytes. + * @param cacheable Specifies whether accesses are cacheable. + * @return True if the map operation was successful. (At this + * point in time, the map operation always succeeds.) + */ + bool map(Addr vaddr, Addr paddr, int size, bool cacheable = true); + + void replicatePage(Addr vaddr, Addr new_paddr, ThreadContext *old_tc, + ThreadContext *new_tc, bool alloc_page); + + virtual void clone(ThreadContext *old_tc, ThreadContext *new_tc, + Process *new_p, RegVal flags); // thread contexts associated with this process - std::vector threadContexts; - - // remote gdb objects - std::vector remoteGDB; - std::vector gdbListen; - bool breakpoint(); + std::vector contextIds; - // number of CPUs (esxec contexts, really) assigned to this process. - unsigned int numCpus() { return threadContexts.size(); } + // system object which owns this process + System *system; - // record of blocked context - struct WaitRec + // flag for using architecture specific page table + bool useArchPT; + // running KVM requires special initialization + bool kvmInSE; + // flag for using the process as a thread which shares page tables + bool useForClone; + + EmulationPageTable *pTable; + + // Memory proxy for initial image load. + std::unique_ptr initVirtMem; + + /** + * Each instance of a Loader subclass will have a chance to try to load + * an object file when tryLoaders is called. If they can't because they + * aren't compatible with it (wrong arch, wrong OS, etc), then they + * silently fail by returning nullptr so other loaders can try. + */ + class Loader { - Addr waitChan; - ThreadContext *waitingContext; - - WaitRec(Addr chan, ThreadContext *ctx) - : waitChan(chan), waitingContext(ctx) - { } + public: + Loader(); + + /* Loader instances are singletons. */ + Loader(const Loader &) = delete; + void operator=(const Loader &) = delete; + + virtual ~Loader() {} + + /** + * Each subclass needs to implement this method. If the loader is + * compatible with the passed in object file, it should return the + * created Process object corresponding to it. If not, it should fail + * silently and return nullptr. If there's a non-compatibliity related + * error like file IO errors, etc., those should fail non-silently + * with a panic or fail as normal. + */ + virtual Process *load(const ProcessParams ¶ms, + ::Loader::ObjectFile *obj_file) = 0; }; - // list of all blocked contexts - std::list waitList; - - Addr brk_point; // top of the data segment - - Addr stack_base; // stack segment base (highest address) - unsigned stack_size; // initial stack size - Addr stack_min; // lowest address accessed on the stack - - // addr to use for next stack region (for multithreaded apps) - Addr next_thread_stack_base; - - // Base of region for mmaps (when user doesn't specify an address). - Addr mmap_start; - Addr mmap_end; - - // Base of region for nxm data - Addr nxm_start; - Addr nxm_end; - - std::string prog_fname; // file name - - Stats::Scalar<> num_syscalls; // number of syscalls executed - - - protected: - // constructor - Process(const std::string &nm, - System *_system, - int stdin_fd, // initial I/O descriptors - int stdout_fd, - int stderr_fd); - - // post initialization startup - virtual void startup(); - - protected: - /// Memory object for initialization (image loading) - TranslatingPort *initVirtMem; + // Try all the Loader instance's "load" methods one by one until one is + // successful. If none are, complain and fail. + static Process *tryLoaders(const ProcessParams ¶ms, + ::Loader::ObjectFile *obj_file); - public: - PageTable *pTable; - - private: - // file descriptor remapping support - static const int MAX_FD = 256; // max legal fd value - int fd_map[MAX_FD+1]; - - public: - // static helper functions to generate file descriptors for constructor - static int openInputFile(const std::string &filename); - static int openOutputFile(const std::string &filename); - - // override of virtual SimObject method: register statistics - virtual void regStats(); - - // register a thread context for this process. - // returns tc's cpu number (index into threadContexts[]) - int registerThreadContext(ThreadContext *tc); - - - void replaceThreadContext(ThreadContext *tc, int tcIndex); - - // map simulator fd sim_fd to target fd tgt_fd - void dup_fd(int sim_fd, int tgt_fd); - - // generate new target fd for sim_fd - int alloc_fd(int sim_fd); - - // free target fd (e.g., after close) - void free_fd(int tgt_fd); - - // look up simulator fd for given target fd - int sim_fd(int tgt_fd); - - virtual void syscall(int64_t callnum, ThreadContext *tc) = 0; - - // check if the this addr is on the next available page and allocate it - // if it's not we'll panic - bool checkAndAllocNextPage(Addr vaddr); - - void serialize(std::ostream &os); - void unserialize(Checkpoint *cp, const std::string §ion); -}; - -// -// "Live" process with system calls redirected to host system -// -class ObjectFile; -class LiveProcess : public Process -{ - protected: - ObjectFile *objFile; + ::Loader::ObjectFile *objFile; + ::Loader::MemoryImage image; + ::Loader::MemoryImage interpImage; std::vector argv; std::vector envp; - std::string cwd; - - LiveProcess(const std::string &nm, ObjectFile *objFile, - System *_system, int stdin_fd, int stdout_fd, int stderr_fd, - std::vector &argv, - std::vector &envp, - const std::string &cwd, - uint64_t _uid, uint64_t _euid, - uint64_t _gid, uint64_t _egid, - uint64_t _pid, uint64_t _ppid); - - virtual void argsInit(int intSize, int pageSize); + std::string executable; + + /** + * Return an absolute path given a relative path paired with the current + * working directory of the process running under simulation. + * + * @param path The relative path (generally a filename) that needs the + * current working directory prepended. + * @param host_fs A flag which determines whether to return a + * path for the host filesystem or the filesystem of the process running + * under simulation. Only matters if filesysem redirection is used to + * replace files (or directories) that would normally appear via the + * host filesystem. + * @return String containing an absolute path. + */ + std::string absolutePath(const std::string &path, bool host_fs); + + /** + * Redirect file path if it matches any keys initialized by system object. + * @param filename An input parameter containing either a relative path + * or an absolute path. If given a relative path, the path will be + * prepended to the current working directory of the simulation with + * respect to the host filesystem. + * @return String containing an absolute path. + */ + std::string checkPathRedirect(const std::string &filename); + + /** + * The cwd members are used to track changes to the current working + * directory for the purpose of executing system calls which depend on + * relative paths (i.e. open, chdir). + * + * The tgt member and host member may differ if the path for the current + * working directory is redirected to point to a different location + * (i.e. `cd /proc` should point to '$(gem5_repo)/m5out/fs/proc' + * instead of '/proc'). + */ + std::string tgtCwd; + std::string hostCwd; + + // Syscall emulation uname release. + std::string release; // Id of the owner of the process - uint64_t __uid; - uint64_t __euid; - uint64_t __gid; - uint64_t __egid; + uint64_t _uid; + uint64_t _euid; + uint64_t _gid; + uint64_t _egid; // pid of the process and it's parent - uint64_t __pid; - uint64_t __ppid; + uint64_t _pid; + uint64_t _ppid; + uint64_t _pgid; + uint64_t _tgid; - public: - - inline uint64_t uid() {return __uid;} - inline uint64_t euid() {return __euid;} - inline uint64_t gid() {return __gid;} - inline uint64_t egid() {return __egid;} - inline uint64_t pid() {return __pid;} - inline uint64_t ppid() {return __ppid;} + // Emulated drivers available to this process + std::vector drivers; - std::string - fullPath(const std::string &filename) - { - if (filename[0] == '/' || cwd.empty()) - return filename; + std::shared_ptr fds; - std::string full = cwd; + bool *exitGroup; + std::shared_ptr memState; - if (cwd[cwd.size() - 1] != '/') - full += '/'; + /** + * Calls a futex wakeup at the address specified by this pointer when + * this process exits. + */ + uint64_t childClearTID; - return full + filename; - } + // Process was forked with SIGCHLD set. + bool *sigchld; - virtual void syscall(int64_t callnum, ThreadContext *tc); - - virtual SyscallDesc* getDesc(int callnum) = 0; - - // this function is used to create the LiveProcess object, since - // we can't tell which subclass of LiveProcess to use until we - // open and look at the object file. - static LiveProcess *create(const std::string &nm, - System *_system, - int stdin_fd, int stdout_fd, int stderr_fd, - std::string executable, - std::vector &argv, - std::vector &envp, - const std::string &cwd, - uint64_t _uid, uint64_t _euid, - uint64_t _gid, uint64_t _egid, - uint64_t _pid, uint64_t _ppid); + Stats::Scalar numSyscalls; // track how many system calls are executed }; - -#endif // !FULL_SYSTEM - #endif // __PROCESS_HH__