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 "sim/host.hh"
49 #include "sim/sim_object.hh"
54 class TranslatingPort;
62 class Process : public SimObject
66 /// Pointer to object representing the system this process is
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;
75 // thread contexts associated with this process
76 std::vector<ThreadContext *> threadContexts;
79 std::vector<TheISA::RemoteGDB *> remoteGDB;
80 std::vector<GDBListener *> gdbListen;
83 // number of CPUs (esxec contexts, really) assigned to this process.
84 unsigned int numCpus() { return threadContexts.size(); }
86 // record of blocked context
90 ThreadContext *waitingContext;
92 WaitRec(Addr chan, ThreadContext *ctx)
93 : waitChan(chan), waitingContext(ctx)
97 // list of all blocked contexts
98 std::list<WaitRec> waitList;
100 Addr brk_point; // top of the data segment
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
106 // addr to use for next stack region (for multithreaded apps)
107 Addr next_thread_stack_base;
109 // Base of region for mmaps (when user doesn't specify an address).
113 // Base of region for nxm data
117 std::string prog_fname; // file name
119 Stats::Scalar<> num_syscalls; // number of syscalls executed
124 Process(const std::string &nm,
126 int stdin_fd, // initial I/O descriptors
130 // post initialization startup
131 virtual void startup();
134 /// Memory object for initialization (image loading)
135 TranslatingPort *initVirtMem;
141 // file descriptor remapping support
142 static const int MAX_FD = 256; // max legal fd value
143 int fd_map[MAX_FD+1];
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);
150 // override of virtual SimObject method: register statistics
151 virtual void regStats();
153 // register a thread context for this process.
154 // returns tc's cpu number (index into threadContexts[])
155 int registerThreadContext(ThreadContext *tc);
158 void replaceThreadContext(ThreadContext *tc, int tcIndex);
160 // map simulator fd sim_fd to target fd tgt_fd
161 void dup_fd(int sim_fd, int tgt_fd);
163 // generate new target fd for sim_fd
164 int alloc_fd(int sim_fd);
166 // free target fd (e.g., after close)
167 void free_fd(int tgt_fd);
169 // look up simulator fd for given target fd
170 int sim_fd(int tgt_fd);
172 virtual void syscall(int64_t callnum, ThreadContext *tc) = 0;
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);
178 void serialize(std::ostream &os);
179 void unserialize(Checkpoint *cp, const std::string §ion);
183 // "Live" process with system calls redirected to host system
186 class LiveProcess : public Process
190 std::vector<std::string> argv;
191 std::vector<std::string> envp;
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);
203 virtual void argsInit(int intSize, int pageSize);
205 // Id of the owner of the process
211 // pid of the process and it's parent
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;}
225 fullPath(const std::string &filename)
227 if (filename[0] == '/' || cwd.empty())
230 std::string full = cwd;
232 if (cwd[cwd.size() - 1] != '/')
235 return full + filename;
238 virtual void syscall(int64_t callnum, ThreadContext *tc);
240 virtual SyscallDesc* getDesc(int callnum) = 0;
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,
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);
258 #endif // !FULL_SYSTEM
260 #endif // __PROCESS_HH__