xref: /linux/include/uapi/linux/mroute.h (revision bb9707077b4ee5f77bc9939b057ff8a0d410296f)
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 /* Based on the MROUTING 3.5 defines primarily to keep
8  * source compatibility with BSD.
9  *
10  * See the mrouted code for the original history.
11  *
12  * Protocol Independent Multicast (PIM) data structures included
13  * Carlos Picoto (cap@di.fc.ul.pt)
14  */
15 
16 #define MRT_BASE	200
17 #define MRT_INIT	(MRT_BASE)	/* Activate the kernel mroute code 	*/
18 #define MRT_DONE	(MRT_BASE+1)	/* Shutdown the kernel mroute		*/
19 #define MRT_ADD_VIF	(MRT_BASE+2)	/* Add a virtual interface		*/
20 #define MRT_DEL_VIF	(MRT_BASE+3)	/* Delete a virtual interface		*/
21 #define MRT_ADD_MFC	(MRT_BASE+4)	/* Add a multicast forwarding entry	*/
22 #define MRT_DEL_MFC	(MRT_BASE+5)	/* Delete a multicast forwarding entry	*/
23 #define MRT_VERSION	(MRT_BASE+6)	/* Get the kernel multicast version	*/
24 #define MRT_ASSERT	(MRT_BASE+7)	/* Activate PIM assert mode		*/
25 #define MRT_PIM		(MRT_BASE+8)	/* enable PIM code			*/
26 #define MRT_TABLE	(MRT_BASE+9)	/* Specify mroute table ID		*/
27 #define MRT_ADD_MFC_PROXY	(MRT_BASE+10)	/* Add a (*,*|G) mfc entry	*/
28 #define MRT_DEL_MFC_PROXY	(MRT_BASE+11)	/* Del a (*,*|G) mfc entry	*/
29 #define MRT_MAX		(MRT_BASE+11)
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 /* Same idea as select */
41 
42 #define VIFM_SET(n,m)	((m)|=(1<<(n)))
43 #define VIFM_CLR(n,m)	((m)&=~(1<<(n)))
44 #define VIFM_ISSET(n,m)	((m)&(1<<(n)))
45 #define VIFM_CLRALL(m)	((m)=0)
46 #define VIFM_COPY(mfrom,mto)	((mto)=(mfrom))
47 #define VIFM_SAME(m1,m2)	((m1)==(m2))
48 
49 /* Passed by mrouted for an MRT_ADD_VIF - again we use the
50  * mrouted 3.6 structures for compatibility
51  */
52 struct vifctl {
53 	vifi_t	vifc_vifi;		/* Index of VIF */
54 	unsigned char vifc_flags;	/* VIFF_ flags */
55 	unsigned char vifc_threshold;	/* ttl limit */
56 	unsigned int vifc_rate_limit;	/* Rate limiter values (NI) */
57 	union {
58 		struct in_addr vifc_lcl_addr;     /* Local interface address */
59 		int            vifc_lcl_ifindex;  /* Local interface index   */
60 	};
61 	struct in_addr vifc_rmt_addr;	/* IPIP tunnel addr */
62 };
63 
64 #define VIFF_TUNNEL		0x1	/* IPIP tunnel */
65 #define VIFF_SRCRT		0x2	/* NI */
66 #define VIFF_REGISTER		0x4	/* register vif	*/
67 #define VIFF_USE_IFINDEX	0x8	/* use vifc_lcl_ifindex instead of
68 					   vifc_lcl_addr to find an interface */
69 
70 /* Cache manipulation structures for mrouted and PIMd */
71 struct mfcctl {
72 	struct in_addr mfcc_origin;		/* Origin of mcast	*/
73 	struct in_addr mfcc_mcastgrp;		/* Group in question	*/
74 	vifi_t	mfcc_parent;			/* Where it arrived	*/
75 	unsigned char mfcc_ttls[MAXVIFS];	/* Where it is going	*/
76 	unsigned int mfcc_pkt_cnt;		/* pkt count for src-grp */
77 	unsigned int mfcc_byte_cnt;
78 	unsigned int mfcc_wrong_if;
79 	int	     mfcc_expire;
80 };
81 
82 /*  Group count retrieval for mrouted */
83 struct sioc_sg_req {
84 	struct in_addr src;
85 	struct in_addr grp;
86 	unsigned long pktcnt;
87 	unsigned long bytecnt;
88 	unsigned long wrong_if;
89 };
90 
91 /* To get vif packet counts */
92 struct sioc_vif_req {
93 	vifi_t	vifi;		/* Which iface */
94 	unsigned long icount;	/* In packets */
95 	unsigned long ocount;	/* Out packets */
96 	unsigned long ibytes;	/* In bytes */
97 	unsigned long obytes;	/* Out bytes */
98 };
99 
100 /* This is the format the mroute daemon expects to see IGMP control
101  * data. Magically happens to be like an IP packet as per the original
102  */
103 struct igmpmsg {
104 	__u32 unused1,unused2;
105 	unsigned char im_msgtype;		/* What is this */
106 	unsigned char im_mbz;			/* Must be zero */
107 	unsigned char im_vif;			/* Interface (this ought to be a vifi_t!) */
108 	unsigned char unused3;
109 	struct in_addr im_src,im_dst;
110 };
111 
112 /* That's all usermode folks */
113 
114 #define MFC_ASSERT_THRESH (3*HZ)		/* Maximal freq. of asserts */
115 
116 /* Pseudo messages used by mrouted */
117 #define IGMPMSG_NOCACHE		1		/* Kern cache fill request to mrouted */
118 #define IGMPMSG_WRONGVIF	2		/* For PIM assert processing (unused) */
119 #define IGMPMSG_WHOLEPKT	3		/* For PIM Register processing */
120 
121 #endif /* _UAPI__LINUX_MROUTE_H */
122