* cosmetic
[olsrd.git] / src / defs.h
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3  * Copyright (c) 2004, Andreas T√łnnesen(andreto@olsr.org)
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without 
7  * modification, are permitted provided that the following conditions 
8  * are met:
9  *
10  * * Redistributions of source code must retain the above copyright 
11  *   notice, this list of conditions and the following disclaimer.
12  * * Redistributions in binary form must reproduce the above copyright 
13  *   notice, this list of conditions and the following disclaimer in 
14  *   the documentation and/or other materials provided with the 
15  *   distribution.
16  * * Neither the name of olsr.org, olsrd nor the names of its 
17  *   contributors may be used to endorse or promote products derived 
18  *   from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
24  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
30  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
31  * POSSIBILITY OF SUCH DAMAGE.
32  *
33  * Visit http://www.olsr.org for more information.
34  *
35  * If you find this software useful feel free to make a donation
36  * to the project. For more information see the website or contact
37  * the copyright holders.
38  *
39  * $Id: defs.h,v 1.60 2007/05/02 08:06:28 bernd67 Exp $
40  */
41
42
43 #ifndef _OLSR_DEFS
44 #define _OLSR_DEFS
45
46 /* Common includes */
47 #include <sys/time.h>
48 #include <sys/times.h>
49 #include <sys/socket.h>
50 #include <netinet/in.h>
51 #include <stdio.h>
52 #include <stdlib.h>
53 #include <string.h>
54 #include <unistd.h>
55 #include <errno.h>
56 #include <time.h>
57
58 #include "olsr_protocol.h"
59 #include "net_olsr.h" /* IPaddr -> string conversions is used by everyone */
60 #include "olsr_cfg.h"
61
62 #define SOFTWARE_VERSION        "olsr.org - " VERSION
63 #define OLSRD_VERSION_DATE      "       *** " SOFTWARE_VERSION " (" __DATE__ ") ***\n"
64
65 #ifndef OLSRD_GLOBAL_CONF_FILE
66 #define OLSRD_CONF_FILE_NAME    "olsrd.conf"
67 #define OLSRD_GLOBAL_CONF_FILE  "/etc/" OLSRD_CONF_FILE_NAME
68 #endif
69
70 #define MAXMESSAGESIZE          1500    /* max broadcast size */
71 #define UDP_IPV4_HDRSIZE        28
72 #define UDP_IPV6_HDRSIZE        62
73
74 #define MIN_PACKET_SIZE(ver)    ((int)(sizeof(olsr_u8_t) * (((ver) == AF_INET) ? 4 : 7)))
75 /* Debug helper macro */
76 #ifdef DEBUG
77 #define olsr_debug(lvl, format, args...) do {                           \
78     OLSR_PRINTF(lvl, "%s (%s:%d): ", __func__, __FILE__, __LINE__);     \
79     OLSR_PRINTF(lvl, (format), ##args);                                 \
80   } while (0)
81 #endif
82
83 extern FILE *debug_handle;
84
85 #ifdef NODEBUG
86 #define OLSR_PRINTF(lvl, format, args...) do { } while(0)
87 #else
88 #define OLSR_PRINTF(lvl, format, args...) do {                  \
89     if((olsr_cnf->debug_level >= (lvl)) && debug_handle)          \
90       fprintf(debug_handle, (format), ##args);                    \
91   } while (0)
92 #endif
93
94 /* Provides a timestamp s1 milliseconds in the future
95    according to system ticks returned by times(2) */
96 #define GET_TIMESTAMP(s1)       (now_times + ((s1) / olsr_cnf->system_tick_divider))
97
98 #define TIMED_OUT(s1)   ((int)((s1) - now_times) < 0)
99
100
101 #define ARRAYSIZE(x)    (sizeof(x)/sizeof(*(x)))
102
103 /*
104  * Queueing macros
105  */
106
107 /* First "argument" is NOT a pointer! */
108
109 #define QUEUE_ELEM(pre, new) do { \
110     pre.next->prev = new;         \
111     new->next = pre.next;         \
112     new->prev = &pre;             \
113     pre.next = new;               \
114   } while (0)
115
116 #define DEQUEUE_ELEM(elem) do { \
117     elem->prev->next = elem->next;     \
118     elem->next->prev = elem->prev;     \
119   } while (0)
120
121
122 #define CLOSE(fd)  do { close(fd); (fd) = -1; } while (0)
123
124 /*
125  * Global olsrd configuragtion
126  */
127
128 extern struct olsrd_config *olsr_cnf;
129
130 /* Timer data */
131 extern clock_t now_times;              /* current idea of times(2) reported uptime */
132 extern struct timeval now;             /* current idea of time */
133 extern struct tm *nowtm;               /* current idea of time (in tm) */
134
135 /*
136  *IPC functions
137  *These are moved to a plugin soon
138  * soon... duh!
139  */
140
141 int
142 ipc_init(void);
143
144 #if 0
145 int
146 ipc_input(int);
147 #endif
148
149 int
150 shutdown_ipc(void);
151
152 int
153 ipc_output(struct olsr *);
154
155 int
156 ipc_route_send_rtentry(union olsr_ip_addr*, union olsr_ip_addr *, int, int, char *);
157
158 #endif