process.hh revision 2474 
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 "base/statistics.hh"
44#include "sim/sim_object.hh"
45
46class CPUExecContext;
47class ExecContext;
48class SyscallDesc;
49class PageTable;
50class TranslatingPort;
51class System;
52
53class Process : public SimObject
54{
55  public:
56
57    /// Pointer to object representing the system this process is
58    /// running on.
59    System *system;
60
61    // have we initialized an execution context from this process?  If
62    // yes, subsequent contexts are assumed to be for dynamically
63    // created threads and are not initialized.
64    bool initialContextLoaded;
65
66    // execution contexts associated with this process
67    std::vector<ExecContext *> execContexts;
68
69    // number of CPUs (esxec contexts, really) assigned to this process.
70    unsigned int numCpus() { return execContexts.size(); }
71
72    // record of blocked context
73    struct WaitRec
74    {
75        Addr waitChan;
76        ExecContext *waitingContext;
77
78        WaitRec(Addr chan, ExecContext *ctx)
79            : waitChan(chan), waitingContext(ctx)
80        {	}
81    };
82
83    // list of all blocked contexts
84    std::list<WaitRec> waitList;
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    // addr to use for next stack region (for multithreaded apps)
93    Addr next_thread_stack_base;
94
95    // Base of region for mmaps (when user doesn't specify an address).
96    Addr mmap_start;
97    Addr mmap_end;
98
99    // Base of region for nxm data
100    Addr nxm_start;
101    Addr nxm_end;
102
103    std::string prog_fname;	// file name
104
105    Stats::Scalar<> num_syscalls;	// number of syscalls executed
106
107
108  protected:
109    // constructor
110    Process(const std::string &nm,
111            System *_system,
112            int stdin_fd, 	// initial I/O descriptors
113            int stdout_fd,
114            int stderr_fd);
115
116    // post initialization startup
117    virtual void startup();
118
119  protected:
120    /// Memory object for initialization (image loading)
121    TranslatingPort *initVirtMem;
122
123  public:
124    PageTable *pTable;
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    virtual void syscall(ExecContext *xc) = 0;
159};
160
161//
162// "Live" process with system calls redirected to host system
163//
164class ObjectFile;
165class LiveProcess : public Process
166{
167  protected:
168    ObjectFile *objFile;
169    std::vector<std::string> argv;
170    std::vector<std::string> envp;
171
172    LiveProcess(const std::string &nm, ObjectFile *objFile,
173                System *_system, int stdin_fd, int stdout_fd, int stderr_fd,
174                std::vector<std::string> &argv,
175                std::vector<std::string> &envp);
176
177    void argsInit(int intSize, int pageSize);
178
179  public:
180    virtual void syscall(ExecContext *xc);
181
182    virtual SyscallDesc* getDesc(int callnum) = 0;
183};
184
185
186#endif // !FULL_SYSTEM
187
188#endif // __PROCESS_HH__
189