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