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