Merge tag 'writeback_for_v5.9-rc3' of git://git.kernel.org/pub/scm/linux/kernel/git...
[linux-2.6-microblaze.git] / fs / afs / proc.c
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /* /proc interface for AFS
3  *
4  * Copyright (C) 2002 Red Hat, Inc. All Rights Reserved.
5  * Written by David Howells (dhowells@redhat.com)
6  */
7
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>
14 #include "internal.h"
15
16 struct afs_vl_seq_net_private {
17         struct seq_net_private          seq;    /* Must be first */
18         struct afs_vlserver_list        *vllist;
19 };
20
21 static inline struct afs_net *afs_seq2net(struct seq_file *m)
22 {
23         return afs_net(seq_file_net(m));
24 }
25
26 static inline struct afs_net *afs_seq2net_single(struct seq_file *m)
27 {
28         return afs_net(seq_file_single_net(m));
29 }
30
31 /*
32  * Display the list of cells known to the namespace.
33  */
34 static int afs_proc_cells_show(struct seq_file *m, void *v)
35 {
36         struct afs_vlserver_list *vllist;
37         struct afs_cell *cell;
38
39         if (v == SEQ_START_TOKEN) {
40                 /* display header on line 1 */
41                 seq_puts(m, "USE    TTL SV ST NAME\n");
42                 return 0;
43         }
44
45         cell = list_entry(v, struct afs_cell, proc_link);
46         vllist = rcu_dereference(cell->vl_servers);
47
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(),
52                    vllist->nr_servers,
53                    cell->state,
54                    cell->name);
55         return 0;
56 }
57
58 static void *afs_proc_cells_start(struct seq_file *m, loff_t *_pos)
59         __acquires(rcu)
60 {
61         rcu_read_lock();
62         return seq_hlist_start_head_rcu(&afs_seq2net(m)->proc_cells, *_pos);
63 }
64
65 static void *afs_proc_cells_next(struct seq_file *m, void *v, loff_t *pos)
66 {
67         return seq_hlist_next_rcu(v, &afs_seq2net(m)->proc_cells, pos);
68 }
69
70 static void afs_proc_cells_stop(struct seq_file *m, void *v)
71         __releases(rcu)
72 {
73         rcu_read_unlock();
74 }
75
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,
81 };
82
83 /*
84  * handle writes to /proc/fs/afs/cells
85  * - to add cells: echo "add <cellname> <IP>[:<IP>][:<IP>]"
86  */
87 static int afs_proc_cells_write(struct file *file, char *buf, size_t size)
88 {
89         struct seq_file *m = file->private_data;
90         struct afs_net *net = afs_seq2net(m);
91         char *name, *args;
92         int ret;
93
94         /* trim to first NL */
95         name = memchr(buf, '\n', size);
96         if (name)
97                 *name = 0;
98
99         /* split into command, name and argslist */
100         name = strchr(buf, ' ');
101         if (!name)
102                 goto inval;
103         do {
104                 *name++ = 0;
105         } while(*name == ' ');
106         if (!*name)
107                 goto inval;
108
109         args = strchr(name, ' ');
110         if (args) {
111                 do {
112                         *args++ = 0;
113                 } while(*args == ' ');
114                 if (!*args)
115                         goto inval;
116         }
117
118         /* determine command to perform */
119         _debug("cmd=%s name=%s args=%s", buf, name, args);
120
121         if (strcmp(buf, "add") == 0) {
122                 struct afs_cell *cell;
123
124                 cell = afs_lookup_cell(net, name, strlen(name), args, true);
125                 if (IS_ERR(cell)) {
126                         ret = PTR_ERR(cell);
127                         goto done;
128                 }
129
130                 if (test_and_set_bit(AFS_CELL_FL_NO_GC, &cell->flags))
131                         afs_put_cell(net, cell);
132         } else {
133                 goto inval;
134         }
135
136         ret = 0;
137
138 done:
139         _leave(" = %d", ret);
140         return ret;
141
142 inval:
143         ret = -EINVAL;
144         printk("kAFS: Invalid Command on /proc/fs/afs/cells file\n");
145         goto done;
146 }
147
148 /*
149  * Display the name of the current workstation cell.
150  */
151 static int afs_proc_rootcell_show(struct seq_file *m, void *v)
152 {
153         struct afs_cell *cell;
154         struct afs_net *net;
155
156         net = afs_seq2net_single(m);
157         if (rcu_access_pointer(net->ws_cell)) {
158                 rcu_read_lock();
159                 cell = rcu_dereference(net->ws_cell);
160                 if (cell)
161                         seq_printf(m, "%s\n", cell->name);
162                 rcu_read_unlock();
163         }
164         return 0;
165 }
166
167 /*
168  * Set the current workstation cell and optionally supply its list of volume
169  * location servers.
170  *
171  *      echo "cell.name:192.168.231.14" >/proc/fs/afs/rootcell
172  */
173 static int afs_proc_rootcell_write(struct file *file, char *buf, size_t size)
174 {
175         struct seq_file *m = file->private_data;
176         struct afs_net *net = afs_seq2net_single(m);
177         char *s;
178         int ret;
179
180         ret = -EINVAL;
181         if (buf[0] == '.')
182                 goto out;
183         if (memchr(buf, '/', size))
184                 goto out;
185
186         /* trim to first NL */
187         s = memchr(buf, '\n', size);
188         if (s)
189                 *s = 0;
190
191         /* determine command to perform */
192         _debug("rootcell=%s", buf);
193
194         ret = afs_cell_init(net, buf);
195
196 out:
197         _leave(" = %d", ret);
198         return ret;
199 }
200
201 static const char afs_vol_types[3][3] = {
202         [AFSVL_RWVOL]   = "RW",
203         [AFSVL_ROVOL]   = "RO",
204         [AFSVL_BACKVOL] = "BK",
205 };
206
207 /*
208  * Display the list of volumes known to a cell.
209  */
210 static int afs_proc_cell_volumes_show(struct seq_file *m, void *v)
211 {
212         struct afs_volume *vol = hlist_entry(v, struct afs_volume, proc_link);
213
214         /* Display header on line 1 */
215         if (v == SEQ_START_TOKEN) {
216                 seq_puts(m, "USE VID      TY NAME\n");
217                 return 0;
218         }
219
220         seq_printf(m, "%3d %08llx %s %s\n",
221                    atomic_read(&vol->usage), vol->vid,
222                    afs_vol_types[vol->type],
223                    vol->name);
224
225         return 0;
226 }
227
228 static void *afs_proc_cell_volumes_start(struct seq_file *m, loff_t *_pos)
229         __acquires(cell->proc_lock)
230 {
231         struct afs_cell *cell = PDE_DATA(file_inode(m->file));
232
233         rcu_read_lock();
234         return seq_hlist_start_head_rcu(&cell->proc_volumes, *_pos);
235 }
236
237 static void *afs_proc_cell_volumes_next(struct seq_file *m, void *v,
238                                         loff_t *_pos)
239 {
240         struct afs_cell *cell = PDE_DATA(file_inode(m->file));
241
242         return seq_hlist_next_rcu(v, &cell->proc_volumes, _pos);
243 }
244
245 static void afs_proc_cell_volumes_stop(struct seq_file *m, void *v)
246         __releases(cell->proc_lock)
247 {
248         rcu_read_unlock();
249 }
250
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,
256 };
257
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]"
266 };
267
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]"
278 };
279
280 /*
281  * Display the list of Volume Location servers we're using for a cell.
282  */
283 static int afs_proc_cell_vlservers_show(struct seq_file *m, void *v)
284 {
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;
290         int i;
291
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]);
296                 return 0;
297         }
298
299         entry = v;
300         vlserver = entry->server;
301         alist = rcu_dereference(vlserver->addresses);
302
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]);
307         if (alist) {
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);
312         }
313         return 0;
314 }
315
316 static void *afs_proc_cell_vlservers_start(struct seq_file *m, loff_t *_pos)
317         __acquires(rcu)
318 {
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));
322         loff_t pos = *_pos;
323
324         rcu_read_lock();
325
326         vllist = rcu_dereference(cell->vl_servers);
327         priv->vllist = vllist;
328
329         if (pos < 0)
330                 *_pos = pos = 0;
331         if (pos == 0)
332                 return SEQ_START_TOKEN;
333
334         if (pos - 1 >= vllist->nr_servers)
335                 return NULL;
336
337         return &vllist->servers[pos - 1];
338 }
339
340 static void *afs_proc_cell_vlservers_next(struct seq_file *m, void *v,
341                                           loff_t *_pos)
342 {
343         struct afs_vl_seq_net_private *priv = m->private;
344         struct afs_vlserver_list *vllist = priv->vllist;
345         loff_t pos;
346
347         pos = *_pos;
348         pos++;
349         *_pos = pos;
350         if (!vllist || pos - 1 >= vllist->nr_servers)
351                 return NULL;
352
353         return &vllist->servers[pos - 1];
354 }
355
356 static void afs_proc_cell_vlservers_stop(struct seq_file *m, void *v)
357         __releases(rcu)
358 {
359         rcu_read_unlock();
360 }
361
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,
367 };
368
369 /*
370  * Display the list of fileservers we're using within a namespace.
371  */
372 static int afs_proc_servers_show(struct seq_file *m, void *v)
373 {
374         struct afs_server *server;
375         struct afs_addr_list *alist;
376         int i;
377
378         if (v == SEQ_START_TOKEN) {
379                 seq_puts(m, "UUID                                 REF ACT\n");
380                 return 0;
381         }
382
383         server = list_entry(v, struct afs_server, proc_link);
384         alist = rcu_dereference(server->addresses);
385         seq_printf(m, "%pU %3d %3d\n",
386                    &server->uuid,
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 ? "*" : "");
400         return 0;
401 }
402
403 static void *afs_proc_servers_start(struct seq_file *m, loff_t *_pos)
404         __acquires(rcu)
405 {
406         rcu_read_lock();
407         return seq_hlist_start_head_rcu(&afs_seq2net(m)->fs_proc, *_pos);
408 }
409
410 static void *afs_proc_servers_next(struct seq_file *m, void *v, loff_t *_pos)
411 {
412         return seq_hlist_next_rcu(v, &afs_seq2net(m)->fs_proc, _pos);
413 }
414
415 static void afs_proc_servers_stop(struct seq_file *m, void *v)
416         __releases(rcu)
417 {
418         rcu_read_unlock();
419 }
420
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,
426 };
427
428 /*
429  * Display the list of strings that may be substituted for the @sys pathname
430  * macro.
431  */
432 static int afs_proc_sysname_show(struct seq_file *m, void *v)
433 {
434         struct afs_net *net = afs_seq2net(m);
435         struct afs_sysnames *sysnames = net->sysnames;
436         unsigned int i = (unsigned long)v - 1;
437
438         if (i < sysnames->nr)
439                 seq_printf(m, "%s\n", sysnames->subs[i]);
440         return 0;
441 }
442
443 static void *afs_proc_sysname_start(struct seq_file *m, loff_t *pos)
444         __acquires(&net->sysnames_lock)
445 {
446         struct afs_net *net = afs_seq2net(m);
447         struct afs_sysnames *names;
448
449         read_lock(&net->sysnames_lock);
450
451         names = net->sysnames;
452         if (*pos >= names->nr)
453                 return NULL;
454         return (void *)(unsigned long)(*pos + 1);
455 }
456
457 static void *afs_proc_sysname_next(struct seq_file *m, void *v, loff_t *pos)
458 {
459         struct afs_net *net = afs_seq2net(m);
460         struct afs_sysnames *names = net->sysnames;
461
462         *pos += 1;
463         if (*pos >= names->nr)
464                 return NULL;
465         return (void *)(unsigned long)(*pos + 1);
466 }
467
468 static void afs_proc_sysname_stop(struct seq_file *m, void *v)
469         __releases(&net->sysnames_lock)
470 {
471         struct afs_net *net = afs_seq2net(m);
472
473         read_unlock(&net->sysnames_lock);
474 }
475
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,
481 };
482
483 /*
484  * Allow the @sys substitution to be configured.
485  */
486 static int afs_proc_sysname_write(struct file *file, char *buf, size_t size)
487 {
488         struct afs_sysnames *sysnames, *kill;
489         struct seq_file *m = file->private_data;
490         struct afs_net *net = afs_seq2net(m);
491         char *s, *p, *sub;
492         int ret, len;
493
494         sysnames = kzalloc(sizeof(*sysnames), GFP_KERNEL);
495         if (!sysnames)
496                 return -ENOMEM;
497         refcount_set(&sysnames->usage, 1);
498         kill = sysnames;
499
500         p = buf;
501         while ((s = strsep(&p, " \t\n"))) {
502                 len = strlen(s);
503                 if (len == 0)
504                         continue;
505                 ret = -ENAMETOOLONG;
506                 if (len >= AFSNAMEMAX)
507                         goto error;
508
509                 if (len >= 4 &&
510                     s[len - 4] == '@' &&
511                     s[len - 3] == 's' &&
512                     s[len - 2] == 'y' &&
513                     s[len - 1] == 's')
514                         /* Protect against recursion */
515                         goto invalid;
516
517                 if (s[0] == '.' &&
518                     (len < 2 || (len == 2 && s[1] == '.')))
519                         goto invalid;
520
521                 if (memchr(s, '/', len))
522                         goto invalid;
523
524                 ret = -EFBIG;
525                 if (sysnames->nr >= AFS_NR_SYSNAME)
526                         goto out;
527
528                 if (strcmp(s, afs_init_sysname) == 0) {
529                         sub = (char *)afs_init_sysname;
530                 } else {
531                         ret = -ENOMEM;
532                         sub = kmemdup(s, len + 1, GFP_KERNEL);
533                         if (!sub)
534                                 goto out;
535                 }
536
537                 sysnames->subs[sysnames->nr] = sub;
538                 sysnames->nr++;
539         }
540
541         if (sysnames->nr == 0) {
542                 sysnames->subs[0] = sysnames->blank;
543                 sysnames->nr++;
544         }
545
546         write_lock(&net->sysnames_lock);
547         kill = net->sysnames;
548         net->sysnames = sysnames;
549         write_unlock(&net->sysnames_lock);
550         ret = 0;
551 out:
552         afs_put_sysnames(kill);
553         return ret;
554
555 invalid:
556         ret = -EINVAL;
557 error:
558         goto out;
559 }
560
561 void afs_put_sysnames(struct afs_sysnames *sysnames)
562 {
563         int i;
564
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]);
570                 kfree(sysnames);
571         }
572 }
573
574 /*
575  * Display general per-net namespace statistics
576  */
577 static int afs_proc_stats_show(struct seq_file *m, void *v)
578 {
579         struct afs_net *net = afs_seq2net_single(m);
580
581         seq_puts(m, "kAFS statistics\n");
582
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));
588
589         seq_printf(m, "dir-data: rdpg=%u\n",
590                    atomic_read(&net->n_read_dir));
591
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));
595
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));
602         return 0;
603 }
604
605 /*
606  * initialise /proc/fs/afs/<cell>/
607  */
608 int afs_proc_cell_setup(struct afs_cell *cell)
609 {
610         struct proc_dir_entry *dir;
611         struct afs_net *net = cell->net;
612
613         _enter("%p{%s},%p", cell, cell->name, net->proc_afs);
614
615         dir = proc_net_mkdir(net->net, cell->name, net->proc_afs);
616         if (!dir)
617                 goto error_dir;
618
619         if (!proc_create_net_data("vlservers", 0444, dir,
620                                   &afs_proc_cell_vlservers_ops,
621                                   sizeof(struct afs_vl_seq_net_private),
622                                   cell) ||
623             !proc_create_net_data("volumes", 0444, dir,
624                                   &afs_proc_cell_volumes_ops,
625                                   sizeof(struct seq_net_private),
626                                   cell))
627                 goto error_tree;
628
629         _leave(" = 0");
630         return 0;
631
632 error_tree:
633         remove_proc_subtree(cell->name, net->proc_afs);
634 error_dir:
635         _leave(" = -ENOMEM");
636         return -ENOMEM;
637 }
638
639 /*
640  * remove /proc/fs/afs/<cell>/
641  */
642 void afs_proc_cell_remove(struct afs_cell *cell)
643 {
644         struct afs_net *net = cell->net;
645
646         _enter("");
647         remove_proc_subtree(cell->name, net->proc_afs);
648         _leave("");
649 }
650
651 /*
652  * initialise the /proc/fs/afs/ directory
653  */
654 int afs_proc_init(struct afs_net *net)
655 {
656         struct proc_dir_entry *p;
657
658         _enter("");
659
660         p = proc_net_mkdir(net->net, "afs", net->net->proc_net);
661         if (!p)
662                 goto error_dir;
663
664         if (!proc_create_net_data_write("cells", 0644, p,
665                                         &afs_proc_cells_ops,
666                                         afs_proc_cells_write,
667                                         sizeof(struct seq_net_private),
668                                         NULL) ||
669             !proc_create_net_single_write("rootcell", 0644, p,
670                                           afs_proc_rootcell_show,
671                                           afs_proc_rootcell_write,
672                                           NULL) ||
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),
680                                         NULL))
681                 goto error_tree;
682
683         net->proc_afs = p;
684         _leave(" = 0");
685         return 0;
686
687 error_tree:
688         proc_remove(p);
689 error_dir:
690         _leave(" = -ENOMEM");
691         return -ENOMEM;
692 }
693
694 /*
695  * clean up the /proc/fs/afs/ directory
696  */
697 void afs_proc_cleanup(struct afs_net *net)
698 {
699         proc_remove(net->proc_afs);
700         net->proc_afs = NULL;
701 }