[CONNECTOR]: Update documentation to match reality.
[linux-2.6/verdex.git] / include / linux / mroute.h
blobe05d54a90743e4890a99436c0616ad428142643c
1 #ifndef __LINUX_MROUTE_H
2 #define __LINUX_MROUTE_H
4 #include <linux/sockios.h>
5 #include <linux/in.h>
7 /*
8 * Based on the MROUTING 3.5 defines primarily to keep
9 * source compatibility with BSD.
11 * See the mrouted code for the original history.
13 * Protocol Independent Multicast (PIM) data structures included
14 * Carlos Picoto (cap@di.fc.ul.pt)
18 #define MRT_BASE 200
19 #define MRT_INIT (MRT_BASE) /* Activate the kernel mroute code */
20 #define MRT_DONE (MRT_BASE+1) /* Shutdown the kernel mroute */
21 #define MRT_ADD_VIF (MRT_BASE+2) /* Add a virtual interface */
22 #define MRT_DEL_VIF (MRT_BASE+3) /* Delete a virtual interface */
23 #define MRT_ADD_MFC (MRT_BASE+4) /* Add a multicast forwarding entry */
24 #define MRT_DEL_MFC (MRT_BASE+5) /* Delete a multicast forwarding entry */
25 #define MRT_VERSION (MRT_BASE+6) /* Get the kernel multicast version */
26 #define MRT_ASSERT (MRT_BASE+7) /* Activate PIM assert mode */
27 #define MRT_PIM (MRT_BASE+8) /* enable PIM code */
29 #define SIOCGETVIFCNT SIOCPROTOPRIVATE /* IP protocol privates */
30 #define SIOCGETSGCNT (SIOCPROTOPRIVATE+1)
31 #define SIOCGETRPF (SIOCPROTOPRIVATE+2)
33 #define MAXVIFS 32
34 typedef unsigned long vifbitmap_t; /* User mode code depends on this lot */
35 typedef unsigned short vifi_t;
36 #define ALL_VIFS ((vifi_t)(-1))
39 * Same idea as select
42 #define VIFM_SET(n,m) ((m)|=(1<<(n)))
43 #define VIFM_CLR(n,m) ((m)&=~(1<<(n)))
44 #define VIFM_ISSET(n,m) ((m)&(1<<(n)))
45 #define VIFM_CLRALL(m) ((m)=0)
46 #define VIFM_COPY(mfrom,mto) ((mto)=(mfrom))
47 #define VIFM_SAME(m1,m2) ((m1)==(m2))
50 * Passed by mrouted for an MRT_ADD_VIF - again we use the
51 * mrouted 3.6 structures for compatibility
54 struct vifctl {
55 vifi_t vifc_vifi; /* Index of VIF */
56 unsigned char vifc_flags; /* VIFF_ flags */
57 unsigned char vifc_threshold; /* ttl limit */
58 unsigned int vifc_rate_limit; /* Rate limiter values (NI) */
59 struct in_addr vifc_lcl_addr; /* Our address */
60 struct in_addr vifc_rmt_addr; /* IPIP tunnel addr */
63 #define VIFF_TUNNEL 0x1 /* IPIP tunnel */
64 #define VIFF_SRCRT 0x2 /* NI */
65 #define VIFF_REGISTER 0x4 /* register vif */
68 * Cache manipulation structures for mrouted and PIMd
71 struct mfcctl
73 struct in_addr mfcc_origin; /* Origin of mcast */
74 struct in_addr mfcc_mcastgrp; /* Group in question */
75 vifi_t mfcc_parent; /* Where it arrived */
76 unsigned char mfcc_ttls[MAXVIFS]; /* Where it is going */
77 unsigned int mfcc_pkt_cnt; /* pkt count for src-grp */
78 unsigned int mfcc_byte_cnt;
79 unsigned int mfcc_wrong_if;
80 int mfcc_expire;
83 /*
84 * Group count retrieval for mrouted
87 struct sioc_sg_req
89 struct in_addr src;
90 struct in_addr grp;
91 unsigned long pktcnt;
92 unsigned long bytecnt;
93 unsigned long wrong_if;
97 * To get vif packet counts
100 struct sioc_vif_req
102 vifi_t vifi; /* Which iface */
103 unsigned long icount; /* In packets */
104 unsigned long ocount; /* Out packets */
105 unsigned long ibytes; /* In bytes */
106 unsigned long obytes; /* Out bytes */
110 * This is the format the mroute daemon expects to see IGMP control
111 * data. Magically happens to be like an IP packet as per the original
114 struct igmpmsg
116 __u32 unused1,unused2;
117 unsigned char im_msgtype; /* What is this */
118 unsigned char im_mbz; /* Must be zero */
119 unsigned char im_vif; /* Interface (this ought to be a vifi_t!) */
120 unsigned char unused3;
121 struct in_addr im_src,im_dst;
125 * That's all usermode folks
128 #ifdef __KERNEL__
129 #include <net/sock.h>
131 extern int ip_mroute_setsockopt(struct sock *, int, char __user *, int);
132 extern int ip_mroute_getsockopt(struct sock *, int, char __user *, int __user *);
133 extern int ipmr_ioctl(struct sock *sk, int cmd, void __user *arg);
134 extern void ip_mr_init(void);
137 struct vif_device
139 struct net_device *dev; /* Device we are using */
140 unsigned long bytes_in,bytes_out;
141 unsigned long pkt_in,pkt_out; /* Statistics */
142 unsigned long rate_limit; /* Traffic shaping (NI) */
143 unsigned char threshold; /* TTL threshold */
144 unsigned short flags; /* Control flags */
145 __u32 local,remote; /* Addresses(remote for tunnels)*/
146 int link; /* Physical interface index */
149 #define VIFF_STATIC 0x8000
151 struct mfc_cache
153 struct mfc_cache *next; /* Next entry on cache line */
154 __u32 mfc_mcastgrp; /* Group the entry belongs to */
155 __u32 mfc_origin; /* Source of packet */
156 vifi_t mfc_parent; /* Source interface */
157 int mfc_flags; /* Flags on line */
159 union {
160 struct {
161 unsigned long expires;
162 struct sk_buff_head unresolved; /* Unresolved buffers */
163 } unres;
164 struct {
165 unsigned long last_assert;
166 int minvif;
167 int maxvif;
168 unsigned long bytes;
169 unsigned long pkt;
170 unsigned long wrong_if;
171 unsigned char ttls[MAXVIFS]; /* TTL thresholds */
172 } res;
173 } mfc_un;
176 #define MFC_STATIC 1
177 #define MFC_NOTIFY 2
179 #define MFC_LINES 64
181 #ifdef __BIG_ENDIAN
182 #define MFC_HASH(a,b) ((((a)>>24)^((b)>>26))&(MFC_LINES-1))
183 #else
184 #define MFC_HASH(a,b) (((a)^((b)>>2))&(MFC_LINES-1))
185 #endif
187 #endif
190 #define MFC_ASSERT_THRESH (3*HZ) /* Maximal freq. of asserts */
193 * Pseudo messages used by mrouted
196 #define IGMPMSG_NOCACHE 1 /* Kern cache fill request to mrouted */
197 #define IGMPMSG_WRONGVIF 2 /* For PIM assert processing (unused) */
198 #define IGMPMSG_WHOLEPKT 3 /* For PIM Register processing */
200 #ifdef __KERNEL__
202 #define PIM_V1_VERSION __constant_htonl(0x10000000)
203 #define PIM_V1_REGISTER 1
205 #define PIM_VERSION 2
206 #define PIM_REGISTER 1
208 #define PIM_NULL_REGISTER __constant_htonl(0x40000000)
210 /* PIMv2 register message header layout (ietf-draft-idmr-pimvsm-v2-00.ps */
212 struct pimreghdr
214 __u8 type;
215 __u8 reserved;
216 __u16 csum;
217 __u32 flags;
220 extern int pim_rcv_v1(struct sk_buff *);
222 struct rtmsg;
223 extern int ipmr_get_route(struct sk_buff *skb, struct rtmsg *rtm, int nowait);
224 #endif
226 #endif