1 /* Zebra common header.
2 Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002 Kunihiro Ishiguro
4 This file is part of GNU Zebra.
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
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.
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
26 #endif /* HAVE_CONFIG_H */
30 typedef unsigned int u_int32_t
;
31 typedef unsigned short u_int16_t
;
32 typedef unsigned char u_int8_t
;
35 #ifndef HAVE_SOCKLEN_T
36 typedef int socklen_t
;
37 #endif /* HAVE_SOCKLEN_T */
52 #endif /* HAVE_STROPTS_H */
53 #ifdef HAVE_SYS_SELECT_H
54 #include <sys/select.h>
55 #endif /* HAVE_SYS_SELECT_H */
57 #include <sys/types.h>
58 #include <sys/param.h>
59 #ifdef HAVE_SYS_SYSCTL_H
61 #include <linux/types.h>
63 #include <sys/sysctl.h>
64 #endif /* HAVE_SYS_SYSCTL_H */
65 #include <sys/ioctl.h>
66 #ifdef HAVE_SYS_CONF_H
68 #endif /* HAVE_SYS_CONF_H */
69 #ifdef HAVE_SYS_KSYM_H
71 #endif /* HAVE_SYS_KSYM_H */
73 #ifdef TIME_WITH_SYS_TIME
74 # include <sys/time.h>
77 # ifdef HAVE_SYS_TIME_H
78 # include <sys/time.h>
82 #endif /* TIME_WITH_SYS_TIME */
84 #include <sys/utsname.h>
86 #include <sys/resource.h>
87 #endif /* HAVE_RUSAGE */
90 #endif /* HAVE_LIMITS_H */
91 #ifdef HAVE_INTTYPES_H
93 #endif /* HAVE_INTTYPES_H */
98 /* machine dependent includes */
103 /* machine dependent includes */
104 #ifdef HAVE_LINUX_VERSION_H
105 #include <linux/version.h>
106 #endif /* HAVE_LINUX_VERSION_H */
108 #ifdef HAVE_ASM_TYPES_H
109 #include <asm/types.h>
110 #endif /* HAVE_ASM_TYPES_H */
112 /* misc include group */
114 #if !(defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)
115 /* Not C99; do we need to define va_copy? */
118 #define va_copy(DST,SRC) __va_copy(DST,SRC)
120 /* Now we are desperate; this should work on many typical platforms.
121 But this is slightly dangerous, because the standard does not require
122 va_copy to be a macro. */
123 #define va_copy(DST,SRC) memcpy(&(DST), &(SRC), sizeof(va_list))
124 #warning "Not C99 and no va_copy macro available, falling back to memcpy"
125 #endif /* __va_copy */
126 #endif /* !va_copy */
131 #include <sys/capability.h>
132 #include <sys/prctl.h>
133 #endif /* HAVE_LCAPS */
135 #ifdef HAVE_SOLARIS_CAPABILITIES
137 #endif /* HAVE_SOLARIS_CAPABILITIES */
139 /* network include group */
141 #include <sys/socket.h>
143 #ifdef HAVE_SYS_SOCKIO_H
144 #include <sys/sockio.h>
145 #endif /* HAVE_SYS_SOCKIO_H */
148 #define __APPLE_USE_RFC_3542
151 #ifdef HAVE_NETINET_IN_H
152 #include <netinet/in.h>
153 #endif /* HAVE_NETINET_IN_H */
154 #include <netinet/in_systm.h>
155 #include <netinet/ip.h>
156 #include <netinet/tcp.h>
158 #ifdef HAVE_NET_NETOPT_H
159 #include <net/netopt.h>
160 #endif /* HAVE_NET_NETOPT_H */
164 #ifdef HAVE_NET_IF_DL_H
165 #include <net/if_dl.h>
166 #endif /* HAVE_NET_IF_DL_H */
168 #ifdef HAVE_NET_IF_VAR_H
169 #include <net/if_var.h>
170 #endif /* HAVE_NET_IF_VAR_H */
172 #ifdef HAVE_NET_ROUTE_H
173 #include <net/route.h>
174 #endif /* HAVE_NET_ROUTE_H */
177 #include <linux/netlink.h>
178 #include <linux/rtnetlink.h>
179 #include <linux/filter.h>
181 #define RT_TABLE_MAIN 0
182 #endif /* HAVE_NETLINK */
186 #endif /* HAVE_NETDB_H */
188 #include <arpa/inet.h>
190 #ifdef HAVE_INET_ND_H
192 #endif /* HAVE_INET_ND_H */
194 #ifdef HAVE_NETINET_IN_VAR_H
195 #include <netinet/in_var.h>
196 #endif /* HAVE_NETINET_IN_VAR_H */
198 #ifdef HAVE_NETINET6_IN6_VAR_H
199 #include <netinet6/in6_var.h>
200 #endif /* HAVE_NETINET6_IN6_VAR_H */
202 #ifdef HAVE_NETINET_IN6_VAR_H
203 #include <netinet/in6_var.h>
204 #endif /* HAVE_NETINET_IN6_VAR_H */
206 #ifdef HAVE_NETINET6_IN_H
207 #include <netinet6/in.h>
208 #endif /* HAVE_NETINET6_IN_H */
211 #ifdef HAVE_NETINET6_IP6_H
212 #include <netinet6/ip6.h>
213 #endif /* HAVE_NETINET6_IP6_H */
215 #ifdef HAVE_NETINET_ICMP6_H
216 #include <netinet/icmp6.h>
217 #endif /* HAVE_NETINET_ICMP6_H */
219 #ifdef HAVE_NETINET6_ND6_H
220 #include <netinet6/nd6.h>
221 #endif /* HAVE_NETINET6_ND6_H */
223 /* Some systems do not define UINT32_MAX, etc.. from inttypes.h
224 * e.g. this makes life easier for FBSD 4.11 users.
227 #define INT8_MAX (127)
230 #define INT16_MAX (32767)
233 #define INT32_MAX (2147483647)
236 #define UINT8_MAX (255U)
239 #define UINT16_MAX (65535U)
242 #define UINT32_MAX (4294967295U)
245 #ifdef HAVE_GLIBC_BACKTRACE
246 #include <execinfo.h>
247 #endif /* HAVE_GLIBC_BACKTRACE */
249 /* Local includes: */
250 #if !(defined(__GNUC__) || defined(VTYSH_EXTRACT_PL))
251 #define __attribute__(x)
252 #endif /* !__GNUC__ || VTYSH_EXTRACT_PL */
258 #ifdef HAVE_BROKEN_CMSG_FIRSTHDR
259 /* This bug is present in Solaris 8 and pre-patch Solaris 9 <sys/socket.h>;
260 please refer to http://bugzilla.quagga.net/show_bug.cgi?id=142 */
262 /* Check that msg_controllen is large enough. */
263 #define ZCMSG_FIRSTHDR(mhdr) \
264 (((size_t)((mhdr)->msg_controllen) >= sizeof(struct cmsghdr)) ? \
265 CMSG_FIRSTHDR(mhdr) : (struct cmsghdr *)NULL)
267 #warning "CMSG_FIRSTHDR is broken on this platform, using a workaround"
269 #else /* HAVE_BROKEN_CMSG_FIRSTHDR */
270 #define ZCMSG_FIRSTHDR(M) CMSG_FIRSTHDR(M)
271 #endif /* HAVE_BROKEN_CMSG_FIRSTHDR */
276 * RFC 3542 defines several macros for using struct cmsghdr.
277 * Here, we define those that are not present
281 * Internal defines, for use only in this file.
282 * These are likely wrong on other than ILP32 machines, so warn.
284 #ifndef _CMSG_DATA_ALIGN
285 #define _CMSG_DATA_ALIGN(n) (((n) + 3) & ~3)
286 #endif /* _CMSG_DATA_ALIGN */
288 #ifndef _CMSG_HDR_ALIGN
289 #define _CMSG_HDR_ALIGN(n) (((n) + 3) & ~3)
290 #endif /* _CMSG_HDR_ALIGN */
293 * CMSG_SPACE and CMSG_LEN are required in RFC3542, but were new in that
297 #define CMSG_SPACE(l) (_CMSG_DATA_ALIGN(sizeof(struct cmsghdr)) + \
299 #warning "assuming 4-byte alignment for CMSG_SPACE"
300 #endif /* CMSG_SPACE */
304 #define CMSG_LEN(l) (_CMSG_DATA_ALIGN(sizeof(struct cmsghdr)) + (l))
305 #warning "assuming 4-byte alignment for CMSG_LEN"
306 #endif /* CMSG_LEN */
309 /* The definition of struct in_pktinfo is missing in old version of
310 GLIBC 2.1 (Redhat 6.1). */
311 #if defined (GNU_LINUX) && ! defined (HAVE_STRUCT_IN_PKTINFO)
315 struct in_addr ipi_spec_dst
;
316 struct in_addr ipi_addr
;
321 * OSPF Fragmentation / fragmented writes
323 * ospfd can support writing fragmented packets, for cases where
324 * kernel will not fragment IP_HDRINCL and/or multicast destined
325 * packets (ie TTBOMK all kernels, BSD, SunOS, Linux). However,
326 * SunOS, probably BSD too, clobber the user supplied IP ID and IP
327 * flags fields, hence user-space fragmentation will not work.
328 * Only Linux is known to leave IP header unmolested.
329 * Further, fragmentation really should be done the kernel, which already
330 * supports it, and which avoids nasty IP ID state problems.
332 * Fragmentation of OSPF packets can be required on networks with router
333 * with many many interfaces active in one area, or on networks with links
337 #define WANT_OSPF_WRITE_FRAGMENT
341 * IP_HDRINCL / struct ip byte order
343 * Linux: network byte order
344 * *BSD: network, except for length and offset. (cf Stevens)
345 * SunOS: nominally as per BSD. but bug: network order on LE.
346 * OpenBSD: network byte order, apart from older versions which are as per
349 #if defined(__NetBSD__) \
350 || (defined(__FreeBSD__) && (__FreeBSD_version < 1100030)) \
351 || (defined(__OpenBSD__) && (OpenBSD < 200311)) \
352 || (defined(__APPLE__)) \
353 || (defined(SUNOS_5) && defined(WORDS_BIGENDIAN))
354 #define HAVE_IP_HDRINCL_BSD_ORDER
357 /* Define BYTE_ORDER, if not defined. Useful for compiler conditional
358 * code, rather than preprocessor conditional.
359 * Not all the world has this BSD define.
362 #define BIG_ENDIAN 4321 /* least-significant byte first (vax, pc) */
363 #define LITTLE_ENDIAN 1234 /* most-significant byte first (IBM, net) */
364 #define PDP_ENDIAN 3412 /* LSB first in word, MSW first in long (pdp) */
366 #if defined(WORDS_BIGENDIAN)
367 #define BYTE_ORDER BIG_ENDIAN
368 #else /* !WORDS_BIGENDIAN */
369 #define BYTE_ORDER LITTLE_ENDIAN
370 #endif /* WORDS_BIGENDIAN */
372 #endif /* ndef BYTE_ORDER */
374 /* MAX / MIN are not commonly defined, but useful */
377 ({ typeof (a) _a = (a); \
378 typeof (b) _b = (b); \
379 _a > _b ? _a : _b; })
383 ({ typeof (a) _a = (a); \
384 typeof (b) _b = (b); \
385 _a < _b ? _a : _b; })
388 #define ZEBRA_NUM_OF(x) (sizeof (x) / sizeof (x[0]))
390 /* For old definition. */
391 #ifndef IN6_ARE_ADDR_EQUAL
392 #define IN6_ARE_ADDR_EQUAL IN6_IS_ADDR_EQUAL
393 #endif /* IN6_ARE_ADDR_EQUAL */
395 /* default zebra TCP port for zclient */
396 #define ZEBRA_PORT 2600
398 /* Zebra message types. */
399 #define ZEBRA_INTERFACE_ADD 1
400 #define ZEBRA_INTERFACE_DELETE 2
401 #define ZEBRA_INTERFACE_ADDRESS_ADD 3
402 #define ZEBRA_INTERFACE_ADDRESS_DELETE 4
403 #define ZEBRA_INTERFACE_UP 5
404 #define ZEBRA_INTERFACE_DOWN 6
405 #define ZEBRA_IPV4_ROUTE_ADD 7
406 #define ZEBRA_IPV4_ROUTE_DELETE 8
407 #define ZEBRA_IPV6_ROUTE_ADD 9
408 #define ZEBRA_IPV6_ROUTE_DELETE 10
409 #define ZEBRA_REDISTRIBUTE_ADD 11
410 #define ZEBRA_REDISTRIBUTE_DELETE 12
411 #define ZEBRA_REDISTRIBUTE_DEFAULT_ADD 13
412 #define ZEBRA_REDISTRIBUTE_DEFAULT_DELETE 14
413 #define ZEBRA_IPV4_NEXTHOP_LOOKUP 15
414 #define ZEBRA_IPV6_NEXTHOP_LOOKUP 16
415 #define ZEBRA_IPV4_IMPORT_LOOKUP 17
416 #define ZEBRA_IPV6_IMPORT_LOOKUP 18
417 #define ZEBRA_INTERFACE_RENAME 19
418 #define ZEBRA_ROUTER_ID_ADD 20
419 #define ZEBRA_ROUTER_ID_DELETE 21
420 #define ZEBRA_ROUTER_ID_UPDATE 22
421 #define ZEBRA_HELLO 23
422 #define ZEBRA_NEXTHOP_REGISTER 24
423 #define ZEBRA_NEXTHOP_UNREGISTER 25
424 #define ZEBRA_NEXTHOP_UPDATE 26
425 #define ZEBRA_INTERFACE_NBR_ADDRESS_ADD 27
426 #define ZEBRA_INTERFACE_NBR_ADDRESS_DELETE 28
427 #define ZEBRA_INTERFACE_BFD_DEST_UPDATE 29
428 #define ZEBRA_IMPORT_ROUTE_REGISTER 30
429 #define ZEBRA_IMPORT_ROUTE_UNREGISTER 31
430 #define ZEBRA_IMPORT_CHECK_UPDATE 32
431 #define ZEBRA_IPV4_ROUTE_IPV6_NEXTHOP_ADD 33
432 #define ZEBRA_BFD_DEST_REGISTER 34
433 #define ZEBRA_BFD_DEST_DEREGISTER 35
434 #define ZEBRA_BFD_DEST_UPDATE 36
435 #define ZEBRA_BFD_DEST_REPLAY 37
436 #define ZEBRA_REDISTRIBUTE_IPV4_ADD 38
437 #define ZEBRA_REDISTRIBUTE_IPV4_DEL 39
438 #define ZEBRA_REDISTRIBUTE_IPV6_ADD 40
439 #define ZEBRA_REDISTRIBUTE_IPV6_DEL 41
440 #define ZEBRA_VRF_UNREGISTER 42
441 #define ZEBRA_VRF_ADD 43
442 #define ZEBRA_VRF_DELETE 44
443 #define ZEBRA_INTERFACE_VRF_UPDATE 45
444 #define ZEBRA_BFD_CLIENT_REGISTER 46
445 #define ZEBRA_INTERFACE_ENABLE_RADV 47
446 #define ZEBRA_INTERFACE_DISABLE_RADV 48
447 #define ZEBRA_IPV4_NEXTHOP_LOOKUP_MRIB 49
448 #define ZEBRA_MESSAGE_MAX 50
450 /* Marker value used in new Zserv, in the byte location corresponding
451 * the command value in the old zserv header. To allow old and new
452 * Zserv headers to be distinguished from each other.
454 #define ZEBRA_HEADER_MARKER 255
456 /* Zebra route's types are defined in route_types.h */
457 #include "route_types.h"
459 /* Note: whenever a new route-type or zserv-command is added the
460 * corresponding {command,route}_types[] table in lib/log.c MUST be
463 /* Map a route type to a string. For example, ZEBRA_ROUTE_RIPNG -> "ripng". */
464 extern const char *zebra_route_string(unsigned int route_type
);
465 /* Map a route type to a char. For example, ZEBRA_ROUTE_RIPNG -> 'R'. */
466 extern char zebra_route_char(unsigned int route_type
);
467 /* Map a zserv command type to the same string,
468 * e.g. ZEBRA_INTERFACE_ADD -> "ZEBRA_INTERFACE_ADD" */
469 /* Map a protocol name to its number. e.g. ZEBRA_ROUTE_BGP->9*/
470 extern int proto_name2num(const char *s
);
471 /* Map redistribute X argument to protocol number.
472 * unlike proto_name2num, this accepts shorthands and takes
473 * an AFI value to restrict input */
474 extern int proto_redistnum(int afi
, const char *s
);
476 extern const char *zserv_command_string (unsigned int command
);
478 /* Error codes of zebra. */
479 #define ZEBRA_ERR_NOERROR 0
480 #define ZEBRA_ERR_RTEXIST -1
481 #define ZEBRA_ERR_RTUNREACH -2
482 #define ZEBRA_ERR_EPERM -3
483 #define ZEBRA_ERR_RTNOEXIST -4
484 #define ZEBRA_ERR_KERNEL -5
486 /* Zebra message flags */
487 #define ZEBRA_FLAG_INTERNAL 0x01
488 #define ZEBRA_FLAG_SELFROUTE 0x02
489 #define ZEBRA_FLAG_BLACKHOLE 0x04
490 #define ZEBRA_FLAG_IBGP 0x08
491 #define ZEBRA_FLAG_SELECTED 0x10
492 #define ZEBRA_FLAG_STATIC 0x40
493 #define ZEBRA_FLAG_REJECT 0x80
494 #define ZEBRA_FLAG_SCOPE_LINK 0x100
496 /* Zebra nexthop flags. */
497 #define ZEBRA_NEXTHOP_IFINDEX 1
498 #define ZEBRA_NEXTHOP_IPV4 2
499 #define ZEBRA_NEXTHOP_IPV4_IFINDEX 3
500 #define ZEBRA_NEXTHOP_IPV6 4
501 #define ZEBRA_NEXTHOP_IPV6_IFINDEX 5
502 #define ZEBRA_NEXTHOP_BLACKHOLE 6
503 #define ZEBRA_NEXTHOP_IPV4_ONLINK 7
505 #ifndef INADDR_LOOPBACK
506 #define INADDR_LOOPBACK 0x7f000001 /* Internet address 127.0.0.1. */
509 /* Address family numbers from RFC1700. */
516 /* Subsequent Address Family Identifier. */
517 #define SAFI_UNICAST 1
518 #define SAFI_MULTICAST 2
519 #define SAFI_RESERVED_3 3
520 #define SAFI_MPLS_VPN 4
521 #define SAFI_ENCAP 7 /* per IANA */
524 /* Default Administrative Distance of each protocol. */
525 #define ZEBRA_KERNEL_DISTANCE_DEFAULT 0
526 #define ZEBRA_CONNECT_DISTANCE_DEFAULT 0
527 #define ZEBRA_STATIC_DISTANCE_DEFAULT 1
528 #define ZEBRA_RIP_DISTANCE_DEFAULT 120
529 #define ZEBRA_RIPNG_DISTANCE_DEFAULT 120
530 #define ZEBRA_OSPF_DISTANCE_DEFAULT 110
531 #define ZEBRA_OSPF6_DISTANCE_DEFAULT 110
532 #define ZEBRA_ISIS_DISTANCE_DEFAULT 115
533 #define ZEBRA_IBGP_DISTANCE_DEFAULT 200
534 #define ZEBRA_EBGP_DISTANCE_DEFAULT 20
535 #define ZEBRA_TABLE_DISTANCE_DEFAULT 15
537 /* Flag manipulation macros. */
538 #define CHECK_FLAG(V,F) ((V) & (F))
539 #define SET_FLAG(V,F) (V) |= (F)
540 #define UNSET_FLAG(V,F) (V) &= ~(F)
541 #define RESET_FLAG(V) (V) = 0
543 typedef u_int8_t safi_t
;
545 /* Zebra types. Used in Zserv message header. */
546 typedef u_int16_t zebra_size_t
;
547 typedef u_int16_t zebra_command_t
;
550 typedef u_int16_t vrf_id_t
;
552 /* FIFO -- first in first out structure and macros. */
559 #define FIFO_INIT(F) \
561 struct fifo *Xfifo = (struct fifo *)(F); \
562 Xfifo->next = Xfifo->prev = Xfifo; \
565 #define FIFO_ADD(F,N) \
567 struct fifo *Xfifo = (struct fifo *)(F); \
568 struct fifo *Xnode = (struct fifo *)(N); \
569 Xnode->next = Xfifo; \
570 Xnode->prev = Xfifo->prev; \
571 Xfifo->prev = Xfifo->prev->next = Xnode; \
574 #define FIFO_DEL(N) \
576 struct fifo *Xnode = (struct fifo *)(N); \
577 Xnode->prev->next = Xnode->next; \
578 Xnode->next->prev = Xnode->prev; \
581 #define FIFO_HEAD(F) \
582 ((((struct fifo *)(F))->next == (struct fifo *)(F)) \
585 #define FIFO_EMPTY(F) \
586 (((struct fifo *)(F))->next == (struct fifo *)(F))
588 #define FIFO_TOP(F) \
589 (FIFO_EMPTY(F) ? NULL : ((struct fifo *)(F))->next)
591 #endif /* _ZEBRA_H */