verbs: Document that pointer-returning verbs set errno on failure
The RETURN VALUE sections of the pointer-returning verbs stated only
that NULL is returned on failure. Where errno was mentioned it described
the paired int-returning sibling (e.g. ibv_dealloc_pd, ibv_free_dm), not
the pointer verb itself; only ibv_import_dm documented that errno is set
on the NULL return.
Document the errno contract on all of these verbs for consistency with
ibv_import_dm and with the sibling int-returning verbs: ibv_reg_mr and
friends, ibv_alloc_pd, ibv_alloc_dm, ibv_reg_dm_mr, ibv_alloc_null_mr,
ibv_create_ah, ibv_create_ah_from_wc, ibv_create_comp_channel,
ibv_create_cq, ibv_create_cq_ex, ibv_create_qp, ibv_create_srq,
ibv_open_device, ibv_import_device, ibv_import_mr and ibv_import_pd. The
ibv_reg_mr path has set errno since commit f9e127a4bffa ("verbs: Set
missing errno in ibv_cmd_reg_mr").
Signed-off-by: Christian Häggström <christian.haggstrom@sambanovasystems.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’