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