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 (c) 2001, The IEEE and The Open Group. All Rights Reserved.
Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
cc -mt [ flag... ] file... [ library... ] #include <pthread.h> int pthread_spin_lock(pthread_spinlock_t *lock);
#include <pthread.h> int pthread_spin_trylock(pthread_spinlock_t *lock);
The pthread_spin_lock() function locks the spin lock referenced by lock. The calling thread acquires the lock if it is not held by another thread. Otherwise, the thread spins (that is, does not return from the pthread_spin_lock call()) until the lock becomes available. The results are undefined if the calling thread holds the lock at the time the call is made.
The pthread_spin_trylock() function locks the spin lock referenced by lock if it is not held by any thread. Otherwise, the function fails.
The results are undefined if either of these functions is called with an uninitialized spin lock.
Upon successful completion, these functions returns 0. Otherwise, an error number is returned to indicate the error.
The pthread_spin_trylock() function will fail if: EBUSY
A thread currently holds the lock.
These functions may fail if: EINVAL
The value specified by lock does not refer to an initialized spin lock object.
The pthread_spin_lock() function may fail if: EDEADLK
The calling thread already holds the lock.
See attributes(5) for descriptions of the following attributes:
| ATTRIBUTE TYPE ATTRIBUTE VALUE |
| Interface Stability Standard |
| MT-Level MT-Safe |
pthread_spin_destroy(3C), pthread_spin_unlock(3C), attributes(5), standards(5)