xref: /titanic_41/usr/src/man/man3rsm/rsm_memseg_import_set_mode.3rsm (revision ed22c7109fc5dd9e1b7a5d0333bdc7ad2718e2ab) 
 te
 Copyright (c) 2001 by Sun Microsystems, Inc. All rights reserved.
 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.
 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.
 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]
 RSM_MEMSEG_IMPORT_SET_MODE 3RSM "Jun 8, 2001"
 NAME
rsm_memseg_import_set_mode, rsm_memseg_import_get_mode - set or get mode for
barrier scoping

 SYNOPSIS


cc [ flag... ] file... -lrsm [ library... ]
#include <rsmapi.h>

int rsm_memseg_import_set_mode(rsm_memseg_import_handle_t memseg,
 rsm_barrier_mode_t mode);






int rsm_memseg_import_get_mode(rsm_memseg_import_handle_t memseg,
 rsm_barrier_mode_t *mode);




 DESCRIPTION

The rsm_memseg_import_set_mode() function provides support for optional
explicit barrier scoping in the functions described on the
rsm_memseg_import_get(3RSM) and rsm_memseg_import_put(3RSM) manual
pages.. The two valid barrier modes are RSM_BARRIER_MODE_EXPLICIT and
RSM_BARRIER_MODE_IMPLICIT. By default, the barrier mode is set to
RSM_BARRIER_MODE_IMPLICIT. When the mode is
RSM_BARRIER_MODE_IMPLICIT, an implicit barrier open and barrier close is
applied to the put operation. Irrespective of the mode set, the barrier must be
initialized using the rsm_memseg_import_init_barrier(3RSM) function
before any barrier operations, either implicit or explicit, are used.


The rsm_memseg_import_get_mode() function obtains the current value of
the mode used for barrier scoping in put functions.

 RETURN VALUES

Upon successful completion, these functions return 0. Otherwise, an error value
is returned to indicate the error.

 ERRORS

The rsm_memseg_import_set_mode() and rsm_memseg_import_get_mode()
functions can return the following errors:
RSMERR_BAD_SEG_HNDL 


Invalid segment handle.




 ATTRIBUTES

See attributes(5) for descriptions of the following attributes:






ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Evolving
MT-Level MT-Safe



 SEE ALSO

rsm_memseg_import_get(3RSM), rsm_memseg_import_init_barrier(3RSM),
rsm_memseg_import_put(3RSM), attributes(5)