mirror of https://github.com/mkerrisk/man-pages
115 lines
3.4 KiB
Groff
115 lines
3.4 KiB
Groff
.\" Copyright (c) 2008 Linux Foundation, written by Michael Kerrisk
|
|
.\" <mtk.manpages@gmail.com>
|
|
.\"
|
|
.\" Permission is granted to make and distribute verbatim copies of this
|
|
.\" manual provided the copyright notice and this permission notice are
|
|
.\" preserved on all copies.
|
|
.\"
|
|
.\" Permission is granted to copy and distribute modified versions of this
|
|
.\" manual under the conditions for verbatim copying, provided that the
|
|
.\" entire resulting derived work is distributed under the terms of a
|
|
.\" permission notice identical to this one.
|
|
.\"
|
|
.\" Since the Linux kernel and libraries are constantly changing, this
|
|
.\" manual page may be incorrect or out-of-date. The author(s) assume no
|
|
.\" responsibility for errors or omissions, or for damages resulting from
|
|
.\" the use of the information contained herein. The author(s) may not
|
|
.\" have taken the same level of care in the production of this manual,
|
|
.\" which is licensed free of charge, as they might when working
|
|
.\" professionally.
|
|
.\"
|
|
.\" Formatted or processed versions of this manual, if unaccompanied by
|
|
.\" the source, must acknowledge the copyright and authors of this work.
|
|
.\"
|
|
.TH PTHREAD_ATTR_SETSTACKSIZE 3 2008-11-05 "Linux" "Linux Programmer's Manual"
|
|
.SH NAME
|
|
pthread_attr_setstacksize, pthread_attr_getstacksize \- set/get stack size
|
|
attribute in thread attributes object
|
|
.SH SYNOPSIS
|
|
.nf
|
|
.B #include <pthread.h>
|
|
|
|
.BI "int pthread_attr_setstacksize(pthread_attr_t *" attr \
|
|
", size_t " stacksize );
|
|
.BI "int pthread_attr_getstacksize(pthread_attr_t *" attr \
|
|
", size_t *" stacksize );
|
|
.sp
|
|
Compile and link with \fI\-pthread\fP.
|
|
.SH DESCRIPTION
|
|
The
|
|
.BR pthread_attr_setstacksize ()
|
|
function sets the stack size attribute of the
|
|
thread attributes object referred to by
|
|
.I attr
|
|
to the value specified in
|
|
.IR stacksize .
|
|
|
|
The stack size attribute determines the minimum size (in bytes) that
|
|
will be allocated for threads created using the thread attributes object
|
|
.IR attr .
|
|
|
|
The
|
|
.BR pthread_attr_getstacksize ()
|
|
function returns the stack size attribute of the
|
|
thread attributes object referred to by
|
|
.I attr
|
|
in the buffer pointed to by
|
|
.IR stacksize .
|
|
.SH RETURN VALUE
|
|
On success, these functions return 0;
|
|
on error, they return a non-zero error number.
|
|
.SH ERRORS
|
|
.BR pthread_attr_setstacksize ()
|
|
can fail with the following error:
|
|
.TP
|
|
.B EINVAL
|
|
The stack size is less than
|
|
.BR PTHREAD_STACK_MIN
|
|
(16384) bytes.
|
|
.PP
|
|
On some systems,
|
|
.\" e.g., MacOS
|
|
.BR pthread_attr_setstacksize ()
|
|
can fail with the error
|
|
.B EINVAL
|
|
if
|
|
.I stacksize
|
|
is not a multiple of the system page size.
|
|
.SH VERSIONS
|
|
These functions are provided by glibc since version 2.1.
|
|
.SH CONFORMING TO
|
|
POSIX.1-2001.
|
|
.SH EXAMPLE
|
|
See
|
|
.BR pthread_create (3).
|
|
.SH NOTES
|
|
For details on the default stack size of new threads, see
|
|
.BR pthread_create (3).
|
|
|
|
A thread's stack size is fixed at the time of thread creation.
|
|
Only the main thread can dynamically grow its stack.
|
|
|
|
The
|
|
.BR pthread_attr_setstack (3)
|
|
function allows an application to set both the size and location
|
|
of a caller-allocated stack that is to be used by a thread.
|
|
.SH BUGS
|
|
As at glibc 2.8,
|
|
if the specified
|
|
.I stacksize
|
|
is not a multiple of
|
|
.BR STACK_ALIGN
|
|
(16 bytes on most architectures), it may be rounded
|
|
.IR downwards ,
|
|
in violation of POSIX.1-2001, which says that the allocated stack will
|
|
be at least
|
|
.I stacksize
|
|
bytes.
|
|
.SH SEE ALSO
|
|
.BR getrlimit (2),
|
|
.BR pthread_attr_init (3),
|
|
.BR pthread_attr_setguardsize (3),
|
|
.BR pthread_attr_setstack (3),
|
|
.BR pthread_create (3),
|
|
.BR pthreads (7)
|