* applied rt-refactoring-6.diff from Hannes Gredler <hannes@gredler.at>
[olsrd.git] / lib / nameservice / src / nameservice.h
1 /*
2  * Copyright (c) 2005, Bruno Randolf <bruno.randolf@4g-systems.biz>
3  * Copyright (c) 2004, Andreas T√łnnesen(andreto-at-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 notice, 
11  *   this list of conditions and the following disclaimer.
12  * * Redistributions in binary form must reproduce the above copyright notice, 
13  *   this list of conditions and the following disclaimer in the documentation 
14  *   and/or other materials provided with the distribution.
15  * * Neither the name of the UniK olsr daemon nor the names of its contributors 
16  *   may be used to endorse or promote products derived from this software 
17  *   without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
21  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
22  * IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
23  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
24  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY 
26  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
27  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 
28  * OF THE POSSIBILITY OF SUCH DAMAGE.
29  *
30  */
31
32 /* $Id: nameservice.h,v 1.13 2007/09/05 16:11:10 bernd67 Exp $ */
33  
34 /*
35  * Dynamic linked library for UniK OLSRd
36  */
37
38 #ifndef _NAMESERVICE_PLUGIN
39 #define _NAMESERVICE_PLUGIN
40
41 #include <sys/time.h>
42 #include <regex.h>
43
44 #include "olsr_types.h"
45 #include "interfaces.h"
46 #include "olsr_protocol.h"
47
48 #include "olsrd_plugin.h"
49 #include "nameservice_msg.h"
50
51 #define PLUGIN_NAME     "OLSRD nameservice plugin"
52 #define PLUGIN_VERSION  "0.3"
53 #define PLUGIN_AUTHOR   "Bruno Randolf, Jens Nachtigall, Sven-Ola"
54
55 // useful to set for the freifunkfirmware to remove all
56 // calls to olsr_printf by the empty statement ";"
57 //#define olsr_printf(...) ;
58
59 #define MESSAGE_TYPE            130
60 #define PARSER_TYPE             MESSAGE_TYPE
61 #define EMISSION_INTERVAL       120 /* two minutes */
62 #define NAME_VALID_TIME         1800 /* half one hour */
63 #define NAMESERVER_COUNT        3
64
65 #define NAME_PROTOCOL_VERSION   1
66
67 #define MAX_NAME 127
68 #define MAX_FILE 255
69 #define MAX_SUFFIX 63
70
71 /**
72  * a linked list of name_entry
73  * if type is NAME_HOST, name is a hostname and ip its IP addr
74  * if type is NAME_FORWARDER, then ip is a dns-server (and name is irrelevant)
75  * if type is NAME_SERVICE, then name is a service-line (and the ip is irrelevant)
76  * if type is NAME_LATLON, then name has 2 floats with lat and lon (and the ip is irrelevant)
77  */
78 struct name_entry
79 {
80         union olsr_ip_addr      ip;
81         olsr_u16_t              type;
82         olsr_u16_t              len;
83         char                    *name;
84         struct name_entry       *next;          /* linked list */
85 };
86
87 /* *
88  * linked list of db_entries for each originator with
89  * originator being its main_addr
90  * 
91  * names points to the name_entry with its hostname, dns-server or
92  * service-line entry
93  *
94  * all the db_entries are hashed in nameservice.c to avoid a too long list
95  * for many nodes in a net
96  *
97  * */
98 struct db_entry
99 {
100         union olsr_ip_addr      originator;     /* IP address of the node this entry describes */
101         struct timeval          timer;          /* Validity time */
102         struct name_entry       *names;         /* list of names this originator declares */
103         struct db_entry         *next;          /* linked list */
104 };
105
106
107 /* Timeout function to register with the sceduler */
108 void
109 olsr_timeout(void);
110
111 /* Parser function to register with the sceduler */
112 void
113 olsr_parser(union olsr_message *, struct interface *, union olsr_ip_addr *);
114
115 /* Event function to register with the sceduler */
116 void
117 olsr_event(void *);
118
119 int
120 encap_namemsg(struct namemsg *);
121
122 struct name_entry*
123 add_name_to_list(struct name_entry *my_list, char *value, int type, const union olsr_ip_addr *ip);
124
125 struct name_entry*
126 remove_nonvalid_names_from_list(struct name_entry *my_list, int type);
127
128 void 
129 free_all_list_entries(struct db_entry **this_db_list) ;
130
131 void
132 timeout_old_names(struct db_entry **this_list, olsr_bool *this_table_changed);
133
134 void
135 decap_namemsg(struct name *from_packet, struct name_entry **to, olsr_bool *this_table_changed );
136
137 void
138 insert_new_name_in_list(union olsr_ip_addr *originator, struct db_entry **this_list, struct name *from_packet, olsr_bool *this_table_changed, double vtime);
139
140 olsr_bool
141 allowed_hostname_or_ip_in_service(char *service_line, regmatch_t *hostname_or_ip);
142
143 void
144 update_name_entry(union olsr_ip_addr *, struct namemsg *, int, double);
145
146 void
147 write_hosts_file(void);
148
149 void
150 write_services_file(void);
151
152 void
153 write_resolv_file(void);
154
155 int
156 register_olsr_param(char *key, char *value);
157
158 void 
159 free_name_entry_list(struct name_entry **list);
160
161 olsr_bool
162 allowed_ip(union olsr_ip_addr *addr);
163
164 olsr_bool
165 allowed_service(char *service_line);
166
167 olsr_bool
168 is_name_wellformed(char *service_line);
169
170 olsr_bool
171 is_service_wellformed(char *service_line);
172
173 olsr_bool
174 is_service_wellformed(char *service_line);
175
176 olsr_bool
177 is_latlon_wellformed(char *latlon_line);
178
179 olsr_bool
180 get_isdefhna_latlon(void);
181
182 void
183 lookup_defhna_latlon(union olsr_ip_addr *ip);
184
185 char*
186 lookup_name_latlon(union olsr_ip_addr *ip);
187
188 void
189 write_latlon_file(void);
190
191 char*  
192 create_packet(struct name *to, struct name_entry *from);
193
194 void
195 name_constructor(void);
196
197 void
198 name_destructor(void);
199
200 int
201 name_init(void);
202
203 #endif