contrib/ofed/librdmacm/man/rdma_dereg_mr.3

   1 .\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
   2 .TH "RDMA_DEREG_MR" 3 "2010-07-19" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
   3 .SH NAME
   4 rdma_dereg_mr \- deregisters a registered memory region.
   5 .SH SYNOPSIS
   6 .B "#include <rdma/rdma_verbs.h>"
   7 .P
   8 .B "struct ibv_mr *" rdma_dereg_mr
   9 .BI "(struct ibv_mr *" mr ");"
  10 .SH ARGUMENTS
  11 .IP "mr" 12
  12 A reference to a registered memory buffer.
  13 .SH "DESCRIPTION"
  14 Deregisters a memory buffer that had been registered for RDMA
  15 or message operations.  A user should call rdma_dereg_mr for all
  16 registered memory associated with an rdma_cm_id before destroying
  17 the rdma_cm_id.
  18 .SH "RETURN VALUE"
  19 Returns 0 on success, or -1 on error.  If an error occurs, errno will be
  20 set to indicate the failure reason.
  21 .SH "NOTES"
  22 All memory registered with an rdma_cm_id is associated with the
  23 protection domain associated with the id.  Users must deregister
  24 all registered memory before the protection domain can be destroyed.
  25 .SH "SEE ALSO"
  26 rdma_cm(7), rdma_create_id(3), rdma_create_ep(3),
  27 rdma_destroy_id(3), rdma_destroy_ep(3),
  28 rdma_reg_msgs(3), rdma_reg_read(3), rdma_reg_write(3),
  29 ibv_reg_mr(3), ibv_dereg_mr(3)