1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /* /proc interface for AFS
4 * Copyright (C) 2002 Red Hat, Inc. All Rights Reserved.
5 * Written by David Howells (dhowells@redhat.com)
8 #include <linux/slab.h>
9 #include <linux/module.h>
10 #include <linux/proc_fs.h>
11 #include <linux/seq_file.h>
12 #include <linux/sched.h>
13 #include <linux/uaccess.h>
16 struct afs_vl_seq_net_private {
17 struct seq_net_private seq; /* Must be first */
18 struct afs_vlserver_list *vllist;
21 static inline struct afs_net *afs_seq2net(struct seq_file *m)
23 return afs_net(seq_file_net(m));
26 static inline struct afs_net *afs_seq2net_single(struct seq_file *m)
28 return afs_net(seq_file_single_net(m));
32 * Display the list of cells known to the namespace.
34 static int afs_proc_cells_show(struct seq_file *m, void *v)
36 struct afs_vlserver_list *vllist;
37 struct afs_cell *cell;
39 if (v == SEQ_START_TOKEN) {
40 /* display header on line 1 */
41 seq_puts(m, "USE TTL SV ST NAME\n");
45 cell = list_entry(v, struct afs_cell, proc_link);
46 vllist = rcu_dereference(cell->vl_servers);
48 /* display one cell per line on subsequent lines */
49 seq_printf(m, "%3u %6lld %2u %2u %s\n",
50 atomic_read(&cell->usage),
51 cell->dns_expiry - ktime_get_real_seconds(),
58 static void *afs_proc_cells_start(struct seq_file *m, loff_t *_pos)
62 return seq_hlist_start_head_rcu(&afs_seq2net(m)->proc_cells, *_pos);
65 static void *afs_proc_cells_next(struct seq_file *m, void *v, loff_t *pos)
67 return seq_hlist_next_rcu(v, &afs_seq2net(m)->proc_cells, pos);
70 static void afs_proc_cells_stop(struct seq_file *m, void *v)
76 static const struct seq_operations afs_proc_cells_ops = {
77 .start = afs_proc_cells_start,
78 .next = afs_proc_cells_next,
79 .stop = afs_proc_cells_stop,
80 .show = afs_proc_cells_show,
84 * handle writes to /proc/fs/afs/cells
85 * - to add cells: echo "add <cellname> <IP>[:<IP>][:<IP>]"
87 static int afs_proc_cells_write(struct file *file, char *buf, size_t size)
89 struct seq_file *m = file->private_data;
90 struct afs_net *net = afs_seq2net(m);
94 /* trim to first NL */
95 name = memchr(buf, '\n', size);
99 /* split into command, name and argslist */
100 name = strchr(buf, ' ');
105 } while(*name == ' ');
109 args = strchr(name, ' ');
113 } while(*args == ' ');
118 /* determine command to perform */
119 _debug("cmd=%s name=%s args=%s", buf, name, args);
121 if (strcmp(buf, "add") == 0) {
122 struct afs_cell *cell;
124 cell = afs_lookup_cell(net, name, strlen(name), args, true);
130 if (test_and_set_bit(AFS_CELL_FL_NO_GC, &cell->flags))
131 afs_put_cell(net, cell);
139 _leave(" = %d", ret);
144 printk("kAFS: Invalid Command on /proc/fs/afs/cells file\n");
149 * Display the name of the current workstation cell.
151 static int afs_proc_rootcell_show(struct seq_file *m, void *v)
153 struct afs_cell *cell;
156 net = afs_seq2net_single(m);
157 if (rcu_access_pointer(net->ws_cell)) {
159 cell = rcu_dereference(net->ws_cell);
161 seq_printf(m, "%s\n", cell->name);
168 * Set the current workstation cell and optionally supply its list of volume
171 * echo "cell.name:192.168.231.14" >/proc/fs/afs/rootcell
173 static int afs_proc_rootcell_write(struct file *file, char *buf, size_t size)
175 struct seq_file *m = file->private_data;
176 struct afs_net *net = afs_seq2net_single(m);
183 if (memchr(buf, '/', size))
186 /* trim to first NL */
187 s = memchr(buf, '\n', size);
191 /* determine command to perform */
192 _debug("rootcell=%s", buf);
194 ret = afs_cell_init(net, buf);
197 _leave(" = %d", ret);
201 static const char afs_vol_types[3][3] = {
202 [AFSVL_RWVOL] = "RW",
203 [AFSVL_ROVOL] = "RO",
204 [AFSVL_BACKVOL] = "BK",
208 * Display the list of volumes known to a cell.
210 static int afs_proc_cell_volumes_show(struct seq_file *m, void *v)
212 struct afs_volume *vol = hlist_entry(v, struct afs_volume, proc_link);
214 /* Display header on line 1 */
215 if (v == SEQ_START_TOKEN) {
216 seq_puts(m, "USE VID TY NAME\n");
220 seq_printf(m, "%3d %08llx %s %s\n",
221 atomic_read(&vol->usage), vol->vid,
222 afs_vol_types[vol->type],
228 static void *afs_proc_cell_volumes_start(struct seq_file *m, loff_t *_pos)
229 __acquires(cell->proc_lock)
231 struct afs_cell *cell = PDE_DATA(file_inode(m->file));
234 return seq_hlist_start_head_rcu(&cell->proc_volumes, *_pos);
237 static void *afs_proc_cell_volumes_next(struct seq_file *m, void *v,
240 struct afs_cell *cell = PDE_DATA(file_inode(m->file));
242 return seq_hlist_next_rcu(v, &cell->proc_volumes, _pos);
245 static void afs_proc_cell_volumes_stop(struct seq_file *m, void *v)
246 __releases(cell->proc_lock)
251 static const struct seq_operations afs_proc_cell_volumes_ops = {
252 .start = afs_proc_cell_volumes_start,
253 .next = afs_proc_cell_volumes_next,
254 .stop = afs_proc_cell_volumes_stop,
255 .show = afs_proc_cell_volumes_show,
258 static const char *const dns_record_sources[NR__dns_record_source + 1] = {
259 [DNS_RECORD_UNAVAILABLE] = "unav",
260 [DNS_RECORD_FROM_CONFIG] = "cfg",
261 [DNS_RECORD_FROM_DNS_A] = "A",
262 [DNS_RECORD_FROM_DNS_AFSDB] = "AFSDB",
263 [DNS_RECORD_FROM_DNS_SRV] = "SRV",
264 [DNS_RECORD_FROM_NSS] = "nss",
265 [NR__dns_record_source] = "[weird]"
268 static const char *const dns_lookup_statuses[NR__dns_lookup_status + 1] = {
269 [DNS_LOOKUP_NOT_DONE] = "no-lookup",
270 [DNS_LOOKUP_GOOD] = "good",
271 [DNS_LOOKUP_GOOD_WITH_BAD] = "good/bad",
272 [DNS_LOOKUP_BAD] = "bad",
273 [DNS_LOOKUP_GOT_NOT_FOUND] = "not-found",
274 [DNS_LOOKUP_GOT_LOCAL_FAILURE] = "local-failure",
275 [DNS_LOOKUP_GOT_TEMP_FAILURE] = "temp-failure",
276 [DNS_LOOKUP_GOT_NS_FAILURE] = "ns-failure",
277 [NR__dns_lookup_status] = "[weird]"
281 * Display the list of Volume Location servers we're using for a cell.
283 static int afs_proc_cell_vlservers_show(struct seq_file *m, void *v)
285 const struct afs_vl_seq_net_private *priv = m->private;
286 const struct afs_vlserver_list *vllist = priv->vllist;
287 const struct afs_vlserver_entry *entry;
288 const struct afs_vlserver *vlserver;
289 const struct afs_addr_list *alist;
292 if (v == SEQ_START_TOKEN) {
293 seq_printf(m, "# source %s, status %s\n",
294 dns_record_sources[vllist ? vllist->source : 0],
295 dns_lookup_statuses[vllist ? vllist->status : 0]);
300 vlserver = entry->server;
301 alist = rcu_dereference(vlserver->addresses);
303 seq_printf(m, "%s [p=%hu w=%hu s=%s,%s]:\n",
304 vlserver->name, entry->priority, entry->weight,
305 dns_record_sources[alist ? alist->source : entry->source],
306 dns_lookup_statuses[alist ? alist->status : entry->status]);
308 for (i = 0; i < alist->nr_addrs; i++)
309 seq_printf(m, " %c %pISpc\n",
310 alist->preferred == i ? '>' : '-',
311 &alist->addrs[i].transport);
316 static void *afs_proc_cell_vlservers_start(struct seq_file *m, loff_t *_pos)
319 struct afs_vl_seq_net_private *priv = m->private;
320 struct afs_vlserver_list *vllist;
321 struct afs_cell *cell = PDE_DATA(file_inode(m->file));
326 vllist = rcu_dereference(cell->vl_servers);
327 priv->vllist = vllist;
332 return SEQ_START_TOKEN;
334 if (pos - 1 >= vllist->nr_servers)
337 return &vllist->servers[pos - 1];
340 static void *afs_proc_cell_vlservers_next(struct seq_file *m, void *v,
343 struct afs_vl_seq_net_private *priv = m->private;
344 struct afs_vlserver_list *vllist = priv->vllist;
350 if (!vllist || pos - 1 >= vllist->nr_servers)
353 return &vllist->servers[pos - 1];
356 static void afs_proc_cell_vlservers_stop(struct seq_file *m, void *v)
362 static const struct seq_operations afs_proc_cell_vlservers_ops = {
363 .start = afs_proc_cell_vlservers_start,
364 .next = afs_proc_cell_vlservers_next,
365 .stop = afs_proc_cell_vlservers_stop,
366 .show = afs_proc_cell_vlservers_show,
370 * Display the list of fileservers we're using within a namespace.
372 static int afs_proc_servers_show(struct seq_file *m, void *v)
374 struct afs_server *server;
375 struct afs_addr_list *alist;
378 if (v == SEQ_START_TOKEN) {
379 seq_puts(m, "UUID REF ACT\n");
383 server = list_entry(v, struct afs_server, proc_link);
384 alist = rcu_dereference(server->addresses);
385 seq_printf(m, "%pU %3d %3d\n",
387 atomic_read(&server->ref),
388 atomic_read(&server->active));
389 seq_printf(m, " - info: fl=%lx rtt=%u brk=%x\n",
390 server->flags, server->rtt, server->cb_s_break);
391 seq_printf(m, " - probe: last=%d out=%d\n",
392 (int)(jiffies - server->probed_at) / HZ,
393 atomic_read(&server->probe_outstanding));
394 seq_printf(m, " - ALIST v=%u rsp=%lx f=%lx\n",
395 alist->version, alist->responded, alist->failed);
396 for (i = 0; i < alist->nr_addrs; i++)
397 seq_printf(m, " [%x] %pISpc%s\n",
398 i, &alist->addrs[i].transport,
399 alist->preferred == i ? "*" : "");
403 static void *afs_proc_servers_start(struct seq_file *m, loff_t *_pos)
407 return seq_hlist_start_head_rcu(&afs_seq2net(m)->fs_proc, *_pos);
410 static void *afs_proc_servers_next(struct seq_file *m, void *v, loff_t *_pos)
412 return seq_hlist_next_rcu(v, &afs_seq2net(m)->fs_proc, _pos);
415 static void afs_proc_servers_stop(struct seq_file *m, void *v)
421 static const struct seq_operations afs_proc_servers_ops = {
422 .start = afs_proc_servers_start,
423 .next = afs_proc_servers_next,
424 .stop = afs_proc_servers_stop,
425 .show = afs_proc_servers_show,
429 * Display the list of strings that may be substituted for the @sys pathname
432 static int afs_proc_sysname_show(struct seq_file *m, void *v)
434 struct afs_net *net = afs_seq2net(m);
435 struct afs_sysnames *sysnames = net->sysnames;
436 unsigned int i = (unsigned long)v - 1;
438 if (i < sysnames->nr)
439 seq_printf(m, "%s\n", sysnames->subs[i]);
443 static void *afs_proc_sysname_start(struct seq_file *m, loff_t *pos)
444 __acquires(&net->sysnames_lock)
446 struct afs_net *net = afs_seq2net(m);
447 struct afs_sysnames *names;
449 read_lock(&net->sysnames_lock);
451 names = net->sysnames;
452 if (*pos >= names->nr)
454 return (void *)(unsigned long)(*pos + 1);
457 static void *afs_proc_sysname_next(struct seq_file *m, void *v, loff_t *pos)
459 struct afs_net *net = afs_seq2net(m);
460 struct afs_sysnames *names = net->sysnames;
463 if (*pos >= names->nr)
465 return (void *)(unsigned long)(*pos + 1);
468 static void afs_proc_sysname_stop(struct seq_file *m, void *v)
469 __releases(&net->sysnames_lock)
471 struct afs_net *net = afs_seq2net(m);
473 read_unlock(&net->sysnames_lock);
476 static const struct seq_operations afs_proc_sysname_ops = {
477 .start = afs_proc_sysname_start,
478 .next = afs_proc_sysname_next,
479 .stop = afs_proc_sysname_stop,
480 .show = afs_proc_sysname_show,
484 * Allow the @sys substitution to be configured.
486 static int afs_proc_sysname_write(struct file *file, char *buf, size_t size)
488 struct afs_sysnames *sysnames, *kill;
489 struct seq_file *m = file->private_data;
490 struct afs_net *net = afs_seq2net(m);
494 sysnames = kzalloc(sizeof(*sysnames), GFP_KERNEL);
497 refcount_set(&sysnames->usage, 1);
501 while ((s = strsep(&p, " \t\n"))) {
506 if (len >= AFSNAMEMAX)
514 /* Protect against recursion */
518 (len < 2 || (len == 2 && s[1] == '.')))
521 if (memchr(s, '/', len))
525 if (sysnames->nr >= AFS_NR_SYSNAME)
528 if (strcmp(s, afs_init_sysname) == 0) {
529 sub = (char *)afs_init_sysname;
532 sub = kmemdup(s, len + 1, GFP_KERNEL);
537 sysnames->subs[sysnames->nr] = sub;
541 if (sysnames->nr == 0) {
542 sysnames->subs[0] = sysnames->blank;
546 write_lock(&net->sysnames_lock);
547 kill = net->sysnames;
548 net->sysnames = sysnames;
549 write_unlock(&net->sysnames_lock);
552 afs_put_sysnames(kill);
561 void afs_put_sysnames(struct afs_sysnames *sysnames)
565 if (sysnames && refcount_dec_and_test(&sysnames->usage)) {
566 for (i = 0; i < sysnames->nr; i++)
567 if (sysnames->subs[i] != afs_init_sysname &&
568 sysnames->subs[i] != sysnames->blank)
569 kfree(sysnames->subs[i]);
575 * Display general per-net namespace statistics
577 static int afs_proc_stats_show(struct seq_file *m, void *v)
579 struct afs_net *net = afs_seq2net_single(m);
581 seq_puts(m, "kAFS statistics\n");
583 seq_printf(m, "dir-mgmt: look=%u reval=%u inval=%u relpg=%u\n",
584 atomic_read(&net->n_lookup),
585 atomic_read(&net->n_reval),
586 atomic_read(&net->n_inval),
587 atomic_read(&net->n_relpg));
589 seq_printf(m, "dir-data: rdpg=%u\n",
590 atomic_read(&net->n_read_dir));
592 seq_printf(m, "dir-edit: cr=%u rm=%u\n",
593 atomic_read(&net->n_dir_cr),
594 atomic_read(&net->n_dir_rm));
596 seq_printf(m, "file-rd : n=%u nb=%lu\n",
597 atomic_read(&net->n_fetches),
598 atomic_long_read(&net->n_fetch_bytes));
599 seq_printf(m, "file-wr : n=%u nb=%lu\n",
600 atomic_read(&net->n_stores),
601 atomic_long_read(&net->n_store_bytes));
606 * initialise /proc/fs/afs/<cell>/
608 int afs_proc_cell_setup(struct afs_cell *cell)
610 struct proc_dir_entry *dir;
611 struct afs_net *net = cell->net;
613 _enter("%p{%s},%p", cell, cell->name, net->proc_afs);
615 dir = proc_net_mkdir(net->net, cell->name, net->proc_afs);
619 if (!proc_create_net_data("vlservers", 0444, dir,
620 &afs_proc_cell_vlservers_ops,
621 sizeof(struct afs_vl_seq_net_private),
623 !proc_create_net_data("volumes", 0444, dir,
624 &afs_proc_cell_volumes_ops,
625 sizeof(struct seq_net_private),
633 remove_proc_subtree(cell->name, net->proc_afs);
635 _leave(" = -ENOMEM");
640 * remove /proc/fs/afs/<cell>/
642 void afs_proc_cell_remove(struct afs_cell *cell)
644 struct afs_net *net = cell->net;
647 remove_proc_subtree(cell->name, net->proc_afs);
652 * initialise the /proc/fs/afs/ directory
654 int afs_proc_init(struct afs_net *net)
656 struct proc_dir_entry *p;
660 p = proc_net_mkdir(net->net, "afs", net->net->proc_net);
664 if (!proc_create_net_data_write("cells", 0644, p,
666 afs_proc_cells_write,
667 sizeof(struct seq_net_private),
669 !proc_create_net_single_write("rootcell", 0644, p,
670 afs_proc_rootcell_show,
671 afs_proc_rootcell_write,
673 !proc_create_net("servers", 0444, p, &afs_proc_servers_ops,
674 sizeof(struct seq_net_private)) ||
675 !proc_create_net_single("stats", 0444, p, afs_proc_stats_show, NULL) ||
676 !proc_create_net_data_write("sysname", 0644, p,
677 &afs_proc_sysname_ops,
678 afs_proc_sysname_write,
679 sizeof(struct seq_net_private),
690 _leave(" = -ENOMEM");
695 * clean up the /proc/fs/afs/ directory
697 void afs_proc_cleanup(struct afs_net *net)
699 proc_remove(net->proc_afs);
700 net->proc_afs = NULL;