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