Module primitives

Module primitives 

Source
Expand description

This file contains primitive data structures for interacting with ibverbs.

Primitives:

  • IbvConfig: Represents ibverbs specific configurations, holding parameters required to establish and manage an RDMA connection, including settings for the RDMA device, queue pair attributes, and other connection-specific parameters.
  • IbvDevice: Represents an RDMA device, i.e. ‘mlx5_0’. Contains information about the device, such as: its name, vendor ID, vendor part ID, hardware version, firmware version, node GUID, and capabilities.
  • IbvPort: Represents information about the port of an RDMA device, including state, physical state, LID (Local Identifier), and GID (Global Identifier) information.
  • IbvMemoryRegionView: Represents a memory region that can be registered with an RDMA device for direct memory access operations.
  • IbvOperation: Represents the type of RDMA operation to perform (Read or Write).
  • IbvQpInfo: Contains connection information needed to establish an RDMA connection with a remote endpoint.
  • IbvWc: Wrapper around ibverbs work completion structure, used to track the status of RDMA operations.

Structs§

Gid
IbvConfig
Represents ibverbs specific configurations.
IbvDevice
Represents an RDMA device in the system.
IbvMemoryRegionView
Represents a view of a memory region that can be registered with an RDMA device.
IbvPort
IbvQpInfo
Contains information needed to establish an RDMA queue pair with a remote endpoint.
IbvWc
Wrapper around ibv_wc (ibverbs work completion).

Enums§

IbvOperation
Enum representing the common RDMA operations.
IbvQpType
Queue pair type for RDMA operations.

Functions§

format_gid
Formats a GID (Global Identifier) into a human-readable string.
get_all_devices
Retrieves information about all available RDMA devices in the system.
get_link_layer_str
Converts the given link layer type to a human-readable string.
get_port_phy_state_str
Converts the given physical state to a human-readable string.
get_port_state_str
Converts the given port state to a human-readable string.
ibverbs_supported
Checks if ibverbs devices can be retrieved successfully.
mlx5dv_supported
Checks if mlx5dv (Mellanox device-specific verbs extension) is supported.
resolve_qp_type
Converts IbvQpType to the corresponding integer enum value in rdmaxcel_sys.