1IBV_CREATE_SRQ(3)       Libibverbs Programmer's Manual       IBV_CREATE_SRQ(3)
2
3
4

NAME

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

SYNOPSIS

10       #include <infiniband/verbs.h>
11
12       struct ibv_srq *ibv_create_srq(struct ibv_pd *pd, struct
13                                      ibv_srq_init_attr *srq_init_attr);
14
15       int ibv_destroy_srq(struct ibv_srq *srq);
16

DESCRIPTION

18       ibv_create_srq() creates a shared receive queue (SRQ)  associated  with
19       the   protection   domain   pd.    The  argument  srq_init_attr  is  an
20       ibv_srq_init_attr struct, as defined in <infiniband/verbs.h>.
21
22       struct ibv_srq_init_attr {
23               void                   *srq_context;    /* Associated context of the SRQ */
24               struct ibv_srq_attr     attr;           /* SRQ attributes */
25       };
26
27       struct ibv_srq_attr {
28               uint32_t                max_wr;         /* Requested max number of outstanding work requests (WRs) in the SRQ */
29               uint32_t                max_sge;        /* Requested max number of scatter elements per WR */
30               uint32_t                srq_limit;      /* The limit value of the SRQ (irrelevant for ibv_create_srq) */
31       };
32
33       The function ibv_create_srq() will update the srq_init_attr struct with
34       the  original  values of the SRQ that was created; the values of max_wr
35       and max_sge will be greater than or equal to the values requested.
36
37       ibv_destroy_srq() destroys the SRQ srq.
38

RETURN VALUE

40       ibv_create_srq() returns a pointer to the created SRQ, or NULL  if  the
41       request fails.
42
43       ibv_destroy_srq()  returns 0 on success, or the value of errno on fail‐
44       ure (which indicates the failure reason).
45

NOTES

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

SEE ALSO

51       ibv_alloc_pd(3), ibv_modify_srq(3), ibv_query_srq(3)
52

AUTHORS

54       Dotan Barak <dotanba@gmail.com>
55
56
57
58libibverbs                        2006-10-31                 IBV_CREATE_SRQ(3)