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