mlx5dv_reg_dmabuf_mr(3) — Linux manual page

mlx5dv_reg_dmabuf_mr(3)                           mlx5dv_reg_dmabuf_mr(3)

NAME         top

       mlx5dv_reg_dmabuf_mr - Register a dma-buf based memory region (MR)

SYNOPSIS         top

              #include <infiniband/mlx5dv.h>

              struct ibv_mr *mlx5dv_reg_dmabuf_mr(struct ibv_pd *pd, uint64_t offset,
                                                  size_t length, uint64_t iova, int fd,
                                                  int access, int mlx5_access)

DESCRIPTION         top

       Register a dma-buf based memory region (MR), it follows the
       functionality of ibv_reg_dmabuf_mr() with the ability to supply
       specific mlx5 access flags.

ARGUMENTS         top

       pd     The associated protection domain.

       offset The offset of the dma-buf where the MR starts.

       length

              The length of the MR.

       iova   Specifies the virtual base address of the MR when accessed
              through a lkey or rkey.  It must have the same page offset
              as offset and be aligned with the system page size.

       fd     The file descriptor that the dma-buf is identified by.

       access The desired memory protection attributes; it is either 0 or
              the bitwise OR of one or more of enum ibv_access_flags.

       mlx5_access
              A specific device access flags, it is either 0 or the
              below.

              MLX5DV_REG_DMABUF_ACCESS_DATA_DIRECT if set, this MR will
              be accessed through the Data Direct engine bonded with that
              RDMA device.

RETURN VALUE         top

       Upon success returns a pointer to the registered MR, or NULL if
       the request fails, in that case the value of errno indicates the
       failure reason.

SEE ALSO         top

       ibv_reg_dmabuf_mr(3), mlx5dv_get_data_direct_sysfs_path(3)

AUTHOR         top

       Yishai Hadas ⟨yishaih@nvidia.com⟩

COLOPHON         top

       This page is part of the rdma-core (RDMA Core Userspace Libraries
       and Daemons) project.  Information about the project can be found
       at ⟨https://github.com/linux-rdma/rdma-core⟩.  If you have a bug
       report for this manual page, send it to
       linux-rdma@vger.kernel.org.  This page was obtained from the
       project's upstream Git repository
       ⟨https://github.com/linux-rdma/rdma-core.git⟩ on 2025-08-11.  (At
       that time, the date of the most recent commit that was found in
       the repository was 2025-08-04.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there is
       a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       man-pages@man7.org

                                                  mlx5dv_reg_dmabuf_mr(3)

HTML rendering created 2025-09-06 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH.