UMAD_REGISTER2(3)

✨ UMAD_REGISTER2 ✨

okay bestie, welcome to the umad_register2(3) page from the OpenIB Programmer's Manual 💖 this is the one that registers a management class + version for a port, and it's giving very important plumbing energy. let's get into it 🫶

🌸 NAME 🌸

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 🎀

so basically, umad_register2() registers for a MAD agent using the registration attributes you hand it. no cap. 🔥

• port_fd — the port on which to register the agent 🌈
• attr — the registration attributes, as defined by the structure you pass in. the deets on that structure are right below, bestie 👇
• agent_id — returned on success ✨ agent_id identifies the kernel MAD agent that a MAD is received by or is to be sent by. it comes back in the umad header "struct ib_user_mad" on recv, and you specify it in umad_send when sending. iykyk 💫

👑 REGISTRATION ATTRIBUTE STRUCTURE 👑

struct umad_reg_attr {
        uint8_t    mgmt_class;
        uint8_t    mgmt_class_version;
        uint32_t   flags;
        uint64_t   method_mask[2];
        uint32_t   oui;
        uint8_t    rmpp_version;
};

• mgmt_class — management class to register for 💜
• mgmt_class_version — management class version to register for 💜
• flags — registration flags. okay so here's the tea: if a flag you specified is not supported by the kernel, an error is returned, and the supported flags come back in this field. 🙈

current flags are:

• UMAD_USER_RMPP — flag to indicate the kernel should not process RMPP packets. all RMPP packets will be treated like individual MADs. the user is responsible for implementing the RMPP protocol. no pressure, bestie 😭

• method_mask — a bit mask which indicates which unsolicited methods this agent should receive. setting this array to 0 will result in the agent only receiving response MADs for which a request was sent 👀
• oui — the oui (in host order) to use for vendor classes 0x30 - 0x4f. otherwise ignored 🍓
• rmpp_version — if the class supports RMPP and kernel RMPP is enabled (the default), indicate which rmpp_version to use ⭐

💫 RETURN VALUE 💫

umad_register2() returns 0 on success and +ERRNO on failure. slay when it's 0, sad girl hours when it's not 😭

🌈 SEE ALSO 🌈

• umad_unregister(3) — the breakup page, go say bye to your agent 💔

💜 AUTHOR 💜

Ira Weiny <ira.weiny@intel.com> — iconic behavior, honestly 👑

and that's the whole page, bestie!! this one was written by the OpenIB crew, and the version you're looking at is dated March 25, 2014 — yeah she's an elder but she still serves 💅✨ go register something and be the main character of your own MAD agent 🎀🦋