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