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 size_t 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
105 {
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
113 {
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)
134 {
135 assert (n <= STATIC_ARRAY_SIZE (dst->oid));
136 memcpy (dst->oid, src, sizeof (*src) * n);
137 dst->oid_len = n;
138 }
140 static int csnmp_oid_compare (oid_t const *left, oid_t const *right)
141 {
142 return (snmp_oid_compare (left->oid, left->oid_len,
143 right->oid, right->oid_len));
144 }
146 static int csnmp_oid_suffix (oid_t *dst, oid_t const *src,
147 oid_t const *root)
148 {
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);
162 }
164 static int csnmp_oid_to_string (char *buffer, size_t buffer_size,
165 oid_t const *o)
166 {
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 = */ "."));
179 }
181 static void csnmp_host_close_session (host_definition_t *host) /* {{{ */
182 {
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) /* {{{ */
191 {
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)
239 {
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)
248 {
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)
280 {
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)
295 {
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 = (size_t) 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)
338 {
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)
369 {
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)
382 {
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 = %zu }",
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)
480 {
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)
504 {
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)
554 {
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)
583 {
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)
613 {
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)
640 {
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;
649 hd = (host_definition_t *) malloc (sizeof (host_definition_t));
650 if (hd == NULL)
651 return (-1);
652 memset (hd, '\0', sizeof (host_definition_t));
653 hd->version = 2;
654 C_COMPLAIN_INIT (&hd->complaint);
656 status = cf_util_get_string(ci, &hd->name);
657 if (status != 0)
658 return status;
660 hd->sess_handle = NULL;
661 hd->interval = 0;
663 for (i = 0; i < ci->children_num; i++)
664 {
665 oconfig_item_t *option = ci->children + i;
666 status = 0;
668 if (strcasecmp ("Address", option->key) == 0)
669 status = cf_util_get_string(option, &hd->address);
670 else if (strcasecmp ("Community", option->key) == 0)
671 status = cf_util_get_string(option, &hd->community);
672 else if (strcasecmp ("Version", option->key) == 0)
673 status = csnmp_config_add_host_version (hd, option);
674 else if (strcasecmp ("Collect", option->key) == 0)
675 csnmp_config_add_host_collect (hd, option);
676 else if (strcasecmp ("Interval", option->key) == 0)
677 cf_util_get_cdtime (option, &hd->interval);
678 else if (strcasecmp ("Username", option->key) == 0)
679 status = cf_util_get_string(option, &hd->username);
680 else if (strcasecmp ("AuthProtocol", option->key) == 0)
681 status = csnmp_config_add_host_auth_protocol (hd, option);
682 else if (strcasecmp ("PrivacyProtocol", option->key) == 0)
683 status = csnmp_config_add_host_priv_protocol (hd, option);
684 else if (strcasecmp ("AuthPassphrase", option->key) == 0)
685 status = cf_util_get_string(option, &hd->auth_passphrase);
686 else if (strcasecmp ("PrivacyPassphrase", option->key) == 0)
687 status = cf_util_get_string(option, &hd->priv_passphrase);
688 else if (strcasecmp ("SecurityLevel", option->key) == 0)
689 status = csnmp_config_add_host_security_level (hd, option);
690 else if (strcasecmp ("Context", option->key) == 0)
691 status = cf_util_get_string(option, &hd->context);
692 else
693 {
694 WARNING ("snmp plugin: csnmp_config_add_host: Option `%s' not allowed here.", option->key);
695 status = -1;
696 }
698 if (status != 0)
699 break;
700 } /* for (ci->children) */
702 while (status == 0)
703 {
704 if (hd->address == NULL)
705 {
706 WARNING ("snmp plugin: `Address' not given for host `%s'", hd->name);
707 status = -1;
708 break;
709 }
710 if (hd->community == NULL && hd->version < 3)
711 {
712 WARNING ("snmp plugin: `Community' not given for host `%s'", hd->name);
713 status = -1;
714 break;
715 }
716 if (hd->version == 3)
717 {
718 if (hd->username == NULL)
719 {
720 WARNING ("snmp plugin: `Username' not given for host `%s'", hd->name);
721 status = -1;
722 break;
723 }
724 if (hd->security_level == 0)
725 {
726 WARNING ("snmp plugin: `SecurityLevel' not given for host `%s'", hd->name);
727 status = -1;
728 break;
729 }
730 if (hd->security_level == SNMP_SEC_LEVEL_AUTHNOPRIV || hd->security_level == SNMP_SEC_LEVEL_AUTHPRIV)
731 {
732 if (hd->auth_protocol == NULL)
733 {
734 WARNING ("snmp plugin: `AuthProtocol' not given for host `%s'", hd->name);
735 status = -1;
736 break;
737 }
738 if (hd->auth_passphrase == NULL)
739 {
740 WARNING ("snmp plugin: `AuthPassphrase' not given for host `%s'", hd->name);
741 status = -1;
742 break;
743 }
744 }
745 if (hd->security_level == SNMP_SEC_LEVEL_AUTHPRIV)
746 {
747 if (hd->priv_protocol == NULL)
748 {
749 WARNING ("snmp plugin: `PrivacyProtocol' not given for host `%s'", hd->name);
750 status = -1;
751 break;
752 }
753 if (hd->priv_passphrase == NULL)
754 {
755 WARNING ("snmp plugin: `PrivacyPassphrase' not given for host `%s'", hd->name);
756 status = -1;
757 break;
758 }
759 }
760 }
762 break;
763 } /* while (status == 0) */
765 if (status != 0)
766 {
767 csnmp_host_definition_destroy (hd);
768 return (-1);
769 }
771 DEBUG ("snmp plugin: hd = { name = %s, address = %s, community = %s, version = %i }",
772 hd->name, hd->address, hd->community, hd->version);
774 ssnprintf (cb_name, sizeof (cb_name), "snmp-%s", hd->name);
776 memset (&cb_data, 0, sizeof (cb_data));
777 cb_data.data = hd;
778 cb_data.free_func = csnmp_host_definition_destroy;
780 status = plugin_register_complex_read (/* group = */ NULL, cb_name,
781 csnmp_read_host, hd->interval, /* user_data = */ &cb_data);
782 if (status != 0)
783 {
784 ERROR ("snmp plugin: Registering complex read function failed.");
785 csnmp_host_definition_destroy (hd);
786 return (-1);
787 }
789 return (0);
790 } /* int csnmp_config_add_host */
792 static int csnmp_config (oconfig_item_t *ci)
793 {
794 int i;
796 call_snmp_init_once ();
798 for (i = 0; i < ci->children_num; i++)
799 {
800 oconfig_item_t *child = ci->children + i;
801 if (strcasecmp ("Data", child->key) == 0)
802 csnmp_config_add_data (child);
803 else if (strcasecmp ("Host", child->key) == 0)
804 csnmp_config_add_host (child);
805 else
806 {
807 WARNING ("snmp plugin: Ignoring unknown config option `%s'.", child->key);
808 }
809 } /* for (ci->children) */
811 return (0);
812 } /* int csnmp_config */
814 /* }}} End of the config stuff. Now the interesting part begins */
816 static void csnmp_host_open_session (host_definition_t *host)
817 {
818 struct snmp_session sess;
819 int error;
821 if (host->sess_handle != NULL)
822 csnmp_host_close_session (host);
824 snmp_sess_init (&sess);
825 sess.peername = host->address;
826 switch (host->version)
827 {
828 case 1:
829 sess.version = SNMP_VERSION_1;
830 break;
831 case 3:
832 sess.version = SNMP_VERSION_3;
833 break;
834 default:
835 sess.version = SNMP_VERSION_2c;
836 break;
837 }
839 if (host->version == 3)
840 {
841 sess.securityName = host->username;
842 sess.securityNameLen = strlen (host->username);
843 sess.securityLevel = host->security_level;
845 if (sess.securityLevel == SNMP_SEC_LEVEL_AUTHNOPRIV || sess.securityLevel == SNMP_SEC_LEVEL_AUTHPRIV)
846 {
847 sess.securityAuthProto = host->auth_protocol;
848 sess.securityAuthProtoLen = host->auth_protocol_len;
849 sess.securityAuthKeyLen = USM_AUTH_KU_LEN;
850 error = generate_Ku (sess.securityAuthProto,
851 sess.securityAuthProtoLen,
852 (u_char *) host->auth_passphrase,
853 strlen(host->auth_passphrase),
854 sess.securityAuthKey,
855 &sess.securityAuthKeyLen);
856 if (error != SNMPERR_SUCCESS) {
857 ERROR ("snmp plugin: host %s: Error generating Ku from auth_passphrase. (Error %d)", host->name, error);
858 }
859 }
861 if (sess.securityLevel == SNMP_SEC_LEVEL_AUTHPRIV)
862 {
863 sess.securityPrivProto = host->priv_protocol;
864 sess.securityPrivProtoLen = host->priv_protocol_len;
865 sess.securityPrivKeyLen = USM_PRIV_KU_LEN;
866 error = generate_Ku (sess.securityAuthProto,
867 sess.securityAuthProtoLen,
868 (u_char *) host->priv_passphrase,
869 strlen(host->priv_passphrase),
870 sess.securityPrivKey,
871 &sess.securityPrivKeyLen);
872 if (error != SNMPERR_SUCCESS) {
873 ERROR ("snmp plugin: host %s: Error generating Ku from priv_passphrase. (Error %d)", host->name, error);
874 }
875 }
877 if (host->context != NULL)
878 {
879 sess.contextName = host->context;
880 sess.contextNameLen = strlen (host->context);
881 }
882 }
883 else /* SNMPv1/2 "authenticates" with community string */
884 {
885 sess.community = (u_char *) host->community;
886 sess.community_len = strlen (host->community);
887 }
889 /* snmp_sess_open will copy the `struct snmp_session *'. */
890 host->sess_handle = snmp_sess_open (&sess);
892 if (host->sess_handle == NULL)
893 {
894 char *errstr = NULL;
896 snmp_error (&sess, NULL, NULL, &errstr);
898 ERROR ("snmp plugin: host %s: snmp_sess_open failed: %s",
899 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
900 sfree (errstr);
901 }
902 } /* void csnmp_host_open_session */
904 /* TODO: Check if negative values wrap around. Problem: negative temperatures. */
905 static value_t csnmp_value_list_to_value (struct variable_list *vl, int type,
906 double scale, double shift,
907 const char *host_name, const char *data_name)
908 {
909 value_t ret;
910 uint64_t tmp_unsigned = 0;
911 int64_t tmp_signed = 0;
912 _Bool defined = 1;
913 /* Set to true when the original SNMP type appears to have been signed. */
914 _Bool prefer_signed = 0;
916 if ((vl->type == ASN_INTEGER)
917 || (vl->type == ASN_UINTEGER)
918 || (vl->type == ASN_COUNTER)
919 #ifdef ASN_TIMETICKS
920 || (vl->type == ASN_TIMETICKS)
921 #endif
922 || (vl->type == ASN_GAUGE))
923 {
924 tmp_unsigned = (uint32_t) *vl->val.integer;
925 tmp_signed = (int32_t) *vl->val.integer;
927 if ((vl->type == ASN_INTEGER)
928 || (vl->type == ASN_GAUGE))
929 prefer_signed = 1;
931 DEBUG ("snmp plugin: Parsed int32 value is %"PRIu64".", tmp_unsigned);
932 }
933 else if (vl->type == ASN_COUNTER64)
934 {
935 tmp_unsigned = (uint32_t) vl->val.counter64->high;
936 tmp_unsigned = tmp_unsigned << 32;
937 tmp_unsigned += (uint32_t) vl->val.counter64->low;
938 tmp_signed = (int64_t) tmp_unsigned;
939 DEBUG ("snmp plugin: Parsed int64 value is %"PRIu64".", tmp_unsigned);
940 }
941 else if (vl->type == ASN_OCTET_STR)
942 {
943 /* We'll handle this later.. */
944 }
945 else
946 {
947 char oid_buffer[1024];
949 memset (oid_buffer, 0, sizeof (oid_buffer));
950 snprint_objid (oid_buffer, sizeof (oid_buffer) - 1,
951 vl->name, vl->name_length);
953 #ifdef ASN_NULL
954 if (vl->type == ASN_NULL)
955 INFO ("snmp plugin: OID \"%s\" is undefined (type ASN_NULL)",
956 oid_buffer);
957 else
958 #endif
959 WARNING ("snmp plugin: I don't know the ASN type #%i "
960 "(OID: \"%s\", data block \"%s\", host block \"%s\")",
961 (int) vl->type, oid_buffer,
962 (data_name != NULL) ? data_name : "UNKNOWN",
963 (host_name != NULL) ? host_name : "UNKNOWN");
965 defined = 0;
966 }
968 if (vl->type == ASN_OCTET_STR)
969 {
970 int status = -1;
972 if (vl->val.string != NULL)
973 {
974 char string[64];
975 size_t string_length;
977 string_length = sizeof (string) - 1;
978 if (vl->val_len < string_length)
979 string_length = vl->val_len;
981 /* The strings we get from the Net-SNMP library may not be null
982 * terminated. That is why we're using `memcpy' here and not `strcpy'.
983 * `string_length' is set to `vl->val_len' which holds the length of the
984 * string. -octo */
985 memcpy (string, vl->val.string, string_length);
986 string[string_length] = 0;
988 status = parse_value (string, &ret, type);
989 if (status != 0)
990 {
991 ERROR ("snmp plugin: host %s: csnmp_value_list_to_value: Parsing string as %s failed: %s",
992 (host_name != NULL) ? host_name : "UNKNOWN",
993 DS_TYPE_TO_STRING (type), string);
994 }
995 }
997 if (status != 0)
998 {
999 switch (type)
1000 {
1001 case DS_TYPE_COUNTER:
1002 case DS_TYPE_DERIVE:
1003 case DS_TYPE_ABSOLUTE:
1004 memset (&ret, 0, sizeof (ret));
1005 break;
1007 case DS_TYPE_GAUGE:
1008 ret.gauge = NAN;
1009 break;
1011 default:
1012 ERROR ("snmp plugin: csnmp_value_list_to_value: Unknown "
1013 "data source type: %i.", type);
1014 ret.gauge = NAN;
1015 }
1016 }
1017 } /* if (vl->type == ASN_OCTET_STR) */
1018 else if (type == DS_TYPE_COUNTER)
1019 {
1020 ret.counter = tmp_unsigned;
1021 }
1022 else if (type == DS_TYPE_GAUGE)
1023 {
1024 if (!defined)
1025 ret.gauge = NAN;
1026 else if (prefer_signed)
1027 ret.gauge = (scale * tmp_signed) + shift;
1028 else
1029 ret.gauge = (scale * tmp_unsigned) + shift;
1030 }
1031 else if (type == DS_TYPE_DERIVE)
1032 {
1033 if (prefer_signed)
1034 ret.derive = (derive_t) tmp_signed;
1035 else
1036 ret.derive = (derive_t) tmp_unsigned;
1037 }
1038 else if (type == DS_TYPE_ABSOLUTE)
1039 {
1040 ret.absolute = (absolute_t) tmp_unsigned;
1041 }
1042 else
1043 {
1044 ERROR ("snmp plugin: csnmp_value_list_to_value: Unknown data source "
1045 "type: %i.", type);
1046 ret.gauge = NAN;
1047 }
1049 return (ret);
1050 } /* value_t csnmp_value_list_to_value */
1052 /* csnmp_strvbcopy_hexstring converts the bit string contained in "vb" to a hex
1053 * representation and writes it to dst. Returns zero on success and ENOMEM if
1054 * dst is not large enough to hold the string. dst is guaranteed to be
1055 * nul-terminated. */
1056 static int csnmp_strvbcopy_hexstring (char *dst, /* {{{ */
1057 const struct variable_list *vb, size_t dst_size)
1058 {
1059 char *buffer_ptr;
1060 size_t buffer_free;
1061 size_t i;
1063 dst[0] = 0;
1065 buffer_ptr = dst;
1066 buffer_free = dst_size;
1068 for (i = 0; i < vb->val_len; i++)
1069 {
1070 int status;
1072 status = snprintf (buffer_ptr, buffer_free,
1073 (i == 0) ? "%02x" : ":%02x", (unsigned int) vb->val.bitstring[i]);
1074 assert (status >= 0);
1076 if (((size_t) status) >= buffer_free) /* truncated */
1077 {
1078 dst[dst_size - 1] = 0;
1079 return ENOMEM;
1080 }
1081 else /* if (status < buffer_free) */
1082 {
1083 buffer_ptr += (size_t) status;
1084 buffer_free -= (size_t) status;
1085 }
1086 }
1088 return 0;
1089 } /* }}} int csnmp_strvbcopy_hexstring */
1091 /* csnmp_strvbcopy copies the octet string or bit string contained in vb to
1092 * dst. If non-printable characters are detected, it will switch to a hex
1093 * representation of the string. Returns zero on success, EINVAL if vb does not
1094 * contain a string and ENOMEM if dst is not large enough to contain the
1095 * string. */
1096 static int csnmp_strvbcopy (char *dst, /* {{{ */
1097 const struct variable_list *vb, size_t dst_size)
1098 {
1099 char *src;
1100 size_t num_chars;
1101 size_t i;
1103 if (vb->type == ASN_OCTET_STR)
1104 src = (char *) vb->val.string;
1105 else if (vb->type == ASN_BIT_STR)
1106 src = (char *) vb->val.bitstring;
1107 else
1108 {
1109 dst[0] = 0;
1110 return (EINVAL);
1111 }
1113 num_chars = dst_size - 1;
1114 if (num_chars > vb->val_len)
1115 num_chars = vb->val_len;
1117 for (i = 0; i < num_chars; i++)
1118 {
1119 /* Check for control characters. */
1120 if ((unsigned char)src[i] < 32)
1121 return (csnmp_strvbcopy_hexstring (dst, vb, dst_size));
1122 dst[i] = src[i];
1123 }
1124 dst[num_chars] = 0;
1125 dst[dst_size - 1] = 0;
1127 if (dst_size <= vb->val_len)
1128 return ENOMEM;
1130 return 0;
1131 } /* }}} int csnmp_strvbcopy */
1133 static int csnmp_instance_list_add (csnmp_list_instances_t **head,
1134 csnmp_list_instances_t **tail,
1135 const struct snmp_pdu *res,
1136 const host_definition_t *hd, const data_definition_t *dd)
1137 {
1138 csnmp_list_instances_t *il;
1139 struct variable_list *vb;
1140 oid_t vb_name;
1141 int status;
1142 uint32_t i;
1143 uint32_t is_matched;
1145 /* Set vb on the last variable */
1146 for (vb = res->variables;
1147 (vb != NULL) && (vb->next_variable != NULL);
1148 vb = vb->next_variable)
1149 /* do nothing */;
1150 if (vb == NULL)
1151 return (-1);
1153 csnmp_oid_init (&vb_name, vb->name, vb->name_length);
1155 il = malloc (sizeof (*il));
1156 if (il == NULL)
1157 {
1158 ERROR ("snmp plugin: malloc failed.");
1159 return (-1);
1160 }
1161 memset (il, 0, sizeof (*il));
1162 il->next = NULL;
1164 status = csnmp_oid_suffix (&il->suffix, &vb_name, &dd->instance.oid);
1165 if (status != 0)
1166 {
1167 sfree (il);
1168 return (status);
1169 }
1171 /* Get instance name */
1172 if ((vb->type == ASN_OCTET_STR) || (vb->type == ASN_BIT_STR))
1173 {
1174 char *ptr;
1176 csnmp_strvbcopy (il->instance, vb, sizeof (il->instance));
1177 is_matched = 0;
1178 for (i = 0; i < dd->ignores_len; i++)
1179 {
1180 status = fnmatch(dd->ignores[i], il->instance, 0);
1181 if (status == 0)
1182 {
1183 if (dd->invert_match == 0)
1184 {
1185 sfree(il);
1186 return 0;
1187 }
1188 else
1189 {
1190 is_matched = 1;
1191 break;
1192 }
1193 }
1194 }
1195 if (dd->invert_match != 0 && is_matched == 0)
1196 {
1197 sfree(il);
1198 return 0;
1199 }
1200 for (ptr = il->instance; *ptr != '\0'; ptr++)
1201 {
1202 if ((*ptr > 0) && (*ptr < 32))
1203 *ptr = ' ';
1204 else if (*ptr == '/')
1205 *ptr = '_';
1206 }
1207 DEBUG ("snmp plugin: il->instance = `%s';", il->instance);
1208 }
1209 else
1210 {
1211 value_t val = csnmp_value_list_to_value (vb, DS_TYPE_COUNTER,
1212 /* scale = */ 1.0, /* shift = */ 0.0, hd->name, dd->name);
1213 ssnprintf (il->instance, sizeof (il->instance),
1214 "%llu", val.counter);
1215 }
1217 /* TODO: Debugging output */
1219 if (*head == NULL)
1220 *head = il;
1221 else
1222 (*tail)->next = il;
1223 *tail = il;
1225 return (0);
1226 } /* int csnmp_instance_list_add */
1228 static int csnmp_dispatch_table (host_definition_t *host, data_definition_t *data,
1229 csnmp_list_instances_t *instance_list,
1230 csnmp_table_values_t **value_table)
1231 {
1232 const data_set_t *ds;
1233 value_list_t vl = VALUE_LIST_INIT;
1235 csnmp_list_instances_t *instance_list_ptr;
1236 csnmp_table_values_t **value_table_ptr;
1238 size_t i;
1239 _Bool have_more;
1240 oid_t current_suffix;
1242 ds = plugin_get_ds (data->type);
1243 if (!ds)
1244 {
1245 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
1246 return (-1);
1247 }
1248 assert (ds->ds_num == data->values_len);
1249 assert (data->values_len > 0);
1251 instance_list_ptr = instance_list;
1253 value_table_ptr = calloc (data->values_len, sizeof (*value_table_ptr));
1254 if (value_table_ptr == NULL)
1255 return (-1);
1256 for (i = 0; i < data->values_len; i++)
1257 value_table_ptr[i] = value_table[i];
1259 vl.values_len = data->values_len;
1260 vl.values = malloc (sizeof (*vl.values) * vl.values_len);
1261 if (vl.values == NULL)
1262 {
1263 ERROR ("snmp plugin: malloc failed.");
1264 sfree (value_table_ptr);
1265 return (-1);
1266 }
1268 sstrncpy (vl.host, host->name, sizeof (vl.host));
1269 sstrncpy (vl.plugin, "snmp", sizeof (vl.plugin));
1271 vl.interval = host->interval;
1273 have_more = 1;
1274 memset (¤t_suffix, 0, sizeof (current_suffix));
1275 while (have_more)
1276 {
1277 _Bool suffix_skipped = 0;
1279 /* Determine next suffix to handle. */
1280 if (instance_list != NULL)
1281 {
1282 if (instance_list_ptr == NULL)
1283 {
1284 have_more = 0;
1285 continue;
1286 }
1288 memcpy (¤t_suffix, &instance_list_ptr->suffix, sizeof (current_suffix));
1289 }
1290 else /* no instance configured */
1291 {
1292 csnmp_table_values_t *ptr = value_table_ptr[0];
1293 if (ptr == NULL)
1294 {
1295 have_more = 0;
1296 continue;
1297 }
1299 memcpy (¤t_suffix, &ptr->suffix, sizeof (current_suffix));
1300 }
1302 /* Update all the value_table_ptr to point at the entry with the same
1303 * trailing partial OID */
1304 for (i = 0; i < data->values_len; i++)
1305 {
1306 while ((value_table_ptr[i] != NULL)
1307 && (csnmp_oid_compare (&value_table_ptr[i]->suffix, ¤t_suffix) < 0))
1308 value_table_ptr[i] = value_table_ptr[i]->next;
1310 if (value_table_ptr[i] == NULL)
1311 {
1312 have_more = 0;
1313 break;
1314 }
1315 else if (csnmp_oid_compare (&value_table_ptr[i]->suffix, ¤t_suffix) > 0)
1316 {
1317 /* This suffix is missing in the subtree. Indicate this with the
1318 * "suffix_skipped" flag and try the next instance / suffix. */
1319 suffix_skipped = 1;
1320 break;
1321 }
1322 } /* for (i = 0; i < columns; i++) */
1324 if (!have_more)
1325 break;
1327 /* Matching the values failed. Start from the beginning again. */
1328 if (suffix_skipped)
1329 {
1330 if (instance_list != NULL)
1331 instance_list_ptr = instance_list_ptr->next;
1332 else
1333 value_table_ptr[0] = value_table_ptr[0]->next;
1335 continue;
1336 }
1338 /* if we reach this line, all value_table_ptr[i] are non-NULL and are set
1339 * to the same subid. instance_list_ptr is either NULL or points to the
1340 * same subid, too. */
1341 #if COLLECT_DEBUG
1342 for (i = 1; i < data->values_len; i++)
1343 {
1344 assert (value_table_ptr[i] != NULL);
1345 assert (csnmp_oid_compare (&value_table_ptr[i-1]->suffix,
1346 &value_table_ptr[i]->suffix) == 0);
1347 }
1348 assert ((instance_list_ptr == NULL)
1349 || (csnmp_oid_compare (&instance_list_ptr->suffix,
1350 &value_table_ptr[0]->suffix) == 0));
1351 #endif
1353 sstrncpy (vl.type, data->type, sizeof (vl.type));
1355 {
1356 char temp[DATA_MAX_NAME_LEN];
1358 if (instance_list_ptr == NULL)
1359 csnmp_oid_to_string (temp, sizeof (temp), ¤t_suffix);
1360 else
1361 sstrncpy (temp, instance_list_ptr->instance, sizeof (temp));
1363 if (data->instance_prefix == NULL)
1364 sstrncpy (vl.type_instance, temp, sizeof (vl.type_instance));
1365 else
1366 ssnprintf (vl.type_instance, sizeof (vl.type_instance), "%s%s",
1367 data->instance_prefix, temp);
1368 }
1370 for (i = 0; i < data->values_len; i++)
1371 vl.values[i] = value_table_ptr[i]->value;
1373 /* If we get here `vl.type_instance' and all `vl.values' have been set */
1374 plugin_dispatch_values (&vl);
1376 if (instance_list != NULL)
1377 instance_list_ptr = instance_list_ptr->next;
1378 else
1379 value_table_ptr[0] = value_table_ptr[0]->next;
1380 } /* while (have_more) */
1382 sfree (vl.values);
1383 sfree (value_table_ptr);
1385 return (0);
1386 } /* int csnmp_dispatch_table */
1388 static int csnmp_read_table (host_definition_t *host, data_definition_t *data)
1389 {
1390 struct snmp_pdu *req;
1391 struct snmp_pdu *res;
1392 struct variable_list *vb;
1394 const data_set_t *ds;
1396 size_t oid_list_len = data->values_len + 1;
1397 /* Holds the last OID returned by the device. We use this in the GETNEXT
1398 * request to proceed. */
1399 oid_t oid_list[oid_list_len];
1400 /* Set to false when an OID has left its subtree so we don't re-request it
1401 * again. */
1402 _Bool oid_list_todo[oid_list_len];
1404 int status;
1405 size_t i;
1407 /* `value_list_head' and `value_list_tail' implement a linked list for each
1408 * value. `instance_list_head' and `instance_list_tail' implement a linked list of
1409 * instance names. This is used to jump gaps in the table. */
1410 csnmp_list_instances_t *instance_list_head;
1411 csnmp_list_instances_t *instance_list_tail;
1412 csnmp_table_values_t **value_list_head;
1413 csnmp_table_values_t **value_list_tail;
1415 DEBUG ("snmp plugin: csnmp_read_table (host = %s, data = %s)",
1416 host->name, data->name);
1418 if (host->sess_handle == NULL)
1419 {
1420 DEBUG ("snmp plugin: csnmp_read_table: host->sess_handle == NULL");
1421 return (-1);
1422 }
1424 ds = plugin_get_ds (data->type);
1425 if (!ds)
1426 {
1427 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
1428 return (-1);
1429 }
1431 if (ds->ds_num != data->values_len)
1432 {
1433 ERROR ("snmp plugin: DataSet `%s' requires %zu values, but config talks about %zu",
1434 data->type, ds->ds_num, data->values_len);
1435 return (-1);
1436 }
1437 assert (data->values_len > 0);
1439 /* We need a copy of all the OIDs, because GETNEXT will destroy them. */
1440 memcpy (oid_list, data->values, data->values_len * sizeof (oid_t));
1441 if (data->instance.oid.oid_len > 0)
1442 memcpy (oid_list + data->values_len, &data->instance.oid, sizeof (oid_t));
1443 else /* no InstanceFrom option specified. */
1444 oid_list_len--;
1446 for (i = 0; i < oid_list_len; i++)
1447 oid_list_todo[i] = 1;
1449 /* We're going to construct n linked lists, one for each "value".
1450 * value_list_head will contain pointers to the heads of these linked lists,
1451 * value_list_tail will contain pointers to the tail of the lists. */
1452 value_list_head = calloc (data->values_len, sizeof (*value_list_head));
1453 value_list_tail = calloc (data->values_len, sizeof (*value_list_tail));
1454 if ((value_list_head == NULL) || (value_list_tail == NULL))
1455 {
1456 ERROR ("snmp plugin: csnmp_read_table: calloc failed.");
1457 sfree (value_list_head);
1458 sfree (value_list_tail);
1459 return (-1);
1460 }
1462 instance_list_head = NULL;
1463 instance_list_tail = NULL;
1465 status = 0;
1466 while (status == 0)
1467 {
1468 int oid_list_todo_num;
1470 req = snmp_pdu_create (SNMP_MSG_GETNEXT);
1471 if (req == NULL)
1472 {
1473 ERROR ("snmp plugin: snmp_pdu_create failed.");
1474 status = -1;
1475 break;
1476 }
1478 oid_list_todo_num = 0;
1479 for (i = 0; i < oid_list_len; i++)
1480 {
1481 /* Do not rerequest already finished OIDs */
1482 if (!oid_list_todo[i])
1483 continue;
1484 oid_list_todo_num++;
1485 snmp_add_null_var (req, oid_list[i].oid, oid_list[i].oid_len);
1486 }
1488 if (oid_list_todo_num == 0)
1489 {
1490 /* The request is still empty - so we are finished */
1491 DEBUG ("snmp plugin: all variables have left their subtree");
1492 status = 0;
1493 break;
1494 }
1496 res = NULL;
1497 status = snmp_sess_synch_response (host->sess_handle, req, &res);
1498 if ((status != STAT_SUCCESS) || (res == NULL))
1499 {
1500 char *errstr = NULL;
1502 snmp_sess_error (host->sess_handle, NULL, NULL, &errstr);
1504 c_complain (LOG_ERR, &host->complaint,
1505 "snmp plugin: host %s: snmp_sess_synch_response failed: %s",
1506 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
1508 if (res != NULL)
1509 snmp_free_pdu (res);
1510 res = NULL;
1512 /* snmp_synch_response already freed our PDU */
1513 req = NULL;
1514 sfree (errstr);
1515 csnmp_host_close_session (host);
1517 status = -1;
1518 break;
1519 }
1521 status = 0;
1522 assert (res != NULL);
1523 c_release (LOG_INFO, &host->complaint,
1524 "snmp plugin: host %s: snmp_sess_synch_response successful.",
1525 host->name);
1527 vb = res->variables;
1528 if (vb == NULL)
1529 {
1530 status = -1;
1531 break;
1532 }
1534 for (vb = res->variables, i = 0; (vb != NULL); vb = vb->next_variable, i++)
1535 {
1536 /* Calculate value index from todo list */
1537 while ((i < oid_list_len) && !oid_list_todo[i])
1538 i++;
1540 /* An instance is configured and the res variable we process is the
1541 * instance value (last index) */
1542 if ((data->instance.oid.oid_len > 0) && (i == data->values_len))
1543 {
1544 if ((vb->type == SNMP_ENDOFMIBVIEW)
1545 || (snmp_oid_ncompare (data->instance.oid.oid,
1546 data->instance.oid.oid_len,
1547 vb->name, vb->name_length,
1548 data->instance.oid.oid_len) != 0))
1549 {
1550 DEBUG ("snmp plugin: host = %s; data = %s; Instance left its subtree.",
1551 host->name, data->name);
1552 oid_list_todo[i] = 0;
1553 continue;
1554 }
1556 /* Allocate a new `csnmp_list_instances_t', insert the instance name and
1557 * add it to the list */
1558 if (csnmp_instance_list_add (&instance_list_head, &instance_list_tail,
1559 res, host, data) != 0)
1560 {
1561 ERROR ("snmp plugin: host %s: csnmp_instance_list_add failed.",
1562 host->name);
1563 status = -1;
1564 break;
1565 }
1566 }
1567 else /* The variable we are processing is a normal value */
1568 {
1569 csnmp_table_values_t *vt;
1570 oid_t vb_name;
1571 oid_t suffix;
1572 int ret;
1574 csnmp_oid_init (&vb_name, vb->name, vb->name_length);
1576 /* Calculate the current suffix. This is later used to check that the
1577 * suffix is increasing. This also checks if we left the subtree */
1578 ret = csnmp_oid_suffix (&suffix, &vb_name, data->values + i);
1579 if (ret != 0)
1580 {
1581 DEBUG ("snmp plugin: host = %s; data = %s; i = %zu; "
1582 "Value probably left its subtree.",
1583 host->name, data->name, i);
1584 oid_list_todo[i] = 0;
1585 continue;
1586 }
1588 /* Make sure the OIDs returned by the agent are increasing. Otherwise our
1589 * table matching algorithm will get confused. */
1590 if ((value_list_tail[i] != NULL)
1591 && (csnmp_oid_compare (&suffix, &value_list_tail[i]->suffix) <= 0))
1592 {
1593 DEBUG ("snmp plugin: host = %s; data = %s; i = %zu; "
1594 "Suffix is not increasing.",
1595 host->name, data->name, i);
1596 oid_list_todo[i] = 0;
1597 continue;
1598 }
1600 vt = malloc (sizeof (*vt));
1601 if (vt == NULL)
1602 {
1603 ERROR ("snmp plugin: malloc failed.");
1604 status = -1;
1605 break;
1606 }
1607 memset (vt, 0, sizeof (*vt));
1609 vt->value = csnmp_value_list_to_value (vb, ds->ds[i].type,
1610 data->scale, data->shift, host->name, data->name);
1611 memcpy (&vt->suffix, &suffix, sizeof (vt->suffix));
1612 vt->next = NULL;
1614 if (value_list_tail[i] == NULL)
1615 value_list_head[i] = vt;
1616 else
1617 value_list_tail[i]->next = vt;
1618 value_list_tail[i] = vt;
1619 }
1621 /* Copy OID to oid_list[i] */
1622 memcpy (oid_list[i].oid, vb->name, sizeof (oid) * vb->name_length);
1623 oid_list[i].oid_len = vb->name_length;
1625 } /* for (vb = res->variables ...) */
1627 if (res != NULL)
1628 snmp_free_pdu (res);
1629 res = NULL;
1630 } /* while (status == 0) */
1632 if (res != NULL)
1633 snmp_free_pdu (res);
1634 res = NULL;
1636 if (req != NULL)
1637 snmp_free_pdu (req);
1638 req = NULL;
1640 if (status == 0)
1641 csnmp_dispatch_table (host, data, instance_list_head, value_list_head);
1643 /* Free all allocated variables here */
1644 while (instance_list_head != NULL)
1645 {
1646 csnmp_list_instances_t *next = instance_list_head->next;
1647 sfree (instance_list_head);
1648 instance_list_head = next;
1649 }
1651 for (i = 0; i < data->values_len; i++)
1652 {
1653 while (value_list_head[i] != NULL)
1654 {
1655 csnmp_table_values_t *next = value_list_head[i]->next;
1656 sfree (value_list_head[i]);
1657 value_list_head[i] = next;
1658 }
1659 }
1661 sfree (value_list_head);
1662 sfree (value_list_tail);
1664 return (0);
1665 } /* int csnmp_read_table */
1667 static int csnmp_read_value (host_definition_t *host, data_definition_t *data)
1668 {
1669 struct snmp_pdu *req;
1670 struct snmp_pdu *res;
1671 struct variable_list *vb;
1673 const data_set_t *ds;
1674 value_list_t vl = VALUE_LIST_INIT;
1676 int status;
1677 size_t i;
1679 DEBUG ("snmp plugin: csnmp_read_value (host = %s, data = %s)",
1680 host->name, data->name);
1682 if (host->sess_handle == NULL)
1683 {
1684 DEBUG ("snmp plugin: csnmp_read_table: host->sess_handle == NULL");
1685 return (-1);
1686 }
1688 ds = plugin_get_ds (data->type);
1689 if (!ds)
1690 {
1691 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
1692 return (-1);
1693 }
1695 if (ds->ds_num != data->values_len)
1696 {
1697 ERROR ("snmp plugin: DataSet `%s' requires %zu values, but config talks about %zu",
1698 data->type, ds->ds_num, data->values_len);
1699 return (-1);
1700 }
1702 vl.values_len = ds->ds_num;
1703 vl.values = (value_t *) malloc (sizeof (value_t) * vl.values_len);
1704 if (vl.values == NULL)
1705 return (-1);
1706 for (i = 0; i < vl.values_len; i++)
1707 {
1708 if (ds->ds[i].type == DS_TYPE_COUNTER)
1709 vl.values[i].counter = 0;
1710 else
1711 vl.values[i].gauge = NAN;
1712 }
1714 sstrncpy (vl.host, host->name, sizeof (vl.host));
1715 sstrncpy (vl.plugin, "snmp", sizeof (vl.plugin));
1716 sstrncpy (vl.type, data->type, sizeof (vl.type));
1717 sstrncpy (vl.type_instance, data->instance.string, sizeof (vl.type_instance));
1719 vl.interval = host->interval;
1721 req = snmp_pdu_create (SNMP_MSG_GET);
1722 if (req == NULL)
1723 {
1724 ERROR ("snmp plugin: snmp_pdu_create failed.");
1725 sfree (vl.values);
1726 return (-1);
1727 }
1729 for (i = 0; i < data->values_len; i++)
1730 snmp_add_null_var (req, data->values[i].oid, data->values[i].oid_len);
1732 res = NULL;
1733 status = snmp_sess_synch_response (host->sess_handle, req, &res);
1735 if ((status != STAT_SUCCESS) || (res == NULL))
1736 {
1737 char *errstr = NULL;
1739 snmp_sess_error (host->sess_handle, NULL, NULL, &errstr);
1740 ERROR ("snmp plugin: host %s: snmp_sess_synch_response failed: %s",
1741 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
1743 if (res != NULL)
1744 snmp_free_pdu (res);
1745 res = NULL;
1747 sfree (errstr);
1748 csnmp_host_close_session (host);
1750 return (-1);
1751 }
1754 for (vb = res->variables; vb != NULL; vb = vb->next_variable)
1755 {
1756 #if COLLECT_DEBUG
1757 char buffer[1024];
1758 snprint_variable (buffer, sizeof (buffer),
1759 vb->name, vb->name_length, vb);
1760 DEBUG ("snmp plugin: Got this variable: %s", buffer);
1761 #endif /* COLLECT_DEBUG */
1763 for (i = 0; i < data->values_len; i++)
1764 if (snmp_oid_compare (data->values[i].oid, data->values[i].oid_len,
1765 vb->name, vb->name_length) == 0)
1766 vl.values[i] = csnmp_value_list_to_value (vb, ds->ds[i].type,
1767 data->scale, data->shift, host->name, data->name);
1768 } /* for (res->variables) */
1770 if (res != NULL)
1771 snmp_free_pdu (res);
1772 res = NULL;
1774 DEBUG ("snmp plugin: -> plugin_dispatch_values (&vl);");
1775 plugin_dispatch_values (&vl);
1776 sfree (vl.values);
1778 return (0);
1779 } /* int csnmp_read_value */
1781 static int csnmp_read_host (user_data_t *ud)
1782 {
1783 host_definition_t *host;
1784 cdtime_t time_start;
1785 cdtime_t time_end;
1786 int status;
1787 int success;
1788 int i;
1790 host = ud->data;
1792 if (host->interval == 0)
1793 host->interval = plugin_get_interval ();
1795 time_start = cdtime ();
1797 if (host->sess_handle == NULL)
1798 csnmp_host_open_session (host);
1800 if (host->sess_handle == NULL)
1801 return (-1);
1803 success = 0;
1804 for (i = 0; i < host->data_list_len; i++)
1805 {
1806 data_definition_t *data = host->data_list[i];
1808 if (data->is_table)
1809 status = csnmp_read_table (host, data);
1810 else
1811 status = csnmp_read_value (host, data);
1813 if (status == 0)
1814 success++;
1815 }
1817 time_end = cdtime ();
1818 if ((time_end - time_start) > host->interval)
1819 {
1820 WARNING ("snmp plugin: Host `%s' should be queried every %.3f "
1821 "seconds, but reading all values takes %.3f seconds.",
1822 host->name,
1823 CDTIME_T_TO_DOUBLE (host->interval),
1824 CDTIME_T_TO_DOUBLE (time_end - time_start));
1825 }
1827 if (success == 0)
1828 return (-1);
1830 return (0);
1831 } /* int csnmp_read_host */
1833 static int csnmp_init (void)
1834 {
1835 call_snmp_init_once ();
1837 return (0);
1838 } /* int csnmp_init */
1840 static int csnmp_shutdown (void)
1841 {
1842 data_definition_t *data_this;
1843 data_definition_t *data_next;
1845 /* When we get here, the read threads have been stopped and all the
1846 * `host_definition_t' will be freed. */
1847 DEBUG ("snmp plugin: Destroying all data definitions.");
1849 data_this = data_head;
1850 data_head = NULL;
1851 while (data_this != NULL)
1852 {
1853 data_next = data_this->next;
1855 sfree (data_this->name);
1856 sfree (data_this->type);
1857 sfree (data_this->values);
1858 sfree (data_this->ignores);
1859 sfree (data_this);
1861 data_this = data_next;
1862 }
1864 return (0);
1865 } /* int csnmp_shutdown */
1867 void module_register (void)
1868 {
1869 plugin_register_complex_config ("snmp", csnmp_config);
1870 plugin_register_init ("snmp", csnmp_init);
1871 plugin_register_shutdown ("snmp", csnmp_shutdown);
1872 } /* void module_register */
1874 /*
1875 * vim: shiftwidth=2 softtabstop=2 tabstop=8 fdm=marker
1876 */