rtnetlink.h revision dfd26e1c4c6a1cae65adb4ca473efb32d6d9297b
1#ifndef __LINUX_RTNETLINK_H
2#define __LINUX_RTNETLINK_H
3
4#include <linux/netlink.h>
5#include <linux/if_link.h>
6#include <linux/if_addr.h>
7#include <linux/neighbour.h>
8
9/****
10 *		Routing/neighbour discovery messages.
11 ****/
12
13/* Types of messages */
14
15enum {
16	RTM_BASE	= 16,
17#define RTM_BASE	RTM_BASE
18
19	RTM_NEWLINK	= 16,
20#define RTM_NEWLINK	RTM_NEWLINK
21	RTM_DELLINK,
22#define RTM_DELLINK	RTM_DELLINK
23	RTM_GETLINK,
24#define RTM_GETLINK	RTM_GETLINK
25	RTM_SETLINK,
26#define RTM_SETLINK	RTM_SETLINK
27
28	RTM_NEWADDR	= 20,
29#define RTM_NEWADDR	RTM_NEWADDR
30	RTM_DELADDR,
31#define RTM_DELADDR	RTM_DELADDR
32	RTM_GETADDR,
33#define RTM_GETADDR	RTM_GETADDR
34
35	RTM_NEWROUTE	= 24,
36#define RTM_NEWROUTE	RTM_NEWROUTE
37	RTM_DELROUTE,
38#define RTM_DELROUTE	RTM_DELROUTE
39	RTM_GETROUTE,
40#define RTM_GETROUTE	RTM_GETROUTE
41
42	RTM_NEWNEIGH	= 28,
43#define RTM_NEWNEIGH	RTM_NEWNEIGH
44	RTM_DELNEIGH,
45#define RTM_DELNEIGH	RTM_DELNEIGH
46	RTM_GETNEIGH,
47#define RTM_GETNEIGH	RTM_GETNEIGH
48
49	RTM_NEWRULE	= 32,
50#define RTM_NEWRULE	RTM_NEWRULE
51	RTM_DELRULE,
52#define RTM_DELRULE	RTM_DELRULE
53	RTM_GETRULE,
54#define RTM_GETRULE	RTM_GETRULE
55
56	RTM_NEWQDISC	= 36,
57#define RTM_NEWQDISC	RTM_NEWQDISC
58	RTM_DELQDISC,
59#define RTM_DELQDISC	RTM_DELQDISC
60	RTM_GETQDISC,
61#define RTM_GETQDISC	RTM_GETQDISC
62
63	RTM_NEWTCLASS	= 40,
64#define RTM_NEWTCLASS	RTM_NEWTCLASS
65	RTM_DELTCLASS,
66#define RTM_DELTCLASS	RTM_DELTCLASS
67	RTM_GETTCLASS,
68#define RTM_GETTCLASS	RTM_GETTCLASS
69
70	RTM_NEWTFILTER	= 44,
71#define RTM_NEWTFILTER	RTM_NEWTFILTER
72	RTM_DELTFILTER,
73#define RTM_DELTFILTER	RTM_DELTFILTER
74	RTM_GETTFILTER,
75#define RTM_GETTFILTER	RTM_GETTFILTER
76
77	RTM_NEWACTION	= 48,
78#define RTM_NEWACTION   RTM_NEWACTION
79	RTM_DELACTION,
80#define RTM_DELACTION   RTM_DELACTION
81	RTM_GETACTION,
82#define RTM_GETACTION   RTM_GETACTION
83
84	RTM_NEWPREFIX	= 52,
85#define RTM_NEWPREFIX	RTM_NEWPREFIX
86
87	RTM_GETMULTICAST = 58,
88#define RTM_GETMULTICAST RTM_GETMULTICAST
89
90	RTM_GETANYCAST	= 62,
91#define RTM_GETANYCAST	RTM_GETANYCAST
92
93	RTM_NEWNEIGHTBL	= 64,
94#define RTM_NEWNEIGHTBL	RTM_NEWNEIGHTBL
95	RTM_GETNEIGHTBL	= 66,
96#define RTM_GETNEIGHTBL	RTM_GETNEIGHTBL
97	RTM_SETNEIGHTBL,
98#define RTM_SETNEIGHTBL	RTM_SETNEIGHTBL
99
100	__RTM_MAX,
101#define RTM_MAX		(((__RTM_MAX + 3) & ~3) - 1)
102};
103
104#define RTM_NR_MSGTYPES	(RTM_MAX + 1 - RTM_BASE)
105#define RTM_NR_FAMILIES	(RTM_NR_MSGTYPES >> 2)
106#define RTM_FAM(cmd)	(((cmd) - RTM_BASE) >> 2)
107
108/*
109   Generic structure for encapsulation of optional route information.
110   It is reminiscent of sockaddr, but with sa_family replaced
111   with attribute type.
112 */
113
114struct rtattr
115{
116	unsigned short	rta_len;
117	unsigned short	rta_type;
118};
119
120/* Macros to handle rtattributes */
121
122#define RTA_ALIGNTO	4
123#define RTA_ALIGN(len) ( ((len)+RTA_ALIGNTO-1) & ~(RTA_ALIGNTO-1) )
124#define RTA_OK(rta,len) ((len) >= (int)sizeof(struct rtattr) && \
125			 (rta)->rta_len >= sizeof(struct rtattr) && \
126			 (rta)->rta_len <= (len))
127#define RTA_NEXT(rta,attrlen)	((attrlen) -= RTA_ALIGN((rta)->rta_len), \
128				 (struct rtattr*)(((char*)(rta)) + RTA_ALIGN((rta)->rta_len)))
129#define RTA_LENGTH(len)	(RTA_ALIGN(sizeof(struct rtattr)) + (len))
130#define RTA_SPACE(len)	RTA_ALIGN(RTA_LENGTH(len))
131#define RTA_DATA(rta)   ((void*)(((char*)(rta)) + RTA_LENGTH(0)))
132#define RTA_PAYLOAD(rta) ((int)((rta)->rta_len) - RTA_LENGTH(0))
133
134
135
136
137/******************************************************************************
138 *		Definitions used in routing table administration.
139 ****/
140
141struct rtmsg
142{
143	unsigned char		rtm_family;
144	unsigned char		rtm_dst_len;
145	unsigned char		rtm_src_len;
146	unsigned char		rtm_tos;
147
148	unsigned char		rtm_table;	/* Routing table id */
149	unsigned char		rtm_protocol;	/* Routing protocol; see below	*/
150	unsigned char		rtm_scope;	/* See below */
151	unsigned char		rtm_type;	/* See below	*/
152
153	unsigned		rtm_flags;
154};
155
156/* rtm_type */
157
158enum
159{
160	RTN_UNSPEC,
161	RTN_UNICAST,		/* Gateway or direct route	*/
162	RTN_LOCAL,		/* Accept locally		*/
163	RTN_BROADCAST,		/* Accept locally as broadcast,
164				   send as broadcast */
165	RTN_ANYCAST,		/* Accept locally as broadcast,
166				   but send as unicast */
167	RTN_MULTICAST,		/* Multicast route		*/
168	RTN_BLACKHOLE,		/* Drop				*/
169	RTN_UNREACHABLE,	/* Destination is unreachable   */
170	RTN_PROHIBIT,		/* Administratively prohibited	*/
171	RTN_THROW,		/* Not in this table		*/
172	RTN_NAT,		/* Translate this address	*/
173	RTN_XRESOLVE,		/* Use external resolver	*/
174	__RTN_MAX
175};
176
177#define RTN_MAX (__RTN_MAX - 1)
178
179
180/* rtm_protocol */
181
182#define RTPROT_UNSPEC	0
183#define RTPROT_REDIRECT	1	/* Route installed by ICMP redirects;
184				   not used by current IPv4 */
185#define RTPROT_KERNEL	2	/* Route installed by kernel		*/
186#define RTPROT_BOOT	3	/* Route installed during boot		*/
187#define RTPROT_STATIC	4	/* Route installed by administrator	*/
188
189/* Values of protocol >= RTPROT_STATIC are not interpreted by kernel;
190   they are just passed from user and back as is.
191   It will be used by hypothetical multiple routing daemons.
192   Note that protocol values should be standardized in order to
193   avoid conflicts.
194 */
195
196#define RTPROT_GATED	8	/* Apparently, GateD */
197#define RTPROT_RA	9	/* RDISC/ND router advertisements */
198#define RTPROT_MRT	10	/* Merit MRT */
199#define RTPROT_ZEBRA	11	/* Zebra */
200#define RTPROT_BIRD	12	/* BIRD */
201#define RTPROT_DNROUTED	13	/* DECnet routing daemon */
202#define RTPROT_XORP	14	/* XORP */
203#define RTPROT_NTK	15	/* Netsukuku */
204
205/* rtm_scope
206
207   Really it is not scope, but sort of distance to the destination.
208   NOWHERE are reserved for not existing destinations, HOST is our
209   local addresses, LINK are destinations, located on directly attached
210   link and UNIVERSE is everywhere in the Universe.
211
212   Intermediate values are also possible f.e. interior routes
213   could be assigned a value between UNIVERSE and LINK.
214*/
215
216enum rt_scope_t
217{
218	RT_SCOPE_UNIVERSE=0,
219/* User defined values  */
220	RT_SCOPE_SITE=200,
221	RT_SCOPE_LINK=253,
222	RT_SCOPE_HOST=254,
223	RT_SCOPE_NOWHERE=255
224};
225
226/* rtm_flags */
227
228#define RTM_F_NOTIFY		0x100	/* Notify user of route change	*/
229#define RTM_F_CLONED		0x200	/* This route is cloned		*/
230#define RTM_F_EQUALIZE		0x400	/* Multipath equalizer: NI	*/
231#define RTM_F_PREFIX		0x800	/* Prefix addresses		*/
232
233/* Reserved table identifiers */
234
235enum rt_class_t
236{
237	RT_TABLE_UNSPEC=0,
238/* User defined values */
239	RT_TABLE_DEFAULT=253,
240	RT_TABLE_MAIN=254,
241	RT_TABLE_LOCAL=255,
242	RT_TABLE_MAX=0xFFFFFFFF
243};
244
245
246/* Routing message attributes */
247
248enum rtattr_type_t
249{
250	RTA_UNSPEC,
251	RTA_DST,
252	RTA_SRC,
253	RTA_IIF,
254	RTA_OIF,
255	RTA_GATEWAY,
256	RTA_PRIORITY,
257	RTA_PREFSRC,
258	RTA_METRICS,
259	RTA_MULTIPATH,
260	RTA_PROTOINFO,
261	RTA_FLOW,
262	RTA_CACHEINFO,
263	RTA_SESSION,
264	RTA_MP_ALGO, /* no longer used */
265	RTA_TABLE,
266	__RTA_MAX
267};
268
269#define RTA_MAX (__RTA_MAX - 1)
270
271#define RTM_RTA(r)  ((struct rtattr*)(((char*)(r)) + NLMSG_ALIGN(sizeof(struct rtmsg))))
272#define RTM_PAYLOAD(n) NLMSG_PAYLOAD(n,sizeof(struct rtmsg))
273
274/* RTM_MULTIPATH --- array of struct rtnexthop.
275 *
276 * "struct rtnexthop" describes all necessary nexthop information,
277 * i.e. parameters of path to a destination via this nexthop.
278 *
279 * At the moment it is impossible to set different prefsrc, mtu, window
280 * and rtt for different paths from multipath.
281 */
282
283struct rtnexthop
284{
285	unsigned short		rtnh_len;
286	unsigned char		rtnh_flags;
287	unsigned char		rtnh_hops;
288	int			rtnh_ifindex;
289};
290
291/* rtnh_flags */
292
293#define RTNH_F_DEAD		1	/* Nexthop is dead (used by multipath)	*/
294#define RTNH_F_PERVASIVE	2	/* Do recursive gateway lookup	*/
295#define RTNH_F_ONLINK		4	/* Gateway is forced on link	*/
296
297/* Macros to handle hexthops */
298
299#define RTNH_ALIGNTO	4
300#define RTNH_ALIGN(len) ( ((len)+RTNH_ALIGNTO-1) & ~(RTNH_ALIGNTO-1) )
301#define RTNH_OK(rtnh,len) ((rtnh)->rtnh_len >= sizeof(struct rtnexthop) && \
302			   ((int)(rtnh)->rtnh_len) <= (len))
303#define RTNH_NEXT(rtnh)	((struct rtnexthop*)(((char*)(rtnh)) + RTNH_ALIGN((rtnh)->rtnh_len)))
304#define RTNH_LENGTH(len) (RTNH_ALIGN(sizeof(struct rtnexthop)) + (len))
305#define RTNH_SPACE(len)	RTNH_ALIGN(RTNH_LENGTH(len))
306#define RTNH_DATA(rtnh)   ((struct rtattr*)(((char*)(rtnh)) + RTNH_LENGTH(0)))
307
308/* RTM_CACHEINFO */
309
310struct rta_cacheinfo
311{
312	__u32	rta_clntref;
313	__u32	rta_lastuse;
314	__s32	rta_expires;
315	__u32	rta_error;
316	__u32	rta_used;
317
318#define RTNETLINK_HAVE_PEERINFO 1
319	__u32	rta_id;
320	__u32	rta_ts;
321	__u32	rta_tsage;
322};
323
324/* RTM_METRICS --- array of struct rtattr with types of RTAX_* */
325
326enum
327{
328	RTAX_UNSPEC,
329#define RTAX_UNSPEC RTAX_UNSPEC
330	RTAX_LOCK,
331#define RTAX_LOCK RTAX_LOCK
332	RTAX_MTU,
333#define RTAX_MTU RTAX_MTU
334	RTAX_WINDOW,
335#define RTAX_WINDOW RTAX_WINDOW
336	RTAX_RTT,
337#define RTAX_RTT RTAX_RTT
338	RTAX_RTTVAR,
339#define RTAX_RTTVAR RTAX_RTTVAR
340	RTAX_SSTHRESH,
341#define RTAX_SSTHRESH RTAX_SSTHRESH
342	RTAX_CWND,
343#define RTAX_CWND RTAX_CWND
344	RTAX_ADVMSS,
345#define RTAX_ADVMSS RTAX_ADVMSS
346	RTAX_REORDERING,
347#define RTAX_REORDERING RTAX_REORDERING
348	RTAX_HOPLIMIT,
349#define RTAX_HOPLIMIT RTAX_HOPLIMIT
350	RTAX_INITCWND,
351#define RTAX_INITCWND RTAX_INITCWND
352	RTAX_FEATURES,
353#define RTAX_FEATURES RTAX_FEATURES
354	RTAX_RTO_MIN,
355#define RTAX_RTO_MIN RTAX_RTO_MIN
356	__RTAX_MAX
357};
358
359#define RTAX_MAX (__RTAX_MAX - 1)
360
361#define RTAX_FEATURE_ECN	0x00000001
362#define RTAX_FEATURE_SACK	0x00000002
363#define RTAX_FEATURE_TIMESTAMP	0x00000004
364#define RTAX_FEATURE_ALLFRAG	0x00000008
365
366struct rta_session
367{
368	__u8	proto;
369	__u8	pad1;
370	__u16	pad2;
371
372	union {
373		struct {
374			__u16	sport;
375			__u16	dport;
376		} ports;
377
378		struct {
379			__u8	type;
380			__u8	code;
381			__u16	ident;
382		} icmpt;
383
384		__u32		spi;
385	} u;
386};
387
388/****
389 *		General form of address family dependent message.
390 ****/
391
392struct rtgenmsg
393{
394	unsigned char		rtgen_family;
395};
396
397/*****************************************************************
398 *		Link layer specific messages.
399 ****/
400
401/* struct ifinfomsg
402 * passes link level specific information, not dependent
403 * on network protocol.
404 */
405
406struct ifinfomsg
407{
408	unsigned char	ifi_family;
409	unsigned char	__ifi_pad;
410	unsigned short	ifi_type;		/* ARPHRD_* */
411	int		ifi_index;		/* Link index	*/
412	unsigned	ifi_flags;		/* IFF_* flags	*/
413	unsigned	ifi_change;		/* IFF_* change mask */
414};
415
416/********************************************************************
417 *		prefix information
418 ****/
419
420struct prefixmsg
421{
422	unsigned char	prefix_family;
423	unsigned char	prefix_pad1;
424	unsigned short	prefix_pad2;
425	int		prefix_ifindex;
426	unsigned char	prefix_type;
427	unsigned char	prefix_len;
428	unsigned char	prefix_flags;
429	unsigned char	prefix_pad3;
430};
431
432enum
433{
434	PREFIX_UNSPEC,
435	PREFIX_ADDRESS,
436	PREFIX_CACHEINFO,
437	__PREFIX_MAX
438};
439
440#define PREFIX_MAX	(__PREFIX_MAX - 1)
441
442struct prefix_cacheinfo
443{
444	__u32	preferred_time;
445	__u32	valid_time;
446};
447
448
449/*****************************************************************
450 *		Traffic control messages.
451 ****/
452
453struct tcmsg
454{
455	unsigned char	tcm_family;
456	unsigned char	tcm__pad1;
457	unsigned short	tcm__pad2;
458	int		tcm_ifindex;
459	__u32		tcm_handle;
460	__u32		tcm_parent;
461	__u32		tcm_info;
462};
463
464enum
465{
466	TCA_UNSPEC,
467	TCA_KIND,
468	TCA_OPTIONS,
469	TCA_STATS,
470	TCA_XSTATS,
471	TCA_RATE,
472	TCA_FCNT,
473	TCA_STATS2,
474	__TCA_MAX
475};
476
477#define TCA_MAX (__TCA_MAX - 1)
478
479#define TCA_RTA(r)  ((struct rtattr*)(((char*)(r)) + NLMSG_ALIGN(sizeof(struct tcmsg))))
480#define TCA_PAYLOAD(n) NLMSG_PAYLOAD(n,sizeof(struct tcmsg))
481
482/* RTnetlink multicast groups - backwards compatibility for userspace */
483#define RTMGRP_LINK		1
484#define RTMGRP_NOTIFY		2
485#define RTMGRP_NEIGH		4
486#define RTMGRP_TC		8
487
488#define RTMGRP_IPV4_IFADDR	0x10
489#define RTMGRP_IPV4_MROUTE	0x20
490#define RTMGRP_IPV4_ROUTE	0x40
491#define RTMGRP_IPV4_RULE	0x80
492
493#define RTMGRP_IPV6_IFADDR	0x100
494#define RTMGRP_IPV6_MROUTE	0x200
495#define RTMGRP_IPV6_ROUTE	0x400
496#define RTMGRP_IPV6_IFINFO	0x800
497
498#define RTMGRP_DECnet_IFADDR    0x1000
499#define RTMGRP_DECnet_ROUTE     0x4000
500
501#define RTMGRP_IPV6_PREFIX	0x20000
502
503/* RTnetlink multicast groups */
504enum rtnetlink_groups {
505	RTNLGRP_NONE,
506#define RTNLGRP_NONE		RTNLGRP_NONE
507	RTNLGRP_LINK,
508#define RTNLGRP_LINK		RTNLGRP_LINK
509	RTNLGRP_NOTIFY,
510#define RTNLGRP_NOTIFY		RTNLGRP_NOTIFY
511	RTNLGRP_NEIGH,
512#define RTNLGRP_NEIGH		RTNLGRP_NEIGH
513	RTNLGRP_TC,
514#define RTNLGRP_TC		RTNLGRP_TC
515	RTNLGRP_IPV4_IFADDR,
516#define RTNLGRP_IPV4_IFADDR	RTNLGRP_IPV4_IFADDR
517	RTNLGRP_IPV4_MROUTE,
518#define	RTNLGRP_IPV4_MROUTE	RTNLGRP_IPV4_MROUTE
519	RTNLGRP_IPV4_ROUTE,
520#define RTNLGRP_IPV4_ROUTE	RTNLGRP_IPV4_ROUTE
521	RTNLGRP_IPV4_RULE,
522#define RTNLGRP_IPV4_RULE	RTNLGRP_IPV4_RULE
523	RTNLGRP_IPV6_IFADDR,
524#define RTNLGRP_IPV6_IFADDR	RTNLGRP_IPV6_IFADDR
525	RTNLGRP_IPV6_MROUTE,
526#define RTNLGRP_IPV6_MROUTE	RTNLGRP_IPV6_MROUTE
527	RTNLGRP_IPV6_ROUTE,
528#define RTNLGRP_IPV6_ROUTE	RTNLGRP_IPV6_ROUTE
529	RTNLGRP_IPV6_IFINFO,
530#define RTNLGRP_IPV6_IFINFO	RTNLGRP_IPV6_IFINFO
531	RTNLGRP_DECnet_IFADDR,
532#define RTNLGRP_DECnet_IFADDR	RTNLGRP_DECnet_IFADDR
533	RTNLGRP_NOP2,
534	RTNLGRP_DECnet_ROUTE,
535#define RTNLGRP_DECnet_ROUTE	RTNLGRP_DECnet_ROUTE
536	RTNLGRP_DECnet_RULE,
537#define RTNLGRP_DECnet_RULE	RTNLGRP_DECnet_RULE
538	RTNLGRP_NOP4,
539	RTNLGRP_IPV6_PREFIX,
540#define RTNLGRP_IPV6_PREFIX	RTNLGRP_IPV6_PREFIX
541	RTNLGRP_IPV6_RULE,
542#define RTNLGRP_IPV6_RULE	RTNLGRP_IPV6_RULE
543	__RTNLGRP_MAX
544};
545#define RTNLGRP_MAX	(__RTNLGRP_MAX - 1)
546
547/* TC action piece */
548struct tcamsg
549{
550	unsigned char	tca_family;
551	unsigned char	tca__pad1;
552	unsigned short	tca__pad2;
553};
554#define TA_RTA(r)  ((struct rtattr*)(((char*)(r)) + NLMSG_ALIGN(sizeof(struct tcamsg))))
555#define TA_PAYLOAD(n) NLMSG_PAYLOAD(n,sizeof(struct tcamsg))
556#define TCA_ACT_TAB 1 /* attr type must be >=1 */
557#define TCAA_MAX 1
558
559/* End of information exported to user level */
560
561
562
563#endif	/* __LINUX_RTNETLINK_H */
564