Loading...
1/* AFS superblock handling
2 *
3 * Copyright (c) 2002, 2007 Red Hat, Inc. All rights reserved.
4 *
5 * This software may be freely redistributed under the terms of the
6 * GNU General Public License.
7 *
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.
11 *
12 * Authors: David Howells <dhowells@redhat.com>
13 * David Woodhouse <dwmw2@infradead.org>
14 *
15 */
16
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>
22#include <linux/fs.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>
30#include "internal.h"
31
32static void afs_i_init_once(void *foo);
33static struct dentry *afs_mount(struct file_system_type *fs_type,
34 int flags, const char *dev_name, void *data);
35static void afs_kill_super(struct super_block *sb);
36static struct inode *afs_alloc_inode(struct super_block *sb);
37static void afs_destroy_inode(struct inode *inode);
38static int afs_statfs(struct dentry *dentry, struct kstatfs *buf);
39static int afs_show_devname(struct seq_file *m, struct dentry *root);
40static int afs_show_options(struct seq_file *m, struct dentry *root);
41
42struct file_system_type afs_fs_type = {
43 .owner = THIS_MODULE,
44 .name = "afs",
45 .mount = afs_mount,
46 .kill_sb = afs_kill_super,
47 .fs_flags = 0,
48};
49MODULE_ALIAS_FS("afs");
50
51static const struct super_operations afs_super_ops = {
52 .statfs = afs_statfs,
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,
59};
60
61static struct kmem_cache *afs_inode_cachep;
62static atomic_t afs_count_active_inodes;
63
64enum {
65 afs_no_opt,
66 afs_opt_cell,
67 afs_opt_dyn,
68 afs_opt_rwpath,
69 afs_opt_vol,
70 afs_opt_autocell,
71};
72
73static const match_table_t afs_options_list = {
74 { afs_opt_cell, "cell=%s" },
75 { afs_opt_dyn, "dyn" },
76 { afs_opt_rwpath, "rwpath" },
77 { afs_opt_vol, "vol=%s" },
78 { afs_opt_autocell, "autocell" },
79 { afs_no_opt, NULL },
80};
81
82/*
83 * initialise the filesystem
84 */
85int __init afs_fs_init(void)
86{
87 int ret;
88
89 _enter("");
90
91 /* create ourselves an inode cache */
92 atomic_set(&afs_count_active_inodes, 0);
93
94 ret = -ENOMEM;
95 afs_inode_cachep = kmem_cache_create("afs_inode_cache",
96 sizeof(struct afs_vnode),
97 0,
98 SLAB_HWCACHE_ALIGN|SLAB_ACCOUNT,
99 afs_i_init_once);
100 if (!afs_inode_cachep) {
101 printk(KERN_NOTICE "kAFS: Failed to allocate inode cache\n");
102 return ret;
103 }
104
105 /* now export our filesystem to lesser mortals */
106 ret = register_filesystem(&afs_fs_type);
107 if (ret < 0) {
108 kmem_cache_destroy(afs_inode_cachep);
109 _leave(" = %d", ret);
110 return ret;
111 }
112
113 _leave(" = 0");
114 return 0;
115}
116
117/*
118 * clean up the filesystem
119 */
120void __exit afs_fs_exit(void)
121{
122 _enter("");
123
124 afs_mntpt_kill_timer();
125 unregister_filesystem(&afs_fs_type);
126
127 if (atomic_read(&afs_count_active_inodes) != 0) {
128 printk("kAFS: %d active inode objects still present\n",
129 atomic_read(&afs_count_active_inodes));
130 BUG();
131 }
132
133 /*
134 * Make sure all delayed rcu free inodes are flushed before we
135 * destroy cache.
136 */
137 rcu_barrier();
138 kmem_cache_destroy(afs_inode_cachep);
139 _leave("");
140}
141
142/*
143 * Display the mount device name in /proc/mounts.
144 */
145static int afs_show_devname(struct seq_file *m, struct dentry *root)
146{
147 struct afs_super_info *as = AFS_FS_S(root->d_sb);
148 struct afs_volume *volume = as->volume;
149 struct afs_cell *cell = as->cell;
150 const char *suf = "";
151 char pref = '%';
152
153 if (as->dyn_root) {
154 seq_puts(m, "none");
155 return 0;
156 }
157
158 switch (volume->type) {
159 case AFSVL_RWVOL:
160 break;
161 case AFSVL_ROVOL:
162 pref = '#';
163 if (volume->type_force)
164 suf = ".readonly";
165 break;
166 case AFSVL_BACKVOL:
167 pref = '#';
168 suf = ".backup";
169 break;
170 }
171
172 seq_printf(m, "%c%s:%s%s", pref, cell->name, volume->name, suf);
173 return 0;
174}
175
176/*
177 * Display the mount options in /proc/mounts.
178 */
179static int afs_show_options(struct seq_file *m, struct dentry *root)
180{
181 struct afs_super_info *as = AFS_FS_S(root->d_sb);
182
183 if (as->dyn_root)
184 seq_puts(m, ",dyn");
185 if (test_bit(AFS_VNODE_AUTOCELL, &AFS_FS_I(d_inode(root))->flags))
186 seq_puts(m, ",autocell");
187 return 0;
188}
189
190/*
191 * parse the mount options
192 * - this function has been shamelessly adapted from the ext3 fs which
193 * shamelessly adapted it from the msdos fs
194 */
195static int afs_parse_options(struct afs_mount_params *params,
196 char *options, const char **devname)
197{
198 struct afs_cell *cell;
199 substring_t args[MAX_OPT_ARGS];
200 char *p;
201 int token;
202
203 _enter("%s", options);
204
205 options[PAGE_SIZE - 1] = 0;
206
207 while ((p = strsep(&options, ","))) {
208 if (!*p)
209 continue;
210
211 token = match_token(p, afs_options_list, args);
212 switch (token) {
213 case afs_opt_cell:
214 rcu_read_lock();
215 cell = afs_lookup_cell_rcu(params->net,
216 args[0].from,
217 args[0].to - args[0].from);
218 rcu_read_unlock();
219 if (IS_ERR(cell))
220 return PTR_ERR(cell);
221 afs_put_cell(params->net, params->cell);
222 params->cell = cell;
223 break;
224
225 case afs_opt_rwpath:
226 params->rwpath = true;
227 break;
228
229 case afs_opt_vol:
230 *devname = args[0].from;
231 break;
232
233 case afs_opt_autocell:
234 params->autocell = true;
235 break;
236
237 case afs_opt_dyn:
238 params->dyn_root = true;
239 break;
240
241 default:
242 printk(KERN_ERR "kAFS:"
243 " Unknown or invalid mount option: '%s'\n", p);
244 return -EINVAL;
245 }
246 }
247
248 _leave(" = 0");
249 return 0;
250}
251
252/*
253 * parse a device name to get cell name, volume name, volume type and R/W
254 * selector
255 * - this can be one of the following:
256 * "%[cell:]volume[.]" R/W volume
257 * "#[cell:]volume[.]" R/O or R/W volume (rwpath=0),
258 * or R/W (rwpath=1) volume
259 * "%[cell:]volume.readonly" R/O volume
260 * "#[cell:]volume.readonly" R/O volume
261 * "%[cell:]volume.backup" Backup volume
262 * "#[cell:]volume.backup" Backup volume
263 */
264static int afs_parse_device_name(struct afs_mount_params *params,
265 const char *name)
266{
267 struct afs_cell *cell;
268 const char *cellname, *suffix;
269 int cellnamesz;
270
271 _enter(",%s", name);
272
273 if (!name) {
274 printk(KERN_ERR "kAFS: no volume name specified\n");
275 return -EINVAL;
276 }
277
278 if ((name[0] != '%' && name[0] != '#') || !name[1]) {
279 printk(KERN_ERR "kAFS: unparsable volume name\n");
280 return -EINVAL;
281 }
282
283 /* determine the type of volume we're looking for */
284 params->type = AFSVL_ROVOL;
285 params->force = false;
286 if (params->rwpath || name[0] == '%') {
287 params->type = AFSVL_RWVOL;
288 params->force = true;
289 }
290 name++;
291
292 /* split the cell name out if there is one */
293 params->volname = strchr(name, ':');
294 if (params->volname) {
295 cellname = name;
296 cellnamesz = params->volname - name;
297 params->volname++;
298 } else {
299 params->volname = name;
300 cellname = NULL;
301 cellnamesz = 0;
302 }
303
304 /* the volume type is further affected by a possible suffix */
305 suffix = strrchr(params->volname, '.');
306 if (suffix) {
307 if (strcmp(suffix, ".readonly") == 0) {
308 params->type = AFSVL_ROVOL;
309 params->force = true;
310 } else if (strcmp(suffix, ".backup") == 0) {
311 params->type = AFSVL_BACKVOL;
312 params->force = true;
313 } else if (suffix[1] == 0) {
314 } else {
315 suffix = NULL;
316 }
317 }
318
319 params->volnamesz = suffix ?
320 suffix - params->volname : strlen(params->volname);
321
322 _debug("cell %*.*s [%p]",
323 cellnamesz, cellnamesz, cellname ?: "", params->cell);
324
325 /* lookup the cell record */
326 if (cellname || !params->cell) {
327 cell = afs_lookup_cell(params->net, cellname, cellnamesz,
328 NULL, false);
329 if (IS_ERR(cell)) {
330 printk(KERN_ERR "kAFS: unable to lookup cell '%*.*s'\n",
331 cellnamesz, cellnamesz, cellname ?: "");
332 return PTR_ERR(cell);
333 }
334 afs_put_cell(params->net, params->cell);
335 params->cell = cell;
336 }
337
338 _debug("CELL:%s [%p] VOLUME:%*.*s SUFFIX:%s TYPE:%d%s",
339 params->cell->name, params->cell,
340 params->volnamesz, params->volnamesz, params->volname,
341 suffix ?: "-", params->type, params->force ? " FORCE" : "");
342
343 return 0;
344}
345
346/*
347 * check a superblock to see if it's the one we're looking for
348 */
349static int afs_test_super(struct super_block *sb, void *data)
350{
351 struct afs_super_info *as1 = data;
352 struct afs_super_info *as = AFS_FS_S(sb);
353
354 return (as->net == as1->net &&
355 as->volume &&
356 as->volume->vid == as1->volume->vid);
357}
358
359static int afs_dynroot_test_super(struct super_block *sb, void *data)
360{
361 return false;
362}
363
364static int afs_set_super(struct super_block *sb, void *data)
365{
366 struct afs_super_info *as = data;
367
368 sb->s_fs_info = as;
369 return set_anon_super(sb, NULL);
370}
371
372/*
373 * fill in the superblock
374 */
375static int afs_fill_super(struct super_block *sb,
376 struct afs_mount_params *params)
377{
378 struct afs_super_info *as = AFS_FS_S(sb);
379 struct afs_fid fid;
380 struct inode *inode = NULL;
381 int ret;
382
383 _enter("");
384
385 /* fill in the superblock */
386 sb->s_blocksize = PAGE_SIZE;
387 sb->s_blocksize_bits = PAGE_SHIFT;
388 sb->s_magic = AFS_FS_MAGIC;
389 sb->s_op = &afs_super_ops;
390 if (!as->dyn_root)
391 sb->s_xattr = afs_xattr_handlers;
392 ret = super_setup_bdi(sb);
393 if (ret)
394 return ret;
395 sb->s_bdi->ra_pages = VM_MAX_READAHEAD * 1024 / PAGE_SIZE;
396
397 /* allocate the root inode and dentry */
398 if (as->dyn_root) {
399 inode = afs_iget_pseudo_dir(sb, true);
400 sb->s_flags |= SB_RDONLY;
401 } else {
402 sprintf(sb->s_id, "%u", as->volume->vid);
403 afs_activate_volume(as->volume);
404 fid.vid = as->volume->vid;
405 fid.vnode = 1;
406 fid.unique = 1;
407 inode = afs_iget(sb, params->key, &fid, NULL, NULL, NULL);
408 }
409
410 if (IS_ERR(inode))
411 return PTR_ERR(inode);
412
413 if (params->autocell || params->dyn_root)
414 set_bit(AFS_VNODE_AUTOCELL, &AFS_FS_I(inode)->flags);
415
416 ret = -ENOMEM;
417 sb->s_root = d_make_root(inode);
418 if (!sb->s_root)
419 goto error;
420
421 if (params->dyn_root)
422 sb->s_d_op = &afs_dynroot_dentry_operations;
423 else
424 sb->s_d_op = &afs_fs_dentry_operations;
425
426 _leave(" = 0");
427 return 0;
428
429error:
430 _leave(" = %d", ret);
431 return ret;
432}
433
434static struct afs_super_info *afs_alloc_sbi(struct afs_mount_params *params)
435{
436 struct afs_super_info *as;
437
438 as = kzalloc(sizeof(struct afs_super_info), GFP_KERNEL);
439 if (as) {
440 as->net = afs_get_net(params->net);
441 if (params->dyn_root)
442 as->dyn_root = true;
443 else
444 as->cell = afs_get_cell(params->cell);
445 }
446 return as;
447}
448
449static void afs_destroy_sbi(struct afs_super_info *as)
450{
451 if (as) {
452 afs_put_volume(as->cell, as->volume);
453 afs_put_cell(as->net, as->cell);
454 afs_put_net(as->net);
455 kfree(as);
456 }
457}
458
459/*
460 * get an AFS superblock
461 */
462static struct dentry *afs_mount(struct file_system_type *fs_type,
463 int flags, const char *dev_name, void *options)
464{
465 struct afs_mount_params params;
466 struct super_block *sb;
467 struct afs_volume *candidate;
468 struct key *key;
469 struct afs_super_info *as;
470 int ret;
471
472 _enter(",,%s,%p", dev_name, options);
473
474 memset(¶ms, 0, sizeof(params));
475 params.net = &__afs_net;
476
477 ret = -EINVAL;
478 if (current->nsproxy->net_ns != &init_net)
479 goto error;
480
481 /* parse the options and device name */
482 if (options) {
483 ret = afs_parse_options(¶ms, options, &dev_name);
484 if (ret < 0)
485 goto error;
486 }
487
488 if (!params.dyn_root) {
489 ret = afs_parse_device_name(¶ms, dev_name);
490 if (ret < 0)
491 goto error;
492
493 /* try and do the mount securely */
494 key = afs_request_key(params.cell);
495 if (IS_ERR(key)) {
496 _leave(" = %ld [key]", PTR_ERR(key));
497 ret = PTR_ERR(key);
498 goto error;
499 }
500 params.key = key;
501 }
502
503 /* allocate a superblock info record */
504 ret = -ENOMEM;
505 as = afs_alloc_sbi(¶ms);
506 if (!as)
507 goto error_key;
508
509 if (!params.dyn_root) {
510 /* Assume we're going to need a volume record; at the very
511 * least we can use it to update the volume record if we have
512 * one already. This checks that the volume exists within the
513 * cell.
514 */
515 candidate = afs_create_volume(¶ms);
516 if (IS_ERR(candidate)) {
517 ret = PTR_ERR(candidate);
518 goto error_as;
519 }
520
521 as->volume = candidate;
522 }
523
524 /* allocate a deviceless superblock */
525 sb = sget(fs_type,
526 as->dyn_root ? afs_dynroot_test_super : afs_test_super,
527 afs_set_super, flags, as);
528 if (IS_ERR(sb)) {
529 ret = PTR_ERR(sb);
530 goto error_as;
531 }
532
533 if (!sb->s_root) {
534 /* initial superblock/root creation */
535 _debug("create");
536 ret = afs_fill_super(sb, ¶ms);
537 if (ret < 0)
538 goto error_sb;
539 as = NULL;
540 sb->s_flags |= SB_ACTIVE;
541 } else {
542 _debug("reuse");
543 ASSERTCMP(sb->s_flags, &, SB_ACTIVE);
544 afs_destroy_sbi(as);
545 as = NULL;
546 }
547
548 afs_put_cell(params.net, params.cell);
549 key_put(params.key);
550 _leave(" = 0 [%p]", sb);
551 return dget(sb->s_root);
552
553error_sb:
554 deactivate_locked_super(sb);
555 goto error_key;
556error_as:
557 afs_destroy_sbi(as);
558error_key:
559 key_put(params.key);
560error:
561 afs_put_cell(params.net, params.cell);
562 _leave(" = %d", ret);
563 return ERR_PTR(ret);
564}
565
566static void afs_kill_super(struct super_block *sb)
567{
568 struct afs_super_info *as = AFS_FS_S(sb);
569
570 /* Clear the callback interests (which will do ilookup5) before
571 * deactivating the superblock.
572 */
573 if (as->volume)
574 afs_clear_callback_interests(as->net, as->volume->servers);
575 kill_anon_super(sb);
576 if (as->volume)
577 afs_deactivate_volume(as->volume);
578 afs_destroy_sbi(as);
579}
580
581/*
582 * Initialise an inode cache slab element prior to any use. Note that
583 * afs_alloc_inode() *must* reset anything that could incorrectly leak from one
584 * inode to another.
585 */
586static void afs_i_init_once(void *_vnode)
587{
588 struct afs_vnode *vnode = _vnode;
589
590 memset(vnode, 0, sizeof(*vnode));
591 inode_init_once(&vnode->vfs_inode);
592 mutex_init(&vnode->io_lock);
593 init_rwsem(&vnode->validate_lock);
594 spin_lock_init(&vnode->wb_lock);
595 spin_lock_init(&vnode->lock);
596 INIT_LIST_HEAD(&vnode->wb_keys);
597 INIT_LIST_HEAD(&vnode->pending_locks);
598 INIT_LIST_HEAD(&vnode->granted_locks);
599 INIT_DELAYED_WORK(&vnode->lock_work, afs_lock_work);
600 seqlock_init(&vnode->cb_lock);
601}
602
603/*
604 * allocate an AFS inode struct from our slab cache
605 */
606static struct inode *afs_alloc_inode(struct super_block *sb)
607{
608 struct afs_vnode *vnode;
609
610 vnode = kmem_cache_alloc(afs_inode_cachep, GFP_KERNEL);
611 if (!vnode)
612 return NULL;
613
614 atomic_inc(&afs_count_active_inodes);
615
616 /* Reset anything that shouldn't leak from one inode to the next. */
617 memset(&vnode->fid, 0, sizeof(vnode->fid));
618 memset(&vnode->status, 0, sizeof(vnode->status));
619
620 vnode->volume = NULL;
621 vnode->lock_key = NULL;
622 vnode->permit_cache = NULL;
623 vnode->cb_interest = NULL;
624#ifdef CONFIG_AFS_FSCACHE
625 vnode->cache = NULL;
626#endif
627
628 vnode->flags = 1 << AFS_VNODE_UNSET;
629 vnode->cb_type = 0;
630 vnode->lock_state = AFS_VNODE_LOCK_NONE;
631
632 _leave(" = %p", &vnode->vfs_inode);
633 return &vnode->vfs_inode;
634}
635
636static void afs_i_callback(struct rcu_head *head)
637{
638 struct inode *inode = container_of(head, struct inode, i_rcu);
639 struct afs_vnode *vnode = AFS_FS_I(inode);
640 kmem_cache_free(afs_inode_cachep, vnode);
641}
642
643/*
644 * destroy an AFS inode struct
645 */
646static void afs_destroy_inode(struct inode *inode)
647{
648 struct afs_vnode *vnode = AFS_FS_I(inode);
649
650 _enter("%p{%x:%u}", inode, vnode->fid.vid, vnode->fid.vnode);
651
652 _debug("DESTROY INODE %p", inode);
653
654 ASSERTCMP(vnode->cb_interest, ==, NULL);
655
656 call_rcu(&inode->i_rcu, afs_i_callback);
657 atomic_dec(&afs_count_active_inodes);
658}
659
660/*
661 * return information about an AFS volume
662 */
663static int afs_statfs(struct dentry *dentry, struct kstatfs *buf)
664{
665 struct afs_super_info *as = AFS_FS_S(dentry->d_sb);
666 struct afs_fs_cursor fc;
667 struct afs_volume_status vs;
668 struct afs_vnode *vnode = AFS_FS_I(d_inode(dentry));
669 struct key *key;
670 int ret;
671
672 buf->f_type = dentry->d_sb->s_magic;
673 buf->f_bsize = AFS_BLOCK_SIZE;
674 buf->f_namelen = AFSNAMEMAX - 1;
675
676 if (as->dyn_root) {
677 buf->f_blocks = 1;
678 buf->f_bavail = 0;
679 buf->f_bfree = 0;
680 return 0;
681 }
682
683 key = afs_request_key(vnode->volume->cell);
684 if (IS_ERR(key))
685 return PTR_ERR(key);
686
687 ret = -ERESTARTSYS;
688 if (afs_begin_vnode_operation(&fc, vnode, key)) {
689 fc.flags |= AFS_FS_CURSOR_NO_VSLEEP;
690 while (afs_select_fileserver(&fc)) {
691 fc.cb_break = afs_calc_vnode_cb_break(vnode);
692 afs_fs_get_volume_status(&fc, &vs);
693 }
694
695 afs_check_for_remote_deletion(&fc, fc.vnode);
696 afs_vnode_commit_status(&fc, vnode, fc.cb_break);
697 ret = afs_end_vnode_operation(&fc);
698 }
699
700 key_put(key);
701
702 if (ret == 0) {
703 if (vs.max_quota == 0)
704 buf->f_blocks = vs.part_max_blocks;
705 else
706 buf->f_blocks = vs.max_quota;
707 buf->f_bavail = buf->f_bfree = buf->f_blocks - vs.blocks_in_use;
708 }
709
710 return ret;
711}
1/* AFS superblock handling
2 *
3 * Copyright (c) 2002, 2007, 2018 Red Hat, Inc. All rights reserved.
4 *
5 * This software may be freely redistributed under the terms of the
6 * GNU General Public License.
7 *
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.
11 *
12 * Authors: David Howells <dhowells@redhat.com>
13 * David Woodhouse <dwmw2@infradead.org>
14 *
15 */
16
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>
22#include <linux/fs.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>
30#include "internal.h"
31
32static void afs_i_init_once(void *foo);
33static void afs_kill_super(struct super_block *sb);
34static struct inode *afs_alloc_inode(struct super_block *sb);
35static void afs_destroy_inode(struct inode *inode);
36static void afs_free_inode(struct inode *inode);
37static int afs_statfs(struct dentry *dentry, struct kstatfs *buf);
38static int afs_show_devname(struct seq_file *m, struct dentry *root);
39static int afs_show_options(struct seq_file *m, struct dentry *root);
40static int afs_init_fs_context(struct fs_context *fc);
41static const struct fs_parameter_description afs_fs_parameters;
42
43struct file_system_type afs_fs_type = {
44 .owner = THIS_MODULE,
45 .name = "afs",
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,
50};
51MODULE_ALIAS_FS("afs");
52
53int afs_net_id;
54
55static const struct super_operations afs_super_ops = {
56 .statfs = afs_statfs,
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,
64};
65
66static struct kmem_cache *afs_inode_cachep;
67static atomic_t afs_count_active_inodes;
68
69enum afs_param {
70 Opt_autocell,
71 Opt_dyn,
72 Opt_flock,
73 Opt_source,
74};
75
76static 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),
81 {}
82};
83
84static 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 },
89 {}
90};
91
92static const struct fs_parameter_description afs_fs_parameters = {
93 .name = "kAFS",
94 .specs = afs_param_specs,
95 .enums = afs_param_enums,
96};
97
98/*
99 * initialise the filesystem
100 */
101int __init afs_fs_init(void)
102{
103 int ret;
104
105 _enter("");
106
107 /* create ourselves an inode cache */
108 atomic_set(&afs_count_active_inodes, 0);
109
110 ret = -ENOMEM;
111 afs_inode_cachep = kmem_cache_create("afs_inode_cache",
112 sizeof(struct afs_vnode),
113 0,
114 SLAB_HWCACHE_ALIGN|SLAB_ACCOUNT,
115 afs_i_init_once);
116 if (!afs_inode_cachep) {
117 printk(KERN_NOTICE "kAFS: Failed to allocate inode cache\n");
118 return ret;
119 }
120
121 /* now export our filesystem to lesser mortals */
122 ret = register_filesystem(&afs_fs_type);
123 if (ret < 0) {
124 kmem_cache_destroy(afs_inode_cachep);
125 _leave(" = %d", ret);
126 return ret;
127 }
128
129 _leave(" = 0");
130 return 0;
131}
132
133/*
134 * clean up the filesystem
135 */
136void afs_fs_exit(void)
137{
138 _enter("");
139
140 afs_mntpt_kill_timer();
141 unregister_filesystem(&afs_fs_type);
142
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));
146 BUG();
147 }
148
149 /*
150 * Make sure all delayed rcu free inodes are flushed before we
151 * destroy cache.
152 */
153 rcu_barrier();
154 kmem_cache_destroy(afs_inode_cachep);
155 _leave("");
156}
157
158/*
159 * Display the mount device name in /proc/mounts.
160 */
161static int afs_show_devname(struct seq_file *m, struct dentry *root)
162{
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 = "";
167 char pref = '%';
168
169 if (as->dyn_root) {
170 seq_puts(m, "none");
171 return 0;
172 }
173
174 switch (volume->type) {
175 case AFSVL_RWVOL:
176 break;
177 case AFSVL_ROVOL:
178 pref = '#';
179 if (volume->type_force)
180 suf = ".readonly";
181 break;
182 case AFSVL_BACKVOL:
183 pref = '#';
184 suf = ".backup";
185 break;
186 }
187
188 seq_printf(m, "%c%s:%s%s", pref, cell->name, volume->name, suf);
189 return 0;
190}
191
192/*
193 * Display the mount options in /proc/mounts.
194 */
195static int afs_show_options(struct seq_file *m, struct dentry *root)
196{
197 struct afs_super_info *as = AFS_FS_S(root->d_sb);
198 const char *p = NULL;
199
200 if (as->dyn_root)
201 seq_puts(m, ",dyn");
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;
210 }
211 if (p)
212 seq_printf(m, ",flock=%s", p);
213
214 return 0;
215}
216
217/*
218 * Parse the source name to get cell name, volume name, volume type and R/W
219 * selector.
220 *
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
229 */
230static int afs_parse_source(struct fs_context *fc, struct fs_parameter *param)
231{
232 struct afs_fs_context *ctx = fc->fs_private;
233 struct afs_cell *cell;
234 const char *cellname, *suffix, *name = param->string;
235 int cellnamesz;
236
237 _enter(",%s", name);
238
239 if (!name) {
240 printk(KERN_ERR "kAFS: no volume name specified\n");
241 return -EINVAL;
242 }
243
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) {
247 ctx->no_cell = true;
248 return 0;
249 }
250 printk(KERN_ERR "kAFS: unparsable volume name\n");
251 return -EINVAL;
252 }
253
254 /* determine the type of volume we're looking for */
255 if (name[0] == '%') {
256 ctx->type = AFSVL_RWVOL;
257 ctx->force = true;
258 }
259 name++;
260
261 /* split the cell name out if there is one */
262 ctx->volname = strchr(name, ':');
263 if (ctx->volname) {
264 cellname = name;
265 cellnamesz = ctx->volname - name;
266 ctx->volname++;
267 } else {
268 ctx->volname = name;
269 cellname = NULL;
270 cellnamesz = 0;
271 }
272
273 /* the volume type is further affected by a possible suffix */
274 suffix = strrchr(ctx->volname, '.');
275 if (suffix) {
276 if (strcmp(suffix, ".readonly") == 0) {
277 ctx->type = AFSVL_ROVOL;
278 ctx->force = true;
279 } else if (strcmp(suffix, ".backup") == 0) {
280 ctx->type = AFSVL_BACKVOL;
281 ctx->force = true;
282 } else if (suffix[1] == 0) {
283 } else {
284 suffix = NULL;
285 }
286 }
287
288 ctx->volnamesz = suffix ?
289 suffix - ctx->volname : strlen(ctx->volname);
290
291 _debug("cell %*.*s [%p]",
292 cellnamesz, cellnamesz, cellname ?: "", ctx->cell);
293
294 /* lookup the cell record */
295 if (cellname) {
296 cell = afs_lookup_cell(ctx->net, cellname, cellnamesz,
297 NULL, false);
298 if (IS_ERR(cell)) {
299 pr_err("kAFS: unable to lookup cell '%*.*s'\n",
300 cellnamesz, cellnamesz, cellname ?: "");
301 return PTR_ERR(cell);
302 }
303 afs_put_cell(ctx->net, ctx->cell);
304 ctx->cell = cell;
305 }
306
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" : "");
311
312 fc->source = param->string;
313 param->string = NULL;
314 return 0;
315}
316
317/*
318 * Parse a single mount parameter.
319 */
320static int afs_parse_param(struct fs_context *fc, struct fs_parameter *param)
321{
322 struct fs_parse_result result;
323 struct afs_fs_context *ctx = fc->fs_private;
324 int opt;
325
326 opt = fs_parse(fc, &afs_fs_parameters, param, &result);
327 if (opt < 0)
328 return opt;
329
330 switch (opt) {
331 case Opt_source:
332 return afs_parse_source(fc, param);
333
334 case Opt_autocell:
335 ctx->autocell = true;
336 break;
337
338 case Opt_dyn:
339 ctx->dyn_root = true;
340 break;
341
342 case Opt_flock:
343 ctx->flock_mode = result.uint_32;
344 break;
345
346 default:
347 return -EINVAL;
348 }
349
350 _leave(" = 0");
351 return 0;
352}
353
354/*
355 * Validate the options, get the cell key and look up the volume.
356 */
357static int afs_validate_fc(struct fs_context *fc)
358{
359 struct afs_fs_context *ctx = fc->fs_private;
360 struct afs_volume *volume;
361 struct key *key;
362
363 if (!ctx->dyn_root) {
364 if (ctx->no_cell) {
365 pr_warn("kAFS: Can only specify source 'none' with -o dyn\n");
366 return -EINVAL;
367 }
368
369 if (!ctx->cell) {
370 pr_warn("kAFS: No cell specified\n");
371 return -EDESTADDRREQ;
372 }
373
374 /* We try to do the mount securely. */
375 key = afs_request_key(ctx->cell);
376 if (IS_ERR(key))
377 return PTR_ERR(key);
378
379 ctx->key = key;
380
381 if (ctx->volume) {
382 afs_put_volume(ctx->cell, ctx->volume);
383 ctx->volume = NULL;
384 }
385
386 volume = afs_create_volume(ctx);
387 if (IS_ERR(volume))
388 return PTR_ERR(volume);
389
390 ctx->volume = volume;
391 }
392
393 return 0;
394}
395
396/*
397 * check a superblock to see if it's the one we're looking for
398 */
399static int afs_test_super(struct super_block *sb, struct fs_context *fc)
400{
401 struct afs_fs_context *ctx = fc->fs_private;
402 struct afs_super_info *as = AFS_FS_S(sb);
403
404 return (as->net_ns == fc->net_ns &&
405 as->volume &&
406 as->volume->vid == ctx->volume->vid &&
407 !as->dyn_root);
408}
409
410static int afs_dynroot_test_super(struct super_block *sb, struct fs_context *fc)
411{
412 struct afs_super_info *as = AFS_FS_S(sb);
413
414 return (as->net_ns == fc->net_ns &&
415 as->dyn_root);
416}
417
418static int afs_set_super(struct super_block *sb, struct fs_context *fc)
419{
420 return set_anon_super(sb, NULL);
421}
422
423/*
424 * fill in the superblock
425 */
426static int afs_fill_super(struct super_block *sb, struct afs_fs_context *ctx)
427{
428 struct afs_super_info *as = AFS_FS_S(sb);
429 struct afs_iget_data iget_data;
430 struct inode *inode = NULL;
431 int ret;
432
433 _enter("");
434
435 /* fill in the superblock */
436 sb->s_blocksize = PAGE_SIZE;
437 sb->s_blocksize_bits = PAGE_SHIFT;
438 sb->s_maxbytes = MAX_LFS_FILESIZE;
439 sb->s_magic = AFS_FS_MAGIC;
440 sb->s_op = &afs_super_ops;
441 if (!as->dyn_root)
442 sb->s_xattr = afs_xattr_handlers;
443 ret = super_setup_bdi(sb);
444 if (ret)
445 return ret;
446 sb->s_bdi->ra_pages = VM_READAHEAD_PAGES;
447
448 /* allocate the root inode and dentry */
449 if (as->dyn_root) {
450 inode = afs_iget_pseudo_dir(sb, true);
451 sb->s_flags |= SB_RDONLY;
452 } else {
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);
462 }
463
464 if (IS_ERR(inode))
465 return PTR_ERR(inode);
466
467 if (ctx->autocell || as->dyn_root)
468 set_bit(AFS_VNODE_AUTOCELL, &AFS_FS_I(inode)->flags);
469
470 ret = -ENOMEM;
471 sb->s_root = d_make_root(inode);
472 if (!sb->s_root)
473 goto error;
474
475 if (as->dyn_root) {
476 sb->s_d_op = &afs_dynroot_dentry_operations;
477 ret = afs_dynroot_populate(sb);
478 if (ret < 0)
479 goto error;
480 } else {
481 sb->s_d_op = &afs_fs_dentry_operations;
482 }
483
484 _leave(" = 0");
485 return 0;
486
487error:
488 _leave(" = %d", ret);
489 return ret;
490}
491
492static struct afs_super_info *afs_alloc_sbi(struct fs_context *fc)
493{
494 struct afs_fs_context *ctx = fc->fs_private;
495 struct afs_super_info *as;
496
497 as = kzalloc(sizeof(struct afs_super_info), GFP_KERNEL);
498 if (as) {
499 as->net_ns = get_net(fc->net_ns);
500 as->flock_mode = ctx->flock_mode;
501 if (ctx->dyn_root) {
502 as->dyn_root = true;
503 } else {
504 as->cell = afs_get_cell(ctx->cell);
505 as->volume = __afs_get_volume(ctx->volume);
506 }
507 }
508 return as;
509}
510
511static void afs_destroy_sbi(struct afs_super_info *as)
512{
513 if (as) {
514 afs_put_volume(as->cell, as->volume);
515 afs_put_cell(afs_net(as->net_ns), as->cell);
516 put_net(as->net_ns);
517 kfree(as);
518 }
519}
520
521static void afs_kill_super(struct super_block *sb)
522{
523 struct afs_super_info *as = AFS_FS_S(sb);
524 struct afs_net *net = afs_net(as->net_ns);
525
526 if (as->dyn_root)
527 afs_dynroot_depopulate(sb);
528
529 /* Clear the callback interests (which will do ilookup5) before
530 * deactivating the superblock.
531 */
532 if (as->volume)
533 afs_clear_callback_interests(net, as->volume->servers);
534 kill_anon_super(sb);
535 if (as->volume)
536 afs_deactivate_volume(as->volume);
537 afs_destroy_sbi(as);
538}
539
540/*
541 * Get an AFS superblock and root directory.
542 */
543static int afs_get_tree(struct fs_context *fc)
544{
545 struct afs_fs_context *ctx = fc->fs_private;
546 struct super_block *sb;
547 struct afs_super_info *as;
548 int ret;
549
550 ret = afs_validate_fc(fc);
551 if (ret)
552 goto error;
553
554 _enter("");
555
556 /* allocate a superblock info record */
557 ret = -ENOMEM;
558 as = afs_alloc_sbi(fc);
559 if (!as)
560 goto error;
561 fc->s_fs_info = as;
562
563 /* allocate a deviceless superblock */
564 sb = sget_fc(fc,
565 as->dyn_root ? afs_dynroot_test_super : afs_test_super,
566 afs_set_super);
567 if (IS_ERR(sb)) {
568 ret = PTR_ERR(sb);
569 goto error;
570 }
571
572 if (!sb->s_root) {
573 /* initial superblock/root creation */
574 _debug("create");
575 ret = afs_fill_super(sb, ctx);
576 if (ret < 0)
577 goto error_sb;
578 sb->s_flags |= SB_ACTIVE;
579 } else {
580 _debug("reuse");
581 ASSERTCMP(sb->s_flags, &, SB_ACTIVE);
582 }
583
584 fc->root = dget(sb->s_root);
585 trace_afs_get_tree(as->cell, as->volume);
586 _leave(" = 0 [%p]", sb);
587 return 0;
588
589error_sb:
590 deactivate_locked_super(sb);
591error:
592 _leave(" = %d", ret);
593 return ret;
594}
595
596static void afs_free_fc(struct fs_context *fc)
597{
598 struct afs_fs_context *ctx = fc->fs_private;
599
600 afs_destroy_sbi(fc->s_fs_info);
601 afs_put_volume(ctx->cell, ctx->volume);
602 afs_put_cell(ctx->net, ctx->cell);
603 key_put(ctx->key);
604 kfree(ctx);
605}
606
607static const struct fs_context_operations afs_context_ops = {
608 .free = afs_free_fc,
609 .parse_param = afs_parse_param,
610 .get_tree = afs_get_tree,
611};
612
613/*
614 * Set up the filesystem mount context.
615 */
616static int afs_init_fs_context(struct fs_context *fc)
617{
618 struct afs_fs_context *ctx;
619 struct afs_cell *cell;
620
621 ctx = kzalloc(sizeof(struct afs_fs_context), GFP_KERNEL);
622 if (!ctx)
623 return -ENOMEM;
624
625 ctx->type = AFSVL_ROVOL;
626 ctx->net = afs_net(fc->net_ns);
627
628 /* Default to the workstation cell. */
629 rcu_read_lock();
630 cell = afs_lookup_cell_rcu(ctx->net, NULL, 0);
631 rcu_read_unlock();
632 if (IS_ERR(cell))
633 cell = NULL;
634 ctx->cell = cell;
635
636 fc->fs_private = ctx;
637 fc->ops = &afs_context_ops;
638 return 0;
639}
640
641/*
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
644 * inode to another.
645 */
646static void afs_i_init_once(void *_vnode)
647{
648 struct afs_vnode *vnode = _vnode;
649
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);
661}
662
663/*
664 * allocate an AFS inode struct from our slab cache
665 */
666static struct inode *afs_alloc_inode(struct super_block *sb)
667{
668 struct afs_vnode *vnode;
669
670 vnode = kmem_cache_alloc(afs_inode_cachep, GFP_KERNEL);
671 if (!vnode)
672 return NULL;
673
674 atomic_inc(&afs_count_active_inodes);
675
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));
679
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
685 vnode->cache = NULL;
686#endif
687
688 vnode->flags = 1 << AFS_VNODE_UNSET;
689 vnode->lock_state = AFS_VNODE_LOCK_NONE;
690
691 init_rwsem(&vnode->rmdir_lock);
692
693 _leave(" = %p", &vnode->vfs_inode);
694 return &vnode->vfs_inode;
695}
696
697static void afs_free_inode(struct inode *inode)
698{
699 kmem_cache_free(afs_inode_cachep, AFS_FS_I(inode));
700}
701
702/*
703 * destroy an AFS inode struct
704 */
705static void afs_destroy_inode(struct inode *inode)
706{
707 struct afs_vnode *vnode = AFS_FS_I(inode);
708
709 _enter("%p{%llx:%llu}", inode, vnode->fid.vid, vnode->fid.vnode);
710
711 _debug("DESTROY INODE %p", inode);
712
713 ASSERTCMP(rcu_access_pointer(vnode->cb_interest), ==, NULL);
714
715 atomic_dec(&afs_count_active_inodes);
716}
717
718/*
719 * return information about an AFS volume
720 */
721static int afs_statfs(struct dentry *dentry, struct kstatfs *buf)
722{
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));
727 struct key *key;
728 int ret;
729
730 buf->f_type = dentry->d_sb->s_magic;
731 buf->f_bsize = AFS_BLOCK_SIZE;
732 buf->f_namelen = AFSNAMEMAX - 1;
733
734 if (as->dyn_root) {
735 buf->f_blocks = 1;
736 buf->f_bavail = 0;
737 buf->f_bfree = 0;
738 return 0;
739 }
740
741 key = afs_request_key(vnode->volume->cell);
742 if (IS_ERR(key))
743 return PTR_ERR(key);
744
745 ret = -ERESTARTSYS;
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);
751 }
752
753 afs_check_for_remote_deletion(&fc, fc.vnode);
754 ret = afs_end_vnode_operation(&fc);
755 }
756
757 key_put(key);
758
759 if (ret == 0) {
760 if (vs.max_quota == 0)
761 buf->f_blocks = vs.part_max_blocks;
762 else
763 buf->f_blocks = vs.max_quota;
764 buf->f_bavail = buf->f_bfree = buf->f_blocks - vs.blocks_in_use;
765 }
766
767 return ret;
768}