Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

rdma_create_qp (3)

Name

rdma_create_qp - Allocate a QP.

Synopsis

#include <rdma/rdma_cma.h>

int  rdma_create_qp  (struct  rdma_cm_id *id, struct ibv_pd *pd, struct
ibv_qp_init_attr *qp_init_attr);

Description

Librdmacm Programmer's Manual                                RDMA_CREATE_QP(3)



NAME
       rdma_create_qp - Allocate a QP.

SYNOPSIS
       #include <rdma/rdma_cma.h>

       int  rdma_create_qp  (struct  rdma_cm_id *id, struct ibv_pd *pd, struct
       ibv_qp_init_attr *qp_init_attr);

ARGUMENTS
       id          RDMA identifier.

       pd          Optional protection domain for the QP.

       qp_init_attr
                   Initial QP attributes.

DESCRIPTION
       Allocate a QP associated with the specified rdma_cm_id  and  transition
       it for sending and receiving.

RETURN VALUE
       Returns  0  on success, or -1 on error.  If an error occurs, errno will
       be set to indicate 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 rdma_cm_id must be bound to a local RDMA device before calling this
       function,  and the protection domain must be for that same device.  QPs
       allocated to an rdma_cm_id are automatically transitioned by the librd-
       macm through their states.  After being allocated, the QP will be ready
       to handle posting of receives.  If the QP is unconnected,  it  will  be
       ready to post sends.

       If  a  protection domain is not given - pd parameter is NULL - then the
       rdma_cm_id will be created using  a  default  protection  domain.   One
       default protection domain is allocated per RDMA device.

       The  initial QP attributes are specified by the qp_init_attr parameter.
       The send_cq and recv_cq fields in the  ibv_qp_init_attr  are  optional.
       If  a send or receive completion queue is not specified, then a CQ will
       be allocated by the rdma_cm for the QP, along with  corresponding  com-
       pletion  channels.   Completion  channels  and  CQ  data created by the
       rdma_cm are exposed to the user through the rdma_cm_id structure.

       The actual capabilities and  properties  of  the  created  QP  will  be
       returned to the user through the qp_init_attr parameter.  An rdma_cm_id
       may only be associated with a single QP.

       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

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

SEE ALSO
       rdma_bind_addr(3),  rdma_resolve_addr(3),  rdma_destroy_qp(3), ibv_cre-
       ate_qp(3), ibv_modify_qp(3)




librdmacm                         2007-05-15                 RDMA_CREATE_QP(3)