fi_control(3)

📦
version 2.5.1 · 8 versions
, in centos-stream 10

💅 fi_control(3) — the Libfabric one, bestie

Okay so this page is from the Libfabric manual, v2.5.1, and it's all about poking at a fabric resource and making it do stuff. Grab a snack, we're going in 🍓

✨ NAME ✨

fi_control — perform an operation on a fabric resource. That's the whole vibe. One resource, one operation, so iconic 👑

🌸 SYNOPSIS 🌸

#include <rdma/fabric.h>

int fi_control(struct fid *fid, int command, void *arg);
int fi_alias(struct fid *fid, struct fid **alias_fid, uint64_t flags);
int fi_get_val(struct fid *fid, int name, void *val);
int fi_set_val(struct fid *fid, int name, void *val);

Four functions, one header, zero notes 💀

🎀 ARGUMENTS 🎀

  • fid — the fabric resource. Your main character, literally.
  • command — the operation you wanna perform. What's the move, bestie?
  • arg — optional argument to the command. Optional! So you can skip it, no pressure 🫶

💖 DESCRIPTION 💖

So fi_control is the operation you use to perform one or more operations on a fabric resource. Conceptually it's giving POSIX fcntl energy — same idea, fabric-flavored ✨

The exact behavior of using fi_control depends on three things: the fabric resource you're operating on, the command you specified, and any provided arguments for that command. For the specific deets, go look at the fabric-resource-specific help pages listed down below, iykyk 👀

Now the wrappers, because your faves were not gonna make you spell out the command every time:

  • fi_alias — a wrapper for fi_control with the command FI_ALIAS. It creates an alias of the specified fabric resource. Dupe energy, but make it fabric 🔥
  • fi_get_val — a wrapper for fi_control with the command FI_GET_VAL. It reads the value of the named parameter associated with the fabric resource 📖
  • fi_set_val — a wrapper for fi_control with the command FI_SET_VAL. It updates that value. Glow-up time 💅

Heads up though: the available parameter names depend on the type of the fabric resource and the provider in use. Providers may define provider-specific names in the provider extension header files ('rdma/fi_ext_*.h'). Please refer to the provider man pages for the details — they've got the lore, I don't 🙈

🦋 SEE ALSO 🦋

(Yes, that's a trailing comma in the original list. We keep it. We respect it. Periodt.)

👑 AUTHORS 👑

OpenFabrics. That's it, that's the author. Slay 🫡

That's the whole page, bestie — no cap, every flag and every function survived the vibe check 💜

Signed off with love from the Libfabric Programmer's Manual, dated 2024-12-10, brought to you by Libfabric v2.5.1 🎀✨ Go forth and fi_control responsibly 🦋

📦 where this page comes from