share/man/man3c/pthread_barrier_wait.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_BARRIER_WAIT 3C "Jan 30, 2004"
  47 .SH NAME
  48 pthread_barrier_wait \- synchronize at a barrier
  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_barrier_wait\fR(\fBpthread_barrier_t *\fR\fIbarrier\fR);
  56 .fi
  57
  58 .SH DESCRIPTION
  59 .sp
  60 .LP
  61 The \fBpthread_barrier_wait()\fR function synchronizes participating threads at
  62 the barrier referenced by \fIbarrier\fR. The calling thread blocks until the
  63 required number of threads have called \fBpthread_barrier_wait()\fR specifying
  64 the barrier.
  65 .sp
  66 .LP
  67 When the required number of threads have called \fBpthread_barrier_wait()\fR
  68 specifying the barrier, the constant \fBPTHREAD_BARRIER_SERIAL_THREAD\fR is
  69 returned to one unspecified thread and 0 is returned to each of the remaining
  70 threads. At this point, the barrier is reset to the state it had as a result of
  71 the most recent \fBpthread_barrier_init\fR(3C) function that referenced it.
  72 .sp
  73 .LP
  74 The constant \fBPTHREAD_BARRIER_SERIAL_THREAD\fR is defined in
  75 <\fBpthread.h\fR> and its value is distinct from any other value returned by
  76 \fBpthread_barrier_wait()\fR.
  77 .sp
  78 .LP
  79 The results are undefined if this function is called with an uninitialized
  80 barrier.
  81 .sp
  82 .LP
  83 If a signal is delivered to a thread blocked on a barrier, upon return from the
  84 signal handler the thread resumes waiting at the barrier if the barrier wait
  85 has not completed (that is, if the required number of threads have not arrived
  86 at the barrier during the execution of the signal handler); otherwise, the
  87 thread continues as normal from the completed barrier wait. Until the thread in
  88 the signal handler returns from it, it is unspecified whether other threads may
  89 proceed past the barrier once they have all reached it.
  90 .sp
  91 .LP
  92 A thread that has blocked on a barrier does not prevent any unblocked thread
  93 that is eligible to use the same processing resources from eventually making
  94 forward progress in its execution.
  95 .sp
  96 .LP
  97 Eligibility for processing resources is determined by the scheduling policy.
  98 .SH RETURN VALUES
  99 .sp
 100 .LP
 101 Upon successful completion, the \fBpthread_barrier_wait()\fR function returns
 102 \fBPTHREAD_BARRIER_SERIAL_THREAD\fR for a single (arbitrary) thread
 103 synchronized at the barrier and 0 for each of the other threads. Otherwise, an
 104 error number is returned to indicate the error.
 105 .SH ERRORS
 106 .sp
 107 .LP
 108 The \fBpthread_barrier_wait()\fR function will fail if:
 109 .sp
 110 .ne 2
 111 .na
 112 \fB\fBEINVAL\fR\fR
 113 .ad
 114 .RS 10n
 115 The value specified by \fIbarrier\fR does not refer to an initialized barrier
 116 object.
 117 .RE
 118
 119 .SH ATTRIBUTES
 120 .sp
 121 .LP
 122 See \fBattributes\fR(5) for descriptions of the following attributes:
 123 .sp
 124
 125 .sp
 126 .TS
 127 box;
 128 c | c
 129 l | l .
 130 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 131 _
 132 Interface Stability     Standard
 133 _
 134 MT-Level        MT-Safe
 135 .TE
 136
 137 .SH SEE ALSO
 138 .sp
 139 .LP
 140 \fBpthread_barrier_destroy\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)