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