1 /* AFS superblock handling
3 * Copyright (c) 2002, 2007, 2018 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/fs_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 void afs_kill_super(struct super_block
*sb
);
34 static struct inode
*afs_alloc_inode(struct super_block
*sb
);
35 static void afs_destroy_inode(struct inode
*inode
);
36 static void afs_free_inode(struct inode
*inode
);
37 static int afs_statfs(struct dentry
*dentry
, struct kstatfs
*buf
);
38 static int afs_show_devname(struct seq_file
*m
, struct dentry
*root
);
39 static int afs_show_options(struct seq_file
*m
, struct dentry
*root
);
40 static int afs_init_fs_context(struct fs_context
*fc
);
41 static const struct fs_parameter_spec afs_fs_parameters
[];
43 struct file_system_type afs_fs_type
= {
46 .init_fs_context
= afs_init_fs_context
,
47 .parameters
= afs_fs_parameters
,
48 .kill_sb
= afs_kill_super
,
49 .fs_flags
= FS_RENAME_DOES_D_MOVE
,
51 MODULE_ALIAS_FS("afs");
55 static const struct super_operations afs_super_ops
= {
57 .alloc_inode
= afs_alloc_inode
,
58 .drop_inode
= afs_drop_inode
,
59 .destroy_inode
= afs_destroy_inode
,
60 .free_inode
= afs_free_inode
,
61 .evict_inode
= afs_evict_inode
,
62 .show_devname
= afs_show_devname
,
63 .show_options
= afs_show_options
,
66 static struct kmem_cache
*afs_inode_cachep
;
67 static atomic_t afs_count_active_inodes
;
76 static const struct constant_table afs_param_flock
[] = {
77 {"local", afs_flock_mode_local
},
78 {"openafs", afs_flock_mode_openafs
},
79 {"strict", afs_flock_mode_strict
},
80 {"write", afs_flock_mode_write
},
84 static const struct fs_parameter_spec afs_fs_parameters
[] = {
85 fsparam_flag ("autocell", Opt_autocell
),
86 fsparam_flag ("dyn", Opt_dyn
),
87 fsparam_enum ("flock", Opt_flock
, afs_param_flock
),
88 fsparam_string("source", Opt_source
),
93 * initialise the filesystem
95 int __init
afs_fs_init(void)
101 /* create ourselves an inode cache */
102 atomic_set(&afs_count_active_inodes
, 0);
105 afs_inode_cachep
= kmem_cache_create("afs_inode_cache",
106 sizeof(struct afs_vnode
),
108 SLAB_HWCACHE_ALIGN
|SLAB_ACCOUNT
,
110 if (!afs_inode_cachep
) {
111 printk(KERN_NOTICE
"kAFS: Failed to allocate inode cache\n");
115 /* now export our filesystem to lesser mortals */
116 ret
= register_filesystem(&afs_fs_type
);
118 kmem_cache_destroy(afs_inode_cachep
);
119 _leave(" = %d", ret
);
128 * clean up the filesystem
130 void afs_fs_exit(void)
134 afs_mntpt_kill_timer();
135 unregister_filesystem(&afs_fs_type
);
137 if (atomic_read(&afs_count_active_inodes
) != 0) {
138 printk("kAFS: %d active inode objects still present\n",
139 atomic_read(&afs_count_active_inodes
));
144 * Make sure all delayed rcu free inodes are flushed before we
148 kmem_cache_destroy(afs_inode_cachep
);
153 * Display the mount device name in /proc/mounts.
155 static int afs_show_devname(struct seq_file
*m
, struct dentry
*root
)
157 struct afs_super_info
*as
= AFS_FS_S(root
->d_sb
);
158 struct afs_volume
*volume
= as
->volume
;
159 struct afs_cell
*cell
= as
->cell
;
160 const char *suf
= "";
168 switch (volume
->type
) {
173 if (volume
->type_force
)
182 seq_printf(m
, "%c%s:%s%s", pref
, cell
->name
, volume
->name
, suf
);
187 * Display the mount options in /proc/mounts.
189 static int afs_show_options(struct seq_file
*m
, struct dentry
*root
)
191 struct afs_super_info
*as
= AFS_FS_S(root
->d_sb
);
192 const char *p
= NULL
;
196 if (test_bit(AFS_VNODE_AUTOCELL
, &AFS_FS_I(d_inode(root
))->flags
))
197 seq_puts(m
, ",autocell");
198 switch (as
->flock_mode
) {
199 case afs_flock_mode_unset
: break;
200 case afs_flock_mode_local
: p
= "local"; break;
201 case afs_flock_mode_openafs
: p
= "openafs"; break;
202 case afs_flock_mode_strict
: p
= "strict"; break;
203 case afs_flock_mode_write
: p
= "write"; break;
206 seq_printf(m
, ",flock=%s", p
);
212 * Parse the source name to get cell name, volume name, volume type and R/W
215 * This can be one of the following:
216 * "%[cell:]volume[.]" R/W volume
217 * "#[cell:]volume[.]" R/O or R/W volume (R/O parent),
218 * or R/W (R/W parent) volume
219 * "%[cell:]volume.readonly" R/O volume
220 * "#[cell:]volume.readonly" R/O volume
221 * "%[cell:]volume.backup" Backup volume
222 * "#[cell:]volume.backup" Backup volume
224 static int afs_parse_source(struct fs_context
*fc
, struct fs_parameter
*param
)
226 struct afs_fs_context
*ctx
= fc
->fs_private
;
227 struct afs_cell
*cell
;
228 const char *cellname
, *suffix
, *name
= param
->string
;
234 printk(KERN_ERR
"kAFS: no volume name specified\n");
238 if ((name
[0] != '%' && name
[0] != '#') || !name
[1]) {
239 /* To use dynroot, we don't want to have to provide a source */
240 if (strcmp(name
, "none") == 0) {
244 printk(KERN_ERR
"kAFS: unparsable volume name\n");
248 /* determine the type of volume we're looking for */
249 if (name
[0] == '%') {
250 ctx
->type
= AFSVL_RWVOL
;
255 /* split the cell name out if there is one */
256 ctx
->volname
= strchr(name
, ':');
259 cellnamesz
= ctx
->volname
- name
;
267 /* the volume type is further affected by a possible suffix */
268 suffix
= strrchr(ctx
->volname
, '.');
270 if (strcmp(suffix
, ".readonly") == 0) {
271 ctx
->type
= AFSVL_ROVOL
;
273 } else if (strcmp(suffix
, ".backup") == 0) {
274 ctx
->type
= AFSVL_BACKVOL
;
276 } else if (suffix
[1] == 0) {
282 ctx
->volnamesz
= suffix
?
283 suffix
- ctx
->volname
: strlen(ctx
->volname
);
285 _debug("cell %*.*s [%p]",
286 cellnamesz
, cellnamesz
, cellname
?: "", ctx
->cell
);
288 /* lookup the cell record */
290 cell
= afs_lookup_cell(ctx
->net
, cellname
, cellnamesz
,
293 pr_err("kAFS: unable to lookup cell '%*.*s'\n",
294 cellnamesz
, cellnamesz
, cellname
?: "");
295 return PTR_ERR(cell
);
297 afs_put_cell(ctx
->net
, ctx
->cell
);
301 _debug("CELL:%s [%p] VOLUME:%*.*s SUFFIX:%s TYPE:%d%s",
302 ctx
->cell
->name
, ctx
->cell
,
303 ctx
->volnamesz
, ctx
->volnamesz
, ctx
->volname
,
304 suffix
?: "-", ctx
->type
, ctx
->force
? " FORCE" : "");
306 fc
->source
= param
->string
;
307 param
->string
= NULL
;
312 * Parse a single mount parameter.
314 static int afs_parse_param(struct fs_context
*fc
, struct fs_parameter
*param
)
316 struct fs_parse_result result
;
317 struct afs_fs_context
*ctx
= fc
->fs_private
;
320 opt
= fs_parse(fc
, afs_fs_parameters
, param
, &result
);
326 return afs_parse_source(fc
, param
);
329 ctx
->autocell
= true;
333 ctx
->dyn_root
= true;
337 ctx
->flock_mode
= result
.uint_32
;
349 * Validate the options, get the cell key and look up the volume.
351 static int afs_validate_fc(struct fs_context
*fc
)
353 struct afs_fs_context
*ctx
= fc
->fs_private
;
354 struct afs_volume
*volume
;
357 if (!ctx
->dyn_root
) {
359 pr_warn("kAFS: Can only specify source 'none' with -o dyn\n");
364 pr_warn("kAFS: No cell specified\n");
365 return -EDESTADDRREQ
;
368 /* We try to do the mount securely. */
369 key
= afs_request_key(ctx
->cell
);
376 afs_put_volume(ctx
->cell
, ctx
->volume
);
380 volume
= afs_create_volume(ctx
);
382 return PTR_ERR(volume
);
384 ctx
->volume
= volume
;
391 * check a superblock to see if it's the one we're looking for
393 static int afs_test_super(struct super_block
*sb
, struct fs_context
*fc
)
395 struct afs_fs_context
*ctx
= fc
->fs_private
;
396 struct afs_super_info
*as
= AFS_FS_S(sb
);
398 return (as
->net_ns
== fc
->net_ns
&&
400 as
->volume
->vid
== ctx
->volume
->vid
&&
401 as
->cell
== ctx
->cell
&&
405 static int afs_dynroot_test_super(struct super_block
*sb
, struct fs_context
*fc
)
407 struct afs_super_info
*as
= AFS_FS_S(sb
);
409 return (as
->net_ns
== fc
->net_ns
&&
413 static int afs_set_super(struct super_block
*sb
, struct fs_context
*fc
)
415 return set_anon_super(sb
, NULL
);
419 * fill in the superblock
421 static int afs_fill_super(struct super_block
*sb
, struct afs_fs_context
*ctx
)
423 struct afs_super_info
*as
= AFS_FS_S(sb
);
424 struct afs_iget_data iget_data
;
425 struct inode
*inode
= NULL
;
430 /* fill in the superblock */
431 sb
->s_blocksize
= PAGE_SIZE
;
432 sb
->s_blocksize_bits
= PAGE_SHIFT
;
433 sb
->s_maxbytes
= MAX_LFS_FILESIZE
;
434 sb
->s_magic
= AFS_FS_MAGIC
;
435 sb
->s_op
= &afs_super_ops
;
437 sb
->s_xattr
= afs_xattr_handlers
;
438 ret
= super_setup_bdi(sb
);
441 sb
->s_bdi
->ra_pages
= VM_READAHEAD_PAGES
;
443 /* allocate the root inode and dentry */
445 inode
= afs_iget_pseudo_dir(sb
, true);
447 sprintf(sb
->s_id
, "%llu", as
->volume
->vid
);
448 afs_activate_volume(as
->volume
);
449 iget_data
.fid
.vid
= as
->volume
->vid
;
450 iget_data
.fid
.vnode
= 1;
451 iget_data
.fid
.vnode_hi
= 0;
452 iget_data
.fid
.unique
= 1;
453 iget_data
.cb_v_break
= as
->volume
->cb_v_break
;
454 iget_data
.cb_s_break
= 0;
455 inode
= afs_iget(sb
, ctx
->key
, &iget_data
, NULL
, NULL
, NULL
);
459 return PTR_ERR(inode
);
461 if (ctx
->autocell
|| as
->dyn_root
)
462 set_bit(AFS_VNODE_AUTOCELL
, &AFS_FS_I(inode
)->flags
);
465 sb
->s_root
= d_make_root(inode
);
470 sb
->s_d_op
= &afs_dynroot_dentry_operations
;
471 ret
= afs_dynroot_populate(sb
);
475 sb
->s_d_op
= &afs_fs_dentry_operations
;
482 _leave(" = %d", ret
);
486 static struct afs_super_info
*afs_alloc_sbi(struct fs_context
*fc
)
488 struct afs_fs_context
*ctx
= fc
->fs_private
;
489 struct afs_super_info
*as
;
491 as
= kzalloc(sizeof(struct afs_super_info
), GFP_KERNEL
);
493 as
->net_ns
= get_net(fc
->net_ns
);
494 as
->flock_mode
= ctx
->flock_mode
;
498 as
->cell
= afs_get_cell(ctx
->cell
);
499 as
->volume
= __afs_get_volume(ctx
->volume
);
505 static void afs_destroy_sbi(struct afs_super_info
*as
)
508 afs_put_volume(as
->cell
, as
->volume
);
509 afs_put_cell(afs_net(as
->net_ns
), as
->cell
);
515 static void afs_kill_super(struct super_block
*sb
)
517 struct afs_super_info
*as
= AFS_FS_S(sb
);
518 struct afs_net
*net
= afs_net(as
->net_ns
);
521 afs_dynroot_depopulate(sb
);
523 /* Clear the callback interests (which will do ilookup5) before
524 * deactivating the superblock.
527 afs_clear_callback_interests(net
, as
->volume
->servers
);
530 afs_deactivate_volume(as
->volume
);
535 * Get an AFS superblock and root directory.
537 static int afs_get_tree(struct fs_context
*fc
)
539 struct afs_fs_context
*ctx
= fc
->fs_private
;
540 struct super_block
*sb
;
541 struct afs_super_info
*as
;
544 ret
= afs_validate_fc(fc
);
550 /* allocate a superblock info record */
552 as
= afs_alloc_sbi(fc
);
557 /* allocate a deviceless superblock */
559 as
->dyn_root
? afs_dynroot_test_super
: afs_test_super
,
567 /* initial superblock/root creation */
569 ret
= afs_fill_super(sb
, ctx
);
572 sb
->s_flags
|= SB_ACTIVE
;
575 ASSERTCMP(sb
->s_flags
, &, SB_ACTIVE
);
578 fc
->root
= dget(sb
->s_root
);
579 trace_afs_get_tree(as
->cell
, as
->volume
);
580 _leave(" = 0 [%p]", sb
);
584 deactivate_locked_super(sb
);
586 _leave(" = %d", ret
);
590 static void afs_free_fc(struct fs_context
*fc
)
592 struct afs_fs_context
*ctx
= fc
->fs_private
;
594 afs_destroy_sbi(fc
->s_fs_info
);
595 afs_put_volume(ctx
->cell
, ctx
->volume
);
596 afs_put_cell(ctx
->net
, ctx
->cell
);
601 static const struct fs_context_operations afs_context_ops
= {
603 .parse_param
= afs_parse_param
,
604 .get_tree
= afs_get_tree
,
608 * Set up the filesystem mount context.
610 static int afs_init_fs_context(struct fs_context
*fc
)
612 struct afs_fs_context
*ctx
;
613 struct afs_cell
*cell
;
615 ctx
= kzalloc(sizeof(struct afs_fs_context
), GFP_KERNEL
);
619 ctx
->type
= AFSVL_ROVOL
;
620 ctx
->net
= afs_net(fc
->net_ns
);
622 /* Default to the workstation cell. */
624 cell
= afs_lookup_cell_rcu(ctx
->net
, NULL
, 0);
630 fc
->fs_private
= ctx
;
631 fc
->ops
= &afs_context_ops
;
636 * Initialise an inode cache slab element prior to any use. Note that
637 * afs_alloc_inode() *must* reset anything that could incorrectly leak from one
640 static void afs_i_init_once(void *_vnode
)
642 struct afs_vnode
*vnode
= _vnode
;
644 memset(vnode
, 0, sizeof(*vnode
));
645 inode_init_once(&vnode
->vfs_inode
);
646 mutex_init(&vnode
->io_lock
);
647 init_rwsem(&vnode
->validate_lock
);
648 spin_lock_init(&vnode
->wb_lock
);
649 spin_lock_init(&vnode
->lock
);
650 INIT_LIST_HEAD(&vnode
->wb_keys
);
651 INIT_LIST_HEAD(&vnode
->pending_locks
);
652 INIT_LIST_HEAD(&vnode
->granted_locks
);
653 INIT_DELAYED_WORK(&vnode
->lock_work
, afs_lock_work
);
654 seqlock_init(&vnode
->cb_lock
);
658 * allocate an AFS inode struct from our slab cache
660 static struct inode
*afs_alloc_inode(struct super_block
*sb
)
662 struct afs_vnode
*vnode
;
664 vnode
= kmem_cache_alloc(afs_inode_cachep
, GFP_KERNEL
);
668 atomic_inc(&afs_count_active_inodes
);
670 /* Reset anything that shouldn't leak from one inode to the next. */
671 memset(&vnode
->fid
, 0, sizeof(vnode
->fid
));
672 memset(&vnode
->status
, 0, sizeof(vnode
->status
));
674 vnode
->volume
= NULL
;
675 vnode
->lock_key
= NULL
;
676 vnode
->permit_cache
= NULL
;
677 RCU_INIT_POINTER(vnode
->cb_interest
, NULL
);
678 #ifdef CONFIG_AFS_FSCACHE
682 vnode
->flags
= 1 << AFS_VNODE_UNSET
;
683 vnode
->lock_state
= AFS_VNODE_LOCK_NONE
;
685 init_rwsem(&vnode
->rmdir_lock
);
687 _leave(" = %p", &vnode
->vfs_inode
);
688 return &vnode
->vfs_inode
;
691 static void afs_free_inode(struct inode
*inode
)
693 kmem_cache_free(afs_inode_cachep
, AFS_FS_I(inode
));
697 * destroy an AFS inode struct
699 static void afs_destroy_inode(struct inode
*inode
)
701 struct afs_vnode
*vnode
= AFS_FS_I(inode
);
703 _enter("%p{%llx:%llu}", inode
, vnode
->fid
.vid
, vnode
->fid
.vnode
);
705 _debug("DESTROY INODE %p", inode
);
707 ASSERTCMP(rcu_access_pointer(vnode
->cb_interest
), ==, NULL
);
709 atomic_dec(&afs_count_active_inodes
);
713 * return information about an AFS volume
715 static int afs_statfs(struct dentry
*dentry
, struct kstatfs
*buf
)
717 struct afs_super_info
*as
= AFS_FS_S(dentry
->d_sb
);
718 struct afs_fs_cursor fc
;
719 struct afs_volume_status vs
;
720 struct afs_vnode
*vnode
= AFS_FS_I(d_inode(dentry
));
724 buf
->f_type
= dentry
->d_sb
->s_magic
;
725 buf
->f_bsize
= AFS_BLOCK_SIZE
;
726 buf
->f_namelen
= AFSNAMEMAX
- 1;
735 key
= afs_request_key(vnode
->volume
->cell
);
740 if (afs_begin_vnode_operation(&fc
, vnode
, key
, true)) {
741 fc
.flags
|= AFS_FS_CURSOR_NO_VSLEEP
;
742 while (afs_select_fileserver(&fc
)) {
743 fc
.cb_break
= afs_calc_vnode_cb_break(vnode
);
744 afs_fs_get_volume_status(&fc
, &vs
);
747 afs_check_for_remote_deletion(&fc
, fc
.vnode
);
748 ret
= afs_end_vnode_operation(&fc
);
754 if (vs
.max_quota
== 0)
755 buf
->f_blocks
= vs
.part_max_blocks
;
757 buf
->f_blocks
= vs
.max_quota
;
758 buf
->f_bavail
= buf
->f_bfree
= buf
->f_blocks
- vs
.blocks_in_use
;