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

#ifndef __LINUX_MROUTE6_H
#define __LINUX_MROUTE6_H

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

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

#define MRT6_BASE	200
#define MRT6_INIT	(MRT6_BASE)	/* Activate the kernel mroute code 	*/
#define MRT6_DONE	(MRT6_BASE+1)	/* Shutdown the kernel mroute		*/
#define MRT6_ADD_MIF	(MRT6_BASE+2)	/* Add a virtual interface		*/
#define MRT6_DEL_MIF	(MRT6_BASE+3)	/* Delete a virtual interface		*/
#define MRT6_ADD_MFC	(MRT6_BASE+4)	/* Add a multicast forwarding entry	*/
#define MRT6_DEL_MFC	(MRT6_BASE+5)	/* Delete a multicast forwarding entry	*/
#define MRT6_VERSION	(MRT6_BASE+6)	/* Get the kernel multicast version	*/
#define MRT6_ASSERT	(MRT6_BASE+7)	/* Activate PIM assert mode		*/
#define MRT6_PIM	(MRT6_BASE+8)	/* enable PIM code			*/
#define MRT6_TABLE	(MRT6_BASE+9)	/* Specify mroute table ID		*/

#define SIOCGETMIFCNT_IN6	SIOCPROTOPRIVATE	/* IP protocol privates */
#define SIOCGETSGCNT_IN6	(SIOCPROTOPRIVATE+1)
#define SIOCGETRPF	(SIOCPROTOPRIVATE+2)

#define MAXMIFS		32
typedef unsigned long mifbitmap_t;	/* User mode code depends on this lot */
typedef unsigned short mifi_t;
#define ALL_MIFS	((mifi_t)(-1))

#ifndef IF_SETSIZE
#define IF_SETSIZE	256
#endif

typedef	__u32		if_mask;
#define NIFBITS (sizeof(if_mask) * 8)        /* bits per mask */

#if !defined(__KERNEL__)
#if !defined(DIV_ROUND_UP)
#define	DIV_ROUND_UP(x,y)	(((x) + ((y) - 1)) / (y))
#endif
#endif

typedef struct if_set {
	if_mask ifs_bits[DIV_ROUND_UP(IF_SETSIZE, NIFBITS)];
} if_set;

#define IF_SET(n, p)    ((p)->ifs_bits[(n)/NIFBITS] |= (1 << ((n) % NIFBITS)))
#define IF_CLR(n, p)    ((p)->ifs_bits[(n)/NIFBITS] &= ~(1 << ((n) % NIFBITS)))
#define IF_ISSET(n, p)  ((p)->ifs_bits[(n)/NIFBITS] & (1 << ((n) % NIFBITS)))
#define IF_COPY(f, t)   bcopy(f, t, sizeof(*(f)))
#define IF_ZERO(p)      bzero(p, sizeof(*(p)))

/*
 *	Passed by mrouted for an MRT_ADD_MIF - again we use the
 *	mrouted 3.6 structures for compatibility
 */

struct mif6ctl {
	mifi_t	mif6c_mifi;		/* Index of MIF */
	unsigned char mif6c_flags;	/* MIFF_ flags */
	unsigned char vifc_threshold;	/* ttl limit */
	__u16	 mif6c_pifi;		/* the index of the physical IF */
	unsigned int vifc_rate_limit;	/* Rate limiter values (NI) */
};

#define MIFF_REGISTER	0x1	/* register vif	*/

/*
 *	Cache manipulation structures for mrouted and PIMd
 */

struct mf6cctl {
	struct sockaddr_in6 mf6cc_origin;		/* Origin of mcast	*/
	struct sockaddr_in6 mf6cc_mcastgrp;		/* Group in question	*/
	mifi_t	mf6cc_parent;			/* Where it arrived	*/
	struct if_set mf6cc_ifset;		/* Where it is going */
};

/*
 *	Group count retrieval for pim6sd
 */

struct sioc_sg_req6 {
	struct sockaddr_in6 src;
	struct sockaddr_in6 grp;
	unsigned long pktcnt;
	unsigned long bytecnt;
	unsigned long wrong_if;
};

/*
 *	To get vif packet counts
 */

struct sioc_mif_req6 {
	mifi_t	mifi;		/* Which iface */
	unsigned long icount;	/* In packets */
	unsigned long ocount;	/* Out packets */
	unsigned long ibytes;	/* In bytes */
	unsigned long obytes;	/* Out bytes */
};

/*
 *	That's all usermode folks
 */

#ifdef __KERNEL__

#include <linux/pim.h>
#include <linux/skbuff.h>	/* for struct sk_buff_head */
#include <net/net_namespace.h>

#ifdef CONFIG_IPV6_MROUTE
static inline int ip6_mroute_opt(int opt)
{
	return (opt >= MRT6_BASE) && (opt <= MRT6_BASE + 10);
}
#else
static inline int ip6_mroute_opt(int opt)
{
	return 0;
}
#endif

struct sock;

#ifdef CONFIG_IPV6_MROUTE
extern int ip6_mroute_setsockopt(struct sock *, int, char __user *, unsigned int);
extern int ip6_mroute_getsockopt(struct sock *, int, char __user *, int __user *);
extern int ip6_mr_input(struct sk_buff *skb);
extern int ip6mr_ioctl(struct sock *sk, int cmd, void __user *arg);
extern int ip6mr_compat_ioctl(struct sock *sk, unsigned int cmd, void __user *arg);
extern int ip6_mr_init(void);
extern void ip6_mr_cleanup(void);
#else
static inline
int ip6_mroute_setsockopt(struct sock *sock,
			  int optname, char __user *optval, unsigned int optlen)
{
	return -ENOPROTOOPT;
}

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

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

static inline int ip6_mr_init(void)
{
	return 0;
}

static inline void ip6_mr_cleanup(void)
{
	return;
}
#endif

struct mif_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 		*/
	int		link;			/* Physical interface index	*/
};

#define VIFF_STATIC 0x8000

struct mfc6_cache {
	struct list_head list;
	struct in6_addr mf6c_mcastgrp;			/* Group the entry belongs to 	*/
	struct in6_addr mf6c_origin;			/* Source of packet 		*/
	mifi_t mf6c_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[MAXMIFS];	/* TTL thresholds		*/
		} res;
	} mfc_un;
};

#define MFC_STATIC		1
#define MFC_NOTIFY		2

#define MFC6_LINES		64

#define MFC6_HASH(a, g) (((__force u32)(a)->s6_addr32[0] ^ \
			  (__force u32)(a)->s6_addr32[1] ^ \
			  (__force u32)(a)->s6_addr32[2] ^ \
			  (__force u32)(a)->s6_addr32[3] ^ \
			  (__force u32)(g)->s6_addr32[0] ^ \
			  (__force u32)(g)->s6_addr32[1] ^ \
			  (__force u32)(g)->s6_addr32[2] ^ \
			  (__force u32)(g)->s6_addr32[3]) % MFC6_LINES)

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

#endif

#ifdef __KERNEL__
struct rtmsg;
extern int ip6mr_get_route(struct net *net, struct sk_buff *skb,
			   struct rtmsg *rtm, int nowait);

#ifdef CONFIG_IPV6_MROUTE
extern struct sock *mroute6_socket(struct net *net, struct sk_buff *skb);
extern int ip6mr_sk_done(struct sock *sk);
#else
static inline struct sock *mroute6_socket(struct net *net, struct sk_buff *skb)
{
	return NULL;
}
static inline int ip6mr_sk_done(struct sock *sk)
{
	return 0;
}
#endif
#endif

/*
 * Structure used to communicate from kernel to multicast router.
 * We'll overlay the structure onto an MLD header (not an IPv6 heder like igmpmsg{}
 * used for IPv4 implementation). This is because this structure will be passed via an
 * IPv6 raw socket, on which an application will only receiver the payload i.e the data after
 * the IPv6 header and all the extension headers. (See section 3 of RFC 3542)
 */

struct mrt6msg {
#define MRT6MSG_NOCACHE		1
#define MRT6MSG_WRONGMIF	2
#define MRT6MSG_WHOLEPKT	3		/* used for use level encap */
	__u8		im6_mbz;		/* must be zero		   */
	__u8		im6_msgtype;		/* what type of message    */
	__u16		im6_mif;		/* mif rec'd on		   */
	__u32		im6_pad;		/* padding for 64 bit arch */
	struct in6_addr	im6_src, im6_dst;
};

#endif
Commit	Line	Data
7bc570c8 YH	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 */
14fb64e1	26	#define MRT6_ASSERT (MRT6_BASE+7) /* Activate PIM assert mode */
d1db275d PM	27	#define MRT6_PIM (MRT6_BASE+8) /* enable PIM code */
d1db275d PM	28	#define MRT6_TABLE (MRT6_BASE+9) /* Specify mroute table ID */
7bc570c8 YH	29
	30	#define SIOCGETMIFCNT_IN6 SIOCPROTOPRIVATE /* IP protocol privates */
	31	#define SIOCGETSGCNT_IN6 (SIOCPROTOPRIVATE+1)
	32	#define SIOCGETRPF (SIOCPROTOPRIVATE+2)
	33
	34	#define MAXMIFS 32
	35	typedef unsigned long mifbitmap_t; /* User mode code depends on this lot */
	36	typedef unsigned short mifi_t;
	37	#define ALL_MIFS ((mifi_t)(-1))
	38
	39	#ifndef IF_SETSIZE
	40	#define IF_SETSIZE 256
	41	#endif
	42
	43	typedef __u32 if_mask;
	44	#define NIFBITS (sizeof(if_mask) * 8) /* bits per mask */
	45
1632b9e2 DH	46	#if !defined(__KERNEL__)
1632b9e2 DH	47	#if !defined(DIV_ROUND_UP)
7bc570c8 YH	48	#define DIV_ROUND_UP(x,y) (((x) + ((y) - 1)) / (y))
7bc570c8 YH	49	#endif
1632b9e2	50	#endif
7bc570c8 YH	51
	52	typedef struct if_set {
	53	if_mask ifs_bits[DIV_ROUND_UP(IF_SETSIZE, NIFBITS)];
	54	} if_set;
	55
	56	#define IF_SET(n, p) ((p)->ifs_bits[(n)/NIFBITS] \|= (1 << ((n) % NIFBITS)))
	57	#define IF_CLR(n, p) ((p)->ifs_bits[(n)/NIFBITS] &= ~(1 << ((n) % NIFBITS)))
	58	#define IF_ISSET(n, p) ((p)->ifs_bits[(n)/NIFBITS] & (1 << ((n) % NIFBITS)))
	59	#define IF_COPY(f, t) bcopy(f, t, sizeof(*(f)))
	60	#define IF_ZERO(p) bzero(p, sizeof(*(p)))
	61
	62	/*
	63	* Passed by mrouted for an MRT_ADD_MIF - again we use the
	64	* mrouted 3.6 structures for compatibility
	65	*/
	66
	67	struct mif6ctl {
	68	mifi_t mif6c_mifi; /* Index of MIF */
	69	unsigned char mif6c_flags; /* MIFF_ flags */
	70	unsigned char vifc_threshold; /* ttl limit */
85efde6f	71	__u16 mif6c_pifi; /* the index of the physical IF */
7bc570c8 YH	72	unsigned int vifc_rate_limit; /* Rate limiter values (NI) */
	73	};
	74
	75	#define MIFF_REGISTER 0x1 /* register vif */
	76
	77	/*
	78	* Cache manipulation structures for mrouted and PIMd
	79	*/
	80
d94d9fee	81	struct mf6cctl {
7bc570c8 YH	82	struct sockaddr_in6 mf6cc_origin; /* Origin of mcast */
	83	struct sockaddr_in6 mf6cc_mcastgrp; /* Group in question */
	84	mifi_t mf6cc_parent; /* Where it arrived */
	85	struct if_set mf6cc_ifset; /* Where it is going */
	86	};
	87
	88	/*
	89	* Group count retrieval for pim6sd
	90	*/
	91
d94d9fee	92	struct sioc_sg_req6 {
7bc570c8 YH	93	struct sockaddr_in6 src;
	94	struct sockaddr_in6 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
d94d9fee	104	struct sioc_mif_req6 {
7bc570c8 YH	105	mifi_t mifi; /* Which iface */
	106	unsigned long icount; /* In packets */
	107	unsigned long ocount; /* Out packets */
	108	unsigned long ibytes; /* In bytes */
	109	unsigned long obytes; /* Out bytes */
	110	};
	111
	112	/*
	113	* That's all usermode folks
	114	*/
	115
	116	#ifdef __KERNEL__
	117
7c19a3d2	118	#include <linux/pim.h>
7bc570c8	119	#include <linux/skbuff.h> /* for struct sk_buff_head */
bd91b8bf	120	#include <net/net_namespace.h>
7bc570c8	121
7bc570c8 YH	122	#ifdef CONFIG_IPV6_MROUTE
	123	static inline int ip6_mroute_opt(int opt)
	124	{
	125	return (opt >= MRT6_BASE) && (opt <= MRT6_BASE + 10);
	126	}
	127	#else
	128	static inline int ip6_mroute_opt(int opt)
	129	{
	130	return 0;
	131	}
	132	#endif
	133
	134	struct sock;
	135
e0835f8f	136	#ifdef CONFIG_IPV6_MROUTE
b7058842	137	extern int ip6_mroute_setsockopt(struct sock , int, char __user , unsigned int);
7bc570c8 YH	138	extern int ip6_mroute_getsockopt(struct sock , int, char __user , int __user *);
	139	extern int ip6_mr_input(struct sk_buff *skb);
	140	extern int ip6mr_ioctl(struct sock sk, int cmd, void __user arg);
e2d57766	141	extern int ip6mr_compat_ioctl(struct sock sk, unsigned int cmd, void __user arg);
623d1a1a WC	142	extern int ip6_mr_init(void);
623d1a1a WC	143	extern void ip6_mr_cleanup(void);
e0835f8f YH	144	#else
	145	static inline
	146	int ip6_mroute_setsockopt(struct sock *sock,
b7058842	147	int optname, char __user *optval, unsigned int optlen)
e0835f8f YH	148	{
	149	return -ENOPROTOOPT;
	150	}
	151
	152	static inline
	153	int ip6_mroute_getsockopt(struct sock *sock,
	154	int optname, char __user optval, int __user optlen)
	155	{
	156	return -ENOPROTOOPT;
	157	}
	158
	159	static inline
	160	int ip6mr_ioctl(struct sock sk, int cmd, void __user arg)
	161	{
	162	return -ENOIOCTLCMD;
	163	}
	164
	165	static inline int ip6_mr_init(void)
	166	{
	167	return 0;
	168	}
	169
	170	static inline void ip6_mr_cleanup(void)
	171	{
	172	return;
	173	}
	174	#endif
7bc570c8	175
d94d9fee	176	struct mif_device {
7bc570c8 YH	177	struct net_device dev; / Device we are using */
	178	unsigned long bytes_in,bytes_out;
	179	unsigned long pkt_in,pkt_out; /* Statistics */
	180	unsigned long rate_limit; /* Traffic shaping (NI) */
	181	unsigned char threshold; /* TTL threshold */
	182	unsigned short flags; /* Control flags */
	183	int link; /* Physical interface index */
	184	};
	185
	186	#define VIFF_STATIC 0x8000
	187
d94d9fee	188	struct mfc6_cache {
f30a7784	189	struct list_head list;
7bc570c8 YH	190	struct in6_addr mf6c_mcastgrp; /* Group the entry belongs to */
	191	struct in6_addr mf6c_origin; /* Source of packet */
	192	mifi_t mf6c_parent; /* Source interface */
	193	int mfc_flags; /* Flags on line */
	194
	195	union {
	196	struct {
	197	unsigned long expires;
	198	struct sk_buff_head unresolved; /* Unresolved buffers */
	199	} unres;
	200	struct {
	201	unsigned long last_assert;
	202	int minvif;
	203	int maxvif;
	204	unsigned long bytes;
	205	unsigned long pkt;
	206	unsigned long wrong_if;
	207	unsigned char ttls[MAXMIFS]; /* TTL thresholds */
	208	} res;
	209	} mfc_un;
	210	};
	211
	212	#define MFC_STATIC 1
	213	#define MFC_NOTIFY 2
	214
	215	#define MFC6_LINES 64
	216
	217	#define MFC6_HASH(a, g) (((__force u32)(a)->s6_addr32[0] ^ \
	218	(__force u32)(a)->s6_addr32[1] ^ \
	219	(__force u32)(a)->s6_addr32[2] ^ \
	220	(__force u32)(a)->s6_addr32[3] ^ \
	221	(__force u32)(g)->s6_addr32[0] ^ \
	222	(__force u32)(g)->s6_addr32[1] ^ \
	223	(__force u32)(g)->s6_addr32[2] ^ \
	224	(__force u32)(g)->s6_addr32[3]) % MFC6_LINES)
	225
	226	#define MFC_ASSERT_THRESH (3HZ) / Maximal freq. of asserts */
	227
	228	#endif
	229
	230	#ifdef __KERNEL__
	231	struct rtmsg;
8229efda BT	232	extern int ip6mr_get_route(struct net net, struct sk_buff skb,
8229efda BT	233	struct rtmsg *rtm, int nowait);
7bc570c8 YH	234
7bc570c8 YH	235	#ifdef CONFIG_IPV6_MROUTE
d1db275d	236	extern struct sock mroute6_socket(struct net net, struct sk_buff *skb);
7bc570c8 YH	237	extern int ip6mr_sk_done(struct sock *sk);
7bc570c8 YH	238	#else
d1db275d PM	239	static inline struct sock mroute6_socket(struct net net, struct sk_buff *skb)
	240	{
	241	return NULL;
	242	}
	243	static inline int ip6mr_sk_done(struct sock *sk)
	244	{
	245	return 0;
	246	}
7bc570c8 YH	247	#endif
	248	#endif
	249
	250	/*
	251	* Structure used to communicate from kernel to multicast router.
	252	* We'll overlay the structure onto an MLD header (not an IPv6 heder like igmpmsg{}
	253	* used for IPv4 implementation). This is because this structure will be passed via an
25985edc	254	* IPv6 raw socket, on which an application will only receiver the payload i.e the data after
7bc570c8 YH	255	* the IPv6 header and all the extension headers. (See section 3 of RFC 3542)
	256	*/
	257
	258	struct mrt6msg {
	259	#define MRT6MSG_NOCACHE 1
14fb64e1 YH	260	#define MRT6MSG_WRONGMIF 2
14fb64e1 YH	261	#define MRT6MSG_WHOLEPKT 3 /* used for use level encap */
7bc570c8 YH	262	__u8 im6_mbz; /* must be zero */
	263	__u8 im6_msgtype; /* what type of message */
	264	__u16 im6_mif; /* mif rec'd on */
	265	__u32 im6_pad; /* padding for 64 bit arch */
	266	struct in6_addr im6_src, im6_dst;
	267	};
	268
	269	#endif