lib/prefix.h

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*
   3  * Prefix structure.
   4  * Copyright (C) 1998 Kunihiro Ishiguro
   5  */
   6
   7 #ifndef _ZEBRA_PREFIX_H
   8 #define _ZEBRA_PREFIX_H
   9
  10 #ifdef GNU_LINUX
  11 #include <net/ethernet.h>
  12 #else
  13 #include <netinet/if_ether.h>
  14 #endif
  15 #include "sockunion.h"
  16 #include "ipaddr.h"
  17 #include "compiler.h"
  18
  19 #ifdef __cplusplus
  20 extern "C" {
  21 #endif
  22
  23 #ifndef ETH_ALEN
  24 #define ETH_ALEN 6
  25 #endif
  26
  27 /* EVPN route types. */
  28 typedef enum {
  29         BGP_EVPN_AD_ROUTE = 1,    /* Ethernet Auto-Discovery (A-D) route */
  30         BGP_EVPN_MAC_IP_ROUTE,    /* MAC/IP Advertisement route */
  31         BGP_EVPN_IMET_ROUTE,      /* Inclusive Multicast Ethernet Tag route */
  32         BGP_EVPN_ES_ROUTE,        /* Ethernet Segment route */
  33         BGP_EVPN_IP_PREFIX_ROUTE, /* IP Prefix route */
  34 } bgp_evpn_route_type;
  35
  36 /* value of first byte of ESI */
  37 #define ESI_TYPE_ARBITRARY 0  /* */
  38 #define ESI_TYPE_LACP      1  /* <> */
  39 #define ESI_TYPE_BRIDGE    2  /* <Root bridge Mac-6B>:<Root Br Priority-2B>:00 */
  40 #define ESI_TYPE_MAC       3  /* <Syst Mac Add-6B>:<Local Discriminator Value-3B> */
  41 #define ESI_TYPE_ROUTER    4  /* <RouterId-4B>:<Local Discriminator Value-4B> */
  42 #define ESI_TYPE_AS        5  /* <AS-4B>:<Local Discriminator Value-4B> */
  43
  44 #define MAX_ESI {0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff}
  45
  46
  47 #define EVPN_ETH_TAG_BYTES 4
  48 #define ESI_BYTES 10
  49 #define ESI_STR_LEN (3 * ESI_BYTES)
  50 #define EVPN_DF_ALG_STR_LEN 24
  51
  52 /* Maximum number of VTEPs per-ES -
  53  * XXX - temporary limit for allocating strings etc.
  54  */
  55 #define ES_VTEP_MAX_CNT 10
  56 #define ES_VTEP_LIST_STR_SZ (ES_VTEP_MAX_CNT * 16)
  57
  58 #define ETHER_ADDR_STRLEN (3*ETH_ALEN)
  59 /*
  60  * there isn't a portable ethernet address type. We define our
  61  * own to simplify internal handling
  62  */
  63 struct ethaddr {
  64         uint8_t octet[ETH_ALEN];
  65 } __attribute__((packed));
  66
  67
  68 /* length is the number of valuable bits of prefix structure
  69 * 18 bytes is current length in structure, if address is ipv4
  70 * 30 bytes is in case of ipv6
  71 */
  72 #define PREFIX_LEN_ROUTE_TYPE_5_IPV4 (18*8)
  73 #define PREFIX_LEN_ROUTE_TYPE_5_IPV6 (30*8)
  74
  75 typedef struct esi_t_ {
  76         uint8_t val[ESI_BYTES];
  77 } esi_t;
  78
  79 struct evpn_ead_addr {
  80         esi_t esi;
  81         uint32_t eth_tag;
  82         struct ipaddr ip;
  83         uint16_t frag_id;
  84 };
  85
  86 struct evpn_macip_addr {
  87         uint32_t eth_tag;
  88         uint8_t ip_prefix_length;
  89         struct ethaddr mac;
  90         struct ipaddr ip;
  91 };
  92
  93 struct evpn_imet_addr {
  94         uint32_t eth_tag;
  95         uint8_t ip_prefix_length;
  96         struct ipaddr ip;
  97 };
  98
  99 struct evpn_es_addr {
 100         esi_t esi;
 101         uint8_t ip_prefix_length;
 102         struct ipaddr ip;
 103 };
 104
 105 struct evpn_prefix_addr {
 106         uint32_t eth_tag;
 107         uint8_t ip_prefix_length;
 108         struct ipaddr ip;
 109 };
 110
 111 /* EVPN address (RFC 7432) */
 112 struct evpn_addr {
 113         uint8_t route_type;
 114         union {
 115                 struct evpn_ead_addr _ead_addr;
 116                 struct evpn_macip_addr _macip_addr;
 117                 struct evpn_imet_addr _imet_addr;
 118                 struct evpn_es_addr _es_addr;
 119                 struct evpn_prefix_addr _prefix_addr;
 120         } u;
 121 #define ead_addr u._ead_addr
 122 #define macip_addr u._macip_addr
 123 #define imet_addr u._imet_addr
 124 #define es_addr u._es_addr
 125 #define prefix_addr u._prefix_addr
 126 };
 127
 128 /*
 129  * A struct prefix contains an address family, a prefix length, and an
 130  * address.  This can represent either a 'network prefix' as defined
 131  * by CIDR, where the 'host bits' of the prefix are 0
 132  * (e.g. AF_INET:10.0.0.0/8), or an address and netmask
 133  * (e.g. AF_INET:10.0.0.9/8), such as might be configured on an
 134  * interface.
 135  */
 136
 137 /* different OSes use different names */
 138 #if defined(AF_PACKET)
 139 #define AF_ETHERNET AF_PACKET
 140 #else
 141 #if defined(AF_LINK)
 142 #define AF_ETHERNET AF_LINK
 143 #endif
 144 #endif
 145
 146 /* The 'family' in the prefix structure is internal to FRR and need not
 147  * map to standard OS AF_ definitions except where needed for interacting
 148  * with the kernel. However, AF_ definitions are currently in use and
 149  * prevalent across the code. Define a new FRR-specific AF for EVPN to
 150  * distinguish between 'ethernet' (MAC-only) and 'evpn' prefixes and
 151  * ensure it does not conflict with any OS AF_ definition.
 152  */
 153 #if !defined(AF_EVPN)
 154 #define AF_EVPN (AF_MAX + 1)
 155 #endif
 156
 157 #if !defined(AF_FLOWSPEC)
 158 #define AF_FLOWSPEC (AF_MAX + 2)
 159 #endif
 160
 161 struct flowspec_prefix {
 162         uint8_t family;
 163         uint16_t prefixlen; /* length in bytes */
 164         uintptr_t ptr;
 165 };
 166
 167 /* FRR generic prefix structure. */
 168 struct prefix {
 169         uint8_t family;
 170         uint16_t prefixlen;
 171         union {
 172                 uint8_t prefix;
 173                 struct in_addr prefix4;
 174                 struct in6_addr prefix6;
 175                 struct {
 176                         struct in_addr id;
 177                         struct in_addr adv_router;
 178                 } lp;
 179                 struct ethaddr prefix_eth; /* AF_ETHERNET */
 180                 uint8_t val[16];
 181                 uint32_t val32[4];
 182                 uintptr_t ptr;
 183                 struct evpn_addr prefix_evpn; /* AF_EVPN */
 184                 struct flowspec_prefix prefix_flowspec; /* AF_FLOWSPEC */
 185         } u __attribute__((aligned(8)));
 186 };
 187
 188 /* IPv4 prefix structure. */
 189 struct prefix_ipv4 {
 190         uint8_t family;
 191         uint16_t prefixlen;
 192         struct in_addr prefix __attribute__((aligned(8)));
 193 };
 194
 195 /* IPv6 prefix structure. */
 196 struct prefix_ipv6 {
 197         uint8_t family;
 198         uint16_t prefixlen;
 199         struct in6_addr prefix __attribute__((aligned(8)));
 200 };
 201
 202 struct prefix_ls {
 203         uint8_t family;
 204         uint16_t prefixlen;
 205         struct in_addr id __attribute__((aligned(8)));
 206         struct in_addr adv_router;
 207 };
 208
 209 /* Prefix for routing distinguisher. */
 210 struct prefix_rd {
 211         uint8_t family;
 212         uint16_t prefixlen;
 213         uint8_t val[8] __attribute__((aligned(8)));
 214 };
 215
 216 /* Prefix for ethernet. */
 217 struct prefix_eth {
 218         uint8_t family;
 219         uint16_t prefixlen;
 220         struct ethaddr eth_addr __attribute__((aligned(8))); /* AF_ETHERNET */
 221 };
 222
 223 /* EVPN prefix structure. */
 224 struct prefix_evpn {
 225         uint8_t family;
 226         uint16_t prefixlen;
 227         struct evpn_addr prefix __attribute__((aligned(8)));
 228 };
 229
 230 static inline int is_evpn_prefix_ipaddr_none(const struct prefix_evpn *evp)
 231 {
 232         if (evp->prefix.route_type == BGP_EVPN_AD_ROUTE)
 233                 return IS_IPADDR_NONE(&(evp)->prefix.ead_addr.ip);
 234         if (evp->prefix.route_type == BGP_EVPN_MAC_IP_ROUTE)
 235                 return IS_IPADDR_NONE(&(evp)->prefix.macip_addr.ip);
 236         if (evp->prefix.route_type == BGP_EVPN_IMET_ROUTE)
 237                 return IS_IPADDR_NONE(&(evp)->prefix.imet_addr.ip);
 238         if (evp->prefix.route_type == BGP_EVPN_ES_ROUTE)
 239                 return IS_IPADDR_NONE(&(evp)->prefix.es_addr.ip);
 240         if (evp->prefix.route_type == BGP_EVPN_IP_PREFIX_ROUTE)
 241                 return IS_IPADDR_NONE(&(evp)->prefix.prefix_addr.ip);
 242         return 0;
 243 }
 244
 245 static inline int is_evpn_prefix_ipaddr_v4(const struct prefix_evpn *evp)
 246 {
 247         if (evp->prefix.route_type == BGP_EVPN_AD_ROUTE)
 248                 return IS_IPADDR_V4(&(evp)->prefix.ead_addr.ip);
 249         if (evp->prefix.route_type == BGP_EVPN_MAC_IP_ROUTE)
 250                 return IS_IPADDR_V4(&(evp)->prefix.macip_addr.ip);
 251         if (evp->prefix.route_type == BGP_EVPN_IMET_ROUTE)
 252                 return IS_IPADDR_V4(&(evp)->prefix.imet_addr.ip);
 253         if (evp->prefix.route_type == BGP_EVPN_ES_ROUTE)
 254                 return IS_IPADDR_V4(&(evp)->prefix.es_addr.ip);
 255         if (evp->prefix.route_type == BGP_EVPN_IP_PREFIX_ROUTE)
 256                 return IS_IPADDR_V4(&(evp)->prefix.prefix_addr.ip);
 257         return 0;
 258 }
 259
 260 static inline int is_evpn_prefix_ipaddr_v6(const struct prefix_evpn *evp)
 261 {
 262         if (evp->prefix.route_type == BGP_EVPN_AD_ROUTE)
 263                 return IS_IPADDR_V6(&(evp)->prefix.ead_addr.ip);
 264         if (evp->prefix.route_type == BGP_EVPN_MAC_IP_ROUTE)
 265                 return IS_IPADDR_V6(&(evp)->prefix.macip_addr.ip);
 266         if (evp->prefix.route_type == BGP_EVPN_IMET_ROUTE)
 267                 return IS_IPADDR_V6(&(evp)->prefix.imet_addr.ip);
 268         if (evp->prefix.route_type == BGP_EVPN_ES_ROUTE)
 269                 return IS_IPADDR_V6(&(evp)->prefix.es_addr.ip);
 270         if (evp->prefix.route_type == BGP_EVPN_IP_PREFIX_ROUTE)
 271                 return IS_IPADDR_V6(&(evp)->prefix.prefix_addr.ip);
 272         return 0;
 273 }
 274
 275 /* Prefix for a Flowspec entry */
 276 struct prefix_fs {
 277         uint8_t family;
 278         uint16_t prefixlen; /* unused */
 279         struct flowspec_prefix  prefix __attribute__((aligned(8)));
 280 };
 281
 282 struct prefix_sg {
 283         uint8_t family;
 284         uint16_t prefixlen;
 285         struct in_addr src __attribute__((aligned(8)));
 286         struct in_addr grp;
 287 };
 288
 289 union prefixptr {
 290         prefixtype(prefixptr, struct prefix,      p)
 291         prefixtype(prefixptr, struct prefix_ipv4, p4)
 292         prefixtype(prefixptr, struct prefix_ipv6, p6)
 293         prefixtype(prefixptr, struct prefix_evpn, evp)
 294         prefixtype(prefixptr, struct prefix_fs,   fs)
 295         prefixtype(prefixptr, struct prefix_rd,   rd)
 296 } TRANSPARENT_UNION;
 297
 298 union prefixconstptr {
 299         prefixtype(prefixconstptr, const struct prefix,      p)
 300         prefixtype(prefixconstptr, const struct prefix_ipv4, p4)
 301         prefixtype(prefixconstptr, const struct prefix_ipv6, p6)
 302         prefixtype(prefixconstptr, const struct prefix_evpn, evp)
 303         prefixtype(prefixconstptr, const struct prefix_fs,   fs)
 304         prefixtype(prefixconstptr, const struct prefix_rd,   rd)
 305 } TRANSPARENT_UNION;
 306
 307 #ifndef INET_ADDRSTRLEN
 308 #define INET_ADDRSTRLEN 16
 309 #endif /* INET_ADDRSTRLEN */
 310
 311 #ifndef INET6_ADDRSTRLEN
 312 /* dead:beef:dead:beef:dead:beef:dead:beef + \0 */
 313 #define INET6_ADDRSTRLEN 46
 314 #endif /* INET6_ADDRSTRLEN */
 315
 316 #ifndef INET6_BUFSIZ
 317 #define INET6_BUFSIZ 53
 318 #endif /* INET6_BUFSIZ */
 319
 320 /* Maximum string length of the result of prefix2str */
 321 #define PREFIX_STRLEN 80
 322
 323 /*
 324  * Longest possible length of a (S,G) string is 34 bytes
 325  * 123.123.123.123 = 15 * 2
 326  * (,) = 3
 327  * NULL Character at end = 1
 328  * (123.123.123.123,123.123.123.123)
 329  */
 330 #define PREFIX_SG_STR_LEN 34
 331
 332 /* Max bit/byte length of IPv4 address. */
 333 #define IPV4_MAX_BYTELEN    4
 334 #define IPV4_MAX_BITLEN    32
 335 #define IPV4_ADDR_CMP(D,S)   memcmp ((D), (S), IPV4_MAX_BYTELEN)
 336
 337 static inline bool ipv4_addr_same(const struct in_addr *a,
 338                                   const struct in_addr *b)
 339 {
 340         return (a->s_addr == b->s_addr);
 341 }
 342 #define IPV4_ADDR_SAME(A,B)  ipv4_addr_same((A), (B))
 343
 344 static inline void ipv4_addr_copy(struct in_addr *dst,
 345                                   const struct in_addr *src)
 346 {
 347         dst->s_addr = src->s_addr;
 348 }
 349 #define IPV4_ADDR_COPY(D,S)  ipv4_addr_copy((D), (S))
 350
 351 #define IPV4_NET0(a) ((((uint32_t)(a)) & 0xff000000) == 0x00000000)
 352 #define IPV4_NET127(a) ((((uint32_t)(a)) & 0xff000000) == 0x7f000000)
 353 #define IPV4_LINKLOCAL(a) ((((uint32_t)(a)) & 0xffff0000) == 0xa9fe0000)
 354 #define IPV4_CLASS_D(a) ((((uint32_t)(a)) & 0xf0000000) == 0xe0000000)
 355 #define IPV4_CLASS_E(a) ((((uint32_t)(a)) & 0xf0000000) == 0xf0000000)
 356 #define IPV4_CLASS_DE(a) ((((uint32_t)(a)) & 0xe0000000) == 0xe0000000)
 357 #define IPV4_MC_LINKLOCAL(a) ((((uint32_t)(a)) & 0xffffff00) == 0xe0000000)
 358
 359 /* Max bit/byte length of IPv6 address. */
 360 #define IPV6_MAX_BYTELEN    16
 361 #define IPV6_MAX_BITLEN    128
 362 #define IPV6_ADDR_CMP(D,S)   memcmp ((D), (S), IPV6_MAX_BYTELEN)
 363 #define IPV6_ADDR_SAME(D,S)  (memcmp ((D), (S), IPV6_MAX_BYTELEN) == 0)
 364 #define IPV6_ADDR_COPY(D,S)  memcpy ((D), (S), IPV6_MAX_BYTELEN)
 365
 366 /* Count prefix size from mask length */
 367 #define PSIZE(a) (((a) + 7) / (8))
 368
 369 #define BSIZE(a) ((a) * (8))
 370
 371 /* Prefix's family member. */
 372 #define PREFIX_FAMILY(p)  ((p)->family)
 373
 374 /* glibc defines s6_addr32 to __in6_u.__u6_addr32 if __USE_{MISC || GNU} */
 375 #ifndef s6_addr32
 376 #define s6_addr32 __u6_addr.__u6_addr32
 377 #endif /*s6_addr32*/
 378
 379 /* Prototypes. */
 380 extern int str2family(const char *);
 381 extern int afi2family(afi_t);
 382 extern afi_t family2afi(int);
 383 extern const char *family2str(int family);
 384 extern const char *safi2str(safi_t safi);
 385 extern const char *afi2str(afi_t afi);
 386
 387 static inline afi_t prefix_afi(union prefixconstptr pu)
 388 {
 389         return family2afi(pu.p->family);
 390 }
 391
 392 /*
 393  * Check bit of the prefix.
 394  *
 395  * prefix
 396  *    byte buffer
 397  *
 398  * bit_index
 399  *    which bit to fetch from byte buffer, 0 indexed.
 400  */
 401 extern unsigned int prefix_bit(const uint8_t *prefix, const uint16_t bit_index);
 402
 403 extern struct prefix *prefix_new(void);
 404 extern void prefix_free(struct prefix **p);
 405 /*
 406  * Function to handle prefix_free being used as a del function.
 407  */
 408 extern void prefix_free_lists(void *arg);
 409 extern const char *prefix_family_str(union prefixconstptr pu);
 410 extern int prefix_blen(union prefixconstptr pu);
 411 extern int str2prefix(const char *, struct prefix *);
 412
 413 #define PREFIX2STR_BUFFER  PREFIX_STRLEN
 414
 415 extern void prefix_mcast_inet4_dump(const char *onfail, struct in_addr addr,
 416                                 char *buf, int buf_size);
 417 extern const char *prefix_sg2str(const struct prefix_sg *sg, char *str);
 418 extern const char *prefix2str(union prefixconstptr, char *, int);
 419 extern int evpn_type5_prefix_match(const struct prefix *evpn_pfx,
 420                                    const struct prefix *match_pfx);
 421 extern int prefix_match(union prefixconstptr unet, union prefixconstptr upfx);
 422 extern int prefix_match_network_statement(union prefixconstptr unet,
 423                                           union prefixconstptr upfx);
 424 extern int prefix_same(union prefixconstptr ua, union prefixconstptr ub);
 425 extern int prefix_cmp(union prefixconstptr ua, union prefixconstptr ub);
 426 extern int prefix_common_bits(union prefixconstptr ua, union prefixconstptr ub);
 427 extern void prefix_copy(union prefixptr udst, union prefixconstptr usrc);
 428 extern void apply_mask(union prefixptr pu);
 429
 430 #ifdef __clang_analyzer__
 431 /* clang-SA doesn't understand transparent unions, making it think that the
 432  * target of prefix_copy is uninitialized.  So just memset the target.
 433  * cf. https://bugs.llvm.org/show_bug.cgi?id=42811
 434  */
 435 #define prefix_copy(a, b) ({ memset(a, 0, sizeof(*a)); prefix_copy(a, b); })
 436 #endif
 437
 438 extern struct prefix *sockunion2hostprefix(const union sockunion *,
 439                                            struct prefix *p);
 440 extern void prefix2sockunion(const struct prefix *, union sockunion *);
 441
 442 extern int str2prefix_eth(const char *, struct prefix_eth *);
 443
 444 extern struct prefix_ipv4 *prefix_ipv4_new(void);
 445 extern void prefix_ipv4_free(struct prefix_ipv4 **p);
 446 extern int str2prefix_ipv4(const char *, struct prefix_ipv4 *);
 447 extern void apply_mask_ipv4(struct prefix_ipv4 *);
 448
 449 extern int prefix_ipv4_any(const struct prefix_ipv4 *);
 450 extern void apply_classful_mask_ipv4(struct prefix_ipv4 *);
 451
 452 extern uint8_t ip_masklen(struct in_addr);
 453 extern void masklen2ip(const int, struct in_addr *);
 454 /* given the address of a host on a network and the network mask length,
 455  * calculate the broadcast address for that network;
 456  * special treatment for /31 according to RFC3021 section 3.3 */
 457 extern in_addr_t ipv4_broadcast_addr(in_addr_t hostaddr, int masklen);
 458
 459 extern int netmask_str2prefix_str(const char *, const char *, char *, size_t);
 460
 461 extern struct prefix_ipv6 *prefix_ipv6_new(void);
 462 extern void prefix_ipv6_free(struct prefix_ipv6 **p);
 463 extern int str2prefix_ipv6(const char *, struct prefix_ipv6 *);
 464 extern void apply_mask_ipv6(struct prefix_ipv6 *);
 465
 466 extern int ip6_masklen(struct in6_addr);
 467 extern void masklen2ip6(const int, struct in6_addr *);
 468
 469 extern int is_zero_mac(const struct ethaddr *mac);
 470 extern bool is_mcast_mac(const struct ethaddr *mac);
 471 extern bool is_bcast_mac(const struct ethaddr *mac);
 472 extern int prefix_str2mac(const char *str, struct ethaddr *mac);
 473 extern char *prefix_mac2str(const struct ethaddr *mac, char *buf, int size);
 474
 475 extern unsigned prefix_hash_key(const void *pp);
 476
 477 extern int str_to_esi(const char *str, esi_t *esi);
 478 extern char *esi_to_str(const esi_t *esi, char *buf, int size);
 479 extern char *evpn_es_df_alg2str(uint8_t df_alg, char *buf, int buf_len);
 480 extern void prefix_evpn_hexdump(const struct prefix_evpn *p);
 481 extern bool ipv4_unicast_valid(const struct in_addr *addr);
 482 extern int evpn_prefix2prefix(const struct prefix *evpn, struct prefix *to);
 483
 484 static inline int ipv6_martian(const struct in6_addr *addr)
 485 {
 486         struct in6_addr localhost_addr;
 487
 488         inet_pton(AF_INET6, "::1", &localhost_addr);
 489
 490         if (IPV6_ADDR_SAME(&localhost_addr, addr))
 491                 return 1;
 492
 493         return 0;
 494 }
 495
 496 extern int macstr2prefix_evpn(const char *str, struct prefix_evpn *p);
 497
 498 /* NOTE: This routine expects the address argument in network byte order. */
 499 static inline bool ipv4_martian(const struct in_addr *addr)
 500 {
 501         in_addr_t ip = ntohl(addr->s_addr);
 502
 503         if (IPV4_NET0(ip) || IPV4_NET127(ip) || !ipv4_unicast_valid(addr)) {
 504                 return true;
 505         }
 506         return false;
 507 }
 508
 509 static inline bool is_default_prefix4(const struct prefix_ipv4 *p)
 510 {
 511         return p && p->family == AF_INET && p->prefixlen == 0
 512                && p->prefix.s_addr == INADDR_ANY;
 513 }
 514
 515 static inline bool is_default_prefix6(const struct prefix_ipv6 *p)
 516 {
 517         return p && p->family == AF_INET6 && p->prefixlen == 0
 518                && memcmp(&p->prefix, &in6addr_any, sizeof(struct in6_addr))
 519                           == 0;
 520 }
 521
 522 static inline bool is_default_prefix(const struct prefix *p)
 523 {
 524         if (p == NULL)
 525                 return false;
 526
 527         switch (p->family) {
 528         case AF_INET:
 529                 return is_default_prefix4((const struct prefix_ipv4 *)p);
 530         case AF_INET6:
 531                 return is_default_prefix6((const struct prefix_ipv6 *)p);
 532         }
 533
 534         return false;
 535 }
 536
 537 static inline int is_host_route(const struct prefix *p)
 538 {
 539         if (p->family == AF_INET)
 540                 return (p->prefixlen == IPV4_MAX_BITLEN);
 541         else if (p->family == AF_INET6)
 542                 return (p->prefixlen == IPV6_MAX_BITLEN);
 543         return 0;
 544 }
 545
 546 static inline int is_default_host_route(const struct prefix *p)
 547 {
 548         if (p->family == AF_INET) {
 549                 return (p->u.prefix4.s_addr == INADDR_ANY &&
 550                         p->prefixlen == IPV4_MAX_BITLEN);
 551         } else if (p->family == AF_INET6) {
 552                 return ((!memcmp(&p->u.prefix6, &in6addr_any,
 553                                  sizeof(struct in6_addr))) &&
 554                         p->prefixlen == IPV6_MAX_BITLEN);
 555         }
 556         return 0;
 557 }
 558
 559 static inline bool is_ipv6_global_unicast(const struct in6_addr *p)
 560 {
 561         if (IN6_IS_ADDR_UNSPECIFIED(p) || IN6_IS_ADDR_LOOPBACK(p) ||
 562             IN6_IS_ADDR_LINKLOCAL(p) || IN6_IS_ADDR_MULTICAST(p))
 563                 return false;
 564
 565         return true;
 566 }
 567
 568 /* IPv6 scope values, usable for IPv4 too (cf. below) */
 569 /* clang-format off */
 570 enum {
 571         /* 0: reserved */
 572         MCAST_SCOPE_IFACE  = 0x1,
 573         MCAST_SCOPE_LINK   = 0x2,
 574         MCAST_SCOPE_REALM  = 0x3,
 575         MCAST_SCOPE_ADMIN  = 0x4,
 576         MCAST_SCOPE_SITE   = 0x5,
 577         /* 6-7: unassigned */
 578         MCAST_SCOPE_ORG    = 0x8,
 579         /* 9-d: unassigned */
 580         MCAST_SCOPE_GLOBAL = 0xe,
 581         /* f: reserved */
 582 };
 583 /* clang-format on */
 584
 585 static inline uint8_t ipv6_mcast_scope(const struct in6_addr *addr)
 586 {
 587         return addr->s6_addr[1] & 0xf;
 588 }
 589
 590 static inline bool ipv6_mcast_nofwd(const struct in6_addr *addr)
 591 {
 592         return (addr->s6_addr[1] & 0xf) <= MCAST_SCOPE_LINK;
 593 }
 594
 595 static inline bool ipv6_mcast_ssm(const struct in6_addr *addr)
 596 {
 597         uint32_t bits = ntohl(addr->s6_addr32[0]);
 598
 599         /* ff3x:0000::/32 */
 600         return (bits & 0xfff0ffff) == 0xff300000;
 601 }
 602
 603 static inline uint8_t ipv4_mcast_scope(const struct in_addr *addr)
 604 {
 605         uint32_t bits = ntohl(addr->s_addr);
 606
 607         /* 224.0.0.0/24 - link scope */
 608         if ((bits & 0xffffff00) == 0xe0000000)
 609                 return MCAST_SCOPE_LINK;
 610         /* 239.0.0.0/8 - org scope */
 611         if ((bits & 0xff000000) == 0xef000000)
 612                 return MCAST_SCOPE_ORG;
 613
 614         return MCAST_SCOPE_GLOBAL;
 615 }
 616
 617 static inline bool ipv4_mcast_nofwd(const struct in_addr *addr)
 618 {
 619         uint32_t bits = ntohl(addr->s_addr);
 620
 621         /* 224.0.0.0/24 */
 622         return (bits & 0xffffff00) == 0xe0000000;
 623 }
 624
 625 static inline bool ipv4_mcast_ssm(const struct in_addr *addr)
 626 {
 627         uint32_t bits = ntohl(addr->s_addr);
 628
 629         /* 232.0.0.0/8 */
 630         return (bits & 0xff000000) == 0xe8000000;
 631 }
 632
 633 #ifdef _FRR_ATTRIBUTE_PRINTFRR
 634 #pragma FRR printfrr_ext "%pEA"  (struct ethaddr *)
 635
 636 #pragma FRR printfrr_ext "%pI4"  (struct in_addr *)
 637 #pragma FRR printfrr_ext "%pI4"  (in_addr_t *)
 638
 639 #pragma FRR printfrr_ext "%pI6"  (struct in6_addr *)
 640
 641 #pragma FRR printfrr_ext "%pFX"  (struct prefix *)
 642 #pragma FRR printfrr_ext "%pFX"  (struct prefix_ipv4 *)
 643 #pragma FRR printfrr_ext "%pFX"  (struct prefix_ipv6 *)
 644 #pragma FRR printfrr_ext "%pFX"  (struct prefix_eth *)
 645 #pragma FRR printfrr_ext "%pFX"  (struct prefix_evpn *)
 646 #pragma FRR printfrr_ext "%pFX"  (struct prefix_fs *)
 647 #pragma FRR printfrr_ext "%pRDP"  (struct prefix_rd *)
 648 /* RD with AS4B with dot and dot+ format */
 649 #pragma FRR printfrr_ext "%pRDD"  (struct prefix_rd *)
 650 #pragma FRR printfrr_ext "%pRDE"  (struct prefix_rd *)
 651
 652 #pragma FRR printfrr_ext "%pPSG4" (struct prefix_sg *)
 653 #endif
 654
 655 #ifdef __cplusplus
 656 }
 657 #endif
 658
 659 #endif /* _ZEBRA_PREFIX_H */