kern_sysctl.c revision 1.249.2.1 1 /* $NetBSD: kern_sysctl.c,v 1.249.2.1 2014/04/07 02:20:00 tls Exp $ */
2
3 /*-
4 * Copyright (c) 2003, 2007, 2008 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Andrew Brown.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 /*-
33 * Copyright (c) 1982, 1986, 1989, 1993
34 * The Regents of the University of California. All rights reserved.
35 *
36 * This code is derived from software contributed to Berkeley by
37 * Mike Karels at Berkeley Software Design, Inc.
38 *
39 * Redistribution and use in source and binary forms, with or without
40 * modification, are permitted provided that the following conditions
41 * are met:
42 * 1. Redistributions of source code must retain the above copyright
43 * notice, this list of conditions and the following disclaimer.
44 * 2. Redistributions in binary form must reproduce the above copyright
45 * notice, this list of conditions and the following disclaimer in the
46 * documentation and/or other materials provided with the distribution.
47 * 3. Neither the name of the University nor the names of its contributors
48 * may be used to endorse or promote products derived from this software
49 * without specific prior written permission.
50 *
51 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
52 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
53 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
54 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
55 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
56 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
57 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
58 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
59 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
60 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
61 * SUCH DAMAGE.
62 *
63 * @(#)kern_sysctl.c 8.9 (Berkeley) 5/20/95
64 */
65
66 /*
67 * sysctl system call.
68 */
69
70 #include <sys/cdefs.h>
71 __KERNEL_RCSID(0, "$NetBSD: kern_sysctl.c,v 1.249.2.1 2014/04/07 02:20:00 tls Exp $");
72
73 #include "opt_defcorename.h"
74 #include "ksyms.h"
75
76 #include <sys/param.h>
77 #define __COMPAT_SYSCTL
78 #include <sys/sysctl.h>
79 #include <sys/systm.h>
80 #include <sys/buf.h>
81 #include <sys/ksyms.h>
82 #include <sys/malloc.h>
83 #include <sys/mount.h>
84 #include <sys/syscallargs.h>
85 #include <sys/kauth.h>
86 #include <sys/ktrace.h>
87 #include <sys/rnd.h>
88
89 #define MAXDESCLEN 1024
90 MALLOC_DEFINE(M_SYSCTLNODE, "sysctlnode", "sysctl node structures");
91 MALLOC_DEFINE(M_SYSCTLDATA, "sysctldata", "misc sysctl data");
92
93 static int sysctl_mmap(SYSCTLFN_PROTO);
94 static int sysctl_alloc(struct sysctlnode *, int);
95 static int sysctl_realloc(struct sysctlnode *);
96
97 static int sysctl_cvt_in(struct lwp *, int *, const void *, size_t,
98 struct sysctlnode *);
99 static int sysctl_cvt_out(struct lwp *, int, const struct sysctlnode *,
100 void *, size_t, size_t *);
101
102 static int sysctl_log_add(struct sysctllog **, const struct sysctlnode *);
103 static int sysctl_log_realloc(struct sysctllog *);
104
105 typedef void sysctl_setup_func(struct sysctllog **);
106
107 #ifdef SYSCTL_DEBUG
108 #define DPRINTF(a) printf a
109 #else
110 #define DPRINTF(a)
111 #endif
112
113 struct sysctllog {
114 const struct sysctlnode *log_root;
115 int *log_num;
116 int log_size, log_left;
117 };
118
119 /*
120 * the "root" of the new sysctl tree
121 */
122 struct sysctlnode sysctl_root = {
123 .sysctl_flags = SYSCTL_VERSION|
124 CTLFLAG_ROOT|CTLFLAG_READWRITE|
125 CTLTYPE_NODE,
126 .sysctl_num = 0,
127 /*
128 * XXX once all ports are on gcc3, we can get rid of this
129 * ugliness and simply make it into
130 *
131 * .sysctl_size = sizeof(struct sysctlnode),
132 */
133 sysc_init_field(_sysctl_size, sizeof(struct sysctlnode)),
134 .sysctl_name = "(root)",
135 };
136
137 /*
138 * link set of functions that add nodes at boot time (see also
139 * sysctl_buildtree())
140 */
141 __link_set_decl(sysctl_funcs, sysctl_setup_func);
142
143 /*
144 * The `sysctl_treelock' is intended to serialize access to the sysctl
145 * tree. XXX This has serious problems; allocating memory and
146 * copying data out with the lock held is insane.
147 */
148 krwlock_t sysctl_treelock;
149
150 kmutex_t sysctl_file_marker_lock;
151
152 /*
153 * Attributes stored in the kernel.
154 */
155 char hostname[MAXHOSTNAMELEN];
156 int hostnamelen;
157
158 char domainname[MAXHOSTNAMELEN];
159 int domainnamelen;
160
161 long hostid;
162
163 #ifndef DEFCORENAME
164 #define DEFCORENAME "%n.core"
165 #endif
166 char defcorename[MAXPATHLEN] = DEFCORENAME;
167
168 /*
169 * ********************************************************************
170 * Section 0: Some simple glue
171 * ********************************************************************
172 * By wrapping copyin(), copyout(), and copyinstr() like this, we can
173 * stop caring about who's calling us and simplify some code a bunch.
174 * ********************************************************************
175 */
176 int
177 sysctl_copyin(struct lwp *l, const void *uaddr, void *kaddr, size_t len)
178 {
179 int error;
180
181 if (l != NULL) {
182 error = copyin(uaddr, kaddr, len);
183 ktrmibio(-1, UIO_WRITE, uaddr, len, error);
184 } else {
185 error = kcopy(uaddr, kaddr, len);
186 }
187
188 return error;
189 }
190
191 int
192 sysctl_copyout(struct lwp *l, const void *kaddr, void *uaddr, size_t len)
193 {
194 int error;
195
196 if (l != NULL) {
197 error = copyout(kaddr, uaddr, len);
198 ktrmibio(-1, UIO_READ, uaddr, len, error);
199 } else {
200 error = kcopy(kaddr, uaddr, len);
201 }
202
203 return error;
204 }
205
206 int
207 sysctl_copyinstr(struct lwp *l, const void *uaddr, void *kaddr,
208 size_t len, size_t *done)
209 {
210 int error;
211
212 if (l != NULL) {
213 error = copyinstr(uaddr, kaddr, len, done);
214 ktrmibio(-1, UIO_WRITE, uaddr, len, error);
215 } else {
216 error = copystr(uaddr, kaddr, len, done);
217 }
218
219 return error;
220 }
221
222 /*
223 * ********************************************************************
224 * Initialize sysctl subsystem.
225 * ********************************************************************
226 */
227 void
228 sysctl_init(void)
229 {
230 sysctl_setup_func *const *sysctl_setup;
231
232 rw_init(&sysctl_treelock);
233
234 /*
235 * dynamic mib numbers start here
236 */
237 sysctl_root.sysctl_num = CREATE_BASE;
238 sysctl_basenode_init();
239
240 __link_set_foreach(sysctl_setup, sysctl_funcs) {
241 (**sysctl_setup)(NULL);
242 }
243
244 mutex_init(&sysctl_file_marker_lock, MUTEX_DEFAULT, IPL_NONE);
245 }
246
247 /*
248 * Setting this means no more permanent nodes can be added,
249 * trees that claim to be readonly at the root now are, and if
250 * the main tree is readonly, *everything* is.
251 *
252 * Also starts up the PRNG used for the "random" sysctl: it's
253 * better to start it later than sooner.
254 *
255 * Call this at the end of kernel init.
256 */
257 void
258 sysctl_finalize(void)
259 {
260
261 sysctl_root.sysctl_flags |= CTLFLAG_PERMANENT;
262 }
263
264 /*
265 * ********************************************************************
266 * The main native sysctl system call itself.
267 * ********************************************************************
268 */
269 int
270 sys___sysctl(struct lwp *l, const struct sys___sysctl_args *uap, register_t *retval)
271 {
272 /* {
273 syscallarg(const int *) name;
274 syscallarg(u_int) namelen;
275 syscallarg(void *) old;
276 syscallarg(size_t *) oldlenp;
277 syscallarg(const void *) new;
278 syscallarg(size_t) newlen;
279 } */
280 int error, nerror, name[CTL_MAXNAME];
281 size_t oldlen, savelen, *oldlenp;
282
283 /*
284 * get oldlen
285 */
286 oldlen = 0;
287 oldlenp = SCARG(uap, oldlenp);
288 if (oldlenp != NULL) {
289 error = copyin(oldlenp, &oldlen, sizeof(oldlen));
290 if (error)
291 return (error);
292 }
293 savelen = oldlen;
294
295 /*
296 * top-level sysctl names may or may not be non-terminal, but
297 * we don't care
298 */
299 if (SCARG(uap, namelen) > CTL_MAXNAME || SCARG(uap, namelen) < 1)
300 return (EINVAL);
301 error = copyin(SCARG(uap, name), &name,
302 SCARG(uap, namelen) * sizeof(int));
303 if (error)
304 return (error);
305
306 ktrmib(name, SCARG(uap, namelen));
307
308 sysctl_lock(SCARG(uap, new) != NULL);
309
310 /*
311 * do sysctl work (NULL means main built-in default tree)
312 */
313 error = sysctl_dispatch(&name[0], SCARG(uap, namelen),
314 SCARG(uap, old), &oldlen,
315 SCARG(uap, new), SCARG(uap, newlen),
316 &name[0], l, NULL);
317
318 /*
319 * release the sysctl lock
320 */
321 sysctl_unlock();
322
323 /*
324 * set caller's oldlen to new value even in the face of an
325 * error (if this gets an error and they didn't have one, they
326 * get this one)
327 */
328 if (oldlenp) {
329 nerror = copyout(&oldlen, oldlenp, sizeof(oldlen));
330 if (error == 0)
331 error = nerror;
332 }
333
334 /*
335 * if the only problem is that we weren't given enough space,
336 * that's an ENOMEM error
337 */
338 if (error == 0 && SCARG(uap, old) != NULL && savelen < oldlen)
339 error = ENOMEM;
340
341 return (error);
342 }
343
344 /*
345 * ********************************************************************
346 * Section 1: How the tree is used
347 * ********************************************************************
348 * Implementations of sysctl for emulations should typically need only
349 * these three functions in this order: lock the tree, dispatch
350 * request into it, unlock the tree.
351 * ********************************************************************
352 */
353 void
354 sysctl_lock(bool write)
355 {
356
357 if (write) {
358 rw_enter(&sysctl_treelock, RW_WRITER);
359 curlwp->l_pflag |= LP_SYSCTLWRITE;
360 } else {
361 rw_enter(&sysctl_treelock, RW_READER);
362 curlwp->l_pflag &= ~LP_SYSCTLWRITE;
363 }
364 }
365
366 void
367 sysctl_relock(void)
368 {
369
370 if ((curlwp->l_pflag & LP_SYSCTLWRITE) != 0) {
371 rw_enter(&sysctl_treelock, RW_WRITER);
372 } else {
373 rw_enter(&sysctl_treelock, RW_READER);
374 }
375 }
376
377 /*
378 * ********************************************************************
379 * the main sysctl dispatch routine. scans the given tree and picks a
380 * function to call based on what it finds.
381 * ********************************************************************
382 */
383 int
384 sysctl_dispatch(SYSCTLFN_ARGS)
385 {
386 int error;
387 sysctlfn fn;
388 int ni;
389
390 KASSERT(rw_lock_held(&sysctl_treelock));
391
392 if (rnode && SYSCTL_VERS(rnode->sysctl_flags) != SYSCTL_VERSION) {
393 printf("sysctl_dispatch: rnode %p wrong version\n", rnode);
394 error = EINVAL;
395 goto out;
396 }
397
398 fn = NULL;
399 error = sysctl_locate(l, name, namelen, &rnode, &ni);
400
401 if (rnode->sysctl_func != NULL) {
402 /*
403 * the node we ended up at has a function, so call it. it can
404 * hand off to query or create if it wants to.
405 */
406 fn = rnode->sysctl_func;
407 } else if (error == 0) {
408 /*
409 * we found the node they were looking for, so do a lookup.
410 */
411 fn = (sysctlfn)sysctl_lookup; /* XXX may write to rnode */
412 } else if (error == ENOENT && (ni + 1) == namelen && name[ni] < 0) {
413 /*
414 * prospective parent node found, but the terminal node was
415 * not. generic operations associate with the parent.
416 */
417 switch (name[ni]) {
418 case CTL_QUERY:
419 fn = sysctl_query;
420 break;
421 case CTL_CREATE:
422 #if NKSYMS > 0
423 case CTL_CREATESYM:
424 #endif /* NKSYMS > 0 */
425 if (newp == NULL) {
426 error = EINVAL;
427 break;
428 }
429 KASSERT(rw_write_held(&sysctl_treelock));
430 fn = (sysctlfn)sysctl_create; /* we own the rnode */
431 break;
432 case CTL_DESTROY:
433 if (newp == NULL) {
434 error = EINVAL;
435 break;
436 }
437 KASSERT(rw_write_held(&sysctl_treelock));
438 fn = (sysctlfn)sysctl_destroy; /* we own the rnode */
439 break;
440 case CTL_MMAP:
441 fn = (sysctlfn)sysctl_mmap; /* we own the rnode */
442 break;
443 case CTL_DESCRIBE:
444 fn = sysctl_describe;
445 break;
446 default:
447 error = EOPNOTSUPP;
448 break;
449 }
450 }
451
452 /*
453 * after all of that, maybe we found someone who knows how to
454 * get us what we want?
455 */
456 if (fn != NULL)
457 error = (*fn)(name + ni, namelen - ni, oldp, oldlenp,
458 newp, newlen, name, l, rnode);
459 else if (error == 0)
460 error = EOPNOTSUPP;
461
462 out:
463 return (error);
464 }
465
466 /*
467 * ********************************************************************
468 * Releases the tree lock.
469 * ********************************************************************
470 */
471 void
472 sysctl_unlock(void)
473 {
474
475 rw_exit(&sysctl_treelock);
476 }
477
478 /*
479 * ********************************************************************
480 * Section 2: The main tree interfaces
481 * ********************************************************************
482 * This is how sysctl_dispatch() does its work, and you can too, by
483 * calling these routines from helpers (though typically only
484 * sysctl_lookup() will be used). The tree MUST BE LOCKED when these
485 * are called.
486 * ********************************************************************
487 */
488
489 /*
490 * sysctl_locate -- Finds the node matching the given mib under the
491 * given tree (via rv). If no tree is given, we fall back to the
492 * native tree. The current process (via l) is used for access
493 * control on the tree (some nodes may be traversable only by root) and
494 * on return, nip will show how many numbers in the mib were consumed.
495 */
496 int
497 sysctl_locate(struct lwp *l, const int *name, u_int namelen,
498 const struct sysctlnode **rnode, int *nip)
499 {
500 const struct sysctlnode *node, *pnode;
501 int tn, si, ni, error, alias;
502
503 KASSERT(rw_lock_held(&sysctl_treelock));
504
505 /*
506 * basic checks and setup
507 */
508 if (*rnode == NULL)
509 *rnode = &sysctl_root;
510 if (nip)
511 *nip = 0;
512 if (namelen == 0)
513 return (0);
514
515 /*
516 * search starts from "root"
517 */
518 pnode = *rnode;
519 if (SYSCTL_VERS(pnode->sysctl_flags) != SYSCTL_VERSION) {
520 printf("sysctl_locate: pnode %p wrong version\n", pnode);
521 return (EINVAL);
522 }
523 node = pnode->sysctl_child;
524 error = 0;
525
526 /*
527 * scan for node to which new node should be attached
528 */
529 for (ni = 0; ni < namelen; ni++) {
530 /*
531 * walked off bottom of tree
532 */
533 if (node == NULL) {
534 if (SYSCTL_TYPE(pnode->sysctl_flags) == CTLTYPE_NODE)
535 error = ENOENT;
536 else
537 error = ENOTDIR;
538 break;
539 }
540 /*
541 * can anyone traverse this node or only root?
542 */
543 if (l != NULL && (pnode->sysctl_flags & CTLFLAG_PRIVATE) &&
544 (error = kauth_authorize_system(l->l_cred,
545 KAUTH_SYSTEM_SYSCTL, KAUTH_REQ_SYSTEM_SYSCTL_PRVT,
546 NULL, NULL, NULL)) != 0)
547 return (error);
548 /*
549 * find a child node with the right number
550 */
551 tn = name[ni];
552 alias = 0;
553
554 si = 0;
555 /*
556 * Note: ANYNUMBER only matches positive integers.
557 * Since ANYNUMBER is only permitted on single-node
558 * sub-trees (eg proc), check before the loop and skip
559 * it if we can.
560 */
561 if ((node[si].sysctl_flags & CTLFLAG_ANYNUMBER) && (tn >= 0))
562 goto foundit;
563 for (; si < pnode->sysctl_clen; si++) {
564 if (node[si].sysctl_num == tn) {
565 if (node[si].sysctl_flags & CTLFLAG_ALIAS) {
566 if (alias++ == 4)
567 break;
568 else {
569 tn = node[si].sysctl_alias;
570 si = -1;
571 }
572 } else
573 goto foundit;
574 }
575 }
576 /*
577 * if we ran off the end, it obviously doesn't exist
578 */
579 error = ENOENT;
580 break;
581
582 /*
583 * so far so good, move on down the line
584 */
585 foundit:
586 pnode = &node[si];
587 if (SYSCTL_TYPE(pnode->sysctl_flags) == CTLTYPE_NODE)
588 node = node[si].sysctl_child;
589 else
590 node = NULL;
591 }
592
593 *rnode = pnode;
594 if (nip)
595 *nip = ni;
596
597 return (error);
598 }
599
600 /*
601 * sysctl_query -- The auto-discovery engine. Copies out the structs
602 * describing nodes under the given node and handles overlay trees.
603 */
604 int
605 sysctl_query(SYSCTLFN_ARGS)
606 {
607 int error, ni, elim, v;
608 size_t out, left, t;
609 const struct sysctlnode *enode, *onode;
610 struct sysctlnode qnode;
611
612 KASSERT(rw_lock_held(&sysctl_treelock));
613
614 if (SYSCTL_VERS(rnode->sysctl_flags) != SYSCTL_VERSION) {
615 printf("sysctl_query: rnode %p wrong version\n", rnode);
616 return (EINVAL);
617 }
618
619 if (SYSCTL_TYPE(rnode->sysctl_flags) != CTLTYPE_NODE)
620 return (ENOTDIR);
621 if (namelen != 1 || name[0] != CTL_QUERY)
622 return (EINVAL);
623
624 error = 0;
625 out = 0;
626 left = *oldlenp;
627 elim = 0;
628 enode = NULL;
629
630 /*
631 * translate the given request to a current node
632 */
633 error = sysctl_cvt_in(l, &v, newp, newlen, &qnode);
634 if (error)
635 return (error);
636
637 /*
638 * if the request specifies a version, check it
639 */
640 if (qnode.sysctl_ver != 0) {
641 enode = rnode;
642 if (qnode.sysctl_ver != enode->sysctl_ver &&
643 qnode.sysctl_ver != sysctl_rootof(enode)->sysctl_ver)
644 return (EINVAL);
645 }
646
647 /*
648 * process has overlay tree
649 */
650 if (l && l->l_proc->p_emul->e_sysctlovly) {
651 enode = l->l_proc->p_emul->e_sysctlovly;
652 elim = (name - oname);
653 error = sysctl_locate(l, oname, elim, &enode, NULL);
654 if (error == 0) {
655 /* ah, found parent in overlay */
656 elim = enode->sysctl_clen;
657 enode = enode->sysctl_child;
658 } else {
659 error = 0;
660 elim = 0;
661 enode = NULL;
662 }
663 }
664
665 for (ni = 0; ni < rnode->sysctl_clen; ni++) {
666 onode = &rnode->sysctl_child[ni];
667 if (enode && enode->sysctl_num == onode->sysctl_num) {
668 if (SYSCTL_TYPE(enode->sysctl_flags) != CTLTYPE_NODE)
669 onode = enode;
670 if (--elim > 0)
671 enode++;
672 else
673 enode = NULL;
674 }
675 error = sysctl_cvt_out(l, v, onode, oldp, left, &t);
676 if (error)
677 return (error);
678 if (oldp != NULL)
679 oldp = (char*)oldp + t;
680 out += t;
681 left -= MIN(left, t);
682 }
683
684 /*
685 * overlay trees *MUST* be entirely consumed
686 */
687 KASSERT(enode == NULL);
688
689 *oldlenp = out;
690
691 return (error);
692 }
693
694 /*
695 * sysctl_create -- Adds a node (the description of which is taken
696 * from newp) to the tree, returning a copy of it in the space pointed
697 * to by oldp. In the event that the requested slot is already taken
698 * (either by name or by number), the offending node is returned
699 * instead. Yes, this is complex, but we want to make sure everything
700 * is proper.
701 */
702 #ifdef SYSCTL_DEBUG_CREATE
703 int _sysctl_create(SYSCTLFN_ARGS);
704 int
705 _sysctl_create(SYSCTLFN_ARGS)
706 #else
707 int
708 sysctl_create(SYSCTLFN_ARGS)
709 #endif
710 {
711 struct sysctlnode nnode, *node, *pnode;
712 int error, ni, at, nm, type, nsz, sz, flags, anum, v;
713 void *own;
714
715 KASSERT(rw_write_held(&sysctl_treelock));
716
717 error = 0;
718 own = NULL;
719 anum = -1;
720
721 if (SYSCTL_VERS(rnode->sysctl_flags) != SYSCTL_VERSION) {
722 printf("sysctl_create: rnode %p wrong version\n", rnode);
723 return (EINVAL);
724 }
725
726 if (namelen != 1 || (name[namelen - 1] != CTL_CREATE
727 #if NKSYMS > 0
728 && name[namelen - 1] != CTL_CREATESYM
729 #endif /* NKSYMS > 0 */
730 ))
731 return (EINVAL);
732
733 /*
734 * processes can only add nodes at securelevel 0, must be
735 * root, and can't add nodes to a parent that's not writeable
736 */
737 if (l != NULL) {
738 #ifndef SYSCTL_DISALLOW_CREATE
739 error = kauth_authorize_system(l->l_cred, KAUTH_SYSTEM_SYSCTL,
740 KAUTH_REQ_SYSTEM_SYSCTL_ADD, NULL, NULL, NULL);
741 if (error)
742 return (error);
743 if (!(rnode->sysctl_flags & CTLFLAG_READWRITE))
744 #endif /* SYSCTL_DISALLOW_CREATE */
745 return (EPERM);
746 }
747
748 /*
749 * nothing can add a node if:
750 * we've finished initial set up of this tree and
751 * (the tree itself is not writeable or
752 * the entire sysctl system is not writeable)
753 */
754 if ((sysctl_rootof(rnode)->sysctl_flags & CTLFLAG_PERMANENT) &&
755 (!(sysctl_rootof(rnode)->sysctl_flags & CTLFLAG_READWRITE) ||
756 !(sysctl_root.sysctl_flags & CTLFLAG_READWRITE)))
757 return (EPERM);
758
759 /*
760 * it must be a "node", not a "int" or something
761 */
762 if (SYSCTL_TYPE(rnode->sysctl_flags) != CTLTYPE_NODE)
763 return (ENOTDIR);
764 if (rnode->sysctl_flags & CTLFLAG_ALIAS) {
765 printf("sysctl_create: attempt to add node to aliased "
766 "node %p\n", rnode);
767 return (EINVAL);
768 }
769 pnode = __UNCONST(rnode); /* we are adding children to this node */
770
771 if (newp == NULL)
772 return (EINVAL);
773 error = sysctl_cvt_in(l, &v, newp, newlen, &nnode);
774 if (error)
775 return (error);
776
777 /*
778 * nodes passed in don't *have* parents
779 */
780 if (nnode.sysctl_parent != NULL)
781 return (EINVAL);
782
783 /*
784 * if we are indeed adding it, it should be a "good" name and
785 * number
786 */
787 nm = nnode.sysctl_num;
788 #if NKSYMS > 0
789 if (nm == CTL_CREATESYM)
790 nm = CTL_CREATE;
791 #endif /* NKSYMS > 0 */
792 if (nm < 0 && nm != CTL_CREATE)
793 return (EINVAL);
794
795 /*
796 * the name can't start with a digit
797 */
798 if (nnode.sysctl_name[0] >= '0' &&
799 nnode.sysctl_name[0] <= '9')
800 return (EINVAL);
801
802 /*
803 * the name must be only alphanumerics or - or _, longer than
804 * 0 bytes and less that SYSCTL_NAMELEN
805 */
806 nsz = 0;
807 while (nsz < SYSCTL_NAMELEN && nnode.sysctl_name[nsz] != '\0') {
808 if ((nnode.sysctl_name[nsz] >= '0' &&
809 nnode.sysctl_name[nsz] <= '9') ||
810 (nnode.sysctl_name[nsz] >= 'A' &&
811 nnode.sysctl_name[nsz] <= 'Z') ||
812 (nnode.sysctl_name[nsz] >= 'a' &&
813 nnode.sysctl_name[nsz] <= 'z') ||
814 nnode.sysctl_name[nsz] == '-' ||
815 nnode.sysctl_name[nsz] == '_')
816 nsz++;
817 else
818 return (EINVAL);
819 }
820 if (nsz == 0 || nsz == SYSCTL_NAMELEN)
821 return (EINVAL);
822
823 /*
824 * various checks revolve around size vs type, etc
825 */
826 type = SYSCTL_TYPE(nnode.sysctl_flags);
827 flags = SYSCTL_FLAGS(nnode.sysctl_flags);
828 sz = nnode.sysctl_size;
829
830 /*
831 * find out if there's a collision, and if so, let the caller
832 * know what they collided with
833 */
834 node = pnode->sysctl_child;
835 at = 0;
836 if (node) {
837 if ((flags | node->sysctl_flags) & CTLFLAG_ANYNUMBER)
838 /* No siblings for a CTLFLAG_ANYNUMBER node */
839 return EINVAL;
840 for (ni = 0; ni < pnode->sysctl_clen; ni++) {
841 if (nm == node[ni].sysctl_num ||
842 strcmp(nnode.sysctl_name, node[ni].sysctl_name) == 0) {
843 /*
844 * ignore error here, since we
845 * are already fixed on EEXIST
846 */
847 (void)sysctl_cvt_out(l, v, &node[ni], oldp,
848 *oldlenp, oldlenp);
849 return (EEXIST);
850 }
851 if (nm > node[ni].sysctl_num)
852 at++;
853 }
854 }
855
856 /*
857 * use sysctl_ver to add to the tree iff it hasn't changed
858 */
859 if (nnode.sysctl_ver != 0) {
860 /*
861 * a specified value must match either the parent
862 * node's version or the root node's version
863 */
864 if (nnode.sysctl_ver != sysctl_rootof(rnode)->sysctl_ver &&
865 nnode.sysctl_ver != rnode->sysctl_ver) {
866 return (EINVAL);
867 }
868 }
869
870 /*
871 * only the kernel can assign functions to entries
872 */
873 if (l != NULL && nnode.sysctl_func != NULL)
874 return (EPERM);
875
876 /*
877 * only the kernel can create permanent entries, and only then
878 * before the kernel is finished setting itself up
879 */
880 if (l != NULL && (flags & ~SYSCTL_USERFLAGS))
881 return (EPERM);
882 if ((flags & CTLFLAG_PERMANENT) &
883 (sysctl_root.sysctl_flags & CTLFLAG_PERMANENT))
884 return (EPERM);
885 if ((flags & (CTLFLAG_OWNDATA | CTLFLAG_IMMEDIATE)) ==
886 (CTLFLAG_OWNDATA | CTLFLAG_IMMEDIATE))
887 return (EINVAL);
888 if ((flags & CTLFLAG_IMMEDIATE) &&
889 type != CTLTYPE_INT && type != CTLTYPE_QUAD && type != CTLTYPE_BOOL)
890 return (EINVAL);
891
892 /*
893 * check size, or set it if unset and we can figure it out.
894 * kernel created nodes are allowed to have a function instead
895 * of a size (or a data pointer).
896 */
897 switch (type) {
898 case CTLTYPE_NODE:
899 /*
900 * only *i* can assert the size of a node
901 */
902 if (flags & CTLFLAG_ALIAS) {
903 anum = nnode.sysctl_alias;
904 if (anum < 0)
905 return (EINVAL);
906 nnode.sysctl_alias = 0;
907 }
908 if (sz != 0 || nnode.sysctl_data != NULL)
909 return (EINVAL);
910 if (nnode.sysctl_csize != 0 ||
911 nnode.sysctl_clen != 0 ||
912 nnode.sysctl_child != 0)
913 return (EINVAL);
914 if (flags & CTLFLAG_OWNDATA)
915 return (EINVAL);
916 sz = sizeof(struct sysctlnode);
917 break;
918 case CTLTYPE_INT:
919 /*
920 * since an int is an int, if the size is not given or
921 * is wrong, we can "int-uit" it.
922 */
923 if (sz != 0 && sz != sizeof(int))
924 return (EINVAL);
925 sz = sizeof(int);
926 break;
927 case CTLTYPE_STRING:
928 /*
929 * strings are a little more tricky
930 */
931 if (sz == 0) {
932 if (l == NULL) {
933 if (nnode.sysctl_func == NULL) {
934 if (nnode.sysctl_data == NULL)
935 return (EINVAL);
936 else
937 sz = strlen(nnode.sysctl_data) +
938 1;
939 }
940 } else if (nnode.sysctl_data == NULL &&
941 flags & CTLFLAG_OWNDATA) {
942 return (EINVAL);
943 } else {
944 char *vp, *e;
945 size_t s;
946
947 /*
948 * we want a rough idea of what the
949 * size is now
950 */
951 vp = malloc(PAGE_SIZE, M_SYSCTLDATA,
952 M_WAITOK|M_CANFAIL);
953 if (vp == NULL)
954 return (ENOMEM);
955 e = nnode.sysctl_data;
956 do {
957 error = copyinstr(e, vp, PAGE_SIZE, &s);
958 if (error) {
959 if (error != ENAMETOOLONG) {
960 free(vp, M_SYSCTLDATA);
961 return (error);
962 }
963 e += PAGE_SIZE;
964 if ((e - 32 * PAGE_SIZE) >
965 (char*)nnode.sysctl_data) {
966 free(vp, M_SYSCTLDATA);
967 return (ERANGE);
968 }
969 }
970 } while (error != 0);
971 sz = s + (e - (char*)nnode.sysctl_data);
972 free(vp, M_SYSCTLDATA);
973 }
974 }
975 break;
976 case CTLTYPE_QUAD:
977 if (sz != 0 && sz != sizeof(u_quad_t))
978 return (EINVAL);
979 sz = sizeof(u_quad_t);
980 break;
981 case CTLTYPE_BOOL:
982 /*
983 * since an bool is an bool, if the size is not given or
984 * is wrong, we can "intuit" it.
985 */
986 if (sz != 0 && sz != sizeof(bool))
987 return (EINVAL);
988 sz = sizeof(bool);
989 break;
990 case CTLTYPE_STRUCT:
991 if (sz == 0) {
992 if (l != NULL || nnode.sysctl_func == NULL)
993 return (EINVAL);
994 if (flags & CTLFLAG_OWNDATA)
995 return (EINVAL);
996 }
997 break;
998 default:
999 return (EINVAL);
1000 }
1001
1002 /*
1003 * at this point, if sz is zero, we *must* have a
1004 * function to go with it and we can't own it.
1005 */
1006
1007 /*
1008 * l ptr own
1009 * 0 0 0 -> EINVAL (if no func)
1010 * 0 0 1 -> own
1011 * 0 1 0 -> kptr
1012 * 0 1 1 -> kptr
1013 * 1 0 0 -> EINVAL
1014 * 1 0 1 -> own
1015 * 1 1 0 -> kptr, no own (fault on lookup)
1016 * 1 1 1 -> uptr, own
1017 */
1018 if (type != CTLTYPE_NODE) {
1019 if (sz != 0) {
1020 if (flags & CTLFLAG_OWNDATA) {
1021 own = malloc(sz, M_SYSCTLDATA,
1022 M_WAITOK|M_CANFAIL);
1023 if (own == NULL)
1024 return ENOMEM;
1025 if (nnode.sysctl_data == NULL)
1026 memset(own, 0, sz);
1027 else {
1028 error = sysctl_copyin(l,
1029 nnode.sysctl_data, own, sz);
1030 if (error != 0) {
1031 free(own, M_SYSCTLDATA);
1032 return (error);
1033 }
1034 }
1035 } else if ((nnode.sysctl_data != NULL) &&
1036 !(flags & CTLFLAG_IMMEDIATE)) {
1037 #if NKSYMS > 0
1038 if (name[namelen - 1] == CTL_CREATESYM) {
1039 char symname[128]; /* XXX enough? */
1040 u_long symaddr;
1041 size_t symlen;
1042
1043 error = sysctl_copyinstr(l,
1044 nnode.sysctl_data, symname,
1045 sizeof(symname), &symlen);
1046 if (error)
1047 return (error);
1048 error = ksyms_getval(NULL, symname,
1049 &symaddr, KSYMS_EXTERN);
1050 if (error)
1051 return (error); /* EINVAL? */
1052 nnode.sysctl_data = (void*)symaddr;
1053 }
1054 #endif /* NKSYMS > 0 */
1055 /*
1056 * Ideally, we'd like to verify here
1057 * that this address is acceptable,
1058 * but...
1059 *
1060 * - it might be valid now, only to
1061 * become invalid later
1062 *
1063 * - it might be invalid only for the
1064 * moment and valid later
1065 *
1066 * - or something else.
1067 *
1068 * Since we can't get a good answer,
1069 * we'll just accept the address as
1070 * given, and fault on individual
1071 * lookups.
1072 */
1073 }
1074 } else if (nnode.sysctl_func == NULL)
1075 return (EINVAL);
1076 }
1077
1078 /*
1079 * a process can't assign a function to a node, and the kernel
1080 * can't create a node that has no function or data.
1081 * (XXX somewhat redundant check)
1082 */
1083 if (l != NULL || nnode.sysctl_func == NULL) {
1084 if (type != CTLTYPE_NODE &&
1085 nnode.sysctl_data == NULL &&
1086 !(flags & CTLFLAG_IMMEDIATE) &&
1087 own == NULL)
1088 return (EINVAL);
1089 }
1090
1091 #ifdef SYSCTL_DISALLOW_KWRITE
1092 /*
1093 * a process can't create a writable node unless it refers to
1094 * new data.
1095 */
1096 if (l != NULL && own == NULL && type != CTLTYPE_NODE &&
1097 (flags & CTLFLAG_READWRITE) != CTLFLAG_READONLY &&
1098 !(flags & CTLFLAG_IMMEDIATE))
1099 return (EPERM);
1100 #endif /* SYSCTL_DISALLOW_KWRITE */
1101
1102 /*
1103 * make sure there's somewhere to put the new stuff.
1104 */
1105 if (pnode->sysctl_child == NULL) {
1106 if (flags & CTLFLAG_ANYNUMBER)
1107 error = sysctl_alloc(pnode, 1);
1108 else
1109 error = sysctl_alloc(pnode, 0);
1110 if (error) {
1111 if (own != NULL)
1112 free(own, M_SYSCTLDATA);
1113 return (error);
1114 }
1115 }
1116 node = pnode->sysctl_child;
1117
1118 /*
1119 * no collisions, so pick a good dynamic number if we need to.
1120 */
1121 if (nm == CTL_CREATE) {
1122 nm = ++sysctl_root.sysctl_num;
1123 for (ni = 0; ni < pnode->sysctl_clen; ni++) {
1124 if (nm == node[ni].sysctl_num) {
1125 nm++;
1126 ni = -1;
1127 } else if (nm > node[ni].sysctl_num)
1128 at = ni + 1;
1129 }
1130 }
1131
1132 /*
1133 * oops...ran out of space
1134 */
1135 if (pnode->sysctl_clen == pnode->sysctl_csize) {
1136 error = sysctl_realloc(pnode);
1137 if (error) {
1138 if (own != NULL)
1139 free(own, M_SYSCTLDATA);
1140 return (error);
1141 }
1142 node = pnode->sysctl_child;
1143 }
1144
1145 /*
1146 * insert new node data
1147 */
1148 if (at < pnode->sysctl_clen) {
1149 int t;
1150
1151 /*
1152 * move the nodes that should come after the new one
1153 */
1154 memmove(&node[at + 1], &node[at],
1155 (pnode->sysctl_clen - at) * sizeof(struct sysctlnode));
1156 memset(&node[at], 0, sizeof(struct sysctlnode));
1157 node[at].sysctl_parent = pnode;
1158 /*
1159 * and...reparent any children of any moved nodes
1160 */
1161 for (ni = at; ni <= pnode->sysctl_clen; ni++)
1162 if (node[ni].sysctl_child != NULL)
1163 for (t = 0; t < node[ni].sysctl_csize; t++)
1164 node[ni].sysctl_child[t].sysctl_parent =
1165 &node[ni];
1166 }
1167 node = &node[at];
1168 pnode->sysctl_clen++;
1169
1170 strlcpy(node->sysctl_name, nnode.sysctl_name,
1171 sizeof(node->sysctl_name));
1172 node->sysctl_num = nm;
1173 node->sysctl_size = sz;
1174 node->sysctl_flags = SYSCTL_VERSION|type|flags; /* XXX other trees */
1175 node->sysctl_csize = 0;
1176 node->sysctl_clen = 0;
1177 if (own) {
1178 node->sysctl_data = own;
1179 node->sysctl_flags |= CTLFLAG_OWNDATA;
1180 } else if (flags & CTLFLAG_ALIAS) {
1181 node->sysctl_alias = anum;
1182 } else if (flags & CTLFLAG_IMMEDIATE) {
1183 switch (type) {
1184 case CTLTYPE_BOOL:
1185 node->sysctl_bdata = nnode.sysctl_bdata;
1186 break;
1187 case CTLTYPE_INT:
1188 node->sysctl_idata = nnode.sysctl_idata;
1189 break;
1190 case CTLTYPE_QUAD:
1191 node->sysctl_qdata = nnode.sysctl_qdata;
1192 break;
1193 }
1194 } else {
1195 node->sysctl_data = nnode.sysctl_data;
1196 node->sysctl_flags &= ~CTLFLAG_OWNDATA;
1197 }
1198 node->sysctl_func = nnode.sysctl_func;
1199 node->sysctl_child = NULL;
1200 /* node->sysctl_parent should already be done */
1201
1202 /*
1203 * update "version" on path to "root"
1204 */
1205 for (; rnode->sysctl_parent != NULL; rnode = rnode->sysctl_parent)
1206 ;
1207 pnode = node;
1208 for (nm = rnode->sysctl_ver + 1; pnode != NULL;
1209 pnode = pnode->sysctl_parent)
1210 pnode->sysctl_ver = nm;
1211
1212 /* If this fails, the node is already added - the user won't know! */
1213 error = sysctl_cvt_out(l, v, node, oldp, *oldlenp, oldlenp);
1214
1215 return (error);
1216 }
1217
1218 /*
1219 * ********************************************************************
1220 * A wrapper around sysctl_create() that prints the thing we're trying
1221 * to add.
1222 * ********************************************************************
1223 */
1224 #ifdef SYSCTL_DEBUG_CREATE
1225 int
1226 sysctl_create(SYSCTLFN_ARGS)
1227 {
1228 const struct sysctlnode *node;
1229 int k, rc, ni, nl = namelen + (name - oname);
1230
1231 node = newp;
1232
1233 printf("namelen %d (", nl);
1234 for (ni = 0; ni < nl - 1; ni++)
1235 printf(" %d", oname[ni]);
1236 printf(" %d )\t[%s]\tflags %08x (%08x %d %zu)\n",
1237 k = node->sysctl_num,
1238 node->sysctl_name,
1239 node->sysctl_flags,
1240 SYSCTL_FLAGS(node->sysctl_flags),
1241 SYSCTL_TYPE(node->sysctl_flags),
1242 node->sysctl_size);
1243
1244 node = rnode;
1245 rc = _sysctl_create(SYSCTLFN_CALL(rnode));
1246
1247 printf("sysctl_create(");
1248 for (ni = 0; ni < nl - 1; ni++)
1249 printf(" %d", oname[ni]);
1250 printf(" %d ) returned %d\n", k, rc);
1251
1252 return (rc);
1253 }
1254 #endif /* SYSCTL_DEBUG_CREATE */
1255
1256 /*
1257 * sysctl_destroy -- Removes a node (as described by newp) from the
1258 * given tree, returning (if successful) a copy of the dead node in
1259 * oldp. Since we're removing stuff, there's not much to check.
1260 */
1261 int
1262 sysctl_destroy(SYSCTLFN_ARGS)
1263 {
1264 struct sysctlnode *node, *pnode, onode, nnode;
1265 int ni, error, v;
1266
1267 KASSERT(rw_write_held(&sysctl_treelock));
1268
1269 if (SYSCTL_VERS(rnode->sysctl_flags) != SYSCTL_VERSION) {
1270 printf("sysctl_destroy: rnode %p wrong version\n", rnode);
1271 return (EINVAL);
1272 }
1273
1274 error = 0;
1275
1276 if (namelen != 1 || name[namelen - 1] != CTL_DESTROY)
1277 return (EINVAL);
1278
1279 /*
1280 * processes can only destroy nodes at securelevel 0, must be
1281 * root, and can't remove nodes from a parent that's not
1282 * writeable
1283 */
1284 if (l != NULL) {
1285 #ifndef SYSCTL_DISALLOW_CREATE
1286 error = kauth_authorize_system(l->l_cred, KAUTH_SYSTEM_SYSCTL,
1287 KAUTH_REQ_SYSTEM_SYSCTL_DELETE, NULL, NULL, NULL);
1288 if (error)
1289 return (error);
1290 if (!(rnode->sysctl_flags & CTLFLAG_READWRITE))
1291 #endif /* SYSCTL_DISALLOW_CREATE */
1292 return (EPERM);
1293 }
1294
1295 /*
1296 * nothing can remove a node if:
1297 * the node is permanent (checked later) or
1298 * the tree itself is not writeable or
1299 * the entire sysctl system is not writeable
1300 *
1301 * note that we ignore whether setup is complete or not,
1302 * because these rules always apply.
1303 */
1304 if (!(sysctl_rootof(rnode)->sysctl_flags & CTLFLAG_READWRITE) ||
1305 !(sysctl_root.sysctl_flags & CTLFLAG_READWRITE))
1306 return (EPERM);
1307
1308 if (newp == NULL)
1309 return (EINVAL);
1310 error = sysctl_cvt_in(l, &v, newp, newlen, &nnode);
1311 if (error)
1312 return (error);
1313 memset(&onode, 0, sizeof(struct sysctlnode));
1314
1315 node = rnode->sysctl_child;
1316 for (ni = 0; ni < rnode->sysctl_clen; ni++) {
1317 if (nnode.sysctl_num == node[ni].sysctl_num) {
1318 /*
1319 * if name specified, must match
1320 */
1321 if (nnode.sysctl_name[0] != '\0' &&
1322 strcmp(nnode.sysctl_name, node[ni].sysctl_name))
1323 continue;
1324 /*
1325 * if version specified, must match
1326 */
1327 if (nnode.sysctl_ver != 0 &&
1328 nnode.sysctl_ver != node[ni].sysctl_ver)
1329 continue;
1330 /*
1331 * this must be the one
1332 */
1333 break;
1334 }
1335 }
1336 if (ni == rnode->sysctl_clen)
1337 return (ENOENT);
1338 node = &node[ni];
1339 pnode = node->sysctl_parent;
1340
1341 /*
1342 * if the kernel says permanent, it is, so there. nyah.
1343 */
1344 if (SYSCTL_FLAGS(node->sysctl_flags) & CTLFLAG_PERMANENT)
1345 return (EPERM);
1346
1347 /*
1348 * can't delete non-empty nodes
1349 */
1350 if (SYSCTL_TYPE(node->sysctl_flags) == CTLTYPE_NODE &&
1351 node->sysctl_clen != 0)
1352 return (ENOTEMPTY);
1353
1354 /*
1355 * if the node "owns" data, release it now
1356 */
1357 if (node->sysctl_flags & CTLFLAG_OWNDATA) {
1358 if (node->sysctl_data != NULL)
1359 free(node->sysctl_data, M_SYSCTLDATA);
1360 node->sysctl_data = NULL;
1361 }
1362 if (node->sysctl_flags & CTLFLAG_OWNDESC) {
1363 if (node->sysctl_desc != NULL)
1364 /*XXXUNCONST*/
1365 free(__UNCONST(node->sysctl_desc), M_SYSCTLDATA);
1366 node->sysctl_desc = NULL;
1367 }
1368
1369 /*
1370 * if the node to be removed is not the last one on the list,
1371 * move the remaining nodes up, and reparent any grandchildren
1372 */
1373 onode = *node;
1374 if (ni < pnode->sysctl_clen - 1) {
1375 int t;
1376
1377 memmove(&pnode->sysctl_child[ni], &pnode->sysctl_child[ni + 1],
1378 (pnode->sysctl_clen - ni - 1) *
1379 sizeof(struct sysctlnode));
1380 for (; ni < pnode->sysctl_clen - 1; ni++)
1381 if (SYSCTL_TYPE(pnode->sysctl_child[ni].sysctl_flags) ==
1382 CTLTYPE_NODE)
1383 for (t = 0;
1384 t < pnode->sysctl_child[ni].sysctl_clen;
1385 t++)
1386 pnode->sysctl_child[ni].sysctl_child[t].
1387 sysctl_parent =
1388 &pnode->sysctl_child[ni];
1389 ni = pnode->sysctl_clen - 1;
1390 node = &pnode->sysctl_child[ni];
1391 }
1392
1393 /*
1394 * reset the space we just vacated
1395 */
1396 memset(node, 0, sizeof(struct sysctlnode));
1397 node->sysctl_parent = pnode;
1398 pnode->sysctl_clen--;
1399
1400 /*
1401 * if this parent just lost its last child, nuke the creche
1402 */
1403 if (pnode->sysctl_clen == 0) {
1404 free(pnode->sysctl_child, M_SYSCTLNODE);
1405 pnode->sysctl_csize = 0;
1406 pnode->sysctl_child = NULL;
1407 }
1408
1409 /*
1410 * update "version" on path to "root"
1411 */
1412 for (; rnode->sysctl_parent != NULL; rnode = rnode->sysctl_parent)
1413 ;
1414 for (ni = rnode->sysctl_ver + 1; pnode != NULL;
1415 pnode = pnode->sysctl_parent)
1416 pnode->sysctl_ver = ni;
1417
1418 error = sysctl_cvt_out(l, v, &onode, oldp, *oldlenp, oldlenp);
1419
1420 return (error);
1421 }
1422
1423 /*
1424 * sysctl_lookup -- Handles copyin/copyout of new and old values.
1425 * Partial reads are globally allowed. Only root can write to things
1426 * unless the node says otherwise.
1427 */
1428 int
1429 sysctl_lookup(SYSCTLFN_ARGS)
1430 {
1431 int error, rw;
1432 size_t sz, len;
1433 void *d, *d_out;
1434 uint64_t qval;
1435 int ival;
1436
1437 KASSERT(rw_lock_held(&sysctl_treelock));
1438
1439 if (SYSCTL_VERS(rnode->sysctl_flags) != SYSCTL_VERSION) {
1440 printf("%s: rnode %p wrong version\n", __func__, rnode);
1441 return EINVAL;
1442 }
1443
1444 if (newlen == 0)
1445 newp = NULL;
1446
1447 error = 0;
1448
1449 /*
1450 * you can't "look up" a node. you can "query" it, but you
1451 * can't "look it up".
1452 */
1453 if (SYSCTL_TYPE(rnode->sysctl_flags) == CTLTYPE_NODE || namelen != 0) {
1454 DPRINTF(("%s: can't lookup a node\n", __func__));
1455 return EINVAL;
1456 }
1457
1458 /*
1459 * some nodes are private, so only root can look into them.
1460 */
1461 if (l != NULL && (rnode->sysctl_flags & CTLFLAG_PRIVATE) &&
1462 (error = kauth_authorize_system(l->l_cred, KAUTH_SYSTEM_SYSCTL,
1463 KAUTH_REQ_SYSTEM_SYSCTL_PRVT, NULL, NULL, NULL)) != 0) {
1464 DPRINTF(("%s: private node\n", __func__));
1465 return error;
1466 }
1467
1468 /*
1469 * if a node wants to be writable according to different rules
1470 * other than "only root can write to stuff unless a flag is
1471 * set", then it needs its own function which should have been
1472 * called and not us.
1473 */
1474 if (l != NULL && newp != NULL &&
1475 !(rnode->sysctl_flags & CTLFLAG_ANYWRITE) &&
1476 (error = kauth_authorize_system(l->l_cred,
1477 KAUTH_SYSTEM_SYSCTL, KAUTH_REQ_SYSTEM_SYSCTL_MODIFY, NULL, NULL,
1478 NULL)) != 0) {
1479 DPRINTF(("%s: can't modify\n", __func__));
1480 return error;
1481 }
1482
1483 /*
1484 * is this node supposedly writable?
1485 */
1486 rw = (rnode->sysctl_flags & CTLFLAG_READWRITE) ? 1 : 0;
1487
1488 /*
1489 * it appears not to be writable at this time, so if someone
1490 * tried to write to it, we must tell them to go away
1491 */
1492 if (!rw && newp != NULL) {
1493 DPRINTF(("%s: not writable\n", __func__));
1494 return EPERM;
1495 }
1496
1497 /*
1498 * step one, copy out the stuff we have presently
1499 */
1500 if (rnode->sysctl_flags & CTLFLAG_IMMEDIATE) {
1501 /*
1502 * note that we discard const here because we are
1503 * modifying the contents of the node (which is okay
1504 * because it's ours)
1505 *
1506 * It also doesn't matter which field of the union we pick.
1507 */
1508 d = __UNCONST(&rnode->sysctl_qdata);
1509 } else
1510 d = rnode->sysctl_data;
1511 d_out = d;
1512
1513 sz = rnode->sysctl_size;
1514 switch (SYSCTL_TYPE(rnode->sysctl_flags)) {
1515 case CTLTYPE_INT:
1516 /* Allow for 64bit read of 32bit value */
1517 if (*oldlenp != sz && *oldlenp == sizeof (uint64_t)) {
1518 qval = *(int *)d;
1519 d_out = &qval;
1520 sz = sizeof (uint64_t);
1521 }
1522 break;
1523 case CTLTYPE_QUAD:
1524 /* Allow for 32bit read of 64bit value */
1525 if (*oldlenp != sz && *oldlenp == sizeof (int)) {
1526 qval = *(uint64_t *)d;
1527 ival = qval;
1528 /* Replace out of range values with -1 */
1529 if (ival != qval)
1530 ival = -1;
1531 d_out = &ival;
1532 sz = sizeof (int);
1533 }
1534 break;
1535 case CTLTYPE_STRING:
1536 sz = strlen(d) + 1; /* XXX@@@ possible fault here */
1537 break;
1538 default:
1539 break;
1540 }
1541 if (oldp != NULL) {
1542 error = sysctl_copyout(l, d_out, oldp, MIN(sz, *oldlenp));
1543 if (error) {
1544 DPRINTF(("%s: bad copyout %d\n", __func__, error));
1545 return error;
1546 }
1547 }
1548 *oldlenp = sz;
1549
1550 /*
1551 * are we done?
1552 */
1553 if (newp == NULL)
1554 return 0;
1555
1556 /*
1557 * hmm...not done. must now "copy in" new value. re-adjust
1558 * sz to maximum value (strings are "weird").
1559 */
1560 sz = rnode->sysctl_size;
1561 switch (SYSCTL_TYPE(rnode->sysctl_flags)) {
1562 case CTLTYPE_BOOL: {
1563 bool tmp;
1564 /*
1565 * these data must be *exactly* the same size coming
1566 * in. bool may only be true or false.
1567 */
1568 if (newlen != sz) {
1569 DPRINTF(("%s: bad size %zu != %zu\n", __func__, newlen,
1570 sz));
1571 return EINVAL;
1572 }
1573 error = sysctl_copyin(l, newp, &tmp, sz);
1574 if (error)
1575 break;
1576 if (tmp != true && tmp != false) {
1577 DPRINTF(("%s: tmp %d\n", __func__, tmp));
1578 return EINVAL;
1579 }
1580 *(bool *)d = tmp;
1581 break;
1582 }
1583 case CTLTYPE_INT:
1584 case CTLTYPE_QUAD:
1585 /* Allow 32bit of 64bit integers */
1586 if (newlen == sizeof (uint64_t)) {
1587 error = sysctl_copyin(l, newp, &qval, sizeof qval);
1588 } else if (newlen == sizeof (int)) {
1589 error = sysctl_copyin(l, newp, &ival, sizeof ival);
1590 qval = ival;
1591 } else {
1592 goto bad_size;
1593 }
1594 if (!error) {
1595 if (SYSCTL_TYPE(rnode->sysctl_flags) == CTLTYPE_INT) {
1596 ival = qval;
1597 /* Error out of range values */
1598 if (ival != qval)
1599 goto bad_size;
1600 *(int *)d = ival;
1601 } else {
1602 *(uint64_t *)d = qval;
1603 }
1604 }
1605 break;
1606 case CTLTYPE_STRUCT:
1607 /*
1608 * these data must be *exactly* the same size coming
1609 * in.
1610 */
1611 if (newlen != sz)
1612 goto bad_size;
1613 error = sysctl_copyin(l, newp, d, sz);
1614 rnd_add_data(NULL, d, sz, 0);
1615 break;
1616 case CTLTYPE_STRING: {
1617 /*
1618 * strings, on the other hand, can be shorter, and we
1619 * let userland be sloppy about the trailing nul.
1620 */
1621 char *newbuf;
1622
1623 /*
1624 * too much new string?
1625 */
1626 if (newlen > sz)
1627 goto bad_size;
1628
1629 /*
1630 * temporary copy of new inbound string
1631 */
1632 len = MIN(sz, newlen);
1633 newbuf = malloc(len, M_SYSCTLDATA, M_WAITOK|M_CANFAIL);
1634 if (newbuf == NULL) {
1635 DPRINTF(("%s: oomem %zu\n", __func__, len));
1636 return ENOMEM;
1637 }
1638 error = sysctl_copyin(l, newp, newbuf, len);
1639 if (error) {
1640 free(newbuf, M_SYSCTLDATA);
1641 DPRINTF(("%s: copyin %d\n", __func__, error));
1642 return error;
1643 }
1644
1645 /*
1646 * did they NUL terminate it, or do we have space
1647 * left to do it ourselves?
1648 */
1649 if (newbuf[len - 1] != '\0' && len == sz) {
1650 free(newbuf, M_SYSCTLDATA);
1651 DPRINTF(("%s: string too long\n", __func__));
1652 return EINVAL;
1653 }
1654
1655 /*
1656 * looks good, so pop it into place and zero the rest.
1657 */
1658 if (len > 0) {
1659 memcpy(d, newbuf, len);
1660 rnd_add_data(NULL, d, len, 0);
1661 }
1662 if (sz != len)
1663 memset((char*)d + len, 0, sz - len);
1664 free(newbuf, M_SYSCTLDATA);
1665 break;
1666 }
1667 default:
1668 DPRINTF(("%s: bad type\n", __func__));
1669 return EINVAL;
1670 }
1671 if (error) {
1672 DPRINTF(("%s: copyin %d\n", __func__, error));
1673 }
1674
1675 return error;
1676
1677 bad_size:
1678 DPRINTF(("%s: bad size %zu > %zu\n", __func__, newlen, sz));
1679 return EINVAL;
1680 }
1681
1682 /*
1683 * sysctl_mmap -- Dispatches sysctl mmap requests to those nodes that
1684 * purport to handle it. This interface isn't fully fleshed out yet,
1685 * unfortunately.
1686 */
1687 static int
1688 sysctl_mmap(SYSCTLFN_ARGS)
1689 {
1690 const struct sysctlnode *node;
1691 struct sysctlnode nnode;
1692 int error;
1693
1694 if (SYSCTL_VERS(rnode->sysctl_flags) != SYSCTL_VERSION) {
1695 printf("sysctl_mmap: rnode %p wrong version\n", rnode);
1696 return (EINVAL);
1697 }
1698
1699 /*
1700 * let's just pretend that didn't happen, m'kay?
1701 */
1702 if (l == NULL)
1703 return (EPERM);
1704
1705 /*
1706 * is this a sysctlnode description of an mmap request?
1707 */
1708 if (newp == NULL || newlen != sizeof(struct sysctlnode))
1709 return (EINVAL);
1710 error = sysctl_copyin(l, newp, &nnode, sizeof(nnode));
1711 if (error)
1712 return (error);
1713
1714 /*
1715 * does the node they asked for exist?
1716 */
1717 if (namelen != 1)
1718 return (EOPNOTSUPP);
1719 node = rnode;
1720 error = sysctl_locate(l, &nnode.sysctl_num, 1, &node, NULL);
1721 if (error)
1722 return (error);
1723
1724 /*
1725 * does this node that we have found purport to handle mmap?
1726 */
1727 if (node->sysctl_func == NULL ||
1728 !(node->sysctl_flags & CTLFLAG_MMAP))
1729 return (EOPNOTSUPP);
1730
1731 /*
1732 * well...okay, they asked for it.
1733 */
1734 return ((*node->sysctl_func)(SYSCTLFN_CALL(node)));
1735 }
1736
1737 int
1738 sysctl_describe(SYSCTLFN_ARGS)
1739 {
1740 struct sysctldesc *d;
1741 void *bf;
1742 size_t sz, left, tot;
1743 int i, error, v = -1;
1744 struct sysctlnode *node;
1745 struct sysctlnode dnode;
1746
1747 if (SYSCTL_VERS(rnode->sysctl_flags) != SYSCTL_VERSION) {
1748 printf("sysctl_query: rnode %p wrong version\n", rnode);
1749 return (EINVAL);
1750 }
1751
1752 if (SYSCTL_TYPE(rnode->sysctl_flags) != CTLTYPE_NODE)
1753 return (ENOTDIR);
1754 if (namelen != 1 || name[0] != CTL_DESCRIBE)
1755 return (EINVAL);
1756
1757 /*
1758 * get ready...
1759 */
1760 error = 0;
1761 d = bf = malloc(MAXDESCLEN, M_TEMP, M_WAITOK|M_CANFAIL);
1762 if (bf == NULL)
1763 return ENOMEM;
1764 tot = 0;
1765 node = rnode->sysctl_child;
1766 left = *oldlenp;
1767
1768 /*
1769 * no request -> all descriptions at this level
1770 * request with desc unset -> just this node
1771 * request with desc set -> set descr for this node
1772 */
1773 if (newp != NULL) {
1774 error = sysctl_cvt_in(l, &v, newp, newlen, &dnode);
1775 if (error)
1776 goto out;
1777 if (dnode.sysctl_desc != NULL) {
1778 /*
1779 * processes cannot set descriptions above
1780 * securelevel 0. and must be root. blah
1781 * blah blah. a couple more checks are made
1782 * once we find the node we want.
1783 */
1784 if (l != NULL) {
1785 #ifndef SYSCTL_DISALLOW_CREATE
1786 error = kauth_authorize_system(l->l_cred,
1787 KAUTH_SYSTEM_SYSCTL,
1788 KAUTH_REQ_SYSTEM_SYSCTL_DESC, NULL,
1789 NULL, NULL);
1790 if (error)
1791 goto out;
1792 #else /* SYSCTL_DISALLOW_CREATE */
1793 error = EPERM;
1794 goto out;
1795 #endif /* SYSCTL_DISALLOW_CREATE */
1796 }
1797
1798 /*
1799 * find node and try to set the description on it
1800 */
1801 for (i = 0; i < rnode->sysctl_clen; i++)
1802 if (node[i].sysctl_num == dnode.sysctl_num)
1803 break;
1804 if (i == rnode->sysctl_clen) {
1805 error = ENOENT;
1806 goto out;
1807 }
1808 node = &node[i];
1809
1810 /*
1811 * did the caller specify a node version?
1812 */
1813 if (dnode.sysctl_ver != 0 &&
1814 dnode.sysctl_ver != node->sysctl_ver) {
1815 error = EINVAL;
1816 goto out;
1817 }
1818
1819 /*
1820 * okay...some rules:
1821 * (1) if setup is done and the tree is
1822 * read-only or the whole system is
1823 * read-only
1824 * (2) no one can set a description on a
1825 * permanent node (it must be set when
1826 * using createv)
1827 * (3) processes cannot *change* a description
1828 * (4) processes *can*, however, set a
1829 * description on a read-only node so that
1830 * one can be created and then described
1831 * in two steps
1832 * anything else come to mind?
1833 */
1834 if ((sysctl_root.sysctl_flags & CTLFLAG_PERMANENT) &&
1835 (!(sysctl_rootof(node)->sysctl_flags &
1836 CTLFLAG_READWRITE) ||
1837 !(sysctl_root.sysctl_flags & CTLFLAG_READWRITE))) {
1838 error = EPERM;
1839 goto out;
1840 }
1841 if (node->sysctl_flags & CTLFLAG_PERMANENT) {
1842 error = EPERM;
1843 goto out;
1844 }
1845 if (l != NULL && node->sysctl_desc != NULL) {
1846 error = EPERM;
1847 goto out;
1848 }
1849
1850 /*
1851 * right, let's go ahead. the first step is
1852 * making the description into something the
1853 * node can "own", if need be.
1854 */
1855 if (l != NULL ||
1856 dnode.sysctl_flags & CTLFLAG_OWNDESC) {
1857 char *nd, *k;
1858
1859 k = malloc(MAXDESCLEN, M_TEMP,
1860 M_WAITOK|M_CANFAIL);
1861 if (k == NULL) {
1862 error = ENOMEM;
1863 goto out;
1864 }
1865 error = sysctl_copyinstr(l, dnode.sysctl_desc,
1866 k, MAXDESCLEN, &sz);
1867 if (error) {
1868 free(k, M_TEMP);
1869 goto out;
1870 }
1871 nd = malloc(sz, M_SYSCTLDATA,
1872 M_WAITOK|M_CANFAIL);
1873 if (nd == NULL) {
1874 free(k, M_TEMP);
1875 error = ENOMEM;
1876 goto out;
1877 }
1878 memcpy(nd, k, sz);
1879 dnode.sysctl_flags |= CTLFLAG_OWNDESC;
1880 dnode.sysctl_desc = nd;
1881 free(k, M_TEMP);
1882 }
1883
1884 /*
1885 * now "release" the old description and
1886 * attach the new one. ta-da.
1887 */
1888 if ((node->sysctl_flags & CTLFLAG_OWNDESC) &&
1889 node->sysctl_desc != NULL)
1890 /*XXXUNCONST*/
1891 free(__UNCONST(node->sysctl_desc), M_SYSCTLDATA);
1892 node->sysctl_desc = dnode.sysctl_desc;
1893 node->sysctl_flags |=
1894 (dnode.sysctl_flags & CTLFLAG_OWNDESC);
1895
1896 /*
1897 * now we "fall out" and into the loop which
1898 * will copy the new description back out for
1899 * those interested parties
1900 */
1901 }
1902 }
1903
1904 /*
1905 * scan for one description or just retrieve all descriptions
1906 */
1907 for (i = 0; i < rnode->sysctl_clen; i++) {
1908 /*
1909 * did they ask for the description of only one node?
1910 */
1911 if (v != -1 && node[i].sysctl_num != dnode.sysctl_num)
1912 continue;
1913
1914 /*
1915 * don't describe "private" nodes to non-suser users
1916 */
1917 if ((node[i].sysctl_flags & CTLFLAG_PRIVATE) && (l != NULL) &&
1918 !(kauth_authorize_system(l->l_cred, KAUTH_SYSTEM_SYSCTL,
1919 KAUTH_REQ_SYSTEM_SYSCTL_PRVT, NULL, NULL, NULL)))
1920 continue;
1921
1922 /*
1923 * is this description "valid"?
1924 */
1925 memset(bf, 0, MAXDESCLEN);
1926 if (node[i].sysctl_desc == NULL)
1927 sz = 1;
1928 else if (copystr(node[i].sysctl_desc, &d->descr_str[0],
1929 MAXDESCLEN - sizeof(*d), &sz) != 0) {
1930 /*
1931 * erase possible partial description
1932 */
1933 memset(bf, 0, MAXDESCLEN);
1934 sz = 1;
1935 }
1936
1937 /*
1938 * we've got it, stuff it into the caller's buffer
1939 */
1940 d->descr_num = node[i].sysctl_num;
1941 d->descr_ver = node[i].sysctl_ver;
1942 d->descr_len = sz; /* includes trailing nul */
1943 sz = (char *)NEXT_DESCR(d) - (char *)d;
1944 if (oldp != NULL && left >= sz) {
1945 error = sysctl_copyout(l, d, oldp, sz);
1946 if (error)
1947 goto out;
1948 left -= sz;
1949 oldp = (void *)__sysc_desc_adv(oldp, d->descr_len);
1950 }
1951 tot += sz;
1952
1953 /*
1954 * if we get this far with v not "unset", they asked
1955 * for a specific node and we found it
1956 */
1957 if (v != -1)
1958 break;
1959 }
1960
1961 /*
1962 * did we find it after all?
1963 */
1964 if (v != -1 && tot == 0)
1965 error = ENOENT;
1966 else
1967 *oldlenp = tot;
1968
1969 out:
1970 free(bf, M_TEMP);
1971 return (error);
1972 }
1973
1974 /*
1975 * ********************************************************************
1976 * Section 3: Create and destroy from inside the kernel
1977 * ********************************************************************
1978 * sysctl_createv() and sysctl_destroyv() are simpler-to-use
1979 * interfaces for the kernel to fling new entries into the mib and rip
1980 * them out later. In the case of sysctl_createv(), the returned copy
1981 * of the node (see sysctl_create()) will be translated back into a
1982 * pointer to the actual node.
1983 *
1984 * Note that sysctl_createv() will return 0 if the create request
1985 * matches an existing node (ala mkdir -p), and that sysctl_destroyv()
1986 * will return 0 if the node to be destroyed already does not exist
1987 * (aka rm -f) or if it is a parent of other nodes.
1988 *
1989 * This allows two (or more) different subsystems to assert sub-tree
1990 * existence before populating their own nodes, and to remove their
1991 * own nodes without orphaning the others when they are done.
1992 * ********************************************************************
1993 */
1994 #undef sysctl_createv
1995 int
1996 sysctl_createv(struct sysctllog **log, int cflags,
1997 const struct sysctlnode **rnode, const struct sysctlnode **cnode,
1998 int flags, int type, const char *namep, const char *descr,
1999 sysctlfn func, u_quad_t qv, void *newp, size_t newlen,
2000 ...)
2001 {
2002 va_list ap;
2003 int error, ni, namelen, name[CTL_MAXNAME];
2004 const struct sysctlnode *root, *pnode;
2005 struct sysctlnode nnode, onode, *dnode;
2006 size_t sz;
2007
2008 /*
2009 * where are we putting this?
2010 */
2011 if (rnode != NULL && *rnode == NULL) {
2012 printf("sysctl_createv: rnode NULL\n");
2013 return (EINVAL);
2014 }
2015 root = rnode ? *rnode : NULL;
2016 if (cnode != NULL)
2017 *cnode = NULL;
2018 if (cflags != 0)
2019 return (EINVAL);
2020
2021 /*
2022 * what is it?
2023 */
2024 flags = SYSCTL_VERSION|SYSCTL_TYPE(type)|SYSCTL_FLAGS(flags);
2025 if (log != NULL)
2026 flags &= ~CTLFLAG_PERMANENT;
2027
2028 /*
2029 * where do we put it?
2030 */
2031 va_start(ap, newlen);
2032 namelen = 0;
2033 error = 0;
2034 ni = -1;
2035 do {
2036 if (++ni == CTL_MAXNAME) {
2037 error = ENAMETOOLONG;
2038 break;
2039 }
2040 name[ni] = va_arg(ap, int);
2041 /*
2042 * sorry, this is not supported from here
2043 */
2044 if (name[ni] == CTL_CREATESYM) {
2045 error = EINVAL;
2046 break;
2047 }
2048 } while (name[ni] != CTL_EOL && name[ni] != CTL_CREATE);
2049 va_end(ap);
2050 if (error)
2051 return error;
2052 namelen = ni + (name[ni] == CTL_CREATE ? 1 : 0);
2053
2054 /*
2055 * what's it called
2056 */
2057 if (strlcpy(nnode.sysctl_name, namep, sizeof(nnode.sysctl_name)) >=
2058 sizeof(nnode.sysctl_name))
2059 return (ENAMETOOLONG);
2060
2061 /*
2062 * cons up the description of the new node
2063 */
2064 nnode.sysctl_num = name[namelen - 1];
2065 name[namelen - 1] = CTL_CREATE;
2066 nnode.sysctl_size = newlen;
2067 nnode.sysctl_flags = flags;
2068 if (type == CTLTYPE_NODE) {
2069 nnode.sysctl_csize = 0;
2070 nnode.sysctl_clen = 0;
2071 nnode.sysctl_child = NULL;
2072 if (flags & CTLFLAG_ALIAS)
2073 nnode.sysctl_alias = qv;
2074 } else if (flags & CTLFLAG_IMMEDIATE) {
2075 switch (type) {
2076 case CTLTYPE_BOOL:
2077 nnode.sysctl_bdata = qv;
2078 break;
2079 case CTLTYPE_INT:
2080 nnode.sysctl_idata = qv;
2081 break;
2082 case CTLTYPE_QUAD:
2083 nnode.sysctl_qdata = qv;
2084 break;
2085 default:
2086 return (EINVAL);
2087 }
2088 } else {
2089 nnode.sysctl_data = newp;
2090 }
2091 nnode.sysctl_func = func;
2092 nnode.sysctl_parent = NULL;
2093 nnode.sysctl_ver = 0;
2094
2095 /*
2096 * initialize lock state -- we need locks if the main tree has
2097 * been marked as complete, but since we could be called from
2098 * either there, or from a device driver (say, at device
2099 * insertion), or from a module (at module load time, say), we
2100 * don't really want to "wait"...
2101 */
2102 sysctl_lock(true);
2103
2104 /*
2105 * locate the prospective parent of the new node, and if we
2106 * find it, add the new node.
2107 */
2108 sz = sizeof(onode);
2109 pnode = root;
2110 error = sysctl_locate(NULL, &name[0], namelen - 1, &pnode, &ni);
2111 if (error) {
2112 /*
2113 * XXX: If you are seeing this printf in early bringup
2114 * stages, perhaps your setfault is not functioning and
2115 * thus kcopy() is mis-behaving.
2116 */
2117 printf("sysctl_createv: sysctl_locate(%s) returned %d\n",
2118 nnode.sysctl_name, error);
2119 sysctl_unlock();
2120 return (error);
2121 }
2122 error = sysctl_create(&name[ni], namelen - ni, &onode, &sz,
2123 &nnode, sizeof(nnode), &name[0], NULL,
2124 pnode);
2125
2126 /*
2127 * unfortunately the node we wanted to create is already
2128 * there. if the node that's already there is a reasonable
2129 * facsimile of the node we wanted to create, just pretend
2130 * (for the caller's benefit) that we managed to create the
2131 * node they wanted.
2132 */
2133 if (error == EEXIST) {
2134 /* name is the same as requested... */
2135 if (strcmp(nnode.sysctl_name, onode.sysctl_name) == 0 &&
2136 /* they want the same function... */
2137 nnode.sysctl_func == onode.sysctl_func &&
2138 /* number is the same as requested, or... */
2139 (nnode.sysctl_num == onode.sysctl_num ||
2140 /* they didn't pick a number... */
2141 nnode.sysctl_num == CTL_CREATE)) {
2142 /*
2143 * collision here from trying to create
2144 * something that already existed; let's give
2145 * our customers a hand and tell them they got
2146 * what they wanted.
2147 */
2148 #ifdef SYSCTL_DEBUG_CREATE
2149 printf("cleared\n");
2150 #endif /* SYSCTL_DEBUG_CREATE */
2151 error = 0;
2152 }
2153 }
2154
2155 if (error == 0 &&
2156 (cnode != NULL || log != NULL || descr != NULL)) {
2157 /*
2158 * sysctl_create() gave us back a copy of the node,
2159 * but we need to know where it actually is...
2160 */
2161 pnode = root;
2162 error = sysctl_locate(NULL, &name[0], namelen - 1, &pnode, &ni);
2163
2164 /*
2165 * manual scan of last layer so that aliased nodes
2166 * aren't followed.
2167 */
2168 if (error == 0) {
2169 for (ni = 0; ni < pnode->sysctl_clen; ni++)
2170 if (pnode->sysctl_child[ni].sysctl_num ==
2171 onode.sysctl_num)
2172 break;
2173 if (ni < pnode->sysctl_clen)
2174 pnode = &pnode->sysctl_child[ni];
2175 else
2176 error = ENOENT;
2177 }
2178
2179 /*
2180 * not expecting an error here, but...
2181 */
2182 if (error == 0) {
2183 if (log != NULL)
2184 sysctl_log_add(log, pnode);
2185 if (cnode != NULL)
2186 *cnode = pnode;
2187 if (descr != NULL) {
2188 /*
2189 * allow first caller to *set* a
2190 * description actually to set it
2191 *
2192 * discard const here so we can attach
2193 * the description
2194 */
2195 dnode = __UNCONST(pnode);
2196 if (pnode->sysctl_desc != NULL)
2197 /* skip it...we've got one */;
2198 else if (flags & CTLFLAG_OWNDESC) {
2199 size_t l = strlen(descr) + 1;
2200 char *d = malloc(l, M_SYSCTLDATA,
2201 M_WAITOK|M_CANFAIL);
2202 if (d != NULL) {
2203 memcpy(d, descr, l);
2204 dnode->sysctl_desc = d;
2205 dnode->sysctl_flags |=
2206 CTLFLAG_OWNDESC;
2207 }
2208 } else
2209 dnode->sysctl_desc = descr;
2210 }
2211 } else {
2212 printf("sysctl_create succeeded but node not found?!\n");
2213 /*
2214 * confusing, but the create said it
2215 * succeeded, so...
2216 */
2217 error = 0;
2218 }
2219 }
2220
2221 /*
2222 * now it should be safe to release the lock state. note that
2223 * the pointer to the newly created node being passed back may
2224 * not be "good" for very long.
2225 */
2226 sysctl_unlock();
2227
2228 if (error != 0) {
2229 printf("sysctl_createv: sysctl_create(%s) returned %d\n",
2230 nnode.sysctl_name, error);
2231 #if 0
2232 if (error != ENOENT)
2233 sysctl_dump(&onode);
2234 #endif
2235 }
2236
2237 return (error);
2238 }
2239
2240 int
2241 sysctl_destroyv(struct sysctlnode *rnode, ...)
2242 {
2243 va_list ap;
2244 int error, name[CTL_MAXNAME], namelen, ni;
2245 const struct sysctlnode *pnode, *node;
2246 struct sysctlnode dnode, *onode;
2247 size_t sz;
2248
2249 va_start(ap, rnode);
2250 namelen = 0;
2251 ni = 0;
2252 do {
2253 if (ni == CTL_MAXNAME) {
2254 va_end(ap);
2255 return (ENAMETOOLONG);
2256 }
2257 name[ni] = va_arg(ap, int);
2258 } while (name[ni++] != CTL_EOL);
2259 namelen = ni - 1;
2260 va_end(ap);
2261
2262 /*
2263 * i can't imagine why we'd be destroying a node when the tree
2264 * wasn't complete, but who knows?
2265 */
2266 sysctl_lock(true);
2267
2268 /*
2269 * where is it?
2270 */
2271 node = rnode;
2272 error = sysctl_locate(NULL, &name[0], namelen - 1, &node, &ni);
2273 if (error) {
2274 /* they want it gone and it's not there, so... */
2275 sysctl_unlock();
2276 return (error == ENOENT ? 0 : error);
2277 }
2278
2279 /*
2280 * set up the deletion
2281 */
2282 pnode = node;
2283 node = &dnode;
2284 memset(&dnode, 0, sizeof(dnode));
2285 dnode.sysctl_flags = SYSCTL_VERSION;
2286 dnode.sysctl_num = name[namelen - 1];
2287
2288 /*
2289 * we found it, now let's nuke it
2290 */
2291 name[namelen - 1] = CTL_DESTROY;
2292 sz = 0;
2293 error = sysctl_destroy(&name[namelen - 1], 1, NULL, &sz,
2294 node, sizeof(*node), &name[0], NULL,
2295 pnode);
2296 if (error == ENOTEMPTY) {
2297 /*
2298 * think of trying to delete "foo" when "foo.bar"
2299 * (which someone else put there) is still in
2300 * existence
2301 */
2302 error = 0;
2303
2304 /*
2305 * dunno who put the description there, but if this
2306 * node can ever be removed, we need to make sure the
2307 * string doesn't go out of context. that means we
2308 * need to find the node that's still there (don't use
2309 * sysctl_locate() because that follows aliasing).
2310 */
2311 node = pnode->sysctl_child;
2312 for (ni = 0; ni < pnode->sysctl_clen; ni++)
2313 if (node[ni].sysctl_num == dnode.sysctl_num)
2314 break;
2315 node = (ni < pnode->sysctl_clen) ? &node[ni] : NULL;
2316
2317 /*
2318 * if we found it, and this node has a description,
2319 * and this node can be released, and it doesn't
2320 * already own its own description...sigh. :)
2321 */
2322 if (node != NULL && node->sysctl_desc != NULL &&
2323 !(node->sysctl_flags & CTLFLAG_PERMANENT) &&
2324 !(node->sysctl_flags & CTLFLAG_OWNDESC)) {
2325 char *d;
2326
2327 sz = strlen(node->sysctl_desc) + 1;
2328 d = malloc(sz, M_SYSCTLDATA, M_WAITOK|M_CANFAIL);
2329 if (d != NULL) {
2330 /*
2331 * discard const so that we can
2332 * re-attach the description
2333 */
2334 memcpy(d, node->sysctl_desc, sz);
2335 onode = __UNCONST(node);
2336 onode->sysctl_desc = d;
2337 onode->sysctl_flags |= CTLFLAG_OWNDESC;
2338 } else {
2339 /*
2340 * XXX drop the description? be
2341 * afraid? don't care?
2342 */
2343 }
2344 }
2345 }
2346
2347 sysctl_unlock();
2348
2349 return (error);
2350 }
2351
2352 /*
2353 * ********************************************************************
2354 * Deletes an entire n-ary tree. Not recommended unless you know why
2355 * you're doing it. Personally, I don't know why you'd even think
2356 * about it.
2357 * ********************************************************************
2358 */
2359 void
2360 sysctl_free(struct sysctlnode *rnode)
2361 {
2362 struct sysctlnode *node, *pnode;
2363
2364 rw_enter(&sysctl_treelock, RW_WRITER);
2365
2366 if (rnode == NULL)
2367 rnode = &sysctl_root;
2368
2369 if (SYSCTL_VERS(rnode->sysctl_flags) != SYSCTL_VERSION) {
2370 printf("sysctl_free: rnode %p wrong version\n", rnode);
2371 rw_exit(&sysctl_treelock);
2372 return;
2373 }
2374
2375 pnode = rnode;
2376
2377 node = pnode->sysctl_child;
2378 do {
2379 while (node != NULL && pnode->sysctl_csize > 0) {
2380 while (node <
2381 &pnode->sysctl_child[pnode->sysctl_clen] &&
2382 (SYSCTL_TYPE(node->sysctl_flags) !=
2383 CTLTYPE_NODE ||
2384 node->sysctl_csize == 0)) {
2385 if (SYSCTL_FLAGS(node->sysctl_flags) &
2386 CTLFLAG_OWNDATA) {
2387 if (node->sysctl_data != NULL) {
2388 free(node->sysctl_data,
2389 M_SYSCTLDATA);
2390 node->sysctl_data = NULL;
2391 }
2392 }
2393 if (SYSCTL_FLAGS(node->sysctl_flags) &
2394 CTLFLAG_OWNDESC) {
2395 if (node->sysctl_desc != NULL) {
2396 /*XXXUNCONST*/
2397 free(__UNCONST(node->sysctl_desc),
2398 M_SYSCTLDATA);
2399 node->sysctl_desc = NULL;
2400 }
2401 }
2402 node++;
2403 }
2404 if (node < &pnode->sysctl_child[pnode->sysctl_clen]) {
2405 pnode = node;
2406 node = node->sysctl_child;
2407 } else
2408 break;
2409 }
2410 if (pnode->sysctl_child != NULL)
2411 free(pnode->sysctl_child, M_SYSCTLNODE);
2412 pnode->sysctl_clen = 0;
2413 pnode->sysctl_csize = 0;
2414 pnode->sysctl_child = NULL;
2415 node = pnode;
2416 pnode = node->sysctl_parent;
2417 } while (pnode != NULL && node != rnode);
2418
2419 rw_exit(&sysctl_treelock);
2420 }
2421
2422 void
2423 sysctl_log_print(const struct sysctllog *slog)
2424 {
2425 int i, len;
2426
2427 printf("root %p left %d size %d content", (const void *)slog->log_root,
2428 slog->log_left, slog->log_size);
2429
2430 for (len = 0, i = slog->log_left; i < slog->log_size; i++) {
2431 switch (len) {
2432 case 0:
2433 len = -1;
2434 printf(" version %d", slog->log_num[i]);
2435 break;
2436 case -1:
2437 len = -2;
2438 printf(" type %d", slog->log_num[i]);
2439 break;
2440 case -2:
2441 len = slog->log_num[i];
2442 printf(" len %d:", slog->log_num[i]);
2443 if (len <= 0)
2444 len = -1;
2445 break;
2446 default:
2447 len--;
2448 printf(" %d", slog->log_num[i]);
2449 break;
2450 }
2451 }
2452 printf(" end\n");
2453 }
2454
2455 int
2456 sysctl_log_add(struct sysctllog **logp, const struct sysctlnode *node)
2457 {
2458 const int size0 = 16;
2459 int name[CTL_MAXNAME], namelen, i;
2460 const struct sysctlnode *pnode;
2461 struct sysctllog *log;
2462
2463 if (node->sysctl_flags & CTLFLAG_PERMANENT)
2464 return (0);
2465
2466 if (logp == NULL)
2467 return (0);
2468
2469 if (*logp == NULL) {
2470 log = malloc(sizeof(struct sysctllog),
2471 M_SYSCTLDATA, M_WAITOK|M_CANFAIL);
2472 if (log == NULL) {
2473 /* XXX print error message? */
2474 return (-1);
2475 }
2476 log->log_num = malloc(size0 * sizeof(int),
2477 M_SYSCTLDATA, M_WAITOK|M_CANFAIL);
2478 if (log->log_num == NULL) {
2479 /* XXX print error message? */
2480 free(log, M_SYSCTLDATA);
2481 return (-1);
2482 }
2483 memset(log->log_num, 0, size0 * sizeof(int));
2484 log->log_root = NULL;
2485 log->log_size = size0;
2486 log->log_left = size0;
2487 *logp = log;
2488 } else
2489 log = *logp;
2490
2491 /*
2492 * check that the root is proper. it's okay to record the
2493 * address of the root of a tree. it's the only thing that's
2494 * guaranteed not to shift around as nodes come and go.
2495 */
2496 if (log->log_root == NULL)
2497 log->log_root = sysctl_rootof(node);
2498 else if (log->log_root != sysctl_rootof(node)) {
2499 printf("sysctl: log %p root mismatch (%p)\n",
2500 log->log_root, sysctl_rootof(node));
2501 return (-1);
2502 }
2503
2504 /*
2505 * we will copy out name in reverse order
2506 */
2507 for (pnode = node, namelen = 0;
2508 pnode != NULL && !(pnode->sysctl_flags & CTLFLAG_ROOT);
2509 pnode = pnode->sysctl_parent)
2510 name[namelen++] = pnode->sysctl_num;
2511
2512 /*
2513 * do we have space?
2514 */
2515 if (log->log_left < (namelen + 3))
2516 sysctl_log_realloc(log);
2517 if (log->log_left < (namelen + 3))
2518 return (-1);
2519
2520 /*
2521 * stuff name in, then namelen, then node type, and finally,
2522 * the version for non-node nodes.
2523 */
2524 for (i = 0; i < namelen; i++)
2525 log->log_num[--log->log_left] = name[i];
2526 log->log_num[--log->log_left] = namelen;
2527 log->log_num[--log->log_left] = SYSCTL_TYPE(node->sysctl_flags);
2528 if (log->log_num[log->log_left] != CTLTYPE_NODE)
2529 log->log_num[--log->log_left] = node->sysctl_ver;
2530 else
2531 log->log_num[--log->log_left] = 0;
2532
2533 return (0);
2534 }
2535
2536 void
2537 sysctl_teardown(struct sysctllog **logp)
2538 {
2539 const struct sysctlnode *rnode;
2540 struct sysctlnode node;
2541 struct sysctllog *log;
2542 uint namelen;
2543 int *name, t, v, error, ni;
2544 size_t sz;
2545
2546 if (logp == NULL || *logp == NULL)
2547 return;
2548 log = *logp;
2549
2550 rw_enter(&sysctl_treelock, RW_WRITER);
2551 memset(&node, 0, sizeof(node));
2552
2553 while (log->log_left < log->log_size) {
2554 KASSERT((log->log_left + 3 < log->log_size) &&
2555 (log->log_left + log->log_num[log->log_left + 2] <=
2556 log->log_size));
2557 v = log->log_num[log->log_left++];
2558 t = log->log_num[log->log_left++];
2559 namelen = log->log_num[log->log_left++];
2560 name = &log->log_num[log->log_left];
2561
2562 node.sysctl_num = name[namelen - 1];
2563 node.sysctl_flags = SYSCTL_VERSION|t;
2564 node.sysctl_ver = v;
2565
2566 rnode = log->log_root;
2567 error = sysctl_locate(NULL, &name[0], namelen, &rnode, &ni);
2568 if (error == 0) {
2569 name[namelen - 1] = CTL_DESTROY;
2570 rnode = rnode->sysctl_parent;
2571 sz = 0;
2572 (void)sysctl_destroy(&name[namelen - 1], 1, NULL,
2573 &sz, &node, sizeof(node),
2574 &name[0], NULL, rnode);
2575 }
2576
2577 log->log_left += namelen;
2578 }
2579
2580 KASSERT(log->log_size == log->log_left);
2581 free(log->log_num, M_SYSCTLDATA);
2582 free(log, M_SYSCTLDATA);
2583 *logp = NULL;
2584
2585 rw_exit(&sysctl_treelock);
2586 }
2587
2588 /*
2589 * ********************************************************************
2590 * old_sysctl -- A routine to bridge old-style internal calls to the
2591 * new infrastructure.
2592 * ********************************************************************
2593 */
2594 int
2595 old_sysctl(int *name, u_int namelen, void *oldp, size_t *oldlenp,
2596 void *newp, size_t newlen, struct lwp *l)
2597 {
2598 int error;
2599 size_t oldlen = 0;
2600 size_t savelen;
2601
2602 if (oldlenp) {
2603 oldlen = *oldlenp;
2604 }
2605 savelen = oldlen;
2606
2607 sysctl_lock(newp != NULL);
2608 error = sysctl_dispatch(name, namelen, oldp, &oldlen,
2609 newp, newlen, name, l, NULL);
2610 sysctl_unlock();
2611 if (error == 0 && oldp != NULL && savelen < oldlen)
2612 error = ENOMEM;
2613 if (oldlenp) {
2614 *oldlenp = oldlen;
2615 }
2616
2617 return (error);
2618 }
2619
2620 /*
2621 * ********************************************************************
2622 * Section 4: Generic helper routines
2623 * ********************************************************************
2624 * "helper" routines that can do more finely grained access control,
2625 * construct structures from disparate information, create the
2626 * appearance of more nodes and sub-trees, etc. for example, if
2627 * CTL_PROC wanted a helper function, it could respond to a CTL_QUERY
2628 * with a dynamically created list of nodes that represented the
2629 * currently running processes at that instant.
2630 * ********************************************************************
2631 */
2632
2633 /*
2634 * first, a few generic helpers that provide:
2635 *
2636 * sysctl_needfunc() a readonly interface that emits a warning
2637 * sysctl_notavail() returns EOPNOTSUPP (generic error)
2638 * sysctl_null() an empty return buffer with no error
2639 */
2640 int
2641 sysctl_needfunc(SYSCTLFN_ARGS)
2642 {
2643 int error;
2644
2645 printf("!!SYSCTL_NEEDFUNC!!\n");
2646
2647 if (newp != NULL || namelen != 0)
2648 return (EOPNOTSUPP);
2649
2650 error = 0;
2651 if (oldp != NULL)
2652 error = sysctl_copyout(l, rnode->sysctl_data, oldp,
2653 MIN(rnode->sysctl_size, *oldlenp));
2654 *oldlenp = rnode->sysctl_size;
2655
2656 return (error);
2657 }
2658
2659 int
2660 sysctl_notavail(SYSCTLFN_ARGS)
2661 {
2662
2663 if (namelen == 1 && name[0] == CTL_QUERY)
2664 return (sysctl_query(SYSCTLFN_CALL(rnode)));
2665
2666 return (EOPNOTSUPP);
2667 }
2668
2669 int
2670 sysctl_null(SYSCTLFN_ARGS)
2671 {
2672
2673 *oldlenp = 0;
2674
2675 return (0);
2676 }
2677
2678 u_int
2679 sysctl_map_flags(const u_int *map, u_int word)
2680 {
2681 u_int rv;
2682
2683 for (rv = 0; *map != 0; map += 2)
2684 if ((word & map[0]) != 0)
2685 rv |= map[1];
2686
2687 return rv;
2688 }
2689
2690 /*
2691 * ********************************************************************
2692 * Section 5: The machinery that makes it all go
2693 * ********************************************************************
2694 * Memory "manglement" routines. Not much to this, eh?
2695 * ********************************************************************
2696 */
2697 static int
2698 sysctl_alloc(struct sysctlnode *p, int x)
2699 {
2700 int i;
2701 struct sysctlnode *n;
2702
2703 assert(p->sysctl_child == NULL);
2704
2705 if (x == 1)
2706 n = malloc(sizeof(struct sysctlnode),
2707 M_SYSCTLNODE, M_WAITOK|M_CANFAIL);
2708 else
2709 n = malloc(SYSCTL_DEFSIZE * sizeof(struct sysctlnode),
2710 M_SYSCTLNODE, M_WAITOK|M_CANFAIL);
2711 if (n == NULL)
2712 return (ENOMEM);
2713
2714 if (x == 1) {
2715 memset(n, 0, sizeof(struct sysctlnode));
2716 p->sysctl_csize = 1;
2717 } else {
2718 memset(n, 0, SYSCTL_DEFSIZE * sizeof(struct sysctlnode));
2719 p->sysctl_csize = SYSCTL_DEFSIZE;
2720 }
2721 p->sysctl_clen = 0;
2722
2723 for (i = 0; i < p->sysctl_csize; i++)
2724 n[i].sysctl_parent = p;
2725
2726 p->sysctl_child = n;
2727 return (0);
2728 }
2729
2730 static int
2731 sysctl_realloc(struct sysctlnode *p)
2732 {
2733 int i, j, olen;
2734 struct sysctlnode *n;
2735
2736 assert(p->sysctl_csize == p->sysctl_clen);
2737
2738 /*
2739 * how many do we have...how many should we make?
2740 */
2741 olen = p->sysctl_clen;
2742 n = malloc(2 * olen * sizeof(struct sysctlnode), M_SYSCTLNODE,
2743 M_WAITOK|M_CANFAIL);
2744 if (n == NULL)
2745 return (ENOMEM);
2746
2747 /*
2748 * move old children over...initialize new children
2749 */
2750 memcpy(n, p->sysctl_child, olen * sizeof(struct sysctlnode));
2751 memset(&n[olen], 0, olen * sizeof(struct sysctlnode));
2752 p->sysctl_csize = 2 * olen;
2753
2754 /*
2755 * reattach moved (and new) children to parent; if a moved
2756 * child node has children, reattach the parent pointers of
2757 * grandchildren
2758 */
2759 for (i = 0; i < p->sysctl_csize; i++) {
2760 n[i].sysctl_parent = p;
2761 if (n[i].sysctl_child != NULL) {
2762 for (j = 0; j < n[i].sysctl_csize; j++)
2763 n[i].sysctl_child[j].sysctl_parent = &n[i];
2764 }
2765 }
2766
2767 /*
2768 * get out with the old and in with the new
2769 */
2770 free(p->sysctl_child, M_SYSCTLNODE);
2771 p->sysctl_child = n;
2772
2773 return (0);
2774 }
2775
2776 static int
2777 sysctl_log_realloc(struct sysctllog *log)
2778 {
2779 int *n, s, d;
2780
2781 s = log->log_size * 2;
2782 d = log->log_size;
2783
2784 n = malloc(s * sizeof(int), M_SYSCTLDATA, M_WAITOK|M_CANFAIL);
2785 if (n == NULL)
2786 return (-1);
2787
2788 memset(n, 0, s * sizeof(int));
2789 memcpy(&n[d], log->log_num, d * sizeof(int));
2790 free(log->log_num, M_SYSCTLDATA);
2791 log->log_num = n;
2792 if (d)
2793 log->log_left += d;
2794 else
2795 log->log_left = s;
2796 log->log_size = s;
2797
2798 return (0);
2799 }
2800
2801 /*
2802 * ********************************************************************
2803 * Section 6: Conversion between API versions wrt the sysctlnode
2804 * ********************************************************************
2805 */
2806 static int
2807 sysctl_cvt_in(struct lwp *l, int *vp, const void *i, size_t sz,
2808 struct sysctlnode *node)
2809 {
2810 int error, flags;
2811
2812 if (i == NULL || sz < sizeof(flags))
2813 return (EINVAL);
2814
2815 error = sysctl_copyin(l, i, &flags, sizeof(flags));
2816 if (error)
2817 return (error);
2818
2819 #if (SYSCTL_VERSION != SYSCTL_VERS_1)
2820 #error sysctl_cvt_in: no support for SYSCTL_VERSION
2821 #endif /* (SYSCTL_VERSION != SYSCTL_VERS_1) */
2822
2823 if (sz == sizeof(*node) &&
2824 SYSCTL_VERS(flags) == SYSCTL_VERSION) {
2825 error = sysctl_copyin(l, i, node, sizeof(*node));
2826 if (error)
2827 return (error);
2828 *vp = SYSCTL_VERSION;
2829 return (0);
2830 }
2831
2832 return (EINVAL);
2833 }
2834
2835 static int
2836 sysctl_cvt_out(struct lwp *l, int v, const struct sysctlnode *i,
2837 void *ovp, size_t left, size_t *szp)
2838 {
2839 size_t sz = sizeof(*i);
2840 const void *src = i;
2841 int error;
2842
2843 switch (v) {
2844 case SYSCTL_VERS_0:
2845 return (EINVAL);
2846
2847 #if (SYSCTL_VERSION != SYSCTL_VERS_1)
2848 #error sysctl_cvt_out: no support for SYSCTL_VERSION
2849 #endif /* (SYSCTL_VERSION != SYSCTL_VERS_1) */
2850
2851 case SYSCTL_VERSION:
2852 /* nothing more to do here */
2853 break;
2854 }
2855
2856 if (ovp != NULL && left >= sz) {
2857 error = sysctl_copyout(l, src, ovp, sz);
2858 if (error)
2859 return (error);
2860 }
2861
2862 if (szp != NULL)
2863 *szp = sz;
2864
2865 return (0);
2866 }
2867