11da177e4SLinus Torvalds #ifndef _NET_NEIGHBOUR_H 21da177e4SLinus Torvalds #define _NET_NEIGHBOUR_H 31da177e4SLinus Torvalds 49067c722SThomas Graf #include <linux/neighbour.h> 59067c722SThomas Graf 61da177e4SLinus Torvalds /* 71da177e4SLinus Torvalds * Generic neighbour manipulation 81da177e4SLinus Torvalds * 91da177e4SLinus Torvalds * Authors: 101da177e4SLinus Torvalds * Pedro Roque <roque@di.fc.ul.pt> 111da177e4SLinus Torvalds * Alexey Kuznetsov <kuznet@ms2.inr.ac.ru> 121da177e4SLinus Torvalds * 131da177e4SLinus Torvalds * Changes: 141da177e4SLinus Torvalds * 151da177e4SLinus Torvalds * Harald Welte: <laforge@gnumonks.org> 161da177e4SLinus Torvalds * - Add neighbour cache statistics like rtstat 171da177e4SLinus Torvalds */ 181da177e4SLinus Torvalds 191da177e4SLinus Torvalds #include <asm/atomic.h> 201da177e4SLinus Torvalds #include <linux/netdevice.h> 2114c85021SArnaldo Carvalho de Melo #include <linux/skbuff.h> 221da177e4SLinus Torvalds #include <linux/rcupdate.h> 231da177e4SLinus Torvalds #include <linux/seq_file.h> 241da177e4SLinus Torvalds 251da177e4SLinus Torvalds #include <linux/err.h> 261da177e4SLinus Torvalds #include <linux/sysctl.h> 271da177e4SLinus Torvalds 281da177e4SLinus Torvalds #define NUD_IN_TIMER (NUD_INCOMPLETE|NUD_REACHABLE|NUD_DELAY|NUD_PROBE) 291da177e4SLinus Torvalds #define NUD_VALID (NUD_PERMANENT|NUD_NOARP|NUD_REACHABLE|NUD_PROBE|NUD_STALE|NUD_DELAY) 301da177e4SLinus Torvalds #define NUD_CONNECTED (NUD_PERMANENT|NUD_NOARP|NUD_REACHABLE) 311da177e4SLinus Torvalds 321da177e4SLinus Torvalds struct neighbour; 331da177e4SLinus Torvalds 341da177e4SLinus Torvalds struct neigh_parms 351da177e4SLinus Torvalds { 36c7fb64dbSThomas Graf struct net_device *dev; 371da177e4SLinus Torvalds struct neigh_parms *next; 381da177e4SLinus Torvalds int (*neigh_setup)(struct neighbour *); 39c5ecd62cSMichael S. Tsirkin void (*neigh_destructor)(struct neighbour *); 401da177e4SLinus Torvalds struct neigh_table *tbl; 411da177e4SLinus Torvalds 421da177e4SLinus Torvalds void *sysctl_table; 431da177e4SLinus Torvalds 441da177e4SLinus Torvalds int dead; 451da177e4SLinus Torvalds atomic_t refcnt; 461da177e4SLinus Torvalds struct rcu_head rcu_head; 471da177e4SLinus Torvalds 481da177e4SLinus Torvalds int base_reachable_time; 491da177e4SLinus Torvalds int retrans_time; 501da177e4SLinus Torvalds int gc_staletime; 511da177e4SLinus Torvalds int reachable_time; 521da177e4SLinus Torvalds int delay_probe_time; 531da177e4SLinus Torvalds 541da177e4SLinus Torvalds int queue_len; 551da177e4SLinus Torvalds int ucast_probes; 561da177e4SLinus Torvalds int app_probes; 571da177e4SLinus Torvalds int mcast_probes; 581da177e4SLinus Torvalds int anycast_delay; 591da177e4SLinus Torvalds int proxy_delay; 601da177e4SLinus Torvalds int proxy_qlen; 611da177e4SLinus Torvalds int locktime; 621da177e4SLinus Torvalds }; 631da177e4SLinus Torvalds 641da177e4SLinus Torvalds struct neigh_statistics 651da177e4SLinus Torvalds { 661da177e4SLinus Torvalds unsigned long allocs; /* number of allocated neighs */ 671da177e4SLinus Torvalds unsigned long destroys; /* number of destroyed neighs */ 681da177e4SLinus Torvalds unsigned long hash_grows; /* number of hash resizes */ 691da177e4SLinus Torvalds 701da177e4SLinus Torvalds unsigned long res_failed; /* nomber of failed resolutions */ 711da177e4SLinus Torvalds 721da177e4SLinus Torvalds unsigned long lookups; /* number of lookups */ 731da177e4SLinus Torvalds unsigned long hits; /* number of hits (among lookups) */ 741da177e4SLinus Torvalds 751da177e4SLinus Torvalds unsigned long rcv_probes_mcast; /* number of received mcast ipv6 */ 761da177e4SLinus Torvalds unsigned long rcv_probes_ucast; /* number of received ucast ipv6 */ 771da177e4SLinus Torvalds 781da177e4SLinus Torvalds unsigned long periodic_gc_runs; /* number of periodic GC runs */ 791da177e4SLinus Torvalds unsigned long forced_gc_runs; /* number of forced GC runs */ 801da177e4SLinus Torvalds }; 811da177e4SLinus Torvalds 821da177e4SLinus Torvalds #define NEIGH_CACHE_STAT_INC(tbl, field) \ 831da177e4SLinus Torvalds do { \ 841da177e4SLinus Torvalds preempt_disable(); \ 851da177e4SLinus Torvalds (per_cpu_ptr((tbl)->stats, smp_processor_id())->field)++; \ 861da177e4SLinus Torvalds preempt_enable(); \ 871da177e4SLinus Torvalds } while (0) 881da177e4SLinus Torvalds 891da177e4SLinus Torvalds struct neighbour 901da177e4SLinus Torvalds { 911da177e4SLinus Torvalds struct neighbour *next; 921da177e4SLinus Torvalds struct neigh_table *tbl; 931da177e4SLinus Torvalds struct neigh_parms *parms; 941da177e4SLinus Torvalds struct net_device *dev; 951da177e4SLinus Torvalds unsigned long used; 961da177e4SLinus Torvalds unsigned long confirmed; 971da177e4SLinus Torvalds unsigned long updated; 981da177e4SLinus Torvalds __u8 flags; 991da177e4SLinus Torvalds __u8 nud_state; 1001da177e4SLinus Torvalds __u8 type; 1011da177e4SLinus Torvalds __u8 dead; 1021da177e4SLinus Torvalds atomic_t probes; 1031da177e4SLinus Torvalds rwlock_t lock; 1041da177e4SLinus Torvalds unsigned char ha[(MAX_ADDR_LEN+sizeof(unsigned long)-1)&~(sizeof(unsigned long)-1)]; 1051da177e4SLinus Torvalds struct hh_cache *hh; 1061da177e4SLinus Torvalds atomic_t refcnt; 1071da177e4SLinus Torvalds int (*output)(struct sk_buff *skb); 1081da177e4SLinus Torvalds struct sk_buff_head arp_queue; 1091da177e4SLinus Torvalds struct timer_list timer; 1101da177e4SLinus Torvalds struct neigh_ops *ops; 1111da177e4SLinus Torvalds u8 primary_key[0]; 1121da177e4SLinus Torvalds }; 1131da177e4SLinus Torvalds 1141da177e4SLinus Torvalds struct neigh_ops 1151da177e4SLinus Torvalds { 1161da177e4SLinus Torvalds int family; 1171da177e4SLinus Torvalds void (*solicit)(struct neighbour *, struct sk_buff*); 1181da177e4SLinus Torvalds void (*error_report)(struct neighbour *, struct sk_buff*); 1191da177e4SLinus Torvalds int (*output)(struct sk_buff*); 1201da177e4SLinus Torvalds int (*connected_output)(struct sk_buff*); 1211da177e4SLinus Torvalds int (*hh_output)(struct sk_buff*); 1221da177e4SLinus Torvalds int (*queue_xmit)(struct sk_buff*); 1231da177e4SLinus Torvalds }; 1241da177e4SLinus Torvalds 1251da177e4SLinus Torvalds struct pneigh_entry 1261da177e4SLinus Torvalds { 1271da177e4SLinus Torvalds struct pneigh_entry *next; 1281da177e4SLinus Torvalds struct net_device *dev; 1291da177e4SLinus Torvalds u8 key[0]; 1301da177e4SLinus Torvalds }; 1311da177e4SLinus Torvalds 1321da177e4SLinus Torvalds /* 1331da177e4SLinus Torvalds * neighbour table manipulation 1341da177e4SLinus Torvalds */ 1351da177e4SLinus Torvalds 1361da177e4SLinus Torvalds 1371da177e4SLinus Torvalds struct neigh_table 1381da177e4SLinus Torvalds { 1391da177e4SLinus Torvalds struct neigh_table *next; 1401da177e4SLinus Torvalds int family; 1411da177e4SLinus Torvalds int entry_size; 1421da177e4SLinus Torvalds int key_len; 1431da177e4SLinus Torvalds __u32 (*hash)(const void *pkey, const struct net_device *); 1441da177e4SLinus Torvalds int (*constructor)(struct neighbour *); 1451da177e4SLinus Torvalds int (*pconstructor)(struct pneigh_entry *); 1461da177e4SLinus Torvalds void (*pdestructor)(struct pneigh_entry *); 1471da177e4SLinus Torvalds void (*proxy_redo)(struct sk_buff *skb); 1481da177e4SLinus Torvalds char *id; 1491da177e4SLinus Torvalds struct neigh_parms parms; 1501da177e4SLinus Torvalds /* HACK. gc_* shoul follow parms without a gap! */ 1511da177e4SLinus Torvalds int gc_interval; 1521da177e4SLinus Torvalds int gc_thresh1; 1531da177e4SLinus Torvalds int gc_thresh2; 1541da177e4SLinus Torvalds int gc_thresh3; 1551da177e4SLinus Torvalds unsigned long last_flush; 1561da177e4SLinus Torvalds struct timer_list gc_timer; 1571da177e4SLinus Torvalds struct timer_list proxy_timer; 1581da177e4SLinus Torvalds struct sk_buff_head proxy_queue; 1591da177e4SLinus Torvalds atomic_t entries; 1601da177e4SLinus Torvalds rwlock_t lock; 1611da177e4SLinus Torvalds unsigned long last_rand; 1621da177e4SLinus Torvalds kmem_cache_t *kmem_cachep; 1631da177e4SLinus Torvalds struct neigh_statistics *stats; 1641da177e4SLinus Torvalds struct neighbour **hash_buckets; 1651da177e4SLinus Torvalds unsigned int hash_mask; 1661da177e4SLinus Torvalds __u32 hash_rnd; 1671da177e4SLinus Torvalds unsigned int hash_chain_gc; 1681da177e4SLinus Torvalds struct pneigh_entry **phash_buckets; 1691da177e4SLinus Torvalds #ifdef CONFIG_PROC_FS 1701da177e4SLinus Torvalds struct proc_dir_entry *pde; 1711da177e4SLinus Torvalds #endif 1721da177e4SLinus Torvalds }; 1731da177e4SLinus Torvalds 1741da177e4SLinus Torvalds /* flags for neigh_update() */ 1751da177e4SLinus Torvalds #define NEIGH_UPDATE_F_OVERRIDE 0x00000001 1761da177e4SLinus Torvalds #define NEIGH_UPDATE_F_WEAK_OVERRIDE 0x00000002 1771da177e4SLinus Torvalds #define NEIGH_UPDATE_F_OVERRIDE_ISROUTER 0x00000004 1781da177e4SLinus Torvalds #define NEIGH_UPDATE_F_ISROUTER 0x40000000 1791da177e4SLinus Torvalds #define NEIGH_UPDATE_F_ADMIN 0x80000000 1801da177e4SLinus Torvalds 1811da177e4SLinus Torvalds extern void neigh_table_init(struct neigh_table *tbl); 182bd89efc5SSimon Kelley extern void neigh_table_init_no_netlink(struct neigh_table *tbl); 1831da177e4SLinus Torvalds extern int neigh_table_clear(struct neigh_table *tbl); 1841da177e4SLinus Torvalds extern struct neighbour * neigh_lookup(struct neigh_table *tbl, 1851da177e4SLinus Torvalds const void *pkey, 1861da177e4SLinus Torvalds struct net_device *dev); 1871da177e4SLinus Torvalds extern struct neighbour * neigh_lookup_nodev(struct neigh_table *tbl, 1881da177e4SLinus Torvalds const void *pkey); 1891da177e4SLinus Torvalds extern struct neighbour * neigh_create(struct neigh_table *tbl, 1901da177e4SLinus Torvalds const void *pkey, 1911da177e4SLinus Torvalds struct net_device *dev); 1921da177e4SLinus Torvalds extern void neigh_destroy(struct neighbour *neigh); 1931da177e4SLinus Torvalds extern int __neigh_event_send(struct neighbour *neigh, struct sk_buff *skb); 1941da177e4SLinus Torvalds extern int neigh_update(struct neighbour *neigh, const u8 *lladdr, u8 new, 1951da177e4SLinus Torvalds u32 flags); 1961da177e4SLinus Torvalds extern void neigh_changeaddr(struct neigh_table *tbl, struct net_device *dev); 1971da177e4SLinus Torvalds extern int neigh_ifdown(struct neigh_table *tbl, struct net_device *dev); 1981da177e4SLinus Torvalds extern int neigh_resolve_output(struct sk_buff *skb); 1991da177e4SLinus Torvalds extern int neigh_connected_output(struct sk_buff *skb); 2001da177e4SLinus Torvalds extern int neigh_compat_output(struct sk_buff *skb); 2011da177e4SLinus Torvalds extern struct neighbour *neigh_event_ns(struct neigh_table *tbl, 2021da177e4SLinus Torvalds u8 *lladdr, void *saddr, 2031da177e4SLinus Torvalds struct net_device *dev); 2041da177e4SLinus Torvalds 2051da177e4SLinus Torvalds extern struct neigh_parms *neigh_parms_alloc(struct net_device *dev, struct neigh_table *tbl); 2061da177e4SLinus Torvalds extern void neigh_parms_release(struct neigh_table *tbl, struct neigh_parms *parms); 2071da177e4SLinus Torvalds extern void neigh_parms_destroy(struct neigh_parms *parms); 2081da177e4SLinus Torvalds extern unsigned long neigh_rand_reach_time(unsigned long base); 2091da177e4SLinus Torvalds 2101da177e4SLinus Torvalds extern void pneigh_enqueue(struct neigh_table *tbl, struct neigh_parms *p, 2111da177e4SLinus Torvalds struct sk_buff *skb); 2121da177e4SLinus Torvalds extern struct pneigh_entry *pneigh_lookup(struct neigh_table *tbl, const void *key, struct net_device *dev, int creat); 2131da177e4SLinus Torvalds extern int pneigh_delete(struct neigh_table *tbl, const void *key, struct net_device *dev); 2141da177e4SLinus Torvalds 2151da177e4SLinus Torvalds struct netlink_callback; 2161da177e4SLinus Torvalds struct nlmsghdr; 2171da177e4SLinus Torvalds extern int neigh_dump_info(struct sk_buff *skb, struct netlink_callback *cb); 2181da177e4SLinus Torvalds extern int neigh_add(struct sk_buff *skb, struct nlmsghdr *nlh, void *arg); 2191da177e4SLinus Torvalds extern int neigh_delete(struct sk_buff *skb, struct nlmsghdr *nlh, void *arg); 2201da177e4SLinus Torvalds extern void neigh_app_ns(struct neighbour *n); 2211da177e4SLinus Torvalds 222c7fb64dbSThomas Graf extern int neightbl_dump_info(struct sk_buff *skb, struct netlink_callback *cb); 223c7fb64dbSThomas Graf extern int neightbl_set(struct sk_buff *skb, struct nlmsghdr *nlh, void *arg); 224c7fb64dbSThomas Graf 2251da177e4SLinus Torvalds extern void neigh_for_each(struct neigh_table *tbl, void (*cb)(struct neighbour *, void *), void *cookie); 2261da177e4SLinus Torvalds extern void __neigh_for_each_release(struct neigh_table *tbl, int (*cb)(struct neighbour *)); 2271da177e4SLinus Torvalds extern void pneigh_for_each(struct neigh_table *tbl, void (*cb)(struct pneigh_entry *)); 2281da177e4SLinus Torvalds 2291da177e4SLinus Torvalds struct neigh_seq_state { 2301da177e4SLinus Torvalds struct neigh_table *tbl; 2311da177e4SLinus Torvalds void *(*neigh_sub_iter)(struct neigh_seq_state *state, 2321da177e4SLinus Torvalds struct neighbour *n, loff_t *pos); 2331da177e4SLinus Torvalds unsigned int bucket; 2341da177e4SLinus Torvalds unsigned int flags; 2351da177e4SLinus Torvalds #define NEIGH_SEQ_NEIGH_ONLY 0x00000001 2361da177e4SLinus Torvalds #define NEIGH_SEQ_IS_PNEIGH 0x00000002 2371da177e4SLinus Torvalds #define NEIGH_SEQ_SKIP_NOARP 0x00000004 2381da177e4SLinus Torvalds }; 2391da177e4SLinus Torvalds extern void *neigh_seq_start(struct seq_file *, loff_t *, struct neigh_table *, unsigned int); 2401da177e4SLinus Torvalds extern void *neigh_seq_next(struct seq_file *, void *, loff_t *); 2411da177e4SLinus Torvalds extern void neigh_seq_stop(struct seq_file *, void *); 2421da177e4SLinus Torvalds 2431da177e4SLinus Torvalds extern int neigh_sysctl_register(struct net_device *dev, 2441da177e4SLinus Torvalds struct neigh_parms *p, 2451da177e4SLinus Torvalds int p_id, int pdev_id, 2461da177e4SLinus Torvalds char *p_name, 2471da177e4SLinus Torvalds proc_handler *proc_handler, 2481da177e4SLinus Torvalds ctl_handler *strategy); 2491da177e4SLinus Torvalds extern void neigh_sysctl_unregister(struct neigh_parms *p); 2501da177e4SLinus Torvalds 2511da177e4SLinus Torvalds static inline void __neigh_parms_put(struct neigh_parms *parms) 2521da177e4SLinus Torvalds { 2531da177e4SLinus Torvalds atomic_dec(&parms->refcnt); 2541da177e4SLinus Torvalds } 2551da177e4SLinus Torvalds 2561da177e4SLinus Torvalds static inline void neigh_parms_put(struct neigh_parms *parms) 2571da177e4SLinus Torvalds { 2581da177e4SLinus Torvalds if (atomic_dec_and_test(&parms->refcnt)) 2591da177e4SLinus Torvalds neigh_parms_destroy(parms); 2601da177e4SLinus Torvalds } 2611da177e4SLinus Torvalds 2621da177e4SLinus Torvalds static inline struct neigh_parms *neigh_parms_clone(struct neigh_parms *parms) 2631da177e4SLinus Torvalds { 2641da177e4SLinus Torvalds atomic_inc(&parms->refcnt); 2651da177e4SLinus Torvalds return parms; 2661da177e4SLinus Torvalds } 2671da177e4SLinus Torvalds 2681da177e4SLinus Torvalds /* 2691da177e4SLinus Torvalds * Neighbour references 2701da177e4SLinus Torvalds */ 2711da177e4SLinus Torvalds 2721da177e4SLinus Torvalds static inline void neigh_release(struct neighbour *neigh) 2731da177e4SLinus Torvalds { 2741da177e4SLinus Torvalds if (atomic_dec_and_test(&neigh->refcnt)) 2751da177e4SLinus Torvalds neigh_destroy(neigh); 2761da177e4SLinus Torvalds } 2771da177e4SLinus Torvalds 2781da177e4SLinus Torvalds static inline struct neighbour * neigh_clone(struct neighbour *neigh) 2791da177e4SLinus Torvalds { 2801da177e4SLinus Torvalds if (neigh) 2811da177e4SLinus Torvalds atomic_inc(&neigh->refcnt); 2821da177e4SLinus Torvalds return neigh; 2831da177e4SLinus Torvalds } 2841da177e4SLinus Torvalds 2851da177e4SLinus Torvalds #define neigh_hold(n) atomic_inc(&(n)->refcnt) 2861da177e4SLinus Torvalds 2871da177e4SLinus Torvalds static inline void neigh_confirm(struct neighbour *neigh) 2881da177e4SLinus Torvalds { 2891da177e4SLinus Torvalds if (neigh) 2901da177e4SLinus Torvalds neigh->confirmed = jiffies; 2911da177e4SLinus Torvalds } 2921da177e4SLinus Torvalds 2931da177e4SLinus Torvalds static inline int neigh_is_connected(struct neighbour *neigh) 2941da177e4SLinus Torvalds { 2951da177e4SLinus Torvalds return neigh->nud_state&NUD_CONNECTED; 2961da177e4SLinus Torvalds } 2971da177e4SLinus Torvalds 2981da177e4SLinus Torvalds static inline int neigh_is_valid(struct neighbour *neigh) 2991da177e4SLinus Torvalds { 3001da177e4SLinus Torvalds return neigh->nud_state&NUD_VALID; 3011da177e4SLinus Torvalds } 3021da177e4SLinus Torvalds 3031da177e4SLinus Torvalds static inline int neigh_event_send(struct neighbour *neigh, struct sk_buff *skb) 3041da177e4SLinus Torvalds { 3051da177e4SLinus Torvalds neigh->used = jiffies; 3061da177e4SLinus Torvalds if (!(neigh->nud_state&(NUD_CONNECTED|NUD_DELAY|NUD_PROBE))) 3071da177e4SLinus Torvalds return __neigh_event_send(neigh, skb); 3081da177e4SLinus Torvalds return 0; 3091da177e4SLinus Torvalds } 3101da177e4SLinus Torvalds 3111da177e4SLinus Torvalds static inline struct neighbour * 3121da177e4SLinus Torvalds __neigh_lookup(struct neigh_table *tbl, const void *pkey, struct net_device *dev, int creat) 3131da177e4SLinus Torvalds { 3141da177e4SLinus Torvalds struct neighbour *n = neigh_lookup(tbl, pkey, dev); 3151da177e4SLinus Torvalds 3161da177e4SLinus Torvalds if (n || !creat) 3171da177e4SLinus Torvalds return n; 3181da177e4SLinus Torvalds 3191da177e4SLinus Torvalds n = neigh_create(tbl, pkey, dev); 3201da177e4SLinus Torvalds return IS_ERR(n) ? NULL : n; 3211da177e4SLinus Torvalds } 3221da177e4SLinus Torvalds 3231da177e4SLinus Torvalds static inline struct neighbour * 3241da177e4SLinus Torvalds __neigh_lookup_errno(struct neigh_table *tbl, const void *pkey, 3251da177e4SLinus Torvalds struct net_device *dev) 3261da177e4SLinus Torvalds { 3271da177e4SLinus Torvalds struct neighbour *n = neigh_lookup(tbl, pkey, dev); 3281da177e4SLinus Torvalds 3291da177e4SLinus Torvalds if (n) 3301da177e4SLinus Torvalds return n; 3311da177e4SLinus Torvalds 3321da177e4SLinus Torvalds return neigh_create(tbl, pkey, dev); 3331da177e4SLinus Torvalds } 3341da177e4SLinus Torvalds 335a61bbcf2SPatrick McHardy struct neighbour_cb { 336a61bbcf2SPatrick McHardy unsigned long sched_next; 337a61bbcf2SPatrick McHardy unsigned int flags; 338a61bbcf2SPatrick McHardy }; 339a61bbcf2SPatrick McHardy 340a61bbcf2SPatrick McHardy #define LOCALLY_ENQUEUED 0x1 341a61bbcf2SPatrick McHardy 342a61bbcf2SPatrick McHardy #define NEIGH_CB(skb) ((struct neighbour_cb *)(skb)->cb) 3431da177e4SLinus Torvalds 3441da177e4SLinus Torvalds #endif 345