usr/src/man/man3c/pthread_spin_unlock.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_UNLOCK 3C "Jan 30, 2004"
  47 .SH NAME
  48 pthread_spin_unlock \- unlock 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_unlock\fR(\fBpthread_spinlock_t *\fR\fIlock\fR);
  56 .fi
  57
  58 .SH DESCRIPTION
  59 .sp
  60 .LP
  61 The \fBpthread_spin_unlock()\fR function releases the spin lock referenced by
  62 \fIlock\fR which was locked with the \fBpthread_spin_lock\fR(3C) or
  63 \fBpthread_spin_trylock\fR(3C) functions. The results are undefined if the lock
  64 is not held by the calling thread. If there are threads spinning on the lock
  65 when \fBpthread_spin_unlock()\fR is called, the lock becomes available and an
  66 unspecified spinning thread acquires the lock.
  67 .sp
  68 .LP
  69 The results are undefined if this function is called with an uninitialized
  70 thread spin lock.
  71 .SH RETURN VALUES
  72 .sp
  73 .LP
  74 Upon successful completion, the \fBpthread_spin_unlock()\fR function returns 0.
  75 Otherwise, an error number shall be returned to indicate the error.
  76 .SH ERRORS
  77 .sp
  78 .LP
  79 The \fBpthread_spin_unlock()\fR function will fail if:
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fBEINVAL\fR\fR
  84 .ad
  85 .RS 10n
  86 An invalid argument was specified.
  87 .RE
  88
  89 .sp
  90 .ne 2
  91 .na
  92 \fB\fBEPERM\fR\fR
  93 .ad
  94 .RS 10n
  95 The calling thread does not hold the lock.
  96 .RE
  97
  98 .SH ATTRIBUTES
  99 .sp
 100 .LP
 101 See \fBattributes\fR(5) for descriptions of the following attributes:
 102 .sp
 103
 104 .sp
 105 .TS
 106 box;
 107 c | c
 108 l | l .
 109 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 110 _
 111 Interface Stability     Standard
 112 _
 113 MT-Level        MT-Safe
 114 .TE
 115
 116 .SH SEE ALSO
 117 .sp
 118 .LP
 119 \fBpthread_spin_destroy\fR(3C), \fBpthread_spin_lock\fR(3C),
 120 \fBattributes\fR(5), \fBstandards\fR(5)