process.hh revision 1450 
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#ifndef __PROCESS_HH__
30#define __PROCESS_HH__
31
32//
33// The purpose of this code is to fake the loader & syscall mechanism
34// when there's no OS: thus there's no reason to use it in FULL_SYSTEM
35// mode when we do have an OS.
36//
37#ifndef FULL_SYSTEM
38
39#include <vector>
40
41#include "targetarch/isa_traits.hh"
42#include "sim/sim_object.hh"
43#include "sim/stats.hh"
44#include "base/statistics.hh"
45#include "base/trace.hh"
46
47class ExecContext;
48class FunctionalMemory;
49class Process : public SimObject
50{
51  public:
52
53    // have we initialized an execution context from this process?  If
54    // yes, subsequent contexts are assumed to be for dynamically
55    // created threads and are not initialized.
56    bool initialContextLoaded;
57
58    // execution contexts associated with this process
59    std::vector<ExecContext *> execContexts;
60
61    // number of CPUs (esxec contexts, really) assigned to this process.
62    unsigned int numCpus() { return execContexts.size(); }
63
64    // record of blocked context
65    struct WaitRec
66    {
67        Addr waitChan;
68        ExecContext *waitingContext;
69
70        WaitRec(Addr chan, ExecContext *ctx)
71            : waitChan(chan), waitingContext(ctx)
72        {
73        }
74    };
75
76    // list of all blocked contexts
77    std::list<WaitRec> waitList;
78
79    RegFile *init_regs;		// initial register contents
80
81    Addr text_base;		// text (code) segment base
82    unsigned text_size;		// text (code) size in bytes
83
84    Addr data_base;		// initialized data segment base
85    unsigned data_size;		// initialized data + bss size in bytes
86
87    Addr brk_point;		// top of the data segment
88
89    Addr stack_base;		// stack segment base (highest address)
90    unsigned stack_size;	// initial stack size
91    Addr stack_min;		// lowest address accessed on the stack
92
93    // addr to use for next stack region (for multithreaded apps)
94    Addr next_thread_stack_base;
95
96    // Base of region for mmaps (when user doesn't specify an address).
97    Addr mmap_start;
98    Addr mmap_end;
99
100    std::string prog_fname;	// file name
101    Addr prog_entry;		// entry point (initial PC)
102
103    Stats::Scalar<> num_syscalls;	// number of syscalls executed
104
105
106  protected:
107    // constructor
108    Process(const std::string &nm,
109            int stdin_fd, 	// initial I/O descriptors
110            int stdout_fd,
111            int stderr_fd);
112
113    // post initialization startup
114    virtual void startup();
115
116  protected:
117    FunctionalMemory *memory;
118
119  private:
120    // file descriptor remapping support
121    static const int MAX_FD = 100;	// max legal fd value
122    int fd_map[MAX_FD+1];
123
124  public:
125    // static helper functions to generate file descriptors for constructor
126    static int openInputFile(const std::string &filename);
127    static int openOutputFile(const std::string &filename);
128
129    // override of virtual SimObject method: register statistics
130    virtual void regStats();
131
132    // register an execution context for this process.
133    // returns xc's cpu number (index into execContexts[])
134    int registerExecContext(ExecContext *xc);
135
136
137    void replaceExecContext(ExecContext *xc, int xcIndex);
138
139    // map simulator fd sim_fd to target fd tgt_fd
140    void dup_fd(int sim_fd, int tgt_fd);
141
142    // generate new target fd for sim_fd
143    int open_fd(int sim_fd);
144
145    // look up simulator fd for given target fd
146    int sim_fd(int tgt_fd);
147
148    // is this a valid instruction fetch address?
149    bool validInstAddr(Addr addr)
150    {
151        return (text_base <= addr &&
152                addr < text_base + text_size &&
153                !(addr & (sizeof(MachInst)-1)));
154    }
155
156    // is this a valid address? (used to filter data fetches)
157    // note that we just assume stack size <= 16MB
158    // this may be alpha-specific
159    bool validDataAddr(Addr addr)
160    {
161        return ((data_base <= addr && addr < brk_point) ||
162                ((stack_base - 16*1024*1024) <= addr && addr < stack_base) ||
163                (text_base <= addr && addr < (text_base + text_size)) ||
164                (mmap_start <= addr && addr < mmap_end));
165    }
166
167    virtual void syscall(ExecContext *xc) = 0;
168
169    virtual FunctionalMemory *getMemory() { return memory; }
170};
171
172//
173// "Live" process with system calls redirected to host system
174//
175class ObjectFile;
176class LiveProcess : public Process
177{
178  protected:
179    LiveProcess(const std::string &nm, ObjectFile *objFile,
180                int stdin_fd, int stdout_fd, int stderr_fd,
181                std::vector<std::string> &argv,
182                std::vector<std::string> &envp);
183
184  public:
185    // this function is used to create the LiveProcess object, since
186    // we can't tell which subclass of LiveProcess to use until we
187    // open and look at the object file.
188    static LiveProcess *create(const std::string &nm,
189                               int stdin_fd, int stdout_fd, int stderr_fd,
190                               std::vector<std::string> &argv,
191                               std::vector<std::string> &envp);
192};
193
194
195#endif // !FULL_SYSTEM
196
197#endif // __PROCESS_HH__
198