#include <DiskImage.h>

Inheritance diagram for DiskImage:

Collaboration diagram for DiskImage:

Public Member Functions
bool	initialise ()

virtual void	getName (String &str)

virtual void	dump (String &str)

virtual uintptr_t	read (uint64_t location)

virtual size_t	getSize () const
	Gets the size of the disk. More...

virtual size_t	getBlockSize () const
	Gets the block size of the disk. More...

virtual void	pin (uint64_t location)
	Pins a cache page. More...

virtual void	unpin (uint64_t location)

Public Member Functions inherited from Disk
	Disk (Device *p)

virtual Type	getType ()

virtual SubType	getSubType ()

virtual void	write (uint64_t location)

virtual void	align (uint64_t location)
	Sets the page boundary alignment after a specific location on the disk. More...

virtual bool	cacheIsCritical ()
	Whether or not the cache is critical and cannot be flushed or deleted. More...

virtual void	flush (uint64_t location)
	Flush a cached page to disk. More...

Public Member Functions inherited from Device
	Device (Device *p)

Device *	getParent () const

void	setParent (Device *p)

virtual String	getSpecificType ()

virtual void	setSpecificType (String str)

void	setPciPosition (uint32_t bus, uint32_t device, uint32_t func)

void	setPciIdentifiers (uint8_t classCode, uint8_t subclassCode, uint16_t vendorId, uint16_t deviceId, uint8_t progIf)

void	setPciConfigHeader (const PciBus::ConfigSpace &space)

PciBus::ConfigSpace	getPciConfigHeader () const

uint8_t	getPciClassCode ()

uint8_t	getPciSubclassCode ()

uint16_t	getPciVendorId ()

uint16_t	getPciDeviceId ()

uint8_t	getPciProgInterface ()

uint32_t	getPciBusPosition ()

uint32_t	getPciDevicePosition ()

uint32_t	getPciFunctionNumber ()

virtual Vector< Address * > &	addresses ()

virtual uintptr_t	getInterruptNumber ()

virtual void	setInterruptNumber (uintptr_t n)

void	addChild (Device *pDevice)

Device *	getChild (size_t n)

size_t	getNumChildren ()

void	removeChild (size_t n)

void	removeChild (Device *d)

void	replaceChild (Device src, Device dest)

Private Attributes
void *	m_pBase

size_t	m_nSize

Cache	m_Cache

Additional Inherited Members
Public Types inherited from Disk
enum	SubType { ATA = 0, ATAPI }

Public Types inherited from Device
enum	Type { Generic, Root, Disk, Bus, Display, Network, Sound, Console, Mouse, Controller, UsbController, UsbGeneric, UsbContainer }

typedef Device (	Callback) (Device *)

Static Public Member Functions inherited from Device
static void	foreach (Callback callback, Device *root=0)

template<class F , class... Args>
static void	foreach (pedigree_std::Callable< F > &callback, Device *root, Args...args)

static void	addToRoot (Device *device)

static void	searchByVendorId (uint16_t vendorId, void(callback)(Device ), Device *root=0)

static void	searchByVendorIdAndDeviceId (uint16_t vendorId, uint16_t deviceId, void(callback)(Device ), Device *root=0)

static void	searchByClass (uint16_t classCode, void(callback)(Device ), Device *root=0)

static void	searchByClassAndSubclass (uint16_t classCode, uint16_t subclassCode, void(callback)(Device ), Device *root=0)

static void	searchByClassSubclassAndProgInterface (uint16_t classCode, uint16_t subclassCode, uint8_t progInterface, void(callback)(Device ), Device *root=0)

Protected Member Functions inherited from Device
	NOT_COPYABLE_OR_ASSIGNABLE (Device)

Static Protected Member Functions inherited from Device
static Device &	root ()

Protected Attributes inherited from Device
Vector< Address * >	m_Addresses

Vector< Device * >	m_Children

Device *	m_pParent

uintptr_t	m_InterruptNumber

String	m_SpecificType

PciBus::ConfigSpace	m_ConfigHeader

uint8_t	m_ClassCode

uint8_t	m_SubclassCode

uint16_t	m_VendorId

uint16_t	m_DeviceId

uint8_t	m_ProgInterface

uint32_t	m_PciBusPos

uint32_t	m_PciDevicePos

uint32_t	m_PciFunctionNum

Static Protected Attributes inherited from Device
static Device	m_Root

static Mutex	m_TreeLock

Detailed Description

Loads a disk image as a usable disk device.

Definition at line 27 of file DiskImage.h.

Member Function Documentation

virtual void DiskImage::dump ( String & str )

inlinevirtual

Dumps a textual representation of the device into the given string.

Reimplemented from Disk.

Definition at line 45 of file DiskImage.h.

References getSize(), and read().

virtual size_t DiskImage::getBlockSize ( ) const

inlinevirtual

Gets the block size of the disk.

This is the native block size with which all reads and writes are performed, regardless of how much data is available to be read/written.

Reimplemented from Disk.

Definition at line 54 of file DiskImage.h.

References pin(), and unpin().

Referenced by read().

Here is the caller graph for this function:

virtual void DiskImage::getName ( String & str )

inlinevirtual

Stores the device's name in str.

Reimplemented from Disk.

Definition at line 40 of file DiskImage.h.

size_t DiskImage::getSize ( ) const

virtual

Gets the size of the disk.

This is the size in bytes of the disk. Reads or writes beyond this size will fail.

Reimplemented from Disk.

Definition at line 70 of file DiskImage.cc.

Referenced by dump().

Here is the caller graph for this function:

void DiskImage::pin ( uint64_t location )

virtual

Pins a cache page.

This allows an upstream user of Disk pages to 'pin' cache pages, causing them to only be freed once all consumers have done an 'unpin'. The pin and unpin semantics allow for memory mappings to be made in a reasonably safe manner, as it can be assumed that the physical page for a particular cache block will not be freed.

Reimplemented from Disk.

Definition at line 75 of file DiskImage.cc.

References Cache::pin().

Referenced by getBlockSize().

Here is the caller graph for this function:

uintptr_t DiskImage::read ( uint64_t location )

virtual

Read from location on disk and return a pointer to it. location must be 512 byte aligned. The pointer returned is within a page of cache that maps to 4096 bytes of disk area.

Note: If the Disk is backed by a Cache, the buffer returned should have its refcount incremented by one by a successful run of read(). Use unpin() to indicate you no longer care about the buffer.

Parameters

location The offset from the start of the device, in bytes, to start the read, must be multiple of 512.

Returns: Pointer to writable area of memory containing the data. If the data is written, the page is marked as dirty and may be written back to disk at any time (or forced with write() or flush() ).

Reimplemented from Disk.

Definition at line 42 of file DiskImage.cc.

References ERROR, getBlockSize(), Cache::insert(), Cache::lookup(), and Cache::markNoLongerEditing().

Referenced by dump().

Here is the caller graph for this function: