src/dns.c

   1 /**
   2  * collectd - src/dns.c
   3  * Copyright (C) 2006,2007  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 verplant.org>
  21  *   Mirko Buffoni <briareos at eswat.org>
  22  **/
  23
  24 #define _BSD_SOURCE
  25
  26 #include "collectd.h"
  27 #include "common.h"
  28 #include "plugin.h"
  29 #include "configfile.h"
  30
  31 #include "utils_dns.h"
  32 #include <pthread.h>
  33 #include <pcap.h>
  34 #include <poll.h>
  35
  36 /*
  37  * Private data types
  38  */
  39 struct counter_list_s
  40 {
  41         unsigned int key;
  42         unsigned int value;
  43         struct counter_list_s *next;
  44 };
  45 typedef struct counter_list_s counter_list_t;
  46
  47 /*
  48  * Private variables
  49  */
  50 static const char *config_keys[] =
  51 {
  52         "Interface",
  53         "IgnoreSource",
  54         "SelectNumericQueryTypes"
  55 };
  56 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
  57 static int select_numeric_qtype = 1;
  58
  59 #define PCAP_SNAPLEN 1460
  60 static char   *pcap_device = NULL;
  61
  62 static derive_t       tr_queries;
  63 static derive_t       tr_responses;
  64 static counter_list_t *qtype_list;
  65 static counter_list_t *opcode_list;
  66 static counter_list_t *rcode_list;
  67
  68 static pthread_t       listen_thread;
  69 static int             listen_thread_init = 0;
  70 /* The `traffic' mutex if for `tr_queries' and `tr_responses' */
  71 static pthread_mutex_t traffic_mutex = PTHREAD_MUTEX_INITIALIZER;
  72 static pthread_mutex_t qtype_mutex   = PTHREAD_MUTEX_INITIALIZER;
  73 static pthread_mutex_t opcode_mutex  = PTHREAD_MUTEX_INITIALIZER;
  74 static pthread_mutex_t rcode_mutex   = PTHREAD_MUTEX_INITIALIZER;
  75
  76 /*
  77  * Private functions
  78  */
  79 static counter_list_t *counter_list_search (counter_list_t **list, unsigned int key)
  80 {
  81         counter_list_t *entry;
  82
  83         for (entry = *list; entry != NULL; entry = entry->next)
  84                 if (entry->key == key)
  85                         break;
  86
  87         return (entry);
  88 }
  89
  90 static counter_list_t *counter_list_create (counter_list_t **list,
  91                 unsigned int key, unsigned int value)
  92 {
  93         counter_list_t *entry;
  94
  95         entry = (counter_list_t *) malloc (sizeof (counter_list_t));
  96         if (entry == NULL)
  97                 return (NULL);
  98
  99         memset (entry, 0, sizeof (counter_list_t));
 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 void *dns_child_loop (void __attribute__((unused)) *dummy)
 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 (interval_g / 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 (NULL);
 238         }
 239
 240         memset (&fp, 0, sizeof (fp));
 241         if (pcap_compile (pcap_obj, &fp, "udp port 53", 1, 0) < 0)
 242         {
 243                 ERROR ("dns plugin: pcap_compile failed");
 244                 return (NULL);
 245         }
 246         if (pcap_setfilter (pcap_obj, &fp) < 0)
 247         {
 248                 ERROR ("dns plugin: pcap_setfilter failed");
 249                 return (NULL);
 250         }
 251
 252         DEBUG ("dns plugin: PCAP object created.");
 253
 254         dnstop_set_pcap_obj (pcap_obj);
 255         dnstop_set_callback (dns_child_callback);
 256
 257         status = pcap_loop (pcap_obj,
 258                         -1 /* loop forever */,
 259                         handle_pcap /* callback */,
 260                         NULL /* Whatever this means.. */);
 261         if (status < 0)
 262                 ERROR ("dns plugin: Listener thread is exiting "
 263                                 "abnormally: %s", pcap_geterr (pcap_obj));
 264
 265         DEBUG ("dns plugin: Child is exiting.");
 266
 267         pcap_close (pcap_obj);
 268         listen_thread_init = 0;
 269         pthread_exit (NULL);
 270
 271         return (NULL);
 272 } /* static void dns_child_loop (void) */
 273
 274 static int dns_init (void)
 275 {
 276         /* clean up an old thread */
 277         int status;
 278
 279         pthread_mutex_lock (&traffic_mutex);
 280         tr_queries   = 0;
 281         tr_responses = 0;
 282         pthread_mutex_unlock (&traffic_mutex);
 283
 284         if (listen_thread_init != 0)
 285                 return (-1);
 286
 287         status = pthread_create (&listen_thread, NULL, dns_child_loop,
 288                         (void *) 0);
 289         if (status != 0)
 290         {
 291                 char errbuf[1024];
 292                 ERROR ("dns plugin: pthread_create failed: %s",
 293                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 294                 return (-1);
 295         }
 296
 297         listen_thread_init = 1;
 298
 299         return (0);
 300 } /* int dns_init */
 301
 302 static void submit_derive (const char *type, const char *type_instance,
 303                 derive_t value)
 304 {
 305         value_t values[1];
 306         value_list_t vl = VALUE_LIST_INIT;
 307
 308         values[0].derive = value;
 309
 310         vl.values = values;
 311         vl.values_len = 1;
 312         sstrncpy (vl.host, hostname_g, sizeof (vl.host));
 313         sstrncpy (vl.plugin, "dns", sizeof (vl.plugin));
 314         sstrncpy (vl.type, type, sizeof (vl.type));
 315         sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
 316
 317         plugin_dispatch_values (&vl);
 318 } /* void submit_derive */
 319
 320 static void submit_octets (derive_t queries, derive_t responses)
 321 {
 322         value_t values[2];
 323         value_list_t vl = VALUE_LIST_INIT;
 324
 325         values[0].derive = queries;
 326         values[1].derive = responses;
 327
 328         vl.values = values;
 329         vl.values_len = 2;
 330         sstrncpy (vl.host, hostname_g, sizeof (vl.host));
 331         sstrncpy (vl.plugin, "dns", sizeof (vl.plugin));
 332         sstrncpy (vl.type, "dns_octets", sizeof (vl.type));
 333
 334         plugin_dispatch_values (&vl);
 335 } /* void submit_octets */
 336
 337 static int dns_read (void)
 338 {
 339         unsigned int keys[T_MAX];
 340         unsigned int values[T_MAX];
 341         int len;
 342         int i;
 343
 344         counter_list_t *ptr;
 345
 346         pthread_mutex_lock (&traffic_mutex);
 347         values[0] = tr_queries;
 348         values[1] = tr_responses;
 349         pthread_mutex_unlock (&traffic_mutex);
 350
 351         if ((values[0] != 0) || (values[1] != 0))
 352                 submit_octets (values[0], values[1]);
 353
 354         pthread_mutex_lock (&qtype_mutex);
 355         for (ptr = qtype_list, len = 0;
 356                         (ptr != NULL) && (len < T_MAX);
 357                         ptr = ptr->next, len++)
 358         {
 359                 keys[len]   = ptr->key;
 360                 values[len] = ptr->value;
 361         }
 362         pthread_mutex_unlock (&qtype_mutex);
 363
 364         for (i = 0; i < len; i++)
 365         {
 366                 DEBUG ("dns plugin: qtype = %u; counter = %u;", keys[i], values[i]);
 367                 submit_derive ("dns_qtype", qtype_str (keys[i]), values[i]);
 368         }
 369
 370         pthread_mutex_lock (&opcode_mutex);
 371         for (ptr = opcode_list, len = 0;
 372                         (ptr != NULL) && (len < T_MAX);
 373                         ptr = ptr->next, len++)
 374         {
 375                 keys[len]   = ptr->key;
 376                 values[len] = ptr->value;
 377         }
 378         pthread_mutex_unlock (&opcode_mutex);
 379
 380         for (i = 0; i < len; i++)
 381         {
 382                 DEBUG ("dns plugin: opcode = %u; counter = %u;", keys[i], values[i]);
 383                 submit_derive ("dns_opcode", opcode_str (keys[i]), values[i]);
 384         }
 385
 386         pthread_mutex_lock (&rcode_mutex);
 387         for (ptr = rcode_list, len = 0;
 388                         (ptr != NULL) && (len < T_MAX);
 389                         ptr = ptr->next, len++)
 390         {
 391                 keys[len]   = ptr->key;
 392                 values[len] = ptr->value;
 393         }
 394         pthread_mutex_unlock (&rcode_mutex);
 395
 396         for (i = 0; i < len; i++)
 397         {
 398                 DEBUG ("dns plugin: rcode = %u; counter = %u;", keys[i], values[i]);
 399                 submit_derive ("dns_rcode", rcode_str (keys[i]), values[i]);
 400         }
 401
 402         return (0);
 403 } /* int dns_read */
 404
 405 void module_register (void)
 406 {
 407         plugin_register_config ("dns", dns_config, config_keys, config_keys_num);
 408         plugin_register_init ("dns", dns_init);
 409         plugin_register_read ("dns", dns_read);
 410 } /* void module_register */