Package ghidra.pcode.emu.unix

Class DefaultEmuUnixFileHandle<T>

java.lang.Object

ghidra.pcode.emu.unix.DefaultEmuUnixFileHandle<T>

Type Parameters:

T - the type of values stored by the file

All Implemented Interfaces:

EmuUnixFileDescriptor<T>

public class DefaultEmuUnixFileHandle<T>
extends Object
implements EmuUnixFileDescriptor<T>

A file descriptor associated with a file on a simulated UNIX file system

Field Summary

Fields

Modifier and Type	Field	Description
protected final PcodeArithmetic<T>	arithmetic
protected final EmuUnixFile<T>	file
protected final Set<EmuUnixFileSystem.OpenFlag>	flags
protected final int	offsetBytes
protected final EmuUnixUser	user

Fields inherited from interface ghidra.pcode.emu.unix.EmuUnixFileDescriptor

FD_STDERR, FD_STDIN, FD_STDOUT

Constructor Summary

Constructors

Constructor	Description
DefaultEmuUnixFileHandle(PcodeMachine<T> machine, CompilerSpec cSpec, EmuUnixFile<T> file, Set<EmuUnixFileSystem.OpenFlag> flags, EmuUnixUser user)	Construct a new handle on the given file

Method Summary

Modifier and Type	Method	Description
protected void	advanceOffset(T len)	Advance the handle's offset (negative to rewind)
void	checkReadable()	Check if the file is readable, throwing EmuIOException if not
void	checkWritable()	Check if the file is writable, throwing EmuIOException if not
void	close()	Close this descriptor
EmuUnixFile<T>	getFile()	Get the file opened to this handle
T	getOffset()	Get the current offset of the file, or 0 if not applicable
T	read(T buf)	Read from the file opened by this handle
void	seek(T offset)	See to the given offset
EmuUnixFileStat	stat()	Obtain the stat structure of the file opened by this handle
T	write(T buf)	Read into the file opened by this handle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

arithmetic

protected final PcodeArithmetic<T> arithmetic

file

protected final EmuUnixFile<T> file

flags

protected final Set<EmuUnixFileSystem.OpenFlag> flags

user

protected final EmuUnixUser user

offsetBytes

protected final int offsetBytes

Constructor Details

DefaultEmuUnixFileHandle

public DefaultEmuUnixFileHandle(PcodeMachine<T> machine,
 CompilerSpec cSpec,
 EmuUnixFile<T> file,
 Set<EmuUnixFileSystem.OpenFlag> flags,
 EmuUnixUser user)

Construct a new handle on the given file

Parameters:

machine - the machine emulating the hardware

cSpec - the ABI of the target platform

file - the file opened by this handle

flags - the user-specified flags, as defined by the simulator

user - the user that opened the file

See Also:

• AbstractEmuUnixSyscallUseropLibrary.createHandle(EmuUnixFile, int)

Method Details

getFile

public EmuUnixFile<T> getFile()

Get the file opened to this handle

Returns:

the file

checkReadable

public void checkReadable()

Check if the file is readable, throwing EmuIOException if not

checkWritable

public void checkWritable()

Check if the file is writable, throwing EmuIOException if not

advanceOffset

protected void advanceOffset(T len)

Advance the handle's offset (negative to rewind)

Parameters:

len - the number of bytes to advance

getOffset

public T getOffset()

Description copied from interface: EmuUnixFileDescriptor

Get the current offset of the file, or 0 if not applicable

Specified by:

getOffset in interface EmuUnixFileDescriptor<T>

Returns:

the offset

seek

public void seek(T offset)
          throws EmuIOException

Description copied from interface: EmuUnixFileDescriptor

See to the given offset

Specified by:

seek in interface EmuUnixFileDescriptor<T>

Parameters:

offset - the desired offset

Throws:

EmuIOException - if an error occurred

read

public T read(T buf)
       throws EmuIOException

Description copied from interface: EmuUnixFileDescriptor

Read from the file opened by this handle

Specified by:

read in interface EmuUnixFileDescriptor<T>

Parameters:

buf - the destination buffer

Returns:

the number of bytes read

Throws:

EmuIOException - if an error occurred

write

public T write(T buf)
        throws EmuIOException

Description copied from interface: EmuUnixFileDescriptor

Read into the file opened by this handle

Specified by:

write in interface EmuUnixFileDescriptor<T>

Parameters:

buf - the source buffer

Returns:

the number of bytes written

Throws:

EmuIOException - if an error occurred

stat

public EmuUnixFileStat stat()

Description copied from interface: EmuUnixFileDescriptor

Obtain the stat structure of the file opened by this handle

Specified by:

stat in interface EmuUnixFileDescriptor<T>

close

public void close()

Description copied from interface: EmuUnixFileDescriptor

Close this descriptor

Specified by:

close in interface EmuUnixFileDescriptor<T>