Fix dnsmgr entries to ask for the same address family each time.
[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  * \bug There is a minor race condition.  In the event that an IP address
26  * of a dnsmgr managed host changes, there is the potential for the consumer
27  * of that address to access the in_addr data at the same time that the dnsmgr
28  * thread is in the middle of updating it to the new address.
29  */
30
31 #include "asterisk.h"
32
33 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
34
35 #include "asterisk/_private.h"
36 #include <regex.h>
37 #include <signal.h>
38
39 #include "asterisk/dnsmgr.h"
40 #include "asterisk/linkedlists.h"
41 #include "asterisk/utils.h"
42 #include "asterisk/config.h"
43 #include "asterisk/sched.h"
44 #include "asterisk/cli.h"
45 #include "asterisk/manager.h"
46 #include "asterisk/acl.h"
47
48 static struct ast_sched_context *sched;
49 static int refresh_sched = -1;
50 static pthread_t refresh_thread = AST_PTHREADT_NULL;
51
52 struct ast_dnsmgr_entry {
53         /*! where we will store the resulting IP address and port number */
54         struct ast_sockaddr *result;
55         /*! SRV record to lookup, if provided. Composed of service, protocol, and domain name: _Service._Proto.Name */
56         char *service;
57         /*! Address family to filter DNS responses. */
58         unsigned int family;
59         /*! Set to 1 if the entry changes */
60         unsigned int changed:1;
61         ast_mutex_t lock;
62         AST_RWLIST_ENTRY(ast_dnsmgr_entry) list;
63         /*! just 1 here, but we use calloc to allocate the correct size */
64         char name[1];
65 };
66
67 static AST_RWLIST_HEAD_STATIC(entry_list, ast_dnsmgr_entry);
68
69 AST_MUTEX_DEFINE_STATIC(refresh_lock);
70
71 #define REFRESH_DEFAULT 300
72
73 static int enabled;
74 static int refresh_interval;
75
76 struct refresh_info {
77         struct entry_list *entries;
78         int verbose;
79         unsigned int regex_present:1;
80         regex_t filter;
81 };
82
83 static struct refresh_info master_refresh_info = {
84         .entries = &entry_list,
85         .verbose = 0,
86 };
87
88 struct ast_dnsmgr_entry *ast_dnsmgr_get_family(const char *name, struct ast_sockaddr *result, const char *service, unsigned int family)
89 {
90         struct ast_dnsmgr_entry *entry;
91         int total_size = sizeof(*entry) + strlen(name) + (service ? strlen(service) + 1 : 0);
92
93         if (!result || ast_strlen_zero(name) || !(entry = ast_calloc(1, total_size))) {
94                 return NULL;
95         }
96
97         entry->result = result;
98         ast_mutex_init(&entry->lock);
99         strcpy(entry->name, name);
100         if (service) {
101                 entry->service = ((char *) entry) + sizeof(*entry) + strlen(name);
102                 strcpy(entry->service, service);
103         }
104         entry->family = family;
105
106         AST_RWLIST_WRLOCK(&entry_list);
107         AST_RWLIST_INSERT_HEAD(&entry_list, entry, list);
108         AST_RWLIST_UNLOCK(&entry_list);
109
110         return entry;
111 }
112
113 struct ast_dnsmgr_entry *ast_dnsmgr_get(const char *name, struct ast_sockaddr *result, const char *service)
114 {
115         return ast_dnsmgr_get_family(name, result, service, 0);
116 }
117
118 void ast_dnsmgr_release(struct ast_dnsmgr_entry *entry)
119 {
120         if (!entry) {
121                 return;
122         }
123
124         AST_RWLIST_WRLOCK(&entry_list);
125         AST_RWLIST_REMOVE(&entry_list, entry, list);
126         AST_RWLIST_UNLOCK(&entry_list);
127         ast_verb(4, "removing dns manager for '%s'\n", entry->name);
128
129         ast_mutex_destroy(&entry->lock);
130         ast_free(entry);
131 }
132
133 int ast_dnsmgr_lookup(const char *name, struct ast_sockaddr *result, struct ast_dnsmgr_entry **dnsmgr, const char *service)
134 {
135         unsigned int family;
136
137         if (ast_strlen_zero(name) || !result || !dnsmgr) {
138                 return -1;
139         }
140
141         if (*dnsmgr && !strcasecmp((*dnsmgr)->name, name)) {
142                 return 0;
143         }
144
145         /* Lookup address family filter. */
146         family = result->ss.ss_family;
147
148         /*
149          * If it's actually an IP address and not a name, there's no
150          * need for a managed lookup.
151          */
152         if (ast_sockaddr_parse(result, name, PARSE_PORT_FORBID)) {
153                 return 0;
154         }
155
156         ast_verb(4, "doing dnsmgr_lookup for '%s'\n", name);
157
158         /* do a lookup now but add a manager so it will automagically get updated in the background */
159         ast_get_ip_or_srv(result, name, service);
160
161         /* if dnsmgr is not enable don't bother adding an entry */
162         if (!enabled) {
163                 return 0;
164         }
165
166         ast_verb(3, "adding dns manager for '%s'\n", name);
167         *dnsmgr = ast_dnsmgr_get_family(name, result, service, family);
168         return !*dnsmgr;
169 }
170
171 /*
172  * Refresh a dnsmgr entry
173  */
174 static int dnsmgr_refresh(struct ast_dnsmgr_entry *entry, int verbose)
175 {
176         struct ast_sockaddr tmp = { .len = 0, };
177         int changed = 0;
178
179         ast_mutex_lock(&entry->lock);
180
181         if (verbose) {
182                 ast_verb(3, "refreshing '%s'\n", entry->name);
183         }
184
185         tmp.ss.ss_family = entry->family;
186         if (!ast_get_ip_or_srv(&tmp, entry->name, entry->service)) {
187                 if (!ast_sockaddr_port(&tmp)) {
188                         ast_sockaddr_set_port(&tmp, ast_sockaddr_port(entry->result));
189                 }
190
191                 if (ast_sockaddr_cmp(&tmp, entry->result)) {
192                         const char *old_addr = ast_strdupa(ast_sockaddr_stringify(entry->result));
193                         const char *new_addr = ast_strdupa(ast_sockaddr_stringify(&tmp));
194
195                         ast_log(LOG_NOTICE, "dnssrv: host '%s' changed from %s to %s\n",
196                                         entry->name, old_addr, new_addr);
197
198                         ast_sockaddr_copy(entry->result, &tmp);
199                         changed = entry->changed = 1;
200                 }
201         }
202
203         ast_mutex_unlock(&entry->lock);
204
205         return changed;
206 }
207
208 int ast_dnsmgr_refresh(struct ast_dnsmgr_entry *entry)
209 {
210         return dnsmgr_refresh(entry, 0);
211 }
212
213 /*
214  * Check if dnsmgr entry has changed from since last call to this function
215  */
216 int ast_dnsmgr_changed(struct ast_dnsmgr_entry *entry)
217 {
218         int changed;
219
220         ast_mutex_lock(&entry->lock);
221
222         changed = entry->changed;
223         entry->changed = 0;
224
225         ast_mutex_unlock(&entry->lock);
226
227         return changed;
228 }
229
230 static void *do_refresh(void *data)
231 {
232         for (;;) {
233                 pthread_testcancel();
234                 usleep((ast_sched_wait(sched)*1000));
235                 pthread_testcancel();
236                 ast_sched_runq(sched);
237         }
238         return NULL;
239 }
240
241 static int refresh_list(const void *data)
242 {
243         struct refresh_info *info = (struct refresh_info *)data;
244         struct ast_dnsmgr_entry *entry;
245
246         /* if a refresh or reload is already in progress, exit now */
247         if (ast_mutex_trylock(&refresh_lock)) {
248                 if (info->verbose) {
249                         ast_log(LOG_WARNING, "DNS Manager refresh already in progress.\n");
250                 }
251                 return -1;
252         }
253
254         ast_verb(3, "Refreshing DNS lookups.\n");
255         AST_RWLIST_RDLOCK(info->entries);
256         AST_RWLIST_TRAVERSE(info->entries, entry, list) {
257                 if (info->regex_present && regexec(&info->filter, entry->name, 0, NULL, 0)) {
258                         continue;
259                 }
260
261                 dnsmgr_refresh(entry, info->verbose);
262         }
263         AST_RWLIST_UNLOCK(info->entries);
264
265         ast_mutex_unlock(&refresh_lock);
266
267         /* automatically reschedule based on the interval */
268         return refresh_interval * 1000;
269 }
270
271 void dnsmgr_start_refresh(void)
272 {
273         if (refresh_sched > -1) {
274                 AST_SCHED_DEL(sched, refresh_sched);
275                 refresh_sched = ast_sched_add_variable(sched, 100, refresh_list, &master_refresh_info, 1);
276         }
277 }
278
279 static int do_reload(int loading);
280
281 static char *handle_cli_reload(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
282 {
283         switch (cmd) {
284         case CLI_INIT:
285                 e->command = "dnsmgr reload";
286                 e->usage =
287                         "Usage: dnsmgr reload\n"
288                         "       Reloads the DNS manager configuration.\n";
289                 return NULL;
290         case CLI_GENERATE:
291                 return NULL;
292         }
293         if (a->argc > 2) {
294                 return CLI_SHOWUSAGE;
295         }
296
297         do_reload(0);
298         return CLI_SUCCESS;
299 }
300
301 static char *handle_cli_refresh(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
302 {
303         struct refresh_info info = {
304                 .entries = &entry_list,
305                 .verbose = 1,
306         };
307         switch (cmd) {
308         case CLI_INIT:
309                 e->command = "dnsmgr refresh";
310                 e->usage =
311                         "Usage: dnsmgr refresh [pattern]\n"
312                         "       Peforms an immediate refresh of the managed DNS entries.\n"
313                         "       Optional regular expression pattern is used to filter the entries to refresh.\n";
314                 return NULL;
315         case CLI_GENERATE:
316                 return NULL;
317         }
318
319         if (!enabled) {
320                 ast_cli(a->fd, "DNS Manager is disabled.\n");
321                 return 0;
322         }
323
324         if (a->argc > 3) {
325                 return CLI_SHOWUSAGE;
326         }
327
328         if (a->argc == 3) {
329                 if (regcomp(&info.filter, a->argv[2], REG_EXTENDED | REG_NOSUB)) {
330                         return CLI_SHOWUSAGE;
331                 } else {
332                         info.regex_present = 1;
333                 }
334         }
335
336         refresh_list(&info);
337
338         if (info.regex_present) {
339                 regfree(&info.filter);
340         }
341
342         return CLI_SUCCESS;
343 }
344
345 static char *handle_cli_status(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
346 {
347         int count = 0;
348         struct ast_dnsmgr_entry *entry;
349         switch (cmd) {
350         case CLI_INIT:
351                 e->command = "dnsmgr status";
352                 e->usage =
353                         "Usage: dnsmgr status\n"
354                         "       Displays the DNS manager status.\n";
355                 return NULL;
356         case CLI_GENERATE:
357                 return NULL;
358         }
359
360         if (a->argc > 2) {
361                 return CLI_SHOWUSAGE;
362         }
363
364         ast_cli(a->fd, "DNS Manager: %s\n", enabled ? "enabled" : "disabled");
365         ast_cli(a->fd, "Refresh Interval: %d seconds\n", refresh_interval);
366         AST_RWLIST_RDLOCK(&entry_list);
367         AST_RWLIST_TRAVERSE(&entry_list, entry, list)
368                 count++;
369         AST_RWLIST_UNLOCK(&entry_list);
370         ast_cli(a->fd, "Number of entries: %d\n", count);
371
372         return CLI_SUCCESS;
373 }
374
375 static struct ast_cli_entry cli_reload = AST_CLI_DEFINE(handle_cli_reload, "Reloads the DNS manager configuration");
376 static struct ast_cli_entry cli_refresh = AST_CLI_DEFINE(handle_cli_refresh, "Performs an immediate refresh");
377 static struct ast_cli_entry cli_status = AST_CLI_DEFINE(handle_cli_status, "Display the DNS manager status");
378
379 int dnsmgr_init(void)
380 {
381         if (!(sched = ast_sched_context_create())) {
382                 ast_log(LOG_ERROR, "Unable to create schedule context.\n");
383                 return -1;
384         }
385         ast_cli_register(&cli_reload);
386         ast_cli_register(&cli_status);
387         ast_cli_register(&cli_refresh);
388         return do_reload(1);
389 }
390
391 int dnsmgr_reload(void)
392 {
393         return do_reload(0);
394 }
395
396 static int do_reload(int loading)
397 {
398         struct ast_config *config;
399         struct ast_variable *v;
400         struct ast_flags config_flags = { loading ? 0 : CONFIG_FLAG_FILEUNCHANGED };
401         int interval;
402         int was_enabled;
403
404         if ((config = ast_config_load2("dnsmgr.conf", "dnsmgr", config_flags)) == CONFIG_STATUS_FILEUNCHANGED) {
405                 return 0;
406         }
407
408         /* ensure that no refresh cycles run while the reload is in progress */
409         ast_mutex_lock(&refresh_lock);
410
411         /* reset defaults in preparation for reading config file */
412         refresh_interval = REFRESH_DEFAULT;
413         was_enabled = enabled;
414         enabled = 0;
415
416         if (config == CONFIG_STATUS_FILEMISSING || config == CONFIG_STATUS_FILEINVALID) {
417                 ast_mutex_unlock(&refresh_lock);
418                 return 0;
419         }
420
421         AST_SCHED_DEL(sched, refresh_sched);
422
423         for (v = ast_variable_browse(config, "general"); v; v = v->next) {
424                 if (!strcasecmp(v->name, "enable")) {
425                         enabled = ast_true(v->value);
426                 } else if (!strcasecmp(v->name, "refreshinterval")) {
427                         if (sscanf(v->value, "%30d", &interval) < 1) {
428                                 ast_log(LOG_WARNING, "Unable to convert '%s' to a numeric value.\n", v->value);
429                         } else if (interval < 0) {
430                                 ast_log(LOG_WARNING, "Invalid refresh interval '%d' specified, using default\n", interval);
431                         } else {
432                                 refresh_interval = interval;
433                         }
434                 }
435         }
436         ast_config_destroy(config);
437
438         if (enabled && refresh_interval) {
439                 ast_log(LOG_NOTICE, "Managed DNS entries will be refreshed every %d seconds.\n", refresh_interval);
440         }
441
442         /* if this reload enabled the manager, create the background thread
443            if it does not exist */
444         if (enabled) {
445                 if (!was_enabled && (refresh_thread == AST_PTHREADT_NULL)) {
446                         if (ast_pthread_create_background(&refresh_thread, NULL, do_refresh, NULL) < 0) {
447                                 ast_log(LOG_ERROR, "Unable to start refresh thread.\n");
448                         }
449                 }
450                 /* make a background refresh happen right away */
451                 refresh_sched = ast_sched_add_variable(sched, 100, refresh_list, &master_refresh_info, 1);
452         /* if this reload disabled the manager and there is a background thread, kill it */
453         } else if (!enabled && was_enabled && (refresh_thread != AST_PTHREADT_NULL)) {
454                 /* wake up the thread so it will exit */
455                 pthread_cancel(refresh_thread);
456                 pthread_kill(refresh_thread, SIGURG);
457                 pthread_join(refresh_thread, NULL);
458                 refresh_thread = AST_PTHREADT_NULL;
459         }
460
461         ast_mutex_unlock(&refresh_lock);
462         manager_event(EVENT_FLAG_SYSTEM, "Reload", "Module: DNSmgr\r\nStatus: %s\r/nMessage: DNSmgr reload Requested\r\n", enabled ? "Enabled" : "Disabled");
463
464         return 0;
465 }