7036708c752c4a751ac723cbb1f5839cebae2611
[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 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         ast_verb(4, "doing dnsmgr_lookup for '%s'\n", name);
135
136         /* do a lookup now but add a manager so it will automagically get updated in the background */
137         ast_get_ip_or_srv(result, name, service);
138         
139         /* if dnsmgr is not enable don't bother adding an entry */
140         if (!enabled) {
141                 return 0;
142         }
143         
144         ast_verb(3, "adding dns manager for '%s'\n", name);
145         *dnsmgr = ast_dnsmgr_get(name, result, service);
146         return !*dnsmgr;
147 }
148
149 /*
150  * Refresh a dnsmgr entry
151  */
152 static int dnsmgr_refresh(struct ast_dnsmgr_entry *entry, int verbose)
153 {
154         struct ast_sockaddr tmp;
155         int changed = 0;
156
157         ast_mutex_lock(&entry->lock);
158         if (verbose)
159                 ast_verb(3, "refreshing '%s'\n", entry->name);
160
161         memset(&tmp, 0, sizeof(tmp));
162
163         if (!ast_get_ip_or_srv(&tmp, entry->name, entry->service)) {
164                 if (!ast_sockaddr_port(&tmp))
165                         ast_sockaddr_set_port(&tmp, ast_sockaddr_port(entry->result));
166                 if (ast_sockaddr_cmp(&tmp, entry->result)) {
167                         ast_log(LOG_NOTICE, "dnssrv: host '%s' changed from %s to %s\n",
168                                         entry->name, ast_strdupa(ast_sockaddr_stringify(entry->result)),
169                                         ast_strdupa(ast_sockaddr_stringify(&tmp)));
170
171                         ast_sockaddr_copy(entry->result, &tmp);
172                         changed = entry->changed = 1;
173                 }
174         }
175
176         ast_mutex_unlock(&entry->lock);
177         return changed;
178 }
179
180 int ast_dnsmgr_refresh(struct ast_dnsmgr_entry *entry)
181 {
182         return dnsmgr_refresh(entry, 0);
183 }
184
185 /*
186  * Check if dnsmgr entry has changed from since last call to this function
187  */
188 int ast_dnsmgr_changed(struct ast_dnsmgr_entry *entry) 
189 {
190         int changed;
191
192         ast_mutex_lock(&entry->lock);
193
194         changed = entry->changed;
195         entry->changed = 0;
196
197         ast_mutex_unlock(&entry->lock);
198         
199         return changed;
200 }
201
202 static void *do_refresh(void *data)
203 {
204         for (;;) {
205                 pthread_testcancel();
206                 usleep((ast_sched_wait(sched)*1000));
207                 pthread_testcancel();
208                 ast_sched_runq(sched);
209         }
210         return NULL;
211 }
212
213 static int refresh_list(const void *data)
214 {
215         struct refresh_info *info = (struct refresh_info *)data;
216         struct ast_dnsmgr_entry *entry;
217
218         /* if a refresh or reload is already in progress, exit now */
219         if (ast_mutex_trylock(&refresh_lock)) {
220                 if (info->verbose)
221                         ast_log(LOG_WARNING, "DNS Manager refresh already in progress.\n");
222                 return -1;
223         }
224
225         ast_verb(3, "Refreshing DNS lookups.\n");
226         AST_RWLIST_RDLOCK(info->entries);
227         AST_RWLIST_TRAVERSE(info->entries, entry, list) {
228                 if (info->regex_present && regexec(&info->filter, entry->name, 0, NULL, 0))
229                     continue;
230
231                 dnsmgr_refresh(entry, info->verbose);
232         }
233         AST_RWLIST_UNLOCK(info->entries);
234
235         ast_mutex_unlock(&refresh_lock);
236
237         /* automatically reschedule based on the interval */
238         return refresh_interval * 1000;
239 }
240
241 void dnsmgr_start_refresh(void)
242 {
243         if (refresh_sched > -1) {
244                 AST_SCHED_DEL(sched, refresh_sched);
245                 refresh_sched = ast_sched_add_variable(sched, 100, refresh_list, &master_refresh_info, 1);
246         }
247 }
248
249 static int do_reload(int loading);
250
251 static char *handle_cli_reload(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
252 {
253         switch (cmd) {
254         case CLI_INIT:
255                 e->command = "dnsmgr reload";
256                 e->usage = 
257                         "Usage: dnsmgr reload\n"
258                         "       Reloads the DNS manager configuration.\n";
259                 return NULL;
260         case CLI_GENERATE:
261                 return NULL;    
262         }
263         if (a->argc > 2)
264                 return CLI_SHOWUSAGE;
265
266         do_reload(0);
267         return CLI_SUCCESS;
268 }
269
270 static char *handle_cli_refresh(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
271 {
272         struct refresh_info info = {
273                 .entries = &entry_list,
274                 .verbose = 1,
275         };
276         switch (cmd) {
277         case CLI_INIT:
278                 e->command = "dnsmgr refresh";
279                 e->usage = 
280                         "Usage: dnsmgr refresh [pattern]\n"
281                         "       Peforms an immediate refresh of the managed DNS entries.\n"
282                         "       Optional regular expression pattern is used to filter the entries to refresh.\n";
283                 return NULL;
284         case CLI_GENERATE:
285                 return NULL;    
286         }
287
288         if (!enabled) {
289                 ast_cli(a->fd, "DNS Manager is disabled.\n");
290                 return 0;
291         }
292
293         if (a->argc > 3) {
294                 return CLI_SHOWUSAGE;
295         }
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
305         refresh_list(&info);
306
307         if (info.regex_present) {
308                 regfree(&info.filter);
309         }
310
311         return CLI_SUCCESS;
312 }
313
314 static char *handle_cli_status(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
315 {
316         int count = 0;
317         struct ast_dnsmgr_entry *entry;
318         switch (cmd) {
319         case CLI_INIT:
320                 e->command = "dnsmgr status";
321                 e->usage = 
322                         "Usage: dnsmgr status\n"
323                         "       Displays the DNS manager status.\n";
324                 return NULL;
325         case CLI_GENERATE:
326                 return NULL;    
327         }
328
329         if (a->argc > 2)
330                 return CLI_SHOWUSAGE;
331
332         ast_cli(a->fd, "DNS Manager: %s\n", enabled ? "enabled" : "disabled");
333         ast_cli(a->fd, "Refresh Interval: %d seconds\n", refresh_interval);
334         AST_RWLIST_RDLOCK(&entry_list);
335         AST_RWLIST_TRAVERSE(&entry_list, entry, list)
336                 count++;
337         AST_RWLIST_UNLOCK(&entry_list);
338         ast_cli(a->fd, "Number of entries: %d\n", count);
339
340         return CLI_SUCCESS;
341 }
342
343 static struct ast_cli_entry cli_reload = AST_CLI_DEFINE(handle_cli_reload, "Reloads the DNS manager configuration");
344 static struct ast_cli_entry cli_refresh = AST_CLI_DEFINE(handle_cli_refresh, "Performs an immediate refresh");
345 static struct ast_cli_entry cli_status = AST_CLI_DEFINE(handle_cli_status, "Display the DNS manager status");
346
347 int dnsmgr_init(void)
348 {
349         if (!(sched = sched_context_create())) {
350                 ast_log(LOG_ERROR, "Unable to create schedule context.\n");
351                 return -1;
352         }
353         ast_cli_register(&cli_reload);
354         ast_cli_register(&cli_status);
355         ast_cli_register(&cli_refresh);
356         return do_reload(1);
357 }
358
359 int dnsmgr_reload(void)
360 {
361         return do_reload(0);
362 }
363
364 static int do_reload(int loading)
365 {
366         struct ast_config *config;
367         struct ast_flags config_flags = { loading ? 0 : CONFIG_FLAG_FILEUNCHANGED };
368         const char *interval_value;
369         const char *enabled_value;
370         int interval;
371         int was_enabled;
372         int res = -1;
373
374         config = ast_config_load2("dnsmgr.conf", "dnsmgr", config_flags);
375         if (config == CONFIG_STATUS_FILEMISSING || config == CONFIG_STATUS_FILEUNCHANGED || config == CONFIG_STATUS_FILEINVALID) {
376                 return 0;
377         }
378
379         /* ensure that no refresh cycles run while the reload is in progress */
380         ast_mutex_lock(&refresh_lock);
381
382         /* reset defaults in preparation for reading config file */
383         refresh_interval = REFRESH_DEFAULT;
384         was_enabled = enabled;
385         enabled = 0;
386
387         AST_SCHED_DEL(sched, refresh_sched);
388
389         if (config) {
390                 if ((enabled_value = ast_variable_retrieve(config, "general", "enable"))) {
391                         enabled = ast_true(enabled_value);
392                 }
393                 if ((interval_value = ast_variable_retrieve(config, "general", "refreshinterval"))) {
394                         if (sscanf(interval_value, "%30d", &interval) < 1)
395                                 ast_log(LOG_WARNING, "Unable to convert '%s' to a numeric value.\n", interval_value);
396                         else if (interval < 0)
397                                 ast_log(LOG_WARNING, "Invalid refresh interval '%d' specified, using default\n", interval);
398                         else
399                                 refresh_interval = interval;
400                 }
401                 ast_config_destroy(config);
402         }
403
404         if (enabled && refresh_interval)
405                 ast_log(LOG_NOTICE, "Managed DNS entries will be refreshed every %d seconds.\n", refresh_interval);
406
407         /* if this reload enabled the manager, create the background thread
408            if it does not exist */
409         if (enabled) {
410                 if (!was_enabled && (refresh_thread == AST_PTHREADT_NULL)) {
411                         if (ast_pthread_create_background(&refresh_thread, NULL, do_refresh, NULL) < 0) {
412                                 ast_log(LOG_ERROR, "Unable to start refresh thread.\n");
413                         }
414                 }
415                 /* make a background refresh happen right away */
416                 refresh_sched = ast_sched_add_variable(sched, 100, refresh_list, &master_refresh_info, 1);
417                 res = 0;
418         }
419         /* if this reload disabled the manager and there is a background thread,
420            kill it */
421         else if (!enabled && was_enabled && (refresh_thread != AST_PTHREADT_NULL)) {
422                 /* wake up the thread so it will exit */
423                 pthread_cancel(refresh_thread);
424                 pthread_kill(refresh_thread, SIGURG);
425                 pthread_join(refresh_thread, NULL);
426                 refresh_thread = AST_PTHREADT_NULL;
427                 res = 0;
428         }
429         else
430                 res = 0;
431
432         ast_mutex_unlock(&refresh_lock);
433         manager_event(EVENT_FLAG_SYSTEM, "Reload", "Module: DNSmgr\r\nStatus: %s\r/nMessage: DNSmgr reload Requested\r\n", enabled ? "Enabled" : "Disabled");
434
435         return res;
436 }