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