sim/process.cc

   1 /*
   2  * Copyright (c) 2001-2005 The Regents of The University of Michigan
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met: redistributions of source code must retain the above copyright
   8  * notice, this list of conditions and the following disclaimer;
   9  * redistributions in binary form must reproduce the above copyright
  10  * notice, this list of conditions and the following disclaimer in the
  11  * documentation and/or other materials provided with the distribution;
  12  * neither the name of the copyright holders nor the names of its
  13  * contributors may be used to endorse or promote products derived from
  14  * this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #include <unistd.h>
  30 #include <fcntl.h>
  31
  32 #include <cstdio>
  33 #include <string>
  34
  35 #include "base/intmath.hh"
  36 #include "base/loader/object_file.hh"
  37 #include "base/loader/symtab.hh"
  38 #include "base/statistics.hh"
  39 #include "config/full_system.hh"
  40 #include "cpu/exec_context.hh"
  41 #include "cpu/smt.hh"
  42 #include "encumbered/cpu/full/thread.hh"
  43 #include "encumbered/eio/eio.hh"
  44 #include "encumbered/mem/functional/main.hh"
  45 #include "sim/builder.hh"
  46 #include "sim/fake_syscall.hh"
  47 #include "sim/process.hh"
  48 #include "sim/stats.hh"
  49
  50 #ifdef TARGET_ALPHA
  51 #include "arch/alpha/alpha_tru64_process.hh"
  52 #include "arch/alpha/alpha_linux_process.hh"
  53 #endif
  54
  55 using namespace std;
  56
  57 //
  58 // The purpose of this code is to fake the loader & syscall mechanism
  59 // when there's no OS: thus there's no resone to use it in FULL_SYSTEM
  60 // mode when we do have an OS
  61 //
  62 #if FULL_SYSTEM
  63 #error "process.cc not compatible with FULL_SYSTEM"
  64 #endif
  65
  66 // current number of allocated processes
  67 int num_processes = 0;
  68
  69 Process::Process(const string &nm,
  70                  int stdin_fd,  // initial I/O descriptors
  71                  int stdout_fd,
  72                  int stderr_fd)
  73     : SimObject(nm)
  74 {
  75     // allocate memory space
  76     memory = new MainMemory(nm + ".MainMem");
  77
  78     // allocate initial register file
  79     init_regs = new RegFile;
  80     memset(init_regs, 0, sizeof(RegFile));
  81
  82     // initialize first 3 fds (stdin, stdout, stderr)
  83     fd_map[STDIN_FILENO] = stdin_fd;
  84     fd_map[STDOUT_FILENO] = stdout_fd;
  85     fd_map[STDERR_FILENO] = stderr_fd;
  86
  87     // mark remaining fds as free
  88     for (int i = 3; i <= MAX_FD; ++i) {
  89         fd_map[i] = -1;
  90     }
  91
  92     mmap_start = mmap_end = 0;
  93     nxm_start = nxm_end = 0;
  94     // other parameters will be initialized when the program is loaded
  95 }
  96
  97 void
  98 Process::regStats()
  99 {
 100     using namespace Stats;
 101
 102     num_syscalls
 103         .name(name() + ".PROG:num_syscalls")
 104         .desc("Number of system calls")
 105         ;
 106 }
 107
 108 //
 109 // static helper functions
 110 //
 111 int
 112 Process::openInputFile(const string &filename)
 113 {
 114     int fd = open(filename.c_str(), O_RDONLY);
 115
 116     if (fd == -1) {
 117         perror(NULL);
 118         cerr << "unable to open \"" << filename << "\" for reading\n";
 119         fatal("can't open input file");
 120     }
 121
 122     return fd;
 123 }
 124
 125
 126 int
 127 Process::openOutputFile(const string &filename)
 128 {
 129     int fd = open(filename.c_str(), O_WRONLY | O_CREAT | O_TRUNC, 0774);
 130
 131     if (fd == -1) {
 132         perror(NULL);
 133         cerr << "unable to open \"" << filename << "\" for writing\n";
 134         fatal("can't open output file");
 135     }
 136
 137     return fd;
 138 }
 139
 140
 141 int
 142 Process::registerExecContext(ExecContext *xc)
 143 {
 144     // add to list
 145     int myIndex = execContexts.size();
 146     execContexts.push_back(xc);
 147
 148     if (myIndex == 0) {
 149         // copy process's initial regs struct
 150         xc->regs = *init_regs;
 151     }
 152
 153     // return CPU number to caller and increment available CPU count
 154     return myIndex;
 155 }
 156
 157 void
 158 Process::startup()
 159 {
 160     if (execContexts.empty())
 161         return;
 162
 163     // first exec context for this process... initialize & enable
 164     ExecContext *xc = execContexts[0];
 165
 166     // mark this context as active so it will start ticking.
 167     xc->activate(0);
 168 }
 169
 170 void
 171 Process::replaceExecContext(ExecContext *xc, int xcIndex)
 172 {
 173     if (xcIndex >= execContexts.size()) {
 174         panic("replaceExecContext: bad xcIndex, %d >= %d\n",
 175               xcIndex, execContexts.size());
 176     }
 177
 178     execContexts[xcIndex] = xc;
 179 }
 180
 181 // map simulator fd sim_fd to target fd tgt_fd
 182 void
 183 Process::dup_fd(int sim_fd, int tgt_fd)
 184 {
 185     if (tgt_fd < 0 || tgt_fd > MAX_FD)
 186         panic("Process::dup_fd tried to dup past MAX_FD (%d)", tgt_fd);
 187
 188     fd_map[tgt_fd] = sim_fd;
 189 }
 190
 191
 192 // generate new target fd for sim_fd
 193 int
 194 Process::alloc_fd(int sim_fd)
 195 {
 196     // in case open() returns an error, don't allocate a new fd
 197     if (sim_fd == -1)
 198         return -1;
 199
 200     // find first free target fd
 201     for (int free_fd = 0; free_fd < MAX_FD; ++free_fd) {
 202         if (fd_map[free_fd] == -1) {
 203             fd_map[free_fd] = sim_fd;
 204             return free_fd;
 205         }
 206     }
 207
 208     panic("Process::alloc_fd: out of file descriptors!");
 209 }
 210
 211
 212 // free target fd (e.g., after close)
 213 void
 214 Process::free_fd(int tgt_fd)
 215 {
 216     if (fd_map[tgt_fd] == -1)
 217         warn("Process::free_fd: request to free unused fd %d", tgt_fd);
 218
 219     fd_map[tgt_fd] = -1;
 220 }
 221
 222
 223 // look up simulator fd for given target fd
 224 int
 225 Process::sim_fd(int tgt_fd)
 226 {
 227     if (tgt_fd > MAX_FD)
 228         return -1;
 229
 230     return fd_map[tgt_fd];
 231 }
 232
 233
 234
 235 //
 236 // need to declare these here since there is no concrete Process type
 237 // that can be constructed (i.e., no REGISTER_SIM_OBJECT() macro call,
 238 // which is where these get declared for concrete types).
 239 //
 240 DEFINE_SIM_OBJECT_CLASS_NAME("Process", Process)
 241
 242
 243 ////////////////////////////////////////////////////////////////////////
 244 //
 245 // LiveProcess member definitions
 246 //
 247 ////////////////////////////////////////////////////////////////////////
 248
 249
 250 static void
 251 copyStringArray(vector<string> &strings, Addr array_ptr, Addr data_ptr,
 252                 FunctionalMemory *memory)
 253 {
 254     for (int i = 0; i < strings.size(); ++i) {
 255         memory->access(Write, array_ptr, &data_ptr, sizeof(Addr));
 256         memory->writeString(data_ptr, strings[i].c_str());
 257         array_ptr += sizeof(Addr);
 258         data_ptr += strings[i].size() + 1;
 259     }
 260     // add NULL terminator
 261     data_ptr = 0;
 262     memory->access(Write, array_ptr, &data_ptr, sizeof(Addr));
 263 }
 264
 265 LiveProcess::LiveProcess(const string &nm, ObjectFile *objFile,
 266                          int stdin_fd, int stdout_fd, int stderr_fd,
 267                          vector<string> &argv, vector<string> &envp)
 268     : Process(nm, stdin_fd, stdout_fd, stderr_fd)
 269 {
 270     prog_fname = argv[0];
 271
 272     prog_entry = objFile->entryPoint();
 273     text_base = objFile->textBase();
 274     text_size = objFile->textSize();
 275     data_base = objFile->dataBase();
 276     data_size = objFile->dataSize() + objFile->bssSize();
 277     brk_point = RoundUp<uint64_t>(data_base + data_size, VMPageSize);
 278
 279     // load object file into target memory
 280     objFile->loadSections(memory);
 281
 282     // load up symbols, if any... these may be used for debugging or
 283     // profiling.
 284     if (!debugSymbolTable) {
 285         debugSymbolTable = new SymbolTable();
 286         if (!objFile->loadGlobalSymbols(debugSymbolTable) ||
 287             !objFile->loadLocalSymbols(debugSymbolTable)) {
 288             // didn't load any symbols
 289             delete debugSymbolTable;
 290             debugSymbolTable = NULL;
 291         }
 292     }
 293
 294     // Set up stack.  On Alpha, stack goes below text section.  This
 295     // code should get moved to some architecture-specific spot.
 296     stack_base = text_base - (409600+4096);
 297
 298     // Set up region for mmaps.  Tru64 seems to start just above 0 and
 299     // grow up from there.
 300     mmap_start = mmap_end = 0x10000;
 301
 302     // Set pointer for next thread stack.  Reserve 8M for main stack.
 303     next_thread_stack_base = stack_base - (8 * 1024 * 1024);
 304
 305     // Calculate how much space we need for arg & env arrays.
 306     int argv_array_size = sizeof(Addr) * (argv.size() + 1);
 307     int envp_array_size = sizeof(Addr) * (envp.size() + 1);
 308     int arg_data_size = 0;
 309     for (int i = 0; i < argv.size(); ++i) {
 310         arg_data_size += argv[i].size() + 1;
 311     }
 312     int env_data_size = 0;
 313     for (int i = 0; i < envp.size(); ++i) {
 314         env_data_size += envp[i].size() + 1;
 315     }
 316
 317     int space_needed =
 318         argv_array_size + envp_array_size + arg_data_size + env_data_size;
 319     // for SimpleScalar compatibility
 320     if (space_needed < 16384)
 321         space_needed = 16384;
 322
 323     // set bottom of stack
 324     stack_min = stack_base - space_needed;
 325     // align it
 326     stack_min &= ~7;
 327     stack_size = stack_base - stack_min;
 328
 329     // map out initial stack contents
 330     Addr argv_array_base = stack_min + sizeof(uint64_t); // room for argc
 331     Addr envp_array_base = argv_array_base + argv_array_size;
 332     Addr arg_data_base = envp_array_base + envp_array_size;
 333     Addr env_data_base = arg_data_base + arg_data_size;
 334
 335     // write contents to stack
 336     uint64_t argc = argv.size();
 337     memory->access(Write, stack_min, &argc, sizeof(uint64_t));
 338
 339     copyStringArray(argv, argv_array_base, arg_data_base, memory);
 340     copyStringArray(envp, envp_array_base, env_data_base, memory);
 341
 342     init_regs->intRegFile[ArgumentReg0] = argc;
 343     init_regs->intRegFile[ArgumentReg1] = argv_array_base;
 344     init_regs->intRegFile[StackPointerReg] = stack_min;
 345     init_regs->intRegFile[GlobalPointerReg] = objFile->globalPointer();
 346     init_regs->pc = prog_entry;
 347     init_regs->npc = prog_entry + sizeof(MachInst);
 348 }
 349
 350
 351 LiveProcess *
 352 LiveProcess::create(const string &nm,
 353                     int stdin_fd, int stdout_fd, int stderr_fd,
 354                     string executable,
 355                     vector<string> &argv, vector<string> &envp)
 356 {
 357     LiveProcess *process = NULL;
 358     ObjectFile *objFile = createObjectFile(executable);
 359     if (objFile == NULL) {
 360         fatal("Can't load object file %s", executable);
 361     }
 362
 363     // check object type & set up syscall emulation pointer
 364     if (objFile->getArch() == ObjectFile::Alpha) {
 365         switch (objFile->getOpSys()) {
 366           case ObjectFile::Tru64:
 367             process = new AlphaTru64Process(nm, objFile,
 368                                             stdin_fd, stdout_fd, stderr_fd,
 369                                             argv, envp);
 370             break;
 371
 372           case ObjectFile::Linux:
 373             process = new AlphaLinuxProcess(nm, objFile,
 374                                             stdin_fd, stdout_fd, stderr_fd,
 375                                             argv, envp);
 376             break;
 377
 378           default:
 379             fatal("Unknown/unsupported operating system.");
 380         }
 381     } else {
 382         fatal("Unknown object file architecture.");
 383     }
 384
 385     delete objFile;
 386
 387     if (process == NULL)
 388         fatal("Unknown error creating process object.");
 389
 390     return process;
 391 }
 392
 393
 394 BEGIN_DECLARE_SIM_OBJECT_PARAMS(LiveProcess)
 395
 396     VectorParam<string> cmd;
 397     Param<string> executable;
 398     Param<string> input;
 399     Param<string> output;
 400     VectorParam<string> env;
 401
 402 END_DECLARE_SIM_OBJECT_PARAMS(LiveProcess)
 403
 404
 405 BEGIN_INIT_SIM_OBJECT_PARAMS(LiveProcess)
 406
 407     INIT_PARAM(cmd, "command line (executable plus arguments)"),
 408     INIT_PARAM(executable, "executable (overrides cmd[0] if set)"),
 409     INIT_PARAM(input, "filename for stdin (dflt: use sim stdin)"),
 410     INIT_PARAM(output, "filename for stdout/stderr (dflt: use sim stdout)"),
 411     INIT_PARAM(env, "environment settings")
 412
 413 END_INIT_SIM_OBJECT_PARAMS(LiveProcess)
 414
 415
 416 CREATE_SIM_OBJECT(LiveProcess)
 417 {
 418     string in = input;
 419     string out = output;
 420
 421     // initialize file descriptors to default: same as simulator
 422     int stdin_fd, stdout_fd, stderr_fd;
 423
 424     if (in == "stdin" || in == "cin")
 425         stdin_fd = STDIN_FILENO;
 426     else
 427         stdin_fd = Process::openInputFile(input);
 428
 429     if (out == "stdout" || out == "cout")
 430         stdout_fd = STDOUT_FILENO;
 431     else if (out == "stderr" || out == "cerr")
 432         stdout_fd = STDERR_FILENO;
 433     else
 434         stdout_fd = Process::openOutputFile(out);
 435
 436     stderr_fd = (stdout_fd != STDOUT_FILENO) ? stdout_fd : STDERR_FILENO;
 437
 438     return LiveProcess::create(getInstanceName(),
 439                                stdin_fd, stdout_fd, stderr_fd,
 440                                (string)executable == "" ? cmd[0] : executable,
 441                                cmd, env);
 442 }
 443
 444 REGISTER_SIM_OBJECT("LiveProcess", LiveProcess)