IBND_DISCOVER_FABRIC(3)

✨ IBND_DISCOVER_FABRIC ✨

okay bestie so this is from the OpenIB Programmer's Manual, and it's literally the whole ibnetdiscover library glow-up. manual page name is IBND_DISCOVER_FABRIC(3), in case you were wondering 🫶

💖 NAME 💖

ibnd_discover_fabric, ibnd_destroy_fabric, ibnd_debug ibnd_show_progress — initialize the ibnetdiscover library. that's it, that's the job, no cap ✨

🎀 SYNOPSIS 🎀

#include <infiniband/ibnetdisc.h>

ibnd_fabric_t *ibnd_discover_fabric(struct ibmad_port *ibmad_port, int timeout_ms, ib_portid_t *from, int hops)
void ibnd_destroy_fabric(ibnd_fabric_t *fabric)
void ibnd_debug(int i)
void ibnd_show_progress(int i)
int ibnd_set_max_smps_on_wire(int i)

🦋 DESCRIPTION 🦋

ibnd_discover_fabric() 🔍

so this one goes out and discovers the fabric connected to the port you hand it in ibmad_port, using the timeout you specified. it's giving main character energy fr fr.

the "from" and "hops" parameters are optional and they let you scan just a part of a fabric — you say "start at this node "from"" and "go this many "hops" away from it" and boom 💥. what you get back is a "sub-fabric" that's "centered" literally wherever you felt like choosing. iconic behavior honestly.

⚠️ heads up bestie: ibmad_port must be opened with at least IB_SMI_CLASS and IB_SMI_DIRECT_CLASS classes or ibnd_discover_fabric will simply not work. not optional. periodt.

ibnd_destroy_fabric() 🧹

frees all memory and resources associated with the fabric. clean up after yourself, bestie, we don't leave mess 💅

ibnd_debug() 🐛

sets the debug level that gets printed while library operations are taking place. turn it up if you want the tea ☕

ibnd_show_progress() 👀

tells the library "yes queen, print debug output showing your progress through the fabric." you get to watch it vibe its way node by node 🌈

ibnd_set_max_smps_on_wire() 📡

sets the number of SMP's that will be issued on the wire simultaneously. more at once = more chaos, your call.

🔥 RETURN VALUE 🔥

• ibnd_discover_fabric() — returns NULL on failure, otherwise you get a valid ibnd_fabric_t object. slay ✨
• ibnd_destory_fabric(), ibnd_debug() — NONE (yes, ibnd_destory_fabric, that's literally how it's spelled up in here, we don't make the rules 🙈)
• ibnd_set_max_smps_on_wire() — the previous value is returned

🌸 EXAMPLES 🌸

discover the entire fabric connected to device mthca0 , port 1 🎀

     int mgmt_classes[2] = {IB_SMI_CLASS, IB_SMI_DIRECT_CLASS};
     struct ibmad_port *ibmad_port = mad_rpc_open_port(ca, ca_port,
mgmt_classes, 2);      ibnd_fabric_t *fabric =
ibnd_discover_fabric(ibmad_port, 100, NULL, 0);      ...
     ibnd_destroy_fabric(fabric);      mad_rpc_close_port(ibmad_port);

discover only a single node and those nodes connected to it 🦋

     ...       str2drpath(&(port_id.drpath), from, 0, 0);      ...
     ibnd_discover_fabric(ibmad_port, 100, &port_id, 1);      ...

⭐ SEE ALSO ⭐

libibmad, mad_rpc_open_port — go read those too, iykyk 📚

👑 AUTHORS 👑

Ira Weiny <weiny2@llnl.gov> — thank you for your service, legend 🫶

that's the whole page bestie, go discover a fabric and be iconic about it 💖✨

OpenIB · July 25, 2008 · IBND_DISCOVER_FABRIC(3) — mwah, signing off 💅🎀