Package libibumad

OpenFabrics Alliance InfiniBand umad (user MAD) library

https://www.openfabrics.org

libibumad provides the user MAD library functions which sit on top of
the user MAD modules in the kernel. These are used by the IB diagnostic
and management tools, including OpenSM.

Library Functions (Section 3)
umad_addr_dump
umad_addr_dump() dumps the given addr to stderr. The argument addr is an ib_mad_addr_t struct, as specified in <infiniband/umad.h>.
umad_alloc
umad_alloc() allocates memory for an array of num umad buffers of size bytes. Note that size should include the umad_size() plus the length (MAD_BLOCK_SIZE for...
umad_class_str
const char * umad_class_str(uint8_t mgmt_class) Return string value of management class enum const char * umad_method_str(uint8_t mgmt_class, uint8_t method)...
umad_close_port
umad_close_port() closes the port specified by the handle portid.
umad_debug
umad_debug() sets the umad library internal debug level to level. The following debug levels are supported: 0 - no debug (the default), 1 - basic debug...
umad_dump
umad_dump() dumps the given umad buffer to stderr.
umad_free
umad_free() frees memory previously allocated with umad_alloc().
umad_get_ca
umad_get_ca() gets the attributes of the InfiniBand device ca_name. It fills the ca structure with the device attributes specified by the ca_name or with the...
umad_get_ca_portguids
umad_get_ca_portguids() fills the portguids array with up to max port GUIDs belonging the specified IB device ca_name , or to the default IB device if ca_name...
umad_get_cas_names
umad_get_cas_names() fills the cas array with up to max local IB devices (CAs) names. The argument cas is a character array with max entries, each with...
umad_get_fd
umad_get_fd() returns the umad fd for the port specified by portid.
umad_get_issm_path
umad_get_issm_path() resolves path to issm device (which used for setting/clearing PortInfo:CapMask IsSM bit) for portnum of the IB device ca_name , it stores...
umad_get_mad
umad_get_mad() returns a pointer to the MAD contained within the umad buffer.
umad_get_mad_addr
umad_get_mad_addr() returns a pointer to the ib_mad_addr struct within the specified umad buffer.
umad_get_pkey
umad_get_pkey() gets the pkey index from the specified umad buffer.
umad_get_port
umad_get_port() fills the port structure with the IB port attributes specified by ca_name and portnum , or the default port if ca_name is NULL and portnum is...
umad_init
umad_init() initializes the umad library for use. Must be called before any other call to this library. umad_done() finalizes the use of the umad library.
umad_open_port
umad_open_port() opens the port portnum of the IB device ca_name for umad access. The port is selected by the library if not all parameters are provided (see...
umad_poll
umad_poll() waits up to timeout_ms milliseconds for a packet to be received from the port specified by portid. Once a packet is ready to be read, the function...
umad_recv
umad_recv() waits up to timeout_ms milliseconds for an incoming MAD message to be received from the port specified by portid. A MAD "message" consists of a...
umad_register
umad_register() registers the specified management class, management version, and whether RMPP is being used for the port specified by the portid parameter. If...
umad_register2
umad_register2() registers for a MAD agent using the provided registration attributes port_fd the port on which to register the agent attr The registration...
umad_register_oui
umad_register_oui() registers the specified class in vendor range 2, the specified oui, and whether RMPP is being used for the port specified by the portid...
umad_send
umad_send() sends length bytes from the specified umad buffer from the port specified by portid, and using the agent specified by agentid. The buffer can...
umad_set_addr
umad_set_addr() sets the MAD address fields within the specified umad buffer using the provided host ordered fields. dlid is the destination LID. dqp is the...
umad_set_addr_net
umad_set_addr_net() sets the MAD address fields within the specified umad buffer using the provided network ordered fields. dlid is the destination LID. dqp is...
umad_set_grh
umad_set_grh() sets the GRH fields (grh_present, gid, hop_limit, traffic_class, flow_label) within the specified umad buffer based on the mad_addr supplied. The...
umad_set_grh_net
umad_set_grh_net() sets the GRH fields (grh_present, gid, hop_limit, traffic_class, flow_label) within the specified umad buffer based on the mad_addr supplied...
umad_set_pkey
umad_set_pkey() sets the pkey index within the specified umad buffer.
umad_size
umad_size() returns the size of umad buffer (in bytes).
umad_status
umad_status() get the internal umad status field.
umad_unregister
umad_unregister() unregisters the specified agentid previously registered using umad_register() or umad_register_oui().