man7.org > Linux > man-pages

Linux/UNIX system programming training

mlx5dv_pp_alloc(3) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | ARGUMENTS | RETURN VALUE | SEE ALSO | AUTHOR | COLOPHON 

mlx5dv_pp_alloc / mlx5dv_pp_free(3)   mlx5dv_pp_alloc / mlx5dv_pp_free(3)

NAME         top

       mlx5dv_pp_alloc - Allocates a packet pacing entry

       mlx5dv_pp_free - Frees a packet pacing entry

SYNOPSIS         top

              #include <infiniband/mlx5dv.h>

              struct mlx5dv_pp *
              mlx5dv_pp_alloc(struct ibv_context *context,
                      size_t pp_context_sz,
                      const void *pp_context,
                      uint32_t flags);

              void mlx5dv_pp_free(struct mlx5dv_pp *dv_pp);

DESCRIPTION         top

       Create / free a packet pacing entry which can be used for some
       device commands over the DEVX interface.

       The DEVX API enables direct access from the user space area to the
       mlx5 device driver, the packet pacing information is needed for
       few commands where a packet pacing index is needed.

ARGUMENTS         top

       context
              RDMA device context to work on, need to be opened with DEVX
              support by using mlx5dv_open_device().

       pp_context_sz
              Length of pp_context input buffer.

       pp_context
              Packet pacing context according to the device
              specification.

       flags  MLX5DV_PP_ALLOC_FLAGS_DEDICATED_INDEX: allocate a dedicated
              index.

   dv_pp
              struct mlx5dv_pp {
                  uint16_t index;
              };

       index  The device index to be used.

RETURN VALUE         top

       Upon success mlx5dv_pp_alloc returns a pointer to the created
       packet pacing object, on error NULL will be returned and errno
       will be set.

SEE ALSO         top

       mlx5dv_open_device, mlx5dv_devx_obj_create

AUTHOR         top

       Yishai Hadas ⟨yishaih@mellanox.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_pp_alloc / mlx5dv_pp_free(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.

Cover of TLPI