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