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/config.h>
31 #include <linux/module.h>
33 #include <linux/mount.h>
34 #include <linux/pagemap.h>
35 #include <linux/init.h>
36 #include <linux/proc_fs.h>
37 #include <linux/usb.h>
38 #include <linux/namei.h>
39 #include <linux/usbdevice_fs.h>
40 #include <linux/smp_lock.h>
41 #include <linux/parser.h>
42 #include <linux/notifier.h>
43 #include <asm/byteorder.h>
47 static struct super_operations usbfs_ops;
48 static struct file_operations default_file_operations;
49 static struct vfsmount *usbfs_mount;
50 static int usbfs_mount_count; /* = 0 */
51 static int ignore_mount = 0;
53 static struct dentry *devices_usbfs_dentry;
54 static int num_buses; /* = 0 */
56 static uid_t devuid; /* = 0 */
57 static uid_t busuid; /* = 0 */
58 static uid_t listuid; /* = 0 */
59 static gid_t devgid; /* = 0 */
60 static gid_t busgid; /* = 0 */
61 static gid_t listgid; /* = 0 */
62 static umode_t devmode = S_IWUSR | S_IRUGO;
63 static umode_t busmode = S_IXUGO | S_IRUGO;
64 static umode_t listmode = S_IRUGO;
67 Opt_devuid, Opt_devgid, Opt_devmode,
68 Opt_busuid, Opt_busgid, Opt_busmode,
69 Opt_listuid, Opt_listgid, Opt_listmode,
73 static match_table_t tokens = {
74 {Opt_devuid, "devuid=%u"},
75 {Opt_devgid, "devgid=%u"},
76 {Opt_devmode, "devmode=%o"},
77 {Opt_busuid, "busuid=%u"},
78 {Opt_busgid, "busgid=%u"},
79 {Opt_busmode, "busmode=%o"},
80 {Opt_listuid, "listuid=%u"},
81 {Opt_listgid, "listgid=%u"},
82 {Opt_listmode, "listmode=%o"},
86 static int parse_options(struct super_block *s, char *data)
91 /* (re)set to defaults. */
98 devmode = S_IWUSR | S_IRUGO;
99 busmode = S_IXUGO | S_IRUGO;
102 while ((p = strsep(&data, ",")) != NULL) {
103 substring_t args[MAX_OPT_ARGS];
108 token = match_token(p, tokens, args);
111 if (match_int(&args[0], &option))
116 if (match_int(&args[0], &option))
121 if (match_octal(&args[0], &option))
123 devmode = option & S_IRWXUGO;
126 if (match_int(&args[0], &option))
131 if (match_int(&args[0], &option))
136 if (match_octal(&args[0], &option))
138 busmode = option & S_IRWXUGO;
141 if (match_int(&args[0], &option))
146 if (match_int(&args[0], &option))
151 if (match_octal(&args[0], &option))
153 listmode = option & S_IRWXUGO;
156 err("usbfs: unrecognised mount option \"%s\" "
157 "or missing value\n", p);
165 static void update_special(struct dentry *special)
167 special->d_inode->i_uid = listuid;
168 special->d_inode->i_gid = listgid;
169 special->d_inode->i_mode = S_IFREG | listmode;
172 static void update_dev(struct dentry *dev)
174 dev->d_inode->i_uid = devuid;
175 dev->d_inode->i_gid = devgid;
176 dev->d_inode->i_mode = S_IFREG | devmode;
179 static void update_bus(struct dentry *bus)
181 struct dentry *dev = NULL;
183 bus->d_inode->i_uid = busuid;
184 bus->d_inode->i_gid = busgid;
185 bus->d_inode->i_mode = S_IFDIR | busmode;
187 mutex_lock(&bus->d_inode->i_mutex);
189 list_for_each_entry(dev, &bus->d_subdirs, d_u.d_child)
193 mutex_unlock(&bus->d_inode->i_mutex);
196 static void update_sb(struct super_block *sb)
198 struct dentry *root = sb->s_root;
199 struct dentry *bus = NULL;
204 mutex_lock(&root->d_inode->i_mutex);
206 list_for_each_entry(bus, &root->d_subdirs, d_u.d_child) {
208 switch (S_IFMT & bus->d_inode->i_mode) {
216 warn("Unknown node %s mode %x found on remount!\n",bus->d_name.name,bus->d_inode->i_mode);
222 mutex_unlock(&root->d_inode->i_mutex);
225 static int remount(struct super_block *sb, int *flags, char *data)
227 /* If this is not a real mount,
228 * i.e. it's a simple_pin_fs from create_special_files,
234 if (parse_options(sb, data)) {
235 warn("usbfs: mount parameter error:");
239 if (usbfs_mount && usbfs_mount->mnt_sb)
240 update_sb(usbfs_mount->mnt_sb);
245 static struct inode *usbfs_get_inode (struct super_block *sb, int mode, dev_t dev)
247 struct inode *inode = new_inode(sb);
250 inode->i_mode = mode;
251 inode->i_uid = current->fsuid;
252 inode->i_gid = current->fsgid;
253 inode->i_blksize = PAGE_CACHE_SIZE;
255 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
256 switch (mode & S_IFMT) {
258 init_special_inode(inode, mode, dev);
261 inode->i_fop = &default_file_operations;
264 inode->i_op = &simple_dir_inode_operations;
265 inode->i_fop = &simple_dir_operations;
267 /* directory inodes start off with i_nlink == 2 (for "." entry) */
276 static int usbfs_mknod (struct inode *dir, struct dentry *dentry, int mode,
279 struct inode *inode = usbfs_get_inode(dir->i_sb, mode, dev);
286 d_instantiate(dentry, inode);
293 static int usbfs_mkdir (struct inode *dir, struct dentry *dentry, int mode)
297 mode = (mode & (S_IRWXUGO | S_ISVTX)) | S_IFDIR;
298 res = usbfs_mknod (dir, dentry, mode, 0);
304 static int usbfs_create (struct inode *dir, struct dentry *dentry, int mode)
306 mode = (mode & S_IALLUGO) | S_IFREG;
307 return usbfs_mknod (dir, dentry, mode, 0);
310 static inline int usbfs_positive (struct dentry *dentry)
312 return dentry->d_inode && !d_unhashed(dentry);
315 static int usbfs_empty (struct dentry *dentry)
317 struct list_head *list;
319 spin_lock(&dcache_lock);
321 list_for_each(list, &dentry->d_subdirs) {
322 struct dentry *de = list_entry(list, struct dentry, d_u.d_child);
323 if (usbfs_positive(de)) {
324 spin_unlock(&dcache_lock);
329 spin_unlock(&dcache_lock);
333 static int usbfs_unlink (struct inode *dir, struct dentry *dentry)
335 struct inode *inode = dentry->d_inode;
336 mutex_lock(&inode->i_mutex);
337 dentry->d_inode->i_nlink--;
339 mutex_unlock(&inode->i_mutex);
344 static int usbfs_rmdir(struct inode *dir, struct dentry *dentry)
346 int error = -ENOTEMPTY;
347 struct inode * inode = dentry->d_inode;
349 mutex_lock(&inode->i_mutex);
350 dentry_unhash(dentry);
351 if (usbfs_empty(dentry)) {
352 dentry->d_inode->i_nlink -= 2;
354 inode->i_flags |= S_DEAD;
358 mutex_unlock(&inode->i_mutex);
366 /* default file operations */
367 static ssize_t default_read_file (struct file *file, char __user *buf,
368 size_t count, loff_t *ppos)
373 static ssize_t default_write_file (struct file *file, const char __user *buf,
374 size_t count, loff_t *ppos)
379 static loff_t default_file_lseek (struct file *file, loff_t offset, int orig)
381 loff_t retval = -EINVAL;
383 mutex_lock(&file->f_dentry->d_inode->i_mutex);
387 file->f_pos = offset;
388 retval = file->f_pos;
392 if ((offset + file->f_pos) > 0) {
393 file->f_pos += offset;
394 retval = file->f_pos;
400 mutex_unlock(&file->f_dentry->d_inode->i_mutex);
404 static int default_open (struct inode *inode, struct file *file)
406 if (inode->u.generic_ip)
407 file->private_data = inode->u.generic_ip;
412 static struct file_operations default_file_operations = {
413 .read = default_read_file,
414 .write = default_write_file,
415 .open = default_open,
416 .llseek = default_file_lseek,
419 static struct super_operations usbfs_ops = {
420 .statfs = simple_statfs,
421 .drop_inode = generic_delete_inode,
422 .remount_fs = remount,
425 static int usbfs_fill_super(struct super_block *sb, void *data, int silent)
430 sb->s_blocksize = PAGE_CACHE_SIZE;
431 sb->s_blocksize_bits = PAGE_CACHE_SHIFT;
432 sb->s_magic = USBDEVICE_SUPER_MAGIC;
433 sb->s_op = &usbfs_ops;
435 inode = usbfs_get_inode(sb, S_IFDIR | 0755, 0);
438 dbg("%s: could not get inode!",__FUNCTION__);
442 root = d_alloc_root(inode);
444 dbg("%s: could not get root dentry!",__FUNCTION__);
453 * fs_create_by_name - create a file, given a name
454 * @name: name of file
455 * @mode: type of file
456 * @parent: dentry of directory to create it in
457 * @dentry: resulting dentry of file
459 * This function handles both regular files and directories.
461 static int fs_create_by_name (const char *name, mode_t mode,
462 struct dentry *parent, struct dentry **dentry)
466 /* If the parent is not specified, we create it in the root.
467 * We need the root dentry to do this, which is in the super
468 * block. A pointer to that is in the struct vfsmount that we
472 if (usbfs_mount && usbfs_mount->mnt_sb) {
473 parent = usbfs_mount->mnt_sb->s_root;
478 dbg("Ah! can not find a parent!");
483 mutex_lock(&parent->d_inode->i_mutex);
484 *dentry = lookup_one_len(name, parent, strlen(name));
485 if (!IS_ERR(dentry)) {
486 if ((mode & S_IFMT) == S_IFDIR)
487 error = usbfs_mkdir (parent->d_inode, *dentry, mode);
489 error = usbfs_create (parent->d_inode, *dentry, mode);
491 error = PTR_ERR(dentry);
492 mutex_unlock(&parent->d_inode->i_mutex);
497 static struct dentry *fs_create_file (const char *name, mode_t mode,
498 struct dentry *parent, void *data,
499 struct file_operations *fops,
500 uid_t uid, gid_t gid)
502 struct dentry *dentry;
505 dbg("creating file '%s'",name);
507 error = fs_create_by_name (name, mode, parent, &dentry);
511 if (dentry->d_inode) {
513 dentry->d_inode->u.generic_ip = data;
515 dentry->d_inode->i_fop = fops;
516 dentry->d_inode->i_uid = uid;
517 dentry->d_inode->i_gid = gid;
524 static void fs_remove_file (struct dentry *dentry)
526 struct dentry *parent = dentry->d_parent;
528 if (!parent || !parent->d_inode)
531 mutex_lock(&parent->d_inode->i_mutex);
532 if (usbfs_positive(dentry)) {
533 if (dentry->d_inode) {
534 if (S_ISDIR(dentry->d_inode->i_mode))
535 usbfs_rmdir(parent->d_inode, dentry);
537 usbfs_unlink(parent->d_inode, dentry);
541 mutex_unlock(&parent->d_inode->i_mutex);
544 /* --------------------------------------------------------------------- */
546 static struct super_block *usb_get_sb(struct file_system_type *fs_type,
547 int flags, const char *dev_name, void *data)
549 return get_sb_single(fs_type, flags, data, usbfs_fill_super);
552 static struct file_system_type usb_fs_type = {
553 .owner = THIS_MODULE,
555 .get_sb = usb_get_sb,
556 .kill_sb = kill_litter_super,
559 /* --------------------------------------------------------------------- */
561 static int create_special_files (void)
563 struct dentry *parent;
566 /* the simple_pin_fs calls will call remount with no options
567 * without this flag that would overwrite the real mount options (if any)
571 /* create the devices special file */
572 retval = simple_pin_fs("usbfs", &usbfs_mount, &usbfs_mount_count);
574 err ("Unable to get usbfs mount");
580 parent = usbfs_mount->mnt_sb->s_root;
581 devices_usbfs_dentry = fs_create_file ("devices",
582 listmode | S_IFREG, parent,
583 NULL, &usbfs_devices_fops,
585 if (devices_usbfs_dentry == NULL) {
586 err ("Unable to create devices usbfs file");
588 goto error_clean_mounts;
594 simple_release_fs(&usbfs_mount, &usbfs_mount_count);
599 static void remove_special_files (void)
601 if (devices_usbfs_dentry)
602 fs_remove_file (devices_usbfs_dentry);
603 devices_usbfs_dentry = NULL;
604 simple_release_fs(&usbfs_mount, &usbfs_mount_count);
607 void usbfs_update_special (void)
611 if (devices_usbfs_dentry) {
612 inode = devices_usbfs_dentry->d_inode;
614 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
618 static void usbfs_add_bus(struct usb_bus *bus)
620 struct dentry *parent;
624 /* create the special files if this is the first bus added */
625 if (num_buses == 0) {
626 retval = create_special_files();
632 sprintf (name, "%03d", bus->busnum);
634 parent = usbfs_mount->mnt_sb->s_root;
635 bus->usbfs_dentry = fs_create_file (name, busmode | S_IFDIR, parent,
636 bus, NULL, busuid, busgid);
637 if (bus->usbfs_dentry == NULL) {
638 err ("error creating usbfs bus entry");
643 static void usbfs_remove_bus(struct usb_bus *bus)
645 if (bus->usbfs_dentry) {
646 fs_remove_file (bus->usbfs_dentry);
647 bus->usbfs_dentry = NULL;
651 if (num_buses <= 0) {
652 remove_special_files();
657 static void usbfs_add_device(struct usb_device *dev)
663 sprintf (name, "%03d", dev->devnum);
664 dev->usbfs_dentry = fs_create_file (name, devmode | S_IFREG,
665 dev->bus->usbfs_dentry, dev,
666 &usbfs_device_file_operations,
668 if (dev->usbfs_dentry == NULL) {
669 err ("error creating usbfs device entry");
673 /* Set the size of the device's file to be
674 * equal to the size of the device descriptors. */
675 i_size = sizeof (struct usb_device_descriptor);
676 for (i = 0; i < dev->descriptor.bNumConfigurations; ++i) {
677 struct usb_config_descriptor *config =
678 (struct usb_config_descriptor *)dev->rawdescriptors[i];
679 i_size += le16_to_cpu(config->wTotalLength);
681 if (dev->usbfs_dentry->d_inode)
682 dev->usbfs_dentry->d_inode->i_size = i_size;
685 static void usbfs_remove_device(struct usb_device *dev)
687 struct dev_state *ds;
688 struct siginfo sinfo;
690 if (dev->usbfs_dentry) {
691 fs_remove_file (dev->usbfs_dentry);
692 dev->usbfs_dentry = NULL;
694 while (!list_empty(&dev->filelist)) {
695 ds = list_entry(dev->filelist.next, struct dev_state, list);
696 wake_up_all(&ds->wait);
697 list_del_init(&ds->list);
699 sinfo.si_signo = SIGPIPE;
700 sinfo.si_errno = EPIPE;
701 sinfo.si_code = SI_ASYNCIO;
702 sinfo.si_addr = ds->disccontext;
703 kill_proc_info_as_uid(ds->discsignr, &sinfo, ds->disc_pid, ds->disc_uid, ds->disc_euid);
708 static int usbfs_notify(struct notifier_block *self, unsigned long action, void *dev)
712 usbfs_add_device(dev);
714 case USB_DEVICE_REMOVE:
715 usbfs_remove_device(dev);
721 usbfs_remove_bus(dev);
724 usbfs_update_special();
725 usbfs_conn_disc_event();
729 static struct notifier_block usbfs_nb = {
730 .notifier_call = usbfs_notify,
733 /* --------------------------------------------------------------------- */
735 static struct proc_dir_entry *usbdir = NULL;
737 int __init usbfs_init(void)
741 retval = register_filesystem(&usb_fs_type);
745 usb_register_notify(&usbfs_nb);
747 /* create mount point for usbfs */
748 usbdir = proc_mkdir("usb", proc_bus);
753 void usbfs_cleanup(void)
755 usb_unregister_notify(&usbfs_nb);
756 unregister_filesystem(&usb_fs_type);
758 remove_proc_entry("usb", proc_bus);