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 <linux/smp_lock.h>
43 #include <asm/byteorder.h>
47 #define USBFS_DEFAULT_DEVMODE (S_IWUSR | S_IRUGO)
48 #define USBFS_DEFAULT_BUSMODE (S_IXUGO | S_IRUGO)
49 #define USBFS_DEFAULT_LISTMODE S_IRUGO
51 static struct super_operations usbfs_ops
;
52 static const struct file_operations default_file_operations
;
53 static struct vfsmount
*usbfs_mount
;
54 static int usbfs_mount_count
; /* = 0 */
55 static int ignore_mount
= 0;
57 static struct dentry
*devices_usbfs_dentry
;
58 static int num_buses
; /* = 0 */
60 static uid_t devuid
; /* = 0 */
61 static uid_t busuid
; /* = 0 */
62 static uid_t listuid
; /* = 0 */
63 static gid_t devgid
; /* = 0 */
64 static gid_t busgid
; /* = 0 */
65 static gid_t listgid
; /* = 0 */
66 static umode_t devmode
= USBFS_DEFAULT_DEVMODE
;
67 static umode_t busmode
= USBFS_DEFAULT_BUSMODE
;
68 static umode_t listmode
= USBFS_DEFAULT_LISTMODE
;
70 static int usbfs_show_options(struct seq_file
*seq
, struct vfsmount
*mnt
)
73 seq_printf(seq
, ",devuid=%u", devuid
);
75 seq_printf(seq
, ",devgid=%u", devgid
);
76 if (devmode
!= USBFS_DEFAULT_DEVMODE
)
77 seq_printf(seq
, ",devmode=%o", devmode
);
79 seq_printf(seq
, ",busuid=%u", busuid
);
81 seq_printf(seq
, ",busgid=%u", busgid
);
82 if (busmode
!= USBFS_DEFAULT_BUSMODE
)
83 seq_printf(seq
, ",busmode=%o", busmode
);
85 seq_printf(seq
, ",listuid=%u", listuid
);
87 seq_printf(seq
, ",listgid=%u", listgid
);
88 if (listmode
!= USBFS_DEFAULT_LISTMODE
)
89 seq_printf(seq
, ",listmode=%o", listmode
);
95 Opt_devuid
, Opt_devgid
, Opt_devmode
,
96 Opt_busuid
, Opt_busgid
, Opt_busmode
,
97 Opt_listuid
, Opt_listgid
, Opt_listmode
,
101 static const match_table_t tokens
= {
102 {Opt_devuid
, "devuid=%u"},
103 {Opt_devgid
, "devgid=%u"},
104 {Opt_devmode
, "devmode=%o"},
105 {Opt_busuid
, "busuid=%u"},
106 {Opt_busgid
, "busgid=%u"},
107 {Opt_busmode
, "busmode=%o"},
108 {Opt_listuid
, "listuid=%u"},
109 {Opt_listgid
, "listgid=%u"},
110 {Opt_listmode
, "listmode=%o"},
114 static int parse_options(struct super_block
*s
, char *data
)
119 /* (re)set to defaults. */
126 devmode
= USBFS_DEFAULT_DEVMODE
;
127 busmode
= USBFS_DEFAULT_BUSMODE
;
128 listmode
= USBFS_DEFAULT_LISTMODE
;
130 while ((p
= strsep(&data
, ",")) != NULL
) {
131 substring_t args
[MAX_OPT_ARGS
];
136 token
= match_token(p
, tokens
, args
);
139 if (match_int(&args
[0], &option
))
144 if (match_int(&args
[0], &option
))
149 if (match_octal(&args
[0], &option
))
151 devmode
= option
& S_IRWXUGO
;
154 if (match_int(&args
[0], &option
))
159 if (match_int(&args
[0], &option
))
164 if (match_octal(&args
[0], &option
))
166 busmode
= option
& S_IRWXUGO
;
169 if (match_int(&args
[0], &option
))
174 if (match_int(&args
[0], &option
))
179 if (match_octal(&args
[0], &option
))
181 listmode
= option
& S_IRWXUGO
;
184 printk(KERN_ERR
"usbfs: unrecognised mount option "
185 "\"%s\" or missing value\n", p
);
193 static void update_special(struct dentry
*special
)
195 special
->d_inode
->i_uid
= listuid
;
196 special
->d_inode
->i_gid
= listgid
;
197 special
->d_inode
->i_mode
= S_IFREG
| listmode
;
200 static void update_dev(struct dentry
*dev
)
202 dev
->d_inode
->i_uid
= devuid
;
203 dev
->d_inode
->i_gid
= devgid
;
204 dev
->d_inode
->i_mode
= S_IFREG
| devmode
;
207 static void update_bus(struct dentry
*bus
)
209 struct dentry
*dev
= NULL
;
211 bus
->d_inode
->i_uid
= busuid
;
212 bus
->d_inode
->i_gid
= busgid
;
213 bus
->d_inode
->i_mode
= S_IFDIR
| busmode
;
215 mutex_lock(&bus
->d_inode
->i_mutex
);
217 list_for_each_entry(dev
, &bus
->d_subdirs
, d_u
.d_child
)
221 mutex_unlock(&bus
->d_inode
->i_mutex
);
224 static void update_sb(struct super_block
*sb
)
226 struct dentry
*root
= sb
->s_root
;
227 struct dentry
*bus
= NULL
;
232 mutex_lock_nested(&root
->d_inode
->i_mutex
, I_MUTEX_PARENT
);
234 list_for_each_entry(bus
, &root
->d_subdirs
, d_u
.d_child
) {
236 switch (S_IFMT
& bus
->d_inode
->i_mode
) {
244 printk(KERN_WARNING
"usbfs: Unknown node %s "
245 "mode %x found on remount!\n",
246 bus
->d_name
.name
, bus
->d_inode
->i_mode
);
252 mutex_unlock(&root
->d_inode
->i_mutex
);
255 static int remount(struct super_block
*sb
, int *flags
, char *data
)
257 /* If this is not a real mount,
258 * i.e. it's a simple_pin_fs from create_special_files,
264 if (parse_options(sb
, data
)) {
265 printk(KERN_WARNING
"usbfs: mount parameter error.\n");
271 if (usbfs_mount
&& usbfs_mount
->mnt_sb
)
272 update_sb(usbfs_mount
->mnt_sb
);
279 static struct inode
*usbfs_get_inode (struct super_block
*sb
, int mode
, dev_t dev
)
281 struct inode
*inode
= new_inode(sb
);
284 inode
->i_mode
= mode
;
285 inode
->i_uid
= current_fsuid();
286 inode
->i_gid
= current_fsgid();
287 inode
->i_atime
= inode
->i_mtime
= inode
->i_ctime
= CURRENT_TIME
;
288 switch (mode
& S_IFMT
) {
290 init_special_inode(inode
, mode
, dev
);
293 inode
->i_fop
= &default_file_operations
;
296 inode
->i_op
= &simple_dir_inode_operations
;
297 inode
->i_fop
= &simple_dir_operations
;
299 /* directory inodes start off with i_nlink == 2 (for "." entry) */
308 static int usbfs_mknod (struct inode
*dir
, struct dentry
*dentry
, int mode
,
311 struct inode
*inode
= usbfs_get_inode(dir
->i_sb
, mode
, dev
);
318 d_instantiate(dentry
, inode
);
325 static int usbfs_mkdir (struct inode
*dir
, struct dentry
*dentry
, int mode
)
329 mode
= (mode
& (S_IRWXUGO
| S_ISVTX
)) | S_IFDIR
;
330 res
= usbfs_mknod (dir
, dentry
, mode
, 0);
336 static int usbfs_create (struct inode
*dir
, struct dentry
*dentry
, int mode
)
338 mode
= (mode
& S_IALLUGO
) | S_IFREG
;
339 return usbfs_mknod (dir
, dentry
, mode
, 0);
342 static inline int usbfs_positive (struct dentry
*dentry
)
344 return dentry
->d_inode
&& !d_unhashed(dentry
);
347 static int usbfs_empty (struct dentry
*dentry
)
349 struct list_head
*list
;
351 spin_lock(&dcache_lock
);
353 list_for_each(list
, &dentry
->d_subdirs
) {
354 struct dentry
*de
= list_entry(list
, struct dentry
, d_u
.d_child
);
355 if (usbfs_positive(de
)) {
356 spin_unlock(&dcache_lock
);
361 spin_unlock(&dcache_lock
);
365 static int usbfs_unlink (struct inode
*dir
, struct dentry
*dentry
)
367 struct inode
*inode
= dentry
->d_inode
;
368 mutex_lock(&inode
->i_mutex
);
369 drop_nlink(dentry
->d_inode
);
371 mutex_unlock(&inode
->i_mutex
);
376 static int usbfs_rmdir(struct inode
*dir
, struct dentry
*dentry
)
378 int error
= -ENOTEMPTY
;
379 struct inode
* inode
= dentry
->d_inode
;
381 mutex_lock(&inode
->i_mutex
);
382 dentry_unhash(dentry
);
383 if (usbfs_empty(dentry
)) {
384 drop_nlink(dentry
->d_inode
);
385 drop_nlink(dentry
->d_inode
);
387 inode
->i_flags
|= S_DEAD
;
391 mutex_unlock(&inode
->i_mutex
);
399 /* default file operations */
400 static ssize_t
default_read_file (struct file
*file
, char __user
*buf
,
401 size_t count
, loff_t
*ppos
)
406 static ssize_t
default_write_file (struct file
*file
, const char __user
*buf
,
407 size_t count
, loff_t
*ppos
)
412 static loff_t
default_file_lseek (struct file
*file
, loff_t offset
, int orig
)
414 loff_t retval
= -EINVAL
;
416 mutex_lock(&file
->f_path
.dentry
->d_inode
->i_mutex
);
420 file
->f_pos
= offset
;
421 retval
= file
->f_pos
;
425 if ((offset
+ file
->f_pos
) > 0) {
426 file
->f_pos
+= offset
;
427 retval
= file
->f_pos
;
433 mutex_unlock(&file
->f_path
.dentry
->d_inode
->i_mutex
);
437 static int default_open (struct inode
*inode
, struct file
*file
)
439 if (inode
->i_private
)
440 file
->private_data
= inode
->i_private
;
445 static const struct file_operations default_file_operations
= {
446 .read
= default_read_file
,
447 .write
= default_write_file
,
448 .open
= default_open
,
449 .llseek
= default_file_lseek
,
452 static struct super_operations usbfs_ops
= {
453 .statfs
= simple_statfs
,
454 .drop_inode
= generic_delete_inode
,
455 .remount_fs
= remount
,
456 .show_options
= usbfs_show_options
,
459 static int usbfs_fill_super(struct super_block
*sb
, void *data
, int silent
)
464 sb
->s_blocksize
= PAGE_CACHE_SIZE
;
465 sb
->s_blocksize_bits
= PAGE_CACHE_SHIFT
;
466 sb
->s_magic
= USBDEVICE_SUPER_MAGIC
;
467 sb
->s_op
= &usbfs_ops
;
469 inode
= usbfs_get_inode(sb
, S_IFDIR
| 0755, 0);
472 dbg("%s: could not get inode!",__func__
);
476 root
= d_alloc_root(inode
);
478 dbg("%s: could not get root dentry!",__func__
);
487 * fs_create_by_name - create a file, given a name
488 * @name: name of file
489 * @mode: type of file
490 * @parent: dentry of directory to create it in
491 * @dentry: resulting dentry of file
493 * This function handles both regular files and directories.
495 static int fs_create_by_name (const char *name
, mode_t mode
,
496 struct dentry
*parent
, struct dentry
**dentry
)
500 /* If the parent is not specified, we create it in the root.
501 * We need the root dentry to do this, which is in the super
502 * block. A pointer to that is in the struct vfsmount that we
506 if (usbfs_mount
&& usbfs_mount
->mnt_sb
) {
507 parent
= usbfs_mount
->mnt_sb
->s_root
;
512 dbg("Ah! can not find a parent!");
517 mutex_lock(&parent
->d_inode
->i_mutex
);
518 *dentry
= lookup_one_len(name
, parent
, strlen(name
));
519 if (!IS_ERR(dentry
)) {
520 if ((mode
& S_IFMT
) == S_IFDIR
)
521 error
= usbfs_mkdir (parent
->d_inode
, *dentry
, mode
);
523 error
= usbfs_create (parent
->d_inode
, *dentry
, mode
);
525 error
= PTR_ERR(dentry
);
526 mutex_unlock(&parent
->d_inode
->i_mutex
);
531 static struct dentry
*fs_create_file (const char *name
, mode_t mode
,
532 struct dentry
*parent
, void *data
,
533 const struct file_operations
*fops
,
534 uid_t uid
, gid_t gid
)
536 struct dentry
*dentry
;
539 dbg("creating file '%s'",name
);
541 error
= fs_create_by_name (name
, mode
, parent
, &dentry
);
545 if (dentry
->d_inode
) {
547 dentry
->d_inode
->i_private
= data
;
549 dentry
->d_inode
->i_fop
= fops
;
550 dentry
->d_inode
->i_uid
= uid
;
551 dentry
->d_inode
->i_gid
= gid
;
558 static void fs_remove_file (struct dentry
*dentry
)
560 struct dentry
*parent
= dentry
->d_parent
;
562 if (!parent
|| !parent
->d_inode
)
565 mutex_lock_nested(&parent
->d_inode
->i_mutex
, I_MUTEX_PARENT
);
566 if (usbfs_positive(dentry
)) {
567 if (dentry
->d_inode
) {
568 if (S_ISDIR(dentry
->d_inode
->i_mode
))
569 usbfs_rmdir(parent
->d_inode
, dentry
);
571 usbfs_unlink(parent
->d_inode
, dentry
);
575 mutex_unlock(&parent
->d_inode
->i_mutex
);
578 /* --------------------------------------------------------------------- */
580 static int usb_get_sb(struct file_system_type
*fs_type
,
581 int flags
, const char *dev_name
, void *data
, struct vfsmount
*mnt
)
583 return get_sb_single(fs_type
, flags
, data
, usbfs_fill_super
, mnt
);
586 static struct file_system_type usb_fs_type
= {
587 .owner
= THIS_MODULE
,
589 .get_sb
= usb_get_sb
,
590 .kill_sb
= kill_litter_super
,
593 /* --------------------------------------------------------------------- */
595 static int create_special_files (void)
597 struct dentry
*parent
;
600 /* the simple_pin_fs calls will call remount with no options
601 * without this flag that would overwrite the real mount options (if any)
605 /* create the devices special file */
606 retval
= simple_pin_fs(&usb_fs_type
, &usbfs_mount
, &usbfs_mount_count
);
608 printk(KERN_ERR
"Unable to get usbfs mount\n");
614 parent
= usbfs_mount
->mnt_sb
->s_root
;
615 devices_usbfs_dentry
= fs_create_file ("devices",
616 listmode
| S_IFREG
, parent
,
617 NULL
, &usbfs_devices_fops
,
619 if (devices_usbfs_dentry
== NULL
) {
620 printk(KERN_ERR
"Unable to create devices usbfs file\n");
622 goto error_clean_mounts
;
628 simple_release_fs(&usbfs_mount
, &usbfs_mount_count
);
633 static void remove_special_files (void)
635 if (devices_usbfs_dentry
)
636 fs_remove_file (devices_usbfs_dentry
);
637 devices_usbfs_dentry
= NULL
;
638 simple_release_fs(&usbfs_mount
, &usbfs_mount_count
);
641 void usbfs_update_special (void)
645 if (devices_usbfs_dentry
) {
646 inode
= devices_usbfs_dentry
->d_inode
;
648 inode
->i_atime
= inode
->i_mtime
= inode
->i_ctime
= CURRENT_TIME
;
652 static void usbfs_add_bus(struct usb_bus
*bus
)
654 struct dentry
*parent
;
658 /* create the special files if this is the first bus added */
659 if (num_buses
== 0) {
660 retval
= create_special_files();
666 sprintf (name
, "%03d", bus
->busnum
);
668 parent
= usbfs_mount
->mnt_sb
->s_root
;
669 bus
->usbfs_dentry
= fs_create_file (name
, busmode
| S_IFDIR
, parent
,
670 bus
, NULL
, busuid
, busgid
);
671 if (bus
->usbfs_dentry
== NULL
) {
672 printk(KERN_ERR
"Error creating usbfs bus entry\n");
677 static void usbfs_remove_bus(struct usb_bus
*bus
)
679 if (bus
->usbfs_dentry
) {
680 fs_remove_file (bus
->usbfs_dentry
);
681 bus
->usbfs_dentry
= NULL
;
685 if (num_buses
<= 0) {
686 remove_special_files();
691 static void usbfs_add_device(struct usb_device
*dev
)
697 sprintf (name
, "%03d", dev
->devnum
);
698 dev
->usbfs_dentry
= fs_create_file (name
, devmode
| S_IFREG
,
699 dev
->bus
->usbfs_dentry
, dev
,
700 &usbdev_file_operations
,
702 if (dev
->usbfs_dentry
== NULL
) {
703 printk(KERN_ERR
"Error creating usbfs device entry\n");
707 /* Set the size of the device's file to be
708 * equal to the size of the device descriptors. */
709 i_size
= sizeof (struct usb_device_descriptor
);
710 for (i
= 0; i
< dev
->descriptor
.bNumConfigurations
; ++i
) {
711 struct usb_config_descriptor
*config
=
712 (struct usb_config_descriptor
*)dev
->rawdescriptors
[i
];
713 i_size
+= le16_to_cpu(config
->wTotalLength
);
715 if (dev
->usbfs_dentry
->d_inode
)
716 dev
->usbfs_dentry
->d_inode
->i_size
= i_size
;
719 static void usbfs_remove_device(struct usb_device
*dev
)
721 if (dev
->usbfs_dentry
) {
722 fs_remove_file (dev
->usbfs_dentry
);
723 dev
->usbfs_dentry
= NULL
;
727 static int usbfs_notify(struct notifier_block
*self
, unsigned long action
, void *dev
)
731 usbfs_add_device(dev
);
733 case USB_DEVICE_REMOVE
:
734 usbfs_remove_device(dev
);
740 usbfs_remove_bus(dev
);
743 usbfs_update_special();
744 usbfs_conn_disc_event();
748 static struct notifier_block usbfs_nb
= {
749 .notifier_call
= usbfs_notify
,
752 /* --------------------------------------------------------------------- */
754 static struct proc_dir_entry
*usbdir
= NULL
;
756 int __init
usbfs_init(void)
760 retval
= register_filesystem(&usb_fs_type
);
764 usb_register_notify(&usbfs_nb
);
766 /* create mount point for usbfs */
767 usbdir
= proc_mkdir("bus/usb", NULL
);
772 void usbfs_cleanup(void)
774 usb_unregister_notify(&usbfs_nb
);
775 unregister_filesystem(&usb_fs_type
);
777 remove_proc_entry("bus/usb", NULL
);