Merge branch 'pm-docs'
[linux-block.git] / include / linux / inetdevice.h
CommitLineData
b2441318 1/* SPDX-License-Identifier: GPL-2.0 */
1da177e4
LT
2#ifndef _LINUX_INETDEVICE_H
3#define _LINUX_INETDEVICE_H
4
5#ifdef __KERNEL__
6
31be3085 7#include <linux/bitmap.h>
1da177e4 8#include <linux/if.h>
4a5a8aa6 9#include <linux/ip.h>
1da177e4
LT
10#include <linux/netdevice.h>
11#include <linux/rcupdate.h>
12#include <linux/timer.h>
8bfe6d68 13#include <linux/sysctl.h>
95ae6b22 14#include <linux/rtnetlink.h>
7658b36f 15#include <linux/refcount.h>
1da177e4 16
d94d9fee 17struct ipv4_devconf {
1da177e4 18 void *sysctl;
ca7479eb
TG
19 int data[IPV4_DEVCONF_MAX];
20 DECLARE_BITMAP(state, IPV4_DEVCONF_MAX);
1da177e4
LT
21};
22
e9897071
ED
23#define MC_HASH_SZ_LOG 9
24
d94d9fee 25struct in_device {
1da177e4 26 struct net_device *dev;
c04438f5
ED
27 netdevice_tracker dev_tracker;
28
7658b36f 29 refcount_t refcnt;
1da177e4 30 int dead;
2638eb8b 31 struct in_ifaddr __rcu *ifa_list;/* IP ifaddr chain */
e9897071 32
1d7138de 33 struct ip_mc_list __rcu *mc_list; /* IP multicast filter chain */
e9897071
ED
34 struct ip_mc_list __rcu * __rcu *mc_hash;
35
1d7138de 36 int mc_count; /* Number of installed mcasts */
1da177e4
LT
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;
966c37f2
HL
42 unsigned long mr_qi; /* Query Interval */
43 unsigned long mr_qri; /* Query Response Interval */
44 unsigned char mr_qrv; /* Query Robustness Variable */
1da177e4 45 unsigned char mr_gq_running;
b69dd5b3 46 u32 mr_ifc_count;
1da177e4
LT
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
02291680 55#define IPV4_DEVCONF(cnf, attr) ((cnf).data[IPV4_DEVCONF_ ## attr - 1])
586f1211
PE
56#define IPV4_DEVCONF_ALL(net, attr) \
57 IPV4_DEVCONF((*(net)->ipv4.devconf_all), attr)
42f811b8
HX
58
59static inline int ipv4_devconf_get(struct in_device *in_dev, int index)
60{
61 index--;
62 return in_dev->cnf.data[index];
63}
64
65static inline void ipv4_devconf_set(struct in_device *in_dev, int index,
66 int val)
67{
68 index--;
31be3085 69 set_bit(index, in_dev->cnf.state);
42f811b8
HX
70 in_dev->cnf.data[index] = val;
71}
72
71e27da9
HX
73static inline void ipv4_devconf_setall(struct in_device *in_dev)
74{
ca7479eb 75 bitmap_fill(in_dev->cnf.state, IPV4_DEVCONF_MAX);
71e27da9
HX
76}
77
42f811b8 78#define IN_DEV_CONF_GET(in_dev, attr) \
02291680 79 ipv4_devconf_get((in_dev), IPV4_DEVCONF_ ## attr)
42f811b8 80#define IN_DEV_CONF_SET(in_dev, attr, val) \
02291680 81 ipv4_devconf_set((in_dev), IPV4_DEVCONF_ ## attr, (val))
42f811b8
HX
82
83#define IN_DEV_ANDCONF(in_dev, attr) \
c346dca1 84 (IPV4_DEVCONF_ALL(dev_net(in_dev->dev), attr) && \
586f1211 85 IN_DEV_CONF_GET((in_dev), attr))
9eb43e76
ED
86
87#define IN_DEV_NET_ORCONF(in_dev, net, attr) \
88 (IPV4_DEVCONF_ALL(net, attr) || \
586f1211 89 IN_DEV_CONF_GET((in_dev), attr))
9eb43e76
ED
90
91#define IN_DEV_ORCONF(in_dev, attr) \
92 IN_DEV_NET_ORCONF(in_dev, dev_net(in_dev->dev), attr)
93
42f811b8 94#define IN_DEV_MAXCONF(in_dev, attr) \
c346dca1 95 (max(IPV4_DEVCONF_ALL(dev_net(in_dev->dev), attr), \
586f1211 96 IN_DEV_CONF_GET((in_dev), attr)))
42f811b8
HX
97
98#define IN_DEV_FORWARD(in_dev) IN_DEV_CONF_GET((in_dev), FORWARDING)
01ecfe9b 99#define IN_DEV_MFORWARD(in_dev) IN_DEV_ANDCONF((in_dev), MC_FORWARDING)
5cbf777c 100#define IN_DEV_BFORWARD(in_dev) IN_DEV_ANDCONF((in_dev), BC_FORWARDING)
27fed417 101#define IN_DEV_RPFILTER(in_dev) IN_DEV_MAXCONF((in_dev), RP_FILTER)
28f6aeea 102#define IN_DEV_SRC_VMARK(in_dev) IN_DEV_ORCONF((in_dev), SRC_VMARK)
42f811b8
HX
103#define IN_DEV_SOURCE_ROUTE(in_dev) IN_DEV_ANDCONF((in_dev), \
104 ACCEPT_SOURCE_ROUTE)
8153a10c 105#define IN_DEV_ACCEPT_LOCAL(in_dev) IN_DEV_ORCONF((in_dev), ACCEPT_LOCAL)
42f811b8
HX
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)
1af5318c 110#define IN_DEV_PROXY_ARP_PVLAN(in_dev) IN_DEV_ORCONF((in_dev), PROXY_ARP_PVLAN)
42f811b8
HX
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)
d0daebc3 120#define IN_DEV_ROUTE_LOCALNET(in_dev) IN_DEV_ORCONF(in_dev, ROUTE_LOCALNET)
9eb43e76
ED
121#define IN_DEV_NET_ROUTE_LOCALNET(in_dev, net) \
122 IN_DEV_NET_ORCONF(in_dev, net, ROUTE_LOCALNET)
1da177e4
LT
123
124#define IN_DEV_RX_REDIRECTS(in_dev) \
125 ((IN_DEV_FORWARD(in_dev) && \
42f811b8 126 IN_DEV_ANDCONF((in_dev), ACCEPT_REDIRECTS)) \
1da177e4 127 || (!IN_DEV_FORWARD(in_dev) && \
42f811b8 128 IN_DEV_ORCONF((in_dev), ACCEPT_REDIRECTS)))
1da177e4 129
0eeb075f 130#define IN_DEV_IGNORE_ROUTES_WITH_LINKDOWN(in_dev) \
c0c5a60f 131 IN_DEV_ORCONF((in_dev), IGNORE_ROUTES_WITH_LINKDOWN)
0eeb075f 132
42f811b8 133#define IN_DEV_ARPFILTER(in_dev) IN_DEV_ORCONF((in_dev), ARPFILTER)
124d37e9 134#define IN_DEV_ARP_ACCEPT(in_dev) IN_DEV_ORCONF((in_dev), ARP_ACCEPT)
42f811b8
HX
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)
eefef1cf 137#define IN_DEV_ARP_NOTIFY(in_dev) IN_DEV_MAXCONF((in_dev), ARP_NOTIFY)
fcdb44d0
JP
138#define IN_DEV_ARP_EVICT_NOCARRIER(in_dev) IN_DEV_ANDCONF((in_dev), \
139 ARP_EVICT_NOCARRIER)
1da177e4 140
d94d9fee 141struct in_ifaddr {
fd23c3b3 142 struct hlist_node hash;
2638eb8b 143 struct in_ifaddr __rcu *ifa_next;
1da177e4
LT
144 struct in_device *ifa_dev;
145 struct rcu_head rcu_head;
a144ea4b
AV
146 __be32 ifa_local;
147 __be32 ifa_address;
148 __be32 ifa_mask;
af4d768a 149 __u32 ifa_rt_priority;
a144ea4b 150 __be32 ifa_broadcast;
1da177e4 151 unsigned char ifa_scope;
1da177e4 152 unsigned char ifa_prefixlen;
ad6c8135 153 __u32 ifa_flags;
1da177e4 154 char ifa_label[IFNAMSIZ];
5c766d64
JP
155
156 /* In seconds, relative to tstamp. Expiry is at tstamp + HZ * lft. */
157 __u32 ifa_valid_lft;
158 __u32 ifa_preferred_lft;
159 unsigned long ifa_cstamp; /* created timestamp */
160 unsigned long ifa_tstamp; /* updated timestamp */
1da177e4
LT
161};
162
3ad7d246
KJ
163struct in_validator_info {
164 __be32 ivi_addr;
165 struct in_device *ivi_dev;
de95e047 166 struct netlink_ext_ack *extack;
3ad7d246
KJ
167};
168
f629d208
JP
169int register_inetaddr_notifier(struct notifier_block *nb);
170int unregister_inetaddr_notifier(struct notifier_block *nb);
3ad7d246
KJ
171int register_inetaddr_validator_notifier(struct notifier_block *nb);
172int unregister_inetaddr_validator_notifier(struct notifier_block *nb);
1da177e4 173
3b022865
DA
174void inet_netconf_notify_devconf(struct net *net, int event, int type,
175 int ifindex, struct ipv4_devconf *devconf);
d67b8c61 176
f629d208 177struct net_device *__ip_dev_find(struct net *net, __be32 addr, bool devref);
82efee14
ED
178static inline struct net_device *ip_dev_find(struct net *net, __be32 addr)
179{
180 return __ip_dev_find(net, addr, true);
181}
182
f629d208 183int inet_addr_onlink(struct in_device *in_dev, __be32 a, __be32 b);
03aef17b 184int devinet_ioctl(struct net *net, unsigned int cmd, struct ifreq *);
b0e99d03
AB
185#ifdef CONFIG_INET
186int inet_gifconf(struct net_device *dev, char __user *buf, int len, int size);
187#else
188static inline int inet_gifconf(struct net_device *dev, char __user *buf,
189 int len, int size)
190{
191 return 0;
192}
193#endif
f629d208
JP
194void devinet_init(void);
195struct in_device *inetdev_by_index(struct net *, int);
196__be32 inet_select_addr(const struct net_device *dev, __be32 dst, int scope);
b601fa19
ND
197__be32 inet_confirm_addr(struct net *net, struct in_device *in_dev, __be32 dst,
198 __be32 local, int scope);
f629d208
JP
199struct in_ifaddr *inet_ifa_byprefix(struct in_device *in_dev, __be32 prefix,
200 __be32 mask);
6e617de8 201struct in_ifaddr *inet_lookup_ifaddr_rcu(struct net *net, __be32 addr);
ef11db33 202static inline bool inet_ifa_match(__be32 addr, const struct in_ifaddr *ifa)
1da177e4
LT
203{
204 return !((addr^ifa->ifa_address)&ifa->ifa_mask);
205}
206
207/*
208 * Check if a mask is acceptable.
209 */
210
f06cc7b2 211static __inline__ bool bad_mask(__be32 mask, __be32 addr)
1da177e4 212{
714e85be 213 __u32 hmask;
1da177e4 214 if (addr & (mask = ~mask))
f06cc7b2 215 return true;
714e85be
AV
216 hmask = ntohl(mask);
217 if (hmask & (hmask+1))
f06cc7b2
YB
218 return true;
219 return false;
1da177e4
LT
220}
221
ef11db33 222#define in_dev_for_each_ifa_rtnl(ifa, in_dev) \
2638eb8b
FW
223 for (ifa = rtnl_dereference((in_dev)->ifa_list); ifa; \
224 ifa = rtnl_dereference(ifa->ifa_next))
ef11db33
FW
225
226#define in_dev_for_each_ifa_rcu(ifa, in_dev) \
2638eb8b
FW
227 for (ifa = rcu_dereference((in_dev)->ifa_list); ifa; \
228 ifa = rcu_dereference(ifa->ifa_next))
ef11db33 229
e5ed6399
HX
230static inline struct in_device *__in_dev_get_rcu(const struct net_device *dev)
231{
95ae6b22 232 return rcu_dereference(dev->ip_ptr);
e5ed6399
HX
233}
234
95ae6b22 235static inline struct in_device *in_dev_get(const struct net_device *dev)
1da177e4
LT
236{
237 struct in_device *in_dev;
238
239 rcu_read_lock();
e5ed6399 240 in_dev = __in_dev_get_rcu(dev);
1da177e4 241 if (in_dev)
7658b36f 242 refcount_inc(&in_dev->refcnt);
1da177e4
LT
243 rcu_read_unlock();
244 return in_dev;
245}
246
95ae6b22 247static inline struct in_device *__in_dev_get_rtnl(const struct net_device *dev)
1da177e4 248{
06a9701f 249 return rtnl_dereference(dev->ip_ptr);
1da177e4
LT
250}
251
331c7a40
DA
252/* called with rcu_read_lock or rtnl held */
253static inline bool ip_ignore_linkdown(const struct net_device *dev)
254{
255 struct in_device *in_dev;
256 bool rc = false;
257
258 in_dev = rcu_dereference_rtnl(dev->ip_ptr);
259 if (in_dev &&
260 IN_DEV_IGNORE_ROUTES_WITH_LINKDOWN(in_dev))
261 rc = true;
262
263 return rc;
264}
265
1d4c8c29
JP
266static inline struct neigh_parms *__in_dev_arp_parms_get_rcu(const struct net_device *dev)
267{
268 struct in_device *in_dev = __in_dev_get_rcu(dev);
269
270 return in_dev ? in_dev->arp_parms : NULL;
271}
272
f629d208 273void in_dev_finish_destroy(struct in_device *idev);
1da177e4
LT
274
275static inline void in_dev_put(struct in_device *idev)
276{
7658b36f 277 if (refcount_dec_and_test(&idev->refcnt))
1da177e4
LT
278 in_dev_finish_destroy(idev);
279}
280
7658b36f
RE
281#define __in_dev_put(idev) refcount_dec(&(idev)->refcnt)
282#define in_dev_hold(idev) refcount_inc(&(idev)->refcnt)
1da177e4
LT
283
284#endif /* __KERNEL__ */
285
60cad5da 286static __inline__ __be32 inet_make_mask(int logmask)
1da177e4
LT
287{
288 if (logmask)
84bc8868 289 return htonl(~((1U<<(32-logmask))-1));
1da177e4
LT
290 return 0;
291}
292
714e85be 293static __inline__ int inet_mask_len(__be32 mask)
1da177e4 294{
714e85be
AV
295 __u32 hmask = ntohl(mask);
296 if (!hmask)
1da177e4 297 return 0;
714e85be 298 return 32 - ffz(~hmask);
1da177e4
LT
299}
300
301
302#endif /* _LINUX_INETDEVICE_H */