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 */
31 typedef unsigned int uint32_t;
32 typedef unsigned short uint16_t;
33 typedef unsigned char uint8_t;
49 #endif /* HAVE_STROPTS_H */
50 #include <sys/select.h>
52 #include <sys/types.h>
53 #include <sys/param.h>
54 #ifdef HAVE_SYS_SYSCTL_H
56 #include <linux/types.h>
58 #include <sys/sysctl.h>
59 #endif /* HAVE_SYS_SYSCTL_H */
60 #include <sys/ioctl.h>
61 #ifdef HAVE_SYS_CONF_H
63 #endif /* HAVE_SYS_CONF_H */
64 #ifdef HAVE_SYS_KSYM_H
66 #endif /* HAVE_SYS_KSYM_H */
71 #include <sys/utsname.h>
72 #include <sys/resource.h>
77 /* machine dependent includes */
82 /* machine dependent includes */
83 #ifdef HAVE_LINUX_VERSION_H
84 #include <linux/version.h>
85 #endif /* HAVE_LINUX_VERSION_H */
87 #ifdef HAVE_ASM_TYPES_H
88 #include <asm/types.h>
89 #endif /* HAVE_ASM_TYPES_H */
91 /* misc include group */
93 #if !(defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)
94 /* Not C99; do we need to define va_copy? */
97 #define va_copy(DST,SRC) __va_copy(DST,SRC)
99 /* Now we are desperate; this should work on many typical platforms.
100 But this is slightly dangerous, because the standard does not require
101 va_copy to be a macro. */
102 #define va_copy(DST,SRC) memcpy(&(DST), &(SRC), sizeof(va_list))
103 #warning "Not C99 and no va_copy macro available, falling back to memcpy"
104 #endif /* __va_copy */
105 #endif /* !va_copy */
110 #include <sys/capability.h>
111 #include <sys/prctl.h>
112 #endif /* HAVE_LCAPS */
114 #ifdef HAVE_SOLARIS_CAPABILITIES
116 #endif /* HAVE_SOLARIS_CAPABILITIES */
118 /* network include group */
120 #include <sys/socket.h>
122 #ifdef HAVE_SYS_SOCKIO_H
123 #include <sys/sockio.h>
124 #endif /* HAVE_SYS_SOCKIO_H */
127 #define __APPLE_USE_RFC_3542
130 #ifndef HAVE_LIBCRYPT
131 #ifdef HAVE_LIBCRYPTO
132 #include <openssl/des.h>
133 # define crypt DES_crypt
137 #include "openbsd-tree.h"
139 #include <netinet/in.h>
140 #include <netinet/in_systm.h>
141 #include <netinet/ip.h>
142 #include <netinet/tcp.h>
144 #ifdef HAVE_NET_NETOPT_H
145 #include <net/netopt.h>
146 #endif /* HAVE_NET_NETOPT_H */
150 #ifdef HAVE_NET_IF_DL_H
151 #include <net/if_dl.h>
152 #endif /* HAVE_NET_IF_DL_H */
154 #ifdef HAVE_NET_IF_VAR_H
155 #include <net/if_var.h>
156 #endif /* HAVE_NET_IF_VAR_H */
158 #include <net/route.h>
161 #include <linux/netlink.h>
162 #include <linux/rtnetlink.h>
163 #include <linux/filter.h>
165 #define RT_TABLE_MAIN 0
166 #endif /* HAVE_NETLINK */
169 #include <arpa/inet.h>
171 #ifdef HAVE_INET_ND_H
173 #endif /* HAVE_INET_ND_H */
175 #ifdef HAVE_NETINET_IN_VAR_H
176 #include <netinet/in_var.h>
177 #endif /* HAVE_NETINET_IN_VAR_H */
179 #ifdef HAVE_NETINET6_IN6_VAR_H
180 #include <netinet6/in6_var.h>
181 #endif /* HAVE_NETINET6_IN6_VAR_H */
183 #ifdef HAVE_NETINET_IN6_VAR_H
184 #include <netinet/in6_var.h>
185 #endif /* HAVE_NETINET_IN6_VAR_H */
187 #ifdef HAVE_NETINET6_IN_H
188 #include <netinet6/in.h>
189 #endif /* HAVE_NETINET6_IN_H */
192 #ifdef HAVE_NETINET6_IP6_H
193 #include <netinet6/ip6.h>
194 #endif /* HAVE_NETINET6_IP6_H */
196 #include <netinet/icmp6.h>
198 #ifdef HAVE_NETINET6_ND6_H
199 #include <netinet6/nd6.h>
200 #endif /* HAVE_NETINET6_ND6_H */
202 /* Some systems do not define UINT32_MAX, etc.. from inttypes.h
203 * e.g. this makes life easier for FBSD 4.11 users.
206 #define INT8_MAX (127)
209 #define INT16_MAX (32767)
212 #define INT32_MAX (2147483647)
215 #define UINT8_MAX (255U)
218 #define UINT16_MAX (65535U)
221 #define UINT32_MAX (4294967295U)
224 #ifdef HAVE_GLIBC_BACKTRACE
225 #include <execinfo.h>
226 #endif /* HAVE_GLIBC_BACKTRACE */
228 /* Local includes: */
229 #if !(defined(__GNUC__) || defined(VTYSH_EXTRACT_PL))
230 #define __attribute__(x)
231 #endif /* !__GNUC__ || VTYSH_EXTRACT_PL */
236 size_t strlcat(char *__restrict dest
,
237 const char *__restrict src
, size_t destsize
);
240 size_t strlcpy(char *__restrict dest
,
241 const char *__restrict src
, size_t destsize
);
244 /* GCC have printf type attribute check. */
246 #define PRINTF_ATTRIBUTE(a,b) __attribute__ ((__format__ (__printf__, a, b)))
248 #define PRINTF_ATTRIBUTE(a,b)
249 #endif /* __GNUC__ */
252 * RFC 3542 defines several macros for using struct cmsghdr.
253 * Here, we define those that are not present
257 * Internal defines, for use only in this file.
258 * These are likely wrong on other than ILP32 machines, so warn.
260 #ifndef _CMSG_DATA_ALIGN
261 #define _CMSG_DATA_ALIGN(n) (((n) + 3) & ~3)
262 #endif /* _CMSG_DATA_ALIGN */
264 #ifndef _CMSG_HDR_ALIGN
265 #define _CMSG_HDR_ALIGN(n) (((n) + 3) & ~3)
266 #endif /* _CMSG_HDR_ALIGN */
269 * CMSG_SPACE and CMSG_LEN are required in RFC3542, but were new in that
273 #define CMSG_SPACE(l) \
274 (_CMSG_DATA_ALIGN(sizeof(struct cmsghdr)) + _CMSG_HDR_ALIGN(l))
275 #warning "assuming 4-byte alignment for CMSG_SPACE"
276 #endif /* CMSG_SPACE */
280 #define CMSG_LEN(l) (_CMSG_DATA_ALIGN(sizeof(struct cmsghdr)) + (l))
281 #warning "assuming 4-byte alignment for CMSG_LEN"
282 #endif /* CMSG_LEN */
285 /* The definition of struct in_pktinfo is missing in old version of
286 GLIBC 2.1 (Redhat 6.1). */
287 #if defined(GNU_LINUX) && !defined(HAVE_STRUCT_IN_PKTINFO)
290 struct in_addr ipi_spec_dst
;
291 struct in_addr ipi_addr
;
296 * IP_HDRINCL / struct ip byte order
298 * Linux: network byte order
299 * *BSD: network, except for length and offset. (cf Stevens)
300 * SunOS: nominally as per BSD. but bug: network order on LE.
301 * OpenBSD: network byte order, apart from older versions which are as per
304 #if defined(__NetBSD__) \
305 || (defined(__FreeBSD__) && (__FreeBSD_version < 1100030)) \
306 || (defined(__OpenBSD__) && (OpenBSD < 200311)) \
307 || (defined(__APPLE__)) \
308 || (defined(SUNOS_5) && defined(WORDS_BIGENDIAN))
309 #define HAVE_IP_HDRINCL_BSD_ORDER
312 /* Define BYTE_ORDER, if not defined. Useful for compiler conditional
313 * code, rather than preprocessor conditional.
314 * Not all the world has this BSD define.
317 #define BIG_ENDIAN 4321 /* least-significant byte first (vax, pc) */
318 #define LITTLE_ENDIAN 1234 /* most-significant byte first (IBM, net) */
319 #define PDP_ENDIAN 3412 /* LSB first in word, MSW first in long (pdp) */
321 #if defined(WORDS_BIGENDIAN)
322 #define BYTE_ORDER BIG_ENDIAN
323 #else /* !WORDS_BIGENDIAN */
324 #define BYTE_ORDER LITTLE_ENDIAN
325 #endif /* WORDS_BIGENDIAN */
327 #endif /* ndef BYTE_ORDER */
329 /* MAX / MIN are not commonly defined, but useful */
330 /* note: glibc sys/param.h has #define MIN(a,b) (((a)<(b))?(a):(b)) */
336 typeof(a) _max_a = (a); \
337 typeof(b) _max_b = (b); \
338 _max_a > _max_b ? _max_a : _max_b; \
345 typeof(a) _min_a = (a); \
346 typeof(b) _min_b = (b); \
347 _min_a < _min_b ? _min_a : _min_b; \
351 #ifdef __compiler_offsetof
352 #define offsetof(TYPE,MEMBER) __compiler_offsetof(TYPE,MEMBER)
354 #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
359 #define container_of(ptr, type, member) \
361 const typeof(((type *)0)->member) *__mptr = (ptr); \
362 (type *)((char *)__mptr - offsetof(type, member)); \
366 #define ZEBRA_NUM_OF(x) (sizeof (x) / sizeof (x[0]))
368 /* For old definition. */
369 #ifndef IN6_ARE_ADDR_EQUAL
370 #define IN6_ARE_ADDR_EQUAL IN6_IS_ADDR_EQUAL
371 #endif /* IN6_ARE_ADDR_EQUAL */
373 /* default zebra TCP port for zclient */
374 #define ZEBRA_PORT 2600
376 /* Marker value used in new Zserv, in the byte location corresponding
377 * the command value in the old zserv header. To allow old and new
378 * Zserv headers to be distinguished from each other.
380 #define ZEBRA_HEADER_MARKER 254
383 * The compiler.h header is used for anyone using the CPP_NOTICE
384 * since this is universally needed, let's add it to zebra.h
386 #include "compiler.h"
388 /* Zebra route's types are defined in route_types.h */
389 #include "route_types.h"
391 /* Note: whenever a new route-type or zserv-command is added the
392 * corresponding {command,route}_types[] table in lib/log.c MUST be
395 /* Map a route type to a string. For example, ZEBRA_ROUTE_RIPNG -> "ripng". */
396 extern const char *zebra_route_string(unsigned int route_type
);
397 /* Map a route type to a char. For example, ZEBRA_ROUTE_RIPNG -> 'R'. */
398 extern char zebra_route_char(unsigned int route_type
);
399 /* Map a zserv command type to the same string,
400 * e.g. ZEBRA_INTERFACE_ADD -> "ZEBRA_INTERFACE_ADD" */
401 /* Map a protocol name to its number. e.g. ZEBRA_ROUTE_BGP->9*/
402 extern int proto_name2num(const char *s
);
403 /* Map redistribute X argument to protocol number.
404 * unlike proto_name2num, this accepts shorthands and takes
405 * an AFI value to restrict input */
406 extern int proto_redistnum(int afi
, const char *s
);
408 extern const char *zserv_command_string(unsigned int command
);
410 #define strmatch(a,b) (!strcmp((a), (b)))
412 /* Zebra message flags */
415 * Cause Zebra to consider this routes nexthops recursively
417 #define ZEBRA_FLAG_ALLOW_RECURSION 0x01
419 * This is a route that is read in on startup that was left around
420 * from a previous run of FRR
422 #define ZEBRA_FLAG_SELFROUTE 0x02
424 * This flag is used to tell Zebra that the BGP route being passed
425 * down is a IBGP route
427 #define ZEBRA_FLAG_IBGP 0x04
429 * This is a route that has been selected for FIB installation.
430 * This flag is set in zebra and can be passed up to routing daemons
432 #define ZEBRA_FLAG_SELECTED 0x08
434 * This is a route that we are telling Zebra that this route *must*
435 * win and will be installed even over ZEBRA_FLAG_SELECTED
437 #define ZEBRA_FLAG_FIB_OVERRIDE 0x10
439 * This flag tells Zebra that the route is a EVPN route and should
440 * be treated specially
442 #define ZEBRA_FLAG_EVPN_ROUTE 0x20
444 * This flag tells Zebra that it should treat the distance passed
445 * down as an additional discriminator for route selection of the
446 * route entry. This mainly is used for backup static routes.
448 #define ZEBRA_FLAG_RR_USE_DISTANCE 0x40
450 * This flag tells Zebra that the passed down route is ONLINK and the
451 * kernel install flag for it should be turned on
453 #define ZEBRA_FLAG_ONLINK 0x80
455 /* Zebra FEC flags. */
456 #define ZEBRA_FEC_REGISTER_LABEL_INDEX 0x1
458 #ifndef INADDR_LOOPBACK
459 #define INADDR_LOOPBACK 0x7f000001 /* Internet address 127.0.0.1. */
462 /* Address family numbers from RFC1700. */
463 typedef enum { AFI_IP
= 1, AFI_IP6
= 2, AFI_L2VPN
= 3, AFI_MAX
= 4 } afi_t
;
465 /* Subsequent Address Family Identifier. */
472 SAFI_LABELED_UNICAST
= 6,
478 * The above AFI and SAFI definitions are for internal use. The protocol
479 * definitions (IANA values) as for example used in BGP protocol packets
480 * are defined below and these will get mapped to/from the internal values
481 * in the appropriate places.
482 * The rationale is that the protocol (IANA) values may be sparse and are
483 * not optimal for use in data-structure sizing.
484 * Note: Only useful (i.e., supported) values are defined below.
487 IANA_AFI_RESERVED
= 0,
496 IANA_SAFI_RESERVED
= 0,
497 IANA_SAFI_UNICAST
= 1,
498 IANA_SAFI_MULTICAST
= 2,
499 IANA_SAFI_LABELED_UNICAST
= 4,
502 IANA_SAFI_MPLS_VPN
= 128,
503 IANA_SAFI_FLOWSPEC
= 133
506 /* Default Administrative Distance of each protocol. */
507 #define ZEBRA_KERNEL_DISTANCE_DEFAULT 0
508 #define ZEBRA_CONNECT_DISTANCE_DEFAULT 0
509 #define ZEBRA_STATIC_DISTANCE_DEFAULT 1
510 #define ZEBRA_RIP_DISTANCE_DEFAULT 120
511 #define ZEBRA_RIPNG_DISTANCE_DEFAULT 120
512 #define ZEBRA_OSPF_DISTANCE_DEFAULT 110
513 #define ZEBRA_OSPF6_DISTANCE_DEFAULT 110
514 #define ZEBRA_ISIS_DISTANCE_DEFAULT 115
515 #define ZEBRA_IBGP_DISTANCE_DEFAULT 200
516 #define ZEBRA_EBGP_DISTANCE_DEFAULT 20
517 #define ZEBRA_TABLE_DISTANCE_DEFAULT 15
519 /* Flag manipulation macros. */
520 #define CHECK_FLAG(V,F) ((V) & (F))
521 #define SET_FLAG(V,F) (V) |= (F)
522 #define UNSET_FLAG(V,F) (V) &= ~(F)
523 #define RESET_FLAG(V) (V) = 0
524 #define COND_FLAG(V, F, C) ((C) ? (SET_FLAG(V, F)) : (UNSET_FLAG(V, F)))
526 /* Atomic flag manipulation macros. */
527 #define CHECK_FLAG_ATOMIC(PV, F) \
528 ((atomic_load_explicit(PV, memory_order_seq_cst)) & (F))
529 #define SET_FLAG_ATOMIC(PV, F) \
530 ((atomic_fetch_or_explicit(PV, (F), memory_order_seq_cst)))
531 #define UNSET_FLAG_ATOMIC(PV, F) \
532 ((atomic_fetch_and_explicit(PV, ~(F), memory_order_seq_cst)))
533 #define RESET_FLAG_ATOMIC(PV) \
534 ((atomic_store_explicit(PV, 0, memory_order_seq_cst)))
536 /* Zebra types. Used in Zserv message header. */
537 typedef uint16_t zebra_size_t
;
538 typedef uint16_t zebra_command_t
;
541 typedef uint32_t vrf_id_t
;
543 typedef uint32_t route_tag_t
;
544 #define ROUTE_TAG_MAX UINT32_MAX
545 #define ROUTE_TAG_PRI PRIu32
547 static inline afi_t
afi_iana2int(iana_afi_t afi
)
561 static inline iana_afi_t
afi_int2iana(afi_t afi
)
565 return IANA_AFI_IPV4
;
567 return IANA_AFI_IPV6
;
569 return IANA_AFI_L2VPN
;
571 return IANA_AFI_RESERVED
;
575 static inline safi_t
safi_iana2int(iana_safi_t safi
)
578 case IANA_SAFI_UNICAST
:
580 case IANA_SAFI_MULTICAST
:
581 return SAFI_MULTICAST
;
582 case IANA_SAFI_MPLS_VPN
:
583 return SAFI_MPLS_VPN
;
584 case IANA_SAFI_ENCAP
:
588 case IANA_SAFI_LABELED_UNICAST
:
589 return SAFI_LABELED_UNICAST
;
590 case IANA_SAFI_FLOWSPEC
:
591 return SAFI_FLOWSPEC
;
597 static inline iana_safi_t
safi_int2iana(safi_t safi
)
601 return IANA_SAFI_UNICAST
;
603 return IANA_SAFI_MULTICAST
;
605 return IANA_SAFI_MPLS_VPN
;
607 return IANA_SAFI_ENCAP
;
609 return IANA_SAFI_EVPN
;
610 case SAFI_LABELED_UNICAST
:
611 return IANA_SAFI_LABELED_UNICAST
;
613 return IANA_SAFI_FLOWSPEC
;
615 return IANA_SAFI_RESERVED
;
619 #endif /* _ZEBRA_H */