gem5 v24.0.0.0
Loading...
Searching...
No Matches
gem5::Process Class Reference

#include <process.hh>

Inheritance diagram for gem5::Process:
gem5::SimObject gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named gem5::ArmProcess gem5::MipsProcess gem5::PowerProcess gem5::RiscvProcess gem5::SparcProcess gem5::X86ISA::X86Process gem5::ArmProcess32 gem5::ArmProcess64 gem5::RiscvProcess32 gem5::RiscvProcess64 gem5::Sparc32Process gem5::Sparc64Process gem5::X86ISA::I386Process gem5::X86ISA::X86_64Process

Classes

class  Loader
 Each instance of a Loader subclass will have a chance to try to load an object file when tryLoaders is called. More...
 

Public Member Functions

 Process (const ProcessParams &params, EmulationPageTable *pTable, loader::ObjectFile *obj_file)
 
void serialize (CheckpointOut &cp) const override
 Serialize an object.
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object.
 
void init () override
 init() is called after all C++ SimObjects have been created and all ports are connected.
 
void initState () override
 initState() is called on each SimObject when not restoring from a checkpoint.
 
DrainState drain () override
 Draining is the process of clearing out the states of SimObjects.These are the SimObjects that are partially executed or are partially in flight.
 
virtual void syscall (ThreadContext *tc)
 
uint64_t uid ()
 
uint64_t euid ()
 
uint64_t gid ()
 
uint64_t egid ()
 
uint64_t pid ()
 
uint64_t ppid ()
 
uint64_t pgid ()
 
void pgid (uint64_t pgid)
 
uint64_t tgid ()
 
const char * progName () const
 
EmulatedDriverfindDriver (std::string filename)
 Find an emulated device driver.
 
void updateBias ()
 
Addr getBias ()
 
Addr getStartPC ()
 
loader::ObjectFilegetInterpreter ()
 
void allocateMem (Addr vaddr, int64_t size, bool clobber=false)
 
bool fixupFault (Addr vaddr)
 Attempt to fix up a fault at vaddr by allocating a page on the stack.
 
void assignThreadContext (ContextID context_id)
 
void revokeThreadContext (int context_id)
 After delegating a thread context to a child process no longer should relate to the ThreadContext.
 
virtual bool mmapGrowsDown () const
 Does mmap region grow upward or downward from mmapEnd? Most platforms grow downward, but a few (such as Alpha) grow upward instead, so they can override this method to return false.
 
bool map (Addr vaddr, Addr paddr, int64_t size, bool cacheable=true)
 Maps a contiguous range of virtual addresses in this process's address space to a contiguous range of physical addresses.
 
void replicatePage (Addr vaddr, Addr new_paddr, ThreadContext *old_tc, ThreadContext *new_tc, bool alloc_page)
 
virtual void clone (ThreadContext *old_tc, ThreadContext *new_tc, Process *new_p, RegVal flags)
 
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 process running under simulation.
 
std::string checkPathRedirect (const std::string &filename)
 Redirect file path if it matches any keys initialized by system object.
 
- Public Member Functions inherited from gem5::SimObject
const Paramsparams () const
 
 SimObject (const Params &p)
 
virtual ~SimObject ()
 
virtual void loadState (CheckpointIn &cp)
 loadState() is called on each SimObject when restoring from a checkpoint.
 
virtual void regProbePoints ()
 Register probe points for this object.
 
virtual void regProbeListeners ()
 Register probe listeners for this object.
 
ProbeManagergetProbeManager ()
 Get the probe manager for this object.
 
virtual PortgetPort (const std::string &if_name, PortID idx=InvalidPortID)
 Get a port with a given name and index.
 
virtual void startup ()
 startup() is the final initialization call before simulation.
 
DrainState drain () override
 Provide a default implementation of the drain interface for objects that don't need draining.
 
virtual void memWriteback ()
 Write back dirty buffers to memory using functional writes.
 
virtual void memInvalidate ()
 Invalidate the contents of memory buffers.
 
void serialize (CheckpointOut &cp) const override
 Serialize an object.
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object.
 
- Public Member Functions inherited from gem5::EventManager
EventQueueeventQueue () const
 
void schedule (Event &event, Tick when)
 
void deschedule (Event &event)
 
void reschedule (Event &event, Tick when, bool always=false)
 
void schedule (Event *event, Tick when)
 
void deschedule (Event *event)
 
void reschedule (Event *event, Tick when, bool always=false)
 
void wakeupEventQueue (Tick when=(Tick) -1)
 This function is not needed by the usual gem5 event loop but may be necessary in derived EventQueues which host gem5 on other schedulers.
 
void setCurTick (Tick newVal)
 
 EventManager (EventManager &em)
 Event manger manages events in the event queue.
 
 EventManager (EventManager *em)
 
 EventManager (EventQueue *eq)
 
- Public Member Functions inherited from gem5::Serializable
 Serializable ()
 
virtual ~Serializable ()
 
void serializeSection (CheckpointOut &cp, const char *name) const
 Serialize an object into a new section.
 
void serializeSection (CheckpointOut &cp, const std::string &name) const
 
void unserializeSection (CheckpointIn &cp, const char *name)
 Unserialize an a child object.
 
void unserializeSection (CheckpointIn &cp, const std::string &name)
 
- Public Member Functions inherited from gem5::Drainable
DrainState drainState () const
 Return the current drain state of an object.
 
virtual void notifyFork ()
 Notify a child process of a fork.
 
- Public Member Functions inherited from gem5::statistics::Group
 Group (Group *parent, const char *name=nullptr)
 Construct a new statistics group.
 
virtual ~Group ()
 
virtual void regStats ()
 Callback to set stat parameters.
 
virtual void resetStats ()
 Callback to reset stats.
 
virtual void preDumpStats ()
 Callback before stats are dumped.
 
void addStat (statistics::Info *info)
 Register a stat with this group.
 
const std::map< std::string, Group * > & getStatGroups () const
 Get all child groups associated with this object.
 
const std::vector< Info * > & getStats () const
 Get all stats associated with this object.
 
void addStatGroup (const char *name, Group *block)
 Add a stat block as a child of this block.
 
const InforesolveStat (std::string name) const
 Resolve a stat by its name within this group.
 
void mergeStatGroup (Group *block)
 Merge the contents (stats & children) of a block to this block.
 
 Group ()=delete
 
 Group (const Group &)=delete
 
Groupoperator= (const Group &)=delete
 
- Public Member Functions inherited from gem5::Named
 Named (const std::string &name_)
 
virtual ~Named ()=default
 
virtual std::string name () const
 

Static Public Member Functions

static ProcesstryLoaders (const ProcessParams &params, loader::ObjectFile *obj_file)
 
- Static Public Member Functions inherited from gem5::SimObject
static void serializeAll (const std::string &cpt_dir)
 Create a checkpoint by serializing all SimObjects in the system.
 
static SimObjectfind (const char *name)
 Find the SimObject with the given name and return a pointer to it.
 
static void setSimObjectResolver (SimObjectResolver *resolver)
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.
 
static SimObjectResolvergetSimObjectResolver ()
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.
 
- Static Public Member Functions inherited from gem5::Serializable
static const std::string & currentSection ()
 Gets the fully-qualified name of the active section.
 
static void generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
 Generate a checkpoint file so that the serialization can be routed to it.
 

Public Attributes

std::vector< ContextIDcontextIds
 
Systemsystem
 
SEWorkloadseWorkload
 
bool useArchPT
 
bool kvmInSE
 
bool useForClone
 
EmulationPageTablepTable
 
std::unique_ptr< SETranslatingPortProxyinitVirtMem
 
loader::ObjectFileobjFile
 
loader::MemoryImage image
 
loader::MemoryImage interpImage
 
std::vector< std::string > argv
 
std::vector< std::string > envp
 
std::string executable
 
std::string tgtCwd
 The cwd members are used to track changes to the current working directory for the purpose of executing system calls which depend on relative paths (i.e.
 
std::string hostCwd
 
std::string release
 
uint64_t _uid
 
uint64_t _euid
 
uint64_t _gid
 
uint64_t _egid
 
uint64_t _pid
 
uint64_t _ppid
 
uint64_t _pgid
 
uint64_t _tgid
 
std::vector< EmulatedDriver * > drivers
 
std::shared_ptr< FDArrayfds
 
bool * exitGroup
 
std::shared_ptr< MemStatememState
 
uint64_t childClearTID
 Calls a futex wakeup at the address specified by this pointer when this process exits.
 
bool * sigchld
 
std::vector< ContextIDvforkContexts
 
statistics::Scalar numSyscalls
 

Additional Inherited Members

- Public Types inherited from gem5::SimObject
typedef SimObjectParams Params
 
- Protected Member Functions inherited from gem5::Drainable
 Drainable ()
 
virtual ~Drainable ()
 
virtual void drainResume ()
 Resume execution after a successful drain.
 
void signalDrainDone () const
 Signal that an object is drained.
 
- Protected Attributes inherited from gem5::SimObject
const SimObjectParams & _params
 Cached copy of the object parameters.
 
- Protected Attributes inherited from gem5::EventManager
EventQueueeventq
 A pointer to this object's event queue.
 

Detailed Description

Definition at line 67 of file process.hh.

Constructor & Destructor Documentation

◆ Process()

gem5::Process::Process ( const ProcessParams & params,
EmulationPageTable * pTable,
loader::ObjectFile * obj_file )

Linux bundles together processes into this concept called a thread group. The thread group is responsible for recording which processes behave as threads within a process context. The thread group leader is the process who's tgid is equal to its pid. Other processes which belong to the thread group, but do not lead the thread group, are treated as child threads. These threads are created by the clone system call with options specified to create threads (differing from the options used to implement a fork). By default, set up the tgid/pid with a new, equivalent value. If CLONE_THREAD is specified, patch the tgid value with the old process' value.

Definition at line 113 of file process.cc.

References _pid, _tgid, gem5::loader::ImageFile::buildImage(), gem5::loader::debugSymbolTable, exitGroup, fatal_if, image, gem5::System::maxPID, objFile, gem5::SimObject::params(), gem5::System::PIDs, seWorkload, sigchld, gem5::loader::ObjectFile::symtab(), and system.

Member Function Documentation

◆ absolutePath()

std::string gem5::Process::absolutePath ( const std::string & path,
bool host_fs )

Return an absolute path given a relative path paired with the current working directory of the process running under simulation.

Parameters
pathThe relative path (generally a filename) that needs the current working directory prepended.
host_fsA flag which determines whether to return a path for the host filesystem or the filesystem of the process running under simulation. Only matters if filesysem redirection is used to replace files (or directories) that would normally appear via the host filesystem.
Returns
String containing an absolute path.

Definition at line 505 of file process.cc.

References hostCwd, gem5::normalize(), gem5::startswith(), and tgtCwd.

Referenced by checkPathRedirect().

◆ allocateMem()

◆ assignThreadContext()

void gem5::Process::assignThreadContext ( ContextID context_id)
inline

Definition at line 130 of file process.hh.

References contextIds.

Referenced by gem5::doClone(), gem5::execveFunc(), and gem5::BaseCPU::registerThreadContexts().

◆ checkPathRedirect()

std::string gem5::Process::checkPathRedirect ( const std::string & filename)

Redirect file path if it matches any keys initialized by system object.

Parameters
filenameAn input parameter containing either a relative path or an absolute path. If given a relative path, the path will be prepended to the current working directory of the simulation with respect to the host filesystem.
Returns
String containing an absolute path.

Definition at line 424 of file process.cc.

References absolutePath(), gem5::Serializable::path, gem5::System::redirectPaths, gem5::startswith(), and system.

Referenced by gem5::accessImpl(), gem5::chdirFunc(), gem5::chownImpl(), gem5::fchmodatFunc(), gem5::fstatat64Func(), gem5::futimesatFunc(), gem5::lstat64Func(), gem5::lstatFunc(), gem5::mkdirImpl(), gem5::mknodImpl(), gem5::newfstatatFunc(), gem5::readlinkatFunc(), gem5::renameImpl(), gem5::rmdirImpl(), gem5::statfsFunc(), gem5::statFunc(), gem5::statxFunc(), gem5::truncate64Func(), gem5::truncateFunc(), gem5::unlinkImpl(), and gem5::FDArray::unserialize().

◆ clone()

void gem5::Process::clone ( ThreadContext * old_tc,
ThreadContext * new_tc,
Process * new_p,
RegVal flags )
virtual

Share the process memory address space between the new process and the old process. Changes in one will be visible in the other due to the pointer use.

Duplicate the process memory address space. The state needs to be copied over (rather than using pointers to share everything).

The parent and child file descriptors are shared because the two FDArray pointers are pointing to the same FDArray. Opening and closing file descriptors will be visible to both processes.

Copy the file descriptors from the old process into the new child process. The file descriptors entry can be opened and closed independently of the other process being considered. The host file descriptors are also dup'd so that the flags for the host file descriptor is independent of the other process.

Reimplemented in gem5::X86ISA::I386Process, gem5::X86ISA::X86_64Process, and gem5::X86ISA::X86Process.

Definition at line 167 of file process.cc.

References _tgid, argv, CLONE_FILES, CLONE_THREAD, CLONE_VFORK, CLONE_VM, gem5::ThreadContext::contextId(), envp, exitGroup, fds, flags, gem5::EmulationPageTable::getMappings(), memState, pTable, replicatePage(), gem5::EmulationPageTable::translate(), gem5::MipsISA::vaddr, and vforkContexts.

Referenced by gem5::X86ISA::X86Process::clone().

◆ drain()

DrainState gem5::Process::drain ( )
overridevirtual

Draining is the process of clearing out the states of SimObjects.These are the SimObjects that are partially executed or are partially in flight.

Draining is mostly used before forking and creating a check point.

This function notifies an object that it needs to drain its state.

If the object does not need further simulation to drain internal buffers, it returns DrainState::Drained and automatically switches to the Drained state. If the object needs more simulation, it returns DrainState::Draining and automatically enters the Draining state. Other return values are invalid.

Note
An object that has entered the Drained state can be disturbed by other objects in the system and consequently stop being drained. These perturbations are not visible in the drain state. The simulator therefore repeats the draining process until all objects return DrainState::Drained on the first call to drain().
Returns
DrainState::Drained if the object is drained at this point in time, DrainState::Draining if it needs further simulation.

Implements gem5::Drainable.

Definition at line 310 of file process.cc.

References gem5::Drained, and fds.

◆ egid()

◆ euid()

◆ findDriver()

EmulatedDriver * gem5::Process::findDriver ( std::string filename)

Find an emulated device driver.

Parameters
filenameName of the device (under /dev)
Returns
Pointer to driver object if found, else nullptr

Definition at line 413 of file process.cc.

References gem5::ArmISA::d, and drivers.

◆ fixupFault()

bool gem5::Process::fixupFault ( Addr vaddr)

Attempt to fix up a fault at vaddr by allocating a page on the stack.

Returns
Whether the fault has been fixed.

Definition at line 365 of file process.cc.

References memState, and gem5::MipsISA::vaddr.

Referenced by gem5::GenericPageTableFault::invoke(), and gem5::X86ISA::PageFault::invoke().

◆ getBias()

◆ getInterpreter()

loader::ObjectFile * gem5::Process::getInterpreter ( )

Definition at line 483 of file process.cc.

References gem5::loader::ObjectFile::getInterpreter(), and objFile.

Referenced by getBias(), and getStartPC().

◆ getStartPC()

◆ gid()

◆ init()

void gem5::Process::init ( )
overridevirtual

init() is called after all C++ SimObjects have been created and all ports are connected.

Initializations that are independent of unserialization but rely on a fully instantiated and connected SimObject graph should be done here.

Reimplemented from gem5::SimObject.

Definition at line 278 of file process.cc.

References gem5::loader::ImageFile::buildImage(), gem5::loader::ObjectFile::getInterpreter(), interpImage, objFile, and updateBias().

Referenced by gem5::execveFunc().

◆ initState()

◆ map()

bool gem5::Process::map ( Addr vaddr,
Addr paddr,
int64_t size,
bool cacheable = true )

Maps a contiguous range of virtual addresses in this process's address space to a contiguous range of physical addresses.

This function exists primarily to expose the map operation to python, so that configuration scripts can set up mappings in SE mode.

Parameters
vaddrThe starting virtual address of the range.
paddrThe starting physical address of the range.
sizeThe length of the range in bytes.
cacheableSpecifies whether accesses are cacheable.
Returns
True if the map operation was successful. (At this point in time, the map operation always succeeds.)

Definition at line 404 of file process.cc.

References gem5::EmulationPageTable::map(), pTable, gem5::EmulationPageTable::Uncacheable, and gem5::MipsISA::vaddr.

◆ mmapGrowsDown()

virtual bool gem5::Process::mmapGrowsDown ( ) const
inlinevirtual

Does mmap region grow upward or downward from mmapEnd? Most platforms grow downward, but a few (such as Alpha) grow upward instead, so they can override this method to return false.

Reimplemented in gem5::RiscvProcess.

Definition at line 146 of file process.hh.

Referenced by gem5::MemState::extendMmap(), gem5::Shader::mmap(), and updateBias().

◆ pgid() [1/2]

uint64_t gem5::Process::pgid ( )
inline

Definition at line 88 of file process.hh.

References _pgid.

Referenced by gem5::getpgrpFunc(), and gem5::setpgidFunc().

◆ pgid() [2/2]

void gem5::Process::pgid ( uint64_t pgid)
inline

Definition at line 89 of file process.hh.

References _pgid, and pgid().

Referenced by pgid().

◆ pid()

uint64_t gem5::Process::pid ( )
inline

Definition at line 86 of file process.hh.

References _pid.

Referenced by gem5::doClone(), gem5::exitImpl(), gem5::gettidFunc(), gem5::setpgidFunc(), and gem5::tgkillFunc().

◆ ppid()

uint64_t gem5::Process::ppid ( )
inline

Definition at line 87 of file process.hh.

References _ppid.

Referenced by gem5::getppidFunc().

◆ progName()

const char * gem5::Process::progName ( ) const
inline

Definition at line 92 of file process.hh.

References executable.

◆ replicatePage()

void gem5::Process::replicatePage ( Addr vaddr,
Addr new_paddr,
ThreadContext * old_tc,
ThreadContext * new_tc,
bool alloc_page )

◆ revokeThreadContext()

void gem5::Process::revokeThreadContext ( int context_id)

After delegating a thread context to a child process no longer should relate to the ThreadContext.

Definition at line 265 of file process.cc.

References contextIds, and warn.

Referenced by gem5::doClone().

◆ serialize()

void gem5::Process::serialize ( CheckpointOut & cp) const
overridevirtual

Serialize an object.

Output an object's state into the current checkpoint section.

Parameters
cpCheckpoint state

Checkpoints for pipes, device drivers or sockets currently do not work. Need to come back and fix them at a later date.

Implements gem5::Serializable.

Definition at line 371 of file process.cc.

References fds, memState, pTable, gem5::EmulationPageTable::serialize(), and warn.

◆ syscall()

virtual void gem5::Process::syscall ( ThreadContext * tc)
inlinevirtual

Definition at line 80 of file process.hh.

References numSyscalls.

Referenced by gem5::SEWorkload::syscall().

◆ tgid()

uint64_t gem5::Process::tgid ( )
inline

Definition at line 90 of file process.hh.

References _tgid.

Referenced by gem5::exitImpl(), gem5::getpidFunc(), and gem5::tgkillFunc().

◆ tryLoaders()

Process * gem5::Process::tryLoaders ( const ProcessParams & params,
loader::ObjectFile * obj_file )
static

Definition at line 93 of file process.cc.

References gem5::MipsISA::p, and gem5::SimObject::params().

◆ uid()

◆ unserialize()

void gem5::Process::unserialize ( CheckpointIn & cp)
overridevirtual

Unserialize an object.

Read an object's state from the current checkpoint section.

Parameters
cpCheckpoint state

Checkpoints for pipes, device drivers or sockets currently do not work. Need to come back and fix them at a later date.

Implements gem5::Serializable.

Definition at line 386 of file process.cc.

References fds, memState, pTable, gem5::EmulationPageTable::unserialize(), and warn.

◆ updateBias()

void gem5::Process::updateBias ( )

Member Data Documentation

◆ _egid

uint64_t gem5::Process::_egid

Definition at line 275 of file process.hh.

Referenced by egid().

◆ _euid

uint64_t gem5::Process::_euid

Definition at line 273 of file process.hh.

Referenced by euid().

◆ _gid

uint64_t gem5::Process::_gid

Definition at line 274 of file process.hh.

Referenced by gid().

◆ _pgid

uint64_t gem5::Process::_pgid

Definition at line 280 of file process.hh.

Referenced by pgid(), and pgid().

◆ _pid

uint64_t gem5::Process::_pid

Definition at line 278 of file process.hh.

Referenced by gem5::SparcProcess::initState(), pid(), and Process().

◆ _ppid

uint64_t gem5::Process::_ppid

Definition at line 279 of file process.hh.

Referenced by ppid().

◆ _tgid

uint64_t gem5::Process::_tgid

Definition at line 281 of file process.hh.

Referenced by clone(), Process(), and tgid().

◆ _uid

uint64_t gem5::Process::_uid

Definition at line 272 of file process.hh.

Referenced by uid().

◆ argv

◆ childClearTID

uint64_t gem5::Process::childClearTID

Calls a futex wakeup at the address specified by this pointer when this process exits.

Definition at line 295 of file process.hh.

Referenced by gem5::doClone(), and gem5::setTidAddressFunc().

◆ contextIds

◆ drivers

std::vector<EmulatedDriver *> gem5::Process::drivers

Definition at line 284 of file process.hh.

Referenced by findDriver().

◆ envp

◆ executable

std::string gem5::Process::executable

Definition at line 228 of file process.hh.

Referenced by progName().

◆ exitGroup

bool* gem5::Process::exitGroup

Definition at line 288 of file process.hh.

Referenced by clone(), and Process().

◆ fds

std::shared_ptr<FDArray> gem5::Process::fds

Definition at line 286 of file process.hh.

Referenced by clone(), gem5::closeFunc(), drain(), gem5::execveFunc(), serialize(), and unserialize().

◆ hostCwd

std::string gem5::Process::hostCwd

Definition at line 266 of file process.hh.

Referenced by absolutePath().

◆ image

◆ initVirtMem

◆ interpImage

loader::MemoryImage gem5::Process::interpImage

Definition at line 225 of file process.hh.

Referenced by gem5::PowerProcess::argsInit(), init(), and initState().

◆ kvmInSE

bool gem5::Process::kvmInSE

◆ memState

◆ numSyscalls

statistics::Scalar gem5::Process::numSyscalls

Definition at line 304 of file process.hh.

Referenced by syscall().

◆ objFile

◆ pTable

◆ release

std::string gem5::Process::release

Definition at line 269 of file process.hh.

◆ seWorkload

SEWorkload* gem5::Process::seWorkload

◆ sigchld

bool* gem5::Process::sigchld

Definition at line 298 of file process.hh.

Referenced by gem5::doClone(), gem5::execveFunc(), and Process().

◆ system

◆ tgtCwd

std::string gem5::Process::tgtCwd

The cwd members are used to track changes to the current working directory for the purpose of executing system calls which depend on relative paths (i.e.

open, chdir).

The tgt member and host member may differ if the path for the current working directory is redirected to point to a different location (i.e. cd /proc should point to '/m5out/fs/proc' instead of '/proc').

Definition at line 265 of file process.hh.

Referenced by absolutePath(), and gem5::Linux::etcPasswd().

◆ useArchPT

bool gem5::Process::useArchPT

Definition at line 178 of file process.hh.

◆ useForClone

bool gem5::Process::useForClone

Definition at line 182 of file process.hh.

Referenced by gem5::doClone(), and gem5::X86ISA::X86_64Process::initState().

◆ vforkContexts

std::vector<ContextID> gem5::Process::vforkContexts

Definition at line 301 of file process.hh.

Referenced by clone().


The documentation for this class was generated from the following files:

Generated on Tue Jun 18 2024 16:24:13 for gem5 by doxygen 1.11.0