lib/libc/gen/sysconf.3

   1 .\" Copyright (c) 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)sysconf.3   8.3 (Berkeley) 4/19/94
  33 .\" $FreeBSD: src/lib/libc/gen/sysconf.3,v 1.8.2.6 2001/12/14 18:33:51 ru Exp $
  34 .\" $DragonFly: src/lib/libc/gen/sysconf.3,v 1.7 2008/05/02 02:05:03 swildner Exp $
  35 .\"
  36 .Dd February 21, 2008
  37 .Dt SYSCONF 3
  38 .Os
  39 .Sh NAME
  40 .Nm sysconf
  41 .Nd get configurable system variables
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In unistd.h
  46 .Ft long
  47 .Fn sysconf "int name"
  48 .Sh DESCRIPTION
  49 This interface is defined by
  50 .St -p1003.1-88 .
  51 A far more complete interface is available using
  52 .Xr sysctl 3 .
  53 .Pp
  54 The
  55 .Fn sysconf
  56 function provides a method for applications to determine the current
  57 value of a configurable system limit or option variable.
  58 The
  59 .Fa name
  60 argument specifies the system variable to be queried.
  61 Symbolic constants for each name value are found in the include file
  62 .In unistd.h .
  63 .Pp
  64 The available values are as follows:
  65 .Bl -tag -width 6n
  66 .It Li _SC_ARG_MAX
  67 The maximum bytes of argument to
  68 .Xr execve 2 .
  69 .It Li _SC_CHILD_MAX
  70 The maximum number of simultaneous processes per user id.
  71 .It Li _SC_CLK_TCK
  72 The frequency of the statistics clock in ticks per second.
  73 .It Li _SC_IOV_MAX
  74 The maximum number of elements in the I/O vector used by
  75 .Xr readv 2 ,
  76 .Xr writev 2 ,
  77 .Xr recvmsg 2 ,
  78 and
  79 .Xr sendmsg 2 .
  80 .It Li _SC_NGROUPS_MAX
  81 The maximum number of supplemental groups.
  82 .It Li _SC_OPEN_MAX
  83 The maximum number of open files per user id.
  84 .It Li _SC_STREAM_MAX
  85 The minimum maximum number of streams that a process may have open
  86 at any one time.
  87 .It Li _SC_TZNAME_MAX
  88 The minimum maximum number of types supported for the name of a
  89 timezone.
  90 .It Li _SC_JOB_CONTROL
  91 Return 1 if job control is available on this system, otherwise \-1.
  92 .It Li _SC_SAVED_IDS
  93 Returns 1 if saved set-group and saved set-user ID is available,
  94 otherwise \-1.
  95 .It Li _SC_VERSION
  96 The version of
  97 .St -p1003.1
  98 with which the system
  99 attempts to comply.
 100 .It Li _SC_BC_BASE_MAX
 101 The maximum ibase/obase values in the
 102 .Xr bc 1
 103 utility.
 104 .It Li _SC_BC_DIM_MAX
 105 The maximum array size in the
 106 .Xr bc 1
 107 utility.
 108 .It Li _SC_BC_SCALE_MAX
 109 The maximum scale value in the
 110 .Xr bc 1
 111 utility.
 112 .It Li _SC_BC_STRING_MAX
 113 The maximum string length in the
 114 .Xr bc 1
 115 utility.
 116 .It Li _SC_COLL_WEIGHTS_MAX
 117 The maximum number of weights that can be assigned to any entry of
 118 the LC_COLLATE order keyword in the locale definition file.
 119 .It Li _SC_EXPR_NEST_MAX
 120 The maximum number of expressions that can be nested within
 121 parenthesis by the
 122 .Xr expr 1
 123 utility.
 124 .It Li _SC_LINE_MAX
 125 The maximum length in bytes of a text-processing utility's input
 126 line.
 127 .It Li _SC_RE_DUP_MAX
 128 The maximum number of repeated occurrences of a regular expression
 129 permitted when using interval notation.
 130 .It Li _SC_2_VERSION
 131 The version of
 132 .St -p1003.2
 133 with which the system attempts to comply.
 134 .It Li _SC_2_C_BIND
 135 Return 1 if the system's C-language development facilities support the
 136 C-Language Bindings Option, otherwise \-1.
 137 .It Li _SC_2_C_DEV
 138 Return 1 if the system supports the C-Language Development Utilities Option,
 139 otherwise \-1.
 140 .It Li _SC_2_CHAR_TERM
 141 Return 1 if the system supports at least one terminal type capable of
 142 all operations described in
 143 .St -p1003.2 ,
 144 otherwise \-1.
 145 .It Li _SC_2_FORT_DEV
 146 Return 1 if the system supports the FORTRAN Development Utilities Option,
 147 otherwise \-1.
 148 .It Li _SC_2_FORT_RUN
 149 Return 1 if the system supports the FORTRAN Runtime Utilities Option,
 150 otherwise \-1.
 151 .It Li _SC_2_LOCALEDEF
 152 Return 1 if the system supports the creation of locales, otherwise \-1.
 153 .It Li _SC_2_SW_DEV
 154 Return 1 if the system supports the Software Development Utilities Option,
 155 otherwise \-1.
 156 .It Li _SC_2_UPE
 157 Return 1 if the system supports the User Portability Utilities Option,
 158 otherwise \-1.
 159 .It Li _SC_PAGESIZE
 160 The size of a system page in bytes.
 161 .It Li _SC_NPROCESSORS_CONF
 162 The number of processors configured.
 163 .It Li _SC_NPROCESSORS_ONLN
 164 The number of processors online.
 165 .El
 166 .Sh RETURN VALUES
 167 If the call to
 168 .Fn sysconf
 169 is not successful, \-1 is returned and
 170 .Va errno
 171 is set appropriately.
 172 Otherwise, if the variable is associated with functionality that is not
 173 supported, \-1 is returned and
 174 .Va errno
 175 is not modified.
 176 Otherwise, the current variable value is returned.
 177 .Sh ERRORS
 178 The
 179 .Fn sysconf
 180 function may fail and set
 181 .Va errno
 182 for any of the errors specified for the library function
 183 .Xr sysctl 3 .
 184 In addition, the following error may be reported:
 185 .Bl -tag -width Er
 186 .It Bq Er EINVAL
 187 The value of the
 188 .Fa name
 189 argument is invalid.
 190 .El
 191 .Sh SEE ALSO
 192 .Xr sysctl 3
 193 .Sh STANDARDS
 194 Except for the fact that values returned by
 195 .Fn sysconf
 196 may change over the lifetime of the calling process,
 197 this function conforms to
 198 .St -p1003.1-88 .
 199 .Pp
 200 _SC_NPROCESSORS_CONF and _SC_NPROCESSORS_ONLN are nonstandard, but implemented
 201 in many systems.
 202 .Sh HISTORY
 203 The
 204 .Fn sysconf
 205 function first appeared in
 206 .Bx 4.4 .
 207 .Sh BUGS
 208 The value for _SC_STREAM_MAX is a minimum maximum, and required to be
 209 the same as ANSI C's FOPEN_MAX, so the returned value is a ridiculously
 210 small and misleading number.