#include <semihosting.hh>

Inheritance diagram for gem5::BaseSemihosting::File:

Public Member Functions
	File (BaseSemihosting &_parent, const char name, const char mode)

	~File ()

void	serialize (CheckpointOut &cp) const override
	Serialize an object.

void	unserialize (CheckpointIn &cp) override
	Unserialize an object.

int64_t	open () override
	Open the the file.

int64_t	close () override
	Close the file.

bool	isTTY () const override
	Check if a file corresponds to a TTY device.

int64_t	read (uint8_t *buffer, uint64_t size) override
	Read data from file.

int64_t	write (const uint8_t *buffer, uint64_t size) override
	Write data to file.

int64_t	seek (uint64_t pos) override
	Seek to an absolute position in the file.

int64_t	flen () override
	Get the length of a file in bytes.

Public Member Functions inherited from gem5::BaseSemihosting::FileBase
	FileBase (BaseSemihosting &_parent, const char name, const char _mode)

virtual	~FileBase ()

	FileBase ()=delete

	FileBase (FileBase &)=delete

void	serialize (CheckpointOut &cp) const override
	Serialize an object.

void	unserialize (CheckpointIn &cp) override
	Unserialize an object.

const std::string &	fileName ()

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.

void	serializeSection (CheckpointOut &cp, const std::string &name) const

void	unserializeSection (CheckpointIn &cp, const char *name)
	Unserialize an a child object.

void	unserializeSection (CheckpointIn &cp, const std::string &name)

Protected Member Functions
int64_t	openImpl (bool unserialize)

bool	needClose () const

Protected Attributes
FILE *	file

Protected Attributes inherited from gem5::BaseSemihosting::FileBase
BaseSemihosting &	parent

std::string	_name

std::string	mode

Additional Inherited Members
Static Public Member Functions inherited from gem5::BaseSemihosting::FileBase
static std::unique_ptr< FileBase >	create (BaseSemihosting &parent, const std::string &fname, const char *mode)

static std::unique_ptr< FileBase >	create (BaseSemihosting &parent, CheckpointIn &cp, const std::string &sec)

Static Public Member Functions inherited from gem5::Serializable
static const std::string &	currentSection ()
	Gets the fully-qualified name of the active section.

static void	generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
	Generate a checkpoint file so that the serialization can be routed to it.

Detailed Description

Definition at line 333 of file semihosting.hh.

Constructor & Destructor Documentation

◆ File()

gem5::BaseSemihosting::File::File	(	BaseSemihosting &	_parent,
		const char *	name,
		const char *	mode )

Definition at line 719 of file semihosting.cc.

◆ ~File()

gem5::BaseSemihosting::File::~File ( )

Definition at line 724 of file semihosting.cc.

Member Function Documentation

◆ close()

int64_t gem5::BaseSemihosting::File::close ( )

overridevirtual

Close the file.

Returns: <0 on error (-errno), 0 on success.

Reimplemented from gem5::BaseSemihosting::FileBase.

Definition at line 761 of file semihosting.cc.

References panic_if.

◆ flen()

int64_t gem5::BaseSemihosting::File::flen ( )

overridevirtual

Get the length of a file in bytes.

Returns: <0 on error (-errno), length on success

Reimplemented from gem5::BaseSemihosting::FileBase.

Definition at line 823 of file semihosting.cc.

References gem5::ArmISA::len.

◆ isTTY()

bool gem5::BaseSemihosting::File::isTTY ( ) const

overridevirtual

Check if a file corresponds to a TTY device.

Returns: True if the file is a TTY, false otherwise.

Reimplemented from gem5::BaseSemihosting::FileBase.

Definition at line 774 of file semihosting.cc.

Referenced by needClose().

◆ needClose()

bool gem5::BaseSemihosting::File::needClose ( ) const

inlineprotected

Definition at line 357 of file semihosting.hh.

References isTTY().

◆ open()

int64_t gem5::BaseSemihosting::File::open ( )

inlineoverridevirtual

Open the the file.

Semihosting file IO interfaces

These interfaces implement common IO functionality in the Semihosting interface.

All functions return a negative value that corresponds to a UNIX errno value when they fail and >=0 on success.

Returns: <0 on error (-errno), 0 on success.

Reimplemented from gem5::BaseSemihosting::FileBase.

Definition at line 343 of file semihosting.hh.

References openImpl().

◆ openImpl()

int64_t gem5::BaseSemihosting::File::openImpl ( bool unserialize )

protected

Definition at line 732 of file semihosting.cc.

References gem5::Named::_name, gem5::ArmISA::mode, panic_if, and warn.

Referenced by open().

◆ read()

int64_t gem5::BaseSemihosting::File::read	(	uint8_t *	buffer,
		uint64_t	size )

overridevirtual

Read data from file.

Returns: <0 on error (-errno), bytes read on success (0 for EOF).

Reimplemented from gem5::BaseSemihosting::FileBase.

Definition at line 781 of file semihosting.cc.

References panic_if.

◆ seek()

int64_t gem5::BaseSemihosting::File::seek ( uint64_t pos )

overridevirtual

Seek to an absolute position in the file.

Parameters

pos	Byte offset from start of file.

Returns: <0 on error (-errno), 0 on success.

Reimplemented from gem5::BaseSemihosting::FileBase.

Definition at line 811 of file semihosting.cc.

References panic_if.

◆ serialize()

void gem5::BaseSemihosting::File::serialize ( CheckpointOut & cp ) const

overridevirtual

Serialize an object.

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

Parameters

cp	Checkpoint state

Implements gem5::Serializable.

Definition at line 844 of file semihosting.cc.

References panic_if, gem5::BaseSemihosting::FileBase::serialize(), and SERIALIZE_SCALAR.

◆ unserialize()

void gem5::BaseSemihosting::File::unserialize ( CheckpointIn & cp )

overridevirtual

Unserialize an object.

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

Parameters

cp	Checkpoint state

Implements gem5::Serializable.

Definition at line 856 of file semihosting.cc.

References gem5::Named::_name, fatal, gem5::BaseSemihosting::FileBase::unserialize(), and UNSERIALIZE_SCALAR.

◆ write()

int64_t gem5::BaseSemihosting::File::write	(	const uint8_t *	buffer,
		uint64_t	size )

overridevirtual

Write data to file.

Returns: <0 on error (-errno), bytes written on success.

Reimplemented from gem5::BaseSemihosting::FileBase.

Definition at line 796 of file semihosting.cc.

References panic_if.

Member Data Documentation

◆ file

FILE* gem5::BaseSemihosting::File::file

protected

Definition at line 362 of file semihosting.hh.

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

arch/generic/semihosting.hh
arch/generic/semihosting.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ File()

◆ ~File()

Member Function Documentation

◆ close()

◆ flen()

◆ isTTY()

◆ needClose()

◆ open()

◆ openImpl()

◆ read()

◆ seek()

◆ serialize()

◆ unserialize()

◆ write()

Member Data Documentation

◆ file