xref: /illumos-gate/usr/src/man/man3rsm/rsm_memseg_import_open_barrier.3rsm (revision e0731422366620894c16c1ee6515551c5f00733d)
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_OPEN_BARRIER 3RSM "Jun 8, 2001"
NAME
rsm_memseg_import_open_barrier, rsm_memseg_import_order_barrier, rsm_memseg_import_close_barrier - remote memory access error detection functions
SYNOPSIS

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

int rsm_memseg_import_open_barrier(rsmapi_barrier_t *barrier);

int rsm_memseg_import_order_barrier(rsmapi_barrier_t *barrier);

int rsm_memseg_import_close_barrier(rsmapi_barrier_t *barrier);
DESCRIPTION

The rsm_memseg_import_open_barrier() and rsm_memseg_import_close_barrier() functions provide a means of remote memory access error detection when the barrier mode is set to RSM_BARRIER_MODE_EXPLICIT. Open and close barrier operations define a span-of-time interval for error detection. A successful close barrier guarantees that remote memory access covered between the open barrier and close barrier have completed successfully. Any individual failures which may have occured between the open barrier and close barrier occur without any notification and the failure is not reported until the close barrier.

The rsm_memseg_import_order_barrier() function imposes the order-of-write completion whereby, with an order barrier, the write operations issued before the order barrier are all completed before the operations after the order barrier. Effectively, with the order barrier call, all writes within one barrier scope are ordered with respect to those in another barrier scope.

RETURN VALUES

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

ERRORS

The rsm_memseg_import_open_barrier(), rsm_memseg_import_order_barrier(), and rsm_memseg_import_close_barrier() functions can return the following errors: RSMERR_BAD_SEG_HNDL

Invalid segment handle

RSMERR_BAD_BARRIER_PTR

Invalid barrier pointer.

The rsm_memseg_close_barrier() and rsm_memseg_order_barrier() functions can return the following errors: RSMERR_BARRIER_UNINITIALIZED

Barrier not initialized.

RSMERR_BARRIER_NOT_OPENED

Barrier not opened.

RSMERR_BARRIER_FAILURE

Memory access error.

RSMERR_CONN_ABORTED

Connection aborted.

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_init_barrier(3RSM), rsm_memseg_import_set_mode(3RSM), attributes(5)