xref: /titanic_51/usr/src/man/man3c/pthread_spin_unlock.3c (revision e5351341b58845eee9d722bd71543d5a7c26b6cc)
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_SPIN_UNLOCK 3C "Jan 30, 2004"
NAME
pthread_spin_unlock - unlock a spin lock object
SYNOPSIS

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

int pthread_spin_unlock(pthread_spinlock_t *lock);
DESCRIPTION

The pthread_spin_unlock() function releases the spin lock referenced by lock which was locked with the pthread_spin_lock(3C) or pthread_spin_trylock(3C) functions. The results are undefined if the lock is not held by the calling thread. If there are threads spinning on the lock when pthread_spin_unlock() is called, the lock becomes available and an unspecified spinning thread acquires the lock.

The results are undefined if this function is called with an uninitialized thread spin lock.

RETURN VALUES

Upon successful completion, the pthread_spin_unlock() function returns 0. Otherwise, an error number shall be returned to indicate the error.

ERRORS

The pthread_spin_unlock() function will fail if: EINVAL

An invalid argument was specified.

EPERM

The calling thread does not hold the lock.

ATTRIBUTES

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

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

pthread_spin_destroy(3C), pthread_spin_lock(3C), attributes(5), standards(5)