License cleanup: add SPDX GPL-2.0 license identifier to files with no license
[linux-block.git] / include / net / addrconf.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _ADDRCONF_H
3 #define _ADDRCONF_H
4
5 #define MAX_RTR_SOLICITATIONS           -1              /* unlimited */
6 #define RTR_SOLICITATION_INTERVAL       (4*HZ)
7 #define RTR_SOLICITATION_MAX_INTERVAL   (3600*HZ)       /* 1 hour */
8
9 #define MIN_VALID_LIFETIME              (2*3600)        /* 2 hours */
10
11 #define TEMP_VALID_LIFETIME             (7*86400)
12 #define TEMP_PREFERRED_LIFETIME         (86400)
13 #define REGEN_MAX_RETRY                 (3)
14 #define MAX_DESYNC_FACTOR               (600)
15
16 #define ADDR_CHECK_FREQUENCY            (120*HZ)
17
18 #define IPV6_MAX_ADDRESSES              16
19
20 #define ADDRCONF_TIMER_FUZZ_MINUS       (HZ > 50 ? HZ / 50 : 1)
21 #define ADDRCONF_TIMER_FUZZ             (HZ / 4)
22 #define ADDRCONF_TIMER_FUZZ_MAX         (HZ)
23
24 #define ADDRCONF_NOTIFY_PRIORITY        0
25
26 #include <linux/in.h>
27 #include <linux/in6.h>
28
29 struct prefix_info {
30         __u8                    type;
31         __u8                    length;
32         __u8                    prefix_len;
33
34 #if defined(__BIG_ENDIAN_BITFIELD)
35         __u8                    onlink : 1,
36                                 autoconf : 1,
37                                 reserved : 6;
38 #elif defined(__LITTLE_ENDIAN_BITFIELD)
39         __u8                    reserved : 6,
40                                 autoconf : 1,
41                                 onlink : 1;
42 #else
43 #error "Please fix <asm/byteorder.h>"
44 #endif
45         __be32                  valid;
46         __be32                  prefered;
47         __be32                  reserved2;
48
49         struct in6_addr         prefix;
50 };
51
52 #include <linux/netdevice.h>
53 #include <net/if_inet6.h>
54 #include <net/ipv6.h>
55
56 struct in6_validator_info {
57         struct in6_addr         i6vi_addr;
58         struct inet6_dev        *i6vi_dev;
59 };
60
61 #define IN6_ADDR_HSIZE_SHIFT    4
62 #define IN6_ADDR_HSIZE          (1 << IN6_ADDR_HSIZE_SHIFT)
63
64 int addrconf_init(void);
65 void addrconf_cleanup(void);
66
67 int addrconf_add_ifaddr(struct net *net, void __user *arg);
68 int addrconf_del_ifaddr(struct net *net, void __user *arg);
69 int addrconf_set_dstaddr(struct net *net, void __user *arg);
70
71 int ipv6_chk_addr(struct net *net, const struct in6_addr *addr,
72                   const struct net_device *dev, int strict);
73 int ipv6_chk_addr_and_flags(struct net *net, const struct in6_addr *addr,
74                             const struct net_device *dev, int strict,
75                             u32 banned_flags);
76
77 #if defined(CONFIG_IPV6_MIP6) || defined(CONFIG_IPV6_MIP6_MODULE)
78 int ipv6_chk_home_addr(struct net *net, const struct in6_addr *addr);
79 #endif
80
81 bool ipv6_chk_custom_prefix(const struct in6_addr *addr,
82                                    const unsigned int prefix_len,
83                                    struct net_device *dev);
84
85 int ipv6_chk_prefix(const struct in6_addr *addr, struct net_device *dev);
86
87 struct inet6_ifaddr *ipv6_get_ifaddr(struct net *net,
88                                      const struct in6_addr *addr,
89                                      struct net_device *dev, int strict);
90
91 int ipv6_dev_get_saddr(struct net *net, const struct net_device *dev,
92                        const struct in6_addr *daddr, unsigned int srcprefs,
93                        struct in6_addr *saddr);
94 int __ipv6_get_lladdr(struct inet6_dev *idev, struct in6_addr *addr,
95                       u32 banned_flags);
96 int ipv6_get_lladdr(struct net_device *dev, struct in6_addr *addr,
97                     u32 banned_flags);
98 int inet_rcv_saddr_equal(const struct sock *sk, const struct sock *sk2,
99                          bool match_wildcard);
100 void addrconf_join_solict(struct net_device *dev, const struct in6_addr *addr);
101 void addrconf_leave_solict(struct inet6_dev *idev, const struct in6_addr *addr);
102
103 void addrconf_add_linklocal(struct inet6_dev *idev,
104                             const struct in6_addr *addr, u32 flags);
105
106 int addrconf_prefix_rcv_add_addr(struct net *net, struct net_device *dev,
107                                  const struct prefix_info *pinfo,
108                                  struct inet6_dev *in6_dev,
109                                  const struct in6_addr *addr, int addr_type,
110                                  u32 addr_flags, bool sllao, bool tokenized,
111                                  __u32 valid_lft, u32 prefered_lft);
112
113 static inline void addrconf_addr_eui48_base(u8 *eui, const char *const addr)
114 {
115         memcpy(eui, addr, 3);
116         eui[3] = 0xFF;
117         eui[4] = 0xFE;
118         memcpy(eui + 5, addr + 3, 3);
119 }
120
121 static inline void addrconf_addr_eui48(u8 *eui, const char *const addr)
122 {
123         addrconf_addr_eui48_base(eui, addr);
124         eui[0] ^= 2;
125 }
126
127 static inline int addrconf_ifid_eui48(u8 *eui, struct net_device *dev)
128 {
129         if (dev->addr_len != ETH_ALEN)
130                 return -1;
131
132         /*
133          * The zSeries OSA network cards can be shared among various
134          * OS instances, but the OSA cards have only one MAC address.
135          * This leads to duplicate address conflicts in conjunction
136          * with IPv6 if more than one instance uses the same card.
137          *
138          * The driver for these cards can deliver a unique 16-bit
139          * identifier for each instance sharing the same card.  It is
140          * placed instead of 0xFFFE in the interface identifier.  The
141          * "u" bit of the interface identifier is not inverted in this
142          * case.  Hence the resulting interface identifier has local
143          * scope according to RFC2373.
144          */
145
146         addrconf_addr_eui48_base(eui, dev->dev_addr);
147
148         if (dev->dev_id) {
149                 eui[3] = (dev->dev_id >> 8) & 0xFF;
150                 eui[4] = dev->dev_id & 0xFF;
151         } else {
152                 eui[0] ^= 2;
153         }
154
155         return 0;
156 }
157
158 static inline unsigned long addrconf_timeout_fixup(u32 timeout,
159                                                    unsigned int unit)
160 {
161         if (timeout == 0xffffffff)
162                 return ~0UL;
163
164         /*
165          * Avoid arithmetic overflow.
166          * Assuming unit is constant and non-zero, this "if" statement
167          * will go away on 64bit archs.
168          */
169         if (0xfffffffe > LONG_MAX / unit && timeout > LONG_MAX / unit)
170                 return LONG_MAX / unit;
171
172         return timeout;
173 }
174
175 static inline int addrconf_finite_timeout(unsigned long timeout)
176 {
177         return ~timeout;
178 }
179
180 /*
181  *      IPv6 Address Label subsystem (addrlabel.c)
182  */
183 int ipv6_addr_label_init(void);
184 void ipv6_addr_label_cleanup(void);
185 void ipv6_addr_label_rtnl_register(void);
186 u32 ipv6_addr_label(struct net *net, const struct in6_addr *addr,
187                     int type, int ifindex);
188
189 /*
190  *      multicast prototypes (mcast.c)
191  */
192 int ipv6_sock_mc_join(struct sock *sk, int ifindex,
193                       const struct in6_addr *addr);
194 int ipv6_sock_mc_drop(struct sock *sk, int ifindex,
195                       const struct in6_addr *addr);
196 void __ipv6_sock_mc_close(struct sock *sk);
197 void ipv6_sock_mc_close(struct sock *sk);
198 bool inet6_mc_check(struct sock *sk, const struct in6_addr *mc_addr,
199                     const struct in6_addr *src_addr);
200
201 int ipv6_dev_mc_inc(struct net_device *dev, const struct in6_addr *addr);
202 int __ipv6_dev_mc_dec(struct inet6_dev *idev, const struct in6_addr *addr);
203 int ipv6_dev_mc_dec(struct net_device *dev, const struct in6_addr *addr);
204 void ipv6_mc_up(struct inet6_dev *idev);
205 void ipv6_mc_down(struct inet6_dev *idev);
206 void ipv6_mc_unmap(struct inet6_dev *idev);
207 void ipv6_mc_remap(struct inet6_dev *idev);
208 void ipv6_mc_init_dev(struct inet6_dev *idev);
209 void ipv6_mc_destroy_dev(struct inet6_dev *idev);
210 int ipv6_mc_check_mld(struct sk_buff *skb, struct sk_buff **skb_trimmed);
211 void addrconf_dad_failure(struct inet6_ifaddr *ifp);
212
213 bool ipv6_chk_mcast_addr(struct net_device *dev, const struct in6_addr *group,
214                          const struct in6_addr *src_addr);
215
216 void ipv6_mc_dad_complete(struct inet6_dev *idev);
217
218 /* A stub used by vxlan module. This is ugly, ideally these
219  * symbols should be built into the core kernel.
220  */
221 struct ipv6_stub {
222         int (*ipv6_sock_mc_join)(struct sock *sk, int ifindex,
223                                  const struct in6_addr *addr);
224         int (*ipv6_sock_mc_drop)(struct sock *sk, int ifindex,
225                                  const struct in6_addr *addr);
226         int (*ipv6_dst_lookup)(struct net *net, struct sock *sk,
227                                struct dst_entry **dst, struct flowi6 *fl6);
228         void (*udpv6_encap_enable)(void);
229         void (*ndisc_send_na)(struct net_device *dev, const struct in6_addr *daddr,
230                               const struct in6_addr *solicited_addr,
231                               bool router, bool solicited, bool override, bool inc_opt);
232         struct neigh_table *nd_tbl;
233 };
234 extern const struct ipv6_stub *ipv6_stub __read_mostly;
235
236 /*
237  * identify MLD packets for MLD filter exceptions
238  */
239 static inline bool ipv6_is_mld(struct sk_buff *skb, int nexthdr, int offset)
240 {
241         struct icmp6hdr *hdr;
242
243         if (nexthdr != IPPROTO_ICMPV6 ||
244             !pskb_network_may_pull(skb, offset + sizeof(struct icmp6hdr)))
245                 return false;
246
247         hdr = (struct icmp6hdr *)(skb_network_header(skb) + offset);
248
249         switch (hdr->icmp6_type) {
250         case ICMPV6_MGM_QUERY:
251         case ICMPV6_MGM_REPORT:
252         case ICMPV6_MGM_REDUCTION:
253         case ICMPV6_MLD2_REPORT:
254                 return true;
255         default:
256                 break;
257         }
258         return false;
259 }
260
261 void addrconf_prefix_rcv(struct net_device *dev,
262                          u8 *opt, int len, bool sllao);
263
264 /*
265  *      anycast prototypes (anycast.c)
266  */
267 int ipv6_sock_ac_join(struct sock *sk, int ifindex,
268                       const struct in6_addr *addr);
269 int ipv6_sock_ac_drop(struct sock *sk, int ifindex,
270                       const struct in6_addr *addr);
271 void ipv6_sock_ac_close(struct sock *sk);
272
273 int __ipv6_dev_ac_inc(struct inet6_dev *idev, const struct in6_addr *addr);
274 int __ipv6_dev_ac_dec(struct inet6_dev *idev, const struct in6_addr *addr);
275 void ipv6_ac_destroy_dev(struct inet6_dev *idev);
276 bool ipv6_chk_acast_addr(struct net *net, struct net_device *dev,
277                          const struct in6_addr *addr);
278 bool ipv6_chk_acast_addr_src(struct net *net, struct net_device *dev,
279                              const struct in6_addr *addr);
280
281 /* Device notifier */
282 int register_inet6addr_notifier(struct notifier_block *nb);
283 int unregister_inet6addr_notifier(struct notifier_block *nb);
284 int inet6addr_notifier_call_chain(unsigned long val, void *v);
285
286 int register_inet6addr_validator_notifier(struct notifier_block *nb);
287 int unregister_inet6addr_validator_notifier(struct notifier_block *nb);
288 int inet6addr_validator_notifier_call_chain(unsigned long val, void *v);
289
290 void inet6_netconf_notify_devconf(struct net *net, int event, int type,
291                                   int ifindex, struct ipv6_devconf *devconf);
292
293 /**
294  * __in6_dev_get - get inet6_dev pointer from netdevice
295  * @dev: network device
296  *
297  * Caller must hold rcu_read_lock or RTNL, because this function
298  * does not take a reference on the inet6_dev.
299  */
300 static inline struct inet6_dev *__in6_dev_get(const struct net_device *dev)
301 {
302         return rcu_dereference_rtnl(dev->ip6_ptr);
303 }
304
305 /**
306  * in6_dev_get - get inet6_dev pointer from netdevice
307  * @dev: network device
308  *
309  * This version can be used in any context, and takes a reference
310  * on the inet6_dev. Callers must use in6_dev_put() later to
311  * release this reference.
312  */
313 static inline struct inet6_dev *in6_dev_get(const struct net_device *dev)
314 {
315         struct inet6_dev *idev;
316
317         rcu_read_lock();
318         idev = rcu_dereference(dev->ip6_ptr);
319         if (idev)
320                 refcount_inc(&idev->refcnt);
321         rcu_read_unlock();
322         return idev;
323 }
324
325 static inline struct neigh_parms *__in6_dev_nd_parms_get_rcu(const struct net_device *dev)
326 {
327         struct inet6_dev *idev = __in6_dev_get(dev);
328
329         return idev ? idev->nd_parms : NULL;
330 }
331
332 void in6_dev_finish_destroy(struct inet6_dev *idev);
333
334 static inline void in6_dev_put(struct inet6_dev *idev)
335 {
336         if (refcount_dec_and_test(&idev->refcnt))
337                 in6_dev_finish_destroy(idev);
338 }
339
340 static inline void in6_dev_put_clear(struct inet6_dev **pidev)
341 {
342         struct inet6_dev *idev = *pidev;
343
344         if (idev) {
345                 in6_dev_put(idev);
346                 *pidev = NULL;
347         }
348 }
349
350 static inline void __in6_dev_put(struct inet6_dev *idev)
351 {
352         refcount_dec(&idev->refcnt);
353 }
354
355 static inline void in6_dev_hold(struct inet6_dev *idev)
356 {
357         refcount_inc(&idev->refcnt);
358 }
359
360 void inet6_ifa_finish_destroy(struct inet6_ifaddr *ifp);
361
362 static inline void in6_ifa_put(struct inet6_ifaddr *ifp)
363 {
364         if (refcount_dec_and_test(&ifp->refcnt))
365                 inet6_ifa_finish_destroy(ifp);
366 }
367
368 static inline void __in6_ifa_put(struct inet6_ifaddr *ifp)
369 {
370         refcount_dec(&ifp->refcnt);
371 }
372
373 static inline void in6_ifa_hold(struct inet6_ifaddr *ifp)
374 {
375         refcount_inc(&ifp->refcnt);
376 }
377
378
379 /*
380  *      compute link-local solicited-node multicast address
381  */
382
383 static inline void addrconf_addr_solict_mult(const struct in6_addr *addr,
384                                              struct in6_addr *solicited)
385 {
386         ipv6_addr_set(solicited,
387                       htonl(0xFF020000), 0,
388                       htonl(0x1),
389                       htonl(0xFF000000) | addr->s6_addr32[3]);
390 }
391
392 static inline bool ipv6_addr_is_ll_all_nodes(const struct in6_addr *addr)
393 {
394 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) && BITS_PER_LONG == 64
395         __be64 *p = (__be64 *)addr;
396         return ((p[0] ^ cpu_to_be64(0xff02000000000000UL)) | (p[1] ^ cpu_to_be64(1))) == 0UL;
397 #else
398         return ((addr->s6_addr32[0] ^ htonl(0xff020000)) |
399                 addr->s6_addr32[1] | addr->s6_addr32[2] |
400                 (addr->s6_addr32[3] ^ htonl(0x00000001))) == 0;
401 #endif
402 }
403
404 static inline bool ipv6_addr_is_ll_all_routers(const struct in6_addr *addr)
405 {
406 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) && BITS_PER_LONG == 64
407         __be64 *p = (__be64 *)addr;
408         return ((p[0] ^ cpu_to_be64(0xff02000000000000UL)) | (p[1] ^ cpu_to_be64(2))) == 0UL;
409 #else
410         return ((addr->s6_addr32[0] ^ htonl(0xff020000)) |
411                 addr->s6_addr32[1] | addr->s6_addr32[2] |
412                 (addr->s6_addr32[3] ^ htonl(0x00000002))) == 0;
413 #endif
414 }
415
416 static inline bool ipv6_addr_is_isatap(const struct in6_addr *addr)
417 {
418         return (addr->s6_addr32[2] | htonl(0x02000000)) == htonl(0x02005EFE);
419 }
420
421 static inline bool ipv6_addr_is_solict_mult(const struct in6_addr *addr)
422 {
423 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) && BITS_PER_LONG == 64
424         __be64 *p = (__be64 *)addr;
425         return ((p[0] ^ cpu_to_be64(0xff02000000000000UL)) |
426                 ((p[1] ^ cpu_to_be64(0x00000001ff000000UL)) &
427                  cpu_to_be64(0xffffffffff000000UL))) == 0UL;
428 #else
429         return ((addr->s6_addr32[0] ^ htonl(0xff020000)) |
430                 addr->s6_addr32[1] |
431                 (addr->s6_addr32[2] ^ htonl(0x00000001)) |
432                 (addr->s6_addr[12] ^ 0xff)) == 0;
433 #endif
434 }
435
436 #ifdef CONFIG_PROC_FS
437 int if6_proc_init(void);
438 void if6_proc_exit(void);
439 #endif
440
441 #endif