Annotation of embedaddon/quagga/lib/zebra.h, revision 1.1.1.4
1.1 misho 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: typedef unsigned int u_int32_t;
31: typedef unsigned short u_int16_t;
32: typedef unsigned char u_int8_t;
33: #endif /* SUNOS_5 */
34:
35: #ifndef HAVE_SOCKLEN_T
36: typedef int socklen_t;
37: #endif /* HAVE_SOCKLEN_T */
38:
39: #include <unistd.h>
40: #include <stdio.h>
41: #include <stdlib.h>
1.1.1.4 ! misho 42: #include <stddef.h>
1.1 misho 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: #ifdef HAVE_SYS_SELECT_H
54: #include <sys/select.h>
55: #endif /* HAVE_SYS_SELECT_H */
56: #include <sys/stat.h>
57: #include <sys/types.h>
58: #include <sys/param.h>
59: #ifdef HAVE_SYS_SYSCTL_H
60: #ifdef GNU_LINUX
61: #include <linux/types.h>
62: #endif
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: #ifdef TIME_WITH_SYS_TIME
74: # include <sys/time.h>
75: # include <time.h>
76: #else
77: # ifdef HAVE_SYS_TIME_H
78: # include <sys/time.h>
79: # else
80: # include <time.h>
81: # endif
82: #endif /* TIME_WITH_SYS_TIME */
83: #include <sys/uio.h>
84: #include <sys/utsname.h>
85: #ifdef HAVE_RUSAGE
86: #include <sys/resource.h>
87: #endif /* HAVE_RUSAGE */
88: #ifdef HAVE_LIMITS_H
89: #include <limits.h>
90: #endif /* HAVE_LIMITS_H */
91: #ifdef HAVE_INTTYPES_H
92: #include <inttypes.h>
93: #endif /* HAVE_INTTYPES_H */
1.1.1.4 ! misho 94: #ifdef HAVE_STDBOOL_H
! 95: #include <stdbool.h>
! 96: #endif
1.1 misho 97:
98: /* machine dependent includes */
99: #ifdef SUNOS_5
100: #include <strings.h>
101: #endif /* SUNOS_5 */
102:
103: /* machine dependent includes */
104: #ifdef HAVE_LINUX_VERSION_H
105: #include <linux/version.h>
106: #endif /* HAVE_LINUX_VERSION_H */
107:
108: #ifdef HAVE_ASM_TYPES_H
109: #include <asm/types.h>
110: #endif /* HAVE_ASM_TYPES_H */
111:
112: /* misc include group */
113: #include <stdarg.h>
114: #if !(defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)
115: /* Not C99; do we need to define va_copy? */
116: #ifndef va_copy
117: #ifdef __va_copy
118: #define va_copy(DST,SRC) __va_copy(DST,SRC)
119: #else
120: /* Now we are desperate; this should work on many typical platforms.
121: But this is slightly dangerous, because the standard does not require
122: va_copy to be a macro. */
123: #define va_copy(DST,SRC) memcpy(&(DST), &(SRC), sizeof(va_list))
124: #warning "Not C99 and no va_copy macro available, falling back to memcpy"
125: #endif /* __va_copy */
126: #endif /* !va_copy */
127: #endif /* !C99 */
128:
129:
130: #ifdef HAVE_LCAPS
131: #include <sys/capability.h>
132: #include <sys/prctl.h>
133: #endif /* HAVE_LCAPS */
134:
135: #ifdef HAVE_SOLARIS_CAPABILITIES
136: #include <priv.h>
137: #endif /* HAVE_SOLARIS_CAPABILITIES */
138:
139: /* network include group */
140:
141: #include <sys/socket.h>
142:
143: #ifdef HAVE_SYS_SOCKIO_H
144: #include <sys/sockio.h>
145: #endif /* HAVE_SYS_SOCKIO_H */
146:
1.1.1.3 misho 147: #ifdef __APPLE__
148: #define __APPLE_USE_RFC_3542
149: #endif
150:
1.1 misho 151: #ifdef HAVE_NETINET_IN_H
152: #include <netinet/in.h>
153: #endif /* HAVE_NETINET_IN_H */
154: #include <netinet/in_systm.h>
155: #include <netinet/ip.h>
156: #include <netinet/tcp.h>
157:
158: #ifdef HAVE_NET_NETOPT_H
159: #include <net/netopt.h>
160: #endif /* HAVE_NET_NETOPT_H */
161:
162: #include <net/if.h>
163:
164: #ifdef HAVE_NET_IF_DL_H
165: #include <net/if_dl.h>
166: #endif /* HAVE_NET_IF_DL_H */
167:
168: #ifdef HAVE_NET_IF_VAR_H
169: #include <net/if_var.h>
170: #endif /* HAVE_NET_IF_VAR_H */
171:
172: #ifdef HAVE_NET_ROUTE_H
173: #include <net/route.h>
174: #endif /* HAVE_NET_ROUTE_H */
175:
176: #ifdef HAVE_NETLINK
177: #include <linux/netlink.h>
178: #include <linux/rtnetlink.h>
179: #include <linux/filter.h>
180: #else
181: #define RT_TABLE_MAIN 0
182: #endif /* HAVE_NETLINK */
183:
184: #ifdef HAVE_NETDB_H
185: #include <netdb.h>
186: #endif /* HAVE_NETDB_H */
187:
188: #include <arpa/inet.h>
189:
190: #ifdef HAVE_INET_ND_H
191: #include <inet/nd.h>
192: #endif /* HAVE_INET_ND_H */
193:
194: #ifdef HAVE_NETINET_IN_VAR_H
195: #include <netinet/in_var.h>
196: #endif /* HAVE_NETINET_IN_VAR_H */
197:
198: #ifdef HAVE_NETINET6_IN6_VAR_H
199: #include <netinet6/in6_var.h>
200: #endif /* HAVE_NETINET6_IN6_VAR_H */
201:
202: #ifdef HAVE_NETINET_IN6_VAR_H
203: #include <netinet/in6_var.h>
204: #endif /* HAVE_NETINET_IN6_VAR_H */
205:
206: #ifdef HAVE_NETINET6_IN_H
207: #include <netinet6/in.h>
208: #endif /* HAVE_NETINET6_IN_H */
209:
210:
211: #ifdef HAVE_NETINET6_IP6_H
212: #include <netinet6/ip6.h>
213: #endif /* HAVE_NETINET6_IP6_H */
214:
215: #ifdef HAVE_NETINET_ICMP6_H
216: #include <netinet/icmp6.h>
217: #endif /* HAVE_NETINET_ICMP6_H */
218:
219: #ifdef HAVE_NETINET6_ND6_H
220: #include <netinet6/nd6.h>
221: #endif /* HAVE_NETINET6_ND6_H */
222:
223: /* Some systems do not define UINT32_MAX, etc.. from inttypes.h
224: * e.g. this makes life easier for FBSD 4.11 users.
225: */
226: #ifndef INT8_MAX
227: #define INT8_MAX (127)
228: #endif
229: #ifndef INT16_MAX
230: #define INT16_MAX (32767)
231: #endif
232: #ifndef INT32_MAX
233: #define INT32_MAX (2147483647)
234: #endif
235: #ifndef UINT8_MAX
236: #define UINT8_MAX (255U)
237: #endif
238: #ifndef UINT16_MAX
239: #define UINT16_MAX (65535U)
240: #endif
241: #ifndef UINT32_MAX
242: #define UINT32_MAX (4294967295U)
243: #endif
244:
245: #ifdef HAVE_GLIBC_BACKTRACE
246: #include <execinfo.h>
247: #endif /* HAVE_GLIBC_BACKTRACE */
248:
249: /* Local includes: */
250: #if !(defined(__GNUC__) || defined(VTYSH_EXTRACT_PL))
251: #define __attribute__(x)
252: #endif /* !__GNUC__ || VTYSH_EXTRACT_PL */
253:
254: #include "zassert.h"
255: #include "str.h"
256:
257:
258: #ifdef HAVE_BROKEN_CMSG_FIRSTHDR
259: /* This bug is present in Solaris 8 and pre-patch Solaris 9 <sys/socket.h>;
260: please refer to http://bugzilla.quagga.net/show_bug.cgi?id=142 */
261:
262: /* Check that msg_controllen is large enough. */
263: #define ZCMSG_FIRSTHDR(mhdr) \
264: (((size_t)((mhdr)->msg_controllen) >= sizeof(struct cmsghdr)) ? \
265: CMSG_FIRSTHDR(mhdr) : (struct cmsghdr *)NULL)
266:
267: #warning "CMSG_FIRSTHDR is broken on this platform, using a workaround"
268:
269: #else /* HAVE_BROKEN_CMSG_FIRSTHDR */
270: #define ZCMSG_FIRSTHDR(M) CMSG_FIRSTHDR(M)
271: #endif /* HAVE_BROKEN_CMSG_FIRSTHDR */
272:
273:
274:
275: /*
276: * RFC 3542 defines several macros for using struct cmsghdr.
277: * Here, we define those that are not present
278: */
279:
280: /*
281: * Internal defines, for use only in this file.
282: * These are likely wrong on other than ILP32 machines, so warn.
283: */
284: #ifndef _CMSG_DATA_ALIGN
285: #define _CMSG_DATA_ALIGN(n) (((n) + 3) & ~3)
286: #endif /* _CMSG_DATA_ALIGN */
287:
288: #ifndef _CMSG_HDR_ALIGN
289: #define _CMSG_HDR_ALIGN(n) (((n) + 3) & ~3)
290: #endif /* _CMSG_HDR_ALIGN */
291:
292: /*
293: * CMSG_SPACE and CMSG_LEN are required in RFC3542, but were new in that
294: * version.
295: */
296: #ifndef CMSG_SPACE
297: #define CMSG_SPACE(l) (_CMSG_DATA_ALIGN(sizeof(struct cmsghdr)) + \
298: _CMSG_HDR_ALIGN(l))
299: #warning "assuming 4-byte alignment for CMSG_SPACE"
300: #endif /* CMSG_SPACE */
301:
302:
303: #ifndef CMSG_LEN
304: #define CMSG_LEN(l) (_CMSG_DATA_ALIGN(sizeof(struct cmsghdr)) + (l))
305: #warning "assuming 4-byte alignment for CMSG_LEN"
306: #endif /* CMSG_LEN */
307:
308:
309: /* The definition of struct in_pktinfo is missing in old version of
310: GLIBC 2.1 (Redhat 6.1). */
311: #if defined (GNU_LINUX) && ! defined (HAVE_STRUCT_IN_PKTINFO)
312: struct in_pktinfo
313: {
314: int ipi_ifindex;
315: struct in_addr ipi_spec_dst;
316: struct in_addr ipi_addr;
317: };
318: #endif
319:
320: /*
321: * OSPF Fragmentation / fragmented writes
322: *
323: * ospfd can support writing fragmented packets, for cases where
324: * kernel will not fragment IP_HDRINCL and/or multicast destined
325: * packets (ie TTBOMK all kernels, BSD, SunOS, Linux). However,
326: * SunOS, probably BSD too, clobber the user supplied IP ID and IP
327: * flags fields, hence user-space fragmentation will not work.
328: * Only Linux is known to leave IP header unmolested.
329: * Further, fragmentation really should be done the kernel, which already
330: * supports it, and which avoids nasty IP ID state problems.
331: *
332: * Fragmentation of OSPF packets can be required on networks with router
333: * with many many interfaces active in one area, or on networks with links
334: * with low MTUs.
335: */
336: #ifdef GNU_LINUX
337: #define WANT_OSPF_WRITE_FRAGMENT
338: #endif
339:
340: /*
341: * IP_HDRINCL / struct ip byte order
342: *
343: * Linux: network byte order
344: * *BSD: network, except for length and offset. (cf Stevens)
345: * SunOS: nominally as per BSD. but bug: network order on LE.
346: * OpenBSD: network byte order, apart from older versions which are as per
347: * *BSD
348: */
1.1.1.4 ! misho 349: #if defined(__NetBSD__) \
! 350: || (defined(__FreeBSD__) && (__FreeBSD_version < 1100030)) \
1.1 misho 351: || (defined(__OpenBSD__) && (OpenBSD < 200311)) \
1.1.1.3 misho 352: || (defined(__APPLE__)) \
1.1 misho 353: || (defined(SUNOS_5) && defined(WORDS_BIGENDIAN))
354: #define HAVE_IP_HDRINCL_BSD_ORDER
355: #endif
356:
357: /* Define BYTE_ORDER, if not defined. Useful for compiler conditional
358: * code, rather than preprocessor conditional.
359: * Not all the world has this BSD define.
360: */
361: #ifndef BYTE_ORDER
362: #define BIG_ENDIAN 4321 /* least-significant byte first (vax, pc) */
363: #define LITTLE_ENDIAN 1234 /* most-significant byte first (IBM, net) */
364: #define PDP_ENDIAN 3412 /* LSB first in word, MSW first in long (pdp) */
365:
366: #if defined(WORDS_BIGENDIAN)
367: #define BYTE_ORDER BIG_ENDIAN
368: #else /* !WORDS_BIGENDIAN */
369: #define BYTE_ORDER LITTLE_ENDIAN
370: #endif /* WORDS_BIGENDIAN */
371:
372: #endif /* ndef BYTE_ORDER */
373:
374: /* MAX / MIN are not commonly defined, but useful */
375: #ifndef MAX
376: #define MAX(a, b) ((a) > (b) ? (a) : (b))
377: #endif
378: #ifndef MIN
379: #define MIN(a, b) ((a) < (b) ? (a) : (b))
380: #endif
381:
1.1.1.3 misho 382: #define ZEBRA_NUM_OF(x) (sizeof (x) / sizeof (x[0]))
383:
1.1 misho 384: /* For old definition. */
385: #ifndef IN6_ARE_ADDR_EQUAL
386: #define IN6_ARE_ADDR_EQUAL IN6_IS_ADDR_EQUAL
387: #endif /* IN6_ARE_ADDR_EQUAL */
388:
389: /* default zebra TCP port for zclient */
390: #define ZEBRA_PORT 2600
391:
392: /* Zebra message types. */
393: #define ZEBRA_INTERFACE_ADD 1
394: #define ZEBRA_INTERFACE_DELETE 2
395: #define ZEBRA_INTERFACE_ADDRESS_ADD 3
396: #define ZEBRA_INTERFACE_ADDRESS_DELETE 4
397: #define ZEBRA_INTERFACE_UP 5
398: #define ZEBRA_INTERFACE_DOWN 6
399: #define ZEBRA_IPV4_ROUTE_ADD 7
400: #define ZEBRA_IPV4_ROUTE_DELETE 8
401: #define ZEBRA_IPV6_ROUTE_ADD 9
402: #define ZEBRA_IPV6_ROUTE_DELETE 10
403: #define ZEBRA_REDISTRIBUTE_ADD 11
404: #define ZEBRA_REDISTRIBUTE_DELETE 12
405: #define ZEBRA_REDISTRIBUTE_DEFAULT_ADD 13
406: #define ZEBRA_REDISTRIBUTE_DEFAULT_DELETE 14
407: #define ZEBRA_IPV4_NEXTHOP_LOOKUP 15
408: #define ZEBRA_IPV6_NEXTHOP_LOOKUP 16
409: #define ZEBRA_IPV4_IMPORT_LOOKUP 17
410: #define ZEBRA_IPV6_IMPORT_LOOKUP 18
411: #define ZEBRA_INTERFACE_RENAME 19
412: #define ZEBRA_ROUTER_ID_ADD 20
413: #define ZEBRA_ROUTER_ID_DELETE 21
414: #define ZEBRA_ROUTER_ID_UPDATE 22
1.1.1.2 misho 415: #define ZEBRA_HELLO 23
1.1.1.4 ! misho 416: #define ZEBRA_IPV4_NEXTHOP_LOOKUP_MRIB 24
! 417: #define ZEBRA_VRF_UNREGISTER 25
! 418: #define ZEBRA_MESSAGE_MAX 26
1.1 misho 419:
420: /* Marker value used in new Zserv, in the byte location corresponding
421: * the command value in the old zserv header. To allow old and new
422: * Zserv headers to be distinguished from each other.
423: */
424: #define ZEBRA_HEADER_MARKER 255
425:
1.1.1.2 misho 426: /* Zebra route's types are defined in route_types.h */
427: #include "route_types.h"
1.1 misho 428:
429: /* Note: whenever a new route-type or zserv-command is added the
430: * corresponding {command,route}_types[] table in lib/log.c MUST be
431: * updated! */
432:
433: /* Map a route type to a string. For example, ZEBRA_ROUTE_RIPNG -> "ripng". */
434: extern const char *zebra_route_string(unsigned int route_type);
435: /* Map a route type to a char. For example, ZEBRA_ROUTE_RIPNG -> 'R'. */
436: extern char zebra_route_char(unsigned int route_type);
437: /* Map a zserv command type to the same string,
438: * e.g. ZEBRA_INTERFACE_ADD -> "ZEBRA_INTERFACE_ADD" */
439: /* Map a protocol name to its number. e.g. ZEBRA_ROUTE_BGP->9*/
440: extern int proto_name2num(const char *s);
1.1.1.2 misho 441: /* Map redistribute X argument to protocol number.
442: * unlike proto_name2num, this accepts shorthands and takes
443: * an AFI value to restrict input */
444: extern int proto_redistnum(int afi, const char *s);
1.1 misho 445:
446: extern const char *zserv_command_string (unsigned int command);
447:
448: /* Error codes of zebra. */
449: #define ZEBRA_ERR_NOERROR 0
450: #define ZEBRA_ERR_RTEXIST -1
451: #define ZEBRA_ERR_RTUNREACH -2
452: #define ZEBRA_ERR_EPERM -3
453: #define ZEBRA_ERR_RTNOEXIST -4
454: #define ZEBRA_ERR_KERNEL -5
455:
456: /* Zebra message flags */
457: #define ZEBRA_FLAG_INTERNAL 0x01
458: #define ZEBRA_FLAG_SELFROUTE 0x02
459: #define ZEBRA_FLAG_BLACKHOLE 0x04
460: #define ZEBRA_FLAG_IBGP 0x08
461: #define ZEBRA_FLAG_SELECTED 0x10
1.1.1.4 ! misho 462: #define ZEBRA_FLAG_FIB_OVERRIDE 0x20
1.1 misho 463: #define ZEBRA_FLAG_STATIC 0x40
464: #define ZEBRA_FLAG_REJECT 0x80
465:
466: /* Zebra nexthop flags. */
467: #define ZEBRA_NEXTHOP_IFINDEX 1
468: #define ZEBRA_NEXTHOP_IFNAME 2
469: #define ZEBRA_NEXTHOP_IPV4 3
470: #define ZEBRA_NEXTHOP_IPV4_IFINDEX 4
471: #define ZEBRA_NEXTHOP_IPV4_IFNAME 5
472: #define ZEBRA_NEXTHOP_IPV6 6
473: #define ZEBRA_NEXTHOP_IPV6_IFINDEX 7
474: #define ZEBRA_NEXTHOP_IPV6_IFNAME 8
475: #define ZEBRA_NEXTHOP_BLACKHOLE 9
476:
477: #ifndef INADDR_LOOPBACK
478: #define INADDR_LOOPBACK 0x7f000001 /* Internet address 127.0.0.1. */
479: #endif
480:
481: /* Address family numbers from RFC1700. */
1.1.1.4 ! misho 482: typedef enum {
! 483: AFI_IP = 1,
! 484: AFI_IP6 = 2,
! 485: #define AFI_MAX 3
! 486: } afi_t;
1.1 misho 487:
488: /* Subsequent Address Family Identifier. */
489: #define SAFI_UNICAST 1
490: #define SAFI_MULTICAST 2
1.1.1.2 misho 491: #define SAFI_RESERVED_3 3
1.1 misho 492: #define SAFI_MPLS_VPN 4
1.1.1.4 ! misho 493: #define SAFI_ENCAP 7 /* per IANA */
! 494: #define SAFI_MAX 8
1.1 misho 495:
496: /* Default Administrative Distance of each protocol. */
497: #define ZEBRA_KERNEL_DISTANCE_DEFAULT 0
498: #define ZEBRA_CONNECT_DISTANCE_DEFAULT 0
499: #define ZEBRA_STATIC_DISTANCE_DEFAULT 1
500: #define ZEBRA_RIP_DISTANCE_DEFAULT 120
501: #define ZEBRA_RIPNG_DISTANCE_DEFAULT 120
502: #define ZEBRA_OSPF_DISTANCE_DEFAULT 110
503: #define ZEBRA_OSPF6_DISTANCE_DEFAULT 110
504: #define ZEBRA_ISIS_DISTANCE_DEFAULT 115
505: #define ZEBRA_IBGP_DISTANCE_DEFAULT 200
506: #define ZEBRA_EBGP_DISTANCE_DEFAULT 20
507:
508: /* Flag manipulation macros. */
509: #define CHECK_FLAG(V,F) ((V) & (F))
510: #define SET_FLAG(V,F) (V) |= (F)
511: #define UNSET_FLAG(V,F) (V) &= ~(F)
512:
513: typedef u_int8_t safi_t;
514:
515: /* Zebra types. Used in Zserv message header. */
516: typedef u_int16_t zebra_size_t;
517: typedef u_int16_t zebra_command_t;
518:
1.1.1.4 ! misho 519: /* VRF ID type. */
! 520: typedef u_int16_t vrf_id_t;
1.1 misho 521:
522: #endif /* _ZEBRA_H */
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>