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

   1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" Copyright (c) 2001, the Institute of Electrical and Electronics Engineers, Inc. and The Open Group. All Rights Reserved.
   4 .\" Copyright 1991, 1992, 1994, The X/Open Company Ltd.
   5 .\" 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
   6 .\" http://www.opengroup.org/bookstore/.
   7 .\" 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 Sun OS 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.
   8 .\"  This notice shall appear on any product containing this material.
   9 .\" 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.
  10 .\" 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.
  11 .\" 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]
  12 .TH PTHREAD_ATTR_GETSTACKSIZE 3C "Mar 23, 2005"
  13 .SH NAME
  14 pthread_attr_getstacksize, pthread_attr_setstacksize \- get or set stacksize
  15 attribute
  16 .SH SYNOPSIS
  17 .LP
  18 .nf
  19 cc -mt [ \fIflag\fR... ] \fIfile\fR... -lpthread [ \fIlibrary\fR... ]
  20 #include <pthread.h>
  21
  22 \fBint\fR \fBpthread_attr_getstacksize\fR(\fBconst pthread_attr_t *restrict\fR \fIattr\fR,
  23      \fBsize_t *restrict\fR \fIstacksize\fR);
  24 .fi
  25
  26 .LP
  27 .nf
  28 \fBint\fR \fBpthread_attr_setstacksize\fR(\fBpthread_attr_t *\fR\fIattr\fR, \fBsize_t\fR \fIstacksize\fR);
  29 .fi
  30
  31 .SH DESCRIPTION
  32 .sp
  33 .LP
  34 The functions \fBpthread_attr_setstacksize()\fR and
  35 \fBpthread_attr_getstacksize()\fR, respectively, set and get the thread
  36 creation \fIstacksize\fR attribute in the \fIattr\fR object.
  37 .sp
  38 .LP
  39 The \fIstacksize\fR attribute defines the minimum stack size (in bytes)
  40 allocated for the created threads stack. When the \fIstacksize\fR argument is
  41 \fINULL\fR, the default stack size becomes \fB1\fR megabyte for 32-bit
  42 processes and  \fB2\fR megabytes for 64-bit processes.
  43 .SH RETURN VALUES
  44 .sp
  45 .LP
  46 Upon successful completion, \fBpthread_attr_setstacksize()\fR and
  47 \fBpthread_attr_getstacksize()\fR return a value of  \fB0\fR. Otherwise, an
  48 error number is returned to indicate the error. The
  49 \fBpthread_attr_getstacksize()\fR function stores the \fIstacksize\fR attribute
  50 value in \fIstacksize\fR if successful.
  51 .SH ERRORS
  52 .sp
  53 .LP
  54 The \fBpthread_attr_setstacksize()\fR or \fBpthread_attr_getstacksize()\fR
  55 function may fail if:
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fBEINVAL\fR\fR
  60 .ad
  61 .RS 10n
  62 \fIattr\fR or \fIstacksize\fR is invalid.
  63 .RE
  64
  65 .SH ATTRIBUTES
  66 .sp
  67 .LP
  68 See \fBattributes\fR(5) for descriptions of the following attributes:
  69 .sp
  70
  71 .sp
  72 .TS
  73 box;
  74 c | c
  75 l | l .
  76 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  77 _
  78 Interface Stability     Standard
  79 _
  80 MT-Level        MT-Safe
  81 .TE
  82
  83 .SH SEE ALSO
  84 .sp
  85 .LP
  86 \fBpthread_attr_init\fR(3C), \fBpthread_attr_setstackaddr\fR(3C),
  87 \fBpthread_attr_setdetachstate\fR(3C), \fBpthread_create\fR(3C),
  88 \fBattributes\fR(5), \fBstandards\fR(5)