misc: Rename misc.(hh|cc) to logging.(hh|cc)
[gem5.git] / src / arch / mips / process.cc
index 13d8ac3a8b38a4fca5f8edde597bf8325586ed09..4d0d5e309cdeba1c244dc2dcd3b7a857ea958780 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2003-2004 The Regents of The University of Michigan
+ * Copyright (c) 2004-2005 The Regents of The University of Michigan
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  *
  * Authors: Gabe Black
  *          Ali Saidi
+ *          Korey Sewell
  */
 
-#include "arch/mips/isa_traits.hh"
 #include "arch/mips/process.hh"
-#include "arch/mips/linux/process.hh"
+
+#include "arch/mips/isa_traits.hh"
+#include "base/loader/elf_object.hh"
 #include "base/loader/object_file.hh"
-#include "base/misc.hh"
-#include "cpu/exec_context.hh"
-#include "sim/builder.hh"
+#include "base/logging.hh"
+#include "cpu/thread_context.hh"
+#include "debug/Loader.hh"
+#include "mem/page_table.hh"
+#include "sim/aux_vector.hh"
+#include "sim/process.hh"
+#include "sim/process_impl.hh"
+#include "sim/syscall_return.hh"
 #include "sim/system.hh"
 
 using namespace std;
 using namespace MipsISA;
 
-
-MipsLiveProcess *
-MipsLiveProcess::create(const std::string &nm, System *system, int stdin_fd,
-        int stdout_fd, int stderr_fd, std::string executable,
-        std::vector<std::string> &argv, std::vector<std::string> &envp)
+MipsProcess::MipsProcess(ProcessParams * params, ObjectFile *objFile)
+    : Process(params, objFile)
 {
-    MipsLiveProcess *process = NULL;
+    // Set up stack. On MIPS, stack starts at the top of kuseg
+    // user address space. MIPS stack grows down from here
+    Addr stack_base = 0x7FFFFFFF;
 
-    ObjectFile *objFile = createObjectFile(executable);
-    if (objFile == NULL) {
-        fatal("Can't load object file %s", executable);
-    }
+    Addr max_stack_size = 8 * 1024 * 1024;
 
+    // Set pointer for next thread stack.  Reserve 8M for main stack.
+    Addr next_thread_stack_base = stack_base - max_stack_size;
 
-    if (objFile->getArch() != ObjectFile::Mips)
-        fatal("Object file does not match architecture.");
-    switch (objFile->getOpSys()) {
-      case ObjectFile::Linux:
-        process = new MipsLinuxProcess(nm, objFile, system,
-                                        stdin_fd, stdout_fd, stderr_fd,
-                                        argv, envp);
-        break;
+    // Set up break point (Top of Heap)
+    Addr brk_point = objFile->dataBase() + objFile->dataSize() +
+                     objFile->bssSize();
+    brk_point = roundUp(brk_point, PageBytes);
 
-      default:
-        fatal("Unknown/unsupported operating system.");
-    }
+    // Set up region for mmaps.  Start it 1GB above the top of the heap.
+    Addr mmap_end = brk_point + 0x40000000L;
 
-    if (process == NULL)
-        fatal("Unknown error creating process object.");
-    return process;
+    memState = make_shared<MemState>(brk_point, stack_base, max_stack_size,
+                                     next_thread_stack_base, mmap_end);
 }
 
-MipsLiveProcess::MipsLiveProcess(const std::string &nm, ObjectFile *objFile,
-        System *_system, int stdin_fd, int stdout_fd, int stderr_fd,
-        std::vector<std::string> &argv, std::vector<std::string> &envp)
-    : LiveProcess(nm, objFile, _system, stdin_fd, stdout_fd, stderr_fd,
-        argv, envp)
+void
+MipsProcess::initState()
 {
+    Process::initState();
 
-    // XXX all the below need to be updated for SPARC - Ali
-    brk_point = objFile->dataBase() + objFile->dataSize() + objFile->bssSize();
-    brk_point = roundUp(brk_point, VMPageSize);
-
-    // Set up stack.  On Alpha, stack goes below text section.  This
-    // code should get moved to some architecture-specific spot.
-    stack_base = objFile->textBase() - (409600+4096);
-
-    // Set up region for mmaps.  Tru64 seems to start just above 0 and
-    // grow up from there.
-    mmap_start = mmap_end = 0x10000;
-
-    // Set pointer for next thread stack.  Reserve 8M for main stack.
-    next_thread_stack_base = stack_base - (8 * 1024 * 1024);
-
+    argsInit<uint32_t>(PageBytes);
 }
 
+template<class IntType>
 void
-MipsLiveProcess::startup()
+MipsProcess::argsInit(int pageSize)
 {
-    argsInit(MachineBytes, VMPageSize);
-}
-
-
-
+    int intSize = sizeof(IntType);
+
+    // Patch the ld_bias for dynamic executables.
+    updateBias();
+
+    // load object file into target memory
+    objFile->loadSections(initVirtMem);
+
+    typedef AuxVector<IntType> auxv_t;
+    std::vector<auxv_t> auxv;
+
+    ElfObject * elfObject = dynamic_cast<ElfObject *>(objFile);
+    if (elfObject)
+    {
+        // Set the system page size
+        auxv.push_back(auxv_t(M5_AT_PAGESZ, MipsISA::PageBytes));
+        // Set the frequency at which time() increments
+        auxv.push_back(auxv_t(M5_AT_CLKTCK, 100));
+        // For statically linked executables, this is the virtual
+        // address of the program header tables if they appear in the
+        // executable image.
+        auxv.push_back(auxv_t(M5_AT_PHDR, elfObject->programHeaderTable()));
+        DPRINTF(Loader, "auxv at PHDR %08p\n", elfObject->programHeaderTable());
+        // This is the size of a program header entry from the elf file.
+        auxv.push_back(auxv_t(M5_AT_PHENT, elfObject->programHeaderSize()));
+        // This is the number of program headers from the original elf file.
+        auxv.push_back(auxv_t(M5_AT_PHNUM, elfObject->programHeaderCount()));
+        // This is the base address of the ELF interpreter; it should be
+        // zero for static executables or contain the base address for
+        // dynamic executables.
+        auxv.push_back(auxv_t(M5_AT_BASE, getBias()));
+        //The entry point to the program
+        auxv.push_back(auxv_t(M5_AT_ENTRY, objFile->entryPoint()));
+        //Different user and group IDs
+        auxv.push_back(auxv_t(M5_AT_UID, uid()));
+        auxv.push_back(auxv_t(M5_AT_EUID, euid()));
+        auxv.push_back(auxv_t(M5_AT_GID, gid()));
+        auxv.push_back(auxv_t(M5_AT_EGID, egid()));
+    }
 
-BEGIN_DECLARE_SIM_OBJECT_PARAMS(MipsLiveProcess)
+    // Calculate how much space we need for arg & env & auxv arrays.
+    int argv_array_size = intSize * (argv.size() + 1);
+    int envp_array_size = intSize * (envp.size() + 1);
+    int auxv_array_size = intSize * 2 * (auxv.size() + 1);
 
-    VectorParam<string> cmd;
-    Param<string> executable;
-    Param<string> input;
-    Param<string> output;
-    VectorParam<string> env;
-    SimObjectParam<System *> system;
+    int arg_data_size = 0;
+    for (vector<string>::size_type i = 0; i < argv.size(); ++i) {
+        arg_data_size += argv[i].size() + 1;
+    }
+    int env_data_size = 0;
+    for (vector<string>::size_type i = 0; i < envp.size(); ++i) {
+        env_data_size += envp[i].size() + 1;
+    }
 
-END_DECLARE_SIM_OBJECT_PARAMS(MipsLiveProcess)
+    int space_needed =
+        argv_array_size +
+        envp_array_size +
+        auxv_array_size +
+        arg_data_size +
+        env_data_size;
+
+    // set bottom of stack
+    memState->setStackMin(memState->getStackBase() - space_needed);
+    // align it
+    memState->setStackMin(roundDown(memState->getStackMin(), pageSize));
+    memState->setStackSize(memState->getStackBase() - memState->getStackMin());
+    // map memory
+    allocateMem(memState->getStackMin(), roundUp(memState->getStackSize(),
+                pageSize));
+
+    // map out initial stack contents; leave room for argc
+    IntType argv_array_base = memState->getStackMin() + intSize;
+    IntType envp_array_base = argv_array_base + argv_array_size;
+    IntType auxv_array_base = envp_array_base + envp_array_size;
+    IntType arg_data_base = auxv_array_base + auxv_array_size;
+    IntType env_data_base = arg_data_base + arg_data_size;
+
+    // write contents to stack
+    IntType argc = argv.size();
+
+    argc = htog((IntType)argc);
+
+    initVirtMem.writeBlob(memState->getStackMin(), (uint8_t*)&argc, intSize);
+
+    copyStringArray(argv, argv_array_base, arg_data_base, initVirtMem);
+
+    copyStringArray(envp, envp_array_base, env_data_base, initVirtMem);
+
+    // Copy the aux vector
+    for (typename vector<auxv_t>::size_type x = 0; x < auxv.size(); x++) {
+        initVirtMem.writeBlob(auxv_array_base + x * 2 * intSize,
+                (uint8_t*)&(auxv[x].a_type), intSize);
+        initVirtMem.writeBlob(auxv_array_base + (x * 2 + 1) * intSize,
+                (uint8_t*)&(auxv[x].a_val), intSize);
+    }
 
+    // Write out the terminating zeroed auxilliary vector
+    for (unsigned i = 0; i < 2; i++) {
+        const IntType zero = 0;
+        const Addr addr = auxv_array_base + 2 * intSize * (auxv.size() + i);
+        initVirtMem.writeBlob(addr, (uint8_t*)&zero, intSize);
+    }
 
-BEGIN_INIT_SIM_OBJECT_PARAMS(MipsLiveProcess)
+    ThreadContext *tc = system->getThreadContext(contextIds[0]);
 
-    INIT_PARAM(cmd, "command line (executable plus arguments)"),
-    INIT_PARAM(executable, "executable (overrides cmd[0] if set)"),
-    INIT_PARAM(input, "filename for stdin (dflt: use sim stdin)"),
-    INIT_PARAM(output, "filename for stdout/stderr (dflt: use sim stdout)"),
-    INIT_PARAM(env, "environment settings"),
-    INIT_PARAM(system, "system")
+    setSyscallArg(tc, 0, argc);
+    setSyscallArg(tc, 1, argv_array_base);
+    tc->setIntReg(StackPointerReg, memState->getStackMin());
 
-END_INIT_SIM_OBJECT_PARAMS(MipsLiveProcess)
+    tc->pcState(getStartPC());
+}
 
 
-CREATE_SIM_OBJECT(MipsLiveProcess)
+MipsISA::IntReg
+MipsProcess::getSyscallArg(ThreadContext *tc, int &i)
 {
-    string in = input;
-    string out = output;
-
-    // initialize file descriptors to default: same as simulator
-    int stdin_fd, stdout_fd, stderr_fd;
-
-    if (in == "stdin" || in == "cin")
-        stdin_fd = STDIN_FILENO;
-    else
-        stdin_fd = Process::openInputFile(input);
-
-    if (out == "stdout" || out == "cout")
-        stdout_fd = STDOUT_FILENO;
-    else if (out == "stderr" || out == "cerr")
-        stdout_fd = STDERR_FILENO;
-    else
-        stdout_fd = Process::openOutputFile(out);
-
-    stderr_fd = (stdout_fd != STDOUT_FILENO) ? stdout_fd : STDERR_FILENO;
-
-    return MipsLiveProcess::create(getInstanceName(), system,
-                               stdin_fd, stdout_fd, stderr_fd,
-                               (string)executable == "" ? cmd[0] : executable,
-                               cmd, env);
+    assert(i < 6);
+    return tc->readIntReg(FirstArgumentReg + i++);
 }
 
+void
+MipsProcess::setSyscallArg(ThreadContext *tc, int i, MipsISA::IntReg val)
+{
+    assert(i < 6);
+    tc->setIntReg(FirstArgumentReg + i, val);
+}
 
-REGISTER_SIM_OBJECT("MipsLiveProcess", MipsLiveProcess)
-
-
+void
+MipsProcess::setSyscallReturn(ThreadContext *tc, SyscallReturn sysret)
+{
+    if (sysret.successful()) {
+        // no error
+        tc->setIntReg(SyscallSuccessReg, 0);
+        tc->setIntReg(ReturnValueReg, sysret.returnValue());
+    } else {
+        // got an error, return details
+        tc->setIntReg(SyscallSuccessReg, (IntReg) -1);
+        tc->setIntReg(ReturnValueReg, sysret.errnoValue());
+    }
+}