9e5e95988b9e5dea7be60b75829830f607b9ce0d
[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)       /* 1 week */
12 #define TEMP_PREFERRED_LIFETIME         (86400)         /* 24 hours */
13 #define REGEN_MIN_ADVANCE               (2)             /* 2 seconds */
14 #define REGEN_MAX_RETRY                 (3)
15 #define MAX_DESYNC_FACTOR               (600)
16
17 #define ADDR_CHECK_FREQUENCY            (120*HZ)
18
19 #define IPV6_MAX_ADDRESSES              16
20
21 #define ADDRCONF_TIMER_FUZZ_MINUS       (HZ > 50 ? HZ / 50 : 1)
22 #define ADDRCONF_TIMER_FUZZ             (HZ / 4)
23 #define ADDRCONF_TIMER_FUZZ_MAX         (HZ)
24
25 #define ADDRCONF_NOTIFY_PRIORITY        0
26
27 #include <linux/in.h>
28 #include <linux/in6.h>
29
30 struct prefix_info {
31         __u8                    type;
32         __u8                    length;
33         __u8                    prefix_len;
34
35         union __packed {
36                 __u8            flags;
37                 struct __packed {
38 #if defined(__BIG_ENDIAN_BITFIELD)
39                         __u8    onlink : 1,
40                                 autoconf : 1,
41                                 routeraddr : 1,
42                                 preferpd : 1,
43                                 reserved : 4;
44 #elif defined(__LITTLE_ENDIAN_BITFIELD)
45                         __u8    reserved : 4,
46                                 preferpd : 1,
47                                 routeraddr : 1,
48                                 autoconf : 1,
49                                 onlink : 1;
50 #else
51 #error "Please fix <asm/byteorder.h>"
52 #endif
53                 };
54         };
55         __be32                  valid;
56         __be32                  prefered;
57         __be32                  reserved2;
58
59         struct in6_addr         prefix;
60 };
61
62 /* rfc4861 4.6.2: IPv6 PIO is 32 bytes in size */
63 static_assert(sizeof(struct prefix_info) == 32);
64
65 #include <linux/ipv6.h>
66 #include <linux/netdevice.h>
67 #include <net/if_inet6.h>
68 #include <net/ipv6.h>
69
70 struct in6_validator_info {
71         struct in6_addr         i6vi_addr;
72         struct inet6_dev        *i6vi_dev;
73         struct netlink_ext_ack  *extack;
74 };
75
76 struct ifa6_config {
77         const struct in6_addr   *pfx;
78         unsigned int            plen;
79
80         u8                      ifa_proto;
81
82         const struct in6_addr   *peer_pfx;
83
84         u32                     rt_priority;
85         u32                     ifa_flags;
86         u32                     preferred_lft;
87         u32                     valid_lft;
88         u16                     scope;
89 };
90
91 enum addr_type_t {
92         UNICAST_ADDR,
93         MULTICAST_ADDR,
94         ANYCAST_ADDR,
95 };
96
97 struct inet6_fill_args {
98         u32 portid;
99         u32 seq;
100         int event;
101         unsigned int flags;
102         int netnsid;
103         int ifindex;
104         enum addr_type_t type;
105         bool force_rt_scope_universe;
106 };
107
108 int addrconf_init(void);
109 void addrconf_cleanup(void);
110
111 int addrconf_add_ifaddr(struct net *net, void __user *arg);
112 int addrconf_del_ifaddr(struct net *net, void __user *arg);
113 int addrconf_set_dstaddr(struct net *net, void __user *arg);
114
115 int ipv6_chk_addr(struct net *net, const struct in6_addr *addr,
116                   const struct net_device *dev, int strict);
117 int ipv6_chk_addr_and_flags(struct net *net, const struct in6_addr *addr,
118                             const struct net_device *dev, bool skip_dev_check,
119                             int strict, u32 banned_flags);
120
121 #if defined(CONFIG_IPV6_MIP6) || defined(CONFIG_IPV6_MIP6_MODULE)
122 int ipv6_chk_home_addr(struct net *net, const struct in6_addr *addr);
123 #endif
124
125 int ipv6_chk_rpl_srh_loop(struct net *net, const struct in6_addr *segs,
126                           unsigned char nsegs);
127
128 bool ipv6_chk_custom_prefix(const struct in6_addr *addr,
129                                    const unsigned int prefix_len,
130                                    struct net_device *dev);
131
132 int ipv6_chk_prefix(const struct in6_addr *addr, struct net_device *dev);
133
134 struct net_device *ipv6_dev_find(struct net *net, const struct in6_addr *addr,
135                                  struct net_device *dev);
136
137 struct inet6_ifaddr *ipv6_get_ifaddr(struct net *net,
138                                      const struct in6_addr *addr,
139                                      struct net_device *dev, int strict);
140
141 int ipv6_dev_get_saddr(struct net *net, const struct net_device *dev,
142                        const struct in6_addr *daddr, unsigned int srcprefs,
143                        struct in6_addr *saddr);
144 int ipv6_get_lladdr(struct net_device *dev, struct in6_addr *addr,
145                     u32 banned_flags);
146 bool inet_rcv_saddr_equal(const struct sock *sk, const struct sock *sk2,
147                           bool match_wildcard);
148 bool inet_rcv_saddr_any(const struct sock *sk);
149 void addrconf_join_solict(struct net_device *dev, const struct in6_addr *addr);
150 void addrconf_leave_solict(struct inet6_dev *idev, const struct in6_addr *addr);
151
152 void addrconf_add_linklocal(struct inet6_dev *idev,
153                             const struct in6_addr *addr, u32 flags);
154
155 int addrconf_prefix_rcv_add_addr(struct net *net, struct net_device *dev,
156                                  const struct prefix_info *pinfo,
157                                  struct inet6_dev *in6_dev,
158                                  const struct in6_addr *addr, int addr_type,
159                                  u32 addr_flags, bool sllao, bool tokenized,
160                                  __u32 valid_lft, u32 prefered_lft);
161
162 static inline void addrconf_addr_eui48_base(u8 *eui, const char *const addr)
163 {
164         memcpy(eui, addr, 3);
165         eui[3] = 0xFF;
166         eui[4] = 0xFE;
167         memcpy(eui + 5, addr + 3, 3);
168 }
169
170 static inline void addrconf_addr_eui48(u8 *eui, const char *const addr)
171 {
172         addrconf_addr_eui48_base(eui, addr);
173         eui[0] ^= 2;
174 }
175
176 static inline int addrconf_ifid_eui48(u8 *eui, struct net_device *dev)
177 {
178         if (dev->addr_len != ETH_ALEN)
179                 return -1;
180
181         /*
182          * The zSeries OSA network cards can be shared among various
183          * OS instances, but the OSA cards have only one MAC address.
184          * This leads to duplicate address conflicts in conjunction
185          * with IPv6 if more than one instance uses the same card.
186          *
187          * The driver for these cards can deliver a unique 16-bit
188          * identifier for each instance sharing the same card.  It is
189          * placed instead of 0xFFFE in the interface identifier.  The
190          * "u" bit of the interface identifier is not inverted in this
191          * case.  Hence the resulting interface identifier has local
192          * scope according to RFC2373.
193          */
194
195         addrconf_addr_eui48_base(eui, dev->dev_addr);
196
197         if (dev->dev_id) {
198                 eui[3] = (dev->dev_id >> 8) & 0xFF;
199                 eui[4] = dev->dev_id & 0xFF;
200         } else {
201                 eui[0] ^= 2;
202         }
203
204         return 0;
205 }
206
207 #define INFINITY_LIFE_TIME 0xFFFFFFFF
208
209 static inline unsigned long addrconf_timeout_fixup(u32 timeout,
210                                                    unsigned int unit)
211 {
212         if (timeout == INFINITY_LIFE_TIME)
213                 return ~0UL;
214
215         /*
216          * Avoid arithmetic overflow.
217          * Assuming unit is constant and non-zero, this "if" statement
218          * will go away on 64bit archs.
219          */
220         if (0xfffffffe > LONG_MAX / unit && timeout > LONG_MAX / unit)
221                 return LONG_MAX / unit;
222
223         return timeout;
224 }
225
226 static inline int addrconf_finite_timeout(unsigned long timeout)
227 {
228         return ~timeout;
229 }
230
231 /*
232  *      IPv6 Address Label subsystem (addrlabel.c)
233  */
234 int ipv6_addr_label_init(void);
235 void ipv6_addr_label_cleanup(void);
236 int ipv6_addr_label_rtnl_register(void);
237 u32 ipv6_addr_label(struct net *net, const struct in6_addr *addr,
238                     int type, int ifindex);
239
240 /*
241  *      multicast prototypes (mcast.c)
242  */
243 static inline bool ipv6_mc_may_pull(struct sk_buff *skb,
244                                     unsigned int len)
245 {
246         if (skb_transport_offset(skb) + ipv6_transport_len(skb) < len)
247                 return false;
248
249         return pskb_may_pull(skb, len);
250 }
251
252 int ipv6_sock_mc_join(struct sock *sk, int ifindex,
253                       const struct in6_addr *addr);
254 int ipv6_sock_mc_drop(struct sock *sk, int ifindex,
255                       const struct in6_addr *addr);
256 void __ipv6_sock_mc_close(struct sock *sk);
257 void ipv6_sock_mc_close(struct sock *sk);
258 bool inet6_mc_check(const struct sock *sk, const struct in6_addr *mc_addr,
259                     const struct in6_addr *src_addr);
260
261 int ipv6_dev_mc_inc(struct net_device *dev, const struct in6_addr *addr);
262 int __ipv6_dev_mc_dec(struct inet6_dev *idev, const struct in6_addr *addr);
263 int ipv6_dev_mc_dec(struct net_device *dev, const struct in6_addr *addr);
264 void ipv6_mc_up(struct inet6_dev *idev);
265 void ipv6_mc_down(struct inet6_dev *idev);
266 void ipv6_mc_unmap(struct inet6_dev *idev);
267 void ipv6_mc_remap(struct inet6_dev *idev);
268 void ipv6_mc_init_dev(struct inet6_dev *idev);
269 void ipv6_mc_destroy_dev(struct inet6_dev *idev);
270 int ipv6_mc_check_mld(struct sk_buff *skb);
271 void addrconf_dad_failure(struct sk_buff *skb, struct inet6_ifaddr *ifp);
272
273 bool ipv6_chk_mcast_addr(struct net_device *dev, const struct in6_addr *group,
274                          const struct in6_addr *src_addr);
275
276 void ipv6_mc_dad_complete(struct inet6_dev *idev);
277
278 /*
279  * identify MLD packets for MLD filter exceptions
280  */
281 static inline bool ipv6_is_mld(struct sk_buff *skb, int nexthdr, int offset)
282 {
283         struct icmp6hdr *hdr;
284
285         if (nexthdr != IPPROTO_ICMPV6 ||
286             !pskb_network_may_pull(skb, offset + sizeof(struct icmp6hdr)))
287                 return false;
288
289         hdr = (struct icmp6hdr *)(skb_network_header(skb) + offset);
290
291         switch (hdr->icmp6_type) {
292         case ICMPV6_MGM_QUERY:
293         case ICMPV6_MGM_REPORT:
294         case ICMPV6_MGM_REDUCTION:
295         case ICMPV6_MLD2_REPORT:
296                 return true;
297         default:
298                 break;
299         }
300         return false;
301 }
302
303 void addrconf_prefix_rcv(struct net_device *dev,
304                          u8 *opt, int len, bool sllao);
305
306 /*
307  *      anycast prototypes (anycast.c)
308  */
309 int ipv6_sock_ac_join(struct sock *sk, int ifindex,
310                       const struct in6_addr *addr);
311 int ipv6_sock_ac_drop(struct sock *sk, int ifindex,
312                       const struct in6_addr *addr);
313 void __ipv6_sock_ac_close(struct sock *sk);
314 void ipv6_sock_ac_close(struct sock *sk);
315
316 int __ipv6_dev_ac_inc(struct inet6_dev *idev, const struct in6_addr *addr);
317 int __ipv6_dev_ac_dec(struct inet6_dev *idev, const struct in6_addr *addr);
318 void ipv6_ac_destroy_dev(struct inet6_dev *idev);
319 bool ipv6_chk_acast_addr(struct net *net, struct net_device *dev,
320                          const struct in6_addr *addr);
321 bool ipv6_chk_acast_addr_src(struct net *net, struct net_device *dev,
322                              const struct in6_addr *addr);
323 int ipv6_anycast_init(void);
324 void ipv6_anycast_cleanup(void);
325
326 /* Device notifier */
327 int register_inet6addr_notifier(struct notifier_block *nb);
328 int unregister_inet6addr_notifier(struct notifier_block *nb);
329 int inet6addr_notifier_call_chain(unsigned long val, void *v);
330
331 int register_inet6addr_validator_notifier(struct notifier_block *nb);
332 int unregister_inet6addr_validator_notifier(struct notifier_block *nb);
333 int inet6addr_validator_notifier_call_chain(unsigned long val, void *v);
334
335 void inet6_netconf_notify_devconf(struct net *net, int event, int type,
336                                   int ifindex, struct ipv6_devconf *devconf);
337
338 /**
339  * __in6_dev_get - get inet6_dev pointer from netdevice
340  * @dev: network device
341  *
342  * Caller must hold rcu_read_lock or RTNL, because this function
343  * does not take a reference on the inet6_dev.
344  */
345 static inline struct inet6_dev *__in6_dev_get(const struct net_device *dev)
346 {
347         return rcu_dereference_rtnl(dev->ip6_ptr);
348 }
349
350 static inline struct inet6_dev *__in6_dev_get_rtnl_net(const struct net_device *dev)
351 {
352         return rtnl_net_dereference(dev_net(dev), dev->ip6_ptr);
353 }
354
355 /**
356  * __in6_dev_stats_get - get inet6_dev pointer for stats
357  * @dev: network device
358  * @skb: skb for original incoming interface if needed
359  *
360  * Caller must hold rcu_read_lock or RTNL, because this function
361  * does not take a reference on the inet6_dev.
362  */
363 static inline struct inet6_dev *__in6_dev_stats_get(const struct net_device *dev,
364                                                     const struct sk_buff *skb)
365 {
366         if (netif_is_l3_master(dev))
367                 dev = dev_get_by_index_rcu(dev_net(dev), inet6_iif(skb));
368         return __in6_dev_get(dev);
369 }
370
371 /**
372  * __in6_dev_get_safely - get inet6_dev pointer from netdevice
373  * @dev: network device
374  *
375  * This is a safer version of __in6_dev_get
376  */
377 static inline struct inet6_dev *__in6_dev_get_safely(const struct net_device *dev)
378 {
379         if (likely(dev))
380                 return rcu_dereference_rtnl(dev->ip6_ptr);
381         else
382                 return NULL;
383 }
384
385 /**
386  * in6_dev_get - get inet6_dev pointer from netdevice
387  * @dev: network device
388  *
389  * This version can be used in any context, and takes a reference
390  * on the inet6_dev. Callers must use in6_dev_put() later to
391  * release this reference.
392  */
393 static inline struct inet6_dev *in6_dev_get(const struct net_device *dev)
394 {
395         struct inet6_dev *idev;
396
397         rcu_read_lock();
398         idev = rcu_dereference(dev->ip6_ptr);
399         if (idev)
400                 refcount_inc(&idev->refcnt);
401         rcu_read_unlock();
402         return idev;
403 }
404
405 static inline struct neigh_parms *__in6_dev_nd_parms_get_rcu(const struct net_device *dev)
406 {
407         struct inet6_dev *idev = __in6_dev_get(dev);
408
409         return idev ? idev->nd_parms : NULL;
410 }
411
412 void in6_dev_finish_destroy(struct inet6_dev *idev);
413
414 static inline void in6_dev_put(struct inet6_dev *idev)
415 {
416         if (refcount_dec_and_test(&idev->refcnt))
417                 in6_dev_finish_destroy(idev);
418 }
419
420 static inline void in6_dev_put_clear(struct inet6_dev **pidev)
421 {
422         struct inet6_dev *idev = *pidev;
423
424         if (idev) {
425                 in6_dev_put(idev);
426                 *pidev = NULL;
427         }
428 }
429
430 static inline void __in6_dev_put(struct inet6_dev *idev)
431 {
432         refcount_dec(&idev->refcnt);
433 }
434
435 static inline void in6_dev_hold(struct inet6_dev *idev)
436 {
437         refcount_inc(&idev->refcnt);
438 }
439
440 /* called with rcu_read_lock held */
441 static inline bool ip6_ignore_linkdown(const struct net_device *dev)
442 {
443         const struct inet6_dev *idev = __in6_dev_get(dev);
444
445         if (unlikely(!idev))
446                 return true;
447
448         return !!READ_ONCE(idev->cnf.ignore_routes_with_linkdown);
449 }
450
451 void inet6_ifa_finish_destroy(struct inet6_ifaddr *ifp);
452
453 static inline void in6_ifa_put(struct inet6_ifaddr *ifp)
454 {
455         if (refcount_dec_and_test(&ifp->refcnt))
456                 inet6_ifa_finish_destroy(ifp);
457 }
458
459 static inline void __in6_ifa_put(struct inet6_ifaddr *ifp)
460 {
461         refcount_dec(&ifp->refcnt);
462 }
463
464 static inline void in6_ifa_hold(struct inet6_ifaddr *ifp)
465 {
466         refcount_inc(&ifp->refcnt);
467 }
468
469 static inline bool in6_ifa_hold_safe(struct inet6_ifaddr *ifp)
470 {
471         return refcount_inc_not_zero(&ifp->refcnt);
472 }
473
474 /*
475  *      compute link-local solicited-node multicast address
476  */
477
478 static inline void addrconf_addr_solict_mult(const struct in6_addr *addr,
479                                              struct in6_addr *solicited)
480 {
481         ipv6_addr_set(solicited,
482                       htonl(0xFF020000), 0,
483                       htonl(0x1),
484                       htonl(0xFF000000) | addr->s6_addr32[3]);
485 }
486
487 static inline bool ipv6_addr_is_ll_all_nodes(const struct in6_addr *addr)
488 {
489 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) && BITS_PER_LONG == 64
490         __be64 *p = (__force __be64 *)addr;
491         return ((p[0] ^ cpu_to_be64(0xff02000000000000UL)) | (p[1] ^ cpu_to_be64(1))) == 0UL;
492 #else
493         return ((addr->s6_addr32[0] ^ htonl(0xff020000)) |
494                 addr->s6_addr32[1] | addr->s6_addr32[2] |
495                 (addr->s6_addr32[3] ^ htonl(0x00000001))) == 0;
496 #endif
497 }
498
499 static inline bool ipv6_addr_is_ll_all_routers(const struct in6_addr *addr)
500 {
501 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) && BITS_PER_LONG == 64
502         __be64 *p = (__force __be64 *)addr;
503         return ((p[0] ^ cpu_to_be64(0xff02000000000000UL)) | (p[1] ^ cpu_to_be64(2))) == 0UL;
504 #else
505         return ((addr->s6_addr32[0] ^ htonl(0xff020000)) |
506                 addr->s6_addr32[1] | addr->s6_addr32[2] |
507                 (addr->s6_addr32[3] ^ htonl(0x00000002))) == 0;
508 #endif
509 }
510
511 static inline bool ipv6_addr_is_isatap(const struct in6_addr *addr)
512 {
513         return (addr->s6_addr32[2] | htonl(0x02000000)) == htonl(0x02005EFE);
514 }
515
516 static inline bool ipv6_addr_is_solict_mult(const struct in6_addr *addr)
517 {
518 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) && BITS_PER_LONG == 64
519         __be64 *p = (__force __be64 *)addr;
520         return ((p[0] ^ cpu_to_be64(0xff02000000000000UL)) |
521                 ((p[1] ^ cpu_to_be64(0x00000001ff000000UL)) &
522                  cpu_to_be64(0xffffffffff000000UL))) == 0UL;
523 #else
524         return ((addr->s6_addr32[0] ^ htonl(0xff020000)) |
525                 addr->s6_addr32[1] |
526                 (addr->s6_addr32[2] ^ htonl(0x00000001)) |
527                 (addr->s6_addr[12] ^ 0xff)) == 0;
528 #endif
529 }
530
531 static inline bool ipv6_addr_is_all_snoopers(const struct in6_addr *addr)
532 {
533 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) && BITS_PER_LONG == 64
534         __be64 *p = (__force __be64 *)addr;
535
536         return ((p[0] ^ cpu_to_be64(0xff02000000000000UL)) |
537                 (p[1] ^ cpu_to_be64(0x6a))) == 0UL;
538 #else
539         return ((addr->s6_addr32[0] ^ htonl(0xff020000)) |
540                 addr->s6_addr32[1] | addr->s6_addr32[2] |
541                 (addr->s6_addr32[3] ^ htonl(0x0000006a))) == 0;
542 #endif
543 }
544
545 #ifdef CONFIG_PROC_FS
546 int if6_proc_init(void);
547 void if6_proc_exit(void);
548 #endif
549
550 int inet6_fill_ifmcaddr(struct sk_buff *skb,
551                         const struct ifmcaddr6 *ifmca,
552                         struct inet6_fill_args *args);
553
554 int inet6_fill_ifacaddr(struct sk_buff *skb,
555                         const struct ifacaddr6 *ifaca,
556                         struct inet6_fill_args *args);
557 #endif