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_NH_ID,
  33         NDA_FDB_EXT_ATTRS,
  34         NDA_FLAGS_EXT,
  35         NDA_NDM_STATE_MASK,
  36         NDA_NDM_FLAGS_MASK,
  37         __NDA_MAX
  38 };
  39
  40 #define NDA_MAX (__NDA_MAX - 1)
  41
  42 /*
  43  *      Neighbor Cache Entry Flags
  44  */
  45
  46 #define NTF_USE         (1 << 0)
  47 #define NTF_SELF        (1 << 1)
  48 #define NTF_MASTER      (1 << 2)
  49 #define NTF_PROXY       (1 << 3)        /* == ATF_PUBL */
  50 #define NTF_EXT_LEARNED (1 << 4)
  51 #define NTF_OFFLOADED   (1 << 5)
  52 #define NTF_STICKY      (1 << 6)
  53 #define NTF_ROUTER      (1 << 7)
  54 /* Extended flags under NDA_FLAGS_EXT: */
  55 #define NTF_EXT_MANAGED (1 << 0)
  56
  57 /*
  58  *      Neighbor Cache Entry States.
  59  */
  60
  61 #define NUD_INCOMPLETE  0x01
  62 #define NUD_REACHABLE   0x02
  63 #define NUD_STALE       0x04
  64 #define NUD_DELAY       0x08
  65 #define NUD_PROBE       0x10
  66 #define NUD_FAILED      0x20
  67
  68 /* Dummy states */
  69 #define NUD_NOARP       0x40
  70 #define NUD_PERMANENT   0x80
  71 #define NUD_NONE        0x00
  72
  73 /* NUD_NOARP & NUD_PERMANENT are pseudostates, they never change and make no
  74  * address resolution or NUD.
  75  *
  76  * NUD_PERMANENT also cannot be deleted by garbage collectors. This holds true
  77  * for dynamic entries with NTF_EXT_LEARNED flag as well. However, upon carrier
  78  * down event, NUD_PERMANENT entries are not flushed whereas NTF_EXT_LEARNED
  79  * flagged entries explicitly are (which is also consistent with the routing
  80  * subsystem).
  81  *
  82  * When NTF_EXT_LEARNED is set for a bridge fdb entry the different cache entry
  83  * states don't make sense and thus are ignored. Such entries don't age and
  84  * can roam.
  85  *
  86  * NTF_EXT_MANAGED flagged neigbor entries are managed by the kernel on behalf
  87  * of a user space control plane, and automatically refreshed so that (if
  88  * possible) they remain in NUD_REACHABLE state.
  89  */
  90
  91 struct nda_cacheinfo {
  92         __u32           ndm_confirmed;
  93         __u32           ndm_used;
  94         __u32           ndm_updated;
  95         __u32           ndm_refcnt;
  96 };
  97
  98 /*****************************************************************
  99  *              Neighbour tables specific messages.
 100  *
 101  * To retrieve the neighbour tables send RTM_GETNEIGHTBL with the
 102  * NLM_F_DUMP flag set. Every neighbour table configuration is
 103  * spread over multiple messages to avoid running into message
 104  * size limits on systems with many interfaces. The first message
 105  * in the sequence transports all not device specific data such as
 106  * statistics, configuration, and the default parameter set.
 107  * This message is followed by 0..n messages carrying device
 108  * specific parameter sets.
 109  * Although the ordering should be sufficient, NDTA_NAME can be
 110  * used to identify sequences. The initial message can be identified
 111  * by checking for NDTA_CONFIG. The device specific messages do
 112  * not contain this TLV but have NDTPA_IFINDEX set to the
 113  * corresponding interface index.
 114  *
 115  * To change neighbour table attributes, send RTM_SETNEIGHTBL
 116  * with NDTA_NAME set. Changeable attribute include NDTA_THRESH[1-3],
 117  * NDTA_GC_INTERVAL, and all TLVs in NDTA_PARMS unless marked
 118  * otherwise. Device specific parameter sets can be changed by
 119  * setting NDTPA_IFINDEX to the interface index of the corresponding
 120  * device.
 121  ****/
 122
 123 struct ndt_stats {
 124         __u64           ndts_allocs;
 125         __u64           ndts_destroys;
 126         __u64           ndts_hash_grows;
 127         __u64           ndts_res_failed;
 128         __u64           ndts_lookups;
 129         __u64           ndts_hits;
 130         __u64           ndts_rcv_probes_mcast;
 131         __u64           ndts_rcv_probes_ucast;
 132         __u64           ndts_periodic_gc_runs;
 133         __u64           ndts_forced_gc_runs;
 134         __u64           ndts_table_fulls;
 135 };
 136
 137 enum {
 138         NDTPA_UNSPEC,
 139         NDTPA_IFINDEX,                  /* u32, unchangeable */
 140         NDTPA_REFCNT,                   /* u32, read-only */
 141         NDTPA_REACHABLE_TIME,           /* u64, read-only, msecs */
 142         NDTPA_BASE_REACHABLE_TIME,      /* u64, msecs */
 143         NDTPA_RETRANS_TIME,             /* u64, msecs */
 144         NDTPA_GC_STALETIME,             /* u64, msecs */
 145         NDTPA_DELAY_PROBE_TIME,         /* u64, msecs */
 146         NDTPA_QUEUE_LEN,                /* u32 */
 147         NDTPA_APP_PROBES,               /* u32 */
 148         NDTPA_UCAST_PROBES,             /* u32 */
 149         NDTPA_MCAST_PROBES,             /* u32 */
 150         NDTPA_ANYCAST_DELAY,            /* u64, msecs */
 151         NDTPA_PROXY_DELAY,              /* u64, msecs */
 152         NDTPA_PROXY_QLEN,               /* u32 */
 153         NDTPA_LOCKTIME,                 /* u64, msecs */
 154         NDTPA_QUEUE_LENBYTES,           /* u32 */
 155         NDTPA_MCAST_REPROBES,           /* u32 */
 156         NDTPA_PAD,
 157         NDTPA_INTERVAL_PROBE_TIME_MS,   /* u64, msecs */
 158         __NDTPA_MAX
 159 };
 160 #define NDTPA_MAX (__NDTPA_MAX - 1)
 161
 162 struct ndtmsg {
 163         __u8            ndtm_family;
 164         __u8            ndtm_pad1;
 165         __u16           ndtm_pad2;
 166 };
 167
 168 struct ndt_config {
 169         __u16           ndtc_key_len;
 170         __u16           ndtc_entry_size;
 171         __u32           ndtc_entries;
 172         __u32           ndtc_last_flush;        /* delta to now in msecs */
 173         __u32           ndtc_last_rand;         /* delta to now in msecs */
 174         __u32           ndtc_hash_rnd;
 175         __u32           ndtc_hash_mask;
 176         __u32           ndtc_hash_chain_gc;
 177         __u32           ndtc_proxy_qlen;
 178 };
 179
 180 enum {
 181         NDTA_UNSPEC,
 182         NDTA_NAME,                      /* char *, unchangeable */
 183         NDTA_THRESH1,                   /* u32 */
 184         NDTA_THRESH2,                   /* u32 */
 185         NDTA_THRESH3,                   /* u32 */
 186         NDTA_CONFIG,                    /* struct ndt_config, read-only */
 187         NDTA_PARMS,                     /* nested TLV NDTPA_* */
 188         NDTA_STATS,                     /* struct ndt_stats, read-only */
 189         NDTA_GC_INTERVAL,               /* u64, msecs */
 190         NDTA_PAD,
 191         __NDTA_MAX
 192 };
 193 #define NDTA_MAX (__NDTA_MAX - 1)
 194
 195  /* FDB activity notification bits used in NFEA_ACTIVITY_NOTIFY:
 196   * - FDB_NOTIFY_BIT - notify on activity/expire for any entry
 197   * - FDB_NOTIFY_INACTIVE_BIT - mark as inactive to avoid multiple notifications
 198   */
 199 enum {
 200         FDB_NOTIFY_BIT          = (1 << 0),
 201         FDB_NOTIFY_INACTIVE_BIT = (1 << 1)
 202 };
 203
 204 /* embedded into NDA_FDB_EXT_ATTRS:
 205  * [NDA_FDB_EXT_ATTRS] = {
 206  *     [NFEA_ACTIVITY_NOTIFY]
 207  *     ...
 208  * }
 209  */
 210 enum {
 211         NFEA_UNSPEC,
 212         NFEA_ACTIVITY_NOTIFY,
 213         NFEA_DONT_REFRESH,
 214         __NFEA_MAX
 215 };
 216 #define NFEA_MAX (__NFEA_MAX - 1)
 217
 218 #endif