rtnetlink.h revision ab322673298bd0b8927cdd9d11f3d36af5941b93
1#ifndef __LINUX_RTNETLINK_H 2#define __LINUX_RTNETLINK_H 3 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> 9 10/**** 11 * Routing/neighbour discovery messages. 12 ****/ 13 14/* Types of messages */ 15 16enum { 17 RTM_BASE = 16, 18#define RTM_BASE RTM_BASE 19 20 RTM_NEWLINK = 16, 21#define RTM_NEWLINK RTM_NEWLINK 22 RTM_DELLINK, 23#define RTM_DELLINK RTM_DELLINK 24 RTM_GETLINK, 25#define RTM_GETLINK RTM_GETLINK 26 RTM_SETLINK, 27#define RTM_SETLINK RTM_SETLINK 28 29 RTM_NEWADDR = 20, 30#define RTM_NEWADDR RTM_NEWADDR 31 RTM_DELADDR, 32#define RTM_DELADDR RTM_DELADDR 33 RTM_GETADDR, 34#define RTM_GETADDR RTM_GETADDR 35 36 RTM_NEWROUTE = 24, 37#define RTM_NEWROUTE RTM_NEWROUTE 38 RTM_DELROUTE, 39#define RTM_DELROUTE RTM_DELROUTE 40 RTM_GETROUTE, 41#define RTM_GETROUTE RTM_GETROUTE 42 43 RTM_NEWNEIGH = 28, 44#define RTM_NEWNEIGH RTM_NEWNEIGH 45 RTM_DELNEIGH, 46#define RTM_DELNEIGH RTM_DELNEIGH 47 RTM_GETNEIGH, 48#define RTM_GETNEIGH RTM_GETNEIGH 49 50 RTM_NEWRULE = 32, 51#define RTM_NEWRULE RTM_NEWRULE 52 RTM_DELRULE, 53#define RTM_DELRULE RTM_DELRULE 54 RTM_GETRULE, 55#define RTM_GETRULE RTM_GETRULE 56 57 RTM_NEWQDISC = 36, 58#define RTM_NEWQDISC RTM_NEWQDISC 59 RTM_DELQDISC, 60#define RTM_DELQDISC RTM_DELQDISC 61 RTM_GETQDISC, 62#define RTM_GETQDISC RTM_GETQDISC 63 64 RTM_NEWTCLASS = 40, 65#define RTM_NEWTCLASS RTM_NEWTCLASS 66 RTM_DELTCLASS, 67#define RTM_DELTCLASS RTM_DELTCLASS 68 RTM_GETTCLASS, 69#define RTM_GETTCLASS RTM_GETTCLASS 70 71 RTM_NEWTFILTER = 44, 72#define RTM_NEWTFILTER RTM_NEWTFILTER 73 RTM_DELTFILTER, 74#define RTM_DELTFILTER RTM_DELTFILTER 75 RTM_GETTFILTER, 76#define RTM_GETTFILTER RTM_GETTFILTER 77 78 RTM_NEWACTION = 48, 79#define RTM_NEWACTION RTM_NEWACTION 80 RTM_DELACTION, 81#define RTM_DELACTION RTM_DELACTION 82 RTM_GETACTION, 83#define RTM_GETACTION RTM_GETACTION 84 85 RTM_NEWPREFIX = 52, 86#define RTM_NEWPREFIX RTM_NEWPREFIX 87 88 RTM_GETMULTICAST = 58, 89#define RTM_GETMULTICAST RTM_GETMULTICAST 90 91 RTM_GETANYCAST = 62, 92#define RTM_GETANYCAST RTM_GETANYCAST 93 94 RTM_NEWNEIGHTBL = 64, 95#define RTM_NEWNEIGHTBL RTM_NEWNEIGHTBL 96 RTM_GETNEIGHTBL = 66, 97#define RTM_GETNEIGHTBL RTM_GETNEIGHTBL 98 RTM_SETNEIGHTBL, 99#define RTM_SETNEIGHTBL RTM_SETNEIGHTBL 100 101 RTM_NEWNDUSEROPT = 68, 102#define RTM_NEWNDUSEROPT RTM_NEWNDUSEROPT 103 104 RTM_NEWADDRLABEL = 72, 105#define RTM_NEWADDRLABEL RTM_NEWADDRLABEL 106 RTM_DELADDRLABEL, 107#define RTM_DELADDRLABEL RTM_DELADDRLABEL 108 RTM_GETADDRLABEL, 109#define RTM_GETADDRLABEL RTM_GETADDRLABEL 110 111 RTM_GETDCB = 78, 112#define RTM_GETDCB RTM_GETDCB 113 RTM_SETDCB, 114#define RTM_SETDCB RTM_SETDCB 115 116 __RTM_MAX, 117#define RTM_MAX (((__RTM_MAX + 3) & ~3) - 1) 118}; 119 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) 123 124/* 125 Generic structure for encapsulation of optional route information. 126 It is reminiscent of sockaddr, but with sa_family replaced 127 with attribute type. 128 */ 129 130struct rtattr { 131 unsigned short rta_len; 132 unsigned short rta_type; 133}; 134 135/* Macros to handle rtattributes */ 136 137#define RTA_ALIGNTO 4 138#define RTA_ALIGN(len) ( ((len)+RTA_ALIGNTO-1) & ~(RTA_ALIGNTO-1) ) 139#define RTA_OK(rta,len) ((len) >= (int)sizeof(struct rtattr) && \ 140 (rta)->rta_len >= sizeof(struct rtattr) && \ 141 (rta)->rta_len <= (len)) 142#define RTA_NEXT(rta,attrlen) ((attrlen) -= RTA_ALIGN((rta)->rta_len), \ 143 (struct rtattr*)(((char*)(rta)) + RTA_ALIGN((rta)->rta_len))) 144#define RTA_LENGTH(len) (RTA_ALIGN(sizeof(struct rtattr)) + (len)) 145#define RTA_SPACE(len) RTA_ALIGN(RTA_LENGTH(len)) 146#define RTA_DATA(rta) ((void*)(((char*)(rta)) + RTA_LENGTH(0))) 147#define RTA_PAYLOAD(rta) ((int)((rta)->rta_len) - RTA_LENGTH(0)) 148 149 150 151 152/****************************************************************************** 153 * Definitions used in routing table administration. 154 ****/ 155 156struct rtmsg { 157 unsigned char rtm_family; 158 unsigned char rtm_dst_len; 159 unsigned char rtm_src_len; 160 unsigned char rtm_tos; 161 162 unsigned char rtm_table; /* Routing table id */ 163 unsigned char rtm_protocol; /* Routing protocol; see below */ 164 unsigned char rtm_scope; /* See below */ 165 unsigned char rtm_type; /* See below */ 166 167 unsigned rtm_flags; 168}; 169 170/* rtm_type */ 171 172enum { 173 RTN_UNSPEC, 174 RTN_UNICAST, /* Gateway or direct route */ 175 RTN_LOCAL, /* Accept locally */ 176 RTN_BROADCAST, /* Accept locally as broadcast, 177 send as broadcast */ 178 RTN_ANYCAST, /* Accept locally as broadcast, 179 but send as unicast */ 180 RTN_MULTICAST, /* Multicast route */ 181 RTN_BLACKHOLE, /* Drop */ 182 RTN_UNREACHABLE, /* Destination is unreachable */ 183 RTN_PROHIBIT, /* Administratively prohibited */ 184 RTN_THROW, /* Not in this table */ 185 RTN_NAT, /* Translate this address */ 186 RTN_XRESOLVE, /* Use external resolver */ 187 __RTN_MAX 188}; 189 190#define RTN_MAX (__RTN_MAX - 1) 191 192 193/* rtm_protocol */ 194 195#define RTPROT_UNSPEC 0 196#define RTPROT_REDIRECT 1 /* Route installed by ICMP redirects; 197 not used by current IPv4 */ 198#define RTPROT_KERNEL 2 /* Route installed by kernel */ 199#define RTPROT_BOOT 3 /* Route installed during boot */ 200#define RTPROT_STATIC 4 /* Route installed by administrator */ 201 202/* Values of protocol >= RTPROT_STATIC are not interpreted by kernel; 203 they are just passed from user and back as is. 204 It will be used by hypothetical multiple routing daemons. 205 Note that protocol values should be standardized in order to 206 avoid conflicts. 207 */ 208 209#define RTPROT_GATED 8 /* Apparently, GateD */ 210#define RTPROT_RA 9 /* RDISC/ND router advertisements */ 211#define RTPROT_MRT 10 /* Merit MRT */ 212#define RTPROT_ZEBRA 11 /* Zebra */ 213#define RTPROT_BIRD 12 /* BIRD */ 214#define RTPROT_DNROUTED 13 /* DECnet routing daemon */ 215#define RTPROT_XORP 14 /* XORP */ 216#define RTPROT_NTK 15 /* Netsukuku */ 217#define RTPROT_DHCP 16 /* DHCP client */ 218 219/* rtm_scope 220 221 Really it is not scope, but sort of distance to the destination. 222 NOWHERE are reserved for not existing destinations, HOST is our 223 local addresses, LINK are destinations, located on directly attached 224 link and UNIVERSE is everywhere in the Universe. 225 226 Intermediate values are also possible f.e. interior routes 227 could be assigned a value between UNIVERSE and LINK. 228*/ 229 230enum rt_scope_t { 231 RT_SCOPE_UNIVERSE=0, 232/* User defined values */ 233 RT_SCOPE_SITE=200, 234 RT_SCOPE_LINK=253, 235 RT_SCOPE_HOST=254, 236 RT_SCOPE_NOWHERE=255 237}; 238 239/* rtm_flags */ 240 241#define RTM_F_NOTIFY 0x100 /* Notify user of route change */ 242#define RTM_F_CLONED 0x200 /* This route is cloned */ 243#define RTM_F_EQUALIZE 0x400 /* Multipath equalizer: NI */ 244#define RTM_F_PREFIX 0x800 /* Prefix addresses */ 245 246/* Reserved table identifiers */ 247 248enum rt_class_t { 249 RT_TABLE_UNSPEC=0, 250/* User defined values */ 251 RT_TABLE_COMPAT=252, 252 RT_TABLE_DEFAULT=253, 253 RT_TABLE_MAIN=254, 254 RT_TABLE_LOCAL=255, 255 RT_TABLE_MAX=0xFFFFFFFF 256}; 257 258 259/* Routing message attributes */ 260 261enum rtattr_type_t { 262 RTA_UNSPEC, 263 RTA_DST, 264 RTA_SRC, 265 RTA_IIF, 266 RTA_OIF, 267 RTA_GATEWAY, 268 RTA_PRIORITY, 269 RTA_PREFSRC, 270 RTA_METRICS, 271 RTA_MULTIPATH, 272 RTA_PROTOINFO, /* no longer used */ 273 RTA_FLOW, 274 RTA_CACHEINFO, 275 RTA_SESSION, /* no longer used */ 276 RTA_MP_ALGO, /* no longer used */ 277 RTA_TABLE, 278 __RTA_MAX 279}; 280 281#define RTA_MAX (__RTA_MAX - 1) 282 283#define RTM_RTA(r) ((struct rtattr*)(((char*)(r)) + NLMSG_ALIGN(sizeof(struct rtmsg)))) 284#define RTM_PAYLOAD(n) NLMSG_PAYLOAD(n,sizeof(struct rtmsg)) 285 286/* RTM_MULTIPATH --- array of struct rtnexthop. 287 * 288 * "struct rtnexthop" describes all necessary nexthop information, 289 * i.e. parameters of path to a destination via this nexthop. 290 * 291 * At the moment it is impossible to set different prefsrc, mtu, window 292 * and rtt for different paths from multipath. 293 */ 294 295struct rtnexthop { 296 unsigned short rtnh_len; 297 unsigned char rtnh_flags; 298 unsigned char rtnh_hops; 299 int rtnh_ifindex; 300}; 301 302/* rtnh_flags */ 303 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 */ 307 308/* Macros to handle hexthops */ 309 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))) 318 319/* RTM_CACHEINFO */ 320 321struct rta_cacheinfo { 322 __u32 rta_clntref; 323 __u32 rta_lastuse; 324 __s32 rta_expires; 325 __u32 rta_error; 326 __u32 rta_used; 327 328#define RTNETLINK_HAVE_PEERINFO 1 329 __u32 rta_id; 330 __u32 rta_ts; 331 __u32 rta_tsage; 332}; 333 334/* RTM_METRICS --- array of struct rtattr with types of RTAX_* */ 335 336enum { 337 RTAX_UNSPEC, 338#define RTAX_UNSPEC RTAX_UNSPEC 339 RTAX_LOCK, 340#define RTAX_LOCK RTAX_LOCK 341 RTAX_MTU, 342#define RTAX_MTU RTAX_MTU 343 RTAX_WINDOW, 344#define RTAX_WINDOW RTAX_WINDOW 345 RTAX_RTT, 346#define RTAX_RTT RTAX_RTT 347 RTAX_RTTVAR, 348#define RTAX_RTTVAR RTAX_RTTVAR 349 RTAX_SSTHRESH, 350#define RTAX_SSTHRESH RTAX_SSTHRESH 351 RTAX_CWND, 352#define RTAX_CWND RTAX_CWND 353 RTAX_ADVMSS, 354#define RTAX_ADVMSS RTAX_ADVMSS 355 RTAX_REORDERING, 356#define RTAX_REORDERING RTAX_REORDERING 357 RTAX_HOPLIMIT, 358#define RTAX_HOPLIMIT RTAX_HOPLIMIT 359 RTAX_INITCWND, 360#define RTAX_INITCWND RTAX_INITCWND 361 RTAX_FEATURES, 362#define RTAX_FEATURES RTAX_FEATURES 363 RTAX_RTO_MIN, 364#define RTAX_RTO_MIN RTAX_RTO_MIN 365 __RTAX_MAX 366}; 367 368#define RTAX_MAX (__RTAX_MAX - 1) 369 370#define RTAX_FEATURE_ECN 0x00000001 371#define RTAX_FEATURE_SACK 0x00000002 372#define RTAX_FEATURE_TIMESTAMP 0x00000004 373#define RTAX_FEATURE_ALLFRAG 0x00000008 374 375struct rta_session { 376 __u8 proto; 377 __u8 pad1; 378 __u16 pad2; 379 380 union { 381 struct { 382 __u16 sport; 383 __u16 dport; 384 } ports; 385 386 struct { 387 __u8 type; 388 __u8 code; 389 __u16 ident; 390 } icmpt; 391 392 __u32 spi; 393 } u; 394}; 395 396/**** 397 * General form of address family dependent message. 398 ****/ 399 400struct rtgenmsg { 401 unsigned char rtgen_family; 402}; 403 404/***************************************************************** 405 * Link layer specific messages. 406 ****/ 407 408/* struct ifinfomsg 409 * passes link level specific information, not dependent 410 * on network protocol. 411 */ 412 413struct ifinfomsg { 414 unsigned char ifi_family; 415 unsigned char __ifi_pad; 416 unsigned short ifi_type; /* ARPHRD_* */ 417 int ifi_index; /* Link index */ 418 unsigned ifi_flags; /* IFF_* flags */ 419 unsigned ifi_change; /* IFF_* change mask */ 420}; 421 422/******************************************************************** 423 * prefix information 424 ****/ 425 426struct prefixmsg { 427 unsigned char prefix_family; 428 unsigned char prefix_pad1; 429 unsigned short prefix_pad2; 430 int prefix_ifindex; 431 unsigned char prefix_type; 432 unsigned char prefix_len; 433 unsigned char prefix_flags; 434 unsigned char prefix_pad3; 435}; 436 437enum 438{ 439 PREFIX_UNSPEC, 440 PREFIX_ADDRESS, 441 PREFIX_CACHEINFO, 442 __PREFIX_MAX 443}; 444 445#define PREFIX_MAX (__PREFIX_MAX - 1) 446 447struct prefix_cacheinfo { 448 __u32 preferred_time; 449 __u32 valid_time; 450}; 451 452 453/***************************************************************** 454 * Traffic control messages. 455 ****/ 456 457struct tcmsg { 458 unsigned char tcm_family; 459 unsigned char tcm__pad1; 460 unsigned short tcm__pad2; 461 int tcm_ifindex; 462 __u32 tcm_handle; 463 __u32 tcm_parent; 464 __u32 tcm_info; 465}; 466 467enum { 468 TCA_UNSPEC, 469 TCA_KIND, 470 TCA_OPTIONS, 471 TCA_STATS, 472 TCA_XSTATS, 473 TCA_RATE, 474 TCA_FCNT, 475 TCA_STATS2, 476 TCA_STAB, 477 __TCA_MAX 478}; 479 480#define TCA_MAX (__TCA_MAX - 1) 481 482#define TCA_RTA(r) ((struct rtattr*)(((char*)(r)) + NLMSG_ALIGN(sizeof(struct tcmsg)))) 483#define TCA_PAYLOAD(n) NLMSG_PAYLOAD(n,sizeof(struct tcmsg)) 484 485/******************************************************************** 486 * Neighbor Discovery userland options 487 ****/ 488 489struct nduseroptmsg { 490 unsigned char nduseropt_family; 491 unsigned char nduseropt_pad1; 492 unsigned short nduseropt_opts_len; /* Total length of options */ 493 int nduseropt_ifindex; 494 __u8 nduseropt_icmp_type; 495 __u8 nduseropt_icmp_code; 496 unsigned short nduseropt_pad2; 497 unsigned int nduseropt_pad3; 498 /* Followed by one or more ND options */ 499}; 500 501enum { 502 NDUSEROPT_UNSPEC, 503 NDUSEROPT_SRCADDR, 504 __NDUSEROPT_MAX 505}; 506 507#define NDUSEROPT_MAX (__NDUSEROPT_MAX - 1) 508 509/* RTnetlink multicast groups - backwards compatibility for userspace */ 510#define RTMGRP_LINK 1 511#define RTMGRP_NOTIFY 2 512#define RTMGRP_NEIGH 4 513#define RTMGRP_TC 8 514 515#define RTMGRP_IPV4_IFADDR 0x10 516#define RTMGRP_IPV4_MROUTE 0x20 517#define RTMGRP_IPV4_ROUTE 0x40 518#define RTMGRP_IPV4_RULE 0x80 519 520#define RTMGRP_IPV6_IFADDR 0x100 521#define RTMGRP_IPV6_MROUTE 0x200 522#define RTMGRP_IPV6_ROUTE 0x400 523#define RTMGRP_IPV6_IFINFO 0x800 524 525#define RTMGRP_DECnet_IFADDR 0x1000 526#define RTMGRP_DECnet_ROUTE 0x4000 527 528#define RTMGRP_IPV6_PREFIX 0x20000 529 530/* RTnetlink multicast groups */ 531enum rtnetlink_groups { 532 RTNLGRP_NONE, 533#define RTNLGRP_NONE RTNLGRP_NONE 534 RTNLGRP_LINK, 535#define RTNLGRP_LINK RTNLGRP_LINK 536 RTNLGRP_NOTIFY, 537#define RTNLGRP_NOTIFY RTNLGRP_NOTIFY 538 RTNLGRP_NEIGH, 539#define RTNLGRP_NEIGH RTNLGRP_NEIGH 540 RTNLGRP_TC, 541#define RTNLGRP_TC RTNLGRP_TC 542 RTNLGRP_IPV4_IFADDR, 543#define RTNLGRP_IPV4_IFADDR RTNLGRP_IPV4_IFADDR 544 RTNLGRP_IPV4_MROUTE, 545#define RTNLGRP_IPV4_MROUTE RTNLGRP_IPV4_MROUTE 546 RTNLGRP_IPV4_ROUTE, 547#define RTNLGRP_IPV4_ROUTE RTNLGRP_IPV4_ROUTE 548 RTNLGRP_IPV4_RULE, 549#define RTNLGRP_IPV4_RULE RTNLGRP_IPV4_RULE 550 RTNLGRP_IPV6_IFADDR, 551#define RTNLGRP_IPV6_IFADDR RTNLGRP_IPV6_IFADDR 552 RTNLGRP_IPV6_MROUTE, 553#define RTNLGRP_IPV6_MROUTE RTNLGRP_IPV6_MROUTE 554 RTNLGRP_IPV6_ROUTE, 555#define RTNLGRP_IPV6_ROUTE RTNLGRP_IPV6_ROUTE 556 RTNLGRP_IPV6_IFINFO, 557#define RTNLGRP_IPV6_IFINFO RTNLGRP_IPV6_IFINFO 558 RTNLGRP_DECnet_IFADDR, 559#define RTNLGRP_DECnet_IFADDR RTNLGRP_DECnet_IFADDR 560 RTNLGRP_NOP2, 561 RTNLGRP_DECnet_ROUTE, 562#define RTNLGRP_DECnet_ROUTE RTNLGRP_DECnet_ROUTE 563 RTNLGRP_DECnet_RULE, 564#define RTNLGRP_DECnet_RULE RTNLGRP_DECnet_RULE 565 RTNLGRP_NOP4, 566 RTNLGRP_IPV6_PREFIX, 567#define RTNLGRP_IPV6_PREFIX RTNLGRP_IPV6_PREFIX 568 RTNLGRP_IPV6_RULE, 569#define RTNLGRP_IPV6_RULE RTNLGRP_IPV6_RULE 570 RTNLGRP_ND_USEROPT, 571#define RTNLGRP_ND_USEROPT RTNLGRP_ND_USEROPT 572 RTNLGRP_PHONET_IFADDR, 573#define RTNLGRP_PHONET_IFADDR RTNLGRP_PHONET_IFADDR 574 RTNLGRP_PHONET_ROUTE, 575#define RTNLGRP_PHONET_ROUTE RTNLGRP_PHONET_ROUTE 576 __RTNLGRP_MAX 577}; 578#define RTNLGRP_MAX (__RTNLGRP_MAX - 1) 579 580/* TC action piece */ 581struct tcamsg { 582 unsigned char tca_family; 583 unsigned char tca__pad1; 584 unsigned short tca__pad2; 585}; 586#define TA_RTA(r) ((struct rtattr*)(((char*)(r)) + NLMSG_ALIGN(sizeof(struct tcamsg)))) 587#define TA_PAYLOAD(n) NLMSG_PAYLOAD(n,sizeof(struct tcamsg)) 588#define TCA_ACT_TAB 1 /* attr type must be >=1 */ 589#define TCAA_MAX 1 590 591/* End of information exported to user level */ 592 593 594 595#endif /* __LINUX_RTNETLINK_H */ 596