5 * Copyright (c) 1996-1999 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 * Author: Julian Elischer <julian@freebsd.org>
39 * $FreeBSD: src/sys/netgraph/ng_cisco.c,v 1.4.2.6 2002/07/02 23:44:02 archie Exp $
40 * $DragonFly: src/sys/netgraph/cisco/ng_cisco.c,v 1.10 2008/01/05 14:02:39 swildner Exp $
41 * $Whistle: ng_cisco.c,v 1.25 1999/11/01 09:24:51 julian Exp $
44 #include <sys/param.h>
45 #include <sys/systm.h>
46 #include <sys/errno.h>
47 #include <sys/kernel.h>
48 #include <sys/socket.h>
49 #include <sys/malloc.h>
51 #include <sys/syslog.h>
52 #include <sys/thread2.h>
54 #include <machine/inttypes.h>
58 #include <netinet/in.h>
59 #include <netinet/if_ether.h>
61 #include <netproto/atalk/at.h>
63 #include <netproto/ipx/ipx.h>
64 #include <netproto/ipx/ipx_if.h>
66 #include <netgraph/ng_message.h>
67 #include <netgraph/netgraph.h>
68 #include <netgraph/ng_parse.h>
71 #define CISCO_MULTICAST 0x8f /* Cisco multicast address */
72 #define CISCO_UNICAST 0x0f /* Cisco unicast address */
73 #define CISCO_KEEPALIVE 0x8035 /* Cisco keepalive protocol */
74 #define CISCO_ADDR_REQ 0 /* Cisco address request */
75 #define CISCO_ADDR_REPLY 1 /* Cisco address reply */
76 #define CISCO_KEEPALIVE_REQ 2 /* Cisco keepalive request */
78 #define KEEPALIVE_SECS 10
86 #define CISCO_HEADER_LEN sizeof (struct cisco_header)
97 #define CISCO_PACKET_LEN (sizeof(struct cisco_packet))
100 hook_p hook
; /* the hook for this proto */
101 u_short af
; /* address family, -1 = downstream */
107 u_long seqRetries
; /* how many times we've been here throwing out
108 * the same sequence number without ack */
110 struct callout timeout
;
111 struct protoent downstream
;
112 struct protoent inet
; /* IP information */
113 struct in_addr localip
;
114 struct in_addr localmask
;
115 struct protoent inet6
; /* IPv6 information */
116 struct protoent atalk
; /* AppleTalk information */
117 struct protoent ipx
; /* IPX information */
119 typedef struct cisco_priv
*sc_p
;
121 /* Netgraph methods */
122 static ng_constructor_t cisco_constructor
;
123 static ng_rcvmsg_t cisco_rcvmsg
;
124 static ng_shutdown_t cisco_rmnode
;
125 static ng_newhook_t cisco_newhook
;
126 static ng_rcvdata_t cisco_rcvdata
;
127 static ng_disconnect_t cisco_disconnect
;
129 /* Other functions */
130 static int cisco_input(sc_p sc
, struct mbuf
*m
, meta_p meta
);
131 static void cisco_keepalive(void *arg
);
132 static int cisco_send(sc_p sc
, int type
, long par1
, long par2
);
134 /* Parse type for struct ng_cisco_ipaddr */
135 static const struct ng_parse_struct_field ng_cisco_ipaddr_type_fields
[]
136 = NG_CISCO_IPADDR_TYPE_INFO
;
137 static const struct ng_parse_type ng_cisco_ipaddr_type
= {
138 &ng_parse_struct_type
,
139 &ng_cisco_ipaddr_type_fields
142 /* Parse type for struct ng_async_stat */
143 static const struct ng_parse_struct_field ng_cisco_stats_type_fields
[]
144 = NG_CISCO_STATS_TYPE_INFO
;
145 static const struct ng_parse_type ng_cisco_stats_type
= {
146 &ng_parse_struct_type
,
147 &ng_cisco_stats_type_fields
150 /* List of commands and how to convert arguments to/from ASCII */
151 static const struct ng_cmdlist ng_cisco_cmdlist
[] = {
154 NGM_CISCO_SET_IPADDR
,
156 &ng_cisco_ipaddr_type
,
161 NGM_CISCO_GET_IPADDR
,
164 &ng_cisco_ipaddr_type
168 NGM_CISCO_GET_STATUS
,
177 static struct ng_type typestruct
= {
192 NETGRAPH_INIT(cisco
, &typestruct
);
198 cisco_constructor(node_p
*nodep
)
203 MALLOC(sc
, sc_p
, sizeof(*sc
), M_NETGRAPH
, M_NOWAIT
| M_ZERO
);
207 callout_init(&sc
->timeout
);
208 if ((error
= ng_make_node_common(&typestruct
, nodep
))) {
209 FREE(sc
, M_NETGRAPH
);
212 (*nodep
)->private = sc
;
215 /* Initialise the varous protocol hook holders */
216 sc
->downstream
.af
= 0xffff;
217 sc
->inet
.af
= AF_INET
;
218 sc
->inet6
.af
= AF_INET6
;
219 sc
->atalk
.af
= AF_APPLETALK
;
228 cisco_newhook(node_p node
, hook_p hook
, const char *name
)
230 const sc_p sc
= node
->private;
232 if (strcmp(name
, NG_CISCO_HOOK_DOWNSTREAM
) == 0) {
233 sc
->downstream
.hook
= hook
;
234 hook
->private = &sc
->downstream
;
236 /* Start keepalives */
237 callout_reset(&sc
->timeout
, hz
* KEEPALIVE_SECS
,
238 cisco_keepalive
, sc
);
239 } else if (strcmp(name
, NG_CISCO_HOOK_INET
) == 0) {
240 sc
->inet
.hook
= hook
;
241 hook
->private = &sc
->inet
;
242 } else if (strcmp(name
, NG_CISCO_HOOK_APPLETALK
) == 0) {
243 sc
->atalk
.hook
= hook
;
244 hook
->private = &sc
->atalk
;
245 } else if (strcmp(name
, NG_CISCO_HOOK_IPX
) == 0) {
247 hook
->private = &sc
->ipx
;
248 } else if (strcmp(name
, NG_CISCO_HOOK_DEBUG
) == 0) {
249 hook
->private = NULL
; /* unimplemented */
256 * Receive control message.
259 cisco_rcvmsg(node_p node
, struct ng_mesg
*msg
,
260 const char *retaddr
, struct ng_mesg
**rptr
)
262 const sc_p sc
= node
->private;
263 struct ng_mesg
*resp
= NULL
;
266 switch (msg
->header
.typecookie
) {
267 case NGM_GENERIC_COOKIE
:
268 switch (msg
->header
.cmd
) {
269 case NGM_TEXT_STATUS
:
274 NG_MKRESPONSE(resp
, msg
, sizeof(struct ng_mesg
)
275 + NG_TEXTRESPONSE
, M_NOWAIT
);
280 arg
= (char *) resp
->data
;
282 "keepalive period: %d sec; ", KEEPALIVE_SECS
);
283 pos
+= ksprintf(arg
+ pos
,
284 "unacknowledged keepalives: %ld", sc
->seqRetries
);
285 resp
->header
.arglen
= pos
+ 1;
293 case NGM_CISCO_COOKIE
:
294 switch (msg
->header
.cmd
) {
295 case NGM_CISCO_GET_IPADDR
: /* could be a late reply! */
296 if ((msg
->header
.flags
& NGF_RESP
) == 0) {
299 NG_MKRESPONSE(resp
, msg
,
300 2 * sizeof(*ips
), M_NOWAIT
);
305 ips
= (struct in_addr
*) resp
->data
;
306 ips
[0] = sc
->localip
;
307 ips
[1] = sc
->localmask
;
310 /* FALLTHROUGH */ /* ...if it's a reply */
311 case NGM_CISCO_SET_IPADDR
:
313 struct in_addr
*const ips
= (struct in_addr
*)msg
->data
;
315 if (msg
->header
.arglen
< 2 * sizeof(*ips
)) {
319 sc
->localip
= ips
[0];
320 sc
->localmask
= ips
[1];
323 case NGM_CISCO_GET_STATUS
:
325 struct ng_cisco_stats
*stat
;
327 NG_MKRESPONSE(resp
, msg
, sizeof(*stat
), M_NOWAIT
);
332 stat
= (struct ng_cisco_stats
*)resp
->data
;
333 stat
->seqRetries
= sc
->seqRetries
;
334 stat
->keepAlivePeriod
= KEEPALIVE_SECS
;
349 FREE(resp
, M_NETGRAPH
);
350 FREE(msg
, M_NETGRAPH
);
358 cisco_rcvdata(hook_p hook
, struct mbuf
*m
, meta_p meta
)
360 const sc_p sc
= hook
->node
->private;
361 struct protoent
*pep
;
362 struct cisco_header
*h
;
365 if ((pep
= hook
->private) == NULL
)
368 /* If it came from our downlink, deal with it separately */
369 if (pep
->af
== 0xffff)
370 return (cisco_input(sc
, m
, meta
));
372 /* OK so it came from a protocol, heading out. Prepend general data
373 packet header. For now, IP,IPX only */
374 M_PREPEND(m
, CISCO_HEADER_LEN
, MB_DONTWAIT
);
379 h
= mtod(m
, struct cisco_header
*);
380 h
->address
= CISCO_UNICAST
;
384 case AF_INET
: /* Internet Protocol */
385 h
->protocol
= htons(ETHERTYPE_IP
);
388 h
->protocol
= htons(ETHERTYPE_IPV6
);
390 case AF_APPLETALK
: /* AppleTalk Protocol */
391 h
->protocol
= htons(ETHERTYPE_AT
);
393 case AF_IPX
: /* Novell IPX Protocol */
394 h
->protocol
= htons(ETHERTYPE_IPX
);
397 error
= EAFNOSUPPORT
;
402 NG_SEND_DATA(error
, sc
->downstream
.hook
, m
, meta
);
406 NG_FREE_DATA(m
, meta
);
414 cisco_rmnode(node_p node
)
416 const sc_p sc
= node
->private;
418 node
->flags
|= NG_INVALID
;
421 node
->private = NULL
;
423 FREE(sc
, M_NETGRAPH
);
428 * Disconnection of a hook
430 * For this type, removal of the last link destroys the node
433 cisco_disconnect(hook_p hook
)
435 const sc_p sc
= hook
->node
->private;
436 struct protoent
*pep
;
438 /* Check it's not the debug hook */
439 if ((pep
= hook
->private)) {
441 if (pep
->af
== 0xffff) {
442 /* If it is the downstream hook, stop the timers */
443 callout_stop(&sc
->timeout
);
447 /* If no more hooks, remove the node */
448 if (hook
->node
->numhooks
== 0)
449 ng_rmnode(hook
->node
);
457 cisco_input(sc_p sc
, struct mbuf
*m
, meta_p meta
)
459 const struct cisco_header
*h
;
460 struct cisco_header hdrbuf
;
461 struct protoent
*pep
;
464 /* Sanity check header length */
465 if (m
->m_pkthdr
.len
< sizeof(*h
)) {
470 /* Get cisco header */
471 if (m
->m_len
>= sizeof(*h
)) /* the common case */
472 h
= mtod(m
, const struct cisco_header
*);
474 m_copydata(m
, 0, sizeof(*h
), (caddr_t
)&hdrbuf
);
477 m_adj(m
, sizeof(*h
));
479 /* Check header address */
480 switch (h
->address
) {
481 default: /* Invalid Cisco packet. */
484 case CISCO_MULTICAST
:
485 /* Don't check the control field here (RFC 1547). */
486 switch (ntohs(h
->protocol
)) {
489 case CISCO_KEEPALIVE
:
491 const struct cisco_packet
*p
;
492 struct cisco_packet pktbuf
;
494 /* Sanity check packet length */
495 if (m
->m_pkthdr
.len
< sizeof(*p
)) {
500 /* Get cisco packet */
501 if (m
->m_len
>= sizeof(*p
)) /* the common case */
502 p
= mtod(m
, const struct cisco_packet
*);
504 m_copydata(m
, 0, sizeof(*p
), (caddr_t
)&pktbuf
);
508 /* Check packet type */
509 switch (ntohl(p
->type
)) {
512 "cisco: unknown cisco packet type: 0x%"PRIx32
"\n",
515 case CISCO_ADDR_REPLY
:
516 /* Reply on address request, ignore */
518 case CISCO_KEEPALIVE_REQ
:
519 sc
->remote_seq
= ntohl(p
->par1
);
520 if (sc
->local_seq
== ntohl(p
->par2
)) {
527 struct ng_mesg
*msg
, *resp
;
529 /* Ask inet peer for IP address information */
530 if (sc
->inet
.hook
== NULL
)
532 NG_MKMESSAGE(msg
, NGM_CISCO_COOKIE
,
533 NGM_CISCO_GET_IPADDR
, 0, M_NOWAIT
);
536 ng_send_msg(sc
->node
, msg
,
537 NG_CISCO_HOOK_INET
, &resp
);
539 cisco_rcvmsg(sc
->node
, resp
, ".", NULL
);
542 /* Send reply to peer device */
543 error
= cisco_send(sc
, CISCO_ADDR_REPLY
,
544 ntohl(sc
->localip
.s_addr
),
545 ntohl(sc
->localmask
.s_addr
));
567 /* Drop if payload is empty */
568 if (m
->m_pkthdr
.len
== 0) {
574 if (pep
->hook
== NULL
)
576 NG_SEND_DATA(error
, pep
->hook
, m
, meta
);
580 NG_FREE_DATA(m
, meta
);
586 * Send keepalive packets, every 10 seconds.
589 cisco_keepalive(void *arg
)
594 cisco_send(sc
, CISCO_KEEPALIVE_REQ
, sc
->local_seq
, sc
->remote_seq
);
597 callout_reset(&sc
->timeout
, hz
* KEEPALIVE_SECS
,
598 cisco_keepalive
, sc
);
602 * Send Cisco keepalive packet.
605 cisco_send(sc_p sc
, int type
, long par1
, long par2
)
607 struct cisco_header
*h
;
608 struct cisco_packet
*ch
;
617 MGETHDR(m
, MB_DONTWAIT
, MT_DATA
);
621 t
= (time
.tv_sec
- boottime
.tv_sec
) * 1000;
622 m
->m_pkthdr
.len
= m
->m_len
= CISCO_HEADER_LEN
+ CISCO_PACKET_LEN
;
623 m
->m_pkthdr
.rcvif
= 0;
625 h
= mtod(m
, struct cisco_header
*);
626 h
->address
= CISCO_MULTICAST
;
628 h
->protocol
= htons(CISCO_KEEPALIVE
);
630 ch
= (struct cisco_packet
*) (h
+ 1);
631 ch
->type
= htonl(type
);
632 ch
->par1
= htonl(par1
);
633 ch
->par2
= htonl(par2
);
635 ch
->time0
= htons((u_short
) (t
>> 16));
636 ch
->time1
= htons((u_short
) t
);
638 NG_SEND_DATA(error
, sc
->downstream
.hook
, m
, meta
);