gem5  v22.0.0.2
process.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2014-2016 Advanced Micro Devices, Inc.
3  * Copyright (c) 2001-2005 The Regents of The University of Michigan
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are
8  * met: redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer;
10  * redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution;
13  * neither the name of the copyright holders nor the names of its
14  * contributors may be used to endorse or promote products derived from
15  * this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29 
30 #ifndef __PROCESS_HH__
31 #define __PROCESS_HH__
32 
33 #include <inttypes.h>
34 
35 #include <map>
36 #include <memory>
37 #include <string>
38 #include <vector>
39 
41 #include "base/statistics.hh"
42 #include "base/types.hh"
44 #include "sim/fd_array.hh"
45 #include "sim/fd_entry.hh"
46 #include "sim/mem_state.hh"
47 #include "sim/sim_object.hh"
48 
49 namespace gem5
50 {
51 
52 GEM5_DEPRECATED_NAMESPACE(Loader, loader);
53 namespace loader
54 {
55 class ObjectFile;
56 } // namespace loader
57 
58 struct ProcessParams;
59 
60 class EmulatedDriver;
61 class EmulationPageTable;
62 class SEWorkload;
63 class SyscallDesc;
64 class SyscallReturn;
65 class System;
66 class ThreadContext;
67 
68 class Process : public SimObject
69 {
70  public:
71  Process(const ProcessParams &params, EmulationPageTable *pTable,
72  loader::ObjectFile *obj_file);
73 
74  void serialize(CheckpointOut &cp) const override;
75  void unserialize(CheckpointIn &cp) override;
76 
77  void init() override;
78  void initState() override;
79  DrainState drain() override;
80 
81  virtual void syscall(ThreadContext *tc) { numSyscalls++; }
82 
83  inline uint64_t uid() { return _uid; }
84  inline uint64_t euid() { return _euid; }
85  inline uint64_t gid() { return _gid; }
86  inline uint64_t egid() { return _egid; }
87  inline uint64_t pid() { return _pid; }
88  inline uint64_t ppid() { return _ppid; }
89  inline uint64_t pgid() { return _pgid; }
90  inline void pgid(uint64_t pgid) { _pgid = pgid; }
91  inline uint64_t tgid() { return _tgid; }
92 
93  const char *progName() const { return executable.c_str(); }
94 
101  EmulatedDriver *findDriver(std::string filename);
102 
103  // This function acts as a callback to update the bias value in
104  // the object file because the parameters needed to calculate the
105  // bias are not available when the object file is created.
106  void updateBias();
107  Addr getBias();
108  Addr getStartPC();
110 
111  // This function allocates physical memory as backing store, and then maps
112  // it into the virtual address space of the process. The range of virtual
113  // addresses being configured starts at the address "vaddr" and is of size
114  // "size" bytes. If some part of this range of virtual addresses is already
115  // configured, this function will error out unless "clobber" is set. If
116  // clobber is set, then those existing mappings will be replaced.
117  //
118  // If the beginning or end of the virtual address range does not perfectly
119  // align to page boundaries, it will be expanded in either direction until
120  // it does. This function will therefore set up *at least* the range
121  // requested, and may configure more if necessary.
122  void allocateMem(Addr vaddr, int64_t size, bool clobber=false);
123 
126  bool fixupFault(Addr vaddr);
127 
128  // After getting registered with system object, tell process which
129  // system-wide context id it is assigned.
130  void
132  {
133  contextIds.push_back(context_id);
134  }
135 
140  void revokeThreadContext(int context_id);
141 
147  virtual bool mmapGrowsDown() const { return true; }
148 
162  bool map(Addr vaddr, Addr paddr, int size, bool cacheable = true);
163 
164  void replicatePage(Addr vaddr, Addr new_paddr, ThreadContext *old_tc,
165  ThreadContext *new_tc, bool alloc_page);
166 
167  virtual void clone(ThreadContext *old_tc, ThreadContext *new_tc,
168  Process *new_p, RegVal flags);
169 
170  // thread contexts associated with this process
172 
173  // system object which owns this process
175 
177 
178  // flag for using architecture specific page table
179  bool useArchPT;
180  // running KVM requires special initialization
181  bool kvmInSE;
182  // flag for using the process as a thread which shares page tables
184 
186 
187  // Memory proxy for initial image load.
188  std::unique_ptr<SETranslatingPortProxy> initVirtMem;
189 
196  class Loader
197  {
198  public:
199  Loader();
200 
201  /* Loader instances are singletons. */
202  Loader(const Loader &) = delete;
203  void operator=(const Loader &) = delete;
204 
205  virtual ~Loader() {}
206 
215  virtual Process *load(const ProcessParams &params,
216  loader::ObjectFile *obj_file) = 0;
217  };
218 
219  // Try all the Loader instance's "load" methods one by one until one is
220  // successful. If none are, complain and fail.
221  static Process *tryLoaders(const ProcessParams &params,
222  loader::ObjectFile *obj_file);
223 
229  std::string executable;
230 
244  std::string absolutePath(const std::string &path, bool host_fs);
245 
254  std::string checkPathRedirect(const std::string &filename);
255 
266  std::string tgtCwd;
267  std::string hostCwd;
268 
269  // Syscall emulation uname release.
270  std::string release;
271 
272  // Id of the owner of the process
273  uint64_t _uid;
274  uint64_t _euid;
275  uint64_t _gid;
276  uint64_t _egid;
277 
278  // pid of the process and it's parent
279  uint64_t _pid;
280  uint64_t _ppid;
281  uint64_t _pgid;
282  uint64_t _tgid;
283 
284  // Emulated drivers available to this process
286 
287  std::shared_ptr<FDArray> fds;
288 
289  bool *exitGroup;
290  std::shared_ptr<MemState> memState;
291 
296  uint64_t childClearTID;
297 
298  // Process was forked with SIGCHLD set.
299  bool *sigchld;
300 
301  // Contexts to wake up when this thread exits or calls execve
303 
304  // Track how many system calls are executed
306 };
307 
308 } // namespace gem5
309 
310 #endif // __PROCESS_HH__
gem5::statistics::Scalar
This is a simple scalar statistic, like a counter.
Definition: statistics.hh:1930
gem5::Process::assignThreadContext
void assignThreadContext(ContextID context_id)
Definition: process.hh:131
gem5::Process::euid
uint64_t euid()
Definition: process.hh:84
gem5::Process::drivers
std::vector< EmulatedDriver * > drivers
Definition: process.hh:285
gem5::Process::tgid
uint64_t tgid()
Definition: process.hh:91
gem5::EmulationPageTable
Definition: page_table.hh:53
gem5::loader::ObjectFile
Definition: object_file.hh:97
gem5::RegVal
uint64_t RegVal
Definition: types.hh:173
gem5::Process::interpImage
loader::MemoryImage interpImage
Definition: process.hh:226
gem5::Process::progName
const char * progName() const
Definition: process.hh:93
gem5::Process::clone
virtual void clone(ThreadContext *old_tc, ThreadContext *new_tc, Process *new_p, RegVal flags)
Definition: process.cc:167
gem5::Process::useArchPT
bool useArchPT
Definition: process.hh:179
fd_entry.hh
gem5::Process::findDriver
EmulatedDriver * findDriver(std::string filename)
Find an emulated device driver.
Definition: process.cc:413
gem5::Process::getStartPC
Addr getStartPC()
Definition: process.cc:497
gem5::Process::initVirtMem
std::unique_ptr< SETranslatingPortProxy > initVirtMem
Definition: process.hh:188
gem5::Process::tgtCwd
std::string tgtCwd
The cwd members are used to track changes to the current working directory for the purpose of executi...
Definition: process.hh:266
gem5::Process::Loader::~Loader
virtual ~Loader()
Definition: process.hh:205
gem5::Process::numSyscalls
statistics::Scalar numSyscalls
Definition: process.hh:305
gem5::Process::getBias
Addr getBias()
Definition: process.cc:489
gem5::Serializable::path
static std::stack< std::string > path
Definition: serialize.hh:315
gem5::Process::_pgid
uint64_t _pgid
Definition: process.hh:281
gem5::Process::release
std::string release
Definition: process.hh:270
gem5::CheckpointIn
Definition: serialize.hh:68
gem5::Process::updateBias
void updateBias()
Definition: process.cc:457
gem5::Process::initState
void initState() override
initState() is called on each SimObject when not restoring from a checkpoint.
Definition: process.cc:288
gem5::Process::_pid
uint64_t _pid
Definition: process.hh:279
gem5::Process::egid
uint64_t egid()
Definition: process.hh:86
std::vector< ContextID >
gem5::Process::pid
uint64_t pid()
Definition: process.hh:87
gem5::Process::_euid
uint64_t _euid
Definition: process.hh:274
fd_array.hh
gem5::Process::seWorkload
SEWorkload * seWorkload
Definition: process.hh:176
gem5::Process::fds
std::shared_ptr< FDArray > fds
Definition: process.hh:287
gem5::Process::pgid
void pgid(uint64_t pgid)
Definition: process.hh:90
gem5::Process::gid
uint64_t gid()
Definition: process.hh:85
mem_state.hh
gem5::Process::serialize
void serialize(CheckpointOut &cp) const override
Serialize an object.
Definition: process.cc:371
gem5::Process::useForClone
bool useForClone
Definition: process.hh:183
gem5::Process::memState
std::shared_ptr< MemState > memState
Definition: process.hh:290
gem5::Process::syscall
virtual void syscall(ThreadContext *tc)
Definition: process.hh:81
gem5::Process::allocateMem
void allocateMem(Addr vaddr, int64_t size, bool clobber=false)
Definition: process.cc:317
gem5::Process::fixupFault
bool fixupFault(Addr vaddr)
Attempt to fix up a fault at vaddr by allocating a page on the stack.
Definition: process.cc:365
gem5::Process::childClearTID
uint64_t childClearTID
Calls a futex wakeup at the address specified by this pointer when this process exits.
Definition: process.hh:296
gem5::Process::Loader::Loader
Loader()
Definition: process.cc:87
gem5::Process::uid
uint64_t uid()
Definition: process.hh:83
gem5::Process::_tgid
uint64_t _tgid
Definition: process.hh:282
gem5::DrainState
DrainState
Object drain/handover states.
Definition: drain.hh:74
gem5::Process::ppid
uint64_t ppid()
Definition: process.hh:88
gem5::Process::tryLoaders
static Process * tryLoaders(const ProcessParams &params, loader::ObjectFile *obj_file)
Definition: process.cc:93
gem5::System
Definition: system.hh:75
gem5::ThreadContext
ThreadContext is the external interface to all thread state for anything outside of the CPU.
Definition: thread_context.hh:94
gem5::Process::unserialize
void unserialize(CheckpointIn &cp) override
Unserialize an object.
Definition: process.cc:386
gem5::SimObject::params
const Params & params() const
Definition: sim_object.hh:176
sim_object.hh
gem5::Process::pTable
EmulationPageTable * pTable
Definition: process.hh:185
statistics.hh
gem5::Process::Loader::load
virtual Process * load(const ProcessParams &params, loader::ObjectFile *obj_file)=0
Each subclass needs to implement this method.
gem5::Process::exitGroup
bool * exitGroup
Definition: process.hh:289
gem5::loader::MemoryImage
Definition: memory_image.hh:53
gem5::Process::argv
std::vector< std::string > argv
Definition: process.hh:227
gem5::Process::absolutePath
std::string absolutePath(const std::string &path, bool host_fs)
Return an absolute path given a relative path paired with the current working directory of the proces...
Definition: process.cc:505
flags
uint8_t flags
Definition: helpers.cc:66
gem5::Process::executable
std::string executable
Definition: process.hh:229
gem5::Process::Process
Process(const ProcessParams &params, EmulationPageTable *pTable, loader::ObjectFile *obj_file)
Definition: process.cc:113
gem5::Process::checkPathRedirect
std::string checkPathRedirect(const std::string &filename)
Redirect file path if it matches any keys initialized by system object.
Definition: process.cc:424
gem5::SimObject
Abstract superclass for simulation objects.
Definition: sim_object.hh:146
gem5::Process::replicatePage
void replicatePage(Addr vaddr, Addr new_paddr, ThreadContext *old_tc, ThreadContext *new_tc, bool alloc_page)
Definition: process.cc:347
gem5::ArmISA::SEWorkload
Definition: se_workload.hh:42
gem5::Process::_egid
uint64_t _egid
Definition: process.hh:276
gem5::Process::getInterpreter
loader::ObjectFile * getInterpreter()
Definition: process.cc:483
gem5::Addr
uint64_t Addr
Address type This will probably be moved somewhere else in the near future.
Definition: types.hh:147
gem5::Process::envp
std::vector< std::string > envp
Definition: process.hh:228
gem5::GEM5_DEPRECATED_NAMESPACE
GEM5_DEPRECATED_NAMESPACE(GuestABI, guest_abi)
gem5::Process
Definition: process.hh:68
gem5::EmulatedDriver
EmulatedDriver is an abstract base class for fake SE-mode device drivers.
Definition: emul_driver.hh:55
gem5::Process::map
bool map(Addr vaddr, Addr paddr, int size, bool cacheable=true)
Maps a contiguous range of virtual addresses in this process's address space to a contiguous range of...
Definition: process.cc:404
types.hh
gem5::ContextID
int ContextID
Globally unique thread context ID.
Definition: types.hh:239
gem5::Process::sigchld
bool * sigchld
Definition: process.hh:299
gem5::Process::_gid
uint64_t _gid
Definition: process.hh:275
gem5::Process::_ppid
uint64_t _ppid
Definition: process.hh:280
gem5::Process::system
System * system
Definition: process.hh:174
gem5::Process::mmapGrowsDown
virtual bool mmapGrowsDown() const
Does mmap region grow upward or downward from mmapEnd? Most platforms grow downward,...
Definition: process.hh:147
gem5::Process::pgid
uint64_t pgid()
Definition: process.hh:89
gem5::Process::revokeThreadContext
void revokeThreadContext(int context_id)
After delegating a thread context to a child process no longer should relate to the ThreadContext.
Definition: process.cc:265
gem5::Process::init
void init() override
init() is called after all C++ SimObjects have been created and all ports are connected.
Definition: process.cc:278
gem5::CheckpointOut
std::ostream CheckpointOut
Definition: serialize.hh:66
gem5::Process::_uid
uint64_t _uid
Definition: process.hh:273
gem5::Process::contextIds
std::vector< ContextID > contextIds
Definition: process.hh:171
se_translating_port_proxy.hh
gem5::Process::drain
DrainState drain() override
Draining is the process of clearing out the states of SimObjects.These are the SimObjects that are pa...
Definition: process.cc:310
gem5::MipsISA::vaddr
vaddr
Definition: pra_constants.hh:278
gem5::Process::hostCwd
std::string hostCwd
Definition: process.hh:267
gem5::Process::Loader::operator=
void operator=(const Loader &)=delete
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: gpu_translation_state.hh:37
gem5::Process::vforkContexts
std::vector< ContextID > vforkContexts
Definition: process.hh:302
gem5::Process::kvmInSE
bool kvmInSE
Definition: process.hh:181
memory_image.hh
gem5::Process::image
loader::MemoryImage image
Definition: process.hh:225
gem5::Process::objFile
loader::ObjectFile * objFile
Definition: process.hh:224
gem5::Process::Loader
Each instance of a Loader subclass will have a chance to try to load an object file when tryLoaders i...
Definition: process.hh:196

Generated on Thu Jul 28 2022 13:32:24 for gem5 by doxygen 1.8.17