API referenceEmulation APIClasses

hololink::emulation::RoCEv2DataPlane

View as Markdown

The DataPlane implementation for RoCEv2 UDP transport.

#include <hololink/emulation/rocev2_data_plane.hpp>

Inherits from: hololink::emulation::DataPlane (public)

Constructors

RoCEv2DataPlane

hololink::emulation::RoCEv2DataPlane::RoCEv2DataPlane(
    HSBEmulator &hsb_emulator,
    const IPAddress &source_ip,
    uint8_t data_plane_id,
    uint8_t sensor_id
)

python:

def __init__(self: hemu.RoCEv2DataPlane, hsb_emulator: hemu.HSBEmulator, source_ip: hemu.IPAddress, data_plane_id: int, sensor_id: int)

Construct a new RoCEv2DataPlane object

Parameters

hsb_emulator
HSBEmulator &

The HSBEmulator object to attach to.

source_ip
const IPAddress &

The IP address of the DataPlane.

data_plane_id
uint8_t

The identifying index of the DataPlane.

sensor_id
uint8_t

The identifying index of the sensor interface associated with the DataPlane.

Destructor

~RoCEv2DataPlane

hololink::emulation::RoCEv2DataPlane::~RoCEv2DataPlane()

Methods

start

void hololink::emulation::RoCEv2DataPlane::start()

Start the DataPlane by initiating the BootP broadcast.

stop

void hololink::emulation::RoCEv2DataPlane::stop()

Stop the DataPlane by stopping the BootP broadcast.

stop_bootp

void hololink::emulation::RoCEv2DataPlane::stop_bootp()

This is a clear alias for stop().

is_running

bool hololink::emulation::RoCEv2DataPlane::is_running()

Check if the DataPlane is running.

(Bootp is broadcasting)

Returns: True if the DataPlane is running, false otherwise.

send

int64_t hololink::emulation::RoCEv2DataPlane::send(
    const DLTensor &tensor,
    FrameMetadata *frame_metadata = DEFAULT_FRAME_METADATA
)

Send a tensor over the DataPlane.

This method is synchronous. It will block and metadata will be protected by a mutex until the send is complete.

Returns: The number of bytes sent or < 0 if error occurred.

Parameters

tensor
const DLTensor &

The tensor object reference to send. Supported device types are kDLCPU, kDLCUDA, kDLCUDAHost (host pinned), and kDLCUDAManaged (Unified Memory)

frame_metadata
FrameMetadata *Defaults to DEFAULT_FRAME_METADATA

The frame metadata to send. Acts as a buffer flush. If nullptr, the data is by default buffered until the next send command that fills an MTU or a non-nullptr frame_metadata is provided.

get_sensor_id

uint8_t hololink::emulation::RoCEv2DataPlane::get_sensor_id() const

Get the sensor ID associated with the DataPlane.

Returns: The sensor ID.

packetizer_enabled

bool hololink::emulation::RoCEv2DataPlane::packetizer_enabled() const

Check if the packetizer is enabled.

Returns: True if the packetizer is enabled, false otherwise.

get_start_time

struct timespec hololink::emulation::RoCEv2DataPlane::get_start_time() const

broadcast_bootp

int hololink::emulation::RoCEv2DataPlane::broadcast_bootp()

update_metadata

void hololink::emulation::RoCEv2DataPlane::update_metadata() override

Update the TransmissionMetadata for the RoCEv2DataPlane.

Only one thread may call RoCEv2DataPlane::send at a time. DataPlane::send() ensures thread safety.

Member variables

NameTypeDescription
page_uint32_t
registers_AddressMemory &
ip_address_IPAddress
configuration_HSBConfiguration
sensor_id_uint8_t
data_plane_id_uint8_t
transmitter_BaseTransmitter *
data_plane_ctxt_std::unique_ptr< struct DataPlaneCtxt, std::function< void(DataPlaneCtxt *)> >