rtnetlink.h revision 1e659af3c0c6d1aad6007c5b4c5405b1fee483d7
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#define RTPROT_DHCP     16      /* DHCP client */
215
216/* rtm_scope
217
218   Really it is not scope, but sort of distance to the destination.
219   NOWHERE are reserved for not existing destinations, HOST is our
220   local addresses, LINK are destinations, located on directly attached
221   link and UNIVERSE is everywhere in the Universe.
222
223   Intermediate values are also possible f.e. interior routes
224   could be assigned a value between UNIVERSE and LINK.
225*/
226
227enum rt_scope_t
228{
229	RT_SCOPE_UNIVERSE=0,
230/* User defined values  */
231	RT_SCOPE_SITE=200,
232	RT_SCOPE_LINK=253,
233	RT_SCOPE_HOST=254,
234	RT_SCOPE_NOWHERE=255
235};
236
237/* rtm_flags */
238
239#define RTM_F_NOTIFY		0x100	/* Notify user of route change	*/
240#define RTM_F_CLONED		0x200	/* This route is cloned		*/
241#define RTM_F_EQUALIZE		0x400	/* Multipath equalizer: NI	*/
242#define RTM_F_PREFIX		0x800	/* Prefix addresses		*/
243
244/* Reserved table identifiers */
245
246enum rt_class_t
247{
248	RT_TABLE_UNSPEC=0,
249/* User defined values */
250	RT_TABLE_COMPAT=252,
251	RT_TABLE_DEFAULT=253,
252	RT_TABLE_MAIN=254,
253	RT_TABLE_LOCAL=255,
254	RT_TABLE_MAX=0xFFFFFFFF
255};
256
257
258/* Routing message attributes */
259
260enum rtattr_type_t
261{
262	RTA_UNSPEC,
263	RTA_DST,
264	RTA_SRC,
265	RTA_IIF,
266	RTA_OIF,
267	RTA_GATEWAY,
268	RTA_PRIORITY,
269	RTA_PREFSRC,
270	RTA_METRICS,
271	RTA_MULTIPATH,
272	RTA_PROTOINFO, /* no longer used */
273	RTA_FLOW,
274	RTA_CACHEINFO,
275	RTA_SESSION, /* no longer used */
276	RTA_MP_ALGO, /* no longer used */
277	RTA_TABLE,
278	__RTA_MAX
279};
280
281#define RTA_MAX (__RTA_MAX - 1)
282
283#define RTM_RTA(r)  ((struct rtattr*)(((char*)(r)) + NLMSG_ALIGN(sizeof(struct rtmsg))))
284#define RTM_PAYLOAD(n) NLMSG_PAYLOAD(n,sizeof(struct rtmsg))
285
286/* RTM_MULTIPATH --- array of struct rtnexthop.
287 *
288 * "struct rtnexthop" describes all necessary nexthop information,
289 * i.e. parameters of path to a destination via this nexthop.
290 *
291 * At the moment it is impossible to set different prefsrc, mtu, window
292 * and rtt for different paths from multipath.
293 */
294
295struct rtnexthop
296{
297	unsigned short		rtnh_len;
298	unsigned char		rtnh_flags;
299	unsigned char		rtnh_hops;
300	int			rtnh_ifindex;
301};
302
303/* rtnh_flags */
304
305#define RTNH_F_DEAD		1	/* Nexthop is dead (used by multipath)	*/
306#define RTNH_F_PERVASIVE	2	/* Do recursive gateway lookup	*/
307#define RTNH_F_ONLINK		4	/* Gateway is forced on link	*/
308
309/* Macros to handle hexthops */
310
311#define RTNH_ALIGNTO	4
312#define RTNH_ALIGN(len) ( ((len)+RTNH_ALIGNTO-1) & ~(RTNH_ALIGNTO-1) )
313#define RTNH_OK(rtnh,len) ((rtnh)->rtnh_len >= sizeof(struct rtnexthop) && \
314			   ((int)(rtnh)->rtnh_len) <= (len))
315#define RTNH_NEXT(rtnh)	((struct rtnexthop*)(((char*)(rtnh)) + RTNH_ALIGN((rtnh)->rtnh_len)))
316#define RTNH_LENGTH(len) (RTNH_ALIGN(sizeof(struct rtnexthop)) + (len))
317#define RTNH_SPACE(len)	RTNH_ALIGN(RTNH_LENGTH(len))
318#define RTNH_DATA(rtnh)   ((struct rtattr*)(((char*)(rtnh)) + RTNH_LENGTH(0)))
319
320/* RTM_CACHEINFO */
321
322struct rta_cacheinfo
323{
324	__u32	rta_clntref;
325	__u32	rta_lastuse;
326	__s32	rta_expires;
327	__u32	rta_error;
328	__u32	rta_used;
329
330#define RTNETLINK_HAVE_PEERINFO 1
331	__u32	rta_id;
332	__u32	rta_ts;
333	__u32	rta_tsage;
334};
335
336/* RTM_METRICS --- array of struct rtattr with types of RTAX_* */
337
338enum
339{
340	RTAX_UNSPEC,
341#define RTAX_UNSPEC RTAX_UNSPEC
342	RTAX_LOCK,
343#define RTAX_LOCK RTAX_LOCK
344	RTAX_MTU,
345#define RTAX_MTU RTAX_MTU
346	RTAX_WINDOW,
347#define RTAX_WINDOW RTAX_WINDOW
348	RTAX_RTT,
349#define RTAX_RTT RTAX_RTT
350	RTAX_RTTVAR,
351#define RTAX_RTTVAR RTAX_RTTVAR
352	RTAX_SSTHRESH,
353#define RTAX_SSTHRESH RTAX_SSTHRESH
354	RTAX_CWND,
355#define RTAX_CWND RTAX_CWND
356	RTAX_ADVMSS,
357#define RTAX_ADVMSS RTAX_ADVMSS
358	RTAX_REORDERING,
359#define RTAX_REORDERING RTAX_REORDERING
360	RTAX_HOPLIMIT,
361#define RTAX_HOPLIMIT RTAX_HOPLIMIT
362	RTAX_INITCWND,
363#define RTAX_INITCWND RTAX_INITCWND
364	RTAX_FEATURES,
365#define RTAX_FEATURES RTAX_FEATURES
366	RTAX_RTO_MIN,
367#define RTAX_RTO_MIN RTAX_RTO_MIN
368	__RTAX_MAX
369};
370
371#define RTAX_MAX (__RTAX_MAX - 1)
372
373#define RTAX_FEATURE_ECN	0x00000001
374#define RTAX_FEATURE_SACK	0x00000002
375#define RTAX_FEATURE_TIMESTAMP	0x00000004
376#define RTAX_FEATURE_ALLFRAG	0x00000008
377
378struct rta_session
379{
380	__u8	proto;
381	__u8	pad1;
382	__u16	pad2;
383
384	union {
385		struct {
386			__u16	sport;
387			__u16	dport;
388		} ports;
389
390		struct {
391			__u8	type;
392			__u8	code;
393			__u16	ident;
394		} icmpt;
395
396		__u32		spi;
397	} u;
398};
399
400/****
401 *		General form of address family dependent message.
402 ****/
403
404struct rtgenmsg
405{
406	unsigned char		rtgen_family;
407};
408
409/*****************************************************************
410 *		Link layer specific messages.
411 ****/
412
413/* struct ifinfomsg
414 * passes link level specific information, not dependent
415 * on network protocol.
416 */
417
418struct ifinfomsg
419{
420	unsigned char	ifi_family;
421	unsigned char	__ifi_pad;
422	unsigned short	ifi_type;		/* ARPHRD_* */
423	int		ifi_index;		/* Link index	*/
424	unsigned	ifi_flags;		/* IFF_* flags	*/
425	unsigned	ifi_change;		/* IFF_* change mask */
426};
427
428/********************************************************************
429 *		prefix information
430 ****/
431
432struct prefixmsg
433{
434	unsigned char	prefix_family;
435	unsigned char	prefix_pad1;
436	unsigned short	prefix_pad2;
437	int		prefix_ifindex;
438	unsigned char	prefix_type;
439	unsigned char	prefix_len;
440	unsigned char	prefix_flags;
441	unsigned char	prefix_pad3;
442};
443
444enum
445{
446	PREFIX_UNSPEC,
447	PREFIX_ADDRESS,
448	PREFIX_CACHEINFO,
449	__PREFIX_MAX
450};
451
452#define PREFIX_MAX	(__PREFIX_MAX - 1)
453
454struct prefix_cacheinfo
455{
456	__u32	preferred_time;
457	__u32	valid_time;
458};
459
460
461/*****************************************************************
462 *		Traffic control messages.
463 ****/
464
465struct tcmsg
466{
467	unsigned char	tcm_family;
468	unsigned char	tcm__pad1;
469	unsigned short	tcm__pad2;
470	int		tcm_ifindex;
471	__u32		tcm_handle;
472	__u32		tcm_parent;
473	__u32		tcm_info;
474};
475
476enum
477{
478	TCA_UNSPEC,
479	TCA_KIND,
480	TCA_OPTIONS,
481	TCA_STATS,
482	TCA_XSTATS,
483	TCA_RATE,
484	TCA_FCNT,
485	TCA_STATS2,
486	TCA_STAB,
487	__TCA_MAX
488};
489
490#define TCA_MAX (__TCA_MAX - 1)
491
492#define TCA_RTA(r)  ((struct rtattr*)(((char*)(r)) + NLMSG_ALIGN(sizeof(struct tcmsg))))
493#define TCA_PAYLOAD(n) NLMSG_PAYLOAD(n,sizeof(struct tcmsg))
494
495/********************************************************************
496 *		Neighbor Discovery userland options
497 ****/
498
499struct nduseroptmsg
500{
501	unsigned char	nduseropt_family;
502	unsigned char	nduseropt_pad1;
503	unsigned short	nduseropt_opts_len;	/* Total length of options */
504	int		nduseropt_ifindex;
505	__u8		nduseropt_icmp_type;
506	__u8		nduseropt_icmp_code;
507	unsigned short	nduseropt_pad2;
508	unsigned int	nduseropt_pad3;
509	/* Followed by one or more ND options */
510};
511
512enum
513{
514	NDUSEROPT_UNSPEC,
515	NDUSEROPT_SRCADDR,
516	__NDUSEROPT_MAX
517};
518
519#define NDUSEROPT_MAX	(__NDUSEROPT_MAX - 1)
520
521/* RTnetlink multicast groups - backwards compatibility for userspace */
522#define RTMGRP_LINK		1
523#define RTMGRP_NOTIFY		2
524#define RTMGRP_NEIGH		4
525#define RTMGRP_TC		8
526
527#define RTMGRP_IPV4_IFADDR	0x10
528#define RTMGRP_IPV4_MROUTE	0x20
529#define RTMGRP_IPV4_ROUTE	0x40
530#define RTMGRP_IPV4_RULE	0x80
531
532#define RTMGRP_IPV6_IFADDR	0x100
533#define RTMGRP_IPV6_MROUTE	0x200
534#define RTMGRP_IPV6_ROUTE	0x400
535#define RTMGRP_IPV6_IFINFO	0x800
536
537#define RTMGRP_DECnet_IFADDR    0x1000
538#define RTMGRP_DECnet_ROUTE     0x4000
539
540#define RTMGRP_IPV6_PREFIX	0x20000
541
542/* RTnetlink multicast groups */
543enum rtnetlink_groups {
544	RTNLGRP_NONE,
545#define RTNLGRP_NONE		RTNLGRP_NONE
546	RTNLGRP_LINK,
547#define RTNLGRP_LINK		RTNLGRP_LINK
548	RTNLGRP_NOTIFY,
549#define RTNLGRP_NOTIFY		RTNLGRP_NOTIFY
550	RTNLGRP_NEIGH,
551#define RTNLGRP_NEIGH		RTNLGRP_NEIGH
552	RTNLGRP_TC,
553#define RTNLGRP_TC		RTNLGRP_TC
554	RTNLGRP_IPV4_IFADDR,
555#define RTNLGRP_IPV4_IFADDR	RTNLGRP_IPV4_IFADDR
556	RTNLGRP_IPV4_MROUTE,
557#define	RTNLGRP_IPV4_MROUTE	RTNLGRP_IPV4_MROUTE
558	RTNLGRP_IPV4_ROUTE,
559#define RTNLGRP_IPV4_ROUTE	RTNLGRP_IPV4_ROUTE
560	RTNLGRP_IPV4_RULE,
561#define RTNLGRP_IPV4_RULE	RTNLGRP_IPV4_RULE
562	RTNLGRP_IPV6_IFADDR,
563#define RTNLGRP_IPV6_IFADDR	RTNLGRP_IPV6_IFADDR
564	RTNLGRP_IPV6_MROUTE,
565#define RTNLGRP_IPV6_MROUTE	RTNLGRP_IPV6_MROUTE
566	RTNLGRP_IPV6_ROUTE,
567#define RTNLGRP_IPV6_ROUTE	RTNLGRP_IPV6_ROUTE
568	RTNLGRP_IPV6_IFINFO,
569#define RTNLGRP_IPV6_IFINFO	RTNLGRP_IPV6_IFINFO
570	RTNLGRP_DECnet_IFADDR,
571#define RTNLGRP_DECnet_IFADDR	RTNLGRP_DECnet_IFADDR
572	RTNLGRP_NOP2,
573	RTNLGRP_DECnet_ROUTE,
574#define RTNLGRP_DECnet_ROUTE	RTNLGRP_DECnet_ROUTE
575	RTNLGRP_DECnet_RULE,
576#define RTNLGRP_DECnet_RULE	RTNLGRP_DECnet_RULE
577	RTNLGRP_NOP4,
578	RTNLGRP_IPV6_PREFIX,
579#define RTNLGRP_IPV6_PREFIX	RTNLGRP_IPV6_PREFIX
580	RTNLGRP_IPV6_RULE,
581#define RTNLGRP_IPV6_RULE	RTNLGRP_IPV6_RULE
582	RTNLGRP_ND_USEROPT,
583#define RTNLGRP_ND_USEROPT	RTNLGRP_ND_USEROPT
584	RTNLGRP_PHONET_IFADDR,
585#define RTNLGRP_PHONET_IFADDR	RTNLGRP_PHONET_IFADDR
586	RTNLGRP_PHONET_ROUTE,
587#define RTNLGRP_PHONET_ROUTE	RTNLGRP_PHONET_ROUTE
588	__RTNLGRP_MAX
589};
590#define RTNLGRP_MAX	(__RTNLGRP_MAX - 1)
591
592/* TC action piece */
593struct tcamsg
594{
595	unsigned char	tca_family;
596	unsigned char	tca__pad1;
597	unsigned short	tca__pad2;
598};
599#define TA_RTA(r)  ((struct rtattr*)(((char*)(r)) + NLMSG_ALIGN(sizeof(struct tcamsg))))
600#define TA_PAYLOAD(n) NLMSG_PAYLOAD(n,sizeof(struct tcamsg))
601#define TCA_ACT_TAB 1 /* attr type must be >=1 */
602#define TCAA_MAX 1
603
604/* End of information exported to user level */
605
606
607
608#endif	/* __LINUX_RTNETLINK_H */
609