1*8855e28cSpirofti.\" $OpenBSD: pthread_barrier_wait.3,v 1.5 2020/04/06 00:01:08 pirofti Exp $ 2c9961bb2Spirofti.\" 3*8855e28cSpirofti.\" Copyright (c) 2012 Paul Irofti <paul@irofti.net> 4c9961bb2Spirofti.\" 5c9961bb2Spirofti.\" Permission to use, copy, modify, and distribute this software for any 6c9961bb2Spirofti.\" purpose with or without fee is hereby granted, provided that the above 7c9961bb2Spirofti.\" copyright notice and this permission notice appear in all copies. 8c9961bb2Spirofti.\" 9c9961bb2Spirofti.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 10c9961bb2Spirofti.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 11c9961bb2Spirofti.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 12c9961bb2Spirofti.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 13c9961bb2Spirofti.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 14c9961bb2Spirofti.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 15c9961bb2Spirofti.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 16c9961bb2Spirofti.\" 17c9961bb2Spirofti.\" 18*8855e28cSpirofti.Dd $Mdocdate: April 6 2020 $ 19c9961bb2Spirofti.Dt PTHREAD_BARRIER_WAIT 3 20c9961bb2Spirofti.Os 21c9961bb2Spirofti.Sh NAME 22c9961bb2Spirofti.Nm pthread_barrier_wait 236f2b369cSjmc.Nd synchronize at a barrier 24c9961bb2Spirofti.Sh SYNOPSIS 2586f9d4cdStedu.In pthread.h 26c9961bb2Spirofti.Ft int 27c9961bb2Spirofti.Fn pthread_barrier_wait "pthread_barrier_t *barrier" 28c9961bb2Spirofti.Sh DESCRIPTION 29c9961bb2SpiroftiThe 30c9961bb2Spirofti.Fn pthread_barrier_wait 316f2b369cSjmcfunction blocks the calling thread until the required number of threads 326f2b369cSjmccall 336f2b369cSjmc.Fn pthread_barrier_wait , 34d7ee2c56Ssobradoas specified at the object's initialization. 35c9961bb2Spirofti.Sh RETURN VALUES 36c9961bb2SpiroftiIf successful, 37c9961bb2Spirofti.Fn pthread_barrier_wait 386f2b369cSjmcreturns 39c9961bb2Spirofti.Dv PTHREAD_BARRIER_SERIAL_THREAD 406f2b369cSjmcfor a single arbitrary thread and zero for each of the other threads; 416f2b369cSjmcotherwise an error number is returned to indicate the error. 42c9961bb2Spirofti.Sh ERRORS 43c9961bb2Spirofti.Fn pthread_barrier_wait 44c9961bb2Spiroftiwill fail if: 45c9961bb2Spirofti.Bl -tag -width Er 46c9961bb2Spirofti.It Bq Er EINVAL 47c9961bb2SpiroftiThe value specified by 48c9961bb2Spirofti.Fa barrier 49c9961bb2Spiroftiis invalid. 506f2b369cSjmc.El 51c9961bb2Spirofti.Sh SEE ALSO 52c9961bb2Spirofti.Xr pthread_barrier_init 3 , 536f2b369cSjmc.Xr pthread_barrierattr_getpshared 3 , 546f2b369cSjmc.Xr pthread_barrierattr_init 3 55c9961bb2Spirofti.Sh STANDARDS 56c9961bb2Spirofti.Fn pthread_barrier_wait 57c9961bb2Spirofticonforms to 58c9961bb2Spirofti.St -p1003.1-2008 . 59