write_graphite: remove dead assignment
[collectd.git] / src / dns.c
1 /**
2  * collectd - src/dns.c
3  * Copyright (C) 2006-2011  Florian octo Forster
4  * Copyright (C) 2009       Mirko Buffoni
5  *
6  * This program is free software; you can redistribute it and/or modify it
7  * under the terms of the GNU General Public License as published by the
8  * Free Software Foundation; only version 2 of the License is applicable.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License along
16  * with this program; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
18  *
19  * Authors:
20  *   Florian octo Forster <octo at collectd.org>
21  *   Mirko Buffoni <briareos at eswat.org>
22  **/
23
24 #define _DEFAULT_SOURCE
25 #define _BSD_SOURCE
26
27 #include "collectd.h"
28 #include "common.h"
29 #include "plugin.h"
30 #include "configfile.h"
31
32 #include "utils_dns.h"
33 #include <poll.h>
34
35 #include <pcap.h>
36
37 /*
38  * Private data types
39  */
40 struct counter_list_s
41 {
42         unsigned int key;
43         unsigned int value;
44         struct counter_list_s *next;
45 };
46 typedef struct counter_list_s counter_list_t;
47
48 /*
49  * Private variables
50  */
51 static const char *config_keys[] =
52 {
53         "Interface",
54         "IgnoreSource",
55         "SelectNumericQueryTypes"
56 };
57 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
58 static int select_numeric_qtype = 1;
59
60 #define PCAP_SNAPLEN 1460
61 static char   *pcap_device = NULL;
62
63 static derive_t       tr_queries;
64 static derive_t       tr_responses;
65 static counter_list_t *qtype_list;
66 static counter_list_t *opcode_list;
67 static counter_list_t *rcode_list;
68
69 static pthread_t       listen_thread;
70 static int             listen_thread_init = 0;
71 /* The `traffic' mutex if for `tr_queries' and `tr_responses' */
72 static pthread_mutex_t traffic_mutex = PTHREAD_MUTEX_INITIALIZER;
73 static pthread_mutex_t qtype_mutex   = PTHREAD_MUTEX_INITIALIZER;
74 static pthread_mutex_t opcode_mutex  = PTHREAD_MUTEX_INITIALIZER;
75 static pthread_mutex_t rcode_mutex   = PTHREAD_MUTEX_INITIALIZER;
76
77 /*
78  * Private functions
79  */
80 static counter_list_t *counter_list_search (counter_list_t **list, unsigned int key)
81 {
82         counter_list_t *entry;
83
84         for (entry = *list; entry != NULL; entry = entry->next)
85                 if (entry->key == key)
86                         break;
87
88         return (entry);
89 }
90
91 static counter_list_t *counter_list_create (counter_list_t **list,
92                 unsigned int key, unsigned int value)
93 {
94         counter_list_t *entry;
95
96         entry = calloc (1, sizeof (*entry));
97         if (entry == NULL)
98                 return (NULL);
99
100         entry->key = key;
101         entry->value = value;
102
103         if (*list == NULL)
104         {
105                 *list = entry;
106         }
107         else
108         {
109                 counter_list_t *last;
110
111                 last = *list;
112                 while (last->next != NULL)
113                         last = last->next;
114
115                 last->next = entry;
116         }
117
118         return (entry);
119 }
120
121 static void counter_list_add (counter_list_t **list,
122                 unsigned int key, unsigned int increment)
123 {
124         counter_list_t *entry;
125
126         entry = counter_list_search (list, key);
127
128         if (entry != NULL)
129         {
130                 entry->value += increment;
131         }
132         else
133         {
134                 counter_list_create (list, key, increment);
135         }
136 }
137
138 static int dns_config (const char *key, const char *value)
139 {
140         if (strcasecmp (key, "Interface") == 0)
141         {
142                 if (pcap_device != NULL)
143                         free (pcap_device);
144                 if ((pcap_device = strdup (value)) == NULL)
145                         return (1);
146         }
147         else if (strcasecmp (key, "IgnoreSource") == 0)
148         {
149                 if (value != NULL)
150                         ignore_list_add_name (value);
151         }
152         else if (strcasecmp (key, "SelectNumericQueryTypes") == 0)
153         {
154                 if ((value != NULL) && IS_FALSE (value))
155                         select_numeric_qtype = 0;
156                 else
157                         select_numeric_qtype = 1;
158         }
159         else
160         {
161                 return (-1);
162         }
163
164         return (0);
165 }
166
167 static void dns_child_callback (const rfc1035_header_t *dns)
168 {
169         if (dns->qr == 0)
170         {
171                 /* This is a query */
172                 int skip = 0;
173                 if (!select_numeric_qtype)
174                 {
175                         const char *str = qtype_str(dns->qtype);
176                         if ((str == NULL) || (str[0] == '#'))
177                                 skip = 1;
178                 }
179
180                 pthread_mutex_lock (&traffic_mutex);
181                 tr_queries += dns->length;
182                 pthread_mutex_unlock (&traffic_mutex);
183
184                 if (skip == 0)
185                 {
186                         pthread_mutex_lock (&qtype_mutex);
187                         counter_list_add (&qtype_list, dns->qtype,  1);
188                         pthread_mutex_unlock (&qtype_mutex);
189                 }
190         }
191         else
192         {
193                 /* This is a reply */
194                 pthread_mutex_lock (&traffic_mutex);
195                 tr_responses += dns->length;
196                 pthread_mutex_unlock (&traffic_mutex);
197
198                 pthread_mutex_lock (&rcode_mutex);
199                 counter_list_add (&rcode_list,  dns->rcode,  1);
200                 pthread_mutex_unlock (&rcode_mutex);
201         }
202
203         /* FIXME: Are queries, replies or both interesting? */
204         pthread_mutex_lock (&opcode_mutex);
205         counter_list_add (&opcode_list, dns->opcode, 1);
206         pthread_mutex_unlock (&opcode_mutex);
207 }
208
209 static int dns_run_pcap_loop (void)
210 {
211         pcap_t *pcap_obj;
212         char    pcap_error[PCAP_ERRBUF_SIZE];
213         struct  bpf_program fp;
214
215         int status;
216
217         /* Don't block any signals */
218         {
219                 sigset_t sigmask;
220                 sigemptyset (&sigmask);
221                 pthread_sigmask (SIG_SETMASK, &sigmask, NULL);
222         }
223
224         /* Passing `pcap_device == NULL' is okay and the same as passign "any" */
225         DEBUG ("dns plugin: Creating PCAP object..");
226         pcap_obj = pcap_open_live ((pcap_device != NULL) ? pcap_device : "any",
227                         PCAP_SNAPLEN,
228                         0 /* Not promiscuous */,
229                         (int) CDTIME_T_TO_MS (plugin_get_interval () / 2),
230                         pcap_error);
231         if (pcap_obj == NULL)
232         {
233                 ERROR ("dns plugin: Opening interface `%s' "
234                                 "failed: %s",
235                                 (pcap_device != NULL) ? pcap_device : "any",
236                                 pcap_error);
237                 return (PCAP_ERROR);
238         }
239
240         memset (&fp, 0, sizeof (fp));
241         status = pcap_compile (pcap_obj, &fp, "udp port 53", 1, 0);
242         if (status < 0)
243         {
244                 ERROR ("dns plugin: pcap_compile failed: %s",
245                                 pcap_statustostr (status));
246                 return (status);
247         }
248
249         status = pcap_setfilter (pcap_obj, &fp);
250         if (status < 0)
251         {
252                 ERROR ("dns plugin: pcap_setfilter failed: %s",
253                                 pcap_statustostr (status));
254                 return (status);
255         }
256
257         DEBUG ("dns plugin: PCAP object created.");
258
259         dnstop_set_pcap_obj (pcap_obj);
260         dnstop_set_callback (dns_child_callback);
261
262         status = pcap_loop (pcap_obj,
263                         -1 /* loop forever */,
264                         handle_pcap /* callback */,
265                         NULL /* user data */);
266         INFO ("dns plugin: pcap_loop exited with status %i.", status);
267         /* We need to handle "PCAP_ERROR" specially because libpcap currently
268          * doesn't return PCAP_ERROR_IFACE_NOT_UP for compatibility reasons. */
269         if (status == PCAP_ERROR)
270                 status = PCAP_ERROR_IFACE_NOT_UP;
271
272         pcap_close (pcap_obj);
273         return (status);
274 } /* int dns_run_pcap_loop */
275
276 static int dns_sleep_one_interval (void) /* {{{ */
277 {
278         cdtime_t interval;
279         struct timespec ts = { 0, 0 };
280         int status = 0;
281
282         interval = plugin_get_interval ();
283         CDTIME_T_TO_TIMESPEC (interval, &ts);
284
285         while (42)
286         {
287                 struct timespec rem = { 0, 0 };
288
289                 status = nanosleep (&ts, &rem);
290                 if (status == 0)
291                         break;
292                 else if ((errno == EINTR) || (errno == EAGAIN))
293                 {
294                         ts = rem;
295                         continue;
296                 }
297                 else
298                         break;
299         }
300
301         return (status);
302 } /* }}} int dns_sleep_one_interval */
303
304 static void *dns_child_loop (__attribute__((unused)) void *dummy) /* {{{ */
305 {
306         int status;
307
308         while (42)
309         {
310                 status = dns_run_pcap_loop ();
311                 if (status != PCAP_ERROR_IFACE_NOT_UP)
312                         break;
313
314                 dns_sleep_one_interval ();
315         }
316
317         if (status != PCAP_ERROR_BREAK)
318                 ERROR ("dns plugin: PCAP returned error %s.",
319                                 pcap_statustostr (status));
320
321         listen_thread_init = 0;
322         return (NULL);
323 } /* }}} void *dns_child_loop */
324
325 static int dns_init (void)
326 {
327         /* clean up an old thread */
328         int status;
329
330         pthread_mutex_lock (&traffic_mutex);
331         tr_queries   = 0;
332         tr_responses = 0;
333         pthread_mutex_unlock (&traffic_mutex);
334
335         if (listen_thread_init != 0)
336                 return (-1);
337
338         status = plugin_thread_create (&listen_thread, NULL, dns_child_loop,
339                         (void *) 0);
340         if (status != 0)
341         {
342                 char errbuf[1024];
343                 ERROR ("dns plugin: pthread_create failed: %s",
344                                 sstrerror (errno, errbuf, sizeof (errbuf)));
345                 return (-1);
346         }
347
348         listen_thread_init = 1;
349
350         return (0);
351 } /* int dns_init */
352
353 static void submit_derive (const char *type, const char *type_instance,
354                 derive_t value)
355 {
356         value_t values[1];
357         value_list_t vl = VALUE_LIST_INIT;
358
359         values[0].derive = value;
360
361         vl.values = values;
362         vl.values_len = 1;
363         sstrncpy (vl.host, hostname_g, sizeof (vl.host));
364         sstrncpy (vl.plugin, "dns", sizeof (vl.plugin));
365         sstrncpy (vl.type, type, sizeof (vl.type));
366         sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
367
368         plugin_dispatch_values (&vl);
369 } /* void submit_derive */
370
371 static void submit_octets (derive_t queries, derive_t responses)
372 {
373         value_t values[2];
374         value_list_t vl = VALUE_LIST_INIT;
375
376         values[0].derive = queries;
377         values[1].derive = responses;
378
379         vl.values = values;
380         vl.values_len = 2;
381         sstrncpy (vl.host, hostname_g, sizeof (vl.host));
382         sstrncpy (vl.plugin, "dns", sizeof (vl.plugin));
383         sstrncpy (vl.type, "dns_octets", sizeof (vl.type));
384
385         plugin_dispatch_values (&vl);
386 } /* void submit_octets */
387
388 static int dns_read (void)
389 {
390         unsigned int keys[T_MAX];
391         unsigned int values[T_MAX];
392         int len;
393         int i;
394
395         counter_list_t *ptr;
396
397         pthread_mutex_lock (&traffic_mutex);
398         values[0] = tr_queries;
399         values[1] = tr_responses;
400         pthread_mutex_unlock (&traffic_mutex);
401
402         if ((values[0] != 0) || (values[1] != 0))
403                 submit_octets (values[0], values[1]);
404
405         pthread_mutex_lock (&qtype_mutex);
406         for (ptr = qtype_list, len = 0;
407                         (ptr != NULL) && (len < T_MAX);
408                         ptr = ptr->next, len++)
409         {
410                 keys[len]   = ptr->key;
411                 values[len] = ptr->value;
412         }
413         pthread_mutex_unlock (&qtype_mutex);
414
415         for (i = 0; i < len; i++)
416         {
417                 DEBUG ("dns plugin: qtype = %u; counter = %u;", keys[i], values[i]);
418                 submit_derive ("dns_qtype", qtype_str (keys[i]), values[i]);
419         }
420
421         pthread_mutex_lock (&opcode_mutex);
422         for (ptr = opcode_list, len = 0;
423                         (ptr != NULL) && (len < T_MAX);
424                         ptr = ptr->next, len++)
425         {
426                 keys[len]   = ptr->key;
427                 values[len] = ptr->value;
428         }
429         pthread_mutex_unlock (&opcode_mutex);
430
431         for (i = 0; i < len; i++)
432         {
433                 DEBUG ("dns plugin: opcode = %u; counter = %u;", keys[i], values[i]);
434                 submit_derive ("dns_opcode", opcode_str (keys[i]), values[i]);
435         }
436
437         pthread_mutex_lock (&rcode_mutex);
438         for (ptr = rcode_list, len = 0;
439                         (ptr != NULL) && (len < T_MAX);
440                         ptr = ptr->next, len++)
441         {
442                 keys[len]   = ptr->key;
443                 values[len] = ptr->value;
444         }
445         pthread_mutex_unlock (&rcode_mutex);
446
447         for (i = 0; i < len; i++)
448         {
449                 DEBUG ("dns plugin: rcode = %u; counter = %u;", keys[i], values[i]);
450                 submit_derive ("dns_rcode", rcode_str (keys[i]), values[i]);
451         }
452
453         return (0);
454 } /* int dns_read */
455
456 void module_register (void)
457 {
458         plugin_register_config ("dns", dns_config, config_keys, config_keys_num);
459         plugin_register_init ("dns", dns_init);
460         plugin_register_read ("dns", dns_read);
461 } /* void module_register */