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 */
250 RT_TABLE_DEFAULT=253,
253 RT_TABLE_MAX=0xFFFFFFFF
257 /* Routing message attributes */
271 RTA_PROTOINFO, /* no longer used */
274 RTA_SESSION, /* no longer used */
275 RTA_MP_ALGO, /* no longer used */
280 #define RTA_MAX (__RTA_MAX - 1)
282 #define RTM_RTA(r) ((struct rtattr*)(((char*)(r)) + NLMSG_ALIGN(sizeof(struct rtmsg))))
283 #define RTM_PAYLOAD(n) NLMSG_PAYLOAD(n,sizeof(struct rtmsg))
285 /* RTM_MULTIPATH --- array of struct rtnexthop.
287 * "struct rtnexthop" describes all necessary nexthop information,
288 * i.e. parameters of path to a destination via this nexthop.
290 * At the moment it is impossible to set different prefsrc, mtu, window
291 * and rtt for different paths from multipath.
296 unsigned short rtnh_len;
297 unsigned char rtnh_flags;
298 unsigned char rtnh_hops;
304 #define RTNH_F_DEAD 1 /* Nexthop is dead (used by multipath) */
305 #define RTNH_F_PERVASIVE 2 /* Do recursive gateway lookup */
306 #define RTNH_F_ONLINK 4 /* Gateway is forced on link */
308 /* Macros to handle hexthops */
310 #define RTNH_ALIGNTO 4
311 #define RTNH_ALIGN(len) ( ((len)+RTNH_ALIGNTO-1) & ~(RTNH_ALIGNTO-1) )
312 #define RTNH_OK(rtnh,len) ((rtnh)->rtnh_len >= sizeof(struct rtnexthop) && \
313 ((int)(rtnh)->rtnh_len) <= (len))
314 #define RTNH_NEXT(rtnh) ((struct rtnexthop*)(((char*)(rtnh)) + RTNH_ALIGN((rtnh)->rtnh_len)))
315 #define RTNH_LENGTH(len) (RTNH_ALIGN(sizeof(struct rtnexthop)) + (len))
316 #define RTNH_SPACE(len) RTNH_ALIGN(RTNH_LENGTH(len))
317 #define RTNH_DATA(rtnh) ((struct rtattr*)(((char*)(rtnh)) + RTNH_LENGTH(0)))
329 #define RTNETLINK_HAVE_PEERINFO 1
335 /* RTM_METRICS --- array of struct rtattr with types of RTAX_* */
340 #define RTAX_UNSPEC RTAX_UNSPEC
342 #define RTAX_LOCK RTAX_LOCK
344 #define RTAX_MTU RTAX_MTU
346 #define RTAX_WINDOW RTAX_WINDOW
348 #define RTAX_RTT RTAX_RTT
350 #define RTAX_RTTVAR RTAX_RTTVAR
352 #define RTAX_SSTHRESH RTAX_SSTHRESH
354 #define RTAX_CWND RTAX_CWND
356 #define RTAX_ADVMSS RTAX_ADVMSS
358 #define RTAX_REORDERING RTAX_REORDERING
360 #define RTAX_HOPLIMIT RTAX_HOPLIMIT
362 #define RTAX_INITCWND RTAX_INITCWND
364 #define RTAX_FEATURES RTAX_FEATURES
366 #define RTAX_RTO_MIN RTAX_RTO_MIN
370 #define RTAX_MAX (__RTAX_MAX - 1)
372 #define RTAX_FEATURE_ECN 0x00000001
373 #define RTAX_FEATURE_SACK 0x00000002
374 #define RTAX_FEATURE_TIMESTAMP 0x00000004
375 #define RTAX_FEATURE_ALLFRAG 0x00000008
400 * General form of address family dependent message.
405 unsigned char rtgen_family;
408 /*****************************************************************
409 * Link layer specific messages.
413 * passes link level specific information, not dependent
414 * on network protocol.
419 unsigned char ifi_family;
420 unsigned char __ifi_pad;
421 unsigned short ifi_type; /* ARPHRD_* */
422 int ifi_index; /* Link index */
423 unsigned ifi_flags; /* IFF_* flags */
424 unsigned ifi_change; /* IFF_* change mask */
427 /********************************************************************
433 unsigned char prefix_family;
434 unsigned char prefix_pad1;
435 unsigned short prefix_pad2;
437 unsigned char prefix_type;
438 unsigned char prefix_len;
439 unsigned char prefix_flags;
440 unsigned char prefix_pad3;
451 #define PREFIX_MAX (__PREFIX_MAX - 1)
453 struct prefix_cacheinfo
455 __u32 preferred_time;
460 /*****************************************************************
461 * Traffic control messages.
466 unsigned char tcm_family;
467 unsigned char tcm__pad1;
468 unsigned short tcm__pad2;
489 #define TCA_MAX (__TCA_MAX - 1)
491 #define TCA_RTA(r) ((struct rtattr*)(((char*)(r)) + NLMSG_ALIGN(sizeof(struct tcmsg))))
492 #define TCA_PAYLOAD(n) NLMSG_PAYLOAD(n,sizeof(struct tcmsg))
494 /********************************************************************
495 * Neighbor Discovery userland options
500 unsigned char nduseropt_family;
501 unsigned char nduseropt_pad1;
502 unsigned short nduseropt_opts_len; /* Total length of options */
503 int nduseropt_ifindex;
504 __u8 nduseropt_icmp_type;
505 __u8 nduseropt_icmp_code;
506 unsigned short nduseropt_pad2;
507 unsigned int nduseropt_pad3;
508 /* Followed by one or more ND options */
518 #define NDUSEROPT_MAX (__NDUSEROPT_MAX - 1)
521 /* RTnetlink multicast groups - backwards compatibility for userspace */
522 #define RTMGRP_LINK 1
523 #define RTMGRP_NOTIFY 2
524 #define RTMGRP_NEIGH 4
527 #define RTMGRP_IPV4_IFADDR 0x10
528 #define RTMGRP_IPV4_MROUTE 0x20
529 #define RTMGRP_IPV4_ROUTE 0x40
530 #define RTMGRP_IPV4_RULE 0x80
532 #define RTMGRP_IPV6_IFADDR 0x100
533 #define RTMGRP_IPV6_MROUTE 0x200
534 #define RTMGRP_IPV6_ROUTE 0x400
535 #define RTMGRP_IPV6_IFINFO 0x800
537 #define RTMGRP_DECnet_IFADDR 0x1000
538 #define RTMGRP_DECnet_ROUTE 0x4000
540 #define RTMGRP_IPV6_PREFIX 0x20000
543 /* RTnetlink multicast groups */
544 enum rtnetlink_groups {
546 #define RTNLGRP_NONE RTNLGRP_NONE
548 #define RTNLGRP_LINK RTNLGRP_LINK
550 #define RTNLGRP_NOTIFY RTNLGRP_NOTIFY
552 #define RTNLGRP_NEIGH RTNLGRP_NEIGH
554 #define RTNLGRP_TC RTNLGRP_TC
556 #define RTNLGRP_IPV4_IFADDR RTNLGRP_IPV4_IFADDR
558 #define RTNLGRP_IPV4_MROUTE RTNLGRP_IPV4_MROUTE
560 #define RTNLGRP_IPV4_ROUTE RTNLGRP_IPV4_ROUTE
562 #define RTNLGRP_IPV4_RULE RTNLGRP_IPV4_RULE
564 #define RTNLGRP_IPV6_IFADDR RTNLGRP_IPV6_IFADDR
566 #define RTNLGRP_IPV6_MROUTE RTNLGRP_IPV6_MROUTE
568 #define RTNLGRP_IPV6_ROUTE RTNLGRP_IPV6_ROUTE
570 #define RTNLGRP_IPV6_IFINFO RTNLGRP_IPV6_IFINFO
571 RTNLGRP_DECnet_IFADDR,
572 #define RTNLGRP_DECnet_IFADDR RTNLGRP_DECnet_IFADDR
574 RTNLGRP_DECnet_ROUTE,
575 #define RTNLGRP_DECnet_ROUTE RTNLGRP_DECnet_ROUTE
577 #define RTNLGRP_DECnet_RULE RTNLGRP_DECnet_RULE
580 #define RTNLGRP_IPV6_PREFIX RTNLGRP_IPV6_PREFIX
582 #define RTNLGRP_IPV6_RULE RTNLGRP_IPV6_RULE
584 #define RTNLGRP_ND_USEROPT RTNLGRP_ND_USEROPT
587 #define RTNLGRP_MAX (__RTNLGRP_MAX - 1)
589 /* 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 int rtnl_notify(struct sk_buff *skb, struct net *net, u32 pid, u32 group,
616 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);
747 extern void rtnetlink_init(void);
748 extern void __rtnl_unlock(void);
750 #define ASSERT_RTNL() do { \
751 if (unlikely(!rtnl_is_locked())) { \
752 printk(KERN_ERR "RTNL: assertion failed at %s (%d)\n", \
753 __FILE__, __LINE__); \
758 static inline u32 rtm_get_table(struct rtattr **rta, u8 table)
760 return RTA_GET_U32(rta[RTA_TABLE-1]);
765 #endif /* __KERNEL__ */
768 #endif /* __LINUX_RTNETLINK_H */