1 /*****************************************************************************/
4 * inode.c -- Inode/Dentry functions for the USB device file system.
6 * Copyright (C) 2000 Thomas Sailer (sailer@ife.ee.ethz.ch)
7 * Copyright (C) 2001,2002,2004 Greg Kroah-Hartman (greg@kroah.com)
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 * 0.1 04.01.2000 Created
25 * 0.2 10.12.2001 converted to use the vfs layer better
28 /*****************************************************************************/
30 #include <linux/module.h>
32 #include <linux/mount.h>
33 #include <linux/pagemap.h>
34 #include <linux/init.h>
35 #include <linux/proc_fs.h>
36 #include <linux/usb.h>
37 #include <linux/namei.h>
38 #include <linux/usbdevice_fs.h>
39 #include <linux/parser.h>
40 #include <linux/notifier.h>
41 #include <linux/seq_file.h>
42 #include <asm/byteorder.h>
46 #define USBFS_DEFAULT_DEVMODE (S_IWUSR | S_IRUGO)
47 #define USBFS_DEFAULT_BUSMODE (S_IXUGO | S_IRUGO)
48 #define USBFS_DEFAULT_LISTMODE S_IRUGO
50 static struct super_operations usbfs_ops;
51 static const struct file_operations default_file_operations;
52 static struct vfsmount *usbfs_mount;
53 static int usbfs_mount_count; /* = 0 */
54 static int ignore_mount = 0;
56 static struct dentry *devices_usbfs_dentry;
57 static int num_buses; /* = 0 */
59 static uid_t devuid; /* = 0 */
60 static uid_t busuid; /* = 0 */
61 static uid_t listuid; /* = 0 */
62 static gid_t devgid; /* = 0 */
63 static gid_t busgid; /* = 0 */
64 static gid_t listgid; /* = 0 */
65 static umode_t devmode = USBFS_DEFAULT_DEVMODE;
66 static umode_t busmode = USBFS_DEFAULT_BUSMODE;
67 static umode_t listmode = USBFS_DEFAULT_LISTMODE;
69 static int usbfs_show_options(struct seq_file *seq, struct vfsmount *mnt)
72 seq_printf(seq, ",devuid=%u", devuid);
74 seq_printf(seq, ",devgid=%u", devgid);
75 if (devmode != USBFS_DEFAULT_DEVMODE)
76 seq_printf(seq, ",devmode=%o", devmode);
78 seq_printf(seq, ",busuid=%u", busuid);
80 seq_printf(seq, ",busgid=%u", busgid);
81 if (busmode != USBFS_DEFAULT_BUSMODE)
82 seq_printf(seq, ",busmode=%o", busmode);
84 seq_printf(seq, ",listuid=%u", listuid);
86 seq_printf(seq, ",listgid=%u", listgid);
87 if (listmode != USBFS_DEFAULT_LISTMODE)
88 seq_printf(seq, ",listmode=%o", listmode);
94 Opt_devuid, Opt_devgid, Opt_devmode,
95 Opt_busuid, Opt_busgid, Opt_busmode,
96 Opt_listuid, Opt_listgid, Opt_listmode,
100 static const match_table_t tokens = {
101 {Opt_devuid, "devuid=%u"},
102 {Opt_devgid, "devgid=%u"},
103 {Opt_devmode, "devmode=%o"},
104 {Opt_busuid, "busuid=%u"},
105 {Opt_busgid, "busgid=%u"},
106 {Opt_busmode, "busmode=%o"},
107 {Opt_listuid, "listuid=%u"},
108 {Opt_listgid, "listgid=%u"},
109 {Opt_listmode, "listmode=%o"},
113 static int parse_options(struct super_block *s, char *data)
118 /* (re)set to defaults. */
125 devmode = USBFS_DEFAULT_DEVMODE;
126 busmode = USBFS_DEFAULT_BUSMODE;
127 listmode = USBFS_DEFAULT_LISTMODE;
129 while ((p = strsep(&data, ",")) != NULL) {
130 substring_t args[MAX_OPT_ARGS];
135 token = match_token(p, tokens, args);
138 if (match_int(&args[0], &option))
143 if (match_int(&args[0], &option))
148 if (match_octal(&args[0], &option))
150 devmode = option & S_IRWXUGO;
153 if (match_int(&args[0], &option))
158 if (match_int(&args[0], &option))
163 if (match_octal(&args[0], &option))
165 busmode = option & S_IRWXUGO;
168 if (match_int(&args[0], &option))
173 if (match_int(&args[0], &option))
178 if (match_octal(&args[0], &option))
180 listmode = option & S_IRWXUGO;
183 printk(KERN_ERR "usbfs: unrecognised mount option "
184 "\"%s\" or missing value\n", p);
192 static void update_special(struct dentry *special)
194 special->d_inode->i_uid = listuid;
195 special->d_inode->i_gid = listgid;
196 special->d_inode->i_mode = S_IFREG | listmode;
199 static void update_dev(struct dentry *dev)
201 dev->d_inode->i_uid = devuid;
202 dev->d_inode->i_gid = devgid;
203 dev->d_inode->i_mode = S_IFREG | devmode;
206 static void update_bus(struct dentry *bus)
208 struct dentry *dev = NULL;
210 bus->d_inode->i_uid = busuid;
211 bus->d_inode->i_gid = busgid;
212 bus->d_inode->i_mode = S_IFDIR | busmode;
214 mutex_lock(&bus->d_inode->i_mutex);
216 list_for_each_entry(dev, &bus->d_subdirs, d_u.d_child)
220 mutex_unlock(&bus->d_inode->i_mutex);
223 static void update_sb(struct super_block *sb)
225 struct dentry *root = sb->s_root;
226 struct dentry *bus = NULL;
231 mutex_lock_nested(&root->d_inode->i_mutex, I_MUTEX_PARENT);
233 list_for_each_entry(bus, &root->d_subdirs, d_u.d_child) {
235 switch (S_IFMT & bus->d_inode->i_mode) {
243 printk(KERN_WARNING "usbfs: Unknown node %s "
244 "mode %x found on remount!\n",
245 bus->d_name.name, bus->d_inode->i_mode);
251 mutex_unlock(&root->d_inode->i_mutex);
254 static int remount(struct super_block *sb, int *flags, char *data)
256 /* If this is not a real mount,
257 * i.e. it's a simple_pin_fs from create_special_files,
263 if (parse_options(sb, data)) {
264 printk(KERN_WARNING "usbfs: mount parameter error.\n");
268 if (usbfs_mount && usbfs_mount->mnt_sb)
269 update_sb(usbfs_mount->mnt_sb);
274 static struct inode *usbfs_get_inode (struct super_block *sb, int mode, dev_t dev)
276 struct inode *inode = new_inode(sb);
279 inode->i_mode = mode;
280 inode->i_uid = current_fsuid();
281 inode->i_gid = current_fsgid();
282 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
283 switch (mode & S_IFMT) {
285 init_special_inode(inode, mode, dev);
288 inode->i_fop = &default_file_operations;
291 inode->i_op = &simple_dir_inode_operations;
292 inode->i_fop = &simple_dir_operations;
294 /* directory inodes start off with i_nlink == 2 (for "." entry) */
303 static int usbfs_mknod (struct inode *dir, struct dentry *dentry, int mode,
306 struct inode *inode = usbfs_get_inode(dir->i_sb, mode, dev);
313 d_instantiate(dentry, inode);
320 static int usbfs_mkdir (struct inode *dir, struct dentry *dentry, int mode)
324 mode = (mode & (S_IRWXUGO | S_ISVTX)) | S_IFDIR;
325 res = usbfs_mknod (dir, dentry, mode, 0);
331 static int usbfs_create (struct inode *dir, struct dentry *dentry, int mode)
333 mode = (mode & S_IALLUGO) | S_IFREG;
334 return usbfs_mknod (dir, dentry, mode, 0);
337 static inline int usbfs_positive (struct dentry *dentry)
339 return dentry->d_inode && !d_unhashed(dentry);
342 static int usbfs_empty (struct dentry *dentry)
344 struct list_head *list;
346 spin_lock(&dcache_lock);
348 list_for_each(list, &dentry->d_subdirs) {
349 struct dentry *de = list_entry(list, struct dentry, d_u.d_child);
350 if (usbfs_positive(de)) {
351 spin_unlock(&dcache_lock);
356 spin_unlock(&dcache_lock);
360 static int usbfs_unlink (struct inode *dir, struct dentry *dentry)
362 struct inode *inode = dentry->d_inode;
363 mutex_lock(&inode->i_mutex);
364 drop_nlink(dentry->d_inode);
366 mutex_unlock(&inode->i_mutex);
371 static int usbfs_rmdir(struct inode *dir, struct dentry *dentry)
373 int error = -ENOTEMPTY;
374 struct inode * inode = dentry->d_inode;
376 mutex_lock(&inode->i_mutex);
377 dentry_unhash(dentry);
378 if (usbfs_empty(dentry)) {
379 drop_nlink(dentry->d_inode);
380 drop_nlink(dentry->d_inode);
382 inode->i_flags |= S_DEAD;
386 mutex_unlock(&inode->i_mutex);
394 /* default file operations */
395 static ssize_t default_read_file (struct file *file, char __user *buf,
396 size_t count, loff_t *ppos)
401 static ssize_t default_write_file (struct file *file, const char __user *buf,
402 size_t count, loff_t *ppos)
407 static loff_t default_file_lseek (struct file *file, loff_t offset, int orig)
409 loff_t retval = -EINVAL;
411 mutex_lock(&file->f_path.dentry->d_inode->i_mutex);
415 file->f_pos = offset;
416 retval = file->f_pos;
420 if ((offset + file->f_pos) > 0) {
421 file->f_pos += offset;
422 retval = file->f_pos;
428 mutex_unlock(&file->f_path.dentry->d_inode->i_mutex);
432 static int default_open (struct inode *inode, struct file *file)
434 if (inode->i_private)
435 file->private_data = inode->i_private;
440 static const struct file_operations default_file_operations = {
441 .read = default_read_file,
442 .write = default_write_file,
443 .open = default_open,
444 .llseek = default_file_lseek,
447 static struct super_operations usbfs_ops = {
448 .statfs = simple_statfs,
449 .drop_inode = generic_delete_inode,
450 .remount_fs = remount,
451 .show_options = usbfs_show_options,
454 static int usbfs_fill_super(struct super_block *sb, void *data, int silent)
459 sb->s_blocksize = PAGE_CACHE_SIZE;
460 sb->s_blocksize_bits = PAGE_CACHE_SHIFT;
461 sb->s_magic = USBDEVICE_SUPER_MAGIC;
462 sb->s_op = &usbfs_ops;
464 inode = usbfs_get_inode(sb, S_IFDIR | 0755, 0);
467 dbg("%s: could not get inode!",__func__);
471 root = d_alloc_root(inode);
473 dbg("%s: could not get root dentry!",__func__);
482 * fs_create_by_name - create a file, given a name
483 * @name: name of file
484 * @mode: type of file
485 * @parent: dentry of directory to create it in
486 * @dentry: resulting dentry of file
488 * This function handles both regular files and directories.
490 static int fs_create_by_name (const char *name, mode_t mode,
491 struct dentry *parent, struct dentry **dentry)
495 /* If the parent is not specified, we create it in the root.
496 * We need the root dentry to do this, which is in the super
497 * block. A pointer to that is in the struct vfsmount that we
501 if (usbfs_mount && usbfs_mount->mnt_sb) {
502 parent = usbfs_mount->mnt_sb->s_root;
507 dbg("Ah! can not find a parent!");
512 mutex_lock(&parent->d_inode->i_mutex);
513 *dentry = lookup_one_len(name, parent, strlen(name));
514 if (!IS_ERR(dentry)) {
515 if ((mode & S_IFMT) == S_IFDIR)
516 error = usbfs_mkdir (parent->d_inode, *dentry, mode);
518 error = usbfs_create (parent->d_inode, *dentry, mode);
520 error = PTR_ERR(dentry);
521 mutex_unlock(&parent->d_inode->i_mutex);
526 static struct dentry *fs_create_file (const char *name, mode_t mode,
527 struct dentry *parent, void *data,
528 const struct file_operations *fops,
529 uid_t uid, gid_t gid)
531 struct dentry *dentry;
534 dbg("creating file '%s'",name);
536 error = fs_create_by_name (name, mode, parent, &dentry);
540 if (dentry->d_inode) {
542 dentry->d_inode->i_private = data;
544 dentry->d_inode->i_fop = fops;
545 dentry->d_inode->i_uid = uid;
546 dentry->d_inode->i_gid = gid;
553 static void fs_remove_file (struct dentry *dentry)
555 struct dentry *parent = dentry->d_parent;
557 if (!parent || !parent->d_inode)
560 mutex_lock_nested(&parent->d_inode->i_mutex, I_MUTEX_PARENT);
561 if (usbfs_positive(dentry)) {
562 if (dentry->d_inode) {
563 if (S_ISDIR(dentry->d_inode->i_mode))
564 usbfs_rmdir(parent->d_inode, dentry);
566 usbfs_unlink(parent->d_inode, dentry);
570 mutex_unlock(&parent->d_inode->i_mutex);
573 /* --------------------------------------------------------------------- */
575 static int usb_get_sb(struct file_system_type *fs_type,
576 int flags, const char *dev_name, void *data, struct vfsmount *mnt)
578 return get_sb_single(fs_type, flags, data, usbfs_fill_super, mnt);
581 static struct file_system_type usb_fs_type = {
582 .owner = THIS_MODULE,
584 .get_sb = usb_get_sb,
585 .kill_sb = kill_litter_super,
588 /* --------------------------------------------------------------------- */
590 static int create_special_files (void)
592 struct dentry *parent;
595 /* the simple_pin_fs calls will call remount with no options
596 * without this flag that would overwrite the real mount options (if any)
600 /* create the devices special file */
601 retval = simple_pin_fs(&usb_fs_type, &usbfs_mount, &usbfs_mount_count);
603 printk(KERN_ERR "Unable to get usbfs mount\n");
609 parent = usbfs_mount->mnt_sb->s_root;
610 devices_usbfs_dentry = fs_create_file ("devices",
611 listmode | S_IFREG, parent,
612 NULL, &usbfs_devices_fops,
614 if (devices_usbfs_dentry == NULL) {
615 printk(KERN_ERR "Unable to create devices usbfs file\n");
617 goto error_clean_mounts;
623 simple_release_fs(&usbfs_mount, &usbfs_mount_count);
628 static void remove_special_files (void)
630 if (devices_usbfs_dentry)
631 fs_remove_file (devices_usbfs_dentry);
632 devices_usbfs_dentry = NULL;
633 simple_release_fs(&usbfs_mount, &usbfs_mount_count);
636 void usbfs_update_special (void)
640 if (devices_usbfs_dentry) {
641 inode = devices_usbfs_dentry->d_inode;
643 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
647 static void usbfs_add_bus(struct usb_bus *bus)
649 struct dentry *parent;
653 /* create the special files if this is the first bus added */
654 if (num_buses == 0) {
655 retval = create_special_files();
661 sprintf (name, "%03d", bus->busnum);
663 parent = usbfs_mount->mnt_sb->s_root;
664 bus->usbfs_dentry = fs_create_file (name, busmode | S_IFDIR, parent,
665 bus, NULL, busuid, busgid);
666 if (bus->usbfs_dentry == NULL) {
667 printk(KERN_ERR "Error creating usbfs bus entry\n");
672 static void usbfs_remove_bus(struct usb_bus *bus)
674 if (bus->usbfs_dentry) {
675 fs_remove_file (bus->usbfs_dentry);
676 bus->usbfs_dentry = NULL;
680 if (num_buses <= 0) {
681 remove_special_files();
686 static void usbfs_add_device(struct usb_device *dev)
692 sprintf (name, "%03d", dev->devnum);
693 dev->usbfs_dentry = fs_create_file (name, devmode | S_IFREG,
694 dev->bus->usbfs_dentry, dev,
695 &usbdev_file_operations,
697 if (dev->usbfs_dentry == NULL) {
698 printk(KERN_ERR "Error creating usbfs device entry\n");
702 /* Set the size of the device's file to be
703 * equal to the size of the device descriptors. */
704 i_size = sizeof (struct usb_device_descriptor);
705 for (i = 0; i < dev->descriptor.bNumConfigurations; ++i) {
706 struct usb_config_descriptor *config =
707 (struct usb_config_descriptor *)dev->rawdescriptors[i];
708 i_size += le16_to_cpu(config->wTotalLength);
710 if (dev->usbfs_dentry->d_inode)
711 dev->usbfs_dentry->d_inode->i_size = i_size;
714 static void usbfs_remove_device(struct usb_device *dev)
716 if (dev->usbfs_dentry) {
717 fs_remove_file (dev->usbfs_dentry);
718 dev->usbfs_dentry = NULL;
722 static int usbfs_notify(struct notifier_block *self, unsigned long action, void *dev)
726 usbfs_add_device(dev);
728 case USB_DEVICE_REMOVE:
729 usbfs_remove_device(dev);
735 usbfs_remove_bus(dev);
738 usbfs_update_special();
739 usbfs_conn_disc_event();
743 static struct notifier_block usbfs_nb = {
744 .notifier_call = usbfs_notify,
747 /* --------------------------------------------------------------------- */
749 static struct proc_dir_entry *usbdir = NULL;
751 int __init usbfs_init(void)
755 retval = register_filesystem(&usb_fs_type);
759 usb_register_notify(&usbfs_nb);
761 /* create mount point for usbfs */
762 usbdir = proc_mkdir("bus/usb", NULL);
767 void usbfs_cleanup(void)
769 usb_unregister_notify(&usbfs_nb);
770 unregister_filesystem(&usb_fs_type);
772 remove_proc_entry("bus/usb", NULL);