[mirror_ubuntu-bionic-kernel.git] / include / linux / mroute.h

#ifndef __LINUX_MROUTE_H
#define __LINUX_MROUTE_H

#include <linux/sockios.h>
#include <linux/types.h>
#ifdef __KERNEL__
#include <linux/in.h>
#endif
#include <linux/pim.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__
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>
80a9492a YH	5	#include <linux/types.h>
80a9492a YH	6	#ifdef __KERNEL__
1da177e4	7	#include <linux/in.h>
80a9492a	8	#endif
2e804627	9	#include <linux/pim.h>
1da177e4 LT	10
	11	/*
	12	* Based on the MROUTING 3.5 defines primarily to keep
	13	* source compatibility with BSD.
	14	*
	15	* See the mrouted code for the original history.
	16	*
	17	* Protocol Independent Multicast (PIM) data structures included
	18	* Carlos Picoto (cap@di.fc.ul.pt)
	19	*
	20	*/
	21
	22	#define MRT_BASE 200
	23	#define MRT_INIT (MRT_BASE) /* Activate the kernel mroute code */
	24	#define MRT_DONE (MRT_BASE+1) /* Shutdown the kernel mroute */
	25	#define MRT_ADD_VIF (MRT_BASE+2) /* Add a virtual interface */
	26	#define MRT_DEL_VIF (MRT_BASE+3) /* Delete a virtual interface */
	27	#define MRT_ADD_MFC (MRT_BASE+4) /* Add a multicast forwarding entry */
	28	#define MRT_DEL_MFC (MRT_BASE+5) /* Delete a multicast forwarding entry */
	29	#define MRT_VERSION (MRT_BASE+6) /* Get the kernel multicast version */
	30	#define MRT_ASSERT (MRT_BASE+7) /* Activate PIM assert mode */
	31	#define MRT_PIM (MRT_BASE+8) /* enable PIM code */
	32
	33	#define SIOCGETVIFCNT SIOCPROTOPRIVATE /* IP protocol privates */
	34	#define SIOCGETSGCNT (SIOCPROTOPRIVATE+1)
	35	#define SIOCGETRPF (SIOCPROTOPRIVATE+2)
	36
	37	#define MAXVIFS 32
	38	typedef unsigned long vifbitmap_t; /* User mode code depends on this lot */
	39	typedef unsigned short vifi_t;
	40	#define ALL_VIFS ((vifi_t)(-1))
	41
	42	/*
	43	* Same idea as select
	44	*/
	45
	46	#define VIFM_SET(n,m) ((m)\|=(1<<(n)))
	47	#define VIFM_CLR(n,m) ((m)&=~(1<<(n)))
	48	#define VIFM_ISSET(n,m) ((m)&(1<<(n)))
	49	#define VIFM_CLRALL(m) ((m)=0)
	50	#define VIFM_COPY(mfrom,mto) ((mto)=(mfrom))
	51	#define VIFM_SAME(m1,m2) ((m1)==(m2))
	52
	53	/*
	54	* Passed by mrouted for an MRT_ADD_VIF - again we use the
	55	* mrouted 3.6 structures for compatibility
	56	*/
	57
	58	struct vifctl {
	59	vifi_t vifc_vifi; /* Index of VIF */
	60	unsigned char vifc_flags; /* VIFF_ flags */
	61	unsigned char vifc_threshold; /* ttl limit */
	62	unsigned int vifc_rate_limit; /* Rate limiter values (NI) */
	63	struct in_addr vifc_lcl_addr; /* Our address */
	64	struct in_addr vifc_rmt_addr; /* IPIP tunnel addr */
	65	};
	66
	67	#define VIFF_TUNNEL 0x1 /* IPIP tunnel */
	68	#define VIFF_SRCRT 0x2 /* NI */
	69	#define VIFF_REGISTER 0x4 /* register vif */
	70
	71	/*
	72	* Cache manipulation structures for mrouted and PIMd
	73	*/
74
75	struct mfcctl
76	{
77	struct in_addr mfcc_origin; /* Origin of mcast */
78	struct in_addr mfcc_mcastgrp; /* Group in question */
79	vifi_t mfcc_parent; /* Where it arrived */
80	unsigned char mfcc_ttls[MAXVIFS]; /* Where it is going */
81	unsigned int mfcc_pkt_cnt; /* pkt count for src-grp */
82	unsigned int mfcc_byte_cnt;
83	unsigned int mfcc_wrong_if;
84	int mfcc_expire;
85	};
86
87	/*
88	* Group count retrieval for mrouted
89	*/
90
91	struct sioc_sg_req
92	{
93	struct in_addr src;
94	struct in_addr grp;
95	unsigned long pktcnt;
96	unsigned long bytecnt;
97	unsigned long wrong_if;
98	};
99
100	/*
101	* To get vif packet counts
102	*/
103
104	struct sioc_vif_req
105	{
106	vifi_t vifi; /* Which iface */
107	unsigned long icount; /* In packets */
108	unsigned long ocount; /* Out packets */
109	unsigned long ibytes; /* In bytes */
110	unsigned long obytes; /* Out bytes */
111	};
112
113	/*
114	* This is the format the mroute daemon expects to see IGMP control
115	* data. Magically happens to be like an IP packet as per the original
116	*/
117
118	struct igmpmsg
119	{
120	__u32 unused1,unused2;
121	unsigned char im_msgtype; /* What is this */
122	unsigned char im_mbz; /* Must be zero */
123	unsigned char im_vif; /* Interface (this ought to be a vifi_t!) */
124	unsigned char unused3;
125	struct in_addr im_src,im_dst;
126	};
127
128	/*
129	* That's all usermode folks
130	*/
131
132	#ifdef __KERNEL__
133	#include <net/sock.h>
134
6a9fb947 PE	135	#ifdef CONFIG_IP_MROUTE
	136	static inline int ip_mroute_opt(int opt)
	137	{
	138	return (opt >= MRT_BASE) && (opt <= MRT_BASE + 10);
	139	}
	140	#else
	141	static inline int ip_mroute_opt(int opt)
	142	{
	143	return 0;
	144	}
	145	#endif
	146
1da177e4 LT	147	extern int ip_mroute_setsockopt(struct sock , int, char __user , int);
	148	extern int ip_mroute_getsockopt(struct sock , int, char __user , int __user *);
	149	extern int ipmr_ioctl(struct sock sk, int cmd, void __user arg);
	150	extern void ip_mr_init(void);
	151
	152
	153	struct vif_device
	154	{
	155	struct net_device dev; / Device we are using */
	156	unsigned long bytes_in,bytes_out;
	157	unsigned long pkt_in,pkt_out; /* Statistics */
	158	unsigned long rate_limit; /* Traffic shaping (NI) */
	159	unsigned char threshold; /* TTL threshold */
	160	unsigned short flags; /* Control flags */
114c7844	161	__be32 local,remote; /* Addresses(remote for tunnels)*/
1da177e4 LT	162	int link; /* Physical interface index */
	163	};
	164
	165	#define VIFF_STATIC 0x8000
	166
	167	struct mfc_cache
	168	{
	169	struct mfc_cache next; / Next entry on cache line */
114c7844 AV	170	__be32 mfc_mcastgrp; /* Group the entry belongs to */
114c7844 AV	171	__be32 mfc_origin; /* Source of packet */
1da177e4 LT	172	vifi_t mfc_parent; /* Source interface */
	173	int mfc_flags; /* Flags on line */
	174
	175	union {
	176	struct {
	177	unsigned long expires;
	178	struct sk_buff_head unresolved; /* Unresolved buffers */
	179	} unres;
	180	struct {
	181	unsigned long last_assert;
	182	int minvif;
	183	int maxvif;
	184	unsigned long bytes;
	185	unsigned long pkt;
	186	unsigned long wrong_if;
	187	unsigned char ttls[MAXVIFS]; /* TTL thresholds */
	188	} res;
	189	} mfc_un;
	190	};
	191
	192	#define MFC_STATIC 1
	193	#define MFC_NOTIFY 2
	194
	195	#define MFC_LINES 64
	196
	197	#ifdef __BIG_ENDIAN
114c7844	198	#define MFC_HASH(a,b) (((((__force u32)(__be32)a)>>24)^(((__force u32)(__be32)b)>>26))&(MFC_LINES-1))
1da177e4	199	#else
114c7844	200	#define MFC_HASH(a,b) ((((__force u32)(__be32)a)^(((__force u32)(__be32)b)>>2))&(MFC_LINES-1))
1da177e4 LT	201	#endif
	202
	203	#endif
	204
	205
	206	#define MFC_ASSERT_THRESH (3HZ) / Maximal freq. of asserts */
	207
	208	/*
	209	* Pseudo messages used by mrouted
	210	*/
	211
	212	#define IGMPMSG_NOCACHE 1 /* Kern cache fill request to mrouted */
	213	#define IGMPMSG_WRONGVIF 2 /* For PIM assert processing (unused) */
	214	#define IGMPMSG_WHOLEPKT 3 /* For PIM Register processing */
	215
	216	#ifdef __KERNEL__
1da177e4 LT	217	struct rtmsg;
	218	extern int ipmr_get_route(struct sk_buff skb, struct rtmsg rtm, int nowait);
	219	#endif
	220
	221	#endif