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