process.hh revision 12431:000549e1f497 
1/*
2 * Copyright (c) 2014-2016 Advanced Micro Devices, Inc.
3 * Copyright (c) 2001-2005 The Regents of The University of Michigan
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met: redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer;
10 * redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution;
13 * neither the name of the copyright holders nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 *
29 * Authors: Nathan Binkert
30 *          Steve Reinhardt
31 *          Brandon Potter
32 */
33
34#ifndef __PROCESS_HH__
35#define __PROCESS_HH__
36
37#include <inttypes.h>
38
39#include <map>
40#include <string>
41#include <vector>
42
43#include "arch/registers.hh"
44#include "base/statistics.hh"
45#include "base/types.hh"
46#include "config/the_isa.hh"
47#include "mem/se_translating_port_proxy.hh"
48#include "sim/fd_array.hh"
49#include "sim/fd_entry.hh"
50#include "sim/mem_state.hh"
51#include "sim/sim_object.hh"
52
53struct ProcessParams;
54
55class EmulatedDriver;
56class ObjectFile;
57class PageTableBase;
58class SyscallDesc;
59class SyscallReturn;
60class System;
61class ThreadContext;
62
63class Process : public SimObject
64{
65  public:
66    Process(ProcessParams *params, PageTableBase *pTable,
67            ObjectFile *obj_file);
68
69    void serialize(CheckpointOut &cp) const override;
70    void unserialize(CheckpointIn &cp) override;
71
72    void initState() override;
73    DrainState drain() override;
74
75    virtual void syscall(int64_t callnum, ThreadContext *tc, Fault *fault);
76    virtual TheISA::IntReg getSyscallArg(ThreadContext *tc, int &i) = 0;
77    virtual TheISA::IntReg getSyscallArg(ThreadContext *tc, int &i, int width);
78    virtual void setSyscallArg(ThreadContext *tc, int i,
79                               TheISA::IntReg val) = 0;
80    virtual void setSyscallReturn(ThreadContext *tc,
81                                  SyscallReturn return_value) = 0;
82    virtual SyscallDesc *getDesc(int callnum) = 0;
83
84    inline uint64_t uid() { return _uid; }
85    inline uint64_t euid() { return _euid; }
86    inline uint64_t gid() { return _gid; }
87    inline uint64_t egid() { return _egid; }
88    inline uint64_t pid() { return _pid; }
89    inline uint64_t ppid() { return _ppid; }
90    inline uint64_t pgid() { return _pgid; }
91    inline uint64_t tgid() { return _tgid; }
92    inline void setpgid(uint64_t pgid) { _pgid = pgid; }
93
94    const char *progName() const { return executable.c_str(); }
95    std::string fullPath(const std::string &filename);
96    std::string getcwd() const { return cwd; }
97
98    /**
99     * Find an emulated device driver.
100     *
101     * @param filename Name of the device (under /dev)
102     * @return Pointer to driver object if found, else nullptr
103     */
104    EmulatedDriver *findDriver(std::string filename);
105
106    // This function acts as a callback to update the bias value in
107    // the object file because the parameters needed to calculate the
108    // bias are not available when the object file is created.
109    void updateBias();
110    Addr getBias();
111    Addr getStartPC();
112    ObjectFile *getInterpreter();
113
114    // override of virtual SimObject method: register statistics
115    void regStats() override;
116
117    void allocateMem(Addr vaddr, int64_t size, bool clobber = false);
118
119    /// Attempt to fix up a fault at vaddr by allocating a page on the stack.
120    /// @return Whether the fault has been fixed.
121    bool fixupStackFault(Addr vaddr);
122
123    // After getting registered with system object, tell process which
124    // system-wide context id it is assigned.
125    void
126    assignThreadContext(ContextID context_id)
127    {
128        contextIds.push_back(context_id);
129    }
130
131    // Find a free context to use
132    ThreadContext *findFreeContext();
133
134    /**
135     * After delegating a thread context to a child process
136     * no longer should relate to the ThreadContext
137     */
138    void revokeThreadContext(int context_id);
139
140    /**
141     * Does mmap region grow upward or downward from mmapEnd?  Most
142     * platforms grow downward, but a few (such as Alpha) grow upward
143     * instead, so they can override this method to return false.
144     */
145    virtual bool mmapGrowsDown() const { return true; }
146
147    /**
148     * Maps a contiguous range of virtual addresses in this process's
149     * address space to a contiguous range of physical addresses.
150     * This function exists primarily to expose the map operation to
151     * python, so that configuration scripts can set up mappings in SE mode.
152     *
153     * @param vaddr The starting virtual address of the range.
154     * @param paddr The starting physical address of the range.
155     * @param size The length of the range in bytes.
156     * @param cacheable Specifies whether accesses are cacheable.
157     * @return True if the map operation was successful.  (At this
158     *           point in time, the map operation always succeeds.)
159     */
160    bool map(Addr vaddr, Addr paddr, int size, bool cacheable = true);
161
162    void replicatePage(Addr vaddr, Addr new_paddr, ThreadContext *old_tc,
163                       ThreadContext *new_tc, bool alloc_page);
164
165    virtual void clone(ThreadContext *old_tc, ThreadContext *new_tc,
166                       Process *new_p, TheISA::IntReg flags);
167
168    // thread contexts associated with this process
169    std::vector<ContextID> contextIds;
170
171    // system object which owns this process
172    System *system;
173
174    Stats::Scalar numSyscalls;  // track how many system calls are executed
175
176    bool useArchPT; // flag for using architecture specific page table
177    bool kvmInSE;   // running KVM requires special initialization
178
179    PageTableBase* pTable;
180
181    SETranslatingPortProxy initVirtMem; // memory proxy for initial image load
182
183    ObjectFile *objFile;
184    std::vector<std::string> argv;
185    std::vector<std::string> envp;
186    std::string cwd;
187    std::string executable;
188
189    // Id of the owner of the process
190    uint64_t _uid;
191    uint64_t _euid;
192    uint64_t _gid;
193    uint64_t _egid;
194
195    // pid of the process and it's parent
196    uint64_t _pid;
197    uint64_t _ppid;
198    uint64_t _pgid;
199    uint64_t _tgid;
200
201    // Emulated drivers available to this process
202    std::vector<EmulatedDriver *> drivers;
203
204    std::shared_ptr<FDArray> fds;
205
206    bool *exitGroup;
207    std::shared_ptr<MemState> memState;
208
209    /**
210     * Calls a futex wakeup at the address specified by this pointer when
211     * this process exits.
212     */
213    uint64_t childClearTID;
214
215    // Process was forked with SIGCHLD set.
216    bool *sigchld;
217};
218
219#endif // __PROCESS_HH__
220