share/man/man3c/pthread_spin_lock.3c

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  44 .\" Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
  45 .\"
  46 .TH PTHREAD_SPIN_LOCK 3C "Jan 30, 2004"
  47 .SH NAME
  48 pthread_spin_lock, pthread_spin_trylock \- lock a spin lock object
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 cc \fB-mt\fR [ \fIflag\fR... ] \fIfile\fR... [ \fIlibrary\fR... ]
  53 #include <pthread.h>
  54
  55 \fBint\fR \fBpthread_spin_lock\fR(\fBpthread_spinlock_t *\fR\fIlock\fR);
  56 .fi
  57
  58 .LP
  59 .nf
  60 #include <pthread.h>
  61
  62 \fBint\fR \fBpthread_spin_trylock\fR(\fBpthread_spinlock_t *\fR\fIlock\fR);
  63 .fi
  64
  65 .SH DESCRIPTION
  66 .sp
  67 .LP
  68 The \fBpthread_spin_lock()\fR function locks the spin lock referenced by
  69 \fIlock\fR. The calling thread acquires the lock if it is not held by another
  70 thread. Otherwise, the thread spins (that is, does not return from the
  71 \fBpthread_spin_lock call()\fR) until the lock becomes available. The results
  72 are undefined if the calling thread holds the lock at the time the call is
  73 made.
  74 .sp
  75 .LP
  76 The \fBpthread_spin_trylock()\fR function locks the spin lock referenced by
  77 \fIlock\fR if it is not held by any thread. Otherwise, the function fails.
  78 .sp
  79 .LP
  80 The results are undefined if either of these functions is called with an
  81 uninitialized spin lock.
  82 .SH RETURN VALUES
  83 .sp
  84 .LP
  85 Upon successful completion, these functions returns 0. Otherwise, an error
  86 number is returned to indicate the error.
  87 .SH ERRORS
  88 .sp
  89 .LP
  90 The \fBpthread_spin_trylock()\fR function will fail if:
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fBEBUSY\fR\fR
  95 .ad
  96 .RS 9n
  97 A thread currently holds the lock.
  98 .RE
  99
 100 .sp
 101 .LP
 102 These functions may fail if:
 103 .sp
 104 .ne 2
 105 .na
 106 \fB\fBEINVAL\fR\fR
 107 .ad
 108 .RS 10n
 109 The value specified by \fIlock\fR does not refer to an initialized spin lock
 110 object.
 111 .RE
 112
 113 .sp
 114 .LP
 115 The \fBpthread_spin_lock()\fR function may fail if:
 116 .sp
 117 .ne 2
 118 .na
 119 \fB\fBEDEADLK\fR\fR
 120 .ad
 121 .RS 11n
 122 The calling thread already holds the lock.
 123 .RE
 124
 125 .SH ATTRIBUTES
 126 .sp
 127 .LP
 128 See \fBattributes\fR(5) for descriptions of the following attributes:
 129 .sp
 130
 131 .sp
 132 .TS
 133 box;
 134 c | c
 135 l | l .
 136 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 137 _
 138 Interface Stability     Standard
 139 _
 140 MT-Level        MT-Safe
 141 .TE
 142
 143 .SH SEE ALSO
 144 .sp
 145 .LP
 146 \fBpthread_spin_destroy\fR(3C), \fBpthread_spin_unlock\fR(3C),
 147 \fBattributes\fR(5), \fBstandards\fR(5)