fi_ucx(7)

📦 version 2.0.0, in opensuse-leap 16.0

💅 fi_ucx — the UCX Fabric Provider 🌈

Okay so bestie, welcome to fi_ucx(7), straight out of the libfabric programmer's manual — this is the page for the ucx provider, and I'm gonna walk you through it like we're texting at 2am 🫶

✨ OVERVIEW ✨

So the ucx provider runs on top of the UCX library, which is currently supported by the NVIDIA Infiniband fabrics 🔥 That's the whole vibe.

The ucx provider uses the UCX tag matching API to implement a limited set of the libfabric data transfer APIs — limited, bestie, remember that word, it comes back 😭

Supported UCP API version: 1.0 ⭐

💀 LIMITATIONS 💀

Not gonna lie, the ucx provider does not support everything defined in the libfabric API. Here's the rundown of what's missing, so you don't get blindsided:

Endpoint types

The only supported type is FI_EP_RDM. That's it. That's the list. Periodt 💅

Endpoint capabilities

Endpoints support these data transfer capabilities: FI_MSG, FI_TAGGED, FI_RMA and FI_MULTI_RECV. Collect them all 🎀

Threading

The supported threading mode is FI_THREAD_DOMAIN — which means the ucx provider is not thread safe. 🚨 So like, don't come for it with multiple threads, it will not slay, it will simply crumble 😭

🎀 RUNTIME PARAMETERS 🎀

These are the env-var girlies you can set. Each one has a default, no surprises:

  • FI_UCX_CONFIG — the path to the UCX configuration file (default: none).
  • FI_UCX_TINJECT_LIMIT — maximal tinject message size (default: 1024).
  • FI_UCX_NS_ENABLE — enforce usage of name server functionality for the UCX provider (default: disabled).
  • FI_UCX_NS_PORT — the UCX provider's name server port (default: 12345).
  • FI_UCX_NS_IFACE — IPv4 network interface for the UCX provider's name server (default: any).
  • FI_UCX_CHECK_REQ_LEAK — check request leak (default: disabled).

🦋 SEE ALSO 🦋

Go read these next, iykyk:

👑 AUTHORS 👑

OpenFabrics. That's the whole author section, iconic of them honestly 💜

And that's the page!! 🌸 Little sign-off for the record books: this is the Libfabric Programmer's Manual, version #VERSION#, dated 2024-12-11 — and it's all about fi_ucx(7), which, yes, is the exact same thing you just read. Full circle, bestie 🧚💖

📦 where this page comes from