1 /*****************************************************************************
2 * Linux PPP over L2TP (PPPoX/PPPoL2TP) Sockets
4 * PPPoX --- Generic PPP encapsulation socket family
5 * PPPoL2TP --- PPP over L2TP (RFC 2661)
9 * Authors: Martijn van Oosterhout <kleptog@svana.org>
10 * James Chapman (jchapman@katalix.com)
12 * Michal Ostrowski <mostrows@speakeasy.net>
13 * Arnaldo Carvalho de Melo <acme@xconectiva.com.br>
14 * David S. Miller (davem@redhat.com)
17 * This program is free software; you can redistribute it and/or
18 * modify it under the terms of the GNU General Public License
19 * as published by the Free Software Foundation; either version
20 * 2 of the License, or (at your option) any later version.
24 /* This driver handles only L2TP data frames; control frames are handled by a
25 * userspace application.
27 * To send data in an L2TP session, userspace opens a PPPoL2TP socket and
28 * attaches it to a bound UDP socket with local tunnel_id / session_id and
29 * peer tunnel_id / session_id set. Data can then be sent or received using
30 * regular socket sendmsg() / recvmsg() calls. Kernel parameters of the socket
31 * can be read or modified using ioctl() or [gs]etsockopt() calls.
33 * When a PPPoL2TP socket is connected with local and peer session_id values
34 * zero, the socket is treated as a special tunnel management socket.
36 * Here's example userspace code to create a socket for sending/receiving data
37 * over an L2TP session:-
39 * struct sockaddr_pppol2tp sax;
43 * fd = socket(AF_PPPOX, SOCK_DGRAM, PX_PROTO_OL2TP);
45 * sax.sa_family = AF_PPPOX;
46 * sax.sa_protocol = PX_PROTO_OL2TP;
47 * sax.pppol2tp.fd = tunnel_fd; // bound UDP socket
48 * sax.pppol2tp.addr.sin_addr.s_addr = addr->sin_addr.s_addr;
49 * sax.pppol2tp.addr.sin_port = addr->sin_port;
50 * sax.pppol2tp.addr.sin_family = AF_INET;
51 * sax.pppol2tp.s_tunnel = tunnel_id;
52 * sax.pppol2tp.s_session = session_id;
53 * sax.pppol2tp.d_tunnel = peer_tunnel_id;
54 * sax.pppol2tp.d_session = peer_session_id;
56 * session_fd = connect(fd, (struct sockaddr *)&sax, sizeof(sax));
58 * A pppd plugin that allows PPP traffic to be carried over L2TP using
59 * this driver is available from the OpenL2TP project at
60 * http://openl2tp.sourceforge.net.
63 #include <linux/module.h>
64 #include <linux/version.h>
65 #include <linux/string.h>
66 #include <linux/list.h>
67 #include <asm/uaccess.h>
69 #include <linux/kernel.h>
70 #include <linux/spinlock.h>
71 #include <linux/kthread.h>
72 #include <linux/sched.h>
73 #include <linux/slab.h>
74 #include <linux/errno.h>
75 #include <linux/jiffies.h>
77 #include <linux/netdevice.h>
78 #include <linux/net.h>
79 #include <linux/inetdevice.h>
80 #include <linux/skbuff.h>
81 #include <linux/init.h>
83 #include <linux/udp.h>
84 #include <linux/if_pppox.h>
85 #include <linux/if_pppol2tp.h>
87 #include <linux/ppp_channel.h>
88 #include <linux/ppp_defs.h>
89 #include <linux/if_ppp.h>
90 #include <linux/file.h>
91 #include <linux/hash.h>
92 #include <linux/sort.h>
93 #include <linux/proc_fs.h>
94 #include <net/net_namespace.h>
100 #include <asm/byteorder.h>
101 #include <asm/atomic.h>
104 #define PPPOL2TP_DRV_VERSION "V1.0"
106 /* L2TP header constants */
107 #define L2TP_HDRFLAG_T 0x8000
108 #define L2TP_HDRFLAG_L 0x4000
109 #define L2TP_HDRFLAG_S 0x0800
110 #define L2TP_HDRFLAG_O 0x0200
111 #define L2TP_HDRFLAG_P 0x0100
113 #define L2TP_HDR_VER_MASK 0x000F
114 #define L2TP_HDR_VER 0x0002
116 /* Space for UDP, L2TP and PPP headers */
117 #define PPPOL2TP_HEADER_OVERHEAD 40
119 /* Just some random numbers */
120 #define L2TP_TUNNEL_MAGIC 0x42114DDA
121 #define L2TP_SESSION_MAGIC 0x0C04EB7D
123 #define PPPOL2TP_HASH_BITS 4
124 #define PPPOL2TP_HASH_SIZE (1 << PPPOL2TP_HASH_BITS)
126 /* Default trace flags */
127 #define PPPOL2TP_DEFAULT_DEBUG_FLAGS 0
129 #define PRINTK(_mask, _type, _lvl, _fmt, args...) \
131 if ((_mask) & (_type)) \
132 printk(_lvl "PPPOL2TP: " _fmt, ##args); \
135 /* Number of bytes to build transmit L2TP headers.
136 * Unfortunately the size is different depending on whether sequence numbers
139 #define PPPOL2TP_L2TP_HDR_SIZE_SEQ 10
140 #define PPPOL2TP_L2TP_HDR_SIZE_NOSEQ 6
142 struct pppol2tp_tunnel;
144 /* Describes a session. It is the sk_user_data field in the PPPoL2TP
145 * socket. Contains information to determine incoming packets and transmit
148 struct pppol2tp_session
150 int magic; /* should be
151 * L2TP_SESSION_MAGIC */
152 int owner; /* pid that opened the socket */
154 struct sock *sock; /* Pointer to the session
156 struct sock *tunnel_sock; /* Pointer to the tunnel UDP
159 struct pppol2tp_addr tunnel_addr; /* Description of tunnel */
161 struct pppol2tp_tunnel *tunnel; /* back pointer to tunnel
164 char name[20]; /* "sess xxxxx/yyyyy", where
165 * x=tunnel_id, y=session_id */
168 int flags; /* accessed by PPPIOCGFLAGS.
170 unsigned recv_seq:1; /* expect receive packets with
171 * sequence numbers? */
172 unsigned send_seq:1; /* send packets with sequence
174 unsigned lns_mode:1; /* behave as LNS? LAC enables
175 * sequence numbers under
177 int debug; /* bitmask of debug message
179 int reorder_timeout; /* configured reorder timeout
181 u16 nr; /* session NR state (receive) */
182 u16 ns; /* session NR state (send) */
183 struct sk_buff_head reorder_q; /* receive reorder queue */
184 struct pppol2tp_ioc_stats stats;
185 struct hlist_node hlist; /* Hash list node */
188 /* The sk_user_data field of the tunnel's UDP socket. It contains info to track
189 * all the associated sessions so incoming packets can be sorted out
191 struct pppol2tp_tunnel
193 int magic; /* Should be L2TP_TUNNEL_MAGIC */
194 rwlock_t hlist_lock; /* protect session_hlist */
195 struct hlist_head session_hlist[PPPOL2TP_HASH_SIZE];
196 /* hashed list of sessions,
198 int debug; /* bitmask of debug message
200 char name[12]; /* "tunl xxxxx" */
201 struct pppol2tp_ioc_stats stats;
203 void (*old_sk_destruct)(struct sock *);
205 struct sock *sock; /* Parent socket */
206 struct list_head list; /* Keep a list of all open
207 * prepared sockets */
212 /* Private data stored for received packets in the skb.
214 struct pppol2tp_skb_cb {
219 unsigned long expires;
222 #define PPPOL2TP_SKB_CB(skb) ((struct pppol2tp_skb_cb *) &skb->cb[sizeof(struct inet_skb_parm)])
224 static int pppol2tp_xmit(struct ppp_channel *chan, struct sk_buff *skb);
225 static void pppol2tp_tunnel_free(struct pppol2tp_tunnel *tunnel);
227 static atomic_t pppol2tp_tunnel_count;
228 static atomic_t pppol2tp_session_count;
229 static struct ppp_channel_ops pppol2tp_chan_ops = { pppol2tp_xmit , NULL };
230 static struct proto_ops pppol2tp_ops;
231 static LIST_HEAD(pppol2tp_tunnel_list);
232 static DEFINE_RWLOCK(pppol2tp_tunnel_list_lock);
234 /* Helpers to obtain tunnel/session contexts from sockets.
236 static inline struct pppol2tp_session *pppol2tp_sock_to_session(struct sock *sk)
238 struct pppol2tp_session *session;
243 session = (struct pppol2tp_session *)(sk->sk_user_data);
247 BUG_ON(session->magic != L2TP_SESSION_MAGIC);
252 static inline struct pppol2tp_tunnel *pppol2tp_sock_to_tunnel(struct sock *sk)
254 struct pppol2tp_tunnel *tunnel;
259 tunnel = (struct pppol2tp_tunnel *)(sk->sk_user_data);
263 BUG_ON(tunnel->magic != L2TP_TUNNEL_MAGIC);
268 /* Tunnel reference counts. Incremented per session that is added to
271 static inline void pppol2tp_tunnel_inc_refcount(struct pppol2tp_tunnel *tunnel)
273 atomic_inc(&tunnel->ref_count);
276 static inline void pppol2tp_tunnel_dec_refcount(struct pppol2tp_tunnel *tunnel)
278 if (atomic_dec_and_test(&tunnel->ref_count))
279 pppol2tp_tunnel_free(tunnel);
282 /* Session hash list.
283 * The session_id SHOULD be random according to RFC2661, but several
284 * L2TP implementations (Cisco and Microsoft) use incrementing
285 * session_ids. So we do a real hash on the session_id, rather than a
288 static inline struct hlist_head *
289 pppol2tp_session_id_hash(struct pppol2tp_tunnel *tunnel, u16 session_id)
291 unsigned long hash_val = (unsigned long) session_id;
292 return &tunnel->session_hlist[hash_long(hash_val, PPPOL2TP_HASH_BITS)];
295 /* Lookup a session by id
297 static struct pppol2tp_session *
298 pppol2tp_session_find(struct pppol2tp_tunnel *tunnel, u16 session_id)
300 struct hlist_head *session_list =
301 pppol2tp_session_id_hash(tunnel, session_id);
302 struct pppol2tp_session *session;
303 struct hlist_node *walk;
305 read_lock(&tunnel->hlist_lock);
306 hlist_for_each_entry(session, walk, session_list, hlist) {
307 if (session->tunnel_addr.s_session == session_id) {
308 read_unlock(&tunnel->hlist_lock);
312 read_unlock(&tunnel->hlist_lock);
317 /* Lookup a tunnel by id
319 static struct pppol2tp_tunnel *pppol2tp_tunnel_find(u16 tunnel_id)
321 struct pppol2tp_tunnel *tunnel = NULL;
323 read_lock(&pppol2tp_tunnel_list_lock);
324 list_for_each_entry(tunnel, &pppol2tp_tunnel_list, list) {
325 if (tunnel->stats.tunnel_id == tunnel_id) {
326 read_unlock(&pppol2tp_tunnel_list_lock);
330 read_unlock(&pppol2tp_tunnel_list_lock);
335 /*****************************************************************************
336 * Receive data handling
337 *****************************************************************************/
339 /* Queue a skb in order. We come here only if the skb has an L2TP sequence
342 static void pppol2tp_recv_queue_skb(struct pppol2tp_session *session, struct sk_buff *skb)
344 struct sk_buff *skbp;
345 u16 ns = PPPOL2TP_SKB_CB(skb)->ns;
347 spin_lock(&session->reorder_q.lock);
348 skb_queue_walk(&session->reorder_q, skbp) {
349 if (PPPOL2TP_SKB_CB(skbp)->ns > ns) {
350 __skb_insert(skb, skbp->prev, skbp, &session->reorder_q);
351 PRINTK(session->debug, PPPOL2TP_MSG_SEQ, KERN_DEBUG,
352 "%s: pkt %hu, inserted before %hu, reorder_q len=%d\n",
353 session->name, ns, PPPOL2TP_SKB_CB(skbp)->ns,
354 skb_queue_len(&session->reorder_q));
355 session->stats.rx_oos_packets++;
360 __skb_queue_tail(&session->reorder_q, skb);
363 spin_unlock(&session->reorder_q.lock);
366 /* Dequeue a single skb.
368 static void pppol2tp_recv_dequeue_skb(struct pppol2tp_session *session, struct sk_buff *skb)
370 struct pppol2tp_tunnel *tunnel = session->tunnel;
371 int length = PPPOL2TP_SKB_CB(skb)->length;
372 struct sock *session_sock = NULL;
374 /* We're about to requeue the skb, so unlink it and return resources
375 * to its current owner (a socket receive buffer).
377 skb_unlink(skb, &session->reorder_q);
380 tunnel->stats.rx_packets++;
381 tunnel->stats.rx_bytes += length;
382 session->stats.rx_packets++;
383 session->stats.rx_bytes += length;
385 if (PPPOL2TP_SKB_CB(skb)->has_seq) {
388 PRINTK(session->debug, PPPOL2TP_MSG_SEQ, KERN_DEBUG,
389 "%s: updated nr to %hu\n", session->name, session->nr);
392 /* If the socket is bound, send it in to PPP's input queue. Otherwise
393 * queue it on the session socket.
395 session_sock = session->sock;
396 if (session_sock->sk_state & PPPOX_BOUND) {
397 struct pppox_sock *po;
398 PRINTK(session->debug, PPPOL2TP_MSG_DATA, KERN_DEBUG,
399 "%s: recv %d byte data frame, passing to ppp\n",
400 session->name, length);
402 /* We need to forget all info related to the L2TP packet
403 * gathered in the skb as we are going to reuse the same
404 * skb for the inner packet.
406 * - reset xfrm (IPSec) information as it applies to
407 * the outer L2TP packet and not to the inner one
408 * - release the dst to force a route lookup on the inner
409 * IP packet since skb->dst currently points to the dst
411 * - reset netfilter information as it doesn't apply
412 * to the inner packet either
415 dst_release(skb->dst);
419 po = pppox_sk(session_sock);
420 ppp_input(&po->chan, skb);
422 PRINTK(session->debug, PPPOL2TP_MSG_DATA, KERN_INFO,
423 "%s: socket not bound\n", session->name);
425 /* Not bound. Nothing we can do, so discard. */
426 session->stats.rx_errors++;
430 sock_put(session->sock);
433 /* Dequeue skbs from the session's reorder_q, subject to packet order.
434 * Skbs that have been in the queue for too long are simply discarded.
436 static void pppol2tp_recv_dequeue(struct pppol2tp_session *session)
441 /* If the pkt at the head of the queue has the nr that we
442 * expect to send up next, dequeue it and any other
443 * in-sequence packets behind it.
445 spin_lock(&session->reorder_q.lock);
446 skb_queue_walk_safe(&session->reorder_q, skb, tmp) {
447 if (time_after(jiffies, PPPOL2TP_SKB_CB(skb)->expires)) {
448 session->stats.rx_seq_discards++;
449 session->stats.rx_errors++;
450 PRINTK(session->debug, PPPOL2TP_MSG_SEQ, KERN_DEBUG,
451 "%s: oos pkt %hu len %d discarded (too old), "
452 "waiting for %hu, reorder_q_len=%d\n",
453 session->name, PPPOL2TP_SKB_CB(skb)->ns,
454 PPPOL2TP_SKB_CB(skb)->length, session->nr,
455 skb_queue_len(&session->reorder_q));
456 __skb_unlink(skb, &session->reorder_q);
458 sock_put(session->sock);
462 if (PPPOL2TP_SKB_CB(skb)->has_seq) {
463 if (PPPOL2TP_SKB_CB(skb)->ns != session->nr) {
464 PRINTK(session->debug, PPPOL2TP_MSG_SEQ, KERN_DEBUG,
465 "%s: holding oos pkt %hu len %d, "
466 "waiting for %hu, reorder_q_len=%d\n",
467 session->name, PPPOL2TP_SKB_CB(skb)->ns,
468 PPPOL2TP_SKB_CB(skb)->length, session->nr,
469 skb_queue_len(&session->reorder_q));
473 spin_unlock(&session->reorder_q.lock);
474 pppol2tp_recv_dequeue_skb(session, skb);
475 spin_lock(&session->reorder_q.lock);
479 spin_unlock(&session->reorder_q.lock);
482 /* Internal receive frame. Do the real work of receiving an L2TP data frame
483 * here. The skb is not on a list when we get here.
484 * Returns 0 if the packet was a data packet and was successfully passed on.
485 * Returns 1 if the packet was not a good data packet and could not be
486 * forwarded. All such packets are passed up to userspace to deal with.
488 static int pppol2tp_recv_core(struct sock *sock, struct sk_buff *skb)
490 struct pppol2tp_session *session = NULL;
491 struct pppol2tp_tunnel *tunnel;
492 unsigned char *ptr, *optr;
494 u16 tunnel_id, session_id;
498 tunnel = pppol2tp_sock_to_tunnel(sock);
502 /* UDP always verifies the packet length. */
503 __skb_pull(skb, sizeof(struct udphdr));
506 if (!pskb_may_pull(skb, 12)) {
507 PRINTK(tunnel->debug, PPPOL2TP_MSG_DATA, KERN_INFO,
508 "%s: recv short packet (len=%d)\n", tunnel->name, skb->len);
512 /* Point to L2TP header */
513 optr = ptr = skb->data;
515 /* Get L2TP header flags */
516 hdrflags = ntohs(*(__be16*)ptr);
518 /* Trace packet contents, if enabled */
519 if (tunnel->debug & PPPOL2TP_MSG_DATA) {
520 length = min(16u, skb->len);
521 if (!pskb_may_pull(skb, length))
524 printk(KERN_DEBUG "%s: recv: ", tunnel->name);
528 printk(" %02X", ptr[offset]);
529 } while (++offset < length);
534 /* Get length of L2TP packet */
537 /* If type is control packet, it is handled by userspace. */
538 if (hdrflags & L2TP_HDRFLAG_T) {
539 PRINTK(tunnel->debug, PPPOL2TP_MSG_DATA, KERN_DEBUG,
540 "%s: recv control packet, len=%d\n", tunnel->name, length);
547 /* If length is present, skip it */
548 if (hdrflags & L2TP_HDRFLAG_L)
551 /* Extract tunnel and session ID */
552 tunnel_id = ntohs(*(__be16 *) ptr);
554 session_id = ntohs(*(__be16 *) ptr);
557 /* Find the session context */
558 session = pppol2tp_session_find(tunnel, session_id);
560 /* Not found? Pass to userspace to deal with */
561 PRINTK(tunnel->debug, PPPOL2TP_MSG_DATA, KERN_INFO,
562 "%s: no socket found (%hu/%hu). Passing up.\n",
563 tunnel->name, tunnel_id, session_id);
566 sock_hold(session->sock);
568 /* The ref count on the socket was increased by the above call since
569 * we now hold a pointer to the session. Take care to do sock_put()
570 * when exiting this function from now on...
573 /* Handle the optional sequence numbers. If we are the LAC,
574 * enable/disable sequence numbers under the control of the LNS. If
575 * no sequence numbers present but we were expecting them, discard
578 if (hdrflags & L2TP_HDRFLAG_S) {
580 ns = ntohs(*(__be16 *) ptr);
582 nr = ntohs(*(__be16 *) ptr);
585 /* Received a packet with sequence numbers. If we're the LNS,
586 * check if we sre sending sequence numbers and if not,
589 if ((!session->lns_mode) && (!session->send_seq)) {
590 PRINTK(session->debug, PPPOL2TP_MSG_SEQ, KERN_INFO,
591 "%s: requested to enable seq numbers by LNS\n",
593 session->send_seq = -1;
596 /* Store L2TP info in the skb */
597 PPPOL2TP_SKB_CB(skb)->ns = ns;
598 PPPOL2TP_SKB_CB(skb)->nr = nr;
599 PPPOL2TP_SKB_CB(skb)->has_seq = 1;
601 PRINTK(session->debug, PPPOL2TP_MSG_SEQ, KERN_DEBUG,
602 "%s: recv data ns=%hu, nr=%hu, session nr=%hu\n",
603 session->name, ns, nr, session->nr);
605 /* No sequence numbers.
606 * If user has configured mandatory sequence numbers, discard.
608 if (session->recv_seq) {
609 PRINTK(session->debug, PPPOL2TP_MSG_SEQ, KERN_WARNING,
610 "%s: recv data has no seq numbers when required. "
611 "Discarding\n", session->name);
612 session->stats.rx_seq_discards++;
616 /* If we're the LAC and we're sending sequence numbers, the
617 * LNS has requested that we no longer send sequence numbers.
618 * If we're the LNS and we're sending sequence numbers, the
619 * LAC is broken. Discard the frame.
621 if ((!session->lns_mode) && (session->send_seq)) {
622 PRINTK(session->debug, PPPOL2TP_MSG_SEQ, KERN_INFO,
623 "%s: requested to disable seq numbers by LNS\n",
625 session->send_seq = 0;
626 } else if (session->send_seq) {
627 PRINTK(session->debug, PPPOL2TP_MSG_SEQ, KERN_WARNING,
628 "%s: recv data has no seq numbers when required. "
629 "Discarding\n", session->name);
630 session->stats.rx_seq_discards++;
634 /* Store L2TP info in the skb */
635 PPPOL2TP_SKB_CB(skb)->has_seq = 0;
638 /* If offset bit set, skip it. */
639 if (hdrflags & L2TP_HDRFLAG_O) {
640 offset = ntohs(*(__be16 *)ptr);
645 if (!pskb_may_pull(skb, offset))
648 __skb_pull(skb, offset);
650 /* Skip PPP header, if present. In testing, Microsoft L2TP clients
651 * don't send the PPP header (PPP header compression enabled), but
652 * other clients can include the header. So we cope with both cases
653 * here. The PPP header is always FF03 when using L2TP.
655 * Note that skb->data[] isn't dereferenced from a u16 ptr here since
656 * the field may be unaligned.
658 if (!pskb_may_pull(skb, 2))
661 if ((skb->data[0] == 0xff) && (skb->data[1] == 0x03))
664 /* Prepare skb for adding to the session's reorder_q. Hold
665 * packets for max reorder_timeout or 1 second if not
668 PPPOL2TP_SKB_CB(skb)->length = length;
669 PPPOL2TP_SKB_CB(skb)->expires = jiffies +
670 (session->reorder_timeout ? session->reorder_timeout : HZ);
672 /* Add packet to the session's receive queue. Reordering is done here, if
673 * enabled. Saved L2TP protocol info is stored in skb->sb[].
675 if (PPPOL2TP_SKB_CB(skb)->has_seq) {
676 if (session->reorder_timeout != 0) {
677 /* Packet reordering enabled. Add skb to session's
678 * reorder queue, in order of ns.
680 pppol2tp_recv_queue_skb(session, skb);
682 /* Packet reordering disabled. Discard out-of-sequence
685 if (PPPOL2TP_SKB_CB(skb)->ns != session->nr) {
686 session->stats.rx_seq_discards++;
687 PRINTK(session->debug, PPPOL2TP_MSG_SEQ, KERN_DEBUG,
688 "%s: oos pkt %hu len %d discarded, "
689 "waiting for %hu, reorder_q_len=%d\n",
690 session->name, PPPOL2TP_SKB_CB(skb)->ns,
691 PPPOL2TP_SKB_CB(skb)->length, session->nr,
692 skb_queue_len(&session->reorder_q));
695 skb_queue_tail(&session->reorder_q, skb);
698 /* No sequence numbers. Add the skb to the tail of the
699 * reorder queue. This ensures that it will be
700 * delivered after all previous sequenced skbs.
702 skb_queue_tail(&session->reorder_q, skb);
705 /* Try to dequeue as many skbs from reorder_q as we can. */
706 pppol2tp_recv_dequeue(session);
711 session->stats.rx_errors++;
713 sock_put(session->sock);
718 /* Put UDP header back */
719 __skb_push(skb, sizeof(struct udphdr));
725 /* UDP encapsulation receive handler. See net/ipv4/udp.c.
729 * >0: skb should be passed up to userspace as UDP.
731 static int pppol2tp_udp_encap_recv(struct sock *sk, struct sk_buff *skb)
733 struct pppol2tp_tunnel *tunnel;
735 tunnel = pppol2tp_sock_to_tunnel(sk);
739 PRINTK(tunnel->debug, PPPOL2TP_MSG_DATA, KERN_DEBUG,
740 "%s: received %d bytes\n", tunnel->name, skb->len);
742 if (pppol2tp_recv_core(sk, skb))
751 /* Receive message. This is the recvmsg for the PPPoL2TP socket.
753 static int pppol2tp_recvmsg(struct kiocb *iocb, struct socket *sock,
754 struct msghdr *msg, size_t len,
759 struct sock *sk = sock->sk;
762 if (sk->sk_state & PPPOX_BOUND)
765 msg->msg_namelen = 0;
768 skb = skb_recv_datagram(sk, flags & ~MSG_DONTWAIT,
769 flags & MSG_DONTWAIT, &err);
771 err = memcpy_toiovec(msg->msg_iov, (unsigned char *) skb->data,
783 /************************************************************************
785 ***********************************************************************/
787 /* Tell how big L2TP headers are for a particular session. This
788 * depends on whether sequence numbers are being used.
790 static inline int pppol2tp_l2tp_header_len(struct pppol2tp_session *session)
792 if (session->send_seq)
793 return PPPOL2TP_L2TP_HDR_SIZE_SEQ;
795 return PPPOL2TP_L2TP_HDR_SIZE_NOSEQ;
798 /* Build an L2TP header for the session into the buffer provided.
800 static void pppol2tp_build_l2tp_header(struct pppol2tp_session *session,
804 u16 flags = L2TP_HDR_VER;
806 if (session->send_seq)
807 flags |= L2TP_HDRFLAG_S;
809 /* Setup L2TP header.
810 * FIXME: Can this ever be unaligned? Is direct dereferencing of
811 * 16-bit header fields safe here for all architectures?
813 *bufp++ = htons(flags);
814 *bufp++ = htons(session->tunnel_addr.d_tunnel);
815 *bufp++ = htons(session->tunnel_addr.d_session);
816 if (session->send_seq) {
817 *bufp++ = htons(session->ns);
820 PRINTK(session->debug, PPPOL2TP_MSG_SEQ, KERN_DEBUG,
821 "%s: updated ns to %hu\n", session->name, session->ns);
825 /* This is the sendmsg for the PPPoL2TP pppol2tp_session socket. We come here
826 * when a user application does a sendmsg() on the session socket. L2TP and
827 * PPP headers must be inserted into the user's data.
829 static int pppol2tp_sendmsg(struct kiocb *iocb, struct socket *sock, struct msghdr *m,
832 static const unsigned char ppph[2] = { 0xff, 0x03 };
833 struct sock *sk = sock->sk;
834 struct inet_sock *inet;
839 struct pppol2tp_session *session;
840 struct pppol2tp_tunnel *tunnel;
845 if (sock_flag(sk, SOCK_DEAD) || !(sk->sk_state & PPPOX_CONNECTED))
848 /* Get session and tunnel contexts */
850 session = pppol2tp_sock_to_session(sk);
854 tunnel = pppol2tp_sock_to_tunnel(session->tunnel_sock);
858 /* What header length is configured for this session? */
859 hdr_len = pppol2tp_l2tp_header_len(session);
861 /* Allocate a socket buffer */
863 skb = sock_wmalloc(sk, NET_SKB_PAD + sizeof(struct iphdr) +
864 sizeof(struct udphdr) + hdr_len +
865 sizeof(ppph) + total_len,
870 /* Reserve space for headers. */
871 skb_reserve(skb, NET_SKB_PAD);
872 skb_reset_network_header(skb);
873 skb_reserve(skb, sizeof(struct iphdr));
874 skb_reset_transport_header(skb);
876 /* Build UDP header */
877 inet = inet_sk(session->tunnel_sock);
878 uh = (struct udphdr *) skb->data;
879 uh->source = inet->sport;
880 uh->dest = inet->dport;
881 uh->len = htons(hdr_len + sizeof(ppph) + total_len);
883 skb_put(skb, sizeof(struct udphdr));
885 /* Build L2TP header */
886 pppol2tp_build_l2tp_header(session, skb->data);
887 skb_put(skb, hdr_len);
890 skb->data[0] = ppph[0];
891 skb->data[1] = ppph[1];
894 /* Copy user data into skb */
895 error = memcpy_fromiovec(skb->data, m->msg_iov, total_len);
900 skb_put(skb, total_len);
902 /* Calculate UDP checksum if configured to do so */
903 if (session->tunnel_sock->sk_no_check != UDP_CSUM_NOXMIT)
904 csum = udp_csum_outgoing(sk, skb);
907 if (session->send_seq)
908 PRINTK(session->debug, PPPOL2TP_MSG_DATA, KERN_DEBUG,
909 "%s: send %Zd bytes, ns=%hu\n", session->name,
910 total_len, session->ns - 1);
912 PRINTK(session->debug, PPPOL2TP_MSG_DATA, KERN_DEBUG,
913 "%s: send %Zd bytes\n", session->name, total_len);
915 if (session->debug & PPPOL2TP_MSG_DATA) {
917 unsigned char *datap = skb->data;
919 printk(KERN_DEBUG "%s: xmit:", session->name);
920 for (i = 0; i < total_len; i++) {
921 printk(" %02X", *datap++);
930 /* Queue the packet to IP for output */
932 error = ip_queue_xmit(skb, 1);
936 tunnel->stats.tx_packets++;
937 tunnel->stats.tx_bytes += len;
938 session->stats.tx_packets++;
939 session->stats.tx_bytes += len;
941 tunnel->stats.tx_errors++;
942 session->stats.tx_errors++;
949 /* Transmit function called by generic PPP driver. Sends PPP frame
950 * over PPPoL2TP socket.
952 * This is almost the same as pppol2tp_sendmsg(), but rather than
953 * being called with a msghdr from userspace, it is called with a skb
956 * The supplied skb from ppp doesn't have enough headroom for the
957 * insertion of L2TP, UDP and IP headers so we need to allocate more
958 * headroom in the skb. This will create a cloned skb. But we must be
959 * careful in the error case because the caller will expect to free
960 * the skb it supplied, not our cloned skb. So we take care to always
961 * leave the original skb unfreed if we return an error.
963 static int pppol2tp_xmit(struct ppp_channel *chan, struct sk_buff *skb)
965 static const u8 ppph[2] = { 0xff, 0x03 };
966 struct sock *sk = (struct sock *) chan->private;
969 struct pppol2tp_session *session;
970 struct pppol2tp_tunnel *tunnel;
973 int data_len = skb->len;
974 struct inet_sock *inet;
979 if (sock_flag(sk, SOCK_DEAD) || !(sk->sk_state & PPPOX_CONNECTED))
982 /* Get session and tunnel contexts from the socket */
983 session = pppol2tp_sock_to_session(sk);
987 sk_tun = session->tunnel_sock;
990 tunnel = pppol2tp_sock_to_tunnel(sk_tun);
994 /* What header length is configured for this session? */
995 hdr_len = pppol2tp_l2tp_header_len(session);
997 /* Check that there's enough headroom in the skb to insert IP,
998 * UDP and L2TP and PPP headers. If not enough, expand it to
999 * make room. Note that a new skb (or a clone) is
1000 * allocated. If we return an error from this point on, make
1001 * sure we free the new skb but do not free the original skb
1002 * since that is done by the caller for the error case.
1004 headroom = NET_SKB_PAD + sizeof(struct iphdr) +
1005 sizeof(struct udphdr) + hdr_len + sizeof(ppph);
1006 if (skb_cow_head(skb, headroom))
1009 /* Setup PPP header */
1010 __skb_push(skb, sizeof(ppph));
1011 skb->data[0] = ppph[0];
1012 skb->data[1] = ppph[1];
1014 /* Setup L2TP header */
1015 pppol2tp_build_l2tp_header(session, __skb_push(skb, hdr_len));
1017 /* Setup UDP header */
1018 inet = inet_sk(sk_tun);
1019 __skb_push(skb, sizeof(*uh));
1020 skb_reset_transport_header(skb);
1022 uh->source = inet->sport;
1023 uh->dest = inet->dport;
1024 uh->len = htons(sizeof(struct udphdr) + hdr_len + sizeof(ppph) + data_len);
1027 /* *BROKEN* Calculate UDP checksum if configured to do so */
1028 if (sk_tun->sk_no_check != UDP_CSUM_NOXMIT)
1029 csum = udp_csum_outgoing(sk_tun, skb);
1032 if (session->send_seq)
1033 PRINTK(session->debug, PPPOL2TP_MSG_DATA, KERN_DEBUG,
1034 "%s: send %d bytes, ns=%hu\n", session->name,
1035 data_len, session->ns - 1);
1037 PRINTK(session->debug, PPPOL2TP_MSG_DATA, KERN_DEBUG,
1038 "%s: send %d bytes\n", session->name, data_len);
1040 if (session->debug & PPPOL2TP_MSG_DATA) {
1042 unsigned char *datap = skb->data;
1044 printk(KERN_DEBUG "%s: xmit:", session->name);
1045 for (i = 0; i < data_len; i++) {
1046 printk(" %02X", *datap++);
1055 memset(&(IPCB(skb)->opt), 0, sizeof(IPCB(skb)->opt));
1056 IPCB(skb)->flags &= ~(IPSKB_XFRM_TUNNEL_SIZE | IPSKB_XFRM_TRANSFORMED |
1060 /* Get routing info from the tunnel socket */
1061 dst_release(skb->dst);
1062 skb->dst = sk_dst_get(sk_tun);
1066 /* Queue the packet to IP for output */
1068 rc = ip_queue_xmit(skb, 1);
1072 tunnel->stats.tx_packets++;
1073 tunnel->stats.tx_bytes += len;
1074 session->stats.tx_packets++;
1075 session->stats.tx_bytes += len;
1077 tunnel->stats.tx_errors++;
1078 session->stats.tx_errors++;
1084 /* Free the original skb */
1089 /*****************************************************************************
1090 * Session (and tunnel control) socket create/destroy.
1091 *****************************************************************************/
1093 /* When the tunnel UDP socket is closed, all the attached sockets need to go
1096 static void pppol2tp_tunnel_closeall(struct pppol2tp_tunnel *tunnel)
1099 struct hlist_node *walk;
1100 struct hlist_node *tmp;
1101 struct pppol2tp_session *session;
1107 PRINTK(tunnel->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
1108 "%s: closing all sessions...\n", tunnel->name);
1110 write_lock(&tunnel->hlist_lock);
1111 for (hash = 0; hash < PPPOL2TP_HASH_SIZE; hash++) {
1113 hlist_for_each_safe(walk, tmp, &tunnel->session_hlist[hash]) {
1114 struct sk_buff *skb;
1116 session = hlist_entry(walk, struct pppol2tp_session, hlist);
1120 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
1121 "%s: closing session\n", session->name);
1123 hlist_del_init(&session->hlist);
1125 /* Since we should hold the sock lock while
1126 * doing any unbinding, we need to release the
1127 * lock we're holding before taking that lock.
1128 * Hold a reference to the sock so it doesn't
1129 * disappear as we're jumping between locks.
1132 write_unlock(&tunnel->hlist_lock);
1135 if (sk->sk_state & (PPPOX_CONNECTED | PPPOX_BOUND)) {
1136 pppox_unbind_sock(sk);
1137 sk->sk_state = PPPOX_DEAD;
1138 sk->sk_state_change(sk);
1141 /* Purge any queued data */
1142 skb_queue_purge(&sk->sk_receive_queue);
1143 skb_queue_purge(&sk->sk_write_queue);
1144 while ((skb = skb_dequeue(&session->reorder_q))) {
1152 /* Now restart from the beginning of this hash
1153 * chain. We always remove a session from the
1154 * list so we are guaranteed to make forward
1157 write_lock(&tunnel->hlist_lock);
1161 write_unlock(&tunnel->hlist_lock);
1164 /* Really kill the tunnel.
1165 * Come here only when all sessions have been cleared from the tunnel.
1167 static void pppol2tp_tunnel_free(struct pppol2tp_tunnel *tunnel)
1169 /* Remove from socket list */
1170 write_lock(&pppol2tp_tunnel_list_lock);
1171 list_del_init(&tunnel->list);
1172 write_unlock(&pppol2tp_tunnel_list_lock);
1174 atomic_dec(&pppol2tp_tunnel_count);
1178 /* Tunnel UDP socket destruct hook.
1179 * The tunnel context is deleted only when all session sockets have been
1182 static void pppol2tp_tunnel_destruct(struct sock *sk)
1184 struct pppol2tp_tunnel *tunnel;
1186 tunnel = pppol2tp_sock_to_tunnel(sk);
1190 PRINTK(tunnel->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
1191 "%s: closing...\n", tunnel->name);
1193 /* Close all sessions */
1194 pppol2tp_tunnel_closeall(tunnel);
1196 /* No longer an encapsulation socket. See net/ipv4/udp.c */
1197 (udp_sk(sk))->encap_type = 0;
1198 (udp_sk(sk))->encap_rcv = NULL;
1200 /* Remove hooks into tunnel socket */
1201 tunnel->sock = NULL;
1202 sk->sk_destruct = tunnel->old_sk_destruct;
1203 sk->sk_user_data = NULL;
1205 /* Call original (UDP) socket descructor */
1206 if (sk->sk_destruct != NULL)
1207 (*sk->sk_destruct)(sk);
1209 pppol2tp_tunnel_dec_refcount(tunnel);
1215 /* Really kill the session socket. (Called from sock_put() if
1218 static void pppol2tp_session_destruct(struct sock *sk)
1220 struct pppol2tp_session *session = NULL;
1222 if (sk->sk_user_data != NULL) {
1223 struct pppol2tp_tunnel *tunnel;
1225 session = pppol2tp_sock_to_session(sk);
1226 if (session == NULL)
1229 /* Don't use pppol2tp_sock_to_tunnel() here to
1230 * get the tunnel context because the tunnel
1231 * socket might have already been closed (its
1232 * sk->sk_user_data will be NULL) so use the
1233 * session's private tunnel ptr instead.
1235 tunnel = session->tunnel;
1236 if (tunnel != NULL) {
1237 BUG_ON(tunnel->magic != L2TP_TUNNEL_MAGIC);
1239 /* If session_id is zero, this is a null
1240 * session context, which was created for a
1241 * socket that is being used only to manage
1244 if (session->tunnel_addr.s_session != 0) {
1245 /* Delete the session socket from the
1248 write_lock(&tunnel->hlist_lock);
1249 hlist_del_init(&session->hlist);
1250 write_unlock(&tunnel->hlist_lock);
1252 atomic_dec(&pppol2tp_session_count);
1255 /* This will delete the tunnel context if this
1256 * is the last session on the tunnel.
1258 session->tunnel = NULL;
1259 session->tunnel_sock = NULL;
1260 pppol2tp_tunnel_dec_refcount(tunnel);
1269 /* Called when the PPPoX socket (session) is closed.
1271 static int pppol2tp_release(struct socket *sock)
1273 struct sock *sk = sock->sk;
1281 if (sock_flag(sk, SOCK_DEAD) != 0)
1284 pppox_unbind_sock(sk);
1286 /* Signal the death of the socket. */
1287 sk->sk_state = PPPOX_DEAD;
1291 /* Purge any queued data */
1292 skb_queue_purge(&sk->sk_receive_queue);
1293 skb_queue_purge(&sk->sk_write_queue);
1297 /* This will delete the session context via
1298 * pppol2tp_session_destruct() if the socket's refcnt drops to
1310 /* Internal function to prepare a tunnel (UDP) socket to have PPPoX
1311 * sockets attached to it.
1313 static struct sock *pppol2tp_prepare_tunnel_socket(int fd, u16 tunnel_id,
1317 struct socket *sock = NULL;
1319 struct pppol2tp_tunnel *tunnel;
1320 struct sock *ret = NULL;
1322 /* Get the tunnel UDP socket from the fd, which was opened by
1323 * the userspace L2TP daemon.
1326 sock = sockfd_lookup(fd, &err);
1328 PRINTK(-1, PPPOL2TP_MSG_CONTROL, KERN_ERR,
1329 "tunl %hu: sockfd_lookup(fd=%d) returned %d\n",
1330 tunnel_id, fd, err);
1336 /* Quick sanity checks */
1337 err = -EPROTONOSUPPORT;
1338 if (sk->sk_protocol != IPPROTO_UDP) {
1339 PRINTK(-1, PPPOL2TP_MSG_CONTROL, KERN_ERR,
1340 "tunl %hu: fd %d wrong protocol, got %d, expected %d\n",
1341 tunnel_id, fd, sk->sk_protocol, IPPROTO_UDP);
1344 err = -EAFNOSUPPORT;
1345 if (sock->ops->family != AF_INET) {
1346 PRINTK(-1, PPPOL2TP_MSG_CONTROL, KERN_ERR,
1347 "tunl %hu: fd %d wrong family, got %d, expected %d\n",
1348 tunnel_id, fd, sock->ops->family, AF_INET);
1354 /* Check if this socket has already been prepped */
1355 tunnel = (struct pppol2tp_tunnel *)sk->sk_user_data;
1356 if (tunnel != NULL) {
1357 /* User-data field already set */
1359 BUG_ON(tunnel->magic != L2TP_TUNNEL_MAGIC);
1361 /* This socket has already been prepped */
1366 /* This socket is available and needs prepping. Create a new tunnel
1367 * context and init it.
1369 sk->sk_user_data = tunnel = kzalloc(sizeof(struct pppol2tp_tunnel), GFP_KERNEL);
1370 if (sk->sk_user_data == NULL) {
1375 tunnel->magic = L2TP_TUNNEL_MAGIC;
1376 sprintf(&tunnel->name[0], "tunl %hu", tunnel_id);
1378 tunnel->stats.tunnel_id = tunnel_id;
1379 tunnel->debug = PPPOL2TP_DEFAULT_DEBUG_FLAGS;
1381 /* Hook on the tunnel socket destructor so that we can cleanup
1382 * if the tunnel socket goes away.
1384 tunnel->old_sk_destruct = sk->sk_destruct;
1385 sk->sk_destruct = &pppol2tp_tunnel_destruct;
1388 sk->sk_allocation = GFP_ATOMIC;
1391 rwlock_init(&tunnel->hlist_lock);
1393 /* Add tunnel to our list */
1394 INIT_LIST_HEAD(&tunnel->list);
1395 write_lock(&pppol2tp_tunnel_list_lock);
1396 list_add(&tunnel->list, &pppol2tp_tunnel_list);
1397 write_unlock(&pppol2tp_tunnel_list_lock);
1398 atomic_inc(&pppol2tp_tunnel_count);
1400 /* Bump the reference count. The tunnel context is deleted
1401 * only when this drops to zero.
1403 pppol2tp_tunnel_inc_refcount(tunnel);
1405 /* Mark socket as an encapsulation socket. See net/ipv4/udp.c */
1406 (udp_sk(sk))->encap_type = UDP_ENCAP_L2TPINUDP;
1407 (udp_sk(sk))->encap_rcv = pppol2tp_udp_encap_recv;
1423 static struct proto pppol2tp_sk_proto = {
1425 .owner = THIS_MODULE,
1426 .obj_size = sizeof(struct pppox_sock),
1429 /* socket() handler. Initialize a new struct sock.
1431 static int pppol2tp_create(struct net *net, struct socket *sock)
1433 int error = -ENOMEM;
1436 sk = sk_alloc(net, PF_PPPOX, GFP_KERNEL, &pppol2tp_sk_proto);
1440 sock_init_data(sock, sk);
1442 sock->state = SS_UNCONNECTED;
1443 sock->ops = &pppol2tp_ops;
1445 sk->sk_backlog_rcv = pppol2tp_recv_core;
1446 sk->sk_protocol = PX_PROTO_OL2TP;
1447 sk->sk_family = PF_PPPOX;
1448 sk->sk_state = PPPOX_NONE;
1449 sk->sk_type = SOCK_STREAM;
1450 sk->sk_destruct = pppol2tp_session_destruct;
1458 /* connect() handler. Attach a PPPoX socket to a tunnel UDP socket
1460 static int pppol2tp_connect(struct socket *sock, struct sockaddr *uservaddr,
1461 int sockaddr_len, int flags)
1463 struct sock *sk = sock->sk;
1464 struct sockaddr_pppol2tp *sp = (struct sockaddr_pppol2tp *) uservaddr;
1465 struct pppox_sock *po = pppox_sk(sk);
1466 struct sock *tunnel_sock = NULL;
1467 struct pppol2tp_session *session = NULL;
1468 struct pppol2tp_tunnel *tunnel;
1469 struct dst_entry *dst;
1475 if (sp->sa_protocol != PX_PROTO_OL2TP)
1478 /* Check for already bound sockets */
1480 if (sk->sk_state & PPPOX_CONNECTED)
1483 /* We don't supporting rebinding anyway */
1485 if (sk->sk_user_data)
1486 goto end; /* socket is already attached */
1488 /* Don't bind if s_tunnel is 0 */
1490 if (sp->pppol2tp.s_tunnel == 0)
1493 /* Special case: prepare tunnel socket if s_session and
1494 * d_session is 0. Otherwise look up tunnel using supplied
1497 if ((sp->pppol2tp.s_session == 0) && (sp->pppol2tp.d_session == 0)) {
1498 tunnel_sock = pppol2tp_prepare_tunnel_socket(sp->pppol2tp.fd,
1499 sp->pppol2tp.s_tunnel,
1501 if (tunnel_sock == NULL)
1504 tunnel = tunnel_sock->sk_user_data;
1506 tunnel = pppol2tp_tunnel_find(sp->pppol2tp.s_tunnel);
1508 /* Error if we can't find the tunnel */
1513 tunnel_sock = tunnel->sock;
1516 /* Check that this session doesn't already exist */
1518 session = pppol2tp_session_find(tunnel, sp->pppol2tp.s_session);
1519 if (session != NULL)
1522 /* Allocate and initialize a new session context. */
1523 session = kzalloc(sizeof(struct pppol2tp_session), GFP_KERNEL);
1524 if (session == NULL) {
1529 skb_queue_head_init(&session->reorder_q);
1531 session->magic = L2TP_SESSION_MAGIC;
1532 session->owner = current->pid;
1534 session->tunnel = tunnel;
1535 session->tunnel_sock = tunnel_sock;
1536 session->tunnel_addr = sp->pppol2tp;
1537 sprintf(&session->name[0], "sess %hu/%hu",
1538 session->tunnel_addr.s_tunnel,
1539 session->tunnel_addr.s_session);
1541 session->stats.tunnel_id = session->tunnel_addr.s_tunnel;
1542 session->stats.session_id = session->tunnel_addr.s_session;
1544 INIT_HLIST_NODE(&session->hlist);
1546 /* Inherit debug options from tunnel */
1547 session->debug = tunnel->debug;
1549 /* Default MTU must allow space for UDP/L2TP/PPP
1552 session->mtu = session->mru = 1500 - PPPOL2TP_HEADER_OVERHEAD;
1554 /* If PMTU discovery was enabled, use the MTU that was discovered */
1555 dst = sk_dst_get(sk);
1557 u32 pmtu = dst_mtu(__sk_dst_get(sk));
1559 session->mtu = session->mru = pmtu -
1560 PPPOL2TP_HEADER_OVERHEAD;
1564 /* Special case: if source & dest session_id == 0x0000, this socket is
1565 * being created to manage the tunnel. Don't add the session to the
1566 * session hash list, just set up the internal context for use by
1567 * ioctl() and sockopt() handlers.
1569 if ((session->tunnel_addr.s_session == 0) &&
1570 (session->tunnel_addr.d_session == 0)) {
1572 sk->sk_user_data = session;
1576 /* Get tunnel context from the tunnel socket */
1577 tunnel = pppol2tp_sock_to_tunnel(tunnel_sock);
1578 if (tunnel == NULL) {
1583 /* Right now, because we don't have a way to push the incoming skb's
1584 * straight through the UDP layer, the only header we need to worry
1585 * about is the L2TP header. This size is different depending on
1586 * whether sequence numbers are enabled for the data channel.
1588 po->chan.hdrlen = PPPOL2TP_L2TP_HDR_SIZE_NOSEQ;
1590 po->chan.private = sk;
1591 po->chan.ops = &pppol2tp_chan_ops;
1592 po->chan.mtu = session->mtu;
1594 error = ppp_register_channel(&po->chan);
1598 /* This is how we get the session context from the socket. */
1599 sk->sk_user_data = session;
1601 /* Add session to the tunnel's hash list */
1602 write_lock(&tunnel->hlist_lock);
1603 hlist_add_head(&session->hlist,
1604 pppol2tp_session_id_hash(tunnel,
1605 session->tunnel_addr.s_session));
1606 write_unlock(&tunnel->hlist_lock);
1608 atomic_inc(&pppol2tp_session_count);
1611 pppol2tp_tunnel_inc_refcount(tunnel);
1612 sk->sk_state = PPPOX_CONNECTED;
1613 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
1614 "%s: created\n", session->name);
1620 PRINTK(session ? session->debug : -1, PPPOL2TP_MSG_CONTROL, KERN_WARNING,
1621 "%s: connect failed: %d\n", session->name, error);
1626 /* getname() support.
1628 static int pppol2tp_getname(struct socket *sock, struct sockaddr *uaddr,
1629 int *usockaddr_len, int peer)
1631 int len = sizeof(struct sockaddr_pppol2tp);
1632 struct sockaddr_pppol2tp sp;
1634 struct pppol2tp_session *session;
1637 if (sock->sk->sk_state != PPPOX_CONNECTED)
1640 session = pppol2tp_sock_to_session(sock->sk);
1641 if (session == NULL) {
1646 sp.sa_family = AF_PPPOX;
1647 sp.sa_protocol = PX_PROTO_OL2TP;
1648 memcpy(&sp.pppol2tp, &session->tunnel_addr,
1649 sizeof(struct pppol2tp_addr));
1651 memcpy(uaddr, &sp, len);
1653 *usockaddr_len = len;
1661 /****************************************************************************
1664 * The PPPoX socket is created for L2TP sessions: tunnels have their own UDP
1665 * sockets. However, in order to control kernel tunnel features, we allow
1666 * userspace to create a special "tunnel" PPPoX socket which is used for
1667 * control only. Tunnel PPPoX sockets have session_id == 0 and simply allow
1668 * the user application to issue L2TP setsockopt(), getsockopt() and ioctl()
1670 ****************************************************************************/
1672 /* Session ioctl helper.
1674 static int pppol2tp_session_ioctl(struct pppol2tp_session *session,
1675 unsigned int cmd, unsigned long arg)
1679 struct sock *sk = session->sock;
1680 int val = (int) arg;
1682 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_DEBUG,
1683 "%s: pppol2tp_session_ioctl(cmd=%#x, arg=%#lx)\n",
1684 session->name, cmd, arg);
1691 if (!(sk->sk_state & PPPOX_CONNECTED))
1695 if (copy_from_user(&ifr, (void __user *) arg, sizeof(struct ifreq)))
1697 ifr.ifr_mtu = session->mtu;
1698 if (copy_to_user((void __user *) arg, &ifr, sizeof(struct ifreq)))
1701 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
1702 "%s: get mtu=%d\n", session->name, session->mtu);
1708 if (!(sk->sk_state & PPPOX_CONNECTED))
1712 if (copy_from_user(&ifr, (void __user *) arg, sizeof(struct ifreq)))
1715 session->mtu = ifr.ifr_mtu;
1717 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
1718 "%s: set mtu=%d\n", session->name, session->mtu);
1724 if (!(sk->sk_state & PPPOX_CONNECTED))
1728 if (put_user(session->mru, (int __user *) arg))
1731 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
1732 "%s: get mru=%d\n", session->name, session->mru);
1738 if (!(sk->sk_state & PPPOX_CONNECTED))
1742 if (get_user(val,(int __user *) arg))
1746 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
1747 "%s: set mru=%d\n", session->name, session->mru);
1753 if (put_user(session->flags, (int __user *) arg))
1756 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
1757 "%s: get flags=%d\n", session->name, session->flags);
1763 if (get_user(val, (int __user *) arg))
1765 session->flags = val;
1766 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
1767 "%s: set flags=%d\n", session->name, session->flags);
1771 case PPPIOCGL2TPSTATS:
1773 if (!(sk->sk_state & PPPOX_CONNECTED))
1776 if (copy_to_user((void __user *) arg, &session->stats,
1777 sizeof(session->stats)))
1779 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
1780 "%s: get L2TP stats\n", session->name);
1794 /* Tunnel ioctl helper.
1796 * Note the special handling for PPPIOCGL2TPSTATS below. If the ioctl data
1797 * specifies a session_id, the session ioctl handler is called. This allows an
1798 * application to retrieve session stats via a tunnel socket.
1800 static int pppol2tp_tunnel_ioctl(struct pppol2tp_tunnel *tunnel,
1801 unsigned int cmd, unsigned long arg)
1804 struct sock *sk = tunnel->sock;
1805 struct pppol2tp_ioc_stats stats_req;
1807 PRINTK(tunnel->debug, PPPOL2TP_MSG_CONTROL, KERN_DEBUG,
1808 "%s: pppol2tp_tunnel_ioctl(cmd=%#x, arg=%#lx)\n", tunnel->name,
1814 case PPPIOCGL2TPSTATS:
1816 if (!(sk->sk_state & PPPOX_CONNECTED))
1819 if (copy_from_user(&stats_req, (void __user *) arg,
1820 sizeof(stats_req))) {
1824 if (stats_req.session_id != 0) {
1825 /* resend to session ioctl handler */
1826 struct pppol2tp_session *session =
1827 pppol2tp_session_find(tunnel, stats_req.session_id);
1828 if (session != NULL)
1829 err = pppol2tp_session_ioctl(session, cmd, arg);
1835 tunnel->stats.using_ipsec = (sk->sk_policy[0] || sk->sk_policy[1]) ? 1 : 0;
1837 if (copy_to_user((void __user *) arg, &tunnel->stats,
1838 sizeof(tunnel->stats))) {
1842 PRINTK(tunnel->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
1843 "%s: get L2TP stats\n", tunnel->name);
1857 /* Main ioctl() handler.
1858 * Dispatch to tunnel or session helpers depending on the socket.
1860 static int pppol2tp_ioctl(struct socket *sock, unsigned int cmd,
1863 struct sock *sk = sock->sk;
1864 struct pppol2tp_session *session;
1865 struct pppol2tp_tunnel *tunnel;
1872 if (sock_flag(sk, SOCK_DEAD) != 0)
1876 if ((sk->sk_user_data == NULL) ||
1877 (!(sk->sk_state & (PPPOX_CONNECTED | PPPOX_BOUND))))
1880 /* Get session context from the socket */
1882 session = pppol2tp_sock_to_session(sk);
1883 if (session == NULL)
1886 /* Special case: if session's session_id is zero, treat ioctl as a
1889 if ((session->tunnel_addr.s_session == 0) &&
1890 (session->tunnel_addr.d_session == 0)) {
1892 tunnel = pppol2tp_sock_to_tunnel(session->tunnel_sock);
1896 err = pppol2tp_tunnel_ioctl(tunnel, cmd, arg);
1900 err = pppol2tp_session_ioctl(session, cmd, arg);
1906 /*****************************************************************************
1907 * setsockopt() / getsockopt() support.
1909 * The PPPoX socket is created for L2TP sessions: tunnels have their own UDP
1910 * sockets. In order to control kernel tunnel features, we allow userspace to
1911 * create a special "tunnel" PPPoX socket which is used for control only.
1912 * Tunnel PPPoX sockets have session_id == 0 and simply allow the user
1913 * application to issue L2TP setsockopt(), getsockopt() and ioctl() calls.
1914 *****************************************************************************/
1916 /* Tunnel setsockopt() helper.
1918 static int pppol2tp_tunnel_setsockopt(struct sock *sk,
1919 struct pppol2tp_tunnel *tunnel,
1920 int optname, int val)
1925 case PPPOL2TP_SO_DEBUG:
1926 tunnel->debug = val;
1927 PRINTK(tunnel->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
1928 "%s: set debug=%x\n", tunnel->name, tunnel->debug);
1939 /* Session setsockopt helper.
1941 static int pppol2tp_session_setsockopt(struct sock *sk,
1942 struct pppol2tp_session *session,
1943 int optname, int val)
1948 case PPPOL2TP_SO_RECVSEQ:
1949 if ((val != 0) && (val != 1)) {
1953 session->recv_seq = val ? -1 : 0;
1954 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
1955 "%s: set recv_seq=%d\n", session->name,
1959 case PPPOL2TP_SO_SENDSEQ:
1960 if ((val != 0) && (val != 1)) {
1964 session->send_seq = val ? -1 : 0;
1966 struct sock *ssk = session->sock;
1967 struct pppox_sock *po = pppox_sk(ssk);
1968 po->chan.hdrlen = val ? PPPOL2TP_L2TP_HDR_SIZE_SEQ :
1969 PPPOL2TP_L2TP_HDR_SIZE_NOSEQ;
1971 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
1972 "%s: set send_seq=%d\n", session->name, session->send_seq);
1975 case PPPOL2TP_SO_LNSMODE:
1976 if ((val != 0) && (val != 1)) {
1980 session->lns_mode = val ? -1 : 0;
1981 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
1982 "%s: set lns_mode=%d\n", session->name,
1986 case PPPOL2TP_SO_DEBUG:
1987 session->debug = val;
1988 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
1989 "%s: set debug=%x\n", session->name, session->debug);
1992 case PPPOL2TP_SO_REORDERTO:
1993 session->reorder_timeout = msecs_to_jiffies(val);
1994 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
1995 "%s: set reorder_timeout=%d\n", session->name,
1996 session->reorder_timeout);
2007 /* Main setsockopt() entry point.
2008 * Does API checks, then calls either the tunnel or session setsockopt
2009 * handler, according to whether the PPPoL2TP socket is a for a regular
2010 * session or the special tunnel type.
2012 static int pppol2tp_setsockopt(struct socket *sock, int level, int optname,
2013 char __user *optval, int optlen)
2015 struct sock *sk = sock->sk;
2016 struct pppol2tp_session *session = sk->sk_user_data;
2017 struct pppol2tp_tunnel *tunnel;
2021 if (level != SOL_PPPOL2TP)
2022 return udp_prot.setsockopt(sk, level, optname, optval, optlen);
2024 if (optlen < sizeof(int))
2027 if (get_user(val, (int __user *)optval))
2031 if (sk->sk_user_data == NULL)
2034 /* Get session context from the socket */
2036 session = pppol2tp_sock_to_session(sk);
2037 if (session == NULL)
2040 /* Special case: if session_id == 0x0000, treat as operation on tunnel
2042 if ((session->tunnel_addr.s_session == 0) &&
2043 (session->tunnel_addr.d_session == 0)) {
2045 tunnel = pppol2tp_sock_to_tunnel(session->tunnel_sock);
2049 err = pppol2tp_tunnel_setsockopt(sk, tunnel, optname, val);
2051 err = pppol2tp_session_setsockopt(sk, session, optname, val);
2059 /* Tunnel getsockopt helper. Called with sock locked.
2061 static int pppol2tp_tunnel_getsockopt(struct sock *sk,
2062 struct pppol2tp_tunnel *tunnel,
2063 int optname, int *val)
2068 case PPPOL2TP_SO_DEBUG:
2069 *val = tunnel->debug;
2070 PRINTK(tunnel->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
2071 "%s: get debug=%x\n", tunnel->name, tunnel->debug);
2082 /* Session getsockopt helper. Called with sock locked.
2084 static int pppol2tp_session_getsockopt(struct sock *sk,
2085 struct pppol2tp_session *session,
2086 int optname, int *val)
2091 case PPPOL2TP_SO_RECVSEQ:
2092 *val = session->recv_seq;
2093 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
2094 "%s: get recv_seq=%d\n", session->name, *val);
2097 case PPPOL2TP_SO_SENDSEQ:
2098 *val = session->send_seq;
2099 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
2100 "%s: get send_seq=%d\n", session->name, *val);
2103 case PPPOL2TP_SO_LNSMODE:
2104 *val = session->lns_mode;
2105 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
2106 "%s: get lns_mode=%d\n", session->name, *val);
2109 case PPPOL2TP_SO_DEBUG:
2110 *val = session->debug;
2111 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
2112 "%s: get debug=%d\n", session->name, *val);
2115 case PPPOL2TP_SO_REORDERTO:
2116 *val = (int) jiffies_to_msecs(session->reorder_timeout);
2117 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
2118 "%s: get reorder_timeout=%d\n", session->name, *val);
2128 /* Main getsockopt() entry point.
2129 * Does API checks, then calls either the tunnel or session getsockopt
2130 * handler, according to whether the PPPoX socket is a for a regular session
2131 * or the special tunnel type.
2133 static int pppol2tp_getsockopt(struct socket *sock, int level,
2134 int optname, char __user *optval, int __user *optlen)
2136 struct sock *sk = sock->sk;
2137 struct pppol2tp_session *session = sk->sk_user_data;
2138 struct pppol2tp_tunnel *tunnel;
2142 if (level != SOL_PPPOL2TP)
2143 return udp_prot.getsockopt(sk, level, optname, optval, optlen);
2145 if (get_user(len, (int __user *) optlen))
2148 len = min_t(unsigned int, len, sizeof(int));
2154 if (sk->sk_user_data == NULL)
2157 /* Get the session context */
2159 session = pppol2tp_sock_to_session(sk);
2160 if (session == NULL)
2163 /* Special case: if session_id == 0x0000, treat as operation on tunnel */
2164 if ((session->tunnel_addr.s_session == 0) &&
2165 (session->tunnel_addr.d_session == 0)) {
2167 tunnel = pppol2tp_sock_to_tunnel(session->tunnel_sock);
2171 err = pppol2tp_tunnel_getsockopt(sk, tunnel, optname, &val);
2173 err = pppol2tp_session_getsockopt(sk, session, optname, &val);
2176 if (put_user(len, (int __user *) optlen))
2179 if (copy_to_user((void __user *) optval, &val, len))
2187 /*****************************************************************************
2188 * /proc filesystem for debug
2189 *****************************************************************************/
2191 #ifdef CONFIG_PROC_FS
2193 #include <linux/seq_file.h>
2195 struct pppol2tp_seq_data {
2196 struct pppol2tp_tunnel *tunnel; /* current tunnel */
2197 struct pppol2tp_session *session; /* NULL means get first session in tunnel */
2200 static struct pppol2tp_session *next_session(struct pppol2tp_tunnel *tunnel, struct pppol2tp_session *curr)
2202 struct pppol2tp_session *session = NULL;
2203 struct hlist_node *walk;
2208 read_lock(&tunnel->hlist_lock);
2209 for (i = 0; i < PPPOL2TP_HASH_SIZE; i++) {
2210 hlist_for_each_entry(session, walk, &tunnel->session_hlist[i], hlist) {
2215 if (session == curr) {
2226 read_unlock(&tunnel->hlist_lock);
2233 static struct pppol2tp_tunnel *next_tunnel(struct pppol2tp_tunnel *curr)
2235 struct pppol2tp_tunnel *tunnel = NULL;
2237 read_lock(&pppol2tp_tunnel_list_lock);
2238 if (list_is_last(&curr->list, &pppol2tp_tunnel_list)) {
2241 tunnel = list_entry(curr->list.next, struct pppol2tp_tunnel, list);
2243 read_unlock(&pppol2tp_tunnel_list_lock);
2248 static void *pppol2tp_seq_start(struct seq_file *m, loff_t *offs)
2250 struct pppol2tp_seq_data *pd = SEQ_START_TOKEN;
2256 BUG_ON(m->private == NULL);
2259 if (pd->tunnel == NULL) {
2260 if (!list_empty(&pppol2tp_tunnel_list))
2261 pd->tunnel = list_entry(pppol2tp_tunnel_list.next, struct pppol2tp_tunnel, list);
2263 pd->session = next_session(pd->tunnel, pd->session);
2264 if (pd->session == NULL) {
2265 pd->tunnel = next_tunnel(pd->tunnel);
2269 /* NULL tunnel and session indicates end of list */
2270 if ((pd->tunnel == NULL) && (pd->session == NULL))
2277 static void *pppol2tp_seq_next(struct seq_file *m, void *v, loff_t *pos)
2283 static void pppol2tp_seq_stop(struct seq_file *p, void *v)
2288 static void pppol2tp_seq_tunnel_show(struct seq_file *m, void *v)
2290 struct pppol2tp_tunnel *tunnel = v;
2292 seq_printf(m, "\nTUNNEL '%s', %c %d\n",
2294 (tunnel == tunnel->sock->sk_user_data) ? 'Y':'N',
2295 atomic_read(&tunnel->ref_count) - 1);
2296 seq_printf(m, " %08x %llu/%llu/%llu %llu/%llu/%llu\n",
2298 (unsigned long long)tunnel->stats.tx_packets,
2299 (unsigned long long)tunnel->stats.tx_bytes,
2300 (unsigned long long)tunnel->stats.tx_errors,
2301 (unsigned long long)tunnel->stats.rx_packets,
2302 (unsigned long long)tunnel->stats.rx_bytes,
2303 (unsigned long long)tunnel->stats.rx_errors);
2306 static void pppol2tp_seq_session_show(struct seq_file *m, void *v)
2308 struct pppol2tp_session *session = v;
2310 seq_printf(m, " SESSION '%s' %08X/%d %04X/%04X -> "
2311 "%04X/%04X %d %c\n",
2313 ntohl(session->tunnel_addr.addr.sin_addr.s_addr),
2314 ntohs(session->tunnel_addr.addr.sin_port),
2315 session->tunnel_addr.s_tunnel,
2316 session->tunnel_addr.s_session,
2317 session->tunnel_addr.d_tunnel,
2318 session->tunnel_addr.d_session,
2319 session->sock->sk_state,
2320 (session == session->sock->sk_user_data) ?
2322 seq_printf(m, " %d/%d/%c/%c/%s %08x %u\n",
2323 session->mtu, session->mru,
2324 session->recv_seq ? 'R' : '-',
2325 session->send_seq ? 'S' : '-',
2326 session->lns_mode ? "LNS" : "LAC",
2328 jiffies_to_msecs(session->reorder_timeout));
2329 seq_printf(m, " %hu/%hu %llu/%llu/%llu %llu/%llu/%llu\n",
2330 session->nr, session->ns,
2331 (unsigned long long)session->stats.tx_packets,
2332 (unsigned long long)session->stats.tx_bytes,
2333 (unsigned long long)session->stats.tx_errors,
2334 (unsigned long long)session->stats.rx_packets,
2335 (unsigned long long)session->stats.rx_bytes,
2336 (unsigned long long)session->stats.rx_errors);
2339 static int pppol2tp_seq_show(struct seq_file *m, void *v)
2341 struct pppol2tp_seq_data *pd = v;
2343 /* display header on line 1 */
2344 if (v == SEQ_START_TOKEN) {
2345 seq_puts(m, "PPPoL2TP driver info, " PPPOL2TP_DRV_VERSION "\n");
2346 seq_puts(m, "TUNNEL name, user-data-ok session-count\n");
2347 seq_puts(m, " debug tx-pkts/bytes/errs rx-pkts/bytes/errs\n");
2348 seq_puts(m, " SESSION name, addr/port src-tid/sid "
2349 "dest-tid/sid state user-data-ok\n");
2350 seq_puts(m, " mtu/mru/rcvseq/sendseq/lns debug reorderto\n");
2351 seq_puts(m, " nr/ns tx-pkts/bytes/errs rx-pkts/bytes/errs\n");
2355 /* Show the tunnel or session context.
2357 if (pd->session == NULL)
2358 pppol2tp_seq_tunnel_show(m, pd->tunnel);
2360 pppol2tp_seq_session_show(m, pd->session);
2366 static struct seq_operations pppol2tp_seq_ops = {
2367 .start = pppol2tp_seq_start,
2368 .next = pppol2tp_seq_next,
2369 .stop = pppol2tp_seq_stop,
2370 .show = pppol2tp_seq_show,
2373 /* Called when our /proc file is opened. We allocate data for use when
2374 * iterating our tunnel / session contexts and store it in the private
2375 * data of the seq_file.
2377 static int pppol2tp_proc_open(struct inode *inode, struct file *file)
2380 struct pppol2tp_seq_data *pd;
2383 ret = seq_open(file, &pppol2tp_seq_ops);
2387 m = file->private_data;
2389 /* Allocate and fill our proc_data for access later */
2391 m->private = kzalloc(sizeof(struct pppol2tp_seq_data), GFP_KERNEL);
2392 if (m->private == NULL)
2402 /* Called when /proc file access completes.
2404 static int pppol2tp_proc_release(struct inode *inode, struct file *file)
2406 struct seq_file *m = (struct seq_file *)file->private_data;
2411 return seq_release(inode, file);
2414 static struct file_operations pppol2tp_proc_fops = {
2415 .owner = THIS_MODULE,
2416 .open = pppol2tp_proc_open,
2418 .llseek = seq_lseek,
2419 .release = pppol2tp_proc_release,
2422 static struct proc_dir_entry *pppol2tp_proc;
2424 #endif /* CONFIG_PROC_FS */
2426 /*****************************************************************************
2428 *****************************************************************************/
2430 static struct proto_ops pppol2tp_ops = {
2432 .owner = THIS_MODULE,
2433 .release = pppol2tp_release,
2434 .bind = sock_no_bind,
2435 .connect = pppol2tp_connect,
2436 .socketpair = sock_no_socketpair,
2437 .accept = sock_no_accept,
2438 .getname = pppol2tp_getname,
2439 .poll = datagram_poll,
2440 .listen = sock_no_listen,
2441 .shutdown = sock_no_shutdown,
2442 .setsockopt = pppol2tp_setsockopt,
2443 .getsockopt = pppol2tp_getsockopt,
2444 .sendmsg = pppol2tp_sendmsg,
2445 .recvmsg = pppol2tp_recvmsg,
2446 .mmap = sock_no_mmap,
2447 .ioctl = pppox_ioctl,
2450 static struct pppox_proto pppol2tp_proto = {
2451 .create = pppol2tp_create,
2452 .ioctl = pppol2tp_ioctl
2455 static int __init pppol2tp_init(void)
2459 err = proto_register(&pppol2tp_sk_proto, 0);
2462 err = register_pppox_proto(PX_PROTO_OL2TP, &pppol2tp_proto);
2464 goto out_unregister_pppol2tp_proto;
2466 #ifdef CONFIG_PROC_FS
2467 pppol2tp_proc = create_proc_entry("pppol2tp", 0, init_net.proc_net);
2468 if (!pppol2tp_proc) {
2470 goto out_unregister_pppox_proto;
2472 pppol2tp_proc->proc_fops = &pppol2tp_proc_fops;
2473 #endif /* CONFIG_PROC_FS */
2474 printk(KERN_INFO "PPPoL2TP kernel driver, %s\n",
2475 PPPOL2TP_DRV_VERSION);
2479 #ifdef CONFIG_PROC_FS
2480 out_unregister_pppox_proto:
2481 unregister_pppox_proto(PX_PROTO_OL2TP);
2483 out_unregister_pppol2tp_proto:
2484 proto_unregister(&pppol2tp_sk_proto);
2488 static void __exit pppol2tp_exit(void)
2490 unregister_pppox_proto(PX_PROTO_OL2TP);
2492 #ifdef CONFIG_PROC_FS
2493 remove_proc_entry("pppol2tp", init_net.proc_net);
2495 proto_unregister(&pppol2tp_sk_proto);
2498 module_init(pppol2tp_init);
2499 module_exit(pppol2tp_exit);
2501 MODULE_AUTHOR("Martijn van Oosterhout <kleptog@svana.org>, "
2502 "James Chapman <jchapman@katalix.com>");
2503 MODULE_DESCRIPTION("PPP over L2TP over UDP");
2504 MODULE_LICENSE("GPL");
2505 MODULE_VERSION(PPPOL2TP_DRV_VERSION);