man3/pthread_attr_setstacksize.3

   1 .\" Copyright (c) 2008 Linux Foundation, written by Michael Kerrisk
   2 .\"     <mtk.manpages@gmail.com>
   3 .\"
   4 .\" %%%LICENSE_START(VERBATIM)
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\" %%%LICENSE_END
  25 .\"
  26 .TH PTHREAD_ATTR_SETSTACKSIZE 3 2021-03-22 "Linux" "Linux Programmer's Manual"
  27 .SH NAME
  28 pthread_attr_setstacksize, pthread_attr_getstacksize \- set/get stack size
  29 attribute in thread attributes object
  30 .SH SYNOPSIS
  31 .nf
  32 .B #include <pthread.h>
  33 .PP
  34 .BI "int pthread_attr_setstacksize(pthread_attr_t *" attr \
  35 ", size_t " stacksize );
  36 .BI "int pthread_attr_getstacksize(const pthread_attr_t *restrict " attr ,
  37 .BI "                              size_t *restrict " stacksize );
  38 .PP
  39 Compile and link with \fI\-pthread\fP.
  40 .fi
  41 .SH DESCRIPTION
  42 The
  43 .BR pthread_attr_setstacksize ()
  44 function sets the stack size attribute of the
  45 thread attributes object referred to by
  46 .I attr
  47 to the value specified in
  48 .IR stacksize .
  49 .PP
  50 The stack size attribute determines the minimum size (in bytes) that
  51 will be allocated for threads created using the thread attributes object
  52 .IR attr .
  53 .PP
  54 The
  55 .BR pthread_attr_getstacksize ()
  56 function returns the stack size attribute of the
  57 thread attributes object referred to by
  58 .I attr
  59 in the buffer pointed to by
  60 .IR stacksize .
  61 .SH RETURN VALUE
  62 On success, these functions return 0;
  63 on error, they return a nonzero error number.
  64 .SH ERRORS
  65 .BR pthread_attr_setstacksize ()
  66 can fail with the following error:
  67 .TP
  68 .B EINVAL
  69 The stack size is less than
  70 .BR PTHREAD_STACK_MIN
  71 (16384) bytes.
  72 .PP
  73 On some systems,
  74 .\" e.g., MacOS
  75 .BR pthread_attr_setstacksize ()
  76 can fail with the error
  77 .B EINVAL
  78 if
  79 .I stacksize
  80 is not a multiple of the system page size.
  81 .SH VERSIONS
  82 These functions are provided by glibc since version 2.1.
  83 .SH ATTRIBUTES
  84 For an explanation of the terms used in this section, see
  85 .BR attributes (7).
  86 .ad l
  87 .nh
  88 .TS
  89 allbox;
  90 lbx lb lb
  91 l l l.
  92 Interface       Attribute       Value
  93 T{
  94 .BR pthread_attr_setstacksize (),
  95 .BR pthread_attr_getstacksize ()
  96 T}      Thread safety   MT-Safe
  97 .TE
  98 .hy
  99 .ad
 100 .sp 1
 101 .SH CONFORMING TO
 102 POSIX.1-2001, POSIX.1-2008.
 103 .SH NOTES
 104 For details on the default stack size of new threads, see
 105 .BR pthread_create (3).
 106 .PP
 107 A thread's stack size is fixed at the time of thread creation.
 108 Only the main thread can dynamically grow its stack.
 109 .PP
 110 The
 111 .BR pthread_attr_setstack (3)
 112 function allows an application to set both the size and location
 113 of a caller-allocated stack that is to be used by a thread.
 114 .SH BUGS
 115 As at glibc 2.8,
 116 if the specified
 117 .I stacksize
 118 is not a multiple of
 119 .BR STACK_ALIGN
 120 (16 bytes on most architectures), it may be rounded
 121 .IR downward ,
 122 in violation of POSIX.1, which says that the allocated stack will
 123 be at least
 124 .I stacksize
 125 bytes.
 126 .SH EXAMPLES
 127 See
 128 .BR pthread_create (3).
 129 .SH SEE ALSO
 130 .BR getrlimit (2),
 131 .BR pthread_attr_init (3),
 132 .BR pthread_attr_setguardsize (3),
 133 .BR pthread_attr_setstack (3),
 134 .BR pthread_create (3),
 135 .BR pthreads (7)