process.hh revision 2665:a124942bacb8
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 * Authors: Nathan Binkert
29 *          Steve Reinhardt
30 */
31
32#ifndef __PROCESS_HH__
33#define __PROCESS_HH__
34
35//
36// The purpose of this code is to fake the loader & syscall mechanism
37// when there's no OS: thus there's no reason to use it in FULL_SYSTEM
38// mode when we do have an OS.
39//
40#include "config/full_system.hh"
41
42#if !FULL_SYSTEM
43
44#include <vector>
45
46#include "base/statistics.hh"
47#include "sim/sim_object.hh"
48
49class CPUExecContext;
50class ExecContext;
51class SyscallDesc;
52class PageTable;
53class TranslatingPort;
54class System;
55
56void
57copyStringArray(std::vector<std::string> &strings, Addr array_ptr,
58        Addr data_ptr, TranslatingPort* memPort);
59
60class Process : public SimObject
61{
62  public:
63
64    /// Pointer to object representing the system this process is
65    /// running on.
66    System *system;
67
68    // have we initialized an execution context from this process?  If
69    // yes, subsequent contexts are assumed to be for dynamically
70    // created threads and are not initialized.
71    bool initialContextLoaded;
72
73    // execution contexts associated with this process
74    std::vector<ExecContext *> execContexts;
75
76    // number of CPUs (esxec contexts, really) assigned to this process.
77    unsigned int numCpus() { return execContexts.size(); }
78
79    // record of blocked context
80    struct WaitRec
81    {
82        Addr waitChan;
83        ExecContext *waitingContext;
84
85        WaitRec(Addr chan, ExecContext *ctx)
86            : waitChan(chan), waitingContext(ctx)
87        {	}
88    };
89
90    // list of all blocked contexts
91    std::list<WaitRec> waitList;
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
112    Stats::Scalar<> num_syscalls;	// number of syscalls executed
113
114
115  protected:
116    // constructor
117    Process(const std::string &nm,
118            System *_system,
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    /// Memory object for initialization (image loading)
128    TranslatingPort *initVirtMem;
129
130  public:
131    PageTable *pTable;
132
133  private:
134    // file descriptor remapping support
135    static const int MAX_FD = 256;	// max legal fd value
136    int fd_map[MAX_FD+1];
137
138  public:
139    // static helper functions to generate file descriptors for constructor
140    static int openInputFile(const std::string &filename);
141    static int openOutputFile(const std::string &filename);
142
143    // override of virtual SimObject method: register statistics
144    virtual void regStats();
145
146    // register an execution context for this process.
147    // returns xc's cpu number (index into execContexts[])
148    int registerExecContext(ExecContext *xc);
149
150
151    void replaceExecContext(ExecContext *xc, int xcIndex);
152
153    // map simulator fd sim_fd to target fd tgt_fd
154    void dup_fd(int sim_fd, int tgt_fd);
155
156    // generate new target fd for sim_fd
157    int alloc_fd(int sim_fd);
158
159    // free target fd (e.g., after close)
160    void free_fd(int tgt_fd);
161
162    // look up simulator fd for given target fd
163    int sim_fd(int tgt_fd);
164
165    virtual void syscall(int64_t callnum, ExecContext *xc) = 0;
166};
167
168//
169// "Live" process with system calls redirected to host system
170//
171class ObjectFile;
172class LiveProcess : public Process
173{
174  protected:
175    ObjectFile *objFile;
176    std::vector<std::string> argv;
177    std::vector<std::string> envp;
178
179    LiveProcess(const std::string &nm, ObjectFile *objFile,
180                System *_system, int stdin_fd, int stdout_fd, int stderr_fd,
181                std::vector<std::string> &argv,
182                std::vector<std::string> &envp);
183
184    virtual void argsInit(int intSize, int pageSize);
185
186  public:
187    virtual void syscall(int64_t callnum, ExecContext *xc);
188
189    virtual SyscallDesc* getDesc(int callnum) = 0;
190};
191
192
193#endif // !FULL_SYSTEM
194
195#endif // __PROCESS_HH__
196