Add support for Protocol Independent Multicast.
[dragonfly.git] / sys / net / ip_mroute / ip_mroute.c
1 /*
2  * IP multicast forwarding procedures
3  *
4  * Written by David Waitzman, BBN Labs, August 1988.
5  * Modified by Steve Deering, Stanford, February 1989.
6  * Modified by Mark J. Steiglitz, Stanford, May, 1991
7  * Modified by Van Jacobson, LBL, January 1993
8  * Modified by Ajit Thyagarajan, PARC, August 1993
9  * Modified by Bill Fenner, PARC, April 1995
10  * Modified by Ahmed Helmy, SGI, June 1996
11  * Modified by George Edmond Eddy (Rusty), ISI, February 1998
12  * Modified by Pavlin Radoslavov, USC/ISI, May 1998, August 1999, October 2000
13  * Modified by Hitoshi Asaeda, WIDE, August 2000
14  * Modified by Pavlin Radoslavov, ICSI, October 2002
15  *
16  * MROUTING Revision: 3.5
17  * and PIM-SMv2 and PIM-DM support, advanced API support,
18  * bandwidth metering and signaling
19  *
20  * $FreeBSD: src/sys/netinet/ip_mroute.c,v 1.56.2.10 2003/08/24 21:37:34 hsu Exp $
21  * $DragonFly: src/sys/net/ip_mroute/ip_mroute.c,v 1.4 2003/08/24 23:07:07 hsu Exp $
22  */
23
24 #include "opt_mrouting.h"
25 #include "opt_random_ip_id.h"
26
27 #ifdef PIM
28 #define _PIM_VT 1
29 #endif
30
31 #include <sys/param.h>
32 #include <sys/kernel.h>
33 #include <sys/malloc.h>
34 #include <sys/mbuf.h>
35 #include <sys/protosw.h>
36 #include <sys/socket.h>
37 #include <sys/socketvar.h>
38 #include <sys/sockio.h>
39 #include <sys/sysctl.h>
40 #include <sys/syslog.h>
41 #include <sys/systm.h>
42 #include <sys/time.h>
43 #include <net/if.h>
44 #include <net/route.h>
45 #include <netinet/in.h>
46 #include <netinet/igmp.h>
47 #include <netinet/in_systm.h>
48 #include <netinet/in_var.h>
49 #include <netinet/ip.h>
50 #include "ip_mroute.h"
51 #include <netinet/ip_var.h>
52 #ifdef PIM
53 #include <netinet/pim.h>
54 #include <netinet/pim_var.h>
55 #endif
56 #include <netinet/udp.h>
57 #include <machine/in_cksum.h>
58
59 /*
60  * Control debugging code for rsvp and multicast routing code.
61  * Can only set them with the debugger.
62  */
63 static  u_int   rsvpdebug;              /* non-zero enables debugging   */
64
65 static  u_int   mrtdebug;               /* any set of the flags below   */
66  
67 #define         DEBUG_MFC       0x02
68 #define         DEBUG_FORWARD   0x04
69 #define         DEBUG_EXPIRE    0x08
70 #define         DEBUG_XMIT      0x10
71 #define         DEBUG_PIM       0x20
72
73 #define         VIFI_INVALID    ((vifi_t) -1)
74
75 #define M_HASCL(m)      ((m)->m_flags & M_EXT)
76
77 static MALLOC_DEFINE(M_MRTABLE, "mroutetbl", "multicast routing tables");
78
79 static struct mrtstat   mrtstat;
80 SYSCTL_STRUCT(_net_inet_ip, OID_AUTO, mrtstat, CTLFLAG_RW,
81     &mrtstat, mrtstat,
82     "Multicast Routing Statistics (struct mrtstat, netinet/ip_mroute.h)");
83
84 static struct mfc       *mfctable[MFCTBLSIZ];
85 SYSCTL_OPAQUE(_net_inet_ip, OID_AUTO, mfctable, CTLFLAG_RD,
86     &mfctable, sizeof(mfctable), "S,*mfc[MFCTBLSIZ]",
87     "Multicast Forwarding Table (struct *mfc[MFCTBLSIZ], netinet/ip_mroute.h)");
88
89 static struct vif       viftable[MAXVIFS];
90 SYSCTL_OPAQUE(_net_inet_ip, OID_AUTO, viftable, CTLFLAG_RD,
91     &viftable, sizeof(viftable), "S,vif[MAXVIFS]",
92     "Multicast Virtual Interfaces (struct vif[MAXVIFS], netinet/ip_mroute.h)");
93
94 static u_char           nexpire[MFCTBLSIZ];
95
96 static struct callout_handle expire_upcalls_ch;
97
98 #define         EXPIRE_TIMEOUT  (hz / 4)        /* 4x / second          */
99 #define         UPCALL_EXPIRE   6               /* number of timeouts   */
100
101 /*
102  * Define the token bucket filter structures
103  * tbftable -> each vif has one of these for storing info
104  */
105
106 static struct tbf tbftable[MAXVIFS];
107 #define         TBF_REPROCESS   (hz / 100)      /* 100x / second */
108
109 /*
110  * 'Interfaces' associated with decapsulator (so we can tell
111  * packets that went through it from ones that get reflected
112  * by a broken gateway).  These interfaces are never linked into
113  * the system ifnet list & no routes point to them.  I.e., packets
114  * can't be sent this way.  They only exist as a placeholder for
115  * multicast source verification.
116  */
117 static struct ifnet multicast_decap_if[MAXVIFS];
118
119 #define ENCAP_TTL 64
120 #define ENCAP_PROTO IPPROTO_IPIP        /* 4 */
121
122 /* prototype IP hdr for encapsulated packets */
123 static struct ip multicast_encap_iphdr = {
124 #if BYTE_ORDER == LITTLE_ENDIAN
125         sizeof(struct ip) >> 2, IPVERSION,
126 #else
127         IPVERSION, sizeof(struct ip) >> 2,
128 #endif
129         0,                              /* tos */
130         sizeof(struct ip),              /* total length */
131         0,                              /* id */
132         0,                              /* frag offset */
133         ENCAP_TTL, ENCAP_PROTO,
134         0,                              /* checksum */
135 };
136
137 /*
138  * Bandwidth meter variables and constants
139  */
140 static MALLOC_DEFINE(M_BWMETER, "bwmeter", "multicast upcall bw meters");
141 /*
142  * Pending timeouts are stored in a hash table, the key being the
143  * expiration time. Periodically, the entries are analysed and processed.
144  */
145 #define BW_METER_BUCKETS        1024
146 static struct bw_meter *bw_meter_timers[BW_METER_BUCKETS];
147 static struct callout_handle bw_meter_ch;
148 #define BW_METER_PERIOD (hz)            /* periodical handling of bw meters */
149
150 /*
151  * Pending upcalls are stored in a vector which is flushed when
152  * full, or periodically
153  */
154 static struct bw_upcall bw_upcalls[BW_UPCALLS_MAX];
155 static u_int    bw_upcalls_n; /* # of pending upcalls */
156 static struct callout_handle bw_upcalls_ch;
157 #define BW_UPCALLS_PERIOD (hz)          /* periodical flush of bw upcalls */
158
159 #ifdef PIM
160 static struct pimstat pimstat;
161 SYSCTL_STRUCT(_net_inet_pim, PIMCTL_STATS, stats, CTLFLAG_RD,
162     &pimstat, pimstat,
163     "PIM Statistics (struct pimstat, netinet/pim_var.h)");
164
165 /*
166  * Note: the PIM Register encapsulation adds the following in front of a
167  * data packet:
168  *
169  * struct pim_encap_hdr {
170  *    struct ip ip;
171  *    struct pim_encap_pimhdr  pim;
172  * }
173  *
174  */
175
176 struct pim_encap_pimhdr {
177         struct pim pim;
178         uint32_t   flags;
179 };
180
181 static struct ip pim_encap_iphdr = {
182 #if BYTE_ORDER == LITTLE_ENDIAN
183         sizeof(struct ip) >> 2,
184         IPVERSION,
185 #else
186         IPVERSION,
187         sizeof(struct ip) >> 2,
188 #endif
189         0,                      /* tos */
190         sizeof(struct ip),      /* total length */
191         0,                      /* id */
192         0,                      /* frag offset */ 
193         ENCAP_TTL,
194         IPPROTO_PIM,
195         0,                      /* checksum */
196 };
197
198 static struct pim_encap_pimhdr pim_encap_pimhdr = {
199     {
200         PIM_MAKE_VT(PIM_VERSION, PIM_REGISTER), /* PIM vers and message type */
201         0,                      /* reserved */
202         0,                      /* checksum */
203     },
204     0                           /* flags */
205 };
206
207 static struct ifnet multicast_register_if;
208 static vifi_t reg_vif_num = VIFI_INVALID;
209 #endif /* PIM */
210
211 /*
212  * Private variables.
213  */
214 static vifi_t      numvifs;
215 static int have_encap_tunnel;
216
217 /*
218  * one-back cache used by ipip_input to locate a tunnel's vif
219  * given a datagram's src ip address.
220  */
221 static u_long last_encap_src;
222 static struct vif *last_encap_vif;
223
224 static u_long   X_ip_mcast_src(int vifi);
225 static int      X_ip_mforward(struct ip *ip, struct ifnet *ifp,
226                         struct mbuf *m, struct ip_moptions *imo);
227 static int      X_ip_mrouter_done(void);
228 static int      X_ip_mrouter_get(struct socket *so, struct sockopt *m);
229 static int      X_ip_mrouter_set(struct socket *so, struct sockopt *m);
230 static int      X_legal_vif_num(int vif);
231 static int      X_mrt_ioctl(int cmd, caddr_t data);
232
233 static int get_sg_cnt(struct sioc_sg_req *);
234 static int get_vif_cnt(struct sioc_vif_req *);
235 static int ip_mrouter_init(struct socket *, int);
236 static int add_vif(struct vifctl *);
237 static int del_vif(vifi_t);
238 static int add_mfc(struct mfcctl2 *);
239 static int del_mfc(struct mfcctl2 *);
240 static int set_api_config(uint32_t *); /* chose API capabilities */
241 static int socket_send(struct socket *, struct mbuf *, struct sockaddr_in *);
242 static int set_assert(int);
243 static void expire_upcalls(void *);
244 static int ip_mdq(struct mbuf *, struct ifnet *, struct mfc *, vifi_t);
245 static void phyint_send(struct ip *, struct vif *, struct mbuf *);
246 static void encap_send(struct ip *, struct vif *, struct mbuf *);
247 static void tbf_control(struct vif *, struct mbuf *, struct ip *, u_long);
248 static void tbf_queue(struct vif *, struct mbuf *);
249 static void tbf_process_q(struct vif *);
250 static void tbf_reprocess_q(void *);
251 static int tbf_dq_sel(struct vif *, struct ip *);
252 static void tbf_send_packet(struct vif *, struct mbuf *);
253 static void tbf_update_tokens(struct vif *);
254 static int priority(struct vif *, struct ip *);
255
256 /*
257  * Bandwidth monitoring
258  */
259 static void free_bw_list(struct bw_meter *list);
260 static int add_bw_upcall(struct bw_upcall *);
261 static int del_bw_upcall(struct bw_upcall *);
262 static void bw_meter_receive_packet(struct bw_meter *x, int plen,
263                 struct timeval *nowp);
264 static void bw_meter_prepare_upcall(struct bw_meter *x, struct timeval *nowp);
265 static void bw_upcalls_send(void);
266 static void schedule_bw_meter(struct bw_meter *x, struct timeval *nowp);
267 static void unschedule_bw_meter(struct bw_meter *x);
268 static void bw_meter_process(void);
269 static void expire_bw_upcalls_send(void *);
270 static void expire_bw_meter_process(void *);
271
272 #ifdef PIM
273 static int pim_register_send(struct ip *, struct vif *,
274                 struct mbuf *, struct mfc *);
275 static int pim_register_send_rp(struct ip *, struct vif *,
276                 struct mbuf *, struct mfc *);
277 static int pim_register_send_upcall(struct ip *, struct vif *,
278                 struct mbuf *, struct mfc *);
279 static struct mbuf *pim_register_prepare(struct ip *, struct mbuf *);
280 #endif
281
282 /*
283  * whether or not special PIM assert processing is enabled.
284  */
285 static int pim_assert;
286 /*
287  * Rate limit for assert notification messages, in usec
288  */
289 #define ASSERT_MSG_TIME         3000000
290
291 /*
292  * Kernel multicast routing API capabilities and setup.
293  * If more API capabilities are added to the kernel, they should be
294  * recorded in `mrt_api_support'.
295  */
296 static const uint32_t mrt_api_support = (MRT_MFC_FLAGS_DISABLE_WRONGVIF |
297                                          MRT_MFC_FLAGS_BORDER_VIF |
298                                          MRT_MFC_RP |
299                                          MRT_MFC_BW_UPCALL);
300 static uint32_t mrt_api_config = 0;
301
302 /*
303  * Hash function for a source, group entry
304  */
305 #define MFCHASH(a, g) MFCHASHMOD(((a) >> 20) ^ ((a) >> 10) ^ (a) ^ \
306                         ((g) >> 20) ^ ((g) >> 10) ^ (g))
307
308 /*
309  * Find a route for a given origin IP address and Multicast group address
310  * Type of service parameter to be added in the future!!!
311  * Statistics are updated by the caller if needed
312  * (mrtstat.mrts_mfc_lookups and mrtstat.mrts_mfc_misses)
313  */
314 static struct mfc *
315 mfc_find(in_addr_t o, in_addr_t g)
316 {
317     struct mfc *rt;
318
319     for (rt = mfctable[MFCHASH(o,g)]; rt; rt = rt->mfc_next)
320         if ((rt->mfc_origin.s_addr == o) &&
321                 (rt->mfc_mcastgrp.s_addr == g) && (rt->mfc_stall == NULL))
322             break;
323     return rt;
324 }
325
326 /*
327  * Macros to compute elapsed time efficiently
328  * Borrowed from Van Jacobson's scheduling code
329  */
330 #define TV_DELTA(a, b, delta) {                                 \
331         int xxs;                                                \
332         delta = (a).tv_usec - (b).tv_usec;                      \
333         if ((xxs = (a).tv_sec - (b).tv_sec)) {                  \
334                 switch (xxs) {                                  \
335                 case 2:                                         \
336                         delta += 1000000;                       \
337                         /* FALLTHROUGH */                       \
338                 case 1:                                         \
339                         delta += 1000000;                       \
340                         break;                                  \
341                 default:                                        \
342                         delta += (1000000 * xxs);               \
343                 }                                               \
344         }                                                       \
345 }
346
347 #define TV_LT(a, b) (((a).tv_usec < (b).tv_usec && \
348               (a).tv_sec <= (b).tv_sec) || (a).tv_sec < (b).tv_sec)
349
350 /*
351  * Handle MRT setsockopt commands to modify the multicast routing tables.
352  */
353 static int
354 X_ip_mrouter_set(struct socket *so, struct sockopt *sopt)
355 {
356     int error, optval;
357     vifi_t      vifi;
358     struct      vifctl vifc;
359     struct      mfcctl2 mfc;
360     struct      bw_upcall bw_upcall;
361     uint32_t    i;
362
363     if (so != ip_mrouter && sopt->sopt_name != MRT_INIT)
364         return EPERM;
365
366     error = 0;
367     switch (sopt->sopt_name) {
368     case MRT_INIT:
369         error = sooptcopyin(sopt, &optval, sizeof optval, sizeof optval);
370         if (error)
371             break;
372         error = ip_mrouter_init(so, optval);
373         break;
374
375     case MRT_DONE:
376         error = ip_mrouter_done();
377         break;
378
379     case MRT_ADD_VIF:
380         error = sooptcopyin(sopt, &vifc, sizeof vifc, sizeof vifc);
381         if (error)
382             break;
383         error = add_vif(&vifc);
384         break;
385
386     case MRT_DEL_VIF:
387         error = sooptcopyin(sopt, &vifi, sizeof vifi, sizeof vifi);
388         if (error)
389             break;
390         error = del_vif(vifi);
391         break;
392
393     case MRT_ADD_MFC:
394     case MRT_DEL_MFC:
395         /*
396          * select data size depending on API version.
397          */
398         if (sopt->sopt_name == MRT_ADD_MFC &&
399                 mrt_api_config & MRT_API_FLAGS_ALL) {
400             error = sooptcopyin(sopt, &mfc, sizeof(struct mfcctl2),
401                                 sizeof(struct mfcctl2));
402         } else {
403             error = sooptcopyin(sopt, &mfc, sizeof(struct mfcctl),
404                                 sizeof(struct mfcctl));
405             bzero((caddr_t)&mfc + sizeof(struct mfcctl),
406                         sizeof(mfc) - sizeof(struct mfcctl));
407         }
408         if (error)
409             break;
410         if (sopt->sopt_name == MRT_ADD_MFC)
411             error = add_mfc(&mfc);
412         else
413             error = del_mfc(&mfc);
414         break;
415
416     case MRT_ASSERT:
417         error = sooptcopyin(sopt, &optval, sizeof optval, sizeof optval);
418         if (error)
419             break;
420         set_assert(optval);
421         break;
422
423     case MRT_API_CONFIG:
424         error = sooptcopyin(sopt, &i, sizeof i, sizeof i);
425         if (!error)
426             error = set_api_config(&i);
427         if (!error)
428             error = sooptcopyout(sopt, &i, sizeof i);
429         break;
430
431     case MRT_ADD_BW_UPCALL:
432     case MRT_DEL_BW_UPCALL:
433         error = sooptcopyin(sopt, &bw_upcall, sizeof bw_upcall,
434                                 sizeof bw_upcall);
435         if (error)
436             break;
437         if (sopt->sopt_name == MRT_ADD_BW_UPCALL)
438             error = add_bw_upcall(&bw_upcall);
439         else
440             error = del_bw_upcall(&bw_upcall);
441         break;
442
443     default:
444         error = EOPNOTSUPP;
445         break;
446     }
447     return error;
448 }
449
450 /*
451  * Handle MRT getsockopt commands
452  */
453 static int
454 X_ip_mrouter_get(struct socket *so, struct sockopt *sopt)
455 {
456     int error;
457     static int version = 0x0305; /* !!! why is this here? XXX */
458
459     switch (sopt->sopt_name) {
460     case MRT_VERSION:
461         error = sooptcopyout(sopt, &version, sizeof version);
462         break;
463
464     case MRT_ASSERT:
465         error = sooptcopyout(sopt, &pim_assert, sizeof pim_assert);
466         break;
467
468     case MRT_API_SUPPORT:
469         error = sooptcopyout(sopt, &mrt_api_support, sizeof mrt_api_support);
470         break;
471
472     case MRT_API_CONFIG:
473         error = sooptcopyout(sopt, &mrt_api_config, sizeof mrt_api_config);
474         break;
475
476     default:
477         error = EOPNOTSUPP;
478         break;
479     }
480     return error;
481 }
482
483 /*
484  * Handle ioctl commands to obtain information from the cache
485  */
486 static int
487 X_mrt_ioctl(int cmd, caddr_t data)
488 {
489     int error = 0;
490
491     switch (cmd) {
492     case SIOCGETVIFCNT:
493         error = get_vif_cnt((struct sioc_vif_req *)data);
494         break;
495
496     case SIOCGETSGCNT:
497         error = get_sg_cnt((struct sioc_sg_req *)data);
498         break;
499
500     default:
501         error = EINVAL;
502         break;
503     }
504     return error;
505 }
506
507 /*
508  * returns the packet, byte, rpf-failure count for the source group provided
509  */
510 static int
511 get_sg_cnt(struct sioc_sg_req *req)
512 {
513     int s;
514     struct mfc *rt;
515
516     s = splnet();
517     rt = mfc_find(req->src.s_addr, req->grp.s_addr);
518     splx(s);
519     if (rt == NULL) {
520         req->pktcnt = req->bytecnt = req->wrong_if = 0xffffffff;
521         return EADDRNOTAVAIL;
522     }
523     req->pktcnt = rt->mfc_pkt_cnt;
524     req->bytecnt = rt->mfc_byte_cnt;
525     req->wrong_if = rt->mfc_wrong_if;
526     return 0;
527 }
528
529 /*
530  * returns the input and output packet and byte counts on the vif provided
531  */
532 static int
533 get_vif_cnt(struct sioc_vif_req *req)
534 {
535     vifi_t vifi = req->vifi;
536
537     if (vifi >= numvifs)
538         return EINVAL;
539
540     req->icount = viftable[vifi].v_pkt_in;
541     req->ocount = viftable[vifi].v_pkt_out;
542     req->ibytes = viftable[vifi].v_bytes_in;
543     req->obytes = viftable[vifi].v_bytes_out;
544
545     return 0;
546 }
547
548 /*
549  * Enable multicast routing
550  */
551 static int
552 ip_mrouter_init(struct socket *so, int version)
553 {
554     if (mrtdebug)
555         log(LOG_DEBUG, "ip_mrouter_init: so_type = %d, pr_protocol = %d\n",
556             so->so_type, so->so_proto->pr_protocol);
557
558     if (so->so_type != SOCK_RAW || so->so_proto->pr_protocol != IPPROTO_IGMP)
559         return EOPNOTSUPP;
560
561     if (version != 1)
562         return ENOPROTOOPT;
563
564     if (ip_mrouter != NULL)
565         return EADDRINUSE;
566
567     ip_mrouter = so;
568
569     bzero((caddr_t)mfctable, sizeof(mfctable));
570     bzero((caddr_t)nexpire, sizeof(nexpire));
571
572     pim_assert = 0;
573
574     expire_upcalls_ch = timeout(expire_upcalls, NULL, EXPIRE_TIMEOUT);
575
576     bw_upcalls_n = 0;
577     bzero((caddr_t)bw_meter_timers, sizeof(bw_meter_timers));
578     bw_upcalls_ch = timeout(expire_bw_upcalls_send, NULL, BW_UPCALLS_PERIOD);
579     bw_meter_ch = timeout(expire_bw_meter_process, NULL, BW_METER_PERIOD);
580
581     mrt_api_config = 0;
582
583     if (mrtdebug)
584         log(LOG_DEBUG, "ip_mrouter_init\n");
585
586     return 0;
587 }
588
589 /*
590  * Disable multicast routing
591  */
592 static int
593 X_ip_mrouter_done(void)
594 {
595     vifi_t vifi;
596     int i;
597     struct ifnet *ifp;
598     struct ifreq ifr;
599     struct mfc *rt;
600     struct rtdetq *rte;
601     int s;
602
603     s = splnet();
604
605     /*
606      * For each phyint in use, disable promiscuous reception of all IP
607      * multicasts.
608      */
609     for (vifi = 0; vifi < numvifs; vifi++) {
610         if (viftable[vifi].v_lcl_addr.s_addr != 0 &&
611                 !(viftable[vifi].v_flags & (VIFF_TUNNEL | VIFF_REGISTER))) {
612             struct sockaddr_in *so = (struct sockaddr_in *)&(ifr.ifr_addr);
613
614             so->sin_len = sizeof(struct sockaddr_in);
615             so->sin_family = AF_INET;
616             so->sin_addr.s_addr = INADDR_ANY;
617             ifp = viftable[vifi].v_ifp;
618             if_allmulti(ifp, 0);
619         }
620     }
621     bzero((caddr_t)tbftable, sizeof(tbftable));
622     bzero((caddr_t)viftable, sizeof(viftable));
623     numvifs = 0;
624     pim_assert = 0;
625
626     untimeout(expire_upcalls, NULL, expire_upcalls_ch);
627
628     mrt_api_config = 0;
629     bw_upcalls_n = 0;
630     untimeout(expire_bw_upcalls_send, NULL, bw_upcalls_ch);
631     untimeout(expire_bw_meter_process, NULL, bw_meter_ch);
632
633     /*
634      * Free all multicast forwarding cache entries.
635      */
636     for (i = 0; i < MFCTBLSIZ; i++) {
637         for (rt = mfctable[i]; rt != NULL; ) {
638             struct mfc *nr = rt->mfc_next;
639
640             for (rte = rt->mfc_stall; rte != NULL; ) {
641                 struct rtdetq *n = rte->next;
642
643                 m_freem(rte->m);
644                 free(rte, M_MRTABLE);
645                 rte = n;
646             }
647             free_bw_list(rt->mfc_bw_meter);
648             free(rt, M_MRTABLE);
649             rt = nr;
650         }
651     }
652
653     bzero((caddr_t)mfctable, sizeof(mfctable));
654
655     bzero(bw_meter_timers, sizeof(bw_meter_timers));
656
657     /*
658      * Reset de-encapsulation cache
659      */
660     last_encap_src = INADDR_ANY;
661     last_encap_vif = NULL;
662 #ifdef PIM
663     reg_vif_num = VIFI_INVALID;
664 #endif
665     have_encap_tunnel = 0;
666
667     ip_mrouter = NULL;
668
669     splx(s);
670
671     if (mrtdebug)
672         log(LOG_DEBUG, "ip_mrouter_done\n");
673
674     return 0;
675 }
676
677 /*
678  * Set PIM assert processing global
679  */
680 static int
681 set_assert(int i)
682 {
683     if ((i != 1) && (i != 0))
684         return EINVAL;
685
686     pim_assert = i;
687
688     return 0;
689 }
690
691 /*
692  * Configure API capabilities
693  */
694 int
695 set_api_config(uint32_t *apival)
696 {
697     int i;
698
699     /*
700      * We can set the API capabilities only if it is the first operation
701      * after MRT_INIT. I.e.:
702      *  - there are no vifs installed
703      *  - pim_assert is not enabled
704      *  - the MFC table is empty
705      */
706     if (numvifs > 0) {
707         *apival = 0;
708         return EPERM;
709     }
710     if (pim_assert) {
711         *apival = 0;
712         return EPERM;
713     }
714     for (i = 0; i < MFCTBLSIZ; i++) {
715         if (mfctable[i] != NULL) {
716             *apival = 0;
717             return EPERM;
718         }
719     }
720
721     mrt_api_config = *apival & mrt_api_support;
722     *apival = mrt_api_config;
723
724     return 0;
725 }
726
727 /*
728  * Add a vif to the vif table
729  */
730 static int
731 add_vif(struct vifctl *vifcp)
732 {
733     struct vif *vifp = viftable + vifcp->vifc_vifi;
734     struct sockaddr_in sin = {sizeof sin, AF_INET};
735     struct ifaddr *ifa;
736     struct ifnet *ifp;
737     int error, s;
738     struct tbf *v_tbf = tbftable + vifcp->vifc_vifi;
739
740     if (vifcp->vifc_vifi >= MAXVIFS)
741         return EINVAL;
742     if (vifp->v_lcl_addr.s_addr != INADDR_ANY)
743         return EADDRINUSE;
744     if (vifcp->vifc_lcl_addr.s_addr == INADDR_ANY)
745         return EADDRNOTAVAIL;
746
747     /* Find the interface with an address in AF_INET family */
748 #ifdef PIM
749     if (vifcp->vifc_flags & VIFF_REGISTER) {
750         /*
751          * XXX: Because VIFF_REGISTER does not really need a valid
752          * local interface (e.g. it could be 127.0.0.2), we don't
753          * check its address.
754          */
755         ifp = NULL;
756     } else
757 #endif
758     {
759         sin.sin_addr = vifcp->vifc_lcl_addr;
760         ifa = ifa_ifwithaddr((struct sockaddr *)&sin);
761         if (ifa == NULL)
762             return EADDRNOTAVAIL;
763         ifp = ifa->ifa_ifp;
764     }
765
766     if (vifcp->vifc_flags & VIFF_TUNNEL) {
767         if ((vifcp->vifc_flags & VIFF_SRCRT) == 0) {
768             /*
769              * An encapsulating tunnel is wanted.  Tell ipip_input() to
770              * start paying attention to encapsulated packets.
771              */
772             if (have_encap_tunnel == 0) {
773                 have_encap_tunnel = 1;
774                 for (s = 0; s < MAXVIFS; ++s) {
775                     multicast_decap_if[s].if_name = "mdecap";
776                     multicast_decap_if[s].if_unit = s;
777                 }
778             }
779             /*
780              * Set interface to fake encapsulator interface
781              */
782             ifp = &multicast_decap_if[vifcp->vifc_vifi];
783             /*
784              * Prepare cached route entry
785              */
786             bzero(&vifp->v_route, sizeof(vifp->v_route));
787         } else {
788             log(LOG_ERR, "source routed tunnels not supported\n");
789             return EOPNOTSUPP;
790         }
791 #ifdef PIM
792     } else if (vifcp->vifc_flags & VIFF_REGISTER) {
793         ifp = &multicast_register_if;
794         if (mrtdebug)
795             log(LOG_DEBUG, "Adding a register vif, ifp: %p\n",
796                     (void *)&multicast_register_if);
797         if (reg_vif_num == VIFI_INVALID) {
798             multicast_register_if.if_name = "register_vif";
799             multicast_register_if.if_unit = 0;
800             multicast_register_if.if_flags = IFF_LOOPBACK;
801             bzero(&vifp->v_route, sizeof(vifp->v_route));
802             reg_vif_num = vifcp->vifc_vifi;
803         }
804 #endif
805     } else {            /* Make sure the interface supports multicast */
806         if ((ifp->if_flags & IFF_MULTICAST) == 0)
807             return EOPNOTSUPP;
808
809         /* Enable promiscuous reception of all IP multicasts from the if */
810         s = splnet();
811         error = if_allmulti(ifp, 1);
812         splx(s);
813         if (error)
814             return error;
815     }
816
817     s = splnet();
818     /* define parameters for the tbf structure */
819     vifp->v_tbf = v_tbf;
820     GET_TIME(vifp->v_tbf->tbf_last_pkt_t);
821     vifp->v_tbf->tbf_n_tok = 0;
822     vifp->v_tbf->tbf_q_len = 0;
823     vifp->v_tbf->tbf_max_q_len = MAXQSIZE;
824     vifp->v_tbf->tbf_q = vifp->v_tbf->tbf_t = NULL;
825
826     vifp->v_flags     = vifcp->vifc_flags;
827     vifp->v_threshold = vifcp->vifc_threshold;
828     vifp->v_lcl_addr  = vifcp->vifc_lcl_addr;
829     vifp->v_rmt_addr  = vifcp->vifc_rmt_addr;
830     vifp->v_ifp       = ifp;
831     /* scaling up here allows division by 1024 in critical code */
832     vifp->v_rate_limit= vifcp->vifc_rate_limit * 1024 / 1000;
833     vifp->v_rsvp_on   = 0;
834     vifp->v_rsvpd     = NULL;
835     /* initialize per vif pkt counters */
836     vifp->v_pkt_in    = 0;
837     vifp->v_pkt_out   = 0;
838     vifp->v_bytes_in  = 0;
839     vifp->v_bytes_out = 0;
840     splx(s);
841
842     /* Adjust numvifs up if the vifi is higher than numvifs */
843     if (numvifs <= vifcp->vifc_vifi) numvifs = vifcp->vifc_vifi + 1;
844
845     if (mrtdebug)
846         log(LOG_DEBUG, "add_vif #%d, lcladdr %lx, %s %lx, thresh %x, rate %d\n",
847             vifcp->vifc_vifi,
848             (u_long)ntohl(vifcp->vifc_lcl_addr.s_addr),
849             (vifcp->vifc_flags & VIFF_TUNNEL) ? "rmtaddr" : "mask",
850             (u_long)ntohl(vifcp->vifc_rmt_addr.s_addr),
851             vifcp->vifc_threshold,
852             vifcp->vifc_rate_limit);
853
854     return 0;
855 }
856
857 /*
858  * Delete a vif from the vif table
859  */
860 static int
861 del_vif(vifi_t vifi)
862 {
863     struct vif *vifp;
864     int s;
865
866     if (vifi >= numvifs)
867         return EINVAL;
868     vifp = &viftable[vifi];
869     if (vifp->v_lcl_addr.s_addr == INADDR_ANY)
870         return EADDRNOTAVAIL;
871
872     s = splnet();
873
874     if (!(vifp->v_flags & (VIFF_TUNNEL | VIFF_REGISTER)))
875         if_allmulti(vifp->v_ifp, 0);
876
877     if (vifp == last_encap_vif) {
878         last_encap_vif = NULL;
879         last_encap_src = INADDR_ANY;
880     }
881
882     /*
883      * Free packets queued at the interface
884      */
885     while (vifp->v_tbf->tbf_q) {
886         struct mbuf *m = vifp->v_tbf->tbf_q;
887
888         vifp->v_tbf->tbf_q = m->m_act;
889         m_freem(m);
890     }
891
892 #ifdef PIM
893     if (vifp->v_flags & VIFF_REGISTER)
894         reg_vif_num = VIFI_INVALID;
895 #endif
896
897     bzero((caddr_t)vifp->v_tbf, sizeof(*(vifp->v_tbf)));
898     bzero((caddr_t)vifp, sizeof (*vifp));
899
900     if (mrtdebug)
901         log(LOG_DEBUG, "del_vif %d, numvifs %d\n", vifi, numvifs);
902
903     /* Adjust numvifs down */
904     for (vifi = numvifs; vifi > 0; vifi--)
905         if (viftable[vifi-1].v_lcl_addr.s_addr != INADDR_ANY)
906             break;
907     numvifs = vifi;
908
909     splx(s);
910
911     return 0;
912 }
913
914 /*
915  * update an mfc entry without resetting counters and S,G addresses.
916  */
917 static void
918 update_mfc_params(struct mfc *rt, struct mfcctl2 *mfccp)
919 {
920     int i;
921
922     rt->mfc_parent = mfccp->mfcc_parent;
923     for (i = 0; i < numvifs; i++) {
924         rt->mfc_ttls[i] = mfccp->mfcc_ttls[i];
925         rt->mfc_flags[i] = mfccp->mfcc_flags[i] & mrt_api_config &
926             MRT_MFC_FLAGS_ALL;
927     }
928     /* set the RP address */
929     if (mrt_api_config & MRT_MFC_RP)
930         rt->mfc_rp = mfccp->mfcc_rp;
931     else
932         rt->mfc_rp.s_addr = INADDR_ANY;
933 }
934
935 /*
936  * fully initialize an mfc entry from the parameter.
937  */
938 static void
939 init_mfc_params(struct mfc *rt, struct mfcctl2 *mfccp)
940 {
941     rt->mfc_origin     = mfccp->mfcc_origin;
942     rt->mfc_mcastgrp   = mfccp->mfcc_mcastgrp;
943
944     update_mfc_params(rt, mfccp);
945
946     /* initialize pkt counters per src-grp */
947     rt->mfc_pkt_cnt    = 0;
948     rt->mfc_byte_cnt   = 0;
949     rt->mfc_wrong_if   = 0;
950     rt->mfc_last_assert.tv_sec = rt->mfc_last_assert.tv_usec = 0;
951 }
952
953
954 /*
955  * Add an mfc entry
956  */
957 static int
958 add_mfc(struct mfcctl2 *mfccp)
959 {
960     struct mfc *rt;
961     u_long hash;
962     struct rtdetq *rte;
963     u_short nstl;
964     int s;
965
966     rt = mfc_find(mfccp->mfcc_origin.s_addr, mfccp->mfcc_mcastgrp.s_addr);
967
968     /* If an entry already exists, just update the fields */
969     if (rt) {
970         if (mrtdebug & DEBUG_MFC)
971             log(LOG_DEBUG,"add_mfc update o %lx g %lx p %x\n",
972                 (u_long)ntohl(mfccp->mfcc_origin.s_addr),
973                 (u_long)ntohl(mfccp->mfcc_mcastgrp.s_addr),
974                 mfccp->mfcc_parent);
975
976         s = splnet();
977         update_mfc_params(rt, mfccp);
978         splx(s);
979         return 0;
980     }
981
982     /*
983      * Find the entry for which the upcall was made and update
984      */
985     s = splnet();
986     hash = MFCHASH(mfccp->mfcc_origin.s_addr, mfccp->mfcc_mcastgrp.s_addr);
987     for (rt = mfctable[hash], nstl = 0; rt; rt = rt->mfc_next) {
988
989         if ((rt->mfc_origin.s_addr == mfccp->mfcc_origin.s_addr) &&
990                 (rt->mfc_mcastgrp.s_addr == mfccp->mfcc_mcastgrp.s_addr) &&
991                 (rt->mfc_stall != NULL)) {
992
993             if (nstl++)
994                 log(LOG_ERR, "add_mfc %s o %lx g %lx p %x dbx %p\n",
995                     "multiple kernel entries",
996                     (u_long)ntohl(mfccp->mfcc_origin.s_addr),
997                     (u_long)ntohl(mfccp->mfcc_mcastgrp.s_addr),
998                     mfccp->mfcc_parent, (void *)rt->mfc_stall);
999
1000             if (mrtdebug & DEBUG_MFC)
1001                 log(LOG_DEBUG,"add_mfc o %lx g %lx p %x dbg %p\n",
1002                     (u_long)ntohl(mfccp->mfcc_origin.s_addr),
1003                     (u_long)ntohl(mfccp->mfcc_mcastgrp.s_addr),
1004                     mfccp->mfcc_parent, (void *)rt->mfc_stall);
1005
1006             init_mfc_params(rt, mfccp);
1007
1008             rt->mfc_expire = 0; /* Don't clean this guy up */
1009             nexpire[hash]--;
1010
1011             /* free packets Qed at the end of this entry */
1012             for (rte = rt->mfc_stall; rte != NULL; ) {
1013                 struct rtdetq *n = rte->next;
1014
1015                 ip_mdq(rte->m, rte->ifp, rt, -1);
1016                 m_freem(rte->m);
1017                 free(rte, M_MRTABLE);
1018                 rte = n;
1019             }
1020             rt->mfc_stall = NULL;
1021         }
1022     }
1023
1024     /*
1025      * It is possible that an entry is being inserted without an upcall
1026      */
1027     if (nstl == 0) {
1028         if (mrtdebug & DEBUG_MFC)
1029             log(LOG_DEBUG,"add_mfc no upcall h %lu o %lx g %lx p %x\n",
1030                 hash, (u_long)ntohl(mfccp->mfcc_origin.s_addr),
1031                 (u_long)ntohl(mfccp->mfcc_mcastgrp.s_addr),
1032                 mfccp->mfcc_parent);
1033
1034         for (rt = mfctable[hash]; rt != NULL; rt = rt->mfc_next) {
1035             if ((rt->mfc_origin.s_addr == mfccp->mfcc_origin.s_addr) &&
1036                     (rt->mfc_mcastgrp.s_addr == mfccp->mfcc_mcastgrp.s_addr)) {
1037                 init_mfc_params(rt, mfccp);
1038                 if (rt->mfc_expire)
1039                     nexpire[hash]--;
1040                 rt->mfc_expire = 0;
1041                 break; /* XXX */
1042             }
1043         }
1044         if (rt == NULL) {               /* no upcall, so make a new entry */
1045             rt = (struct mfc *)malloc(sizeof(*rt), M_MRTABLE, M_NOWAIT);
1046             if (rt == NULL) {
1047                 splx(s);
1048                 return ENOBUFS;
1049             }
1050
1051             init_mfc_params(rt, mfccp);
1052             rt->mfc_expire     = 0;
1053             rt->mfc_stall      = NULL;
1054
1055             rt->mfc_bw_meter = NULL;
1056             /* insert new entry at head of hash chain */
1057             rt->mfc_next = mfctable[hash];
1058             mfctable[hash] = rt;
1059         }
1060     }
1061     splx(s);
1062     return 0;
1063 }
1064
1065 /*
1066  * Delete an mfc entry
1067  */
1068 static int
1069 del_mfc(struct mfcctl2 *mfccp)
1070 {
1071     struct in_addr      origin;
1072     struct in_addr      mcastgrp;
1073     struct mfc          *rt;
1074     struct mfc          **nptr;
1075     u_long              hash;
1076     int s;
1077     struct bw_meter     *list;
1078
1079     origin = mfccp->mfcc_origin;
1080     mcastgrp = mfccp->mfcc_mcastgrp;
1081
1082     if (mrtdebug & DEBUG_MFC)
1083         log(LOG_DEBUG,"del_mfc orig %lx mcastgrp %lx\n",
1084             (u_long)ntohl(origin.s_addr), (u_long)ntohl(mcastgrp.s_addr));
1085
1086     s = splnet();
1087
1088     hash = MFCHASH(origin.s_addr, mcastgrp.s_addr);
1089     for (nptr = &mfctable[hash]; (rt = *nptr) != NULL; nptr = &rt->mfc_next)
1090         if (origin.s_addr == rt->mfc_origin.s_addr &&
1091                 mcastgrp.s_addr == rt->mfc_mcastgrp.s_addr &&
1092                 rt->mfc_stall == NULL)
1093             break;
1094     if (rt == NULL) {
1095         splx(s);
1096         return EADDRNOTAVAIL;
1097     }
1098
1099     *nptr = rt->mfc_next;
1100
1101     /*
1102      * free the bw_meter entries
1103      */
1104     list = rt->mfc_bw_meter;
1105     rt->mfc_bw_meter = NULL;
1106
1107     free(rt, M_MRTABLE);
1108
1109     splx(s);
1110
1111     free_bw_list(list);
1112
1113     return 0;
1114 }
1115
1116 /*
1117  * Send a message to mrouted on the multicast routing socket
1118  */
1119 static int
1120 socket_send(struct socket *s, struct mbuf *mm, struct sockaddr_in *src)
1121 {
1122     if (s) {
1123         if (sbappendaddr(&s->so_rcv, (struct sockaddr *)src, mm, NULL) != 0) {
1124             sorwakeup(s);
1125             return 0;
1126         }
1127     }
1128     m_freem(mm);
1129     return -1;
1130 }
1131
1132 /*
1133  * IP multicast forwarding function. This function assumes that the packet
1134  * pointed to by "ip" has arrived on (or is about to be sent to) the interface
1135  * pointed to by "ifp", and the packet is to be relayed to other networks
1136  * that have members of the packet's destination IP multicast group.
1137  *
1138  * The packet is returned unscathed to the caller, unless it is
1139  * erroneous, in which case a non-zero return value tells the caller to
1140  * discard it.
1141  */
1142
1143 #define TUNNEL_LEN  12  /* # bytes of IP option for tunnel encapsulation  */
1144
1145 static int
1146 X_ip_mforward(struct ip *ip, struct ifnet *ifp, struct mbuf *m,
1147     struct ip_moptions *imo)
1148 {
1149     struct mfc *rt;
1150     int s;
1151     vifi_t vifi;
1152
1153     if (mrtdebug & DEBUG_FORWARD)
1154         log(LOG_DEBUG, "ip_mforward: src %lx, dst %lx, ifp %p\n",
1155             (u_long)ntohl(ip->ip_src.s_addr), (u_long)ntohl(ip->ip_dst.s_addr),
1156             (void *)ifp);
1157
1158     if (ip->ip_hl < (sizeof(struct ip) + TUNNEL_LEN) >> 2 ||
1159                 ((u_char *)(ip + 1))[1] != IPOPT_LSRR ) {
1160         /*
1161          * Packet arrived via a physical interface or
1162          * an encapsulated tunnel or a register_vif.
1163          */
1164     } else {
1165         /*
1166          * Packet arrived through a source-route tunnel.
1167          * Source-route tunnels are no longer supported.
1168          */
1169         static int last_log;
1170         if (last_log != time_second) {
1171             last_log = time_second;
1172             log(LOG_ERR,
1173                 "ip_mforward: received source-routed packet from %lx\n",
1174                 (u_long)ntohl(ip->ip_src.s_addr));
1175         }
1176         return 1;
1177     }
1178
1179     if (imo && ((vifi = imo->imo_multicast_vif) < numvifs)) {
1180         if (ip->ip_ttl < 255)
1181             ip->ip_ttl++;       /* compensate for -1 in *_send routines */
1182         if (rsvpdebug && ip->ip_p == IPPROTO_RSVP) {
1183             struct vif *vifp = viftable + vifi;
1184
1185             printf("Sending IPPROTO_RSVP from %lx to %lx on vif %d (%s%s%d)\n",
1186                 (long)ntohl(ip->ip_src.s_addr), (long)ntohl(ip->ip_dst.s_addr),
1187                 vifi,
1188                 (vifp->v_flags & VIFF_TUNNEL) ? "tunnel on " : "",
1189                 vifp->v_ifp->if_name, vifp->v_ifp->if_unit);
1190         }
1191         return ip_mdq(m, ifp, NULL, vifi);
1192     }
1193     if (rsvpdebug && ip->ip_p == IPPROTO_RSVP) {
1194         printf("Warning: IPPROTO_RSVP from %lx to %lx without vif option\n",
1195             (long)ntohl(ip->ip_src.s_addr), (long)ntohl(ip->ip_dst.s_addr));
1196         if (!imo)
1197             printf("In fact, no options were specified at all\n");
1198     }
1199
1200     /*
1201      * Don't forward a packet with time-to-live of zero or one,
1202      * or a packet destined to a local-only group.
1203      */
1204     if (ip->ip_ttl <= 1 || ntohl(ip->ip_dst.s_addr) <= INADDR_MAX_LOCAL_GROUP)
1205         return 0;
1206
1207     /*
1208      * Determine forwarding vifs from the forwarding cache table
1209      */
1210     s = splnet();
1211     ++mrtstat.mrts_mfc_lookups;
1212     rt = mfc_find(ip->ip_src.s_addr, ip->ip_dst.s_addr);
1213
1214     /* Entry exists, so forward if necessary */
1215     if (rt != NULL) {
1216         splx(s);
1217         return ip_mdq(m, ifp, rt, -1);
1218     } else {
1219         /*
1220          * If we don't have a route for packet's origin,
1221          * Make a copy of the packet & send message to routing daemon
1222          */
1223
1224         struct mbuf *mb0;
1225         struct rtdetq *rte;
1226         u_long hash;
1227         int hlen = ip->ip_hl << 2;
1228
1229         ++mrtstat.mrts_mfc_misses;
1230
1231         mrtstat.mrts_no_route++;
1232         if (mrtdebug & (DEBUG_FORWARD | DEBUG_MFC))
1233             log(LOG_DEBUG, "ip_mforward: no rte s %lx g %lx\n",
1234                 (u_long)ntohl(ip->ip_src.s_addr),
1235                 (u_long)ntohl(ip->ip_dst.s_addr));
1236
1237         /*
1238          * Allocate mbufs early so that we don't do extra work if we are
1239          * just going to fail anyway.  Make sure to pullup the header so
1240          * that other people can't step on it.
1241          */
1242         rte = (struct rtdetq *)malloc((sizeof *rte), M_MRTABLE, M_NOWAIT);
1243         if (rte == NULL) {
1244             splx(s);
1245             return ENOBUFS;
1246         }
1247         mb0 = m_copypacket(m, M_DONTWAIT);
1248         if (mb0 && (M_HASCL(mb0) || mb0->m_len < hlen))
1249             mb0 = m_pullup(mb0, hlen);
1250         if (mb0 == NULL) {
1251             free(rte, M_MRTABLE);
1252             splx(s);
1253             return ENOBUFS;
1254         }
1255
1256         /* is there an upcall waiting for this flow ? */
1257         hash = MFCHASH(ip->ip_src.s_addr, ip->ip_dst.s_addr);
1258         for (rt = mfctable[hash]; rt; rt = rt->mfc_next) {
1259             if ((ip->ip_src.s_addr == rt->mfc_origin.s_addr) &&
1260                     (ip->ip_dst.s_addr == rt->mfc_mcastgrp.s_addr) &&
1261                     (rt->mfc_stall != NULL))
1262                 break;
1263         }
1264
1265         if (rt == NULL) {
1266             int i;
1267             struct igmpmsg *im;
1268             struct sockaddr_in k_igmpsrc = { sizeof k_igmpsrc, AF_INET };
1269             struct mbuf *mm;
1270
1271             /*
1272              * Locate the vifi for the incoming interface for this packet.
1273              * If none found, drop packet.
1274              */
1275             for (vifi=0; vifi < numvifs && viftable[vifi].v_ifp != ifp; vifi++)
1276                 ;
1277             if (vifi >= numvifs)        /* vif not found, drop packet */
1278                 goto non_fatal;
1279
1280             /* no upcall, so make a new entry */
1281             rt = (struct mfc *)malloc(sizeof(*rt), M_MRTABLE, M_NOWAIT);
1282             if (rt == NULL)
1283                 goto fail;
1284             /* Make a copy of the header to send to the user level process */
1285             mm = m_copy(mb0, 0, hlen);
1286             if (mm == NULL)
1287                 goto fail1;
1288
1289             /*
1290              * Send message to routing daemon to install
1291              * a route into the kernel table
1292              */
1293
1294             im = mtod(mm, struct igmpmsg *);
1295             im->im_msgtype = IGMPMSG_NOCACHE;
1296             im->im_mbz = 0;
1297             im->im_vif = vifi;
1298
1299             mrtstat.mrts_upcalls++;
1300
1301             k_igmpsrc.sin_addr = ip->ip_src;
1302             if (socket_send(ip_mrouter, mm, &k_igmpsrc) < 0) {
1303                 log(LOG_WARNING, "ip_mforward: ip_mrouter socket queue full\n");
1304                 ++mrtstat.mrts_upq_sockfull;
1305 fail1:
1306                 free(rt, M_MRTABLE);
1307 fail:
1308                 free(rte, M_MRTABLE);
1309                 m_freem(mb0);
1310                 splx(s);
1311                 return ENOBUFS;
1312             }
1313
1314             /* insert new entry at head of hash chain */
1315             rt->mfc_origin.s_addr     = ip->ip_src.s_addr;
1316             rt->mfc_mcastgrp.s_addr   = ip->ip_dst.s_addr;
1317             rt->mfc_expire            = UPCALL_EXPIRE;
1318             nexpire[hash]++;
1319             for (i = 0; i < numvifs; i++) {
1320                 rt->mfc_ttls[i] = 0;
1321                 rt->mfc_flags[i] = 0;
1322             }
1323             rt->mfc_parent = -1;
1324
1325             rt->mfc_rp.s_addr = INADDR_ANY; /* clear the RP address */
1326
1327             rt->mfc_bw_meter = NULL;
1328
1329             /* link into table */
1330             rt->mfc_next   = mfctable[hash];
1331             mfctable[hash] = rt;
1332             rt->mfc_stall = rte;
1333
1334         } else {
1335             /* determine if q has overflowed */
1336             int npkts = 0;
1337             struct rtdetq **p;
1338
1339             /*
1340              * XXX ouch! we need to append to the list, but we
1341              * only have a pointer to the front, so we have to
1342              * scan the entire list every time.
1343              */
1344             for (p = &rt->mfc_stall; *p != NULL; p = &(*p)->next)
1345                 npkts++;
1346
1347             if (npkts > MAX_UPQ) {
1348                 mrtstat.mrts_upq_ovflw++;
1349 non_fatal:
1350                 free(rte, M_MRTABLE);
1351                 m_freem(mb0);
1352                 splx(s);
1353                 return 0;
1354             }
1355
1356             /* Add this entry to the end of the queue */
1357             *p = rte;
1358         }
1359
1360         rte->m                  = mb0;
1361         rte->ifp                = ifp;
1362         rte->next               = NULL;
1363
1364         splx(s);
1365
1366         return 0;
1367     }
1368 }
1369
1370 /*
1371  * Clean up the cache entry if upcall is not serviced
1372  */
1373 static void
1374 expire_upcalls(void *unused)
1375 {
1376     struct rtdetq *rte;
1377     struct mfc *mfc, **nptr;
1378     int i;
1379     int s;
1380
1381     s = splnet();
1382     for (i = 0; i < MFCTBLSIZ; i++) {
1383         if (nexpire[i] == 0)
1384             continue;
1385         nptr = &mfctable[i];
1386         for (mfc = *nptr; mfc != NULL; mfc = *nptr) {
1387             /*
1388              * Skip real cache entries
1389              * Make sure it wasn't marked to not expire (shouldn't happen)
1390              * If it expires now
1391              */
1392             if (mfc->mfc_stall != NULL && mfc->mfc_expire != 0 &&
1393                     --mfc->mfc_expire == 0) {
1394                 if (mrtdebug & DEBUG_EXPIRE)
1395                     log(LOG_DEBUG, "expire_upcalls: expiring (%lx %lx)\n",
1396                         (u_long)ntohl(mfc->mfc_origin.s_addr),
1397                         (u_long)ntohl(mfc->mfc_mcastgrp.s_addr));
1398                 /*
1399                  * drop all the packets
1400                  * free the mbuf with the pkt, if, timing info
1401                  */
1402                 for (rte = mfc->mfc_stall; rte; ) {
1403                     struct rtdetq *n = rte->next;
1404
1405                     m_freem(rte->m);
1406                     free(rte, M_MRTABLE);
1407                     rte = n;
1408                 }
1409                 ++mrtstat.mrts_cache_cleanups;
1410                 nexpire[i]--;
1411
1412                 /*
1413                  * free the bw_meter entries
1414                  */
1415                 while (mfc->mfc_bw_meter != NULL) {
1416                     struct bw_meter *x = mfc->mfc_bw_meter;
1417
1418                     mfc->mfc_bw_meter = x->bm_mfc_next;
1419                     free(x, M_BWMETER);
1420                 }
1421
1422                 *nptr = mfc->mfc_next;
1423                 free(mfc, M_MRTABLE);
1424             } else {
1425                 nptr = &mfc->mfc_next;
1426             }
1427         }
1428     }
1429     splx(s);
1430     expire_upcalls_ch = timeout(expire_upcalls, NULL, EXPIRE_TIMEOUT);
1431 }
1432
1433 /*
1434  * Packet forwarding routine once entry in the cache is made
1435  */
1436 static int
1437 ip_mdq(struct mbuf *m, struct ifnet *ifp, struct mfc *rt, vifi_t xmt_vif)
1438 {
1439     struct ip  *ip = mtod(m, struct ip *);
1440     vifi_t vifi;
1441     int plen = ip->ip_len;
1442
1443 /*
1444  * Macro to send packet on vif.  Since RSVP packets don't get counted on
1445  * input, they shouldn't get counted on output, so statistics keeping is
1446  * separate.
1447  */
1448 #define MC_SEND(ip,vifp,m) {                            \
1449                 if ((vifp)->v_flags & VIFF_TUNNEL)      \
1450                     encap_send((ip), (vifp), (m));      \
1451                 else                                    \
1452                     phyint_send((ip), (vifp), (m));     \
1453 }
1454
1455     /*
1456      * If xmt_vif is not -1, send on only the requested vif.
1457      *
1458      * (since vifi_t is u_short, -1 becomes MAXUSHORT, which > numvifs.)
1459      */
1460     if (xmt_vif < numvifs) {
1461 #ifdef PIM
1462         if (viftable[xmt_vif].v_flags & VIFF_REGISTER)
1463             pim_register_send(ip, viftable + xmt_vif, m, rt);
1464         else
1465 #endif
1466         MC_SEND(ip, viftable + xmt_vif, m);
1467         return 1;
1468     }
1469
1470     /*
1471      * Don't forward if it didn't arrive from the parent vif for its origin.
1472      */
1473     vifi = rt->mfc_parent;
1474     if ((vifi >= numvifs) || (viftable[vifi].v_ifp != ifp)) {
1475         /* came in the wrong interface */
1476         if (mrtdebug & DEBUG_FORWARD)
1477             log(LOG_DEBUG, "wrong if: ifp %p vifi %d vififp %p\n",
1478                 (void *)ifp, vifi, (void *)viftable[vifi].v_ifp);
1479         ++mrtstat.mrts_wrong_if;
1480         ++rt->mfc_wrong_if;
1481         /*
1482          * If we are doing PIM assert processing, send a message
1483          * to the routing daemon.
1484          *
1485          * XXX: A PIM-SM router needs the WRONGVIF detection so it
1486          * can complete the SPT switch, regardless of the type
1487          * of the iif (broadcast media, GRE tunnel, etc).
1488          */
1489         if (pim_assert && (vifi < numvifs) && viftable[vifi].v_ifp) {
1490             struct timeval now;
1491             u_long delta;
1492
1493 #ifdef PIM
1494             if (ifp == &multicast_register_if)
1495                 pimstat.pims_rcv_registers_wrongiif++;
1496 #endif
1497
1498             /* Get vifi for the incoming packet */
1499             for (vifi=0; vifi < numvifs && viftable[vifi].v_ifp != ifp; vifi++)
1500                 ;
1501             if (vifi >= numvifs)
1502                 return 0;       /* The iif is not found: ignore the packet. */
1503
1504             if (rt->mfc_flags[vifi] & MRT_MFC_FLAGS_DISABLE_WRONGVIF)
1505                 return 0;       /* WRONGVIF disabled: ignore the packet */
1506
1507             GET_TIME(now);
1508
1509             TV_DELTA(rt->mfc_last_assert, now, delta);
1510
1511             if (delta > ASSERT_MSG_TIME) {
1512                 struct sockaddr_in k_igmpsrc = { sizeof k_igmpsrc, AF_INET };
1513                 struct igmpmsg *im;
1514                 int hlen = ip->ip_hl << 2;
1515                 struct mbuf *mm = m_copy(m, 0, hlen);
1516
1517                 if (mm && (M_HASCL(mm) || mm->m_len < hlen))
1518                     mm = m_pullup(mm, hlen);
1519                 if (mm == NULL)
1520                     return ENOBUFS;
1521
1522                 rt->mfc_last_assert = now;
1523
1524                 im = mtod(mm, struct igmpmsg *);
1525                 im->im_msgtype  = IGMPMSG_WRONGVIF;
1526                 im->im_mbz              = 0;
1527                 im->im_vif              = vifi;
1528
1529                 mrtstat.mrts_upcalls++;
1530
1531                 k_igmpsrc.sin_addr = im->im_src;
1532                 if (socket_send(ip_mrouter, mm, &k_igmpsrc) < 0) {
1533                     log(LOG_WARNING,
1534                         "ip_mforward: ip_mrouter socket queue full\n");
1535                     ++mrtstat.mrts_upq_sockfull;
1536                     return ENOBUFS;
1537                 }
1538             }
1539         }
1540         return 0;
1541     }
1542
1543     /* If I sourced this packet, it counts as output, else it was input. */
1544     if (ip->ip_src.s_addr == viftable[vifi].v_lcl_addr.s_addr) {
1545         viftable[vifi].v_pkt_out++;
1546         viftable[vifi].v_bytes_out += plen;
1547     } else {
1548         viftable[vifi].v_pkt_in++;
1549         viftable[vifi].v_bytes_in += plen;
1550     }
1551     rt->mfc_pkt_cnt++;
1552     rt->mfc_byte_cnt += plen;
1553
1554     /*
1555      * For each vif, decide if a copy of the packet should be forwarded.
1556      * Forward if:
1557      *          - the ttl exceeds the vif's threshold
1558      *          - there are group members downstream on interface
1559      */
1560     for (vifi = 0; vifi < numvifs; vifi++)
1561         if ((rt->mfc_ttls[vifi] > 0) && (ip->ip_ttl > rt->mfc_ttls[vifi])) {
1562             viftable[vifi].v_pkt_out++;
1563             viftable[vifi].v_bytes_out += plen;
1564 #ifdef PIM
1565             if (viftable[vifi].v_flags & VIFF_REGISTER)
1566                 pim_register_send(ip, viftable + vifi, m, rt);
1567             else
1568 #endif
1569             MC_SEND(ip, viftable+vifi, m);
1570         }
1571
1572     /*
1573      * Perform upcall-related bw measuring.
1574      */
1575     if (rt->mfc_bw_meter != NULL) {
1576         struct bw_meter *x;
1577         struct timeval now;
1578
1579         GET_TIME(now);
1580         for (x = rt->mfc_bw_meter; x != NULL; x = x->bm_mfc_next)
1581             bw_meter_receive_packet(x, plen, &now);
1582     }
1583
1584     return 0;
1585 }
1586
1587 /*
1588  * check if a vif number is legal/ok. This is used by ip_output.
1589  */
1590 static int
1591 X_legal_vif_num(int vif)
1592 {
1593     return (vif >= 0 && vif < numvifs);
1594 }
1595
1596 /*
1597  * Return the local address used by this vif
1598  */
1599 static u_long
1600 X_ip_mcast_src(int vifi)
1601 {
1602     if (vifi >= 0 && vifi < numvifs)
1603         return viftable[vifi].v_lcl_addr.s_addr;
1604     else
1605         return INADDR_ANY;
1606 }
1607
1608 static void
1609 phyint_send(struct ip *ip, struct vif *vifp, struct mbuf *m)
1610 {
1611     struct mbuf *mb_copy;
1612     int hlen = ip->ip_hl << 2;
1613
1614     /*
1615      * Make a new reference to the packet; make sure that
1616      * the IP header is actually copied, not just referenced,
1617      * so that ip_output() only scribbles on the copy.
1618      */
1619     mb_copy = m_copypacket(m, M_DONTWAIT);
1620     if (mb_copy && (M_HASCL(mb_copy) || mb_copy->m_len < hlen))
1621         mb_copy = m_pullup(mb_copy, hlen);
1622     if (mb_copy == NULL)
1623         return;
1624
1625     if (vifp->v_rate_limit == 0)
1626         tbf_send_packet(vifp, mb_copy);
1627     else
1628         tbf_control(vifp, mb_copy, mtod(mb_copy, struct ip *), ip->ip_len);
1629 }
1630
1631 static void
1632 encap_send(struct ip *ip, struct vif *vifp, struct mbuf *m)
1633 {
1634     struct mbuf *mb_copy;
1635     struct ip *ip_copy;
1636     int i, len = ip->ip_len;
1637
1638     /* Take care of delayed checksums */
1639     if (m->m_pkthdr.csum_flags & CSUM_DELAY_DATA) {
1640         in_delayed_cksum(m);
1641         m->m_pkthdr.csum_flags &= ~CSUM_DELAY_DATA;
1642     }
1643
1644     /*
1645      * copy the old packet & pullup its IP header into the
1646      * new mbuf so we can modify it.  Try to fill the new
1647      * mbuf since if we don't the ethernet driver will.
1648      */
1649     MGETHDR(mb_copy, M_DONTWAIT, MT_HEADER);
1650     if (mb_copy == NULL)
1651         return;
1652     mb_copy->m_data += max_linkhdr;
1653     mb_copy->m_len = sizeof(multicast_encap_iphdr);
1654
1655     if ((mb_copy->m_next = m_copypacket(m, M_DONTWAIT)) == NULL) {
1656         m_freem(mb_copy);
1657         return;
1658     }
1659     i = MHLEN - M_LEADINGSPACE(mb_copy);
1660     if (i > len)
1661         i = len;
1662     mb_copy = m_pullup(mb_copy, i);
1663     if (mb_copy == NULL)
1664         return;
1665     mb_copy->m_pkthdr.len = len + sizeof(multicast_encap_iphdr);
1666
1667     /*
1668      * fill in the encapsulating IP header.
1669      */
1670     ip_copy = mtod(mb_copy, struct ip *);
1671     *ip_copy = multicast_encap_iphdr;
1672 #ifdef RANDOM_IP_ID
1673     ip_copy->ip_id = ip_randomid();
1674 #else
1675     ip_copy->ip_id = htons(ip_id++);
1676 #endif
1677     ip_copy->ip_len += len;
1678     ip_copy->ip_src = vifp->v_lcl_addr;
1679     ip_copy->ip_dst = vifp->v_rmt_addr;
1680
1681     /*
1682      * turn the encapsulated IP header back into a valid one.
1683      */
1684     ip = (struct ip *)((caddr_t)ip_copy + sizeof(multicast_encap_iphdr));
1685     --ip->ip_ttl;
1686     ip->ip_len = htons(ip->ip_len);
1687     ip->ip_off = htons(ip->ip_off);
1688     ip->ip_sum = 0;
1689     mb_copy->m_data += sizeof(multicast_encap_iphdr);
1690     ip->ip_sum = in_cksum(mb_copy, ip->ip_hl << 2);
1691     mb_copy->m_data -= sizeof(multicast_encap_iphdr);
1692
1693     if (vifp->v_rate_limit == 0)
1694         tbf_send_packet(vifp, mb_copy);
1695     else
1696         tbf_control(vifp, mb_copy, ip, ip_copy->ip_len);
1697 }
1698
1699 /*
1700  * De-encapsulate a packet and feed it back through ip input (this
1701  * routine is called whenever IP gets a packet with proto type
1702  * ENCAP_PROTO and a local destination address).
1703  *
1704  * This is similar to mroute_encapcheck() + mroute_encap_input() in -current.
1705  */
1706 static void
1707 X_ipip_input(struct mbuf *m, int off, int proto)
1708 {
1709     struct ip *ip = mtod(m, struct ip *);
1710     int hlen = ip->ip_hl << 2;
1711     int s;
1712     struct ifqueue *ifq;
1713
1714     if (!have_encap_tunnel) {
1715         rip_input(m, off, proto);
1716         return;
1717     }
1718     /*
1719      * dump the packet if it's not to a multicast destination or if
1720      * we don't have an encapsulating tunnel with the source.
1721      * Note:  This code assumes that the remote site IP address
1722      * uniquely identifies the tunnel (i.e., that this site has
1723      * at most one tunnel with the remote site).
1724      */
1725     if (!IN_MULTICAST(ntohl(((struct ip *)((char *)ip+hlen))->ip_dst.s_addr))) {
1726         ++mrtstat.mrts_bad_tunnel;
1727         m_freem(m);
1728         return;
1729     }
1730     if (ip->ip_src.s_addr != last_encap_src) {
1731         struct vif *vifp = viftable;
1732         struct vif *vife = vifp + numvifs;
1733
1734         last_encap_src = ip->ip_src.s_addr;
1735         last_encap_vif = NULL;
1736         for ( ; vifp < vife; ++vifp)
1737             if (vifp->v_rmt_addr.s_addr == ip->ip_src.s_addr) {
1738                 if ((vifp->v_flags & (VIFF_TUNNEL|VIFF_SRCRT))
1739                     == VIFF_TUNNEL)
1740                     last_encap_vif = vifp;
1741                 break;
1742             }
1743     }
1744     if (last_encap_vif == NULL) {
1745         last_encap_src = INADDR_ANY;
1746         mrtstat.mrts_cant_tunnel++; /*XXX*/
1747         m_freem(m);
1748         if (mrtdebug)
1749             log(LOG_DEBUG, "ip_mforward: no tunnel with %lx\n",
1750                 (u_long)ntohl(ip->ip_src.s_addr));
1751         return;
1752     }
1753
1754     if (hlen > sizeof(struct ip))
1755         ip_stripoptions(m, NULL);
1756     m->m_data += sizeof(struct ip);
1757     m->m_len -= sizeof(struct ip);
1758     m->m_pkthdr.len -= sizeof(struct ip);
1759     m->m_pkthdr.rcvif = last_encap_vif->v_ifp;
1760
1761     ifq = &ipintrq;
1762     s = splimp();
1763     if (IF_QFULL(ifq)) {
1764         IF_DROP(ifq);
1765         m_freem(m);
1766     } else {
1767         IF_ENQUEUE(ifq, m);
1768         /*
1769          * normally we would need a "schednetisr(NETISR_IP)"
1770          * here but we were called by ip_input and it is going
1771          * to loop back & try to dequeue the packet we just
1772          * queued as soon as we return so we avoid the
1773          * unnecessary software interrrupt.
1774          */
1775     }
1776     splx(s);
1777 }
1778
1779 /*
1780  * Token bucket filter module
1781  */
1782
1783 static void
1784 tbf_control(struct vif *vifp, struct mbuf *m, struct ip *ip, u_long p_len)
1785 {
1786     struct tbf *t = vifp->v_tbf;
1787
1788     if (p_len > MAX_BKT_SIZE) {         /* drop if packet is too large */
1789         mrtstat.mrts_pkt2large++;
1790         m_freem(m);
1791         return;
1792     }
1793
1794     tbf_update_tokens(vifp);
1795
1796     if (t->tbf_q_len == 0) {            /* queue empty...               */
1797         if (p_len <= t->tbf_n_tok) {    /* send packet if enough tokens */
1798             t->tbf_n_tok -= p_len;
1799             tbf_send_packet(vifp, m);
1800         } else {                        /* no, queue packet and try later */
1801             tbf_queue(vifp, m);
1802             timeout(tbf_reprocess_q, (caddr_t)vifp, TBF_REPROCESS);
1803         }
1804     } else if (t->tbf_q_len < t->tbf_max_q_len) {
1805         /* finite queue length, so queue pkts and process queue */
1806         tbf_queue(vifp, m);
1807         tbf_process_q(vifp);
1808     } else {
1809         /* queue full, try to dq and queue and process */
1810         if (!tbf_dq_sel(vifp, ip)) {
1811             mrtstat.mrts_q_overflow++;
1812             m_freem(m);
1813         } else {
1814             tbf_queue(vifp, m);
1815             tbf_process_q(vifp);
1816         }
1817     }
1818 }
1819
1820 /*
1821  * adds a packet to the queue at the interface
1822  */
1823 static void
1824 tbf_queue(struct vif *vifp, struct mbuf *m)
1825 {
1826     int s = splnet();
1827     struct tbf *t = vifp->v_tbf;
1828
1829     if (t->tbf_t == NULL)       /* Queue was empty */
1830         t->tbf_q = m;
1831     else                        /* Insert at tail */
1832         t->tbf_t->m_act = m;
1833
1834     t->tbf_t = m;               /* Set new tail pointer */
1835
1836 #ifdef DIAGNOSTIC
1837     /* Make sure we didn't get fed a bogus mbuf */
1838     if (m->m_act)
1839         panic("tbf_queue: m_act");
1840 #endif
1841     m->m_act = NULL;
1842
1843     t->tbf_q_len++;
1844
1845     splx(s);
1846 }
1847
1848 /*
1849  * processes the queue at the interface
1850  */
1851 static void
1852 tbf_process_q(struct vif *vifp)
1853 {
1854     int s = splnet();
1855     struct tbf *t = vifp->v_tbf;
1856
1857     /* loop through the queue at the interface and send as many packets
1858      * as possible
1859      */
1860     while (t->tbf_q_len > 0) {
1861         struct mbuf *m = t->tbf_q;
1862         int len = mtod(m, struct ip *)->ip_len;
1863
1864         /* determine if the packet can be sent */
1865         if (len > t->tbf_n_tok) /* not enough tokens, we are done */
1866             break;
1867         /* ok, reduce no of tokens, dequeue and send the packet. */
1868         t->tbf_n_tok -= len;
1869
1870         t->tbf_q = m->m_act;
1871         if (--t->tbf_q_len == 0)
1872             t->tbf_t = NULL;
1873
1874         m->m_act = NULL;
1875         tbf_send_packet(vifp, m);
1876     }
1877     splx(s);
1878 }
1879
1880 static void
1881 tbf_reprocess_q(void *xvifp)
1882 {
1883     struct vif *vifp = xvifp;
1884
1885     if (ip_mrouter == NULL)
1886         return;
1887     tbf_update_tokens(vifp);
1888     tbf_process_q(vifp);
1889     if (vifp->v_tbf->tbf_q_len)
1890         timeout(tbf_reprocess_q, (caddr_t)vifp, TBF_REPROCESS);
1891 }
1892
1893 /* function that will selectively discard a member of the queue
1894  * based on the precedence value and the priority
1895  */
1896 static int
1897 tbf_dq_sel(struct vif *vifp, struct ip *ip)
1898 {
1899     int s = splnet();
1900     u_int p;
1901     struct mbuf *m, *last;
1902     struct mbuf **np;
1903     struct tbf *t = vifp->v_tbf;
1904
1905     p = priority(vifp, ip);
1906
1907     np = &t->tbf_q;
1908     last = NULL;
1909     while ((m = *np) != NULL) {
1910         if (p > priority(vifp, mtod(m, struct ip *))) {
1911             *np = m->m_act;
1912             /* If we're removing the last packet, fix the tail pointer */
1913             if (m == t->tbf_t)
1914                 t->tbf_t = last;
1915             m_freem(m);
1916             /* It's impossible for the queue to be empty, but check anyways. */
1917             if (--t->tbf_q_len == 0)
1918                 t->tbf_t = NULL;
1919             splx(s);
1920             mrtstat.mrts_drop_sel++;
1921             return 1;
1922         }
1923         np = &m->m_act;
1924         last = m;
1925     }
1926     splx(s);
1927     return 0;
1928 }
1929
1930 static void
1931 tbf_send_packet(struct vif *vifp, struct mbuf *m)
1932 {
1933     int s = splnet();
1934
1935     if (vifp->v_flags & VIFF_TUNNEL)    /* If tunnel options */
1936         ip_output(m, NULL, &vifp->v_route, IP_FORWARDING, NULL, NULL);
1937     else {
1938         struct ip_moptions imo;
1939         int error;
1940         static struct route ro; /* XXX check this */
1941
1942         imo.imo_multicast_ifp  = vifp->v_ifp;
1943         imo.imo_multicast_ttl  = mtod(m, struct ip *)->ip_ttl - 1;
1944         imo.imo_multicast_loop = 1;
1945         imo.imo_multicast_vif  = -1;
1946
1947         /*
1948          * Re-entrancy should not be a problem here, because
1949          * the packets that we send out and are looped back at us
1950          * should get rejected because they appear to come from
1951          * the loopback interface, thus preventing looping.
1952          */
1953         error = ip_output(m, NULL, &ro, IP_FORWARDING, &imo, NULL);
1954
1955         if (mrtdebug & DEBUG_XMIT)
1956             log(LOG_DEBUG, "phyint_send on vif %d err %d\n",
1957                 (int)(vifp - viftable), error);
1958     }
1959     splx(s);
1960 }
1961
1962 /* determine the current time and then
1963  * the elapsed time (between the last time and time now)
1964  * in milliseconds & update the no. of tokens in the bucket
1965  */
1966 static void
1967 tbf_update_tokens(struct vif *vifp)
1968 {
1969     struct timeval tp;
1970     u_long tm;
1971     int s = splnet();
1972     struct tbf *t = vifp->v_tbf;
1973
1974     GET_TIME(tp);
1975
1976     TV_DELTA(tp, t->tbf_last_pkt_t, tm);
1977
1978     /*
1979      * This formula is actually
1980      * "time in seconds" * "bytes/second".
1981      *
1982      * (tm / 1000000) * (v_rate_limit * 1000 * (1000/1024) / 8)
1983      *
1984      * The (1000/1024) was introduced in add_vif to optimize
1985      * this divide into a shift.
1986      */
1987     t->tbf_n_tok += tm * vifp->v_rate_limit / 1024 / 8;
1988     t->tbf_last_pkt_t = tp;
1989
1990     if (t->tbf_n_tok > MAX_BKT_SIZE)
1991         t->tbf_n_tok = MAX_BKT_SIZE;
1992
1993     splx(s);
1994 }
1995
1996 static int
1997 priority(struct vif *vifp, struct ip *ip)
1998 {
1999     int prio = 50; /* the lowest priority -- default case */
2000
2001     /* temporary hack; may add general packet classifier some day */
2002
2003     /*
2004      * The UDP port space is divided up into four priority ranges:
2005      * [0, 16384)     : unclassified - lowest priority
2006      * [16384, 32768) : audio - highest priority
2007      * [32768, 49152) : whiteboard - medium priority
2008      * [49152, 65536) : video - low priority
2009      *
2010      * Everything else gets lowest priority.
2011      */
2012     if (ip->ip_p == IPPROTO_UDP) {
2013         struct udphdr *udp = (struct udphdr *)(((char *)ip) + (ip->ip_hl << 2));
2014         switch (ntohs(udp->uh_dport) & 0xc000) {
2015         case 0x4000:
2016             prio = 70;
2017             break;
2018         case 0x8000:
2019             prio = 60;
2020             break;
2021         case 0xc000:
2022             prio = 55;
2023             break;
2024         }
2025     }
2026     return prio;
2027 }
2028
2029 /*
2030  * End of token bucket filter modifications
2031  */
2032
2033 static int
2034 X_ip_rsvp_vif(struct socket *so, struct sockopt *sopt)
2035 {
2036     int error, vifi, s;
2037
2038     if (so->so_type != SOCK_RAW || so->so_proto->pr_protocol != IPPROTO_RSVP)
2039         return EOPNOTSUPP;
2040
2041     error = sooptcopyin(sopt, &vifi, sizeof vifi, sizeof vifi);
2042     if (error)
2043         return error;
2044
2045     s = splnet();
2046
2047     if (vifi < 0 || vifi >= numvifs) { /* Error if vif is invalid */
2048         splx(s);
2049         return EADDRNOTAVAIL;
2050     }
2051
2052     if (sopt->sopt_name == IP_RSVP_VIF_ON) {
2053         /* Check if socket is available. */
2054         if (viftable[vifi].v_rsvpd != NULL) {
2055             splx(s);
2056             return EADDRINUSE;
2057         }
2058
2059         viftable[vifi].v_rsvpd = so;
2060         /* This may seem silly, but we need to be sure we don't over-increment
2061          * the RSVP counter, in case something slips up.
2062          */
2063         if (!viftable[vifi].v_rsvp_on) {
2064             viftable[vifi].v_rsvp_on = 1;
2065             rsvp_on++;
2066         }
2067     } else { /* must be VIF_OFF */
2068         /*
2069          * XXX as an additional consistency check, one could make sure
2070          * that viftable[vifi].v_rsvpd == so, otherwise passing so as
2071          * first parameter is pretty useless.
2072          */
2073         viftable[vifi].v_rsvpd = NULL;
2074         /*
2075          * This may seem silly, but we need to be sure we don't over-decrement
2076          * the RSVP counter, in case something slips up.
2077          */
2078         if (viftable[vifi].v_rsvp_on) {
2079             viftable[vifi].v_rsvp_on = 0;
2080             rsvp_on--;
2081         }
2082     }
2083     splx(s);
2084     return 0;
2085 }
2086
2087 static void
2088 X_ip_rsvp_force_done(struct socket *so)
2089 {
2090     int vifi;
2091     int s;
2092
2093     /* Don't bother if it is not the right type of socket. */
2094     if (so->so_type != SOCK_RAW || so->so_proto->pr_protocol != IPPROTO_RSVP)
2095         return;
2096
2097     s = splnet();
2098
2099     /* The socket may be attached to more than one vif...this
2100      * is perfectly legal.
2101      */
2102     for (vifi = 0; vifi < numvifs; vifi++) {
2103         if (viftable[vifi].v_rsvpd == so) {
2104             viftable[vifi].v_rsvpd = NULL;
2105             /* This may seem silly, but we need to be sure we don't
2106              * over-decrement the RSVP counter, in case something slips up.
2107              */
2108             if (viftable[vifi].v_rsvp_on) {
2109                 viftable[vifi].v_rsvp_on = 0;
2110                 rsvp_on--;
2111             }
2112         }
2113     }
2114
2115     splx(s);
2116 }
2117
2118 static void
2119 X_rsvp_input(struct mbuf *m, int off, int proto)
2120 {
2121     int vifi;
2122     struct ip *ip = mtod(m, struct ip *);
2123     struct sockaddr_in rsvp_src = { sizeof rsvp_src, AF_INET };
2124     int s;
2125     struct ifnet *ifp;
2126
2127     if (rsvpdebug)
2128         printf("rsvp_input: rsvp_on %d\n",rsvp_on);
2129
2130     /* Can still get packets with rsvp_on = 0 if there is a local member
2131      * of the group to which the RSVP packet is addressed.  But in this
2132      * case we want to throw the packet away.
2133      */
2134     if (!rsvp_on) {
2135         m_freem(m);
2136         return;
2137     }
2138
2139     s = splnet();
2140
2141     if (rsvpdebug)
2142         printf("rsvp_input: check vifs\n");
2143
2144 #ifdef DIAGNOSTIC
2145     if (!(m->m_flags & M_PKTHDR))
2146         panic("rsvp_input no hdr");
2147 #endif
2148
2149     ifp = m->m_pkthdr.rcvif;
2150     /* Find which vif the packet arrived on. */
2151     for (vifi = 0; vifi < numvifs; vifi++)
2152         if (viftable[vifi].v_ifp == ifp)
2153             break;
2154
2155     if (vifi == numvifs || viftable[vifi].v_rsvpd == NULL) {
2156         /*
2157          * If the old-style non-vif-associated socket is set,
2158          * then use it.  Otherwise, drop packet since there
2159          * is no specific socket for this vif.
2160          */
2161         if (ip_rsvpd != NULL) {
2162             if (rsvpdebug)
2163                 printf("rsvp_input: Sending packet up old-style socket\n");
2164             rip_input(m, off, proto);  /* xxx */
2165         } else {
2166             if (rsvpdebug && vifi == numvifs)
2167                 printf("rsvp_input: Can't find vif for packet.\n");
2168             else if (rsvpdebug && viftable[vifi].v_rsvpd == NULL)
2169                 printf("rsvp_input: No socket defined for vif %d\n",vifi);
2170             m_freem(m);
2171         }
2172         splx(s);
2173         return;
2174     }
2175     rsvp_src.sin_addr = ip->ip_src;
2176
2177     if (rsvpdebug && m)
2178         printf("rsvp_input: m->m_len = %d, sbspace() = %ld\n",
2179                m->m_len,sbspace(&(viftable[vifi].v_rsvpd->so_rcv)));
2180
2181     if (socket_send(viftable[vifi].v_rsvpd, m, &rsvp_src) < 0) {
2182         if (rsvpdebug)
2183             printf("rsvp_input: Failed to append to socket\n");
2184     } else {
2185         if (rsvpdebug)
2186             printf("rsvp_input: send packet up\n");
2187     }
2188
2189     splx(s);
2190 }
2191
2192 /*
2193  * Code for bandwidth monitors
2194  */
2195
2196 /*
2197  * Define common interface for timeval-related methods
2198  */
2199 #define BW_TIMEVALCMP(tvp, uvp, cmp) timevalcmp((tvp), (uvp), cmp)
2200 #define BW_TIMEVALDECR(vvp, uvp) timevalsub((vvp), (uvp))
2201 #define BW_TIMEVALADD(vvp, uvp) timevaladd((vvp), (uvp))
2202
2203 static uint32_t
2204 compute_bw_meter_flags(struct bw_upcall *req)
2205 {
2206     uint32_t flags = 0;
2207
2208     if (req->bu_flags & BW_UPCALL_UNIT_PACKETS)
2209         flags |= BW_METER_UNIT_PACKETS;
2210     if (req->bu_flags & BW_UPCALL_UNIT_BYTES)
2211         flags |= BW_METER_UNIT_BYTES;
2212     if (req->bu_flags & BW_UPCALL_GEQ)
2213         flags |= BW_METER_GEQ;
2214     if (req->bu_flags & BW_UPCALL_LEQ)
2215         flags |= BW_METER_LEQ;
2216     
2217     return flags;
2218 }
2219  
2220 /*
2221  * Add a bw_meter entry
2222  */
2223 static int
2224 add_bw_upcall(struct bw_upcall *req)
2225 {
2226     struct mfc *mfc;
2227     struct timeval delta = { BW_UPCALL_THRESHOLD_INTERVAL_MIN_SEC,
2228                 BW_UPCALL_THRESHOLD_INTERVAL_MIN_USEC };
2229     struct timeval now;
2230     struct bw_meter *x;
2231     uint32_t flags;
2232     int s;
2233     
2234     if (!(mrt_api_config & MRT_MFC_BW_UPCALL))
2235         return EOPNOTSUPP;
2236     
2237     /* Test if the flags are valid */
2238     if (!(req->bu_flags & (BW_UPCALL_UNIT_PACKETS | BW_UPCALL_UNIT_BYTES)))
2239         return EINVAL;
2240     if (!(req->bu_flags & (BW_UPCALL_GEQ | BW_UPCALL_LEQ)))
2241         return EINVAL;
2242     if ((req->bu_flags & (BW_UPCALL_GEQ | BW_UPCALL_LEQ))
2243             == (BW_UPCALL_GEQ | BW_UPCALL_LEQ))
2244         return EINVAL;
2245     
2246     /* Test if the threshold time interval is valid */
2247     if (BW_TIMEVALCMP(&req->bu_threshold.b_time, &delta, <))
2248         return EINVAL;
2249     
2250     flags = compute_bw_meter_flags(req);
2251
2252     /*
2253      * Find if we have already same bw_meter entry
2254      */
2255     s = splnet();
2256     mfc = mfc_find(req->bu_src.s_addr, req->bu_dst.s_addr);
2257     if (mfc == NULL) {
2258         splx(s);
2259         return EADDRNOTAVAIL;
2260     }
2261     for (x = mfc->mfc_bw_meter; x != NULL; x = x->bm_mfc_next) {
2262         if ((BW_TIMEVALCMP(&x->bm_threshold.b_time,
2263                            &req->bu_threshold.b_time, ==)) &&
2264             (x->bm_threshold.b_packets == req->bu_threshold.b_packets) &&
2265             (x->bm_threshold.b_bytes == req->bu_threshold.b_bytes) &&
2266             (x->bm_flags & BW_METER_USER_FLAGS) == flags)  {
2267             splx(s);
2268             return 0;           /* XXX Already installed */
2269         }
2270     }
2271     splx(s);
2272     
2273     /* Allocate the new bw_meter entry */
2274     x = (struct bw_meter *)malloc(sizeof(*x), M_BWMETER, M_NOWAIT);
2275     if (x == NULL)
2276         return ENOBUFS;
2277     
2278     /* Set the new bw_meter entry */
2279     x->bm_threshold.b_time = req->bu_threshold.b_time;
2280     GET_TIME(now);
2281     x->bm_start_time = now;
2282     x->bm_threshold.b_packets = req->bu_threshold.b_packets;
2283     x->bm_threshold.b_bytes = req->bu_threshold.b_bytes;
2284     x->bm_measured.b_packets = 0;
2285     x->bm_measured.b_bytes = 0;
2286     x->bm_flags = flags;
2287     x->bm_time_next = NULL;
2288     x->bm_time_hash = BW_METER_BUCKETS;
2289     
2290     /* Add the new bw_meter entry to the front of entries for this MFC */
2291     s = splnet();
2292     x->bm_mfc = mfc;
2293     x->bm_mfc_next = mfc->mfc_bw_meter;
2294     mfc->mfc_bw_meter = x;
2295     schedule_bw_meter(x, &now);
2296     splx(s);
2297     
2298     return 0;
2299 }
2300
2301 static void
2302 free_bw_list(struct bw_meter *list)
2303 {
2304     while (list != NULL) {
2305         struct bw_meter *x = list;
2306
2307         list = list->bm_mfc_next;
2308         unschedule_bw_meter(x);
2309         free(x, M_BWMETER);
2310     }
2311 }
2312
2313 /*
2314  * Delete one or multiple bw_meter entries
2315  */
2316 static int
2317 del_bw_upcall(struct bw_upcall *req)
2318 {
2319     struct mfc *mfc;
2320     struct bw_meter *x;
2321     int s;
2322     
2323     if (!(mrt_api_config & MRT_MFC_BW_UPCALL))
2324         return EOPNOTSUPP;
2325     
2326     s = splnet();
2327     /* Find the corresponding MFC entry */
2328     mfc = mfc_find(req->bu_src.s_addr, req->bu_dst.s_addr);
2329     if (mfc == NULL) {
2330         splx(s);
2331         return EADDRNOTAVAIL;
2332     } else if (req->bu_flags & BW_UPCALL_DELETE_ALL) {
2333         /*
2334          * Delete all bw_meter entries for this mfc
2335          */
2336         struct bw_meter *list;
2337         
2338         list = mfc->mfc_bw_meter;
2339         mfc->mfc_bw_meter = NULL;
2340         splx(s);
2341         free_bw_list(list);
2342         return 0;
2343     } else {                    /* Delete a single bw_meter entry */
2344         struct bw_meter *prev;
2345         uint32_t flags = 0;
2346
2347         flags = compute_bw_meter_flags(req);
2348
2349         /* Find the bw_meter entry to delete */
2350         for (prev = NULL, x = mfc->mfc_bw_meter; x != NULL;
2351              x = x->bm_mfc_next) {
2352             if ((BW_TIMEVALCMP(&x->bm_threshold.b_time,
2353                                &req->bu_threshold.b_time, ==)) &&
2354                 (x->bm_threshold.b_packets == req->bu_threshold.b_packets) &&
2355                 (x->bm_threshold.b_bytes == req->bu_threshold.b_bytes) &&
2356                 (x->bm_flags & BW_METER_USER_FLAGS) == flags)
2357                 break;
2358         }
2359         if (x != NULL) { /* Delete entry from the list for this MFC */
2360             if (prev != NULL)
2361                 prev->bm_mfc_next = x->bm_mfc_next;     /* remove from middle*/
2362             else
2363                 x->bm_mfc->mfc_bw_meter = x->bm_mfc_next;/* new head of list */
2364             splx(s);
2365
2366             unschedule_bw_meter(x);
2367             /* Free the bw_meter entry */
2368             free(x, M_BWMETER);
2369             return 0;
2370         } else {
2371             splx(s);
2372             return EINVAL;
2373         }
2374     }
2375     /* NOTREACHED */
2376 }
2377
2378 /*
2379  * Perform bandwidth measurement processing that may result in an upcall
2380  */
2381 static void
2382 bw_meter_receive_packet(struct bw_meter *x, int plen, struct timeval *nowp)
2383 {
2384     struct timeval delta;
2385     int s;
2386     
2387     s = splnet();
2388     delta = *nowp;
2389     BW_TIMEVALDECR(&delta, &x->bm_start_time);
2390     
2391     if (x->bm_flags & BW_METER_GEQ) {
2392         /*
2393          * Processing for ">=" type of bw_meter entry
2394          */
2395         if (BW_TIMEVALCMP(&delta, &x->bm_threshold.b_time, >)) {
2396             /* Reset the bw_meter entry */
2397             x->bm_start_time = *nowp;
2398             x->bm_measured.b_packets = 0;
2399             x->bm_measured.b_bytes = 0;
2400             x->bm_flags &= ~BW_METER_UPCALL_DELIVERED;
2401         }
2402         
2403         /* Record that a packet is received */
2404         x->bm_measured.b_packets++;
2405         x->bm_measured.b_bytes += plen;
2406         
2407         /*
2408          * Test if we should deliver an upcall
2409          */
2410         if (!(x->bm_flags & BW_METER_UPCALL_DELIVERED)) {       
2411             if (((x->bm_flags & BW_METER_UNIT_PACKETS) &&
2412                  (x->bm_measured.b_packets >= x->bm_threshold.b_packets)) ||
2413                 ((x->bm_flags & BW_METER_UNIT_BYTES) &&
2414                  (x->bm_measured.b_bytes >= x->bm_threshold.b_bytes))) {
2415                 /* Prepare an upcall for delivery */
2416                 bw_meter_prepare_upcall(x, nowp);
2417                 x->bm_flags |= BW_METER_UPCALL_DELIVERED;
2418             }
2419         }
2420     } else if (x->bm_flags & BW_METER_LEQ) {
2421         /*
2422          * Processing for "<=" type of bw_meter entry
2423          */
2424         if (BW_TIMEVALCMP(&delta, &x->bm_threshold.b_time, >)) {
2425             /*
2426              * We are behind time with the multicast forwarding table
2427              * scanning for "<=" type of bw_meter entries, so test now
2428              * if we should deliver an upcall.
2429              */
2430             if (((x->bm_flags & BW_METER_UNIT_PACKETS) &&
2431                  (x->bm_measured.b_packets <= x->bm_threshold.b_packets)) ||
2432                 ((x->bm_flags & BW_METER_UNIT_BYTES) &&
2433                  (x->bm_measured.b_bytes <= x->bm_threshold.b_bytes))) {
2434                 /* Prepare an upcall for delivery */
2435                 bw_meter_prepare_upcall(x, nowp);
2436             }
2437             /* Reschedule the bw_meter entry */
2438             unschedule_bw_meter(x);
2439             schedule_bw_meter(x, nowp);
2440         }
2441         
2442         /* Record that a packet is received */
2443         x->bm_measured.b_packets++;
2444         x->bm_measured.b_bytes += plen;
2445         
2446         /*
2447          * Test if we should restart the measuring interval
2448          */
2449         if ((x->bm_flags & BW_METER_UNIT_PACKETS &&
2450              x->bm_measured.b_packets <= x->bm_threshold.b_packets) ||
2451             (x->bm_flags & BW_METER_UNIT_BYTES &&
2452              x->bm_measured.b_bytes <= x->bm_threshold.b_bytes)) {
2453             /* Don't restart the measuring interval */
2454         } else {
2455             /* Do restart the measuring interval */
2456             /*
2457              * XXX: note that we don't unschedule and schedule, because this
2458              * might be too much overhead per packet. Instead, when we process
2459              * all entries for a given timer hash bin, we check whether it is
2460              * really a timeout. If not, we reschedule at that time.
2461              */
2462             x->bm_start_time = *nowp;
2463             x->bm_measured.b_packets = 0;
2464             x->bm_measured.b_bytes = 0;
2465             x->bm_flags &= ~BW_METER_UPCALL_DELIVERED;
2466         }
2467     }
2468     splx(s);
2469 }
2470
2471 /*
2472  * Prepare a bandwidth-related upcall
2473  */
2474 static void
2475 bw_meter_prepare_upcall(struct bw_meter *x, struct timeval *nowp)
2476 {
2477     struct timeval delta;
2478     struct bw_upcall *u;
2479     int s;
2480     
2481     s = splnet();
2482     
2483     /*
2484      * Compute the measured time interval 
2485      */
2486     delta = *nowp;
2487     BW_TIMEVALDECR(&delta, &x->bm_start_time);
2488     
2489     /*
2490      * If there are too many pending upcalls, deliver them now
2491      */
2492     if (bw_upcalls_n >= BW_UPCALLS_MAX)
2493         bw_upcalls_send();
2494     
2495     /*
2496      * Set the bw_upcall entry
2497      */
2498     u = &bw_upcalls[bw_upcalls_n++];
2499     u->bu_src = x->bm_mfc->mfc_origin;
2500     u->bu_dst = x->bm_mfc->mfc_mcastgrp;
2501     u->bu_threshold.b_time = x->bm_threshold.b_time;
2502     u->bu_threshold.b_packets = x->bm_threshold.b_packets;
2503     u->bu_threshold.b_bytes = x->bm_threshold.b_bytes;
2504     u->bu_measured.b_time = delta;
2505     u->bu_measured.b_packets = x->bm_measured.b_packets;
2506     u->bu_measured.b_bytes = x->bm_measured.b_bytes;
2507     u->bu_flags = 0;
2508     if (x->bm_flags & BW_METER_UNIT_PACKETS)
2509         u->bu_flags |= BW_UPCALL_UNIT_PACKETS;
2510     if (x->bm_flags & BW_METER_UNIT_BYTES)
2511         u->bu_flags |= BW_UPCALL_UNIT_BYTES;
2512     if (x->bm_flags & BW_METER_GEQ)
2513         u->bu_flags |= BW_UPCALL_GEQ;
2514     if (x->bm_flags & BW_METER_LEQ)
2515         u->bu_flags |= BW_UPCALL_LEQ;
2516     
2517     splx(s);
2518 }
2519
2520 /*
2521  * Send the pending bandwidth-related upcalls
2522  */
2523 static void
2524 bw_upcalls_send(void)
2525 {
2526     struct mbuf *m;
2527     int len = bw_upcalls_n * sizeof(bw_upcalls[0]);
2528     struct sockaddr_in k_igmpsrc = { sizeof k_igmpsrc, AF_INET };
2529     static struct igmpmsg igmpmsg = { 0,                /* unused1 */
2530                                       0,                /* unused2 */
2531                                       IGMPMSG_BW_UPCALL,/* im_msgtype */
2532                                       0,                /* im_mbz  */
2533                                       0,                /* im_vif  */
2534                                       0,                /* unused3 */
2535                                       { 0 },            /* im_src  */
2536                                       { 0 } };          /* im_dst  */
2537     
2538     if (bw_upcalls_n == 0)
2539         return;                 /* No pending upcalls */
2540
2541     bw_upcalls_n = 0;
2542     
2543     /*
2544      * Allocate a new mbuf, initialize it with the header and
2545      * the payload for the pending calls.
2546      */
2547     MGETHDR(m, M_DONTWAIT, MT_HEADER);
2548     if (m == NULL) {
2549         log(LOG_WARNING, "bw_upcalls_send: cannot allocate mbuf\n");
2550         return;
2551     }
2552     
2553     m->m_len = m->m_pkthdr.len = 0;
2554     m_copyback(m, 0, sizeof(struct igmpmsg), (caddr_t)&igmpmsg);
2555     m_copyback(m, sizeof(struct igmpmsg), len, (caddr_t)&bw_upcalls[0]);
2556     
2557     /*
2558      * Send the upcalls
2559      * XXX do we need to set the address in k_igmpsrc ?
2560      */
2561     mrtstat.mrts_upcalls++;
2562     if (socket_send(ip_mrouter, m, &k_igmpsrc) < 0) {
2563         log(LOG_WARNING, "bw_upcalls_send: ip_mrouter socket queue full\n");
2564         ++mrtstat.mrts_upq_sockfull;
2565     }
2566 }
2567
2568 /*
2569  * Compute the timeout hash value for the bw_meter entries
2570  */
2571 #define BW_METER_TIMEHASH(bw_meter, hash)                               \
2572     do {                                                                \
2573         struct timeval next_timeval = (bw_meter)->bm_start_time;        \
2574                                                                         \
2575         BW_TIMEVALADD(&next_timeval, &(bw_meter)->bm_threshold.b_time); \
2576         (hash) = next_timeval.tv_sec;                                   \
2577         if (next_timeval.tv_usec)                                       \
2578             (hash)++; /* XXX: make sure we don't timeout early */       \
2579         (hash) %= BW_METER_BUCKETS;                                     \
2580     } while (0)
2581
2582 /*
2583  * Schedule a timer to process periodically bw_meter entry of type "<="
2584  * by linking the entry in the proper hash bucket.
2585  */
2586 static void
2587 schedule_bw_meter(struct bw_meter *x, struct timeval *nowp)
2588 {
2589     int time_hash, s;
2590     
2591     if (!(x->bm_flags & BW_METER_LEQ))
2592         return;         /* XXX: we schedule timers only for "<=" entries */
2593     
2594     /*
2595      * Reset the bw_meter entry
2596      */
2597     s = splnet();
2598     x->bm_start_time = *nowp;
2599     x->bm_measured.b_packets = 0;
2600     x->bm_measured.b_bytes = 0;
2601     x->bm_flags &= ~BW_METER_UPCALL_DELIVERED;
2602     splx(s);
2603     
2604     /*
2605      * Compute the timeout hash value and insert the entry
2606      */
2607     BW_METER_TIMEHASH(x, time_hash);
2608     x->bm_time_next = bw_meter_timers[time_hash];
2609     bw_meter_timers[time_hash] = x;
2610     x->bm_time_hash = time_hash;
2611 }
2612
2613 /*
2614  * Unschedule the periodic timer that processes bw_meter entry of type "<="
2615  * by removing the entry from the proper hash bucket.
2616  */
2617 static void
2618 unschedule_bw_meter(struct bw_meter *x)
2619 {
2620     int time_hash;
2621     struct bw_meter *prev, *tmp;
2622     
2623     if (!(x->bm_flags & BW_METER_LEQ))
2624         return;         /* XXX: we schedule timers only for "<=" entries */
2625     
2626     /*
2627      * Compute the timeout hash value and delete the entry
2628      */
2629     time_hash = x->bm_time_hash;
2630     if (time_hash >= BW_METER_BUCKETS)
2631         return;         /* Entry was not scheduled */
2632     
2633     for (prev = NULL, tmp = bw_meter_timers[time_hash];
2634              tmp != NULL; prev = tmp, tmp = tmp->bm_time_next)
2635         if (tmp == x)
2636             break;
2637     
2638     if (tmp == NULL)
2639         panic("unschedule_bw_meter: bw_meter entry not found");
2640     
2641     if (prev != NULL)
2642         prev->bm_time_next = x->bm_time_next;
2643     else
2644         bw_meter_timers[time_hash] = x->bm_time_next;
2645     
2646     x->bm_time_next = NULL;
2647     x->bm_time_hash = BW_METER_BUCKETS;
2648 }
2649
2650
2651 /*
2652  * Process all "<=" type of bw_meter that should be processed now,
2653  * and for each entry prepare an upcall if necessary. Each processed
2654  * entry is rescheduled again for the (periodic) processing.
2655  *
2656  * This is run periodically (once per second normally). On each round,
2657  * all the potentially matching entries are in the hash slot that we are
2658  * looking at.
2659  */
2660 static void
2661 bw_meter_process()
2662 {
2663     static uint32_t last_tv_sec;        /* last time we processed this */
2664
2665     uint32_t loops;
2666     int i, s;
2667     struct timeval now, process_endtime;
2668     
2669     GET_TIME(now);
2670     if (last_tv_sec == now.tv_sec)
2671         return;         /* nothing to do */
2672
2673     s = splnet();
2674     loops = now.tv_sec - last_tv_sec;
2675     last_tv_sec = now.tv_sec;
2676     if (loops > BW_METER_BUCKETS)
2677         loops = BW_METER_BUCKETS;
2678
2679     /*
2680      * Process all bins of bw_meter entries from the one after the last
2681      * processed to the current one. On entry, i points to the last bucket
2682      * visited, so we need to increment i at the beginning of the loop.
2683      */
2684     for (i = (now.tv_sec - loops) % BW_METER_BUCKETS; loops > 0; loops--) {
2685         struct bw_meter *x, *tmp_list;
2686         
2687         if (++i >= BW_METER_BUCKETS)
2688             i = 0;
2689         
2690         /* Disconnect the list of bw_meter entries from the bin */
2691         tmp_list = bw_meter_timers[i];
2692         bw_meter_timers[i] = NULL;
2693         
2694         /* Process the list of bw_meter entries */
2695         while (tmp_list != NULL) {
2696             x = tmp_list;
2697             tmp_list = tmp_list->bm_time_next;
2698             
2699             /* Test if the time interval is over */
2700             process_endtime = x->bm_start_time;
2701             BW_TIMEVALADD(&process_endtime, &x->bm_threshold.b_time);
2702             if (BW_TIMEVALCMP(&process_endtime, &now, >)) {
2703                 /* Not yet: reschedule, but don't reset */
2704                 int time_hash;
2705                 
2706                 BW_METER_TIMEHASH(x, time_hash);
2707                 if (time_hash == i && process_endtime.tv_sec == now.tv_sec) {
2708                     /*
2709                      * XXX: somehow the bin processing is a bit ahead of time.
2710                      * Put the entry in the next bin.
2711                      */
2712                     if (++time_hash >= BW_METER_BUCKETS)
2713                         time_hash = 0;
2714                 }
2715                 x->bm_time_next = bw_meter_timers[time_hash];
2716                 bw_meter_timers[time_hash] = x;
2717                 x->bm_time_hash = time_hash;
2718                 
2719                 continue;
2720             }
2721             
2722             /*
2723              * Test if we should deliver an upcall
2724              */
2725             if (((x->bm_flags & BW_METER_UNIT_PACKETS) &&
2726                  (x->bm_measured.b_packets <= x->bm_threshold.b_packets)) ||
2727                 ((x->bm_flags & BW_METER_UNIT_BYTES) &&
2728                  (x->bm_measured.b_bytes <= x->bm_threshold.b_bytes))) {
2729                 /* Prepare an upcall for delivery */
2730                 bw_meter_prepare_upcall(x, &now);
2731             }
2732             
2733             /*
2734              * Reschedule for next processing
2735              */
2736             schedule_bw_meter(x, &now);
2737         }
2738     }
2739     splx(s);
2740     
2741     /* Send all upcalls that are pending delivery */
2742     bw_upcalls_send();
2743 }
2744
2745 /*
2746  * A periodic function for sending all upcalls that are pending delivery
2747  */
2748 static void
2749 expire_bw_upcalls_send(void *unused)
2750 {
2751     bw_upcalls_send();
2752     
2753     bw_upcalls_ch = timeout(expire_bw_upcalls_send, NULL, BW_UPCALLS_PERIOD);
2754 }
2755
2756 /*
2757  * A periodic function for periodic scanning of the multicast forwarding
2758  * table for processing all "<=" bw_meter entries.
2759  */
2760 static void
2761 expire_bw_meter_process(void *unused)
2762 {
2763     if (mrt_api_config & MRT_MFC_BW_UPCALL)
2764         bw_meter_process();
2765     
2766     bw_meter_ch = timeout(expire_bw_meter_process, NULL, BW_METER_PERIOD);
2767 }
2768
2769 /*
2770  * End of bandwidth monitoring code
2771  */
2772
2773 #ifdef PIM
2774 /*
2775  * Send the packet up to the user daemon, or eventually do kernel encapsulation
2776  *
2777  */
2778 static int
2779 pim_register_send(struct ip *ip, struct vif *vifp,
2780         struct mbuf *m, struct mfc *rt)
2781 {
2782     struct mbuf *mb_copy, *mm;
2783     
2784     if (mrtdebug & DEBUG_PIM)
2785         log(LOG_DEBUG, "pim_register_send: ");
2786     
2787     mb_copy = pim_register_prepare(ip, m);
2788     if (mb_copy == NULL)
2789         return ENOBUFS;
2790     
2791     /*
2792      * Send all the fragments. Note that the mbuf for each fragment
2793      * is freed by the sending machinery.
2794      */
2795     for (mm = mb_copy; mm; mm = mb_copy) {
2796         mb_copy = mm->m_nextpkt;
2797         mm->m_nextpkt = 0;
2798         mm = m_pullup(mm, sizeof(struct ip));
2799         if (mm != NULL) {
2800             ip = mtod(mm, struct ip *);
2801             if ((mrt_api_config & MRT_MFC_RP) &&
2802                 (rt->mfc_rp.s_addr != INADDR_ANY)) {
2803                 pim_register_send_rp(ip, vifp, mm, rt);
2804             } else {
2805                 pim_register_send_upcall(ip, vifp, mm, rt);
2806             }
2807         }
2808     }
2809     
2810     return 0;
2811 }
2812
2813 /*
2814  * Return a copy of the data packet that is ready for PIM Register
2815  * encapsulation.
2816  * XXX: Note that in the returned copy the IP header is a valid one.
2817  */
2818 static struct mbuf *
2819 pim_register_prepare(struct ip *ip, struct mbuf *m)
2820 {
2821     struct mbuf *mb_copy = NULL;
2822     int mtu;
2823     
2824     /* Take care of delayed checksums */
2825     if (m->m_pkthdr.csum_flags & CSUM_DELAY_DATA) {
2826         in_delayed_cksum(m);
2827         m->m_pkthdr.csum_flags &= ~CSUM_DELAY_DATA;
2828     }
2829
2830     /*
2831      * Copy the old packet & pullup its IP header into the
2832      * new mbuf so we can modify it.
2833      */
2834     mb_copy = m_copypacket(m, M_DONTWAIT);
2835     if (mb_copy == NULL)
2836         return NULL;
2837     mb_copy = m_pullup(mb_copy, ip->ip_hl << 2);
2838     if (mb_copy == NULL)
2839         return NULL;
2840     
2841     /* take care of the TTL */
2842     ip = mtod(mb_copy, struct ip *);
2843     --ip->ip_ttl;
2844     
2845     /* Compute the MTU after the PIM Register encapsulation */
2846     mtu = 0xffff - sizeof(pim_encap_iphdr) - sizeof(pim_encap_pimhdr);
2847     
2848     if (ip->ip_len <= mtu) {
2849         /* Turn the IP header into a valid one */
2850         ip->ip_len = htons(ip->ip_len);
2851         ip->ip_off = htons(ip->ip_off);
2852         ip->ip_sum = 0;
2853         ip->ip_sum = in_cksum(mb_copy, ip->ip_hl << 2);
2854     } else {
2855         /* Fragment the packet */
2856         if (ip_fragment(ip, &mb_copy, mtu, 0, CSUM_DELAY_IP) != 0) {
2857             m_freem(mb_copy);
2858             return NULL;
2859         }
2860     }
2861     return mb_copy;
2862 }
2863
2864 /*
2865  * Send an upcall with the data packet to the user-level process.
2866  */
2867 static int
2868 pim_register_send_upcall(struct ip *ip, struct vif *vifp,
2869         struct mbuf *mb_copy, struct mfc *rt)
2870 {
2871     struct mbuf *mb_first;
2872     int len = ntohs(ip->ip_len);
2873     struct igmpmsg *im;
2874     struct sockaddr_in k_igmpsrc = { sizeof k_igmpsrc, AF_INET };
2875     
2876     /*
2877      * Add a new mbuf with an upcall header
2878      */
2879     MGETHDR(mb_first, M_DONTWAIT, MT_HEADER);
2880     if (mb_first == NULL) {
2881         m_freem(mb_copy);
2882         return ENOBUFS;
2883     }
2884     mb_first->m_data += max_linkhdr;
2885     mb_first->m_pkthdr.len = len + sizeof(struct igmpmsg);
2886     mb_first->m_len = sizeof(struct igmpmsg);
2887     mb_first->m_next = mb_copy;
2888     
2889     /* Send message to routing daemon */
2890     im = mtod(mb_first, struct igmpmsg *);
2891     im->im_msgtype      = IGMPMSG_WHOLEPKT;
2892     im->im_mbz          = 0;
2893     im->im_vif          = vifp - viftable;
2894     im->im_src          = ip->ip_src;
2895     im->im_dst          = ip->ip_dst;
2896     
2897     k_igmpsrc.sin_addr  = ip->ip_src;
2898     
2899     mrtstat.mrts_upcalls++;
2900     
2901     if (socket_send(ip_mrouter, mb_first, &k_igmpsrc) < 0) {
2902         if (mrtdebug & DEBUG_PIM)
2903             log(LOG_WARNING,
2904                 "mcast: pim_register_send_upcall: ip_mrouter socket queue full");
2905         ++mrtstat.mrts_upq_sockfull;
2906         return ENOBUFS;
2907     }
2908     
2909     /* Keep statistics */
2910     pimstat.pims_snd_registers_msgs++;
2911     pimstat.pims_snd_registers_bytes += len;
2912     
2913     return 0;
2914 }
2915
2916 /*
2917  * Encapsulate the data packet in PIM Register message and send it to the RP.
2918  */
2919 static int
2920 pim_register_send_rp(struct ip *ip, struct vif *vifp,
2921         struct mbuf *mb_copy, struct mfc *rt)
2922 {
2923     struct mbuf *mb_first;
2924     struct ip *ip_outer;
2925     struct pim_encap_pimhdr *pimhdr;
2926     int len = ntohs(ip->ip_len);
2927     vifi_t vifi = rt->mfc_parent;
2928     
2929     if ((vifi >= numvifs) || (viftable[vifi].v_lcl_addr.s_addr == 0)) {
2930         m_freem(mb_copy);
2931         return EADDRNOTAVAIL;           /* The iif vif is invalid */
2932     }
2933     
2934     /*
2935      * Add a new mbuf with the encapsulating header
2936      */
2937     MGETHDR(mb_first, M_DONTWAIT, MT_HEADER);
2938     if (mb_first == NULL) {
2939         m_freem(mb_copy);
2940         return ENOBUFS;
2941     }
2942     mb_first->m_data += max_linkhdr;
2943     mb_first->m_len = sizeof(pim_encap_iphdr) + sizeof(pim_encap_pimhdr);
2944     mb_first->m_next = mb_copy;
2945
2946     mb_first->m_pkthdr.len = len + mb_first->m_len;
2947     
2948     /*
2949      * Fill in the encapsulating IP and PIM header
2950      */
2951     ip_outer = mtod(mb_first, struct ip *);
2952     *ip_outer = pim_encap_iphdr;
2953 #ifdef RANDOM_IP_ID
2954     ip_outer->ip_id = ip_randomid();
2955 #else
2956     ip_outer->ip_id = htons(ip_id++);
2957 #endif
2958     ip_outer->ip_len = len + sizeof(pim_encap_iphdr) + sizeof(pim_encap_pimhdr);
2959     ip_outer->ip_src = viftable[vifi].v_lcl_addr;
2960     ip_outer->ip_dst = rt->mfc_rp;
2961     /*
2962      * Copy the inner header TOS to the outer header, and take care of the
2963      * IP_DF bit.
2964      */
2965     ip_outer->ip_tos = ip->ip_tos;
2966     if (ntohs(ip->ip_off) & IP_DF)
2967         ip_outer->ip_off |= IP_DF;
2968     pimhdr = (struct pim_encap_pimhdr *)((caddr_t)ip_outer
2969                                          + sizeof(pim_encap_iphdr));
2970     *pimhdr = pim_encap_pimhdr;
2971     /* If the iif crosses a border, set the Border-bit */
2972     if (rt->mfc_flags[vifi] & MRT_MFC_FLAGS_BORDER_VIF & mrt_api_config)
2973         pimhdr->flags |= htonl(PIM_BORDER_REGISTER);
2974     
2975     mb_first->m_data += sizeof(pim_encap_iphdr);
2976     pimhdr->pim.pim_cksum = in_cksum(mb_first, sizeof(pim_encap_pimhdr));
2977     mb_first->m_data -= sizeof(pim_encap_iphdr);
2978     
2979     if (vifp->v_rate_limit == 0)
2980         tbf_send_packet(vifp, mb_first);
2981     else
2982         tbf_control(vifp, mb_first, ip, ip_outer->ip_len);
2983     
2984     /* Keep statistics */
2985     pimstat.pims_snd_registers_msgs++;
2986     pimstat.pims_snd_registers_bytes += len;
2987     
2988     return 0;
2989 }
2990
2991 /*
2992  * PIM-SMv2 and PIM-DM messages processing.
2993  * Receives and verifies the PIM control messages, and passes them
2994  * up to the listening socket, using rip_input().
2995  * The only message with special processing is the PIM_REGISTER message
2996  * (used by PIM-SM): the PIM header is stripped off, and the inner packet
2997  * is passed to if_simloop().
2998  */
2999 void
3000 pim_input(struct mbuf *m, int off, int proto)
3001 {
3002     struct ip *ip = mtod(m, struct ip *);
3003     struct pim *pim;
3004     int minlen;
3005     int datalen = ip->ip_len;
3006     int ip_tos;
3007     int iphlen = off;
3008     
3009     /* Keep statistics */
3010     pimstat.pims_rcv_total_msgs++;
3011     pimstat.pims_rcv_total_bytes += datalen;
3012     
3013     /*
3014      * Validate lengths
3015      */
3016     if (datalen < PIM_MINLEN) {
3017         pimstat.pims_rcv_tooshort++;
3018         log(LOG_ERR, "pim_input: packet size too small %d from %lx\n",
3019             datalen, (u_long)ip->ip_src.s_addr);
3020         m_freem(m);
3021         return;
3022     }
3023     
3024     /*
3025      * If the packet is at least as big as a REGISTER, go agead
3026      * and grab the PIM REGISTER header size, to avoid another
3027      * possible m_pullup() later.
3028      * 
3029      * PIM_MINLEN       == pimhdr + u_int32_t == 4 + 4 = 8
3030      * PIM_REG_MINLEN   == pimhdr + reghdr + encap_iphdr == 4 + 4 + 20 = 28
3031      */
3032     minlen = iphlen + (datalen >= PIM_REG_MINLEN ? PIM_REG_MINLEN : PIM_MINLEN);
3033     /*
3034      * Get the IP and PIM headers in contiguous memory, and
3035      * possibly the PIM REGISTER header.
3036      */
3037     if ((m->m_flags & M_EXT || m->m_len < minlen) &&
3038         (m = m_pullup(m, minlen)) == 0) {
3039         log(LOG_ERR, "pim_input: m_pullup failure\n");
3040         return;
3041     }
3042     /* m_pullup() may have given us a new mbuf so reset ip. */
3043     ip = mtod(m, struct ip *);
3044     ip_tos = ip->ip_tos;
3045     
3046     /* adjust mbuf to point to the PIM header */
3047     m->m_data += iphlen;
3048     m->m_len  -= iphlen;
3049     pim = mtod(m, struct pim *);
3050     
3051     /*
3052      * Validate checksum. If PIM REGISTER, exclude the data packet.
3053      *
3054      * XXX: some older PIMv2 implementations don't make this distinction,
3055      * so for compatibility reason perform the checksum over part of the
3056      * message, and if error, then over the whole message.
3057      */
3058     if (PIM_VT_T(pim->pim_vt) == PIM_REGISTER && in_cksum(m, PIM_MINLEN) == 0) {
3059         /* do nothing, checksum okay */
3060     } else if (in_cksum(m, datalen)) {
3061         pimstat.pims_rcv_badsum++;
3062         if (mrtdebug & DEBUG_PIM)
3063             log(LOG_DEBUG, "pim_input: invalid checksum");
3064         m_freem(m);
3065         return;
3066     }
3067
3068     /* PIM version check */
3069     if (PIM_VT_V(pim->pim_vt) < PIM_VERSION) {
3070         pimstat.pims_rcv_badversion++;
3071         log(LOG_ERR, "pim_input: incorrect version %d, expecting %d\n",
3072             PIM_VT_V(pim->pim_vt), PIM_VERSION);
3073         m_freem(m);
3074         return;
3075     }
3076     
3077     /* restore mbuf back to the outer IP */
3078     m->m_data -= iphlen;
3079     m->m_len  += iphlen;
3080     
3081     if (PIM_VT_T(pim->pim_vt) == PIM_REGISTER) {
3082         /*
3083          * Since this is a REGISTER, we'll make a copy of the register
3084          * headers ip + pim + u_int32 + encap_ip, to be passed up to the
3085          * routing daemon.
3086          */
3087         struct sockaddr_in dst = { sizeof(dst), AF_INET };
3088         struct mbuf *mcp;
3089         struct ip *encap_ip;
3090         u_int32_t *reghdr;
3091         
3092         if ((reg_vif_num >= numvifs) || (reg_vif_num == VIFI_INVALID)) {
3093             if (mrtdebug & DEBUG_PIM)
3094                 log(LOG_DEBUG,
3095                     "pim_input: register vif not set: %d\n", reg_vif_num);
3096             m_freem(m);
3097             return;
3098         }
3099         
3100         /*
3101          * Validate length
3102          */
3103         if (datalen < PIM_REG_MINLEN) {
3104             pimstat.pims_rcv_tooshort++;
3105             pimstat.pims_rcv_badregisters++;
3106             log(LOG_ERR,
3107                 "pim_input: register packet size too small %d from %lx\n",
3108                 datalen, (u_long)ip->ip_src.s_addr);
3109             m_freem(m);
3110             return;
3111         }
3112         
3113         reghdr = (u_int32_t *)(pim + 1);
3114         encap_ip = (struct ip *)(reghdr + 1);
3115         
3116         if (mrtdebug & DEBUG_PIM) {
3117             log(LOG_DEBUG,
3118                 "pim_input[register], encap_ip: %lx -> %lx, encap_ip len %d\n",
3119                 (u_long)ntohl(encap_ip->ip_src.s_addr),
3120                 (u_long)ntohl(encap_ip->ip_dst.s_addr),
3121                 ntohs(encap_ip->ip_len));
3122         }
3123         
3124         /* verify the version number of the inner packet */
3125         if (encap_ip->ip_v != IPVERSION) {
3126             pimstat.pims_rcv_badregisters++;
3127             if (mrtdebug & DEBUG_PIM) {
3128                 log(LOG_DEBUG, "pim_input: invalid IP version (%d) "
3129                     "of the inner packet\n", encap_ip->ip_v);
3130             }
3131             m_freem(m);
3132             return;
3133         }
3134         
3135         /* verify the inner packet is destined to a mcast group */
3136         if (!IN_MULTICAST(ntohl(encap_ip->ip_dst.s_addr))) {
3137             pimstat.pims_rcv_badregisters++;
3138             if (mrtdebug & DEBUG_PIM)
3139                 log(LOG_DEBUG,
3140                     "pim_input: inner packet of register is not "
3141                     "multicast %lx\n",
3142                     (u_long)ntohl(encap_ip->ip_dst.s_addr));
3143             m_freem(m);
3144             return;
3145         }
3146         
3147         /*
3148          * Copy the TOS from the outer IP header to the inner IP header.
3149          */
3150         if (encap_ip->ip_tos != ip_tos) {
3151             /* Outer TOS -> inner TOS */
3152             encap_ip->ip_tos = ip_tos;
3153             /* Recompute the inner header checksum. Sigh... */
3154             
3155             /* adjust mbuf to point to the inner IP header */
3156             m->m_data += (iphlen + PIM_MINLEN);
3157             m->m_len  -= (iphlen + PIM_MINLEN);
3158             
3159             encap_ip->ip_sum = 0;
3160             encap_ip->ip_sum = in_cksum(m, encap_ip->ip_hl << 2);
3161             
3162             /* restore mbuf to point back to the outer IP header */
3163             m->m_data -= (iphlen + PIM_MINLEN);
3164             m->m_len  += (iphlen + PIM_MINLEN);
3165         }
3166         
3167         /* If a NULL_REGISTER, pass it to the daemon */
3168         if ((ntohl(*reghdr) & PIM_NULL_REGISTER))
3169             goto pim_input_to_daemon;
3170         
3171         /*
3172          * Decapsulate the inner IP packet and loopback to forward it
3173          * as a normal multicast packet. Also, make a copy of the 
3174          *     outer_iphdr + pimhdr + reghdr + encap_iphdr
3175          * to pass to the daemon later, so it can take the appropriate
3176          * actions (e.g., send back PIM_REGISTER_STOP).
3177          * XXX: here m->m_data points to the outer IP header.
3178          */
3179         mcp = m_copy(m, 0, iphlen + PIM_REG_MINLEN);
3180         if (mcp == NULL) {
3181             log(LOG_ERR,
3182                 "pim_input: pim register: could not copy register head\n");
3183             m_freem(m);
3184             return;
3185         }
3186         
3187         /* Keep statistics */
3188         /* XXX: registers_bytes include only the encap. mcast pkt */
3189         pimstat.pims_rcv_registers_msgs++;
3190         pimstat.pims_rcv_registers_bytes += ntohs(encap_ip->ip_len);
3191         
3192         /*
3193          * forward the inner ip packet; point m_data at the inner ip.
3194          */
3195         m_adj(m, iphlen + PIM_MINLEN);
3196         
3197         if (mrtdebug & DEBUG_PIM) {
3198             log(LOG_DEBUG,
3199                 "pim_input: forwarding decapsulated register: "
3200                 "src %lx, dst %lx, vif %d\n",
3201                 (u_long)ntohl(encap_ip->ip_src.s_addr),
3202                 (u_long)ntohl(encap_ip->ip_dst.s_addr),
3203                 reg_vif_num);
3204         }
3205         if_simloop(viftable[reg_vif_num].v_ifp, m, dst.sin_family, 0);
3206         
3207         /* prepare the register head to send to the mrouting daemon */
3208         m = mcp;
3209     }
3210
3211 pim_input_to_daemon:    
3212     /*
3213      * Pass the PIM message up to the daemon; if it is a Register message,
3214      * pass the 'head' only up to the daemon. This includes the
3215      * outer IP header, PIM header, PIM-Register header and the
3216      * inner IP header.
3217      * XXX: the outer IP header pkt size of a Register is not adjust to
3218      * reflect the fact that the inner multicast data is truncated.
3219      */
3220     rip_input(m, iphlen, proto);
3221
3222     return;
3223 }
3224 #endif /* PIM */
3225
3226 static int
3227 ip_mroute_modevent(module_t mod, int type, void *unused)
3228 {
3229     int s;
3230
3231     switch (type) {
3232     case MOD_LOAD:
3233         s = splnet();
3234         /* XXX Protect against multiple loading */
3235         ip_mcast_src = X_ip_mcast_src;
3236         ip_mforward = X_ip_mforward;
3237         ip_mrouter_done = X_ip_mrouter_done;
3238         ip_mrouter_get = X_ip_mrouter_get;
3239         ip_mrouter_set = X_ip_mrouter_set;
3240         ip_rsvp_force_done = X_ip_rsvp_force_done;
3241         ip_rsvp_vif = X_ip_rsvp_vif;
3242         ipip_input = X_ipip_input;
3243         legal_vif_num = X_legal_vif_num;
3244         mrt_ioctl = X_mrt_ioctl;
3245         rsvp_input_p = X_rsvp_input;
3246         splx(s);
3247         break;
3248
3249     case MOD_UNLOAD:
3250         if (ip_mrouter)
3251             return EINVAL;
3252
3253         s = splnet();
3254         ip_mcast_src = NULL;
3255         ip_mforward = NULL;
3256         ip_mrouter_done = NULL;
3257         ip_mrouter_get = NULL;
3258         ip_mrouter_set = NULL;
3259         ip_rsvp_force_done = NULL;
3260         ip_rsvp_vif = NULL;
3261         ipip_input = NULL;
3262         legal_vif_num = NULL;
3263         mrt_ioctl = NULL;
3264         rsvp_input_p = NULL;
3265         splx(s);
3266         break;
3267     }
3268     return 0;
3269 }
3270
3271 static moduledata_t ip_mroutemod = {
3272     "ip_mroute",
3273     ip_mroute_modevent,
3274     0
3275 };
3276 DECLARE_MODULE(ip_mroute, ip_mroutemod, SI_SUB_PSEUDO, SI_ORDER_ANY);