| RTM_GETLINK | Create, remove, or get information about a specific network interface. These messages contain an ifinfomsg structure followed by a series of rtattr structures. |
| RTM_GETADDR | Add, remove, or receive information about an IP address associated with an interface. In Linux 2.2, an interface can carry multiple IP addresses, this replaces the alias device concept in Linux 2.0. In Linux 2.2, these messages support IPv4 and IPv6 addresses. They contain an ifaddrmsg structure, optionally followed by rtattr routing attributes. |
| RTM_GETROUTE | Create, remove, or receive information about a network route. These messages contain an rtmsg structure with an optional sequence of rtattr structures following. For RTM_GETROUTE, setting rtm_dst_len and rtm_src_len to 0 means you get all entries for the specified routing table. For the other fields, except rtm_table and rtm_protocol, 0 is the wildcard. |
| RTM_GETNEIGH | Add, remove, or receive information about a neighbor table entry (e.g., an ARP entry). The message contains an ndmsg structure. |
| RTM_GETRULE | Add, delete, or retrieve a routing rule. Carries a struct rtmsg |
| RTM_GETQDISC | Add, remove, or get a queueing discipline. The message contains a struct tcmsg and may be followed by a series of attributes. |
| RTM_GETTCLASS | Add, remove, or get a traffic class. These messages contain a struct tcmsg as described above. |
| RTM_GETTFILTER | Add, remove, or receive information about a traffic filter. These messages contain a struct tcmsg as described above. |
NAME
rtnetlink - Linux routing socket
SYNOPSIS
#include <asm/types.h>\n
\n#include <linux/if_link.h>\n
\n#include <linux/netlink.h>\n
\n#include <linux/rtnetlink.h>\n
\n#include <sys/socket.h>rtnetlink_socket = socket(AF_NETLINK, int \nsocket_type\n, NETLINK_ROUTE);DESCRIPTION
Rtnetlink allows the kernel's routing tables to be read and altered. It is used within the kernel to communicate between various subsystems, though this usage is not documented here, and for communication with user-space programs. Network routes, IP addresses, link parameters, neighbor setups, queueing disciplines, traffic classes and packet classifiers may all be controlled through NETLINK_ROUTE sockets. It is based on netlink messages; see netlink(7) for more information.
Routing attributes
Some rtnetlink messages have optional attributes after the initial header:
struct rtattr {
\n
unsigned short rta_len; /* Length of option */
\n
unsigned short rta_type; /* Type of option */
\n
/* Data follows */
};These attributes should be manipulated using only the RTA_* macros or libnetlink, see rtnetlink(3).
Messages
Rtnetlink consists of these message types (in addition to standard netlink messages):
- RTM_NEWLINK
- RTM_DELLINK
- RTM_GETLINK
Create, remove, or get information about a specific network interface. These messages contain an ifinfomsg structure followed by a series of rtattr structures.
- bash
struct ifinfomsg { \n unsigned char ifi_family; /* AF_UNSPEC */ \n unsigned short ifi_type; /* Device type */ \n int ifi_index; /* Interface index */ \n unsigned int ifi_flags; /* Device flags */ \n unsigned int ifi_change; /* change mask */ }; Routing attributes rta_type Value type Description IFLA_UNSPEC - unspecified IFLA_ADDRESS hardware address interface L2 address IFLA_BROADCAST hardware address L2 broadcast address IFLA_IFNAME asciiz string Device name IFLA_MTU unsigned int MTU of the device IFLA_LINK int Link type IFLA_QDISC asciiz string Queueing discipline IFLA_STATS see below Interface Statistics IFLA_PERM_ADDRESS hardware address hardware address provided by device (since Linux 5.5) The value type for IFLA_STATS is struct rtnl_link_stats (struct net_device_stats in Linux 2.4 and earlier).
- RTM_NEWADDR
- RTM_DELADDR
- RTM_GETADDR
Add, remove, or receive information about an IP address associated with an interface. In Linux 2.2, an interface can carry multiple IP addresses, this replaces the alias device concept in Linux 2.0. In Linux 2.2, these messages support IPv4 and IPv6 addresses. They contain an ifaddrmsg structure, optionally followed by rtattr routing attributes.
- bash
struct ifaddrmsg { \n unsigned char ifa_family; /* Address type */ \n unsigned char ifa_prefixlen; /* Prefixlength of address */ \n unsigned char ifa_flags; /* Address flags */ \n unsigned char ifa_scope; /* Address scope */ \n unsigned int ifa_index; /* Interface index */ }; Attributes rta_type Value type Description IFA_UNSPEC - unspecified IFA_ADDRESS raw protocol address interface address IFA_LOCAL raw protocol address local address IFA_LABEL asciiz string name of the interface IFA_BROADCAST raw protocol address broadcast address IFA_ANYCAST raw protocol address anycast address IFA_CACHEINFO struct ifa_cacheinfo Address information
- RTM_NEWROUTE
- RTM_DELROUTE
- RTM_GETROUTE
Create, remove, or receive information about a network route. These messages contain an rtmsg structure with an optional sequence of rtattr structures following. For RTM_GETROUTE, setting rtm_dst_len and rtm_src_len to 0 means you get all entries for the specified routing table. For the other fields, except rtm_table and rtm_protocol, 0 is the wildcard.
- bash
struct rtmsg { \n unsigned char rtm_family; /* Address family of route */ \n unsigned char rtm_dst_len; /* Length of destination */ \n unsigned char rtm_src_len; /* Length of source */ \n unsigned char rtm_tos; /* TOS filter */ \n unsigned char rtm_table; /* Routing table ID; \n see RTA_TABLE below */ \n unsigned char rtm_protocol; /* Routing protocol; see below */ \n unsigned char rtm_scope; /* See below */ \n unsigned char rtm_type; /* See below */ \n unsigned int rtm_flags; };rtm_type Route type RTN_UNSPEC unknown route RTN_UNICAST a gateway or direct route RTN_LOCAL a local interface route RTN_BROADCAST a local broadcast route (sent as a broadcast) RTN_ANYCAST a local broadcast route (sent as a unicast) RTN_MULTICAST a multicast route RTN_BLACKHOLE a packet dropping route RTN_UNREACHABLE an unreachable destination RTN_PROHIBIT a packet rejection route RTN_THROW continue routing lookup in another table RTN_NAT a network address translation rule RTN_XRESOLVE refer to an external resolver (not implemented) rtm_protocol Route origin RTPROT_UNSPEC unknown RTPROT_REDIRECT by an ICMP redirect (currently unused) RTPROT_KERNEL by the kernel RTPROT_BOOT during boot RTPROT_STATIC by the administrator Values larger than RTPROT_STATIC are not interpreted by the kernel, they are just for user information. They may be used to tag the source of a routing information or to distinguish between multiple routing daemons. See <linux/rtnetlink.h> for the routing daemon identifiers which are already assigned.
RT_SCOPE_UNIVERSE global route RT_SCOPE_SITE interior route in the local autonomous system RT_SCOPE_LINK route on this link RT_SCOPE_HOST route on the local host RT_SCOPE_NOWHERE destination doesn't exist The values between RT_SCOPE_UNIVERSE and RT_SCOPE_SITE are available to the user.
RTM_F_NOTIFY if the route changes, notify the user via rtnetlink RTM_F_CLONED route is cloned from another route RTM_F_EQUALIZE a multipath equalizer (not yet implemented) RT_TABLE_UNSPEC an unspecified routing table RT_TABLE_DEFAULT the default table RT_TABLE_MAIN the main table RT_TABLE_LOCAL the local table Attributes rta_type Value type Description RTA_UNSPEC - ignored RTA_DST protocol address Route destination address RTA_SRC protocol address Route source address RTA_IIF int Input interface index RTA_OIF int Output interface index RTA_GATEWAY protocol address The gateway of the route RTA_PRIORITY int Priority of route RTA_PREFSRC protocol address Preferred source address RTA_METRICS int Route metric RTA_MULTIPATH Multipath nexthop data br (see below). RTA_PROTOINFO No longer used RTA_FLOW int Route realm RTA_CACHEINFO struct rta_cacheinfo (see linux/rtnetlink.h) RTA_SESSION No longer used RTA_MP_ALGO No longer used RTA_TABLE int Routing table ID; if set, rtm_table is ignored RTA_MARK int RTA_MFC_STATS struct rta_mfc_stats (see linux/rtnetlink.h) RTA_VIA struct rtvia Gateway in different AF (see below) RTA_NEWDST protocol address Change packet destination address RTA_PREF char RFC4191 IPv6 router preference (see below) RTA_ENCAP_TYPE short Encapsulation type for lwtunnels (see below) RTA_ENCAP Defined by RTA_ENCAP_TYPE RTA_EXPIRES int Expire time for IPv6 routes (in seconds) RTA_MULTIPATH contains several packed instances of struct rtnexthop together with nested RTAs (RTA_GATEWAY):
- bash
struct rtnexthop { \n unsigned short rtnh_len; /* Length of struct + length \n of RTAs */ \n unsigned char rtnh_flags; /* Flags (see \n linux/rtnetlink.h) */ \n unsigned char rtnh_hops; /* Nexthop priority */ \n int rtnh_ifindex; /* Interface index for this \n nexthop */ } There exist a bunch of RTNH_* macros similar to RTA_* and NLHDR_* macros useful to handle these structures.
- bash
struct rtvia { \n unsigned short rtvia_family; \n unsigned char rtvia_addr[0]; }; rtvia_addr is the address, rtvia_family is its family type.
RTA_PREF may contain values ICMPV6_ROUTER_PREF_LOW, ICMPV6_ROUTER_PREF_MEDIUM, and ICMPV6_ROUTER_PREF_HIGH defined incw <linux/icmpv6.h>.
RTA_ENCAP_TYPE may contain values LWTUNNEL_ENCAP_MPLS, LWTUNNEL_ENCAP_IP, LWTUNNEL_ENCAP_ILA, or LWTUNNEL_ENCAP_IP6 defined in <linux/lwtunnel.h>.
Fill these values in!
- RTM_NEWNEIGH
- RTM_DELNEIGH
- RTM_GETNEIGH
Add, remove, or receive information about a neighbor table entry (e.g., an ARP entry). The message contains an ndmsg structure.
- bash
struct ndmsg { \n unsigned char ndm_family; \n int ndm_ifindex; /* Interface index */ \n __u16 ndm_state; /* State */ \n __u8 ndm_flags; /* Flags */ \n __u8 ndm_type; }; struct nda_cacheinfo { \n __u32 ndm_confirmed; \n __u32 ndm_used; \n __u32 ndm_updated; \n __u32 ndm_refcnt; }; NUD_INCOMPLETE a currently resolving cache entry NUD_REACHABLE a confirmed working cache entry NUD_STALE an expired cache entry NUD_DELAY an entry waiting for a timer NUD_PROBE a cache entry that is currently reprobed NUD_FAILED an invalid cache entry NUD_NOARP a device with no destination cache NUD_PERMANENT a static entry NTF_PROXY a proxy arp entry NTF_ROUTER an IPv6 router NDA_UNSPEC unknown type NDA_DST a neighbor cache n/w layer destination address NDA_LLADDR a neighbor cache link layer address NDA_CACHEINFO cache statistics If the rta_type field is NDA_CACHEINFO, then a struct nda_cacheinfo header follows.
- RTM_NEWRULE
- RTM_DELRULE
- RTM_GETRULE
Add, delete, or retrieve a routing rule. Carries a struct rtmsg
- RTM_NEWQDISC
- RTM_DELQDISC
- RTM_GETQDISC
Add, remove, or get a queueing discipline. The message contains a struct tcmsg and may be followed by a series of attributes.
- bash
struct tcmsg { \n unsigned char tcm_family; \n int tcm_ifindex; /* interface index */ \n __u32 tcm_handle; /* Qdisc handle */ \n __u32 tcm_parent; /* Parent qdisc */ \n __u32 tcm_info; };Attributes rta_type Value type Description TCA_UNSPEC - unspecified TCA_KIND asciiz string Name of queueing discipline TCA_OPTIONS byte sequence Qdisc-specific options follow TCA_STATS struct tc_stats Qdisc statistics TCA_XSTATS qdisc-specific Module-specific statistics TCA_RATE struct tc_estimator Rate limit In addition, various other qdisc-module-specific attributes are allowed. For more information see the appropriate include files.
- RTM_NEWTCLASS
- RTM_DELTCLASS
- RTM_GETTCLASS
Add, remove, or get a traffic class. These messages contain a struct tcmsg as described above.
- RTM_NEWTFILTER
- RTM_DELTFILTER
- RTM_GETTFILTER
Add, remove, or receive information about a traffic filter. These messages contain a struct tcmsg as described above.
VERSIONS
rtnetlink is a new feature of Linux 2.2.
BUGS
This manual page is incomplete.
SEE ALSO
cmsg(3), rtnetlink(3), ip(7), netlink(7)