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