(issue #10724)
[asterisk/asterisk.git] / main / dnsmgr.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2005-2006, Kevin P. Fleming
5  *
6  * Kevin P. Fleming <kpfleming@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief Background DNS update manager
22  *
23  * \author Kevin P. Fleming <kpfleming@digium.com> 
24  */
25
26 #include "asterisk.h"
27
28 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
29
30 #include <sys/types.h>
31 #include <netinet/in.h>
32 #include <sys/socket.h>
33 #include <arpa/inet.h>
34 #include <resolv.h>
35 #include <stdio.h>
36 #include <string.h>
37 #include <unistd.h>
38 #include <stdlib.h>
39 #include <regex.h>
40 #include <signal.h>
41
42 #include "asterisk/dnsmgr.h"
43 #include "asterisk/linkedlists.h"
44 #include "asterisk/utils.h"
45 #include "asterisk/config.h"
46 #include "asterisk/logger.h"
47 #include "asterisk/sched.h"
48 #include "asterisk/options.h"
49 #include "asterisk/cli.h"
50
51 static struct sched_context *sched;
52 static int refresh_sched = -1;
53 static pthread_t refresh_thread = AST_PTHREADT_NULL;
54
55 struct ast_dnsmgr_entry {
56         /*! where we will store the resulting address */
57         struct in_addr *result;
58         /*! the last result, used to check if address has changed */
59         struct in_addr last;
60         /*! Set to 1 if the entry changes */
61         int changed:1;
62         ast_mutex_t lock;
63         AST_RWLIST_ENTRY(ast_dnsmgr_entry) list;
64         /*! just 1 here, but we use calloc to allocate the correct size */
65         char name[1];
66 };
67
68 static AST_RWLIST_HEAD_STATIC(entry_list, ast_dnsmgr_entry);
69
70 AST_MUTEX_DEFINE_STATIC(refresh_lock);
71
72 #define REFRESH_DEFAULT 300
73
74 static int enabled;
75 static int refresh_interval;
76
77 struct refresh_info {
78         struct entry_list *entries;
79         int verbose;
80         unsigned int regex_present:1;
81         regex_t filter;
82 };
83
84 static struct refresh_info master_refresh_info = {
85         .entries = &entry_list,
86         .verbose = 0,
87 };
88
89 struct ast_dnsmgr_entry *ast_dnsmgr_get(const char *name, struct in_addr *result)
90 {
91         struct ast_dnsmgr_entry *entry;
92
93         if (!result || ast_strlen_zero(name) || !(entry = ast_calloc(1, sizeof(*entry) + strlen(name))))
94                 return NULL;
95
96         entry->result = result;
97         ast_mutex_init(&entry->lock);
98         strcpy(entry->name, name);
99         memcpy(&entry->last, result, sizeof(entry->last));
100
101         AST_RWLIST_WRLOCK(&entry_list);
102         AST_RWLIST_INSERT_HEAD(&entry_list, entry, list);
103         AST_RWLIST_UNLOCK(&entry_list);
104
105         return entry;
106 }
107
108 void ast_dnsmgr_release(struct ast_dnsmgr_entry *entry)
109 {
110         if (!entry)
111                 return;
112
113         AST_RWLIST_WRLOCK(&entry_list);
114         AST_RWLIST_REMOVE(&entry_list, entry, list);
115         AST_RWLIST_UNLOCK(&entry_list);
116         ast_verb(4, "removing dns manager for '%s'\n", entry->name);
117
118         ast_mutex_destroy(&entry->lock);
119         ast_free(entry);
120 }
121
122 int ast_dnsmgr_lookup(const char *name, struct in_addr *result, struct ast_dnsmgr_entry **dnsmgr)
123 {
124         struct ast_hostent ahp;
125         struct hostent *hp;
126
127         if (ast_strlen_zero(name) || !result || !dnsmgr)
128                 return -1;
129
130         if (*dnsmgr && !strcasecmp((*dnsmgr)->name, name))
131                 return 0;
132
133         ast_verb(4, "doing dnsmgr_lookup for '%s'\n", name);
134
135         /* if it's actually an IP address and not a name,
136            there's no need for a managed lookup */
137         if (inet_aton(name, result))
138                 return 0;
139
140         /* do a lookup now but add a manager so it will automagically get updated in the background */
141         if ((hp = ast_gethostbyname(name, &ahp)))
142                 memcpy(result, hp->h_addr, sizeof(result));
143         
144         /* if dnsmgr is not enable don't bother adding an entry */
145         if (!enabled)
146                 return 0;
147         
148         ast_verb(3, "adding dns manager for '%s'\n", name);
149         *dnsmgr = ast_dnsmgr_get(name, result);
150         return !*dnsmgr;
151 }
152
153 /*
154  * Refresh a dnsmgr entry
155  */
156 static int dnsmgr_refresh(struct ast_dnsmgr_entry *entry, int verbose)
157 {
158         struct ast_hostent ahp;
159         struct hostent *hp;
160         char iabuf[INET_ADDRSTRLEN];
161         char iabuf2[INET_ADDRSTRLEN];
162         struct in_addr tmp;
163         int changed = 0;
164         
165         ast_mutex_lock(&entry->lock);
166         if (verbose)
167                 ast_verb(3, "refreshing '%s'\n", entry->name);
168
169         if ((hp = ast_gethostbyname(entry->name, &ahp))) {
170                 /* check to see if it has changed, do callback if requested (where de callback is defined ????) */
171                 memcpy(&tmp, hp->h_addr, sizeof(tmp));
172                 if (tmp.s_addr != entry->last.s_addr) {
173                         ast_copy_string(iabuf, ast_inet_ntoa(entry->last), sizeof(iabuf));
174                         ast_copy_string(iabuf2, ast_inet_ntoa(tmp), sizeof(iabuf2));
175                         ast_log(LOG_NOTICE, "host '%s' changed from %s to %s\n", 
176                                 entry->name, iabuf, iabuf2);
177                         memcpy(entry->result, hp->h_addr, sizeof(entry->result));
178                         memcpy(&entry->last, hp->h_addr, sizeof(entry->last));
179                         changed = entry->changed = 1;
180                 } 
181                 
182         }
183         ast_mutex_unlock(&entry->lock);
184         return changed;
185 }
186
187 int ast_dnsmgr_refresh(struct ast_dnsmgr_entry *entry)
188 {
189         return dnsmgr_refresh(entry, 0);
190 }
191
192 /*
193  * Check if dnsmgr entry has changed from since last call to this function
194  */
195 int ast_dnsmgr_changed(struct ast_dnsmgr_entry *entry) 
196 {
197         int changed;
198
199         ast_mutex_lock(&entry->lock);
200
201         changed = entry->changed;
202         entry->changed = 0;
203
204         ast_mutex_unlock(&entry->lock);
205         
206         return changed;
207 }
208
209 static void *do_refresh(void *data)
210 {
211         for (;;) {
212                 pthread_testcancel();
213                 usleep((ast_sched_wait(sched)*1000));
214                 pthread_testcancel();
215                 ast_sched_runq(sched);
216         }
217         return NULL;
218 }
219
220 static int refresh_list(void *data)
221 {
222         struct refresh_info *info = data;
223         struct ast_dnsmgr_entry *entry;
224
225         /* if a refresh or reload is already in progress, exit now */
226         if (ast_mutex_trylock(&refresh_lock)) {
227                 if (info->verbose)
228                         ast_log(LOG_WARNING, "DNS Manager refresh already in progress.\n");
229                 return -1;
230         }
231
232         ast_verb(3, "Refreshing DNS lookups.\n");
233         AST_RWLIST_RDLOCK(info->entries);
234         AST_RWLIST_TRAVERSE(info->entries, entry, list) {
235                 if (info->regex_present && regexec(&info->filter, entry->name, 0, NULL, 0))
236                     continue;
237
238                 dnsmgr_refresh(entry, info->verbose);
239         }
240         AST_RWLIST_UNLOCK(info->entries);
241
242         ast_mutex_unlock(&refresh_lock);
243
244         /* automatically reschedule based on the interval */
245         return refresh_interval * 1000;
246 }
247
248 void dnsmgr_start_refresh(void)
249 {
250         if (refresh_sched > -1) {
251                 ast_sched_del(sched, refresh_sched);
252                 refresh_sched = ast_sched_add_variable(sched, 100, refresh_list, &master_refresh_info, 1);
253         }
254 }
255
256 static int do_reload(int loading);
257
258 static char *handle_cli_reload(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
259 {
260         switch (cmd) {
261         case CLI_INIT:
262                 e->command = "dnsmgr reload";
263                 e->usage = 
264                         "Usage: dnsmgr reload\n"
265                         "       Reloads the DNS manager configuration.\n";
266                 return NULL;
267         case CLI_GENERATE:
268                 return NULL;    
269         }
270         if (a->argc > 2)
271                 return CLI_SHOWUSAGE;
272
273         do_reload(0);
274         return CLI_SUCCESS;
275 }
276
277 static char *handle_cli_refresh(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
278 {
279         struct refresh_info info = {
280                 .entries = &entry_list,
281                 .verbose = 1,
282         };
283         switch (cmd) {
284         case CLI_INIT:
285                 e->command = "dnsmgr refresh";
286                 e->usage = 
287                         "Usage: dnsmgr refresh [pattern]\n"
288                         "       Peforms an immediate refresh of the managed DNS entries.\n"
289                         "       Optional regular expression pattern is used to filter the entries to refresh.\n";
290                 return NULL;
291         case CLI_GENERATE:
292                 return NULL;    
293         }
294         if (a->argc > 3)
295                 return CLI_SHOWUSAGE;
296
297         if (a->argc == 3) {
298                 if ( regcomp(&info.filter, a->argv[2], REG_EXTENDED | REG_NOSUB) )
299                         return CLI_SHOWUSAGE;
300                 else
301                         info.regex_present = 1;
302         }
303
304         refresh_list(&info);
305
306         if (info.regex_present)
307                 regfree(&info.filter);
308
309         return CLI_SUCCESS;
310 }
311
312 static char *handle_cli_status(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
313 {
314         int count = 0;
315         struct ast_dnsmgr_entry *entry;
316         switch (cmd) {
317         case CLI_INIT:
318                 e->command = "dnsmgr status";
319                 e->usage = 
320                         "Usage: dnsmgr status\n"
321                         "       Displays the DNS manager status.\n";
322                 return NULL;
323         case CLI_GENERATE:
324                 return NULL;    
325         }
326
327         if (a->argc > 2)
328                 return CLI_SHOWUSAGE;
329
330         ast_cli(a->fd, "DNS Manager: %s\n", enabled ? "enabled" : "disabled");
331         ast_cli(a->fd, "Refresh Interval: %d seconds\n", refresh_interval);
332         AST_RWLIST_RDLOCK(&entry_list);
333         AST_RWLIST_TRAVERSE(&entry_list, entry, list)
334                 count++;
335         AST_RWLIST_UNLOCK(&entry_list);
336         ast_cli(a->fd, "Number of entries: %d\n", count);
337
338         return CLI_SUCCESS;
339 }
340
341 static struct ast_cli_entry cli_reload = NEW_CLI(handle_cli_reload, "Reloads the DNS manager configuration");
342 static struct ast_cli_entry cli_refresh = NEW_CLI(handle_cli_refresh, "Performs an immediate refresh");
343 static struct ast_cli_entry cli_status = NEW_CLI(handle_cli_status, "Display the DNS manager status");
344
345 int dnsmgr_init(void)
346 {
347         if (!(sched = sched_context_create())) {
348                 ast_log(LOG_ERROR, "Unable to create schedule context.\n");
349                 return -1;
350         }
351         ast_cli_register(&cli_reload);
352         ast_cli_register(&cli_status);
353         ast_cli_register(&cli_refresh);
354         return do_reload(1);
355 }
356
357 int dnsmgr_reload(void)
358 {
359         return do_reload(0);
360 }
361
362 static int do_reload(int loading)
363 {
364         struct ast_config *config;
365         struct ast_flags config_flags = { loading ? 0 : CONFIG_FLAG_FILEUNCHANGED };
366         const char *interval_value;
367         const char *enabled_value;
368         int interval;
369         int was_enabled;
370         int res = -1;
371
372         if ((config = ast_config_load("dnsmgr.conf", config_flags)) == CONFIG_STATUS_FILEUNCHANGED)
373                 return 0;
374
375         /* ensure that no refresh cycles run while the reload is in progress */
376         ast_mutex_lock(&refresh_lock);
377
378         /* reset defaults in preparation for reading config file */
379         refresh_interval = REFRESH_DEFAULT;
380         was_enabled = enabled;
381         enabled = 0;
382
383         if (refresh_sched > -1)
384                 ast_sched_del(sched, refresh_sched);
385
386         if (config) {
387                 if ((enabled_value = ast_variable_retrieve(config, "general", "enable"))) {
388                         enabled = ast_true(enabled_value);
389                 }
390                 if ((interval_value = ast_variable_retrieve(config, "general", "refreshinterval"))) {
391                         if (sscanf(interval_value, "%d", &interval) < 1)
392                                 ast_log(LOG_WARNING, "Unable to convert '%s' to a numeric value.\n", interval_value);
393                         else if (interval < 0)
394                                 ast_log(LOG_WARNING, "Invalid refresh interval '%d' specified, using default\n", interval);
395                         else
396                                 refresh_interval = interval;
397                 }
398                 ast_config_destroy(config);
399         }
400
401         if (enabled && refresh_interval)
402                 ast_log(LOG_NOTICE, "Managed DNS entries will be refreshed every %d seconds.\n", refresh_interval);
403
404         /* if this reload enabled the manager, create the background thread
405            if it does not exist */
406         if (enabled) {
407                 if (!was_enabled && (refresh_thread == AST_PTHREADT_NULL)) {
408                         if (ast_pthread_create_background(&refresh_thread, NULL, do_refresh, NULL) < 0) {
409                                 ast_log(LOG_ERROR, "Unable to start refresh thread.\n");
410                         }
411                         ast_cli_register(&cli_refresh);
412                 }
413                 /* make a background refresh happen right away */
414                 refresh_sched = ast_sched_add_variable(sched, 100, refresh_list, &master_refresh_info, 1);
415                 res = 0;
416         }
417         /* if this reload disabled the manager and there is a background thread,
418            kill it */
419         else if (!enabled && was_enabled && (refresh_thread != AST_PTHREADT_NULL)) {
420                 /* wake up the thread so it will exit */
421                 pthread_cancel(refresh_thread);
422                 pthread_kill(refresh_thread, SIGURG);
423                 pthread_join(refresh_thread, NULL);
424                 refresh_thread = AST_PTHREADT_NULL;
425                 ast_cli_unregister(&cli_refresh);
426                 res = 0;
427         }
428         else
429                 res = 0;
430
431         ast_mutex_unlock(&refresh_lock);
432
433         return res;
434 }