SYSCTL(3)
Bestie, you're looking at SYSCTL(3) from the Library Functions Manual โ aka the libc page for getting and setting system info, and it's honestly giving main character energy in the kernel-adjacent department. Let's go.
โจ NAME โจ
sysctl, sysctlbyname, sysctlnametomib โ get or set system information. That's the whole three-name situation, and yes, they're all in the same friend group.
๐ LIBRARY ๐
Standard C Library (libc, -lc). Slay.
๐ ๏ธ SYNOPSIS ๐ ๏ธ
The vibe check, exactly as the header says:
#include <sys/sysctl.h>
int
sysctl(const int *name, u_int namelen, void *oldp, size_t *oldlenp,
const void *newp, size_t newlen);
int
sysctlbyname(const char *name, void *oldp, size_t *oldlenp,
const void *newp, size_t newlen);
int
sysctlnametomib(const char *name, int *mibp, size_t *sizep);
๐ DESCRIPTION ๐
Okay so sysctl() retrieves system information and lets processes with appropriate privileges set system information. The info it can hand you consists of integers, strings, and tables โ like a little buffet of kernel facts ๐. You can also retrieve and set information from the command interface using the sysctl(8) utility. Obsessed.
Unless explicitly noted below, sysctl() returns a consistent snapshot of the data requested. Consistency is obtained by locking the destination buffer into memory so that the data may be copied out without blocking. Calls to sysctl() are serialized to avoid deadlock โ yes, they queue politely, no chaos.
The state is described using a โManagement Information Baseโ (MIB) style name, listed in name, which is a namelen length array of integers. If that sounds like a coordinate system for kernel data, that's because it lowkey is.
The sysctlbyname() function accepts an ASCII representation of the name and internally looks up the integer name vector. Apart from that, it behaves the same as the standard sysctl() function. Same energy, friendlier spelling โจ.
The information is copied into the buffer specified by oldp. The size of the buffer is given by the location specified by oldlenp before the call, and that location gives the amount of data copied after a successful call and after a call that returns with the error code ENOMEM. So oldlenp is doing double duty: size in, size out. Not me being impressed by a pointer ๐ญ.
If the amount of data available is greater than the size of the buffer supplied, the call supplies as much data as fits in the buffer provided and returns with the error code ENOMEM. Translation: it fills what it can, then tells you the buffer was too small. If the old value is not desired, oldp and oldlenp should be set to NULL.
bestie warning: too-small buffer = partial data plus ENOMEM, not a full clean read. Handle it, don't ignore it ๐
.
The size of the available data can be determined by calling sysctl() with the NULL argument for oldp. The size of the available data will be returned in the location pointed to by oldlenp. For some operations, the amount of space may change often. For these operations, the system attempts to round up so that the returned size is large enough for a call to return the data shortly thereafter. It's giving โI got you, but also data is feral.โ
To set a new value, newp is set to point to a buffer of length newlen from which the requested value is to be taken. If a new value is not to be set, newp should be set to NULL and newlen set to 0. Clean ๐.
The sysctlnametomib() function accepts an ASCII representation of the name, looks up the integer name vector, and returns the numeric representation in the mib array pointed to by mibp. The number of elements in the mib array is given by the location specified by sizep before the call, and that location gives the number of entries copied after a successful call. The resulting mib and size may be used in subsequent sysctl() calls to get the data associated with the requested ASCII name.
This interface is intended for use by applications that want to repeatedly request the same variable โ and here's the flex โ the sysctl() function runs in about a third the time as the same request made via the sysctlbyname() function. The sysctlnametomib() function is also useful for fetching mib prefixes and then adding a final component. For example, to fetch process information for processes with pid's less than 100:
int i, mib[4];
size_t len;
struct kinfo_proc kp;
/* Fill out the first three components of the mib */
len = 4;
sysctlnametomib("kern.proc.pid", mib, &len);
/* Fetch and print entries for pid's < 100 */
for (i = 0; i < 100; i++) {
mib[3] = i;
len = sizeof(kp);
if (sysctl(mib, 4, &kp, &len, NULL, 0) == -1)
perror("sysctl");
else if (len > 0)
printkproc(&kp);
}
The top level names are defined with a CTL_ prefix in <sys/sysctl.h>, and are as follows. The next and subsequent levels down are found in the include files listed here, and described in separate sections below. So here's the whole top-level lineup, no cap:
CTL_DEBUGโ next level names:<sys/sysctl.h>; description: Debugging.CTL_VFSโ next level names:<sys/mount.h>; description: File system.CTL_HWโ next level names:<sys/sysctl.h>; description: Generic CPU, I/O.CTL_KERNโ next level names:<sys/sysctl.h>; description: High kernel limits.CTL_MACHDEPโ next level names:<sys/sysctl.h>; description: Machine dependent.CTL_NETโ next level names:<sys/socket.h>; description: Networking.CTL_USERโ next level names:<sys/sysctl.h>; description: User-level.CTL_VMโ next level names:<vm/vm_param.h>; description: Virtual memory.
For example, the following retrieves the maximum number of processes allowed in the system:
int mib[2], maxproc;
size_t len;
mib[0] = CTL_KERN;
mib[1] = KERN_MAXPROC;
len = sizeof(maxproc);
sysctl(mib, 2, &maxproc, &len, NULL, 0);
To retrieve the standard search path for the system utilities:
int mib[2];
size_t len;
char *p;
mib[0] = CTL_USER;
mib[1] = USER_CS_PATH;
sysctl(mib, 2, NULL, &len, NULL, 0);
p = malloc(len);
sysctl(mib, 2, p, &len, NULL, 0);
๐ CTL_DEBUG ๐
The debugging variables vary from system to system. A debugging variable may be added or deleted without need to recompile sysctl() to know about it. Each time it runs, sysctl() gets the list of debugging variables from the kernel and displays their current values. The system defines twenty (struct ctldebug) variables named debug0 through debug19. They are declared as separate variables so that they can be individually initialized at the location of their associated variable. The loader prevents multiple use of the same variable by issuing errors if a variable is initialized in more than one place. For example, to export the variable dospecialcheck as a debugging variable, the following declaration would be used:
int dospecialcheck = 1;
struct ctldebug debug5 = { "dospecialcheck", &dospecialcheck };
๐๏ธ CTL_VFS ๐๏ธ
A distinguished second level name, VFS_GENERIC, is used to get general information about all file systems. One of its third level identifiers is VFS_MAXTYPENUM that gives the highest valid file system type number. Its other third level identifier is VFS_CONF that returns configuration information about the file system type given as a fourth level identifier (see getvfsbyname(3) as an example of its use). The remaining second level identifiers are the file system type number returned by a statfs(2) call or from VFS_CONF. The third level identifiers available for each file system are given in the header file that defines the mount argument structure for that file system. Very โbring your own header fileโ of it ๐ฆ.
๐ฅ๏ธ CTL_HW ๐ฅ๏ธ
The string and integer information available for the CTL_HW level is detailed below. The changeable column shows whether a process with appropriate privilege may change the value. (Spoiler: in this list, none of them are changeable โ they're all โnoโ bestie.)
HW_MACHINEโ type: string; changeable: no.HW_MODELโ type: string; changeable: no.HW_NCPUโ type: integer; changeable: no.HW_BYTEORDERโ type: integer; changeable: no.HW_PHYSMEMโ type: integer; changeable: no.HW_USERMEMโ type: integer; changeable: no.HW_PAGESIZEโ type: integer; changeable: no.HW_FLOATINGPTโ type: integer; changeable: no.HW_MACHINE_ARCHโ type: string; changeable: no.HW_REALMEMโ type: integer; changeable: no.HW_AVAILPAGESโ type: integer; changeable: no.
And here's what each one actually means, because the names alone are lowkey cryptic:
HW_MACHINEโ The machine class.HW_MODELโ The machine model.HW_NCPUโ The number of cpus.HW_BYTEORDERโ The byteorder (4321or1234).HW_PHYSMEMโ Amount of physical memory (in bytes), minus the amount used by the kernel, pre-loaded modules, and (on x86) the dcons buffer.HW_USERMEMโ Amount of memory (in bytes) which is not wired.HW_PAGESIZEโ The software page size.HW_FLOATINGPTโ Nonzero if the floating point support is in hardware.HW_MACHINE_ARCHโ The machine dependent architecture type.HW_REALMEMโ Amount of memory (in bytes) reported by the firmware. That value is sometimes not sane; in that case, the kernel reports the max memory address instead.HW_AVAILPAGESโ The same value asHW_PHYSMEM, measured in pages rather than bytes.
๐ง CTL_KERN ๐ง
The string and integer information available for the CTL_KERN level is detailed below. The changeable column shows whether a process with appropriate privilege may change the value. The types of data currently available are process information, system vnodes, the open file entries, routing table entries, virtual memory statistics, load average history, and clock rate information.
okay so hereโs the second-level name roster, bestie โ every single one, with its type and whether you can change it, no skips, periodt:
KERN_ARGMAXโ type:integerยท changeable: noKERN_ARNDโ type:integerยท changeable: noKERN_BOOTFILEโ type:stringยท changeable: yesKERN_BOOTTIMEโ type:struct timevalยท changeable: noKERN_CLOCKRATEโ type:struct clockinfoยท changeable: noKERN_FILEโ type:struct xfileยท changeable: noKERN_HOSTIDโ type:integerยท changeable: yesKERN_HOSTUUIDโ type:stringยท changeable: yesKERN_HOSTNAMEโ type:stringยท changeable: yesKERN_IOV_MAXโ type:integerยท changeable: yesKERN_JOB_CONTROLโ type:integerยท changeable: noKERN_LOCKFโ type:struct kinfo_lockfยท changeable: noKERN_LOGSIGEXITโ type:integerยท changeable: yesKERN_MAXFILESโ type:integerยท changeable: yesKERN_MAXFILESPERPROCโ type:integerยท changeable: yesKERN_MAXPHYSโ type:integerยท changeable: noKERN_MAXPROCโ type:integerยท changeable: noKERN_MAXPROCPERUIDโ type:integerยท changeable: yesKERN_MAXVNODESโ type:integerยท changeable: yesKERN_NGROUPSโ type:integerยท changeable: noKERN_NISDOMAINNAMEโ type:stringยท changeable: yesKERN_OSRELDATEโ type:integerยท changeable: noKERN_OSRELEASEโ type:stringยท changeable: noKERN_OSREVโ type:integerยท changeable: noKERN_OSTYPEโ type:stringยท changeable: noKERN_POSIX1โ type:integerยท changeable: noKERN_PROCโ type:nodeยท changeable: not applicableKERN_PS_STRINGSโ type:integerยท changeable: noKERN_SAVED_IDSโ type:integerยท changeable: noKERN_SECURELVLโ type:integerยท changeable: raise onlyKERN_UPDATEINTERVALโ type:integerยท changeable: noKERN_USRSTACKโ type:integerยท changeable: noKERN_VERSIONโ type:stringยท changeable: no
KERN_ARGMAX โ the maximum bytes of argument to execve(2).
KERN_ARND โ arc4rand(9) fills the buffer with random bytes from the in-kernel random data generator. This is an alternative interface for read(2) of the random(4) device, which does not depend on accessibility and correct mounting options of the devfs(4) node.
KERN_BOOTFILE โ the full pathname of the file from which the kernel was loaded.
KERN_BOOTTIME โ a struct timeval structure is returned. This structure contains the time that the system was booted.
KERN_CLOCKRATE โ a struct clockinfo structure is returned. This structure contains the clock, statistics clock and profiling clock frequencies, the number of micro-seconds per hz tick and the skew rate.
KERN_FILE โ return the entire file table. The returned data consists of an array of struct xfile, whose size depends on the current number of such objects in the system.
KERN_HOSTID โ get or set the host ID.
KERN_HOSTUUID โ get or set the hostโs universally unique identifier (UUID).
KERN_HOSTNAME โ get or set the hostname.
KERN_IOV_MAX โ the maximum accepted number of elements in an input-output vector (iovec), see readv(2) and writev(2).
KERN_JOB_CONTROL โ return 1 if job control is available on this system, otherwise 0.
KERN_LOCKF โ returns the list of the file advisory locks currently known to kernel.
KERN_LOGSIGEXIT โ controls logging of process exit due to untrapped signals.
KERN_MAXFILES โ the maximum number of files that may be open in the system.
KERN_MAXFILESPERPROC โ the maximum number of files that may be open for a single process. This limit only applies to processes with an effective uid of nonzero at the time of the open request. Files that have already been opened are not affected if the limit or the effective uid is changed.
KERN_MAXPHYS โ specifies the maximum block I/O size. Can be changed by the tunable kern.maxphys.
KERN_MAXPROC โ the maximum number of concurrent processes the system will allow.
KERN_MAXPROCPERUID โ the maximum number of concurrent processes the system will allow for a single effective uid. This limit only applies to processes with an effective uid of nonzero at the time of a fork request. Processes that have already been started are not affected if the limit is changed.
KERN_MAXVNODES โ the maximum number of vnodes available on the system.
KERN_NGROUPS โ the maximum number of supplemental groups.
KERN_NISDOMAINNAME โ the name of the current YP/NIS domain.
KERN_OSRELDATE โ the kernel release version in the format MmmRxx, where M is the major version, mm is the two digit minor version, R is 0 if release branch, otherwise 1, and xx is updated when the available APIs change.
The userland release version is available from <osreldate.h>; parse this file if you need to get the release version of the currently installed userland.
KERN_OSRELEASE โ the system release string.
KERN_OSREV โ the system revision string.
KERN_OSTYPE โ the system type string.
KERN_POSIX1 โ the version of IEEE Std 1003.1 (โPOSIX.1โ) with which the system attempts to comply.
KERN_PROC โ return selected information about specific running processes.
For the following names, an array of struct kinfo_proc structures is returned, whose size depends on the current number of such objects in the system:
KERN_PROC_ALLโ fourth level:NoneKERN_PROC_PIDโ fourth level: A process IDKERN_PROC_PGRPโ fourth level: A process groupKERN_PROC_SESSIONโ fourth level: A sessionKERN_PROC_TTYโ fourth level: A tty deviceKERN_PROC_UIDโ fourth level: effective user IDKERN_PROC_RUIDโ fourth level: A real user IDKERN_PROC_GIDโ fourth level: effective group IDKERN_PROC_RGIDโ fourth level: A real group ID
For the following names, the miscellaneous information about the target process, which is specified by the fourth level of the oid name, is returned. A process ID of -1 specifies the current process.
KERN_PROC_ARGSโ fourth level:Set of stringsKERN_PROC_PATHNAMEโ fourth level:StringKERN_PROC_KSTACKโ fourth level:struct kinfo_stack []KERN_PROC_VMMAPโ fourth level:struct kinfo_vmentry []KERN_PROC_FILEDESCโ fourth level:struct kinfo_file []KERN_PROC_GROUPSโ fourth level:gid_t []KERN_PROC_ENVโ fourth level:Set of stringsKERN_PROC_AUXVโ fourth level:Elf_Auxinfo []KERN_PROC_RLIMITโ fourth level:IntegerKERN_PROC_PS_STRINGSโ fourth level:IntegerKERN_PROC_UMASKโ fourth level:Integer/shortKERN_PROC_OSRELโ fourth level:IntegerKERN_PROC_SIGTRAMPโ fourth level:IntegerKERN_PROC_CWDโ fourth level:StringKERN_PROC_NFDSโ fourth level:IntegerKERN_PROC_SIGFASTBLKโ fourth level:IntegerKERN_PROC_VM_LAYOUTโ fourth level:struct kinfo_vm_layoutKERN_PROC_RLIMIT_USAGEโ fourth level:rlim_t []KERN_PROC_KQUEUEโ fourth level:struct kinfo_knote []
KERN_PROC_ARGS โ the command line argument array is returned in a flattened form, i.e., zero-terminated arguments follow each other. The total size of array is returned. It is also possible for a process to set its own process title this way.
KERN_PROC_PATHNAME โ the path of the processโ text file is returned.
KERN_PROC_KSTACK โ the in-kernel call stacks for the threads of the specified process.
KERN_PROC_VMMAP โ the description of the map entries for the process. Also refer to kinfo_getvmmap(3).
KERN_PROC_FILEDESC โ the file descriptors for files opened in the specified process. Also refer to kinfo_getfile(3).
KERN_PROC_GROUPS โ groups associated with the process.
KERN_PROC_ENV โ the set of strings representing the environment of the specified process. ๐ซถ
okay so real talk from the kernel's POV: environment only exists at the moment of the execve(2) system call. this node method tries to reconstruct the env from the breadcrumbs left behind in the process address space, but ngl it is not guaranteed to succeed, and it is not guaranteed to show you the current value the program is actually keeping. ๐
KERN_PROC_AUXVโ the set of ELF auxv entries โจ. see the note above about environment, because it applies here too โ same vibes, same caveats.KERN_PROC_RLIMITโ you must supply an additional OID name element specifying the resource name as ingetrlimit(2). the call returns the given resource limit for the process ๐ซถ.KERN_PROC_PS_STRINGSโ returns the location of theps_stringsstructure at the time of the last call toexecve(2)in the specified process ๐KERN_PROC_UMASKโ the current umask value, seeumask(2)๐KERN_PROC_OSRELโ the value of osrel for the process, i.e. the osrel the currently executed image was compiled for. it's read from the note of the elf executable atexecve(2)time. it might be modified by the process (they can be messy like that) ๐KERN_PROC_SIGTRAMPโ address of the signal trampoline in the process address space, where โ simplifying a lot โ the kernel passes control for signal delivery ๐ธKERN_PROC_CWDโ returns the current working directory for the process ๐ฆKERN_PROC_NFDSโ returns the total number of opened file descriptors for the process ๐ฅKERN_PROC_SIGFASTBLKโ returns the address of thesigfastblock(2)location, if active โจKERN_PROC_VM_LAYOUTโ fills a structure describing the process virtual address space layout ๐งKERN_PROC_RLIMIT_USAGEโ likeKERN_PROC_RLIMIT, but instead of the limit it returns the accounted resource usage ๐ . for resources that don't have a meaningful current value,-1is returned.KERN_PROC_KQUEUEโ fills an array of structures describing events registered with the specified kqueue ๐. the next two node's values are the pid and kqfd โ the process ID of the process, and the file descriptor of the kqueue in that process, to query.
KERN_PS_STRINGS ๐
Reports the location of the process ps_strings structure after exec, for the ABI of the querying process ๐
KERN_SAVED_IDS ๐
Returns 1 if saved set-group and saved set-user ID is available, otherwise... well, that's the whole test โจ
KERN_SECURELVL ๐
The system security level. this level may be raised by processes with appropriate privilege, but it may not be lowered ๐ค periodt. no take-backs.
KERN_USRSTACK ๐ซถ
Reports the top of the main thread user stack for the current process.
KERN_VERSION โญ
The system version string. iconic. show-off behavior.
๐ CTL_NET
the string and integer info available at the CTL_NET level is detailed below bestie. the changeable column tells you whether a process with appropriate privilege can change the value:
PF_ROUTEโ routing messages โ not changeable ๐ซPF_INETโ IPv4 values โ changeable โPF_INET6โ IPv6 values โ changeable โ
๐ฃ๏ธ PF_ROUTE
Return the entire routing table, or just a subset of it. the data comes back as a sequence of routing messages (see route(4) for the header file, format and meaning) ๐. the length of each message is contained in the message header, iykyk.
The third level name is a protocol number, which is currently always 0. the fourth level name is an address family, and you can set it to 0 to select all address families ๐. the fifth, sixth and seventh level names go like this:
NET_RT_FLAGSโ sixth level:rtflagsโ seventh level: NoneNET_RT_DUMPโ sixth level: None โ seventh level: None or fib numberNET_RT_IFLISTโ sixth level:0orif_indexโ seventh level: NoneNET_RT_IFMALISTโ sixth level:0orif_indexโ seventh level: NoneNET_RT_IFLISTLโ sixth level:0orif_indexโ seventh level: NoneNET_RT_NHOPSโ sixth level: None โ seventh level: fib number
The NET_RT_IFMALIST name returns info about multicast group memberships on all interfaces if 0 is specified, or for the interface specified by if_index ๐ฆ
The NET_RT_IFLISTL is like NET_RT_IFLIST, just returning message header structs with additional fields allowing the interface to be extended without breaking binary compatibility โจ. NET_RT_IFLISTL uses the 'l' versions of the message header structures: struct if_msghdrl and struct ifa_msghdrl.
NET_RT_NHOPS returns all nexthops for the specified address family in the given fib ๐
๐ก PF_INET
Get or set various global info about IPv4 (Internet Protocol version 4) ๐. the third level name is the protocol, the fourth level name is the variable name. here's the currently defined values, no cap:
icmp.bmcastechoโ type:integerโ changeable: yesicmp.maskreplโ type:integerโ changeable: yesip.forwardingโ type:integerโ changeable: yesip.redirectโ type:integerโ changeable: yesip.ttlโ type:integerโ changeable: yesudp.checksumโ type:integerโ changeable: yes
and here's what each one actually means ๐ :
icmp.bmcastechoโ returns1if an ICMP echo request to a broadcast or multicast address is to be answered ๐icmp.maskreplโ returns1if ICMP network mask requests are to be answered ๐ip.forwardingโ returns1when IP forwarding is enabled for the host, meaning the host is acting as a router ๐ip.redirectโ returns1when ICMP redirects may be sent by the host. this option is ignored unless the host is routing IP packets, and it should normally be enabled on all systems โญip.ttlโ the maximum time-to-live (hop count) value for an IP packet sourced by the system ๐ธ. this value applies to normal transport protocols, not to ICMP.udp.checksumโ returns1when UDP checksums are being computed and checked. disabling UDP checksums is strongly discouraged ๐จ like bestie please don't.
for variables net.inet.*.ipsec, please refer to ipsec(4) ๐ซถ
๐ PF_INET6
Get or set various global info about IPv6 (Internet Protocol version 6) ๐. the third level name is the protocol, the fourth level name is the variable name.
For variables net.inet6.* please refer to inet6(4) โจ. For variables net.inet6.*.ipsec6, please refer to ipsec(4).
๐ค CTL_USER
the string and integer info available at the CTL_USER level is detailed below. the changeable column shows whether a process with appropriate privilege may change the value โ spoiler, none of these are changeable, they're all read-only queens ๐:
USER_BC_BASE_MAXโintegerโ noUSER_BC_DIM_MAXโintegerโ noUSER_BC_SCALE_MAXโintegerโ noUSER_BC_STRING_MAXโintegerโ noUSER_COLL_WEIGHTS_MAXโintegerโ noUSER_CS_PATHโstringโ noUSER_EXPR_NEST_MAXโintegerโ noUSER_LINE_MAXโintegerโ noUSER_LOCALBASEโstringโ noUSER_POSIX2_CHAR_TERMโintegerโ noUSER_POSIX2_C_BINDโintegerโ noUSER_POSIX2_C_DEVโintegerโ noUSER_POSIX2_FORT_DEVโintegerโ noUSER_POSIX2_FORT_RUNโintegerโ noUSER_POSIX2_LOCALEDEFโintegerโ noUSER_POSIX2_SW_DEVโintegerโ noUSER_POSIX2_UPEโintegerโ noUSER_POSIX2_VERSIONโintegerโ noUSER_RE_DUP_MAXโintegerโ noUSER_STREAM_MAXโintegerโ noUSER_TZNAME_MAXโintegerโ no
okay now the actual definitions, one by one ๐:
๐งฎ USER_BC_BASE_MAX
The maximum ibase/obase values in the bc(1) utility.
๐งฎ USER_BC_DIM_MAX
The maximum array size in the bc(1) utility.
๐งฎ USER_BC_SCALE_MAX
The maximum scale value in the bc(1) utility.
๐งฎ USER_BC_STRING_MAX
The maximum string length in the bc(1) utility.
๐ USER_COLL_WEIGHTS_MAX
The maximum number of weights that can be assigned to any entry of the LC_COLLATE order keyword in the locale definition file ๐ฆ
๐ค๏ธ USER_CS_PATH
Return a value for the PATH environment variable that finds all the standard utilities โจ
๐ง USER_EXPR_NEST_MAX
The maximum number of expressions that can be nested within parenthesis by the expr(1) utility. deep nesting? she said know your limits.
๐ USER_LINE_MAX
The maximum length in bytes of a text-processing utility's input line.
๐ฆ USER_LOCALBASE
Return the value of localbase that has been compiled into system utilities that need to have access to resources provided by a port or package ๐
๐ฅ๏ธ USER_POSIX2_CHAR_TERM
Return 1 if the system supports at least one terminal type capable of all operations described in IEEE Std 1003.2 ("POSIX.2"), otherwise 0 ๐
๐ฅ๏ธ USER_POSIX2_C_BIND
Return 1 if the system's C-language development facilities support the C-Language Bindings Option, otherwise 0 โจ
๐ฅ๏ธ USER_POSIX2_C_DEV
Return 1 if the system supports the C-Language Development Utilities Option, otherwise 0 ๐ธ
๐ฅ๏ธ USER_POSIX2_FORT_DEV
Return 1 if the system supports the FORTRAN Development Utilities Option, otherwise 0 ๐ฅ
๐ฅ๏ธ USER_POSIX2_FORT_RUN
Return 1 if the system supports the FORTRAN Runtime Utilities Option, otherwise 0 โญ
๐ฅ๏ธ USER_POSIX2_LOCALEDEF
Return 1 if the system supports the creation of locales, otherwise 0 ๐
๐ฅ๏ธ USER_POSIX2_SW_DEV
Return 1 if the system supports the Software Development Utilities Option, otherwise 0 ๐
๐ธ the user-level identifiers, continued ๐ธ
USER_POSIX2_UPEโ returns1if the system supports the User Portability Utilities Option, otherwise0. yes bestie it's a vibe check for POSIX ๐USER_POSIX2_VERSIONโ the version of IEEE Std 1003.2 (โPOSIX.2โ) that the system is attempting to comply with. key word attempting ๐ญUSER_RE_DUP_MAXโ the maximum number of repeated occurrences of a regular expression that's permitted when you're using interval notation. so like{n,m}energy ๐USER_STREAM_MAXโ the minimum maximum number of streams a process may have open at any one time. yes, "minimum maximum", it's giving oxymoron but it's real โจUSER_TZNAME_MAXโ the minimum maximum number of types supported for the name of a timezone. ๐ฐ๏ธ
๐ฅ CTL_VM ๐ฅ
okay so the string and integer info available at the CTL_VM level is all spelled out below, no gatekeeping. the changeable column tells you whether a process with appropriate privilege can actually change the value โ like, do you have the range to touch it or nah ๐
VM_LOADAVGโ typestruct loadavg, changeable: noVM_TOTALโ typestruct vmtotal, changeable: noVM_SWAPPING_ENABLEDโ typeinteger, changeable: maybeVM_V_FREE_MINโ typeinteger, changeable: yesVM_V_FREE_RESERVEDโ typeinteger, changeable: yesVM_V_FREE_TARGETโ typeinteger, changeable: yesVM_V_INACTIVE_TARGETโ typeinteger, changeable: yesVM_V_PAGEOUT_FREE_MINโ typeinteger, changeable: yesVM_OVERCOMMITโ typeinteger, changeable: yes
the individual VM identifiers, one by one ๐
VM_LOADAVGโ returns the load average history. what you get back is astruct loadavg. history class for your CPU ๐VM_TOTALโ returns the system wide virtual memory statistics. what you get back is astruct vmtotal. the whole system's memory receipts ๐งพVM_SWAPPING_ENABLEDโ1if process swapping is enabled, or0if it's disabled. tiny caveat bestie: this variable is permanently set to0if the kernel was built with swapping disabled. so no takebacks ๐VM_V_FREE_MINโ the minimum amount of memory (cache memory plus free memory) that has to be available before a process waiting on memory will get awakened. like the bare minimum to be let back in the group chat ๐ดVM_V_FREE_RESERVEDโ processes will awaken the pageout daemon and wait for memory if the number of free and cached pages drops below this value. the panic button number ๐จVM_V_FREE_TARGETโ the total amount of free memory (cache memory included) that the pageout daemon tries to maintain. its little goal in life ๐ฏVM_V_INACTIVE_TARGETโ the desired number of inactive pages the pageout daemon should achieve when it runs. inactive pages can be quickly inserted into process address space when needed, so it's lowkey a stash ๐๏ธVM_V_PAGEOUT_FREE_MINโ if the amount of free and cache memory falls below this value, the pageout daemon enters"memory conserving mode"to avoid deadlock. emergency era ๐VM_OVERCOMMITโ overcommit behaviour, as described intuning(7). go read that one for the tea ๐ต
โจ RETURN VALUES โจ
upon successful completion, the value 0 is returned. otherwise the value -1 is returned and the global variable errno is set to indicate the error. classic zero-or-negative-one situation, no in between ๐ซถ
๐ FILES ๐
<sys/sysctl.h>โ definitions for top level identifiers, second level kernel and hardware identifiers, and user level identifiers<sys/socket.h>โ definitions for second level network identifiers<sys/gmon.h>โ definitions for third level profiling identifiers<vm/vm_param.h>โ definitions for second level virtual memory identifiers<netinet/in.h>โ definitions for third level IPv4/IPv6 identifiers and fourth level IPv4/v6 identifiers<netinet/icmp_var.h>โ definitions for fourth level ICMP identifiers<netinet/icmp6.h>โ definitions for fourth level ICMPv6 identifiers<netinet/udp_var.h>โ definitions for fourth level UDP identifiers
๐ ERRORS ๐
these are the errors that may be reported, read them like a warning label bestie:
[EFAULT]โ the buffername,oldp,newp, or length pointeroldlenpcontains an invalid address.[EINVAL]โ thenamearray is less than two or greater thanCTL_MAXNAME.[EINVAL]โ a non-nullnewpis given and its specified length innewlenis too large or too small.[ENOMEM]โ the length pointed to byoldlenpis too short to hold the requested value.[ENOMEM]โ the smaller of either the length pointed to byoldlenpor the estimated size of the returned data exceeds the system limit on locked memory.[ENOMEM]โ locking the bufferoldp, or a portion of the buffer if the estimated size of the data to be returned is smaller, would cause the process to exceed its per-process locked memory limit.[ENOTDIR]โ thenamearray specifies an intermediate rather than terminal name.[EISDIR]โ thenamearray specifies a terminal name, but the actual name is not terminal.[ENOENT]โ thenamearray specifies a value that is unknown.[EPERM]โ an attempt is made to set a read-only value. rude honestly ๐[EPERM]โ a process without appropriate privilege attempts to set a value. no privilege, no entry, that's the rule ๐
๐ SEE ALSO ๐
confstr(3), kinfo_getproc(3), kvm(3), sysconf(3), sysctl(8)
โญ HISTORY โญ
the sysctl() function first appeared in 4.4BSD. an icon, a legend, a pioneer ๐
and that's the whole page bestie, you ate that ๐ซถ this one's from the Debian crew, dated July 31, 2025, and it's SYSCTL(3) โ go forth and sysctl responsibly โจ๐
๐ฆ where this page comes from
- freebsd 15.1: base 15.1
- Copyright (c) 1993 The Regents of the University of California. All rights reserved
- ๐ girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms