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

#include <disk_image.hh>

Inheritance diagram for RawDiskImage:

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 Params *	params () 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	regProbePoints ()
	Register probe points for this object. More...

virtual void	regProbeListeners ()
	Register probe listeners for this object. More...

ProbeManager *	getProbeManager ()
	Get the probe manager for this object. More...

virtual Port &	getPort (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
EventQueue *	eventQueue () 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...

Public Member Functions inherited from Stats::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 (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 Info *	resolveStat (std::string name) const
	Resolve a stat by its name within this group. More...

	Group ()=delete

	Group (const Group &)=delete

Group &	operator= (const Group &)=delete

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
EventQueue *	eventq
	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 SimObject *	find (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)

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 70 of file disk_image.hh.

Member Typedef Documentation

◆ Params

typedef RawDiskImageParams RawDiskImage::Params

Definition at line 79 of file disk_image.hh.

Constructor & Destructor Documentation

◆ RawDiskImage()

RawDiskImage::RawDiskImage ( const Params * p )

Definition at line 58 of file disk_image.cc.

References open(), and MipsISA::p.

◆ ~RawDiskImage()

RawDiskImage::~RawDiskImage ( )

Definition at line 62 of file disk_image.cc.

References close().

Member Function Documentation

◆ close()

void RawDiskImage::close ( )

Definition at line 94 of file disk_image.cc.

References stream.

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

◆ notifyFork()

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

Definition at line 66 of file disk_image.cc.

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

◆ open()

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

Definition at line 77 of file disk_image.cc.

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

Referenced by notifyFork(), and RawDiskImage().

◆ read()

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

overridevirtual

Implements DiskImage.

Definition at line 113 of file disk_image.cc.

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

◆ size()

std::streampos RawDiskImage::size ( ) const

overridevirtual

Implements DiskImage.

Definition at line 100 of file disk_image.cc.

References disk_size, panic, SectorSize, and stream.

◆ write()

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

overridevirtual

Implements DiskImage.

Definition at line 135 of file disk_image.cc.

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

Member Data Documentation

◆ disk_size

std::streampos RawDiskImage::disk_size

mutableprotected

Definition at line 76 of file disk_image.hh.

Referenced by size().

◆ file

std::string RawDiskImage::file

protected

Definition at line 74 of file disk_image.hh.

Referenced by open().

◆ readonly

bool RawDiskImage::readonly

protected

Definition at line 75 of file disk_image.hh.

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

◆ stream

std::fstream RawDiskImage::stream

mutableprotected

Definition at line 73 of file disk_image.hh.

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

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

dev/storage/disk_image.hh
dev/storage/disk_image.cc

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Params

Constructor & Destructor Documentation

◆ RawDiskImage()

◆ ~RawDiskImage()

Member Function Documentation

◆ close()

◆ notifyFork()

◆ open()

◆ read()

◆ size()

◆ write()

Member Data Documentation

◆ disk_size

◆ file

◆ readonly

◆ stream