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 #ifndef HAVE_SOCKLEN_T
  36 typedef int socklen_t;
  37 #endif /* HAVE_SOCKLEN_T */
  38
  39 #include <unistd.h>
  40 #include <stdio.h>
  41 #include <stdlib.h>
  42 #include <stddef.h>
  43 #include <ctype.h>
  44 #include <errno.h>
  45 #include <fcntl.h>
  46 #include <signal.h>
  47 #include <string.h>
  48 #include <pwd.h>
  49 #include <grp.h>
  50 #ifdef HAVE_STROPTS_H
  51 #include <stropts.h>
  52 #endif /* HAVE_STROPTS_H */
  53 #ifdef HAVE_SYS_SELECT_H
  54 #include <sys/select.h>
  55 #endif /* HAVE_SYS_SELECT_H */
  56 #include <sys/stat.h>
  57 #include <sys/types.h>
  58 #include <sys/param.h>
  59 #ifdef HAVE_SYS_SYSCTL_H
  60 #ifdef GNU_LINUX
  61 #include <linux/types.h>
  62 #endif
  63 #include <sys/sysctl.h>
  64 #endif /* HAVE_SYS_SYSCTL_H */
  65 #include <sys/ioctl.h>
  66 #ifdef HAVE_SYS_CONF_H
  67 #include <sys/conf.h>
  68 #endif /* HAVE_SYS_CONF_H */
  69 #ifdef HAVE_SYS_KSYM_H
  70 #include <sys/ksym.h>
  71 #endif /* HAVE_SYS_KSYM_H */
  72 #include <syslog.h>
  73 #ifdef TIME_WITH_SYS_TIME
  74 # include <sys/time.h>
  75 # include <time.h>
  76 #else
  77 # ifdef HAVE_SYS_TIME_H
  78 #  include <sys/time.h>
  79 # else
  80 #  include <time.h>
  81 # endif
  82 #endif /* TIME_WITH_SYS_TIME */
  83 #include <sys/uio.h>
  84 #include <sys/utsname.h>
  85 #ifdef HAVE_RUSAGE
  86 #include <sys/resource.h>
  87 #endif /* HAVE_RUSAGE */
  88 #ifdef HAVE_LIMITS_H
  89 #include <limits.h>
  90 #endif /* HAVE_LIMITS_H */
  91 #ifdef HAVE_INTTYPES_H
  92 #include <inttypes.h>
  93 #endif /* HAVE_INTTYPES_H */
  94 #ifdef HAVE_STDBOOL_H
  95 #include <stdbool.h>
  96 #endif
  97 /* primarily for __STDC_IEC_559__ with clang */
  98 #ifdef HAVE_FEATURES_H
  99 #include <features.h>
 100 #endif
 101
 102 /* machine dependent includes */
 103 #ifdef SUNOS_5
 104 #include <strings.h>
 105 #endif /* SUNOS_5 */
 106
 107 /* machine dependent includes */
 108 #ifdef HAVE_LINUX_VERSION_H
 109 #include <linux/version.h>
 110 #endif /* HAVE_LINUX_VERSION_H */
 111
 112 #ifdef HAVE_ASM_TYPES_H
 113 #include <asm/types.h>
 114 #endif /* HAVE_ASM_TYPES_H */
 115
 116 /* misc include group */
 117 #include <stdarg.h>
 118 #if !(defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)
 119 /* Not C99; do we need to define va_copy? */
 120 #ifndef va_copy
 121 #ifdef __va_copy
 122 #define va_copy(DST,SRC) __va_copy(DST,SRC)
 123 #else
 124 /* Now we are desperate; this should work on many typical platforms.
 125    But this is slightly dangerous, because the standard does not require
 126    va_copy to be a macro. */
 127 #define va_copy(DST,SRC) memcpy(&(DST), &(SRC), sizeof(va_list))
 128 #warning "Not C99 and no va_copy macro available, falling back to memcpy"
 129 #endif /* __va_copy */
 130 #endif /* !va_copy */
 131 #endif /* !C99 */
 132
 133
 134 #ifdef HAVE_LCAPS
 135 #include <sys/capability.h>
 136 #include <sys/prctl.h>
 137 #endif /* HAVE_LCAPS */
 138
 139 #ifdef HAVE_SOLARIS_CAPABILITIES
 140 #include <priv.h>
 141 #endif /* HAVE_SOLARIS_CAPABILITIES */
 142
 143 /* network include group */
 144
 145 #include <sys/socket.h>
 146
 147 #ifdef HAVE_SYS_SOCKIO_H
 148 #include <sys/sockio.h>
 149 #endif /* HAVE_SYS_SOCKIO_H */
 150
 151 #ifdef __APPLE__
 152 #define __APPLE_USE_RFC_3542
 153 #endif
 154
 155 #ifdef HAVE_NETINET_IN_H
 156 #include <netinet/in.h>
 157 #endif /* HAVE_NETINET_IN_H */
 158 #include <netinet/in_systm.h>
 159 #include <netinet/ip.h>
 160 #include <netinet/tcp.h>
 161
 162 #ifdef HAVE_NET_NETOPT_H
 163 #include <net/netopt.h>
 164 #endif /* HAVE_NET_NETOPT_H */
 165
 166 #include <net/if.h>
 167
 168 #ifdef HAVE_NET_IF_DL_H
 169 #include <net/if_dl.h>
 170 #endif /* HAVE_NET_IF_DL_H */
 171
 172 #ifdef HAVE_NET_IF_VAR_H
 173 #include <net/if_var.h>
 174 #endif /* HAVE_NET_IF_VAR_H */
 175
 176 #ifdef HAVE_NET_ROUTE_H
 177 #include <net/route.h>
 178 #endif /* HAVE_NET_ROUTE_H */
 179
 180 #ifdef HAVE_NETLINK
 181 #include <linux/netlink.h>
 182 #include <linux/rtnetlink.h>
 183 #include <linux/filter.h>
 184 #else
 185 #define RT_TABLE_MAIN           0
 186 #endif /* HAVE_NETLINK */
 187
 188 #ifdef HAVE_NETDB_H
 189 #include <netdb.h>
 190 #endif /* HAVE_NETDB_H */
 191
 192 #include <arpa/inet.h>
 193
 194 #ifdef HAVE_INET_ND_H
 195 #include <inet/nd.h>
 196 #endif /* HAVE_INET_ND_H */
 197
 198 #ifdef HAVE_NETINET_IN_VAR_H
 199 #include <netinet/in_var.h>
 200 #endif /* HAVE_NETINET_IN_VAR_H */
 201
 202 #ifdef HAVE_NETINET6_IN6_VAR_H
 203 #include <netinet6/in6_var.h>
 204 #endif /* HAVE_NETINET6_IN6_VAR_H */
 205
 206 #ifdef HAVE_NETINET_IN6_VAR_H
 207 #include <netinet/in6_var.h>
 208 #endif /* HAVE_NETINET_IN6_VAR_H */
 209
 210 #ifdef HAVE_NETINET6_IN_H
 211 #include <netinet6/in.h>
 212 #endif /* HAVE_NETINET6_IN_H */
 213
 214
 215 #ifdef HAVE_NETINET6_IP6_H
 216 #include <netinet6/ip6.h>
 217 #endif /* HAVE_NETINET6_IP6_H */
 218
 219 #ifdef HAVE_NETINET_ICMP6_H
 220 #include <netinet/icmp6.h>
 221 #endif /* HAVE_NETINET_ICMP6_H */
 222
 223 #ifdef HAVE_NETINET6_ND6_H
 224 #include <netinet6/nd6.h>
 225 #endif /* HAVE_NETINET6_ND6_H */
 226
 227 /* Some systems do not define UINT32_MAX, etc.. from inttypes.h
 228  * e.g. this makes life easier for FBSD 4.11 users.
 229  */
 230 #ifndef INT8_MAX
 231 #define INT8_MAX        (127)
 232 #endif
 233 #ifndef INT16_MAX
 234 #define INT16_MAX       (32767)
 235 #endif
 236 #ifndef INT32_MAX
 237 #define INT32_MAX       (2147483647)
 238 #endif
 239 #ifndef UINT8_MAX
 240 #define UINT8_MAX       (255U)
 241 #endif
 242 #ifndef UINT16_MAX
 243 #define UINT16_MAX      (65535U)
 244 #endif
 245 #ifndef UINT32_MAX
 246 #define UINT32_MAX      (4294967295U)
 247 #endif
 248
 249 #ifdef HAVE_GLIBC_BACKTRACE
 250 #include <execinfo.h>
 251 #endif /* HAVE_GLIBC_BACKTRACE */
 252
 253 /* Local includes: */
 254 #if !(defined(__GNUC__) || defined(VTYSH_EXTRACT_PL))
 255 #define __attribute__(x)
 256 #endif  /* !__GNUC__ || VTYSH_EXTRACT_PL */
 257
 258 #include "zassert.h"
 259 #include "str.h"
 260
 261
 262 #ifdef HAVE_BROKEN_CMSG_FIRSTHDR
 263 /* This bug is present in Solaris 8 and pre-patch Solaris 9 <sys/socket.h>;
 264    please refer to http://bugzilla.quagga.net/show_bug.cgi?id=142 */
 265
 266 /* Check that msg_controllen is large enough. */
 267 #define ZCMSG_FIRSTHDR(mhdr) \
 268   (((size_t)((mhdr)->msg_controllen) >= sizeof(struct cmsghdr)) ? \
 269    CMSG_FIRSTHDR(mhdr) : (struct cmsghdr *)NULL)
 270
 271 #warning "CMSG_FIRSTHDR is broken on this platform, using a workaround"
 272
 273 #else /* HAVE_BROKEN_CMSG_FIRSTHDR */
 274 #define ZCMSG_FIRSTHDR(M) CMSG_FIRSTHDR(M)
 275 #endif /* HAVE_BROKEN_CMSG_FIRSTHDR */
 276
 277
 278
 279 /*
 280  * RFC 3542 defines several macros for using struct cmsghdr.
 281  * Here, we define those that are not present
 282  */
 283
 284 /*
 285  * Internal defines, for use only in this file.
 286  * These are likely wrong on other than ILP32 machines, so warn.
 287  */
 288 #ifndef _CMSG_DATA_ALIGN
 289 #define _CMSG_DATA_ALIGN(n)           (((n) + 3) & ~3)
 290 #endif /* _CMSG_DATA_ALIGN */
 291
 292 #ifndef _CMSG_HDR_ALIGN
 293 #define _CMSG_HDR_ALIGN(n)            (((n) + 3) & ~3)
 294 #endif /* _CMSG_HDR_ALIGN */
 295
 296 /*
 297  * CMSG_SPACE and CMSG_LEN are required in RFC3542, but were new in that
 298  * version.
 299  */
 300 #ifndef CMSG_SPACE
 301 #define CMSG_SPACE(l)       (_CMSG_DATA_ALIGN(sizeof(struct cmsghdr)) + \
 302                               _CMSG_HDR_ALIGN(l))
 303 #warning "assuming 4-byte alignment for CMSG_SPACE"
 304 #endif  /* CMSG_SPACE */
 305
 306
 307 #ifndef CMSG_LEN
 308 #define CMSG_LEN(l)         (_CMSG_DATA_ALIGN(sizeof(struct cmsghdr)) + (l))
 309 #warning "assuming 4-byte alignment for CMSG_LEN"
 310 #endif /* CMSG_LEN */
 311
 312
 313 /*  The definition of struct in_pktinfo is missing in old version of
 314     GLIBC 2.1 (Redhat 6.1).  */
 315 #if defined (GNU_LINUX) && ! defined (HAVE_STRUCT_IN_PKTINFO)
 316 struct in_pktinfo
 317 {
 318   int ipi_ifindex;
 319   struct in_addr ipi_spec_dst;
 320   struct in_addr ipi_addr;
 321 };
 322 #endif
 323
 324 /*
 325  * OSPF Fragmentation / fragmented writes
 326  *
 327  * ospfd can support writing fragmented packets, for cases where
 328  * kernel will not fragment IP_HDRINCL and/or multicast destined
 329  * packets (ie TTBOMK all kernels, BSD, SunOS, Linux). However,
 330  * SunOS, probably BSD too, clobber the user supplied IP ID and IP
 331  * flags fields, hence user-space fragmentation will not work.
 332  * Only Linux is known to leave IP header unmolested.
 333  * Further, fragmentation really should be done the kernel, which already
 334  * supports it, and which avoids nasty IP ID state problems.
 335  *
 336  * Fragmentation of OSPF packets can be required on networks with router
 337  * with many many interfaces active in one area, or on networks with links
 338  * with low MTUs.
 339  */
 340 #ifdef GNU_LINUX
 341 #define WANT_OSPF_WRITE_FRAGMENT
 342 #endif
 343
 344 /*
 345  * IP_HDRINCL / struct ip byte order
 346  *
 347  * Linux: network byte order
 348  * *BSD: network, except for length and offset. (cf Stevens)
 349  * SunOS: nominally as per BSD. but bug: network order on LE.
 350  * OpenBSD: network byte order, apart from older versions which are as per
 351  *          *BSD
 352  */
 353 #if defined(__NetBSD__) \
 354    || (defined(__FreeBSD__) && (__FreeBSD_version < 1100030)) \
 355    || (defined(__OpenBSD__) && (OpenBSD < 200311)) \
 356    || (defined(__APPLE__)) \
 357    || (defined(SUNOS_5) && defined(WORDS_BIGENDIAN))
 358 #define HAVE_IP_HDRINCL_BSD_ORDER
 359 #endif
 360
 361 /* Define BYTE_ORDER, if not defined. Useful for compiler conditional
 362  * code, rather than preprocessor conditional.
 363  * Not all the world has this BSD define.
 364  */
 365 #ifndef BYTE_ORDER
 366 #define BIG_ENDIAN      4321    /* least-significant byte first (vax, pc) */
 367 #define LITTLE_ENDIAN   1234    /* most-significant byte first (IBM, net) */
 368 #define PDP_ENDIAN      3412    /* LSB first in word, MSW first in long (pdp) */
 369
 370 #if defined(WORDS_BIGENDIAN)
 371 #define BYTE_ORDER      BIG_ENDIAN
 372 #else /* !WORDS_BIGENDIAN */
 373 #define BYTE_ORDER      LITTLE_ENDIAN
 374 #endif /* WORDS_BIGENDIAN */
 375
 376 #endif /* ndef BYTE_ORDER */
 377
 378 /* MAX / MIN are not commonly defined, but useful */
 379 #ifndef MAX
 380 #define MAX(a, b) \
 381         ({ typeof (a) _a = (a); \
 382            typeof (b) _b = (b); \
 383            _a > _b ? _a : _b; })
 384 #endif
 385 #ifndef MIN
 386 #define MIN(a, b) \
 387         ({ typeof (a) _a = (a); \
 388            typeof (b) _b = (b); \
 389            _a < _b ? _a : _b; })
 390 #endif
 391
 392 #define ZEBRA_NUM_OF(x) (sizeof (x) / sizeof (x[0]))
 393
 394 /* For old definition. */
 395 #ifndef IN6_ARE_ADDR_EQUAL
 396 #define IN6_ARE_ADDR_EQUAL IN6_IS_ADDR_EQUAL
 397 #endif /* IN6_ARE_ADDR_EQUAL */
 398
 399 /* default zebra TCP port for zclient */
 400 #define ZEBRA_PORT                      2600
 401
 402 /* Zebra message types. */
 403 #define ZEBRA_INTERFACE_ADD                1
 404 #define ZEBRA_INTERFACE_DELETE             2
 405 #define ZEBRA_INTERFACE_ADDRESS_ADD        3
 406 #define ZEBRA_INTERFACE_ADDRESS_DELETE     4
 407 #define ZEBRA_INTERFACE_UP                 5
 408 #define ZEBRA_INTERFACE_DOWN               6
 409 #define ZEBRA_IPV4_ROUTE_ADD               7
 410 #define ZEBRA_IPV4_ROUTE_DELETE            8
 411 #define ZEBRA_IPV6_ROUTE_ADD               9
 412 #define ZEBRA_IPV6_ROUTE_DELETE           10
 413 #define ZEBRA_REDISTRIBUTE_ADD            11
 414 #define ZEBRA_REDISTRIBUTE_DELETE         12
 415 #define ZEBRA_REDISTRIBUTE_DEFAULT_ADD    13
 416 #define ZEBRA_REDISTRIBUTE_DEFAULT_DELETE 14
 417 #define ZEBRA_IPV4_NEXTHOP_LOOKUP         15
 418 #define ZEBRA_IPV6_NEXTHOP_LOOKUP         16
 419 #define ZEBRA_IPV4_IMPORT_LOOKUP          17
 420 #define ZEBRA_IPV6_IMPORT_LOOKUP          18
 421 #define ZEBRA_INTERFACE_RENAME            19
 422 #define ZEBRA_ROUTER_ID_ADD               20
 423 #define ZEBRA_ROUTER_ID_DELETE            21
 424 #define ZEBRA_ROUTER_ID_UPDATE            22
 425 #define ZEBRA_HELLO                       23
 426 #define ZEBRA_IPV4_NEXTHOP_LOOKUP_MRIB    24
 427 #define ZEBRA_VRF_UNREGISTER              25
 428 #define ZEBRA_INTERFACE_LINK_PARAMS       26
 429 #define ZEBRA_NEXTHOP_REGISTER            27
 430 #define ZEBRA_NEXTHOP_UNREGISTER          28
 431 #define ZEBRA_NEXTHOP_UPDATE              29
 432 #define ZEBRA_MESSAGE_MAX                 30
 433
 434 /* Marker value used in new Zserv, in the byte location corresponding
 435  * the command value in the old zserv header. To allow old and new
 436  * Zserv headers to be distinguished from each other.
 437  */
 438 #define ZEBRA_HEADER_MARKER              255
 439
 440 /* Zebra route's types are defined in route_types.h */
 441 #include "route_types.h"
 442
 443 /* Note: whenever a new route-type or zserv-command is added the
 444  * corresponding {command,route}_types[] table in lib/log.c MUST be
 445  * updated! */
 446
 447 /* Map a route type to a string.  For example, ZEBRA_ROUTE_RIPNG -> "ripng". */
 448 extern const char *zebra_route_string(unsigned int route_type);
 449 /* Map a route type to a char.  For example, ZEBRA_ROUTE_RIPNG -> 'R'. */
 450 extern char zebra_route_char(unsigned int route_type);
 451 /* Map a zserv command type to the same string,
 452  * e.g. ZEBRA_INTERFACE_ADD -> "ZEBRA_INTERFACE_ADD" */
 453 /* Map a protocol name to its number. e.g. ZEBRA_ROUTE_BGP->9*/
 454 extern int proto_name2num(const char *s);
 455 /* Map redistribute X argument to protocol number.
 456  * unlike proto_name2num, this accepts shorthands and takes
 457  * an AFI value to restrict input */
 458 extern int proto_redistnum(int afi, const char *s);
 459
 460 extern const char *zserv_command_string (unsigned int command);
 461
 462 /* Error codes of zebra. */
 463 #define ZEBRA_ERR_NOERROR                0
 464 #define ZEBRA_ERR_RTEXIST               -1
 465 #define ZEBRA_ERR_RTUNREACH             -2
 466 #define ZEBRA_ERR_EPERM                 -3
 467 #define ZEBRA_ERR_RTNOEXIST             -4
 468 #define ZEBRA_ERR_KERNEL                -5
 469
 470 /* Zebra message flags */
 471 #define ZEBRA_FLAG_INTERNAL           0x01
 472 #define ZEBRA_FLAG_SELFROUTE          0x02
 473 #define ZEBRA_FLAG_BLACKHOLE          0x04
 474 #define ZEBRA_FLAG_IBGP               0x08
 475 #define ZEBRA_FLAG_SELECTED           0x10
 476 #define ZEBRA_FLAG_FIB_OVERRIDE       0x20
 477 #define ZEBRA_FLAG_STATIC             0x40
 478 #define ZEBRA_FLAG_REJECT             0x80
 479
 480 /* Zebra nexthop flags. */
 481 #define ZEBRA_NEXTHOP_IFINDEX            1
 482 #define ZEBRA_NEXTHOP_IFNAME             2
 483 #define ZEBRA_NEXTHOP_IPV4               3
 484 #define ZEBRA_NEXTHOP_IPV4_IFINDEX       4
 485 #define ZEBRA_NEXTHOP_IPV4_IFNAME        5
 486 #define ZEBRA_NEXTHOP_IPV6               6
 487 #define ZEBRA_NEXTHOP_IPV6_IFINDEX       7
 488 #define ZEBRA_NEXTHOP_IPV6_IFNAME        8
 489 #define ZEBRA_NEXTHOP_BLACKHOLE          9
 490
 491 #ifndef INADDR_LOOPBACK
 492 #define INADDR_LOOPBACK 0x7f000001      /* Internet address 127.0.0.1.  */
 493 #endif
 494
 495 /* Address family numbers from RFC1700. */
 496 typedef enum {
 497   AFI_IP  = 1,
 498   AFI_IP6 = 2,
 499   AFI_ETHER = 3,                /* RFC 1700 has "6" for 802.* */
 500 #define AFI_MAX 4
 501 } afi_t;
 502
 503 /* Subsequent Address Family Identifier. */
 504 #define SAFI_UNICAST              1
 505 #define SAFI_MULTICAST            2
 506 #define SAFI_RESERVED_3           3
 507 #define SAFI_MPLS_VPN             4
 508 #define SAFI_ENCAP                7 /* per IANA */
 509 #define SAFI_MAX                  8
 510
 511 /* Default Administrative Distance of each protocol. */
 512 #define ZEBRA_KERNEL_DISTANCE_DEFAULT      0
 513 #define ZEBRA_CONNECT_DISTANCE_DEFAULT     0
 514 #define ZEBRA_STATIC_DISTANCE_DEFAULT      1
 515 #define ZEBRA_RIP_DISTANCE_DEFAULT       120
 516 #define ZEBRA_RIPNG_DISTANCE_DEFAULT     120
 517 #define ZEBRA_OSPF_DISTANCE_DEFAULT      110
 518 #define ZEBRA_OSPF6_DISTANCE_DEFAULT     110
 519 #define ZEBRA_ISIS_DISTANCE_DEFAULT      115
 520 #define ZEBRA_IBGP_DISTANCE_DEFAULT      200
 521 #define ZEBRA_EBGP_DISTANCE_DEFAULT       20
 522
 523 /* Flag manipulation macros. */
 524 #define CHECK_FLAG(V,F)      ((V) & (F))
 525 #define SET_FLAG(V,F)        (V) |= (F)
 526 #define UNSET_FLAG(V,F)      (V) &= ~(F)
 527 #define RESET_FLAG(V)        (V) = 0
 528
 529 typedef u_int8_t safi_t;
 530
 531 /* Zebra types. Used in Zserv message header. */
 532 typedef u_int16_t zebra_size_t;
 533 typedef u_int16_t zebra_command_t;
 534
 535 /* VRF ID type. */
 536 typedef u_int16_t vrf_id_t;
 537
 538 typedef uint32_t route_tag_t;
 539 #define ROUTE_TAG_MAX UINT32_MAX
 540
 541 #endif /* _ZEBRA_H */