summaryrefslogtreecommitdiff
path: root/lib/libpthread/man/pthread_barrier_wait.3
diff options
context:
space:
mode:
authorPaul Irofti <pirofti@cvs.openbsd.org>2012-04-11 10:18:47 +0000
committerPaul Irofti <pirofti@cvs.openbsd.org>2012-04-11 10:18:47 +0000
commitabbd14c7192d8a43f2e35665b5f13777c6bbb0a6 (patch)
treec0761cc0e2a4d6f410c0c326a5fa6a4e81229b09 /lib/libpthread/man/pthread_barrier_wait.3
parent130571f42c2079cfa7ac5bd6a8e09876c9b1da18 (diff)
Add pthread barrier support.
Implementation and documentation for: - pthread_barrier_init() - pthread_barrier_destroy() - pthread_barrier_wait() - pthread_barrierattr_init() - pthread_barrierattr_destroy() - pthread_barrierattr_getpshared() - pthread_barrierattr_setpshared() Currently only private barriers are supported. Okay guenther@.
Diffstat (limited to 'lib/libpthread/man/pthread_barrier_wait.3')
-rw-r--r--lib/libpthread/man/pthread_barrier_wait.357
1 files changed, 57 insertions, 0 deletions
diff --git a/lib/libpthread/man/pthread_barrier_wait.3 b/lib/libpthread/man/pthread_barrier_wait.3
new file mode 100644
index 00000000000..e2f66137876
--- /dev/null
+++ b/lib/libpthread/man/pthread_barrier_wait.3
@@ -0,0 +1,57 @@
+.\" $OpenBSD: pthread_barrier_wait.3,v 1.1 2012/04/11 10:18:46 pirofti Exp $
+.\"
+.\" Copyright (c) 2012 Paul Irofti <pirofti@openbsd.org>
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.\"
+.Dd $Mdocdate: April 11 2012 $
+.Dt PTHREAD_BARRIER_WAIT 3
+.Os
+.Sh NAME
+.Nm pthread_barrier_wait
+.Nd synchornize at a barrier
+.Sh SYNOPSIS
+.Fd #include <pthread.h>
+.Ft int
+.Fn pthread_barrier_wait "pthread_barrier_t *barrier"
+.Sh DESCRIPTION
+The
+.Fn pthread_barrier_wait
+function will block the calling thread until the required number of threads
+will call
+.Fn pthread_barrier_wait
+as specified at the object's intialization.
+.Sh RETURN VALUES
+If successful,
+.Fn pthread_barrier_wait
+will return
+.Dv PTHREAD_BARRIER_SERIAL_THREAD
+for a single aribtrary thread and zero for each of the other threads,
+otherwise an error number will be returned to indicate the error.
+.Sh ERRORS
+.Fn pthread_barrier_wait
+will fail if:
+.Bl -tag -width Er
+.It Bq Er EINVAL
+The value specified by
+.Fa barrier
+is invalid.
+.Sh SEE ALSO
+.Xr pthread_barrier_init 3 ,
+.Xr pthread_barrierattr_init 3 ,
+.Xr pthread_barrierattr_getpshared 3
+.Sh STANDARDS
+.Fn pthread_barrier_wait
+conforms to
+.St -p1003.1-2008 .