xref: /openbmc/linux/drivers/net/ppp/pppoe.c (revision 029f7f3b8701cc7aca8bdb31f0c7edd6a479e357)
1 /** -*- linux-c -*- ***********************************************************
2  * Linux PPP over Ethernet (PPPoX/PPPoE) Sockets
3  *
4  * PPPoX --- Generic PPP encapsulation socket family
5  * PPPoE --- PPP over Ethernet (RFC 2516)
6  *
7  *
8  * Version:	0.7.0
9  *
10  * 070228 :	Fix to allow multiple sessions with same remote MAC and same
11  *		session id by including the local device ifindex in the
12  *		tuple identifying a session. This also ensures packets can't
13  *		be injected into a session from interfaces other than the one
14  *		specified by userspace. Florian Zumbiehl <florz@florz.de>
15  *		(Oh, BTW, this one is YYMMDD, in case you were wondering ...)
16  * 220102 :	Fix module use count on failure in pppoe_create, pppox_sk -acme
17  * 030700 :	Fixed connect logic to allow for disconnect.
18  * 270700 :	Fixed potential SMP problems; we must protect against
19  *		simultaneous invocation of ppp_input
20  *		and ppp_unregister_channel.
21  * 040800 :	Respect reference count mechanisms on net-devices.
22  * 200800 :	fix kfree(skb) in pppoe_rcv (acme)
23  *		Module reference count is decremented in the right spot now,
24  *		guards against sock_put not actually freeing the sk
25  *		in pppoe_release.
26  * 051000 :	Initialization cleanup.
27  * 111100 :	Fix recvmsg.
28  * 050101 :	Fix PADT procesing.
29  * 140501 :	Use pppoe_rcv_core to handle all backlog. (Alexey)
30  * 170701 :	Do not lock_sock with rwlock held. (DaveM)
31  *		Ignore discovery frames if user has socket
32  *		locked. (DaveM)
33  *		Ignore return value of dev_queue_xmit in __pppoe_xmit
34  *		or else we may kfree an SKB twice. (DaveM)
35  * 190701 :	When doing copies of skb's in __pppoe_xmit, always delete
36  *		the original skb that was passed in on success, never on
37  *		failure.  Delete the copy of the skb on failure to avoid
38  *		a memory leak.
39  * 081001 :	Misc. cleanup (licence string, non-blocking, prevent
40  *		reference of device on close).
41  * 121301 :	New ppp channels interface; cannot unregister a channel
42  *		from interrupts.  Thus, we mark the socket as a ZOMBIE
43  *		and do the unregistration later.
44  * 081002 :	seq_file support for proc stuff -acme
45  * 111602 :	Merge all 2.4 fixes into 2.5/2.6 tree.  Label 2.5/2.6
46  *		as version 0.7.  Spacing cleanup.
47  * Author:	Michal Ostrowski <mostrows@speakeasy.net>
48  * Contributors:
49  * 		Arnaldo Carvalho de Melo <acme@conectiva.com.br>
50  *		David S. Miller (davem@redhat.com)
51  *
52  * License:
53  *		This program is free software; you can redistribute it and/or
54  *		modify it under the terms of the GNU General Public License
55  *		as published by the Free Software Foundation; either version
56  *		2 of the License, or (at your option) any later version.
57  *
58  */
59 
60 #include <linux/string.h>
61 #include <linux/module.h>
62 #include <linux/kernel.h>
63 #include <linux/slab.h>
64 #include <linux/errno.h>
65 #include <linux/netdevice.h>
66 #include <linux/net.h>
67 #include <linux/inetdevice.h>
68 #include <linux/etherdevice.h>
69 #include <linux/skbuff.h>
70 #include <linux/init.h>
71 #include <linux/if_ether.h>
72 #include <linux/if_pppox.h>
73 #include <linux/ppp_channel.h>
74 #include <linux/ppp_defs.h>
75 #include <linux/ppp-ioctl.h>
76 #include <linux/notifier.h>
77 #include <linux/file.h>
78 #include <linux/proc_fs.h>
79 #include <linux/seq_file.h>
80 
81 #include <linux/nsproxy.h>
82 #include <net/net_namespace.h>
83 #include <net/netns/generic.h>
84 #include <net/sock.h>
85 
86 #include <asm/uaccess.h>
87 
88 #define PPPOE_HASH_BITS 4
89 #define PPPOE_HASH_SIZE (1 << PPPOE_HASH_BITS)
90 #define PPPOE_HASH_MASK	(PPPOE_HASH_SIZE - 1)
91 
92 static int __pppoe_xmit(struct sock *sk, struct sk_buff *skb);
93 
94 static const struct proto_ops pppoe_ops;
95 static const struct ppp_channel_ops pppoe_chan_ops;
96 
97 /* per-net private data for this module */
98 static int pppoe_net_id __read_mostly;
99 struct pppoe_net {
100 	/*
101 	 * we could use _single_ hash table for all
102 	 * nets by injecting net id into the hash but
103 	 * it would increase hash chains and add
104 	 * a few additional math comparations messy
105 	 * as well, moreover in case of SMP less locking
106 	 * controversy here
107 	 */
108 	struct pppox_sock *hash_table[PPPOE_HASH_SIZE];
109 	rwlock_t hash_lock;
110 };
111 
112 /*
113  * PPPoE could be in the following stages:
114  * 1) Discovery stage (to obtain remote MAC and Session ID)
115  * 2) Session stage (MAC and SID are known)
116  *
117  * Ethernet frames have a special tag for this but
118  * we use simpler approach based on session id
119  */
120 static inline bool stage_session(__be16 sid)
121 {
122 	return sid != 0;
123 }
124 
125 static inline struct pppoe_net *pppoe_pernet(struct net *net)
126 {
127 	BUG_ON(!net);
128 
129 	return net_generic(net, pppoe_net_id);
130 }
131 
132 static inline int cmp_2_addr(struct pppoe_addr *a, struct pppoe_addr *b)
133 {
134 	return a->sid == b->sid && ether_addr_equal(a->remote, b->remote);
135 }
136 
137 static inline int cmp_addr(struct pppoe_addr *a, __be16 sid, char *addr)
138 {
139 	return a->sid == sid && ether_addr_equal(a->remote, addr);
140 }
141 
142 #if 8 % PPPOE_HASH_BITS
143 #error 8 must be a multiple of PPPOE_HASH_BITS
144 #endif
145 
146 static int hash_item(__be16 sid, unsigned char *addr)
147 {
148 	unsigned char hash = 0;
149 	unsigned int i;
150 
151 	for (i = 0; i < ETH_ALEN; i++)
152 		hash ^= addr[i];
153 	for (i = 0; i < sizeof(sid_t) * 8; i += 8)
154 		hash ^= (__force __u32)sid >> i;
155 	for (i = 8; (i >>= 1) >= PPPOE_HASH_BITS;)
156 		hash ^= hash >> i;
157 
158 	return hash & PPPOE_HASH_MASK;
159 }
160 
161 /**********************************************************************
162  *
163  *  Set/get/delete/rehash items  (internal versions)
164  *
165  **********************************************************************/
166 static struct pppox_sock *__get_item(struct pppoe_net *pn, __be16 sid,
167 				unsigned char *addr, int ifindex)
168 {
169 	int hash = hash_item(sid, addr);
170 	struct pppox_sock *ret;
171 
172 	ret = pn->hash_table[hash];
173 	while (ret) {
174 		if (cmp_addr(&ret->pppoe_pa, sid, addr) &&
175 		    ret->pppoe_ifindex == ifindex)
176 			return ret;
177 
178 		ret = ret->next;
179 	}
180 
181 	return NULL;
182 }
183 
184 static int __set_item(struct pppoe_net *pn, struct pppox_sock *po)
185 {
186 	int hash = hash_item(po->pppoe_pa.sid, po->pppoe_pa.remote);
187 	struct pppox_sock *ret;
188 
189 	ret = pn->hash_table[hash];
190 	while (ret) {
191 		if (cmp_2_addr(&ret->pppoe_pa, &po->pppoe_pa) &&
192 		    ret->pppoe_ifindex == po->pppoe_ifindex)
193 			return -EALREADY;
194 
195 		ret = ret->next;
196 	}
197 
198 	po->next = pn->hash_table[hash];
199 	pn->hash_table[hash] = po;
200 
201 	return 0;
202 }
203 
204 static void __delete_item(struct pppoe_net *pn, __be16 sid,
205 					char *addr, int ifindex)
206 {
207 	int hash = hash_item(sid, addr);
208 	struct pppox_sock *ret, **src;
209 
210 	ret = pn->hash_table[hash];
211 	src = &pn->hash_table[hash];
212 
213 	while (ret) {
214 		if (cmp_addr(&ret->pppoe_pa, sid, addr) &&
215 		    ret->pppoe_ifindex == ifindex) {
216 			*src = ret->next;
217 			break;
218 		}
219 
220 		src = &ret->next;
221 		ret = ret->next;
222 	}
223 }
224 
225 /**********************************************************************
226  *
227  *  Set/get/delete/rehash items
228  *
229  **********************************************************************/
230 static inline struct pppox_sock *get_item(struct pppoe_net *pn, __be16 sid,
231 					unsigned char *addr, int ifindex)
232 {
233 	struct pppox_sock *po;
234 
235 	read_lock_bh(&pn->hash_lock);
236 	po = __get_item(pn, sid, addr, ifindex);
237 	if (po)
238 		sock_hold(sk_pppox(po));
239 	read_unlock_bh(&pn->hash_lock);
240 
241 	return po;
242 }
243 
244 static inline struct pppox_sock *get_item_by_addr(struct net *net,
245 						struct sockaddr_pppox *sp)
246 {
247 	struct net_device *dev;
248 	struct pppoe_net *pn;
249 	struct pppox_sock *pppox_sock = NULL;
250 
251 	int ifindex;
252 
253 	rcu_read_lock();
254 	dev = dev_get_by_name_rcu(net, sp->sa_addr.pppoe.dev);
255 	if (dev) {
256 		ifindex = dev->ifindex;
257 		pn = pppoe_pernet(net);
258 		pppox_sock = get_item(pn, sp->sa_addr.pppoe.sid,
259 				sp->sa_addr.pppoe.remote, ifindex);
260 	}
261 	rcu_read_unlock();
262 	return pppox_sock;
263 }
264 
265 static inline void delete_item(struct pppoe_net *pn, __be16 sid,
266 					char *addr, int ifindex)
267 {
268 	write_lock_bh(&pn->hash_lock);
269 	__delete_item(pn, sid, addr, ifindex);
270 	write_unlock_bh(&pn->hash_lock);
271 }
272 
273 /***************************************************************************
274  *
275  *  Handler for device events.
276  *  Certain device events require that sockets be unconnected.
277  *
278  **************************************************************************/
279 
280 static void pppoe_flush_dev(struct net_device *dev)
281 {
282 	struct pppoe_net *pn;
283 	int i;
284 
285 	pn = pppoe_pernet(dev_net(dev));
286 	write_lock_bh(&pn->hash_lock);
287 	for (i = 0; i < PPPOE_HASH_SIZE; i++) {
288 		struct pppox_sock *po = pn->hash_table[i];
289 		struct sock *sk;
290 
291 		while (po) {
292 			while (po && po->pppoe_dev != dev) {
293 				po = po->next;
294 			}
295 
296 			if (!po)
297 				break;
298 
299 			sk = sk_pppox(po);
300 
301 			/* We always grab the socket lock, followed by the
302 			 * hash_lock, in that order.  Since we should hold the
303 			 * sock lock while doing any unbinding, we need to
304 			 * release the lock we're holding.  Hold a reference to
305 			 * the sock so it doesn't disappear as we're jumping
306 			 * between locks.
307 			 */
308 
309 			sock_hold(sk);
310 			write_unlock_bh(&pn->hash_lock);
311 			lock_sock(sk);
312 
313 			if (po->pppoe_dev == dev &&
314 			    sk->sk_state & (PPPOX_CONNECTED | PPPOX_BOUND)) {
315 				pppox_unbind_sock(sk);
316 				sk->sk_state_change(sk);
317 				po->pppoe_dev = NULL;
318 				dev_put(dev);
319 			}
320 
321 			release_sock(sk);
322 			sock_put(sk);
323 
324 			/* Restart the process from the start of the current
325 			 * hash chain. We dropped locks so the world may have
326 			 * change from underneath us.
327 			 */
328 
329 			BUG_ON(pppoe_pernet(dev_net(dev)) == NULL);
330 			write_lock_bh(&pn->hash_lock);
331 			po = pn->hash_table[i];
332 		}
333 	}
334 	write_unlock_bh(&pn->hash_lock);
335 }
336 
337 static int pppoe_device_event(struct notifier_block *this,
338 			      unsigned long event, void *ptr)
339 {
340 	struct net_device *dev = netdev_notifier_info_to_dev(ptr);
341 
342 	/* Only look at sockets that are using this specific device. */
343 	switch (event) {
344 	case NETDEV_CHANGEADDR:
345 	case NETDEV_CHANGEMTU:
346 		/* A change in mtu or address is a bad thing, requiring
347 		 * LCP re-negotiation.
348 		 */
349 
350 	case NETDEV_GOING_DOWN:
351 	case NETDEV_DOWN:
352 		/* Find every socket on this device and kill it. */
353 		pppoe_flush_dev(dev);
354 		break;
355 
356 	default:
357 		break;
358 	}
359 
360 	return NOTIFY_DONE;
361 }
362 
363 static struct notifier_block pppoe_notifier = {
364 	.notifier_call = pppoe_device_event,
365 };
366 
367 /************************************************************************
368  *
369  * Do the real work of receiving a PPPoE Session frame.
370  *
371  ***********************************************************************/
372 static int pppoe_rcv_core(struct sock *sk, struct sk_buff *skb)
373 {
374 	struct pppox_sock *po = pppox_sk(sk);
375 	struct pppox_sock *relay_po;
376 
377 	/* Backlog receive. Semantics of backlog rcv preclude any code from
378 	 * executing in lock_sock()/release_sock() bounds; meaning sk->sk_state
379 	 * can't change.
380 	 */
381 
382 	if (skb->pkt_type == PACKET_OTHERHOST)
383 		goto abort_kfree;
384 
385 	if (sk->sk_state & PPPOX_BOUND) {
386 		ppp_input(&po->chan, skb);
387 	} else if (sk->sk_state & PPPOX_RELAY) {
388 		relay_po = get_item_by_addr(sock_net(sk),
389 					    &po->pppoe_relay);
390 		if (relay_po == NULL)
391 			goto abort_kfree;
392 
393 		if ((sk_pppox(relay_po)->sk_state & PPPOX_CONNECTED) == 0)
394 			goto abort_put;
395 
396 		if (!__pppoe_xmit(sk_pppox(relay_po), skb))
397 			goto abort_put;
398 	} else {
399 		if (sock_queue_rcv_skb(sk, skb))
400 			goto abort_kfree;
401 	}
402 
403 	return NET_RX_SUCCESS;
404 
405 abort_put:
406 	sock_put(sk_pppox(relay_po));
407 
408 abort_kfree:
409 	kfree_skb(skb);
410 	return NET_RX_DROP;
411 }
412 
413 /************************************************************************
414  *
415  * Receive wrapper called in BH context.
416  *
417  ***********************************************************************/
418 static int pppoe_rcv(struct sk_buff *skb, struct net_device *dev,
419 		     struct packet_type *pt, struct net_device *orig_dev)
420 {
421 	struct pppoe_hdr *ph;
422 	struct pppox_sock *po;
423 	struct pppoe_net *pn;
424 	int len;
425 
426 	skb = skb_share_check(skb, GFP_ATOMIC);
427 	if (!skb)
428 		goto out;
429 
430 	if (!pskb_may_pull(skb, sizeof(struct pppoe_hdr)))
431 		goto drop;
432 
433 	ph = pppoe_hdr(skb);
434 	len = ntohs(ph->length);
435 
436 	skb_pull_rcsum(skb, sizeof(*ph));
437 	if (skb->len < len)
438 		goto drop;
439 
440 	if (pskb_trim_rcsum(skb, len))
441 		goto drop;
442 
443 	pn = pppoe_pernet(dev_net(dev));
444 
445 	/* Note that get_item does a sock_hold(), so sk_pppox(po)
446 	 * is known to be safe.
447 	 */
448 	po = get_item(pn, ph->sid, eth_hdr(skb)->h_source, dev->ifindex);
449 	if (!po)
450 		goto drop;
451 
452 	return sk_receive_skb(sk_pppox(po), skb, 0);
453 
454 drop:
455 	kfree_skb(skb);
456 out:
457 	return NET_RX_DROP;
458 }
459 
460 static void pppoe_unbind_sock_work(struct work_struct *work)
461 {
462 	struct pppox_sock *po = container_of(work, struct pppox_sock,
463 					     proto.pppoe.padt_work);
464 	struct sock *sk = sk_pppox(po);
465 
466 	lock_sock(sk);
467 	if (po->pppoe_dev) {
468 		dev_put(po->pppoe_dev);
469 		po->pppoe_dev = NULL;
470 	}
471 	pppox_unbind_sock(sk);
472 	release_sock(sk);
473 	sock_put(sk);
474 }
475 
476 /************************************************************************
477  *
478  * Receive a PPPoE Discovery frame.
479  * This is solely for detection of PADT frames
480  *
481  ***********************************************************************/
482 static int pppoe_disc_rcv(struct sk_buff *skb, struct net_device *dev,
483 			  struct packet_type *pt, struct net_device *orig_dev)
484 
485 {
486 	struct pppoe_hdr *ph;
487 	struct pppox_sock *po;
488 	struct pppoe_net *pn;
489 
490 	skb = skb_share_check(skb, GFP_ATOMIC);
491 	if (!skb)
492 		goto out;
493 
494 	if (!pskb_may_pull(skb, sizeof(struct pppoe_hdr)))
495 		goto abort;
496 
497 	ph = pppoe_hdr(skb);
498 	if (ph->code != PADT_CODE)
499 		goto abort;
500 
501 	pn = pppoe_pernet(dev_net(dev));
502 	po = get_item(pn, ph->sid, eth_hdr(skb)->h_source, dev->ifindex);
503 	if (po)
504 		if (!schedule_work(&po->proto.pppoe.padt_work))
505 			sock_put(sk_pppox(po));
506 
507 abort:
508 	kfree_skb(skb);
509 out:
510 	return NET_RX_SUCCESS; /* Lies... :-) */
511 }
512 
513 static struct packet_type pppoes_ptype __read_mostly = {
514 	.type	= cpu_to_be16(ETH_P_PPP_SES),
515 	.func	= pppoe_rcv,
516 };
517 
518 static struct packet_type pppoed_ptype __read_mostly = {
519 	.type	= cpu_to_be16(ETH_P_PPP_DISC),
520 	.func	= pppoe_disc_rcv,
521 };
522 
523 static struct proto pppoe_sk_proto __read_mostly = {
524 	.name	  = "PPPOE",
525 	.owner	  = THIS_MODULE,
526 	.obj_size = sizeof(struct pppox_sock),
527 };
528 
529 /***********************************************************************
530  *
531  * Initialize a new struct sock.
532  *
533  **********************************************************************/
534 static int pppoe_create(struct net *net, struct socket *sock, int kern)
535 {
536 	struct sock *sk;
537 
538 	sk = sk_alloc(net, PF_PPPOX, GFP_KERNEL, &pppoe_sk_proto, kern);
539 	if (!sk)
540 		return -ENOMEM;
541 
542 	sock_init_data(sock, sk);
543 
544 	sock->state	= SS_UNCONNECTED;
545 	sock->ops	= &pppoe_ops;
546 
547 	sk->sk_backlog_rcv	= pppoe_rcv_core;
548 	sk->sk_state		= PPPOX_NONE;
549 	sk->sk_type		= SOCK_STREAM;
550 	sk->sk_family		= PF_PPPOX;
551 	sk->sk_protocol		= PX_PROTO_OE;
552 
553 	return 0;
554 }
555 
556 static int pppoe_release(struct socket *sock)
557 {
558 	struct sock *sk = sock->sk;
559 	struct pppox_sock *po;
560 	struct pppoe_net *pn;
561 	struct net *net = NULL;
562 
563 	if (!sk)
564 		return 0;
565 
566 	lock_sock(sk);
567 	if (sock_flag(sk, SOCK_DEAD)) {
568 		release_sock(sk);
569 		return -EBADF;
570 	}
571 
572 	po = pppox_sk(sk);
573 
574 	if (po->pppoe_dev) {
575 		dev_put(po->pppoe_dev);
576 		po->pppoe_dev = NULL;
577 	}
578 
579 	pppox_unbind_sock(sk);
580 
581 	/* Signal the death of the socket. */
582 	sk->sk_state = PPPOX_DEAD;
583 
584 	net = sock_net(sk);
585 	pn = pppoe_pernet(net);
586 
587 	/*
588 	 * protect "po" from concurrent updates
589 	 * on pppoe_flush_dev
590 	 */
591 	delete_item(pn, po->pppoe_pa.sid, po->pppoe_pa.remote,
592 		    po->pppoe_ifindex);
593 
594 	sock_orphan(sk);
595 	sock->sk = NULL;
596 
597 	skb_queue_purge(&sk->sk_receive_queue);
598 	release_sock(sk);
599 	sock_put(sk);
600 
601 	return 0;
602 }
603 
604 static int pppoe_connect(struct socket *sock, struct sockaddr *uservaddr,
605 		  int sockaddr_len, int flags)
606 {
607 	struct sock *sk = sock->sk;
608 	struct sockaddr_pppox *sp = (struct sockaddr_pppox *)uservaddr;
609 	struct pppox_sock *po = pppox_sk(sk);
610 	struct net_device *dev = NULL;
611 	struct pppoe_net *pn;
612 	struct net *net = NULL;
613 	int error;
614 
615 	lock_sock(sk);
616 
617 	INIT_WORK(&po->proto.pppoe.padt_work, pppoe_unbind_sock_work);
618 
619 	error = -EINVAL;
620 	if (sp->sa_protocol != PX_PROTO_OE)
621 		goto end;
622 
623 	/* Check for already bound sockets */
624 	error = -EBUSY;
625 	if ((sk->sk_state & PPPOX_CONNECTED) &&
626 	     stage_session(sp->sa_addr.pppoe.sid))
627 		goto end;
628 
629 	/* Check for already disconnected sockets, on attempts to disconnect */
630 	error = -EALREADY;
631 	if ((sk->sk_state & PPPOX_DEAD) &&
632 	     !stage_session(sp->sa_addr.pppoe.sid))
633 		goto end;
634 
635 	error = 0;
636 
637 	/* Delete the old binding */
638 	if (stage_session(po->pppoe_pa.sid)) {
639 		pppox_unbind_sock(sk);
640 		pn = pppoe_pernet(sock_net(sk));
641 		delete_item(pn, po->pppoe_pa.sid,
642 			    po->pppoe_pa.remote, po->pppoe_ifindex);
643 		if (po->pppoe_dev) {
644 			dev_put(po->pppoe_dev);
645 			po->pppoe_dev = NULL;
646 		}
647 
648 		memset(sk_pppox(po) + 1, 0,
649 		       sizeof(struct pppox_sock) - sizeof(struct sock));
650 		sk->sk_state = PPPOX_NONE;
651 	}
652 
653 	/* Re-bind in session stage only */
654 	if (stage_session(sp->sa_addr.pppoe.sid)) {
655 		error = -ENODEV;
656 		net = sock_net(sk);
657 		dev = dev_get_by_name(net, sp->sa_addr.pppoe.dev);
658 		if (!dev)
659 			goto err_put;
660 
661 		po->pppoe_dev = dev;
662 		po->pppoe_ifindex = dev->ifindex;
663 		pn = pppoe_pernet(net);
664 		if (!(dev->flags & IFF_UP)) {
665 			goto err_put;
666 		}
667 
668 		memcpy(&po->pppoe_pa,
669 		       &sp->sa_addr.pppoe,
670 		       sizeof(struct pppoe_addr));
671 
672 		write_lock_bh(&pn->hash_lock);
673 		error = __set_item(pn, po);
674 		write_unlock_bh(&pn->hash_lock);
675 		if (error < 0)
676 			goto err_put;
677 
678 		po->chan.hdrlen = (sizeof(struct pppoe_hdr) +
679 				   dev->hard_header_len);
680 
681 		po->chan.mtu = dev->mtu - sizeof(struct pppoe_hdr) - 2;
682 		po->chan.private = sk;
683 		po->chan.ops = &pppoe_chan_ops;
684 
685 		error = ppp_register_net_channel(dev_net(dev), &po->chan);
686 		if (error) {
687 			delete_item(pn, po->pppoe_pa.sid,
688 				    po->pppoe_pa.remote, po->pppoe_ifindex);
689 			goto err_put;
690 		}
691 
692 		sk->sk_state = PPPOX_CONNECTED;
693 	}
694 
695 	po->num = sp->sa_addr.pppoe.sid;
696 
697 end:
698 	release_sock(sk);
699 	return error;
700 err_put:
701 	if (po->pppoe_dev) {
702 		dev_put(po->pppoe_dev);
703 		po->pppoe_dev = NULL;
704 	}
705 	goto end;
706 }
707 
708 static int pppoe_getname(struct socket *sock, struct sockaddr *uaddr,
709 		  int *usockaddr_len, int peer)
710 {
711 	int len = sizeof(struct sockaddr_pppox);
712 	struct sockaddr_pppox sp;
713 
714 	sp.sa_family	= AF_PPPOX;
715 	sp.sa_protocol	= PX_PROTO_OE;
716 	memcpy(&sp.sa_addr.pppoe, &pppox_sk(sock->sk)->pppoe_pa,
717 	       sizeof(struct pppoe_addr));
718 
719 	memcpy(uaddr, &sp, len);
720 
721 	*usockaddr_len = len;
722 
723 	return 0;
724 }
725 
726 static int pppoe_ioctl(struct socket *sock, unsigned int cmd,
727 		unsigned long arg)
728 {
729 	struct sock *sk = sock->sk;
730 	struct pppox_sock *po = pppox_sk(sk);
731 	int val;
732 	int err;
733 
734 	switch (cmd) {
735 	case PPPIOCGMRU:
736 		err = -ENXIO;
737 		if (!(sk->sk_state & PPPOX_CONNECTED))
738 			break;
739 
740 		err = -EFAULT;
741 		if (put_user(po->pppoe_dev->mtu -
742 			     sizeof(struct pppoe_hdr) -
743 			     PPP_HDRLEN,
744 			     (int __user *)arg))
745 			break;
746 		err = 0;
747 		break;
748 
749 	case PPPIOCSMRU:
750 		err = -ENXIO;
751 		if (!(sk->sk_state & PPPOX_CONNECTED))
752 			break;
753 
754 		err = -EFAULT;
755 		if (get_user(val, (int __user *)arg))
756 			break;
757 
758 		if (val < (po->pppoe_dev->mtu
759 			   - sizeof(struct pppoe_hdr)
760 			   - PPP_HDRLEN))
761 			err = 0;
762 		else
763 			err = -EINVAL;
764 		break;
765 
766 	case PPPIOCSFLAGS:
767 		err = -EFAULT;
768 		if (get_user(val, (int __user *)arg))
769 			break;
770 		err = 0;
771 		break;
772 
773 	case PPPOEIOCSFWD:
774 	{
775 		struct pppox_sock *relay_po;
776 
777 		err = -EBUSY;
778 		if (sk->sk_state & (PPPOX_BOUND | PPPOX_DEAD))
779 			break;
780 
781 		err = -ENOTCONN;
782 		if (!(sk->sk_state & PPPOX_CONNECTED))
783 			break;
784 
785 		/* PPPoE address from the user specifies an outbound
786 		   PPPoE address which frames are forwarded to */
787 		err = -EFAULT;
788 		if (copy_from_user(&po->pppoe_relay,
789 				   (void __user *)arg,
790 				   sizeof(struct sockaddr_pppox)))
791 			break;
792 
793 		err = -EINVAL;
794 		if (po->pppoe_relay.sa_family != AF_PPPOX ||
795 		    po->pppoe_relay.sa_protocol != PX_PROTO_OE)
796 			break;
797 
798 		/* Check that the socket referenced by the address
799 		   actually exists. */
800 		relay_po = get_item_by_addr(sock_net(sk), &po->pppoe_relay);
801 		if (!relay_po)
802 			break;
803 
804 		sock_put(sk_pppox(relay_po));
805 		sk->sk_state |= PPPOX_RELAY;
806 		err = 0;
807 		break;
808 	}
809 
810 	case PPPOEIOCDFWD:
811 		err = -EALREADY;
812 		if (!(sk->sk_state & PPPOX_RELAY))
813 			break;
814 
815 		sk->sk_state &= ~PPPOX_RELAY;
816 		err = 0;
817 		break;
818 
819 	default:
820 		err = -ENOTTY;
821 	}
822 
823 	return err;
824 }
825 
826 static int pppoe_sendmsg(struct socket *sock, struct msghdr *m,
827 			 size_t total_len)
828 {
829 	struct sk_buff *skb;
830 	struct sock *sk = sock->sk;
831 	struct pppox_sock *po = pppox_sk(sk);
832 	int error;
833 	struct pppoe_hdr hdr;
834 	struct pppoe_hdr *ph;
835 	struct net_device *dev;
836 	char *start;
837 
838 	lock_sock(sk);
839 	if (sock_flag(sk, SOCK_DEAD) || !(sk->sk_state & PPPOX_CONNECTED)) {
840 		error = -ENOTCONN;
841 		goto end;
842 	}
843 
844 	hdr.ver = 1;
845 	hdr.type = 1;
846 	hdr.code = 0;
847 	hdr.sid = po->num;
848 
849 	dev = po->pppoe_dev;
850 
851 	error = -EMSGSIZE;
852 	if (total_len > (dev->mtu + dev->hard_header_len))
853 		goto end;
854 
855 
856 	skb = sock_wmalloc(sk, total_len + dev->hard_header_len + 32,
857 			   0, GFP_KERNEL);
858 	if (!skb) {
859 		error = -ENOMEM;
860 		goto end;
861 	}
862 
863 	/* Reserve space for headers. */
864 	skb_reserve(skb, dev->hard_header_len);
865 	skb_reset_network_header(skb);
866 
867 	skb->dev = dev;
868 
869 	skb->priority = sk->sk_priority;
870 	skb->protocol = cpu_to_be16(ETH_P_PPP_SES);
871 
872 	ph = (struct pppoe_hdr *)skb_put(skb, total_len + sizeof(struct pppoe_hdr));
873 	start = (char *)&ph->tag[0];
874 
875 	error = memcpy_from_msg(start, m, total_len);
876 	if (error < 0) {
877 		kfree_skb(skb);
878 		goto end;
879 	}
880 
881 	error = total_len;
882 	dev_hard_header(skb, dev, ETH_P_PPP_SES,
883 			po->pppoe_pa.remote, NULL, total_len);
884 
885 	memcpy(ph, &hdr, sizeof(struct pppoe_hdr));
886 
887 	ph->length = htons(total_len);
888 
889 	dev_queue_xmit(skb);
890 
891 end:
892 	release_sock(sk);
893 	return error;
894 }
895 
896 /************************************************************************
897  *
898  * xmit function for internal use.
899  *
900  ***********************************************************************/
901 static int __pppoe_xmit(struct sock *sk, struct sk_buff *skb)
902 {
903 	struct pppox_sock *po = pppox_sk(sk);
904 	struct net_device *dev = po->pppoe_dev;
905 	struct pppoe_hdr *ph;
906 	int data_len = skb->len;
907 
908 	/* The higher-level PPP code (ppp_unregister_channel()) ensures the PPP
909 	 * xmit operations conclude prior to an unregistration call.  Thus
910 	 * sk->sk_state cannot change, so we don't need to do lock_sock().
911 	 * But, we also can't do a lock_sock since that introduces a potential
912 	 * deadlock as we'd reverse the lock ordering used when calling
913 	 * ppp_unregister_channel().
914 	 */
915 
916 	if (sock_flag(sk, SOCK_DEAD) || !(sk->sk_state & PPPOX_CONNECTED))
917 		goto abort;
918 
919 	if (!dev)
920 		goto abort;
921 
922 	/* Copy the data if there is no space for the header or if it's
923 	 * read-only.
924 	 */
925 	if (skb_cow_head(skb, sizeof(*ph) + dev->hard_header_len))
926 		goto abort;
927 
928 	__skb_push(skb, sizeof(*ph));
929 	skb_reset_network_header(skb);
930 
931 	ph = pppoe_hdr(skb);
932 	ph->ver	= 1;
933 	ph->type = 1;
934 	ph->code = 0;
935 	ph->sid	= po->num;
936 	ph->length = htons(data_len);
937 
938 	skb->protocol = cpu_to_be16(ETH_P_PPP_SES);
939 	skb->dev = dev;
940 
941 	dev_hard_header(skb, dev, ETH_P_PPP_SES,
942 			po->pppoe_pa.remote, NULL, data_len);
943 
944 	dev_queue_xmit(skb);
945 	return 1;
946 
947 abort:
948 	kfree_skb(skb);
949 	return 1;
950 }
951 
952 /************************************************************************
953  *
954  * xmit function called by generic PPP driver
955  * sends PPP frame over PPPoE socket
956  *
957  ***********************************************************************/
958 static int pppoe_xmit(struct ppp_channel *chan, struct sk_buff *skb)
959 {
960 	struct sock *sk = (struct sock *)chan->private;
961 	return __pppoe_xmit(sk, skb);
962 }
963 
964 static const struct ppp_channel_ops pppoe_chan_ops = {
965 	.start_xmit = pppoe_xmit,
966 };
967 
968 static int pppoe_recvmsg(struct socket *sock, struct msghdr *m,
969 			 size_t total_len, int flags)
970 {
971 	struct sock *sk = sock->sk;
972 	struct sk_buff *skb;
973 	int error = 0;
974 
975 	if (sk->sk_state & PPPOX_BOUND) {
976 		error = -EIO;
977 		goto end;
978 	}
979 
980 	skb = skb_recv_datagram(sk, flags & ~MSG_DONTWAIT,
981 				flags & MSG_DONTWAIT, &error);
982 	if (error < 0)
983 		goto end;
984 
985 	if (skb) {
986 		total_len = min_t(size_t, total_len, skb->len);
987 		error = skb_copy_datagram_msg(skb, 0, m, total_len);
988 		if (error == 0) {
989 			consume_skb(skb);
990 			return total_len;
991 		}
992 	}
993 
994 	kfree_skb(skb);
995 end:
996 	return error;
997 }
998 
999 #ifdef CONFIG_PROC_FS
1000 static int pppoe_seq_show(struct seq_file *seq, void *v)
1001 {
1002 	struct pppox_sock *po;
1003 	char *dev_name;
1004 
1005 	if (v == SEQ_START_TOKEN) {
1006 		seq_puts(seq, "Id       Address              Device\n");
1007 		goto out;
1008 	}
1009 
1010 	po = v;
1011 	dev_name = po->pppoe_pa.dev;
1012 
1013 	seq_printf(seq, "%08X %pM %8s\n",
1014 		po->pppoe_pa.sid, po->pppoe_pa.remote, dev_name);
1015 out:
1016 	return 0;
1017 }
1018 
1019 static inline struct pppox_sock *pppoe_get_idx(struct pppoe_net *pn, loff_t pos)
1020 {
1021 	struct pppox_sock *po;
1022 	int i;
1023 
1024 	for (i = 0; i < PPPOE_HASH_SIZE; i++) {
1025 		po = pn->hash_table[i];
1026 		while (po) {
1027 			if (!pos--)
1028 				goto out;
1029 			po = po->next;
1030 		}
1031 	}
1032 
1033 out:
1034 	return po;
1035 }
1036 
1037 static void *pppoe_seq_start(struct seq_file *seq, loff_t *pos)
1038 	__acquires(pn->hash_lock)
1039 {
1040 	struct pppoe_net *pn = pppoe_pernet(seq_file_net(seq));
1041 	loff_t l = *pos;
1042 
1043 	read_lock_bh(&pn->hash_lock);
1044 	return l ? pppoe_get_idx(pn, --l) : SEQ_START_TOKEN;
1045 }
1046 
1047 static void *pppoe_seq_next(struct seq_file *seq, void *v, loff_t *pos)
1048 {
1049 	struct pppoe_net *pn = pppoe_pernet(seq_file_net(seq));
1050 	struct pppox_sock *po;
1051 
1052 	++*pos;
1053 	if (v == SEQ_START_TOKEN) {
1054 		po = pppoe_get_idx(pn, 0);
1055 		goto out;
1056 	}
1057 	po = v;
1058 	if (po->next)
1059 		po = po->next;
1060 	else {
1061 		int hash = hash_item(po->pppoe_pa.sid, po->pppoe_pa.remote);
1062 
1063 		po = NULL;
1064 		while (++hash < PPPOE_HASH_SIZE) {
1065 			po = pn->hash_table[hash];
1066 			if (po)
1067 				break;
1068 		}
1069 	}
1070 
1071 out:
1072 	return po;
1073 }
1074 
1075 static void pppoe_seq_stop(struct seq_file *seq, void *v)
1076 	__releases(pn->hash_lock)
1077 {
1078 	struct pppoe_net *pn = pppoe_pernet(seq_file_net(seq));
1079 	read_unlock_bh(&pn->hash_lock);
1080 }
1081 
1082 static const struct seq_operations pppoe_seq_ops = {
1083 	.start		= pppoe_seq_start,
1084 	.next		= pppoe_seq_next,
1085 	.stop		= pppoe_seq_stop,
1086 	.show		= pppoe_seq_show,
1087 };
1088 
1089 static int pppoe_seq_open(struct inode *inode, struct file *file)
1090 {
1091 	return seq_open_net(inode, file, &pppoe_seq_ops,
1092 			sizeof(struct seq_net_private));
1093 }
1094 
1095 static const struct file_operations pppoe_seq_fops = {
1096 	.owner		= THIS_MODULE,
1097 	.open		= pppoe_seq_open,
1098 	.read		= seq_read,
1099 	.llseek		= seq_lseek,
1100 	.release	= seq_release_net,
1101 };
1102 
1103 #endif /* CONFIG_PROC_FS */
1104 
1105 static const struct proto_ops pppoe_ops = {
1106 	.family		= AF_PPPOX,
1107 	.owner		= THIS_MODULE,
1108 	.release	= pppoe_release,
1109 	.bind		= sock_no_bind,
1110 	.connect	= pppoe_connect,
1111 	.socketpair	= sock_no_socketpair,
1112 	.accept		= sock_no_accept,
1113 	.getname	= pppoe_getname,
1114 	.poll		= datagram_poll,
1115 	.listen		= sock_no_listen,
1116 	.shutdown	= sock_no_shutdown,
1117 	.setsockopt	= sock_no_setsockopt,
1118 	.getsockopt	= sock_no_getsockopt,
1119 	.sendmsg	= pppoe_sendmsg,
1120 	.recvmsg	= pppoe_recvmsg,
1121 	.mmap		= sock_no_mmap,
1122 	.ioctl		= pppox_ioctl,
1123 };
1124 
1125 static const struct pppox_proto pppoe_proto = {
1126 	.create	= pppoe_create,
1127 	.ioctl	= pppoe_ioctl,
1128 	.owner	= THIS_MODULE,
1129 };
1130 
1131 static __net_init int pppoe_init_net(struct net *net)
1132 {
1133 	struct pppoe_net *pn = pppoe_pernet(net);
1134 	struct proc_dir_entry *pde;
1135 
1136 	rwlock_init(&pn->hash_lock);
1137 
1138 	pde = proc_create("pppoe", S_IRUGO, net->proc_net, &pppoe_seq_fops);
1139 #ifdef CONFIG_PROC_FS
1140 	if (!pde)
1141 		return -ENOMEM;
1142 #endif
1143 
1144 	return 0;
1145 }
1146 
1147 static __net_exit void pppoe_exit_net(struct net *net)
1148 {
1149 	remove_proc_entry("pppoe", net->proc_net);
1150 }
1151 
1152 static struct pernet_operations pppoe_net_ops = {
1153 	.init = pppoe_init_net,
1154 	.exit = pppoe_exit_net,
1155 	.id   = &pppoe_net_id,
1156 	.size = sizeof(struct pppoe_net),
1157 };
1158 
1159 static int __init pppoe_init(void)
1160 {
1161 	int err;
1162 
1163 	err = register_pernet_device(&pppoe_net_ops);
1164 	if (err)
1165 		goto out;
1166 
1167 	err = proto_register(&pppoe_sk_proto, 0);
1168 	if (err)
1169 		goto out_unregister_net_ops;
1170 
1171 	err = register_pppox_proto(PX_PROTO_OE, &pppoe_proto);
1172 	if (err)
1173 		goto out_unregister_pppoe_proto;
1174 
1175 	dev_add_pack(&pppoes_ptype);
1176 	dev_add_pack(&pppoed_ptype);
1177 	register_netdevice_notifier(&pppoe_notifier);
1178 
1179 	return 0;
1180 
1181 out_unregister_pppoe_proto:
1182 	proto_unregister(&pppoe_sk_proto);
1183 out_unregister_net_ops:
1184 	unregister_pernet_device(&pppoe_net_ops);
1185 out:
1186 	return err;
1187 }
1188 
1189 static void __exit pppoe_exit(void)
1190 {
1191 	unregister_netdevice_notifier(&pppoe_notifier);
1192 	dev_remove_pack(&pppoed_ptype);
1193 	dev_remove_pack(&pppoes_ptype);
1194 	unregister_pppox_proto(PX_PROTO_OE);
1195 	proto_unregister(&pppoe_sk_proto);
1196 	unregister_pernet_device(&pppoe_net_ops);
1197 }
1198 
1199 module_init(pppoe_init);
1200 module_exit(pppoe_exit);
1201 
1202 MODULE_AUTHOR("Michal Ostrowski <mostrows@speakeasy.net>");
1203 MODULE_DESCRIPTION("PPP over Ethernet driver");
1204 MODULE_LICENSE("GPL");
1205 MODULE_ALIAS_NETPROTO(PF_PPPOX);
1206