usr/src/man/man3c/pthread_attr_init.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.  All Rights Reserved.
   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_INIT 3C "Dec 10, 2015"
  13 .SH NAME
  14 pthread_attr_init, pthread_attr_destroy \- initialize or destroy threads
  15 attribute object
  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_init\fR(\fBpthread_attr_t *\fR\fIattr\fR);
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fBint\fR \fBpthread_attr_destroy\fR(\fBpthread_attr_t *\fR\fIattr\fR);
  28 .fi
  29
  30 .SH DESCRIPTION
  31 .LP
  32 The function \fBpthread_attr_init()\fR initializes a thread attributes object
  33 \fIattr\fR with the default value for all of the individual attributes used by
  34 a given implementation.
  35 .sp
  36 .LP
  37 The resulting attribute object (possibly modified by setting individual
  38 attribute values), when used by \fBpthread_create()\fR, defines the attributes
  39 of the thread created. A single attributes object can be used in multiple
  40 simultaneous calls to \fBpthread_create()\fR.
  41 .sp
  42 .LP
  43 The \fBpthread_attr_init()\fR function initializes a thread attributes object (
  44 \fIattr\fR) with the default value for each attribute as follows:
  45 .sp
  46
  47 .sp
  48 .TS
  49 c c c
  50 l l l .
  51 Attribute       Default Value   Meaning of Default
  52 _
  53 \fIcontentionscope\fR   \fBPTHREAD_SCOPE_PROCESS\fR     resource competition within process
  54 \fIdetachstate\fR       \fBPTHREAD_CREATE_JOINABLE\fR   joinable by other threads
  55 \fIstackaddr\fR \fBNULL\fR      stack allocated by system
  56 \fIstacksize\fR 0       1 or 2 megabyte
  57 \fIpriority\fR  0       priority of the thread
  58 \fIpolicy\fR    \fBSCHED_OTHER\fR       traditional time-sharing policy
  59 \fIinheritsched\fR      \fBPTHREAD_INHERIT_SCHED\fR     T{
  60 scheduling policy and parameters are inherited from the creating thread
  61 T}
  62 \fIguardsize\fR \fBPAGESIZE\fR  T{
  63 size of guard area for a thread's created stack
  64 T}
  65 .TE
  66
  67 .sp
  68 .LP
  69 The \fBpthread_attr_destroy()\fR function destroys a thread attributes object (
  70 \fIattr\fR), which cannot be reused until it is reinitialized. An
  71 implementation may cause \fBpthread_attr_destroy()\fR to set \fIattr\fR to an
  72 implementation-dependent invalid value. The behavior of using the attribute
  73 after it has been destroyed is undefined.
  74 .SH RETURN VALUES
  75 .LP
  76 Upon successful completion, \fBpthread_attr_init()\fR and
  77 \fBpthread_attr_destroy()\fR return a value of  \fB0\fR. Otherwise, an error
  78 number is returned to indicate the error.
  79 .SH ERRORS
  80 .LP
  81 The  \fBpthread_attr_init()\fR function will fail if:
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fBENOMEM\fR\fR
  86 .ad
  87 .RS 10n
  88 Insufficient memory exists to initialize the thread attributes object.
  89 .RE
  90
  91 .sp
  92 .LP
  93 The  \fBpthread_attr_destroy()\fR function may fail if:
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fBEINVAL\fR\fR
  98 .ad
  99 .RS 10n
 100 \fIattr\fR is invalid.
 101 .RE
 102
 103 .SH ATTRIBUTES
 104 .LP
 105 See \fBattributes\fR(5) for descriptions of the following attributes:
 106 .sp
 107
 108 .sp
 109 .TS
 110 box;
 111 c | c
 112 l | l .
 113 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 114 _
 115 Interface Stability     Committed
 116 _
 117 MT-Level        MT-Safe
 118 _
 119 Standard        See \fBstandards\fR(5).
 120 .TE
 121
 122 .SH SEE ALSO
 123 .LP
 124 \fBsysconf\fR(3C), \fBpthread_attr_getdetachstate\fR(3C),
 125 \fBpthread_attr_get_np\fR(3C),
 126 \fBpthread_attr_getguardsize\fR(3C), \fBpthread_attr_getinheritsched\fR(3C),
 127 \fBpthread_attr_getschedparam\fR(3C), \fBpthread_attr_getschedpolicy\fR(3C),
 128 \fBpthread_attr_getscope\fR(3C), \fBpthread_attr_getstackaddr\fR(3C),
 129 \fBpthread_attr_getstacksize\fR(3C), \fBpthread_attr_setdetachstate\fR(3C),
 130 \fBpthread_attr_setguardsize\fR(3C), \fBpthread_attr_setinheritsched\fR(3C),
 131 \fBpthread_attr_setschedparam\fR(3C), \fBpthread_attr_setschedpolicy\fR(3C),
 132 \fBpthread_attr_setscope\fR(3C), \fBpthread_attr_setstackaddr\fR(3C),
 133 \fBpthread_attr_setstacksize\fR(3C), \fBpthread_create\fR(3C),
 134 \fBattributes\fR(5), \fBstandards\fR(5)