2 * Copyright (c) 2001-2005 The Regents of The University of Michigan
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.
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.
28 * Authors: Nathan Binkert
32 #ifndef __PROCESS_HH__
33 #define __PROCESS_HH__
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.
40 #include "config/full_system.hh"
47 #include "base/statistics.hh"
48 #include "mem/translating_port.hh"
49 #include "sim/host.hh"
50 #include "sim/sim_object.hh"
55 class TranslatingPort;
63 //This needs to be templated for cases where 32 bit pointers are needed.
64 template<class AddrType>
66 copyStringArray(std::vector<std::string> &strings,
67 AddrType array_ptr, AddrType data_ptr,
68 TranslatingPort* memPort)
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,
75 memPort->writeString(data_ptr, strings[i].c_str());
76 array_ptr += sizeof(AddrType);
77 data_ptr += strings[i].size() + 1;
79 // add NULL terminator
82 memPort->writeBlob(array_ptr, (uint8_t*)&data_ptr, sizeof(AddrType));
85 class Process : public SimObject
89 /// Pointer to object representing the system this process is
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;
98 // thread contexts associated with this process
99 std::vector<ThreadContext *> threadContexts;
101 // remote gdb objects
102 std::vector<TheISA::RemoteGDB *> remoteGDB;
103 std::vector<GDBListener *> gdbListen;
106 // number of CPUs (esxec contexts, really) assigned to this process.
107 unsigned int numCpus() { return threadContexts.size(); }
109 // record of blocked context
113 ThreadContext *waitingContext;
115 WaitRec(Addr chan, ThreadContext *ctx)
116 : waitChan(chan), waitingContext(ctx)
120 // list of all blocked contexts
121 std::list<WaitRec> waitList;
123 Addr brk_point; // top of the data segment
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
129 // addr to use for next stack region (for multithreaded apps)
130 Addr next_thread_stack_base;
132 // Base of region for mmaps (when user doesn't specify an address).
136 // Base of region for nxm data
140 std::string prog_fname; // file name
142 Stats::Scalar<> num_syscalls; // number of syscalls executed
147 Process(const std::string &nm,
149 int stdin_fd, // initial I/O descriptors
153 // post initialization startup
154 virtual void startup();
157 /// Memory object for initialization (image loading)
158 TranslatingPort *initVirtMem;
164 // file descriptor remapping support
165 static const int MAX_FD = 256; // max legal fd value
166 int fd_map[MAX_FD+1];
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);
173 // override of virtual SimObject method: register statistics
174 virtual void regStats();
176 // register a thread context for this process.
177 // returns tc's cpu number (index into threadContexts[])
178 int registerThreadContext(ThreadContext *tc);
181 void replaceThreadContext(ThreadContext *tc, int tcIndex);
183 // map simulator fd sim_fd to target fd tgt_fd
184 void dup_fd(int sim_fd, int tgt_fd);
186 // generate new target fd for sim_fd
187 int alloc_fd(int sim_fd);
189 // free target fd (e.g., after close)
190 void free_fd(int tgt_fd);
192 // look up simulator fd for given target fd
193 int sim_fd(int tgt_fd);
195 virtual void syscall(int64_t callnum, ThreadContext *tc) = 0;
197 void serialize(std::ostream &os);
198 void unserialize(Checkpoint *cp, const std::string §ion);
202 // "Live" process with system calls redirected to host system
205 class LiveProcess : public Process
209 std::vector<std::string> argv;
210 std::vector<std::string> envp;
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);
222 virtual void argsInit(int intSize, int pageSize);
224 // Id of the owner of the process
230 // pid of the process and it's parent
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;}
244 fullPath(const std::string &filename)
246 if (filename[0] == '/' || cwd.empty())
249 std::string full = cwd;
251 if (cwd[cwd.size() - 1] != '/')
254 return full + filename;
257 virtual void syscall(int64_t callnum, ThreadContext *tc);
259 virtual SyscallDesc* getDesc(int callnum) = 0;
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,
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);
277 #endif // !FULL_SYSTEM
279 #endif // __PROCESS_HH__