gem5  v21.1.0.2
Public Member Functions | Public Attributes | Protected Attributes | Private Attributes | List of all members
gem5::ArmISA::FsLinux Class Reference

#include <fs_workload.hh>

Inheritance diagram for gem5::ArmISA::FsLinux:
gem5::ArmISA::FsWorkload gem5::KernelWorkload gem5::Workload gem5::SimObject gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

Public Member Functions

 PARAMS (ArmFsLinux)
 Boilerplate params code. More...
 
 FsLinux (const Params &p)
 
 ~FsLinux ()
 
void initState () override
 initState() is called on each SimObject when not restoring from a checkpoint. More...
 
void startup () override
 startup() is the final initialization call before simulation. More...
 
void mapPid (ThreadContext *tc, uint32_t pid)
 This function creates a new task Id for the given pid. More...
 
void dumpDmesg ()
 Dump the kernel's dmesg buffer to stdout. More...
 
- Public Member Functions inherited from gem5::ArmISA::FsWorkload
 PARAMS (ArmFsWorkload)
 
Addr getEntry () const override
 
loader::Arch getArch () const override
 
 FsWorkload (const Params &p)
 
void setSystem (System *sys) override
 
Addr fixFuncEventAddr (Addr addr) const override
 
- Public Member Functions inherited from gem5::KernelWorkload
 PARAMS (KernelWorkload)
 
Addr start () const
 
Addr end () const
 
Addr loadAddrMask () const
 
Addr loadAddrOffset () const
 
 KernelWorkload (const Params &p)
 
Addr getEntry () const override
 
loader::Arch getArch () const override
 
const loader::SymbolTablesymtab (ThreadContext *tc) override
 
bool insertSymbol (const loader::Symbol &symbol) override
 
void initState () override
 initState() is called on each SimObject when not restoring from a checkpoint. More...
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
template<class T , typename... Args>
T * addKernelFuncEvent (const char *lbl, Args... args)
 Add a function-based event to a kernel symbol. More...
 
template<class T , typename... Args>
T * addKernelFuncEventOrPanic (const char *lbl, Args... args)
 
- Public Member Functions inherited from gem5::Workload
 Workload (const WorkloadParams &params)
 
void recordQuiesce ()
 
void recordArm ()
 
bool trapToGdb (int signal, ContextID ctx_id)
 
virtual void registerThreadContext (ThreadContext *tc)
 
virtual void replaceThreadContext (ThreadContext *tc)
 
void startup () override
 startup() is the final initialization call before simulation. More...
 
virtual void syscall (ThreadContext *tc)
 
virtual void event (ThreadContext *tc)
 
template<class T , typename... Args>
T * addFuncEvent (const loader::SymbolTable &symtab, const char *lbl, const std::string &desc, Args... args)
 Add a function-based event to the given function, to be looked up in the specified symbol table. More...
 
template<class T >
T * addFuncEvent (const loader::SymbolTable &symtab, const char *lbl)
 
template<class T , typename... Args>
T * addFuncEventOrPanic (const loader::SymbolTable &symtab, const char *lbl, Args... args)
 
- Public Member Functions inherited from gem5::SimObject
const Paramsparams () const
 
 SimObject (const Params &p)
 
virtual ~SimObject ()
 
virtual void init ()
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
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...
 
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 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. 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 gem5::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 gem5::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 gem5::statistics::Group
 Group (Group *parent, const char *name=nullptr)
 Construct a new statistics group. More...
 
virtual ~Group ()
 
virtual void regStats ()
 Callback to set stat parameters. More...
 
virtual void resetStats ()
 Callback to reset stats. More...
 
virtual void preDumpStats ()
 Callback before stats are dumped. More...
 
void addStat (statistics::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...
 
void mergeStatGroup (Group *block)
 Merge the contents (stats & children) of a block to this block. More...
 
 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
 

Public Attributes

bool enableContextSwitchStatsDump
 When enabled, dump stats/task info on context switches for Streamline and per-thread cache occupancy studies, etc. More...
 
std::map< uint32_t, uint32_t > taskMap
 This map stores a mapping of OS process IDs to internal Task IDs. More...
 
OutputStreamtaskFile = nullptr
 This is a file that is placed in the run directory that prints out mappings between taskIds and OS process IDs. More...
 

Protected Attributes

PCEventdebugPrintk = nullptr
 PC based event to skip the dprink() call and emulate its functionality. More...
 
PCEventdumpStats = nullptr
 
- Protected Attributes inherited from gem5::ArmISA::FsWorkload
std::vector< std::unique_ptr< loader::ObjectFile > > bootLoaders
 Bootloaders. More...
 
loader::ObjectFilebootldr = nullptr
 Pointer to the bootloader object. More...
 
Addr kernelEntry = 0
 This differs from entry since it takes into account where the kernel is loaded in memory (with loadAddrMask and loadAddrOffset). More...
 
- Protected Attributes inherited from gem5::KernelWorkload
loader::MemoryImage image
 
Addr _loadAddrMask
 Mask that should be anded for binary/symbol loading. More...
 
Addr _loadAddrOffset
 Offset that should be used for binary/symbol loading. More...
 
Addr _start
 
Addr _end
 
std::vector< loader::ObjectFile * > extras
 
loader::ObjectFilekernelObj = nullptr
 
loader::SymbolTable kernelSymtab
 
const std::string commandLine
 
- Protected Attributes inherited from gem5::Workload
gem5::Workload::WorkloadStats stats
 
BaseRemoteGDBgdb = nullptr
 
bool waitForRemoteGDB = false
 
std::set< ThreadContext * > threads
 
Systemsystem = nullptr
 
- Protected Attributes inherited from gem5::SimObject
const SimObjectParams & _params
 Cached copy of the object parameters. More...
 
- Protected Attributes inherited from gem5::EventManager
EventQueueeventq
 A pointer to this object's event queue. More...
 

Private Attributes

PCEventkernelPanic = nullptr
 Event to halt the simulator if the kernel calls panic()
More...
 
PCEventkernelOops = nullptr
 Event to halt the simulator if the kernel calls oopses
More...
 
PCEventskipUDelay = nullptr
 PC based event to skip udelay(<time>) calls and quiesce the processor for the appropriate amount of time. More...
 
PCEventskipConstUDelay = nullptr
 Another PC based skip event for const_udelay(). More...
 

Additional Inherited Members

- Public Types inherited from gem5::SimObject
typedef SimObjectParams Params
 
- 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. More...
 
static SimObjectfind (const char *name)
 Find the SimObject with the given name and return a pointer to it. More...
 
static void setSimObjectResolver (SimObjectResolver *resolver)
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
static SimObjectResolvergetSimObjectResolver ()
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
- Static Public Member Functions inherited from gem5::Serializable
static const std::string & currentSection ()
 Gets the fully-qualified name of the active section. More...
 
static void generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
 Generate a checkpoint file so that the serialization can be routed to it. More...
 
- Protected Member Functions inherited from gem5::ArmISA::FsWorkload
loader::ObjectFilegetBootLoader (loader::ObjectFile *const obj)
 Get a boot loader that matches the kernel. More...
 
template<template< class ABI, class Base > class FuncEvent, typename... Args>
PCEventaddSkipFunc (Args... args)
 
template<template< class ABI, class Base > class FuncEvent, typename... Args>
PCEventaddSkipFuncOrPanic (Args... args)
 
- Protected Member Functions inherited from gem5::Drainable
 Drainable ()
 
virtual ~Drainable ()
 
virtual void drainResume ()
 Resume execution after a successful drain. More...
 
void signalDrainDone () const
 Signal that an object is drained. More...
 

Detailed Description

Definition at line 76 of file fs_workload.hh.

Constructor & Destructor Documentation

◆ FsLinux()

gem5::ArmISA::FsLinux::FsLinux ( const Params p)

Definition at line 68 of file fs_workload.cc.

◆ ~FsLinux()

gem5::ArmISA::FsLinux::~FsLinux ( )

Definition at line 180 of file fs_workload.cc.

References debugPrintk, dumpStats, kernelOops, kernelPanic, skipConstUDelay, and skipUDelay.

Member Function Documentation

◆ dumpDmesg()

void gem5::ArmISA::FsLinux::dumpDmesg ( )

Dump the kernel's dmesg buffer to stdout.

Definition at line 271 of file fs_workload.cc.

References gem5::linux::dumpDmesg(), gem5::Workload::system, and gem5::System::threads.

◆ initState()

void gem5::ArmISA::FsLinux::initState ( )
overridevirtual

◆ mapPid()

void gem5::ArmISA::FsLinux::mapPid ( ThreadContext tc,
uint32_t  pid 
)

This function creates a new task Id for the given pid.

Parameters
tcthread context that is currentyl executing

Definition at line 255 of file fs_workload.cc.

References gem5::context_switch_task_id::MaxNormalTaskId, taskMap, gem5::context_switch_task_id::Unknown, and warn_once.

Referenced by gem5::ArmISA::DumpStats::process(), and startup().

◆ PARAMS()

gem5::ArmISA::FsLinux::PARAMS ( ArmFsLinux  )

Boilerplate params code.

◆ startup()

void gem5::ArmISA::FsLinux::startup ( )
overridevirtual

startup() is the final initialization call before simulation.

All state is initialized (including unserialized state, if any, such as the curTick() value), so this is the appropriate place to schedule initial event(s) for objects that need them.

Reimplemented from gem5::SimObject.

Definition at line 192 of file fs_workload.cc.

References gem5::loader::Arm64, gem5::OutputDirectory::create(), debugPrintk, dumpStats, enableContextSwitchStatsDump, gem5::ArmISA::FsWorkload::getArch(), gem5::BaseCPU::invldPid, kernelOops, kernelPanic, mapPid(), gem5::Named::name(), panic_if, gem5::SimObject::params(), gem5::simout, skipConstUDelay, skipUDelay, gem5::Workload::startup(), gem5::Workload::system, taskFile, taskMap, and gem5::System::threads.

Member Data Documentation

◆ debugPrintk

PCEvent* gem5::ArmISA::FsLinux::debugPrintk = nullptr
protected

PC based event to skip the dprink() call and emulate its functionality.

Definition at line 83 of file fs_workload.hh.

Referenced by startup(), and ~FsLinux().

◆ dumpStats

PCEvent* gem5::ArmISA::FsLinux::dumpStats = nullptr
protected

Definition at line 85 of file fs_workload.hh.

Referenced by startup(), and ~FsLinux().

◆ enableContextSwitchStatsDump

bool gem5::ArmISA::FsLinux::enableContextSwitchStatsDump

When enabled, dump stats/task info on context switches for Streamline and per-thread cache occupancy studies, etc.

Definition at line 93 of file fs_workload.hh.

Referenced by startup().

◆ kernelOops

PCEvent* gem5::ArmISA::FsLinux::kernelOops = nullptr
private

Event to halt the simulator if the kernel calls oopses

Definition at line 127 of file fs_workload.hh.

Referenced by startup(), and ~FsLinux().

◆ kernelPanic

PCEvent* gem5::ArmISA::FsLinux::kernelPanic = nullptr
private

Event to halt the simulator if the kernel calls panic()

Definition at line 124 of file fs_workload.hh.

Referenced by startup(), and ~FsLinux().

◆ skipConstUDelay

PCEvent* gem5::ArmISA::FsLinux::skipConstUDelay = nullptr
private

Another PC based skip event for const_udelay().

Similar to the udelay skip, but this function precomputes the first multiply that is done in the generic case since the parameter is known at compile time. Thus we need to do some division to get back to us.

Definition at line 141 of file fs_workload.hh.

Referenced by startup(), and ~FsLinux().

◆ skipUDelay

PCEvent* gem5::ArmISA::FsLinux::skipUDelay = nullptr
private

PC based event to skip udelay(<time>) calls and quiesce the processor for the appropriate amount of time.

This is not functionally required but does speed up simulation.

Definition at line 134 of file fs_workload.hh.

Referenced by startup(), and ~FsLinux().

◆ taskFile

OutputStream* gem5::ArmISA::FsLinux::taskFile = nullptr

This is a file that is placed in the run directory that prints out mappings between taskIds and OS process IDs.

Definition at line 103 of file fs_workload.hh.

Referenced by gem5::ArmISA::DumpStats::process(), and startup().

◆ taskMap

std::map<uint32_t, uint32_t> gem5::ArmISA::FsLinux::taskMap

This map stores a mapping of OS process IDs to internal Task IDs.

The mapping is done because the stats system doesn't tend to like vectors that are much greater than 1000 items and the entire process space is 65K.

Definition at line 99 of file fs_workload.hh.

Referenced by mapPid(), gem5::ArmISA::DumpStats::process(), and startup().


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

Generated on Tue Sep 21 2021 12:28:32 for gem5 by doxygen 1.8.17