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