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