af33c6ee2cb9d8d78ddc283426bee428246053e3
[olsrd.git] / lib / quagga / src / quagga / zebra.h
1
2 /* Zebra common header.
3    Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002 Kunihiro Ishiguro
4
5 This file is part of GNU Zebra.
6
7 GNU Zebra is free software; you can redistribute it and/or modify it
8 under the terms of the GNU General Public License as published by the
9 Free Software Foundation; either version 2, or (at your option) any
10 later version.
11
12 GNU Zebra is distributed in the hope that it will be useful, but
13 WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15 General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with GNU Zebra; see the file COPYING.  If not, write to the Free
19 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
20 02111-1307, USA.  */
21
22 #ifndef _ZEBRA_H
23 #define _ZEBRA_H
24
25 #ifdef HAVE_CONFIG_H
26 #include "config.h"
27 #endif /* HAVE_CONFIG_H */
28
29 #ifdef SUNOS_5
30 #define _XPG4_2
31 #define __EXTENSIONS__
32 typedef unsigned int u_int32_t;
33 typedef unsigned short u_int16_t;
34 typedef unsigned char u_int8_t;
35 #endif /* SUNOS_5 */
36
37 #ifndef HAVE_SOCKLEN_T
38 typedef int socklen_t;
39 #endif /* HAVE_SOCKLEN_T */
40
41 #include <unistd.h>
42 #include <stdio.h>
43 #include <stdlib.h>
44 #include <ctype.h>
45 #include <errno.h>
46 #include <fcntl.h>
47 #include <signal.h>
48 #include <string.h>
49 #include <pwd.h>
50 #include <grp.h>
51 #ifdef HAVE_STROPTS_H
52 #include <stropts.h>
53 #endif /* HAVE_STROPTS_H */
54 #include <sys/fcntl.h>
55 #ifdef HAVE_SYS_SELECT_H
56 #include <sys/select.h>
57 #endif /* HAVE_SYS_SELECT_H */
58 #include <sys/stat.h>
59 #include <sys/time.h>
60 #include <sys/types.h>
61 #include <sys/param.h>
62 #ifdef HAVE_SYS_SYSCTL_H
63 #include <sys/sysctl.h>
64 #endif /* HAVE_SYS_SYSCTL_H */
65 #include <sys/ioctl.h>
66 #ifdef HAVE_SYS_CONF_H
67 #include <sys/conf.h>
68 #endif /* HAVE_SYS_CONF_H */
69 #ifdef HAVE_SYS_KSYM_H
70 #include <sys/ksym.h>
71 #endif /* HAVE_SYS_KSYM_H */
72 #include <syslog.h>
73 #include <time.h>
74 #include <sys/uio.h>
75 #include <sys/utsname.h>
76 #ifdef HAVE_RUSAGE
77 #include <sys/resource.h>
78 #endif /* HAVE_RUSAGE */
79 #ifdef HAVE_LIMITS_H
80 #include <limits.h>
81 #endif /* HAVE_LIMITS_H */
82
83 /* machine dependent includes */
84 #ifdef SUNOS_5
85 #include <strings.h>
86 #endif /* SUNOS_5 */
87
88 /* machine dependent includes */
89 #ifdef HAVE_LINUX_VERSION_H
90 #include <linux/version.h>
91 #endif /* HAVE_LINUX_VERSION_H */
92
93 #ifdef HAVE_ASM_TYPES_H
94 #include <asm/types.h>
95 #endif /* HAVE_ASM_TYPES_H */
96
97 /* misc include group */
98 #include <stdarg.h>
99 #if !(defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)
100
101 /* Not C99; do we need to define va_copy? */
102 #ifndef va_copy
103 #ifdef __va_copy
104 #define va_copy(DST,SRC) __va_copy(DST,SRC)
105 #else
106
107 /* Now we are desperate; this should work on many typical platforms.
108    But this is slightly dangerous, because the standard does not require
109    va_copy to be a macro. */
110 #define va_copy(DST,SRC) memcpy(&(DST), &(SRC), sizeof(va_list))
111 #warning "Not C99 and no va_copy macro available, falling back to memcpy"
112 #endif /* __va_copy */
113 #endif /* !va_copy */
114 #endif /* !C99 */
115
116 #ifdef HAVE_LCAPS
117 #include <sys/capability.h>
118 #include <sys/prctl.h>
119 #endif /* HAVE_LCAPS */
120
121 /* network include group */
122
123 #include <sys/socket.h>
124
125 #ifdef HAVE_SYS_SOCKIO_H
126 #include <sys/sockio.h>
127 #endif /* HAVE_SYS_SOCKIO_H */
128
129 #ifdef HAVE_NETINET_IN_H
130 #include <netinet/in.h>
131 #endif /* HAVE_NETINET_IN_H */
132 #include <netinet/in_systm.h>
133 #include <netinet/ip.h>
134 #include <netinet/tcp.h>
135
136 #ifdef HAVE_NET_NETOPT_H
137 #include <net/netopt.h>
138 #endif /* HAVE_NET_NETOPT_H */
139
140 #include <net/if.h>
141
142 #ifdef HAVE_NET_IF_DL_H
143 #include <net/if_dl.h>
144 #endif /* HAVE_NET_IF_DL_H */
145
146 #ifdef HAVE_NET_IF_VAR_H
147 #include <net/if_var.h>
148 #endif /* HAVE_NET_IF_VAR_H */
149
150 #ifdef HAVE_NET_ROUTE_H
151 #include <net/route.h>
152 #endif /* HAVE_NET_ROUTE_H */
153
154 #ifdef HAVE_NETLINK
155 #include <linux/netlink.h>
156 #include <linux/rtnetlink.h>
157 #else
158 #define RT_TABLE_MAIN           0
159 #endif /* HAVE_NETLINK */
160
161 #ifdef HAVE_NETDB_H
162 #include <netdb.h>
163 #endif /* HAVE_NETDB_H */
164
165 #include <arpa/inet.h>
166 #include <arpa/telnet.h>
167
168 #ifdef HAVE_INET_ND_H
169 #include <inet/nd.h>
170 #endif /* HAVE_INET_ND_H */
171
172 #ifdef HAVE_NETINET_IN_VAR_H
173 #include <netinet/in_var.h>
174 #endif /* HAVE_NETINET_IN_VAR_H */
175
176 #ifdef HAVE_NETINET6_IN6_VAR_H
177 #include <netinet6/in6_var.h>
178 #endif /* HAVE_NETINET6_IN6_VAR_H */
179
180 #ifdef HAVE_NETINET_IN6_VAR_H
181 #include <netinet/in6_var.h>
182 #endif /* HAVE_NETINET_IN6_VAR_H */
183
184 #ifdef HAVE_NETINET6_IN_H
185 #include <netinet6/in.h>
186 #endif /* HAVE_NETINET6_IN_H */
187
188 #ifdef HAVE_NETINET6_IP6_H
189 #include <netinet6/ip6.h>
190 #endif /* HAVE_NETINET6_IP6_H */
191
192 #ifdef HAVE_NETINET_ICMP6_H
193 #include <netinet/icmp6.h>
194 #endif /* HAVE_NETINET_ICMP6_H */
195
196 #ifdef HAVE_NETINET6_ND6_H
197 #include <netinet6/nd6.h>
198 #endif /* HAVE_NETINET6_ND6_H */
199
200 /* Some systems do not define UINT32_MAX */
201 #ifndef UINT32_MAX
202 #define UINT32_MAX 0xFFFFFFFFU
203 #endif /* UINT32_MAX */
204
205 #ifdef HAVE_LIBUTIL_H
206 #include <libutil.h>
207 #endif /* HAVE_LIBUTIL_H */
208
209 #ifdef HAVE_GLIBC_BACKTRACE
210 #include <execinfo.h>
211 #endif /* HAVE_GLIBC_BACKTRACE */
212
213 #ifdef BSDI_NRL
214
215 #ifdef HAVE_NETINET6_IN6_H
216 #include <netinet6/in6.h>
217 #endif /* HAVE_NETINET6_IN6_H */
218
219 #ifdef NRL
220 #include <netinet6/in6.h>
221 #endif /* NRL */
222
223 #define IN6_ARE_ADDR_EQUAL IN6_IS_ADDR_EQUAL
224
225 #endif /* BSDI_NRL */
226
227 /* Local includes: */
228 #if !(defined(__GNUC__) || defined(VTYSH_EXTRACT_PL))
229 #define __attribute__(x)
230 #endif /* !__GNUC__ || VTYSH_EXTRACT_PL */
231
232 #include "zassert.h"
233
234 #ifdef HAVE_BROKEN_CMSG_FIRSTHDR
235
236 /* This bug is present in Solaris 8 and pre-patch Solaris 9 <sys/socket.h>;
237    please refer to http://bugzilla.quagga.net/show_bug.cgi?id=142 */
238
239 /* Check that msg_controllen is large enough. */
240 #define ZCMSG_FIRSTHDR(mhdr) \
241   (((size_t)((mhdr)->msg_controllen) >= sizeof(struct cmsghdr)) ? \
242    CMSG_FIRSTHDR(mhdr) : (struct cmsghdr *)NULL)
243
244 #warning "CMSG_FIRSTHDR is broken on this platform, using a workaround"
245
246 #else /* HAVE_BROKEN_CMSG_FIRSTHDR */
247 #define ZCMSG_FIRSTHDR(M) CMSG_FIRSTHDR(M)
248 #endif /* HAVE_BROKEN_CMSG_FIRSTHDR */
249
250 /*
251  * RFC 3542 defines several macros for using struct cmsghdr.
252  * Here, we define those that are not present
253  */
254
255 /*
256  * Internal defines, for use only in this file.
257  * These are likely wrong on other than ILP32 machines, so warn.
258  */
259 #ifndef _CMSG_DATA_ALIGN
260 #define _CMSG_DATA_ALIGN(n)           (((n) + 3) & ~3)
261 #endif /* _CMSG_DATA_ALIGN */
262
263 #ifndef _CMSG_HDR_ALIGN
264 #define _CMSG_HDR_ALIGN(n)            (((n) + 3) & ~3)
265 #endif /* _CMSG_HDR_ALIGN */
266
267 /*
268  * CMSG_SPACE and CMSG_LEN are required in RFC3542, but were new in that
269  * version.
270  */
271 #ifndef CMSG_SPACE
272 #define CMSG_SPACE(l)       (_CMSG_DATA_ALIGN(sizeof(struct cmsghdr)) + \
273                               _CMSG_HDR_ALIGN(l))
274 #warning "assuming 4-byte alignment for CMSG_SPACE"
275 #endif /* CMSG_SPACE */
276
277 #ifndef CMSG_LEN
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 */
281
282 /*  The definition of struct in_pktinfo is missing in old version of
283     GLIBC 2.1 (Redhat 6.1).  */
284 #if defined (GNU_LINUX) && ! defined (HAVE_INPKTINFO)
285 struct in_pktinfo {
286   int ipi_ifindex;
287   struct in_addr ipi_spec_dst;
288   struct in_addr ipi_addr;
289 };
290 #endif
291
292 /*
293  * OSPF Fragmentation / fragmented writes
294  *
295  * ospfd can support writing fragmented packets, for cases where
296  * kernel will not fragment IP_HDRINCL and/or multicast destined
297  * packets (ie TTBOMK all kernels, BSD, SunOS, Linux). However,
298  * SunOS, probably BSD too, clobber the user supplied IP ID and IP
299  * flags fields, hence user-space fragmentation will not work.
300  * Only Linux is known to leave IP header unmolested.
301  * Further, fragmentation really should be done the kernel, which already
302  * supports it, and which avoids nasty IP ID state problems.
303  *
304  * Fragmentation of OSPF packets can be required on networks with router
305  * with many many interfaces active in one area, or on networks with links
306  * with low MTUs.
307  */
308 #ifdef GNU_LINUX
309 #define WANT_OSPF_WRITE_FRAGMENT
310 #endif
311
312 /*
313  * IP_HDRINCL / struct ip byte order
314  *
315  * Linux: network byte order
316  * *BSD: network, except for length and offset. (cf Stevens)
317  * SunOS: nominally as per BSD. but bug: network order on LE.
318  * OpenBSD: network byte order, apart from older versions which are as per
319  *          *BSD
320  */
321 #if defined(__NetBSD__) || defined(__FreeBSD__) \
322    || (defined(__OpenBSD__) && (OpenBSD < 200311)) \
323    || (defined(SUNOS_5) && defined(WORDS_BIGENDIAN))
324 #define HAVE_IP_HDRINCL_BSD_ORDER
325 #endif
326
327 /* MAX / MIN are not commonly defined, but useful */
328 #ifndef MAX
329 #define MAX(a, b) ((a) > (b) ? (a) : (b))
330 #endif
331 #ifndef MIN
332 #define MIN(a, b) ((a) < (b) ? (a) : (b))
333 #endif
334
335 /* For old definition. */
336 #ifndef IN6_ARE_ADDR_EQUAL
337 #define IN6_ARE_ADDR_EQUAL IN6_IS_ADDR_EQUAL
338 #endif /* IN6_ARE_ADDR_EQUAL */
339
340 /* Zebra message types. */
341 #define ZEBRA_INTERFACE_ADD                1
342 #define ZEBRA_INTERFACE_DELETE             2
343 #define ZEBRA_INTERFACE_ADDRESS_ADD        3
344 #define ZEBRA_INTERFACE_ADDRESS_DELETE     4
345 #define ZEBRA_INTERFACE_UP                 5
346 #define ZEBRA_INTERFACE_DOWN               6
347 #define ZEBRA_IPV4_ROUTE_ADD               7
348 #define ZEBRA_IPV4_ROUTE_DELETE            8
349 #define ZEBRA_IPV6_ROUTE_ADD               9
350 #define ZEBRA_IPV6_ROUTE_DELETE           10
351 #define ZEBRA_REDISTRIBUTE_ADD            11
352 #define ZEBRA_REDISTRIBUTE_DELETE         12
353 #define ZEBRA_REDISTRIBUTE_DEFAULT_ADD    13
354 #define ZEBRA_REDISTRIBUTE_DEFAULT_DELETE 14
355 #define ZEBRA_IPV4_NEXTHOP_LOOKUP         15
356 #define ZEBRA_IPV6_NEXTHOP_LOOKUP         16
357 #define ZEBRA_IPV4_IMPORT_LOOKUP          17
358 #define ZEBRA_IPV6_IMPORT_LOOKUP          18
359 #define ZEBRA_INTERFACE_RENAME            19
360 #define ZEBRA_ROUTER_ID_ADD               20
361 #define ZEBRA_ROUTER_ID_DELETE            21
362 #define ZEBRA_ROUTER_ID_UPDATE            22
363 #define ZEBRA_MESSAGE_MAX                 23
364
365 /* Zebra route's types. */
366 #define ZEBRA_ROUTE_SYSTEM               0
367 #define ZEBRA_ROUTE_KERNEL               1
368 #define ZEBRA_ROUTE_CONNECT              2
369 #define ZEBRA_ROUTE_STATIC               3
370 #define ZEBRA_ROUTE_RIP                  4
371 #define ZEBRA_ROUTE_RIPNG                5
372 #define ZEBRA_ROUTE_OSPF                 6
373 #define ZEBRA_ROUTE_OSPF6                7
374 #define ZEBRA_ROUTE_ISIS                 8
375 #define ZEBRA_ROUTE_BGP                  9
376 #define ZEBRA_ROUTE_HSLS                 10
377 #define ZEBRA_ROUTE_OLSR                 11
378 #define ZEBRA_ROUTE_MAX                  12
379
380 /* Zebra's family types. */
381 #define ZEBRA_FAMILY_IPV4                1
382 #define ZEBRA_FAMILY_IPV6                2
383 #define ZEBRA_FAMILY_MAX                 3
384
385 /* Error codes of zebra. */
386 #define ZEBRA_ERR_RTEXIST               -1
387 #define ZEBRA_ERR_RTUNREACH             -2
388 #define ZEBRA_ERR_EPERM                 -3
389 #define ZEBRA_ERR_RTNOEXIST             -4
390
391 /* Zebra message flags */
392 #define ZEBRA_FLAG_INTERNAL           0x01
393 #define ZEBRA_FLAG_SELFROUTE          0x02
394 #define ZEBRA_FLAG_BLACKHOLE          0x04
395 #define ZEBRA_FLAG_IBGP               0x08
396 #define ZEBRA_FLAG_SELECTED           0x10
397 #define ZEBRA_FLAG_CHANGED            0x20
398 #define ZEBRA_FLAG_STATIC             0x40
399 #define ZEBRA_FLAG_REJECT             0x80
400
401 /* Zebra nexthop flags. */
402 #define ZEBRA_NEXTHOP_IFINDEX            1
403 #define ZEBRA_NEXTHOP_IFNAME             2
404 #define ZEBRA_NEXTHOP_IPV4               3
405 #define ZEBRA_NEXTHOP_IPV4_IFINDEX       4
406 #define ZEBRA_NEXTHOP_IPV4_IFNAME        5
407 #define ZEBRA_NEXTHOP_IPV6               6
408 #define ZEBRA_NEXTHOP_IPV6_IFINDEX       7
409 #define ZEBRA_NEXTHOP_IPV6_IFNAME        8
410 #define ZEBRA_NEXTHOP_BLACKHOLE          9
411
412 #ifndef INADDR_LOOPBACK
413 #define INADDR_LOOPBACK 0x7f000001      /* Internet address 127.0.0.1.  */
414 #endif
415
416 /* Address family numbers from RFC1700. */
417 #define AFI_IP                    1
418 #define AFI_IP6                   2
419 #define AFI_MAX                   3
420
421 /* Subsequent Address Family Identifier. */
422 #define SAFI_UNICAST              1
423 #define SAFI_MULTICAST            2
424 #define SAFI_UNICAST_MULTICAST    3
425 #define SAFI_MPLS_VPN             4
426 #define SAFI_MAX                  5
427
428 /* Filter direction.  */
429 #define FILTER_IN                 0
430 #define FILTER_OUT                1
431 #define FILTER_MAX                2
432
433 /* Default Administrative Distance of each protocol. */
434 #define ZEBRA_KERNEL_DISTANCE_DEFAULT      0
435 #define ZEBRA_CONNECT_DISTANCE_DEFAULT     0
436 #define ZEBRA_STATIC_DISTANCE_DEFAULT      1
437 #define ZEBRA_RIP_DISTANCE_DEFAULT       120
438 #define ZEBRA_RIPNG_DISTANCE_DEFAULT     120
439 #define ZEBRA_OSPF_DISTANCE_DEFAULT      110
440 #define ZEBRA_OSPF6_DISTANCE_DEFAULT     110
441 #define ZEBRA_ISIS_DISTANCE_DEFAULT      115
442 #define ZEBRA_IBGP_DISTANCE_DEFAULT      200
443 #define ZEBRA_EBGP_DISTANCE_DEFAULT       20
444
445 /* Flag manipulation macros. */
446 #define CHECK_FLAG(V,F)      ((V) & (F))
447 #define SET_FLAG(V,F)        (V) = (V) | (F)
448 #define UNSET_FLAG(V,F)      (V) = (V) & ~(F)
449
450 /* AFI and SAFI type. */
451 typedef u_int16_t afi_t;
452 typedef u_int8_t safi_t;
453
454 /* Zebra types. */
455 typedef u_int16_t zebra_size_t;
456 typedef u_int8_t zebra_command_t;
457
458 /* FIFO -- first in first out structure and macros.  */
459 struct fifo {
460   struct fifo *next;
461   struct fifo *prev;
462 };
463
464 #define FIFO_INIT(F)                                  \
465   do {                                                \
466     struct fifo *Xfifo = (struct fifo *)(F);          \
467     Xfifo->next = Xfifo->prev = Xfifo;                \
468   } while (0)
469
470 #define FIFO_ADD(F,N)                                 \
471   do {                                                \
472     struct fifo *Xfifo = (struct fifo *)(F);          \
473     struct fifo *Xnode = (struct fifo *)(N);          \
474     Xnode->next = Xfifo;                              \
475     Xnode->prev = Xfifo->prev;                        \
476     Xfifo->prev = Xfifo->prev->next = Xnode;          \
477   } while (0)
478
479 #define FIFO_DEL(N)                                   \
480   do {                                                \
481     struct fifo *Xnode = (struct fifo *)(N);          \
482     Xnode->prev->next = Xnode->next;                  \
483     Xnode->next->prev = Xnode->prev;                  \
484   } while (0)
485
486 #define FIFO_HEAD(F)                                  \
487   ((((struct fifo *)(F))->next == (struct fifo *)(F)) \
488   ? NULL : (F)->next)
489
490 #define FIFO_EMPTY(F)                                 \
491   (((struct fifo *)(F))->next == (struct fifo *)(F))
492
493 #define FIFO_TOP(F)                                   \
494   (FIFO_EMPTY(F) ? NULL : ((struct fifo *)(F))->next)
495
496 #endif /* _ZEBRA_H */
497
498 /*
499  * Local Variables:
500  * c-basic-offset: 2
501  * indent-tabs-mode: nil
502  * End:
503  */