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 * $Whistle: ng_cisco.c,v 1.25 1999/11/01 09:24:51 julian Exp $
43 #include <sys/param.h>
44 #include <sys/systm.h>
45 #include <sys/errno.h>
46 #include <sys/kernel.h>
47 #include <sys/socket.h>
48 #include <sys/malloc.h>
50 #include <sys/syslog.h>
51 #include <sys/thread2.h>
53 #include <machine/inttypes.h>
57 #include <netinet/in.h>
58 #include <netinet/if_ether.h>
60 #include <netgraph/ng_message.h>
61 #include <netgraph/netgraph.h>
62 #include <netgraph/ng_parse.h>
65 #define CISCO_MULTICAST 0x8f /* Cisco multicast address */
66 #define CISCO_UNICAST 0x0f /* Cisco unicast address */
67 #define CISCO_KEEPALIVE 0x8035 /* Cisco keepalive protocol */
68 #define CISCO_ADDR_REQ 0 /* Cisco address request */
69 #define CISCO_ADDR_REPLY 1 /* Cisco address reply */
70 #define CISCO_KEEPALIVE_REQ 2 /* Cisco keepalive request */
72 #define KEEPALIVE_SECS 10
80 #define CISCO_HEADER_LEN sizeof (struct cisco_header)
91 #define CISCO_PACKET_LEN (sizeof(struct cisco_packet))
94 hook_p hook
; /* the hook for this proto */
95 u_short af
; /* address family, -1 = downstream */
101 u_long seqRetries
; /* how many times we've been here throwing out
102 * the same sequence number without ack */
104 struct callout timeout
;
105 struct protoent downstream
;
106 struct protoent inet
; /* IP information */
107 struct in_addr localip
;
108 struct in_addr localmask
;
109 struct protoent inet6
; /* IPv6 information */
110 struct protoent ipx
; /* IPX information */
112 typedef struct cisco_priv
*sc_p
;
114 /* Netgraph methods */
115 static ng_constructor_t cisco_constructor
;
116 static ng_rcvmsg_t cisco_rcvmsg
;
117 static ng_shutdown_t cisco_rmnode
;
118 static ng_newhook_t cisco_newhook
;
119 static ng_rcvdata_t cisco_rcvdata
;
120 static ng_disconnect_t cisco_disconnect
;
122 /* Other functions */
123 static int cisco_input(sc_p sc
, struct mbuf
*m
, meta_p meta
);
124 static void cisco_keepalive(void *arg
);
125 static int cisco_send(sc_p sc
, int type
, long par1
, long par2
);
127 /* Parse type for struct ng_cisco_ipaddr */
128 static const struct ng_parse_struct_field ng_cisco_ipaddr_type_fields
[]
129 = NG_CISCO_IPADDR_TYPE_INFO
;
130 static const struct ng_parse_type ng_cisco_ipaddr_type
= {
131 &ng_parse_struct_type
,
132 &ng_cisco_ipaddr_type_fields
135 /* Parse type for struct ng_async_stat */
136 static const struct ng_parse_struct_field ng_cisco_stats_type_fields
[]
137 = NG_CISCO_STATS_TYPE_INFO
;
138 static const struct ng_parse_type ng_cisco_stats_type
= {
139 &ng_parse_struct_type
,
140 &ng_cisco_stats_type_fields
143 /* List of commands and how to convert arguments to/from ASCII */
144 static const struct ng_cmdlist ng_cisco_cmdlist
[] = {
147 NGM_CISCO_SET_IPADDR
,
149 &ng_cisco_ipaddr_type
,
154 NGM_CISCO_GET_IPADDR
,
157 &ng_cisco_ipaddr_type
161 NGM_CISCO_GET_STATUS
,
170 static struct ng_type typestruct
= {
185 NETGRAPH_INIT(cisco
, &typestruct
);
191 cisco_constructor(node_p
*nodep
)
196 sc
= kmalloc(sizeof(*sc
), M_NETGRAPH
, M_NOWAIT
| M_ZERO
);
200 callout_init(&sc
->timeout
);
201 if ((error
= ng_make_node_common(&typestruct
, nodep
))) {
202 kfree(sc
, M_NETGRAPH
);
205 (*nodep
)->private = sc
;
208 /* Initialise the varous protocol hook holders */
209 sc
->downstream
.af
= 0xffff;
210 sc
->inet
.af
= AF_INET
;
211 sc
->inet6
.af
= AF_INET6
;
220 cisco_newhook(node_p node
, hook_p hook
, const char *name
)
222 const sc_p sc
= node
->private;
224 if (strcmp(name
, NG_CISCO_HOOK_DOWNSTREAM
) == 0) {
225 sc
->downstream
.hook
= hook
;
226 hook
->private = &sc
->downstream
;
228 /* Start keepalives */
229 callout_reset(&sc
->timeout
, hz
* KEEPALIVE_SECS
,
230 cisco_keepalive
, sc
);
231 } else if (strcmp(name
, NG_CISCO_HOOK_INET
) == 0) {
232 sc
->inet
.hook
= hook
;
233 hook
->private = &sc
->inet
;
234 } else if (strcmp(name
, NG_CISCO_HOOK_IPX
) == 0) {
236 hook
->private = &sc
->ipx
;
237 } else if (strcmp(name
, NG_CISCO_HOOK_DEBUG
) == 0) {
238 hook
->private = NULL
; /* unimplemented */
245 * Receive control message.
248 cisco_rcvmsg(node_p node
, struct ng_mesg
*msg
,
249 const char *retaddr
, struct ng_mesg
**rptr
)
251 const sc_p sc
= node
->private;
252 struct ng_mesg
*resp
= NULL
;
255 switch (msg
->header
.typecookie
) {
256 case NGM_GENERIC_COOKIE
:
257 switch (msg
->header
.cmd
) {
258 case NGM_TEXT_STATUS
:
263 NG_MKRESPONSE(resp
, msg
, sizeof(struct ng_mesg
)
264 + NG_TEXTRESPONSE
, M_NOWAIT
);
269 arg
= (char *) resp
->data
;
271 "keepalive period: %d sec; ", KEEPALIVE_SECS
);
272 pos
+= ksprintf(arg
+ pos
,
273 "unacknowledged keepalives: %ld", sc
->seqRetries
);
274 resp
->header
.arglen
= pos
+ 1;
282 case NGM_CISCO_COOKIE
:
283 switch (msg
->header
.cmd
) {
284 case NGM_CISCO_GET_IPADDR
: /* could be a late reply! */
285 if ((msg
->header
.flags
& NGF_RESP
) == 0) {
288 NG_MKRESPONSE(resp
, msg
,
289 2 * sizeof(*ips
), M_NOWAIT
);
294 ips
= (struct in_addr
*) resp
->data
;
295 ips
[0] = sc
->localip
;
296 ips
[1] = sc
->localmask
;
299 /* FALLTHROUGH */ /* ...if it's a reply */
300 case NGM_CISCO_SET_IPADDR
:
302 struct in_addr
*const ips
= (struct in_addr
*)msg
->data
;
304 if (msg
->header
.arglen
< 2 * sizeof(*ips
)) {
308 sc
->localip
= ips
[0];
309 sc
->localmask
= ips
[1];
312 case NGM_CISCO_GET_STATUS
:
314 struct ng_cisco_stats
*stat
;
316 NG_MKRESPONSE(resp
, msg
, sizeof(*stat
), M_NOWAIT
);
321 stat
= (struct ng_cisco_stats
*)resp
->data
;
322 stat
->seqRetries
= sc
->seqRetries
;
323 stat
->keepAlivePeriod
= KEEPALIVE_SECS
;
338 kfree(resp
, M_NETGRAPH
);
339 kfree(msg
, M_NETGRAPH
);
347 cisco_rcvdata(hook_p hook
, struct mbuf
*m
, meta_p meta
)
349 const sc_p sc
= hook
->node
->private;
350 struct protoent
*pep
;
351 struct cisco_header
*h
;
354 if ((pep
= hook
->private) == NULL
)
357 /* If it came from our downlink, deal with it separately */
358 if (pep
->af
== 0xffff)
359 return (cisco_input(sc
, m
, meta
));
361 /* OK so it came from a protocol, heading out. Prepend general data
362 packet header. For now, IP,IPX only */
363 M_PREPEND(m
, CISCO_HEADER_LEN
, M_NOWAIT
);
368 h
= mtod(m
, struct cisco_header
*);
369 h
->address
= CISCO_UNICAST
;
373 case AF_INET
: /* Internet Protocol */
374 h
->protocol
= htons(ETHERTYPE_IP
);
377 h
->protocol
= htons(ETHERTYPE_IPV6
);
379 case AF_IPX
: /* Novell IPX Protocol */
380 h
->protocol
= htons(ETHERTYPE_IPX
);
383 error
= EAFNOSUPPORT
;
388 NG_SEND_DATA(error
, sc
->downstream
.hook
, m
, meta
);
392 NG_FREE_DATA(m
, meta
);
400 cisco_rmnode(node_p node
)
402 const sc_p sc
= node
->private;
404 node
->flags
|= NG_INVALID
;
407 node
->private = NULL
;
409 kfree(sc
, M_NETGRAPH
);
414 * Disconnection of a hook
416 * For this type, removal of the last link destroys the node
419 cisco_disconnect(hook_p hook
)
421 const sc_p sc
= hook
->node
->private;
422 struct protoent
*pep
;
424 /* Check it's not the debug hook */
425 if ((pep
= hook
->private)) {
427 if (pep
->af
== 0xffff) {
428 /* If it is the downstream hook, stop the timers */
429 callout_stop(&sc
->timeout
);
433 /* If no more hooks, remove the node */
434 if (hook
->node
->numhooks
== 0)
435 ng_rmnode(hook
->node
);
443 cisco_input(sc_p sc
, struct mbuf
*m
, meta_p meta
)
445 const struct cisco_header
*h
;
446 struct cisco_header hdrbuf
;
447 struct protoent
*pep
;
450 /* Sanity check header length */
451 if (m
->m_pkthdr
.len
< sizeof(*h
)) {
456 /* Get cisco header */
457 if (m
->m_len
>= sizeof(*h
)) /* the common case */
458 h
= mtod(m
, const struct cisco_header
*);
460 m_copydata(m
, 0, sizeof(*h
), (caddr_t
)&hdrbuf
);
463 m_adj(m
, sizeof(*h
));
465 /* Check header address */
466 switch (h
->address
) {
467 default: /* Invalid Cisco packet. */
470 case CISCO_MULTICAST
:
471 /* Don't check the control field here (RFC 1547). */
472 switch (ntohs(h
->protocol
)) {
475 case CISCO_KEEPALIVE
:
477 const struct cisco_packet
*p
;
478 struct cisco_packet pktbuf
;
480 /* Sanity check packet length */
481 if (m
->m_pkthdr
.len
< sizeof(*p
)) {
486 /* Get cisco packet */
487 if (m
->m_len
>= sizeof(*p
)) /* the common case */
488 p
= mtod(m
, const struct cisco_packet
*);
490 m_copydata(m
, 0, sizeof(*p
), (caddr_t
)&pktbuf
);
494 /* Check packet type */
495 switch (ntohl(p
->type
)) {
498 "cisco: unknown cisco packet type: 0x%"PRIx32
"\n",
501 case CISCO_ADDR_REPLY
:
502 /* Reply on address request, ignore */
504 case CISCO_KEEPALIVE_REQ
:
505 sc
->remote_seq
= ntohl(p
->par1
);
506 if (sc
->local_seq
== ntohl(p
->par2
)) {
513 struct ng_mesg
*msg
, *resp
;
515 /* Ask inet peer for IP address information */
516 if (sc
->inet
.hook
== NULL
)
518 NG_MKMESSAGE(msg
, NGM_CISCO_COOKIE
,
519 NGM_CISCO_GET_IPADDR
, 0, M_NOWAIT
);
522 ng_send_msg(sc
->node
, msg
,
523 NG_CISCO_HOOK_INET
, &resp
);
525 cisco_rcvmsg(sc
->node
, resp
, ".", NULL
);
528 /* Send reply to peer device */
529 error
= cisco_send(sc
, CISCO_ADDR_REPLY
,
530 ntohl(sc
->localip
.s_addr
),
531 ntohl(sc
->localmask
.s_addr
));
550 /* Drop if payload is empty */
551 if (m
->m_pkthdr
.len
== 0) {
557 if (pep
->hook
== NULL
)
559 NG_SEND_DATA(error
, pep
->hook
, m
, meta
);
563 NG_FREE_DATA(m
, meta
);
569 * Send keepalive packets, every 10 seconds.
572 cisco_keepalive(void *arg
)
577 cisco_send(sc
, CISCO_KEEPALIVE_REQ
, sc
->local_seq
, sc
->remote_seq
);
580 callout_reset(&sc
->timeout
, hz
* KEEPALIVE_SECS
,
581 cisco_keepalive
, sc
);
585 * Send Cisco keepalive packet.
588 cisco_send(sc_p sc
, int type
, long par1
, long par2
)
590 struct cisco_header
*h
;
591 struct cisco_packet
*ch
;
600 MGETHDR(m
, M_NOWAIT
, MT_DATA
);
604 t
= (time
.tv_sec
- boottime
.tv_sec
) * 1000;
605 m
->m_pkthdr
.len
= m
->m_len
= CISCO_HEADER_LEN
+ CISCO_PACKET_LEN
;
606 m
->m_pkthdr
.rcvif
= 0;
608 h
= mtod(m
, struct cisco_header
*);
609 h
->address
= CISCO_MULTICAST
;
611 h
->protocol
= htons(CISCO_KEEPALIVE
);
613 ch
= (struct cisco_packet
*) (h
+ 1);
614 ch
->type
= htonl(type
);
615 ch
->par1
= htonl(par1
);
616 ch
->par2
= htonl(par2
);
618 ch
->time0
= htons((u_short
) (t
>> 16));
619 ch
->time1
= htons((u_short
) t
);
621 NG_SEND_DATA(error
, sc
->downstream
.hook
, m
, meta
);