]> git.proxmox.com Git - mirror_frr.git/blob - lib/zebra.h
Merge pull request #4155 from pguibert6WIND/bfd_increase_config
[mirror_frr.git] / 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 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
19 */
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 #include "compiler.h"
29
30 #ifdef SUNOS_5
31 typedef unsigned int uint32_t;
32 typedef unsigned short uint16_t;
33 typedef unsigned char uint8_t;
34 #endif /* SUNOS_5 */
35
36 #include <unistd.h>
37 #include <stdio.h>
38 #include <stdlib.h>
39 #include <stddef.h>
40 #include <ctype.h>
41 #include <errno.h>
42 #include <fcntl.h>
43 #include <signal.h>
44 #include <string.h>
45 #include <pwd.h>
46 #include <grp.h>
47 #ifdef HAVE_STROPTS_H
48 #include <stropts.h>
49 #endif /* HAVE_STROPTS_H */
50 #include <sys/select.h>
51 #include <sys/stat.h>
52 #include <sys/types.h>
53 #include <sys/param.h>
54 #ifdef HAVE_SYS_SYSCTL_H
55 #ifdef GNU_LINUX
56 #include <linux/types.h>
57 #endif
58 #include <sys/sysctl.h>
59 #endif /* HAVE_SYS_SYSCTL_H */
60 #include <sys/ioctl.h>
61 #ifdef HAVE_SYS_CONF_H
62 #include <sys/conf.h>
63 #endif /* HAVE_SYS_CONF_H */
64 #ifdef HAVE_SYS_KSYM_H
65 #include <sys/ksym.h>
66 #endif /* HAVE_SYS_KSYM_H */
67 #include <syslog.h>
68 #include <sys/time.h>
69 #include <time.h>
70 #include <sys/uio.h>
71 #include <sys/utsname.h>
72 #include <sys/resource.h>
73 #include <limits.h>
74 #include <inttypes.h>
75 #include <stdbool.h>
76
77 /* machine dependent includes */
78 #ifdef SUNOS_5
79 #include <strings.h>
80 #endif /* SUNOS_5 */
81
82 /* machine dependent includes */
83 #ifdef HAVE_LINUX_VERSION_H
84 #include <linux/version.h>
85 #endif /* HAVE_LINUX_VERSION_H */
86
87 #ifdef HAVE_ASM_TYPES_H
88 #include <asm/types.h>
89 #endif /* HAVE_ASM_TYPES_H */
90
91 /* misc include group */
92 #include <stdarg.h>
93 #if !(defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)
94 /* Not C99; do we need to define va_copy? */
95 #ifndef va_copy
96 #ifdef __va_copy
97 #define va_copy(DST,SRC) __va_copy(DST,SRC)
98 #else
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 */
106 #endif /* !C99 */
107
108
109 #ifdef HAVE_LCAPS
110 #include <sys/capability.h>
111 #include <sys/prctl.h>
112 #endif /* HAVE_LCAPS */
113
114 #ifdef HAVE_SOLARIS_CAPABILITIES
115 #include <priv.h>
116 #endif /* HAVE_SOLARIS_CAPABILITIES */
117
118 /* network include group */
119
120 #include <sys/socket.h>
121
122 #ifdef HAVE_SYS_SOCKIO_H
123 #include <sys/sockio.h>
124 #endif /* HAVE_SYS_SOCKIO_H */
125
126 #ifdef __APPLE__
127 #define __APPLE_USE_RFC_3542
128 #endif
129
130 #ifndef HAVE_LIBCRYPT
131 #ifdef HAVE_LIBCRYPTO
132 #include <openssl/des.h>
133 # define crypt DES_crypt
134 #endif
135 #endif
136
137 #include "openbsd-tree.h"
138
139 #include <netinet/in.h>
140 #include <netinet/in_systm.h>
141 #include <netinet/ip.h>
142 #include <netinet/tcp.h>
143
144 #ifdef HAVE_NET_NETOPT_H
145 #include <net/netopt.h>
146 #endif /* HAVE_NET_NETOPT_H */
147
148 #include <net/if.h>
149
150 #ifdef HAVE_NET_IF_DL_H
151 #include <net/if_dl.h>
152 #endif /* HAVE_NET_IF_DL_H */
153
154 #ifdef HAVE_NET_IF_VAR_H
155 #include <net/if_var.h>
156 #endif /* HAVE_NET_IF_VAR_H */
157
158 #include <net/route.h>
159
160 #ifdef HAVE_NETLINK
161 #include <linux/netlink.h>
162 #include <linux/rtnetlink.h>
163 #include <linux/filter.h>
164 #else
165 #define RT_TABLE_MAIN 0
166 #endif /* HAVE_NETLINK */
167
168 #include <netdb.h>
169 #include <arpa/inet.h>
170
171 #ifdef HAVE_INET_ND_H
172 #include <inet/nd.h>
173 #endif /* HAVE_INET_ND_H */
174
175 #ifdef HAVE_NETINET_IN_VAR_H
176 #include <netinet/in_var.h>
177 #endif /* HAVE_NETINET_IN_VAR_H */
178
179 #ifdef HAVE_NETINET6_IN6_VAR_H
180 #include <netinet6/in6_var.h>
181 #endif /* HAVE_NETINET6_IN6_VAR_H */
182
183 #ifdef HAVE_NETINET_IN6_VAR_H
184 #include <netinet/in6_var.h>
185 #endif /* HAVE_NETINET_IN6_VAR_H */
186
187 #ifdef HAVE_NETINET6_IN_H
188 #include <netinet6/in.h>
189 #endif /* HAVE_NETINET6_IN_H */
190
191
192 #ifdef HAVE_NETINET6_IP6_H
193 #include <netinet6/ip6.h>
194 #endif /* HAVE_NETINET6_IP6_H */
195
196 #include <netinet/icmp6.h>
197
198 #ifdef HAVE_NETINET6_ND6_H
199 #include <netinet6/nd6.h>
200 #endif /* HAVE_NETINET6_ND6_H */
201
202 /* Some systems do not define UINT32_MAX, etc.. from inttypes.h
203 * e.g. this makes life easier for FBSD 4.11 users.
204 */
205 #ifndef INT8_MAX
206 #define INT8_MAX (127)
207 #endif
208 #ifndef INT16_MAX
209 #define INT16_MAX (32767)
210 #endif
211 #ifndef INT32_MAX
212 #define INT32_MAX (2147483647)
213 #endif
214 #ifndef UINT8_MAX
215 #define UINT8_MAX (255U)
216 #endif
217 #ifndef UINT16_MAX
218 #define UINT16_MAX (65535U)
219 #endif
220 #ifndef UINT32_MAX
221 #define UINT32_MAX (4294967295U)
222 #endif
223
224 #ifdef HAVE_GLIBC_BACKTRACE
225 #include <execinfo.h>
226 #endif /* HAVE_GLIBC_BACKTRACE */
227
228 /* Local includes: */
229 #if !(defined(__GNUC__) || defined(VTYSH_EXTRACT_PL))
230 #define __attribute__(x)
231 #endif /* !__GNUC__ || VTYSH_EXTRACT_PL */
232
233 #include "zassert.h"
234
235 /*
236 * Add explicit static cast only when using a C++ compiler.
237 */
238 #ifdef __cplusplus
239 #define static_cast(l, r) static_cast<decltype(l)>((r))
240 #else
241 #define static_cast(l, r) (r)
242 #endif
243
244 #ifndef HAVE_STRLCAT
245 size_t strlcat(char *__restrict dest,
246 const char *__restrict src, size_t destsize);
247 #endif
248 #ifndef HAVE_STRLCPY
249 size_t strlcpy(char *__restrict dest,
250 const char *__restrict src, size_t destsize);
251 #endif
252
253 /* GCC have printf type attribute check. */
254 #ifdef __GNUC__
255 #define PRINTF_ATTRIBUTE(a,b) __attribute__ ((__format__ (__printf__, a, b)))
256 #else
257 #define PRINTF_ATTRIBUTE(a,b)
258 #endif /* __GNUC__ */
259
260 /*
261 * RFC 3542 defines several macros for using struct cmsghdr.
262 * Here, we define those that are not present
263 */
264
265 /*
266 * Internal defines, for use only in this file.
267 * These are likely wrong on other than ILP32 machines, so warn.
268 */
269 #ifndef _CMSG_DATA_ALIGN
270 #define _CMSG_DATA_ALIGN(n) (((n) + 3) & ~3)
271 #endif /* _CMSG_DATA_ALIGN */
272
273 #ifndef _CMSG_HDR_ALIGN
274 #define _CMSG_HDR_ALIGN(n) (((n) + 3) & ~3)
275 #endif /* _CMSG_HDR_ALIGN */
276
277 /*
278 * CMSG_SPACE and CMSG_LEN are required in RFC3542, but were new in that
279 * version.
280 */
281 #ifndef CMSG_SPACE
282 #define CMSG_SPACE(l) \
283 (_CMSG_DATA_ALIGN(sizeof(struct cmsghdr)) + _CMSG_HDR_ALIGN(l))
284 #warning "assuming 4-byte alignment for CMSG_SPACE"
285 #endif /* CMSG_SPACE */
286
287
288 #ifndef CMSG_LEN
289 #define CMSG_LEN(l) (_CMSG_DATA_ALIGN(sizeof(struct cmsghdr)) + (l))
290 #warning "assuming 4-byte alignment for CMSG_LEN"
291 #endif /* CMSG_LEN */
292
293
294 /* The definition of struct in_pktinfo is missing in old version of
295 GLIBC 2.1 (Redhat 6.1). */
296 #if defined(GNU_LINUX) && !defined(HAVE_STRUCT_IN_PKTINFO)
297 struct in_pktinfo {
298 int ipi_ifindex;
299 struct in_addr ipi_spec_dst;
300 struct in_addr ipi_addr;
301 };
302 #endif
303
304 /*
305 * IP_HDRINCL / struct ip byte order
306 *
307 * Linux: network byte order
308 * *BSD: network, except for length and offset. (cf Stevens)
309 * SunOS: nominally as per BSD. but bug: network order on LE.
310 * OpenBSD: network byte order, apart from older versions which are as per
311 * *BSD
312 */
313 #if defined(__NetBSD__) \
314 || (defined(__FreeBSD__) && (__FreeBSD_version < 1100030)) \
315 || (defined(__OpenBSD__) && (OpenBSD < 200311)) \
316 || (defined(__APPLE__)) \
317 || (defined(SUNOS_5) && defined(WORDS_BIGENDIAN))
318 #define HAVE_IP_HDRINCL_BSD_ORDER
319 #endif
320
321 /* Define BYTE_ORDER, if not defined. Useful for compiler conditional
322 * code, rather than preprocessor conditional.
323 * Not all the world has this BSD define.
324 */
325 #ifndef BYTE_ORDER
326 #define BIG_ENDIAN 4321 /* least-significant byte first (vax, pc) */
327 #define LITTLE_ENDIAN 1234 /* most-significant byte first (IBM, net) */
328 #define PDP_ENDIAN 3412 /* LSB first in word, MSW first in long (pdp) */
329
330 #if defined(WORDS_BIGENDIAN)
331 #define BYTE_ORDER BIG_ENDIAN
332 #else /* !WORDS_BIGENDIAN */
333 #define BYTE_ORDER LITTLE_ENDIAN
334 #endif /* WORDS_BIGENDIAN */
335
336 #endif /* ndef BYTE_ORDER */
337
338 /* MAX / MIN are not commonly defined, but useful */
339 /* note: glibc sys/param.h has #define MIN(a,b) (((a)<(b))?(a):(b)) */
340 #ifdef MAX
341 #undef MAX
342 #endif
343 #define MAX(a, b) \
344 ({ \
345 typeof(a) _max_a = (a); \
346 typeof(b) _max_b = (b); \
347 _max_a > _max_b ? _max_a : _max_b; \
348 })
349 #ifdef MIN
350 #undef MIN
351 #endif
352 #define MIN(a, b) \
353 ({ \
354 typeof(a) _min_a = (a); \
355 typeof(b) _min_b = (b); \
356 _min_a < _min_b ? _min_a : _min_b; \
357 })
358
359 #ifndef offsetof
360 #ifdef __compiler_offsetof
361 #define offsetof(TYPE,MEMBER) __compiler_offsetof(TYPE,MEMBER)
362 #else
363 #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
364 #endif
365 #endif
366
367 #ifndef container_of
368 #define container_of(ptr, type, member) \
369 ({ \
370 const typeof(((type *)0)->member) *__mptr = (ptr); \
371 (type *)((char *)__mptr - offsetof(type, member)); \
372 })
373 #endif
374
375 #define ZEBRA_NUM_OF(x) (sizeof (x) / sizeof (x[0]))
376
377 /* For old definition. */
378 #ifndef IN6_ARE_ADDR_EQUAL
379 #define IN6_ARE_ADDR_EQUAL IN6_IS_ADDR_EQUAL
380 #endif /* IN6_ARE_ADDR_EQUAL */
381
382 /* default zebra TCP port for zclient */
383 #define ZEBRA_PORT 2600
384
385 /* Marker value used in new Zserv, in the byte location corresponding
386 * the command value in the old zserv header. To allow old and new
387 * Zserv headers to be distinguished from each other.
388 */
389 #define ZEBRA_HEADER_MARKER 254
390
391 /*
392 * The compiler.h header is used for anyone using the CPP_NOTICE
393 * since this is universally needed, let's add it to zebra.h
394 */
395 #include "compiler.h"
396
397 /* Zebra route's types are defined in route_types.h */
398 #include "route_types.h"
399
400 /* Note: whenever a new route-type or zserv-command is added the
401 * corresponding {command,route}_types[] table in lib/log.c MUST be
402 * updated! */
403
404 /* Map a route type to a string. For example, ZEBRA_ROUTE_RIPNG -> "ripng". */
405 extern const char *zebra_route_string(unsigned int route_type);
406 /* Map a route type to a char. For example, ZEBRA_ROUTE_RIPNG -> 'R'. */
407 extern char zebra_route_char(unsigned int route_type);
408 /* Map a zserv command type to the same string,
409 * e.g. ZEBRA_INTERFACE_ADD -> "ZEBRA_INTERFACE_ADD" */
410 /* Map a protocol name to its number. e.g. ZEBRA_ROUTE_BGP->9*/
411 extern int proto_name2num(const char *s);
412 /* Map redistribute X argument to protocol number.
413 * unlike proto_name2num, this accepts shorthands and takes
414 * an AFI value to restrict input */
415 extern int proto_redistnum(int afi, const char *s);
416
417 extern const char *zserv_command_string(unsigned int command);
418
419 #define strmatch(a,b) (!strcmp((a), (b)))
420
421 /* Zebra message flags */
422
423 /*
424 * Cause Zebra to consider this routes nexthops recursively
425 */
426 #define ZEBRA_FLAG_ALLOW_RECURSION 0x01
427 /*
428 * This is a route that is read in on startup that was left around
429 * from a previous run of FRR
430 */
431 #define ZEBRA_FLAG_SELFROUTE 0x02
432 /*
433 * This flag is used to tell Zebra that the BGP route being passed
434 * down is a IBGP route
435 */
436 #define ZEBRA_FLAG_IBGP 0x04
437 /*
438 * This is a route that has been selected for FIB installation.
439 * This flag is set in zebra and can be passed up to routing daemons
440 */
441 #define ZEBRA_FLAG_SELECTED 0x08
442 /*
443 * This is a route that we are telling Zebra that this route *must*
444 * win and will be installed even over ZEBRA_FLAG_SELECTED
445 */
446 #define ZEBRA_FLAG_FIB_OVERRIDE 0x10
447 /*
448 * This flag tells Zebra that the route is a EVPN route and should
449 * be treated specially
450 */
451 #define ZEBRA_FLAG_EVPN_ROUTE 0x20
452 /*
453 * This flag tells Zebra that it should treat the distance passed
454 * down as an additional discriminator for route selection of the
455 * route entry. This mainly is used for backup static routes.
456 */
457 #define ZEBRA_FLAG_RR_USE_DISTANCE 0x40
458
459 #ifndef INADDR_LOOPBACK
460 #define INADDR_LOOPBACK 0x7f000001 /* Internet address 127.0.0.1. */
461 #endif
462
463 /* Address family numbers from RFC1700. */
464 typedef enum { AFI_IP = 1, AFI_IP6 = 2, AFI_L2VPN = 3, AFI_MAX = 4 } afi_t;
465
466 /* Subsequent Address Family Identifier. */
467 typedef enum {
468 SAFI_UNICAST = 1,
469 SAFI_MULTICAST = 2,
470 SAFI_MPLS_VPN = 3,
471 SAFI_ENCAP = 4,
472 SAFI_EVPN = 5,
473 SAFI_LABELED_UNICAST = 6,
474 SAFI_FLOWSPEC = 7,
475 SAFI_MAX = 8
476 } safi_t;
477
478 /*
479 * The above AFI and SAFI definitions are for internal use. The protocol
480 * definitions (IANA values) as for example used in BGP protocol packets
481 * are defined below and these will get mapped to/from the internal values
482 * in the appropriate places.
483 * The rationale is that the protocol (IANA) values may be sparse and are
484 * not optimal for use in data-structure sizing.
485 * Note: Only useful (i.e., supported) values are defined below.
486 */
487 typedef enum {
488 IANA_AFI_RESERVED = 0,
489 IANA_AFI_IPV4 = 1,
490 IANA_AFI_IPV6 = 2,
491 IANA_AFI_L2VPN = 25,
492 IANA_AFI_IPMR = 128,
493 IANA_AFI_IP6MR = 129
494 } iana_afi_t;
495
496 typedef enum {
497 IANA_SAFI_RESERVED = 0,
498 IANA_SAFI_UNICAST = 1,
499 IANA_SAFI_MULTICAST = 2,
500 IANA_SAFI_LABELED_UNICAST = 4,
501 IANA_SAFI_ENCAP = 7,
502 IANA_SAFI_EVPN = 70,
503 IANA_SAFI_MPLS_VPN = 128,
504 IANA_SAFI_FLOWSPEC = 133
505 } iana_safi_t;
506
507 /* Default Administrative Distance of each protocol. */
508 #define ZEBRA_KERNEL_DISTANCE_DEFAULT 0
509 #define ZEBRA_CONNECT_DISTANCE_DEFAULT 0
510 #define ZEBRA_STATIC_DISTANCE_DEFAULT 1
511 #define ZEBRA_RIP_DISTANCE_DEFAULT 120
512 #define ZEBRA_RIPNG_DISTANCE_DEFAULT 120
513 #define ZEBRA_OSPF_DISTANCE_DEFAULT 110
514 #define ZEBRA_OSPF6_DISTANCE_DEFAULT 110
515 #define ZEBRA_ISIS_DISTANCE_DEFAULT 115
516 #define ZEBRA_IBGP_DISTANCE_DEFAULT 200
517 #define ZEBRA_EBGP_DISTANCE_DEFAULT 20
518 #define ZEBRA_TABLE_DISTANCE_DEFAULT 15
519
520 /* Flag manipulation macros. */
521 #define CHECK_FLAG(V,F) ((V) & (F))
522 #define SET_FLAG(V,F) (V) |= (F)
523 #define UNSET_FLAG(V,F) (V) &= ~(F)
524 #define RESET_FLAG(V) (V) = 0
525 #define COND_FLAG(V, F, C) ((C) ? (SET_FLAG(V, F)) : (UNSET_FLAG(V, F)))
526
527 /* Atomic flag manipulation macros. */
528 #define CHECK_FLAG_ATOMIC(PV, F) \
529 ((atomic_load_explicit(PV, memory_order_seq_cst)) & (F))
530 #define SET_FLAG_ATOMIC(PV, F) \
531 ((atomic_fetch_or_explicit(PV, (F), memory_order_seq_cst)))
532 #define UNSET_FLAG_ATOMIC(PV, F) \
533 ((atomic_fetch_and_explicit(PV, ~(F), memory_order_seq_cst)))
534 #define RESET_FLAG_ATOMIC(PV) \
535 ((atomic_store_explicit(PV, 0, memory_order_seq_cst)))
536
537 /* Zebra types. Used in Zserv message header. */
538 typedef uint16_t zebra_size_t;
539 typedef uint16_t zebra_command_t;
540
541 /* VRF ID type. */
542 typedef uint32_t vrf_id_t;
543
544 typedef uint32_t route_tag_t;
545 #define ROUTE_TAG_MAX UINT32_MAX
546 #define ROUTE_TAG_PRI PRIu32
547
548 static inline afi_t afi_iana2int(iana_afi_t afi)
549 {
550 switch (afi) {
551 case IANA_AFI_IPV4:
552 return AFI_IP;
553 case IANA_AFI_IPV6:
554 return AFI_IP6;
555 case IANA_AFI_L2VPN:
556 return AFI_L2VPN;
557 default:
558 return AFI_MAX;
559 }
560 }
561
562 static inline iana_afi_t afi_int2iana(afi_t afi)
563 {
564 switch (afi) {
565 case AFI_IP:
566 return IANA_AFI_IPV4;
567 case AFI_IP6:
568 return IANA_AFI_IPV6;
569 case AFI_L2VPN:
570 return IANA_AFI_L2VPN;
571 default:
572 return IANA_AFI_RESERVED;
573 }
574 }
575
576 static inline safi_t safi_iana2int(iana_safi_t safi)
577 {
578 switch (safi) {
579 case IANA_SAFI_UNICAST:
580 return SAFI_UNICAST;
581 case IANA_SAFI_MULTICAST:
582 return SAFI_MULTICAST;
583 case IANA_SAFI_MPLS_VPN:
584 return SAFI_MPLS_VPN;
585 case IANA_SAFI_ENCAP:
586 return SAFI_ENCAP;
587 case IANA_SAFI_EVPN:
588 return SAFI_EVPN;
589 case IANA_SAFI_LABELED_UNICAST:
590 return SAFI_LABELED_UNICAST;
591 case IANA_SAFI_FLOWSPEC:
592 return SAFI_FLOWSPEC;
593 default:
594 return SAFI_MAX;
595 }
596 }
597
598 static inline iana_safi_t safi_int2iana(safi_t safi)
599 {
600 switch (safi) {
601 case SAFI_UNICAST:
602 return IANA_SAFI_UNICAST;
603 case SAFI_MULTICAST:
604 return IANA_SAFI_MULTICAST;
605 case SAFI_MPLS_VPN:
606 return IANA_SAFI_MPLS_VPN;
607 case SAFI_ENCAP:
608 return IANA_SAFI_ENCAP;
609 case SAFI_EVPN:
610 return IANA_SAFI_EVPN;
611 case SAFI_LABELED_UNICAST:
612 return IANA_SAFI_LABELED_UNICAST;
613 case SAFI_FLOWSPEC:
614 return IANA_SAFI_FLOWSPEC;
615 default:
616 return IANA_SAFI_RESERVED;
617 }
618 }
619
620 #endif /* _ZEBRA_H */