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

/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
#ifndef _UAPI__LINUX_MROUTE_H
#define _UAPI__LINUX_MROUTE_H

#include <linux/sockios.h>
#include <linux/types.h>
#include <linux/in.h>		/* For struct in_addr. */

/* 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 MRT_TABLE	(MRT_BASE+9)	/* Specify mroute table ID		*/
#define MRT_ADD_MFC_PROXY	(MRT_BASE+10)	/* Add a (*,*|G) mfc entry	*/
#define MRT_DEL_MFC_PROXY	(MRT_BASE+11)	/* Del a (*,*|G) mfc entry	*/
#define MRT_MAX		(MRT_BASE+11)

#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;
};

/* ipmr netlink table attributes */
enum {
	IPMRA_TABLE_UNSPEC,
	IPMRA_TABLE_ID,
	IPMRA_TABLE_CACHE_RES_QUEUE_LEN,
	IPMRA_TABLE_MROUTE_REG_VIF_NUM,
	IPMRA_TABLE_MROUTE_DO_ASSERT,
	IPMRA_TABLE_MROUTE_DO_PIM,
	IPMRA_TABLE_VIFS,
	__IPMRA_TABLE_MAX
};
#define IPMRA_TABLE_MAX (__IPMRA_TABLE_MAX - 1)

/* ipmr netlink vif attribute format
 * [ IPMRA_TABLE_VIFS ] - nested attribute
 *   [ IPMRA_VIF ] - nested attribute
 *     [ IPMRA_VIFA_xxx ]
 */
enum {
	IPMRA_VIF_UNSPEC,
	IPMRA_VIF,
	__IPMRA_VIF_MAX
};
#define IPMRA_VIF_MAX (__IPMRA_VIF_MAX - 1)

/* vif-specific attributes */
enum {
	IPMRA_VIFA_UNSPEC,
	IPMRA_VIFA_IFINDEX,
	IPMRA_VIFA_VIF_ID,
	IPMRA_VIFA_FLAGS,
	IPMRA_VIFA_BYTES_IN,
	IPMRA_VIFA_BYTES_OUT,
	IPMRA_VIFA_PACKETS_IN,
	IPMRA_VIFA_PACKETS_OUT,
	IPMRA_VIFA_LOCAL_ADDR,
	IPMRA_VIFA_REMOTE_ADDR,
	IPMRA_VIFA_PAD,
	__IPMRA_VIFA_MAX
};
#define IPMRA_VIFA_MAX (__IPMRA_VIFA_MAX - 1)

/* ipmr netlink cache report attributes */
enum {
	IPMRA_CREPORT_UNSPEC,
	IPMRA_CREPORT_MSGTYPE,
	IPMRA_CREPORT_VIF_ID,
	IPMRA_CREPORT_SRC_ADDR,
	IPMRA_CREPORT_DST_ADDR,
	IPMRA_CREPORT_PKT,
	__IPMRA_CREPORT_MAX
};
#define IPMRA_CREPORT_MAX (__IPMRA_CREPORT_MAX - 1)

/* That's all usermode folks */

#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 */

#endif /* _UAPI__LINUX_MROUTE_H */
Commit	Line	Data
6f52b16c	1	/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
607ca46e DH	2	#ifndef _UAPI__LINUX_MROUTE_H
	3	#define _UAPI__LINUX_MROUTE_H
	4
	5	#include <linux/sockios.h>
	6	#include <linux/types.h>
bcb41c6b	7	#include <linux/in.h> /* For struct in_addr. */
607ca46e	8
7ef8f65d NA	9	/* Based on the MROUTING 3.5 defines primarily to keep
7ef8f65d NA	10	* source compatibility with BSD.
607ca46e	11	*
7ef8f65d	12	* See the mrouted code for the original history.
607ca46e	13	*
7ef8f65d NA	14	* Protocol Independent Multicast (PIM) data structures included
7ef8f65d NA	15	* Carlos Picoto (cap@di.fc.ul.pt)
607ca46e DH	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	#define MRT_TABLE (MRT_BASE+9) /* Specify mroute table ID */
660b26dc ND	29	#define MRT_ADD_MFC_PROXY (MRT_BASE+10) /* Add a (,\|G) mfc entry */
	30	#define MRT_DEL_MFC_PROXY (MRT_BASE+11) /* Del a (,\|G) mfc entry */
	31	#define MRT_MAX (MRT_BASE+11)
607ca46e DH	32
	33	#define SIOCGETVIFCNT SIOCPROTOPRIVATE /* IP protocol privates */
	34	#define SIOCGETSGCNT (SIOCPROTOPRIVATE+1)
	35	#define SIOCGETRPF (SIOCPROTOPRIVATE+2)
	36
7ef8f65d	37	#define MAXVIFS 32
607ca46e DH	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
7ef8f65d NA	42	/* Same idea as select */
7ef8f65d NA	43
607ca46e DH	44	#define VIFM_SET(n,m) ((m)\|=(1<<(n)))
	45	#define VIFM_CLR(n,m) ((m)&=~(1<<(n)))
	46	#define VIFM_ISSET(n,m) ((m)&(1<<(n)))
	47	#define VIFM_CLRALL(m) ((m)=0)
	48	#define VIFM_COPY(mfrom,mto) ((mto)=(mfrom))
	49	#define VIFM_SAME(m1,m2) ((m1)==(m2))
	50
7ef8f65d NA	51	/* Passed by mrouted for an MRT_ADD_VIF - again we use the
7ef8f65d NA	52	* mrouted 3.6 structures for compatibility
607ca46e	53	*/
607ca46e DH	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	union {
	60	struct in_addr vifc_lcl_addr; /* Local interface address */
	61	int vifc_lcl_ifindex; /* Local interface index */
	62	};
	63	struct in_addr vifc_rmt_addr; /* IPIP tunnel addr */
	64	};
	65
	66	#define VIFF_TUNNEL 0x1 /* IPIP tunnel */
	67	#define VIFF_SRCRT 0x2 /* NI */
	68	#define VIFF_REGISTER 0x4 /* register vif */
	69	#define VIFF_USE_IFINDEX 0x8 /* use vifc_lcl_ifindex instead of
	70	vifc_lcl_addr to find an interface */
	71
7ef8f65d	72	/* Cache manipulation structures for mrouted and PIMd */
607ca46e DH	73	struct mfcctl {
	74	struct in_addr mfcc_origin; /* Origin of mcast */
	75	struct in_addr mfcc_mcastgrp; /* Group in question */
	76	vifi_t mfcc_parent; /* Where it arrived */
	77	unsigned char mfcc_ttls[MAXVIFS]; /* Where it is going */
	78	unsigned int mfcc_pkt_cnt; /* pkt count for src-grp */
	79	unsigned int mfcc_byte_cnt;
	80	unsigned int mfcc_wrong_if;
	81	int mfcc_expire;
	82	};
	83
7ef8f65d	84	/* Group count retrieval for mrouted */
607ca46e DH	85	struct sioc_sg_req {
	86	struct in_addr src;
	87	struct in_addr grp;
	88	unsigned long pktcnt;
	89	unsigned long bytecnt;
	90	unsigned long wrong_if;
	91	};
	92
7ef8f65d	93	/* To get vif packet counts */
607ca46e DH	94	struct sioc_vif_req {
	95	vifi_t vifi; /* Which iface */
	96	unsigned long icount; /* In packets */
	97	unsigned long ocount; /* Out packets */
	98	unsigned long ibytes; /* In bytes */
	99	unsigned long obytes; /* Out bytes */
	100	};
	101
7ef8f65d NA	102	/* This is the format the mroute daemon expects to see IGMP control
7ef8f65d NA	103	* data. Magically happens to be like an IP packet as per the original
607ca46e	104	*/
607ca46e DH	105	struct igmpmsg {
	106	__u32 unused1,unused2;
	107	unsigned char im_msgtype; /* What is this */
	108	unsigned char im_mbz; /* Must be zero */
	109	unsigned char im_vif; /* Interface (this ought to be a vifi_t!) */
	110	unsigned char unused3;
	111	struct in_addr im_src,im_dst;
	112	};
	113
772c344d NA	114	/* ipmr netlink table attributes */
	115	enum {
	116	IPMRA_TABLE_UNSPEC,
	117	IPMRA_TABLE_ID,
	118	IPMRA_TABLE_CACHE_RES_QUEUE_LEN,
	119	IPMRA_TABLE_MROUTE_REG_VIF_NUM,
	120	IPMRA_TABLE_MROUTE_DO_ASSERT,
	121	IPMRA_TABLE_MROUTE_DO_PIM,
	122	IPMRA_TABLE_VIFS,
	123	__IPMRA_TABLE_MAX
	124	};
	125	#define IPMRA_TABLE_MAX (__IPMRA_TABLE_MAX - 1)
	126
	127	/* ipmr netlink vif attribute format
	128	* [ IPMRA_TABLE_VIFS ] - nested attribute
	129	* [ IPMRA_VIF ] - nested attribute
	130	* [ IPMRA_VIFA_xxx ]
	131	*/
	132	enum {
	133	IPMRA_VIF_UNSPEC,
	134	IPMRA_VIF,
	135	__IPMRA_VIF_MAX
	136	};
	137	#define IPMRA_VIF_MAX (__IPMRA_VIF_MAX - 1)
	138
	139	/* vif-specific attributes */
	140	enum {
	141	IPMRA_VIFA_UNSPEC,
	142	IPMRA_VIFA_IFINDEX,
	143	IPMRA_VIFA_VIF_ID,
	144	IPMRA_VIFA_FLAGS,
	145	IPMRA_VIFA_BYTES_IN,
	146	IPMRA_VIFA_BYTES_OUT,
	147	IPMRA_VIFA_PACKETS_IN,
	148	IPMRA_VIFA_PACKETS_OUT,
	149	IPMRA_VIFA_LOCAL_ADDR,
	150	IPMRA_VIFA_REMOTE_ADDR,
	151	IPMRA_VIFA_PAD,
	152	__IPMRA_VIFA_MAX
	153	};
	154	#define IPMRA_VIFA_MAX (__IPMRA_VIFA_MAX - 1)
	155
5a645dd8 JG	156	/* ipmr netlink cache report attributes */
	157	enum {
	158	IPMRA_CREPORT_UNSPEC,
	159	IPMRA_CREPORT_MSGTYPE,
	160	IPMRA_CREPORT_VIF_ID,
	161	IPMRA_CREPORT_SRC_ADDR,
	162	IPMRA_CREPORT_DST_ADDR,
	163	IPMRA_CREPORT_PKT,
	164	__IPMRA_CREPORT_MAX
	165	};
	166	#define IPMRA_CREPORT_MAX (__IPMRA_CREPORT_MAX - 1)
	167
7ef8f65d	168	/* That's all usermode folks */
607ca46e DH	169
	170	#define MFC_ASSERT_THRESH (3HZ) / Maximal freq. of asserts */
	171
7ef8f65d	172	/* Pseudo messages used by mrouted */
607ca46e DH	173	#define IGMPMSG_NOCACHE 1 /* Kern cache fill request to mrouted */
	174	#define IGMPMSG_WRONGVIF 2 /* For PIM assert processing (unused) */
	175	#define IGMPMSG_WHOLEPKT 3 /* For PIM Register processing */
	176
607ca46e	177	#endif /* _UAPI__LINUX_MROUTE_H */