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