Struct RdmaDevice

pub struct RdmaDevice {
    pub name: String,
    /* private fields */
}

Represents an RDMA device in the system.

This struct encapsulates information about an RDMA device, including its hardware characteristics, capabilities, and port information. It provides access to device attributes such as vendor information, firmware version, and supported features.

Examples

use monarch_rdma::get_all_devices;

let devices = get_all_devices();
if let Some(device) = devices.first() {
    // Access device name and firmware version
    let device_name = device.name();
    let firmware_version = device.fw_ver();
}

Fields

name: String

name - The name of the RDMA device (e.g., “mlx5_0”).

Implementations

impl RdmaDevice

pub fn name(&self) -> &String

Returns the name of the RDMA device.

pub fn first_available() -> Option<RdmaDevice>

Returns the first available RDMA device, if any.

pub fn vendor_id(&self) -> u32

Returns the vendor ID of the RDMA device.

pub fn vendor_part_id(&self) -> u32

Returns the vendor part ID of the RDMA device.

pub fn hw_ver(&self) -> u32

Returns the hardware version of the RDMA device.

pub fn fw_ver(&self) -> &String

Returns the firmware version of the RDMA device.

pub fn node_guid(&self) -> u64

Returns the node GUID of the RDMA device.

pub fn ports(&self) -> &Vec<RdmaPort>

Returns a reference to the vector of ports available on the RDMA device.

pub fn max_qp(&self) -> i32

Returns the maximum number of queue pairs supported by the RDMA device.

pub fn max_cq(&self) -> i32

Returns the maximum number of completion queues supported by the RDMA device.

pub fn max_mr(&self) -> i32

Returns the maximum number of memory regions supported by the RDMA device.

pub fn max_pd(&self) -> i32

Returns the maximum number of protection domains supported by the RDMA device.

pub fn max_qp_wr(&self) -> i32

Returns the maximum number of work requests per queue pair supported by the RDMA device.

pub fn max_sge(&self) -> i32

Returns the maximum number of scatter/gather elements per work request supported by the RDMA device.

Trait Implementations

impl Clone for RdmaDevice

fn clone(&self) -> RdmaDevice

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RdmaDevice

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RdmaDevice

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RdmaDevice

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RdmaDevice

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Serialize for RdmaDevice

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.