contrib/ofed/libibverbs/man/ibv_modify_srq.3

   1 .\" -*- nroff -*-
   2 .\"
   3 .TH IBV_MODIFY_SRQ 3 2006-10-31 libibverbs "Libibverbs Programmer's Manual"
   4 .SH "NAME"
   5 ibv_modify_srq \- modify attributes of a shared receive queue (SRQ)
   6 .SH "SYNOPSIS"
   7 .nf
   8 .B #include <infiniband/verbs.h>
   9 .sp
  10 .BI "int ibv_modify_srq(struct ibv_srq " "*srq" ,
  11 .BI "                   struct ibv_srq_attr " "*srq_attr" ,
  12 .BI "                   int " "srq_attr_mask" );
  13 .fi
  14 .SH "DESCRIPTION"
  15 .B ibv_modify_srq()
  16 modifies the attributes of SRQ
  17 .I srq
  18 with the attributes in
  19 .I srq_attr
  20 according to the mask
  21 .I srq_attr_mask\fR.
  22 The argument \fIsrq_attr\fR is an ibv_srq_attr struct, as defined in <infiniband/verbs.h>.
  23 .PP
  24 .nf
  25 struct ibv_srq_attr {
  26 .in +8
  27 uint32_t                max_wr;      /* maximum number of outstanding work requests (WRs) in the SRQ */
  28 uint32_t                max_sge;     /* number of scatter elements per WR (irrelevant for ibv_modify_srq) */
  29 uint32_t                srq_limit;   /* the limit value of the SRQ */
  30 .in -8
  31 };
  32 .fi
  33 .PP
  34 The argument
  35 .I srq_attr_mask
  36 specifies the SRQ attributes to be modified.
  37 The argument is either 0 or the bitwise OR of one or more of the following flags:
  38 .PP
  39 .TP
  40 .B IBV_SRQ_MAX_WR \fR Resize the SRQ
  41 .TP
  42 .B IBV_SRQ_LIMIT \fR Set the SRQ limit
  43 .SH "RETURN VALUE"
  44 .B ibv_modify_srq()
  45 returns 0 on success, or the value of errno on failure (which indicates the failure reason).
  46 .SH "NOTES"
  47 If any of the modify attributes is invalid, none of the attributes will be modified.
  48 .PP
  49 Not all devices support resizing SRQs.  To check if a device supports it, check if the
  50 .B IBV_DEVICE_SRQ_RESIZE
  51 bit is set in the device capabilities flags.
  52 .PP
  53 Modifying the srq_limit arms the SRQ to produce an
  54 .B IBV_EVENT_SRQ_LIMIT_REACHED
  55 "low watermark" asynchronous event once the number of WRs in the SRQ drops below srq_limit.
  56 .SH "SEE ALSO"
  57 .BR ibv_query_device (3),
  58 .BR ibv_create_srq (3),
  59 .BR ibv_destroy_srq (3),
  60 .BR ibv_query_srq (3)
  61 .SH "AUTHORS"
  62 .TP
  63 Dotan Barak <dotanb@mellanox.co.il>