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