gem5  v22.0.0.2
Classes | Public Types | Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | List of all members
gem5::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 gem5::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 468 of file base.hh.

Member Typedef Documentation

◆ Flags

template<typename T >
typedef uint16_t gem5::VirtQueue::VirtRing< T >::Flags

Definition at line 471 of file base.hh.

◆ Index

template<typename T >
typedef uint16_t gem5::VirtQueue::VirtRing< T >::Index

Definition at line 472 of file base.hh.

Constructor & Destructor Documentation

◆ VirtRing() [1/2]

template<typename T >
gem5::VirtQueue::VirtRing< T >::VirtRing ( PortProxy proxy,
ByteOrder  bo,
uint16_t  size 
)
inline

Definition at line 480 of file base.hh.

◆ VirtRing() [2/2]

template<typename T >
gem5::VirtQueue::VirtRing< T >::VirtRing ( )
private

Member Function Documentation

◆ read()

template<typename T >
void gem5::VirtQueue::VirtRing< T >::read ( )
inline

Definition at line 520 of file base.hh.

Referenced by gem5::VirtQueue::consumeDescriptor().

◆ readHeader()

template<typename T >
void gem5::VirtQueue::VirtRing< T >::readHeader ( )
inline

Update the ring buffer header with data from the guest.

Definition at line 501 of file base.hh.

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

◆ reset()

template<typename T >
void gem5::VirtQueue::VirtRing< T >::reset ( )
inline

Reset any state in the ring buffer.

Definition at line 486 of file base.hh.

Referenced by gem5::VirtQueue::reset().

◆ setAddress()

template<typename T >
void gem5::VirtQueue::VirtRing< T >::setAddress ( Addr  addr)
inline

Set the base address of the VirtIO ring buffer.

Parameters
addrNew host physical address

Definition at line 497 of file base.hh.

Referenced by gem5::VirtQueue::setAddress().

◆ write()

template<typename T >
void gem5::VirtQueue::VirtRing< T >::write ( )
inline

Definition at line 533 of file base.hh.

Referenced by gem5::VirtQueue::produceDescriptor().

◆ writeHeader()

template<typename T >
void gem5::VirtQueue::VirtRing< T >::writeHeader ( )
inline

Definition at line 510 of file base.hh.

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

Member Data Documentation

◆ _base

template<typename T >
Addr gem5::VirtQueue::VirtRing< T >::_base
private

◆ _proxy

template<typename T >
PortProxy& gem5::VirtQueue::VirtRing< T >::_proxy
private

◆ byteOrder

template<typename T >
ByteOrder gem5::VirtQueue::VirtRing< T >::byteOrder
private

◆ header

template<typename T >
Header gem5::VirtQueue::VirtRing< T >::header

◆ ring

template<typename T >
std::vector<T> gem5::VirtQueue::VirtRing< T >::ring

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

Generated on Thu Jul 28 2022 13:33:18 for gem5 by doxygen 1.8.17