share/man/man3dat/dat_lmr_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_LMR_FREE 3DAT "Jul 16, 2004"
   8 .SH NAME
   9 dat_lmr_free \- destroy an instance of the LMR
  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_lmr_free (
  18     IN    DAT_LMR_HANDLE    lmr_handle
  19     )
  20 .fi
  21
  22 .SH PARAMETERS
  23 .sp
  24 .ne 2
  25 .na
  26 \fB\fIlmr_handle:\fR\fR
  27 .ad
  28 .RS 15n
  29 Handle for an instance of LMR to be destroyed.
  30 .RE
  31
  32 .SH DESCRIPTION
  33 .sp
  34 .LP
  35 The \fBdat_lmr_free()\fR function destroys an instance of the LMR. The LMR
  36 cannot be destroyed if it is in use by an RMR. The operation does not
  37 deallocate the memory region or unpin memory on a host.
  38 .sp
  39 .LP
  40 Use of the handle of the destroyed LMR in any subsequent operation except for
  41 \fBdat_lmr_free()\fR fails. Any DTO operation that uses the destroyed LMR after
  42 the \fBdat_lmr_free()\fR is completed shall fail and report a protection
  43 violation. The use of \fIrmr_context\fR of the destroyed LMR by a remote peer
  44 for an RDMA DTO results in an error and broken connection on which it was used.
  45 Any remote RDMA operation that uses the destroyed LMR rmr_context\fI\fR, whose
  46 Transport-specific request arrived to the local host after the
  47 \fBdat_lmr_free()\fR has completed, fails and reports a protection violation.
  48 Remote RDMA operation that uses the destroyed LMR \fIrmr_context\fR, whose
  49 Transport-specific request arrived to the local host prior to the
  50 \fBdat_lmr_free()\fR returns, might or might not complete successfully. If it
  51 fails, \fBDAT_DTO_ERR_REMOTE_ACCESS\fR is reported in
  52 \fBDAT_DTO_COMPLETION_STATUS\fR for the remote RDMA DTO and the connection is
  53 broken.
  54 .SH RETURN VALUES
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fBDAT_SUCCESS\fR\fR
  59 .ad
  60 .RS 22n
  61 The operation was successful.
  62 .RE
  63
  64 .sp
  65 .ne 2
  66 .na
  67 \fB\fBDAT_INVALID_HANDLE\fR\fR
  68 .ad
  69 .RS 22n
  70 The \fIlmr_handle\fR parameter is invalid.
  71 .RE
  72
  73 .sp
  74 .ne 2
  75 .na
  76 \fB\fBDAT_INVALID_STATE\fR\fR
  77 .ad
  78 .RS 22n
  79 Parameter in an invalid state; LMR is in use by an RMR instance.
  80 .RE
  81
  82 .SH ATTRIBUTES
  83 .sp
  84 .LP
  85 See \fBattributes\fR(5) for descriptions of the following attributes:
  86 .sp
  87
  88 .sp
  89 .TS
  90 box;
  91 c | c
  92 l | l .
  93 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  94 _
  95 Interface Stability     Standard: uDAPL, 1.1, 1.2
  96 _
  97 MT-Level        Unsafe
  98 .TE
  99
 100 .SH SEE ALSO
 101 .sp
 102 .LP
 103 \fBlibdat\fR(3LIB), \fBattributes\fR(5)