Several small refactorings. Split log-group of network scheduler and timer scheduler
[olsrd.git] / lib / nameservice / src / nameservice.h
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004-2009, the olsr.org team - see HISTORY file
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  *   notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright
14  *   notice, this list of conditions and the following disclaimer in
15  *   the documentation and/or other materials provided with the
16  *   distribution.
17  * * Neither the name of olsr.org, olsrd nor the names of its
18  *   contributors may be used to endorse or promote products derived
19  *   from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *
34  * Visit http://www.olsr.org for more information.
35  *
36  * If you find this software useful feel free to make a donation
37  * to the project. For more information see the website or contact
38  * the copyright holders.
39  *
40  */
41
42
43 /*
44  * Dynamic linked library for UniK OLSRd
45  */
46
47 #ifndef _NAMESERVICE_PLUGIN
48 #define _NAMESERVICE_PLUGIN
49
50 #include <regex.h>
51
52 #include "olsr_types.h"
53 #include "interfaces.h"
54 #include "olsr_protocol.h"
55 #include "common/list.h"
56 #include "duplicate_set.h"
57 #include "plugin.h"
58 #include "nameservice_msg.h"
59 #include "hashing.h"
60 #include "mapwrite.h"
61 #include "olsr_time.h"
62
63 #define PLUGIN_NAME     "OLSRD nameservice plugin"
64 #define PLUGIN_VERSION  "0.3"
65 #define PLUGIN_AUTHOR   "Bruno Randolf, Jens Nachtigall, Sven-Ola Tuecke"
66
67 #define MESSAGE_TYPE            130
68 #define PARSER_TYPE             MESSAGE_TYPE
69 #define EMISSION_INTERVAL       120     /* seconds */
70 #define EMISSION_JITTER         25      /* percent */
71 #define NAME_VALID_TIME         1800    /* seconds */
72 #define NAMESERVER_COUNT        3
73
74 #define NAME_PROTOCOL_VERSION   1
75
76 #define MAX_NAME 127
77 #define MAX_FILE 255
78 #define MAX_SUFFIX 63
79
80 #define MID_ENTRIES 1
81 #define MID_MAXLEN 16
82 #define MID_PREFIX "mid%i."
83
84 /**
85  * a linked list of name_entry
86  * if type is NAME_HOST, name is a hostname and ip its IP addr
87  * if type is NAME_FORWARDER, then ip is a dns-server (and name is irrelevant)
88  * if type is NAME_SERVICE, then name is a service-line (and the ip is irrelevant)
89  * if type is NAME_LATLON, then name has 2 floats with lat and lon (and the ip is irrelevant)
90  */
91 struct name_entry {
92   union olsr_ip_addr ip;
93   uint16_t type;
94   uint16_t len;
95   char *name;
96   struct name_entry *next;             /* linked list */
97 };
98
99 /* *
100  * linked list of db_entries for each originator with
101  * originator being its router_id
102  *
103  * names points to the name_entry with its hostname, dns-server or
104  * service-line entry
105  *
106  * all the db_entries are hashed in nameservice.c to avoid a too long list
107  * for many nodes in a net
108  *
109  * */
110 struct db_entry {
111   union olsr_ip_addr originator;       /* IP address of the node this entry describes */
112   struct timer_entry *db_timer;        /* Validity time */
113   struct name_entry *names;            /* list of names this originator declares */
114   struct list_entity db_list;            /* linked list of db entries per hash container */
115 };
116
117
118 #define OLSR_NAMESVC_DB_JITTER 5        /* percent */
119
120 extern struct name_entry *my_names;
121 extern struct list_entity latlon_list[HASHSIZE];
122 extern float my_lat, my_lon;
123 extern struct olsr_cookie_info *map_poll_timer_cookie;
124
125 void olsr_expire_write_file_timer(void *);
126 void olsr_namesvc_delete_db_entry(struct db_entry *);
127
128 /* Parser function to register with the sceduler */
129 void olsr_parser(struct olsr_message *, struct interface *, union olsr_ip_addr *, enum duplicate_status);
130
131 /* callback for periodic timer */
132 void olsr_namesvc_gen(void *);
133
134 int
135   encap_namemsg(struct namemsg *);
136
137 struct name_entry *add_name_to_list(struct name_entry *my_list, const char *value, int type, const union olsr_ip_addr *ip);
138
139 struct name_entry *remove_nonvalid_names_from_list(struct name_entry *my_list, int type);
140
141 void
142   free_all_listold_entries(struct list_entity *);
143
144 void
145   decap_namemsg(const struct name *from_packet, struct name_entry **to, bool * this_table_changed);
146
147 void
148   insert_new_name_in_list(union olsr_ip_addr *, struct list_entity *, const struct name *, bool *, uint32_t);
149
150 bool allowed_hostname_or_ip_in_service(const char *service_line, const regmatch_t * hostname_or_ip);
151
152 void
153   update_name_entry(union olsr_ip_addr *, const struct namemsg *, const uint8_t *, uint32_t);
154
155 void
156   write_hosts_file(void);
157
158 void
159   write_services_file(bool writemacs);
160
161 void
162   write_resolv_file(void);
163
164 int
165   register_olsr_param(char *key, char *value);
166
167 void
168   free_name_entry_list(struct name_entry **list);
169
170 bool allowed_ip(const union olsr_ip_addr *addr);
171
172 bool allowed_service(const char *service_line);
173
174 bool is_name_wellformed(const char *service_line);
175
176 bool is_service_wellformed(const char *service_line);
177
178 bool is_mac_wellformed(const char *service_line);
179
180 bool is_latlon_wellformed(const char *latlon_line);
181
182 bool get_isdefhna_latlon(void);
183
184 void
185   lookup_defhna_latlon(union olsr_ip_addr *ip);
186
187 const char *lookup_name_latlon(union olsr_ip_addr *ip);
188
189 void
190   write_latlon_file(void);
191
192 char *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
204
205
206 /*
207  * Local Variables:
208  * c-basic-offset: 2
209  * indent-tabs-mode: nil
210  * End:
211  */