xref: /linux-6.15/include/uapi/linux/mroute6.h (revision bb7e5ce7)
1 #ifndef _UAPI__LINUX_MROUTE6_H
2 #define _UAPI__LINUX_MROUTE6_H
3 
4 #include <linux/kernel.h>
5 #include <linux/types.h>
6 #include <linux/sockios.h>
7 #include <linux/in6.h>		/* For struct sockaddr_in6. */
8 
9 /*
10  *	Based on the MROUTING 3.5 defines primarily to keep
11  *	source compatibility with BSD.
12  *
13  *	See the pim6sd code for the original history.
14  *
15  *      Protocol Independent Multicast (PIM) data structures included
16  *      Carlos Picoto ([email protected])
17  *
18  */
19 
20 #define MRT6_BASE	200
21 #define MRT6_INIT	(MRT6_BASE)	/* Activate the kernel mroute code 	*/
22 #define MRT6_DONE	(MRT6_BASE+1)	/* Shutdown the kernel mroute		*/
23 #define MRT6_ADD_MIF	(MRT6_BASE+2)	/* Add a virtual interface		*/
24 #define MRT6_DEL_MIF	(MRT6_BASE+3)	/* Delete a virtual interface		*/
25 #define MRT6_ADD_MFC	(MRT6_BASE+4)	/* Add a multicast forwarding entry	*/
26 #define MRT6_DEL_MFC	(MRT6_BASE+5)	/* Delete a multicast forwarding entry	*/
27 #define MRT6_VERSION	(MRT6_BASE+6)	/* Get the kernel multicast version	*/
28 #define MRT6_ASSERT	(MRT6_BASE+7)	/* Activate PIM assert mode		*/
29 #define MRT6_PIM	(MRT6_BASE+8)	/* enable PIM code			*/
30 #define MRT6_TABLE	(MRT6_BASE+9)	/* Specify mroute table ID		*/
31 #define MRT6_ADD_MFC_PROXY	(MRT6_BASE+10)	/* Add a (*,*|G) mfc entry	*/
32 #define MRT6_DEL_MFC_PROXY	(MRT6_BASE+11)	/* Del a (*,*|G) mfc entry	*/
33 #define MRT6_MAX	(MRT6_BASE+11)
34 
35 #define SIOCGETMIFCNT_IN6	SIOCPROTOPRIVATE	/* IP protocol privates */
36 #define SIOCGETSGCNT_IN6	(SIOCPROTOPRIVATE+1)
37 #define SIOCGETRPF	(SIOCPROTOPRIVATE+2)
38 
39 #define MAXMIFS		32
40 typedef unsigned long mifbitmap_t;	/* User mode code depends on this lot */
41 typedef unsigned short mifi_t;
42 #define ALL_MIFS	((mifi_t)(-1))
43 
44 #ifndef IF_SETSIZE
45 #define IF_SETSIZE	256
46 #endif
47 
48 typedef	__u32		if_mask;
49 #define NIFBITS (sizeof(if_mask) * 8)        /* bits per mask */
50 
51 typedef struct if_set {
52 	if_mask ifs_bits[__KERNEL_DIV_ROUND_UP(IF_SETSIZE, NIFBITS)];
53 } if_set;
54 
55 #define IF_SET(n, p)    ((p)->ifs_bits[(n)/NIFBITS] |= (1 << ((n) % NIFBITS)))
56 #define IF_CLR(n, p)    ((p)->ifs_bits[(n)/NIFBITS] &= ~(1 << ((n) % NIFBITS)))
57 #define IF_ISSET(n, p)  ((p)->ifs_bits[(n)/NIFBITS] & (1 << ((n) % NIFBITS)))
58 #define IF_COPY(f, t)   bcopy(f, t, sizeof(*(f)))
59 #define IF_ZERO(p)      bzero(p, sizeof(*(p)))
60 
61 /*
62  *	Passed by mrouted for an MRT_ADD_MIF - again we use the
63  *	mrouted 3.6 structures for compatibility
64  */
65 
66 struct mif6ctl {
67 	mifi_t	mif6c_mifi;		/* Index of MIF */
68 	unsigned char mif6c_flags;	/* MIFF_ flags */
69 	unsigned char vifc_threshold;	/* ttl limit */
70 	__u16	 mif6c_pifi;		/* the index of the physical IF */
71 	unsigned int vifc_rate_limit;	/* Rate limiter values (NI) */
72 };
73 
74 #define MIFF_REGISTER	0x1	/* register vif	*/
75 
76 /*
77  *	Cache manipulation structures for mrouted and PIMd
78  */
79 
80 struct mf6cctl {
81 	struct sockaddr_in6 mf6cc_origin;		/* Origin of mcast	*/
82 	struct sockaddr_in6 mf6cc_mcastgrp;		/* Group in question	*/
83 	mifi_t	mf6cc_parent;			/* Where it arrived	*/
84 	struct if_set mf6cc_ifset;		/* Where it is going */
85 };
86 
87 /*
88  *	Group count retrieval for pim6sd
89  */
90 
91 struct sioc_sg_req6 {
92 	struct sockaddr_in6 src;
93 	struct sockaddr_in6 grp;
94 	unsigned long pktcnt;
95 	unsigned long bytecnt;
96 	unsigned long wrong_if;
97 };
98 
99 /*
100  *	To get vif packet counts
101  */
102 
103 struct sioc_mif_req6 {
104 	mifi_t	mifi;		/* Which iface */
105 	unsigned long icount;	/* In packets */
106 	unsigned long ocount;	/* Out packets */
107 	unsigned long ibytes;	/* In bytes */
108 	unsigned long obytes;	/* Out bytes */
109 };
110 
111 /*
112  *	That's all usermode folks
113  */
114 
115 
116 
117 /*
118  * Structure used to communicate from kernel to multicast router.
119  * We'll overlay the structure onto an MLD header (not an IPv6 heder like igmpmsg{}
120  * used for IPv4 implementation). This is because this structure will be passed via an
121  * IPv6 raw socket, on which an application will only receiver the payload i.e the data after
122  * the IPv6 header and all the extension headers. (See section 3 of RFC 3542)
123  */
124 
125 struct mrt6msg {
126 #define MRT6MSG_NOCACHE		1
127 #define MRT6MSG_WRONGMIF	2
128 #define MRT6MSG_WHOLEPKT	3		/* used for use level encap */
129 	__u8		im6_mbz;		/* must be zero		   */
130 	__u8		im6_msgtype;		/* what type of message    */
131 	__u16		im6_mif;		/* mif rec'd on		   */
132 	__u32		im6_pad;		/* padding for 64 bit arch */
133 	struct in6_addr	im6_src, im6_dst;
134 };
135 
136 /* ip6mr netlink cache report attributes */
137 enum {
138 	IP6MRA_CREPORT_UNSPEC,
139 	IP6MRA_CREPORT_MSGTYPE,
140 	IP6MRA_CREPORT_MIF_ID,
141 	IP6MRA_CREPORT_SRC_ADDR,
142 	IP6MRA_CREPORT_DST_ADDR,
143 	IP6MRA_CREPORT_PKT,
144 	__IP6MRA_CREPORT_MAX
145 };
146 #define IP6MRA_CREPORT_MAX (__IP6MRA_CREPORT_MAX - 1)
147 
148 #endif /* _UAPI__LINUX_MROUTE6_H */
149