IBV_QUERY_GID_TABLE(3)

📦
version 62.0 · 8 versions
, in alpine 3.24, centos-stream 10, centos-stream 9, ubuntu jammy

💖 NAME 💖

okay so this page is from the Libibverbs Programmer’s Manual, and the main character is ibv_query_gid_table — query an InfiniBand device’s GID table. ✨

📞 SYNOPSIS 📞

#include <infiniband/verbs.h>

ssize_t ibv_query_gid_table(struct ibv_context *context,
                            struct ibv_gid_entry *entries,
                            size_t max_entries,
                            uint32_t flags);

🧠 DESCRIPTION 🧠

ibv_query_gid_table() grabs the valid GID table entries for the RDMA device context context and puts them at the pointer entries. 💅

bestie, you have to allocate the entries array yourself for the GID table entries you want to query. This API returns only valid GID table entries — no fake ones, no extras. ✨

You also have to pass a non zero number of entries at max_entries, and that number has to correspond to the size of the entries array. 🫶

Your entries array needs to be allocated so it can contain all the valid GID table entries of the device. If there are more valid GID entries than the provided value of max_entries and the entries array can hold, the call will fail. 😭

For example, if an RDMA device context has a total of 10 valid GID entries, entries should be allocated for at least 10 entries, and max_entries should be set appropriately. 🔥

bestie, this is the vibe check: size your array for all the valid entries, or the call is gonna fail on you. 💀

🎀 ARGUMENTS 🎀

  • context — the context of the device to query. 👑
  • entries — array of ibv_gid_entry structs where the GID entries are returned. Please see the ibv_query_gid_ex(3) man page for ibv_gid_entry. 🦋
  • max_entries — maximum number of entries that can be returned. 🌸
  • flags — extra fields to query post entries->ndev_ifindex; for now must be 0. 🚨

🪞 RETURN VALUE 🪞

ibv_query_gid_table() returns the number of entries that were read on success, or a negative errno value on error. The number of entries returned is <= max_entries. 💖

👀 SEE ALSO 👀

🌟 AUTHOR 🌟

Parav Pandit <parav@nvidia.com> 🫶

mwah 💖 this page is from libibverbs, dated 2020-04-24 — that’s the whole thing, periodt. 🌈

📦 where this page comes from