sim/process.cc

   1 /*
   2  * Copyright (c) 2003 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/statistics.hh"
  38 #include "cpu/exec_context.hh"
  39 #include "cpu/full_cpu/smt.hh"
  40 #include "cpu/full_cpu/thread.hh"
  41 #include "eio/eio.hh"
  42 #include "mem/functional_mem/main_memory.hh"
  43 #include "sim/builder.hh"
  44 #include "sim/fake_syscall.hh"
  45 #include "sim/process.hh"
  46 #include "sim/sim_stats.hh"
  47
  48 #ifdef TARGET_ALPHA
  49 #include "arch/alpha/alpha_tru64_process.hh"
  50 #include "arch/alpha/alpha_linux_process.hh"
  51 #endif
  52
  53 using namespace std;
  54
  55 //
  56 // The purpose of this code is to fake the loader & syscall mechanism
  57 // when there's no OS: thus there's no resone to use it in FULL_SYSTEM
  58 // mode when we do have an OS
  59 //
  60 #ifdef FULL_SYSTEM
  61 #error "process.cc not compatible with FULL_SYSTEM"
  62 #endif
  63
  64 // current number of allocated processes
  65 int num_processes = 0;
  66
  67 Process::Process(const string &name,
  68                  int stdin_fd,  // initial I/O descriptors
  69                  int stdout_fd,
  70                  int stderr_fd)
  71     : SimObject(name)
  72 {
  73     // allocate memory space
  74     memory = new MainMemory(name + ".MainMem");
  75
  76     // allocate initial register file
  77     init_regs = new RegFile;
  78     memset(init_regs, 0, sizeof(RegFile));
  79
  80     // initialize first 3 fds (stdin, stdout, stderr)
  81     fd_map[STDIN_FILENO] = stdin_fd;
  82     fd_map[STDOUT_FILENO] = stdout_fd;
  83     fd_map[STDERR_FILENO] = stderr_fd;
  84
  85     // mark remaining fds as free
  86     for (int i = 3; i <= MAX_FD; ++i) {
  87         fd_map[i] = -1;
  88     }
  89
  90     num_syscalls = 0;
  91
  92     // other parameters will be initialized when the program is loaded
  93 }
  94
  95 void
  96 Process::regStats()
  97 {
  98     using namespace Statistics;
  99
 100     num_syscalls
 101         .name(name() + ".PROG:num_syscalls")
 102         .desc("Number of system calls")
 103         ;
 104 }
 105
 106 //
 107 // static helper functions
 108 //
 109 int
 110 Process::openInputFile(const string &filename)
 111 {
 112     int fd = open(filename.c_str(), O_RDONLY);
 113
 114     if (fd == -1) {
 115         perror(NULL);
 116         cerr << "unable to open \"" << filename << "\" for reading\n";
 117         fatal("can't open input file");
 118     }
 119
 120     return fd;
 121 }
 122
 123
 124 int
 125 Process::openOutputFile(const string &filename)
 126 {
 127     int fd = open(filename.c_str(), O_WRONLY | O_CREAT | O_TRUNC, 0774);
 128
 129     if (fd == -1) {
 130         perror(NULL);
 131         cerr << "unable to open \"" << filename << "\" for writing\n";
 132         fatal("can't open output file");
 133     }
 134
 135     return fd;
 136 }
 137
 138
 139 int
 140 Process::registerExecContext(ExecContext *xc)
 141 {
 142     // add to list
 143     int myIndex = execContexts.size();
 144     execContexts.push_back(xc);
 145
 146     if (myIndex == 0) {
 147         // first exec context for this process... initialize & enable
 148
 149         // copy process's initial regs struct
 150         xc->regs = *init_regs;
 151
 152         // mark this context as active.
 153         // activate with zero delay so that we start ticking right
 154         // away on cycle 0
 155         xc->activate(0);
 156     }
 157
 158     // return CPU number to caller and increment available CPU count
 159     return myIndex;
 160 }
 161
 162
 163 void
 164 Process::replaceExecContext(int xcIndex, ExecContext *xc)
 165 {
 166     if (xcIndex >= execContexts.size()) {
 167         panic("replaceExecContext: bad xcIndex, %d >= %d\n",
 168               xcIndex, execContexts.size());
 169     }
 170
 171     execContexts[xcIndex] = xc;
 172 }
 173
 174 // map simulator fd sim_fd to target fd tgt_fd
 175 void
 176 Process::dup_fd(int sim_fd, int tgt_fd)
 177 {
 178     if (tgt_fd < 0 || tgt_fd > MAX_FD)
 179         panic("Process::dup_fd tried to dup past MAX_FD (%d)", tgt_fd);
 180
 181     fd_map[tgt_fd] = sim_fd;
 182 }
 183
 184
 185 // generate new target fd for sim_fd
 186 int
 187 Process::open_fd(int sim_fd)
 188 {
 189     int free_fd;
 190
 191     // in case open() returns an error, don't allocate a new fd
 192     if (sim_fd == -1)
 193         return -1;
 194
 195     // find first free target fd
 196     for (free_fd = 0; fd_map[free_fd] >= 0; ++free_fd) {
 197         if (free_fd == MAX_FD)
 198             panic("Process::open_fd: out of file descriptors!");
 199     }
 200
 201     fd_map[free_fd] = sim_fd;
 202
 203     return free_fd;
 204 }
 205
 206
 207 // look up simulator fd for given target fd
 208 int
 209 Process::sim_fd(int tgt_fd)
 210 {
 211     if (tgt_fd > MAX_FD)
 212         return -1;
 213
 214     return fd_map[tgt_fd];
 215 }
 216
 217
 218
 219 //
 220 // need to declare these here since there is no concrete Process type
 221 // that can be constructed (i.e., no REGISTER_SIM_OBJECT() macro call,
 222 // which is where these get declared for concrete types).
 223 //
 224 DEFINE_SIM_OBJECT_CLASS_NAME("Process object", Process)
 225
 226
 227 ////////////////////////////////////////////////////////////////////////
 228 //
 229 // LiveProcess member definitions
 230 //
 231 ////////////////////////////////////////////////////////////////////////
 232
 233
 234 static void
 235 copyStringArray(vector<string> &strings, Addr array_ptr, Addr data_ptr,
 236                 FunctionalMemory *memory)
 237 {
 238     for (int i = 0; i < strings.size(); ++i) {
 239         memory->access(Write, array_ptr, &data_ptr, sizeof(Addr));
 240         memory->writeString(data_ptr, strings[i].c_str());
 241         array_ptr += sizeof(Addr);
 242         data_ptr += strings[i].size() + 1;
 243     }
 244     // add NULL terminator
 245     data_ptr = 0;
 246     memory->access(Write, array_ptr, &data_ptr, sizeof(Addr));
 247 }
 248
 249 LiveProcess::LiveProcess(const string &name, ObjectFile *objFile,
 250                          int stdin_fd, int stdout_fd, int stderr_fd,
 251                          vector<string> &argv, vector<string> &envp)
 252     : Process(name, stdin_fd, stdout_fd, stderr_fd)
 253 {
 254     prog_fname = argv[0];
 255
 256     prog_entry = objFile->entryPoint();
 257     text_base = objFile->textBase();
 258     text_size = objFile->textSize();
 259     data_base = objFile->dataBase();
 260     data_size = objFile->dataSize() + objFile->bssSize();
 261     brk_point = RoundUp<uint64_t>(data_base + data_size, VMPageSize);
 262
 263     // load object file into target memory
 264     objFile->loadSections(memory);
 265
 266     // Set up stack.  On Alpha, stack goes below text section.  This
 267     // code should get moved to some architecture-specific spot.
 268     stack_base = text_base - (409600+4096);
 269
 270     // Set up region for mmaps.  Tru64 seems to start just above 0 and
 271     // grow up from there.
 272     mmap_base = 0x10000;
 273
 274     // Set pointer for next thread stack.  Reserve 8M for main stack.
 275     next_thread_stack_base = stack_base - (8 * 1024 * 1024);
 276
 277     // Calculate how much space we need for arg & env arrays.
 278     int argv_array_size = sizeof(Addr) * (argv.size() + 1);
 279     int envp_array_size = sizeof(Addr) * (envp.size() + 1);
 280     int arg_data_size = 0;
 281     for (int i = 0; i < argv.size(); ++i) {
 282         arg_data_size += argv[i].size() + 1;
 283     }
 284     int env_data_size = 0;
 285     for (int i = 0; i < envp.size(); ++i) {
 286         env_data_size += envp[i].size() + 1;
 287     }
 288
 289     int space_needed =
 290         argv_array_size + envp_array_size + arg_data_size + env_data_size;
 291     // for SimpleScalar compatibility
 292     if (space_needed < 16384)
 293         space_needed = 16384;
 294
 295     // set bottom of stack
 296     stack_min = stack_base - space_needed;
 297     // align it
 298     stack_min &= ~7;
 299     stack_size = stack_base - stack_min;
 300
 301     // map out initial stack contents
 302     Addr argv_array_base = stack_min + sizeof(uint64_t); // room for argc
 303     Addr envp_array_base = argv_array_base + argv_array_size;
 304     Addr arg_data_base = envp_array_base + envp_array_size;
 305     Addr env_data_base = arg_data_base + arg_data_size;
 306
 307     // write contents to stack
 308     uint64_t argc = argv.size();
 309     memory->access(Write, stack_min, &argc, sizeof(uint64_t));
 310
 311     copyStringArray(argv, argv_array_base, arg_data_base, memory);
 312     copyStringArray(envp, envp_array_base, env_data_base, memory);
 313
 314     init_regs->intRegFile[ArgumentReg0] = argc;
 315     init_regs->intRegFile[ArgumentReg1] = argv_array_base;
 316     init_regs->intRegFile[StackPointerReg] = stack_min;
 317     init_regs->intRegFile[GlobalPointerReg] = objFile->globalPointer();
 318     init_regs->pc = prog_entry;
 319     init_regs->npc = prog_entry + sizeof(MachInst);
 320 }
 321
 322
 323 LiveProcess *
 324 LiveProcess::create(const string &name,
 325                     int stdin_fd, int stdout_fd, int stderr_fd,
 326                     vector<string> &argv, vector<string> &envp)
 327 {
 328     LiveProcess *process = NULL;
 329     ObjectFile *objFile = createObjectFile(argv[0]);
 330     if (objFile == NULL) {
 331         fatal("Can't load object file %s", argv[0]);
 332     }
 333
 334     // check object type & set up syscall emulation pointer
 335     if (objFile->getArch() == ObjectFile::Alpha) {
 336         switch (objFile->getOpSys()) {
 337           case ObjectFile::Tru64:
 338             process = new AlphaTru64Process(name, objFile,
 339                                             stdin_fd, stdout_fd, stderr_fd,
 340                                             argv, envp);
 341             break;
 342
 343           case ObjectFile::Linux:
 344             process = new AlphaLinuxProcess(name, objFile,
 345                                             stdin_fd, stdout_fd, stderr_fd,
 346                                             argv, envp);
 347             break;
 348
 349           default:
 350             fatal("Unknown/unsupported operating system.");
 351         }
 352     } else {
 353         fatal("Unknown object file architecture.");
 354     }
 355
 356     delete objFile;
 357
 358     if (process == NULL)
 359         fatal("Unknown error creating process object.");
 360
 361     return process;
 362 }
 363
 364
 365 BEGIN_DECLARE_SIM_OBJECT_PARAMS(LiveProcess)
 366
 367     VectorParam<string> cmd;
 368     Param<string> input;
 369     Param<string> output;
 370     VectorParam<string> env;
 371
 372 END_DECLARE_SIM_OBJECT_PARAMS(LiveProcess)
 373
 374
 375 BEGIN_INIT_SIM_OBJECT_PARAMS(LiveProcess)
 376
 377     INIT_PARAM(cmd, "command line (executable plus arguments)"),
 378     INIT_PARAM(input, "filename for stdin (dflt: use sim stdin)"),
 379     INIT_PARAM(output, "filename for stdout/stderr (dflt: use sim stdout)"),
 380     INIT_PARAM(env, "environment settings")
 381
 382 END_INIT_SIM_OBJECT_PARAMS(LiveProcess)
 383
 384
 385 CREATE_SIM_OBJECT(LiveProcess)
 386 {
 387     // initialize file descriptors to default: same as simulator
 388     int stdin_fd = input.isValid() ? Process::openInputFile(input) : 0;
 389     int stdout_fd = output.isValid() ? Process::openOutputFile(output) : 1;
 390     int stderr_fd = output.isValid() ? stdout_fd : 2;
 391
 392     // dummy for default env
 393     vector<string> null_vec;
 394
 395     //  We do this with "temp" because of the bogus compiler warning
 396     //  you get with g++ 2.95 -O if you just "return new LiveProcess(..."
 397     LiveProcess *temp = LiveProcess::create(getInstanceName(),
 398                                             stdin_fd, stdout_fd, stderr_fd,
 399                                             cmd,
 400                                             env.isValid() ? env : null_vec);
 401
 402     return temp;
 403 }
 404
 405
 406 REGISTER_SIM_OBJECT("LiveProcess", LiveProcess)