1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /* /proc interface for AFS
4 * Copyright (C) 2002 Red Hat, Inc. All Rights Reserved.
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 ACT 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 %3u %6lld %2u %2u %s\n",
50 refcount_read(&cell->ref),
51 atomic_read(&cell->active),
52 cell->dns_expiry - ktime_get_real_seconds(),
53 vllist ? vllist->nr_servers : 0,
59 static void *afs_proc_cells_start(struct seq_file *m, loff_t *_pos)
63 return seq_hlist_start_head_rcu(&afs_seq2net(m)->proc_cells, *_pos);
66 static void *afs_proc_cells_next(struct seq_file *m, void *v, loff_t *pos)
68 return seq_hlist_next_rcu(v, &afs_seq2net(m)->proc_cells, pos);
71 static void afs_proc_cells_stop(struct seq_file *m, void *v)
77 static const struct seq_operations afs_proc_cells_ops = {
78 .start = afs_proc_cells_start,
79 .next = afs_proc_cells_next,
80 .stop = afs_proc_cells_stop,
81 .show = afs_proc_cells_show,
85 * handle writes to /proc/fs/afs/cells
86 * - to add cells: echo "add <cellname> <IP>[:<IP>][:<IP>]"
88 static int afs_proc_cells_write(struct file *file, char *buf, size_t size)
90 struct seq_file *m = file->private_data;
91 struct afs_net *net = afs_seq2net(m);
95 /* trim to first NL */
96 name = memchr(buf, '\n', size);
100 /* split into command, name and argslist */
101 name = strchr(buf, ' ');
106 } while(*name == ' ');
110 args = strchr(name, ' ');
114 } while(*args == ' ');
119 /* determine command to perform */
120 _debug("cmd=%s name=%s args=%s", buf, name, args);
122 if (strcmp(buf, "add") == 0) {
123 struct afs_cell *cell;
125 cell = afs_lookup_cell(net, name, strlen(name), args, true);
131 if (test_and_set_bit(AFS_CELL_FL_NO_GC, &cell->flags))
132 afs_unuse_cell(net, cell, afs_cell_trace_unuse_no_pin);
140 _leave(" = %d", ret);
145 printk("kAFS: Invalid Command on /proc/fs/afs/cells file\n");
150 * Display the list of addr_prefs known to the namespace.
152 static int afs_proc_addr_prefs_show(struct seq_file *m, void *v)
154 struct afs_addr_preference_list *preflist;
155 struct afs_addr_preference *pref;
156 struct afs_net *net = afs_seq2net_single(m);
158 struct sockaddr_in sin;
159 struct sockaddr_in6 sin6;
162 char buf[44]; /* Maximum ipv6 + max subnet is 43 */
165 preflist = rcu_dereference(net->address_prefs);
168 seq_puts(m, "NO PREFS\n");
172 seq_printf(m, "PROT SUBNET PRIOR (v=%u n=%u/%u/%u)\n",
173 preflist->version, preflist->ipv6_off, preflist->nr, preflist->max_prefs);
175 memset(&addr, 0, sizeof(addr));
177 for (i = 0; i < preflist->nr; i++) {
178 pref = &preflist->prefs[i];
180 addr.sin.sin_family = pref->family;
181 if (pref->family == AF_INET) {
182 memcpy(&addr.sin.sin_addr, &pref->ipv4_addr,
183 sizeof(addr.sin.sin_addr));
184 snprintf(buf, sizeof(buf), "%pISc/%u", &addr.sin, pref->subnet_mask);
185 seq_printf(m, "UDP %-43.43s %5u\n", buf, pref->prio);
187 memcpy(&addr.sin6.sin6_addr, &pref->ipv6_addr,
188 sizeof(addr.sin6.sin6_addr));
189 snprintf(buf, sizeof(buf), "%pISc/%u", &addr.sin6, pref->subnet_mask);
190 seq_printf(m, "UDP %-43.43s %5u\n", buf, pref->prio);
199 * Display the name of the current workstation cell.
201 static int afs_proc_rootcell_show(struct seq_file *m, void *v)
203 struct afs_cell *cell;
206 net = afs_seq2net_single(m);
207 down_read(&net->cells_lock);
210 seq_printf(m, "%s\n", cell->name);
211 up_read(&net->cells_lock);
216 * Set the current workstation cell and optionally supply its list of volume
219 * echo "cell.name:192.168.231.14" >/proc/fs/afs/rootcell
221 static int afs_proc_rootcell_write(struct file *file, char *buf, size_t size)
223 struct seq_file *m = file->private_data;
224 struct afs_net *net = afs_seq2net_single(m);
231 if (memchr(buf, '/', size))
234 /* trim to first NL */
235 s = memchr(buf, '\n', size);
239 /* determine command to perform */
240 _debug("rootcell=%s", buf);
242 ret = afs_cell_init(net, buf);
245 _leave(" = %d", ret);
249 static const char afs_vol_types[3][3] = {
250 [AFSVL_RWVOL] = "RW",
251 [AFSVL_ROVOL] = "RO",
252 [AFSVL_BACKVOL] = "BK",
256 * Display the list of volumes known to a cell.
258 static int afs_proc_cell_volumes_show(struct seq_file *m, void *v)
260 struct afs_volume *vol = hlist_entry(v, struct afs_volume, proc_link);
262 /* Display header on line 1 */
263 if (v == SEQ_START_TOKEN) {
264 seq_puts(m, "USE VID TY NAME\n");
268 seq_printf(m, "%3d %08llx %s %s\n",
269 refcount_read(&vol->ref), vol->vid,
270 afs_vol_types[vol->type],
276 static void *afs_proc_cell_volumes_start(struct seq_file *m, loff_t *_pos)
277 __acquires(cell->proc_lock)
279 struct afs_cell *cell = pde_data(file_inode(m->file));
282 return seq_hlist_start_head_rcu(&cell->proc_volumes, *_pos);
285 static void *afs_proc_cell_volumes_next(struct seq_file *m, void *v,
288 struct afs_cell *cell = pde_data(file_inode(m->file));
290 return seq_hlist_next_rcu(v, &cell->proc_volumes, _pos);
293 static void afs_proc_cell_volumes_stop(struct seq_file *m, void *v)
294 __releases(cell->proc_lock)
299 static const struct seq_operations afs_proc_cell_volumes_ops = {
300 .start = afs_proc_cell_volumes_start,
301 .next = afs_proc_cell_volumes_next,
302 .stop = afs_proc_cell_volumes_stop,
303 .show = afs_proc_cell_volumes_show,
306 static const char *const dns_record_sources[NR__dns_record_source + 1] = {
307 [DNS_RECORD_UNAVAILABLE] = "unav",
308 [DNS_RECORD_FROM_CONFIG] = "cfg",
309 [DNS_RECORD_FROM_DNS_A] = "A",
310 [DNS_RECORD_FROM_DNS_AFSDB] = "AFSDB",
311 [DNS_RECORD_FROM_DNS_SRV] = "SRV",
312 [DNS_RECORD_FROM_NSS] = "nss",
313 [NR__dns_record_source] = "[weird]"
316 static const char *const dns_lookup_statuses[NR__dns_lookup_status + 1] = {
317 [DNS_LOOKUP_NOT_DONE] = "no-lookup",
318 [DNS_LOOKUP_GOOD] = "good",
319 [DNS_LOOKUP_GOOD_WITH_BAD] = "good/bad",
320 [DNS_LOOKUP_BAD] = "bad",
321 [DNS_LOOKUP_GOT_NOT_FOUND] = "not-found",
322 [DNS_LOOKUP_GOT_LOCAL_FAILURE] = "local-failure",
323 [DNS_LOOKUP_GOT_TEMP_FAILURE] = "temp-failure",
324 [DNS_LOOKUP_GOT_NS_FAILURE] = "ns-failure",
325 [NR__dns_lookup_status] = "[weird]"
329 * Display the list of Volume Location servers we're using for a cell.
331 static int afs_proc_cell_vlservers_show(struct seq_file *m, void *v)
333 const struct afs_vl_seq_net_private *priv = m->private;
334 const struct afs_vlserver_list *vllist = priv->vllist;
335 const struct afs_vlserver_entry *entry;
336 const struct afs_vlserver *vlserver;
337 const struct afs_addr_list *alist;
340 if (v == SEQ_START_TOKEN) {
341 seq_printf(m, "# source %s, status %s\n",
342 dns_record_sources[vllist ? vllist->source : 0],
343 dns_lookup_statuses[vllist ? vllist->status : 0]);
348 vlserver = entry->server;
349 alist = rcu_dereference(vlserver->addresses);
351 seq_printf(m, "%s [p=%hu w=%hu s=%s,%s]:\n",
352 vlserver->name, entry->priority, entry->weight,
353 dns_record_sources[alist ? alist->source : entry->source],
354 dns_lookup_statuses[alist ? alist->status : entry->status]);
356 for (i = 0; i < alist->nr_addrs; i++)
357 seq_printf(m, " %c %pISpc\n",
358 alist->preferred == i ? '>' : '-',
359 rxrpc_kernel_remote_addr(alist->addrs[i].peer));
361 seq_printf(m, " info: fl=%lx rtt=%d\n", vlserver->flags, vlserver->rtt);
362 seq_printf(m, " probe: fl=%x e=%d ac=%d out=%d\n",
363 vlserver->probe.flags, vlserver->probe.error,
364 vlserver->probe.abort_code,
365 atomic_read(&vlserver->probe_outstanding));
369 static void *afs_proc_cell_vlservers_start(struct seq_file *m, loff_t *_pos)
372 struct afs_vl_seq_net_private *priv = m->private;
373 struct afs_vlserver_list *vllist;
374 struct afs_cell *cell = pde_data(file_inode(m->file));
379 vllist = rcu_dereference(cell->vl_servers);
380 priv->vllist = vllist;
385 return SEQ_START_TOKEN;
387 if (pos - 1 >= vllist->nr_servers)
390 return &vllist->servers[pos - 1];
393 static void *afs_proc_cell_vlservers_next(struct seq_file *m, void *v,
396 struct afs_vl_seq_net_private *priv = m->private;
397 struct afs_vlserver_list *vllist = priv->vllist;
403 if (!vllist || pos - 1 >= vllist->nr_servers)
406 return &vllist->servers[pos - 1];
409 static void afs_proc_cell_vlservers_stop(struct seq_file *m, void *v)
415 static const struct seq_operations afs_proc_cell_vlservers_ops = {
416 .start = afs_proc_cell_vlservers_start,
417 .next = afs_proc_cell_vlservers_next,
418 .stop = afs_proc_cell_vlservers_stop,
419 .show = afs_proc_cell_vlservers_show,
423 * Display the list of fileservers we're using within a namespace.
425 static int afs_proc_servers_show(struct seq_file *m, void *v)
427 struct afs_endpoint_state *estate;
428 struct afs_addr_list *alist;
429 struct afs_server *server;
430 unsigned long failed;
433 if (v == SEQ_START_TOKEN) {
434 seq_puts(m, "UUID REF ACT CELL\n");
438 server = list_entry(v, struct afs_server, proc_link);
439 estate = rcu_dereference(server->endpoint_state);
440 alist = estate->addresses;
441 seq_printf(m, "%pU %3d %3d %s\n",
443 refcount_read(&server->ref),
444 atomic_read(&server->active),
446 seq_printf(m, " - info: fl=%lx rtt=%u\n",
447 server->flags, server->rtt);
448 seq_printf(m, " - probe: last=%d\n",
449 (int)(jiffies - server->probed_at) / HZ);
450 failed = estate->failed_set;
451 seq_printf(m, " - ESTATE pq=%x np=%u rsp=%lx f=%lx\n",
452 estate->probe_seq, atomic_read(&estate->nr_probing),
453 estate->responsive_set, estate->failed_set);
454 seq_printf(m, " - ALIST v=%u ap=%u\n",
455 alist->version, alist->addr_pref_version);
456 for (i = 0; i < alist->nr_addrs; i++) {
457 const struct afs_address *addr = &alist->addrs[i];
459 seq_printf(m, " [%x] %pISpc%s rtt=%d err=%d p=%u\n",
460 i, rxrpc_kernel_remote_addr(addr->peer),
461 alist->preferred == i ? "*" :
462 test_bit(i, &failed) ? "!" : "",
463 rxrpc_kernel_get_srtt(addr->peer),
464 addr->last_error, addr->prio);
469 static void *afs_proc_servers_start(struct seq_file *m, loff_t *_pos)
473 return seq_hlist_start_head_rcu(&afs_seq2net(m)->fs_proc, *_pos);
476 static void *afs_proc_servers_next(struct seq_file *m, void *v, loff_t *_pos)
478 return seq_hlist_next_rcu(v, &afs_seq2net(m)->fs_proc, _pos);
481 static void afs_proc_servers_stop(struct seq_file *m, void *v)
487 static const struct seq_operations afs_proc_servers_ops = {
488 .start = afs_proc_servers_start,
489 .next = afs_proc_servers_next,
490 .stop = afs_proc_servers_stop,
491 .show = afs_proc_servers_show,
495 * Display the list of strings that may be substituted for the @sys pathname
498 static int afs_proc_sysname_show(struct seq_file *m, void *v)
500 struct afs_net *net = afs_seq2net(m);
501 struct afs_sysnames *sysnames = net->sysnames;
502 unsigned int i = (unsigned long)v - 1;
504 if (i < sysnames->nr)
505 seq_printf(m, "%s\n", sysnames->subs[i]);
509 static void *afs_proc_sysname_start(struct seq_file *m, loff_t *pos)
510 __acquires(&net->sysnames_lock)
512 struct afs_net *net = afs_seq2net(m);
513 struct afs_sysnames *names;
515 read_lock(&net->sysnames_lock);
517 names = net->sysnames;
518 if (*pos >= names->nr)
520 return (void *)(unsigned long)(*pos + 1);
523 static void *afs_proc_sysname_next(struct seq_file *m, void *v, loff_t *pos)
525 struct afs_net *net = afs_seq2net(m);
526 struct afs_sysnames *names = net->sysnames;
529 if (*pos >= names->nr)
531 return (void *)(unsigned long)(*pos + 1);
534 static void afs_proc_sysname_stop(struct seq_file *m, void *v)
535 __releases(&net->sysnames_lock)
537 struct afs_net *net = afs_seq2net(m);
539 read_unlock(&net->sysnames_lock);
542 static const struct seq_operations afs_proc_sysname_ops = {
543 .start = afs_proc_sysname_start,
544 .next = afs_proc_sysname_next,
545 .stop = afs_proc_sysname_stop,
546 .show = afs_proc_sysname_show,
550 * Allow the @sys substitution to be configured.
552 static int afs_proc_sysname_write(struct file *file, char *buf, size_t size)
554 struct afs_sysnames *sysnames, *kill;
555 struct seq_file *m = file->private_data;
556 struct afs_net *net = afs_seq2net(m);
560 sysnames = kzalloc(sizeof(*sysnames), GFP_KERNEL);
563 refcount_set(&sysnames->usage, 1);
567 while ((s = strsep(&p, " \t\n"))) {
572 if (len >= AFSNAMEMAX)
580 /* Protect against recursion */
584 (len < 2 || (len == 2 && s[1] == '.')))
587 if (memchr(s, '/', len))
591 if (sysnames->nr >= AFS_NR_SYSNAME)
594 if (strcmp(s, afs_init_sysname) == 0) {
595 sub = (char *)afs_init_sysname;
598 sub = kmemdup(s, len + 1, GFP_KERNEL);
603 sysnames->subs[sysnames->nr] = sub;
607 if (sysnames->nr == 0) {
608 sysnames->subs[0] = sysnames->blank;
612 write_lock(&net->sysnames_lock);
613 kill = net->sysnames;
614 net->sysnames = sysnames;
615 write_unlock(&net->sysnames_lock);
618 afs_put_sysnames(kill);
627 void afs_put_sysnames(struct afs_sysnames *sysnames)
631 if (sysnames && refcount_dec_and_test(&sysnames->usage)) {
632 for (i = 0; i < sysnames->nr; i++)
633 if (sysnames->subs[i] != afs_init_sysname &&
634 sysnames->subs[i] != sysnames->blank)
635 kfree(sysnames->subs[i]);
641 * Display general per-net namespace statistics
643 static int afs_proc_stats_show(struct seq_file *m, void *v)
645 struct afs_net *net = afs_seq2net_single(m);
647 seq_puts(m, "kAFS statistics\n");
649 seq_printf(m, "dir-mgmt: look=%u reval=%u inval=%u relpg=%u\n",
650 atomic_read(&net->n_lookup),
651 atomic_read(&net->n_reval),
652 atomic_read(&net->n_inval),
653 atomic_read(&net->n_relpg));
655 seq_printf(m, "dir-data: rdpg=%u\n",
656 atomic_read(&net->n_read_dir));
658 seq_printf(m, "dir-edit: cr=%u rm=%u\n",
659 atomic_read(&net->n_dir_cr),
660 atomic_read(&net->n_dir_rm));
662 seq_printf(m, "file-rd : n=%u nb=%lu\n",
663 atomic_read(&net->n_fetches),
664 atomic_long_read(&net->n_fetch_bytes));
665 seq_printf(m, "file-wr : n=%u nb=%lu\n",
666 atomic_read(&net->n_stores),
667 atomic_long_read(&net->n_store_bytes));
672 * initialise /proc/fs/afs/<cell>/
674 int afs_proc_cell_setup(struct afs_cell *cell)
676 struct proc_dir_entry *dir;
677 struct afs_net *net = cell->net;
679 _enter("%p{%s},%p", cell, cell->name, net->proc_afs);
681 dir = proc_net_mkdir(net->net, cell->name, net->proc_afs);
685 if (!proc_create_net_data("vlservers", 0444, dir,
686 &afs_proc_cell_vlservers_ops,
687 sizeof(struct afs_vl_seq_net_private),
689 !proc_create_net_data("volumes", 0444, dir,
690 &afs_proc_cell_volumes_ops,
691 sizeof(struct seq_net_private),
699 remove_proc_subtree(cell->name, net->proc_afs);
701 _leave(" = -ENOMEM");
706 * remove /proc/fs/afs/<cell>/
708 void afs_proc_cell_remove(struct afs_cell *cell)
710 struct afs_net *net = cell->net;
713 remove_proc_subtree(cell->name, net->proc_afs);
718 * initialise the /proc/fs/afs/ directory
720 int afs_proc_init(struct afs_net *net)
722 struct proc_dir_entry *p;
726 p = proc_net_mkdir(net->net, "afs", net->net->proc_net);
730 if (!proc_create_net_data_write("cells", 0644, p,
732 afs_proc_cells_write,
733 sizeof(struct seq_net_private),
735 !proc_create_net_single_write("rootcell", 0644, p,
736 afs_proc_rootcell_show,
737 afs_proc_rootcell_write,
739 !proc_create_net("servers", 0444, p, &afs_proc_servers_ops,
740 sizeof(struct seq_net_private)) ||
741 !proc_create_net_single("stats", 0444, p, afs_proc_stats_show, NULL) ||
742 !proc_create_net_data_write("sysname", 0644, p,
743 &afs_proc_sysname_ops,
744 afs_proc_sysname_write,
745 sizeof(struct seq_net_private),
747 !proc_create_net_single_write("addr_prefs", 0644, p,
748 afs_proc_addr_prefs_show,
749 afs_proc_addr_prefs_write,
760 _leave(" = -ENOMEM");
765 * clean up the /proc/fs/afs/ directory
767 void afs_proc_cleanup(struct afs_net *net)
769 proc_remove(net->proc_afs);
770 net->proc_afs = NULL;