Scroll to navigation

rpma_write_atomic(3) RPMA Programmer's Manual rpma_write_atomic(3)

NAME

rpma_write_atomic - initiate the atomic write operation

SYNOPSIS


#include <librpma.h>
struct rpma_conn;
struct rpma_mr_local;
struct rpma_mr_remote;
int rpma_write_atomic(struct rpma_conn *conn,
struct rpma_mr_remote *dst, size_t dst_offset,
const struct rpma_mr_local *src, size_t src_offset,
int flags, const void *op_context);

DESCRIPTION

rpma_write_atomic() initiates the atomic write operation (transferring data from the local memory to the remote memory). The atomic write operation allows transferring 8 bytes of data (RPMA_ATOMIC_WRITE_ALIGNMENT) and storing them atomically in the remote memory.

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_write_atomic() function returns 0 on success or a negative error code on failure.

ERRORS

rpma_write_atomic() can fail with the following errors:

  • RPMA_E_INVAL - conn, dst or src is NULL
  • RPMA_E_INVAL - dst_offset is not aligned to 8 bytes
  • RPMA_E_INVAL - flags are not set
  • RPMA_E_PROVIDER - ibv_post_send(3) failed

SEE ALSO

rpma_conn_req_connect(3), rpma_mr_reg(3), rpma_mr_remote_from_descriptor(3), librpma(7) and https://pmem.io/rpma/

22 February 2022 RPMA