[deliverable/linux.git] / include / linux / mroute.h

#ifndef __LINUX_MROUTE_H
#define __LINUX_MROUTE_H

#include <linux/sockios.h>
#include <linux/in.h>

/*
 *	Based on the MROUTING 3.5 defines primarily to keep
 *	source compatibility with BSD.
 *
 *	See the mrouted code for the original history.
 *
 *      Protocol Independent Multicast (PIM) data structures included
 *      Carlos Picoto (cap@di.fc.ul.pt)
 *
 */

#define MRT_BASE	200
#define MRT_INIT	(MRT_BASE)	/* Activate the kernel mroute code 	*/
#define MRT_DONE	(MRT_BASE+1)	/* Shutdown the kernel mroute		*/
#define MRT_ADD_VIF	(MRT_BASE+2)	/* Add a virtual interface		*/
#define MRT_DEL_VIF	(MRT_BASE+3)	/* Delete a virtual interface		*/
#define MRT_ADD_MFC	(MRT_BASE+4)	/* Add a multicast forwarding entry	*/
#define MRT_DEL_MFC	(MRT_BASE+5)	/* Delete a multicast forwarding entry	*/
#define MRT_VERSION	(MRT_BASE+6)	/* Get the kernel multicast version	*/
#define MRT_ASSERT	(MRT_BASE+7)	/* Activate PIM assert mode		*/
#define MRT_PIM		(MRT_BASE+8)	/* enable PIM code	*/

#define SIOCGETVIFCNT	SIOCPROTOPRIVATE	/* IP protocol privates */
#define SIOCGETSGCNT	(SIOCPROTOPRIVATE+1)
#define SIOCGETRPF	(SIOCPROTOPRIVATE+2)

#define MAXVIFS		32	
typedef unsigned long vifbitmap_t;	/* User mode code depends on this lot */
typedef unsigned short vifi_t;
#define ALL_VIFS	((vifi_t)(-1))

/*
 *	Same idea as select
 */
 
#define VIFM_SET(n,m)	((m)|=(1<<(n)))
#define VIFM_CLR(n,m)	((m)&=~(1<<(n)))
#define VIFM_ISSET(n,m)	((m)&(1<<(n)))
#define VIFM_CLRALL(m)	((m)=0)
#define VIFM_COPY(mfrom,mto)	((mto)=(mfrom))
#define VIFM_SAME(m1,m2)	((m1)==(m2))

/*
 *	Passed by mrouted for an MRT_ADD_VIF - again we use the
 *	mrouted 3.6 structures for compatibility
 */
 
struct vifctl {
	vifi_t	vifc_vifi;		/* Index of VIF */
	unsigned char vifc_flags;	/* VIFF_ flags */
	unsigned char vifc_threshold;	/* ttl limit */
	unsigned int vifc_rate_limit;	/* Rate limiter values (NI) */
	struct in_addr vifc_lcl_addr;	/* Our address */
	struct in_addr vifc_rmt_addr;	/* IPIP tunnel addr */
};

#define VIFF_TUNNEL	0x1	/* IPIP tunnel */
#define VIFF_SRCRT	0x2	/* NI */
#define VIFF_REGISTER	0x4	/* register vif	*/

/*
 *	Cache manipulation structures for mrouted and PIMd
 */
 
struct mfcctl
{
	struct in_addr mfcc_origin;		/* Origin of mcast	*/
	struct in_addr mfcc_mcastgrp;		/* Group in question	*/
	vifi_t	mfcc_parent;			/* Where it arrived	*/
	unsigned char mfcc_ttls[MAXVIFS];	/* Where it is going	*/
	unsigned int mfcc_pkt_cnt;		/* pkt count for src-grp */
	unsigned int mfcc_byte_cnt;
	unsigned int mfcc_wrong_if;
	int	     mfcc_expire;
};

/* 
 *	Group count retrieval for mrouted
 */
 
struct sioc_sg_req
{
	struct in_addr src;
	struct in_addr grp;
	unsigned long pktcnt;
	unsigned long bytecnt;
	unsigned long wrong_if;
};

/*
 *	To get vif packet counts
 */

struct sioc_vif_req
{
	vifi_t	vifi;		/* Which iface */
	unsigned long icount;	/* In packets */
	unsigned long ocount;	/* Out packets */
	unsigned long ibytes;	/* In bytes */
	unsigned long obytes;	/* Out bytes */
};

/*
 *	This is the format the mroute daemon expects to see IGMP control
 *	data. Magically happens to be like an IP packet as per the original
 */
 
struct igmpmsg
{
	__u32 unused1,unused2;
	unsigned char im_msgtype;		/* What is this */
	unsigned char im_mbz;			/* Must be zero */
	unsigned char im_vif;			/* Interface (this ought to be a vifi_t!) */
	unsigned char unused3;
	struct in_addr im_src,im_dst;
};

/*
 *	That's all usermode folks
 */

#ifdef __KERNEL__
#include <net/sock.h>

#ifdef CONFIG_IP_MROUTE
static inline int ip_mroute_opt(int opt)
{
	return (opt >= MRT_BASE) && (opt <= MRT_BASE + 10);
}
#else
static inline int ip_mroute_opt(int opt)
{
	return 0;
}
#endif

extern int ip_mroute_setsockopt(struct sock *, int, char __user *, int);
extern int ip_mroute_getsockopt(struct sock *, int, char __user *, int __user *);
extern int ipmr_ioctl(struct sock *sk, int cmd, void __user *arg);
extern void ip_mr_init(void);


struct vif_device
{
	struct net_device 	*dev;			/* Device we are using */
	unsigned long	bytes_in,bytes_out;
	unsigned long	pkt_in,pkt_out;		/* Statistics 			*/
	unsigned long	rate_limit;		/* Traffic shaping (NI) 	*/
	unsigned char	threshold;		/* TTL threshold 		*/
	unsigned short	flags;			/* Control flags 		*/
	__be32		local,remote;		/* Addresses(remote for tunnels)*/
	int		link;			/* Physical interface index	*/
};

#define VIFF_STATIC 0x8000

struct mfc_cache 
{
	struct mfc_cache *next;			/* Next entry on cache line 	*/
	__be32 mfc_mcastgrp;			/* Group the entry belongs to 	*/
	__be32 mfc_origin;			/* Source of packet 		*/
	vifi_t mfc_parent;			/* Source interface		*/
	int mfc_flags;				/* Flags on line		*/

	union {
		struct {
			unsigned long expires;
			struct sk_buff_head unresolved;	/* Unresolved buffers		*/
		} unres;
		struct {
			unsigned long last_assert;
			int minvif;
			int maxvif;
			unsigned long bytes;
			unsigned long pkt;
			unsigned long wrong_if;
			unsigned char ttls[MAXVIFS];	/* TTL thresholds		*/
		} res;
	} mfc_un;
};

#define MFC_STATIC		1
#define MFC_NOTIFY		2

#define MFC_LINES		64

#ifdef __BIG_ENDIAN
#define MFC_HASH(a,b)	(((((__force u32)(__be32)a)>>24)^(((__force u32)(__be32)b)>>26))&(MFC_LINES-1))
#else
#define MFC_HASH(a,b)	((((__force u32)(__be32)a)^(((__force u32)(__be32)b)>>2))&(MFC_LINES-1))
#endif		

#endif


#define MFC_ASSERT_THRESH (3*HZ)		/* Maximal freq. of asserts */

/*
 *	Pseudo messages used by mrouted
 */

#define IGMPMSG_NOCACHE		1		/* Kern cache fill request to mrouted */
#define IGMPMSG_WRONGVIF	2		/* For PIM assert processing (unused) */
#define IGMPMSG_WHOLEPKT	3		/* For PIM Register processing */

#ifdef __KERNEL__

#define PIM_V1_VERSION		__constant_htonl(0x10000000)
#define PIM_V1_REGISTER		1

#define PIM_VERSION		2
#define PIM_REGISTER		1

#define PIM_NULL_REGISTER	__constant_htonl(0x40000000)

/* PIMv2 register message header layout (ietf-draft-idmr-pimvsm-v2-00.ps */

struct pimreghdr
{
	__u8	type;
	__u8	reserved;
	__be16	csum;
	__be32	flags;
};

extern int pim_rcv_v1(struct sk_buff *);

struct rtmsg;
extern int ipmr_get_route(struct sk_buff *skb, struct rtmsg *rtm, int nowait);
#endif

#endif
Commit	Line	Data
1da177e4 LT	1	#ifndef __LINUX_MROUTE_H
	2	#define __LINUX_MROUTE_H
	3
	4	#include <linux/sockios.h>
	5	#include <linux/in.h>
	6
	7	/*
	8	* Based on the MROUTING 3.5 defines primarily to keep
	9	* source compatibility with BSD.
	10	*
	11	* See the mrouted 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 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 */
	28
	29	#define SIOCGETVIFCNT SIOCPROTOPRIVATE /* IP protocol privates */
	30	#define SIOCGETSGCNT (SIOCPROTOPRIVATE+1)
	31	#define SIOCGETRPF (SIOCPROTOPRIVATE+2)
	32
	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))
	37
	38	/*
	39	* Same idea as select
	40	*/
	41
	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))
	48
	49	/*
	50	* Passed by mrouted for an MRT_ADD_VIF - again we use the
	51	* mrouted 3.6 structures for compatibility
	52	*/
	53
	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 */
	61	};
	62
	63	#define VIFF_TUNNEL 0x1 /* IPIP tunnel */
	64	#define VIFF_SRCRT 0x2 /* NI */
65	#define VIFF_REGISTER 0x4 /* register vif */
66
67	/*
68	* Cache manipulation structures for mrouted and PIMd
69	*/
70
71	struct mfcctl
72	{
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;
81	};
82
83	/*
84	* Group count retrieval for mrouted
85	*/
86
87	struct sioc_sg_req
88	{
89	struct in_addr src;
90	struct in_addr grp;
91	unsigned long pktcnt;
92	unsigned long bytecnt;
93	unsigned long wrong_if;
94	};
95
96	/*
97	* To get vif packet counts
98	*/
99
100	struct sioc_vif_req
101	{
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 */
107	};
108
109	/*
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
112	*/
113
114	struct igmpmsg
115	{
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;
122	};
123
124	/*
125	* That's all usermode folks
126	*/
127
128	#ifdef __KERNEL__
129	#include <net/sock.h>
130
6a9fb947 PE	131	#ifdef CONFIG_IP_MROUTE
	132	static inline int ip_mroute_opt(int opt)
	133	{
	134	return (opt >= MRT_BASE) && (opt <= MRT_BASE + 10);
	135	}
	136	#else
	137	static inline int ip_mroute_opt(int opt)
	138	{
	139	return 0;
	140	}
	141	#endif
	142
1da177e4 LT	143	extern int ip_mroute_setsockopt(struct sock , int, char __user , int);
	144	extern int ip_mroute_getsockopt(struct sock , int, char __user , int __user *);
	145	extern int ipmr_ioctl(struct sock sk, int cmd, void __user arg);
	146	extern void ip_mr_init(void);
	147
	148
	149	struct vif_device
	150	{
	151	struct net_device dev; / Device we are using */
	152	unsigned long bytes_in,bytes_out;
	153	unsigned long pkt_in,pkt_out; /* Statistics */
	154	unsigned long rate_limit; /* Traffic shaping (NI) */
	155	unsigned char threshold; /* TTL threshold */
	156	unsigned short flags; /* Control flags */
114c7844	157	__be32 local,remote; /* Addresses(remote for tunnels)*/
1da177e4 LT	158	int link; /* Physical interface index */
	159	};
	160
	161	#define VIFF_STATIC 0x8000
	162
	163	struct mfc_cache
	164	{
	165	struct mfc_cache next; / Next entry on cache line */
114c7844 AV	166	__be32 mfc_mcastgrp; /* Group the entry belongs to */
114c7844 AV	167	__be32 mfc_origin; /* Source of packet */
1da177e4 LT	168	vifi_t mfc_parent; /* Source interface */
	169	int mfc_flags; /* Flags on line */
	170
	171	union {
	172	struct {
	173	unsigned long expires;
	174	struct sk_buff_head unresolved; /* Unresolved buffers */
	175	} unres;
	176	struct {
	177	unsigned long last_assert;
	178	int minvif;
	179	int maxvif;
	180	unsigned long bytes;
	181	unsigned long pkt;
	182	unsigned long wrong_if;
	183	unsigned char ttls[MAXVIFS]; /* TTL thresholds */
	184	} res;
	185	} mfc_un;
	186	};
	187
	188	#define MFC_STATIC 1
	189	#define MFC_NOTIFY 2
	190
	191	#define MFC_LINES 64
	192
	193	#ifdef __BIG_ENDIAN
114c7844	194	#define MFC_HASH(a,b) (((((__force u32)(__be32)a)>>24)^(((__force u32)(__be32)b)>>26))&(MFC_LINES-1))
1da177e4	195	#else
114c7844	196	#define MFC_HASH(a,b) ((((__force u32)(__be32)a)^(((__force u32)(__be32)b)>>2))&(MFC_LINES-1))
1da177e4 LT	197	#endif
	198
	199	#endif
	200
	201
	202	#define MFC_ASSERT_THRESH (3HZ) / Maximal freq. of asserts */
	203
	204	/*
	205	* Pseudo messages used by mrouted
	206	*/
	207
	208	#define IGMPMSG_NOCACHE 1 /* Kern cache fill request to mrouted */
	209	#define IGMPMSG_WRONGVIF 2 /* For PIM assert processing (unused) */
	210	#define IGMPMSG_WHOLEPKT 3 /* For PIM Register processing */
	211
	212	#ifdef __KERNEL__
	213
	214	#define PIM_V1_VERSION __constant_htonl(0x10000000)
	215	#define PIM_V1_REGISTER 1
	216
	217	#define PIM_VERSION 2
	218	#define PIM_REGISTER 1
	219
	220	#define PIM_NULL_REGISTER __constant_htonl(0x40000000)
	221
	222	/* PIMv2 register message header layout (ietf-draft-idmr-pimvsm-v2-00.ps */
	223
	224	struct pimreghdr
	225	{
	226	__u8 type;
	227	__u8 reserved;
1b620154 AV	228	__be16 csum;
1b620154 AV	229	__be32 flags;
1da177e4 LT	230	};
	231
	232	extern int pim_rcv_v1(struct sk_buff *);
	233
	234	struct rtmsg;
	235	extern int ipmr_get_route(struct sk_buff skb, struct rtmsg rtm, int nowait);
	236	#endif
	237
	238	#endif