xref: /linux/include/uapi/linux/mroute.h (revision c4ee0af3fa0dc65f690fc908f02b8355f9576ea0)
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 (cap@di.fc.ul.pt)
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_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)
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 	union {
64 		struct in_addr vifc_lcl_addr;     /* Local interface address */
65 		int            vifc_lcl_ifindex;  /* Local interface index   */
66 	};
67 	struct in_addr vifc_rmt_addr;	/* IPIP tunnel addr */
68 };
69 
70 #define VIFF_TUNNEL		0x1	/* IPIP tunnel */
71 #define VIFF_SRCRT		0x2	/* NI */
72 #define VIFF_REGISTER		0x4	/* register vif	*/
73 #define VIFF_USE_IFINDEX	0x8	/* use vifc_lcl_ifindex instead of
74 					   vifc_lcl_addr to find an interface */
75 
76 /*
77  *	Cache manipulation structures for mrouted and PIMd
78  */
79 
80 struct mfcctl {
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 	struct in_addr src;
97 	struct in_addr grp;
98 	unsigned long pktcnt;
99 	unsigned long bytecnt;
100 	unsigned long wrong_if;
101 };
102 
103 /*
104  *	To get vif packet counts
105  */
106 
107 struct sioc_vif_req {
108 	vifi_t	vifi;		/* Which iface */
109 	unsigned long icount;	/* In packets */
110 	unsigned long ocount;	/* Out packets */
111 	unsigned long ibytes;	/* In bytes */
112 	unsigned long obytes;	/* Out bytes */
113 };
114 
115 /*
116  *	This is the format the mroute daemon expects to see IGMP control
117  *	data. Magically happens to be like an IP packet as per the original
118  */
119 
120 struct igmpmsg {
121 	__u32 unused1,unused2;
122 	unsigned char im_msgtype;		/* What is this */
123 	unsigned char im_mbz;			/* Must be zero */
124 	unsigned char im_vif;			/* Interface (this ought to be a vifi_t!) */
125 	unsigned char unused3;
126 	struct in_addr im_src,im_dst;
127 };
128 
129 /*
130  *	That's all usermode folks
131  */
132 
133 
134 
135 #define MFC_ASSERT_THRESH (3*HZ)		/* Maximal freq. of asserts */
136 
137 /*
138  *	Pseudo messages used by mrouted
139  */
140 
141 #define IGMPMSG_NOCACHE		1		/* Kern cache fill request to mrouted */
142 #define IGMPMSG_WRONGVIF	2		/* For PIM assert processing (unused) */
143 #define IGMPMSG_WHOLEPKT	3		/* For PIM Register processing */
144 
145 
146 #endif /* _UAPI__LINUX_MROUTE_H */
147