#include <SkipListLatencyBufferModel.hpp>

Inheritance diagram for dunedaq::datahandlinglibs::SkipListLatencyBufferModel< T >:

Collaboration diagram for dunedaq::datahandlinglibs::SkipListLatencyBufferModel< T >:

Classes
struct	Iterator

Public Types
using	SkipListT = typename folly::ConcurrentSkipList<T>
using	SkipListTIter = typename SkipListT::iterator
using	SkipListTAcc = typename folly::ConcurrentSkipList<T>::Accessor
using	SkipListTSkip = typename folly::ConcurrentSkipList<T>::Skipper
Public Types inherited from dunedaq::opmonlib::MonitorableObject
using	NodePtr = std::weak_ptr<MonitorableObject>
using	NewNodePtr = std::shared_ptr<MonitorableObject>
using	ElementId = std::string

Public Member Functions
	SkipListLatencyBufferModel ()
void	conf (const appmodel::LatencyBuffer *) override
	Configure the LB.
void	scrap (const appfwk::DAQModule::CommandData_t &) override
	Unconfigure the LB.
std::shared_ptr< SkipListT > &	get_skip_list ()
size_t	occupancy () const override
	Occupancy of LB.
void	flush () override
	Flush all elements from the latency buffer.
bool	write (T &&new_element) override
	Move referenced object into LB.
std::pair< const T *, bool >	write_and_return (T &&new_element)
bool	put (T &new_element)
bool	read (T &element) override
	Move object from LB to referenced.
void	allocate_memory (size_t) override
	Allocate memory for LB.
Iterator	begin ()
Iterator	end ()
Iterator	lower_bound (T &element, bool with_errors=false)
const T *	front () override
	Get pointer to the front of the LB.
const T *	back () override
	Get pointer to the back of the LB.
void	pop (size_t num=1) override
Public Member Functions inherited from dunedaq::datahandlinglibs::LatencyBufferConcept< T >
	LatencyBufferConcept ()
virtual	~LatencyBufferConcept ()
	LatencyBufferConcept (const LatencyBufferConcept &)=delete
	LatencyBufferConcept is not copy-constructible.
LatencyBufferConcept &	operator= (const LatencyBufferConcept &)=delete
	LatencyBufferConcept is not copy-assginable.
	LatencyBufferConcept (LatencyBufferConcept &&)=delete
	LatencyBufferConcept is not move-constructible.
LatencyBufferConcept &	operator= (LatencyBufferConcept &&)=delete
	LatencyBufferConcept is not move-assignable.
virtual void	pop (std::size_t amount)=0
	Pop specified amount of elements from LB.
Public Member Functions inherited from dunedaq::opmonlib::MonitorableObject
	MonitorableObject (const MonitorableObject &)=delete
MonitorableObject &	operator= (const MonitorableObject &)=delete
	MonitorableObject (MonitorableObject &&)=delete
MonitorableObject &	operator= (MonitorableObject &&)=delete
virtual	~MonitorableObject ()=default
auto	get_opmon_id () const noexcept
auto	get_opmon_level () const noexcept

Static Public Attributes
static constexpr bool	expects_order = false

Protected Member Functions
virtual void	generate_opmon_data () override
Protected Member Functions inherited from dunedaq::opmonlib::MonitorableObject
	MonitorableObject ()=default
void	register_node (ElementId name, NewNodePtr)
void	publish (google::protobuf::Message &&, CustomOrigin &&co={}, OpMonLevel l=to_level(EntryOpMonLevel::kDefault)) const noexcept

Private Attributes
std::shared_ptr< SkipListT >	m_skip_list

Static Private Attributes
static constexpr uint32_t	unconfigured_head_height = 2

Additional Inherited Members
Static Public Member Functions inherited from dunedaq::opmonlib::MonitorableObject
static bool	publishable_metric (OpMonLevel entry, OpMonLevel system) noexcept

Detailed Description

template<class T>
class dunedaq::datahandlinglibs::SkipListLatencyBufferModel< T >

Definition at line 28 of file SkipListLatencyBufferModel.hpp.

Member Typedef Documentation

◆ SkipListT

template<class T>

using dunedaq::datahandlinglibs::SkipListLatencyBufferModel< T >::SkipListT = typename folly::ConcurrentSkipList<T>

Definition at line 33 of file SkipListLatencyBufferModel.hpp.

◆ SkipListTAcc

template<class T>

using dunedaq::datahandlinglibs::SkipListLatencyBufferModel< T >::SkipListTAcc = typename folly::ConcurrentSkipList<T>::Accessor

Definition at line 35 of file SkipListLatencyBufferModel.hpp.

◆ SkipListTIter

template<class T>

using dunedaq::datahandlinglibs::SkipListLatencyBufferModel< T >::SkipListTIter = typename SkipListT::iterator

Definition at line 34 of file SkipListLatencyBufferModel.hpp.

◆ SkipListTSkip

template<class T>

using dunedaq::datahandlinglibs::SkipListLatencyBufferModel< T >::SkipListTSkip = typename folly::ConcurrentSkipList<T>::Skipper

Definition at line 36 of file SkipListLatencyBufferModel.hpp.

Constructor & Destructor Documentation

◆ SkipListLatencyBufferModel()

template<class T>

dunedaq::datahandlinglibs::SkipListLatencyBufferModel< T >::SkipListLatencyBufferModel ( )

inline

Definition at line 41 of file SkipListLatencyBufferModel.hpp.

    : m_skip_list(folly::ConcurrentSkipList<T>::createInstance(unconfigured_head_height))
  {
    TLOG(TLVL_WORK_STEPS) << "Initializing non configured latency buffer";
  }

Member Function Documentation

◆ allocate_memory()

template<class T>

void dunedaq::datahandlinglibs::SkipListLatencyBufferModel< T >::allocate_memory ( size_t )

inlineoverridevirtual

Allocate memory for LB.

Implements dunedaq::datahandlinglibs::LatencyBufferConcept< T >.

Definition at line 105 of file SkipListLatencyBufferModel.hpp.

  {
      TLOG(TLVL_DEBUG) << "SkipListLatencyBufferModel::allocate_memory not implemented.";
  }

◆ back()

template<class T>

const T * dunedaq::datahandlinglibs::SkipListLatencyBufferModel< T >::back ( )

overridevirtual

Get pointer to the back of the LB.

Implements dunedaq::datahandlinglibs::LatencyBufferConcept< T >.

Definition at line 114 of file SkipListLatencyBufferModel.hxx.

{
  SkipListTAcc acc(m_skip_list);
  return acc.last();
}

◆ begin()

template<class T>

SkipListLatencyBufferModel< T >::Iterator dunedaq::datahandlinglibs::SkipListLatencyBufferModel< T >::begin ( )

Definition at line 79 of file SkipListLatencyBufferModel.hxx.

{
  SkipListTAcc acc = SkipListTAcc(m_skip_list);
  SkipListTIter iter = acc.begin();
  return std::move(SkipListLatencyBufferModel<T>::Iterator(std::move(acc), iter));
}

◆ conf()

template<class T>

void dunedaq::datahandlinglibs::SkipListLatencyBufferModel< T >::conf ( const appmodel::LatencyBuffer * conf )

inlineoverridevirtual

Configure the LB.

Implements dunedaq::datahandlinglibs::LatencyBufferConcept< T >.

Definition at line 81 of file SkipListLatencyBufferModel.hpp.

  {
    // Reset datastructure
    m_skip_list = folly::ConcurrentSkipList<T>::createInstance(unconfigured_head_height);
  }

◆ end()

template<class T>

SkipListLatencyBufferModel< T >::Iterator dunedaq::datahandlinglibs::SkipListLatencyBufferModel< T >::end ( )

Definition at line 88 of file SkipListLatencyBufferModel.hxx.

{
  SkipListTAcc acc = SkipListTAcc(m_skip_list);
  SkipListTIter iter = acc.end();
  return std::move(SkipListLatencyBufferModel<T>::Iterator(std::move(acc), iter));
}

◆ flush()

template<class T>

void dunedaq::datahandlinglibs::SkipListLatencyBufferModel< T >::flush ( )

inlineoverridevirtual

Flush all elements from the latency buffer.

Implements dunedaq::datahandlinglibs::LatencyBufferConcept< T >.

Definition at line 99 of file SkipListLatencyBufferModel.hpp.

99{ pop(occupancy()); }

dunedaq::datahandlinglibs::SkipListLatencyBufferModel::occupancy

size_t occupancy() const override

Occupancy of LB.

Definition SkipListLatencyBufferModel.hxx:10

dunedaq::datahandlinglibs::SkipListLatencyBufferModel::pop

void pop(size_t num=1) override

Definition SkipListLatencyBufferModel.hxx:122

◆ front()

template<class T>

const T * dunedaq::datahandlinglibs::SkipListLatencyBufferModel< T >::front ( )

overridevirtual

Get pointer to the front of the LB.

Implements dunedaq::datahandlinglibs::LatencyBufferConcept< T >.

Definition at line 106 of file SkipListLatencyBufferModel.hxx.

{
  SkipListTAcc acc(m_skip_list);
  return acc.first();
}

◆ generate_opmon_data()

template<class T>

void dunedaq::datahandlinglibs::SkipListLatencyBufferModel< T >::generate_opmon_data ( )

overrideprotectedvirtual

Hook for customisable pubblication. The function can throw, exception will be caught by the monitoring thread

Reimplemented from dunedaq::opmonlib::MonitorableObject.

Definition at line 134 of file SkipListLatencyBufferModel.hxx.

                                                   {
   opmon::LatencyBufferInfo info;
   info.set_num_buffer_elements(occupancy());
   this->publish(std::move(info));
}

◆ get_skip_list()

template<class T>

std::shared_ptr< SkipListT > & dunedaq::datahandlinglibs::SkipListLatencyBufferModel< T >::get_skip_list ( )

inline

Definition at line 95 of file SkipListLatencyBufferModel.hpp.

95{ return std::ref(m_skip_list); }

◆ lower_bound()

template<class T>

SkipListLatencyBufferModel< T >::Iterator dunedaq::datahandlinglibs::SkipListLatencyBufferModel< T >::lower_bound	(	T &	element,
		bool	with_errors = false )

Definition at line 97 of file SkipListLatencyBufferModel.hxx.

{
  SkipListTAcc acc = SkipListTAcc(m_skip_list);
  SkipListTIter iter = acc.lower_bound(element);
  return std::move(SkipListLatencyBufferModel<T>::Iterator(std::move(acc), iter));
}

◆ occupancy()

template<class T>

size_t dunedaq::datahandlinglibs::SkipListLatencyBufferModel< T >::occupancy ( ) const

overridevirtual

Occupancy of LB.

Implements dunedaq::datahandlinglibs::LatencyBufferConcept< T >.

Definition at line 10 of file SkipListLatencyBufferModel.hxx.

{
  auto occupancy = 0;
  {
    SkipListTAcc acc(m_skip_list);
    occupancy = acc.size();
  }
  return occupancy;
}

◆ pop()

template<class T>

void dunedaq::datahandlinglibs::SkipListLatencyBufferModel< T >::pop ( size_t num = 1 )

override

Definition at line 122 of file SkipListLatencyBufferModel.hxx.

{
  {
    SkipListTAcc acc(m_skip_list);
    for (unsigned i = 0; i < num; ++i) {
      acc.pop_back();
    }
  }
}

◆ put()

template<class T>

bool dunedaq::datahandlinglibs::SkipListLatencyBufferModel< T >::put ( T & new_element )

Definition at line 50 of file SkipListLatencyBufferModel.hxx.

{
  bool success = false;
  {
    SkipListTAcc acc(m_skip_list);
    auto ret = acc.insert(new_element); // ret T = std::pair<iterator, bool>
    success = ret.second;
  }
  return success;
}

◆ read()

template<class T>

bool dunedaq::datahandlinglibs::SkipListLatencyBufferModel< T >::read ( T & element )

overridevirtual

Move object from LB to referenced.

Implements dunedaq::datahandlinglibs::LatencyBufferConcept< T >.

Definition at line 63 of file SkipListLatencyBufferModel.hxx.

{
  bool found = false;
  {
    SkipListTAcc acc(m_skip_list);
    auto lb_node = acc.begin();
    found = (lb_node == acc.end()) ? false : true;
    if (found) {
      element = *lb_node;
    }
  }
  return found;
}

◆ scrap()

template<class T>

void dunedaq::datahandlinglibs::SkipListLatencyBufferModel< T >::scrap ( const appfwk::DAQModule::CommandData_t & cfg )

inlineoverridevirtual

Unconfigure the LB.

Implements dunedaq::datahandlinglibs::LatencyBufferConcept< T >.

Definition at line 88 of file SkipListLatencyBufferModel.hpp.

  {
    // RS -> Cross-check, we don't need to flush first?
    m_skip_list = folly::ConcurrentSkipList<T>::createInstance(unconfigured_head_height);
  }

◆ write()

template<class T>

bool dunedaq::datahandlinglibs::SkipListLatencyBufferModel< T >::write ( T && element )

overridevirtual

Move referenced object into LB.

Implements dunedaq::datahandlinglibs::LatencyBufferConcept< T >.

Definition at line 22 of file SkipListLatencyBufferModel.hxx.

{
  bool success = false;
  {
    SkipListTAcc acc(m_skip_list);
    auto ret = acc.insert(std::move(new_element)); // ret T = std::pair<iterator, bool>
    success = ret.second;
  }
  return success;
}

◆ write_and_return()

template<class T>

std::pair< const T *, bool > dunedaq::datahandlinglibs::SkipListLatencyBufferModel< T >::write_and_return ( T && new_element )

Definition at line 35 of file SkipListLatencyBufferModel.hxx.

{
  const T* written = nullptr;
  bool success = false;
  {
    SkipListTAcc acc(m_skip_list);
    const auto [iter, result] = acc.insert(std::move(new_element));
    written = &(*iter);
    success = result;
  }
  return {written, success};
}

Member Data Documentation

◆ expects_order

template<class T>

bool dunedaq::datahandlinglibs::SkipListLatencyBufferModel< T >::expects_order = false

staticconstexpr

Definition at line 38 of file SkipListLatencyBufferModel.hpp.

◆ m_skip_list

template<class T>

std::shared_ptr<SkipListT> dunedaq::datahandlinglibs::SkipListLatencyBufferModel< T >::m_skip_list

private

Definition at line 126 of file SkipListLatencyBufferModel.hpp.

◆ unconfigured_head_height

template<class T>

uint32_t dunedaq::datahandlinglibs::SkipListLatencyBufferModel< T >::unconfigured_head_height = 2

staticconstexprprivate

Definition at line 129 of file SkipListLatencyBufferModel.hpp.

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

/github/workspace/dunedaq/sourcecode/datahandlinglibs/include/datahandlinglibs/models/SkipListLatencyBufferModel.hpp
/github/workspace/dunedaq/sourcecode/datahandlinglibs/include/datahandlinglibs/models/detail/SkipListLatencyBufferModel.hxx

Classes

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ SkipListT

◆ SkipListTAcc

◆ SkipListTIter

◆ SkipListTSkip

Constructor & Destructor Documentation

◆ SkipListLatencyBufferModel()

Member Function Documentation

◆ allocate_memory()

◆ back()

◆ begin()

◆ conf()

◆ end()

◆ flush()

◆ front()

◆ generate_opmon_data()

◆ get_skip_list()

◆ lower_bound()

◆ occupancy()

◆ pop()

◆ put()

◆ read()

◆ scrap()

◆ write()

◆ write_and_return()

Member Data Documentation

◆ expects_order

◆ m_skip_list

◆ unconfigured_head_height