From 92fa0888006446f19ecb94917fc328f73a181ca5 Mon Sep 17 00:00:00 2001 From: mtm Date: Thu, 19 Feb 2004 13:51:52 +0000 Subject: Implement PThreads barriers and barrier attributes. --- share/man/man3/Makefile | 8 ++ share/man/man3/pthread_barrier_destroy.3 | 157 +++++++++++++++++++++++++++++++ share/man/man3/pthread_barrierattr.3 | 150 +++++++++++++++++++++++++++++ 3 files changed, 315 insertions(+) create mode 100644 share/man/man3/pthread_barrier_destroy.3 create mode 100644 share/man/man3/pthread_barrierattr.3 (limited to 'share/man/man3') diff --git a/share/man/man3/Makefile b/share/man/man3/Makefile index 8e5df1b..fb9ceb8 100644 --- a/share/man/man3/Makefile +++ b/share/man/man3/Makefile @@ -140,6 +140,8 @@ PTHREAD_MAN= pthread.3 \ pthread_attr.3 \ pthread_attr_get_np.3 \ pthread_attr_setcreatesuspend_np.3 \ + pthread_barrier_destroy.3 \ + pthread_barrierattr.3 \ pthread_cancel.3 \ pthread_cleanup_pop.3 \ pthread_cleanup_push.3 \ @@ -216,6 +218,12 @@ PTHREAD_MLINKS= pthread_attr.3 pthread_attr_destroy.3 \ pthread_attr.3 pthread_attr_setstack.3 \ pthread_attr.3 pthread_attr_setstackaddr.3 \ pthread_attr.3 pthread_attr_setstacksize.3 +PTHREAD_MLINKS+=pthread_barrier_destroy.3 pthread_barrier_init.3 \ + pthread_barrier_destroy.3 pthread_barrier_wait.3 +PTHREAD_MLINKS+=pthread_barrierattr.3 pthread_barrierattr_destroy.3 \ + pthread_barrierattr.3 pthread_barrierattr_getpshared.3 \ + pthread_barrierattr.3 pthread_barrierattr_init.3 \ + pthread_barrierattr.3 pthread_barrierattr_setpshared.3 PTHREAD_MLINKS+=pthread_condattr.3 pthread_condattr_destroy.3 \ pthread_condattr.3 pthread_condattr_init.3 PTHREAD_MLINKS+=pthread_getconcurrency.3 pthread_setconcurrency.3 diff --git a/share/man/man3/pthread_barrier_destroy.3 b/share/man/man3/pthread_barrier_destroy.3 new file mode 100644 index 0000000..27ded5b --- /dev/null +++ b/share/man/man3/pthread_barrier_destroy.3 @@ -0,0 +1,157 @@ +.\" Copyright (c) 2004 Michael Telahun Makonnen +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.\" Note: The date here should be updated whenever a non-trivial +.\" change is made to the manual page. +.Dd February 19, 2004 +.Dt PTHREAD_BARRIER_DESTROY 3 PTHREAD_BARRIER_INIT 3 PTHREAD_BARRIER_WAIT 3 +.Os +.Sh NAME +.Nm pthread_barrier_destroy pthread_barrier_init pthread_barrier_wait +.Nd "destroy, initialize or wait on a barrier object" +.Sh LIBRARY +.Lb libpthread +.Lb libthr +.Sh SYNOPSIS +.In pthread.h +.Ft int +.Fn pthread_barrier_destroy "pthread_barrier_t *barrier" +.Ft int +.Fn pthread_barrier_init "pthread_barrier_t *barrier" "const pthread_barrierattr_t *attr" "int count" +.Ft int +.Fn pthread_barrier_wait "pthread_barrier_t *barrier" +.Sh DESCRIPTION +The +.Fn pthread_barrier_init +function will initialize +.Fa barrier +with attributes specified in +.Fa attr , +or if it is NULL, +with default attributes. +The number of threads that must call +.Fn pthread_barrier_wait +before any of the waiting threads can be +released is specified by +.Fa count . +The +.Fn pthread_barrier_destroy +function will destroy +.Fa barrier +and release any resources that may have been allocated on its behalf. +.Pp +The +.Fn pthread_barrier_wait +function will synchronize calling threads at +.Fa barrier . +The threads will be blocked from +making further progress until +a sufficient number of threads calls this function. +The number of threads that must call it before +any of them will be released is determined by the +.Fa count +argument to +.Fn pthread_barrier_init . +Once the threads have been released the barrier will be reset. +.Sh DIAGNOSTICS +If successful, +both +.Fn pthread_barrier_destroy +and +.Fn pthread_barrier_init +will return zero. +Otherwise an error number will be returned to indicate the error. +If the call to +.Fn pthread_barrier_wait +is successful all but one of the threads will return zero. +That one thread will return PTHREAD_BARRIER_SERIAL_THREAD. +Otherwise an error number will be returned to indicate the error. +.Pp +None of these functions will return EINTR. +.Sh IMPLIMENTATION NOTES +In both +.Lb libpthread +and +.Lb libthr +the PTHREAD_BARRIER_SERIAL_THREAD return value will +always be returned by the last thread to reach the barrier. +.Sh ERRORS +The +.Fn pthread_barrier_destroy +function will fail if: +.Bl -tag -width Er +.It Bq Er EBUSY +An attempt was made to destroy +.Fa barrier +while it was in use. +.El +.Pp +The +.Fn pthread_barrier_destroy +and +.Fn pthread_barrier_wait +functions may fail if: +.Bl -tag -width Er +.It Bq Er EINVAL +The value specified by +.Fa barrier +is invalid. +.El +.Pp +The +.Fn pthread_barrier_init +function will fail if: +.Bl -tag -width Er +.It Bq Er EAGAIN +The system lacks resources, +other than memory, +to initialize +.Fa barrier . +.It Bq Er EINVAL +The +.Fa count +argument is less than 1. +.It Bq Er ENOMEM +Insufficient memory to initialize +.Fa barrier . +.El +.Sh SEE ALSO +.Xr pthread_barrier_wait 3 , +.Xr pthread_barrierattr 3 +.Sh HISTORY +The +.Fn pthread_barrier_destroy , +.Fn pthread_barrier_init +and +.Fn pthread_barrier_wait +functions first appeared in +.Lb libpthread +in +.Fx 5.2 , +and in +.Lb libthr +in +.Fx 5.3 . diff --git a/share/man/man3/pthread_barrierattr.3 b/share/man/man3/pthread_barrierattr.3 new file mode 100644 index 0000000..2931bdf --- /dev/null +++ b/share/man/man3/pthread_barrierattr.3 @@ -0,0 +1,150 @@ +.\" Copyright (c) 2004 Michael Telahun Makonnen +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.\" Note: The date here should be updated whenever a non-trivial +.\" change is made to the manual page. +.Dd February 19, 2004 +.Dt PTHREAD_BARRIERATTR_DESTROY 3 PTHREAD_BARRIERATTR_GETPSHARED 3 PTHREAD_BARRIERATTR_INIT 3 PTHREAD_BARRIERATTR_SETPSHARED 3 +.Os +.Sh NAME +.Nm pthread_barrierattr_destroy pthread_barrierattr_getpshared +.Nm pthread_barrierattr_init pthread_barrierattr_setpshared +.Nd "manipulate a barrier attribute object" +.Sh LIBRARY +.Lb libpthread +.Lb libthr +.Sh SYNOPSIS +.In pthread.h +.Ft int +.Fn pthread_barrierattr_destroy "pthread_barrierattr_t *attr" +.Ft int +.Fn pthread_barrierattr_getpshared "const pthread_barrierattr_t *attr" "int *pshared" +.Ft int +.Fn pthread_barrierattr_init "pthread_barrierattr_t *attr" +.Ft int +.Fn pthread_barrierattr_setpshared "pthread_barrierattr_t *attr" "int pshared" +.Sh DESCRIPTION +The +.Fn pthread_barrierattr_init +function will initialize +.Fa attr +with default attributes. +The +.Fn pthread_barrierattr_destroy +function will destroy +.Fa attr +and release any resources that may have been allocated on its behalf. +.Pp +The +.Fn pthread_barrierattr_getpshared +function will put the value of the process-shared attribute from +.Fa attr +into the memory area pointed to by +.Fa pshared . +The +.Fn pthread_barrierattr_setpshared +function will set the process-shared attribute of +.Fa attr +to the value specified in +.Fa pshared. +The argument +.Fa pshared +may have one of the following values: +.Bl -tag -width ".Dv PTHREAD_PROCESS_PRIVATE" +.It Dv PTHREAD_PROCESS_PRIVATE +The barrier object it is attached to may only be accessed by +threads in the same process as the one that created the object. +.It Dv PTHREAD_PROCESS_SHARED +The barrier object it is attached to may be accessed by +threads in processes other than the one that created the object. +.El +.Sh DIAGNOSTICS +If successful all these functions will return zero. +Otherwise an error number will be returned to indicate the error. +.Pp +None of these functions will return EINTR. +.Pp +.Sh ERRORS +The +.Fn pthread_barrierattr_destroy , +.Fn pthread_barrierattr_getpshared +and +.Fn pthread_barrierattr_setpshared +functions may fail if: +.Bl -tag -width Er +.It Bq Er EINVAL +The value specified by +.Fa attr +is invalid. +.El +.Pp +The +.Fn pthread_barrierattr_init +function will fail if: +.Bl -tag -width Er +.It Bq Er ENOMEM +Insufficient memory to initialize the barrier attribute object +.Fa attr . +.El +.Pp +The +.Fn pthread_barrierattr_setpshared +function will fail if: +.Bl -tag -width Er +.It Bq Er EINVAL +The value specified in +.Fa pshared +is not one of the allowed values. +.El +.Sh SEE ALSO +.Xr pthread_barrier_destroy 3 , +.Xr pthread_barrier_init 3 , +.Xr pthread_barrier_wait 3 , +.Sh HISTORY +The +.Fn pthread_barrierattr +functions first appeared in +.Lb libpthread +in +.Fx 5.2 , +and in +.Lb libthr +in +.Fx 5.3 . +.Sh BUGS +The implementation of +.Fn pthread_barriers +does not fully conform to +.St -p1003.2 +because the process-shared attribute is ignored in +.Lb libthr , +and in +.Lb libpthread +if any value other than +.Dv PTHREAD_PROCESSES_PRIVATE +is specified in a call to +.Fn pthread_barrierattr_setpshared +it will return EINVAL. -- cgit v1.1