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