ndisc.h 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466
  1. /* SPDX-License-Identifier: GPL-2.0 */
  2. #ifndef _NDISC_H
  3. #define _NDISC_H
  4. /*
  5. * ICMP codes for neighbour discovery messages
  6. */
  7. #define NDISC_ROUTER_SOLICITATION 133
  8. #define NDISC_ROUTER_ADVERTISEMENT 134
  9. #define NDISC_NEIGHBOUR_SOLICITATION 135
  10. #define NDISC_NEIGHBOUR_ADVERTISEMENT 136
  11. #define NDISC_REDIRECT 137
  12. /*
  13. * Router type: cross-layer information from link-layer to
  14. * IPv6 layer reported by certain link types (e.g., RFC4214).
  15. */
  16. #define NDISC_NODETYPE_UNSPEC 0 /* unspecified (default) */
  17. #define NDISC_NODETYPE_HOST 1 /* host or unauthorized router */
  18. #define NDISC_NODETYPE_NODEFAULT 2 /* non-default router */
  19. #define NDISC_NODETYPE_DEFAULT 3 /* default router */
  20. /*
  21. * ndisc options
  22. */
  23. enum {
  24. __ND_OPT_PREFIX_INFO_END = 0,
  25. ND_OPT_SOURCE_LL_ADDR = 1, /* RFC2461 */
  26. ND_OPT_TARGET_LL_ADDR = 2, /* RFC2461 */
  27. ND_OPT_PREFIX_INFO = 3, /* RFC2461 */
  28. ND_OPT_REDIRECT_HDR = 4, /* RFC2461 */
  29. ND_OPT_MTU = 5, /* RFC2461 */
  30. ND_OPT_NONCE = 14, /* RFC7527 */
  31. __ND_OPT_ARRAY_MAX,
  32. ND_OPT_ROUTE_INFO = 24, /* RFC4191 */
  33. ND_OPT_RDNSS = 25, /* RFC5006 */
  34. ND_OPT_DNSSL = 31, /* RFC6106 */
  35. ND_OPT_6CO = 34, /* RFC6775 */
  36. ND_OPT_CAPTIVE_PORTAL = 37, /* RFC7710 */
  37. ND_OPT_PREF64 = 38, /* RFC8781 */
  38. __ND_OPT_MAX
  39. };
  40. #define MAX_RTR_SOLICITATION_DELAY HZ
  41. #define ND_REACHABLE_TIME (30*HZ)
  42. #define ND_RETRANS_TIMER HZ
  43. #include <linux/compiler.h>
  44. #include <linux/icmpv6.h>
  45. #include <linux/in6.h>
  46. #include <linux/types.h>
  47. #include <linux/if_arp.h>
  48. #include <linux/netdevice.h>
  49. #include <linux/hash.h>
  50. #include <net/neighbour.h>
  51. /* Set to 3 to get tracing... */
  52. #define ND_DEBUG 1
  53. #define ND_PRINTK(val, level, fmt, ...) \
  54. do { \
  55. if (val <= ND_DEBUG) \
  56. net_##level##_ratelimited(fmt, ##__VA_ARGS__); \
  57. } while (0)
  58. struct ctl_table;
  59. struct inet6_dev;
  60. struct net_device;
  61. struct net_proto_family;
  62. struct sk_buff;
  63. struct prefix_info;
  64. extern struct neigh_table nd_tbl;
  65. struct nd_msg {
  66. struct icmp6hdr icmph;
  67. struct in6_addr target;
  68. __u8 opt[0];
  69. };
  70. struct rs_msg {
  71. struct icmp6hdr icmph;
  72. __u8 opt[0];
  73. };
  74. struct ra_msg {
  75. struct icmp6hdr icmph;
  76. __be32 reachable_time;
  77. __be32 retrans_timer;
  78. };
  79. struct rd_msg {
  80. struct icmp6hdr icmph;
  81. struct in6_addr target;
  82. struct in6_addr dest;
  83. __u8 opt[0];
  84. };
  85. struct nd_opt_hdr {
  86. __u8 nd_opt_type;
  87. __u8 nd_opt_len;
  88. } __packed;
  89. /* ND options */
  90. struct ndisc_options {
  91. struct nd_opt_hdr *nd_opt_array[__ND_OPT_ARRAY_MAX];
  92. #ifdef CONFIG_IPV6_ROUTE_INFO
  93. struct nd_opt_hdr *nd_opts_ri;
  94. struct nd_opt_hdr *nd_opts_ri_end;
  95. #endif
  96. struct nd_opt_hdr *nd_useropts;
  97. struct nd_opt_hdr *nd_useropts_end;
  98. #if IS_ENABLED(CONFIG_IEEE802154_6LOWPAN)
  99. struct nd_opt_hdr *nd_802154_opt_array[ND_OPT_TARGET_LL_ADDR + 1];
  100. #endif
  101. };
  102. #define nd_opts_src_lladdr nd_opt_array[ND_OPT_SOURCE_LL_ADDR]
  103. #define nd_opts_tgt_lladdr nd_opt_array[ND_OPT_TARGET_LL_ADDR]
  104. #define nd_opts_pi nd_opt_array[ND_OPT_PREFIX_INFO]
  105. #define nd_opts_pi_end nd_opt_array[__ND_OPT_PREFIX_INFO_END]
  106. #define nd_opts_rh nd_opt_array[ND_OPT_REDIRECT_HDR]
  107. #define nd_opts_mtu nd_opt_array[ND_OPT_MTU]
  108. #define nd_opts_nonce nd_opt_array[ND_OPT_NONCE]
  109. #define nd_802154_opts_src_lladdr nd_802154_opt_array[ND_OPT_SOURCE_LL_ADDR]
  110. #define nd_802154_opts_tgt_lladdr nd_802154_opt_array[ND_OPT_TARGET_LL_ADDR]
  111. #define NDISC_OPT_SPACE(len) (((len)+2+7)&~7)
  112. struct ndisc_options *ndisc_parse_options(const struct net_device *dev,
  113. u8 *opt, int opt_len,
  114. struct ndisc_options *ndopts);
  115. void __ndisc_fill_addr_option(struct sk_buff *skb, int type, void *data,
  116. int data_len, int pad);
  117. #define NDISC_OPS_REDIRECT_DATA_SPACE 2
  118. /*
  119. * This structure defines the hooks for IPv6 neighbour discovery.
  120. * The following hooks can be defined; unless noted otherwise, they are
  121. * optional and can be filled with a null pointer.
  122. *
  123. * int (*is_useropt)(u8 nd_opt_type):
  124. * This function is called when IPv6 decide RA userspace options. if
  125. * this function returns 1 then the option given by nd_opt_type will
  126. * be handled as userspace option additional to the IPv6 options.
  127. *
  128. * int (*parse_options)(const struct net_device *dev,
  129. * struct nd_opt_hdr *nd_opt,
  130. * struct ndisc_options *ndopts):
  131. * This function is called while parsing ndisc ops and put each position
  132. * as pointer into ndopts. If this function return unequal 0, then this
  133. * function took care about the ndisc option, if 0 then the IPv6 ndisc
  134. * option parser will take care about that option.
  135. *
  136. * void (*update)(const struct net_device *dev, struct neighbour *n,
  137. * u32 flags, u8 icmp6_type,
  138. * const struct ndisc_options *ndopts):
  139. * This function is called when IPv6 ndisc updates the neighbour cache
  140. * entry. Additional options which can be updated may be previously
  141. * parsed by parse_opts callback and accessible over ndopts parameter.
  142. *
  143. * int (*opt_addr_space)(const struct net_device *dev, u8 icmp6_type,
  144. * struct neighbour *neigh, u8 *ha_buf,
  145. * u8 **ha):
  146. * This function is called when the necessary option space will be
  147. * calculated before allocating a skb. The parameters neigh, ha_buf
  148. * abd ha are available on NDISC_REDIRECT messages only.
  149. *
  150. * void (*fill_addr_option)(const struct net_device *dev,
  151. * struct sk_buff *skb, u8 icmp6_type,
  152. * const u8 *ha):
  153. * This function is called when the skb will finally fill the option
  154. * fields inside skb. NOTE: this callback should fill the option
  155. * fields to the skb which are previously indicated by opt_space
  156. * parameter. That means the decision to add such option should
  157. * not lost between these two callbacks, e.g. protected by interface
  158. * up state.
  159. *
  160. * void (*prefix_rcv_add_addr)(struct net *net, struct net_device *dev,
  161. * const struct prefix_info *pinfo,
  162. * struct inet6_dev *in6_dev,
  163. * struct in6_addr *addr,
  164. * int addr_type, u32 addr_flags,
  165. * bool sllao, bool tokenized,
  166. * __u32 valid_lft, u32 prefered_lft,
  167. * bool dev_addr_generated):
  168. * This function is called when a RA messages is received with valid
  169. * PIO option fields and an IPv6 address will be added to the interface
  170. * for autoconfiguration. The parameter dev_addr_generated reports about
  171. * if the address was based on dev->dev_addr or not. This can be used
  172. * to add a second address if link-layer operates with two link layer
  173. * addresses. E.g. 802.15.4 6LoWPAN.
  174. */
  175. struct ndisc_ops {
  176. int (*is_useropt)(u8 nd_opt_type);
  177. int (*parse_options)(const struct net_device *dev,
  178. struct nd_opt_hdr *nd_opt,
  179. struct ndisc_options *ndopts);
  180. void (*update)(const struct net_device *dev, struct neighbour *n,
  181. u32 flags, u8 icmp6_type,
  182. const struct ndisc_options *ndopts);
  183. int (*opt_addr_space)(const struct net_device *dev, u8 icmp6_type,
  184. struct neighbour *neigh, u8 *ha_buf,
  185. u8 **ha);
  186. void (*fill_addr_option)(const struct net_device *dev,
  187. struct sk_buff *skb, u8 icmp6_type,
  188. const u8 *ha);
  189. void (*prefix_rcv_add_addr)(struct net *net, struct net_device *dev,
  190. const struct prefix_info *pinfo,
  191. struct inet6_dev *in6_dev,
  192. struct in6_addr *addr,
  193. int addr_type, u32 addr_flags,
  194. bool sllao, bool tokenized,
  195. __u32 valid_lft, u32 prefered_lft,
  196. bool dev_addr_generated);
  197. };
  198. #if IS_ENABLED(CONFIG_IPV6)
  199. static inline int ndisc_ops_is_useropt(const struct net_device *dev,
  200. u8 nd_opt_type)
  201. {
  202. if (dev->ndisc_ops && dev->ndisc_ops->is_useropt)
  203. return dev->ndisc_ops->is_useropt(nd_opt_type);
  204. else
  205. return 0;
  206. }
  207. static inline int ndisc_ops_parse_options(const struct net_device *dev,
  208. struct nd_opt_hdr *nd_opt,
  209. struct ndisc_options *ndopts)
  210. {
  211. if (dev->ndisc_ops && dev->ndisc_ops->parse_options)
  212. return dev->ndisc_ops->parse_options(dev, nd_opt, ndopts);
  213. else
  214. return 0;
  215. }
  216. static inline void ndisc_ops_update(const struct net_device *dev,
  217. struct neighbour *n, u32 flags,
  218. u8 icmp6_type,
  219. const struct ndisc_options *ndopts)
  220. {
  221. if (dev->ndisc_ops && dev->ndisc_ops->update)
  222. dev->ndisc_ops->update(dev, n, flags, icmp6_type, ndopts);
  223. }
  224. static inline int ndisc_ops_opt_addr_space(const struct net_device *dev,
  225. u8 icmp6_type)
  226. {
  227. if (dev->ndisc_ops && dev->ndisc_ops->opt_addr_space &&
  228. icmp6_type != NDISC_REDIRECT)
  229. return dev->ndisc_ops->opt_addr_space(dev, icmp6_type, NULL,
  230. NULL, NULL);
  231. else
  232. return 0;
  233. }
  234. static inline int ndisc_ops_redirect_opt_addr_space(const struct net_device *dev,
  235. struct neighbour *neigh,
  236. u8 *ha_buf, u8 **ha)
  237. {
  238. if (dev->ndisc_ops && dev->ndisc_ops->opt_addr_space)
  239. return dev->ndisc_ops->opt_addr_space(dev, NDISC_REDIRECT,
  240. neigh, ha_buf, ha);
  241. else
  242. return 0;
  243. }
  244. static inline void ndisc_ops_fill_addr_option(const struct net_device *dev,
  245. struct sk_buff *skb,
  246. u8 icmp6_type)
  247. {
  248. if (dev->ndisc_ops && dev->ndisc_ops->fill_addr_option &&
  249. icmp6_type != NDISC_REDIRECT)
  250. dev->ndisc_ops->fill_addr_option(dev, skb, icmp6_type, NULL);
  251. }
  252. static inline void ndisc_ops_fill_redirect_addr_option(const struct net_device *dev,
  253. struct sk_buff *skb,
  254. const u8 *ha)
  255. {
  256. if (dev->ndisc_ops && dev->ndisc_ops->fill_addr_option)
  257. dev->ndisc_ops->fill_addr_option(dev, skb, NDISC_REDIRECT, ha);
  258. }
  259. static inline void ndisc_ops_prefix_rcv_add_addr(struct net *net,
  260. struct net_device *dev,
  261. const struct prefix_info *pinfo,
  262. struct inet6_dev *in6_dev,
  263. struct in6_addr *addr,
  264. int addr_type, u32 addr_flags,
  265. bool sllao, bool tokenized,
  266. __u32 valid_lft,
  267. u32 prefered_lft,
  268. bool dev_addr_generated)
  269. {
  270. if (dev->ndisc_ops && dev->ndisc_ops->prefix_rcv_add_addr)
  271. dev->ndisc_ops->prefix_rcv_add_addr(net, dev, pinfo, in6_dev,
  272. addr, addr_type,
  273. addr_flags, sllao,
  274. tokenized, valid_lft,
  275. prefered_lft,
  276. dev_addr_generated);
  277. }
  278. #endif
  279. /*
  280. * Return the padding between the option length and the start of the
  281. * link addr. Currently only IP-over-InfiniBand needs this, although
  282. * if RFC 3831 IPv6-over-Fibre Channel is ever implemented it may
  283. * also need a pad of 2.
  284. */
  285. static inline int ndisc_addr_option_pad(unsigned short type)
  286. {
  287. switch (type) {
  288. case ARPHRD_INFINIBAND: return 2;
  289. default: return 0;
  290. }
  291. }
  292. static inline int __ndisc_opt_addr_space(unsigned char addr_len, int pad)
  293. {
  294. return NDISC_OPT_SPACE(addr_len + pad);
  295. }
  296. #if IS_ENABLED(CONFIG_IPV6)
  297. static inline int ndisc_opt_addr_space(struct net_device *dev, u8 icmp6_type)
  298. {
  299. return __ndisc_opt_addr_space(dev->addr_len,
  300. ndisc_addr_option_pad(dev->type)) +
  301. ndisc_ops_opt_addr_space(dev, icmp6_type);
  302. }
  303. static inline int ndisc_redirect_opt_addr_space(struct net_device *dev,
  304. struct neighbour *neigh,
  305. u8 *ops_data_buf,
  306. u8 **ops_data)
  307. {
  308. return __ndisc_opt_addr_space(dev->addr_len,
  309. ndisc_addr_option_pad(dev->type)) +
  310. ndisc_ops_redirect_opt_addr_space(dev, neigh, ops_data_buf,
  311. ops_data);
  312. }
  313. #endif
  314. static inline u8 *__ndisc_opt_addr_data(struct nd_opt_hdr *p,
  315. unsigned char addr_len, int prepad)
  316. {
  317. u8 *lladdr = (u8 *)(p + 1);
  318. int lladdrlen = p->nd_opt_len << 3;
  319. if (lladdrlen != __ndisc_opt_addr_space(addr_len, prepad))
  320. return NULL;
  321. return lladdr + prepad;
  322. }
  323. static inline u8 *ndisc_opt_addr_data(struct nd_opt_hdr *p,
  324. struct net_device *dev)
  325. {
  326. return __ndisc_opt_addr_data(p, dev->addr_len,
  327. ndisc_addr_option_pad(dev->type));
  328. }
  329. static inline u32 ndisc_hashfn(const void *pkey, const struct net_device *dev, __u32 *hash_rnd)
  330. {
  331. const u32 *p32 = pkey;
  332. return (((p32[0] ^ hash32_ptr(dev)) * hash_rnd[0]) +
  333. (p32[1] * hash_rnd[1]) +
  334. (p32[2] * hash_rnd[2]) +
  335. (p32[3] * hash_rnd[3]));
  336. }
  337. static inline struct neighbour *__ipv6_neigh_lookup_noref(struct net_device *dev, const void *pkey)
  338. {
  339. return ___neigh_lookup_noref(&nd_tbl, neigh_key_eq128, ndisc_hashfn, pkey, dev);
  340. }
  341. static inline struct neighbour *__ipv6_neigh_lookup(struct net_device *dev, const void *pkey)
  342. {
  343. struct neighbour *n;
  344. rcu_read_lock_bh();
  345. n = __ipv6_neigh_lookup_noref(dev, pkey);
  346. if (n && !refcount_inc_not_zero(&n->refcnt))
  347. n = NULL;
  348. rcu_read_unlock_bh();
  349. return n;
  350. }
  351. static inline void __ipv6_confirm_neigh(struct net_device *dev,
  352. const void *pkey)
  353. {
  354. struct neighbour *n;
  355. rcu_read_lock_bh();
  356. n = __ipv6_neigh_lookup_noref(dev, pkey);
  357. if (n) {
  358. unsigned long now = jiffies;
  359. /* avoid dirtying neighbour */
  360. if (n->confirmed != now)
  361. n->confirmed = now;
  362. }
  363. rcu_read_unlock_bh();
  364. }
  365. int ndisc_init(void);
  366. int ndisc_late_init(void);
  367. void ndisc_late_cleanup(void);
  368. void ndisc_cleanup(void);
  369. int ndisc_rcv(struct sk_buff *skb);
  370. void ndisc_send_ns(struct net_device *dev, const struct in6_addr *solicit,
  371. const struct in6_addr *daddr, const struct in6_addr *saddr,
  372. u64 nonce);
  373. void ndisc_send_rs(struct net_device *dev,
  374. const struct in6_addr *saddr, const struct in6_addr *daddr);
  375. void ndisc_send_na(struct net_device *dev, const struct in6_addr *daddr,
  376. const struct in6_addr *solicited_addr,
  377. bool router, bool solicited, bool override, bool inc_opt);
  378. void ndisc_send_redirect(struct sk_buff *skb, const struct in6_addr *target);
  379. int ndisc_mc_map(const struct in6_addr *addr, char *buf, struct net_device *dev,
  380. int dir);
  381. void ndisc_update(const struct net_device *dev, struct neighbour *neigh,
  382. const u8 *lladdr, u8 new, u32 flags, u8 icmp6_type,
  383. struct ndisc_options *ndopts);
  384. /*
  385. * IGMP
  386. */
  387. int igmp6_init(void);
  388. int igmp6_late_init(void);
  389. void igmp6_cleanup(void);
  390. void igmp6_late_cleanup(void);
  391. int igmp6_event_query(struct sk_buff *skb);
  392. int igmp6_event_report(struct sk_buff *skb);
  393. #ifdef CONFIG_SYSCTL
  394. int ndisc_ifinfo_sysctl_change(struct ctl_table *ctl, int write,
  395. void __user *buffer, size_t *lenp, loff_t *ppos);
  396. int ndisc_ifinfo_sysctl_strategy(struct ctl_table *ctl,
  397. void __user *oldval, size_t __user *oldlenp,
  398. void __user *newval, size_t newlen);
  399. #endif
  400. void inet6_ifinfo_notify(int event, struct inet6_dev *idev);
  401. #endif