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.
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;
355 struct afs_cell *cell;
359 if (!ctx->dyn_root) {
361 pr_warn("kAFS: Can only specify source 'none' with -o dyn\n");
366 pr_warn("kAFS: No cell specified\n");
367 return -EDESTADDRREQ;
371 /* We try to do the mount securely. */
372 key = afs_request_key(ctx->cell);
379 afs_put_volume(ctx->net, ctx->volume,
380 afs_volume_trace_put_validate_fc);
384 if (test_bit(AFS_CELL_FL_CHECK_ALIAS, &ctx->cell->flags)) {
385 ret = afs_cell_detect_alias(ctx->cell, key);
389 _debug("switch to alias");
392 cell = afs_get_cell(ctx->cell->alias_of);
393 afs_put_cell(ctx->net, ctx->cell);
399 volume = afs_create_volume(ctx);
401 return PTR_ERR(volume);
403 ctx->volume = volume;
410 * check a superblock to see if it's the one we're looking for
412 static int afs_test_super(struct super_block *sb, struct fs_context *fc)
414 struct afs_fs_context *ctx = fc->fs_private;
415 struct afs_super_info *as = AFS_FS_S(sb);
417 return (as->net_ns == fc->net_ns &&
419 as->volume->vid == ctx->volume->vid &&
420 as->cell == ctx->cell &&
424 static int afs_dynroot_test_super(struct super_block *sb, struct fs_context *fc)
426 struct afs_super_info *as = AFS_FS_S(sb);
428 return (as->net_ns == fc->net_ns &&
432 static int afs_set_super(struct super_block *sb, struct fs_context *fc)
434 return set_anon_super(sb, NULL);
438 * fill in the superblock
440 static int afs_fill_super(struct super_block *sb, struct afs_fs_context *ctx)
442 struct afs_super_info *as = AFS_FS_S(sb);
443 struct inode *inode = NULL;
448 /* fill in the superblock */
449 sb->s_blocksize = PAGE_SIZE;
450 sb->s_blocksize_bits = PAGE_SHIFT;
451 sb->s_maxbytes = MAX_LFS_FILESIZE;
452 sb->s_magic = AFS_FS_MAGIC;
453 sb->s_op = &afs_super_ops;
455 sb->s_xattr = afs_xattr_handlers;
456 ret = super_setup_bdi(sb);
459 sb->s_bdi->ra_pages = VM_READAHEAD_PAGES;
461 /* allocate the root inode and dentry */
463 inode = afs_iget_pseudo_dir(sb, true);
465 sprintf(sb->s_id, "%llu", as->volume->vid);
466 afs_activate_volume(as->volume);
467 inode = afs_root_iget(sb, ctx->key);
471 return PTR_ERR(inode);
473 if (ctx->autocell || as->dyn_root)
474 set_bit(AFS_VNODE_AUTOCELL, &AFS_FS_I(inode)->flags);
477 sb->s_root = d_make_root(inode);
482 sb->s_d_op = &afs_dynroot_dentry_operations;
483 ret = afs_dynroot_populate(sb);
487 sb->s_d_op = &afs_fs_dentry_operations;
488 rcu_assign_pointer(as->volume->sb, sb);
495 _leave(" = %d", ret);
499 static struct afs_super_info *afs_alloc_sbi(struct fs_context *fc)
501 struct afs_fs_context *ctx = fc->fs_private;
502 struct afs_super_info *as;
504 as = kzalloc(sizeof(struct afs_super_info), GFP_KERNEL);
506 as->net_ns = get_net(fc->net_ns);
507 as->flock_mode = ctx->flock_mode;
511 as->cell = afs_get_cell(ctx->cell);
512 as->volume = afs_get_volume(ctx->volume,
513 afs_volume_trace_get_alloc_sbi);
519 static void afs_destroy_sbi(struct afs_super_info *as)
522 struct afs_net *net = afs_net(as->net_ns);
523 afs_put_volume(net, as->volume, afs_volume_trace_put_destroy_sbi);
524 afs_put_cell(net, as->cell);
530 static void afs_kill_super(struct super_block *sb)
532 struct afs_super_info *as = AFS_FS_S(sb);
535 afs_dynroot_depopulate(sb);
537 /* Clear the callback interests (which will do ilookup5) before
538 * deactivating the superblock.
541 rcu_assign_pointer(as->volume->sb, NULL);
544 afs_deactivate_volume(as->volume);
549 * Get an AFS superblock and root directory.
551 static int afs_get_tree(struct fs_context *fc)
553 struct afs_fs_context *ctx = fc->fs_private;
554 struct super_block *sb;
555 struct afs_super_info *as;
558 ret = afs_validate_fc(fc);
564 /* allocate a superblock info record */
566 as = afs_alloc_sbi(fc);
571 /* allocate a deviceless superblock */
573 as->dyn_root ? afs_dynroot_test_super : afs_test_super,
581 /* initial superblock/root creation */
583 ret = afs_fill_super(sb, ctx);
586 sb->s_flags |= SB_ACTIVE;
589 ASSERTCMP(sb->s_flags, &, SB_ACTIVE);
592 fc->root = dget(sb->s_root);
593 trace_afs_get_tree(as->cell, as->volume);
594 _leave(" = 0 [%p]", sb);
598 deactivate_locked_super(sb);
600 _leave(" = %d", ret);
604 static void afs_free_fc(struct fs_context *fc)
606 struct afs_fs_context *ctx = fc->fs_private;
608 afs_destroy_sbi(fc->s_fs_info);
609 afs_put_volume(ctx->net, ctx->volume, afs_volume_trace_put_free_fc);
610 afs_put_cell(ctx->net, ctx->cell);
615 static const struct fs_context_operations afs_context_ops = {
617 .parse_param = afs_parse_param,
618 .get_tree = afs_get_tree,
622 * Set up the filesystem mount context.
624 static int afs_init_fs_context(struct fs_context *fc)
626 struct afs_fs_context *ctx;
627 struct afs_cell *cell;
629 ctx = kzalloc(sizeof(struct afs_fs_context), GFP_KERNEL);
633 ctx->type = AFSVL_ROVOL;
634 ctx->net = afs_net(fc->net_ns);
636 /* Default to the workstation cell. */
638 cell = afs_lookup_cell_rcu(ctx->net, NULL, 0);
644 fc->fs_private = ctx;
645 fc->ops = &afs_context_ops;
650 * Initialise an inode cache slab element prior to any use. Note that
651 * afs_alloc_inode() *must* reset anything that could incorrectly leak from one
654 static void afs_i_init_once(void *_vnode)
656 struct afs_vnode *vnode = _vnode;
658 memset(vnode, 0, sizeof(*vnode));
659 inode_init_once(&vnode->vfs_inode);
660 mutex_init(&vnode->io_lock);
661 init_rwsem(&vnode->validate_lock);
662 spin_lock_init(&vnode->wb_lock);
663 spin_lock_init(&vnode->lock);
664 INIT_LIST_HEAD(&vnode->wb_keys);
665 INIT_LIST_HEAD(&vnode->pending_locks);
666 INIT_LIST_HEAD(&vnode->granted_locks);
667 INIT_DELAYED_WORK(&vnode->lock_work, afs_lock_work);
668 seqlock_init(&vnode->cb_lock);
672 * allocate an AFS inode struct from our slab cache
674 static struct inode *afs_alloc_inode(struct super_block *sb)
676 struct afs_vnode *vnode;
678 vnode = kmem_cache_alloc(afs_inode_cachep, GFP_KERNEL);
682 atomic_inc(&afs_count_active_inodes);
684 /* Reset anything that shouldn't leak from one inode to the next. */
685 memset(&vnode->fid, 0, sizeof(vnode->fid));
686 memset(&vnode->status, 0, sizeof(vnode->status));
688 vnode->volume = NULL;
689 vnode->lock_key = NULL;
690 vnode->permit_cache = NULL;
691 #ifdef CONFIG_AFS_FSCACHE
695 vnode->flags = 1 << AFS_VNODE_UNSET;
696 vnode->lock_state = AFS_VNODE_LOCK_NONE;
698 init_rwsem(&vnode->rmdir_lock);
700 _leave(" = %p", &vnode->vfs_inode);
701 return &vnode->vfs_inode;
704 static void afs_free_inode(struct inode *inode)
706 kmem_cache_free(afs_inode_cachep, AFS_FS_I(inode));
710 * destroy an AFS inode struct
712 static void afs_destroy_inode(struct inode *inode)
714 struct afs_vnode *vnode = AFS_FS_I(inode);
716 _enter("%p{%llx:%llu}", inode, vnode->fid.vid, vnode->fid.vnode);
718 _debug("DESTROY INODE %p", inode);
720 atomic_dec(&afs_count_active_inodes);
723 static void afs_get_volume_status_success(struct afs_operation *op)
725 struct afs_volume_status *vs = &op->volstatus.vs;
726 struct kstatfs *buf = op->volstatus.buf;
728 if (vs->max_quota == 0)
729 buf->f_blocks = vs->part_max_blocks;
731 buf->f_blocks = vs->max_quota;
733 if (buf->f_blocks > vs->blocks_in_use)
734 buf->f_bavail = buf->f_bfree =
735 buf->f_blocks - vs->blocks_in_use;
738 static const struct afs_operation_ops afs_get_volume_status_operation = {
739 .issue_afs_rpc = afs_fs_get_volume_status,
740 .issue_yfs_rpc = yfs_fs_get_volume_status,
741 .success = afs_get_volume_status_success,
745 * return information about an AFS volume
747 static int afs_statfs(struct dentry *dentry, struct kstatfs *buf)
749 struct afs_super_info *as = AFS_FS_S(dentry->d_sb);
750 struct afs_operation *op;
751 struct afs_vnode *vnode = AFS_FS_I(d_inode(dentry));
753 buf->f_type = dentry->d_sb->s_magic;
754 buf->f_bsize = AFS_BLOCK_SIZE;
755 buf->f_namelen = AFSNAMEMAX - 1;
764 op = afs_alloc_operation(NULL, as->volume);
768 afs_op_set_vnode(op, 0, vnode);
770 op->volstatus.buf = buf;
771 op->ops = &afs_get_volume_status_operation;
772 return afs_do_sync_operation(op);