Manpage of PTHREAD_ATTR_SETSTACK

PTHREAD_ATTR_SETSTACK

Section: Linux Programmer's Manual (3)
Updated: 2016-03-15
Index
 

NAME

pthread_attr_setstack, pthread_attr_getstack - set/get stack attributes in thread attributes object  

SYNOPSIS

#include <pthread.h>int pthread_attr_setstack(pthread_attr_t *attr,                          void *stackaddr, size_t stacksize);int pthread_attr_getstack(const pthread_attr_t *attr,                          void **stackaddr, size_t *stacksize);Compile and link with -pthread.

Feature Test Macro Requirements for glibc (see feature_test_macros(7)):

pthread_attr_getstack(), pthread_attr_setstack():

_POSIX_C_SOURCE >= 200112L
 

DESCRIPTION

The pthread_attr_setstack() function sets the stack address and stack size attributes of the thread attributes object referred to by attrto the values specified in stackaddrand stacksize, respectively. These attributes specify the location and size of the stack that should be used by a thread that is created using the thread attributes object attr.

stackaddrshould point to the lowest addressable byte of a buffer of stacksizebytes that was allocated by the caller. The pages of the allocated buffer should be both readable and writable.

The pthread_attr_getstack() function returns the stack address and stack size attributes of the thread attributes object referred to by attrin the buffers pointed to by stackaddrand stacksize, respectively.  

RETURN VALUE

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

ERRORS

pthread_attr_setstack() can fail with the following error:
EINVAL
stacksizeis less than PTHREAD_STACK_MIN(16384) bytes. On some systems, this error may also occur if stackaddror stackaddr + stacksizeis not suitably aligned.

POSIX.1 also documents an EACCESerror if the stack area described by stackaddrand stacksizeis not both readable and writable by the caller.  

VERSIONS

These functions are provided by glibc since version 2.2.  

ATTRIBUTES

For an explanation of the terms used in this section, see attributes(7).
InterfaceAttributeValue
pthread_attr_setstack(), pthread_attr_getstack() Thread safetyMT-Safe
 

CONFORMING TO

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

NOTES

These functions are provided for applications that must ensure that a thread's stack is placed in a particular location. For most applications, this is not necessary, and the use of these functions should be avoided. (Use pthread_attr_setstacksize(3) if an application simply requires a stack size other than the default.)

When an application employs pthread_attr_setstack(), it takes over the responsibility of allocating the stack. Any guard size value that was set using pthread_attr_setguardsize(3) is ignored. If deemed necessary, it is the application's responsibility to allocate a guard area (one or more pages protected against reading and writing) to handle the possibility of stack overflow.

The address specified in stackaddrshould be suitably aligned: for full portability, align it on a page boundary (sysconf(_SC_PAGESIZE)). posix_memalign(3) may be useful for allocation. Probably, stacksizeshould also be a multiple of the system page size.

If attris used to create multiple threads, then the caller must change the stack address attribute between calls to pthread_create(3); otherwise, the threads will attempt to use the same memory area for their stacks, and chaos will ensue.  

EXAMPLE

See pthread_attr_init(3).  

SEE ALSO

mmap(2), mprotect(2), posix_memalign(3), pthread_attr_init(3), pthread_attr_setguardsize(3), pthread_attr_setstackaddr(3), pthread_attr_setstacksize(3), pthread_create(3), pthreads(7)


 

Index

NAME
SYNOPSIS
DESCRIPTION
RETURN VALUE
ERRORS
VERSIONS
ATTRIBUTES
CONFORMING TO
NOTES
EXAMPLE
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 16:30:25 GMT, October 09, 2016 Click Here!