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