Page MenuHomeFreeBSD
Differential D4091 Diff 10004 head/share/man/man9/sysctl.9

Changeset View

Standalone View

View Options

head/share/man/man9/sysctl.9

Show All 31 Lines
.Nm SYSCTL_DECL , .Nm SYSCTL_DECL ,
.Nm SYSCTL_ADD_INT , .Nm SYSCTL_ADD_INT ,
.Nm SYSCTL_ADD_LONG , .Nm SYSCTL_ADD_LONG ,
.Nm SYSCTL_ADD_NODE , .Nm SYSCTL_ADD_NODE ,
.Nm SYSCTL_ADD_OPAQUE , .Nm SYSCTL_ADD_OPAQUE ,
.Nm SYSCTL_ADD_PROC , .Nm SYSCTL_ADD_PROC ,
.Nm SYSCTL_ADD_QUAD , .Nm SYSCTL_ADD_QUAD ,
.Nm SYSCTL_ADD_ROOT_NODE , .Nm SYSCTL_ADD_ROOT_NODE ,
.Nm SYSCTL_ADD_S8 ,
.Nm SYSCTL_ADD_S16 ,
.Nm SYSCTL_ADD_S32 ,
.Nm SYSCTL_ADD_S64 ,
.Nm SYSCTL_ADD_STRING , .Nm SYSCTL_ADD_STRING ,
.Nm SYSCTL_ADD_STRUCT , .Nm SYSCTL_ADD_STRUCT ,
.Nm SYSCTL_ADD_U8 , .Nm SYSCTL_ADD_U8 ,
.Nm SYSCTL_ADD_U16 , .Nm SYSCTL_ADD_U16 ,
.Nm SYSCTL_ADD_U32 ,
.Nm SYSCTL_ADD_U64 ,
.Nm SYSCTL_ADD_UAUTO , .Nm SYSCTL_ADD_UAUTO ,
.Nm SYSCTL_ADD_UINT , .Nm SYSCTL_ADD_UINT ,
.Nm SYSCTL_ADD_ULONG , .Nm SYSCTL_ADD_ULONG ,
.Nm SYSCTL_ADD_UQUAD , .Nm SYSCTL_ADD_UQUAD ,
.Nm SYSCTL_CHILDREN , .Nm SYSCTL_CHILDREN ,
.Nm SYSCTL_STATIC_CHILDREN , .Nm SYSCTL_STATIC_CHILDREN ,
.Nm SYSCTL_NODE_CHILDREN , .Nm SYSCTL_NODE_CHILDREN ,
.Nm SYSCTL_PARENT , .Nm SYSCTL_PARENT ,
.Nm SYSCTL_INT , .Nm SYSCTL_INT ,
.Nm SYSCTL_LONG , .Nm SYSCTL_LONG ,
.Nm SYSCTL_NODE , .Nm SYSCTL_NODE ,
.Nm SYSCTL_OPAQUE , .Nm SYSCTL_OPAQUE ,
.Nm SYSCTL_PROC , .Nm SYSCTL_PROC ,
.Nm SYSCTL_QUAD , .Nm SYSCTL_QUAD ,
.Nm SYSCTL_ROOT_NODE , .Nm SYSCTL_ROOT_NODE ,
.Nm SYSCTL_S8 ,
.Nm SYSCTL_S16 ,
.Nm SYSCTL_S32 ,
.Nm SYSCTL_S64 ,
.Nm SYSCTL_STRING , .Nm SYSCTL_STRING ,
.Nm SYSCTL_STRUCT , .Nm SYSCTL_STRUCT ,
.Nm SYSCTL_U8 , .Nm SYSCTL_U8 ,
.Nm SYSCTL_U16 , .Nm SYSCTL_U16 ,
.Nm SYSCTL_U32 ,
.Nm SYSCTL_U64 ,
.Nm SYSCTL_UINT , .Nm SYSCTL_UINT ,
.Nm SYSCTL_ULONG , .Nm SYSCTL_ULONG ,
.Nm SYSCTL_UQUAD .Nm SYSCTL_UQUAD
.Nd Dynamic and static sysctl MIB creation functions .Nd Dynamic and static sysctl MIB creation functions
.Sh SYNOPSIS .Sh SYNOPSIS
.In sys/types.h .In sys/types.h
.In sys/sysctl.h .In sys/sysctl.h
.Fn SYSCTL_DECL name .Fn SYSCTL_DECL name
.Ft struct sysctl_oid * .Ft struct sysctl_oid *
.Fo SYSCTL_ADD_INT .Fo SYSCTL_ADD_INT
.Fa "struct sysctl_ctx_list *ctx" .Fa "struct sysctl_ctx_list *ctx"
.Fa "struct sysctl_oid_list *parent" .Fa "struct sysctl_oid_list *parent"
.Fa "int number" .Fa "int number"
.Fa "const char *name" .Fa "const char *name"
.Fa "int ctlflags" .Fa "int ctlflags"
.Fa "int *ptr" .Fa "int *ptr"
.Fa "intptr_t val" .Fa "int val"
.Fa "const char *descr" .Fa "const char *descr"
.Fc .Fc
.Ft struct sysctl_oid * .Ft struct sysctl_oid *
.Fo SYSCTL_ADD_LONG .Fo SYSCTL_ADD_LONG
.Fa "struct sysctl_ctx_list *ctx" .Fa "struct sysctl_ctx_list *ctx"
.Fa "struct sysctl_oid_list *parent" .Fa "struct sysctl_oid_list *parent"
.Fa "int number" .Fa "int number"
.Fa "const char *name" .Fa "const char *name"
Show All 38 Lines
.Fc .Fc
.Ft struct sysctl_oid * .Ft struct sysctl_oid *
.Fo SYSCTL_ADD_QUAD .Fo SYSCTL_ADD_QUAD
.Fa "struct sysctl_ctx_list *ctx" .Fa "struct sysctl_ctx_list *ctx"
.Fa "struct sysctl_oid_list *parent" .Fa "struct sysctl_oid_list *parent"
.Fa "int number" .Fa "int number"
.Fa "const char *name" .Fa "const char *name"
.Fa "int ctlflags" .Fa "int ctlflags"
.Fa "quad_t *ptr" .Fa "int64_t *ptr"
.Fa "const char *descr" .Fa "const char *descr"
.Fc .Fc
.Ft struct sysctl_oid * .Ft struct sysctl_oid *
.Fo SYSCTL_ADD_ROOT_NODE .Fo SYSCTL_ADD_ROOT_NODE
.Fa "struct sysctl_ctx_list *ctx" .Fa "struct sysctl_ctx_list *ctx"
.Fa "int number" .Fa "int number"
.Fa "const char *name" .Fa "const char *name"
.Fa "int ctlflags" .Fa "int ctlflags"
.Fa "int (*handler)(SYSCTL_HANDLER_ARGS)" .Fa "int (*handler)(SYSCTL_HANDLER_ARGS)"
.Fa "const char *descr" .Fa "const char *descr"
.Fc .Fc
.Ft struct sysctl_oid * .Ft struct sysctl_oid *
.Fo SYSCTL_ADD_S8
.Fa "struct sysctl_ctx_list *ctx"
.Fa "struct sysctl_oid_list *parent"
.Fa "int number"
.Fa "const char *name"
.Fa "int ctlflags"
.Fa "int8_t *ptr"
.Fa "int8_t val"
.Fa "const char *descr"
.Fc
.Ft struct sysctl_oid *
.Fo SYSCTL_ADD_S16
.Fa "struct sysctl_ctx_list *ctx"
.Fa "struct sysctl_oid_list *parent"
.Fa "int number"
.Fa "const char *name"
.Fa "int ctlflags"
.Fa "int16_t *ptr"
.Fa "int16_t val"
.Fa "const char *descr"
.Fc
.Ft struct sysctl_oid *
.Fo SYSCTL_ADD_S32
.Fa "struct sysctl_ctx_list *ctx"
.Fa "struct sysctl_oid_list *parent"
.Fa "int number"
.Fa "const char *name"
.Fa "int ctlflags"
.Fa "int32_t *ptr"
.Fa "int32_t val"
.Fa "const char *descr"
.Fc
.Ft struct sysctl_oid *
.Fo SYSCTL_ADD_S64
.Fa "struct sysctl_ctx_list *ctx"
.Fa "struct sysctl_oid_list *parent"
.Fa "int number"
.Fa "const char *name"
.Fa "int ctlflags"
.Fa "int64_t *ptr"
.Fa "int64_t val"
.Fa "const char *descr"
.Fc
.Ft struct sysctl_oid *
.Fo SYSCTL_ADD_STRING .Fo SYSCTL_ADD_STRING
.Fa "struct sysctl_ctx_list *ctx" .Fa "struct sysctl_ctx_list *ctx"
.Fa "struct sysctl_oid_list *parent" .Fa "struct sysctl_oid_list *parent"
.Fa "int number" .Fa "int number"
.Fa "const char *name" .Fa "const char *name"
.Fa "int ctlflags" .Fa "int ctlflags"
.Fa "char *ptr" .Fa "char *ptr"
.Fa "intptr_t len" .Fa "intptr_t len"
Show All 12 Lines
.Fc .Fc
.Ft struct sysctl_oid * .Ft struct sysctl_oid *
.Fo SYSCTL_ADD_U8 .Fo SYSCTL_ADD_U8
.Fa "struct sysctl_ctx_list *ctx" .Fa "struct sysctl_ctx_list *ctx"
.Fa "struct sysctl_oid_list *parent" .Fa "struct sysctl_oid_list *parent"
.Fa "int number" .Fa "int number"
.Fa "const char *name" .Fa "const char *name"
.Fa "int ctlflags" .Fa "int ctlflags"
.Fa "unsigned int *ptr" .Fa "uint8_t *ptr"
.Fa "intptr_t val" .Fa "uint8_t val"
.Fa "const char *descr" .Fa "const char *descr"
.Fc .Fc
.Ft struct sysctl_oid * .Ft struct sysctl_oid *
.Fo SYSCTL_ADD_U16 .Fo SYSCTL_ADD_U16
.Fa "struct sysctl_ctx_list *ctx" .Fa "struct sysctl_ctx_list *ctx"
.Fa "struct sysctl_oid_list *parent" .Fa "struct sysctl_oid_list *parent"
.Fa "int number" .Fa "int number"
.Fa "const char *name" .Fa "const char *name"
.Fa "int ctlflags" .Fa "int ctlflags"
.Fa "unsigned int *ptr" .Fa "uint16_t *ptr"
.Fa "intptr_t val" .Fa "uint16_t val"
.Fa "const char *descr" .Fa "const char *descr"
.Fc .Fc
.Ft struct sysctl_oid * .Ft struct sysctl_oid *
.Fo SYSCTL_ADD_U32
.Fa "struct sysctl_ctx_list *ctx"
.Fa "struct sysctl_oid_list *parent"
.Fa "int number"
.Fa "const char *name"
.Fa "int ctlflags"
.Fa "uint32_t *ptr"
.Fa "uint32_t val"
.Fa "const char *descr"
.Fc
.Ft struct sysctl_oid *
.Fo SYSCTL_ADD_U64
.Fa "struct sysctl_ctx_list *ctx"
.Fa "struct sysctl_oid_list *parent"
.Fa "int number"
.Fa "const char *name"
.Fa "int ctlflags"
.Fa "uint64_t *ptr"
.Fa "uint64_t val"
.Fa "const char *descr"
.Fc
.Ft struct sysctl_oid *
.Fo SYSCTL_ADD_UINT .Fo SYSCTL_ADD_UINT
.Fa "struct sysctl_ctx_list *ctx" .Fa "struct sysctl_ctx_list *ctx"
.Fa "struct sysctl_oid_list *parent" .Fa "struct sysctl_oid_list *parent"
.Fa "int number" .Fa "int number"
.Fa "const char *name" .Fa "const char *name"
.Fa "int ctlflags" .Fa "int ctlflags"
.Fa "unsigned int *ptr" .Fa "unsigned int *ptr"
.Fa "intptr_t val" .Fa "unsigned int val"
.Fa "const char *descr" .Fa "const char *descr"
.Fc .Fc
.Ft struct sysctl_oid * .Ft struct sysctl_oid *
.Fo SYSCTL_ADD_ULONG .Fo SYSCTL_ADD_ULONG
.Fa "struct sysctl_ctx_list *ctx" .Fa "struct sysctl_ctx_list *ctx"
.Fa "struct sysctl_oid_list *parent" .Fa "struct sysctl_oid_list *parent"
.Fa "int number" .Fa "int number"
.Fa "const char *name" .Fa "const char *name"
.Fa "int ctlflags" .Fa "int ctlflags"
.Fa "unsigned long *ptr" .Fa "unsigned long *ptr"
.Fa "const char *descr" .Fa "const char *descr"
.Fc .Fc
.Ft struct sysctl_oid * .Ft struct sysctl_oid *
.Fo SYSCTL_ADD_UQUAD .Fo SYSCTL_ADD_UQUAD
.Fa "struct sysctl_ctx_list *ctx" .Fa "struct sysctl_ctx_list *ctx"
.Fa "struct sysctl_oid_list *parent" .Fa "struct sysctl_oid_list *parent"
.Fa "int number" .Fa "int number"
.Fa "const char *name" .Fa "const char *name"
.Fa "int ctlflags" .Fa "int ctlflags"
.Fa "u_quad_t *ptr" .Fa "uint64_t *ptr"
.Fa "const char *descr" .Fa "const char *descr"
.Fc .Fc
.Ft struct sysctl_oid * .Ft struct sysctl_oid *
.Fo SYSCTL_ADD_UAUTO .Fo SYSCTL_ADD_UAUTO
.Fa "struct sysctl_ctx_list *ctx" .Fa "struct sysctl_ctx_list *ctx"
.Fa "struct sysctl_oid_list *parent" .Fa "struct sysctl_oid_list *parent"
.Fa "int number" .Fa "int number"
.Fa "const char *name" .Fa "const char *name"
Show All 19 Lines
.Fa "struct sysctl_oid *oid" .Fa "struct sysctl_oid *oid"
.Fc .Fc
.Fn SYSCTL_INT parent number name ctlflags ptr val descr .Fn SYSCTL_INT parent number name ctlflags ptr val descr
.Fn SYSCTL_LONG parent number name ctlflags ptr val descr .Fn SYSCTL_LONG parent number name ctlflags ptr val descr
.Fn SYSCTL_NODE parent number name ctlflags handler descr .Fn SYSCTL_NODE parent number name ctlflags handler descr
.Fn SYSCTL_OPAQUE parent number name ctlflags ptr len format descr .Fn SYSCTL_OPAQUE parent number name ctlflags ptr len format descr
.Fn SYSCTL_PROC parent number name ctlflags arg1 arg2 handler format descr .Fn SYSCTL_PROC parent number name ctlflags arg1 arg2 handler format descr
.Fn SYSCTL_QUAD parent number name ctlflags ptr val descr .Fn SYSCTL_QUAD parent number name ctlflags ptr val descr
.Fn SYSCTL_ROOT_NODE number name ctlflags handler descr
.Fn SYSCTL_S8 parent number name ctlflags ptr val descr
.Fn SYSCTL_S16 parent number name ctlflags ptr val descr
.Fn SYSCTL_S32 parent number name ctlflags ptr val descr
.Fn SYSCTL_S64 parent number name ctlflags ptr val descr
.Fn SYSCTL_STRING parent number name ctlflags arg len descr .Fn SYSCTL_STRING parent number name ctlflags arg len descr
.Fn SYSCTL_STRUCT parent number name ctlflags ptr struct_type descr .Fn SYSCTL_STRUCT parent number name ctlflags ptr struct_type descr
.Fn SYSCTL_ROOT_NODE number name ctlflags handler descr
.Fn SYSCTL_U8 parent number name ctlflags ptr val descr .Fn SYSCTL_U8 parent number name ctlflags ptr val descr
.Fn SYSCTL_U16 parent number name ctlflags ptr val descr .Fn SYSCTL_U16 parent number name ctlflags ptr val descr
.Fn SYSCTL_U32 parent number name ctlflags ptr val descr
.Fn SYSCTL_U64 parent number name ctlflags ptr val descr
.Fn SYSCTL_UINT parent number name ctlflags ptr val descr .Fn SYSCTL_UINT parent number name ctlflags ptr val descr
.Fn SYSCTL_ULONG parent number name ctlflags ptr val descr .Fn SYSCTL_ULONG parent number name ctlflags ptr val descr
.Fn SYSCTL_UQUAD parent number name ctlflags ptr val descr .Fn SYSCTL_UQUAD parent number name ctlflags ptr val descr
.Sh DESCRIPTION .Sh DESCRIPTION
The The
.Nm SYSCTL .Nm SYSCTL
kernel interface allows dynamic or static creation of kernel interface allows dynamic or static creation of
.Xr sysctl 8 .Xr sysctl 8
▲ Show 20 Lines • Show All 167 Lines • ▼ Show 20 Lines
Static sysctls are declared using one of the Static sysctls are declared using one of the
.Fn SYSCTL_INT , .Fn SYSCTL_INT ,
.Fn SYSCTL_LONG , .Fn SYSCTL_LONG ,
.Fn SYSCTL_NODE , .Fn SYSCTL_NODE ,
.Fn SYSCTL_OPAQUE , .Fn SYSCTL_OPAQUE ,
.Fn SYSCTL_PROC , .Fn SYSCTL_PROC ,
.Fn SYSCTL_QUAD , .Fn SYSCTL_QUAD ,
.Fn SYSCTL_ROOT_NODE , .Fn SYSCTL_ROOT_NODE ,
.Fn SYSCTL_S8 ,
.Fn SYSCTL_S16 ,
.Fn SYSCTL_S32 ,
.Fn SYSCTL_S64 ,
.Fn SYSCTL_STRING , .Fn SYSCTL_STRING ,
.Fn SYSCTL_STRUCT , .Fn SYSCTL_STRUCT ,
.Fn SYSCTL_U8 , .Fn SYSCTL_U8 ,
.Fn SYSCTL_U16 , .Fn SYSCTL_U16 ,
.Fn SYSCTL_U32 ,
.Fn SYSCTL_U64 ,
.Fn SYSCTL_UINT , .Fn SYSCTL_UINT ,
.Fn SYSCTL_ULONG .Fn SYSCTL_ULONG
or or
.Fn SYSCTL_UQUAD .Fn SYSCTL_UQUAD
macros. macros.
.Sh CREATING A DYNAMIC SYSCTL .Sh CREATING A DYNAMIC SYSCTL
Dynamic nodes are created using one of the Dynamic nodes are created using one of the
.Fn SYSCTL_ADD_INT , .Fn SYSCTL_ADD_INT ,
.Fn SYSCTL_ADD_LONG , .Fn SYSCTL_ADD_LONG ,
.Fn SYSCTL_ADD_NODE , .Fn SYSCTL_ADD_NODE ,
.Fn SYSCTL_ADD_OPAQUE , .Fn SYSCTL_ADD_OPAQUE ,
.Fn SYSCTL_ADD_PROC , .Fn SYSCTL_ADD_PROC ,
.Fn SYSCTL_ADD_QUAD , .Fn SYSCTL_ADD_QUAD ,
.Fn SYSCTL_ADD_ROOT_NODE , .Fn SYSCTL_ADD_ROOT_NODE ,
.Fn SYSCTL_ADD_S8 ,
.Fn SYSCTL_ADD_S16 ,
.Fn SYSCTL_ADD_S32 ,
.Fn SYSCTL_ADD_S64 ,
.Fn SYSCTL_ADD_STRING , .Fn SYSCTL_ADD_STRING ,
.Fn SYSCTL_ADD_STRUCT , .Fn SYSCTL_ADD_STRUCT ,
.Fn SYSCTL_ADD_U8 , .Fn SYSCTL_ADD_U8 ,
.Fn SYSCTL_ADD_U16 , .Fn SYSCTL_ADD_U16 ,
.Fn SYSCTL_ADD_U32 ,
.Fn SYSCTL_ADD_U64 ,
.Fn SYSCTL_ADD_UAUTO , .Fn SYSCTL_ADD_UAUTO ,
.Fn SYSCTL_ADD_UINT , .Fn SYSCTL_ADD_UINT ,
.Fn SYSCTL_ADD_ULONG , .Fn SYSCTL_ADD_ULONG ,
or or
.Fn SYSCTL_UQUAD .Fn SYSCTL_UQUAD
functions. functions.
See See
.Xr sysctl_remove_oid 9 .Xr sysctl_remove_oid 9
or or
.Xr sysctl_ctx_free 9 .Xr sysctl_ctx_free 9
for more information on how to destroy a dynamically created OID. for more information on how to destroy a dynamically created OID.
.Sh CONTROL FLAGS .Sh CONTROL FLAGS
For most of the above functions and macros, declaring a type as part For most of the above functions and macros, declaring a type as part
of the access flags is not necessary \[em] however, when declaring a of the access flags is not necessary \[em] however, when declaring a
sysctl implemented by a function, including a type in the access mask sysctl implemented by a function, including a type in the access mask
is required: is required:
.Bl -tag -width ".Dv CTLTYPE_NOFETCH" .Bl -tag -width ".Dv CTLTYPE_NOFETCH"
.It Dv CTLTYPE_NODE .It Dv CTLTYPE_NODE
This is a node intended to be a parent for other nodes. This is a node intended to be a parent for other nodes.
.It Dv CTLTYPE_INT .It Dv CTLTYPE_INT
This is a signed integer. This is a signed integer.
.It Dv CTLTYPE_STRING .It Dv CTLTYPE_STRING
This is a nul-terminated string stored in a character array. This is a nul-terminated string stored in a character array.
.It Dv CTLTYPE_S8
This is an 8-bit signed integer.
.It Dv CTLTYPE_S16
This is a 16-bit signed integer.
.It Dv CTLTYPE_S32
This is a 32-bit signed integer.
.It Dv CTLTYPE_S64 .It Dv CTLTYPE_S64
This is a 64-bit signed integer. This is a 64-bit signed integer.
.It Dv CTLTYPE_OPAQUE .It Dv CTLTYPE_OPAQUE
This is an opaque data structure. This is an opaque data structure.
.It Dv CTLTYPE_STRUCT .It Dv CTLTYPE_STRUCT
Alias for Alias for
.Dv CTLTYPE_OPAQUE . .Dv CTLTYPE_OPAQUE .
.It Dv CTLTYPE_U8 .It Dv CTLTYPE_U8
This is an 8-bit unsigned integer. This is an 8-bit unsigned integer.
.It Dv CTLTYPE_U16 .It Dv CTLTYPE_U16
This is a 16-bit unsigned integer. This is a 16-bit unsigned integer.
.It Dv CTLTYPE_U32
This is a 32-bit unsigned integer.
.It Dv CTLTYPE_U64
This is a 64-bit unsigned integer.
.It Dv CTLTYPE_UINT .It Dv CTLTYPE_UINT
This is an unsigned integer. This is an unsigned integer.
.It Dv CTLTYPE_LONG .It Dv CTLTYPE_LONG
This is a signed long. This is a signed long.
.It Dv CTLTYPE_ULONG .It Dv CTLTYPE_ULONG
This is an unsigned long. This is an unsigned long.
.It Dv CTLTYPE_U64
This is a 64-bit unsigned integer.
.El .El
.Pp .Pp
All sysctl types except for new node declarations require one of the following All sysctl types except for new node declarations require one of the following
flags to be set indicating the read and write disposition of the sysctl: flags to be set indicating the read and write disposition of the sysctl:
.Bl -tag -width ".Dv CTLFLAG_ANYBODY" .Bl -tag -width ".Dv CTLFLAG_ANYBODY"
.It Dv CTLFLAG_RD .It Dv CTLFLAG_RD
This is a read-only sysctl. This is a read-only sysctl.
.It Dv CTLFLAG_RDTUN .It Dv CTLFLAG_RDTUN
▲ Show 20 Lines • Show All 235 Lines • Show Last 20 Lines