gem5::CircleBuf< T > Class Template Reference

Circular buffer backed by a vector. More...

#include <circlebuf.hh>

Public Types
using	value_type = T

Public Member Functions
	CircleBuf (size_t size)
bool	empty () const
size_t	size () const
size_t	capacity () const
void	flush ()
	Throw away any data in the buffer. More...
template<class OutputIterator >
void	peek (OutputIterator out, size_t len) const
	Copy buffer contents without advancing the read pointer. More...
template<class OutputIterator >
void	peek (OutputIterator out, off_t offset, size_t len) const
	Copy buffer contents without advancing the read pointer. More...
template<class OutputIterator >
void	read (OutputIterator out, size_t len)
	Copy buffer contents and advance the read pointer. More...
template<class InputIterator >
void	write (InputIterator in, size_t len)
	Add elements to the end of the ring buffers and advance. More...

Private Attributes
std::vector< T >	buffer
size_t	start = 0
size_t	used = 0
size_t	maxSize

Detailed Description

template<typename T>
class gem5::CircleBuf< T >

Circular buffer backed by a vector.

The data in the cricular buffer is stored in a standard vector.

Definition at line 58 of file circlebuf.hh.

Member Typedef Documentation

value_type

template<typename T >

using gem5::CircleBuf< T >::value_type = T

Definition at line 67 of file circlebuf.hh.

Constructor & Destructor Documentation

CircleBuf()

template<typename T >

gem5::CircleBuf< T >::CircleBuf ( size_t  size )

inlineexplicit

Definition at line 69 of file circlebuf.hh.

Member Function Documentation

capacity()

template<typename T >

size_t gem5::CircleBuf< T >::capacity ( ) const

inline

Definition at line 73 of file circlebuf.hh.

References gem5::CircleBuf< T >::maxSize.

Referenced by gem5::Fifo< T >::capacity().

empty()

template<typename T >

bool gem5::CircleBuf< T >::empty ( ) const

inline

Definition at line 71 of file circlebuf.hh.

References gem5::CircleBuf< T >::used.

Referenced by gem5::Terminal::console_in(), gem5::Terminal::dataAvailable(), gem5::Fifo< T >::empty(), gem5::Terminal::readData(), and TEST().

flush()

template<typename T >

void gem5::CircleBuf< T >::flush ( )

inline

Throw away any data in the buffer.

Definition at line 79 of file circlebuf.hh.

References gem5::CircleBuf< T >::start, and gem5::CircleBuf< T >::used.

Referenced by gem5::arrayParamIn(), gem5::Fifo< T >::flush(), and gem5::CircleBuf< T >::write().

peek() [1/2]

template<typename T >

template<class OutputIterator >

void gem5::CircleBuf< T >::peek ( OutputIterator  out, off_t  offset, size_t  len  ) const

inline

Copy buffer contents without advancing the read pointer.

Parameters

out	Output iterator/pointer
offset	Offset into the ring buffer
len	Number of elements to copy

Definition at line 107 of file circlebuf.hh.

References gem5::CircleBuf< T >::buffer, len, gem5::CircleBuf< T >::maxSize, gem5::ArmISA::offset, panic_if, gem5::CircleBuf< T >::start, and gem5::CircleBuf< T >::used.

peek() [2/2]

template<typename T >

template<class OutputIterator >

void gem5::CircleBuf< T >::peek ( OutputIterator  out, size_t  len  ) const

inline

Copy buffer contents without advancing the read pointer.

Parameters

out	Output iterator/pointer
len	Number of elements to copy

Definition at line 93 of file circlebuf.hh.

References len.

Referenced by gem5::Terminal::accept(), gem5::arrayParamOut(), gem5::Fifo< T >::peek(), gem5::CircleBuf< T >::read(), and TEST().

read()

template<typename T >

template<class OutputIterator >

void gem5::CircleBuf< T >::read ( OutputIterator  out, size_t  len  )

inline

Copy buffer contents and advance the read pointer.

Parameters

out	Output iterator/pointer
len	Number of elements to read

Definition at line 140 of file circlebuf.hh.

References len, gem5::CircleBuf< T >::peek(), gem5::CircleBuf< T >::start, and gem5::CircleBuf< T >::used.

Referenced by gem5::Fifo< T >::read(), gem5::Terminal::readData(), and TEST().

size()

template<typename T >

size_t gem5::CircleBuf< T >::size ( ) const

inline

Definition at line 72 of file circlebuf.hh.

References gem5::CircleBuf< T >::used.

Referenced by gem5::Terminal::accept(), gem5::arrayParamOut(), gem5::Fifo< T >::size(), and TEST().

write()

template<typename T >

template<class InputIterator >

void gem5::CircleBuf< T >::write ( InputIterator  in, size_t  len  )

inline

Add elements to the end of the ring buffers and advance.

Writes which would exceed the capacity of the queue fill the avaialble space, and then continue overwriting the head of the queue. The head advances as if that data had been read out.

Parameters

in	Input iterator/pointer
len	Number of elements to read

Definition at line 158 of file circlebuf.hh.

References gem5::CircleBuf< T >::buffer, gem5::CircleBuf< T >::flush(), len, gem5::CircleBuf< T >::maxSize, sc_dt::overflow(), gem5::CircleBuf< T >::start, and gem5::CircleBuf< T >::used.

Referenced by gem5::arrayParamIn(), gem5::Terminal::data(), TEST(), gem5::Fifo< T >::write(), and gem5::Terminal::writeData().

Member Data Documentation

buffer

template<typename T >

std::vector<T> gem5::CircleBuf< T >::buffer

private

Definition at line 61 of file circlebuf.hh.

Referenced by gem5::CircleBuf< T >::peek(), and gem5::CircleBuf< T >::write().

maxSize

template<typename T >

size_t gem5::CircleBuf< T >::maxSize

private

Definition at line 64 of file circlebuf.hh.

Referenced by gem5::CircleBuf< T >::capacity(), gem5::CircleBuf< T >::peek(), and gem5::CircleBuf< T >::write().

start

template<typename T >

size_t gem5::CircleBuf< T >::start = 0

private

Definition at line 62 of file circlebuf.hh.

Referenced by gem5::CircleBuf< T >::flush(), gem5::CircleBuf< T >::peek(), gem5::CircleBuf< T >::read(), and gem5::CircleBuf< T >::write().

used

template<typename T >

size_t gem5::CircleBuf< T >::used = 0

private

Definition at line 63 of file circlebuf.hh.

Referenced by gem5::CircleBuf< T >::empty(), gem5::CircleBuf< T >::flush(), gem5::CircleBuf< T >::peek(), gem5::CircleBuf< T >::read(), gem5::CircleBuf< T >::size(), and gem5::CircleBuf< T >::write().

---

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

• base/circlebuf.hh