[mirror_ubuntu-jammy-kernel.git] / include / net / ndisc.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _NDISC_H
#define _NDISC_H

#include <net/ipv6_stubs.h>

/*
 *	ICMP codes for neighbour discovery messages
 */

#define NDISC_ROUTER_SOLICITATION	133
#define NDISC_ROUTER_ADVERTISEMENT	134
#define NDISC_NEIGHBOUR_SOLICITATION	135
#define NDISC_NEIGHBOUR_ADVERTISEMENT	136
#define NDISC_REDIRECT			137

/*
 * Router type: cross-layer information from link-layer to
 * IPv6 layer reported by certain link types (e.g., RFC4214).
 */
#define NDISC_NODETYPE_UNSPEC		0	/* unspecified (default) */
#define NDISC_NODETYPE_HOST		1	/* host or unauthorized router */
#define NDISC_NODETYPE_NODEFAULT	2	/* non-default router */
#define NDISC_NODETYPE_DEFAULT		3	/* default router */

/*
 *	ndisc options
 */

enum {
	__ND_OPT_PREFIX_INFO_END = 0,
	ND_OPT_SOURCE_LL_ADDR = 1,	/* RFC2461 */
	ND_OPT_TARGET_LL_ADDR = 2,	/* RFC2461 */
	ND_OPT_PREFIX_INFO = 3,		/* RFC2461 */
	ND_OPT_REDIRECT_HDR = 4,	/* RFC2461 */
	ND_OPT_MTU = 5,			/* RFC2461 */
	ND_OPT_NONCE = 14,              /* RFC7527 */
	__ND_OPT_ARRAY_MAX,
	ND_OPT_ROUTE_INFO = 24,		/* RFC4191 */
	ND_OPT_RDNSS = 25,		/* RFC5006 */
	ND_OPT_DNSSL = 31,		/* RFC6106 */
	ND_OPT_6CO = 34,		/* RFC6775 */
	ND_OPT_CAPTIVE_PORTAL = 37,	/* RFC7710 */
	__ND_OPT_MAX
};

#define MAX_RTR_SOLICITATION_DELAY	HZ

#define ND_REACHABLE_TIME		(30*HZ)
#define ND_RETRANS_TIMER		HZ

#include <linux/compiler.h>
#include <linux/icmpv6.h>
#include <linux/in6.h>
#include <linux/types.h>
#include <linux/if_arp.h>
#include <linux/netdevice.h>
#include <linux/hash.h>

#include <net/neighbour.h>

/* Set to 3 to get tracing... */
#define ND_DEBUG 1

#define ND_PRINTK(val, level, fmt, ...)				\
do {								\
	if (val <= ND_DEBUG)					\
		net_##level##_ratelimited(fmt, ##__VA_ARGS__);	\
} while (0)

struct ctl_table;
struct inet6_dev;
struct net_device;
struct net_proto_family;
struct sk_buff;
struct prefix_info;

extern struct neigh_table nd_tbl;

struct nd_msg {
        struct icmp6hdr	icmph;
        struct in6_addr	target;
	__u8		opt[0];
};

struct rs_msg {
	struct icmp6hdr	icmph;
	__u8		opt[0];
};

struct ra_msg {
        struct icmp6hdr		icmph;
	__be32			reachable_time;
	__be32			retrans_timer;
};

struct rd_msg {
	struct icmp6hdr icmph;
	struct in6_addr	target;
	struct in6_addr	dest;
	__u8		opt[0];
};

struct nd_opt_hdr {
	__u8		nd_opt_type;
	__u8		nd_opt_len;
} __packed;

/* ND options */
struct ndisc_options {
	struct nd_opt_hdr *nd_opt_array[__ND_OPT_ARRAY_MAX];
#ifdef CONFIG_IPV6_ROUTE_INFO
	struct nd_opt_hdr *nd_opts_ri;
	struct nd_opt_hdr *nd_opts_ri_end;
#endif
	struct nd_opt_hdr *nd_useropts;
	struct nd_opt_hdr *nd_useropts_end;
#if IS_ENABLED(CONFIG_IEEE802154_6LOWPAN)
	struct nd_opt_hdr *nd_802154_opt_array[ND_OPT_TARGET_LL_ADDR + 1];
#endif
};

#define nd_opts_src_lladdr		nd_opt_array[ND_OPT_SOURCE_LL_ADDR]
#define nd_opts_tgt_lladdr		nd_opt_array[ND_OPT_TARGET_LL_ADDR]
#define nd_opts_pi			nd_opt_array[ND_OPT_PREFIX_INFO]
#define nd_opts_pi_end			nd_opt_array[__ND_OPT_PREFIX_INFO_END]
#define nd_opts_rh			nd_opt_array[ND_OPT_REDIRECT_HDR]
#define nd_opts_mtu			nd_opt_array[ND_OPT_MTU]
#define nd_opts_nonce			nd_opt_array[ND_OPT_NONCE]
#define nd_802154_opts_src_lladdr	nd_802154_opt_array[ND_OPT_SOURCE_LL_ADDR]
#define nd_802154_opts_tgt_lladdr	nd_802154_opt_array[ND_OPT_TARGET_LL_ADDR]

#define NDISC_OPT_SPACE(len) (((len)+2+7)&~7)

struct ndisc_options *ndisc_parse_options(const struct net_device *dev,
					  u8 *opt, int opt_len,
					  struct ndisc_options *ndopts);

void __ndisc_fill_addr_option(struct sk_buff *skb, int type, void *data,
			      int data_len, int pad);

#define NDISC_OPS_REDIRECT_DATA_SPACE	2

/*
 * This structure defines the hooks for IPv6 neighbour discovery.
 * The following hooks can be defined; unless noted otherwise, they are
 * optional and can be filled with a null pointer.
 *
 * int (*is_useropt)(u8 nd_opt_type):
 *     This function is called when IPv6 decide RA userspace options. if
 *     this function returns 1 then the option given by nd_opt_type will
 *     be handled as userspace option additional to the IPv6 options.
 *
 * int (*parse_options)(const struct net_device *dev,
 *			struct nd_opt_hdr *nd_opt,
 *			struct ndisc_options *ndopts):
 *     This function is called while parsing ndisc ops and put each position
 *     as pointer into ndopts. If this function return unequal 0, then this
 *     function took care about the ndisc option, if 0 then the IPv6 ndisc
 *     option parser will take care about that option.
 *
 * void (*update)(const struct net_device *dev, struct neighbour *n,
 *		  u32 flags, u8 icmp6_type,
 *		  const struct ndisc_options *ndopts):
 *     This function is called when IPv6 ndisc updates the neighbour cache
 *     entry. Additional options which can be updated may be previously
 *     parsed by parse_opts callback and accessible over ndopts parameter.
 *
 * int (*opt_addr_space)(const struct net_device *dev, u8 icmp6_type,
 *			 struct neighbour *neigh, u8 *ha_buf,
 *			 u8 **ha):
 *     This function is called when the necessary option space will be
 *     calculated before allocating a skb. The parameters neigh, ha_buf
 *     abd ha are available on NDISC_REDIRECT messages only.
 *
 * void (*fill_addr_option)(const struct net_device *dev,
 *			    struct sk_buff *skb, u8 icmp6_type,
 *			    const u8 *ha):
 *     This function is called when the skb will finally fill the option
 *     fields inside skb. NOTE: this callback should fill the option
 *     fields to the skb which are previously indicated by opt_space
 *     parameter. That means the decision to add such option should
 *     not lost between these two callbacks, e.g. protected by interface
 *     up state.
 *
 * void (*prefix_rcv_add_addr)(struct net *net, struct net_device *dev,
 *			       const struct prefix_info *pinfo,
 *			       struct inet6_dev *in6_dev,
 *			       struct in6_addr *addr,
 *			       int addr_type, u32 addr_flags,
 *			       bool sllao, bool tokenized,
 *			       __u32 valid_lft, u32 prefered_lft,
 *			       bool dev_addr_generated):
 *     This function is called when a RA messages is received with valid
 *     PIO option fields and an IPv6 address will be added to the interface
 *     for autoconfiguration. The parameter dev_addr_generated reports about
 *     if the address was based on dev->dev_addr or not. This can be used
 *     to add a second address if link-layer operates with two link layer
 *     addresses. E.g. 802.15.4 6LoWPAN.
 */
struct ndisc_ops {
	int	(*is_useropt)(u8 nd_opt_type);
	int	(*parse_options)(const struct net_device *dev,
				 struct nd_opt_hdr *nd_opt,
				 struct ndisc_options *ndopts);
	void	(*update)(const struct net_device *dev, struct neighbour *n,
			  u32 flags, u8 icmp6_type,
			  const struct ndisc_options *ndopts);
	int	(*opt_addr_space)(const struct net_device *dev, u8 icmp6_type,
				  struct neighbour *neigh, u8 *ha_buf,
				  u8 **ha);
	void	(*fill_addr_option)(const struct net_device *dev,
				    struct sk_buff *skb, u8 icmp6_type,
				    const u8 *ha);
	void	(*prefix_rcv_add_addr)(struct net *net, struct net_device *dev,
				       const struct prefix_info *pinfo,
				       struct inet6_dev *in6_dev,
				       struct in6_addr *addr,
				       int addr_type, u32 addr_flags,
				       bool sllao, bool tokenized,
				       __u32 valid_lft, u32 prefered_lft,
				       bool dev_addr_generated);
};

#if IS_ENABLED(CONFIG_IPV6)
static inline int ndisc_ops_is_useropt(const struct net_device *dev,
				       u8 nd_opt_type)
{
	if (dev->ndisc_ops && dev->ndisc_ops->is_useropt)
		return dev->ndisc_ops->is_useropt(nd_opt_type);
	else
		return 0;
}

static inline int ndisc_ops_parse_options(const struct net_device *dev,
					  struct nd_opt_hdr *nd_opt,
					  struct ndisc_options *ndopts)
{
	if (dev->ndisc_ops && dev->ndisc_ops->parse_options)
		return dev->ndisc_ops->parse_options(dev, nd_opt, ndopts);
	else
		return 0;
}

static inline void ndisc_ops_update(const struct net_device *dev,
					  struct neighbour *n, u32 flags,
					  u8 icmp6_type,
					  const struct ndisc_options *ndopts)
{
	if (dev->ndisc_ops && dev->ndisc_ops->update)
		dev->ndisc_ops->update(dev, n, flags, icmp6_type, ndopts);
}

static inline int ndisc_ops_opt_addr_space(const struct net_device *dev,
					   u8 icmp6_type)
{
	if (dev->ndisc_ops && dev->ndisc_ops->opt_addr_space &&
	    icmp6_type != NDISC_REDIRECT)
		return dev->ndisc_ops->opt_addr_space(dev, icmp6_type, NULL,
						      NULL, NULL);
	else
		return 0;
}

static inline int ndisc_ops_redirect_opt_addr_space(const struct net_device *dev,
						    struct neighbour *neigh,
						    u8 *ha_buf, u8 **ha)
{
	if (dev->ndisc_ops && dev->ndisc_ops->opt_addr_space)
		return dev->ndisc_ops->opt_addr_space(dev, NDISC_REDIRECT,
						      neigh, ha_buf, ha);
	else
		return 0;
}

static inline void ndisc_ops_fill_addr_option(const struct net_device *dev,
					      struct sk_buff *skb,
					      u8 icmp6_type)
{
	if (dev->ndisc_ops && dev->ndisc_ops->fill_addr_option &&
	    icmp6_type != NDISC_REDIRECT)
		dev->ndisc_ops->fill_addr_option(dev, skb, icmp6_type, NULL);
}

static inline void ndisc_ops_fill_redirect_addr_option(const struct net_device *dev,
						       struct sk_buff *skb,
						       const u8 *ha)
{
	if (dev->ndisc_ops && dev->ndisc_ops->fill_addr_option)
		dev->ndisc_ops->fill_addr_option(dev, skb, NDISC_REDIRECT, ha);
}

static inline void ndisc_ops_prefix_rcv_add_addr(struct net *net,
						 struct net_device *dev,
						 const struct prefix_info *pinfo,
						 struct inet6_dev *in6_dev,
						 struct in6_addr *addr,
						 int addr_type, u32 addr_flags,
						 bool sllao, bool tokenized,
						 __u32 valid_lft,
						 u32 prefered_lft,
						 bool dev_addr_generated)
{
	if (dev->ndisc_ops && dev->ndisc_ops->prefix_rcv_add_addr)
		dev->ndisc_ops->prefix_rcv_add_addr(net, dev, pinfo, in6_dev,
						    addr, addr_type,
						    addr_flags, sllao,
						    tokenized, valid_lft,
						    prefered_lft,
						    dev_addr_generated);
}
#endif

/*
 * Return the padding between the option length and the start of the
 * link addr.  Currently only IP-over-InfiniBand needs this, although
 * if RFC 3831 IPv6-over-Fibre Channel is ever implemented it may
 * also need a pad of 2.
 */
static inline int ndisc_addr_option_pad(unsigned short type)
{
	switch (type) {
	case ARPHRD_INFINIBAND: return 2;
	default:                return 0;
	}
}

static inline int __ndisc_opt_addr_space(unsigned char addr_len, int pad)
{
	return NDISC_OPT_SPACE(addr_len + pad);
}

#if IS_ENABLED(CONFIG_IPV6)
static inline int ndisc_opt_addr_space(struct net_device *dev, u8 icmp6_type)
{
	return __ndisc_opt_addr_space(dev->addr_len,
				      ndisc_addr_option_pad(dev->type)) +
		ndisc_ops_opt_addr_space(dev, icmp6_type);
}

static inline int ndisc_redirect_opt_addr_space(struct net_device *dev,
						struct neighbour *neigh,
						u8 *ops_data_buf,
						u8 **ops_data)
{
	return __ndisc_opt_addr_space(dev->addr_len,
				      ndisc_addr_option_pad(dev->type)) +
		ndisc_ops_redirect_opt_addr_space(dev, neigh, ops_data_buf,
						  ops_data);
}
#endif

static inline u8 *__ndisc_opt_addr_data(struct nd_opt_hdr *p,
					unsigned char addr_len, int prepad)
{
	u8 *lladdr = (u8 *)(p + 1);
	int lladdrlen = p->nd_opt_len << 3;
	if (lladdrlen != __ndisc_opt_addr_space(addr_len, prepad))
		return NULL;
	return lladdr + prepad;
}

static inline u8 *ndisc_opt_addr_data(struct nd_opt_hdr *p,
				      struct net_device *dev)
{
	return __ndisc_opt_addr_data(p, dev->addr_len,
				     ndisc_addr_option_pad(dev->type));
}

static inline u32 ndisc_hashfn(const void *pkey, const struct net_device *dev, __u32 *hash_rnd)
{
	const u32 *p32 = pkey;

	return (((p32[0] ^ hash32_ptr(dev)) * hash_rnd[0]) +
		(p32[1] * hash_rnd[1]) +
		(p32[2] * hash_rnd[2]) +
		(p32[3] * hash_rnd[3]));
}

static inline struct neighbour *__ipv6_neigh_lookup_noref(struct net_device *dev, const void *pkey)
{
	return ___neigh_lookup_noref(&nd_tbl, neigh_key_eq128, ndisc_hashfn, pkey, dev);
}

static inline
struct neighbour *__ipv6_neigh_lookup_noref_stub(struct net_device *dev,
						 const void *pkey)
{
	return ___neigh_lookup_noref(ipv6_stub->nd_tbl, neigh_key_eq128,
				     ndisc_hashfn, pkey, dev);
}

static inline struct neighbour *__ipv6_neigh_lookup(struct net_device *dev, const void *pkey)
{
	struct neighbour *n;

	rcu_read_lock_bh();
	n = __ipv6_neigh_lookup_noref(dev, pkey);
	if (n && !refcount_inc_not_zero(&n->refcnt))
		n = NULL;
	rcu_read_unlock_bh();

	return n;
}

static inline void __ipv6_confirm_neigh(struct net_device *dev,
					const void *pkey)
{
	struct neighbour *n;

	rcu_read_lock_bh();
	n = __ipv6_neigh_lookup_noref(dev, pkey);
	if (n) {
		unsigned long now = jiffies;

		/* avoid dirtying neighbour */
		if (READ_ONCE(n->confirmed) != now)
			WRITE_ONCE(n->confirmed, now);
	}
	rcu_read_unlock_bh();
}

static inline void __ipv6_confirm_neigh_stub(struct net_device *dev,
					     const void *pkey)
{
	struct neighbour *n;

	rcu_read_lock_bh();
	n = __ipv6_neigh_lookup_noref_stub(dev, pkey);
	if (n) {
		unsigned long now = jiffies;

		/* avoid dirtying neighbour */
		if (READ_ONCE(n->confirmed) != now)
			WRITE_ONCE(n->confirmed, now);
	}
	rcu_read_unlock_bh();
}

/* uses ipv6_stub and is meant for use outside of IPv6 core */
static inline struct neighbour *ip_neigh_gw6(struct net_device *dev,
					     const void *addr)
{
	struct neighbour *neigh;

	neigh = __ipv6_neigh_lookup_noref_stub(dev, addr);
	if (unlikely(!neigh))
		neigh = __neigh_create(ipv6_stub->nd_tbl, addr, dev, false);

	return neigh;
}

int ndisc_init(void);
int ndisc_late_init(void);

void ndisc_late_cleanup(void);
void ndisc_cleanup(void);

int ndisc_rcv(struct sk_buff *skb);

void ndisc_send_ns(struct net_device *dev, const struct in6_addr *solicit,
		   const struct in6_addr *daddr, const struct in6_addr *saddr,
		   u64 nonce);

void ndisc_send_rs(struct net_device *dev,
		   const struct in6_addr *saddr, const struct in6_addr *daddr);
void ndisc_send_na(struct net_device *dev, const struct in6_addr *daddr,
		   const struct in6_addr *solicited_addr,
		   bool router, bool solicited, bool override, bool inc_opt);

void ndisc_send_redirect(struct sk_buff *skb, const struct in6_addr *target);

int ndisc_mc_map(const struct in6_addr *addr, char *buf, struct net_device *dev,
		 int dir);

void ndisc_update(const struct net_device *dev, struct neighbour *neigh,
		  const u8 *lladdr, u8 new, u32 flags, u8 icmp6_type,
		  struct ndisc_options *ndopts);

/*
 *	IGMP
 */
int igmp6_init(void);
int igmp6_late_init(void);

void igmp6_cleanup(void);
void igmp6_late_cleanup(void);

int igmp6_event_query(struct sk_buff *skb);

int igmp6_event_report(struct sk_buff *skb);


#ifdef CONFIG_SYSCTL
int ndisc_ifinfo_sysctl_change(struct ctl_table *ctl, int write,
			       void __user *buffer, size_t *lenp, loff_t *ppos);
int ndisc_ifinfo_sysctl_strategy(struct ctl_table *ctl,
				 void __user *oldval, size_t __user *oldlenp,
				 void __user *newval, size_t newlen);
#endif

void inet6_ifinfo_notify(int event, struct inet6_dev *idev);

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