Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

ibv_modify_srq (3)

Name

ibv_modify_srq - modify attributes of a shared receive queue (SRQ)

Synopsis

#include <infiniband/verbs.h>

int ibv_modify_srq(struct ibv_srq *srq,
struct ibv_srq_attr *srq_attr,
int srq_attr_mask);

Description

Libibverbs Programmer's Manual                               IBV_MODIFY_SRQ(3)



NAME
       ibv_modify_srq - modify attributes of a shared receive queue (SRQ)

SYNOPSIS
       #include <infiniband/verbs.h>

       int ibv_modify_srq(struct ibv_srq *srq,
                          struct ibv_srq_attr *srq_attr,
                          int srq_attr_mask);

DESCRIPTION
       ibv_modify_srq() modifies the attributes of SRQ srq with the attributes
       in srq_attr according to the mask srq_attr_mask.  The argument srq_attr
       is an ibv_srq_attr struct, as defined in <infiniband/verbs.h>.

       struct ibv_srq_attr {
               uint32_t                max_wr;      /* maximum number of outstanding work requests (WRs) in the SRQ */
               uint32_t                max_sge;     /* number of scatter elements per WR (irrelevant for ibv_modify_srq) */
               uint32_t                srq_limit;   /* the limit value of the SRQ */
       };

       The argument srq_attr_mask specifies the SRQ attributes to be modified.
       The argument is either 0 or the bitwise OR of one or more of  the  fol-
       lowing flags:

       IBV_SRQ_MAX_WR  Resize the SRQ

       IBV_SRQ_LIMIT  Set the SRQ limit

RETURN VALUE
       ibv_modify_srq() returns 0 on success, or the value of errno on failure
       (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
       If any of the modify attributes is invalid, none of the attributes will
       be modified.

       Not  all  devices support resizing SRQs.  To check if a device supports
       it, check if the IBV_DEVICE_SRQ_RESIZE bit is set in the  device  capa-
       bilities flags.

       Modifying    the    srq_limit    arms    the    SRQ   to   produce   an
       IBV_EVENT_SRQ_LIMIT_REACHED "low watermark" asynchronous event once the
       number of WRs in the SRQ drops below srq_limit.

SEE ALSO
       ibv_query_device(3),       ibv_create_srq(3),       ibv_destroy_srq(3),
       ibv_query_srq(3)

AUTHORS
       Dotan Barak <dotanba@gmail.com>


              This   software   was   built   from   source    available    at
              https://github.com/oracle/solaris-userland.  The original commu-
              nity  source   was   downloaded   from    ['https://www.openfab-
              rics.org/downloads/ibutils/ibutils-1.5.7-0.2.gbd7e502.tar.gz',
              'https://www.openfabrics.org/downloads/libibverbs/libib-
              verbs-1.1.8.tar.gz',          'https://www.openfabrics.org/down-
              loads/libmlx4/libmlx4-1.0.6.tar.gz',       'https://www.openfab-
              rics.org/downloads/libsdp/libsdp-1.1.108-0.15.gd7fdb72.tar.gz',
              'https://www.openfabrics.org/downloads/management/infiniband-
              diags-1.6.5.tar.gz', 'https://www.openfabrics.org/downloads/man-
              agement/libibmad-1.3.12.tar.gz',           'https://www.openfab-
              rics.org/downloads/management/libibumad-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.openfabrics.org/down-
              loads/qperf/qperf-0.4.9.tar.gz',           'https://www.openfab-
              rics.org/downloads/rdmacm/librdmacm-1.0.21.tar.gz',
              'https://www.openfabrics.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/.



libibverbs                        2006-10-31                 IBV_MODIFY_SRQ(3)