Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

ibv_create_qp (3)

Name

ibv_create_qp - create or destroy a queue pair (QP)

Synopsis

#include <infiniband/verbs.h>

struct ibv_qp *ibv_create_qp(struct ibv_pd *pd,
struct ibv_qp_init_attr *qp_init_attr);

int ibv_destroy_qp(struct ibv_qp *qp);

Description

Libibverbs Programmer's Manual                                IBV_CREATE_QP(3)



NAME
       ibv_create_qp, ibv_destroy_qp - create or destroy a queue pair (QP)

SYNOPSIS
       #include <infiniband/verbs.h>

       struct ibv_qp *ibv_create_qp(struct ibv_pd *pd,
                                    struct ibv_qp_init_attr *qp_init_attr);

       int ibv_destroy_qp(struct ibv_qp *qp);

DESCRIPTION
       ibv_create_qp()  creates  a queue pair (QP) associated with the protec-
       tion domain pd.   The  argument  qp_init_attr  is  an  ibv_qp_init_attr
       struct, as defined in <infiniband/verbs.h>.

       struct ibv_qp_init_attr {
               void                   *qp_context;     /* Associated context of the QP */
               struct ibv_cq          *send_cq;        /* CQ to be associated with the Send Queue (SQ) */
               struct ibv_cq          *recv_cq;        /* CQ to be associated with the Receive Queue (RQ) */
               struct ibv_srq         *srq;            /* SRQ handle if QP is to be associated with an SRQ, otherwise NULL */
               struct ibv_qp_cap       cap;            /* QP capabilities */
               enum ibv_qp_type        qp_type;        /* QP Transport Service Type: IBV_QPT_RC, IBV_QPT_UC, IBV_QPT_UD or IBV_QPT_RAW_PACKET */
               int                     sq_sig_all;     /* If set, each Work Request (WR) submitted to the SQ generates a completion entry */
       };

       struct ibv_qp_cap {
               uint32_t                max_send_wr;    /* Requested max number of outstanding WRs in the SQ */
               uint32_t                max_recv_wr;    /* Requested max number of outstanding WRs in the RQ */
               uint32_t                max_send_sge;   /* Requested max number of scatter/gather (s/g) elements in a WR in the SQ */
               uint32_t                max_recv_sge;   /* Requested max number of s/g elements in a WR in the SQ */
               uint32_t                max_inline_data;/* Requested max number of data (bytes) that can be posted inline to the SQ, otherwise 0 */
       };

       The  function  ibv_create_qp() will update the qp_init_attr->cap struct
       with the actual QP values of the QP that was created; the  values  will
       be greater than or equal to the values requested.

       ibv_destroy_qp() destroys the QP qp.

RETURN VALUE
       ibv_create_qp()  returns  a  pointer  to the created QP, or NULL if the
       request fails.  Check the QP number (qp_num) in the returned QP.

       ibv_destroy_qp() 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
       ibv_create_qp() will fail if a it is asked to create QP of a type other
       than IBV_QPT_RC or IBV_QPT_UD associated with an SRQ.

       The attributes max_recv_wr and max_recv_sge  are  ignored  by  ibv_cre-
       ate_qp() if the QP is to be associated with an SRQ.

       ibv_destroy_qp() fails if the QP is attached to a multicast group.

SEE ALSO
       ibv_alloc_pd(3), ibv_modify_qp(3), ibv_query_qp(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_CREATE_QP(3)