move avl and list library into src/common
[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  
33 /*
34  * Dynamic linked library for UniK OLSRd
35  */
36
37 #ifndef _NAMESERVICE_PLUGIN
38 #define _NAMESERVICE_PLUGIN
39
40 #include <sys/time.h>
41 #include <regex.h>
42
43 #include "olsr_types.h"
44 #include "interfaces.h"
45 #include "olsr_protocol.h"
46 #include "common/list.h"
47
48 #include "olsrd_plugin.h"
49 #include "nameservice_msg.h"
50 #include "hashing.h"
51 #include "mapwrite.h"
52
53 #define PLUGIN_NAME     "OLSRD nameservice plugin"
54 #define PLUGIN_VERSION  "0.3"
55 #define PLUGIN_AUTHOR   "Bruno Randolf, Jens Nachtigall, Sven-Ola Tuecke"
56
57 // useful to set for the freifunkfirmware to remove all
58 // calls to olsr_printf by the empty statement ";"
59 //#define olsr_printf(...) ;
60
61 #define MESSAGE_TYPE            130
62 #define PARSER_TYPE             MESSAGE_TYPE
63 #define EMISSION_INTERVAL       120 /* seconds */
64 #define EMISSION_JITTER         25 /* percent */
65 #define NAME_VALID_TIME         1800 /* seconds */
66 #define NAMESERVER_COUNT        3
67
68 #define NAME_PROTOCOL_VERSION   1
69
70 #define MAX_NAME 127
71 #define MAX_FILE 255
72 #define MAX_SUFFIX 63
73
74 #define MID_ENTRIES 1
75 #define MID_MAXLEN 16
76 #define MID_PREFIX "mid%i."
77
78 /**
79  * a linked list of name_entry
80  * if type is NAME_HOST, name is a hostname and ip its IP addr
81  * if type is NAME_FORWARDER, then ip is a dns-server (and name is irrelevant)
82  * if type is NAME_SERVICE, then name is a service-line (and the ip is irrelevant)
83  * if type is NAME_LATLON, then name has 2 floats with lat and lon (and the ip is irrelevant)
84  */
85 struct name_entry
86 {
87         union olsr_ip_addr      ip;
88         olsr_u16_t              type;
89         olsr_u16_t              len;
90         char                    *name;
91         struct name_entry       *next;          /* linked list */
92 };
93
94 /* *
95  * linked list of db_entries for each originator with
96  * originator being its main_addr
97  * 
98  * names points to the name_entry with its hostname, dns-server or
99  * service-line entry
100  *
101  * all the db_entries are hashed in nameservice.c to avoid a too long list
102  * for many nodes in a net
103  *
104  * */
105 struct db_entry
106 {
107         union olsr_ip_addr      originator;     /* IP address of the node this entry describes */
108         struct timer_entry      *db_timer;      /* Validity time */
109         struct name_entry       *names;         /* list of names this originator declares */
110         struct list_node        db_list;        /* linked list of db entries per hash container */
111 };
112
113 /* inline to recast from db_list back to db_entry */
114 LISTNODE2STRUCT(list2db, struct db_entry, db_list);
115
116 #define OLSR_NAMESVC_DB_JITTER 5 /* percent */
117
118 extern struct name_entry *my_names;
119 extern struct list_node latlon_list[HASHSIZE];
120 extern float my_lat, my_lon;
121
122 void olsr_expire_write_file_timer(void *);
123 void olsr_namesvc_delete_db_entry(struct db_entry *);
124
125 /* Parser function to register with the sceduler */
126 void
127 olsr_parser(union olsr_message *, struct interface *, union olsr_ip_addr *);
128
129 /* callback for periodic timer */
130 void olsr_namesvc_gen(void *);
131
132 int
133 encap_namemsg(struct namemsg *);
134
135 struct name_entry*
136 add_name_to_list(struct name_entry *my_list, const char *value, int type, const union olsr_ip_addr *ip);
137
138 struct name_entry*
139 remove_nonvalid_names_from_list(struct name_entry *my_list, int type);
140
141 void 
142 free_all_list_entries(struct list_node *) ;
143
144 void
145 decap_namemsg(struct name *from_packet, struct name_entry **to, olsr_bool *this_table_changed );
146
147 void
148 insert_new_name_in_list(union olsr_ip_addr *, struct list_node *,
149                         struct name *, olsr_bool *, double);
150
151 olsr_bool
152 allowed_hostname_or_ip_in_service(const char *service_line, const regmatch_t *hostname_or_ip);
153
154 void
155 update_name_entry(union olsr_ip_addr *, struct namemsg *, int, double);
156
157 void
158 write_hosts_file(void);
159
160 void
161 write_services_file(void);
162
163 void
164 write_resolv_file(void);
165
166 int
167 register_olsr_param(char *key, char *value);
168
169 void 
170 free_name_entry_list(struct name_entry **list);
171
172 olsr_bool
173 allowed_ip(const union olsr_ip_addr *addr);
174
175 olsr_bool
176 allowed_service(const char *service_line);
177
178 olsr_bool
179 is_name_wellformed(const char *service_line);
180
181 olsr_bool
182 is_service_wellformed(const char *service_line);
183
184 olsr_bool
185 is_service_wellformed(const char *service_line);
186
187 olsr_bool
188 is_latlon_wellformed(const char *latlon_line);
189
190 olsr_bool
191 get_isdefhna_latlon(void);
192
193 void
194 lookup_defhna_latlon(union olsr_ip_addr *ip);
195
196 const char*
197 lookup_name_latlon(union olsr_ip_addr *ip);
198
199 void
200 write_latlon_file(void);
201
202 char*  
203 create_packet(struct name *to, struct name_entry *from);
204
205 void
206 name_constructor(void);
207
208 void
209 name_destructor(void);
210
211 int
212 name_init(void);
213
214 #endif
215