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 along
17 * with this program; see the file COPYING; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
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
;
48 #endif /* HAVE_STROPTS_H */
49 #include <sys/select.h>
51 #include <sys/types.h>
52 #include <sys/param.h>
53 #ifdef HAVE_SYS_SYSCTL_H
55 #include <linux/types.h>
57 #include <sys/sysctl.h>
58 #endif /* HAVE_SYS_SYSCTL_H */
59 #include <sys/ioctl.h>
60 #ifdef HAVE_SYS_CONF_H
62 #endif /* HAVE_SYS_CONF_H */
63 #ifdef HAVE_SYS_KSYM_H
65 #endif /* HAVE_SYS_KSYM_H */
70 #include <sys/utsname.h>
71 #include <sys/resource.h>
76 /* machine dependent includes */
81 /* machine dependent includes */
82 #ifdef HAVE_LINUX_VERSION_H
83 #include <linux/version.h>
84 #endif /* HAVE_LINUX_VERSION_H */
86 #ifdef HAVE_ASM_TYPES_H
87 #include <asm/types.h>
88 #endif /* HAVE_ASM_TYPES_H */
90 /* misc include group */
92 #if !(defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)
93 /* Not C99; do we need to define va_copy? */
96 #define va_copy(DST,SRC) __va_copy(DST,SRC)
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 */
109 #include <sys/capability.h>
110 #include <sys/prctl.h>
111 #endif /* HAVE_LCAPS */
113 #ifdef HAVE_SOLARIS_CAPABILITIES
115 #endif /* HAVE_SOLARIS_CAPABILITIES */
117 /* network include group */
119 #include <sys/socket.h>
121 #ifdef HAVE_SYS_SOCKIO_H
122 #include <sys/sockio.h>
123 #endif /* HAVE_SYS_SOCKIO_H */
126 #define __APPLE_USE_RFC_3542
129 #include <netinet/in.h>
130 #include <netinet/in_systm.h>
131 #include <netinet/ip.h>
132 #include <netinet/tcp.h>
134 #ifdef HAVE_NET_NETOPT_H
135 #include <net/netopt.h>
136 #endif /* HAVE_NET_NETOPT_H */
140 #ifdef HAVE_NET_IF_DL_H
141 #include <net/if_dl.h>
142 #endif /* HAVE_NET_IF_DL_H */
144 #ifdef HAVE_NET_IF_VAR_H
145 #include <net/if_var.h>
146 #endif /* HAVE_NET_IF_VAR_H */
148 #include <net/route.h>
151 #include <linux/netlink.h>
152 #include <linux/rtnetlink.h>
153 #include <linux/filter.h>
155 #define RT_TABLE_MAIN 0
156 #endif /* HAVE_NETLINK */
159 #include <arpa/inet.h>
161 #ifdef HAVE_INET_ND_H
163 #endif /* HAVE_INET_ND_H */
165 #ifdef HAVE_NETINET_IN_VAR_H
166 #include <netinet/in_var.h>
167 #endif /* HAVE_NETINET_IN_VAR_H */
169 #ifdef HAVE_NETINET6_IN6_VAR_H
170 #include <netinet6/in6_var.h>
171 #endif /* HAVE_NETINET6_IN6_VAR_H */
173 #ifdef HAVE_NETINET_IN6_VAR_H
174 #include <netinet/in6_var.h>
175 #endif /* HAVE_NETINET_IN6_VAR_H */
177 #ifdef HAVE_NETINET6_IN_H
178 #include <netinet6/in.h>
179 #endif /* HAVE_NETINET6_IN_H */
182 #ifdef HAVE_NETINET6_IP6_H
183 #include <netinet6/ip6.h>
184 #endif /* HAVE_NETINET6_IP6_H */
186 #include <netinet/icmp6.h>
188 #ifdef HAVE_NETINET6_ND6_H
189 #include <netinet6/nd6.h>
190 #endif /* HAVE_NETINET6_ND6_H */
192 /* Some systems do not define UINT32_MAX, etc.. from inttypes.h
193 * e.g. this makes life easier for FBSD 4.11 users.
196 #define INT8_MAX (127)
199 #define INT16_MAX (32767)
202 #define INT32_MAX (2147483647)
205 #define UINT8_MAX (255U)
208 #define UINT16_MAX (65535U)
211 #define UINT32_MAX (4294967295U)
214 #ifdef HAVE_GLIBC_BACKTRACE
215 #include <execinfo.h>
216 #endif /* HAVE_GLIBC_BACKTRACE */
218 /* Local includes: */
219 #if !(defined(__GNUC__) || defined(VTYSH_EXTRACT_PL))
220 #define __attribute__(x)
221 #endif /* !__GNUC__ || VTYSH_EXTRACT_PL */
226 size_t strlcat (char *__restrict dest
, const char *__restrict src
, size_t size
);
229 size_t strlcpy (char *__restrict dest
, const char *__restrict src
, size_t size
);
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 */
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) : (struct cmsghdr *)NULL)
241 #warning "CMSG_FIRSTHDR is broken on this platform, using a workaround"
243 #else /* HAVE_BROKEN_CMSG_FIRSTHDR */
244 #define ZCMSG_FIRSTHDR(M) CMSG_FIRSTHDR(M)
245 #endif /* HAVE_BROKEN_CMSG_FIRSTHDR */
250 * RFC 3542 defines several macros for using struct cmsghdr.
251 * Here, we define those that are not present
255 * Internal defines, for use only in this file.
256 * These are likely wrong on other than ILP32 machines, so warn.
258 #ifndef _CMSG_DATA_ALIGN
259 #define _CMSG_DATA_ALIGN(n) (((n) + 3) & ~3)
260 #endif /* _CMSG_DATA_ALIGN */
262 #ifndef _CMSG_HDR_ALIGN
263 #define _CMSG_HDR_ALIGN(n) (((n) + 3) & ~3)
264 #endif /* _CMSG_HDR_ALIGN */
267 * CMSG_SPACE and CMSG_LEN are required in RFC3542, but were new in that
271 #define CMSG_SPACE(l) (_CMSG_DATA_ALIGN(sizeof(struct cmsghdr)) + \
273 #warning "assuming 4-byte alignment for CMSG_SPACE"
274 #endif /* CMSG_SPACE */
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 */
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)
289 struct in_addr ipi_spec_dst
;
290 struct in_addr ipi_addr
;
295 * IP_HDRINCL / struct ip byte order
297 * Linux: network byte order
298 * *BSD: network, except for length and offset. (cf Stevens)
299 * SunOS: nominally as per BSD. but bug: network order on LE.
300 * OpenBSD: network byte order, apart from older versions which are as per
303 #if defined(__NetBSD__) \
304 || (defined(__FreeBSD__) && (__FreeBSD_version < 1100030)) \
305 || (defined(__OpenBSD__) && (OpenBSD < 200311)) \
306 || (defined(__APPLE__)) \
307 || (defined(SUNOS_5) && defined(WORDS_BIGENDIAN))
308 #define HAVE_IP_HDRINCL_BSD_ORDER
311 /* Define BYTE_ORDER, if not defined. Useful for compiler conditional
312 * code, rather than preprocessor conditional.
313 * Not all the world has this BSD define.
316 #define BIG_ENDIAN 4321 /* least-significant byte first (vax, pc) */
317 #define LITTLE_ENDIAN 1234 /* most-significant byte first (IBM, net) */
318 #define PDP_ENDIAN 3412 /* LSB first in word, MSW first in long (pdp) */
320 #if defined(WORDS_BIGENDIAN)
321 #define BYTE_ORDER BIG_ENDIAN
322 #else /* !WORDS_BIGENDIAN */
323 #define BYTE_ORDER LITTLE_ENDIAN
324 #endif /* WORDS_BIGENDIAN */
326 #endif /* ndef BYTE_ORDER */
328 /* MAX / MIN are not commonly defined, but useful */
329 /* note: glibc sys/param.h has #define MIN(a,b) (((a)<(b))?(a):(b)) */
334 ({ typeof (a) _a = (a); \
335 typeof (b) _b = (b); \
336 _a > _b ? _a : _b; })
341 ({ typeof (a) _a = (a); \
342 typeof (b) _b = (b); \
343 _a < _b ? _a : _b; })
345 #define ZEBRA_NUM_OF(x) (sizeof (x) / sizeof (x[0]))
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 */
352 /* default zebra TCP port for zclient */
353 #define ZEBRA_PORT 2600
355 /* Marker value used in new Zserv, in the byte location corresponding
356 * the command value in the old zserv header. To allow old and new
357 * Zserv headers to be distinguished from each other.
359 #define ZEBRA_HEADER_MARKER 254
361 /* Zebra route's types are defined in route_types.h */
362 #include "route_types.h"
364 /* Note: whenever a new route-type or zserv-command is added the
365 * corresponding {command,route}_types[] table in lib/log.c MUST be
368 /* Map a route type to a string. For example, ZEBRA_ROUTE_RIPNG -> "ripng". */
369 extern const char *zebra_route_string(unsigned int route_type
);
370 /* Map a route type to a char. For example, ZEBRA_ROUTE_RIPNG -> 'R'. */
371 extern char zebra_route_char(unsigned int route_type
);
372 /* Map a zserv command type to the same string,
373 * e.g. ZEBRA_INTERFACE_ADD -> "ZEBRA_INTERFACE_ADD" */
374 /* Map a protocol name to its number. e.g. ZEBRA_ROUTE_BGP->9*/
375 extern int proto_name2num(const char *s
);
376 /* Map redistribute X argument to protocol number.
377 * unlike proto_name2num, this accepts shorthands and takes
378 * an AFI value to restrict input */
379 extern int proto_redistnum(int afi
, const char *s
);
381 extern const char *zserv_command_string (unsigned int command
);
383 #define strmatch(a,b) (!strcmp((a), (b)))
385 /* Zebra message flags */
386 #define ZEBRA_FLAG_INTERNAL 0x01
387 #define ZEBRA_FLAG_SELFROUTE 0x02
388 #define ZEBRA_FLAG_BLACKHOLE 0x04
389 #define ZEBRA_FLAG_IBGP 0x08
390 #define ZEBRA_FLAG_SELECTED 0x10
391 #define ZEBRA_FLAG_STATIC 0x40
392 #define ZEBRA_FLAG_REJECT 0x80
393 #define ZEBRA_FLAG_SCOPE_LINK 0x100
394 #define ZEBRA_FLAG_FIB_OVERRIDE 0x200
396 /* Zebra FEC flags. */
397 #define ZEBRA_FEC_REGISTER_LABEL_INDEX 0x1
399 #ifndef INADDR_LOOPBACK
400 #define INADDR_LOOPBACK 0x7f000001 /* Internet address 127.0.0.1. */
403 /* Address family numbers from RFC1700. */
411 /* Subsequent Address Family Identifier. */
412 #define SAFI_UNICAST 1
413 #define SAFI_MULTICAST 2
414 #define SAFI_MPLS_VPN 3
415 #define SAFI_RESERVED_4 4
417 #define SAFI_RESERVED_5 5
419 #define SAFI_LABELED_UNICAST 7
422 #define IANA_SAFI_RESERVED 0
423 #define IANA_SAFI_UNICAST 1
424 #define IANA_SAFI_MULTICAST 2
425 #define IANA_SAFI_LABELED_UNICAST 4
426 #define IANA_SAFI_ENCAP 7
427 #define IANA_SAFI_MPLS_VPN 128
430 * The above AFI and SAFI definitions are for internal use. The protocol
431 * definitions (IANA values) as for example used in BGP protocol packets
432 * are defined below and these will get mapped to/from the internal values
433 * in the appropriate places.
434 * The rationale is that the protocol (IANA) values may be sparse and are
435 * not optimal for use in data-structure sizing.
436 * Note: Only useful (i.e., supported) values are defined below.
439 IANA_AFI_RESERVED
= 0,
447 #define IANA_SAFI_RESERVED 0
448 #define IANA_SAFI_UNICAST 1
449 #define IANA_SAFI_MULTICAST 2
450 #define IANA_SAFI_ENCAP 7
451 #define IANA_SAFI_EVPN 70
452 #define IANA_SAFI_MPLS_VPN 128
454 /* Default Administrative Distance of each protocol. */
455 #define ZEBRA_KERNEL_DISTANCE_DEFAULT 0
456 #define ZEBRA_CONNECT_DISTANCE_DEFAULT 0
457 #define ZEBRA_STATIC_DISTANCE_DEFAULT 1
458 #define ZEBRA_RIP_DISTANCE_DEFAULT 120
459 #define ZEBRA_RIPNG_DISTANCE_DEFAULT 120
460 #define ZEBRA_OSPF_DISTANCE_DEFAULT 110
461 #define ZEBRA_OSPF6_DISTANCE_DEFAULT 110
462 #define ZEBRA_ISIS_DISTANCE_DEFAULT 115
463 #define ZEBRA_IBGP_DISTANCE_DEFAULT 200
464 #define ZEBRA_EBGP_DISTANCE_DEFAULT 20
465 #define ZEBRA_TABLE_DISTANCE_DEFAULT 15
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 #define RESET_FLAG(V) (V) = 0
473 typedef u_int8_t safi_t
;
475 /* Zebra types. Used in Zserv message header. */
476 typedef u_int16_t zebra_size_t
;
477 typedef u_int16_t zebra_command_t
;
480 typedef u_int16_t vrf_id_t
;
482 typedef uint32_t route_tag_t
;
483 #define ROUTE_TAG_MAX UINT32_MAX
484 #define ROUTE_TAG_PRI PRIu32
486 static inline afi_t
afi_iana2int (iana_afi_t afi
)
488 if (afi
== IANA_AFI_IPV4
)
490 if (afi
== IANA_AFI_IPV6
)
492 if (afi
== IANA_AFI_L2VPN
)
497 static inline iana_afi_t
afi_int2iana (afi_t afi
)
500 return IANA_AFI_IPV4
;
502 return IANA_AFI_IPV6
;
503 if (afi
== AFI_L2VPN
)
504 return IANA_AFI_L2VPN
;
505 return IANA_AFI_RESERVED
;
508 static inline safi_t
safi_iana2int (safi_t safi
)
510 if (safi
== IANA_SAFI_UNICAST
)
512 if (safi
== IANA_SAFI_MULTICAST
)
513 return SAFI_MULTICAST
;
514 if (safi
== IANA_SAFI_MPLS_VPN
)
515 return SAFI_MPLS_VPN
;
516 if (safi
== IANA_SAFI_ENCAP
)
518 if (safi
== IANA_SAFI_EVPN
)
520 if (safi
== IANA_SAFI_LABELED_UNICAST
)
521 return SAFI_LABELED_UNICAST
;
525 static inline safi_t
safi_int2iana (safi_t safi
)
527 if (safi
== SAFI_UNICAST
)
528 return IANA_SAFI_UNICAST
;
529 if (safi
== SAFI_MULTICAST
)
530 return IANA_SAFI_MULTICAST
;
531 if (safi
== SAFI_MPLS_VPN
)
532 return IANA_SAFI_MPLS_VPN
;
533 if (safi
== SAFI_ENCAP
)
534 return IANA_SAFI_ENCAP
;
535 if (safi
== SAFI_EVPN
)
536 return IANA_SAFI_EVPN
;
537 if (safi
== SAFI_LABELED_UNICAST
)
538 return IANA_SAFI_LABELED_UNICAST
;
539 return IANA_SAFI_RESERVED
;
542 #endif /* _ZEBRA_H */