Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

ibv_create_srq (3)

Name

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

Synopsis

#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

Libibverbs Programmer's Manual                               IBV_CREATE_SRQ(3)



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

SYNOPSIS
       #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
       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
       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 fail-
       ure (which indicates the failure reason).


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
       +---------------+-----------------------+
       |Availability   | network/open-fabrics  |
       +---------------+-----------------------+
       |Stability      | Pass-through volatile |
       +---------------+-----------------------+

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

       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source   was   downloaded   from    ['https://www.openfabrics.org/down-
       loads/ibutils/ibutils-1.5.7-0.2.gbd7e502.tar.gz', 'https://www.openfab-
       rics.org/downloads/libibverbs/libibverbs-1.1.8.tar.gz',
       'https://www.openfabrics.org/downloads/libmlx4/libmlx4-1.0.6.tar.gz',
       'https://www.openfabrics.org/downloads/libsdp/lib-
       sdp-1.1.108-0.15.gd7fdb72.tar.gz',   'https://www.openfabrics.org/down-
       loads/management/infiniband-diags-1.6.5.tar.gz',  'https://www.openfab-
       rics.org/downloads/management/libibmad-1.3.12.tar.gz',
       'https://www.openfabrics.org/downloads/management/libibu-
       mad-1.3.10.2.tar.gz',    'https://www.openfabrics.org/downloads/manage-
       ment/opensm-3.3.19.tar.gz',          'https://www.openfabrics.org/down-
       loads/perftest/perftest-1.3.0-0.42.gf350d3d.tar.gz', 'https://www.open-
       fabrics.org/downloads/qperf/qperf-0.4.9.tar.gz',  'https://www.openfab-
       rics.org/downloads/rdmacm/librdmacm-1.0.21.tar.gz',  'https://www.open-
       fabrics.org/downloads/rds-tools/rds-tools-2.0.4.tar.gz'].

       Further information about this software can be found on the open source
       community website at http://www.openfabrics.org/.

SEE ALSO
       ibv_alloc_pd(3), ibv_modify_srq(3), ibv_query_srq(3)

AUTHORS
       Dotan Barak <dotanba@gmail.com>




libibverbs                        2006-10-31                 IBV_CREATE_SRQ(3)