File: rdma_dereg_mr.3

package info (click to toggle)
rdma-core 56.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 17,196 kB
  • sloc: ansic: 171,361; python: 13,724; sh: 2,774; perl: 1,465; makefile: 73
file content (29 lines) | stat: -rw-r--r-- 1,165 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
.\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
.TH "RDMA_DEREG_MR" 3 "2010-07-19" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
.SH NAME
rdma_dereg_mr \- deregisters a registered memory region.
.SH SYNOPSIS
.B "#include <rdma/rdma_verbs.h>"
.P
.B "int" rdma_dereg_mr
.BI "(struct ibv_mr *" mr ");"
.SH ARGUMENTS
.IP "mr" 12
A reference to a registered memory buffer.
.SH "DESCRIPTION"
Deregisters a memory buffer that had been registered for RDMA
or message operations.  A user should call rdma_dereg_mr for all
registered memory associated with an rdma_cm_id before destroying
the rdma_cm_id.
.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"
All memory registered with an rdma_cm_id is associated with the
protection domain associated with the id.  Users must deregister
all registered memory before the protection domain can be destroyed.
.SH "SEE ALSO"
rdma_cm(7), rdma_create_id(3), rdma_create_ep(3),
rdma_destroy_id(3), rdma_destroy_ep(3),
rdma_reg_msgs(3), rdma_reg_read(3), rdma_reg_write(3),
ibv_reg_mr(3), ibv_dereg_mr(3)