dunedaq::dpdklibs::SourceModel< TargetPayloadType > Class Template Reference

#include <SourceModel.hpp>

Inheritance diagram for dunedaq::dpdklibs::SourceModel< TargetPayloadType >:

Collaboration diagram for dunedaq::dpdklibs::SourceModel< TargetPayloadType >:

Public Types
using	sink_t = iomanager::SenderConcept<TargetPayloadType>
using	inherited = SourceConcept
using	data_t = nlohmann::json
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
	SourceModel ()
	SourceModel Constructor.
	~SourceModel ()
void	set_sink (const std::string &sink_name, bool callback_mode) override
void	acquire_callback () override
std::shared_ptr< sink_t > &	get_sink ()
void	handle_daq_frame (char *buffer, std::size_t size)
void	generate_opmon_data () override
Public Member Functions inherited from dunedaq::dpdklibs::SourceConcept
	SourceConcept ()
virtual	~SourceConcept ()
	SourceConcept (const SourceConcept &)=delete
	SourceConcept is not copy-constructible.
SourceConcept &	operator= (const SourceConcept &)=delete
	SourceConcept is not copy-assginable.
	SourceConcept (SourceConcept &&)=delete
	SourceConcept is not move-constructible.
SourceConcept &	operator= (SourceConcept &&)=delete
	SourceConcept is not move-assignable.
void	set_sink_name (const std::string &sink_name)
void	disable_daq_protocol_checks ()
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

Private Types
using	sink_cb_t = std::shared_ptr<std::function<void(TargetPayloadType&&)>>

Private Attributes
const std::size_t	m_expected_frame_size = sizeof(TargetPayloadType)
std::string	m_sink_id
bool	m_sink_is_set { false }
std::shared_ptr< sink_t >	m_sink_queue
bool	m_callback_mode
bool	m_callback_is_acquired { false }
sink_cb_t	m_sink_callback
std::atomic< uint64_t >	m_leftover_bytes_encountered {0}
std::atomic< uint64_t >	m_failed_to_send_daq_payloads {0}

Additional Inherited Members
Static Public Member Functions inherited from dunedaq::opmonlib::MonitorableObject
static bool	publishable_metric (OpMonLevel entry, OpMonLevel system) noexcept
Public Attributes inherited from dunedaq::dpdklibs::SourceConcept
std::string	m_sink_name
bool	m_daq_protocol_ensured { true }
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

Detailed Description

template<class TargetPayloadType>
class dunedaq::dpdklibs::SourceModel< TargetPayloadType >

Definition at line 35 of file SourceModel.hpp.

Member Typedef Documentation

data_t

template<class TargetPayloadType >

using dunedaq::dpdklibs::SourceModel< TargetPayloadType >::data_t = nlohmann::json

Definition at line 40 of file SourceModel.hpp.

inherited

template<class TargetPayloadType >

using dunedaq::dpdklibs::SourceModel< TargetPayloadType >::inherited = SourceConcept

Definition at line 39 of file SourceModel.hpp.

sink_cb_t

template<class TargetPayloadType >

using dunedaq::dpdklibs::SourceModel< TargetPayloadType >::sink_cb_t = std::shared_ptr<std::function<void(TargetPayloadType&&)>>

private

Definition at line 145 of file SourceModel.hpp.

sink_t

template<class TargetPayloadType >

using dunedaq::dpdklibs::SourceModel< TargetPayloadType >::sink_t = iomanager::SenderConcept<TargetPayloadType>

Definition at line 38 of file SourceModel.hpp.

Constructor & Destructor Documentation

SourceModel()

template<class TargetPayloadType >

dunedaq::dpdklibs::SourceModel< TargetPayloadType >::SourceModel ( )

inline

SourceModel Constructor.

Parameters

name	Instance name for this SourceModel instance

Definition at line 46 of file SourceModel.hpp.

    : SourceConcept()
  {}

~SourceModel()

template<class TargetPayloadType >

dunedaq::dpdklibs::SourceModel< TargetPayloadType >::~SourceModel ( )

inline

Definition at line 49 of file SourceModel.hpp.

{}

Member Function Documentation

acquire_callback()

template<class TargetPayloadType >

void dunedaq::dpdklibs::SourceModel< TargetPayloadType >::acquire_callback ( )

inlineoverridevirtual

Implements dunedaq::dpdklibs::SourceConcept.

Definition at line 66 of file SourceModel.hpp.

  {
    if (m_callback_mode) {
      if (m_callback_is_acquired) {
        TLOG_DEBUG(5) << "SourceModel callback is already acquired!";
      } else {
        // Getting DataMoveCBRegistry
        auto dmcbr = datahandlinglibs::DataMoveCallbackRegistry::get();
        m_sink_callback = dmcbr->get_callback<TargetPayloadType>(inherited::m_sink_name);
        m_callback_is_acquired = true;
      }
    } else {
      TLOG_DEBUG(5) << "Won't acquire callback, as IOM sink is set!";
    }
  }

generate_opmon_data()

template<class TargetPayloadType >

void dunedaq::dpdklibs::SourceModel< TargetPayloadType >::generate_opmon_data ( )

inlineoverridevirtual

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

Reimplemented from dunedaq::opmonlib::MonitorableObject.

Definition at line 120 of file SourceModel.hpp.

                                      {
      
    if(m_failed_to_send_daq_payloads != 0) {
        ers::warning(FailedToSendData(ERS_HERE, m_sink_id, m_failed_to_send_daq_payloads));
    }
 
    opmon::SourceInfo info;
    info.set_failed_to_send_daq_payloads( m_failed_to_send_daq_payloads.exchange(0) );
    info.set_leftover_bytes_encountered( m_leftover_bytes_encountered.exchange(0) );
 
    publish( std::move(info) );
  }

get_sink()

template<class TargetPayloadType >

std::shared_ptr< sink_t > & dunedaq::dpdklibs::SourceModel< TargetPayloadType >::get_sink ( )

inline

Definition at line 83 of file SourceModel.hpp.

{ return m_sink_queue; }

handle_daq_frame()

template<class TargetPayloadType >

void dunedaq::dpdklibs::SourceModel< TargetPayloadType >::handle_daq_frame ( char * buffer, std::size_t size )

inlinevirtual

Implements dunedaq::dpdklibs::SourceConcept.

Definition at line 86 of file SourceModel.hpp.

  {
    // Calculate how many full frames fit in the incoming message buffer.
    std::size_t full_frames = size / m_expected_frame_size;
    
    // Calculate leftover bytes that don't form a complete frame.
    if (size % m_expected_frame_size > 0) [[unlikely]] {
      ++m_leftover_bytes_encountered;
    }
    
    // Process each full frames
    for (std::size_t i = 0; i < full_frames; ++i) {
      // Calculate pointer to the i-th frame chunk inside the message buffer.
      const char* src = buffer + i * m_expected_frame_size;
    
      // Materialize a real TargetPayloadType object by copying bytes from the buffer.
      // This is defined behavior, alignment-safe, and fast, without pointer vodoo
      // Previously reinterpret_cast to TargetPayloadType* introduced alignment traps 
      // “pretend there’s a constructed object there” UB. Scatter won't work like that.
      TargetPayloadType frame;
      std::memcpy(&frame, src, m_expected_frame_size);
 
      if (m_callback_mode) {
        // Pass by value (moved); no references into 'buffer', so no UAF.
        (*m_sink_callback)(std::move(frame));
      } else {
        // Queue mode: attempt to enqueue the frame in a non-blocking way.
        if (!m_sink_queue->try_send(std::move(frame), iomanager::Sender::s_no_block)) {
           ++m_failed_to_send_daq_payloads;
        }
      }
    }
  }

set_sink()

template<class TargetPayloadType >

void dunedaq::dpdklibs::SourceModel< TargetPayloadType >::set_sink ( const std::string & sink_name, bool callback_mode )

inlineoverridevirtual

Implements dunedaq::dpdklibs::SourceConcept.

Definition at line 51 of file SourceModel.hpp.

  {
    m_callback_mode = callback_mode;
    if (callback_mode) {
      TLOG_DEBUG(5) << "Callback mode requested. Won't acquire iom sender!";
    } else {
      if (m_sink_is_set) {
        TLOG_DEBUG(5) << "SourceModel sink is already set in initialized!";
      } else {
        m_sink_queue = get_iom_sender<TargetPayloadType>(sink_name);
        m_sink_is_set = true;
      }
    }
  }

Member Data Documentation

m_callback_is_acquired

template<class TargetPayloadType >

bool dunedaq::dpdklibs::SourceModel< TargetPayloadType >::m_callback_is_acquired { false }

private

Definition at line 144 of file SourceModel.hpp.

{ false };

m_callback_mode

template<class TargetPayloadType >

bool dunedaq::dpdklibs::SourceModel< TargetPayloadType >::m_callback_mode

private

Definition at line 143 of file SourceModel.hpp.

m_expected_frame_size

template<class TargetPayloadType >

const std::size_t dunedaq::dpdklibs::SourceModel< TargetPayloadType >::m_expected_frame_size = sizeof(TargetPayloadType)

private

Definition at line 135 of file SourceModel.hpp.

m_failed_to_send_daq_payloads

template<class TargetPayloadType >

std::atomic<uint64_t> dunedaq::dpdklibs::SourceModel< TargetPayloadType >::m_failed_to_send_daq_payloads {0}

private

Definition at line 150 of file SourceModel.hpp.

{0};

m_leftover_bytes_encountered

template<class TargetPayloadType >

std::atomic<uint64_t> dunedaq::dpdklibs::SourceModel< TargetPayloadType >::m_leftover_bytes_encountered {0}

private

Definition at line 149 of file SourceModel.hpp.

{0};

m_sink_callback

template<class TargetPayloadType >

sink_cb_t dunedaq::dpdklibs::SourceModel< TargetPayloadType >::m_sink_callback

private

Definition at line 146 of file SourceModel.hpp.

m_sink_id

template<class TargetPayloadType >

std::string dunedaq::dpdklibs::SourceModel< TargetPayloadType >::m_sink_id

private

Definition at line 138 of file SourceModel.hpp.

m_sink_is_set

template<class TargetPayloadType >

bool dunedaq::dpdklibs::SourceModel< TargetPayloadType >::m_sink_is_set { false }

private

Definition at line 139 of file SourceModel.hpp.

{ false };

m_sink_queue

template<class TargetPayloadType >

std::shared_ptr<sink_t> dunedaq::dpdklibs::SourceModel< TargetPayloadType >::m_sink_queue

private

Definition at line 140 of file SourceModel.hpp.

---

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

• /github/workspace/dunedaq/sourcecode/dpdklibs/src/SourceModel.hpp