VirtQueue::VirtRing< T > Class Template Reference

VirtIO ring buffer wrapper. More...

Classes
struct	Header

Public Types
typedef uint16_t	Flags
typedef uint16_t	Index

Public Member Functions
	VirtRing (PortProxy &proxy, ByteOrder bo, uint16_t size)
void	reset ()
	Reset any state in the ring buffer. More...
void	setAddress (Addr addr)
	Set the base address of the VirtIO ring buffer. More...
void	readHeader ()
	Update the ring buffer header with data from the guest. More...
void	writeHeader ()
void	read ()
void	write ()

Public Attributes
Header	header
	Ring buffer header in host byte order. More...
std::vector< T >	ring
	Elements in ring in host byte order. More...

Private Member Functions
	VirtRing ()

Private Attributes
PortProxy &	_proxy
	Guest physical memory proxy. More...
Addr	_base
	Guest physical base address of the ring buffer. More...
ByteOrder	byteOrder
	Byte order in the ring. More...

Detailed Description

template<typename T>
class VirtQueue::VirtRing< T >

VirtIO ring buffer wrapper.

This class wraps a VirtIO ring buffer. The template parameter T is used to select the data type for the items in the ring (used or available descriptors).

Definition at line 460 of file base.hh.

Member Typedef Documentation

Flags

template<typename T >

typedef uint16_t VirtQueue::VirtRing< T >::Flags

Definition at line 463 of file base.hh.

Index

template<typename T >

typedef uint16_t VirtQueue::VirtRing< T >::Index

Definition at line 464 of file base.hh.

Constructor & Destructor Documentation

VirtRing() [1/2]

template<typename T >

VirtQueue::VirtRing< T >::VirtRing ( PortProxy &  proxy, ByteOrder  bo, uint16_t  size  )

inline

Definition at line 471 of file base.hh.

VirtRing() [2/2]

template<typename T >

VirtQueue::VirtRing< T >::VirtRing ( )

private

Member Function Documentation

read()

template<typename T >

void VirtQueue::VirtRing< T >::read ( )

inline

Definition at line 511 of file base.hh.

Referenced by VirtQueue::consumeDescriptor().

readHeader()

template<typename T >

void VirtQueue::VirtRing< T >::readHeader ( )

inline

Update the ring buffer header with data from the guest.

Definition at line 492 of file base.hh.

Referenced by VirtQueue::produceDescriptor(), and VirtQueue::VirtRing< struct vring_used_elem >::read().

reset()

template<typename T >

void VirtQueue::VirtRing< T >::reset ( )

inline

Reset any state in the ring buffer.

Definition at line 477 of file base.hh.

Referenced by VirtQueue::reset().

setAddress()

template<typename T >

void VirtQueue::VirtRing< T >::setAddress ( Addr  addr )

inline

Set the base address of the VirtIO ring buffer.

Parameters

addr	New host physical address

Definition at line 488 of file base.hh.

Referenced by VirtQueue::setAddress().

write()

template<typename T >

void VirtQueue::VirtRing< T >::write ( )

inline

Definition at line 524 of file base.hh.

Referenced by VirtQueue::produceDescriptor().

writeHeader()

template<typename T >

void VirtQueue::VirtRing< T >::writeHeader ( )

inline

Definition at line 501 of file base.hh.

Referenced by VirtQueue::VirtRing< struct vring_used_elem >::write().

Member Data Documentation

_base

template<typename T >

Addr VirtQueue::VirtRing< T >::_base

private

Guest physical base address of the ring buffer.

Definition at line 549 of file base.hh.

Referenced by VirtQueue::VirtRing< struct vring_used_elem >::read(), VirtQueue::VirtRing< struct vring_used_elem >::readHeader(), VirtQueue::VirtRing< struct vring_used_elem >::reset(), VirtQueue::VirtRing< struct vring_used_elem >::setAddress(), VirtQueue::VirtRing< struct vring_used_elem >::write(), and VirtQueue::VirtRing< struct vring_used_elem >::writeHeader().

_proxy

template<typename T >

PortProxy& VirtQueue::VirtRing< T >::_proxy

private

Guest physical memory proxy.

Definition at line 547 of file base.hh.

Referenced by VirtQueue::VirtRing< struct vring_used_elem >::read(), VirtQueue::VirtRing< struct vring_used_elem >::readHeader(), VirtQueue::VirtRing< struct vring_used_elem >::write(), and VirtQueue::VirtRing< struct vring_used_elem >::writeHeader().

byteOrder

template<typename T >

ByteOrder VirtQueue::VirtRing< T >::byteOrder

private

Byte order in the ring.

Definition at line 551 of file base.hh.

Referenced by VirtQueue::VirtRing< struct vring_used_elem >::read(), VirtQueue::VirtRing< struct vring_used_elem >::readHeader(), VirtQueue::VirtRing< struct vring_used_elem >::write(), and VirtQueue::VirtRing< struct vring_used_elem >::writeHeader().

header

template<typename T >

Header VirtQueue::VirtRing< T >::header

Ring buffer header in host byte order.

Definition at line 538 of file base.hh.

Referenced by VirtQueue::consumeDescriptor(), VirtQueue::produceDescriptor(), VirtQueue::VirtRing< struct vring_used_elem >::read(), VirtQueue::VirtRing< struct vring_used_elem >::readHeader(), VirtQueue::VirtRing< struct vring_used_elem >::reset(), VirtQueue::VirtRing< struct vring_used_elem >::write(), and VirtQueue::VirtRing< struct vring_used_elem >::writeHeader().

ring

template<typename T >

std::vector<T> VirtQueue::VirtRing< T >::ring

Elements in ring in host byte order.

Definition at line 540 of file base.hh.

Referenced by VirtQueue::consumeDescriptor(), VirtQueue::produceDescriptor(), VirtQueue::VirtRing< struct vring_used_elem >::read(), and VirtQueue::VirtRing< struct vring_used_elem >::write().

---

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

• dev/virtio/base.hh