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