process.hh revision 8766:b0773af78423 
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#include <string>
36#include <vector>
37
38#include "arch/registers.hh"
39#include "base/statistics.hh"
40#include "base/types.hh"
41#include "config/the_isa.hh"
42#include "sim/sim_object.hh"
43#include "sim/syscallreturn.hh"
44
45class PageTable;
46class ProcessParams;
47class LiveProcessParams;
48class SyscallDesc;
49class System;
50class ThreadContext;
51class TranslatingPort;
52
53template<class IntType>
54struct AuxVector
55{
56    IntType a_type;
57    IntType a_val;
58
59    AuxVector()
60    {}
61
62    AuxVector(IntType type, IntType val);
63};
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    // thread contexts associated with this process
74    std::vector<int> contextIds;
75
76    // number of CPUs (esxec contexts, really) assigned to this process.
77    unsigned int numCpus() { return contextIds.size(); }
78
79    // record of blocked context
80    struct WaitRec
81    {
82        Addr waitChan;
83        ThreadContext *waitingContext;
84
85        WaitRec(Addr chan, ThreadContext *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    // The maximum size allowed for the stack.
100    Addr max_stack_size;
101
102    // addr to use for next stack region (for multithreaded apps)
103    Addr next_thread_stack_base;
104
105    // Base of region for mmaps (when user doesn't specify an address).
106    Addr mmap_start;
107    Addr mmap_end;
108
109    // Base of region for nxm data
110    Addr nxm_start;
111    Addr nxm_end;
112
113    std::string prog_fname;     // file name
114
115    Stats::Scalar num_syscalls;       // number of syscalls executed
116
117
118  protected:
119    // constructor
120    Process(ProcessParams *params);
121
122    virtual void initState();
123
124  protected:
125    /// Memory object for initialization (image loading)
126    TranslatingPort *initVirtMem;
127
128  public:
129    PageTable *pTable;
130
131    //This id is assigned by m5 and is used to keep process' tlb entries
132    //separated.
133    uint64_t M5_pid;
134
135    class FdMap
136    {
137      public:
138        int fd;
139        std::string filename;
140        int mode;
141        int flags;
142        bool isPipe;
143        int readPipeSource;
144        uint64_t fileOffset;
145
146        FdMap()
147            : fd(-1), filename("NULL"), mode(0), flags(0),
148              isPipe(false), readPipeSource(0), fileOffset(0)
149        { }
150
151        void serialize(std::ostream &os);
152        void unserialize(Checkpoint *cp, const std::string &section);
153    };
154
155  private:
156    // file descriptor remapping support
157    static const int MAX_FD = 256;    // max legal fd value
158    FdMap fd_map[MAX_FD+1];
159
160
161  public:
162    // static helper functions to generate file descriptors for constructor
163    static int openInputFile(const std::string &filename);
164    static int openOutputFile(const std::string &filename);
165
166    // override of virtual SimObject method: register statistics
167    virtual void regStats();
168
169    // After getting registered with system object, tell process which
170    // system-wide context id it is assigned.
171    void assignThreadContext(int context_id)
172    {
173        contextIds.push_back(context_id);
174    }
175
176    // Find a free context to use
177    ThreadContext *findFreeContext();
178
179    // map simulator fd sim_fd to target fd tgt_fd
180    void dup_fd(int sim_fd, int tgt_fd);
181
182    // generate new target fd for sim_fd
183    int alloc_fd(int sim_fd, std::string filename, int flags, int mode,
184                 bool pipe);
185
186    // free target fd (e.g., after close)
187    void free_fd(int tgt_fd);
188
189    // look up simulator fd for given target fd
190    int sim_fd(int tgt_fd);
191
192    // look up simulator fd_map object for a given target fd
193    FdMap *sim_fd_obj(int tgt_fd);
194
195    // fix all offsets for currently open files and save them
196    void fix_file_offsets();
197
198    // find all offsets for currently open files and save them
199    void find_file_offsets();
200
201    // set the source of this read pipe for a checkpoint resume
202    void setReadPipeSource(int read_pipe_fd, int source_fd);
203
204    virtual void syscall(int64_t callnum, ThreadContext *tc) = 0;
205
206    /// Attempt to fix up a fault at vaddr by allocating a page on the stack.
207    /// @return Whether the fault has been fixed.
208    bool fixupStackFault(Addr vaddr);
209
210    void serialize(std::ostream &os);
211    void unserialize(Checkpoint *cp, const std::string &section);
212};
213
214//
215// "Live" process with system calls redirected to host system
216//
217class ObjectFile;
218class LiveProcess : public Process
219{
220  protected:
221    ObjectFile *objFile;
222    std::vector<std::string> argv;
223    std::vector<std::string> envp;
224    std::string cwd;
225
226    LiveProcess(LiveProcessParams *params, ObjectFile *objFile);
227
228    // Id of the owner of the process
229    uint64_t __uid;
230    uint64_t __euid;
231    uint64_t __gid;
232    uint64_t __egid;
233
234    // pid of the process and it's parent
235    uint64_t __pid;
236    uint64_t __ppid;
237
238  public:
239
240    enum AuxiliaryVectorType {
241        M5_AT_NULL = 0,
242        M5_AT_IGNORE = 1,
243        M5_AT_EXECFD = 2,
244        M5_AT_PHDR = 3,
245        M5_AT_PHENT = 4,
246        M5_AT_PHNUM = 5,
247        M5_AT_PAGESZ = 6,
248        M5_AT_BASE = 7,
249        M5_AT_FLAGS = 8,
250        M5_AT_ENTRY = 9,
251        M5_AT_NOTELF = 10,
252        M5_AT_UID = 11,
253        M5_AT_EUID = 12,
254        M5_AT_GID = 13,
255        M5_AT_EGID = 14,
256        // The following may be specific to Linux
257        M5_AT_PLATFORM = 15,
258        M5_AT_HWCAP = 16,
259        M5_AT_CLKTCK = 17,
260
261        M5_AT_SECURE = 23,
262        M5_BASE_PLATFORM = 24,
263        M5_AT_RANDOM = 25,
264
265        M5_AT_EXECFN = 31,
266
267        M5_AT_VECTOR_SIZE = 44
268    };
269
270    inline uint64_t uid() {return __uid;}
271    inline uint64_t euid() {return __euid;}
272    inline uint64_t gid() {return __gid;}
273    inline uint64_t egid() {return __egid;}
274    inline uint64_t pid() {return __pid;}
275    inline uint64_t ppid() {return __ppid;}
276
277    std::string
278    fullPath(const std::string &filename)
279    {
280        if (filename[0] == '/' || cwd.empty())
281            return filename;
282
283        std::string full = cwd;
284
285        if (cwd[cwd.size() - 1] != '/')
286            full += '/';
287
288        return full + filename;
289    }
290
291    std::string getcwd() const { return cwd; }
292
293    virtual void syscall(int64_t callnum, ThreadContext *tc);
294
295    virtual TheISA::IntReg getSyscallArg(ThreadContext *tc, int &i) = 0;
296    virtual TheISA::IntReg getSyscallArg(ThreadContext *tc, int &i, int width);
297    virtual void setSyscallArg(ThreadContext *tc,
298            int i, TheISA::IntReg val) = 0;
299    virtual void setSyscallReturn(ThreadContext *tc,
300            SyscallReturn return_value) = 0;
301
302    virtual SyscallDesc *getDesc(int callnum) = 0;
303
304    // this function is used to create the LiveProcess object, since
305    // we can't tell which subclass of LiveProcess to use until we
306    // open and look at the object file.
307    static LiveProcess *create(LiveProcessParams *params);
308};
309
310
311#endif // __PROCESS_HH__
312