xref: /titanic_51/usr/src/man/man3c/pthread_barrierattr_getpshared.3c (revision 511ef1d6e74f3d1db7bd854375a0926d87bdd7e6)
te
Copyright (c) 2001, the Institute of Electrical and Electronics Engineers, Inc. and The Open Group. All Rights Reserved.
Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.
The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
This notice shall appear on any product containing this material.
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]
PTHREAD_BARRIERATTR_GETPSHARED 3C "Jan 30, 2004"
NAME
pthread_barrierattr_getpshared, pthread_barrierattr_setpshared - get and set process-shared attribute of barrier attributes object
SYNOPSIS

cc -mt [ flag... ] file... [ library... ]
#include <pthread.h>

int pthread_barrierattr_getpshared(
 const pthread_barrierattr_t *restrict attr,
 int *restrict pshared);

int pthread_barrierattr_setpshared(pthread_barrierattr_t *attr,
 int pshared);
DESCRIPTION

The pthread_barrierattr_getpshared() function obtains the value of the process-shared attribute from the attributes object referenced by attr. The pthread_barrierattr_setpshared() function sets the process-shared attribute in an initialized attributes object referenced by attr.

The process-shared attribute is set to PTHREAD_PROCESS_SHARED to permit a barrier to be operated upon by any thread that has access to the memory where the barrier is allocated. If the process-shared attribute is PTHREAD_PROCESS_PRIVATE, the barrier will only be operated upon by threads created within the same process as the thread that initialized the barrier. If threads of different processes attempt to operate on such a barrier, the behavior is undefined.

The default value of the attribute is PTHREAD_PROCESS_PRIVATE. Both constants PTHREAD_PROCESS_SHARED and PTHREAD_PROCESS_PRIVATE are defined in <pthread.h>.

No barrier attributes other than the process-shared attribute are provided.

RETURN VALUES

Upon successful completion, the pthread_barrierattr_getpshared() function returns 0 and stores the value of the process-shared attribute of attr into the object referenced by the pshared parameter. Otherwise, an error number is returned to indicate the error.

Upon successful completion, the pthread_barrierattr_setpshared() function returns 0. Otherwise, an error number is returned to indicate the error.

ERRORS

These functions may fail if: EINVAL

The value specified by attr is invalid.

The pthread_barrierattr_setpshared() function may fail if: EINVAL

The new value specified for the process-shared attribute is not one of the legal values PTHREAD_PROCESS_SHARED or PTHREAD_PROCESS_PRIVATE.

ATTRIBUTES

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

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
MT-Level MT-Safe
SEE ALSO

pthread_barrier_init(3C), pthread_barrierattr_destroy(3C), attributes(5), standards(5)