5 * Copyright (c) 1996-2000 Whistle Communications, Inc.
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.
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
37 * Authors: Archie Cobbs <archie@freebsd.org>
38 * Julian Elischer <julian@freebsd.org>
40 * $FreeBSD: src/sys/netgraph/ng_ether.c,v 1.2.2.13 2002/07/02 20:10:25 archie Exp $
41 * $DragonFly: src/sys/netgraph/ether/ng_ether.c,v 1.11 2006/12/20 18:14:43 dillon Exp $
45 * ng_ether(4) netgraph node type
48 #include <sys/param.h>
49 #include <sys/systm.h>
50 #include <sys/kernel.h>
51 #include <sys/malloc.h>
53 #include <sys/errno.h>
54 #include <sys/syslog.h>
55 #include <sys/socket.h>
56 #include <sys/thread2.h>
59 #include <net/if_types.h>
60 #include <net/if_arp.h>
61 #include <net/if_var.h>
62 #include <net/ethernet.h>
64 #include <netgraph/ng_message.h>
65 #include <netgraph/netgraph.h>
66 #include <netgraph/ng_parse.h>
69 #define IFP2AC(IFP) ((struct arpcom *)IFP)
70 #define IFP2NG(ifp) (IFP2AC((ifp))->ac_netgraph)
72 /* Per-node private data */
74 struct ifnet
*ifp
; /* associated interface */
75 hook_p upper
; /* upper hook connection */
76 hook_p lower
; /* lower OR orphan hook connection */
77 u_char lowerOrphan
; /* whether lower is lower or orphan */
78 u_char autoSrcAddr
; /* always overwrite source address */
79 u_char promisc
; /* promiscuous mode enabled */
80 u_long hwassist
; /* hardware checksum capabilities */
82 typedef struct private *priv_p
;
84 /* Functional hooks called from if_ethersubr.c */
85 static void ng_ether_input(struct ifnet
*ifp
,
86 struct mbuf
**mp
, struct ether_header
*eh
);
87 static void ng_ether_input_orphan(struct ifnet
*ifp
,
88 struct mbuf
*m
, struct ether_header
*eh
);
89 static int ng_ether_output(struct ifnet
*ifp
, struct mbuf
**mp
);
90 static void ng_ether_attach(struct ifnet
*ifp
);
91 static void ng_ether_detach(struct ifnet
*ifp
);
94 static void ng_ether_input2(node_p node
,
95 struct mbuf
**mp
, struct ether_header
*eh
);
96 static int ng_ether_glueback_header(struct mbuf
**mp
,
97 struct ether_header
*eh
);
98 static int ng_ether_rcv_lower(node_p node
, struct mbuf
*m
, meta_p meta
);
99 static int ng_ether_rcv_upper(node_p node
, struct mbuf
*m
, meta_p meta
);
101 /* Netgraph node methods */
102 static ng_constructor_t ng_ether_constructor
;
103 static ng_rcvmsg_t ng_ether_rcvmsg
;
104 static ng_shutdown_t ng_ether_rmnode
;
105 static ng_newhook_t ng_ether_newhook
;
106 static ng_rcvdata_t ng_ether_rcvdata
;
107 static ng_disconnect_t ng_ether_disconnect
;
108 static int ng_ether_mod_event(module_t mod
, int event
, void *data
);
110 /* Parse type for an Ethernet address */
111 static ng_parse_t ng_enaddr_parse
;
112 static ng_unparse_t ng_enaddr_unparse
;
113 const struct ng_parse_type ng_ether_enaddr_type
= {
119 NULL
, /* no such thing as a "default" EN address */
123 /* List of commands and how to convert arguments to/from ASCII */
124 static const struct ng_cmdlist ng_ether_cmdlist
[] = {
127 NGM_ETHER_GET_IFNAME
,
130 &ng_parse_string_type
134 NGM_ETHER_GET_IFINDEX
,
141 NGM_ETHER_GET_ENADDR
,
144 &ng_ether_enaddr_type
148 NGM_ETHER_SET_ENADDR
,
150 &ng_ether_enaddr_type
,
155 NGM_ETHER_GET_PROMISC
,
162 NGM_ETHER_SET_PROMISC
,
164 &ng_parse_int32_type
,
169 NGM_ETHER_GET_AUTOSRC
,
176 NGM_ETHER_SET_AUTOSRC
,
178 &ng_parse_int32_type
,
184 static struct ng_type ng_ether_typestruct
= {
188 ng_ether_constructor
,
199 NETGRAPH_INIT(ether
, &ng_ether_typestruct
);
201 /******************************************************************
202 ETHERNET FUNCTION HOOKS
203 ******************************************************************/
206 * Handle a packet that has come in on an interface. We get to
207 * look at it here before any upper layer protocols do.
209 * NOTE: this function will get called at splimp()
212 ng_ether_input(struct ifnet
*ifp
,
213 struct mbuf
**mp
, struct ether_header
*eh
)
215 const node_p node
= IFP2NG(ifp
);
216 const priv_p priv
= node
->private;
218 /* If "lower" hook not connected, let packet continue */
219 if (priv
->lower
== NULL
|| priv
->lowerOrphan
)
221 ng_ether_input2(node
, mp
, eh
);
225 * Handle a packet that has come in on an interface, and which
226 * does not match any of our known protocols (an ``orphan'').
228 * NOTE: this function will get called at splimp()
231 ng_ether_input_orphan(struct ifnet
*ifp
,
232 struct mbuf
*m
, struct ether_header
*eh
)
234 const node_p node
= IFP2NG(ifp
);
235 const priv_p priv
= node
->private;
237 /* If "orphan" hook not connected, let packet continue */
238 if (priv
->lower
== NULL
|| !priv
->lowerOrphan
) {
242 ng_ether_input2(node
, &m
, eh
);
248 * Handle a packet that has come in on an interface.
249 * The Ethernet header has already been detached from the mbuf,
250 * so we have to put it back.
252 * NOTE: this function will get called at splimp()
255 ng_ether_input2(node_p node
, struct mbuf
**mp
, struct ether_header
*eh
)
257 const priv_p priv
= node
->private;
261 /* Glue Ethernet header back on */
262 if ((error
= ng_ether_glueback_header(mp
, eh
)) != 0)
265 /* Send out lower/orphan hook */
266 ng_queue_data(priv
->lower
, *mp
, meta
);
271 * Handle a packet that is going out on an interface.
272 * The Ethernet header is already attached to the mbuf.
275 ng_ether_output(struct ifnet
*ifp
, struct mbuf
**mp
)
277 const node_p node
= IFP2NG(ifp
);
278 const priv_p priv
= node
->private;
282 /* If "upper" hook not connected, let packet continue */
283 if (priv
->upper
== NULL
)
286 /* Send it out "upper" hook */
287 NG_SEND_DATA(error
, priv
->upper
, *mp
, meta
);
293 * A new Ethernet interface has been attached.
294 * Create a new node for it, etc.
297 ng_ether_attach(struct ifnet
*ifp
)
299 char name
[IFNAMSIZ
+ 1];
304 KASSERT(!IFP2NG(ifp
), ("%s: node already exists?", __func__
));
305 strlcpy(name
, ifp
->if_xname
, sizeof(name
));
306 if (ng_make_node_common(&ng_ether_typestruct
, &node
) != 0) {
307 log(LOG_ERR
, "%s: can't %s for %s\n",
308 __func__
, "create node", name
);
312 /* Allocate private data */
313 MALLOC(priv
, priv_p
, sizeof(*priv
), M_NETGRAPH
, M_NOWAIT
);
315 log(LOG_ERR
, "%s: can't %s for %s\n",
316 __func__
, "allocate memory", name
);
320 bzero(priv
, sizeof(*priv
));
321 node
->private = priv
;
324 priv
->autoSrcAddr
= 1;
325 priv
->hwassist
= ifp
->if_hwassist
;
327 /* Try to give the node the same name as the interface */
328 if (ng_name_node(node
, name
) != 0) {
329 log(LOG_WARNING
, "%s: can't name node %s\n",
335 * An Ethernet interface is being detached.
339 ng_ether_detach(struct ifnet
*ifp
)
341 const node_p node
= IFP2NG(ifp
);
344 if (node
== NULL
) /* no node (why not?), ignore */
346 ng_rmnode(node
); /* break all links to other nodes */
347 node
->flags
|= NG_INVALID
;
348 ng_unname(node
); /* free name (and its reference) */
349 IFP2NG(ifp
) = NULL
; /* detach node from interface */
350 priv
= node
->private; /* free node private info */
351 bzero(priv
, sizeof(*priv
));
352 FREE(priv
, M_NETGRAPH
);
353 node
->private = NULL
;
354 ng_unref(node
); /* free node itself */
358 * Optimization for gluing the Ethernet header back onto
359 * the front of an incoming packet.
362 ng_ether_glueback_header(struct mbuf
**mp
, struct ether_header
*eh
)
364 struct mbuf
*m
= *mp
;
368 * Optimize for the case where the header is already in place
369 * at the front of the mbuf. This is actually quite likely
370 * because many Ethernet drivers generate packets this way.
372 if (eh
== mtod(m
, struct ether_header
*) - 1) {
373 m
->m_len
+= sizeof(*eh
);
374 m
->m_data
-= sizeof(*eh
);
375 m
->m_pkthdr
.len
+= sizeof(*eh
);
379 /* Prepend the header back onto the front of the mbuf */
380 M_PREPEND(m
, sizeof(*eh
), MB_DONTWAIT
);
386 /* Copy header into front of mbuf */
387 bcopy(eh
, mtod(m
, void *), sizeof(*eh
));
395 /******************************************************************
396 NETGRAPH NODE METHODS
397 ******************************************************************/
400 * It is not possible or allowable to create a node of this type.
401 * Nodes get created when the interface is attached (or, when
402 * this node type's KLD is loaded).
405 ng_ether_constructor(node_p
*nodep
)
411 * Check for attaching a new hook.
414 ng_ether_newhook(node_p node
, hook_p hook
, const char *name
)
416 const priv_p priv
= node
->private;
417 u_char orphan
= priv
->lowerOrphan
;
420 /* Divert hook is an alias for lower */
421 if (strcmp(name
, NG_ETHER_HOOK_DIVERT
) == 0)
422 name
= NG_ETHER_HOOK_LOWER
;
425 if (strcmp(name
, NG_ETHER_HOOK_UPPER
) == 0)
426 hookptr
= &priv
->upper
;
427 else if (strcmp(name
, NG_ETHER_HOOK_LOWER
) == 0) {
428 hookptr
= &priv
->lower
;
430 } else if (strcmp(name
, NG_ETHER_HOOK_ORPHAN
) == 0) {
431 hookptr
= &priv
->lower
;
436 /* Check if already connected (shouldn't be, but doesn't hurt) */
437 if (*hookptr
!= NULL
)
440 /* Disable hardware checksums while 'upper' hook is connected */
441 if (hookptr
== &priv
->upper
)
442 priv
->ifp
->if_hwassist
= 0;
446 priv
->lowerOrphan
= orphan
;
451 * Receive an incoming control message.
454 ng_ether_rcvmsg(node_p node
, struct ng_mesg
*msg
,
455 const char *retaddr
, struct ng_mesg
**rptr
)
457 const priv_p priv
= node
->private;
458 struct ng_mesg
*resp
= NULL
;
461 switch (msg
->header
.typecookie
) {
462 case NGM_ETHER_COOKIE
:
463 switch (msg
->header
.cmd
) {
464 case NGM_ETHER_GET_IFNAME
:
465 NG_MKRESPONSE(resp
, msg
, IFNAMSIZ
+ 1, M_NOWAIT
);
470 strlcpy(resp
->data
, priv
->ifp
->if_xname
, IFNAMSIZ
);
472 case NGM_ETHER_GET_IFINDEX
:
473 NG_MKRESPONSE(resp
, msg
, sizeof(u_int32_t
), M_NOWAIT
);
478 *((u_int32_t
*)resp
->data
) = priv
->ifp
->if_index
;
480 case NGM_ETHER_GET_ENADDR
:
481 NG_MKRESPONSE(resp
, msg
, ETHER_ADDR_LEN
, M_NOWAIT
);
486 bcopy((IFP2AC(priv
->ifp
))->ac_enaddr
,
487 resp
->data
, ETHER_ADDR_LEN
);
489 case NGM_ETHER_SET_ENADDR
:
491 if (msg
->header
.arglen
!= ETHER_ADDR_LEN
) {
495 error
= if_setlladdr(priv
->ifp
,
496 (u_char
*)msg
->data
, ETHER_ADDR_LEN
);
499 case NGM_ETHER_GET_PROMISC
:
500 NG_MKRESPONSE(resp
, msg
, sizeof(u_int32_t
), M_NOWAIT
);
505 *((u_int32_t
*)resp
->data
) = priv
->promisc
;
507 case NGM_ETHER_SET_PROMISC
:
511 if (msg
->header
.arglen
!= sizeof(u_int32_t
)) {
515 want
= !!*((u_int32_t
*)msg
->data
);
516 if (want
^ priv
->promisc
) {
517 if ((error
= ifpromisc(priv
->ifp
, want
)) != 0)
519 priv
->promisc
= want
;
523 case NGM_ETHER_GET_AUTOSRC
:
524 NG_MKRESPONSE(resp
, msg
, sizeof(u_int32_t
), M_NOWAIT
);
529 *((u_int32_t
*)resp
->data
) = priv
->autoSrcAddr
;
531 case NGM_ETHER_SET_AUTOSRC
:
532 if (msg
->header
.arglen
!= sizeof(u_int32_t
)) {
536 priv
->autoSrcAddr
= !!*((u_int32_t
*)msg
->data
);
549 else if (resp
!= NULL
)
550 FREE(resp
, M_NETGRAPH
);
551 FREE(msg
, M_NETGRAPH
);
556 * Receive data on a hook.
559 ng_ether_rcvdata(hook_p hook
, struct mbuf
*m
, meta_p meta
)
561 const node_p node
= hook
->node
;
562 const priv_p priv
= node
->private;
564 if (hook
== priv
->lower
)
565 return ng_ether_rcv_lower(node
, m
, meta
);
566 if (hook
== priv
->upper
)
567 return ng_ether_rcv_upper(node
, m
, meta
);
568 panic("%s: weird hook", __func__
);
572 * Handle an mbuf received on the "lower" hook.
575 ng_ether_rcv_lower(node_p node
, struct mbuf
*m
, meta_p meta
)
577 const priv_p priv
= node
->private;
578 struct ifnet
*const ifp
= priv
->ifp
;
581 /* Discard meta info */
584 /* Check whether interface is ready for packets */
585 if ((ifp
->if_flags
& (IFF_UP
|IFF_RUNNING
)) != (IFF_UP
|IFF_RUNNING
)) {
590 /* Make sure header is fully pulled up */
591 if (m
->m_pkthdr
.len
< sizeof(struct ether_header
)) {
595 if (m
->m_len
< sizeof(struct ether_header
)
596 && (m
= m_pullup(m
, sizeof(struct ether_header
))) == NULL
)
599 /* Drop in the MAC address if desired */
600 if (priv
->autoSrcAddr
) {
602 /* Make the mbuf writable if it's not already */
604 && (m
= m_pullup(m
, sizeof(struct ether_header
))) == NULL
)
607 /* Overwrite source MAC address */
608 bcopy((IFP2AC(ifp
))->ac_enaddr
,
609 mtod(m
, struct ether_header
*)->ether_shost
,
613 /* Send it on its way */
614 lwkt_serialize_enter(ifp
->if_serializer
);
615 error
= ether_output_frame(ifp
, m
);
616 lwkt_serialize_exit(ifp
->if_serializer
);
622 * Handle an mbuf received on the "upper" hook.
625 ng_ether_rcv_upper(node_p node
, struct mbuf
*m
, meta_p meta
)
627 const priv_p priv
= node
->private;
628 struct ether_header
*eh
;
630 /* Discard meta info */
633 /* Check length and pull off header */
634 if (m
->m_pkthdr
.len
< sizeof(*eh
)) {
638 if (m
->m_len
< sizeof(*eh
) && (m
= m_pullup(m
, sizeof(*eh
))) == NULL
)
640 eh
= mtod(m
, struct ether_header
*);
641 m
->m_data
+= sizeof(*eh
);
642 m
->m_len
-= sizeof(*eh
);
643 m
->m_pkthdr
.len
-= sizeof(*eh
);
644 m
->m_pkthdr
.rcvif
= priv
->ifp
;
646 /* Route packet back in */
647 lwkt_serialize_enter(priv
->ifp
->if_serializer
);
648 ether_demux(priv
->ifp
, eh
, m
);
649 lwkt_serialize_exit(priv
->ifp
->if_serializer
);
654 * Shutdown node. This resets the node but does not remove it.
657 ng_ether_rmnode(node_p node
)
659 const priv_p priv
= node
->private;
662 node
->flags
&= ~NG_INVALID
; /* bounce back to life */
663 if (priv
->promisc
) { /* disable promiscuous mode */
664 ifpromisc(priv
->ifp
, 0);
667 priv
->autoSrcAddr
= 1; /* reset auto-src-addr flag */
672 * Hook disconnection.
675 ng_ether_disconnect(hook_p hook
)
677 const priv_p priv
= hook
->node
->private;
679 if (hook
== priv
->upper
) {
681 priv
->ifp
->if_hwassist
= priv
->hwassist
; /* restore h/w csum */
682 } else if (hook
== priv
->lower
) {
684 priv
->lowerOrphan
= 0;
686 panic("%s: weird hook", __func__
);
687 if (hook
->node
->numhooks
== 0)
688 ng_rmnode(hook
->node
); /* reset node */
693 ng_enaddr_parse(const struct ng_parse_type
*type
,
694 const char *s
, int *const off
, const u_char
*const start
,
695 u_char
*const buf
, int *const buflen
)
701 if (*buflen
< ETHER_ADDR_LEN
)
703 for (i
= 0; i
< ETHER_ADDR_LEN
; i
++) {
704 val
= strtoul(s
+ *off
, &eptr
, 16);
705 if (val
> 0xff || eptr
== s
+ *off
)
707 buf
[i
] = (u_char
)val
;
709 if (i
< ETHER_ADDR_LEN
- 1) {
715 *buflen
= ETHER_ADDR_LEN
;
720 ng_enaddr_unparse(const struct ng_parse_type
*type
,
721 const u_char
*data
, int *off
, char *cbuf
, int cbuflen
)
725 len
= ksnprintf(cbuf
, cbuflen
, "%02x:%02x:%02x:%02x:%02x:%02x",
726 data
[*off
], data
[*off
+ 1], data
[*off
+ 2],
727 data
[*off
+ 3], data
[*off
+ 4], data
[*off
+ 5]);
730 *off
+= ETHER_ADDR_LEN
;
734 /******************************************************************
736 ******************************************************************/
739 * Handle loading and unloading for this node type.
742 ng_ether_mod_event(module_t mod
, int event
, void *data
)
751 /* Register function hooks */
752 if (ng_ether_attach_p
!= NULL
) {
756 ng_ether_attach_p
= ng_ether_attach
;
757 ng_ether_detach_p
= ng_ether_detach
;
758 ng_ether_output_p
= ng_ether_output
;
759 ng_ether_input_p
= ng_ether_input
;
760 ng_ether_input_orphan_p
= ng_ether_input_orphan
;
762 /* Create nodes for any already-existing Ethernet interfaces */
763 TAILQ_FOREACH(ifp
, &ifnet
, if_link
) {
764 if (ifp
->if_type
== IFT_ETHER
||
765 ifp
->if_type
== IFT_L2VLAN
)
766 ng_ether_attach(ifp
);
773 * Note that the base code won't try to unload us until
774 * all nodes have been removed, and that can't happen
775 * until all Ethernet interfaces are removed. In any
776 * case, we know there are no nodes left if the action
777 * is MOD_UNLOAD, so there's no need to detach any nodes.
780 /* Unregister function hooks */
781 ng_ether_attach_p
= NULL
;
782 ng_ether_detach_p
= NULL
;
783 ng_ether_output_p
= NULL
;
784 ng_ether_input_p
= NULL
;
785 ng_ether_input_orphan_p
= NULL
;