xref: /linux-6.15/include/uapi/linux/mroute.h (revision bbb923a4)
1 #ifndef _UAPI__LINUX_MROUTE_H
2 #define _UAPI__LINUX_MROUTE_H
3 
4 #include <linux/sockios.h>
5 #include <linux/types.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 ([email protected])
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 #define MRT_TABLE	(MRT_BASE+9)	/* Specify mroute table ID		*/
29 #define MRT_MAX		(MRT_BASE+9)
30 
31 #define SIOCGETVIFCNT	SIOCPROTOPRIVATE	/* IP protocol privates */
32 #define SIOCGETSGCNT	(SIOCPROTOPRIVATE+1)
33 #define SIOCGETRPF	(SIOCPROTOPRIVATE+2)
34 
35 #define MAXVIFS		32
36 typedef unsigned long vifbitmap_t;	/* User mode code depends on this lot */
37 typedef unsigned short vifi_t;
38 #define ALL_VIFS	((vifi_t)(-1))
39 
40 /*
41  *	Same idea as select
42  */
43 
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 
51 /*
52  *	Passed by mrouted for an MRT_ADD_VIF - again we use the
53  *	mrouted 3.6 structures for compatibility
54  */
55 
56 struct vifctl {
57 	vifi_t	vifc_vifi;		/* Index of VIF */
58 	unsigned char vifc_flags;	/* VIFF_ flags */
59 	unsigned char vifc_threshold;	/* ttl limit */
60 	unsigned int vifc_rate_limit;	/* Rate limiter values (NI) */
61 	union {
62 		struct in_addr vifc_lcl_addr;     /* Local interface address */
63 		int            vifc_lcl_ifindex;  /* Local interface index   */
64 	};
65 	struct in_addr vifc_rmt_addr;	/* IPIP tunnel addr */
66 };
67 
68 #define VIFF_TUNNEL		0x1	/* IPIP tunnel */
69 #define VIFF_SRCRT		0x2	/* NI */
70 #define VIFF_REGISTER		0x4	/* register vif	*/
71 #define VIFF_USE_IFINDEX	0x8	/* use vifc_lcl_ifindex instead of
72 					   vifc_lcl_addr to find an interface */
73 
74 /*
75  *	Cache manipulation structures for mrouted and PIMd
76  */
77 
78 struct mfcctl {
79 	struct in_addr mfcc_origin;		/* Origin of mcast	*/
80 	struct in_addr mfcc_mcastgrp;		/* Group in question	*/
81 	vifi_t	mfcc_parent;			/* Where it arrived	*/
82 	unsigned char mfcc_ttls[MAXVIFS];	/* Where it is going	*/
83 	unsigned int mfcc_pkt_cnt;		/* pkt count for src-grp */
84 	unsigned int mfcc_byte_cnt;
85 	unsigned int mfcc_wrong_if;
86 	int	     mfcc_expire;
87 };
88 
89 /*
90  *	Group count retrieval for mrouted
91  */
92 
93 struct sioc_sg_req {
94 	struct in_addr src;
95 	struct in_addr grp;
96 	unsigned long pktcnt;
97 	unsigned long bytecnt;
98 	unsigned long wrong_if;
99 };
100 
101 /*
102  *	To get vif packet counts
103  */
104 
105 struct sioc_vif_req {
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 	__u32 unused1,unused2;
120 	unsigned char im_msgtype;		/* What is this */
121 	unsigned char im_mbz;			/* Must be zero */
122 	unsigned char im_vif;			/* Interface (this ought to be a vifi_t!) */
123 	unsigned char unused3;
124 	struct in_addr im_src,im_dst;
125 };
126 
127 /*
128  *	That's all usermode folks
129  */
130 
131 
132 
133 #define MFC_ASSERT_THRESH (3*HZ)		/* Maximal freq. of asserts */
134 
135 /*
136  *	Pseudo messages used by mrouted
137  */
138 
139 #define IGMPMSG_NOCACHE		1		/* Kern cache fill request to mrouted */
140 #define IGMPMSG_WRONGVIF	2		/* For PIM assert processing (unused) */
141 #define IGMPMSG_WHOLEPKT	3		/* For PIM Register processing */
142 
143 
144 #endif /* _UAPI__LINUX_MROUTE_H */
145