gem5  v21.1.0.2
Public Types | Public Member Functions | Protected Attributes | List of all members
gem5::RawDiskImage Class Reference

Specialization for accessing a raw disk image. More...

#include <disk_image.hh>

Inheritance diagram for gem5::RawDiskImage:
gem5::DiskImage gem5::SimObject gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

Public Types

typedef RawDiskImageParams Params
 
- Public Types inherited from gem5::DiskImage
typedef DiskImageParams Params
 
- Public Types inherited from gem5::SimObject
typedef SimObjectParams Params
 

Public Member Functions

 RawDiskImage (const Params &p)
 
 ~RawDiskImage ()
 
void notifyFork () override
 Notify a child process of a fork. More...
 
void close ()
 
void open (const std::string &filename, bool rd_only=false)
 
std::streampos size () const override
 
std::streampos read (uint8_t *data, std::streampos offset) const override
 
std::streampos write (const uint8_t *data, std::streampos offset) override
 
- Public Member Functions inherited from gem5::DiskImage
 DiskImage (const Params &p)
 
virtual ~DiskImage ()
 
- 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 initState ()
 initState() is called on each SimObject when not 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 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...
 
- 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
 

Protected Attributes

std::fstream stream
 
std::string file
 
bool readonly
 
std::streampos disk_size
 
- Protected Attributes inherited from gem5::DiskImage
bool initialized
 
- 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...
 

Additional Inherited Members

- 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::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

Specialization for accessing a raw disk image.

Definition at line 73 of file disk_image.hh.

Member Typedef Documentation

◆ Params

typedef RawDiskImageParams gem5::RawDiskImage::Params

Definition at line 82 of file disk_image.hh.

Constructor & Destructor Documentation

◆ RawDiskImage()

gem5::RawDiskImage::RawDiskImage ( const Params p)

Definition at line 60 of file disk_image.cc.

References open(), and gem5::MipsISA::p.

◆ ~RawDiskImage()

gem5::RawDiskImage::~RawDiskImage ( )

Definition at line 66 of file disk_image.cc.

References close().

Member Function Documentation

◆ close()

void gem5::RawDiskImage::close ( )

Definition at line 100 of file disk_image.cc.

References stream.

Referenced by notifyFork(), and ~RawDiskImage().

◆ notifyFork()

void gem5::RawDiskImage::notifyFork ( )
overridevirtual

Notify a child process of a fork.

SimObjects are told that the process is going to be forked.

Forking is a process of splitting a process in to two processes, which is then used for multiprocessing.

When calling fork in gem5, we need to ensure that resources shared between the parent and the child are consistent. This method is intended to be overloaded to handle that. For example, an object could use this method to re-open input files to get a separate file description with a private file offset.

This method is only called in the child of the fork. The call takes place in a drained system.

Reimplemented from gem5::Drainable.

Definition at line 72 of file disk_image.cc.

References close(), gem5::DiskImage::initialized, open(), gem5::MipsISA::p, panic, gem5::SimObject::params(), and readonly.

◆ open()

void gem5::RawDiskImage::open ( const std::string &  filename,
bool  rd_only = false 
)

Definition at line 83 of file disk_image.cc.

References file, gem5::DiskImage::initialized, gem5::ArmISA::mode, panic, readonly, and stream.

Referenced by notifyFork(), and RawDiskImage().

◆ read()

std::streampos gem5::RawDiskImage::read ( uint8_t *  data,
std::streampos  offset 
) const
overridevirtual

◆ size()

std::streampos gem5::RawDiskImage::size ( ) const
overridevirtual

Implements gem5::DiskImage.

Definition at line 106 of file disk_image.cc.

References disk_size, panic, SectorSize, and stream.

◆ write()

std::streampos gem5::RawDiskImage::write ( const uint8_t *  data,
std::streampos  offset 
)
overridevirtual

Member Data Documentation

◆ disk_size

std::streampos gem5::RawDiskImage::disk_size
mutableprotected

Definition at line 79 of file disk_image.hh.

Referenced by size().

◆ file

std::string gem5::RawDiskImage::file
protected

Definition at line 77 of file disk_image.hh.

Referenced by open().

◆ readonly

bool gem5::RawDiskImage::readonly
protected

Definition at line 78 of file disk_image.hh.

Referenced by notifyFork(), open(), and write().

◆ stream

std::fstream gem5::RawDiskImage::stream
mutableprotected

Definition at line 76 of file disk_image.hh.

Referenced by close(), open(), read(), size(), and write().


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

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