gem5  v20.1.0.0
Classes | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Process Class Reference

#include <process.hh>

Inheritance diagram for Process:
SimObject EventManager Serializable Drainable Stats::Group ArmProcess MipsProcess PowerProcess RiscvProcess SparcProcess X86ISA::X86Process ArmProcess32 ArmProcess64 MipsLinuxProcess PowerLinuxProcess RiscvProcess32 RiscvProcess64 Sparc32Process Sparc64Process X86ISA::I386Process 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 (ProcessParams *params, EmulationPageTable *pTable, ::Loader::ObjectFile *obj_file)
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
void init () override
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
void initState () override
 initState() is called on each SimObject when not restoring from a checkpoint. More...
 
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. More...
 
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. More...
 
void updateBias ()
 
Addr getBias ()
 
Addr getStartPC ()
 
::Loader::ObjectFilegetInterpreter ()
 
void regStats () override
 Callback to set stat parameters. More...
 
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. More...
 
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. More...
 
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. More...
 
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 physical addresses. More...
 
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. More...
 
std::string checkPathRedirect (const std::string &filename)
 Redirect file path if it matches any keys initialized by system object. More...
 
- Public Member Functions inherited from SimObject
const Paramsparams () const
 
 SimObject (const Params *_params)
 
virtual ~SimObject ()
 
virtual const std::string name () const
 
virtual void loadState (CheckpointIn &cp)
 loadState() is called on each SimObject when restoring from a checkpoint. More...
 
virtual void regProbePoints ()
 Register probe points for this object. More...
 
virtual void regProbeListeners ()
 Register probe listeners for this object. More...
 
ProbeManagergetProbeManager ()
 Get the probe manager for this object. More...
 
virtual PortgetPort (const std::string &if_name, PortID idx=InvalidPortID)
 Get a port with a given name and index. More...
 
virtual void startup ()
 startup() is the final initialization call before simulation. More...
 
DrainState drain () override
 Provide a default implementation of the drain interface for objects that don't need draining. More...
 
virtual void memWriteback ()
 Write back dirty buffers to memory using functional writes. More...
 
virtual void memInvalidate ()
 Invalidate the contents of memory buffers. More...
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
- Public Member Functions inherited from 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. More...
 
void setCurTick (Tick newVal)
 
 EventManager (EventManager &em)
 Event manger manages events in the event queue. More...
 
 EventManager (EventManager *em)
 
 EventManager (EventQueue *eq)
 
- Public Member Functions inherited from Serializable
 Serializable ()
 
virtual ~Serializable ()
 
void serializeSection (CheckpointOut &cp, const char *name) const
 Serialize an object into a new section. More...
 
void serializeSection (CheckpointOut &cp, const std::string &name) const
 
void unserializeSection (CheckpointIn &cp, const char *name)
 Unserialize an a child object. More...
 
void unserializeSection (CheckpointIn &cp, const std::string &name)
 
- Public Member Functions inherited from Drainable
DrainState drainState () const
 Return the current drain state of an object. More...
 
virtual void notifyFork ()
 Notify a child process of a fork. More...
 
- Public Member Functions inherited from Stats::Group
 Group (Group *parent, const char *name=nullptr)
 Construct a new statistics group. More...
 
virtual ~Group ()
 
virtual void resetStats ()
 Callback to reset stats. More...
 
virtual void preDumpStats ()
 Callback before stats are dumped. More...
 
void addStat (Stats::Info *info)
 Register a stat with this group. More...
 
const std::map< std::string, Group * > & getStatGroups () const
 Get all child groups associated with this object. More...
 
const std::vector< Info * > & getStats () const
 Get all stats associated with this object. More...
 
void addStatGroup (const char *name, Group *block)
 Add a stat block as a child of this block. More...
 
const InforesolveStat (std::string name) const
 Resolve a stat by its name within this group. More...
 
 Group ()=delete
 
 Group (const Group &)=delete
 
Groupoperator= (const Group &)=delete
 

Static Public Member Functions

static ProcesstryLoaders (ProcessParams *params, ::Loader::ObjectFile *obj_file)
 
- Static Public Member Functions inherited from SimObject
static void serializeAll (CheckpointOut &cp)
 Serialize all SimObjects in the system. More...
 
static SimObjectfind (const char *name)
 Find the SimObject with the given name and return a pointer to it. More...
 
- Static Public Member Functions inherited from Serializable
static const std::string & currentSection ()
 Gets the fully-qualified name of the active section. More...
 
static void serializeAll (const std::string &cpt_dir)
 Serializes all the SimObjects. More...
 
static void unserializeGlobals (CheckpointIn &cp)
 

Public Attributes

std::vector< ContextIDcontextIds
 
Systemsystem
 
Stats::Scalar numSyscalls
 
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. More...
 
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. More...
 
bool * sigchld
 

Additional Inherited Members

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

Detailed Description

Definition at line 65 of file process.hh.

Constructor & Destructor Documentation

◆ Process()

Process::Process ( 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 112 of file process.cc.

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

Member Function Documentation

◆ absolutePath()

std::string 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 484 of file process.cc.

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

Referenced by checkPathRedirect().

◆ allocateMem()

void Process::allocateMem ( Addr  vaddr,
int64_t  size,
bool  clobber = false 
)

◆ assignThreadContext()

void Process::assignThreadContext ( ContextID  context_id)
inline

Definition at line 120 of file process.hh.

References contextIds.

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

◆ checkPathRedirect()

std::string 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 403 of file process.cc.

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

Referenced by lstat64Func(), lstatFunc(), stat64Func(), statfsFunc(), statFunc(), and truncate64Func().

◆ clone()

void 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 X86ISA::I386Process, X86ISA::X86_64Process, X86ISA::X86Process, X86ISA::I386LinuxProcess, and X86ISA::X86_64LinuxProcess.

Definition at line 163 of file process.cc.

References _tgid, argv, CLONE_FILES, CLONE_THREAD, CLONE_VM, envp, exitGroup, fds, EmulationPageTable::getMappings(), map(), memState, pTable, replicatePage(), EmulationPageTable::translate(), and MipsISA::vaddr.

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

◆ drain()

DrainState 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 Drainable.

Definition at line 312 of file process.cc.

References Drained, and fds.

◆ egid()

uint64_t Process::egid ( )
inline

◆ euid()

uint64_t Process::euid ( )
inline

◆ findDriver()

EmulatedDriver * 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 392 of file process.cc.

References ArmISA::d, and drivers.

◆ fixupFault()

bool 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 348 of file process.cc.

References memState, and MipsISA::vaddr.

Referenced by X86ISA::PageFault::invoke(), RiscvISA::TLB::translateFunctional(), and X86ISA::TLB::translateFunctional().

◆ getBias()

Addr Process::getBias ( )

◆ getInterpreter()

Loader::ObjectFile * Process::getInterpreter ( )

Definition at line 462 of file process.cc.

References Loader::ObjectFile::getInterpreter(), and objFile.

Referenced by getBias(), and getStartPC().

◆ getStartPC()

Addr Process::getStartPC ( )

◆ gid()

uint64_t Process::gid ( )
inline

◆ init()

void 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 SimObject.

Definition at line 280 of file process.cc.

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

◆ initState()

void Process::initState ( )
overridevirtual

◆ map()

bool Process::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 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 383 of file process.cc.

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

Referenced by clone().

◆ mmapGrowsDown()

virtual bool 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 RiscvProcess.

Definition at line 136 of file process.hh.

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

◆ pgid() [1/2]

uint64_t Process::pgid ( )
inline

Definition at line 86 of file process.hh.

References _pgid.

Referenced by getpgrpFunc(), and setpgidFunc().

◆ pgid() [2/2]

void Process::pgid ( uint64_t  pgid)
inline

Definition at line 87 of file process.hh.

References _pgid, and pgid().

Referenced by pgid().

◆ pid()

uint64_t Process::pid ( )
inline

Definition at line 84 of file process.hh.

References _pid.

Referenced by exitImpl(), gettidFunc(), setpgidFunc(), and tgkillFunc().

◆ ppid()

uint64_t Process::ppid ( )
inline

Definition at line 85 of file process.hh.

References _ppid.

Referenced by getppidFunc().

◆ progName()

const char* Process::progName ( ) const
inline

Definition at line 90 of file process.hh.

References executable.

◆ regStats()

void Process::regStats ( )
overridevirtual

Callback to set stat parameters.

This callback is typically used for complex stats (e.g., distributions) that need parameters in addition to a name and a description. Stat names and descriptions should typically be set from the constructor usingo from the constructor using the ADD_STAT macro.

Reimplemented from Stats::Group.

Definition at line 254 of file process.cc.

References Stats::DataWrap< Derived, InfoProxyType >::desc(), SimObject::name(), Stats::DataWrap< Derived, InfoProxyType >::name(), numSyscalls, and Stats::Group::regStats().

◆ replicatePage()

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

◆ revokeThreadContext()

void Process::revokeThreadContext ( int  context_id)

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

Definition at line 267 of file process.cc.

References contextIds, and warn.

Referenced by cloneFunc().

◆ serialize()

void Process::serialize ( CheckpointOut cp) const
overridevirtual

Serialize an object.

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

Parameters
cpCheckpoint state

Checkpoints for file descriptors currently do not work. Need to come back and fix them at a later date.

Implements Serializable.

Definition at line 354 of file process.cc.

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

◆ syscall()

virtual void Process::syscall ( ThreadContext tc)
inlinevirtual

◆ tgid()

uint64_t Process::tgid ( )
inline

Definition at line 88 of file process.hh.

References _tgid.

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

◆ tryLoaders()

Process * Process::tryLoaders ( ProcessParams *  params,
::Loader::ObjectFile obj_file 
)
static

Definition at line 93 of file process.cc.

References MipsISA::p.

◆ uid()

uint64_t Process::uid ( )
inline

◆ unserialize()

void Process::unserialize ( CheckpointIn cp)
overridevirtual

Unserialize an object.

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

Parameters
cpCheckpoint state

Checkpoints for file descriptors currently do not work. Need to come back and fix them at a later date.

Implements Serializable.

Definition at line 367 of file process.cc.

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

◆ updateBias()

void Process::updateBias ( )

Member Data Documentation

◆ _egid

uint64_t Process::_egid

Definition at line 265 of file process.hh.

Referenced by egid().

◆ _euid

uint64_t Process::_euid

Definition at line 263 of file process.hh.

Referenced by euid().

◆ _gid

uint64_t Process::_gid

Definition at line 264 of file process.hh.

Referenced by gid().

◆ _pgid

uint64_t Process::_pgid

Definition at line 270 of file process.hh.

Referenced by pgid().

◆ _pid

uint64_t Process::_pid

Definition at line 268 of file process.hh.

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

◆ _ppid

uint64_t Process::_ppid

Definition at line 269 of file process.hh.

Referenced by ppid().

◆ _tgid

uint64_t Process::_tgid

Definition at line 271 of file process.hh.

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

◆ _uid

uint64_t Process::_uid

Definition at line 262 of file process.hh.

Referenced by uid().

◆ argv

std::vector<std::string> Process::argv

◆ childClearTID

uint64_t Process::childClearTID

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

Definition at line 285 of file process.hh.

Referenced by setTidAddressFunc().

◆ contextIds

std::vector<ContextID> Process::contextIds

◆ drivers

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

Definition at line 274 of file process.hh.

Referenced by findDriver().

◆ envp

std::vector<std::string> Process::envp

◆ executable

std::string Process::executable

Definition at line 218 of file process.hh.

Referenced by progName().

◆ exitGroup

bool* Process::exitGroup

Definition at line 278 of file process.hh.

Referenced by clone(), and Process().

◆ fds

std::shared_ptr<FDArray> Process::fds

Definition at line 276 of file process.hh.

Referenced by clone(), drain(), and execveFunc().

◆ hostCwd

std::string Process::hostCwd

Definition at line 256 of file process.hh.

Referenced by absolutePath().

◆ image

::Loader::MemoryImage Process::image

◆ initVirtMem

std::unique_ptr<SETranslatingPortProxy> Process::initVirtMem

◆ interpImage

::Loader::MemoryImage Process::interpImage

Definition at line 215 of file process.hh.

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

◆ kvmInSE

bool Process::kvmInSE

◆ memState

std::shared_ptr<MemState> Process::memState

◆ numSyscalls

Stats::Scalar Process::numSyscalls

Definition at line 165 of file process.hh.

Referenced by regStats(), and syscall().

◆ objFile

::Loader::ObjectFile* Process::objFile

◆ pTable

EmulationPageTable* Process::pTable

◆ release

std::string Process::release

Definition at line 259 of file process.hh.

◆ sigchld

bool* Process::sigchld

Definition at line 288 of file process.hh.

Referenced by execveFunc(), and Process().

◆ system

System* Process::system

◆ tgtCwd

std::string 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 255 of file process.hh.

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

◆ useArchPT

bool Process::useArchPT

Definition at line 168 of file process.hh.

◆ useForClone

bool Process::useForClone

Definition at line 172 of file process.hh.

Referenced by X86ISA::X86_64Process::initState().


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

Generated on Wed Sep 30 2020 14:02:29 for gem5 by doxygen 1.8.17