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