xref: /netbsd-src/share/man/man7/sysctl.7 (revision 8450a7c42673d65e3b1f6560d3b6ecd317a6cbe8)
1.\"	$NetBSD: sysctl.7,v 1.103 2016/10/12 08:52:49 roy 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. Neither the name of the University nor the names of its contributors
15.\"    may be used to endorse or promote products derived from this software
16.\"    without specific prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.\"	@(#)sysctl.3	8.4 (Berkeley) 5/9/95
31.\"
32.Dd October 12, 2016
33.Dt SYSCTL 7
34.Os
35.Sh NAME
36.Nm sysctl
37.Nd system information variables
38.Sh DESCRIPTION
39The
40.Xr sysctl 3
41library function and the
42.Xr sysctl 8
43utility are used to get and set values of system variables, maintained
44by the kernel.
45The variables are organized in a tree and identified by a sequence of
46numbers, conventionally separated by dots with the topmost identifier
47at the left side.
48The numbers have corresponding text names.
49The
50.Xr sysctlnametomib 3
51function or the
52.Fl M
53argument to the
54.Xr sysctl 8
55utility can be used to convert the text representation to the
56numeric one.
57.Pp
58The individual sysctl variables are described below, both the textual
59and numeric form where applicable.
60The textual names can be used as argument to the
61.Xr sysctl 8
62utility and in the file
63.Pa /etc/sysctl.conf .
64The numeric names are usually defined as preprocessor constants and
65are intended for use by programs.
66Every such constant expands to one integer, which identifies the
67sysctl variable relative to the upper level of the tree.
68See the
69.Xr sysctl 3
70manual page for programming examples.
71.Ss Top level names
72The top level names are defined with a
73.Va CTL_
74prefix in
75.In sys/sysctl.h ,
76and are as follows.
77The next and subsequent levels down are found in the include files
78listed here, and described in separate sections below.
79.Bl -column "security" ".Dv CTL_SECURITY" ".In uvm/uvm_param.h" "High kernel limits"
80.It Sy Name  Ta Sy Constant     Ta Sy Next level names Ta Sy Description
81.It kern     Ta Dv CTL_KERN     Ta In sys/sysctl.h     Ta High kernel limits
82.It vm       Ta Dv CTL_VM       Ta In uvm/uvm_param.h  Ta Virtual memory
83.It vfs      Ta Dv CTL_VFS      Ta In sys/mount.h      Ta Filesystem
84.It net      Ta Dv CTL_NET      Ta In sys/socket.h     Ta Networking
85.It debug    Ta Dv CTL_DEBUG    Ta In sys/sysctl.h     Ta Debugging
86.It hw       Ta Dv CTL_HW       Ta In sys/sysctl.h     Ta Generic CPU, I/O
87.It machdep  Ta Dv CTL_MACHDEP  Ta In sys/sysctl.h     Ta Machine dependent
88.It user     Ta Dv CTL_USER     Ta In sys/sysctl.h     Ta User-level
89.It ddb      Ta Dv CTL_DDB      Ta In sys/sysctl.h     Ta In-kernel debugger
90.It proc     Ta Dv CTL_PROC     Ta In sys/sysctl.h     Ta Per-process
91.It vendor   Ta Dv CTL_VENDOR   Ta ?                   Ta Vendor specific
92.It emul     Ta Dv CTL_EMUL     Ta In sys/sysctl.h     Ta Emulation settings
93.It security Ta Dv CTL_SECURITY Ta In sys/sysctl.h     Ta Security settings
94.El
95.Ss The debug.* subtree
96The debugging variables vary from system to system.
97A debugging variable may be added or deleted without need to recompile
98.Nm
99to know about it.
100Each time it runs,
101.Nm
102gets the list of debugging variables from the kernel and
103displays their current values.
104The system defines twenty
105.Vt ( struct ctldebug )
106variables named
107.Dv debug0
108through
109.Dv debug19 .
110They are declared as separate variables so that they can be
111individually initialized at the location of their associated variable.
112The loader prevents multiple use of the same variable by issuing errors
113if a variable is initialized in more than one place.
114For example, to export the variable
115.Va dospecialcheck
116as a debugging variable, the following declaration would be used:
117.Pp
118.Bd -literal -offset indent -compact
119int dospecialcheck = 1;
120struct ctldebug debug5 = { "dospecialcheck", \*[Am]dospecialcheck };
121.Ed
122.Pp
123Note that the dynamic implementation of
124.Nm
125currently in use largely makes this particular
126.Nm
127interface obsolete.
128See
129.Xr sysctl 8
130.\" and
131.\" .Xr sysctl 9
132for more information.
133.Ss The vfs.* subtree
134A distinguished second level name,
135.Li vfs.generic ( Dv VFS_GENERIC ) ,
136is used to get general information about all file systems.
137It has the following third level identifiers:
138.Bl -tag -width "123456"
139.It Li vfs.generic.maxtypenum ( Dv VFS_MAXTYPENUM )
140The highest valid file system type number.
141.It Li vfs.generic.conf ( Dv VFS_CONF )
142Returns configuration information about the file system type given as a fourth
143level identifier.
144.It Li vfs.generic.usermount ( Dv VFS_USERMOUNT )
145Determines if non superuser mounts are allowed, defaults to
146.Dv 0 .
147.It Li vfs.generic.magiclinks ( Dv VFS_MAGICLINKS )
148Controls if expansion of variables is going to be performed on pathnames
149or not.
150Defaults to no variable expansion,
151.Dv 0 .
152Variables are of the form
153.Li @name
154and the variables supported are described in
155.Xr symlink 7
156under
157.Dq "MAGIC SYMLINKS" .
158.El
159.Pp
160A second level name for controlling the
161.Xr wapbl 4
162(Write Ahead Physical Block Logging file system journalling)
163capabilities with the following third level identifiers:
164.Bl -tag -width "123456"
165.It Li vfs.wapbl.flush_disk_cache
166Controls whether to attempt to flush the disk cache on each commit.
167It defaults to 1 and it should always be on to ensure integrity
168of file system metadata in the event of a power loss.
169For slow disks, turning it off can improve performance.
170.It Li vfs.wapbl.verbose_commit
171For each transaction log commit, print the number of bytes written
172and the time it took to commit as seconds.nanoseconds.
173.El
174.Pp
175The remaining second level identifiers are the file system names, identified
176by the type number returned by a
177.Xr statvfs 2
178call or from
179.Li vfs.generic.conf .
180.Pp
181The third level identifiers available for each file system
182are given in the header file that defines the mount
183argument structure for that file system.
184.Ss The hw.* subtree
185The string and integer information available for the
186.Li hw
187level is detailed below.
188The changeable column shows whether a process with appropriate
189privilege may change the value.
190.Bl -column "hw.machine_arch" "integer" "Changeable" -offset indent
191.It Sy Second level name	Sy Type	Sy Changeable
192.It hw.alignbytes	integer	no
193.It hw.byteorder	integer	no
194.It hw.cnmagic	string	yes
195.It hw.disknames	string	no
196.It hw.diskstats	struct	no
197.It hw.machine	string	no
198.It hw.machine_arch	string	no
199.It hw.model	string	no
200.It hw.ncpu	integer	no
201.It hw.ncpuonline	integer	no
202.It hw.pagesize	integer	no
203.It hw.physmem	integer	no
204.It hw.physmem64	quad	no
205.It hw.usermem	integer	no
206.It hw.usermem64	quad	no
207.El
208.Bl -tag -width "123456"
209.It Li hw.alignbytes ( Dv HW_ALIGNBYTES )
210Alignment constraint for all possible data types.
211This shows the value
212.Dv ALIGNBYTES
213in
214.In machine/param.h ,
215at the kernel compilation time.
216.It Li hw.byteorder ( Dv HW_BYTEORDER )
217The byteorder (4321, or 1234).
218.It Li hw.cnmagic ( Dv HW_CNMAGIC )
219The console magic key sequence.
220.It Li hw.disknames ( Dv HW_DISKNAMES )
221The list of (space separated) disk device names on the system.
222.It Li hw.iostatnames ( Dv HW_IOSTATNAMES )
223A space separated list of devices that will have I/O statistics
224collected on them.
225.It Li hw.iostats ( Dv HW_IOSTATS )
226Return statistical information on the NFS mounts, disk and tape
227devices on the system.
228An array of
229.Vt struct io_sysctl
230structures is returned,
231whose size depends on the current number of such objects in the system.
232The third level name is the size of the
233.Vt struct io_sysctl .
234The type of object can be determined by examining the
235.Va type
236element of
237.Vt struct io_sysctl .
238Which can be
239.Dv IOSTAT_DISK
240(disk drive),
241.Dv IOSTAT_TAPE
242(tape drive), or
243.Dv IOSTAT_NFS
244(NFS mount).
245.It Li hw.machine ( Dv HW_MACHINE )
246The machine class.
247.It Li hw.machine_arch ( Dv HW_MACHINE_ARCH )
248The machine CPU class.
249.It Li hw.model ( Dv HW_MODEL )
250The machine model.
251.It Li hw.ncpu ( Dv HW_NCPU )
252The number of CPUs configured.
253.It Li hw.ncpuonline ( Dv HW_NCPUONLINE )
254The number of CPUs online.
255.It Li hw.pagesize ( Dv HW_PAGESIZE )
256The software page size.
257.It Li hw.physmem ( Dv HW_PHYSMEM )
258The bytes of physical memory as a 32-bit integer.
259.It Li hw.physmem64 ( Dv HW_PHYSMEM64 )
260The bytes of physical memory as a 64-bit integer.
261.It Li hw.usermem ( Dv HW_USERMEM )
262The bytes of non-kernel memory as a 32-bit integer.
263.It Li hw.usermem64 ( Dv HW_USERMEM64 )
264The bytes of non-kernel memory as a 64-bit integer.
265.El
266.Ss The kern.* subtree
267This subtree includes data generally related to the kernel.
268The string and integer information available for the
269.Li kern
270level is detailed below.
271The changeable column shows whether a process with appropriate
272privilege may change the value.
273.Bl -column "kern.posix_reader_writer_locks" \
274"struct kinfo_drivers" "not applicable"
275.It Sy Second level name	Sy Type	Sy Changeable
276.It kern.aio_listio_max	integer	yes
277.It kern.aio_max	integer	yes
278.It kern.arandom	integer	no
279.It kern.argmax	integer	no
280.It kern.boothowto	integer	no
281.It kern.boottime	struct timeval	no
282.It kern.buildinfo	string	no
283.\".It kern.bufq	node	not applicable
284.It kern.ccpu	integer	no
285.It kern.clockrate	struct clockinfo	no
286.It kern.consdev	integer	no
287.It kern.coredump	node	not applicable
288.It kern.cp_id	struct	no
289.It kern.cp_time	uint64_t[\|]	no
290.It kern.cryptodevallowsoft	integer	yes
291.It kern.defcorename	string	yes
292.It kern.detachall	integer	yes
293.It kern.domainname	string	yes
294.It kern.drivers	struct kinfo_drivers	no
295.It kern.dump_on_panic	integer	yes
296.It kern.file	struct file	no
297.It kern.forkfsleep	integer	yes
298.It kern.fscale	integer	no
299.It kern.fsync	integer	no
300.It kern.hardclock_ticks	integer	no
301.It kern.hostid	integer	yes
302.It kern.hostname	string	yes
303.It kern.iov_max	integer	no
304.It kern.ipc	node	not applicable
305.It kern.job_control	integer	no
306.It kern.labeloffset	integer	no
307.It kern.labelsector	integer	no
308.It kern.login_name_max	integer	no
309.It kern.logsigexit	integer	yes
310.It kern.mapped_files	integer	no
311.It kern.maxfiles	integer	yes
312.It kern.maxlwp	integer	yes
313.It kern.maxpartitions	integer	no
314.It kern.maxphys	integer	no
315.It kern.maxproc	integer	yes
316.It kern.maxptys	integer	yes
317.It kern.maxvnodes	integer	yes
318.It kern.messages	integer yes
319.It kern.mbuf	node	not applicable
320.It kern.memlock	integer	no
321.It kern.memlock_range	integer	no
322.It kern.memory_protection	integer	no
323.It kern.module	node	not applicable
324.It kern.monotonic_clock	integer	no
325.It kern.mqueue	node	not applicable
326.It kern.msgbuf	integer	no
327.It kern.msgbufsize	integer	no
328.It kern.ngroups	integer	no
329.\".It kern.no_sa_support	integer	yes
330.It kern.ntptime	struct ntptimeval	no
331.It kern.osrelease	string	no
332.It kern.osrevision	integer	no
333.It kern.ostype	string	no
334.\".It kern.panic_now	integer	yes
335.It kern.pipe	node	not applicable
336.It kern.pool	struct pool_sysctl	no
337.\" .It kern.posix	node	not applicable
338.It kern.posix1version	integer	no
339.It kern.posix_aio	integer	no
340.It kern.posix_barriers	integer	no
341.It kern.posix_reader_writer_locks	integer	no
342.\".It kern.posix_sched	integer	yes
343.It kern.posix_semaphores	integer	no
344.It kern.posix_spin_locks	integer	no
345.It kern.posix_threads	integer	no
346.It kern.posix_timers	integer	no
347.It kern.proc	struct kinfo_proc	no
348.It kern.proc2	struct kinfo_proc2	no
349.It kern.proc_args	string	no
350.It kern.profiling	node	not applicable
351.\".It kern.pset	node	not applicable
352.It kern.rawpartition	integer	no
353.It kern.root_device	string	no
354.It kern.root_partition	integer	no
355.It kern.rtc_offset	integer	yes
356.It kern.saved_ids	integer	no
357.It kern.sbmax	integer	yes
358.\".It kern.sched	node	not applicable
359.It kern.securelevel	integer	raise only
360.It kern.somaxkva	integer	yes
361.It kern.synchronized_io	integer	no
362.It kern.timecounter	node	not applicable
363.It kern.timex	struct	no
364.It kern.tkstat	node	not applicable
365.It kern.tty	node	not applicable
366.It kern.urandom	integer	no
367.It kern.usercrypto	integer	yes
368.It kern.userasymcrypto	integer	yes
369.It kern.veriexec	node	not applicable
370.It kern.version	string	no
371.It kern.vnode	struct vnode	no
372.El
373.Bl -tag -width "123456"
374.It Li kern.aio_listio_max
375The maximum number of asynchronous
376.Tn I/O
377operations in a single list I/O call.
378Like with all variables related to
379.Xr aio 3 ,
380the variable may be created and removed dynamically
381upon loading or unloading the corresponding kernel module.
382.It Li kern.aio_max
383The maximum number of asynchronous I/O operations.
384.It Li kern.arandom
385This variable picks a random number each time it is queried.
386The used random number generator
387.Pf ( Tn RNG )
388is based on
389.Xr arc4random 3 .
390.It Li kern.argmax ( Dv KERN_ARGMAX )
391The maximum bytes of argument to
392.Xr execve 2 .
393.It Li kern.boothowto
394Flags passed from the boot loader; see
395.Xr reboot 2
396for the meanings of the flags.
397.It Li kern.boottime ( Dv KERN_BOOTTIME )
398A
399.Vt struct timeval
400structure is returned.
401This structure contains the time that the system was booted.
402.It Li kern.buildinfo
403When the kernel is built, the build environment may optionally provide
404arbitrary information to be stored in this variable.
405.\" .It Li kern.bufq
406.\" XXX: Undocumented.
407.It Li kern.ccpu ( Dv KERN_CCPU )
408The scheduler exponential decay value.
409.It Li kern.clockrate ( Dv KERN_CLOCKRATE )
410A
411.Vt struct clockinfo
412structure is returned.
413This structure contains the clock, statistics clock and profiling clock
414frequencies, the number of micro-seconds per hz tick, and the clock
415skew rate.
416Refer to
417.Xr hz 9
418for additional details.
419.It Li kern.consdev ( Dv KERN_CONSDEV )
420Console device.
421.It Li kern.coredump
422Settings related to set-id processes coredumps.
423By default, set-id processes do not dump core in situations where
424other processes would.
425The settings in this node allows an administrator to change this
426behavior.
427.Pp
428The third level name is
429.Dv kern.coredump.setid
430and fourth level variables are described below.
431.Bl -column "kern.coredump.setid.group" "integer" "Changeable" -offset indent
432.It Sy Fourth level name	Sy Type	Sy Changeable
433.It kern.coredump.setid.dump	integer	yes
434.It kern.coredump.setid.group	integer	yes
435.It kern.coredump.setid.mode	integer	yes
436.It kern.coredump.setid.owner	integer	yes
437.It kern.coredump.setid.path	string	yes
438.El
439.Bl -tag -width "123456"
440.It Li kern.coredump.setid.dump
441If non-zero, set-id processes will dump core.
442.It Li kern.coredump.setid.group
443The group-id for the set-id processes' coredump.
444.It Li kern.coredump.setid.mode
445The mode for the set-id processes' coredump.
446See
447.Xr chmod 1 .
448.It Li kern.coredump.setid.owner
449The user-id that will be used as the owner of the set-id processes'
450coredump.
451.It Li kern.coredump.setid.path
452The path to which set-id processes' coredumps will be saved to.
453Same syntax as kern.defcorename.
454.El
455.It Li kern.cp_id ( Dv KERN_CP_ID )
456Mapping of CPU number to CPU id.
457.It Li kern.cp_time ( Dv KERN_CP_TIME )
458Returns an array of
459.Dv CPUSTATES
460.Vt uint64_t Ns s .
461This array contains the
462number of clock ticks spent in different CPU states.
463On multi-processor systems, the sum across all CPUs is returned unless
464appropriate space is given for one data set for each CPU.
465Data for a specific CPU can also be obtained by adding the number of the
466CPU at the end of the MIB, enlarging it by one.
467.It Li kern.cryptodevallowsoft
468This variable controls userland access to hardware versus software transforms
469in the
470.Xr crypto 4
471system.
472The available values are as follows:
473.Bl -tag -width XX0 -offset indent
474.It Dv \*[Lt] 0
475Always force userlevel requests to use software transforms.
476.It Dv = 0
477If present, use hardware and grant userlevel requests for
478non-accelerated transforms (handling the latter in software).
479.It Dv \*[Gt] 0
480Allow user requests only for transforms which are hardware-accelerated.
481.El
482.It Li kern.defcorename ( Dv KERN_DEFCORENAME )
483Default template for the name of core dump files (see also
484.Li proc.pid.corename
485in the per-process variables
486.Li proc.* ,
487and
488.Xr core 5
489for format of this template).
490The default value is
491.Pa %n.core
492and can be changed with the kernel configuration option
493.Cd options DEFCORENAME
494(see
495.Xr options 4
496).
497.It Li kern.detachall
498Detach all devices at shutdown.
499.It Li kern.domainname ( Dv KERN_DOMAINNAME )
500Get or set the YP domain name.
501.It Li kern.drivers ( Dv KERN_DRIVERS )
502Return an array of
503.Vt struct kinfo_drivers
504that contains the name and major device numbers of all the device drivers
505in the current kernel.
506The
507.Va d_name
508field is always a NUL terminated string.
509The
510.Va d_bmajor
511field will be set to \-1 if the driver doesn't have a block device.
512.It Li kern.dump_on_panic ( Dv KERN_DUMP_ON_PANIC )
513Perform a crash dump on system
514.Xr panic 9 .
515.It Li kern.file ( Dv KERN_FILE )
516Return the entire file table.
517The returned data consists of a single
518.Vt struct filelist
519followed by an array of
520.Vt struct file ,
521whose size depends on the current number of such objects in the system.
522.It Li kern.forkfsleep ( Dv KERN_FORKFSLEEP )
523If
524.Xr fork 2
525system call fails due to limit on number of processes (either
526the global maxproc limit or user's one), wait for this many
527milliseconds before returning
528.Er EAGAIN
529error to process.
530Useful to keep heavily forking runaway processes in bay.
531Default zero (no sleep).
532Maximum is 20 seconds.
533.It Li kern.fscale ( Dv KERN_FSCALE )
534The kernel fixed-point scale factor.
535.It Li kern.fsync ( Dv KERN_FSYNC )
536Return 1 if the
537.St -p1003.1b-93
538File Synchronization Option is available
539on this system,
540otherwise\ 0.
541.It Li kern.hardclock_ticks ( Dv KERN_HARDCLOCK_TICKS )
542Returns the number of
543.Xr hardclock 9
544ticks.
545.It Li kern.hostid ( Dv KERN_HOSTID )
546Get or set the host identifier.
547This is aimed to replace the legacy
548.Xr gethostid 3
549and
550.Xr sethostid 3
551system calls.
552.It Li kern.hostname ( Dv KERN_HOSTNAME )
553Get or set the
554.Xr hostname 1 .
555.It Li kern.iov_max ( Dv KERN_IOV_MAX )
556Return the maximum number of
557.Vt iovec
558structures that a process has available for use with
559.Xr preadv 2 ,
560.Xr pwritev 2 ,
561.Xr readv 2 ,
562.Xr recvmsg 2 ,
563.Xr sendmsg 2
564and
565.Xr writev 2 .
566.It Li kern.ipc ( Dv KERN_SYSVIPC )
567Return information about the SysV IPC parameters.
568The third level names for the ipc variables are detailed below.
569.Bl -column "kern.ipc.shm_use_phys" "integer" "Changeable" -offset indent
570.It Sy Third level name	Sy Type	Sy Changeable
571.It kern.ipc.sysvmsg	integer	no
572.It kern.ipc.sysvsem	integer	no
573.It kern.ipc.sysvshm	integer	no
574.It kern.ipc.sysvipc_info	struct	no
575.It kern.ipc.shmmax	integer	yes
576.It kern.ipc.shmmni	integer	yes
577.It kern.ipc.shmseg	integer	yes
578.It kern.ipc.shmmaxpgs	integer	yes
579.It kern.ipc.shm_use_phys	integer	yes
580.It kern.ipc.msgmni	integer	yes
581.It kern.ipc.msgseg	integer	yes
582.It kern.ipc.semmni	integer	yes
583.It kern.ipc.semmns	integer	yes
584.It kern.ipc.semmnu	integer	yes
585.El
586.Bl -tag -width "123456"
587.It Li kern.ipc.sysvmsg ( Dv KERN_SYSVIPC_MSG )
588Returns 1 if System V style message queue functionality is available
589on this system,
590otherwise\ 0.
591.It Li kern.ipc.sysvsem ( Dv KERN_SYSVIPC_SEM )
592Returns 1 if System V style semaphore functionality is available
593on this system,
594otherwise\ 0.
595.It Li kern.ipc.sysvshm ( Dv KERN_SYSVIPC_SHM )
596Returns 1 if System V style share memory functionality is available
597on this system,
598otherwise\ 0.
599.It Li kern.ipc.sysvipc_info ( Dv KERN_SYSVIPC_INFO )
600Return System V style IPC configuration and run-time information.
601The fourth level name selects the System V style IPC facility.
602.Bl -column "KERN_SYSVIPC_MSG_INFO" "struct shm_sysctl_info" -offset indent
603.It Sy Fourth level name	Sy Type
604.It KERN_SYSVIPC_MSG_INFO	struct msg_sysctl_info
605.It KERN_SYSVIPC_SEM_INFO	struct sem_sysctl_info
606.It KERN_SYSVIPC_SHM_INFO	struct shm_sysctl_info
607.El
608.Bl -tag -width "123456"
609.It Li KERN_SYSVIPC_MSG_INFO
610Return information on the System V style message facility.
611The
612.Sy msg_sysctl_info
613structure is defined in
614.In sys/msg.h .
615.It Li KERN_SYSVIPC_SEM_INFO
616Return information on the System V style semaphore facility.
617The
618.Sy sem_sysctl_info
619structure is defined in
620.In sys/sem.h .
621.It Li KERN_SYSVIPC_SHM_INFO
622Return information on the System V style shared memory facility.
623The
624.Sy shm_sysctl_info
625structure is defined in
626.In sys/shm.h .
627.El
628.It Li kern.ipc.shmmax ( Dv KERN_SYSVIPC_SHMMAX )
629Max shared memory segment size in bytes.
630.It Li kern.ipc.shmmni ( Dv KERN_SYSVIPC_SHMMNI )
631Max number of shared memory identifiers.
632.It Li kern.ipc.shmseg ( Dv KERN_SYSVIPC_SHMSEG )
633Max shared memory segments per process.
634.It Li kern.ipc.shmmaxpgs ( Dv KERN_SYSVIPC_SHMMAXPGS )
635Max amount of shared memory in pages.
636.It Li kern.ipc.shm_use_phys ( Dv KERN_SYSVIPC_SHMUSEPHYS )
637Locking of shared memory in physical memory.
638If 0, memory can be swapped
639out, otherwise it will be locked in physical memory.
640.It Li kern.ipc.msgmni
641Max number of message queue identifiers.
642.It Li kern.ipc.msgseg
643Max number of number of message segments.
644.It Li kern.ipc.semmni
645Max number of number of semaphore identifiers.
646.It Li kern.ipc.semmns
647Max number of number of semaphores in system.
648.It Li kern.ipc.semmnu
649Max number of undo structures in system.
650.El
651.It Li kern.job_control ( Dv KERN_JOB_CONTROL )
652Return 1 if job control is available on this system, otherwise\ 0.
653.It Li kern.labeloffset ( Dv KERN_LABELOFFSET )
654The offset within the sector specified by
655.Dv KERN_LABELSECTOR
656of the
657.Xr disklabel 5 .
658.It Li kern.labelsector ( Dv KERN_LABELSECTOR )
659The sector number containing the
660.Xr disklabel 5 .
661.It Li kern.login_name_max ( Dv KERN_LOGIN_NAME_MAX )
662The size of the storage required for a login name, in bytes,
663including the terminating NUL.
664.It Li kern.logsigexit ( Dv KERN_LOGSIGEXIT )
665If this flag is non-zero, the kernel will
666.Xr log 9
667all process exits due to signals which create a
668.Xr core 5
669file, and whether the coredump was created.
670.It Li kern.mapped_files ( Dv KERN_MAPPED_FILES )
671Returns 1 if the
672.St -p1003.1b-93
673Memory Mapped Files Option is available on this system,
674otherwise\ 0.
675.It Li kern.maxfiles ( Dv KERN_MAXFILES )
676The maximum number of open files that may be open in the system.
677.It Li kern.maxpartitions ( Dv KERN_MAXPARTITIONS )
678The maximum number of partitions allowed per disk.
679.It Li kern.maxlwp
680The maximum number of Lightweight Processes (threads) the system allows
681per uid.
682.It Li kern.maxphys ( Dv KERN_MAXPHYS )
683Maximum raw I/O transfer size.
684.It Li kern.maxproc ( Dv KERN_MAXPROC )
685The maximum number of simultaneous processes the system will allow.
686.It Li kern.maxptys ( Dv KERN_MAXPTYS )
687The maximum number of pseudo terminals.
688This value can be both raised and lowered, though it cannot
689be set lower than number of currently used ptys.
690See also
691.Xr pty 4 .
692.It Li kern.maxvnodes ( Dv KERN_MAXVNODES )
693The maximum number of vnodes available on the system.
694This can only be raised.
695.It Li kern.mbuf ( Dv KERN_MBUF )
696Return information about the mbuf control variables.
697Mbufs are data structures which store network packets and other data
698structures in the networking code, see
699.Xr mbuf 9 .
700The third level names for the mbuf variables are detailed below.
701The changeable column shows whether a process with appropriate
702privilege may change the value.
703.Bl -column "kern.mbuf.nmbclusters" "integer" "Changeable" -offset indent
704.It Sy Third level name	Sy Type	Sy Changeable
705.\" XXX Changeable? really?
706.It kern.mbuf.mblowat	integer	yes
707.It kern.mbuf.mclbytes	integer	yes
708.It kern.mbuf.mcllowat	integer	yes
709.It kern.mbuf.msize	integer	yes
710.It kern.mbuf.nmbclusters	integer	yes
711.El
712.Pp
713The variables are as follows:
714.Bl -tag -width "123456"
715.It Li kern.mbuf.mblowat ( Dv MBUF_MBLOWAT )
716The mbuf low water mark.
717.It Li kern.mbuf.mclbytes ( Dv MBUF_MCLBYTES )
718The mbuf cluster size.
719.It Li kern.mbuf.mcllowat ( Dv MBUF_MCLLOWAT )
720The mbuf cluster low water mark.
721.It Li kern.mbuf.msize ( Dv MBUF_MSIZE )
722The mbuf base size.
723.It Li kern.mbuf.nmbclusters ( Dv MBUF_NMBCLUSTERS )
724The limit on the number of mbuf clusters.
725The variable can only be increased, and only increased on machines with
726direct-mapped pool pages.
727.El
728.It Li kern.memlock ( Dv KERN_MEMLOCK )
729Returns 1 if the
730.St -p1003.1b-93
731Process Memory Locking Option is available on this system,
732otherwise\ 0.
733.It Li kern.memlock_range ( Dv KERN_MEMLOCK_RANGE )
734Returns 1 if the
735.St -p1003.1b-93
736Range Memory Locking Option is available on this system,
737otherwise\ 0.
738.It Li kern.memory_protection ( Dv KERN_MEMORY_PROTECTION )
739Returns 1 if the
740.St -p1003.1b-93
741Memory Protection Option is available on this system,
742otherwise\ 0.
743.It Li kern.messages
744Kernel console message verbosity.
745See
746.Sy \<sys/reboot.h\>
747.Bl -column "verbosity" "setting" -offset indent
748.It Sy Verbosity       Setting
749.It \ \ \ \ 0  Silent Sy AB_SILENT
750.It \ \ \ \ 1  Quiet Sy AB_QUIET
751.It \ \ \ \ 2  Normal Sy AB_NORMAL
752.It \ \ \ \ 3  Verbose Sy AB_VERBOSE
753.It \ \ \ \ 4  Debug Sy AB_DEBUG
754.El
755.It Li kern.module
756Settings related to kernel modules.
757The third level names for the settings are described below.
758.Bl -column "kern.module.autoload" "integer" "Changeable" -offset indent
759.It Sy Third level name	Sy Type	Sy Changeable
760.It kern.module.autoload	integer	yes
761.It kern.module.autotime	integer	yes
762.It kern.module.verbose	integer	yes
763.El
764.Pp
765The variables are as follows:
766.Bl -tag -width "123456"
767.It Li kern.module.autoload
768A boolean that controls whether kernel modules are loaded automatically.
769See
770.Xr module 7
771for additional details.
772.It Li kern.module.autotime
773An integer that controls the delay before an attempt is made to
774automatically unload a module that was auto-loaded.
775Setting this value to zero disables the auto-unload function.
776.It Li kern.module.verbose
777A boolean that enables or disables verbose
778debug messages related to kernel modules.
779.El
780.It Li kern.monotonic_clock ( Dv KERN_MONOTONIC_CLOCK )
781Returns the standard version the implementation of the
782.St -p1003.1b-93
783Monotonic Clock Option conforms to,
784otherwise\ 0.
785.It Li kern.mqueue
786Settings related to
787.Tn POSIX
788message queues; see
789.Xr mqueue 3 .
790This node is created dynamically when
791the corresponding kernel module is loaded.
792The third level names for the settings are described below.
793.Bl -column "kern.mqueue.mq_max_msgsize" "integer" "Changeable" -offset indent
794.It Sy Third level name	Sy Type	Sy Changeable
795.It kern.mqueue.mq_open_max	integer	yes
796.It kern.mqueue.mq_prio_max	integer	yes
797.It kern.mqueue.mq_max_msgsize	integer	yes
798.It kern.mqueue.mq_def_maxmsg	integer	yes
799.It kern.mqueue.mq_max_maxmsg	integer	yes
800.El
801.Pp
802The variables are:
803.Bl -tag -width "123456"
804.It Li kern.mqueue.mq_open_max
805The maximum number of message queue descriptors any single process can open.
806.It Li kern.mqueue.mq_prio_max
807The maximum priority of a message.
808.It Li kern.mqueue.mq_max_msgsize
809The maximum size of a message in a message queue.
810.It Li kern.mqueue.mq_def_maxmsg
811The default maximum message count.
812.It Li kern.mqueue.mq_max_maxmsg
813The maximum number of messages in a message queue.
814.El
815.It Li kern.msgbuf ( Dv KERN_MSGBUF )
816The kernel message buffer, rotated so that the head of the circular kernel
817message buffer is at the start of the returned data.
818The returned data may contain NUL bytes.
819.It Li kern.msgbufsize ( Dv KERN_MSGBUFSIZE )
820The maximum number of characters that the kernel message buffer can hold.
821.It Li kern.ngroups ( Dv KERN_NGROUPS )
822The maximum number of supplemental groups.
823.\" .It Li kern.no_sa_support
824.\" XXX: Undocumented.
825.It Li kern.ntptime ( Dv KERN_NTPTIME )
826A
827.Vt struct ntptimeval
828structure is returned.
829This structure contains data used by the
830.Xr ntpd 8
831program.
832.It Li kern.osrelease ( Dv KERN_OSRELEASE )
833The system release string.
834.It Li kern.osrevision ( Dv KERN_OSREV )
835The system revision string.
836.It Li kern.ostype ( Dv KERN_OSTYPE )
837The system type string.
838.\".It Li kern.panic_now
839.\" XXX: Undocumented.
840.It Li kern.pipe ( Dv KERN_PIPE )
841Pipe settings.
842The third level names for the  integer pipe settings is detailed below.
843The changeable column shows whether a process with appropriate
844privilege may change the value.
845.Bl -column "kern.pipe.maxbigpipes" "integer" "Changeable" -offset indent
846.It Sy Third level name	Sy Type	Sy Changeable
847.It kern.pipe.kvasiz	integer	yes
848.It kern.pipe.maxbigpipes	integer	yes
849.It kern.pipe.maxkvasz	integer	yes
850.It kern.pipe.limitkva	integer	yes
851.It kern.pipe.nbigpipes	integer	yes
852.El
853.Pp
854The variables are as follows:
855.Bl -tag -width "123456"
856.It Li kern.pipe.kvasiz ( Dv KERN_PIPE_KVASIZ )
857Amount of kernel memory consumed by pipe buffers.
858.It Li kern.pipe.maxbigpipes ( Dv KERN_PIPE_MAXBIGPIPES )
859Maximum number of
860.Dq big
861pipes.
862.It Li kern.pipe.maxkvasz ( Dv KERN_PIPE_MAXKVASZ )
863Maximum amount of kernel memory to be used for pipes.
864.It Li kern.pipe.limitkva ( Dv KERN_PIPE_LIMITKVA )
865Limit for direct transfers via page loan.
866.It Li kern.pipe.nbigpipes ( Dv KERN_PIPE_NBIGPIPES )
867Number of
868.Dq big
869pipes.
870.El
871.It Li kern.pool
872Provides statistics about the
873.Xr pool 9
874and
875.Xr pool_cache 9
876subsystems.
877.\" XXX: Undocumented .It Li kern.posix ( ? )
878.\"	 This is a node in which the only variable is semmax.
879.It Li kern.posix1version ( Dv KERN_POSIX1 )
880The version of ISO/IEC 9945
881.Pq St -p1003.1
882with which the system attempts to comply.
883.It Li kern.posix_aio
884The version of
885.St -p1003.1
886and its Asynchronous I/O option to which the system attempts to conform.
887.It Li kern.posix_barriers ( Dv KERN_POSIX_BARRIERS )
888The version of
889.St -p1003.1
890and its
891Barriers
892option to which the system attempts to conform,
893otherwise\ 0.
894.It Li kern.posix_reader_writer_locks ( Dv KERN_POSIX_READER_WRITER_LOCKS )
895The version of
896.St -p1003.1
897and its
898Read-Write Locks
899option to which the system attempts to conform,
900otherwise\ 0.
901.\".It Li kern.posix_sched
902.\" XXX: Undocumented.
903.It Li kern.posix_semaphores ( Dv KERN_POSIX_SEMAPHORES )
904The version of
905.St -p1003.1
906and its
907Semaphores
908option to which the system attempts to conform,
909otherwise\ 0.
910.It Li kern.posix_spin_locks ( Dv KERN_POSIX_SPIN_LOCKS )
911The version of
912.St -p1003.1
913and its
914Spin Locks
915option to which the system attempts to conform,
916otherwise\ 0.
917.It Li kern.posix_threads ( Dv KERN_POSIX_THREADS )
918The version of
919.St -p1003.1
920and its
921Threads
922option to which the system attempts to conform,
923otherwise\ 0.
924.It Li kern.posix_timers ( Dv KERN_POSIX_TIMERS )
925The version of
926.St -p1003.1
927and its
928Timers
929option to which the system attempts to conform,
930otherwise\ 0.
931.It Li kern.proc ( Dv KERN_PROC )
932Return the entire process table, or a subset of it.
933An array of
934.Vt struct kinfo_proc
935structures is returned,
936whose size depends on the current number of such objects in the system.
937The third and fourth level numeric names are as follows:
938.Bl -column "KERN_PROC_SESSION" "Fourth level is:" -offset indent
939.It Sy Third level name	Sy Fourth level is:
940.It KERN_PROC_ALL	None
941.It KERN_PROC_GID	A group ID
942.It KERN_PROC_PID	A process ID
943.It KERN_PROC_PGRP	A process group
944.It KERN_PROC_RGID	A real group ID
945.It KERN_PROC_RUID	A real user ID
946.It KERN_PROC_SESSION	A session ID
947.It KERN_PROC_TTY	A tty device
948.It KERN_PROC_UID	A user ID
949.El
950.It Li kern.proc2 ( Dv KERN_PROC2 )
951As for
952.Dv KERN_PROC ,
953but an array of
954.Vt struct kinfo_proc2
955structures are returned.
956The fifth level name is the size of the
957.Vt struct kinfo_proc2
958and the sixth level name is the number of structures to return.
959.It Li kern.proc_args ( Dv KERN_PROC_ARGS )
960Return the argv or environment strings (or the number thereof)
961of a process.
962Multiple strings are returned separated by NUL characters.
963The third level name is the process ID.
964The fourth level name is as follows:
965.Bl -column "KERN_PROG_PATHNAME" "The full pathname of the executable" -offset indent
966.It Dv KERN_PROC_ARGV	The argv strings
967.It Dv KERN_PROC_ENV	The environ strings
968.It Dv KERN_PROC_NARGV	The number of argv strings
969.It Dv KERN_PROC_NENV	The number of environ strings
970.It Dv KERN_PROC_PATHNAME	The full pathname of the executable
971.El
972.It Li kern.profiling ( Dv KERN_PROF )
973Return profiling information about the kernel.
974If the kernel is not compiled for profiling,
975attempts to retrieve any of the
976.Dv KERN_PROF
977values will fail with
978.Er EOPNOTSUPP .
979The third level names for the string and integer profiling information
980is detailed below.
981The changeable column shows whether a process with appropriate
982privilege may change the value.
983.Bl -column "kern.profiling.gmonparam" "struct gmonparam" "Changeable" -offset indent
984.It Sy Third level name	Sy Type	Sy Changeable
985.It kern.profiling.count	u_short[\|]	yes
986.It kern.profiling.froms	u_short[\|]	yes
987.It kern.profiling.gmonparam	struct gmonparam	no
988.It kern.profiling.state	integer	yes
989.It kern.profiling.tos	struct tostruct	yes
990.El
991.Pp
992The variables are as follows:
993.Bl -tag -width "123456"
994.It Li kern.profiling.count ( Dv GPROF_COUNT )
995Array of statistical program counter counts.
996.It Li kern.profiling.froms ( Dv GPROF_FROMS )
997Array indexed by program counter of call-from points.
998.It Li kern.profiling.gmonparams ( Dv GPROF_GMONPARAM )
999Structure giving the sizes of the above arrays.
1000.It Li kern.profiling.state ( Dv GPROF_STATE )
1001Profiling state.
1002If set to
1003.Dv GMON_PROF_ON ,
1004starts profiling.
1005If set to
1006.Dv GMON_PROF_OFF ,
1007stops profiling.
1008.It Li kern.profiling.tos ( Dv GPROF_TOS )
1009Array of
1010.Vt struct tostruct
1011describing destination of calls and their counts.
1012.El
1013.\" .It Li kern.pset
1014.\" XXX: Undocumented.
1015.It Li kern.rawpartition ( Dv KERN_RAWPARTITION )
1016The raw partition of a disk (a == 0).
1017.It Li kern.root_device ( Dv KERN_ROOT_DEVICE )
1018The name of the root device (e.g.,
1019.Dq wd0 ) .
1020.It Li kern.root_partition ( Dv KERN_ROOT_PARTITION )
1021The root partition on the root device (a == 0).
1022.It Li kern.rtc_offset ( Dv KERN_RTC_OFFSET )
1023Return the offset of real time clock from UTC in minutes.
1024.It Li kern.saved_ids ( Dv KERN_SAVED_IDS )
1025Returns 1 if saved set-group and saved set-user ID is available.
1026.It Li kern.sbmax ( Dv KERN_SBMAX )
1027Maximum socket buffer size.
1028.\" XXX units?
1029.It Li kern.securelevel ( Dv KERN_SECURELVL )
1030See
1031.Xr secmodel_securelevel 9 .
1032.\" .It Li kern.sched
1033.\" XXX: Undocumented.
1034.It Li kern.somaxkva ( Dv KERN_SOMAXKVA )
1035Maximum amount of kernel memory to be used for socket buffers.
1036.\" XXX units?
1037.It Li kern.synchronized_io ( Dv KERN_SYNCHRONIZED_IO )
1038Returns 1 if the
1039.St -p1003.1b-93
1040Synchronized I/O Option is available on this system,
1041otherwise\ 0.
1042.It Li kern.timecounter ( dynamic )
1043Display and control the timecounter source of the system.
1044.Bl -column "kern.timecounter.timestepwarnings" "integer" "Changeable" -offset indent
1045.It Sy Third level name	Sy Type	Sy Changeable
1046.It kern.timecounter.choice	string	no
1047.It kern.timecounter.hardware	string	yes
1048.It kern.timecounter.timestepwarnings	integer	yes
1049.El
1050.Pp
1051The variables are as follows:
1052.Bl -tag -width "123456"
1053.It Li kern.timecounter.choice ( dynamic )
1054The list of available timecounters with their quality and frequency.
1055.It Li kern.timecounter.hardware ( dynamic )
1056The currently selected timecounter source.
1057.It Li kern.timecounter.timestepwarnings ( dynamic )
1058If non-zero display a message each time the time is stepped.
1059.El
1060.It Li kern.timex ( Dv KERN_TIMEX )
1061Not available.
1062.It Li kern.tkstat ( Dv KERN_TKSTAT )
1063Return information about the number of characters sent and received
1064on ttys.
1065The third level names for the tty statistic variables are detailed below.
1066The changeable column shows whether a process
1067with appropriate privilege may change the value.
1068.Bl -column "kern.tkstat.cancc" "quad" "Changeable" -offset indent
1069.It Sy Third level name	Sy Type	Sy Changeable
1070.It kern.tkstat.cancc	quad	no
1071.It kern.tkstat.nin	quad	no
1072.It kern.tkstat.nout	quad	no
1073.It kern.tkstat.rawcc	quad	no
1074.El
1075.Pp
1076The variables are as follows:
1077.Bl -tag -width "123456"
1078.It Li kern.tkstat.cancc ( Dv KERN_TKSTAT_CANCC )
1079The number of canonical input characters.
1080.It Li kern.tkstat.nin ( Dv KERN_TKSTAT_NIN )
1081The total number of input characters.
1082.It Li kern.tkstat.nout ( Dv KERN_TKSTAT_NOUT )
1083The total number of output characters.
1084.It Li kern.tkstat.rawcc ( Dv KERN_TKSTAT_RAWCC )
1085The number of raw input characters.
1086.El
1087.It Li kern.tty
1088The third level names for the tty setup variables are detailed below.
1089The changeable column shows whether a process
1090with appropriate privilege may change the value.
1091.Bl -column "kern.tty.qsize" "int" "Changeable" -offset indent
1092.It Sy Third level name	Sy Type	Sy Changeable
1093.It kern.tty.qsize	int	yes
1094.El
1095.Pp
1096The variables are as follows:
1097.Bl -tag -width "123456"
1098.It Li kern.tty.qsize
1099Control/display the size of the default input and output queues selected
1100during tty creation.
1101Is converted to a power of two and its range is between
1102.Dv 1024
1103and
1104.Dv 65536 .
1105.El
1106.It Li kern.uidinfo
1107Resource usage for the current user.
1108.Bl -column "kern.uidinfo.proccnt" "integer" "Changeable" -offset indent
1109.It Sy Third level name	Sy Type	Sy Changeable
1110.It kern.uidinfo.proccnt	integer	no
1111.It kern.uidinfo.lwpcnt	integer	no
1112.It kern.uidinfo.lockcnt	integer	no
1113.It kern.uidinfo.sbsize	integer	no
1114.El
1115.Bl -tag -width "123456"
1116.It Li kern.uidinfo.proccnt
1117Returns the number of active processes for the current user.
1118.It Li kern.uidinfo.lwpcnt
1119Returns the number of active threads for the current user; the first thread
1120of each process is not counted.
1121.It Li kern.uidinfo.lockcnt
1122Number of locks held by the current user.
1123.It Li kern.uidinfo.sbsize
1124Number of bytes in socket buffers allocated to the current user.
1125.El
1126.It Li kern.urandom ( Dv KERN_URND )
1127Random integer value.
1128.It Li kern.usercrypto
1129When enabled, allows userland to
1130.Xr open 2
1131the
1132.Pa /dev/crypto
1133special device, used by the
1134.Xr crypto 4
1135system.
1136.It Li kern.userasymcrypto
1137Enables or disables the use of software asymmetric crypto support in the
1138.Xr crypto 4
1139system.
1140.It Li kern.veriexec
1141Runtime information for
1142.Xr veriexec 8 .
1143.Bl -column "kern.veriexec.algorithms" "integer" "Changeable" -offset indent
1144.It Sy Third level name	Sy Type	Sy Changeable
1145.It kern.veriexec.algorithms	string	no
1146.It kern.veriexec.count	node	not applicable
1147.It kern.veriexec.strict	integer	yes
1148.It kern.veriexec.verbose	integer	yes
1149.El
1150.Bl -tag -width "123456"
1151.It Li kern.veriexec.algorithms
1152Returns a string with the supported algorithms in Veriexec.
1153.It Li kern.veriexec.count
1154Sub-nodes are added to this node as new mounts are monitored by Veriexec.
1155Each mount will be under its own
1156.No tableN
1157node.
1158Under each node there will be three variables, indicating the mount
1159point, the file system type, and the number of entries.
1160.It Li kern.veriexec.strict
1161Controls the strict level of Veriexec.
1162See
1163.Xr security 7
1164for more information on each level's implications.
1165.It Li kern.veriexec.verbose
1166Controls the verbosity level of Veriexec.
1167If 0, only the minimal
1168indication required will be given about what's happening - fingerprint
1169mismatches, removal of entries from the tables, modification of a
1170fingerprinted file.
1171If 1, more messages will be printed (ie., when a file with a valid
1172fingerprint is accessed).
1173Verbose level 2 is debug mode.
1174.El
1175.It Li kern.version ( Dv KERN_VERSION )
1176The system version string.
1177.It Li kern.vnode ( Dv KERN_VNODE )
1178Return the entire vnode table.
1179Note, the vnode table is not necessarily a consistent snapshot of
1180the system.
1181The returned data consists of an array whose size depends on the
1182current number of such objects in the system.
1183Each element of the array contains the kernel address of a vnode
1184.Vt struct vnode *
1185followed by the vnode itself
1186.Vt struct vnode .
1187.\" XXX: Undocumented: kern.lwp: no children?
1188.El
1189.Ss The machdep.* subtree
1190The set of variables defined is architecture dependent.
1191Most architectures define at least the following variables.
1192.Bl -column "machdep.booted_kernel" "Type" "Changeable" -offset indent
1193.It Sy Second level name	Sy Type	Sy Changeable
1194.It Li machdep.booted_kernel	string	no
1195.El
1196.\" XXX: Document the above.
1197.Ss The net.* subtree
1198The string and integer information available for the
1199.Li net
1200level is detailed below.
1201The changeable column shows whether a process with appropriate
1202privilege may change the value.
1203The second and third levels are typically the protocol family and
1204protocol number, though this is not always the case.
1205.Bl -column "Second level name" "IPsec key management values" "Changeable" -offset indent
1206.It Sy Second level name	Sy Type	Sy Changeable
1207.It net.route	routing messages	no
1208.It net.inet	IPv4 values	yes
1209.It net.inet6	IPv6 values	yes
1210.It net.key	IPsec key management values	yes
1211.El
1212.Bl -tag -width "123456"
1213.It Li net.route ( Dv PF_ROUTE )
1214.\" XXX really?
1215Return the entire routing table or a subset of it.
1216The data is returned as a sequence of routing messages (see
1217.Xr route 4
1218for the header file, format and meaning).
1219The length of each message is contained in the message header.
1220.Pp
1221The third level name is a protocol number, which is currently always\ 0.
1222The fourth level name is an address family, which may be set to 0 to
1223select all address families.
1224The fifth and sixth level names are as follows:
1225.Bl -column "Fifth level name" "Sixth level is:" -offset indent
1226.It Sy Fifth level name	Sy Sixth level is:
1227.It NET_RT_FLAGS	rtflags
1228.It NET_RT_DUMP	None
1229.It NET_RT_IFLIST	None
1230.El
1231.It Li net.inet ( Dv PF_INET )
1232Get or set various global information about the IPv4
1233.Pq Internet Protocol version 4 .
1234The third level name is the protocol.
1235The fourth level name is the variable name.
1236The currently defined protocols and names are:
1237.Bl -column "Protocol" "anonportalgo.available" "integer" "Changeable" -offset indent
1238.It Sy Protocol	Variable	Sy Type	Sy Changeable
1239.It arp	down	integer	yes
1240.It arp	keep	integer	yes
1241.It arp	log_movements	integer	yes
1242.It arp	log_permanent_modify	integer	yes
1243.It arp	log_unknown_network	integer	yes
1244.It arp	log_wrong_iface	integer	yes
1245.It carp	allow	integer	yes
1246.It carp	preempt	integer	yes
1247.It carp	log	integer	yes
1248.It carp	arpbalance	integer	yes
1249.It icmp	errppslimit	integer	yes
1250.It icmp	maskrepl	integer	yes
1251.It icmp	rediraccept	integer	yes
1252.It icmp	redirtimeout	integer	yes
1253.It icmp	bmcastecho	integer	yes
1254.It ip	allowsrcrt	integer	yes
1255.It ip 	anonportalgo.selected	string	yes
1256.It ip 	anonportalgo.available	string	yes
1257.It ip 	anonportalgo.reserve	struct	yes
1258.It ip	anonportmax	integer	yes
1259.It ip	anonportmin	integer	yes
1260.It ip	checkinterface	integer	yes
1261.It ip	dad_count	integer	yes
1262.It ip	directed-broadcast	integer	yes
1263.It ip	do_loopback_cksum	integer	yes
1264.It ip	forwarding	integer	yes
1265.It ip	forwsrcrt	integer	yes
1266.It ip	gifttl	integer	yes
1267.It ip	grettl	integer	yes
1268.It ip	hashsize	integer	yes
1269.It ip	hostzerobroadcast	integer	yes
1270.It ip	lowportmin	integer	yes
1271.It ip	lowportmax	integer	yes
1272.It ip	maxflows	integer	yes
1273.It ip	maxfragpackets	integer	yes
1274.It ip	mtudisc	integer	yes
1275.It ip	mtudisctimeout	integer	yes
1276.It ip	random_id	integer	yes
1277.It ip	redirect	integer	yes
1278.It ip	subnetsarelocal	integer	yes
1279.It ip	ttl	integer	yes
1280.It tcp	rfc1323	integer	yes
1281.It tcp	sendspace	integer	yes
1282.It tcp	recvspace	integer	yes
1283.It tcp	mssdflt	integer	yes
1284.It tcp	syn_cache_limit	integer	yes
1285.It tcp	syn_bucket_limit	integer	yes
1286.It tcp	syn_cache_interval	integer	yes
1287.It tcp	init_win	integer	yes
1288.It tcp	init_win_local	integer	yes
1289.It tcp	mss_ifmtu	integer	yes
1290.It tcp	win_scale	integer	yes
1291.It tcp	timestamps	integer	yes
1292.It tcp	compat_42	integer	yes
1293.It tcp	cwm	integer	yes
1294.It tcp	cwm_burstsize	integer	yes
1295.It tcp	ack_on_push	integer	yes
1296.It tcp	keepidle	integer	yes
1297.It tcp	keepintvl	integer	yes
1298.It tcp	keepcnt	integer	yes
1299.It tcp	slowhz	integer	no
1300.It tcp	keepinit	integer	yes
1301.It tcp	log_refused	integer	yes
1302.It tcp	rstppslimit	integer	yes
1303.It tcp	ident	struct	no
1304.It tcp	drop	struct	no
1305.It tcp	sack.enable	integer	yes
1306.It tcp	sack.globalholes	integer	no
1307.It tcp	sack.globalmaxholes	integer	yes
1308.It tcp	sack.maxholes	integer	yes
1309.It tcp	ecn.enable	integer	yes
1310.It tcp	ecn.maxretries	integer	yes
1311.It tcp	congctl.selected	string	yes
1312.It tcp	congctl.available	string	yes
1313.It tcp	abc.enable	integer	yes
1314.It tcp	abc.aggressive	integer	yes
1315.It udp	checksum	integer	yes
1316.It udp	do_loopback_cksum	integer	yes
1317.It udp	recvspace	integer	yes
1318.It udp	sendspace	integer	yes
1319.El
1320.Pp
1321The variables are as follows:
1322.Bl -tag -width "123456"
1323.It Li arp.down
1324Failed ARP entry lifetime.
1325.It Li arp.keep
1326Valid ARP entry lifetime.
1327.It Li carp.allow
1328If set to 0, incoming
1329.Xr carp 4
1330packets will not be processed.
1331If set to any other value, processing will occur.
1332Enabled by default.
1333.It Li carp.arpbalance
1334If set to any value other than 0, the ARP balancing functionality of
1335.Xr carp 4
1336is enabled.
1337When ARP requests are received for an IP address which is part of any virtual
1338host, carp will hash the source IP in the ARP request to select one of the
1339virtual hosts from the set of all the virtual hosts which have that IP address.
1340The master of that host will respond with the correct virtual MAC address.
1341Disabled by default.
1342.It Li carp.log
1343If set to any value other than 0,
1344.Xr carp 4
1345will log errors.
1346Disabled by default.
1347.It Li carp.preempt
1348If set to 0,
1349.Xr carp 4
1350will not attempt to become master if it is receiving advertisements from
1351another active master.
1352If set to any other value, carp will become master of the virtual host if it
1353believes it can send advertisements more frequently than the current master.
1354Disabled by default.
1355.It Li ip.allowsrcrt
1356If set to 1, the host accepts source routed packets.
1357.It Li ip.anonportalgo.available
1358The available RFC 6056 port randomization algorithms.
1359.It Li ip.anonportalgo.reserve
1360A bitmask of ports that will not be used during anonymous or privileged
1361port selection.
1362.It Li ip.anonportalgo.selected
1363The currently selected RFC 6056 port randomization algorithm.
1364.It Li ip.anonportmax
1365The highest port number to use for TCP and UDP ephemeral port allocation.
1366This cannot be set to less than 1024 or greater than 65535, and must
1367be greater than
1368.Li ip.anonportmin .
1369.It Li ip.anonportmin
1370The lowest port number to use for TCP and UDP ephemeral port allocation.
1371This cannot be set to less than 1024 or greater than 65535.
1372.It Li ip.checkinterface
1373If set to non-zero, the host will reject packets addressed to it
1374that arrive on an interface not bound to that address.
1375Currently, this must be disabled if ipnat is used to translate the
1376destination address to another local interface, or if addresses
1377are added to the loopback interface instead of the interface where
1378the packets for those packets are received.
1379.It Li ip.dad_count
1380The number of
1381.Xr arp 4
1382probes sent for Address Conflict Detection.
1383Set to 0 to disable this.
1384.It Li ip.directed-broadcast
1385If set to 1, enables directed broadcast behavior for the host.
1386.It Li ip.do_loopback_cksum
1387Perform IP checksum on loopback.
1388.It Li ip.forwarding
1389If set to 1, enables IP forwarding for the host,
1390meaning that the host is acting as a router.
1391.It Li ip.forwsrcrt
1392If set to 1, enables forwarding of source-routed packets for the host.
1393This value may only be changed if the kernel security level is less than 1.
1394.It Li ip.gifttl
1395The maximum time-to-live (hop count) value for an IPv4 packet generated by
1396.Xr gif 4
1397tunnel interface.
1398.It Li ip.grettl
1399The maximum time-to-live (hop count) value for an IPv4 packet generated by
1400.Xr gre 4
1401tunnel interface.
1402.It Li ip.hashsize
1403The size of IPv4 Fast Forward hash table.
1404This value must be a power of 2 (64, 256...).
1405A larger hash table size results in fewer collisions.
1406Also see
1407.Li ip.maxflows .
1408.It Li ip.hostzerobroadcast
1409All zeroes address is broadcast address.
1410.It Li ip.lowportmax
1411The highest port number to use for TCP and UDP reserved port allocation.
1412This cannot be set to less than 0 or greater than 1024, and must
1413be greater than
1414.Li ip.lowportmin .
1415.It Li ip.lowportmin
1416The lowest port number to use for TCP and UDP reserved port allocation.
1417This cannot be set to less than 0 or greater than 1024, and must
1418be smaller than
1419.Li ip.lowportmax .
1420.It Li ip.maxflows
1421IPv4 Fast Forwarding is enabled by default.
1422If set to 0, IPv4 Fast Forwarding is disabled.
1423.Li ip.maxflows
1424controls the maximum amount of flows which can be created.
1425The default value is 256.
1426.It Li ip.maxfragpackets
1427The maximum number of fragmented packets the node will accept.
14280 means that the node will not accept any fragmented packets.
1429\-1 means that the node will accept as many fragmented packets as it receives.
1430The flag is provided basically for avoiding possible DoS attacks.
1431.It Li ip.mtudisc
1432If set to 1, enables Path MTU Discovery (RFC 1191).
1433When Path MTU Discovery is enabled, the transmitted TCP segment
1434size will be determined by the advertised maximum segment size
1435(MSS) from the remote end, as constrained by the path MTU.
1436If MTU Discovery is disabled, the transmitted segment size will
1437never be greater than
1438.Li tcp.mssdflt
1439(the local maximum segment size).
1440.It Li ip.mtudisctimeout
1441The number of seconds in which a route added by the Path MTU
1442Discovery engine will time out.
1443When the route times out, the Path
1444MTU Discovery engine will attempt to probe a larger path MTU.
1445.It Li ip.random_id
1446Assign random ip_id values.
1447.It Li ip.redirect
1448If set to 1, ICMP redirects may be sent by the host.
1449This option is ignored unless the host is routing IP packets,
1450and should normally be enabled on all systems.
1451.It Li ip.subnetsarelocal
1452If set to 1, subnets are to be considered local addresses.
1453.It Li ip.ttl
1454The maximum time-to-live (hop count) value for an IP packet sourced by
1455the system.
1456This value applies to normal transport protocols, not to ICMP.
1457.It Li icmp.errppslimit
1458The variable specifies the maximum number of outgoing ICMP error messages,
1459per second.
1460ICMP error messages that exceeded the value are subject to rate limitation
1461and will not go out from the node.
1462Negative value disables rate limitation.
1463.It Li icmp.maskrepl
1464If set to 1, ICMP network mask requests are to be answered.
1465.It Li icmp.rediraccept
1466If set to non-zero, the host will accept ICMP redirect packets.
1467Note that routers will never accept ICMP redirect packets,
1468and the variable is meaningful on IP hosts only.
1469.It Li icmp.redirtimeout
1470The variable specifies lifetime of routing entries generated by incoming
1471ICMP redirect.
1472This defaults to 600 seconds.
1473.It Li icmp.returndatabytes
1474Number of bytes to return in an ICMP error message.
1475.It Li icmp.bmcastecho
1476If set to 1, enables responding to ICMP echo or timestamp request to the
1477broadcast address.
1478.It Li tcp.ack_on_push
1479If set to 1, TCP is to immediately transmit an ACK upon reception of
1480a packet with PUSH set.
1481This can avoid losing a round trip time in some rare situations,
1482but has the caveat of potentially defeating TCP's delayed ACK algorithm.
1483Use of this option is generally not recommended, but
1484the variable exists in case your configuration really needs it.
1485.It Li tcp.compat_42
1486If set to 1, enables work-arounds for bugs in the 4.2BSD TCP implementation.
1487Use of this option is not recommended, although it may be
1488required in order to communicate with extremely old TCP implementations.
1489.It Li tcp.cwm
1490If set to 1, enables use of the Hughes/Touch/Heidemann Congestion Window
1491Monitoring algorithm.
1492This algorithm prevents line-rate bursts of packets that could
1493otherwise occur when data begins flowing on an idle TCP connection.
1494These line-rate bursts can contribute to network and router congestion.
1495This can be particularly useful on World Wide Web servers
1496which support HTTP/1.1, which has lingering connections.
1497.It Li tcp.cwm_burstsize
1498The Congestion Window Monitoring allowed burst size, in terms
1499of packet count.
1500.It Li tcp.delack_ticks
1501Number of ticks to delay sending an ACK.
1502.It Li tcp.do_loopback_cksum
1503Perform TCP checksum on loopback.
1504.It Li tcp.init_win
1505A value indicating the TCP initial congestion window.
1506The valid range
1507is 0 to 10 (maximum specified by RFC6928),
1508with a default of 4 (approximately 4K per RFC3390).
1509.It Li tcp.init_win_local
1510Like
1511.Li tcp.init_win ,
1512but used when communicating with hosts on a local network.
1513.It Li tcp.keepcnt
1514Number of keepalive probes sent before declaring a connection dead.
1515If set to zero, there is no limit;
1516keepalives will be sent until some kind of
1517response is received from the peer.
1518.It Li tcp.keepidle
1519Time a connection must be idle before keepalives are sent (if keepalives
1520are enabled for the connection).
1521See also tcp.slowhz.
1522.It Li tcp.keepintvl
1523Time after a keepalive probe is sent until, in the absence of any response,
1524another probe is sent.
1525See also tcp.slowhz.
1526.It Li tcp.log_refused
1527If set to 1, refused TCP connections to the host will be logged.
1528.It Li tcp.keepinit
1529Timeout in seconds during connection establishment.
1530.It Li tcp.mss_ifmtu
1531If set to 1, TCP calculates the outgoing maximum segment size based on
1532the MTU of the appropriate interface.
1533If set to 0, it is calculated based on the greater of the MTU of the
1534interface, and the largest (non-loopback) interface MTU on the system.
1535.It Li tcp.mssdflt
1536The default maximum segment size both advertised to the peer
1537and to use when either the peer does not advertise a maximum segment size to
1538us during connection setup or Path MTU Discovery
1539.Li ( ip.mtudisc )
1540is disabled.
1541Do not change this value unless you really know what you are doing.
1542.It Li tcp.recvspace
1543The default TCP receive buffer size.
1544.It Li tcp.rfc1323
1545If set to 1, enables RFC 1323 extensions to TCP.
1546.It Li tcp.rstppslimit
1547The variable specifies the maximum number of outgoing TCP RST packets,
1548per second.
1549TCP RST packet that exceeded the value are subject to rate limitation
1550and will not go out from the node.
1551Negative value disables rate limitation.
1552.It Li tcp.ident
1553Return the user ID of a connected socket pair.
1554(RFC1413 Identification Protocol lookups.)
1555.It Li tcp.drop
1556Drop a TCP socket pair connection.
1557.It Li tcp.sack.enable
1558If set to 1, enables RFC 2018 Selective ACKnowledgement.
1559.It Li tcp.sack.globalholes
1560Global number of TCP SACK holes.
1561.It Li tcp.sack.globalmaxholes
1562Global maximum number of TCP SACK holes.
1563.It Li tcp.sack.maxholes
1564Maximum number of TCP SACK holes allowed per connection.
1565.It Li tcp.ecn.enable
1566If set to 1, enables RFC 3168 Explicit Congestion Notification.
1567.It Li tcp.ecn.maxretries
1568Number of times to retry sending the ECN-setup packet.
1569.It Li tcp.sendspace
1570The default TCP send buffer size.
1571.It Li tcp.slowhz
1572The units for tcp.keepidle and tcp.keepintvl; those variables are in ticks
1573of a clock that ticks tcp.slowhz times per second.
1574(That is, their values
1575must be divided by the tcp.slowhz value to get times in seconds.)
1576.It Li tcp.syn_bucket_limit
1577The maximum number of entries allowed per hash bucket in the TCP
1578compressed state engine.
1579.It Li tcp.syn_cache_limit
1580The maximum number of entries allowed in the TCP compressed state
1581engine.
1582.It Li tcp.timestamps
1583If rfc1323 is enabled, a value of 1 indicates RFC 1323 time stamp options,
1584used for measuring TCP round trip times, are enabled.
1585.It Li tcp.win_scale
1586If rfc1323 is enabled, a value of 1 indicates RFC 1323 window scale options,
1587for increasing the TCP window size, are enabled.
1588.It Li tcp.congctl.available
1589The available TCP congestion control algorithms.
1590.It Li tcp.congctl.selected
1591The currently selected TCP congestion control algorithm.
1592.It Li tcp.abc.enable
1593If set to 1, use RFC 3465 Appropriate Byte Counting (ABC).
1594If set to 0, use traditional Packet Counting.
1595.It Li tcp.abc.aggressive
1596Choose the L parameter found in RFC 3465.
1597L is the maximum cwnd increase for an ack during slow start.
1598If set to 1, use L=2*SMSS.
1599If set to 0, use L=1*SMSS.
1600It has no effect unless tcp.abc.enable is set to 1.
1601.It Li udp.checksum
1602If set to 1, UDP checksums are being computed.
1603Received non-zero UDP checksums are always checked.
1604Disabling UDP checksums is strongly discouraged.
1605.It Li udp.recvspace
1606The default UDP receive buffer size.
1607.It Li udp.sendspace
1608The default UDP send buffer size.
1609.El
1610.Pp
1611For variables net.*.ipsec, please refer to
1612.Xr ipsec 4 .
1613.It Li net.inet6 ( Dv PF_INET6 )
1614Get or set various global information about the IPv6
1615.Pq Internet Protocol version 6 .
1616The third level name is the protocol.
1617The fourth level name is the variable name.
1618The currently defined protocols and names are:
1619.Bl -column "Protocol" "anonportalgo.available" "integer" "Changeable" -offset indent
1620.It Sy Protocol	Variable	Sy Type	Sy Changeable
1621.It icmp6	errppslimit	integer	yes
1622.It icmp6	mtudisc_hiwat	integer	yes
1623.It icmp6	mtudisc_lowat	integer	yes
1624.It icmp6	nd6_debug	integer	yes
1625.It icmp6	nd6_delay	integer	yes
1626.It icmp6	nd6_maxnudhint	integer	yes
1627.It icmp6	nd6_mmaxtries	integer	yes
1628.It icmp6	nd6_prune	integer	yes
1629.It icmp6	nd6_umaxtries	integer	yes
1630.It icmp6	nd6_useloopback	integer	yes
1631.It icmp6	nodeinfo	integer	yes
1632.It icmp6	rediraccept	integer	yes
1633.It icmp6	redirtimeout	integer	yes
1634.It ip6	accept_rtadv	integer	yes
1635.It ip6	addctlpolicy	struct in6_addrpolicy	no
1636.It ip6	anonportalgo.selected	string	yes
1637.It ip6	anonportalgo.available	string	yes
1638.It ip6	anonportalgo.reserve	struct	yes
1639.It ip6	anonportmax	integer	yes
1640.It ip6	anonportmin	integer	yes
1641.It ip6	auto_flowlabel	integer	yes
1642.It ip6	dad_count	integer	yes
1643.It ip6	defmcasthlim	integer	yes
1644.It ip6	forwarding	integer	yes
1645.It ip6	gifhlim	integer	yes
1646.It ip6	hashsize	integer	yes
1647.It ip6	hlim	integer	yes
1648.It ip6	hdrnestlimit	integer	yes
1649.It ip6	kame_version	string	no
1650.It ip6	keepfaith	integer	yes
1651.It ip6	log_interval	integer	yes
1652.It ip6	lowportmax	integer	yes
1653.It ip6	lowportmin	integer	yes
1654.It ip6	maxdynroutes	integer	yes
1655.It ip6	maxifprefixes	integer	yes
1656.It ip6	maxifdefrouters	integer	yes
1657.It ip6	maxflows	integer	yes
1658.It ip6	maxfragpackets	integer	yes
1659.It ip6	maxfrags	integer	yes
1660.It ip6	neighborgcthresh	integer	yes
1661.It ip6	redirect	integer	yes
1662.It ip6	rr_prune	integer	yes
1663.It ip6	use_deprecated	integer	yes
1664.It ip6	v6only	integer	yes
1665.It udp6	do_loopback_cksum	integer	yes
1666.It udp6	recvspace	integer	yes
1667.It udp6	sendspace	integer	yes
1668.El
1669.Pp
1670The variables are as follows:
1671.Bl -tag -width "123456"
1672.It Li ip6.accept_rtadv
1673If set to non-zero, the node will accept ICMPv6 router advertisement packets
1674and autoconfigures address prefixes and default routers.
1675The node must be a host
1676.Pq not a router
1677for the option to be meaningful.
1678.It Li ip6.anonportalgo.available
1679The available RFC 6056 port randomization algorithms.
1680.It Li ip6.anonportalgo.reserve
1681A bitmask of ports that will not be used during anonymous or privileged
1682port selection.
1683.It Li ip6.anonportalgo.selected
1684The currently selected RFC 6056 port randomization algorithm.
1685.It Li ip6.anonportmax
1686The highest port number to use for TCP and UDP ephemeral port allocation.
1687This cannot be set to less than 1024 or greater than 65535, and must
1688be greater than
1689.Li ip6.anonportmin .
1690.It Li ip6.anonportmin
1691The lowest port number to use for TCP and UDP ephemeral port allocation.
1692This cannot be set to less than 1024 or greater than 65535.
1693.It Li ip6.auto_flowlabel
1694On connected transport protocol packets,
1695fill IPv6 flowlabel field to help intermediate routers to identify packet flows.
1696.It Li ip6.dad_count
1697The variable configures number of IPv6 DAD
1698.Pq duplicated address detection
1699probe packets.
1700The packets will be generated when IPv6 interface addresses are configured.
1701.It Li ip6.defmcasthlim
1702The default hop limit value for an IPv6 multicast packet sourced by the node.
1703This value applies to all the transport protocols on top of IPv6.
1704There are APIs to override the value, as documented in
1705.Xr ip6 4 .
1706.It Li ip6.forwarding
1707If set to 1, enables IPv6 forwarding for the node,
1708meaning that the node is acting as a router.
1709If set to 0, disables IPv6 forwarding for the node,
1710meaning that the node is acting as a host.
1711IPv6 specification defines node behavior for
1712.Dq router
1713case and
1714.Dq host
1715case quite differently, and changing this variable during operation
1716may cause serious trouble.
1717It is recommended to configure the variable at bootstrap time,
1718and bootstrap time only.
1719.It Li ip6.gifhlim
1720The maximum hop limit value for an IPv6 packet generated by
1721.Xr gif 4
1722tunnel interface.
1723.It Li ip6.hdrnestlimit
1724The number of IPv6 extension headers permitted on incoming IPv6 packets.
1725If set to 0, the node will accept as many extension headers as possible.
1726.It Li ip6.hashsize
1727The size of IPv6 Fast Forward hash table.
1728This value must be a power of 2 (64, 256, ...).
1729A larger hash table size results in fewer collisions.
1730Also see
1731.Li ip6.maxflows .
1732.It Li ip6.hlim
1733The default hop limit value for an IPv6 unicast packet sourced by the node.
1734This value applies to all the transport protocols on top of IPv6.
1735There are APIs to override the value, as documented in
1736.Xr ip6 4 .
1737.It Li ip6.kame_version
1738The string identifies the version of KAME IPv6 stack implemented in the kernel.
1739.It Li ip6.keepfaith
1740If set to non-zero, it enables
1741.Dq FAITH
1742TCP relay IPv6-to-IPv4 translator code in the kernel.
1743Refer
1744.Xr faith 4
1745and
1746.Xr faithd 8
1747for detail.
1748.It Li ip6.log_interval
1749The variable controls amount of logs generated by IPv6 packet
1750forwarding engine, by setting interval between log output
1751.Pq in seconds .
1752.It Li ip6.lowportmax
1753The highest port number to use for TCP and UDP reserved port allocation.
1754This cannot be set to less than 0 or greater than 1024, and must
1755be greater than
1756.Li ip6.lowportmin .
1757.It Li ip6.lowportmin
1758The lowest port number to use for TCP and UDP reserved port allocation.
1759This cannot be set to less than 0 or greater than 1024, and must
1760be smaller than
1761.Li ip6.lowportmax .
1762.It Li ip6.maxdynroutes
1763Maximum number of routes created by redirect.
1764Set it to negative to disable.
1765The default value is 4096.
1766.It Li ip6.maxifprefixes
1767Maximum number of prefixes created by route advertisements per interface.
1768Set it to negative to disable.
1769The default value is 16.
1770.It Li ip6.maxifdefrouters 16
1771Maximum number of default routers created by route advertisements per interface.
1772Set it to negative to disable.
1773The default value is 16.
1774.It Li ip6.maxflows
1775IPv6 Fast Forwarding is enabled by default.
1776If set to 0, IPv6 Fast Forwarding is disabled.
1777.Li ip6.maxflows
1778controls the maximum amount of flows which can be created.
1779The default value is 256.
1780.It Li ip6.maxfragpackets
1781The maximum number of fragmented packets the node will accept.
17820 means that the node will not accept any fragmented packets.
1783\-1 means that the node will accept as many fragmented packets as it receives.
1784The flag is provided basically for avoiding possible DoS attacks.
1785.It Li ip6.maxfrags
1786The maximum number of fragments the node will accept.
17870 means that the node will not accept any fragments.
1788\-1 means that the node will accept as many fragments as it receives.
1789The flag is provided basically for avoiding possible DoS attacks.
1790.It Li ip6.neighborgcthresh
1791Maximum number of entries in neighbor cache per interface.
1792Set to negative to disable.
1793The default value is 2048.
1794.It Li ip6.redirect
1795If set to 1, ICMPv6 redirects may be sent by the node.
1796This option is ignored unless the node is routing IP packets,
1797and should normally be enabled on all systems.
1798.It Li ip6.rr_prune
1799The variable specifies interval between IPv6 router renumbering prefix
1800babysitting, in seconds.
1801.It Li ip6.use_deprecated
1802The variable controls use of deprecated address, specified in RFC 2462 5.5.4.
1803.It Li ip6.v6only
1804The variable specifies initial value for
1805.Dv IPV6_V6ONLY
1806socket option for
1807.Dv AF_INET6
1808socket.
1809Please refer to
1810.Xr ip6 4
1811for detail.
1812.It Li icmp6.errppslimit
1813The variable specifies the maximum number of outgoing ICMPv6 error messages,
1814per second.
1815ICMPv6 error messages that exceeded the value are subject to rate limitation
1816and will not go out from the node.
1817Negative value disables rate limitation.
1818.It Li icmp6.mtudisc_hiwat
1819.It Li icmp6.mtudisc_lowat
1820The variables define the maximum number of routing table entries,
1821created due to path MTU discovery
1822.Pq prevents denial-of-service attacks with ICMPv6 too big messages .
1823When IPv6 path MTU discovery happens, we keep path MTU information into
1824the routing table.
1825If the number of routing table entries exceed the value,
1826the kernel will not attempt to keep the path MTU information.
1827.Li icmp6.mtudisc_hiwat
1828is used when we have verified ICMPv6 too big messages.
1829.Li icmp6.mtudisc_lowat
1830is used when we have unverified ICMPv6 too big messages.
1831Verification is performed by using address/port pairs kept in connected pcbs.
1832Negative value disables the upper limit.
1833.It Li icmp6.nd6_debug
1834If set to non-zero, kernel IPv6 neighbor discovery code will generate
1835debugging messages.
1836The debug outputs are useful to diagnose IPv6 interoperability issues.
1837The flag must be set to 0 for normal operation.
1838.It Li icmp6.nd6_delay
1839The variable specifies
1840.Dv DELAY_FIRST_PROBE_TIME
1841timing constant in IPv6 neighbor discovery specification
1842.Pq RFC 2461 ,
1843in seconds.
1844.It Li icmp6.nd6_maxnudhint
1845IPv6 neighbor discovery permits upper layer protocols to supply reachability
1846hints, to avoid unnecessary neighbor discovery exchanges.
1847The variable defines the number of consecutive hints the neighbor discovery
1848layer will take.
1849For example, by setting the variable to 3, neighbor discovery layer
1850will take 3 consecutive hints in maximum.
1851After receiving 3 hints, neighbor discovery layer will perform
1852normal neighbor discovery process.
1853.It Li icmp6.nd6_mmaxtries
1854The variable specifies
1855.Dv MAX_MULTICAST_SOLICIT
1856constant in IPv6 neighbor discovery specification
1857.Pq RFC 2461 .
1858.It Li icmp6.nd6_prune
1859The variable specifies interval between IPv6 neighbor cache babysitting,
1860in seconds.
1861.It Li icmp6.nd6_umaxtries
1862The variable specifies
1863.Dv MAX_UNICAST_SOLICIT
1864constant in IPv6 neighbor discovery specification
1865.Pq RFC 2461 .
1866.It Li icmp6.nd6_useloopback
1867If set to non-zero, kernel IPv6 stack will use loopback interface for
1868local traffic.
1869.It Li icmp6.nodeinfo
1870The variable enables responses to ICMPv6 node information queries.
1871If you set the variable to 0, responses will not be generated for
1872ICMPv6 node information queries.
1873Since node information queries can have a security impact, it is
1874possible to fine tune which responses should be answered.
1875Two separate bits can be set.
1876.Bl -tag -width "12345"
1877.It 1
1878Respond to ICMPv6 FQDN queries, e.g.
1879.Li ping6 -w .
1880.It 2
1881Respond to ICMPv6 node addresses queries, e.g.
1882.Li ping6 -a .
1883.El
1884.It Li icmp6.rediraccept
1885If set to non-zero, the host will accept ICMPv6 redirect packets.
1886Note that IPv6 routers will never accept ICMPv6 redirect packets,
1887and the variable is meaningful on IPv6 hosts
1888.Pq non-router
1889only.
1890.It Li icmp6.redirtimeout
1891The variable specifies lifetime of routing entries generated by incoming
1892ICMPv6 redirect.
1893.It Li udp6.do_loopback_cksum
1894Perform UDP checksum on loopback.
1895.It Li udp6.recvspace
1896Default UDP receive buffer size.
1897.It Li udp6.sendspace
1898Default UDP send buffer size.
1899.El
1900.Pp
1901We reuse net.*.tcp for
1902.Tn TCP
1903over
1904.Tn IPv6 ,
1905and therefore we do not have variables net.*.tcp6.
1906Variables net.inet6.udp6 have identical meaning to net.inet.udp.
1907Please refer to
1908.Li PF_INET
1909section above.
1910For variables net.*.ipsec6, please refer to
1911.Xr ipsec 4 .
1912.It Li net.key ( Dv PF_KEY )
1913Get or set various global information about the IPsec key management.
1914The third level name is the variable name.
1915The currently defined variable and names are:
1916.Bl -column "blockacq_lifetime" "integer" "Changeable" -offset indent
1917.It Sy Variable	Type	Sy Changeable
1918.It debug	integer	yes
1919.It enabled	integer	yes
1920.It used	integer	no
1921.It spi_try	integer	yes
1922.It spi_min_value	integer	yes
1923.It spi_max_value	integer	yes
1924.It larval_lifetime	integer	yes
1925.It blockacq_count	integer	yes
1926.It blockacq_lifetime	integer	yes
1927.It esp_keymin	integer	yes
1928.It esp_auth	integer	yes
1929.It ah_keymin	integer	yes
1930.El
1931.Pp
1932The variables are as follows:
1933.Bl -tag -width "123456"
1934.It Li debug
1935Turn on debugging message from within the kernel.
1936The value is a bitmap, as defined in
1937.In netkey/key_debug.h .
1938.It Li enabled
1939Control processing of IPsec control messages.
1940.Bl -tag -width indent
1941.It 0
1942Never allow IPsec processing
1943.It 1
1944Allow IPsec processing when SPD policies are present.
1945.It 2
1946Force IPsec processing even when SPD policies are not present.
1947.El
1948.It Li used
1949Based on if IPsec is enabled, and SPD rule existance, show if
1950IPsec is being used.
1951Note that currenly once IPsec is being used, it cannot be disabled.
1952.It Li spi_try
1953The number of times the kernel will try to obtain an unique SPI
1954when it generates it from random number generator.
1955.It Li spi_min_value
1956Minimum SPI value when generating it within the kernel.
1957.It Li spi_max_value
1958Maximum SPI value when generating it within the kernel.
1959.It Li larval_lifetime
1960Lifetime for LARVAL SAD entries, in seconds.
1961.It Li blockacq_count
1962Number of ACQUIRE PF_KEY messages to be blocked after an ACQUIRE message.
1963It avoids flood of ACQUIRE PF_KEY from being sent from the kernel to the
1964key management daemon.
1965.It Li blockacq_lifetime
1966Lifetime of ACQUIRE PF_KEY message.
1967.It Li esp_keymin
1968Minimum ESP key length, in bits.
1969The value is used when the kernel creates proposal payload
1970on ACQUIRE PF_KEY message.
1971.It Li esp_auth
1972Whether ESP authentication should be used or not.
1973Non-zero value indicates that ESP authentication should be used.
1974The value is used when the kernel creates proposal payload
1975on ACQUIRE PF_KEY message.
1976.It Li ah_keymin
1977Minimum AH key length, in bits,
1978The value is used when the kernel creates proposal payload
1979on ACQUIRE PF_KEY message.
1980.El
1981.El
1982.Ss The proc.* subtree
1983The string and integer information available for the
1984.Li proc
1985level is detailed below.
1986The changeable column shows whether a process with appropriate
1987privilege may change the value.
1988These values are per-process,
1989and as such may change from one process to another.
1990When a process is created,
1991the default values are inherited from its parent.
1992When a set-user-ID or set-group-ID binary is executed, the
1993value of PROC_PID_CORENAME is reset to the system default value.
1994The second level name is either the magic value PROC_CURPROC, which
1995points to the current process, or the PID of the target process.
1996.Bl -column "proc.pid.corename" "string" "not applicable" -offset indent
1997.It Sy Third level name	Sy Type	Sy Changeable
1998.It proc.pid.corename	string	yes
1999.It proc.pid.rlimit	node	not applicable
2000.It proc.pid.stopfork	int	yes
2001.It proc.pid.stopexec	int	yes
2002.It proc.pid.stopexit	int	yes
2003.El
2004.Bl -tag -width "123456"
2005.It Li proc.pid.corename ( Dv PROC_PID_CORENAME )
2006The template used for the core dump file name (see
2007.Xr core 5
2008for details).
2009The base name must either be
2010.Pa core
2011or end with the suffix
2012.Pa .core
2013(the super-user may set arbitrary names).
2014By default it points to
2015.Dv KERN_DEFCORENAME .
2016.It Li proc.pid.rlimit ( Dv PROC_PID_LIMIT )
2017Return resources limits, as defined for the
2018.Xr getrlimit 2
2019and
2020.Xr setrlimit 2
2021system calls.
2022The fourth level name is one of:
2023.Bl -tag -width "123456"
2024.It Li proc.pid.rlimit.cputime ( Dv PROC_PID_LIMIT_CPU )
2025The maximum amount of CPU time (in seconds) to be used by each process.
2026.It Li proc.pid.rlimit.filesize ( Dv PROC_PID_LIMIT_FSIZE )
2027The largest size (in bytes) file that may be created.
2028.It Li proc.pid.rlimit.datasize ( Dv PROC_PID_LIMIT_DATA )
2029The maximum size (in bytes) of the data segment for a process;
2030this defines how far a program may extend its break with the
2031.Xr sbrk 2
2032system call.
2033.It Li proc.pid.rlimit.stacksize ( Dv PROC_PID_LIMIT_STACK )
2034The maximum size (in bytes) of the stack segment for a process;
2035this defines how far a program's stack segment may be extended.
2036Stack extension is performed automatically by the system.
2037.It Li proc.pid.rlimit.coredumpsize ( Dv PROC_PID_LIMIT_CORE )
2038The largest size (in bytes)
2039.Pa core
2040file that may be created.
2041.It Li proc.pid.rlimit.memoryuse ( Dv PROC_PID_LIMIT_RSS )
2042The maximum size (in bytes) to which a process's resident set size may
2043grow.
2044This imposes a limit on the amount of physical memory to be given to
2045a process; if memory is tight, the system will prefer to take memory
2046from processes that are exceeding their declared resident set size.
2047.It Li proc.pid.rlimit.memorylocked ( Dv PROC_PID_LIMIT_MEMLOCK )
2048The maximum size (in bytes) which a process may lock into memory
2049using the
2050.Xr mlock 2
2051function.
2052.It Li proc.pid.rlimit.maxproc ( Dv PROC_PID_LIMIT_NPROC )
2053The maximum number of simultaneous processes for this user id.
2054.It Li proc.pid.rlimit.descriptors ( Dv PROC_PID_LIMIT_NOFILE )
2055The maximum number of open files for this process.
2056.It Li proc.pid.rlimit.sbsize ( Dv PROC_PID_LIMIT_SBSIZE )
2057The maximum size (in bytes) of the socket buffers
2058set by the
2059.Xr setsockopt 2
2060.Dv SO_RCVBUF
2061and
2062.Dv SO_SNDBUF
2063options.
2064.It Li proc.pid.rlimit.vmemoryuse ( Dv PROC_PID_LIMIT_AS )
2065The maximum size (in bytes) which a process can obtain.
2066.It Li proc.pid.rlimit.maxlwp ( Dv PROC_PID_LIMIT_NTHR )
2067The maximum number of threads that cen be created and running at one time in
2068the process.
2069The first thread of each process is not counted against this.
2070.El
2071.Pp
2072The fifth level name is one of
2073.Li soft ( Dv PROC_PID_LIMIT_TYPE_SOFT )
2074or
2075.Li hard ( Dv PROC_PID_LIMIT_TYPE_HARD ) ,
2076to select respectively the soft or hard limit.
2077Both are of type integer.
2078.It Li proc.pid.stopfork ( Dv PROC_PID_STOPFORK )
2079If non zero, the process' children will be stopped after
2080.Xr fork 2
2081calls.
2082The children is created in the SSTOP state and is never scheduled
2083for running before being stopped.
2084This feature helps attaching a process with a debugger such as
2085.Xr gdb 1
2086before it had the opportunity to actually do anything.
2087.Pp
2088This value is inherited by the process's children, and it also
2089apply to emulation specific system calls that fork a new process, such as
2090.Fn sproc
2091or
2092.Fn clone .
2093.It Li proc.pid.stopexec ( Dv PROC_PID_STOPEXEC )
2094If non zero, the process will be stopped on next
2095.Xr exec 3
2096call.
2097The process created by
2098.Xr exec 3
2099is created in the SSTOP state and is never scheduled for running
2100before being stopped.
2101This feature helps attaching a process with a debugger such as
2102.Xr gdb 1
2103before it had the opportunity to actually do anything.
2104.Pp
2105This value is inherited by the process's children.
2106.It Li proc.pid.stopexit ( Dv PROC_PID_STOPEXIT )
2107If non zero, the process will be stopped on when it has cause to exit,
2108either by way of calling
2109.Xr exit 3 ,
2110.Xr _exit 2 ,
2111or by the receipt of a specific signal.
2112The process is stopped before any of its resources or vm space is
2113released allowing examination of the termination state of a process
2114before it disappears.
2115This feature can be used to examine the final conditions of the
2116process's vmspace via
2117.Xr pmap 1
2118or its resource settings with
2119.Xr sysctl 8
2120before it disappears.
2121.Pp
2122This value is also inherited by the process's children.
2123.El
2124.Ss The user.* subtree ( Dv CTL_USER )
2125The string and integer information available for the
2126.Li user
2127level is detailed below.
2128The changeable column shows whether a process with appropriate
2129privilege may change the value.
2130.Bl -column "user.coll_weights_max" "integer" "Changeable" -offset indent
2131.It Sy Second level name	Sy Type	Sy Changeable
2132.It user.atexit_max	integer	no
2133.It user.bc_base_max	integer	no
2134.It user.bc_dim_max	integer	no
2135.It user.bc_scale_max	integer	no
2136.It user.bc_string_max	integer	no
2137.It user.coll_weights_max	integer	no
2138.It user.cs_path	string	no
2139.It user.expr_nest_max	integer	no
2140.It user.line_max	integer	no
2141.It user.posix2_c_bind	integer	no
2142.It user.posix2_c_dev	integer	no
2143.It user.posix2_char_term	integer	no
2144.It user.posix2_fort_dev	integer	no
2145.It user.posix2_fort_run	integer	no
2146.It user.posix2_localedef	integer	no
2147.It user.posix2_sw_dev	integer	no
2148.It user.posix2_upe	integer	no
2149.It user.posix2_version	integer	no
2150.It user.re_dup_max	integer	no
2151.It user.stream_max	integer	no
2152.It user.stream_max	integer	no
2153.It user.tzname_max	integer	no
2154.El
2155.Bl -tag -width "123456"
2156.It Li user.atexit_max ( Dv USER_ATEXIT_MAX )
2157The maximum number of functions that may be registered with
2158.Xr atexit 3 .
2159.It Li user.bc_base_max ( Dv USER_BC_BASE_MAX )
2160The maximum ibase/obase values in the
2161.Xr bc 1
2162utility.
2163.It Li user.bc_dim_max ( Dv USER_BC_DIM_MAX )
2164The maximum array size in the
2165.Xr bc 1
2166utility.
2167.It Li user.bc_scale_max ( Dv USER_BC_SCALE_MAX )
2168The maximum scale value in the
2169.Xr bc 1
2170utility.
2171.It Li user.bc_string_max ( Dv USER_BC_STRING_MAX )
2172The maximum string length in the
2173.Xr bc 1
2174utility.
2175.It Li user.coll_weights_max ( Dv USER_COLL_WEIGHTS_MAX )
2176The maximum number of weights that can be assigned to any entry of
2177the LC_COLLATE order keyword in the locale definition file.
2178.It Li user.cs_path ( USER_CS_PATH )
2179Return a value for the
2180.Ev PATH
2181environment variable that finds all the standard utilities.
2182.It Li user.expr_nest_max ( Dv USER_EXPR_NEST_MAX )
2183The maximum number of expressions that can be nested within
2184parenthesis by the
2185.Xr expr 1
2186utility.
2187.It Li user.line_max ( Dv USER_LINE_MAX )
2188The maximum length in bytes of a text-processing utility's input
2189line.
2190.It Li user.posix2_char_term ( Dv USER_POSIX2_CHAR_TERM )
2191Return 1 if the system supports at least one terminal type capable of
2192all operations described in
2193.St -p1003.2 ,
2194otherwise\ 0.
2195.It Li user.posix2_c_bind ( Dv USER_POSIX2_C_BIND )
2196Return 1 if the system's C-language development facilities support the
2197C-Language Bindings Option, otherwise\ 0.
2198.It Li user.posix2_c_dev ( Dv USER_POSIX2_C_DEV )
2199Return 1 if the system supports the C-Language Development Utilities Option,
2200otherwise\ 0.
2201.It Li user.posix2_fort_dev ( Dv USER_POSIX2_FORT_DEV )
2202Return 1 if the system supports the FORTRAN Development Utilities Option,
2203otherwise\ 0.
2204.It Li user.posix2_fort_run ( Dv USER_POSIX2_FORT_RUN )
2205Return 1 if the system supports the FORTRAN Runtime Utilities Option,
2206otherwise\ 0.
2207.It Li user.posix2_localedef ( Dv USER_POSIX2_LOCALEDEF )
2208Return 1 if the system supports the creation of locales, otherwise\ 0.
2209.It Li user.posix2_sw_dev ( Dv USER_POSIX2_SW_DEV )
2210Return 1 if the system supports the Software Development Utilities Option,
2211otherwise\ 0.
2212.It Li user.posix2_upe ( Dv USER_POSIX2_UPE )
2213Return 1 if the system supports the User Portability Utilities Option,
2214otherwise\ 0.
2215.It Li user.posix2_version ( Dv USER_POSIX2_VERSION )
2216The version of
2217.St -p1003.2
2218with which the system attempts to comply.
2219.It Li user.re_dup_max ( Dv USER_RE_DUP_MAX )
2220The maximum number of repeated occurrences of a regular expression
2221permitted when using interval notation.
2222.It Li user.stream_max ( Dv USER_STREAM_MAX )
2223The minimum maximum number of streams that a process may have open
2224at any one time.
2225.It Li user.tzname_max ( Dv USER_TZNAME_MAX )
2226The minimum maximum number of types supported for the name of a
2227timezone.
2228.El
2229.Ss The vm.* subtree ( Dv CTL_VM )
2230The string and integer information available for the
2231.Li vm
2232level is detailed below.
2233The changeable column shows whether a process with appropriate
2234privilege may change the value.
2235.Bl -column "Second level name" "struct uvmexp_sysctl" "Changeable" -offset indent
2236.It Sy Second level name	Sy Type	Sy Changeable
2237.It vm.anonmax	int	yes
2238.It vm.anonmin	int	yes
2239.It vm.bufcache	int	yes
2240.It vm.bufmem	int	no
2241.It vm.bufmem_hiwater	int	yes
2242.It vm.bufmem_lowater	int	yes
2243.It vm.execmax	int	yes
2244.It vm.execmin	int	yes
2245.It vm.filemax	int	yes
2246.It vm.filemin	int	yes
2247.It vm.loadavg	struct loadavg	no
2248.It vm.maxslp	int	no
2249.It vm.nkmempages	int	no
2250.It vm.uspace	int	no
2251.It vm.uvmexp	struct uvmexp	no
2252.It vm.uvmexp2	struct uvmexp_sysctl	no
2253.It vm.vmmeter	struct vmtotal	no
2254.It vm.proc.map	struct kinfo_vmentry	no
2255.El
2256.Bl -tag -width "123456"
2257.It Li vm.anonmax ( Dv VM_ANONMAX )
2258The percentage of physical memory which will be reclaimed
2259from other types of memory usage to store anonymous application data.
2260.It Li vm.anonmin ( Dv VM_ANONMIN )
2261The percentage of physical memory which will be always be available for
2262anonymous application data.
2263.It Li vm.bufcache ( Dv VM_BUFCACHE )
2264The percentage of physical memory which will be available
2265for the buffer cache.
2266.It Li vm.bufmem ( Dv VM_BUFMEM )
2267The amount of kernel memory that is being used by the buffer cache.
2268.It Li vm.bufmem_lowater ( Dv VM_BUFMEM_LOWATER )
2269The minimum amount of kernel memory to reserve for the
2270buffer cache.
2271.It Li vm.bufmem_hiwater ( Dv VM_BUFMEM_HIWATER )
2272The maximum amount of kernel memory to be used for the
2273buffer cache.
2274.It Li vm.execmax ( Dv VM_EXECMAX )
2275The percentage of physical memory which will be reclaimed
2276from other types of memory usage to store cached executable data.
2277.It Li vm.execmin ( Dv VM_EXECMIN )
2278The percentage of physical memory which will be always be available for
2279cached executable data.
2280.It Li vm.filemax ( Dv VM_FILEMAX )
2281The percentage of physical memory which will be reclaimed
2282from other types of memory usage to store cached file data.
2283.It Li vm.filemin ( Dv VM_FILEMIN )
2284The percentage of physical memory which will be always be available for
2285cached file data.
2286.It Li vm.loadavg ( Dv VM_LOADAVG )
2287Return the load average history.
2288The returned data consists of a
2289.Vt struct loadavg .
2290.It Li vm.maxslp ( Dv VM_MAXSLP )
2291The value of the maxslp kernel global variable.
2292.It Li vm.vmmeter ( Dv VM_METER )
2293Return system wide virtual memory statistics.
2294The returned data consists of a
2295.Vt struct vmtotal .
2296.It vm.user_va0_disable
2297A flag which controls whether user processes can map virtual address\ 0.
2298.It Li vm.proc.map ( Dv VM_PROC )
2299The third level is
2300.dv VM_PROC_MAP ,
2301the fourth is the pid of the process to display the vm object entries for, and
2302the fifth is the size of
2303.Vt struct kinfo_vmentry .
2304Returns an array of
2305.Vt struct kinfo_vmentry
2306objects.
2307.It Li vm.uspace ( Dv VM_USPACE )
2308The number of bytes allocated for each kernel stack.
2309.It Li vm.uvmexp ( Dv VM_UVMEXP )
2310Return system wide virtual memory statistics.
2311The returned data consists of a
2312.Vt struct uvmexp .
2313.It Li vm.uvmexp2 ( Dv VM_UVMEXP2 )
2314Return system wide virtual memory statistics.
2315The returned data consists of a
2316.Vt struct uvmexp_sysctl .
2317.\" XXX vm.idlezero
2318.El
2319.Ss The ddb.* subtree ( Dv CTL_DDB )
2320The information available for the
2321.Li ddb
2322level is detailed below.
2323The changeable column shows whether a process with appropriate
2324privilege may change the value.
2325.\" XXX sort
2326.Bl -column "Second level name" "integer" "Changeable" -offset indent
2327.It Sy Second level name	Sy Type	Sy Changeable
2328.It ddb.radix	integer	yes
2329.It ddb.maxoff	integer	yes
2330.It ddb.maxwidth	integer	yes
2331.It ddb.lines	integer	yes
2332.It ddb.tabstops	integer	yes
2333.It ddb.onpanic	integer	yes
2334.It ddb.fromconsole	integer	yes
2335.It ddb.tee_msgbuf	integer	yes
2336.It ddb.commandonenter	string	yes
2337.El
2338.Bl -tag -width "123456"
2339.It Li ddb.radix ( Dv DDBCTL_RADIX )
2340The input and output radix.
2341.It Li ddb.maxoff ( Dv DDBCTL_MAXOFF )
2342The maximum symbol offset.
2343.It Li ddb.maxwidth ( Dv DDBCTL_MAXWIDTH )
2344The maximum output line width.
2345.It Li ddb.lines ( Dv DDBCTL_LINES )
2346Number of display lines.
2347.It Li ddb.tabstops ( Dv DDBCTL_TABSTOPS )
2348Tab width.
2349.It Li ddb.onpanic ( Dv DDBCTL_ONPANIC )
2350If greater than zero, DDB will be entered if the kernel panics.
2351A value of 1 causes the system to enter DDB on panic, while a value of 2
2352causes the kernel to attempt to print out a stack trace before entering DDB.
2353A value of 0 causes the kernel to attempt to print a stack trace, then
2354reboot, while a value of \-1 means neither a stack trace will be printed
2355nor DDB entered.
2356.It Li ddb.fromconsole ( Dv DDBCTL_FROMCONSOLE )
2357If not zero, DDB may be entered by sending a break on a serial
2358console or by a special key sequence on a graphics console.
2359.It Li ddb.tee_msgbuf
2360If not zero, DDB will output also to the kernel message buffer.
2361.It Li ddb.commandonenter
2362If not empty, a command to be executed on each enter to the
2363.Tn DDB .
2364.\"
2365.\" XXX: (a) ddb.commandonenter is missing in ddb(4);
2366.\"	 (b) No DDBCTL definitions for tee_msgbuf and commandonenter.
2367.El
2368.Pp
2369Some of these
2370.Tn MIB
2371nodes are also available as variables from within the debugger.
2372See
2373.Xr ddb 4
2374for more details.
2375.Ss The security.* subtree ( Dv CTL_SECURITY )
2376The
2377.Li security
2378level contains various security-related settings for
2379the system.
2380The available second level names are:
2381.Bl -column "Second level name" "integer" "Changeable" -offset indent
2382.It Sy Second level name	Sy Type	Sy Changeable
2383.It Li security.curtain	integer	yes
2384.It Li security.models	node	not applicable
2385.It Li security.pax	node	not applicable
2386.El
2387.Pp
2388Available settings are detailed below.
2389.Bl -tag -width "123456"
2390.It Li security.curtain
2391If non-zero, will filter return objects according to the user
2392.Tn ID
2393requesting information about them, preventing users from
2394accessing any objects they do not own.
2395.Pp
2396At the moment, it affects
2397.Xr ps 1 ,
2398.Xr netstat 1
2399(for
2400.Dv PF_INET ,
2401.Dv PF_INET6 ,
2402and
2403.Dv PF_UNIX
2404PCBs), and
2405.Xr w 1 .
2406.It Li security.models
2407.Nx
2408supports pluggable security models.
2409Every security model used, whether if loaded as a module or built with the system,
2410is required to add an entry to this node with at least one element,
2411.Dq name ,
2412indicating the name of the security model.
2413.Pp
2414In addition to the name, any settings and other information private to the
2415security model will be available under this node.
2416See
2417.Xr secmodel 9
2418for more information.
2419.It Li security.pax
2420Settings for PaX -- exploit mitigation features.
2421For more information on any of the PaX features, please see
2422.Xr paxctl 8
2423and
2424.Xr security 7 .
2425The available third and fourth level names are:
2426.Bl -column "security.pax.segvguard.suspend_timeout" "integer" "Changeable" \
2427-offset 2n
2428.It Sy Third and fourth level names Ta Sy Type Ta Sy Changeable
2429.It Li security.pax.aslr.enabled	integer	yes
2430.\".It Li security.pax.aslr.exec_len	integer	yes
2431.It Li security.pax.aslr.global	integer	yes
2432.\".It Li security.pax.aslr.mmap_len	integer	yes
2433.\".It Li security.pax.aslr.stack_len	integer	yes
2434.It Li security.pax.mprotect.enabled	integer	yes
2435.It Li security.pax.mprotect.global	integer	yes
2436.It Li security.pax.mprotect.ptrace	integer	yes
2437.It Li security.pax.segvguard.enabled	integer	yes
2438.It Li security.pax.segvguard.expiry_timeout	integer	yes
2439.It Li security.pax.segvguard.global	integer	yes
2440.It Li security.pax.segvguard.max_crashes	integer	yes
2441.It Li security.pax.segvguard.suspend_timeout	integer	yes
2442.El
2443.Bl -tag -width "123456"
2444.It Li security.pax.aslr.enabled
2445Enable PaX ASLR (Address Space Layout Randomization).
2446.Pp
2447The value of this
2448knob must be non-zero for PaX ASLR to be enabled, even if a program is set to
2449explicit enable.
2450.\".It Li security.pax.aslr.exec_len
2451.\" XXX: Undocumented.
2452.It Li security.pax.aslr.global
2453Specifies the default global policy for programs without an
2454explicit enable/disable flag.
2455.Pp
2456When non-zero, all programs will get PaX ASLR, except those exempted with
2457.Xr paxctl 8 .
2458Otherwise, all programs will not get PaX ASLR, except those specifically
2459marked as such with
2460.Xr paxctl 8 .
2461.\".It Li security.pax.aslr.mmap_len
2462.\" XXX: Undocumented.
2463.\" .It Li security.pax.aslr.stack_len
2464.\" XXX: Undocumented.
2465.It Li security.pax.mprotect.enabled
2466Enable PaX MPROTECT restrictions.
2467.Pp
2468These are
2469.Xr mprotect 2
2470restrictions to better enforce a W^X policy.
2471The value of this
2472knob must be non-zero for PaX MPROTECT to be enabled, even if a
2473program is set to explicit enable.
2474.It Li security.pax.mprotect.global
2475Specifies the default global policy for programs without an
2476explicit enable/disable flag.
2477.Pp
2478When non-zero, all programs will get the PaX MPROTECT restrictions,
2479except those exempted with
2480.Xr paxctl 8 .
2481Otherwise, all programs will not get the PaX MPROTECT restrictions,
2482except those specifically marked as such with
2483.Xr paxctl 8 .
2484.It Li security.pax.mprotect.ptrace
2485This variable allows
2486.Xr ptrace 2
2487to override PaX MPROTECT permissions.
2488It can have the following values:
2489.Bl -tag -width XX -compact
2490.It 0
2491Does not let override any permissions.
2492.It 1
2493Disables PaX MPROTECT from processes that start executing while traced (default).
2494.It 2
2495Bypasses PaX MPROTECT for all processes being traced.
2496.El
2497.It Li security.pax.segvguard.enabled
2498Enable PaX Segvguard.
2499.Pp
2500PaX Segvguard can detect and prevent certain exploitation attempts, where
2501an attacker may try for example to brute-force function return addresses
2502of respawning daemons.
2503.Pp
2504.Em Note :
2505The
2506.Nx
2507interface and implementation of the Segvguard is still experimental, and may
2508change in future releases.
2509.It Li security.pax.segvguard.expiry_timeout
2510If the max number was not reached within this timeout (in seconds), the entry
2511will expire.
2512.It Li security.pax.segvguard.global
2513Specifies the default global policy for programs without an
2514explicit enable/disable flag.
2515.Pp
2516When non-zero, all programs will get the PaX Segvguard,
2517except those exempted with
2518.Xr paxctl 8 .
2519Otherwise, no program will get the PaX Segvguard restrictions,
2520except those specifically marked as such with
2521.Xr paxctl 8 .
2522.It Li security.pax.segvguard.max_crashes
2523The maximum number of segfaults a program can receive before suspension.
2524.It Li security.pax.segvguard.suspend_timeout
2525Number of seconds to suspend a user from running a faulting program when the
2526limit was exceeded.
2527.El
2528.El
2529.Ss The vendor.* subtree ( Dv CTL_VENDOR )
2530The
2531.Li vendor
2532toplevel name is reserved to be used by vendors who wish to
2533have their own private MIB tree.
2534Intended use is to store values under
2535.Dq vendor.\*[Lt]yourname\*[Gt].* .
2536.Sh SEE ALSO
2537.Xr sysctl 3 ,
2538.Xr ipsec 4 ,
2539.Xr tcp 4 ,
2540.Xr security 7 ,
2541.Xr sysctl 8
2542.Sh HISTORY
2543The
2544.Nm
2545variables first appeared in
2546.Bx 4.4 .
2547