pthread_attr_setstacksize(3) — Linux manual page

pthread_attr_setstacksize(3)ary Functions Manualead_attr_setstacksize(3)

NAME         top

       pthread_attr_setstacksize, pthread_attr_getstacksize - set/get
       stack size attribute in thread attributes object

LIBRARY         top

       POSIX threads library (libpthread, -lpthread)

SYNOPSIS         top

       #include <pthread.h>

       int pthread_attr_setstacksize(pthread_attr_t *attr, size_t stacksize);
       int pthread_attr_getstacksize(const pthread_attr_t *restrict attr,
                                     size_t *restrict stacksize);

DESCRIPTION         top

       The pthread_attr_setstacksize() function sets the stack size
       attribute of the thread attributes object referred to by attr to
       the value specified in stacksize.

       The stack size attribute determines the minimum size (in bytes)
       that will be allocated for threads created using the thread
       attributes object attr.

       The pthread_attr_getstacksize() function returns the stack size
       attribute of the thread attributes object referred to by attr in
       the buffer pointed to by stacksize.

RETURN VALUE         top

       On success, these functions return 0; on error, they return a
       nonzero error number.

ERRORS         top

       pthread_attr_setstacksize() can fail with the following error:

       EINVAL The stack size is less than PTHREAD_STACK_MIN (16384)
              bytes.

       On some systems, pthread_attr_setstacksize() can fail with the
       error EINVAL if stacksize is not a multiple of the system page
       size.

ATTRIBUTES         top

       For an explanation of the terms used in this section, see
       attributes(7).

       ┌──────────────────────────────────────┬───────────────┬─────────┐
       │Interface                             │ Attribute     │ Value   │
       ├──────────────────────────────────────┼───────────────┼─────────┤
       │pthread_attr_setstacksize(),          │ Thread safety │ MT-Safe │
       │pthread_attr_getstacksize()           │               │         │
       └──────────────────────────────────────┴───────────────┴─────────┘

VERSIONS         top

       These functions are provided since glibc 2.1.

STANDARDS         top

       POSIX.1-2001, POSIX.1-2008.

NOTES         top

       For details on the default stack size of new threads, see
       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 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.

BUGS         top

       As at glibc 2.8, if the specified stacksize is not a multiple of
       STACK_ALIGN (16 bytes on most architectures), it may be rounded
       downward, in violation of POSIX.1, which says that the allocated
       stack will be at least stacksize bytes.

EXAMPLES         top

       See pthread_create(3).

SEE ALSO         top

       getrlimit(2), pthread_attr_init(3), pthread_attr_setguardsize(3),
       pthread_attr_setstack(3), pthread_create(3), pthreads(7)

Linux man-pages 6.04           2023-03-17   pthread_attr_setstacksize(3)

Pages that refer to this page: pthread_attr_init(3),  pthread_attr_setguardsize(3),  pthread_attr_setstack(3),  pthread_attr_setstackaddr(3),  pthread_create(3),  pthread_getattr_default_np(3),  pthread_getattr_np(3)

HTML rendering created 2023-06-24 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH.