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>
11 * Routing/neighbour discovery messages.
14 /* Types of messages */
18 #define RTM_BASE RTM_BASE
21 #define RTM_NEWLINK RTM_NEWLINK
23 #define RTM_DELLINK RTM_DELLINK
25 #define RTM_GETLINK RTM_GETLINK
27 #define RTM_SETLINK RTM_SETLINK
30 #define RTM_NEWADDR RTM_NEWADDR
32 #define RTM_DELADDR RTM_DELADDR
34 #define RTM_GETADDR RTM_GETADDR
37 #define RTM_NEWROUTE RTM_NEWROUTE
39 #define RTM_DELROUTE RTM_DELROUTE
41 #define RTM_GETROUTE RTM_GETROUTE
44 #define RTM_NEWNEIGH RTM_NEWNEIGH
46 #define RTM_DELNEIGH RTM_DELNEIGH
48 #define RTM_GETNEIGH RTM_GETNEIGH
51 #define RTM_NEWRULE RTM_NEWRULE
53 #define RTM_DELRULE RTM_DELRULE
55 #define RTM_GETRULE RTM_GETRULE
58 #define RTM_NEWQDISC RTM_NEWQDISC
60 #define RTM_DELQDISC RTM_DELQDISC
62 #define RTM_GETQDISC RTM_GETQDISC
65 #define RTM_NEWTCLASS RTM_NEWTCLASS
67 #define RTM_DELTCLASS RTM_DELTCLASS
69 #define RTM_GETTCLASS RTM_GETTCLASS
72 #define RTM_NEWTFILTER RTM_NEWTFILTER
74 #define RTM_DELTFILTER RTM_DELTFILTER
76 #define RTM_GETTFILTER RTM_GETTFILTER
79 #define RTM_NEWACTION RTM_NEWACTION
81 #define RTM_DELACTION RTM_DELACTION
83 #define RTM_GETACTION RTM_GETACTION
86 #define RTM_NEWPREFIX RTM_NEWPREFIX
88 RTM_GETMULTICAST = 58,
89 #define RTM_GETMULTICAST RTM_GETMULTICAST
92 #define RTM_GETANYCAST RTM_GETANYCAST
95 #define RTM_NEWNEIGHTBL RTM_NEWNEIGHTBL
97 #define RTM_GETNEIGHTBL RTM_GETNEIGHTBL
99 #define RTM_SETNEIGHTBL RTM_SETNEIGHTBL
101 RTM_NEWNDUSEROPT = 68,
102 #define RTM_NEWNDUSEROPT RTM_NEWNDUSEROPT
104 RTM_NEWADDRLABEL = 72,
105 #define RTM_NEWADDRLABEL RTM_NEWADDRLABEL
107 #define RTM_NEWADDRLABEL RTM_NEWADDRLABEL
109 #define RTM_GETADDRLABEL RTM_GETADDRLABEL
112 #define RTM_GETDCB RTM_GETDCB
114 #define RTM_SETDCB RTM_SETDCB
117 #define RTM_MAX (((__RTM_MAX + 3) & ~3) - 1)
120 #define RTM_NR_MSGTYPES (RTM_MAX + 1 - RTM_BASE)
121 #define RTM_NR_FAMILIES (RTM_NR_MSGTYPES >> 2)
122 #define RTM_FAM(cmd) (((cmd) - RTM_BASE) >> 2)
125 Generic structure for encapsulation of optional route information.
126 It is reminiscent of sockaddr, but with sa_family replaced
132 unsigned short rta_len;
133 unsigned short rta_type;
136 /* Macros to handle rtattributes */
138 #define RTA_ALIGNTO 4
139 #define RTA_ALIGN(len) ( ((len)+RTA_ALIGNTO-1) & ~(RTA_ALIGNTO-1) )
140 #define RTA_OK(rta,len) ((len) >= (int)sizeof(struct rtattr) && \
141 (rta)->rta_len >= sizeof(struct rtattr) && \
142 (rta)->rta_len <= (len))
143 #define RTA_NEXT(rta,attrlen) ((attrlen) -= RTA_ALIGN((rta)->rta_len), \
144 (struct rtattr*)(((char*)(rta)) + RTA_ALIGN((rta)->rta_len)))
145 #define RTA_LENGTH(len) (RTA_ALIGN(sizeof(struct rtattr)) + (len))
146 #define RTA_SPACE(len) RTA_ALIGN(RTA_LENGTH(len))
147 #define RTA_DATA(rta) ((void*)(((char*)(rta)) + RTA_LENGTH(0)))
148 #define RTA_PAYLOAD(rta) ((int)((rta)->rta_len) - RTA_LENGTH(0))
153 /******************************************************************************
154 * Definitions used in routing table administration.
159 unsigned char rtm_family;
160 unsigned char rtm_dst_len;
161 unsigned char rtm_src_len;
162 unsigned char rtm_tos;
164 unsigned char rtm_table; /* Routing table id */
165 unsigned char rtm_protocol; /* Routing protocol; see below */
166 unsigned char rtm_scope; /* See below */
167 unsigned char rtm_type; /* See below */
177 RTN_UNICAST, /* Gateway or direct route */
178 RTN_LOCAL, /* Accept locally */
179 RTN_BROADCAST, /* Accept locally as broadcast,
181 RTN_ANYCAST, /* Accept locally as broadcast,
182 but send as unicast */
183 RTN_MULTICAST, /* Multicast route */
184 RTN_BLACKHOLE, /* Drop */
185 RTN_UNREACHABLE, /* Destination is unreachable */
186 RTN_PROHIBIT, /* Administratively prohibited */
187 RTN_THROW, /* Not in this table */
188 RTN_NAT, /* Translate this address */
189 RTN_XRESOLVE, /* Use external resolver */
193 #define RTN_MAX (__RTN_MAX - 1)
198 #define RTPROT_UNSPEC 0
199 #define RTPROT_REDIRECT 1 /* Route installed by ICMP redirects;
200 not used by current IPv4 */
201 #define RTPROT_KERNEL 2 /* Route installed by kernel */
202 #define RTPROT_BOOT 3 /* Route installed during boot */
203 #define RTPROT_STATIC 4 /* Route installed by administrator */
205 /* Values of protocol >= RTPROT_STATIC are not interpreted by kernel;
206 they are just passed from user and back as is.
207 It will be used by hypothetical multiple routing daemons.
208 Note that protocol values should be standardized in order to
212 #define RTPROT_GATED 8 /* Apparently, GateD */
213 #define RTPROT_RA 9 /* RDISC/ND router advertisements */
214 #define RTPROT_MRT 10 /* Merit MRT */
215 #define RTPROT_ZEBRA 11 /* Zebra */
216 #define RTPROT_BIRD 12 /* BIRD */
217 #define RTPROT_DNROUTED 13 /* DECnet routing daemon */
218 #define RTPROT_XORP 14 /* XORP */
219 #define RTPROT_NTK 15 /* Netsukuku */
223 Really it is not scope, but sort of distance to the destination.
224 NOWHERE are reserved for not existing destinations, HOST is our
225 local addresses, LINK are destinations, located on directly attached
226 link and UNIVERSE is everywhere in the Universe.
228 Intermediate values are also possible f.e. interior routes
229 could be assigned a value between UNIVERSE and LINK.
235 /* User defined values */
244 #define RTM_F_NOTIFY 0x100 /* Notify user of route change */
245 #define RTM_F_CLONED 0x200 /* This route is cloned */
246 #define RTM_F_EQUALIZE 0x400 /* Multipath equalizer: NI */
247 #define RTM_F_PREFIX 0x800 /* Prefix addresses */
249 /* Reserved table identifiers */
254 /* User defined values */
256 RT_TABLE_DEFAULT=253,
259 RT_TABLE_MAX=0xFFFFFFFF
263 /* Routing message attributes */
277 RTA_PROTOINFO, /* no longer used */
280 RTA_SESSION, /* no longer used */
281 RTA_MP_ALGO, /* no longer used */
286 #define RTA_MAX (__RTA_MAX - 1)
288 #define RTM_RTA(r) ((struct rtattr*)(((char*)(r)) + NLMSG_ALIGN(sizeof(struct rtmsg))))
289 #define RTM_PAYLOAD(n) NLMSG_PAYLOAD(n,sizeof(struct rtmsg))
291 /* RTM_MULTIPATH --- array of struct rtnexthop.
293 * "struct rtnexthop" describes all necessary nexthop information,
294 * i.e. parameters of path to a destination via this nexthop.
296 * At the moment it is impossible to set different prefsrc, mtu, window
297 * 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)))
335 #define RTNETLINK_HAVE_PEERINFO 1
341 /* RTM_METRICS --- array of struct rtattr with types of RTAX_* */
346 #define RTAX_UNSPEC RTAX_UNSPEC
348 #define RTAX_LOCK RTAX_LOCK
350 #define RTAX_MTU RTAX_MTU
352 #define RTAX_WINDOW RTAX_WINDOW
354 #define RTAX_RTT RTAX_RTT
356 #define RTAX_RTTVAR RTAX_RTTVAR
358 #define RTAX_SSTHRESH RTAX_SSTHRESH
360 #define RTAX_CWND RTAX_CWND
362 #define RTAX_ADVMSS RTAX_ADVMSS
364 #define RTAX_REORDERING RTAX_REORDERING
366 #define RTAX_HOPLIMIT RTAX_HOPLIMIT
368 #define RTAX_INITCWND RTAX_INITCWND
370 #define RTAX_FEATURES RTAX_FEATURES
372 #define RTAX_RTO_MIN RTAX_RTO_MIN
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
406 * General form of address family dependent message.
411 unsigned char rtgen_family;
414 /*****************************************************************
415 * Link layer specific messages.
419 * passes link level specific information, not dependent
420 * on network protocol.
425 unsigned char ifi_family;
426 unsigned char __ifi_pad;
427 unsigned short ifi_type; /* ARPHRD_* */
428 int ifi_index; /* Link index */
429 unsigned ifi_flags; /* IFF_* flags */
430 unsigned ifi_change; /* IFF_* change mask */
433 /********************************************************************
439 unsigned char prefix_family;
440 unsigned char prefix_pad1;
441 unsigned short prefix_pad2;
443 unsigned char prefix_type;
444 unsigned char prefix_len;
445 unsigned char prefix_flags;
446 unsigned char prefix_pad3;
457 #define PREFIX_MAX (__PREFIX_MAX - 1)
459 struct prefix_cacheinfo
461 __u32 preferred_time;
466 /*****************************************************************
467 * Traffic control messages.
472 unsigned char tcm_family;
473 unsigned char tcm__pad1;
474 unsigned short tcm__pad2;
495 #define TCA_MAX (__TCA_MAX - 1)
497 #define TCA_RTA(r) ((struct rtattr*)(((char*)(r)) + NLMSG_ALIGN(sizeof(struct tcmsg))))
498 #define TCA_PAYLOAD(n) NLMSG_PAYLOAD(n,sizeof(struct tcmsg))
500 /********************************************************************
501 * Neighbor Discovery userland options
506 unsigned char nduseropt_family;
507 unsigned char nduseropt_pad1;
508 unsigned short nduseropt_opts_len; /* Total length of options */
509 int nduseropt_ifindex;
510 __u8 nduseropt_icmp_type;
511 __u8 nduseropt_icmp_code;
512 unsigned short nduseropt_pad2;
513 unsigned int nduseropt_pad3;
514 /* Followed by one or more ND options */
524 #define NDUSEROPT_MAX (__NDUSEROPT_MAX - 1)
527 /* RTnetlink multicast groups - backwards compatibility for userspace */
528 #define RTMGRP_LINK 1
529 #define RTMGRP_NOTIFY 2
530 #define RTMGRP_NEIGH 4
533 #define RTMGRP_IPV4_IFADDR 0x10
534 #define RTMGRP_IPV4_MROUTE 0x20
535 #define RTMGRP_IPV4_ROUTE 0x40
536 #define RTMGRP_IPV4_RULE 0x80
538 #define RTMGRP_IPV6_IFADDR 0x100
539 #define RTMGRP_IPV6_MROUTE 0x200
540 #define RTMGRP_IPV6_ROUTE 0x400
541 #define RTMGRP_IPV6_IFINFO 0x800
543 #define RTMGRP_DECnet_IFADDR 0x1000
544 #define RTMGRP_DECnet_ROUTE 0x4000
546 #define RTMGRP_IPV6_PREFIX 0x20000
549 /* RTnetlink multicast groups */
550 enum rtnetlink_groups {
552 #define RTNLGRP_NONE RTNLGRP_NONE
554 #define RTNLGRP_LINK RTNLGRP_LINK
556 #define RTNLGRP_NOTIFY RTNLGRP_NOTIFY
558 #define RTNLGRP_NEIGH RTNLGRP_NEIGH
560 #define RTNLGRP_TC RTNLGRP_TC
562 #define RTNLGRP_IPV4_IFADDR RTNLGRP_IPV4_IFADDR
564 #define RTNLGRP_IPV4_MROUTE RTNLGRP_IPV4_MROUTE
566 #define RTNLGRP_IPV4_ROUTE RTNLGRP_IPV4_ROUTE
568 #define RTNLGRP_IPV4_RULE RTNLGRP_IPV4_RULE
570 #define RTNLGRP_IPV6_IFADDR RTNLGRP_IPV6_IFADDR
572 #define RTNLGRP_IPV6_MROUTE RTNLGRP_IPV6_MROUTE
574 #define RTNLGRP_IPV6_ROUTE RTNLGRP_IPV6_ROUTE
576 #define RTNLGRP_IPV6_IFINFO RTNLGRP_IPV6_IFINFO
577 RTNLGRP_DECnet_IFADDR,
578 #define RTNLGRP_DECnet_IFADDR RTNLGRP_DECnet_IFADDR
580 RTNLGRP_DECnet_ROUTE,
581 #define RTNLGRP_DECnet_ROUTE RTNLGRP_DECnet_ROUTE
583 #define RTNLGRP_DECnet_RULE RTNLGRP_DECnet_RULE
586 #define RTNLGRP_IPV6_PREFIX RTNLGRP_IPV6_PREFIX
588 #define RTNLGRP_IPV6_RULE RTNLGRP_IPV6_RULE
590 #define RTNLGRP_ND_USEROPT RTNLGRP_ND_USEROPT
591 RTNLGRP_PHONET_IFADDR,
592 #define RTNLGRP_PHONET_IFADDR RTNLGRP_PHONET_IFADDR
593 RTNLGRP_PHONET_ROUTE,
594 #define RTNLGRP_PHONET_ROUTE RTNLGRP_PHONET_ROUTE
597 #define RTNLGRP_MAX (__RTNLGRP_MAX - 1)
599 /* TC action piece */
602 unsigned char tca_family;
603 unsigned char tca__pad1;
604 unsigned short tca__pad2;
606 #define TA_RTA(r) ((struct rtattr*)(((char*)(r)) + NLMSG_ALIGN(sizeof(struct tcamsg))))
607 #define TA_PAYLOAD(n) NLMSG_PAYLOAD(n,sizeof(struct tcamsg))
608 #define TCA_ACT_TAB 1 /* attr type must be >=1 */
611 /* End of information exported to user level */
615 #include <linux/mutex.h>
617 static __inline__ int rtattr_strcmp(const struct rtattr *rta, const char *str)
619 int len = strlen(str) + 1;
620 return len > rta->rta_len || memcmp(RTA_DATA(rta), str, len);
623 extern int rtnetlink_send(struct sk_buff *skb, struct net *net, u32 pid, u32 group, int echo);
624 extern int rtnl_unicast(struct sk_buff *skb, struct net *net, u32 pid);
625 extern int rtnl_notify(struct sk_buff *skb, struct net *net, u32 pid, u32 group,
626 struct nlmsghdr *nlh, gfp_t flags);
627 extern void rtnl_set_sk_err(struct net *net, u32 group, int error);
628 extern int rtnetlink_put_metrics(struct sk_buff *skb, u32 *metrics);
629 extern int rtnl_put_cacheinfo(struct sk_buff *skb, struct dst_entry *dst,
630 u32 id, u32 ts, u32 tsage, long expires,
633 extern void __rta_fill(struct sk_buff *skb, int attrtype, int attrlen, const void *data);
635 #define RTA_PUT(skb, attrtype, attrlen, data) \
636 ({ if (unlikely(skb_tailroom(skb) < (int)RTA_SPACE(attrlen))) \
637 goto rtattr_failure; \
638 __rta_fill(skb, attrtype, attrlen, data); })
640 #define RTA_APPEND(skb, attrlen, data) \
641 ({ if (unlikely(skb_tailroom(skb) < (int)(attrlen))) \
642 goto rtattr_failure; \
643 memcpy(skb_put(skb, attrlen), data, attrlen); })
645 #define RTA_PUT_NOHDR(skb, attrlen, data) \
646 ({ RTA_APPEND(skb, RTA_ALIGN(attrlen), data); \
647 memset(skb_tail_pointer(skb) - (RTA_ALIGN(attrlen) - attrlen), 0, \
648 RTA_ALIGN(attrlen) - attrlen); })
650 #define RTA_PUT_U8(skb, attrtype, value) \
651 ({ u8 _tmp = (value); \
652 RTA_PUT(skb, attrtype, sizeof(u8), &_tmp); })
654 #define RTA_PUT_U16(skb, attrtype, value) \
655 ({ u16 _tmp = (value); \
656 RTA_PUT(skb, attrtype, sizeof(u16), &_tmp); })
658 #define RTA_PUT_U32(skb, attrtype, value) \
659 ({ u32 _tmp = (value); \
660 RTA_PUT(skb, attrtype, sizeof(u32), &_tmp); })
662 #define RTA_PUT_U64(skb, attrtype, value) \
663 ({ u64 _tmp = (value); \
664 RTA_PUT(skb, attrtype, sizeof(u64), &_tmp); })
666 #define RTA_PUT_SECS(skb, attrtype, value) \
667 RTA_PUT_U64(skb, attrtype, (value) / HZ)
669 #define RTA_PUT_MSECS(skb, attrtype, value) \
670 RTA_PUT_U64(skb, attrtype, jiffies_to_msecs(value))
672 #define RTA_PUT_STRING(skb, attrtype, value) \
673 RTA_PUT(skb, attrtype, strlen(value) + 1, value)
675 #define RTA_PUT_FLAG(skb, attrtype) \
676 RTA_PUT(skb, attrtype, 0, NULL);
678 #define RTA_NEST(skb, type) \
679 ({ struct rtattr *__start = (struct rtattr *)skb_tail_pointer(skb); \
680 RTA_PUT(skb, type, 0, NULL); \
683 #define RTA_NEST_END(skb, start) \
684 ({ (start)->rta_len = skb_tail_pointer(skb) - (unsigned char *)(start); \
687 #define RTA_NEST_COMPAT(skb, type, attrlen, data) \
688 ({ struct rtattr *__start = (struct rtattr *)skb_tail_pointer(skb); \
689 RTA_PUT(skb, type, attrlen, data); \
690 RTA_NEST(skb, type); \
693 #define RTA_NEST_COMPAT_END(skb, start) \
694 ({ struct rtattr *__nest = (void *)(start) + NLMSG_ALIGN((start)->rta_len); \
695 (start)->rta_len = skb_tail_pointer(skb) - (unsigned char *)(start); \
696 RTA_NEST_END(skb, __nest); \
699 #define RTA_NEST_CANCEL(skb, start) \
701 skb_trim(skb, (unsigned char *) (start) - (skb)->data); \
704 #define RTA_GET_U8(rta) \
705 ({ if (!rta || RTA_PAYLOAD(rta) < sizeof(u8)) \
706 goto rtattr_failure; \
707 *(u8 *) RTA_DATA(rta); })
709 #define RTA_GET_U16(rta) \
710 ({ if (!rta || RTA_PAYLOAD(rta) < sizeof(u16)) \
711 goto rtattr_failure; \
712 *(u16 *) RTA_DATA(rta); })
714 #define RTA_GET_U32(rta) \
715 ({ if (!rta || RTA_PAYLOAD(rta) < sizeof(u32)) \
716 goto rtattr_failure; \
717 *(u32 *) RTA_DATA(rta); })
719 #define RTA_GET_U64(rta) \
721 if (!rta || RTA_PAYLOAD(rta) < sizeof(u64)) \
722 goto rtattr_failure; \
723 memcpy(&_tmp, RTA_DATA(rta), sizeof(_tmp)); \
726 #define RTA_GET_FLAG(rta) (!!(rta))
728 #define RTA_GET_SECS(rta) ((unsigned long) RTA_GET_U64(rta) * HZ)
729 #define RTA_GET_MSECS(rta) (msecs_to_jiffies((unsigned long) RTA_GET_U64(rta)))
731 static inline struct rtattr *
732 __rta_reserve(struct sk_buff *skb, int attrtype, int attrlen)
735 int size = RTA_LENGTH(attrlen);
737 rta = (struct rtattr*)skb_put(skb, RTA_ALIGN(size));
738 rta->rta_type = attrtype;
740 memset(RTA_DATA(rta) + attrlen, 0, RTA_ALIGN(size) - size);
744 #define __RTA_PUT(skb, attrtype, attrlen) \
745 ({ if (unlikely(skb_tailroom(skb) < (int)RTA_SPACE(attrlen))) \
746 goto rtattr_failure; \
747 __rta_reserve(skb, attrtype, attrlen); })
749 extern void rtmsg_ifinfo(int type, struct net_device *dev, unsigned change);
751 /* RTNL is used as a global lock for all changes to network configuration */
752 extern void rtnl_lock(void);
753 extern void rtnl_unlock(void);
754 extern int rtnl_trylock(void);
755 extern int rtnl_is_locked(void);
757 extern void rtnetlink_init(void);
758 extern void __rtnl_unlock(void);
760 #define ASSERT_RTNL() do { \
761 if (unlikely(!rtnl_is_locked())) { \
762 printk(KERN_ERR "RTNL: assertion failed at %s (%d)\n", \
763 __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 */