xref: /linux/include/uapi/linux/mroute.h (revision 74ce1896c6c65b2f8cccbf59162d542988835835)
1 #ifndef _UAPI__LINUX_MROUTE_H
2 #define _UAPI__LINUX_MROUTE_H
3 
4 #include <linux/sockios.h>
5 #include <linux/types.h>
6 #include <linux/in.h>		/* For struct in_addr. */
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 #define MRT_BASE	200
18 #define MRT_INIT	(MRT_BASE)	/* Activate the kernel mroute code 	*/
19 #define MRT_DONE	(MRT_BASE+1)	/* Shutdown the kernel mroute		*/
20 #define MRT_ADD_VIF	(MRT_BASE+2)	/* Add a virtual interface		*/
21 #define MRT_DEL_VIF	(MRT_BASE+3)	/* Delete a virtual interface		*/
22 #define MRT_ADD_MFC	(MRT_BASE+4)	/* Add a multicast forwarding entry	*/
23 #define MRT_DEL_MFC	(MRT_BASE+5)	/* Delete a multicast forwarding entry	*/
24 #define MRT_VERSION	(MRT_BASE+6)	/* Get the kernel multicast version	*/
25 #define MRT_ASSERT	(MRT_BASE+7)	/* Activate PIM assert mode		*/
26 #define MRT_PIM		(MRT_BASE+8)	/* enable PIM code			*/
27 #define MRT_TABLE	(MRT_BASE+9)	/* Specify mroute table ID		*/
28 #define MRT_ADD_MFC_PROXY	(MRT_BASE+10)	/* Add a (*,*|G) mfc entry	*/
29 #define MRT_DEL_MFC_PROXY	(MRT_BASE+11)	/* Del a (*,*|G) mfc entry	*/
30 #define MRT_MAX		(MRT_BASE+11)
31 
32 #define SIOCGETVIFCNT	SIOCPROTOPRIVATE	/* IP protocol privates */
33 #define SIOCGETSGCNT	(SIOCPROTOPRIVATE+1)
34 #define SIOCGETRPF	(SIOCPROTOPRIVATE+2)
35 
36 #define MAXVIFS		32
37 typedef unsigned long vifbitmap_t;	/* User mode code depends on this lot */
38 typedef unsigned short vifi_t;
39 #define ALL_VIFS	((vifi_t)(-1))
40 
41 /* Same idea as select */
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 /* Passed by mrouted for an MRT_ADD_VIF - again we use the
51  * mrouted 3.6 structures for compatibility
52  */
53 struct vifctl {
54 	vifi_t	vifc_vifi;		/* Index of VIF */
55 	unsigned char vifc_flags;	/* VIFF_ flags */
56 	unsigned char vifc_threshold;	/* ttl limit */
57 	unsigned int vifc_rate_limit;	/* Rate limiter values (NI) */
58 	union {
59 		struct in_addr vifc_lcl_addr;     /* Local interface address */
60 		int            vifc_lcl_ifindex;  /* Local interface index   */
61 	};
62 	struct in_addr vifc_rmt_addr;	/* IPIP tunnel addr */
63 };
64 
65 #define VIFF_TUNNEL		0x1	/* IPIP tunnel */
66 #define VIFF_SRCRT		0x2	/* NI */
67 #define VIFF_REGISTER		0x4	/* register vif	*/
68 #define VIFF_USE_IFINDEX	0x8	/* use vifc_lcl_ifindex instead of
69 					   vifc_lcl_addr to find an interface */
70 
71 /* Cache manipulation structures for mrouted and PIMd */
72 struct mfcctl {
73 	struct in_addr mfcc_origin;		/* Origin of mcast	*/
74 	struct in_addr mfcc_mcastgrp;		/* Group in question	*/
75 	vifi_t	mfcc_parent;			/* Where it arrived	*/
76 	unsigned char mfcc_ttls[MAXVIFS];	/* Where it is going	*/
77 	unsigned int mfcc_pkt_cnt;		/* pkt count for src-grp */
78 	unsigned int mfcc_byte_cnt;
79 	unsigned int mfcc_wrong_if;
80 	int	     mfcc_expire;
81 };
82 
83 /*  Group count retrieval for mrouted */
84 struct sioc_sg_req {
85 	struct in_addr src;
86 	struct in_addr grp;
87 	unsigned long pktcnt;
88 	unsigned long bytecnt;
89 	unsigned long wrong_if;
90 };
91 
92 /* To get vif packet counts */
93 struct sioc_vif_req {
94 	vifi_t	vifi;		/* Which iface */
95 	unsigned long icount;	/* In packets */
96 	unsigned long ocount;	/* Out packets */
97 	unsigned long ibytes;	/* In bytes */
98 	unsigned long obytes;	/* Out bytes */
99 };
100 
101 /* This is the format the mroute daemon expects to see IGMP control
102  * data. Magically happens to be like an IP packet as per the original
103  */
104 struct igmpmsg {
105 	__u32 unused1,unused2;
106 	unsigned char im_msgtype;		/* What is this */
107 	unsigned char im_mbz;			/* Must be zero */
108 	unsigned char im_vif;			/* Interface (this ought to be a vifi_t!) */
109 	unsigned char unused3;
110 	struct in_addr im_src,im_dst;
111 };
112 
113 /* ipmr netlink table attributes */
114 enum {
115 	IPMRA_TABLE_UNSPEC,
116 	IPMRA_TABLE_ID,
117 	IPMRA_TABLE_CACHE_RES_QUEUE_LEN,
118 	IPMRA_TABLE_MROUTE_REG_VIF_NUM,
119 	IPMRA_TABLE_MROUTE_DO_ASSERT,
120 	IPMRA_TABLE_MROUTE_DO_PIM,
121 	IPMRA_TABLE_VIFS,
122 	__IPMRA_TABLE_MAX
123 };
124 #define IPMRA_TABLE_MAX (__IPMRA_TABLE_MAX - 1)
125 
126 /* ipmr netlink vif attribute format
127  * [ IPMRA_TABLE_VIFS ] - nested attribute
128  *   [ IPMRA_VIF ] - nested attribute
129  *     [ IPMRA_VIFA_xxx ]
130  */
131 enum {
132 	IPMRA_VIF_UNSPEC,
133 	IPMRA_VIF,
134 	__IPMRA_VIF_MAX
135 };
136 #define IPMRA_VIF_MAX (__IPMRA_VIF_MAX - 1)
137 
138 /* vif-specific attributes */
139 enum {
140 	IPMRA_VIFA_UNSPEC,
141 	IPMRA_VIFA_IFINDEX,
142 	IPMRA_VIFA_VIF_ID,
143 	IPMRA_VIFA_FLAGS,
144 	IPMRA_VIFA_BYTES_IN,
145 	IPMRA_VIFA_BYTES_OUT,
146 	IPMRA_VIFA_PACKETS_IN,
147 	IPMRA_VIFA_PACKETS_OUT,
148 	IPMRA_VIFA_LOCAL_ADDR,
149 	IPMRA_VIFA_REMOTE_ADDR,
150 	IPMRA_VIFA_PAD,
151 	__IPMRA_VIFA_MAX
152 };
153 #define IPMRA_VIFA_MAX (__IPMRA_VIFA_MAX - 1)
154 
155 /* ipmr netlink cache report attributes */
156 enum {
157 	IPMRA_CREPORT_UNSPEC,
158 	IPMRA_CREPORT_MSGTYPE,
159 	IPMRA_CREPORT_VIF_ID,
160 	IPMRA_CREPORT_SRC_ADDR,
161 	IPMRA_CREPORT_DST_ADDR,
162 	IPMRA_CREPORT_PKT,
163 	__IPMRA_CREPORT_MAX
164 };
165 #define IPMRA_CREPORT_MAX (__IPMRA_CREPORT_MAX - 1)
166 
167 /* That's all usermode folks */
168 
169 #define MFC_ASSERT_THRESH (3*HZ)		/* Maximal freq. of asserts */
170 
171 /* Pseudo messages used by mrouted */
172 #define IGMPMSG_NOCACHE		1		/* Kern cache fill request to mrouted */
173 #define IGMPMSG_WRONGVIF	2		/* For PIM assert processing (unused) */
174 #define IGMPMSG_WHOLEPKT	3		/* For PIM Register processing */
175 
176 #endif /* _UAPI__LINUX_MROUTE_H */
177