Merge remote branch 'crater/vendor/MDOCML' into HEAD
[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.\"
15acf97d 25.\" $FreeBSD: src/share/man/man3/pthread_attr_get_np.3,v 1.14 2007/10/22 10:08:00 ru 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 27.\"
15acf97d 28.Dd July 10, 2009
984263bc
MD
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
9964d5ef 35.Lb libpthread
984263bc 36.Sh SYNOPSIS
d1428a72 37.In pthread.h
984263bc
MD
38.In pthread_np.h
39.Ft int
40.Fn pthread_attr_get_np "pthread_t pid" "pthread_attr_t *dst"
41.Sh DESCRIPTION
42The
43.Fn pthread_attr_get_np
44function is used to get existent thread's attributes.
45Most fields of
46.Vt pthread_attr_t
47structure are exact values of attributes provided at thread creation
48time (as parameter to
49.Xr pthread_create 3
50function), except for the stack address.
51.Pp
52Value returned as
53.Fa dst
54is supposed to be used in conjunction with
55.Fn pthread_attr_get*
56functions to retrieve individual values from
57.Vt pthread_attr_t
58structure.
59Parameter
60.Fa dst
61should point to allocated memory area big enough to fit this structure.
62.Pp
63It is HIGHLY RECOMMENDED to use
64.Xr pthread_attr_init 3
65function to allocate attribute storage.
66.Sh IMPLEMENTATION NOTES
67The
68.Fn pthread_attr_get_np
69function will always return a pointer to the thread's real stack address,
70regardless of its value in the original attributes structure.
0b84df5c
SW
71.Sh RETURN VALUES
72If successful,
73.Fn pthread_attr_get_np
74function returns 0.
75Otherwise, an error number is returned to indicate the error.
984263bc
MD
76.Sh EXAMPLES
77.Bd -literal
78size_t
79my_thread_stack_size(pthread_t pid)
80{
81 pthread_attr_t attr;
82 size_t size;
83
84 pthread_attr_init(&attr);
85 pthread_attr_get_np(pid, &attr);
86 pthread_attr_getstacksize(&attr, &size);
87 pthread_attr_destroy(&attr);
88 return(size);
89}
90.Ed
984263bc 91.Sh ERRORS
15acf97d 92The
984263bc 93.Fn pthread_attr_get_np
15acf97d 94function will fail if:
984263bc
MD
95.Bl -tag -width Er
96.It Bq Er EINVAL
97Invalid value for one of given parameters.
98.It Bq Er ESRC
99No thread could be found corresponding to that specified by the given
100thread ID.
101.El
102.Sh SEE ALSO
103.Xr pthread_attr_destroy 3 ,
104.Xr pthread_attr_getdetachstate 3 ,
105.Xr pthread_attr_getinheritsched 3 ,
106.Xr pthread_attr_getschedparam 3 ,
107.Xr pthread_attr_getschedpolicy 3 ,
108.Xr pthread_attr_getscope 3 ,
109.Xr pthread_attr_getstack 3 ,
110.Xr pthread_attr_getstackaddr 3 ,
111.Xr pthread_attr_getstacksize 3 ,
112.Xr pthread_attr_init 3
113.Sh AUTHORS
114The
115.Fn pthread_attr_get_np
116function and this manual page were written by
117.An Alexey Zelkin
118.Aq phantom@FreeBSD.org .