xref: /linux/include/uapi/linux/neighbour.h (revision c3d6b628395fe6ec3442a83ddf02334c54867d43)
1 #ifndef __LINUX_NEIGHBOUR_H
2 #define __LINUX_NEIGHBOUR_H
3 
4 #include <linux/types.h>
5 #include <linux/netlink.h>
6 
7 struct ndmsg {
8 	__u8		ndm_family;
9 	__u8		ndm_pad1;
10 	__u16		ndm_pad2;
11 	__s32		ndm_ifindex;
12 	__u16		ndm_state;
13 	__u8		ndm_flags;
14 	__u8		ndm_type;
15 };
16 
17 enum {
18 	NDA_UNSPEC,
19 	NDA_DST,
20 	NDA_LLADDR,
21 	NDA_CACHEINFO,
22 	NDA_PROBES,
23 	NDA_VLAN,
24 	__NDA_MAX
25 };
26 
27 #define NDA_MAX (__NDA_MAX - 1)
28 
29 /*
30  *	Neighbor Cache Entry Flags
31  */
32 
33 #define NTF_USE		0x01
34 #define NTF_PROXY	0x08	/* == ATF_PUBL */
35 #define NTF_ROUTER	0x80
36 
37 #define NTF_SELF	0x02
38 #define NTF_MASTER	0x04
39 
40 /*
41  *	Neighbor Cache Entry States.
42  */
43 
44 #define NUD_INCOMPLETE	0x01
45 #define NUD_REACHABLE	0x02
46 #define NUD_STALE	0x04
47 #define NUD_DELAY	0x08
48 #define NUD_PROBE	0x10
49 #define NUD_FAILED	0x20
50 
51 /* Dummy states */
52 #define NUD_NOARP	0x40
53 #define NUD_PERMANENT	0x80
54 #define NUD_NONE	0x00
55 
56 /* NUD_NOARP & NUD_PERMANENT are pseudostates, they never change
57    and make no address resolution or NUD.
58    NUD_PERMANENT is also cannot be deleted by garbage collectors.
59  */
60 
61 struct nda_cacheinfo {
62 	__u32		ndm_confirmed;
63 	__u32		ndm_used;
64 	__u32		ndm_updated;
65 	__u32		ndm_refcnt;
66 };
67 
68 /*****************************************************************
69  *		Neighbour tables specific messages.
70  *
71  * To retrieve the neighbour tables send RTM_GETNEIGHTBL with the
72  * NLM_F_DUMP flag set. Every neighbour table configuration is
73  * spread over multiple messages to avoid running into message
74  * size limits on systems with many interfaces. The first message
75  * in the sequence transports all not device specific data such as
76  * statistics, configuration, and the default parameter set.
77  * This message is followed by 0..n messages carrying device
78  * specific parameter sets.
79  * Although the ordering should be sufficient, NDTA_NAME can be
80  * used to identify sequences. The initial message can be identified
81  * by checking for NDTA_CONFIG. The device specific messages do
82  * not contain this TLV but have NDTPA_IFINDEX set to the
83  * corresponding interface index.
84  *
85  * To change neighbour table attributes, send RTM_SETNEIGHTBL
86  * with NDTA_NAME set. Changeable attribute include NDTA_THRESH[1-3],
87  * NDTA_GC_INTERVAL, and all TLVs in NDTA_PARMS unless marked
88  * otherwise. Device specific parameter sets can be changed by
89  * setting NDTPA_IFINDEX to the interface index of the corresponding
90  * device.
91  ****/
92 
93 struct ndt_stats {
94 	__u64		ndts_allocs;
95 	__u64		ndts_destroys;
96 	__u64		ndts_hash_grows;
97 	__u64		ndts_res_failed;
98 	__u64		ndts_lookups;
99 	__u64		ndts_hits;
100 	__u64		ndts_rcv_probes_mcast;
101 	__u64		ndts_rcv_probes_ucast;
102 	__u64		ndts_periodic_gc_runs;
103 	__u64		ndts_forced_gc_runs;
104 };
105 
106 enum {
107 	NDTPA_UNSPEC,
108 	NDTPA_IFINDEX,			/* u32, unchangeable */
109 	NDTPA_REFCNT,			/* u32, read-only */
110 	NDTPA_REACHABLE_TIME,		/* u64, read-only, msecs */
111 	NDTPA_BASE_REACHABLE_TIME,	/* u64, msecs */
112 	NDTPA_RETRANS_TIME,		/* u64, msecs */
113 	NDTPA_GC_STALETIME,		/* u64, msecs */
114 	NDTPA_DELAY_PROBE_TIME,		/* u64, msecs */
115 	NDTPA_QUEUE_LEN,		/* u32 */
116 	NDTPA_APP_PROBES,		/* u32 */
117 	NDTPA_UCAST_PROBES,		/* u32 */
118 	NDTPA_MCAST_PROBES,		/* u32 */
119 	NDTPA_ANYCAST_DELAY,		/* u64, msecs */
120 	NDTPA_PROXY_DELAY,		/* u64, msecs */
121 	NDTPA_PROXY_QLEN,		/* u32 */
122 	NDTPA_LOCKTIME,			/* u64, msecs */
123 	NDTPA_QUEUE_LENBYTES,		/* u32 */
124 	__NDTPA_MAX
125 };
126 #define NDTPA_MAX (__NDTPA_MAX - 1)
127 
128 struct ndtmsg {
129 	__u8		ndtm_family;
130 	__u8		ndtm_pad1;
131 	__u16		ndtm_pad2;
132 };
133 
134 struct ndt_config {
135 	__u16		ndtc_key_len;
136 	__u16		ndtc_entry_size;
137 	__u32		ndtc_entries;
138 	__u32		ndtc_last_flush;	/* delta to now in msecs */
139 	__u32		ndtc_last_rand;		/* delta to now in msecs */
140 	__u32		ndtc_hash_rnd;
141 	__u32		ndtc_hash_mask;
142 	__u32		ndtc_hash_chain_gc;
143 	__u32		ndtc_proxy_qlen;
144 };
145 
146 enum {
147 	NDTA_UNSPEC,
148 	NDTA_NAME,			/* char *, unchangeable */
149 	NDTA_THRESH1,			/* u32 */
150 	NDTA_THRESH2,			/* u32 */
151 	NDTA_THRESH3,			/* u32 */
152 	NDTA_CONFIG,			/* struct ndt_config, read-only */
153 	NDTA_PARMS,			/* nested TLV NDTPA_* */
154 	NDTA_STATS,			/* struct ndt_stats, read-only */
155 	NDTA_GC_INTERVAL,		/* u64, msecs */
156 	__NDTA_MAX
157 };
158 #define NDTA_MAX (__NDTA_MAX - 1)
159 
160 #endif
161