gem5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Protected Attributes | List of all members
RawDiskImage Class Reference

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

#include <disk_image.hh>

Inheritance diagram for RawDiskImage:
DiskImage SimObject EventManager Serializable Drainable

Public Types

typedef RawDiskImageParams Params
 
- Public Types inherited from DiskImage
typedef DiskImageParams Params
 
- Public Types inherited from 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 DiskImage
 DiskImage (const Params *p)
 
virtual ~DiskImage ()
 
- Public Member Functions inherited from SimObject
const Paramsparams () const
 
 SimObject (const Params *_params)
 
virtual ~SimObject ()
 
virtual const std::string name () const
 
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 regStats ()
 Register statistics for this object. More...
 
virtual void resetStats ()
 Reset statistics associated with this object. 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 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
 EventManager (EventManager &em)
 
 EventManager (EventManager *em)
 
 EventManager (EventQueue *eq)
 
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)
 
void setCurTick (Tick newVal)
 
- 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...
 

Protected Attributes

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

Additional Inherited Members

- 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 ()
 Get the fully-qualified name of the active section. More...
 
static void serializeAll (const std::string &cpt_dir)
 
static void unserializeGlobals (CheckpointIn &cp)
 
- Static Public Attributes inherited from Serializable
static int ckptCount = 0
 
static int ckptMaxCount = 0
 
static int ckptPrevCount = -1
 
- 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...
 

Detailed Description

Specialization for accessing a raw disk image.

Definition at line 72 of file disk_image.hh.

Member Typedef Documentation

typedef RawDiskImageParams RawDiskImage::Params

Definition at line 81 of file disk_image.hh.

Constructor & Destructor Documentation

RawDiskImage::RawDiskImage ( const Params p)

Definition at line 60 of file disk_image.cc.

References open().

RawDiskImage::~RawDiskImage ( )

Definition at line 64 of file disk_image.cc.

References close().

Member Function Documentation

void RawDiskImage::close ( )

Definition at line 96 of file disk_image.cc.

References stream.

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

void RawDiskImage::notifyFork ( )
overridevirtual

Notify a child process of a fork.

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

Definition at line 68 of file disk_image.cc.

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

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

Definition at line 79 of file disk_image.cc.

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

Referenced by notifyFork(), and RawDiskImage().

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

Implements DiskImage.

Definition at line 115 of file disk_image.cc.

References DDUMP, DPRINTF, DiskImage::initialized, panic, SectorSize, and stream.

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

Implements DiskImage.

Definition at line 102 of file disk_image.cc.

References disk_size, panic, SectorSize, and stream.

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

Implements DiskImage.

Definition at line 137 of file disk_image.cc.

References DDUMP, DPRINTF, DiskImage::initialized, panic, readonly, SectorSize, and stream.

Member Data Documentation

std::streampos RawDiskImage::disk_size
mutableprotected

Definition at line 78 of file disk_image.hh.

Referenced by size().

std::string RawDiskImage::file
protected

Definition at line 76 of file disk_image.hh.

Referenced by open().

bool RawDiskImage::readonly
protected

Definition at line 77 of file disk_image.hh.

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

std::fstream RawDiskImage::stream
mutableprotected

Definition at line 75 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 Fri Jun 9 2017 13:04:17 for gem5 by doxygen 1.8.6