aboutsummaryrefslogtreecommitdiff
path: root/contrib/ofed/librdmacm/man/rdma_post_read.3
diff options
context:
space:
mode:
authorHans Petter Selasky <hselasky@FreeBSD.org>2017-08-02 16:00:30 +0000
committerHans Petter Selasky <hselasky@FreeBSD.org>2017-08-02 16:00:30 +0000
commitd6b92ffa990dc57d8a969a98e3ca4e25ba39cbb2 (patch)
tree8cca73c0fa75739adf10581b9e68d682f63048f3 /contrib/ofed/librdmacm/man/rdma_post_read.3
parent434b6d2073f936acc361b1e343dd9615036e1cd9 (diff)
downloadsrc-d6b92ffa990dc57d8a969a98e3ca4e25ba39cbb2.tar.gz
src-d6b92ffa990dc57d8a969a98e3ca4e25ba39cbb2.zip
OFED user-space import and update for use with Linux-4.9 compatible RDMA
kernel APIs. List of sources used: 1) rdma-core was cloned from "https://github.com/linux-rdma/rdma-core.git" Top commit d65138ef93af30b3ea249f3a84aa6a24ba7f8a75 2) OpenSM was cloned from git://git.openfabrics.org/~halr/opensm.git Top commit 85f841cf209f791c89a075048a907020e924528d 3) libibmad was cloned from "git://git.openfabrics.org/~iraweiny/libibmad.git" Tag 1.3.13 with some additional patches from Mellanox. 4) infiniband-diags was cloned from "git://git.openfabrics.org/~iraweiny/infiniband-diags.git" Tag 1.6.7 with some additional patches from Mellanox. Added the required Makefiles for building and installing. Sponsored by: Mellanox Technologies
Notes
Notes: svn path=/projects/bsd_rdma_4_9/; revision=321936
Diffstat (limited to 'contrib/ofed/librdmacm/man/rdma_post_read.3')
-rw-r--r--contrib/ofed/librdmacm/man/rdma_post_read.356
1 files changed, 56 insertions, 0 deletions
diff --git a/contrib/ofed/librdmacm/man/rdma_post_read.3 b/contrib/ofed/librdmacm/man/rdma_post_read.3
new file mode 100644
index 000000000000..11b3e09e16ac
--- /dev/null
+++ b/contrib/ofed/librdmacm/man/rdma_post_read.3
@@ -0,0 +1,56 @@
+.\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
+.TH "RDMA_POST_READ" 3 "2010-07-19" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
+.SH NAME
+rdma_post_read \- post an RDMA read work request.
+.SH SYNOPSIS
+.B "#include <rdma/rdma_verbs.h>"
+.P
+.B "int" rdma_post_read
+.BI "(struct rdma_cm_id *" id ","
+.BI "void *" context ","
+.BI "void *" addr ","
+.BI "size_t " length ","
+.BI "struct ibv_mr *" mr ","
+.BI "int " flags ","
+.BI "uint64_t " remote_addr ","
+.BI "uint32_t " rkey ");"
+.SH ARGUMENTS
+.IP "id" 12
+A reference to a communication identifier where the request
+will be posted.
+.IP "context" 12
+User-defined context associated with the request.
+.IP "addr" 12
+The address of the local destination of the read request.
+.IP "length" 12
+The length of the read operation.
+.IP "mr" 12
+Registered memory region associated with the local buffer.
+.IP "flags" 12
+Optional flags used to control the read operation.
+.IP "remote_addr" 12
+The address of the remote registered memory to read from.
+.IP "rkey" 12
+The registered memory key associated with the remote address.
+.SH "DESCRIPTION"
+Posts a work request to the send queue of the queue pair associated
+with the rdma_cm_id. The contents of the remote memory region will be
+read into the local data buffer.
+.SH "RETURN VALUE"
+Returns 0 on success, or -1 on error. If an error occurs, errno will be
+set to indicate the failure reason.
+.SH "NOTES"
+For a list of supported flags, see ibv_post_send.
+Both the remote and local data buffers must have been registered
+before the read is issued, and the buffers must remain registered
+until the read completes.
+.P
+Read operations may not be posted to an rdma_cm_id or the corresponding
+queue pair until it has been connected.
+.P
+The user-defined context associated with the read request will be
+returned to the user through the work completion wr_id, work request
+identifier, field.
+.SH "SEE ALSO"
+rdma_cm(7), rdma_connect(3), rdma_accept(3),
+ibv_post_send(3), rdma_post_readv(3), rdma_reg_read(3), rdma_reg_msgs(3)