neighbour.h 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391
  1. #ifndef _NET_NEIGHBOUR_H
  2. #define _NET_NEIGHBOUR_H
  3. #include <linux/neighbour.h>
  4. /*
  5. * Generic neighbour manipulation
  6. *
  7. * Authors:
  8. * Pedro Roque <roque@di.fc.ul.pt>
  9. * Alexey Kuznetsov <kuznet@ms2.inr.ac.ru>
  10. *
  11. * Changes:
  12. *
  13. * Harald Welte: <laforge@gnumonks.org>
  14. * - Add neighbour cache statistics like rtstat
  15. */
  16. #include <asm/atomic.h>
  17. #include <linux/netdevice.h>
  18. #include <linux/skbuff.h>
  19. #include <linux/rcupdate.h>
  20. #include <linux/seq_file.h>
  21. #include <linux/err.h>
  22. #include <linux/sysctl.h>
  23. #include <linux/workqueue.h>
  24. #include <net/rtnetlink.h>
  25. /*
  26. * NUD stands for "neighbor unreachability detection"
  27. */
  28. #define NUD_IN_TIMER (NUD_INCOMPLETE|NUD_REACHABLE|NUD_DELAY|NUD_PROBE)
  29. #define NUD_VALID (NUD_PERMANENT|NUD_NOARP|NUD_REACHABLE|NUD_PROBE|NUD_STALE|NUD_DELAY)
  30. #define NUD_CONNECTED (NUD_PERMANENT|NUD_NOARP|NUD_REACHABLE)
  31. struct neighbour;
  32. struct neigh_parms {
  33. #ifdef CONFIG_NET_NS
  34. struct net *net;
  35. #endif
  36. struct net_device *dev;
  37. struct neigh_parms *next;
  38. int (*neigh_setup)(struct neighbour *);
  39. void (*neigh_cleanup)(struct neighbour *);
  40. struct neigh_table *tbl;
  41. void *sysctl_table;
  42. int dead;
  43. atomic_t refcnt;
  44. struct rcu_head rcu_head;
  45. int base_reachable_time;
  46. int retrans_time;
  47. int gc_staletime;
  48. int reachable_time;
  49. int delay_probe_time;
  50. int queue_len;
  51. int ucast_probes;
  52. int app_probes;
  53. int mcast_probes;
  54. int anycast_delay;
  55. int proxy_delay;
  56. int proxy_qlen;
  57. int locktime;
  58. };
  59. struct neigh_statistics {
  60. unsigned long allocs; /* number of allocated neighs */
  61. unsigned long destroys; /* number of destroyed neighs */
  62. unsigned long hash_grows; /* number of hash resizes */
  63. unsigned long res_failed; /* number of failed resolutions */
  64. unsigned long lookups; /* number of lookups */
  65. unsigned long hits; /* number of hits (among lookups) */
  66. unsigned long rcv_probes_mcast; /* number of received mcast ipv6 */
  67. unsigned long rcv_probes_ucast; /* number of received ucast ipv6 */
  68. unsigned long periodic_gc_runs; /* number of periodic GC runs */
  69. unsigned long forced_gc_runs; /* number of forced GC runs */
  70. unsigned long unres_discards; /* number of unresolved drops */
  71. };
  72. #define NEIGH_CACHE_STAT_INC(tbl, field) this_cpu_inc((tbl)->stats->field)
  73. struct neighbour {
  74. struct neighbour __rcu *next;
  75. struct neigh_table *tbl;
  76. struct neigh_parms *parms;
  77. unsigned long confirmed;
  78. unsigned long updated;
  79. rwlock_t lock;
  80. atomic_t refcnt;
  81. struct sk_buff_head arp_queue;
  82. struct timer_list timer;
  83. unsigned long used;
  84. atomic_t probes;
  85. __u8 flags;
  86. __u8 nud_state;
  87. __u8 type;
  88. __u8 dead;
  89. seqlock_t ha_lock;
  90. unsigned char ha[ALIGN(MAX_ADDR_LEN, sizeof(unsigned long))];
  91. struct hh_cache *hh;
  92. int (*output)(struct sk_buff *skb);
  93. const struct neigh_ops *ops;
  94. struct rcu_head rcu;
  95. struct net_device *dev;
  96. u8 primary_key[0];
  97. };
  98. struct neigh_ops {
  99. int family;
  100. void (*solicit)(struct neighbour *, struct sk_buff*);
  101. void (*error_report)(struct neighbour *, struct sk_buff*);
  102. int (*output)(struct sk_buff*);
  103. int (*connected_output)(struct sk_buff*);
  104. int (*hh_output)(struct sk_buff*);
  105. int (*queue_xmit)(struct sk_buff*);
  106. };
  107. struct pneigh_entry {
  108. struct pneigh_entry *next;
  109. #ifdef CONFIG_NET_NS
  110. struct net *net;
  111. #endif
  112. struct net_device *dev;
  113. u8 flags;
  114. u8 key[0];
  115. };
  116. /*
  117. * neighbour table manipulation
  118. */
  119. struct neigh_hash_table {
  120. struct neighbour __rcu **hash_buckets;
  121. unsigned int hash_mask;
  122. __u32 hash_rnd;
  123. struct rcu_head rcu;
  124. };
  125. struct neigh_table {
  126. struct neigh_table *next;
  127. int family;
  128. int entry_size;
  129. int key_len;
  130. __u32 (*hash)(const void *pkey,
  131. const struct net_device *dev,
  132. __u32 hash_rnd);
  133. int (*constructor)(struct neighbour *);
  134. int (*pconstructor)(struct pneigh_entry *);
  135. void (*pdestructor)(struct pneigh_entry *);
  136. void (*proxy_redo)(struct sk_buff *skb);
  137. char *id;
  138. struct neigh_parms parms;
  139. /* HACK. gc_* should follow parms without a gap! */
  140. int gc_interval;
  141. int gc_thresh1;
  142. int gc_thresh2;
  143. int gc_thresh3;
  144. unsigned long last_flush;
  145. struct delayed_work gc_work;
  146. struct timer_list proxy_timer;
  147. struct sk_buff_head proxy_queue;
  148. atomic_t entries;
  149. rwlock_t lock;
  150. unsigned long last_rand;
  151. struct kmem_cache *kmem_cachep;
  152. struct neigh_statistics __percpu *stats;
  153. struct neigh_hash_table __rcu *nht;
  154. struct pneigh_entry **phash_buckets;
  155. };
  156. /* flags for neigh_update() */
  157. #define NEIGH_UPDATE_F_OVERRIDE 0x00000001
  158. #define NEIGH_UPDATE_F_WEAK_OVERRIDE 0x00000002
  159. #define NEIGH_UPDATE_F_OVERRIDE_ISROUTER 0x00000004
  160. #define NEIGH_UPDATE_F_ISROUTER 0x40000000
  161. #define NEIGH_UPDATE_F_ADMIN 0x80000000
  162. extern void neigh_table_init(struct neigh_table *tbl);
  163. extern void neigh_table_init_no_netlink(struct neigh_table *tbl);
  164. extern int neigh_table_clear(struct neigh_table *tbl);
  165. extern struct neighbour * neigh_lookup(struct neigh_table *tbl,
  166. const void *pkey,
  167. struct net_device *dev);
  168. extern struct neighbour * neigh_lookup_nodev(struct neigh_table *tbl,
  169. struct net *net,
  170. const void *pkey);
  171. extern struct neighbour * neigh_create(struct neigh_table *tbl,
  172. const void *pkey,
  173. struct net_device *dev);
  174. extern void neigh_destroy(struct neighbour *neigh);
  175. extern int __neigh_event_send(struct neighbour *neigh, struct sk_buff *skb);
  176. extern int neigh_update(struct neighbour *neigh, const u8 *lladdr, u8 new,
  177. u32 flags);
  178. extern void neigh_changeaddr(struct neigh_table *tbl, struct net_device *dev);
  179. extern int neigh_ifdown(struct neigh_table *tbl, struct net_device *dev);
  180. extern int neigh_resolve_output(struct sk_buff *skb);
  181. extern int neigh_connected_output(struct sk_buff *skb);
  182. extern int neigh_compat_output(struct sk_buff *skb);
  183. extern struct neighbour *neigh_event_ns(struct neigh_table *tbl,
  184. u8 *lladdr, void *saddr,
  185. struct net_device *dev);
  186. extern struct neigh_parms *neigh_parms_alloc(struct net_device *dev, struct neigh_table *tbl);
  187. extern void neigh_parms_release(struct neigh_table *tbl, struct neigh_parms *parms);
  188. static inline
  189. struct net *neigh_parms_net(const struct neigh_parms *parms)
  190. {
  191. return read_pnet(&parms->net);
  192. }
  193. extern unsigned long neigh_rand_reach_time(unsigned long base);
  194. extern void pneigh_enqueue(struct neigh_table *tbl, struct neigh_parms *p,
  195. struct sk_buff *skb);
  196. extern struct pneigh_entry *pneigh_lookup(struct neigh_table *tbl, struct net *net, const void *key, struct net_device *dev, int creat);
  197. extern struct pneigh_entry *__pneigh_lookup(struct neigh_table *tbl,
  198. struct net *net,
  199. const void *key,
  200. struct net_device *dev);
  201. extern int pneigh_delete(struct neigh_table *tbl, struct net *net, const void *key, struct net_device *dev);
  202. static inline
  203. struct net *pneigh_net(const struct pneigh_entry *pneigh)
  204. {
  205. return read_pnet(&pneigh->net);
  206. }
  207. extern void neigh_app_ns(struct neighbour *n);
  208. extern void neigh_for_each(struct neigh_table *tbl, void (*cb)(struct neighbour *, void *), void *cookie);
  209. extern void __neigh_for_each_release(struct neigh_table *tbl, int (*cb)(struct neighbour *));
  210. extern void pneigh_for_each(struct neigh_table *tbl, void (*cb)(struct pneigh_entry *));
  211. struct neigh_seq_state {
  212. struct seq_net_private p;
  213. struct neigh_table *tbl;
  214. struct neigh_hash_table *nht;
  215. void *(*neigh_sub_iter)(struct neigh_seq_state *state,
  216. struct neighbour *n, loff_t *pos);
  217. unsigned int bucket;
  218. unsigned int flags;
  219. #define NEIGH_SEQ_NEIGH_ONLY 0x00000001
  220. #define NEIGH_SEQ_IS_PNEIGH 0x00000002
  221. #define NEIGH_SEQ_SKIP_NOARP 0x00000004
  222. };
  223. extern void *neigh_seq_start(struct seq_file *, loff_t *, struct neigh_table *, unsigned int);
  224. extern void *neigh_seq_next(struct seq_file *, void *, loff_t *);
  225. extern void neigh_seq_stop(struct seq_file *, void *);
  226. extern int neigh_sysctl_register(struct net_device *dev,
  227. struct neigh_parms *p,
  228. char *p_name,
  229. proc_handler *proc_handler);
  230. extern void neigh_sysctl_unregister(struct neigh_parms *p);
  231. static inline void __neigh_parms_put(struct neigh_parms *parms)
  232. {
  233. atomic_dec(&parms->refcnt);
  234. }
  235. static inline struct neigh_parms *neigh_parms_clone(struct neigh_parms *parms)
  236. {
  237. atomic_inc(&parms->refcnt);
  238. return parms;
  239. }
  240. /*
  241. * Neighbour references
  242. */
  243. static inline void neigh_release(struct neighbour *neigh)
  244. {
  245. if (atomic_dec_and_test(&neigh->refcnt))
  246. neigh_destroy(neigh);
  247. }
  248. static inline struct neighbour * neigh_clone(struct neighbour *neigh)
  249. {
  250. if (neigh)
  251. atomic_inc(&neigh->refcnt);
  252. return neigh;
  253. }
  254. #define neigh_hold(n) atomic_inc(&(n)->refcnt)
  255. static inline void neigh_confirm(struct neighbour *neigh)
  256. {
  257. if (neigh)
  258. neigh->confirmed = jiffies;
  259. }
  260. static inline int neigh_event_send(struct neighbour *neigh, struct sk_buff *skb)
  261. {
  262. unsigned long now = jiffies;
  263. if (neigh->used != now)
  264. neigh->used = now;
  265. if (!(neigh->nud_state&(NUD_CONNECTED|NUD_DELAY|NUD_PROBE)))
  266. return __neigh_event_send(neigh, skb);
  267. return 0;
  268. }
  269. #ifdef CONFIG_BRIDGE_NETFILTER
  270. static inline int neigh_hh_bridge(struct hh_cache *hh, struct sk_buff *skb)
  271. {
  272. unsigned seq, hh_alen;
  273. do {
  274. seq = read_seqbegin(&hh->hh_lock);
  275. hh_alen = HH_DATA_ALIGN(ETH_HLEN);
  276. memcpy(skb->data - hh_alen, hh->hh_data, ETH_ALEN + hh_alen - ETH_HLEN);
  277. } while (read_seqretry(&hh->hh_lock, seq));
  278. return 0;
  279. }
  280. #endif
  281. static inline int neigh_hh_output(struct hh_cache *hh, struct sk_buff *skb)
  282. {
  283. unsigned seq;
  284. int hh_len;
  285. do {
  286. int hh_alen;
  287. seq = read_seqbegin(&hh->hh_lock);
  288. hh_len = hh->hh_len;
  289. hh_alen = HH_DATA_ALIGN(hh_len);
  290. memcpy(skb->data - hh_alen, hh->hh_data, hh_alen);
  291. } while (read_seqretry(&hh->hh_lock, seq));
  292. skb_push(skb, hh_len);
  293. return hh->hh_output(skb);
  294. }
  295. static inline struct neighbour *
  296. __neigh_lookup(struct neigh_table *tbl, const void *pkey, struct net_device *dev, int creat)
  297. {
  298. struct neighbour *n = neigh_lookup(tbl, pkey, dev);
  299. if (n || !creat)
  300. return n;
  301. n = neigh_create(tbl, pkey, dev);
  302. return IS_ERR(n) ? NULL : n;
  303. }
  304. static inline struct neighbour *
  305. __neigh_lookup_errno(struct neigh_table *tbl, const void *pkey,
  306. struct net_device *dev)
  307. {
  308. struct neighbour *n = neigh_lookup(tbl, pkey, dev);
  309. if (n)
  310. return n;
  311. return neigh_create(tbl, pkey, dev);
  312. }
  313. struct neighbour_cb {
  314. unsigned long sched_next;
  315. unsigned int flags;
  316. };
  317. #define LOCALLY_ENQUEUED 0x1
  318. #define NEIGH_CB(skb) ((struct neighbour_cb *)(skb)->cb)
  319. static inline void neigh_ha_snapshot(char *dst, const struct neighbour *n,
  320. const struct net_device *dev)
  321. {
  322. unsigned int seq;
  323. do {
  324. seq = read_seqbegin(&n->ha_lock);
  325. memcpy(dst, n->ha, dev->addr_len);
  326. } while (read_seqretry(&n->ha_lock, seq));
  327. }
  328. #endif