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