xref: /illumos-gate/usr/src/man/man3c/pthread_attr_getstack.3c (revision bde334a8dbd66dfa70ce4d7fc9dcad6e1ae45fe4)

Sun Microsystems, Inc. gratefully acknowledges The Open Group for
permission to reproduce portions of its copyrighted documentation.
Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.

The Institute of Electrical and Electronics Engineers and The Open
Group, have given us permission to reprint portions of their
documentation.

In the following statement, the phrase ``this text'' refers to portions
of the system documentation.

Portions of this text are reprinted and reproduced in electronic form
in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
Standard for Information Technology -- Portable Operating System
Interface (POSIX), The Open Group Base Specifications Issue 6,
Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
Engineers, Inc and The Open Group. In the event of any discrepancy
between these versions and the original IEEE and The Open Group
Standard, the original IEEE and The Open Group Standard is the referee
document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html.

This notice shall appear on any product containing this material.

The contents of this file are subject to the terms of the
Common Development and Distribution License (the "License").
You may not use this file except in compliance with the License.

You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
or http://www.opensolaris.org/os/licensing.
See the License for the specific language governing permissions
and limitations under the License.

When distributing Covered Code, include this CDDL HEADER in each
file and include the License file at usr/src/OPENSOLARIS.LICENSE.
If applicable, add the following below this CDDL HEADER, with the
fields enclosed by brackets "[]" replaced with your own identifying
information: Portions Copyright [yyyy] [name of copyright owner]


Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved.
Portions Copyright (c) 2005, Sun Microsystems, Inc. All Rights Reserved.

PTHREAD_ATTR_GETSTACK 3C "Mar 23, 2005"
NAME
pthread_attr_getstack, pthread_attr_setstack - get or set stack attributes
SYNOPSIS

cc -mt [ flag.\|.\|. ] file.\|.\|. -lpthread [ library.\|.\|. ]
#include <pthread.h>

int pthread_attr_getstack(const pthread_attr_t *restrict attr,
 void **restrict stackaddr, size_t *restrict stacksize);

int pthread_attr_setstack(pthread_attr_t * attr, void *stackaddr,
 size_t stacksize);
DESCRIPTION

The pthread_attr_getstack() and pthread_attr_setstack() functions, respectively, get and set the thread creation stack attributes stackaddr and stacksize in the attr object.

The stack attributes specify the area of storage to be used for the created thread's stack. The base (lowest addressable byte) of the storage is stackaddr, and the size of the storage is stacksize bytes. The stacksize argument must be at least {PTHREAD_STACK_MIN}. The stackaddr argument must be aligned appropriately to be used as a stack; for example, pthread_attr_setstack() might fail with EINVAL if (stackaddr & 0x7) is not 0. All pages within the stack described by stackaddr and stacksize are both readable and writable by the thread.

RETURN VALUES

Upon successful completion, these functions return a 0; otherwise, an error number is returned to indicate the error.

The pthread_attr_getstack() function stores the stack attribute values in stackaddr and stacksize if successful.

ERRORS

The pthread_attr_setstack() function will fail if: EINVAL

The value of stacksize is less than {PTHREAD_STACK_MIN}.

The pthread_attr_setstack() function may fail if: EACCES

The stack page(s) described by stackaddr and stacksize are not both readable and writable by the thread.

EINVAL

The value of stackaddr does not have proper alignment to be used as a stack, or (stackaddr + stacksize) lacks proper alignment.

USAGE

These functions are appropriate for use by applications in an environment where the stack for a thread must be placed in some particular region of memory.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
MT-Level Async-Signal-Safe
SEE ALSO

pthread_attr_init(3C), pthread_attr_setdetachstate(3C), pthread_attr_setstacksize(3C), pthread_create(3C), attributes(5)