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