1 /* AFS superblock handling
3 * Copyright (c) 2002, 2007 Red Hat, Inc. All rights reserved.
5 * This software may be freely redistributed under the terms of the
6 * GNU General Public License.
8 * You should have received a copy of the GNU General Public License
9 * along with this program; if not, write to the Free Software
10 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
12 * Authors: David Howells <dhowells@redhat.com>
13 * David Woodhouse <dwmw2@infradead.org>
17 #include <linux/kernel.h>
18 #include <linux/module.h>
19 #include <linux/mount.h>
20 #include <linux/init.h>
21 #include <linux/slab.h>
23 #include <linux/pagemap.h>
24 #include <linux/parser.h>
25 #include <linux/statfs.h>
26 #include <linux/sched.h>
27 #include <linux/nsproxy.h>
28 #include <linux/magic.h>
29 #include <net/net_namespace.h>
32 static void afs_i_init_once(void *foo
);
33 static struct dentry
*afs_mount(struct file_system_type
*fs_type
,
34 int flags
, const char *dev_name
, void *data
);
35 static void afs_kill_super(struct super_block
*sb
);
36 static struct inode
*afs_alloc_inode(struct super_block
*sb
);
37 static void afs_destroy_inode(struct inode
*inode
);
38 static int afs_statfs(struct dentry
*dentry
, struct kstatfs
*buf
);
39 static int afs_show_devname(struct seq_file
*m
, struct dentry
*root
);
40 static int afs_show_options(struct seq_file
*m
, struct dentry
*root
);
42 struct file_system_type afs_fs_type
= {
46 .kill_sb
= afs_kill_super
,
49 MODULE_ALIAS_FS("afs");
51 static const struct super_operations afs_super_ops
= {
53 .alloc_inode
= afs_alloc_inode
,
54 .drop_inode
= afs_drop_inode
,
55 .destroy_inode
= afs_destroy_inode
,
56 .evict_inode
= afs_evict_inode
,
57 .show_devname
= afs_show_devname
,
58 .show_options
= afs_show_options
,
61 static struct kmem_cache
*afs_inode_cachep
;
62 static atomic_t afs_count_active_inodes
;
72 static const match_table_t afs_options_list
= {
73 { afs_opt_cell
, "cell=%s" },
74 { afs_opt_rwpath
, "rwpath" },
75 { afs_opt_vol
, "vol=%s" },
76 { afs_opt_autocell
, "autocell" },
81 * initialise the filesystem
83 int __init
afs_fs_init(void)
89 /* create ourselves an inode cache */
90 atomic_set(&afs_count_active_inodes
, 0);
93 afs_inode_cachep
= kmem_cache_create("afs_inode_cache",
94 sizeof(struct afs_vnode
),
96 SLAB_HWCACHE_ALIGN
|SLAB_ACCOUNT
,
98 if (!afs_inode_cachep
) {
99 printk(KERN_NOTICE
"kAFS: Failed to allocate inode cache\n");
103 /* now export our filesystem to lesser mortals */
104 ret
= register_filesystem(&afs_fs_type
);
106 kmem_cache_destroy(afs_inode_cachep
);
107 _leave(" = %d", ret
);
116 * clean up the filesystem
118 void __exit
afs_fs_exit(void)
122 afs_mntpt_kill_timer();
123 unregister_filesystem(&afs_fs_type
);
125 if (atomic_read(&afs_count_active_inodes
) != 0) {
126 printk("kAFS: %d active inode objects still present\n",
127 atomic_read(&afs_count_active_inodes
));
132 * Make sure all delayed rcu free inodes are flushed before we
136 kmem_cache_destroy(afs_inode_cachep
);
141 * Display the mount device name in /proc/mounts.
143 static int afs_show_devname(struct seq_file
*m
, struct dentry
*root
)
145 struct afs_super_info
*as
= root
->d_sb
->s_fs_info
;
146 struct afs_volume
*volume
= as
->volume
;
147 struct afs_cell
*cell
= volume
->cell
;
148 const char *suf
= "";
151 switch (volume
->type
) {
156 if (volume
->type_force
)
165 seq_printf(m
, "%c%s:%s%s", pref
, cell
->name
, volume
->vlocation
->vldb
.name
, suf
);
170 * Display the mount options in /proc/mounts.
172 static int afs_show_options(struct seq_file
*m
, struct dentry
*root
)
174 if (test_bit(AFS_VNODE_AUTOCELL
, &AFS_FS_I(d_inode(root
))->flags
))
175 seq_puts(m
, "autocell");
180 * parse the mount options
181 * - this function has been shamelessly adapted from the ext3 fs which
182 * shamelessly adapted it from the msdos fs
184 static int afs_parse_options(struct afs_mount_params
*params
,
185 char *options
, const char **devname
)
187 struct afs_cell
*cell
;
188 substring_t args
[MAX_OPT_ARGS
];
192 _enter("%s", options
);
194 options
[PAGE_SIZE
- 1] = 0;
196 while ((p
= strsep(&options
, ","))) {
200 token
= match_token(p
, afs_options_list
, args
);
203 cell
= afs_cell_lookup(params
->net
,
205 args
[0].to
- args
[0].from
,
208 return PTR_ERR(cell
);
209 afs_put_cell(params
->cell
);
218 *devname
= args
[0].from
;
221 case afs_opt_autocell
:
222 params
->autocell
= 1;
226 printk(KERN_ERR
"kAFS:"
227 " Unknown or invalid mount option: '%s'\n", p
);
237 * parse a device name to get cell name, volume name, volume type and R/W
239 * - this can be one of the following:
240 * "%[cell:]volume[.]" R/W volume
241 * "#[cell:]volume[.]" R/O or R/W volume (rwpath=0),
242 * or R/W (rwpath=1) volume
243 * "%[cell:]volume.readonly" R/O volume
244 * "#[cell:]volume.readonly" R/O volume
245 * "%[cell:]volume.backup" Backup volume
246 * "#[cell:]volume.backup" Backup volume
248 static int afs_parse_device_name(struct afs_mount_params
*params
,
251 struct afs_cell
*cell
;
252 const char *cellname
, *suffix
;
258 printk(KERN_ERR
"kAFS: no volume name specified\n");
262 if ((name
[0] != '%' && name
[0] != '#') || !name
[1]) {
263 printk(KERN_ERR
"kAFS: unparsable volume name\n");
267 /* determine the type of volume we're looking for */
268 params
->type
= AFSVL_ROVOL
;
269 params
->force
= false;
270 if (params
->rwpath
|| name
[0] == '%') {
271 params
->type
= AFSVL_RWVOL
;
272 params
->force
= true;
276 /* split the cell name out if there is one */
277 params
->volname
= strchr(name
, ':');
278 if (params
->volname
) {
280 cellnamesz
= params
->volname
- name
;
283 params
->volname
= name
;
288 /* the volume type is further affected by a possible suffix */
289 suffix
= strrchr(params
->volname
, '.');
291 if (strcmp(suffix
, ".readonly") == 0) {
292 params
->type
= AFSVL_ROVOL
;
293 params
->force
= true;
294 } else if (strcmp(suffix
, ".backup") == 0) {
295 params
->type
= AFSVL_BACKVOL
;
296 params
->force
= true;
297 } else if (suffix
[1] == 0) {
303 params
->volnamesz
= suffix
?
304 suffix
- params
->volname
: strlen(params
->volname
);
306 _debug("cell %*.*s [%p]",
307 cellnamesz
, cellnamesz
, cellname
?: "", params
->cell
);
309 /* lookup the cell record */
310 if (cellname
|| !params
->cell
) {
311 cell
= afs_cell_lookup(params
->net
, cellname
, cellnamesz
, true);
313 printk(KERN_ERR
"kAFS: unable to lookup cell '%*.*s'\n",
314 cellnamesz
, cellnamesz
, cellname
?: "");
315 return PTR_ERR(cell
);
317 afs_put_cell(params
->cell
);
321 _debug("CELL:%s [%p] VOLUME:%*.*s SUFFIX:%s TYPE:%d%s",
322 params
->cell
->name
, params
->cell
,
323 params
->volnamesz
, params
->volnamesz
, params
->volname
,
324 suffix
?: "-", params
->type
, params
->force
? " FORCE" : "");
330 * check a superblock to see if it's the one we're looking for
332 static int afs_test_super(struct super_block
*sb
, void *data
)
334 struct afs_super_info
*as1
= data
;
335 struct afs_super_info
*as
= sb
->s_fs_info
;
337 return as
->net
== as1
->net
&& as
->volume
== as1
->volume
;
340 static int afs_set_super(struct super_block
*sb
, void *data
)
342 sb
->s_fs_info
= data
;
343 return set_anon_super(sb
, NULL
);
347 * fill in the superblock
349 static int afs_fill_super(struct super_block
*sb
,
350 struct afs_mount_params
*params
)
352 struct afs_super_info
*as
= sb
->s_fs_info
;
354 struct inode
*inode
= NULL
;
359 /* fill in the superblock */
360 sb
->s_blocksize
= PAGE_SIZE
;
361 sb
->s_blocksize_bits
= PAGE_SHIFT
;
362 sb
->s_magic
= AFS_FS_MAGIC
;
363 sb
->s_op
= &afs_super_ops
;
364 sb
->s_xattr
= afs_xattr_handlers
;
365 ret
= super_setup_bdi(sb
);
368 sb
->s_bdi
->ra_pages
= VM_MAX_READAHEAD
* 1024 / PAGE_SIZE
;
369 strlcpy(sb
->s_id
, as
->volume
->vlocation
->vldb
.name
, sizeof(sb
->s_id
));
371 /* allocate the root inode and dentry */
372 fid
.vid
= as
->volume
->vid
;
375 inode
= afs_iget(sb
, params
->key
, &fid
, NULL
, NULL
);
377 return PTR_ERR(inode
);
379 if (params
->autocell
)
380 set_bit(AFS_VNODE_AUTOCELL
, &AFS_FS_I(inode
)->flags
);
383 sb
->s_root
= d_make_root(inode
);
387 sb
->s_d_op
= &afs_fs_dentry_operations
;
393 _leave(" = %d", ret
);
397 static struct afs_super_info
*afs_alloc_sbi(struct afs_mount_params
*params
)
399 struct afs_super_info
*as
;
401 as
= kzalloc(sizeof(struct afs_super_info
), GFP_KERNEL
);
403 as
->net
= afs_get_net(params
->net
);
404 as
->cell
= afs_get_cell(params
->cell
);
409 static void afs_destroy_sbi(struct afs_super_info
*as
)
412 afs_put_volume(as
->net
, as
->volume
);
413 afs_put_cell(as
->cell
);
414 afs_put_net(as
->net
);
420 * get an AFS superblock
422 static struct dentry
*afs_mount(struct file_system_type
*fs_type
,
423 int flags
, const char *dev_name
, void *options
)
425 struct afs_mount_params params
;
426 struct super_block
*sb
;
427 struct afs_volume
*vol
;
429 struct afs_super_info
*as
;
432 _enter(",,%s,%p", dev_name
, options
);
434 memset(¶ms
, 0, sizeof(params
));
435 params
.net
= &__afs_net
;
438 if (current
->nsproxy
->net_ns
!= &init_net
)
441 /* parse the options and device name */
443 ret
= afs_parse_options(¶ms
, options
, &dev_name
);
448 ret
= afs_parse_device_name(¶ms
, dev_name
);
452 /* try and do the mount securely */
453 key
= afs_request_key(params
.cell
);
455 _leave(" = %ld [key]", PTR_ERR(key
));
461 /* allocate a superblock info record */
463 as
= afs_alloc_sbi(¶ms
);
467 /* parse the device name */
468 vol
= afs_volume_lookup(¶ms
);
475 /* allocate a deviceless superblock */
476 sb
= sget(fs_type
, afs_test_super
, afs_set_super
, flags
, as
);
483 /* initial superblock/root creation */
485 ret
= afs_fill_super(sb
, ¶ms
);
489 sb
->s_flags
|= MS_ACTIVE
;
492 ASSERTCMP(sb
->s_flags
, &, MS_ACTIVE
);
497 afs_put_cell(params
.cell
);
499 _leave(" = 0 [%p]", sb
);
500 return dget(sb
->s_root
);
503 deactivate_locked_super(sb
);
507 afs_put_cell(params
.cell
);
509 _leave(" = %d", ret
);
513 static void afs_kill_super(struct super_block
*sb
)
515 struct afs_super_info
*as
= sb
->s_fs_info
;
522 * initialise an inode cache slab element prior to any use
524 static void afs_i_init_once(void *_vnode
)
526 struct afs_vnode
*vnode
= _vnode
;
528 memset(vnode
, 0, sizeof(*vnode
));
529 inode_init_once(&vnode
->vfs_inode
);
530 init_waitqueue_head(&vnode
->update_waitq
);
531 mutex_init(&vnode
->permits_lock
);
532 mutex_init(&vnode
->validate_lock
);
533 spin_lock_init(&vnode
->writeback_lock
);
534 spin_lock_init(&vnode
->lock
);
535 INIT_LIST_HEAD(&vnode
->writebacks
);
536 INIT_LIST_HEAD(&vnode
->pending_locks
);
537 INIT_LIST_HEAD(&vnode
->granted_locks
);
538 INIT_DELAYED_WORK(&vnode
->lock_work
, afs_lock_work
);
539 INIT_WORK(&vnode
->cb_broken_work
, afs_broken_callback_work
);
543 * allocate an AFS inode struct from our slab cache
545 static struct inode
*afs_alloc_inode(struct super_block
*sb
)
547 struct afs_vnode
*vnode
;
549 vnode
= kmem_cache_alloc(afs_inode_cachep
, GFP_KERNEL
);
553 atomic_inc(&afs_count_active_inodes
);
555 memset(&vnode
->fid
, 0, sizeof(vnode
->fid
));
556 memset(&vnode
->status
, 0, sizeof(vnode
->status
));
558 vnode
->volume
= NULL
;
559 vnode
->update_cnt
= 0;
560 vnode
->flags
= 1 << AFS_VNODE_UNSET
;
561 vnode
->cb_promised
= false;
563 _leave(" = %p", &vnode
->vfs_inode
);
564 return &vnode
->vfs_inode
;
567 static void afs_i_callback(struct rcu_head
*head
)
569 struct inode
*inode
= container_of(head
, struct inode
, i_rcu
);
570 struct afs_vnode
*vnode
= AFS_FS_I(inode
);
571 kmem_cache_free(afs_inode_cachep
, vnode
);
575 * destroy an AFS inode struct
577 static void afs_destroy_inode(struct inode
*inode
)
579 struct afs_vnode
*vnode
= AFS_FS_I(inode
);
581 _enter("%p{%x:%u}", inode
, vnode
->fid
.vid
, vnode
->fid
.vnode
);
583 _debug("DESTROY INODE %p", inode
);
585 ASSERTCMP(vnode
->server
, ==, NULL
);
587 call_rcu(&inode
->i_rcu
, afs_i_callback
);
588 atomic_dec(&afs_count_active_inodes
);
592 * return information about an AFS volume
594 static int afs_statfs(struct dentry
*dentry
, struct kstatfs
*buf
)
596 struct afs_volume_status vs
;
597 struct afs_vnode
*vnode
= AFS_FS_I(d_inode(dentry
));
601 key
= afs_request_key(vnode
->volume
->cell
);
605 ret
= afs_vnode_get_volume_status(vnode
, key
, &vs
);
608 _leave(" = %d", ret
);
612 buf
->f_type
= dentry
->d_sb
->s_magic
;
613 buf
->f_bsize
= AFS_BLOCK_SIZE
;
614 buf
->f_namelen
= AFSNAMEMAX
- 1;
616 if (vs
.max_quota
== 0)
617 buf
->f_blocks
= vs
.part_max_blocks
;
619 buf
->f_blocks
= vs
.max_quota
;
620 buf
->f_bavail
= buf
->f_bfree
= buf
->f_blocks
- vs
.blocks_in_use
;