man3/pthread_attr_setguardsize.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_SETGUARDSIZE 3 2021-03-22 "Linux" "Linux Programmer's Manual"
  27 .SH NAME
  28 pthread_attr_setguardsize, pthread_attr_getguardsize \- set/get guard size
  29 attribute in thread attributes object
  30 .SH SYNOPSIS
  31 .nf
  32 .B #include <pthread.h>
  33 .PP
  34 .BI "int pthread_attr_setguardsize(pthread_attr_t *" attr \
  35 ", size_t " guardsize );
  36 .BI "int pthread_attr_getguardsize(const pthread_attr_t *restrict " attr ,
  37 .BI "                              size_t *restrict " guardsize );
  38 .PP
  39 Compile and link with \fI\-pthread\fP.
  40 .fi
  41 .SH DESCRIPTION
  42 The
  43 .BR pthread_attr_setguardsize ()
  44 function sets the guard size attribute of the
  45 thread attributes object referred to by
  46 .I attr
  47 to the value specified in
  48 .IR guardsize .
  49 .PP
  50 If
  51 .I guardsize
  52 is greater than 0,
  53 then for each new thread created using
  54 .I attr
  55 the system allocates an additional region of at least
  56 .I guardsize
  57 bytes at the end of the thread's stack to act as the guard area
  58 for the stack (but see BUGS).
  59 .PP
  60 If
  61 .I guardsize
  62 is 0, then new threads created with
  63 .I attr
  64 will not have a guard area.
  65 .PP
  66 The default guard size is the same as the system page size.
  67 .PP
  68 If the stack address attribute has been set in
  69 .I attr
  70 (using
  71 .BR pthread_attr_setstack (3)
  72 or
  73 .BR pthread_attr_setstackaddr (3)),
  74 meaning that the caller is allocating the thread's stack,
  75 then the guard size attribute is ignored
  76 (i.e., no guard area is created by the system):
  77 it is the application's responsibility to handle stack overflow
  78 (perhaps by using
  79 .BR mprotect (2)
  80 to manually define a guard area at the end of the stack
  81 that it has allocated).
  82 .PP
  83 The
  84 .BR pthread_attr_getguardsize ()
  85 function returns the guard size attribute of the
  86 thread attributes object referred to by
  87 .I attr
  88 in the buffer pointed to by
  89 .IR guardsize .
  90 .SH RETURN VALUE
  91 On success, these functions return 0;
  92 on error, they return a nonzero error number.
  93 .SH ERRORS
  94 POSIX.1 documents an
  95 .B EINVAL
  96 error if
  97 .I attr
  98 or
  99 .I guardsize
 100 is invalid.
 101 On Linux these functions always succeed
 102 (but portable and future-proof applications should nevertheless
 103 handle a possible error return).
 104 .SH VERSIONS
 105 These functions are provided by glibc since version 2.1.
 106 .SH ATTRIBUTES
 107 For an explanation of the terms used in this section, see
 108 .BR attributes (7).
 109 .ad l
 110 .nh
 111 .TS
 112 allbox;
 113 lbx lb lb
 114 l l l.
 115 Interface       Attribute       Value
 116 T{
 117 .BR pthread_attr_setguardsize (),
 118 .BR pthread_attr_getguardsize ()
 119 T}      Thread safety   MT-Safe
 120 .TE
 121 .hy
 122 .ad
 123 .sp 1
 124 .SH CONFORMING TO
 125 POSIX.1-2001, POSIX.1-2008.
 126 .SH NOTES
 127 A guard area consists of virtual memory pages that are protected
 128 to prevent read and write access.
 129 If a thread overflows its stack into the guard area,
 130 then, on most hard architectures, it receives a
 131 .B SIGSEGV
 132 signal, thus notifying it of the overflow.
 133 Guard areas start on page boundaries,
 134 and the guard size is internally rounded up to
 135 the system page size when creating a thread.
 136 (Nevertheless,
 137 .BR pthread_attr_getguardsize ()
 138 returns the guard size that was set by
 139 .BR pthread_attr_setguardsize ().)
 140 .PP
 141 Setting a guard size of 0 may be useful to save memory
 142 in an application that creates many threads
 143 and knows that stack overflow can never occur.
 144 .PP
 145 Choosing a guard size larger than the default size
 146 may be necessary for detecting stack overflows
 147 if a thread allocates large data structures on the stack.
 148 .SH BUGS
 149 As at glibc 2.8, the NPTL threading implementation includes
 150 the guard area within the stack size allocation,
 151 rather than allocating extra space at the end of the stack,
 152 as POSIX.1 requires.
 153 (This can result in an
 154 .B EINVAL
 155 error from
 156 .BR pthread_create (3)
 157 if the guard size value is too large,
 158 leaving no space for the actual stack.)
 159 .PP
 160 The obsolete LinuxThreads implementation did the right thing,
 161 allocating extra space at the end of the stack for the guard area.
 162 .\" glibc includes the guardsize within the allocated stack size,
 163 .\" which looks pretty clearly to be in violation of POSIX.
 164 .\"
 165 .\" Filed bug, 22 Oct 2008:
 166 .\" http://sources.redhat.com/bugzilla/show_bug.cgi?id=6973
 167 .\"
 168 .\" Older reports:
 169 .\" https//bugzilla.redhat.com/show_bug.cgi?id=435337
 170 .\" Reportedly, LinuxThreads did the right thing, allocating
 171 .\" extra space at the end of the stack:
 172 .\" http://sourceware.org/ml/libc-alpha/2008-05/msg00086.html
 173 .SH EXAMPLES
 174 See
 175 .BR pthread_getattr_np (3).
 176 .SH SEE ALSO
 177 .BR mmap (2),
 178 .BR mprotect (2),
 179 .BR pthread_attr_init (3),
 180 .BR pthread_attr_setstack (3),
 181 .BR pthread_attr_setstacksize (3),
 182 .BR pthread_create (3),
 183 .BR pthreads (7)