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