[mirror_ubuntu-bionic-kernel.git] / include / net / neighbour.h

#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;
	struct sk_buff_head	arp_queue;
	unsigned int		arp_queue_len_bytes;
	struct timer_list	timer;
	unsigned long		used;
	atomic_t		probes;
	__u8			flags;
	__u8			nud_state;
	__u8			type;
	__u8			dead;
	seqlock_t		ha_lock;
	unsigned char		ha[ALIGN(MAX_ADDR_LEN, sizeof(unsigned long))];
	struct hh_cache		hh;
	int			(*output)(struct neighbour *, struct sk_buff *);
	const struct neigh_ops	*ops;
	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			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);
	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;
	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_ISROUTER			0x40000000
#define NEIGH_UPDATE_F_ADMIN			0x80000000


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_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 seq;
	unsigned int hh_len;

	do {
		seq = read_seqbegin(&hh->hh_lock);
		hh_len = hh->hh_len;
		if (likely(hh_len <= HH_DATA_MOD)) {
			/* this is inlined by gcc */
			memcpy(skb->data - HH_DATA_MOD, hh->hh_data, HH_DATA_MOD);
		} else {
			unsigned int hh_alen = HH_DATA_ALIGN(hh_len);

			memcpy(skb->data - hh_alen, hh->hh_data, hh_alen);
		}
	} while (read_seqretry(&hh->hh_lock, seq));

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

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

	if ((n->nud_state & NUD_CONNECTED) && hh->hh_len)
		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));
}


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