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 #define __EXTENSIONS__
  31 typedef unsigned int    u_int32_t;
  32 typedef unsigned short  u_int16_t;
  33 typedef unsigned char   u_int8_t;
  34 #endif /* SUNOS_5 */
  35
  36 #ifndef HAVE_SOCKLEN_T
  37 typedef int socklen_t;
  38 #endif /* HAVE_SOCKLEN_T */
  39
  40 #include <unistd.h>
  41 #include <stdio.h>
  42 #include <stdlib.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 #include <sys/fcntl.h>
  54 #ifdef HAVE_SYS_SELECT_H
  55 #include <sys/select.h>
  56 #endif /* HAVE_SYS_SELECT_H */
  57 #include <sys/stat.h>
  58 #include <sys/time.h>
  59 #include <sys/types.h>
  60 #include <sys/param.h>
  61 #ifdef HAVE_SYS_SYSCTL_H
  62 #include <sys/sysctl.h>
  63 #endif /* HAVE_SYS_SYSCTL_H */
  64 #include <sys/ioctl.h>
  65 #ifdef HAVE_SYS_CONF_H
  66 #include <sys/conf.h>
  67 #endif /* HAVE_SYS_CONF_H */
  68 #ifdef HAVE_SYS_KSYM_H
  69 #include <sys/ksym.h>
  70 #endif /* HAVE_SYS_KSYM_H */
  71 #include <syslog.h>
  72 #include <time.h>
  73 #include <sys/uio.h>
  74 #include <sys/utsname.h>
  75 #ifdef HAVE_RUSAGE
  76 #include <sys/resource.h>
  77 #endif /* HAVE_RUSAGE */
  78 #ifdef HAVE_LIMITS_H
  79 #include <limits.h>
  80 #endif /* HAVE_LIMITS_H */
  81
  82 /* machine dependent includes */
  83 #ifdef SUNOS_5
  84 #include <strings.h>
  85 #endif /* SUNOS_5 */
  86
  87 /* machine dependent includes */
  88 #ifdef HAVE_LINUX_VERSION_H
  89 #include <linux/version.h>
  90 #endif /* HAVE_LINUX_VERSION_H */
  91
  92 #ifdef HAVE_ASM_TYPES_H
  93 #include <asm/types.h>
  94 #endif /* HAVE_ASM_TYPES_H */
  95
  96 /* misc include group */
  97 #include <stdarg.h>
  98 #include <assert.h>
  99
 100 #ifdef HAVE_LCAPS
 101 #include <sys/capability.h>
 102 #include <sys/prctl.h>
 103 #endif /* HAVE_LCAPS */
 104
 105 /* network include group */
 106
 107 #include <sys/socket.h>
 108
 109 #ifdef HAVE_SYS_SOCKIO_H
 110 #include <sys/sockio.h>
 111 #endif /* HAVE_SYS_SOCKIO_H */
 112
 113 #ifdef HAVE_NETINET_IN_H
 114 #include <netinet/in.h>
 115 #endif /* HAVE_NETINET_IN_H */
 116 #include <netinet/in_systm.h>
 117 #include <netinet/ip.h>
 118 #include <netinet/tcp.h>
 119
 120 #ifdef HAVE_NET_NETOPT_H
 121 #include <net/netopt.h>
 122 #endif /* HAVE_NET_NETOPT_H */
 123
 124 #include <net/if.h>
 125
 126 #ifdef HAVE_NET_IF_DL_H
 127 #include <net/if_dl.h>
 128 #endif /* HAVE_NET_IF_DL_H */
 129
 130 #ifdef HAVE_NET_IF_VAR_H
 131 #include <net/if_var.h>
 132 #endif /* HAVE_NET_IF_VAR_H */
 133
 134 #ifdef HAVE_NET_ROUTE_H
 135 #include <net/route.h>
 136 #endif /* HAVE_NET_ROUTE_H */
 137
 138 #ifdef HAVE_NETLINK
 139 #include <linux/netlink.h>
 140 #include <linux/rtnetlink.h>
 141 #else
 142 #define RT_TABLE_MAIN           0
 143 #endif /* HAVE_NETLINK */
 144
 145 #ifdef HAVE_NETDB_H
 146 #include <netdb.h>
 147 #endif /* HAVE_NETDB_H */
 148
 149 #include <arpa/inet.h>
 150 #include <arpa/telnet.h>
 151
 152 #ifdef HAVE_INET_ND_H
 153 #include <inet/nd.h>
 154 #endif /* HAVE_INET_ND_H */
 155
 156 #ifdef HAVE_NETINET_IN_VAR_H
 157 #include <netinet/in_var.h>
 158 #endif /* HAVE_NETINET_IN_VAR_H */
 159
 160 #ifdef HAVE_NETINET6_IN6_VAR_H
 161 #include <netinet6/in6_var.h>
 162 #endif /* HAVE_NETINET6_IN6_VAR_H */
 163
 164 #ifdef HAVE_NETINET_IN6_VAR_H
 165 #include <netinet/in6_var.h>
 166 #endif /* HAVE_NETINET_IN6_VAR_H */
 167
 168 #ifdef HAVE_NETINET6_IN_H
 169 #include <netinet6/in.h>
 170 #endif /* HAVE_NETINET6_IN_H */
 171
 172
 173 #ifdef HAVE_NETINET6_IP6_H
 174 #include <netinet6/ip6.h>
 175 #endif /* HAVE_NETINET6_IP6_H */
 176
 177 #ifdef HAVE_NETINET_ICMP6_H
 178 #include <netinet/icmp6.h>
 179 #endif /* HAVE_NETINET_ICMP6_H */
 180
 181 #ifdef HAVE_NETINET6_ND6_H
 182 #include <netinet6/nd6.h>
 183 #endif /* HAVE_NETINET6_ND6_H */
 184
 185 /* Some systems do not define UINT32_MAX */
 186 #ifndef UINT32_MAX
 187 #define UINT32_MAX 0xFFFFFFFFU
 188 #endif /* UINT32_MAX */
 189
 190 #ifdef HAVE_LIBUTIL_H
 191 #include <libutil.h>
 192 #endif /* HAVE_LIBUTIL_H */
 193
 194 #ifdef HAVE_GLIBC_BACKTRACE
 195 #include <execinfo.h>
 196 #endif /* HAVE_GLIBC_BACKTRACE */
 197
 198 #ifdef BSDI_NRL
 199
 200 #ifdef HAVE_NETINET6_IN6_H
 201 #include <netinet6/in6.h>
 202 #endif /* HAVE_NETINET6_IN6_H */
 203
 204 #ifdef NRL
 205 #include <netinet6/in6.h>
 206 #endif /* NRL */
 207
 208 #define IN6_ARE_ADDR_EQUAL IN6_IS_ADDR_EQUAL
 209
 210 /* BSD/OS 4.0 has lost belows defines, it should appear at
 211    /usr/include/sys/socket.h.  */
 212 #define CMSG_ALIGN(n)           (((n) + 3) & ~3)
 213 #define CMSG_SPACE(l)   (CMSG_ALIGN(sizeof(struct cmsghdr)) + CMSG_ALIGN(l))
 214 #define CMSG_LEN(l)     (CMSG_ALIGN(sizeof(struct cmsghdr)) + (l))
 215
 216 #endif /* BSDI_NRL */
 217
 218 /*  The definition of struct in_pktinfo is missing in old version of
 219     GLIBC 2.1 (Redhat 6.1).  */
 220 #if defined (GNU_LINUX) && ! defined (HAVE_INPKTINFO)
 221 struct in_pktinfo
 222 {
 223   int ipi_ifindex;
 224   struct in_addr ipi_spec_dst;
 225   struct in_addr ipi_addr;
 226 };
 227 #endif
 228
 229 /* For old definition. */
 230 #ifndef IN6_ARE_ADDR_EQUAL
 231 #define IN6_ARE_ADDR_EQUAL IN6_IS_ADDR_EQUAL
 232 #endif /* IN6_ARE_ADDR_EQUAL */
 233
 234 /* Zebra message types. */
 235 #define ZEBRA_INTERFACE_ADD                1
 236 #define ZEBRA_INTERFACE_DELETE             2
 237 #define ZEBRA_INTERFACE_ADDRESS_ADD        3
 238 #define ZEBRA_INTERFACE_ADDRESS_DELETE     4
 239 #define ZEBRA_INTERFACE_UP                 5
 240 #define ZEBRA_INTERFACE_DOWN               6
 241 #define ZEBRA_IPV4_ROUTE_ADD               7
 242 #define ZEBRA_IPV4_ROUTE_DELETE            8
 243 #define ZEBRA_IPV6_ROUTE_ADD               9
 244 #define ZEBRA_IPV6_ROUTE_DELETE           10
 245 #define ZEBRA_REDISTRIBUTE_ADD            11
 246 #define ZEBRA_REDISTRIBUTE_DELETE         12
 247 #define ZEBRA_REDISTRIBUTE_DEFAULT_ADD    13
 248 #define ZEBRA_REDISTRIBUTE_DEFAULT_DELETE 14
 249 #define ZEBRA_IPV4_NEXTHOP_LOOKUP         15
 250 #define ZEBRA_IPV6_NEXTHOP_LOOKUP         16
 251 #define ZEBRA_IPV4_IMPORT_LOOKUP          17
 252 #define ZEBRA_IPV6_IMPORT_LOOKUP          18
 253 #define ZEBRA_MESSAGE_MAX                 19
 254
 255 /* Zebra route's types. */
 256 #define ZEBRA_ROUTE_SYSTEM               0
 257 #define ZEBRA_ROUTE_KERNEL               1
 258 #define ZEBRA_ROUTE_CONNECT              2
 259 #define ZEBRA_ROUTE_STATIC               3
 260 #define ZEBRA_ROUTE_RIP                  4
 261 #define ZEBRA_ROUTE_RIPNG                5
 262 #define ZEBRA_ROUTE_OSPF                 6
 263 #define ZEBRA_ROUTE_OSPF6                7
 264 #define ZEBRA_ROUTE_BGP                  8
 265 #define ZEBRA_ROUTE_MAX                  9
 266
 267 /* Zebra's family types. */
 268 #define ZEBRA_FAMILY_IPV4                1
 269 #define ZEBRA_FAMILY_IPV6                2
 270 #define ZEBRA_FAMILY_MAX                 3
 271
 272 /* Error codes of zebra. */
 273 #define ZEBRA_ERR_RTEXIST               -1
 274 #define ZEBRA_ERR_RTUNREACH             -2
 275 #define ZEBRA_ERR_EPERM                 -3
 276 #define ZEBRA_ERR_RTNOEXIST             -4
 277
 278 /* Zebra message flags */
 279 #define ZEBRA_FLAG_INTERNAL           0x01
 280 #define ZEBRA_FLAG_SELFROUTE          0x02
 281 #define ZEBRA_FLAG_BLACKHOLE          0x04
 282 #define ZEBRA_FLAG_IBGP               0x08
 283 #define ZEBRA_FLAG_SELECTED           0x10
 284 #define ZEBRA_FLAG_CHANGED            0x20
 285 #define ZEBRA_FLAG_STATIC             0x40
 286 #define ZEBRA_FLAG_REJECT             0x80
 287
 288 /* Zebra nexthop flags. */
 289 #define ZEBRA_NEXTHOP_IFINDEX            1
 290 #define ZEBRA_NEXTHOP_IFNAME             2
 291 #define ZEBRA_NEXTHOP_IPV4               3
 292 #define ZEBRA_NEXTHOP_IPV4_IFINDEX       4
 293 #define ZEBRA_NEXTHOP_IPV4_IFNAME        5
 294 #define ZEBRA_NEXTHOP_IPV6               6
 295 #define ZEBRA_NEXTHOP_IPV6_IFINDEX       7
 296 #define ZEBRA_NEXTHOP_IPV6_IFNAME        8
 297 #define ZEBRA_NEXTHOP_BLACKHOLE          9
 298
 299 #ifndef INADDR_LOOPBACK
 300 #define INADDR_LOOPBACK 0x7f000001      /* Internet address 127.0.0.1.  */
 301 #endif
 302
 303 /* Address family numbers from RFC1700. */
 304 #define AFI_IP                    1
 305 #define AFI_IP6                   2
 306 #define AFI_MAX                   3
 307
 308 /* Subsequent Address Family Identifier. */
 309 #define SAFI_UNICAST              1
 310 #define SAFI_MULTICAST            2
 311 #define SAFI_UNICAST_MULTICAST    3
 312 #define SAFI_MPLS_VPN             4
 313 #define SAFI_MAX                  5
 314
 315 /* Filter direction.  */
 316 #define FILTER_IN                 0
 317 #define FILTER_OUT                1
 318 #define FILTER_MAX                2
 319
 320 /* Default Administrative Distance of each protocol. */
 321 #define ZEBRA_KERNEL_DISTANCE_DEFAULT      0
 322 #define ZEBRA_CONNECT_DISTANCE_DEFAULT     0
 323 #define ZEBRA_STATIC_DISTANCE_DEFAULT      1
 324 #define ZEBRA_RIP_DISTANCE_DEFAULT       120
 325 #define ZEBRA_RIPNG_DISTANCE_DEFAULT     120
 326 #define ZEBRA_OSPF_DISTANCE_DEFAULT      110
 327 #define ZEBRA_OSPF6_DISTANCE_DEFAULT     110
 328 #define ZEBRA_IBGP_DISTANCE_DEFAULT      200
 329 #define ZEBRA_EBGP_DISTANCE_DEFAULT       20
 330
 331 /* Flag manipulation macros. */
 332 #define CHECK_FLAG(V,F)      ((V) & (F))
 333 #define SET_FLAG(V,F)        (V) = (V) | (F)
 334 #define UNSET_FLAG(V,F)      (V) = (V) & ~(F)
 335
 336 /* AFI and SAFI type. */
 337 typedef u_int16_t afi_t;
 338 typedef u_char safi_t;
 339
 340 /* Zebra types. */
 341 typedef u_int16_t zebra_size_t;
 342 typedef u_int8_t zebra_command_t;
 343
 344 /* FIFO -- first in first out structure and macros.  */
 345 struct fifo
 346 {
 347   struct fifo *next;
 348   struct fifo *prev;
 349 };
 350
 351 #define FIFO_INIT(F)                                  \
 352   do {                                                \
 353     struct fifo *Xfifo = (struct fifo *)(F);          \
 354     Xfifo->next = Xfifo->prev = Xfifo;                \
 355   } while (0)
 356
 357 #define FIFO_ADD(F,N)                                 \
 358   do {                                                \
 359     struct fifo *Xfifo = (struct fifo *)(F);          \
 360     struct fifo *Xnode = (struct fifo *)(N);          \
 361     Xnode->next = Xfifo;                              \
 362     Xnode->prev = Xfifo->prev;                        \
 363     Xfifo->prev = Xfifo->prev->next = Xnode;          \
 364   } while (0)
 365
 366 #define FIFO_DEL(N)                                   \
 367   do {                                                \
 368     struct fifo *Xnode = (struct fifo *)(N);          \
 369     Xnode->prev->next = Xnode->next;                  \
 370     Xnode->next->prev = Xnode->prev;                  \
 371   } while (0)
 372
 373 #define FIFO_HEAD(F)                                  \
 374   ((((struct fifo *)(F))->next == (struct fifo *)(F)) \
 375   ? NULL : (F)->next)
 376
 377 #define FIFO_EMPTY(F)                                 \
 378   (((struct fifo *)(F))->next == (struct fifo *)(F))
 379
 380 #define FIFO_TOP(F)                                   \
 381   (FIFO_EMPTY(F) ? NULL : ((struct fifo *)(F))->next)
 382
 383 #endif /* _ZEBRA_H */