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