/*
- * Copyright (c) 2014 Advanced Micro Devices, Inc.
+ * Copyright (c) 2014-2016 Advanced Micro Devices, Inc.
* Copyright (c) 2001-2005 The Regents of The University of Michigan
* All rights reserved.
*
*
* Authors: Nathan Binkert
* Steve Reinhardt
+ * Brandon Potter
*/
#ifndef __PROCESS_HH__
#include <inttypes.h>
-#include <array>
#include <map>
#include <string>
#include <vector>
#include "arch/registers.hh"
+#include "base/loader/memory_image.hh"
#include "base/statistics.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"
struct ProcessParams;
class EmulatedDriver;
class ObjectFile;
-class PageTableBase;
+class EmulationPageTable;
class SyscallDesc;
class SyscallReturn;
class System;
class Process : public SimObject
{
public:
- struct WaitRec
- {
- Addr waitChan;
- ThreadContext *waitingContext;
-
- WaitRec(Addr chan, ThreadContext *ctx)
- : waitChan(chan), waitingContext(ctx)
- { }
- };
-
- Process(ProcessParams *params, ObjectFile *obj_file);
+ Process(ProcessParams *params, EmulationPageTable *pTable,
+ ObjectFile *obj_file);
void serialize(CheckpointOut &cp) const override;
void unserialize(CheckpointIn &cp) override;
+ void init() override;
void initState() override;
DrainState drain() override;
- void syscall(int64_t callnum, ThreadContext *tc);
- virtual TheISA::IntReg getSyscallArg(ThreadContext *tc, int &i) = 0;
- virtual TheISA::IntReg getSyscallArg(ThreadContext *tc, int &i, int width);
- virtual void setSyscallArg(ThreadContext *tc, int i,
- TheISA::IntReg val) = 0;
+ virtual void syscall(int64_t callnum, ThreadContext *tc, Fault *fault);
+ virtual RegVal getSyscallArg(ThreadContext *tc, int &i) = 0;
+ virtual RegVal getSyscallArg(ThreadContext *tc, int &i, int width);
+ virtual void setSyscallArg(ThreadContext *tc, int i, RegVal val) = 0;
virtual void setSyscallReturn(ThreadContext *tc,
SyscallReturn return_value) = 0;
virtual SyscallDesc *getDesc(int callnum) = 0;
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(); }
- std::string fullPath(const std::string &filename);
- std::string getcwd() const { return cwd; }
/**
* Find an emulated device driver.
*
* @param filename Name of the device (under /dev)
- * @return Pointer to driver object if found, else NULL
+ * @return Pointer to driver object if found, else nullptr
*/
EmulatedDriver *findDriver(std::string filename);
Addr getStartPC();
ObjectFile *getInterpreter();
- // inherit file descriptor map from another process (necessary for clone)
- void inheritFDArray(Process *p);
-
// override of virtual SimObject method: register statistics
void regStats() override;
- // generate new target fd for sim_fd
- int allocFD(int sim_fd, const std::string& filename, int flags, int mode,
- bool pipe);
-
- // disassociate target fd with simulator fd and cleanup subsidiary fields
- void resetFDEntry(int tgt_fd);
-
- // look up simulator fd for given target fd
- int getSimFD(int tgt_fd);
-
- // look up fd entry for a given target fd
- FDEntry *getFDEntry(int tgt_fd);
-
- // look up target fd for given host fd
- // Assumes a 1:1 mapping between target file descriptor and host file
- // descriptor. Given the current API, this must be true given that it's
- // not possible to map multiple target file descriptors to the same host
- // file descriptor
- int getTgtFD(int sim_fd);
-
- // fix all offsets for currently open files and save them
- void fixFileOffsets();
-
- // find all offsets for currently open files and save them
- void findFileOffsets();
-
- // set the source of this read pipe for a checkpoint resume
- void setReadPipeSource(int read_pipe_fd, int source_fd);
-
-
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.
ThreadContext *findFreeContext();
/**
- * Does mmap region grow upward or downward from mmap_end? Most
+ * 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.
*/
*/
bool map(Addr vaddr, Addr paddr, int size, bool cacheable = true);
- // list of all blocked contexts
- std::list<WaitRec> waitList;
+ 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<ContextID> contextIds;
// system object which owns this process
System *system;
- Addr brk_point; // top of the data segment
- Addr stack_base; // stack segment base
- unsigned stack_size; // initial stack size
- Addr stack_min; // furthest address accessed from stack base
- Addr max_stack_size; // the maximum size allowed for the stack
- Addr next_thread_stack_base; // addr for next region w/ multithreaded apps
- Addr mmap_end; // base of automatic mmap region allocs
-
- Stats::Scalar num_syscalls; // track how many system calls are executed
+ Stats::Scalar numSyscalls; // track how many system calls are executed
- bool useArchPT; // flag for using architecture specific page table
- bool kvmInSE; // running KVM requires special initialization
+ // 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;
- PageTableBase* pTable;
+ EmulationPageTable *pTable;
SETranslatingPortProxy initVirtMem; // memory proxy for initial image load
- static const int NUM_FDS = 1024;
-
- // File descriptor remapping support.
- std::shared_ptr<std::array<FDEntry, NUM_FDS>> fd_array;
+ /**
+ * 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
+ {
+ 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(ProcessParams *params, ObjectFile *obj_file) = 0;
+ };
- // Standard file descriptor options for initialization and checkpoints.
- std::map<std::string, int> imap;
- std::map<std::string, int> oemap;
+ // Try all the Loader instance's "load" methods one by one until one is
+ // successful. If none are, complain and fail.
+ static Process *tryLoaders(ProcessParams *params, ObjectFile *obj_file);
ObjectFile *objFile;
+ MemoryImage image;
+ MemoryImage interpImage;
std::vector<std::string> argv;
std::vector<std::string> envp;
- std::string cwd;
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;
// pid of the process and it's parent
uint64_t _pid;
uint64_t _ppid;
+ uint64_t _pgid;
+ uint64_t _tgid;
// Emulated drivers available to this process
std::vector<EmulatedDriver *> drivers;
+
+ std::shared_ptr<FDArray> fds;
+
+ bool *exitGroup;
+ std::shared_ptr<MemState> memState;
+
+ /**
+ * Calls a futex wakeup at the address specified by this pointer when
+ * this process exits.
+ */
+ uint64_t childClearTID;
+
+ // Process was forked with SIGCHLD set.
+ bool *sigchld;
};
#endif // __PROCESS_HH__