diff options
author | phantom <phantom@FreeBSD.org> | 2002-10-26 15:04:29 +0000 |
---|---|---|
committer | phantom <phantom@FreeBSD.org> | 2002-10-26 15:04:29 +0000 |
commit | 0fc7234ce3c73b2147218f31cd2ab0c31ce62826 (patch) | |
tree | 5843edc9cfc80205699cc85dddb8e799e8066b48 | |
parent | 312cab0dee67b902f2b3c5b4d8873b978e5f0191 (diff) | |
download | FreeBSD-src-0fc7234ce3c73b2147218f31cd2ab0c31ce62826.zip FreeBSD-src-0fc7234ce3c73b2147218f31cd2ab0c31ce62826.tar.gz |
Add & hookup manpage for pthread_attr_get_np(3).
MFC after: 3 days
-rw-r--r-- | lib/libc_r/man/Makefile.inc | 1 | ||||
-rw-r--r-- | lib/libc_r/man/pthread_attr_get_np.3 | 95 | ||||
-rw-r--r-- | share/man/man3/pthread_attr_get_np.3 | 95 |
3 files changed, 191 insertions, 0 deletions
diff --git a/lib/libc_r/man/Makefile.inc b/lib/libc_r/man/Makefile.inc index ed041aa..2d4eea0 100644 --- a/lib/libc_r/man/Makefile.inc +++ b/lib/libc_r/man/Makefile.inc @@ -5,6 +5,7 @@ .PATH: ${.CURDIR}/man MAN+= pthread_attr.3 \ + pthread_attr_get_np.3 \ pthread_cancel.3 \ pthread_cleanup_pop.3 \ pthread_cleanup_push.3 \ diff --git a/lib/libc_r/man/pthread_attr_get_np.3 b/lib/libc_r/man/pthread_attr_get_np.3 new file mode 100644 index 0000000..1a833dd --- /dev/null +++ b/lib/libc_r/man/pthread_attr_get_np.3 @@ -0,0 +1,95 @@ +.\" Copyright (c) 2002 Alexey Zelkin <phantom@FreeBSD.org> +.\" 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$ +.Dd October 26, 2002 +.Dt PTHREAD_ATTR_GET_NP 3 +.Os +.Sh NAME +.Nm pthread_attr_get_np +.Nd get attributes of existent thread +.Sh LIBRARY +.Lb libc_r +.Sh SYNOPSIS +.In pthread_np.h +.Ft int +.Fn pthread_attr_get_np "pthread_t *pid" "pthread_attr_t *dst" +.Sh DESCRIPTION +The +.Fn pthread_attr_get_np +function is used to get existent thread's attributes. +Value returned as +.Fa dst +is supposed to be used in conjunction with +.Fn pthread_attr_get* +functions to retrive individual values from +.Ft pthread_attr_t +structure. Parameter +.Fa dst +should point to allocated memory area big enough to fit this structure. +It's HIGHLY RECOMENDED to use +.Xr pthread_attr_init 3 +function to allocate attribute storage. +.Sh EXAMPLES +.Bd -literal +size_t +my_thread_stack_size(pthread_t pid) +{ + pthread_attr_t attr; + size_t size; + + pthread_attr_init(&attr); + pthread_attr_get_np(&pid, &attr); + pthread_attr_getstacksize(&attr, &size); + pthread_attr_destroy(&attr); + return(size); +} +.Ed +.Sh RETURN VALUES +If successful, +.Fn pthread_attr_get_np +function returns 0. +Otherwise, an error number is returned to indicate the error. +.Sh ERRORS +.Fn pthread_attr_get_np +will fail if: +.Bl -tag -width Er +.It Bq Er EINVAL +Invalid value for one of given parameters. +.El +.Bl -tag -width Er +.It Bq Er ESRCH +No thread could be found corresponding to that specified by the given +thread ID. +.El +.Sh SEE ALSO +.Xr pthread_attr_init 3 , +.Xr pthread_attr_destroy 3 , +.Xr pthread_attr_getstacksize 3 , +.Xr pthread_attr_getstackaddr 3 , +.Xr pthread_attr_getdetachstate 3 , +.Xr pthread_attr_getinheritsched 3 , +.Xr pthread_attr_getschedparam 3 , +.Xr pthread_attr_getschedpolicy 3 , +.Xr pthread_attr_getscope 3 diff --git a/share/man/man3/pthread_attr_get_np.3 b/share/man/man3/pthread_attr_get_np.3 new file mode 100644 index 0000000..1a833dd --- /dev/null +++ b/share/man/man3/pthread_attr_get_np.3 @@ -0,0 +1,95 @@ +.\" Copyright (c) 2002 Alexey Zelkin <phantom@FreeBSD.org> +.\" 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$ +.Dd October 26, 2002 +.Dt PTHREAD_ATTR_GET_NP 3 +.Os +.Sh NAME +.Nm pthread_attr_get_np +.Nd get attributes of existent thread +.Sh LIBRARY +.Lb libc_r +.Sh SYNOPSIS +.In pthread_np.h +.Ft int +.Fn pthread_attr_get_np "pthread_t *pid" "pthread_attr_t *dst" +.Sh DESCRIPTION +The +.Fn pthread_attr_get_np +function is used to get existent thread's attributes. +Value returned as +.Fa dst +is supposed to be used in conjunction with +.Fn pthread_attr_get* +functions to retrive individual values from +.Ft pthread_attr_t +structure. Parameter +.Fa dst +should point to allocated memory area big enough to fit this structure. +It's HIGHLY RECOMENDED to use +.Xr pthread_attr_init 3 +function to allocate attribute storage. +.Sh EXAMPLES +.Bd -literal +size_t +my_thread_stack_size(pthread_t pid) +{ + pthread_attr_t attr; + size_t size; + + pthread_attr_init(&attr); + pthread_attr_get_np(&pid, &attr); + pthread_attr_getstacksize(&attr, &size); + pthread_attr_destroy(&attr); + return(size); +} +.Ed +.Sh RETURN VALUES +If successful, +.Fn pthread_attr_get_np +function returns 0. +Otherwise, an error number is returned to indicate the error. +.Sh ERRORS +.Fn pthread_attr_get_np +will fail if: +.Bl -tag -width Er +.It Bq Er EINVAL +Invalid value for one of given parameters. +.El +.Bl -tag -width Er +.It Bq Er ESRCH +No thread could be found corresponding to that specified by the given +thread ID. +.El +.Sh SEE ALSO +.Xr pthread_attr_init 3 , +.Xr pthread_attr_destroy 3 , +.Xr pthread_attr_getstacksize 3 , +.Xr pthread_attr_getstackaddr 3 , +.Xr pthread_attr_getdetachstate 3 , +.Xr pthread_attr_getinheritsched 3 , +.Xr pthread_attr_getschedparam 3 , +.Xr pthread_attr_getschedpolicy 3 , +.Xr pthread_attr_getscope 3 |