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