docs: remove stale API references and fix symbol typos in man pages While reviewing the docs I found that some man pages still documented functions that no longer exist in the code. An automated sweep of all documented symbols against the source tree turned up more cases of the same problem, plus a number of misspelled identifiers; this fixes the ones in the core libraries, infiniband-diags, and rxe. libibnetdisc: - ibnd_discover_fabric(3): drop ibnd_debug(), ibnd_set_max_smps_on_wire() and ibnd_show_progress(), which no longer exist as functions. The max_smps and show_progress knobs now live in struct ibnd_config. Update the SYNOPSIS and examples to the current ca_name/ca_port/config API and fix the ibnd_destory_fabric typo. - ibnd_iter_nodes(3): the callback type is ibnd_iter_node_func_t and ibnd_iter_nodes_type() takes a plain int node_type. - man/CMakeLists.txt + debian: drop the man page aliases and install entries for the removed functions. libibumad: - umad_free_ca_device_list(3): the list is allocated by umad_get_ca_device_list(), not umad_get_ca_namelist(). libibverbs: - ibv_create_flow_action(3): ibv_modify_flow_action_esp and ibv_destroy_flow_action are the real function names; fix the ESP flag/keymat/replay identifiers (the FULL_OFFLOAD misspelling, IBV_ACTION_ESP_KEYMAT_*, reply_*, esp_attr, keymat struct/enum names) and several field typos. - ibv_wr_post(3): ibv_wr_set_sge (not ibv_set_wr_sge) and the inline data list is an array of struct ibv_data_buf. - ibv_alloc_dm(3): the parameter is dm_offset. - ibv_query_device_ex(3): enum ibv_odp_general_caps, transport spelled correctly, and the struct member is general_caps. - ibv_advise_mr(3): IBV_ADVISE_MR_ADVICE_PREFETCH. - ibv_read_counters(3): IBV_FLOW_SPEC_ETH instead of the removed IBV_EXP_FLOW_SPEC_ETH. librdmacm: - rdma_getaddrinfo(3): drop the librdmacm-1.0 era EAI_QPTYPE code and describe the actual return convention; fix ai_qp_type. - rdma_create_ep(3): the field is res->ai_flags. - rdma_post_sendv(3): the parameter is sgl. - cmtime(1): milliseconds. - rsocket(7): drop the max_events config parameter, which nothing reads. infiniband-diags: - saquery(8): there is no -o/--outstanding_smps option and saquery does not depend on libosmcomp. - check_lft_balance(8): document the real options, remove the unsupported -R option, and distinguish the Debian command name from the .pl name installed on other distributions. providers/rxe: - rxe(7): drop the stale rdma_rxe_net sysfs entry. Signed-off-by: Zhiwei Zhang <zhangzhiwei@bitintelligence.io> Co-Authored-By: Claude Code <noreply@anthropic.com>
This is the userspace components for the Linux Kernel's drivers/infiniband subsystem. Specifically this contains the userspace libraries for the following device nodes:
The userspace component of the libibverbs RDMA kernel drivers are included under the providers/ directory. Support for the following Kernel RDMA drivers is included:
Additional service daemons are provided for:
This project uses a cmake based build system. Quick start:
$ bash build.sh
build/bin will contain the sample programs and build/lib will contain the shared libraries. The build is configured to run all the programs ‘in-place’ and cannot be installed.
$ apt-get install build-essential cmake gcc libudev-dev libnl-3-dev libnl-route-3-dev ninja-build pkg-config valgrind python3-dev cython3 python3-docutils pandoc
Supported releases:
$ dnf builddep redhat/rdma-core.spec
NOTE: Fedora Core uses the name ‘ninja-build’ for the ‘ninja’ command.
$ zypper install cmake gcc libnl3-devel libudev-devel ninja pkg-config valgrind-devel python3-devel python3-Cython python3-docutils pandoc
Install required packages:
$ yum install cmake gcc libnl3-devel libudev-devel make pkgconfig valgrind-devel
Developers on CentOS 7 or Amazon Linux 2 are suggested to install more modern tooling for the best experience.
CentOS 7:
$ yum install epel-release $ yum install cmake3 ninja-build pandoc
Amazon Linux 2:
$ amazon-linux-extras install epel $ yum install cmake3 ninja-build pandoc
NOTE: EPEL uses the name ‘ninja-build’ for the ‘ninja’ command, and ‘cmake3’ for the ‘cmake’ command.
To set up software RDMA on an existing interface with either of the available drivers, use the following commands, substituting <DRIVER> with the name of the driver of your choice (rdma_rxe or siw) and <TYPE> with the type corresponding to the driver (rxe or siw).
# modprobe <DRIVER> # rdma link add <NAME> type <TYPE> netdev <DEVICE>
Please note that you need version of iproute2 recent enough is required for the command above to work.
You can use either ibv_devices or rdma link to verify that the device was successfully added.
Bugs should be reported to the linux-rdma@vger.kernel.org mailing list In your bug report, please include:
Information about your system:
How to reproduce the bug.
If the bug is a crash, the exact output printed out when the crash occurred, including any kernel messages produced.
See Contributing to rdma-core.
Stable versions are released regularly with backported fixes (see Documentation/stable.md) The current minimum version still maintained is ‘v33.X’