[mirror_iproute2.git] / include / uapi / linux / neighbour.h

/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
#ifndef __LINUX_NEIGHBOUR_H
#define __LINUX_NEIGHBOUR_H

#include <linux/types.h>
#include <linux/netlink.h>

struct ndmsg {
	__u8		ndm_family;
	__u8		ndm_pad1;
	__u16		ndm_pad2;
	__s32		ndm_ifindex;
	__u16		ndm_state;
	__u8		ndm_flags;
	__u8		ndm_type;
};

enum {
	NDA_UNSPEC,
	NDA_DST,
	NDA_LLADDR,
	NDA_CACHEINFO,
	NDA_PROBES,
	NDA_VLAN,
	NDA_PORT,
	NDA_VNI,
	NDA_IFINDEX,
	NDA_MASTER,
	NDA_LINK_NETNSID,
	NDA_SRC_VNI,
	NDA_PROTOCOL,  /* Originator of entry */
	NDA_NH_ID,
	NDA_FDB_EXT_ATTRS,
	__NDA_MAX
};

#define NDA_MAX (__NDA_MAX - 1)

/*
 *	Neighbor Cache Entry Flags
 */

#define NTF_USE		0x01
#define NTF_SELF	0x02
#define NTF_MASTER	0x04
#define NTF_PROXY	0x08	/* == ATF_PUBL */
#define NTF_EXT_LEARNED	0x10
#define NTF_OFFLOADED   0x20
#define NTF_STICKY	0x40
#define NTF_ROUTER	0x80

/*
 *	Neighbor Cache Entry States.
 */

#define NUD_INCOMPLETE	0x01
#define NUD_REACHABLE	0x02
#define NUD_STALE	0x04
#define NUD_DELAY	0x08
#define NUD_PROBE	0x10
#define NUD_FAILED	0x20

/* Dummy states */
#define NUD_NOARP	0x40
#define NUD_PERMANENT	0x80
#define NUD_NONE	0x00

/* NUD_NOARP & NUD_PERMANENT are pseudostates, they never change
   and make no address resolution or NUD.
   NUD_PERMANENT also cannot be deleted by garbage collectors.
 */

struct nda_cacheinfo {
	__u32		ndm_confirmed;
	__u32		ndm_used;
	__u32		ndm_updated;
	__u32		ndm_refcnt;
};

/*****************************************************************
 *		Neighbour tables specific messages.
 *
 * To retrieve the neighbour tables send RTM_GETNEIGHTBL with the
 * NLM_F_DUMP flag set. Every neighbour table configuration is
 * spread over multiple messages to avoid running into message
 * size limits on systems with many interfaces. The first message
 * in the sequence transports all not device specific data such as
 * statistics, configuration, and the default parameter set.
 * This message is followed by 0..n messages carrying device
 * specific parameter sets.
 * Although the ordering should be sufficient, NDTA_NAME can be
 * used to identify sequences. The initial message can be identified
 * by checking for NDTA_CONFIG. The device specific messages do
 * not contain this TLV but have NDTPA_IFINDEX set to the
 * corresponding interface index.
 *
 * To change neighbour table attributes, send RTM_SETNEIGHTBL
 * with NDTA_NAME set. Changeable attribute include NDTA_THRESH[1-3],
 * NDTA_GC_INTERVAL, and all TLVs in NDTA_PARMS unless marked
 * otherwise. Device specific parameter sets can be changed by
 * setting NDTPA_IFINDEX to the interface index of the corresponding
 * device.
 ****/

struct ndt_stats {
	__u64		ndts_allocs;
	__u64		ndts_destroys;
	__u64		ndts_hash_grows;
	__u64		ndts_res_failed;
	__u64		ndts_lookups;
	__u64		ndts_hits;
	__u64		ndts_rcv_probes_mcast;
	__u64		ndts_rcv_probes_ucast;
	__u64		ndts_periodic_gc_runs;
	__u64		ndts_forced_gc_runs;
	__u64		ndts_table_fulls;
};

enum {
	NDTPA_UNSPEC,
	NDTPA_IFINDEX,			/* u32, unchangeable */
	NDTPA_REFCNT,			/* u32, read-only */
	NDTPA_REACHABLE_TIME,		/* u64, read-only, msecs */
	NDTPA_BASE_REACHABLE_TIME,	/* u64, msecs */
	NDTPA_RETRANS_TIME,		/* u64, msecs */
	NDTPA_GC_STALETIME,		/* u64, msecs */
	NDTPA_DELAY_PROBE_TIME,		/* u64, msecs */
	NDTPA_QUEUE_LEN,		/* u32 */
	NDTPA_APP_PROBES,		/* u32 */
	NDTPA_UCAST_PROBES,		/* u32 */
	NDTPA_MCAST_PROBES,		/* u32 */
	NDTPA_ANYCAST_DELAY,		/* u64, msecs */
	NDTPA_PROXY_DELAY,		/* u64, msecs */
	NDTPA_PROXY_QLEN,		/* u32 */
	NDTPA_LOCKTIME,			/* u64, msecs */
	NDTPA_QUEUE_LENBYTES,		/* u32 */
	NDTPA_MCAST_REPROBES,		/* u32 */
	NDTPA_PAD,
	__NDTPA_MAX
};
#define NDTPA_MAX (__NDTPA_MAX - 1)

struct ndtmsg {
	__u8		ndtm_family;
	__u8		ndtm_pad1;
	__u16		ndtm_pad2;
};

struct ndt_config {
	__u16		ndtc_key_len;
	__u16		ndtc_entry_size;
	__u32		ndtc_entries;
	__u32		ndtc_last_flush;	/* delta to now in msecs */
	__u32		ndtc_last_rand;		/* delta to now in msecs */
	__u32		ndtc_hash_rnd;
	__u32		ndtc_hash_mask;
	__u32		ndtc_hash_chain_gc;
	__u32		ndtc_proxy_qlen;
};

enum {
	NDTA_UNSPEC,
	NDTA_NAME,			/* char *, unchangeable */
	NDTA_THRESH1,			/* u32 */
	NDTA_THRESH2,			/* u32 */
	NDTA_THRESH3,			/* u32 */
	NDTA_CONFIG,			/* struct ndt_config, read-only */
	NDTA_PARMS,			/* nested TLV NDTPA_* */
	NDTA_STATS,			/* struct ndt_stats, read-only */
	NDTA_GC_INTERVAL,		/* u64, msecs */
	NDTA_PAD,
	__NDTA_MAX
};
#define NDTA_MAX (__NDTA_MAX - 1)

 /* FDB activity notification bits used in NFEA_ACTIVITY_NOTIFY:
  * - FDB_NOTIFY_BIT - notify on activity/expire for any entry
  * - FDB_NOTIFY_INACTIVE_BIT - mark as inactive to avoid multiple notifications
  */
enum {
	FDB_NOTIFY_BIT		= (1 << 0),
	FDB_NOTIFY_INACTIVE_BIT	= (1 << 1)
};

/* embedded into NDA_FDB_EXT_ATTRS:
 * [NDA_FDB_EXT_ATTRS] = {
 *     [NFEA_ACTIVITY_NOTIFY]
 *     ...
 * }
 */
enum {
	NFEA_UNSPEC,
	NFEA_ACTIVITY_NOTIFY,
	NFEA_DONT_REFRESH,
	__NFEA_MAX
};
#define NFEA_MAX (__NFEA_MAX - 1)

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