ibv_create_comp_channel(3) — Linux manual page

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

IBV_CREATE_COMP_CHANNEL(3)verbs Programmer's ManualREATE_COMP_CHANNEL(3)

NAME         top

       ibv_create_comp_channel, ibv_destroy_comp_channel - create or
       destroy a completion event channel

SYNOPSIS         top

       #include <infiniband/verbs.h>

       struct ibv_comp_channel *ibv_create_comp_channel(struct ibv_context
                                                        *context);

       int ibv_destroy_comp_channel(struct ibv_comp_channel *channel);

DESCRIPTION         top

       ibv_create_comp_channel() creates a completion event channel for
       the RDMA device context context.

       ibv_destroy_comp_channel() destroys the completion event channel
       channel.

RETURN VALUE         top

       ibv_create_comp_channel() returns a pointer to the created
       completion event channel, or NULL if the request fails.

       ibv_destroy_comp_channel() returns 0 on success, or the value of
       errno on failure (which indicates the failure reason).

NOTES         top

       A "completion channel" is an abstraction introduced by libibverbs
       that does not exist in the InfiniBand Architecture verbs
       specification or RDMA Protocol Verbs Specification.  A completion
       channel is essentially file descriptor that is used to deliver
       completion notifications to a userspace process.  When a
       completion event is generated for a completion queue (CQ), the
       event is delivered via the completion channel attached to that
       CQ.  This may be useful to steer completion events to different
       threads by using multiple completion channels.

       ibv_destroy_comp_channel() fails if any CQs are still associated
       with the completion event channel being destroyed.

SEE ALSO         top

       ibv_open_device(3), ibv_create_cq(3), ibv_get_cq_event(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-08-27.  (At
       that time, the date of the most recent commit that was found in
       the repository was 2021-08-18.)  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_COMP_CHANNEL(3)

Pages that refer to this page: ibv_get_cq_event(3)