]> git.proxmox.com Git - mirror_frr.git/blame - lib/zebra.h
2004-09-30 Paul Jakma <paul@dishone.st>
[mirror_frr.git] / lib / zebra.h
CommitLineData
718e3744 1/* Zebra common header.
2 Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002 Kunihiro Ishiguro
3
4This file is part of GNU Zebra.
5
6GNU Zebra is free software; you can redistribute it and/or modify it
7under the terms of the GNU General Public License as published by the
8Free Software Foundation; either version 2, or (at your option) any
9later version.
10
11GNU Zebra is distributed in the hope that it will be useful, but
12WITHOUT ANY WARRANTY; without even the implied warranty of
13MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14General Public License for more details.
15
16You should have received a copy of the GNU General Public License
17along with GNU Zebra; see the file COPYING. If not, write to the Free
18Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
1902111-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__
9bcdb638 31typedef unsigned int u_int32_t;
32typedef unsigned short u_int16_t;
33typedef unsigned char u_int8_t;
718e3744 34#endif /* SUNOS_5 */
35
f0438521 36#ifndef HAVE_SOCKLEN_T
37typedef int socklen_t;
38#endif /* HAVE_SOCKLEN_T */
39
718e3744 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>
edd7c245 48#include <pwd.h>
49#include <grp.h>
718e3744 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 */
a58c25b6 78#ifdef HAVE_LIMITS_H
79#include <limits.h>
80#endif /* HAVE_LIMITS_H */
718e3744 81
82/* machine dependent includes */
83#ifdef SUNOS_5
718e3744 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
ba965c6c 92#ifdef HAVE_ASM_TYPES_H
93#include <asm/types.h>
94#endif /* HAVE_ASM_TYPES_H */
95
718e3744 96/* misc include group */
97#include <stdarg.h>
98#include <assert.h>
99
ba3a0bc5 100#ifdef HAVE_LCAPS
101#include <sys/capability.h>
102#include <sys/prctl.h>
103#endif /* HAVE_LCAPS */
104
718e3744 105/* network include group */
106
107#include <sys/socket.h>
108
109#ifdef HAVE_SYS_SOCKIO_H
110#include <sys/sockio.h>
111#endif /* HAVE_SYS_SOCKIO_H */
112
113#ifdef HAVE_NETINET_IN_H
114#include <netinet/in.h>
115#endif /* HAVE_NETINET_IN_H */
116#include <netinet/in_systm.h>
117#include <netinet/ip.h>
118#include <netinet/tcp.h>
119
120#ifdef HAVE_NET_NETOPT_H
121#include <net/netopt.h>
122#endif /* HAVE_NET_NETOPT_H */
123
124#include <net/if.h>
125
126#ifdef HAVE_NET_IF_DL_H
127#include <net/if_dl.h>
128#endif /* HAVE_NET_IF_DL_H */
129
130#ifdef HAVE_NET_IF_VAR_H
131#include <net/if_var.h>
132#endif /* HAVE_NET_IF_VAR_H */
133
a58c25b6 134#ifdef HAVE_NET_ROUTE_H
718e3744 135#include <net/route.h>
a58c25b6 136#endif /* HAVE_NET_ROUTE_H */
718e3744 137
138#ifdef HAVE_NETLINK
139#include <linux/netlink.h>
140#include <linux/rtnetlink.h>
141#else
142#define RT_TABLE_MAIN 0
143#endif /* HAVE_NETLINK */
144
145#ifdef HAVE_NETDB_H
146#include <netdb.h>
147#endif /* HAVE_NETDB_H */
148
149#include <arpa/inet.h>
150#include <arpa/telnet.h>
151
152#ifdef HAVE_INET_ND_H
153#include <inet/nd.h>
154#endif /* HAVE_INET_ND_H */
155
156#ifdef HAVE_NETINET_IN_VAR_H
157#include <netinet/in_var.h>
158#endif /* HAVE_NETINET_IN_VAR_H */
159
726f9b2b 160#ifdef HAVE_NETINET6_IN6_VAR_H
161#include <netinet6/in6_var.h>
162#endif /* HAVE_NETINET6_IN6_VAR_H */
163
718e3744 164#ifdef HAVE_NETINET_IN6_VAR_H
165#include <netinet/in6_var.h>
166#endif /* HAVE_NETINET_IN6_VAR_H */
167
168#ifdef HAVE_NETINET6_IN_H
169#include <netinet6/in.h>
170#endif /* HAVE_NETINET6_IN_H */
171
172
173#ifdef HAVE_NETINET6_IP6_H
174#include <netinet6/ip6.h>
175#endif /* HAVE_NETINET6_IP6_H */
176
177#ifdef HAVE_NETINET_ICMP6_H
178#include <netinet/icmp6.h>
179#endif /* HAVE_NETINET_ICMP6_H */
180
181#ifdef HAVE_NETINET6_ND6_H
182#include <netinet6/nd6.h>
183#endif /* HAVE_NETINET6_ND6_H */
184
3b424979 185/* Some systems do not define UINT32_MAX */
186#ifndef UINT32_MAX
187#define UINT32_MAX 0xFFFFFFFFU
188#endif /* UINT32_MAX */
189
718e3744 190#ifdef HAVE_LIBUTIL_H
191#include <libutil.h>
192#endif /* HAVE_LIBUTIL_H */
193
fb2d1502 194#ifdef HAVE_GLIBC_BACKTRACE
195#include <execinfo.h>
196#endif /* HAVE_GLIBC_BACKTRACE */
197
718e3744 198#ifdef BSDI_NRL
199
200#ifdef HAVE_NETINET6_IN6_H
201#include <netinet6/in6.h>
202#endif /* HAVE_NETINET6_IN6_H */
203
204#ifdef NRL
205#include <netinet6/in6.h>
206#endif /* NRL */
207
208#define IN6_ARE_ADDR_EQUAL IN6_IS_ADDR_EQUAL
209
718e3744 210#endif /* BSDI_NRL */
211
02ff83c5 212/*
213 * RFC 2553-bis defines not available on some systems.
214 */
215#ifndef _CMSG_DATA_ALIGN
216#define _CMSG_DATA_ALIGN(n) (((n) + 3) & ~3)
217#endif /* _CMSG_DATA_ALIGN */
218
219#ifndef _CMSG_HDR_ALIGN
220#define _CMSG_HDR_ALIGN(n) (((n) + 3) & ~3)
221#endif /* _CMSG_HDR_ALIGN */
222
223#ifndef CMSG_SPACE
224#define CMSG_SPACE(l) (_CMSG_DATA_ALIGN(sizeof(struct cmsghdr)) + \
225 _CMSG_HDR_ALIGN(l))
226#endif /* CMSG_SPACE */
227
228
229#ifndef CMSG_LEN
230#define CMSG_LEN(l) (_CMSG_DATA_ALIGN(sizeof(struct cmsghdr)) + (l))
231#endif /* CMSG_LEN */
232
138ce75f 233#if !(defined(__GNUC__) || defined(VTYSH_EXTRACT_PL))
51a8798e 234#define __attribute__(x)
235#endif /* !__GNUC__ */
236
718e3744 237/* The definition of struct in_pktinfo is missing in old version of
238 GLIBC 2.1 (Redhat 6.1). */
239#if defined (GNU_LINUX) && ! defined (HAVE_INPKTINFO)
240struct in_pktinfo
241{
242 int ipi_ifindex;
243 struct in_addr ipi_spec_dst;
244 struct in_addr ipi_addr;
245};
246#endif
247
9172ee0e 248/*
249 * OSPF Fragmentation / fragmented writes
250 *
251 * ospfd can support writing fragmented packets, for cases where
252 * kernel will not fragment IP_HDRINCL and/or multicast destined
253 * packets (ie TTBOMK all kernels, BSD, SunOS, Linux). However,
254 * SunOS, probably BSD too, clobber the user supplied IP ID and IP
255 * flags fields, hence user-space fragmentation will not work.
256 * Only Linux is known to leave IP header unmolested.
257 * Further, fragmentation really should be done the kernel, which already
258 * supports it, and which avoids nasty IP ID state problems.
259 *
260 * Fragmentation of OSPF packets can be required on networks with router
261 * with many many interfaces active in one area, or on networks with links
262 * with low MTUs.
263 */
264#ifdef GNU_LINUX
265#define WANT_OSPF_WRITE_FRAGMENT
266#endif
267
268/*
269 * IP_HDRINCL / struct ip byte order
270 *
271 * Linux: network byte order
272 * *BSD: network, except for length and offset. (cf Stevens)
273 * SunOS: nominally as per BSD. but bug: network order on LE.
274 * OpenBSD: network byte order, apart from older versions which are as per
275 * *BSD
276 */
277#if defined(__NetBSD__) || defined(__FreeBSD__) \
278 || (defined(__OpenBSD__) && (OpenBSD < 200311)) \
279 || (defined(SUNOS_5) && defined(WORDS_BIGENDIAN))
280#define HAVE_IP_HDRINCL_BSD_ORDER
281#endif
282
283/*
efba6ce9 284/* MAX / MIN are not commonly defined, but useful */
285#ifndef MAX
286#define MAX(a, b) ((a) > (b) ? (a) : (b))
287#endif
288#ifndef MIN
289#define MIN(a, b) ((a) < (b) ? (a) : (b))
290#endif
291
718e3744 292/* For old definition. */
293#ifndef IN6_ARE_ADDR_EQUAL
294#define IN6_ARE_ADDR_EQUAL IN6_IS_ADDR_EQUAL
295#endif /* IN6_ARE_ADDR_EQUAL */
296
297/* Zebra message types. */
298#define ZEBRA_INTERFACE_ADD 1
299#define ZEBRA_INTERFACE_DELETE 2
300#define ZEBRA_INTERFACE_ADDRESS_ADD 3
301#define ZEBRA_INTERFACE_ADDRESS_DELETE 4
302#define ZEBRA_INTERFACE_UP 5
303#define ZEBRA_INTERFACE_DOWN 6
304#define ZEBRA_IPV4_ROUTE_ADD 7
305#define ZEBRA_IPV4_ROUTE_DELETE 8
306#define ZEBRA_IPV6_ROUTE_ADD 9
307#define ZEBRA_IPV6_ROUTE_DELETE 10
308#define ZEBRA_REDISTRIBUTE_ADD 11
309#define ZEBRA_REDISTRIBUTE_DELETE 12
310#define ZEBRA_REDISTRIBUTE_DEFAULT_ADD 13
311#define ZEBRA_REDISTRIBUTE_DEFAULT_DELETE 14
312#define ZEBRA_IPV4_NEXTHOP_LOOKUP 15
313#define ZEBRA_IPV6_NEXTHOP_LOOKUP 16
314#define ZEBRA_IPV4_IMPORT_LOOKUP 17
315#define ZEBRA_IPV6_IMPORT_LOOKUP 18
efba6ce9 316#define ZEBRA_INTERFACE_RENAME 19
317#define ZEBRA_MESSAGE_MAX 20
718e3744 318
319/* Zebra route's types. */
320#define ZEBRA_ROUTE_SYSTEM 0
321#define ZEBRA_ROUTE_KERNEL 1
322#define ZEBRA_ROUTE_CONNECT 2
323#define ZEBRA_ROUTE_STATIC 3
324#define ZEBRA_ROUTE_RIP 4
325#define ZEBRA_ROUTE_RIPNG 5
326#define ZEBRA_ROUTE_OSPF 6
327#define ZEBRA_ROUTE_OSPF6 7
9e867fe6 328#define ZEBRA_ROUTE_ISIS 8
329#define ZEBRA_ROUTE_BGP 9
330#define ZEBRA_ROUTE_MAX 10
718e3744 331
332/* Zebra's family types. */
333#define ZEBRA_FAMILY_IPV4 1
334#define ZEBRA_FAMILY_IPV6 2
335#define ZEBRA_FAMILY_MAX 3
336
337/* Error codes of zebra. */
338#define ZEBRA_ERR_RTEXIST -1
339#define ZEBRA_ERR_RTUNREACH -2
340#define ZEBRA_ERR_EPERM -3
341#define ZEBRA_ERR_RTNOEXIST -4
342
343/* Zebra message flags */
344#define ZEBRA_FLAG_INTERNAL 0x01
345#define ZEBRA_FLAG_SELFROUTE 0x02
346#define ZEBRA_FLAG_BLACKHOLE 0x04
347#define ZEBRA_FLAG_IBGP 0x08
348#define ZEBRA_FLAG_SELECTED 0x10
349#define ZEBRA_FLAG_CHANGED 0x20
350#define ZEBRA_FLAG_STATIC 0x40
81dfcaa2 351#define ZEBRA_FLAG_REJECT 0x80
718e3744 352
353/* Zebra nexthop flags. */
354#define ZEBRA_NEXTHOP_IFINDEX 1
355#define ZEBRA_NEXTHOP_IFNAME 2
356#define ZEBRA_NEXTHOP_IPV4 3
357#define ZEBRA_NEXTHOP_IPV4_IFINDEX 4
358#define ZEBRA_NEXTHOP_IPV4_IFNAME 5
359#define ZEBRA_NEXTHOP_IPV6 6
360#define ZEBRA_NEXTHOP_IPV6_IFINDEX 7
361#define ZEBRA_NEXTHOP_IPV6_IFNAME 8
595db7f1 362#define ZEBRA_NEXTHOP_BLACKHOLE 9
718e3744 363
364#ifndef INADDR_LOOPBACK
365#define INADDR_LOOPBACK 0x7f000001 /* Internet address 127.0.0.1. */
366#endif
367
368/* Address family numbers from RFC1700. */
369#define AFI_IP 1
370#define AFI_IP6 2
371#define AFI_MAX 3
372
373/* Subsequent Address Family Identifier. */
374#define SAFI_UNICAST 1
375#define SAFI_MULTICAST 2
376#define SAFI_UNICAST_MULTICAST 3
377#define SAFI_MPLS_VPN 4
378#define SAFI_MAX 5
379
380/* Filter direction. */
381#define FILTER_IN 0
382#define FILTER_OUT 1
383#define FILTER_MAX 2
384
385/* Default Administrative Distance of each protocol. */
386#define ZEBRA_KERNEL_DISTANCE_DEFAULT 0
387#define ZEBRA_CONNECT_DISTANCE_DEFAULT 0
388#define ZEBRA_STATIC_DISTANCE_DEFAULT 1
389#define ZEBRA_RIP_DISTANCE_DEFAULT 120
390#define ZEBRA_RIPNG_DISTANCE_DEFAULT 120
391#define ZEBRA_OSPF_DISTANCE_DEFAULT 110
392#define ZEBRA_OSPF6_DISTANCE_DEFAULT 110
9e867fe6 393#define ZEBRA_ISIS_DISTANCE_DEFAULT 115
718e3744 394#define ZEBRA_IBGP_DISTANCE_DEFAULT 200
395#define ZEBRA_EBGP_DISTANCE_DEFAULT 20
396
397/* Flag manipulation macros. */
398#define CHECK_FLAG(V,F) ((V) & (F))
399#define SET_FLAG(V,F) (V) = (V) | (F)
400#define UNSET_FLAG(V,F) (V) = (V) & ~(F)
401
402/* AFI and SAFI type. */
403typedef u_int16_t afi_t;
5228ad27 404typedef u_int8_t safi_t;
718e3744 405
406/* Zebra types. */
407typedef u_int16_t zebra_size_t;
408typedef u_int8_t zebra_command_t;
409
f0438521 410/* FIFO -- first in first out structure and macros. */
411struct fifo
412{
413 struct fifo *next;
414 struct fifo *prev;
415};
416
417#define FIFO_INIT(F) \
418 do { \
419 struct fifo *Xfifo = (struct fifo *)(F); \
420 Xfifo->next = Xfifo->prev = Xfifo; \
421 } while (0)
422
423#define FIFO_ADD(F,N) \
424 do { \
425 struct fifo *Xfifo = (struct fifo *)(F); \
426 struct fifo *Xnode = (struct fifo *)(N); \
427 Xnode->next = Xfifo; \
428 Xnode->prev = Xfifo->prev; \
429 Xfifo->prev = Xfifo->prev->next = Xnode; \
430 } while (0)
431
432#define FIFO_DEL(N) \
433 do { \
434 struct fifo *Xnode = (struct fifo *)(N); \
435 Xnode->prev->next = Xnode->next; \
436 Xnode->next->prev = Xnode->prev; \
437 } while (0)
438
439#define FIFO_HEAD(F) \
440 ((((struct fifo *)(F))->next == (struct fifo *)(F)) \
441 ? NULL : (F)->next)
442
443#define FIFO_EMPTY(F) \
444 (((struct fifo *)(F))->next == (struct fifo *)(F))
445
446#define FIFO_TOP(F) \
447 (FIFO_EMPTY(F) ? NULL : ((struct fifo *)(F))->next)
448
718e3744 449#endif /* _ZEBRA_H */