1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2 #ifndef _UAPI__LINUX_RTNETLINK_H
3 #define _UAPI__LINUX_RTNETLINK_H
5 #include <linux/types.h>
6 #include <linux/netlink.h>
7 #include <linux/if_link.h>
8 #include <linux/if_addr.h>
9 #include <linux/neighbour.h>
11 /* rtnetlink families. Values up to 127 are reserved for real address
12 * families, values above 128 may be used arbitrarily.
14 #define RTNL_FAMILY_IPMR 128
15 #define RTNL_FAMILY_IP6MR 129
16 #define RTNL_FAMILY_MAX 129
19 * Routing/neighbour discovery messages.
22 /* Types of messages */
26 #define RTM_BASE RTM_BASE
29 #define RTM_NEWLINK RTM_NEWLINK
31 #define RTM_DELLINK RTM_DELLINK
33 #define RTM_GETLINK RTM_GETLINK
35 #define RTM_SETLINK RTM_SETLINK
38 #define RTM_NEWADDR RTM_NEWADDR
40 #define RTM_DELADDR RTM_DELADDR
42 #define RTM_GETADDR RTM_GETADDR
45 #define RTM_NEWROUTE RTM_NEWROUTE
47 #define RTM_DELROUTE RTM_DELROUTE
49 #define RTM_GETROUTE RTM_GETROUTE
52 #define RTM_NEWNEIGH RTM_NEWNEIGH
54 #define RTM_DELNEIGH RTM_DELNEIGH
56 #define RTM_GETNEIGH RTM_GETNEIGH
59 #define RTM_NEWRULE RTM_NEWRULE
61 #define RTM_DELRULE RTM_DELRULE
63 #define RTM_GETRULE RTM_GETRULE
66 #define RTM_NEWQDISC RTM_NEWQDISC
68 #define RTM_DELQDISC RTM_DELQDISC
70 #define RTM_GETQDISC RTM_GETQDISC
73 #define RTM_NEWTCLASS RTM_NEWTCLASS
75 #define RTM_DELTCLASS RTM_DELTCLASS
77 #define RTM_GETTCLASS RTM_GETTCLASS
80 #define RTM_NEWTFILTER RTM_NEWTFILTER
82 #define RTM_DELTFILTER RTM_DELTFILTER
84 #define RTM_GETTFILTER RTM_GETTFILTER
87 #define RTM_NEWACTION RTM_NEWACTION
89 #define RTM_DELACTION RTM_DELACTION
91 #define RTM_GETACTION RTM_GETACTION
94 #define RTM_NEWPREFIX RTM_NEWPREFIX
96 RTM_GETMULTICAST = 58,
97 #define RTM_GETMULTICAST RTM_GETMULTICAST
100 #define RTM_GETANYCAST RTM_GETANYCAST
102 RTM_NEWNEIGHTBL = 64,
103 #define RTM_NEWNEIGHTBL RTM_NEWNEIGHTBL
104 RTM_GETNEIGHTBL = 66,
105 #define RTM_GETNEIGHTBL RTM_GETNEIGHTBL
107 #define RTM_SETNEIGHTBL RTM_SETNEIGHTBL
109 RTM_NEWNDUSEROPT = 68,
110 #define RTM_NEWNDUSEROPT RTM_NEWNDUSEROPT
112 RTM_NEWADDRLABEL = 72,
113 #define RTM_NEWADDRLABEL RTM_NEWADDRLABEL
115 #define RTM_DELADDRLABEL RTM_DELADDRLABEL
117 #define RTM_GETADDRLABEL RTM_GETADDRLABEL
120 #define RTM_GETDCB RTM_GETDCB
122 #define RTM_SETDCB RTM_SETDCB
125 #define RTM_NEWNETCONF RTM_NEWNETCONF
127 #define RTM_DELNETCONF RTM_DELNETCONF
129 #define RTM_GETNETCONF RTM_GETNETCONF
132 #define RTM_NEWMDB RTM_NEWMDB
134 #define RTM_DELMDB RTM_DELMDB
136 #define RTM_GETMDB RTM_GETMDB
139 #define RTM_NEWNSID RTM_NEWNSID
141 #define RTM_DELNSID RTM_DELNSID
143 #define RTM_GETNSID RTM_GETNSID
146 #define RTM_NEWSTATS RTM_NEWSTATS
148 #define RTM_GETSTATS RTM_GETSTATS
150 RTM_NEWCACHEREPORT = 96,
151 #define RTM_NEWCACHEREPORT RTM_NEWCACHEREPORT
154 #define RTM_NEWCHAIN RTM_NEWCHAIN
156 #define RTM_DELCHAIN RTM_DELCHAIN
158 #define RTM_GETCHAIN RTM_GETCHAIN
161 #define RTM_MAX (((__RTM_MAX + 3) & ~3) - 1)
164 #define RTM_NR_MSGTYPES (RTM_MAX + 1 - RTM_BASE)
165 #define RTM_NR_FAMILIES (RTM_NR_MSGTYPES >> 2)
166 #define RTM_FAM(cmd) (((cmd) - RTM_BASE) >> 2)
169 Generic structure for encapsulation of optional route information.
170 It is reminiscent of sockaddr, but with sa_family replaced
175 unsigned short rta_len;
176 unsigned short rta_type;
179 /* Macros to handle rtattributes */
181 #define RTA_ALIGNTO 4U
182 #define RTA_ALIGN(len) ( ((len)+RTA_ALIGNTO-1) & ~(RTA_ALIGNTO-1) )
183 #define RTA_OK(rta,len) ((len) >= (int)sizeof(struct rtattr) && \
184 (rta)->rta_len >= sizeof(struct rtattr) && \
185 (rta)->rta_len <= (len))
186 #define RTA_NEXT(rta,attrlen) ((attrlen) -= RTA_ALIGN((rta)->rta_len), \
187 (struct rtattr*)(((char*)(rta)) + RTA_ALIGN((rta)->rta_len)))
188 #define RTA_LENGTH(len) (RTA_ALIGN(sizeof(struct rtattr)) + (len))
189 #define RTA_SPACE(len) RTA_ALIGN(RTA_LENGTH(len))
190 #define RTA_DATA(rta) ((void*)(((char*)(rta)) + RTA_LENGTH(0)))
191 #define RTA_PAYLOAD(rta) ((int)((rta)->rta_len) - RTA_LENGTH(0))
196 /******************************************************************************
197 * Definitions used in routing table administration.
201 unsigned char rtm_family;
202 unsigned char rtm_dst_len;
203 unsigned char rtm_src_len;
204 unsigned char rtm_tos;
206 unsigned char rtm_table; /* Routing table id */
207 unsigned char rtm_protocol; /* Routing protocol; see below */
208 unsigned char rtm_scope; /* See below */
209 unsigned char rtm_type; /* See below */
218 RTN_UNICAST, /* Gateway or direct route */
219 RTN_LOCAL, /* Accept locally */
220 RTN_BROADCAST, /* Accept locally as broadcast,
222 RTN_ANYCAST, /* Accept locally as broadcast,
223 but send as unicast */
224 RTN_MULTICAST, /* Multicast route */
225 RTN_BLACKHOLE, /* Drop */
226 RTN_UNREACHABLE, /* Destination is unreachable */
227 RTN_PROHIBIT, /* Administratively prohibited */
228 RTN_THROW, /* Not in this table */
229 RTN_NAT, /* Translate this address */
230 RTN_XRESOLVE, /* Use external resolver */
234 #define RTN_MAX (__RTN_MAX - 1)
239 #define RTPROT_UNSPEC 0
240 #define RTPROT_REDIRECT 1 /* Route installed by ICMP redirects;
241 not used by current IPv4 */
242 #define RTPROT_KERNEL 2 /* Route installed by kernel */
243 #define RTPROT_BOOT 3 /* Route installed during boot */
244 #define RTPROT_STATIC 4 /* Route installed by administrator */
246 /* Values of protocol >= RTPROT_STATIC are not interpreted by kernel;
247 they are just passed from user and back as is.
248 It will be used by hypothetical multiple routing daemons.
249 Note that protocol values should be standardized in order to
253 #define RTPROT_GATED 8 /* Apparently, GateD */
254 #define RTPROT_RA 9 /* RDISC/ND router advertisements */
255 #define RTPROT_MRT 10 /* Merit MRT */
256 #define RTPROT_ZEBRA 11 /* Zebra */
257 #define RTPROT_BIRD 12 /* BIRD */
258 #define RTPROT_DNROUTED 13 /* DECnet routing daemon */
259 #define RTPROT_XORP 14 /* XORP */
260 #define RTPROT_NTK 15 /* Netsukuku */
261 #define RTPROT_DHCP 16 /* DHCP client */
262 #define RTPROT_MROUTED 17 /* Multicast daemon */
263 #define RTPROT_BABEL 42 /* Babel daemon */
264 #define RTPROT_BGP 186 /* BGP Routes */
265 #define RTPROT_ISIS 187 /* ISIS Routes */
266 #define RTPROT_OSPF 188 /* OSPF Routes */
267 #define RTPROT_RIP 189 /* RIP Routes */
268 #define RTPROT_EIGRP 192 /* EIGRP Routes */
272 Really it is not scope, but sort of distance to the destination.
273 NOWHERE are reserved for not existing destinations, HOST is our
274 local addresses, LINK are destinations, located on directly attached
275 link and UNIVERSE is everywhere in the Universe.
277 Intermediate values are also possible f.e. interior routes
278 could be assigned a value between UNIVERSE and LINK.
283 /* User defined values */
292 #define RTM_F_NOTIFY 0x100 /* Notify user of route change */
293 #define RTM_F_CLONED 0x200 /* This route is cloned */
294 #define RTM_F_EQUALIZE 0x400 /* Multipath equalizer: NI */
295 #define RTM_F_PREFIX 0x800 /* Prefix addresses */
296 #define RTM_F_LOOKUP_TABLE 0x1000 /* set rtm_table to FIB lookup result */
297 #define RTM_F_FIB_MATCH 0x2000 /* return full fib lookup match */
299 /* Reserved table identifiers */
303 /* User defined values */
305 RT_TABLE_DEFAULT=253,
308 RT_TABLE_MAX=0xFFFFFFFF
312 /* Routing message attributes */
325 RTA_PROTOINFO, /* no longer used */
328 RTA_SESSION, /* no longer used */
329 RTA_MP_ALGO, /* no longer used */
348 #define RTA_MAX (__RTA_MAX - 1)
350 #define RTM_RTA(r) ((struct rtattr*)(((char*)(r)) + NLMSG_ALIGN(sizeof(struct rtmsg))))
351 #define RTM_PAYLOAD(n) NLMSG_PAYLOAD(n,sizeof(struct rtmsg))
353 /* RTM_MULTIPATH --- array of struct rtnexthop.
355 * "struct rtnexthop" describes all necessary nexthop information,
356 * i.e. parameters of path to a destination via this nexthop.
358 * At the moment it is impossible to set different prefsrc, mtu, window
359 * and rtt for different paths from multipath.
363 unsigned short rtnh_len;
364 unsigned char rtnh_flags;
365 unsigned char rtnh_hops;
371 #define RTNH_F_DEAD 1 /* Nexthop is dead (used by multipath) */
372 #define RTNH_F_PERVASIVE 2 /* Do recursive gateway lookup */
373 #define RTNH_F_ONLINK 4 /* Gateway is forced on link */
374 #define RTNH_F_OFFLOAD 8 /* offloaded route */
375 #define RTNH_F_LINKDOWN 16 /* carrier-down on nexthop */
376 #define RTNH_F_UNRESOLVED 32 /* The entry is unresolved (ipmr) */
378 #define RTNH_COMPARE_MASK (RTNH_F_DEAD | RTNH_F_LINKDOWN | RTNH_F_OFFLOAD)
380 /* Macros to handle hexthops */
382 #define RTNH_ALIGNTO 4
383 #define RTNH_ALIGN(len) ( ((len)+RTNH_ALIGNTO-1) & ~(RTNH_ALIGNTO-1) )
384 #define RTNH_OK(rtnh,len) ((rtnh)->rtnh_len >= sizeof(struct rtnexthop) && \
385 ((int)(rtnh)->rtnh_len) <= (len))
386 #define RTNH_NEXT(rtnh) ((struct rtnexthop*)(((char*)(rtnh)) + RTNH_ALIGN((rtnh)->rtnh_len)))
387 #define RTNH_LENGTH(len) (RTNH_ALIGN(sizeof(struct rtnexthop)) + (len))
388 #define RTNH_SPACE(len) RTNH_ALIGN(RTNH_LENGTH(len))
389 #define RTNH_DATA(rtnh) ((struct rtattr*)(((char*)(rtnh)) + RTNH_LENGTH(0)))
393 __kernel_sa_family_t rtvia_family;
399 struct rta_cacheinfo {
406 #define RTNETLINK_HAVE_PEERINFO 1
412 /* RTM_METRICS --- array of struct rtattr with types of RTAX_* */
416 #define RTAX_UNSPEC RTAX_UNSPEC
418 #define RTAX_LOCK RTAX_LOCK
420 #define RTAX_MTU RTAX_MTU
422 #define RTAX_WINDOW RTAX_WINDOW
424 #define RTAX_RTT RTAX_RTT
426 #define RTAX_RTTVAR RTAX_RTTVAR
428 #define RTAX_SSTHRESH RTAX_SSTHRESH
430 #define RTAX_CWND RTAX_CWND
432 #define RTAX_ADVMSS RTAX_ADVMSS
434 #define RTAX_REORDERING RTAX_REORDERING
436 #define RTAX_HOPLIMIT RTAX_HOPLIMIT
438 #define RTAX_INITCWND RTAX_INITCWND
440 #define RTAX_FEATURES RTAX_FEATURES
442 #define RTAX_RTO_MIN RTAX_RTO_MIN
444 #define RTAX_INITRWND RTAX_INITRWND
446 #define RTAX_QUICKACK RTAX_QUICKACK
448 #define RTAX_CC_ALGO RTAX_CC_ALGO
449 RTAX_FASTOPEN_NO_COOKIE,
450 #define RTAX_FASTOPEN_NO_COOKIE RTAX_FASTOPEN_NO_COOKIE
454 #define RTAX_MAX (__RTAX_MAX - 1)
456 #define RTAX_FEATURE_ECN (1 << 0)
457 #define RTAX_FEATURE_SACK (1 << 1)
458 #define RTAX_FEATURE_TIMESTAMP (1 << 2)
459 #define RTAX_FEATURE_ALLFRAG (1 << 3)
461 #define RTAX_FEATURE_MASK (RTAX_FEATURE_ECN | RTAX_FEATURE_SACK | \
462 RTAX_FEATURE_TIMESTAMP | RTAX_FEATURE_ALLFRAG)
485 struct rta_mfc_stats {
492 * General form of address family dependent message.
496 unsigned char rtgen_family;
499 /*****************************************************************
500 * Link layer specific messages.
504 * passes link level specific information, not dependent
505 * on network protocol.
509 unsigned char ifi_family;
510 unsigned char __ifi_pad;
511 unsigned short ifi_type; /* ARPHRD_* */
512 int ifi_index; /* Link index */
513 unsigned ifi_flags; /* IFF_* flags */
514 unsigned ifi_change; /* IFF_* change mask */
517 /********************************************************************
522 unsigned char prefix_family;
523 unsigned char prefix_pad1;
524 unsigned short prefix_pad2;
526 unsigned char prefix_type;
527 unsigned char prefix_len;
528 unsigned char prefix_flags;
529 unsigned char prefix_pad3;
540 #define PREFIX_MAX (__PREFIX_MAX - 1)
542 struct prefix_cacheinfo {
543 __u32 preferred_time;
548 /*****************************************************************
549 * Traffic control messages.
553 unsigned char tcm_family;
554 unsigned char tcm__pad1;
555 unsigned short tcm__pad2;
559 /* tcm_block_index is used instead of tcm_parent
560 * in case tcm_ifindex == TCM_IFINDEX_MAGIC_BLOCK
562 #define tcm_block_index tcm_parent
566 /* For manipulation of filters in shared block, tcm_ifindex is set to
567 * TCM_IFINDEX_MAGIC_BLOCK, and tcm_parent is aliased to tcm_block_index
568 * which is the block index.
570 #define TCM_IFINDEX_MAGIC_BLOCK (0xFFFFFFFFU)
591 #define TCA_MAX (__TCA_MAX - 1)
593 #define TCA_RTA(r) ((struct rtattr*)(((char*)(r)) + NLMSG_ALIGN(sizeof(struct tcmsg))))
594 #define TCA_PAYLOAD(n) NLMSG_PAYLOAD(n,sizeof(struct tcmsg))
596 /********************************************************************
597 * Neighbor Discovery userland options
600 struct nduseroptmsg {
601 unsigned char nduseropt_family;
602 unsigned char nduseropt_pad1;
603 unsigned short nduseropt_opts_len; /* Total length of options */
604 int nduseropt_ifindex;
605 __u8 nduseropt_icmp_type;
606 __u8 nduseropt_icmp_code;
607 unsigned short nduseropt_pad2;
608 unsigned int nduseropt_pad3;
609 /* Followed by one or more ND options */
618 #define NDUSEROPT_MAX (__NDUSEROPT_MAX - 1)
621 /* RTnetlink multicast groups - backwards compatibility for userspace */
622 #define RTMGRP_LINK 1
623 #define RTMGRP_NOTIFY 2
624 #define RTMGRP_NEIGH 4
627 #define RTMGRP_IPV4_IFADDR 0x10
628 #define RTMGRP_IPV4_MROUTE 0x20
629 #define RTMGRP_IPV4_ROUTE 0x40
630 #define RTMGRP_IPV4_RULE 0x80
632 #define RTMGRP_IPV6_IFADDR 0x100
633 #define RTMGRP_IPV6_MROUTE 0x200
634 #define RTMGRP_IPV6_ROUTE 0x400
635 #define RTMGRP_IPV6_IFINFO 0x800
637 #define RTMGRP_DECnet_IFADDR 0x1000
638 #define RTMGRP_DECnet_ROUTE 0x4000
640 #define RTMGRP_IPV6_PREFIX 0x20000
643 /* RTnetlink multicast groups */
644 enum rtnetlink_groups {
646 #define RTNLGRP_NONE RTNLGRP_NONE
648 #define RTNLGRP_LINK RTNLGRP_LINK
650 #define RTNLGRP_NOTIFY RTNLGRP_NOTIFY
652 #define RTNLGRP_NEIGH RTNLGRP_NEIGH
654 #define RTNLGRP_TC RTNLGRP_TC
656 #define RTNLGRP_IPV4_IFADDR RTNLGRP_IPV4_IFADDR
658 #define RTNLGRP_IPV4_MROUTE RTNLGRP_IPV4_MROUTE
660 #define RTNLGRP_IPV4_ROUTE RTNLGRP_IPV4_ROUTE
662 #define RTNLGRP_IPV4_RULE RTNLGRP_IPV4_RULE
664 #define RTNLGRP_IPV6_IFADDR RTNLGRP_IPV6_IFADDR
666 #define RTNLGRP_IPV6_MROUTE RTNLGRP_IPV6_MROUTE
668 #define RTNLGRP_IPV6_ROUTE RTNLGRP_IPV6_ROUTE
670 #define RTNLGRP_IPV6_IFINFO RTNLGRP_IPV6_IFINFO
671 RTNLGRP_DECnet_IFADDR,
672 #define RTNLGRP_DECnet_IFADDR RTNLGRP_DECnet_IFADDR
674 RTNLGRP_DECnet_ROUTE,
675 #define RTNLGRP_DECnet_ROUTE RTNLGRP_DECnet_ROUTE
677 #define RTNLGRP_DECnet_RULE RTNLGRP_DECnet_RULE
680 #define RTNLGRP_IPV6_PREFIX RTNLGRP_IPV6_PREFIX
682 #define RTNLGRP_IPV6_RULE RTNLGRP_IPV6_RULE
684 #define RTNLGRP_ND_USEROPT RTNLGRP_ND_USEROPT
685 RTNLGRP_PHONET_IFADDR,
686 #define RTNLGRP_PHONET_IFADDR RTNLGRP_PHONET_IFADDR
687 RTNLGRP_PHONET_ROUTE,
688 #define RTNLGRP_PHONET_ROUTE RTNLGRP_PHONET_ROUTE
690 #define RTNLGRP_DCB RTNLGRP_DCB
691 RTNLGRP_IPV4_NETCONF,
692 #define RTNLGRP_IPV4_NETCONF RTNLGRP_IPV4_NETCONF
693 RTNLGRP_IPV6_NETCONF,
694 #define RTNLGRP_IPV6_NETCONF RTNLGRP_IPV6_NETCONF
696 #define RTNLGRP_MDB RTNLGRP_MDB
698 #define RTNLGRP_MPLS_ROUTE RTNLGRP_MPLS_ROUTE
700 #define RTNLGRP_NSID RTNLGRP_NSID
701 RTNLGRP_MPLS_NETCONF,
702 #define RTNLGRP_MPLS_NETCONF RTNLGRP_MPLS_NETCONF
703 RTNLGRP_IPV4_MROUTE_R,
704 #define RTNLGRP_IPV4_MROUTE_R RTNLGRP_IPV4_MROUTE_R
705 RTNLGRP_IPV6_MROUTE_R,
706 #define RTNLGRP_IPV6_MROUTE_R RTNLGRP_IPV6_MROUTE_R
709 #define RTNLGRP_MAX (__RTNLGRP_MAX - 1)
711 /* TC action piece */
713 unsigned char tca_family;
714 unsigned char tca__pad1;
715 unsigned short tca__pad2;
721 #define TCA_ACT_TAB TCA_ROOT_TAB
722 #define TCAA_MAX TCA_ROOT_TAB
725 TCA_ROOT_TIME_DELTA, /* in msecs */
727 #define TCA_ROOT_MAX (__TCA_ROOT_MAX - 1)
730 #define TA_RTA(r) ((struct rtattr*)(((char*)(r)) + NLMSG_ALIGN(sizeof(struct tcamsg))))
731 #define TA_PAYLOAD(n) NLMSG_PAYLOAD(n,sizeof(struct tcamsg))
732 /* tcamsg flags stored in attribute TCA_ROOT_FLAGS
734 * TCA_FLAG_LARGE_DUMP_ON user->kernel to request for larger than TCA_ACT_MAX_PRIO
735 * actions in a dump. All dump responses will contain the number of actions
736 * being dumped stored in for user app's consumption in TCA_ROOT_COUNT
739 #define TCA_FLAG_LARGE_DUMP_ON (1 << 0)
741 /* New extended info filters for IFLA_EXT_MASK */
742 #define RTEXT_FILTER_VF (1 << 0)
743 #define RTEXT_FILTER_BRVLAN (1 << 1)
744 #define RTEXT_FILTER_BRVLAN_COMPRESSED (1 << 2)
745 #define RTEXT_FILTER_SKIP_STATS (1 << 3)
747 /* End of information exported to user level */
751 #endif /* _UAPI__LINUX_RTNETLINK_H */