1 /* /proc interface for AFS
3 * Copyright (C) 2002 Red Hat, Inc. All Rights Reserved.
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
12 #include <linux/slab.h>
13 #include <linux/module.h>
14 #include <linux/proc_fs.h>
15 #include <linux/seq_file.h>
16 #include <linux/sched.h>
17 #include <linux/uaccess.h>
20 static inline struct afs_net *afs_proc2net(struct file *f)
25 static inline struct afs_net *afs_seq2net(struct seq_file *m)
27 return &__afs_net; // TODO: use seq_file_net(m)
30 static int afs_proc_cells_open(struct inode *inode, struct file *file);
31 static void *afs_proc_cells_start(struct seq_file *p, loff_t *pos);
32 static void *afs_proc_cells_next(struct seq_file *p, void *v, loff_t *pos);
33 static void afs_proc_cells_stop(struct seq_file *p, void *v);
34 static int afs_proc_cells_show(struct seq_file *m, void *v);
35 static ssize_t afs_proc_cells_write(struct file *file, const char __user *buf,
36 size_t size, loff_t *_pos);
38 static const struct seq_operations afs_proc_cells_ops = {
39 .start = afs_proc_cells_start,
40 .next = afs_proc_cells_next,
41 .stop = afs_proc_cells_stop,
42 .show = afs_proc_cells_show,
45 static const struct file_operations afs_proc_cells_fops = {
46 .open = afs_proc_cells_open,
48 .write = afs_proc_cells_write,
50 .release = seq_release,
53 static ssize_t afs_proc_rootcell_read(struct file *file, char __user *buf,
54 size_t size, loff_t *_pos);
55 static ssize_t afs_proc_rootcell_write(struct file *file,
56 const char __user *buf,
57 size_t size, loff_t *_pos);
59 static const struct file_operations afs_proc_rootcell_fops = {
60 .read = afs_proc_rootcell_read,
61 .write = afs_proc_rootcell_write,
65 static int afs_proc_cell_volumes_open(struct inode *inode, struct file *file);
66 static void *afs_proc_cell_volumes_start(struct seq_file *p, loff_t *pos);
67 static void *afs_proc_cell_volumes_next(struct seq_file *p, void *v,
69 static void afs_proc_cell_volumes_stop(struct seq_file *p, void *v);
70 static int afs_proc_cell_volumes_show(struct seq_file *m, void *v);
72 static const struct seq_operations afs_proc_cell_volumes_ops = {
73 .start = afs_proc_cell_volumes_start,
74 .next = afs_proc_cell_volumes_next,
75 .stop = afs_proc_cell_volumes_stop,
76 .show = afs_proc_cell_volumes_show,
79 static const struct file_operations afs_proc_cell_volumes_fops = {
80 .open = afs_proc_cell_volumes_open,
83 .release = seq_release,
86 static int afs_proc_cell_vlservers_open(struct inode *inode,
88 static void *afs_proc_cell_vlservers_start(struct seq_file *p, loff_t *pos);
89 static void *afs_proc_cell_vlservers_next(struct seq_file *p, void *v,
91 static void afs_proc_cell_vlservers_stop(struct seq_file *p, void *v);
92 static int afs_proc_cell_vlservers_show(struct seq_file *m, void *v);
94 static const struct seq_operations afs_proc_cell_vlservers_ops = {
95 .start = afs_proc_cell_vlservers_start,
96 .next = afs_proc_cell_vlservers_next,
97 .stop = afs_proc_cell_vlservers_stop,
98 .show = afs_proc_cell_vlservers_show,
101 static const struct file_operations afs_proc_cell_vlservers_fops = {
102 .open = afs_proc_cell_vlservers_open,
105 .release = seq_release,
108 static int afs_proc_servers_open(struct inode *inode, struct file *file);
109 static void *afs_proc_servers_start(struct seq_file *p, loff_t *pos);
110 static void *afs_proc_servers_next(struct seq_file *p, void *v,
112 static void afs_proc_servers_stop(struct seq_file *p, void *v);
113 static int afs_proc_servers_show(struct seq_file *m, void *v);
115 static const struct seq_operations afs_proc_servers_ops = {
116 .start = afs_proc_servers_start,
117 .next = afs_proc_servers_next,
118 .stop = afs_proc_servers_stop,
119 .show = afs_proc_servers_show,
122 static const struct file_operations afs_proc_servers_fops = {
123 .open = afs_proc_servers_open,
126 .release = seq_release,
129 static int afs_proc_sysname_open(struct inode *inode, struct file *file);
130 static int afs_proc_sysname_release(struct inode *inode, struct file *file);
131 static void *afs_proc_sysname_start(struct seq_file *p, loff_t *pos);
132 static void *afs_proc_sysname_next(struct seq_file *p, void *v,
134 static void afs_proc_sysname_stop(struct seq_file *p, void *v);
135 static int afs_proc_sysname_show(struct seq_file *m, void *v);
136 static ssize_t afs_proc_sysname_write(struct file *file,
137 const char __user *buf,
138 size_t size, loff_t *_pos);
140 static const struct seq_operations afs_proc_sysname_ops = {
141 .start = afs_proc_sysname_start,
142 .next = afs_proc_sysname_next,
143 .stop = afs_proc_sysname_stop,
144 .show = afs_proc_sysname_show,
147 static const struct file_operations afs_proc_sysname_fops = {
148 .open = afs_proc_sysname_open,
151 .release = afs_proc_sysname_release,
152 .write = afs_proc_sysname_write,
155 static const struct file_operations afs_proc_stats_fops;
158 * initialise the /proc/fs/afs/ directory
160 int afs_proc_init(struct afs_net *net)
164 net->proc_afs = proc_mkdir("fs/afs", NULL);
168 if (!proc_create("cells", 0644, net->proc_afs, &afs_proc_cells_fops) ||
169 !proc_create("rootcell", 0644, net->proc_afs, &afs_proc_rootcell_fops) ||
170 !proc_create("servers", 0644, net->proc_afs, &afs_proc_servers_fops) ||
171 !proc_create("stats", 0644, net->proc_afs, &afs_proc_stats_fops) ||
172 !proc_create("sysname", 0644, net->proc_afs, &afs_proc_sysname_fops))
179 proc_remove(net->proc_afs);
181 _leave(" = -ENOMEM");
186 * clean up the /proc/fs/afs/ directory
188 void afs_proc_cleanup(struct afs_net *net)
190 proc_remove(net->proc_afs);
191 net->proc_afs = NULL;
195 * open "/proc/fs/afs/cells" which provides a summary of extant cells
197 static int afs_proc_cells_open(struct inode *inode, struct file *file)
202 ret = seq_open(file, &afs_proc_cells_ops);
206 m = file->private_data;
207 m->private = PDE_DATA(inode);
212 * set up the iterator to start reading from the cells list and return the
215 static void *afs_proc_cells_start(struct seq_file *m, loff_t *_pos)
218 struct afs_net *net = afs_seq2net(m);
221 return seq_list_start_head(&net->proc_cells, *_pos);
225 * move to next cell in cells list
227 static void *afs_proc_cells_next(struct seq_file *m, void *v, loff_t *pos)
229 struct afs_net *net = afs_seq2net(m);
231 return seq_list_next(v, &net->proc_cells, pos);
235 * clean up after reading from the cells list
237 static void afs_proc_cells_stop(struct seq_file *m, void *v)
244 * display a header line followed by a load of cell lines
246 static int afs_proc_cells_show(struct seq_file *m, void *v)
248 struct afs_cell *cell = list_entry(v, struct afs_cell, proc_link);
249 struct afs_net *net = afs_seq2net(m);
251 if (v == &net->proc_cells) {
252 /* display header on line 1 */
253 seq_puts(m, "USE NAME\n");
257 /* display one cell per line on subsequent lines */
258 seq_printf(m, "%3u %s\n", atomic_read(&cell->usage), cell->name);
263 * handle writes to /proc/fs/afs/cells
264 * - to add cells: echo "add <cellname> <IP>[:<IP>][:<IP>]"
266 static ssize_t afs_proc_cells_write(struct file *file, const char __user *buf,
267 size_t size, loff_t *_pos)
269 struct afs_net *net = afs_proc2net(file);
270 char *kbuf, *name, *args;
273 /* start by dragging the command into memory */
274 if (size <= 1 || size >= PAGE_SIZE)
277 kbuf = memdup_user_nul(buf, size);
279 return PTR_ERR(kbuf);
281 /* trim to first NL */
282 name = memchr(kbuf, '\n', size);
286 /* split into command, name and argslist */
287 name = strchr(kbuf, ' ');
292 } while(*name == ' ');
296 args = strchr(name, ' ');
301 } while(*args == ' ');
305 /* determine command to perform */
306 _debug("cmd=%s name=%s args=%s", kbuf, name, args);
308 if (strcmp(kbuf, "add") == 0) {
309 struct afs_cell *cell;
311 cell = afs_lookup_cell(net, name, strlen(name), args, true);
317 if (test_and_set_bit(AFS_CELL_FL_NO_GC, &cell->flags))
318 afs_put_cell(net, cell);
319 printk("kAFS: Added new cell '%s'\n", name);
328 _leave(" = %d", ret);
333 printk("kAFS: Invalid Command on /proc/fs/afs/cells file\n");
337 static ssize_t afs_proc_rootcell_read(struct file *file, char __user *buf,
338 size_t size, loff_t *_pos)
340 struct afs_cell *cell;
341 struct afs_net *net = afs_proc2net(file);
342 unsigned int seq = 0;
343 char name[AFS_MAXCELLNAME + 1];
353 read_seqbegin_or_lock(&net->cells_lock, &seq);
355 cell = rcu_dereference_raw(net->ws_cell);
357 len = cell->name_len;
358 memcpy(name, cell->name, len);
360 } while (need_seqretry(&net->cells_lock, seq));
361 done_seqretry(&net->cells_lock, seq);
370 if (copy_to_user(buf, name, len) != 0)
377 * handle writes to /proc/fs/afs/rootcell
378 * - to initialize rootcell: echo "cell.name:192.168.231.14"
380 static ssize_t afs_proc_rootcell_write(struct file *file,
381 const char __user *buf,
382 size_t size, loff_t *_pos)
384 struct afs_net *net = afs_proc2net(file);
388 /* start by dragging the command into memory */
389 if (size <= 1 || size >= PAGE_SIZE)
392 kbuf = memdup_user_nul(buf, size);
394 return PTR_ERR(kbuf);
399 if (memchr(kbuf, '/', size))
402 /* trim to first NL */
403 s = memchr(kbuf, '\n', size);
407 /* determine command to perform */
408 _debug("rootcell=%s", kbuf);
410 ret = afs_cell_init(net, kbuf);
412 ret = size; /* consume everything, always */
416 _leave(" = %d", ret);
421 * initialise /proc/fs/afs/<cell>/
423 int afs_proc_cell_setup(struct afs_net *net, struct afs_cell *cell)
425 struct proc_dir_entry *dir;
427 _enter("%p{%s},%p", cell, cell->name, net->proc_afs);
429 dir = proc_mkdir(cell->name, net->proc_afs);
433 if (!proc_create_data("vlservers", 0, dir,
434 &afs_proc_cell_vlservers_fops, cell) ||
435 !proc_create_data("volumes", 0, dir,
436 &afs_proc_cell_volumes_fops, cell))
443 remove_proc_subtree(cell->name, net->proc_afs);
445 _leave(" = -ENOMEM");
450 * remove /proc/fs/afs/<cell>/
452 void afs_proc_cell_remove(struct afs_net *net, struct afs_cell *cell)
456 remove_proc_subtree(cell->name, net->proc_afs);
462 * open "/proc/fs/afs/<cell>/volumes" which provides a summary of extant cells
464 static int afs_proc_cell_volumes_open(struct inode *inode, struct file *file)
466 struct afs_cell *cell;
470 cell = PDE_DATA(inode);
474 ret = seq_open(file, &afs_proc_cell_volumes_ops);
478 m = file->private_data;
485 * set up the iterator to start reading from the cells list and return the
488 static void *afs_proc_cell_volumes_start(struct seq_file *m, loff_t *_pos)
489 __acquires(cell->proc_lock)
491 struct afs_cell *cell = m->private;
493 _enter("cell=%p pos=%Ld", cell, *_pos);
495 read_lock(&cell->proc_lock);
496 return seq_list_start_head(&cell->proc_volumes, *_pos);
500 * move to next cell in cells list
502 static void *afs_proc_cell_volumes_next(struct seq_file *p, void *v,
505 struct afs_cell *cell = p->private;
507 _enter("cell=%p pos=%Ld", cell, *_pos);
508 return seq_list_next(v, &cell->proc_volumes, _pos);
512 * clean up after reading from the cells list
514 static void afs_proc_cell_volumes_stop(struct seq_file *p, void *v)
515 __releases(cell->proc_lock)
517 struct afs_cell *cell = p->private;
519 read_unlock(&cell->proc_lock);
522 static const char afs_vol_types[3][3] = {
523 [AFSVL_RWVOL] = "RW",
524 [AFSVL_ROVOL] = "RO",
525 [AFSVL_BACKVOL] = "BK",
529 * display a header line followed by a load of volume lines
531 static int afs_proc_cell_volumes_show(struct seq_file *m, void *v)
533 struct afs_cell *cell = m->private;
534 struct afs_volume *vol = list_entry(v, struct afs_volume, proc_link);
536 /* Display header on line 1 */
537 if (v == &cell->proc_volumes) {
538 seq_puts(m, "USE VID TY\n");
542 seq_printf(m, "%3d %08x %s\n",
543 atomic_read(&vol->usage), vol->vid,
544 afs_vol_types[vol->type]);
550 * open "/proc/fs/afs/<cell>/vlservers" which provides a list of volume
553 static int afs_proc_cell_vlservers_open(struct inode *inode, struct file *file)
555 struct afs_cell *cell;
559 cell = PDE_DATA(inode);
563 ret = seq_open(file, &afs_proc_cell_vlservers_ops);
567 m = file->private_data;
574 * set up the iterator to start reading from the cells list and return the
577 static void *afs_proc_cell_vlservers_start(struct seq_file *m, loff_t *_pos)
580 struct afs_addr_list *alist;
581 struct afs_cell *cell = m->private;
586 alist = rcu_dereference(cell->vl_addrs);
588 /* allow for the header line */
593 if (!alist || pos >= alist->nr_addrs)
596 return alist->addrs + pos;
600 * move to next cell in cells list
602 static void *afs_proc_cell_vlservers_next(struct seq_file *p, void *v,
605 struct afs_addr_list *alist;
606 struct afs_cell *cell = p->private;
609 alist = rcu_dereference(cell->vl_addrs);
613 if (!alist || pos >= alist->nr_addrs)
616 return alist->addrs + pos;
620 * clean up after reading from the cells list
622 static void afs_proc_cell_vlservers_stop(struct seq_file *p, void *v)
629 * display a header line followed by a load of volume lines
631 static int afs_proc_cell_vlservers_show(struct seq_file *m, void *v)
633 struct sockaddr_rxrpc *addr = v;
635 /* display header on line 1 */
636 if (v == (void *)1) {
637 seq_puts(m, "ADDRESS\n");
641 /* display one cell per line on subsequent lines */
642 seq_printf(m, "%pISp\n", &addr->transport);
647 * open "/proc/fs/afs/servers" which provides a summary of active
650 static int afs_proc_servers_open(struct inode *inode, struct file *file)
652 return seq_open(file, &afs_proc_servers_ops);
656 * Set up the iterator to start reading from the server list and return the
659 static void *afs_proc_servers_start(struct seq_file *m, loff_t *_pos)
662 struct afs_net *net = afs_seq2net(m);
665 return seq_hlist_start_head_rcu(&net->fs_proc, *_pos);
669 * move to next cell in cells list
671 static void *afs_proc_servers_next(struct seq_file *m, void *v, loff_t *_pos)
673 struct afs_net *net = afs_seq2net(m);
675 return seq_hlist_next_rcu(v, &net->fs_proc, _pos);
679 * clean up after reading from the cells list
681 static void afs_proc_servers_stop(struct seq_file *p, void *v)
688 * display a header line followed by a load of volume lines
690 static int afs_proc_servers_show(struct seq_file *m, void *v)
692 struct afs_server *server;
693 struct afs_addr_list *alist;
695 if (v == SEQ_START_TOKEN) {
696 seq_puts(m, "UUID USE ADDR\n");
700 server = list_entry(v, struct afs_server, proc_link);
701 alist = rcu_dereference(server->addresses);
702 seq_printf(m, "%pU %3d %pISp\n",
704 atomic_read(&server->usage),
705 &alist->addrs[alist->index].transport);
709 void afs_put_sysnames(struct afs_sysnames *sysnames)
713 if (sysnames && refcount_dec_and_test(&sysnames->usage)) {
714 for (i = 0; i < sysnames->nr; i++)
715 if (sysnames->subs[i] != afs_init_sysname &&
716 sysnames->subs[i] != sysnames->blank)
717 kfree(sysnames->subs[i]);
722 * Handle opening of /proc/fs/afs/sysname. If it is opened for writing, we
723 * assume the caller wants to change the substitution list and we allocate a
724 * buffer to hold the list.
726 static int afs_proc_sysname_open(struct inode *inode, struct file *file)
728 struct afs_sysnames *sysnames;
732 ret = seq_open(file, &afs_proc_sysname_ops);
736 if (file->f_mode & FMODE_WRITE) {
737 sysnames = kzalloc(sizeof(*sysnames), GFP_KERNEL);
739 seq_release(inode, file);
743 refcount_set(&sysnames->usage, 1);
744 m = file->private_data;
745 m->private = sysnames;
752 * Handle writes to /proc/fs/afs/sysname to set the @sys substitution.
754 static ssize_t afs_proc_sysname_write(struct file *file,
755 const char __user *buf,
756 size_t size, loff_t *_pos)
758 struct afs_sysnames *sysnames;
759 struct seq_file *m = file->private_data;
760 char *kbuf = NULL, *s, *p, *sub;
763 sysnames = m->private;
767 return sysnames->error;
769 if (size >= PAGE_SIZE - 1) {
770 sysnames->error = -EINVAL;
776 kbuf = memdup_user_nul(buf, size);
778 return PTR_ERR(kbuf);
780 inode_lock(file_inode(file));
783 while ((s = strsep(&p, " \t\n"))) {
788 if (len >= AFSNAMEMAX)
796 /* Protect against recursion */
800 (len < 2 || (len == 2 && s[1] == '.')))
803 if (memchr(s, '/', len))
807 if (sysnames->nr >= AFS_NR_SYSNAME)
810 if (strcmp(s, afs_init_sysname) == 0) {
811 sub = (char *)afs_init_sysname;
814 sub = kmemdup(s, len + 1, GFP_KERNEL);
819 sysnames->subs[sysnames->nr] = sub;
823 ret = size; /* consume everything, always */
825 inode_unlock(file_inode(file));
832 sysnames->error = ret;
836 static int afs_proc_sysname_release(struct inode *inode, struct file *file)
838 struct afs_sysnames *sysnames, *kill = NULL;
839 struct seq_file *m = file->private_data;
840 struct afs_net *net = afs_seq2net(m);
842 sysnames = m->private;
844 if (!sysnames->error) {
846 if (sysnames->nr == 0) {
847 sysnames->subs[0] = sysnames->blank;
850 write_lock(&net->sysnames_lock);
851 kill = net->sysnames;
852 net->sysnames = sysnames;
853 write_unlock(&net->sysnames_lock);
855 afs_put_sysnames(kill);
858 return seq_release(inode, file);
861 static void *afs_proc_sysname_start(struct seq_file *m, loff_t *pos)
862 __acquires(&net->sysnames_lock)
864 struct afs_net *net = afs_seq2net(m);
865 struct afs_sysnames *names = net->sysnames;
867 read_lock(&net->sysnames_lock);
869 if (*pos >= names->nr)
871 return (void *)(unsigned long)(*pos + 1);
874 static void *afs_proc_sysname_next(struct seq_file *m, void *v, loff_t *pos)
876 struct afs_net *net = afs_seq2net(m);
877 struct afs_sysnames *names = net->sysnames;
880 if (*pos >= names->nr)
882 return (void *)(unsigned long)(*pos + 1);
885 static void afs_proc_sysname_stop(struct seq_file *m, void *v)
886 __releases(&net->sysnames_lock)
888 struct afs_net *net = afs_seq2net(m);
890 read_unlock(&net->sysnames_lock);
893 static int afs_proc_sysname_show(struct seq_file *m, void *v)
895 struct afs_net *net = afs_seq2net(m);
896 struct afs_sysnames *sysnames = net->sysnames;
897 unsigned int i = (unsigned long)v - 1;
899 if (i < sysnames->nr)
900 seq_printf(m, "%s\n", sysnames->subs[i]);
905 * Display general per-net namespace statistics
907 static int afs_proc_stats_show(struct seq_file *m, void *v)
909 struct afs_net *net = afs_seq2net(m);
911 seq_puts(m, "kAFS statistics\n");
913 seq_printf(m, "dir-mgmt: look=%u reval=%u inval=%u relpg=%u\n",
914 atomic_read(&net->n_lookup),
915 atomic_read(&net->n_reval),
916 atomic_read(&net->n_inval),
917 atomic_read(&net->n_relpg));
919 seq_printf(m, "dir-data: rdpg=%u\n",
920 atomic_read(&net->n_read_dir));
922 seq_printf(m, "dir-edit: cr=%u rm=%u\n",
923 atomic_read(&net->n_dir_cr),
924 atomic_read(&net->n_dir_rm));
926 seq_printf(m, "file-rd : n=%u nb=%lu\n",
927 atomic_read(&net->n_fetches),
928 atomic_long_read(&net->n_fetch_bytes));
929 seq_printf(m, "file-wr : n=%u nb=%lu\n",
930 atomic_read(&net->n_stores),
931 atomic_long_read(&net->n_store_bytes));
936 * Open "/proc/fs/afs/stats" to allow reading of the stat counters.
938 static int afs_proc_stats_open(struct inode *inode, struct file *file)
940 return single_open(file, afs_proc_stats_show, NULL);
943 static const struct file_operations afs_proc_stats_fops = {
944 .open = afs_proc_stats_open,
947 .release = single_release,