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 struct afs_vl_seq_net_private {
21 struct seq_net_private seq; /* Must be first */
22 struct afs_vlserver_list *vllist;
25 static inline struct afs_net *afs_seq2net(struct seq_file *m)
27 return afs_net(seq_file_net(m));
30 static inline struct afs_net *afs_seq2net_single(struct seq_file *m)
32 return afs_net(seq_file_single_net(m));
36 * Display the list of cells known to the namespace.
38 static int afs_proc_cells_show(struct seq_file *m, void *v)
40 struct afs_vlserver_list *vllist;
41 struct afs_cell *cell;
43 if (v == SEQ_START_TOKEN) {
44 /* display header on line 1 */
45 seq_puts(m, "USE TTL SV NAME\n");
49 cell = list_entry(v, struct afs_cell, proc_link);
50 vllist = rcu_dereference(cell->vl_servers);
52 /* display one cell per line on subsequent lines */
53 seq_printf(m, "%3u %6lld %2u %s\n",
54 atomic_read(&cell->usage),
55 cell->dns_expiry - ktime_get_real_seconds(),
56 vllist ? vllist->nr_servers : 0,
61 static void *afs_proc_cells_start(struct seq_file *m, loff_t *_pos)
65 return seq_hlist_start_head_rcu(&afs_seq2net(m)->proc_cells, *_pos);
68 static void *afs_proc_cells_next(struct seq_file *m, void *v, loff_t *pos)
70 return seq_hlist_next_rcu(v, &afs_seq2net(m)->proc_cells, pos);
73 static void afs_proc_cells_stop(struct seq_file *m, void *v)
79 static const struct seq_operations afs_proc_cells_ops = {
80 .start = afs_proc_cells_start,
81 .next = afs_proc_cells_next,
82 .stop = afs_proc_cells_stop,
83 .show = afs_proc_cells_show,
87 * handle writes to /proc/fs/afs/cells
88 * - to add cells: echo "add <cellname> <IP>[:<IP>][:<IP>]"
90 static int afs_proc_cells_write(struct file *file, char *buf, size_t size)
92 struct seq_file *m = file->private_data;
93 struct afs_net *net = afs_seq2net(m);
97 /* trim to first NL */
98 name = memchr(buf, '\n', size);
102 /* split into command, name and argslist */
103 name = strchr(buf, ' ');
108 } while(*name == ' ');
112 args = strchr(name, ' ');
116 } while(*args == ' ');
121 /* determine command to perform */
122 _debug("cmd=%s name=%s args=%s", buf, name, args);
124 if (strcmp(buf, "add") == 0) {
125 struct afs_cell *cell;
127 cell = afs_lookup_cell(net, name, strlen(name), args, true);
133 if (test_and_set_bit(AFS_CELL_FL_NO_GC, &cell->flags))
134 afs_put_cell(net, cell);
142 _leave(" = %d", ret);
147 printk("kAFS: Invalid Command on /proc/fs/afs/cells file\n");
152 * Display the name of the current workstation cell.
154 static int afs_proc_rootcell_show(struct seq_file *m, void *v)
156 struct afs_cell *cell;
159 net = afs_seq2net_single(m);
160 if (rcu_access_pointer(net->ws_cell)) {
162 cell = rcu_dereference(net->ws_cell);
164 seq_printf(m, "%s\n", cell->name);
171 * Set the current workstation cell and optionally supply its list of volume
174 * echo "cell.name:192.168.231.14" >/proc/fs/afs/rootcell
176 static int afs_proc_rootcell_write(struct file *file, char *buf, size_t size)
178 struct seq_file *m = file->private_data;
179 struct afs_net *net = afs_seq2net_single(m);
186 if (memchr(buf, '/', size))
189 /* trim to first NL */
190 s = memchr(buf, '\n', size);
194 /* determine command to perform */
195 _debug("rootcell=%s", buf);
197 ret = afs_cell_init(net, buf);
200 _leave(" = %d", ret);
204 static const char afs_vol_types[3][3] = {
205 [AFSVL_RWVOL] = "RW",
206 [AFSVL_ROVOL] = "RO",
207 [AFSVL_BACKVOL] = "BK",
211 * Display the list of volumes known to a cell.
213 static int afs_proc_cell_volumes_show(struct seq_file *m, void *v)
215 struct afs_cell *cell = PDE_DATA(file_inode(m->file));
216 struct afs_volume *vol = list_entry(v, struct afs_volume, proc_link);
218 /* Display header on line 1 */
219 if (v == &cell->proc_volumes) {
220 seq_puts(m, "USE VID TY\n");
224 seq_printf(m, "%3d %08llx %s\n",
225 atomic_read(&vol->usage), vol->vid,
226 afs_vol_types[vol->type]);
231 static void *afs_proc_cell_volumes_start(struct seq_file *m, loff_t *_pos)
232 __acquires(cell->proc_lock)
234 struct afs_cell *cell = PDE_DATA(file_inode(m->file));
236 read_lock(&cell->proc_lock);
237 return seq_list_start_head(&cell->proc_volumes, *_pos);
240 static void *afs_proc_cell_volumes_next(struct seq_file *m, void *v,
243 struct afs_cell *cell = PDE_DATA(file_inode(m->file));
245 return seq_list_next(v, &cell->proc_volumes, _pos);
248 static void afs_proc_cell_volumes_stop(struct seq_file *m, void *v)
249 __releases(cell->proc_lock)
251 struct afs_cell *cell = PDE_DATA(file_inode(m->file));
253 read_unlock(&cell->proc_lock);
256 static const struct seq_operations afs_proc_cell_volumes_ops = {
257 .start = afs_proc_cell_volumes_start,
258 .next = afs_proc_cell_volumes_next,
259 .stop = afs_proc_cell_volumes_stop,
260 .show = afs_proc_cell_volumes_show,
263 static const char *const dns_record_sources[NR__dns_record_source + 1] = {
264 [DNS_RECORD_UNAVAILABLE] = "unav",
265 [DNS_RECORD_FROM_CONFIG] = "cfg",
266 [DNS_RECORD_FROM_DNS_A] = "A",
267 [DNS_RECORD_FROM_DNS_AFSDB] = "AFSDB",
268 [DNS_RECORD_FROM_DNS_SRV] = "SRV",
269 [DNS_RECORD_FROM_NSS] = "nss",
270 [NR__dns_record_source] = "[weird]"
273 static const char *const dns_lookup_statuses[NR__dns_lookup_status + 1] = {
274 [DNS_LOOKUP_NOT_DONE] = "no-lookup",
275 [DNS_LOOKUP_GOOD] = "good",
276 [DNS_LOOKUP_GOOD_WITH_BAD] = "good/bad",
277 [DNS_LOOKUP_BAD] = "bad",
278 [DNS_LOOKUP_GOT_NOT_FOUND] = "not-found",
279 [DNS_LOOKUP_GOT_LOCAL_FAILURE] = "local-failure",
280 [DNS_LOOKUP_GOT_TEMP_FAILURE] = "temp-failure",
281 [DNS_LOOKUP_GOT_NS_FAILURE] = "ns-failure",
282 [NR__dns_lookup_status] = "[weird]"
286 * Display the list of Volume Location servers we're using for a cell.
288 static int afs_proc_cell_vlservers_show(struct seq_file *m, void *v)
290 const struct afs_vl_seq_net_private *priv = m->private;
291 const struct afs_vlserver_list *vllist = priv->vllist;
292 const struct afs_vlserver_entry *entry;
293 const struct afs_vlserver *vlserver;
294 const struct afs_addr_list *alist;
297 if (v == SEQ_START_TOKEN) {
298 seq_printf(m, "# source %s, status %s\n",
299 dns_record_sources[vllist->source],
300 dns_lookup_statuses[vllist->status]);
305 vlserver = entry->server;
306 alist = rcu_dereference(vlserver->addresses);
308 seq_printf(m, "%s [p=%hu w=%hu s=%s,%s]:\n",
309 vlserver->name, entry->priority, entry->weight,
310 dns_record_sources[alist ? alist->source : entry->source],
311 dns_lookup_statuses[alist ? alist->status : entry->status]);
313 for (i = 0; i < alist->nr_addrs; i++)
314 seq_printf(m, " %c %pISpc\n",
315 alist->preferred == i ? '>' : '-',
316 &alist->addrs[i].transport);
321 static void *afs_proc_cell_vlservers_start(struct seq_file *m, loff_t *_pos)
324 struct afs_vl_seq_net_private *priv = m->private;
325 struct afs_vlserver_list *vllist;
326 struct afs_cell *cell = PDE_DATA(file_inode(m->file));
331 vllist = rcu_dereference(cell->vl_servers);
332 priv->vllist = vllist;
337 return SEQ_START_TOKEN;
339 if (!vllist || pos - 1 >= vllist->nr_servers)
342 return &vllist->servers[pos - 1];
345 static void *afs_proc_cell_vlservers_next(struct seq_file *m, void *v,
348 struct afs_vl_seq_net_private *priv = m->private;
349 struct afs_vlserver_list *vllist = priv->vllist;
355 if (!vllist || pos - 1 >= vllist->nr_servers)
358 return &vllist->servers[pos - 1];
361 static void afs_proc_cell_vlservers_stop(struct seq_file *m, void *v)
367 static const struct seq_operations afs_proc_cell_vlservers_ops = {
368 .start = afs_proc_cell_vlservers_start,
369 .next = afs_proc_cell_vlservers_next,
370 .stop = afs_proc_cell_vlservers_stop,
371 .show = afs_proc_cell_vlservers_show,
375 * Display the list of fileservers we're using within a namespace.
377 static int afs_proc_servers_show(struct seq_file *m, void *v)
379 struct afs_server *server;
380 struct afs_addr_list *alist;
383 if (v == SEQ_START_TOKEN) {
384 seq_puts(m, "UUID USE ADDR\n");
388 server = list_entry(v, struct afs_server, proc_link);
389 alist = rcu_dereference(server->addresses);
390 seq_printf(m, "%pU %3d %pISpc%s\n",
392 atomic_read(&server->usage),
393 &alist->addrs[0].transport,
394 alist->preferred == 0 ? "*" : "");
395 for (i = 1; i < alist->nr_addrs; i++)
396 seq_printf(m, " %pISpc%s\n",
397 &alist->addrs[i].transport,
398 alist->preferred == i ? "*" : "");
402 static void *afs_proc_servers_start(struct seq_file *m, loff_t *_pos)
406 return seq_hlist_start_head_rcu(&afs_seq2net(m)->fs_proc, *_pos);
409 static void *afs_proc_servers_next(struct seq_file *m, void *v, loff_t *_pos)
411 return seq_hlist_next_rcu(v, &afs_seq2net(m)->fs_proc, _pos);
414 static void afs_proc_servers_stop(struct seq_file *m, void *v)
420 static const struct seq_operations afs_proc_servers_ops = {
421 .start = afs_proc_servers_start,
422 .next = afs_proc_servers_next,
423 .stop = afs_proc_servers_stop,
424 .show = afs_proc_servers_show,
428 * Display the list of strings that may be substituted for the @sys pathname
431 static int afs_proc_sysname_show(struct seq_file *m, void *v)
433 struct afs_net *net = afs_seq2net(m);
434 struct afs_sysnames *sysnames = net->sysnames;
435 unsigned int i = (unsigned long)v - 1;
437 if (i < sysnames->nr)
438 seq_printf(m, "%s\n", sysnames->subs[i]);
442 static void *afs_proc_sysname_start(struct seq_file *m, loff_t *pos)
443 __acquires(&net->sysnames_lock)
445 struct afs_net *net = afs_seq2net(m);
446 struct afs_sysnames *names;
448 read_lock(&net->sysnames_lock);
450 names = net->sysnames;
451 if (*pos >= names->nr)
453 return (void *)(unsigned long)(*pos + 1);
456 static void *afs_proc_sysname_next(struct seq_file *m, void *v, loff_t *pos)
458 struct afs_net *net = afs_seq2net(m);
459 struct afs_sysnames *names = net->sysnames;
462 if (*pos >= names->nr)
464 return (void *)(unsigned long)(*pos + 1);
467 static void afs_proc_sysname_stop(struct seq_file *m, void *v)
468 __releases(&net->sysnames_lock)
470 struct afs_net *net = afs_seq2net(m);
472 read_unlock(&net->sysnames_lock);
475 static const struct seq_operations afs_proc_sysname_ops = {
476 .start = afs_proc_sysname_start,
477 .next = afs_proc_sysname_next,
478 .stop = afs_proc_sysname_stop,
479 .show = afs_proc_sysname_show,
483 * Allow the @sys substitution to be configured.
485 static int afs_proc_sysname_write(struct file *file, char *buf, size_t size)
487 struct afs_sysnames *sysnames, *kill;
488 struct seq_file *m = file->private_data;
489 struct afs_net *net = afs_seq2net(m);
493 sysnames = kzalloc(sizeof(*sysnames), GFP_KERNEL);
496 refcount_set(&sysnames->usage, 1);
500 while ((s = strsep(&p, " \t\n"))) {
505 if (len >= AFSNAMEMAX)
513 /* Protect against recursion */
517 (len < 2 || (len == 2 && s[1] == '.')))
520 if (memchr(s, '/', len))
524 if (sysnames->nr >= AFS_NR_SYSNAME)
527 if (strcmp(s, afs_init_sysname) == 0) {
528 sub = (char *)afs_init_sysname;
531 sub = kmemdup(s, len + 1, GFP_KERNEL);
536 sysnames->subs[sysnames->nr] = sub;
540 if (sysnames->nr == 0) {
541 sysnames->subs[0] = sysnames->blank;
545 write_lock(&net->sysnames_lock);
546 kill = net->sysnames;
547 net->sysnames = sysnames;
548 write_unlock(&net->sysnames_lock);
551 afs_put_sysnames(kill);
560 void afs_put_sysnames(struct afs_sysnames *sysnames)
564 if (sysnames && refcount_dec_and_test(&sysnames->usage)) {
565 for (i = 0; i < sysnames->nr; i++)
566 if (sysnames->subs[i] != afs_init_sysname &&
567 sysnames->subs[i] != sysnames->blank)
568 kfree(sysnames->subs[i]);
573 * Display general per-net namespace statistics
575 static int afs_proc_stats_show(struct seq_file *m, void *v)
577 struct afs_net *net = afs_seq2net_single(m);
579 seq_puts(m, "kAFS statistics\n");
581 seq_printf(m, "dir-mgmt: look=%u reval=%u inval=%u relpg=%u\n",
582 atomic_read(&net->n_lookup),
583 atomic_read(&net->n_reval),
584 atomic_read(&net->n_inval),
585 atomic_read(&net->n_relpg));
587 seq_printf(m, "dir-data: rdpg=%u\n",
588 atomic_read(&net->n_read_dir));
590 seq_printf(m, "dir-edit: cr=%u rm=%u\n",
591 atomic_read(&net->n_dir_cr),
592 atomic_read(&net->n_dir_rm));
594 seq_printf(m, "file-rd : n=%u nb=%lu\n",
595 atomic_read(&net->n_fetches),
596 atomic_long_read(&net->n_fetch_bytes));
597 seq_printf(m, "file-wr : n=%u nb=%lu\n",
598 atomic_read(&net->n_stores),
599 atomic_long_read(&net->n_store_bytes));
604 * initialise /proc/fs/afs/<cell>/
606 int afs_proc_cell_setup(struct afs_cell *cell)
608 struct proc_dir_entry *dir;
609 struct afs_net *net = cell->net;
611 _enter("%p{%s},%p", cell, cell->name, net->proc_afs);
613 dir = proc_net_mkdir(net->net, cell->name, net->proc_afs);
617 if (!proc_create_net_data("vlservers", 0444, dir,
618 &afs_proc_cell_vlservers_ops,
619 sizeof(struct afs_vl_seq_net_private),
621 !proc_create_net_data("volumes", 0444, dir,
622 &afs_proc_cell_volumes_ops,
623 sizeof(struct seq_net_private),
631 remove_proc_subtree(cell->name, net->proc_afs);
633 _leave(" = -ENOMEM");
638 * remove /proc/fs/afs/<cell>/
640 void afs_proc_cell_remove(struct afs_cell *cell)
642 struct afs_net *net = cell->net;
645 remove_proc_subtree(cell->name, net->proc_afs);
650 * initialise the /proc/fs/afs/ directory
652 int afs_proc_init(struct afs_net *net)
654 struct proc_dir_entry *p;
658 p = proc_net_mkdir(net->net, "afs", net->net->proc_net);
662 if (!proc_create_net_data_write("cells", 0644, p,
664 afs_proc_cells_write,
665 sizeof(struct seq_net_private),
667 !proc_create_net_single_write("rootcell", 0644, p,
668 afs_proc_rootcell_show,
669 afs_proc_rootcell_write,
671 !proc_create_net("servers", 0444, p, &afs_proc_servers_ops,
672 sizeof(struct seq_net_private)) ||
673 !proc_create_net_single("stats", 0444, p, afs_proc_stats_show, NULL) ||
674 !proc_create_net_data_write("sysname", 0644, p,
675 &afs_proc_sysname_ops,
676 afs_proc_sysname_write,
677 sizeof(struct seq_net_private),
688 _leave(" = -ENOMEM");
693 * clean up the /proc/fs/afs/ directory
695 void afs_proc_cleanup(struct afs_net *net)
697 proc_remove(net->proc_afs);
698 net->proc_afs = NULL;