usr/src/man/man3c/pthread_getconcurrency.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_GETCONCURRENCY 3C "Mar 23, 2005"
  13 .SH NAME
  14 pthread_getconcurrency, pthread_setconcurrency \- get or set level of
  15 concurrency
  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_getconcurrency\fR(\fBvoid\fR);
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fBint\fR \fBpthread_setconcurrency\fR(\fBint\fR \fInew_level\fR);
  28 .fi
  29
  30 .SH DESCRIPTION
  31 .sp
  32 .LP
  33 Unbound threads in a process may or may not be required to be simultaneously
  34 active. By default, the threads implementation ensures that a sufficient number
  35 of threads are active so that the process can continue to make progress. While
  36 this conserves system resources, it may not produce the most effective level of
  37 concurrency.
  38 .sp
  39 .LP
  40 The  \fBpthread_setconcurrency()\fR function allows an application to inform
  41 the threads implementation of its desired concurrency level, \fInew_level\fR.
  42 The actual level of concurrency provided by the implementation as a result of
  43 this function call is unspecified.
  44 .sp
  45 .LP
  46 If \fInew_level\fR is  \fB0\fR, it causes the implementation to maintain the
  47 concurrency level at its discretion as if \fBpthread_setconcurrency()\fR was
  48 never called.
  49 .sp
  50 .LP
  51 The  \fBpthread_getconcurrency()\fR function returns the  value set by a
  52 previous call to the  \fBpthread_setconcurrency()\fR function. If the
  53 \fBpthread_setconcurrency()\fR function was not previously called, this
  54 function returns  \fB0\fR to indicate that the implementation is maintaining
  55 the concurrency level.
  56 .sp
  57 .LP
  58 When an application calls  \fBpthread_setconcurrency()\fR it is informing the
  59 implementation of its desired concurrency level. The implementation uses this
  60 as a hint, not a requirement.
  61 .sp
  62 .LP
  63 If an implementation does not support multiplexing of user threads on top of
  64 several kernel scheduled entities, the  \fBpthread_setconcurrency()\fR and
  65 \fBpthread_getconcurrency()\fR functions will be provided for source code
  66 compatibility but they will have no effect when called. To maintain the
  67 function semantics, the \fInew_level\fR parameter will be saved when
  68 \fBpthread_setconcurrency()\fR is called so that a subsequent call to
  69 \fBpthread_getconcurrency()\fR returns the same value.
  70 .SH RETURN VALUES
  71 .sp
  72 .LP
  73 If successful, the  \fBpthread_setconcurrency()\fR function returns  \fB0\fR.
  74 Otherwise, an error number is returned to indicate the error.
  75 .sp
  76 .LP
  77 The  \fBpthread_getconcurrency()\fR function always returns the concurrency
  78 level set by a previous call to  \fBpthread_setconcurrency()\fR. If the
  79 \fBpthread_setconcurrency()\fR function has never been called,
  80 \fBpthread_getconcurrency()\fR returns  \fB0\fR.
  81 .SH ERRORS
  82 .sp
  83 .LP
  84 The \fBpthread_setconcurrency()\fR function will fail if:
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fBEINVAL\fR\fR
  89 .ad
  90 .RS 10n
  91 The value specified by \fInew_level\fR is negative.
  92 .RE
  93
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fBEAGAIN\fR\fR
  98 .ad
  99 .RS 10n
 100 The value specific by \fInew_level\fR would cause a system resource to be
 101 exceeded.
 102 .RE
 103
 104 .SH ATTRIBUTES
 105 .sp
 106 .LP
 107 See \fBattributes\fR(5) for descriptions of the following attributes:
 108 .sp
 109
 110 .sp
 111 .TS
 112 box;
 113 c | c
 114 l | l .
 115 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 116 _
 117 Interface Stability     Standard
 118 _
 119 MT-Level        MT-Safe
 120 .TE
 121
 122 .SH SEE ALSO
 123 .sp
 124 .LP
 125 \fBpthread_create\fR(3C), \fBpthread_attr_init\fR(3C), \fBattributes\fR(5),
 126 \fBstandards\fR(5)