tests: arch-power: Add 64-bit hello binaries
[gem5.git] / src / sim / process.hh
index a1ca84bf555d8e47956786b1ef05ea24d4db4fd8..c9e6a8b752593facd60877ae859d3c40d8b9b27b 100644 (file)
  * 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
- *          Brandon Potter
  */
 
 #ifndef __PROCESS_HH__
 #include <inttypes.h>
 
 #include <map>
+#include <memory>
 #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 "sim/mem_state.hh"
 #include "sim/sim_object.hh"
 
+namespace Loader
+{
+class ObjectFile;
+} // namespace Loader
+
 struct ProcessParams;
 
 class EmulatedDriver;
-class ObjectFile;
 class EmulationPageTable;
 class SyscallDesc;
 class SyscallReturn;
@@ -63,22 +65,17 @@ class ThreadContext;
 class Process : public SimObject
 {
   public:
-    Process(ProcessParams *params, EmulationPageTable *pTable,
-            ObjectFile *obj_file);
+    Process(const ProcessParams &params, 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(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;
+    virtual void syscall(ThreadContext *tc) { numSyscalls++; }
 
     inline uint64_t uid() { return _uid; }
     inline uint64_t euid() { return _euid; }
@@ -87,12 +84,10 @@ class Process : public SimObject
     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; }
-    inline void setpgid(uint64_t pgid) { _pgid = pgid; }
 
     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.
@@ -108,16 +103,13 @@ class Process : public SimObject
     void updateBias();
     Addr getBias();
     Addr getStartPC();
-    ObjectFile *getInterpreter();
-
-    // override of virtual SimObject method: register statistics
-    void regStats() override;
+    ::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 fixupStackFault(Addr vaddr);
+    bool fixupFault(Addr vaddr);
 
     // After getting registered with system object, tell process which
     // system-wide context id it is assigned.
@@ -127,9 +119,6 @@ class Process : public SimObject
         contextIds.push_back(context_id);
     }
 
-    // Find a free context to use
-    ThreadContext *findFreeContext();
-
     /**
      * After delegating a thread context to a child process
      * no longer should relate to the ThreadContext
@@ -170,8 +159,6 @@ class Process : public SimObject
     // system object which owns this process
     System *system;
 
-    Stats::Scalar numSyscalls;  // track how many system calls are executed
-
     // flag for using architecture specific page table
     bool useArchPT;
     // running KVM requires special initialization
@@ -181,14 +168,91 @@ class Process : public SimObject
 
     EmulationPageTable *pTable;
 
-    SETranslatingPortProxy initVirtMem; // memory proxy for initial image load
+    // Memory proxy for initial image load.
+    std::unique_ptr<SETranslatingPortProxy> initVirtMem;
 
-    ObjectFile *objFile;
+    /**
+     * 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(const ProcessParams &params,
+                              ::Loader::ObjectFile *obj_file) = 0;
+    };
+
+    // 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 &params,
+                               ::Loader::ObjectFile *obj_file);
+
+    ::Loader::ObjectFile *objFile;
+    ::Loader::MemoryImage image;
+    ::Loader::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;
@@ -217,6 +281,8 @@ class Process : public SimObject
 
     // Process was forked with SIGCHLD set.
     bool *sigchld;
+
+    Stats::Scalar numSyscalls;  // track how many system calls are executed
 };
 
 #endif // __PROCESS_HH__