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

#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_MAX
};

#define NDA_MAX (__NDA_MAX - 1)

/*
 *	Neighbor Cache Entry Flags
 */

#define NTF_USE		0x01
#define NTF_PROXY	0x08	/* == ATF_PUBL */
#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 is 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;
};

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_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_MAX
};
#define NDTA_MAX (__NDTA_MAX - 1)

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