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