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"
46 #include "base/statistics.hh"
47 #include "sim/sim_object.hh"
52 class TranslatingPort;
56 copyStringArray(std::vector<std::string> &strings, Addr array_ptr,
57 Addr data_ptr, TranslatingPort* memPort);
59 class Process : public SimObject
63 /// Pointer to object representing the system this process is
67 // have we initialized a thread context from this process? If
68 // yes, subsequent contexts are assumed to be for dynamically
69 // created threads and are not initialized.
70 bool initialContextLoaded;
72 // thread contexts associated with this process
73 std::vector<ThreadContext *> threadContexts;
75 // number of CPUs (esxec contexts, really) assigned to this process.
76 unsigned int numCpus() { return threadContexts.size(); }
78 // Id of the owner of the process
84 // pid of the process and it's parent
88 // record of blocked context
92 ThreadContext *waitingContext;
94 WaitRec(Addr chan, ThreadContext *ctx)
95 : waitChan(chan), waitingContext(ctx)
99 // list of all blocked contexts
100 std::list<WaitRec> waitList;
102 Addr brk_point; // top of the data segment
104 Addr stack_base; // stack segment base (highest address)
105 unsigned stack_size; // initial stack size
106 Addr stack_min; // lowest address accessed on the stack
108 // addr to use for next stack region (for multithreaded apps)
109 Addr next_thread_stack_base;
111 // Base of region for mmaps (when user doesn't specify an address).
115 // Base of region for nxm data
119 std::string prog_fname; // file name
121 Stats::Scalar<> num_syscalls; // number of syscalls executed
126 Process(const std::string &nm,
128 int stdin_fd, // initial I/O descriptors
132 // post initialization startup
133 virtual void startup();
136 /// Memory object for initialization (image loading)
137 TranslatingPort *initVirtMem;
143 // file descriptor remapping support
144 static const int MAX_FD = 256; // max legal fd value
145 int fd_map[MAX_FD+1];
148 // static helper functions to generate file descriptors for constructor
149 static int openInputFile(const std::string &filename);
150 static int openOutputFile(const std::string &filename);
152 // override of virtual SimObject method: register statistics
153 virtual void regStats();
155 // register a thread context for this process.
156 // returns tc's cpu number (index into threadContexts[])
157 int registerThreadContext(ThreadContext *tc);
160 void replaceThreadContext(ThreadContext *tc, int tcIndex);
162 // map simulator fd sim_fd to target fd tgt_fd
163 void dup_fd(int sim_fd, int tgt_fd);
165 // generate new target fd for sim_fd
166 int alloc_fd(int sim_fd);
168 // free target fd (e.g., after close)
169 void free_fd(int tgt_fd);
171 // look up simulator fd for given target fd
172 int sim_fd(int tgt_fd);
174 virtual void syscall(int64_t callnum, ThreadContext *tc) = 0;
178 // "Live" process with system calls redirected to host system
181 class LiveProcess : public Process
185 std::vector<std::string> argv;
186 std::vector<std::string> envp;
188 LiveProcess(const std::string &nm, ObjectFile *objFile,
189 System *_system, int stdin_fd, int stdout_fd, int stderr_fd,
190 std::vector<std::string> &argv,
191 std::vector<std::string> &envp);
193 virtual void argsInit(int intSize, int pageSize);
196 virtual void syscall(int64_t callnum, ThreadContext *tc);
198 virtual SyscallDesc* getDesc(int callnum) = 0;
200 // this function is used to create the LiveProcess object, since
201 // we can't tell which subclass of LiveProcess to use until we
202 // open and look at the object file.
203 static LiveProcess *create(const std::string &nm,
205 int stdin_fd, int stdout_fd, int stderr_fd,
206 std::string executable,
207 std::vector<std::string> &argv,
208 std::vector<std::string> &envp);
212 #endif // !FULL_SYSTEM
214 #endif // __PROCESS_HH__