Section 3: library functions
umad_set_grh – set GRH fields within umad buffer using host ordering Synopsis #include <infiniband/umad.h> int umad_set_grh(void *umad, void *mad_addr); Description 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 provided mad_addr fields are expected to be in host order. If the mad_addr pointer…
umad_set_addr_net – set MAD address fields within umad buffer using network ordering Synopsis #include <infiniband/umad.h> int umad_set_addr_net(void *umad, int dlid, int dqp, int sl, int qkey); Description 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 the destination QP (queue…
umad_set_addr – set MAD address fields within umad buffer using host ordering Synopsis #include <infiniband/umad.h> int umad_set_addr(void *umad, int dlid, int dqp, int sl, int qkey); Description 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 destination QP (queue…
umad_send – send umad Synopsis #include <infiniband/umad.h> int umad_send(int portid, int agentid, void *umad, int length, int timeout_ms, int retries); Description 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 contain a RMPP transmission which is larger than a…
umad_register_oui – register the specified class in vendor range 2 for port Synopsis #include <infiniband/umad.h> int umad_register_oui(int portid, int mgmt_class, uint8_t rmpp_version, uint8_t oui[3], uint32_t method_mask[4]); Description 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 handle. If method_mask…
umad_register2 – register the specified management class and version for port Synopsis #include <infiniband/umad.h> int umad_register2(int port_fd, struct umad_reg_attr *attr, uint32_t *agent_id); Description 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 attributes as defined by the structure passed. See below…
umad_register – register the specified management class and version for port Synopsis #include <infiniband/umad.h> int umad_register(int portid, int mgmt_class, int mgmt_version, uint8_t rmpp_version, long method_mask[16 / sizeof(long)]); Description umad_register() registers the specified management class, management version, and whether RMPP is being used for the port specified by the portid parameter. If method_mask array is provided,…
umad_recv – receive umad Synopsis #include <infiniband/umad.h> int umad_recv(int portid, void *umad, int *length, int timeout_ms); Description 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 single MAD packet or a coalesced multipacket RMPP transmission. In the RMPP…
umad_poll – poll umad Synopsis #include <infiniband/umad.h> int umad_poll(int portid, int timeout_ms); Description 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 returns 0. After that the packet can be read using umad_recv(). Otherwise, -ETIMEDOUT is…
umad_open_port – open InfiniBand device port for umad access Synopsis #include <infiniband/umad.h> int umad_open_port(char *ca_name, int portnum); Description 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_get_port() for details). Return Value umad_open_port() returns 0 or an…
umad_init, umad_done – perform library initialization and finalization Synopsis #include <infiniband/umad.h> int umad_init(void); int umad_done(void); Description 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. Return Value umad_init() and umad_done() return 0 on success, and -1 on error. Error…
umad_get_port, umad_release_port – open and close an InfiniBand port Synopsis #include <infiniband/umad.h> int umad_get_port(char *ca_name, int portnum, umad_port_t *port); int umad_release_port(umad_port_t *port); Description 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 zero. If only one of…
umad_get_pkey – get pkey index from umad buffer Synopsis #include <infiniband/umad.h> int umad_get_pkey(void *umad); Description umad_get_pkey() gets the pkey index from the specified umad buffer. Return Value umad_get_pkey() returns value of pkey index (or zero if pkey index is not supported by user_mad interface). Author Sasha Khapyorsky <sashak [at] voltaire.com>
umad_get_mad_addr – get the address of the ib_mad_addr from a umad buffer Synopsis #include <infiniband/umad.h> ib_mad_addr_t *umad_get_mad_addr(void *umad); Description umad_get_mad_addr() returns a pointer to the ib_mad_addr struct within the specified umad buffer. Return Value The return value is a pointer to an ib_mad_addr_t struct, as specified in <infiniband/umad.h>. typedef struct ib_mad_addr { uint32_t qpn; uint32_t…
umad_get_mad – get the MAD pointer of a umad buffer Synopsis #include <infiniband/umad.h> void *umad_get_mad(void *umad); Description umad_get_mad() returns a pointer to the MAD contained within the umad buffer. Return Value umad_get_mad() returns a pointer to the MAD contained within the supplied umad buffer. Author Hal Rosenstock <halr [at] voltaire.com>
umad_get_issm_path – get path of issm device Synopsis #include <infiniband/umad.h> int umad_get_issm_path(char *ca_name, int portnum, char *path, intmax); Description 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 resolved path in path array which cannot exceed max bytes in length (including…
umad_get_fd – get the umad fd for the requested port Synopsis #include <infiniband/umad.h> int umad_get_fd(int portid); Description umad_get_fd() returns the umad fd for the port specified by portid. Return Value umad_get_fd() returns the fd for the portid requested or -EINVAL if portid is invalid. Author Hal Rosenstock <halr [at] voltaire.com>
umad_get_cas_names – get list of available InfiniBand device names Synopsis #include <infiniband/umad.h> int umad_get_cas_names(char cas[][UMAD_CA_NAME_LEN], int max); Description 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_CA_NAME_LEN characters. Return Value umad_get_cas_names() returns a non-negative value equal to…
umad_get_ca_portguids – get the InfiniBand device ports GUIDs Synopsis #include <infiniband/umad.h> int umad_get_ca_portguids(char *ca_name, uint64_t *portguids, int max); Description 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 is NULL. The argument portguids is an array of max…
umad_get_ca, umad_release_ca – get and release InfiniBand device port attributes Synopsis #include <infiniband/umad.h> int umad_get_ca(char *ca_name, umad_ca_t *ca); int umad_release_ca(umad_ca_t *ca); Description 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 default device attributes if ca_name is NULL. umad_release_ca()…