xref: /dragonfly/sys/netgraph/pppoe/ng_pppoe.c (revision 783d47c4)
1 
2 /*
3  * ng_pppoe.c
4  *
5  * Copyright (c) 1996-1999 Whistle Communications, Inc.
6  * All rights reserved.
7  *
8  * Subject to the following obligations and disclaimer of warranty, use and
9  * redistribution of this software, in source or object code forms, with or
10  * without modifications are expressly permitted by Whistle Communications;
11  * provided, however, that:
12  * 1. Any and all reproductions of the source or object code must include the
13  *    copyright notice above and the following disclaimer of warranties; and
14  * 2. No rights are granted, in any manner or form, to use Whistle
15  *    Communications, Inc. trademarks, including the mark "WHISTLE
16  *    COMMUNICATIONS" on advertising, endorsements, or otherwise except as
17  *    such appears in the above copyright notice or in the software.
18  *
19  * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
20  * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
21  * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
22  * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
23  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
24  * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
25  * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
26  * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
27  * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
28  * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
29  * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
30  * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
31  * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
32  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
34  * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
35  * OF SUCH DAMAGE.
36  *
37  * Author: Julian Elischer <julian@freebsd.org>
38  *
39  * $FreeBSD: src/sys/netgraph/ng_pppoe.c,v 1.23.2.17 2002/07/02 22:17:18 archie Exp $
40  * $Whistle: ng_pppoe.c,v 1.10 1999/11/01 09:24:52 julian Exp $
41  */
42 #if 0
43 #define AAA kprintf("pppoe: %s\n", __func__ );
44 #define BBB kprintf("-%d-", __LINE__ );
45 #else
46 #define AAA
47 #define BBB
48 #endif
49 
50 #include <sys/param.h>
51 #include <sys/systm.h>
52 #include <sys/kernel.h>
53 #include <sys/mbuf.h>
54 #include <sys/malloc.h>
55 #include <sys/errno.h>
56 #include <sys/sysctl.h>
57 #include <sys/syslog.h>
58 #include <sys/thread2.h>
59 #include <net/ethernet.h>
60 
61 #include <netgraph/ng_message.h>
62 #include <netgraph/netgraph.h>
63 #include "ng_pppoe.h"
64 
65 #define SIGNOFF "session closed"
66 
67 /*
68  * This section contains the netgraph method declarations for the
69  * pppoe node. These methods define the netgraph pppoe 'type'.
70  */
71 
72 static ng_constructor_t	ng_pppoe_constructor;
73 static ng_rcvmsg_t	ng_pppoe_rcvmsg;
74 static ng_shutdown_t	ng_pppoe_rmnode;
75 static ng_newhook_t	ng_pppoe_newhook;
76 static ng_connect_t	ng_pppoe_connect;
77 static ng_rcvdata_t	ng_pppoe_rcvdata;
78 static ng_disconnect_t	ng_pppoe_disconnect;
79 
80 /* Netgraph node type descriptor */
81 static struct ng_type typestruct = {
82 	NG_VERSION,
83 	NG_PPPOE_NODE_TYPE,
84 	NULL,
85 	ng_pppoe_constructor,
86 	ng_pppoe_rcvmsg,
87 	ng_pppoe_rmnode,
88 	ng_pppoe_newhook,
89 	NULL,
90 	ng_pppoe_connect,
91 	ng_pppoe_rcvdata,
92 	ng_pppoe_rcvdata,
93 	ng_pppoe_disconnect,
94 	NULL
95 };
96 NETGRAPH_INIT(pppoe, &typestruct);
97 
98 /*
99  * States for the session state machine.
100  * These have no meaning if there is no hook attached yet.
101  */
102 enum state {
103     PPPOE_SNONE=0,	/* [both] Initial state */
104     PPPOE_LISTENING,	/* [Daemon] Listening for discover initiation pkt */
105     PPPOE_SINIT,	/* [Client] Sent discovery initiation */
106     PPPOE_PRIMED,	/* [Server] Awaiting PADI from daemon */
107     PPPOE_SOFFER,	/* [Server] Sent offer message  (got PADI)*/
108     PPPOE_SREQ,		/* [Client] Sent a Request */
109     PPPOE_NEWCONNECTED,	/* [Server] Connection established, No data received */
110     PPPOE_CONNECTED,	/* [Both] Connection established, Data received */
111     PPPOE_DEAD		/* [Both] */
112 };
113 
114 #define NUMTAGS 20 /* number of tags we are set up to work with */
115 
116 /*
117  * Information we store for each hook on each node for negotiating the
118  * session. The mbuf and cluster are freed once negotiation has completed.
119  * The whole negotiation block is then discarded.
120  */
121 
122 struct sess_neg {
123 	struct mbuf 		*m; /* holds cluster with last sent packet */
124 	union	packet		*pkt; /* points within the above cluster */
125 	struct callout		timeout_ch;
126 	u_int			timeout; /* 0,1,2,4,8,16 etc. seconds */
127 	u_int			numtags;
128 	const struct pppoe_tag	*tags[NUMTAGS];
129 	u_int			service_len;
130 	u_int			ac_name_len;
131 
132 	struct datatag		service;
133 	struct datatag		ac_name;
134 };
135 typedef struct sess_neg *negp;
136 
137 /*
138  * Session information that is needed after connection.
139  */
140 struct sess_con {
141 	hook_p  		hook;
142 	u_int16_t		Session_ID;
143 	enum state		state;
144 	char			creator[NG_NODESIZ]; /* who to notify */
145 	struct pppoe_full_hdr	pkt_hdr;	/* used when connected */
146 	negp			neg;		/* used when negotiating */
147 	/*struct sess_con	*hash_next;*/	/* not yet used */
148 };
149 typedef struct sess_con *sessp;
150 
151 /*
152  * Information we store for each node
153  */
154 struct PPPOE {
155 	node_p		node;		/* back pointer to node */
156 	hook_p  	ethernet_hook;
157 	hook_p  	debug_hook;
158 	u_int   	packets_in;	/* packets in from ethernet */
159 	u_int   	packets_out;	/* packets out towards ethernet */
160 	u_int32_t	flags;
161 	/*struct sess_con *buckets[HASH_SIZE];*/	/* not yet used */
162 };
163 typedef struct PPPOE *priv_p;
164 
165 struct ether_header eh_prototype =
166 	{{0xff,0xff,0xff,0xff,0xff,0xff},
167 	 {0x00,0x00,0x00,0x00,0x00,0x00},
168 	 ETHERTYPE_PPPOE_DISC};
169 
170 #define PPPOE_KEEPSTANDARD	-1	/* never switch to nonstandard mode */
171 #define PPPOE_STANDARD		0	/* try standard mode (dangerous!) */
172 #define PPPOE_NONSTANDARD	1	/* just be in nonstandard mode */
173 static int pppoe_mode = PPPOE_KEEPSTANDARD;
174 
175 static int
176 ngpppoe_set_ethertype(SYSCTL_HANDLER_ARGS)
177 {
178 	int error;
179 	int val;
180 
181 	val = pppoe_mode;
182 	error = sysctl_handle_int(oidp, &val, sizeof(int), req);
183 	if (error != 0 || req->newptr == NULL)
184 		return (error);
185 	switch (val) {
186 	case PPPOE_NONSTANDARD:
187 		pppoe_mode = PPPOE_NONSTANDARD;
188 		eh_prototype.ether_type = ETHERTYPE_PPPOE_STUPID_DISC;
189 		break;
190 	case PPPOE_STANDARD:
191 		pppoe_mode = PPPOE_STANDARD;
192 		eh_prototype.ether_type = ETHERTYPE_PPPOE_DISC;
193 		break;
194 	case PPPOE_KEEPSTANDARD:
195 		pppoe_mode = PPPOE_KEEPSTANDARD;
196 		eh_prototype.ether_type = ETHERTYPE_PPPOE_DISC;
197 		break;
198 	default:
199 		return (EINVAL);
200 	}
201 	return (0);
202 }
203 
204 SYSCTL_PROC(_net_graph, OID_AUTO, nonstandard_pppoe, CTLTYPE_INT | CTLFLAG_RW,
205     0, sizeof(int), ngpppoe_set_ethertype, "I", "nonstandard ethertype");
206 
207 union uniq {
208 	char bytes[sizeof(void *)];
209 	void * pointer;
210 	};
211 
212 #define	LEAVE(x) do { error = x; goto quit; } while(0)
213 static void	pppoe_start(sessp sp);
214 static void	sendpacket(sessp sp);
215 static void	pppoe_ticker(void *arg);
216 static const	struct pppoe_tag *scan_tags(sessp sp,
217 			const struct pppoe_hdr* ph);
218 static	int	pppoe_send_event(sessp sp, enum cmd cmdid);
219 
220 /*************************************************************************
221  * Some basic utilities  from the Linux version with author's permission.*
222  * Author:	Michal Ostrowski <mostrows@styx.uwaterloo.ca>		 *
223  ************************************************************************/
224 
225 /*
226  * Generate a new session id
227  * XXX find out the FreeBSD locking scheme.
228  */
229 static u_int16_t
230 get_new_sid(node_p node)
231 {
232 	static int pppoe_sid = 10;
233 	sessp sp;
234 	hook_p	hook;
235 	u_int16_t val;
236 	priv_p privp = node->private;
237 
238 AAA
239 restart:
240 	val = pppoe_sid++;
241 	/*
242 	 * Spec says 0xFFFF is reserved.
243 	 * Also don't use 0x0000
244 	 */
245 	if (val == 0xffff) {
246 		pppoe_sid = 20;
247 		goto restart;
248 	}
249 
250 	/* Check it isn't already in use */
251 	LIST_FOREACH(hook, &node->hooks, hooks) {
252 		/* don't check special hooks */
253 		if ((hook->private == &privp->debug_hook)
254 		||  (hook->private == &privp->ethernet_hook))
255 			continue;
256 		sp = hook->private;
257 		if (sp->Session_ID == val)
258 			goto restart;
259 	}
260 
261 	return val;
262 }
263 
264 
265 /*
266  * Return the location where the next tag can be put
267  */
268 static __inline const struct pppoe_tag*
269 next_tag(const struct pppoe_hdr* ph)
270 {
271 	return (const struct pppoe_tag*)(((const char*)&ph->tag[0])
272 	    + ntohs(ph->length));
273 }
274 
275 /*
276  * Look for a tag of a specific type
277  * Don't trust any length the other end says.
278  * but assume we already sanity checked ph->length.
279  */
280 static const struct pppoe_tag*
281 get_tag(const struct pppoe_hdr* ph, u_int16_t idx)
282 {
283 	const char *const end = (const char *)next_tag(ph);
284 	const char *ptn;
285 	const struct pppoe_tag *pt = &ph->tag[0];
286 	/*
287 	 * Keep processing tags while a tag header will still fit.
288 	 */
289 AAA
290 	while((const char*)(pt + 1) <= end) {
291 	    /*
292 	     * If the tag data would go past the end of the packet, abort.
293 	     */
294 	    ptn = (((const char *)(pt + 1)) + ntohs(pt->tag_len));
295 	    if(ptn > end)
296 		return NULL;
297 
298 	    if(pt->tag_type == idx)
299 		return pt;
300 
301 	    pt = (const struct pppoe_tag*)ptn;
302 	}
303 	return NULL;
304 }
305 
306 /**************************************************************************
307  * inlines to initialise or add tags to a session's tag list,
308  **************************************************************************/
309 /*
310  * Initialise the session's tag list
311  */
312 static void
313 init_tags(sessp sp)
314 {
315 AAA
316 	if(sp->neg == NULL) {
317 		kprintf("pppoe: asked to init NULL neg pointer\n");
318 		return;
319 	}
320 	sp->neg->numtags = 0;
321 }
322 
323 static void
324 insert_tag(sessp sp, const struct pppoe_tag *tp)
325 {
326 	int	i;
327 	negp neg;
328 
329 AAA
330 	if((neg = sp->neg) == NULL) {
331 		kprintf("pppoe: asked to use NULL neg pointer\n");
332 		return;
333 	}
334 	if ((i = neg->numtags++) < NUMTAGS) {
335 		neg->tags[i] = tp;
336 	} else {
337 		kprintf("pppoe: asked to add too many tags to packet\n");
338 		neg->numtags--;
339 	}
340 }
341 
342 /*
343  * Make up a packet, using the tags filled out for the session.
344  *
345  * Assume that the actual pppoe header and ethernet header
346  * are filled out externally to this routine.
347  * Also assume that neg->wh points to the correct
348  * location at the front of the buffer space.
349  */
350 static void
351 make_packet(sessp sp) {
352 	struct pppoe_full_hdr *wh = &sp->neg->pkt->pkt_header;
353 	const struct pppoe_tag **tag;
354 	char *dp;
355 	int count;
356 	int tlen;
357 	u_int16_t length = 0;
358 
359 AAA
360 	if ((sp->neg == NULL) || (sp->neg->m == NULL)) {
361 		kprintf("pppoe: make_packet called from wrong state\n");
362 	}
363 	dp = (char *)wh->ph.tag;
364 	for (count = 0, tag = sp->neg->tags;
365 	    ((count < sp->neg->numtags) && (count < NUMTAGS));
366 	    tag++, count++) {
367 		tlen = ntohs((*tag)->tag_len) + sizeof(**tag);
368 		if ((length + tlen) > (ETHER_MAX_LEN - 4 - sizeof(*wh))) {
369 			kprintf("pppoe: tags too long\n");
370 			sp->neg->numtags = count;
371 			break;	/* XXX chop off what's too long */
372 		}
373 		bcopy(*tag, (char *)dp, tlen);
374 		length += tlen;
375 		dp += tlen;
376 	}
377  	wh->ph.length = htons(length);
378 	sp->neg->m->m_len = length + sizeof(*wh);
379 	sp->neg->m->m_pkthdr.len = length + sizeof(*wh);
380 }
381 
382 /**************************************************************************
383  * Routine to match a service offered					  *
384  **************************************************************************/
385 /*
386  * Find a hook that has a service string that matches that
387  * we are seeking. for now use a simple string.
388  * In the future we may need something like regexp().
389  * for testing allow a null string to match 1st found and a null service
390  * to match all requests. Also make '*' do the same.
391  */
392 
393 #define NG_MATCH_EXACT	1
394 #define NG_MATCH_ANY	2
395 
396 static hook_p
397 pppoe_match_svc(node_p node, const char *svc_name, int svc_len, int match)
398 {
399 	sessp	sp	= NULL;
400 	negp	neg	= NULL;
401 	priv_p	privp	= node->private;
402 	hook_p	allhook	= NULL;
403 	hook_p	hook;
404 
405 AAA
406 	LIST_FOREACH(hook, &node->hooks, hooks) {
407 
408 		/* skip any hook that is debug or ethernet */
409 		if ((hook->private == &privp->debug_hook)
410 		||  (hook->private == &privp->ethernet_hook))
411 			continue;
412 		sp = hook->private;
413 
414 		/* Skip any sessions which are not in LISTEN mode. */
415 		if ( sp->state != PPPOE_LISTENING)
416 			continue;
417 
418 		neg = sp->neg;
419 
420 		/* Special case for a blank or "*" service name (wildcard) */
421 		if (match == NG_MATCH_ANY && neg->service_len == 1 &&
422 		    neg->service.data[0] == '*') {
423 			allhook = hook;
424 			continue;
425 		}
426 
427 		/* If the lengths don't match, that aint it. */
428 		if (neg->service_len != svc_len)
429 			continue;
430 
431 		/* An exact match? */
432 		if (svc_len == 0)
433 			break;
434 
435 		if (strncmp(svc_name, neg->service.data, svc_len) == 0)
436 			break;
437 	}
438 	return (hook ? hook : allhook);
439 }
440 /**************************************************************************
441  * Routine to find a particular session that matches an incoming packet	  *
442  **************************************************************************/
443 static hook_p
444 pppoe_findsession(node_p node, const struct pppoe_full_hdr *wh)
445 {
446 	sessp	sp = NULL;
447 	hook_p hook = NULL;
448 	priv_p	privp = node->private;
449 	u_int16_t	session = ntohs(wh->ph.sid);
450 
451 	/*
452 	 * find matching peer/session combination.
453 	 */
454 AAA
455 	LIST_FOREACH(hook, &node->hooks, hooks) {
456 		/* don't check special hooks */
457 		if ((hook->private == &privp->debug_hook)
458 		||  (hook->private == &privp->ethernet_hook)) {
459 			continue;
460 		}
461 		sp = hook->private;
462 		if ( ( (sp->state == PPPOE_CONNECTED)
463 		    || (sp->state == PPPOE_NEWCONNECTED) )
464 		&& (sp->Session_ID == session)
465 		&& (bcmp(sp->pkt_hdr.eh.ether_dhost,
466 		    wh->eh.ether_shost,
467 		    ETHER_ADDR_LEN)) == 0) {
468 			break;
469 		}
470 	}
471 	return (hook);
472 }
473 
474 static hook_p
475 pppoe_finduniq(node_p node, const struct pppoe_tag *tag)
476 {
477 	hook_p hook = NULL;
478 	priv_p	privp = node->private;
479 	union uniq		uniq;
480 
481 AAA
482 	bcopy(tag->tag_data, uniq.bytes, sizeof(void *));
483 	/* cycle through all known hooks */
484 	LIST_FOREACH(hook, &node->hooks, hooks) {
485 		/* don't check special hooks */
486 		if ((hook->private == &privp->debug_hook)
487 		||  (hook->private == &privp->ethernet_hook))
488 			continue;
489 		if (uniq.pointer == hook->private)
490 			break;
491 	}
492 	return (hook);
493 }
494 
495 /**************************************************************************
496  * start of Netgraph entrypoints					  *
497  **************************************************************************/
498 
499 /*
500  * Allocate the private data structure and the generic node
501  * and link them together.
502  *
503  * ng_make_node_common() returns with a generic node struct
504  * with a single reference for us.. we transfer it to the
505  * private structure.. when we free the private struct we must
506  * unref the node so it gets freed too.
507  */
508 static int
509 ng_pppoe_constructor(node_p *nodep)
510 {
511 	priv_p privdata;
512 	int error;
513 
514 AAA
515 	/* Initialize private descriptor */
516 	privdata = kmalloc(sizeof(*privdata), M_NETGRAPH, M_NOWAIT | M_ZERO);
517 	if (privdata == NULL)
518 		return (ENOMEM);
519 
520 	/* Call the 'generic' (ie, superclass) node constructor */
521 	if ((error = ng_make_node_common(&typestruct, nodep))) {
522 		kfree(privdata, M_NETGRAPH);
523 		return (error);
524 	}
525 
526 	/* Link structs together; this counts as our one reference to *nodep */
527 	(*nodep)->private = privdata;
528 	privdata->node = *nodep;
529 	return (0);
530 }
531 
532 /*
533  * Give our ok for a hook to be added...
534  * point the hook's private info to the hook structure.
535  *
536  * The following hook names are special:
537  *  Ethernet:  the hook that should be connected to a NIC.
538  *  debug:	copies of data sent out here  (when I write the code).
539  * All other hook names need only be unique. (the framework checks this).
540  */
541 static int
542 ng_pppoe_newhook(node_p node, hook_p hook, const char *name)
543 {
544 	const priv_p privp = node->private;
545 	sessp sp;
546 
547 AAA
548 	if (strcmp(name, NG_PPPOE_HOOK_ETHERNET) == 0) {
549 		privp->ethernet_hook = hook;
550 		hook->private = &privp->ethernet_hook;
551 	} else if (strcmp(name, NG_PPPOE_HOOK_DEBUG) == 0) {
552 		privp->debug_hook = hook;
553 		hook->private = &privp->debug_hook;
554 	} else {
555 		/*
556 		 * Any other unique name is OK.
557 		 * The infrastructure has already checked that it's unique,
558 		 * so just allocate it and hook it in.
559 		 */
560 		sp = kmalloc(sizeof(*sp), M_NETGRAPH, M_NOWAIT | M_ZERO);
561 		if (sp == NULL)
562 			return (ENOMEM);
563 
564 		hook->private = sp;
565 		sp->hook = hook;
566 	}
567 	return(0);
568 }
569 
570 /*
571  * Get a netgraph control message.
572  * Check it is one we understand. If needed, send a response.
573  * We sometimes save the address for an async action later.
574  * Always free the message.
575  */
576 static int
577 ng_pppoe_rcvmsg(node_p node,
578 	   struct ng_mesg *msg, const char *retaddr, struct ng_mesg **rptr)
579 {
580 	priv_p privp = node->private;
581 	struct ngpppoe_init_data *ourmsg = NULL;
582 	struct ng_mesg *resp = NULL;
583 	int error = 0;
584 	hook_p hook = NULL;
585 	sessp sp = NULL;
586 	negp neg = NULL;
587 
588 AAA
589 	/* Deal with message according to cookie and command */
590 	switch (msg->header.typecookie) {
591 	case NGM_PPPOE_COOKIE:
592 		switch (msg->header.cmd) {
593 		case NGM_PPPOE_CONNECT:
594 		case NGM_PPPOE_LISTEN:
595 		case NGM_PPPOE_OFFER:
596 		case NGM_PPPOE_SERVICE:
597 			ourmsg = (struct ngpppoe_init_data *)msg->data;
598 			if (( sizeof(*ourmsg) > msg->header.arglen)
599 			|| ((sizeof(*ourmsg) + ourmsg->data_len)
600 			    > msg->header.arglen)) {
601 				kprintf("pppoe_rcvmsg: bad arg size");
602 				LEAVE(EMSGSIZE);
603 			}
604 			if (ourmsg->data_len > PPPOE_SERVICE_NAME_SIZE) {
605 				kprintf("pppoe: init data too long (%d)\n",
606 							ourmsg->data_len);
607 				LEAVE(EMSGSIZE);
608 			}
609 			/* make sure strcmp will terminate safely */
610 			ourmsg->hook[sizeof(ourmsg->hook) - 1] = '\0';
611 
612 			/* cycle through all known hooks */
613 			LIST_FOREACH(hook, &node->hooks, hooks) {
614 				if (hook->name
615 				&& strcmp(hook->name, ourmsg->hook) == 0)
616 					break;
617 			}
618 			if (hook == NULL) {
619 				LEAVE(ENOENT);
620 			}
621 			if ((hook->private == &privp->debug_hook)
622 			||  (hook->private == &privp->ethernet_hook)) {
623 				LEAVE(EINVAL);
624 			}
625 			sp = hook->private;
626 
627 			if (msg->header.cmd == NGM_PPPOE_LISTEN) {
628 				/*
629 				 * Ensure we aren't already listening for this
630 				 * service.
631 				 */
632 				if (pppoe_match_svc(node, ourmsg->data,
633 				    ourmsg->data_len, NG_MATCH_EXACT) != NULL) {
634 					LEAVE(EEXIST);
635 				}
636 			}
637 
638 			/*
639 			 * PPPOE_SERVICE advertisments are set up
640 			 * on sessions that are in PRIMED state.
641 			 */
642 			if (msg->header.cmd == NGM_PPPOE_SERVICE) {
643 				break;
644 			}
645 			if (sp->state != PPPOE_SNONE) {
646 				kprintf("pppoe: Session already active\n");
647 				LEAVE(EISCONN);
648 			}
649 
650 			/*
651 			 * set up prototype header
652 			 */
653 			neg = kmalloc(sizeof(*neg), M_NETGRAPH,
654 				      M_NOWAIT | M_ZERO);
655 
656 			if (neg == NULL) {
657 				kprintf("pppoe: Session out of memory\n");
658 				LEAVE(ENOMEM);
659 			}
660 			MGETHDR(neg->m, MB_DONTWAIT, MT_DATA);
661 			if(neg->m == NULL) {
662 				kprintf("pppoe: Session out of mbufs\n");
663 				kfree(neg, M_NETGRAPH);
664 				LEAVE(ENOBUFS);
665 			}
666 			neg->m->m_pkthdr.rcvif = NULL;
667 			MCLGET(neg->m, MB_DONTWAIT);
668 			if ((neg->m->m_flags & M_EXT) == 0) {
669 				kprintf("pppoe: Session out of mcls\n");
670 				m_freem(neg->m);
671 				kfree(neg, M_NETGRAPH);
672 				LEAVE(ENOBUFS);
673 			}
674 			sp->neg = neg;
675 			callout_init(&neg->timeout_ch);
676 			neg->m->m_len = sizeof(struct pppoe_full_hdr);
677 			neg->pkt = mtod(neg->m, union packet*);
678 			neg->pkt->pkt_header.eh = eh_prototype;
679 			neg->pkt->pkt_header.ph.ver = 0x1;
680 			neg->pkt->pkt_header.ph.type = 0x1;
681 			neg->pkt->pkt_header.ph.sid = 0x0000;
682 			neg->timeout = 0;
683 
684 			strlcpy(sp->creator, retaddr, NG_NODESIZ);
685 		}
686 		switch (msg->header.cmd) {
687 		case NGM_PPPOE_GET_STATUS:
688 		    {
689 			struct ngpppoestat *stats;
690 
691 			NG_MKRESPONSE(resp, msg, sizeof(*stats), M_NOWAIT);
692 			if (!resp) {
693 				LEAVE(ENOMEM);
694 			}
695 			stats = (struct ngpppoestat *) resp->data;
696 			stats->packets_in = privp->packets_in;
697 			stats->packets_out = privp->packets_out;
698 			break;
699 		    }
700 		case NGM_PPPOE_CONNECT:
701 			/*
702 			 * Check the hook exists and is Uninitialised.
703 			 * Send a PADI request, and start the timeout logic.
704 			 * Store the originator of this message so we can send
705 			 * a success of fail message to them later.
706 			 * Move the session to SINIT
707 			 * Set up the session to the correct state and
708 			 * start it.
709 			 */
710 			neg->service.hdr.tag_type = PTT_SRV_NAME;
711 			neg->service.hdr.tag_len =
712 					htons((u_int16_t)ourmsg->data_len);
713 			if (ourmsg->data_len) {
714 				bcopy(ourmsg->data,
715 					neg->service.data, ourmsg->data_len);
716 			}
717 			neg->service_len = ourmsg->data_len;
718 			pppoe_start(sp);
719 			break;
720 		case NGM_PPPOE_LISTEN:
721 			/*
722 			 * Check the hook exists and is Uninitialised.
723 			 * Install the service matching string.
724 			 * Store the originator of this message so we can send
725 			 * a success of fail message to them later.
726 			 * Move the hook to 'LISTENING'
727 			 */
728 			neg->service.hdr.tag_type = PTT_SRV_NAME;
729 			neg->service.hdr.tag_len =
730 					htons((u_int16_t)ourmsg->data_len);
731 
732 			if (ourmsg->data_len) {
733 				bcopy(ourmsg->data,
734 					neg->service.data, ourmsg->data_len);
735 			}
736 			neg->service_len = ourmsg->data_len;
737 			neg->pkt->pkt_header.ph.code = PADT_CODE;
738 			/*
739 			 * wait for PADI packet coming from ethernet
740 			 */
741 			sp->state = PPPOE_LISTENING;
742 			break;
743 		case NGM_PPPOE_OFFER:
744 			/*
745 			 * Check the hook exists and is Uninitialised.
746 			 * Store the originator of this message so we can send
747 			 * a success of fail message to them later.
748 			 * Store the AC-Name given and go to PRIMED.
749 			 */
750 			neg->ac_name.hdr.tag_type = PTT_AC_NAME;
751 			neg->ac_name.hdr.tag_len =
752 					htons((u_int16_t)ourmsg->data_len);
753 			if (ourmsg->data_len) {
754 				bcopy(ourmsg->data,
755 					neg->ac_name.data, ourmsg->data_len);
756 			}
757 			neg->ac_name_len = ourmsg->data_len;
758 			neg->pkt->pkt_header.ph.code = PADO_CODE;
759 			/*
760 			 * Wait for PADI packet coming from hook
761 			 */
762 			sp->state = PPPOE_PRIMED;
763 			break;
764 		case NGM_PPPOE_SERVICE:
765 			/*
766 			 * Check the session is primed.
767 			 * for now just allow ONE service to be advertised.
768 			 * If you do it twice you just overwrite.
769 			 */
770 			if (sp->state != PPPOE_PRIMED) {
771 				kprintf("pppoe: Session not primed\n");
772 				LEAVE(EISCONN);
773 			}
774 			neg = sp->neg;
775 			neg->service.hdr.tag_type = PTT_SRV_NAME;
776 			neg->service.hdr.tag_len =
777 			    htons((u_int16_t)ourmsg->data_len);
778 
779 			if (ourmsg->data_len)
780 				bcopy(ourmsg->data, neg->service.data,
781 				    ourmsg->data_len);
782 			neg->service_len = ourmsg->data_len;
783 			break;
784 		default:
785 			LEAVE(EINVAL);
786 		}
787 		break;
788 	default:
789 		LEAVE(EINVAL);
790 	}
791 
792 	/* Take care of synchronous response, if any */
793 	if (rptr)
794 		*rptr = resp;
795 	else if (resp)
796 		kfree(resp, M_NETGRAPH);
797 
798 	/* Free the message and return */
799 quit:
800 	kfree(msg, M_NETGRAPH);
801 	return(error);
802 }
803 
804 /*
805  * Start a client into the first state. A separate function because
806  * it can be needed if the negotiation times out.
807  */
808 static void
809 pppoe_start(sessp sp)
810 {
811 	struct {
812 		struct pppoe_tag hdr;
813 		union	uniq	data;
814 	} __attribute ((packed)) uniqtag;
815 
816 	/*
817 	 * kick the state machine into starting up
818 	 */
819 AAA
820 	sp->state = PPPOE_SINIT;
821 	/* reset the packet header to broadcast */
822 	sp->neg->pkt->pkt_header.eh = eh_prototype;
823 	sp->neg->pkt->pkt_header.ph.code = PADI_CODE;
824 	uniqtag.hdr.tag_type = PTT_HOST_UNIQ;
825 	uniqtag.hdr.tag_len = htons((u_int16_t)sizeof(uniqtag.data));
826 	uniqtag.data.pointer = sp;
827 	init_tags(sp);
828 	insert_tag(sp, &uniqtag.hdr);
829 	insert_tag(sp, &sp->neg->service.hdr);
830 	make_packet(sp);
831 	sendpacket(sp);
832 }
833 
834 static int
835 send_acname(sessp sp, const struct pppoe_tag *tag)
836 {
837 	int error, tlen;
838 	struct ng_mesg *msg;
839 	struct ngpppoe_sts *sts;
840 
841 	NG_MKMESSAGE(msg, NGM_PPPOE_COOKIE, NGM_PPPOE_ACNAME,
842 	    sizeof(struct ngpppoe_sts), M_NOWAIT);
843 	if (msg == NULL)
844 		return (ENOMEM);
845 
846 	sts = (struct ngpppoe_sts *)msg->data;
847 	tlen = min(NG_HOOKSIZ - 1, ntohs(tag->tag_len));
848 	strncpy(sts->hook, tag->tag_data, tlen);
849 	sts->hook[tlen] = '\0';
850 	error = ng_send_msg(sp->hook->node, msg, sp->creator, NULL);
851 
852 	return (error);
853 }
854 
855 static int
856 send_sessionid(sessp sp)
857 {
858 	int error;
859 	struct ng_mesg *msg;
860 
861 	NG_MKMESSAGE(msg, NGM_PPPOE_COOKIE, NGM_PPPOE_SESSIONID,
862 	    sizeof(u_int16_t), M_NOWAIT);
863 	if (msg == NULL)
864 		return (ENOMEM);
865 
866 	*(u_int16_t *)msg->data = sp->Session_ID;
867 	error = ng_send_msg(sp->hook->node, msg, sp->creator, NULL);
868 
869 	return (error);
870 }
871 
872 /*
873  * Receive data, and do something with it.
874  * The caller will never free m or meta, so
875  * if we use up this data or abort we must free BOTH of these.
876  */
877 static int
878 ng_pppoe_rcvdata(hook_p hook, struct mbuf *m, meta_p meta)
879 {
880 	node_p			node = hook->node;
881 	const priv_p		privp = node->private;
882 	sessp			sp = hook->private;
883 	const struct pppoe_full_hdr *wh;
884 	const struct pppoe_hdr	*ph;
885 	int			error = 0;
886 	u_int16_t		session;
887 	u_int16_t		length;
888 	u_int8_t		code;
889 	const struct pppoe_tag	*utag = NULL, *tag = NULL;
890 	hook_p 			sendhook;
891 	struct {
892 		struct pppoe_tag hdr;
893 		union	uniq	data;
894 	} __attribute ((packed)) uniqtag;
895 	negp			neg = NULL;
896 
897 AAA
898 	if (hook->private == &privp->debug_hook) {
899 		/*
900 		 * Data from the debug hook gets sent without modification
901 		 * straight to the ethernet.
902 		 */
903 		NG_SEND_DATA( error, privp->ethernet_hook, m, meta);
904 	 	privp->packets_out++;
905 	} else if (hook->private == &privp->ethernet_hook) {
906 		/*
907 		 * Incoming data.
908 		 * Dig out various fields from the packet.
909 		 * use them to decide where to send it.
910 		 */
911 
912  		privp->packets_in++;
913 		if( m->m_len < sizeof(*wh)) {
914 			m = m_pullup(m, sizeof(*wh)); /* Checks length */
915 			if (m == NULL) {
916 				kprintf("couldn't m_pullup\n");
917 				LEAVE(ENOBUFS);
918 			}
919 		}
920 		wh = mtod(m, struct pppoe_full_hdr *);
921 		ph = &wh->ph;
922 		session = ntohs(wh->ph.sid);
923 		length = ntohs(wh->ph.length);
924 		code = wh->ph.code;
925 		switch(wh->eh.ether_type) {
926 		case	ETHERTYPE_PPPOE_STUPID_DISC:
927 			if (pppoe_mode == PPPOE_STANDARD) {
928 				pppoe_mode = PPPOE_NONSTANDARD;
929 				eh_prototype.ether_type =
930 				    ETHERTYPE_PPPOE_STUPID_DISC;
931 				log(LOG_NOTICE,
932 				    "Switched to nonstandard PPPoE mode due to "
933 				    "packet from %*D\n",
934 				    ETHER_ADDR_LEN,
935 				    wh->eh.ether_shost, ":");
936 			} else if (pppoe_mode == PPPOE_KEEPSTANDARD)
937 				log(LOG_NOTICE,
938 				    "Ignored nonstandard PPPoE packet "
939 				    "from %*D\n",
940 				    ETHER_ADDR_LEN,
941 				    wh->eh.ether_shost, ":");
942 			/* fall through */
943 		case	ETHERTYPE_PPPOE_DISC:
944 			/*
945 			 * We need to try to make sure that the tag area
946 			 * is contiguous, or we could wander off the end
947 			 * of a buffer and make a mess.
948 			 * (Linux wouldn't have this problem).
949 			 */
950 /*XXX fix this mess */
951 
952 			if (m->m_pkthdr.len <= MHLEN) {
953 				if( m->m_len < m->m_pkthdr.len) {
954 					m = m_pullup(m, m->m_pkthdr.len);
955 					if (m == NULL) {
956 						kprintf("couldn't m_pullup\n");
957 						LEAVE(ENOBUFS);
958 					}
959 				}
960 			}
961 			if (m->m_len != m->m_pkthdr.len) {
962 				/*
963 				 * It's not all in one piece.
964 				 * We need to do extra work.
965 				 */
966 				kprintf("packet fragmented\n");
967 				LEAVE(EMSGSIZE);
968 			}
969 
970 			switch(code) {
971 			case	PADI_CODE:
972 				/*
973 				 * We are a server:
974 				 * Look for a hook with the required service
975 				 * and send the ENTIRE packet up there.
976 				 * It should come back to a new hook in
977 				 * PRIMED state. Look there for further
978 				 * processing.
979 				 */
980 				tag = get_tag(ph, PTT_SRV_NAME);
981 				if (tag == NULL) {
982 					kprintf("no service tag\n");
983 					LEAVE(ENETUNREACH);
984 				}
985 				sendhook = pppoe_match_svc(hook->node,
986 			    		tag->tag_data, ntohs(tag->tag_len),
987 					NG_MATCH_ANY);
988 				if (sendhook) {
989 					NG_SEND_DATA(error, sendhook, m, meta);
990 				} else {
991 					LEAVE(ENETUNREACH);
992 				}
993 				break;
994 			case	PADO_CODE:
995 				/*
996 				 * We are a client:
997 				 * Use the host_uniq tag to find the
998 				 * hook this is in response to.
999 				 * Received #2, now send #3
1000 				 * For now simply accept the first we receive.
1001 				 */
1002 				utag = get_tag(ph, PTT_HOST_UNIQ);
1003 				if ((utag == NULL)
1004 				|| (ntohs(utag->tag_len) != sizeof(sp))) {
1005 					kprintf("no host unique field\n");
1006 					LEAVE(ENETUNREACH);
1007 				}
1008 
1009 				sendhook = pppoe_finduniq(node, utag);
1010 				if (sendhook == NULL) {
1011 					kprintf("no matching session\n");
1012 					LEAVE(ENETUNREACH);
1013 				}
1014 
1015 				/*
1016 				 * Check the session is in the right state.
1017 				 * It needs to be in PPPOE_SINIT.
1018 				 */
1019 				sp = sendhook->private;
1020 				if (sp->state != PPPOE_SINIT) {
1021 					kprintf("session in wrong state\n");
1022 					LEAVE(ENETUNREACH);
1023 				}
1024 				neg = sp->neg;
1025 				callout_stop(&neg->timeout_ch);
1026 
1027 				/*
1028 				 * This is the first time we hear
1029 				 * from the server, so note it's
1030 				 * unicast address, replacing the
1031 				 * broadcast address .
1032 				 */
1033 				bcopy(wh->eh.ether_shost,
1034 					neg->pkt->pkt_header.eh.ether_dhost,
1035 					ETHER_ADDR_LEN);
1036 				neg->timeout = 0;
1037 				neg->pkt->pkt_header.ph.code = PADR_CODE;
1038 				init_tags(sp);
1039 				insert_tag(sp, utag);      /* Host Unique */
1040 				if ((tag = get_tag(ph, PTT_AC_COOKIE)))
1041 					insert_tag(sp, tag); /* return cookie */
1042 				if ((tag = get_tag(ph, PTT_AC_NAME))) {
1043 					insert_tag(sp, tag); /* return it */
1044 					send_acname(sp, tag);
1045 				}
1046 				insert_tag(sp, &neg->service.hdr); /* Service */
1047 				scan_tags(sp, ph);
1048 				make_packet(sp);
1049 				sp->state = PPPOE_SREQ;
1050 				sendpacket(sp);
1051 				break;
1052 			case	PADR_CODE:
1053 
1054 				/*
1055 				 * We are a server:
1056 				 * Use the ac_cookie tag to find the
1057 				 * hook this is in response to.
1058 				 */
1059 				utag = get_tag(ph, PTT_AC_COOKIE);
1060 				if ((utag == NULL)
1061 				|| (ntohs(utag->tag_len) != sizeof(sp))) {
1062 					LEAVE(ENETUNREACH);
1063 				}
1064 
1065 				sendhook = pppoe_finduniq(node, utag);
1066 				if (sendhook == NULL) {
1067 					LEAVE(ENETUNREACH);
1068 				}
1069 
1070 				/*
1071 				 * Check the session is in the right state.
1072 				 * It needs to be in PPPOE_SOFFER
1073 				 * or PPPOE_NEWCONNECTED. If the latter,
1074 				 * then this is a retry by the client.
1075 				 * so be nice, and resend.
1076 				 */
1077 				sp = sendhook->private;
1078 				if (sp->state == PPPOE_NEWCONNECTED) {
1079 					/*
1080 					 * Whoa! drop back to resend that
1081 					 * PADS packet.
1082 					 * We should still have a copy of it.
1083 					 */
1084 					sp->state = PPPOE_SOFFER;
1085 				}
1086 				if (sp->state != PPPOE_SOFFER) {
1087 					LEAVE (ENETUNREACH);
1088 					break;
1089 				}
1090 				neg = sp->neg;
1091 				callout_stop(&neg->timeout_ch);
1092 				neg->pkt->pkt_header.ph.code = PADS_CODE;
1093 				if (sp->Session_ID == 0)
1094 					neg->pkt->pkt_header.ph.sid =
1095 					    htons(sp->Session_ID
1096 						= get_new_sid(node));
1097 				send_sessionid(sp);
1098 				neg->timeout = 0;
1099 				/*
1100 				 * start working out the tags to respond with.
1101 				 */
1102 				init_tags(sp);
1103 				insert_tag(sp, &neg->ac_name.hdr); /* AC_NAME */
1104 				if ((tag = get_tag(ph, PTT_SRV_NAME)))
1105 					insert_tag(sp, tag);/* return service */
1106 				if ((tag = get_tag(ph, PTT_HOST_UNIQ)))
1107 					insert_tag(sp, tag); /* return it */
1108 				insert_tag(sp, utag);	/* ac_cookie */
1109 				scan_tags(sp, ph);
1110 				make_packet(sp);
1111 				sp->state = PPPOE_NEWCONNECTED;
1112 				sendpacket(sp);
1113 				/*
1114 				 * Having sent the last Negotiation header,
1115 				 * Set up the stored packet header to
1116 				 * be correct for the actual session.
1117 				 * But keep the negotialtion stuff
1118 				 * around in case we need to resend this last
1119 				 * packet. We'll discard it when we move
1120 				 * from NEWCONNECTED to CONNECTED
1121 				 */
1122 				sp->pkt_hdr = neg->pkt->pkt_header;
1123 				if (pppoe_mode == PPPOE_NONSTANDARD)
1124 					sp->pkt_hdr.eh.ether_type
1125 						= ETHERTYPE_PPPOE_STUPID_SESS;
1126 				else
1127 					sp->pkt_hdr.eh.ether_type
1128 						= ETHERTYPE_PPPOE_SESS;
1129 				sp->pkt_hdr.ph.code = 0;
1130 				pppoe_send_event(sp, NGM_PPPOE_SUCCESS);
1131 				break;
1132 			case	PADS_CODE:
1133 				/*
1134 				 * We are a client:
1135 				 * Use the host_uniq tag to find the
1136 				 * hook this is in response to.
1137 				 * take the session ID and store it away.
1138 				 * Also make sure the pre-made header is
1139 				 * correct and set us into Session mode.
1140 				 */
1141 				utag = get_tag(ph, PTT_HOST_UNIQ);
1142 				if ((utag == NULL)
1143 				|| (ntohs(utag->tag_len) != sizeof(sp))) {
1144 					LEAVE (ENETUNREACH);
1145 					break;
1146 				}
1147 				sendhook = pppoe_finduniq(node, utag);
1148 				if (sendhook == NULL) {
1149 					LEAVE(ENETUNREACH);
1150 				}
1151 
1152 				/*
1153 				 * Check the session is in the right state.
1154 				 * It needs to be in PPPOE_SREQ.
1155 				 */
1156 				sp = sendhook->private;
1157 				if (sp->state != PPPOE_SREQ) {
1158 					LEAVE(ENETUNREACH);
1159 				}
1160 				neg = sp->neg;
1161 				callout_stop(&neg->timeout_ch);
1162 				neg->pkt->pkt_header.ph.sid = wh->ph.sid;
1163 				sp->Session_ID = ntohs(wh->ph.sid);
1164 				send_sessionid(sp);
1165 				neg->timeout = 0;
1166 				sp->state = PPPOE_CONNECTED;
1167 				/*
1168 				 * Now we have gone to Connected mode,
1169 				 * Free all resources needed for
1170 				 * negotiation.
1171 				 * Keep a copy of the header we will be using.
1172 				 */
1173 				sp->pkt_hdr = neg->pkt->pkt_header;
1174 				if (pppoe_mode == PPPOE_NONSTANDARD)
1175 					sp->pkt_hdr.eh.ether_type
1176 						= ETHERTYPE_PPPOE_STUPID_SESS;
1177 				else
1178 					sp->pkt_hdr.eh.ether_type
1179 						= ETHERTYPE_PPPOE_SESS;
1180 				sp->pkt_hdr.ph.code = 0;
1181 				m_freem(neg->m);
1182 				kfree(sp->neg, M_NETGRAPH);
1183 				sp->neg = NULL;
1184 				pppoe_send_event(sp, NGM_PPPOE_SUCCESS);
1185 				break;
1186 			case	PADT_CODE:
1187 				/*
1188 				 * Send a 'close' message to the controlling
1189 				 * process (the one that set us up);
1190 				 * And then tear everything down.
1191 				 *
1192 				 * Find matching peer/session combination.
1193 				 */
1194 				sendhook = pppoe_findsession(node, wh);
1195 				NG_FREE_DATA(m, meta); /* no longer needed */
1196 				if (sendhook == NULL) {
1197 					LEAVE(ENETUNREACH);
1198 				}
1199 				/* send message to creator */
1200 				/* close hook */
1201 				if (sendhook) {
1202 					ng_destroy_hook(sendhook);
1203 				}
1204 				break;
1205 			default:
1206 				LEAVE(EPFNOSUPPORT);
1207 			}
1208 			break;
1209 		case	ETHERTYPE_PPPOE_STUPID_SESS:
1210 		case	ETHERTYPE_PPPOE_SESS:
1211 			/*
1212 			 * find matching peer/session combination.
1213 			 */
1214 			sendhook = pppoe_findsession(node, wh);
1215 			if (sendhook == NULL) {
1216 				LEAVE (ENETUNREACH);
1217 				break;
1218 			}
1219 			sp = sendhook->private;
1220 			m_adj(m, sizeof(*wh));
1221 			if (m->m_pkthdr.len < length) {
1222 				/* Packet too short, dump it */
1223 				LEAVE(EMSGSIZE);
1224 			}
1225 
1226 			/* Also need to trim excess at the end */
1227 			if (m->m_pkthdr.len > length) {
1228 				m_adj(m, -((int)(m->m_pkthdr.len - length)));
1229 			}
1230 			if ( sp->state != PPPOE_CONNECTED) {
1231 				if (sp->state == PPPOE_NEWCONNECTED) {
1232 					sp->state = PPPOE_CONNECTED;
1233 					/*
1234 					 * Now we have gone to Connected mode,
1235 					 * Free all resources needed for
1236 					 * negotiation. Be paranoid about
1237 					 * whether there may be a timeout.
1238 					 */
1239 					m_freem(sp->neg->m);
1240 					callout_stop(&sp->neg->timeout_ch);
1241 					kfree(sp->neg, M_NETGRAPH);
1242 					sp->neg = NULL;
1243 				} else {
1244 					LEAVE (ENETUNREACH);
1245 					break;
1246 				}
1247 			}
1248 			NG_SEND_DATA( error, sendhook, m, meta);
1249 			break;
1250 		default:
1251 			LEAVE(EPFNOSUPPORT);
1252 		}
1253 	} else {
1254 		/*
1255 		 * 	Not ethernet or debug hook..
1256 		 *
1257 		 * The packet has come in on a normal hook.
1258 		 * We need to find out what kind of hook,
1259 		 * So we can decide how to handle it.
1260 		 * Check the hook's state.
1261 		 */
1262 		sp = hook->private;
1263 		switch (sp->state) {
1264 		case	PPPOE_NEWCONNECTED:
1265 		case	PPPOE_CONNECTED: {
1266 			static const u_char addrctrl[] = { 0xff, 0x03 };
1267 			struct pppoe_full_hdr *wh;
1268 
1269 			/*
1270 			 * Remove PPP address and control fields, if any.
1271 			 * For example, ng_ppp(4) always sends LCP packets
1272 			 * with address and control fields as required by
1273 			 * generic PPP. PPPoE is an exception to the rule.
1274 			 */
1275 			if (m->m_pkthdr.len >= 2) {
1276 				if (m->m_len < 2 && !(m = m_pullup(m, 2)))
1277 					LEAVE(ENOBUFS);
1278 				if (bcmp(mtod(m, u_char *), addrctrl, 2) == 0)
1279 					m_adj(m, 2);
1280 			}
1281 			/*
1282 			 * Bang in a pre-made header, and set the length up
1283 			 * to be correct. Then send it to the ethernet driver.
1284 			 * But first correct the length.
1285 			 */
1286 			sp->pkt_hdr.ph.length = htons((short)(m->m_pkthdr.len));
1287 			M_PREPEND(m, sizeof(*wh), MB_DONTWAIT);
1288 			if (m == NULL) {
1289 				LEAVE(ENOBUFS);
1290 			}
1291 			wh = mtod(m, struct pppoe_full_hdr *);
1292 			bcopy(&sp->pkt_hdr, wh, sizeof(*wh));
1293 			NG_SEND_DATA( error, privp->ethernet_hook, m, meta);
1294 			privp->packets_out++;
1295 			break;
1296 			}
1297 		case	PPPOE_PRIMED:
1298 			/*
1299 			 * A PADI packet is being returned by the application
1300 			 * that has set up this hook. This indicates that it
1301 			 * wants us to offer service.
1302 			 */
1303 			neg = sp->neg;
1304 			if (m->m_len < sizeof(*wh)) {
1305 				m = m_pullup(m, sizeof(*wh));
1306 				if (m == NULL) {
1307 					LEAVE(ENOBUFS);
1308 				}
1309 			}
1310 			wh = mtod(m, struct pppoe_full_hdr *);
1311 			ph = &wh->ph;
1312 			session = ntohs(wh->ph.sid);
1313 			length = ntohs(wh->ph.length);
1314 			code = wh->ph.code;
1315 			if ( code != PADI_CODE) {
1316 				LEAVE(EINVAL);
1317 			};
1318 			callout_stop(&neg->timeout_ch);
1319 
1320 			/*
1321 			 * This is the first time we hear
1322 			 * from the client, so note it's
1323 			 * unicast address, replacing the
1324 			 * broadcast address.
1325 			 */
1326 			bcopy(wh->eh.ether_shost,
1327 				neg->pkt->pkt_header.eh.ether_dhost,
1328 				ETHER_ADDR_LEN);
1329 			sp->state = PPPOE_SOFFER;
1330 			neg->timeout = 0;
1331 			neg->pkt->pkt_header.ph.code = PADO_CODE;
1332 
1333 			/*
1334 			 * start working out the tags to respond with.
1335 			 */
1336 			uniqtag.hdr.tag_type = PTT_AC_COOKIE;
1337 			uniqtag.hdr.tag_len = htons((u_int16_t)sizeof(sp));
1338 			uniqtag.data.pointer = sp;
1339 			init_tags(sp);
1340 			insert_tag(sp, &neg->ac_name.hdr); /* AC_NAME */
1341 			if ((tag = get_tag(ph, PTT_SRV_NAME)))
1342 				insert_tag(sp, tag);	  /* return service */
1343 			/*
1344 			 * If we have a NULL service request
1345 			 * and have an extra service defined in this hook,
1346 			 * then also add a tag for the extra service.
1347 			 * XXX this is a hack. eventually we should be able
1348 			 * to support advertising many services, not just one
1349 			 */
1350 			if (((tag == NULL) || (tag->tag_len == 0))
1351 			&& (neg->service.hdr.tag_len != 0)) {
1352 				insert_tag(sp, &neg->service.hdr); /* SERVICE */
1353 			}
1354 			if ((tag = get_tag(ph, PTT_HOST_UNIQ)))
1355 				insert_tag(sp, tag); /* returned hostunique */
1356 			insert_tag(sp, &uniqtag.hdr);
1357 			scan_tags(sp, ph);
1358 			make_packet(sp);
1359 			sendpacket(sp);
1360 			break;
1361 
1362 		/*
1363 		 * Packets coming from the hook make no sense
1364 		 * to sessions in these states. Throw them away.
1365 		 */
1366 		case	PPPOE_SINIT:
1367 		case	PPPOE_SREQ:
1368 		case	PPPOE_SOFFER:
1369 		case	PPPOE_SNONE:
1370 		case	PPPOE_LISTENING:
1371 		case	PPPOE_DEAD:
1372 		default:
1373 			LEAVE(ENETUNREACH);
1374 		}
1375 	}
1376 quit:
1377 	NG_FREE_DATA(m, meta);
1378 	return error;
1379 }
1380 
1381 /*
1382  * Do local shutdown processing..
1383  * If we are a persistant device, we might refuse to go away, and
1384  * we'd only remove our links and reset ourself.
1385  */
1386 static int
1387 ng_pppoe_rmnode(node_p node)
1388 {
1389 	const priv_p privdata = node->private;
1390 
1391 AAA
1392 	node->flags |= NG_INVALID;
1393 	ng_cutlinks(node);
1394 	ng_unname(node);
1395 	node->private = NULL;
1396 	ng_unref(privdata->node);
1397 	kfree(privdata, M_NETGRAPH);
1398 	return (0);
1399 }
1400 
1401 /*
1402  * This is called once we've already connected a new hook to the other node.
1403  * It gives us a chance to balk at the last minute.
1404  */
1405 static int
1406 ng_pppoe_connect(hook_p hook)
1407 {
1408 	/* be really amiable and just say "YUP that's OK by me! " */
1409 	return (0);
1410 }
1411 
1412 /*
1413  * Hook disconnection
1414  *
1415  * Clean up all dangling links and information about the session/hook.
1416  * For this type, removal of the last link destroys the node
1417  */
1418 static int
1419 ng_pppoe_disconnect(hook_p hook)
1420 {
1421 	node_p node = hook->node;
1422 	priv_p privp = node->private;
1423 	sessp	sp;
1424 	int 	hooks;
1425 
1426 AAA
1427 	hooks = node->numhooks; /* this one already not counted */
1428 	if (hook->private == &privp->debug_hook) {
1429 		privp->debug_hook = NULL;
1430 	} else if (hook->private == &privp->ethernet_hook) {
1431 		privp->ethernet_hook = NULL;
1432 		ng_rmnode(node);
1433 	} else {
1434 		sp = hook->private;
1435 		if (sp->state != PPPOE_SNONE ) {
1436 			pppoe_send_event(sp, NGM_PPPOE_CLOSE);
1437 		}
1438 		/*
1439 		 * According to the spec, if we are connected,
1440 		 * we should send a DISC packet if we are shutting down
1441 		 * a session.
1442 		 */
1443 		if ((privp->ethernet_hook)
1444 		&& ((sp->state == PPPOE_CONNECTED)
1445 		 || (sp->state == PPPOE_NEWCONNECTED))) {
1446 			struct mbuf *m;
1447 			struct pppoe_full_hdr *wh;
1448 			struct pppoe_tag *tag;
1449 			int	msglen = strlen(SIGNOFF);
1450 			void *dummy = NULL;
1451 			int error = 0;
1452 
1453 			/* revert the stored header to DISC/PADT mode */
1454 		 	wh = &sp->pkt_hdr;
1455 			wh->ph.code = PADT_CODE;
1456 			if (pppoe_mode == PPPOE_NONSTANDARD)
1457 				wh->eh.ether_type = ETHERTYPE_PPPOE_STUPID_DISC;
1458 			else
1459 				wh->eh.ether_type = ETHERTYPE_PPPOE_DISC;
1460 
1461 			/* generate a packet of that type */
1462 			MGETHDR(m, MB_DONTWAIT, MT_DATA);
1463 			if(m == NULL)
1464 				kprintf("pppoe: Session out of mbufs\n");
1465 			else {
1466 				m->m_pkthdr.rcvif = NULL;
1467 				m->m_pkthdr.len = m->m_len = sizeof(*wh);
1468 				bcopy((caddr_t)wh, mtod(m, caddr_t),
1469 				    sizeof(*wh));
1470 				/*
1471 				 * Add a General error message and adjust
1472 				 * sizes
1473 				 */
1474 				wh = mtod(m, struct pppoe_full_hdr *);
1475 				tag = wh->ph.tag;
1476 				tag->tag_type = PTT_GEN_ERR;
1477 				tag->tag_len = htons((u_int16_t)msglen);
1478 				strncpy(tag->tag_data, SIGNOFF, msglen);
1479 				m->m_pkthdr.len = (m->m_len += sizeof(*tag) +
1480 				    msglen);
1481 				wh->ph.length = htons(sizeof(*tag) + msglen);
1482 				NG_SEND_DATA(error, privp->ethernet_hook, m,
1483 				    dummy);
1484 			}
1485 		}
1486 		/*
1487 		 * As long as we have somewhere to store the timeout handle,
1488 		 * we may have a timeout pending.. get rid of it.
1489 		 */
1490 		if (sp->neg) {
1491 			callout_stop(&sp->neg->timeout_ch);
1492 			if (sp->neg->m)
1493 				m_freem(sp->neg->m);
1494 			kfree(sp->neg, M_NETGRAPH);
1495 		}
1496 		kfree(sp, M_NETGRAPH);
1497 		hook->private = NULL;
1498 		/* work out how many session hooks there are */
1499 		/* Node goes away on last session hook removal */
1500 		if (privp->ethernet_hook) hooks -= 1;
1501 		if (privp->debug_hook) hooks -= 1;
1502 	}
1503 	if (node->numhooks == 0)
1504 		ng_rmnode(node);
1505 	return (0);
1506 }
1507 
1508 /*
1509  * timeouts come here.
1510  */
1511 static void
1512 pppoe_ticker(void *arg)
1513 {
1514 	hook_p hook = arg;
1515 	sessp	sp = hook->private;
1516 	negp	neg = sp->neg;
1517 	int	error = 0;
1518 	struct mbuf *m0 = NULL;
1519 	priv_p privp = hook->node->private;
1520 	meta_p dummy = NULL;
1521 
1522 	crit_enter();
1523 AAA
1524 	switch(sp->state) {
1525 		/*
1526 		 * resend the last packet, using an exponential backoff.
1527 		 * After a period of time, stop growing the backoff,
1528 		 * and either leave it, or revert to the start.
1529 		 */
1530 	case	PPPOE_SINIT:
1531 	case	PPPOE_SREQ:
1532 		/* timeouts on these produce resends */
1533 		m0 = m_copypacket(sp->neg->m, MB_DONTWAIT);
1534 		NG_SEND_DATA( error, privp->ethernet_hook, m0, dummy);
1535 		callout_reset(&neg->timeout_ch, neg->timeout * hz,
1536 				pppoe_ticker, hook);
1537 		if ((neg->timeout <<= 1) > PPPOE_TIMEOUT_LIMIT) {
1538 			if (sp->state == PPPOE_SREQ) {
1539 				/* revert to SINIT mode */
1540 				pppoe_start(sp);
1541 			} else {
1542 				neg->timeout = PPPOE_TIMEOUT_LIMIT;
1543 			}
1544 		}
1545 		break;
1546 	case	PPPOE_PRIMED:
1547 	case	PPPOE_SOFFER:
1548 		/* a timeout on these says "give up" */
1549 		ng_destroy_hook(hook);
1550 		break;
1551 	default:
1552 		/* timeouts have no meaning in other states */
1553 		kprintf("pppoe: unexpected timeout\n");
1554 	}
1555 	crit_exit();
1556 }
1557 
1558 
1559 static void
1560 sendpacket(sessp sp)
1561 {
1562 	int	error = 0;
1563 	struct mbuf *m0 = NULL;
1564 	hook_p hook = sp->hook;
1565 	negp	neg = sp->neg;
1566 	priv_p	privp = hook->node->private;
1567 	meta_p dummy = NULL;
1568 
1569 AAA
1570 	switch(sp->state) {
1571 	case	PPPOE_LISTENING:
1572 	case	PPPOE_DEAD:
1573 	case	PPPOE_SNONE:
1574 	case	PPPOE_CONNECTED:
1575 		kprintf("pppoe: sendpacket: unexpected state\n");
1576 		break;
1577 
1578 	case	PPPOE_NEWCONNECTED:
1579 		/* send the PADS without a timeout - we're now connected */
1580 		m0 = m_copypacket(sp->neg->m, MB_DONTWAIT);
1581 		NG_SEND_DATA( error, privp->ethernet_hook, m0, dummy);
1582 		break;
1583 
1584 	case	PPPOE_PRIMED:
1585 		/* No packet to send, but set up the timeout */
1586 		callout_reset(&neg->timeout_ch, PPPOE_OFFER_TIMEOUT * hz,
1587 				pppoe_ticker, hook);
1588 		break;
1589 
1590 	case	PPPOE_SOFFER:
1591 		/*
1592 		 * send the offer but if they don't respond
1593 		 * in PPPOE_OFFER_TIMEOUT seconds, forget about it.
1594 		 */
1595 		m0 = m_copypacket(sp->neg->m, MB_DONTWAIT);
1596 		NG_SEND_DATA( error, privp->ethernet_hook, m0, dummy);
1597 		callout_reset(&neg->timeout_ch, PPPOE_OFFER_TIMEOUT * hz,
1598 				pppoe_ticker, hook);
1599 		break;
1600 
1601 	case	PPPOE_SINIT:
1602 	case	PPPOE_SREQ:
1603 		m0 = m_copypacket(sp->neg->m, MB_DONTWAIT);
1604 		NG_SEND_DATA( error, privp->ethernet_hook, m0, dummy);
1605 		callout_reset(&neg->timeout_ch, PPPOE_INITIAL_TIMEOUT * hz,
1606 				pppoe_ticker, hook);
1607 		neg->timeout = PPPOE_INITIAL_TIMEOUT * 2;
1608 		break;
1609 
1610 	default:
1611 		error = EINVAL;
1612 		kprintf("pppoe: timeout: bad state\n");
1613 	}
1614 	/* return (error); */
1615 }
1616 
1617 /*
1618  * Parse an incoming packet to see if any tags should be copied to the
1619  * output packet. Don't do any tags that have been handled in the main
1620  * state machine.
1621  */
1622 static const struct pppoe_tag*
1623 scan_tags(sessp	sp, const struct pppoe_hdr* ph)
1624 {
1625 	const char *const end = (const char *)next_tag(ph);
1626 	const char *ptn;
1627 	const struct pppoe_tag *pt = &ph->tag[0];
1628 	/*
1629 	 * Keep processing tags while a tag header will still fit.
1630 	 */
1631 AAA
1632 	while((const char*)(pt + 1) <= end) {
1633 		/*
1634 		 * If the tag data would go past the end of the packet, abort.
1635 		 */
1636 		ptn = (((const char *)(pt + 1)) + ntohs(pt->tag_len));
1637 		if(ptn > end)
1638 			return NULL;
1639 
1640 		switch (pt->tag_type) {
1641 		case	PTT_RELAY_SID:
1642 			insert_tag(sp, pt);
1643 			break;
1644 		case	PTT_EOL:
1645 			return NULL;
1646 		case	PTT_SRV_NAME:
1647 		case	PTT_AC_NAME:
1648 		case	PTT_HOST_UNIQ:
1649 		case	PTT_AC_COOKIE:
1650 		case	PTT_VENDOR:
1651 		case	PTT_SRV_ERR:
1652 		case	PTT_SYS_ERR:
1653 		case	PTT_GEN_ERR:
1654 			break;
1655 		}
1656 		pt = (const struct pppoe_tag*)ptn;
1657 	}
1658 	return NULL;
1659 }
1660 
1661 static	int
1662 pppoe_send_event(sessp sp, enum cmd cmdid)
1663 {
1664 	int error;
1665 	struct ng_mesg *msg;
1666 	struct ngpppoe_sts *sts;
1667 
1668 AAA
1669 	NG_MKMESSAGE(msg, NGM_PPPOE_COOKIE, cmdid,
1670 			sizeof(struct ngpppoe_sts), M_NOWAIT);
1671 	if (msg == NULL)
1672 		return (ENOMEM);
1673 	sts = (struct ngpppoe_sts *)msg->data;
1674 	strlcpy(sts->hook, sp->hook->name, NG_HOOKSIZ);
1675 	error = ng_send_msg(sp->hook->node, msg, sp->creator, NULL);
1676 	return (error);
1677 }
1678