[linux-2.6-block.git] / include / net / neighbour.h

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

#include <linux/neighbour.h>

/*
 *	Generic neighbour manipulation
 *
 *	Authors:
 *	Pedro Roque		<roque@di.fc.ul.pt>
 *	Alexey Kuznetsov	<kuznet@ms2.inr.ac.ru>
 *
 * 	Changes:
 *
 *	Harald Welte:		<laforge@gnumonks.org>
 *		- Add neighbour cache statistics like rtstat
 */

#include <linux/atomic.h>
#include <linux/refcount.h>
#include <linux/netdevice.h>
#include <linux/skbuff.h>
#include <linux/rcupdate.h>
#include <linux/seq_file.h>
#include <linux/bitmap.h>

#include <linux/err.h>
#include <linux/sysctl.h>
#include <linux/workqueue.h>
#include <net/rtnetlink.h>

/*
 * NUD stands for "neighbor unreachability detection"
 */

#define NUD_IN_TIMER	(NUD_INCOMPLETE|NUD_REACHABLE|NUD_DELAY|NUD_PROBE)
#define NUD_VALID	(NUD_PERMANENT|NUD_NOARP|NUD_REACHABLE|NUD_PROBE|NUD_STALE|NUD_DELAY)
#define NUD_CONNECTED	(NUD_PERMANENT|NUD_NOARP|NUD_REACHABLE)

struct neighbour;

enum {
	NEIGH_VAR_MCAST_PROBES,
	NEIGH_VAR_UCAST_PROBES,
	NEIGH_VAR_APP_PROBES,
	NEIGH_VAR_MCAST_REPROBES,
	NEIGH_VAR_RETRANS_TIME,
	NEIGH_VAR_BASE_REACHABLE_TIME,
	NEIGH_VAR_DELAY_PROBE_TIME,
	NEIGH_VAR_GC_STALETIME,
	NEIGH_VAR_QUEUE_LEN_BYTES,
	NEIGH_VAR_PROXY_QLEN,
	NEIGH_VAR_ANYCAST_DELAY,
	NEIGH_VAR_PROXY_DELAY,
	NEIGH_VAR_LOCKTIME,
#define NEIGH_VAR_DATA_MAX (NEIGH_VAR_LOCKTIME + 1)
	/* Following are used as a second way to access one of the above */
	NEIGH_VAR_QUEUE_LEN, /* same data as NEIGH_VAR_QUEUE_LEN_BYTES */
	NEIGH_VAR_RETRANS_TIME_MS, /* same data as NEIGH_VAR_RETRANS_TIME */
	NEIGH_VAR_BASE_REACHABLE_TIME_MS, /* same data as NEIGH_VAR_BASE_REACHABLE_TIME */
	/* Following are used by "default" only */
	NEIGH_VAR_GC_INTERVAL,
	NEIGH_VAR_GC_THRESH1,
	NEIGH_VAR_GC_THRESH2,
	NEIGH_VAR_GC_THRESH3,
	NEIGH_VAR_MAX
};

struct neigh_parms {
	possible_net_t net;
	struct net_device *dev;
	struct list_head list;
	int	(*neigh_setup)(struct neighbour *);
	void	(*neigh_cleanup)(struct neighbour *);
	struct neigh_table *tbl;

	void	*sysctl_table;

	int dead;
	refcount_t refcnt;
	struct rcu_head rcu_head;

	int	reachable_time;
	int	data[NEIGH_VAR_DATA_MAX];
	DECLARE_BITMAP(data_state, NEIGH_VAR_DATA_MAX);
};

static inline void neigh_var_set(struct neigh_parms *p, int index, int val)
{
	set_bit(index, p->data_state);
	p->data[index] = val;
}

#define NEIGH_VAR(p, attr) ((p)->data[NEIGH_VAR_ ## attr])

/* In ndo_neigh_setup, NEIGH_VAR_INIT should be used.
 * In other cases, NEIGH_VAR_SET should be used.
 */
#define NEIGH_VAR_INIT(p, attr, val) (NEIGH_VAR(p, attr) = val)
#define NEIGH_VAR_SET(p, attr, val) neigh_var_set(p, NEIGH_VAR_ ## attr, val)

static inline void neigh_parms_data_state_setall(struct neigh_parms *p)
{
	bitmap_fill(p->data_state, NEIGH_VAR_DATA_MAX);
}

static inline void neigh_parms_data_state_cleanall(struct neigh_parms *p)
{
	bitmap_zero(p->data_state, NEIGH_VAR_DATA_MAX);
}

struct neigh_statistics {
	unsigned long allocs;		/* number of allocated neighs */
	unsigned long destroys;		/* number of destroyed neighs */
	unsigned long hash_grows;	/* number of hash resizes */

	unsigned long res_failed;	/* number of failed resolutions */

	unsigned long lookups;		/* number of lookups */
	unsigned long hits;		/* number of hits (among lookups) */

	unsigned long rcv_probes_mcast;	/* number of received mcast ipv6 */
	unsigned long rcv_probes_ucast; /* number of received ucast ipv6 */

	unsigned long periodic_gc_runs;	/* number of periodic GC runs */
	unsigned long forced_gc_runs;	/* number of forced GC runs */

	unsigned long unres_discards;	/* number of unresolved drops */
	unsigned long table_fulls;      /* times even gc couldn't help */
};

#define NEIGH_CACHE_STAT_INC(tbl, field) this_cpu_inc((tbl)->stats->field)

struct neighbour {
	struct neighbour __rcu	*next;
	struct neigh_table	*tbl;
	struct neigh_parms	*parms;
	unsigned long		confirmed;
	unsigned long		updated;
	rwlock_t		lock;
	refcount_t		refcnt;
	unsigned int		arp_queue_len_bytes;
	struct sk_buff_head	arp_queue;
	struct timer_list	timer;
	unsigned long		used;
	atomic_t		probes;
	__u8			flags;
	__u8			nud_state;
	__u8			type;
	__u8			dead;
	u8			protocol;
	seqlock_t		ha_lock;
	unsigned char		ha[ALIGN(MAX_ADDR_LEN, sizeof(unsigned long))] __aligned(8);
	struct hh_cache		hh;
	int			(*output)(struct neighbour *, struct sk_buff *);
	const struct neigh_ops	*ops;
	struct list_head	gc_list;
	struct rcu_head		rcu;
	struct net_device	*dev;
	u8			primary_key[0];
} __randomize_layout;

struct neigh_ops {
	int			family;
	void			(*solicit)(struct neighbour *, struct sk_buff *);
	void			(*error_report)(struct neighbour *, struct sk_buff *);
	int			(*output)(struct neighbour *, struct sk_buff *);
	int			(*connected_output)(struct neighbour *, struct sk_buff *);
};

struct pneigh_entry {
	struct pneigh_entry	*next;
	possible_net_t		net;
	struct net_device	*dev;
	u8			flags;
	u8			protocol;
	u8			key[0];
};

/*
 *	neighbour table manipulation
 */

#define NEIGH_NUM_HASH_RND	4

struct neigh_hash_table {
	struct neighbour __rcu	**hash_buckets;
	unsigned int		hash_shift;
	__u32			hash_rnd[NEIGH_NUM_HASH_RND];
	struct rcu_head		rcu;
};


struct neigh_table {
	int			family;
	unsigned int		entry_size;
	unsigned int		key_len;
	__be16			protocol;
	__u32			(*hash)(const void *pkey,
					const struct net_device *dev,
					__u32 *hash_rnd);
	bool			(*key_eq)(const struct neighbour *, const void *pkey);
	int			(*constructor)(struct neighbour *);
	int			(*pconstructor)(struct pneigh_entry *);
	void			(*pdestructor)(struct pneigh_entry *);
	void			(*proxy_redo)(struct sk_buff *skb);
	bool			(*allow_add)(const struct net_device *dev,
					     struct netlink_ext_ack *extack);
	char			*id;
	struct neigh_parms	parms;
	struct list_head	parms_list;
	int			gc_interval;
	int			gc_thresh1;
	int			gc_thresh2;
	int			gc_thresh3;
	unsigned long		last_flush;
	struct delayed_work	gc_work;
	struct timer_list 	proxy_timer;
	struct sk_buff_head	proxy_queue;
	atomic_t		entries;
	atomic_t		gc_entries;
	struct list_head	gc_list;
	rwlock_t		lock;
	unsigned long		last_rand;
	struct neigh_statistics	__percpu *stats;
	struct neigh_hash_table __rcu *nht;
	struct pneigh_entry	**phash_buckets;
};

enum {
	NEIGH_ARP_TABLE = 0,
	NEIGH_ND_TABLE = 1,
	NEIGH_DN_TABLE = 2,
	NEIGH_NR_TABLES,
	NEIGH_LINK_TABLE = NEIGH_NR_TABLES /* Pseudo table for neigh_xmit */
};

static inline int neigh_parms_family(struct neigh_parms *p)
{
	return p->tbl->family;
}

#define NEIGH_PRIV_ALIGN	sizeof(long long)
#define NEIGH_ENTRY_SIZE(size)	ALIGN((size), NEIGH_PRIV_ALIGN)

static inline void *neighbour_priv(const struct neighbour *n)
{
	return (char *)n + n->tbl->entry_size;
}

/* flags for neigh_update() */
#define NEIGH_UPDATE_F_OVERRIDE			0x00000001
#define NEIGH_UPDATE_F_WEAK_OVERRIDE		0x00000002
#define NEIGH_UPDATE_F_OVERRIDE_ISROUTER	0x00000004
#define NEIGH_UPDATE_F_EXT_LEARNED		0x20000000
#define NEIGH_UPDATE_F_ISROUTER			0x40000000
#define NEIGH_UPDATE_F_ADMIN			0x80000000

extern const struct nla_policy nda_policy[];

static inline bool neigh_key_eq16(const struct neighbour *n, const void *pkey)
{
	return *(const u16 *)n->primary_key == *(const u16 *)pkey;
}

static inline bool neigh_key_eq32(const struct neighbour *n, const void *pkey)
{
	return *(const u32 *)n->primary_key == *(const u32 *)pkey;
}

static inline bool neigh_key_eq128(const struct neighbour *n, const void *pkey)
{
	const u32 *n32 = (const u32 *)n->primary_key;
	const u32 *p32 = pkey;

	return ((n32[0] ^ p32[0]) | (n32[1] ^ p32[1]) |
		(n32[2] ^ p32[2]) | (n32[3] ^ p32[3])) == 0;
}

static inline struct neighbour *___neigh_lookup_noref(
	struct neigh_table *tbl,
	bool (*key_eq)(const struct neighbour *n, const void *pkey),
	__u32 (*hash)(const void *pkey,
		      const struct net_device *dev,
		      __u32 *hash_rnd),
	const void *pkey,
	struct net_device *dev)
{
	struct neigh_hash_table *nht = rcu_dereference_bh(tbl->nht);
	struct neighbour *n;
	u32 hash_val;

	hash_val = hash(pkey, dev, nht->hash_rnd) >> (32 - nht->hash_shift);
	for (n = rcu_dereference_bh(nht->hash_buckets[hash_val]);
	     n != NULL;
	     n = rcu_dereference_bh(n->next)) {
		if (n->dev == dev && key_eq(n, pkey))
			return n;
	}

	return NULL;
}

static inline struct neighbour *__neigh_lookup_noref(struct neigh_table *tbl,
						     const void *pkey,
						     struct net_device *dev)
{
	return ___neigh_lookup_noref(tbl, tbl->key_eq, tbl->hash, pkey, dev);
}

void neigh_table_init(int index, struct neigh_table *tbl);
int neigh_table_clear(int index, struct neigh_table *tbl);
struct neighbour *neigh_lookup(struct neigh_table *tbl, const void *pkey,
			       struct net_device *dev);
struct neighbour *neigh_lookup_nodev(struct neigh_table *tbl, struct net *net,
				     const void *pkey);
struct neighbour *__neigh_create(struct neigh_table *tbl, const void *pkey,
				 struct net_device *dev, bool want_ref);
static inline struct neighbour *neigh_create(struct neigh_table *tbl,
					     const void *pkey,
					     struct net_device *dev)
{
	return __neigh_create(tbl, pkey, dev, true);
}
void neigh_destroy(struct neighbour *neigh);
int __neigh_event_send(struct neighbour *neigh, struct sk_buff *skb);
int neigh_update(struct neighbour *neigh, const u8 *lladdr, u8 new, u32 flags,
		 u32 nlmsg_pid);
void __neigh_set_probe_once(struct neighbour *neigh);
bool neigh_remove_one(struct neighbour *ndel, struct neigh_table *tbl);
void neigh_changeaddr(struct neigh_table *tbl, struct net_device *dev);
int neigh_ifdown(struct neigh_table *tbl, struct net_device *dev);
int neigh_carrier_down(struct neigh_table *tbl, struct net_device *dev);
int neigh_resolve_output(struct neighbour *neigh, struct sk_buff *skb);
int neigh_connected_output(struct neighbour *neigh, struct sk_buff *skb);
int neigh_direct_output(struct neighbour *neigh, struct sk_buff *skb);
struct neighbour *neigh_event_ns(struct neigh_table *tbl,
						u8 *lladdr, void *saddr,
						struct net_device *dev);

struct neigh_parms *neigh_parms_alloc(struct net_device *dev,
				      struct neigh_table *tbl);
void neigh_parms_release(struct neigh_table *tbl, struct neigh_parms *parms);

static inline
struct net *neigh_parms_net(const struct neigh_parms *parms)
{
	return read_pnet(&parms->net);
}

unsigned long neigh_rand_reach_time(unsigned long base);

void pneigh_enqueue(struct neigh_table *tbl, struct neigh_parms *p,
		    struct sk_buff *skb);
struct pneigh_entry *pneigh_lookup(struct neigh_table *tbl, struct net *net,
				   const void *key, struct net_device *dev,
				   int creat);
struct pneigh_entry *__pneigh_lookup(struct neigh_table *tbl, struct net *net,
				     const void *key, struct net_device *dev);
int pneigh_delete(struct neigh_table *tbl, struct net *net, const void *key,
		  struct net_device *dev);

static inline struct net *pneigh_net(const struct pneigh_entry *pneigh)
{
	return read_pnet(&pneigh->net);
}

void neigh_app_ns(struct neighbour *n);
void neigh_for_each(struct neigh_table *tbl,
		    void (*cb)(struct neighbour *, void *), void *cookie);
void __neigh_for_each_release(struct neigh_table *tbl,
			      int (*cb)(struct neighbour *));
int neigh_xmit(int fam, struct net_device *, const void *, struct sk_buff *);
void pneigh_for_each(struct neigh_table *tbl,
		     void (*cb)(struct pneigh_entry *));

struct neigh_seq_state {
	struct seq_net_private p;
	struct neigh_table *tbl;
	struct neigh_hash_table *nht;
	void *(*neigh_sub_iter)(struct neigh_seq_state *state,
				struct neighbour *n, loff_t *pos);
	unsigned int bucket;
	unsigned int flags;
#define NEIGH_SEQ_NEIGH_ONLY	0x00000001
#define NEIGH_SEQ_IS_PNEIGH	0x00000002
#define NEIGH_SEQ_SKIP_NOARP	0x00000004
};
void *neigh_seq_start(struct seq_file *, loff_t *, struct neigh_table *,
		      unsigned int);
void *neigh_seq_next(struct seq_file *, void *, loff_t *);
void neigh_seq_stop(struct seq_file *, void *);

int neigh_proc_dointvec(struct ctl_table *ctl, int write,
			void __user *buffer, size_t *lenp, loff_t *ppos);
int neigh_proc_dointvec_jiffies(struct ctl_table *ctl, int write,
				void __user *buffer,
				size_t *lenp, loff_t *ppos);
int neigh_proc_dointvec_ms_jiffies(struct ctl_table *ctl, int write,
				   void __user *buffer,
				   size_t *lenp, loff_t *ppos);

int neigh_sysctl_register(struct net_device *dev, struct neigh_parms *p,
			  proc_handler *proc_handler);
void neigh_sysctl_unregister(struct neigh_parms *p);

static inline void __neigh_parms_put(struct neigh_parms *parms)
{
	refcount_dec(&parms->refcnt);
}

static inline struct neigh_parms *neigh_parms_clone(struct neigh_parms *parms)
{
	refcount_inc(&parms->refcnt);
	return parms;
}

/*
 *	Neighbour references
 */

static inline void neigh_release(struct neighbour *neigh)
{
	if (refcount_dec_and_test(&neigh->refcnt))
		neigh_destroy(neigh);
}

static inline struct neighbour * neigh_clone(struct neighbour *neigh)
{
	if (neigh)
		refcount_inc(&neigh->refcnt);
	return neigh;
}

#define neigh_hold(n)	refcount_inc(&(n)->refcnt)

static inline int neigh_event_send(struct neighbour *neigh, struct sk_buff *skb)
{
	unsigned long now = jiffies;
	
	if (neigh->used != now)
		neigh->used = now;
	if (!(neigh->nud_state&(NUD_CONNECTED|NUD_DELAY|NUD_PROBE)))
		return __neigh_event_send(neigh, skb);
	return 0;
}

#if IS_ENABLED(CONFIG_BRIDGE_NETFILTER)
static inline int neigh_hh_bridge(struct hh_cache *hh, struct sk_buff *skb)
{
	unsigned int seq, hh_alen;

	do {
		seq = read_seqbegin(&hh->hh_lock);
		hh_alen = HH_DATA_ALIGN(ETH_HLEN);
		memcpy(skb->data - hh_alen, hh->hh_data, ETH_ALEN + hh_alen - ETH_HLEN);
	} while (read_seqretry(&hh->hh_lock, seq));
	return 0;
}
#endif

static inline int neigh_hh_output(const struct hh_cache *hh, struct sk_buff *skb)
{
	unsigned int hh_alen = 0;
	unsigned int seq;
	unsigned int hh_len;

	do {
		seq = read_seqbegin(&hh->hh_lock);
		hh_len = READ_ONCE(hh->hh_len);
		if (likely(hh_len <= HH_DATA_MOD)) {
			hh_alen = HH_DATA_MOD;

			/* skb_push() would proceed silently if we have room for
			 * the unaligned size but not for the aligned size:
			 * check headroom explicitly.
			 */
			if (likely(skb_headroom(skb) >= HH_DATA_MOD)) {
				/* this is inlined by gcc */
				memcpy(skb->data - HH_DATA_MOD, hh->hh_data,
				       HH_DATA_MOD);
			}
		} else {
			hh_alen = HH_DATA_ALIGN(hh_len);

			if (likely(skb_headroom(skb) >= hh_alen)) {
				memcpy(skb->data - hh_alen, hh->hh_data,
				       hh_alen);
			}
		}
	} while (read_seqretry(&hh->hh_lock, seq));

	if (WARN_ON_ONCE(skb_headroom(skb) < hh_alen)) {
		kfree_skb(skb);
		return NET_XMIT_DROP;
	}

	__skb_push(skb, hh_len);
	return dev_queue_xmit(skb);
}

static inline int neigh_output(struct neighbour *n, struct sk_buff *skb,
			       bool skip_cache)
{
	const struct hh_cache *hh = &n->hh;

	if ((n->nud_state & NUD_CONNECTED) && hh->hh_len && !skip_cache)
		return neigh_hh_output(hh, skb);
	else
		return n->output(n, skb);
}

static inline struct neighbour *
__neigh_lookup(struct neigh_table *tbl, const void *pkey, struct net_device *dev, int creat)
{
	struct neighbour *n = neigh_lookup(tbl, pkey, dev);

	if (n || !creat)
		return n;

	n = neigh_create(tbl, pkey, dev);
	return IS_ERR(n) ? NULL : n;
}

static inline struct neighbour *
__neigh_lookup_errno(struct neigh_table *tbl, const void *pkey,
  struct net_device *dev)
{
	struct neighbour *n = neigh_lookup(tbl, pkey, dev);

	if (n)
		return n;

	return neigh_create(tbl, pkey, dev);
}

struct neighbour_cb {
	unsigned long sched_next;
	unsigned int flags;
};

#define LOCALLY_ENQUEUED 0x1

#define NEIGH_CB(skb)	((struct neighbour_cb *)(skb)->cb)

static inline void neigh_ha_snapshot(char *dst, const struct neighbour *n,
				     const struct net_device *dev)
{
	unsigned int seq;

	do {
		seq = read_seqbegin(&n->ha_lock);
		memcpy(dst, n->ha, dev->addr_len);
	} while (read_seqretry(&n->ha_lock, seq));
}

static inline void neigh_update_is_router(struct neighbour *neigh, u32 flags,
					  int *notify)
{
	u8 ndm_flags = 0;

	ndm_flags |= (flags & NEIGH_UPDATE_F_ISROUTER) ? NTF_ROUTER : 0;
	if ((neigh->flags ^ ndm_flags) & NTF_ROUTER) {
		if (ndm_flags & NTF_ROUTER)
			neigh->flags |= NTF_ROUTER;
		else
			neigh->flags &= ~NTF_ROUTER;
		*notify = 1;
	}
}
#endif
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4 LT	2	#ifndef _NET_NEIGHBOUR_H
	3	#define _NET_NEIGHBOUR_H
	4
9067c722 TG	5	#include <linux/neighbour.h>
9067c722 TG	6
1da177e4 LT	7	/*
	8	* Generic neighbour manipulation
	9	*
	10	* Authors:
	11	* Pedro Roque <roque@di.fc.ul.pt>
	12	* Alexey Kuznetsov <kuznet@ms2.inr.ac.ru>
	13	*
	14	* Changes:
	15	*
	16	* Harald Welte: <laforge@gnumonks.org>
	17	* - Add neighbour cache statistics like rtstat
	18	*/
	19
60063497	20	#include <linux/atomic.h>
9f237430	21	#include <linux/refcount.h>
1da177e4	22	#include <linux/netdevice.h>
14c85021	23	#include <linux/skbuff.h>
1da177e4 LT	24	#include <linux/rcupdate.h>
1da177e4 LT	25	#include <linux/seq_file.h>
1d4c8c29	26	#include <linux/bitmap.h>
1da177e4 LT	27
	28	#include <linux/err.h>
	29	#include <linux/sysctl.h>
e4c4e448	30	#include <linux/workqueue.h>
c8822a4e	31	#include <net/rtnetlink.h>
1da177e4	32
39971554 PE	33	/*
	34	* NUD stands for "neighbor unreachability detection"
	35	*/
	36
1da177e4 LT	37	#define NUD_IN_TIMER (NUD_INCOMPLETE\|NUD_REACHABLE\|NUD_DELAY\|NUD_PROBE)
	38	#define NUD_VALID (NUD_PERMANENT\|NUD_NOARP\|NUD_REACHABLE\|NUD_PROBE\|NUD_STALE\|NUD_DELAY)
	39	#define NUD_CONNECTED (NUD_PERMANENT\|NUD_NOARP\|NUD_REACHABLE)
	40
	41	struct neighbour;
	42
1f9248e5 JP	43	enum {
	44	NEIGH_VAR_MCAST_PROBES,
	45	NEIGH_VAR_UCAST_PROBES,
	46	NEIGH_VAR_APP_PROBES,
8da86466	47	NEIGH_VAR_MCAST_REPROBES,
1f9248e5 JP	48	NEIGH_VAR_RETRANS_TIME,
	49	NEIGH_VAR_BASE_REACHABLE_TIME,
	50	NEIGH_VAR_DELAY_PROBE_TIME,
	51	NEIGH_VAR_GC_STALETIME,
	52	NEIGH_VAR_QUEUE_LEN_BYTES,
	53	NEIGH_VAR_PROXY_QLEN,
	54	NEIGH_VAR_ANYCAST_DELAY,
	55	NEIGH_VAR_PROXY_DELAY,
	56	NEIGH_VAR_LOCKTIME,
	57	#define NEIGH_VAR_DATA_MAX (NEIGH_VAR_LOCKTIME + 1)
	58	/* Following are used as a second way to access one of the above */
	59	NEIGH_VAR_QUEUE_LEN, /* same data as NEIGH_VAR_QUEUE_LEN_BYTES */
	60	NEIGH_VAR_RETRANS_TIME_MS, /* same data as NEIGH_VAR_RETRANS_TIME */
	61	NEIGH_VAR_BASE_REACHABLE_TIME_MS, /* same data as NEIGH_VAR_BASE_REACHABLE_TIME */
	62	/* Following are used by "default" only */
	63	NEIGH_VAR_GC_INTERVAL,
	64	NEIGH_VAR_GC_THRESH1,
	65	NEIGH_VAR_GC_THRESH2,
	66	NEIGH_VAR_GC_THRESH3,
	67	NEIGH_VAR_MAX
	68	};
	69
fd2c3ef7	70	struct neigh_parms {
0c5c9fb5	71	possible_net_t net;
c7fb64db	72	struct net_device *dev;
75fbfd33	73	struct list_head list;
447f2191	74	int (neigh_setup)(struct neighbour );
ecbb4169	75	void (neigh_cleanup)(struct neighbour );
1da177e4	76	struct neigh_table *tbl;
1da177e4 LT	77
	78	void *sysctl_table;
	79
	80	int dead;
6343944b	81	refcount_t refcnt;
1da177e4 LT	82	struct rcu_head rcu_head;
1da177e4 LT	83
1da177e4	84	int reachable_time;
1f9248e5	85	int data[NEIGH_VAR_DATA_MAX];
1d4c8c29	86	DECLARE_BITMAP(data_state, NEIGH_VAR_DATA_MAX);
1da177e4 LT	87	};
1da177e4 LT	88
1f9248e5 JP	89	static inline void neigh_var_set(struct neigh_parms *p, int index, int val)
1f9248e5 JP	90	{
1d4c8c29	91	set_bit(index, p->data_state);
1f9248e5 JP	92	p->data[index] = val;
	93	}
	94
	95	#define NEIGH_VAR(p, attr) ((p)->data[NEIGH_VAR_ ## attr])
89740ca7 JP	96
	97	/* In ndo_neigh_setup, NEIGH_VAR_INIT should be used.
	98	* In other cases, NEIGH_VAR_SET should be used.
	99	*/
	100	#define NEIGH_VAR_INIT(p, attr, val) (NEIGH_VAR(p, attr) = val)
1f9248e5 JP	101	#define NEIGH_VAR_SET(p, attr, val) neigh_var_set(p, NEIGH_VAR_ ## attr, val)
1f9248e5 JP	102
1d4c8c29 JP	103	static inline void neigh_parms_data_state_setall(struct neigh_parms *p)
	104	{
	105	bitmap_fill(p->data_state, NEIGH_VAR_DATA_MAX);
	106	}
	107
	108	static inline void neigh_parms_data_state_cleanall(struct neigh_parms *p)
	109	{
	110	bitmap_zero(p->data_state, NEIGH_VAR_DATA_MAX);
	111	}
	112
fd2c3ef7	113	struct neigh_statistics {
1da177e4 LT	114	unsigned long allocs; /* number of allocated neighs */
	115	unsigned long destroys; /* number of destroyed neighs */
	116	unsigned long hash_grows; /* number of hash resizes */
	117
9a6d276e	118	unsigned long res_failed; /* number of failed resolutions */
1da177e4 LT	119
	120	unsigned long lookups; /* number of lookups */
	121	unsigned long hits; /* number of hits (among lookups) */
	122
	123	unsigned long rcv_probes_mcast; /* number of received mcast ipv6 */
	124	unsigned long rcv_probes_ucast; /* number of received ucast ipv6 */
	125
	126	unsigned long periodic_gc_runs; /* number of periodic GC runs */
	127	unsigned long forced_gc_runs; /* number of forced GC runs */
9a6d276e NH	128
9a6d276e NH	129	unsigned long unres_discards; /* number of unresolved drops */
fb811395	130	unsigned long table_fulls; /* times even gc couldn't help */
1da177e4 LT	131	};
1da177e4 LT	132
4ea7334b	133	#define NEIGH_CACHE_STAT_INC(tbl, field) this_cpu_inc((tbl)->stats->field)
1da177e4	134
fd2c3ef7	135	struct neighbour {
767e97e1	136	struct neighbour __rcu *next;
1da177e4 LT	137	struct neigh_table *tbl;
1da177e4 LT	138	struct neigh_parms *parms;
1da177e4 LT	139	unsigned long confirmed;
1da177e4 LT	140	unsigned long updated;
46b13fc5	141	rwlock_t lock;
9f237430	142	refcount_t refcnt;
8b5c171b	143	unsigned int arp_queue_len_bytes;
4b7cd11f	144	struct sk_buff_head arp_queue;
e37ef961 ED	145	struct timer_list timer;
e37ef961 ED	146	unsigned long used;
1da177e4	147	atomic_t probes;
46b13fc5 ED	148	__u8 flags;
	149	__u8 nud_state;
	150	__u8 type;
	151	__u8 dead;
df9b0e30	152	u8 protocol;
0ed8ddf4	153	seqlock_t ha_lock;
4b7cd11f	154	unsigned char ha[ALIGN(MAX_ADDR_LEN, sizeof(unsigned long))] __aligned(8);
f6b72b62	155	struct hh_cache hh;
8f40b161	156	int (output)(struct neighbour , struct sk_buff *);
89d69d2b	157	const struct neigh_ops *ops;
58956317	158	struct list_head gc_list;
767e97e1	159	struct rcu_head rcu;
e37ef961	160	struct net_device *dev;
1da177e4	161	u8 primary_key[0];
3859a271	162	} __randomize_layout;
1da177e4	163
fd2c3ef7	164	struct neigh_ops {
1da177e4	165	int family;
8f40b161 DM	166	void (solicit)(struct neighbour , struct sk_buff *);
	167	void (error_report)(struct neighbour , struct sk_buff *);
	168	int (output)(struct neighbour , struct sk_buff *);
	169	int (connected_output)(struct neighbour , struct sk_buff *);
1da177e4 LT	170	};
1da177e4 LT	171
fd2c3ef7	172	struct pneigh_entry {
1da177e4	173	struct pneigh_entry *next;
0c5c9fb5	174	possible_net_t net;
426b5303	175	struct net_device *dev;
62dd9318	176	u8 flags;
df9b0e30	177	u8 protocol;
1da177e4 LT	178	u8 key[0];
	179	};
	180
	181	/*
	182	* neighbour table manipulation
	183	*/
	184
2c2aba6c DM	185	#define NEIGH_NUM_HASH_RND 4
2c2aba6c DM	186
d6bf7817	187	struct neigh_hash_table {
767e97e1	188	struct neighbour __rcu **hash_buckets;
cd089336	189	unsigned int hash_shift;
2c2aba6c	190	__u32 hash_rnd[NEIGH_NUM_HASH_RND];
d6bf7817 ED	191	struct rcu_head rcu;
	192	};
	193
1da177e4	194
fd2c3ef7	195	struct neigh_table {
1da177e4	196	int family;
e451ae8e	197	unsigned int entry_size;
01ccdf12	198	unsigned int key_len;
bdf53c58	199	__be16 protocol;
d6bf7817 ED	200	__u32 (hash)(const void pkey,
d6bf7817 ED	201	const struct net_device *dev,
2c2aba6c	202	__u32 *hash_rnd);
60395a20	203	bool (key_eq)(const struct neighbour , const void *pkey);
1da177e4 LT	204	int (constructor)(struct neighbour );
	205	int (pconstructor)(struct pneigh_entry );
	206	void (pdestructor)(struct pneigh_entry );
	207	void (proxy_redo)(struct sk_buff skb);
b8fb1ab4 DA	208	bool (allow_add)(const struct net_device dev,
b8fb1ab4 DA	209	struct netlink_ext_ack *extack);
1da177e4 LT	210	char *id;
1da177e4 LT	211	struct neigh_parms parms;
75fbfd33	212	struct list_head parms_list;
1da177e4 LT	213	int gc_interval;
	214	int gc_thresh1;
	215	int gc_thresh2;
	216	int gc_thresh3;
	217	unsigned long last_flush;
e4c4e448	218	struct delayed_work gc_work;
1da177e4 LT	219	struct timer_list proxy_timer;
	220	struct sk_buff_head proxy_queue;
	221	atomic_t entries;
58956317 DA	222	atomic_t gc_entries;
58956317 DA	223	struct list_head gc_list;
1da177e4 LT	224	rwlock_t lock;
1da177e4 LT	225	unsigned long last_rand;
7d720c3e	226	struct neigh_statistics __percpu *stats;
d6bf7817	227	struct neigh_hash_table __rcu *nht;
1da177e4	228	struct pneigh_entry **phash_buckets;
1da177e4 LT	229	};
1da177e4 LT	230
d7480fd3 WC	231	enum {
	232	NEIGH_ARP_TABLE = 0,
	233	NEIGH_ND_TABLE = 1,
	234	NEIGH_DN_TABLE = 2,
	235	NEIGH_NR_TABLES,
b79bda3d	236	NEIGH_LINK_TABLE = NEIGH_NR_TABLES /* Pseudo table for neigh_xmit */
d7480fd3 WC	237	};
d7480fd3 WC	238
73af614a JP	239	static inline int neigh_parms_family(struct neigh_parms *p)
	240	{
	241	return p->tbl->family;
	242	}
	243
1026fec8	244	#define NEIGH_PRIV_ALIGN sizeof(long long)
daaba4fa	245	#define NEIGH_ENTRY_SIZE(size) ALIGN((size), NEIGH_PRIV_ALIGN)
1026fec8 DM	246
	247	static inline void neighbour_priv(const struct neighbour n)
	248	{
08433eff	249	return (char *)n + n->tbl->entry_size;
1026fec8 DM	250	}
1026fec8 DM	251
1da177e4 LT	252	/* flags for neigh_update() */
	253	#define NEIGH_UPDATE_F_OVERRIDE 0x00000001
	254	#define NEIGH_UPDATE_F_WEAK_OVERRIDE 0x00000002
	255	#define NEIGH_UPDATE_F_OVERRIDE_ISROUTER 0x00000004
9ce33e46	256	#define NEIGH_UPDATE_F_EXT_LEARNED 0x20000000
1da177e4 LT	257	#define NEIGH_UPDATE_F_ISROUTER 0x40000000
	258	#define NEIGH_UPDATE_F_ADMIN 0x80000000
	259
82cbb5c6	260	extern const struct nla_policy nda_policy[];
60395a20 EB	261
	262	static inline bool neigh_key_eq16(const struct neighbour n, const void pkey)
	263	{
	264	return (const u16 )n->primary_key == (const u16 )pkey;
	265	}
	266
	267	static inline bool neigh_key_eq32(const struct neighbour n, const void pkey)
	268	{
	269	return (const u32 )n->primary_key == (const u32 )pkey;
	270	}
	271
	272	static inline bool neigh_key_eq128(const struct neighbour n, const void pkey)
	273	{
	274	const u32 n32 = (const u32 )n->primary_key;
	275	const u32 *p32 = pkey;
	276
	277	return ((n32[0] ^ p32[0]) \| (n32[1] ^ p32[1]) \|
	278	(n32[2] ^ p32[2]) \| (n32[3] ^ p32[3])) == 0;
	279	}
	280
	281	static inline struct neighbour *___neigh_lookup_noref(
	282	struct neigh_table *tbl,
	283	bool (key_eq)(const struct neighbour n, const void *pkey),
	284	__u32 (hash)(const void pkey,
	285	const struct net_device *dev,
	286	__u32 *hash_rnd),
	287	const void *pkey,
	288	struct net_device *dev)
	289	{
	290	struct neigh_hash_table *nht = rcu_dereference_bh(tbl->nht);
	291	struct neighbour *n;
	292	u32 hash_val;
	293
	294	hash_val = hash(pkey, dev, nht->hash_rnd) >> (32 - nht->hash_shift);
	295	for (n = rcu_dereference_bh(nht->hash_buckets[hash_val]);
	296	n != NULL;
	297	n = rcu_dereference_bh(n->next)) {
	298	if (n->dev == dev && key_eq(n, pkey))
	299	return n;
	300	}
	301
	302	return NULL;
	303	}
	304
	305	static inline struct neighbour __neigh_lookup_noref(struct neigh_table tbl,
	306	const void *pkey,
	307	struct net_device *dev)
	308	{
	309	return ___neigh_lookup_noref(tbl, tbl->key_eq, tbl->hash, pkey, dev);
	310	}
	311
d7480fd3 WC	312	void neigh_table_init(int index, struct neigh_table *tbl);
d7480fd3 WC	313	int neigh_table_clear(int index, struct neigh_table *tbl);
90972b22 JP	314	struct neighbour neigh_lookup(struct neigh_table tbl, const void *pkey,
	315	struct net_device *dev);
	316	struct neighbour neigh_lookup_nodev(struct neigh_table tbl, struct net *net,
	317	const void *pkey);
	318	struct neighbour __neigh_create(struct neigh_table tbl, const void *pkey,
	319	struct net_device *dev, bool want_ref);
a263b309	320	static inline struct neighbour neigh_create(struct neigh_table tbl,
1da177e4	321	const void *pkey,
a263b309 DM	322	struct net_device *dev)
	323	{
	324	return __neigh_create(tbl, pkey, dev, true);
	325	}
90972b22 JP	326	void neigh_destroy(struct neighbour *neigh);
90972b22 JP	327	int __neigh_event_send(struct neighbour neigh, struct sk_buff skb);
7b8f7a40 RP	328	int neigh_update(struct neighbour neigh, const u8 lladdr, u8 new, u32 flags,
7b8f7a40 RP	329	u32 nlmsg_pid);
7e980569	330	void __neigh_set_probe_once(struct neighbour *neigh);
5071034e	331	bool neigh_remove_one(struct neighbour ndel, struct neigh_table tbl);
90972b22 JP	332	void neigh_changeaddr(struct neigh_table tbl, struct net_device dev);
90972b22 JP	333	int neigh_ifdown(struct neigh_table tbl, struct net_device dev);
859bd2ef	334	int neigh_carrier_down(struct neigh_table tbl, struct net_device dev);
90972b22 JP	335	int neigh_resolve_output(struct neighbour neigh, struct sk_buff skb);
90972b22 JP	336	int neigh_connected_output(struct neighbour neigh, struct sk_buff skb);
90972b22 JP	337	int neigh_direct_output(struct neighbour neigh, struct sk_buff skb);
90972b22 JP	338	struct neighbour neigh_event_ns(struct neigh_table tbl,
1da177e4 LT	339	u8 lladdr, void saddr,
	340	struct net_device *dev);
	341
90972b22 JP	342	struct neigh_parms neigh_parms_alloc(struct net_device dev,
	343	struct neigh_table *tbl);
	344	void neigh_parms_release(struct neigh_table tbl, struct neigh_parms parms);
57da52c1 YH	345
57da52c1 YH	346	static inline
90972b22	347	struct net neigh_parms_net(const struct neigh_parms parms)
57da52c1	348	{
e42ea986	349	return read_pnet(&parms->net);
57da52c1 YH	350	}
57da52c1 YH	351
90972b22	352	unsigned long neigh_rand_reach_time(unsigned long base);
1da177e4	353
90972b22 JP	354	void pneigh_enqueue(struct neigh_table tbl, struct neigh_parms p,
	355	struct sk_buff *skb);
	356	struct pneigh_entry pneigh_lookup(struct neigh_table tbl, struct net *net,
	357	const void key, struct net_device dev,
	358	int creat);
	359	struct pneigh_entry __pneigh_lookup(struct neigh_table tbl, struct net *net,
	360	const void key, struct net_device dev);
	361	int pneigh_delete(struct neigh_table tbl, struct net net, const void *key,
	362	struct net_device *dev);
1da177e4	363
90972b22	364	static inline struct net pneigh_net(const struct pneigh_entry pneigh)
57da52c1	365	{
e42ea986	366	return read_pnet(&pneigh->net);
57da52c1 YH	367	}
57da52c1 YH	368
90972b22 JP	369	void neigh_app_ns(struct neighbour *n);
	370	void neigh_for_each(struct neigh_table *tbl,
	371	void (cb)(struct neighbour , void ), void cookie);
	372	void __neigh_for_each_release(struct neigh_table *tbl,
	373	int (cb)(struct neighbour ));
4fd3d7d9	374	int neigh_xmit(int fam, struct net_device , const void , struct sk_buff *);
90972b22 JP	375	void pneigh_for_each(struct neigh_table *tbl,
90972b22 JP	376	void (cb)(struct pneigh_entry ));
1da177e4 LT	377
1da177e4 LT	378	struct neigh_seq_state {
42508461	379	struct seq_net_private p;
1da177e4	380	struct neigh_table *tbl;
d6bf7817	381	struct neigh_hash_table *nht;
1da177e4 LT	382	void (neigh_sub_iter)(struct neigh_seq_state *state,
	383	struct neighbour n, loff_t pos);
	384	unsigned int bucket;
	385	unsigned int flags;
	386	#define NEIGH_SEQ_NEIGH_ONLY 0x00000001
	387	#define NEIGH_SEQ_IS_PNEIGH 0x00000002
	388	#define NEIGH_SEQ_SKIP_NOARP 0x00000004
	389	};
90972b22 JP	390	void neigh_seq_start(struct seq_file , loff_t , struct neigh_table ,
	391	unsigned int);
	392	void neigh_seq_next(struct seq_file , void , loff_t );
	393	void neigh_seq_stop(struct seq_file , void );
	394
cb5b09c1 JP	395	int neigh_proc_dointvec(struct ctl_table *ctl, int write,
	396	void __user buffer, size_t lenp, loff_t *ppos);
	397	int neigh_proc_dointvec_jiffies(struct ctl_table *ctl, int write,
	398	void __user *buffer,
	399	size_t lenp, loff_t ppos);
	400	int neigh_proc_dointvec_ms_jiffies(struct ctl_table *ctl, int write,
	401	void __user *buffer,
	402	size_t lenp, loff_t ppos);
	403
90972b22	404	int neigh_sysctl_register(struct net_device dev, struct neigh_parms p,
73af614a	405	proc_handler *proc_handler);
90972b22	406	void neigh_sysctl_unregister(struct neigh_parms *p);
1da177e4 LT	407
	408	static inline void __neigh_parms_put(struct neigh_parms *parms)
	409	{
6343944b	410	refcount_dec(&parms->refcnt);
1da177e4 LT	411	}
1da177e4 LT	412
1da177e4 LT	413	static inline struct neigh_parms neigh_parms_clone(struct neigh_parms parms)
1da177e4 LT	414	{
6343944b	415	refcount_inc(&parms->refcnt);
1da177e4 LT	416	return parms;
	417	}
	418
	419	/*
	420	* Neighbour references
	421	*/
	422
	423	static inline void neigh_release(struct neighbour *neigh)
	424	{
9f237430	425	if (refcount_dec_and_test(&neigh->refcnt))
1da177e4 LT	426	neigh_destroy(neigh);
	427	}
	428
	429	static inline struct neighbour * neigh_clone(struct neighbour *neigh)
	430	{
	431	if (neigh)
9f237430	432	refcount_inc(&neigh->refcnt);
1da177e4 LT	433	return neigh;
	434	}
	435
9f237430	436	#define neigh_hold(n) refcount_inc(&(n)->refcnt)
1da177e4	437
1da177e4 LT	438	static inline int neigh_event_send(struct neighbour neigh, struct sk_buff skb)
1da177e4 LT	439	{
ef22b7b6	440	unsigned long now = jiffies;
0ed8ddf4 ED	441
	442	if (neigh->used != now)
	443	neigh->used = now;
1da177e4 LT	444	if (!(neigh->nud_state&(NUD_CONNECTED\|NUD_DELAY\|NUD_PROBE)))
	445	return __neigh_event_send(neigh, skb);
	446	return 0;
	447	}
	448
34666d46	449	#if IS_ENABLED(CONFIG_BRIDGE_NETFILTER)
e179e632 BDS	450	static inline int neigh_hh_bridge(struct hh_cache hh, struct sk_buff skb)
e179e632 BDS	451	{
95c96174	452	unsigned int seq, hh_alen;
e179e632 BDS	453
	454	do {
	455	seq = read_seqbegin(&hh->hh_lock);
	456	hh_alen = HH_DATA_ALIGN(ETH_HLEN);
	457	memcpy(skb->data - hh_alen, hh->hh_data, ETH_ALEN + hh_alen - ETH_HLEN);
	458	} while (read_seqretry(&hh->hh_lock, seq));
	459	return 0;
	460	}
	461	#endif
	462
425f09ab	463	static inline int neigh_hh_output(const struct hh_cache hh, struct sk_buff skb)
3644f0ce	464	{
e6ac64d4	465	unsigned int hh_alen = 0;
95c96174	466	unsigned int seq;
5b3dc2f3	467	unsigned int hh_len;
3644f0ce SH	468
3644f0ce SH	469	do {
3644f0ce	470	seq = read_seqbegin(&hh->hh_lock);
c305c6ae	471	hh_len = READ_ONCE(hh->hh_len);
425f09ab	472	if (likely(hh_len <= HH_DATA_MOD)) {
e6ac64d4 SB	473	hh_alen = HH_DATA_MOD;
	474
	475	/* skb_push() would proceed silently if we have room for
	476	* the unaligned size but not for the aligned size:
	477	* check headroom explicitly.
	478	*/
	479	if (likely(skb_headroom(skb) >= HH_DATA_MOD)) {
	480	/* this is inlined by gcc */
	481	memcpy(skb->data - HH_DATA_MOD, hh->hh_data,
	482	HH_DATA_MOD);
	483	}
425f09ab	484	} else {
e6ac64d4	485	hh_alen = HH_DATA_ALIGN(hh_len);
425f09ab	486
e6ac64d4 SB	487	if (likely(skb_headroom(skb) >= hh_alen)) {
	488	memcpy(skb->data - hh_alen, hh->hh_data,
	489	hh_alen);
	490	}
425f09ab	491	}
3644f0ce SH	492	} while (read_seqretry(&hh->hh_lock, seq));
3644f0ce SH	493
e6ac64d4 SB	494	if (WARN_ON_ONCE(skb_headroom(skb) < hh_alen)) {
	495	kfree_skb(skb);
	496	return NET_XMIT_DROP;
	497	}
	498
	499	__skb_push(skb, hh_len);
b23b5455	500	return dev_queue_xmit(skb);
3644f0ce SH	501	}
3644f0ce SH	502
0353f282 DA	503	static inline int neigh_output(struct neighbour n, struct sk_buff skb,
0353f282 DA	504	bool skip_cache)
c16ec185 JA	505	{
	506	const struct hh_cache *hh = &n->hh;
	507
0353f282	508	if ((n->nud_state & NUD_CONNECTED) && hh->hh_len && !skip_cache)
c16ec185 JA	509	return neigh_hh_output(hh, skb);
	510	else
	511	return n->output(n, skb);
	512	}
	513
1da177e4 LT	514	static inline struct neighbour *
	515	__neigh_lookup(struct neigh_table tbl, const void pkey, struct net_device *dev, int creat)
	516	{
	517	struct neighbour *n = neigh_lookup(tbl, pkey, dev);
	518
	519	if (n \|\| !creat)
	520	return n;
	521
	522	n = neigh_create(tbl, pkey, dev);
	523	return IS_ERR(n) ? NULL : n;
	524	}
	525
	526	static inline struct neighbour *
	527	__neigh_lookup_errno(struct neigh_table tbl, const void pkey,
	528	struct net_device *dev)
	529	{
	530	struct neighbour *n = neigh_lookup(tbl, pkey, dev);
	531
	532	if (n)
	533	return n;
	534
	535	return neigh_create(tbl, pkey, dev);
	536	}
	537
a61bbcf2 PM	538	struct neighbour_cb {
	539	unsigned long sched_next;
	540	unsigned int flags;
	541	};
	542
	543	#define LOCALLY_ENQUEUED 0x1
	544
	545	#define NEIGH_CB(skb) ((struct neighbour_cb *)(skb)->cb)
1da177e4	546
0ed8ddf4 ED	547	static inline void neigh_ha_snapshot(char dst, const struct neighbour n,
	548	const struct net_device *dev)
	549	{
	550	unsigned int seq;
	551
	552	do {
	553	seq = read_seqbegin(&n->ha_lock);
	554	memcpy(dst, n->ha, dev->addr_len);
	555	} while (read_seqretry(&n->ha_lock, seq));
	556	}
4fd3d7d9	557
fc6e8073 RP	558	static inline void neigh_update_is_router(struct neighbour *neigh, u32 flags,
	559	int *notify)
	560	{
	561	u8 ndm_flags = 0;
	562
	563	ndm_flags \|= (flags & NEIGH_UPDATE_F_ISROUTER) ? NTF_ROUTER : 0;
	564	if ((neigh->flags ^ ndm_flags) & NTF_ROUTER) {
	565	if (ndm_flags & NTF_ROUTER)
	566	neigh->flags \|= NTF_ROUTER;
	567	else
	568	neigh->flags &= ~NTF_ROUTER;
	569	*notify = 1;
	570	}
	571	}
1da177e4	572	#endif