2 * IP multicast routing support for mrouted 3.6/3.8
4 * (c) 1995 Alan Cox, <alan@redhat.com>
5 * Linux Consultancy and Custom Driver Development
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version
10 * 2 of the License, or (at your option) any later version.
12 * Version: $Id: ipmr.c,v 1.65 2001/10/31 21:55:54 davem Exp $
15 * Michael Chastain : Incorrect size of copying.
16 * Alan Cox : Added the cache manager code
17 * Alan Cox : Fixed the clone/copy bug and device race.
18 * Mike McLagan : Routing by source
19 * Malcolm Beattie : Buffer handling fixes.
20 * Alexey Kuznetsov : Double buffer free and other fixes.
21 * SVR Anand : Fixed several multicast bugs and problems.
22 * Alexey Kuznetsov : Status, optimisations and more.
23 * Brad Parker : Better behaviour on mrouted upcall
25 * Carlos Picoto : PIMv1 Support
26 * Pavlin Ivanov Radoslavov: PIMv2 Registers must checksum only PIM header
27 * Relax this requrement to work with older peers.
31 #include <linux/config.h>
32 #include <asm/system.h>
33 #include <asm/uaccess.h>
34 #include <linux/types.h>
35 #include <linux/sched.h>
36 #include <linux/errno.h>
37 #include <linux/timer.h>
39 #include <linux/kernel.h>
40 #include <linux/fcntl.h>
41 #include <linux/stat.h>
42 #include <linux/socket.h>
44 #include <linux/inet.h>
45 #include <linux/netdevice.h>
46 #include <linux/inetdevice.h>
47 #include <linux/igmp.h>
48 #include <linux/proc_fs.h>
49 #include <linux/seq_file.h>
50 #include <linux/mroute.h>
51 #include <linux/init.h>
53 #include <net/protocol.h>
54 #include <linux/skbuff.h>
59 #include <linux/notifier.h>
60 #include <linux/if_arp.h>
61 #include <linux/netfilter_ipv4.h>
63 #include <net/checksum.h>
65 #if defined(CONFIG_IP_PIMSM_V1) || defined(CONFIG_IP_PIMSM_V2)
66 #define CONFIG_IP_PIMSM 1
69 static struct sock *mroute_socket;
72 /* Big lock, protecting vif table, mrt cache and mroute socket state.
73 Note that the changes are semaphored via rtnl_lock.
76 static DEFINE_RWLOCK(mrt_lock);
79 * Multicast router control variables
82 static struct vif_device vif_table[MAXVIFS]; /* Devices */
85 #define VIF_EXISTS(idx) (vif_table[idx].dev != NULL)
87 static int mroute_do_assert; /* Set in PIM assert */
88 static int mroute_do_pim;
90 static struct mfc_cache *mfc_cache_array[MFC_LINES]; /* Forwarding cache */
92 static struct mfc_cache *mfc_unres_queue; /* Queue of unresolved entries */
93 static atomic_t cache_resolve_queue_len; /* Size of unresolved */
95 /* Special spinlock for queue of unresolved entries */
96 static DEFINE_SPINLOCK(mfc_unres_lock);
98 /* We return to original Alan's scheme. Hash table of resolved
99 entries is changed only in process context and protected
100 with weak lock mrt_lock. Queue of unresolved entries is protected
101 with strong spinlock mfc_unres_lock.
103 In this case data path is free of exclusive locks at all.
106 static kmem_cache_t *mrt_cachep;
108 static int ip_mr_forward(struct sk_buff *skb, struct mfc_cache *cache, int local);
109 static int ipmr_cache_report(struct sk_buff *pkt, vifi_t vifi, int assert);
110 static int ipmr_fill_mroute(struct sk_buff *skb, struct mfc_cache *c, struct rtmsg *rtm);
112 #ifdef CONFIG_IP_PIMSM_V2
113 static struct net_protocol pim_protocol;
116 static struct timer_list ipmr_expire_timer;
118 /* Service routines creating virtual interfaces: DVMRP tunnels and PIMREG */
121 struct net_device *ipmr_new_tunnel(struct vifctl *v)
123 struct net_device *dev;
125 dev = __dev_get_by_name("tunl0");
131 struct ip_tunnel_parm p;
132 struct in_device *in_dev;
134 memset(&p, 0, sizeof(p));
135 p.iph.daddr = v->vifc_rmt_addr.s_addr;
136 p.iph.saddr = v->vifc_lcl_addr.s_addr;
139 p.iph.protocol = IPPROTO_IPIP;
140 sprintf(p.name, "dvmrp%d", v->vifc_vifi);
141 ifr.ifr_ifru.ifru_data = (void*)&p;
143 oldfs = get_fs(); set_fs(KERNEL_DS);
144 err = dev->do_ioctl(dev, &ifr, SIOCADDTUNNEL);
149 if (err == 0 && (dev = __dev_get_by_name(p.name)) != NULL) {
150 dev->flags |= IFF_MULTICAST;
152 in_dev = __in_dev_get(dev);
153 if (in_dev == NULL && (in_dev = inetdev_init(dev)) == NULL)
155 in_dev->cnf.rp_filter = 0;
164 /* allow the register to be completed before unregistering. */
168 unregister_netdevice(dev);
172 #ifdef CONFIG_IP_PIMSM
174 static int reg_vif_num = -1;
176 static int reg_vif_xmit(struct sk_buff *skb, struct net_device *dev)
178 read_lock(&mrt_lock);
179 ((struct net_device_stats*)dev->priv)->tx_bytes += skb->len;
180 ((struct net_device_stats*)dev->priv)->tx_packets++;
181 ipmr_cache_report(skb, reg_vif_num, IGMPMSG_WHOLEPKT);
182 read_unlock(&mrt_lock);
187 static struct net_device_stats *reg_vif_get_stats(struct net_device *dev)
189 return (struct net_device_stats*)dev->priv;
192 static void reg_vif_setup(struct net_device *dev)
194 dev->type = ARPHRD_PIMREG;
195 dev->mtu = 1500 - sizeof(struct iphdr) - 8;
196 dev->flags = IFF_NOARP;
197 dev->hard_start_xmit = reg_vif_xmit;
198 dev->get_stats = reg_vif_get_stats;
199 dev->destructor = free_netdev;
202 static struct net_device *ipmr_reg_vif(void)
204 struct net_device *dev;
205 struct in_device *in_dev;
207 dev = alloc_netdev(sizeof(struct net_device_stats), "pimreg",
213 if (register_netdevice(dev)) {
219 if ((in_dev = inetdev_init(dev)) == NULL)
222 in_dev->cnf.rp_filter = 0;
230 /* allow the register to be completed before unregistering. */
234 unregister_netdevice(dev);
243 static int vif_delete(int vifi)
245 struct vif_device *v;
246 struct net_device *dev;
247 struct in_device *in_dev;
249 if (vifi < 0 || vifi >= maxvif)
250 return -EADDRNOTAVAIL;
252 v = &vif_table[vifi];
254 write_lock_bh(&mrt_lock);
259 write_unlock_bh(&mrt_lock);
260 return -EADDRNOTAVAIL;
263 #ifdef CONFIG_IP_PIMSM
264 if (vifi == reg_vif_num)
268 if (vifi+1 == maxvif) {
270 for (tmp=vifi-1; tmp>=0; tmp--) {
277 write_unlock_bh(&mrt_lock);
279 dev_set_allmulti(dev, -1);
281 if ((in_dev = __in_dev_get(dev)) != NULL) {
282 in_dev->cnf.mc_forwarding--;
283 ip_rt_multicast_event(in_dev);
286 if (v->flags&(VIFF_TUNNEL|VIFF_REGISTER))
287 unregister_netdevice(dev);
293 /* Destroy an unresolved cache entry, killing queued skbs
294 and reporting error to netlink readers.
297 static void ipmr_destroy_unres(struct mfc_cache *c)
302 atomic_dec(&cache_resolve_queue_len);
304 while((skb=skb_dequeue(&c->mfc_un.unres.unresolved))) {
305 if (skb->nh.iph->version == 0) {
306 struct nlmsghdr *nlh = (struct nlmsghdr *)skb_pull(skb, sizeof(struct iphdr));
307 nlh->nlmsg_type = NLMSG_ERROR;
308 nlh->nlmsg_len = NLMSG_LENGTH(sizeof(struct nlmsgerr));
309 skb_trim(skb, nlh->nlmsg_len);
311 e->error = -ETIMEDOUT;
312 memset(&e->msg, 0, sizeof(e->msg));
313 netlink_unicast(rtnl, skb, NETLINK_CB(skb).dst_pid, MSG_DONTWAIT);
318 kmem_cache_free(mrt_cachep, c);
322 /* Single timer process for all the unresolved queue. */
324 static void ipmr_expire_process(unsigned long dummy)
327 unsigned long expires;
328 struct mfc_cache *c, **cp;
330 if (!spin_trylock(&mfc_unres_lock)) {
331 mod_timer(&ipmr_expire_timer, jiffies+HZ/10);
335 if (atomic_read(&cache_resolve_queue_len) == 0)
340 cp = &mfc_unres_queue;
342 while ((c=*cp) != NULL) {
343 if (time_after(c->mfc_un.unres.expires, now)) {
344 unsigned long interval = c->mfc_un.unres.expires - now;
345 if (interval < expires)
353 ipmr_destroy_unres(c);
356 if (atomic_read(&cache_resolve_queue_len))
357 mod_timer(&ipmr_expire_timer, jiffies + expires);
360 spin_unlock(&mfc_unres_lock);
363 /* Fill oifs list. It is called under write locked mrt_lock. */
365 static void ipmr_update_threshoulds(struct mfc_cache *cache, unsigned char *ttls)
369 cache->mfc_un.res.minvif = MAXVIFS;
370 cache->mfc_un.res.maxvif = 0;
371 memset(cache->mfc_un.res.ttls, 255, MAXVIFS);
373 for (vifi=0; vifi<maxvif; vifi++) {
374 if (VIF_EXISTS(vifi) && ttls[vifi] && ttls[vifi] < 255) {
375 cache->mfc_un.res.ttls[vifi] = ttls[vifi];
376 if (cache->mfc_un.res.minvif > vifi)
377 cache->mfc_un.res.minvif = vifi;
378 if (cache->mfc_un.res.maxvif <= vifi)
379 cache->mfc_un.res.maxvif = vifi + 1;
384 static int vif_add(struct vifctl *vifc, int mrtsock)
386 int vifi = vifc->vifc_vifi;
387 struct vif_device *v = &vif_table[vifi];
388 struct net_device *dev;
389 struct in_device *in_dev;
392 if (VIF_EXISTS(vifi))
395 switch (vifc->vifc_flags) {
396 #ifdef CONFIG_IP_PIMSM
399 * Special Purpose VIF in PIM
400 * All the packets will be sent to the daemon
402 if (reg_vif_num >= 0)
404 dev = ipmr_reg_vif();
410 dev = ipmr_new_tunnel(vifc);
415 dev=ip_dev_find(vifc->vifc_lcl_addr.s_addr);
417 return -EADDRNOTAVAIL;
424 if ((in_dev = __in_dev_get(dev)) == NULL)
425 return -EADDRNOTAVAIL;
426 in_dev->cnf.mc_forwarding++;
427 dev_set_allmulti(dev, +1);
428 ip_rt_multicast_event(in_dev);
431 * Fill in the VIF structures
433 v->rate_limit=vifc->vifc_rate_limit;
434 v->local=vifc->vifc_lcl_addr.s_addr;
435 v->remote=vifc->vifc_rmt_addr.s_addr;
436 v->flags=vifc->vifc_flags;
438 v->flags |= VIFF_STATIC;
439 v->threshold=vifc->vifc_threshold;
444 v->link = dev->ifindex;
445 if (v->flags&(VIFF_TUNNEL|VIFF_REGISTER))
446 v->link = dev->iflink;
448 /* And finish update writing critical data */
449 write_lock_bh(&mrt_lock);
452 #ifdef CONFIG_IP_PIMSM
453 if (v->flags&VIFF_REGISTER)
458 write_unlock_bh(&mrt_lock);
462 static struct mfc_cache *ipmr_cache_find(__u32 origin, __u32 mcastgrp)
464 int line=MFC_HASH(mcastgrp,origin);
467 for (c=mfc_cache_array[line]; c; c = c->next) {
468 if (c->mfc_origin==origin && c->mfc_mcastgrp==mcastgrp)
475 * Allocate a multicast cache entry
477 static struct mfc_cache *ipmr_cache_alloc(void)
479 struct mfc_cache *c=kmem_cache_alloc(mrt_cachep, GFP_KERNEL);
482 memset(c, 0, sizeof(*c));
483 c->mfc_un.res.minvif = MAXVIFS;
487 static struct mfc_cache *ipmr_cache_alloc_unres(void)
489 struct mfc_cache *c=kmem_cache_alloc(mrt_cachep, GFP_ATOMIC);
492 memset(c, 0, sizeof(*c));
493 skb_queue_head_init(&c->mfc_un.unres.unresolved);
494 c->mfc_un.unres.expires = jiffies + 10*HZ;
499 * A cache entry has gone into a resolved state from queued
502 static void ipmr_cache_resolve(struct mfc_cache *uc, struct mfc_cache *c)
508 * Play the pending entries through our router
511 while((skb=__skb_dequeue(&uc->mfc_un.unres.unresolved))) {
512 if (skb->nh.iph->version == 0) {
514 struct nlmsghdr *nlh = (struct nlmsghdr *)skb_pull(skb, sizeof(struct iphdr));
516 if (ipmr_fill_mroute(skb, c, NLMSG_DATA(nlh)) > 0) {
517 nlh->nlmsg_len = skb->tail - (u8*)nlh;
519 nlh->nlmsg_type = NLMSG_ERROR;
520 nlh->nlmsg_len = NLMSG_LENGTH(sizeof(struct nlmsgerr));
521 skb_trim(skb, nlh->nlmsg_len);
523 e->error = -EMSGSIZE;
524 memset(&e->msg, 0, sizeof(e->msg));
526 err = netlink_unicast(rtnl, skb, NETLINK_CB(skb).dst_pid, MSG_DONTWAIT);
528 ip_mr_forward(skb, c, 0);
533 * Bounce a cache query up to mrouted. We could use netlink for this but mrouted
534 * expects the following bizarre scheme.
536 * Called under mrt_lock.
539 static int ipmr_cache_report(struct sk_buff *pkt, vifi_t vifi, int assert)
542 int ihl = pkt->nh.iph->ihl<<2;
543 struct igmphdr *igmp;
547 #ifdef CONFIG_IP_PIMSM
548 if (assert == IGMPMSG_WHOLEPKT)
549 skb = skb_realloc_headroom(pkt, sizeof(struct iphdr));
552 skb = alloc_skb(128, GFP_ATOMIC);
557 #ifdef CONFIG_IP_PIMSM
558 if (assert == IGMPMSG_WHOLEPKT) {
559 /* Ugly, but we have no choice with this interface.
560 Duplicate old header, fix ihl, length etc.
561 And all this only to mangle msg->im_msgtype and
562 to set msg->im_mbz to "mbz" :-)
564 msg = (struct igmpmsg*)skb_push(skb, sizeof(struct iphdr));
565 skb->nh.raw = skb->h.raw = (u8*)msg;
566 memcpy(msg, pkt->nh.raw, sizeof(struct iphdr));
567 msg->im_msgtype = IGMPMSG_WHOLEPKT;
569 msg->im_vif = reg_vif_num;
570 skb->nh.iph->ihl = sizeof(struct iphdr) >> 2;
571 skb->nh.iph->tot_len = htons(ntohs(pkt->nh.iph->tot_len) + sizeof(struct iphdr));
580 skb->nh.iph = (struct iphdr *)skb_put(skb, ihl);
581 memcpy(skb->data,pkt->data,ihl);
582 skb->nh.iph->protocol = 0; /* Flag to the kernel this is a route add */
583 msg = (struct igmpmsg*)skb->nh.iph;
585 skb->dst = dst_clone(pkt->dst);
591 igmp=(struct igmphdr *)skb_put(skb,sizeof(struct igmphdr));
593 msg->im_msgtype = assert;
595 skb->nh.iph->tot_len=htons(skb->len); /* Fix the length */
596 skb->h.raw = skb->nh.raw;
599 if (mroute_socket == NULL) {
607 if ((ret=sock_queue_rcv_skb(mroute_socket,skb))<0) {
609 printk(KERN_WARNING "mroute: pending queue full, dropping entries.\n");
617 * Queue a packet for resolution. It gets locked cache entry!
621 ipmr_cache_unresolved(vifi_t vifi, struct sk_buff *skb)
626 spin_lock_bh(&mfc_unres_lock);
627 for (c=mfc_unres_queue; c; c=c->next) {
628 if (c->mfc_mcastgrp == skb->nh.iph->daddr &&
629 c->mfc_origin == skb->nh.iph->saddr)
635 * Create a new entry if allowable
638 if (atomic_read(&cache_resolve_queue_len)>=10 ||
639 (c=ipmr_cache_alloc_unres())==NULL) {
640 spin_unlock_bh(&mfc_unres_lock);
647 * Fill in the new cache entry
650 c->mfc_origin=skb->nh.iph->saddr;
651 c->mfc_mcastgrp=skb->nh.iph->daddr;
654 * Reflect first query at mrouted.
656 if ((err = ipmr_cache_report(skb, vifi, IGMPMSG_NOCACHE))<0) {
657 /* If the report failed throw the cache entry
660 spin_unlock_bh(&mfc_unres_lock);
662 kmem_cache_free(mrt_cachep, c);
667 atomic_inc(&cache_resolve_queue_len);
668 c->next = mfc_unres_queue;
671 mod_timer(&ipmr_expire_timer, c->mfc_un.unres.expires);
675 * See if we can append the packet
677 if (c->mfc_un.unres.unresolved.qlen>3) {
681 skb_queue_tail(&c->mfc_un.unres.unresolved,skb);
685 spin_unlock_bh(&mfc_unres_lock);
690 * MFC cache manipulation by user space mroute daemon
693 static int ipmr_mfc_delete(struct mfcctl *mfc)
696 struct mfc_cache *c, **cp;
698 line=MFC_HASH(mfc->mfcc_mcastgrp.s_addr, mfc->mfcc_origin.s_addr);
700 for (cp=&mfc_cache_array[line]; (c=*cp) != NULL; cp = &c->next) {
701 if (c->mfc_origin == mfc->mfcc_origin.s_addr &&
702 c->mfc_mcastgrp == mfc->mfcc_mcastgrp.s_addr) {
703 write_lock_bh(&mrt_lock);
705 write_unlock_bh(&mrt_lock);
707 kmem_cache_free(mrt_cachep, c);
714 static int ipmr_mfc_add(struct mfcctl *mfc, int mrtsock)
717 struct mfc_cache *uc, *c, **cp;
719 line=MFC_HASH(mfc->mfcc_mcastgrp.s_addr, mfc->mfcc_origin.s_addr);
721 for (cp=&mfc_cache_array[line]; (c=*cp) != NULL; cp = &c->next) {
722 if (c->mfc_origin == mfc->mfcc_origin.s_addr &&
723 c->mfc_mcastgrp == mfc->mfcc_mcastgrp.s_addr)
728 write_lock_bh(&mrt_lock);
729 c->mfc_parent = mfc->mfcc_parent;
730 ipmr_update_threshoulds(c, mfc->mfcc_ttls);
732 c->mfc_flags |= MFC_STATIC;
733 write_unlock_bh(&mrt_lock);
737 if(!MULTICAST(mfc->mfcc_mcastgrp.s_addr))
740 c=ipmr_cache_alloc();
744 c->mfc_origin=mfc->mfcc_origin.s_addr;
745 c->mfc_mcastgrp=mfc->mfcc_mcastgrp.s_addr;
746 c->mfc_parent=mfc->mfcc_parent;
747 ipmr_update_threshoulds(c, mfc->mfcc_ttls);
749 c->mfc_flags |= MFC_STATIC;
751 write_lock_bh(&mrt_lock);
752 c->next = mfc_cache_array[line];
753 mfc_cache_array[line] = c;
754 write_unlock_bh(&mrt_lock);
757 * Check to see if we resolved a queued list. If so we
758 * need to send on the frames and tidy up.
760 spin_lock_bh(&mfc_unres_lock);
761 for (cp = &mfc_unres_queue; (uc=*cp) != NULL;
763 if (uc->mfc_origin == c->mfc_origin &&
764 uc->mfc_mcastgrp == c->mfc_mcastgrp) {
766 if (atomic_dec_and_test(&cache_resolve_queue_len))
767 del_timer(&ipmr_expire_timer);
771 spin_unlock_bh(&mfc_unres_lock);
774 ipmr_cache_resolve(uc, c);
775 kmem_cache_free(mrt_cachep, uc);
781 * Close the multicast socket, and clear the vif tables etc
784 static void mroute_clean_tables(struct sock *sk)
789 * Shut down all active vif entries
791 for(i=0; i<maxvif; i++) {
792 if (!(vif_table[i].flags&VIFF_STATIC))
799 for (i=0;i<MFC_LINES;i++) {
800 struct mfc_cache *c, **cp;
802 cp = &mfc_cache_array[i];
803 while ((c = *cp) != NULL) {
804 if (c->mfc_flags&MFC_STATIC) {
808 write_lock_bh(&mrt_lock);
810 write_unlock_bh(&mrt_lock);
812 kmem_cache_free(mrt_cachep, c);
816 if (atomic_read(&cache_resolve_queue_len) != 0) {
819 spin_lock_bh(&mfc_unres_lock);
820 while (mfc_unres_queue != NULL) {
822 mfc_unres_queue = c->next;
823 spin_unlock_bh(&mfc_unres_lock);
825 ipmr_destroy_unres(c);
827 spin_lock_bh(&mfc_unres_lock);
829 spin_unlock_bh(&mfc_unres_lock);
833 static void mrtsock_destruct(struct sock *sk)
836 if (sk == mroute_socket) {
837 ipv4_devconf.mc_forwarding--;
839 write_lock_bh(&mrt_lock);
841 write_unlock_bh(&mrt_lock);
843 mroute_clean_tables(sk);
849 * Socket options and virtual interface manipulation. The whole
850 * virtual interface system is a complete heap, but unfortunately
851 * that's how BSD mrouted happens to think. Maybe one day with a proper
852 * MOSPF/PIM router set up we can clean this up.
855 int ip_mroute_setsockopt(struct sock *sk,int optname,char __user *optval,int optlen)
861 if(optname!=MRT_INIT)
863 if(sk!=mroute_socket && !capable(CAP_NET_ADMIN))
870 if (sk->sk_type != SOCK_RAW ||
871 inet_sk(sk)->num != IPPROTO_IGMP)
873 if(optlen!=sizeof(int))
882 ret = ip_ra_control(sk, 1, mrtsock_destruct);
884 write_lock_bh(&mrt_lock);
886 write_unlock_bh(&mrt_lock);
888 ipv4_devconf.mc_forwarding++;
893 if (sk!=mroute_socket)
895 return ip_ra_control(sk, 0, NULL);
898 if(optlen!=sizeof(vif))
900 if (copy_from_user(&vif,optval,sizeof(vif)))
902 if(vif.vifc_vifi >= MAXVIFS)
905 if (optname==MRT_ADD_VIF) {
906 ret = vif_add(&vif, sk==mroute_socket);
908 ret = vif_delete(vif.vifc_vifi);
914 * Manipulate the forwarding caches. These live
915 * in a sort of kernel/user symbiosis.
919 if(optlen!=sizeof(mfc))
921 if (copy_from_user(&mfc,optval, sizeof(mfc)))
924 if (optname==MRT_DEL_MFC)
925 ret = ipmr_mfc_delete(&mfc);
927 ret = ipmr_mfc_add(&mfc, sk==mroute_socket);
931 * Control PIM assert.
936 if(get_user(v,(int __user *)optval))
938 mroute_do_assert=(v)?1:0;
941 #ifdef CONFIG_IP_PIMSM
945 if(get_user(v,(int __user *)optval))
950 if (v != mroute_do_pim) {
952 mroute_do_assert = v;
953 #ifdef CONFIG_IP_PIMSM_V2
955 ret = inet_add_protocol(&pim_protocol,
958 ret = inet_del_protocol(&pim_protocol,
969 * Spurious command, or MRT_VERSION which you cannot
978 * Getsock opt support for the multicast routing system.
981 int ip_mroute_getsockopt(struct sock *sk,int optname,char __user *optval,int __user *optlen)
986 if(optname!=MRT_VERSION &&
987 #ifdef CONFIG_IP_PIMSM
993 if (get_user(olr, optlen))
996 olr = min_t(unsigned int, olr, sizeof(int));
1000 if(put_user(olr,optlen))
1002 if(optname==MRT_VERSION)
1004 #ifdef CONFIG_IP_PIMSM
1005 else if(optname==MRT_PIM)
1009 val=mroute_do_assert;
1010 if(copy_to_user(optval,&val,olr))
1016 * The IP multicast ioctl support routines.
1019 int ipmr_ioctl(struct sock *sk, int cmd, void __user *arg)
1021 struct sioc_sg_req sr;
1022 struct sioc_vif_req vr;
1023 struct vif_device *vif;
1024 struct mfc_cache *c;
1029 if (copy_from_user(&vr,arg,sizeof(vr)))
1033 read_lock(&mrt_lock);
1034 vif=&vif_table[vr.vifi];
1035 if(VIF_EXISTS(vr.vifi)) {
1036 vr.icount=vif->pkt_in;
1037 vr.ocount=vif->pkt_out;
1038 vr.ibytes=vif->bytes_in;
1039 vr.obytes=vif->bytes_out;
1040 read_unlock(&mrt_lock);
1042 if (copy_to_user(arg,&vr,sizeof(vr)))
1046 read_unlock(&mrt_lock);
1047 return -EADDRNOTAVAIL;
1049 if (copy_from_user(&sr,arg,sizeof(sr)))
1052 read_lock(&mrt_lock);
1053 c = ipmr_cache_find(sr.src.s_addr, sr.grp.s_addr);
1055 sr.pktcnt = c->mfc_un.res.pkt;
1056 sr.bytecnt = c->mfc_un.res.bytes;
1057 sr.wrong_if = c->mfc_un.res.wrong_if;
1058 read_unlock(&mrt_lock);
1060 if (copy_to_user(arg,&sr,sizeof(sr)))
1064 read_unlock(&mrt_lock);
1065 return -EADDRNOTAVAIL;
1067 return -ENOIOCTLCMD;
1072 static int ipmr_device_event(struct notifier_block *this, unsigned long event, void *ptr)
1074 struct vif_device *v;
1076 if (event != NETDEV_UNREGISTER)
1079 for(ct=0;ct<maxvif;ct++,v++) {
1087 static struct notifier_block ip_mr_notifier={
1088 .notifier_call = ipmr_device_event,
1092 * Encapsulate a packet by attaching a valid IPIP header to it.
1093 * This avoids tunnel drivers and other mess and gives us the speed so
1094 * important for multicast video.
1097 static void ip_encap(struct sk_buff *skb, u32 saddr, u32 daddr)
1099 struct iphdr *iph = (struct iphdr *)skb_push(skb,sizeof(struct iphdr));
1102 iph->tos = skb->nh.iph->tos;
1103 iph->ttl = skb->nh.iph->ttl;
1107 iph->protocol = IPPROTO_IPIP;
1109 iph->tot_len = htons(skb->len);
1110 ip_select_ident(iph, skb->dst, NULL);
1113 skb->h.ipiph = skb->nh.iph;
1115 memset(&(IPCB(skb)->opt), 0, sizeof(IPCB(skb)->opt));
1119 static inline int ipmr_forward_finish(struct sk_buff *skb)
1121 struct ip_options * opt = &(IPCB(skb)->opt);
1123 IP_INC_STATS_BH(IPSTATS_MIB_OUTFORWDATAGRAMS);
1125 if (unlikely(opt->optlen))
1126 ip_forward_options(skb);
1128 return dst_output(skb);
1132 * Processing handlers for ipmr_forward
1135 static void ipmr_queue_xmit(struct sk_buff *skb, struct mfc_cache *c, int vifi)
1137 struct iphdr *iph = skb->nh.iph;
1138 struct vif_device *vif = &vif_table[vifi];
1139 struct net_device *dev;
1143 if (vif->dev == NULL)
1146 #ifdef CONFIG_IP_PIMSM
1147 if (vif->flags & VIFF_REGISTER) {
1149 vif->bytes_out+=skb->len;
1150 ((struct net_device_stats*)vif->dev->priv)->tx_bytes += skb->len;
1151 ((struct net_device_stats*)vif->dev->priv)->tx_packets++;
1152 ipmr_cache_report(skb, vifi, IGMPMSG_WHOLEPKT);
1158 if (vif->flags&VIFF_TUNNEL) {
1159 struct flowi fl = { .oif = vif->link,
1161 { .daddr = vif->remote,
1162 .saddr = vif->local,
1163 .tos = RT_TOS(iph->tos) } },
1164 .proto = IPPROTO_IPIP };
1165 if (ip_route_output_key(&rt, &fl))
1167 encap = sizeof(struct iphdr);
1169 struct flowi fl = { .oif = vif->link,
1171 { .daddr = iph->daddr,
1172 .tos = RT_TOS(iph->tos) } },
1173 .proto = IPPROTO_IPIP };
1174 if (ip_route_output_key(&rt, &fl))
1178 dev = rt->u.dst.dev;
1180 if (skb->len+encap > dst_mtu(&rt->u.dst) && (ntohs(iph->frag_off) & IP_DF)) {
1181 /* Do not fragment multicasts. Alas, IPv4 does not
1182 allow to send ICMP, so that packets will disappear
1186 IP_INC_STATS_BH(IPSTATS_MIB_FRAGFAILS);
1191 encap += LL_RESERVED_SPACE(dev) + rt->u.dst.header_len;
1193 if (skb_cow(skb, encap)) {
1199 vif->bytes_out+=skb->len;
1201 dst_release(skb->dst);
1202 skb->dst = &rt->u.dst;
1204 ip_decrease_ttl(iph);
1206 /* FIXME: forward and output firewalls used to be called here.
1207 * What do we do with netfilter? -- RR */
1208 if (vif->flags & VIFF_TUNNEL) {
1209 ip_encap(skb, vif->local, vif->remote);
1210 /* FIXME: extra output firewall step used to be here. --RR */
1211 ((struct ip_tunnel *)vif->dev->priv)->stat.tx_packets++;
1212 ((struct ip_tunnel *)vif->dev->priv)->stat.tx_bytes+=skb->len;
1215 IPCB(skb)->flags |= IPSKB_FORWARDED;
1218 * RFC1584 teaches, that DVMRP/PIM router must deliver packets locally
1219 * not only before forwarding, but after forwarding on all output
1220 * interfaces. It is clear, if mrouter runs a multicasting
1221 * program, it should receive packets not depending to what interface
1222 * program is joined.
1223 * If we will not make it, the program will have to join on all
1224 * interfaces. On the other hand, multihoming host (or router, but
1225 * not mrouter) cannot join to more than one interface - it will
1226 * result in receiving multiple packets.
1228 NF_HOOK(PF_INET, NF_IP_FORWARD, skb, skb->dev, dev,
1229 ipmr_forward_finish);
1237 static int ipmr_find_vif(struct net_device *dev)
1240 for (ct=maxvif-1; ct>=0; ct--) {
1241 if (vif_table[ct].dev == dev)
1247 /* "local" means that we should preserve one skb (for local delivery) */
1249 static int ip_mr_forward(struct sk_buff *skb, struct mfc_cache *cache, int local)
1254 vif = cache->mfc_parent;
1255 cache->mfc_un.res.pkt++;
1256 cache->mfc_un.res.bytes += skb->len;
1259 * Wrong interface: drop packet and (maybe) send PIM assert.
1261 if (vif_table[vif].dev != skb->dev) {
1264 if (((struct rtable*)skb->dst)->fl.iif == 0) {
1265 /* It is our own packet, looped back.
1266 Very complicated situation...
1268 The best workaround until routing daemons will be
1269 fixed is not to redistribute packet, if it was
1270 send through wrong interface. It means, that
1271 multicast applications WILL NOT work for
1272 (S,G), which have default multicast route pointing
1273 to wrong oif. In any case, it is not a good
1274 idea to use multicasting applications on router.
1279 cache->mfc_un.res.wrong_if++;
1280 true_vifi = ipmr_find_vif(skb->dev);
1282 if (true_vifi >= 0 && mroute_do_assert &&
1283 /* pimsm uses asserts, when switching from RPT to SPT,
1284 so that we cannot check that packet arrived on an oif.
1285 It is bad, but otherwise we would need to move pretty
1286 large chunk of pimd to kernel. Ough... --ANK
1288 (mroute_do_pim || cache->mfc_un.res.ttls[true_vifi] < 255) &&
1290 cache->mfc_un.res.last_assert + MFC_ASSERT_THRESH)) {
1291 cache->mfc_un.res.last_assert = jiffies;
1292 ipmr_cache_report(skb, true_vifi, IGMPMSG_WRONGVIF);
1297 vif_table[vif].pkt_in++;
1298 vif_table[vif].bytes_in+=skb->len;
1303 for (ct = cache->mfc_un.res.maxvif-1; ct >= cache->mfc_un.res.minvif; ct--) {
1304 if (skb->nh.iph->ttl > cache->mfc_un.res.ttls[ct]) {
1306 struct sk_buff *skb2 = skb_clone(skb, GFP_ATOMIC);
1308 ipmr_queue_xmit(skb2, cache, psend);
1315 struct sk_buff *skb2 = skb_clone(skb, GFP_ATOMIC);
1317 ipmr_queue_xmit(skb2, cache, psend);
1319 ipmr_queue_xmit(skb, cache, psend);
1332 * Multicast packets for forwarding arrive here
1335 int ip_mr_input(struct sk_buff *skb)
1337 struct mfc_cache *cache;
1338 int local = ((struct rtable*)skb->dst)->rt_flags&RTCF_LOCAL;
1340 /* Packet is looped back after forward, it should not be
1341 forwarded second time, but still can be delivered locally.
1343 if (IPCB(skb)->flags&IPSKB_FORWARDED)
1347 if (IPCB(skb)->opt.router_alert) {
1348 if (ip_call_ra_chain(skb))
1350 } else if (skb->nh.iph->protocol == IPPROTO_IGMP){
1351 /* IGMPv1 (and broken IGMPv2 implementations sort of
1352 Cisco IOS <= 11.2(8)) do not put router alert
1353 option to IGMP packets destined to routable
1354 groups. It is very bad, because it means
1355 that we can forward NO IGMP messages.
1357 read_lock(&mrt_lock);
1358 if (mroute_socket) {
1360 raw_rcv(mroute_socket, skb);
1361 read_unlock(&mrt_lock);
1364 read_unlock(&mrt_lock);
1368 read_lock(&mrt_lock);
1369 cache = ipmr_cache_find(skb->nh.iph->saddr, skb->nh.iph->daddr);
1372 * No usable cache entry
1378 struct sk_buff *skb2 = skb_clone(skb, GFP_ATOMIC);
1379 ip_local_deliver(skb);
1381 read_unlock(&mrt_lock);
1387 vif = ipmr_find_vif(skb->dev);
1389 int err = ipmr_cache_unresolved(vif, skb);
1390 read_unlock(&mrt_lock);
1394 read_unlock(&mrt_lock);
1399 ip_mr_forward(skb, cache, local);
1401 read_unlock(&mrt_lock);
1404 return ip_local_deliver(skb);
1410 return ip_local_deliver(skb);
1415 #ifdef CONFIG_IP_PIMSM_V1
1417 * Handle IGMP messages of PIMv1
1420 int pim_rcv_v1(struct sk_buff * skb)
1422 struct igmphdr *pim;
1423 struct iphdr *encap;
1424 struct net_device *reg_dev = NULL;
1426 if (!pskb_may_pull(skb, sizeof(*pim) + sizeof(*encap)))
1429 pim = (struct igmphdr*)skb->h.raw;
1431 if (!mroute_do_pim ||
1432 skb->len < sizeof(*pim) + sizeof(*encap) ||
1433 pim->group != PIM_V1_VERSION || pim->code != PIM_V1_REGISTER)
1436 encap = (struct iphdr*)(skb->h.raw + sizeof(struct igmphdr));
1439 a. packet is really destinted to a multicast group
1440 b. packet is not a NULL-REGISTER
1441 c. packet is not truncated
1443 if (!MULTICAST(encap->daddr) ||
1444 encap->tot_len == 0 ||
1445 ntohs(encap->tot_len) + sizeof(*pim) > skb->len)
1448 read_lock(&mrt_lock);
1449 if (reg_vif_num >= 0)
1450 reg_dev = vif_table[reg_vif_num].dev;
1453 read_unlock(&mrt_lock);
1455 if (reg_dev == NULL)
1458 skb->mac.raw = skb->nh.raw;
1459 skb_pull(skb, (u8*)encap - skb->data);
1460 skb->nh.iph = (struct iphdr *)skb->data;
1462 memset(&(IPCB(skb)->opt), 0, sizeof(struct ip_options));
1463 skb->protocol = htons(ETH_P_IP);
1465 skb->pkt_type = PACKET_HOST;
1466 dst_release(skb->dst);
1468 ((struct net_device_stats*)reg_dev->priv)->rx_bytes += skb->len;
1469 ((struct net_device_stats*)reg_dev->priv)->rx_packets++;
1480 #ifdef CONFIG_IP_PIMSM_V2
1481 static int pim_rcv(struct sk_buff * skb)
1483 struct pimreghdr *pim;
1484 struct iphdr *encap;
1485 struct net_device *reg_dev = NULL;
1487 if (!pskb_may_pull(skb, sizeof(*pim) + sizeof(*encap)))
1490 pim = (struct pimreghdr*)skb->h.raw;
1491 if (pim->type != ((PIM_VERSION<<4)|(PIM_REGISTER)) ||
1492 (pim->flags&PIM_NULL_REGISTER) ||
1493 (ip_compute_csum((void *)pim, sizeof(*pim)) != 0 &&
1494 (u16)csum_fold(skb_checksum(skb, 0, skb->len, 0))))
1497 /* check if the inner packet is destined to mcast group */
1498 encap = (struct iphdr*)(skb->h.raw + sizeof(struct pimreghdr));
1499 if (!MULTICAST(encap->daddr) ||
1500 encap->tot_len == 0 ||
1501 ntohs(encap->tot_len) + sizeof(*pim) > skb->len)
1504 read_lock(&mrt_lock);
1505 if (reg_vif_num >= 0)
1506 reg_dev = vif_table[reg_vif_num].dev;
1509 read_unlock(&mrt_lock);
1511 if (reg_dev == NULL)
1514 skb->mac.raw = skb->nh.raw;
1515 skb_pull(skb, (u8*)encap - skb->data);
1516 skb->nh.iph = (struct iphdr *)skb->data;
1518 memset(&(IPCB(skb)->opt), 0, sizeof(struct ip_options));
1519 skb->protocol = htons(ETH_P_IP);
1521 skb->pkt_type = PACKET_HOST;
1522 dst_release(skb->dst);
1523 ((struct net_device_stats*)reg_dev->priv)->rx_bytes += skb->len;
1524 ((struct net_device_stats*)reg_dev->priv)->rx_packets++;
1537 ipmr_fill_mroute(struct sk_buff *skb, struct mfc_cache *c, struct rtmsg *rtm)
1540 struct rtnexthop *nhp;
1541 struct net_device *dev = vif_table[c->mfc_parent].dev;
1543 struct rtattr *mp_head;
1546 RTA_PUT(skb, RTA_IIF, 4, &dev->ifindex);
1548 mp_head = (struct rtattr*)skb_put(skb, RTA_LENGTH(0));
1550 for (ct = c->mfc_un.res.minvif; ct < c->mfc_un.res.maxvif; ct++) {
1551 if (c->mfc_un.res.ttls[ct] < 255) {
1552 if (skb_tailroom(skb) < RTA_ALIGN(RTA_ALIGN(sizeof(*nhp)) + 4))
1553 goto rtattr_failure;
1554 nhp = (struct rtnexthop*)skb_put(skb, RTA_ALIGN(sizeof(*nhp)));
1555 nhp->rtnh_flags = 0;
1556 nhp->rtnh_hops = c->mfc_un.res.ttls[ct];
1557 nhp->rtnh_ifindex = vif_table[ct].dev->ifindex;
1558 nhp->rtnh_len = sizeof(*nhp);
1561 mp_head->rta_type = RTA_MULTIPATH;
1562 mp_head->rta_len = skb->tail - (u8*)mp_head;
1563 rtm->rtm_type = RTN_MULTICAST;
1567 skb_trim(skb, b - skb->data);
1571 int ipmr_get_route(struct sk_buff *skb, struct rtmsg *rtm, int nowait)
1574 struct mfc_cache *cache;
1575 struct rtable *rt = (struct rtable*)skb->dst;
1577 read_lock(&mrt_lock);
1578 cache = ipmr_cache_find(rt->rt_src, rt->rt_dst);
1581 struct net_device *dev;
1585 read_unlock(&mrt_lock);
1590 if (dev == NULL || (vif = ipmr_find_vif(dev)) < 0) {
1591 read_unlock(&mrt_lock);
1594 skb->nh.raw = skb_push(skb, sizeof(struct iphdr));
1595 skb->nh.iph->ihl = sizeof(struct iphdr)>>2;
1596 skb->nh.iph->saddr = rt->rt_src;
1597 skb->nh.iph->daddr = rt->rt_dst;
1598 skb->nh.iph->version = 0;
1599 err = ipmr_cache_unresolved(vif, skb);
1600 read_unlock(&mrt_lock);
1604 if (!nowait && (rtm->rtm_flags&RTM_F_NOTIFY))
1605 cache->mfc_flags |= MFC_NOTIFY;
1606 err = ipmr_fill_mroute(skb, cache, rtm);
1607 read_unlock(&mrt_lock);
1611 #ifdef CONFIG_PROC_FS
1613 * The /proc interfaces to multicast routing /proc/ip_mr_cache /proc/ip_mr_vif
1615 struct ipmr_vif_iter {
1619 static struct vif_device *ipmr_vif_seq_idx(struct ipmr_vif_iter *iter,
1622 for (iter->ct = 0; iter->ct < maxvif; ++iter->ct) {
1623 if(!VIF_EXISTS(iter->ct))
1626 return &vif_table[iter->ct];
1631 static void *ipmr_vif_seq_start(struct seq_file *seq, loff_t *pos)
1633 read_lock(&mrt_lock);
1634 return *pos ? ipmr_vif_seq_idx(seq->private, *pos - 1)
1638 static void *ipmr_vif_seq_next(struct seq_file *seq, void *v, loff_t *pos)
1640 struct ipmr_vif_iter *iter = seq->private;
1643 if (v == SEQ_START_TOKEN)
1644 return ipmr_vif_seq_idx(iter, 0);
1646 while (++iter->ct < maxvif) {
1647 if(!VIF_EXISTS(iter->ct))
1649 return &vif_table[iter->ct];
1654 static void ipmr_vif_seq_stop(struct seq_file *seq, void *v)
1656 read_unlock(&mrt_lock);
1659 static int ipmr_vif_seq_show(struct seq_file *seq, void *v)
1661 if (v == SEQ_START_TOKEN) {
1663 "Interface BytesIn PktsIn BytesOut PktsOut Flags Local Remote\n");
1665 const struct vif_device *vif = v;
1666 const char *name = vif->dev ? vif->dev->name : "none";
1669 "%2Zd %-10s %8ld %7ld %8ld %7ld %05X %08X %08X\n",
1671 name, vif->bytes_in, vif->pkt_in,
1672 vif->bytes_out, vif->pkt_out,
1673 vif->flags, vif->local, vif->remote);
1678 static struct seq_operations ipmr_vif_seq_ops = {
1679 .start = ipmr_vif_seq_start,
1680 .next = ipmr_vif_seq_next,
1681 .stop = ipmr_vif_seq_stop,
1682 .show = ipmr_vif_seq_show,
1685 static int ipmr_vif_open(struct inode *inode, struct file *file)
1687 struct seq_file *seq;
1689 struct ipmr_vif_iter *s = kmalloc(sizeof(*s), GFP_KERNEL);
1694 rc = seq_open(file, &ipmr_vif_seq_ops);
1699 seq = file->private_data;
1709 static struct file_operations ipmr_vif_fops = {
1710 .owner = THIS_MODULE,
1711 .open = ipmr_vif_open,
1713 .llseek = seq_lseek,
1714 .release = seq_release_private,
1717 struct ipmr_mfc_iter {
1718 struct mfc_cache **cache;
1723 static struct mfc_cache *ipmr_mfc_seq_idx(struct ipmr_mfc_iter *it, loff_t pos)
1725 struct mfc_cache *mfc;
1727 it->cache = mfc_cache_array;
1728 read_lock(&mrt_lock);
1729 for (it->ct = 0; it->ct < MFC_LINES; it->ct++)
1730 for(mfc = mfc_cache_array[it->ct]; mfc; mfc = mfc->next)
1733 read_unlock(&mrt_lock);
1735 it->cache = &mfc_unres_queue;
1736 spin_lock_bh(&mfc_unres_lock);
1737 for(mfc = mfc_unres_queue; mfc; mfc = mfc->next)
1740 spin_unlock_bh(&mfc_unres_lock);
1747 static void *ipmr_mfc_seq_start(struct seq_file *seq, loff_t *pos)
1749 struct ipmr_mfc_iter *it = seq->private;
1752 return *pos ? ipmr_mfc_seq_idx(seq->private, *pos - 1)
1756 static void *ipmr_mfc_seq_next(struct seq_file *seq, void *v, loff_t *pos)
1758 struct mfc_cache *mfc = v;
1759 struct ipmr_mfc_iter *it = seq->private;
1763 if (v == SEQ_START_TOKEN)
1764 return ipmr_mfc_seq_idx(seq->private, 0);
1769 if (it->cache == &mfc_unres_queue)
1772 BUG_ON(it->cache != mfc_cache_array);
1774 while (++it->ct < MFC_LINES) {
1775 mfc = mfc_cache_array[it->ct];
1780 /* exhausted cache_array, show unresolved */
1781 read_unlock(&mrt_lock);
1782 it->cache = &mfc_unres_queue;
1785 spin_lock_bh(&mfc_unres_lock);
1786 mfc = mfc_unres_queue;
1791 spin_unlock_bh(&mfc_unres_lock);
1797 static void ipmr_mfc_seq_stop(struct seq_file *seq, void *v)
1799 struct ipmr_mfc_iter *it = seq->private;
1801 if (it->cache == &mfc_unres_queue)
1802 spin_unlock_bh(&mfc_unres_lock);
1803 else if (it->cache == mfc_cache_array)
1804 read_unlock(&mrt_lock);
1807 static int ipmr_mfc_seq_show(struct seq_file *seq, void *v)
1811 if (v == SEQ_START_TOKEN) {
1813 "Group Origin Iif Pkts Bytes Wrong Oifs\n");
1815 const struct mfc_cache *mfc = v;
1816 const struct ipmr_mfc_iter *it = seq->private;
1818 seq_printf(seq, "%08lX %08lX %-3d %8ld %8ld %8ld",
1819 (unsigned long) mfc->mfc_mcastgrp,
1820 (unsigned long) mfc->mfc_origin,
1822 mfc->mfc_un.res.pkt,
1823 mfc->mfc_un.res.bytes,
1824 mfc->mfc_un.res.wrong_if);
1826 if (it->cache != &mfc_unres_queue) {
1827 for(n = mfc->mfc_un.res.minvif;
1828 n < mfc->mfc_un.res.maxvif; n++ ) {
1830 && mfc->mfc_un.res.ttls[n] < 255)
1833 n, mfc->mfc_un.res.ttls[n]);
1836 seq_putc(seq, '\n');
1841 static struct seq_operations ipmr_mfc_seq_ops = {
1842 .start = ipmr_mfc_seq_start,
1843 .next = ipmr_mfc_seq_next,
1844 .stop = ipmr_mfc_seq_stop,
1845 .show = ipmr_mfc_seq_show,
1848 static int ipmr_mfc_open(struct inode *inode, struct file *file)
1850 struct seq_file *seq;
1852 struct ipmr_mfc_iter *s = kmalloc(sizeof(*s), GFP_KERNEL);
1857 rc = seq_open(file, &ipmr_mfc_seq_ops);
1861 seq = file->private_data;
1871 static struct file_operations ipmr_mfc_fops = {
1872 .owner = THIS_MODULE,
1873 .open = ipmr_mfc_open,
1875 .llseek = seq_lseek,
1876 .release = seq_release_private,
1880 #ifdef CONFIG_IP_PIMSM_V2
1881 static struct net_protocol pim_protocol = {
1888 * Setup for IP multicast routing
1891 void __init ip_mr_init(void)
1893 mrt_cachep = kmem_cache_create("ip_mrt_cache",
1894 sizeof(struct mfc_cache),
1895 0, SLAB_HWCACHE_ALIGN,
1898 panic("cannot allocate ip_mrt_cache");
1900 init_timer(&ipmr_expire_timer);
1901 ipmr_expire_timer.function=ipmr_expire_process;
1902 register_netdevice_notifier(&ip_mr_notifier);
1903 #ifdef CONFIG_PROC_FS
1904 proc_net_fops_create("ip_mr_vif", 0, &ipmr_vif_fops);
1905 proc_net_fops_create("ip_mr_cache", 0, &ipmr_mfc_fops);