Code

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