xref: /freebsd/lib/libc/gen/sysctl.3 (revision d2d9aa87f5564eb1aca7386cb6f595b13ebd556f)
158f0484fSRodney W. Grimes.\" Copyright (c) 1993
258f0484fSRodney W. Grimes.\"	The Regents of the University of California.  All rights reserved.
358f0484fSRodney W. Grimes.\"
458f0484fSRodney W. Grimes.\" Redistribution and use in source and binary forms, with or without
558f0484fSRodney W. Grimes.\" modification, are permitted provided that the following conditions
658f0484fSRodney W. Grimes.\" are met:
758f0484fSRodney W. Grimes.\" 1. Redistributions of source code must retain the above copyright
858f0484fSRodney W. Grimes.\"    notice, this list of conditions and the following disclaimer.
958f0484fSRodney W. Grimes.\" 2. Redistributions in binary form must reproduce the above copyright
1058f0484fSRodney W. Grimes.\"    notice, this list of conditions and the following disclaimer in the
1158f0484fSRodney W. Grimes.\"    documentation and/or other materials provided with the distribution.
1258f0484fSRodney W. Grimes.\" 3. All advertising materials mentioning features or use of this software
1358f0484fSRodney W. Grimes.\"    must display the following acknowledgement:
1458f0484fSRodney W. Grimes.\"	This product includes software developed by the University of
1558f0484fSRodney W. Grimes.\"	California, Berkeley and its contributors.
1658f0484fSRodney W. Grimes.\" 4. Neither the name of the University nor the names of its contributors
1758f0484fSRodney W. Grimes.\"    may be used to endorse or promote products derived from this software
1858f0484fSRodney W. Grimes.\"    without specific prior written permission.
1958f0484fSRodney W. Grimes.\"
2058f0484fSRodney W. Grimes.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
2158f0484fSRodney W. Grimes.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
2258f0484fSRodney W. Grimes.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
2358f0484fSRodney W. Grimes.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
2458f0484fSRodney W. Grimes.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
2558f0484fSRodney W. Grimes.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2658f0484fSRodney W. Grimes.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2758f0484fSRodney W. Grimes.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2858f0484fSRodney W. Grimes.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2958f0484fSRodney W. Grimes.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
3058f0484fSRodney W. Grimes.\" SUCH DAMAGE.
3158f0484fSRodney W. Grimes.\"
320014b4c0SPeter Wemm.\"	@(#)sysctl.3	8.4 (Berkeley) 5/9/95
337f3dea24SPeter Wemm.\" $FreeBSD$
3458f0484fSRodney W. Grimes.\"
35681e5e7aSSteve Price.Dd May 9, 1995
3658f0484fSRodney W. Grimes.Dt SYSCTL 3
3758f0484fSRodney W. Grimes.Os
3858f0484fSRodney W. Grimes.Sh NAME
39dd1d7d1fSPeter Wemm.Nm sysctl ,
40dd1d7d1fSPeter Wemm.Nm sysctlbyname
4158f0484fSRodney W. Grimes.Nd get or set system information
4225bb73e0SAlexey Zelkin.Sh LIBRARY
4325bb73e0SAlexey Zelkin.Lb libc
4458f0484fSRodney W. Grimes.Sh SYNOPSIS
4549f94c2dSPoul-Henning Kamp.Fd #include <sys/types.h>
4658f0484fSRodney W. Grimes.Fd #include <sys/sysctl.h>
4758f0484fSRodney W. Grimes.Ft int
4858f0484fSRodney W. Grimes.Fn sysctl "int *name" "u_int namelen" "void *oldp" "size_t *oldlenp" "void *newp" "size_t newlen"
4904b7c947SBruce Evans.Ft int
50dd1d7d1fSPeter Wemm.Fn sysctlbyname "const char *name" "void *oldp" "size_t *oldlenp" "void *newp" "size_t newlen"
5158f0484fSRodney W. Grimes.Sh DESCRIPTION
5258f0484fSRodney W. GrimesThe
53bf5a138eSMike Pritchard.Fn sysctl
5458f0484fSRodney W. Grimesfunction retrieves system information and allows processes with
5558f0484fSRodney W. Grimesappropriate privileges to set system information.
5658f0484fSRodney W. GrimesThe information available from
57bf5a138eSMike Pritchard.Fn sysctl
5858f0484fSRodney W. Grimesconsists of integers, strings, and tables.
5958f0484fSRodney W. GrimesInformation may be retrieved and set from the command interface
6058f0484fSRodney W. Grimesusing the
61e1f4e80cSMike Pritchard.Xr sysctl 8
6258f0484fSRodney W. Grimesutility.
6358f0484fSRodney W. Grimes.Pp
6458f0484fSRodney W. GrimesUnless explicitly noted below,
65bf5a138eSMike Pritchard.Fn sysctl
6658f0484fSRodney W. Grimesreturns a consistent snapshot of the data requested.
6758f0484fSRodney W. GrimesConsistency is obtained by locking the destination
6858f0484fSRodney W. Grimesbuffer into memory so that the data may be copied out without blocking.
6958f0484fSRodney W. GrimesCalls to
70bf5a138eSMike Pritchard.Fn sysctl
7158f0484fSRodney W. Grimesare serialized to avoid deadlock.
7258f0484fSRodney W. Grimes.Pp
7358f0484fSRodney W. GrimesThe state is described using a ``Management Information Base'' (MIB)
7458f0484fSRodney W. Grimesstyle name, listed in
7558f0484fSRodney W. Grimes.Fa name ,
7658f0484fSRodney W. Grimeswhich is a
7758f0484fSRodney W. Grimes.Fa namelen
7858f0484fSRodney W. Grimeslength array of integers.
7958f0484fSRodney W. Grimes.Pp
80dd1d7d1fSPeter WemmThe
81dd1d7d1fSPeter Wemm.Fn sysctlbyname
82c6d6e772SAlexey Zelkinfunction accepts an ASCII representation of the name and internally
83dd1d7d1fSPeter Wemmlooks up the integer name vector.  Apart from that, it behaves the same
84dd1d7d1fSPeter Wemmas the standard
85dd1d7d1fSPeter Wemm.Fn sysctl
86dd1d7d1fSPeter Wemmfunction.
87dd1d7d1fSPeter Wemm.Pp
8858f0484fSRodney W. GrimesThe information is copied into the buffer specified by
8958f0484fSRodney W. Grimes.Fa oldp .
9058f0484fSRodney W. GrimesThe size of the buffer is given by the location specified by
9158f0484fSRodney W. Grimes.Fa oldlenp
9258f0484fSRodney W. Grimesbefore the call,
93b1f6a5fbSBruce Evansand that location gives the amount of data copied after a successful call
94b1f6a5fbSBruce Evansand after a call that returns with the error code ENOMEM.
9558f0484fSRodney W. GrimesIf the amount of data available is greater
9658f0484fSRodney W. Grimesthan the size of the buffer supplied,
9758f0484fSRodney W. Grimesthe call supplies as much data as fits in the buffer provided
9858f0484fSRodney W. Grimesand returns with the error code ENOMEM.
9958f0484fSRodney W. GrimesIf the old value is not desired,
10058f0484fSRodney W. Grimes.Fa oldp
10158f0484fSRodney W. Grimesand
10258f0484fSRodney W. Grimes.Fa oldlenp
10358f0484fSRodney W. Grimesshould be set to NULL.
10458f0484fSRodney W. Grimes.Pp
10558f0484fSRodney W. GrimesThe size of the available data can be determined by calling
106bf5a138eSMike Pritchard.Fn sysctl
10758f0484fSRodney W. Grimeswith a NULL parameter for
10858f0484fSRodney W. Grimes.Fa oldp .
10958f0484fSRodney W. GrimesThe size of the available data will be returned in the location pointed to by
11058f0484fSRodney W. Grimes.Fa oldlenp .
11158f0484fSRodney W. GrimesFor some operations, the amount of space may change often.
11258f0484fSRodney W. GrimesFor these operations,
11358f0484fSRodney W. Grimesthe system attempts to round up so that the returned size is
11458f0484fSRodney W. Grimeslarge enough for a call to return the data shortly thereafter.
11558f0484fSRodney W. Grimes.Pp
11658f0484fSRodney W. GrimesTo set a new value,
11758f0484fSRodney W. Grimes.Fa newp
11858f0484fSRodney W. Grimesis set to point to a buffer of length
11958f0484fSRodney W. Grimes.Fa newlen
12058f0484fSRodney W. Grimesfrom which the requested value is to be taken.
12158f0484fSRodney W. GrimesIf a new value is not to be set,
12258f0484fSRodney W. Grimes.Fa newp
12358f0484fSRodney W. Grimesshould be set to NULL and
12458f0484fSRodney W. Grimes.Fa newlen
12558f0484fSRodney W. Grimesset to 0.
12658f0484fSRodney W. Grimes.Pp
12758f0484fSRodney W. GrimesThe top level names are defined with a CTL_ prefix in
12896e430a4SAlexey Zelkin.Aq Pa sys/sysctl.h ,
12958f0484fSRodney W. Grimesand are as follows.
13058f0484fSRodney W. GrimesThe next and subsequent levels down are found in the include files
13158f0484fSRodney W. Grimeslisted here, and described in separate sections below.
13258f0484fSRodney W. Grimes.Pp
13358f0484fSRodney W. Grimes.Bl -column CTLXMACHDEPXXX "Next level namesXXXXXX" -offset indent
13458f0484fSRodney W. Grimes.It Sy Pa Name	Next level names	Description
13558f0484fSRodney W. Grimes.It CTL\_DEBUG	sys/sysctl.h	Debugging
1360014b4c0SPeter Wemm.It CTL\_VFS	sys/mount.h	Filesystem
13758f0484fSRodney W. Grimes.It CTL\_HW	sys/sysctl.h	Generic CPU, I/O
13858f0484fSRodney W. Grimes.It CTL\_KERN	sys/sysctl.h	High kernel limits
13958f0484fSRodney W. Grimes.It CTL\_MACHDEP	sys/sysctl.h	Machine dependent
14058f0484fSRodney W. Grimes.It CTL\_NET	sys/socket.h	Networking
14158f0484fSRodney W. Grimes.It CTL\_USER	sys/sysctl.h	User-level
14258f0484fSRodney W. Grimes.It CTL\_VM	vm/vm_param.h	Virtual memory
14358f0484fSRodney W. Grimes.El
14458f0484fSRodney W. Grimes.Pp
14558f0484fSRodney W. GrimesFor example, the following retrieves the maximum number of processes allowed
14658f0484fSRodney W. Grimesin the system:
147c492ccdbSMike Pritchard.Pp
14858f0484fSRodney W. Grimes.Bd -literal -offset indent -compact
14958f0484fSRodney W. Grimesint mib[2], maxproc;
15058f0484fSRodney W. Grimessize_t len;
151c492ccdbSMike Pritchard
15258f0484fSRodney W. Grimesmib[0] = CTL_KERN;
15358f0484fSRodney W. Grimesmib[1] = KERN_MAXPROC;
15458f0484fSRodney W. Grimeslen = sizeof(maxproc);
15558f0484fSRodney W. Grimessysctl(mib, 2, &maxproc, &len, NULL, 0);
15658f0484fSRodney W. Grimes.Ed
157c492ccdbSMike Pritchard.Pp
15858f0484fSRodney W. GrimesTo retrieve the standard search path for the system utilities:
159c492ccdbSMike Pritchard.Pp
16058f0484fSRodney W. Grimes.Bd -literal -offset indent -compact
16158f0484fSRodney W. Grimesint mib[2];
16258f0484fSRodney W. Grimessize_t len;
16358f0484fSRodney W. Grimeschar *p;
164c492ccdbSMike Pritchard
16558f0484fSRodney W. Grimesmib[0] = CTL_USER;
16658f0484fSRodney W. Grimesmib[1] = USER_CS_PATH;
16758f0484fSRodney W. Grimessysctl(mib, 2, NULL, &len, NULL, 0);
16858f0484fSRodney W. Grimesp = malloc(len);
16958f0484fSRodney W. Grimessysctl(mib, 2, p, &len, NULL, 0);
17058f0484fSRodney W. Grimes.Ed
17196e430a4SAlexey Zelkin.Ss CTL_DEBUG
17258f0484fSRodney W. GrimesThe debugging variables vary from system to system.
17358f0484fSRodney W. GrimesA debugging variable may be added or deleted without need to recompile
174bf5a138eSMike Pritchard.Fn sysctl
17558f0484fSRodney W. Grimesto know about it.
17658f0484fSRodney W. GrimesEach time it runs,
177bf5a138eSMike Pritchard.Fn sysctl
17858f0484fSRodney W. Grimesgets the list of debugging variables from the kernel and
17958f0484fSRodney W. Grimesdisplays their current values.
18058f0484fSRodney W. GrimesThe system defines twenty
18158f0484fSRodney W. Grimes.Ns ( Va struct ctldebug )
18258f0484fSRodney W. Grimesvariables named
18358f0484fSRodney W. Grimes.Nm debug0
18458f0484fSRodney W. Grimesthrough
18558f0484fSRodney W. Grimes.Nm debug19 .
18658f0484fSRodney W. GrimesThey are declared as separate variables so that they can be
18758f0484fSRodney W. Grimesindividually initialized at the location of their associated variable.
18858f0484fSRodney W. GrimesThe loader prevents multiple use of the same variable by issuing errors
18958f0484fSRodney W. Grimesif a variable is initialized in more than one place.
19058f0484fSRodney W. GrimesFor example, to export the variable
19158f0484fSRodney W. Grimes.Nm dospecialcheck
19258f0484fSRodney W. Grimesas a debugging variable, the following declaration would be used:
19358f0484fSRodney W. Grimes.Bd -literal -offset indent -compact
19458f0484fSRodney W. Grimesint dospecialcheck = 1;
19558f0484fSRodney W. Grimesstruct ctldebug debug5 = { "dospecialcheck", &dospecialcheck };
19658f0484fSRodney W. Grimes.Ed
19796e430a4SAlexey Zelkin.Ss CTL_VFS
1980014b4c0SPeter WemmA distinguished second level name, VFS_GENERIC,
1990014b4c0SPeter Wemmis used to get general information about all filesystems.
2000014b4c0SPeter WemmOne of its third level identifiers is VFS_MAXTYPENUM
2010014b4c0SPeter Wemmthat gives the highest valid filesystem type number.
2020014b4c0SPeter WemmIts other third level identifier is VFS_CONF that
2030014b4c0SPeter Wemmreturns configuration information about the filesystem
2040014b4c0SPeter Wemmtype given as a fourth level identifier (see
2050014b4c0SPeter Wemm.Xr getvfsbyname 3
2060014b4c0SPeter Wemmas an example of its use).
2070014b4c0SPeter WemmThe remaining second level identifiers are the
2080014b4c0SPeter Wemmfilesystem type number returned by a
2090014b4c0SPeter Wemm.Xr statfs 2
2100014b4c0SPeter Wemmcall or from VFS_CONF.
2110014b4c0SPeter WemmThe third level identifiers available for each filesystem
2120014b4c0SPeter Wemmare given in the header file that defines the mount
2130014b4c0SPeter Wemmargument structure for that filesystem.
21496e430a4SAlexey Zelkin.Ss CTL_HW
21558f0484fSRodney W. GrimesThe string and integer information available for the CTL_HW level
21658f0484fSRodney W. Grimesis detailed below.
21758f0484fSRodney W. GrimesThe changeable column shows whether a process with appropriate
21858f0484fSRodney W. Grimesprivilege may change the value.
21958f0484fSRodney W. Grimes.Bl -column "Second level nameXXXXXX" integerXXX -offset indent
22058f0484fSRodney W. Grimes.It Sy Pa Second level name	Type	Changeable
22158f0484fSRodney W. Grimes.It HW\_MACHINE	string	no
22258f0484fSRodney W. Grimes.It HW\_MODEL	string	no
22358f0484fSRodney W. Grimes.It HW\_NCPU	integer	no
22458f0484fSRodney W. Grimes.It HW\_BYTEORDER	integer	no
22558f0484fSRodney W. Grimes.It HW\_PHYSMEM	integer	no
22658f0484fSRodney W. Grimes.It HW\_USERMEM	integer	no
22758f0484fSRodney W. Grimes.It HW\_PAGESIZE	integer	no
22838c429d5SBruce Evans.It HW\_FLOATINGPOINT	integer	no
22901f770e8SKATO Takenori.It HW\_MACHINE\_ARCH	string	no
23058f0484fSRodney W. Grimes.\".It HW\_DISKNAMES	integer	no
23158f0484fSRodney W. Grimes.\".It HW\_DISKSTATS	integer	no
23258f0484fSRodney W. Grimes.El
23358f0484fSRodney W. Grimes.Pp
23458f0484fSRodney W. Grimes.Bl -tag -width "123456"
23558f0484fSRodney W. Grimes.It Li HW_MACHINE
23658f0484fSRodney W. GrimesThe machine class.
23758f0484fSRodney W. Grimes.It Li HW_MODEL
23858f0484fSRodney W. GrimesThe machine model
23958f0484fSRodney W. Grimes.It Li HW_NCPU
24058f0484fSRodney W. GrimesThe number of cpus.
24158f0484fSRodney W. Grimes.It Li HW_BYTEORDER
24258f0484fSRodney W. GrimesThe byteorder (4,321, or 1,234).
24358f0484fSRodney W. Grimes.It Li HW_PHYSMEM
24458f0484fSRodney W. GrimesThe bytes of physical memory.
24558f0484fSRodney W. Grimes.It Li HW_USERMEM
24658f0484fSRodney W. GrimesThe bytes of non-kernel memory.
24758f0484fSRodney W. Grimes.It Li HW_PAGESIZE
24858f0484fSRodney W. GrimesThe software page size.
24938c429d5SBruce Evans.It Li HW_FLOATINGPOINT
25038c429d5SBruce EvansNonzero if the floating point support is in hardware.
25101f770e8SKATO Takenori.It Li HW_MACHINE_ARCH
25201f770e8SKATO TakenoriThe machine dependent architecture type.
25358f0484fSRodney W. Grimes.\".It Fa HW_DISKNAMES
25458f0484fSRodney W. Grimes.\".It Fa HW_DISKSTATS
25558f0484fSRodney W. Grimes.El
25696e430a4SAlexey Zelkin.Ss CTL_KERN
25758f0484fSRodney W. GrimesThe string and integer information available for the CTL_KERN level
25858f0484fSRodney W. Grimesis detailed below.
25958f0484fSRodney W. GrimesThe changeable column shows whether a process with appropriate
26058f0484fSRodney W. Grimesprivilege may change the value.
26158f0484fSRodney W. GrimesThe types of data currently available are process information,
26258f0484fSRodney W. Grimessystem vnodes, the open file entries, routing table entries,
26358f0484fSRodney W. Grimesvirtual memory statistics, load average history, and clock rate
26458f0484fSRodney W. Grimesinformation.
26538c429d5SBruce Evans.Bl -column "KERNXMAXFILESPERPROCXXX" "struct clockrateXXX" -offset indent
26658f0484fSRodney W. Grimes.It Sy Pa Second level name	Type	Changeable
26758f0484fSRodney W. Grimes.It KERN\_ARGMAX	integer	no
26838c429d5SBruce Evans.It KERN\_BOOTFILE	string	yes
26958f0484fSRodney W. Grimes.It KERN\_BOOTTIME	struct timeval	no
27058f0484fSRodney W. Grimes.It KERN\_CLOCKRATE	struct clockinfo	no
27158f0484fSRodney W. Grimes.It KERN\_FILE	struct file	no
27258f0484fSRodney W. Grimes.It KERN\_HOSTID	integer	yes
27358f0484fSRodney W. Grimes.It KERN\_HOSTNAME	string	yes
27458f0484fSRodney W. Grimes.It KERN\_JOB\_CONTROL	integer	no
27558f0484fSRodney W. Grimes.It KERN\_MAXFILES	integer	yes
27638c429d5SBruce Evans.It KERN\_MAXFILESPERPROC	integer	yes
2777669e901SJoseph Koshy.It KERN\_MAXPROC	integer	no
27838c429d5SBruce Evans.It KERN\_MAXPROCPERUID	integer	yes
27958f0484fSRodney W. Grimes.It KERN\_MAXVNODES	integer	yes
28058f0484fSRodney W. Grimes.It KERN\_NGROUPS	integer	no
28138c429d5SBruce Evans.It KERN\_NISDOMAINNAME	string	yes
28238c429d5SBruce Evans.It KERN\_OSRELDATE	integer	no
28358f0484fSRodney W. Grimes.It KERN\_OSRELEASE	string	no
28458f0484fSRodney W. Grimes.It KERN\_OSREV	integer	no
28558f0484fSRodney W. Grimes.It KERN\_OSTYPE	string	no
28658f0484fSRodney W. Grimes.It KERN\_POSIX1	integer	no
28758f0484fSRodney W. Grimes.It KERN\_PROC	struct proc	no
28858f0484fSRodney W. Grimes.It KERN\_PROF	node	not applicable
289443cb51fSChris Costello.It KERN\_QUANTUM	integer	yes
29058f0484fSRodney W. Grimes.It KERN\_SAVED\_IDS	integer	no
29158f0484fSRodney W. Grimes.It KERN\_SECURELVL	integer	raise only
29238c429d5SBruce Evans.It KERN\_UPDATEINTERVAL	integer	no
29358f0484fSRodney W. Grimes.It KERN\_VERSION	string	no
29458f0484fSRodney W. Grimes.It KERN\_VNODE	struct vnode	no
29558f0484fSRodney W. Grimes.El
29658f0484fSRodney W. Grimes.Pp
29758f0484fSRodney W. Grimes.Bl -tag -width "123456"
29858f0484fSRodney W. Grimes.It Li KERN_ARGMAX
29958f0484fSRodney W. GrimesThe maximum bytes of argument to
300e1f4e80cSMike Pritchard.Xr execve 2 .
30138c429d5SBruce Evans.It Li KERN_BOOTFILE
30238c429d5SBruce EvansThe full pathname of the file from which the kernel was loaded.
30358f0484fSRodney W. Grimes.It Li KERN_BOOTTIME
30458f0484fSRodney W. GrimesA
30558f0484fSRodney W. Grimes.Va struct timeval
30658f0484fSRodney W. Grimesstructure is returned.
30758f0484fSRodney W. GrimesThis structure contains the time that the system was booted.
30858f0484fSRodney W. Grimes.It Li KERN_CLOCKRATE
30958f0484fSRodney W. GrimesA
31058f0484fSRodney W. Grimes.Va struct clockinfo
31158f0484fSRodney W. Grimesstructure is returned.
31258f0484fSRodney W. GrimesThis structure contains the clock, statistics clock and profiling clock
313127feebeSJohn Hayfrequencies, the number of micro-seconds per hz tick and the skew rate.
31458f0484fSRodney W. Grimes.It Li KERN_FILE
31558f0484fSRodney W. GrimesReturn the entire file table.
31658f0484fSRodney W. GrimesThe returned data consists of a single
31758f0484fSRodney W. Grimes.Va struct filehead
31858f0484fSRodney W. Grimesfollowed by an array of
31958f0484fSRodney W. Grimes.Va struct file ,
32058f0484fSRodney W. Grimeswhose size depends on the current number of such objects in the system.
32158f0484fSRodney W. Grimes.It Li KERN_HOSTID
32258f0484fSRodney W. GrimesGet or set the host id.
32358f0484fSRodney W. Grimes.It Li KERN_HOSTNAME
32458f0484fSRodney W. GrimesGet or set the hostname.
32558f0484fSRodney W. Grimes.It Li KERN_JOB_CONTROL
32658f0484fSRodney W. GrimesReturn 1 if job control is available on this system, otherwise 0.
32758f0484fSRodney W. Grimes.It Li KERN_MAXFILES
32838c429d5SBruce EvansThe maximum number of files that may be open in the system.
32938c429d5SBruce Evans.It Li KERN_MAXFILESPERPROC
33038c429d5SBruce EvansThe maximum number of files that may be open for a single process.
33138c429d5SBruce EvansThis limit only applies to processes with an effective uid of nonzero
33238c429d5SBruce Evansat the time of the open request.
33338c429d5SBruce EvansFiles that have already been opened are not affected if the limit
33438c429d5SBruce Evansor the effective uid is changed.
33558f0484fSRodney W. Grimes.It Li KERN_MAXPROC
33638c429d5SBruce EvansThe maximum number of concurrent processes the system will allow.
33738c429d5SBruce Evans.It Li KERN_MAXPROCPERUID
33838c429d5SBruce EvansThe maximum number of concurrent processes the system will allow
33938c429d5SBruce Evansfor a single effective uid.
34038c429d5SBruce EvansThis limit only applies to processes with an effective uid of nonzero
34138c429d5SBruce Evansat the time of a fork request.
34238c429d5SBruce EvansProcesses that have already been started are not affected if the limit
34338c429d5SBruce Evansis changed.
34458f0484fSRodney W. Grimes.It Li KERN_MAXVNODES
34558f0484fSRodney W. GrimesThe maximum number of vnodes available on the system.
34658f0484fSRodney W. Grimes.It Li KERN_NGROUPS
34758f0484fSRodney W. GrimesThe maximum number of supplemental groups.
34838c429d5SBruce Evans.It Li KERN_NISDOMAINNAME
34938c429d5SBruce EvansThe name of the current YP/NIS domain.
35038c429d5SBruce Evans.It Li KERN_OSRELDATE
35138c429d5SBruce EvansThe system release date in YYYYMM format
35238c429d5SBruce Evans(January 1996 is encoded as 199601).
35358f0484fSRodney W. Grimes.It Li KERN_OSRELEASE
35458f0484fSRodney W. GrimesThe system release string.
35558f0484fSRodney W. Grimes.It Li KERN_OSREV
35658f0484fSRodney W. GrimesThe system revision string.
35758f0484fSRodney W. Grimes.It Li KERN_OSTYPE
35858f0484fSRodney W. GrimesThe system type string.
35958f0484fSRodney W. Grimes.It Li KERN_POSIX1
36058f0484fSRodney W. GrimesThe version of ISO/IEC 9945 (POSIX 1003.1) with which the system
36158f0484fSRodney W. Grimesattempts to comply.
36258f0484fSRodney W. Grimes.It Li KERN_PROC
36358f0484fSRodney W. GrimesReturn the entire process table, or a subset of it.
3642de021a4SAndrzej BialeckiAn array of pairs of
3652de021a4SAndrzej Bialecki.Va struct proc
3662de021a4SAndrzej Bialeckifollowed by corresponding
3672de021a4SAndrzej Bialecki.Va struct eproc
36858f0484fSRodney W. Grimesstructures is returned,
36958f0484fSRodney W. Grimeswhose size depends on the current number of such objects in the system.
37058f0484fSRodney W. GrimesThe third and fourth level names are as follows:
37158f0484fSRodney W. Grimes.Bl -column "Third level nameXXXXXX" "Fourth level is:XXXXXX" -offset indent
37258f0484fSRodney W. Grimes.It Pa Third level name	Fourth level is:
37358f0484fSRodney W. Grimes.It KERN\_PROC\_ALL	None
37458f0484fSRodney W. Grimes.It KERN\_PROC\_PID	A process ID
37558f0484fSRodney W. Grimes.It KERN\_PROC\_PGRP	A process group
37658f0484fSRodney W. Grimes.It KERN\_PROC\_TTY	A tty device
37758f0484fSRodney W. Grimes.It KERN\_PROC\_UID	A user ID
37858f0484fSRodney W. Grimes.It KERN\_PROC\_RUID	A real user ID
37958f0484fSRodney W. Grimes.El
380d2d9aa87SSheldon Hearn.Pp
3812de021a4SAndrzej BialeckiIf the third level name is KERN_PROC_ARGS then the command line argument
3822de021a4SAndrzej Bialeckiarray is returned in a flattened form, i.e. zero-terminated arguments
383d2d9aa87SSheldon Hearnfollow each other.
384d2d9aa87SSheldon HearnThe total size of array is returned.
385d2d9aa87SSheldon HearnIt's also possible for a process to set it's own process title this way.
3862de021a4SAndrzej Bialecki.Bl -column "Third level nameXXXXXX" "Fourth level is:XXXXXX" -offset indent
3872de021a4SAndrzej Bialecki.It Pa Third level name	Fourth level is:
3882de021a4SAndrzej Bialecki.It KERN\_PROC\_ARGS	A process ID
3892de021a4SAndrzej Bialecki.El
39058f0484fSRodney W. Grimes.It Li KERN_PROF
39158f0484fSRodney W. GrimesReturn profiling information about the kernel.
39258f0484fSRodney W. GrimesIf the kernel is not compiled for profiling,
39358f0484fSRodney W. Grimesattempts to retrieve any of the KERN_PROF values will
39458f0484fSRodney W. Grimesfail with EOPNOTSUPP.
39558f0484fSRodney W. GrimesThe third level names for the string and integer profiling information
39658f0484fSRodney W. Grimesis detailed below.
39758f0484fSRodney W. GrimesThe changeable column shows whether a process with appropriate
39858f0484fSRodney W. Grimesprivilege may change the value.
39958f0484fSRodney W. Grimes.Bl -column "GPROFXGMONPARAMXXX" "struct gmonparamXXX" -offset indent
40058f0484fSRodney W. Grimes.It Sy Pa Third level name	Type	Changeable
40158f0484fSRodney W. Grimes.It GPROF\_STATE	integer	yes
40258f0484fSRodney W. Grimes.It GPROF\_COUNT	u_short[\|]	yes
40358f0484fSRodney W. Grimes.It GPROF\_FROMS	u_short[\|]	yes
40458f0484fSRodney W. Grimes.It GPROF\_TOS	struct tostruct	yes
40558f0484fSRodney W. Grimes.It GPROF\_GMONPARAM	struct gmonparam	no
40658f0484fSRodney W. Grimes.El
40758f0484fSRodney W. Grimes.Pp
40858f0484fSRodney W. GrimesThe variables are as follows:
40958f0484fSRodney W. Grimes.Bl -tag -width "123456"
41058f0484fSRodney W. Grimes.It Li GPROF_STATE
41158f0484fSRodney W. GrimesReturns GMON_PROF_ON or GMON_PROF_OFF to show that profiling
41258f0484fSRodney W. Grimesis running or stopped.
41358f0484fSRodney W. Grimes.It Li GPROF_COUNT
41458f0484fSRodney W. GrimesArray of statistical program counter counts.
41558f0484fSRodney W. Grimes.It Li GPROF_FROMS
41658f0484fSRodney W. GrimesArray indexed by program counter of call-from points.
41758f0484fSRodney W. Grimes.It Li GPROF_TOS
41858f0484fSRodney W. GrimesArray of
41958f0484fSRodney W. Grimes.Va struct tostruct
42058f0484fSRodney W. Grimesdescribing destination of calls and their counts.
42158f0484fSRodney W. Grimes.It Li GPROF_GMONPARAM
42258f0484fSRodney W. GrimesStructure giving the sizes of the above arrays.
42358f0484fSRodney W. Grimes.El
424443cb51fSChris Costello.It Li KERN_QUANTUM
42511400c9aSChris CostelloThe maximum period of time, in microseconds, for which a process is allowed
42611400c9aSChris Costelloto run without being preempted if other processes are in the run queue.
42758f0484fSRodney W. Grimes.It Li KERN_SAVED_IDS
42858f0484fSRodney W. GrimesReturns 1 if saved set-group and saved set-user ID is available.
42958f0484fSRodney W. Grimes.It Li KERN_SECURELVL
43058f0484fSRodney W. GrimesThe system security level.
43158f0484fSRodney W. GrimesThis level may be raised by processes with appropriate privilege.
432b697833cSGuy HelmerIt may not be lowered.
43358f0484fSRodney W. Grimes.It Li KERN_VERSION
43458f0484fSRodney W. GrimesThe system version string.
43558f0484fSRodney W. Grimes.It Li KERN_VNODE
43658f0484fSRodney W. GrimesReturn the entire vnode table.
43758f0484fSRodney W. GrimesNote, the vnode table is not necessarily a consistent snapshot of
43858f0484fSRodney W. Grimesthe system.
43958f0484fSRodney W. GrimesThe returned data consists of an array whose size depends on the
44058f0484fSRodney W. Grimescurrent number of such objects in the system.
44158f0484fSRodney W. GrimesEach element of the array contains the kernel address of a vnode
44258f0484fSRodney W. Grimes.Va struct vnode *
44358f0484fSRodney W. Grimesfollowed by the vnode itself
44458f0484fSRodney W. Grimes.Va struct vnode .
44558f0484fSRodney W. Grimes.El
44696e430a4SAlexey Zelkin.Ss CTL_MACHDEP
44758f0484fSRodney W. GrimesThe set of variables defined is architecture dependent.
44838c429d5SBruce EvansThe following variables are defined for the i386 architecture.
44938c429d5SBruce Evans.Bl -column "CONSOLE_DEVICEXXX" "struct bootinfoXXX" -offset indent
45058f0484fSRodney W. Grimes.It Sy Pa Second level name	Type	Changeable
45158f0484fSRodney W. Grimes.It Li CPU_CONSDEV	dev_t	no
452fb46136eSAndrey A. Chernov.It Li CPU_ADJKERNTZ	int	yes
453fb46136eSAndrey A. Chernov.It Li CPU_DISRTCSET	int	yes
45438c429d5SBruce Evans.It Li CPU_BOOTINFO	struct bootinfo	no
45538c429d5SBruce Evans.It Li CPU_WALLCLOCK	int	yes
45658f0484fSRodney W. Grimes.El
45796e430a4SAlexey Zelkin.Ss CTL_NET
45858f0484fSRodney W. GrimesThe string and integer information available for the CTL_NET level
45958f0484fSRodney W. Grimesis detailed below.
46058f0484fSRodney W. GrimesThe changeable column shows whether a process with appropriate
46158f0484fSRodney W. Grimesprivilege may change the value.
46258f0484fSRodney W. Grimes.Bl -column "Second level nameXXXXXX" "routing messagesXXX" -offset indent
46358f0484fSRodney W. Grimes.It Sy Pa Second level name	Type	Changeable
46458f0484fSRodney W. Grimes.It PF\_ROUTE	routing messages	no
4651522ff5bSJun-ichiro itojun Hagino.It PF\_INET	IPv4 values	yes
4661522ff5bSJun-ichiro itojun Hagino.It PF\_INET6	IPv6 values	yes
46758f0484fSRodney W. Grimes.El
46858f0484fSRodney W. Grimes.Pp
46958f0484fSRodney W. Grimes.Bl -tag -width "123456"
47058f0484fSRodney W. Grimes.It Li PF_ROUTE
47158f0484fSRodney W. GrimesReturn the entire routing table or a subset of it.
47258f0484fSRodney W. GrimesThe data is returned as a sequence of routing messages (see
47358f0484fSRodney W. Grimes.Xr route 4
47458f0484fSRodney W. Grimesfor the header file, format and meaning).
47558f0484fSRodney W. GrimesThe length of each message is contained in the message header.
47658f0484fSRodney W. Grimes.Pp
47758f0484fSRodney W. GrimesThe third level name is a protocol number, which is currently always 0.
47858f0484fSRodney W. GrimesThe fourth level name is an address family, which may be set to 0 to
47958f0484fSRodney W. Grimesselect all address families.
48058f0484fSRodney W. GrimesThe fifth and sixth level names are as follows:
48158f0484fSRodney W. Grimes.Bl -column "Fifth level nameXXXXXX" "Sixth level is:XXX" -offset indent
48258f0484fSRodney W. Grimes.It Pa Fifth level name	Sixth level is:
48358f0484fSRodney W. Grimes.It NET\_RT\_FLAGS	rtflags
48458f0484fSRodney W. Grimes.It NET\_RT\_DUMP	None
48558f0484fSRodney W. Grimes.It NET\_RT\_IFLIST	None
48658f0484fSRodney W. Grimes.El
48758f0484fSRodney W. Grimes.It Li PF_INET
4881522ff5bSJun-ichiro itojun HaginoGet or set various global information about the IPv4
4891522ff5bSJun-ichiro itojun Hagino.Pq Internet Protocol version 4 .
49058f0484fSRodney W. GrimesThe third level name is the protocol.
49158f0484fSRodney W. GrimesThe fourth level name is the variable name.
49258f0484fSRodney W. GrimesThe currently defined protocols and names are:
49361a4defdSJoseph Koshy.Bl -column ProtocolXX VariableXX TypeXX ChangeableXX
49461a4defdSJoseph Koshy.It Pa Protocol	Variable	Type	Changeable
4950a843f2aSJoseph Koshy.It icmp	bmcastecho	integer	yes
4960a843f2aSJoseph Koshy.It icmp	maskrepl	integer	yes
49758f0484fSRodney W. Grimes.It ip	forwarding	integer	yes
49858f0484fSRodney W. Grimes.It ip	redirect	integer	yes
49958f0484fSRodney W. Grimes.It ip	ttl	integer	yes
50058f0484fSRodney W. Grimes.It udp	checksum	integer	yes
50158f0484fSRodney W. Grimes.El
50258f0484fSRodney W. Grimes.Pp
50358f0484fSRodney W. GrimesThe variables are as follows:
50458f0484fSRodney W. Grimes.Bl -tag -width "123456"
5050a843f2aSJoseph Koshy.It Li icmp.bmcastecho
5060a843f2aSJoseph KoshyReturns 1 if an ICMP echo request to a broadcast or multicast address is
5070a843f2aSJoseph Koshyto be answered.
5080a843f2aSJoseph Koshy.It Li icmp.maskrepl
5090a843f2aSJoseph KoshyReturns 1 if ICMP network mask requests are to be answered.
51058f0484fSRodney W. Grimes.It Li ip.forwarding
51158f0484fSRodney W. GrimesReturns 1 when IP forwarding is enabled for the host,
51258f0484fSRodney W. Grimesmeaning that the host is acting as a router.
51358f0484fSRodney W. Grimes.It Li ip.redirect
51458f0484fSRodney W. GrimesReturns 1 when ICMP redirects may be sent by the host.
51558f0484fSRodney W. GrimesThis option is ignored unless the host is routing IP packets,
51658f0484fSRodney W. Grimesand should normally be enabled on all systems.
51758f0484fSRodney W. Grimes.It Li ip.ttl
51858f0484fSRodney W. GrimesThe maximum time-to-live (hop count) value for an IP packet sourced by
51958f0484fSRodney W. Grimesthe system.
52058f0484fSRodney W. GrimesThis value applies to normal transport protocols, not to ICMP.
52158f0484fSRodney W. Grimes.It Li udp.checksum
52258f0484fSRodney W. GrimesReturns 1 when UDP checksums are being computed and checked.
52358f0484fSRodney W. GrimesDisabling UDP checksums is strongly discouraged.
5241522ff5bSJun-ichiro itojun Hagino.Pp
5258a3c1270SJun-ichiro itojun HaginoFor variables net.inet.*.ipsec, please refer to
5261522ff5bSJun-ichiro itojun Hagino.Xr ipsec 4 .
5271522ff5bSJun-ichiro itojun Hagino.El
5281522ff5bSJun-ichiro itojun Hagino.It Li PF_INET6
5291522ff5bSJun-ichiro itojun HaginoGet or set various global information about the IPv6
5301522ff5bSJun-ichiro itojun Hagino.Pq Internet Protocol version 6 .
5311522ff5bSJun-ichiro itojun HaginoThe third level name is the protocol.
5321522ff5bSJun-ichiro itojun HaginoThe fourth level name is the variable name.
5331522ff5bSJun-ichiro itojun Hagino.Pp
5348a3c1270SJun-ichiro itojun HaginoFor variables net.inet6.* please refer to
5358a3c1270SJun-ichiro itojun Hagino.Xr inet6 4 .
5368a3c1270SJun-ichiro itojun HaginoFor variables net.inet6.*.ipsec6, please refer to
5371522ff5bSJun-ichiro itojun Hagino.Xr ipsec 4 .
53858f0484fSRodney W. Grimes.El
53996e430a4SAlexey Zelkin.Ss CTL_USER
54058f0484fSRodney W. GrimesThe string and integer information available for the CTL_USER level
54158f0484fSRodney W. Grimesis detailed below.
54258f0484fSRodney W. GrimesThe changeable column shows whether a process with appropriate
54358f0484fSRodney W. Grimesprivilege may change the value.
54458f0484fSRodney W. Grimes.Bl -column "USER_COLL_WEIGHTS_MAXXXX" "integerXXX" -offset indent
54558f0484fSRodney W. Grimes.It Sy Pa Second level name	Type	Changeable
54658f0484fSRodney W. Grimes.It USER\_BC\_BASE\_MAX	integer	no
54758f0484fSRodney W. Grimes.It USER\_BC\_DIM\_MAX	integer	no
54858f0484fSRodney W. Grimes.It USER\_BC\_SCALE\_MAX	integer	no
54958f0484fSRodney W. Grimes.It USER\_BC\_STRING\_MAX	integer	no
55058f0484fSRodney W. Grimes.It USER\_COLL\_WEIGHTS\_MAX	integer	no
55158f0484fSRodney W. Grimes.It USER\_CS\_PATH	string	no
55258f0484fSRodney W. Grimes.It USER\_EXPR\_NEST\_MAX	integer	no
55358f0484fSRodney W. Grimes.It USER\_LINE\_MAX	integer	no
55458f0484fSRodney W. Grimes.It USER\_POSIX2\_CHAR\_TERM	integer	no
55558f0484fSRodney W. Grimes.It USER\_POSIX2\_C\_BIND	integer	no
55658f0484fSRodney W. Grimes.It USER\_POSIX2\_C\_DEV	integer	no
55758f0484fSRodney W. Grimes.It USER\_POSIX2\_FORT\_DEV	integer	no
55858f0484fSRodney W. Grimes.It USER\_POSIX2\_FORT\_RUN	integer	no
55958f0484fSRodney W. Grimes.It USER\_POSIX2\_LOCALEDEF	integer	no
56058f0484fSRodney W. Grimes.It USER\_POSIX2\_SW\_DEV	integer	no
56158f0484fSRodney W. Grimes.It USER\_POSIX2\_UPE	integer	no
56258f0484fSRodney W. Grimes.It USER\_POSIX2\_VERSION	integer	no
56358f0484fSRodney W. Grimes.It USER\_RE\_DUP\_MAX	integer	no
56458f0484fSRodney W. Grimes.It USER\_STREAM\_MAX	integer	no
56558f0484fSRodney W. Grimes.It USER\_TZNAME\_MAX	integer	no
56658f0484fSRodney W. Grimes.El
56758f0484fSRodney W. Grimes.Bl -tag -width "123456"
56858f0484fSRodney W. Grimes.Pp
56958f0484fSRodney W. Grimes.It Li USER_BC_BASE_MAX
57058f0484fSRodney W. GrimesThe maximum ibase/obase values in the
57158f0484fSRodney W. Grimes.Xr bc 1
57258f0484fSRodney W. Grimesutility.
57358f0484fSRodney W. Grimes.It Li USER_BC_DIM_MAX
57458f0484fSRodney W. GrimesThe maximum array size in the
57558f0484fSRodney W. Grimes.Xr bc 1
57658f0484fSRodney W. Grimesutility.
57758f0484fSRodney W. Grimes.It Li USER_BC_SCALE_MAX
57858f0484fSRodney W. GrimesThe maximum scale value in the
57958f0484fSRodney W. Grimes.Xr bc 1
58058f0484fSRodney W. Grimesutility.
58158f0484fSRodney W. Grimes.It Li USER_BC_STRING_MAX
58258f0484fSRodney W. GrimesThe maximum string length in the
58358f0484fSRodney W. Grimes.Xr bc 1
58458f0484fSRodney W. Grimesutility.
58558f0484fSRodney W. Grimes.It Li USER_COLL_WEIGHTS_MAX
58658f0484fSRodney W. GrimesThe maximum number of weights that can be assigned to any entry of
58758f0484fSRodney W. Grimesthe LC_COLLATE order keyword in the locale definition file.
58858f0484fSRodney W. Grimes.It Li USER_CS_PATH
58958f0484fSRodney W. GrimesReturn a value for the
59058f0484fSRodney W. Grimes.Ev PATH
59158f0484fSRodney W. Grimesenvironment variable that finds all the standard utilities.
59258f0484fSRodney W. Grimes.It Li USER_EXPR_NEST_MAX
59358f0484fSRodney W. GrimesThe maximum number of expressions that can be nested within
59458f0484fSRodney W. Grimesparenthesis by the
59558f0484fSRodney W. Grimes.Xr expr 1
59658f0484fSRodney W. Grimesutility.
59758f0484fSRodney W. Grimes.It Li USER_LINE_MAX
59858f0484fSRodney W. GrimesThe maximum length in bytes of a text-processing utility's input
59958f0484fSRodney W. Grimesline.
60058f0484fSRodney W. Grimes.It Li USER_POSIX2_CHAR_TERM
60158f0484fSRodney W. GrimesReturn 1 if the system supports at least one terminal type capable of
60258f0484fSRodney W. Grimesall operations described in POSIX 1003.2, otherwise 0.
60358f0484fSRodney W. Grimes.It Li USER_POSIX2_C_BIND
60458f0484fSRodney W. GrimesReturn 1 if the system's C-language development facilities support the
60558f0484fSRodney W. GrimesC-Language Bindings Option, otherwise 0.
60658f0484fSRodney W. Grimes.It Li USER_POSIX2_C_DEV
60758f0484fSRodney W. GrimesReturn 1 if the system supports the C-Language Development Utilities Option,
60858f0484fSRodney W. Grimesotherwise 0.
60958f0484fSRodney W. Grimes.It Li USER_POSIX2_FORT_DEV
61058f0484fSRodney W. GrimesReturn 1 if the system supports the FORTRAN Development Utilities Option,
61158f0484fSRodney W. Grimesotherwise 0.
61258f0484fSRodney W. Grimes.It Li USER_POSIX2_FORT_RUN
61358f0484fSRodney W. GrimesReturn 1 if the system supports the FORTRAN Runtime Utilities Option,
61458f0484fSRodney W. Grimesotherwise 0.
61558f0484fSRodney W. Grimes.It Li USER_POSIX2_LOCALEDEF
61658f0484fSRodney W. GrimesReturn 1 if the system supports the creation of locales, otherwise 0.
61758f0484fSRodney W. Grimes.It Li USER_POSIX2_SW_DEV
61858f0484fSRodney W. GrimesReturn 1 if the system supports the Software Development Utilities Option,
61958f0484fSRodney W. Grimesotherwise 0.
62058f0484fSRodney W. Grimes.It Li USER_POSIX2_UPE
62158f0484fSRodney W. GrimesReturn 1 if the system supports the User Portability Utilities Option,
62258f0484fSRodney W. Grimesotherwise 0.
62358f0484fSRodney W. Grimes.It Li USER_POSIX2_VERSION
62458f0484fSRodney W. GrimesThe version of POSIX 1003.2 with which the system attempts to comply.
62558f0484fSRodney W. Grimes.It Li USER_RE_DUP_MAX
62658f0484fSRodney W. GrimesThe maximum number of repeated occurrences of a regular expression
62758f0484fSRodney W. Grimespermitted when using interval notation.
62858f0484fSRodney W. Grimes.It Li USER_STREAM_MAX
62958f0484fSRodney W. GrimesThe minimum maximum number of streams that a process may have open
63058f0484fSRodney W. Grimesat any one time.
63158f0484fSRodney W. Grimes.It Li USER_TZNAME_MAX
63258f0484fSRodney W. GrimesThe minimum maximum number of types supported for the name of a
63358f0484fSRodney W. Grimestimezone.
63458f0484fSRodney W. Grimes.El
63596e430a4SAlexey Zelkin.Ss CTL_VM
63658f0484fSRodney W. GrimesThe string and integer information available for the CTL_VM level
63758f0484fSRodney W. Grimesis detailed below.
63858f0484fSRodney W. GrimesThe changeable column shows whether a process with appropriate
63958f0484fSRodney W. Grimesprivilege may change the value.
64058f0484fSRodney W. Grimes.Bl -column "Second level nameXXXXXX" "struct loadavgXXX" -offset indent
64158f0484fSRodney W. Grimes.It Sy Pa Second level name	Type	Changeable
64258f0484fSRodney W. Grimes.It VM\_LOADAVG	struct loadavg	no
64358f0484fSRodney W. Grimes.It VM\_METER	struct vmtotal	no
644b697833cSGuy Helmer.It VM\_PAGEOUT\_ALGORITHM	integer	yes
645b697833cSGuy Helmer.It VM\_SWAPPING\_ENABLED	integer	maybe
646b697833cSGuy Helmer.It VM\_V\_CACHE\_MAX	integer	yes
647b697833cSGuy Helmer.It VM\_V\_CACHE\_MIN	integer	yes
648b697833cSGuy Helmer.It VM\_V\_FREE\_MIN	integer	yes
649b697833cSGuy Helmer.It VM\_V\_FREE\_RESERVED	integer	yes
650b697833cSGuy Helmer.It VM\_V\_FREE\_TARGET	integer	yes
651b697833cSGuy Helmer.It VM\_V\_INACTIVE\_TARGET	integer	yes
652b697833cSGuy Helmer.It VM\_V\_PAGEOUT\_FREE\_MIN	integer	yes
65358f0484fSRodney W. Grimes.El
65458f0484fSRodney W. Grimes.Pp
65558f0484fSRodney W. Grimes.Bl -tag -width "123456"
65658f0484fSRodney W. Grimes.It Li VM_LOADAVG
65758f0484fSRodney W. GrimesReturn the load average history.
65858f0484fSRodney W. GrimesThe returned data consists of a
65958f0484fSRodney W. Grimes.Va struct loadavg .
66058f0484fSRodney W. Grimes.It Li VM_METER
66158f0484fSRodney W. GrimesReturn the system wide virtual memory statistics.
66258f0484fSRodney W. GrimesThe returned data consists of a
66358f0484fSRodney W. Grimes.Va struct vmtotal .
664b697833cSGuy Helmer.It Li VM_PAGEOUT_ALGORITHM
665b697833cSGuy Helmer0 if the statistics-based page management algorithm is in use
666b697833cSGuy Helmeror 1 if the near-LRU algorithm is in use.
667b697833cSGuy Helmer.It Li VM_SWAPPING_ENABLED
668b697833cSGuy Helmer1 if process swapping is enabled or 0 if disabled.  This variable is
669b697833cSGuy Helmerpermanently set to 0 if the kernel was built with swapping disabled.
670b697833cSGuy Helmer.It Li VM_V_CACHE_MAX
671b697833cSGuy HelmerMaximum desired size of the cache queue.
672b697833cSGuy Helmer.It Li VM_V_CACHE_MIN
673b697833cSGuy HelmerMinimum desired size of the cache queue.  If the cache queue size
674b697833cSGuy Helmerfalls very far below this value, the pageout daemon is awakened.
675b697833cSGuy Helmer.It Li VM_V_FREE_MIN
676b697833cSGuy HelmerMinimum amount of memory (cache memory plus free memory)
677b697833cSGuy Helmerrequired to be available before a process waiting on memory will be
678b697833cSGuy Helmerawakened.
679b697833cSGuy Helmer.It Li VM_V_FREE_RESERVED
680b697833cSGuy HelmerProcesses will awaken the pageout daemon and wait for memory if the
681b697833cSGuy Helmernumber of free and cached pages drops below this value.
682b697833cSGuy Helmer.It Li VM_V_FREE_TARGET
683b697833cSGuy HelmerThe total amount of free memory (including cache memory) that the
684b697833cSGuy Helmerpageout daemon tries to maintain.
685b697833cSGuy Helmer.It Li VM_V_INACTIVE_TARGET
686b697833cSGuy HelmerThe desired number of inactive pages that the pageout daemon should
687b697833cSGuy Helmerachieve when it runs.  Inactive pages can be quickly inserted into
688b697833cSGuy Helmerprocess address space when needed.
689b697833cSGuy Helmer.It Li VM_V_PAGEOUT_FREE_MIN
690b697833cSGuy HelmerIf the amount of free and cache memory falls below this value, the
691b697833cSGuy Helmerpageout daemon will enter "memory conserving mode" to avoid deadlock.
69258f0484fSRodney W. Grimes.El
69358f0484fSRodney W. Grimes.Sh RETURN VALUES
694bf5a138eSMike Pritchard.Fn sysctl
695eec1dbe6SDag-Erling Smørgravand
696eec1dbe6SDag-Erling Smørgrav.Fn sysctlbyname
697eec1dbe6SDag-Erling Smørgravreturn 0 when successful.
69858f0484fSRodney W. GrimesOtherwise \-1 is returned and
69958f0484fSRodney W. Grimes.Va errno
70058f0484fSRodney W. Grimesis set appropriately.
70158f0484fSRodney W. Grimes.Sh ERRORS
70258f0484fSRodney W. GrimesThe following errors may be reported:
70358f0484fSRodney W. Grimes.Bl -tag -width Er
70458f0484fSRodney W. Grimes.It Bq Er EFAULT
70558f0484fSRodney W. GrimesThe buffer
70658f0484fSRodney W. Grimes.Fa name ,
70758f0484fSRodney W. Grimes.Fa oldp ,
70858f0484fSRodney W. Grimes.Fa newp ,
70958f0484fSRodney W. Grimesor length pointer
71058f0484fSRodney W. Grimes.Fa oldlenp
71158f0484fSRodney W. Grimescontains an invalid address.
71258f0484fSRodney W. Grimes.It Bq Er EINVAL
71358f0484fSRodney W. GrimesThe
71458f0484fSRodney W. Grimes.Fa name
71558f0484fSRodney W. Grimesarray is less than two or greater than CTL_MAXNAME.
71658f0484fSRodney W. Grimes.It Bq Er EINVAL
71758f0484fSRodney W. GrimesA non-null
71858f0484fSRodney W. Grimes.Fa newp
71958f0484fSRodney W. Grimesis given and its specified length in
72058f0484fSRodney W. Grimes.Fa newlen
72158f0484fSRodney W. Grimesis too large or too small.
72258f0484fSRodney W. Grimes.It Bq Er ENOMEM
72358f0484fSRodney W. GrimesThe length pointed to by
72458f0484fSRodney W. Grimes.Fa oldlenp
72558f0484fSRodney W. Grimesis too short to hold the requested value.
72658f0484fSRodney W. Grimes.It Bq Er ENOTDIR
72758f0484fSRodney W. GrimesThe
72858f0484fSRodney W. Grimes.Fa name
72958f0484fSRodney W. Grimesarray specifies an intermediate rather than terminal name.
730226420a4SBrian Feldman.It Bq Er EISDIR
731226420a4SBrian FeldmanThe
732226420a4SBrian Feldman.Fa name
733226420a4SBrian Feldmanarray specifies a terminal name, but the actual name is not terminal.
73458f0484fSRodney W. Grimes.It Bq Er EOPNOTSUPP
73558f0484fSRodney W. GrimesThe
73658f0484fSRodney W. Grimes.Fa name
73758f0484fSRodney W. Grimesarray specifies a value that is unknown.
73858f0484fSRodney W. Grimes.It Bq Er EPERM
73958f0484fSRodney W. GrimesAn attempt is made to set a read-only value.
74058f0484fSRodney W. Grimes.It Bq Er EPERM
74158f0484fSRodney W. GrimesA process without appropriate privilege attempts to set a value.
74258f0484fSRodney W. Grimes.El
74358f0484fSRodney W. Grimes.Sh FILES
74458f0484fSRodney W. Grimes.Bl -tag -width <netinet/icmpXvar.h> -compact
74596e430a4SAlexey Zelkin.It Aq Pa sys/sysctl.h
74658f0484fSRodney W. Grimesdefinitions for top level identifiers, second level kernel and hardware
74758f0484fSRodney W. Grimesidentifiers, and user level identifiers
74896e430a4SAlexey Zelkin.It Aq Pa sys/socket.h
74958f0484fSRodney W. Grimesdefinitions for second level network identifiers
75096e430a4SAlexey Zelkin.It Aq Pa sys/gmon.h
75158f0484fSRodney W. Grimesdefinitions for third level profiling identifiers
75296e430a4SAlexey Zelkin.It Aq Pa vm/vm_param.h
75358f0484fSRodney W. Grimesdefinitions for second level virtual memory identifiers
75496e430a4SAlexey Zelkin.It Aq Pa netinet/in.h
7551522ff5bSJun-ichiro itojun Haginodefinitions for third level IPv4/IPv6 identifiers and
7561522ff5bSJun-ichiro itojun Haginofourth level IPv4/v6 identifiers
75796e430a4SAlexey Zelkin.It Aq Pa netinet/icmp_var.h
75858f0484fSRodney W. Grimesdefinitions for fourth level ICMP identifiers
75996e430a4SAlexey Zelkin.It Aq Pa netinet/icmp6.h
7601522ff5bSJun-ichiro itojun Haginodefinitions for fourth level ICMPv6 identifiers
76196e430a4SAlexey Zelkin.It Aq Pa netinet/udp_var.h
76258f0484fSRodney W. Grimesdefinitions for fourth level UDP identifiers
76358f0484fSRodney W. Grimes.El
76458f0484fSRodney W. Grimes.Sh SEE ALSO
76538cf6319SEivind Eklund.Xr sysconf 3 ,
766f5a78334SJoseph Koshy.Xr sysctl 8
76758f0484fSRodney W. Grimes.Sh HISTORY
76858f0484fSRodney W. GrimesThe
769bf5a138eSMike Pritchard.Fn sysctl
7707bdf80e5SMike Pritchardfunction first appeared in
7717bdf80e5SMike Pritchard.Bx 4.4 .
772