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