[mirror_ubuntu-jammy-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

/*
 *	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) */
	union {
		struct in_addr vifc_lcl_addr;     /* Local interface address */
		int            vifc_lcl_ifindex;  /* Local interface index   */
	};
	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	*/
#define VIFF_USE_IFINDEX	0x8	/* use vifc_lcl_ifindex instead of
					   vifc_lcl_addr to find an interface */

/*
 *	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 <linux/pim.h>
#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

#ifdef CONFIG_IP_MROUTE
extern int ip_mroute_setsockopt(struct sock *, int, char __user *, unsigned 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 int ip_mr_init(void);
#else
static inline
int ip_mroute_setsockopt(struct sock *sock,
			 int optname, char __user *optval, unsigned int optlen)
{
	return -ENOPROTOOPT;
}

static inline
int ip_mroute_getsockopt(struct sock *sock,
			 int optname, char __user *optval, int __user *optlen)
{
	return -ENOPROTOOPT;
}

static inline
int ipmr_ioctl(struct sock *sk, int cmd, void __user *arg)
{
	return -ENOIOCTLCMD;
}

static inline int ip_mr_init(void)
{
	return 0;
}
#endif

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 	*/
#ifdef CONFIG_NET_NS
	struct net *mfc_net;
#endif
	__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;
};

static inline
struct net *mfc_net(const struct mfc_cache *mfc)
{
	return read_pnet(&mfc->mfc_net);
}

static inline
void mfc_net_set(struct mfc_cache *mfc, struct net *net)
{
	write_pnet(&mfc->mfc_net, hold_net(net));
}

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