lib/zebra.h

   1 /* Zebra common header.
   2    Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002 Kunihiro Ishiguro
   3
   4 This file is part of GNU Zebra.
   5
   6 GNU Zebra is free software; you can redistribute it and/or modify it
   7 under the terms of the GNU General Public License as published by the
   8 Free Software Foundation; either version 2, or (at your option) any
   9 later version.
  10
  11 GNU Zebra is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Zebra; see the file COPYING.  If not, write to the Free
  18 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  19 02111-1307, USA.  */
  20
  21 #ifndef _ZEBRA_H
  22 #define _ZEBRA_H
  23
  24 #ifdef HAVE_CONFIG_H
  25 #include "config.h"
  26 #endif /* HAVE_CONFIG_H */
  27
  28 #ifdef SUNOS_5
  29 #define _XPG4_2
  30 typedef unsigned int u_int32_t;
  31 typedef unsigned short u_int16_t;
  32 typedef unsigned char u_int8_t;
  33 #endif /* SUNOS_5 */
  34
  35 #include <unistd.h>
  36 #include <stdio.h>
  37 #include <stdlib.h>
  38 #include <stddef.h>
  39 #include <ctype.h>
  40 #include <errno.h>
  41 #include <fcntl.h>
  42 #include <signal.h>
  43 #include <string.h>
  44 #include <pwd.h>
  45 #include <grp.h>
  46 #ifdef HAVE_STROPTS_H
  47 #include <stropts.h>
  48 #endif /* HAVE_STROPTS_H */
  49 #include <sys/select.h>
  50 #include <sys/stat.h>
  51 #include <sys/types.h>
  52 #include <sys/param.h>
  53 #ifdef HAVE_SYS_SYSCTL_H
  54 #ifdef GNU_LINUX
  55 #include <linux/types.h>
  56 #endif
  57 #include <sys/sysctl.h>
  58 #endif /* HAVE_SYS_SYSCTL_H */
  59 #include <sys/ioctl.h>
  60 #ifdef HAVE_SYS_CONF_H
  61 #include <sys/conf.h>
  62 #endif /* HAVE_SYS_CONF_H */
  63 #ifdef HAVE_SYS_KSYM_H
  64 #include <sys/ksym.h>
  65 #endif /* HAVE_SYS_KSYM_H */
  66 #include <syslog.h>
  67 #include <sys/time.h>
  68 #include <time.h>
  69 #include <sys/uio.h>
  70 #include <sys/utsname.h>
  71 #include <sys/resource.h>
  72 #include <limits.h>
  73 #include <inttypes.h>
  74 #include <stdbool.h>
  75
  76 /* machine dependent includes */
  77 #ifdef SUNOS_5
  78 #include <strings.h>
  79 #endif /* SUNOS_5 */
  80
  81 /* machine dependent includes */
  82 #ifdef HAVE_LINUX_VERSION_H
  83 #include <linux/version.h>
  84 #endif /* HAVE_LINUX_VERSION_H */
  85
  86 #ifdef HAVE_ASM_TYPES_H
  87 #include <asm/types.h>
  88 #endif /* HAVE_ASM_TYPES_H */
  89
  90 /* misc include group */
  91 #include <stdarg.h>
  92 #if !(defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)
  93 /* Not C99; do we need to define va_copy? */
  94 #ifndef va_copy
  95 #ifdef __va_copy
  96 #define va_copy(DST,SRC) __va_copy(DST,SRC)
  97 #else
  98 /* Now we are desperate; this should work on many typical platforms.
  99    But this is slightly dangerous, because the standard does not require
 100    va_copy to be a macro. */
 101 #define va_copy(DST,SRC) memcpy(&(DST), &(SRC), sizeof(va_list))
 102 #warning "Not C99 and no va_copy macro available, falling back to memcpy"
 103 #endif /* __va_copy */
 104 #endif /* !va_copy */
 105 #endif /* !C99 */
 106
 107
 108 #ifdef HAVE_LCAPS
 109 #include <sys/capability.h>
 110 #include <sys/prctl.h>
 111 #endif /* HAVE_LCAPS */
 112
 113 #ifdef HAVE_SOLARIS_CAPABILITIES
 114 #include <priv.h>
 115 #endif /* HAVE_SOLARIS_CAPABILITIES */
 116
 117 /* network include group */
 118
 119 #include <sys/socket.h>
 120
 121 #ifdef HAVE_SYS_SOCKIO_H
 122 #include <sys/sockio.h>
 123 #endif /* HAVE_SYS_SOCKIO_H */
 124
 125 #ifdef __APPLE__
 126 #define __APPLE_USE_RFC_3542
 127 #endif
 128
 129 #include <netinet/in.h>
 130 #include <netinet/in_systm.h>
 131 #include <netinet/ip.h>
 132 #include <netinet/tcp.h>
 133
 134 #ifdef HAVE_NET_NETOPT_H
 135 #include <net/netopt.h>
 136 #endif /* HAVE_NET_NETOPT_H */
 137
 138 #include <net/if.h>
 139
 140 #ifdef HAVE_NET_IF_DL_H
 141 #include <net/if_dl.h>
 142 #endif /* HAVE_NET_IF_DL_H */
 143
 144 #ifdef HAVE_NET_IF_VAR_H
 145 #include <net/if_var.h>
 146 #endif /* HAVE_NET_IF_VAR_H */
 147
 148 #include <net/route.h>
 149
 150 #ifdef HAVE_NETLINK
 151 #include <linux/netlink.h>
 152 #include <linux/rtnetlink.h>
 153 #include <linux/filter.h>
 154 #else
 155 #define RT_TABLE_MAIN           0
 156 #endif /* HAVE_NETLINK */
 157
 158 #include <netdb.h>
 159 #include <arpa/inet.h>
 160
 161 #ifdef HAVE_INET_ND_H
 162 #include <inet/nd.h>
 163 #endif /* HAVE_INET_ND_H */
 164
 165 #ifdef HAVE_NETINET_IN_VAR_H
 166 #include <netinet/in_var.h>
 167 #endif /* HAVE_NETINET_IN_VAR_H */
 168
 169 #ifdef HAVE_NETINET6_IN6_VAR_H
 170 #include <netinet6/in6_var.h>
 171 #endif /* HAVE_NETINET6_IN6_VAR_H */
 172
 173 #ifdef HAVE_NETINET_IN6_VAR_H
 174 #include <netinet/in6_var.h>
 175 #endif /* HAVE_NETINET_IN6_VAR_H */
 176
 177 #ifdef HAVE_NETINET6_IN_H
 178 #include <netinet6/in.h>
 179 #endif /* HAVE_NETINET6_IN_H */
 180
 181
 182 #ifdef HAVE_NETINET6_IP6_H
 183 #include <netinet6/ip6.h>
 184 #endif /* HAVE_NETINET6_IP6_H */
 185
 186 #include <netinet/icmp6.h>
 187
 188 #ifdef HAVE_NETINET6_ND6_H
 189 #include <netinet6/nd6.h>
 190 #endif /* HAVE_NETINET6_ND6_H */
 191
 192 /* Some systems do not define UINT32_MAX, etc.. from inttypes.h
 193  * e.g. this makes life easier for FBSD 4.11 users.
 194  */
 195 #ifndef INT8_MAX
 196 #define INT8_MAX        (127)
 197 #endif
 198 #ifndef INT16_MAX
 199 #define INT16_MAX       (32767)
 200 #endif
 201 #ifndef INT32_MAX
 202 #define INT32_MAX       (2147483647)
 203 #endif
 204 #ifndef UINT8_MAX
 205 #define UINT8_MAX       (255U)
 206 #endif
 207 #ifndef UINT16_MAX
 208 #define UINT16_MAX      (65535U)
 209 #endif
 210 #ifndef UINT32_MAX
 211 #define UINT32_MAX      (4294967295U)
 212 #endif
 213
 214 #ifdef HAVE_GLIBC_BACKTRACE
 215 #include <execinfo.h>
 216 #endif /* HAVE_GLIBC_BACKTRACE */
 217
 218 /* Local includes: */
 219 #if !(defined(__GNUC__) || defined(VTYSH_EXTRACT_PL))
 220 #define __attribute__(x)
 221 #endif /* !__GNUC__ || VTYSH_EXTRACT_PL */
 222
 223 #include "zassert.h"
 224
 225 #ifndef HAVE_STRLCAT
 226 size_t strlcat(char *__restrict dest, const char *__restrict src, size_t size);
 227 #endif
 228 #ifndef HAVE_STRLCPY
 229 size_t strlcpy(char *__restrict dest, const char *__restrict src, size_t size);
 230 #endif
 231
 232 #ifdef HAVE_BROKEN_CMSG_FIRSTHDR
 233 /* This bug is present in Solaris 8 and pre-patch Solaris 9 <sys/socket.h>;
 234    please refer to http://bugzilla.quagga.net/show_bug.cgi?id=142 */
 235
 236 /* Check that msg_controllen is large enough. */
 237 #define ZCMSG_FIRSTHDR(mhdr)                                                   \
 238         (((size_t)((mhdr)->msg_controllen) >= sizeof(struct cmsghdr))          \
 239                  ? CMSG_FIRSTHDR(mhdr)                                         \
 240                  : (struct cmsghdr *)NULL)
 241
 242 #warning "CMSG_FIRSTHDR is broken on this platform, using a workaround"
 243
 244 #else  /* HAVE_BROKEN_CMSG_FIRSTHDR */
 245 #define ZCMSG_FIRSTHDR(M) CMSG_FIRSTHDR(M)
 246 #endif /* HAVE_BROKEN_CMSG_FIRSTHDR */
 247
 248
 249 /*
 250  * RFC 3542 defines several macros for using struct cmsghdr.
 251  * Here, we define those that are not present
 252  */
 253
 254 /*
 255  * Internal defines, for use only in this file.
 256  * These are likely wrong on other than ILP32 machines, so warn.
 257  */
 258 #ifndef _CMSG_DATA_ALIGN
 259 #define _CMSG_DATA_ALIGN(n)           (((n) + 3) & ~3)
 260 #endif /* _CMSG_DATA_ALIGN */
 261
 262 #ifndef _CMSG_HDR_ALIGN
 263 #define _CMSG_HDR_ALIGN(n)            (((n) + 3) & ~3)
 264 #endif /* _CMSG_HDR_ALIGN */
 265
 266 /*
 267  * CMSG_SPACE and CMSG_LEN are required in RFC3542, but were new in that
 268  * version.
 269  */
 270 #ifndef CMSG_SPACE
 271 #define CMSG_SPACE(l)                                                          \
 272         (_CMSG_DATA_ALIGN(sizeof(struct cmsghdr)) + _CMSG_HDR_ALIGN(l))
 273 #warning "assuming 4-byte alignment for CMSG_SPACE"
 274 #endif /* CMSG_SPACE */
 275
 276
 277 #ifndef CMSG_LEN
 278 #define CMSG_LEN(l)         (_CMSG_DATA_ALIGN(sizeof(struct cmsghdr)) + (l))
 279 #warning "assuming 4-byte alignment for CMSG_LEN"
 280 #endif /* CMSG_LEN */
 281
 282
 283 /*  The definition of struct in_pktinfo is missing in old version of
 284     GLIBC 2.1 (Redhat 6.1).  */
 285 #if defined(GNU_LINUX) && !defined(HAVE_STRUCT_IN_PKTINFO)
 286 struct in_pktinfo {
 287         int ipi_ifindex;
 288         struct in_addr ipi_spec_dst;
 289         struct in_addr ipi_addr;
 290 };
 291 #endif
 292
 293 /*
 294  * IP_HDRINCL / struct ip byte order
 295  *
 296  * Linux: network byte order
 297  * *BSD: network, except for length and offset. (cf Stevens)
 298  * SunOS: nominally as per BSD. but bug: network order on LE.
 299  * OpenBSD: network byte order, apart from older versions which are as per
 300  *          *BSD
 301  */
 302 #if defined(__NetBSD__)                                                        \
 303         || (defined(__FreeBSD__) && (__FreeBSD_version < 1100030))             \
 304         || (defined(__OpenBSD__) && (OpenBSD < 200311))                        \
 305         || (defined(__APPLE__))                                                \
 306         || (defined(SUNOS_5) && defined(WORDS_BIGENDIAN))
 307 #define HAVE_IP_HDRINCL_BSD_ORDER
 308 #endif
 309
 310 /* Define BYTE_ORDER, if not defined. Useful for compiler conditional
 311  * code, rather than preprocessor conditional.
 312  * Not all the world has this BSD define.
 313  */
 314 #ifndef BYTE_ORDER
 315 #define BIG_ENDIAN      4321    /* least-significant byte first (vax, pc) */
 316 #define LITTLE_ENDIAN   1234    /* most-significant byte first (IBM, net) */
 317 #define PDP_ENDIAN      3412    /* LSB first in word, MSW first in long (pdp) */
 318
 319 #if defined(WORDS_BIGENDIAN)
 320 #define BYTE_ORDER      BIG_ENDIAN
 321 #else  /* !WORDS_BIGENDIAN */
 322 #define BYTE_ORDER      LITTLE_ENDIAN
 323 #endif /* WORDS_BIGENDIAN */
 324
 325 #endif /* ndef BYTE_ORDER */
 326
 327 /* MAX / MIN are not commonly defined, but useful */
 328 /* note: glibc sys/param.h has #define MIN(a,b) (((a)<(b))?(a):(b)) */
 329 #ifdef MAX
 330 #undef MAX
 331 #endif
 332 #define MAX(a, b)                                                              \
 333         ({                                                                     \
 334                 typeof(a) _a = (a);                                            \
 335                 typeof(b) _b = (b);                                            \
 336                 _a > _b ? _a : _b;                                             \
 337         })
 338 #ifdef MIN
 339 #undef MIN
 340 #endif
 341 #define MIN(a, b)                                                              \
 342         ({                                                                     \
 343                 typeof(a) _a = (a);                                            \
 344                 typeof(b) _b = (b);                                            \
 345                 _a < _b ? _a : _b;                                             \
 346         })
 347
 348 #define ZEBRA_NUM_OF(x) (sizeof (x) / sizeof (x[0]))
 349
 350 /* For old definition. */
 351 #ifndef IN6_ARE_ADDR_EQUAL
 352 #define IN6_ARE_ADDR_EQUAL IN6_IS_ADDR_EQUAL
 353 #endif /* IN6_ARE_ADDR_EQUAL */
 354
 355 /* default zebra TCP port for zclient */
 356 #define ZEBRA_PORT                      2600
 357
 358 /* Marker value used in new Zserv, in the byte location corresponding
 359  * the command value in the old zserv header. To allow old and new
 360  * Zserv headers to be distinguished from each other.
 361  */
 362 #define ZEBRA_HEADER_MARKER              254
 363
 364 /* Zebra route's types are defined in route_types.h */
 365 #include "route_types.h"
 366
 367 /* Note: whenever a new route-type or zserv-command is added the
 368  * corresponding {command,route}_types[] table in lib/log.c MUST be
 369  * updated! */
 370
 371 /* Map a route type to a string.  For example, ZEBRA_ROUTE_RIPNG -> "ripng". */
 372 extern const char *zebra_route_string(unsigned int route_type);
 373 /* Map a route type to a char.  For example, ZEBRA_ROUTE_RIPNG -> 'R'. */
 374 extern char zebra_route_char(unsigned int route_type);
 375 /* Map a zserv command type to the same string,
 376  * e.g. ZEBRA_INTERFACE_ADD -> "ZEBRA_INTERFACE_ADD" */
 377 /* Map a protocol name to its number. e.g. ZEBRA_ROUTE_BGP->9*/
 378 extern int proto_name2num(const char *s);
 379 /* Map redistribute X argument to protocol number.
 380  * unlike proto_name2num, this accepts shorthands and takes
 381  * an AFI value to restrict input */
 382 extern int proto_redistnum(int afi, const char *s);
 383
 384 extern const char *zserv_command_string(unsigned int command);
 385
 386 #define strmatch(a,b) (!strcmp((a), (b)))
 387
 388 /* Zebra message flags */
 389 #define ZEBRA_FLAG_INTERNAL           0x01
 390 #define ZEBRA_FLAG_SELFROUTE          0x02
 391 #define ZEBRA_FLAG_BLACKHOLE          0x04
 392 #define ZEBRA_FLAG_IBGP               0x08
 393 #define ZEBRA_FLAG_SELECTED           0x10
 394 #define ZEBRA_FLAG_STATIC             0x40
 395 #define ZEBRA_FLAG_REJECT             0x80
 396 #define ZEBRA_FLAG_SCOPE_LINK         0x100
 397 #define ZEBRA_FLAG_FIB_OVERRIDE       0x200
 398
 399 #ifndef INADDR_LOOPBACK
 400 #define INADDR_LOOPBACK 0x7f000001      /* Internet address 127.0.0.1.  */
 401 #endif
 402
 403 /* Address family numbers from RFC1700. */
 404 typedef enum { AFI_IP = 1, AFI_IP6 = 2, AFI_L2VPN = 4, AFI_MAX = 5 } afi_t;
 405
 406 /* Subsequent Address Family Identifier. */
 407 #define SAFI_UNICAST              1
 408 #define SAFI_MULTICAST            2
 409 #define SAFI_MPLS_VPN             3
 410 #define SAFI_RESERVED_4           4
 411 #define SAFI_ENCAP                5
 412 #define SAFI_RESERVED_5           5
 413 #define SAFI_EVPN                 6
 414 #define SAFI_MAX                  7
 415
 416 #define IANA_SAFI_RESERVED            0
 417 #define IANA_SAFI_UNICAST             1
 418 #define IANA_SAFI_MULTICAST           2
 419 #define IANA_SAFI_ENCAP               7
 420 #define IANA_SAFI_MPLS_VPN            128
 421
 422 /*
 423  * The above AFI and SAFI definitions are for internal use. The protocol
 424  * definitions (IANA values) as for example used in BGP protocol packets
 425  * are defined below and these will get mapped to/from the internal values
 426  * in the appropriate places.
 427  * The rationale is that the protocol (IANA) values may be sparse and are
 428  * not optimal for use in data-structure sizing.
 429  * Note: Only useful (i.e., supported) values are defined below.
 430  */
 431 typedef enum {
 432         IANA_AFI_RESERVED = 0,
 433         IANA_AFI_IPV4 = 1,
 434         IANA_AFI_IPV6 = 2,
 435         IANA_AFI_L2VPN = 25,
 436         IANA_AFI_IPMR = 128,
 437         IANA_AFI_IP6MR = 129
 438 } iana_afi_t;
 439
 440 #define IANA_SAFI_RESERVED            0
 441 #define IANA_SAFI_UNICAST             1
 442 #define IANA_SAFI_MULTICAST           2
 443 #define IANA_SAFI_ENCAP               7
 444 #define IANA_SAFI_EVPN                70
 445 #define IANA_SAFI_MPLS_VPN            128
 446
 447 /* Default Administrative Distance of each protocol. */
 448 #define ZEBRA_KERNEL_DISTANCE_DEFAULT      0
 449 #define ZEBRA_CONNECT_DISTANCE_DEFAULT     0
 450 #define ZEBRA_STATIC_DISTANCE_DEFAULT      1
 451 #define ZEBRA_RIP_DISTANCE_DEFAULT       120
 452 #define ZEBRA_RIPNG_DISTANCE_DEFAULT     120
 453 #define ZEBRA_OSPF_DISTANCE_DEFAULT      110
 454 #define ZEBRA_OSPF6_DISTANCE_DEFAULT     110
 455 #define ZEBRA_ISIS_DISTANCE_DEFAULT      115
 456 #define ZEBRA_IBGP_DISTANCE_DEFAULT      200
 457 #define ZEBRA_EBGP_DISTANCE_DEFAULT       20
 458 #define ZEBRA_TABLE_DISTANCE_DEFAULT      15
 459
 460 /* Flag manipulation macros. */
 461 #define CHECK_FLAG(V,F)      ((V) & (F))
 462 #define SET_FLAG(V,F)        (V) |= (F)
 463 #define UNSET_FLAG(V,F)      (V) &= ~(F)
 464 #define RESET_FLAG(V)        (V) = 0
 465
 466 typedef u_int8_t safi_t;
 467
 468 /* Zebra types. Used in Zserv message header. */
 469 typedef u_int16_t zebra_size_t;
 470 typedef u_int16_t zebra_command_t;
 471
 472 /* VRF ID type. */
 473 typedef u_int16_t vrf_id_t;
 474
 475 typedef uint32_t route_tag_t;
 476 #define ROUTE_TAG_MAX UINT32_MAX
 477 #define ROUTE_TAG_PRI PRIu32
 478
 479 static inline afi_t afi_iana2int(iana_afi_t afi)
 480 {
 481         if (afi == IANA_AFI_IPV4)
 482                 return AFI_IP;
 483         if (afi == IANA_AFI_IPV6)
 484                 return AFI_IP6;
 485         if (afi == IANA_AFI_L2VPN)
 486                 return AFI_L2VPN;
 487         return AFI_MAX;
 488 }
 489
 490 static inline iana_afi_t afi_int2iana(afi_t afi)
 491 {
 492         if (afi == AFI_IP)
 493                 return IANA_AFI_IPV4;
 494         if (afi == AFI_IP6)
 495                 return IANA_AFI_IPV6;
 496         if (afi == AFI_L2VPN)
 497                 return IANA_AFI_L2VPN;
 498         return IANA_AFI_RESERVED;
 499 }
 500
 501 static inline safi_t safi_iana2int(safi_t safi)
 502 {
 503         if (safi == IANA_SAFI_UNICAST)
 504                 return SAFI_UNICAST;
 505         if (safi == IANA_SAFI_MULTICAST)
 506                 return SAFI_MULTICAST;
 507         if (safi == IANA_SAFI_MPLS_VPN)
 508                 return SAFI_MPLS_VPN;
 509         if (safi == IANA_SAFI_ENCAP)
 510                 return SAFI_ENCAP;
 511         if (safi == IANA_SAFI_EVPN)
 512                 return SAFI_EVPN;
 513         return SAFI_MAX;
 514 }
 515
 516 static inline safi_t safi_int2iana(safi_t safi)
 517 {
 518         if (safi == SAFI_UNICAST)
 519                 return IANA_SAFI_UNICAST;
 520         if (safi == SAFI_MULTICAST)
 521                 return IANA_SAFI_MULTICAST;
 522         if (safi == SAFI_MPLS_VPN)
 523                 return IANA_SAFI_MPLS_VPN;
 524         if (safi == SAFI_ENCAP)
 525                 return IANA_SAFI_ENCAP;
 526         if (safi == SAFI_EVPN)
 527                 return IANA_SAFI_EVPN;
 528         return IANA_SAFI_RESERVED;
 529 }
 530
 531 #endif /* _ZEBRA_H */