usr/src/man/man3rsm/rsm_memseg_import_init_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_INIT_BARRIER 3RSM "Jun 8, 2001"
   7 .SH NAME
   8 rsm_memseg_import_init_barrier, rsm_memseg_import_destroy_barrier \- create or
   9 destroy barrier for imported segment
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 cc [ \fIflag\fR... ] \fIfile\fR... -lrsm [ \fIlibrary\fR... ]
  14 #include <rsmapi.h>
  15
  16 \fBint\fR \fBrsm_memseg_import_init_barrier\fR(
  17      \fBrsm_memseg_import_handle_t\fR \fImemseg\fR, \fBrsm_barrier_type_t\fR \fItype\fR,
  18      \fBrsmapi_barrier_t *\fR\fIbarrier\fR);
  19 .fi
  20
  21 .LP
  22 .nf
  23 \fBint\fR \fBrsm_memseg_import_destroy_barrier\fR(\fBrsmapi_barrier_t *\fR\fIbarrier\fR);
  24 .fi
  25
  26 .SH DESCRIPTION
  27 .sp
  28 .LP
  29 The \fBrsm_memseg_import_init_barrier()\fR function creates a barrier for the
  30 imported segment specified by \fImemseg\fR. The barrier type is specified by
  31 the \fItype\fR argument. Currently, only \fBRSM_BAR_DEFAULT\fR is supported as
  32 a barrier type. A handle to the barrier is obtained through the \fIbarrier\fR
  33 argument and is used in subsequent barrier calls.
  34 .sp
  35 .LP
  36 The \fBrsm_memseg_import_destroy_barrier()\fR function deallocates all the
  37 resources associated with the barrier.
  38 .SH RETURN VALUES
  39 .sp
  40 .LP
  41 Upon successful completion, these functions return 0. Otherwise, an error value
  42 is returned to indicate the error.
  43 .SH ERRORS
  44 .sp
  45 .LP
  46 The \fBrsm_memseg_import_init_barrier()\fR and
  47 \fBrsm_memseg_import_destroy_barrier()\fR functions can return the following
  48 errors:
  49 .sp
  50 .ne 2
  51 .na
  52 \fB\fBRSMERR_BAD_SEG_HNDL\fR \fR
  53 .ad
  54 .RS 27n
  55 Invalid segment handle.
  56 .RE
  57
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fBRSMERR_BAD_BARRIER_PTR\fR \fR
  62 .ad
  63 .RS 27n
  64 Invalid barrier pointer.
  65 .RE
  66
  67 .sp
  68 .LP
  69 The \fBrsm_memseg_import_init_barrier()\fR function can return the following
  70 errors:
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fBRSMERR_INSUFFICIENT_MEM\fR \fR
  75 .ad
  76 .RS 28n
  77 Insufficient memory.
  78 .RE
  79
  80 .SH ATTRIBUTES
  81 .sp
  82 .LP
  83 See \fBattributes\fR(5) for descriptions of the following attributes:
  84 .sp
  85
  86 .sp
  87 .TS
  88 box;
  89 c | c
  90 l | l .
  91 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  92 _
  93 Interface Stability     Evolving
  94 _
  95 MT-Level        MT-Safe
  96 .TE
  97
  98 .SH SEE ALSO
  99 .sp
 100 .LP
 101 \fBrsm_memseg_import_open_barrier\fR(3RSM),
 102 \fBrsm_memseg_import_set_mode\fR(3RSM), \fBattributes\fR(5)