sys/kern/kern_conf.c

   1 /*-
   2  * Copyright (c) 1999-2002 Poul-Henning Kamp
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  */
  26
  27 #include <sys/cdefs.h>
  28 __FBSDID("$FreeBSD$");
  29
  30 #include <sys/param.h>
  31 #include <sys/kernel.h>
  32 #include <sys/systm.h>
  33 #include <sys/bus.h>
  34 #include <sys/bio.h>
  35 #include <sys/lock.h>
  36 #include <sys/mutex.h>
  37 #include <sys/module.h>
  38 #include <sys/malloc.h>
  39 #include <sys/conf.h>
  40 #include <sys/vnode.h>
  41 #include <sys/queue.h>
  42 #include <sys/poll.h>
  43 #include <sys/sx.h>
  44 #include <sys/ctype.h>
  45 #include <sys/ucred.h>
  46 #include <sys/taskqueue.h>
  47 #include <machine/stdarg.h>
  48
  49 #include <fs/devfs/devfs_int.h>
  50 #include <vm/vm.h>
  51
  52 static MALLOC_DEFINE(M_DEVT, "cdev", "cdev storage");
  53
  54 struct mtx devmtx;
  55 static void destroy_devl(struct cdev *dev);
  56 static int destroy_dev_sched_cbl(struct cdev *dev,
  57     void (*cb)(void *), void *arg);
  58 static int make_dev_credv(int flags, struct cdev **dres, struct cdevsw *devsw,
  59     int unit, struct ucred *cr, uid_t uid, gid_t gid, int mode, const char *fmt,
  60     va_list ap);
  61
  62 static struct cdev_priv_list cdevp_free_list =
  63     TAILQ_HEAD_INITIALIZER(cdevp_free_list);
  64 static SLIST_HEAD(free_cdevsw, cdevsw) cdevsw_gt_post_list =
  65     SLIST_HEAD_INITIALIZER(cdevsw_gt_post_list);
  66
  67 void
  68 dev_lock(void)
  69 {
  70
  71         mtx_lock(&devmtx);
  72 }
  73
  74 /*
  75  * Free all the memory collected while the cdev mutex was
  76  * locked. Since devmtx is after the system map mutex, free() cannot
  77  * be called immediately and is postponed until cdev mutex can be
  78  * dropped.
  79  */
  80 static void
  81 dev_unlock_and_free(void)
  82 {
  83         struct cdev_priv_list cdp_free;
  84         struct free_cdevsw csw_free;
  85         struct cdev_priv *cdp;
  86         struct cdevsw *csw;
  87
  88         mtx_assert(&devmtx, MA_OWNED);
  89
  90         /*
  91          * Make the local copy of the list heads while the dev_mtx is
  92          * held. Free it later.
  93          */
  94         TAILQ_INIT(&cdp_free);
  95         TAILQ_CONCAT(&cdp_free, &cdevp_free_list, cdp_list);
  96         csw_free = cdevsw_gt_post_list;
  97         SLIST_INIT(&cdevsw_gt_post_list);
  98
  99         mtx_unlock(&devmtx);
 100
 101         while ((cdp = TAILQ_FIRST(&cdp_free)) != NULL) {
 102                 TAILQ_REMOVE(&cdp_free, cdp, cdp_list);
 103                 devfs_free(&cdp->cdp_c);
 104         }
 105         while ((csw = SLIST_FIRST(&csw_free)) != NULL) {
 106                 SLIST_REMOVE_HEAD(&csw_free, d_postfree_list);
 107                 free(csw, M_DEVT);
 108         }
 109 }
 110
 111 static void
 112 dev_free_devlocked(struct cdev *cdev)
 113 {
 114         struct cdev_priv *cdp;
 115
 116         mtx_assert(&devmtx, MA_OWNED);
 117         cdp = cdev2priv(cdev);
 118         TAILQ_INSERT_HEAD(&cdevp_free_list, cdp, cdp_list);
 119 }
 120
 121 static void
 122 cdevsw_free_devlocked(struct cdevsw *csw)
 123 {
 124
 125         mtx_assert(&devmtx, MA_OWNED);
 126         SLIST_INSERT_HEAD(&cdevsw_gt_post_list, csw, d_postfree_list);
 127 }
 128
 129 void
 130 dev_unlock(void)
 131 {
 132
 133         mtx_unlock(&devmtx);
 134 }
 135
 136 void
 137 dev_ref(struct cdev *dev)
 138 {
 139
 140         mtx_assert(&devmtx, MA_NOTOWNED);
 141         mtx_lock(&devmtx);
 142         dev->si_refcount++;
 143         mtx_unlock(&devmtx);
 144 }
 145
 146 void
 147 dev_refl(struct cdev *dev)
 148 {
 149
 150         mtx_assert(&devmtx, MA_OWNED);
 151         dev->si_refcount++;
 152 }
 153
 154 void
 155 dev_rel(struct cdev *dev)
 156 {
 157         int flag = 0;
 158
 159         mtx_assert(&devmtx, MA_NOTOWNED);
 160         dev_lock();
 161         dev->si_refcount--;
 162         KASSERT(dev->si_refcount >= 0,
 163             ("dev_rel(%s) gave negative count", devtoname(dev)));
 164 #if 0
 165         if (dev->si_usecount == 0 &&
 166             (dev->si_flags & SI_CHEAPCLONE) && (dev->si_flags & SI_NAMED))
 167                 ;
 168         else
 169 #endif
 170         if (dev->si_devsw == NULL && dev->si_refcount == 0) {
 171                 LIST_REMOVE(dev, si_list);
 172                 flag = 1;
 173         }
 174         dev_unlock();
 175         if (flag)
 176                 devfs_free(dev);
 177 }
 178
 179 struct cdevsw *
 180 dev_refthread(struct cdev *dev)
 181 {
 182         struct cdevsw *csw;
 183         struct cdev_priv *cdp;
 184
 185         mtx_assert(&devmtx, MA_NOTOWNED);
 186         dev_lock();
 187         csw = dev->si_devsw;
 188         if (csw != NULL) {
 189                 cdp = cdev2priv(dev);
 190                 if ((cdp->cdp_flags & CDP_SCHED_DTR) == 0)
 191                         dev->si_threadcount++;
 192                 else
 193                         csw = NULL;
 194         }
 195         dev_unlock();
 196         return (csw);
 197 }
 198
 199 struct cdevsw *
 200 devvn_refthread(struct vnode *vp, struct cdev **devp)
 201 {
 202         struct cdevsw *csw;
 203         struct cdev_priv *cdp;
 204
 205         mtx_assert(&devmtx, MA_NOTOWNED);
 206         csw = NULL;
 207         dev_lock();
 208         *devp = vp->v_rdev;
 209         if (*devp != NULL) {
 210                 cdp = cdev2priv(*devp);
 211                 if ((cdp->cdp_flags & CDP_SCHED_DTR) == 0) {
 212                         csw = (*devp)->si_devsw;
 213                         if (csw != NULL)
 214                                 (*devp)->si_threadcount++;
 215                 }
 216         }
 217         dev_unlock();
 218         return (csw);
 219 }
 220
 221 void
 222 dev_relthread(struct cdev *dev)
 223 {
 224
 225         mtx_assert(&devmtx, MA_NOTOWNED);
 226         dev_lock();
 227         KASSERT(dev->si_threadcount > 0,
 228             ("%s threadcount is wrong", dev->si_name));
 229         dev->si_threadcount--;
 230         dev_unlock();
 231 }
 232
 233 int
 234 nullop(void)
 235 {
 236
 237         return (0);
 238 }
 239
 240 int
 241 eopnotsupp(void)
 242 {
 243
 244         return (EOPNOTSUPP);
 245 }
 246
 247 static int
 248 enxio(void)
 249 {
 250         return (ENXIO);
 251 }
 252
 253 static int
 254 enodev(void)
 255 {
 256         return (ENODEV);
 257 }
 258
 259 /* Define a dead_cdevsw for use when devices leave unexpectedly. */
 260
 261 #define dead_open       (d_open_t *)enxio
 262 #define dead_close      (d_close_t *)enxio
 263 #define dead_read       (d_read_t *)enxio
 264 #define dead_write      (d_write_t *)enxio
 265 #define dead_ioctl      (d_ioctl_t *)enxio
 266 #define dead_poll       (d_poll_t *)enodev
 267 #define dead_mmap       (d_mmap_t *)enodev
 268
 269 static void
 270 dead_strategy(struct bio *bp)
 271 {
 272
 273         biofinish(bp, NULL, ENXIO);
 274 }
 275
 276 #define dead_dump       (dumper_t *)enxio
 277 #define dead_kqfilter   (d_kqfilter_t *)enxio
 278 #define dead_mmap_single (d_mmap_single_t *)enodev
 279
 280 static struct cdevsw dead_cdevsw = {
 281         .d_version =    D_VERSION,
 282         .d_flags =      D_NEEDGIANT, /* XXX: does dead_strategy need this ? */
 283         .d_open =       dead_open,
 284         .d_close =      dead_close,
 285         .d_read =       dead_read,
 286         .d_write =      dead_write,
 287         .d_ioctl =      dead_ioctl,
 288         .d_poll =       dead_poll,
 289         .d_mmap =       dead_mmap,
 290         .d_strategy =   dead_strategy,
 291         .d_name =       "dead",
 292         .d_dump =       dead_dump,
 293         .d_kqfilter =   dead_kqfilter,
 294         .d_mmap_single = dead_mmap_single
 295 };
 296
 297 /* Default methods if driver does not specify method */
 298
 299 #define null_open       (d_open_t *)nullop
 300 #define null_close      (d_close_t *)nullop
 301 #define no_read         (d_read_t *)enodev
 302 #define no_write        (d_write_t *)enodev
 303 #define no_ioctl        (d_ioctl_t *)enodev
 304 #define no_mmap         (d_mmap2_t *)enodev
 305 #define no_kqfilter     (d_kqfilter_t *)enodev
 306 #define no_mmap_single  (d_mmap_single_t *)enodev
 307
 308 static void
 309 no_strategy(struct bio *bp)
 310 {
 311
 312         biofinish(bp, NULL, ENODEV);
 313 }
 314
 315 static int
 316 no_poll(struct cdev *dev __unused, int events, struct thread *td __unused)
 317 {
 318
 319         return (poll_no_poll(events));
 320 }
 321
 322 #define no_dump         (dumper_t *)enodev
 323
 324 static int
 325 giant_open(struct cdev *dev, int oflags, int devtype, struct thread *td)
 326 {
 327         struct cdevsw *dsw;
 328         int retval;
 329
 330         dsw = dev_refthread(dev);
 331         if (dsw == NULL)
 332                 return (ENXIO);
 333         mtx_lock(&Giant);
 334         retval = dsw->d_gianttrick->d_open(dev, oflags, devtype, td);
 335         mtx_unlock(&Giant);
 336         dev_relthread(dev);
 337         return (retval);
 338 }
 339
 340 static int
 341 giant_fdopen(struct cdev *dev, int oflags, struct thread *td, struct file *fp)
 342 {
 343         struct cdevsw *dsw;
 344         int retval;
 345
 346         dsw = dev_refthread(dev);
 347         if (dsw == NULL)
 348                 return (ENXIO);
 349         mtx_lock(&Giant);
 350         retval = dsw->d_gianttrick->d_fdopen(dev, oflags, td, fp);
 351         mtx_unlock(&Giant);
 352         dev_relthread(dev);
 353         return (retval);
 354 }
 355
 356 static int
 357 giant_close(struct cdev *dev, int fflag, int devtype, struct thread *td)
 358 {
 359         struct cdevsw *dsw;
 360         int retval;
 361
 362         dsw = dev_refthread(dev);
 363         if (dsw == NULL)
 364                 return (ENXIO);
 365         mtx_lock(&Giant);
 366         retval = dsw->d_gianttrick->d_close(dev, fflag, devtype, td);
 367         mtx_unlock(&Giant);
 368         dev_relthread(dev);
 369         return (retval);
 370 }
 371
 372 static void
 373 giant_strategy(struct bio *bp)
 374 {
 375         struct cdevsw *dsw;
 376         struct cdev *dev;
 377
 378         dev = bp->bio_dev;
 379         dsw = dev_refthread(dev);
 380         if (dsw == NULL) {
 381                 biofinish(bp, NULL, ENXIO);
 382                 return;
 383         }
 384         mtx_lock(&Giant);
 385         dsw->d_gianttrick->d_strategy(bp);
 386         mtx_unlock(&Giant);
 387         dev_relthread(dev);
 388 }
 389
 390 static int
 391 giant_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag, struct thread *td)
 392 {
 393         struct cdevsw *dsw;
 394         int retval;
 395
 396         dsw = dev_refthread(dev);
 397         if (dsw == NULL)
 398                 return (ENXIO);
 399         mtx_lock(&Giant);
 400         retval = dsw->d_gianttrick->d_ioctl(dev, cmd, data, fflag, td);
 401         mtx_unlock(&Giant);
 402         dev_relthread(dev);
 403         return (retval);
 404 }
 405
 406 static int
 407 giant_read(struct cdev *dev, struct uio *uio, int ioflag)
 408 {
 409         struct cdevsw *dsw;
 410         int retval;
 411
 412         dsw = dev_refthread(dev);
 413         if (dsw == NULL)
 414                 return (ENXIO);
 415         mtx_lock(&Giant);
 416         retval = dsw->d_gianttrick->d_read(dev, uio, ioflag);
 417         mtx_unlock(&Giant);
 418         dev_relthread(dev);
 419         return (retval);
 420 }
 421
 422 static int
 423 giant_write(struct cdev *dev, struct uio *uio, int ioflag)
 424 {
 425         struct cdevsw *dsw;
 426         int retval;
 427
 428         dsw = dev_refthread(dev);
 429         if (dsw == NULL)
 430                 return (ENXIO);
 431         mtx_lock(&Giant);
 432         retval = dsw->d_gianttrick->d_write(dev, uio, ioflag);
 433         mtx_unlock(&Giant);
 434         dev_relthread(dev);
 435         return (retval);
 436 }
 437
 438 static int
 439 giant_poll(struct cdev *dev, int events, struct thread *td)
 440 {
 441         struct cdevsw *dsw;
 442         int retval;
 443
 444         dsw = dev_refthread(dev);
 445         if (dsw == NULL)
 446                 return (ENXIO);
 447         mtx_lock(&Giant);
 448         retval = dsw->d_gianttrick->d_poll(dev, events, td);
 449         mtx_unlock(&Giant);
 450         dev_relthread(dev);
 451         return (retval);
 452 }
 453
 454 static int
 455 giant_kqfilter(struct cdev *dev, struct knote *kn)
 456 {
 457         struct cdevsw *dsw;
 458         int retval;
 459
 460         dsw = dev_refthread(dev);
 461         if (dsw == NULL)
 462                 return (ENXIO);
 463         mtx_lock(&Giant);
 464         retval = dsw->d_gianttrick->d_kqfilter(dev, kn);
 465         mtx_unlock(&Giant);
 466         dev_relthread(dev);
 467         return (retval);
 468 }
 469
 470 static int
 471 giant_mmap(struct cdev *dev, vm_offset_t offset, vm_paddr_t *paddr, int nprot,
 472     vm_memattr_t *memattr)
 473 {
 474         struct cdevsw *dsw;
 475         int retval;
 476
 477         dsw = dev_refthread(dev);
 478         if (dsw == NULL)
 479                 return (ENXIO);
 480         mtx_lock(&Giant);
 481         if (dsw->d_gianttrick->d_flags & D_MMAP2)
 482                 retval = dsw->d_gianttrick->d_mmap2(dev, offset, paddr, nprot,
 483                     memattr);
 484         else
 485                 retval = dsw->d_gianttrick->d_mmap(dev, offset, paddr, nprot);
 486         mtx_unlock(&Giant);
 487         dev_relthread(dev);
 488         return (retval);
 489 }
 490
 491 static int
 492 giant_mmap_single(struct cdev *dev, vm_ooffset_t *offset, vm_size_t size,
 493     vm_object_t *object, int nprot)
 494 {
 495         struct cdevsw *dsw;
 496         int retval;
 497
 498         dsw = dev_refthread(dev);
 499         if (dsw == NULL)
 500                 return (ENXIO);
 501         mtx_lock(&Giant);
 502         retval = dsw->d_gianttrick->d_mmap_single(dev, offset, size, object,
 503             nprot);
 504         mtx_unlock(&Giant);
 505         dev_relthread(dev);
 506         return (retval);
 507 }
 508
 509 static void
 510 notify(struct cdev *dev, const char *ev, int flags)
 511 {
 512         static const char prefix[] = "cdev=";
 513         char *data;
 514         int namelen, mflags;
 515
 516         if (cold)
 517                 return;
 518         mflags = (flags & MAKEDEV_NOWAIT) ? M_NOWAIT : M_WAITOK;
 519         namelen = strlen(dev->si_name);
 520         data = malloc(namelen + sizeof(prefix), M_TEMP, mflags);
 521         if (data == NULL)
 522                 return;
 523         memcpy(data, prefix, sizeof(prefix) - 1);
 524         memcpy(data + sizeof(prefix) - 1, dev->si_name, namelen + 1);
 525         devctl_notify_f("DEVFS", "CDEV", ev, data, mflags);
 526         free(data, M_TEMP);
 527 }
 528
 529 static void
 530 notify_create(struct cdev *dev, int flags)
 531 {
 532
 533         notify(dev, "CREATE", flags);
 534 }
 535
 536 static void
 537 notify_destroy(struct cdev *dev)
 538 {
 539
 540         notify(dev, "DESTROY", MAKEDEV_WAITOK);
 541 }
 542
 543 static struct cdev *
 544 newdev(struct cdevsw *csw, int unit, struct cdev *si)
 545 {
 546         struct cdev *si2;
 547
 548         mtx_assert(&devmtx, MA_OWNED);
 549         if (csw->d_flags & D_NEEDMINOR) {
 550                 /* We may want to return an existing device */
 551                 LIST_FOREACH(si2, &csw->d_devs, si_list) {
 552                         if (dev2unit(si2) == unit) {
 553                                 dev_free_devlocked(si);
 554                                 return (si2);
 555                         }
 556                 }
 557         }
 558         si->si_drv0 = unit;
 559         si->si_devsw = csw;
 560         LIST_INSERT_HEAD(&csw->d_devs, si, si_list);
 561         return (si);
 562 }
 563
 564 static void
 565 fini_cdevsw(struct cdevsw *devsw)
 566 {
 567         struct cdevsw *gt;
 568
 569         if (devsw->d_gianttrick != NULL) {
 570                 gt = devsw->d_gianttrick;
 571                 memcpy(devsw, gt, sizeof *devsw);
 572                 cdevsw_free_devlocked(gt);
 573                 devsw->d_gianttrick = NULL;
 574         }
 575         devsw->d_flags &= ~D_INIT;
 576 }
 577
 578 static int
 579 prep_cdevsw(struct cdevsw *devsw, int flags)
 580 {
 581         struct cdevsw *dsw2;
 582
 583         mtx_assert(&devmtx, MA_OWNED);
 584         if (devsw->d_flags & D_INIT)
 585                 return (0);
 586         if (devsw->d_flags & D_NEEDGIANT) {
 587                 dev_unlock();
 588                 dsw2 = malloc(sizeof *dsw2, M_DEVT,
 589                      (flags & MAKEDEV_NOWAIT) ? M_NOWAIT : M_WAITOK);
 590                 dev_lock();
 591                 if (dsw2 == NULL && !(devsw->d_flags & D_INIT))
 592                         return (ENOMEM);
 593         } else
 594                 dsw2 = NULL;
 595         if (devsw->d_flags & D_INIT) {
 596                 if (dsw2 != NULL)
 597                         cdevsw_free_devlocked(dsw2);
 598                 return (0);
 599         }
 600
 601         if (devsw->d_version != D_VERSION_01 &&
 602             devsw->d_version != D_VERSION_02) {
 603                 printf(
 604                     "WARNING: Device driver \"%s\" has wrong version %s\n",
 605                     devsw->d_name == NULL ? "???" : devsw->d_name,
 606                     "and is disabled.  Recompile KLD module.");
 607                 devsw->d_open = dead_open;
 608                 devsw->d_close = dead_close;
 609                 devsw->d_read = dead_read;
 610                 devsw->d_write = dead_write;
 611                 devsw->d_ioctl = dead_ioctl;
 612                 devsw->d_poll = dead_poll;
 613                 devsw->d_mmap = dead_mmap;
 614                 devsw->d_strategy = dead_strategy;
 615                 devsw->d_dump = dead_dump;
 616                 devsw->d_kqfilter = dead_kqfilter;
 617         }
 618         if (devsw->d_version == D_VERSION_01)
 619                 devsw->d_mmap_single = NULL;
 620
 621         if (devsw->d_flags & D_NEEDGIANT) {
 622                 if (devsw->d_gianttrick == NULL) {
 623                         memcpy(dsw2, devsw, sizeof *dsw2);
 624                         devsw->d_gianttrick = dsw2;
 625                         devsw->d_flags |= D_MMAP2;
 626                         dsw2 = NULL;
 627                 }
 628         }
 629
 630 #define FIXUP(member, noop, giant)                              \
 631         do {                                                    \
 632                 if (devsw->member == NULL) {                    \
 633                         devsw->member = noop;                   \
 634                 } else if (devsw->d_flags & D_NEEDGIANT)        \
 635                         devsw->member = giant;                  \
 636                 }                                               \
 637         while (0)
 638
 639         FIXUP(d_open,           null_open,      giant_open);
 640         FIXUP(d_fdopen,         NULL,           giant_fdopen);
 641         FIXUP(d_close,          null_close,     giant_close);
 642         FIXUP(d_read,           no_read,        giant_read);
 643         FIXUP(d_write,          no_write,       giant_write);
 644         FIXUP(d_ioctl,          no_ioctl,       giant_ioctl);
 645         FIXUP(d_poll,           no_poll,        giant_poll);
 646         FIXUP(d_mmap2,          no_mmap,        giant_mmap);
 647         FIXUP(d_strategy,       no_strategy,    giant_strategy);
 648         FIXUP(d_kqfilter,       no_kqfilter,    giant_kqfilter);
 649         FIXUP(d_mmap_single,    no_mmap_single, giant_mmap_single);
 650
 651         if (devsw->d_dump == NULL)      devsw->d_dump = no_dump;
 652
 653         LIST_INIT(&devsw->d_devs);
 654
 655         devsw->d_flags |= D_INIT;
 656
 657         if (dsw2 != NULL)
 658                 cdevsw_free_devlocked(dsw2);
 659         return (0);
 660 }
 661
 662 static int
 663 make_dev_credv(int flags, struct cdev **dres, struct cdevsw *devsw, int unit,
 664     struct ucred *cr, uid_t uid, gid_t gid, int mode, const char *fmt,
 665     va_list ap)
 666 {
 667         struct cdev *dev;
 668         int i, res;
 669
 670         KASSERT((flags & MAKEDEV_WAITOK) == 0 || (flags & MAKEDEV_NOWAIT) == 0,
 671             ("make_dev_credv: both WAITOK and NOWAIT specified"));
 672         dev = devfs_alloc(flags);
 673         if (dev == NULL)
 674                 return (ENOMEM);
 675         dev_lock();
 676         res = prep_cdevsw(devsw, flags);
 677         if (res != 0) {
 678                 dev_unlock();
 679                 devfs_free(dev);
 680                 return (res);
 681         }
 682         dev = newdev(devsw, unit, dev);
 683         if (flags & MAKEDEV_REF)
 684                 dev_refl(dev);
 685         if (dev->si_flags & SI_CHEAPCLONE &&
 686             dev->si_flags & SI_NAMED) {
 687                 /*
 688                  * This is allowed as it removes races and generally
 689                  * simplifies cloning devices.
 690                  * XXX: still ??
 691                  */
 692                 dev_unlock_and_free();
 693                 *dres = dev;
 694                 return (0);
 695         }
 696         KASSERT(!(dev->si_flags & SI_NAMED),
 697             ("make_dev() by driver %s on pre-existing device (min=%x, name=%s)",
 698             devsw->d_name, dev2unit(dev), devtoname(dev)));
 699
 700         i = vsnrprintf(dev->__si_namebuf, sizeof dev->__si_namebuf, 32, fmt, ap);
 701         if (i > (sizeof dev->__si_namebuf - 1)) {
 702                 printf("WARNING: Device name truncated! (%s)\n",
 703                     dev->__si_namebuf);
 704         }
 705
 706         dev->si_flags |= SI_NAMED;
 707         if (cr != NULL)
 708                 dev->si_cred = crhold(cr);
 709         dev->si_uid = uid;
 710         dev->si_gid = gid;
 711         dev->si_mode = mode;
 712
 713         devfs_create(dev);
 714         clean_unrhdrl(devfs_inos);
 715         dev_unlock_and_free();
 716
 717         notify_create(dev, flags);
 718
 719         *dres = dev;
 720         return (0);
 721 }
 722
 723 struct cdev *
 724 make_dev(struct cdevsw *devsw, int unit, uid_t uid, gid_t gid, int mode,
 725     const char *fmt, ...)
 726 {
 727         struct cdev *dev;
 728         va_list ap;
 729         int res;
 730
 731         va_start(ap, fmt);
 732         res = make_dev_credv(0, &dev, devsw, unit, NULL, uid, gid, mode, fmt,
 733             ap);
 734         va_end(ap);
 735         KASSERT(res == 0 && dev != NULL, ("make_dev: failed make_dev_credv"));
 736         return (dev);
 737 }
 738
 739 struct cdev *
 740 make_dev_cred(struct cdevsw *devsw, int unit, struct ucred *cr, uid_t uid,
 741     gid_t gid, int mode, const char *fmt, ...)
 742 {
 743         struct cdev *dev;
 744         va_list ap;
 745         int res;
 746
 747         va_start(ap, fmt);
 748         res = make_dev_credv(0, &dev, devsw, unit, cr, uid, gid, mode, fmt, ap);
 749         va_end(ap);
 750
 751         KASSERT(res == 0 && dev != NULL,
 752             ("make_dev_cred: failed make_dev_credv"));
 753         return (dev);
 754 }
 755
 756 struct cdev *
 757 make_dev_credf(int flags, struct cdevsw *devsw, int unit, struct ucred *cr,
 758     uid_t uid, gid_t gid, int mode, const char *fmt, ...)
 759 {
 760         struct cdev *dev;
 761         va_list ap;
 762         int res;
 763
 764         va_start(ap, fmt);
 765         res = make_dev_credv(flags, &dev, devsw, unit, cr, uid, gid, mode,
 766             fmt, ap);
 767         va_end(ap);
 768
 769         KASSERT((flags & MAKEDEV_NOWAIT) != 0 || res == 0,
 770             ("make_dev_credf: failed make_dev_credv"));
 771         return (res == 0 ? dev : NULL);
 772 }
 773
 774 int
 775 make_dev_p(int flags, struct cdev **cdev, struct cdevsw *devsw,
 776     struct ucred *cr, uid_t uid, gid_t gid, int mode, const char *fmt, ...)
 777 {
 778         va_list ap;
 779         int res;
 780
 781         va_start(ap, fmt);
 782         res = make_dev_credv(flags, cdev, devsw, 0, cr, uid, gid, mode,
 783             fmt, ap);
 784         va_end(ap);
 785
 786         KASSERT((flags & MAKEDEV_NOWAIT) != 0 || res == 0,
 787             ("make_dev_p: failed make_dev_credv"));
 788         return (res);
 789 }
 790
 791 static void
 792 dev_dependsl(struct cdev *pdev, struct cdev *cdev)
 793 {
 794
 795         cdev->si_parent = pdev;
 796         cdev->si_flags |= SI_CHILD;
 797         LIST_INSERT_HEAD(&pdev->si_children, cdev, si_siblings);
 798 }
 799
 800
 801 void
 802 dev_depends(struct cdev *pdev, struct cdev *cdev)
 803 {
 804
 805         dev_lock();
 806         dev_dependsl(pdev, cdev);
 807         dev_unlock();
 808 }
 809
 810 struct cdev *
 811 make_dev_alias(struct cdev *pdev, const char *fmt, ...)
 812 {
 813         struct cdev *dev;
 814         va_list ap;
 815         int i;
 816
 817         KASSERT(pdev != NULL, ("NULL pdev"));
 818         dev = devfs_alloc(MAKEDEV_WAITOK);
 819         dev_lock();
 820         dev->si_flags |= SI_ALIAS;
 821         dev->si_flags |= SI_NAMED;
 822         va_start(ap, fmt);
 823         i = vsnrprintf(dev->__si_namebuf, sizeof dev->__si_namebuf, 32, fmt, ap);
 824         if (i > (sizeof dev->__si_namebuf - 1)) {
 825                 printf("WARNING: Device name truncated! (%s)\n",
 826                     dev->__si_namebuf);
 827         }
 828         va_end(ap);
 829
 830         devfs_create(dev);
 831         dev_dependsl(pdev, dev);
 832         clean_unrhdrl(devfs_inos);
 833         dev_unlock();
 834
 835         notify_create(dev, MAKEDEV_WAITOK);
 836
 837         return (dev);
 838 }
 839
 840 static void
 841 destroy_devl(struct cdev *dev)
 842 {
 843         struct cdevsw *csw;
 844         struct cdev_privdata *p, *p1;
 845
 846         mtx_assert(&devmtx, MA_OWNED);
 847         KASSERT(dev->si_flags & SI_NAMED,
 848             ("WARNING: Driver mistake: destroy_dev on %d\n", dev2unit(dev)));
 849
 850         devfs_destroy(dev);
 851
 852         /* Remove name marking */
 853         dev->si_flags &= ~SI_NAMED;
 854
 855         /* If we are a child, remove us from the parents list */
 856         if (dev->si_flags & SI_CHILD) {
 857                 LIST_REMOVE(dev, si_siblings);
 858                 dev->si_flags &= ~SI_CHILD;
 859         }
 860
 861         /* Kill our children */
 862         while (!LIST_EMPTY(&dev->si_children))
 863                 destroy_devl(LIST_FIRST(&dev->si_children));
 864
 865         /* Remove from clone list */
 866         if (dev->si_flags & SI_CLONELIST) {
 867                 LIST_REMOVE(dev, si_clone);
 868                 dev->si_flags &= ~SI_CLONELIST;
 869         }
 870
 871         dev->si_refcount++;     /* Avoid race with dev_rel() */
 872         csw = dev->si_devsw;
 873         dev->si_devsw = NULL;   /* already NULL for SI_ALIAS */
 874         while (csw != NULL && csw->d_purge != NULL && dev->si_threadcount) {
 875                 csw->d_purge(dev);
 876                 msleep(csw, &devmtx, PRIBIO, "devprg", hz/10);
 877                 if (dev->si_threadcount)
 878                         printf("Still %lu threads in %s\n",
 879                             dev->si_threadcount, devtoname(dev));
 880         }
 881         while (dev->si_threadcount != 0) {
 882                 /* Use unique dummy wait ident */
 883                 msleep(&csw, &devmtx, PRIBIO, "devdrn", hz / 10);
 884         }
 885
 886         dev_unlock();
 887         notify_destroy(dev);
 888         mtx_lock(&cdevpriv_mtx);
 889         LIST_FOREACH_SAFE(p, &cdev2priv(dev)->cdp_fdpriv, cdpd_list, p1) {
 890                 devfs_destroy_cdevpriv(p);
 891                 mtx_lock(&cdevpriv_mtx);
 892         }
 893         mtx_unlock(&cdevpriv_mtx);
 894         dev_lock();
 895
 896         dev->si_drv1 = 0;
 897         dev->si_drv2 = 0;
 898         bzero(&dev->__si_u, sizeof(dev->__si_u));
 899
 900         if (!(dev->si_flags & SI_ALIAS)) {
 901                 /* Remove from cdevsw list */
 902                 LIST_REMOVE(dev, si_list);
 903
 904                 /* If cdevsw has no more struct cdev *'s, clean it */
 905                 if (LIST_EMPTY(&csw->d_devs)) {
 906                         fini_cdevsw(csw);
 907                         wakeup(&csw->d_devs);
 908                 }
 909         }
 910         dev->si_flags &= ~SI_ALIAS;
 911         dev->si_refcount--;     /* Avoid race with dev_rel() */
 912
 913         if (dev->si_refcount > 0) {
 914                 LIST_INSERT_HEAD(&dead_cdevsw.d_devs, dev, si_list);
 915         } else {
 916                 dev_free_devlocked(dev);
 917         }
 918 }
 919
 920 void
 921 destroy_dev(struct cdev *dev)
 922 {
 923
 924         WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL, "destroy_dev");
 925         dev_lock();
 926         destroy_devl(dev);
 927         dev_unlock_and_free();
 928 }
 929
 930 const char *
 931 devtoname(struct cdev *dev)
 932 {
 933
 934         return (dev->si_name);
 935 }
 936
 937 int
 938 dev_stdclone(char *name, char **namep, const char *stem, int *unit)
 939 {
 940         int u, i;
 941
 942         i = strlen(stem);
 943         if (bcmp(stem, name, i) != 0)
 944                 return (0);
 945         if (!isdigit(name[i]))
 946                 return (0);
 947         u = 0;
 948         if (name[i] == '0' && isdigit(name[i+1]))
 949                 return (0);
 950         while (isdigit(name[i])) {
 951                 u *= 10;
 952                 u += name[i++] - '0';
 953         }
 954         if (u > 0xffffff)
 955                 return (0);
 956         *unit = u;
 957         if (namep)
 958                 *namep = &name[i];
 959         if (name[i])
 960                 return (2);
 961         return (1);
 962 }
 963
 964 /*
 965  * Helper functions for cloning device drivers.
 966  *
 967  * The objective here is to make it unnecessary for the device drivers to
 968  * use rman or similar to manage their unit number space.  Due to the way
 969  * we do "on-demand" devices, using rman or other "private" methods
 970  * will be very tricky to lock down properly once we lock down this file.
 971  *
 972  * Instead we give the drivers these routines which puts the struct cdev *'s
 973  * that are to be managed on their own list, and gives the driver the ability
 974  * to ask for the first free unit number or a given specified unit number.
 975  *
 976  * In addition these routines support paired devices (pty, nmdm and similar)
 977  * by respecting a number of "flag" bits in the minor number.
 978  *
 979  */
 980
 981 struct clonedevs {
 982         LIST_HEAD(,cdev)        head;
 983 };
 984
 985 void
 986 clone_setup(struct clonedevs **cdp)
 987 {
 988
 989         *cdp = malloc(sizeof **cdp, M_DEVBUF, M_WAITOK | M_ZERO);
 990         LIST_INIT(&(*cdp)->head);
 991 }
 992
 993 int
 994 clone_create(struct clonedevs **cdp, struct cdevsw *csw, int *up,
 995     struct cdev **dp, int extra)
 996 {
 997         struct clonedevs *cd;
 998         struct cdev *dev, *ndev, *dl, *de;
 999         int unit, low, u;
1000
1001         KASSERT(*cdp != NULL,
1002             ("clone_setup() not called in driver \"%s\"", csw->d_name));
1003         KASSERT(!(extra & CLONE_UNITMASK),
1004             ("Illegal extra bits (0x%x) in clone_create", extra));
1005         KASSERT(*up <= CLONE_UNITMASK,
1006             ("Too high unit (0x%x) in clone_create", *up));
1007         KASSERT(csw->d_flags & D_NEEDMINOR,
1008             ("clone_create() on cdevsw without minor numbers"));
1009
1010
1011         /*
1012          * Search the list for a lot of things in one go:
1013          *   A preexisting match is returned immediately.
1014          *   The lowest free unit number if we are passed -1, and the place
1015          *       in the list where we should insert that new element.
1016          *   The place to insert a specified unit number, if applicable
1017          *       the end of the list.
1018          */
1019         unit = *up;
1020         ndev = devfs_alloc(MAKEDEV_WAITOK);
1021         dev_lock();
1022         prep_cdevsw(csw, MAKEDEV_WAITOK);
1023         low = extra;
1024         de = dl = NULL;
1025         cd = *cdp;
1026         LIST_FOREACH(dev, &cd->head, si_clone) {
1027                 KASSERT(dev->si_flags & SI_CLONELIST,
1028                     ("Dev %p(%s) should be on clonelist", dev, dev->si_name));
1029                 u = dev2unit(dev);
1030                 if (u == (unit | extra)) {
1031                         *dp = dev;
1032                         dev_unlock();
1033                         devfs_free(ndev);
1034                         return (0);
1035                 }
1036                 if (unit == -1 && u == low) {
1037                         low++;
1038                         de = dev;
1039                         continue;
1040                 } else if (u < (unit | extra)) {
1041                         de = dev;
1042                         continue;
1043                 } else if (u > (unit | extra)) {
1044                         dl = dev;
1045                         break;
1046                 }
1047         }
1048         if (unit == -1)
1049                 unit = low & CLONE_UNITMASK;
1050         dev = newdev(csw, unit | extra, ndev);
1051         if (dev->si_flags & SI_CLONELIST) {
1052                 printf("dev %p (%s) is on clonelist\n", dev, dev->si_name);
1053                 printf("unit=%d, low=%d, extra=0x%x\n", unit, low, extra);
1054                 LIST_FOREACH(dev, &cd->head, si_clone) {
1055                         printf("\t%p %s\n", dev, dev->si_name);
1056                 }
1057                 panic("foo");
1058         }
1059         KASSERT(!(dev->si_flags & SI_CLONELIST),
1060             ("Dev %p(%s) should not be on clonelist", dev, dev->si_name));
1061         if (dl != NULL)
1062                 LIST_INSERT_BEFORE(dl, dev, si_clone);
1063         else if (de != NULL)
1064                 LIST_INSERT_AFTER(de, dev, si_clone);
1065         else
1066                 LIST_INSERT_HEAD(&cd->head, dev, si_clone);
1067         dev->si_flags |= SI_CLONELIST;
1068         *up = unit;
1069         dev_unlock_and_free();
1070         return (1);
1071 }
1072
1073 /*
1074  * Kill everything still on the list.  The driver should already have
1075  * disposed of any softc hung of the struct cdev *'s at this time.
1076  */
1077 void
1078 clone_cleanup(struct clonedevs **cdp)
1079 {
1080         struct cdev *dev;
1081         struct cdev_priv *cp;
1082         struct clonedevs *cd;
1083
1084         cd = *cdp;
1085         if (cd == NULL)
1086                 return;
1087         dev_lock();
1088         while (!LIST_EMPTY(&cd->head)) {
1089                 dev = LIST_FIRST(&cd->head);
1090                 LIST_REMOVE(dev, si_clone);
1091                 KASSERT(dev->si_flags & SI_CLONELIST,
1092                     ("Dev %p(%s) should be on clonelist", dev, dev->si_name));
1093                 dev->si_flags &= ~SI_CLONELIST;
1094                 cp = cdev2priv(dev);
1095                 if (!(cp->cdp_flags & CDP_SCHED_DTR)) {
1096                         cp->cdp_flags |= CDP_SCHED_DTR;
1097                         KASSERT(dev->si_flags & SI_NAMED,
1098                                 ("Driver has goofed in cloning underways udev %x unit %x", dev2udev(dev), dev2unit(dev)));
1099                         destroy_devl(dev);
1100                 }
1101         }
1102         dev_unlock_and_free();
1103         free(cd, M_DEVBUF);
1104         *cdp = NULL;
1105 }
1106
1107 static TAILQ_HEAD(, cdev_priv) dev_ddtr =
1108         TAILQ_HEAD_INITIALIZER(dev_ddtr);
1109 static struct task dev_dtr_task;
1110
1111 static void
1112 destroy_dev_tq(void *ctx, int pending)
1113 {
1114         struct cdev_priv *cp;
1115         struct cdev *dev;
1116         void (*cb)(void *);
1117         void *cb_arg;
1118
1119         dev_lock();
1120         while (!TAILQ_EMPTY(&dev_ddtr)) {
1121                 cp = TAILQ_FIRST(&dev_ddtr);
1122                 dev = &cp->cdp_c;
1123                 KASSERT(cp->cdp_flags & CDP_SCHED_DTR,
1124                     ("cdev %p in dev_destroy_tq without CDP_SCHED_DTR", cp));
1125                 TAILQ_REMOVE(&dev_ddtr, cp, cdp_dtr_list);
1126                 cb = cp->cdp_dtr_cb;
1127                 cb_arg = cp->cdp_dtr_cb_arg;
1128                 destroy_devl(dev);
1129                 dev_unlock_and_free();
1130                 dev_rel(dev);
1131                 if (cb != NULL)
1132                         cb(cb_arg);
1133                 dev_lock();
1134         }
1135         dev_unlock();
1136 }
1137
1138 /*
1139  * devmtx shall be locked on entry. devmtx will be unlocked after
1140  * function return.
1141  */
1142 static int
1143 destroy_dev_sched_cbl(struct cdev *dev, void (*cb)(void *), void *arg)
1144 {
1145         struct cdev_priv *cp;
1146
1147         mtx_assert(&devmtx, MA_OWNED);
1148         cp = cdev2priv(dev);
1149         if (cp->cdp_flags & CDP_SCHED_DTR) {
1150                 dev_unlock();
1151                 return (0);
1152         }
1153         dev_refl(dev);
1154         cp->cdp_flags |= CDP_SCHED_DTR;
1155         cp->cdp_dtr_cb = cb;
1156         cp->cdp_dtr_cb_arg = arg;
1157         TAILQ_INSERT_TAIL(&dev_ddtr, cp, cdp_dtr_list);
1158         dev_unlock();
1159         taskqueue_enqueue(taskqueue_swi_giant, &dev_dtr_task);
1160         return (1);
1161 }
1162
1163 int
1164 destroy_dev_sched_cb(struct cdev *dev, void (*cb)(void *), void *arg)
1165 {
1166
1167         dev_lock();
1168         return (destroy_dev_sched_cbl(dev, cb, arg));
1169 }
1170
1171 int
1172 destroy_dev_sched(struct cdev *dev)
1173 {
1174
1175         return (destroy_dev_sched_cb(dev, NULL, NULL));
1176 }
1177
1178 void
1179 destroy_dev_drain(struct cdevsw *csw)
1180 {
1181
1182         dev_lock();
1183         while (!LIST_EMPTY(&csw->d_devs)) {
1184                 msleep(&csw->d_devs, &devmtx, PRIBIO, "devscd", hz/10);
1185         }
1186         dev_unlock();
1187 }
1188
1189 void
1190 drain_dev_clone_events(void)
1191 {
1192
1193         sx_xlock(&clone_drain_lock);
1194         sx_xunlock(&clone_drain_lock);
1195 }
1196
1197 static void
1198 devdtr_init(void *dummy __unused)
1199 {
1200
1201         TASK_INIT(&dev_dtr_task, 0, destroy_dev_tq, NULL);
1202 }
1203
1204 SYSINIT(devdtr, SI_SUB_DEVFS, SI_ORDER_SECOND, devdtr_init, NULL);