Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

ibv_create_cq (3)

Name

ibv_create_cq - create or destroy a completion queue (CQ)

Synopsis

#include <infiniband/verbs.h>

struct ibv_cq *ibv_create_cq(struct ibv_context *context, int cqe,
void *cq_context,
struct ibv_comp_channel *channel,
int comp_vector);

int ibv_destroy_cq(struct ibv_cq *cq);

Description

Libibverbs Programmer's Manual                                IBV_CREATE_CQ(3)



NAME
       ibv_create_cq,  ibv_destroy_cq  -  create or destroy a completion queue
       (CQ)

SYNOPSIS
       #include <infiniband/verbs.h>

       struct ibv_cq *ibv_create_cq(struct ibv_context *context, int cqe,
                                    void *cq_context,
                                    struct ibv_comp_channel *channel,
                                    int comp_vector);

       int ibv_destroy_cq(struct ibv_cq *cq);

DESCRIPTION
       ibv_create_cq() creates a completion  queue  (CQ)  with  at  least  cqe
       entries  for  the  RDMA device context context.  The pointer cq_context
       will be used to set user context pointer of the CQ structure. The argu-
       ment  channel  is optional; if not NULL, the completion channel channel
       will be used to return completion events.  The CQ will use the  comple-
       tion  vector comp_vector for signaling completion events; it must be at
       least zero and less than context->num_comp_vectors.

       ibv_destroy_cq() destroys the CQ cq.

RETURN VALUE
       ibv_create_cq() returns a pointer to the CQ, or  NULL  if  the  request
       fails.

       ibv_destroy_cq() 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_cq() may create a CQ with size greater than or equal to  the
       requested  size.  Check  the  cqe  attribute in the returned CQ for the
       actual size.

       ibv_destroy_cq() fails if any queue pair is still associated with  this
       CQ.

SEE ALSO
       ibv_resize_cq(3),  ibv_req_notify_cq(3), ibv_ack_cq_events(3), ibv_cre-
       ate_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_CQ(3)