xref: /openbsd-src/lib/libpthread/man/pthread_attr_setstackaddr.3 (revision a28daedfc357b214be5c701aa8ba8adb29a7f1c2)
1.\" $OpenBSD: pthread_attr_setstackaddr.3,v 1.10 2008/12/18 09:30:32 guenther Exp $
2.\" Manual page derived from TOG's UNIX98 documentation.
3.\"
4.\"  David Leonard, 2000. Public Domain.
5.\"
6.Dd $Mdocdate: December 18 2008 $
7.Dt PTHREAD_ATTR_SETSTACKADDR 3
8.Os
9.Sh NAME
10.Nm pthread_attr_setstackaddr ,
11.Nm pthread_attr_getstackaddr
12.Nd set and get stackaddr attribute
13.Sh SYNOPSIS
14.Fd #include <pthread.h>
15.Ft int
16.Fn pthread_attr_setstackaddr "pthread_attr_t *attr" "void *stackaddr"
17.Ft int
18.Fn pthread_attr_getstackaddr "const pthread_attr_t *attr" "void **stackaddr"
19.Sh DESCRIPTION
20The functions
21.Fn pthread_attr_setstackaddr
22and
23.Fn pthread_attr_getstackaddr ,
24respectively, set and get the thread
25creation
26.Va stackaddr
27attribute in the
28.Fa attr
29object.
30.Pp
31The
32.Va stackaddr
33attribute specifies the location of storage to be
34used for the created thread's stack.
35The size of the storage is at least
36.Dv PTHREAD_STACK_MIN .
37.Sh RETURN VALUES
38Upon successful completion,
39.Fn pthread_attr_setstackaddr
40and
41.Fn pthread_attr_getstackaddr
42return a value of 0.
43Otherwise, an error number is returned to indicate the error.
44.Pp
45The
46.Fn pthread_attr_getstackaddr
47function stores the
48.Va stackaddr
49attribute value in
50.Fa stackaddr
51if successful.
52.Sh ERRORS
53No errors are defined.
54.Pp
55These functions will not return an error code of
56.Bq Er EINTR .
57.Sh SEE ALSO
58.Xr pthread_attr_init 3 ,
59.Xr pthread_attr_setdetachstate 3 ,
60.Xr pthread_attr_setguardsize 3 ,
61.Xr pthread_attr_setstack 3 ,
62.Xr pthread_attr_setstacksize 3 ,
63.Xr pthread_create 3 ,
64.Xr pthreads 3
65.Sh STANDARDS
66.Fn pthread_attr_setstackaddr
67and
68.Fn pthread_attr_getstackaddr
69conform to ISO/IEC 9945-1 ANSI/IEEE
70.Pq Dq Tn POSIX
71Std 1003.1 Second Edition 1996-07-12.
72