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 "arch/registers.hh"
48 #include "base/statistics.hh"
49 #include "base/types.hh"
50 #include "sim/sim_object.hh"
51 #include "sim/syscallreturn.hh"
56 class LiveProcessParams;
60 class TranslatingPort;
66 template<class IntType>
75 AuxVector(IntType type, IntType val);
78 class Process : public SimObject
82 /// Pointer to object representing the system this process is
86 // have we initialized a thread context from this process? If
87 // yes, subsequent contexts are assumed to be for dynamically
88 // created threads and are not initialized.
89 bool initialContextLoaded;
91 bool checkpointRestored;
93 // thread contexts associated with this process
94 std::vector<int> contextIds;
97 std::vector<TheISA::RemoteGDB *> remoteGDB;
98 std::vector<GDBListener *> gdbListen;
101 // number of CPUs (esxec contexts, really) assigned to this process.
102 unsigned int numCpus() { return contextIds.size(); }
104 // record of blocked context
108 ThreadContext *waitingContext;
110 WaitRec(Addr chan, ThreadContext *ctx)
111 : waitChan(chan), waitingContext(ctx)
115 // list of all blocked contexts
116 std::list<WaitRec> waitList;
118 Addr brk_point; // top of the data segment
120 Addr stack_base; // stack segment base (highest address)
121 unsigned stack_size; // initial stack size
122 Addr stack_min; // lowest address accessed on the stack
124 // The maximum size allowed for the stack.
127 // addr to use for next stack region (for multithreaded apps)
128 Addr next_thread_stack_base;
130 // Base of region for mmaps (when user doesn't specify an address).
134 // Base of region for nxm data
138 std::string prog_fname; // file name
140 Stats::Scalar num_syscalls; // number of syscalls executed
145 Process(ProcessParams * params);
147 // post initialization startup
148 virtual void startup();
151 /// Memory object for initialization (image loading)
152 TranslatingPort *initVirtMem;
157 //This id is assigned by m5 and is used to keep process' tlb entries
165 std::string filename;
185 void serialize(std::ostream &os);
186 void unserialize(Checkpoint *cp, const std::string §ion);
191 // file descriptor remapping support
192 static const int MAX_FD = 256; // max legal fd value
193 FdMap fd_map[MAX_FD+1];
197 // static helper functions to generate file descriptors for constructor
198 static int openInputFile(const std::string &filename);
199 static int openOutputFile(const std::string &filename);
201 // override of virtual SimObject method: register statistics
202 virtual void regStats();
204 // After getting registered with system object, tell process which
205 // system-wide context id it is assigned.
206 void assignThreadContext(int context_id)
208 contextIds.push_back(context_id);
211 // Find a free context to use
212 ThreadContext * findFreeContext();
214 // map simulator fd sim_fd to target fd tgt_fd
215 void dup_fd(int sim_fd, int tgt_fd);
217 // generate new target fd for sim_fd
218 int alloc_fd(int sim_fd, std::string filename, int flags, int mode, bool pipe);
220 // free target fd (e.g., after close)
221 void free_fd(int tgt_fd);
223 // look up simulator fd for given target fd
224 int sim_fd(int tgt_fd);
226 // look up simulator fd_map object for a given target fd
227 FdMap * sim_fd_obj(int tgt_fd);
229 // fix all offsets for currently open files and save them
230 void fix_file_offsets();
232 // find all offsets for currently open files and save them
233 void find_file_offsets();
235 // set the source of this read pipe for a checkpoint resume
236 void setReadPipeSource(int read_pipe_fd, int source_fd);
238 virtual void syscall(int64_t callnum, ThreadContext *tc) = 0;
240 // check if the this addr is on the next available page and allocate it
241 // if it's not we'll panic
242 bool checkAndAllocNextPage(Addr vaddr);
244 void serialize(std::ostream &os);
245 void unserialize(Checkpoint *cp, const std::string §ion);
249 // "Live" process with system calls redirected to host system
252 class LiveProcess : public Process
256 std::vector<std::string> argv;
257 std::vector<std::string> envp;
260 LiveProcess(LiveProcessParams * params, ObjectFile *objFile);
262 virtual void argsInit(int intSize, int pageSize);
264 // Id of the owner of the process
270 // pid of the process and it's parent
276 enum AuxiliaryVectorType {
292 // The following may be specific to Linux
298 M5_BASE_PLATFORM = 24,
303 M5_AT_VECTOR_SIZE = 44
306 inline uint64_t uid() {return __uid;}
307 inline uint64_t euid() {return __euid;}
308 inline uint64_t gid() {return __gid;}
309 inline uint64_t egid() {return __egid;}
310 inline uint64_t pid() {return __pid;}
311 inline uint64_t ppid() {return __ppid;}
314 fullPath(const std::string &filename)
316 if (filename[0] == '/' || cwd.empty())
319 std::string full = cwd;
321 if (cwd[cwd.size() - 1] != '/')
324 return full + filename;
327 std::string getcwd() const { return cwd; }
329 virtual void syscall(int64_t callnum, ThreadContext *tc);
330 virtual TheISA::IntReg getSyscallArg(ThreadContext *tc, int i) = 0;
331 virtual void setSyscallArg(ThreadContext *tc,
332 int i, TheISA::IntReg val) = 0;
333 virtual void setSyscallReturn(ThreadContext *tc,
334 SyscallReturn return_value) = 0;
336 virtual SyscallDesc* getDesc(int callnum) = 0;
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);
345 #endif // !FULL_SYSTEM
347 #endif // __PROCESS_HH__