ibv_create_cq(3) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | NOTES | SEE ALSO | AUTHORS | COLOPHON

IBV_CREATE_CQ(3)     Libibverbs Programmer's Manual     IBV_CREATE_CQ(3)

NAME         top

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

SYNOPSIS         top

       #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         top

       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 argument channel is optional; if not NULL, the
       completion channel channel will be used to return completion
       events.  The CQ will use the completion 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         top

       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).

NOTES         top

       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         top

       ibv_resize_cq(3), ibv_req_notify_cq(3), ibv_ack_cq_events(3),
       ibv_create_qp(3)

AUTHORS         top

       Dotan Barak <dotanba@gmail.com>

COLOPHON         top

       This page is part of the rdma-core (RDMA Core Userspace Libraries
       and Daemons) project.  Information about the project can be found
       at ⟨https://github.com/linux-rdma/rdma-core⟩.  If you have a bug
       report for this manual page, send it to
       linux-rdma@vger.kernel.org.  This page was obtained from the
       project's upstream Git repository
       ⟨https://github.com/linux-rdma/rdma-core.git⟩ on 2021-04-01.  (At
       that time, the date of the most recent commit that was found in
       the repository was 2021-03-24.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       man-pages@man7.org

libibverbs                     2006-10-31               IBV_CREATE_CQ(3)

Pages that refer to this page: ibv_create_comp_channel(3)ibv_create_cq_ex(3)ibv_get_cq_event(3)ibv_modify_cq(3)