usr/src/man/man3dat/dat_rmr_free.3dat

   1 '\" te
   2 .\" This manual page is derived from the DAT/uDAPL 1.2 specification.
   3 .\" Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH DAT_RMR_FREE 3DAT "Jul 16, 2004"
   8 .SH NAME
   9 dat_rmr_free \- destroy an instance of the RMR
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-ldat\fR [ \fIlibrary\fR\&.\|.\|. ]
  14 #include <\fBdat/udat.h\fR>
  15
  16 DAT_RETURN
  17     dat_rmr_free (
  18     IN    DAT_RMR_HANDLE    rmr_handle
  19     )
  20 .fi
  21
  22 .SH PARAMETERS
  23 .sp
  24 .ne 2
  25 .na
  26 \fB\fIrmr_handle\fR\fR
  27 .ad
  28 .RS 14n
  29 Handle for an instance of the RMR to be destroyed.
  30 .RE
  31
  32 .SH DESCRIPTION
  33 .sp
  34 .LP
  35 The \fBdat_rmr_free()\fR function destroys an instance of the RMR.
  36 .sp
  37 .LP
  38 Use of the handle of the destroyed RMR in any subsequent operation except for
  39 the \fBdat_rmr_free()\fR fails. Any remote RDMA operation that uses the
  40 destroyed RMR \fIrmr_context\fR, whose Transport-specific request arrived to
  41 the local host after the \fBdat_rmr_free()\fR has completed, fails and reports
  42 a protection violation. Remote RDMA operation that uses the destroyed RMR
  43 \fIrmr_context\fR, whose Transport-specific request arrived to the local host
  44 prior to the \fBdat_rmr_free()\fR return, might or might not complete
  45 successfully. If it fails, \fBDAT_DTO_ERR_REMOTE_ACCESS\fR is reported in
  46 \fBDAT_DTO_COMPLETION_STATUS\fR for the remote RDMA DTO and the connection is
  47 broken.
  48 .sp
  49 .LP
  50 The \fBdat_rmr_free()\fR function is allowed on either bound or unbound RMR. If
  51 RMR is bound, \fBdat_rmr_free()\fR unbinds (free HCA TPT and other resources
  52 and whatever else binds with length of 0 should do), and then free RMR.
  53 .SH RETURN VALUES
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fBDAT_SUCCESS\fR\fR
  58 .ad
  59 .RS 22n
  60 The operation was successful.
  61 .RE
  62
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fBDAT_INVALID_HANDLE\fR\fR
  67 .ad
  68 .RS 22n
  69 The \fIrmr_handle\fR handle is invalid.
  70 .RE
  71
  72 .SH ATTRIBUTES
  73 .sp
  74 .LP
  75 See \fBattributes\fR(5) for descriptions of the following attributes:
  76 .sp
  77
  78 .sp
  79 .TS
  80 box;
  81 c | c
  82 l | l .
  83 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  84 _
  85 Interface Stability     Standard: uDAPL, 1.1, 1.2
  86 _
  87 MT-Level        Unsafe
  88 .TE
  89
  90 .SH SEE ALSO
  91 .sp
  92 .LP
  93 \fBlibdat\fR(3LIB), \fBattributes\fR(5)