1 #ifndef __LINUX_RTNETLINK_H
2 #define __LINUX_RTNETLINK_H
4 #include <linux/netlink.h>
5 #include <linux/if_link.h>
6 #include <linux/if_addr.h>
7 #include <linux/neighbour.h>
10 * Routing/neighbour discovery messages.
13 /* Types of messages */
17 #define RTM_BASE RTM_BASE
20 #define RTM_NEWLINK RTM_NEWLINK
22 #define RTM_DELLINK RTM_DELLINK
24 #define RTM_GETLINK RTM_GETLINK
26 #define RTM_SETLINK RTM_SETLINK
29 #define RTM_NEWADDR RTM_NEWADDR
31 #define RTM_DELADDR RTM_DELADDR
33 #define RTM_GETADDR RTM_GETADDR
36 #define RTM_NEWROUTE RTM_NEWROUTE
38 #define RTM_DELROUTE RTM_DELROUTE
40 #define RTM_GETROUTE RTM_GETROUTE
43 #define RTM_NEWNEIGH RTM_NEWNEIGH
45 #define RTM_DELNEIGH RTM_DELNEIGH
47 #define RTM_GETNEIGH RTM_GETNEIGH
50 #define RTM_NEWRULE RTM_NEWRULE
52 #define RTM_DELRULE RTM_DELRULE
54 #define RTM_GETRULE RTM_GETRULE
57 #define RTM_NEWQDISC RTM_NEWQDISC
59 #define RTM_DELQDISC RTM_DELQDISC
61 #define RTM_GETQDISC RTM_GETQDISC
64 #define RTM_NEWTCLASS RTM_NEWTCLASS
66 #define RTM_DELTCLASS RTM_DELTCLASS
68 #define RTM_GETTCLASS RTM_GETTCLASS
71 #define RTM_NEWTFILTER RTM_NEWTFILTER
73 #define RTM_DELTFILTER RTM_DELTFILTER
75 #define RTM_GETTFILTER RTM_GETTFILTER
78 #define RTM_NEWACTION RTM_NEWACTION
80 #define RTM_DELACTION RTM_DELACTION
82 #define RTM_GETACTION RTM_GETACTION
85 #define RTM_NEWPREFIX RTM_NEWPREFIX
87 RTM_GETMULTICAST = 58,
88 #define RTM_GETMULTICAST RTM_GETMULTICAST
91 #define RTM_GETANYCAST RTM_GETANYCAST
94 #define RTM_NEWNEIGHTBL RTM_NEWNEIGHTBL
96 #define RTM_GETNEIGHTBL RTM_GETNEIGHTBL
98 #define RTM_SETNEIGHTBL RTM_SETNEIGHTBL
100 RTM_NEWNDUSEROPT = 68,
101 #define RTM_NEWNDUSEROPT RTM_NEWNDUSEROPT
104 #define RTM_MAX (((__RTM_MAX + 3) & ~3) - 1)
107 #define RTM_NR_MSGTYPES (RTM_MAX + 1 - RTM_BASE)
108 #define RTM_NR_FAMILIES (RTM_NR_MSGTYPES >> 2)
109 #define RTM_FAM(cmd) (((cmd) - RTM_BASE) >> 2)
112 Generic structure for encapsulation of optional route information.
113 It is reminiscent of sockaddr, but with sa_family replaced
119 unsigned short rta_len;
120 unsigned short rta_type;
123 /* Macros to handle rtattributes */
125 #define RTA_ALIGNTO 4
126 #define RTA_ALIGN(len) ( ((len)+RTA_ALIGNTO-1) & ~(RTA_ALIGNTO-1) )
127 #define RTA_OK(rta,len) ((len) >= (int)sizeof(struct rtattr) && \
128 (rta)->rta_len >= sizeof(struct rtattr) && \
129 (rta)->rta_len <= (len))
130 #define RTA_NEXT(rta,attrlen) ((attrlen) -= RTA_ALIGN((rta)->rta_len), \
131 (struct rtattr*)(((char*)(rta)) + RTA_ALIGN((rta)->rta_len)))
132 #define RTA_LENGTH(len) (RTA_ALIGN(sizeof(struct rtattr)) + (len))
133 #define RTA_SPACE(len) RTA_ALIGN(RTA_LENGTH(len))
134 #define RTA_DATA(rta) ((void*)(((char*)(rta)) + RTA_LENGTH(0)))
135 #define RTA_PAYLOAD(rta) ((int)((rta)->rta_len) - RTA_LENGTH(0))
140 /******************************************************************************
141 * Definitions used in routing table administration.
146 unsigned char rtm_family;
147 unsigned char rtm_dst_len;
148 unsigned char rtm_src_len;
149 unsigned char rtm_tos;
151 unsigned char rtm_table; /* Routing table id */
152 unsigned char rtm_protocol; /* Routing protocol; see below */
153 unsigned char rtm_scope; /* See below */
154 unsigned char rtm_type; /* See below */
164 RTN_UNICAST, /* Gateway or direct route */
165 RTN_LOCAL, /* Accept locally */
166 RTN_BROADCAST, /* Accept locally as broadcast,
168 RTN_ANYCAST, /* Accept locally as broadcast,
169 but send as unicast */
170 RTN_MULTICAST, /* Multicast route */
171 RTN_BLACKHOLE, /* Drop */
172 RTN_UNREACHABLE, /* Destination is unreachable */
173 RTN_PROHIBIT, /* Administratively prohibited */
174 RTN_THROW, /* Not in this table */
175 RTN_NAT, /* Translate this address */
176 RTN_XRESOLVE, /* Use external resolver */
180 #define RTN_MAX (__RTN_MAX - 1)
185 #define RTPROT_UNSPEC 0
186 #define RTPROT_REDIRECT 1 /* Route installed by ICMP redirects;
187 not used by current IPv4 */
188 #define RTPROT_KERNEL 2 /* Route installed by kernel */
189 #define RTPROT_BOOT 3 /* Route installed during boot */
190 #define RTPROT_STATIC 4 /* Route installed by administrator */
192 /* Values of protocol >= RTPROT_STATIC are not interpreted by kernel;
193 they are just passed from user and back as is.
194 It will be used by hypothetical multiple routing daemons.
195 Note that protocol values should be standardized in order to
199 #define RTPROT_GATED 8 /* Apparently, GateD */
200 #define RTPROT_RA 9 /* RDISC/ND router advertisements */
201 #define RTPROT_MRT 10 /* Merit MRT */
202 #define RTPROT_ZEBRA 11 /* Zebra */
203 #define RTPROT_BIRD 12 /* BIRD */
204 #define RTPROT_DNROUTED 13 /* DECnet routing daemon */
205 #define RTPROT_XORP 14 /* XORP */
206 #define RTPROT_NTK 15 /* Netsukuku */
210 Really it is not scope, but sort of distance to the destination.
211 NOWHERE are reserved for not existing destinations, HOST is our
212 local addresses, LINK are destinations, located on directly attached
213 link and UNIVERSE is everywhere in the Universe.
215 Intermediate values are also possible f.e. interior routes
216 could be assigned a value between UNIVERSE and LINK.
222 /* User defined values */
231 #define RTM_F_NOTIFY 0x100 /* Notify user of route change */
232 #define RTM_F_CLONED 0x200 /* This route is cloned */
233 #define RTM_F_EQUALIZE 0x400 /* Multipath equalizer: NI */
234 #define RTM_F_PREFIX 0x800 /* Prefix addresses */
236 /* Reserved table identifiers */
241 /* User defined values */
242 RT_TABLE_DEFAULT=253,
245 RT_TABLE_MAX=0xFFFFFFFF
249 /* Routing message attributes */
267 RTA_MP_ALGO, /* no longer used */
272 #define RTA_MAX (__RTA_MAX - 1)
274 #define RTM_RTA(r) ((struct rtattr*)(((char*)(r)) + NLMSG_ALIGN(sizeof(struct rtmsg))))
275 #define RTM_PAYLOAD(n) NLMSG_PAYLOAD(n,sizeof(struct rtmsg))
277 /* RTM_MULTIPATH --- array of struct rtnexthop.
279 * "struct rtnexthop" describes all necessary nexthop information,
280 * i.e. parameters of path to a destination via this nexthop.
282 * At the moment it is impossible to set different prefsrc, mtu, window
283 * and rtt for different paths from multipath.
288 unsigned short rtnh_len;
289 unsigned char rtnh_flags;
290 unsigned char rtnh_hops;
296 #define RTNH_F_DEAD 1 /* Nexthop is dead (used by multipath) */
297 #define RTNH_F_PERVASIVE 2 /* Do recursive gateway lookup */
298 #define RTNH_F_ONLINK 4 /* Gateway is forced on link */
300 /* Macros to handle hexthops */
302 #define RTNH_ALIGNTO 4
303 #define RTNH_ALIGN(len) ( ((len)+RTNH_ALIGNTO-1) & ~(RTNH_ALIGNTO-1) )
304 #define RTNH_OK(rtnh,len) ((rtnh)->rtnh_len >= sizeof(struct rtnexthop) && \
305 ((int)(rtnh)->rtnh_len) <= (len))
306 #define RTNH_NEXT(rtnh) ((struct rtnexthop*)(((char*)(rtnh)) + RTNH_ALIGN((rtnh)->rtnh_len)))
307 #define RTNH_LENGTH(len) (RTNH_ALIGN(sizeof(struct rtnexthop)) + (len))
308 #define RTNH_SPACE(len) RTNH_ALIGN(RTNH_LENGTH(len))
309 #define RTNH_DATA(rtnh) ((struct rtattr*)(((char*)(rtnh)) + RTNH_LENGTH(0)))
321 #define RTNETLINK_HAVE_PEERINFO 1
327 /* RTM_METRICS --- array of struct rtattr with types of RTAX_* */
332 #define RTAX_UNSPEC RTAX_UNSPEC
334 #define RTAX_LOCK RTAX_LOCK
336 #define RTAX_MTU RTAX_MTU
338 #define RTAX_WINDOW RTAX_WINDOW
340 #define RTAX_RTT RTAX_RTT
342 #define RTAX_RTTVAR RTAX_RTTVAR
344 #define RTAX_SSTHRESH RTAX_SSTHRESH
346 #define RTAX_CWND RTAX_CWND
348 #define RTAX_ADVMSS RTAX_ADVMSS
350 #define RTAX_REORDERING RTAX_REORDERING
352 #define RTAX_HOPLIMIT RTAX_HOPLIMIT
354 #define RTAX_INITCWND RTAX_INITCWND
356 #define RTAX_FEATURES RTAX_FEATURES
358 #define RTAX_RTO_MIN RTAX_RTO_MIN
362 #define RTAX_MAX (__RTAX_MAX - 1)
364 #define RTAX_FEATURE_ECN 0x00000001
365 #define RTAX_FEATURE_SACK 0x00000002
366 #define RTAX_FEATURE_TIMESTAMP 0x00000004
367 #define RTAX_FEATURE_ALLFRAG 0x00000008
392 * General form of address family dependent message.
397 unsigned char rtgen_family;
400 /*****************************************************************
401 * Link layer specific messages.
405 * passes link level specific information, not dependent
406 * on network protocol.
411 unsigned char ifi_family;
412 unsigned char __ifi_pad;
413 unsigned short ifi_type; /* ARPHRD_* */
414 int ifi_index; /* Link index */
415 unsigned ifi_flags; /* IFF_* flags */
416 unsigned ifi_change; /* IFF_* change mask */
419 /********************************************************************
425 unsigned char prefix_family;
426 unsigned char prefix_pad1;
427 unsigned short prefix_pad2;
429 unsigned char prefix_type;
430 unsigned char prefix_len;
431 unsigned char prefix_flags;
432 unsigned char prefix_pad3;
443 #define PREFIX_MAX (__PREFIX_MAX - 1)
445 struct prefix_cacheinfo
447 __u32 preferred_time;
452 /*****************************************************************
453 * Traffic control messages.
458 unsigned char tcm_family;
459 unsigned char tcm__pad1;
460 unsigned short tcm__pad2;
480 #define TCA_MAX (__TCA_MAX - 1)
482 #define TCA_RTA(r) ((struct rtattr*)(((char*)(r)) + NLMSG_ALIGN(sizeof(struct tcmsg))))
483 #define TCA_PAYLOAD(n) NLMSG_PAYLOAD(n,sizeof(struct tcmsg))
485 /********************************************************************
486 * Neighbor Discovery userland options
491 unsigned char nduseropt_family;
492 unsigned char nduseropt_pad1;
493 unsigned short nduseropt_opts_len; /* Total length of options */
494 int nduseropt_ifindex;
495 __u8 nduseropt_icmp_type;
496 __u8 nduseropt_icmp_code;
497 unsigned short nduseropt_pad2;
498 unsigned int nduseropt_pad3;
499 /* Followed by one or more ND options */
509 #define NDUSEROPT_MAX (__NDUSEROPT_MAX - 1)
512 /* RTnetlink multicast groups - backwards compatibility for userspace */
513 #define RTMGRP_LINK 1
514 #define RTMGRP_NOTIFY 2
515 #define RTMGRP_NEIGH 4
518 #define RTMGRP_IPV4_IFADDR 0x10
519 #define RTMGRP_IPV4_MROUTE 0x20
520 #define RTMGRP_IPV4_ROUTE 0x40
521 #define RTMGRP_IPV4_RULE 0x80
523 #define RTMGRP_IPV6_IFADDR 0x100
524 #define RTMGRP_IPV6_MROUTE 0x200
525 #define RTMGRP_IPV6_ROUTE 0x400
526 #define RTMGRP_IPV6_IFINFO 0x800
528 #define RTMGRP_DECnet_IFADDR 0x1000
529 #define RTMGRP_DECnet_ROUTE 0x4000
531 #define RTMGRP_IPV6_PREFIX 0x20000
534 /* RTnetlink multicast groups */
535 enum rtnetlink_groups {
537 #define RTNLGRP_NONE RTNLGRP_NONE
539 #define RTNLGRP_LINK RTNLGRP_LINK
541 #define RTNLGRP_NOTIFY RTNLGRP_NOTIFY
543 #define RTNLGRP_NEIGH RTNLGRP_NEIGH
545 #define RTNLGRP_TC RTNLGRP_TC
547 #define RTNLGRP_IPV4_IFADDR RTNLGRP_IPV4_IFADDR
549 #define RTNLGRP_IPV4_MROUTE RTNLGRP_IPV4_MROUTE
551 #define RTNLGRP_IPV4_ROUTE RTNLGRP_IPV4_ROUTE
553 #define RTNLGRP_IPV4_RULE RTNLGRP_IPV4_RULE
555 #define RTNLGRP_IPV6_IFADDR RTNLGRP_IPV6_IFADDR
557 #define RTNLGRP_IPV6_MROUTE RTNLGRP_IPV6_MROUTE
559 #define RTNLGRP_IPV6_ROUTE RTNLGRP_IPV6_ROUTE
561 #define RTNLGRP_IPV6_IFINFO RTNLGRP_IPV6_IFINFO
562 RTNLGRP_DECnet_IFADDR,
563 #define RTNLGRP_DECnet_IFADDR RTNLGRP_DECnet_IFADDR
565 RTNLGRP_DECnet_ROUTE,
566 #define RTNLGRP_DECnet_ROUTE RTNLGRP_DECnet_ROUTE
568 #define RTNLGRP_DECnet_RULE RTNLGRP_DECnet_RULE
571 #define RTNLGRP_IPV6_PREFIX RTNLGRP_IPV6_PREFIX
573 #define RTNLGRP_IPV6_RULE RTNLGRP_IPV6_RULE
575 #define RTNLGRP_ND_USEROPT RTNLGRP_ND_USEROPT
578 #define RTNLGRP_MAX (__RTNLGRP_MAX - 1)
580 /* TC action piece */
583 unsigned char tca_family;
584 unsigned char tca__pad1;
585 unsigned short tca__pad2;
587 #define TA_RTA(r) ((struct rtattr*)(((char*)(r)) + NLMSG_ALIGN(sizeof(struct tcamsg))))
588 #define TA_PAYLOAD(n) NLMSG_PAYLOAD(n,sizeof(struct tcamsg))
589 #define TCA_ACT_TAB 1 /* attr type must be >=1 */
592 /* End of information exported to user level */
596 #include <linux/mutex.h>
598 extern size_t rtattr_strlcpy(char *dest, const struct rtattr *rta, size_t size);
599 static __inline__ int rtattr_strcmp(const struct rtattr *rta, const char *str)
601 int len = strlen(str) + 1;
602 return len > rta->rta_len || memcmp(RTA_DATA(rta), str, len);
605 extern int rtattr_parse(struct rtattr *tb[], int maxattr, struct rtattr *rta, int len);
606 extern int __rtattr_parse_nested_compat(struct rtattr *tb[], int maxattr,
607 struct rtattr *rta, int len);
609 #define rtattr_parse_nested(tb, max, rta) \
610 rtattr_parse((tb), (max), RTA_DATA((rta)), RTA_PAYLOAD((rta)))
612 #define rtattr_parse_nested_compat(tb, max, rta, data, len) \
613 ({ data = RTA_PAYLOAD(rta) >= len ? RTA_DATA(rta) : NULL; \
614 __rtattr_parse_nested_compat(tb, max, rta, len); })
616 extern int rtnetlink_send(struct sk_buff *skb, u32 pid, u32 group, int echo);
617 extern int rtnl_unicast(struct sk_buff *skb, u32 pid);
618 extern int rtnl_notify(struct sk_buff *skb, u32 pid, u32 group,
619 struct nlmsghdr *nlh, gfp_t flags);
620 extern void rtnl_set_sk_err(u32 group, int error);
621 extern int rtnetlink_put_metrics(struct sk_buff *skb, u32 *metrics);
622 extern int rtnl_put_cacheinfo(struct sk_buff *skb, struct dst_entry *dst,
623 u32 id, u32 ts, u32 tsage, long expires,
626 extern void __rta_fill(struct sk_buff *skb, int attrtype, int attrlen, const void *data);
628 #define RTA_PUT(skb, attrtype, attrlen, data) \
629 ({ if (unlikely(skb_tailroom(skb) < (int)RTA_SPACE(attrlen))) \
630 goto rtattr_failure; \
631 __rta_fill(skb, attrtype, attrlen, data); })
633 #define RTA_APPEND(skb, attrlen, data) \
634 ({ if (unlikely(skb_tailroom(skb) < (int)(attrlen))) \
635 goto rtattr_failure; \
636 memcpy(skb_put(skb, attrlen), data, attrlen); })
638 #define RTA_PUT_NOHDR(skb, attrlen, data) \
639 ({ RTA_APPEND(skb, RTA_ALIGN(attrlen), data); \
640 memset(skb_tail_pointer(skb) - (RTA_ALIGN(attrlen) - attrlen), 0, \
641 RTA_ALIGN(attrlen) - attrlen); })
643 #define RTA_PUT_U8(skb, attrtype, value) \
644 ({ u8 _tmp = (value); \
645 RTA_PUT(skb, attrtype, sizeof(u8), &_tmp); })
647 #define RTA_PUT_U16(skb, attrtype, value) \
648 ({ u16 _tmp = (value); \
649 RTA_PUT(skb, attrtype, sizeof(u16), &_tmp); })
651 #define RTA_PUT_U32(skb, attrtype, value) \
652 ({ u32 _tmp = (value); \
653 RTA_PUT(skb, attrtype, sizeof(u32), &_tmp); })
655 #define RTA_PUT_U64(skb, attrtype, value) \
656 ({ u64 _tmp = (value); \
657 RTA_PUT(skb, attrtype, sizeof(u64), &_tmp); })
659 #define RTA_PUT_SECS(skb, attrtype, value) \
660 RTA_PUT_U64(skb, attrtype, (value) / HZ)
662 #define RTA_PUT_MSECS(skb, attrtype, value) \
663 RTA_PUT_U64(skb, attrtype, jiffies_to_msecs(value))
665 #define RTA_PUT_STRING(skb, attrtype, value) \
666 RTA_PUT(skb, attrtype, strlen(value) + 1, value)
668 #define RTA_PUT_FLAG(skb, attrtype) \
669 RTA_PUT(skb, attrtype, 0, NULL);
671 #define RTA_NEST(skb, type) \
672 ({ struct rtattr *__start = (struct rtattr *)skb_tail_pointer(skb); \
673 RTA_PUT(skb, type, 0, NULL); \
676 #define RTA_NEST_END(skb, start) \
677 ({ (start)->rta_len = skb_tail_pointer(skb) - (unsigned char *)(start); \
680 #define RTA_NEST_COMPAT(skb, type, attrlen, data) \
681 ({ struct rtattr *__start = (struct rtattr *)skb_tail_pointer(skb); \
682 RTA_PUT(skb, type, attrlen, data); \
683 RTA_NEST(skb, type); \
686 #define RTA_NEST_COMPAT_END(skb, start) \
687 ({ struct rtattr *__nest = (void *)(start) + NLMSG_ALIGN((start)->rta_len); \
688 (start)->rta_len = skb_tail_pointer(skb) - (unsigned char *)(start); \
689 RTA_NEST_END(skb, __nest); \
692 #define RTA_NEST_CANCEL(skb, start) \
694 skb_trim(skb, (unsigned char *) (start) - (skb)->data); \
697 #define RTA_GET_U8(rta) \
698 ({ if (!rta || RTA_PAYLOAD(rta) < sizeof(u8)) \
699 goto rtattr_failure; \
700 *(u8 *) RTA_DATA(rta); })
702 #define RTA_GET_U16(rta) \
703 ({ if (!rta || RTA_PAYLOAD(rta) < sizeof(u16)) \
704 goto rtattr_failure; \
705 *(u16 *) RTA_DATA(rta); })
707 #define RTA_GET_U32(rta) \
708 ({ if (!rta || RTA_PAYLOAD(rta) < sizeof(u32)) \
709 goto rtattr_failure; \
710 *(u32 *) RTA_DATA(rta); })
712 #define RTA_GET_U64(rta) \
714 if (!rta || RTA_PAYLOAD(rta) < sizeof(u64)) \
715 goto rtattr_failure; \
716 memcpy(&_tmp, RTA_DATA(rta), sizeof(_tmp)); \
719 #define RTA_GET_FLAG(rta) (!!(rta))
721 #define RTA_GET_SECS(rta) ((unsigned long) RTA_GET_U64(rta) * HZ)
722 #define RTA_GET_MSECS(rta) (msecs_to_jiffies((unsigned long) RTA_GET_U64(rta)))
724 static inline struct rtattr *
725 __rta_reserve(struct sk_buff *skb, int attrtype, int attrlen)
728 int size = RTA_LENGTH(attrlen);
730 rta = (struct rtattr*)skb_put(skb, RTA_ALIGN(size));
731 rta->rta_type = attrtype;
733 memset(RTA_DATA(rta) + attrlen, 0, RTA_ALIGN(size) - size);
737 #define __RTA_PUT(skb, attrtype, attrlen) \
738 ({ if (unlikely(skb_tailroom(skb) < (int)RTA_SPACE(attrlen))) \
739 goto rtattr_failure; \
740 __rta_reserve(skb, attrtype, attrlen); })
742 extern void rtmsg_ifinfo(int type, struct net_device *dev, unsigned change);
744 /* RTNL is used as a global lock for all changes to network configuration */
745 extern void rtnl_lock(void);
746 extern void rtnl_unlock(void);
747 extern int rtnl_trylock(void);
749 extern void rtnetlink_init(void);
750 extern void __rtnl_unlock(void);
752 #define ASSERT_RTNL() do { \
753 if (unlikely(rtnl_trylock())) { \
755 printk(KERN_ERR "RTNL: assertion failed at %s (%d)\n", \
756 __FILE__, __LINE__); \
761 #define BUG_TRAP(x) do { \
762 if (unlikely(!(x))) { \
763 printk(KERN_ERR "KERNEL: assertion (%s) failed at %s (%d)\n", \
764 #x, __FILE__ , __LINE__); \
768 static inline u32 rtm_get_table(struct rtattr **rta, u8 table)
770 return RTA_GET_U32(rta[RTA_TABLE-1]);
775 #endif /* __KERNEL__ */
778 #endif /* __LINUX_RTNETLINK_H */