drivers/net/pppol2tp.c

   1 /*****************************************************************************
   2  * Linux PPP over L2TP (PPPoX/PPPoL2TP) Sockets
   3  *
   4  * PPPoX    --- Generic PPP encapsulation socket family
   5  * PPPoL2TP --- PPP over L2TP (RFC 2661)
   6  *
   7  * Version:     1.0.0
   8  *
   9  * Authors:     Martijn van Oosterhout <kleptog@svana.org>
  10  *              James Chapman (jchapman@katalix.com)
  11  * Contributors:
  12  *              Michal Ostrowski <mostrows@speakeasy.net>
  13  *              Arnaldo Carvalho de Melo <acme@xconectiva.com.br>
  14  *              David S. Miller (davem@redhat.com)
  15  *
  16  * License:
  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.
  21  *
  22  */
  23
  24 /* This driver handles only L2TP data frames; control frames are handled by a
  25  * userspace application.
  26  *
  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.
  32  *
  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.
  35  *
  36  * Here's example userspace code to create a socket for sending/receiving data
  37  * over an L2TP session:-
  38  *
  39  *      struct sockaddr_pppol2tp sax;
  40  *      int fd;
  41  *      int session_fd;
  42  *
  43  *      fd = socket(AF_PPPOX, SOCK_DGRAM, PX_PROTO_OL2TP);
  44  *
  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;
  55  *
  56  *      session_fd = connect(fd, (struct sockaddr *)&sax, sizeof(sax));
  57  *
  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.
  61  */
  62
  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>
  68
  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>
  76
  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>
  82 #include <linux/ip.h>
  83 #include <linux/udp.h>
  84 #include <linux/if_pppox.h>
  85 #include <linux/if_pppol2tp.h>
  86 #include <net/sock.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/dst.h>
  95 #include <net/ip.h>
  96 #include <net/udp.h>
  97 #include <net/xfrm.h>
  98
  99 #include <asm/byteorder.h>
 100 #include <asm/atomic.h>
 101
 102
 103 #define PPPOL2TP_DRV_VERSION    "V1.0"
 104
 105 /* L2TP header constants */
 106 #define L2TP_HDRFLAG_T     0x8000
 107 #define L2TP_HDRFLAG_L     0x4000
 108 #define L2TP_HDRFLAG_S     0x0800
 109 #define L2TP_HDRFLAG_O     0x0200
 110 #define L2TP_HDRFLAG_P     0x0100
 111
 112 #define L2TP_HDR_VER_MASK  0x000F
 113 #define L2TP_HDR_VER       0x0002
 114
 115 /* Space for UDP, L2TP and PPP headers */
 116 #define PPPOL2TP_HEADER_OVERHEAD        40
 117
 118 /* Just some random numbers */
 119 #define L2TP_TUNNEL_MAGIC       0x42114DDA
 120 #define L2TP_SESSION_MAGIC      0x0C04EB7D
 121
 122 #define PPPOL2TP_HASH_BITS      4
 123 #define PPPOL2TP_HASH_SIZE      (1 << PPPOL2TP_HASH_BITS)
 124
 125 /* Default trace flags */
 126 #define PPPOL2TP_DEFAULT_DEBUG_FLAGS    0
 127
 128 #define PRINTK(_mask, _type, _lvl, _fmt, args...)                       \
 129         do {                                                            \
 130                 if ((_mask) & (_type))                                  \
 131                         printk(_lvl "PPPOL2TP: " _fmt, ##args);         \
 132         } while(0)
 133
 134 /* Number of bytes to build transmit L2TP headers.
 135  * Unfortunately the size is different depending on whether sequence numbers
 136  * are enabled.
 137  */
 138 #define PPPOL2TP_L2TP_HDR_SIZE_SEQ              10
 139 #define PPPOL2TP_L2TP_HDR_SIZE_NOSEQ            6
 140
 141 struct pppol2tp_tunnel;
 142
 143 /* Describes a session. It is the sk_user_data field in the PPPoL2TP
 144  * socket. Contains information to determine incoming packets and transmit
 145  * outgoing ones.
 146  */
 147 struct pppol2tp_session
 148 {
 149         int                     magic;          /* should be
 150                                                  * L2TP_SESSION_MAGIC */
 151         int                     owner;          /* pid that opened the socket */
 152
 153         struct sock             *sock;          /* Pointer to the session
 154                                                  * PPPoX socket */
 155         struct sock             *tunnel_sock;   /* Pointer to the tunnel UDP
 156                                                  * socket */
 157
 158         struct pppol2tp_addr    tunnel_addr;    /* Description of tunnel */
 159
 160         struct pppol2tp_tunnel  *tunnel;        /* back pointer to tunnel
 161                                                  * context */
 162
 163         char                    name[20];       /* "sess xxxxx/yyyyy", where
 164                                                  * x=tunnel_id, y=session_id */
 165         int                     mtu;
 166         int                     mru;
 167         int                     flags;          /* accessed by PPPIOCGFLAGS.
 168                                                  * Unused. */
 169         unsigned                recv_seq:1;     /* expect receive packets with
 170                                                  * sequence numbers? */
 171         unsigned                send_seq:1;     /* send packets with sequence
 172                                                  * numbers? */
 173         unsigned                lns_mode:1;     /* behave as LNS? LAC enables
 174                                                  * sequence numbers under
 175                                                  * control of LNS. */
 176         int                     debug;          /* bitmask of debug message
 177                                                  * categories */
 178         int                     reorder_timeout; /* configured reorder timeout
 179                                                   * (in jiffies) */
 180         u16                     nr;             /* session NR state (receive) */
 181         u16                     ns;             /* session NR state (send) */
 182         struct sk_buff_head     reorder_q;      /* receive reorder queue */
 183         struct pppol2tp_ioc_stats stats;
 184         struct hlist_node       hlist;          /* Hash list node */
 185 };
 186
 187 /* The sk_user_data field of the tunnel's UDP socket. It contains info to track
 188  * all the associated sessions so incoming packets can be sorted out
 189  */
 190 struct pppol2tp_tunnel
 191 {
 192         int                     magic;          /* Should be L2TP_TUNNEL_MAGIC */
 193         rwlock_t                hlist_lock;     /* protect session_hlist */
 194         struct hlist_head       session_hlist[PPPOL2TP_HASH_SIZE];
 195                                                 /* hashed list of sessions,
 196                                                  * hashed by id */
 197         int                     debug;          /* bitmask of debug message
 198                                                  * categories */
 199         char                    name[12];       /* "tunl xxxxx" */
 200         struct pppol2tp_ioc_stats stats;
 201
 202         void (*old_sk_destruct)(struct sock *);
 203
 204         struct sock             *sock;          /* Parent socket */
 205         struct list_head        list;           /* Keep a list of all open
 206                                                  * prepared sockets */
 207
 208         atomic_t                ref_count;
 209 };
 210
 211 /* Private data stored for received packets in the skb.
 212  */
 213 struct pppol2tp_skb_cb {
 214         u16                     ns;
 215         u16                     nr;
 216         u16                     has_seq;
 217         u16                     length;
 218         unsigned long           expires;
 219 };
 220
 221 #define PPPOL2TP_SKB_CB(skb)    ((struct pppol2tp_skb_cb *) &skb->cb[sizeof(struct inet_skb_parm)])
 222
 223 static int pppol2tp_xmit(struct ppp_channel *chan, struct sk_buff *skb);
 224 static void pppol2tp_tunnel_free(struct pppol2tp_tunnel *tunnel);
 225
 226 static atomic_t pppol2tp_tunnel_count;
 227 static atomic_t pppol2tp_session_count;
 228 static struct ppp_channel_ops pppol2tp_chan_ops = { pppol2tp_xmit , NULL };
 229 static struct proto_ops pppol2tp_ops;
 230 static LIST_HEAD(pppol2tp_tunnel_list);
 231 static DEFINE_RWLOCK(pppol2tp_tunnel_list_lock);
 232
 233 /* Helpers to obtain tunnel/session contexts from sockets.
 234  */
 235 static inline struct pppol2tp_session *pppol2tp_sock_to_session(struct sock *sk)
 236 {
 237         struct pppol2tp_session *session;
 238
 239         if (sk == NULL)
 240                 return NULL;
 241
 242         session = (struct pppol2tp_session *)(sk->sk_user_data);
 243         if (session == NULL)
 244                 return NULL;
 245
 246         BUG_ON(session->magic != L2TP_SESSION_MAGIC);
 247
 248         return session;
 249 }
 250
 251 static inline struct pppol2tp_tunnel *pppol2tp_sock_to_tunnel(struct sock *sk)
 252 {
 253         struct pppol2tp_tunnel *tunnel;
 254
 255         if (sk == NULL)
 256                 return NULL;
 257
 258         tunnel = (struct pppol2tp_tunnel *)(sk->sk_user_data);
 259         if (tunnel == NULL)
 260                 return NULL;
 261
 262         BUG_ON(tunnel->magic != L2TP_TUNNEL_MAGIC);
 263
 264         return tunnel;
 265 }
 266
 267 /* Tunnel reference counts. Incremented per session that is added to
 268  * the tunnel.
 269  */
 270 static inline void pppol2tp_tunnel_inc_refcount(struct pppol2tp_tunnel *tunnel)
 271 {
 272         atomic_inc(&tunnel->ref_count);
 273 }
 274
 275 static inline void pppol2tp_tunnel_dec_refcount(struct pppol2tp_tunnel *tunnel)
 276 {
 277         if (atomic_dec_and_test(&tunnel->ref_count))
 278                 pppol2tp_tunnel_free(tunnel);
 279 }
 280
 281 /* Session hash list.
 282  * The session_id SHOULD be random according to RFC2661, but several
 283  * L2TP implementations (Cisco and Microsoft) use incrementing
 284  * session_ids.  So we do a real hash on the session_id, rather than a
 285  * simple bitmask.
 286  */
 287 static inline struct hlist_head *
 288 pppol2tp_session_id_hash(struct pppol2tp_tunnel *tunnel, u16 session_id)
 289 {
 290         unsigned long hash_val = (unsigned long) session_id;
 291         return &tunnel->session_hlist[hash_long(hash_val, PPPOL2TP_HASH_BITS)];
 292 }
 293
 294 /* Lookup a session by id
 295  */
 296 static struct pppol2tp_session *
 297 pppol2tp_session_find(struct pppol2tp_tunnel *tunnel, u16 session_id)
 298 {
 299         struct hlist_head *session_list =
 300                 pppol2tp_session_id_hash(tunnel, session_id);
 301         struct pppol2tp_session *session;
 302         struct hlist_node *walk;
 303
 304         read_lock(&tunnel->hlist_lock);
 305         hlist_for_each_entry(session, walk, session_list, hlist) {
 306                 if (session->tunnel_addr.s_session == session_id) {
 307                         read_unlock(&tunnel->hlist_lock);
 308                         return session;
 309                 }
 310         }
 311         read_unlock(&tunnel->hlist_lock);
 312
 313         return NULL;
 314 }
 315
 316 /* Lookup a tunnel by id
 317  */
 318 static struct pppol2tp_tunnel *pppol2tp_tunnel_find(u16 tunnel_id)
 319 {
 320         struct pppol2tp_tunnel *tunnel = NULL;
 321
 322         read_lock(&pppol2tp_tunnel_list_lock);
 323         list_for_each_entry(tunnel, &pppol2tp_tunnel_list, list) {
 324                 if (tunnel->stats.tunnel_id == tunnel_id) {
 325                         read_unlock(&pppol2tp_tunnel_list_lock);
 326                         return tunnel;
 327                 }
 328         }
 329         read_unlock(&pppol2tp_tunnel_list_lock);
 330
 331         return NULL;
 332 }
 333
 334 /*****************************************************************************
 335  * Receive data handling
 336  *****************************************************************************/
 337
 338 /* Queue a skb in order. We come here only if the skb has an L2TP sequence
 339  * number.
 340  */
 341 static void pppol2tp_recv_queue_skb(struct pppol2tp_session *session, struct sk_buff *skb)
 342 {
 343         struct sk_buff *skbp;
 344         u16 ns = PPPOL2TP_SKB_CB(skb)->ns;
 345
 346         spin_lock(&session->reorder_q.lock);
 347         skb_queue_walk(&session->reorder_q, skbp) {
 348                 if (PPPOL2TP_SKB_CB(skbp)->ns > ns) {
 349                         __skb_insert(skb, skbp->prev, skbp, &session->reorder_q);
 350                         PRINTK(session->debug, PPPOL2TP_MSG_SEQ, KERN_DEBUG,
 351                                "%s: pkt %hu, inserted before %hu, reorder_q len=%d\n",
 352                                session->name, ns, PPPOL2TP_SKB_CB(skbp)->ns,
 353                                skb_queue_len(&session->reorder_q));
 354                         session->stats.rx_oos_packets++;
 355                         goto out;
 356                 }
 357         }
 358
 359         __skb_queue_tail(&session->reorder_q, skb);
 360
 361 out:
 362         spin_unlock(&session->reorder_q.lock);
 363 }
 364
 365 /* Dequeue a single skb.
 366  */
 367 static void pppol2tp_recv_dequeue_skb(struct pppol2tp_session *session, struct sk_buff *skb)
 368 {
 369         struct pppol2tp_tunnel *tunnel = session->tunnel;
 370         int length = PPPOL2TP_SKB_CB(skb)->length;
 371         struct sock *session_sock = NULL;
 372
 373         /* We're about to requeue the skb, so unlink it and return resources
 374          * to its current owner (a socket receive buffer).
 375          */
 376         skb_unlink(skb, &session->reorder_q);
 377         skb_orphan(skb);
 378
 379         tunnel->stats.rx_packets++;
 380         tunnel->stats.rx_bytes += length;
 381         session->stats.rx_packets++;
 382         session->stats.rx_bytes += length;
 383
 384         if (PPPOL2TP_SKB_CB(skb)->has_seq) {
 385                 /* Bump our Nr */
 386                 session->nr++;
 387                 PRINTK(session->debug, PPPOL2TP_MSG_SEQ, KERN_DEBUG,
 388                        "%s: updated nr to %hu\n", session->name, session->nr);
 389         }
 390
 391         /* If the socket is bound, send it in to PPP's input queue. Otherwise
 392          * queue it on the session socket.
 393          */
 394         session_sock = session->sock;
 395         if (session_sock->sk_state & PPPOX_BOUND) {
 396                 struct pppox_sock *po;
 397                 PRINTK(session->debug, PPPOL2TP_MSG_DATA, KERN_DEBUG,
 398                        "%s: recv %d byte data frame, passing to ppp\n",
 399                        session->name, length);
 400
 401                 /* We need to forget all info related to the L2TP packet
 402                  * gathered in the skb as we are going to reuse the same
 403                  * skb for the inner packet.
 404                  * Namely we need to:
 405                  * - reset xfrm (IPSec) information as it applies to
 406                  *   the outer L2TP packet and not to the inner one
 407                  * - release the dst to force a route lookup on the inner
 408                  *   IP packet since skb->dst currently points to the dst
 409                  *   of the UDP tunnel
 410                  * - reset netfilter information as it doesn't apply
 411                  *   to the inner packet either
 412                  */
 413                 secpath_reset(skb);
 414                 dst_release(skb->dst);
 415                 skb->dst = NULL;
 416                 nf_reset(skb);
 417
 418                 po = pppox_sk(session_sock);
 419                 ppp_input(&po->chan, skb);
 420         } else {
 421                 PRINTK(session->debug, PPPOL2TP_MSG_DATA, KERN_INFO,
 422                        "%s: socket not bound\n", session->name);
 423
 424                 /* Not bound. Nothing we can do, so discard. */
 425                 session->stats.rx_errors++;
 426                 kfree_skb(skb);
 427         }
 428
 429         sock_put(session->sock);
 430 }
 431
 432 /* Dequeue skbs from the session's reorder_q, subject to packet order.
 433  * Skbs that have been in the queue for too long are simply discarded.
 434  */
 435 static void pppol2tp_recv_dequeue(struct pppol2tp_session *session)
 436 {
 437         struct sk_buff *skb;
 438         struct sk_buff *tmp;
 439
 440         /* If the pkt at the head of the queue has the nr that we
 441          * expect to send up next, dequeue it and any other
 442          * in-sequence packets behind it.
 443          */
 444         spin_lock(&session->reorder_q.lock);
 445         skb_queue_walk_safe(&session->reorder_q, skb, tmp) {
 446                 if (time_after(jiffies, PPPOL2TP_SKB_CB(skb)->expires)) {
 447                         session->stats.rx_seq_discards++;
 448                         session->stats.rx_errors++;
 449                         PRINTK(session->debug, PPPOL2TP_MSG_SEQ, KERN_DEBUG,
 450                                "%s: oos pkt %hu len %d discarded (too old), "
 451                                "waiting for %hu, reorder_q_len=%d\n",
 452                                session->name, PPPOL2TP_SKB_CB(skb)->ns,
 453                                PPPOL2TP_SKB_CB(skb)->length, session->nr,
 454                                skb_queue_len(&session->reorder_q));
 455                         __skb_unlink(skb, &session->reorder_q);
 456                         kfree_skb(skb);
 457                         continue;
 458                 }
 459
 460                 if (PPPOL2TP_SKB_CB(skb)->has_seq) {
 461                         if (PPPOL2TP_SKB_CB(skb)->ns != session->nr) {
 462                                 PRINTK(session->debug, PPPOL2TP_MSG_SEQ, KERN_DEBUG,
 463                                        "%s: holding oos pkt %hu len %d, "
 464                                        "waiting for %hu, reorder_q_len=%d\n",
 465                                        session->name, PPPOL2TP_SKB_CB(skb)->ns,
 466                                        PPPOL2TP_SKB_CB(skb)->length, session->nr,
 467                                        skb_queue_len(&session->reorder_q));
 468                                 goto out;
 469                         }
 470                 }
 471                 spin_unlock(&session->reorder_q.lock);
 472                 pppol2tp_recv_dequeue_skb(session, skb);
 473                 spin_lock(&session->reorder_q.lock);
 474         }
 475
 476 out:
 477         spin_unlock(&session->reorder_q.lock);
 478 }
 479
 480 /* Internal receive frame. Do the real work of receiving an L2TP data frame
 481  * here. The skb is not on a list when we get here.
 482  * Returns 0 if the packet was a data packet and was successfully passed on.
 483  * Returns 1 if the packet was not a good data packet and could not be
 484  * forwarded.  All such packets are passed up to userspace to deal with.
 485  */
 486 static int pppol2tp_recv_core(struct sock *sock, struct sk_buff *skb)
 487 {
 488         struct pppol2tp_session *session = NULL;
 489         struct pppol2tp_tunnel *tunnel;
 490         unsigned char *ptr;
 491         u16 hdrflags;
 492         u16 tunnel_id, session_id;
 493         int length;
 494         struct udphdr *uh;
 495
 496         tunnel = pppol2tp_sock_to_tunnel(sock);
 497         if (tunnel == NULL)
 498                 goto error;
 499
 500         /* Short packet? */
 501         if (skb->len < sizeof(struct udphdr)) {
 502                 PRINTK(tunnel->debug, PPPOL2TP_MSG_DATA, KERN_INFO,
 503                        "%s: recv short packet (len=%d)\n", tunnel->name, skb->len);
 504                 goto error;
 505         }
 506
 507         /* Point to L2TP header */
 508         ptr = skb->data + sizeof(struct udphdr);
 509
 510         /* Get L2TP header flags */
 511         hdrflags = ntohs(*(__be16*)ptr);
 512
 513         /* Trace packet contents, if enabled */
 514         if (tunnel->debug & PPPOL2TP_MSG_DATA) {
 515                 printk(KERN_DEBUG "%s: recv: ", tunnel->name);
 516
 517                 for (length = 0; length < 16; length++)
 518                         printk(" %02X", ptr[length]);
 519                 printk("\n");
 520         }
 521
 522         /* Get length of L2TP packet */
 523         uh = (struct udphdr *) skb_transport_header(skb);
 524         length = ntohs(uh->len) - sizeof(struct udphdr);
 525
 526         /* Too short? */
 527         if (length < 12) {
 528                 PRINTK(tunnel->debug, PPPOL2TP_MSG_DATA, KERN_INFO,
 529                        "%s: recv short L2TP packet (len=%d)\n", tunnel->name, length);
 530                 goto error;
 531         }
 532
 533         /* If type is control packet, it is handled by userspace. */
 534         if (hdrflags & L2TP_HDRFLAG_T) {
 535                 PRINTK(tunnel->debug, PPPOL2TP_MSG_DATA, KERN_DEBUG,
 536                        "%s: recv control packet, len=%d\n", tunnel->name, length);
 537                 goto error;
 538         }
 539
 540         /* Skip flags */
 541         ptr += 2;
 542
 543         /* If length is present, skip it */
 544         if (hdrflags & L2TP_HDRFLAG_L)
 545                 ptr += 2;
 546
 547         /* Extract tunnel and session ID */
 548         tunnel_id = ntohs(*(__be16 *) ptr);
 549         ptr += 2;
 550         session_id = ntohs(*(__be16 *) ptr);
 551         ptr += 2;
 552
 553         /* Find the session context */
 554         session = pppol2tp_session_find(tunnel, session_id);
 555         if (!session) {
 556                 /* Not found? Pass to userspace to deal with */
 557                 PRINTK(tunnel->debug, PPPOL2TP_MSG_DATA, KERN_INFO,
 558                        "%s: no socket found (%hu/%hu). Passing up.\n",
 559                        tunnel->name, tunnel_id, session_id);
 560                 goto error;
 561         }
 562         sock_hold(session->sock);
 563
 564         /* The ref count on the socket was increased by the above call since
 565          * we now hold a pointer to the session. Take care to do sock_put()
 566          * when exiting this function from now on...
 567          */
 568
 569         /* Handle the optional sequence numbers.  If we are the LAC,
 570          * enable/disable sequence numbers under the control of the LNS.  If
 571          * no sequence numbers present but we were expecting them, discard
 572          * frame.
 573          */
 574         if (hdrflags & L2TP_HDRFLAG_S) {
 575                 u16 ns, nr;
 576                 ns = ntohs(*(__be16 *) ptr);
 577                 ptr += 2;
 578                 nr = ntohs(*(__be16 *) ptr);
 579                 ptr += 2;
 580
 581                 /* Received a packet with sequence numbers. If we're the LNS,
 582                  * check if we sre sending sequence numbers and if not,
 583                  * configure it so.
 584                  */
 585                 if ((!session->lns_mode) && (!session->send_seq)) {
 586                         PRINTK(session->debug, PPPOL2TP_MSG_SEQ, KERN_INFO,
 587                                "%s: requested to enable seq numbers by LNS\n",
 588                                session->name);
 589                         session->send_seq = -1;
 590                 }
 591
 592                 /* Store L2TP info in the skb */
 593                 PPPOL2TP_SKB_CB(skb)->ns = ns;
 594                 PPPOL2TP_SKB_CB(skb)->nr = nr;
 595                 PPPOL2TP_SKB_CB(skb)->has_seq = 1;
 596
 597                 PRINTK(session->debug, PPPOL2TP_MSG_SEQ, KERN_DEBUG,
 598                        "%s: recv data ns=%hu, nr=%hu, session nr=%hu\n",
 599                        session->name, ns, nr, session->nr);
 600         } else {
 601                 /* No sequence numbers.
 602                  * If user has configured mandatory sequence numbers, discard.
 603                  */
 604                 if (session->recv_seq) {
 605                         PRINTK(session->debug, PPPOL2TP_MSG_SEQ, KERN_WARNING,
 606                                "%s: recv data has no seq numbers when required. "
 607                                "Discarding\n", session->name);
 608                         session->stats.rx_seq_discards++;
 609                         session->stats.rx_errors++;
 610                         goto discard;
 611                 }
 612
 613                 /* If we're the LAC and we're sending sequence numbers, the
 614                  * LNS has requested that we no longer send sequence numbers.
 615                  * If we're the LNS and we're sending sequence numbers, the
 616                  * LAC is broken. Discard the frame.
 617                  */
 618                 if ((!session->lns_mode) && (session->send_seq)) {
 619                         PRINTK(session->debug, PPPOL2TP_MSG_SEQ, KERN_INFO,
 620                                "%s: requested to disable seq numbers by LNS\n",
 621                                session->name);
 622                         session->send_seq = 0;
 623                 } else if (session->send_seq) {
 624                         PRINTK(session->debug, PPPOL2TP_MSG_SEQ, KERN_WARNING,
 625                                "%s: recv data has no seq numbers when required. "
 626                                "Discarding\n", session->name);
 627                         session->stats.rx_seq_discards++;
 628                         session->stats.rx_errors++;
 629                         goto discard;
 630                 }
 631
 632                 /* Store L2TP info in the skb */
 633                 PPPOL2TP_SKB_CB(skb)->has_seq = 0;
 634         }
 635
 636         /* If offset bit set, skip it. */
 637         if (hdrflags & L2TP_HDRFLAG_O)
 638                 ptr += 2 + ntohs(*(__be16 *) ptr);
 639
 640         skb_pull(skb, ptr - skb->data);
 641
 642         /* Skip PPP header, if present.  In testing, Microsoft L2TP clients
 643          * don't send the PPP header (PPP header compression enabled), but
 644          * other clients can include the header. So we cope with both cases
 645          * here. The PPP header is always FF03 when using L2TP.
 646          *
 647          * Note that skb->data[] isn't dereferenced from a u16 ptr here since
 648          * the field may be unaligned.
 649          */
 650         if ((skb->data[0] == 0xff) && (skb->data[1] == 0x03))
 651                 skb_pull(skb, 2);
 652
 653         /* Prepare skb for adding to the session's reorder_q.  Hold
 654          * packets for max reorder_timeout or 1 second if not
 655          * reordering.
 656          */
 657         PPPOL2TP_SKB_CB(skb)->length = length;
 658         PPPOL2TP_SKB_CB(skb)->expires = jiffies +
 659                 (session->reorder_timeout ? session->reorder_timeout : HZ);
 660
 661         /* Add packet to the session's receive queue. Reordering is done here, if
 662          * enabled. Saved L2TP protocol info is stored in skb->sb[].
 663          */
 664         if (PPPOL2TP_SKB_CB(skb)->has_seq) {
 665                 if (session->reorder_timeout != 0) {
 666                         /* Packet reordering enabled. Add skb to session's
 667                          * reorder queue, in order of ns.
 668                          */
 669                         pppol2tp_recv_queue_skb(session, skb);
 670                 } else {
 671                         /* Packet reordering disabled. Discard out-of-sequence
 672                          * packets
 673                          */
 674                         if (PPPOL2TP_SKB_CB(skb)->ns != session->nr) {
 675                                 session->stats.rx_seq_discards++;
 676                                 session->stats.rx_errors++;
 677                                 PRINTK(session->debug, PPPOL2TP_MSG_SEQ, KERN_DEBUG,
 678                                        "%s: oos pkt %hu len %d discarded, "
 679                                        "waiting for %hu, reorder_q_len=%d\n",
 680                                        session->name, PPPOL2TP_SKB_CB(skb)->ns,
 681                                        PPPOL2TP_SKB_CB(skb)->length, session->nr,
 682                                        skb_queue_len(&session->reorder_q));
 683                                 goto discard;
 684                         }
 685                         skb_queue_tail(&session->reorder_q, skb);
 686                 }
 687         } else {
 688                 /* No sequence numbers. Add the skb to the tail of the
 689                  * reorder queue. This ensures that it will be
 690                  * delivered after all previous sequenced skbs.
 691                  */
 692                 skb_queue_tail(&session->reorder_q, skb);
 693         }
 694
 695         /* Try to dequeue as many skbs from reorder_q as we can. */
 696         pppol2tp_recv_dequeue(session);
 697
 698         return 0;
 699
 700 discard:
 701         kfree_skb(skb);
 702         sock_put(session->sock);
 703
 704         return 0;
 705
 706 error:
 707         return 1;
 708 }
 709
 710 /* UDP encapsulation receive handler. See net/ipv4/udp.c.
 711  * Return codes:
 712  * 0 : success.
 713  * <0: error
 714  * >0: skb should be passed up to userspace as UDP.
 715  */
 716 static int pppol2tp_udp_encap_recv(struct sock *sk, struct sk_buff *skb)
 717 {
 718         struct pppol2tp_tunnel *tunnel;
 719
 720         tunnel = pppol2tp_sock_to_tunnel(sk);
 721         if (tunnel == NULL)
 722                 goto pass_up;
 723
 724         PRINTK(tunnel->debug, PPPOL2TP_MSG_DATA, KERN_DEBUG,
 725                "%s: received %d bytes\n", tunnel->name, skb->len);
 726
 727         if (pppol2tp_recv_core(sk, skb))
 728                 goto pass_up;
 729
 730         return 0;
 731
 732 pass_up:
 733         return 1;
 734 }
 735
 736 /* Receive message. This is the recvmsg for the PPPoL2TP socket.
 737  */
 738 static int pppol2tp_recvmsg(struct kiocb *iocb, struct socket *sock,
 739                             struct msghdr *msg, size_t len,
 740                             int flags)
 741 {
 742         int err;
 743         struct sk_buff *skb;
 744         struct sock *sk = sock->sk;
 745
 746         err = -EIO;
 747         if (sk->sk_state & PPPOX_BOUND)
 748                 goto end;
 749
 750         msg->msg_namelen = 0;
 751
 752         err = 0;
 753         skb = skb_recv_datagram(sk, flags & ~MSG_DONTWAIT,
 754                                 flags & MSG_DONTWAIT, &err);
 755         if (skb) {
 756                 err = memcpy_toiovec(msg->msg_iov, (unsigned char *) skb->data,
 757                                      skb->len);
 758                 if (err < 0)
 759                         goto do_skb_free;
 760                 err = skb->len;
 761         }
 762 do_skb_free:
 763         kfree_skb(skb);
 764 end:
 765         return err;
 766 }
 767
 768 /************************************************************************
 769  * Transmit handling
 770  ***********************************************************************/
 771
 772 /* Tell how big L2TP headers are for a particular session. This
 773  * depends on whether sequence numbers are being used.
 774  */
 775 static inline int pppol2tp_l2tp_header_len(struct pppol2tp_session *session)
 776 {
 777         if (session->send_seq)
 778                 return PPPOL2TP_L2TP_HDR_SIZE_SEQ;
 779
 780         return PPPOL2TP_L2TP_HDR_SIZE_NOSEQ;
 781 }
 782
 783 /* Build an L2TP header for the session into the buffer provided.
 784  */
 785 static void pppol2tp_build_l2tp_header(struct pppol2tp_session *session,
 786                                        void *buf)
 787 {
 788         __be16 *bufp = buf;
 789         u16 flags = L2TP_HDR_VER;
 790
 791         if (session->send_seq)
 792                 flags |= L2TP_HDRFLAG_S;
 793
 794         /* Setup L2TP header.
 795          * FIXME: Can this ever be unaligned? Is direct dereferencing of
 796          * 16-bit header fields safe here for all architectures?
 797          */
 798         *bufp++ = htons(flags);
 799         *bufp++ = htons(session->tunnel_addr.d_tunnel);
 800         *bufp++ = htons(session->tunnel_addr.d_session);
 801         if (session->send_seq) {
 802                 *bufp++ = htons(session->ns);
 803                 *bufp++ = 0;
 804                 session->ns++;
 805                 PRINTK(session->debug, PPPOL2TP_MSG_SEQ, KERN_DEBUG,
 806                        "%s: updated ns to %hu\n", session->name, session->ns);
 807         }
 808 }
 809
 810 /* This is the sendmsg for the PPPoL2TP pppol2tp_session socket.  We come here
 811  * when a user application does a sendmsg() on the session socket. L2TP and
 812  * PPP headers must be inserted into the user's data.
 813  */
 814 static int pppol2tp_sendmsg(struct kiocb *iocb, struct socket *sock, struct msghdr *m,
 815                             size_t total_len)
 816 {
 817         static const unsigned char ppph[2] = { 0xff, 0x03 };
 818         struct sock *sk = sock->sk;
 819         struct inet_sock *inet;
 820         __wsum csum = 0;
 821         struct sk_buff *skb;
 822         int error;
 823         int hdr_len;
 824         struct pppol2tp_session *session;
 825         struct pppol2tp_tunnel *tunnel;
 826         struct udphdr *uh;
 827         unsigned int len;
 828
 829         error = -ENOTCONN;
 830         if (sock_flag(sk, SOCK_DEAD) || !(sk->sk_state & PPPOX_CONNECTED))
 831                 goto error;
 832
 833         /* Get session and tunnel contexts */
 834         error = -EBADF;
 835         session = pppol2tp_sock_to_session(sk);
 836         if (session == NULL)
 837                 goto error;
 838
 839         tunnel = pppol2tp_sock_to_tunnel(session->tunnel_sock);
 840         if (tunnel == NULL)
 841                 goto error;
 842
 843         /* What header length is configured for this session? */
 844         hdr_len = pppol2tp_l2tp_header_len(session);
 845
 846         /* Allocate a socket buffer */
 847         error = -ENOMEM;
 848         skb = sock_wmalloc(sk, NET_SKB_PAD + sizeof(struct iphdr) +
 849                            sizeof(struct udphdr) + hdr_len +
 850                            sizeof(ppph) + total_len,
 851                            0, GFP_KERNEL);
 852         if (!skb)
 853                 goto error;
 854
 855         /* Reserve space for headers. */
 856         skb_reserve(skb, NET_SKB_PAD);
 857         skb_reset_network_header(skb);
 858         skb_reserve(skb, sizeof(struct iphdr));
 859         skb_reset_transport_header(skb);
 860
 861         /* Build UDP header */
 862         inet = inet_sk(session->tunnel_sock);
 863         uh = (struct udphdr *) skb->data;
 864         uh->source = inet->sport;
 865         uh->dest = inet->dport;
 866         uh->len = htons(hdr_len + sizeof(ppph) + total_len);
 867         uh->check = 0;
 868         skb_put(skb, sizeof(struct udphdr));
 869
 870         /* Build L2TP header */
 871         pppol2tp_build_l2tp_header(session, skb->data);
 872         skb_put(skb, hdr_len);
 873
 874         /* Add PPP header */
 875         skb->data[0] = ppph[0];
 876         skb->data[1] = ppph[1];
 877         skb_put(skb, 2);
 878
 879         /* Copy user data into skb */
 880         error = memcpy_fromiovec(skb->data, m->msg_iov, total_len);
 881         if (error < 0) {
 882                 kfree_skb(skb);
 883                 goto error;
 884         }
 885         skb_put(skb, total_len);
 886
 887         /* Calculate UDP checksum if configured to do so */
 888         if (session->tunnel_sock->sk_no_check != UDP_CSUM_NOXMIT)
 889                 csum = udp_csum_outgoing(sk, skb);
 890
 891         /* Debug */
 892         if (session->send_seq)
 893                 PRINTK(session->debug, PPPOL2TP_MSG_DATA, KERN_DEBUG,
 894                        "%s: send %Zd bytes, ns=%hu\n", session->name,
 895                        total_len, session->ns - 1);
 896         else
 897                 PRINTK(session->debug, PPPOL2TP_MSG_DATA, KERN_DEBUG,
 898                        "%s: send %Zd bytes\n", session->name, total_len);
 899
 900         if (session->debug & PPPOL2TP_MSG_DATA) {
 901                 int i;
 902                 unsigned char *datap = skb->data;
 903
 904                 printk(KERN_DEBUG "%s: xmit:", session->name);
 905                 for (i = 0; i < total_len; i++) {
 906                         printk(" %02X", *datap++);
 907                         if (i == 15) {
 908                                 printk(" ...");
 909                                 break;
 910                         }
 911                 }
 912                 printk("\n");
 913         }
 914
 915         /* Queue the packet to IP for output */
 916         len = skb->len;
 917         error = ip_queue_xmit(skb, 1);
 918
 919         /* Update stats */
 920         if (error >= 0) {
 921                 tunnel->stats.tx_packets++;
 922                 tunnel->stats.tx_bytes += len;
 923                 session->stats.tx_packets++;
 924                 session->stats.tx_bytes += len;
 925         } else {
 926                 tunnel->stats.tx_errors++;
 927                 session->stats.tx_errors++;
 928         }
 929
 930 error:
 931         return error;
 932 }
 933
 934 /* Transmit function called by generic PPP driver.  Sends PPP frame
 935  * over PPPoL2TP socket.
 936  *
 937  * This is almost the same as pppol2tp_sendmsg(), but rather than
 938  * being called with a msghdr from userspace, it is called with a skb
 939  * from the kernel.
 940  *
 941  * The supplied skb from ppp doesn't have enough headroom for the
 942  * insertion of L2TP, UDP and IP headers so we need to allocate more
 943  * headroom in the skb. This will create a cloned skb. But we must be
 944  * careful in the error case because the caller will expect to free
 945  * the skb it supplied, not our cloned skb. So we take care to always
 946  * leave the original skb unfreed if we return an error.
 947  */
 948 static int pppol2tp_xmit(struct ppp_channel *chan, struct sk_buff *skb)
 949 {
 950         static const u8 ppph[2] = { 0xff, 0x03 };
 951         struct sock *sk = (struct sock *) chan->private;
 952         struct sock *sk_tun;
 953         int hdr_len;
 954         struct pppol2tp_session *session;
 955         struct pppol2tp_tunnel *tunnel;
 956         int rc;
 957         int headroom;
 958         int data_len = skb->len;
 959         struct inet_sock *inet;
 960         __wsum csum = 0;
 961         struct sk_buff *skb2 = NULL;
 962         struct udphdr *uh;
 963         unsigned int len;
 964
 965         if (sock_flag(sk, SOCK_DEAD) || !(sk->sk_state & PPPOX_CONNECTED))
 966                 goto abort;
 967
 968         /* Get session and tunnel contexts from the socket */
 969         session = pppol2tp_sock_to_session(sk);
 970         if (session == NULL)
 971                 goto abort;
 972
 973         sk_tun = session->tunnel_sock;
 974         if (sk_tun == NULL)
 975                 goto abort;
 976         tunnel = pppol2tp_sock_to_tunnel(sk_tun);
 977         if (tunnel == NULL)
 978                 goto abort;
 979
 980         /* What header length is configured for this session? */
 981         hdr_len = pppol2tp_l2tp_header_len(session);
 982
 983         /* Check that there's enough headroom in the skb to insert IP,
 984          * UDP and L2TP and PPP headers. If not enough, expand it to
 985          * make room. Note that a new skb (or a clone) is
 986          * allocated. If we return an error from this point on, make
 987          * sure we free the new skb but do not free the original skb
 988          * since that is done by the caller for the error case.
 989          */
 990         headroom = NET_SKB_PAD + sizeof(struct iphdr) +
 991                 sizeof(struct udphdr) + hdr_len + sizeof(ppph);
 992         if (skb_headroom(skb) < headroom) {
 993                 skb2 = skb_realloc_headroom(skb, headroom);
 994                 if (skb2 == NULL)
 995                         goto abort;
 996         } else
 997                 skb2 = skb;
 998
 999         /* Check that the socket has room */
1000         if (atomic_read(&sk_tun->sk_wmem_alloc) < sk_tun->sk_sndbuf)
1001                 skb_set_owner_w(skb2, sk_tun);
1002         else
1003                 goto discard;
1004
1005         /* Setup PPP header */
1006         skb_push(skb2, sizeof(ppph));
1007         skb2->data[0] = ppph[0];
1008         skb2->data[1] = ppph[1];
1009
1010         /* Setup L2TP header */
1011         skb_push(skb2, hdr_len);
1012         pppol2tp_build_l2tp_header(session, skb2->data);
1013
1014         /* Setup UDP header */
1015         inet = inet_sk(sk_tun);
1016         skb_push(skb2, sizeof(struct udphdr));
1017         skb_reset_transport_header(skb2);
1018         uh = (struct udphdr *) skb2->data;
1019         uh->source = inet->sport;
1020         uh->dest = inet->dport;
1021         uh->len = htons(sizeof(struct udphdr) + hdr_len + sizeof(ppph) + data_len);
1022         uh->check = 0;
1023
1024         /* Calculate UDP checksum if configured to do so */
1025         if (sk_tun->sk_no_check != UDP_CSUM_NOXMIT)
1026                 csum = udp_csum_outgoing(sk_tun, skb2);
1027
1028         /* Debug */
1029         if (session->send_seq)
1030                 PRINTK(session->debug, PPPOL2TP_MSG_DATA, KERN_DEBUG,
1031                        "%s: send %d bytes, ns=%hu\n", session->name,
1032                        data_len, session->ns - 1);
1033         else
1034                 PRINTK(session->debug, PPPOL2TP_MSG_DATA, KERN_DEBUG,
1035                        "%s: send %d bytes\n", session->name, data_len);
1036
1037         if (session->debug & PPPOL2TP_MSG_DATA) {
1038                 int i;
1039                 unsigned char *datap = skb2->data;
1040
1041                 printk(KERN_DEBUG "%s: xmit:", session->name);
1042                 for (i = 0; i < data_len; i++) {
1043                         printk(" %02X", *datap++);
1044                         if (i == 31) {
1045                                 printk(" ...");
1046                                 break;
1047                         }
1048                 }
1049                 printk("\n");
1050         }
1051
1052         memset(&(IPCB(skb2)->opt), 0, sizeof(IPCB(skb2)->opt));
1053         IPCB(skb2)->flags &= ~(IPSKB_XFRM_TUNNEL_SIZE | IPSKB_XFRM_TRANSFORMED |
1054                                IPSKB_REROUTED);
1055         nf_reset(skb2);
1056
1057         /* Get routing info from the tunnel socket */
1058         dst_release(skb2->dst);
1059         skb2->dst = sk_dst_get(sk_tun);
1060
1061         /* Queue the packet to IP for output */
1062         len = skb2->len;
1063         rc = ip_queue_xmit(skb2, 1);
1064
1065         /* Update stats */
1066         if (rc >= 0) {
1067                 tunnel->stats.tx_packets++;
1068                 tunnel->stats.tx_bytes += len;
1069                 session->stats.tx_packets++;
1070                 session->stats.tx_bytes += len;
1071         } else {
1072                 tunnel->stats.tx_errors++;
1073                 session->stats.tx_errors++;
1074         }
1075
1076         /* Free the original skb */
1077         kfree_skb(skb);
1078
1079         return 1;
1080
1081 discard:
1082         /* Free the new skb. Caller will free original skb. */
1083         if (skb2 != skb)
1084                 kfree_skb(skb2);
1085 abort:
1086         return 0;
1087 }
1088
1089 /*****************************************************************************
1090  * Session (and tunnel control) socket create/destroy.
1091  *****************************************************************************/
1092
1093 /* When the tunnel UDP socket is closed, all the attached sockets need to go
1094  * too.
1095  */
1096 static void pppol2tp_tunnel_closeall(struct pppol2tp_tunnel *tunnel)
1097 {
1098         int hash;
1099         struct hlist_node *walk;
1100         struct hlist_node *tmp;
1101         struct pppol2tp_session *session;
1102         struct sock *sk;
1103
1104         if (tunnel == NULL)
1105                 BUG();
1106
1107         PRINTK(tunnel->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
1108                "%s: closing all sessions...\n", tunnel->name);
1109
1110         write_lock(&tunnel->hlist_lock);
1111         for (hash = 0; hash < PPPOL2TP_HASH_SIZE; hash++) {
1112 again:
1113                 hlist_for_each_safe(walk, tmp, &tunnel->session_hlist[hash]) {
1114                         session = hlist_entry(walk, struct pppol2tp_session, hlist);
1115
1116                         sk = session->sock;
1117
1118                         PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
1119                                "%s: closing session\n", session->name);
1120
1121                         hlist_del_init(&session->hlist);
1122
1123                         /* Since we should hold the sock lock while
1124                          * doing any unbinding, we need to release the
1125                          * lock we're holding before taking that lock.
1126                          * Hold a reference to the sock so it doesn't
1127                          * disappear as we're jumping between locks.
1128                          */
1129                         sock_hold(sk);
1130                         write_unlock(&tunnel->hlist_lock);
1131                         lock_sock(sk);
1132
1133                         if (sk->sk_state & (PPPOX_CONNECTED | PPPOX_BOUND)) {
1134                                 pppox_unbind_sock(sk);
1135                                 sk->sk_state = PPPOX_DEAD;
1136                                 sk->sk_state_change(sk);
1137                         }
1138
1139                         /* Purge any queued data */
1140                         skb_queue_purge(&sk->sk_receive_queue);
1141                         skb_queue_purge(&sk->sk_write_queue);
1142                         skb_queue_purge(&session->reorder_q);
1143
1144                         release_sock(sk);
1145                         sock_put(sk);
1146
1147                         /* Now restart from the beginning of this hash
1148                          * chain.  We always remove a session from the
1149                          * list so we are guaranteed to make forward
1150                          * progress.
1151                          */
1152                         write_lock(&tunnel->hlist_lock);
1153                         goto again;
1154                 }
1155         }
1156         write_unlock(&tunnel->hlist_lock);
1157 }
1158
1159 /* Really kill the tunnel.
1160  * Come here only when all sessions have been cleared from the tunnel.
1161  */
1162 static void pppol2tp_tunnel_free(struct pppol2tp_tunnel *tunnel)
1163 {
1164         /* Remove from socket list */
1165         write_lock(&pppol2tp_tunnel_list_lock);
1166         list_del_init(&tunnel->list);
1167         write_unlock(&pppol2tp_tunnel_list_lock);
1168
1169         atomic_dec(&pppol2tp_tunnel_count);
1170         kfree(tunnel);
1171 }
1172
1173 /* Tunnel UDP socket destruct hook.
1174  * The tunnel context is deleted only when all session sockets have been
1175  * closed.
1176  */
1177 static void pppol2tp_tunnel_destruct(struct sock *sk)
1178 {
1179         struct pppol2tp_tunnel *tunnel;
1180
1181         tunnel = pppol2tp_sock_to_tunnel(sk);
1182         if (tunnel == NULL)
1183                 goto end;
1184
1185         PRINTK(tunnel->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
1186                "%s: closing...\n", tunnel->name);
1187
1188         /* Close all sessions */
1189         pppol2tp_tunnel_closeall(tunnel);
1190
1191         /* No longer an encapsulation socket. See net/ipv4/udp.c */
1192         (udp_sk(sk))->encap_type = 0;
1193         (udp_sk(sk))->encap_rcv = NULL;
1194
1195         /* Remove hooks into tunnel socket */
1196         tunnel->sock = NULL;
1197         sk->sk_destruct = tunnel->old_sk_destruct;
1198         sk->sk_user_data = NULL;
1199
1200         /* Call original (UDP) socket descructor */
1201         if (sk->sk_destruct != NULL)
1202                 (*sk->sk_destruct)(sk);
1203
1204         pppol2tp_tunnel_dec_refcount(tunnel);
1205
1206 end:
1207         return;
1208 }
1209
1210 /* Really kill the session socket. (Called from sock_put() if
1211  * refcnt == 0.)
1212  */
1213 static void pppol2tp_session_destruct(struct sock *sk)
1214 {
1215         struct pppol2tp_session *session = NULL;
1216
1217         if (sk->sk_user_data != NULL) {
1218                 struct pppol2tp_tunnel *tunnel;
1219
1220                 session = pppol2tp_sock_to_session(sk);
1221                 if (session == NULL)
1222                         goto out;
1223
1224                 /* Don't use pppol2tp_sock_to_tunnel() here to
1225                  * get the tunnel context because the tunnel
1226                  * socket might have already been closed (its
1227                  * sk->sk_user_data will be NULL) so use the
1228                  * session's private tunnel ptr instead.
1229                  */
1230                 tunnel = session->tunnel;
1231                 if (tunnel != NULL) {
1232                         BUG_ON(tunnel->magic != L2TP_TUNNEL_MAGIC);
1233
1234                         /* If session_id is zero, this is a null
1235                          * session context, which was created for a
1236                          * socket that is being used only to manage
1237                          * tunnels.
1238                          */
1239                         if (session->tunnel_addr.s_session != 0) {
1240                                 /* Delete the session socket from the
1241                                  * hash
1242                                  */
1243                                 write_lock(&tunnel->hlist_lock);
1244                                 hlist_del_init(&session->hlist);
1245                                 write_unlock(&tunnel->hlist_lock);
1246
1247                                 atomic_dec(&pppol2tp_session_count);
1248                         }
1249
1250                         /* This will delete the tunnel context if this
1251                          * is the last session on the tunnel.
1252                          */
1253                         session->tunnel = NULL;
1254                         session->tunnel_sock = NULL;
1255                         pppol2tp_tunnel_dec_refcount(tunnel);
1256                 }
1257         }
1258
1259         kfree(session);
1260 out:
1261         return;
1262 }
1263
1264 /* Called when the PPPoX socket (session) is closed.
1265  */
1266 static int pppol2tp_release(struct socket *sock)
1267 {
1268         struct sock *sk = sock->sk;
1269         int error;
1270
1271         if (!sk)
1272                 return 0;
1273
1274         error = -EBADF;
1275         lock_sock(sk);
1276         if (sock_flag(sk, SOCK_DEAD) != 0)
1277                 goto error;
1278
1279         pppox_unbind_sock(sk);
1280
1281         /* Signal the death of the socket. */
1282         sk->sk_state = PPPOX_DEAD;
1283         sock_orphan(sk);
1284         sock->sk = NULL;
1285
1286         /* Purge any queued data */
1287         skb_queue_purge(&sk->sk_receive_queue);
1288         skb_queue_purge(&sk->sk_write_queue);
1289
1290         release_sock(sk);
1291
1292         /* This will delete the session context via
1293          * pppol2tp_session_destruct() if the socket's refcnt drops to
1294          * zero.
1295          */
1296         sock_put(sk);
1297
1298         return 0;
1299
1300 error:
1301         release_sock(sk);
1302         return error;
1303 }
1304
1305 /* Internal function to prepare a tunnel (UDP) socket to have PPPoX
1306  * sockets attached to it.
1307  */
1308 static struct sock *pppol2tp_prepare_tunnel_socket(int fd, u16 tunnel_id,
1309                                                    int *error)
1310 {
1311         int err;
1312         struct socket *sock = NULL;
1313         struct sock *sk;
1314         struct pppol2tp_tunnel *tunnel;
1315         struct sock *ret = NULL;
1316
1317         /* Get the tunnel UDP socket from the fd, which was opened by
1318          * the userspace L2TP daemon.
1319          */
1320         err = -EBADF;
1321         sock = sockfd_lookup(fd, &err);
1322         if (!sock) {
1323                 PRINTK(-1, PPPOL2TP_MSG_CONTROL, KERN_ERR,
1324                        "tunl %hu: sockfd_lookup(fd=%d) returned %d\n",
1325                        tunnel_id, fd, err);
1326                 goto err;
1327         }
1328
1329         /* Quick sanity checks */
1330         err = -ESOCKTNOSUPPORT;
1331         if (sock->type != SOCK_DGRAM) {
1332                 PRINTK(-1, PPPOL2TP_MSG_CONTROL, KERN_ERR,
1333                        "tunl %hu: fd %d wrong type, got %d, expected %d\n",
1334                        tunnel_id, fd, sock->type, SOCK_DGRAM);
1335                 goto err;
1336         }
1337         err = -EAFNOSUPPORT;
1338         if (sock->ops->family != AF_INET) {
1339                 PRINTK(-1, PPPOL2TP_MSG_CONTROL, KERN_ERR,
1340                        "tunl %hu: fd %d wrong family, got %d, expected %d\n",
1341                        tunnel_id, fd, sock->ops->family, AF_INET);
1342                 goto err;
1343         }
1344
1345         err = -ENOTCONN;
1346         sk = sock->sk;
1347
1348         /* Check if this socket has already been prepped */
1349         tunnel = (struct pppol2tp_tunnel *)sk->sk_user_data;
1350         if (tunnel != NULL) {
1351                 /* User-data field already set */
1352                 err = -EBUSY;
1353                 BUG_ON(tunnel->magic != L2TP_TUNNEL_MAGIC);
1354
1355                 /* This socket has already been prepped */
1356                 ret = tunnel->sock;
1357                 goto out;
1358         }
1359
1360         /* This socket is available and needs prepping. Create a new tunnel
1361          * context and init it.
1362          */
1363         sk->sk_user_data = tunnel = kzalloc(sizeof(struct pppol2tp_tunnel), GFP_KERNEL);
1364         if (sk->sk_user_data == NULL) {
1365                 err = -ENOMEM;
1366                 goto err;
1367         }
1368
1369         tunnel->magic = L2TP_TUNNEL_MAGIC;
1370         sprintf(&tunnel->name[0], "tunl %hu", tunnel_id);
1371
1372         tunnel->stats.tunnel_id = tunnel_id;
1373         tunnel->debug = PPPOL2TP_DEFAULT_DEBUG_FLAGS;
1374
1375         /* Hook on the tunnel socket destructor so that we can cleanup
1376          * if the tunnel socket goes away.
1377          */
1378         tunnel->old_sk_destruct = sk->sk_destruct;
1379         sk->sk_destruct = &pppol2tp_tunnel_destruct;
1380
1381         tunnel->sock = sk;
1382         sk->sk_allocation = GFP_ATOMIC;
1383
1384         /* Misc init */
1385         rwlock_init(&tunnel->hlist_lock);
1386
1387         /* Add tunnel to our list */
1388         INIT_LIST_HEAD(&tunnel->list);
1389         write_lock(&pppol2tp_tunnel_list_lock);
1390         list_add(&tunnel->list, &pppol2tp_tunnel_list);
1391         write_unlock(&pppol2tp_tunnel_list_lock);
1392         atomic_inc(&pppol2tp_tunnel_count);
1393
1394         /* Bump the reference count. The tunnel context is deleted
1395          * only when this drops to zero.
1396          */
1397         pppol2tp_tunnel_inc_refcount(tunnel);
1398
1399         /* Mark socket as an encapsulation socket. See net/ipv4/udp.c */
1400         (udp_sk(sk))->encap_type = UDP_ENCAP_L2TPINUDP;
1401         (udp_sk(sk))->encap_rcv = pppol2tp_udp_encap_recv;
1402
1403         ret = tunnel->sock;
1404
1405         *error = 0;
1406 out:
1407         if (sock)
1408                 sockfd_put(sock);
1409
1410         return ret;
1411
1412 err:
1413         *error = err;
1414         goto out;
1415 }
1416
1417 static struct proto pppol2tp_sk_proto = {
1418         .name     = "PPPOL2TP",
1419         .owner    = THIS_MODULE,
1420         .obj_size = sizeof(struct pppox_sock),
1421 };
1422
1423 /* socket() handler. Initialize a new struct sock.
1424  */
1425 static int pppol2tp_create(struct socket *sock)
1426 {
1427         int error = -ENOMEM;
1428         struct sock *sk;
1429
1430         sk = sk_alloc(PF_PPPOX, GFP_KERNEL, &pppol2tp_sk_proto, 1);
1431         if (!sk)
1432                 goto out;
1433
1434         sock_init_data(sock, sk);
1435
1436         sock->state  = SS_UNCONNECTED;
1437         sock->ops    = &pppol2tp_ops;
1438
1439         sk->sk_backlog_rcv = pppol2tp_recv_core;
1440         sk->sk_protocol    = PX_PROTO_OL2TP;
1441         sk->sk_family      = PF_PPPOX;
1442         sk->sk_state       = PPPOX_NONE;
1443         sk->sk_type        = SOCK_STREAM;
1444         sk->sk_destruct    = pppol2tp_session_destruct;
1445
1446         error = 0;
1447
1448 out:
1449         return error;
1450 }
1451
1452 /* connect() handler. Attach a PPPoX socket to a tunnel UDP socket
1453  */
1454 static int pppol2tp_connect(struct socket *sock, struct sockaddr *uservaddr,
1455                             int sockaddr_len, int flags)
1456 {
1457         struct sock *sk = sock->sk;
1458         struct sockaddr_pppol2tp *sp = (struct sockaddr_pppol2tp *) uservaddr;
1459         struct pppox_sock *po = pppox_sk(sk);
1460         struct sock *tunnel_sock = NULL;
1461         struct pppol2tp_session *session = NULL;
1462         struct pppol2tp_tunnel *tunnel;
1463         struct dst_entry *dst;
1464         int error = 0;
1465
1466         lock_sock(sk);
1467
1468         error = -EINVAL;
1469         if (sp->sa_protocol != PX_PROTO_OL2TP)
1470                 goto end;
1471
1472         /* Check for already bound sockets */
1473         error = -EBUSY;
1474         if (sk->sk_state & PPPOX_CONNECTED)
1475                 goto end;
1476
1477         /* We don't supporting rebinding anyway */
1478         error = -EALREADY;
1479         if (sk->sk_user_data)
1480                 goto end; /* socket is already attached */
1481
1482         /* Don't bind if s_tunnel is 0 */
1483         error = -EINVAL;
1484         if (sp->pppol2tp.s_tunnel == 0)
1485                 goto end;
1486
1487         /* Special case: prepare tunnel socket if s_session and
1488          * d_session is 0. Otherwise look up tunnel using supplied
1489          * tunnel id.
1490          */
1491         if ((sp->pppol2tp.s_session == 0) && (sp->pppol2tp.d_session == 0)) {
1492                 tunnel_sock = pppol2tp_prepare_tunnel_socket(sp->pppol2tp.fd,
1493                                                              sp->pppol2tp.s_tunnel,
1494                                                              &error);
1495                 if (tunnel_sock == NULL)
1496                         goto end;
1497
1498                 tunnel = tunnel_sock->sk_user_data;
1499         } else {
1500                 tunnel = pppol2tp_tunnel_find(sp->pppol2tp.s_tunnel);
1501
1502                 /* Error if we can't find the tunnel */
1503                 error = -ENOENT;
1504                 if (tunnel == NULL)
1505                         goto end;
1506
1507                 tunnel_sock = tunnel->sock;
1508         }
1509
1510         /* Check that this session doesn't already exist */
1511         error = -EEXIST;
1512         session = pppol2tp_session_find(tunnel, sp->pppol2tp.s_session);
1513         if (session != NULL)
1514                 goto end;
1515
1516         /* Allocate and initialize a new session context. */
1517         session = kzalloc(sizeof(struct pppol2tp_session), GFP_KERNEL);
1518         if (session == NULL) {
1519                 error = -ENOMEM;
1520                 goto end;
1521         }
1522
1523         skb_queue_head_init(&session->reorder_q);
1524
1525         session->magic       = L2TP_SESSION_MAGIC;
1526         session->owner       = current->pid;
1527         session->sock        = sk;
1528         session->tunnel      = tunnel;
1529         session->tunnel_sock = tunnel_sock;
1530         session->tunnel_addr = sp->pppol2tp;
1531         sprintf(&session->name[0], "sess %hu/%hu",
1532                 session->tunnel_addr.s_tunnel,
1533                 session->tunnel_addr.s_session);
1534
1535         session->stats.tunnel_id  = session->tunnel_addr.s_tunnel;
1536         session->stats.session_id = session->tunnel_addr.s_session;
1537
1538         INIT_HLIST_NODE(&session->hlist);
1539
1540         /* Inherit debug options from tunnel */
1541         session->debug = tunnel->debug;
1542
1543         /* Default MTU must allow space for UDP/L2TP/PPP
1544          * headers.
1545          */
1546         session->mtu = session->mru = 1500 - PPPOL2TP_HEADER_OVERHEAD;
1547
1548         /* If PMTU discovery was enabled, use the MTU that was discovered */
1549         dst = sk_dst_get(sk);
1550         if (dst != NULL) {
1551                 u32 pmtu = dst_mtu(__sk_dst_get(sk));
1552                 if (pmtu != 0)
1553                         session->mtu = session->mru = pmtu -
1554                                 PPPOL2TP_HEADER_OVERHEAD;
1555                 dst_release(dst);
1556         }
1557
1558         /* Special case: if source & dest session_id == 0x0000, this socket is
1559          * being created to manage the tunnel. Don't add the session to the
1560          * session hash list, just set up the internal context for use by
1561          * ioctl() and sockopt() handlers.
1562          */
1563         if ((session->tunnel_addr.s_session == 0) &&
1564             (session->tunnel_addr.d_session == 0)) {
1565                 error = 0;
1566                 sk->sk_user_data = session;
1567                 goto out_no_ppp;
1568         }
1569
1570         /* Get tunnel context from the tunnel socket */
1571         tunnel = pppol2tp_sock_to_tunnel(tunnel_sock);
1572         if (tunnel == NULL) {
1573                 error = -EBADF;
1574                 goto end;
1575         }
1576
1577         /* Right now, because we don't have a way to push the incoming skb's
1578          * straight through the UDP layer, the only header we need to worry
1579          * about is the L2TP header. This size is different depending on
1580          * whether sequence numbers are enabled for the data channel.
1581          */
1582         po->chan.hdrlen = PPPOL2TP_L2TP_HDR_SIZE_NOSEQ;
1583
1584         po->chan.private = sk;
1585         po->chan.ops     = &pppol2tp_chan_ops;
1586         po->chan.mtu     = session->mtu;
1587
1588         error = ppp_register_channel(&po->chan);
1589         if (error)
1590                 goto end;
1591
1592         /* This is how we get the session context from the socket. */
1593         sk->sk_user_data = session;
1594
1595         /* Add session to the tunnel's hash list */
1596         write_lock(&tunnel->hlist_lock);
1597         hlist_add_head(&session->hlist,
1598                        pppol2tp_session_id_hash(tunnel,
1599                                                 session->tunnel_addr.s_session));
1600         write_unlock(&tunnel->hlist_lock);
1601
1602         atomic_inc(&pppol2tp_session_count);
1603
1604 out_no_ppp:
1605         pppol2tp_tunnel_inc_refcount(tunnel);
1606         sk->sk_state = PPPOX_CONNECTED;
1607         PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
1608                "%s: created\n", session->name);
1609
1610 end:
1611         release_sock(sk);
1612
1613         if (error != 0)
1614                 PRINTK(session ? session->debug : -1, PPPOL2TP_MSG_CONTROL, KERN_WARNING,
1615                        "%s: connect failed: %d\n", session->name, error);
1616
1617         return error;
1618 }
1619
1620 /* getname() support.
1621  */
1622 static int pppol2tp_getname(struct socket *sock, struct sockaddr *uaddr,
1623                             int *usockaddr_len, int peer)
1624 {
1625         int len = sizeof(struct sockaddr_pppol2tp);
1626         struct sockaddr_pppol2tp sp;
1627         int error = 0;
1628         struct pppol2tp_session *session;
1629
1630         error = -ENOTCONN;
1631         if (sock->sk->sk_state != PPPOX_CONNECTED)
1632                 goto end;
1633
1634         session = pppol2tp_sock_to_session(sock->sk);
1635         if (session == NULL) {
1636                 error = -EBADF;
1637                 goto end;
1638         }
1639
1640         sp.sa_family    = AF_PPPOX;
1641         sp.sa_protocol  = PX_PROTO_OL2TP;
1642         memcpy(&sp.pppol2tp, &session->tunnel_addr,
1643                sizeof(struct pppol2tp_addr));
1644
1645         memcpy(uaddr, &sp, len);
1646
1647         *usockaddr_len = len;
1648
1649         error = 0;
1650
1651 end:
1652         return error;
1653 }
1654
1655 /****************************************************************************
1656  * ioctl() handlers.
1657  *
1658  * The PPPoX socket is created for L2TP sessions: tunnels have their own UDP
1659  * sockets. However, in order to control kernel tunnel features, we allow
1660  * userspace to create a special "tunnel" PPPoX socket which is used for
1661  * control only.  Tunnel PPPoX sockets have session_id == 0 and simply allow
1662  * the user application to issue L2TP setsockopt(), getsockopt() and ioctl()
1663  * calls.
1664  ****************************************************************************/
1665
1666 /* Session ioctl helper.
1667  */
1668 static int pppol2tp_session_ioctl(struct pppol2tp_session *session,
1669                                   unsigned int cmd, unsigned long arg)
1670 {
1671         struct ifreq ifr;
1672         int err = 0;
1673         struct sock *sk = session->sock;
1674         int val = (int) arg;
1675
1676         PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_DEBUG,
1677                "%s: pppol2tp_session_ioctl(cmd=%#x, arg=%#lx)\n",
1678                session->name, cmd, arg);
1679
1680         sock_hold(sk);
1681
1682         switch (cmd) {
1683         case SIOCGIFMTU:
1684                 err = -ENXIO;
1685                 if (!(sk->sk_state & PPPOX_CONNECTED))
1686                         break;
1687
1688                 err = -EFAULT;
1689                 if (copy_from_user(&ifr, (void __user *) arg, sizeof(struct ifreq)))
1690                         break;
1691                 ifr.ifr_mtu = session->mtu;
1692                 if (copy_to_user((void __user *) arg, &ifr, sizeof(struct ifreq)))
1693                         break;
1694
1695                 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
1696                        "%s: get mtu=%d\n", session->name, session->mtu);
1697                 err = 0;
1698                 break;
1699
1700         case SIOCSIFMTU:
1701                 err = -ENXIO;
1702                 if (!(sk->sk_state & PPPOX_CONNECTED))
1703                         break;
1704
1705                 err = -EFAULT;
1706                 if (copy_from_user(&ifr, (void __user *) arg, sizeof(struct ifreq)))
1707                         break;
1708
1709                 session->mtu = ifr.ifr_mtu;
1710
1711                 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
1712                        "%s: set mtu=%d\n", session->name, session->mtu);
1713                 err = 0;
1714                 break;
1715
1716         case PPPIOCGMRU:
1717                 err = -ENXIO;
1718                 if (!(sk->sk_state & PPPOX_CONNECTED))
1719                         break;
1720
1721                 err = -EFAULT;
1722                 if (put_user(session->mru, (int __user *) arg))
1723                         break;
1724
1725                 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
1726                        "%s: get mru=%d\n", session->name, session->mru);
1727                 err = 0;
1728                 break;
1729
1730         case PPPIOCSMRU:
1731                 err = -ENXIO;
1732                 if (!(sk->sk_state & PPPOX_CONNECTED))
1733                         break;
1734
1735                 err = -EFAULT;
1736                 if (get_user(val,(int __user *) arg))
1737                         break;
1738
1739                 session->mru = val;
1740                 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
1741                        "%s: set mru=%d\n", session->name, session->mru);
1742                 err = 0;
1743                 break;
1744
1745         case PPPIOCGFLAGS:
1746                 err = -EFAULT;
1747                 if (put_user(session->flags, (int __user *) arg))
1748                         break;
1749
1750                 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
1751                        "%s: get flags=%d\n", session->name, session->flags);
1752                 err = 0;
1753                 break;
1754
1755         case PPPIOCSFLAGS:
1756                 err = -EFAULT;
1757                 if (get_user(val, (int __user *) arg))
1758                         break;
1759                 session->flags = val;
1760                 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
1761                        "%s: set flags=%d\n", session->name, session->flags);
1762                 err = 0;
1763                 break;
1764
1765         case PPPIOCGL2TPSTATS:
1766                 err = -ENXIO;
1767                 if (!(sk->sk_state & PPPOX_CONNECTED))
1768                         break;
1769
1770                 if (copy_to_user((void __user *) arg, &session->stats,
1771                                  sizeof(session->stats)))
1772                         break;
1773                 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
1774                        "%s: get L2TP stats\n", session->name);
1775                 err = 0;
1776                 break;
1777
1778         default:
1779                 err = -ENOSYS;
1780                 break;
1781         }
1782
1783         sock_put(sk);
1784
1785         return err;
1786 }
1787
1788 /* Tunnel ioctl helper.
1789  *
1790  * Note the special handling for PPPIOCGL2TPSTATS below. If the ioctl data
1791  * specifies a session_id, the session ioctl handler is called. This allows an
1792  * application to retrieve session stats via a tunnel socket.
1793  */
1794 static int pppol2tp_tunnel_ioctl(struct pppol2tp_tunnel *tunnel,
1795                                  unsigned int cmd, unsigned long arg)
1796 {
1797         int err = 0;
1798         struct sock *sk = tunnel->sock;
1799         struct pppol2tp_ioc_stats stats_req;
1800
1801         PRINTK(tunnel->debug, PPPOL2TP_MSG_CONTROL, KERN_DEBUG,
1802                "%s: pppol2tp_tunnel_ioctl(cmd=%#x, arg=%#lx)\n", tunnel->name,
1803                cmd, arg);
1804
1805         sock_hold(sk);
1806
1807         switch (cmd) {
1808         case PPPIOCGL2TPSTATS:
1809                 err = -ENXIO;
1810                 if (!(sk->sk_state & PPPOX_CONNECTED))
1811                         break;
1812
1813                 if (copy_from_user(&stats_req, (void __user *) arg,
1814                                    sizeof(stats_req))) {
1815                         err = -EFAULT;
1816                         break;
1817                 }
1818                 if (stats_req.session_id != 0) {
1819                         /* resend to session ioctl handler */
1820                         struct pppol2tp_session *session =
1821                                 pppol2tp_session_find(tunnel, stats_req.session_id);
1822                         if (session != NULL)
1823                                 err = pppol2tp_session_ioctl(session, cmd, arg);
1824                         else
1825                                 err = -EBADR;
1826                         break;
1827                 }
1828 #ifdef CONFIG_XFRM
1829                 tunnel->stats.using_ipsec = (sk->sk_policy[0] || sk->sk_policy[1]) ? 1 : 0;
1830 #endif
1831                 if (copy_to_user((void __user *) arg, &tunnel->stats,
1832                                  sizeof(tunnel->stats))) {
1833                         err = -EFAULT;
1834                         break;
1835                 }
1836                 PRINTK(tunnel->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
1837                        "%s: get L2TP stats\n", tunnel->name);
1838                 err = 0;
1839                 break;
1840
1841         default:
1842                 err = -ENOSYS;
1843                 break;
1844         }
1845
1846         sock_put(sk);
1847
1848         return err;
1849 }
1850
1851 /* Main ioctl() handler.
1852  * Dispatch to tunnel or session helpers depending on the socket.
1853  */
1854 static int pppol2tp_ioctl(struct socket *sock, unsigned int cmd,
1855                           unsigned long arg)
1856 {
1857         struct sock *sk = sock->sk;
1858         struct pppol2tp_session *session;
1859         struct pppol2tp_tunnel *tunnel;
1860         int err;
1861
1862         if (!sk)
1863                 return 0;
1864
1865         err = -EBADF;
1866         if (sock_flag(sk, SOCK_DEAD) != 0)
1867                 goto end;
1868
1869         err = -ENOTCONN;
1870         if ((sk->sk_user_data == NULL) ||
1871             (!(sk->sk_state & (PPPOX_CONNECTED | PPPOX_BOUND))))
1872                 goto end;
1873
1874         /* Get session context from the socket */
1875         err = -EBADF;
1876         session = pppol2tp_sock_to_session(sk);
1877         if (session == NULL)
1878                 goto end;
1879
1880         /* Special case: if session's session_id is zero, treat ioctl as a
1881          * tunnel ioctl
1882          */
1883         if ((session->tunnel_addr.s_session == 0) &&
1884             (session->tunnel_addr.d_session == 0)) {
1885                 err = -EBADF;
1886                 tunnel = pppol2tp_sock_to_tunnel(session->tunnel_sock);
1887                 if (tunnel == NULL)
1888                         goto end;
1889
1890                 err = pppol2tp_tunnel_ioctl(tunnel, cmd, arg);
1891                 goto end;
1892         }
1893
1894         err = pppol2tp_session_ioctl(session, cmd, arg);
1895
1896 end:
1897         return err;
1898 }
1899
1900 /*****************************************************************************
1901  * setsockopt() / getsockopt() support.
1902  *
1903  * The PPPoX socket is created for L2TP sessions: tunnels have their own UDP
1904  * sockets. In order to control kernel tunnel features, we allow userspace to
1905  * create a special "tunnel" PPPoX socket which is used for control only.
1906  * Tunnel PPPoX sockets have session_id == 0 and simply allow the user
1907  * application to issue L2TP setsockopt(), getsockopt() and ioctl() calls.
1908  *****************************************************************************/
1909
1910 /* Tunnel setsockopt() helper.
1911  */
1912 static int pppol2tp_tunnel_setsockopt(struct sock *sk,
1913                                       struct pppol2tp_tunnel *tunnel,
1914                                       int optname, int val)
1915 {
1916         int err = 0;
1917
1918         switch (optname) {
1919         case PPPOL2TP_SO_DEBUG:
1920                 tunnel->debug = val;
1921                 PRINTK(tunnel->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
1922                        "%s: set debug=%x\n", tunnel->name, tunnel->debug);
1923                 break;
1924
1925         default:
1926                 err = -ENOPROTOOPT;
1927                 break;
1928         }
1929
1930         return err;
1931 }
1932
1933 /* Session setsockopt helper.
1934  */
1935 static int pppol2tp_session_setsockopt(struct sock *sk,
1936                                        struct pppol2tp_session *session,
1937                                        int optname, int val)
1938 {
1939         int err = 0;
1940
1941         switch (optname) {
1942         case PPPOL2TP_SO_RECVSEQ:
1943                 if ((val != 0) && (val != 1)) {
1944                         err = -EINVAL;
1945                         break;
1946                 }
1947                 session->recv_seq = val ? -1 : 0;
1948                 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
1949                        "%s: set recv_seq=%d\n", session->name,
1950                        session->recv_seq);
1951                 break;
1952
1953         case PPPOL2TP_SO_SENDSEQ:
1954                 if ((val != 0) && (val != 1)) {
1955                         err = -EINVAL;
1956                         break;
1957                 }
1958                 session->send_seq = val ? -1 : 0;
1959                 {
1960                         struct sock *ssk      = session->sock;
1961                         struct pppox_sock *po = pppox_sk(ssk);
1962                         po->chan.hdrlen = val ? PPPOL2TP_L2TP_HDR_SIZE_SEQ :
1963                                 PPPOL2TP_L2TP_HDR_SIZE_NOSEQ;
1964                 }
1965                 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
1966                        "%s: set send_seq=%d\n", session->name, session->send_seq);
1967                 break;
1968
1969         case PPPOL2TP_SO_LNSMODE:
1970                 if ((val != 0) && (val != 1)) {
1971                         err = -EINVAL;
1972                         break;
1973                 }
1974                 session->lns_mode = val ? -1 : 0;
1975                 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
1976                        "%s: set lns_mode=%d\n", session->name,
1977                        session->lns_mode);
1978                 break;
1979
1980         case PPPOL2TP_SO_DEBUG:
1981                 session->debug = val;
1982                 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
1983                        "%s: set debug=%x\n", session->name, session->debug);
1984                 break;
1985
1986         case PPPOL2TP_SO_REORDERTO:
1987                 session->reorder_timeout = msecs_to_jiffies(val);
1988                 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
1989                        "%s: set reorder_timeout=%d\n", session->name,
1990                        session->reorder_timeout);
1991                 break;
1992
1993         default:
1994                 err = -ENOPROTOOPT;
1995                 break;
1996         }
1997
1998         return err;
1999 }
2000
2001 /* Main setsockopt() entry point.
2002  * Does API checks, then calls either the tunnel or session setsockopt
2003  * handler, according to whether the PPPoL2TP socket is a for a regular
2004  * session or the special tunnel type.
2005  */
2006 static int pppol2tp_setsockopt(struct socket *sock, int level, int optname,
2007                                char __user *optval, int optlen)
2008 {
2009         struct sock *sk = sock->sk;
2010         struct pppol2tp_session *session = sk->sk_user_data;
2011         struct pppol2tp_tunnel *tunnel;
2012         int val;
2013         int err;
2014
2015         if (level != SOL_PPPOL2TP)
2016                 return udp_prot.setsockopt(sk, level, optname, optval, optlen);
2017
2018         if (optlen < sizeof(int))
2019                 return -EINVAL;
2020
2021         if (get_user(val, (int __user *)optval))
2022                 return -EFAULT;
2023
2024         err = -ENOTCONN;
2025         if (sk->sk_user_data == NULL)
2026                 goto end;
2027
2028         /* Get session context from the socket */
2029         err = -EBADF;
2030         session = pppol2tp_sock_to_session(sk);
2031         if (session == NULL)
2032                 goto end;
2033
2034         /* Special case: if session_id == 0x0000, treat as operation on tunnel
2035          */
2036         if ((session->tunnel_addr.s_session == 0) &&
2037             (session->tunnel_addr.d_session == 0)) {
2038                 err = -EBADF;
2039                 tunnel = pppol2tp_sock_to_tunnel(session->tunnel_sock);
2040                 if (tunnel == NULL)
2041                         goto end;
2042
2043                 err = pppol2tp_tunnel_setsockopt(sk, tunnel, optname, val);
2044         } else
2045                 err = pppol2tp_session_setsockopt(sk, session, optname, val);
2046
2047         err = 0;
2048
2049 end:
2050         return err;
2051 }
2052
2053 /* Tunnel getsockopt helper. Called with sock locked.
2054  */
2055 static int pppol2tp_tunnel_getsockopt(struct sock *sk,
2056                                       struct pppol2tp_tunnel *tunnel,
2057                                       int optname, int __user *val)
2058 {
2059         int err = 0;
2060
2061         switch (optname) {
2062         case PPPOL2TP_SO_DEBUG:
2063                 *val = tunnel->debug;
2064                 PRINTK(tunnel->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
2065                        "%s: get debug=%x\n", tunnel->name, tunnel->debug);
2066                 break;
2067
2068         default:
2069                 err = -ENOPROTOOPT;
2070                 break;
2071         }
2072
2073         return err;
2074 }
2075
2076 /* Session getsockopt helper. Called with sock locked.
2077  */
2078 static int pppol2tp_session_getsockopt(struct sock *sk,
2079                                        struct pppol2tp_session *session,
2080                                        int optname, int __user *val)
2081 {
2082         int err = 0;
2083
2084         switch (optname) {
2085         case PPPOL2TP_SO_RECVSEQ:
2086                 *val = session->recv_seq;
2087                 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
2088                        "%s: get recv_seq=%d\n", session->name, *val);
2089                 break;
2090
2091         case PPPOL2TP_SO_SENDSEQ:
2092                 *val = session->send_seq;
2093                 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
2094                        "%s: get send_seq=%d\n", session->name, *val);
2095                 break;
2096
2097         case PPPOL2TP_SO_LNSMODE:
2098                 *val = session->lns_mode;
2099                 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
2100                        "%s: get lns_mode=%d\n", session->name, *val);
2101                 break;
2102
2103         case PPPOL2TP_SO_DEBUG:
2104                 *val = session->debug;
2105                 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
2106                        "%s: get debug=%d\n", session->name, *val);
2107                 break;
2108
2109         case PPPOL2TP_SO_REORDERTO:
2110                 *val = (int) jiffies_to_msecs(session->reorder_timeout);
2111                 PRINTK(session->debug, PPPOL2TP_MSG_CONTROL, KERN_INFO,
2112                        "%s: get reorder_timeout=%d\n", session->name, *val);
2113                 break;
2114
2115         default:
2116                 err = -ENOPROTOOPT;
2117         }
2118
2119         return err;
2120 }
2121
2122 /* Main getsockopt() entry point.
2123  * Does API checks, then calls either the tunnel or session getsockopt
2124  * handler, according to whether the PPPoX socket is a for a regular session
2125  * or the special tunnel type.
2126  */
2127 static int pppol2tp_getsockopt(struct socket *sock, int level,
2128                                int optname, char __user *optval, int __user *optlen)
2129 {
2130         struct sock *sk = sock->sk;
2131         struct pppol2tp_session *session = sk->sk_user_data;
2132         struct pppol2tp_tunnel *tunnel;
2133         int val, len;
2134         int err;
2135
2136         if (level != SOL_PPPOL2TP)
2137                 return udp_prot.getsockopt(sk, level, optname, optval, optlen);
2138
2139         if (get_user(len, (int __user *) optlen))
2140                 return -EFAULT;
2141
2142         len = min_t(unsigned int, len, sizeof(int));
2143
2144         if (len < 0)
2145                 return -EINVAL;
2146
2147         err = -ENOTCONN;
2148         if (sk->sk_user_data == NULL)
2149                 goto end;
2150
2151         /* Get the session context */
2152         err = -EBADF;
2153         session = pppol2tp_sock_to_session(sk);
2154         if (session == NULL)
2155                 goto end;
2156
2157         /* Special case: if session_id == 0x0000, treat as operation on tunnel */
2158         if ((session->tunnel_addr.s_session == 0) &&
2159             (session->tunnel_addr.d_session == 0)) {
2160                 err = -EBADF;
2161                 tunnel = pppol2tp_sock_to_tunnel(session->tunnel_sock);
2162                 if (tunnel == NULL)
2163                         goto end;
2164
2165                 err = pppol2tp_tunnel_getsockopt(sk, tunnel, optname, &val);
2166         } else
2167                 err = pppol2tp_session_getsockopt(sk, session, optname, &val);
2168
2169         err = -EFAULT;
2170         if (put_user(len, (int __user *) optlen))
2171                 goto end;
2172
2173         if (copy_to_user((void __user *) optval, &val, len))
2174                 goto end;
2175
2176         err = 0;
2177 end:
2178         return err;
2179 }
2180
2181 /*****************************************************************************
2182  * /proc filesystem for debug
2183  *****************************************************************************/
2184
2185 #ifdef CONFIG_PROC_FS
2186
2187 #include <linux/seq_file.h>
2188
2189 struct pppol2tp_seq_data {
2190         struct pppol2tp_tunnel *tunnel; /* current tunnel */
2191         struct pppol2tp_session *session; /* NULL means get first session in tunnel */
2192 };
2193
2194 static struct pppol2tp_session *next_session(struct pppol2tp_tunnel *tunnel, struct pppol2tp_session *curr)
2195 {
2196         struct pppol2tp_session *session = NULL;
2197         struct hlist_node *walk;
2198         int found = 0;
2199         int next = 0;
2200         int i;
2201
2202         read_lock(&tunnel->hlist_lock);
2203         for (i = 0; i < PPPOL2TP_HASH_SIZE; i++) {
2204                 hlist_for_each_entry(session, walk, &tunnel->session_hlist[i], hlist) {
2205                         if (curr == NULL) {
2206                                 found = 1;
2207                                 goto out;
2208                         }
2209                         if (session == curr) {
2210                                 next = 1;
2211                                 continue;
2212                         }
2213                         if (next) {
2214                                 found = 1;
2215                                 goto out;
2216                         }
2217                 }
2218         }
2219 out:
2220         read_unlock(&tunnel->hlist_lock);
2221         if (!found)
2222                 session = NULL;
2223
2224         return session;
2225 }
2226
2227 static struct pppol2tp_tunnel *next_tunnel(struct pppol2tp_tunnel *curr)
2228 {
2229         struct pppol2tp_tunnel *tunnel = NULL;
2230
2231         read_lock(&pppol2tp_tunnel_list_lock);
2232         if (list_is_last(&curr->list, &pppol2tp_tunnel_list)) {
2233                 goto out;
2234         }
2235         tunnel = list_entry(curr->list.next, struct pppol2tp_tunnel, list);
2236 out:
2237         read_unlock(&pppol2tp_tunnel_list_lock);
2238
2239         return tunnel;
2240 }
2241
2242 static void *pppol2tp_seq_start(struct seq_file *m, loff_t *offs)
2243 {
2244         struct pppol2tp_seq_data *pd = SEQ_START_TOKEN;
2245         loff_t pos = *offs;
2246
2247         if (!pos)
2248                 goto out;
2249
2250         BUG_ON(m->private == NULL);
2251         pd = m->private;
2252
2253         if (pd->tunnel == NULL) {
2254                 if (!list_empty(&pppol2tp_tunnel_list))
2255                         pd->tunnel = list_entry(pppol2tp_tunnel_list.next, struct pppol2tp_tunnel, list);
2256         } else {
2257                 pd->session = next_session(pd->tunnel, pd->session);
2258                 if (pd->session == NULL) {
2259                         pd->tunnel = next_tunnel(pd->tunnel);
2260                 }
2261         }
2262
2263         /* NULL tunnel and session indicates end of list */
2264         if ((pd->tunnel == NULL) && (pd->session == NULL))
2265                 pd = NULL;
2266
2267 out:
2268         return pd;
2269 }
2270
2271 static void *pppol2tp_seq_next(struct seq_file *m, void *v, loff_t *pos)
2272 {
2273         (*pos)++;
2274         return NULL;
2275 }
2276
2277 static void pppol2tp_seq_stop(struct seq_file *p, void *v)
2278 {
2279         /* nothing to do */
2280 }
2281
2282 static void pppol2tp_seq_tunnel_show(struct seq_file *m, void *v)
2283 {
2284         struct pppol2tp_tunnel *tunnel = v;
2285
2286         seq_printf(m, "\nTUNNEL '%s', %c %d\n",
2287                    tunnel->name,
2288                    (tunnel == tunnel->sock->sk_user_data) ? 'Y':'N',
2289                    atomic_read(&tunnel->ref_count) - 1);
2290         seq_printf(m, " %08x %llu/%llu/%llu %llu/%llu/%llu\n",
2291                    tunnel->debug,
2292                    tunnel->stats.tx_packets, tunnel->stats.tx_bytes,
2293                    tunnel->stats.tx_errors,
2294                    tunnel->stats.rx_packets, tunnel->stats.rx_bytes,
2295                    tunnel->stats.rx_errors);
2296 }
2297
2298 static void pppol2tp_seq_session_show(struct seq_file *m, void *v)
2299 {
2300         struct pppol2tp_session *session = v;
2301
2302         seq_printf(m, "  SESSION '%s' %08X/%d %04X/%04X -> "
2303                    "%04X/%04X %d %c\n",
2304                    session->name,
2305                    ntohl(session->tunnel_addr.addr.sin_addr.s_addr),
2306                    ntohs(session->tunnel_addr.addr.sin_port),
2307                    session->tunnel_addr.s_tunnel,
2308                    session->tunnel_addr.s_session,
2309                    session->tunnel_addr.d_tunnel,
2310                    session->tunnel_addr.d_session,
2311                    session->sock->sk_state,
2312                    (session == session->sock->sk_user_data) ?
2313                    'Y' : 'N');
2314         seq_printf(m, "   %d/%d/%c/%c/%s %08x %u\n",
2315                    session->mtu, session->mru,
2316                    session->recv_seq ? 'R' : '-',
2317                    session->send_seq ? 'S' : '-',
2318                    session->lns_mode ? "LNS" : "LAC",
2319                    session->debug,
2320                    jiffies_to_msecs(session->reorder_timeout));
2321         seq_printf(m, "   %hu/%hu %llu/%llu/%llu %llu/%llu/%llu\n",
2322                    session->nr, session->ns,
2323                    session->stats.tx_packets,
2324                    session->stats.tx_bytes,
2325                    session->stats.tx_errors,
2326                    session->stats.rx_packets,
2327                    session->stats.rx_bytes,
2328                    session->stats.rx_errors);
2329 }
2330
2331 static int pppol2tp_seq_show(struct seq_file *m, void *v)
2332 {
2333         struct pppol2tp_seq_data *pd = v;
2334
2335         /* display header on line 1 */
2336         if (v == SEQ_START_TOKEN) {
2337                 seq_puts(m, "PPPoL2TP driver info, " PPPOL2TP_DRV_VERSION "\n");
2338                 seq_puts(m, "TUNNEL name, user-data-ok session-count\n");
2339                 seq_puts(m, " debug tx-pkts/bytes/errs rx-pkts/bytes/errs\n");
2340                 seq_puts(m, "  SESSION name, addr/port src-tid/sid "
2341                          "dest-tid/sid state user-data-ok\n");
2342                 seq_puts(m, "   mtu/mru/rcvseq/sendseq/lns debug reorderto\n");
2343                 seq_puts(m, "   nr/ns tx-pkts/bytes/errs rx-pkts/bytes/errs\n");
2344                 goto out;
2345         }
2346
2347         /* Show the tunnel or session context.
2348          */
2349         if (pd->session == NULL)
2350                 pppol2tp_seq_tunnel_show(m, pd->tunnel);
2351         else
2352                 pppol2tp_seq_session_show(m, pd->session);
2353
2354 out:
2355         return 0;
2356 }
2357
2358 static struct seq_operations pppol2tp_seq_ops = {
2359         .start          = pppol2tp_seq_start,
2360         .next           = pppol2tp_seq_next,
2361         .stop           = pppol2tp_seq_stop,
2362         .show           = pppol2tp_seq_show,
2363 };
2364
2365 /* Called when our /proc file is opened. We allocate data for use when
2366  * iterating our tunnel / session contexts and store it in the private
2367  * data of the seq_file.
2368  */
2369 static int pppol2tp_proc_open(struct inode *inode, struct file *file)
2370 {
2371         struct seq_file *m;
2372         struct pppol2tp_seq_data *pd;
2373         int ret = 0;
2374
2375         ret = seq_open(file, &pppol2tp_seq_ops);
2376         if (ret < 0)
2377                 goto out;
2378
2379         m = file->private_data;
2380
2381         /* Allocate and fill our proc_data for access later */
2382         ret = -ENOMEM;
2383         m->private = kzalloc(sizeof(struct pppol2tp_seq_data), GFP_KERNEL);
2384         if (m->private == NULL)
2385                 goto out;
2386
2387         pd = m->private;
2388         ret = 0;
2389
2390 out:
2391         return ret;
2392 }
2393
2394 /* Called when /proc file access completes.
2395  */
2396 static int pppol2tp_proc_release(struct inode *inode, struct file *file)
2397 {
2398         struct seq_file *m = (struct seq_file *)file->private_data;
2399
2400         kfree(m->private);
2401         m->private = NULL;
2402
2403         return seq_release(inode, file);
2404 }
2405
2406 static struct file_operations pppol2tp_proc_fops = {
2407         .owner          = THIS_MODULE,
2408         .open           = pppol2tp_proc_open,
2409         .read           = seq_read,
2410         .llseek         = seq_lseek,
2411         .release        = pppol2tp_proc_release,
2412 };
2413
2414 static struct proc_dir_entry *pppol2tp_proc;
2415
2416 #endif /* CONFIG_PROC_FS */
2417
2418 /*****************************************************************************
2419  * Init and cleanup
2420  *****************************************************************************/
2421
2422 static struct proto_ops pppol2tp_ops = {
2423         .family         = AF_PPPOX,
2424         .owner          = THIS_MODULE,
2425         .release        = pppol2tp_release,
2426         .bind           = sock_no_bind,
2427         .connect        = pppol2tp_connect,
2428         .socketpair     = sock_no_socketpair,
2429         .accept         = sock_no_accept,
2430         .getname        = pppol2tp_getname,
2431         .poll           = datagram_poll,
2432         .listen         = sock_no_listen,
2433         .shutdown       = sock_no_shutdown,
2434         .setsockopt     = pppol2tp_setsockopt,
2435         .getsockopt     = pppol2tp_getsockopt,
2436         .sendmsg        = pppol2tp_sendmsg,
2437         .recvmsg        = pppol2tp_recvmsg,
2438         .mmap           = sock_no_mmap,
2439         .ioctl          = pppox_ioctl,
2440 };
2441
2442 static struct pppox_proto pppol2tp_proto = {
2443         .create         = pppol2tp_create,
2444         .ioctl          = pppol2tp_ioctl
2445 };
2446
2447 static int __init pppol2tp_init(void)
2448 {
2449         int err;
2450
2451         err = proto_register(&pppol2tp_sk_proto, 0);
2452         if (err)
2453                 goto out;
2454         err = register_pppox_proto(PX_PROTO_OL2TP, &pppol2tp_proto);
2455         if (err)
2456                 goto out_unregister_pppol2tp_proto;
2457
2458 #ifdef CONFIG_PROC_FS
2459         pppol2tp_proc = create_proc_entry("pppol2tp", 0, proc_net);
2460         if (!pppol2tp_proc) {
2461                 err = -ENOMEM;
2462                 goto out_unregister_pppox_proto;
2463         }
2464         pppol2tp_proc->proc_fops = &pppol2tp_proc_fops;
2465 #endif /* CONFIG_PROC_FS */
2466         printk(KERN_INFO "PPPoL2TP kernel driver, %s\n",
2467                PPPOL2TP_DRV_VERSION);
2468
2469 out:
2470         return err;
2471
2472 out_unregister_pppox_proto:
2473         unregister_pppox_proto(PX_PROTO_OL2TP);
2474 out_unregister_pppol2tp_proto:
2475         proto_unregister(&pppol2tp_sk_proto);
2476         goto out;
2477 }
2478
2479 static void __exit pppol2tp_exit(void)
2480 {
2481         unregister_pppox_proto(PX_PROTO_OL2TP);
2482
2483 #ifdef CONFIG_PROC_FS
2484         remove_proc_entry("pppol2tp", proc_net);
2485 #endif
2486         proto_unregister(&pppol2tp_sk_proto);
2487 }
2488
2489 module_init(pppol2tp_init);
2490 module_exit(pppol2tp_exit);
2491
2492 MODULE_AUTHOR("Martijn van Oosterhout <kleptog@svana.org>,"
2493               "James Chapman <jchapman@katalix.com>");
2494 MODULE_DESCRIPTION("PPP over L2TP over UDP");
2495 MODULE_LICENSE("GPL");
2496 MODULE_VERSION(PPPOL2TP_DRV_VERSION);