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