linux/net/l2tp/l2tp_debugfs.c
<<
>>
Prefs
   1// SPDX-License-Identifier: GPL-2.0-or-later
   2/*
   3 * L2TP subsystem debugfs
   4 *
   5 * Copyright (c) 2010 Katalix Systems Ltd
   6 */
   7
   8#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
   9
  10#include <linux/module.h>
  11#include <linux/skbuff.h>
  12#include <linux/socket.h>
  13#include <linux/hash.h>
  14#include <linux/l2tp.h>
  15#include <linux/in.h>
  16#include <linux/etherdevice.h>
  17#include <linux/spinlock.h>
  18#include <linux/debugfs.h>
  19#include <net/sock.h>
  20#include <net/ip.h>
  21#include <net/icmp.h>
  22#include <net/udp.h>
  23#include <net/inet_common.h>
  24#include <net/inet_hashtables.h>
  25#include <net/tcp_states.h>
  26#include <net/protocol.h>
  27#include <net/xfrm.h>
  28#include <net/net_namespace.h>
  29#include <net/netns/generic.h>
  30
  31#include "l2tp_core.h"
  32
  33static struct dentry *rootdir;
  34
  35struct l2tp_dfs_seq_data {
  36        struct net *net;
  37        int tunnel_idx;                 /* current tunnel */
  38        int session_idx;                /* index of session within current tunnel */
  39        struct l2tp_tunnel *tunnel;
  40        struct l2tp_session *session;   /* NULL means get next tunnel */
  41};
  42
  43static void l2tp_dfs_next_tunnel(struct l2tp_dfs_seq_data *pd)
  44{
  45        /* Drop reference taken during previous invocation */
  46        if (pd->tunnel)
  47                l2tp_tunnel_dec_refcount(pd->tunnel);
  48
  49        pd->tunnel = l2tp_tunnel_get_nth(pd->net, pd->tunnel_idx);
  50        pd->tunnel_idx++;
  51}
  52
  53static void l2tp_dfs_next_session(struct l2tp_dfs_seq_data *pd)
  54{
  55        /* Drop reference taken during previous invocation */
  56        if (pd->session)
  57                l2tp_session_dec_refcount(pd->session);
  58
  59        pd->session = l2tp_session_get_nth(pd->tunnel, pd->session_idx);
  60        pd->session_idx++;
  61
  62        if (pd->session == NULL) {
  63                pd->session_idx = 0;
  64                l2tp_dfs_next_tunnel(pd);
  65        }
  66
  67}
  68
  69static void *l2tp_dfs_seq_start(struct seq_file *m, loff_t *offs)
  70{
  71        struct l2tp_dfs_seq_data *pd = SEQ_START_TOKEN;
  72        loff_t pos = *offs;
  73
  74        if (!pos)
  75                goto out;
  76
  77        BUG_ON(m->private == NULL);
  78        pd = m->private;
  79
  80        if (pd->tunnel == NULL)
  81                l2tp_dfs_next_tunnel(pd);
  82        else
  83                l2tp_dfs_next_session(pd);
  84
  85        /* NULL tunnel and session indicates end of list */
  86        if ((pd->tunnel == NULL) && (pd->session == NULL))
  87                pd = NULL;
  88
  89out:
  90        return pd;
  91}
  92
  93
  94static void *l2tp_dfs_seq_next(struct seq_file *m, void *v, loff_t *pos)
  95{
  96        (*pos)++;
  97        return NULL;
  98}
  99
 100static void l2tp_dfs_seq_stop(struct seq_file *p, void *v)
 101{
 102        struct l2tp_dfs_seq_data *pd = v;
 103
 104        if (!pd || pd == SEQ_START_TOKEN)
 105                return;
 106
 107        /* Drop reference taken by last invocation of l2tp_dfs_next_session()
 108         * or l2tp_dfs_next_tunnel().
 109         */
 110        if (pd->session) {
 111                l2tp_session_dec_refcount(pd->session);
 112                pd->session = NULL;
 113        }
 114        if (pd->tunnel) {
 115                l2tp_tunnel_dec_refcount(pd->tunnel);
 116                pd->tunnel = NULL;
 117        }
 118}
 119
 120static void l2tp_dfs_seq_tunnel_show(struct seq_file *m, void *v)
 121{
 122        struct l2tp_tunnel *tunnel = v;
 123        int session_count = 0;
 124        int hash;
 125        struct hlist_node *walk;
 126        struct hlist_node *tmp;
 127
 128        read_lock_bh(&tunnel->hlist_lock);
 129        for (hash = 0; hash < L2TP_HASH_SIZE; hash++) {
 130                hlist_for_each_safe(walk, tmp, &tunnel->session_hlist[hash]) {
 131                        struct l2tp_session *session;
 132
 133                        session = hlist_entry(walk, struct l2tp_session, hlist);
 134                        if (session->session_id == 0)
 135                                continue;
 136
 137                        session_count++;
 138                }
 139        }
 140        read_unlock_bh(&tunnel->hlist_lock);
 141
 142        seq_printf(m, "\nTUNNEL %u peer %u", tunnel->tunnel_id, tunnel->peer_tunnel_id);
 143        if (tunnel->sock) {
 144                struct inet_sock *inet = inet_sk(tunnel->sock);
 145
 146#if IS_ENABLED(CONFIG_IPV6)
 147                if (tunnel->sock->sk_family == AF_INET6) {
 148                        const struct ipv6_pinfo *np = inet6_sk(tunnel->sock);
 149
 150                        seq_printf(m, " from %pI6c to %pI6c\n",
 151                                &np->saddr, &tunnel->sock->sk_v6_daddr);
 152                } else
 153#endif
 154                seq_printf(m, " from %pI4 to %pI4\n",
 155                           &inet->inet_saddr, &inet->inet_daddr);
 156                if (tunnel->encap == L2TP_ENCAPTYPE_UDP)
 157                        seq_printf(m, " source port %hu, dest port %hu\n",
 158                                   ntohs(inet->inet_sport), ntohs(inet->inet_dport));
 159        }
 160        seq_printf(m, " L2TPv%d, %s\n", tunnel->version,
 161                   tunnel->encap == L2TP_ENCAPTYPE_UDP ? "UDP" :
 162                   tunnel->encap == L2TP_ENCAPTYPE_IP ? "IP" :
 163                   "");
 164        seq_printf(m, " %d sessions, refcnt %d/%d\n", session_count,
 165                   tunnel->sock ? refcount_read(&tunnel->sock->sk_refcnt) : 0,
 166                   refcount_read(&tunnel->ref_count));
 167        seq_printf(m, " %08x rx %ld/%ld/%ld rx %ld/%ld/%ld\n",
 168                   tunnel->debug,
 169                   atomic_long_read(&tunnel->stats.tx_packets),
 170                   atomic_long_read(&tunnel->stats.tx_bytes),
 171                   atomic_long_read(&tunnel->stats.tx_errors),
 172                   atomic_long_read(&tunnel->stats.rx_packets),
 173                   atomic_long_read(&tunnel->stats.rx_bytes),
 174                   atomic_long_read(&tunnel->stats.rx_errors));
 175}
 176
 177static void l2tp_dfs_seq_session_show(struct seq_file *m, void *v)
 178{
 179        struct l2tp_session *session = v;
 180
 181        seq_printf(m, "  SESSION %u, peer %u, %s\n", session->session_id,
 182                   session->peer_session_id,
 183                   session->pwtype == L2TP_PWTYPE_ETH ? "ETH" :
 184                   session->pwtype == L2TP_PWTYPE_PPP ? "PPP" :
 185                   "");
 186        if (session->send_seq || session->recv_seq)
 187                seq_printf(m, "   nr %hu, ns %hu\n", session->nr, session->ns);
 188        seq_printf(m, "   refcnt %d\n", refcount_read(&session->ref_count));
 189        seq_printf(m, "   config 0/0/%c/%c/-/%s %08x %u\n",
 190                   session->recv_seq ? 'R' : '-',
 191                   session->send_seq ? 'S' : '-',
 192                   session->lns_mode ? "LNS" : "LAC",
 193                   session->debug,
 194                   jiffies_to_msecs(session->reorder_timeout));
 195        seq_printf(m, "   offset 0 l2specific %hu/%hu\n",
 196                   session->l2specific_type, l2tp_get_l2specific_len(session));
 197        if (session->cookie_len) {
 198                seq_printf(m, "   cookie %02x%02x%02x%02x",
 199                           session->cookie[0], session->cookie[1],
 200                           session->cookie[2], session->cookie[3]);
 201                if (session->cookie_len == 8)
 202                        seq_printf(m, "%02x%02x%02x%02x",
 203                                   session->cookie[4], session->cookie[5],
 204                                   session->cookie[6], session->cookie[7]);
 205                seq_printf(m, "\n");
 206        }
 207        if (session->peer_cookie_len) {
 208                seq_printf(m, "   peer cookie %02x%02x%02x%02x",
 209                           session->peer_cookie[0], session->peer_cookie[1],
 210                           session->peer_cookie[2], session->peer_cookie[3]);
 211                if (session->peer_cookie_len == 8)
 212                        seq_printf(m, "%02x%02x%02x%02x",
 213                                   session->peer_cookie[4], session->peer_cookie[5],
 214                                   session->peer_cookie[6], session->peer_cookie[7]);
 215                seq_printf(m, "\n");
 216        }
 217
 218        seq_printf(m, "   %hu/%hu tx %ld/%ld/%ld rx %ld/%ld/%ld\n",
 219                   session->nr, session->ns,
 220                   atomic_long_read(&session->stats.tx_packets),
 221                   atomic_long_read(&session->stats.tx_bytes),
 222                   atomic_long_read(&session->stats.tx_errors),
 223                   atomic_long_read(&session->stats.rx_packets),
 224                   atomic_long_read(&session->stats.rx_bytes),
 225                   atomic_long_read(&session->stats.rx_errors));
 226
 227        if (session->show != NULL)
 228                session->show(m, session);
 229}
 230
 231static int l2tp_dfs_seq_show(struct seq_file *m, void *v)
 232{
 233        struct l2tp_dfs_seq_data *pd = v;
 234
 235        /* display header on line 1 */
 236        if (v == SEQ_START_TOKEN) {
 237                seq_puts(m, "TUNNEL ID, peer ID from IP to IP\n");
 238                seq_puts(m, " L2TPv2/L2TPv3, UDP/IP\n");
 239                seq_puts(m, " sessions session-count, refcnt refcnt/sk->refcnt\n");
 240                seq_puts(m, " debug tx-pkts/bytes/errs rx-pkts/bytes/errs\n");
 241                seq_puts(m, "  SESSION ID, peer ID, PWTYPE\n");
 242                seq_puts(m, "   refcnt cnt\n");
 243                seq_puts(m, "   offset OFFSET l2specific TYPE/LEN\n");
 244                seq_puts(m, "   [ cookie ]\n");
 245                seq_puts(m, "   [ peer cookie ]\n");
 246                seq_puts(m, "   config mtu/mru/rcvseq/sendseq/dataseq/lns debug reorderto\n");
 247                seq_puts(m, "   nr/ns tx-pkts/bytes/errs rx-pkts/bytes/errs\n");
 248                goto out;
 249        }
 250
 251        if (!pd->session)
 252                l2tp_dfs_seq_tunnel_show(m, pd->tunnel);
 253        else
 254                l2tp_dfs_seq_session_show(m, pd->session);
 255
 256out:
 257        return 0;
 258}
 259
 260static const struct seq_operations l2tp_dfs_seq_ops = {
 261        .start          = l2tp_dfs_seq_start,
 262        .next           = l2tp_dfs_seq_next,
 263        .stop           = l2tp_dfs_seq_stop,
 264        .show           = l2tp_dfs_seq_show,
 265};
 266
 267static int l2tp_dfs_seq_open(struct inode *inode, struct file *file)
 268{
 269        struct l2tp_dfs_seq_data *pd;
 270        struct seq_file *seq;
 271        int rc = -ENOMEM;
 272
 273        pd = kzalloc(sizeof(*pd), GFP_KERNEL);
 274        if (pd == NULL)
 275                goto out;
 276
 277        /* Derive the network namespace from the pid opening the
 278         * file.
 279         */
 280        pd->net = get_net_ns_by_pid(current->pid);
 281        if (IS_ERR(pd->net)) {
 282                rc = PTR_ERR(pd->net);
 283                goto err_free_pd;
 284        }
 285
 286        rc = seq_open(file, &l2tp_dfs_seq_ops);
 287        if (rc)
 288                goto err_free_net;
 289
 290        seq = file->private_data;
 291        seq->private = pd;
 292
 293out:
 294        return rc;
 295
 296err_free_net:
 297        put_net(pd->net);
 298err_free_pd:
 299        kfree(pd);
 300        goto out;
 301}
 302
 303static int l2tp_dfs_seq_release(struct inode *inode, struct file *file)
 304{
 305        struct l2tp_dfs_seq_data *pd;
 306        struct seq_file *seq;
 307
 308        seq = file->private_data;
 309        pd = seq->private;
 310        if (pd->net)
 311                put_net(pd->net);
 312        kfree(pd);
 313        seq_release(inode, file);
 314
 315        return 0;
 316}
 317
 318static const struct file_operations l2tp_dfs_fops = {
 319        .owner          = THIS_MODULE,
 320        .open           = l2tp_dfs_seq_open,
 321        .read           = seq_read,
 322        .llseek         = seq_lseek,
 323        .release        = l2tp_dfs_seq_release,
 324};
 325
 326static int __init l2tp_debugfs_init(void)
 327{
 328        rootdir = debugfs_create_dir("l2tp", NULL);
 329
 330        debugfs_create_file("tunnels", 0600, rootdir, NULL, &l2tp_dfs_fops);
 331
 332        pr_info("L2TP debugfs support\n");
 333
 334        return 0;
 335}
 336
 337static void __exit l2tp_debugfs_exit(void)
 338{
 339        debugfs_remove_recursive(rootdir);
 340}
 341
 342module_init(l2tp_debugfs_init);
 343module_exit(l2tp_debugfs_exit);
 344
 345MODULE_LICENSE("GPL");
 346MODULE_AUTHOR("James Chapman <jchapman@katalix.com>");
 347MODULE_DESCRIPTION("L2TP debugfs driver");
 348MODULE_VERSION("1.0");
 349