Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

ibv_post_recv (3)

Name

ibv_post_recv - post a list of work requests (WRs) to a receive queue

Synopsis

#include <infiniband/verbs.h>

int ibv_post_recv(struct ibv_qp *qp, struct ibv_recv_wr *wr,
struct ibv_recv_wr **bad_wr);

Description

Libibverbs Programmer's Manual                                IBV_POST_RECV(3)



NAME
       ibv_post_recv - post a list of work requests (WRs) to a receive queue

SYNOPSIS
       #include <infiniband/verbs.h>

       int ibv_post_recv(struct ibv_qp *qp, struct ibv_recv_wr *wr,
                         struct ibv_recv_wr **bad_wr);

DESCRIPTION
       ibv_post_recv()  posts  the linked list of work requests (WRs) starting
       with wr to the receive queue of the queue pair qp.  It stops processing
       WRs  from  this list at the first failure (that can be detected immedi-
       ately while requests are being posted), and  returns  this  failing  WR
       through bad_wr.

       The  argument  wr  is  an  ibv_recv_wr  struct,  as defined in <infini-
       band/verbs.h>.

       struct ibv_recv_wr {
               uint64_t                wr_id;     /* User defined WR ID */
               struct ibv_recv_wr     *next;      /* Pointer to next WR in list, NULL if last WR */
               struct ibv_sge         *sg_list;   /* Pointer to the s/g array */
               int                     num_sge;   /* Size of the s/g array */
       };

       struct ibv_sge {
               uint64_t                addr;      /* Start address of the local memory buffer */
               uint32_t                length;    /* Length of the buffer */
               uint32_t                lkey;      /* Key of the local Memory Region */
       };

RETURN VALUE
       ibv_post_recv() 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
       The buffers used by a WR can only be safely reused after WR the request
       is fully executed and a work completion has  been  retrieved  from  the
       corresponding completion queue (CQ).

       If  the  QP  qp is associated with a shared receive queue, you must use
       the function ibv_post_srq_recv(), and not  ibv_post_recv(),  since  the
       QP's own receive queue will not be used.

       If  a WR is being posted to a UD QP, the Global Routing Header (GRH) of
       the incoming message will be placed in the first 40 bytes of  the  buf-
       fer(s)  in the scatter list.  If no GRH is present in the incoming mes-
       sage, then the first bytes will be undefined.  This means that  in  all
       cases,  the actual data of the incoming message will start at an offset
       of 40 bytes into the buffer(s) in the scatter list.

SEE ALSO
       ibv_create_qp(3),        ibv_post_send(3),        ibv_post_srq_recv(3),
       ibv_poll_cq(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_POST_RECV(3)