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 LiveProcessParams;
58 class TranslatingPort;
64 class Process : public SimObject
68 /// Pointer to object representing the system this process is
72 // have we initialized a thread context from this process? If
73 // yes, subsequent contexts are assumed to be for dynamically
74 // created threads and are not initialized.
75 bool initialContextLoaded;
77 bool checkpointRestored;
79 // thread contexts associated with this process
80 std::vector<ThreadContext *> threadContexts;
83 std::vector<TheISA::RemoteGDB *> remoteGDB;
84 std::vector<GDBListener *> gdbListen;
87 // number of CPUs (esxec contexts, really) assigned to this process.
88 unsigned int numCpus() { return threadContexts.size(); }
90 // record of blocked context
94 ThreadContext *waitingContext;
96 WaitRec(Addr chan, ThreadContext *ctx)
97 : waitChan(chan), waitingContext(ctx)
101 // list of all blocked contexts
102 std::list<WaitRec> waitList;
104 Addr brk_point; // top of the data segment
106 Addr stack_base; // stack segment base (highest address)
107 unsigned stack_size; // initial stack size
108 Addr stack_min; // lowest address accessed on the stack
110 // The maximum size allowed for the stack.
113 // addr to use for next stack region (for multithreaded apps)
114 Addr next_thread_stack_base;
116 // Base of region for mmaps (when user doesn't specify an address).
120 // Base of region for nxm data
124 std::string prog_fname; // file name
126 Stats::Scalar<> num_syscalls; // number of syscalls executed
131 Process(ProcessParams * params);
133 // post initialization startup
134 virtual void startup();
137 /// Memory object for initialization (image loading)
138 TranslatingPort *initVirtMem;
143 //This id is assigned by m5 and is used to keep process' tlb entries
148 // file descriptor remapping support
149 static const int MAX_FD = 256; // max legal fd value
150 int fd_map[MAX_FD+1];
153 // static helper functions to generate file descriptors for constructor
154 static int openInputFile(const std::string &filename);
155 static int openOutputFile(const std::string &filename);
157 // override of virtual SimObject method: register statistics
158 virtual void regStats();
160 // register a thread context for this process.
161 // returns tc's cpu number (index into threadContexts[])
162 int registerThreadContext(ThreadContext *tc);
165 void replaceThreadContext(ThreadContext *tc, int tcIndex);
167 // map simulator fd sim_fd to target fd tgt_fd
168 void dup_fd(int sim_fd, int tgt_fd);
170 // generate new target fd for sim_fd
171 int alloc_fd(int sim_fd);
173 // free target fd (e.g., after close)
174 void free_fd(int tgt_fd);
176 // look up simulator fd for given target fd
177 int sim_fd(int tgt_fd);
179 virtual void syscall(int64_t callnum, ThreadContext *tc) = 0;
181 // check if the this addr is on the next available page and allocate it
182 // if it's not we'll panic
183 bool checkAndAllocNextPage(Addr vaddr);
185 void serialize(std::ostream &os);
186 void unserialize(Checkpoint *cp, const std::string §ion);
190 // "Live" process with system calls redirected to host system
193 class LiveProcess : public Process
197 std::vector<std::string> argv;
198 std::vector<std::string> envp;
201 LiveProcess(LiveProcessParams * params, ObjectFile *objFile);
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 enum AuxiliaryVectorType {
233 // The following may be specific to Linux
240 M5_AT_VECTOR_SIZE = 44
243 inline uint64_t uid() {return __uid;}
244 inline uint64_t euid() {return __euid;}
245 inline uint64_t gid() {return __gid;}
246 inline uint64_t egid() {return __egid;}
247 inline uint64_t pid() {return __pid;}
248 inline uint64_t ppid() {return __ppid;}
251 fullPath(const std::string &filename)
253 if (filename[0] == '/' || cwd.empty())
256 std::string full = cwd;
258 if (cwd[cwd.size() - 1] != '/')
261 return full + filename;
264 virtual void syscall(int64_t callnum, ThreadContext *tc);
266 virtual SyscallDesc* getDesc(int callnum) = 0;
268 // this function is used to create the LiveProcess object, since
269 // we can't tell which subclass of LiveProcess to use until we
270 // open and look at the object file.
271 static LiveProcess *create(LiveProcessParams * params);
275 #endif // !FULL_SYSTEM
277 #endif // __PROCESS_HH__