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