xref: /linux/include/uapi/linux/mroute.h (revision b889fcf63cb62e7fdb7816565e28f44dbe4a76a5)
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 
30 #define SIOCGETVIFCNT	SIOCPROTOPRIVATE	/* IP protocol privates */
31 #define SIOCGETSGCNT	(SIOCPROTOPRIVATE+1)
32 #define SIOCGETRPF	(SIOCPROTOPRIVATE+2)
33 
34 #define MAXVIFS		32
35 typedef unsigned long vifbitmap_t;	/* User mode code depends on this lot */
36 typedef unsigned short vifi_t;
37 #define ALL_VIFS	((vifi_t)(-1))
38 
39 /*
40  *	Same idea as select
41  */
42 
43 #define VIFM_SET(n,m)	((m)|=(1<<(n)))
44 #define VIFM_CLR(n,m)	((m)&=~(1<<(n)))
45 #define VIFM_ISSET(n,m)	((m)&(1<<(n)))
46 #define VIFM_CLRALL(m)	((m)=0)
47 #define VIFM_COPY(mfrom,mto)	((mto)=(mfrom))
48 #define VIFM_SAME(m1,m2)	((m1)==(m2))
49 
50 /*
51  *	Passed by mrouted for an MRT_ADD_VIF - again we use the
52  *	mrouted 3.6 structures for compatibility
53  */
54 
55 struct vifctl {
56 	vifi_t	vifc_vifi;		/* Index of VIF */
57 	unsigned char vifc_flags;	/* VIFF_ flags */
58 	unsigned char vifc_threshold;	/* ttl limit */
59 	unsigned int vifc_rate_limit;	/* Rate limiter values (NI) */
60 	union {
61 		struct in_addr vifc_lcl_addr;     /* Local interface address */
62 		int            vifc_lcl_ifindex;  /* Local interface index   */
63 	};
64 	struct in_addr vifc_rmt_addr;	/* IPIP tunnel addr */
65 };
66 
67 #define VIFF_TUNNEL		0x1	/* IPIP tunnel */
68 #define VIFF_SRCRT		0x2	/* NI */
69 #define VIFF_REGISTER		0x4	/* register vif	*/
70 #define VIFF_USE_IFINDEX	0x8	/* use vifc_lcl_ifindex instead of
71 					   vifc_lcl_addr to find an interface */
72 
73 /*
74  *	Cache manipulation structures for mrouted and PIMd
75  */
76 
77 struct mfcctl {
78 	struct in_addr mfcc_origin;		/* Origin of mcast	*/
79 	struct in_addr mfcc_mcastgrp;		/* Group in question	*/
80 	vifi_t	mfcc_parent;			/* Where it arrived	*/
81 	unsigned char mfcc_ttls[MAXVIFS];	/* Where it is going	*/
82 	unsigned int mfcc_pkt_cnt;		/* pkt count for src-grp */
83 	unsigned int mfcc_byte_cnt;
84 	unsigned int mfcc_wrong_if;
85 	int	     mfcc_expire;
86 };
87 
88 /*
89  *	Group count retrieval for mrouted
90  */
91 
92 struct sioc_sg_req {
93 	struct in_addr src;
94 	struct in_addr 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 
104 struct sioc_vif_req {
105 	vifi_t	vifi;		/* 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  *	This is the format the mroute daemon expects to see IGMP control
114  *	data. Magically happens to be like an IP packet as per the original
115  */
116 
117 struct igmpmsg {
118 	__u32 unused1,unused2;
119 	unsigned char im_msgtype;		/* What is this */
120 	unsigned char im_mbz;			/* Must be zero */
121 	unsigned char im_vif;			/* Interface (this ought to be a vifi_t!) */
122 	unsigned char unused3;
123 	struct in_addr im_src,im_dst;
124 };
125 
126 /*
127  *	That's all usermode folks
128  */
129 
130 
131 
132 #define MFC_ASSERT_THRESH (3*HZ)		/* Maximal freq. of asserts */
133 
134 /*
135  *	Pseudo messages used by mrouted
136  */
137 
138 #define IGMPMSG_NOCACHE		1		/* Kern cache fill request to mrouted */
139 #define IGMPMSG_WRONGVIF	2		/* For PIM assert processing (unused) */
140 #define IGMPMSG_WHOLEPKT	3		/* For PIM Register processing */
141 
142 
143 #endif /* _UAPI__LINUX_MROUTE_H */
144