l2tp: purge socket queues in the .destruct() callback
[linux/fpc-iii.git] / net / l2tp / l2tp_ppp.c
blob123b6a2411a03832b1b927a6b0eb47d5617f23a1
1 /*****************************************************************************
2 * Linux PPP over L2TP (PPPoX/PPPoL2TP) Sockets
4 * PPPoX --- Generic PPP encapsulation socket family
5 * PPPoL2TP --- PPP over L2TP (RFC 2661)
7 * Version: 2.0.0
9 * Authors: James Chapman (jchapman@katalix.com)
11 * Based on original work by Martijn van Oosterhout <kleptog@svana.org>
13 * License:
14 * This program is free software; you can redistribute it and/or
15 * modify it under the terms of the GNU General Public License
16 * as published by the Free Software Foundation; either version
17 * 2 of the License, or (at your option) any later version.
21 /* This driver handles only L2TP data frames; control frames are handled by a
22 * userspace application.
24 * To send data in an L2TP session, userspace opens a PPPoL2TP socket and
25 * attaches it to a bound UDP socket with local tunnel_id / session_id and
26 * peer tunnel_id / session_id set. Data can then be sent or received using
27 * regular socket sendmsg() / recvmsg() calls. Kernel parameters of the socket
28 * can be read or modified using ioctl() or [gs]etsockopt() calls.
30 * When a PPPoL2TP socket is connected with local and peer session_id values
31 * zero, the socket is treated as a special tunnel management socket.
33 * Here's example userspace code to create a socket for sending/receiving data
34 * over an L2TP session:-
36 * struct sockaddr_pppol2tp sax;
37 * int fd;
38 * int session_fd;
40 * fd = socket(AF_PPPOX, SOCK_DGRAM, PX_PROTO_OL2TP);
42 * sax.sa_family = AF_PPPOX;
43 * sax.sa_protocol = PX_PROTO_OL2TP;
44 * sax.pppol2tp.fd = tunnel_fd; // bound UDP socket
45 * sax.pppol2tp.addr.sin_addr.s_addr = addr->sin_addr.s_addr;
46 * sax.pppol2tp.addr.sin_port = addr->sin_port;
47 * sax.pppol2tp.addr.sin_family = AF_INET;
48 * sax.pppol2tp.s_tunnel = tunnel_id;
49 * sax.pppol2tp.s_session = session_id;
50 * sax.pppol2tp.d_tunnel = peer_tunnel_id;
51 * sax.pppol2tp.d_session = peer_session_id;
53 * session_fd = connect(fd, (struct sockaddr *)&sax, sizeof(sax));
55 * A pppd plugin that allows PPP traffic to be carried over L2TP using
56 * this driver is available from the OpenL2TP project at
57 * http://openl2tp.sourceforge.net.
60 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
62 #include <linux/module.h>
63 #include <linux/string.h>
64 #include <linux/list.h>
65 #include <linux/uaccess.h>
67 #include <linux/kernel.h>
68 #include <linux/spinlock.h>
69 #include <linux/kthread.h>
70 #include <linux/sched.h>
71 #include <linux/slab.h>
72 #include <linux/errno.h>
73 #include <linux/jiffies.h>
75 #include <linux/netdevice.h>
76 #include <linux/net.h>
77 #include <linux/inetdevice.h>
78 #include <linux/skbuff.h>
79 #include <linux/init.h>
80 #include <linux/ip.h>
81 #include <linux/udp.h>
82 #include <linux/if_pppox.h>
83 #include <linux/if_pppol2tp.h>
84 #include <net/sock.h>
85 #include <linux/ppp_channel.h>
86 #include <linux/ppp_defs.h>
87 #include <linux/ppp-ioctl.h>
88 #include <linux/file.h>
89 #include <linux/hash.h>
90 #include <linux/sort.h>
91 #include <linux/proc_fs.h>
92 #include <linux/l2tp.h>
93 #include <linux/nsproxy.h>
94 #include <net/net_namespace.h>
95 #include <net/netns/generic.h>
96 #include <net/dst.h>
97 #include <net/ip.h>
98 #include <net/udp.h>
99 #include <net/xfrm.h>
100 #include <net/inet_common.h>
102 #include <asm/byteorder.h>
103 #include <linux/atomic.h>
105 #include "l2tp_core.h"
107 #define PPPOL2TP_DRV_VERSION "V2.0"
109 /* Space for UDP, L2TP and PPP headers */
110 #define PPPOL2TP_HEADER_OVERHEAD 40
112 /* Number of bytes to build transmit L2TP headers.
113 * Unfortunately the size is different depending on whether sequence numbers
114 * are enabled.
116 #define PPPOL2TP_L2TP_HDR_SIZE_SEQ 10
117 #define PPPOL2TP_L2TP_HDR_SIZE_NOSEQ 6
119 /* Private data of each session. This data lives at the end of struct
120 * l2tp_session, referenced via session->priv[].
122 struct pppol2tp_session {
123 int owner; /* pid that opened the socket */
125 struct sock *sock; /* Pointer to the session
126 * PPPoX socket */
127 struct sock *tunnel_sock; /* Pointer to the tunnel UDP
128 * socket */
129 int flags; /* accessed by PPPIOCGFLAGS.
130 * Unused. */
133 static int pppol2tp_xmit(struct ppp_channel *chan, struct sk_buff *skb);
135 static const struct ppp_channel_ops pppol2tp_chan_ops = {
136 .start_xmit = pppol2tp_xmit,
139 static const struct proto_ops pppol2tp_ops;
141 /* Helpers to obtain tunnel/session contexts from sockets.
143 static inline struct l2tp_session *pppol2tp_sock_to_session(struct sock *sk)
145 struct l2tp_session *session;
147 if (sk == NULL)
148 return NULL;
150 sock_hold(sk);
151 session = (struct l2tp_session *)(sk->sk_user_data);
152 if (session == NULL) {
153 sock_put(sk);
154 goto out;
157 BUG_ON(session->magic != L2TP_SESSION_MAGIC);
159 out:
160 return session;
163 /*****************************************************************************
164 * Receive data handling
165 *****************************************************************************/
167 static int pppol2tp_recv_payload_hook(struct sk_buff *skb)
169 /* Skip PPP header, if present. In testing, Microsoft L2TP clients
170 * don't send the PPP header (PPP header compression enabled), but
171 * other clients can include the header. So we cope with both cases
172 * here. The PPP header is always FF03 when using L2TP.
174 * Note that skb->data[] isn't dereferenced from a u16 ptr here since
175 * the field may be unaligned.
177 if (!pskb_may_pull(skb, 2))
178 return 1;
180 if ((skb->data[0] == PPP_ALLSTATIONS) && (skb->data[1] == PPP_UI))
181 skb_pull(skb, 2);
183 return 0;
186 /* Receive message. This is the recvmsg for the PPPoL2TP socket.
188 static int pppol2tp_recvmsg(struct socket *sock, struct msghdr *msg,
189 size_t len, int flags)
191 int err;
192 struct sk_buff *skb;
193 struct sock *sk = sock->sk;
195 err = -EIO;
196 if (sk->sk_state & PPPOX_BOUND)
197 goto end;
199 err = 0;
200 skb = skb_recv_datagram(sk, flags & ~MSG_DONTWAIT,
201 flags & MSG_DONTWAIT, &err);
202 if (!skb)
203 goto end;
205 if (len > skb->len)
206 len = skb->len;
207 else if (len < skb->len)
208 msg->msg_flags |= MSG_TRUNC;
210 err = skb_copy_datagram_msg(skb, 0, msg, len);
211 if (likely(err == 0))
212 err = len;
214 kfree_skb(skb);
215 end:
216 return err;
219 static void pppol2tp_recv(struct l2tp_session *session, struct sk_buff *skb, int data_len)
221 struct pppol2tp_session *ps = l2tp_session_priv(session);
222 struct sock *sk = NULL;
224 /* If the socket is bound, send it in to PPP's input queue. Otherwise
225 * queue it on the session socket.
227 sk = ps->sock;
228 if (sk == NULL)
229 goto no_sock;
231 if (sk->sk_state & PPPOX_BOUND) {
232 struct pppox_sock *po;
234 l2tp_dbg(session, L2TP_MSG_DATA,
235 "%s: recv %d byte data frame, passing to ppp\n",
236 session->name, data_len);
238 po = pppox_sk(sk);
239 ppp_input(&po->chan, skb);
240 } else {
241 l2tp_dbg(session, L2TP_MSG_DATA,
242 "%s: recv %d byte data frame, passing to L2TP socket\n",
243 session->name, data_len);
245 if (sock_queue_rcv_skb(sk, skb) < 0) {
246 atomic_long_inc(&session->stats.rx_errors);
247 kfree_skb(skb);
251 return;
253 no_sock:
254 l2tp_info(session, L2TP_MSG_DATA, "%s: no socket\n", session->name);
255 kfree_skb(skb);
258 static void pppol2tp_session_sock_hold(struct l2tp_session *session)
260 struct pppol2tp_session *ps = l2tp_session_priv(session);
262 if (ps->sock)
263 sock_hold(ps->sock);
266 static void pppol2tp_session_sock_put(struct l2tp_session *session)
268 struct pppol2tp_session *ps = l2tp_session_priv(session);
270 if (ps->sock)
271 sock_put(ps->sock);
274 /************************************************************************
275 * Transmit handling
276 ***********************************************************************/
278 /* This is the sendmsg for the PPPoL2TP pppol2tp_session socket. We come here
279 * when a user application does a sendmsg() on the session socket. L2TP and
280 * PPP headers must be inserted into the user's data.
282 static int pppol2tp_sendmsg(struct socket *sock, struct msghdr *m,
283 size_t total_len)
285 struct sock *sk = sock->sk;
286 struct sk_buff *skb;
287 int error;
288 struct l2tp_session *session;
289 struct l2tp_tunnel *tunnel;
290 struct pppol2tp_session *ps;
291 int uhlen;
293 error = -ENOTCONN;
294 if (sock_flag(sk, SOCK_DEAD) || !(sk->sk_state & PPPOX_CONNECTED))
295 goto error;
297 /* Get session and tunnel contexts */
298 error = -EBADF;
299 session = pppol2tp_sock_to_session(sk);
300 if (session == NULL)
301 goto error;
303 ps = l2tp_session_priv(session);
304 tunnel = l2tp_sock_to_tunnel(ps->tunnel_sock);
305 if (tunnel == NULL)
306 goto error_put_sess;
308 uhlen = (tunnel->encap == L2TP_ENCAPTYPE_UDP) ? sizeof(struct udphdr) : 0;
310 /* Allocate a socket buffer */
311 error = -ENOMEM;
312 skb = sock_wmalloc(sk, NET_SKB_PAD + sizeof(struct iphdr) +
313 uhlen + session->hdr_len +
314 2 + total_len, /* 2 bytes for PPP_ALLSTATIONS & PPP_UI */
315 0, GFP_KERNEL);
316 if (!skb)
317 goto error_put_sess_tun;
319 /* Reserve space for headers. */
320 skb_reserve(skb, NET_SKB_PAD);
321 skb_reset_network_header(skb);
322 skb_reserve(skb, sizeof(struct iphdr));
323 skb_reset_transport_header(skb);
324 skb_reserve(skb, uhlen);
326 /* Add PPP header */
327 skb->data[0] = PPP_ALLSTATIONS;
328 skb->data[1] = PPP_UI;
329 skb_put(skb, 2);
331 /* Copy user data into skb */
332 error = memcpy_from_msg(skb_put(skb, total_len), m, total_len);
333 if (error < 0) {
334 kfree_skb(skb);
335 goto error_put_sess_tun;
338 local_bh_disable();
339 l2tp_xmit_skb(session, skb, session->hdr_len);
340 local_bh_enable();
342 sock_put(ps->tunnel_sock);
343 sock_put(sk);
345 return total_len;
347 error_put_sess_tun:
348 sock_put(ps->tunnel_sock);
349 error_put_sess:
350 sock_put(sk);
351 error:
352 return error;
355 /* Transmit function called by generic PPP driver. Sends PPP frame
356 * over PPPoL2TP socket.
358 * This is almost the same as pppol2tp_sendmsg(), but rather than
359 * being called with a msghdr from userspace, it is called with a skb
360 * from the kernel.
362 * The supplied skb from ppp doesn't have enough headroom for the
363 * insertion of L2TP, UDP and IP headers so we need to allocate more
364 * headroom in the skb. This will create a cloned skb. But we must be
365 * careful in the error case because the caller will expect to free
366 * the skb it supplied, not our cloned skb. So we take care to always
367 * leave the original skb unfreed if we return an error.
369 static int pppol2tp_xmit(struct ppp_channel *chan, struct sk_buff *skb)
371 struct sock *sk = (struct sock *) chan->private;
372 struct sock *sk_tun;
373 struct l2tp_session *session;
374 struct l2tp_tunnel *tunnel;
375 struct pppol2tp_session *ps;
376 int uhlen, headroom;
378 if (sock_flag(sk, SOCK_DEAD) || !(sk->sk_state & PPPOX_CONNECTED))
379 goto abort;
381 /* Get session and tunnel contexts from the socket */
382 session = pppol2tp_sock_to_session(sk);
383 if (session == NULL)
384 goto abort;
386 ps = l2tp_session_priv(session);
387 sk_tun = ps->tunnel_sock;
388 if (sk_tun == NULL)
389 goto abort_put_sess;
390 tunnel = l2tp_sock_to_tunnel(sk_tun);
391 if (tunnel == NULL)
392 goto abort_put_sess;
394 uhlen = (tunnel->encap == L2TP_ENCAPTYPE_UDP) ? sizeof(struct udphdr) : 0;
395 headroom = NET_SKB_PAD +
396 sizeof(struct iphdr) + /* IP header */
397 uhlen + /* UDP header (if L2TP_ENCAPTYPE_UDP) */
398 session->hdr_len + /* L2TP header */
399 2; /* 2 bytes for PPP_ALLSTATIONS & PPP_UI */
400 if (skb_cow_head(skb, headroom))
401 goto abort_put_sess_tun;
403 /* Setup PPP header */
404 __skb_push(skb, 2);
405 skb->data[0] = PPP_ALLSTATIONS;
406 skb->data[1] = PPP_UI;
408 local_bh_disable();
409 l2tp_xmit_skb(session, skb, session->hdr_len);
410 local_bh_enable();
412 sock_put(sk_tun);
413 sock_put(sk);
414 return 1;
416 abort_put_sess_tun:
417 sock_put(sk_tun);
418 abort_put_sess:
419 sock_put(sk);
420 abort:
421 /* Free the original skb */
422 kfree_skb(skb);
423 return 1;
426 /*****************************************************************************
427 * Session (and tunnel control) socket create/destroy.
428 *****************************************************************************/
430 /* Called by l2tp_core when a session socket is being closed.
432 static void pppol2tp_session_close(struct l2tp_session *session)
434 struct pppol2tp_session *ps = l2tp_session_priv(session);
435 struct sock *sk = ps->sock;
436 struct socket *sock = sk->sk_socket;
438 BUG_ON(session->magic != L2TP_SESSION_MAGIC);
440 if (sock) {
441 inet_shutdown(sock, SEND_SHUTDOWN);
442 /* Don't let the session go away before our socket does */
443 l2tp_session_inc_refcount(session);
447 /* Really kill the session socket. (Called from sock_put() if
448 * refcnt == 0.)
450 static void pppol2tp_session_destruct(struct sock *sk)
452 struct l2tp_session *session = sk->sk_user_data;
454 skb_queue_purge(&sk->sk_receive_queue);
455 skb_queue_purge(&sk->sk_write_queue);
457 if (session) {
458 sk->sk_user_data = NULL;
459 BUG_ON(session->magic != L2TP_SESSION_MAGIC);
460 l2tp_session_dec_refcount(session);
464 /* Called when the PPPoX socket (session) is closed.
466 static int pppol2tp_release(struct socket *sock)
468 struct sock *sk = sock->sk;
469 struct l2tp_session *session;
470 int error;
472 if (!sk)
473 return 0;
475 error = -EBADF;
476 lock_sock(sk);
477 if (sock_flag(sk, SOCK_DEAD) != 0)
478 goto error;
480 pppox_unbind_sock(sk);
482 /* Signal the death of the socket. */
483 sk->sk_state = PPPOX_DEAD;
484 sock_orphan(sk);
485 sock->sk = NULL;
487 session = pppol2tp_sock_to_session(sk);
489 /* Purge any queued data */
490 if (session != NULL) {
491 __l2tp_session_unhash(session);
492 l2tp_session_queue_purge(session);
493 sock_put(sk);
495 release_sock(sk);
497 /* This will delete the session context via
498 * pppol2tp_session_destruct() if the socket's refcnt drops to
499 * zero.
501 sock_put(sk);
503 return 0;
505 error:
506 release_sock(sk);
507 return error;
510 static struct proto pppol2tp_sk_proto = {
511 .name = "PPPOL2TP",
512 .owner = THIS_MODULE,
513 .obj_size = sizeof(struct pppox_sock),
516 static int pppol2tp_backlog_recv(struct sock *sk, struct sk_buff *skb)
518 int rc;
520 rc = l2tp_udp_encap_recv(sk, skb);
521 if (rc)
522 kfree_skb(skb);
524 return NET_RX_SUCCESS;
527 /* socket() handler. Initialize a new struct sock.
529 static int pppol2tp_create(struct net *net, struct socket *sock, int kern)
531 int error = -ENOMEM;
532 struct sock *sk;
534 sk = sk_alloc(net, PF_PPPOX, GFP_KERNEL, &pppol2tp_sk_proto, kern);
535 if (!sk)
536 goto out;
538 sock_init_data(sock, sk);
540 sock->state = SS_UNCONNECTED;
541 sock->ops = &pppol2tp_ops;
543 sk->sk_backlog_rcv = pppol2tp_backlog_recv;
544 sk->sk_protocol = PX_PROTO_OL2TP;
545 sk->sk_family = PF_PPPOX;
546 sk->sk_state = PPPOX_NONE;
547 sk->sk_type = SOCK_STREAM;
548 sk->sk_destruct = pppol2tp_session_destruct;
550 error = 0;
552 out:
553 return error;
556 #if IS_ENABLED(CONFIG_L2TP_DEBUGFS)
557 static void pppol2tp_show(struct seq_file *m, void *arg)
559 struct l2tp_session *session = arg;
560 struct pppol2tp_session *ps = l2tp_session_priv(session);
562 if (ps) {
563 struct pppox_sock *po = pppox_sk(ps->sock);
564 if (po)
565 seq_printf(m, " interface %s\n", ppp_dev_name(&po->chan));
568 #endif
570 /* connect() handler. Attach a PPPoX socket to a tunnel UDP socket
572 static int pppol2tp_connect(struct socket *sock, struct sockaddr *uservaddr,
573 int sockaddr_len, int flags)
575 struct sock *sk = sock->sk;
576 struct sockaddr_pppol2tp *sp = (struct sockaddr_pppol2tp *) uservaddr;
577 struct pppox_sock *po = pppox_sk(sk);
578 struct l2tp_session *session = NULL;
579 struct l2tp_tunnel *tunnel;
580 struct pppol2tp_session *ps;
581 struct dst_entry *dst;
582 struct l2tp_session_cfg cfg = { 0, };
583 int error = 0;
584 u32 tunnel_id, peer_tunnel_id;
585 u32 session_id, peer_session_id;
586 int ver = 2;
587 int fd;
589 lock_sock(sk);
591 error = -EINVAL;
592 if (sp->sa_protocol != PX_PROTO_OL2TP)
593 goto end;
595 /* Check for already bound sockets */
596 error = -EBUSY;
597 if (sk->sk_state & PPPOX_CONNECTED)
598 goto end;
600 /* We don't supporting rebinding anyway */
601 error = -EALREADY;
602 if (sk->sk_user_data)
603 goto end; /* socket is already attached */
605 /* Get params from socket address. Handle L2TPv2 and L2TPv3.
606 * This is nasty because there are different sockaddr_pppol2tp
607 * structs for L2TPv2, L2TPv3, over IPv4 and IPv6. We use
608 * the sockaddr size to determine which structure the caller
609 * is using.
611 peer_tunnel_id = 0;
612 if (sockaddr_len == sizeof(struct sockaddr_pppol2tp)) {
613 fd = sp->pppol2tp.fd;
614 tunnel_id = sp->pppol2tp.s_tunnel;
615 peer_tunnel_id = sp->pppol2tp.d_tunnel;
616 session_id = sp->pppol2tp.s_session;
617 peer_session_id = sp->pppol2tp.d_session;
618 } else if (sockaddr_len == sizeof(struct sockaddr_pppol2tpv3)) {
619 struct sockaddr_pppol2tpv3 *sp3 =
620 (struct sockaddr_pppol2tpv3 *) sp;
621 ver = 3;
622 fd = sp3->pppol2tp.fd;
623 tunnel_id = sp3->pppol2tp.s_tunnel;
624 peer_tunnel_id = sp3->pppol2tp.d_tunnel;
625 session_id = sp3->pppol2tp.s_session;
626 peer_session_id = sp3->pppol2tp.d_session;
627 } else if (sockaddr_len == sizeof(struct sockaddr_pppol2tpin6)) {
628 struct sockaddr_pppol2tpin6 *sp6 =
629 (struct sockaddr_pppol2tpin6 *) sp;
630 fd = sp6->pppol2tp.fd;
631 tunnel_id = sp6->pppol2tp.s_tunnel;
632 peer_tunnel_id = sp6->pppol2tp.d_tunnel;
633 session_id = sp6->pppol2tp.s_session;
634 peer_session_id = sp6->pppol2tp.d_session;
635 } else if (sockaddr_len == sizeof(struct sockaddr_pppol2tpv3in6)) {
636 struct sockaddr_pppol2tpv3in6 *sp6 =
637 (struct sockaddr_pppol2tpv3in6 *) sp;
638 ver = 3;
639 fd = sp6->pppol2tp.fd;
640 tunnel_id = sp6->pppol2tp.s_tunnel;
641 peer_tunnel_id = sp6->pppol2tp.d_tunnel;
642 session_id = sp6->pppol2tp.s_session;
643 peer_session_id = sp6->pppol2tp.d_session;
644 } else {
645 error = -EINVAL;
646 goto end; /* bad socket address */
649 /* Don't bind if tunnel_id is 0 */
650 error = -EINVAL;
651 if (tunnel_id == 0)
652 goto end;
654 tunnel = l2tp_tunnel_find(sock_net(sk), tunnel_id);
656 /* Special case: create tunnel context if session_id and
657 * peer_session_id is 0. Otherwise look up tunnel using supplied
658 * tunnel id.
660 if ((session_id == 0) && (peer_session_id == 0)) {
661 if (tunnel == NULL) {
662 struct l2tp_tunnel_cfg tcfg = {
663 .encap = L2TP_ENCAPTYPE_UDP,
664 .debug = 0,
666 error = l2tp_tunnel_create(sock_net(sk), fd, ver, tunnel_id, peer_tunnel_id, &tcfg, &tunnel);
667 if (error < 0)
668 goto end;
670 } else {
671 /* Error if we can't find the tunnel */
672 error = -ENOENT;
673 if (tunnel == NULL)
674 goto end;
676 /* Error if socket is not prepped */
677 if (tunnel->sock == NULL)
678 goto end;
681 if (tunnel->recv_payload_hook == NULL)
682 tunnel->recv_payload_hook = pppol2tp_recv_payload_hook;
684 if (tunnel->peer_tunnel_id == 0)
685 tunnel->peer_tunnel_id = peer_tunnel_id;
687 /* Create session if it doesn't already exist. We handle the
688 * case where a session was previously created by the netlink
689 * interface by checking that the session doesn't already have
690 * a socket and its tunnel socket are what we expect. If any
691 * of those checks fail, return EEXIST to the caller.
693 session = l2tp_session_find(sock_net(sk), tunnel, session_id);
694 if (session == NULL) {
695 /* Default MTU must allow space for UDP/L2TP/PPP
696 * headers.
698 cfg.mtu = cfg.mru = 1500 - PPPOL2TP_HEADER_OVERHEAD;
700 /* Allocate and initialize a new session context. */
701 session = l2tp_session_create(sizeof(struct pppol2tp_session),
702 tunnel, session_id,
703 peer_session_id, &cfg);
704 if (session == NULL) {
705 error = -ENOMEM;
706 goto end;
708 } else {
709 ps = l2tp_session_priv(session);
710 error = -EEXIST;
711 if (ps->sock != NULL)
712 goto end;
714 /* consistency checks */
715 if (ps->tunnel_sock != tunnel->sock)
716 goto end;
719 /* Associate session with its PPPoL2TP socket */
720 ps = l2tp_session_priv(session);
721 ps->owner = current->pid;
722 ps->sock = sk;
723 ps->tunnel_sock = tunnel->sock;
725 session->recv_skb = pppol2tp_recv;
726 session->session_close = pppol2tp_session_close;
727 #if IS_ENABLED(CONFIG_L2TP_DEBUGFS)
728 session->show = pppol2tp_show;
729 #endif
731 /* We need to know each time a skb is dropped from the reorder
732 * queue.
734 session->ref = pppol2tp_session_sock_hold;
735 session->deref = pppol2tp_session_sock_put;
737 /* If PMTU discovery was enabled, use the MTU that was discovered */
738 dst = sk_dst_get(tunnel->sock);
739 if (dst != NULL) {
740 u32 pmtu = dst_mtu(dst);
742 if (pmtu != 0)
743 session->mtu = session->mru = pmtu -
744 PPPOL2TP_HEADER_OVERHEAD;
745 dst_release(dst);
748 /* Special case: if source & dest session_id == 0x0000, this
749 * socket is being created to manage the tunnel. Just set up
750 * the internal context for use by ioctl() and sockopt()
751 * handlers.
753 if ((session->session_id == 0) &&
754 (session->peer_session_id == 0)) {
755 error = 0;
756 goto out_no_ppp;
759 /* The only header we need to worry about is the L2TP
760 * header. This size is different depending on whether
761 * sequence numbers are enabled for the data channel.
763 po->chan.hdrlen = PPPOL2TP_L2TP_HDR_SIZE_NOSEQ;
765 po->chan.private = sk;
766 po->chan.ops = &pppol2tp_chan_ops;
767 po->chan.mtu = session->mtu;
769 error = ppp_register_net_channel(sock_net(sk), &po->chan);
770 if (error)
771 goto end;
773 out_no_ppp:
774 /* This is how we get the session context from the socket. */
775 sk->sk_user_data = session;
776 sk->sk_state = PPPOX_CONNECTED;
777 l2tp_info(session, L2TP_MSG_CONTROL, "%s: created\n",
778 session->name);
780 end:
781 release_sock(sk);
783 return error;
786 #ifdef CONFIG_L2TP_V3
788 /* Called when creating sessions via the netlink interface.
790 static int pppol2tp_session_create(struct net *net, u32 tunnel_id, u32 session_id, u32 peer_session_id, struct l2tp_session_cfg *cfg)
792 int error;
793 struct l2tp_tunnel *tunnel;
794 struct l2tp_session *session;
795 struct pppol2tp_session *ps;
797 tunnel = l2tp_tunnel_find(net, tunnel_id);
799 /* Error if we can't find the tunnel */
800 error = -ENOENT;
801 if (tunnel == NULL)
802 goto out;
804 /* Error if tunnel socket is not prepped */
805 if (tunnel->sock == NULL)
806 goto out;
808 /* Check that this session doesn't already exist */
809 error = -EEXIST;
810 session = l2tp_session_find(net, tunnel, session_id);
811 if (session != NULL)
812 goto out;
814 /* Default MTU values. */
815 if (cfg->mtu == 0)
816 cfg->mtu = 1500 - PPPOL2TP_HEADER_OVERHEAD;
817 if (cfg->mru == 0)
818 cfg->mru = cfg->mtu;
820 /* Allocate and initialize a new session context. */
821 error = -ENOMEM;
822 session = l2tp_session_create(sizeof(struct pppol2tp_session),
823 tunnel, session_id,
824 peer_session_id, cfg);
825 if (session == NULL)
826 goto out;
828 ps = l2tp_session_priv(session);
829 ps->tunnel_sock = tunnel->sock;
831 l2tp_info(session, L2TP_MSG_CONTROL, "%s: created\n",
832 session->name);
834 error = 0;
836 out:
837 return error;
840 #endif /* CONFIG_L2TP_V3 */
842 /* getname() support.
844 static int pppol2tp_getname(struct socket *sock, struct sockaddr *uaddr,
845 int *usockaddr_len, int peer)
847 int len = 0;
848 int error = 0;
849 struct l2tp_session *session;
850 struct l2tp_tunnel *tunnel;
851 struct sock *sk = sock->sk;
852 struct inet_sock *inet;
853 struct pppol2tp_session *pls;
855 error = -ENOTCONN;
856 if (sk == NULL)
857 goto end;
858 if (!(sk->sk_state & PPPOX_CONNECTED))
859 goto end;
861 error = -EBADF;
862 session = pppol2tp_sock_to_session(sk);
863 if (session == NULL)
864 goto end;
866 pls = l2tp_session_priv(session);
867 tunnel = l2tp_sock_to_tunnel(pls->tunnel_sock);
868 if (tunnel == NULL)
869 goto end_put_sess;
871 inet = inet_sk(tunnel->sock);
872 if ((tunnel->version == 2) && (tunnel->sock->sk_family == AF_INET)) {
873 struct sockaddr_pppol2tp sp;
874 len = sizeof(sp);
875 memset(&sp, 0, len);
876 sp.sa_family = AF_PPPOX;
877 sp.sa_protocol = PX_PROTO_OL2TP;
878 sp.pppol2tp.fd = tunnel->fd;
879 sp.pppol2tp.pid = pls->owner;
880 sp.pppol2tp.s_tunnel = tunnel->tunnel_id;
881 sp.pppol2tp.d_tunnel = tunnel->peer_tunnel_id;
882 sp.pppol2tp.s_session = session->session_id;
883 sp.pppol2tp.d_session = session->peer_session_id;
884 sp.pppol2tp.addr.sin_family = AF_INET;
885 sp.pppol2tp.addr.sin_port = inet->inet_dport;
886 sp.pppol2tp.addr.sin_addr.s_addr = inet->inet_daddr;
887 memcpy(uaddr, &sp, len);
888 #if IS_ENABLED(CONFIG_IPV6)
889 } else if ((tunnel->version == 2) &&
890 (tunnel->sock->sk_family == AF_INET6)) {
891 struct sockaddr_pppol2tpin6 sp;
893 len = sizeof(sp);
894 memset(&sp, 0, len);
895 sp.sa_family = AF_PPPOX;
896 sp.sa_protocol = PX_PROTO_OL2TP;
897 sp.pppol2tp.fd = tunnel->fd;
898 sp.pppol2tp.pid = pls->owner;
899 sp.pppol2tp.s_tunnel = tunnel->tunnel_id;
900 sp.pppol2tp.d_tunnel = tunnel->peer_tunnel_id;
901 sp.pppol2tp.s_session = session->session_id;
902 sp.pppol2tp.d_session = session->peer_session_id;
903 sp.pppol2tp.addr.sin6_family = AF_INET6;
904 sp.pppol2tp.addr.sin6_port = inet->inet_dport;
905 memcpy(&sp.pppol2tp.addr.sin6_addr, &tunnel->sock->sk_v6_daddr,
906 sizeof(tunnel->sock->sk_v6_daddr));
907 memcpy(uaddr, &sp, len);
908 } else if ((tunnel->version == 3) &&
909 (tunnel->sock->sk_family == AF_INET6)) {
910 struct sockaddr_pppol2tpv3in6 sp;
912 len = sizeof(sp);
913 memset(&sp, 0, len);
914 sp.sa_family = AF_PPPOX;
915 sp.sa_protocol = PX_PROTO_OL2TP;
916 sp.pppol2tp.fd = tunnel->fd;
917 sp.pppol2tp.pid = pls->owner;
918 sp.pppol2tp.s_tunnel = tunnel->tunnel_id;
919 sp.pppol2tp.d_tunnel = tunnel->peer_tunnel_id;
920 sp.pppol2tp.s_session = session->session_id;
921 sp.pppol2tp.d_session = session->peer_session_id;
922 sp.pppol2tp.addr.sin6_family = AF_INET6;
923 sp.pppol2tp.addr.sin6_port = inet->inet_dport;
924 memcpy(&sp.pppol2tp.addr.sin6_addr, &tunnel->sock->sk_v6_daddr,
925 sizeof(tunnel->sock->sk_v6_daddr));
926 memcpy(uaddr, &sp, len);
927 #endif
928 } else if (tunnel->version == 3) {
929 struct sockaddr_pppol2tpv3 sp;
930 len = sizeof(sp);
931 memset(&sp, 0, len);
932 sp.sa_family = AF_PPPOX;
933 sp.sa_protocol = PX_PROTO_OL2TP;
934 sp.pppol2tp.fd = tunnel->fd;
935 sp.pppol2tp.pid = pls->owner;
936 sp.pppol2tp.s_tunnel = tunnel->tunnel_id;
937 sp.pppol2tp.d_tunnel = tunnel->peer_tunnel_id;
938 sp.pppol2tp.s_session = session->session_id;
939 sp.pppol2tp.d_session = session->peer_session_id;
940 sp.pppol2tp.addr.sin_family = AF_INET;
941 sp.pppol2tp.addr.sin_port = inet->inet_dport;
942 sp.pppol2tp.addr.sin_addr.s_addr = inet->inet_daddr;
943 memcpy(uaddr, &sp, len);
946 *usockaddr_len = len;
947 error = 0;
949 sock_put(pls->tunnel_sock);
950 end_put_sess:
951 sock_put(sk);
952 end:
953 return error;
956 /****************************************************************************
957 * ioctl() handlers.
959 * The PPPoX socket is created for L2TP sessions: tunnels have their own UDP
960 * sockets. However, in order to control kernel tunnel features, we allow
961 * userspace to create a special "tunnel" PPPoX socket which is used for
962 * control only. Tunnel PPPoX sockets have session_id == 0 and simply allow
963 * the user application to issue L2TP setsockopt(), getsockopt() and ioctl()
964 * calls.
965 ****************************************************************************/
967 static void pppol2tp_copy_stats(struct pppol2tp_ioc_stats *dest,
968 struct l2tp_stats *stats)
970 dest->tx_packets = atomic_long_read(&stats->tx_packets);
971 dest->tx_bytes = atomic_long_read(&stats->tx_bytes);
972 dest->tx_errors = atomic_long_read(&stats->tx_errors);
973 dest->rx_packets = atomic_long_read(&stats->rx_packets);
974 dest->rx_bytes = atomic_long_read(&stats->rx_bytes);
975 dest->rx_seq_discards = atomic_long_read(&stats->rx_seq_discards);
976 dest->rx_oos_packets = atomic_long_read(&stats->rx_oos_packets);
977 dest->rx_errors = atomic_long_read(&stats->rx_errors);
980 /* Session ioctl helper.
982 static int pppol2tp_session_ioctl(struct l2tp_session *session,
983 unsigned int cmd, unsigned long arg)
985 struct ifreq ifr;
986 int err = 0;
987 struct sock *sk;
988 int val = (int) arg;
989 struct pppol2tp_session *ps = l2tp_session_priv(session);
990 struct l2tp_tunnel *tunnel = session->tunnel;
991 struct pppol2tp_ioc_stats stats;
993 l2tp_dbg(session, L2TP_MSG_CONTROL,
994 "%s: pppol2tp_session_ioctl(cmd=%#x, arg=%#lx)\n",
995 session->name, cmd, arg);
997 sk = ps->sock;
998 sock_hold(sk);
1000 switch (cmd) {
1001 case SIOCGIFMTU:
1002 err = -ENXIO;
1003 if (!(sk->sk_state & PPPOX_CONNECTED))
1004 break;
1006 err = -EFAULT;
1007 if (copy_from_user(&ifr, (void __user *) arg, sizeof(struct ifreq)))
1008 break;
1009 ifr.ifr_mtu = session->mtu;
1010 if (copy_to_user((void __user *) arg, &ifr, sizeof(struct ifreq)))
1011 break;
1013 l2tp_info(session, L2TP_MSG_CONTROL, "%s: get mtu=%d\n",
1014 session->name, session->mtu);
1015 err = 0;
1016 break;
1018 case SIOCSIFMTU:
1019 err = -ENXIO;
1020 if (!(sk->sk_state & PPPOX_CONNECTED))
1021 break;
1023 err = -EFAULT;
1024 if (copy_from_user(&ifr, (void __user *) arg, sizeof(struct ifreq)))
1025 break;
1027 session->mtu = ifr.ifr_mtu;
1029 l2tp_info(session, L2TP_MSG_CONTROL, "%s: set mtu=%d\n",
1030 session->name, session->mtu);
1031 err = 0;
1032 break;
1034 case PPPIOCGMRU:
1035 err = -ENXIO;
1036 if (!(sk->sk_state & PPPOX_CONNECTED))
1037 break;
1039 err = -EFAULT;
1040 if (put_user(session->mru, (int __user *) arg))
1041 break;
1043 l2tp_info(session, L2TP_MSG_CONTROL, "%s: get mru=%d\n",
1044 session->name, session->mru);
1045 err = 0;
1046 break;
1048 case PPPIOCSMRU:
1049 err = -ENXIO;
1050 if (!(sk->sk_state & PPPOX_CONNECTED))
1051 break;
1053 err = -EFAULT;
1054 if (get_user(val, (int __user *) arg))
1055 break;
1057 session->mru = val;
1058 l2tp_info(session, L2TP_MSG_CONTROL, "%s: set mru=%d\n",
1059 session->name, session->mru);
1060 err = 0;
1061 break;
1063 case PPPIOCGFLAGS:
1064 err = -EFAULT;
1065 if (put_user(ps->flags, (int __user *) arg))
1066 break;
1068 l2tp_info(session, L2TP_MSG_CONTROL, "%s: get flags=%d\n",
1069 session->name, ps->flags);
1070 err = 0;
1071 break;
1073 case PPPIOCSFLAGS:
1074 err = -EFAULT;
1075 if (get_user(val, (int __user *) arg))
1076 break;
1077 ps->flags = val;
1078 l2tp_info(session, L2TP_MSG_CONTROL, "%s: set flags=%d\n",
1079 session->name, ps->flags);
1080 err = 0;
1081 break;
1083 case PPPIOCGL2TPSTATS:
1084 err = -ENXIO;
1085 if (!(sk->sk_state & PPPOX_CONNECTED))
1086 break;
1088 memset(&stats, 0, sizeof(stats));
1089 stats.tunnel_id = tunnel->tunnel_id;
1090 stats.session_id = session->session_id;
1091 pppol2tp_copy_stats(&stats, &session->stats);
1092 if (copy_to_user((void __user *) arg, &stats,
1093 sizeof(stats)))
1094 break;
1095 l2tp_info(session, L2TP_MSG_CONTROL, "%s: get L2TP stats\n",
1096 session->name);
1097 err = 0;
1098 break;
1100 default:
1101 err = -ENOSYS;
1102 break;
1105 sock_put(sk);
1107 return err;
1110 /* Tunnel ioctl helper.
1112 * Note the special handling for PPPIOCGL2TPSTATS below. If the ioctl data
1113 * specifies a session_id, the session ioctl handler is called. This allows an
1114 * application to retrieve session stats via a tunnel socket.
1116 static int pppol2tp_tunnel_ioctl(struct l2tp_tunnel *tunnel,
1117 unsigned int cmd, unsigned long arg)
1119 int err = 0;
1120 struct sock *sk;
1121 struct pppol2tp_ioc_stats stats;
1123 l2tp_dbg(tunnel, L2TP_MSG_CONTROL,
1124 "%s: pppol2tp_tunnel_ioctl(cmd=%#x, arg=%#lx)\n",
1125 tunnel->name, cmd, arg);
1127 sk = tunnel->sock;
1128 sock_hold(sk);
1130 switch (cmd) {
1131 case PPPIOCGL2TPSTATS:
1132 err = -ENXIO;
1133 if (!(sk->sk_state & PPPOX_CONNECTED))
1134 break;
1136 if (copy_from_user(&stats, (void __user *) arg,
1137 sizeof(stats))) {
1138 err = -EFAULT;
1139 break;
1141 if (stats.session_id != 0) {
1142 /* resend to session ioctl handler */
1143 struct l2tp_session *session =
1144 l2tp_session_find(sock_net(sk), tunnel, stats.session_id);
1145 if (session != NULL)
1146 err = pppol2tp_session_ioctl(session, cmd, arg);
1147 else
1148 err = -EBADR;
1149 break;
1151 #ifdef CONFIG_XFRM
1152 stats.using_ipsec = (sk->sk_policy[0] || sk->sk_policy[1]) ? 1 : 0;
1153 #endif
1154 pppol2tp_copy_stats(&stats, &tunnel->stats);
1155 if (copy_to_user((void __user *) arg, &stats, sizeof(stats))) {
1156 err = -EFAULT;
1157 break;
1159 l2tp_info(tunnel, L2TP_MSG_CONTROL, "%s: get L2TP stats\n",
1160 tunnel->name);
1161 err = 0;
1162 break;
1164 default:
1165 err = -ENOSYS;
1166 break;
1169 sock_put(sk);
1171 return err;
1174 /* Main ioctl() handler.
1175 * Dispatch to tunnel or session helpers depending on the socket.
1177 static int pppol2tp_ioctl(struct socket *sock, unsigned int cmd,
1178 unsigned long arg)
1180 struct sock *sk = sock->sk;
1181 struct l2tp_session *session;
1182 struct l2tp_tunnel *tunnel;
1183 struct pppol2tp_session *ps;
1184 int err;
1186 if (!sk)
1187 return 0;
1189 err = -EBADF;
1190 if (sock_flag(sk, SOCK_DEAD) != 0)
1191 goto end;
1193 err = -ENOTCONN;
1194 if ((sk->sk_user_data == NULL) ||
1195 (!(sk->sk_state & (PPPOX_CONNECTED | PPPOX_BOUND))))
1196 goto end;
1198 /* Get session context from the socket */
1199 err = -EBADF;
1200 session = pppol2tp_sock_to_session(sk);
1201 if (session == NULL)
1202 goto end;
1204 /* Special case: if session's session_id is zero, treat ioctl as a
1205 * tunnel ioctl
1207 ps = l2tp_session_priv(session);
1208 if ((session->session_id == 0) &&
1209 (session->peer_session_id == 0)) {
1210 err = -EBADF;
1211 tunnel = l2tp_sock_to_tunnel(ps->tunnel_sock);
1212 if (tunnel == NULL)
1213 goto end_put_sess;
1215 err = pppol2tp_tunnel_ioctl(tunnel, cmd, arg);
1216 sock_put(ps->tunnel_sock);
1217 goto end_put_sess;
1220 err = pppol2tp_session_ioctl(session, cmd, arg);
1222 end_put_sess:
1223 sock_put(sk);
1224 end:
1225 return err;
1228 /*****************************************************************************
1229 * setsockopt() / getsockopt() support.
1231 * The PPPoX socket is created for L2TP sessions: tunnels have their own UDP
1232 * sockets. In order to control kernel tunnel features, we allow userspace to
1233 * create a special "tunnel" PPPoX socket which is used for control only.
1234 * Tunnel PPPoX sockets have session_id == 0 and simply allow the user
1235 * application to issue L2TP setsockopt(), getsockopt() and ioctl() calls.
1236 *****************************************************************************/
1238 /* Tunnel setsockopt() helper.
1240 static int pppol2tp_tunnel_setsockopt(struct sock *sk,
1241 struct l2tp_tunnel *tunnel,
1242 int optname, int val)
1244 int err = 0;
1246 switch (optname) {
1247 case PPPOL2TP_SO_DEBUG:
1248 tunnel->debug = val;
1249 l2tp_info(tunnel, L2TP_MSG_CONTROL, "%s: set debug=%x\n",
1250 tunnel->name, tunnel->debug);
1251 break;
1253 default:
1254 err = -ENOPROTOOPT;
1255 break;
1258 return err;
1261 /* Session setsockopt helper.
1263 static int pppol2tp_session_setsockopt(struct sock *sk,
1264 struct l2tp_session *session,
1265 int optname, int val)
1267 int err = 0;
1268 struct pppol2tp_session *ps = l2tp_session_priv(session);
1270 switch (optname) {
1271 case PPPOL2TP_SO_RECVSEQ:
1272 if ((val != 0) && (val != 1)) {
1273 err = -EINVAL;
1274 break;
1276 session->recv_seq = !!val;
1277 l2tp_info(session, L2TP_MSG_CONTROL,
1278 "%s: set recv_seq=%d\n",
1279 session->name, session->recv_seq);
1280 break;
1282 case PPPOL2TP_SO_SENDSEQ:
1283 if ((val != 0) && (val != 1)) {
1284 err = -EINVAL;
1285 break;
1287 session->send_seq = !!val;
1289 struct sock *ssk = ps->sock;
1290 struct pppox_sock *po = pppox_sk(ssk);
1291 po->chan.hdrlen = val ? PPPOL2TP_L2TP_HDR_SIZE_SEQ :
1292 PPPOL2TP_L2TP_HDR_SIZE_NOSEQ;
1294 l2tp_session_set_header_len(session, session->tunnel->version);
1295 l2tp_info(session, L2TP_MSG_CONTROL,
1296 "%s: set send_seq=%d\n",
1297 session->name, session->send_seq);
1298 break;
1300 case PPPOL2TP_SO_LNSMODE:
1301 if ((val != 0) && (val != 1)) {
1302 err = -EINVAL;
1303 break;
1305 session->lns_mode = !!val;
1306 l2tp_info(session, L2TP_MSG_CONTROL,
1307 "%s: set lns_mode=%d\n",
1308 session->name, session->lns_mode);
1309 break;
1311 case PPPOL2TP_SO_DEBUG:
1312 session->debug = val;
1313 l2tp_info(session, L2TP_MSG_CONTROL, "%s: set debug=%x\n",
1314 session->name, session->debug);
1315 break;
1317 case PPPOL2TP_SO_REORDERTO:
1318 session->reorder_timeout = msecs_to_jiffies(val);
1319 l2tp_info(session, L2TP_MSG_CONTROL,
1320 "%s: set reorder_timeout=%d\n",
1321 session->name, session->reorder_timeout);
1322 break;
1324 default:
1325 err = -ENOPROTOOPT;
1326 break;
1329 return err;
1332 /* Main setsockopt() entry point.
1333 * Does API checks, then calls either the tunnel or session setsockopt
1334 * handler, according to whether the PPPoL2TP socket is a for a regular
1335 * session or the special tunnel type.
1337 static int pppol2tp_setsockopt(struct socket *sock, int level, int optname,
1338 char __user *optval, unsigned int optlen)
1340 struct sock *sk = sock->sk;
1341 struct l2tp_session *session;
1342 struct l2tp_tunnel *tunnel;
1343 struct pppol2tp_session *ps;
1344 int val;
1345 int err;
1347 if (level != SOL_PPPOL2TP)
1348 return -EINVAL;
1350 if (optlen < sizeof(int))
1351 return -EINVAL;
1353 if (get_user(val, (int __user *)optval))
1354 return -EFAULT;
1356 err = -ENOTCONN;
1357 if (sk->sk_user_data == NULL)
1358 goto end;
1360 /* Get session context from the socket */
1361 err = -EBADF;
1362 session = pppol2tp_sock_to_session(sk);
1363 if (session == NULL)
1364 goto end;
1366 /* Special case: if session_id == 0x0000, treat as operation on tunnel
1368 ps = l2tp_session_priv(session);
1369 if ((session->session_id == 0) &&
1370 (session->peer_session_id == 0)) {
1371 err = -EBADF;
1372 tunnel = l2tp_sock_to_tunnel(ps->tunnel_sock);
1373 if (tunnel == NULL)
1374 goto end_put_sess;
1376 err = pppol2tp_tunnel_setsockopt(sk, tunnel, optname, val);
1377 sock_put(ps->tunnel_sock);
1378 } else
1379 err = pppol2tp_session_setsockopt(sk, session, optname, val);
1381 err = 0;
1383 end_put_sess:
1384 sock_put(sk);
1385 end:
1386 return err;
1389 /* Tunnel getsockopt helper. Called with sock locked.
1391 static int pppol2tp_tunnel_getsockopt(struct sock *sk,
1392 struct l2tp_tunnel *tunnel,
1393 int optname, int *val)
1395 int err = 0;
1397 switch (optname) {
1398 case PPPOL2TP_SO_DEBUG:
1399 *val = tunnel->debug;
1400 l2tp_info(tunnel, L2TP_MSG_CONTROL, "%s: get debug=%x\n",
1401 tunnel->name, tunnel->debug);
1402 break;
1404 default:
1405 err = -ENOPROTOOPT;
1406 break;
1409 return err;
1412 /* Session getsockopt helper. Called with sock locked.
1414 static int pppol2tp_session_getsockopt(struct sock *sk,
1415 struct l2tp_session *session,
1416 int optname, int *val)
1418 int err = 0;
1420 switch (optname) {
1421 case PPPOL2TP_SO_RECVSEQ:
1422 *val = session->recv_seq;
1423 l2tp_info(session, L2TP_MSG_CONTROL,
1424 "%s: get recv_seq=%d\n", session->name, *val);
1425 break;
1427 case PPPOL2TP_SO_SENDSEQ:
1428 *val = session->send_seq;
1429 l2tp_info(session, L2TP_MSG_CONTROL,
1430 "%s: get send_seq=%d\n", session->name, *val);
1431 break;
1433 case PPPOL2TP_SO_LNSMODE:
1434 *val = session->lns_mode;
1435 l2tp_info(session, L2TP_MSG_CONTROL,
1436 "%s: get lns_mode=%d\n", session->name, *val);
1437 break;
1439 case PPPOL2TP_SO_DEBUG:
1440 *val = session->debug;
1441 l2tp_info(session, L2TP_MSG_CONTROL, "%s: get debug=%d\n",
1442 session->name, *val);
1443 break;
1445 case PPPOL2TP_SO_REORDERTO:
1446 *val = (int) jiffies_to_msecs(session->reorder_timeout);
1447 l2tp_info(session, L2TP_MSG_CONTROL,
1448 "%s: get reorder_timeout=%d\n", session->name, *val);
1449 break;
1451 default:
1452 err = -ENOPROTOOPT;
1455 return err;
1458 /* Main getsockopt() entry point.
1459 * Does API checks, then calls either the tunnel or session getsockopt
1460 * handler, according to whether the PPPoX socket is a for a regular session
1461 * or the special tunnel type.
1463 static int pppol2tp_getsockopt(struct socket *sock, int level, int optname,
1464 char __user *optval, int __user *optlen)
1466 struct sock *sk = sock->sk;
1467 struct l2tp_session *session;
1468 struct l2tp_tunnel *tunnel;
1469 int val, len;
1470 int err;
1471 struct pppol2tp_session *ps;
1473 if (level != SOL_PPPOL2TP)
1474 return -EINVAL;
1476 if (get_user(len, optlen))
1477 return -EFAULT;
1479 len = min_t(unsigned int, len, sizeof(int));
1481 if (len < 0)
1482 return -EINVAL;
1484 err = -ENOTCONN;
1485 if (sk->sk_user_data == NULL)
1486 goto end;
1488 /* Get the session context */
1489 err = -EBADF;
1490 session = pppol2tp_sock_to_session(sk);
1491 if (session == NULL)
1492 goto end;
1494 /* Special case: if session_id == 0x0000, treat as operation on tunnel */
1495 ps = l2tp_session_priv(session);
1496 if ((session->session_id == 0) &&
1497 (session->peer_session_id == 0)) {
1498 err = -EBADF;
1499 tunnel = l2tp_sock_to_tunnel(ps->tunnel_sock);
1500 if (tunnel == NULL)
1501 goto end_put_sess;
1503 err = pppol2tp_tunnel_getsockopt(sk, tunnel, optname, &val);
1504 sock_put(ps->tunnel_sock);
1505 } else
1506 err = pppol2tp_session_getsockopt(sk, session, optname, &val);
1508 err = -EFAULT;
1509 if (put_user(len, optlen))
1510 goto end_put_sess;
1512 if (copy_to_user((void __user *) optval, &val, len))
1513 goto end_put_sess;
1515 err = 0;
1517 end_put_sess:
1518 sock_put(sk);
1519 end:
1520 return err;
1523 /*****************************************************************************
1524 * /proc filesystem for debug
1525 * Since the original pppol2tp driver provided /proc/net/pppol2tp for
1526 * L2TPv2, we dump only L2TPv2 tunnels and sessions here.
1527 *****************************************************************************/
1529 static unsigned int pppol2tp_net_id;
1531 #ifdef CONFIG_PROC_FS
1533 struct pppol2tp_seq_data {
1534 struct seq_net_private p;
1535 int tunnel_idx; /* current tunnel */
1536 int session_idx; /* index of session within current tunnel */
1537 struct l2tp_tunnel *tunnel;
1538 struct l2tp_session *session; /* NULL means get next tunnel */
1541 static void pppol2tp_next_tunnel(struct net *net, struct pppol2tp_seq_data *pd)
1543 for (;;) {
1544 pd->tunnel = l2tp_tunnel_find_nth(net, pd->tunnel_idx);
1545 pd->tunnel_idx++;
1547 if (pd->tunnel == NULL)
1548 break;
1550 /* Ignore L2TPv3 tunnels */
1551 if (pd->tunnel->version < 3)
1552 break;
1556 static void pppol2tp_next_session(struct net *net, struct pppol2tp_seq_data *pd)
1558 pd->session = l2tp_session_find_nth(pd->tunnel, pd->session_idx);
1559 pd->session_idx++;
1561 if (pd->session == NULL) {
1562 pd->session_idx = 0;
1563 pppol2tp_next_tunnel(net, pd);
1567 static void *pppol2tp_seq_start(struct seq_file *m, loff_t *offs)
1569 struct pppol2tp_seq_data *pd = SEQ_START_TOKEN;
1570 loff_t pos = *offs;
1571 struct net *net;
1573 if (!pos)
1574 goto out;
1576 BUG_ON(m->private == NULL);
1577 pd = m->private;
1578 net = seq_file_net(m);
1580 if (pd->tunnel == NULL)
1581 pppol2tp_next_tunnel(net, pd);
1582 else
1583 pppol2tp_next_session(net, pd);
1585 /* NULL tunnel and session indicates end of list */
1586 if ((pd->tunnel == NULL) && (pd->session == NULL))
1587 pd = NULL;
1589 out:
1590 return pd;
1593 static void *pppol2tp_seq_next(struct seq_file *m, void *v, loff_t *pos)
1595 (*pos)++;
1596 return NULL;
1599 static void pppol2tp_seq_stop(struct seq_file *p, void *v)
1601 /* nothing to do */
1604 static void pppol2tp_seq_tunnel_show(struct seq_file *m, void *v)
1606 struct l2tp_tunnel *tunnel = v;
1608 seq_printf(m, "\nTUNNEL '%s', %c %d\n",
1609 tunnel->name,
1610 (tunnel == tunnel->sock->sk_user_data) ? 'Y' : 'N',
1611 atomic_read(&tunnel->ref_count) - 1);
1612 seq_printf(m, " %08x %ld/%ld/%ld %ld/%ld/%ld\n",
1613 tunnel->debug,
1614 atomic_long_read(&tunnel->stats.tx_packets),
1615 atomic_long_read(&tunnel->stats.tx_bytes),
1616 atomic_long_read(&tunnel->stats.tx_errors),
1617 atomic_long_read(&tunnel->stats.rx_packets),
1618 atomic_long_read(&tunnel->stats.rx_bytes),
1619 atomic_long_read(&tunnel->stats.rx_errors));
1622 static void pppol2tp_seq_session_show(struct seq_file *m, void *v)
1624 struct l2tp_session *session = v;
1625 struct l2tp_tunnel *tunnel = session->tunnel;
1626 struct pppol2tp_session *ps = l2tp_session_priv(session);
1627 struct pppox_sock *po = pppox_sk(ps->sock);
1628 u32 ip = 0;
1629 u16 port = 0;
1631 if (tunnel->sock) {
1632 struct inet_sock *inet = inet_sk(tunnel->sock);
1633 ip = ntohl(inet->inet_saddr);
1634 port = ntohs(inet->inet_sport);
1637 seq_printf(m, " SESSION '%s' %08X/%d %04X/%04X -> "
1638 "%04X/%04X %d %c\n",
1639 session->name, ip, port,
1640 tunnel->tunnel_id,
1641 session->session_id,
1642 tunnel->peer_tunnel_id,
1643 session->peer_session_id,
1644 ps->sock->sk_state,
1645 (session == ps->sock->sk_user_data) ?
1646 'Y' : 'N');
1647 seq_printf(m, " %d/%d/%c/%c/%s %08x %u\n",
1648 session->mtu, session->mru,
1649 session->recv_seq ? 'R' : '-',
1650 session->send_seq ? 'S' : '-',
1651 session->lns_mode ? "LNS" : "LAC",
1652 session->debug,
1653 jiffies_to_msecs(session->reorder_timeout));
1654 seq_printf(m, " %hu/%hu %ld/%ld/%ld %ld/%ld/%ld\n",
1655 session->nr, session->ns,
1656 atomic_long_read(&session->stats.tx_packets),
1657 atomic_long_read(&session->stats.tx_bytes),
1658 atomic_long_read(&session->stats.tx_errors),
1659 atomic_long_read(&session->stats.rx_packets),
1660 atomic_long_read(&session->stats.rx_bytes),
1661 atomic_long_read(&session->stats.rx_errors));
1663 if (po)
1664 seq_printf(m, " interface %s\n", ppp_dev_name(&po->chan));
1667 static int pppol2tp_seq_show(struct seq_file *m, void *v)
1669 struct pppol2tp_seq_data *pd = v;
1671 /* display header on line 1 */
1672 if (v == SEQ_START_TOKEN) {
1673 seq_puts(m, "PPPoL2TP driver info, " PPPOL2TP_DRV_VERSION "\n");
1674 seq_puts(m, "TUNNEL name, user-data-ok session-count\n");
1675 seq_puts(m, " debug tx-pkts/bytes/errs rx-pkts/bytes/errs\n");
1676 seq_puts(m, " SESSION name, addr/port src-tid/sid "
1677 "dest-tid/sid state user-data-ok\n");
1678 seq_puts(m, " mtu/mru/rcvseq/sendseq/lns debug reorderto\n");
1679 seq_puts(m, " nr/ns tx-pkts/bytes/errs rx-pkts/bytes/errs\n");
1680 goto out;
1683 /* Show the tunnel or session context.
1685 if (pd->session == NULL)
1686 pppol2tp_seq_tunnel_show(m, pd->tunnel);
1687 else
1688 pppol2tp_seq_session_show(m, pd->session);
1690 out:
1691 return 0;
1694 static const struct seq_operations pppol2tp_seq_ops = {
1695 .start = pppol2tp_seq_start,
1696 .next = pppol2tp_seq_next,
1697 .stop = pppol2tp_seq_stop,
1698 .show = pppol2tp_seq_show,
1701 /* Called when our /proc file is opened. We allocate data for use when
1702 * iterating our tunnel / session contexts and store it in the private
1703 * data of the seq_file.
1705 static int pppol2tp_proc_open(struct inode *inode, struct file *file)
1707 return seq_open_net(inode, file, &pppol2tp_seq_ops,
1708 sizeof(struct pppol2tp_seq_data));
1711 static const struct file_operations pppol2tp_proc_fops = {
1712 .owner = THIS_MODULE,
1713 .open = pppol2tp_proc_open,
1714 .read = seq_read,
1715 .llseek = seq_lseek,
1716 .release = seq_release_net,
1719 #endif /* CONFIG_PROC_FS */
1721 /*****************************************************************************
1722 * Network namespace
1723 *****************************************************************************/
1725 static __net_init int pppol2tp_init_net(struct net *net)
1727 struct proc_dir_entry *pde;
1728 int err = 0;
1730 pde = proc_create("pppol2tp", S_IRUGO, net->proc_net,
1731 &pppol2tp_proc_fops);
1732 if (!pde) {
1733 err = -ENOMEM;
1734 goto out;
1737 out:
1738 return err;
1741 static __net_exit void pppol2tp_exit_net(struct net *net)
1743 remove_proc_entry("pppol2tp", net->proc_net);
1746 static struct pernet_operations pppol2tp_net_ops = {
1747 .init = pppol2tp_init_net,
1748 .exit = pppol2tp_exit_net,
1749 .id = &pppol2tp_net_id,
1752 /*****************************************************************************
1753 * Init and cleanup
1754 *****************************************************************************/
1756 static const struct proto_ops pppol2tp_ops = {
1757 .family = AF_PPPOX,
1758 .owner = THIS_MODULE,
1759 .release = pppol2tp_release,
1760 .bind = sock_no_bind,
1761 .connect = pppol2tp_connect,
1762 .socketpair = sock_no_socketpair,
1763 .accept = sock_no_accept,
1764 .getname = pppol2tp_getname,
1765 .poll = datagram_poll,
1766 .listen = sock_no_listen,
1767 .shutdown = sock_no_shutdown,
1768 .setsockopt = pppol2tp_setsockopt,
1769 .getsockopt = pppol2tp_getsockopt,
1770 .sendmsg = pppol2tp_sendmsg,
1771 .recvmsg = pppol2tp_recvmsg,
1772 .mmap = sock_no_mmap,
1773 .ioctl = pppox_ioctl,
1776 static const struct pppox_proto pppol2tp_proto = {
1777 .create = pppol2tp_create,
1778 .ioctl = pppol2tp_ioctl,
1779 .owner = THIS_MODULE,
1782 #ifdef CONFIG_L2TP_V3
1784 static const struct l2tp_nl_cmd_ops pppol2tp_nl_cmd_ops = {
1785 .session_create = pppol2tp_session_create,
1786 .session_delete = l2tp_session_delete,
1789 #endif /* CONFIG_L2TP_V3 */
1791 static int __init pppol2tp_init(void)
1793 int err;
1795 err = register_pernet_device(&pppol2tp_net_ops);
1796 if (err)
1797 goto out;
1799 err = proto_register(&pppol2tp_sk_proto, 0);
1800 if (err)
1801 goto out_unregister_pppol2tp_pernet;
1803 err = register_pppox_proto(PX_PROTO_OL2TP, &pppol2tp_proto);
1804 if (err)
1805 goto out_unregister_pppol2tp_proto;
1807 #ifdef CONFIG_L2TP_V3
1808 err = l2tp_nl_register_ops(L2TP_PWTYPE_PPP, &pppol2tp_nl_cmd_ops);
1809 if (err)
1810 goto out_unregister_pppox;
1811 #endif
1813 pr_info("PPPoL2TP kernel driver, %s\n", PPPOL2TP_DRV_VERSION);
1815 out:
1816 return err;
1818 #ifdef CONFIG_L2TP_V3
1819 out_unregister_pppox:
1820 unregister_pppox_proto(PX_PROTO_OL2TP);
1821 #endif
1822 out_unregister_pppol2tp_proto:
1823 proto_unregister(&pppol2tp_sk_proto);
1824 out_unregister_pppol2tp_pernet:
1825 unregister_pernet_device(&pppol2tp_net_ops);
1826 goto out;
1829 static void __exit pppol2tp_exit(void)
1831 #ifdef CONFIG_L2TP_V3
1832 l2tp_nl_unregister_ops(L2TP_PWTYPE_PPP);
1833 #endif
1834 unregister_pppox_proto(PX_PROTO_OL2TP);
1835 proto_unregister(&pppol2tp_sk_proto);
1836 unregister_pernet_device(&pppol2tp_net_ops);
1839 module_init(pppol2tp_init);
1840 module_exit(pppol2tp_exit);
1842 MODULE_AUTHOR("James Chapman <jchapman@katalix.com>");
1843 MODULE_DESCRIPTION("PPP over L2TP over UDP");
1844 MODULE_LICENSE("GPL");
1845 MODULE_VERSION(PPPOL2TP_DRV_VERSION);
1846 MODULE_ALIAS_NET_PF_PROTO(PF_PPPOX, PX_PROTO_OL2TP);
1847 MODULE_ALIAS_L2TP_PWTYPE(11);