c1872221d7
kernel APIs. List of sources used: 1) rdma-core was cloned from "https://github.com/linux-rdma/rdma-core.git" Top commit d65138ef93af30b3ea249f3a84aa6a24ba7f8a75 2) OpenSM was cloned from git://git.openfabrics.org/~halr/opensm.git Top commit 85f841cf209f791c89a075048a907020e924528d 3) libibmad was cloned from "git://git.openfabrics.org/~iraweiny/libibmad.git" Tag 1.3.13 with some additional patches from Mellanox. 4) infiniband-diags was cloned from "git://git.openfabrics.org/~iraweiny/infiniband-diags.git" Tag 1.6.7 with some additional patches from Mellanox. Added the required Makefiles for building and installing. Sponsored by: Mellanox Technologies
69 lines
2.0 KiB
Groff
69 lines
2.0 KiB
Groff
.\" -*- nroff -*-
|
|
.\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
|
|
.\"
|
|
.TH IBV_CREATE_SRQ 3 2006-10-31 libibverbs "Libibverbs Programmer's Manual"
|
|
.SH "NAME"
|
|
ibv_create_srq, ibv_destroy_srq \- create or destroy a shared receive queue (SRQ)
|
|
.SH "SYNOPSIS"
|
|
.nf
|
|
.B #include <infiniband/verbs.h>
|
|
.sp
|
|
.BI "struct ibv_srq *ibv_create_srq(struct ibv_pd " "*pd" ", struct "
|
|
.BI " ibv_srq_init_attr " "*srq_init_attr" );
|
|
.sp
|
|
.BI "int ibv_destroy_srq(struct ibv_srq " "*srq" );
|
|
.fi
|
|
.SH "DESCRIPTION"
|
|
.B ibv_create_srq()
|
|
creates a shared receive queue (SRQ) associated with the protection domain
|
|
.I pd\fR.
|
|
The argument
|
|
.I srq_init_attr
|
|
is an ibv_srq_init_attr struct, as defined in <infiniband/verbs.h>.
|
|
.PP
|
|
.nf
|
|
struct ibv_srq_init_attr {
|
|
.in +8
|
|
void *srq_context; /* Associated context of the SRQ */
|
|
struct ibv_srq_attr attr; /* SRQ attributes */
|
|
.in -8
|
|
};
|
|
.sp
|
|
.nf
|
|
struct ibv_srq_attr {
|
|
.in +8
|
|
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) */
|
|
.in -8
|
|
};
|
|
.fi
|
|
.PP
|
|
The function
|
|
.B ibv_create_srq()
|
|
will update the
|
|
.I 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.
|
|
.PP
|
|
.B ibv_destroy_srq()
|
|
destroys the SRQ
|
|
.I srq\fR.
|
|
.SH "RETURN VALUE"
|
|
.B ibv_create_srq()
|
|
returns a pointer to the created SRQ, or NULL if the request fails.
|
|
.PP
|
|
.B ibv_destroy_srq()
|
|
returns 0 on success, or the value of errno on failure (which indicates the failure reason).
|
|
.SH "NOTES"
|
|
.B ibv_destroy_srq()
|
|
fails if any queue pair is still associated with this SRQ.
|
|
.SH "SEE ALSO"
|
|
.BR ibv_alloc_pd (3),
|
|
.BR ibv_modify_srq (3),
|
|
.BR ibv_query_srq (3)
|
|
.SH "AUTHORS"
|
|
.TP
|
|
Dotan Barak <dotanba@gmail.com>
|