xref: /illumos-gate/usr/src/man/man3c/pthread_mutexattr_getpshared.3c (revision 4c28a617e3922d92a58e813a5b955eb526b9c386)

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 SunOS 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]


Copyright 1991, 1992, 1994, The X/Open Company Ltd.
Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved.
Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.

PTHREAD_MUTEXATTR_GETPSHARED 3C "Mar 23, 2005"
NAME
pthread_mutexattr_getpshared, pthread_mutexattr_setpshared - get or set process-shared attribute
SYNOPSIS

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

int pthread_mutexattr_getpshared(
 const pthread_mutexattr_t *restrict attr,
 int *restrict pshared);

int pthread_mutexattr_setpshared(pthread_mutexattr_t *attr,
 int pshared);
DESCRIPTION

The pthread_mutexattr_getpshared() function obtains the value of the process-shared attribute from the attributes object referenced by attr. The pthread_mutexattr_setpshared() function is used to set 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 mutex to be operated upon by any thread that has access to the memory where the mutex is allocated, even if the mutex is allocated in memory that is shared by multiple processes. If the process-shared attribute is PTHREAD_PROCESS_PRIVATE, the mutex will only be operated upon by threads created within the same process as the thread that initialized the mutex; if threads of differing processes attempt to operate on such a mutex, the behavior is undefined. The default value of the attribute is PTHREAD_PROCESS_PRIVATE.

RETURN VALUES

Upon successful completion, pthread_mutexattr_getpshared() 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, pthread_mutexattr_setpshared() returns 0. Otherwise, an error number is returned to indicate the error.

ERRORS

The pthread_mutexattr_getpshared() and pthread_mutexattr_setpshared() functions may fail if: EINVAL

The value specified by attr is invalid.

The pthread_mutexattr_setpshared() function may fail if: EINVAL

The new value specified for the attribute is outside the range of legal values for that attribute.

ATTRIBUTES

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

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

pthread_create(3C), pthread_mutex_init(3C), pthread_mutexattr_init(3C), pthread_cond_init(3C), attributes(5), standards(5)