* applied patches from the most recent FreiFunkFirmware (and fixed compile errors...
[olsrd.git] / lib / quagga / src / quagga / 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 #if !(defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)
99 /* Not C99; do we need to define va_copy? */
100 #ifndef va_copy
101 #ifdef __va_copy
102 #define va_copy(DST,SRC) __va_copy(DST,SRC)
103 #else
104 /* Now we are desperate; this should work on many typical platforms. 
105    But this is slightly dangerous, because the standard does not require
106    va_copy to be a macro. */
107 #define va_copy(DST,SRC) memcpy(&(DST), &(SRC), sizeof(va_list))
108 #warning "Not C99 and no va_copy macro available, falling back to memcpy"
109 #endif /* __va_copy */
110 #endif /* !va_copy */
111 #endif /* !C99 */
112
113
114 #ifdef HAVE_LCAPS
115 #include <sys/capability.h>
116 #include <sys/prctl.h>
117 #endif /* HAVE_LCAPS */
118
119 /* network include group */
120
121 #include <sys/socket.h>
122
123 #ifdef HAVE_SYS_SOCKIO_H
124 #include <sys/sockio.h>
125 #endif /* HAVE_SYS_SOCKIO_H */
126
127 #ifdef HAVE_NETINET_IN_H
128 #include <netinet/in.h>
129 #endif /* HAVE_NETINET_IN_H */
130 #include <netinet/in_systm.h>
131 #include <netinet/ip.h>
132 #include <netinet/tcp.h>
133
134 #ifdef HAVE_NET_NETOPT_H
135 #include <net/netopt.h>
136 #endif /* HAVE_NET_NETOPT_H */
137
138 #include <net/if.h>
139
140 #ifdef HAVE_NET_IF_DL_H
141 #include <net/if_dl.h>
142 #endif /* HAVE_NET_IF_DL_H */
143
144 #ifdef HAVE_NET_IF_VAR_H
145 #include <net/if_var.h>
146 #endif /* HAVE_NET_IF_VAR_H */
147
148 #ifdef HAVE_NET_ROUTE_H
149 #include <net/route.h>
150 #endif /* HAVE_NET_ROUTE_H */
151
152 #ifdef HAVE_NETLINK
153 #include <linux/netlink.h>
154 #include <linux/rtnetlink.h>
155 #else
156 #define RT_TABLE_MAIN           0
157 #endif /* HAVE_NETLINK */
158
159 #ifdef HAVE_NETDB_H
160 #include <netdb.h>
161 #endif /* HAVE_NETDB_H */
162
163 #include <arpa/inet.h>
164 #include <arpa/telnet.h>
165
166 #ifdef HAVE_INET_ND_H
167 #include <inet/nd.h>
168 #endif /* HAVE_INET_ND_H */
169
170 #ifdef HAVE_NETINET_IN_VAR_H
171 #include <netinet/in_var.h>
172 #endif /* HAVE_NETINET_IN_VAR_H */
173
174 #ifdef HAVE_NETINET6_IN6_VAR_H
175 #include <netinet6/in6_var.h>
176 #endif /* HAVE_NETINET6_IN6_VAR_H */
177
178 #ifdef HAVE_NETINET_IN6_VAR_H
179 #include <netinet/in6_var.h>
180 #endif /* HAVE_NETINET_IN6_VAR_H */
181
182 #ifdef HAVE_NETINET6_IN_H
183 #include <netinet6/in.h>
184 #endif /* HAVE_NETINET6_IN_H */
185
186
187 #ifdef HAVE_NETINET6_IP6_H
188 #include <netinet6/ip6.h>
189 #endif /* HAVE_NETINET6_IP6_H */
190
191 #ifdef HAVE_NETINET_ICMP6_H
192 #include <netinet/icmp6.h>
193 #endif /* HAVE_NETINET_ICMP6_H */
194
195 #ifdef HAVE_NETINET6_ND6_H
196 #include <netinet6/nd6.h>
197 #endif /* HAVE_NETINET6_ND6_H */
198
199 /* Some systems do not define UINT32_MAX */
200 #ifndef UINT32_MAX
201 #define UINT32_MAX 0xFFFFFFFFU
202 #endif /* UINT32_MAX */
203
204 #ifdef HAVE_LIBUTIL_H
205 #include <libutil.h>
206 #endif /* HAVE_LIBUTIL_H */
207
208 #ifdef HAVE_GLIBC_BACKTRACE
209 #include <execinfo.h>
210 #endif /* HAVE_GLIBC_BACKTRACE */
211
212 #ifdef BSDI_NRL
213
214 #ifdef HAVE_NETINET6_IN6_H
215 #include <netinet6/in6.h>
216 #endif /* HAVE_NETINET6_IN6_H */
217
218 #ifdef NRL
219 #include <netinet6/in6.h>
220 #endif /* NRL */
221
222 #define IN6_ARE_ADDR_EQUAL IN6_IS_ADDR_EQUAL
223
224 #endif /* BSDI_NRL */
225
226 /* Local includes: */
227 #if !(defined(__GNUC__) || defined(VTYSH_EXTRACT_PL)) 
228 #define __attribute__(x)
229 #endif  /* !__GNUC__ || VTYSH_EXTRACT_PL */
230
231 #include "zassert.h"
232
233
234 #ifdef HAVE_BROKEN_CMSG_FIRSTHDR
235 /* This bug is present in Solaris 8 and pre-patch Solaris 9 <sys/socket.h>;
236    please refer to http://bugzilla.quagga.net/show_bug.cgi?id=142 */
237
238 /* Check that msg_controllen is large enough. */
239 #define ZCMSG_FIRSTHDR(mhdr) \
240   (((size_t)((mhdr)->msg_controllen) >= sizeof(struct cmsghdr)) ? \
241    CMSG_FIRSTHDR(mhdr) : (struct cmsghdr *)NULL)
242
243 #warning "CMSG_FIRSTHDR is broken on this platform, using a workaround"
244
245 #else /* HAVE_BROKEN_CMSG_FIRSTHDR */
246 #define ZCMSG_FIRSTHDR(M) CMSG_FIRSTHDR(M)
247 #endif /* HAVE_BROKEN_CMSG_FIRSTHDR */
248
249
250
251 /* 
252  * RFC 3542 defines several macros for using struct cmsghdr.
253  * Here, we define those that are not present
254  */
255
256 /*
257  * Internal defines, for use only in this file.
258  * These are likely wrong on other than ILP32 machines, so warn.
259  */
260 #ifndef _CMSG_DATA_ALIGN
261 #define _CMSG_DATA_ALIGN(n)           (((n) + 3) & ~3)
262 #endif /* _CMSG_DATA_ALIGN */
263
264 #ifndef _CMSG_HDR_ALIGN
265 #define _CMSG_HDR_ALIGN(n)            (((n) + 3) & ~3)
266 #endif /* _CMSG_HDR_ALIGN */
267
268 /*
269  * CMSG_SPACE and CMSG_LEN are required in RFC3542, but were new in that
270  * version.
271  */
272 #ifndef CMSG_SPACE
273 #define CMSG_SPACE(l)       (_CMSG_DATA_ALIGN(sizeof(struct cmsghdr)) + \
274                               _CMSG_HDR_ALIGN(l))
275 #warning "assuming 4-byte alignment for CMSG_SPACE"
276 #endif  /* CMSG_SPACE */
277
278
279 #ifndef CMSG_LEN
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 */
283
284
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_INPKTINFO)
288 struct in_pktinfo
289 {
290   int ipi_ifindex;
291   struct in_addr ipi_spec_dst;
292   struct in_addr ipi_addr;
293 };
294 #endif
295
296 /* 
297  * OSPF Fragmentation / fragmented writes
298  *
299  * ospfd can support writing fragmented packets, for cases where
300  * kernel will not fragment IP_HDRINCL and/or multicast destined
301  * packets (ie TTBOMK all kernels, BSD, SunOS, Linux). However,
302  * SunOS, probably BSD too, clobber the user supplied IP ID and IP
303  * flags fields, hence user-space fragmentation will not work.
304  * Only Linux is known to leave IP header unmolested.
305  * Further, fragmentation really should be done the kernel, which already
306  * supports it, and which avoids nasty IP ID state problems.
307  *
308  * Fragmentation of OSPF packets can be required on networks with router
309  * with many many interfaces active in one area, or on networks with links
310  * with low MTUs.
311  */
312 #ifdef GNU_LINUX
313 #define WANT_OSPF_WRITE_FRAGMENT
314 #endif
315
316 /* 
317  * IP_HDRINCL / struct ip byte order
318  *
319  * Linux: network byte order
320  * *BSD: network, except for length and offset. (cf Stevens)
321  * SunOS: nominally as per BSD. but bug: network order on LE.
322  * OpenBSD: network byte order, apart from older versions which are as per 
323  *          *BSD
324  */
325 #if defined(__NetBSD__) || defined(__FreeBSD__) \
326    || (defined(__OpenBSD__) && (OpenBSD < 200311)) \
327    || (defined(SUNOS_5) && defined(WORDS_BIGENDIAN))
328 #define HAVE_IP_HDRINCL_BSD_ORDER
329 #endif
330
331 /* MAX / MIN are not commonly defined, but useful */
332 #ifndef MAX
333 #define MAX(a, b) ((a) > (b) ? (a) : (b))
334 #endif 
335 #ifndef MIN
336 #define MIN(a, b) ((a) < (b) ? (a) : (b))
337 #endif
338
339 /* For old definition. */
340 #ifndef IN6_ARE_ADDR_EQUAL
341 #define IN6_ARE_ADDR_EQUAL IN6_IS_ADDR_EQUAL
342 #endif /* IN6_ARE_ADDR_EQUAL */
343
344 /* Zebra message types. */
345 #define ZEBRA_INTERFACE_ADD                1
346 #define ZEBRA_INTERFACE_DELETE             2
347 #define ZEBRA_INTERFACE_ADDRESS_ADD        3
348 #define ZEBRA_INTERFACE_ADDRESS_DELETE     4
349 #define ZEBRA_INTERFACE_UP                 5
350 #define ZEBRA_INTERFACE_DOWN               6
351 #define ZEBRA_IPV4_ROUTE_ADD               7
352 #define ZEBRA_IPV4_ROUTE_DELETE            8
353 #define ZEBRA_IPV6_ROUTE_ADD               9
354 #define ZEBRA_IPV6_ROUTE_DELETE           10
355 #define ZEBRA_REDISTRIBUTE_ADD            11
356 #define ZEBRA_REDISTRIBUTE_DELETE         12
357 #define ZEBRA_REDISTRIBUTE_DEFAULT_ADD    13
358 #define ZEBRA_REDISTRIBUTE_DEFAULT_DELETE 14
359 #define ZEBRA_IPV4_NEXTHOP_LOOKUP         15
360 #define ZEBRA_IPV6_NEXTHOP_LOOKUP         16
361 #define ZEBRA_IPV4_IMPORT_LOOKUP          17
362 #define ZEBRA_IPV6_IMPORT_LOOKUP          18
363 #define ZEBRA_INTERFACE_RENAME            19
364 #define ZEBRA_ROUTER_ID_ADD               20
365 #define ZEBRA_ROUTER_ID_DELETE            21
366 #define ZEBRA_ROUTER_ID_UPDATE            22
367 #define ZEBRA_MESSAGE_MAX                 23
368
369 /* Zebra route's types. */
370 #define ZEBRA_ROUTE_SYSTEM               0
371 #define ZEBRA_ROUTE_KERNEL               1
372 #define ZEBRA_ROUTE_CONNECT              2
373 #define ZEBRA_ROUTE_STATIC               3
374 #define ZEBRA_ROUTE_RIP                  4
375 #define ZEBRA_ROUTE_RIPNG                5
376 #define ZEBRA_ROUTE_OSPF                 6
377 #define ZEBRA_ROUTE_OSPF6                7
378 #define ZEBRA_ROUTE_ISIS                 8
379 #define ZEBRA_ROUTE_BGP                  9
380 #define ZEBRA_ROUTE_HSLS                 10
381 #define ZEBRA_ROUTE_OLSR                 11
382 #define ZEBRA_ROUTE_MAX                  12
383
384 /* Zebra's family types. */
385 #define ZEBRA_FAMILY_IPV4                1
386 #define ZEBRA_FAMILY_IPV6                2
387 #define ZEBRA_FAMILY_MAX                 3
388
389 /* Error codes of zebra. */
390 #define ZEBRA_ERR_RTEXIST               -1
391 #define ZEBRA_ERR_RTUNREACH             -2
392 #define ZEBRA_ERR_EPERM                 -3
393 #define ZEBRA_ERR_RTNOEXIST             -4
394
395 /* Zebra message flags */
396 #define ZEBRA_FLAG_INTERNAL           0x01
397 #define ZEBRA_FLAG_SELFROUTE          0x02
398 #define ZEBRA_FLAG_BLACKHOLE          0x04
399 #define ZEBRA_FLAG_IBGP               0x08
400 #define ZEBRA_FLAG_SELECTED           0x10
401 #define ZEBRA_FLAG_CHANGED            0x20
402 #define ZEBRA_FLAG_STATIC             0x40
403 #define ZEBRA_FLAG_REJECT             0x80
404
405 /* Zebra nexthop flags. */
406 #define ZEBRA_NEXTHOP_IFINDEX            1
407 #define ZEBRA_NEXTHOP_IFNAME             2
408 #define ZEBRA_NEXTHOP_IPV4               3
409 #define ZEBRA_NEXTHOP_IPV4_IFINDEX       4
410 #define ZEBRA_NEXTHOP_IPV4_IFNAME        5
411 #define ZEBRA_NEXTHOP_IPV6               6
412 #define ZEBRA_NEXTHOP_IPV6_IFINDEX       7
413 #define ZEBRA_NEXTHOP_IPV6_IFNAME        8
414 #define ZEBRA_NEXTHOP_BLACKHOLE          9
415
416 #ifndef INADDR_LOOPBACK
417 #define INADDR_LOOPBACK 0x7f000001      /* Internet address 127.0.0.1.  */
418 #endif
419
420 /* Address family numbers from RFC1700. */
421 #define AFI_IP                    1
422 #define AFI_IP6                   2
423 #define AFI_MAX                   3
424
425 /* Subsequent Address Family Identifier. */
426 #define SAFI_UNICAST              1
427 #define SAFI_MULTICAST            2
428 #define SAFI_UNICAST_MULTICAST    3
429 #define SAFI_MPLS_VPN             4
430 #define SAFI_MAX                  5
431
432 /* Filter direction.  */
433 #define FILTER_IN                 0
434 #define FILTER_OUT                1
435 #define FILTER_MAX                2
436
437 /* Default Administrative Distance of each protocol. */
438 #define ZEBRA_KERNEL_DISTANCE_DEFAULT      0
439 #define ZEBRA_CONNECT_DISTANCE_DEFAULT     0
440 #define ZEBRA_STATIC_DISTANCE_DEFAULT      1
441 #define ZEBRA_RIP_DISTANCE_DEFAULT       120
442 #define ZEBRA_RIPNG_DISTANCE_DEFAULT     120
443 #define ZEBRA_OSPF_DISTANCE_DEFAULT      110
444 #define ZEBRA_OSPF6_DISTANCE_DEFAULT     110
445 #define ZEBRA_ISIS_DISTANCE_DEFAULT      115
446 #define ZEBRA_IBGP_DISTANCE_DEFAULT      200
447 #define ZEBRA_EBGP_DISTANCE_DEFAULT       20
448
449 /* Flag manipulation macros. */
450 #define CHECK_FLAG(V,F)      ((V) & (F))
451 #define SET_FLAG(V,F)        (V) = (V) | (F)
452 #define UNSET_FLAG(V,F)      (V) = (V) & ~(F)
453
454 /* AFI and SAFI type. */
455 typedef u_int16_t afi_t;
456 typedef u_int8_t safi_t;
457
458 /* Zebra types. */
459 typedef u_int16_t zebra_size_t;
460 typedef u_int8_t zebra_command_t;
461
462 /* FIFO -- first in first out structure and macros.  */
463 struct fifo
464 {
465   struct fifo *next;
466   struct fifo *prev;
467 };
468
469 #define FIFO_INIT(F)                                  \
470   do {                                                \
471     struct fifo *Xfifo = (struct fifo *)(F);          \
472     Xfifo->next = Xfifo->prev = Xfifo;                \
473   } while (0)
474
475 #define FIFO_ADD(F,N)                                 \
476   do {                                                \
477     struct fifo *Xfifo = (struct fifo *)(F);          \
478     struct fifo *Xnode = (struct fifo *)(N);          \
479     Xnode->next = Xfifo;                              \
480     Xnode->prev = Xfifo->prev;                        \
481     Xfifo->prev = Xfifo->prev->next = Xnode;          \
482   } while (0)
483
484 #define FIFO_DEL(N)                                   \
485   do {                                                \
486     struct fifo *Xnode = (struct fifo *)(N);          \
487     Xnode->prev->next = Xnode->next;                  \
488     Xnode->next->prev = Xnode->prev;                  \
489   } while (0)
490
491 #define FIFO_HEAD(F)                                  \
492   ((((struct fifo *)(F))->next == (struct fifo *)(F)) \
493   ? NULL : (F)->next)
494
495 #define FIFO_EMPTY(F)                                 \
496   (((struct fifo *)(F))->next == (struct fifo *)(F))
497
498 #define FIFO_TOP(F)                                   \
499   (FIFO_EMPTY(F) ? NULL : ((struct fifo *)(F))->next)
500
501 #endif /* _ZEBRA_H */