usr/src/man/man3rsm/rsm_memseg_import_open_barrier.3rsm

   1 '\" te
   2 .\"  Copyright (c) 2001 by Sun Microsystems, Inc.  All rights reserved.
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH RSM_MEMSEG_IMPORT_OPEN_BARRIER 3RSM "April 9, 2016"
   7 .SH NAME
   8 rsm_memseg_import_open_barrier, rsm_memseg_import_order_barrier,
   9 rsm_memseg_import_close_barrier \- remote memory access error detection
  10 functions
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 cc [ \fIflag\fR... ] \fIfile\fR... -lrsm [ \fIlibrary\fR... ]
  15 #include <rsmapi.h>
  16
  17 \fBint\fR \fBrsm_memseg_import_open_barrier\fR(\fBrsmapi_barrier_t *\fR\fIbarrier\fR);
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBint\fR \fBrsm_memseg_import_order_barrier\fR(\fBrsmapi_barrier_t *\fR\fIbarrier\fR);
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fBint\fR \fBrsm_memseg_import_close_barrier\fR(\fBrsmapi_barrier_t *\fR\fIbarrier\fR);
  28 .fi
  29
  30 .SH DESCRIPTION
  31 .LP
  32 The  \fBrsm_memseg_import_open_barrier()\fR and
  33 \fBrsm_memseg_import_close_barrier()\fR functions provide a means of remote
  34 memory access error detection when the barrier mode is set to
  35 \fBRSM_BARRIER_MODE_EXPLICIT\fR. Open and close barrier operations define a
  36 span-of-time interval for error detection. A successful close barrier
  37 guarantees that remote memory access covered between the open barrier and close
  38 barrier have completed successfully. Any individual failures which may have
  39 occurred between the open barrier and close barrier occur without any
  40 notification and the failure is not reported until the close barrier.
  41 .sp
  42 .LP
  43 The \fBrsm_memseg_import_order_barrier()\fR function imposes the order-of-write
  44 completion whereby, with an order barrier, the write operations issued before
  45 the order barrier are all completed before the operations after the order
  46 barrier. Effectively, with the order barrier call, all writes within one
  47 barrier scope are ordered with respect to those in another barrier scope.
  48 .SH RETURN VALUES
  49 .LP
  50 Upon successful completion, these functions return 0. Otherwise, an error value
  51 is returned to indicate the error.
  52 .SH ERRORS
  53 .LP
  54 The \fBrsm_memseg_import_open_barrier()\fR,
  55 \fBrsm_memseg_import_order_barrier()\fR, and
  56 \fBrsm_memseg_import_close_barrier()\fR functions can return the following
  57 errors:
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fBRSMERR_BAD_SEG_HNDL\fR \fR
  62 .ad
  63 .RS 27n
  64 Invalid segment handle
  65 .RE
  66
  67 .sp
  68 .ne 2
  69 .na
  70 \fB\fBRSMERR_BAD_BARRIER_PTR\fR \fR
  71 .ad
  72 .RS 27n
  73 Invalid barrier pointer.
  74 .RE
  75
  76 .sp
  77 .LP
  78 The \fBrsm_memseg_close_barrier()\fR and \fBrsm_memseg_order_barrier()\fR
  79 functions can return the following errors:
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fBRSMERR_BARRIER_UNINITIALIZED\fR \fR
  84 .ad
  85 .sp .6
  86 .RS 4n
  87 Barrier not initialized.
  88 .RE
  89
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fBRSMERR_BARRIER_NOT_OPENED\fR \fR
  94 .ad
  95 .sp .6
  96 .RS 4n
  97 Barrier not opened.
  98 .RE
  99
 100 .sp
 101 .ne 2
 102 .na
 103 \fB\fBRSMERR_BARRIER_FAILURE\fR \fR
 104 .ad
 105 .sp .6
 106 .RS 4n
 107 Memory access error.
 108 .RE
 109
 110 .sp
 111 .ne 2
 112 .na
 113 \fB\fBRSMERR_CONN_ABORTED\fR \fR
 114 .ad
 115 .sp .6
 116 .RS 4n
 117 Connection aborted.
 118 .RE
 119
 120 .SH ATTRIBUTES
 121 .LP
 122 See \fBattributes\fR(5) for descriptions of the following attributes:
 123 .sp
 124
 125 .sp
 126 .TS
 127 box;
 128 c | c
 129 l | l .
 130 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 131 _
 132 Interface Stability     Evolving
 133 _
 134 MT-Level        MT-Safe
 135 .TE
 136
 137 .SH SEE ALSO
 138 .LP
 139 \fBrsm_memseg_import_init_barrier\fR(3RSM),
 140 \fBrsm_memseg_import_set_mode\fR(3RSM), \fBattributes\fR(5)