diff options
| author | jruoho <jruoho@NetBSD.org> | 2010-07-06 21:36:34 +0000 |
|---|---|---|
| committer | jruoho <jruoho@NetBSD.org> | 2010-07-06 21:36:34 +0000 |
| commit | 935deb263fdb27a856e01bfd2073c5af38bb45e4 (patch) | |
| tree | 4ee0da0e50b6492814d17c2df540797977e6fb2e /lib/libpthread | |
| parent | 71e8cdce367f04e59c6e3698802248a4d75788fd (diff) | |
Document pthread_attr_get_np(). Fixes PR lib/39289 from ahoka@.
Diffstat (limited to 'lib/libpthread')
| -rw-r--r-- | lib/libpthread/Makefile | 3 | ||||
| -rw-r--r-- | lib/libpthread/pthread_attr_get_np.3 | 99 |
2 files changed, 101 insertions, 1 deletions
diff --git a/lib/libpthread/Makefile b/lib/libpthread/Makefile index 6cbecfbf396..f1536b3eded 100644 --- a/lib/libpthread/Makefile +++ b/lib/libpthread/Makefile @@ -1,4 +1,4 @@ -# $NetBSD: Makefile,v 1.57 2010/05/19 20:04:43 jruoho Exp $ +# $NetBSD: Makefile,v 1.58 2010/07/06 21:36:34 jruoho Exp $ # WARNS= 4 @@ -89,6 +89,7 @@ COPTS.pthread.c += -Wno-stack-protector MAN+= affinity.3 pthread.3 \ pthread_attr.3 \ + pthread_attr_get_np.3 \ pthread_attr_getname_np.3 \ pthread_attr_setcreatesuspend_np.3 \ pthread_attr_setname_np.3 \ diff --git a/lib/libpthread/pthread_attr_get_np.3 b/lib/libpthread/pthread_attr_get_np.3 new file mode 100644 index 00000000000..e4d570cfef0 --- /dev/null +++ b/lib/libpthread/pthread_attr_get_np.3 @@ -0,0 +1,99 @@ +.\" $NetBSD: pthread_attr_get_np.3,v 1.1 2010/07/06 21:36:34 jruoho Exp $ +.\" +.\" Copyright (c) 2010 Jukka Ruohonen <jruohonen@iki.fi> +.\" 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 NETBSD FOUNDATION, INC. 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 FOUNDATION 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. +.\" +.Dd July 6, 2010 +.Dt PTHREAD_ATTR_GET_NP 3 +.Os +.Sh NAME +.Nm pthread_attr_get_np +.Nd get attributes of existing thread +.Sh LIBRARY +.Lb libpthread +.Sh SYNOPSIS +.In pthread.h +.Ft int +.Fn pthread_attr_get_np "pthread_t thread" "pthread_attr_t *attr" +.Sh DESCRIPTION +The +.Fn pthread_attr_get_np +function can be used to retrieve attributes of a running +.Fa thread . +The result is stored to +.Fa attr , +which should be initialized prior to the call by using +.Xr pthread_attr_init 3 . +.Pp +Most fields of +.Fa attr +are the same ones provided during thread creation time as a parameter to +.Xr pthread_create 3 . +The exceptions include: +.Bl -bullet -offset indent +.It +The detach state -- a joinable thread +may have detached itself after the creation. +.It +The guard size, which may vary if the application +has allocated its own thread stack. +.It +The stack address and size; +.Fn pthread_attr_get_np +will always return the thread's real stack address and size, +regardless of the values in the original attributes structure. +.El +.Pp +The returned +.Vt pthread_attr_t +structure is supposed to be used in conjunction with the +.Fn pthread_attr_get* +functions to retrieve individual values from the structure. +When the returned +.Fa attr +is no longer needed, it should be destroyed by using +.Xr pthread_attr_destroy 3 . +.Sh COMPATIBILITY +The +.Fn pthread_attr_get_np +function is a non-standard extension. +.Sh RETURN VALUES +Upon successful completion, +.Fn pthread_attr_get_np +returns 0. +Otherwise an error number is returned to indicate the error. +.Sh ERRORS +The +.Fn pthread_attr_get_np +function will fail if: +.Bl -tag -width Er +.It Bq Er ENOMEM +Insufficient memory. +.It Bq Er ESRCH +Non-existent +.Fa thread . +.Sh SEE ALSO +.Xr pthread 3 , +.Xr pthread_attr 3 |
