usr/src/man/man3rsm/rsm_memseg_import_set_mode.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_SET_MODE 3RSM "Jun 8, 2001"
   7 .SH NAME
   8 rsm_memseg_import_set_mode, rsm_memseg_import_get_mode \- set or get mode for
   9 barrier scoping
  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_set_mode\fR(\fBrsm_memseg_import_handle_t\fR \fImemseg\fR,
  17      \fBrsm_barrier_mode_t\fR \fImode\fR);
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBint\fR \fBrsm_memseg_import_get_mode\fR(\fBrsm_memseg_import_handle_t\fR \fImemseg\fR,
  23      \fBrsm_barrier_mode_t *\fR\fImode\fR);
  24 .fi
  25
  26 .SH DESCRIPTION
  27 .sp
  28 .LP
  29 The  \fBrsm_memseg_import_set_mode()\fR function provides support for optional
  30 explicit barrier scoping in the functions described on the
  31 \fBrsm_memseg_import_get\fR(3RSM) and \fBrsm_memseg_import_put\fR(3RSM) manual
  32 pages.. The two valid barrier modes are \fBRSM_BARRIER_MODE_EXPLICIT\fR and
  33 \fBRSM_BARRIER_MODE_IMPLICIT\fR. By default, the barrier mode is set to
  34 \fBRSM_BARRIER_MODE_IMPLICIT\fR. When the mode is
  35 \fBRSM_BARRIER_MODE_IMPLICIT\fR, an implicit barrier open and barrier close is
  36 applied to the put operation. Irrespective of the mode set, the barrier must be
  37 initialized using the  \fBrsm_memseg_import_init_barrier\fR(3RSM) function
  38 before any barrier operations, either implicit or explicit, are used.
  39 .sp
  40 .LP
  41 The \fBrsm_memseg_import_get_mode()\fR function obtains the current value of
  42 the mode used for barrier scoping in put functions.
  43 .SH RETURN VALUES
  44 .sp
  45 .LP
  46 Upon successful completion, these functions return 0. Otherwise, an error value
  47 is returned to indicate the error.
  48 .SH ERRORS
  49 .sp
  50 .LP
  51 The \fBrsm_memseg_import_set_mode()\fR and \fBrsm_memseg_import_get_mode()\fR
  52 functions can return the following errors:
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fBRSMERR_BAD_SEG_HNDL\fR \fR
  57 .ad
  58 .RS 24n
  59 Invalid segment handle.
  60 .RE
  61
  62 .SH ATTRIBUTES
  63 .sp
  64 .LP
  65 See \fBattributes\fR(5) for descriptions of the following attributes:
  66 .sp
  67
  68 .sp
  69 .TS
  70 box;
  71 c | c
  72 l | l .
  73 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  74 _
  75 Interface Stability     Evolving
  76 _
  77 MT-Level        MT-Safe
  78 .TE
  79
  80 .SH SEE ALSO
  81 .sp
  82 .LP
  83 \fBrsm_memseg_import_get\fR(3RSM), \fBrsm_memseg_import_init_barrier\fR(3RSM),
  84 \fBrsm_memseg_import_put\fR(3RSM), \fBattributes\fR(5)