src/snmp.c

   1 /**
   2  * collectd - src/snmp.c
   3  * Copyright (C) 2007-2012  Florian octo Forster
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a
   6  * copy of this software and associated documentation files (the "Software"),
   7  * to deal in the Software without restriction, including without limitation
   8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   9  * and/or sell copies of the Software, and to permit persons to whom the
  10  * Software is furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21  * DEALINGS IN THE SOFTWARE.
  22  *
  23  * Authors:
  24  *   Florian octo Forster <octo at collectd.org>
  25  **/
  26
  27 #include "collectd.h"
  28
  29 #include "plugin.h"
  30 #include "utils/common/common.h"
  31 #include "utils/ignorelist/ignorelist.h"
  32 #include "utils_complain.h"
  33
  34 #include <net-snmp/net-snmp-config.h>
  35 #include <net-snmp/net-snmp-includes.h>
  36
  37 #include <fnmatch.h>
  38
  39 /*
  40  * Private data structes
  41  */
  42 struct oid_s {
  43   oid oid[MAX_OID_LEN];
  44   size_t oid_len;
  45 };
  46 typedef struct oid_s oid_t;
  47
  48 struct instance_s {
  49   bool configured;
  50   oid_t oid;
  51   char *prefix;
  52   char *value;
  53 };
  54 typedef struct instance_s instance_t;
  55
  56 struct data_definition_s {
  57   char *name; /* used to reference this from the `Collect' option */
  58   char *type; /* used to find the data_set */
  59   bool is_table;
  60   instance_t type_instance;
  61   instance_t plugin_instance;
  62   instance_t host;
  63   oid_t filter_oid;
  64   ignorelist_t *ignorelist;
  65   char *plugin_name;
  66   oid_t *values;
  67   size_t values_len;
  68   double scale;
  69   double shift;
  70   struct data_definition_s *next;
  71   char **ignores;
  72   size_t ignores_len;
  73   bool invert_match;
  74 };
  75 typedef struct data_definition_s data_definition_t;
  76
  77 struct host_definition_s {
  78   char *name;
  79   char *address;
  80   int version;
  81   cdtime_t timeout;
  82   int retries;
  83
  84   /* snmpv1/2 options */
  85   char *community;
  86
  87   /* snmpv3 security options */
  88   char *username;
  89   oid *auth_protocol;
  90   size_t auth_protocol_len;
  91   char *auth_passphrase;
  92   oid *priv_protocol;
  93   size_t priv_protocol_len;
  94   char *priv_passphrase;
  95   int security_level;
  96   char *context;
  97
  98   void *sess_handle;
  99   c_complain_t complaint;
 100   data_definition_t **data_list;
 101   int data_list_len;
 102
 103   int bulk_size;
 104 };
 105 typedef struct host_definition_s host_definition_t;
 106
 107 /* These two types are used to cache values in `csnmp_read_table' to handle
 108  * gaps in tables. */
 109 struct csnmp_cell_char_s {
 110   oid_t suffix;
 111   char value[DATA_MAX_NAME_LEN];
 112   struct csnmp_cell_char_s *next;
 113 };
 114 typedef struct csnmp_cell_char_s csnmp_cell_char_t;
 115
 116 struct csnmp_cell_value_s {
 117   oid_t suffix;
 118   value_t value;
 119   struct csnmp_cell_value_s *next;
 120 };
 121 typedef struct csnmp_cell_value_s csnmp_cell_value_t;
 122
 123 typedef enum {
 124   OID_TYPE_SKIP = 0,
 125   OID_TYPE_VARIABLE,
 126   OID_TYPE_TYPEINSTANCE,
 127   OID_TYPE_PLUGININSTANCE,
 128   OID_TYPE_HOST,
 129   OID_TYPE_FILTER,
 130 } csnmp_oid_type_t;
 131
 132 /*
 133  * Private variables
 134  */
 135 static data_definition_t *data_head;
 136
 137 /*
 138  * Prototypes
 139  */
 140 static int csnmp_read_host(user_data_t *ud);
 141
 142 /*
 143  * Private functions
 144  */
 145 static void csnmp_oid_init(oid_t *dst, oid const *src, size_t n) {
 146   assert(n <= STATIC_ARRAY_SIZE(dst->oid));
 147   memcpy(dst->oid, src, sizeof(*src) * n);
 148   dst->oid_len = n;
 149 }
 150
 151 static int csnmp_oid_compare(oid_t const *left, oid_t const *right) {
 152   return snmp_oid_compare(left->oid, left->oid_len, right->oid, right->oid_len);
 153 }
 154
 155 static int csnmp_oid_suffix(oid_t *dst, oid_t const *src, oid_t const *root) {
 156   /* Make sure "src" is in "root"s subtree. */
 157   if (src->oid_len <= root->oid_len)
 158     return EINVAL;
 159   if (snmp_oid_ncompare(root->oid, root->oid_len, src->oid, src->oid_len,
 160                         /* n = */ root->oid_len) != 0)
 161     return EINVAL;
 162
 163   memset(dst, 0, sizeof(*dst));
 164   dst->oid_len = src->oid_len - root->oid_len;
 165   memcpy(dst->oid, &src->oid[root->oid_len],
 166          dst->oid_len * sizeof(dst->oid[0]));
 167   return 0;
 168 }
 169
 170 static int csnmp_oid_to_string(char *buffer, size_t buffer_size,
 171                                oid_t const *o) {
 172   char oid_str[MAX_OID_LEN][16];
 173   char *oid_str_ptr[MAX_OID_LEN];
 174
 175   for (size_t i = 0; i < o->oid_len; i++) {
 176     ssnprintf(oid_str[i], sizeof(oid_str[i]), "%lu", (unsigned long)o->oid[i]);
 177     oid_str_ptr[i] = oid_str[i];
 178   }
 179
 180   return strjoin(buffer, buffer_size, oid_str_ptr, o->oid_len, ".");
 181 }
 182
 183 static void csnmp_host_close_session(host_definition_t *host) /* {{{ */
 184 {
 185   if (host->sess_handle == NULL)
 186     return;
 187
 188   snmp_sess_close(host->sess_handle);
 189   host->sess_handle = NULL;
 190 } /* }}} void csnmp_host_close_session */
 191
 192 static void csnmp_host_definition_destroy(void *arg) /* {{{ */
 193 {
 194   host_definition_t *hd;
 195
 196   hd = arg;
 197
 198   if (hd == NULL)
 199     return;
 200
 201   if (hd->name != NULL) {
 202     DEBUG("snmp plugin: Destroying host definition for host `%s'.", hd->name);
 203   }
 204
 205   csnmp_host_close_session(hd);
 206
 207   sfree(hd->name);
 208   sfree(hd->address);
 209   sfree(hd->community);
 210   sfree(hd->username);
 211   sfree(hd->auth_passphrase);
 212   sfree(hd->priv_passphrase);
 213   sfree(hd->context);
 214   sfree(hd->data_list);
 215
 216   sfree(hd);
 217 } /* }}} void csnmp_host_definition_destroy */
 218
 219 static void csnmp_data_definition_destroy(data_definition_t *dd) {
 220   sfree(dd->name);
 221   sfree(dd->type);
 222   sfree(dd->plugin_name);
 223   sfree(dd->plugin_instance.prefix);
 224   sfree(dd->plugin_instance.value);
 225   sfree(dd->type_instance.prefix);
 226   sfree(dd->type_instance.value);
 227   sfree(dd->host.prefix);
 228   sfree(dd->host.value);
 229   sfree(dd->values);
 230   sfree(dd->ignores);
 231   ignorelist_free(dd->ignorelist);
 232   sfree(dd);
 233 } /* void csnmp_data_definition_destroy */
 234
 235 /* Many functions to handle the configuration. {{{ */
 236 /* First there are many functions which do configuration stuff. It's a big
 237  * bloated and messy, I'm afraid. */
 238
 239 /*
 240  * Callgraph for the config stuff:
 241  *  csnmp_config
 242  *  +-> call_snmp_init_once
 243  *  +-> csnmp_config_add_data
 244  *  !   +-> csnmp_config_configure_data_instance
 245  *  !   +-> csnmp_config_add_data_values
 246  *  +-> csnmp_config_add_host
 247  *      +-> csnmp_config_add_host_version
 248  *      +-> csnmp_config_add_host_collect
 249  *      +-> csnmp_config_add_host_auth_protocol
 250  *      +-> csnmp_config_add_host_priv_protocol
 251  *      +-> csnmp_config_add_host_security_level
 252  */
 253 static void call_snmp_init_once(void) {
 254   static int have_init;
 255
 256   if (have_init == 0)
 257     init_snmp(PACKAGE_NAME);
 258   have_init = 1;
 259 } /* void call_snmp_init_once */
 260
 261 static int csnmp_config_configure_data_instance(instance_t *instance,
 262                                                 oconfig_item_t *ci) {
 263   char buffer[DATA_MAX_NAME_LEN];
 264
 265   int status = cf_util_get_string_buffer(ci, buffer, sizeof(buffer));
 266   if (status != 0)
 267     return status;
 268
 269   instance->configured = true;
 270
 271   if (strlen(buffer) == 0) {
 272     return 0;
 273   }
 274
 275   instance->oid.oid_len = MAX_OID_LEN;
 276
 277   if (!read_objid(buffer, instance->oid.oid, &instance->oid.oid_len)) {
 278     ERROR("snmp plugin: read_objid (%s) failed.", buffer);
 279     return -1;
 280   }
 281
 282   return 0;
 283 } /* int csnmp_config_configure_data_instance */
 284
 285 static int csnmp_config_add_data_values(data_definition_t *dd,
 286                                         oconfig_item_t *ci) {
 287   if (ci->values_num < 1) {
 288     WARNING("snmp plugin: `Values' needs at least one argument.");
 289     return -1;
 290   }
 291
 292   for (int i = 0; i < ci->values_num; i++)
 293     if (ci->values[i].type != OCONFIG_TYPE_STRING) {
 294       WARNING("snmp plugin: `Values' needs only string argument.");
 295       return -1;
 296     }
 297
 298   sfree(dd->values);
 299   dd->values_len = 0;
 300   dd->values = malloc(sizeof(*dd->values) * ci->values_num);
 301   if (dd->values == NULL)
 302     return -1;
 303   dd->values_len = (size_t)ci->values_num;
 304
 305   for (int i = 0; i < ci->values_num; i++) {
 306     dd->values[i].oid_len = MAX_OID_LEN;
 307
 308     if (NULL == snmp_parse_oid(ci->values[i].value.string, dd->values[i].oid,
 309                                &dd->values[i].oid_len)) {
 310       ERROR("snmp plugin: snmp_parse_oid (%s) failed.",
 311             ci->values[i].value.string);
 312       free(dd->values);
 313       dd->values = NULL;
 314       dd->values_len = 0;
 315       return -1;
 316     }
 317   }
 318
 319   return 0;
 320 } /* int csnmp_config_configure_data_instance */
 321
 322 static int csnmp_config_add_data_blacklist(data_definition_t *dd,
 323                                            oconfig_item_t *ci) {
 324   if (ci->values_num < 1)
 325     return 0;
 326
 327   for (int i = 0; i < ci->values_num; i++) {
 328     if (ci->values[i].type != OCONFIG_TYPE_STRING) {
 329       WARNING("snmp plugin: `Ignore' needs only string argument.");
 330       return -1;
 331     }
 332   }
 333
 334   for (int i = 0; i < ci->values_num; ++i) {
 335     if (strarray_add(&(dd->ignores), &(dd->ignores_len),
 336                      ci->values[i].value.string) != 0) {
 337       ERROR("snmp plugin: Can't allocate memory");
 338       strarray_free(dd->ignores, dd->ignores_len);
 339       return ENOMEM;
 340     }
 341   }
 342   return 0;
 343 } /* int csnmp_config_add_data_blacklist */
 344
 345 static int csnmp_config_add_data_filter_values(data_definition_t *data,
 346                                                oconfig_item_t *ci) {
 347   if (ci->values_num < 1) {
 348     WARNING("snmp plugin: `FilterValues' needs at least one argument.");
 349     return -1;
 350   }
 351
 352   for (int i = 0; i < ci->values_num; i++) {
 353     if (ci->values[i].type != OCONFIG_TYPE_STRING) {
 354       WARNING("snmp plugin: All arguments to `FilterValues' must be strings.");
 355       return -1;
 356     }
 357     ignorelist_add(data->ignorelist, ci->values[i].value.string);
 358   }
 359
 360   return 0;
 361 } /* int csnmp_config_add_data_filter_values */
 362
 363 static int csnmp_config_add_data_filter_oid(data_definition_t *data,
 364                                             oconfig_item_t *ci) {
 365
 366   char buffer[DATA_MAX_NAME_LEN];
 367   int status = cf_util_get_string_buffer(ci, buffer, sizeof(buffer));
 368   if (status != 0)
 369     return status;
 370
 371   data->filter_oid.oid_len = MAX_OID_LEN;
 372
 373   if (!read_objid(buffer, data->filter_oid.oid, &data->filter_oid.oid_len)) {
 374     ERROR("snmp plugin: read_objid (%s) failed.", buffer);
 375     return -1;
 376   }
 377   return 0;
 378 } /* int csnmp_config_add_data_filter_oid */
 379
 380 static int csnmp_config_add_data(oconfig_item_t *ci) {
 381   data_definition_t *dd = calloc(1, sizeof(*dd));
 382   if (dd == NULL)
 383     return -1;
 384
 385   int status = cf_util_get_string(ci, &dd->name);
 386   if (status != 0) {
 387     sfree(dd);
 388     return -1;
 389   }
 390
 391   dd->scale = 1.0;
 392   dd->shift = 0.0;
 393   dd->ignores_len = 0;
 394   dd->ignores = NULL;
 395
 396   dd->ignorelist = ignorelist_create(/* invert = */ 1);
 397   if (dd->ignorelist == NULL) {
 398     sfree(dd->name);
 399     sfree(dd);
 400     ERROR("snmp plugin: ignorelist_create() failed.");
 401     return ENOMEM;
 402   }
 403
 404   dd->plugin_name = strdup("snmp");
 405   if (dd->plugin_name == NULL) {
 406     ERROR("snmp plugin: Can't allocate memory");
 407     return ENOMEM;
 408   }
 409
 410   for (int i = 0; i < ci->children_num; i++) {
 411     oconfig_item_t *option = ci->children + i;
 412
 413     if (strcasecmp("Type", option->key) == 0)
 414       status = cf_util_get_string(option, &dd->type);
 415     else if (strcasecmp("Table", option->key) == 0)
 416       status = cf_util_get_boolean(option, &dd->is_table);
 417     else if (strcasecmp("Plugin", option->key) == 0)
 418       status = cf_util_get_string(option, &dd->plugin_name);
 419     else if (strcasecmp("Instance", option->key) == 0) {
 420       if (dd->is_table) {
 421         /* Instance is OID */
 422         WARNING(
 423             "snmp plugin: data %s: Option `Instance' is deprecated, please use "
 424             "option `TypeInstanceOID'.",
 425             dd->name);
 426         status =
 427             csnmp_config_configure_data_instance(&dd->type_instance, option);
 428       } else {
 429         /* Instance is a simple string */
 430         WARNING(
 431             "snmp plugin: data %s: Option `Instance' is deprecated, please use "
 432             "option `TypeInstance'.",
 433             dd->name);
 434         status = cf_util_get_string(option, &dd->type_instance.value);
 435       }
 436     } else if (strcasecmp("InstancePrefix", option->key) == 0) {
 437       WARNING("snmp plugin: data %s: Option `InstancePrefix' is deprecated, "
 438               "please use option `TypeInstancePrefix'.",
 439               dd->name);
 440       status = cf_util_get_string(option, &dd->type_instance.prefix);
 441     } else if (strcasecmp("PluginInstance", option->key) == 0)
 442       status = cf_util_get_string(option, &dd->plugin_instance.value);
 443     else if (strcasecmp("TypeInstance", option->key) == 0)
 444       status = cf_util_get_string(option, &dd->type_instance.value);
 445     else if (strcasecmp("PluginInstanceOID", option->key) == 0)
 446       status =
 447           csnmp_config_configure_data_instance(&dd->plugin_instance, option);
 448     else if (strcasecmp("PluginInstancePrefix", option->key) == 0)
 449       status = cf_util_get_string(option, &dd->plugin_instance.prefix);
 450     else if (strcasecmp("TypeInstanceOID", option->key) == 0)
 451       status = csnmp_config_configure_data_instance(&dd->type_instance, option);
 452     else if (strcasecmp("TypeInstancePrefix", option->key) == 0)
 453       status = cf_util_get_string(option, &dd->type_instance.prefix);
 454     else if (strcasecmp("HostOID", option->key) == 0)
 455       status = csnmp_config_configure_data_instance(&dd->host, option);
 456     else if (strcasecmp("HostPrefix", option->key) == 0)
 457       status = cf_util_get_string(option, &dd->host.prefix);
 458     else if (strcasecmp("Values", option->key) == 0)
 459       status = csnmp_config_add_data_values(dd, option);
 460     else if (strcasecmp("Shift", option->key) == 0)
 461       status = cf_util_get_double(option, &dd->shift);
 462     else if (strcasecmp("Scale", option->key) == 0)
 463       status = cf_util_get_double(option, &dd->scale);
 464     else if (strcasecmp("Ignore", option->key) == 0)
 465       status = csnmp_config_add_data_blacklist(dd, option);
 466     else if (strcasecmp("InvertMatch", option->key) == 0)
 467       status = cf_util_get_boolean(option, &dd->invert_match);
 468     else if (strcasecmp("FilterOID", option->key) == 0) {
 469       status = csnmp_config_add_data_filter_oid(dd, option);
 470     } else if (strcasecmp("FilterValues", option->key) == 0) {
 471       status = csnmp_config_add_data_filter_values(dd, option);
 472     } else if (strcasecmp("FilterIgnoreSelected", option->key) == 0) {
 473       bool t;
 474       status = cf_util_get_boolean(option, &t);
 475       if (status == 0)
 476         ignorelist_set_invert(dd->ignorelist, /* invert = */ !t);
 477     } else {
 478       WARNING("snmp plugin: data %s: Option `%s' not allowed here.", dd->name,
 479               option->key);
 480       status = -1;
 481     }
 482
 483     if (status != 0)
 484       break;
 485   } /* for (ci->children) */
 486
 487   while (status == 0) {
 488     if (dd->is_table) {
 489       /* Set type_instance to SUBID by default */
 490       if (!dd->plugin_instance.configured && !dd->host.configured)
 491         dd->type_instance.configured = true;
 492
 493       if (dd->plugin_instance.value && dd->plugin_instance.configured) {
 494         WARNING(
 495             "snmp plugin: data %s: Option `PluginInstance' will be ignored.",
 496             dd->name);
 497       }
 498       if (dd->type_instance.value && dd->type_instance.configured) {
 499         WARNING("snmp plugin: data %s: Option `TypeInstance' will be ignored.",
 500                 dd->name);
 501       }
 502       if (dd->type_instance.prefix && !dd->type_instance.configured) {
 503         WARNING("snmp plugin: data %s: Option `TypeInstancePrefix' will be "
 504                 "ignored.",
 505                 dd->name);
 506       }
 507       if (dd->plugin_instance.prefix && !dd->plugin_instance.configured) {
 508         WARNING("snmp plugin: data %s: Option `PluginInstancePrefix' will be "
 509                 "ignored.",
 510                 dd->name);
 511       }
 512       if (dd->host.prefix && !dd->host.configured) {
 513         WARNING("snmp plugin: data %s: Option `HostPrefix' will be ignored.",
 514                 dd->name);
 515       }
 516     } else {
 517       if (dd->plugin_instance.oid.oid_len > 0) {
 518         WARNING("snmp plugin: data %s: Option `PluginInstanceOID' will be "
 519                 "ignored.",
 520                 dd->name);
 521       }
 522       if (dd->type_instance.oid.oid_len > 0) {
 523         WARNING(
 524             "snmp plugin: data %s: Option `TypeInstanceOID' will be ignored.",
 525             dd->name);
 526       }
 527       if (dd->type_instance.prefix) {
 528         WARNING("snmp plugin: data %s: Option `TypeInstancePrefix' is ignored "
 529                 "when `Table' "
 530                 "set to `false'.",
 531                 dd->name);
 532       }
 533       if (dd->plugin_instance.prefix) {
 534         WARNING("snmp plugin: data %s: Option `PluginInstancePrefix' is "
 535                 "ignored when "
 536                 "`Table' set to `false'.",
 537                 dd->name);
 538       }
 539       if (dd->host.prefix) {
 540         WARNING(
 541             "snmp plugin: data %s: Option `HostPrefix' is ignored when `Table' "
 542             "set to `false'.",
 543             dd->name);
 544       }
 545     }
 546
 547     if (dd->type == NULL) {
 548       WARNING("snmp plugin: `Type' not given for data `%s'", dd->name);
 549       status = -1;
 550       break;
 551     }
 552     if (dd->values == NULL) {
 553       WARNING("snmp plugin: No `Value' given for data `%s'", dd->name);
 554       status = -1;
 555       break;
 556     }
 557
 558     break;
 559   } /* while (status == 0) */
 560
 561   if (status != 0) {
 562     csnmp_data_definition_destroy(dd);
 563     return -1;
 564   }
 565
 566   DEBUG("snmp plugin: dd = { name = %s, type = %s, is_table = %s, values_len = "
 567         "%" PRIsz ",",
 568         dd->name, dd->type, (dd->is_table) ? "true" : "false", dd->values_len);
 569
 570   DEBUG("snmp plugin:        plugin_instance = %s, type_instance = %s,",
 571         dd->plugin_instance.value, dd->type_instance.value);
 572
 573   DEBUG("snmp plugin:        type_instance_by_oid = %s, plugin_instance_by_oid "
 574         "= %s }",
 575         (dd->type_instance.oid.oid_len > 0)
 576             ? "true"
 577             : ((dd->type_instance.configured) ? "SUBID" : "false"),
 578         (dd->plugin_instance.oid.oid_len > 0)
 579             ? "true"
 580             : ((dd->plugin_instance.configured) ? "SUBID" : "false"));
 581
 582   if (data_head == NULL)
 583     data_head = dd;
 584   else {
 585     data_definition_t *last;
 586     last = data_head;
 587     while (last->next != NULL)
 588       last = last->next;
 589     last->next = dd;
 590   }
 591
 592   return 0;
 593 } /* int csnmp_config_add_data */
 594
 595 static int csnmp_config_add_host_version(host_definition_t *hd,
 596                                          oconfig_item_t *ci) {
 597   int version;
 598
 599   if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER)) {
 600     WARNING("snmp plugin: The `Version' config option needs exactly one number "
 601             "argument.");
 602     return -1;
 603   }
 604
 605   version = (int)ci->values[0].value.number;
 606   if ((version < 1) || (version > 3)) {
 607     WARNING("snmp plugin: `Version' must either be `1', `2', or `3'.");
 608     return -1;
 609   }
 610
 611   hd->version = version;
 612
 613   return 0;
 614 } /* int csnmp_config_add_host_version */
 615
 616 static int csnmp_config_add_host_collect(host_definition_t *host,
 617                                          oconfig_item_t *ci) {
 618   data_definition_t *data;
 619   data_definition_t **data_list;
 620   int data_list_len;
 621
 622   if (ci->values_num < 1) {
 623     WARNING("snmp plugin: `Collect' needs at least one argument.");
 624     return -1;
 625   }
 626
 627   for (int i = 0; i < ci->values_num; i++)
 628     if (ci->values[i].type != OCONFIG_TYPE_STRING) {
 629       WARNING("snmp plugin: All arguments to `Collect' must be strings.");
 630       return -1;
 631     }
 632
 633   data_list_len = host->data_list_len + ci->values_num;
 634   data_list =
 635       realloc(host->data_list, sizeof(data_definition_t *) * data_list_len);
 636   if (data_list == NULL)
 637     return -1;
 638   host->data_list = data_list;
 639
 640   for (int i = 0; i < ci->values_num; i++) {
 641     for (data = data_head; data != NULL; data = data->next)
 642       if (strcasecmp(ci->values[i].value.string, data->name) == 0)
 643         break;
 644
 645     if (data == NULL) {
 646       WARNING("snmp plugin: No such data configured: `%s'",
 647               ci->values[i].value.string);
 648       continue;
 649     }
 650
 651     DEBUG("snmp plugin: Collect: host = %s, data[%i] = %s;", host->name,
 652           host->data_list_len, data->name);
 653
 654     host->data_list[host->data_list_len] = data;
 655     host->data_list_len++;
 656   } /* for (values_num) */
 657
 658   return 0;
 659 } /* int csnmp_config_add_host_collect */
 660
 661 static int csnmp_config_add_host_auth_protocol(host_definition_t *hd,
 662                                                oconfig_item_t *ci) {
 663   char buffer[4];
 664   int status;
 665
 666   status = cf_util_get_string_buffer(ci, buffer, sizeof(buffer));
 667   if (status != 0)
 668     return status;
 669
 670   if (strcasecmp("MD5", buffer) == 0) {
 671     hd->auth_protocol = usmHMACMD5AuthProtocol;
 672     hd->auth_protocol_len = sizeof(usmHMACMD5AuthProtocol) / sizeof(oid);
 673   } else if (strcasecmp("SHA", buffer) == 0) {
 674     hd->auth_protocol = usmHMACSHA1AuthProtocol;
 675     hd->auth_protocol_len = sizeof(usmHMACSHA1AuthProtocol) / sizeof(oid);
 676   } else {
 677     WARNING("snmp plugin: The `AuthProtocol' config option must be `MD5' or "
 678             "`SHA'.");
 679     return -1;
 680   }
 681
 682   DEBUG("snmp plugin: host = %s; host->auth_protocol = %s;", hd->name,
 683         hd->auth_protocol == usmHMACMD5AuthProtocol ? "MD5" : "SHA");
 684
 685   return 0;
 686 } /* int csnmp_config_add_host_auth_protocol */
 687
 688 static int csnmp_config_add_host_priv_protocol(host_definition_t *hd,
 689                                                oconfig_item_t *ci) {
 690   char buffer[4];
 691   int status;
 692
 693   status = cf_util_get_string_buffer(ci, buffer, sizeof(buffer));
 694   if (status != 0)
 695     return status;
 696
 697   if (strcasecmp("AES", buffer) == 0) {
 698     hd->priv_protocol = usmAESPrivProtocol;
 699     hd->priv_protocol_len = sizeof(usmAESPrivProtocol) / sizeof(oid);
 700   } else if (strcasecmp("DES", buffer) == 0) {
 701     hd->priv_protocol = usmDESPrivProtocol;
 702     hd->priv_protocol_len = sizeof(usmDESPrivProtocol) / sizeof(oid);
 703   } else {
 704     WARNING("snmp plugin: The `PrivProtocol' config option must be `AES' or "
 705             "`DES'.");
 706     return -1;
 707   }
 708
 709   DEBUG("snmp plugin: host = %s; host->priv_protocol = %s;", hd->name,
 710         hd->priv_protocol == usmAESPrivProtocol ? "AES" : "DES");
 711
 712   return 0;
 713 } /* int csnmp_config_add_host_priv_protocol */
 714
 715 static int csnmp_config_add_host_security_level(host_definition_t *hd,
 716                                                 oconfig_item_t *ci) {
 717   char buffer[16];
 718   int status;
 719
 720   status = cf_util_get_string_buffer(ci, buffer, sizeof(buffer));
 721   if (status != 0)
 722     return status;
 723
 724   if (strcasecmp("noAuthNoPriv", buffer) == 0)
 725     hd->security_level = SNMP_SEC_LEVEL_NOAUTH;
 726   else if (strcasecmp("authNoPriv", buffer) == 0)
 727     hd->security_level = SNMP_SEC_LEVEL_AUTHNOPRIV;
 728   else if (strcasecmp("authPriv", buffer) == 0)
 729     hd->security_level = SNMP_SEC_LEVEL_AUTHPRIV;
 730   else {
 731     WARNING("snmp plugin: The `SecurityLevel' config option must be "
 732             "`noAuthNoPriv', `authNoPriv', or `authPriv'.");
 733     return -1;
 734   }
 735
 736   DEBUG("snmp plugin: host = %s; host->security_level = %d;", hd->name,
 737         hd->security_level);
 738
 739   return 0;
 740 } /* int csnmp_config_add_host_security_level */
 741
 742 static int csnmp_config_add_host(oconfig_item_t *ci) {
 743   host_definition_t *hd;
 744   int status = 0;
 745
 746   /* Registration stuff. */
 747   cdtime_t interval = 0;
 748   char cb_name[DATA_MAX_NAME_LEN];
 749
 750   hd = calloc(1, sizeof(*hd));
 751   if (hd == NULL)
 752     return -1;
 753   hd->version = 2;
 754   C_COMPLAIN_INIT(&hd->complaint);
 755
 756   status = cf_util_get_string(ci, &hd->name);
 757   if (status != 0) {
 758     sfree(hd);
 759     return status;
 760   }
 761
 762   hd->sess_handle = NULL;
 763
 764   /* These mean that we have not set a timeout or retry value */
 765   hd->timeout = 0;
 766   hd->retries = -1;
 767   hd->build_size = 0;
 768
 769   for (int i = 0; i < ci->children_num; i++) {
 770     oconfig_item_t *option = ci->children + i;
 771
 772     if (strcasecmp("Address", option->key) == 0)
 773       status = cf_util_get_string(option, &hd->address);
 774     else if (strcasecmp("Community", option->key) == 0)
 775       status = cf_util_get_string(option, &hd->community);
 776     else if (strcasecmp("Version", option->key) == 0)
 777       status = csnmp_config_add_host_version(hd, option);
 778     else if (strcasecmp("Timeout", option->key) == 0)
 779       status = cf_util_get_cdtime(option, &hd->timeout);
 780     else if (strcasecmp("Retries", option->key) == 0)
 781       status = cf_util_get_int(option, &hd->retries);
 782     else if (strcasecmp("Collect", option->key) == 0)
 783       status = csnmp_config_add_host_collect(hd, option);
 784     else if (strcasecmp("Interval", option->key) == 0)
 785       status = cf_util_get_cdtime(option, &interval);
 786     else if (strcasecmp("Username", option->key) == 0)
 787       status = cf_util_get_string(option, &hd->username);
 788     else if (strcasecmp("AuthProtocol", option->key) == 0)
 789       status = csnmp_config_add_host_auth_protocol(hd, option);
 790     else if (strcasecmp("PrivacyProtocol", option->key) == 0)
 791       status = csnmp_config_add_host_priv_protocol(hd, option);
 792     else if (strcasecmp("AuthPassphrase", option->key) == 0)
 793       status = cf_util_get_string(option, &hd->auth_passphrase);
 794     else if (strcasecmp("PrivacyPassphrase", option->key) == 0)
 795       status = cf_util_get_string(option, &hd->priv_passphrase);
 796     else if (strcasecmp("SecurityLevel", option->key) == 0)
 797       status = csnmp_config_add_host_security_level(hd, option);
 798     else if (strcasecmp("Context", option->key) == 0)
 799       status = cf_util_get_string(option, &hd->context);
 800     else if (strcasecmp("BulkSize", option->key) == 0)
 801       status = cf_util_get_int(option, &hd->bulk_size);
 802     else {
 803       WARNING(
 804           "snmp plugin: csnmp_config_add_host: Option `%s' not allowed here.",
 805           option->key);
 806       status = -1;
 807     }
 808
 809     if (status != 0)
 810       break;
 811   } /* for (ci->children) */
 812
 813   while (status == 0) {
 814     if (hd->address == NULL) {
 815       WARNING("snmp plugin: `Address' not given for host `%s'", hd->name);
 816       status = -1;
 817       break;
 818     }
 819     if (hd->community == NULL && hd->version < 3) {
 820       WARNING("snmp plugin: `Community' not given for host `%s'", hd->name);
 821       status = -1;
 822       break;
 823     }
 824     if (hd->version == 3) {
 825       if (hd->username == NULL) {
 826         WARNING("snmp plugin: `Username' not given for host `%s'", hd->name);
 827         status = -1;
 828         break;
 829       }
 830       if (hd->security_level == 0) {
 831         WARNING("snmp plugin: `SecurityLevel' not given for host `%s'",
 832                 hd->name);
 833         status = -1;
 834         break;
 835       }
 836       if (hd->security_level == SNMP_SEC_LEVEL_AUTHNOPRIV ||
 837           hd->security_level == SNMP_SEC_LEVEL_AUTHPRIV) {
 838         if (hd->auth_protocol == NULL) {
 839           WARNING("snmp plugin: `AuthProtocol' not given for host `%s'",
 840                   hd->name);
 841           status = -1;
 842           break;
 843         }
 844         if (hd->auth_passphrase == NULL) {
 845           WARNING("snmp plugin: `AuthPassphrase' not given for host `%s'",
 846                   hd->name);
 847           status = -1;
 848           break;
 849         }
 850       }
 851       if (hd->security_level == SNMP_SEC_LEVEL_AUTHPRIV) {
 852         if (hd->priv_protocol == NULL) {
 853           WARNING("snmp plugin: `PrivacyProtocol' not given for host `%s'",
 854                   hd->name);
 855           status = -1;
 856           break;
 857         }
 858         if (hd->priv_passphrase == NULL) {
 859           WARNING("snmp plugin: `PrivacyPassphrase' not given for host `%s'",
 860                   hd->name);
 861           status = -1;
 862           break;
 863         }
 864       }
 865     }
 866
 867     break;
 868   } /* while (status == 0) */
 869
 870   if (status != 0) {
 871     csnmp_host_definition_destroy(hd);
 872     return -1;
 873   }
 874
 875   DEBUG("snmp plugin: hd = { name = %s, address = %s, community = %s, version "
 876         "= %i }",
 877         hd->name, hd->address, hd->community, hd->version);
 878
 879   ssnprintf(cb_name, sizeof(cb_name), "snmp-%s", hd->name);
 880
 881   status = plugin_register_complex_read(
 882       /* group = */ NULL, cb_name, csnmp_read_host, interval,
 883       &(user_data_t){
 884           .data = hd,
 885           .free_func = csnmp_host_definition_destroy,
 886       });
 887   if (status != 0) {
 888     ERROR("snmp plugin: Registering complex read function failed.");
 889     return -1;
 890   }
 891
 892   return 0;
 893 } /* int csnmp_config_add_host */
 894
 895 static int csnmp_config(oconfig_item_t *ci) {
 896   call_snmp_init_once();
 897
 898   for (int i = 0; i < ci->children_num; i++) {
 899     oconfig_item_t *child = ci->children + i;
 900     if (strcasecmp("Data", child->key) == 0)
 901       csnmp_config_add_data(child);
 902     else if (strcasecmp("Host", child->key) == 0)
 903       csnmp_config_add_host(child);
 904     else {
 905       WARNING("snmp plugin: Ignoring unknown config option `%s'.", child->key);
 906     }
 907   } /* for (ci->children) */
 908
 909   return 0;
 910 } /* int csnmp_config */
 911
 912 /* }}} End of the config stuff. Now the interesting part begins */
 913
 914 static void csnmp_host_open_session(host_definition_t *host) {
 915   struct snmp_session sess;
 916   int error;
 917
 918   if (host->sess_handle != NULL)
 919     csnmp_host_close_session(host);
 920
 921   snmp_sess_init(&sess);
 922   sess.peername = host->address;
 923   switch (host->version) {
 924   case 1:
 925     sess.version = SNMP_VERSION_1;
 926     break;
 927   case 3:
 928     sess.version = SNMP_VERSION_3;
 929     break;
 930   default:
 931     sess.version = SNMP_VERSION_2c;
 932     break;
 933   }
 934
 935   if (host->version == 3) {
 936     sess.securityName = host->username;
 937     sess.securityNameLen = strlen(host->username);
 938     sess.securityLevel = host->security_level;
 939
 940     if (sess.securityLevel == SNMP_SEC_LEVEL_AUTHNOPRIV ||
 941         sess.securityLevel == SNMP_SEC_LEVEL_AUTHPRIV) {
 942       sess.securityAuthProto = host->auth_protocol;
 943       sess.securityAuthProtoLen = host->auth_protocol_len;
 944       sess.securityAuthKeyLen = USM_AUTH_KU_LEN;
 945       error = generate_Ku(sess.securityAuthProto, sess.securityAuthProtoLen,
 946                           (u_char *)host->auth_passphrase,
 947                           strlen(host->auth_passphrase), sess.securityAuthKey,
 948                           &sess.securityAuthKeyLen);
 949       if (error != SNMPERR_SUCCESS) {
 950         ERROR("snmp plugin: host %s: Error generating Ku from auth_passphrase. "
 951               "(Error %d)",
 952               host->name, error);
 953       }
 954     }
 955
 956     if (sess.securityLevel == SNMP_SEC_LEVEL_AUTHPRIV) {
 957       sess.securityPrivProto = host->priv_protocol;
 958       sess.securityPrivProtoLen = host->priv_protocol_len;
 959       sess.securityPrivKeyLen = USM_PRIV_KU_LEN;
 960       error = generate_Ku(sess.securityAuthProto, sess.securityAuthProtoLen,
 961                           (u_char *)host->priv_passphrase,
 962                           strlen(host->priv_passphrase), sess.securityPrivKey,
 963                           &sess.securityPrivKeyLen);
 964       if (error != SNMPERR_SUCCESS) {
 965         ERROR("snmp plugin: host %s: Error generating Ku from priv_passphrase. "
 966               "(Error %d)",
 967               host->name, error);
 968       }
 969     }
 970
 971     if (host->context != NULL) {
 972       sess.contextName = host->context;
 973       sess.contextNameLen = strlen(host->context);
 974     }
 975   } else /* SNMPv1/2 "authenticates" with community string */
 976   {
 977     sess.community = (u_char *)host->community;
 978     sess.community_len = strlen(host->community);
 979   }
 980
 981   /* Set timeout & retries, if they have been changed from the default */
 982   if (host->timeout != 0) {
 983     /* net-snmp expects microseconds */
 984     sess.timeout = CDTIME_T_TO_US(host->timeout);
 985   }
 986   if (host->retries >= 0) {
 987     sess.retries = host->retries;
 988   }
 989
 990   /* snmp_sess_open will copy the `struct snmp_session *'. */
 991   host->sess_handle = snmp_sess_open(&sess);
 992
 993   if (host->sess_handle == NULL) {
 994     char *errstr = NULL;
 995
 996     snmp_error(&sess, NULL, NULL, &errstr);
 997
 998     ERROR("snmp plugin: host %s: snmp_sess_open failed: %s", host->name,
 999           (errstr == NULL) ? "Unknown problem" : errstr);
1000     sfree(errstr);
1001   }
1002 } /* void csnmp_host_open_session */
1003
1004 /* TODO: Check if negative values wrap around. Problem: negative temperatures.
1005  */
1006 static value_t csnmp_value_list_to_value(const struct variable_list *vl,
1007                                          int type, double scale, double shift,
1008                                          const char *host_name,
1009                                          const char *data_name) {
1010   value_t ret;
1011   uint64_t tmp_unsigned = 0;
1012   int64_t tmp_signed = 0;
1013   bool defined = 1;
1014   /* Set to true when the original SNMP type appears to have been signed. */
1015   bool prefer_signed = 0;
1016
1017   if ((vl->type == ASN_INTEGER) || (vl->type == ASN_UINTEGER) ||
1018       (vl->type == ASN_COUNTER)
1019 #ifdef ASN_TIMETICKS
1020       || (vl->type == ASN_TIMETICKS)
1021 #endif
1022       || (vl->type == ASN_GAUGE)) {
1023     tmp_unsigned = (uint32_t)*vl->val.integer;
1024     tmp_signed = (int32_t)*vl->val.integer;
1025
1026     if (vl->type == ASN_INTEGER)
1027       prefer_signed = 1;
1028
1029     DEBUG("snmp plugin: Parsed int32 value is %" PRIu64 ".", tmp_unsigned);
1030   } else if (vl->type == ASN_COUNTER64) {
1031     tmp_unsigned = (uint32_t)vl->val.counter64->high;
1032     tmp_unsigned = tmp_unsigned << 32;
1033     tmp_unsigned += (uint32_t)vl->val.counter64->low;
1034     tmp_signed = (int64_t)tmp_unsigned;
1035     DEBUG("snmp plugin: Parsed int64 value is %" PRIu64 ".", tmp_unsigned);
1036   } else if (vl->type == ASN_OCTET_STR) {
1037     /* We'll handle this later.. */
1038   } else {
1039     char oid_buffer[1024] = {0};
1040
1041     snprint_objid(oid_buffer, sizeof(oid_buffer) - 1, vl->name,
1042                   vl->name_length);
1043
1044 #ifdef ASN_NULL
1045     if (vl->type == ASN_NULL)
1046       INFO("snmp plugin: OID \"%s\" is undefined (type ASN_NULL)", oid_buffer);
1047     else
1048 #endif
1049       WARNING("snmp plugin: I don't know the ASN type #%i "
1050               "(OID: \"%s\", data block \"%s\", host block \"%s\")",
1051               (int)vl->type, oid_buffer,
1052               (data_name != NULL) ? data_name : "UNKNOWN",
1053               (host_name != NULL) ? host_name : "UNKNOWN");
1054
1055     defined = 0;
1056   }
1057
1058   if (vl->type == ASN_OCTET_STR) {
1059     int status = -1;
1060
1061     if (vl->val.string != NULL) {
1062       char string[64];
1063       size_t string_length;
1064
1065       string_length = sizeof(string) - 1;
1066       if (vl->val_len < string_length)
1067         string_length = vl->val_len;
1068
1069       /* The strings we get from the Net-SNMP library may not be null
1070        * terminated. That is why we're using `memcpy' here and not `strcpy'.
1071        * `string_length' is set to `vl->val_len' which holds the length of the
1072        * string.  -octo */
1073       memcpy(string, vl->val.string, string_length);
1074       string[string_length] = 0;
1075
1076       status = parse_value(string, &ret, type);
1077       if (status != 0) {
1078         ERROR("snmp plugin: host %s: csnmp_value_list_to_value: Parsing string "
1079               "as %s failed: %s",
1080               (host_name != NULL) ? host_name : "UNKNOWN",
1081               DS_TYPE_TO_STRING(type), string);
1082       }
1083     }
1084
1085     if (status != 0) {
1086       switch (type) {
1087       case DS_TYPE_COUNTER:
1088       case DS_TYPE_DERIVE:
1089       case DS_TYPE_ABSOLUTE:
1090         memset(&ret, 0, sizeof(ret));
1091         break;
1092
1093       case DS_TYPE_GAUGE:
1094         ret.gauge = NAN;
1095         break;
1096
1097       default:
1098         ERROR("snmp plugin: csnmp_value_list_to_value: Unknown "
1099               "data source type: %i.",
1100               type);
1101         ret.gauge = NAN;
1102       }
1103     }
1104   } /* if (vl->type == ASN_OCTET_STR) */
1105   else if (type == DS_TYPE_COUNTER) {
1106     ret.counter = tmp_unsigned;
1107   } else if (type == DS_TYPE_GAUGE) {
1108     if (!defined)
1109       ret.gauge = NAN;
1110     else if (prefer_signed)
1111       ret.gauge = (scale * tmp_signed) + shift;
1112     else
1113       ret.gauge = (scale * tmp_unsigned) + shift;
1114   } else if (type == DS_TYPE_DERIVE) {
1115     if (prefer_signed)
1116       ret.derive = (derive_t)tmp_signed;
1117     else
1118       ret.derive = (derive_t)tmp_unsigned;
1119   } else if (type == DS_TYPE_ABSOLUTE) {
1120     ret.absolute = (absolute_t)tmp_unsigned;
1121   } else {
1122     ERROR("snmp plugin: csnmp_value_list_to_value: Unknown data source "
1123           "type: %i.",
1124           type);
1125     ret.gauge = NAN;
1126   }
1127
1128   return ret;
1129 } /* value_t csnmp_value_list_to_value */
1130
1131 /* csnmp_strvbcopy_hexstring converts the bit string contained in "vb" to a hex
1132  * representation and writes it to dst. Returns zero on success and ENOMEM if
1133  * dst is not large enough to hold the string. dst is guaranteed to be
1134  * nul-terminated. */
1135 static int csnmp_strvbcopy_hexstring(char *dst, /* {{{ */
1136                                      const struct variable_list *vb,
1137                                      size_t dst_size) {
1138   char *buffer_ptr;
1139   size_t buffer_free;
1140
1141   dst[0] = 0;
1142
1143   buffer_ptr = dst;
1144   buffer_free = dst_size;
1145
1146   for (size_t i = 0; i < vb->val_len; i++) {
1147     int status;
1148
1149     status = ssnprintf(buffer_ptr, buffer_free, (i == 0) ? "%02x" : ":%02x",
1150                        (unsigned int)vb->val.bitstring[i]);
1151     assert(status >= 0);
1152
1153     if (((size_t)status) >= buffer_free) /* truncated */
1154     {
1155       dst[dst_size - 1] = '\0';
1156       return ENOMEM;
1157     } else /* if (status < buffer_free) */
1158     {
1159       buffer_ptr += (size_t)status;
1160       buffer_free -= (size_t)status;
1161     }
1162   }
1163
1164   return 0;
1165 } /* }}} int csnmp_strvbcopy_hexstring */
1166
1167 /* csnmp_strvbcopy copies the octet string or bit string contained in vb to
1168  * dst. If non-printable characters are detected, it will switch to a hex
1169  * representation of the string. Returns zero on success, EINVAL if vb does not
1170  * contain a string and ENOMEM if dst is not large enough to contain the
1171  * string. */
1172 static int csnmp_strvbcopy(char *dst, /* {{{ */
1173                            const struct variable_list *vb, size_t dst_size) {
1174   char *src;
1175   size_t num_chars;
1176
1177   if (vb->type == ASN_OCTET_STR)
1178     src = (char *)vb->val.string;
1179   else if (vb->type == ASN_BIT_STR)
1180     src = (char *)vb->val.bitstring;
1181   else if (vb->type == ASN_IPADDRESS) {
1182     return ssnprintf(dst, dst_size,
1183                      "%" PRIu8 ".%" PRIu8 ".%" PRIu8 ".%" PRIu8 "",
1184                      (uint8_t)vb->val.string[0], (uint8_t)vb->val.string[1],
1185                      (uint8_t)vb->val.string[2], (uint8_t)vb->val.string[3]);
1186   } else {
1187     dst[0] = 0;
1188     return EINVAL;
1189   }
1190
1191   num_chars = dst_size - 1;
1192   if (num_chars > vb->val_len)
1193     num_chars = vb->val_len;
1194
1195   for (size_t i = 0; i < num_chars; i++) {
1196     /* Check for control characters. */
1197     if ((unsigned char)src[i] < 32)
1198       return csnmp_strvbcopy_hexstring(dst, vb, dst_size);
1199     dst[i] = src[i];
1200   }
1201   dst[num_chars] = 0;
1202   dst[dst_size - 1] = '\0';
1203
1204   if (dst_size <= vb->val_len)
1205     return ENOMEM;
1206
1207   return 0;
1208 } /* }}} int csnmp_strvbcopy */
1209
1210 static csnmp_cell_char_t *csnmp_get_char_cell(const struct variable_list *vb,
1211                                               const oid_t *root_oid,
1212                                               const host_definition_t *hd,
1213                                               const data_definition_t *dd) {
1214
1215   if (vb == NULL)
1216     return NULL;
1217
1218   csnmp_cell_char_t *il = calloc(1, sizeof(*il));
1219   if (il == NULL) {
1220     ERROR("snmp plugin: calloc failed.");
1221     return NULL;
1222   }
1223   il->next = NULL;
1224
1225   oid_t vb_name;
1226   csnmp_oid_init(&vb_name, vb->name, vb->name_length);
1227
1228   if (csnmp_oid_suffix(&il->suffix, &vb_name, root_oid) != 0) {
1229     sfree(il);
1230     return NULL;
1231   }
1232
1233   /* Get value */
1234   if ((vb->type == ASN_OCTET_STR) || (vb->type == ASN_BIT_STR) ||
1235       (vb->type == ASN_IPADDRESS)) {
1236
1237     csnmp_strvbcopy(il->value, vb, sizeof(il->value));
1238
1239   } else {
1240     value_t val = csnmp_value_list_to_value(
1241         vb, DS_TYPE_COUNTER,
1242         /* scale = */ 1.0, /* shift = */ 0.0, hd->name, dd->name);
1243     ssnprintf(il->value, sizeof(il->value), "%" PRIu64, (uint64_t)val.counter);
1244   }
1245
1246   return il;
1247 } /* csnmp_cell_char_t csnmp_get_char_cell */
1248
1249 static void csnmp_cells_append(csnmp_cell_char_t **head,
1250                                csnmp_cell_char_t **tail,
1251                                csnmp_cell_char_t *il) {
1252   if (*head == NULL)
1253     *head = il;
1254   else
1255     (*tail)->next = il;
1256   *tail = il;
1257 } /* void csnmp_cells_append */
1258
1259 static bool csnmp_ignore_instance(csnmp_cell_char_t *cell,
1260                                   const data_definition_t *dd) {
1261   bool is_matched = 0;
1262   for (uint32_t i = 0; i < dd->ignores_len; i++) {
1263     int status = fnmatch(dd->ignores[i], cell->value, 0);
1264     if (status == 0) {
1265       if (!dd->invert_match) {
1266         return 1;
1267       } else {
1268         is_matched = 1;
1269         break;
1270       }
1271     }
1272   }
1273   if (dd->invert_match && !is_matched) {
1274     return 1;
1275   }
1276   return 0;
1277 } /* bool csnmp_ignore_instance */
1278
1279 static void csnmp_cell_replace_reserved_chars(csnmp_cell_char_t *cell) {
1280   for (char *ptr = cell->value; *ptr != '\0'; ptr++) {
1281     if ((*ptr > 0) && (*ptr < 32))
1282       *ptr = ' ';
1283     else if (*ptr == '/')
1284       *ptr = '_';
1285   }
1286 } /* void csnmp_cell_replace_reserved_chars */
1287
1288 static int csnmp_dispatch_table(host_definition_t *host,
1289                                 data_definition_t *data,
1290                                 csnmp_cell_char_t *type_instance_cells,
1291                                 csnmp_cell_char_t *plugin_instance_cells,
1292                                 csnmp_cell_char_t *hostname_cells,
1293                                 csnmp_cell_char_t *filter_cells,
1294                                 csnmp_cell_value_t **value_cells) {
1295   const data_set_t *ds;
1296   value_list_t vl = VALUE_LIST_INIT;
1297
1298   csnmp_cell_char_t *type_instance_cell_ptr = type_instance_cells;
1299   csnmp_cell_char_t *plugin_instance_cell_ptr = plugin_instance_cells;
1300   csnmp_cell_char_t *hostname_cell_ptr = hostname_cells;
1301   csnmp_cell_char_t *filter_cell_ptr = filter_cells;
1302   csnmp_cell_value_t *value_cell_ptr[data->values_len];
1303
1304   size_t i;
1305   bool have_more;
1306   oid_t current_suffix;
1307
1308   ds = plugin_get_ds(data->type);
1309   if (!ds) {
1310     ERROR("snmp plugin: DataSet `%s' not defined.", data->type);
1311     return -1;
1312   }
1313   assert(ds->ds_num == data->values_len);
1314   assert(data->values_len > 0);
1315
1316   for (i = 0; i < data->values_len; i++)
1317     value_cell_ptr[i] = value_cells[i];
1318
1319   sstrncpy(vl.plugin, data->plugin_name, sizeof(vl.plugin));
1320   sstrncpy(vl.type, data->type, sizeof(vl.type));
1321
1322   have_more = 1;
1323   while (have_more) {
1324     bool suffix_skipped = 0;
1325
1326     /* Determine next suffix to handle. */
1327     if (type_instance_cells != NULL) {
1328       if (type_instance_cell_ptr == NULL) {
1329         have_more = 0;
1330         continue;
1331       }
1332
1333       memcpy(&current_suffix, &type_instance_cell_ptr->suffix,
1334              sizeof(current_suffix));
1335     } else {
1336       /* no instance configured */
1337       csnmp_cell_value_t *ptr = value_cell_ptr[0];
1338       if (ptr == NULL) {
1339         have_more = 0;
1340         continue;
1341       }
1342
1343       memcpy(&current_suffix, &ptr->suffix, sizeof(current_suffix));
1344     }
1345
1346     /*
1347     char oid_buffer[1024] = {0};
1348     snprint_objid(oid_buffer, sizeof(oid_buffer) - 1, current_suffix.oid,
1349                           current_suffix.oid_len);
1350     DEBUG("SNMP PLUGIN: SUFFIX %s", oid_buffer);
1351     */
1352
1353     /* Update plugin_instance_cell_ptr to point expected suffix */
1354     if (plugin_instance_cells != NULL) {
1355       while ((plugin_instance_cell_ptr != NULL) &&
1356              (csnmp_oid_compare(&plugin_instance_cell_ptr->suffix,
1357                                 &current_suffix) < 0))
1358         plugin_instance_cell_ptr = plugin_instance_cell_ptr->next;
1359
1360       if (plugin_instance_cell_ptr == NULL) {
1361         have_more = 0;
1362         continue;
1363       }
1364
1365       if (csnmp_oid_compare(&plugin_instance_cell_ptr->suffix,
1366                             &current_suffix) > 0) {
1367         /* This suffix is missing in the subtree. Indicate this with the
1368          * "suffix_skipped" flag and try the next instance / suffix. */
1369         suffix_skipped = 1;
1370       }
1371     }
1372
1373     /* Update hostname_cell_ptr to point expected suffix */
1374     if (hostname_cells != NULL) {
1375       while (
1376           (hostname_cell_ptr != NULL) &&
1377           (csnmp_oid_compare(&hostname_cell_ptr->suffix, &current_suffix) < 0))
1378         hostname_cell_ptr = hostname_cell_ptr->next;
1379
1380       if (hostname_cell_ptr == NULL) {
1381         have_more = 0;
1382         continue;
1383       }
1384
1385       if (csnmp_oid_compare(&hostname_cell_ptr->suffix, &current_suffix) > 0) {
1386         /* This suffix is missing in the subtree. Indicate this with the
1387          * "suffix_skipped" flag and try the next instance / suffix. */
1388         suffix_skipped = 1;
1389       }
1390     }
1391
1392     /* Update filter_cell_ptr to point expected suffix */
1393     if (filter_cells != NULL) {
1394       while ((filter_cell_ptr != NULL) &&
1395              (csnmp_oid_compare(&filter_cell_ptr->suffix, &current_suffix) < 0))
1396         filter_cell_ptr = filter_cell_ptr->next;
1397
1398       if (filter_cell_ptr == NULL) {
1399         have_more = 0;
1400         continue;
1401       }
1402
1403       if (csnmp_oid_compare(&filter_cell_ptr->suffix, &current_suffix) > 0) {
1404         /* This suffix is missing in the subtree. Indicate this with the
1405          * "suffix_skipped" flag and try the next instance / suffix. */
1406         suffix_skipped = 1;
1407       }
1408     }
1409
1410     /* Update all the value_cell_ptr to point at the entry with the same
1411      * trailing partial OID */
1412     for (i = 0; i < data->values_len; i++) {
1413       while (
1414           (value_cell_ptr[i] != NULL) &&
1415           (csnmp_oid_compare(&value_cell_ptr[i]->suffix, &current_suffix) < 0))
1416         value_cell_ptr[i] = value_cell_ptr[i]->next;
1417
1418       if (value_cell_ptr[i] == NULL) {
1419         have_more = 0;
1420         break;
1421       } else if (csnmp_oid_compare(&value_cell_ptr[i]->suffix,
1422                                    &current_suffix) > 0) {
1423         /* This suffix is missing in the subtree. Indicate this with the
1424          * "suffix_skipped" flag and try the next instance / suffix. */
1425         suffix_skipped = 1;
1426         break;
1427       }
1428     } /* for (i = 0; i < columns; i++) */
1429
1430     if (!have_more)
1431       break;
1432
1433     /* Matching the values failed. Start from the beginning again. */
1434     if (suffix_skipped) {
1435       if (type_instance_cells != NULL)
1436         type_instance_cell_ptr = type_instance_cell_ptr->next;
1437       else
1438         value_cell_ptr[0] = value_cell_ptr[0]->next;
1439
1440       continue;
1441     }
1442
1443 /* if we reach this line, all value_cell_ptr[i] are non-NULL and are set
1444  * to the same subid. type_instance_cell_ptr is either NULL or points to the
1445  * same subid, too. */
1446 #if COLLECT_DEBUG
1447     for (i = 1; i < data->values_len; i++) {
1448       assert(value_cell_ptr[i] != NULL);
1449       assert(csnmp_oid_compare(&value_cell_ptr[i - 1]->suffix,
1450                                &value_cell_ptr[i]->suffix) == 0);
1451     }
1452     assert((type_instance_cell_ptr == NULL) ||
1453            (csnmp_oid_compare(&type_instance_cell_ptr->suffix,
1454                               &value_cell_ptr[0]->suffix) == 0));
1455     assert((plugin_instance_cell_ptr == NULL) ||
1456            (csnmp_oid_compare(&plugin_instance_cell_ptr->suffix,
1457                               &value_cell_ptr[0]->suffix) == 0));
1458     assert((hostname_cell_ptr == NULL) ||
1459            (csnmp_oid_compare(&hostname_cell_ptr->suffix,
1460                               &value_cell_ptr[0]->suffix) == 0));
1461     assert((filter_cell_ptr == NULL) ||
1462            (csnmp_oid_compare(&filter_cell_ptr->suffix,
1463                               &value_cell_ptr[0]->suffix) == 0));
1464 #endif
1465
1466     /* Check the value in filter column */
1467     if (filter_cell_ptr &&
1468         ignorelist_match(data->ignorelist, filter_cell_ptr->value) != 0) {
1469       if (type_instance_cells != NULL)
1470         type_instance_cell_ptr = type_instance_cell_ptr->next;
1471       else
1472         value_cell_ptr[0] = value_cell_ptr[0]->next;
1473
1474       continue;
1475     }
1476
1477     /* set vl.host */
1478     if (data->host.configured) {
1479       char temp[DATA_MAX_NAME_LEN];
1480       if (hostname_cell_ptr == NULL)
1481         csnmp_oid_to_string(temp, sizeof(temp), &current_suffix);
1482       else
1483         sstrncpy(temp, hostname_cell_ptr->value, sizeof(temp));
1484
1485       if (data->host.prefix == NULL)
1486         sstrncpy(vl.host, temp, sizeof(vl.host));
1487       else
1488         ssnprintf(vl.host, sizeof(vl.host), "%s%s", data->host.prefix, temp);
1489     } else {
1490       sstrncpy(vl.host, host->name, sizeof(vl.host));
1491     }
1492
1493     /* set vl.type_instance */
1494     if (data->type_instance.configured) {
1495       char temp[DATA_MAX_NAME_LEN];
1496       if (type_instance_cell_ptr == NULL)
1497         csnmp_oid_to_string(temp, sizeof(temp), &current_suffix);
1498       else
1499         sstrncpy(temp, type_instance_cell_ptr->value, sizeof(temp));
1500
1501       if (data->type_instance.prefix == NULL)
1502         sstrncpy(vl.type_instance, temp, sizeof(vl.type_instance));
1503       else
1504         ssnprintf(vl.type_instance, sizeof(vl.type_instance), "%s%s",
1505                   data->type_instance.prefix, temp);
1506     } else if (data->type_instance.value) {
1507       sstrncpy(vl.type_instance, data->type_instance.value,
1508                sizeof(vl.type_instance));
1509     }
1510
1511     /* set vl.plugin_instance */
1512     if (data->plugin_instance.configured) {
1513       char temp[DATA_MAX_NAME_LEN];
1514       if (plugin_instance_cell_ptr == NULL)
1515         csnmp_oid_to_string(temp, sizeof(temp), &current_suffix);
1516       else
1517         sstrncpy(temp, plugin_instance_cell_ptr->value, sizeof(temp));
1518
1519       if (data->plugin_instance.prefix == NULL)
1520         sstrncpy(vl.plugin_instance, temp, sizeof(vl.plugin_instance));
1521       else
1522         ssnprintf(vl.plugin_instance, sizeof(vl.plugin_instance), "%s%s",
1523                   data->plugin_instance.prefix, temp);
1524     } else if (data->plugin_instance.value) {
1525       sstrncpy(vl.plugin_instance, data->plugin_instance.value,
1526                sizeof(vl.plugin_instance));
1527     }
1528
1529     vl.values_len = data->values_len;
1530     value_t values[vl.values_len];
1531     vl.values = values;
1532
1533     for (i = 0; i < data->values_len; i++)
1534       vl.values[i] = value_cell_ptr[i]->value;
1535
1536     plugin_dispatch_values(&vl);
1537
1538     /* prevent leakage of pointer to local variable. */
1539     vl.values_len = 0;
1540     vl.values = NULL;
1541
1542     if (type_instance_cells != NULL)
1543       type_instance_cell_ptr = type_instance_cell_ptr->next;
1544     else
1545       value_cell_ptr[0] = value_cell_ptr[0]->next;
1546   } /* while (have_more) */
1547
1548   return 0;
1549 } /* int csnmp_dispatch_table */
1550
1551 static int csnmp_read_table(host_definition_t *host, data_definition_t *data) {
1552   struct snmp_pdu *req;
1553   struct snmp_pdu *res = NULL;
1554   struct variable_list *vb;
1555
1556   const data_set_t *ds;
1557
1558   size_t oid_list_len = data->values_len;
1559
1560   if (data->type_instance.oid.oid_len > 0)
1561     oid_list_len++;
1562
1563   if (data->plugin_instance.oid.oid_len > 0)
1564     oid_list_len++;
1565
1566   if (data->host.oid.oid_len > 0)
1567     oid_list_len++;
1568
1569   if (data->filter_oid.oid_len > 0)
1570     oid_list_len++;
1571
1572   /* Holds the last OID returned by the device. We use this in the GETNEXT
1573    * request to proceed. */
1574   oid_t oid_list[oid_list_len];
1575   /* Set to false when an OID has left its subtree so we don't re-request it
1576    * again. */
1577   csnmp_oid_type_t oid_list_todo[oid_list_len];
1578
1579   int status;
1580   size_t i,j;
1581
1582   /* `value_list_head' and `value_cells_tail' implement a linked list for each
1583    * value. `instance_cells_head' and `instance_cells_tail' implement a linked
1584    * list of instance names. This is used to jump gaps in the table. */
1585   csnmp_cell_char_t *type_instance_cells_head = NULL;
1586   csnmp_cell_char_t *type_instance_cells_tail = NULL;
1587   csnmp_cell_char_t *plugin_instance_cells_head = NULL;
1588   csnmp_cell_char_t *plugin_instance_cells_tail = NULL;
1589   csnmp_cell_char_t *hostname_cells_head = NULL;
1590   csnmp_cell_char_t *hostname_cells_tail = NULL;
1591   csnmp_cell_char_t *filter_cells_head = NULL;
1592   csnmp_cell_char_t *filter_cells_tail = NULL;
1593   csnmp_cell_value_t **value_cells_head;
1594   csnmp_cell_value_t **value_cells_tail;
1595
1596   DEBUG("snmp plugin: csnmp_read_table (host = %s, data = %s (%ld))", host->name,
1597         data->name, data->values_len);
1598
1599   if (host->sess_handle == NULL) {
1600     DEBUG("snmp plugin: csnmp_read_table: host->sess_handle == NULL");
1601     return -1;
1602   }
1603
1604   ds = plugin_get_ds(data->type);
1605   if (!ds) {
1606     ERROR("snmp plugin: DataSet `%s' not defined.", data->type);
1607     return -1;
1608   }
1609
1610   if (ds->ds_num != data->values_len) {
1611     ERROR("snmp plugin: DataSet `%s' requires %" PRIsz
1612           " values, but config talks "
1613           "about %" PRIsz,
1614           data->type, ds->ds_num, data->values_len);
1615     return -1;
1616   }
1617   assert(data->values_len > 0);
1618
1619   for (i = 0; i < data->values_len; i++)
1620     oid_list_todo[i] = OID_TYPE_VARIABLE;
1621
1622   /* We need a copy of all the OIDs, because GETNEXT will destroy them. */
1623   memcpy(oid_list, data->values, data->values_len * sizeof(oid_t));
1624
1625   if (data->type_instance.oid.oid_len > 0) {
1626     memcpy(oid_list + i, &data->type_instance.oid, sizeof(oid_t));
1627     oid_list_todo[i] = OID_TYPE_TYPEINSTANCE;
1628     i++;
1629   }
1630
1631   if (data->plugin_instance.oid.oid_len > 0) {
1632     memcpy(oid_list + i, &data->plugin_instance.oid, sizeof(oid_t));
1633     oid_list_todo[i] = OID_TYPE_PLUGININSTANCE;
1634     i++;
1635   }
1636
1637   if (data->host.oid.oid_len > 0) {
1638     memcpy(oid_list + i, &data->host.oid, sizeof(oid_t));
1639     oid_list_todo[i] = OID_TYPE_HOST;
1640     i++;
1641   }
1642
1643   if (data->filter_oid.oid_len > 0) {
1644     memcpy(oid_list + i, &data->filter_oid, sizeof(oid_t));
1645     oid_list_todo[i] = OID_TYPE_FILTER;
1646     i++;
1647   }
1648
1649   /* We're going to construct n linked lists, one for each "value".
1650    * value_cells_head will contain pointers to the heads of these linked lists,
1651    * value_cells_tail will contain pointers to the tail of the lists. */
1652   value_cells_head = calloc(data->values_len, sizeof(*value_cells_head));
1653   value_cells_tail = calloc(data->values_len, sizeof(*value_cells_tail));
1654   if ((value_cells_head == NULL) || (value_cells_tail == NULL)) {
1655     ERROR("snmp plugin: csnmp_read_table: calloc failed.");
1656     sfree(value_cells_head);
1657     sfree(value_cells_tail);
1658     return -1;
1659   }
1660
1661   status = 0;
1662   while (status == 0) {
1663     /* If SNMP v2 and later and bulk transfert enabled, use GETBULK PDU */
1664     if (host->version > 1 && host->bulk_size > 0) {
1665       req = snmp_pdu_create(SNMP_MSG_GETBULK);
1666       req->non_repeaters = 0;
1667       req->max_repetitions = host->bulk_size;
1668     } else {
1669       req = snmp_pdu_create(SNMP_MSG_GETNEXT);
1670     }
1671     if (req == NULL) {
1672       ERROR("snmp plugin: snmp_pdu_create failed.");
1673       status = -1;
1674       break;
1675     }
1676
1677     size_t oid_list_todo_num = 0;
1678     size_t var_idx[oid_list_len];
1679     memset(var_idx, 0, sizeof(var_idx));
1680
1681     for (i = 0; i < oid_list_len; i++) {
1682       /* Do not rerequest already finished OIDs */
1683       if (!oid_list_todo[i])
1684         continue;
1685       snmp_add_null_var(req, oid_list[i].oid, oid_list[i].oid_len);
1686       var_idx[oid_list_todo_num] = i;
1687       oid_list_todo_num++;
1688     }
1689
1690     if (oid_list_todo_num == 0) {
1691       /* The request is still empty - so we are finished */
1692       DEBUG("snmp plugin: all variables have left their subtree");
1693       snmp_free_pdu(req);
1694       status = 0;
1695       break;
1696     }
1697
1698     if (req->command == SNMP_MSG_GETBULK) {
1699         /* In bulk mode the host will send 'max_repetitions' values per
1700            requested variable, so we need to split it per number of variable
1701            to stay 'in budget' */
1702         req->max_repetitions = floor(host->bulk_size/oid_list_todo_num);
1703     }
1704
1705     res = NULL;
1706     status = snmp_sess_synch_response(host->sess_handle, req, &res);
1707
1708     /* snmp_sess_synch_response always frees our req PDU */
1709     req = NULL;
1710
1711     if ((status != STAT_SUCCESS) || (res == NULL)) {
1712       char *errstr = NULL;
1713
1714       snmp_sess_error(host->sess_handle, NULL, NULL, &errstr);
1715
1716       c_complain(LOG_ERR, &host->complaint,
1717                  "snmp plugin: host %s: snmp_sess_synch_response failed: %s",
1718                  host->name, (errstr == NULL) ? "Unknown problem" : errstr);
1719
1720       if (res != NULL)
1721         snmp_free_pdu(res);
1722       res = NULL;
1723
1724       sfree(errstr);
1725       csnmp_host_close_session(host);
1726
1727       status = -1;
1728       break;
1729     }
1730
1731     status = 0;
1732     assert(res != NULL);
1733     c_release(LOG_INFO, &host->complaint,
1734               "snmp plugin: host %s: snmp_sess_synch_response successful.",
1735               host->name);
1736
1737     vb = res->variables;
1738     if (vb == NULL) {
1739       status = -1;
1740       break;
1741     }
1742
1743     if (res->errstat != SNMP_ERR_NOERROR) {
1744       if (res->errindex != 0) {
1745         /* Find the OID which caused error */
1746         for (i = 1, vb = res->variables; vb != NULL && i != res->errindex;
1747              vb = vb->next_variable, i++)
1748           /* do nothing */;
1749       }
1750
1751       if ((res->errindex == 0) || (vb == NULL)) {
1752         ERROR("snmp plugin: host %s; data %s: response error: %s (%li) ",
1753               host->name, data->name, snmp_errstring(res->errstat),
1754               res->errstat);
1755         status = -1;
1756         break;
1757       }
1758
1759       char oid_buffer[1024] = {0};
1760       snprint_objid(oid_buffer, sizeof(oid_buffer) - 1, vb->name,
1761                     vb->name_length);
1762       NOTICE("snmp plugin: host %s; data %s: OID `%s` failed: %s", host->name,
1763              data->name, oid_buffer, snmp_errstring(res->errstat));
1764
1765       /* Get value index from todo list and skip OID found */
1766       assert(res->errindex <= oid_list_todo_num);
1767       i = var_idx[res->errindex - 1];
1768       assert(i < oid_list_len);
1769       oid_list_todo[i] = 0;
1770
1771       snmp_free_pdu(res);
1772       res = NULL;
1773       continue;
1774     }
1775
1776     for (vb = res->variables, j = 0; (vb != NULL);
1777          vb = vb->next_variable, j++) {
1778       /* If bulk request is active convert value index of the extra value */
1779       if (host->version > 1 && host->bulk_size > 0) {
1780         i = j % oid_list_todo_num;
1781       } else {
1782         i = j;
1783       }
1784       /* Calculate value index from todo list */
1785       while ((i < oid_list_len) && !oid_list_todo[i]) {
1786         i++; j++;
1787       }
1788       if (i >= oid_list_len) {
1789         break;
1790       }
1791
1792       /* An instance is configured and the res variable we process is the
1793        * instance value */
1794       if (oid_list_todo[i] == OID_TYPE_TYPEINSTANCE) {
1795         if ((vb->type == SNMP_ENDOFMIBVIEW) ||
1796             (snmp_oid_ncompare(data->type_instance.oid.oid,
1797                                data->type_instance.oid.oid_len, vb->name,
1798                                vb->name_length,
1799                                data->type_instance.oid.oid_len) != 0)) {
1800           DEBUG("snmp plugin: host = %s; data = %s; TypeInstance left its "
1801                 "subtree.",
1802                 host->name, data->name);
1803           oid_list_todo[i] = 0;
1804           continue;
1805         }
1806
1807         /* Allocate a new `csnmp_cell_char_t', insert the instance name and
1808          * add it to the list */
1809         csnmp_cell_char_t *cell =
1810             csnmp_get_char_cell(vb, &data->type_instance.oid, host, data);
1811         if (cell == NULL) {
1812           ERROR("snmp plugin: host %s: csnmp_get_char_cell() failed.",
1813                 host->name);
1814           status = -1;
1815           break;
1816         }
1817
1818         if (csnmp_ignore_instance(cell, data)) {
1819           sfree(cell);
1820         } else {
1821           csnmp_cell_replace_reserved_chars(cell);
1822
1823           DEBUG("snmp plugin: il->type_instance = `%s';", cell->value);
1824           csnmp_cells_append(&type_instance_cells_head,
1825                              &type_instance_cells_tail, cell);
1826         }
1827       } else if (oid_list_todo[i] == OID_TYPE_PLUGININSTANCE) {
1828         if ((vb->type == SNMP_ENDOFMIBVIEW) ||
1829             (snmp_oid_ncompare(data->plugin_instance.oid.oid,
1830                                data->plugin_instance.oid.oid_len, vb->name,
1831                                vb->name_length,
1832                                data->plugin_instance.oid.oid_len) != 0)) {
1833           DEBUG("snmp plugin: host = %s; data = %s; TypeInstance left its "
1834                 "subtree.",
1835                 host->name, data->name);
1836           oid_list_todo[i] = 0;
1837           continue;
1838         }
1839
1840         /* Allocate a new `csnmp_cell_char_t', insert the instance name and
1841          * add it to the list */
1842         csnmp_cell_char_t *cell =
1843             csnmp_get_char_cell(vb, &data->plugin_instance.oid, host, data);
1844         if (cell == NULL) {
1845           ERROR("snmp plugin: host %s: csnmp_get_char_cell() failed.",
1846                 host->name);
1847           status = -1;
1848           break;
1849         }
1850
1851         csnmp_cell_replace_reserved_chars(cell);
1852
1853         DEBUG("snmp plugin: il->plugin_instance = `%s';", cell->value);
1854         csnmp_cells_append(&plugin_instance_cells_head,
1855                            &plugin_instance_cells_tail, cell);
1856       } else if (oid_list_todo[i] == OID_TYPE_HOST) {
1857         if ((vb->type == SNMP_ENDOFMIBVIEW) ||
1858             (snmp_oid_ncompare(data->host.oid.oid, data->host.oid.oid_len,
1859                                vb->name, vb->name_length,
1860                                data->host.oid.oid_len) != 0)) {
1861           DEBUG("snmp plugin: host = %s; data = %s; Host left its subtree.",
1862                 host->name, data->name);
1863           oid_list_todo[i] = 0;
1864           continue;
1865         }
1866
1867         /* Allocate a new `csnmp_cell_char_t', insert the instance name and
1868          * add it to the list */
1869         csnmp_cell_char_t *cell =
1870             csnmp_get_char_cell(vb, &data->host.oid, host, data);
1871         if (cell == NULL) {
1872           ERROR("snmp plugin: host %s: csnmp_get_char_cell() failed.",
1873                 host->name);
1874           status = -1;
1875           break;
1876         }
1877
1878         csnmp_cell_replace_reserved_chars(cell);
1879
1880         DEBUG("snmp plugin: il->hostname = `%s';", cell->value);
1881         csnmp_cells_append(&hostname_cells_head, &hostname_cells_tail, cell);
1882       } else if (oid_list_todo[i] == OID_TYPE_FILTER) {
1883         if ((vb->type == SNMP_ENDOFMIBVIEW) ||
1884             (snmp_oid_ncompare(data->filter_oid.oid, data->filter_oid.oid_len,
1885                                vb->name, vb->name_length,
1886                                data->filter_oid.oid_len) != 0)) {
1887           DEBUG("snmp plugin: host = %s; data = %s; Host left its subtree.",
1888                 host->name, data->name);
1889           oid_list_todo[i] = 0;
1890           continue;
1891         }
1892
1893         /* Allocate a new `csnmp_cell_char_t', insert the instance name and
1894          * add it to the list */
1895         csnmp_cell_char_t *cell =
1896             csnmp_get_char_cell(vb, &data->filter_oid, host, data);
1897         if (cell == NULL) {
1898           ERROR("snmp plugin: host %s: csnmp_get_char_cell() failed.",
1899                 host->name);
1900           status = -1;
1901           break;
1902         }
1903
1904         csnmp_cell_replace_reserved_chars(cell);
1905
1906         DEBUG("snmp plugin: il->filter = `%s';", cell->value);
1907         csnmp_cells_append(&filter_cells_head, &filter_cells_tail, cell);
1908       } else /* The variable we are processing is a normal value */
1909       {
1910         assert(oid_list_todo[i] == OID_TYPE_VARIABLE);
1911
1912         csnmp_cell_value_t *vt;
1913         oid_t vb_name;
1914         oid_t suffix;
1915         int ret;
1916
1917         csnmp_oid_init(&vb_name, vb->name, vb->name_length);
1918
1919         /* Calculate the current suffix. This is later used to check that the
1920          * suffix is increasing. This also checks if we left the subtree */
1921         ret = csnmp_oid_suffix(&suffix, &vb_name, data->values + i);
1922         if (ret != 0) {
1923           DEBUG("snmp plugin: host = %s; data = %s; i = %" PRIsz "; "
1924                 "Value probably left its subtree.",
1925                 host->name, data->name, i);
1926           oid_list_todo[i] = 0;
1927           continue;
1928         }
1929
1930         /* Make sure the OIDs returned by the agent are increasing. Otherwise
1931          * our table matching algorithm will get confused. */
1932         if ((value_cells_tail[i] != NULL) &&
1933             (csnmp_oid_compare(&suffix, &value_cells_tail[i]->suffix) <= 0)) {
1934           DEBUG("snmp plugin: host = %s; data = %s; i = %" PRIsz "; "
1935                 "Suffix is not increasing.",
1936                 host->name, data->name, i);
1937           oid_list_todo[i] = 0;
1938           continue;
1939         }
1940
1941         vt = calloc(1, sizeof(*vt));
1942         if (vt == NULL) {
1943           ERROR("snmp plugin: calloc failed.");
1944           status = -1;
1945           break;
1946         }
1947
1948         vt->value =
1949             csnmp_value_list_to_value(vb, ds->ds[i].type, data->scale,
1950                                       data->shift, host->name, data->name);
1951         memcpy(&vt->suffix, &suffix, sizeof(vt->suffix));
1952         vt->next = NULL;
1953
1954         if (value_cells_tail[i] == NULL)
1955           value_cells_head[i] = vt;
1956         else
1957           value_cells_tail[i]->next = vt;
1958         value_cells_tail[i] = vt;
1959       }
1960
1961       /* Copy OID to oid_list[i] */
1962       memcpy(oid_list[i].oid, vb->name, sizeof(oid) * vb->name_length);
1963       oid_list[i].oid_len = vb->name_length;
1964
1965     } /* for (vb = res->variables ...) */
1966
1967     if (res != NULL)
1968       snmp_free_pdu(res);
1969     res = NULL;
1970   } /* while (status == 0) */
1971
1972   if (res != NULL)
1973     snmp_free_pdu(res);
1974   res = NULL;
1975
1976   if (status == 0)
1977     csnmp_dispatch_table(host, data, type_instance_cells_head,
1978                          plugin_instance_cells_head, hostname_cells_head,
1979                          filter_cells_head, value_cells_head);
1980
1981   /* Free all allocated variables here */
1982   while (type_instance_cells_head != NULL) {
1983     csnmp_cell_char_t *next = type_instance_cells_head->next;
1984     sfree(type_instance_cells_head);
1985     type_instance_cells_head = next;
1986   }
1987
1988   while (plugin_instance_cells_head != NULL) {
1989     csnmp_cell_char_t *next = plugin_instance_cells_head->next;
1990     sfree(plugin_instance_cells_head);
1991     plugin_instance_cells_head = next;
1992   }
1993
1994   while (hostname_cells_head != NULL) {
1995     csnmp_cell_char_t *next = hostname_cells_head->next;
1996     sfree(hostname_cells_head);
1997     hostname_cells_head = next;
1998   }
1999
2000   while (filter_cells_head != NULL) {
2001     csnmp_cell_char_t *next = filter_cells_head->next;
2002     sfree(filter_cells_head);
2003     filter_cells_head = next;
2004   }
2005
2006   for (i = 0; i < data->values_len; i++) {
2007     while (value_cells_head[i] != NULL) {
2008       csnmp_cell_value_t *next = value_cells_head[i]->next;
2009       sfree(value_cells_head[i]);
2010       value_cells_head[i] = next;
2011     }
2012   }
2013
2014   sfree(value_cells_head);
2015   sfree(value_cells_tail);
2016
2017   return 0;
2018 } /* int csnmp_read_table */
2019
2020 static int csnmp_read_value(host_definition_t *host, data_definition_t *data) {
2021   struct snmp_pdu *req;
2022   struct snmp_pdu *res = NULL;
2023   struct variable_list *vb;
2024
2025   const data_set_t *ds;
2026   value_list_t vl = VALUE_LIST_INIT;
2027
2028   int status;
2029   size_t i;
2030
2031   DEBUG("snmp plugin: csnmp_read_value (host = %s, data = %s)", host->name,
2032         data->name);
2033
2034   if (host->sess_handle == NULL) {
2035     DEBUG("snmp plugin: csnmp_read_value: host->sess_handle == NULL");
2036     return -1;
2037   }
2038
2039   ds = plugin_get_ds(data->type);
2040   if (!ds) {
2041     ERROR("snmp plugin: DataSet `%s' not defined.", data->type);
2042     return -1;
2043   }
2044
2045   if (ds->ds_num != data->values_len) {
2046     ERROR("snmp plugin: DataSet `%s' requires %" PRIsz
2047           " values, but config talks "
2048           "about %" PRIsz,
2049           data->type, ds->ds_num, data->values_len);
2050     return -1;
2051   }
2052
2053   vl.values_len = ds->ds_num;
2054   vl.values = malloc(sizeof(*vl.values) * vl.values_len);
2055   if (vl.values == NULL)
2056     return -1;
2057   for (i = 0; i < vl.values_len; i++) {
2058     if (ds->ds[i].type == DS_TYPE_COUNTER)
2059       vl.values[i].counter = 0;
2060     else
2061       vl.values[i].gauge = NAN;
2062   }
2063
2064   sstrncpy(vl.host, host->name, sizeof(vl.host));
2065   sstrncpy(vl.plugin, data->plugin_name, sizeof(vl.plugin));
2066   sstrncpy(vl.type, data->type, sizeof(vl.type));
2067   if (data->type_instance.value)
2068     sstrncpy(vl.type_instance, data->type_instance.value,
2069              sizeof(vl.type_instance));
2070   if (data->plugin_instance.value)
2071     sstrncpy(vl.plugin_instance, data->plugin_instance.value,
2072              sizeof(vl.plugin_instance));
2073
2074   req = snmp_pdu_create(SNMP_MSG_GET);
2075   if (req == NULL) {
2076     ERROR("snmp plugin: snmp_pdu_create failed.");
2077     sfree(vl.values);
2078     return -1;
2079   }
2080
2081   for (i = 0; i < data->values_len; i++)
2082     snmp_add_null_var(req, data->values[i].oid, data->values[i].oid_len);
2083
2084   status = snmp_sess_synch_response(host->sess_handle, req, &res);
2085
2086   if ((status != STAT_SUCCESS) || (res == NULL)) {
2087     char *errstr = NULL;
2088
2089     snmp_sess_error(host->sess_handle, NULL, NULL, &errstr);
2090     ERROR("snmp plugin: host %s: snmp_sess_synch_response failed: %s",
2091           host->name, (errstr == NULL) ? "Unknown problem" : errstr);
2092
2093     if (res != NULL)
2094       snmp_free_pdu(res);
2095
2096     sfree(errstr);
2097     sfree(vl.values);
2098     csnmp_host_close_session(host);
2099
2100     return -1;
2101   }
2102
2103   for (vb = res->variables; vb != NULL; vb = vb->next_variable) {
2104 #if COLLECT_DEBUG
2105     char buffer[1024];
2106     snprint_variable(buffer, sizeof(buffer), vb->name, vb->name_length, vb);
2107     DEBUG("snmp plugin: Got this variable: %s", buffer);
2108 #endif /* COLLECT_DEBUG */
2109
2110     for (i = 0; i < data->values_len; i++)
2111       if (snmp_oid_compare(data->values[i].oid, data->values[i].oid_len,
2112                            vb->name, vb->name_length) == 0)
2113         vl.values[i] =
2114             csnmp_value_list_to_value(vb, ds->ds[i].type, data->scale,
2115                                       data->shift, host->name, data->name);
2116   } /* for (res->variables) */
2117
2118   snmp_free_pdu(res);
2119
2120   DEBUG("snmp plugin: -> plugin_dispatch_values (&vl);");
2121   plugin_dispatch_values(&vl);
2122   sfree(vl.values);
2123
2124   return 0;
2125 } /* int csnmp_read_value */
2126
2127 static int csnmp_read_host(user_data_t *ud) {
2128   host_definition_t *host;
2129   int status;
2130   int success;
2131   int i;
2132
2133   host = ud->data;
2134
2135   if (host->sess_handle == NULL)
2136     csnmp_host_open_session(host);
2137
2138   if (host->sess_handle == NULL)
2139     return -1;
2140
2141   success = 0;
2142   for (i = 0; i < host->data_list_len; i++) {
2143     data_definition_t *data = host->data_list[i];
2144
2145     if (data->is_table)
2146       status = csnmp_read_table(host, data);
2147     else
2148       status = csnmp_read_value(host, data);
2149
2150     if (status == 0)
2151       success++;
2152   }
2153
2154   if (success == 0)
2155     return -1;
2156
2157   return 0;
2158 } /* int csnmp_read_host */
2159
2160 static int csnmp_init(void) {
2161   call_snmp_init_once();
2162
2163   return 0;
2164 } /* int csnmp_init */
2165
2166 static int csnmp_shutdown(void) {
2167   data_definition_t *data_this;
2168   data_definition_t *data_next;
2169
2170   /* When we get here, the read threads have been stopped and all the
2171    * `host_definition_t' will be freed. */
2172   DEBUG("snmp plugin: Destroying all data definitions.");
2173
2174   data_this = data_head;
2175   data_head = NULL;
2176   while (data_this != NULL) {
2177     data_next = data_this->next;
2178
2179     csnmp_data_definition_destroy(data_this);
2180
2181     data_this = data_next;
2182   }
2183
2184   return 0;
2185 } /* int csnmp_shutdown */
2186
2187 void module_register(void) {
2188   plugin_register_complex_config("snmp", csnmp_config);
2189   plugin_register_init("snmp", csnmp_init);
2190   plugin_register_shutdown("snmp", csnmp_shutdown);
2191 } /* void module_register */