Merge pull request #2796 from elfiesmelfie/feat_ipmi_SEL_ignore_list
[collectd.git] / 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 "common.h"
30 #include "plugin.h"
31 #include "utils_complain.h"
32
33 #include <net-snmp/net-snmp-config.h>
34 #include <net-snmp/net-snmp-includes.h>
35
36 #include <fnmatch.h>
37
38 /*
39  * Private data structes
40  */
41 struct oid_s {
42   oid oid[MAX_OID_LEN];
43   size_t oid_len;
44 };
45 typedef struct oid_s oid_t;
46
47 union instance_u {
48   char string[DATA_MAX_NAME_LEN];
49   oid_t oid;
50 };
51 typedef union instance_u instance_t;
52
53 struct data_definition_s {
54   char *name; /* used to reference this from the `Collect' option */
55   char *type; /* used to find the data_set */
56   bool is_table;
57   instance_t instance;
58   char *instance_prefix;
59   oid_t *values;
60   size_t values_len;
61   double scale;
62   double shift;
63   struct data_definition_s *next;
64   char **ignores;
65   size_t ignores_len;
66   bool invert_match;
67 };
68 typedef struct data_definition_s data_definition_t;
69
70 struct host_definition_s {
71   char *name;
72   char *address;
73   int version;
74   cdtime_t timeout;
75   int retries;
76
77   /* snmpv1/2 options */
78   char *community;
79
80   /* snmpv3 security options */
81   char *username;
82   oid *auth_protocol;
83   size_t auth_protocol_len;
84   char *auth_passphrase;
85   oid *priv_protocol;
86   size_t priv_protocol_len;
87   char *priv_passphrase;
88   int security_level;
89   char *context;
90
91   void *sess_handle;
92   c_complain_t complaint;
93   cdtime_t interval;
94   data_definition_t **data_list;
95   int data_list_len;
96 };
97 typedef struct host_definition_s host_definition_t;
98
99 /* These two types are used to cache values in `csnmp_read_table' to handle
100  * gaps in tables. */
101 struct csnmp_list_instances_s {
102   oid_t suffix;
103   char instance[DATA_MAX_NAME_LEN];
104   struct csnmp_list_instances_s *next;
105 };
106 typedef struct csnmp_list_instances_s csnmp_list_instances_t;
107
108 struct csnmp_table_values_s {
109   oid_t suffix;
110   value_t value;
111   struct csnmp_table_values_s *next;
112 };
113 typedef struct csnmp_table_values_s csnmp_table_values_t;
114
115 /*
116  * Private variables
117  */
118 static data_definition_t *data_head;
119
120 /*
121  * Prototypes
122  */
123 static int csnmp_read_host(user_data_t *ud);
124
125 /*
126  * Private functions
127  */
128 static void csnmp_oid_init(oid_t *dst, oid const *src, size_t n) {
129   assert(n <= STATIC_ARRAY_SIZE(dst->oid));
130   memcpy(dst->oid, src, sizeof(*src) * n);
131   dst->oid_len = n;
132 }
133
134 static int csnmp_oid_compare(oid_t const *left, oid_t const *right) {
135   return snmp_oid_compare(left->oid, left->oid_len, right->oid, right->oid_len);
136 }
137
138 static int csnmp_oid_suffix(oid_t *dst, oid_t const *src, oid_t const *root) {
139   /* Make sure "src" is in "root"s subtree. */
140   if (src->oid_len <= root->oid_len)
141     return EINVAL;
142   if (snmp_oid_ncompare(root->oid, root->oid_len, src->oid, src->oid_len,
143                         /* n = */ root->oid_len) != 0)
144     return EINVAL;
145
146   memset(dst, 0, sizeof(*dst));
147   dst->oid_len = src->oid_len - root->oid_len;
148   memcpy(dst->oid, &src->oid[root->oid_len],
149          dst->oid_len * sizeof(dst->oid[0]));
150   return 0;
151 }
152
153 static int csnmp_oid_to_string(char *buffer, size_t buffer_size,
154                                oid_t const *o) {
155   char oid_str[MAX_OID_LEN][16];
156   char *oid_str_ptr[MAX_OID_LEN];
157
158   for (size_t i = 0; i < o->oid_len; i++) {
159     snprintf(oid_str[i], sizeof(oid_str[i]), "%lu", (unsigned long)o->oid[i]);
160     oid_str_ptr[i] = oid_str[i];
161   }
162
163   return strjoin(buffer, buffer_size, oid_str_ptr, o->oid_len, ".");
164 }
165
166 static void csnmp_host_close_session(host_definition_t *host) /* {{{ */
167 {
168   if (host->sess_handle == NULL)
169     return;
170
171   snmp_sess_close(host->sess_handle);
172   host->sess_handle = NULL;
173 } /* }}} void csnmp_host_close_session */
174
175 static void csnmp_host_definition_destroy(void *arg) /* {{{ */
176 {
177   host_definition_t *hd;
178
179   hd = arg;
180
181   if (hd == NULL)
182     return;
183
184   if (hd->name != NULL) {
185     DEBUG("snmp plugin: Destroying host definition for host `%s'.", hd->name);
186   }
187
188   csnmp_host_close_session(hd);
189
190   sfree(hd->name);
191   sfree(hd->address);
192   sfree(hd->community);
193   sfree(hd->username);
194   sfree(hd->auth_passphrase);
195   sfree(hd->priv_passphrase);
196   sfree(hd->context);
197   sfree(hd->data_list);
198
199   sfree(hd);
200 } /* }}} void csnmp_host_definition_destroy */
201
202 /* Many functions to handle the configuration. {{{ */
203 /* First there are many functions which do configuration stuff. It's a big
204  * bloated and messy, I'm afraid. */
205
206 /*
207  * Callgraph for the config stuff:
208  *  csnmp_config
209  *  +-> call_snmp_init_once
210  *  +-> csnmp_config_add_data
211  *  !   +-> csnmp_config_add_data_instance
212  *  !   +-> csnmp_config_add_data_instance_prefix
213  *  !   +-> csnmp_config_add_data_values
214  *  +-> csnmp_config_add_host
215  *      +-> csnmp_config_add_host_version
216  *      +-> csnmp_config_add_host_collect
217  *      +-> csnmp_config_add_host_auth_protocol
218  *      +-> csnmp_config_add_host_priv_protocol
219  *      +-> csnmp_config_add_host_security_level
220  */
221 static void call_snmp_init_once(void) {
222   static int have_init;
223
224   if (have_init == 0)
225     init_snmp(PACKAGE_NAME);
226   have_init = 1;
227 } /* void call_snmp_init_once */
228
229 static int csnmp_config_add_data_instance(data_definition_t *dd,
230                                           oconfig_item_t *ci) {
231   char buffer[DATA_MAX_NAME_LEN];
232   int status;
233
234   status = cf_util_get_string_buffer(ci, buffer, sizeof(buffer));
235   if (status != 0)
236     return status;
237
238   if (dd->is_table) {
239     /* Instance is an OID */
240     dd->instance.oid.oid_len = MAX_OID_LEN;
241
242     if (!read_objid(buffer, dd->instance.oid.oid, &dd->instance.oid.oid_len)) {
243       ERROR("snmp plugin: read_objid (%s) failed.", buffer);
244       return -1;
245     }
246   } else {
247     /* Instance is a simple string */
248     sstrncpy(dd->instance.string, buffer, sizeof(dd->instance.string));
249   }
250
251   return 0;
252 } /* int csnmp_config_add_data_instance */
253
254 static int csnmp_config_add_data_instance_prefix(data_definition_t *dd,
255                                                  oconfig_item_t *ci) {
256   int status;
257
258   if (!dd->is_table) {
259     WARNING("snmp plugin: data %s: InstancePrefix is ignored when `Table' "
260             "is set to `false'.",
261             dd->name);
262     return -1;
263   }
264
265   status = cf_util_get_string(ci, &dd->instance_prefix);
266   return status;
267 } /* int csnmp_config_add_data_instance_prefix */
268
269 static int csnmp_config_add_data_values(data_definition_t *dd,
270                                         oconfig_item_t *ci) {
271   if (ci->values_num < 1) {
272     WARNING("snmp plugin: `Values' needs at least one argument.");
273     return -1;
274   }
275
276   for (int i = 0; i < ci->values_num; i++)
277     if (ci->values[i].type != OCONFIG_TYPE_STRING) {
278       WARNING("snmp plugin: `Values' needs only string argument.");
279       return -1;
280     }
281
282   sfree(dd->values);
283   dd->values_len = 0;
284   dd->values = malloc(sizeof(*dd->values) * ci->values_num);
285   if (dd->values == NULL)
286     return -1;
287   dd->values_len = (size_t)ci->values_num;
288
289   for (int i = 0; i < ci->values_num; i++) {
290     dd->values[i].oid_len = MAX_OID_LEN;
291
292     if (NULL == snmp_parse_oid(ci->values[i].value.string, dd->values[i].oid,
293                                &dd->values[i].oid_len)) {
294       ERROR("snmp plugin: snmp_parse_oid (%s) failed.",
295             ci->values[i].value.string);
296       free(dd->values);
297       dd->values = NULL;
298       dd->values_len = 0;
299       return -1;
300     }
301   }
302
303   return 0;
304 } /* int csnmp_config_add_data_instance */
305
306 static int csnmp_config_add_data_blacklist(data_definition_t *dd,
307                                            oconfig_item_t *ci) {
308   if (ci->values_num < 1)
309     return 0;
310
311   for (int i = 0; i < ci->values_num; i++) {
312     if (ci->values[i].type != OCONFIG_TYPE_STRING) {
313       WARNING("snmp plugin: `Ignore' needs only string argument.");
314       return -1;
315     }
316   }
317
318   dd->ignores_len = 0;
319   dd->ignores = NULL;
320
321   for (int i = 0; i < ci->values_num; ++i) {
322     if (strarray_add(&(dd->ignores), &(dd->ignores_len),
323                      ci->values[i].value.string) != 0) {
324       ERROR("snmp plugin: Can't allocate memory");
325       strarray_free(dd->ignores, dd->ignores_len);
326       return ENOMEM;
327     }
328   }
329   return 0;
330 } /* int csnmp_config_add_data_blacklist */
331
332 static int csnmp_config_add_data(oconfig_item_t *ci) {
333   data_definition_t *dd = calloc(1, sizeof(*dd));
334   if (dd == NULL)
335     return -1;
336
337   int status = cf_util_get_string(ci, &dd->name);
338   if (status != 0) {
339     sfree(dd);
340     return -1;
341   }
342
343   dd->scale = 1.0;
344   dd->shift = 0.0;
345
346   for (int i = 0; i < ci->children_num; i++) {
347     oconfig_item_t *option = ci->children + i;
348
349     if (strcasecmp("Type", option->key) == 0)
350       status = cf_util_get_string(option, &dd->type);
351     else if (strcasecmp("Table", option->key) == 0)
352       status = cf_util_get_boolean(option, &dd->is_table);
353     else if (strcasecmp("Instance", option->key) == 0)
354       status = csnmp_config_add_data_instance(dd, option);
355     else if (strcasecmp("InstancePrefix", option->key) == 0)
356       status = csnmp_config_add_data_instance_prefix(dd, option);
357     else if (strcasecmp("Values", option->key) == 0)
358       status = csnmp_config_add_data_values(dd, option);
359     else if (strcasecmp("Shift", option->key) == 0)
360       status = cf_util_get_double(option, &dd->shift);
361     else if (strcasecmp("Scale", option->key) == 0)
362       status = cf_util_get_double(option, &dd->scale);
363     else if (strcasecmp("Ignore", option->key) == 0)
364       status = csnmp_config_add_data_blacklist(dd, option);
365     else if (strcasecmp("InvertMatch", option->key) == 0)
366       status = cf_util_get_boolean(option, &dd->invert_match);
367     else {
368       WARNING("snmp plugin: Option `%s' not allowed here.", option->key);
369       status = -1;
370     }
371
372     if (status != 0)
373       break;
374   } /* for (ci->children) */
375
376   while (status == 0) {
377     if (dd->type == NULL) {
378       WARNING("snmp plugin: `Type' not given for data `%s'", dd->name);
379       status = -1;
380       break;
381     }
382     if (dd->values == NULL) {
383       WARNING("snmp plugin: No `Value' given for data `%s'", dd->name);
384       status = -1;
385       break;
386     }
387
388     break;
389   } /* while (status == 0) */
390
391   if (status != 0) {
392     sfree(dd->name);
393     sfree(dd->instance_prefix);
394     sfree(dd->values);
395     sfree(dd->ignores);
396     sfree(dd);
397     return -1;
398   }
399
400   DEBUG("snmp plugin: dd = { name = %s, type = %s, is_table = %s, values_len = "
401         "%" PRIsz " }",
402         dd->name, dd->type, (dd->is_table) ? "true" : "false", dd->values_len);
403
404   if (data_head == NULL)
405     data_head = dd;
406   else {
407     data_definition_t *last;
408     last = data_head;
409     while (last->next != NULL)
410       last = last->next;
411     last->next = dd;
412   }
413
414   return 0;
415 } /* int csnmp_config_add_data */
416
417 static int csnmp_config_add_host_version(host_definition_t *hd,
418                                          oconfig_item_t *ci) {
419   int version;
420
421   if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER)) {
422     WARNING("snmp plugin: The `Version' config option needs exactly one number "
423             "argument.");
424     return -1;
425   }
426
427   version = (int)ci->values[0].value.number;
428   if ((version < 1) || (version > 3)) {
429     WARNING("snmp plugin: `Version' must either be `1', `2', or `3'.");
430     return -1;
431   }
432
433   hd->version = version;
434
435   return 0;
436 } /* int csnmp_config_add_host_address */
437
438 static int csnmp_config_add_host_collect(host_definition_t *host,
439                                          oconfig_item_t *ci) {
440   data_definition_t *data;
441   data_definition_t **data_list;
442   int data_list_len;
443
444   if (ci->values_num < 1) {
445     WARNING("snmp plugin: `Collect' needs at least one argument.");
446     return -1;
447   }
448
449   for (int i = 0; i < ci->values_num; i++)
450     if (ci->values[i].type != OCONFIG_TYPE_STRING) {
451       WARNING("snmp plugin: All arguments to `Collect' must be strings.");
452       return -1;
453     }
454
455   data_list_len = host->data_list_len + ci->values_num;
456   data_list =
457       realloc(host->data_list, sizeof(data_definition_t *) * data_list_len);
458   if (data_list == NULL)
459     return -1;
460   host->data_list = data_list;
461
462   for (int i = 0; i < ci->values_num; i++) {
463     for (data = data_head; data != NULL; data = data->next)
464       if (strcasecmp(ci->values[i].value.string, data->name) == 0)
465         break;
466
467     if (data == NULL) {
468       WARNING("snmp plugin: No such data configured: `%s'",
469               ci->values[i].value.string);
470       continue;
471     }
472
473     DEBUG("snmp plugin: Collect: host = %s, data[%i] = %s;", host->name,
474           host->data_list_len, data->name);
475
476     host->data_list[host->data_list_len] = data;
477     host->data_list_len++;
478   } /* for (values_num) */
479
480   return 0;
481 } /* int csnmp_config_add_host_collect */
482
483 static int csnmp_config_add_host_auth_protocol(host_definition_t *hd,
484                                                oconfig_item_t *ci) {
485   char buffer[4];
486   int status;
487
488   status = cf_util_get_string_buffer(ci, buffer, sizeof(buffer));
489   if (status != 0)
490     return status;
491
492   if (strcasecmp("MD5", buffer) == 0) {
493     hd->auth_protocol = usmHMACMD5AuthProtocol;
494     hd->auth_protocol_len = sizeof(usmHMACMD5AuthProtocol) / sizeof(oid);
495   } else if (strcasecmp("SHA", buffer) == 0) {
496     hd->auth_protocol = usmHMACSHA1AuthProtocol;
497     hd->auth_protocol_len = sizeof(usmHMACSHA1AuthProtocol) / sizeof(oid);
498   } else {
499     WARNING("snmp plugin: The `AuthProtocol' config option must be `MD5' or "
500             "`SHA'.");
501     return -1;
502   }
503
504   DEBUG("snmp plugin: host = %s; host->auth_protocol = %s;", hd->name,
505         hd->auth_protocol == usmHMACMD5AuthProtocol ? "MD5" : "SHA");
506
507   return 0;
508 } /* int csnmp_config_add_host_auth_protocol */
509
510 static int csnmp_config_add_host_priv_protocol(host_definition_t *hd,
511                                                oconfig_item_t *ci) {
512   char buffer[4];
513   int status;
514
515   status = cf_util_get_string_buffer(ci, buffer, sizeof(buffer));
516   if (status != 0)
517     return status;
518
519   if (strcasecmp("AES", buffer) == 0) {
520     hd->priv_protocol = usmAESPrivProtocol;
521     hd->priv_protocol_len = sizeof(usmAESPrivProtocol) / sizeof(oid);
522   } else if (strcasecmp("DES", buffer) == 0) {
523     hd->priv_protocol = usmDESPrivProtocol;
524     hd->priv_protocol_len = sizeof(usmDESPrivProtocol) / sizeof(oid);
525   } else {
526     WARNING("snmp plugin: The `PrivProtocol' config option must be `AES' or "
527             "`DES'.");
528     return -1;
529   }
530
531   DEBUG("snmp plugin: host = %s; host->priv_protocol = %s;", hd->name,
532         hd->priv_protocol == usmAESPrivProtocol ? "AES" : "DES");
533
534   return 0;
535 } /* int csnmp_config_add_host_priv_protocol */
536
537 static int csnmp_config_add_host_security_level(host_definition_t *hd,
538                                                 oconfig_item_t *ci) {
539   char buffer[16];
540   int status;
541
542   status = cf_util_get_string_buffer(ci, buffer, sizeof(buffer));
543   if (status != 0)
544     return status;
545
546   if (strcasecmp("noAuthNoPriv", buffer) == 0)
547     hd->security_level = SNMP_SEC_LEVEL_NOAUTH;
548   else if (strcasecmp("authNoPriv", buffer) == 0)
549     hd->security_level = SNMP_SEC_LEVEL_AUTHNOPRIV;
550   else if (strcasecmp("authPriv", buffer) == 0)
551     hd->security_level = SNMP_SEC_LEVEL_AUTHPRIV;
552   else {
553     WARNING("snmp plugin: The `SecurityLevel' config option must be "
554             "`noAuthNoPriv', `authNoPriv', or `authPriv'.");
555     return -1;
556   }
557
558   DEBUG("snmp plugin: host = %s; host->security_level = %d;", hd->name,
559         hd->security_level);
560
561   return 0;
562 } /* int csnmp_config_add_host_security_level */
563
564 static int csnmp_config_add_host(oconfig_item_t *ci) {
565   host_definition_t *hd;
566   int status = 0;
567
568   /* Registration stuff. */
569   char cb_name[DATA_MAX_NAME_LEN];
570
571   hd = calloc(1, sizeof(*hd));
572   if (hd == NULL)
573     return -1;
574   hd->version = 2;
575   C_COMPLAIN_INIT(&hd->complaint);
576
577   status = cf_util_get_string(ci, &hd->name);
578   if (status != 0) {
579     sfree(hd);
580     return status;
581   }
582
583   hd->sess_handle = NULL;
584   hd->interval = 0;
585
586   /* These mean that we have not set a timeout or retry value */
587   hd->timeout = 0;
588   hd->retries = -1;
589
590   for (int i = 0; i < ci->children_num; i++) {
591     oconfig_item_t *option = ci->children + i;
592
593     if (strcasecmp("Address", option->key) == 0)
594       status = cf_util_get_string(option, &hd->address);
595     else if (strcasecmp("Community", option->key) == 0)
596       status = cf_util_get_string(option, &hd->community);
597     else if (strcasecmp("Version", option->key) == 0)
598       status = csnmp_config_add_host_version(hd, option);
599     else if (strcasecmp("Timeout", option->key) == 0)
600       status = cf_util_get_cdtime(option, &hd->timeout);
601     else if (strcasecmp("Retries", option->key) == 0)
602       status = cf_util_get_int(option, &hd->retries);
603     else if (strcasecmp("Collect", option->key) == 0)
604       status = csnmp_config_add_host_collect(hd, option);
605     else if (strcasecmp("Interval", option->key) == 0)
606       status = cf_util_get_cdtime(option, &hd->interval);
607     else if (strcasecmp("Username", option->key) == 0)
608       status = cf_util_get_string(option, &hd->username);
609     else if (strcasecmp("AuthProtocol", option->key) == 0)
610       status = csnmp_config_add_host_auth_protocol(hd, option);
611     else if (strcasecmp("PrivacyProtocol", option->key) == 0)
612       status = csnmp_config_add_host_priv_protocol(hd, option);
613     else if (strcasecmp("AuthPassphrase", option->key) == 0)
614       status = cf_util_get_string(option, &hd->auth_passphrase);
615     else if (strcasecmp("PrivacyPassphrase", option->key) == 0)
616       status = cf_util_get_string(option, &hd->priv_passphrase);
617     else if (strcasecmp("SecurityLevel", option->key) == 0)
618       status = csnmp_config_add_host_security_level(hd, option);
619     else if (strcasecmp("Context", option->key) == 0)
620       status = cf_util_get_string(option, &hd->context);
621     else {
622       WARNING(
623           "snmp plugin: csnmp_config_add_host: Option `%s' not allowed here.",
624           option->key);
625       status = -1;
626     }
627
628     if (status != 0)
629       break;
630   } /* for (ci->children) */
631
632   while (status == 0) {
633     if (hd->address == NULL) {
634       WARNING("snmp plugin: `Address' not given for host `%s'", hd->name);
635       status = -1;
636       break;
637     }
638     if (hd->community == NULL && hd->version < 3) {
639       WARNING("snmp plugin: `Community' not given for host `%s'", hd->name);
640       status = -1;
641       break;
642     }
643     if (hd->version == 3) {
644       if (hd->username == NULL) {
645         WARNING("snmp plugin: `Username' not given for host `%s'", hd->name);
646         status = -1;
647         break;
648       }
649       if (hd->security_level == 0) {
650         WARNING("snmp plugin: `SecurityLevel' not given for host `%s'",
651                 hd->name);
652         status = -1;
653         break;
654       }
655       if (hd->security_level == SNMP_SEC_LEVEL_AUTHNOPRIV ||
656           hd->security_level == SNMP_SEC_LEVEL_AUTHPRIV) {
657         if (hd->auth_protocol == NULL) {
658           WARNING("snmp plugin: `AuthProtocol' not given for host `%s'",
659                   hd->name);
660           status = -1;
661           break;
662         }
663         if (hd->auth_passphrase == NULL) {
664           WARNING("snmp plugin: `AuthPassphrase' not given for host `%s'",
665                   hd->name);
666           status = -1;
667           break;
668         }
669       }
670       if (hd->security_level == SNMP_SEC_LEVEL_AUTHPRIV) {
671         if (hd->priv_protocol == NULL) {
672           WARNING("snmp plugin: `PrivacyProtocol' not given for host `%s'",
673                   hd->name);
674           status = -1;
675           break;
676         }
677         if (hd->priv_passphrase == NULL) {
678           WARNING("snmp plugin: `PrivacyPassphrase' not given for host `%s'",
679                   hd->name);
680           status = -1;
681           break;
682         }
683       }
684     }
685
686     break;
687   } /* while (status == 0) */
688
689   if (status != 0) {
690     csnmp_host_definition_destroy(hd);
691     return -1;
692   }
693
694   DEBUG("snmp plugin: hd = { name = %s, address = %s, community = %s, version "
695         "= %i }",
696         hd->name, hd->address, hd->community, hd->version);
697
698   snprintf(cb_name, sizeof(cb_name), "snmp-%s", hd->name);
699
700   status = plugin_register_complex_read(
701       /* group = */ NULL, cb_name, csnmp_read_host, hd->interval,
702       &(user_data_t){
703           .data = hd, .free_func = csnmp_host_definition_destroy,
704       });
705   if (status != 0) {
706     ERROR("snmp plugin: Registering complex read function failed.");
707     return -1;
708   }
709
710   return 0;
711 } /* int csnmp_config_add_host */
712
713 static int csnmp_config(oconfig_item_t *ci) {
714   call_snmp_init_once();
715
716   for (int i = 0; i < ci->children_num; i++) {
717     oconfig_item_t *child = ci->children + i;
718     if (strcasecmp("Data", child->key) == 0)
719       csnmp_config_add_data(child);
720     else if (strcasecmp("Host", child->key) == 0)
721       csnmp_config_add_host(child);
722     else {
723       WARNING("snmp plugin: Ignoring unknown config option `%s'.", child->key);
724     }
725   } /* for (ci->children) */
726
727   return 0;
728 } /* int csnmp_config */
729
730 /* }}} End of the config stuff. Now the interesting part begins */
731
732 static void csnmp_host_open_session(host_definition_t *host) {
733   struct snmp_session sess;
734   int error;
735
736   if (host->sess_handle != NULL)
737     csnmp_host_close_session(host);
738
739   snmp_sess_init(&sess);
740   sess.peername = host->address;
741   switch (host->version) {
742   case 1:
743     sess.version = SNMP_VERSION_1;
744     break;
745   case 3:
746     sess.version = SNMP_VERSION_3;
747     break;
748   default:
749     sess.version = SNMP_VERSION_2c;
750     break;
751   }
752
753   if (host->version == 3) {
754     sess.securityName = host->username;
755     sess.securityNameLen = strlen(host->username);
756     sess.securityLevel = host->security_level;
757
758     if (sess.securityLevel == SNMP_SEC_LEVEL_AUTHNOPRIV ||
759         sess.securityLevel == SNMP_SEC_LEVEL_AUTHPRIV) {
760       sess.securityAuthProto = host->auth_protocol;
761       sess.securityAuthProtoLen = host->auth_protocol_len;
762       sess.securityAuthKeyLen = USM_AUTH_KU_LEN;
763       error = generate_Ku(sess.securityAuthProto, sess.securityAuthProtoLen,
764                           (u_char *)host->auth_passphrase,
765                           strlen(host->auth_passphrase), sess.securityAuthKey,
766                           &sess.securityAuthKeyLen);
767       if (error != SNMPERR_SUCCESS) {
768         ERROR("snmp plugin: host %s: Error generating Ku from auth_passphrase. "
769               "(Error %d)",
770               host->name, error);
771       }
772     }
773
774     if (sess.securityLevel == SNMP_SEC_LEVEL_AUTHPRIV) {
775       sess.securityPrivProto = host->priv_protocol;
776       sess.securityPrivProtoLen = host->priv_protocol_len;
777       sess.securityPrivKeyLen = USM_PRIV_KU_LEN;
778       error = generate_Ku(sess.securityAuthProto, sess.securityAuthProtoLen,
779                           (u_char *)host->priv_passphrase,
780                           strlen(host->priv_passphrase), sess.securityPrivKey,
781                           &sess.securityPrivKeyLen);
782       if (error != SNMPERR_SUCCESS) {
783         ERROR("snmp plugin: host %s: Error generating Ku from priv_passphrase. "
784               "(Error %d)",
785               host->name, error);
786       }
787     }
788
789     if (host->context != NULL) {
790       sess.contextName = host->context;
791       sess.contextNameLen = strlen(host->context);
792     }
793   } else /* SNMPv1/2 "authenticates" with community string */
794   {
795     sess.community = (u_char *)host->community;
796     sess.community_len = strlen(host->community);
797   }
798
799   /* Set timeout & retries, if they have been changed from the default */
800   if (host->timeout != 0) {
801     /* net-snmp expects microseconds */
802     sess.timeout = CDTIME_T_TO_US(host->timeout);
803   }
804   if (host->retries >= 0) {
805     sess.retries = host->retries;
806   }
807
808   /* snmp_sess_open will copy the `struct snmp_session *'. */
809   host->sess_handle = snmp_sess_open(&sess);
810
811   if (host->sess_handle == NULL) {
812     char *errstr = NULL;
813
814     snmp_error(&sess, NULL, NULL, &errstr);
815
816     ERROR("snmp plugin: host %s: snmp_sess_open failed: %s", host->name,
817           (errstr == NULL) ? "Unknown problem" : errstr);
818     sfree(errstr);
819   }
820 } /* void csnmp_host_open_session */
821
822 /* TODO: Check if negative values wrap around. Problem: negative temperatures.
823  */
824 static value_t csnmp_value_list_to_value(struct variable_list *vl, int type,
825                                          double scale, double shift,
826                                          const char *host_name,
827                                          const char *data_name) {
828   value_t ret;
829   uint64_t tmp_unsigned = 0;
830   int64_t tmp_signed = 0;
831   bool defined = 1;
832   /* Set to true when the original SNMP type appears to have been signed. */
833   bool prefer_signed = 0;
834
835   if ((vl->type == ASN_INTEGER) || (vl->type == ASN_UINTEGER) ||
836       (vl->type == ASN_COUNTER)
837 #ifdef ASN_TIMETICKS
838       || (vl->type == ASN_TIMETICKS)
839 #endif
840       || (vl->type == ASN_GAUGE)) {
841     tmp_unsigned = (uint32_t)*vl->val.integer;
842     tmp_signed = (int32_t)*vl->val.integer;
843
844     if (vl->type == ASN_INTEGER)
845       prefer_signed = 1;
846
847     DEBUG("snmp plugin: Parsed int32 value is %" PRIu64 ".", tmp_unsigned);
848   } else if (vl->type == ASN_COUNTER64) {
849     tmp_unsigned = (uint32_t)vl->val.counter64->high;
850     tmp_unsigned = tmp_unsigned << 32;
851     tmp_unsigned += (uint32_t)vl->val.counter64->low;
852     tmp_signed = (int64_t)tmp_unsigned;
853     DEBUG("snmp plugin: Parsed int64 value is %" PRIu64 ".", tmp_unsigned);
854   } else if (vl->type == ASN_OCTET_STR) {
855     /* We'll handle this later.. */
856   } else {
857     char oid_buffer[1024] = {0};
858
859     snprint_objid(oid_buffer, sizeof(oid_buffer) - 1, vl->name,
860                   vl->name_length);
861
862 #ifdef ASN_NULL
863     if (vl->type == ASN_NULL)
864       INFO("snmp plugin: OID \"%s\" is undefined (type ASN_NULL)", oid_buffer);
865     else
866 #endif
867       WARNING("snmp plugin: I don't know the ASN type #%i "
868               "(OID: \"%s\", data block \"%s\", host block \"%s\")",
869               (int)vl->type, oid_buffer,
870               (data_name != NULL) ? data_name : "UNKNOWN",
871               (host_name != NULL) ? host_name : "UNKNOWN");
872
873     defined = 0;
874   }
875
876   if (vl->type == ASN_OCTET_STR) {
877     int status = -1;
878
879     if (vl->val.string != NULL) {
880       char string[64];
881       size_t string_length;
882
883       string_length = sizeof(string) - 1;
884       if (vl->val_len < string_length)
885         string_length = vl->val_len;
886
887       /* The strings we get from the Net-SNMP library may not be null
888        * terminated. That is why we're using `memcpy' here and not `strcpy'.
889        * `string_length' is set to `vl->val_len' which holds the length of the
890        * string.  -octo */
891       memcpy(string, vl->val.string, string_length);
892       string[string_length] = 0;
893
894       status = parse_value(string, &ret, type);
895       if (status != 0) {
896         ERROR("snmp plugin: host %s: csnmp_value_list_to_value: Parsing string "
897               "as %s failed: %s",
898               (host_name != NULL) ? host_name : "UNKNOWN",
899               DS_TYPE_TO_STRING(type), string);
900       }
901     }
902
903     if (status != 0) {
904       switch (type) {
905       case DS_TYPE_COUNTER:
906       case DS_TYPE_DERIVE:
907       case DS_TYPE_ABSOLUTE:
908         memset(&ret, 0, sizeof(ret));
909         break;
910
911       case DS_TYPE_GAUGE:
912         ret.gauge = NAN;
913         break;
914
915       default:
916         ERROR("snmp plugin: csnmp_value_list_to_value: Unknown "
917               "data source type: %i.",
918               type);
919         ret.gauge = NAN;
920       }
921     }
922   } /* if (vl->type == ASN_OCTET_STR) */
923   else if (type == DS_TYPE_COUNTER) {
924     ret.counter = tmp_unsigned;
925   } else if (type == DS_TYPE_GAUGE) {
926     if (!defined)
927       ret.gauge = NAN;
928     else if (prefer_signed)
929       ret.gauge = (scale * tmp_signed) + shift;
930     else
931       ret.gauge = (scale * tmp_unsigned) + shift;
932   } else if (type == DS_TYPE_DERIVE) {
933     if (prefer_signed)
934       ret.derive = (derive_t)tmp_signed;
935     else
936       ret.derive = (derive_t)tmp_unsigned;
937   } else if (type == DS_TYPE_ABSOLUTE) {
938     ret.absolute = (absolute_t)tmp_unsigned;
939   } else {
940     ERROR("snmp plugin: csnmp_value_list_to_value: Unknown data source "
941           "type: %i.",
942           type);
943     ret.gauge = NAN;
944   }
945
946   return ret;
947 } /* value_t csnmp_value_list_to_value */
948
949 /* csnmp_strvbcopy_hexstring converts the bit string contained in "vb" to a hex
950  * representation and writes it to dst. Returns zero on success and ENOMEM if
951  * dst is not large enough to hold the string. dst is guaranteed to be
952  * nul-terminated. */
953 static int csnmp_strvbcopy_hexstring(char *dst, /* {{{ */
954                                      const struct variable_list *vb,
955                                      size_t dst_size) {
956   char *buffer_ptr;
957   size_t buffer_free;
958
959   dst[0] = 0;
960
961   buffer_ptr = dst;
962   buffer_free = dst_size;
963
964   for (size_t i = 0; i < vb->val_len; i++) {
965     int status;
966
967     status = snprintf(buffer_ptr, buffer_free, (i == 0) ? "%02x" : ":%02x",
968                       (unsigned int)vb->val.bitstring[i]);
969     assert(status >= 0);
970
971     if (((size_t)status) >= buffer_free) /* truncated */
972     {
973       dst[dst_size - 1] = 0;
974       return ENOMEM;
975     } else /* if (status < buffer_free) */
976     {
977       buffer_ptr += (size_t)status;
978       buffer_free -= (size_t)status;
979     }
980   }
981
982   return 0;
983 } /* }}} int csnmp_strvbcopy_hexstring */
984
985 /* csnmp_strvbcopy copies the octet string or bit string contained in vb to
986  * dst. If non-printable characters are detected, it will switch to a hex
987  * representation of the string. Returns zero on success, EINVAL if vb does not
988  * contain a string and ENOMEM if dst is not large enough to contain the
989  * string. */
990 static int csnmp_strvbcopy(char *dst, /* {{{ */
991                            const struct variable_list *vb, size_t dst_size) {
992   char *src;
993   size_t num_chars;
994
995   if (vb->type == ASN_OCTET_STR)
996     src = (char *)vb->val.string;
997   else if (vb->type == ASN_BIT_STR)
998     src = (char *)vb->val.bitstring;
999   else if (vb->type == ASN_IPADDRESS) {
1000     return snprintf(dst, dst_size,
1001                     "%" PRIu8 ".%" PRIu8 ".%" PRIu8 ".%" PRIu8 "",
1002                     (uint8_t)vb->val.string[0], (uint8_t)vb->val.string[1],
1003                     (uint8_t)vb->val.string[2], (uint8_t)vb->val.string[3]);
1004   } else {
1005     dst[0] = 0;
1006     return EINVAL;
1007   }
1008
1009   num_chars = dst_size - 1;
1010   if (num_chars > vb->val_len)
1011     num_chars = vb->val_len;
1012
1013   for (size_t i = 0; i < num_chars; i++) {
1014     /* Check for control characters. */
1015     if ((unsigned char)src[i] < 32)
1016       return csnmp_strvbcopy_hexstring(dst, vb, dst_size);
1017     dst[i] = src[i];
1018   }
1019   dst[num_chars] = 0;
1020   dst[dst_size - 1] = 0;
1021
1022   if (dst_size <= vb->val_len)
1023     return ENOMEM;
1024
1025   return 0;
1026 } /* }}} int csnmp_strvbcopy */
1027
1028 static int csnmp_instance_list_add(csnmp_list_instances_t **head,
1029                                    csnmp_list_instances_t **tail,
1030                                    const struct snmp_pdu *res,
1031                                    const host_definition_t *hd,
1032                                    const data_definition_t *dd) {
1033   csnmp_list_instances_t *il;
1034   struct variable_list *vb;
1035   oid_t vb_name;
1036   int status;
1037
1038   /* Set vb on the last variable */
1039   for (vb = res->variables; (vb != NULL) && (vb->next_variable != NULL);
1040        vb = vb->next_variable)
1041     /* do nothing */;
1042   if (vb == NULL)
1043     return -1;
1044
1045   csnmp_oid_init(&vb_name, vb->name, vb->name_length);
1046
1047   il = calloc(1, sizeof(*il));
1048   if (il == NULL) {
1049     ERROR("snmp plugin: calloc failed.");
1050     return -1;
1051   }
1052   il->next = NULL;
1053
1054   status = csnmp_oid_suffix(&il->suffix, &vb_name, &dd->instance.oid);
1055   if (status != 0) {
1056     sfree(il);
1057     return status;
1058   }
1059
1060   /* Get instance name */
1061   if ((vb->type == ASN_OCTET_STR) || (vb->type == ASN_BIT_STR) ||
1062       (vb->type == ASN_IPADDRESS)) {
1063     char *ptr;
1064
1065     csnmp_strvbcopy(il->instance, vb, sizeof(il->instance));
1066     bool is_matched = 0;
1067     for (uint32_t i = 0; i < dd->ignores_len; i++) {
1068       status = fnmatch(dd->ignores[i], il->instance, 0);
1069       if (status == 0) {
1070         if (!dd->invert_match) {
1071           sfree(il);
1072           return 0;
1073         } else {
1074           is_matched = 1;
1075           break;
1076         }
1077       }
1078     }
1079     if (dd->invert_match && !is_matched) {
1080       sfree(il);
1081       return 0;
1082     }
1083     for (ptr = il->instance; *ptr != '\0'; ptr++) {
1084       if ((*ptr > 0) && (*ptr < 32))
1085         *ptr = ' ';
1086       else if (*ptr == '/')
1087         *ptr = '_';
1088     }
1089     DEBUG("snmp plugin: il->instance = `%s';", il->instance);
1090   } else {
1091     value_t val = csnmp_value_list_to_value(
1092         vb, DS_TYPE_COUNTER,
1093         /* scale = */ 1.0, /* shift = */ 0.0, hd->name, dd->name);
1094     snprintf(il->instance, sizeof(il->instance), "%" PRIu64,
1095              (uint64_t)val.counter);
1096   }
1097
1098   /* TODO: Debugging output */
1099
1100   if (*head == NULL)
1101     *head = il;
1102   else
1103     (*tail)->next = il;
1104   *tail = il;
1105
1106   return 0;
1107 } /* int csnmp_instance_list_add */
1108
1109 static int csnmp_dispatch_table(host_definition_t *host,
1110                                 data_definition_t *data,
1111                                 csnmp_list_instances_t *instance_list,
1112                                 csnmp_table_values_t **value_table) {
1113   const data_set_t *ds;
1114   value_list_t vl = VALUE_LIST_INIT;
1115
1116   csnmp_list_instances_t *instance_list_ptr;
1117   csnmp_table_values_t *value_table_ptr[data->values_len];
1118
1119   size_t i;
1120   bool have_more;
1121   oid_t current_suffix;
1122
1123   ds = plugin_get_ds(data->type);
1124   if (!ds) {
1125     ERROR("snmp plugin: DataSet `%s' not defined.", data->type);
1126     return -1;
1127   }
1128   assert(ds->ds_num == data->values_len);
1129   assert(data->values_len > 0);
1130
1131   instance_list_ptr = instance_list;
1132
1133   for (i = 0; i < data->values_len; i++)
1134     value_table_ptr[i] = value_table[i];
1135
1136   sstrncpy(vl.host, host->name, sizeof(vl.host));
1137   sstrncpy(vl.plugin, "snmp", sizeof(vl.plugin));
1138
1139   vl.interval = host->interval;
1140
1141   have_more = 1;
1142   while (have_more) {
1143     bool suffix_skipped = 0;
1144
1145     /* Determine next suffix to handle. */
1146     if (instance_list != NULL) {
1147       if (instance_list_ptr == NULL) {
1148         have_more = 0;
1149         continue;
1150       }
1151
1152       memcpy(&current_suffix, &instance_list_ptr->suffix,
1153              sizeof(current_suffix));
1154     } else {
1155       /* no instance configured */
1156       csnmp_table_values_t *ptr = value_table_ptr[0];
1157       if (ptr == NULL) {
1158         have_more = 0;
1159         continue;
1160       }
1161
1162       memcpy(&current_suffix, &ptr->suffix, sizeof(current_suffix));
1163     }
1164
1165     /* Update all the value_table_ptr to point at the entry with the same
1166      * trailing partial OID */
1167     for (i = 0; i < data->values_len; i++) {
1168       while (
1169           (value_table_ptr[i] != NULL) &&
1170           (csnmp_oid_compare(&value_table_ptr[i]->suffix, &current_suffix) < 0))
1171         value_table_ptr[i] = value_table_ptr[i]->next;
1172
1173       if (value_table_ptr[i] == NULL) {
1174         have_more = 0;
1175         break;
1176       } else if (csnmp_oid_compare(&value_table_ptr[i]->suffix,
1177                                    &current_suffix) > 0) {
1178         /* This suffix is missing in the subtree. Indicate this with the
1179          * "suffix_skipped" flag and try the next instance / suffix. */
1180         suffix_skipped = 1;
1181         break;
1182       }
1183     } /* for (i = 0; i < columns; i++) */
1184
1185     if (!have_more)
1186       break;
1187
1188     /* Matching the values failed. Start from the beginning again. */
1189     if (suffix_skipped) {
1190       if (instance_list != NULL)
1191         instance_list_ptr = instance_list_ptr->next;
1192       else
1193         value_table_ptr[0] = value_table_ptr[0]->next;
1194
1195       continue;
1196     }
1197
1198 /* if we reach this line, all value_table_ptr[i] are non-NULL and are set
1199  * to the same subid. instance_list_ptr is either NULL or points to the
1200  * same subid, too. */
1201 #if COLLECT_DEBUG
1202     for (i = 1; i < data->values_len; i++) {
1203       assert(value_table_ptr[i] != NULL);
1204       assert(csnmp_oid_compare(&value_table_ptr[i - 1]->suffix,
1205                                &value_table_ptr[i]->suffix) == 0);
1206     }
1207     assert((instance_list_ptr == NULL) ||
1208            (csnmp_oid_compare(&instance_list_ptr->suffix,
1209                               &value_table_ptr[0]->suffix) == 0));
1210 #endif
1211
1212     sstrncpy(vl.type, data->type, sizeof(vl.type));
1213
1214     {
1215       char temp[DATA_MAX_NAME_LEN];
1216
1217       if (instance_list_ptr == NULL)
1218         csnmp_oid_to_string(temp, sizeof(temp), &current_suffix);
1219       else
1220         sstrncpy(temp, instance_list_ptr->instance, sizeof(temp));
1221
1222       if (data->instance_prefix == NULL)
1223         sstrncpy(vl.type_instance, temp, sizeof(vl.type_instance));
1224       else
1225         snprintf(vl.type_instance, sizeof(vl.type_instance), "%s%s",
1226                  data->instance_prefix, temp);
1227     }
1228
1229     vl.values_len = data->values_len;
1230     value_t values[vl.values_len];
1231     vl.values = values;
1232
1233     for (i = 0; i < data->values_len; i++)
1234       vl.values[i] = value_table_ptr[i]->value;
1235
1236     /* If we get here `vl.type_instance' and all `vl.values' have been set
1237      * vl.type_instance can be empty, i.e. a blank port description on a
1238      * switch if you're using IF-MIB::ifDescr as Instance.
1239      */
1240     if (vl.type_instance[0] != '\0')
1241       plugin_dispatch_values(&vl);
1242
1243     /* prevent leakage of pointer to local variable. */
1244     vl.values_len = 0;
1245     vl.values = NULL;
1246
1247     if (instance_list != NULL)
1248       instance_list_ptr = instance_list_ptr->next;
1249     else
1250       value_table_ptr[0] = value_table_ptr[0]->next;
1251   } /* while (have_more) */
1252
1253   return (0);
1254 } /* int csnmp_dispatch_table */
1255
1256 static int csnmp_read_table(host_definition_t *host, data_definition_t *data) {
1257   struct snmp_pdu *req;
1258   struct snmp_pdu *res = NULL;
1259   struct variable_list *vb;
1260
1261   const data_set_t *ds;
1262
1263   size_t oid_list_len = data->values_len + 1;
1264   /* Holds the last OID returned by the device. We use this in the GETNEXT
1265    * request to proceed. */
1266   oid_t oid_list[oid_list_len];
1267   /* Set to false when an OID has left its subtree so we don't re-request it
1268    * again. */
1269   bool oid_list_todo[oid_list_len];
1270
1271   int status;
1272   size_t i;
1273
1274   /* `value_list_head' and `value_list_tail' implement a linked list for each
1275    * value. `instance_list_head' and `instance_list_tail' implement a linked
1276    * list of
1277    * instance names. This is used to jump gaps in the table. */
1278   csnmp_list_instances_t *instance_list_head;
1279   csnmp_list_instances_t *instance_list_tail;
1280   csnmp_table_values_t **value_list_head;
1281   csnmp_table_values_t **value_list_tail;
1282
1283   DEBUG("snmp plugin: csnmp_read_table (host = %s, data = %s)", host->name,
1284         data->name);
1285
1286   if (host->sess_handle == NULL) {
1287     DEBUG("snmp plugin: csnmp_read_table: host->sess_handle == NULL");
1288     return -1;
1289   }
1290
1291   ds = plugin_get_ds(data->type);
1292   if (!ds) {
1293     ERROR("snmp plugin: DataSet `%s' not defined.", data->type);
1294     return -1;
1295   }
1296
1297   if (ds->ds_num != data->values_len) {
1298     ERROR("snmp plugin: DataSet `%s' requires %" PRIsz
1299           " values, but config talks "
1300           "about %" PRIsz,
1301           data->type, ds->ds_num, data->values_len);
1302     return -1;
1303   }
1304   assert(data->values_len > 0);
1305
1306   /* We need a copy of all the OIDs, because GETNEXT will destroy them. */
1307   memcpy(oid_list, data->values, data->values_len * sizeof(oid_t));
1308   if (data->instance.oid.oid_len > 0)
1309     memcpy(oid_list + data->values_len, &data->instance.oid, sizeof(oid_t));
1310   else /* no InstanceFrom option specified. */
1311     oid_list_len--;
1312
1313   for (i = 0; i < oid_list_len; i++)
1314     oid_list_todo[i] = 1;
1315
1316   /* We're going to construct n linked lists, one for each "value".
1317    * value_list_head will contain pointers to the heads of these linked lists,
1318    * value_list_tail will contain pointers to the tail of the lists. */
1319   value_list_head = calloc(data->values_len, sizeof(*value_list_head));
1320   value_list_tail = calloc(data->values_len, sizeof(*value_list_tail));
1321   if ((value_list_head == NULL) || (value_list_tail == NULL)) {
1322     ERROR("snmp plugin: csnmp_read_table: calloc failed.");
1323     sfree(value_list_head);
1324     sfree(value_list_tail);
1325     return -1;
1326   }
1327
1328   instance_list_head = NULL;
1329   instance_list_tail = NULL;
1330
1331   status = 0;
1332   while (status == 0) {
1333     req = snmp_pdu_create(SNMP_MSG_GETNEXT);
1334     if (req == NULL) {
1335       ERROR("snmp plugin: snmp_pdu_create failed.");
1336       status = -1;
1337       break;
1338     }
1339
1340     size_t oid_list_todo_num = 0;
1341     size_t var_idx[oid_list_len];
1342     memset(var_idx, 0, sizeof(var_idx));
1343
1344     for (i = 0; i < oid_list_len; i++) {
1345       /* Do not rerequest already finished OIDs */
1346       if (!oid_list_todo[i])
1347         continue;
1348       snmp_add_null_var(req, oid_list[i].oid, oid_list[i].oid_len);
1349       var_idx[oid_list_todo_num] = i;
1350       oid_list_todo_num++;
1351     }
1352
1353     if (oid_list_todo_num == 0) {
1354       /* The request is still empty - so we are finished */
1355       DEBUG("snmp plugin: all variables have left their subtree");
1356       snmp_free_pdu(req);
1357       status = 0;
1358       break;
1359     }
1360
1361     res = NULL;
1362     status = snmp_sess_synch_response(host->sess_handle, req, &res);
1363
1364     /* snmp_sess_synch_response always frees our req PDU */
1365     req = NULL;
1366
1367     if ((status != STAT_SUCCESS) || (res == NULL)) {
1368       char *errstr = NULL;
1369
1370       snmp_sess_error(host->sess_handle, NULL, NULL, &errstr);
1371
1372       c_complain(LOG_ERR, &host->complaint,
1373                  "snmp plugin: host %s: snmp_sess_synch_response failed: %s",
1374                  host->name, (errstr == NULL) ? "Unknown problem" : errstr);
1375
1376       if (res != NULL)
1377         snmp_free_pdu(res);
1378       res = NULL;
1379
1380       sfree(errstr);
1381       csnmp_host_close_session(host);
1382
1383       status = -1;
1384       break;
1385     }
1386
1387     status = 0;
1388     assert(res != NULL);
1389     c_release(LOG_INFO, &host->complaint,
1390               "snmp plugin: host %s: snmp_sess_synch_response successful.",
1391               host->name);
1392
1393     vb = res->variables;
1394     if (vb == NULL) {
1395       status = -1;
1396       break;
1397     }
1398
1399     if (res->errstat != SNMP_ERR_NOERROR) {
1400       if (res->errindex != 0) {
1401         /* Find the OID which caused error */
1402         for (i = 1, vb = res->variables; vb != NULL && i != res->errindex;
1403              vb = vb->next_variable, i++)
1404           /* do nothing */;
1405       }
1406
1407       if ((res->errindex == 0) || (vb == NULL)) {
1408         ERROR("snmp plugin: host %s; data %s: response error: %s (%li) ",
1409               host->name, data->name, snmp_errstring(res->errstat),
1410               res->errstat);
1411         status = -1;
1412         break;
1413       }
1414
1415       char oid_buffer[1024] = {0};
1416       snprint_objid(oid_buffer, sizeof(oid_buffer) - 1, vb->name,
1417                     vb->name_length);
1418       NOTICE("snmp plugin: host %s; data %s: OID `%s` failed: %s", host->name,
1419              data->name, oid_buffer, snmp_errstring(res->errstat));
1420
1421       /* Get value index from todo list and skip OID found */
1422       assert(res->errindex <= oid_list_todo_num);
1423       i = var_idx[res->errindex - 1];
1424       assert(i < oid_list_len);
1425       oid_list_todo[i] = 0;
1426
1427       snmp_free_pdu(res);
1428       res = NULL;
1429       continue;
1430     }
1431
1432     for (vb = res->variables, i = 0; (vb != NULL);
1433          vb = vb->next_variable, i++) {
1434       /* Calculate value index from todo list */
1435       while ((i < oid_list_len) && !oid_list_todo[i]) {
1436         i++;
1437       }
1438       if (i >= oid_list_len) {
1439         break;
1440       }
1441
1442       /* An instance is configured and the res variable we process is the
1443        * instance value (last index) */
1444       if ((data->instance.oid.oid_len > 0) && (i == data->values_len)) {
1445         if ((vb->type == SNMP_ENDOFMIBVIEW) ||
1446             (snmp_oid_ncompare(
1447                  data->instance.oid.oid, data->instance.oid.oid_len, vb->name,
1448                  vb->name_length, data->instance.oid.oid_len) != 0)) {
1449           DEBUG("snmp plugin: host = %s; data = %s; Instance left its subtree.",
1450                 host->name, data->name);
1451           oid_list_todo[i] = 0;
1452           continue;
1453         }
1454
1455         /* Allocate a new `csnmp_list_instances_t', insert the instance name and
1456          * add it to the list */
1457         if (csnmp_instance_list_add(&instance_list_head, &instance_list_tail,
1458                                     res, host, data) != 0) {
1459           ERROR("snmp plugin: host %s: csnmp_instance_list_add failed.",
1460                 host->name);
1461           status = -1;
1462           break;
1463         }
1464       } else /* The variable we are processing is a normal value */
1465       {
1466         csnmp_table_values_t *vt;
1467         oid_t vb_name;
1468         oid_t suffix;
1469         int ret;
1470
1471         csnmp_oid_init(&vb_name, vb->name, vb->name_length);
1472
1473         /* Calculate the current suffix. This is later used to check that the
1474          * suffix is increasing. This also checks if we left the subtree */
1475         ret = csnmp_oid_suffix(&suffix, &vb_name, data->values + i);
1476         if (ret != 0) {
1477           DEBUG("snmp plugin: host = %s; data = %s; i = %" PRIsz "; "
1478                 "Value probably left its subtree.",
1479                 host->name, data->name, i);
1480           oid_list_todo[i] = 0;
1481           continue;
1482         }
1483
1484         /* Make sure the OIDs returned by the agent are increasing. Otherwise
1485          * our
1486          * table matching algorithm will get confused. */
1487         if ((value_list_tail[i] != NULL) &&
1488             (csnmp_oid_compare(&suffix, &value_list_tail[i]->suffix) <= 0)) {
1489           DEBUG("snmp plugin: host = %s; data = %s; i = %" PRIsz "; "
1490                 "Suffix is not increasing.",
1491                 host->name, data->name, i);
1492           oid_list_todo[i] = 0;
1493           continue;
1494         }
1495
1496         vt = calloc(1, sizeof(*vt));
1497         if (vt == NULL) {
1498           ERROR("snmp plugin: calloc failed.");
1499           status = -1;
1500           break;
1501         }
1502
1503         vt->value =
1504             csnmp_value_list_to_value(vb, ds->ds[i].type, data->scale,
1505                                       data->shift, host->name, data->name);
1506         memcpy(&vt->suffix, &suffix, sizeof(vt->suffix));
1507         vt->next = NULL;
1508
1509         if (value_list_tail[i] == NULL)
1510           value_list_head[i] = vt;
1511         else
1512           value_list_tail[i]->next = vt;
1513         value_list_tail[i] = vt;
1514       }
1515
1516       /* Copy OID to oid_list[i] */
1517       memcpy(oid_list[i].oid, vb->name, sizeof(oid) * vb->name_length);
1518       oid_list[i].oid_len = vb->name_length;
1519
1520     } /* for (vb = res->variables ...) */
1521
1522     if (res != NULL)
1523       snmp_free_pdu(res);
1524     res = NULL;
1525   } /* while (status == 0) */
1526
1527   if (res != NULL)
1528     snmp_free_pdu(res);
1529   res = NULL;
1530
1531   if (status == 0)
1532     csnmp_dispatch_table(host, data, instance_list_head, value_list_head);
1533
1534   /* Free all allocated variables here */
1535   while (instance_list_head != NULL) {
1536     csnmp_list_instances_t *next = instance_list_head->next;
1537     sfree(instance_list_head);
1538     instance_list_head = next;
1539   }
1540
1541   for (i = 0; i < data->values_len; i++) {
1542     while (value_list_head[i] != NULL) {
1543       csnmp_table_values_t *next = value_list_head[i]->next;
1544       sfree(value_list_head[i]);
1545       value_list_head[i] = next;
1546     }
1547   }
1548
1549   sfree(value_list_head);
1550   sfree(value_list_tail);
1551
1552   return 0;
1553 } /* int csnmp_read_table */
1554
1555 static int csnmp_read_value(host_definition_t *host, data_definition_t *data) {
1556   struct snmp_pdu *req;
1557   struct snmp_pdu *res = NULL;
1558   struct variable_list *vb;
1559
1560   const data_set_t *ds;
1561   value_list_t vl = VALUE_LIST_INIT;
1562
1563   int status;
1564   size_t i;
1565
1566   DEBUG("snmp plugin: csnmp_read_value (host = %s, data = %s)", host->name,
1567         data->name);
1568
1569   if (host->sess_handle == NULL) {
1570     DEBUG("snmp plugin: csnmp_read_value: host->sess_handle == NULL");
1571     return -1;
1572   }
1573
1574   ds = plugin_get_ds(data->type);
1575   if (!ds) {
1576     ERROR("snmp plugin: DataSet `%s' not defined.", data->type);
1577     return -1;
1578   }
1579
1580   if (ds->ds_num != data->values_len) {
1581     ERROR("snmp plugin: DataSet `%s' requires %" PRIsz
1582           " values, but config talks "
1583           "about %" PRIsz,
1584           data->type, ds->ds_num, data->values_len);
1585     return -1;
1586   }
1587
1588   vl.values_len = ds->ds_num;
1589   vl.values = malloc(sizeof(*vl.values) * vl.values_len);
1590   if (vl.values == NULL)
1591     return -1;
1592   for (i = 0; i < vl.values_len; i++) {
1593     if (ds->ds[i].type == DS_TYPE_COUNTER)
1594       vl.values[i].counter = 0;
1595     else
1596       vl.values[i].gauge = NAN;
1597   }
1598
1599   sstrncpy(vl.host, host->name, sizeof(vl.host));
1600   sstrncpy(vl.plugin, "snmp", sizeof(vl.plugin));
1601   sstrncpy(vl.type, data->type, sizeof(vl.type));
1602   sstrncpy(vl.type_instance, data->instance.string, sizeof(vl.type_instance));
1603
1604   vl.interval = host->interval;
1605
1606   req = snmp_pdu_create(SNMP_MSG_GET);
1607   if (req == NULL) {
1608     ERROR("snmp plugin: snmp_pdu_create failed.");
1609     sfree(vl.values);
1610     return -1;
1611   }
1612
1613   for (i = 0; i < data->values_len; i++)
1614     snmp_add_null_var(req, data->values[i].oid, data->values[i].oid_len);
1615
1616   status = snmp_sess_synch_response(host->sess_handle, req, &res);
1617
1618   if ((status != STAT_SUCCESS) || (res == NULL)) {
1619     char *errstr = NULL;
1620
1621     snmp_sess_error(host->sess_handle, NULL, NULL, &errstr);
1622     ERROR("snmp plugin: host %s: snmp_sess_synch_response failed: %s",
1623           host->name, (errstr == NULL) ? "Unknown problem" : errstr);
1624
1625     if (res != NULL)
1626       snmp_free_pdu(res);
1627
1628     sfree(errstr);
1629     sfree(vl.values);
1630     csnmp_host_close_session(host);
1631
1632     return -1;
1633   }
1634
1635   for (vb = res->variables; vb != NULL; vb = vb->next_variable) {
1636 #if COLLECT_DEBUG
1637     char buffer[1024];
1638     snprint_variable(buffer, sizeof(buffer), vb->name, vb->name_length, vb);
1639     DEBUG("snmp plugin: Got this variable: %s", buffer);
1640 #endif /* COLLECT_DEBUG */
1641
1642     for (i = 0; i < data->values_len; i++)
1643       if (snmp_oid_compare(data->values[i].oid, data->values[i].oid_len,
1644                            vb->name, vb->name_length) == 0)
1645         vl.values[i] =
1646             csnmp_value_list_to_value(vb, ds->ds[i].type, data->scale,
1647                                       data->shift, host->name, data->name);
1648   } /* for (res->variables) */
1649
1650   snmp_free_pdu(res);
1651
1652   DEBUG("snmp plugin: -> plugin_dispatch_values (&vl);");
1653   plugin_dispatch_values(&vl);
1654   sfree(vl.values);
1655
1656   return 0;
1657 } /* int csnmp_read_value */
1658
1659 static int csnmp_read_host(user_data_t *ud) {
1660   host_definition_t *host;
1661   int status;
1662   int success;
1663   int i;
1664
1665   host = ud->data;
1666
1667   if (host->interval == 0)
1668     host->interval = plugin_get_interval();
1669
1670   if (host->sess_handle == NULL)
1671     csnmp_host_open_session(host);
1672
1673   if (host->sess_handle == NULL)
1674     return -1;
1675
1676   success = 0;
1677   for (i = 0; i < host->data_list_len; i++) {
1678     data_definition_t *data = host->data_list[i];
1679
1680     if (data->is_table)
1681       status = csnmp_read_table(host, data);
1682     else
1683       status = csnmp_read_value(host, data);
1684
1685     if (status == 0)
1686       success++;
1687   }
1688
1689   if (success == 0)
1690     return -1;
1691
1692   return 0;
1693 } /* int csnmp_read_host */
1694
1695 static int csnmp_init(void) {
1696   call_snmp_init_once();
1697
1698   return 0;
1699 } /* int csnmp_init */
1700
1701 static int csnmp_shutdown(void) {
1702   data_definition_t *data_this;
1703   data_definition_t *data_next;
1704
1705   /* When we get here, the read threads have been stopped and all the
1706    * `host_definition_t' will be freed. */
1707   DEBUG("snmp plugin: Destroying all data definitions.");
1708
1709   data_this = data_head;
1710   data_head = NULL;
1711   while (data_this != NULL) {
1712     data_next = data_this->next;
1713
1714     sfree(data_this->name);
1715     sfree(data_this->type);
1716     sfree(data_this->values);
1717     sfree(data_this->ignores);
1718     sfree(data_this);
1719
1720     data_this = data_next;
1721   }
1722
1723   return 0;
1724 } /* int csnmp_shutdown */
1725
1726 void module_register(void) {
1727   plugin_register_complex_config("snmp", csnmp_config);
1728   plugin_register_init("snmp", csnmp_init);
1729   plugin_register_shutdown("snmp", csnmp_shutdown);
1730 } /* void module_register */