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
;
283 inode
->i_atime
= inode
->i_mtime
= inode
->i_ctime
= CURRENT_TIME
;
284 switch (mode
& S_IFMT
) {
286 init_special_inode(inode
, mode
, dev
);
289 inode
->i_fop
= &default_file_operations
;
292 inode
->i_op
= &simple_dir_inode_operations
;
293 inode
->i_fop
= &simple_dir_operations
;
295 /* directory inodes start off with i_nlink == 2 (for "." entry) */
304 static int usbfs_mknod (struct inode
*dir
, struct dentry
*dentry
, int mode
,
307 struct inode
*inode
= usbfs_get_inode(dir
->i_sb
, mode
, dev
);
314 d_instantiate(dentry
, inode
);
321 static int usbfs_mkdir (struct inode
*dir
, struct dentry
*dentry
, int mode
)
325 mode
= (mode
& (S_IRWXUGO
| S_ISVTX
)) | S_IFDIR
;
326 res
= usbfs_mknod (dir
, dentry
, mode
, 0);
332 static int usbfs_create (struct inode
*dir
, struct dentry
*dentry
, int mode
)
334 mode
= (mode
& S_IALLUGO
) | S_IFREG
;
335 return usbfs_mknod (dir
, dentry
, mode
, 0);
338 static inline int usbfs_positive (struct dentry
*dentry
)
340 return dentry
->d_inode
&& !d_unhashed(dentry
);
343 static int usbfs_empty (struct dentry
*dentry
)
345 struct list_head
*list
;
347 spin_lock(&dcache_lock
);
349 list_for_each(list
, &dentry
->d_subdirs
) {
350 struct dentry
*de
= list_entry(list
, struct dentry
, d_u
.d_child
);
351 if (usbfs_positive(de
)) {
352 spin_unlock(&dcache_lock
);
357 spin_unlock(&dcache_lock
);
361 static int usbfs_unlink (struct inode
*dir
, struct dentry
*dentry
)
363 struct inode
*inode
= dentry
->d_inode
;
364 mutex_lock(&inode
->i_mutex
);
365 drop_nlink(dentry
->d_inode
);
367 mutex_unlock(&inode
->i_mutex
);
372 static int usbfs_rmdir(struct inode
*dir
, struct dentry
*dentry
)
374 int error
= -ENOTEMPTY
;
375 struct inode
* inode
= dentry
->d_inode
;
377 mutex_lock(&inode
->i_mutex
);
378 dentry_unhash(dentry
);
379 if (usbfs_empty(dentry
)) {
380 drop_nlink(dentry
->d_inode
);
381 drop_nlink(dentry
->d_inode
);
383 inode
->i_flags
|= S_DEAD
;
387 mutex_unlock(&inode
->i_mutex
);
395 /* default file operations */
396 static ssize_t
default_read_file (struct file
*file
, char __user
*buf
,
397 size_t count
, loff_t
*ppos
)
402 static ssize_t
default_write_file (struct file
*file
, const char __user
*buf
,
403 size_t count
, loff_t
*ppos
)
408 static loff_t
default_file_lseek (struct file
*file
, loff_t offset
, int orig
)
410 loff_t retval
= -EINVAL
;
412 mutex_lock(&file
->f_path
.dentry
->d_inode
->i_mutex
);
416 file
->f_pos
= offset
;
417 retval
= file
->f_pos
;
421 if ((offset
+ file
->f_pos
) > 0) {
422 file
->f_pos
+= offset
;
423 retval
= file
->f_pos
;
429 mutex_unlock(&file
->f_path
.dentry
->d_inode
->i_mutex
);
433 static int default_open (struct inode
*inode
, struct file
*file
)
435 if (inode
->i_private
)
436 file
->private_data
= inode
->i_private
;
441 static const struct file_operations default_file_operations
= {
442 .read
= default_read_file
,
443 .write
= default_write_file
,
444 .open
= default_open
,
445 .llseek
= default_file_lseek
,
448 static struct super_operations usbfs_ops
= {
449 .statfs
= simple_statfs
,
450 .drop_inode
= generic_delete_inode
,
451 .remount_fs
= remount
,
452 .show_options
= usbfs_show_options
,
455 static int usbfs_fill_super(struct super_block
*sb
, void *data
, int silent
)
460 sb
->s_blocksize
= PAGE_CACHE_SIZE
;
461 sb
->s_blocksize_bits
= PAGE_CACHE_SHIFT
;
462 sb
->s_magic
= USBDEVICE_SUPER_MAGIC
;
463 sb
->s_op
= &usbfs_ops
;
465 inode
= usbfs_get_inode(sb
, S_IFDIR
| 0755, 0);
468 dbg("%s: could not get inode!",__func__
);
472 root
= d_alloc_root(inode
);
474 dbg("%s: could not get root dentry!",__func__
);
483 * fs_create_by_name - create a file, given a name
484 * @name: name of file
485 * @mode: type of file
486 * @parent: dentry of directory to create it in
487 * @dentry: resulting dentry of file
489 * This function handles both regular files and directories.
491 static int fs_create_by_name (const char *name
, mode_t mode
,
492 struct dentry
*parent
, struct dentry
**dentry
)
496 /* If the parent is not specified, we create it in the root.
497 * We need the root dentry to do this, which is in the super
498 * block. A pointer to that is in the struct vfsmount that we
502 if (usbfs_mount
&& usbfs_mount
->mnt_sb
) {
503 parent
= usbfs_mount
->mnt_sb
->s_root
;
508 dbg("Ah! can not find a parent!");
513 mutex_lock(&parent
->d_inode
->i_mutex
);
514 *dentry
= lookup_one_len(name
, parent
, strlen(name
));
515 if (!IS_ERR(dentry
)) {
516 if ((mode
& S_IFMT
) == S_IFDIR
)
517 error
= usbfs_mkdir (parent
->d_inode
, *dentry
, mode
);
519 error
= usbfs_create (parent
->d_inode
, *dentry
, mode
);
521 error
= PTR_ERR(dentry
);
522 mutex_unlock(&parent
->d_inode
->i_mutex
);
527 static struct dentry
*fs_create_file (const char *name
, mode_t mode
,
528 struct dentry
*parent
, void *data
,
529 const struct file_operations
*fops
,
530 uid_t uid
, gid_t gid
)
532 struct dentry
*dentry
;
535 dbg("creating file '%s'",name
);
537 error
= fs_create_by_name (name
, mode
, parent
, &dentry
);
541 if (dentry
->d_inode
) {
543 dentry
->d_inode
->i_private
= data
;
545 dentry
->d_inode
->i_fop
= fops
;
546 dentry
->d_inode
->i_uid
= uid
;
547 dentry
->d_inode
->i_gid
= gid
;
554 static void fs_remove_file (struct dentry
*dentry
)
556 struct dentry
*parent
= dentry
->d_parent
;
558 if (!parent
|| !parent
->d_inode
)
561 mutex_lock_nested(&parent
->d_inode
->i_mutex
, I_MUTEX_PARENT
);
562 if (usbfs_positive(dentry
)) {
563 if (dentry
->d_inode
) {
564 if (S_ISDIR(dentry
->d_inode
->i_mode
))
565 usbfs_rmdir(parent
->d_inode
, dentry
);
567 usbfs_unlink(parent
->d_inode
, dentry
);
571 mutex_unlock(&parent
->d_inode
->i_mutex
);
574 /* --------------------------------------------------------------------- */
576 static int usb_get_sb(struct file_system_type
*fs_type
,
577 int flags
, const char *dev_name
, void *data
, struct vfsmount
*mnt
)
579 return get_sb_single(fs_type
, flags
, data
, usbfs_fill_super
, mnt
);
582 static struct file_system_type usb_fs_type
= {
583 .owner
= THIS_MODULE
,
585 .get_sb
= usb_get_sb
,
586 .kill_sb
= kill_litter_super
,
589 /* --------------------------------------------------------------------- */
591 static int create_special_files (void)
593 struct dentry
*parent
;
596 /* the simple_pin_fs calls will call remount with no options
597 * without this flag that would overwrite the real mount options (if any)
601 /* create the devices special file */
602 retval
= simple_pin_fs(&usb_fs_type
, &usbfs_mount
, &usbfs_mount_count
);
604 printk(KERN_ERR
"Unable to get usbfs mount\n");
610 parent
= usbfs_mount
->mnt_sb
->s_root
;
611 devices_usbfs_dentry
= fs_create_file ("devices",
612 listmode
| S_IFREG
, parent
,
613 NULL
, &usbfs_devices_fops
,
615 if (devices_usbfs_dentry
== NULL
) {
616 printk(KERN_ERR
"Unable to create devices usbfs file\n");
618 goto error_clean_mounts
;
624 simple_release_fs(&usbfs_mount
, &usbfs_mount_count
);
629 static void remove_special_files (void)
631 if (devices_usbfs_dentry
)
632 fs_remove_file (devices_usbfs_dentry
);
633 devices_usbfs_dentry
= NULL
;
634 simple_release_fs(&usbfs_mount
, &usbfs_mount_count
);
637 void usbfs_update_special (void)
641 if (devices_usbfs_dentry
) {
642 inode
= devices_usbfs_dentry
->d_inode
;
644 inode
->i_atime
= inode
->i_mtime
= inode
->i_ctime
= CURRENT_TIME
;
648 static void usbfs_add_bus(struct usb_bus
*bus
)
650 struct dentry
*parent
;
654 /* create the special files if this is the first bus added */
655 if (num_buses
== 0) {
656 retval
= create_special_files();
662 sprintf (name
, "%03d", bus
->busnum
);
664 parent
= usbfs_mount
->mnt_sb
->s_root
;
665 bus
->usbfs_dentry
= fs_create_file (name
, busmode
| S_IFDIR
, parent
,
666 bus
, NULL
, busuid
, busgid
);
667 if (bus
->usbfs_dentry
== NULL
) {
668 printk(KERN_ERR
"Error creating usbfs bus entry\n");
673 static void usbfs_remove_bus(struct usb_bus
*bus
)
675 if (bus
->usbfs_dentry
) {
676 fs_remove_file (bus
->usbfs_dentry
);
677 bus
->usbfs_dentry
= NULL
;
681 if (num_buses
<= 0) {
682 remove_special_files();
687 static void usbfs_add_device(struct usb_device
*dev
)
693 sprintf (name
, "%03d", dev
->devnum
);
694 dev
->usbfs_dentry
= fs_create_file (name
, devmode
| S_IFREG
,
695 dev
->bus
->usbfs_dentry
, dev
,
696 &usbdev_file_operations
,
698 if (dev
->usbfs_dentry
== NULL
) {
699 printk(KERN_ERR
"Error creating usbfs device entry\n");
703 /* Set the size of the device's file to be
704 * equal to the size of the device descriptors. */
705 i_size
= sizeof (struct usb_device_descriptor
);
706 for (i
= 0; i
< dev
->descriptor
.bNumConfigurations
; ++i
) {
707 struct usb_config_descriptor
*config
=
708 (struct usb_config_descriptor
*)dev
->rawdescriptors
[i
];
709 i_size
+= le16_to_cpu(config
->wTotalLength
);
711 if (dev
->usbfs_dentry
->d_inode
)
712 dev
->usbfs_dentry
->d_inode
->i_size
= i_size
;
715 static void usbfs_remove_device(struct usb_device
*dev
)
717 if (dev
->usbfs_dentry
) {
718 fs_remove_file (dev
->usbfs_dentry
);
719 dev
->usbfs_dentry
= NULL
;
721 usb_fs_classdev_common_remove(dev
);
724 static int usbfs_notify(struct notifier_block
*self
, unsigned long action
, void *dev
)
728 usbfs_add_device(dev
);
730 case USB_DEVICE_REMOVE
:
731 usbfs_remove_device(dev
);
737 usbfs_remove_bus(dev
);
740 usbfs_update_special();
741 usbfs_conn_disc_event();
745 static struct notifier_block usbfs_nb
= {
746 .notifier_call
= usbfs_notify
,
749 /* --------------------------------------------------------------------- */
751 static struct proc_dir_entry
*usbdir
= NULL
;
753 int __init
usbfs_init(void)
757 retval
= register_filesystem(&usb_fs_type
);
761 usb_register_notify(&usbfs_nb
);
763 /* create mount point for usbfs */
764 usbdir
= proc_mkdir("bus/usb", NULL
);
769 void usbfs_cleanup(void)
771 usb_unregister_notify(&usbfs_nb
);
772 unregister_filesystem(&usb_fs_type
);
774 remove_proc_entry("bus/usb", NULL
);