xref: /netbsd-src/lib/libc/gen/sysctl.3 (revision bcc8ec9959e7b01e313d813067bfb43a3ad70551)
1.\"	$NetBSD: sysctl.3,v 1.72 2001/01/10 03:03:02 hubertf Exp $
2.\"
3.\" Copyright (c) 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by the University of
17.\"	California, Berkeley and its contributors.
18.\" 4. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\"	@(#)sysctl.3	8.4 (Berkeley) 5/9/95
35.\"
36.Dd June 24, 1999
37.Dt SYSCTL 3
38.Os
39.Sh NAME
40.Nm sysctl
41.Nd get or set system information
42.Sh LIBRARY
43.Lb libc
44.Sh SYNOPSIS
45.Fd #include <sys/param.h>
46.Fd #include <sys/sysctl.h>
47.Ft int
48.Fn sysctl "int *name" "u_int namelen" "void *oldp" "size_t *oldlenp" "void *newp" "size_t newlen"
49.Sh DESCRIPTION
50The
51.Nm
52function retrieves system information and allows processes with
53appropriate privileges to set system information.
54The information available from
55.Nm
56consists of integers, strings, and tables.
57Information may be retrieved and set from the command interface
58using the
59.Xr sysctl 8
60utility.
61.Pp
62Unless explicitly noted below,
63.Nm
64returns a consistent snapshot of the data requested.
65Consistency is obtained by locking the destination
66buffer into memory so that the data may be copied out without blocking.
67Calls to
68.Nm
69are serialized to avoid deadlock.
70.Pp
71The state is described using a ``Management Information Base'' (MIB)
72style name, listed in
73.Fa name ,
74which is a
75.Fa namelen
76length array of integers.
77.Pp
78The information is copied into the buffer specified by
79.Fa oldp .
80The size of the buffer is given by the location specified by
81.Fa oldlenp
82before the call,
83and that location gives the amount of data copied after a successful call.
84If the amount of data available is greater
85than the size of the buffer supplied,
86the call supplies as much data as fits in the buffer provided
87and returns with the error code ENOMEM.
88If the old value is not desired,
89.Fa oldp
90and
91.Fa oldlenp
92should be set to NULL.
93.Pp
94The size of the available data can be determined by calling
95.Nm
96with a NULL parameter for
97.Fa oldp .
98The size of the available data will be returned in the location pointed to by
99.Fa oldlenp .
100For some operations, the amount of space may change often.
101For these operations,
102the system attempts to round up so that the returned size is
103large enough for a call to return the data shortly thereafter.
104.Pp
105To set a new value,
106.Fa newp
107is set to point to a buffer of length
108.Fa newlen
109from which the requested value is to be taken.
110If a new value is not to be set,
111.Fa newp
112should be set to NULL and
113.Fa newlen
114set to 0.
115.Pp
116The top level names are defined with a CTL_ prefix in
117.Pa <sys/sysctl.h> ,
118and are as follows.
119The next and subsequent levels down are found in the include files
120listed here, and described in separate sections below.
121.Pp
122.Bl -column CTLXMACHDEPXXX "Next level namesXXXXXX" -offset indent
123.It Sy Pa Name	Next level names	Description
124.It CTL\_KERN	sys/sysctl.h	High kernel limits
125.It CTL\_VM	uvm/uvm_param.h	Virtual memory
126.It CTL\_VFS	sys/mount.h	Filesystem
127.It CTL\_NET	sys/socket.h	Networking
128.It CTL\_DEBUG	sys/sysctl.h	Debugging
129.It CTL\_HW	sys/sysctl.h	Generic CPU, I/O
130.It CTL\_MACHDEP	sys/sysctl.h	Machine dependent
131.It CTL\_USER	sys/sysctl.h	User-level
132.It CTL\_DDB	sys/sysctl.h	In-kernel debugger
133.It CTL\_PROC	sys/sysctl.h	Per-process
134.It CTL\_VENDOR	?	Vendor specific
135.El
136.Pp
137For example, the following retrieves the maximum number of processes allowed
138in the system:
139.Bd -literal -offset indent -compact
140int mib[2], maxproc;
141size_t len;
142.sp
143mib[0] = CTL_KERN;
144mib[1] = KERN_MAXPROC;
145len = sizeof(maxproc);
146sysctl(mib, 2, &maxproc, &len, NULL, 0);
147.Ed
148.sp
149To retrieve the standard search path for the system utilities:
150.Bd -literal -offset indent -compact
151int mib[2];
152size_t len;
153char *p;
154.sp
155mib[0] = CTL_USER;
156mib[1] = USER_CS_PATH;
157sysctl(mib, 2, NULL, &len, NULL, 0);
158p = malloc(len);
159sysctl(mib, 2, p, &len, NULL, 0);
160.Ed
161.Sh CTL_DEBUG
162The debugging variables vary from system to system.
163A debugging variable may be added or deleted without need to recompile
164.Nm
165to know about it.
166Each time it runs,
167.Nm
168gets the list of debugging variables from the kernel and
169displays their current values.
170The system defines twenty
171.Ns ( Va struct ctldebug )
172variables named
173.Dv debug0
174through
175.Dv debug19 .
176They are declared as separate variables so that they can be
177individually initialized at the location of their associated variable.
178The loader prevents multiple use of the same variable by issuing errors
179if a variable is initialized in more than one place.
180For example, to export the variable
181.Dv dospecialcheck
182as a debugging variable, the following declaration would be used:
183.Bd -literal -offset indent -compact
184int dospecialcheck = 1;
185struct ctldebug debug5 = { "dospecialcheck", &dospecialcheck };
186.Ed
187.Sh CTL_VFS
188A distinguished second level name, VFS_GENERIC,
189is used to get general information about all filesystems.
190One of its third level identifiers is VFS_MAXTYPENUM
191that gives the highest valid filesystem type number.
192Its other third level identifier is VFS_CONF that
193returns configuration information about the filesystem
194type given as a fourth level identifier.
195The remaining second level identifiers are the
196filesystem type number returned by a
197.Xr statfs 2
198call or from VFS_CONF.
199The third level identifiers available for each filesystem
200are given in the header file that defines the mount
201argument structure for that filesystem.
202.Sh CTL_HW
203The string and integer information available for the CTL_HW level
204is detailed below.
205The changeable column shows whether a process with appropriate
206privilege may change the value.
207.Bl -column "Second level nameXXXXXX" integerXXX -offset indent
208.It Sy Pa Second level name	Type	Changeable
209.It HW\_MACHINE	string	no
210.It HW\_MODEL	string	no
211.It HW\_NCPU	integer	no
212.It HW\_BYTEORDER	integer	no
213.It HW\_PHYSMEM	integer	no
214.It HW\_USERMEM	integer	no
215.It HW\_PAGESIZE	integer	no
216.\".It HW\_DISKNAMES	struct	no
217.\".It HW\_DISKSTATS	struct	no
218.It HW\_MACHINE\_ARCH	string	no
219.It HW\_ALIGNBYTES	integer	no
220.El
221.Pp
222.Bl -tag -width "123456"
223.It Li HW_MACHINE
224The machine class.
225.It Li HW_MODEL
226The machine model
227.It Li HW_NCPU
228The number of cpus.
229.ne 1i
230.It Li HW_BYTEORDER
231The byteorder (4,321, or 1,234).
232.It Li HW_PHYSMEM
233The bytes of physical memory.
234.It Li HW_USERMEM
235The bytes of non-kernel memory.
236.It Li HW_PAGESIZE
237The software page size.
238.\".It Fa HW_DISKNAMES
239.\".It Fa HW_DISKSTATS
240.It Li HW_MACHINE_ARCH
241The machine cpu class.
242.It Li HW_ALIGNBYTES
243Alignment constraint for all possible data types.
244This shows the value
245.Dv ALIGNBYTES
246in
247.Pa /usr/include/machine/param.h ,
248at the kernel compilation time.
249.El
250.Sh CTL_KERN
251The string and integer information available for the CTL_KERN level
252is detailed below.
253The changeable column shows whether a process with appropriate
254privilege may change the value.
255The types of data currently available are process information,
256system vnodes, the open file entries, routing table entries,
257virtual memory statistics, load average history, and clock rate
258information.
259.Bl -column "KERNXCHOWNXRESTRICTEDXXX" "struct clockrateXXX" -offset indent
260.It Sy Pa Second level name	Type	Changeable
261.It KERN\_ARGMAX	integer	no
262.It KERN\_AUTONICETIME	integer	yes
263.It KERN\_AUTONICEVAL	integer	yes
264.It KERN\_BOOTTIME	struct timeval	no
265.It KERN\_CCPU	integer	no
266.It KERN\_CLOCKRATE	struct clockinfo	no
267.It KERN\_CP\_TIME	long[\|]	no
268.It KERN\_DEFCORENAME	string	yes
269.It KERN\_DOMAINNAME	string	yes
270.It KERN\_FILE	struct file	no
271.It KERN\_FSCALE	integer	no
272.It KERN\_FSYNC	integer	no
273.It KERN\_HOSTID	integer	yes
274.It KERN\_HOSTNAME	string	yes
275.It KERN\_IOV\_MAX	integer	no
276.It KERN\_JOB\_CONTROL	integer	no
277.It KERN\_LOGIN\_NAME\_MAX	integer	no
278.It KERN\_LOGSIGEXIT	integer	yes
279.It KERN\_MAPPED\_FILES	integer	no
280.It KERN\_MAXFILES	integer	yes
281.It KERN\_MAXPARTITIONS	integer	no
282.It KERN\_MAXPROC	integer	yes
283.It KERN\_MAXPTYS	integer	yes
284.It KERN\_MAXVNODES	integer	yes
285.It KERN\_MBUF	node	not applicable
286.It KERN\_MEMLOCK	integer	no
287.It KERN\_MEMLOCK\_RANGE	integer	no
288.It KERN\_MEMORY\_PROTECTION	integer	no
289.It KERN\_MSGBUF	char[\|]	no
290.It KERN\_MSGBUFSIZE	integer	no
291.It KERN\_NGROUPS	integer	no
292.It KERN\_NTPTIME	struct ntptimeval	no
293.It KERN\_OSRELEASE	string	no
294.It KERN\_OSREV	integer	no
295.It KERN\_OSTYPE	string	no
296.It KERN\_POSIX1	integer	no
297.It KERN\_PROC	struct kinfo_proc	no
298.It KERN\_PROC2	struct kinfo_proc2	no
299.It KERN\_PROC\_ARGS	string	no
300.It KERN\_PROF	node	not applicable
301.It KERN\_RAWPARTITION	integer	no
302.It KERN\_ROOT\_DEVICE	string	no
303.It KERN\_RTC\_OFFSET	integer	yes
304.It KERN\_SAVED\_IDS	integer	no
305.It KERN\_SECURELVL	integer	raise only
306.It KERN\_SYNCHRONIZED\_IO	integer	no
307.It KERN\_SYSVIPC\_INFO	node	not applicable
308.It KERN\_SYSVMSG	integer	no
309.It KERN\_SYSVSEM	integer	no
310.It KERN\_SYSVSHM	integer	no
311.It KERN\_VERSION	string	no
312.It KERN\_VNODE	struct vnode	no
313.El
314.ne 1i
315.Pp
316.Bl -tag -width "123456"
317.It Li KERN_ARGMAX
318The maximum bytes of argument to
319.Xr execve 2 .
320.It Li KERN_AUTONICETIME
321The number of seconds of cpu-time a non-root process may accumulate before
322having its priority lowered from the default to the value of KERN_AUTONICEVAL.
323If set to 0, automatic lowering of priority is not performed, and if set to -1
324all non-root processes are immediately lowered.
325.It Li KERN_AUTONICEVAL
326The priority assigned for automatically niced processes.
327.It Li KERN_BOOTTIME
328A
329.Va struct timeval
330structure is returned.
331This structure contains the time that the system was booted.
332.It Li KERN_CCPU
333The scheduler exponential decay value.
334.It Li KERN_CLOCKRATE
335A
336.Va struct clockinfo
337structure is returned.
338This structure contains the clock, statistics clock and profiling clock
339frequencies, the number of micro-seconds per hz tick, and the clock
340skew rate.
341.It Li KERN_CP_TIME
342Return an array if CPUSTATES longs is returned.  This array contains the
343number of clock ticks spent in different CPU states.
344.It Li KERN_DEFCORENAME
345Default template for the name of core dump files (see also PROC_PID_CORENAME
346in the per-process variables CTL_PROC, and
347.Xr core 5
348for format of this template).  The default value is
349.Nm %n.core
350and can be changed with the kernel configuration option
351.Cd options DEFCORENAME
352(see
353.Xr options 4
354).
355.It Li KERN_DOMAINNAME
356Get or set the YP domain name.
357.It Li KERN_FILE
358Return the entire file table.
359The returned data consists of a single
360.Va struct filehead
361followed by an array of
362.Va struct file ,
363whose size depends on the current number of such objects in the system.
364.It Li KERN_FSCALE
365The kernel fixed-point scale factor.
366.It Li KERN_FSYNC
367Return 1 if the POSIX 1003.1b File Synchronization Option is available
368on this system,
369otherwise 0.
370.It Li KERN_HOSTID
371Get or set the host id.
372.It Li KERN_HOSTNAME
373Get or set the hostname.
374.It Li KERN_IOV_MAX
375Return the maximum number of
376.Va iovec
377structures that a process has available for use with
378.Xr preadv 2 ,
379.Xr pwritev 2 ,
380.Xr readv 2 ,
381.Xr recvmsg 2 ,
382.Xr sendmsg 2
383and
384.Xr writev 2 .
385.It Li KERN_JOB_CONTROL
386Return 1 if job control is available on this system, otherwise 0.
387.It Li KERN_LOGIN_NAME_MAX
388The size of the storage required for a login name, in bytes,
389including the terminating NUL.
390.It Li KERN_LOGSIGEXIT
391If this flag is non-zero, the kernel will
392.Xr log 9
393all process exits due to signals which create a
394.Xr core 5
395file, and whether the coredump was created.
396.It Li KERN_MAPPED_FILES
397Returns 1 if the POSIX 1003.1b Memory Mapped Files Option is available
398on this system,
399otherwise 0.
400.It Li KERN_MAXFILES
401The maximum number of open files that may be open in the system.
402.It Li KERN_MAXPARTITIONS
403The maximum number of partitions allowed per disk.
404.It Li KERN_MAXPROC
405The maximum number of simultaneous processes the system will allow.
406.It Li KERN_MAXPTYS
407The maximum number of pseudo terminals. This value can be both
408raised and lowered, though it cannot
409be set lower than number of currently used ptys.  See also
410.Xr pty 4 .
411.It Li KERN_MAXVNODES
412The maximum number of vnodes available on the system. This can only
413be raised.
414.It Li KERN_MBUF
415Return information about the mbuf control variables.
416the third level names for the mbuf variables are detailed below.
417The changeable column shows whether a process with appropriate
418privilege may change the value.
419.Bl -column "MBUFXNMBCLUSTERSXXX" "struct integerXXX" -offset indent
420.It MBUF\_MSIZE	integer	yes
421.It MBUF\_MCLBYTES	integer	yes
422.It MBUF\_NMBCLUSTERS	integer	yes
423.It MBUF\_MBLOWAT	integer	yes
424.It MBUF\_MCLLOWAT	integer	yes
425.El
426.Pp
427The variables are as follows:
428.Bl -tag -width "123456"
429.It Li MBUF_MSIZE
430The mbuf base size.
431.It Li MBUF_MCLBYTES
432The mbuf cluster size.
433.It Li MBUF_NMBCLUSTERS
434The limit on the number of mbuf clusters.
435The variable can only be increased, and only increased on machines with
436direct-mapped pool pages
437.It Li MBUF_MBLOWAT
438The mbuf low water mark.
439.It Li MBUF_MCLLOWAT
440The mbuf cluster low water mark.
441.El
442.It Li KERN_MEMLOCK
443Returns 1 if the POSIX 1003.1b Process Memory Locking Option is available
444on this system,
445otherwise 0.
446.It Li KERN_MEMLOCK_RANGE
447Returns 1 if the POSIX 1003.1b Range Memory Locking Option is available
448on this system,
449otherwise 0.
450.It Li KERN_MEMORY_PROTECTION
451Returns 1 if the POSIX 1003.1b Memory Protection Option is available
452on this system,
453otherwise 0.
454.It Li KERN_MSGBUF
455The kernel message buffer, rotated so that the head of the circular kernel
456message buffer is returned at the start of the buffer specified by
457.Fa oldp .
458The returned data may contain NUL bytes.
459.It Li KERN_MSGBUFSIZE
460The maximum number of characters that the kernel message buffer can hold.
461.It Li KERN_NGROUPS
462The maximum number of supplemental groups.
463.It Li KERN_NO_TRUNC
464Return 1 if file names longer than KERN_NAME_MAX are truncated.
465.It Li KERN_NTPTIME
466A
467.Va struct ntptimeval
468structure is returned.
469This structure contains data used by the
470.Xr ntpd 8
471program.
472.It Li KERN_OSRELEASE
473The system release string.
474.It Li KERN_OSREV
475The system revision string.
476.It Li KERN_OSTYPE
477The system type string.
478.It Li KERN_PATH_MAX
479The maximum number of bytes in a pathname.
480.It Li KERN_POSIX1
481The version of ISO/IEC 9945 (POSIX 1003.1) with which the system
482attempts to comply.
483.It Li KERN_PROC
484Return the entire process table, or a subset of it.
485An array of
486.Va struct kinfo_proc
487structures is returned,
488whose size depends on the current number of such objects in the system.
489The third and fourth level names are as follows:
490.Bl -column "Third level nameXXXXXX" "Fourth level is:XXXXXX" -offset indent
491.It Pa Third level name	Fourth level is:
492.It KERN\_PROC\_ALL	None
493.It KERN\_PROC\_PID	A process ID
494.It KERN\_PROC\_PGRP	A process group
495.It KERN\_PROC\_SESSION	A session ID
496.It KERN\_PROC\_TTY	A tty device
497.It KERN\_PROC\_UID	A user ID
498.It KERN\_PROC\_RUID	A real user ID
499.It KERN\_PROC\_GID	A group ID
500.It KERN\_PROC\_RGID	A real group ID
501.El
502.It Li KERN_PROC2
503As for KERN_PROC, but an array of
504.Va struct kinfo_proc2
505structures are returned.  The fifth level name is the size of the
506.Va struct kinfo_proc2
507and the sixth level name is the number of structures to return.
508.It Li KERN_PROC_ARGS
509Return the argv or environment strings (or the number thereof)
510of a process.  Multiple strings are returned separated by NUL
511characters.  The third level name is the process ID.  The fourth
512level name is as follows:
513.Bl -column "Third level nameXXXXXX" -offset indent
514.It KERN\_PROC\_ARGV	The argv strings
515.It KERN\_PROC\_NARGV	The number of argv strings
516.It KERN\_PROC\_ENV	The environ strings
517.It KERN\_PROC\_NENV	The number of environ strings
518.El
519.It Li KERN_PROF
520Return profiling information about the kernel.
521If the kernel is not compiled for profiling,
522attempts to retrieve any of the KERN_PROF values will
523fail with EOPNOTSUPP.
524The third level names for the string and integer profiling information
525is detailed below.
526The changeable column shows whether a process with appropriate
527privilege may change the value.
528.Bl -column "GPROFXGMONPARAMXXX" "struct gmonparamXXX" -offset indent
529.It Sy Pa Third level name	Type	Changeable
530.It GPROF\_STATE	integer	yes
531.It GPROF\_COUNT	u_short[\|]	yes
532.It GPROF\_FROMS	u_short[\|]	yes
533.It GPROF\_TOS	struct tostruct	yes
534.It GPROF\_GMONPARAM	struct gmonparam	no
535.El
536.Pp
537The variables are as follows:
538.Bl -tag -width "123456"
539.It Li GPROF_STATE
540Returns GMON_PROF_ON or GMON_PROF_OFF to show that profiling
541is running or stopped.
542.It Li GPROF_COUNT
543Array of statistical program counter counts.
544.It Li GPROF_FROMS
545Array indexed by program counter of call-from points.
546.It Li GPROF_TOS
547Array of
548.Va struct tostruct
549describing destination of calls and their counts.
550.It Li GPROF_GMONPARAM
551Structure giving the sizes of the above arrays.
552.El
553.It Li KERN_RAWPARTITION
554The raw partition of a disk (a == 0).
555.It Li KERN_ROOT_DEVICE
556The name of the root device.
557.It Li KERN_RTC_OFFSET
558Return the offset of real time clock from UTC in minutes.
559.It Li KERN_SAVED_IDS
560Returns 1 if saved set-group and saved set-user ID is available.
561.It Li KERN_SECURELVL
562The system security level.
563This level may be raised by processes with appropriate privilege.
564It may only be lowered by process 1.
565.It Li KERN_SYNCHRONIZED_IO
566Returns 1 if the POSIX 1003.1b Synchronized I/O Option is available
567on this system,
568otherwise 0.
569.It Li KERN_SYSVIPC_INFO
570Return System V style IPC configuration and run-time information.
571The third level name selects the System V style IPC facility.
572.Bl -column "KERN_SYSVIPC_MSG_INFOXXX" "struct shm_sysctl_infoXXX" -offset indent
573.It Sy Pa Third level name	Type
574.It KERN\_SYSVIPC\_MSG\_INFO	struct msg_sysctl_info
575.It KERN\_SYSVIPC\_SEM\_INFO	struct sem_sysctl_info
576.It KERN\_SYSVIPC\_SHM\_INFO	struct shm_sysctl_info
577.El
578.Pp
579.Bl -tag -width "123456"
580.It Li KERN_SYSVIPC_MSG_INFO
581Return information on the System V style message facility.  The
582.Sy msg_sysctl_info
583structure is defined in
584.Aq Pa sys/msg.h .
585.It Li KERN_SYSVIPC_SEM_INFO
586Return information on the System V style semaphore facility.  The
587.Sy sem_sysctl_info
588structure is defined in
589.Aq Pa sys/sem.h .
590.It Li KERN_SYSVIPC_SHM_INFO
591Return information on the System V style shared memory facility.  The
592.Sy shm_sysctl_info
593structure is defined in
594.Aq Pa sys/shm.h .
595.El
596.It Li KERN_SYSVMSG
597Returns 1 if System V style message queue functionality is available
598on this system,
599otherwise 0.
600.It Li KERN_SYSVSEM
601Returns 1 if System V style semaphore functionality is available
602on this system,
603otherwise 0.
604.It Li KERN_SYSVSHM
605Returns 1 if System V style share memory functionality is available
606on this system,
607otherwise 0.
608.It Li KERN_VERSION
609The system version string.
610.It Li KERN_VNODE
611Return the entire vnode table.
612Note, the vnode table is not necessarily a consistent snapshot of
613the system.
614The returned data consists of an array whose size depends on the
615current number of such objects in the system.
616Each element of the array contains the kernel address of a vnode
617.Va struct vnode *
618followed by the vnode itself
619.Va struct vnode .
620.El
621.Sh CTL_MACHDEP
622The set of variables defined is architecture dependent.
623Most architectures define at least the following variables.
624.Bl -column "CONSOLE_DEVICEXXX" "integerXXX" -offset indent
625.It Sy Pa Second level name	Type	Changeable
626.It Li CPU_CONSDEV	dev_t	no
627.El
628.Sh CTL_NET
629The string and integer information available for the CTL_NET level
630is detailed below.
631The changeable column shows whether a process with appropriate
632privilege may change the value.
633.Bl -column "Second level nameXXXXXX" "routing messagesXXX" -offset indent
634.It Sy Pa Second level name	Type	Changeable
635.It PF\_ROUTE	routing messages	no
636.It PF\_INET	IPv4 values	yes
637.It PF\_INET6	IPv6 values	yes
638.El
639.Pp
640.Bl -tag -width "123456"
641.It Li PF_ROUTE
642Return the entire routing table or a subset of it.
643The data is returned as a sequence of routing messages (see
644.Xr route 4
645for the header file, format and meaning).
646The length of each message is contained in the message header.
647.Pp
648The third level name is a protocol number, which is currently always 0.
649The fourth level name is an address family, which may be set to 0 to
650select all address families.
651The fifth and sixth level names are as follows:
652.Bl -column "Fifth level nameXXXXXX" "Sixth level is:XXX" -offset indent
653.It Pa Fifth level name	Sixth level is:
654.It NET\_RT\_FLAGS	rtflags
655.It NET\_RT\_DUMP	None
656.It NET\_RT\_IFLIST	None
657.El
658.It Li PF_INET
659Get or set various global information about the IPv4
660.Pq Internet Protocol version 4 .
661The third level name is the protocol.
662The fourth level name is the variable name.
663The currently defined protocols and names are:
664.Bl -column "Protocol name" "Variable nameXX" "integer" "yes" -offset indent
665.It Pa Protocol name	Variable name	Type	Changeable
666.It ip	forwarding	integer	yes
667.It ip	redirect	integer	yes
668.It ip	ttl	integer	yes
669.It ip	forwsrcrt	integer	yes
670.It ip	directed-broadcast	integer	yes
671.It ip	allowsrcrt	integer	yes
672.It ip	subnetsarelocal	integer	yes
673.It ip	mtudisc	integer	yes
674.It ip	anonportmin	integer	yes
675.It ip	anonportmax	integer	yes
676.It ip	mtudisctimeout	integer	yes
677.It ip	gifttl	integer	yes
678.It ip	lowportmin	integer	yes
679.It ip	lowportmax	integer	yes
680.It icmp	maskrepl	integer	yes
681.It icmp	errppslimit	integer	yes
682.It tcp	rfc1323	integer	yes
683.It tcp	sendspace	integer	yes
684.It tcp	recvspace	integer	yes
685.It tcp	mssdflt	integer	yes
686.It tcp	syn_cache_limit	integer	yes
687.It tcp	syn_bucket_limit	integer	yes
688.It tcp	syn_cache_interval	integer	yes
689.It tcp	init_win	integer	yes
690.It tcp	mss_ifmtu	integer	yes
691.It tcp	sack	integer	yes
692.It tcp	win_scale	integer	yes
693.It tcp	timestamps	integer	yes
694.It tcp	compat_42	integer	yes
695.It tcp	cwm	integer	yes
696.It tcp	cwm_burstsize	integer	yes
697.It tcp	ack_on_push	integer	yes
698.It tcp	keepidle	integer	yes
699.It tcp	keepintvl	integer	yes
700.It tcp	keepcnt	integer	yes
701.It tcp	slowhz	integer	no
702.It tcp	newreno	integer	yes
703.It tcp	log_refused	integer	yes
704.It tcp	rstppslimit	integer	yes
705.It udp	checksum	integer	yes
706.It udp	sendspace	integer	yes
707.It udp	recvspace	integer	yes
708.El
709.Pp
710The variables are as follows:
711.Bl -tag -width "123456"
712.It Li ip.forwarding
713Returns 1 when IP forwarding is enabled for the host,
714meaning that the host is acting as a router.
715.It Li ip.redirect
716Returns 1 when ICMP redirects may be sent by the host.
717This option is ignored unless the host is routing IP packets,
718and should normally be enabled on all systems.
719.It Li ip.ttl
720The maximum time-to-live (hop count) value for an IP packet sourced by
721the system.
722This value applies to normal transport protocols, not to ICMP.
723.It Li ip.forwsrcrt
724Returns 1 when forwarding of source-routed packets is enabled for
725the host.  This value may only be changed if the kernel security
726level is less than 1.
727.It Li ip.directed-broadcast
728Returns 1 if directed broadcast behavior is enabled for the host.
729.It Li ip.allowsrcrt
730Returns 1 if the host accepts source routed packets.
731.It Li ip.subnetsarelocal
732Returns 1 if subnets are to be considered local addresses.
733.It Li ip.mtudisc
734Returns 1 if Path MTU Discovery is enabled.
735.It Li ip.anonportmin
736The lowest port number to use for TCP and UDP ephemeral port allocation.
737This cannot be set to less than 1024 or greater than 65535.
738.It Li ip.anonportmax
739The highest port number to use for TCP and UDP ephemeral port allocation.
740This cannot be set to less than 1024 or greater than 65535, and must
741be greater than
742.Li ip.anonportmin .
743.It Li ip.mtudisctimeout
744Returns the number of seconds in which a route added by the Path MTU
745Discovery engine will time out.  When the route times out, the Path
746MTU Discovery engine will attempt to probe a larger path MTU.
747.It Li ip.gifttl
748The maximum time-to-live (hop count) value for an IPv4 packet generated by
749.Xr gif 4
750tunnel interface.
751.It Li ip.lowportmin
752The lowest port number to use for TCP and UDP reserved port allocation.
753This cannot be set to less than 0 or greater than 1024, and must
754be smaller than
755.Li ip.lowportmax .
756.It Li ip.lowportmax
757The highest port number to use for TCP and UDP reserved port allocation.
758This cannot be set to less than 0 or greater than 1024, and must
759be greater than
760.Li ip.lowportmin .
761.It Li icmp.maskrepl
762Returns 1 if ICMP network mask requests are to be answered.
763.It Li icmp.errppslimit
764The variable specifies the maximum number of outgoing ICMP error messages,
765per second.
766ICMP error messages that exceeded the value are subject to rate limitation
767and will not go out from the node.
768Negative value disables rate limitation.
769.It Li tcp.rfc1323
770Returns 1 if RFC1323 extensions to TCP are enabled.
771.It Li tcp.sendspace
772Returns the default TCP send buffer size.
773.It Li tcp.recvspace
774Returns the default TCP receive buffer size.
775.It Li tcp.mssdflt
776Returns the default maximum segment size both advertsized to the peer
777and to use when the peer does not advertize a maximum segment size to
778us during connection setup.  Do not change this value unless you really
779know what you are doing.
780.It Li tcp.syn_cache_limit
781Returns the maximum number of entries allowed in the TCP compressed state
782engine.
783.It Li tcp.syn_bucket_limit
784Returns the maximum number of entries allowed per hash bucket in the TCP
785compressed state engine.
786.It Li tcp.syn_cache_interval
787Returns the TCP compressed state engine's timer interval.
788.It Li tcp.init_win
789Returns a value indicating the TCP initial congestion window.  If this
790value is 0, an auto-tuning algorithm designed to use an initial window
791of approximately 4K bytes is in use.  Otherwise, this value indicates
792a fixed number of packets.
793.It Li tcp.mss_ifmtu
794Returns 1 if TCP calculates the outgoing maximum segment size based on
795the MTU of the appropriate interface.  Otherwise, it is calculated based on
796the greater of the MTU of the interface, and the largest (non-loopback)
797interface MTU on the system.
798.It Li tcp.sack
799TCP Selective ACKnowledgement (RFC 2018) is not implemented in
800.Nx
801at this time.
802Changing this value will have no effect.
803.It Li tcp.win_scale
804If rfc1323 is enabled, a value of 1 indicates RFC1323 window scale options,
805for increasing the TCP window size, are enabled.
806.It Li tcp.timestamps
807If rfc1323 is enabled, a value of 1 indicates RFC1323 time stamp options,
808used for measuring TCP round trip times, are enabled.
809.It Li tcp.compat_42
810Returns 1 if work-arounds for bugs in the 4.2BSD TCP implementation are
811enabled.  Use of this option is not recommended, although it may be
812required in order to communicate with extremely old TCP implementations.
813.It Li tcp.cwm
814Returns 1 if use of the Hughes/Touch/Heidemann Congestion Window Monitoring
815algorithm is enabled.  This algorithm prevents line-rate bursts of packets
816that could otherwise occur when data begins flowing on an idle TCP
817connection.  These line-rate bursts can contribute to network and router
818congestion.  This can be particularly useful on World Wide Web servers
819which support HTTP/1.1, which has lingering connections.
820.It Li tcp.cwm_burstsize
821Returns the Congestion Window Monitoring allowed burst size, in terms
822of packet count.
823.It Li tcp.ack_on_push
824Returns 1 if TCP is to immediately transmit an ACK upon reception of
825a packet with PUSH set.  This can avoid losing a round trip time in some
826rare situations, but has the caveat of potentially defeating TCP's delayed
827ACK algorithm.  Use of this option is generally not recommended, but
828the variable exists in case your configuration really needs it.
829.It Li tcp.keepidle
830Time a connection must be idle before keepalives are sent (if keepalives
831are enabled for the connection).  See also tcp.slowhz.
832.It Li tcp.keepintvl
833Time after a keepalive probe is sent until, in the absence of any response,
834another probe is sent.  See also tcp.slowhz.
835.It Li tcp.keepcnt
836Number of keepalive probes sent before declaring a connection dead.  If
837set to zero, there is no limit; keepalives will be sent until some kind of
838response is received from the peer.
839.It Li tcp.slowhz
840The units for tcp.keepidle and tcp.keepintvl; those variables are in ticks
841of a clock that ticks tcp.slowhz times per second.  (That is, their values
842must be divided by the tcp.slowhz value to get times in seconds.)
843.It Li tcp.newreno
844Returns 1 if the use of J. Hoe's NewReno congestion control algorithm is
845enabled.  This algorithm improves the start-up behavior of TCP connections.
846.It Li tcp.log_refused
847Returns 1 if refused TCP connections to the host will be logged.
848.It Li tcp.rstppslimit
849The variable specifies the maximum number of outgoing TCP RST packets,
850per second.
851TCP RST packet that exceeded the value are subject to rate limitation
852and will not go out from the node.
853Negative value disables rate limitation.
854.It Li udp.checksum
855Returns 1 when UDP checksums are being computed and checked.
856Disabling UDP checksums is strongly discouraged.
857.It Li udp.sendspace
858Returns the default UDP send buffer size.
859.It Li udp.recvspace
860Returns the default UDP receive buffer size.
861.El
862.Pp
863For variables net.*.ipsec, please refer to
864.Xr ipsec 4 .
865.It Li PF_INET6
866Get or set various global information about the IPv6
867.Pq Internet Protocol version 6 .
868The third level name is the protocol.
869The fourth level name is the variable name.
870The currently defined protocols and names are:
871.Bl -column "Protocol name" "Variable nameXX" "integer" "yes" -offset indent
872.It Pa Protocol name	Variable name	Type	Changeable
873.It ip6	forwarding	integer	yes
874.It ip6	redirect	integer	yes
875.It ip6	hlim	integer	yes
876.It ip6	maxfragpackets	integer	yes
877.It ip6	accept_rtadv	integer	yes
878.It ip6	keepfaith	integer	yes
879.It ip6	log_interval	integer	yes
880.It ip6	hdrnestlimit	integer	yes
881.It ip6	dad_count	integer	yes
882.It ip6	auto_flowlabel	integer	yes
883.It ip6	defmcasthlim	integer	yes
884.It ip6	gif_hlim	integer	yes
885.It ip6	kame_version	string	no
886.It ip6	use_deprecated	integer	yes
887.It ip6	rr_prune	integer	yes
888.It ip6	bindv6only	integer	yes
889.It ip6	anonportmin	integer	yes
890.It ip6	anonportmax	integer	yes
891.It ip6	lowportmin	integer	yes
892.It ip6	lowportmax	integer	yes
893.It icmp6	rediraccept	integer	yes
894.It icmp6	redirtimeout	integer	yes
895.It icmp6	nd6_prune	integer	yes
896.It icmp6	nd6_delay	integer	yes
897.It icmp6	nd6_umaxtries	integer	yes
898.It icmp6	nd6_mmaxtries	integer	yes
899.It icmp6	nd6_useloopback	integer	yes
900.It icmp6	nodeinfo	integer	yes
901.It icmp6	errppslimit	integer	yes
902.It icmp6	nd6_maxnudhint	integer	yes
903.It icmp6	mtudisc_hiwat	integer	yes
904.It icmp6	mtudisc_lowat	integer	yes
905.It udp6	sendspace	integer	yes
906.It udp6	recvspace	integer	yes
907.El
908.Pp
909The variables are as follows:
910.Bl -tag -width "123456"
911.It Li ip6.forwarding
912Returns 1 when IPv6 forwarding is enabled for the node,
913meaning that the node is acting as a router.
914Returns 0 when IPv6 forwarding is disabled for the node,
915meaning that the node is acting as a host.
916IPv6 specification defines node behavior for
917.Dq router
918case and
919.Dq host
920case quite differently, and changing this variable during operation
921may cause serious trouble.
922It is recommended to configure the variable at bootstrap time,
923and bootstrap time only.
924.It Li ip6.redirect
925Returns 1 when ICMPv6 redirects may be sent by the node.
926This option is ignored unless the node is routing IP packets,
927and should normally be enabled on all systems.
928.It Li ip6.hlim
929The default hop limit value for an IPv6 unicast packet sourced by the node.
930This value applies to all the transport protocols on top of IPv6.
931There are APIs to override the value, as documented in
932.Xr ip6 4 .
933.It Li ip6.maxfragpackets
934The maximum number of fragmented packets the node will accept.
9350 means that the node will not accept any fragmented packets.
936-1 means that the node will accept as many fragmented packets as it receives.
937The flag is provided basically for avoiding possible DoS attacks.
938.It Li ip6.accept_rtadv
939If set to non-zero, the node will accept ICMPv6 router advertisement packets
940and autoconfigures address prefixes and default routers.
941The node must be a host
942.Pq not a router
943for the option to be meaningful.
944.It Li ip6.keepfaith
945If set to non-zero, it enables
946.Dq FAITH
947TCP relay IPv6-to-IPv4 translator code in the kernel.
948Refer
949.Xr faith 4
950and
951.Xr faithd 8
952for detail.
953.It Li ip6.log_interval
954The variable controls amount of logs generated by IPv6 packet
955forwarding engine, by seting interval between log output
956.Pq in seconds .
957.It Li ip6.hdrnestlimit
958The number of IPv6 extension headers permitted on incoming IPv6 packets.
959If set to 0, the node will accept as many extension headers as possible.
960.It Li ip6.dad_count
961The variable cofigures number of IPv6 DAD
962.Pq duplicated address detection
963probe packets.
964The packets will be generated when IPv6 interface addresses are configured.
965.It Li ip6.auto_flowlabel
966On connected transport protocol packets,
967fill IPv6 flowlabel field to help intermediate routers to identify packet flows.
968.It Li ip6.defmcasthlim
969The default hop limit value for an IPv6 multicast packet sourced by the node.
970This value applies to all the transport protocols on top of IPv6.
971There are APIs to override the value, as documented in
972.Xr ip6 4 .
973.It Li ip6.gif_hlim
974The maximum hop limit value for an IPv6 packet generated by
975.Xr gif 4
976tunnel interface.
977.It Li ip6.kame_version
978The string identifies the version of KAME IPv6 stack implemented in the kernel.
979.It Li ip6.use_deprecated
980The variable controls use of deprecated address, specified in RFC2462 5.5.4.
981.It Li ip6.rr_prune
982The variable specifies interval between IPv6 router renumbering prefix
983babysitting, in seconds.
984.It Li ip6.bindv6only
985The variable specifies initial value for
986.Dv IPV6_BINDV6ONLY
987socket option for
988.Dv AF_INET6
989socket.
990Please refer to
991.Xr ip6 4
992for detail.
993.It Li ip6.anonportmin
994The lowest port number to use for TCP and UDP ephemeral port allocation.
995This cannot be set to less than 1024 or greater than 65535.
996.It Li ip6.anonportmax
997The highest port number to use for TCP and UDP ephemeral port allocation.
998This cannot be set to less than 1024 or greater than 65535, and must
999be greater than
1000.Li ip6.anonportmin .
1001.It Li ip6.lowportmin
1002The lowest port number to use for TCP and UDP reserved port allocation.
1003This cannot be set to less than 0 or greater than 1024, and must
1004be smaller than
1005.Li ip6.lowportmax .
1006.It Li ip6.lowportmax
1007The highest port number to use for TCP and UDP reserved port allocation.
1008This cannot be set to less than 0 or greater than 1024, and must
1009be greater than
1010.Li ip6.lowportmin .
1011.It Li icmp6.rediraccept
1012If set to non-zero, the host will accept ICMPv6 redirect packets.
1013Note that IPv6 routers will never accept ICMPv6 redirect packets,
1014and the variable is meaningful on IPv6 hosts
1015.Pq non-router
1016only.
1017.It Li icmp6.redirtimeout
1018The variable specifies lifetime of routing entries generated by incoming
1019ICMPv6 redirect.
1020.It Li icmp6.nd6_prune
1021The variable specifies interval between IPv6 neighbor cache babysitting,
1022in seconds.
1023.It Li icmp6.nd6_delay
1024The variable specifies
1025.Dv DELAY_FIRST_PROBE_TIME
1026timing constant in IPv6 neighbor discovery specification
1027.Pq RFC2461 ,
1028in seconds.
1029.It Li icmp6.nd6_umaxtries
1030The variable specifies
1031.Dv MAX_UNICAST_SOLICIT
1032constant in IPv6 neighbor discovery specification
1033.Pq RFC2461 .
1034.It Li icmp6.nd6_mmaxtries
1035The variable specifies
1036.Dv MAX_MULTICAST_SOLICIT
1037constant in IPv6 neighbor discovery specification
1038.Pq RFC2461 .
1039.It Li icmp6.nd6_useloopback
1040If set to non-zero, kernel IPv6 stack will use loopback interface for
1041local traffic.
1042.It Li icmp6.nodeinfo
1043The variable enables, or disables, kernel support for
1044ICMPv6 node information query/reply.
1045.It Li icmp6.errppslimit
1046The variable specifies the maximum number of outgoing ICMPv6 error messages,
1047per second.
1048ICMPv6 error messages that exceeded the value are subject to rate limitation
1049and will not go out from the node.
1050Negative value disables rate limitation.
1051.It Li icmp6.nd6_maxnudhint
1052IPv6 neighbor discovery permits upper layer protocols to supply reachability
1053hints, to avoid unnecessary neighbor discovery exchanges.
1054The variable defines the number of consecutive hints the neighbor discovery
1055layer will take.
1056For example, by setting the variable to 3, neighbor discovery layer
1057will take 3 consecutive hints in maximum.
1058After receiving 3 hints, neighbor discovery layer will perform
1059normal neighbor discovery process.
1060.It Li icmp6.mtudisc_hiwat
1061.It Li icmp6.mtudisc_lowat
1062The variables define the maximum number of routing table entries,
1063created due to path MTU discovery
1064.Pq prevents denial-of-service attacks with ICMPv6 too big messages .
1065When IPv6 path MTU discovery happens, we keep path MTU information into
1066the routing table.
1067If the number of routing table entries exceed the value,
1068the kernel will not attempt to keep the path MTU information.
1069.Li icmp6.mtudisc_hiwat
1070is used when we have verified ICMPv6 too big messages.
1071.Li icmp6.mtudisc_lowat
1072is used when we have unverified ICMPv6 too big messages.
1073Verification is performed by using address/port pairs kept in connected pcbs.
1074.El
1075.Pp
1076We reuse net.*.tcp for
1077.Tn TCP
1078over
1079.Tn IPv6 ,
1080and therefore we do not have variables net.*.tcp6.
1081Variables net.inet6.udp6 have identical meaning to net.inet.udp.
1082Please refer to
1083.Li PF_INET
1084section above.
1085For variables net.*.ipsec6, please refer to
1086.Xr ipsec 4 .
1087.El
1088.Sh CTL_PROC
1089The string and integer information available for the CTL_PROC
1090is detailed below.
1091The changeable column shows whether a process with appropriate
1092privilege may change the value.
1093These values are per-process, and as such may change from one process
1094to another. When a process is created, the default values are inherited from
1095its parent. When a set-user-ID or set-group-ID binary is executed, the
1096value of PROC_PID_CORENAME is reset to the system default value.
1097The second level name is either the magic value PROC_CURPROC, which
1098points to the current process, or the PID of the target process.
1099.Bl -column "USER_COLL_WEIGHTS_MAXXXX" "integerXXX" "yes" -offset indent
1100.It Sy Pa Third level name	Type	Changeable
1101.It PROC\_PID\_CORENAME	string	yes
1102.It PROC\_PID\_LIMIT	node	not applicable
1103.El
1104.Bl -tag -width "123456"
1105.Pp
1106.It Li PROC_PID_CORENAME
1107The template used for the core dump file name (see
1108.Xr core 5
1109for details). The base name must either be
1110.Nm core
1111or end with the suffix ``.core'' (the super-user may set arbitrary names). By
1112default it points to KERN_DEFCORENAME.
1113.It Li PROC_PID_LIMIT
1114Return resources limits, as defined for the
1115.Xr getrlimit 2
1116and
1117.Xr setrlimit 2
1118system calls.
1119The fourth level name is one of:
1120.Bl -tag -width PROC_PID_LIMIT_MEMLOCKAA
1121.It Li PROC_PID_LIMIT_CPU
1122The maximum amount of cpu time (in seconds) to be used by each process.
1123.It Li PROC_PID_LIMIT_FSIZE
1124The largest size (in bytes) file that may be created.
1125.It Li PROC_PID_LIMIT_DATA
1126The maximum size (in bytes) of the data segment for a process;
1127this defines how far a program may extend its break with the
1128.Xr sbrk 2
1129system call.
1130.It Li PROC_PID_LIMIT_STACK
1131The maximum size (in bytes) of the stack segment for a process;
1132this defines how far a program's stack segment may be extended.
1133Stack extension is performed automatically by the system.
1134.It Li PROC_PID_LIMIT_CORE
1135The largest size (in bytes)
1136.Pa core
1137file that may be created.
1138.It Li PROC_PID_LIMIT_RSS
1139The maximum size (in bytes) to which a process's resident set size may
1140grow.
1141This imposes a limit on the amount of physical memory to be given to
1142a process; if memory is tight, the system will prefer to take memory
1143from processes that are exceeding their declared resident set size.
1144.It Li PROC_PID_LIMIT_MEMLOCK
1145The maximum size (in bytes) which a process may lock into memory
1146using the
1147.Xr mlock 2
1148function.
1149.It Li PROC_PID_LIMIT_NPROC
1150The maximum number of simultaneous processes for this user id.
1151.It Li PROC_PID_LIMIT_NOFILE
1152The maximum number of open files for this process.
1153.El
1154.Pp
1155The fifth level name is one of PROC_PID_LIMIT_TYPE_SOFT or
1156PROC_PID_LIMIT_TYPE_HARD, to select respectively the soft or hard limit.
1157Both are of type integer.
1158.El
1159.Pp
1160
1161.Sh CTL_USER
1162The string and integer information available for the CTL_USER level
1163is detailed below.
1164The changeable column shows whether a process with appropriate
1165privilege may change the value.
1166.Bl -column "USER_COLL_WEIGHTS_MAXXXX" "integerXXX" -offset indent
1167.It Sy Pa Second level name	Type	Changeable
1168.It USER\_BC\_BASE\_MAX	integer	no
1169.It USER\_BC\_DIM\_MAX	integer	no
1170.It USER\_BC\_SCALE\_MAX	integer	no
1171.It USER\_BC\_STRING\_MAX	integer	no
1172.It USER\_COLL\_WEIGHTS\_MAX	integer	no
1173.It USER\_CS\_PATH	string	no
1174.It USER\_EXPR\_NEST\_MAX	integer	no
1175.It USER\_LINE\_MAX	integer	no
1176.It USER\_POSIX2\_CHAR\_TERM	integer	no
1177.It USER\_POSIX2\_C\_BIND	integer	no
1178.It USER\_POSIX2\_C\_DEV	integer	no
1179.It USER\_POSIX2\_FORT\_DEV	integer	no
1180.It USER\_POSIX2\_FORT\_RUN	integer	no
1181.It USER\_POSIX2\_LOCALEDEF	integer	no
1182.It USER\_POSIX2\_SW\_DEV	integer	no
1183.It USER\_POSIX2\_UPE	integer	no
1184.It USER\_POSIX2\_VERSION	integer	no
1185.It USER\_RE\_DUP\_MAX	integer	no
1186.It USER\_STREAM\_MAX	integer	no
1187.It USER\_TZNAME\_MAX	integer	no
1188.El
1189.Bl -tag -width "123456"
1190.Pp
1191.It Li USER_BC_BASE_MAX
1192The maximum ibase/obase values in the
1193.Xr bc 1
1194utility.
1195.It Li USER_BC_DIM_MAX
1196The maximum array size in the
1197.Xr bc 1
1198utility.
1199.It Li USER_BC_SCALE_MAX
1200The maximum scale value in the
1201.Xr bc 1
1202utility.
1203.It Li USER_BC_STRING_MAX
1204The maximum string length in the
1205.Xr bc 1
1206utility.
1207.It Li USER_COLL_WEIGHTS_MAX
1208The maximum number of weights that can be assigned to any entry of
1209the LC_COLLATE order keyword in the locale definition file.
1210.It Li USER_CS_PATH
1211Return a value for the
1212.Ev PATH
1213environment variable that finds all the standard utilities.
1214.It Li USER_EXPR_NEST_MAX
1215The maximum number of expressions that can be nested within
1216parenthesis by the
1217.Xr expr 1
1218utility.
1219.It Li USER_LINE_MAX
1220The maximum length in bytes of a text-processing utility's input
1221line.
1222.It Li USER_POSIX2_CHAR_TERM
1223Return 1 if the system supports at least one terminal type capable of
1224all operations described in POSIX 1003.2, otherwise 0.
1225.It Li USER_POSIX2_C_BIND
1226Return 1 if the system's C-language development facilities support the
1227C-Language Bindings Option, otherwise 0.
1228.It Li USER_POSIX2_C_DEV
1229Return 1 if the system supports the C-Language Development Utilities Option,
1230otherwise 0.
1231.It Li USER_POSIX2_FORT_DEV
1232Return 1 if the system supports the FORTRAN Development Utilities Option,
1233otherwise 0.
1234.It Li USER_POSIX2_FORT_RUN
1235Return 1 if the system supports the FORTRAN Runtime Utilities Option,
1236otherwise 0.
1237.It Li USER_POSIX2_LOCALEDEF
1238Return 1 if the system supports the creation of locales, otherwise 0.
1239.It Li USER_POSIX2_SW_DEV
1240Return 1 if the system supports the Software Development Utilities Option,
1241otherwise 0.
1242.It Li USER_POSIX2_UPE
1243Return 1 if the system supports the User Portability Utilities Option,
1244otherwise 0.
1245.It Li USER_POSIX2_VERSION
1246The version of POSIX 1003.2 with which the system attempts to comply.
1247.It Li USER_RE_DUP_MAX
1248The maximum number of repeated occurrences of a regular expression
1249permitted when using interval notation.
1250.ne 1i
1251.It Li USER_STREAM_MAX
1252The minimum maximum number of streams that a process may have open
1253at any one time.
1254.It Li USER_TZNAME_MAX
1255The minimum maximum number of types supported for the name of a
1256timezone.
1257.El
1258.Sh CTL_VM
1259The string and integer information available for the CTL_VM level
1260is detailed below.
1261The changeable column shows whether a process with appropriate
1262privilege may change the value.
1263.Bl -column "Second level nameXXXXXX" "struct loadavgXXX" -offset indent
1264.It Sy Pa Second level name	Type	Changeable
1265.It VM\_LOADAVG	struct loadavg	no
1266.It VM\_METER	struct vmtotal	no
1267.El
1268.Pp
1269.Bl -tag -width "123456"
1270.It Li VM_LOADAVG
1271Return the load average history.
1272The returned data consists of a
1273.Va struct loadavg .
1274.It Li VM_METER
1275Return the system wide virtual memory statistics.
1276The returned data consists of a
1277.Va struct vmtotal .
1278.El
1279.Sh CTL_DDB
1280The integer information available for the CTL_DDB level is detailed below.
1281The changeable column shows whether a process with appropriate
1282privilege may change the value.
1283.Bl -column "DBCTL_TABSTOPSXXX" "integerXXX" -offset indent
1284.It Sy Pa Second level name	Type	Changeable
1285.It DBCTL\_RADIX	integer	yes
1286.It DBCTL\_MAXOFF	integer	yes
1287.It DBCTL\_LINES	integer	yes
1288.It DBCTL\_TABSTOPS	integer	yes
1289.It DBCTL\_ONPANIC	integer	yes
1290.It DBCTL\_FROMCONSOLE	integer	yes
1291.El
1292.Pp
1293.Bl -tag -width "123456"
1294.It Li DBCTL_RADIX
1295The input and output radix.
1296.It Li DBCTL_MAXOFF
1297The maximum symbol offset.
1298.It Li DBCTL_LINES
1299Number of display lines.
1300.It Li DBCTL_TABSTOPS
1301Tab width.
1302.It Li DBCTL_ONPANIC
1303If non-zero, DDB will be entered when the kernel panics.
1304.It Li DBCTL_FROMCONSOLE
1305If not zero, DDB may be entered by sending a break on a serial
1306console or by a special key sequence on a graphics console.
1307.El
1308.Pp
1309These MIB nodes are also available as variables from within the
1310DDB.  See
1311.Xr ddb 4
1312for more details.
1313.Sh CTL_VENDOR
1314The "vendor" toplevel name is reserved to be used by vendors who wish to
1315have their own private MIB tree. Intended use is to store values under
1316.Dq vendor.<yourname>.* .
1317.Sh RETURN VALUES
1318If the call to
1319.Nm
1320is successful, the number of bytes copied out is returned.
1321Otherwise \-1 is returned and
1322.Va errno
1323is set appropriately.
1324.Sh ERRORS
1325The following errors may be reported:
1326.Bl -tag -width Er
1327.It Bq Er EFAULT
1328The buffer
1329.Fa name ,
1330.Fa oldp ,
1331.Fa newp ,
1332or length pointer
1333.Fa oldlenp
1334contains an invalid address.
1335.It Bq Er EINVAL
1336The
1337.Fa name
1338array is less than two or greater than CTL_MAXNAME.
1339.It Bq Er EINVAL
1340A non-null
1341.Fa newp
1342is given and its specified length in
1343.Fa newlen
1344is too large or too small.
1345.It Bq Er ENOMEM
1346The length pointed to by
1347.Fa oldlenp
1348is too short to hold the requested value.
1349.It Bq Er ENOTDIR
1350The
1351.Fa name
1352array specifies an intermediate rather than terminal name.
1353.It Bq Er EOPNOTSUPP
1354The
1355.Fa name
1356array specifies a value that is unknown.
1357.It Bq Er EPERM
1358An attempt is made to set a read-only value.
1359.It Bq Er EPERM
1360A process without appropriate privilege attempts to set a value.
1361.It Bq Er EPERM
1362An attempt to change a value protected by the current kernel security
1363level is made.
1364.El
1365.Sh FILES
1366.Bl -tag -width <netinet6/udp6Xvar.h> -compact
1367.It Pa <sys/sysctl.h>
1368definitions for top level identifiers, second level kernel and hardware
1369identifiers, and user level identifiers
1370.It Pa <sys/socket.h>
1371definitions for second level network identifiers
1372.It Pa <sys/gmon.h>
1373definitions for third level profiling identifiers
1374.It Pa <uvm/uvm_param.h>
1375definitions for second level virtual memory identifiers
1376.It Pa <netinet/in.h>
1377definitions for third level IPv4/v6 identifiers and
1378fourth level IPv4/v6 identifiers
1379.It Pa <netinet/icmp_var.h>
1380definitions for fourth level ICMP identifiers
1381.It Pa <netinet/icmp6.h>
1382definitions for fourth level ICMPv6 identifiers
1383.It Pa <netinet/tcp_var.h>
1384definitions for fourth level TCP identifiers
1385.It Pa <netinet/udp_var.h>
1386definitions for fourth level UDP identifiers
1387.It Pa <netinet6/udp6_var.h>
1388definitions for fourth level IPv6 UDP identifiers
1389.It Pa <netinet6/ipsec.h>
1390definitions for fourth level IPsec identifiers
1391.El
1392.Sh SEE ALSO
1393.Xr ipsec 4 ,
1394.Xr sysctl 8
1395.Sh HISTORY
1396The
1397.Nm
1398function first appeared in
1399.Bx 4.4 .
1400