share/man/man9/sysctl_add_oid.9

   1 .\"
   2 .\" Copyright (c) 2000, Andrzej Bialecki <abial@FreeBSD.org>
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. The name of the author may not be used to endorse or promote products
  14 .\"    derived from this software without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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 .\" $FreeBSD$
  29 .\"
  30 .Dd July 15, 2000
  31 .Dt SYSCTL_ADD_OID 9
  32 .Os
  33 .Sh NAME
  34 .Nm sysctl_add_oid ,
  35 .Nm sysctl_move_oid ,
  36 .Nm sysctl_remove_oid
  37 .Nd runtime sysctl tree manipulation
  38 .Sh SYNOPSIS
  39 .In sys/types.h
  40 .In sys/sysctl.h
  41 .Ft struct sysctl_oid *
  42 .Fo sysctl_add_oid
  43 .Fa "struct sysctl_ctx_list *ctx"
  44 .Fa "struct sysctl_oid_list *parent"
  45 .Fa "int number"
  46 .Fa "const char *name"
  47 .Fa "int kind"
  48 .Fa "void *arg1"
  49 .Fa "int arg2"
  50 .Fa "int (*handler) (SYSCTL_HANDLER_ARGS)"
  51 .Fa "const char *format"
  52 .Fa "const char *descr"
  53 .Fc
  54 .Ft int
  55 .Fo sysctl_move_oid
  56 .Fa "struct sysctl_oid *oidp"
  57 .Fa "struct sysctl_oid_list *parent"
  58 .Fc
  59 .Ft int
  60 .Fo sysctl_remove_oid
  61 .Fa "struct sysctl_oid *oidp"
  62 .Fa "int del"
  63 .Fa "int recurse"
  64 .Fc
  65 .Ft struct sysctl_oid_list *
  66 .Fo SYSCTL_CHILDREN
  67 .Fa "struct sysctl_oid *oidp"
  68 .Fc
  69 .Ft struct sysctl_oid_list *
  70 .Fo SYSCTL_STATIC_CHILDREN
  71 .Fa "struct sysctl_oid_list OID_NAME"
  72 .Fc
  73 .Ft struct sysctl_oid *
  74 .Fo SYSCTL_ADD_OID
  75 .Fa "struct sysctl_ctx_list *ctx"
  76 .Fa "struct sysctl_oid_list *parent"
  77 .Fa "int number"
  78 .Fa "const char *name"
  79 .Fa "int kind"
  80 .Fa "void *arg1"
  81 .Fa "int arg2"
  82 .Fa "int (*handler) (SYSCTL_HANDLER_ARGS)"
  83 .Fa "const char *format"
  84 .Fa "const char *descr"
  85 .Fc
  86 .Ft struct sysctl_oid *
  87 .Fo SYSCTL_ADD_NODE
  88 .Fa "struct sysctl_ctx_list *ctx"
  89 .Fa "struct sysctl_oid_list *parent"
  90 .Fa "int number"
  91 .Fa "const char *name"
  92 .Fa "int access"
  93 .Fa "int (*handler) (SYSCTL_HANDLER_ARGS)"
  94 .Fa "const char *descr"
  95 .Fc
  96 .Ft struct sysctl_oid *
  97 .Fo SYSCTL_ADD_STRING
  98 .Fa "struct sysctl_ctx_list *ctx"
  99 .Fa "struct sysctl_oid_list *parent"
 100 .Fa "int number"
 101 .Fa "const char *name"
 102 .Fa "int access"
 103 .Fa "char *arg"
 104 .Fa "int len"
 105 .Fa "const char *descr"
 106 .Fc
 107 .Ft struct sysctl_oid *
 108 .Fo SYSCTL_ADD_INT
 109 .Fa "struct sysctl_ctx_list *ctx"
 110 .Fa "struct sysctl_oid_list *parent"
 111 .Fa "int number"
 112 .Fa "const char *name"
 113 .Fa "int access"
 114 .Fa "int *arg"
 115 .Fa "int len"
 116 .Fa "const char *descr"
 117 .Fc
 118 .Ft struct sysctl_oid *
 119 .Fo SYSCTL_ADD_UINT
 120 .Fa "struct sysctl_ctx_list *ctx"
 121 .Fa "struct sysctl_oid_list *parent"
 122 .Fa "int number"
 123 .Fa "const char *name"
 124 .Fa "int access"
 125 .Fa "unsigned int *arg"
 126 .Fa "int len"
 127 .Fa "const char *descr"
 128 .Fc
 129 .Ft struct sysctl_oid *
 130 .Fo SYSCTL_ADD_LONG
 131 .Fa "struct sysctl_ctx_list *ctx"
 132 .Fa "struct sysctl_oid_list *parent"
 133 .Fa "int number"
 134 .Fa "const char *name"
 135 .Fa "int access"
 136 .Fa "long *arg"
 137 .Fa "const char *descr"
 138 .Fc
 139 .Ft struct sysctl_oid *
 140 .Fo SYSCTL_ADD_ULONG
 141 .Fa "struct sysctl_ctx_list *ctx"
 142 .Fa "struct sysctl_oid_list *parent"
 143 .Fa "int number"
 144 .Fa "const char *name"
 145 .Fa "int access"
 146 .Fa "unsigned long *arg"
 147 .Fa "const char *descr"
 148 .Fc
 149 .Ft struct sysctl_oid *
 150 .Fo SYSCTL_ADD_OPAQUE
 151 .Fa "struct sysctl_ctx_list *ctx"
 152 .Fa "struct sysctl_oid_list *parent"
 153 .Fa "int number"
 154 .Fa "const char *name"
 155 .Fa "int access"
 156 .Fa "void *arg"
 157 .Fa "int len"
 158 .Fa "const char *format"
 159 .Fa "const char *descr"
 160 .Fc
 161 .Ft struct sysctl_oid *
 162 .Fo SYSCTL_ADD_STRUCT
 163 .Fa "struct sysctl_ctx_list *ctx"
 164 .Fa "struct sysctl_oid_list *parent"
 165 .Fa "int number"
 166 .Fa "const char *name"
 167 .Fa "int access"
 168 .Fa "void *arg"
 169 .Fa STRUCT_NAME
 170 .Fa "const char *descr"
 171 .Fc
 172 .Ft struct sysctl_oid *
 173 .Fo SYSCTL_ADD_PROC
 174 .Fa "struct sysctl_ctx_list *ctx"
 175 .Fa "struct sysctl_oid_list *parent"
 176 .Fa "int number"
 177 .Fa "const char *name"
 178 .Fa "int access"
 179 .Fa "void *arg1"
 180 .Fa "int arg2"
 181 .Fa "int (*handler) (SYSCTL_HANDLER_ARGS)"
 182 .Fa "const char *format"
 183 .Fa "const char *descr"
 184 .Fc
 185 .Sh DESCRIPTION
 186 These functions and macros provide an interface
 187 for creating and deleting sysctl oids at runtime
 188 (e.g.\& during lifetime of a module).
 189 The alternative method,
 190 based on linker sets (see
 191 .In sys/linker_set.h
 192 and
 193 .\" XXX Manual pages should avoid referencing source files
 194 .Pa src/sys/kern/kern_sysctl.c
 195 for details), only allows creation and deletion
 196 on module load and unload respectively.
 197 .Pp
 198 Dynamic oids of type
 199 .Dv CTLTYPE_NODE
 200 are reusable
 201 so that several code sections can create and delete them,
 202 but in reality they are allocated and freed
 203 based on their reference count.
 204 As a consequence,
 205 it is possible for two or more code sections
 206 to create partially overlapping trees that they both can use.
 207 It is not possible to create overlapping leaves,
 208 nor to create different child types with the same name and parent.
 209 .Pp
 210 Newly created oids are connected to their parent nodes.
 211 In all these functions and macros
 212 (with the exception of
 213 .Fn sysctl_remove_oid ) ,
 214 one of the required parameters is
 215 .Fa parent ,
 216 which points to the head of the parent's list of children.
 217 .Pp
 218 Most top level categories are created statically.
 219 When connecting to existing static oids,
 220 this pointer can be obtained with the
 221 .Fn SYSCTL_STATIC_CHILDREN
 222 macro, where the
 223 .Fa OID_NAME
 224 argument is name of the parent oid of type
 225 .Dv CTLTYPE_NODE
 226 (i.e., the name displayed by
 227 .Xr sysctl 8 ,
 228 preceded by underscore, and with all dots replaced with underscores).
 229 .Pp
 230 When connecting to an existing dynamic oid, this pointer
 231 can be obtained with the
 232 .Fn SYSCTL_CHILDREN
 233 macro, where the
 234 .Fa oidp
 235 argument points to the parent oid of type
 236 .Dv CTLTYPE_NODE .
 237 .Pp
 238 The
 239 .Fn sysctl_add_oid
 240 function creates raw oids of any type.
 241 If the oid is successfully created,
 242 the function returns a pointer to it;
 243 otherwise it returns
 244 .Dv NULL .
 245 Many of the arguments for
 246 .Fn sysctl_add_oid
 247 are common to the macros.
 248 The arguments are as follows:
 249 .Bl -tag -width handler
 250 .It Fa ctx
 251 A pointer to an optional sysctl context, or
 252 .Dv NULL .
 253 See
 254 .Xr sysctl_ctx_init 9
 255 for details.
 256 Programmers are strongly advised to use contexts
 257 to organize the dynamic oids which they create,
 258 unless special creation and deletion sequences are required.
 259 If
 260 .Fa ctx
 261 is not
 262 .Dv NULL ,
 263 the newly created oid will be added to this context
 264 as its first entry.
 265 .It Fa parent
 266 A pointer to a
 267 .Li struct sysctl_oid_list ,
 268 which is the head of the parent's list of children.
 269 .It Fa number
 270 The oid number that will be assigned to this oid.
 271 In almost all cases this should be set to
 272 .Dv OID_AUTO ,
 273 which will result in the assignment of the next available oid number.
 274 .It Fa name
 275 The name of the oid.
 276 The newly created oid will contain a copy of the name.
 277 .It Fa kind
 278 The kind of oid,
 279 specified as a bit mask of the type and access values defined in the
 280 .In sys/sysctl.h
 281 header file.
 282 Oids created dynamically always have the
 283 .Dv CTLFLAG_DYN
 284 flag set.
 285 Access flags specify whether this oid is read-only or read-write,
 286 and whether it may be modified by all users
 287 or by the superuser only.
 288 .It Fa arg1
 289 A pointer to any data that the oid should reference, or
 290 .Dv NULL .
 291 .It Fa arg2
 292 The size of
 293 .Fa arg1 ,
 294 or 0 if
 295 .Fa arg1
 296 is
 297 .Dv NULL .
 298 .It Fa handler
 299 A pointer to the function
 300 that is responsible for handling read and write requests
 301 to this oid.
 302 There are several standard handlers
 303 that support operations on nodes,
 304 integers, strings and opaque objects.
 305 It is possible also to define new handlers using the
 306 .Fn SYSCTL_ADD_PROC
 307 macro.
 308 .It Fa format
 309 A pointer to a string
 310 which specifies the format of the oid symbolically.
 311 This format is used as a hint by
 312 .Xr sysctl 8
 313 to apply proper data formatting for display purposes.
 314 Currently used format names are:
 315 .Dq N
 316 for node,
 317 .Dq A
 318 for
 319 .Li "char *" ,
 320 .Dq I
 321 for
 322 .Li "int" ,
 323 .Dq IU
 324 for
 325 .Li "unsigned int" ,
 326 .Dq L
 327 for
 328 .Li "long" ,
 329 .Dq LU
 330 for
 331 .Li "unsigned long"
 332 and
 333 .Dq S,TYPE
 334 for
 335 .Li "struct TYPE"
 336 structures.
 337 .It Fa descr
 338 A pointer to a textual description of the oid.
 339 .El
 340 .Pp
 341 The
 342 .Fn sysctl_move_oid
 343 function reparents an existing oid.
 344 The oid is assigned a new number as if it had been created with
 345 .Fa number
 346 set to
 347 .Dv OID_AUTO .
 348 .Pp
 349 The
 350 .Fn sysctl_remove_oid
 351 function removes a dynamically created oid from the tree,
 352 optionally freeing its resources.
 353 It takes the following arguments:
 354 .Bl -tag -width recurse
 355 .It Fa oidp
 356 A pointer to the dynamic oid to be removed.
 357 If the oid is not dynamic, or the pointer is
 358 .Dv NULL ,
 359 the function returns
 360 .Er EINVAL .
 361 .It Fa del
 362 If non-zero,
 363 .Fn sysctl_remove_oid
 364 will try to free the oid's resources
 365 when the reference count of the oid becomes zero.
 366 However, if
 367 .Fa del
 368 is set to 0,
 369 the routine will only deregister the oid from the tree,
 370 without freeing its resources.
 371 This behaviour is useful when the caller expects to rollback
 372 (possibly partially failed)
 373 deletion of many oids later.
 374 .It Fa recurse
 375 If non-zero, attempt to remove the node and all its children.
 376 If
 377 .Pa recurse
 378 is set to 0,
 379 any attempt to remove a node that contains any children
 380 will result in a
 381 .Er ENOTEMPTY
 382 error.
 383 .Em WARNING : "use recursive deletion with extreme caution" !
 384 Normally it should not be needed if contexts are used.
 385 Contexts take care of tracking inter-dependencies
 386 between users of the tree.
 387 However, in some extreme cases it might be necessary
 388 to remove part of the subtree no matter how it was created,
 389 in order to free some other resources.
 390 Be aware, though, that this may result in a system
 391 .Xr panic 9
 392 if other code sections continue to use removed subtrees.
 393 .El
 394 .Pp
 395 .\" XXX sheldonh finished up to here
 396 Again, in most cases the programmer should use contexts,
 397 as described in
 398 .Xr sysctl_ctx_init 9 ,
 399 to keep track of created oids,
 400 and to delete them later in orderly fashion.
 401 .Pp
 402 There is a set of macros defined
 403 that helps to create oids of given type.
 404 .Bl -tag -width SYSCTL_ADD_STRINGXX
 405 They are as follows:
 406 .It Fn SYSCTL_ADD_OID
 407 creates a raw oid.
 408 This macro is functionally equivalent to the
 409 .Fn sysctl_add_oid
 410 function.
 411 .It Fn SYSCTL_ADD_NODE
 412 creates an oid of type
 413 .Dv CTLTYPE_NODE ,
 414 to which child oids may be added.
 415 .It Fn SYSCTL_ADD_STRING
 416 creates an oid that handles a zero-terminated character string.
 417 .It Fn SYSCTL_ADD_INT
 418 creates an oid that handles an
 419 .Li int
 420 variable.
 421 .It Fn SYSCTL_ADD_UINT
 422 creates an oid that handles an
 423 .Li unsigned int
 424 variable.
 425 .It Fn SYSCTL_ADD_LONG
 426 creates an oid that handles a
 427 .Li long
 428 variable.
 429 .It Fn SYSCTL_ADD_ULONG
 430 creates an oid that handles an
 431 .Li unsigned long
 432 variable.
 433 .It Fn SYSCTL_ADD_OPAQUE
 434 creates an oid that handles any chunk of opaque data
 435 of the size specified by the
 436 .Fa len
 437 argument,
 438 which is a pointer to a
 439 .Li "size_t *" .
 440 .It Fn SYSCTL_ADD_STRUCT
 441 creates an oid that handles a
 442 .Li "struct TYPE"
 443 structure.
 444 The
 445 .Fa format
 446 parameter will be set to
 447 .Dq S,TYPE
 448 to provide proper hints to the
 449 .Xr sysctl 8
 450 utility.
 451 .It Fn SYSCTL_ADD_PROC
 452 creates an oid with the specified
 453 .Pa handler
 454 function.
 455 The handler is responsible for handling read and write requests
 456 to the oid.
 457 This oid type is especially useful
 458 if the kernel data is not easily accessible,
 459 or needs to be processed before exporting.
 460 .El
 461 .Sh EXAMPLES
 462 The following is an example of
 463 how to create a new top-level category
 464 and how to hook up another subtree to an existing static node.
 465 This example does not use contexts,
 466 which results in tedious management of all intermediate oids,
 467 as they need to be freed later on:
 468 .Bd -literal
 469 #include <sys/sysctl.h>
 470  ...
 471 /* Need to preserve pointers to newly created subtrees, to be able
 472  * to free them later.
 473  */
 474 struct sysctl_oid *root1, *root2, *oidp;
 475 int a_int;
 476 char *string = "dynamic sysctl";
 477  ...
 478
 479 root1 = SYSCTL_ADD_NODE( NULL, SYSCTL_STATIC_CHILDREN(/* tree top */),
 480         OID_AUTO, "newtree", CTLFLAG_RW, 0, "new top level tree");
 481 oidp = SYSCTL_ADD_INT( NULL, SYSCTL_CHILDREN(root1),
 482         OID_AUTO, "newint", CTLFLAG_RW, &a_int, 0, "new int leaf");
 483  ...
 484 root2 = SYSCTL_ADD_NODE( NULL, SYSCTL_STATIC_CHILDREN(_debug),
 485         OID_AUTO, "newtree", CTLFLAG_RW, 0, "new tree under debug");
 486 oidp = SYSCTL_ADD_STRING( NULL, SYSCTL_CHILDREN(root2),
 487         OID_AUTO, "newstring", CTLFLAG_RD, string, 0, "new string leaf");
 488 .Ed
 489 .Pp
 490 This example creates the following subtrees:
 491 .Bd -literal -offset indent
 492 debug.newtree.newstring
 493 newtree.newint
 494 .Ed
 495 .Pp
 496 .Em "Care should be taken to free all oids once they are no longer needed!"
 497 .Sh SEE ALSO
 498 .Xr sysctl 8 ,
 499 .Xr sysctl 9 ,
 500 .Xr sysctl_ctx_free 9 ,
 501 .Xr sysctl_ctx_init 9
 502 .Sh HISTORY
 503 These functions first appeared in
 504 .Fx 4.2 .
 505 .Sh AUTHORS
 506 .An Andrzej Bialecki Aq abial@FreeBSD.org
 507 .Sh BUGS
 508 Sharing nodes between many code sections
 509 causes interdependencies that sometimes may lock the resources.
 510 For example,
 511 if module A hooks up a subtree to an oid created by module B,
 512 module B will be unable to delete that oid.
 513 These issues are handled properly by sysctl contexts.
 514 .Pp
 515 Many operations on the tree involve traversing linked lists.
 516 For this reason, oid creation and removal is relatively costly.