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
103 RTM_NEWADDRLABEL = 72,
104 #define RTM_NEWADDRLABEL RTM_NEWADDRLABEL
106 #define RTM_NEWADDRLABEL RTM_NEWADDRLABEL
108 #define RTM_GETADDRLABEL RTM_GETADDRLABEL
111 #define RTM_MAX (((__RTM_MAX + 3) & ~3) - 1)
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)
119 Generic structure for encapsulation of optional route information.
120 It is reminiscent of sockaddr, but with sa_family replaced
126 unsigned short rta_len;
127 unsigned short rta_type;
130 /* Macros to handle rtattributes */
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))
147 /******************************************************************************
148 * Definitions used in routing table administration.
153 unsigned char rtm_family;
154 unsigned char rtm_dst_len;
155 unsigned char rtm_src_len;
156 unsigned char rtm_tos;
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 */
171 RTN_UNICAST, /* Gateway or direct route */
172 RTN_LOCAL, /* Accept locally */
173 RTN_BROADCAST, /* Accept locally 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 */
187 #define RTN_MAX (__RTN_MAX - 1)
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 */
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
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 */
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.
222 Intermediate values are also possible f.e. interior routes
223 could be assigned a value between UNIVERSE and LINK.
229 /* User defined values */
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 */
243 /* Reserved table identifiers */
248 /* User defined values */
249 RT_TABLE_DEFAULT=253,
252 RT_TABLE_MAX=0xFFFFFFFF
256 /* Routing message attributes */
274 RTA_MP_ALGO, /* no longer used */
279 #define RTA_MAX (__RTA_MAX - 1)
281 #define RTM_RTA(r) ((struct rtattr*)(((char*)(r)) + NLMSG_ALIGN(sizeof(struct rtmsg))))
282 #define RTM_PAYLOAD(n) NLMSG_PAYLOAD(n,sizeof(struct rtmsg))
284 /* RTM_MULTIPATH --- array of struct rtnexthop.
286 * "struct rtnexthop" describes all necessary nexthop information,
287 * i.e. parameters of path to a destination via this nexthop.
289 * At the moment it is impossible to set different prefsrc, mtu, window
290 * and rtt for different paths from multipath.
295 unsigned short rtnh_len;
296 unsigned char rtnh_flags;
297 unsigned char rtnh_hops;
303 #define RTNH_F_DEAD 1 /* Nexthop is dead (used by multipath) */
304 #define RTNH_F_PERVASIVE 2 /* Do recursive gateway lookup */
305 #define RTNH_F_ONLINK 4 /* Gateway is forced on link */
307 /* Macros to handle hexthops */
309 #define RTNH_ALIGNTO 4
310 #define RTNH_ALIGN(len) ( ((len)+RTNH_ALIGNTO-1) & ~(RTNH_ALIGNTO-1) )
311 #define RTNH_OK(rtnh,len) ((rtnh)->rtnh_len >= sizeof(struct rtnexthop) && \
312 ((int)(rtnh)->rtnh_len) <= (len))
313 #define RTNH_NEXT(rtnh) ((struct rtnexthop*)(((char*)(rtnh)) + RTNH_ALIGN((rtnh)->rtnh_len)))
314 #define RTNH_LENGTH(len) (RTNH_ALIGN(sizeof(struct rtnexthop)) + (len))
315 #define RTNH_SPACE(len) RTNH_ALIGN(RTNH_LENGTH(len))
316 #define RTNH_DATA(rtnh) ((struct rtattr*)(((char*)(rtnh)) + RTNH_LENGTH(0)))
328 #define RTNETLINK_HAVE_PEERINFO 1
334 /* RTM_METRICS --- array of struct rtattr with types of RTAX_* */
339 #define RTAX_UNSPEC RTAX_UNSPEC
341 #define RTAX_LOCK RTAX_LOCK
343 #define RTAX_MTU RTAX_MTU
345 #define RTAX_WINDOW RTAX_WINDOW
347 #define RTAX_RTT RTAX_RTT
349 #define RTAX_RTTVAR RTAX_RTTVAR
351 #define RTAX_SSTHRESH RTAX_SSTHRESH
353 #define RTAX_CWND RTAX_CWND
355 #define RTAX_ADVMSS RTAX_ADVMSS
357 #define RTAX_REORDERING RTAX_REORDERING
359 #define RTAX_HOPLIMIT RTAX_HOPLIMIT
361 #define RTAX_INITCWND RTAX_INITCWND
363 #define RTAX_FEATURES RTAX_FEATURES
365 #define RTAX_RTO_MIN RTAX_RTO_MIN
369 #define RTAX_MAX (__RTAX_MAX - 1)
371 #define RTAX_FEATURE_ECN 0x00000001
372 #define RTAX_FEATURE_SACK 0x00000002
373 #define RTAX_FEATURE_TIMESTAMP 0x00000004
374 #define RTAX_FEATURE_ALLFRAG 0x00000008
399 * General form of address family dependent message.
404 unsigned char rtgen_family;
407 /*****************************************************************
408 * Link layer specific messages.
412 * passes link level specific information, not dependent
413 * on network protocol.
418 unsigned char ifi_family;
419 unsigned char __ifi_pad;
420 unsigned short ifi_type; /* ARPHRD_* */
421 int ifi_index; /* Link index */
422 unsigned ifi_flags; /* IFF_* flags */
423 unsigned ifi_change; /* IFF_* change mask */
426 /********************************************************************
432 unsigned char prefix_family;
433 unsigned char prefix_pad1;
434 unsigned short prefix_pad2;
436 unsigned char prefix_type;
437 unsigned char prefix_len;
438 unsigned char prefix_flags;
439 unsigned char prefix_pad3;
450 #define PREFIX_MAX (__PREFIX_MAX - 1)
452 struct prefix_cacheinfo
454 __u32 preferred_time;
459 /*****************************************************************
460 * Traffic control messages.
465 unsigned char tcm_family;
466 unsigned char tcm__pad1;
467 unsigned short tcm__pad2;
487 #define TCA_MAX (__TCA_MAX - 1)
489 #define TCA_RTA(r) ((struct rtattr*)(((char*)(r)) + NLMSG_ALIGN(sizeof(struct tcmsg))))
490 #define TCA_PAYLOAD(n) NLMSG_PAYLOAD(n,sizeof(struct tcmsg))
492 /********************************************************************
493 * Neighbor Discovery userland options
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 */
516 #define NDUSEROPT_MAX (__NDUSEROPT_MAX - 1)
519 /* RTnetlink multicast groups - backwards compatibility for userspace */
520 #define RTMGRP_LINK 1
521 #define RTMGRP_NOTIFY 2
522 #define RTMGRP_NEIGH 4
525 #define RTMGRP_IPV4_IFADDR 0x10
526 #define RTMGRP_IPV4_MROUTE 0x20
527 #define RTMGRP_IPV4_ROUTE 0x40
528 #define RTMGRP_IPV4_RULE 0x80
530 #define RTMGRP_IPV6_IFADDR 0x100
531 #define RTMGRP_IPV6_MROUTE 0x200
532 #define RTMGRP_IPV6_ROUTE 0x400
533 #define RTMGRP_IPV6_IFINFO 0x800
535 #define RTMGRP_DECnet_IFADDR 0x1000
536 #define RTMGRP_DECnet_ROUTE 0x4000
538 #define RTMGRP_IPV6_PREFIX 0x20000
541 /* RTnetlink multicast groups */
542 enum rtnetlink_groups {
544 #define RTNLGRP_NONE RTNLGRP_NONE
546 #define RTNLGRP_LINK RTNLGRP_LINK
548 #define RTNLGRP_NOTIFY RTNLGRP_NOTIFY
550 #define RTNLGRP_NEIGH RTNLGRP_NEIGH
552 #define RTNLGRP_TC RTNLGRP_TC
554 #define RTNLGRP_IPV4_IFADDR RTNLGRP_IPV4_IFADDR
556 #define RTNLGRP_IPV4_MROUTE RTNLGRP_IPV4_MROUTE
558 #define RTNLGRP_IPV4_ROUTE RTNLGRP_IPV4_ROUTE
560 #define RTNLGRP_IPV4_RULE RTNLGRP_IPV4_RULE
562 #define RTNLGRP_IPV6_IFADDR RTNLGRP_IPV6_IFADDR
564 #define RTNLGRP_IPV6_MROUTE RTNLGRP_IPV6_MROUTE
566 #define RTNLGRP_IPV6_ROUTE RTNLGRP_IPV6_ROUTE
568 #define RTNLGRP_IPV6_IFINFO RTNLGRP_IPV6_IFINFO
569 RTNLGRP_DECnet_IFADDR,
570 #define RTNLGRP_DECnet_IFADDR RTNLGRP_DECnet_IFADDR
572 RTNLGRP_DECnet_ROUTE,
573 #define RTNLGRP_DECnet_ROUTE RTNLGRP_DECnet_ROUTE
575 #define RTNLGRP_DECnet_RULE RTNLGRP_DECnet_RULE
578 #define RTNLGRP_IPV6_PREFIX RTNLGRP_IPV6_PREFIX
580 #define RTNLGRP_IPV6_RULE RTNLGRP_IPV6_RULE
582 #define RTNLGRP_ND_USEROPT RTNLGRP_ND_USEROPT
585 #define RTNLGRP_MAX (__RTNLGRP_MAX - 1)
587 /* TC action piece */
590 unsigned char tca_family;
591 unsigned char tca__pad1;
592 unsigned short tca__pad2;
594 #define TA_RTA(r) ((struct rtattr*)(((char*)(r)) + NLMSG_ALIGN(sizeof(struct tcamsg))))
595 #define TA_PAYLOAD(n) NLMSG_PAYLOAD(n,sizeof(struct tcamsg))
596 #define TCA_ACT_TAB 1 /* attr type must be >=1 */
599 /* End of information exported to user level */
603 #include <linux/mutex.h>
605 static __inline__ int rtattr_strcmp(const struct rtattr *rta, const char *str)
607 int len = strlen(str) + 1;
608 return len > rta->rta_len || memcmp(RTA_DATA(rta), str, len);
611 extern int rtnetlink_send(struct sk_buff *skb, struct net *net, u32 pid, u32 group, int echo);
612 extern int rtnl_unicast(struct sk_buff *skb, struct net *net, u32 pid);
613 extern int rtnl_notify(struct sk_buff *skb, struct net *net, u32 pid, u32 group,
614 struct nlmsghdr *nlh, gfp_t flags);
615 extern void rtnl_set_sk_err(struct net *net, u32 group, int error);
616 extern int rtnetlink_put_metrics(struct sk_buff *skb, u32 *metrics);
617 extern int rtnl_put_cacheinfo(struct sk_buff *skb, struct dst_entry *dst,
618 u32 id, u32 ts, u32 tsage, long expires,
621 extern void __rta_fill(struct sk_buff *skb, int attrtype, int attrlen, const void *data);
623 #define RTA_PUT(skb, attrtype, attrlen, data) \
624 ({ if (unlikely(skb_tailroom(skb) < (int)RTA_SPACE(attrlen))) \
625 goto rtattr_failure; \
626 __rta_fill(skb, attrtype, attrlen, data); })
628 #define RTA_APPEND(skb, attrlen, data) \
629 ({ if (unlikely(skb_tailroom(skb) < (int)(attrlen))) \
630 goto rtattr_failure; \
631 memcpy(skb_put(skb, attrlen), data, attrlen); })
633 #define RTA_PUT_NOHDR(skb, attrlen, data) \
634 ({ RTA_APPEND(skb, RTA_ALIGN(attrlen), data); \
635 memset(skb_tail_pointer(skb) - (RTA_ALIGN(attrlen) - attrlen), 0, \
636 RTA_ALIGN(attrlen) - attrlen); })
638 #define RTA_PUT_U8(skb, attrtype, value) \
639 ({ u8 _tmp = (value); \
640 RTA_PUT(skb, attrtype, sizeof(u8), &_tmp); })
642 #define RTA_PUT_U16(skb, attrtype, value) \
643 ({ u16 _tmp = (value); \
644 RTA_PUT(skb, attrtype, sizeof(u16), &_tmp); })
646 #define RTA_PUT_U32(skb, attrtype, value) \
647 ({ u32 _tmp = (value); \
648 RTA_PUT(skb, attrtype, sizeof(u32), &_tmp); })
650 #define RTA_PUT_U64(skb, attrtype, value) \
651 ({ u64 _tmp = (value); \
652 RTA_PUT(skb, attrtype, sizeof(u64), &_tmp); })
654 #define RTA_PUT_SECS(skb, attrtype, value) \
655 RTA_PUT_U64(skb, attrtype, (value) / HZ)
657 #define RTA_PUT_MSECS(skb, attrtype, value) \
658 RTA_PUT_U64(skb, attrtype, jiffies_to_msecs(value))
660 #define RTA_PUT_STRING(skb, attrtype, value) \
661 RTA_PUT(skb, attrtype, strlen(value) + 1, value)
663 #define RTA_PUT_FLAG(skb, attrtype) \
664 RTA_PUT(skb, attrtype, 0, NULL);
666 #define RTA_NEST(skb, type) \
667 ({ struct rtattr *__start = (struct rtattr *)skb_tail_pointer(skb); \
668 RTA_PUT(skb, type, 0, NULL); \
671 #define RTA_NEST_END(skb, start) \
672 ({ (start)->rta_len = skb_tail_pointer(skb) - (unsigned char *)(start); \
675 #define RTA_NEST_COMPAT(skb, type, attrlen, data) \
676 ({ struct rtattr *__start = (struct rtattr *)skb_tail_pointer(skb); \
677 RTA_PUT(skb, type, attrlen, data); \
678 RTA_NEST(skb, type); \
681 #define RTA_NEST_COMPAT_END(skb, start) \
682 ({ struct rtattr *__nest = (void *)(start) + NLMSG_ALIGN((start)->rta_len); \
683 (start)->rta_len = skb_tail_pointer(skb) - (unsigned char *)(start); \
684 RTA_NEST_END(skb, __nest); \
687 #define RTA_NEST_CANCEL(skb, start) \
689 skb_trim(skb, (unsigned char *) (start) - (skb)->data); \
692 #define RTA_GET_U8(rta) \
693 ({ if (!rta || RTA_PAYLOAD(rta) < sizeof(u8)) \
694 goto rtattr_failure; \
695 *(u8 *) RTA_DATA(rta); })
697 #define RTA_GET_U16(rta) \
698 ({ if (!rta || RTA_PAYLOAD(rta) < sizeof(u16)) \
699 goto rtattr_failure; \
700 *(u16 *) RTA_DATA(rta); })
702 #define RTA_GET_U32(rta) \
703 ({ if (!rta || RTA_PAYLOAD(rta) < sizeof(u32)) \
704 goto rtattr_failure; \
705 *(u32 *) RTA_DATA(rta); })
707 #define RTA_GET_U64(rta) \
709 if (!rta || RTA_PAYLOAD(rta) < sizeof(u64)) \
710 goto rtattr_failure; \
711 memcpy(&_tmp, RTA_DATA(rta), sizeof(_tmp)); \
714 #define RTA_GET_FLAG(rta) (!!(rta))
716 #define RTA_GET_SECS(rta) ((unsigned long) RTA_GET_U64(rta) * HZ)
717 #define RTA_GET_MSECS(rta) (msecs_to_jiffies((unsigned long) RTA_GET_U64(rta)))
719 static inline struct rtattr *
720 __rta_reserve(struct sk_buff *skb, int attrtype, int attrlen)
723 int size = RTA_LENGTH(attrlen);
725 rta = (struct rtattr*)skb_put(skb, RTA_ALIGN(size));
726 rta->rta_type = attrtype;
728 memset(RTA_DATA(rta) + attrlen, 0, RTA_ALIGN(size) - size);
732 #define __RTA_PUT(skb, attrtype, attrlen) \
733 ({ if (unlikely(skb_tailroom(skb) < (int)RTA_SPACE(attrlen))) \
734 goto rtattr_failure; \
735 __rta_reserve(skb, attrtype, attrlen); })
737 extern void rtmsg_ifinfo(int type, struct net_device *dev, unsigned change);
739 /* RTNL is used as a global lock for all changes to network configuration */
740 extern void rtnl_lock(void);
741 extern void rtnl_unlock(void);
742 extern int rtnl_trylock(void);
744 extern void rtnetlink_init(void);
745 extern void __rtnl_unlock(void);
747 #define ASSERT_RTNL() do { \
748 if (unlikely(rtnl_trylock())) { \
750 printk(KERN_ERR "RTNL: assertion failed at %s (%d)\n", \
751 __FILE__, __LINE__); \
756 #define BUG_TRAP(x) do { \
757 if (unlikely(!(x))) { \
758 printk(KERN_ERR "KERNEL: assertion (%s) failed at %s (%d)\n", \
759 #x, __FILE__ , __LINE__); \
763 static inline u32 rtm_get_table(struct rtattr **rta, u8 table)
765 return RTA_GET_U32(rta[RTA_TABLE-1]);
770 #endif /* __KERNEL__ */
773 #endif /* __LINUX_RTNETLINK_H */