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