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 .\" 4. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)sysconf.3   8.3 (Berkeley) 4/19/94
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd April 26, 2013
  32 .Dt SYSCONF 3
  33 .Os
  34 .Sh NAME
  35 .Nm sysconf
  36 .Nd get configurable system variables
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In unistd.h
  41 .Ft long
  42 .Fn sysconf "int name"
  43 .Sh DESCRIPTION
  44 This interface is defined by
  45 .St -p1003.1-88 .
  46 A far more complete interface is available using
  47 .Xr sysctl 3 .
  48 .Pp
  49 The
  50 .Fn sysconf
  51 function provides a method for applications to determine the current
  52 value of a configurable system limit or option variable.
  53 The
  54 .Fa name
  55 argument specifies the system variable to be queried.
  56 Symbolic constants for each name value are found in the include file
  57 .In unistd.h .
  58 Shell programmers who need access to these parameters should use the
  59 .Xr getconf 1
  60 utility.
  61 .Pp
  62 The available values are as follows:
  63 .Bl -tag -width 6n
  64 .It Li _SC_ARG_MAX
  65 The maximum bytes of argument to
  66 .Xr execve 2 .
  67 .It Li _SC_CHILD_MAX
  68 The maximum number of simultaneous processes per user id.
  69 .It Li _SC_CLK_TCK
  70 The frequency of the statistics clock in ticks per second.
  71 .It Li _SC_IOV_MAX
  72 The maximum number of elements in the I/O vector used by
  73 .Xr readv 2 ,
  74 .Xr writev 2 ,
  75 .Xr recvmsg 2 ,
  76 and
  77 .Xr sendmsg 2 .
  78 .It Li _SC_NGROUPS_MAX
  79 The maximum number of supplemental groups.
  80 .It Li _SC_NPROCESSORS_CONF
  81 The number of processors configured.
  82 .It Li _SC_NPROCESSORS_ONLN
  83 The number of processors currently online.
  84 .It Li _SC_OPEN_MAX
  85 One more than the maximum value the system may assign to a new file descriptor.
  86 .It Li _SC_PAGESIZE
  87 The size of a system page in bytes.
  88 .It Li _SC_PAGE_SIZE
  89 Equivalent to
  90 .Li _SC_PAGESIZE .
  91 .It Li _SC_STREAM_MAX
  92 The minimum maximum number of streams that a process may have open
  93 at any one time.
  94 .It Li _SC_TZNAME_MAX
  95 The minimum maximum number of types supported for the name of a
  96 timezone.
  97 .It Li _SC_JOB_CONTROL
  98 Return 1 if job control is available on this system, otherwise \-1.
  99 .It Li _SC_SAVED_IDS
 100 Returns 1 if saved set-group and saved set-user ID is available,
 101 otherwise \-1.
 102 .It Li _SC_VERSION
 103 The version of
 104 .St -p1003.1
 105 with which the system
 106 attempts to comply.
 107 .It Li _SC_BC_BASE_MAX
 108 The maximum ibase/obase values in the
 109 .Xr bc 1
 110 utility.
 111 .It Li _SC_BC_DIM_MAX
 112 The maximum array size in the
 113 .Xr bc 1
 114 utility.
 115 .It Li _SC_BC_SCALE_MAX
 116 The maximum scale value in the
 117 .Xr bc 1
 118 utility.
 119 .It Li _SC_BC_STRING_MAX
 120 The maximum string length in the
 121 .Xr bc 1
 122 utility.
 123 .It Li _SC_COLL_WEIGHTS_MAX
 124 The maximum number of weights that can be assigned to any entry of
 125 the LC_COLLATE order keyword in the locale definition file.
 126 .It Li _SC_EXPR_NEST_MAX
 127 The maximum number of expressions that can be nested within
 128 parenthesis by the
 129 .Xr expr 1
 130 utility.
 131 .It Li _SC_LINE_MAX
 132 The maximum length in bytes of a text-processing utility's input
 133 line.
 134 .It Li _SC_RE_DUP_MAX
 135 The maximum number of repeated occurrences of a regular expression
 136 permitted when using interval notation.
 137 .It Li _SC_2_VERSION
 138 The version of
 139 .St -p1003.2
 140 with which the system attempts to comply.
 141 .It Li _SC_2_C_BIND
 142 Return 1 if the system's C-language development facilities support the
 143 C-Language Bindings Option, otherwise \-1.
 144 .It Li _SC_2_C_DEV
 145 Return 1 if the system supports the C-Language Development Utilities Option,
 146 otherwise \-1.
 147 .It Li _SC_2_CHAR_TERM
 148 Return 1 if the system supports at least one terminal type capable of
 149 all operations described in
 150 .St -p1003.2 ,
 151 otherwise \-1.
 152 .It Li _SC_2_FORT_DEV
 153 Return 1 if the system supports the FORTRAN Development Utilities Option,
 154 otherwise \-1.
 155 .It Li _SC_2_FORT_RUN
 156 Return 1 if the system supports the FORTRAN Runtime Utilities Option,
 157 otherwise \-1.
 158 .It Li _SC_2_LOCALEDEF
 159 Return 1 if the system supports the creation of locales, otherwise \-1.
 160 .It Li _SC_2_SW_DEV
 161 Return 1 if the system supports the Software Development Utilities Option,
 162 otherwise \-1.
 163 .It Li _SC_2_UPE
 164 Return 1 if the system supports the User Portability Utilities Option,
 165 otherwise \-1.
 166 .It Li _SC_AIO_LISTIO_MAX
 167 Maximum number of I/O operations in a single list I/O call supported.
 168 .It Li _SC_AIO_MAX
 169 Maximum number of outstanding asynchronous I/O operations supported.
 170 .It Li _SC_AIO_PRIO_DELTA_MAX
 171 The maximum amount by which a process can decrease its asynchronous I/O
 172 priority level from its own scheduling priority.
 173 .It Li _SC_DELAYTIMER_MAX
 174 Maximum number of timer expiration overruns.
 175 .It Li _SC_MQ_OPEN_MAX
 176 The maximum number of open message queue descriptors a process may hold.
 177 .It Li _SC_RTSIG_MAX
 178 Maximum number of realtime signals reserved for application use.
 179 .It Li _SC_SEM_NSEMS_MAX
 180 Maximum number of semaphores that a process may have.
 181 .It Li _SC_SEM_VALUE_MAX
 182 The maximum value a semaphore may have.
 183 .It Li _SC_SIGQUEUE_MAX
 184 Maximum number of queued signals that a process may send and have pending at
 185 the receiver(s) at any time.
 186 .It Li _SC_TIMER_MAX
 187 Maximum number of timers per process supported.
 188 .It Li _SC_GETGR_R_SIZE_MAX
 189 Suggested initial value for the size of the group entry buffer.
 190 .It Li _SC_GETPW_R_SIZE_MAX
 191 Suggested initial value for the size of the password entry buffer.
 192 .It Li _SC_HOST_NAME_MAX
 193 Maximum length of a host name (not including the terminating null) as
 194 returned from the
 195 .Fn gethostname
 196 function.
 197 .It Li _SC_LOGIN_NAME_MAX
 198 Maximum length of a login name.
 199 .It Li _SC_THREAD_STACK_MIN
 200 Minimum size in bytes of thread stack storage.
 201 .It Li _SC_THREAD_THREADS_MAX
 202 Maximum number of threads that can be created per process.
 203 .It Li _SC_TTY_NAME_MAX
 204 Maximum length of terminal device name.
 205 .It Li _SC_SYMLOOP_MAX
 206 Maximum number of symbolic links that can be reliably traversed in the
 207 resolution of a pathname in the absence of a loop.
 208 .It Li _SC_ATEXIT_MAX
 209 Maximum number of functions that may be registered with
 210 .Fn atexit .
 211 .It Li _SC_XOPEN_VERSION
 212 An integer value greater than or equal to 4,
 213 indicating the version of the X/Open Portability Guide to which this
 214 system conforms.
 215 .It Li _SC_XOPEN_XCU_VERSION
 216 An integer value indicating the version of the XCU Specification to which
 217 this system conforms.
 218 .El
 219 .Pp
 220 These values also exist, but may not be standard:
 221 .Bl -tag -width 6n
 222 .It Li _SC_CPUSET_SIZE
 223 Size of the kernel cpuset.
 224 .It Li _SC_PHYS_PAGES
 225 The number of pages of physical memory.
 226 Note that it is possible that the product of this value and the value of
 227 .Li _SC_PAGESIZE
 228 will overflow a
 229 .Vt long
 230 in some configurations on a 32bit machine.
 231 .El
 232 .Sh RETURN VALUES
 233 If the call to
 234 .Fn sysconf
 235 is not successful, \-1 is returned and
 236 .Va errno
 237 is set appropriately.
 238 Otherwise, if the variable is associated with functionality that is not
 239 supported, \-1 is returned and
 240 .Va errno
 241 is not modified.
 242 Otherwise, the current variable value is returned.
 243 .Sh ERRORS
 244 The
 245 .Fn sysconf
 246 function may fail and set
 247 .Va errno
 248 for any of the errors specified for the library function
 249 .Xr sysctl 3 .
 250 In addition, the following error may be reported:
 251 .Bl -tag -width Er
 252 .It Bq Er EINVAL
 253 The value of the
 254 .Fa name
 255 argument is invalid.
 256 .El
 257 .Sh SEE ALSO
 258 .Xr getconf 1 ,
 259 .Xr pathconf 2 ,
 260 .Xr confstr 3 ,
 261 .Xr sysctl 3
 262 .Sh STANDARDS
 263 Except for the fact that values returned by
 264 .Fn sysconf
 265 may change over the lifetime of the calling process,
 266 this function conforms to
 267 .St -p1003.1-88 .
 268 .Sh HISTORY
 269 The
 270 .Fn sysconf
 271 function first appeared in
 272 .Bx 4.4 .
 273 .Sh BUGS
 274 The value for _SC_STREAM_MAX is a minimum maximum, and required to be
 275 the same as ANSI C's FOPEN_MAX, so the returned value is a ridiculously
 276 small and misleading number.