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::open_fd(int sim_fd)
 195 {
 196     int free_fd;
 197
 198     // in case open() returns an error, don't allocate a new fd
 199     if (sim_fd == -1)
 200         return -1;
 201
 202     // find first free target fd
 203     for (free_fd = 0; fd_map[free_fd] >= 0; ++free_fd) {
 204         if (free_fd == MAX_FD)
 205             panic("Process::open_fd: out of file descriptors!");
 206     }
 207
 208     fd_map[free_fd] = sim_fd;
 209
 210     return free_fd;
 211 }
 212
 213
 214 // look up simulator fd for given target fd
 215 int
 216 Process::sim_fd(int tgt_fd)
 217 {
 218     if (tgt_fd > MAX_FD)
 219         return -1;
 220
 221     return fd_map[tgt_fd];
 222 }
 223
 224
 225
 226 //
 227 // need to declare these here since there is no concrete Process type
 228 // that can be constructed (i.e., no REGISTER_SIM_OBJECT() macro call,
 229 // which is where these get declared for concrete types).
 230 //
 231 DEFINE_SIM_OBJECT_CLASS_NAME("Process", Process)
 232
 233
 234 ////////////////////////////////////////////////////////////////////////
 235 //
 236 // LiveProcess member definitions
 237 //
 238 ////////////////////////////////////////////////////////////////////////
 239
 240
 241 static void
 242 copyStringArray(vector<string> &strings, Addr array_ptr, Addr data_ptr,
 243                 FunctionalMemory *memory)
 244 {
 245     for (int i = 0; i < strings.size(); ++i) {
 246         memory->access(Write, array_ptr, &data_ptr, sizeof(Addr));
 247         memory->writeString(data_ptr, strings[i].c_str());
 248         array_ptr += sizeof(Addr);
 249         data_ptr += strings[i].size() + 1;
 250     }
 251     // add NULL terminator
 252     data_ptr = 0;
 253     memory->access(Write, array_ptr, &data_ptr, sizeof(Addr));
 254 }
 255
 256 LiveProcess::LiveProcess(const string &nm, ObjectFile *objFile,
 257                          int stdin_fd, int stdout_fd, int stderr_fd,
 258                          vector<string> &argv, vector<string> &envp)
 259     : Process(nm, stdin_fd, stdout_fd, stderr_fd)
 260 {
 261     prog_fname = argv[0];
 262
 263     prog_entry = objFile->entryPoint();
 264     text_base = objFile->textBase();
 265     text_size = objFile->textSize();
 266     data_base = objFile->dataBase();
 267     data_size = objFile->dataSize() + objFile->bssSize();
 268     brk_point = RoundUp<uint64_t>(data_base + data_size, VMPageSize);
 269
 270     // load object file into target memory
 271     objFile->loadSections(memory);
 272
 273     // load up symbols, if any... these may be used for debugging or
 274     // profiling.
 275     if (!debugSymbolTable) {
 276         debugSymbolTable = new SymbolTable();
 277         if (!objFile->loadGlobalSymbols(debugSymbolTable) ||
 278             !objFile->loadLocalSymbols(debugSymbolTable)) {
 279             // didn't load any symbols
 280             delete debugSymbolTable;
 281             debugSymbolTable = NULL;
 282         }
 283     }
 284
 285     // Set up stack.  On Alpha, stack goes below text section.  This
 286     // code should get moved to some architecture-specific spot.
 287     stack_base = text_base - (409600+4096);
 288
 289     // Set up region for mmaps.  Tru64 seems to start just above 0 and
 290     // grow up from there.
 291     mmap_start = mmap_end = 0x10000;
 292
 293     // Set pointer for next thread stack.  Reserve 8M for main stack.
 294     next_thread_stack_base = stack_base - (8 * 1024 * 1024);
 295
 296     // Calculate how much space we need for arg & env arrays.
 297     int argv_array_size = sizeof(Addr) * (argv.size() + 1);
 298     int envp_array_size = sizeof(Addr) * (envp.size() + 1);
 299     int arg_data_size = 0;
 300     for (int i = 0; i < argv.size(); ++i) {
 301         arg_data_size += argv[i].size() + 1;
 302     }
 303     int env_data_size = 0;
 304     for (int i = 0; i < envp.size(); ++i) {
 305         env_data_size += envp[i].size() + 1;
 306     }
 307
 308     int space_needed =
 309         argv_array_size + envp_array_size + arg_data_size + env_data_size;
 310     // for SimpleScalar compatibility
 311     if (space_needed < 16384)
 312         space_needed = 16384;
 313
 314     // set bottom of stack
 315     stack_min = stack_base - space_needed;
 316     // align it
 317     stack_min &= ~7;
 318     stack_size = stack_base - stack_min;
 319
 320     // map out initial stack contents
 321     Addr argv_array_base = stack_min + sizeof(uint64_t); // room for argc
 322     Addr envp_array_base = argv_array_base + argv_array_size;
 323     Addr arg_data_base = envp_array_base + envp_array_size;
 324     Addr env_data_base = arg_data_base + arg_data_size;
 325
 326     // write contents to stack
 327     uint64_t argc = argv.size();
 328     memory->access(Write, stack_min, &argc, sizeof(uint64_t));
 329
 330     copyStringArray(argv, argv_array_base, arg_data_base, memory);
 331     copyStringArray(envp, envp_array_base, env_data_base, memory);
 332
 333     init_regs->intRegFile[ArgumentReg0] = argc;
 334     init_regs->intRegFile[ArgumentReg1] = argv_array_base;
 335     init_regs->intRegFile[StackPointerReg] = stack_min;
 336     init_regs->intRegFile[GlobalPointerReg] = objFile->globalPointer();
 337     init_regs->pc = prog_entry;
 338     init_regs->npc = prog_entry + sizeof(MachInst);
 339 }
 340
 341
 342 LiveProcess *
 343 LiveProcess::create(const string &nm,
 344                     int stdin_fd, int stdout_fd, int stderr_fd,
 345                     vector<string> &argv, vector<string> &envp)
 346 {
 347     LiveProcess *process = NULL;
 348     ObjectFile *objFile = createObjectFile(argv[0]);
 349     if (objFile == NULL) {
 350         fatal("Can't load object file %s", argv[0]);
 351     }
 352
 353     // check object type & set up syscall emulation pointer
 354     if (objFile->getArch() == ObjectFile::Alpha) {
 355         switch (objFile->getOpSys()) {
 356           case ObjectFile::Tru64:
 357             process = new AlphaTru64Process(nm, objFile,
 358                                             stdin_fd, stdout_fd, stderr_fd,
 359                                             argv, envp);
 360             break;
 361
 362           case ObjectFile::Linux:
 363             process = new AlphaLinuxProcess(nm, objFile,
 364                                             stdin_fd, stdout_fd, stderr_fd,
 365                                             argv, envp);
 366             break;
 367
 368           default:
 369             fatal("Unknown/unsupported operating system.");
 370         }
 371     } else {
 372         fatal("Unknown object file architecture.");
 373     }
 374
 375     delete objFile;
 376
 377     if (process == NULL)
 378         fatal("Unknown error creating process object.");
 379
 380     return process;
 381 }
 382
 383
 384 BEGIN_DECLARE_SIM_OBJECT_PARAMS(LiveProcess)
 385
 386     VectorParam<string> cmd;
 387     Param<string> input;
 388     Param<string> output;
 389     VectorParam<string> env;
 390
 391 END_DECLARE_SIM_OBJECT_PARAMS(LiveProcess)
 392
 393
 394 BEGIN_INIT_SIM_OBJECT_PARAMS(LiveProcess)
 395
 396     INIT_PARAM(cmd, "command line (executable plus arguments)"),
 397     INIT_PARAM(input, "filename for stdin (dflt: use sim stdin)"),
 398     INIT_PARAM(output, "filename for stdout/stderr (dflt: use sim stdout)"),
 399     INIT_PARAM(env, "environment settings")
 400
 401 END_INIT_SIM_OBJECT_PARAMS(LiveProcess)
 402
 403
 404 CREATE_SIM_OBJECT(LiveProcess)
 405 {
 406     string in = input;
 407     string out = output;
 408
 409     // initialize file descriptors to default: same as simulator
 410     int stdin_fd, stdout_fd, stderr_fd;
 411
 412     if (in == "stdin" || in == "cin")
 413         stdin_fd = STDIN_FILENO;
 414     else
 415         stdin_fd = Process::openInputFile(input);
 416
 417     if (out == "stdout" || out == "cout")
 418         stdout_fd = STDOUT_FILENO;
 419     else if (out == "stderr" || out == "cerr")
 420         stdout_fd = STDERR_FILENO;
 421     else
 422         stdout_fd = Process::openOutputFile(out);
 423
 424     stderr_fd = (stdout_fd != STDOUT_FILENO) ? stdout_fd : STDERR_FILENO;
 425
 426     return LiveProcess::create(getInstanceName(),
 427                                stdin_fd, stdout_fd, stderr_fd,
 428                                cmd, env);
 429 }
 430
 431 REGISTER_SIM_OBJECT("LiveProcess", LiveProcess)