Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

ibv_create_comp_channel(3) [debian man page]

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

NAME

       ibv_create_comp_channel, ibv_destroy_comp_channel - create or destroy a completion event channel

SYNOPSIS

       #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

       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

       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

       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

       ibv_open_device(3), ibv_create_cq(3), ibv_get_cq_event(3)

AUTHORS

       Dotan Barak <dotanba@gmail.com>

libibverbs							    2006-10-31						IBV_CREATE_COMP_CHANNEL(3)

Check Out this Related Man Page

IBV_CREATE_CQ(3)					  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 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

       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

       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_create_qp(3)

AUTHORS

       Dotan Barak <dotanba@gmail.com>

libibverbs							    2006-10-31							  IBV_CREATE_CQ(3)
Man Page