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_description 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 fs_parameter_spec afs_param_specs
[] = {
77 fsparam_flag ("autocell", Opt_autocell
),
78 fsparam_flag ("dyn", Opt_dyn
),
79 fsparam_enum ("flock", Opt_flock
),
80 fsparam_string("source", Opt_source
),
84 static const struct fs_parameter_enum afs_param_enums
[] = {
85 { Opt_flock
, "local", afs_flock_mode_local
},
86 { Opt_flock
, "openafs", afs_flock_mode_openafs
},
87 { Opt_flock
, "strict", afs_flock_mode_strict
},
88 { Opt_flock
, "write", afs_flock_mode_write
},
92 static const struct fs_parameter_description afs_fs_parameters
= {
94 .specs
= afs_param_specs
,
95 .enums
= afs_param_enums
,
99 * initialise the filesystem
101 int __init
afs_fs_init(void)
107 /* create ourselves an inode cache */
108 atomic_set(&afs_count_active_inodes
, 0);
111 afs_inode_cachep
= kmem_cache_create("afs_inode_cache",
112 sizeof(struct afs_vnode
),
114 SLAB_HWCACHE_ALIGN
|SLAB_ACCOUNT
,
116 if (!afs_inode_cachep
) {
117 printk(KERN_NOTICE
"kAFS: Failed to allocate inode cache\n");
121 /* now export our filesystem to lesser mortals */
122 ret
= register_filesystem(&afs_fs_type
);
124 kmem_cache_destroy(afs_inode_cachep
);
125 _leave(" = %d", ret
);
134 * clean up the filesystem
136 void afs_fs_exit(void)
140 afs_mntpt_kill_timer();
141 unregister_filesystem(&afs_fs_type
);
143 if (atomic_read(&afs_count_active_inodes
) != 0) {
144 printk("kAFS: %d active inode objects still present\n",
145 atomic_read(&afs_count_active_inodes
));
150 * Make sure all delayed rcu free inodes are flushed before we
154 kmem_cache_destroy(afs_inode_cachep
);
159 * Display the mount device name in /proc/mounts.
161 static int afs_show_devname(struct seq_file
*m
, struct dentry
*root
)
163 struct afs_super_info
*as
= AFS_FS_S(root
->d_sb
);
164 struct afs_volume
*volume
= as
->volume
;
165 struct afs_cell
*cell
= as
->cell
;
166 const char *suf
= "";
174 switch (volume
->type
) {
179 if (volume
->type_force
)
188 seq_printf(m
, "%c%s:%s%s", pref
, cell
->name
, volume
->name
, suf
);
193 * Display the mount options in /proc/mounts.
195 static int afs_show_options(struct seq_file
*m
, struct dentry
*root
)
197 struct afs_super_info
*as
= AFS_FS_S(root
->d_sb
);
198 const char *p
= NULL
;
202 if (test_bit(AFS_VNODE_AUTOCELL
, &AFS_FS_I(d_inode(root
))->flags
))
203 seq_puts(m
, ",autocell");
204 switch (as
->flock_mode
) {
205 case afs_flock_mode_unset
: break;
206 case afs_flock_mode_local
: p
= "local"; break;
207 case afs_flock_mode_openafs
: p
= "openafs"; break;
208 case afs_flock_mode_strict
: p
= "strict"; break;
209 case afs_flock_mode_write
: p
= "write"; break;
212 seq_printf(m
, ",flock=%s", p
);
218 * Parse the source name to get cell name, volume name, volume type and R/W
221 * This can be one of the following:
222 * "%[cell:]volume[.]" R/W volume
223 * "#[cell:]volume[.]" R/O or R/W volume (R/O parent),
224 * or R/W (R/W parent) volume
225 * "%[cell:]volume.readonly" R/O volume
226 * "#[cell:]volume.readonly" R/O volume
227 * "%[cell:]volume.backup" Backup volume
228 * "#[cell:]volume.backup" Backup volume
230 static int afs_parse_source(struct fs_context
*fc
, struct fs_parameter
*param
)
232 struct afs_fs_context
*ctx
= fc
->fs_private
;
233 struct afs_cell
*cell
;
234 const char *cellname
, *suffix
, *name
= param
->string
;
240 printk(KERN_ERR
"kAFS: no volume name specified\n");
244 if ((name
[0] != '%' && name
[0] != '#') || !name
[1]) {
245 /* To use dynroot, we don't want to have to provide a source */
246 if (strcmp(name
, "none") == 0) {
250 printk(KERN_ERR
"kAFS: unparsable volume name\n");
254 /* determine the type of volume we're looking for */
255 if (name
[0] == '%') {
256 ctx
->type
= AFSVL_RWVOL
;
261 /* split the cell name out if there is one */
262 ctx
->volname
= strchr(name
, ':');
265 cellnamesz
= ctx
->volname
- name
;
273 /* the volume type is further affected by a possible suffix */
274 suffix
= strrchr(ctx
->volname
, '.');
276 if (strcmp(suffix
, ".readonly") == 0) {
277 ctx
->type
= AFSVL_ROVOL
;
279 } else if (strcmp(suffix
, ".backup") == 0) {
280 ctx
->type
= AFSVL_BACKVOL
;
282 } else if (suffix
[1] == 0) {
288 ctx
->volnamesz
= suffix
?
289 suffix
- ctx
->volname
: strlen(ctx
->volname
);
291 _debug("cell %*.*s [%p]",
292 cellnamesz
, cellnamesz
, cellname
?: "", ctx
->cell
);
294 /* lookup the cell record */
296 cell
= afs_lookup_cell(ctx
->net
, cellname
, cellnamesz
,
299 pr_err("kAFS: unable to lookup cell '%*.*s'\n",
300 cellnamesz
, cellnamesz
, cellname
?: "");
301 return PTR_ERR(cell
);
303 afs_put_cell(ctx
->net
, ctx
->cell
);
307 _debug("CELL:%s [%p] VOLUME:%*.*s SUFFIX:%s TYPE:%d%s",
308 ctx
->cell
->name
, ctx
->cell
,
309 ctx
->volnamesz
, ctx
->volnamesz
, ctx
->volname
,
310 suffix
?: "-", ctx
->type
, ctx
->force
? " FORCE" : "");
312 fc
->source
= param
->string
;
313 param
->string
= NULL
;
318 * Parse a single mount parameter.
320 static int afs_parse_param(struct fs_context
*fc
, struct fs_parameter
*param
)
322 struct fs_parse_result result
;
323 struct afs_fs_context
*ctx
= fc
->fs_private
;
326 opt
= fs_parse(fc
, &afs_fs_parameters
, param
, &result
);
332 return afs_parse_source(fc
, param
);
335 ctx
->autocell
= true;
339 ctx
->dyn_root
= true;
343 ctx
->flock_mode
= result
.uint_32
;
355 * Validate the options, get the cell key and look up the volume.
357 static int afs_validate_fc(struct fs_context
*fc
)
359 struct afs_fs_context
*ctx
= fc
->fs_private
;
360 struct afs_volume
*volume
;
363 if (!ctx
->dyn_root
) {
365 pr_warn("kAFS: Can only specify source 'none' with -o dyn\n");
370 pr_warn("kAFS: No cell specified\n");
371 return -EDESTADDRREQ
;
374 /* We try to do the mount securely. */
375 key
= afs_request_key(ctx
->cell
);
382 afs_put_volume(ctx
->cell
, ctx
->volume
);
386 volume
= afs_create_volume(ctx
);
388 return PTR_ERR(volume
);
390 ctx
->volume
= volume
;
397 * check a superblock to see if it's the one we're looking for
399 static int afs_test_super(struct super_block
*sb
, struct fs_context
*fc
)
401 struct afs_fs_context
*ctx
= fc
->fs_private
;
402 struct afs_super_info
*as
= AFS_FS_S(sb
);
404 return (as
->net_ns
== fc
->net_ns
&&
406 as
->volume
->vid
== ctx
->volume
->vid
&&
407 as
->cell
== ctx
->cell
&&
411 static int afs_dynroot_test_super(struct super_block
*sb
, struct fs_context
*fc
)
413 struct afs_super_info
*as
= AFS_FS_S(sb
);
415 return (as
->net_ns
== fc
->net_ns
&&
419 static int afs_set_super(struct super_block
*sb
, struct fs_context
*fc
)
421 return set_anon_super(sb
, NULL
);
425 * fill in the superblock
427 static int afs_fill_super(struct super_block
*sb
, struct afs_fs_context
*ctx
)
429 struct afs_super_info
*as
= AFS_FS_S(sb
);
430 struct afs_iget_data iget_data
;
431 struct inode
*inode
= NULL
;
436 /* fill in the superblock */
437 sb
->s_blocksize
= PAGE_SIZE
;
438 sb
->s_blocksize_bits
= PAGE_SHIFT
;
439 sb
->s_maxbytes
= MAX_LFS_FILESIZE
;
440 sb
->s_magic
= AFS_FS_MAGIC
;
441 sb
->s_op
= &afs_super_ops
;
443 sb
->s_xattr
= afs_xattr_handlers
;
444 ret
= super_setup_bdi(sb
);
447 sb
->s_bdi
->ra_pages
= VM_READAHEAD_PAGES
;
449 /* allocate the root inode and dentry */
451 inode
= afs_iget_pseudo_dir(sb
, true);
453 sprintf(sb
->s_id
, "%llu", as
->volume
->vid
);
454 afs_activate_volume(as
->volume
);
455 iget_data
.fid
.vid
= as
->volume
->vid
;
456 iget_data
.fid
.vnode
= 1;
457 iget_data
.fid
.vnode_hi
= 0;
458 iget_data
.fid
.unique
= 1;
459 iget_data
.cb_v_break
= as
->volume
->cb_v_break
;
460 iget_data
.cb_s_break
= 0;
461 inode
= afs_iget(sb
, ctx
->key
, &iget_data
, NULL
, NULL
, NULL
);
465 return PTR_ERR(inode
);
467 if (ctx
->autocell
|| as
->dyn_root
)
468 set_bit(AFS_VNODE_AUTOCELL
, &AFS_FS_I(inode
)->flags
);
471 sb
->s_root
= d_make_root(inode
);
476 sb
->s_d_op
= &afs_dynroot_dentry_operations
;
477 ret
= afs_dynroot_populate(sb
);
481 sb
->s_d_op
= &afs_fs_dentry_operations
;
488 _leave(" = %d", ret
);
492 static struct afs_super_info
*afs_alloc_sbi(struct fs_context
*fc
)
494 struct afs_fs_context
*ctx
= fc
->fs_private
;
495 struct afs_super_info
*as
;
497 as
= kzalloc(sizeof(struct afs_super_info
), GFP_KERNEL
);
499 as
->net_ns
= get_net(fc
->net_ns
);
500 as
->flock_mode
= ctx
->flock_mode
;
504 as
->cell
= afs_get_cell(ctx
->cell
);
505 as
->volume
= __afs_get_volume(ctx
->volume
);
511 static void afs_destroy_sbi(struct afs_super_info
*as
)
514 afs_put_volume(as
->cell
, as
->volume
);
515 afs_put_cell(afs_net(as
->net_ns
), as
->cell
);
521 static void afs_kill_super(struct super_block
*sb
)
523 struct afs_super_info
*as
= AFS_FS_S(sb
);
524 struct afs_net
*net
= afs_net(as
->net_ns
);
527 afs_dynroot_depopulate(sb
);
529 /* Clear the callback interests (which will do ilookup5) before
530 * deactivating the superblock.
533 afs_clear_callback_interests(net
, as
->volume
->servers
);
536 afs_deactivate_volume(as
->volume
);
541 * Get an AFS superblock and root directory.
543 static int afs_get_tree(struct fs_context
*fc
)
545 struct afs_fs_context
*ctx
= fc
->fs_private
;
546 struct super_block
*sb
;
547 struct afs_super_info
*as
;
550 ret
= afs_validate_fc(fc
);
556 /* allocate a superblock info record */
558 as
= afs_alloc_sbi(fc
);
563 /* allocate a deviceless superblock */
565 as
->dyn_root
? afs_dynroot_test_super
: afs_test_super
,
573 /* initial superblock/root creation */
575 ret
= afs_fill_super(sb
, ctx
);
578 sb
->s_flags
|= SB_ACTIVE
;
581 ASSERTCMP(sb
->s_flags
, &, SB_ACTIVE
);
584 fc
->root
= dget(sb
->s_root
);
585 trace_afs_get_tree(as
->cell
, as
->volume
);
586 _leave(" = 0 [%p]", sb
);
590 deactivate_locked_super(sb
);
592 _leave(" = %d", ret
);
596 static void afs_free_fc(struct fs_context
*fc
)
598 struct afs_fs_context
*ctx
= fc
->fs_private
;
600 afs_destroy_sbi(fc
->s_fs_info
);
601 afs_put_volume(ctx
->cell
, ctx
->volume
);
602 afs_put_cell(ctx
->net
, ctx
->cell
);
607 static const struct fs_context_operations afs_context_ops
= {
609 .parse_param
= afs_parse_param
,
610 .get_tree
= afs_get_tree
,
614 * Set up the filesystem mount context.
616 static int afs_init_fs_context(struct fs_context
*fc
)
618 struct afs_fs_context
*ctx
;
619 struct afs_cell
*cell
;
621 ctx
= kzalloc(sizeof(struct afs_fs_context
), GFP_KERNEL
);
625 ctx
->type
= AFSVL_ROVOL
;
626 ctx
->net
= afs_net(fc
->net_ns
);
628 /* Default to the workstation cell. */
630 cell
= afs_lookup_cell_rcu(ctx
->net
, NULL
, 0);
636 fc
->fs_private
= ctx
;
637 fc
->ops
= &afs_context_ops
;
642 * Initialise an inode cache slab element prior to any use. Note that
643 * afs_alloc_inode() *must* reset anything that could incorrectly leak from one
646 static void afs_i_init_once(void *_vnode
)
648 struct afs_vnode
*vnode
= _vnode
;
650 memset(vnode
, 0, sizeof(*vnode
));
651 inode_init_once(&vnode
->vfs_inode
);
652 mutex_init(&vnode
->io_lock
);
653 init_rwsem(&vnode
->validate_lock
);
654 spin_lock_init(&vnode
->wb_lock
);
655 spin_lock_init(&vnode
->lock
);
656 INIT_LIST_HEAD(&vnode
->wb_keys
);
657 INIT_LIST_HEAD(&vnode
->pending_locks
);
658 INIT_LIST_HEAD(&vnode
->granted_locks
);
659 INIT_DELAYED_WORK(&vnode
->lock_work
, afs_lock_work
);
660 seqlock_init(&vnode
->cb_lock
);
664 * allocate an AFS inode struct from our slab cache
666 static struct inode
*afs_alloc_inode(struct super_block
*sb
)
668 struct afs_vnode
*vnode
;
670 vnode
= kmem_cache_alloc(afs_inode_cachep
, GFP_KERNEL
);
674 atomic_inc(&afs_count_active_inodes
);
676 /* Reset anything that shouldn't leak from one inode to the next. */
677 memset(&vnode
->fid
, 0, sizeof(vnode
->fid
));
678 memset(&vnode
->status
, 0, sizeof(vnode
->status
));
680 vnode
->volume
= NULL
;
681 vnode
->lock_key
= NULL
;
682 vnode
->permit_cache
= NULL
;
683 RCU_INIT_POINTER(vnode
->cb_interest
, NULL
);
684 #ifdef CONFIG_AFS_FSCACHE
688 vnode
->flags
= 1 << AFS_VNODE_UNSET
;
689 vnode
->lock_state
= AFS_VNODE_LOCK_NONE
;
691 init_rwsem(&vnode
->rmdir_lock
);
693 _leave(" = %p", &vnode
->vfs_inode
);
694 return &vnode
->vfs_inode
;
697 static void afs_free_inode(struct inode
*inode
)
699 kmem_cache_free(afs_inode_cachep
, AFS_FS_I(inode
));
703 * destroy an AFS inode struct
705 static void afs_destroy_inode(struct inode
*inode
)
707 struct afs_vnode
*vnode
= AFS_FS_I(inode
);
709 _enter("%p{%llx:%llu}", inode
, vnode
->fid
.vid
, vnode
->fid
.vnode
);
711 _debug("DESTROY INODE %p", inode
);
713 ASSERTCMP(rcu_access_pointer(vnode
->cb_interest
), ==, NULL
);
715 atomic_dec(&afs_count_active_inodes
);
719 * return information about an AFS volume
721 static int afs_statfs(struct dentry
*dentry
, struct kstatfs
*buf
)
723 struct afs_super_info
*as
= AFS_FS_S(dentry
->d_sb
);
724 struct afs_fs_cursor fc
;
725 struct afs_volume_status vs
;
726 struct afs_vnode
*vnode
= AFS_FS_I(d_inode(dentry
));
730 buf
->f_type
= dentry
->d_sb
->s_magic
;
731 buf
->f_bsize
= AFS_BLOCK_SIZE
;
732 buf
->f_namelen
= AFSNAMEMAX
- 1;
741 key
= afs_request_key(vnode
->volume
->cell
);
746 if (afs_begin_vnode_operation(&fc
, vnode
, key
, true)) {
747 fc
.flags
|= AFS_FS_CURSOR_NO_VSLEEP
;
748 while (afs_select_fileserver(&fc
)) {
749 fc
.cb_break
= afs_calc_vnode_cb_break(vnode
);
750 afs_fs_get_volume_status(&fc
, &vs
);
753 afs_check_for_remote_deletion(&fc
, fc
.vnode
);
754 ret
= afs_end_vnode_operation(&fc
);
760 if (vs
.max_quota
== 0)
761 buf
->f_blocks
= vs
.part_max_blocks
;
763 buf
->f_blocks
= vs
.max_quota
;
764 buf
->f_bavail
= buf
->f_bfree
= buf
->f_blocks
- vs
.blocks_in_use
;