usr/src/man/man3c/pthread_spin_lock.3c

   1 '\" te
   2 .\" Copyright (c) 2001, the Institute of Electrical and Electronics Engineers, Inc. and The Open Group. All Rights Reserved.
   3 .\" Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" 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
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\" 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.
   7 .\"  This notice shall appear on any product containing this material.
   8 .\" 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.
   9 .\" 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.
  10 .\" 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]
  11 .TH PTHREAD_SPIN_LOCK 3C "Jan 30, 2004"
  12 .SH NAME
  13 pthread_spin_lock, pthread_spin_trylock \- lock a spin lock object
  14 .SH SYNOPSIS
  15 .LP
  16 .nf
  17 cc \fB-mt\fR [ \fIflag\fR... ] \fIfile\fR... [ \fIlibrary\fR... ]
  18 #include <pthread.h>
  19
  20 \fBint\fR \fBpthread_spin_lock\fR(\fBpthread_spinlock_t *\fR\fIlock\fR);
  21 .fi
  22
  23 .LP
  24 .nf
  25 #include <pthread.h>
  26
  27 \fBint\fR \fBpthread_spin_trylock\fR(\fBpthread_spinlock_t *\fR\fIlock\fR);
  28 .fi
  29
  30 .SH DESCRIPTION
  31 .sp
  32 .LP
  33 The \fBpthread_spin_lock()\fR function locks the spin lock referenced by
  34 \fIlock\fR. The calling thread acquires the lock if it is not held by another
  35 thread. Otherwise, the thread spins (that is, does not return from the
  36 \fBpthread_spin_lock call()\fR) until the lock becomes available. The results
  37 are undefined if the calling thread holds the lock at the time the call is
  38 made.
  39 .sp
  40 .LP
  41 The \fBpthread_spin_trylock()\fR function locks the spin lock referenced by
  42 \fIlock\fR if it is not held by any thread. Otherwise, the function fails.
  43 .sp
  44 .LP
  45 The results are undefined if either of these functions is called with an
  46 uninitialized spin lock.
  47 .SH RETURN VALUES
  48 .sp
  49 .LP
  50 Upon successful completion, these functions returns 0. Otherwise, an error
  51 number is returned to indicate the error.
  52 .SH ERRORS
  53 .sp
  54 .LP
  55 The \fBpthread_spin_trylock()\fR function will fail if:
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fBEBUSY\fR\fR
  60 .ad
  61 .RS 9n
  62 A thread currently holds the lock.
  63 .RE
  64
  65 .sp
  66 .LP
  67 These functions may fail if:
  68 .sp
  69 .ne 2
  70 .na
  71 \fB\fBEINVAL\fR\fR
  72 .ad
  73 .RS 10n
  74 The value specified by \fIlock\fR does not refer to an initialized spin lock
  75 object.
  76 .RE
  77
  78 .sp
  79 .LP
  80 The \fBpthread_spin_lock()\fR function may fail if:
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fBEDEADLK\fR\fR
  85 .ad
  86 .RS 11n
  87 The calling thread already holds the lock.
  88 .RE
  89
  90 .SH ATTRIBUTES
  91 .sp
  92 .LP
  93 See \fBattributes\fR(5) for descriptions of the following attributes:
  94 .sp
  95
  96 .sp
  97 .TS
  98 box;
  99 c | c
 100 l | l .
 101 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 102 _
 103 Interface Stability     Standard
 104 _
 105 MT-Level        MT-Safe
 106 .TE
 107
 108 .SH SEE ALSO
 109 .sp
 110 .LP
 111 \fBpthread_spin_destroy\fR(3C), \fBpthread_spin_unlock\fR(3C),
 112 \fBattributes\fR(5), \fBstandards\fR(5)