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