.\" Extracted by src2man from /build/rpma-11eW7Q/rpma-1.3.0/src/include/librpma.h
.\" Text automatically generated by txt2man
.TH rpma_mr_advise 3 "29 May 2023" "RPMA" "RPMA Programmer's Manual"
.SH NAME
\fBrpma_mr_advise \fP- give advice about an address range in a memory registration
.SH SYNOPSIS
.nf
.fam C
      #include <librpma.h>

      struct rpma_mr_local *mr;
      int \fBrpma_mr_advise\fP(struct rpma_mr_local *mr, size_t offset, size_t len, int advice,
              uint32_t flags);

.fam T
.fi
.fam T
.fi
.SH DESCRIPTION
\fBrpma_mr_advise\fP() gives advice about an address range in a memory registration. The usage
parameter specifies the operations that can be performed on the given memory address range.
For available advice and flags values please see \fBibv_advise_mr\fP(3).
.SH RETURN VALUE
The \fBrpma_mr_advise\fP() function returns 0 on success or a negative error code on failure.
.SH ERRORS
\fBrpma_mr_advise\fP() can fail with the following errors:
.IP \(bu 3
RPMA_E_INVAL - in one of the following:
.RS
.IP \(bu 3
the requested range is out of the memory registration bounds
.IP \(bu 3
the memory registration usage does not allow the specific advice
.IP \(bu 3
the flags are invalid
.RE
.IP \(bu 3
RPMA_E_NOSUPP - the operation is not supported by the system
.IP \(bu 3
RPMA_E_PROVIDER - \fBibv_mr_advise\fP(3) failed for other errors
.SH SEE ALSO
\fBrpma_mr_reg\fP(3), \fBibv_mr_advise\fP(3), \fBlibrpma\fP(7) and https://pmem.io/rpma/