1#ifndef _NET_NEIGHBOUR_H
2#define _NET_NEIGHBOUR_H
3
4#include <linux/neighbour.h>
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19#include <linux/atomic.h>
20#include <linux/netdevice.h>
21#include <linux/skbuff.h>
22#include <linux/rcupdate.h>
23#include <linux/seq_file.h>
24#include <linux/bitmap.h>
25
26#include <linux/err.h>
27#include <linux/sysctl.h>
28#include <linux/workqueue.h>
29#include <net/rtnetlink.h>
30
31
32
33
34
35#define NUD_IN_TIMER (NUD_INCOMPLETE|NUD_REACHABLE|NUD_DELAY|NUD_PROBE)
36#define NUD_VALID (NUD_PERMANENT|NUD_NOARP|NUD_REACHABLE|NUD_PROBE|NUD_STALE|NUD_DELAY)
37#define NUD_CONNECTED (NUD_PERMANENT|NUD_NOARP|NUD_REACHABLE)
38
39struct neighbour;
40
41enum {
42 NEIGH_VAR_MCAST_PROBES,
43 NEIGH_VAR_UCAST_PROBES,
44 NEIGH_VAR_APP_PROBES,
45 NEIGH_VAR_RETRANS_TIME,
46 NEIGH_VAR_BASE_REACHABLE_TIME,
47 NEIGH_VAR_DELAY_PROBE_TIME,
48 NEIGH_VAR_GC_STALETIME,
49 NEIGH_VAR_QUEUE_LEN_BYTES,
50 NEIGH_VAR_PROXY_QLEN,
51 NEIGH_VAR_ANYCAST_DELAY,
52 NEIGH_VAR_PROXY_DELAY,
53 NEIGH_VAR_LOCKTIME,
54#define NEIGH_VAR_DATA_MAX (NEIGH_VAR_LOCKTIME + 1)
55
56 NEIGH_VAR_QUEUE_LEN,
57 NEIGH_VAR_RETRANS_TIME_MS,
58 NEIGH_VAR_BASE_REACHABLE_TIME_MS,
59
60 NEIGH_VAR_GC_INTERVAL,
61 NEIGH_VAR_GC_THRESH1,
62 NEIGH_VAR_GC_THRESH2,
63 NEIGH_VAR_GC_THRESH3,
64 NEIGH_VAR_MAX
65};
66
67struct neigh_parms {
68 possible_net_t net;
69 struct net_device *dev;
70 struct neigh_parms *next;
71 int (*neigh_setup)(struct neighbour *);
72 void (*neigh_cleanup)(struct neighbour *);
73 struct neigh_table *tbl;
74
75 void *sysctl_table;
76
77 int dead;
78 atomic_t refcnt;
79 struct rcu_head rcu_head;
80
81 int reachable_time;
82 int data[NEIGH_VAR_DATA_MAX];
83 DECLARE_BITMAP(data_state, NEIGH_VAR_DATA_MAX);
84};
85
86static inline void neigh_var_set(struct neigh_parms *p, int index, int val)
87{
88 set_bit(index, p->data_state);
89 p->data[index] = val;
90}
91
92#define NEIGH_VAR(p, attr) ((p)->data[NEIGH_VAR_ ## attr])
93#define NEIGH_VAR_SET(p, attr, val) neigh_var_set(p, NEIGH_VAR_ ## attr, val)
94
95static inline void neigh_parms_data_state_setall(struct neigh_parms *p)
96{
97 bitmap_fill(p->data_state, NEIGH_VAR_DATA_MAX);
98}
99
100static inline void neigh_parms_data_state_cleanall(struct neigh_parms *p)
101{
102 bitmap_zero(p->data_state, NEIGH_VAR_DATA_MAX);
103}
104
105struct neigh_statistics {
106 unsigned long allocs;
107 unsigned long destroys;
108 unsigned long hash_grows;
109
110 unsigned long res_failed;
111
112 unsigned long lookups;
113 unsigned long hits;
114
115 unsigned long rcv_probes_mcast;
116 unsigned long rcv_probes_ucast;
117
118 unsigned long periodic_gc_runs;
119 unsigned long forced_gc_runs;
120
121 unsigned long unres_discards;
122};
123
124#define NEIGH_CACHE_STAT_INC(tbl, field) this_cpu_inc((tbl)->stats->field)
125
126struct neighbour {
127 struct neighbour __rcu *next;
128 struct neigh_table *tbl;
129 struct neigh_parms *parms;
130 unsigned long confirmed;
131 unsigned long updated;
132 rwlock_t lock;
133 atomic_t refcnt;
134 struct sk_buff_head arp_queue;
135 unsigned int arp_queue_len_bytes;
136 struct timer_list timer;
137 unsigned long used;
138 atomic_t probes;
139 __u8 flags;
140 __u8 nud_state;
141 __u8 type;
142 __u8 dead;
143 seqlock_t ha_lock;
144 unsigned char ha[ALIGN(MAX_ADDR_LEN, sizeof(unsigned long))];
145 struct hh_cache hh;
146 int (*output)(struct neighbour *, struct sk_buff *);
147 const struct neigh_ops *ops;
148 struct rcu_head rcu;
149 struct net_device *dev;
150 u8 primary_key[0];
151};
152
153struct neigh_ops {
154 int family;
155 void (*solicit)(struct neighbour *, struct sk_buff *);
156 void (*error_report)(struct neighbour *, struct sk_buff *);
157 int (*output)(struct neighbour *, struct sk_buff *);
158 int (*connected_output)(struct neighbour *, struct sk_buff *);
159};
160
161struct pneigh_entry {
162 struct pneigh_entry *next;
163 possible_net_t net;
164 struct net_device *dev;
165 u8 flags;
166 u8 key[0];
167};
168
169
170
171
172
173#define NEIGH_NUM_HASH_RND 4
174
175struct neigh_hash_table {
176 struct neighbour __rcu **hash_buckets;
177 unsigned int hash_shift;
178 __u32 hash_rnd[NEIGH_NUM_HASH_RND];
179 struct rcu_head rcu;
180};
181
182
183struct neigh_table {
184 struct neigh_table *next;
185 int family;
186 int entry_size;
187 int key_len;
188 __u32 (*hash)(const void *pkey,
189 const struct net_device *dev,
190 __u32 *hash_rnd);
191 int (*constructor)(struct neighbour *);
192 int (*pconstructor)(struct pneigh_entry *);
193 void (*pdestructor)(struct pneigh_entry *);
194 void (*proxy_redo)(struct sk_buff *skb);
195 char *id;
196 struct neigh_parms parms;
197
198 int gc_interval;
199 int gc_thresh1;
200 int gc_thresh2;
201 int gc_thresh3;
202 unsigned long last_flush;
203 struct delayed_work gc_work;
204 struct timer_list proxy_timer;
205 struct sk_buff_head proxy_queue;
206 atomic_t entries;
207 rwlock_t lock;
208 unsigned long last_rand;
209 struct neigh_statistics __percpu *stats;
210 struct neigh_hash_table __rcu *nht;
211 struct pneigh_entry **phash_buckets;
212};
213
214enum {
215 NEIGH_ARP_TABLE = 0,
216 NEIGH_ND_TABLE = 1,
217 NEIGH_DN_TABLE = 2,
218 NEIGH_NR_TABLES,
219};
220
221static inline int neigh_parms_family(struct neigh_parms *p)
222{
223 return p->tbl->family;
224}
225
226#define NEIGH_PRIV_ALIGN sizeof(long long)
227#define NEIGH_ENTRY_SIZE(size) ALIGN((size), NEIGH_PRIV_ALIGN)
228
229static inline void *neighbour_priv(const struct neighbour *n)
230{
231 return (char *)n + n->tbl->entry_size;
232}
233
234
235#define NEIGH_UPDATE_F_OVERRIDE 0x00000001
236#define NEIGH_UPDATE_F_WEAK_OVERRIDE 0x00000002
237#define NEIGH_UPDATE_F_OVERRIDE_ISROUTER 0x00000004
238#define NEIGH_UPDATE_F_ISROUTER 0x40000000
239#define NEIGH_UPDATE_F_ADMIN 0x80000000
240
241void neigh_table_init(int index, struct neigh_table *tbl);
242int neigh_table_clear(int index, struct neigh_table *tbl);
243struct neighbour *neigh_lookup(struct neigh_table *tbl, const void *pkey,
244 struct net_device *dev);
245struct neighbour *neigh_lookup_nodev(struct neigh_table *tbl, struct net *net,
246 const void *pkey);
247struct neighbour *__neigh_create(struct neigh_table *tbl, const void *pkey,
248 struct net_device *dev, bool want_ref);
249static inline struct neighbour *neigh_create(struct neigh_table *tbl,
250 const void *pkey,
251 struct net_device *dev)
252{
253 return __neigh_create(tbl, pkey, dev, true);
254}
255void neigh_destroy(struct neighbour *neigh);
256int __neigh_event_send(struct neighbour *neigh, struct sk_buff *skb);
257int neigh_update(struct neighbour *neigh, const u8 *lladdr, u8 new, u32 flags,
258 u32 nlmsg_pid);
259void __neigh_set_probe_once(struct neighbour *neigh);
260bool neigh_remove_one(struct neighbour *ndel, struct neigh_table *tbl);
261void neigh_changeaddr(struct neigh_table *tbl, struct net_device *dev);
262int neigh_ifdown(struct neigh_table *tbl, struct net_device *dev);
263int neigh_resolve_output(struct neighbour *neigh, struct sk_buff *skb);
264int neigh_connected_output(struct neighbour *neigh, struct sk_buff *skb);
265int neigh_compat_output(struct neighbour *neigh, struct sk_buff *skb);
266int neigh_direct_output(struct neighbour *neigh, struct sk_buff *skb);
267struct neighbour *neigh_event_ns(struct neigh_table *tbl,
268 u8 *lladdr, void *saddr,
269 struct net_device *dev);
270
271struct neigh_parms *neigh_parms_alloc(struct net_device *dev,
272 struct neigh_table *tbl);
273void neigh_parms_release(struct neigh_table *tbl, struct neigh_parms *parms);
274
275static inline
276struct net *neigh_parms_net(const struct neigh_parms *parms)
277{
278 return read_pnet(&parms->net);
279}
280
281unsigned long neigh_rand_reach_time(unsigned long base);
282
283void pneigh_enqueue(struct neigh_table *tbl, struct neigh_parms *p,
284 struct sk_buff *skb);
285struct pneigh_entry *pneigh_lookup(struct neigh_table *tbl, struct net *net,
286 const void *key, struct net_device *dev,
287 int creat);
288struct pneigh_entry *__pneigh_lookup(struct neigh_table *tbl, struct net *net,
289 const void *key, struct net_device *dev);
290int pneigh_delete(struct neigh_table *tbl, struct net *net, const void *key,
291 struct net_device *dev);
292
293static inline struct net *pneigh_net(const struct pneigh_entry *pneigh)
294{
295 return read_pnet(&pneigh->net);
296}
297
298void neigh_app_ns(struct neighbour *n);
299void neigh_for_each(struct neigh_table *tbl,
300 void (*cb)(struct neighbour *, void *), void *cookie);
301void __neigh_for_each_release(struct neigh_table *tbl,
302 int (*cb)(struct neighbour *));
303void pneigh_for_each(struct neigh_table *tbl,
304 void (*cb)(struct pneigh_entry *));
305
306struct neigh_seq_state {
307 struct seq_net_private p;
308 struct neigh_table *tbl;
309 struct neigh_hash_table *nht;
310 void *(*neigh_sub_iter)(struct neigh_seq_state *state,
311 struct neighbour *n, loff_t *pos);
312 unsigned int bucket;
313 unsigned int flags;
314#define NEIGH_SEQ_NEIGH_ONLY 0x00000001
315#define NEIGH_SEQ_IS_PNEIGH 0x00000002
316#define NEIGH_SEQ_SKIP_NOARP 0x00000004
317};
318void *neigh_seq_start(struct seq_file *, loff_t *, struct neigh_table *,
319 unsigned int);
320void *neigh_seq_next(struct seq_file *, void *, loff_t *);
321void neigh_seq_stop(struct seq_file *, void *);
322
323int neigh_proc_dointvec(struct ctl_table *ctl, int write,
324 void __user *buffer, size_t *lenp, loff_t *ppos);
325int neigh_proc_dointvec_jiffies(struct ctl_table *ctl, int write,
326 void __user *buffer,
327 size_t *lenp, loff_t *ppos);
328int neigh_proc_dointvec_ms_jiffies(struct ctl_table *ctl, int write,
329 void __user *buffer,
330 size_t *lenp, loff_t *ppos);
331
332int neigh_sysctl_register(struct net_device *dev, struct neigh_parms *p,
333 proc_handler *proc_handler);
334void neigh_sysctl_unregister(struct neigh_parms *p);
335
336static inline void __neigh_parms_put(struct neigh_parms *parms)
337{
338 atomic_dec(&parms->refcnt);
339}
340
341static inline struct neigh_parms *neigh_parms_clone(struct neigh_parms *parms)
342{
343 atomic_inc(&parms->refcnt);
344 return parms;
345}
346
347
348
349
350
351static inline void neigh_release(struct neighbour *neigh)
352{
353 if (atomic_dec_and_test(&neigh->refcnt))
354 neigh_destroy(neigh);
355}
356
357static inline struct neighbour * neigh_clone(struct neighbour *neigh)
358{
359 if (neigh)
360 atomic_inc(&neigh->refcnt);
361 return neigh;
362}
363
364#define neigh_hold(n) atomic_inc(&(n)->refcnt)
365
366static inline int neigh_event_send(struct neighbour *neigh, struct sk_buff *skb)
367{
368 unsigned long now = jiffies;
369
370 if (neigh->used != now)
371 neigh->used = now;
372 if (!(neigh->nud_state&(NUD_CONNECTED|NUD_DELAY|NUD_PROBE)))
373 return __neigh_event_send(neigh, skb);
374 return 0;
375}
376
377#if IS_ENABLED(CONFIG_BRIDGE_NETFILTER)
378static inline int neigh_hh_bridge(struct hh_cache *hh, struct sk_buff *skb)
379{
380 unsigned int seq, hh_alen;
381
382 do {
383 seq = read_seqbegin(&hh->hh_lock);
384 hh_alen = HH_DATA_ALIGN(ETH_HLEN);
385 memcpy(skb->data - hh_alen, hh->hh_data, ETH_ALEN + hh_alen - ETH_HLEN);
386 } while (read_seqretry(&hh->hh_lock, seq));
387 return 0;
388}
389#endif
390
391static inline int neigh_hh_output(const struct hh_cache *hh, struct sk_buff *skb)
392{
393 int hh_alen = 0;
394 unsigned int seq;
395 int hh_len;
396
397 do {
398 seq = read_seqbegin(&hh->hh_lock);
399 hh_len = hh->hh_len;
400 if (likely(hh_len <= HH_DATA_MOD)) {
401 hh_alen = HH_DATA_MOD;
402
403
404
405
406
407 if (likely(skb_headroom(skb) >= HH_DATA_MOD)) {
408
409 memcpy(skb->data - HH_DATA_MOD, hh->hh_data,
410 HH_DATA_MOD);
411 }
412 } else {
413 hh_alen = HH_DATA_ALIGN(hh_len);
414
415 if (likely(skb_headroom(skb) >= hh_alen)) {
416 memcpy(skb->data - hh_alen, hh->hh_data,
417 hh_alen);
418 }
419 }
420 } while (read_seqretry(&hh->hh_lock, seq));
421
422 if (WARN_ON_ONCE(skb_headroom(skb) < hh_alen)) {
423 kfree_skb(skb);
424 return NET_XMIT_DROP;
425 }
426
427 __skb_push(skb, hh_len);
428 return dev_queue_xmit(skb);
429}
430
431static inline struct neighbour *
432__neigh_lookup(struct neigh_table *tbl, const void *pkey, struct net_device *dev, int creat)
433{
434 struct neighbour *n = neigh_lookup(tbl, pkey, dev);
435
436 if (n || !creat)
437 return n;
438
439 n = neigh_create(tbl, pkey, dev);
440 return IS_ERR(n) ? NULL : n;
441}
442
443static inline struct neighbour *
444__neigh_lookup_errno(struct neigh_table *tbl, const void *pkey,
445 struct net_device *dev)
446{
447 struct neighbour *n = neigh_lookup(tbl, pkey, dev);
448
449 if (n)
450 return n;
451
452 return neigh_create(tbl, pkey, dev);
453}
454
455struct neighbour_cb {
456 unsigned long sched_next;
457 unsigned int flags;
458};
459
460#define LOCALLY_ENQUEUED 0x1
461
462#define NEIGH_CB(skb) ((struct neighbour_cb *)(skb)->cb)
463
464static inline void neigh_ha_snapshot(char *dst, const struct neighbour *n,
465 const struct net_device *dev)
466{
467 unsigned int seq;
468
469 do {
470 seq = read_seqbegin(&n->ha_lock);
471 memcpy(dst, n->ha, dev->addr_len);
472 } while (read_seqretry(&n->ha_lock, seq));
473}
474#endif
475
