rpma_read(3)

rpma_read - initiate the read operation

Section 3 librpma-dev bookworm source

Description

rpma_read

NAME

rpma_read - initiate the read operation

SYNOPSIS

#include <librpma.h>

struct rpma_conn;
struct rpma_mr_local;
struct rpma_mr_remote;
int rpma_read(struct rpma_conn *conn,
struct rpma_mr_local *dst, size_t dst_offset,
const struct rpma_mr_remote *src, size_t src_offset,
size_t len, int flags, const void *op_context);

DESCRIPTION

rpma_read() initiates transferring data from the remote memory to the local memory. To read a 0 bytes message, set src and dst to NULL and src_offset, dst_offset and len to 0.

The attribute flags set the completion notification indicator:

	•		RPMA_F_COMPLETION_ON_ERROR - generate the completion on error
	•		RPMA_F_COMPLETION_ALWAYS - generate the completion regardless of result of the operation.

op_context is returned in the wr_id field of the completion (struct ibv_wc).

RETURN VALUE

The rpma_read() function returns 0 on success or a negative error code on failure.

ERRORS

rpma_read() can fail with the following errors:

	•		RPMA_E_INVAL - conn == NULL \|\| flags == 0
	•		RPMA_E_INVAL - dst == NULL && (src != NULL \|\| src_offset != 0 \|\| dst_offset != 0 \|\| len != 0)
	•		RPMA_E_INVAL - src == NULL && (dst != NULL \|\| src_offset != 0 \|\| dst_offset != 0 \|\| len != 0)
	•		RPMA_E_PROVIDER - ibv_post_send(3) failed