process.hh revision 4111:65fffcb4fae9 
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/host.hh"
48#include "sim/sim_object.hh"
49
50class ThreadContext;
51class SyscallDesc;
52class PageTable;
53class TranslatingPort;
54class System;
55class GDBListener;
56namespace TheISA
57{
58    class RemoteGDB;
59}
60
61void
62copyStringArray(std::vector<std::string> &strings, Addr array_ptr,
63        Addr data_ptr, TranslatingPort* memPort, int ptr_size = sizeof(Addr));
64
65class Process : public SimObject
66{
67  public:
68
69    /// Pointer to object representing the system this process is
70    /// running on.
71    System *system;
72
73    // have we initialized a thread context from this process?  If
74    // yes, subsequent contexts are assumed to be for dynamically
75    // created threads and are not initialized.
76    bool initialContextLoaded;
77
78    // thread contexts associated with this process
79    std::vector<ThreadContext *> threadContexts;
80
81    // remote gdb objects
82    std::vector<TheISA::RemoteGDB *> remoteGDB;
83    std::vector<GDBListener *> gdbListen;
84    bool breakpoint();
85
86    // number of CPUs (esxec contexts, really) assigned to this process.
87    unsigned int numCpus() { return threadContexts.size(); }
88
89    // record of blocked context
90    struct WaitRec
91    {
92        Addr waitChan;
93        ThreadContext *waitingContext;
94
95        WaitRec(Addr chan, ThreadContext *ctx)
96            : waitChan(chan), waitingContext(ctx)
97        {	}
98    };
99
100    // list of all blocked contexts
101    std::list<WaitRec> waitList;
102
103    Addr brk_point;		// top of the data segment
104
105    Addr stack_base;		// stack segment base (highest address)
106    unsigned stack_size;	// initial stack size
107    Addr stack_min;		// lowest address accessed on the stack
108
109    // addr to use for next stack region (for multithreaded apps)
110    Addr next_thread_stack_base;
111
112    // Base of region for mmaps (when user doesn't specify an address).
113    Addr mmap_start;
114    Addr mmap_end;
115
116    // Base of region for nxm data
117    Addr nxm_start;
118    Addr nxm_end;
119
120    std::string prog_fname;	// file name
121
122    Stats::Scalar<> num_syscalls;	// number of syscalls executed
123
124
125  protected:
126    // constructor
127    Process(const std::string &nm,
128            System *_system,
129            int stdin_fd, 	// initial I/O descriptors
130            int stdout_fd,
131            int stderr_fd);
132
133    // post initialization startup
134    virtual void startup();
135
136  protected:
137    /// Memory object for initialization (image loading)
138    TranslatingPort *initVirtMem;
139
140  public:
141    PageTable *pTable;
142
143  private:
144    // file descriptor remapping support
145    static const int MAX_FD = 256;	// max legal fd value
146    int fd_map[MAX_FD+1];
147
148  public:
149    // static helper functions to generate file descriptors for constructor
150    static int openInputFile(const std::string &filename);
151    static int openOutputFile(const std::string &filename);
152
153    // override of virtual SimObject method: register statistics
154    virtual void regStats();
155
156    // register a thread context for this process.
157    // returns tc's cpu number (index into threadContexts[])
158    int registerThreadContext(ThreadContext *tc);
159
160
161    void replaceThreadContext(ThreadContext *tc, int tcIndex);
162
163    // map simulator fd sim_fd to target fd tgt_fd
164    void dup_fd(int sim_fd, int tgt_fd);
165
166    // generate new target fd for sim_fd
167    int alloc_fd(int sim_fd);
168
169    // free target fd (e.g., after close)
170    void free_fd(int tgt_fd);
171
172    // look up simulator fd for given target fd
173    int sim_fd(int tgt_fd);
174
175    virtual void syscall(int64_t callnum, ThreadContext *tc) = 0;
176
177    void serialize(std::ostream &os);
178    void unserialize(Checkpoint *cp, const std::string &section);
179};
180
181//
182// "Live" process with system calls redirected to host system
183//
184class ObjectFile;
185class LiveProcess : public Process
186{
187  protected:
188    ObjectFile *objFile;
189    std::vector<std::string> argv;
190    std::vector<std::string> envp;
191    std::string cwd;
192
193    LiveProcess(const std::string &nm, ObjectFile *objFile,
194                System *_system, int stdin_fd, int stdout_fd, int stderr_fd,
195                std::vector<std::string> &argv,
196                std::vector<std::string> &envp,
197                const std::string &cwd,
198                uint64_t _uid, uint64_t _euid,
199                uint64_t _gid, uint64_t _egid,
200                uint64_t _pid, uint64_t _ppid);
201
202    virtual void argsInit(int intSize, int pageSize);
203
204    // Id of the owner of the process
205    uint64_t __uid;
206    uint64_t __euid;
207    uint64_t __gid;
208    uint64_t __egid;
209
210    // pid of the process and it's parent
211    uint64_t __pid;
212    uint64_t __ppid;
213
214  public:
215
216    inline uint64_t uid() {return __uid;}
217    inline uint64_t euid() {return __euid;}
218    inline uint64_t gid() {return __gid;}
219    inline uint64_t egid() {return __egid;}
220    inline uint64_t pid() {return __pid;}
221    inline uint64_t ppid() {return __ppid;}
222
223    std::string
224    fullPath(const std::string &filename)
225    {
226        if (filename[0] == '/' || cwd.empty())
227            return filename;
228
229        std::string full = cwd;
230
231        if (cwd[cwd.size() - 1] != '/')
232            full += '/';
233
234        return full + filename;
235    }
236
237    virtual void syscall(int64_t callnum, ThreadContext *tc);
238
239    virtual SyscallDesc* getDesc(int callnum) = 0;
240
241    // this function is used to create the LiveProcess object, since
242    // we can't tell which subclass of LiveProcess to use until we
243    // open and look at the object file.
244    static LiveProcess *create(const std::string &nm,
245                               System *_system,
246                               int stdin_fd, int stdout_fd, int stderr_fd,
247                               std::string executable,
248                               std::vector<std::string> &argv,
249                               std::vector<std::string> &envp,
250                               const std::string &cwd,
251                               uint64_t _uid, uint64_t _euid,
252                               uint64_t _gid, uint64_t _egid,
253                               uint64_t _pid, uint64_t _ppid);
254};
255
256
257#endif // !FULL_SYSTEM
258
259#endif // __PROCESS_HH__
260