kernel - Make certain sysctl's unlocked
[dragonfly.git] / sys / kern / kern_sysctl.c
1 /*-
2  * Copyright (c) 1982, 1986, 1989, 1993
3  *      The Regents of the University of California.  All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley by
6  * Mike Karels at Berkeley Software Design, Inc.
7  *
8  * Quite extensively rewritten by Poul-Henning Kamp of the FreeBSD
9  * project, to make these variables more userfriendly.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. Neither the name of the University nor the names of its contributors
20  *    may be used to endorse or promote products derived from this software
21  *    without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33  * SUCH DAMAGE.
34  *
35  *      @(#)kern_sysctl.c       8.4 (Berkeley) 4/14/94
36  * $FreeBSD: src/sys/kern/kern_sysctl.c,v 1.92.2.9 2003/05/01 22:48:09 trhodes Exp $
37  */
38
39 #include <sys/param.h>
40 #include <sys/systm.h>
41 #include <sys/kernel.h>
42 #include <sys/buf.h>
43 #include <sys/sysctl.h>
44 #include <sys/malloc.h>
45 #include <sys/proc.h>
46 #include <sys/priv.h>
47 #include <sys/sysproto.h>
48 #include <sys/lock.h>
49 #include <sys/sbuf.h>
50
51 #include <vm/vm.h>
52 #include <vm/vm_extern.h>
53
54 static MALLOC_DEFINE(M_SYSCTL, "sysctl", "sysctl internal magic");
55 static MALLOC_DEFINE(M_SYSCTLOID, "sysctloid", "sysctl dynamic oids");
56
57 /*
58  * The sysctllock protects the MIB tree.  It also protects sysctl
59  * contexts used with dynamic sysctls.  The sysctl_register_oid() and
60  * sysctl_unregister_oid() routines require the sysctllock to already
61  * be held, so the sysctl_lock() and sysctl_unlock() routines are
62  * provided for the few places in the kernel which need to use that
63  * API rather than using the dynamic API.  Use of the dynamic API is
64  * strongly encouraged for most code.
65  */
66
67 static int      sysctl_root(SYSCTL_HANDLER_ARGS);
68 static void     sysctl_register_oid_int(struct sysctl_oid *oipd);
69 static void     sysctl_unregister_oid_int(struct sysctl_oid *oipd);
70
71 struct sysctl_oid_list sysctl__children; /* root list */
72
73 static int      sysctl_remove_oid_locked(struct sysctl_oid *oidp, int del,
74                     int recurse);
75
76 static struct sysctl_oid *
77 sysctl_find_oidname(const char *name, struct sysctl_oid_list *list, int lock)
78 {
79         struct sysctl_oid *oidp;
80
81         SLIST_FOREACH(oidp, list, oid_link) {
82                 if (strcmp(oidp->oid_name, name) == 0) {
83                         break;
84                 }
85         }
86         return (oidp);
87 }
88
89 /*
90  * Initialization of the MIB tree.
91  *
92  * Order by number in each list.
93  */
94
95 void
96 sysctl_register_oid(struct sysctl_oid *oidp)
97 {
98         SYSCTL_XLOCK();
99         sysctl_register_oid_int(oidp);
100         SYSCTL_XUNLOCK();
101 }
102
103 static void
104 sysctl_register_oid_int(struct sysctl_oid *oidp)
105 {
106         struct sysctl_oid_list *parent = oidp->oid_parent;
107         struct sysctl_oid *p;
108         struct sysctl_oid *q;
109
110         /*
111          * Finish initialization from sysctl_set or add.
112          */
113         lockinit(&oidp->oid_lock, "oidlk", 0, LK_CANRECURSE);
114
115         /*
116          * First check if another oid with the same name already
117          * exists in the parent's list.
118          */
119         p = sysctl_find_oidname(oidp->oid_name, parent, 0);
120         if (p != NULL) {
121                 if ((p->oid_kind & CTLTYPE) == CTLTYPE_NODE)
122                         p->oid_refcnt++;
123                 else
124                         kprintf("can't re-use a leaf (%s)!\n", p->oid_name);
125                 return;
126         }
127
128         /*
129          * If this oid has a number OID_AUTO, give it a number which
130          * is greater than any current oid.  Make sure it is at least
131          * 256 to leave space for pre-assigned oid numbers.
132          */
133         if (oidp->oid_number == OID_AUTO) {
134                 int newoid = 0x100;     /* minimum AUTO oid */
135
136                 /*
137                  * Adjust based on highest oid in parent list
138                  */
139                 SLIST_FOREACH(p, parent, oid_link) {
140                         if (newoid <= p->oid_number)
141                                 newoid = p->oid_number + 1;
142                 }
143                 oidp->oid_number = newoid;
144         }
145
146         /*
147          * Insert the oid into the parent's list in order.
148          */
149         q = NULL;
150         SLIST_FOREACH(p, parent, oid_link) {
151                 if (oidp->oid_number < p->oid_number)
152                         break;
153                 q = p;
154         }
155         if (q)
156                 SLIST_INSERT_AFTER(q, oidp, oid_link);
157         else
158                 SLIST_INSERT_HEAD(parent, oidp, oid_link);
159 }
160
161 void
162 sysctl_unregister_oid(struct sysctl_oid *oidp)
163 {
164         SYSCTL_XLOCK();
165         sysctl_unregister_oid_int(oidp);
166         SYSCTL_XUNLOCK();
167 }
168
169 static void
170 sysctl_unregister_oid_int(struct sysctl_oid *oidp)
171 {
172         struct sysctl_oid *p;
173
174         if (oidp->oid_number == OID_AUTO)
175                 panic("Trying to unregister OID_AUTO entry: %p", oidp);
176
177         SLIST_FOREACH(p, oidp->oid_parent, oid_link) {
178                 if (p != oidp)
179                         continue;
180                 SLIST_REMOVE(oidp->oid_parent, oidp, sysctl_oid, oid_link);
181                 return;
182         }
183
184         /*
185          * This can happen when a module fails to register and is
186          * being unloaded afterwards.  It should not be a panic()
187          * for normal use.
188          */
189         kprintf("%s: failed to unregister sysctl\n", __func__);
190 }
191
192 /* Initialize a new context to keep track of dynamically added sysctls. */
193 int
194 sysctl_ctx_init(struct sysctl_ctx_list *c)
195 {
196         if (c == NULL)
197                 return(EINVAL);
198         TAILQ_INIT(c);
199         return(0);
200 }
201
202 /* Free the context, and destroy all dynamic oids registered in this context */
203 int
204 sysctl_ctx_free(struct sysctl_ctx_list *clist)
205 {
206         struct sysctl_ctx_entry *e, *e1;
207         int error;
208
209         error = 0;
210         /*
211          * First perform a "dry run" to check if it's ok to remove oids.
212          * XXX FIXME
213          * XXX This algorithm is a hack. But I don't know any
214          * XXX better solution for now...
215          */
216         SYSCTL_XLOCK();
217         TAILQ_FOREACH(e, clist, link) {
218                 error = sysctl_remove_oid_locked(e->entry, 0, 0);
219                 if (error)
220                         break;
221         }
222         /*
223          * Restore deregistered entries, either from the end,
224          * or from the place where error occured.
225          * e contains the entry that was not unregistered
226          */
227         if (error)
228                 e1 = TAILQ_PREV(e, sysctl_ctx_list, link);
229         else
230                 e1 = TAILQ_LAST(clist, sysctl_ctx_list);
231         while (e1 != NULL) {
232                 sysctl_register_oid(e1->entry);
233                 e1 = TAILQ_PREV(e1, sysctl_ctx_list, link);
234         }
235         if (error) {
236                 SYSCTL_XUNLOCK();
237                 return(EBUSY);
238         }
239         /* Now really delete the entries */
240         e = TAILQ_FIRST(clist);
241         while (e != NULL) {
242                 e1 = TAILQ_NEXT(e, link);
243                 error = sysctl_remove_oid_locked(e->entry, 1, 0);
244                 if (error)
245                         panic("sysctl_remove_oid: corrupt tree, entry: %s",
246                             e->entry->oid_name);
247                 kfree(e, M_SYSCTLOID);
248                 e = e1;
249         }
250         SYSCTL_XUNLOCK();
251         return (error);
252 }
253
254 /* Add an entry to the context */
255 struct sysctl_ctx_entry *
256 sysctl_ctx_entry_add(struct sysctl_ctx_list *clist, struct sysctl_oid *oidp)
257 {
258         struct sysctl_ctx_entry *e;
259
260         SYSCTL_ASSERT_LOCKED();
261         if (clist == NULL || oidp == NULL)
262                 return(NULL);
263         e = kmalloc(sizeof(struct sysctl_ctx_entry), M_SYSCTLOID, M_WAITOK);
264         e->entry = oidp;
265         TAILQ_INSERT_HEAD(clist, e, link);
266         return (e);
267 }
268
269 /* Find an entry in the context */
270 struct sysctl_ctx_entry *
271 sysctl_ctx_entry_find(struct sysctl_ctx_list *clist, struct sysctl_oid *oidp)
272 {
273         struct sysctl_ctx_entry *e;
274
275         SYSCTL_ASSERT_LOCKED();
276         if (clist == NULL || oidp == NULL)
277                 return(NULL);
278         TAILQ_FOREACH(e, clist, link) {
279                 if(e->entry == oidp)
280                         return(e);
281         }
282         return (e);
283 }
284
285 /*
286  * Delete an entry from the context.
287  * NOTE: this function doesn't free oidp! You have to remove it
288  * with sysctl_remove_oid().
289  */
290 int
291 sysctl_ctx_entry_del(struct sysctl_ctx_list *clist, struct sysctl_oid *oidp)
292 {
293         struct sysctl_ctx_entry *e;
294
295         if (clist == NULL || oidp == NULL)
296                 return (EINVAL);
297         SYSCTL_XLOCK();
298         e = sysctl_ctx_entry_find(clist, oidp);
299         if (e != NULL) {
300                 TAILQ_REMOVE(clist, e, link);
301                 SYSCTL_XUNLOCK();
302                 kfree(e, M_SYSCTLOID);
303                 return (0);
304         } else {
305                 SYSCTL_XUNLOCK();
306                 return (ENOENT);
307         }
308 }
309
310 /*
311  * Remove dynamically created sysctl trees.
312  * oidp - top of the tree to be removed
313  * del - if 0 - just deregister, otherwise free up entries as well
314  * recurse - if != 0 traverse the subtree to be deleted
315  */
316 int
317 sysctl_remove_oid(struct sysctl_oid *oidp, int del, int recurse)
318 {
319         int error;
320
321         SYSCTL_XLOCK();
322         error = sysctl_remove_oid_locked(oidp, del, recurse);
323         SYSCTL_XUNLOCK();
324         return (error);
325 }
326
327 static int
328 sysctl_remove_oid_locked(struct sysctl_oid *oidp, int del, int recurse)
329 {
330         struct sysctl_oid *p, *tmp;
331         int error;
332
333         SYSCTL_ASSERT_LOCKED();
334         if (oidp == NULL)
335                 return(EINVAL);
336         if ((oidp->oid_kind & CTLFLAG_DYN) == 0) {
337                 kprintf("can't remove non-dynamic nodes!\n");
338                 return (EINVAL);
339         }
340         /*
341          * WARNING: normal method to do this should be through
342          * sysctl_ctx_free(). Use recursing as the last resort
343          * method to purge your sysctl tree of leftovers...
344          * However, if some other code still references these nodes,
345          * it will panic.
346          */
347         if ((oidp->oid_kind & CTLTYPE) == CTLTYPE_NODE) {
348                 if (oidp->oid_refcnt == 1) {
349                         SLIST_FOREACH_MUTABLE(p,
350                             SYSCTL_CHILDREN(oidp), oid_link, tmp) {
351                                 if (!recurse) {
352                                         kprintf("Warning: failed attempt to "
353                                             "remove oid %s with child %s\n",
354                                             oidp->oid_name, p->oid_name);
355                                         return (ENOTEMPTY);
356                                 }
357                                 error = sysctl_remove_oid_locked(p, del,
358                                                                  recurse);
359                                 if (error)
360                                         return (error);
361                         }
362                         if (del)
363                                 kfree(SYSCTL_CHILDREN(oidp), M_SYSCTLOID);
364                 }
365         }
366         if (oidp->oid_refcnt > 1 ) {
367                 oidp->oid_refcnt--;
368         } else {
369                 if (oidp->oid_refcnt == 0) {
370                         kprintf("Warning: bad oid_refcnt=%u (%s)!\n",
371                                 oidp->oid_refcnt, oidp->oid_name);
372                         return (EINVAL);
373                 }
374                 sysctl_unregister_oid(oidp);
375                 if (del) {
376                         /*
377                          * Wait for all threads running the handler to drain.
378                          * This preserves the previous behavior when the
379                          * sysctl lock was held across a handler invocation,
380                          * and is necessary for module unload correctness.
381                          */
382                         while (oidp->oid_running > 0) {
383                                 oidp->oid_kind |= CTLFLAG_DYING;
384                                 tsleep_interlock(&oidp->oid_running, 0);
385                                 SYSCTL_XUNLOCK();
386                                 tsleep(&oidp->oid_running, PINTERLOCKED,
387                                        "oidrm", 0);
388                                 SYSCTL_XLOCK();
389                         }
390                         if (oidp->oid_descr)
391                                 kfree(__DECONST(char *, oidp->oid_descr),
392                                     M_SYSCTLOID);
393                         kfree(__DECONST(char *, oidp->oid_name), M_SYSCTLOID);
394                         lockuninit(&oidp->oid_lock);
395                         kfree(oidp, M_SYSCTLOID);
396                 }
397         }
398         return (0);
399 }
400
401 int
402 sysctl_remove_name(struct sysctl_oid *parent, const char *name,
403     int del, int recurse)
404 {
405         struct sysctl_oid *p, *tmp;
406         int error;
407
408         error = ENOENT;
409         SYSCTL_XLOCK();
410         SLIST_FOREACH_MUTABLE(p, SYSCTL_CHILDREN(parent), oid_link, tmp) {
411                 if (strcmp(p->oid_name, name) == 0) {
412                         error = sysctl_remove_oid_locked(p, del, recurse);
413                         break;
414                 }
415         }
416         SYSCTL_XUNLOCK();
417
418         return (error);
419 }
420
421 /*
422  * Create new sysctls at run time.
423  * clist may point to a valid context initialized with sysctl_ctx_init().
424  */
425 struct sysctl_oid *
426 sysctl_add_oid(struct sysctl_ctx_list *clist, struct sysctl_oid_list *parent,
427         int number, const char *name, int kind, void *arg1, int arg2,
428         int (*handler)(SYSCTL_HANDLER_ARGS), const char *fmt, const char *descr)
429 {
430         struct sysctl_oid *oidp;
431         ssize_t len;
432         char *newname;
433
434         /* You have to hook up somewhere.. */
435         if (parent == NULL)
436                 return(NULL);
437         SYSCTL_XLOCK();
438         /* Check if the node already exists, otherwise create it */
439         oidp = sysctl_find_oidname(name, parent, 0);
440         if (oidp != NULL) {
441                 if ((oidp->oid_kind & CTLTYPE) == CTLTYPE_NODE) {
442                         oidp->oid_refcnt++;
443                         /* Update the context */
444                         if (clist != NULL)
445                                 sysctl_ctx_entry_add(clist, oidp);
446                         SYSCTL_XUNLOCK();
447                         return (oidp);
448                 } else {
449                         kprintf("can't re-use a leaf (%s)!\n", name);
450                         SYSCTL_XUNLOCK();
451                         return (NULL);
452                 }
453         }
454         oidp = kmalloc(sizeof(struct sysctl_oid), M_SYSCTLOID,
455                        M_WAITOK | M_ZERO);
456         oidp->oid_parent = parent;
457         SLIST_NEXT(oidp, oid_link) = NULL;
458         oidp->oid_number = number;
459         oidp->oid_refcnt = 1;
460         len = strlen(name);
461         newname = kmalloc(len + 1, M_SYSCTLOID, M_WAITOK);
462         bcopy(name, newname, len + 1);
463         newname[len] = '\0';
464         oidp->oid_name = newname;
465         oidp->oid_handler = handler;
466         oidp->oid_kind = CTLFLAG_DYN | kind;
467         if ((kind & CTLTYPE) == CTLTYPE_NODE) {
468                 struct sysctl_oid_list *children;
469
470                 /* Allocate space for children */
471                 children = kmalloc(sizeof(*children), M_SYSCTLOID, M_WAITOK);
472                 SYSCTL_SET_CHILDREN(oidp, children);
473                 SLIST_INIT(children);
474         } else {
475                 oidp->oid_arg1 = arg1;
476                 oidp->oid_arg2 = arg2;
477         }
478         oidp->oid_fmt = fmt;
479         if (descr) {
480                 int len = strlen(descr) + 1;
481                 oidp->oid_descr = kmalloc(len, M_SYSCTLOID, M_WAITOK);
482                 strcpy((char *)(uintptr_t)(const void *)oidp->oid_descr, descr);
483         };
484         /* Update the context, if used */
485         if (clist != NULL)
486                 sysctl_ctx_entry_add(clist, oidp);
487         /* Register this oid */
488         sysctl_register_oid_int(oidp);
489         SYSCTL_XUNLOCK();
490         return (oidp);
491 }
492
493 /*
494  * Rename an existing oid.
495  */
496 void
497 sysctl_rename_oid(struct sysctl_oid *oidp, const char *name)
498 {
499         char *newname;
500         char *oldname;
501
502         newname = kstrdup(name, M_SYSCTLOID);
503         SYSCTL_XLOCK();
504         oldname = __DECONST(char *, oidp->oid_name);
505         oidp->oid_name = newname;
506         SYSCTL_XUNLOCK();
507         kfree(oldname, M_SYSCTLOID);
508 }
509
510 /*
511  * Register the kernel's oids on startup.
512  */
513 SET_DECLARE(sysctl_set, struct sysctl_oid);
514
515 static void
516 sysctl_register_all(void *arg)
517 {
518         struct sysctl_oid **oidp;
519
520         SYSCTL_XLOCK();
521         SET_FOREACH(oidp, sysctl_set)
522                 sysctl_register_oid(*oidp);
523         SYSCTL_XUNLOCK();
524 }
525 SYSINIT(sysctl, SI_BOOT1_POST, SI_ORDER_ANY, sysctl_register_all, 0);
526
527 /*
528  * "Staff-functions"
529  *
530  * These functions implement a presently undocumented interface 
531  * used by the sysctl program to walk the tree, and get the type
532  * so it can print the value.
533  * This interface is under work and consideration, and should probably
534  * be killed with a big axe by the first person who can find the time.
535  * (be aware though, that the proper interface isn't as obvious as it
536  * may seem, there are various conflicting requirements.
537  *
538  * {0,0}        kprintf the entire MIB-tree.
539  * {0,1,...}    return the name of the "..." OID.
540  * {0,2,...}    return the next OID.
541  * {0,3}        return the OID of the name in "new"
542  * {0,4,...}    return the kind & format info for the "..." OID.
543  */
544
545 static void
546 sysctl_sysctl_debug_dump_node(struct sysctl_oid_list *l, int i)
547 {
548         int k;
549         struct sysctl_oid *oidp;
550
551         SLIST_FOREACH(oidp, l, oid_link) {
552
553                 for (k=0; k<i; k++)
554                         kprintf(" ");
555
556                 kprintf("%d %s ", oidp->oid_number, oidp->oid_name);
557
558                 kprintf("%c%c",
559                         oidp->oid_kind & CTLFLAG_RD ? 'R':' ',
560                         oidp->oid_kind & CTLFLAG_WR ? 'W':' ');
561
562                 if (oidp->oid_handler)
563                         kprintf(" *Handler");
564
565                 switch (oidp->oid_kind & CTLTYPE) {
566                         case CTLTYPE_NODE:
567                                 kprintf(" Node\n");
568                                 if (!oidp->oid_handler) {
569                                         sysctl_sysctl_debug_dump_node(
570                                                 oidp->oid_arg1, i+2);
571                                 }
572                                 break;
573                         case CTLTYPE_INT:    kprintf(" Int\n"); break;
574                         case CTLTYPE_STRING: kprintf(" String\n"); break;
575                         case CTLTYPE_QUAD:   kprintf(" Quad\n"); break;
576                         case CTLTYPE_OPAQUE: kprintf(" Opaque/struct\n"); break;
577                         default:             kprintf("\n");
578                 }
579
580         }
581 }
582
583 static int
584 sysctl_sysctl_debug(SYSCTL_HANDLER_ARGS)
585 {
586         int error;
587
588         error = priv_check(req->td, PRIV_SYSCTL_DEBUG);
589         if (error)
590                 return (error);
591         sysctl_sysctl_debug_dump_node(&sysctl__children, 0);
592
593         return (ENOENT);
594 }
595
596 SYSCTL_PROC(_sysctl, 0, debug, CTLTYPE_STRING|CTLFLAG_RD,
597         0, 0, sysctl_sysctl_debug, "-", "");
598
599 static int
600 sysctl_sysctl_name(SYSCTL_HANDLER_ARGS)
601 {
602         int *name = (int *) arg1;
603         u_int namelen = arg2;
604         int error = 0;
605         struct sysctl_oid *oid;
606         struct sysctl_oid_list *lsp = &sysctl__children, *lsp2;
607         char buf[10];
608
609         while (namelen) {
610                 if (!lsp) {
611                         ksnprintf(buf, sizeof(buf), "%d",  *name);
612                         if (req->oldidx)
613                                 error = SYSCTL_OUT(req, ".", 1);
614                         if (!error)
615                                 error = SYSCTL_OUT(req, buf, strlen(buf));
616                         if (error)
617                                 goto out;
618                         namelen--;
619                         name++;
620                         continue;
621                 }
622                 lsp2 = NULL;
623                 SLIST_FOREACH(oid, lsp, oid_link) {
624                         if (oid->oid_number != *name)
625                                 continue;
626
627                         if (req->oldidx)
628                                 error = SYSCTL_OUT(req, ".", 1);
629                         if (!error)
630                                 error = SYSCTL_OUT(req, oid->oid_name,
631                                         strlen(oid->oid_name));
632                         if (error)
633                                 goto out;
634
635                         namelen--;
636                         name++;
637
638                         if ((oid->oid_kind & CTLTYPE) != CTLTYPE_NODE) 
639                                 break;
640
641                         if (oid->oid_handler)
642                                 break;
643
644                         lsp2 = SYSCTL_CHILDREN(oid);
645                         break;
646                 }
647                 lsp = lsp2;
648         }
649         error = SYSCTL_OUT(req, "", 1);
650  out:
651         return (error);
652 }
653
654 SYSCTL_NODE(_sysctl, 1, name, CTLFLAG_RD, sysctl_sysctl_name, "");
655
656 static int
657 sysctl_sysctl_next_ls(struct sysctl_oid_list *lsp, int *name, u_int namelen, 
658         int *next, int *len, int level, struct sysctl_oid **oidpp)
659 {
660         struct sysctl_oid *oidp;
661
662         *len = level;
663         SLIST_FOREACH(oidp, lsp, oid_link) {
664                 *next = oidp->oid_number;
665                 *oidpp = oidp;
666
667                 if (oidp->oid_kind & CTLFLAG_SKIP)
668                         continue;
669
670                 if (!namelen) {
671                         if ((oidp->oid_kind & CTLTYPE) != CTLTYPE_NODE) 
672                                 return (0);
673                         if (oidp->oid_handler) 
674                                 /* We really should call the handler here...*/
675                                 return (0);
676                         lsp = SYSCTL_CHILDREN(oidp);
677                         if (!sysctl_sysctl_next_ls(lsp, 0, 0, next+1, 
678                                 len, level+1, oidpp))
679                                 return (0);
680                         goto emptynode;
681                 }
682
683                 if (oidp->oid_number < *name)
684                         continue;
685
686                 if (oidp->oid_number > *name) {
687                         if ((oidp->oid_kind & CTLTYPE) != CTLTYPE_NODE)
688                                 return (0);
689                         if (oidp->oid_handler)
690                                 return (0);
691                         lsp = SYSCTL_CHILDREN(oidp);
692                         if (!sysctl_sysctl_next_ls(lsp, name+1, namelen-1, 
693                                 next+1, len, level+1, oidpp))
694                                 return (0);
695                         goto next;
696                 }
697                 if ((oidp->oid_kind & CTLTYPE) != CTLTYPE_NODE)
698                         continue;
699
700                 if (oidp->oid_handler)
701                         continue;
702
703                 lsp = SYSCTL_CHILDREN(oidp);
704                 if (!sysctl_sysctl_next_ls(lsp, name+1, namelen-1, next+1, 
705                         len, level+1, oidpp))
706                         return (0);
707         next:
708                 namelen = 1;
709         emptynode:
710                 *len = level;
711         }
712         return (1);
713 }
714
715 static int
716 sysctl_sysctl_next(SYSCTL_HANDLER_ARGS)
717 {
718         int *name = (int *) arg1;
719         u_int namelen = arg2;
720         int i, j, error;
721         struct sysctl_oid *oid;
722         struct sysctl_oid_list *lsp = &sysctl__children;
723         int newoid[CTL_MAXNAME];
724
725         i = sysctl_sysctl_next_ls(lsp, name, namelen, newoid, &j, 1, &oid);
726         if (i)
727                 return ENOENT;
728         error = SYSCTL_OUT(req, newoid, j * sizeof (int));
729
730         return (error);
731 }
732
733 SYSCTL_NODE(_sysctl, 2, next, CTLFLAG_RD, sysctl_sysctl_next, "");
734
735 static int
736 name2oid(char *name, int *oid, int *len, struct sysctl_oid **oidpp)
737 {
738         struct sysctl_oid *oidp;
739         struct sysctl_oid_list *lsp = &sysctl__children;
740         char *p;
741
742         SYSCTL_ASSERT_LOCKED();
743
744         for (*len = 0; *len < CTL_MAXNAME;) {
745                 p = strsep(&name, ".");
746
747                 oidp = SLIST_FIRST(lsp);
748                 for (;; oidp = SLIST_NEXT(oidp, oid_link)) {
749                         if (oidp == NULL)
750                                 return (ENOENT);
751                         if (strcmp(p, oidp->oid_name) == 0)
752                                 break;
753                 }
754                 *oid++ = oidp->oid_number;
755                 (*len)++;
756
757                 if (name == NULL || *name == '\0') {
758                         if (oidpp)
759                                 *oidpp = oidp;
760                         return (0);
761                 }
762
763                 if ((oidp->oid_kind & CTLTYPE) != CTLTYPE_NODE)
764                         break;
765
766                 if (oidp->oid_handler)
767                         break;
768
769                 lsp = SYSCTL_CHILDREN(oidp);
770         }
771         return (ENOENT);
772 }
773
774 static int
775 sysctl_sysctl_name2oid(SYSCTL_HANDLER_ARGS)
776 {
777         char *p;
778         int error, oid[CTL_MAXNAME], len;
779         struct sysctl_oid *op = NULL;
780
781         if (!req->newlen) 
782                 return ENOENT;
783         if (req->newlen >= MAXPATHLEN)  /* XXX arbitrary, undocumented */
784                 return (ENAMETOOLONG);
785
786         p = kmalloc(req->newlen+1, M_SYSCTL, M_WAITOK);
787
788         error = SYSCTL_IN(req, p, req->newlen);
789         if (error) {
790                 kfree(p, M_SYSCTL);
791                 return (error);
792         }
793
794         p [req->newlen] = '\0';
795
796         error = name2oid(p, oid, &len, &op);
797
798         kfree(p, M_SYSCTL);
799
800         if (error)
801                 return (error);
802
803         error = SYSCTL_OUT(req, oid, len * sizeof *oid);
804         return (error);
805 }
806
807 SYSCTL_PROC(_sysctl, 3, name2oid, CTLFLAG_RW|CTLFLAG_ANYBODY|CTLFLAG_SHLOCK,
808             0, 0, sysctl_sysctl_name2oid, "I", "");
809
810 static int
811 sysctl_sysctl_oidfmt(SYSCTL_HANDLER_ARGS)
812 {
813         struct sysctl_oid *oid;
814         int error;
815
816         error = sysctl_find_oid(arg1, arg2, &oid, NULL, req);
817         if (error)
818                 return (error);
819
820         if (!oid->oid_fmt)
821                 return (ENOENT);
822         error = SYSCTL_OUT(req, &oid->oid_kind, sizeof(oid->oid_kind));
823         if (error)
824                 return (error);
825         error = SYSCTL_OUT(req, oid->oid_fmt, strlen(oid->oid_fmt) + 1);
826         return (error);
827 }
828
829
830 SYSCTL_NODE(_sysctl, 4, oidfmt, CTLFLAG_RD, sysctl_sysctl_oidfmt, "");
831
832 static int
833 sysctl_sysctl_oiddescr(SYSCTL_HANDLER_ARGS)
834 {
835         struct sysctl_oid *oid;
836         int error;
837
838         error = sysctl_find_oid(arg1, arg2, &oid, NULL, req);
839         if (error)
840                 return (error);
841         
842         if (!oid->oid_descr)
843                 return (ENOENT);
844         error = SYSCTL_OUT(req, oid->oid_descr, strlen(oid->oid_descr) + 1);
845         return (error);
846 }
847
848 SYSCTL_NODE(_sysctl, 5, oiddescr, CTLFLAG_RD, sysctl_sysctl_oiddescr, "");
849
850 /*
851  * Default "handler" functions.
852  */
853
854 /*
855  * Handle an int, signed or unsigned.
856  * Two cases:
857  *     a variable:  point arg1 at it.
858  *     a constant:  pass it in arg2.
859  */
860
861 int
862 sysctl_handle_int(SYSCTL_HANDLER_ARGS)
863 {
864         int error = 0;
865
866         if (arg1)
867                 error = SYSCTL_OUT(req, arg1, sizeof(int));
868         else
869                 error = SYSCTL_OUT(req, &arg2, sizeof(int));
870
871         if (error || !req->newptr)
872                 return (error);
873
874         if (!arg1)
875                 error = EPERM;
876         else
877                 error = SYSCTL_IN(req, arg1, sizeof(int));
878         return (error);
879 }
880
881 /*
882  * Handle a long, signed or unsigned.  arg1 points to it.
883  */
884
885 int
886 sysctl_handle_long(SYSCTL_HANDLER_ARGS)
887 {
888         int error = 0;
889
890         if (!arg1)
891                 return (EINVAL);
892         error = SYSCTL_OUT(req, arg1, sizeof(long));
893
894         if (error || !req->newptr)
895                 return (error);
896
897         error = SYSCTL_IN(req, arg1, sizeof(long));
898         return (error);
899 }
900
901 /*
902  * Handle a quad, signed or unsigned.  arg1 points to it.
903  */
904
905 int
906 sysctl_handle_quad(SYSCTL_HANDLER_ARGS)
907 {
908         int error = 0;
909
910         if (!arg1)
911                 return (EINVAL);
912         error = SYSCTL_OUT(req, arg1, sizeof(quad_t));
913
914         if (error || !req->newptr)
915                 return (error);
916
917         error = SYSCTL_IN(req, arg1, sizeof(quad_t));
918         return (error);
919 }
920
921 /*
922  * Handle our generic '\0' terminated 'C' string.
923  * Two cases:
924  *      a variable string:  point arg1 at it, arg2 is max length.
925  *      a constant string:  point arg1 at it, arg2 is zero.
926  */
927
928 int
929 sysctl_handle_string(SYSCTL_HANDLER_ARGS)
930 {
931         int error=0;
932
933         error = SYSCTL_OUT(req, arg1, strlen((char *)arg1)+1);
934
935         if (error || !req->newptr)
936                 return (error);
937
938         if ((req->newlen - req->newidx) >= arg2) {
939                 error = EINVAL;
940         } else {
941                 arg2 = (req->newlen - req->newidx);
942                 error = SYSCTL_IN(req, arg1, arg2);
943                 ((char *)arg1)[arg2] = '\0';
944         }
945
946         return (error);
947 }
948
949 /*
950  * Handle any kind of opaque data.
951  * arg1 points to it, arg2 is the size.
952  */
953
954 int
955 sysctl_handle_opaque(SYSCTL_HANDLER_ARGS)
956 {
957         int error;
958
959         error = SYSCTL_OUT(req, arg1, arg2);
960
961         if (error || !req->newptr)
962                 return (error);
963
964         error = SYSCTL_IN(req, arg1, arg2);
965
966         return (error);
967 }
968
969 /*
970  * Transfer functions to/from kernel space.
971  * XXX: rather untested at this point
972  */
973 static int
974 sysctl_old_kernel(struct sysctl_req *req, const void *p, size_t l)
975 {
976         size_t i = 0;
977
978         if (req->oldptr) {
979                 i = l;
980                 if (i > req->oldlen - req->oldidx)
981                         i = req->oldlen - req->oldidx;
982                 if (i > 0)
983                         bcopy(p, (char *)req->oldptr + req->oldidx, i);
984         }
985         req->oldidx += l;
986         if (req->oldptr && i != l)
987                 return (ENOMEM);
988         return (0);
989 }
990
991 static int
992 sysctl_new_kernel(struct sysctl_req *req, void *p, size_t l)
993 {
994
995         if (!req->newptr)
996                 return 0;
997         if (req->newlen - req->newidx < l)
998                 return (EINVAL);
999         bcopy((char *)req->newptr + req->newidx, p, l);
1000         req->newidx += l;
1001         return (0);
1002 }
1003
1004 int
1005 kernel_sysctl(int *name, u_int namelen,
1006               void *old, size_t *oldlenp,
1007               void *new, size_t newlen, size_t *retval)
1008 {
1009         int error = 0;
1010         struct sysctl_req req;
1011
1012         bzero(&req, sizeof req);
1013
1014         req.td = curthread;
1015
1016         if (oldlenp) {
1017                 req.oldlen = *oldlenp;
1018         }
1019         req.validlen = req.oldlen;
1020
1021         if (old) {
1022                 req.oldptr= old;
1023         }
1024
1025         if (new != NULL) {
1026                 req.newlen = newlen;
1027                 req.newptr = new;
1028         }
1029
1030         req.oldfunc = sysctl_old_kernel;
1031         req.newfunc = sysctl_new_kernel;
1032 #if 0
1033         req.lock = REQ_UNWIRED;
1034 #endif
1035
1036         SYSCTL_SLOCK();
1037         error = sysctl_root(0, name, namelen, &req);
1038         SYSCTL_SUNLOCK();
1039
1040 #if 0
1041         if (req.lock == REQ_WIRED && req.validlen > 0)
1042                 vsunlock(req.oldptr, req.validlen);
1043 #endif
1044
1045         if (error && error != ENOMEM)
1046                 return (error);
1047
1048         if (retval) {
1049                 if (req.oldptr && req.oldidx > req.validlen)
1050                         *retval = req.validlen;
1051                 else
1052                         *retval = req.oldidx;
1053         }
1054         return (error);
1055 }
1056
1057 int
1058 kernel_sysctlbyname(char *name,
1059                     void *old, size_t *oldlenp,
1060                     void *new, size_t newlen, size_t *retval)
1061 {
1062         int oid[CTL_MAXNAME];
1063         size_t oidlen, plen;
1064         int error;
1065
1066         oid[0] = 0;             /* sysctl internal magic */
1067         oid[1] = 3;             /* name2oid */
1068         oidlen = sizeof(oid);
1069
1070         error = kernel_sysctl(oid, 2, oid, &oidlen, name, strlen(name), &plen);
1071         if (error)
1072                 return (error);
1073
1074         error = kernel_sysctl(oid, plen / sizeof(int), old, oldlenp,
1075             new, newlen, retval);
1076         return (error);
1077 }
1078
1079 /*
1080  * Transfer function to/from user space.
1081  */
1082 static int
1083 sysctl_old_user(struct sysctl_req *req, const void *p, size_t l)
1084 {
1085         int error = 0;
1086         size_t i = 0;
1087
1088 #if 0
1089         if (req->lock == 1 && req->oldptr) {
1090                 vslock(req->oldptr, req->oldlen);
1091                 req->lock = 2;
1092         }
1093 #endif
1094         if (req->oldptr) {
1095                 i = l;
1096                 if (i > req->oldlen - req->oldidx)
1097                         i = req->oldlen - req->oldidx;
1098                 if (i > 0)
1099                         error = copyout(p, (char *)req->oldptr + req->oldidx,
1100                                         i);
1101         }
1102         req->oldidx += l;
1103         if (error)
1104                 return (error);
1105         if (req->oldptr && i < l)
1106                 return (ENOMEM);
1107         return (0);
1108 }
1109
1110 static int
1111 sysctl_new_user(struct sysctl_req *req, void *p, size_t l)
1112 {
1113         int error;
1114
1115         if (!req->newptr)
1116                 return 0;
1117         if (req->newlen - req->newidx < l)
1118                 return (EINVAL);
1119         error = copyin((char *)req->newptr + req->newidx, p, l);
1120         req->newidx += l;
1121         return (error);
1122 }
1123
1124 int
1125 sysctl_find_oid(int *name, u_int namelen, struct sysctl_oid **noid,
1126                 int *nindx, struct sysctl_req *req)
1127 {
1128         struct sysctl_oid_list *lsp;
1129         struct sysctl_oid *oid;
1130         int indx;
1131
1132         lsp = &sysctl__children;
1133         indx = 0;
1134         while (indx < CTL_MAXNAME) {
1135                 SLIST_FOREACH(oid, lsp, oid_link) {
1136                         if (oid->oid_number == name[indx])
1137                                 break;
1138                 }
1139                 if (oid == NULL)
1140                         return (ENOENT);
1141
1142                 indx++;
1143                 if ((oid->oid_kind & CTLTYPE) == CTLTYPE_NODE) {
1144                         if (oid->oid_handler != NULL || indx == namelen) {
1145                                 *noid = oid;
1146                                 if (nindx != NULL)
1147                                         *nindx = indx;
1148                                 KASSERT((oid->oid_kind & CTLFLAG_DYING) == 0,
1149                                     ("%s found DYING node %p", __func__, oid));
1150                                 return (0);
1151                         }
1152                         lsp = SYSCTL_CHILDREN(oid);
1153                 } else if (indx == namelen) {
1154                         *noid = oid;
1155                         if (nindx != NULL)
1156                                 *nindx = indx;
1157                         KASSERT((oid->oid_kind & CTLFLAG_DYING) == 0,
1158                             ("%s found DYING node %p", __func__, oid));
1159                         return (0);
1160                 } else {
1161                         return (ENOTDIR);
1162                 }
1163         }
1164         return (ENOENT);
1165 }
1166
1167 /*
1168  * Traverse our tree, and find the right node, execute whatever it points
1169  * to, and return the resulting error code.
1170  */
1171 static int
1172 sysctl_root(SYSCTL_HANDLER_ARGS)
1173 {
1174         struct thread *td = req->td;
1175         struct proc *p = td ? td->td_proc : NULL;
1176         struct sysctl_oid *oid;
1177         int error, indx;
1178         int lktype;
1179
1180         error = sysctl_find_oid(arg1, arg2, &oid, &indx, req);
1181         if (error)
1182                 return (error);
1183
1184         if ((oid->oid_kind & CTLTYPE) == CTLTYPE_NODE) {
1185                 /*
1186                  * You can't call a sysctl when it's a node, but has
1187                  * no handler.  Inform the user that it's a node.
1188                  * The indx may or may not be the same as namelen.
1189                  */
1190                 if (oid->oid_handler == NULL)
1191                         return (EISDIR);
1192         }
1193
1194         /* If writing isn't allowed */
1195         if (req->newptr && (!(oid->oid_kind & CTLFLAG_WR) ||
1196             ((oid->oid_kind & CTLFLAG_SECURE) && securelevel > 0)))
1197                 return (EPERM);
1198
1199         /* Most likely only root can write */
1200         if (!(oid->oid_kind & CTLFLAG_ANYBODY) && req->newptr && p &&
1201             (error = priv_check_cred(td->td_ucred,
1202              (oid->oid_kind & CTLFLAG_PRISON) ? PRIV_SYSCTL_WRITEJAIL :
1203                                                 PRIV_SYSCTL_WRITE, 0)))
1204                 return (error);
1205
1206         if (oid->oid_handler == NULL)
1207                 return EINVAL;
1208
1209         /*
1210          * Default oid locking is exclusive when modifying (newptr),
1211          * shared otherwise, unless overridden with a control flag.
1212          */
1213         if ((oid->oid_kind & CTLFLAG_NOLOCK) == 0) {
1214                 lktype = (req->newptr != NULL) ? LK_EXCLUSIVE : LK_SHARED;
1215                 if (oid->oid_kind & CTLFLAG_SHLOCK)
1216                         lktype = LK_SHARED;
1217                 if (oid->oid_kind & CTLFLAG_EXLOCK)
1218                         lktype = LK_EXCLUSIVE;
1219 #if 1
1220                 lockmgr(&oid->oid_lock, lktype);
1221 #else
1222                 /* DEBUGGING */
1223                 if (lockmgr(&oid->oid_lock, lktype | LK_SLEEPFAIL)) {
1224                         kprintf("%s\n", oid->oid_name);
1225                         lockmgr(&oid->oid_lock, lktype);
1226                 }
1227 #endif
1228         }
1229
1230         if ((oid->oid_kind & CTLTYPE) == CTLTYPE_NODE)
1231                 error = oid->oid_handler(oid, (int *)arg1 + indx, arg2 - indx,
1232                                          req);
1233         else
1234                 error = oid->oid_handler(oid, oid->oid_arg1, oid->oid_arg2,
1235                                          req);
1236
1237         if ((oid->oid_kind & CTLFLAG_NOLOCK) == 0)
1238                 lockmgr(&oid->oid_lock, LK_RELEASE);
1239         return (error);
1240 }
1241
1242 int
1243 sys___sysctl(struct sysctl_args *uap)
1244 {
1245         int error, i, name[CTL_MAXNAME];
1246         size_t j;
1247
1248         if (uap->namelen > CTL_MAXNAME || uap->namelen < 2)
1249                 return (EINVAL);
1250
1251         error = copyin(uap->name, &name, uap->namelen * sizeof(int));
1252         if (error)
1253                 return (error);
1254
1255         error = userland_sysctl(name, uap->namelen,
1256                                 uap->old, uap->oldlenp, 0,
1257                                 uap->new, uap->newlen, &j);
1258         if (error && error != ENOMEM)
1259                 return (error);
1260         if (uap->oldlenp) {
1261                 i = copyout(&j, uap->oldlenp, sizeof(j));
1262                 if (i)
1263                         return (i);
1264         }
1265         return (error);
1266 }
1267
1268 /*
1269  * This is used from various compatibility syscalls too.  That's why name
1270  * must be in kernel space.
1271  */
1272 int
1273 userland_sysctl(int *name, u_int namelen,
1274                 void *old, size_t *oldlenp, int inkernel,
1275                 void *new, size_t newlen, size_t *retval)
1276 {
1277         int error = 0;
1278         struct sysctl_req req;
1279
1280         bzero(&req, sizeof req);
1281
1282         req.td = curthread;
1283         req.flags = 0;
1284
1285         if (oldlenp) {
1286                 if (inkernel) {
1287                         req.oldlen = *oldlenp;
1288                 } else {
1289                         error = copyin(oldlenp, &req.oldlen, sizeof(*oldlenp));
1290                         if (error)
1291                                 return (error);
1292                 }
1293         }
1294         req.validlen = req.oldlen;
1295
1296         /*
1297          * NOTE: User supplied buffers are not guaranteed to be good,
1298          *       the sysctl copyins and copyouts can fail.
1299          */
1300         if (old)
1301                 req.oldptr= old;
1302
1303         if (new != NULL) {
1304                 req.newlen = newlen;
1305                 req.newptr = new;
1306         }
1307
1308         req.oldfunc = sysctl_old_user;
1309         req.newfunc = sysctl_new_user;
1310 #if 0
1311         req.lock = REQ_UNWIRED;
1312 #endif
1313
1314 #ifdef KTRACE
1315         if (KTRPOINT(curthread, KTR_SYSCTL))
1316                 ktrsysctl(name, namelen);
1317 #endif
1318
1319         for (;;) {
1320                 req.oldidx = 0;
1321                 req.newidx = 0;
1322                 SYSCTL_SLOCK();
1323                 error = sysctl_root(0, name, namelen, &req);
1324                 SYSCTL_SUNLOCK();
1325                 if (error != EAGAIN)
1326                         break;
1327                 lwkt_yield();
1328         }
1329
1330 #if 0
1331         if (req.lock == REQ_WIRED && req.validlen > 0)
1332                 vsunlock(req.oldptr, req.validlen);
1333 #endif
1334         if (error && error != ENOMEM)
1335                 return (error);
1336
1337         if (retval) {
1338                 if (req.oldptr && req.oldidx > req.validlen)
1339                         *retval = req.validlen;
1340                 else
1341                         *retval = req.oldidx;
1342         }
1343         return (error);
1344 }
1345
1346 int
1347 sysctl_int_range(SYSCTL_HANDLER_ARGS, int low, int high)
1348 {
1349         int error, value;
1350
1351         value = *(int *)arg1;
1352         error = sysctl_handle_int(oidp, &value, 0, req);
1353         if (error || !req->newptr)
1354                 return (error);
1355         if (value < low || value > high)
1356                 return (EINVAL);
1357         *(int *)arg1 = value;
1358         return (0);
1359 }
1360
1361 /*
1362  * Drain into a sysctl struct.  The user buffer should be wired if a page
1363  * fault would cause issue.
1364  */
1365 static int
1366 sbuf_sysctl_drain(void *arg, const char *data, int len)
1367 {
1368         struct sysctl_req *req = arg;
1369         int error;
1370
1371         error = SYSCTL_OUT(req, data, len);
1372         KASSERT(error >= 0, ("Got unexpected negative value %d", error));
1373         return (error == 0 ? len : -error);
1374 }
1375
1376 struct sbuf *
1377 sbuf_new_for_sysctl(struct sbuf *s, char *buf, int length,
1378     struct sysctl_req *req)
1379 {
1380
1381         s = sbuf_new(s, buf, length, SBUF_FIXEDLEN);
1382         sbuf_set_drain(s, sbuf_sysctl_drain, req);
1383         return (s);
1384 }
1385
1386 /*
1387  * The exclusive sysctl lock only protects its topology, and is
1388  * very expensive, but allows us to use a pcpu shared lock for
1389  * critical path accesses.
1390  */
1391 void
1392 _sysctl_xlock(void)
1393 {
1394         globaldata_t gd;
1395         int i;
1396
1397         for (i = 0; i < ncpus; ++i) {
1398                 gd = globaldata_find(i);
1399                 lockmgr(&gd->gd_sysctllock, LK_EXCLUSIVE);
1400         }
1401 }
1402
1403 void
1404 _sysctl_xunlock(void)
1405 {
1406         globaldata_t gd;
1407         int i;
1408
1409         for (i = 0; i < ncpus; ++i) {
1410                 gd = globaldata_find(i);
1411                 lockmgr(&gd->gd_sysctllock, LK_RELEASE);
1412         }
1413 }