Changeset View
Changeset View
Standalone View
Standalone View
contrib/ofed/libibverbs/man/ibv_create_srq.3
.\" -*- nroff -*- | .\" -*- nroff -*- | ||||
.\" | .\" | ||||
.TH IBV_CREATE_SRQ 3 2006-10-31 libibverbs "Libibverbs Programmer's Manual" | .TH IBV_CREATE_SRQ 3 2006-10-31 libibverbs "Libibverbs Programmer's Manual" | ||||
.SH "NAME" | .SH "NAME" | ||||
ibv_create_srq, ibv_destroy_srq \- create or destroy a shared receive queue (SRQ) | ibv_create_srq, ibv_destroy_srq \- create or destroy a shared receive queue (SRQ) | ||||
.SH "SYNOPSIS" | .SH "SYNOPSIS" | ||||
.nf | .nf | ||||
.B #include <infiniband/verbs.h> | .B #include <infiniband/verbs.h> | ||||
.sp | .sp | ||||
.BI "struct ibv_srq *ibv_create_srq(struct ibv_pd " "*pd" ", struct " | .BI "struct ibv_srq *ibv_create_srq(struct ibv_pd " "*pd" ", struct " | ||||
.BI " ibv_srq_init_attr " "*srq_init_attr" ); | .BI " ibv_srq_init_attr " "*srq_init_attr" ); | ||||
.sp | .sp | ||||
.BI "struct ibv_srq *ibv_create_xrc_srq(struct ibv_pd " "*pd" ", | |||||
.BI " struct ibv_xrc_domain " "*xrc_domain" ", | |||||
.BI " struct ibv_cq " "*xrc_cq" ", | |||||
.BI " struct ibv_srq_init_attr " "*srq_init_attr" ); | |||||
.sp | |||||
.BI "int ibv_destroy_srq(struct ibv_srq " "*srq" ); | .BI "int ibv_destroy_srq(struct ibv_srq " "*srq" ); | ||||
.fi | .fi | ||||
.SH "DESCRIPTION" | .SH "DESCRIPTION" | ||||
.B ibv_create_srq() | .B ibv_create_srq() | ||||
creates a shared receive queue (SRQ) associated with the protection domain | creates a shared receive queue (SRQ) associated with the protection domain | ||||
.I pd\fR. | .I pd\fR. | ||||
.PP | |||||
.B ibv_create_xrc_srq() | |||||
creates an XRC shared receive queue (SRQ) associated with the protection domain | |||||
.I pd\fR, | |||||
the XRC domain | |||||
.I xrc_domain | |||||
and the CQ which will hold the XRC completion | |||||
.I xrc_cq\fR. | |||||
.PP | |||||
The argument | The argument | ||||
.I srq_init_attr | .I srq_init_attr | ||||
is an ibv_srq_init_attr struct, as defined in <infiniband/verbs.h>. | is an ibv_srq_init_attr struct, as defined in <infiniband/verbs.h>. | ||||
.PP | .PP | ||||
.nf | .nf | ||||
struct ibv_srq_init_attr { | struct ibv_srq_init_attr { | ||||
.in +8 | .in +8 | ||||
void *srq_context; /* Associated context of the SRQ */ | void *srq_context; /* Associated context of the SRQ */ | ||||
Show All 32 Lines | |||||
.B ibv_destroy_srq() | .B ibv_destroy_srq() | ||||
fails if any queue pair is still associated with this SRQ. | fails if any queue pair is still associated with this SRQ. | ||||
.SH "SEE ALSO" | .SH "SEE ALSO" | ||||
.BR ibv_alloc_pd (3), | .BR ibv_alloc_pd (3), | ||||
.BR ibv_modify_srq (3), | .BR ibv_modify_srq (3), | ||||
.BR ibv_query_srq (3) | .BR ibv_query_srq (3) | ||||
.SH "AUTHORS" | .SH "AUTHORS" | ||||
.TP | .TP | ||||
Dotan Barak <dotanb@mellanox.co.il> | Dotan Barak <dotanba@gmail.com> |