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