1 #ifndef __LINUX_RTNETLINK_H
2 #define __LINUX_RTNETLINK_H
4 #include <linux/types.h>
5 #include <linux/netlink.h>
6 #include <linux/if_link.h>
7 #include <linux/if_addr.h>
8 #include <linux/neighbour.h>
10 /* rtnetlink families. Values up to 127 are reserved for real address
11 * families, values above 128 may be used arbitrarily.
13 #define RTNL_FAMILY_IPMR 128
14 #define RTNL_FAMILY_MAX 128
17 * Routing/neighbour discovery messages.
20 /* Types of messages */
24 #define RTM_BASE RTM_BASE
27 #define RTM_NEWLINK RTM_NEWLINK
29 #define RTM_DELLINK RTM_DELLINK
31 #define RTM_GETLINK RTM_GETLINK
33 #define RTM_SETLINK RTM_SETLINK
36 #define RTM_NEWADDR RTM_NEWADDR
38 #define RTM_DELADDR RTM_DELADDR
40 #define RTM_GETADDR RTM_GETADDR
43 #define RTM_NEWROUTE RTM_NEWROUTE
45 #define RTM_DELROUTE RTM_DELROUTE
47 #define RTM_GETROUTE RTM_GETROUTE
50 #define RTM_NEWNEIGH RTM_NEWNEIGH
52 #define RTM_DELNEIGH RTM_DELNEIGH
54 #define RTM_GETNEIGH RTM_GETNEIGH
57 #define RTM_NEWRULE RTM_NEWRULE
59 #define RTM_DELRULE RTM_DELRULE
61 #define RTM_GETRULE RTM_GETRULE
64 #define RTM_NEWQDISC RTM_NEWQDISC
66 #define RTM_DELQDISC RTM_DELQDISC
68 #define RTM_GETQDISC RTM_GETQDISC
71 #define RTM_NEWTCLASS RTM_NEWTCLASS
73 #define RTM_DELTCLASS RTM_DELTCLASS
75 #define RTM_GETTCLASS RTM_GETTCLASS
78 #define RTM_NEWTFILTER RTM_NEWTFILTER
80 #define RTM_DELTFILTER RTM_DELTFILTER
82 #define RTM_GETTFILTER RTM_GETTFILTER
85 #define RTM_NEWACTION RTM_NEWACTION
87 #define RTM_DELACTION RTM_DELACTION
89 #define RTM_GETACTION RTM_GETACTION
92 #define RTM_NEWPREFIX RTM_NEWPREFIX
94 RTM_GETMULTICAST = 58,
95 #define RTM_GETMULTICAST RTM_GETMULTICAST
98 #define RTM_GETANYCAST RTM_GETANYCAST
100 RTM_NEWNEIGHTBL = 64,
101 #define RTM_NEWNEIGHTBL RTM_NEWNEIGHTBL
102 RTM_GETNEIGHTBL = 66,
103 #define RTM_GETNEIGHTBL RTM_GETNEIGHTBL
105 #define RTM_SETNEIGHTBL RTM_SETNEIGHTBL
107 RTM_NEWNDUSEROPT = 68,
108 #define RTM_NEWNDUSEROPT RTM_NEWNDUSEROPT
110 RTM_NEWADDRLABEL = 72,
111 #define RTM_NEWADDRLABEL RTM_NEWADDRLABEL
113 #define RTM_DELADDRLABEL RTM_DELADDRLABEL
115 #define RTM_GETADDRLABEL RTM_GETADDRLABEL
118 #define RTM_GETDCB RTM_GETDCB
120 #define RTM_SETDCB RTM_SETDCB
123 #define RTM_MAX (((__RTM_MAX + 3) & ~3) - 1)
126 #define RTM_NR_MSGTYPES (RTM_MAX + 1 - RTM_BASE)
127 #define RTM_NR_FAMILIES (RTM_NR_MSGTYPES >> 2)
128 #define RTM_FAM(cmd) (((cmd) - RTM_BASE) >> 2)
131 Generic structure for encapsulation of optional route information.
132 It is reminiscent of sockaddr, but with sa_family replaced
137 unsigned short rta_len;
138 unsigned short rta_type;
141 /* Macros to handle rtattributes */
143 #define RTA_ALIGNTO 4
144 #define RTA_ALIGN(len) ( ((len)+RTA_ALIGNTO-1) & ~(RTA_ALIGNTO-1) )
145 #define RTA_OK(rta,len) ((len) >= (int)sizeof(struct rtattr) && \
146 (rta)->rta_len >= sizeof(struct rtattr) && \
147 (rta)->rta_len <= (len))
148 #define RTA_NEXT(rta,attrlen) ((attrlen) -= RTA_ALIGN((rta)->rta_len), \
149 (struct rtattr*)(((char*)(rta)) + RTA_ALIGN((rta)->rta_len)))
150 #define RTA_LENGTH(len) (RTA_ALIGN(sizeof(struct rtattr)) + (len))
151 #define RTA_SPACE(len) RTA_ALIGN(RTA_LENGTH(len))
152 #define RTA_DATA(rta) ((void*)(((char*)(rta)) + RTA_LENGTH(0)))
153 #define RTA_PAYLOAD(rta) ((int)((rta)->rta_len) - RTA_LENGTH(0))
158 /******************************************************************************
159 * Definitions used in routing table administration.
163 unsigned char rtm_family;
164 unsigned char rtm_dst_len;
165 unsigned char rtm_src_len;
166 unsigned char rtm_tos;
168 unsigned char rtm_table; /* Routing table id */
169 unsigned char rtm_protocol; /* Routing protocol; see below */
170 unsigned char rtm_scope; /* See below */
171 unsigned char rtm_type; /* See below */
180 RTN_UNICAST, /* Gateway or direct route */
181 RTN_LOCAL, /* Accept locally */
182 RTN_BROADCAST, /* Accept locally as broadcast,
184 RTN_ANYCAST, /* Accept locally as broadcast,
185 but send as unicast */
186 RTN_MULTICAST, /* Multicast route */
187 RTN_BLACKHOLE, /* Drop */
188 RTN_UNREACHABLE, /* Destination is unreachable */
189 RTN_PROHIBIT, /* Administratively prohibited */
190 RTN_THROW, /* Not in this table */
191 RTN_NAT, /* Translate this address */
192 RTN_XRESOLVE, /* Use external resolver */
196 #define RTN_MAX (__RTN_MAX - 1)
201 #define RTPROT_UNSPEC 0
202 #define RTPROT_REDIRECT 1 /* Route installed by ICMP redirects;
203 not used by current IPv4 */
204 #define RTPROT_KERNEL 2 /* Route installed by kernel */
205 #define RTPROT_BOOT 3 /* Route installed during boot */
206 #define RTPROT_STATIC 4 /* Route installed by administrator */
208 /* Values of protocol >= RTPROT_STATIC are not interpreted by kernel;
209 they are just passed from user and back as is.
210 It will be used by hypothetical multiple routing daemons.
211 Note that protocol values should be standardized in order to
215 #define RTPROT_GATED 8 /* Apparently, GateD */
216 #define RTPROT_RA 9 /* RDISC/ND router advertisements */
217 #define RTPROT_MRT 10 /* Merit MRT */
218 #define RTPROT_ZEBRA 11 /* Zebra */
219 #define RTPROT_BIRD 12 /* BIRD */
220 #define RTPROT_DNROUTED 13 /* DECnet routing daemon */
221 #define RTPROT_XORP 14 /* XORP */
222 #define RTPROT_NTK 15 /* Netsukuku */
223 #define RTPROT_DHCP 16 /* DHCP client */
227 Really it is not scope, but sort of distance to the destination.
228 NOWHERE are reserved for not existing destinations, HOST is our
229 local addresses, LINK are destinations, located on directly attached
230 link and UNIVERSE is everywhere in the Universe.
232 Intermediate values are also possible f.e. interior routes
233 could be assigned a value between UNIVERSE and LINK.
238 /* User defined values */
247 #define RTM_F_NOTIFY 0x100 /* Notify user of route change */
248 #define RTM_F_CLONED 0x200 /* This route is cloned */
249 #define RTM_F_EQUALIZE 0x400 /* Multipath equalizer: NI */
250 #define RTM_F_PREFIX 0x800 /* Prefix addresses */
252 /* Reserved table identifiers */
256 /* User defined values */
258 RT_TABLE_DEFAULT=253,
261 RT_TABLE_MAX=0xFFFFFFFF
265 /* Routing message attributes */
278 RTA_PROTOINFO, /* no longer used */
281 RTA_SESSION, /* no longer used */
282 RTA_MP_ALGO, /* no longer used */
287 #define RTA_MAX (__RTA_MAX - 1)
289 #define RTM_RTA(r) ((struct rtattr*)(((char*)(r)) + NLMSG_ALIGN(sizeof(struct rtmsg))))
290 #define RTM_PAYLOAD(n) NLMSG_PAYLOAD(n,sizeof(struct rtmsg))
292 /* RTM_MULTIPATH --- array of struct rtnexthop.
294 * "struct rtnexthop" describes all necessary nexthop information,
295 * i.e. parameters of path to a destination via this nexthop.
297 * At the moment it is impossible to set different prefsrc, mtu, window
298 * and rtt for different paths from multipath.
302 unsigned short rtnh_len;
303 unsigned char rtnh_flags;
304 unsigned char rtnh_hops;
310 #define RTNH_F_DEAD 1 /* Nexthop is dead (used by multipath) */
311 #define RTNH_F_PERVASIVE 2 /* Do recursive gateway lookup */
312 #define RTNH_F_ONLINK 4 /* Gateway is forced on link */
314 /* Macros to handle hexthops */
316 #define RTNH_ALIGNTO 4
317 #define RTNH_ALIGN(len) ( ((len)+RTNH_ALIGNTO-1) & ~(RTNH_ALIGNTO-1) )
318 #define RTNH_OK(rtnh,len) ((rtnh)->rtnh_len >= sizeof(struct rtnexthop) && \
319 ((int)(rtnh)->rtnh_len) <= (len))
320 #define RTNH_NEXT(rtnh) ((struct rtnexthop*)(((char*)(rtnh)) + RTNH_ALIGN((rtnh)->rtnh_len)))
321 #define RTNH_LENGTH(len) (RTNH_ALIGN(sizeof(struct rtnexthop)) + (len))
322 #define RTNH_SPACE(len) RTNH_ALIGN(RTNH_LENGTH(len))
323 #define RTNH_DATA(rtnh) ((struct rtattr*)(((char*)(rtnh)) + RTNH_LENGTH(0)))
327 struct rta_cacheinfo {
334 #define RTNETLINK_HAVE_PEERINFO 1
340 /* RTM_METRICS --- array of struct rtattr with types of RTAX_* */
344 #define RTAX_UNSPEC RTAX_UNSPEC
346 #define RTAX_LOCK RTAX_LOCK
348 #define RTAX_MTU RTAX_MTU
350 #define RTAX_WINDOW RTAX_WINDOW
352 #define RTAX_RTT RTAX_RTT
354 #define RTAX_RTTVAR RTAX_RTTVAR
356 #define RTAX_SSTHRESH RTAX_SSTHRESH
358 #define RTAX_CWND RTAX_CWND
360 #define RTAX_ADVMSS RTAX_ADVMSS
362 #define RTAX_REORDERING RTAX_REORDERING
364 #define RTAX_HOPLIMIT RTAX_HOPLIMIT
366 #define RTAX_INITCWND RTAX_INITCWND
368 #define RTAX_FEATURES RTAX_FEATURES
370 #define RTAX_RTO_MIN RTAX_RTO_MIN
372 #define RTAX_INITRWND RTAX_INITRWND
376 #define RTAX_MAX (__RTAX_MAX - 1)
378 #define RTAX_FEATURE_ECN 0x00000001
379 #define RTAX_FEATURE_SACK 0x00000002
380 #define RTAX_FEATURE_TIMESTAMP 0x00000004
381 #define RTAX_FEATURE_ALLFRAG 0x00000008
405 * General form of address family dependent message.
409 unsigned char rtgen_family;
412 /*****************************************************************
413 * Link layer specific messages.
417 * passes link level specific information, not dependent
418 * on network protocol.
422 unsigned char ifi_family;
423 unsigned char __ifi_pad;
424 unsigned short ifi_type; /* ARPHRD_* */
425 int ifi_index; /* Link index */
426 unsigned ifi_flags; /* IFF_* flags */
427 unsigned ifi_change; /* IFF_* change mask */
430 /********************************************************************
435 unsigned char prefix_family;
436 unsigned char prefix_pad1;
437 unsigned short prefix_pad2;
439 unsigned char prefix_type;
440 unsigned char prefix_len;
441 unsigned char prefix_flags;
442 unsigned char prefix_pad3;
453 #define PREFIX_MAX (__PREFIX_MAX - 1)
455 struct prefix_cacheinfo {
456 __u32 preferred_time;
461 /*****************************************************************
462 * Traffic control messages.
466 unsigned char tcm_family;
467 unsigned char tcm__pad1;
468 unsigned short tcm__pad2;
488 #define TCA_MAX (__TCA_MAX - 1)
490 #define TCA_RTA(r) ((struct rtattr*)(((char*)(r)) + NLMSG_ALIGN(sizeof(struct tcmsg))))
491 #define TCA_PAYLOAD(n) NLMSG_PAYLOAD(n,sizeof(struct tcmsg))
493 /********************************************************************
494 * Neighbor Discovery userland options
497 struct nduseroptmsg {
498 unsigned char nduseropt_family;
499 unsigned char nduseropt_pad1;
500 unsigned short nduseropt_opts_len; /* Total length of options */
501 int nduseropt_ifindex;
502 __u8 nduseropt_icmp_type;
503 __u8 nduseropt_icmp_code;
504 unsigned short nduseropt_pad2;
505 unsigned int nduseropt_pad3;
506 /* Followed by one or more ND options */
515 #define NDUSEROPT_MAX (__NDUSEROPT_MAX - 1)
518 /* RTnetlink multicast groups - backwards compatibility for userspace */
519 #define RTMGRP_LINK 1
520 #define RTMGRP_NOTIFY 2
521 #define RTMGRP_NEIGH 4
524 #define RTMGRP_IPV4_IFADDR 0x10
525 #define RTMGRP_IPV4_MROUTE 0x20
526 #define RTMGRP_IPV4_ROUTE 0x40
527 #define RTMGRP_IPV4_RULE 0x80
529 #define RTMGRP_IPV6_IFADDR 0x100
530 #define RTMGRP_IPV6_MROUTE 0x200
531 #define RTMGRP_IPV6_ROUTE 0x400
532 #define RTMGRP_IPV6_IFINFO 0x800
534 #define RTMGRP_DECnet_IFADDR 0x1000
535 #define RTMGRP_DECnet_ROUTE 0x4000
537 #define RTMGRP_IPV6_PREFIX 0x20000
540 /* RTnetlink multicast groups */
541 enum rtnetlink_groups {
543 #define RTNLGRP_NONE RTNLGRP_NONE
545 #define RTNLGRP_LINK RTNLGRP_LINK
547 #define RTNLGRP_NOTIFY RTNLGRP_NOTIFY
549 #define RTNLGRP_NEIGH RTNLGRP_NEIGH
551 #define RTNLGRP_TC RTNLGRP_TC
553 #define RTNLGRP_IPV4_IFADDR RTNLGRP_IPV4_IFADDR
555 #define RTNLGRP_IPV4_MROUTE RTNLGRP_IPV4_MROUTE
557 #define RTNLGRP_IPV4_ROUTE RTNLGRP_IPV4_ROUTE
559 #define RTNLGRP_IPV4_RULE RTNLGRP_IPV4_RULE
561 #define RTNLGRP_IPV6_IFADDR RTNLGRP_IPV6_IFADDR
563 #define RTNLGRP_IPV6_MROUTE RTNLGRP_IPV6_MROUTE
565 #define RTNLGRP_IPV6_ROUTE RTNLGRP_IPV6_ROUTE
567 #define RTNLGRP_IPV6_IFINFO RTNLGRP_IPV6_IFINFO
568 RTNLGRP_DECnet_IFADDR,
569 #define RTNLGRP_DECnet_IFADDR RTNLGRP_DECnet_IFADDR
571 RTNLGRP_DECnet_ROUTE,
572 #define RTNLGRP_DECnet_ROUTE RTNLGRP_DECnet_ROUTE
574 #define RTNLGRP_DECnet_RULE RTNLGRP_DECnet_RULE
577 #define RTNLGRP_IPV6_PREFIX RTNLGRP_IPV6_PREFIX
579 #define RTNLGRP_IPV6_RULE RTNLGRP_IPV6_RULE
581 #define RTNLGRP_ND_USEROPT RTNLGRP_ND_USEROPT
582 RTNLGRP_PHONET_IFADDR,
583 #define RTNLGRP_PHONET_IFADDR RTNLGRP_PHONET_IFADDR
584 RTNLGRP_PHONET_ROUTE,
585 #define RTNLGRP_PHONET_ROUTE RTNLGRP_PHONET_ROUTE
588 #define RTNLGRP_MAX (__RTNLGRP_MAX - 1)
590 /* TC action piece */
592 unsigned char tca_family;
593 unsigned char tca__pad1;
594 unsigned short tca__pad2;
596 #define TA_RTA(r) ((struct rtattr*)(((char*)(r)) + NLMSG_ALIGN(sizeof(struct tcamsg))))
597 #define TA_PAYLOAD(n) NLMSG_PAYLOAD(n,sizeof(struct tcamsg))
598 #define TCA_ACT_TAB 1 /* attr type must be >=1 */
601 /* End of information exported to user level */
605 #include <linux/mutex.h>
607 static __inline__ int rtattr_strcmp(const struct rtattr *rta, const char *str)
609 int len = strlen(str) + 1;
610 return len > rta->rta_len || memcmp(RTA_DATA(rta), str, len);
613 extern int rtnetlink_send(struct sk_buff *skb, struct net *net, u32 pid, u32 group, int echo);
614 extern int rtnl_unicast(struct sk_buff *skb, struct net *net, u32 pid);
615 extern void rtnl_notify(struct sk_buff *skb, struct net *net, u32 pid,
616 u32 group, struct nlmsghdr *nlh, gfp_t flags);
617 extern void rtnl_set_sk_err(struct net *net, u32 group, int error);
618 extern int rtnetlink_put_metrics(struct sk_buff *skb, u32 *metrics);
619 extern int rtnl_put_cacheinfo(struct sk_buff *skb, struct dst_entry *dst,
620 u32 id, u32 ts, u32 tsage, long expires,
623 extern void __rta_fill(struct sk_buff *skb, int attrtype, int attrlen, const void *data);
625 #define RTA_PUT(skb, attrtype, attrlen, data) \
626 ({ if (unlikely(skb_tailroom(skb) < (int)RTA_SPACE(attrlen))) \
627 goto rtattr_failure; \
628 __rta_fill(skb, attrtype, attrlen, data); })
630 #define RTA_APPEND(skb, attrlen, data) \
631 ({ if (unlikely(skb_tailroom(skb) < (int)(attrlen))) \
632 goto rtattr_failure; \
633 memcpy(skb_put(skb, attrlen), data, attrlen); })
635 #define RTA_PUT_NOHDR(skb, attrlen, data) \
636 ({ RTA_APPEND(skb, RTA_ALIGN(attrlen), data); \
637 memset(skb_tail_pointer(skb) - (RTA_ALIGN(attrlen) - attrlen), 0, \
638 RTA_ALIGN(attrlen) - attrlen); })
640 #define RTA_PUT_U8(skb, attrtype, value) \
641 ({ u8 _tmp = (value); \
642 RTA_PUT(skb, attrtype, sizeof(u8), &_tmp); })
644 #define RTA_PUT_U16(skb, attrtype, value) \
645 ({ u16 _tmp = (value); \
646 RTA_PUT(skb, attrtype, sizeof(u16), &_tmp); })
648 #define RTA_PUT_U32(skb, attrtype, value) \
649 ({ u32 _tmp = (value); \
650 RTA_PUT(skb, attrtype, sizeof(u32), &_tmp); })
652 #define RTA_PUT_U64(skb, attrtype, value) \
653 ({ u64 _tmp = (value); \
654 RTA_PUT(skb, attrtype, sizeof(u64), &_tmp); })
656 #define RTA_PUT_SECS(skb, attrtype, value) \
657 RTA_PUT_U64(skb, attrtype, (value) / HZ)
659 #define RTA_PUT_MSECS(skb, attrtype, value) \
660 RTA_PUT_U64(skb, attrtype, jiffies_to_msecs(value))
662 #define RTA_PUT_STRING(skb, attrtype, value) \
663 RTA_PUT(skb, attrtype, strlen(value) + 1, value)
665 #define RTA_PUT_FLAG(skb, attrtype) \
666 RTA_PUT(skb, attrtype, 0, NULL);
668 #define RTA_NEST(skb, type) \
669 ({ struct rtattr *__start = (struct rtattr *)skb_tail_pointer(skb); \
670 RTA_PUT(skb, type, 0, NULL); \
673 #define RTA_NEST_END(skb, start) \
674 ({ (start)->rta_len = skb_tail_pointer(skb) - (unsigned char *)(start); \
677 #define RTA_NEST_COMPAT(skb, type, attrlen, data) \
678 ({ struct rtattr *__start = (struct rtattr *)skb_tail_pointer(skb); \
679 RTA_PUT(skb, type, attrlen, data); \
680 RTA_NEST(skb, type); \
683 #define RTA_NEST_COMPAT_END(skb, start) \
684 ({ struct rtattr *__nest = (void *)(start) + NLMSG_ALIGN((start)->rta_len); \
685 (start)->rta_len = skb_tail_pointer(skb) - (unsigned char *)(start); \
686 RTA_NEST_END(skb, __nest); \
689 #define RTA_NEST_CANCEL(skb, start) \
691 skb_trim(skb, (unsigned char *) (start) - (skb)->data); \
694 #define RTA_GET_U8(rta) \
695 ({ if (!rta || RTA_PAYLOAD(rta) < sizeof(u8)) \
696 goto rtattr_failure; \
697 *(u8 *) RTA_DATA(rta); })
699 #define RTA_GET_U16(rta) \
700 ({ if (!rta || RTA_PAYLOAD(rta) < sizeof(u16)) \
701 goto rtattr_failure; \
702 *(u16 *) RTA_DATA(rta); })
704 #define RTA_GET_U32(rta) \
705 ({ if (!rta || RTA_PAYLOAD(rta) < sizeof(u32)) \
706 goto rtattr_failure; \
707 *(u32 *) RTA_DATA(rta); })
709 #define RTA_GET_U64(rta) \
711 if (!rta || RTA_PAYLOAD(rta) < sizeof(u64)) \
712 goto rtattr_failure; \
713 memcpy(&_tmp, RTA_DATA(rta), sizeof(_tmp)); \
716 #define RTA_GET_FLAG(rta) (!!(rta))
718 #define RTA_GET_SECS(rta) ((unsigned long) RTA_GET_U64(rta) * HZ)
719 #define RTA_GET_MSECS(rta) (msecs_to_jiffies((unsigned long) RTA_GET_U64(rta)))
721 static inline struct rtattr *
722 __rta_reserve(struct sk_buff *skb, int attrtype, int attrlen)
725 int size = RTA_LENGTH(attrlen);
727 rta = (struct rtattr*)skb_put(skb, RTA_ALIGN(size));
728 rta->rta_type = attrtype;
730 memset(RTA_DATA(rta) + attrlen, 0, RTA_ALIGN(size) - size);
734 #define __RTA_PUT(skb, attrtype, attrlen) \
735 ({ if (unlikely(skb_tailroom(skb) < (int)RTA_SPACE(attrlen))) \
736 goto rtattr_failure; \
737 __rta_reserve(skb, attrtype, attrlen); })
739 extern void rtmsg_ifinfo(int type, struct net_device *dev, unsigned change);
741 /* RTNL is used as a global lock for all changes to network configuration */
742 extern void rtnl_lock(void);
743 extern void rtnl_unlock(void);
744 extern int rtnl_trylock(void);
745 extern int rtnl_is_locked(void);
746 #ifdef CONFIG_PROVE_LOCKING
747 extern int lockdep_rtnl_is_held(void);
748 #endif /* #ifdef CONFIG_PROVE_LOCKING */
750 extern void rtnetlink_init(void);
751 extern void __rtnl_unlock(void);
753 #define ASSERT_RTNL() do { \
754 if (unlikely(!rtnl_is_locked())) { \
755 printk(KERN_ERR "RTNL: assertion failed at %s (%d)\n", \
756 __FILE__, __LINE__); \
761 static inline u32 rtm_get_table(struct rtattr **rta, u8 table)
763 return RTA_GET_U32(rta[RTA_TABLE-1]);
768 #endif /* __KERNEL__ */
771 #endif /* __LINUX_RTNETLINK_H */