lib/libc/gen/sysctl.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 .\"     @(#)sysctl.3    8.4 (Berkeley) 5/9/95
  33 .\" $FreeBSD: src/lib/libc/gen/sysctl.3,v 1.33.2.13 2002/04/07 04:57:14 dd Exp $
  34 .\" $DragonFly: src/lib/libc/gen/sysctl.3,v 1.2 2003/06/17 04:26:42 dillon Exp $
  35 .\"
  36 .Dd January 23, 2001
  37 .Dt SYSCTL 3
  38 .Os
  39 .Sh NAME
  40 .Nm sysctl ,
  41 .Nm sysctlbyname ,
  42 .Nm sysctlnametomib
  43 .Nd get or set system information
  44 .Sh LIBRARY
  45 .Lb libc
  46 .Sh SYNOPSIS
  47 .In sys/types.h
  48 .In sys/sysctl.h
  49 .Ft int
  50 .Fn sysctl "int *name" "u_int namelen" "void *oldp" "size_t *oldlenp" "void *newp" "size_t newlen"
  51 .Ft int
  52 .Fn sysctlbyname "const char *name" "void *oldp" "size_t *oldlenp" "void *newp" "size_t newlen"
  53 .Ft int
  54 .Fn sysctlnametomib "const char *name" "int *mibp" "size_t *sizep"
  55 .Sh DESCRIPTION
  56 The
  57 .Fn sysctl
  58 function retrieves system information and allows processes with
  59 appropriate privileges to set system information.
  60 The information available from
  61 .Fn sysctl
  62 consists of integers, strings, and tables.
  63 Information may be retrieved and set from the command interface
  64 using the
  65 .Xr sysctl 8
  66 utility.
  67 .Pp
  68 Unless explicitly noted below,
  69 .Fn sysctl
  70 returns a consistent snapshot of the data requested.
  71 Consistency is obtained by locking the destination
  72 buffer into memory so that the data may be copied out without blocking.
  73 Calls to
  74 .Fn sysctl
  75 are serialized to avoid deadlock.
  76 .Pp
  77 The state is described using a ``Management Information Base'' (MIB)
  78 style name, listed in
  79 .Fa name ,
  80 which is a
  81 .Fa namelen
  82 length array of integers.
  83 .Pp
  84 The
  85 .Fn sysctlbyname
  86 function accepts an ASCII representation of the name and internally
  87 looks up the integer name vector.  Apart from that, it behaves the same
  88 as the standard
  89 .Fn sysctl
  90 function.
  91 .Pp
  92 The information is copied into the buffer specified by
  93 .Fa oldp .
  94 The size of the buffer is given by the location specified by
  95 .Fa oldlenp
  96 before the call,
  97 and that location gives the amount of data copied after a successful call
  98 and after a call that returns with the error code
  99 .Er ENOMEM .
 100 If the amount of data available is greater
 101 than the size of the buffer supplied,
 102 the call supplies as much data as fits in the buffer provided
 103 and returns with the error code
 104 .Er ENOMEM .
 105 If the old value is not desired,
 106 .Fa oldp
 107 and
 108 .Fa oldlenp
 109 should be set to NULL.
 110 .Pp
 111 The size of the available data can be determined by calling
 112 .Fn sysctl
 113 with a NULL parameter for
 114 .Fa oldp .
 115 The size of the available data will be returned in the location pointed to by
 116 .Fa oldlenp .
 117 For some operations, the amount of space may change often.
 118 For these operations,
 119 the system attempts to round up so that the returned size is
 120 large enough for a call to return the data shortly thereafter.
 121 .Pp
 122 To set a new value,
 123 .Fa newp
 124 is set to point to a buffer of length
 125 .Fa newlen
 126 from which the requested value is to be taken.
 127 If a new value is not to be set,
 128 .Fa newp
 129 should be set to NULL and
 130 .Fa newlen
 131 set to 0.
 132 .Pp
 133 The
 134 .Fn sysctlnametomib
 135 function accepts an ASCII representation of the name,
 136 looks up the integer name vector,
 137 and returns the numeric representation in the mib array pointed to by
 138 .Fa mibp .
 139 The number of elements in the mib array is given by the location specified by
 140 .Fa sizep
 141 before the call,
 142 and that location gives the number of entries copied after a successful call.
 143 The resulting
 144 .Fa mib
 145 and
 146 .Fa size
 147 may be used in subsequent
 148 .Fn sysctl
 149 calls to get the data associated with the requested ASCII name.
 150 This interface is intended for use by applications that want to
 151 repeatedly request the same variable (the
 152 .Fn sysctl
 153 function runs in about a third the time as the same request made via the
 154 .Fn sysctlbyname
 155 function).
 156 The
 157 .Fn sysctlnametomib
 158 function is also useful for fetching mib prefixes and then adding
 159 a final component.
 160 For example, to fetch process information
 161 for processes with pid's less than 100:
 162 .Pp
 163 .Bd -literal -offset indent -compact
 164 int i, mib[4];
 165 size_t len;
 166 struct kinfo_proc kp;
 167
 168 /* Fill out the first three components of the mib */
 169 len = 4;
 170 sysctlnametomib("kern.proc.pid", mib, &len);
 171
 172 /* Fetch and print entries for pid's < 100 */
 173 for (i = 0; i < 100; i++) {
 174         mib[3] = i;
 175         len = sizeof(kp);
 176         if (sysctl(mib, 4, &kp, &len, NULL, 0) == -1)
 177                 perror("sysctl");
 178         else if (len > 0)
 179                 printkproc(&kp);
 180 }
 181 .Ed
 182 .Pp
 183 The top level names are defined with a CTL_ prefix in
 184 .Aq Pa sys/sysctl.h ,
 185 and are as follows.
 186 The next and subsequent levels down are found in the include files
 187 listed here, and described in separate sections below.
 188 .Pp
 189 .Bl -column CTLXMACHDEPXXX "Next level namesXXXXXX" -offset indent
 190 .It Sy "Name    Next level names        Description"
 191 .It "CTL\_DEBUG sys/sysctl.h    Debugging"
 192 .It "CTL\_VFS   sys/mount.h     Filesystem"
 193 .It "CTL\_HW    sys/sysctl.h    Generic CPU, I/O"
 194 .It "CTL\_KERN  sys/sysctl.h    High kernel limits"
 195 .It "CTL\_MACHDEP       sys/sysctl.h    Machine dependent"
 196 .It "CTL\_NET   sys/socket.h    Networking"
 197 .It "CTL\_USER  sys/sysctl.h    User-level"
 198 .It "CTL\_VM    vm/vm_param.h   Virtual memory"
 199 .El
 200 .Pp
 201 For example, the following retrieves the maximum number of processes allowed
 202 in the system:
 203 .Pp
 204 .Bd -literal -offset indent -compact
 205 int mib[2], maxproc;
 206 size_t len;
 207
 208 mib[0] = CTL_KERN;
 209 mib[1] = KERN_MAXPROC;
 210 len = sizeof(maxproc);
 211 sysctl(mib, 2, &maxproc, &len, NULL, 0);
 212 .Ed
 213 .Pp
 214 To retrieve the standard search path for the system utilities:
 215 .Pp
 216 .Bd -literal -offset indent -compact
 217 int mib[2];
 218 size_t len;
 219 char *p;
 220
 221 mib[0] = CTL_USER;
 222 mib[1] = USER_CS_PATH;
 223 sysctl(mib, 2, NULL, &len, NULL, 0);
 224 p = malloc(len);
 225 sysctl(mib, 2, p, &len, NULL, 0);
 226 .Ed
 227 .Ss CTL_DEBUG
 228 The debugging variables vary from system to system.
 229 A debugging variable may be added or deleted without need to recompile
 230 .Fn sysctl
 231 to know about it.
 232 Each time it runs,
 233 .Fn sysctl
 234 gets the list of debugging variables from the kernel and
 235 displays their current values.
 236 The system defines twenty
 237 .Ns ( Va struct ctldebug )
 238 variables named
 239 .Nm debug0
 240 through
 241 .Nm debug19 .
 242 They are declared as separate variables so that they can be
 243 individually initialized at the location of their associated variable.
 244 The loader prevents multiple use of the same variable by issuing errors
 245 if a variable is initialized in more than one place.
 246 For example, to export the variable
 247 .Nm dospecialcheck
 248 as a debugging variable, the following declaration would be used:
 249 .Bd -literal -offset indent -compact
 250 int dospecialcheck = 1;
 251 struct ctldebug debug5 = { "dospecialcheck", &dospecialcheck };
 252 .Ed
 253 .Ss CTL_VFS
 254 A distinguished second level name, VFS_GENERIC,
 255 is used to get general information about all filesystems.
 256 One of its third level identifiers is VFS_MAXTYPENUM
 257 that gives the highest valid filesystem type number.
 258 Its other third level identifier is VFS_CONF that
 259 returns configuration information about the filesystem
 260 type given as a fourth level identifier (see
 261 .Xr getvfsbyname 3
 262 as an example of its use).
 263 The remaining second level identifiers are the
 264 filesystem type number returned by a
 265 .Xr statfs 2
 266 call or from VFS_CONF.
 267 The third level identifiers available for each filesystem
 268 are given in the header file that defines the mount
 269 argument structure for that filesystem.
 270 .Ss CTL_HW
 271 The string and integer information available for the CTL_HW level
 272 is detailed below.
 273 The changeable column shows whether a process with appropriate
 274 privilege may change the value.
 275 .Bl -column "Second level nameXXXXXX" integerXXX -offset indent
 276 .It Sy "Second level name       Type    Changeable"
 277 .It "HW\_MACHINE        string  no"
 278 .It "HW\_MODEL  string  no"
 279 .It "HW\_NCPU   integer no"
 280 .It "HW\_BYTEORDER      integer no"
 281 .It "HW\_PHYSMEM        integer no"
 282 .It "HW\_USERMEM        integer no"
 283 .It "HW\_PAGESIZE       integer no"
 284 .It "HW\_FLOATINGPOINT  integer no"
 285 .It "HW\_MACHINE\_ARCH  string  no"
 286 .\".It "HW\_DISKNAMES   integer no"
 287 .\".It "HW\_DISKSTATS   integer no"
 288 .El
 289 .Pp
 290 .Bl -tag -width 6n
 291 .It Li HW_MACHINE
 292 The machine class.
 293 .It Li HW_MODEL
 294 The machine model
 295 .It Li HW_NCPU
 296 The number of cpus.
 297 .It Li HW_BYTEORDER
 298 The byteorder (4,321, or 1,234).
 299 .It Li HW_PHYSMEM
 300 The bytes of physical memory.
 301 .It Li HW_USERMEM
 302 The bytes of non-kernel memory.
 303 .It Li HW_PAGESIZE
 304 The software page size.
 305 .It Li HW_FLOATINGPOINT
 306 Nonzero if the floating point support is in hardware.
 307 .It Li HW_MACHINE_ARCH
 308 The machine dependent architecture type.
 309 .\".It Fa HW_DISKNAMES
 310 .\".It Fa HW_DISKSTATS
 311 .El
 312 .Ss CTL_KERN
 313 The string and integer information available for the CTL_KERN level
 314 is detailed below.
 315 The changeable column shows whether a process with appropriate
 316 privilege may change the value.
 317 The types of data currently available are process information,
 318 system vnodes, the open file entries, routing table entries,
 319 virtual memory statistics, load average history, and clock rate
 320 information.
 321 .Bl -column "KERNXMAXFILESPERPROCXXX" "struct clockrateXXX" -offset indent
 322 .It Sy "Second level name       Type    Changeable"
 323 .It "KERN\_ARGMAX       integer no"
 324 .It "KERN\_BOOTFILE     string  yes"
 325 .It "KERN\_BOOTTIME     struct timeval  no"
 326 .It "KERN\_CLOCKRATE    struct clockinfo        no"
 327 .It "KERN\_FILE struct file     no"
 328 .It "KERN\_HOSTID       integer yes"
 329 .It "KERN\_HOSTNAME     string  yes"
 330 .It "KERN\_JOB\_CONTROL integer no"
 331 .It "KERN\_MAXFILES     integer yes"
 332 .It "KERN\_MAXFILESPERPROC      integer yes"
 333 .It "KERN\_MAXPROC      integer no"
 334 .It "KERN\_MAXPROCPERUID        integer yes"
 335 .It "KERN\_MAXVNODES    integer yes"
 336 .It "KERN\_NGROUPS      integer no"
 337 .It "KERN\_NISDOMAINNAME        string  yes"
 338 .It "KERN\_OSRELDATE    integer no"
 339 .It "KERN\_OSRELEASE    string  no"
 340 .It "KERN\_OSREV        integer no"
 341 .It "KERN\_OSTYPE       string  no"
 342 .It "KERN\_POSIX1       integer no"
 343 .It "KERN\_PROC struct proc     no"
 344 .It "KERN\_PROF node    not applicable"
 345 .It "KERN\_QUANTUM      integer yes"
 346 .It "KERN\_SAVED\_IDS   integer no"
 347 .It "KERN\_SECURELVL    integer raise only"
 348 .It "KERN\_UPDATEINTERVAL       integer no"
 349 .It "KERN\_VERSION      string  no"
 350 .It "KERN\_VNODE        struct vnode    no"
 351 .El
 352 .Pp
 353 .Bl -tag -width 6n
 354 .It Li KERN_ARGMAX
 355 The maximum bytes of argument to
 356 .Xr execve 2 .
 357 .It Li KERN_BOOTFILE
 358 The full pathname of the file from which the kernel was loaded.
 359 .It Li KERN_BOOTTIME
 360 A
 361 .Va struct timeval
 362 structure is returned.
 363 This structure contains the time that the system was booted.
 364 .It Li KERN_CLOCKRATE
 365 A
 366 .Va struct clockinfo
 367 structure is returned.
 368 This structure contains the clock, statistics clock and profiling clock
 369 frequencies, the number of micro-seconds per hz tick and the skew rate.
 370 .It Li KERN_FILE
 371 Return the entire file table.
 372 The returned data consists of a single
 373 .Va struct filehead
 374 followed by an array of
 375 .Va struct file ,
 376 whose size depends on the current number of such objects in the system.
 377 .It Li KERN_HOSTID
 378 Get or set the host id.
 379 .It Li KERN_HOSTNAME
 380 Get or set the hostname.
 381 .It Li KERN_JOB_CONTROL
 382 Return 1 if job control is available on this system, otherwise 0.
 383 .It Li KERN_MAXFILES
 384 The maximum number of files that may be open in the system.
 385 .It Li KERN_MAXFILESPERPROC
 386 The maximum number of files that may be open for a single process.
 387 This limit only applies to processes with an effective uid of nonzero
 388 at the time of the open request.
 389 Files that have already been opened are not affected if the limit
 390 or the effective uid is changed.
 391 .It Li KERN_MAXPROC
 392 The maximum number of concurrent processes the system will allow.
 393 .It Li KERN_MAXPROCPERUID
 394 The maximum number of concurrent processes the system will allow
 395 for a single effective uid.
 396 This limit only applies to processes with an effective uid of nonzero
 397 at the time of a fork request.
 398 Processes that have already been started are not affected if the limit
 399 is changed.
 400 .It Li KERN_MAXVNODES
 401 The maximum number of vnodes available on the system.
 402 .It Li KERN_NGROUPS
 403 The maximum number of supplemental groups.
 404 .It Li KERN_NISDOMAINNAME
 405 The name of the current YP/NIS domain.
 406 .It Li KERN_OSRELDATE
 407 The system release date in YYYYMM format
 408 (January 1996 is encoded as 199601).
 409 .It Li KERN_OSRELEASE
 410 The system release string.
 411 .It Li KERN_OSREV
 412 The system revision string.
 413 .It Li KERN_OSTYPE
 414 The system type string.
 415 .It Li KERN_POSIX1
 416 The version of
 417 .St -p1003.1
 418 with which the system
 419 attempts to comply.
 420 .It Li KERN_PROC
 421 Return the entire process table, or a subset of it.
 422 An array of
 423 .Va struct kinfo_proc
 424 structures is returned,
 425 whose size depends on the current number of such objects in the system.
 426 The third and fourth level names are as follows:
 427 .Bl -column "Third level nameXXXXXX" "Fourth level is:XXXXXX" -offset indent
 428 .It "Third level name   Fourth level is:"
 429 .It "KERN\_PROC\_ALL    None"
 430 .It "KERN\_PROC\_PID    A process ID"
 431 .It "KERN\_PROC\_PGRP   A process group"
 432 .It "KERN\_PROC\_TTY    A tty device"
 433 .It "KERN\_PROC\_UID    A user ID"
 434 .It "KERN\_PROC\_RUID   A real user ID"
 435 .El
 436 .It Li KERN_PROF
 437 Return profiling information about the kernel.
 438 If the kernel is not compiled for profiling,
 439 attempts to retrieve any of the KERN_PROF values will
 440 fail with
 441 .Er ENOENT .
 442 The third level names for the string and integer profiling information
 443 is detailed below.
 444 The changeable column shows whether a process with appropriate
 445 privilege may change the value.
 446 .Bl -column "GPROFXGMONPARAMXXX" "struct gmonparamXXX" -offset indent
 447 .It Sy "Third level name        Type    Changeable"
 448 .It "GPROF\_STATE       integer yes"
 449 .It "GPROF\_COUNT       u_short[\|]     yes"
 450 .It "GPROF\_FROMS       u_short[\|]     yes"
 451 .It "GPROF\_TOS struct tostruct yes"
 452 .It "GPROF\_GMONPARAM   struct gmonparam        no"
 453 .El
 454 .Pp
 455 The variables are as follows:
 456 .Bl -tag -width 6n
 457 .It Li GPROF_STATE
 458 Returns GMON_PROF_ON or GMON_PROF_OFF to show that profiling
 459 is running or stopped.
 460 .It Li GPROF_COUNT
 461 Array of statistical program counter counts.
 462 .It Li GPROF_FROMS
 463 Array indexed by program counter of call-from points.
 464 .It Li GPROF_TOS
 465 Array of
 466 .Va struct tostruct
 467 describing destination of calls and their counts.
 468 .It Li GPROF_GMONPARAM
 469 Structure giving the sizes of the above arrays.
 470 .El
 471 .It Li KERN_QUANTUM
 472 The maximum period of time, in microseconds, for which a process is allowed
 473 to run without being preempted if other processes are in the run queue.
 474 .It Li KERN_SAVED_IDS
 475 Returns 1 if saved set-group and saved set-user ID is available.
 476 .It Li KERN_SECURELVL
 477 The system security level.
 478 This level may be raised by processes with appropriate privilege.
 479 It may not be lowered.
 480 .It Li KERN_VERSION
 481 The system version string.
 482 .It Li KERN_VNODE
 483 Return the entire vnode table.
 484 Note, the vnode table is not necessarily a consistent snapshot of
 485 the system.
 486 The returned data consists of an array whose size depends on the
 487 current number of such objects in the system.
 488 Each element of the array contains the kernel address of a vnode
 489 .Va struct vnode *
 490 followed by the vnode itself
 491 .Va struct vnode .
 492 .El
 493 .Ss CTL_MACHDEP
 494 The set of variables defined is architecture dependent.
 495 The following variables are defined for the i386 architecture.
 496 .Bl -column "CONSOLE_DEVICEXXX" "struct bootinfoXXX" -offset indent
 497 .It Sy "Second level name       Type    Changeable"
 498 .It Li "CPU_CONSDEV     dev_t   no"
 499 .It Li "CPU_ADJKERNTZ   int     yes"
 500 .It Li "CPU_DISRTCSET   int     yes"
 501 .It Li "CPU_BOOTINFO    struct bootinfo no"
 502 .It Li "CPU_WALLCLOCK   int     yes"
 503 .El
 504 .Ss CTL_NET
 505 The string and integer information available for the CTL_NET level
 506 is detailed below.
 507 The changeable column shows whether a process with appropriate
 508 privilege may change the value.
 509 .Bl -column "Second level nameXXXXXX" "routing messagesXXX" -offset indent
 510 .It Sy "Second level name       Type    Changeable"
 511 .It "PF\_ROUTE  routing messages        no"
 512 .It "PF\_INET   IPv4 values     yes"
 513 .It "PF\_INET6  IPv6 values     yes"
 514 .El
 515 .Pp
 516 .Bl -tag -width 6n
 517 .It Li PF_ROUTE
 518 Return the entire routing table or a subset of it.
 519 The data is returned as a sequence of routing messages (see
 520 .Xr route 4
 521 for the header file, format and meaning).
 522 The length of each message is contained in the message header.
 523 .Pp
 524 The third level name is a protocol number, which is currently always 0.
 525 The fourth level name is an address family, which may be set to 0 to
 526 select all address families.
 527 The fifth and sixth level names are as follows:
 528 .Bl -column "Fifth level nameXXXXXX" "Sixth level is:XXX" -offset indent
 529 .It Sy "Fifth level name        Sixth level is:"
 530 .It "NET\_RT\_FLAGS     rtflags"
 531 .It "NET\_RT\_DUMP      None"
 532 .It "NET\_RT\_IFLIST    None"
 533 .El
 534 .It Li PF_INET
 535 Get or set various global information about the IPv4
 536 (Internet Protocol version 4).
 537 The third level name is the protocol.
 538 The fourth level name is the variable name.
 539 The currently defined protocols and names are:
 540 .Bl -column ProtocolXX VariableXX TypeXX ChangeableXX
 541 .It Sy "Protocol        Variable        Type    Changeable"
 542 .It "icmp       bmcastecho      integer yes"
 543 .It "icmp       maskrepl        integer yes"
 544 .It "ip forwarding      integer yes"
 545 .It "ip redirect        integer yes"
 546 .It "ip ttl     integer yes"
 547 .It "udp        checksum        integer yes"
 548 .El
 549 .Pp
 550 The variables are as follows:
 551 .Bl -tag -width 6n
 552 .It Li icmp.bmcastecho
 553 Returns 1 if an ICMP echo request to a broadcast or multicast address is
 554 to be answered.
 555 .It Li icmp.maskrepl
 556 Returns 1 if ICMP network mask requests are to be answered.
 557 .It Li ip.forwarding
 558 Returns 1 when IP forwarding is enabled for the host,
 559 meaning that the host is acting as a router.
 560 .It Li ip.redirect
 561 Returns 1 when ICMP redirects may be sent by the host.
 562 This option is ignored unless the host is routing IP packets,
 563 and should normally be enabled on all systems.
 564 .It Li ip.ttl
 565 The maximum time-to-live (hop count) value for an IP packet sourced by
 566 the system.
 567 This value applies to normal transport protocols, not to ICMP.
 568 .It Li udp.checksum
 569 Returns 1 when UDP checksums are being computed and checked.
 570 Disabling UDP checksums is strongly discouraged.
 571 .Pp
 572 For variables net.inet.*.ipsec, please refer to
 573 .Xr ipsec 4 .
 574 .El
 575 .It Li PF_INET6
 576 Get or set various global information about the IPv6
 577 (Internet Protocol version 6).
 578 The third level name is the protocol.
 579 The fourth level name is the variable name.
 580 .Pp
 581 For variables net.inet6.* please refer to
 582 .Xr inet6 4 .
 583 For variables net.inet6.*.ipsec6, please refer to
 584 .Xr ipsec 4 .
 585 .El
 586 .Ss CTL_USER
 587 The string and integer information available for the CTL_USER level
 588 is detailed below.
 589 The changeable column shows whether a process with appropriate
 590 privilege may change the value.
 591 .Bl -column "USER_COLL_WEIGHTS_MAXXXX" "integerXXX" -offset indent
 592 .It Sy "Second level name       Type    Changeable"
 593 .It "USER\_BC\_BASE\_MAX        integer no"
 594 .It "USER\_BC\_DIM\_MAX integer no"
 595 .It "USER\_BC\_SCALE\_MAX       integer no"
 596 .It "USER\_BC\_STRING\_MAX      integer no"
 597 .It "USER\_COLL\_WEIGHTS\_MAX   integer no"
 598 .It "USER\_CS\_PATH     string  no"
 599 .It "USER\_EXPR\_NEST\_MAX      integer no"
 600 .It "USER\_LINE\_MAX    integer no"
 601 .It "USER\_POSIX2\_CHAR\_TERM   integer no"
 602 .It "USER\_POSIX2\_C\_BIND      integer no"
 603 .It "USER\_POSIX2\_C\_DEV       integer no"
 604 .It "USER\_POSIX2\_FORT\_DEV    integer no"
 605 .It "USER\_POSIX2\_FORT\_RUN    integer no"
 606 .It "USER\_POSIX2\_LOCALEDEF    integer no"
 607 .It "USER\_POSIX2\_SW\_DEV      integer no"
 608 .It "USER\_POSIX2\_UPE  integer no"
 609 .It "USER\_POSIX2\_VERSION      integer no"
 610 .It "USER\_RE\_DUP\_MAX integer no"
 611 .It "USER\_STREAM\_MAX  integer no"
 612 .It "USER\_TZNAME\_MAX  integer no"
 613 .El
 614 .Bl -tag -width 6n
 615 .Pp
 616 .It Li USER_BC_BASE_MAX
 617 The maximum ibase/obase values in the
 618 .Xr bc 1
 619 utility.
 620 .It Li USER_BC_DIM_MAX
 621 The maximum array size in the
 622 .Xr bc 1
 623 utility.
 624 .It Li USER_BC_SCALE_MAX
 625 The maximum scale value in the
 626 .Xr bc 1
 627 utility.
 628 .It Li USER_BC_STRING_MAX
 629 The maximum string length in the
 630 .Xr bc 1
 631 utility.
 632 .It Li USER_COLL_WEIGHTS_MAX
 633 The maximum number of weights that can be assigned to any entry of
 634 the LC_COLLATE order keyword in the locale definition file.
 635 .It Li USER_CS_PATH
 636 Return a value for the
 637 .Ev PATH
 638 environment variable that finds all the standard utilities.
 639 .It Li USER_EXPR_NEST_MAX
 640 The maximum number of expressions that can be nested within
 641 parenthesis by the
 642 .Xr expr 1
 643 utility.
 644 .It Li USER_LINE_MAX
 645 The maximum length in bytes of a text-processing utility's input
 646 line.
 647 .It Li USER_POSIX2_CHAR_TERM
 648 Return 1 if the system supports at least one terminal type capable of
 649 all operations described in
 650 .St -p1003.2 ,
 651 otherwise 0.
 652 .It Li USER_POSIX2_C_BIND
 653 Return 1 if the system's C-language development facilities support the
 654 C-Language Bindings Option, otherwise 0.
 655 .It Li USER_POSIX2_C_DEV
 656 Return 1 if the system supports the C-Language Development Utilities Option,
 657 otherwise 0.
 658 .It Li USER_POSIX2_FORT_DEV
 659 Return 1 if the system supports the FORTRAN Development Utilities Option,
 660 otherwise 0.
 661 .It Li USER_POSIX2_FORT_RUN
 662 Return 1 if the system supports the FORTRAN Runtime Utilities Option,
 663 otherwise 0.
 664 .It Li USER_POSIX2_LOCALEDEF
 665 Return 1 if the system supports the creation of locales, otherwise 0.
 666 .It Li USER_POSIX2_SW_DEV
 667 Return 1 if the system supports the Software Development Utilities Option,
 668 otherwise 0.
 669 .It Li USER_POSIX2_UPE
 670 Return 1 if the system supports the User Portability Utilities Option,
 671 otherwise 0.
 672 .It Li USER_POSIX2_VERSION
 673 The version of
 674 .St -p1003.2
 675 with which the system attempts to comply.
 676 .It Li USER_RE_DUP_MAX
 677 The maximum number of repeated occurrences of a regular expression
 678 permitted when using interval notation.
 679 .It Li USER_STREAM_MAX
 680 The minimum maximum number of streams that a process may have open
 681 at any one time.
 682 .It Li USER_TZNAME_MAX
 683 The minimum maximum number of types supported for the name of a
 684 timezone.
 685 .El
 686 .Ss CTL_VM
 687 The string and integer information available for the CTL_VM level
 688 is detailed below.
 689 The changeable column shows whether a process with appropriate
 690 privilege may change the value.
 691 .Bl -column "Second level nameXXXXXX" "struct loadavgXXX" -offset indent
 692 .It Sy "Second level name       Type    Changeable"
 693 .It "VM\_LOADAVG        struct loadavg  no"
 694 .It "VM\_METER  struct vmtotal  no"
 695 .It "VM\_PAGEOUT\_ALGORITHM     integer yes"
 696 .It "VM\_SWAPPING\_ENABLED      integer maybe"
 697 .It "VM\_V\_CACHE\_MAX  integer yes"
 698 .It "VM\_V\_CACHE\_MIN  integer yes"
 699 .It "VM\_V\_FREE\_MIN   integer yes"
 700 .It "VM\_V\_FREE\_RESERVED      integer yes"
 701 .It "VM\_V\_FREE\_TARGET        integer yes"
 702 .It "VM\_V\_INACTIVE\_TARGET    integer yes"
 703 .It "VM\_V\_PAGEOUT\_FREE\_MIN  integer yes"
 704 .El
 705 .Pp
 706 .Bl -tag -width 6n
 707 .It Li VM_LOADAVG
 708 Return the load average history.
 709 The returned data consists of a
 710 .Va struct loadavg .
 711 .It Li VM_METER
 712 Return the system wide virtual memory statistics.
 713 The returned data consists of a
 714 .Va struct vmtotal .
 715 .It Li VM_PAGEOUT_ALGORITHM
 716 0 if the statistics-based page management algorithm is in use
 717 or 1 if the near-LRU algorithm is in use.
 718 .It Li VM_SWAPPING_ENABLED
 719 1 if process swapping is enabled or 0 if disabled.  This variable is
 720 permanently set to 0 if the kernel was built with swapping disabled.
 721 .It Li VM_V_CACHE_MAX
 722 Maximum desired size of the cache queue.
 723 .It Li VM_V_CACHE_MIN
 724 Minimum desired size of the cache queue.  If the cache queue size
 725 falls very far below this value, the pageout daemon is awakened.
 726 .It Li VM_V_FREE_MIN
 727 Minimum amount of memory (cache memory plus free memory)
 728 required to be available before a process waiting on memory will be
 729 awakened.
 730 .It Li VM_V_FREE_RESERVED
 731 Processes will awaken the pageout daemon and wait for memory if the
 732 number of free and cached pages drops below this value.
 733 .It Li VM_V_FREE_TARGET
 734 The total amount of free memory (including cache memory) that the
 735 pageout daemon tries to maintain.
 736 .It Li VM_V_INACTIVE_TARGET
 737 The desired number of inactive pages that the pageout daemon should
 738 achieve when it runs.  Inactive pages can be quickly inserted into
 739 process address space when needed.
 740 .It Li VM_V_PAGEOUT_FREE_MIN
 741 If the amount of free and cache memory falls below this value, the
 742 pageout daemon will enter "memory conserving mode" to avoid deadlock.
 743 .El
 744 .Sh RETURN VALUES
 745 .Rv -std
 746 .Sh ERRORS
 747 The following errors may be reported:
 748 .Bl -tag -width Er
 749 .It Bq Er EFAULT
 750 The buffer
 751 .Fa name ,
 752 .Fa oldp ,
 753 .Fa newp ,
 754 or length pointer
 755 .Fa oldlenp
 756 contains an invalid address.
 757 .It Bq Er EINVAL
 758 The
 759 .Fa name
 760 array is less than two or greater than CTL_MAXNAME.
 761 .It Bq Er EINVAL
 762 A non-null
 763 .Fa newp
 764 is given and its specified length in
 765 .Fa newlen
 766 is too large or too small.
 767 .It Bq Er ENOMEM
 768 The length pointed to by
 769 .Fa oldlenp
 770 is too short to hold the requested value.
 771 .It Bq Er ENOTDIR
 772 The
 773 .Fa name
 774 array specifies an intermediate rather than terminal name.
 775 .It Bq Er EISDIR
 776 The
 777 .Fa name
 778 array specifies a terminal name, but the actual name is not terminal.
 779 .It Bq Er ENOENT
 780 The
 781 .Fa name
 782 array specifies a value that is unknown.
 783 .It Bq Er EPERM
 784 An attempt is made to set a read-only value.
 785 .It Bq Er EPERM
 786 A process without appropriate privilege attempts to set a value.
 787 .El
 788 .Sh FILES
 789 .Bl -tag -width <netinet/icmpXvar.h> -compact
 790 .It Aq Pa sys/sysctl.h
 791 definitions for top level identifiers, second level kernel and hardware
 792 identifiers, and user level identifiers
 793 .It Aq Pa sys/socket.h
 794 definitions for second level network identifiers
 795 .It Aq Pa sys/gmon.h
 796 definitions for third level profiling identifiers
 797 .It Aq Pa vm/vm_param.h
 798 definitions for second level virtual memory identifiers
 799 .It Aq Pa netinet/in.h
 800 definitions for third level IPv4/IPv6 identifiers and
 801 fourth level IPv4/v6 identifiers
 802 .It Aq Pa netinet/icmp_var.h
 803 definitions for fourth level ICMP identifiers
 804 .It Aq Pa netinet/icmp6.h
 805 definitions for fourth level ICMPv6 identifiers
 806 .It Aq Pa netinet/udp_var.h
 807 definitions for fourth level UDP identifiers
 808 .El
 809 .Sh SEE ALSO
 810 .Xr sysconf 3 ,
 811 .Xr sysctl 8
 812 .Sh HISTORY
 813 The
 814 .Fn sysctl
 815 function first appeared in
 816 .Bx 4.4 .