usr/src/man/man3c/pthread_attr_getstack.3c

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  44 .\" Portions Copyright (c) 2005, Sun Microsystems, Inc. All Rights Reserved.
  45 .\"
  46 .TH PTHREAD_ATTR_GETSTACK 3C "Mar 23, 2005"
  47 .SH NAME
  48 pthread_attr_getstack, pthread_attr_setstack \- get or set stack attributes
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 cc \fB-mt\fR  [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lpthread\fR [ \fIlibrary\fR\&.\|.\|. ]
  53 #include <pthread.h>
  54
  55 \fBint\fR \fBpthread_attr_getstack\fR(\fBconst pthread_attr_t *restrict\fR \fIattr\fR,
  56      \fBvoid **restrict\fR \fIstackaddr\fR, \fBsize_t *restrict\fR \fIstacksize\fR);
  57 .fi
  58
  59 .LP
  60 .nf
  61 \fBint\fR \fBpthread_attr_setstack\fR(\fBpthread_attr_t *\fR \fIattr\fR, \fBvoid *\fR\fIstackaddr\fR,
  62      \fBsize_t\fR \fIstacksize\fR);
  63 .fi
  64
  65 .SH DESCRIPTION
  66 .sp
  67 .LP
  68 The \fBpthread_attr_getstack()\fR and \fBpthread_attr_setstack()\fR functions,
  69 respectively, get and set the thread creation stack attributes \fIstackaddr\fR
  70 and \fIstacksize\fR in the \fIattr\fR object.
  71 .sp
  72 .LP
  73 The stack attributes specify the area of storage to be used for the created
  74 thread's stack. The base (lowest addressable byte) of the storage is
  75 \fIstackaddr\fR, and the size of the storage is \fIstacksize\fR bytes. The
  76 \fIstacksize\fR argument must be at least {\fBPTHREAD_STACK_MIN\fR}. The
  77 \fIstackaddr\fR argument must be aligned appropriately to be used as a stack;
  78 for example, \fBpthread_attr_setstack()\fR might fail with \fBEINVAL\fR if
  79 (\fIstackaddr\fR & 0x7) is not 0. All pages within the stack described by
  80 \fIstackaddr\fR and \fIstacksize\fR are both readable and writable by the
  81 thread.
  82 .SH RETURN VALUES
  83 .sp
  84 .LP
  85 Upon successful completion, these functions return a 0; otherwise, an error
  86 number is returned to indicate the error.
  87 .sp
  88 .LP
  89 The \fBpthread_attr_getstack()\fR function stores the stack attribute values in
  90 stackaddr and stacksize if successful.
  91 .SH ERRORS
  92 .sp
  93 .LP
  94 The \fBpthread_attr_setstack()\fR function will fail if:
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fBEINVAL\fR\fR
  99 .ad
 100 .RS 10n
 101 The value of \fIstacksize\fR is less than {\fBPTHREAD_STACK_MIN\fR}.
 102 .RE
 103
 104 .sp
 105 .LP
 106 The \fBpthread_attr_setstack()\fR function may fail if:
 107 .sp
 108 .ne 2
 109 .na
 110 \fB\fBEACCES\fR\fR
 111 .ad
 112 .RS 10n
 113 The stack page(s) described by \fIstackaddr\fR and \fIstacksize\fR are not both
 114 readable and writable by the thread.
 115 .RE
 116
 117 .sp
 118 .ne 2
 119 .na
 120 \fB\fBEINVAL\fR\fR
 121 .ad
 122 .RS 10n
 123 The value of \fIstackaddr\fR does not have proper alignment to be used as a
 124 stack, or (\fIstackaddr\fR + \fIstacksize\fR) lacks proper alignment.
 125 .RE
 126
 127 .SH USAGE
 128 .sp
 129 .LP
 130 These functions are appropriate for use by applications in an environment where
 131 the stack for a thread must be placed in some particular region of memory.
 132 .SH ATTRIBUTES
 133 .sp
 134 .LP
 135 See \fBattributes\fR(5) for descriptions of the following attributes:
 136 .sp
 137
 138 .sp
 139 .TS
 140 box;
 141 c | c
 142 l | l .
 143 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 144 _
 145 Interface Stability     Standard
 146 _
 147 MT-Level        Async-Signal-Safe
 148 .TE
 149
 150 .SH SEE ALSO
 151 .sp
 152 .LP
 153 \fBpthread_attr_init\fR(3C), \fBpthread_attr_setdetachstate\fR(3C),
 154 \fBpthread_attr_setstacksize\fR(3C), \fBpthread_create\fR(3C),
 155 \fBattributes\fR(5)