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