usr/src/man/man3c/pthread_barrier_destroy.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_DESTROY 3C "Jan 30, 2004"
  47 .SH NAME
  48 pthread_barrier_destroy, pthread_barrier_init \- destroy and initialize a
  49 barrier object
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 cc \fB-mt\fR [ \fIflag\fR... ] \fIfile\fR... [ \fIlibrary\fR... ]
  54 #include <pthread.h>
  55
  56 \fBint\fR \fBpthread_barrier_destroy\fR(\fBpthread_barrier_t *\fR\fIbarrier\fR);
  57 .fi
  58
  59 .LP
  60 .nf
  61 \fBint\fR \fBpthread_barrier_init\fR(\fBpthread_barrier_t *\fR\fIbarrier\fR,
  62      \fBconst pthread_barrierattr_t *restrict\fR \fIattr\fR, \fBunsigned\fR \fIcount\fR);
  63 .fi
  64
  65 .SH DESCRIPTION
  66 .sp
  67 .LP
  68 The \fBpthread_barrier_destroy()\fR function destroys the barrier referenced by
  69 \fIbarrier\fR and releases any resources used by the barrier. The effect of
  70 subsequent use of the barrier is undefined until the barrier is reinitialized
  71 by another call to \fBpthread_barrier_init()\fR. An implementation can use this
  72 function to set barrier to an invalid value. The results are undefined if
  73 \fBpthread_barrier_destroy()\fR is called when any thread is blocked on the
  74 barrier, or if this function is called with an uninitialized barrier.
  75 .sp
  76 .LP
  77 The \fBpthread_barrier_init()\fR function allocates any resources required to
  78 use the barrier referenced by barrier and initializes the barrier with
  79 attributes referenced by \fIattr\fR. If attr is \fINULL\fR, the default barrier
  80 attributes are used; the effect is the same as passing the address of a default
  81 barrier attributes object. The results are undefined if
  82 \fBpthread_barrier_init()\fR is called when any thread is blocked on the
  83 barrier (that is, has not returned from the \fBpthread_barrier_wait\fR(3C)
  84 call). The results are undefined if a barrier is used without first being
  85 initialized. The results are undefined if \fBpthread_barrier_init()\fR is
  86 called specifying an already initialized barrier.
  87 .sp
  88 .LP
  89 The \fIcount\fR argument specifies the number of threads that must call
  90 \fBpthread_barrier_wait()\fR before any of them successfully return from the
  91 call. The value specified by \fIcount\fR must be greater than 0.
  92 .sp
  93 .LP
  94 If the \fBpthread_barrier_init()\fR function fails, the barrier is not
  95 initialized and the contents of \fIbarrier\fR are undefined.
  96 .sp
  97 .LP
  98 Only the object referenced by barrier can be used for performing
  99 synchronization. The result of referring to copies of that object in calls to
 100 \fBpthread_barrier_destroy()\fR or \fBpthread_barrier_wait()\fR is undefined.
 101 .SH RETURN VALUES
 102 .sp
 103 .LP
 104 Upon successful completion, these functions returns 0. Otherwise, an error
 105 number is returned to indicate the error.
 106 .SH ERRORS
 107 .sp
 108 .LP
 109 The \fBpthread_barrier_init()\fR function will fail if:
 110 .sp
 111 .ne 2
 112 .na
 113 \fB\fBEAGAIN\fR\fR
 114 .ad
 115 .RS 10n
 116 The system lacks the necessary resources to initialize another barrier.
 117 .RE
 118
 119 .sp
 120 .ne 2
 121 .na
 122 \fB\fBEINVAL\fR\fR
 123 .ad
 124 .RS 10n
 125 The value specified by \fIcount\fR is equal to 0.
 126 .RE
 127
 128 .sp
 129 .ne 2
 130 .na
 131 \fB\fBENOMEM\fR\fR
 132 .ad
 133 .RS 10n
 134 Insufficient memory exists to initialize the barrier.
 135 .RE
 136
 137 .sp
 138 .LP
 139 The \fBpthread_barrier_init()\fR function may fail if:
 140 .sp
 141 .ne 2
 142 .na
 143 \fB\fBEBUSY\fR\fR
 144 .ad
 145 .RS 10n
 146 The implementation has detected an attempt to destroy a barrier while it is in
 147 use (for example, while being used in a \fBpthread_barrier_wait()\fR call) by
 148 another thread.
 149 .RE
 150
 151 .sp
 152 .ne 2
 153 .na
 154 \fB\fBEINVAL\fR\fR
 155 .ad
 156 .RS 10n
 157 The value specified by \fIattr\fR is invalid.
 158 .RE
 159
 160 .sp
 161 .LP
 162 The \fBpthread_barrier_destroy()\fR function may fail if:
 163 .sp
 164 .ne 2
 165 .na
 166 \fB\fBEBUSY\fR\fR
 167 .ad
 168 .RS 10n
 169 The implementation has detected an attempt to destroy a barrier while it is in
 170 use (for example, while being used in a \fBpthread_barrier_wait()\fR call) by
 171 another thread.
 172 .RE
 173
 174 .sp
 175 .ne 2
 176 .na
 177 \fB\fBEINVAL\fR\fR
 178 .ad
 179 .RS 10n
 180 The value specified by \fIbarrier\fR is invalid.
 181 .RE
 182
 183 .SH ATTRIBUTES
 184 .sp
 185 .LP
 186 See \fBattributes\fR(5) for descriptions of the following attributes:
 187 .sp
 188
 189 .sp
 190 .TS
 191 box;
 192 c | c
 193 l | l .
 194 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 195 _
 196 Interface Stability     Standard
 197 _
 198 MT-Level        MT-Safe
 199 .TE
 200
 201 .SH SEE ALSO
 202 .sp
 203 .LP
 204 \fBpthread_barrier_wait\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)