xref: /linux-6.15/include/linux/inetdevice.h (revision 4df864c1)
1 #ifndef _LINUX_INETDEVICE_H
2 #define _LINUX_INETDEVICE_H
3 
4 #ifdef __KERNEL__
5 
6 #include <linux/bitmap.h>
7 #include <linux/if.h>
8 #include <linux/ip.h>
9 #include <linux/netdevice.h>
10 #include <linux/rcupdate.h>
11 #include <linux/timer.h>
12 #include <linux/sysctl.h>
13 #include <linux/rtnetlink.h>
14 
15 struct ipv4_devconf {
16 	void	*sysctl;
17 	int	data[IPV4_DEVCONF_MAX];
18 	DECLARE_BITMAP(state, IPV4_DEVCONF_MAX);
19 };
20 
21 #define MC_HASH_SZ_LOG 9
22 
23 struct in_device {
24 	struct net_device	*dev;
25 	atomic_t		refcnt;
26 	int			dead;
27 	struct in_ifaddr	*ifa_list;	/* IP ifaddr chain		*/
28 
29 	struct ip_mc_list __rcu	*mc_list;	/* IP multicast filter chain    */
30 	struct ip_mc_list __rcu	* __rcu *mc_hash;
31 
32 	int			mc_count;	/* Number of installed mcasts	*/
33 	spinlock_t		mc_tomb_lock;
34 	struct ip_mc_list	*mc_tomb;
35 	unsigned long		mr_v1_seen;
36 	unsigned long		mr_v2_seen;
37 	unsigned long		mr_maxdelay;
38 	unsigned char		mr_qrv;
39 	unsigned char		mr_gq_running;
40 	unsigned char		mr_ifc_count;
41 	struct timer_list	mr_gq_timer;	/* general query timer */
42 	struct timer_list	mr_ifc_timer;	/* interface change timer */
43 
44 	struct neigh_parms	*arp_parms;
45 	struct ipv4_devconf	cnf;
46 	struct rcu_head		rcu_head;
47 };
48 
49 #define IPV4_DEVCONF(cnf, attr) ((cnf).data[IPV4_DEVCONF_ ## attr - 1])
50 #define IPV4_DEVCONF_ALL(net, attr) \
51 	IPV4_DEVCONF((*(net)->ipv4.devconf_all), attr)
52 
53 static inline int ipv4_devconf_get(struct in_device *in_dev, int index)
54 {
55 	index--;
56 	return in_dev->cnf.data[index];
57 }
58 
59 static inline void ipv4_devconf_set(struct in_device *in_dev, int index,
60 				    int val)
61 {
62 	index--;
63 	set_bit(index, in_dev->cnf.state);
64 	in_dev->cnf.data[index] = val;
65 }
66 
67 static inline void ipv4_devconf_setall(struct in_device *in_dev)
68 {
69 	bitmap_fill(in_dev->cnf.state, IPV4_DEVCONF_MAX);
70 }
71 
72 #define IN_DEV_CONF_GET(in_dev, attr) \
73 	ipv4_devconf_get((in_dev), IPV4_DEVCONF_ ## attr)
74 #define IN_DEV_CONF_SET(in_dev, attr, val) \
75 	ipv4_devconf_set((in_dev), IPV4_DEVCONF_ ## attr, (val))
76 
77 #define IN_DEV_ANDCONF(in_dev, attr) \
78 	(IPV4_DEVCONF_ALL(dev_net(in_dev->dev), attr) && \
79 	 IN_DEV_CONF_GET((in_dev), attr))
80 
81 #define IN_DEV_NET_ORCONF(in_dev, net, attr) \
82 	(IPV4_DEVCONF_ALL(net, attr) || \
83 	 IN_DEV_CONF_GET((in_dev), attr))
84 
85 #define IN_DEV_ORCONF(in_dev, attr) \
86 	IN_DEV_NET_ORCONF(in_dev, dev_net(in_dev->dev), attr)
87 
88 #define IN_DEV_MAXCONF(in_dev, attr) \
89 	(max(IPV4_DEVCONF_ALL(dev_net(in_dev->dev), attr), \
90 	     IN_DEV_CONF_GET((in_dev), attr)))
91 
92 #define IN_DEV_FORWARD(in_dev)		IN_DEV_CONF_GET((in_dev), FORWARDING)
93 #define IN_DEV_MFORWARD(in_dev)		IN_DEV_ANDCONF((in_dev), MC_FORWARDING)
94 #define IN_DEV_RPFILTER(in_dev)		IN_DEV_MAXCONF((in_dev), RP_FILTER)
95 #define IN_DEV_SRC_VMARK(in_dev)    	IN_DEV_ORCONF((in_dev), SRC_VMARK)
96 #define IN_DEV_SOURCE_ROUTE(in_dev)	IN_DEV_ANDCONF((in_dev), \
97 						       ACCEPT_SOURCE_ROUTE)
98 #define IN_DEV_ACCEPT_LOCAL(in_dev)	IN_DEV_ORCONF((in_dev), ACCEPT_LOCAL)
99 #define IN_DEV_BOOTP_RELAY(in_dev)	IN_DEV_ANDCONF((in_dev), BOOTP_RELAY)
100 
101 #define IN_DEV_LOG_MARTIANS(in_dev)	IN_DEV_ORCONF((in_dev), LOG_MARTIANS)
102 #define IN_DEV_PROXY_ARP(in_dev)	IN_DEV_ORCONF((in_dev), PROXY_ARP)
103 #define IN_DEV_PROXY_ARP_PVLAN(in_dev)	IN_DEV_CONF_GET(in_dev, PROXY_ARP_PVLAN)
104 #define IN_DEV_SHARED_MEDIA(in_dev)	IN_DEV_ORCONF((in_dev), SHARED_MEDIA)
105 #define IN_DEV_TX_REDIRECTS(in_dev)	IN_DEV_ORCONF((in_dev), SEND_REDIRECTS)
106 #define IN_DEV_SEC_REDIRECTS(in_dev)	IN_DEV_ORCONF((in_dev), \
107 						      SECURE_REDIRECTS)
108 #define IN_DEV_IDTAG(in_dev)		IN_DEV_CONF_GET(in_dev, TAG)
109 #define IN_DEV_MEDIUM_ID(in_dev)	IN_DEV_CONF_GET(in_dev, MEDIUM_ID)
110 #define IN_DEV_PROMOTE_SECONDARIES(in_dev) \
111 					IN_DEV_ORCONF((in_dev), \
112 						      PROMOTE_SECONDARIES)
113 #define IN_DEV_ROUTE_LOCALNET(in_dev)	IN_DEV_ORCONF(in_dev, ROUTE_LOCALNET)
114 #define IN_DEV_NET_ROUTE_LOCALNET(in_dev, net)	\
115 	IN_DEV_NET_ORCONF(in_dev, net, ROUTE_LOCALNET)
116 
117 #define IN_DEV_RX_REDIRECTS(in_dev) \
118 	((IN_DEV_FORWARD(in_dev) && \
119 	  IN_DEV_ANDCONF((in_dev), ACCEPT_REDIRECTS)) \
120 	 || (!IN_DEV_FORWARD(in_dev) && \
121 	  IN_DEV_ORCONF((in_dev), ACCEPT_REDIRECTS)))
122 
123 #define IN_DEV_IGNORE_ROUTES_WITH_LINKDOWN(in_dev) \
124 	IN_DEV_CONF_GET((in_dev), IGNORE_ROUTES_WITH_LINKDOWN)
125 
126 #define IN_DEV_ARPFILTER(in_dev)	IN_DEV_ORCONF((in_dev), ARPFILTER)
127 #define IN_DEV_ARP_ACCEPT(in_dev)	IN_DEV_ORCONF((in_dev), ARP_ACCEPT)
128 #define IN_DEV_ARP_ANNOUNCE(in_dev)	IN_DEV_MAXCONF((in_dev), ARP_ANNOUNCE)
129 #define IN_DEV_ARP_IGNORE(in_dev)	IN_DEV_MAXCONF((in_dev), ARP_IGNORE)
130 #define IN_DEV_ARP_NOTIFY(in_dev)	IN_DEV_MAXCONF((in_dev), ARP_NOTIFY)
131 
132 struct in_ifaddr {
133 	struct hlist_node	hash;
134 	struct in_ifaddr	*ifa_next;
135 	struct in_device	*ifa_dev;
136 	struct rcu_head		rcu_head;
137 	__be32			ifa_local;
138 	__be32			ifa_address;
139 	__be32			ifa_mask;
140 	__be32			ifa_broadcast;
141 	unsigned char		ifa_scope;
142 	unsigned char		ifa_prefixlen;
143 	__u32			ifa_flags;
144 	char			ifa_label[IFNAMSIZ];
145 
146 	/* In seconds, relative to tstamp. Expiry is at tstamp + HZ * lft. */
147 	__u32			ifa_valid_lft;
148 	__u32			ifa_preferred_lft;
149 	unsigned long		ifa_cstamp; /* created timestamp */
150 	unsigned long		ifa_tstamp; /* updated timestamp */
151 };
152 
153 struct in_validator_info {
154 	__be32			ivi_addr;
155 	struct in_device	*ivi_dev;
156 };
157 
158 int register_inetaddr_notifier(struct notifier_block *nb);
159 int unregister_inetaddr_notifier(struct notifier_block *nb);
160 int register_inetaddr_validator_notifier(struct notifier_block *nb);
161 int unregister_inetaddr_validator_notifier(struct notifier_block *nb);
162 
163 void inet_netconf_notify_devconf(struct net *net, int event, int type,
164 				 int ifindex, struct ipv4_devconf *devconf);
165 
166 struct net_device *__ip_dev_find(struct net *net, __be32 addr, bool devref);
167 static inline struct net_device *ip_dev_find(struct net *net, __be32 addr)
168 {
169 	return __ip_dev_find(net, addr, true);
170 }
171 
172 int inet_addr_onlink(struct in_device *in_dev, __be32 a, __be32 b);
173 int devinet_ioctl(struct net *net, unsigned int cmd, void __user *);
174 void devinet_init(void);
175 struct in_device *inetdev_by_index(struct net *, int);
176 __be32 inet_select_addr(const struct net_device *dev, __be32 dst, int scope);
177 __be32 inet_confirm_addr(struct net *net, struct in_device *in_dev, __be32 dst,
178 			 __be32 local, int scope);
179 struct in_ifaddr *inet_ifa_byprefix(struct in_device *in_dev, __be32 prefix,
180 				    __be32 mask);
181 static __inline__ bool inet_ifa_match(__be32 addr, struct in_ifaddr *ifa)
182 {
183 	return !((addr^ifa->ifa_address)&ifa->ifa_mask);
184 }
185 
186 /*
187  *	Check if a mask is acceptable.
188  */
189 
190 static __inline__ bool bad_mask(__be32 mask, __be32 addr)
191 {
192 	__u32 hmask;
193 	if (addr & (mask = ~mask))
194 		return true;
195 	hmask = ntohl(mask);
196 	if (hmask & (hmask+1))
197 		return true;
198 	return false;
199 }
200 
201 #define for_primary_ifa(in_dev)	{ struct in_ifaddr *ifa; \
202   for (ifa = (in_dev)->ifa_list; ifa && !(ifa->ifa_flags&IFA_F_SECONDARY); ifa = ifa->ifa_next)
203 
204 #define for_ifa(in_dev)	{ struct in_ifaddr *ifa; \
205   for (ifa = (in_dev)->ifa_list; ifa; ifa = ifa->ifa_next)
206 
207 
208 #define endfor_ifa(in_dev) }
209 
210 static inline struct in_device *__in_dev_get_rcu(const struct net_device *dev)
211 {
212 	return rcu_dereference(dev->ip_ptr);
213 }
214 
215 static inline struct in_device *in_dev_get(const struct net_device *dev)
216 {
217 	struct in_device *in_dev;
218 
219 	rcu_read_lock();
220 	in_dev = __in_dev_get_rcu(dev);
221 	if (in_dev)
222 		atomic_inc(&in_dev->refcnt);
223 	rcu_read_unlock();
224 	return in_dev;
225 }
226 
227 static inline struct in_device *__in_dev_get_rtnl(const struct net_device *dev)
228 {
229 	return rtnl_dereference(dev->ip_ptr);
230 }
231 
232 static inline struct neigh_parms *__in_dev_arp_parms_get_rcu(const struct net_device *dev)
233 {
234 	struct in_device *in_dev = __in_dev_get_rcu(dev);
235 
236 	return in_dev ? in_dev->arp_parms : NULL;
237 }
238 
239 void in_dev_finish_destroy(struct in_device *idev);
240 
241 static inline void in_dev_put(struct in_device *idev)
242 {
243 	if (atomic_dec_and_test(&idev->refcnt))
244 		in_dev_finish_destroy(idev);
245 }
246 
247 #define __in_dev_put(idev)  atomic_dec(&(idev)->refcnt)
248 #define in_dev_hold(idev)   atomic_inc(&(idev)->refcnt)
249 
250 #endif /* __KERNEL__ */
251 
252 static __inline__ __be32 inet_make_mask(int logmask)
253 {
254 	if (logmask)
255 		return htonl(~((1U<<(32-logmask))-1));
256 	return 0;
257 }
258 
259 static __inline__ int inet_mask_len(__be32 mask)
260 {
261 	__u32 hmask = ntohl(mask);
262 	if (!hmask)
263 		return 0;
264 	return 32 - ffz(~hmask);
265 }
266 
267 
268 #endif /* _LINUX_INETDEVICE_H */
269