Move pthread* manpages to lib/libpthread as they are not libc_r specific.
[dragonfly.git] / lib / libpthread / pthread_attr_get_np.3
CommitLineData
984263bc
MD
1.\" Copyright (c) 2002,2003 Alexey Zelkin <phantom@FreeBSD.org>
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\" notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\" notice, this list of conditions and the following disclaimer in the
11.\" documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD: src/lib/libc_r/man/pthread_attr_get_np.3,v 1.4.2.3 2003/03/03 22:02:43 phantom Exp $
0b84df5c 26.\" $DragonFly: src/lib/libc_r/man/pthread_attr_get_np.3,v 1.3 2006/02/17 19:35:07 swildner Exp $
984263bc
MD
27.\"
28.Dd January 31, 2003
29.Dt PTHREAD_ATTR_GET_NP 3
30.Os
31.Sh NAME
32.Nm pthread_attr_get_np
33.Nd get attributes of existent thread
34.Sh LIBRARY
35.Lb libc_r
36.Sh SYNOPSIS
37.In pthread_np.h
38.Ft int
39.Fn pthread_attr_get_np "pthread_t pid" "pthread_attr_t *dst"
40.Sh DESCRIPTION
41The
42.Fn pthread_attr_get_np
43function is used to get existent thread's attributes.
44Most fields of
45.Vt pthread_attr_t
46structure are exact values of attributes provided at thread creation
47time (as parameter to
48.Xr pthread_create 3
49function), except for the stack address.
50.Pp
51Value returned as
52.Fa dst
53is supposed to be used in conjunction with
54.Fn pthread_attr_get*
55functions to retrieve individual values from
56.Vt pthread_attr_t
57structure.
58Parameter
59.Fa dst
60should point to allocated memory area big enough to fit this structure.
61.Pp
62It is HIGHLY RECOMMENDED to use
63.Xr pthread_attr_init 3
64function to allocate attribute storage.
65.Sh IMPLEMENTATION NOTES
66The
67.Fn pthread_attr_get_np
68function will always return a pointer to the thread's real stack address,
69regardless of its value in the original attributes structure.
0b84df5c
SW
70.Sh RETURN VALUES
71If successful,
72.Fn pthread_attr_get_np
73function returns 0.
74Otherwise, an error number is returned to indicate the error.
984263bc
MD
75.Sh EXAMPLES
76.Bd -literal
77size_t
78my_thread_stack_size(pthread_t pid)
79{
80 pthread_attr_t attr;
81 size_t size;
82
83 pthread_attr_init(&attr);
84 pthread_attr_get_np(pid, &attr);
85 pthread_attr_getstacksize(&attr, &size);
86 pthread_attr_destroy(&attr);
87 return(size);
88}
89.Ed
984263bc
MD
90.Sh ERRORS
91.Fn pthread_attr_get_np
92will fail if:
93.Bl -tag -width Er
94.It Bq Er EINVAL
95Invalid value for one of given parameters.
96.It Bq Er ESRC
97No thread could be found corresponding to that specified by the given
98thread ID.
99.El
100.Sh SEE ALSO
101.Xr pthread_attr_destroy 3 ,
102.Xr pthread_attr_getdetachstate 3 ,
103.Xr pthread_attr_getinheritsched 3 ,
104.Xr pthread_attr_getschedparam 3 ,
105.Xr pthread_attr_getschedpolicy 3 ,
106.Xr pthread_attr_getscope 3 ,
107.Xr pthread_attr_getstack 3 ,
108.Xr pthread_attr_getstackaddr 3 ,
109.Xr pthread_attr_getstacksize 3 ,
110.Xr pthread_attr_init 3
111.Sh AUTHORS
112The
113.Fn pthread_attr_get_np
114function and this manual page were written by
115.An Alexey Zelkin
116.Aq phantom@FreeBSD.org .