UMAD_GET_CA(3)

💖 UMAD_GET_CA — the umad_get_ca(3) page, bestie edition 💖

okay so we're in the OpenIB Programmer's Manual section 3, and today's main characters are umad_get_ca and umad_release_ca. no cap, this is the glow-up your InfiniBand device attributes deserved. 🦋

✨ NAME ✨

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 ✨

so umad_get_ca() literally goes and gets the attributes of the InfiniBand device called ca_name. it fills in that ca structure with the device attributes that ca_name points at — or, and this is the iconic part, with the default device attributes if ca_name is NULL. lowkey a serve. 💅

then umad_release_ca() — you have GOT to call it before the ca structure gets deallocated. that's the vibe check. don't skip it. 🙈

the argument ca is an umad_ca_t struct, exactly as specified in <infiniband/umad.h>. here she is in all her glory:

typedef struct umad_ca {
        char ca_name[UMAD_CA_NAME_LEN];                 /* Name of the device */
        uint node_type;                                 /* Type of the device */
        int numports;                                   /* Number of physical ports */
        char fw_ver[20];                                /* FW version */
        char ca_type[40];                               /* CA type (e.g. MT23108, etc.) */
        char hw_ver[20];                                /* Hardware version */
        uint64_t node_guid;                             /* Node GUID */
        uint64_t system_guid;                           /* System image GUID */
        umad_port_t *ports[UMAD_CA_MAX_PORTS];          /* Array of device port properties */
} umad_ca_t;

and fr fr: umad_release_ca() releases the resources that were allocated back in umad_get_ca(). that's the whole point of her. it's giving cleanup era. 🧚

✨ RETURN VALUE ✨

both umad_get_ca() and umad_release_ca() return 0 on success, and a negative value on error. simple as that, periodt. ⭐

✨ AUTHORS ✨

• Hal Rosenstock <halr@voltaire.com> 👑
• Dotan Barak <dotanb@mellanox.co.il> 👑

and that's the page, bestie!! this was the OpenIB manual, dated May 21, 2007, and the page itself is UMAD_GET_CA(3) — yes the title and the footer said the same thing, iconic behaviour honestly. go call umad_release_ca(), drink some water, and slay the rest of your day. 💜🌸✨