share/man/man3c/pthread_attr_getstackaddr.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 1991, 1992, 1994, The X/Open Company Ltd.
  44 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  45 .\" Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved.
  46 .\"
  47 .TH PTHREAD_ATTR_GETSTACKADDR 3C "Mar 23, 2005"
  48 .SH NAME
  49 pthread_attr_getstackaddr, pthread_attr_setstackaddr \- get or set stackaddr
  50 attribute
  51 .SH SYNOPSIS
  52 .LP
  53 .nf
  54 cc -mt [ \fIflag\fR... ] \fIfile\fR... -lpthread [ \fIlibrary\fR... ]
  55 #include <pthread.h>
  56
  57 \fBint\fR \fBpthread_attr_getstackaddr\fR(\fBconst pthread_attr_t *restrict\fR \fIattr\fR,
  58      \fBvoid **restrict\fR \fIstackaddr\fR);
  59 .fi
  60
  61 .LP
  62 .nf
  63 \fBint\fR \fBpthread_attr_setstackaddr\fR(\fBpthread_attr_t *\fR\fIattr\fR, \fBvoid *\fR\fIstackaddr\fR);
  64 .fi
  65
  66 .SH DESCRIPTION
  67 .sp
  68 .LP
  69 The functions \fBpthread_attr_setstackaddr()\fR and
  70 \fBpthread_attr_getstackaddr()\fR, respectively, set and get the thread
  71 creation \fIstackaddr\fR attribute in the \fIattr\fR object. The
  72 \fIstackaddr\fR default is \fINULL\fR. See \fBpthread_create\fR(3C).
  73 .sp
  74 .LP
  75 The \fIstackaddr\fR attribute specifies the location of storage to be used for
  76 the created thread's stack. The size of the storage is at least
  77 \fBPTHREAD_STACK_MIN.\fR
  78 .SH RETURN VALUES
  79 .sp
  80 .LP
  81 Upon successful completion, \fBpthread_attr_setstackaddr()\fR and
  82 \fBpthread_attr_getstackaddr()\fR return a value of  \fB0\fR. Otherwise, an
  83 error number is returned to indicate the error.
  84 .sp
  85 .LP
  86 If successful, the \fBpthread_attr_getstackaddr()\fR function stores the
  87 \fIstackaddr\fR attribute value in \fIstackaddr\fR.
  88 .SH ERRORS
  89 .sp
  90 .LP
  91 The \fBpthread_attr_setstackaddr()\fR function may fail if:
  92 .sp
  93 .ne 2
  94 .na
  95 \fB\fBEINVAL\fR\fR
  96 .ad
  97 .RS 10n
  98 \fIattr\fR is invalid.
  99 .RE
 100
 101 .sp
 102 .LP
 103 The  \fBpthread_attr_getstackaddr()\fR function may fail if:
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fBEINVAL\fR\fR
 108 .ad
 109 .RS 10n
 110 \fIattr\fR or \fIstackaddr\fR is invalid.
 111 .RE
 112
 113 .SH ATTRIBUTES
 114 .sp
 115 .LP
 116 See \fBattributes\fR(5) for descriptions of the following attributes:
 117 .sp
 118
 119 .sp
 120 .TS
 121 box;
 122 c | c
 123 l | l .
 124 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 125 _
 126 Interface Stability     Standard
 127 _
 128 MT-Level        MT-Safe
 129 .TE
 130
 131 .SH SEE ALSO
 132 .sp
 133 .LP
 134 \fBpthread_attr_init\fR(3C), \fBpthread_attr_setdetachstate\fR(3C),
 135 \fBpthread_attr_setstacksize\fR(3C), \fBpthread_create\fR(3C),
 136 \fBattributes\fR(5), \fBstandards\fR(5)