process.hh (4117:2807cee7b892) process.hh (4434:2ea7b6e0b78f)
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 "base/statistics.hh"
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 "base/statistics.hh"
48#include "mem/translating_port.hh"
49#include "sim/host.hh"
50#include "sim/sim_object.hh"
51
52class ThreadContext;
53class SyscallDesc;
54class PageTable;
55class TranslatingPort;
56class System;
57class GDBListener;
58namespace TheISA
59{
60 class RemoteGDB;
61}
62
48#include "sim/host.hh"
49#include "sim/sim_object.hh"
50
51class ThreadContext;
52class SyscallDesc;
53class PageTable;
54class TranslatingPort;
55class System;
56class GDBListener;
57namespace TheISA
58{
59 class RemoteGDB;
60}
61
63//This needs to be templated for cases where 32 bit pointers are needed.
64template<class AddrType>
65void
66copyStringArray(std::vector<std::string> &strings,
67 AddrType array_ptr, AddrType data_ptr,
68 TranslatingPort* memPort)
69{
70 AddrType data_ptr_swap;
71 for (int i = 0; i < strings.size(); ++i) {
72 data_ptr_swap = htog(data_ptr);
73 memPort->writeBlob(array_ptr, (uint8_t*)&data_ptr_swap,
74 sizeof(AddrType));
75 memPort->writeString(data_ptr, strings[i].c_str());
76 array_ptr += sizeof(AddrType);
77 data_ptr += strings[i].size() + 1;
78 }
79 // add NULL terminator
80 data_ptr = 0;
81
82 memPort->writeBlob(array_ptr, (uint8_t*)&data_ptr, sizeof(AddrType));
83}
84
85class Process : public SimObject
86{
87 public:
88
89 /// Pointer to object representing the system this process is
90 /// running on.
91 System *system;
92
93 // have we initialized a thread context from this process? If
94 // yes, subsequent contexts are assumed to be for dynamically
95 // created threads and are not initialized.
96 bool initialContextLoaded;
97
98 // thread contexts associated with this process
99 std::vector<ThreadContext *> threadContexts;
100
101 // remote gdb objects
102 std::vector<TheISA::RemoteGDB *> remoteGDB;
103 std::vector<GDBListener *> gdbListen;
104 bool breakpoint();
105
106 // number of CPUs (esxec contexts, really) assigned to this process.
107 unsigned int numCpus() { return threadContexts.size(); }
108
109 // record of blocked context
110 struct WaitRec
111 {
112 Addr waitChan;
113 ThreadContext *waitingContext;
114
115 WaitRec(Addr chan, ThreadContext *ctx)
116 : waitChan(chan), waitingContext(ctx)
117 { }
118 };
119
120 // list of all blocked contexts
121 std::list<WaitRec> waitList;
122
123 Addr brk_point; // top of the data segment
124
125 Addr stack_base; // stack segment base (highest address)
126 unsigned stack_size; // initial stack size
127 Addr stack_min; // lowest address accessed on the stack
128
129 // addr to use for next stack region (for multithreaded apps)
130 Addr next_thread_stack_base;
131
132 // Base of region for mmaps (when user doesn't specify an address).
133 Addr mmap_start;
134 Addr mmap_end;
135
136 // Base of region for nxm data
137 Addr nxm_start;
138 Addr nxm_end;
139
140 std::string prog_fname; // file name
141
142 Stats::Scalar<> num_syscalls; // number of syscalls executed
143
144
145 protected:
146 // constructor
147 Process(const std::string &nm,
148 System *_system,
149 int stdin_fd, // initial I/O descriptors
150 int stdout_fd,
151 int stderr_fd);
152
153 // post initialization startup
154 virtual void startup();
155
156 protected:
157 /// Memory object for initialization (image loading)
158 TranslatingPort *initVirtMem;
159
160 public:
161 PageTable *pTable;
162
163 private:
164 // file descriptor remapping support
165 static const int MAX_FD = 256; // max legal fd value
166 int fd_map[MAX_FD+1];
167
168 public:
169 // static helper functions to generate file descriptors for constructor
170 static int openInputFile(const std::string &filename);
171 static int openOutputFile(const std::string &filename);
172
173 // override of virtual SimObject method: register statistics
174 virtual void regStats();
175
176 // register a thread context for this process.
177 // returns tc's cpu number (index into threadContexts[])
178 int registerThreadContext(ThreadContext *tc);
179
180
181 void replaceThreadContext(ThreadContext *tc, int tcIndex);
182
183 // map simulator fd sim_fd to target fd tgt_fd
184 void dup_fd(int sim_fd, int tgt_fd);
185
186 // generate new target fd for sim_fd
187 int alloc_fd(int sim_fd);
188
189 // free target fd (e.g., after close)
190 void free_fd(int tgt_fd);
191
192 // look up simulator fd for given target fd
193 int sim_fd(int tgt_fd);
194
195 virtual void syscall(int64_t callnum, ThreadContext *tc) = 0;
196
62class Process : public SimObject
63{
64 public:
65
66 /// Pointer to object representing the system this process is
67 /// running on.
68 System *system;
69
70 // have we initialized a thread context from this process? If
71 // yes, subsequent contexts are assumed to be for dynamically
72 // created threads and are not initialized.
73 bool initialContextLoaded;
74
75 // thread contexts associated with this process
76 std::vector<ThreadContext *> threadContexts;
77
78 // remote gdb objects
79 std::vector<TheISA::RemoteGDB *> remoteGDB;
80 std::vector<GDBListener *> gdbListen;
81 bool breakpoint();
82
83 // number of CPUs (esxec contexts, really) assigned to this process.
84 unsigned int numCpus() { return threadContexts.size(); }
85
86 // record of blocked context
87 struct WaitRec
88 {
89 Addr waitChan;
90 ThreadContext *waitingContext;
91
92 WaitRec(Addr chan, ThreadContext *ctx)
93 : waitChan(chan), waitingContext(ctx)
94 { }
95 };
96
97 // list of all blocked contexts
98 std::list<WaitRec> waitList;
99
100 Addr brk_point; // top of the data segment
101
102 Addr stack_base; // stack segment base (highest address)
103 unsigned stack_size; // initial stack size
104 Addr stack_min; // lowest address accessed on the stack
105
106 // addr to use for next stack region (for multithreaded apps)
107 Addr next_thread_stack_base;
108
109 // Base of region for mmaps (when user doesn't specify an address).
110 Addr mmap_start;
111 Addr mmap_end;
112
113 // Base of region for nxm data
114 Addr nxm_start;
115 Addr nxm_end;
116
117 std::string prog_fname; // file name
118
119 Stats::Scalar<> num_syscalls; // number of syscalls executed
120
121
122 protected:
123 // constructor
124 Process(const std::string &nm,
125 System *_system,
126 int stdin_fd, // initial I/O descriptors
127 int stdout_fd,
128 int stderr_fd);
129
130 // post initialization startup
131 virtual void startup();
132
133 protected:
134 /// Memory object for initialization (image loading)
135 TranslatingPort *initVirtMem;
136
137 public:
138 PageTable *pTable;
139
140 private:
141 // file descriptor remapping support
142 static const int MAX_FD = 256; // max legal fd value
143 int fd_map[MAX_FD+1];
144
145 public:
146 // static helper functions to generate file descriptors for constructor
147 static int openInputFile(const std::string &filename);
148 static int openOutputFile(const std::string &filename);
149
150 // override of virtual SimObject method: register statistics
151 virtual void regStats();
152
153 // register a thread context for this process.
154 // returns tc's cpu number (index into threadContexts[])
155 int registerThreadContext(ThreadContext *tc);
156
157
158 void replaceThreadContext(ThreadContext *tc, int tcIndex);
159
160 // map simulator fd sim_fd to target fd tgt_fd
161 void dup_fd(int sim_fd, int tgt_fd);
162
163 // generate new target fd for sim_fd
164 int alloc_fd(int sim_fd);
165
166 // free target fd (e.g., after close)
167 void free_fd(int tgt_fd);
168
169 // look up simulator fd for given target fd
170 int sim_fd(int tgt_fd);
171
172 virtual void syscall(int64_t callnum, ThreadContext *tc) = 0;
173
174 // check if the this addr is on the next available page and allocate it
175 // if it's not we'll panic
176 bool checkAndAllocNextPage(Addr vaddr);
177
197 void serialize(std::ostream &os);
198 void unserialize(Checkpoint *cp, const std::string &section);
199};
200
201//
202// "Live" process with system calls redirected to host system
203//
204class ObjectFile;
205class LiveProcess : public Process
206{
207 protected:
208 ObjectFile *objFile;
209 std::vector<std::string> argv;
210 std::vector<std::string> envp;
211 std::string cwd;
212
213 LiveProcess(const std::string &nm, ObjectFile *objFile,
214 System *_system, int stdin_fd, int stdout_fd, int stderr_fd,
215 std::vector<std::string> &argv,
216 std::vector<std::string> &envp,
217 const std::string &cwd,
218 uint64_t _uid, uint64_t _euid,
219 uint64_t _gid, uint64_t _egid,
220 uint64_t _pid, uint64_t _ppid);
221
222 virtual void argsInit(int intSize, int pageSize);
223
224 // Id of the owner of the process
225 uint64_t __uid;
226 uint64_t __euid;
227 uint64_t __gid;
228 uint64_t __egid;
229
230 // pid of the process and it's parent
231 uint64_t __pid;
232 uint64_t __ppid;
233
234 public:
235
236 inline uint64_t uid() {return __uid;}
237 inline uint64_t euid() {return __euid;}
238 inline uint64_t gid() {return __gid;}
239 inline uint64_t egid() {return __egid;}
240 inline uint64_t pid() {return __pid;}
241 inline uint64_t ppid() {return __ppid;}
242
243 std::string
244 fullPath(const std::string &filename)
245 {
246 if (filename[0] == '/' || cwd.empty())
247 return filename;
248
249 std::string full = cwd;
250
251 if (cwd[cwd.size() - 1] != '/')
252 full += '/';
253
254 return full + filename;
255 }
256
257 virtual void syscall(int64_t callnum, ThreadContext *tc);
258
259 virtual SyscallDesc* getDesc(int callnum) = 0;
260
261 // this function is used to create the LiveProcess object, since
262 // we can't tell which subclass of LiveProcess to use until we
263 // open and look at the object file.
264 static LiveProcess *create(const std::string &nm,
265 System *_system,
266 int stdin_fd, int stdout_fd, int stderr_fd,
267 std::string executable,
268 std::vector<std::string> &argv,
269 std::vector<std::string> &envp,
270 const std::string &cwd,
271 uint64_t _uid, uint64_t _euid,
272 uint64_t _gid, uint64_t _egid,
273 uint64_t _pid, uint64_t _ppid);
274};
275
276
277#endif // !FULL_SYSTEM
278
279#endif // __PROCESS_HH__
178 void serialize(std::ostream &os);
179 void unserialize(Checkpoint *cp, const std::string &section);
180};
181
182//
183// "Live" process with system calls redirected to host system
184//
185class ObjectFile;
186class LiveProcess : public Process
187{
188 protected:
189 ObjectFile *objFile;
190 std::vector<std::string> argv;
191 std::vector<std::string> envp;
192 std::string cwd;
193
194 LiveProcess(const std::string &nm, ObjectFile *objFile,
195 System *_system, int stdin_fd, int stdout_fd, int stderr_fd,
196 std::vector<std::string> &argv,
197 std::vector<std::string> &envp,
198 const std::string &cwd,
199 uint64_t _uid, uint64_t _euid,
200 uint64_t _gid, uint64_t _egid,
201 uint64_t _pid, uint64_t _ppid);
202
203 virtual void argsInit(int intSize, int pageSize);
204
205 // Id of the owner of the process
206 uint64_t __uid;
207 uint64_t __euid;
208 uint64_t __gid;
209 uint64_t __egid;
210
211 // pid of the process and it's parent
212 uint64_t __pid;
213 uint64_t __ppid;
214
215 public:
216
217 inline uint64_t uid() {return __uid;}
218 inline uint64_t euid() {return __euid;}
219 inline uint64_t gid() {return __gid;}
220 inline uint64_t egid() {return __egid;}
221 inline uint64_t pid() {return __pid;}
222 inline uint64_t ppid() {return __ppid;}
223
224 std::string
225 fullPath(const std::string &filename)
226 {
227 if (filename[0] == '/' || cwd.empty())
228 return filename;
229
230 std::string full = cwd;
231
232 if (cwd[cwd.size() - 1] != '/')
233 full += '/';
234
235 return full + filename;
236 }
237
238 virtual void syscall(int64_t callnum, ThreadContext *tc);
239
240 virtual SyscallDesc* getDesc(int callnum) = 0;
241
242 // this function is used to create the LiveProcess object, since
243 // we can't tell which subclass of LiveProcess to use until we
244 // open and look at the object file.
245 static LiveProcess *create(const std::string &nm,
246 System *_system,
247 int stdin_fd, int stdout_fd, int stderr_fd,
248 std::string executable,
249 std::vector<std::string> &argv,
250 std::vector<std::string> &envp,
251 const std::string &cwd,
252 uint64_t _uid, uint64_t _euid,
253 uint64_t _gid, uint64_t _egid,
254 uint64_t _pid, uint64_t _ppid);
255};
256
257
258#endif // !FULL_SYSTEM
259
260#endif // __PROCESS_HH__