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