xref: /linux-6.15/include/linux/mroute6.h (revision 659431fc)
1 #ifndef __LINUX_MROUTE6_H
2 #define __LINUX_MROUTE6_H
3 
4 #include <linux/types.h>
5 #include <linux/sockios.h>
6 
7 /*
8  *	Based on the MROUTING 3.5 defines primarily to keep
9  *	source compatibility with BSD.
10  *
11  *	See the pim6sd code for the original history.
12  *
13  *      Protocol Independent Multicast (PIM) data structures included
14  *      Carlos Picoto ([email protected])
15  *
16  */
17 
18 #define MRT6_BASE	200
19 #define MRT6_INIT	(MRT6_BASE)	/* Activate the kernel mroute code 	*/
20 #define MRT6_DONE	(MRT6_BASE+1)	/* Shutdown the kernel mroute		*/
21 #define MRT6_ADD_MIF	(MRT6_BASE+2)	/* Add a virtual interface		*/
22 #define MRT6_DEL_MIF	(MRT6_BASE+3)	/* Delete a virtual interface		*/
23 #define MRT6_ADD_MFC	(MRT6_BASE+4)	/* Add a multicast forwarding entry	*/
24 #define MRT6_DEL_MFC	(MRT6_BASE+5)	/* Delete a multicast forwarding entry	*/
25 #define MRT6_VERSION	(MRT6_BASE+6)	/* Get the kernel multicast version	*/
26 #define MRT6_ASSERT	(MRT6_BASE+7)	/* Activate PIM assert mode		*/
27 #define MRT6_PIM	(MRT6_BASE+8)	/* enable PIM code	*/
28 
29 #define SIOCGETMIFCNT_IN6	SIOCPROTOPRIVATE	/* IP protocol privates */
30 #define SIOCGETSGCNT_IN6	(SIOCPROTOPRIVATE+1)
31 #define SIOCGETRPF	(SIOCPROTOPRIVATE+2)
32 
33 #define MAXMIFS		32
34 typedef unsigned long mifbitmap_t;	/* User mode code depends on this lot */
35 typedef unsigned short mifi_t;
36 #define ALL_MIFS	((mifi_t)(-1))
37 
38 #ifndef IF_SETSIZE
39 #define IF_SETSIZE	256
40 #endif
41 
42 typedef	__u32		if_mask;
43 #define NIFBITS (sizeof(if_mask) * 8)        /* bits per mask */
44 
45 #if !defined(__KERNEL__) && !defined(DIV_ROUND_UP)
46 #define	DIV_ROUND_UP(x,y)	(((x) + ((y) - 1)) / (y))
47 #endif
48 
49 typedef struct if_set {
50 	if_mask ifs_bits[DIV_ROUND_UP(IF_SETSIZE, NIFBITS)];
51 } if_set;
52 
53 #define IF_SET(n, p)    ((p)->ifs_bits[(n)/NIFBITS] |= (1 << ((n) % NIFBITS)))
54 #define IF_CLR(n, p)    ((p)->ifs_bits[(n)/NIFBITS] &= ~(1 << ((n) % NIFBITS)))
55 #define IF_ISSET(n, p)  ((p)->ifs_bits[(n)/NIFBITS] & (1 << ((n) % NIFBITS)))
56 #define IF_COPY(f, t)   bcopy(f, t, sizeof(*(f)))
57 #define IF_ZERO(p)      bzero(p, sizeof(*(p)))
58 
59 /*
60  *	Passed by mrouted for an MRT_ADD_MIF - again we use the
61  *	mrouted 3.6 structures for compatibility
62  */
63 
64 struct mif6ctl {
65 	mifi_t	mif6c_mifi;		/* Index of MIF */
66 	unsigned char mif6c_flags;	/* MIFF_ flags */
67 	unsigned char vifc_threshold;	/* ttl limit */
68 	__u16	 mif6c_pifi;		/* the index of the physical IF */
69 	unsigned int vifc_rate_limit;	/* Rate limiter values (NI) */
70 };
71 
72 #define MIFF_REGISTER	0x1	/* register vif	*/
73 
74 /*
75  *	Cache manipulation structures for mrouted and PIMd
76  */
77 
78 struct mf6cctl {
79 	struct sockaddr_in6 mf6cc_origin;		/* Origin of mcast	*/
80 	struct sockaddr_in6 mf6cc_mcastgrp;		/* Group in question	*/
81 	mifi_t	mf6cc_parent;			/* Where it arrived	*/
82 	struct if_set mf6cc_ifset;		/* Where it is going */
83 };
84 
85 /*
86  *	Group count retrieval for pim6sd
87  */
88 
89 struct sioc_sg_req6 {
90 	struct sockaddr_in6 src;
91 	struct sockaddr_in6 grp;
92 	unsigned long pktcnt;
93 	unsigned long bytecnt;
94 	unsigned long wrong_if;
95 };
96 
97 /*
98  *	To get vif packet counts
99  */
100 
101 struct sioc_mif_req6 {
102 	mifi_t	mifi;		/* Which iface */
103 	unsigned long icount;	/* In packets */
104 	unsigned long ocount;	/* Out packets */
105 	unsigned long ibytes;	/* In bytes */
106 	unsigned long obytes;	/* Out bytes */
107 };
108 
109 /*
110  *	That's all usermode folks
111  */
112 
113 #ifdef __KERNEL__
114 
115 #include <linux/pim.h>
116 #include <linux/skbuff.h>	/* for struct sk_buff_head */
117 #include <net/net_namespace.h>
118 
119 #ifdef CONFIG_IPV6_MROUTE
120 static inline int ip6_mroute_opt(int opt)
121 {
122 	return (opt >= MRT6_BASE) && (opt <= MRT6_BASE + 10);
123 }
124 #else
125 static inline int ip6_mroute_opt(int opt)
126 {
127 	return 0;
128 }
129 #endif
130 
131 struct sock;
132 
133 #ifdef CONFIG_IPV6_MROUTE
134 extern int ip6_mroute_setsockopt(struct sock *, int, char __user *, unsigned int);
135 extern int ip6_mroute_getsockopt(struct sock *, int, char __user *, int __user *);
136 extern int ip6_mr_input(struct sk_buff *skb);
137 extern int ip6mr_ioctl(struct sock *sk, int cmd, void __user *arg);
138 extern int ip6_mr_init(void);
139 extern void ip6_mr_cleanup(void);
140 #else
141 static inline
142 int ip6_mroute_setsockopt(struct sock *sock,
143 			  int optname, char __user *optval, unsigned int optlen)
144 {
145 	return -ENOPROTOOPT;
146 }
147 
148 static inline
149 int ip6_mroute_getsockopt(struct sock *sock,
150 			  int optname, char __user *optval, int __user *optlen)
151 {
152 	return -ENOPROTOOPT;
153 }
154 
155 static inline
156 int ip6mr_ioctl(struct sock *sk, int cmd, void __user *arg)
157 {
158 	return -ENOIOCTLCMD;
159 }
160 
161 static inline int ip6_mr_init(void)
162 {
163 	return 0;
164 }
165 
166 static inline void ip6_mr_cleanup(void)
167 {
168 	return;
169 }
170 #endif
171 
172 struct mif_device {
173 	struct net_device 	*dev;			/* Device we are using */
174 	unsigned long	bytes_in,bytes_out;
175 	unsigned long	pkt_in,pkt_out;		/* Statistics 			*/
176 	unsigned long	rate_limit;		/* Traffic shaping (NI) 	*/
177 	unsigned char	threshold;		/* TTL threshold 		*/
178 	unsigned short	flags;			/* Control flags 		*/
179 	int		link;			/* Physical interface index	*/
180 };
181 
182 #define VIFF_STATIC 0x8000
183 
184 struct mfc6_cache {
185 	struct mfc6_cache *next;		/* Next entry on cache line 	*/
186 #ifdef CONFIG_NET_NS
187 	struct net *mfc6_net;
188 #endif
189 	struct in6_addr mf6c_mcastgrp;			/* Group the entry belongs to 	*/
190 	struct in6_addr mf6c_origin;			/* Source of packet 		*/
191 	mifi_t mf6c_parent;			/* Source interface		*/
192 	int mfc_flags;				/* Flags on line		*/
193 
194 	union {
195 		struct {
196 			unsigned long expires;
197 			struct sk_buff_head unresolved;	/* Unresolved buffers		*/
198 		} unres;
199 		struct {
200 			unsigned long last_assert;
201 			int minvif;
202 			int maxvif;
203 			unsigned long bytes;
204 			unsigned long pkt;
205 			unsigned long wrong_if;
206 			unsigned char ttls[MAXMIFS];	/* TTL thresholds		*/
207 		} res;
208 	} mfc_un;
209 };
210 
211 static inline
212 struct net *mfc6_net(const struct mfc6_cache *mfc)
213 {
214 	return read_pnet(&mfc->mfc6_net);
215 }
216 
217 static inline
218 void mfc6_net_set(struct mfc6_cache *mfc, struct net *net)
219 {
220 	write_pnet(&mfc->mfc6_net, hold_net(net));
221 }
222 
223 #define MFC_STATIC		1
224 #define MFC_NOTIFY		2
225 
226 #define MFC6_LINES		64
227 
228 #define MFC6_HASH(a, g) (((__force u32)(a)->s6_addr32[0] ^ \
229 			  (__force u32)(a)->s6_addr32[1] ^ \
230 			  (__force u32)(a)->s6_addr32[2] ^ \
231 			  (__force u32)(a)->s6_addr32[3] ^ \
232 			  (__force u32)(g)->s6_addr32[0] ^ \
233 			  (__force u32)(g)->s6_addr32[1] ^ \
234 			  (__force u32)(g)->s6_addr32[2] ^ \
235 			  (__force u32)(g)->s6_addr32[3]) % MFC6_LINES)
236 
237 #define MFC_ASSERT_THRESH (3*HZ)		/* Maximal freq. of asserts */
238 
239 #endif
240 
241 #ifdef __KERNEL__
242 struct rtmsg;
243 extern int ip6mr_get_route(struct net *net, struct sk_buff *skb,
244 			   struct rtmsg *rtm, int nowait);
245 
246 #ifdef CONFIG_IPV6_MROUTE
247 static inline struct sock *mroute6_socket(struct net *net)
248 {
249 	return net->ipv6.mroute6_sk;
250 }
251 extern int ip6mr_sk_done(struct sock *sk);
252 #else
253 static inline struct sock *mroute6_socket(struct net *net) { return NULL; }
254 static inline int ip6mr_sk_done(struct sock *sk) { return 0; }
255 #endif
256 #endif
257 
258 /*
259  * Structure used to communicate from kernel to multicast router.
260  * We'll overlay the structure onto an MLD header (not an IPv6 heder like igmpmsg{}
261  * used for IPv4 implementation). This is because this structure will be passed via an
262  * IPv6 raw socket, on wich an application will only receiver the payload i.e the data after
263  * the IPv6 header and all the extension headers. (See section 3 of RFC 3542)
264  */
265 
266 struct mrt6msg {
267 #define MRT6MSG_NOCACHE		1
268 #define MRT6MSG_WRONGMIF	2
269 #define MRT6MSG_WHOLEPKT	3		/* used for use level encap */
270 	__u8		im6_mbz;		/* must be zero		   */
271 	__u8		im6_msgtype;		/* what type of message    */
272 	__u16		im6_mif;		/* mif rec'd on		   */
273 	__u32		im6_pad;		/* padding for 64 bit arch */
274 	struct in6_addr	im6_src, im6_dst;
275 };
276 
277 #endif
278