pthread_attr_setstacksize(3) — Linux manual page

pthread_...stacksize(3) Library Functions Manual pthread_...stacksize(3)

NAME

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

LIBRARY

       POSIX threads library (libpthread, -lpthread)

SYNOPSIS

       #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

       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

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

ERRORS

       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

       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

       These functions are provided since glibc 2.1.

STANDARDS

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

NOTES

       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

       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

       See pthread_create(3).

SEE ALSO

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

COLOPHON

       This page is part of the man-pages (Linux kernel and C library
       user-space interface documentation) project.  Information about
       the project can be found at 
       ⟨https://www.kernel.org/doc/man-pages/⟩.  If you have a bug report
       for this manual page, see
       ⟨https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/CONTRIBUTING⟩.
       This page was obtained from the tarball man-pages-6.9.1.tar.gz
       fetched from
       ⟨https://mirrors.edge.kernel.org/pub/linux/docs/man-pages/⟩ on
       2024-06-26.  If you discover any rendering problems in this HTML
       version of the page, or you believe there is a better or more up-
       to-date source for the page, or you have corrections or
       improvements to the information in this COLOPHON (which is not
       part of the original manual page), send a mail to
       man-pages@man7.org

Linux man-pages 6.9.1          2024-05-02        pthread_...stacksize(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)

---