xref: /openbsd-src/lib/libc/sys/sysctl.2 (revision 7350f337b9e3eb4461d99580e625c7ef148d107c)
1.\"	$OpenBSD: sysctl.2,v 1.27 2019/05/09 15:05:47 claudio 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.Dd $Mdocdate: May 9 2019 $
31.Dt SYSCTL 2
32.Os
33.Sh NAME
34.Nm sysctl
35.Nd get or set system information
36.Sh SYNOPSIS
37.In sys/types.h
38.In sys/sysctl.h
39.Ft int
40.Fn sysctl "const int *name" "u_int namelen" "void *oldp" "size_t *oldlenp" "void *newp" "size_t newlen"
41.Sh DESCRIPTION
42The
43.Fn sysctl
44function retrieves system information and allows processes with
45appropriate privileges to set system information.
46The information available from
47.Fn sysctl
48consists of integers, strings, and tables.
49Information may be retrieved and set using the
50.Xr sysctl 8
51utility;
52the variable names used by this utility are given here in parentheses.
53.Pp
54Unless explicitly noted below,
55.Fn sysctl
56returns a consistent snapshot of the data requested.
57Consistency is obtained by locking the destination
58buffer into memory so that the data may be copied out without blocking.
59Calls to
60.Fn sysctl
61are serialized to avoid deadlock.
62.Pp
63The state is described using a
64.Dq Management Information Base (MIB)
65style name, listed in
66.Fa name ,
67which is a
68.Fa namelen
69length array of integers.
70.Pp
71The information is copied into the buffer specified by
72.Fa oldp .
73The size of the buffer is given by the location specified by
74.Fa oldlenp
75before the call,
76and that location gives the amount of data copied after a successful call.
77If the amount of data available is greater
78than the size of the buffer supplied,
79the call supplies as much data as fits in the buffer provided
80and returns with the error code
81.Er ENOMEM .
82If the old value is not desired,
83.Fa oldp
84and
85.Fa oldlenp
86should be set to
87.Dv NULL .
88.Pp
89The size of the available data can be determined by calling
90.Fn sysctl
91with a
92.Dv NULL
93parameter for
94.Fa oldp .
95The size of the available data will be returned in the location pointed to by
96.Fa oldlenp .
97For some operations, the amount of space may change often.
98For these operations,
99the system attempts to round up so that the returned size is
100large enough for a call to return the data shortly thereafter.
101.Pp
102The terminating NUL character is included in the lengths of string values.
103.Pp
104To set a new value,
105.Fa newp
106is set to point to a buffer of length
107.Fa newlen
108from which the requested value is to be taken.
109If a new value is not to be set,
110.Fa newp
111should be set to
112.Dv NULL
113and
114.Fa newlen
115set to 0.
116.Pp
117The top level names are defined with a
118.Dv CTL_
119prefix in
120.In sys/sysctl.h ,
121and are as follows.
122The next and subsequent levels down are found in the include files
123listed here, and described in separate sections below.
124.Bl -column "CTL_MACHDEP" "ufs/ffs/ffs_extern.h" "Description" -offset indent
125.It Sy "Name" Ta Sy "Next level names" Ta Sy "Description"
126.It Dv CTL_DDB Ta "ddb/db_var.h" Ta "Kernel debugger"
127.It Dv CTL_DEBUG Ta "sys/sysctl.h" Ta "Debugging"
128.It Dv CTL_FS Ta "sys/sysctl.h" Ta "File system"
129.It Dv CTL_HW Ta "sys/sysctl.h" Ta "Generic CPU, I/O"
130.It Dv CTL_KERN Ta "sys/sysctl.h" Ta "High kernel limits"
131.It Dv CTL_MACHDEP Ta "sys/sysctl.h" Ta "Machine dependent"
132.It Dv CTL_NET Ta "sys/socket.h" Ta "Networking"
133.It Dv CTL_VFS Ta "ufs/ffs/ffs_extern.h" Ta "Virtual file system"
134.It Dv CTL_VM Ta "uvm/uvm_param.h" Ta "Virtual memory"
135.El
136.Pp
137For example, the following retrieves the maximum number of processes allowed
138in the system:
139.Bd -literal -offset indent
140int mib[2], maxproc;
141size_t len;
142
143mib[0] = CTL_KERN;
144mib[1] = KERN_MAXPROC;
145len = sizeof(maxproc);
146if (sysctl(mib, 2, &maxproc, &len, NULL, 0) == -1)
147	err(1, "sysctl");
148.Ed
149.Ss CTL_DDB
150Integer information and settable variables are available for the
151.Dv CTL_DDB level ,
152as described below.
153More information is also available in
154.Xr ddb 4 .
155.Bl -column "Second level name" "integer" "Changeable" -offset indent
156.It Sy "Second level name" Ta Sy "Type" Ta Sy "Changeable"
157.It Dv DBCTL_CONSOLE Ta "integer" Ta "yes"
158.It Dv DBCTL_LOG Ta "integer" Ta "yes"
159.It Dv DBCTL_MAXLINE Ta "integer" Ta "yes"
160.It Dv DBCTL_MAXWIDTH Ta "integer" Ta "yes"
161.It Dv DBCTL_PANIC Ta "integer" Ta "yes"
162.It Dv DBCTL_RADIX Ta "integer" Ta "yes"
163.It Dv DBCTL_TABSTOP Ta "integer" Ta "yes"
164.It Dv DBCTL_TRIGGER Ta "integer" Ta "yes"
165.El
166.Bl -tag -width "123456"
167.It Dv DBCTL_CONSOLE Pq Va ddb.console
168When this variable is set, an architecture dependent magic key sequence
169on the console or a debugger button will permit entry into the kernel debugger.
170When running with a
171.Xr securelevel 7
172greater than 0,
173this variable may not be raised.
174.It Dv DBCTL_LOG Pq Va ddb.log
175When set, ddb output is also logged in the kernel message buffer.
176.It Dv DBCTL_MAXLINE Pq Va ddb.max_line
177Determines the number of lines to page in
178.Xr ddb 4 .
179This variable is also available as the ddb
180.Dv $lines
181variable.
182.It Dv DBCTL_MAXWIDTH Pq Va ddb.max_width
183Determines the maximum width of a line in
184.Xr ddb 4 .
185This variable is also available as the ddb
186.Dv $maxwidth
187variable.
188.It Dv DBCTL_PANIC Pq Va ddb.panic
189When this variable is set, system panics may drop into the kernel debugger.
190When running with a
191.Xr securelevel 7
192greater than 0,
193this variable may not be raised.
194.It Dv DBCTL_RADIX Pq Va ddb.radix
195Determines the default radix or base for non-prefixed numbers
196entered into
197.Xr ddb 4 .
198This variable is also available as the ddb
199.Dv $radix
200variable.
201.It Dv DBCTL_TABSTOP Pq Va ddb.tab_stop_width
202Width of a tab stop in
203.Xr ddb 4 .
204This variable is also available as the ddb
205.Dv $tabstops
206variable.
207.It Dv DBCTL_TRIGGER Pq Va ddb.trigger
208When
209.Dv DBCTL_CONSOLE
210is set,
211writing to
212.Dv DBCTL_TRIGGER
213causes the system to enter
214.Xr ddb 4 .
215When running with a
216.Xr securelevel 7
217greater than 0,
218the process writing to this variable must be running
219on the console in order to enter
220.Xr ddb 4 .
221.El
222.Ss CTL_DEBUG
223The debugging variables vary from system to system.
224A debugging variable may be added or deleted without need to recompile
225.Fn sysctl
226to know about it.
227Each time it runs,
228.Fn sysctl
229gets the list of debugging variables from the kernel and
230displays their current values.
231The system defines twenty
232.Vt struct ctldebug
233variables named
234.Va debug0
235through
236.Va debug19 .
237They are declared as separate variables so that they can be
238individually initialized at the location of their associated variable.
239The loader prevents multiple use of the same variable by issuing errors
240if a variable is initialized in more than one place.
241For example, to export the variable
242.Va dospecialcheck
243as a debugging variable, the following declaration would be used:
244.Bd -literal -offset indent
245int dospecialcheck = 1;
246struct ctldebug debug5 = { "dospecialcheck", &dospecialcheck };
247.Ed
248.Ss CTL_FS
249The string and integer information available for the
250.Dv CTL_FS
251level is detailed below.
252The changeable column shows whether a process with appropriate
253privileges may change the value.
254.Bl -column "Second level name" "integer" "Changeable" -offset indent
255.It Sy "Second level name" Ta Sy "Type" Ta Sy "Changeable"
256.It Dv FS_POSIX_SETUID Ta "integer" Ta "yes"
257.El
258.Bl -tag -width "123456"
259.It Dv FS_POSIX_SETUID Pq Va fs.posix.setuid
260When this variable is set, ownership changes on a file will cause
261the
262.Va S_ISUID
263and
264.Va S_ISGID
265bits to be cleared.
266When running with a
267.Xr securelevel 7
268greater than 0,
269this variable may not be changed.
270.El
271.Ss CTL_HW
272The string and integer information available for the
273.Dv CTL_HW
274level is detailed below.
275The changeable column shows whether a process with appropriate
276privileges may change the value.
277.Bl -column "Second level name" "integer" "Changeable" -offset indent
278.It Sy "Second level name" Ta Sy "Type" Ta Sy "Changeable"
279.It Dv HW_ALLOWPOWERDOWN Ta "integer" Ta "yes"
280.It Dv HW_BYTEORDER Ta "integer" Ta "no"
281.It Dv HW_CPUSPEED Ta "integer" Ta "no"
282.It Dv HW_DISKCOUNT Ta "integer" Ta "no"
283.It Dv HW_DISKNAMES Ta "string" Ta "no"
284.It Dv HW_DISKSTATS Ta "struct" Ta "no"
285.It Dv HW_MACHINE Ta "string" Ta "no"
286.It Dv HW_MODEL Ta "string" Ta "no"
287.It Dv HW_NCPU Ta "integer" Ta "no"
288.It Dv HW_NCPUFOUND Ta "integer" Ta "no"
289.It Dv HW_NCPUONLINE Ta "integer" Ta "no"
290.It Dv HW_PAGESIZE Ta "integer" Ta "no"
291.It Dv HW_PERFPOLICY Ta "string" Ta "yes"
292.It Dv HW_PHYSMEM Ta "integer" Ta "no"
293.It Dv HW_PHYSMEM64 Ta "int64_t" Ta "no"
294.It Dv HW_PRODUCT Ta "string" Ta "no"
295.It Dv HW_SENSORS Ta "node" Ta "not applicable"
296.It Dv HW_SETPERF Ta "integer" Ta "yes"
297.It Dv HW_SMT Ta "integer" Ta "yes"
298.It Dv HW_USERMEM Ta "integer" Ta "no"
299.It Dv HW_USERMEM64 Ta "int64_t" Ta "no"
300.It Dv HW_UUID Ta "string" Ta "no"
301.It Dv HW_VENDOR Ta "string" Ta "no"
302.It Dv HW_VERSION Ta "string" Ta "no"
303.El
304.Bl -tag -width "123456"
305.It Dv HW_ALLOWPOWERDOWN Pq Va hw.allowpowerdown
306Some machines generate an interrupt when the power button is pressed
307and a driver can catch that interrupt.
308When this variable is set, such an event will cause the system to
309perform a regular shutdown and power off the machine.
310When running with a
311.Xr securelevel 7
312greater than 0,
313this variable may not be changed.
314.It Dv HW_BYTEORDER Pq Va hw.byteorder
315The byteorder (4321 or 1234).
316.It Dv HW_CPUSPEED Pq Va hw.cpuspeed
317The current CPU frequency
318.Pq in MHz .
319.It Dv HW_DISKCOUNT Pq Va hw.diskcount
320The number of disks currently attached to the system.
321.It Dv HW_DISKNAMES Pq Va hw.disknames
322A comma-separated list of disk names.
323.It Dv HW_DISKSTATS Pq Va hw.diskstats
324An array of
325.Vt struct diskstats
326structures containing disk statistics.
327.It Dv HW_MACHINE Pq Va hw.machine
328The machine class.
329.It Dv HW_MODEL Pq Va hw.model
330The machine model.
331.It Dv HW_NCPU Pq Va hw.ncpu
332The number of CPUs configured.
333.It Dv HW_NCPUFOUND Pq Va hw.ncpufound
334The number of CPUs found.
335.It Dv HW_NCPUONLINE Pq Va hw.ncpuonline
336The number of CPUs online.
337.It Dv HW_PAGESIZE Pq Va hw.pagesize
338The software page size.
339.It Dv HW_PERFPOLICY Pq Va hw.perfpolicy
340The performance policy for power management.
341Can be one of
342.Dq manual ,
343.Dq auto ,
344or
345.Dq high .
346.It Dv HW_PHYSMEM
347The total physical memory, in bytes.
348This variable is deprecated; use
349.Dv HW_PHYSMEM64
350instead.
351.It Dv HW_PHYSMEM64 Pq Va hw.physmem
352The total physical memory, in bytes.
353.It Dv HW_PRODUCT Pq Va hw.product
354The product name of the machine.
355.It Dv HW_SENSORS Pq Va hw.sensors
356Third level comprises an array of
357.Vt struct sensordev
358structures containing information about devices
359that may attach hardware monitoring sensors.
360.Pp
361Third, fourth and fifth levels together comprise an array of
362.Vt struct sensor
363structures containing snapshot readings of hardware monitoring sensors.
364In such usage, third level indicates the numerical representation
365of the sensor device name to which the sensor is attached
366(a device's xname and number are matched with the help of
367.Vt struct sensordev
368structure above),
369fourth level indicates sensor type and
370fifth level is an ordinal sensor number (unique to
371the specified sensor type on the specified sensor device).
372.Pp
373The
374.Sy sensordev
375and
376.Sy sensor
377structures
378and
379.Sy sensor_type
380enumeration
381are defined in
382.In sys/sensors.h .
383.It Dv HW_SERIALNO Pq Va hw.serialno
384The serial number of the machine.
385.It Dv HW_SETPERF Pq Va hw.setperf
386Current CPU performance
387.Pq percentage .
388It is only modifiable if
389.Dv HW_PERFPOLICY
390is set to
391.Dq manual .
392.It Dv HW_SMT Pq Va hw.smt
393If set to 1, enable simultaneous multithreading (SMT) on CPUs that
394support it.
395Disabled by default.
396.It Dv HW_USERMEM
397The amount of available non-kernel memory in bytes.
398This variable is deprecated; use
399.Dv HW_USERMEM64
400instead.
401.It Dv HW_USERMEM64 Pq Va hw.usermem
402The amount of available non-kernel memory in bytes.
403.It Dv HW_UUID Pq Va hw.uuid
404The universal unique identification number assigned to the machine.
405.It Dv HW_VENDOR Pq Va hw.vendor
406The vendor name for this machine.
407.It Dv HW_VERSION Pq Va hw.version
408The version or revision of this machine.
409.El
410.Ss CTL_KERN
411The string and integer information available for the
412.Dv CTL_KERN
413level is detailed below.
414The changeable column shows whether a process with appropriate
415privileges may change the value.
416The types of data currently available are process information,
417system vnodes, the open file entries, routing table entries,
418virtual memory statistics, load average history, and clock rate
419information.
420.Bl -column "KERN_PROC_NOBROADCASTKILL" "u_int64_t[CPUSTATES]" "no" -offset indent
421.It Sy "Second level name" Ta Sy "Type" Ta Sy "Changeable"
422.It Dv KERN_ALLOWKMEM Ta "integer" Ta "yes"
423.It Dv KERN_ARGMAX Ta "integer" Ta "no"
424.It Dv KERN_AUDIO Ta "node" Ta "yes"
425.It Dv KERN_BOOTTIME Ta "struct timeval" Ta "no"
426.It Dv KERN_CACHEPCT Ta "integer" Ta "yes"
427.It Dv KERN_CCPU Ta "integer" Ta "no"
428.It Dv KERN_CLOCKRATE Ta "struct clockinfo" Ta "no"
429.It Dv KERN_CONSDEV Ta "dev_t" Ta "no"
430.It Dv KERN_CPTIME Ta "long[CPUSTATES]" Ta "no"
431.It Dv KERN_CPTIME2 Ta "u_int64_t[CPUSTATES]" Ta "no"
432.It Dv KERN_CPUSTATS Ta "struct cpustats" Ta "no"
433.It Dv KERN_DOMAINNAME Ta "string" Ta "yes"
434.It Dv KERN_FILE Ta "struct kinfo_file" Ta "no"
435.It Dv KERN_FORKSTAT Ta "struct forkstat" Ta "no"
436.It Dv KERN_FSCALE Ta "integer" Ta "no"
437.It Dv KERN_FSYNC Ta "integer" Ta "no"
438.It Dv KERN_GLOBAL_PTRACE Ta "integer" Ta "yes"
439.It Dv KERN_HOSTID Ta "integer" Ta "yes"
440.It Dv KERN_HOSTNAME Ta "string" Ta "yes"
441.It Dv KERN_INTRCNT Ta "node" Ta "not applicable"
442.It Dv KERN_JOB_CONTROL Ta "integer" Ta "no"
443.It Dv KERN_MALLOCSTATS Ta "node" Ta "no"
444.It Dv KERN_MAXCLUSTERS Ta "integer" Ta "yes"
445.It Dv KERN_MAXFILES Ta "integer" Ta "yes"
446.It Dv KERN_MAXLOCKSPERUID Ta "integer" Ta "yes"
447.It Dv KERN_MAXPARTITIONS Ta "integer" Ta "no"
448.It Dv KERN_MAXPROC Ta "integer" Ta "yes"
449.It Dv KERN_MAXTHREAD Ta "integer" Ta "yes"
450.It Dv KERN_MAXVNODES Ta "integer" Ta "yes"
451.It Dv KERN_MBSTAT Ta "struct mbstat" Ta "no"
452.It Dv KERN_MSGBUF Ta "char[]" Ta "no"
453.It Dv KERN_MSGBUFSIZE Ta "integer" Ta "no"
454.It Dv KERN_NCHSTATS Ta "struct nchstats" Ta "no"
455.It Dv KERN_NFILES Ta "integer" Ta "no"
456.It Dv KERN_NGROUPS Ta "integer" Ta "no"
457.It Dv KERN_NOSUIDCOREDUMP Ta "integer" Ta "yes"
458.It Dv KERN_NPROCS Ta "integer" Ta "no"
459.It Dv KERN_NSELCOLL Ta "integer" Ta "no"
460.It Dv KERN_NTHREADS Ta "integer" Ta "no"
461.It Dv KERN_NUMVNODES Ta "integer" Ta "no"
462.It Dv KERN_OSRELEASE Ta "string" Ta "no"
463.It Dv KERN_OSREV Ta "integer" Ta "no"
464.It Dv KERN_OSTYPE Ta "string" Ta "no"
465.It Dv KERN_OSVERSION Ta "string" Ta "no"
466.It Dv KERN_PFSTATUS Ta "struct pf_status" Ta "no"
467.It Dv KERN_POOL_DEBUG Ta "integer" Ta "yes"
468.It Dv KERN_POSIX1 Ta "integer" Ta "no"
469.It Dv KERN_PROC Ta "struct kinfo_proc" Ta "no"
470.It Dv KERN_PROC_ARGS Ta "node" Ta "not applicable"
471.It Dv KERN_PROC_CWD Ta "string" Ta "not applicable"
472.It Dv KERN_PROC_NOBROADCASTKILL Ta "node" Ta "not applicable"
473.It Dv KERN_PROC_VMMAP Ta "struct kinfo_vmentry" Ta "no"
474.It Dv KERN_PROF Ta "node" Ta "not applicable"
475.It Dv KERN_RAWPARTITION Ta "integer" Ta "no"
476.It Dv KERN_SAVED_IDS Ta "integer" Ta "no"
477.It Dv KERN_SECURELVL Ta "integer" Ta "raise only"
478.It Dv KERN_SEMINFO Ta "node" Ta "not applicable"
479.It Dv KERN_SHMINFO Ta "node" Ta "not applicable"
480.It Dv KERN_SOMAXCONN Ta "integer" Ta "yes"
481.It Dv KERN_SOMINCONN Ta "integer" Ta "yes"
482.It Dv KERN_SPLASSERT Ta "int" Ta "yes"
483.It Dv KERN_STACKGAPRANDOM Ta "integer" Ta "yes"
484.It Dv KERN_SYSVIPC_INFO Ta "node" Ta "not applicable"
485.It Dv KERN_SYSVMSG Ta "integer" Ta "no"
486.It Dv KERN_SYSVSEM Ta "integer" Ta "no"
487.It Dv KERN_SYSVSHM Ta "integer" Ta "no"
488.It Dv KERN_TIMECOUNTER Ta "node" Ta "not applicable"
489.It Dv KERN_TTY Ta "node" Ta "not applicable"
490.It Dv KERN_TTYCOUNT Ta "integer" Ta "no"
491.It Dv KERN_VERSION Ta "string" Ta "no"
492.It Dv KERN_WATCHDOG Ta "node" Ta "not applicable"
493.It Dv KERN_WITNESS Ta "node" Ta "not applicable"
494.It Dv KERN_WXABORT Ta "integer" Ta "yes"
495.El
496.Bl -tag -width "123456"
497.It Dv KERN_ALLOWKMEM Pq Va kern.allowkmem
498Allow userland processes access to
499.Pa /dev/mem
500and
501.Pa /dev/kmem .
502When running with a
503.Xr securelevel 7
504greater than 0,
505this variable may not be changed.
506.It Dv KERN_ARGMAX Pq Va kern.argmax
507The maximum number of bytes allowed among the arguments to
508.Xr exec 3 .
509.It Dv KERN_AUDIO Pq Va kern.audio
510Control device-independent aspects of the
511.Xr audio 4
512and
513.Xr mixer 4
514subsystem.
515Currently, there is one subnode:
516.Bl -column "KERN_AUDIO_RECORD" "integer" "Changeable" -offset indent
517.It Sy "Third level name" Ta Sy "Type" Ta Sy "Changeable"
518.It Dv KERN_AUDIO_RECORD Ta "integer" Ta "yes"
519.El
520.Pp
521Its meaning is as follows:
522.Bl -tag -width "123456"
523.It Dv KERN_AUDIO_RECORD Pq Va kern.audio.record
524If set to the default value of 0, recording is muted by default
525for all audio devices.
526Otherwise, audio recording is enabled by default.
527For individual devices, this setting can be overridden with the
528.Xr mixerctl 1
529.Va record.enable
530variable.
531.El
532.It Dv KERN_BOOTTIME Pq Va kern.boottime
533A
534.Vt struct timeval
535structure is returned.
536This structure contains the time that the system was booted.
537.It Dv KERN_CACHEPCT Pq Va kern.bufcachepercent
538The maximum percentage of DMA-reachable physical memory the buffer cache may use.
539.It Dv KERN_CCPU Pq Va kern.ccpu
540The scheduler exponential decay value.
541.It Dv KERN_CLOCKRATE Pq Va kern.clockrate
542A
543.Vt struct clockinfo
544structure is returned.
545This structure contains the clock, statistics clock and profiling clock
546frequencies, the number of micro-seconds per hz tick, and the clock
547skew rate.
548.It Dv KERN_CONSDEV Pq Va kern.consdev
549The console device.
550.It Dv KERN_CPTIME Pq Va kern.cp_time
551An array of longs of size
552.Dv CPUSTATES
553is returned, containing statistics about the number of ticks spent by
554the system in interrupt processing, user processes
555.Po
556.Xr nice 1
557or normal
558.Pc ,
559system processing, lock spinning, or idling.
560.It Dv KERN_CPTIME2 Pq Va kern.cp_time2
561Similar to
562.Dv KERN_CPTIME ,
563but obtains information from only the single CPU specified by the
564third level name given.
565.It Dv KERN_CPUSTATS
566A
567.Vt struct cpustats
568structure is returned.
569This structure contains the array described in
570.Dv KERN_CPTIME2
571and a bit mask indicating the status of the CPU specified by the
572third level name.
573.It Dv KERN_DOMAINNAME Pq Va kern.domainname
574Get or set the YP domain name.
575.It Dv KERN_FILE Pq Va kern.file
576Return the entire file table, or a subset of it.
577An array of
578.Vt struct kinfo_file
579structures is returned,
580whose size depends on the current number of selected files in the system.
581The third and fourth level names are as follows:
582.Bl -column "Third level name" "Fourth level is:" -offset indent
583.It Sy "Third level name" Ta Sy "Fourth level is:"
584.It Dv KERN_FILE_BYFILE Ta "A file type"
585.It Dv KERN_FILE_BYPID Ta "A process ID"
586.It Dv KERN_FILE_BYUID Ta "A user ID"
587.El
588.Pp
589The fifth level name is the size of the
590.Vt struct kinfo_file
591and the sixth level name is the number of structures to return.
592.It Dv KERN_FORKSTAT Pq Va kern.forkstat
593A
594.Vt struct forkstat
595structure is returned.
596This structure contains information about the number of
597.Xr fork 2 ,
598.Xr vfork 2 ,
599and
600.Xr __tfork 3
601system calls as well as kernel thread creations since system startup,
602and the number of pages of virtual memory involved in each.
603.It Dv KERN_FSCALE Pq Va kern.fscale
604The kernel fixed-point scale factor.
605.It Dv KERN_FSYNC Pq Va kern.fsync
606Return 1 if the File Synchronisation Option is available on this system,
607otherwise 0.
608.It Dv KERN_GLOBAL_PTRACE Pq Va kern.global_ptrace
609When set to 1, permit
610.Xr ptrace 2
611to attach to any process with the appropriate privileges.
612When set to 0, processes may only attach to their own descendants.
613.It Dv KERN_HOSTID Pq Va kern.hostid
614Get or set the host ID.
615.It Dv KERN_HOSTNAME Pq Va kern.hostname
616Get or set the hostname.
617.It Dv KERN_JOB_CONTROL Pq Va kern.job_control
618Return 1 if job control is available on this system, otherwise 0.
619.It Dv KERN_MALLOCSTATS Pq Va kern.malloc
620Return kernel memory bucket statistics.
621The third level names are detailed below.
622There are no changeable values in this branch.
623.Bl -column "KERN_MALLOC_KMEMNAMES" "string" -offset indent
624.It Sy "Third level name" Ta Sy "Type"
625.It Dv KERN_MALLOC_BUCKET Ta "node"
626.It Dv KERN_MALLOC_BUCKETS Ta "string"
627.It Dv KERN_MALLOC_KMEMNAMES Ta "string"
628.It Dv KERN_MALLOC_KMEMSTATS Ta "node"
629.El
630.Pp
631The variables are as follows:
632.Bl -tag -width "123456"
633.It Dv KERN_MALLOC_BUCKET.<size> Pq Va kern.malloc.bucket
634A node containing the statistics for the memory bucket of the
635specified size (in decimal notation, the number of bytes per bucket
636element, e.g., 16, 32, 128).
637Each node returns a
638.Vt struct kmembuckets .
639.Pp
640If a value is specified that does not correspond directly to a
641bucket size, the statistics for the closest larger bucket size will be
642returned instead.
643.Pp
644Note that bucket sizes are typically powers of 2.
645.It Dv KERN_MALLOC_BUCKETS Pq Va kern.malloc.buckets
646Return a comma-separated list of the bucket sizes used by the kernel.
647.It Dv KERN_MALLOC_KMEMNAMES Pq Va kern.malloc.kmemnames
648Return a comma-separated list of the names of the kernel
649.Xr malloc 9
650types.
651.It Dv KERN_MALLOC_KMEMSTATS Pq Va kern.malloc.kmemstat
652A node containing the statistics for the memory types of the specified
653name.
654Each node returns a
655.Vt struct kmemstats .
656.El
657.It Dv KERN_MAXCLUSTERS Pq Va kern.maxclusters
658The maximum number of
659.Xr mbuf 9
660clusters that may be allocated.
661.It Dv KERN_MAXFILES Pq Va kern.maxfiles
662The maximum number of open files that may be open in the system.
663.It Dv KERN_MAXLOCKSPERUID Pq Va kern.maxlocksperuid
664The maximum number of file locks per user;
665the default is 1024.
666.It Dv KERN_MAXPARTITIONS Pq Va kern.maxpartitions
667The maximum number of partitions allowed per disk.
668.It Dv KERN_MAXPROC Pq Va kern.maxproc
669The maximum number of simultaneous processes the system will allow.
670.It Dv KERN_MAXTHREAD Pq Va kern.maxthread
671The maximum number of simultaneous threads the system will allow.
672.It Dv KERN_MAXVNODES Pq Va kern.maxvnodes
673The maximum number of vnodes available on the system.
674.It Dv KERN_MBSTAT Pq Va kern.mbstat
675A
676.Vt struct mbstat
677structure is returned, containing statistics on
678.Xr mbuf 9
679usage.
680.It Dv KERN_MSGBUF Pq Va kern.msgbuf
681Returns a buffer containing kernel log messages;
682see
683.Xr dmesg 8 .
684.It Dv KERN_MSGBUFSIZE Pq Va kern.msgbufsize
685The size of the kernel message buffer.
686.It Dv KERN_NCHSTATS Pq Va kern.nchstats
687A
688.Vt struct nchstats
689structure is returned.
690This structure contains information about the
691filename to
692.Xr inode 5
693mapping cache.
694.It Dv KERN_NFILES Pq Va kern.nfiles
695Number of open files.
696.It Dv KERN_NGROUPS Pq Va kern.ngroups
697The maximum number of supplemental groups.
698.It Dv KERN_NOSUIDCOREDUMP Pq Va kern.nosuidcoredump
699Whether a process may dump core after changing user or group ID:
700.Bl -column "value" "condition" "current directory"
701.It Sy "value" Ta Sy "condition" Ta Sy "dump core to"
702.It 0 Ta "euid == 0" Ta "current directory"
703.It 1 Ta "never" Ta ""
704.It 2 Ta "always" Ta Pa "/var/crash"
705.It 3 Ta "depends" Ta Pa "/var/crash/$programname/"
706.El
707.It Dv KERN_NPROCS Pq Va kern.nprocs
708The number of entries in the kernel process table.
709.It Dv KERN_NSELCOLL Pq Va kern.nselcoll
710Number of
711.Xr select 2
712collisions.
713.It Dv KERN_NTHREADS Pq Va kern.nthreads
714The number of entries in the kernel thread table.
715.It Dv KERN_NUMVNODES Pq Va kern.numvnodes
716Number of vnodes in use.
717.It Dv KERN_OSRELEASE Pq Va kern.osrelease
718The system release string.
719.It Dv KERN_OSREV Pq Va kern.osrevision
720The system revision number.
721.It Dv KERN_OSTYPE Pq Va kern.ostype
722The system type string.
723.It Dv KERN_OSVERSION Pq Va kern.osversion
724The kernel build version.
725.It Dv KERN_PFSTATUS
726The
727.Vt struct pf_status
728structure.
729.It Dv KERN_POOL_DEBUG Pq Va kern.pool_debug
730Modify the memory pool debug level.
731Valid values are:
732.Pp
733.Bl -tag -width 3n -offset indent -compact
734.It 0
735Disable pool debugging.
736.It 1
737Enable use after free detection.
738.It 2
739In addition to 1, when calling either
740.Xr malloc 9
741or
742.Xr pool_get 9
743with flags indicating that sleeping is allowed then always yield.
744Useful to detect potential races.
745.El
746.It Dv KERN_POSIX1 Pq Va kern.posix1version
747The version of ISO/IEC 9945 (POSIX 1003.1) with which the system
748attempts to comply.
749.It Dv KERN_PROC Pq Va kern.proc
750Return the entire process table, or a subset of it.
751An array of
752.Vt struct kinfo_proc
753structures is returned,
754whose size depends on the current number of selected processes in the system.
755The third and fourth level names are as follows:
756.Bl -column "KERN_PROC_SESSION" "Fourth level is:" -offset indent
757.It Sy "Third level name" Ta Sy "Fourth level is:"
758.It Dv KERN_PROC_ALL Ta "None"
759.It Dv KERN_PROC_KTHREAD Ta "A kernel thread"
760.It Dv KERN_PROC_PID Ta "A process ID"
761.It Dv KERN_PROC_PGRP Ta "A process group"
762.It Dv KERN_PROC_RUID Ta "A real user ID"
763.It Dv KERN_PROC_SESSION Ta "A session PID"
764.It Dv KERN_PROC_TTY Ta "A tty device"
765.It Dv KERN_PROC_UID Ta "A user ID"
766.El
767.Pp
768The fifth level name is the size of the
769.Vt struct kinfo_proc
770and the sixth level name is the number of structures to return.
771.It Dv KERN_PROC_ARGS Pq Va kern.procargs
772Returns the arguments or environment of a process.
773The third level name is the PID of the process.
774The fourth level name is one of:
775.Bl -column KERN_PROC_NARGV -offset indent
776.It Dv KERN_PROC_ARGV
777.It Dv KERN_PROC_ENV
778.It Dv KERN_PROC_NARGV
779.It Dv KERN_PROC_NENV
780.El
781.Pp
782.Dv KERN_PROC_NARGV
783and
784.Dv KERN_PROC_NENV
785return the number of elements as an
786.Vt int
787in the argv or env array.
788.Dv KERN_PROC_ARGV
789returns the argv array and
790.Dv KERN_PROC_ENV
791returns the environ array.
792The buffer pointed to by
793.Fa oldp
794is filled with an array of char pointers
795followed by the strings themselves.
796The last char pointer is a
797.Dv NULL
798pointer.
799.It Dv KERN_PROC_CWD Pq Va kern.proc_cwd
800Return the current working directory of a process.
801The third level name is the target process ID.
802A NUL-terminated string is returned.
803.It Dv KERN_PROC_NOBROADCASTKILL Pq Va kern.proc_nobroadcastkill
804When set, a process will no longer be signaled when sending broadcast signals.
805The third level name is the target process ID.
806.It Dv KERN_PROC_VMMAP Pq Va kern.proc_vmmap
807Return the entire process VM map entries.
808An array of
809.Vt struct kinfo_vmentry
810structures is returned,
811whose size depends on the current number of VM map entries of the selected process.
812Iteration is possible by setting the base address in the first element of
813.Vt struct kinfo_vmentry .
814.It Dv KERN_PROF Pq Va kern.profiling
815Return profiling information about the kernel.
816If the kernel is not compiled for profiling,
817attempts to retrieve any of the
818.Dv KERN_PROF
819values will fail with
820.Er EOPNOTSUPP .
821The third level names for the string and integer profiling information
822are detailed below.
823The changeable column shows whether a process with appropriate
824privileges may change the value.
825.Bl -column "Third level name" "struct gmonparam" -offset indent
826.It Sy "Third level name" Ta Sy "Type" Ta Sy "Changeable"
827.It Dv GPROF_COUNT Ta "u_short[]" Ta "yes"
828.It Dv GPROF_FROMS Ta "u_short[]" Ta "yes"
829.It Dv GPROF_GMONPARAM Ta "struct gmonparam" Ta "no"
830.It Dv GPROF_STATE Ta "integer" Ta "yes"
831.It Dv GPROF_TOS Ta "struct tostruct" Ta "yes"
832.El
833.Pp
834The variables are as follows:
835.Bl -tag -width "123456"
836.It Dv GPROF_COUNT
837Array of statistical program counter counts.
838.It Dv GPROF_FROMS
839Array indexed by program counter of call-from points.
840.It Dv GPROF_GMONPARAM
841Structure giving the sizes of the above arrays.
842.It Dv GPROF_STATE
843Returns
844.Dv GMON_PROF_ON
845or
846.Dv GMON_PROF_OFF
847to show that profiling is running or stopped.
848.It Dv GPROF_TOS
849Array of
850.Vt struct tostruct
851describing destination of calls and their counts.
852.El
853.It Dv KERN_RAWPARTITION Pq Va kern.rawpartition
854The raw partition of a disk (a == 0).
855.It Dv KERN_SAVED_IDS Pq Va kern.saved_ids
856Returns 1 if saved set-group-ID and saved set-user-ID are available.
857.It Dv KERN_SECURELVL Pq Va kern.securelevel
858The system security level.
859This level may be raised by processes with appropriate privileges.
860It may only be lowered by process 1.
861.It Dv KERN_SEMINFO Pq Va kern.seminfo
862Return the elements of
863.Vt struct seminfo .
864If the kernel is not compiled with System V style semaphore support,
865attempts to retrieve any of the
866.Dv KERN_SEMINFO
867values will fail with
868.Er EOPNOTSUPP .
869The third level names for the elements of
870.Vt struct seminfo
871are detailed below.
872The changeable column shows whether a process with appropriate
873privileges may change the value.
874.Bl -column "KERN_SEMINFO_SEMMNI" "integer" "Changeable" -offset indent
875.It Sy "Third level name" Ta Sy "Type" Ta Sy "Changeable"
876.It Dv KERN_SEMINFO_SEMAEM Ta "integer" Ta "no"
877.It Dv KERN_SEMINFO_SEMMNI Ta "integer" Ta "yes"
878.It Dv KERN_SEMINFO_SEMMNS Ta "integer" Ta "yes"
879.It Dv KERN_SEMINFO_SEMMNU Ta "integer" Ta "yes"
880.It Dv KERN_SEMINFO_SEMMSL Ta "integer" Ta "yes"
881.It Dv KERN_SEMINFO_SEMOPM Ta "integer" Ta "yes"
882.It Dv KERN_SEMINFO_SEMUME Ta "integer" Ta "no"
883.It Dv KERN_SEMINFO_SEMUSZ Ta "integer" Ta "no"
884.It Dv KERN_SEMINFO_SEMVMX Ta "integer" Ta "no"
885.El
886.Pp
887The variables are as follows:
888.Bl -tag -width "123456"
889.It Dv KERN_SEMINFO_SEMAEM Pq Va kern.seminfo.semaem
890The adjust on exit maximum value.
891.It Dv KERN_SEMINFO_SEMMNI Pq Va kern.seminfo.semmni
892The maximum number of semaphore identifiers allowed.
893.It Dv KERN_SEMINFO_SEMMNS Pq Va kern.seminfo.semmns
894The maximum number of semaphores allowed in the system.
895.It Dv KERN_SEMINFO_SEMMNU Pq Va kern.seminfo.semmnu
896The maximum number of semaphore undo structures allowed in the system.
897.It Dv KERN_SEMINFO_SEMMSL Pq Va kern.seminfo.semmsl
898The maximum number of semaphores allowed per ID.
899.It Dv KERN_SEMINFO_SEMOPM Pq Va kern.seminfo.semopm
900The maximum number of operations per
901.Xr semop 2
902call.
903.It Dv KERN_SEMINFO_SEMUME Pq Va kern.seminfo.semume
904The maximum number of undo entries per process.
905.It Dv KERN_SEMINFO_SEMUSZ Pq Va kern.seminfo.semusz
906The size (in bytes) of the undo structure.
907.It Dv KERN_SEMINFO_SEMVMX Pq Va kern.seminfo.semvmx
908The semaphore maximum value.
909.El
910.It Dv KERN_SHMINFO Pq Va kern.shminfo
911Return the elements of
912.Vt struct shminfo .
913If the kernel is not compiled with System V style shared memory support,
914attempts to retrieve any of the
915.Dv KERN_SHMINFO
916values will fail with
917.Er EOPNOTSUPP .
918The third level names for the elements of
919.Vt struct shminfo
920are detailed below.
921The changeable column shows whether a process with appropriate
922privileges may change the value.
923.Bl -column "KERN_SHMINFO_SHMMAX" "integer" "Changeable" -offset indent
924.It Sy "Third level name" Ta Sy "Type" Ta Sy "Changeable"
925.It Dv KERN_SHMINFO_SHMALL Ta "integer" Ta "yes"
926.It Dv KERN_SHMINFO_SHMMAX Ta "integer" Ta "yes"
927.It Dv KERN_SHMINFO_SHMMIN Ta "integer" Ta "yes"
928.It Dv KERN_SHMINFO_SHMMNI Ta "integer" Ta "yes"
929.It Dv KERN_SHMINFO_SHMSEG Ta "integer" Ta "yes"
930.El
931.Pp
932The variables are as follows:
933.Bl -tag -width "123456"
934.It Dv KERN_SHMINFO_SHMALL Pq Va kern.shminfo.shmall
935The maximum amount of total shared memory allowed in the system (in pages).
936.It Dv KERN_SHMINFO_SHMMAX Pq Va kern.shminfo.shmmax
937The maximum shared memory segment size (in bytes).
938.It Dv KERN_SHMINFO_SHMMIN Pq Va kern.shminfo.shmmin
939The minimum shared memory segment size (in bytes).
940.It Dv KERN_SHMINFO_SHMMNI Pq Va kern.shminfo.shmmni
941The maximum number of shared memory identifiers in the system.
942.It Dv KERN_SHMINFO_SHMSEG Pq Va kern.shminfo.shmseg
943The maximum number of shared memory segments per process.
944.El
945.It Dv KERN_SOMAXCONN Pq Va kern.somaxconn
946Upper bound on the number of half-open connections a process can allow
947to be associated with a socket, using
948.Xr listen 2 .
949The default value is 128.
950.It Dv KERN_SOMINCONN Pq Va kern.sominconn
951Lower bound on the number of half-open connections a process can allow
952to be associated with a socket, using
953.Xr listen 2 .
954The default value is 80.
955.It Dv KERN_SPLASSERT Pq Va kern.splassert
956Modify the system interrupt priority level.
957Valid values are:
958.Pp
959.Bl -tag -width 3n -offset indent -compact
960.It 0
961Disable error checking.
962.It 1
963Print a message if an error is detected.
964.It 2
965Print a message if an error is detected,
966and a stack trace if possible.
967.It 3
968The same as 2, but also drop into the kernel debugger.
969.El
970.Pp
971Any other value causes a system panic on errors.
972See
973.Xr splassert 9
974for more information.
975.It Dv KERN_STACKGAPRANDOM Pq Va kern.stackgap_random
976Sets the range of the random value added to the stack pointer on each
977program execution.
978The random value is added to make buffer overflow exploitation slightly
979harder.
980The bigger the number, the harder it is to brute force this added protection,
981but it also means bigger waste of memory.
982.It Dv KERN_SYSVIPC_INFO Pq Va kern.sysvipc_info
983Return System V style IPC configuration and run-time information.
984The third level name selects the System V style IPC facility.
985.Bl -column "KERN_SYSVIPC_MSG_INFO" "struct shm_sysctl_info" -offset indent
986.It Sy "Third level name" Ta Sy "Type"
987.It Dv KERN_SYSVIPC_MSG_INFO Ta "struct msg_sysctl_info"
988.It Dv KERN_SYSVIPC_SEM_INFO Ta "struct sem_sysctl_info"
989.It Dv KERN_SYSVIPC_SHM_INFO Ta "struct shm_sysctl_info"
990.El
991.Bl -tag -width "123456"
992.It Dv KERN_SYSVIPC_MSG_INFO
993Return information on the System V style message facility.
994The
995.Sy msg_sysctl_info
996structure is defined in
997.In sys/msg.h .
998.It Dv KERN_SYSVIPC_SEM_INFO
999Return information on the System V style semaphore facility.
1000The
1001.Sy sem_sysctl_info
1002structure is defined in
1003.In sys/sem.h .
1004.It Dv KERN_SYSVIPC_SHM_INFO
1005Return information on the System V style shared memory facility.
1006The
1007.Sy shm_sysctl_info
1008structure is defined in
1009.In sys/shm.h .
1010.El
1011.It Dv KERN_SYSVMSG Pq Va kern.sysvmsg
1012Returns 1 if System V style message queue functionality is available on this
1013system, otherwise 0.
1014.It Dv KERN_SYSVSEM Pq Va kern.sysvem
1015Returns 1 if System V style semaphore functionality is available on this
1016system, otherwise 0.
1017.It Dv KERN_SYSVSHM Pq Va kern.sysvshm
1018Returns 1 if System V style shared memory functionality is available on this
1019system, otherwise 0.
1020.It Dv KERN_TIMECOUNTER Pq Va kern.timecounter
1021Return statistics information about the kernel time counter.
1022The third level names information is detailed below.
1023The changeable column shows whether a process with appropriate
1024privileges may change the value.
1025.Bl -column "KERN_TIMECOUNTER_TIMESTEPWARNINGS" "integer" -offset indent
1026.It Sy "Third level name" Ta Sy "Type" Ta Sy "Changeable"
1027.It Dv KERN_TIMECOUNTER_CHOICE Ta "string" Ta "no"
1028.It Dv KERN_TIMECOUNTER_HARDWARE Ta "string" Ta "yes"
1029.It Dv KERN_TIMECOUNTER_TICK Ta "integer" Ta "no"
1030.It Dv KERN_TIMECOUNTER_TIMESTEPWARNINGS Ta "integer" Ta "yes"
1031.El
1032.Pp
1033The variables are as follows:
1034.Bl -tag -width "123456"
1035.It Dv KERN_TIMECOUNTER_CHOICE Pq Va kern.timecounter.choice
1036Get the list of kernel time counter sources and their claimed
1037quality (higher is better).
1038.It Dv KERN_TIMECOUNTER_HARDWARE Pq Va kern.timecounter.hardware
1039Get or set the kernel time counter source by name.
1040.It Dv KERN_TIMECOUNTER_TICK Pq Va kern.timecounter.tick
1041Get the number of times we have reset the kernel time counter
1042information.
1043.It Dv KERN_TIMECOUNTER_TIMESTEPWARNINGS Pq Va kern.timecounter.timestepwarnings
1044Get or set a flag to log a message when the kernel time is
1045stepped.
1046.El
1047.It Dv KERN_TTY Pq Va kern.tty
1048Return statistics information about tty input/output.
1049The third level names information is detailed below.
1050The changeable column shows whether a process with appropriate
1051privileges may change the value.
1052.Bl -column "KERN_TTY_TKRAWCC" "struct itty" "Changeable" -offset indent
1053.It Sy "Third level name" Ta Sy "Type" Ta Sy "Changeable"
1054.It Dv KERN_TTY_INFO Ta "struct itty" Ta "no"
1055.It Dv KERN_TTY_TKCANCC Ta "int64_t" Ta "no"
1056.It Dv KERN_TTY_TKNIN Ta "int64_t" Ta "no"
1057.It Dv KERN_TTY_TKNOUT Ta "int64_t" Ta "no"
1058.It Dv KERN_TTY_TKRAWCC Ta "int64_t" Ta "no"
1059.El
1060.Pp
1061The variables are as follows:
1062.Bl -tag -width "123456"
1063.It Dv KERN_TTY_INFO Pq Va kern.tty.ttyinfo
1064Returns an array of
1065.Vt struct itty
1066structures containing tty statistics.
1067.It Dv KERN_TTY_TKCANCC Pq Va kern.tty.tk_cancc
1068Returns the number of input characters in canonical mode.
1069.It Dv KERN_TTY_TKNIN Pq Va kern.tty.tk_nin
1070Returns the number of input characters from a
1071.Xr tty 4 .
1072.It Dv KERN_TTY_TKNOUT Pq Va kern.tty.tk_nout
1073Returns the number of output characters on a
1074.Xr tty 4 .
1075.It Dv KERN_TTY_TKRAWCC Pq Va kern.tty.tk_rawcc
1076Returns the number of input characters in raw mode.
1077.El
1078.It Dv KERN_TTYCOUNT Pq Va kern.ttycount
1079Number of available
1080.Xr tty 4
1081devices.
1082.It Dv KERN_VERSION Pq Va kern.version
1083The system version string.
1084.It Dv KERN_WATCHDOG Pq Va kern.watchdog
1085Return information on hardware watchdog timers.
1086If the kernel does not support a hardware watchdog timer,
1087attempts to retrieve or set any of the
1088.Dv KERN_WATCHDOG
1089values will fail with
1090.Er EOPNOTSUPP .
1091.Bl -column "KERN_WATCHDOG_PERIOD" "integer" "Changeable" -offset indent
1092.It Sy "Third level name" Ta Sy "Type" Ta Sy "Changeable"
1093.It Dv KERN_WATCHDOG_AUTO Ta "integer" Ta "yes"
1094.It Dv KERN_WATCHDOG_PERIOD Ta "integer" Ta "yes"
1095.El
1096.Pp
1097The variables are as follows:
1098.Bl -tag -width "123456"
1099.It Dv KERN_WATCHDOG_AUTO Pq Va kern.watchdog.auto
1100If set to 1, the kernel refreshes the watchdog timer periodically.
1101If set to 0, a userland process must ensure that the watchdog timer
1102gets refreshed by setting the
1103.Dv KERN_WATCHDOG_PERIOD
1104variable.
1105.It Dv KERN_WATCHDOG_PERIOD Pq Va kern.watchdog.period
1106The period of the watchdog timer in seconds.
1107Set to 0 to disable the watchdog timer.
1108.El
1109.It Dv KERN_WITNESS Pq Va kern.witness
1110Control settings of
1111.Xr witness 4 .
1112.Bl -column "KERN_WITNESS_LOCKTRACE" "integer" "Changeable" -offset indent
1113.It Sy "Third level name" Ta Sy "Type" Ta Sy "Changeable"
1114.It Dv KERN_WITNESS_LOCKTRACE Ta "integer" Ta "yes"
1115.It Dv KERN_WITNESS_WATCH Ta "integer" Ta "yes"
1116.El
1117.Pp
1118The variables are as follows:
1119.Bl -tag -width "123456"
1120.It Dv KERN_WITNESS_LOCKTRACE Pq Va kern.witness.locktrace
1121When set,
1122.Xr witness 4
1123saves a stack trace on each lock acquisition.
1124The stack traces of acquired locks can be viewed using
1125.Xr ddb 4 .
1126.It Dv KERN_WITNESS_WATCH Pq Va kern.witness.watch
1127Control how
1128.Xr witness 4
1129behaves on error.
1130Valid values are:
1131.Pp
1132.Bl -tag -width 3n -offset indent -compact
1133.It -1
1134Disable
1135.Xr witness 4
1136completely.
1137System reboot is needed to re-enable it.
1138.It 0
1139Disable lock order checking.
1140.It 1
1141Print a message if an error is detected.
1142.It 2
1143Print a message if an error is detected,
1144and a stack trace if possible.
1145.It 3
1146The same as 2, but also drop into the kernel debugger.
1147.El
1148.El
1149.It Dv KERN_WXABORT Pq Va kern.wxabort
1150Generate an abort,
1151rather than returning an error,
1152on W^X violation.
1153.El
1154.Ss CTL_MACHDEP
1155The set of variables defined is architecture dependent.
1156Most architectures define at least the following variables.
1157.Bl -column "Second level name" "dev_t" "Changeable" -offset indent
1158.It Sy "Second level name" Ta Sy "Type" Ta Sy "Changeable"
1159.It Dv CPU_CONSDEV Ta "dev_t" Ta "no"
1160.El
1161.Pp
1162Consult the example file
1163.Pa /etc/examples/sysctl.conf
1164for a non-exhaustive list of
1165.Va machdep
1166variables.
1167.Ss CTL_NET
1168The string and integer information available for the
1169.Dv CTL_NET
1170level is detailed below.
1171The changeable column shows whether a process with appropriate
1172privileges may change the value.
1173.Bl -column "Second level name" "routing messages" "Changeable" -offset indent
1174.It Sy "Second level name" Ta Sy "Type" Ta Sy "Changeable"
1175.It Dv PF_ROUTE Ta "routing messages" Ta "no"
1176.It Dv PF_INET Ta "IPv4 values" Ta "yes"
1177.It Dv PF_INET6 Ta "IPv6 values" Ta "yes"
1178.It Dv PF_KEY Ta "key management" Ta "no"
1179.It Dv PF_MPLS Ta "MPLS values" Ta "yes"
1180.It Dv PF_PIPEX Ta "PIPEX values" Ta "yes"
1181.El
1182.Bl -tag -width "123456"
1183.It Dv PF_ROUTE
1184Return the entire routing table or a subset of it.
1185The data is returned as a sequence of routing messages (see
1186.Xr route 4
1187for the header file, format, and meaning).
1188The length of each message is contained in the message header.
1189.Pp
1190The third level name is a protocol number, which is currently always 0.
1191The fourth level name is an address family, which may be set to 0 to
1192select all address families.
1193The fifth and sixth level names are as follows:
1194.Bl -column "Fifth level name" "Sixth level is:" -offset indent
1195.It Sy "Fifth level name" Ta Sy "Sixth level is:"
1196.It Dv NET_RT_DUMP Ta "priority"
1197.It Dv NET_RT_FLAGS Ta "rtflags"
1198.It Dv NET_RT_IFLIST Ta "None"
1199.It Dv NET_RT_IFNAMES Ta "None"
1200.It Dv NET_RT_STATS Ta "None"
1201.It Dv NET_RT_TABLE Ta "rtableid"
1202.El
1203.Bl -tag -width "123456"
1204.It Dv NET_RT_DUMP
1205If set to 0, show all routes.
1206If set to any number, show all routes with that number priority.
1207If set to a negative number, show routes that do not have the positive
1208priority value.
1209.El
1210.Pp
1211An optional seventh level name can be provided to select the routing table
1212on which to run the operation.
1213If not provided, the table with ID 0 is used.
1214.It Dv PF_INET
1215Get or set various global information about IPv4
1216.Pq Internet Protocol version 4 .
1217The third level name is the protocol.
1218The fourth level name is the variable name.
1219The currently defined protocols and names are:
1220.Bl -column "Protocol name" "ipsec-expire-acquire" "structure" "Changeable" -offset 2n
1221.It Sy "Protocol name" Ta Sy "Variable name" Ta Sy "Type" Ta Sy "Changeable"
1222.It ah Ta enable Ta integer Ta yes
1223.It bpf Ta bufsize Ta integer Ta yes
1224.It bpf Ta maxbufsize Ta integer Ta yes
1225.It carp Ta allow Ta integer Ta yes
1226.It carp Ta log Ta integer Ta yes
1227.It carp Ta preempt Ta integer Ta yes
1228.It divert Ta recvspace Ta integer Ta yes
1229.It divert Ta sendspace Ta integer Ta yes
1230.It esp Ta enable Ta integer Ta yes
1231.It esp Ta udpencap Ta integer Ta yes
1232.It esp Ta udpencap_port Ta integer Ta yes
1233.It etherip Ta allow Ta integer Ta yes
1234.It gre Ta allow Ta integer Ta yes
1235.It gre Ta wccp Ta integer Ta yes
1236.It icmp Ta bmcastecho Ta integer Ta yes
1237.It icmp Ta errppslimit Ta integer Ta yes
1238.It icmp Ta maskrepl Ta integer Ta yes
1239.It icmp Ta rediraccept Ta integer Ta yes
1240.It icmp Ta redirtimeout Ta integer Ta yes
1241.It icmp Ta stats Ta structure Ta no
1242.It icmp Ta tstamprepl Ta integer Ta yes
1243.It ip Ta arpdown Ta integer Ta yes
1244.It ip Ta arptimeout Ta integer Ta yes
1245.It ip Ta directed-broadcast Ta integer Ta yes
1246.It ip Ta encdebug Ta integer Ta yes
1247.It ip Ta forwarding Ta integer Ta yes
1248.It ip Ta ifq Ta node Ta "N/A"
1249.It ip Ta ipsec-allocs Ta integer Ta yes
1250.It ip Ta ipsec-auth-alg Ta string Ta yes
1251.It ip Ta ipsec-bytes Ta integer Ta yes
1252.It ip Ta ipsec-comp-alg Ta string Ta yes
1253.It ip Ta ipsec-enc-alg Ta string Ta yes
1254.It ip Ta ipsec-expire-acquire Ta integer Ta yes
1255.It ip Ta ipsec-firstuse Ta integer Ta yes
1256.It ip Ta ipsec-invalid-life Ta integer Ta yes
1257.It ip Ta ipsec-pfs Ta integer Ta yes
1258.It ip Ta ipsec-soft-allocs Ta integer Ta yes
1259.It ip Ta ipsec-soft-bytes Ta integer Ta yes
1260.It ip Ta ipsec-soft-firstuse Ta integer Ta yes
1261.It ip Ta ipsec-soft-timeout Ta integer Ta yes
1262.It ip Ta ipsec-timeout Ta integer Ta yes
1263.It ip Ta maxqueue Ta integer Ta yes
1264.It ip Ta mforwarding Ta integer Ta yes
1265.It ip Ta mtudisc Ta integer Ta yes
1266.It ip Ta mtudisctimeout Ta integer Ta yes
1267.It ip Ta multipath Ta integer Ta yes
1268.It ip Ta portfirst Ta integer Ta yes
1269.It ip Ta porthifirst Ta integer Ta yes
1270.It ip Ta porthilast Ta integer Ta yes
1271.It ip Ta portlast Ta integer Ta yes
1272.It ip Ta redirect Ta integer Ta yes
1273.It ip Ta sourceroute Ta integer Ta yes
1274.It ip Ta stats Ta structure Ta no
1275.It ip Ta ttl Ta integer Ta yes
1276.It ipcomp Ta enable Ta integer Ta yes
1277.It ipip Ta allow Ta integer Ta yes
1278.It mobileip Ta allow Ta integer Ta yes
1279.It tcp Ta ackonpush Ta integer Ta yes
1280.It tcp Ta always_keepalive Ta integer Ta yes
1281.It tcp Ta baddynamic Ta array Ta yes
1282.It tcp Ta ecn Ta integer Ta yes
1283.It tcp Ta ident Ta structure Ta no
1284.It tcp Ta keepidle Ta integer Ta yes
1285.It tcp Ta keepinittime Ta integer Ta yes
1286.It tcp Ta keepintvl Ta integer Ta yes
1287.It tcp Ta mssdflt Ta integer Ta yes
1288.It tcp Ta reasslimit Ta integer Ta yes
1289.It tcp Ta rfc1323 Ta integer Ta yes
1290.It tcp Ta rfc3390 Ta integer Ta yes
1291.It tcp Ta rootonly Ta array Ta yes
1292.It tcp Ta rstppslimit Ta integer Ta yes
1293.It tcp Ta sack Ta integer Ta yes
1294.It tcp Ta slowhz Ta integer Ta no
1295.It tcp Ta stats Ta structure Ta no
1296.It tcp Ta synbucketlimit Ta integer Ta yes
1297.It tcp Ta syncachelimit Ta integer Ta yes
1298.It tcp Ta synhashsize Ta integer Ta yes
1299.It tcp Ta synuselimit Ta integer Ta yes
1300.It udp Ta baddynamic Ta array Ta yes
1301.It udp Ta checksum Ta integer Ta yes
1302.It udp Ta recvspace Ta integer Ta yes
1303.It udp Ta rootonly Ta array Ta yes
1304.It udp Ta sendspace Ta integer Ta yes
1305.It udp Ta stats Ta structure Ta no
1306.El
1307.Pp
1308The variables are as follows:
1309.Bl -tag -width "123456"
1310.It Li ah.enable Pq Va net.inet.ah.enable
1311If set to 1, enable the Authentication Header
1312.Pq AH
1313IPsec protocol.
1314Enabled by default.
1315See
1316.Xr ipsec 4
1317for more information.
1318.It Li bpf.bufsize Pq Va net.bpf.bufsize
1319The initial size of
1320.Xr bpf 4
1321buffers.
1322.It Li bpf.maxbufsize Pq Va net.bpf.maxbufsize
1323The maximum size a user may request a
1324.Xr bpf 4
1325buffer to be.
1326.It Li carp.allow Pq Va net.inet.carp.allow
1327If set to 0, incoming
1328.Xr carp 4
1329packets will not be processed.
1330If set to any other value, processing will occur.
1331Enabled by default.
1332.It Li carp.log Pq Va net.inet.carp.log
1333Controls the verbosity of
1334.Xr carp 4
1335logging.
1336May be a value between 0 and 7 corresponding with
1337.Xr syslog 3
1338priorities.
1339The default value is 2.
1340.It Li carp.preempt Pq Va net.inet.carp.preempt
1341If set to 0,
1342.Xr carp 4
1343will not attempt to become master if it is receiving advertisements from
1344another active master.
1345If set to any other value, carp will become master of the virtual host if it
1346believes it can send advertisements more frequently than the current master.
1347Disabled by default.
1348.It Li divert.recvspace Pq Va net.inet.divert.recvspace
1349Returns the default divert receive buffer size.
1350.It Li divert.sendspace Pq Va net.inet.divert.sendspace
1351Returns the default divert send buffer size.
1352.It Li esp.enable Pq Va net.inet.esp.enable
1353If set to 1, enable the Encapsulating Security Payload
1354.Pq ESP
1355IPsec protocol.
1356Enabled by default.
1357See
1358.Xr ipsec 4
1359for more information.
1360.It Li esp.udpencap Pq Va net.inet.esp.udpencap
1361If set to 1, enable processing of UDP encapsulated ESP packets.
1362Enabled by default.
1363.It Li esp.udpencap_port Pq Va net.inet.udpencap_port
1364Contains the value of the UDP port that triggers
1365decapsulation for incoming UDP encapsulated ESP packets.
1366The default port is 4500.
1367.It Li etherip.allow Pq Va net.inet.etherip.allow
1368If set to 0, incoming Ethernet-in-IPv4 packets will not be processed.
1369If set to any other value, processing will occur.
1370.It Li gre.allow Pq Va net.inet.gre.allow
1371If set to 0, incoming GRE packets will not be processed.
1372If set to any other value, processing will occur.
1373.It Li gre.wccp Pq Va net.inet.gre.wccp
1374If set to 0, incoming WCCPv1-style GRE packets will not be processed.
1375If set to any other value, and gre.allow allows GRE packet processing,
1376WCCPv1-style GRE packets will be processed.
1377.It Li icmp.bmcastecho Pq Va net.inet.icmp.bmcastecho
1378If set to 1, respond to ICMP echo requests destined for
1379broadcast and multicast addresses.
1380Note, enabling this could open a system to a type of denial of service attack
1381called
1382.Qq smurfing ,
1383and is thus not advised.
1384.It Li icmp.errppslimit Pq Va net.inet.icmp.errppslimit
1385This variable specifies the maximum number of outgoing ICMP error messages
1386per second.
1387ICMP error messages exceeding this value are subject to rate limitation
1388and will not go out from the node.
1389A negative value disables rate limitation.
1390.It Li icmp.maskrepl Pq Va kern.inet.icmp.maskrepl
1391Returns 1 if ICMP network mask requests are to be answered.
1392.It Li icmp.rediraccept Pq Va kern.inet.icmp.rediraccept
1393If set to non-zero, the host will accept ICMP redirect packets.
1394Note that routers will never accept ICMP redirect packets,
1395and the variable is meaningful on IP hosts only.
1396.It Li icmp.redirtimeout Pq Va net.inet.icmp.redrttimeout
1397This variable specifies the lifetime of routing entries generated by incoming
1398ICMP redirects.
1399The default timeout is 10 minutes.
1400.It Li icmp.stats Pq Va kern.inet.icmp.stats
1401Returns the ICMP statistics in a struct icmpstat.
1402.It Li icmp.tstamprepl Pq Va net.inet.icmp.tstamprepl
1403If set to 1, reply to ICMP timestamp requests.
1404If set to 0, ignore timestamp requests.
1405.It Li ip.arpdown Pq Va net.inet.ip.arpdown
1406Lifetime of unresolved ARP entries, in seconds.
1407.It Li ip.arptimeout Pq Va net.inet.ip.arptimeout
1408Lifetime of resolved ARP entries, in seconds.
1409.It Li ip.directed-broadcast Pq Va net.inet.ip.directed-broadcast
1410Returns 1 if directed broadcast behavior is enabled for the host.
1411.It Li ip.encdebug Pq Va net.inet.ip.encdebug
1412Returns 1 when error message reporting is enabled for the host.
1413If the kernel has been compiled with the
1414.Dv ENCDEBUG
1415option,
1416then debugging information will also be reported when this variable is set.
1417.It Li ip.forwarding Pq Va net.inet.ip.forwarding
1418If set to 1, then IP forwarding is enabled for the host,
1419indicating the host is acting as a router.
1420If set to 2, then IP forwarding is restricted to traffic that has been
1421IPsec encapsulated or decapsulated by the host.
1422The default value is 0.
1423.It Li ip.ifq
1424Fifth level comprises an array of
1425.Vt struct ifqueue
1426structures containing information about IP packet input queue.
1427The fifth level names for the elements of
1428.Vt struct ifqueue
1429are detailed below.
1430.Bl -column "Fifth level name" "integer" "Changeable" -offset indent
1431.It Sy "Fifth level name" Ta Sy "Type" Ta Sy "Changeable"
1432.It Dv IFQCTL_DROPS Ta "integer" Ta "no"
1433.It Dv IFQCTL_LEN Ta "integer" Ta "no"
1434.It Dv IFQCTL_MAXLEN Ta "integer" Ta "yes"
1435.El
1436.Pp
1437The variables are as follows:
1438.Pp
1439.Bl -tag -width Ds -compact
1440.It Dv IFQCTL_DROPS Pq Va net.inet.ip.ifq.drops
1441Returns number of packet dropped.
1442.It Dv IFQCTL_LEN Pq Va net.inet.ip.ifq.len
1443Returns the current queue length.
1444.It Dv IFQCTL_MAXLEN Pq Va net.inet.ip.ifq.maxlen
1445Get or set the maximum number of queue length.
1446.El
1447.It Li ip.ipsec-allocs Pq Va net.inet.ip.ipsec-allocs
1448The number of IPsec flows that can use a security association before
1449it expires.
1450If set to less than or equal to zero, the security association will not
1451expire because of this counter.
1452The default value is 0.
1453.It Li ip.ipsec-auth-alg Pq Va net.inet.ip.ipsec-auth-alg
1454This is the default authentication algorithm the kernel will instruct
1455key management daemons to negotiate when establishing security
1456associations on behalf of the kernel.
1457Such security associations can occur as a result of a process having
1458requested some security level through
1459.Xr setsockopt 2 ,
1460or as a result of dynamic VPN entries.
1461Supported values are hmac-md5, hmac-sha1, and hmac-ripemd160.
1462If set to any other value, it is left to the key management daemons to
1463select an authentication algorithm for the security association.
1464The default value is hmac-sha1.
1465.It Li ip.ipsec-bytes Pq Va net.inet.ip.ipsec-bytes
1466The number of bytes that will be processed by a security association
1467before it expires.
1468If set to less than or equal to zero, the security association will not
1469expire because of this counter.
1470The default value is 0.
1471.It Li ip.ipsec-comp-alg Pq Va net.inet.ip.ipsec-comp-alg
1472The compression algorithm to use with an IP Compression Association
1473.Pq IPCA .
1474Possible values are
1475.Dq deflate
1476and
1477.Dq lzs .
1478Note that lzs is only available with
1479.Xr hifn 4 .
1480See
1481.Xr ipsecctl 8
1482for more information.
1483.It Li ip.ipsec-enc-alg Pq Va net.inet.ip.ipsec-enc-alg
1484This is the default encryption algorithm the kernel will instruct key
1485management daemons to negotiate when establishing security
1486associations on behalf of the kernel.
1487Such security associations can occur as a result of a process having
1488requested some security level through
1489.Xr setsockopt 2 ,
1490or as a result of dynamic VPN entries.
1491Supported values are aes, des, 3des, blowfish and cast128.
1492If set to any other value, it is left to the key management daemons to
1493select an encryption algorithm for the security association.
1494The default value is aes.
1495.It Li ip.ipsec-expire-acquire Pq Va net.inet.ip.ipsec-expire-acquire
1496How long the kernel should allow key management to dynamically acquire
1497security associations before re-sending a request.
1498The default value is 30 seconds.
1499.It Li ip.ipsec-firstuse Pq Va net.inet.ip.ipsec-firstuse
1500The number of seconds after a security association is first used before
1501it expires.
1502If set to less than or equal to zero, the security association will
1503not expire because of this timer.
1504The default value is 7200 seconds.
1505.It Li ip.ipsec-invalid-life Pq Va net.inet.ip.ipsec-invalid-life
1506The lifetime of embryonic Security Associations (SAs that key management
1507daemons have reserved but not fully established yet) in seconds.
1508If set to less than or equal to zero, embryonic SAs will not expire.
1509The default value is 60.
1510.It Li ip.ipsec-pfs Pq Va net.inet.ip.ipsec-pfs
1511If set to any non-zero value, the kernel will ask the key management
1512daemons to use Perfect Forward Secrecy when establishing IPsec
1513Security Associations.
1514Perfect Forward Secrecy makes IPsec Security Associations
1515cryptographically distinct from each other, such that breaking the key
1516for one such SA does not compromise any others.
1517Requiring PFS for every security association significantly increases the
1518computational load of
1519.Xr isakmpd 8
1520exchanges.
1521The default value is 1.
1522.It Li ip.ipsec-soft-allocs Pq Va net.inet.ip.ipsec-soft-allocs
1523The number of IPsec flows that can use a security association before a
1524message is sent by the kernel to key management for renegotiation
1525of the security association.
1526If set to less than or equal to zero, no message is sent to key
1527management.
1528The default value is 0.
1529.It Li ip.ipsec-soft-bytes Pq Va net.inet.ip.ipsec-soft-bytes
1530The number of bytes that will be processed by a security association
1531before a message is sent by the kernel to key management for
1532renegotiation of the security association.
1533If set to less than or equal to zero, no message is sent to key
1534management.
1535The default value is 0.
1536.It Li ip.ipsec-soft-firstuse Pq Va net.inet.ip.ipsec-soft-firstuse
1537The number of seconds after a security association is first used
1538before a message is sent by the kernel to key management for
1539renegotiation of the security association.
1540If set to less than or equal to zero, no message is sent to key
1541management.
1542The default value is 3600 seconds.
1543.It Li ip.ipsec-soft-timeout Pq Va net.inet.ip.ipsec-soft-timeout
1544The number of seconds after a security association is established
1545before a message is sent by the kernel to key management for
1546renegotiation of the security association.
1547If set to less than or equal to zero, no message is sent to key
1548management.
1549The default value is 80000 seconds.
1550.It Li ip.ipsec-timeout Pq Va net.inet.ip.ipsec-timeout
1551The number of seconds after a security association is established
1552before it will expire.
1553If set to less than or equal to zero, the security association will
1554not expire because of this timer.
1555The default value is 86400 seconds.
1556.It Li ip.maxqueue Pq Va net.inet.ip.maxqueue
1557Fragment flood protection.
1558Sets the maximum number of unassembled IP fragments in the fragment queue.
1559.It Li ip.mforwarding Pq Va net.inet.ip.mforwarding
1560If set to 1, then multicast forwarding is enabled for the host.
1561The default is 0.
1562.It Li ip.mtudisc Pq Va net.inet.ip.mtudisc
1563Returns 1 if Path MTU Discovery is enabled.
1564.It Li ip.mtudisctimeout Pq Va net.inet.ip.mtudisctimeout
1565Number of seconds in which a route added by the Path MTU
1566Discovery engine will time out.
1567When the route times out, the Path MTU Discovery engine will attempt
1568to probe a larger path MTU.
1569.It Li ip.multipath Pq Va net.inet.ip.multipath
1570This variable enables multipath routing for IPv4 addresses.
1571If set to 0, only the first route selected will be used for a given
1572destination regardless of how many routes exist in the routing table.
1573.It Li ip.portfirst Pq Va net.inet.ip.portfirst
1574Minimum registered port number for TCP/UDP port allocation.
1575Registered ports can be used by ordinary user processes
1576or programs executed by ordinary users.
1577Cannot be less than 1024 or greater than 49151.
1578Must be less than ip.portlast.
1579.It Li ip.porthifirst Pq Va net.inet.ip.porthifirst
1580Minimum dynamic/private port number for TCP/UDP port allocation.
1581Dynamic/private ports can be used by ordinary user processes
1582or programs executed by ordinary users.
1583Cannot be less than 49152 or greater than 65535.
1584Must be less than ip.porthilast.
1585.It Li ip.porthilast Pq Va net.inet.ip.porthilast
1586Maximum dynamic/private port number for TCP/UDP port allocation.
1587Dynamic/private ports can be used by ordinary user processes
1588or programs executed by ordinary users.
1589Cannot be less than 49152 or greater than 65535.
1590Must be greater than ip.porthifirst.
1591.It Li ip.portlast Pq Va net.inet.ip.portlast
1592Maximum registered port number for TCP/UDP port allocation.
1593Registered ports can be used by ordinary user processes
1594or programs executed by ordinary users.
1595Cannot be less than 1024 or greater than 49151.
1596Must be greater than ip.portfirst.
1597.It Li ip.redirect Pq Va net.inet.ip.redirect
1598Returns 1 when ICMP redirects may be sent by the host.
1599This option is ignored unless the host is routing IP packets,
1600and should normally be enabled on all systems.
1601.It Li ip.sourceroute Pq Va net.inet.ip.sourceroute
1602Returns 1 when forwarding of source-routed packets is enabled for
1603the host.
1604When running with a
1605.Xr securelevel 7
1606greater than 0,
1607this variable may not be changed.
1608.It Li ip.stats Pq Va net.inet.ip.stats
1609Returns the IP statistics in a struct ipstat.
1610.It Li ip.ttl Pq Va net.inet.ip.ttl
1611The maximum time-to-live (hop count) value for an IP packet
1612sourced by the system.
1613This value applies to normal transport protocols, not to ICMP.
1614.It Li ipcomp.enable Pq Va net.inet.ipcomp.enable
1615Enable the IPComp protocol.
1616See
1617.Xr ipcomp 4
1618for more information.
1619.It Li ipip.allow Pq Va net.inet.ipip.allow
1620If set to 0, incoming IP-in-IP packets will not be processed.
1621If set to any other value, processing will occur; furthermore, if set
1622to 2, no checks for spoofing of loopback addresses will be done.
1623This is useful only for debugging purposes, and should never be used
1624in production systems.
1625.It Li mobileip.allow Pq Va net.inet.mobileip.allow
1626If set to 0, incoming Mobile IP encapsulated packets (RFC 2004) will not be
1627processed.
1628If set to any other value, processing will occur.
1629.It Li tcp.ackonpush Pq Va net.inet.tcp.ackonpush
1630Returns 1 if TCP segments with the
1631.Dv TH_PUSH
1632flag set are being acknowledged immediately, otherwise 0.
1633.It Li tcp.baddynamic Pq Va net.inet.tcp.baddynamic
1634An array of
1635.Vt in_port_t
1636is returned specifying the bitmask of TCP ports between 512
1637and 1023 inclusive that should not be allocated dynamically
1638by the kernel (i.e., they must be bound specifically by port number).
1639.It Li tcp.ecn Pq Va net.inet.tcp.ecn
1640Returns 1 if Explicit Congestion Notifications for TCP are enabled.
1641.It Li tcp.ident Pq Va net.inet.tcp.ident
1642A
1643.Vt struct tcp_ident_mapping
1644specifying a local and foreign endpoint of a TCP
1645socket is filled in with the effective and real UIDs of the process that
1646owns the socket.
1647If no such socket exists, then the effective and real UID values are
1648both set to \-1.
1649.It Li tcp.keepidle Pq Va net.inet.tcp.keepidle
1650If the socket option
1651.Dv SO_KEEPALIVE
1652has been set on a socket, then this value specifies how much time a
1653connection needs to be idle before keepalives are sent.
1654See also tcp.slowhz.
1655.It Li tcp.keepinittime Pq Va net.inet.tcp.keepinittime
1656Time to keep alive the initial SYN packet of a TCP handshake.
1657.It Li tcp.keepintvl Pq Va net.inet.tcp.keepintvl
1658Time after a keepalive probe is sent until, in the absence of any response,
1659another probe is sent.
1660See also tcp.slowhz.
1661.It Li tcp.always_keepalive Pq Va net.inet.tcp.always_keepalive
1662Act as if the option
1663.Dv SO_KEEPALIVE
1664was set on all TCP sockets.
1665.It Li tcp.mssdflt Pq Va net.inet.tcp.mssdflt
1666The maximum segment size that is used as default for non-local connections.
1667The default value is 512.
1668.It Li tcp.reasslimit Pq Va net.inet.tcp.reasslimit
1669The maximum number of out-of-order TCP
1670segments the system will store for reassembly.
1671.It Li tcp.rfc1323 Pq Va net.inet.tcp.rfc1323
1672Returns 1 if RFC 1323 extensions to TCP are enabled.
1673.It Li tcp.rfc3390 Pq Va net.inet.tcp.rfc3390
1674Returns 1 if the TCP Initial Window
1675is increased to 4 * MSS or 4380 bytes, as specified in RFC 3390.
1676Returns 2 if the TCP Initial Window
1677is increased to 10 * MSS or 14600 bytes, as specified in
1678RFC 6928.
1679.It Li tcp.rootonly Pq Va net.inet.tcp.rootonly
1680An array of
1681.Vt in_port_t
1682is returned specifying the bitmask of TCP ports
1683that can only be bound by processes with root euid.
1684When running with a
1685.Xr securelevel 7
1686greater than 0,
1687this variable may not be changed.
1688.It Li tcp.rstppslimit Pq Va net.inet.tcp.rstppslimit
1689This variable specifies the maximum number of outgoing TCP RST packets
1690per second.
1691TCP RST packets exceeding this value are subject to rate limitation
1692and will not go out from the node.
1693A negative value disables rate limitation.
1694.It Li tcp.sack Pq Va net.inet.tcp.sack
1695Returns 1 if RFC 2018 Selective Acknowledgements are enabled.
1696.It Li tcp.slowhz Pq Va net.inet.tcp.slowhz
1697The units for tcp.keepidle and tcp.keepintvl; those variables are in ticks
1698of a clock that ticks tcp.slowhz times per second.
1699(That is, their values must be divided by the tcp.slowhz value to get times
1700in seconds.)
1701.It Li tcp.stats Pq Va net.inet.tcp.stats
1702Returns the TCP statistics in a struct tcpstat.
1703.It Li tcp.synbucketlimit Pq Va net.inet.tcp.synbucketlimit
1704The maximum number of entries allowed per hash bucket in the TCP SYN cache.
1705.It Li tcp.syncachelimit Pq Va net.inet.tcp.syncachelimit
1706The maximum number of entries allowed in the TCP SYN cache.
1707.It Li tcp.synhashsize Pq Va net.inet.tcp.synhashsize
1708The number of buckets in the TCP SYN cache hash array.
1709After the value is set, the actual size changes when the alternative
1710SYN cache becomes empty and both SYN caches are swapped.
1711.It Li tcp.synuselimit Pq Va net.inet.tcp.synuselimit
1712The minimum number of times the hash function for the TCP SYN cache is used
1713before it is reseeded.
1714.It Li udp.baddynamic Pq Va net.inet.udp.baddynamic
1715Analogous to
1716.Li tcp.baddynamic
1717but for UDP sockets.
1718.It Li udp.checksum Pq Va net.inet.udp.checksum
1719Returns 1 when UDP checksums are being computed and checked.
1720Disabling UDP checksums is strongly discouraged.
1721.It Li udp.recvspace Pq Va net.inet.udp.recvspace
1722Returns the default UDP receive buffer size.
1723.It Li udp.rootonly Pq Va net.inet.udp.rootonly
1724Analogous to
1725.Li tcp.rootonly
1726but for UDP sockets.
1727.It Li udp.sendspace Pq Va net.inet.udp.sendspace
1728Returns the default UDP send buffer size.
1729.It Li udp.stats Pq Va net.inet.udp.stats
1730Returns the UDP statistics in a struct udpstat.
1731.El
1732.It Dv PF_INET6
1733Get or set various global information about IPv6
1734.Pq Internet Protocol version 6 .
1735The third level name is the protocol.
1736The fourth level name is the variable name.
1737The currently defined protocols and names are:
1738.Bl -column "Protocol name" "multicast_mtudisc" "integer" "yes" -offset indent
1739.It Sy "Protocol name" Ta Sy "Variable name" Ta Sy "Type" Ta Sy "Changeable"
1740.It icmp6 Ta errppslimit Ta integer Ta yes
1741.It icmp6 Ta mtudisc_hiwat Ta integer Ta yes
1742.It icmp6 Ta mtudisc_lowat Ta integer Ta yes
1743.It icmp6 Ta nd6_debug Ta integer Ta yes
1744.It icmp6 Ta nd6_delay Ta integer Ta yes
1745.It icmp6 Ta nd6_maxnudhint Ta integer Ta yes
1746.It icmp6 Ta nd6_mmaxtries Ta integer Ta yes
1747.It icmp6 Ta nd6_umaxtries Ta integer Ta yes
1748.It icmp6 Ta redirtimeout Ta integer Ta yes
1749.It ip6 Ta auto_flowlabel Ta integer Ta yes
1750.It ip6 Ta dad_count Ta integer Ta yes
1751.It ip6 Ta dad_pending Ta integer Ta yes
1752.It ip6 Ta defmcasthlim Ta integer Ta yes
1753.It ip6 Ta forwarding Ta integer Ta yes
1754.It ip6 Ta hdrnestlimit Ta integer Ta yes
1755.It ip6 Ta hlim Ta integer Ta yes
1756.It ip6 Ta ifq Ta node Ta "N/A"
1757.It ip6 Ta log_interval Ta integer Ta yes
1758.It ip6 Ta maxdynroutes Ta integer Ta yes
1759.It ip6 Ta maxfragpackets Ta integer Ta yes
1760.It ip6 Ta maxfrags Ta integer Ta yes
1761.It ip6 Ta mforwarding Ta integer Ta yes
1762.It ip6 Ta mtudisctimeout Ta integer Ta yes
1763.It ip6 Ta multicast_mtudisc Ta integer Ta yes
1764.It ip6 Ta multipath Ta integer Ta yes
1765.It ip6 Ta neighborgcthresh Ta integer Ta yes
1766.It ip6 Ta redirect Ta integer Ta yes
1767.It ip6 Ta soiikey Ta uint8_t[] Ta yes
1768.It ip6 Ta use_deprecated Ta integer Ta yes
1769.El
1770.Pp
1771The variables are as follows:
1772.Pp
1773.Bl -tag -width "123456" -compact
1774.It Li icmp6.errppslimit Pq Va net.inet6.icmp6.errppslimit
1775This variable specifies the maximum number of outgoing ICMPv6 error messages
1776per second.
1777ICMPv6 error messages exceeding this value are subject to rate limitation
1778and will not go out from the node.
1779A negative value will disable the rate limitation.
1780.Pp
1781.It Li icmp6.mtudisc_hiwat Pq Va net.inet6.icmp6.mtudisc_hiwat
1782.It Li icmp6.mtudisc_lowat Pq Va net.inet6.icmp6.mtudisc_lowat
1783These variables define the maximum number of routing table entries
1784created due to path MTU discovery
1785.Pq preventing denial-of-service attacks with ICMPv6 too big messages .
1786After IPv6 path MTU discovery happens, path MTU information is kept in
1787the routing table.
1788If the number of routing table entries exceeds this value,
1789the kernel will not attempt to keep the path MTU information.
1790.Li icmp6.mtudisc_hiwat
1791is used when we have verified ICMPv6 too big messages.
1792.Li icmp6.mtudisc_lowat
1793is used when we have unverified ICMPv6 too big messages.
1794Verification is performed by using address/port pairs kept in connected PCBs.
1795A negative value disables the upper limit.
1796.Pp
1797.It Li icmp6.nd6_debug Pq Va net.inet6.icmp6.nd6_debug
1798If set to non-zero, IPv6 neighbor discovery will generate debugging
1799messages.
1800The debug output is useful for diagnosing IPv6 interoperability issues.
1801The flag must be set to 0 for normal operation.
1802.Pp
1803.It Li icmp6.nd6_delay Pq Va net.inet6.icmp6.nd6_delay
1804This variable specifies the
1805.Dv DELAY_FIRST_PROBE_TIME
1806timing constant in IPv6 neighbor discovery specification
1807.Pq RFC 4861 ,
1808in seconds.
1809.Pp
1810.It Li icmp6.nd6_maxnudhint Pq Va net.inet6.icmp6.nd6_maxnudhint
1811IPv6 neighbor discovery permits upper layer protocols to supply reachability
1812hints, to avoid unnecessary neighbor discovery exchanges.
1813This variable defines the number of consecutive hints the neighbor discovery
1814layer will take.
1815For example, by setting the variable to 3, neighbor discovery will take
1816a maximum of 3 consecutive hints.
1817After receiving 3 hints, the neighbor discovery layer will instead perform
1818the normal neighbor discovery process.
1819.Pp
1820.It Li icmp6.nd6_mmaxtries Pq Va net.inet6.icmp6.nd6_mmaxtries
1821This variable specifies the
1822.Dv MAX_MULTICAST_SOLICIT
1823constant in IPv6 neighbor discovery specification
1824.Pq RFC 4861 .
1825.Pp
1826.It Li icmp6.nd6_umaxtries Pq Va net.inet6.icmp6.nd6_umaxtries
1827This variable specifies the
1828.Dv MAX_UNICAST_SOLICIT
1829constant in IPv6 neighbor discovery specification
1830.Pq RFC 4861 .
1831.Pp
1832.It Li icmp6.redirtimeout Pq Va net.inet6.icmp6.redirtimeout
1833The variable specifies the lifetime of routing entries generated by
1834incoming ICMPv6 redirects.
1835.Pp
1836.It Li ip6.auto_flowlabel Pq Va net.inet6.ip6.auto_flowlabel
1837On connected transport protocol packets,
1838fill the IPv6 flowlabel field to help intermediate routers identify
1839packet flows.
1840.Pp
1841.It Li ip6.dad_count Pq Va net.inet6.ip6.dad_count
1842This variable configures the number of IPv6 DAD
1843.Pq duplicated address detection
1844probe packets.
1845These packets are generated when IPv6 interfaces are first brought up.
1846.Pp
1847.It Li ip6.dad_pending Pq Va net.inet6.ip6.dad_pending
1848This variable displays the number of pending IPv6 DAD
1849.Pq duplicated address detection
1850before completion.
1851It is used to make sure that DAD is completed before
1852.Xr netstart 8
1853is executed.
1854.Pp
1855.It Li ip6.defmcasthlim Pq Va net.inet6.ip6.defmcasthlim
1856The default hop limit value for an IPv6 multicast packet sourced by the node.
1857This value applies to all the transport protocols on top of IPv6.
1858Methods for overriding this value are documented in
1859.Xr ip6 4 .
1860.Pp
1861.It Li ip6.forwarding Pq Va net.inet6.ip6.forwarding
1862Returns 1 when IPv6 forwarding is enabled for the node,
1863meaning that the node is acting as a router.
1864Returns 0 when IPv6 forwarding is disabled for the node,
1865meaning that the node is acting as a host.
1866Note that IPv6 defines node behavior for the
1867.Dq router
1868and
1869.Dq host
1870cases quite differently, and changing this variable during operation
1871may cause serious trouble.
1872Hence, this variable should only be set at bootstrap time.
1873.Pp
1874.It Li ip6.hdrnestlimit Pq Va net.inet6.ip6.hdrnestlimit
1875The number of IPv6 extension headers permitted on incoming IPv6 packets.
1876If set to 0, the node will accept as many extension headers as possible.
1877.Pp
1878.It Li ip6.hlim Pq Va net.inet6.ip6.hlim
1879The default hop limit value for an IPv6 unicast packet sourced by the node.
1880This value applies to all the transport protocols on top of IPv6.
1881Methods for overriding this value are documented in
1882.Xr ip6 4 .
1883.Pp
1884.It Li ip6.ifq Pq Va net.inet6.ip6.ifq
1885Fifth level comprises an array of
1886.Vt struct ifqueue
1887structures containing information about IPv6 packet input queue.
1888The fifth level names for the elements of
1889.Vt struct ifqueue
1890are detailed above in
1891.Li ip.ifq .
1892.Pp
1893.It Li ip6.log_interval Pq Va net.inet6.ip6.log_interval
1894This variable permits adjusting the amount of logs generated by the
1895IPv6 packet forwarding engine.
1896The value indicates the number of
1897seconds of interval which must elapse between log output.
1898.Pp
1899.It Li ip6.maxdynroutes Pq Va net.inet6.ip6.maxdynroutes
1900Maximum number of routes created by redirect.
1901Set to negative to disable.
1902The default value is 4096.
1903.Pp
1904.It Li ip6.maxfragpackets Pq Va net.inet6.ip6.maxfragpackets
1905The maximum number of fragmented packets the node will accept.
19060 means that the node will not accept any fragmented packets.
1907\-1 means that the node will accept as many fragmented packets as it receives.
1908The flag is provided basically for avoiding possible DoS attacks.
1909.Pp
1910.It Li ip6.maxfrags Pq Va net.inet6.ip6.maxfrags
1911The maximum number of fragments the node will accept.
19120 means that the node will not accept any fragments.
1913\-1 means that the node will accept as many fragments as it receives.
1914The flag is provided basically for avoiding possible DoS attacks.
1915.Pp
1916.It Li ip6.mforwarding Pq Va net.inet6.ip6.mforwarding
1917If set to 1, then multicast forwarding is enabled for the host.
1918The default is 0.
1919.Pp
1920.It Li ip6.multicast_mtudisc Pq Va net.inet6.ip6.multicast_mtudisc
1921This variable controls generation of ICMPv6 Too Big messages
1922when the machine is performing as an IPv6 multicast router.
1923If set to 1, an ICMPv6 Too Big message will be generated for multicast packets
1924which were too big to be forwarded.
1925If set to 0, the ICMPv6 Too Big message will be suppressed.
1926.Pp
1927.It Li ip6.multipath Pq Va net.inet6.ip6.multipath
1928This variable enables multipath routing for IPv6 addresses.
1929If set to 0, only the first route selected will be used for a given
1930destination regardless of how many routes exist in the routing table.
1931.Pp
1932.It Li ip6.mtudisctimeout Pq Va net.inet6.ip6.mtudisctimeout
1933Number of seconds in which a route added by the Path MTU
1934Discovery engine will time out.
1935When the route times out, the Path MTU Discovery engine will attempt
1936to probe a larger path MTU.
1937.Pp
1938.It Li ip6.neighborgcthresh Pq Va net.inet6.ip6.neighborgcthresh
1939Maximum number of entries in neighbor cache.
1940Set to negative to disable.
1941The default value is 2048.
1942.Pp
1943.It Li ip6.redirect Pq Va net.inet6.ip6.redirect
1944Returns 1 when ICMPv6 redirects may be sent by the node.
1945This option is ignored unless the node is routing IP packets,
1946and should normally be enabled on all systems.
1947.Pp
1948.It Li ip6.soii Pq Va net.inet6.ip6.soiikey
1949This variable configures the secret key for the RFC 7217 algorithm to
1950calculate a persistent Semantically Opaque Interface Identifier (SOII)
1951for IPv6 link local and Stateless Address Autoconfiguration (SLAAC) addresses.
1952.Pp
1953.It Li ip6.use_deprecated Pq Va net.inet6.ip6.use_deprecated
1954This variable controls the use of deprecated addresses, specified in
1955RFC 4862 5.5.4.
1956.El
1957.Pp
1958We reuse
1959.Li net.inet.tcp
1960and
1961.Li net.inet.udp
1962for TCP/UDP over IPv6.
1963.It Dv PF_KEY
1964Return
1965.Xr ipsec 4
1966database dumps.
1967The second level name is
1968.Dv PF_KEY_V2 .
1969The third level name selects the database as follows:
1970.Pp
1971.Bl -tag -width "NET_KEY_SADB_DUMP" -offset indent -compact
1972.It Dv NET_KEY_SADB_DUMP
1973Security Association database (SADB).
1974.It Dv NET_KEY_SPD_DUMP
1975IPsec flow database (SPD).
1976.El
1977.It Dv PF_MPLS
1978Get or set global information about MPLS (Multiprotocol Label Switching).
1979.Bl -column "MPLSCTL_MAXINKLOOP " "integer" "not applicable" -offset indent
1980.It Sy "Third level name" Ta Sy "Type" Ta Sy "Changeable"
1981.It Dv MPLSCTL_DEFTTL Ta integer Ta yes
1982.It Dv MPLSCTL_IFQUEUE Ta node Ta "not applicable"
1983.It Dv MPLSCTL_MAPTTL_IP Ta integer Ta yes
1984.It Dv MPLSCTL_MAPTTL_IP6 Ta integer Ta yes
1985.It Dv MPLSCTL_MAXINKLOOP Ta integer Ta yes
1986.El
1987.Bl -tag -width "123456"
1988.It Dv MPLSCTL_DEFTTL Pq Va net.mpls.ttl
1989Set or get the default TTL value which is used for MPLS (Shim) Header.
1990The default is 255.
1991.It Dv MPLSCTL_IFQUEUE Pq Va net.mpls.ifq
1992Fourth level comprises an array of
1993.Vt struct ifqueue
1994structures containing information about MPLS packet input queue.
1995The forth level names for the elements of
1996.Vt struct ifqueue
1997are the same as described in
1998.Li ip.ifq
1999in the
2000.Dv PF_INET
2001section.
2002.It Dv MPLSCTL_MAPTTL_IP Pq Va net.mpls.mapttl_ip
2003If set to 1 the TTL field is synchronized between the IP header and the
2004MPLS label stack.
2005If set to 0 the IP header TTL is not modified while passing through MPLS
2006and the MPLS label stack is initialized with the
2007.Dv MPLSCTL_DEFTTL .
2008The default is 1.
2009.It Dv MPLSCTL_MAPTTL_IP6 Pq Va net.mpls.mapttl_ip6
2010If set to 1 the TTL field is synchronized between the IPv6 header and the
2011MPLS label stack.
2012If set to 0 the IPv6 header TTL is not modified while passing through MPLS
2013and the MPLS label stack is initialized with the
2014.Dv MPLSCTL_DEFTTL .
2015The default is 0.
2016.It Dv MPLSCTL_MAXINKLOOP Pq Va net.mpls.maxloop_inkernel
2017Set or get the maxinum number of label stack operations (push, swap, pop)
2018that can be made on a packet.
2019The default is 16.
2020.El
2021.It Dv PF_PIPEX Pq Va net.pipex
2022Get or set global information about PIPEX.
2023.Pp
2024The currently defined variable names are:
2025.Bl -column "Third level name" "integer" "Changeable" -offset indent
2026.It Sy "Third level name" Ta Sy "Type" Ta Sy "Changeable"
2027.It Dv PIPEXCTL_ENABLE Ta integer Ta yes
2028.It Dv PIPEXCTL_INQ Ta node Ta not applicable
2029.It Dv PIPEXCTL_OUTQ Ta node Ta not applicable
2030.El
2031.Bl -tag -width "123456"
2032.It Dv PIPEXCTL_ENABLE
2033If set to 1, enable PIPEX processing.
2034The default is 0.
2035.It Dv PIPEXCTL_INQ Pq Va net.pipex.inq
2036Fourth level comprises an array of
2037.Vt struct ifqueue
2038structures containing information about the PIPEX packet input queue.
2039The forth level names for the elements of
2040.Vt struct ifqueue
2041are the same as described in
2042.Li ip.ifq
2043in the
2044.Dv PF_INET
2045section.
2046.It Dv PIPEXCTL_OUTQ Pq Va net.pipex.outq
2047Fourth level comprises an array of
2048.Vt struct ifqueue
2049structures containing information about PIPEX packet output queue.
2050The forth level names for the elements of
2051.Vt struct ifqueue
2052are the same as described in
2053.Li ip.ifq
2054in the
2055.Dv PF_INET
2056section.
2057.El
2058.El
2059.Ss CTL_VFS
2060The string and integer information available for the
2061.Dv CTL_VFS
2062level is detailed below.
2063The changeable column shows whether a process with appropriate
2064privileges may change the value.
2065.Bl -column "Second level name" "VFS generic info" "Changeable" -offset indent
2066.It Sy "Second level name" Ta Sy "Type" Ta Sy "Changeable"
2067.It Dv VFS_GENERIC Ta "VFS generic info" Ta "no"
2068.It Dv "filesystem #" Ta "filesystem info" Ta "no"
2069.El
2070.Bl -tag -width "123456"
2071.It Dv VFS_GENERIC
2072This second level identifier requests generic information about the
2073VFS layer.
2074Within it, the following third level identifiers exist:
2075.Bl -column "Third level name" "struct vfsconf" "Changeable" -offset indent
2076.It Sy "Third level name" Ta Sy "Type" Ta Sy "Changeable"
2077.It Dv VFS_CONF Ta "struct vfsconf" Ta "no"
2078.It Dv VFS_MAXTYPENUM Ta "int" Ta "no"
2079.El
2080.It filesystem #
2081After finding the filesystem dependent
2082.Va vfc_typenum
2083using
2084.Dv VFS_GENERIC
2085with
2086.Dv VFS_CONF ,
2087it is possible to access filesystem dependent information.
2088.Pp
2089Some filesystems may contain settings.
2090.Bl -tag -width "123"
2091.It FFS
2092.Bl -column "FFS_SD_DIRECT_BLK_PTRS" "integer" "Changeable" -offset indent
2093.It Sy "Third level name" Ta Sy "Type" Ta Sy "Changeable"
2094.It Dv FFS_DIRHASH_DIRSIZE Ta "integer" Ta "yes"
2095.It Dv FFS_DIRHASH_MAXMEM Ta "integer" Ta "yes"
2096.It Dv FFS_DIRHASH_MEM Ta "integer" Ta "no"
2097.It Dv FFS_MAX_SOFTDEPS Ta "integer" Ta "yes"
2098.It Dv FFS_SD_BLK_LIMIT_HIT Ta "integer" Ta "yes"
2099.It Dv FFS_SD_BLK_LIMIT_PUSH Ta "integer" Ta "yes"
2100.It Dv FFS_SD_DIR_ENTRY Ta "integer" Ta "yes"
2101.It Dv FFS_SD_DIRECT_BLK_PTRS Ta "integer" Ta "yes"
2102.It Dv FFS_SD_INDIR_BLK_PTRS Ta "integer" Ta "yes"
2103.It Dv FFS_SD_INO_LIMIT_HIT Ta "integer" Ta "yes"
2104.It Dv FFS_SD_INO_LIMIT_PUSH Ta "integer" Ta "yes"
2105.It Dv FFS_SD_INODE_BITMAP Ta "integer" Ta "yes"
2106.It Dv FFS_SD_SYNC_LIMIT_HIT Ta "integer" Ta "yes"
2107.It Dv FFS_SD_TICKDELAY Ta "integer" Ta "yes"
2108.It Dv FFS_SD_WORKLIST_PUSH Ta "integer" Ta "yes"
2109.El
2110.Bl -tag -width "123456"
2111.It Dv FFS_DIRHASH_DIRSIZE Pq Va vfs.ffs.dirhash_dirsize
2112The minimum size of a directory, in bytes, before it is considered for hashing.
2113.It Dv FFS_DIRHASH_MAXMEM Pq Va vfs.ffs.dirhash_maxmem
2114The maximum amount of memory, in bytes, to be used for storing directory
2115hashes.
2116.It Dv FFS_DIRHASH_MEM Pq Va vfs.ffs.dirhash_mem
2117The amount of memory currently used by all directory hashes.
2118.It Dv FFS_MAX_SOFTDEPS Pq Va vfs.ffs.max_softdeps
2119Maximum strcuctures before slowdowns.
2120.It Dv FFS_SD_BLK_LIMIT_HIT Pq Va vfs.ffs.sd_blk_limit_hit
2121Number of times block slowdown imposed.
2122.It Dv FFS_SD_BLK_LIMIT_PUSH Pq Va vfs.ffs.sd_blk_limit_push
2123Number of times block limit neared.
2124.It Dv FFS_SD_DIR_ENTRY Pq Va vfs.ffs.sd_dir_entry
2125Bufs redirtied as dir entry cannot write.
2126.It Dv FFS_SD_DIRECT_BLK_PTRS Pq Va vfs.ffs.sd_direct_blk_ptrs
2127Bufs redirtied as direct ptrs not written.
2128.It Dv FFS_SD_INDIR_BLK_PTRS Pq Va vfs.ffs.sd_indir_blk_ptrs
2129Bufs redirtied as indirect ptrs not written.
2130.It Dv FFS_SD_INO_LIMIT_HIT Pq Va vfs.ffs.sd_ino_limit_hit
2131Number of times inode limit imposed.
2132.It Dv FFS_SD_INO_LIMIT_PUSH Pq Va vfs.ffs.sd_ino_limit_push
2133Number of times inode limit neared.
2134.It Dv FFS_SD_INODE_BITMAP Pq Va vfs.ffs.sd_inode_bitmap
2135Bufs redirtied as inode bitmap not written.
2136.It Dv FFS_SD_SYNC_LIMIT_HIT Pq Va vfs.ffs.sd_sync_limit_hit
2137Number of synchronous slowdowns imposed.
2138.It Dv FFS_SD_TICKDELAY Pq Va vfs.ffs.sd_tickdelay
2139Ticks to pause during slowdown.
2140.It Dv FFS_SD_WORKLIST_PUSH Pq Va vfs.ffs.sd_worklist_push
2141Number of worklist cleanups.
2142.El
2143.It NFS
2144.Bl -column "Third level name" "struct nfsstats" "Changeable" -offset indent
2145.It Sy "Third level name" Ta Sy "Type" Ta Sy "Changeable"
2146.It Dv NFS_NFSSTATS Ta "struct nfsstats" Ta "yes"
2147.It Dv NFS_NIOTHREADS Ta "int" Ta "yes"
2148.El
2149.Bl -tag -width Ds
2150.It Dv NFS_NIOTHREADS Pq Va vfs.nfs.iothreads
2151The number of I/O kernel threads for NFS clients.
2152The default is 4;
2153the maximum is 20.
2154.El
2155.It FUSE
2156.Bl -column "FUSEFS_POOL_NBPAGES" "Type" "Changeable" -offset indent
2157.It Sy "Third level name" Ta Sy "Type" Ta Sy "Changeable"
2158.It Dv FUSEFS_INFBUFS Ta "int" Ta "no"
2159.It Dv FUSEFS_OPENDEVS Ta "int" Ta "no"
2160.It Dv FUSEFS_POOL_NBPAGES Ta "int" Ta "no"
2161.It Dv FUSEFS_WAITFBUFS Ta "int" Ta "no"
2162.El
2163.Bl -tag -width Ds
2164.It Dv FUSEFS_INFBUFS Pq Va vfs.fuse.fusefs_fbufs_in
2165The number of inbound fusebufs.
2166.It Dv FUSEFS_OPENDEVS Pq Va vfs.fuse.fusefs_open_devices
2167The number of FUSE devices opened.
2168.It Dv FUSEFS_POOL_NBPAGES Pq Va vfs.fuse.fusefs_pool_pages
2169The number of pages used for fusebuf memory.
2170.It Dv FUSEFS_WAITFBUFS Pq Va vfs.fuse.fusefs_fbufs_wait
2171The number of fusebufs waiting for a response.
2172.El
2173.El
2174.El
2175.Ss CTL_VM
2176The string and integer information available for the
2177.Dv CTL_VM
2178level is detailed below.
2179The changeable column shows whether a process with appropriate
2180privileges may change the value.
2181.Bl -column "Second level name" "swap encrypt values" "yes" -offset indent
2182.It Sy "Second level name" Ta Sy "Type" Ta Sy "Changeable"
2183.It Dv VM_ANONMIN Ta "integer" Ta "yes"
2184.It Dv VM_LOADAVG Ta "struct loadavg" Ta "no"
2185.It Dv VM_MALLOC_CONF Ta "string" Ta "yes"
2186.It Dv VM_MAXSLP Ta "integer" Ta "no"
2187.It Dv VM_METER Ta "struct vmtotal" Ta "no"
2188.It Dv VM_NKMEMPAGES Ta "integer" Ta "no"
2189.It Dv VM_PSSTRINGS Ta "struct psstrings" Ta "no"
2190.It Dv VM_SWAPENCRYPT Ta "swap encrypt values" Ta "yes"
2191.It Dv VM_USPACE Ta "integer" Ta "no"
2192.It Dv VM_UVMEXP Ta "struct uvmexp" Ta "no"
2193.It Dv VM_VNODEMIN Ta "integer" Ta "yes"
2194.It Dv VM_VTEXTMIN Ta "integer" Ta "yes"
2195.El
2196.Bl -tag -width "123456"
2197.It Dv VM_ANONMIN Pq Va vm.anonmin
2198Percentage of physical memory available for
2199pages which contain anonymous mapping.
2200.It Dv VM_LOADAVG Pq Va vm.loadavg
2201Return the load average history.
2202The returned data consists of a
2203.Vt struct loadavg .
2204.It Dv VM_MALLOC_CONF Pq Va vm.malloc_conf
2205String of option flags for the
2206.Xr malloc 3
2207family of functions
2208which will be applied to all programs starting in the future.
2209The string contains a maximum of 15 characters.
2210.It Dv VM_MAXSLP Pq Va vm.maxslp
2211The time for a process to be blocked before being swappable,
2212in seconds.
2213.It Dv VM_METER Pq Va vm.vmmeter
2214Return the system wide virtual memory statistics.
2215The returned data consists of a
2216.Vt struct vmtotal .
2217.It Dv VM_NKMEMPAGES Pq Va vm.nkmempages
2218Number of pages in kmem_map.
2219.It Dv VM_PSSTRINGS Pq Va vm.psstrings
2220Returns the address of the process
2221.Vt struct ps_strings .
2222The
2223.Xr ps 1
2224program uses it to locate the argument and environment strings.
2225.It Dv VM_SWAPENCRYPT
2226Contains statistics about swap encryption.
2227The string and integer information available for the third level is
2228detailed below.
2229.Bl -column "Third level name" "integer" "Changeable" -offset indent
2230.It Sy "Third level name" Ta Sy "Type" Ta Sy "Changeable"
2231.It Dv SWPENC_CREATED Ta "integer" Ta "no"
2232.It Dv SWPENC_DELETED Ta "integer" Ta "no"
2233.It Dv SWPENC_ENABLE Ta "integer" Ta "yes"
2234.El
2235.Bl -tag -width "123456"
2236.It Dv SWPENC_CREATED Pq Va vm.swapencrypt.keyscreated
2237The number of encryption keys that have been randomly created.
2238The swap partition is divided into sections of normally 512KB.
2239Each section has its own encryption key.
2240.It Dv SWPENC_DELETED Pq Va vm.swapencrypt.keysdeleted
2241The number of encryption keys that have been deleted, thus effectively
2242erasing the data that has been encrypted with them.
2243Encryption keys are deleted when their reference counter reaches zero.
2244.It Dv SWPENC_ENABLE Pq Va vm.swapencrypt.enable
2245Set to 1 to enable swap encryption for all processes.
2246A 0 disables swap encryption.
2247Pages still on swap receive a grandfather clause.
2248Turning this option on does not affect legacy swap data already on the disk,
2249but all newly written data will be encrypted.
2250When swap encryption is turned on, automatic
2251.Xr crash 8
2252dumps are disabled.
2253.El
2254.It Dv VM_USPACE Pq Va vm.uspace
2255The number of bytes allocated for each kernel stack.
2256.It Dv VM_UVMEXP Pq Va vm.uvmexp
2257Contains statistics about the UVM memory management system.
2258.It Dv VM_VNODEMIN Pq Va vm.vnodemin
2259Percentage of physical memory available for
2260pages which contain cached file data.
2261.It Dv VM_VTEXTMIN Pq Va vm.vtextmin
2262Percentage of physical memory available for
2263pages which contain cached executable data.
2264.El
2265.Sh RETURN VALUES
2266If the call to
2267.Fn sysctl
2268is unsuccessful, \-1 is returned and
2269.Va errno
2270is set appropriately.
2271.Sh FILES
2272.Bl -tag -width "uvm/uvmXswapXencrypt.h  " -compact
2273.It In sys/sysctl.h
2274top level identifiers and second level kernel and hardware
2275identifiers
2276.It In sys/socket.h
2277second level network identifiers
2278.It In sys/gmon.h
2279third level profiling identifiers
2280.It In uvm/uvm_param.h
2281second level virtual memory identifiers
2282.It In uvm/uvm_swap_encrypt.h
2283third level virtual memory identifiers
2284.It In net/if.h
2285packet input/output queue identifiers
2286.It In net/pipex.h
2287third level PIPEX identifiers
2288.It In netinet/in.h
2289third and fourth level IPv4/v6 identifiers
2290.It In netinet/ip_divert.h
2291fourth level divert identifiers
2292.It In netinet/icmp_var.h
2293fourth level ICMP identifiers
2294.It In netinet/icmp6.h
2295fourth level ICMPv6 identifiers
2296.It In netinet/tcp_var.h
2297fourth level TCP identifiers
2298.It In netinet/udp_var.h
2299fourth level UDP identifiers
2300.It In ddb/db_var.h
2301second level ddb identifiers
2302.It In sys/mount.h
2303second level vfs identifiers
2304.It In miscfs/fuse/fusefs.h
2305third level fusefs identifiers
2306.It In nfs/nfs.h
2307third level NFS identifiers
2308.It In ufs/ffs/ffs_extern.h
2309third level FFS identifiers
2310.It In machine/cpu.h
2311second level CPU identifiers
2312.El
2313.Sh ERRORS
2314The following errors may be reported:
2315.Bl -tag -width Er
2316.It Bq Er EFAULT
2317The buffer
2318.Fa name ,
2319.Fa oldp ,
2320.Fa newp ,
2321or length pointer
2322.Fa oldlenp
2323contains an invalid address.
2324.It Bq Er EINVAL
2325The
2326.Fa name
2327array is less than two or greater than
2328.Dv CTL_MAXNAME .
2329.It Bq Er EINVAL
2330A non-null
2331.Fa newp
2332pointer is given and its specified length in
2333.Fa newlen
2334is too large or too small.
2335.It Bq Er ENOMEM
2336The length pointed to by
2337.Fa oldlenp
2338is too short to hold the requested value.
2339.It Bq Er ENOENT
2340The mib specified does not exist, or exceeds the range that is possible.
2341.It Bq Er ENXIO
2342If the mib is a sparsely populated array, this error may be returned
2343instead.
2344.It Bq Er ENOTDIR
2345The
2346.Fa name
2347array specifies an intermediate rather than terminal name.
2348.It Bq Er EOPNOTSUPP
2349The
2350.Fa name
2351array specifies a value that is unknown.
2352.It Bq Er EPERM
2353An attempt is made to set a read-only value.
2354.It Bq Er EPERM
2355A process without appropriate privileges attempts to set a value.
2356.It Bq Er EPERM
2357An attempt to change a value protected by the current kernel security
2358level is made.
2359.It Bq Er ESRCH
2360No process could be found which corresponds to the given process ID.
2361.El
2362.Sh SEE ALSO
2363.Xr pathconf 2 ,
2364.Xr sysconf 3 ,
2365.Xr ddb 4 ,
2366.Xr sysctl.conf 5 ,
2367.Xr securelevel 7 ,
2368.Xr sysctl 8
2369.Sh HISTORY
2370The
2371.Fn sysctl
2372function first appeared in
2373.Bx 4.4 .
2374