src/snmp.c

   1 /**
   2  * collectd - src/snmp.c
   3  * Copyright (C) 2007  Florian octo Forster
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by the
   7  * Free Software Foundation; only version 2 of the License is applicable.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  17  *
  18  * Authors:
  19  *   Florian octo Forster <octo at verplant.org>
  20  **/
  21
  22 #include "collectd.h"
  23 #include "common.h"
  24 #include "plugin.h"
  25
  26 #include <pthread.h>
  27
  28 #include <net-snmp/net-snmp-config.h>
  29 #include <net-snmp/net-snmp-includes.h>
  30
  31 /*
  32  * Private data structes
  33  */
  34 struct oid_s
  35 {
  36   oid oid[MAX_OID_LEN];
  37   size_t oid_len;
  38 };
  39 typedef struct oid_s oid_t;
  40
  41 union instance_u
  42 {
  43   char  string[DATA_MAX_NAME_LEN];
  44   oid_t oid;
  45 };
  46 typedef union instance_u instance_t;
  47
  48 struct data_definition_s
  49 {
  50   char *name; /* used to reference this from the `Collect' option */
  51   char *type; /* used to find the data_set */
  52   int is_table;
  53   instance_t instance;
  54   oid_t *values;
  55   int values_len;
  56   struct data_definition_s *next;
  57 };
  58 typedef struct data_definition_s data_definition_t;
  59
  60 struct host_definition_s
  61 {
  62   char *name;
  63   char *address;
  64   char *community;
  65   int version;
  66   void *sess_handle;
  67   int16_t skip_num;
  68   int16_t skip_left;
  69   data_definition_t **data_list;
  70   int data_list_len;
  71   enum          /****************************************************/
  72   {             /* This host..                                      */
  73     STATE_IDLE, /* - just sits there until `skip_left < interval_g' */
  74     STATE_WAIT, /* - waits to be queried.                           */
  75     STATE_BUSY  /* - is currently being queried.                    */
  76   } state;      /****************************************************/
  77   struct host_definition_s *next;
  78 };
  79 typedef struct host_definition_s host_definition_t;
  80
  81 /* These two types are used to cache values in `csnmp_read_table' to handle
  82  * gaps in tables. */
  83 struct csnmp_list_instances_s
  84 {
  85   oid subid;
  86   char instance[DATA_MAX_NAME_LEN];
  87   struct csnmp_list_instances_s *next;
  88 };
  89 typedef struct csnmp_list_instances_s csnmp_list_instances_t;
  90
  91 struct csnmp_table_values_s
  92 {
  93   oid subid;
  94   value_t value;
  95   struct csnmp_table_values_s *next;
  96 };
  97 typedef struct csnmp_table_values_s csnmp_table_values_t;
  98
  99 /*
 100  * Private variables
 101  */
 102 static int do_shutdown = 0;
 103
 104 pthread_t *threads = NULL;
 105 int threads_num = 0;
 106
 107 static data_definition_t *data_head = NULL;
 108 static host_definition_t *host_head = NULL;
 109
 110 static pthread_mutex_t host_lock = PTHREAD_MUTEX_INITIALIZER;
 111 static pthread_cond_t  host_cond = PTHREAD_COND_INITIALIZER;
 112
 113 /*
 114  * Private functions
 115  */
 116 /* First there are many functions which do configuration stuff. It's a big
 117  * bloated and messy, I'm afraid. */
 118
 119 /*
 120  * Callgraph for the config stuff:
 121  *  csnmp_config
 122  *  +-> call_snmp_init_once
 123  *  +-> csnmp_config_add_data
 124  *  !   +-> csnmp_config_add_data_type
 125  *  !   +-> csnmp_config_add_data_table
 126  *  !   +-> csnmp_config_add_data_instance
 127  *  !   +-> csnmp_config_add_data_values
 128  *  +-> csnmp_config_add_host
 129  *      +-> csnmp_config_add_host_address
 130  *      +-> csnmp_config_add_host_community
 131  *      +-> csnmp_config_add_host_version
 132  *      +-> csnmp_config_add_host_collect
 133  *      +-> csnmp_config_add_host_interval
 134  */
 135 static void call_snmp_init_once (void)
 136 {
 137   static int have_init = 0;
 138
 139   if (have_init == 0)
 140     init_snmp (PACKAGE_NAME);
 141   have_init = 1;
 142 } /* void call_snmp_init_once */
 143
 144 static int csnmp_config_add_data_type (data_definition_t *dd, oconfig_item_t *ci)
 145 {
 146   if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
 147   {
 148     WARNING ("snmp plugin: `Type' needs exactly one string argument.");
 149     return (-1);
 150   }
 151
 152   if (dd->type != NULL)
 153     free (dd->type);
 154
 155   dd->type = strdup (ci->values[0].value.string);
 156   if (dd->type == NULL)
 157     return (-1);
 158
 159   return (0);
 160 } /* int csnmp_config_add_data_type */
 161
 162 static int csnmp_config_add_data_table (data_definition_t *dd, oconfig_item_t *ci)
 163 {
 164   if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_BOOLEAN))
 165   {
 166     WARNING ("snmp plugin: `Table' needs exactly one boolean argument.");
 167     return (-1);
 168   }
 169
 170   dd->is_table = ci->values[0].value.boolean ? 1 : 0;
 171
 172   return (0);
 173 } /* int csnmp_config_add_data_table */
 174
 175 static int csnmp_config_add_data_instance (data_definition_t *dd, oconfig_item_t *ci)
 176 {
 177   if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
 178   {
 179     WARNING ("snmp plugin: `Instance' needs exactly one string argument.");
 180     return (-1);
 181   }
 182
 183   if (dd->is_table)
 184   {
 185     /* Instance is an OID */
 186     dd->instance.oid.oid_len = MAX_OID_LEN;
 187
 188     if (!read_objid (ci->values[0].value.string,
 189           dd->instance.oid.oid, &dd->instance.oid.oid_len))
 190     {
 191       ERROR ("snmp plugin: read_objid (%s) failed.",
 192           ci->values[0].value.string);
 193       return (-1);
 194     }
 195   }
 196   else
 197   {
 198     /* Instance is a simple string */
 199     strncpy (dd->instance.string, ci->values[0].value.string, DATA_MAX_NAME_LEN - 1);
 200   }
 201
 202   return (0);
 203 } /* int csnmp_config_add_data_instance */
 204
 205 static int csnmp_config_add_data_values (data_definition_t *dd, oconfig_item_t *ci)
 206 {
 207   int i;
 208
 209   if (ci->values_num < 1)
 210   {
 211     WARNING ("snmp plugin: `Values' needs at least one argument.");
 212     return (-1);
 213   }
 214
 215   for (i = 0; i < ci->values_num; i++)
 216     if (ci->values[i].type != OCONFIG_TYPE_STRING)
 217     {
 218       WARNING ("snmp plugin: `Values' needs only string argument.");
 219       return (-1);
 220     }
 221
 222   if (dd->values != NULL)
 223     free (dd->values);
 224   dd->values = (oid_t *) malloc (sizeof (oid_t) * ci->values_num);
 225   if (dd->values == NULL)
 226     return (-1);
 227   dd->values_len = ci->values_num;
 228
 229   for (i = 0; i < ci->values_num; i++)
 230   {
 231     dd->values[i].oid_len = MAX_OID_LEN;
 232
 233     if (NULL == snmp_parse_oid (ci->values[i].value.string,
 234           dd->values[i].oid, &dd->values[i].oid_len))
 235     {
 236       ERROR ("snmp plugin: snmp_parse_oid (%s) failed.",
 237           ci->values[i].value.string);
 238       free (dd->values);
 239       dd->values = NULL;
 240       dd->values_len = 0;
 241       return (-1);
 242     }
 243   }
 244
 245   return (0);
 246 } /* int csnmp_config_add_data_instance */
 247
 248 static int csnmp_config_add_data (oconfig_item_t *ci)
 249 {
 250   data_definition_t *dd;
 251   int status = 0;
 252   int i;
 253
 254   if ((ci->values_num != 1)
 255       || (ci->values[0].type != OCONFIG_TYPE_STRING))
 256   {
 257     WARNING ("snmp plugin: The `Data' config option needs exactly one string argument.");
 258     return (-1);
 259   }
 260
 261   dd = (data_definition_t *) malloc (sizeof (data_definition_t));
 262   if (dd == NULL)
 263     return (-1);
 264   memset (dd, '\0', sizeof (data_definition_t));
 265
 266   dd->name = strdup (ci->values[0].value.string);
 267   if (dd->name == NULL)
 268   {
 269     free (dd);
 270     return (-1);
 271   }
 272
 273   for (i = 0; i < ci->children_num; i++)
 274   {
 275     oconfig_item_t *option = ci->children + i;
 276     status = 0;
 277
 278     if (strcasecmp ("Type", option->key) == 0)
 279       status = csnmp_config_add_data_type (dd, option);
 280     else if (strcasecmp ("Table", option->key) == 0)
 281       status = csnmp_config_add_data_table (dd, option);
 282     else if (strcasecmp ("Instance", option->key) == 0)
 283       status = csnmp_config_add_data_instance (dd, option);
 284     else if (strcasecmp ("Values", option->key) == 0)
 285       status = csnmp_config_add_data_values (dd, option);
 286     else
 287     {
 288       WARNING ("snmp plugin: Option `%s' not allowed here.", option->key);
 289       status = -1;
 290     }
 291
 292     if (status != 0)
 293       break;
 294   } /* for (ci->children) */
 295
 296   while (status == 0)
 297   {
 298     if (dd->type == NULL)
 299     {
 300       WARNING ("snmp plugin: `Type' not given for data `%s'", dd->name);
 301       status = -1;
 302       break;
 303     }
 304     if (dd->values == NULL)
 305     {
 306       WARNING ("snmp plugin: No `Value' given for data `%s'", dd->name);
 307       status = -1;
 308       break;
 309     }
 310
 311     break;
 312   } /* while (status == 0) */
 313
 314   if (status != 0)
 315   {
 316     sfree (dd->name);
 317     sfree (dd->values);
 318     sfree (dd);
 319     return (-1);
 320   }
 321
 322   DEBUG ("snmp plugin: dd = { name = %s, type = %s, is_table = %s, values_len = %i }",
 323       dd->name, dd->type, (dd->is_table != 0) ? "true" : "false", dd->values_len);
 324
 325   if (data_head == NULL)
 326     data_head = dd;
 327   else
 328   {
 329     data_definition_t *last;
 330     last = data_head;
 331     while (last->next != NULL)
 332       last = last->next;
 333     last->next = dd;
 334   }
 335
 336   return (0);
 337 } /* int csnmp_config_add_data */
 338
 339 static int csnmp_config_add_host_address (host_definition_t *hd, oconfig_item_t *ci)
 340 {
 341   if ((ci->values_num != 1)
 342       || (ci->values[0].type != OCONFIG_TYPE_STRING))
 343   {
 344     WARNING ("snmp plugin: The `Address' config option needs exactly one string argument.");
 345     return (-1);
 346   }
 347
 348   if (hd->address == NULL)
 349     free (hd->address);
 350
 351   hd->address = strdup (ci->values[0].value.string);
 352   if (hd->address == NULL)
 353     return (-1);
 354
 355   DEBUG ("snmp plugin: host = %s; host->address = %s;",
 356       hd->name, hd->address);
 357
 358   return (0);
 359 } /* int csnmp_config_add_host_address */
 360
 361 static int csnmp_config_add_host_community (host_definition_t *hd, oconfig_item_t *ci)
 362 {
 363   if ((ci->values_num != 1)
 364       || (ci->values[0].type != OCONFIG_TYPE_STRING))
 365   {
 366     WARNING ("snmp plugin: The `Community' config option needs exactly one string argument.");
 367     return (-1);
 368   }
 369
 370   if (hd->community == NULL)
 371     free (hd->community);
 372
 373   hd->community = strdup (ci->values[0].value.string);
 374   if (hd->community == NULL)
 375     return (-1);
 376
 377   DEBUG ("snmp plugin: host = %s; host->community = %s;",
 378       hd->name, hd->community);
 379
 380   return (0);
 381 } /* int csnmp_config_add_host_community */
 382
 383 static int csnmp_config_add_host_version (host_definition_t *hd, oconfig_item_t *ci)
 384 {
 385   int version;
 386
 387   if ((ci->values_num != 1)
 388       || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
 389   {
 390     WARNING ("snmp plugin: The `Version' config option needs exactly one number argument.");
 391     return (-1);
 392   }
 393
 394   version = (int) ci->values[0].value.number;
 395   if ((version != 1) && (version != 2))
 396   {
 397     WARNING ("snmp plugin: `Version' must either be `1' or `2'.");
 398     return (-1);
 399   }
 400
 401   hd->version = version;
 402
 403   return (0);
 404 } /* int csnmp_config_add_host_address */
 405
 406 static int csnmp_config_add_host_collect (host_definition_t *host,
 407     oconfig_item_t *ci)
 408 {
 409   data_definition_t *data;
 410   data_definition_t **data_list;
 411   int data_list_len;
 412   int i;
 413
 414   if (ci->values_num < 1)
 415   {
 416     WARNING ("snmp plugin: `Collect' needs at least one argument.");
 417     return (-1);
 418   }
 419
 420   for (i = 0; i < ci->values_num; i++)
 421     if (ci->values[i].type != OCONFIG_TYPE_STRING)
 422     {
 423       WARNING ("snmp plugin: All arguments to `Collect' must be strings.");
 424       return (-1);
 425     }
 426
 427   data_list_len = host->data_list_len + ci->values_num;
 428   data_list = (data_definition_t **) realloc (host->data_list,
 429       sizeof (data_definition_t *) * data_list_len);
 430   if (data_list == NULL)
 431     return (-1);
 432   host->data_list = data_list;
 433
 434   for (i = 0; i < ci->values_num; i++)
 435   {
 436     for (data = data_head; data != NULL; data = data->next)
 437       if (strcasecmp (ci->values[i].value.string, data->name) == 0)
 438         break;
 439
 440     if (data == NULL)
 441     {
 442       WARNING ("snmp plugin: No such data configured: `%s'",
 443           ci->values[i].value.string);
 444       continue;
 445     }
 446
 447     DEBUG ("snmp plugin: Collect: host = %s, data[%i] = %s;",
 448         host->name, host->data_list_len, data->name);
 449
 450     host->data_list[host->data_list_len] = data;
 451     host->data_list_len++;
 452   } /* for (values_num) */
 453
 454   return (0);
 455 } /* int csnmp_config_add_host_collect */
 456
 457 static int csnmp_config_add_host_interval (host_definition_t *hd, oconfig_item_t *ci)
 458 {
 459   int interval;
 460
 461   if ((ci->values_num != 1)
 462       || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
 463   {
 464     WARNING ("snmp plugin: The `Interval' config option needs exactly one number argument.");
 465     return (-1);
 466   }
 467
 468   interval = (int) ci->values[0].value.number;
 469   hd->skip_num = interval;
 470   if (hd->skip_num < 0)
 471     hd->skip_num = 0;
 472
 473   return (0);
 474 } /* int csnmp_config_add_host_interval */
 475
 476 static int csnmp_config_add_host (oconfig_item_t *ci)
 477 {
 478   host_definition_t *hd;
 479   int status = 0;
 480   int i;
 481
 482   if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
 483   {
 484     WARNING ("snmp plugin: `Host' needs exactly one string argument.");
 485     return (-1);
 486   }
 487
 488   hd = (host_definition_t *) malloc (sizeof (host_definition_t));
 489   if (hd == NULL)
 490     return (-1);
 491   memset (hd, '\0', sizeof (host_definition_t));
 492   hd->version = 2;
 493
 494   hd->name = strdup (ci->values[0].value.string);
 495   if (hd->name == NULL)
 496   {
 497     free (hd);
 498     return (-1);
 499   }
 500
 501   hd->sess_handle = NULL;
 502   hd->skip_num = 0;
 503   hd->skip_left = 0;
 504   hd->state = STATE_IDLE;
 505
 506   for (i = 0; i < ci->children_num; i++)
 507   {
 508     oconfig_item_t *option = ci->children + i;
 509     status = 0;
 510
 511     if (strcasecmp ("Address", option->key) == 0)
 512       status = csnmp_config_add_host_address (hd, option);
 513     else if (strcasecmp ("Community", option->key) == 0)
 514       status = csnmp_config_add_host_community (hd, option);
 515     else if (strcasecmp ("Version", option->key) == 0)
 516       status = csnmp_config_add_host_version (hd, option);
 517     else if (strcasecmp ("Collect", option->key) == 0)
 518       csnmp_config_add_host_collect (hd, option);
 519     else if (strcasecmp ("Interval", option->key) == 0)
 520       csnmp_config_add_host_interval (hd, option);
 521     else
 522     {
 523       WARNING ("snmp plugin: csnmp_config_add_host: Option `%s' not allowed here.", option->key);
 524       status = -1;
 525     }
 526
 527     if (status != 0)
 528       break;
 529   } /* for (ci->children) */
 530
 531   while (status == 0)
 532   {
 533     if (hd->address == NULL)
 534     {
 535       WARNING ("snmp plugin: `Address' not given for host `%s'", hd->name);
 536       status = -1;
 537       break;
 538     }
 539     if (hd->community == NULL)
 540     {
 541       WARNING ("snmp plugin: `Community' not given for host `%s'", hd->name);
 542       status = -1;
 543       break;
 544     }
 545
 546     break;
 547   } /* while (status == 0) */
 548
 549   if (status != 0)
 550   {
 551     sfree (hd->name);
 552     sfree (hd);
 553     return (-1);
 554   }
 555
 556   DEBUG ("snmp plugin: hd = { name = %s, address = %s, community = %s, version = %i }",
 557       hd->name, hd->address, hd->community, hd->version);
 558
 559   if (host_head == NULL)
 560     host_head = hd;
 561   else
 562   {
 563     host_definition_t *last;
 564     last = host_head;
 565     while (last->next != NULL)
 566       last = last->next;
 567     last->next = hd;
 568   }
 569
 570   return (0);
 571 } /* int csnmp_config_add_host */
 572
 573 static int csnmp_config (oconfig_item_t *ci)
 574 {
 575   int i;
 576
 577   call_snmp_init_once ();
 578
 579   for (i = 0; i < ci->children_num; i++)
 580   {
 581     oconfig_item_t *child = ci->children + i;
 582     if (strcasecmp ("Data", child->key) == 0)
 583       csnmp_config_add_data (child);
 584     else if (strcasecmp ("Host", child->key) == 0)
 585       csnmp_config_add_host (child);
 586     else
 587     {
 588       WARNING ("snmp plugin: Ignoring unknown config option `%s'.", child->key);
 589     }
 590   } /* for (ci->children) */
 591
 592   return (0);
 593 } /* int csnmp_config */
 594
 595 /* End of the config stuff. Now the interesting part begins */
 596
 597 static void csnmp_host_close_session (host_definition_t *host)
 598 {
 599   int status;
 600
 601   if (host->sess_handle == NULL)
 602     return;
 603
 604   status = snmp_sess_close (host->sess_handle);
 605
 606   if (status != 0)
 607   {
 608     char *errstr = NULL;
 609
 610     snmp_sess_error (host->sess_handle, NULL, NULL, &errstr);
 611
 612     ERROR ("snmp plugin: snmp_sess_close failed: %s",
 613         (errstr == NULL) ? "Unknown problem" : errstr);
 614     sfree (errstr);
 615   }
 616
 617   host->sess_handle = NULL;
 618 } /* void csnmp_host_close_session */
 619
 620 static void csnmp_host_open_session (host_definition_t *host)
 621 {
 622   struct snmp_session sess;
 623
 624   if (host->sess_handle != NULL)
 625     csnmp_host_close_session (host);
 626
 627   snmp_sess_init (&sess);
 628   sess.peername = host->address;
 629   sess.community = (u_char *) host->community;
 630   sess.community_len = strlen (host->community);
 631   sess.version = (host->version == 1) ? SNMP_VERSION_1 : SNMP_VERSION_2c;
 632
 633   /* snmp_sess_open will copy the `struct snmp_session *'. */
 634   host->sess_handle = snmp_sess_open (&sess);
 635
 636   if (host->sess_handle == NULL)
 637   {
 638     char *errstr = NULL;
 639
 640     snmp_error (&sess, NULL, NULL, &errstr);
 641
 642     ERROR ("snmp plugin: snmp_sess_open failed: %s",
 643         (errstr == NULL) ? "Unknown problem" : errstr);
 644     sfree (errstr);
 645   }
 646 } /* void csnmp_host_open_session */
 647
 648 static value_t csnmp_value_list_to_value (struct variable_list *vl, int type)
 649 {
 650   value_t ret;
 651   uint64_t temp = 0;
 652   int defined = 1;
 653
 654   if ((vl->type == ASN_INTEGER)
 655       || (vl->type == ASN_UINTEGER)
 656       || (vl->type == ASN_COUNTER)
 657 #ifdef ASN_TIMETICKS
 658       || (vl->type == ASN_TIMETICKS)
 659 #endif
 660       || (vl->type == ASN_GAUGE))
 661   {
 662     temp = (uint32_t) *vl->val.integer;
 663     DEBUG ("snmp plugin: Parsed int32 value is %llu.", temp);
 664   }
 665   else if (vl->type == ASN_COUNTER64)
 666   {
 667     temp = (uint32_t) vl->val.counter64->high;
 668     temp = temp << 32;
 669     temp += (uint32_t) vl->val.counter64->low;
 670     DEBUG ("snmp plugin: Parsed int64 value is %llu.", temp);
 671   }
 672   else
 673   {
 674     WARNING ("snmp plugin: I don't know the ASN type `%i'", (int) vl->type);
 675     defined = 0;
 676   }
 677
 678   if (type == DS_TYPE_COUNTER)
 679   {
 680     ret.counter = temp;
 681   }
 682   else if (type == DS_TYPE_GAUGE)
 683   {
 684     ret.gauge = NAN;
 685     if (defined != 0)
 686       ret.gauge = temp;
 687   }
 688
 689   return (ret);
 690 } /* value_t csnmp_value_list_to_value */
 691
 692 static int csnmp_dispatch_table (host_definition_t *host, data_definition_t *data,
 693     csnmp_list_instances_t *instance_list,
 694     csnmp_table_values_t **value_table)
 695 {
 696   const data_set_t *ds;
 697   value_list_t vl = VALUE_LIST_INIT;
 698
 699   csnmp_list_instances_t *instance_list_ptr;
 700   csnmp_table_values_t **value_table_ptr;
 701
 702   int i;
 703
 704   ds = plugin_get_ds (data->type);
 705   if (!ds)
 706   {
 707     ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
 708     return (-1);
 709   }
 710   assert (ds->ds_num == data->values_len);
 711
 712   value_table_ptr = (csnmp_table_values_t **) malloc (sizeof (csnmp_table_values_t *)
 713       * data->values_len);
 714   if (value_table_ptr == NULL)
 715     return (-1);
 716   for (i = 0; i < data->values_len; i++)
 717     value_table_ptr[i] = value_table[i];
 718
 719   vl.values_len = ds->ds_num;
 720   vl.values = (value_t *) malloc (sizeof (value_t) * vl.values_len);
 721   if (vl.values == NULL)
 722   {
 723     sfree (value_table_ptr);
 724     return (-1);
 725   }
 726
 727   strncpy (vl.host, host->name, sizeof (vl.host));
 728   vl.host[sizeof (vl.host) - 1] = '\0';
 729   strcpy (vl.plugin, "snmp");
 730
 731   vl.interval = host->skip_num;
 732   vl.time = time (NULL);
 733
 734   for (instance_list_ptr = instance_list;
 735       instance_list_ptr != NULL;
 736       instance_list_ptr = instance_list_ptr->next)
 737   {
 738     strncpy (vl.type_instance, instance_list_ptr->instance, sizeof (vl.type_instance));
 739     vl.type_instance[sizeof (vl.type_instance) - 1] = '\0';
 740
 741     for (i = 0; i < data->values_len; i++)
 742     {
 743       while ((value_table_ptr[i] != NULL)
 744           && (value_table_ptr[i]->subid < instance_list_ptr->subid))
 745         value_table_ptr[i] = value_table_ptr[i]->next;
 746       if ((value_table_ptr[i] == NULL)
 747           || (value_table_ptr[i]->subid != instance_list_ptr->subid))
 748         break;
 749       vl.values[i] = value_table_ptr[i]->value;
 750     } /* for (data->values_len) */
 751
 752     /* If the for-loop was aborted early, not all subid's match. */
 753     if (i < data->values_len)
 754     {
 755       DEBUG ("snmp plugin: host = %s; data = %s; i = %i; "
 756           "Skipping SUBID %i",
 757           host->name, data->name, i, instance_list_ptr->subid);
 758       continue;
 759     }
 760
 761     /* If we get here `vl.type_instance' and all `vl.values' have been set */
 762     plugin_dispatch_values (data->type, &vl);
 763   } /* for (instance_list) */
 764
 765   sfree (vl.values);
 766   sfree (value_table_ptr);
 767
 768   return (0);
 769 } /* int csnmp_dispatch_table */
 770
 771 static int csnmp_read_table (host_definition_t *host, data_definition_t *data)
 772 {
 773   struct snmp_pdu *req;
 774   struct snmp_pdu *res;
 775   struct variable_list *vb;
 776
 777   const data_set_t *ds;
 778   oid_t *oid_list;
 779   uint32_t oid_list_len;
 780
 781   int status;
 782   int i;
 783
 784   /* `value_table' and `value_table_ptr' implement a linked list for each
 785    * value. `instance_list' and `instance_list_ptr' implement a linked list of
 786    * instance names. This is used to jump gaps in the table. */
 787   csnmp_list_instances_t *instance_list;
 788   csnmp_list_instances_t *instance_list_ptr;
 789   csnmp_table_values_t **value_table;
 790   csnmp_table_values_t **value_table_ptr;
 791
 792   DEBUG ("snmp plugin: csnmp_read_table (host = %s, data = %s)",
 793       host->name, data->name);
 794
 795   ds = plugin_get_ds (data->type);
 796   if (!ds)
 797   {
 798     ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
 799     return (-1);
 800   }
 801
 802   if (ds->ds_num != data->values_len)
 803   {
 804     ERROR ("snmp plugin: DataSet `%s' requires %i values, but config talks about %i",
 805         data->type, ds->ds_num, data->values_len);
 806     return (-1);
 807   }
 808
 809   /* We need a copy of all the OIDs, because GETNEXT will destroy them. */
 810   oid_list_len = data->values_len + 1;
 811   oid_list = (oid_t *) malloc (sizeof (oid_t) * (oid_list_len));
 812   if (oid_list == NULL)
 813     return (-1);
 814   memcpy (oid_list, &data->instance.oid, sizeof (oid_t));
 815   for (i = 0; i < data->values_len; i++)
 816     memcpy (oid_list + (i + 1), data->values + i, sizeof (oid_t));
 817
 818   /* Allocate the `value_table' */
 819   value_table = (csnmp_table_values_t **) malloc (sizeof (csnmp_table_values_t *)
 820       * 2 * data->values_len);
 821   if (value_table == NULL)
 822   {
 823     sfree (oid_list);
 824     return (-1);
 825   }
 826   memset (value_table, '\0', sizeof (csnmp_table_values_t *) * 2 * data->values_len);
 827   value_table_ptr = value_table + data->values_len;
 828
 829   instance_list = NULL;
 830   instance_list_ptr = NULL;
 831
 832   status = 0;
 833   while (status == 0)
 834   {
 835     csnmp_list_instances_t *il;
 836
 837     req = snmp_pdu_create (SNMP_MSG_GETNEXT);
 838     if (req == NULL)
 839     {
 840       ERROR ("snmp plugin: snmp_pdu_create failed.");
 841       status = -1;
 842       break;
 843     }
 844
 845     for (i = 0; i < oid_list_len; i++)
 846       snmp_add_null_var (req, oid_list[i].oid, oid_list[i].oid_len);
 847
 848     status = snmp_sess_synch_response (host->sess_handle, req, &res);
 849
 850     if (status != STAT_SUCCESS)
 851     {
 852       char *errstr = NULL;
 853
 854       snmp_sess_error (host->sess_handle, NULL, NULL, &errstr);
 855       ERROR ("snmp plugin: snmp_sess_synch_response failed: %s",
 856           (errstr == NULL) ? "Unknown problem" : errstr);
 857       csnmp_host_close_session (host);
 858
 859       status = -1;
 860       break;
 861     }
 862     status = 0;
 863     assert (res != NULL);
 864
 865     vb = res->variables;
 866     if (vb == NULL)
 867     {
 868       status = -1;
 869       break;
 870     }
 871
 872     /* Check if we left the subtree */
 873     if (snmp_oid_ncompare (data->instance.oid.oid, data->instance.oid.oid_len,
 874           vb->name, vb->name_length,
 875           data->instance.oid.oid_len) != 0)
 876       break;
 877
 878     /* Allocate a new `csnmp_list_instances_t', insert the instance name and
 879      * add it to the list */
 880     il = (csnmp_list_instances_t *) malloc (sizeof (csnmp_list_instances_t));
 881     if (il == NULL)
 882     {
 883       status = -1;
 884       break;
 885     }
 886     il->subid = vb->name[vb->name_length - 1];
 887     il->next = NULL;
 888
 889     /* Get instance name */
 890     if ((vb->type == ASN_OCTET_STR) || (vb->type == ASN_BIT_STR))
 891     {
 892       char *ptr;
 893       size_t instance_len;
 894
 895       instance_len = sizeof (il->instance) - 1;
 896       if (instance_len > vb->val_len)
 897         instance_len = vb->val_len;
 898
 899       strncpy (il->instance, (char *) ((vb->type == ASN_OCTET_STR)
 900             ? vb->val.string
 901             : vb->val.bitstring),
 902           instance_len);
 903       il->instance[instance_len] = '\0';
 904
 905       for (ptr = il->instance; *ptr != '\0'; ptr++)
 906       {
 907         if ((*ptr > 0) && (*ptr < 32))
 908           *ptr = ' ';
 909         else if (*ptr == '/')
 910           *ptr = '_';
 911       }
 912       DEBUG ("snmp plugin: il->instance = `%s';", il->instance);
 913     }
 914     else
 915     {
 916       value_t val = csnmp_value_list_to_value (vb, DS_TYPE_COUNTER);
 917       snprintf (il->instance, sizeof (il->instance),
 918           "%llu", val.counter);
 919     }
 920     il->instance[sizeof (il->instance) - 1] = '\0';
 921     DEBUG ("snmp plugin: data = `%s'; il->instance = `%s';",
 922         data->name, il->instance);
 923
 924     if (instance_list_ptr == NULL)
 925       instance_list = il;
 926     else
 927       instance_list_ptr->next = il;
 928     instance_list_ptr = il;
 929
 930     /* Copy OID to oid_list[0] */
 931     memcpy (oid_list[0].oid, vb->name, sizeof (oid) * vb->name_length);
 932     oid_list[0].oid_len = vb->name_length;
 933
 934     for (i = 0; i < data->values_len; i++)
 935     {
 936       csnmp_table_values_t *vt;
 937
 938       vb = vb->next_variable;
 939       if (vb == NULL)
 940       {
 941         status = -1;
 942         break;
 943       }
 944
 945       /* Check if we left the subtree */
 946       if (snmp_oid_ncompare (data->values[i].oid,
 947             data->values[i].oid_len,
 948             vb->name, vb->name_length,
 949             data->values[i].oid_len) != 0)
 950       {
 951         DEBUG ("snmp plugin: host = %s; data = %s; Value %i left its subtree.",
 952             host->name, data->name, i);
 953         continue;
 954       }
 955
 956       if ((value_table_ptr[i] != NULL)
 957           && (vb->name[vb->name_length - 1] <= value_table_ptr[i]->subid))
 958       {
 959         DEBUG ("snmp plugin: host = %s; data = %s; i = %i; SUBID is not increasing.",
 960             host->name, data->name, i);
 961         continue;
 962       }
 963
 964       vt = (csnmp_table_values_t *) malloc (sizeof (csnmp_table_values_t));
 965       if (vt != NULL)
 966       {
 967         vt->subid = vb->name[vb->name_length - 1];
 968         vt->value = csnmp_value_list_to_value (vb, ds->ds[i].type);
 969         vt->next = NULL;
 970
 971         if (value_table_ptr[i] == NULL)
 972           value_table[i] = vt;
 973         else
 974           value_table_ptr[i]->next = vt;
 975         value_table_ptr[i] = vt;
 976       }
 977
 978       /* Copy OID to oid_list[i + 1] */
 979       memcpy (oid_list[i + 1].oid, vb->name, sizeof (oid) * vb->name_length);
 980       oid_list[i + 1].oid_len = vb->name_length;
 981     } /* for (i = data->values_len) */
 982
 983     if (res != NULL)
 984       snmp_free_pdu (res);
 985     res = NULL;
 986   } /* while (status == 0) */
 987
 988   if (status == 0)
 989     csnmp_dispatch_table (host, data, instance_list, value_table);
 990
 991   /* Free all allocated variables here */
 992   while (instance_list != NULL)
 993   {
 994     instance_list_ptr = instance_list->next;
 995     sfree (instance_list);
 996     instance_list = instance_list_ptr;
 997   }
 998
 999   for (i = 0; i < data->values_len; i++)
1000   {
1001     csnmp_table_values_t *tmp;
1002     while (value_table[i] != NULL)
1003     {
1004       tmp = value_table[i]->next;
1005       sfree (value_table[i]);
1006       value_table[i] = tmp;
1007     }
1008   }
1009
1010   sfree (value_table);
1011   sfree (oid_list);
1012
1013   return (0);
1014 } /* int csnmp_read_table */
1015
1016 static int csnmp_read_value (host_definition_t *host, data_definition_t *data)
1017 {
1018   struct snmp_pdu *req;
1019   struct snmp_pdu *res;
1020   struct variable_list *vb;
1021
1022   const data_set_t *ds;
1023   value_list_t vl = VALUE_LIST_INIT;
1024
1025   int status;
1026   int i;
1027
1028   DEBUG ("snmp plugin: csnmp_read_value (host = %s, data = %s)",
1029       host->name, data->name);
1030
1031   ds = plugin_get_ds (data->type);
1032   if (!ds)
1033   {
1034     ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
1035     return (-1);
1036   }
1037
1038   if (ds->ds_num != data->values_len)
1039   {
1040     ERROR ("snmp plugin: DataSet `%s' requires %i values, but config talks about %i",
1041         data->type, ds->ds_num, data->values_len);
1042     return (-1);
1043   }
1044
1045   vl.values_len = ds->ds_num;
1046   vl.values = (value_t *) malloc (sizeof (value_t) * vl.values_len);
1047   if (vl.values == NULL)
1048     return (-1);
1049   for (i = 0; i < vl.values_len; i++)
1050   {
1051     if (ds->ds[i].type == DS_TYPE_COUNTER)
1052       vl.values[i].counter = 0;
1053     else
1054       vl.values[i].gauge = NAN;
1055   }
1056
1057   strncpy (vl.host, host->name, sizeof (vl.host));
1058   vl.host[sizeof (vl.host) - 1] = '\0';
1059   strcpy (vl.plugin, "snmp");
1060   strncpy (vl.type_instance, data->instance.string, sizeof (vl.type_instance));
1061   vl.type_instance[sizeof (vl.type_instance) - 1] = '\0';
1062
1063   vl.interval = host->skip_num;
1064
1065   req = snmp_pdu_create (SNMP_MSG_GET);
1066   if (req == NULL)
1067   {
1068     ERROR ("snmp plugin: snmp_pdu_create failed.");
1069     sfree (vl.values);
1070     return (-1);
1071   }
1072
1073   for (i = 0; i < data->values_len; i++)
1074     snmp_add_null_var (req, data->values[i].oid, data->values[i].oid_len);
1075   status = snmp_sess_synch_response (host->sess_handle, req, &res);
1076
1077   if (status != STAT_SUCCESS)
1078   {
1079     char *errstr = NULL;
1080
1081     snmp_sess_error (host->sess_handle, NULL, NULL, &errstr);
1082     ERROR ("snmp plugin: snmp_sess_synch_response failed: %s",
1083         (errstr == NULL) ? "Unknown problem" : errstr);
1084     csnmp_host_close_session (host);
1085     sfree (errstr);
1086
1087     return (-1);
1088   }
1089
1090   vl.time = time (NULL);
1091
1092   for (vb = res->variables; vb != NULL; vb = vb->next_variable)
1093   {
1094     char buffer[1024];
1095     snprint_variable (buffer, sizeof (buffer),
1096         vb->name, vb->name_length, vb);
1097     DEBUG ("snmp plugin: Got this variable: %s", buffer);
1098
1099     for (i = 0; i < data->values_len; i++)
1100       if (snmp_oid_compare (data->values[i].oid, data->values[i].oid_len,
1101             vb->name, vb->name_length) == 0)
1102         vl.values[i] = csnmp_value_list_to_value (vb, ds->ds[i].type);
1103   } /* for (res->variables) */
1104
1105   snmp_free_pdu (res);
1106
1107   DEBUG ("snmp plugin: -> plugin_dispatch_values (%s, &vl);", data->type);
1108   plugin_dispatch_values (data->type, &vl);
1109   sfree (vl.values);
1110
1111   return (0);
1112 } /* int csnmp_read_value */
1113
1114 static int csnmp_read_host (host_definition_t *host)
1115 {
1116   int i;
1117
1118   DEBUG ("snmp plugin: csnmp_read_host (%s);", host->name);
1119
1120   if (host->sess_handle == NULL)
1121     csnmp_host_open_session (host);
1122
1123   if (host->sess_handle == NULL)
1124     return (-1);
1125
1126   for (i = 0; i < host->data_list_len; i++)
1127   {
1128     data_definition_t *data = host->data_list[i];
1129
1130     if (data->is_table)
1131       csnmp_read_table (host, data);
1132     else
1133       csnmp_read_value (host, data);
1134   }
1135
1136   return (0);
1137 } /* int csnmp_read_host */
1138
1139 static void *csnmp_read_thread (void *data)
1140 {
1141   host_definition_t *host;
1142
1143   pthread_mutex_lock (&host_lock);
1144   while (do_shutdown == 0)
1145   {
1146     pthread_cond_wait (&host_cond, &host_lock);
1147
1148     for (host = host_head; host != NULL; host = host->next)
1149     {
1150       if (do_shutdown != 0)
1151         break;
1152       if (host->state != STATE_WAIT)
1153         continue;
1154
1155       host->state = STATE_BUSY;
1156       pthread_mutex_unlock (&host_lock);
1157       csnmp_read_host (host);
1158       pthread_mutex_lock (&host_lock);
1159       host->state = STATE_IDLE;
1160     } /* for (host) */
1161   } /* while (do_shutdown == 0) */
1162   pthread_mutex_unlock (&host_lock);
1163
1164   pthread_exit ((void *) 0);
1165   return ((void *) 0);
1166 } /* void *csnmp_read_thread */
1167
1168 static int csnmp_init (void)
1169 {
1170   host_definition_t *host;
1171   int i;
1172
1173   if (host_head == NULL)
1174     return (-1);
1175
1176   call_snmp_init_once ();
1177
1178   threads_num = 0;
1179   for (host = host_head; host != NULL; host = host->next)
1180   {
1181     threads_num++;
1182     /* We need to initialize `skip_num' here, because `interval_g' isn't
1183      * initialized during `configure'. */
1184     host->skip_left = interval_g;
1185     if (host->skip_num == 0)
1186     {
1187       host->skip_num = interval_g;
1188     }
1189     else if (host->skip_num < interval_g)
1190     {
1191       host->skip_num = interval_g;
1192       WARNING ("snmp plugin: Data for host `%s' will be collected every %i seconds.",
1193           host->name, host->skip_num);
1194     }
1195
1196     csnmp_host_open_session (host);
1197   } /* for (host) */
1198
1199   /* Now start the reading threads */
1200   if (threads_num > 3)
1201   {
1202     threads_num = 3 + ((threads_num - 3) / 10);
1203     if (threads_num > 10)
1204       threads_num = 10;
1205   }
1206
1207   threads = (pthread_t *) malloc (threads_num * sizeof (pthread_t));
1208   if (threads == NULL)
1209     return (-1);
1210   memset (threads, '\0', threads_num * sizeof (pthread_t));
1211
1212   for (i = 0; i < threads_num; i++)
1213       pthread_create (threads + i, NULL, csnmp_read_thread, (void *) 0);
1214
1215   return (0);
1216 } /* int csnmp_init */
1217
1218 static int csnmp_read (void)
1219 {
1220   host_definition_t *host;
1221   time_t now;
1222
1223   if (host_head == NULL)
1224   {
1225     INFO ("snmp plugin: No hosts configured.");
1226     return (-1);
1227   }
1228
1229   now = time (NULL);
1230
1231   pthread_mutex_lock (&host_lock);
1232   for (host = host_head; host != NULL; host = host->next)
1233   {
1234     if (host->state != STATE_IDLE)
1235       continue;
1236
1237     host->skip_left -= interval_g;
1238     if (host->skip_left >= interval_g)
1239       continue;
1240
1241     host->state = STATE_WAIT;
1242
1243     host->skip_left = host->skip_num;
1244   } /* for (host) */
1245
1246   pthread_cond_broadcast (&host_cond);
1247   pthread_mutex_unlock (&host_lock);
1248
1249   return (0);
1250 } /* int csnmp_read */
1251
1252 static int csnmp_shutdown (void)
1253 {
1254   host_definition_t *host_this;
1255   host_definition_t *host_next;
1256
1257   data_definition_t *data_this;
1258   data_definition_t *data_next;
1259
1260   int i;
1261
1262   pthread_mutex_lock (&host_lock);
1263   do_shutdown = 1;
1264   pthread_cond_broadcast (&host_cond);
1265   pthread_mutex_unlock (&host_lock);
1266
1267   for (i = 0; i < threads_num; i++)
1268     pthread_join (threads[i], NULL);
1269
1270   /* Now that all the threads have exited, let's free all the global variables.
1271    * This isn't really neccessary, I guess, but I think it's good stile to do
1272    * so anyway. */
1273   host_this = host_head;
1274   host_head = NULL;
1275   while (host_this != NULL)
1276   {
1277     host_next = host_this->next;
1278
1279     csnmp_host_close_session (host_this);
1280
1281     sfree (host_this->name);
1282     sfree (host_this->address);
1283     sfree (host_this->community);
1284     sfree (host_this->data_list);
1285     sfree (host_this);
1286
1287     host_this = host_next;
1288   }
1289
1290   data_this = data_head;
1291   data_head = NULL;
1292   while (data_this != NULL)
1293   {
1294     data_next = data_this->next;
1295
1296     sfree (data_this->name);
1297     sfree (data_this->type);
1298     sfree (data_this->values);
1299     sfree (data_this);
1300
1301     data_this = data_next;
1302   }
1303
1304   return (0);
1305 } /* int csnmp_shutdown */
1306
1307 void module_register (void)
1308 {
1309   plugin_register_complex_config ("snmp", csnmp_config);
1310   plugin_register_init ("snmp", csnmp_init);
1311   plugin_register_read ("snmp", csnmp_read);
1312   plugin_register_shutdown ("snmp", csnmp_shutdown);
1313 } /* void module_register */
1314
1315 /*
1316  * vim: shiftwidth=2 softtabstop=2 tabstop=8
1317  */