fs/char_dev.c

   1 /*
   2  *  linux/fs/char_dev.c
   3  *
   4  *  Copyright (C) 1991, 1992  Linus Torvalds
   5  */
   6
   7 #include <linux/init.h>
   8 #include <linux/fs.h>
   9 #include <linux/kdev_t.h>
  10 #include <linux/slab.h>
  11 #include <linux/string.h>
  12
  13 #include <linux/major.h>
  14 #include <linux/errno.h>
  15 #include <linux/module.h>
  16 #include <linux/seq_file.h>
  17
  18 #include <linux/kobject.h>
  19 #include <linux/kobj_map.h>
  20 #include <linux/cdev.h>
  21 #include <linux/mutex.h>
  22 #include <linux/backing-dev.h>
  23
  24 #include "internal.h"
  25
  26 /*
  27  * capabilities for /dev/mem, /dev/kmem and similar directly mappable character
  28  * devices
  29  * - permits shared-mmap for read, write and/or exec
  30  * - does not permit private mmap in NOMMU mode (can't do COW)
  31  * - no readahead or I/O queue unplugging required
  32  */
  33 struct backing_dev_info directly_mappable_cdev_bdi = {
  34         .name = "char",
  35         .capabilities   = (
  36 #ifdef CONFIG_MMU
  37                 /* permit private copies of the data to be taken */
  38                 BDI_CAP_MAP_COPY |
  39 #endif
  40                 /* permit direct mmap, for read, write or exec */
  41                 BDI_CAP_MAP_DIRECT |
  42                 BDI_CAP_READ_MAP | BDI_CAP_WRITE_MAP | BDI_CAP_EXEC_MAP |
  43                 /* no writeback happens */
  44                 BDI_CAP_NO_ACCT_AND_WRITEBACK),
  45 };
  46
  47 static struct kobj_map *cdev_map;
  48
  49 static DEFINE_MUTEX(chrdevs_lock);
  50
  51 static struct char_device_struct {
  52         struct char_device_struct *next;
  53         unsigned int major;
  54         unsigned int baseminor;
  55         int minorct;
  56         char name[64];
  57         struct cdev *cdev;              /* will die */
  58 } *chrdevs[CHRDEV_MAJOR_HASH_SIZE];
  59
  60 /* index in the above */
  61 static inline int major_to_index(int major)
  62 {
  63         return major % CHRDEV_MAJOR_HASH_SIZE;
  64 }
  65
  66 #ifdef CONFIG_PROC_FS
  67
  68 void chrdev_show(struct seq_file *f, off_t offset)
  69 {
  70         struct char_device_struct *cd;
  71
  72         if (offset < CHRDEV_MAJOR_HASH_SIZE) {
  73                 mutex_lock(&chrdevs_lock);
  74                 for (cd = chrdevs[offset]; cd; cd = cd->next)
  75                         seq_printf(f, "%3d %s\n", cd->major, cd->name);
  76                 mutex_unlock(&chrdevs_lock);
  77         }
  78 }
  79
  80 #endif /* CONFIG_PROC_FS */
  81
  82 /*
  83  * Register a single major with a specified minor range.
  84  *
  85  * If major == 0 this functions will dynamically allocate a major and return
  86  * its number.
  87  *
  88  * If major > 0 this function will attempt to reserve the passed range of
  89  * minors and will return zero on success.
  90  *
  91  * Returns a -ve errno on failure.
  92  */
  93 static struct char_device_struct *
  94 __register_chrdev_region(unsigned int major, unsigned int baseminor,
  95                            int minorct, const char *name)
  96 {
  97         struct char_device_struct *cd, **cp;
  98         int ret = 0;
  99         int i;
 100
 101         cd = kzalloc(sizeof(struct char_device_struct), GFP_KERNEL);
 102         if (cd == NULL)
 103                 return ERR_PTR(-ENOMEM);
 104
 105         mutex_lock(&chrdevs_lock);
 106
 107         /* temporary */
 108         if (major == 0) {
 109                 for (i = ARRAY_SIZE(chrdevs)-1; i > 0; i--) {
 110                         if (chrdevs[i] == NULL)
 111                                 break;
 112                 }
 113
 114                 if (i == 0) {
 115                         ret = -EBUSY;
 116                         goto out;
 117                 }
 118                 major = i;
 119                 ret = major;
 120         }
 121
 122         cd->major = major;
 123         cd->baseminor = baseminor;
 124         cd->minorct = minorct;
 125         strlcpy(cd->name, name, sizeof(cd->name));
 126
 127         i = major_to_index(major);
 128
 129         for (cp = &chrdevs[i]; *cp; cp = &(*cp)->next)
 130                 if ((*cp)->major > major ||
 131                     ((*cp)->major == major &&
 132                      (((*cp)->baseminor >= baseminor) ||
 133                       ((*cp)->baseminor + (*cp)->minorct > baseminor))))
 134                         break;
 135
 136         /* Check for overlapping minor ranges.  */
 137         if (*cp && (*cp)->major == major) {
 138                 int old_min = (*cp)->baseminor;
 139                 int old_max = (*cp)->baseminor + (*cp)->minorct - 1;
 140                 int new_min = baseminor;
 141                 int new_max = baseminor + minorct - 1;
 142
 143                 /* New driver overlaps from the left.  */
 144                 if (new_max >= old_min && new_max <= old_max) {
 145                         ret = -EBUSY;
 146                         goto out;
 147                 }
 148
 149                 /* New driver overlaps from the right.  */
 150                 if (new_min <= old_max && new_min >= old_min) {
 151                         ret = -EBUSY;
 152                         goto out;
 153                 }
 154         }
 155
 156         cd->next = *cp;
 157         *cp = cd;
 158         mutex_unlock(&chrdevs_lock);
 159         return cd;
 160 out:
 161         mutex_unlock(&chrdevs_lock);
 162         kfree(cd);
 163         return ERR_PTR(ret);
 164 }
 165
 166 static struct char_device_struct *
 167 __unregister_chrdev_region(unsigned major, unsigned baseminor, int minorct)
 168 {
 169         struct char_device_struct *cd = NULL, **cp;
 170         int i = major_to_index(major);
 171
 172         mutex_lock(&chrdevs_lock);
 173         for (cp = &chrdevs[i]; *cp; cp = &(*cp)->next)
 174                 if ((*cp)->major == major &&
 175                     (*cp)->baseminor == baseminor &&
 176                     (*cp)->minorct == minorct)
 177                         break;
 178         if (*cp) {
 179                 cd = *cp;
 180                 *cp = cd->next;
 181         }
 182         mutex_unlock(&chrdevs_lock);
 183         return cd;
 184 }
 185
 186 /**
 187  * register_chrdev_region() - register a range of device numbers
 188  * @from: the first in the desired range of device numbers; must include
 189  *        the major number.
 190  * @count: the number of consecutive device numbers required
 191  * @name: the name of the device or driver.
 192  *
 193  * Return value is zero on success, a negative error code on failure.
 194  */
 195 int register_chrdev_region(dev_t from, unsigned count, const char *name)
 196 {
 197         struct char_device_struct *cd;
 198         dev_t to = from + count;
 199         dev_t n, next;
 200
 201         for (n = from; n < to; n = next) {
 202                 next = MKDEV(MAJOR(n)+1, 0);
 203                 if (next > to)
 204                         next = to;
 205                 cd = __register_chrdev_region(MAJOR(n), MINOR(n),
 206                                next - n, name);
 207                 if (IS_ERR(cd))
 208                         goto fail;
 209         }
 210         return 0;
 211 fail:
 212         to = n;
 213         for (n = from; n < to; n = next) {
 214                 next = MKDEV(MAJOR(n)+1, 0);
 215                 kfree(__unregister_chrdev_region(MAJOR(n), MINOR(n), next - n));
 216         }
 217         return PTR_ERR(cd);
 218 }
 219
 220 /**
 221  * alloc_chrdev_region() - register a range of char device numbers
 222  * @dev: output parameter for first assigned number
 223  * @baseminor: first of the requested range of minor numbers
 224  * @count: the number of minor numbers required
 225  * @name: the name of the associated device or driver
 226  *
 227  * Allocates a range of char device numbers.  The major number will be
 228  * chosen dynamically, and returned (along with the first minor number)
 229  * in @dev.  Returns zero or a negative error code.
 230  */
 231 int alloc_chrdev_region(dev_t *dev, unsigned baseminor, unsigned count,
 232                         const char *name)
 233 {
 234         struct char_device_struct *cd;
 235         cd = __register_chrdev_region(0, baseminor, count, name);
 236         if (IS_ERR(cd))
 237                 return PTR_ERR(cd);
 238         *dev = MKDEV(cd->major, cd->baseminor);
 239         return 0;
 240 }
 241
 242 /**
 243  * __register_chrdev() - create and register a cdev occupying a range of minors
 244  * @major: major device number or 0 for dynamic allocation
 245  * @baseminor: first of the requested range of minor numbers
 246  * @count: the number of minor numbers required
 247  * @name: name of this range of devices
 248  * @fops: file operations associated with this devices
 249  *
 250  * If @major == 0 this functions will dynamically allocate a major and return
 251  * its number.
 252  *
 253  * If @major > 0 this function will attempt to reserve a device with the given
 254  * major number and will return zero on success.
 255  *
 256  * Returns a -ve errno on failure.
 257  *
 258  * The name of this device has nothing to do with the name of the device in
 259  * /dev. It only helps to keep track of the different owners of devices. If
 260  * your module name has only one type of devices it's ok to use e.g. the name
 261  * of the module here.
 262  */
 263 int __register_chrdev(unsigned int major, unsigned int baseminor,
 264                       unsigned int count, const char *name,
 265                       const struct file_operations *fops)
 266 {
 267         struct char_device_struct *cd;
 268         struct cdev *cdev;
 269         int err = -ENOMEM;
 270
 271         cd = __register_chrdev_region(major, baseminor, count, name);
 272         if (IS_ERR(cd))
 273                 return PTR_ERR(cd);
 274
 275         cdev = cdev_alloc();
 276         if (!cdev)
 277                 goto out2;
 278
 279         cdev->owner = fops->owner;
 280         cdev->ops = fops;
 281         kobject_set_name(&cdev->kobj, "%s", name);
 282
 283         err = cdev_add(cdev, MKDEV(cd->major, baseminor), count);
 284         if (err)
 285                 goto out;
 286
 287         cd->cdev = cdev;
 288
 289         return major ? 0 : cd->major;
 290 out:
 291         kobject_put(&cdev->kobj);
 292 out2:
 293         kfree(__unregister_chrdev_region(cd->major, baseminor, count));
 294         return err;
 295 }
 296
 297 /**
 298  * unregister_chrdev_region() - return a range of device numbers
 299  * @from: the first in the range of numbers to unregister
 300  * @count: the number of device numbers to unregister
 301  *
 302  * This function will unregister a range of @count device numbers,
 303  * starting with @from.  The caller should normally be the one who
 304  * allocated those numbers in the first place...
 305  */
 306 void unregister_chrdev_region(dev_t from, unsigned count)
 307 {
 308         dev_t to = from + count;
 309         dev_t n, next;
 310
 311         for (n = from; n < to; n = next) {
 312                 next = MKDEV(MAJOR(n)+1, 0);
 313                 if (next > to)
 314                         next = to;
 315                 kfree(__unregister_chrdev_region(MAJOR(n), MINOR(n), next - n));
 316         }
 317 }
 318
 319 /**
 320  * __unregister_chrdev - unregister and destroy a cdev
 321  * @major: major device number
 322  * @baseminor: first of the range of minor numbers
 323  * @count: the number of minor numbers this cdev is occupying
 324  * @name: name of this range of devices
 325  *
 326  * Unregister and destroy the cdev occupying the region described by
 327  * @major, @baseminor and @count.  This function undoes what
 328  * __register_chrdev() did.
 329  */
 330 void __unregister_chrdev(unsigned int major, unsigned int baseminor,
 331                          unsigned int count, const char *name)
 332 {
 333         struct char_device_struct *cd;
 334
 335         cd = __unregister_chrdev_region(major, baseminor, count);
 336         if (cd && cd->cdev)
 337                 cdev_del(cd->cdev);
 338         kfree(cd);
 339 }
 340
 341 static DEFINE_SPINLOCK(cdev_lock);
 342
 343 static struct kobject *cdev_get(struct cdev *p)
 344 {
 345         struct module *owner = p->owner;
 346         struct kobject *kobj;
 347
 348         if (owner && !try_module_get(owner))
 349                 return NULL;
 350         kobj = kobject_get(&p->kobj);
 351         if (!kobj)
 352                 module_put(owner);
 353         return kobj;
 354 }
 355
 356 void cdev_put(struct cdev *p)
 357 {
 358         if (p) {
 359                 struct module *owner = p->owner;
 360                 kobject_put(&p->kobj);
 361                 module_put(owner);
 362         }
 363 }
 364
 365 /*
 366  * Called every time a character special file is opened
 367  */
 368 static int chrdev_open(struct inode *inode, struct file *filp)
 369 {
 370         struct cdev *p;
 371         struct cdev *new = NULL;
 372         int ret = 0;
 373
 374         spin_lock(&cdev_lock);
 375         p = inode->i_cdev;
 376         if (!p) {
 377                 struct kobject *kobj;
 378                 int idx;
 379                 spin_unlock(&cdev_lock);
 380                 kobj = kobj_lookup(cdev_map, inode->i_rdev, &idx);
 381                 if (!kobj)
 382                         return -ENXIO;
 383                 new = container_of(kobj, struct cdev, kobj);
 384                 spin_lock(&cdev_lock);
 385                 /* Check i_cdev again in case somebody beat us to it while
 386                    we dropped the lock. */
 387                 p = inode->i_cdev;
 388                 if (!p) {
 389                         inode->i_cdev = p = new;
 390                         list_add(&inode->i_devices, &p->list);
 391                         new = NULL;
 392                 } else if (!cdev_get(p))
 393                         ret = -ENXIO;
 394         } else if (!cdev_get(p))
 395                 ret = -ENXIO;
 396         spin_unlock(&cdev_lock);
 397         cdev_put(new);
 398         if (ret)
 399                 return ret;
 400
 401         ret = -ENXIO;
 402         filp->f_op = fops_get(p->ops);
 403         if (!filp->f_op)
 404                 goto out_cdev_put;
 405
 406         if (filp->f_op->open) {
 407                 ret = filp->f_op->open(inode,filp);
 408                 if (ret)
 409                         goto out_cdev_put;
 410         }
 411
 412         return 0;
 413
 414  out_cdev_put:
 415         cdev_put(p);
 416         return ret;
 417 }
 418
 419 int cdev_index(struct inode *inode)
 420 {
 421         int idx;
 422         struct kobject *kobj;
 423
 424         kobj = kobj_lookup(cdev_map, inode->i_rdev, &idx);
 425         if (!kobj)
 426                 return -1;
 427         kobject_put(kobj);
 428         return idx;
 429 }
 430
 431 void cd_forget(struct inode *inode)
 432 {
 433         spin_lock(&cdev_lock);
 434         list_del_init(&inode->i_devices);
 435         inode->i_cdev = NULL;
 436         spin_unlock(&cdev_lock);
 437 }
 438
 439 static void cdev_purge(struct cdev *cdev)
 440 {
 441         spin_lock(&cdev_lock);
 442         while (!list_empty(&cdev->list)) {
 443                 struct inode *inode;
 444                 inode = container_of(cdev->list.next, struct inode, i_devices);
 445                 list_del_init(&inode->i_devices);
 446                 inode->i_cdev = NULL;
 447         }
 448         spin_unlock(&cdev_lock);
 449 }
 450
 451 /*
 452  * Dummy default file-operations: the only thing this does
 453  * is contain the open that then fills in the correct operations
 454  * depending on the special file...
 455  */
 456 const struct file_operations def_chr_fops = {
 457         .open = chrdev_open,
 458 };
 459
 460 static struct kobject *exact_match(dev_t dev, int *part, void *data)
 461 {
 462         struct cdev *p = data;
 463         return &p->kobj;
 464 }
 465
 466 static int exact_lock(dev_t dev, void *data)
 467 {
 468         struct cdev *p = data;
 469         return cdev_get(p) ? 0 : -1;
 470 }
 471
 472 /**
 473  * cdev_add() - add a char device to the system
 474  * @p: the cdev structure for the device
 475  * @dev: the first device number for which this device is responsible
 476  * @count: the number of consecutive minor numbers corresponding to this
 477  *         device
 478  *
 479  * cdev_add() adds the device represented by @p to the system, making it
 480  * live immediately.  A negative error code is returned on failure.
 481  */
 482 int cdev_add(struct cdev *p, dev_t dev, unsigned count)
 483 {
 484         p->dev = dev;
 485         p->count = count;
 486         return kobj_map(cdev_map, dev, count, NULL, exact_match, exact_lock, p);
 487 }
 488
 489 static void cdev_unmap(dev_t dev, unsigned count)
 490 {
 491         kobj_unmap(cdev_map, dev, count);
 492 }
 493
 494 /**
 495  * cdev_del() - remove a cdev from the system
 496  * @p: the cdev structure to be removed
 497  *
 498  * cdev_del() removes @p from the system, possibly freeing the structure
 499  * itself.
 500  */
 501 void cdev_del(struct cdev *p)
 502 {
 503         cdev_unmap(p->dev, p->count);
 504         kobject_put(&p->kobj);
 505 }
 506
 507
 508 static void cdev_default_release(struct kobject *kobj)
 509 {
 510         struct cdev *p = container_of(kobj, struct cdev, kobj);
 511         cdev_purge(p);
 512 }
 513
 514 static void cdev_dynamic_release(struct kobject *kobj)
 515 {
 516         struct cdev *p = container_of(kobj, struct cdev, kobj);
 517         cdev_purge(p);
 518         kfree(p);
 519 }
 520
 521 static struct kobj_type ktype_cdev_default = {
 522         .release        = cdev_default_release,
 523 };
 524
 525 static struct kobj_type ktype_cdev_dynamic = {
 526         .release        = cdev_dynamic_release,
 527 };
 528
 529 /**
 530  * cdev_alloc() - allocate a cdev structure
 531  *
 532  * Allocates and returns a cdev structure, or NULL on failure.
 533  */
 534 struct cdev *cdev_alloc(void)
 535 {
 536         struct cdev *p = kzalloc(sizeof(struct cdev), GFP_KERNEL);
 537         if (p) {
 538                 INIT_LIST_HEAD(&p->list);
 539                 kobject_init(&p->kobj, &ktype_cdev_dynamic);
 540         }
 541         return p;
 542 }
 543
 544 /**
 545  * cdev_init() - initialize a cdev structure
 546  * @cdev: the structure to initialize
 547  * @fops: the file_operations for this device
 548  *
 549  * Initializes @cdev, remembering @fops, making it ready to add to the
 550  * system with cdev_add().
 551  */
 552 void cdev_init(struct cdev *cdev, const struct file_operations *fops)
 553 {
 554         memset(cdev, 0, sizeof *cdev);
 555         INIT_LIST_HEAD(&cdev->list);
 556         kobject_init(&cdev->kobj, &ktype_cdev_default);
 557         cdev->ops = fops;
 558 }
 559
 560 static struct kobject *base_probe(dev_t dev, int *part, void *data)
 561 {
 562         if (request_module("char-major-%d-%d", MAJOR(dev), MINOR(dev)) > 0)
 563                 /* Make old-style 2.4 aliases work */
 564                 request_module("char-major-%d", MAJOR(dev));
 565         return NULL;
 566 }
 567
 568 void __init chrdev_init(void)
 569 {
 570         cdev_map = kobj_map_init(base_probe, &chrdevs_lock);
 571         bdi_init(&directly_mappable_cdev_bdi);
 572 }
 573
 574
 575 /* Let modules do char dev stuff */
 576 EXPORT_SYMBOL(register_chrdev_region);
 577 EXPORT_SYMBOL(unregister_chrdev_region);
 578 EXPORT_SYMBOL(alloc_chrdev_region);
 579 EXPORT_SYMBOL(cdev_init);
 580 EXPORT_SYMBOL(cdev_alloc);
 581 EXPORT_SYMBOL(cdev_del);
 582 EXPORT_SYMBOL(cdev_add);
 583 EXPORT_SYMBOL(cdev_index);
 584 EXPORT_SYMBOL(__register_chrdev);
 585 EXPORT_SYMBOL(__unregister_chrdev);
 586 EXPORT_SYMBOL(directly_mappable_cdev_bdi);