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_DELADDRLABEL RTM_DELADDRLABEL
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 */
220 #define RTPROT_DHCP 16 /* DHCP client */
224 Really it is not scope, but sort of distance to the destination.
225 NOWHERE are reserved for not existing destinations, HOST is our
226 local addresses, LINK are destinations, located on directly attached
227 link and UNIVERSE is everywhere in the Universe.
229 Intermediate values are also possible f.e. interior routes
230 could be assigned a value between UNIVERSE and LINK.
236 /* User defined values */
245 #define RTM_F_NOTIFY 0x100 /* Notify user of route change */
246 #define RTM_F_CLONED 0x200 /* This route is cloned */
247 #define RTM_F_EQUALIZE 0x400 /* Multipath equalizer: NI */
248 #define RTM_F_PREFIX 0x800 /* Prefix addresses */
250 /* Reserved table identifiers */
255 /* User defined values */
257 RT_TABLE_DEFAULT=253,
260 RT_TABLE_MAX=0xFFFFFFFF
264 /* 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.
303 unsigned short rtnh_len;
304 unsigned char rtnh_flags;
305 unsigned char rtnh_hops;
311 #define RTNH_F_DEAD 1 /* Nexthop is dead (used by multipath) */
312 #define RTNH_F_PERVASIVE 2 /* Do recursive gateway lookup */
313 #define RTNH_F_ONLINK 4 /* Gateway is forced on link */
315 /* Macros to handle hexthops */
317 #define RTNH_ALIGNTO 4
318 #define RTNH_ALIGN(len) ( ((len)+RTNH_ALIGNTO-1) & ~(RTNH_ALIGNTO-1) )
319 #define RTNH_OK(rtnh,len) ((rtnh)->rtnh_len >= sizeof(struct rtnexthop) && \
320 ((int)(rtnh)->rtnh_len) <= (len))
321 #define RTNH_NEXT(rtnh) ((struct rtnexthop*)(((char*)(rtnh)) + RTNH_ALIGN((rtnh)->rtnh_len)))
322 #define RTNH_LENGTH(len) (RTNH_ALIGN(sizeof(struct rtnexthop)) + (len))
323 #define RTNH_SPACE(len) RTNH_ALIGN(RTNH_LENGTH(len))
324 #define RTNH_DATA(rtnh) ((struct rtattr*)(((char*)(rtnh)) + RTNH_LENGTH(0)))
336 #define RTNETLINK_HAVE_PEERINFO 1
342 /* RTM_METRICS --- array of struct rtattr with types of RTAX_* */
347 #define RTAX_UNSPEC RTAX_UNSPEC
349 #define RTAX_LOCK RTAX_LOCK
351 #define RTAX_MTU RTAX_MTU
353 #define RTAX_WINDOW RTAX_WINDOW
355 #define RTAX_RTT RTAX_RTT
357 #define RTAX_RTTVAR RTAX_RTTVAR
359 #define RTAX_SSTHRESH RTAX_SSTHRESH
361 #define RTAX_CWND RTAX_CWND
363 #define RTAX_ADVMSS RTAX_ADVMSS
365 #define RTAX_REORDERING RTAX_REORDERING
367 #define RTAX_HOPLIMIT RTAX_HOPLIMIT
369 #define RTAX_INITCWND RTAX_INITCWND
371 #define RTAX_FEATURES RTAX_FEATURES
373 #define RTAX_RTO_MIN RTAX_RTO_MIN
377 #define RTAX_MAX (__RTAX_MAX - 1)
379 #define RTAX_FEATURE_ECN 0x00000001
380 #define RTAX_FEATURE_NO_SACK 0x00000002
381 #define RTAX_FEATURE_NO_TSTAMP 0x00000004
382 #define RTAX_FEATURE_ALLFRAG 0x00000008
383 #define RTAX_FEATURE_NO_WSCALE 0x00000010
408 * General form of address family dependent message.
413 unsigned char rtgen_family;
416 /*****************************************************************
417 * Link layer specific messages.
421 * passes link level specific information, not dependent
422 * on network protocol.
427 unsigned char ifi_family;
428 unsigned char __ifi_pad;
429 unsigned short ifi_type; /* ARPHRD_* */
430 int ifi_index; /* Link index */
431 unsigned ifi_flags; /* IFF_* flags */
432 unsigned ifi_change; /* IFF_* change mask */
435 /********************************************************************
441 unsigned char prefix_family;
442 unsigned char prefix_pad1;
443 unsigned short prefix_pad2;
445 unsigned char prefix_type;
446 unsigned char prefix_len;
447 unsigned char prefix_flags;
448 unsigned char prefix_pad3;
459 #define PREFIX_MAX (__PREFIX_MAX - 1)
461 struct prefix_cacheinfo
463 __u32 preferred_time;
468 /*****************************************************************
469 * Traffic control messages.
474 unsigned char tcm_family;
475 unsigned char tcm__pad1;
476 unsigned short tcm__pad2;
497 #define TCA_MAX (__TCA_MAX - 1)
499 #define TCA_RTA(r) ((struct rtattr*)(((char*)(r)) + NLMSG_ALIGN(sizeof(struct tcmsg))))
500 #define TCA_PAYLOAD(n) NLMSG_PAYLOAD(n,sizeof(struct tcmsg))
502 /********************************************************************
503 * Neighbor Discovery userland options
508 unsigned char nduseropt_family;
509 unsigned char nduseropt_pad1;
510 unsigned short nduseropt_opts_len; /* Total length of options */
511 int nduseropt_ifindex;
512 __u8 nduseropt_icmp_type;
513 __u8 nduseropt_icmp_code;
514 unsigned short nduseropt_pad2;
515 unsigned int nduseropt_pad3;
516 /* Followed by one or more ND options */
526 #define NDUSEROPT_MAX (__NDUSEROPT_MAX - 1)
529 /* RTnetlink multicast groups - backwards compatibility for userspace */
530 #define RTMGRP_LINK 1
531 #define RTMGRP_NOTIFY 2
532 #define RTMGRP_NEIGH 4
535 #define RTMGRP_IPV4_IFADDR 0x10
536 #define RTMGRP_IPV4_MROUTE 0x20
537 #define RTMGRP_IPV4_ROUTE 0x40
538 #define RTMGRP_IPV4_RULE 0x80
540 #define RTMGRP_IPV6_IFADDR 0x100
541 #define RTMGRP_IPV6_MROUTE 0x200
542 #define RTMGRP_IPV6_ROUTE 0x400
543 #define RTMGRP_IPV6_IFINFO 0x800
545 #define RTMGRP_DECnet_IFADDR 0x1000
546 #define RTMGRP_DECnet_ROUTE 0x4000
548 #define RTMGRP_IPV6_PREFIX 0x20000
551 /* RTnetlink multicast groups */
552 enum rtnetlink_groups {
554 #define RTNLGRP_NONE RTNLGRP_NONE
556 #define RTNLGRP_LINK RTNLGRP_LINK
558 #define RTNLGRP_NOTIFY RTNLGRP_NOTIFY
560 #define RTNLGRP_NEIGH RTNLGRP_NEIGH
562 #define RTNLGRP_TC RTNLGRP_TC
564 #define RTNLGRP_IPV4_IFADDR RTNLGRP_IPV4_IFADDR
566 #define RTNLGRP_IPV4_MROUTE RTNLGRP_IPV4_MROUTE
568 #define RTNLGRP_IPV4_ROUTE RTNLGRP_IPV4_ROUTE
570 #define RTNLGRP_IPV4_RULE RTNLGRP_IPV4_RULE
572 #define RTNLGRP_IPV6_IFADDR RTNLGRP_IPV6_IFADDR
574 #define RTNLGRP_IPV6_MROUTE RTNLGRP_IPV6_MROUTE
576 #define RTNLGRP_IPV6_ROUTE RTNLGRP_IPV6_ROUTE
578 #define RTNLGRP_IPV6_IFINFO RTNLGRP_IPV6_IFINFO
579 RTNLGRP_DECnet_IFADDR,
580 #define RTNLGRP_DECnet_IFADDR RTNLGRP_DECnet_IFADDR
582 RTNLGRP_DECnet_ROUTE,
583 #define RTNLGRP_DECnet_ROUTE RTNLGRP_DECnet_ROUTE
585 #define RTNLGRP_DECnet_RULE RTNLGRP_DECnet_RULE
588 #define RTNLGRP_IPV6_PREFIX RTNLGRP_IPV6_PREFIX
590 #define RTNLGRP_IPV6_RULE RTNLGRP_IPV6_RULE
592 #define RTNLGRP_ND_USEROPT RTNLGRP_ND_USEROPT
593 RTNLGRP_PHONET_IFADDR,
594 #define RTNLGRP_PHONET_IFADDR RTNLGRP_PHONET_IFADDR
595 RTNLGRP_PHONET_ROUTE,
596 #define RTNLGRP_PHONET_ROUTE RTNLGRP_PHONET_ROUTE
599 #define RTNLGRP_MAX (__RTNLGRP_MAX - 1)
601 /* TC action piece */
604 unsigned char tca_family;
605 unsigned char tca__pad1;
606 unsigned short tca__pad2;
608 #define TA_RTA(r) ((struct rtattr*)(((char*)(r)) + NLMSG_ALIGN(sizeof(struct tcamsg))))
609 #define TA_PAYLOAD(n) NLMSG_PAYLOAD(n,sizeof(struct tcamsg))
610 #define TCA_ACT_TAB 1 /* attr type must be >=1 */
613 /* End of information exported to user level */
617 #include <linux/mutex.h>
619 static __inline__ int rtattr_strcmp(const struct rtattr *rta, const char *str)
621 int len = strlen(str) + 1;
622 return len > rta->rta_len || memcmp(RTA_DATA(rta), str, len);
625 extern int rtnetlink_send(struct sk_buff *skb, struct net *net, u32 pid, u32 group, int echo);
626 extern int rtnl_unicast(struct sk_buff *skb, struct net *net, u32 pid);
627 extern void rtnl_notify(struct sk_buff *skb, struct net *net, u32 pid,
628 u32 group, struct nlmsghdr *nlh, gfp_t flags);
629 extern void rtnl_set_sk_err(struct net *net, u32 group, int error);
630 extern int rtnetlink_put_metrics(struct sk_buff *skb, u32 *metrics);
631 extern int rtnl_put_cacheinfo(struct sk_buff *skb, struct dst_entry *dst,
632 u32 id, u32 ts, u32 tsage, long expires,
635 extern void __rta_fill(struct sk_buff *skb, int attrtype, int attrlen, const void *data);
637 #define RTA_PUT(skb, attrtype, attrlen, data) \
638 ({ if (unlikely(skb_tailroom(skb) < (int)RTA_SPACE(attrlen))) \
639 goto rtattr_failure; \
640 __rta_fill(skb, attrtype, attrlen, data); })
642 #define RTA_APPEND(skb, attrlen, data) \
643 ({ if (unlikely(skb_tailroom(skb) < (int)(attrlen))) \
644 goto rtattr_failure; \
645 memcpy(skb_put(skb, attrlen), data, attrlen); })
647 #define RTA_PUT_NOHDR(skb, attrlen, data) \
648 ({ RTA_APPEND(skb, RTA_ALIGN(attrlen), data); \
649 memset(skb_tail_pointer(skb) - (RTA_ALIGN(attrlen) - attrlen), 0, \
650 RTA_ALIGN(attrlen) - attrlen); })
652 #define RTA_PUT_U8(skb, attrtype, value) \
653 ({ u8 _tmp = (value); \
654 RTA_PUT(skb, attrtype, sizeof(u8), &_tmp); })
656 #define RTA_PUT_U16(skb, attrtype, value) \
657 ({ u16 _tmp = (value); \
658 RTA_PUT(skb, attrtype, sizeof(u16), &_tmp); })
660 #define RTA_PUT_U32(skb, attrtype, value) \
661 ({ u32 _tmp = (value); \
662 RTA_PUT(skb, attrtype, sizeof(u32), &_tmp); })
664 #define RTA_PUT_U64(skb, attrtype, value) \
665 ({ u64 _tmp = (value); \
666 RTA_PUT(skb, attrtype, sizeof(u64), &_tmp); })
668 #define RTA_PUT_SECS(skb, attrtype, value) \
669 RTA_PUT_U64(skb, attrtype, (value) / HZ)
671 #define RTA_PUT_MSECS(skb, attrtype, value) \
672 RTA_PUT_U64(skb, attrtype, jiffies_to_msecs(value))
674 #define RTA_PUT_STRING(skb, attrtype, value) \
675 RTA_PUT(skb, attrtype, strlen(value) + 1, value)
677 #define RTA_PUT_FLAG(skb, attrtype) \
678 RTA_PUT(skb, attrtype, 0, NULL);
680 #define RTA_NEST(skb, type) \
681 ({ struct rtattr *__start = (struct rtattr *)skb_tail_pointer(skb); \
682 RTA_PUT(skb, type, 0, NULL); \
685 #define RTA_NEST_END(skb, start) \
686 ({ (start)->rta_len = skb_tail_pointer(skb) - (unsigned char *)(start); \
689 #define RTA_NEST_COMPAT(skb, type, attrlen, data) \
690 ({ struct rtattr *__start = (struct rtattr *)skb_tail_pointer(skb); \
691 RTA_PUT(skb, type, attrlen, data); \
692 RTA_NEST(skb, type); \
695 #define RTA_NEST_COMPAT_END(skb, start) \
696 ({ struct rtattr *__nest = (void *)(start) + NLMSG_ALIGN((start)->rta_len); \
697 (start)->rta_len = skb_tail_pointer(skb) - (unsigned char *)(start); \
698 RTA_NEST_END(skb, __nest); \
701 #define RTA_NEST_CANCEL(skb, start) \
703 skb_trim(skb, (unsigned char *) (start) - (skb)->data); \
706 #define RTA_GET_U8(rta) \
707 ({ if (!rta || RTA_PAYLOAD(rta) < sizeof(u8)) \
708 goto rtattr_failure; \
709 *(u8 *) RTA_DATA(rta); })
711 #define RTA_GET_U16(rta) \
712 ({ if (!rta || RTA_PAYLOAD(rta) < sizeof(u16)) \
713 goto rtattr_failure; \
714 *(u16 *) RTA_DATA(rta); })
716 #define RTA_GET_U32(rta) \
717 ({ if (!rta || RTA_PAYLOAD(rta) < sizeof(u32)) \
718 goto rtattr_failure; \
719 *(u32 *) RTA_DATA(rta); })
721 #define RTA_GET_U64(rta) \
723 if (!rta || RTA_PAYLOAD(rta) < sizeof(u64)) \
724 goto rtattr_failure; \
725 memcpy(&_tmp, RTA_DATA(rta), sizeof(_tmp)); \
728 #define RTA_GET_FLAG(rta) (!!(rta))
730 #define RTA_GET_SECS(rta) ((unsigned long) RTA_GET_U64(rta) * HZ)
731 #define RTA_GET_MSECS(rta) (msecs_to_jiffies((unsigned long) RTA_GET_U64(rta)))
733 static inline struct rtattr *
734 __rta_reserve(struct sk_buff *skb, int attrtype, int attrlen)
737 int size = RTA_LENGTH(attrlen);
739 rta = (struct rtattr*)skb_put(skb, RTA_ALIGN(size));
740 rta->rta_type = attrtype;
742 memset(RTA_DATA(rta) + attrlen, 0, RTA_ALIGN(size) - size);
746 #define __RTA_PUT(skb, attrtype, attrlen) \
747 ({ if (unlikely(skb_tailroom(skb) < (int)RTA_SPACE(attrlen))) \
748 goto rtattr_failure; \
749 __rta_reserve(skb, attrtype, attrlen); })
751 extern void rtmsg_ifinfo(int type, struct net_device *dev, unsigned change);
753 /* RTNL is used as a global lock for all changes to network configuration */
754 extern void rtnl_lock(void);
755 extern void rtnl_unlock(void);
756 extern int rtnl_trylock(void);
757 extern int rtnl_is_locked(void);
759 extern void rtnetlink_init(void);
760 extern void __rtnl_unlock(void);
762 #define ASSERT_RTNL() do { \
763 if (unlikely(!rtnl_is_locked())) { \
764 printk(KERN_ERR "RTNL: assertion failed at %s (%d)\n", \
765 __FILE__, __LINE__); \
770 static inline u32 rtm_get_table(struct rtattr **rta, u8 table)
772 return RTA_GET_U32(rta[RTA_TABLE-1]);
777 #endif /* __KERNEL__ */
780 #endif /* __LINUX_RTNETLINK_H */