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