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