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