ibv_create_srq(3) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | NOTES | SEE ALSO | AUTHORS | COLOPHON

IBV_CREATE_SRQ(3)    Libibverbs Programmer's Manual    IBV_CREATE_SRQ(3)

NAME         top

       ibv_create_srq, ibv_destroy_srq - create or destroy a shared
       receive queue (SRQ)

SYNOPSIS         top

       #include <infiniband/verbs.h>

       struct ibv_srq *ibv_create_srq(struct ibv_pd *pd, struct
                                      ibv_srq_init_attr *srq_init_attr);

       int ibv_destroy_srq(struct ibv_srq *srq);

DESCRIPTION         top

       ibv_create_srq() creates a shared receive queue (SRQ) associated
       with the protection domain pd.  The argument srq_init_attr is an
       ibv_srq_init_attr struct, as defined in <infiniband/verbs.h>.

       struct ibv_srq_init_attr {
               void                   *srq_context;    /* Associated context of the SRQ */
               struct ibv_srq_attr     attr;           /* SRQ attributes */
       };

       struct ibv_srq_attr {
               uint32_t                max_wr;         /* Requested max number of outstanding work requests (WRs) in the SRQ */
               uint32_t                max_sge;        /* Requested max number of scatter elements per WR */
               uint32_t                srq_limit;      /* The limit value of the SRQ (irrelevant for ibv_create_srq) */
       };

       The function ibv_create_srq() will update the srq_init_attr
       struct with the original values of the SRQ that was created; the
       values of max_wr and max_sge will be greater than or equal to the
       values requested.

       ibv_destroy_srq() destroys the SRQ srq.

RETURN VALUE         top

       ibv_create_srq() returns a pointer to the created SRQ, or NULL if
       the request fails.

       ibv_destroy_srq() returns 0 on success, or the value of errno on
       failure (which indicates the failure reason).

NOTES         top

       ibv_destroy_srq() fails if any queue pair is still associated
       with this SRQ.

SEE ALSO         top

       ibv_alloc_pd(3), ibv_modify_srq(3), ibv_query_srq(3)

AUTHORS         top

       Dotan Barak <dotanba@gmail.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 2021-08-27.  (At
       that time, the date of the most recent commit that was found in
       the repository was 2021-08-18.)  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

libibverbs                     2006-10-31              IBV_CREATE_SRQ(3)

Pages that refer to this page: ibv_alloc_pd(3)ibv_modify_srq(3)ibv_query_srq(3)rdma_create_srq(3)rdma_destroy_srq(3)