File Manager

003 File Manager

Current Path: /usr/src/contrib/ofed/libibverbs/man

usr / src / contrib / ofed / libibverbs / man /

📁 ..
📄 ibv_alloc_mw.3(1.86 KB)
📄 ibv_alloc_pd.3(1.09 KB)
📄 ibv_asyncwatch.1(643 B)
📄 ibv_attach_mcast.3(1.52 KB)
📄 ibv_bind_mw.3(3.33 KB)
📄 ibv_create_ah.3(1.96 KB)
📄 ibv_create_ah_from_wc.3(1.85 KB)
📄 ibv_create_comp_channel.3(1.83 KB)
📄 ibv_create_cq.3(1.79 KB)
📄 ibv_create_cq_ex.3(6.78 KB)
📄 ibv_create_flow.3(7.92 KB)
📄 ibv_create_qp.3(2.99 KB)
📄 ibv_create_qp_ex.3(4.21 KB)
📄 ibv_create_rwq_ind_table.3(2 KB)
📄 ibv_create_srq.3(1.98 KB)
📄 ibv_create_srq_ex.3(2.35 KB)
📄 ibv_create_wq.3(2.31 KB)
📄 ibv_devices.1(382 B)
📄 ibv_devinfo.1(824 B)
📄 ibv_event_type_str.3(1.15 KB)
📄 ibv_fork_init.3(1.87 KB)
📄 ibv_get_async_event.3(4.65 KB)
📄 ibv_get_cq_event.3(4.73 KB)
📄 ibv_get_device_guid.3(737 B)
📄 ibv_get_device_list.3(1.87 KB)
📄 ibv_get_device_name.3(754 B)
📄 ibv_get_srq_num.3(977 B)
📄 ibv_inc_rkey.3(864 B)
📄 ibv_modify_qp.3(7.34 KB)
📄 ibv_modify_srq.3(1.99 KB)
📄 ibv_modify_wq.3(1.31 KB)
📄 ibv_open_device.3(1.19 KB)
📄 ibv_open_qp.3(1.55 KB)
📄 ibv_open_xrcd.3(2.02 KB)
📄 ibv_poll_cq.3(3.18 KB)
📄 ibv_post_recv.3(2.47 KB)
📄 ibv_post_send.3(6.57 KB)
📄 ibv_post_srq_recv.3(2.31 KB)
📄 ibv_query_device.3(5.15 KB)
📄 ibv_query_device_ex.3(4.87 KB)
📄 ibv_query_gid.3(849 B)
📄 ibv_query_pkey.3(880 B)
📄 ibv_query_port.3(2.45 KB)
📄 ibv_query_qp.3(4.19 KB)
📄 ibv_query_rt_values_ex.3(1.46 KB)
📄 ibv_query_srq.3(1.38 KB)
📄 ibv_rate_to_mbps.3(1.15 KB)
📄 ibv_rate_to_mult.3(1.24 KB)
📄 ibv_rc_pingpong.1(2.13 KB)
📄 ibv_reg_mr.3(2.24 KB)
📄 ibv_req_notify_cq.3(1.5 KB)
📄 ibv_rereg_mr.3(2.45 KB)
📄 ibv_resize_cq.3(1.12 KB)
📄 ibv_srq_pingpong.1(2.21 KB)
📄 ibv_uc_pingpong.1(2.01 KB)
📄 ibv_ud_pingpong.1(1.91 KB)
📄 ibv_xsrq_pingpong.1(2.14 KB)

Editing: ibv_poll_cq.3

.\" -*- nroff -*-
.\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
.\"
.TH IBV_POLL_CQ 3 2006-10-31 libibverbs "Libibverbs Programmer's Manual"
.SH "NAME"
ibv_poll_cq \- poll a completion queue (CQ)
.SH "SYNOPSIS"
.nf
.B #include <infiniband/verbs.h>
.sp
.BI "int ibv_poll_cq(struct ibv_cq " "*cq" ", int " "num_entries" ,
.BI "                struct ibv_wc " "*wc" );
.fi
.SH "DESCRIPTION"
.B ibv_poll_cq()
polls the CQ
.I cq
for work completions and returns the first
.I num_entries
(or all available completions if the CQ contains fewer than this number) in the array
.I wc\fR.
The argument
.I wc
is a pointer to an array of ibv_wc structs, as defined in <infiniband/verbs.h>.
.PP
.nf
struct ibv_wc {
.in +8
uint64_t                wr_id;          /* ID of the completed Work Request (WR) */
enum ibv_wc_status      status;         /* Status of the operation */
enum ibv_wc_opcode      opcode;         /* Operation type specified in the completed WR */
uint32_t                vendor_err;     /* Vendor error syndrome */
uint32_t                byte_len;       /* Number of bytes transferred */
union {
.in +8
__be32                  imm_data;         /* Immediate data (in network byte order) */
uint32_t                invalidated_rkey; /* Local RKey that was invalidated */
.in -8
};
uint32_t                qp_num;         /* Local QP number of completed WR */
uint32_t                src_qp;         /* Source QP number (remote QP number) of completed WR (valid only for UD QPs) */
int                     wc_flags;       /* Flags of the completed WR */
uint16_t                pkey_index;     /* P_Key index (valid only for GSI QPs) */
uint16_t                slid;           /* Source LID */
uint8_t                 sl;             /* Service Level */
uint8_t                 dlid_path_bits; /* DLID path bits (not applicable for multicast messages) */
.in -8
};
.sp
.fi
.PP
The attribute wc_flags describes the properties of the work completion. 
It is either 0 or the bitwise OR of one or more of the following flags:
.PP
.TP
.B IBV_WC_GRH \fR      GRH is present (valid only for UD QPs)
.TP
.B IBV_WC_WITH_IMM \fR Immediate data value is valid
.TP
.B IBV_WC_WITH_INV \fR Invalidated RKey data value is valid (cannot be combined with IBV_WC_WITH_IMM)
.TP
.B IBV_WC_IP_CSUM_OK \fR TCP/UDP checksum over IPv4 and IPv4 header checksum are
verified.
Valid only when \fBdevice_cap_flags\fR in device_attr indicates current QP is
supported by checksum offload.
.PP
Not all
.I wc
attributes are always valid. If the completion status is other than
.B IBV_WC_SUCCESS\fR,
only the following attributes are valid: wr_id, status, qp_num, and vendor_err.
.SH "RETURN VALUE"
On success, 
.B ibv_poll_cq()
returns a non-negative value equal to the number of completions
found.  On failure, a negative value is returned.
.SH "NOTES"
.PP
Each polled completion is removed from the CQ and cannot be returned to it.
.PP
The user should consume work completions at a rate that prevents CQ
overrun from occurrence.  In case of a CQ overrun, the async event
.B IBV_EVENT_CQ_ERR
will be triggered, and the CQ cannot be used.
.SH "SEE ALSO"
.BR ibv_post_send (3),
.BR ibv_post_recv (3)
.SH "AUTHORS"
.TP
Dotan Barak <dotanba@gmail.com>

003 File Manager

Editing: ibv_poll_cq.3

Upload File

Create Folder