General cleanups in header files
[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.37 2005/02/20 18:52:18 kattemat Exp $
40  */
41
42 #ifndef OLSR_PLUGIN
43
44 #ifndef _OLSR_DEFS
45 #define _OLSR_DEFS
46
47 /* Common includes */
48 #include <sys/time.h>
49 #include <sys/times.h>
50 #include <sys/socket.h>
51 #include <netinet/in.h>
52 #include <stdio.h>
53 #include <stdlib.h>
54 #include <string.h>
55 #include <unistd.h>
56 #include <errno.h>
57 #include <time.h>
58
59 #include "log.h"
60 #include "olsr_protocol.h"
61 #include "process_routes.h" /* Needed for rt_entry */
62 #include "net.h" /* IPaddr -> string conversions is used by everyone */
63 #include "olsr.h" /* Everybody uses theese */
64 #include "olsr_cfg.h"
65
66 #define VERSION "0.4.9-pre"
67 #define SOFTWARE_VERSION "olsr.org - " VERSION
68 #define OLSRD_VERSION_DATE "       *** " SOFTWARE_VERSION " (" __DATE__ ") ***\n"
69
70 #define OLSRD_CONF_FILE_NAME "olsrd.conf"
71 #define OLSRD_GLOBAL_CONF_FILE "/etc/" OLSRD_CONF_FILE_NAME
72
73 #define HOPCNT_MAX              16      /* maximum hops number */
74 #define MAXMESSAGESIZE          1500    /* max broadcast size */
75 #define UDP_IP_HDRSIZE          28
76 #define MAX_IFS                 16
77
78 /* Debug helper macro */
79 #ifdef DEBUG
80 #define olsr_debug(lvl,format,args...) \
81    olsr_printf(lvl, "%s (%s:%d): ", __func__, __FILE__, __LINE__); \
82    olsr_printf(lvl, format, ##args);
83 #endif
84
85
86 /*
87  * Global olsrd configuragtion
88  */
89
90 struct olsrd_config *olsr_cnf;
91
92 /* Global tick resolution */
93 olsr_u16_t system_tick_divider;
94
95 int exit_value; /* Global return value for process termination */
96
97
98 /* Timer data */
99 clock_t now_times;              /* current idea of times(2) reported uptime */
100 struct timeval now;             /* current idea of time */
101 struct tm *nowtm;               /* current idea of time (in tm) */
102
103 olsr_bool disp_pack_in;         /* display incoming packet content? */
104 olsr_bool disp_pack_out;        /* display outgoing packet content? */
105
106 olsr_bool del_gws;
107
108 /*
109  * Timer values
110  */
111
112 extern float will_int;
113 extern float dup_hold_time;
114 extern float max_jitter;
115
116 size_t ipsize;
117
118 /*
119  * Address of this hosts OLSR interfaces
120  * and main address of this node
121  * and number of OLSR interfaces on this host
122  */
123 union olsr_ip_addr main_addr;
124 /*
125  * OLSR UPD port
126  */
127 int olsr_udp_port;
128
129 /* The socket used for all ioctls */
130 int ioctl_s;
131
132 /* routing socket */
133 #if defined __FreeBSD__ || defined __MacOSX__ || defined __NetBSD__
134 int rts;
135 #endif
136
137 float max_tc_vtime;
138
139 clock_t fwdtimer[MAX_IFS];      /* forwarding timer */
140
141 int minsize;
142
143 olsr_bool changes;                /* is set if changes occur in MPRS set */ 
144
145 /* TC empty message sending */
146 extern clock_t send_empty_tc;
147
148 /*
149  *IPC functions
150  *These are moved to a plugin soon
151  * soon... duh!
152  */
153
154 int
155 ipc_init(void);
156
157 int
158 ipc_input(int);
159
160 int
161 shutdown_ipc(void);
162
163 int
164 ipc_output(struct olsr *);
165
166 int
167 ipc_send_net_info(void);
168
169 int
170 ipc_route_send_rtentry(union olsr_ip_addr*, union olsr_ip_addr *, int, int, char *);
171
172
173
174 #endif
175 #endif