[IPV6] MROUTE: Support multicast forwarding.
[linux-2.6.git] / include / linux / mroute6.h
1 #ifndef __LINUX_MROUTE6_H
2 #define __LINUX_MROUTE6_H
3
4 #include <linux/types.h>
5 #include <linux/sockios.h>
6
7 /*
8  *      Based on the MROUTING 3.5 defines primarily to keep
9  *      source compatibility with BSD.
10  *
11  *      See the pim6sd code for the original history.
12  *
13  *      Protocol Independent Multicast (PIM) data structures included
14  *      Carlos Picoto (cap@di.fc.ul.pt)
15  *
16  */
17
18 #define MRT6_BASE       200
19 #define MRT6_INIT       (MRT6_BASE)     /* Activate the kernel mroute code      */
20 #define MRT6_DONE       (MRT6_BASE+1)   /* Shutdown the kernel mroute           */
21 #define MRT6_ADD_MIF    (MRT6_BASE+2)   /* Add a virtual interface              */
22 #define MRT6_DEL_MIF    (MRT6_BASE+3)   /* Delete a virtual interface           */
23 #define MRT6_ADD_MFC    (MRT6_BASE+4)   /* Add a multicast forwarding entry     */
24 #define MRT6_DEL_MFC    (MRT6_BASE+5)   /* Delete a multicast forwarding entry  */
25 #define MRT6_VERSION    (MRT6_BASE+6)   /* Get the kernel multicast version     */
26
27 #define SIOCGETMIFCNT_IN6       SIOCPROTOPRIVATE        /* IP protocol privates */
28 #define SIOCGETSGCNT_IN6        (SIOCPROTOPRIVATE+1)
29 #define SIOCGETRPF      (SIOCPROTOPRIVATE+2)
30
31 #define MAXMIFS         32
32 typedef unsigned long mifbitmap_t;      /* User mode code depends on this lot */
33 typedef unsigned short mifi_t;
34 #define ALL_MIFS        ((mifi_t)(-1))
35
36 #ifndef IF_SETSIZE
37 #define IF_SETSIZE      256
38 #endif
39
40 typedef __u32           if_mask;
41 #define NIFBITS (sizeof(if_mask) * 8)        /* bits per mask */
42
43 #if !defined(__KERNEL__) && !defined(DIV_ROUND_UP)
44 #define DIV_ROUND_UP(x,y)       (((x) + ((y) - 1)) / (y))
45 #endif
46
47 typedef struct if_set {
48         if_mask ifs_bits[DIV_ROUND_UP(IF_SETSIZE, NIFBITS)];
49 } if_set;
50
51 #define IF_SET(n, p)    ((p)->ifs_bits[(n)/NIFBITS] |= (1 << ((n) % NIFBITS)))
52 #define IF_CLR(n, p)    ((p)->ifs_bits[(n)/NIFBITS] &= ~(1 << ((n) % NIFBITS)))
53 #define IF_ISSET(n, p)  ((p)->ifs_bits[(n)/NIFBITS] & (1 << ((n) % NIFBITS)))
54 #define IF_COPY(f, t)   bcopy(f, t, sizeof(*(f)))
55 #define IF_ZERO(p)      bzero(p, sizeof(*(p)))
56
57 /*
58  *      Passed by mrouted for an MRT_ADD_MIF - again we use the
59  *      mrouted 3.6 structures for compatibility
60  */
61
62 struct mif6ctl {
63         mifi_t  mif6c_mifi;             /* Index of MIF */
64         unsigned char mif6c_flags;      /* MIFF_ flags */
65         unsigned char vifc_threshold;   /* ttl limit */
66         u_short  mif6c_pifi;            /* the index of the physical IF */
67         unsigned int vifc_rate_limit;   /* Rate limiter values (NI) */
68 };
69
70 #define MIFF_REGISTER   0x1     /* register vif */
71
72 /*
73  *      Cache manipulation structures for mrouted and PIMd
74  */
75
76 struct mf6cctl
77 {
78         struct sockaddr_in6 mf6cc_origin;               /* Origin of mcast      */
79         struct sockaddr_in6 mf6cc_mcastgrp;             /* Group in question    */
80         mifi_t  mf6cc_parent;                   /* Where it arrived     */
81         struct if_set mf6cc_ifset;              /* Where it is going */
82 };
83
84 /*
85  *      Group count retrieval for pim6sd
86  */
87
88 struct sioc_sg_req6
89 {
90         struct sockaddr_in6 src;
91         struct sockaddr_in6 grp;
92         unsigned long pktcnt;
93         unsigned long bytecnt;
94         unsigned long wrong_if;
95 };
96
97 /*
98  *      To get vif packet counts
99  */
100
101 struct sioc_mif_req6
102 {
103         mifi_t  mifi;           /* Which iface */
104         unsigned long icount;   /* In packets */
105         unsigned long ocount;   /* Out packets */
106         unsigned long ibytes;   /* In bytes */
107         unsigned long obytes;   /* Out bytes */
108 };
109
110 /*
111  *      That's all usermode folks
112  */
113
114 #ifdef __KERNEL__
115
116 #include <linux/skbuff.h>       /* for struct sk_buff_head */
117
118 struct net_device;
119 struct inet6_dev *ipv6_find_idev(struct net_device *dev);
120
121 #ifdef CONFIG_IPV6_MROUTE
122 static inline int ip6_mroute_opt(int opt)
123 {
124         return (opt >= MRT6_BASE) && (opt <= MRT6_BASE + 10);
125 }
126 #else
127 static inline int ip6_mroute_opt(int opt)
128 {
129         return 0;
130 }
131 #endif
132
133 struct sock;
134
135 extern int ip6_mroute_setsockopt(struct sock *, int, char __user *, int);
136 extern int ip6_mroute_getsockopt(struct sock *, int, char __user *, int __user *);
137 extern int ip6_mr_input(struct sk_buff *skb);
138 extern int ip6mr_ioctl(struct sock *sk, int cmd, void __user *arg);
139 extern void ip6_mr_init(void);
140
141 struct mif_device
142 {
143         struct net_device       *dev;                   /* Device we are using */
144         unsigned long   bytes_in,bytes_out;
145         unsigned long   pkt_in,pkt_out;         /* Statistics                   */
146         unsigned long   rate_limit;             /* Traffic shaping (NI)         */
147         unsigned char   threshold;              /* TTL threshold                */
148         unsigned short  flags;                  /* Control flags                */
149         int             link;                   /* Physical interface index     */
150 };
151
152 #define VIFF_STATIC 0x8000
153
154 struct mfc6_cache
155 {
156         struct mfc6_cache *next;                /* Next entry on cache line     */
157         struct in6_addr mf6c_mcastgrp;                  /* Group the entry belongs to   */
158         struct in6_addr mf6c_origin;                    /* Source of packet             */
159         mifi_t mf6c_parent;                     /* Source interface             */
160         int mfc_flags;                          /* Flags on line                */
161
162         union {
163                 struct {
164                         unsigned long expires;
165                         struct sk_buff_head unresolved; /* Unresolved buffers           */
166                 } unres;
167                 struct {
168                         unsigned long last_assert;
169                         int minvif;
170                         int maxvif;
171                         unsigned long bytes;
172                         unsigned long pkt;
173                         unsigned long wrong_if;
174                         unsigned char ttls[MAXMIFS];    /* TTL thresholds               */
175                 } res;
176         } mfc_un;
177 };
178
179 #define MFC_STATIC              1
180 #define MFC_NOTIFY              2
181
182 #define MFC6_LINES              64
183
184 #define MFC6_HASH(a, g) (((__force u32)(a)->s6_addr32[0] ^ \
185                           (__force u32)(a)->s6_addr32[1] ^ \
186                           (__force u32)(a)->s6_addr32[2] ^ \
187                           (__force u32)(a)->s6_addr32[3] ^ \
188                           (__force u32)(g)->s6_addr32[0] ^ \
189                           (__force u32)(g)->s6_addr32[1] ^ \
190                           (__force u32)(g)->s6_addr32[2] ^ \
191                           (__force u32)(g)->s6_addr32[3]) % MFC6_LINES)
192
193 #define MFC_ASSERT_THRESH (3*HZ)                /* Maximal freq. of asserts */
194
195 #endif
196
197 #ifdef __KERNEL__
198 struct rtmsg;
199 extern int ip6mr_get_route(struct sk_buff *skb, struct rtmsg *rtm, int nowait);
200
201 #ifdef CONFIG_IPV6_MROUTE
202 extern struct sock *mroute6_socket;
203 extern int ip6mr_sk_done(struct sock *sk);
204 #else
205 #define mroute6_socket NULL
206 static inline int ip6mr_sk_done(struct sock *sk) { return 0; }
207 #endif
208 #endif
209
210 /*
211  * Structure used to communicate from kernel to multicast router.
212  * We'll overlay the structure onto an MLD header (not an IPv6 heder like igmpmsg{}
213  * used for IPv4 implementation). This is because this structure will be passed via an
214  * IPv6 raw socket, on wich an application will only receiver the payload i.e the data after
215  * the IPv6 header and all the extension headers. (See section 3 of RFC 3542)
216  */
217
218 struct mrt6msg {
219 #define MRT6MSG_NOCACHE         1
220         __u8            im6_mbz;                /* must be zero            */
221         __u8            im6_msgtype;            /* what type of message    */
222         __u16           im6_mif;                /* mif rec'd on            */
223         __u32           im6_pad;                /* padding for 64 bit arch */
224         struct in6_addr im6_src, im6_dst;
225 };
226
227 #endif