1 /*- 2 * Parts Copyright (c) 1995 Terrence R. Lambert 3 * Copyright (c) 1995 Julian R. Elischer 4 * All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 3. All advertising materials mentioning features or use of this software 15 * must display the following acknowledgement: 16 * This product includes software developed by Terrence R. Lambert. 17 * 4. The name Terrence R. Lambert may not be used to endorse or promote 18 * products derived from this software without specific prior written 19 * permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY Julian R. Elischer ``AS IS'' AND ANY 22 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24 * ARE DISCLAIMED. IN NO EVENT SHALL THE TERRENCE R. LAMBERT BE LIABLE 25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * $FreeBSD$ 34 */ 35 36 #include <sys/param.h> 37 #include <sys/kernel.h> 38 #include <sys/systm.h> 39 #include <sys/sysctl.h> 40 #include <sys/module.h> 41 #include <sys/malloc.h> 42 #include <sys/conf.h> 43 #include <sys/vnode.h> 44 #include <sys/queue.h> 45 #include <sys/ctype.h> 46 #include <machine/stdarg.h> 47 48 #define cdevsw_ALLOCSTART (NUMCDEVSW/2) 49 50 static struct cdevsw *cdevsw[NUMCDEVSW]; 51 52 static MALLOC_DEFINE(M_DEVT, "dev_t", "dev_t storage"); 53 54 /* 55 * This is the number of hash-buckets. Experiements with 'real-life' 56 * udev_t's show that a prime halfway between two powers of two works 57 * best. 58 */ 59 #define DEVT_HASH 83 60 61 /* The number of dev_t's we can create before malloc(9) kick in. */ 62 #define DEVT_STASH 50 63 64 static struct specinfo devt_stash[DEVT_STASH]; 65 66 static LIST_HEAD(, specinfo) dev_hash[DEVT_HASH]; 67 68 static LIST_HEAD(, specinfo) dev_free; 69 70 devfs_create_t *devfs_create_hook; 71 devfs_destroy_t *devfs_destroy_hook; 72 int devfs_present; 73 74 static int ready_for_devs; 75 76 static int free_devt; 77 SYSCTL_INT(_debug, OID_AUTO, free_devt, CTLFLAG_RW, &free_devt, 0, ""); 78 79 /* XXX: This is a hack */ 80 void disk_dev_synth(dev_t dev); 81 82 struct cdevsw * 83 devsw(dev_t dev) 84 { 85 if (dev->si_devsw) 86 return (dev->si_devsw); 87 /* XXX: Hack around our backwards disk code */ 88 disk_dev_synth(dev); 89 if (dev->si_devsw) 90 return (dev->si_devsw); 91 if (devfs_present) 92 return (NULL); 93 return(cdevsw[major(dev)]); 94 } 95 96 /* 97 * Add a cdevsw entry 98 */ 99 100 int 101 cdevsw_add(struct cdevsw *newentry) 102 { 103 104 if (newentry->d_maj < 0 || newentry->d_maj >= NUMCDEVSW) { 105 printf("%s: ERROR: driver has bogus cdevsw->d_maj = %d\n", 106 newentry->d_name, newentry->d_maj); 107 return (EINVAL); 108 } 109 110 if (cdevsw[newentry->d_maj]) { 111 printf("WARNING: \"%s\" is usurping \"%s\"'s cdevsw[]\n", 112 newentry->d_name, cdevsw[newentry->d_maj]->d_name); 113 } 114 115 cdevsw[newentry->d_maj] = newentry; 116 117 return (0); 118 } 119 120 /* 121 * Remove a cdevsw entry 122 */ 123 124 int 125 cdevsw_remove(struct cdevsw *oldentry) 126 { 127 if (oldentry->d_maj < 0 || oldentry->d_maj >= NUMCDEVSW) { 128 printf("%s: ERROR: driver has bogus cdevsw->d_maj = %d\n", 129 oldentry->d_name, oldentry->d_maj); 130 return EINVAL; 131 } 132 133 cdevsw[oldentry->d_maj] = NULL; 134 135 return 0; 136 } 137 138 /* 139 * dev_t and u_dev_t primitives 140 */ 141 142 int 143 major(dev_t x) 144 { 145 if (x == NODEV) 146 return NOUDEV; 147 return((x->si_udev >> 8) & 0xff); 148 } 149 150 int 151 minor(dev_t x) 152 { 153 if (x == NODEV) 154 return NOUDEV; 155 return(x->si_udev & 0xffff00ff); 156 } 157 158 int 159 dev2unit(dev_t x) 160 { 161 int i; 162 163 if (x == NODEV) 164 return NOUDEV; 165 i = minor(x); 166 return ((i & 0xff) | (i >> 8)); 167 } 168 169 int 170 unit2minor(int unit) 171 { 172 173 KASSERT(unit <= 0xffffff, ("Invalid unit (%d) in unit2minor", unit)); 174 return ((unit & 0xff) | ((unit << 8) & ~0xffff)); 175 } 176 177 static dev_t 178 allocdev(void) 179 { 180 static int stashed; 181 struct specinfo *si; 182 183 if (stashed >= DEVT_STASH) { 184 MALLOC(si, struct specinfo *, sizeof(*si), M_DEVT, 185 M_USE_RESERVE | M_ZERO); 186 } else if (LIST_FIRST(&dev_free)) { 187 si = LIST_FIRST(&dev_free); 188 LIST_REMOVE(si, si_hash); 189 } else { 190 si = devt_stash + stashed++; 191 bzero(si, sizeof *si); 192 si->si_flags |= SI_STASHED; 193 } 194 LIST_INIT(&si->si_children); 195 TAILQ_INIT(&si->si_snapshots); 196 return (si); 197 } 198 199 dev_t 200 makedev(int x, int y) 201 { 202 struct specinfo *si; 203 udev_t udev; 204 int hash; 205 206 if (x == umajor(NOUDEV) && y == uminor(NOUDEV)) 207 panic("makedev of NOUDEV"); 208 udev = (x << 8) | y; 209 hash = udev % DEVT_HASH; 210 LIST_FOREACH(si, &dev_hash[hash], si_hash) { 211 if (si->si_udev == udev) 212 return (si); 213 } 214 si = allocdev(); 215 si->si_udev = udev; 216 LIST_INSERT_HEAD(&dev_hash[hash], si, si_hash); 217 return (si); 218 } 219 220 void 221 freedev(dev_t dev) 222 { 223 224 if (!free_devt) 225 return; 226 if (SLIST_FIRST(&dev->si_hlist)) 227 return; 228 if (dev->si_devsw || dev->si_drv1 || dev->si_drv2) 229 return; 230 LIST_REMOVE(dev, si_hash); 231 if (dev->si_flags & SI_STASHED) { 232 bzero(dev, sizeof(*dev)); 233 dev->si_flags |= SI_STASHED; 234 LIST_INSERT_HEAD(&dev_free, dev, si_hash); 235 } else { 236 FREE(dev, M_DEVT); 237 } 238 } 239 240 udev_t 241 dev2udev(dev_t x) 242 { 243 if (x == NODEV) 244 return NOUDEV; 245 return (x->si_udev); 246 } 247 248 dev_t 249 udev2dev(udev_t x, int b) 250 { 251 252 if (x == NOUDEV) 253 return (NODEV); 254 switch (b) { 255 case 0: 256 return makedev(umajor(x), uminor(x)); 257 case 1: 258 return (NODEV); 259 default: 260 Debugger("udev2dev(...,X)"); 261 return NODEV; 262 } 263 } 264 265 int 266 uminor(udev_t dev) 267 { 268 return(dev & 0xffff00ff); 269 } 270 271 int 272 umajor(udev_t dev) 273 { 274 return((dev & 0xff00) >> 8); 275 } 276 277 udev_t 278 makeudev(int x, int y) 279 { 280 return ((x << 8) | y); 281 } 282 283 dev_t 284 make_dev(struct cdevsw *devsw, int minor, uid_t uid, gid_t gid, int perms, const char *fmt, ...) 285 { 286 dev_t dev; 287 va_list ap; 288 int i; 289 290 KASSERT(umajor(makeudev(devsw->d_maj, minor)) == devsw->d_maj, 291 ("Invalid minor (%d) in make_dev", minor)); 292 293 if (!ready_for_devs) { 294 printf("WARNING: Driver mistake: make_dev(%s) called before SI_SUB_DRIVERS\n", 295 fmt); 296 /* XXX panic here once drivers are cleaned up */ 297 } 298 299 dev = makedev(devsw->d_maj, minor); 300 if (dev->si_flags & SI_NAMED) { 301 printf( "WARNING: Driver mistake: repeat make_dev(\"%s\")\n", 302 dev->si_name); 303 panic("don't do that"); 304 return (dev); 305 } 306 va_start(ap, fmt); 307 i = kvprintf(fmt, NULL, dev->si_name, 32, ap); 308 dev->si_name[i] = '\0'; 309 va_end(ap); 310 dev->si_devsw = devsw; 311 dev->si_uid = uid; 312 dev->si_gid = gid; 313 dev->si_mode = perms; 314 dev->si_flags |= SI_NAMED; 315 316 if (devfs_create_hook) 317 devfs_create_hook(dev); 318 return (dev); 319 } 320 321 int 322 dev_named(dev_t pdev, const char *name) 323 { 324 dev_t cdev; 325 326 if (strcmp(devtoname(pdev), name) == 0) 327 return (1); 328 LIST_FOREACH(cdev, &pdev->si_children, si_siblings) 329 if (strcmp(devtoname(cdev), name) == 0) 330 return (1); 331 return (0); 332 } 333 334 void 335 dev_depends(dev_t pdev, dev_t cdev) 336 { 337 338 cdev->si_parent = pdev; 339 cdev->si_flags |= SI_CHILD; 340 LIST_INSERT_HEAD(&pdev->si_children, cdev, si_siblings); 341 } 342 343 dev_t 344 make_dev_alias(dev_t pdev, const char *fmt, ...) 345 { 346 dev_t dev; 347 va_list ap; 348 int i; 349 350 dev = allocdev(); 351 dev->si_flags |= SI_ALIAS; 352 dev->si_flags |= SI_NAMED; 353 dev_depends(pdev, dev); 354 va_start(ap, fmt); 355 i = kvprintf(fmt, NULL, dev->si_name, 32, ap); 356 dev->si_name[i] = '\0'; 357 va_end(ap); 358 359 if (devfs_create_hook) 360 devfs_create_hook(dev); 361 return (dev); 362 } 363 364 void 365 destroy_dev(dev_t dev) 366 { 367 368 if (!(dev->si_flags & SI_NAMED)) { 369 printf( "WARNING: Driver mistake: destroy_dev on %d/%d\n", 370 major(dev), minor(dev)); 371 panic("don't do that"); 372 return; 373 } 374 375 if (devfs_destroy_hook) 376 devfs_destroy_hook(dev); 377 if (dev->si_flags & SI_CHILD) { 378 LIST_REMOVE(dev, si_siblings); 379 dev->si_flags &= ~SI_CHILD; 380 } 381 while (!LIST_EMPTY(&dev->si_children)) 382 destroy_dev(LIST_FIRST(&dev->si_children)); 383 dev->si_drv1 = 0; 384 dev->si_drv2 = 0; 385 dev->si_devsw = 0; 386 dev->si_flags &= ~SI_NAMED; 387 dev->si_flags &= ~SI_ALIAS; 388 freedev(dev); 389 } 390 391 const char * 392 devtoname(dev_t dev) 393 { 394 char *p; 395 int mynor; 396 397 if (dev->si_name[0] == '#' || dev->si_name[0] == '\0') { 398 p = dev->si_name; 399 if (devsw(dev)) 400 sprintf(p, "#%s/", devsw(dev)->d_name); 401 else 402 sprintf(p, "#%d/", major(dev)); 403 p += strlen(p); 404 mynor = minor(dev); 405 if (mynor < 0 || mynor > 255) 406 sprintf(p, "%#x", (u_int)mynor); 407 else 408 sprintf(p, "%d", mynor); 409 } 410 return (dev->si_name); 411 } 412 413 int 414 dev_stdclone(char *name, char **namep, char *stem, int *unit) 415 { 416 int u, i; 417 418 i = strlen(stem); 419 if (bcmp(stem, name, i) != 0) 420 return (0); 421 if (!isdigit(name[i])) 422 return (0); 423 u = 0; 424 if (name[i] == '0' && isdigit(name[i+1])) 425 return (0); 426 while (isdigit(name[i])) { 427 u *= 10; 428 u += name[i++] - '0'; 429 } 430 *unit = u; 431 if (namep) 432 *namep = &name[i]; 433 if (name[i]) 434 return (2); 435 return (1); 436 } 437 438 /* 439 * Helper sysctl for devname(3). We're given a {u}dev_t and return 440 * the name, if any, registered by the device driver. 441 */ 442 static int 443 sysctl_devname(SYSCTL_HANDLER_ARGS) 444 { 445 int error; 446 udev_t ud; 447 dev_t dev; 448 449 error = SYSCTL_IN(req, &ud, sizeof (ud)); 450 if (error) 451 return (error); 452 if (ud == NOUDEV) 453 return(EINVAL); 454 dev = makedev(umajor(ud), uminor(ud)); 455 if (dev->si_name[0] == '\0') 456 error = ENOENT; 457 else 458 error = SYSCTL_OUT(req, dev->si_name, strlen(dev->si_name) + 1); 459 freedev(dev); 460 return (error); 461 } 462 463 SYSCTL_PROC(_kern, OID_AUTO, devname, CTLTYPE_OPAQUE|CTLFLAG_RW|CTLFLAG_ANYBODY, 464 NULL, 0, sysctl_devname, "", "devname(3) handler"); 465 466 /* 467 * Set ready_for_devs; prior to this point, device creation is not allowed. 468 */ 469 static void 470 dev_set_ready(void *junk) 471 { 472 ready_for_devs = 1; 473 } 474 475 SYSINIT(dev_ready, SI_SUB_DEVFS, SI_ORDER_FIRST, dev_set_ready, NULL); 476