3d6604183ea1cbcb626262149a66d241ba3d9f17
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
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 = 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 = %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)
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;
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 {
660 sfree (hd);
661 return status;
662 }
664 hd->sess_handle = NULL;
665 hd->interval = 0;
667 for (i = 0; i < ci->children_num; i++)
668 {
669 oconfig_item_t *option = ci->children + i;
670 status = 0;
672 if (strcasecmp ("Address", option->key) == 0)
673 status = cf_util_get_string(option, &hd->address);
674 else if (strcasecmp ("Community", option->key) == 0)
675 status = cf_util_get_string(option, &hd->community);
676 else if (strcasecmp ("Version", option->key) == 0)
677 status = csnmp_config_add_host_version (hd, option);
678 else if (strcasecmp ("Collect", option->key) == 0)
679 csnmp_config_add_host_collect (hd, option);
680 else if (strcasecmp ("Interval", option->key) == 0)
681 cf_util_get_cdtime (option, &hd->interval);
682 else if (strcasecmp ("Username", option->key) == 0)
683 status = cf_util_get_string(option, &hd->username);
684 else if (strcasecmp ("AuthProtocol", option->key) == 0)
685 status = csnmp_config_add_host_auth_protocol (hd, option);
686 else if (strcasecmp ("PrivacyProtocol", option->key) == 0)
687 status = csnmp_config_add_host_priv_protocol (hd, option);
688 else if (strcasecmp ("AuthPassphrase", option->key) == 0)
689 status = cf_util_get_string(option, &hd->auth_passphrase);
690 else if (strcasecmp ("PrivacyPassphrase", option->key) == 0)
691 status = cf_util_get_string(option, &hd->priv_passphrase);
692 else if (strcasecmp ("SecurityLevel", option->key) == 0)
693 status = csnmp_config_add_host_security_level (hd, option);
694 else if (strcasecmp ("Context", option->key) == 0)
695 status = cf_util_get_string(option, &hd->context);
696 else
697 {
698 WARNING ("snmp plugin: csnmp_config_add_host: Option `%s' not allowed here.", option->key);
699 status = -1;
700 }
702 if (status != 0)
703 break;
704 } /* for (ci->children) */
706 while (status == 0)
707 {
708 if (hd->address == NULL)
709 {
710 WARNING ("snmp plugin: `Address' not given for host `%s'", hd->name);
711 status = -1;
712 break;
713 }
714 if (hd->community == NULL && hd->version < 3)
715 {
716 WARNING ("snmp plugin: `Community' not given for host `%s'", hd->name);
717 status = -1;
718 break;
719 }
720 if (hd->version == 3)
721 {
722 if (hd->username == NULL)
723 {
724 WARNING ("snmp plugin: `Username' not given for host `%s'", hd->name);
725 status = -1;
726 break;
727 }
728 if (hd->security_level == 0)
729 {
730 WARNING ("snmp plugin: `SecurityLevel' not given for host `%s'", hd->name);
731 status = -1;
732 break;
733 }
734 if (hd->security_level == SNMP_SEC_LEVEL_AUTHNOPRIV || hd->security_level == SNMP_SEC_LEVEL_AUTHPRIV)
735 {
736 if (hd->auth_protocol == NULL)
737 {
738 WARNING ("snmp plugin: `AuthProtocol' not given for host `%s'", hd->name);
739 status = -1;
740 break;
741 }
742 if (hd->auth_passphrase == NULL)
743 {
744 WARNING ("snmp plugin: `AuthPassphrase' not given for host `%s'", hd->name);
745 status = -1;
746 break;
747 }
748 }
749 if (hd->security_level == SNMP_SEC_LEVEL_AUTHPRIV)
750 {
751 if (hd->priv_protocol == NULL)
752 {
753 WARNING ("snmp plugin: `PrivacyProtocol' not given for host `%s'", hd->name);
754 status = -1;
755 break;
756 }
757 if (hd->priv_passphrase == NULL)
758 {
759 WARNING ("snmp plugin: `PrivacyPassphrase' not given for host `%s'", hd->name);
760 status = -1;
761 break;
762 }
763 }
764 }
766 break;
767 } /* while (status == 0) */
769 if (status != 0)
770 {
771 csnmp_host_definition_destroy (hd);
772 return (-1);
773 }
775 DEBUG ("snmp plugin: hd = { name = %s, address = %s, community = %s, version = %i }",
776 hd->name, hd->address, hd->community, hd->version);
778 ssnprintf (cb_name, sizeof (cb_name), "snmp-%s", hd->name);
780 memset (&cb_data, 0, sizeof (cb_data));
781 cb_data.data = hd;
782 cb_data.free_func = csnmp_host_definition_destroy;
784 CDTIME_T_TO_TIMESPEC (hd->interval, &cb_interval);
786 status = plugin_register_complex_read (/* group = */ NULL, cb_name,
787 csnmp_read_host, /* interval = */ &cb_interval,
788 /* user_data = */ &cb_data);
789 if (status != 0)
790 {
791 ERROR ("snmp plugin: Registering complex read function failed.");
792 csnmp_host_definition_destroy (hd);
793 return (-1);
794 }
796 return (0);
797 } /* int csnmp_config_add_host */
799 static int csnmp_config (oconfig_item_t *ci)
800 {
801 int i;
803 call_snmp_init_once ();
805 for (i = 0; i < ci->children_num; i++)
806 {
807 oconfig_item_t *child = ci->children + i;
808 if (strcasecmp ("Data", child->key) == 0)
809 csnmp_config_add_data (child);
810 else if (strcasecmp ("Host", child->key) == 0)
811 csnmp_config_add_host (child);
812 else
813 {
814 WARNING ("snmp plugin: Ignoring unknown config option `%s'.", child->key);
815 }
816 } /* for (ci->children) */
818 return (0);
819 } /* int csnmp_config */
821 /* }}} End of the config stuff. Now the interesting part begins */
823 static void csnmp_host_open_session (host_definition_t *host)
824 {
825 struct snmp_session sess;
826 int error;
828 if (host->sess_handle != NULL)
829 csnmp_host_close_session (host);
831 snmp_sess_init (&sess);
832 sess.peername = host->address;
833 switch (host->version)
834 {
835 case 1:
836 sess.version = SNMP_VERSION_1;
837 break;
838 case 3:
839 sess.version = SNMP_VERSION_3;
840 break;
841 default:
842 sess.version = SNMP_VERSION_2c;
843 break;
844 }
846 if (host->version == 3)
847 {
848 sess.securityName = host->username;
849 sess.securityNameLen = strlen (host->username);
850 sess.securityLevel = host->security_level;
852 if (sess.securityLevel == SNMP_SEC_LEVEL_AUTHNOPRIV || sess.securityLevel == SNMP_SEC_LEVEL_AUTHPRIV)
853 {
854 sess.securityAuthProto = host->auth_protocol;
855 sess.securityAuthProtoLen = host->auth_protocol_len;
856 sess.securityAuthKeyLen = USM_AUTH_KU_LEN;
857 error = generate_Ku (sess.securityAuthProto,
858 sess.securityAuthProtoLen,
859 (u_char *) host->auth_passphrase,
860 strlen(host->auth_passphrase),
861 sess.securityAuthKey,
862 &sess.securityAuthKeyLen);
863 if (error != SNMPERR_SUCCESS) {
864 ERROR ("snmp plugin: host %s: Error generating Ku from auth_passphrase. (Error %d)", host->name, error);
865 }
866 }
868 if (sess.securityLevel == SNMP_SEC_LEVEL_AUTHPRIV)
869 {
870 sess.securityPrivProto = host->priv_protocol;
871 sess.securityPrivProtoLen = host->priv_protocol_len;
872 sess.securityPrivKeyLen = USM_PRIV_KU_LEN;
873 error = generate_Ku (sess.securityAuthProto,
874 sess.securityAuthProtoLen,
875 (u_char *) host->priv_passphrase,
876 strlen(host->priv_passphrase),
877 sess.securityPrivKey,
878 &sess.securityPrivKeyLen);
879 if (error != SNMPERR_SUCCESS) {
880 ERROR ("snmp plugin: host %s: Error generating Ku from priv_passphrase. (Error %d)", host->name, error);
881 }
882 }
884 if (host->context != NULL)
885 {
886 sess.contextName = host->context;
887 sess.contextNameLen = strlen (host->context);
888 }
889 }
890 else /* SNMPv1/2 "authenticates" with community string */
891 {
892 sess.community = (u_char *) host->community;
893 sess.community_len = strlen (host->community);
894 }
896 /* snmp_sess_open will copy the `struct snmp_session *'. */
897 host->sess_handle = snmp_sess_open (&sess);
899 if (host->sess_handle == NULL)
900 {
901 char *errstr = NULL;
903 snmp_error (&sess, NULL, NULL, &errstr);
905 ERROR ("snmp plugin: host %s: snmp_sess_open failed: %s",
906 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
907 sfree (errstr);
908 }
909 } /* void csnmp_host_open_session */
911 /* TODO: Check if negative values wrap around. Problem: negative temperatures. */
912 static value_t csnmp_value_list_to_value (struct variable_list *vl, int type,
913 double scale, double shift,
914 const char *host_name, const char *data_name)
915 {
916 value_t ret;
917 uint64_t tmp_unsigned = 0;
918 int64_t tmp_signed = 0;
919 _Bool defined = 1;
920 /* Set to true when the original SNMP type appears to have been signed. */
921 _Bool prefer_signed = 0;
923 if ((vl->type == ASN_INTEGER)
924 || (vl->type == ASN_UINTEGER)
925 || (vl->type == ASN_COUNTER)
926 #ifdef ASN_TIMETICKS
927 || (vl->type == ASN_TIMETICKS)
928 #endif
929 || (vl->type == ASN_GAUGE))
930 {
931 tmp_unsigned = (uint32_t) *vl->val.integer;
932 tmp_signed = (int32_t) *vl->val.integer;
934 if (vl->type == ASN_INTEGER)
935 prefer_signed = 1;
937 DEBUG ("snmp plugin: Parsed int32 value is %"PRIu64".", tmp_unsigned);
938 }
939 else if (vl->type == ASN_COUNTER64)
940 {
941 tmp_unsigned = (uint32_t) vl->val.counter64->high;
942 tmp_unsigned = tmp_unsigned << 32;
943 tmp_unsigned += (uint32_t) vl->val.counter64->low;
944 tmp_signed = (int64_t) tmp_unsigned;
945 DEBUG ("snmp plugin: Parsed int64 value is %"PRIu64".", tmp_unsigned);
946 }
947 else if (vl->type == ASN_OCTET_STR)
948 {
949 /* We'll handle this later.. */
950 }
951 else
952 {
953 char oid_buffer[1024];
955 memset (oid_buffer, 0, sizeof (oid_buffer));
956 snprint_objid (oid_buffer, sizeof (oid_buffer) - 1,
957 vl->name, vl->name_length);
959 #ifdef ASN_NULL
960 if (vl->type == ASN_NULL)
961 INFO ("snmp plugin: OID \"%s\" is undefined (type ASN_NULL)",
962 oid_buffer);
963 else
964 #endif
965 WARNING ("snmp plugin: I don't know the ASN type #%i "
966 "(OID: \"%s\", data block \"%s\", host block \"%s\")",
967 (int) vl->type, oid_buffer,
968 (data_name != NULL) ? data_name : "UNKNOWN",
969 (host_name != NULL) ? host_name : "UNKNOWN");
971 defined = 0;
972 }
974 if (vl->type == ASN_OCTET_STR)
975 {
976 int status = -1;
978 if (vl->val.string != NULL)
979 {
980 char string[64];
981 size_t string_length;
983 string_length = sizeof (string) - 1;
984 if (vl->val_len < string_length)
985 string_length = vl->val_len;
987 /* The strings we get from the Net-SNMP library may not be null
988 * terminated. That is why we're using `memcpy' here and not `strcpy'.
989 * `string_length' is set to `vl->val_len' which holds the length of the
990 * string. -octo */
991 memcpy (string, vl->val.string, string_length);
992 string[string_length] = 0;
994 status = parse_value (string, &ret, type);
995 if (status != 0)
996 {
997 ERROR ("snmp plugin: host %s: csnmp_value_list_to_value: Parsing string as %s failed: %s",
998 (host_name != NULL) ? host_name : "UNKNOWN",
999 DS_TYPE_TO_STRING (type), string);
1000 }
1001 }
1003 if (status != 0)
1004 {
1005 switch (type)
1006 {
1007 case DS_TYPE_COUNTER:
1008 case DS_TYPE_DERIVE:
1009 case DS_TYPE_ABSOLUTE:
1010 memset (&ret, 0, sizeof (ret));
1011 break;
1013 case DS_TYPE_GAUGE:
1014 ret.gauge = NAN;
1015 break;
1017 default:
1018 ERROR ("snmp plugin: csnmp_value_list_to_value: Unknown "
1019 "data source type: %i.", type);
1020 ret.gauge = NAN;
1021 }
1022 }
1023 } /* if (vl->type == ASN_OCTET_STR) */
1024 else if (type == DS_TYPE_COUNTER)
1025 {
1026 ret.counter = tmp_unsigned;
1027 }
1028 else if (type == DS_TYPE_GAUGE)
1029 {
1030 if (!defined)
1031 ret.gauge = NAN;
1032 else if (prefer_signed)
1033 ret.gauge = (scale * tmp_signed) + shift;
1034 else
1035 ret.gauge = (scale * tmp_unsigned) + shift;
1036 }
1037 else if (type == DS_TYPE_DERIVE)
1038 {
1039 if (prefer_signed)
1040 ret.derive = (derive_t) tmp_signed;
1041 else
1042 ret.derive = (derive_t) tmp_unsigned;
1043 }
1044 else if (type == DS_TYPE_ABSOLUTE)
1045 {
1046 ret.absolute = (absolute_t) tmp_unsigned;
1047 }
1048 else
1049 {
1050 ERROR ("snmp plugin: csnmp_value_list_to_value: Unknown data source "
1051 "type: %i.", type);
1052 ret.gauge = NAN;
1053 }
1055 return (ret);
1056 } /* value_t csnmp_value_list_to_value */
1058 static int csnmp_strvbcopy_hexstring (char *dst, /* {{{ */
1059 const struct variable_list *vb, size_t dst_size)
1060 {
1061 char *buffer_ptr;
1062 size_t buffer_free;
1063 size_t i;
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]);
1075 if (status >= buffer_free)
1076 {
1077 buffer_ptr += (buffer_free - 1);
1078 *buffer_ptr = 0;
1079 return (dst_size + (buffer_free - status));
1080 }
1081 else /* if (status < buffer_free) */
1082 {
1083 buffer_ptr += status;
1084 buffer_free -= status;
1085 }
1086 }
1088 return ((int) (dst_size - buffer_free));
1089 } /* }}} int csnmp_strvbcopy_hexstring */
1091 static int csnmp_strvbcopy (char *dst, /* {{{ */
1092 const struct variable_list *vb, size_t dst_size)
1093 {
1094 char *src;
1095 size_t num_chars;
1096 size_t i;
1098 if (vb->type == ASN_OCTET_STR)
1099 src = (char *) vb->val.string;
1100 else if (vb->type == ASN_BIT_STR)
1101 src = (char *) vb->val.bitstring;
1102 else
1103 {
1104 dst[0] = 0;
1105 return (EINVAL);
1106 }
1108 num_chars = dst_size - 1;
1109 if (num_chars > vb->val_len)
1110 num_chars = vb->val_len;
1112 for (i = 0; i < num_chars; i++)
1113 {
1114 /* Check for control characters. */
1115 if ((unsigned char)src[i] < 32)
1116 return (csnmp_strvbcopy_hexstring (dst, vb, dst_size));
1117 dst[i] = src[i];
1118 }
1119 dst[num_chars] = 0;
1121 return ((int) vb->val_len);
1122 } /* }}} int csnmp_strvbcopy */
1124 static int csnmp_instance_list_add (csnmp_list_instances_t **head,
1125 csnmp_list_instances_t **tail,
1126 const struct snmp_pdu *res,
1127 const host_definition_t *hd, const data_definition_t *dd)
1128 {
1129 csnmp_list_instances_t *il;
1130 struct variable_list *vb;
1131 oid_t vb_name;
1132 int status;
1133 uint32_t i;
1134 uint32_t is_matched;
1136 /* Set vb on the last variable */
1137 for (vb = res->variables;
1138 (vb != NULL) && (vb->next_variable != NULL);
1139 vb = vb->next_variable)
1140 /* do nothing */;
1141 if (vb == NULL)
1142 return (-1);
1144 csnmp_oid_init (&vb_name, vb->name, vb->name_length);
1146 il = malloc (sizeof (*il));
1147 if (il == NULL)
1148 {
1149 ERROR ("snmp plugin: malloc failed.");
1150 return (-1);
1151 }
1152 memset (il, 0, sizeof (*il));
1153 il->next = NULL;
1155 status = csnmp_oid_suffix (&il->suffix, &vb_name, &dd->instance.oid);
1156 if (status != 0)
1157 {
1158 sfree (il);
1159 return (status);
1160 }
1162 /* Get instance name */
1163 if ((vb->type == ASN_OCTET_STR) || (vb->type == ASN_BIT_STR))
1164 {
1165 char *ptr;
1167 csnmp_strvbcopy (il->instance, vb, sizeof (il->instance));
1168 is_matched = 0;
1169 for (i = 0; i < dd->ignores_len; i++)
1170 {
1171 status = fnmatch(dd->ignores[i], il->instance, 0);
1172 if (status == 0)
1173 {
1174 if (dd->invert_match == 0)
1175 {
1176 sfree(il);
1177 return 0;
1178 }
1179 else
1180 {
1181 is_matched = 1;
1182 break;
1183 }
1184 }
1185 }
1186 if (dd->invert_match != 0 && is_matched == 0)
1187 {
1188 sfree(il);
1189 return 0;
1190 }
1191 for (ptr = il->instance; *ptr != '\0'; ptr++)
1192 {
1193 if ((*ptr > 0) && (*ptr < 32))
1194 *ptr = ' ';
1195 else if (*ptr == '/')
1196 *ptr = '_';
1197 }
1198 DEBUG ("snmp plugin: il->instance = `%s';", il->instance);
1199 }
1200 else
1201 {
1202 value_t val = csnmp_value_list_to_value (vb, DS_TYPE_COUNTER,
1203 /* scale = */ 1.0, /* shift = */ 0.0, hd->name, dd->name);
1204 ssnprintf (il->instance, sizeof (il->instance),
1205 "%llu", val.counter);
1206 }
1208 /* TODO: Debugging output */
1210 if (*head == NULL)
1211 *head = il;
1212 else
1213 (*tail)->next = il;
1214 *tail = il;
1216 return (0);
1217 } /* int csnmp_instance_list_add */
1219 static int csnmp_dispatch_table (host_definition_t *host, data_definition_t *data,
1220 csnmp_list_instances_t *instance_list,
1221 csnmp_table_values_t **value_table)
1222 {
1223 const data_set_t *ds;
1224 value_list_t vl = VALUE_LIST_INIT;
1226 csnmp_list_instances_t *instance_list_ptr;
1227 csnmp_table_values_t **value_table_ptr;
1229 int i;
1230 _Bool have_more;
1231 oid_t current_suffix;
1233 ds = plugin_get_ds (data->type);
1234 if (!ds)
1235 {
1236 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
1237 return (-1);
1238 }
1239 assert (ds->ds_num == data->values_len);
1240 assert (data->values_len > 0);
1242 instance_list_ptr = instance_list;
1244 value_table_ptr = calloc ((size_t) data->values_len, sizeof (*value_table_ptr));
1245 if (value_table_ptr == NULL)
1246 return (-1);
1247 for (i = 0; i < data->values_len; i++)
1248 value_table_ptr[i] = value_table[i];
1250 vl.values_len = data->values_len;
1251 vl.values = malloc (sizeof (*vl.values) * vl.values_len);
1252 if (vl.values == NULL)
1253 {
1254 ERROR ("snmp plugin: malloc failed.");
1255 sfree (value_table_ptr);
1256 return (-1);
1257 }
1259 sstrncpy (vl.host, host->name, sizeof (vl.host));
1260 sstrncpy (vl.plugin, "snmp", sizeof (vl.plugin));
1262 vl.interval = host->interval;
1264 have_more = 1;
1265 memset (¤t_suffix, 0, sizeof (current_suffix));
1266 while (have_more)
1267 {
1268 _Bool suffix_skipped = 0;
1270 /* Determine next suffix to handle. */
1271 if (instance_list != NULL)
1272 {
1273 if (instance_list_ptr == NULL)
1274 {
1275 have_more = 0;
1276 continue;
1277 }
1279 memcpy (¤t_suffix, &instance_list_ptr->suffix, sizeof (current_suffix));
1280 }
1281 else /* no instance configured */
1282 {
1283 csnmp_table_values_t *ptr = value_table_ptr[0];
1284 if (ptr == NULL)
1285 {
1286 have_more = 0;
1287 continue;
1288 }
1290 memcpy (¤t_suffix, &ptr->suffix, sizeof (current_suffix));
1291 }
1293 /* Update all the value_table_ptr to point at the entry with the same
1294 * trailing partial OID */
1295 for (i = 0; i < data->values_len; i++)
1296 {
1297 while ((value_table_ptr[i] != NULL)
1298 && (csnmp_oid_compare (&value_table_ptr[i]->suffix, ¤t_suffix) < 0))
1299 value_table_ptr[i] = value_table_ptr[i]->next;
1301 if (value_table_ptr[i] == NULL)
1302 {
1303 have_more = 0;
1304 break;
1305 }
1306 else if (csnmp_oid_compare (&value_table_ptr[i]->suffix, ¤t_suffix) > 0)
1307 {
1308 /* This suffix is missing in the subtree. Indicate this with the
1309 * "suffix_skipped" flag and try the next instance / suffix. */
1310 suffix_skipped = 1;
1311 break;
1312 }
1313 } /* for (i = 0; i < columns; i++) */
1315 if (!have_more)
1316 break;
1318 /* Matching the values failed. Start from the beginning again. */
1319 if (suffix_skipped)
1320 {
1321 if (instance_list != NULL)
1322 instance_list_ptr = instance_list_ptr->next;
1323 else
1324 value_table_ptr[0] = value_table_ptr[0]->next;
1326 continue;
1327 }
1329 /* if we reach this line, all value_table_ptr[i] are non-NULL and are set
1330 * to the same subid. instance_list_ptr is either NULL or points to the
1331 * same subid, too. */
1332 #if COLLECT_DEBUG
1333 for (i = 1; i < data->values_len; i++)
1334 {
1335 assert (value_table_ptr[i] != NULL);
1336 assert (csnmp_oid_compare (&value_table_ptr[i-1]->suffix,
1337 &value_table_ptr[i]->suffix) == 0);
1338 }
1339 assert ((instance_list_ptr == NULL)
1340 || (csnmp_oid_compare (&instance_list_ptr->suffix,
1341 &value_table_ptr[0]->suffix) == 0));
1342 #endif
1344 sstrncpy (vl.type, data->type, sizeof (vl.type));
1346 {
1347 char temp[DATA_MAX_NAME_LEN];
1349 if (instance_list_ptr == NULL)
1350 csnmp_oid_to_string (temp, sizeof (temp), ¤t_suffix);
1351 else
1352 sstrncpy (temp, instance_list_ptr->instance, sizeof (temp));
1354 if (data->instance_prefix == NULL)
1355 sstrncpy (vl.type_instance, temp, sizeof (vl.type_instance));
1356 else
1357 ssnprintf (vl.type_instance, sizeof (vl.type_instance), "%s%s",
1358 data->instance_prefix, temp);
1359 }
1361 for (i = 0; i < data->values_len; i++)
1362 vl.values[i] = value_table_ptr[i]->value;
1364 /* If we get here `vl.type_instance' and all `vl.values' have been set */
1365 plugin_dispatch_values (&vl);
1367 if (instance_list != NULL)
1368 instance_list_ptr = instance_list_ptr->next;
1369 else
1370 value_table_ptr[0] = value_table_ptr[0]->next;
1371 } /* while (have_more) */
1373 sfree (vl.values);
1374 sfree (value_table_ptr);
1376 return (0);
1377 } /* int csnmp_dispatch_table */
1379 static int csnmp_read_table (host_definition_t *host, data_definition_t *data)
1380 {
1381 struct snmp_pdu *req;
1382 struct snmp_pdu *res;
1383 struct variable_list *vb;
1385 const data_set_t *ds;
1387 uint32_t oid_list_len = (uint32_t) (data->values_len + 1);
1388 /* Holds the last OID returned by the device. We use this in the GETNEXT
1389 * request to proceed. */
1390 oid_t oid_list[oid_list_len];
1391 /* Set to false when an OID has left its subtree so we don't re-request it
1392 * again. */
1393 _Bool oid_list_todo[oid_list_len];
1395 int status;
1396 int i;
1397 uint32_t j;
1399 /* `value_list_head' and `value_list_tail' implement a linked list for each
1400 * value. `instance_list_head' and `instance_list_tail' implement a linked list of
1401 * instance names. This is used to jump gaps in the table. */
1402 csnmp_list_instances_t *instance_list_head;
1403 csnmp_list_instances_t *instance_list_tail;
1404 csnmp_table_values_t **value_list_head;
1405 csnmp_table_values_t **value_list_tail;
1407 DEBUG ("snmp plugin: csnmp_read_table (host = %s, data = %s)",
1408 host->name, data->name);
1410 if (host->sess_handle == NULL)
1411 {
1412 DEBUG ("snmp plugin: csnmp_read_table: host->sess_handle == NULL");
1413 return (-1);
1414 }
1416 ds = plugin_get_ds (data->type);
1417 if (!ds)
1418 {
1419 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
1420 return (-1);
1421 }
1423 if (ds->ds_num != data->values_len)
1424 {
1425 ERROR ("snmp plugin: DataSet `%s' requires %i values, but config talks about %i",
1426 data->type, ds->ds_num, data->values_len);
1427 return (-1);
1428 }
1429 assert (data->values_len > 0);
1431 /* We need a copy of all the OIDs, because GETNEXT will destroy them. */
1432 memcpy (oid_list, data->values, data->values_len * sizeof (oid_t));
1433 if (data->instance.oid.oid_len > 0)
1434 memcpy (oid_list + data->values_len, &data->instance.oid, sizeof (oid_t));
1435 else /* no InstanceFrom option specified. */
1436 oid_list_len--;
1438 for (j = 0; j < oid_list_len; j++)
1439 oid_list_todo[j] = 1;
1441 /* We're going to construct n linked lists, one for each "value".
1442 * value_list_head will contain pointers to the heads of these linked lists,
1443 * value_list_tail will contain pointers to the tail of the lists. */
1444 value_list_head = calloc (data->values_len, sizeof (*value_list_head));
1445 value_list_tail = calloc (data->values_len, sizeof (*value_list_tail));
1446 if ((value_list_head == NULL) || (value_list_tail == NULL))
1447 {
1448 ERROR ("snmp plugin: csnmp_read_table: calloc failed.");
1449 sfree (value_list_head);
1450 sfree (value_list_tail);
1451 return (-1);
1452 }
1454 instance_list_head = NULL;
1455 instance_list_tail = NULL;
1457 status = 0;
1458 while (status == 0)
1459 {
1460 int oid_list_todo_num;
1462 req = snmp_pdu_create (SNMP_MSG_GETNEXT);
1463 if (req == NULL)
1464 {
1465 ERROR ("snmp plugin: snmp_pdu_create failed.");
1466 status = -1;
1467 break;
1468 }
1470 oid_list_todo_num = 0;
1471 for (j = 0; j < oid_list_len; j++)
1472 {
1473 /* Do not rerequest already finished OIDs */
1474 if (!oid_list_todo[j])
1475 continue;
1476 oid_list_todo_num++;
1477 snmp_add_null_var (req, oid_list[j].oid, oid_list[j].oid_len);
1478 }
1480 if (oid_list_todo_num == 0)
1481 {
1482 /* The request is still empty - so we are finished */
1483 DEBUG ("snmp plugin: all variables have left their subtree");
1484 status = 0;
1485 break;
1486 }
1488 res = NULL;
1489 status = snmp_sess_synch_response (host->sess_handle, req, &res);
1490 if ((status != STAT_SUCCESS) || (res == NULL))
1491 {
1492 char *errstr = NULL;
1494 snmp_sess_error (host->sess_handle, NULL, NULL, &errstr);
1496 c_complain (LOG_ERR, &host->complaint,
1497 "snmp plugin: host %s: snmp_sess_synch_response failed: %s",
1498 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
1500 if (res != NULL)
1501 snmp_free_pdu (res);
1502 res = NULL;
1504 /* snmp_synch_response already freed our PDU */
1505 req = NULL;
1506 sfree (errstr);
1507 csnmp_host_close_session (host);
1509 status = -1;
1510 break;
1511 }
1513 status = 0;
1514 assert (res != NULL);
1515 c_release (LOG_INFO, &host->complaint,
1516 "snmp plugin: host %s: snmp_sess_synch_response successful.",
1517 host->name);
1519 vb = res->variables;
1520 if (vb == NULL)
1521 {
1522 status = -1;
1523 break;
1524 }
1526 for (vb = res->variables, i = 0; (vb != NULL); vb = vb->next_variable, i++)
1527 {
1528 /* Calculate value index from todo list */
1529 while ((i < oid_list_len) && !oid_list_todo[i])
1530 i++;
1532 /* An instance is configured and the res variable we process is the
1533 * instance value (last index) */
1534 if ((data->instance.oid.oid_len > 0) && (i == data->values_len))
1535 {
1536 if ((vb->type == SNMP_ENDOFMIBVIEW)
1537 || (snmp_oid_ncompare (data->instance.oid.oid,
1538 data->instance.oid.oid_len,
1539 vb->name, vb->name_length,
1540 data->instance.oid.oid_len) != 0))
1541 {
1542 DEBUG ("snmp plugin: host = %s; data = %s; Instance left its subtree.",
1543 host->name, data->name);
1544 oid_list_todo[i] = 0;
1545 continue;
1546 }
1548 /* Allocate a new `csnmp_list_instances_t', insert the instance name and
1549 * add it to the list */
1550 if (csnmp_instance_list_add (&instance_list_head, &instance_list_tail,
1551 res, host, data) != 0)
1552 {
1553 ERROR ("snmp plugin: host %s: csnmp_instance_list_add failed.",
1554 host->name);
1555 status = -1;
1556 break;
1557 }
1558 }
1559 else /* The variable we are processing is a normal value */
1560 {
1561 csnmp_table_values_t *vt;
1562 oid_t vb_name;
1563 oid_t suffix;
1564 int ret;
1566 csnmp_oid_init (&vb_name, vb->name, vb->name_length);
1568 /* Calculate the current suffix. This is later used to check that the
1569 * suffix is increasing. This also checks if we left the subtree */
1570 ret = csnmp_oid_suffix (&suffix, &vb_name, data->values + i);
1571 if (ret != 0)
1572 {
1573 DEBUG ("snmp plugin: host = %s; data = %s; i = %i; "
1574 "Value probably left its subtree.",
1575 host->name, data->name, i);
1576 oid_list_todo[i] = 0;
1577 continue;
1578 }
1580 /* Make sure the OIDs returned by the agent are increasing. Otherwise our
1581 * table matching algorithm will get confused. */
1582 if ((value_list_tail[i] != NULL)
1583 && (csnmp_oid_compare (&suffix, &value_list_tail[i]->suffix) <= 0))
1584 {
1585 DEBUG ("snmp plugin: host = %s; data = %s; i = %i; "
1586 "Suffix is not increasing.",
1587 host->name, data->name, i);
1588 oid_list_todo[i] = 0;
1589 continue;
1590 }
1592 vt = malloc (sizeof (*vt));
1593 if (vt == NULL)
1594 {
1595 ERROR ("snmp plugin: malloc failed.");
1596 status = -1;
1597 break;
1598 }
1599 memset (vt, 0, sizeof (*vt));
1601 vt->value = csnmp_value_list_to_value (vb, ds->ds[i].type,
1602 data->scale, data->shift, host->name, data->name);
1603 memcpy (&vt->suffix, &suffix, sizeof (vt->suffix));
1604 vt->next = NULL;
1606 if (value_list_tail[i] == NULL)
1607 value_list_head[i] = vt;
1608 else
1609 value_list_tail[i]->next = vt;
1610 value_list_tail[i] = vt;
1611 }
1613 /* Copy OID to oid_list[i] */
1614 memcpy (oid_list[i].oid, vb->name, sizeof (oid) * vb->name_length);
1615 oid_list[i].oid_len = vb->name_length;
1617 } /* for (vb = res->variables ...) */
1619 if (res != NULL)
1620 snmp_free_pdu (res);
1621 res = NULL;
1622 } /* while (status == 0) */
1624 if (res != NULL)
1625 snmp_free_pdu (res);
1626 res = NULL;
1628 if (req != NULL)
1629 snmp_free_pdu (req);
1630 req = NULL;
1632 if (status == 0)
1633 csnmp_dispatch_table (host, data, instance_list_head, value_list_head);
1635 /* Free all allocated variables here */
1636 while (instance_list_head != NULL)
1637 {
1638 csnmp_list_instances_t *next = instance_list_head->next;
1639 sfree (instance_list_head);
1640 instance_list_head = next;
1641 }
1643 for (i = 0; i < data->values_len; i++)
1644 {
1645 while (value_list_head[i] != NULL)
1646 {
1647 csnmp_table_values_t *next = value_list_head[i]->next;
1648 sfree (value_list_head[i]);
1649 value_list_head[i] = next;
1650 }
1651 }
1653 sfree (value_list_head);
1654 sfree (value_list_tail);
1656 return (0);
1657 } /* int csnmp_read_table */
1659 static int csnmp_read_value (host_definition_t *host, data_definition_t *data)
1660 {
1661 struct snmp_pdu *req;
1662 struct snmp_pdu *res;
1663 struct variable_list *vb;
1665 const data_set_t *ds;
1666 value_list_t vl = VALUE_LIST_INIT;
1668 int status;
1669 int i;
1671 DEBUG ("snmp plugin: csnmp_read_value (host = %s, data = %s)",
1672 host->name, data->name);
1674 if (host->sess_handle == NULL)
1675 {
1676 DEBUG ("snmp plugin: csnmp_read_value: host->sess_handle == NULL");
1677 return (-1);
1678 }
1680 ds = plugin_get_ds (data->type);
1681 if (!ds)
1682 {
1683 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
1684 return (-1);
1685 }
1687 if (ds->ds_num != data->values_len)
1688 {
1689 ERROR ("snmp plugin: DataSet `%s' requires %i values, but config talks about %i",
1690 data->type, ds->ds_num, data->values_len);
1691 return (-1);
1692 }
1694 vl.values_len = ds->ds_num;
1695 vl.values = (value_t *) malloc (sizeof (value_t) * vl.values_len);
1696 if (vl.values == NULL)
1697 return (-1);
1698 for (i = 0; i < vl.values_len; i++)
1699 {
1700 if (ds->ds[i].type == DS_TYPE_COUNTER)
1701 vl.values[i].counter = 0;
1702 else
1703 vl.values[i].gauge = NAN;
1704 }
1706 sstrncpy (vl.host, host->name, sizeof (vl.host));
1707 sstrncpy (vl.plugin, "snmp", sizeof (vl.plugin));
1708 sstrncpy (vl.type, data->type, sizeof (vl.type));
1709 sstrncpy (vl.type_instance, data->instance.string, sizeof (vl.type_instance));
1711 vl.interval = host->interval;
1713 req = snmp_pdu_create (SNMP_MSG_GET);
1714 if (req == NULL)
1715 {
1716 ERROR ("snmp plugin: snmp_pdu_create failed.");
1717 sfree (vl.values);
1718 return (-1);
1719 }
1721 for (i = 0; i < data->values_len; i++)
1722 snmp_add_null_var (req, data->values[i].oid, data->values[i].oid_len);
1724 res = NULL;
1725 status = snmp_sess_synch_response (host->sess_handle, req, &res);
1727 if ((status != STAT_SUCCESS) || (res == NULL))
1728 {
1729 char *errstr = NULL;
1731 snmp_sess_error (host->sess_handle, NULL, NULL, &errstr);
1732 ERROR ("snmp plugin: host %s: snmp_sess_synch_response failed: %s",
1733 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
1735 if (res != NULL)
1736 snmp_free_pdu (res);
1737 res = NULL;
1739 sfree (errstr);
1740 csnmp_host_close_session (host);
1742 return (-1);
1743 }
1746 for (vb = res->variables; vb != NULL; vb = vb->next_variable)
1747 {
1748 #if COLLECT_DEBUG
1749 char buffer[1024];
1750 snprint_variable (buffer, sizeof (buffer),
1751 vb->name, vb->name_length, vb);
1752 DEBUG ("snmp plugin: Got this variable: %s", buffer);
1753 #endif /* COLLECT_DEBUG */
1755 for (i = 0; i < data->values_len; i++)
1756 if (snmp_oid_compare (data->values[i].oid, data->values[i].oid_len,
1757 vb->name, vb->name_length) == 0)
1758 vl.values[i] = csnmp_value_list_to_value (vb, ds->ds[i].type,
1759 data->scale, data->shift, host->name, data->name);
1760 } /* for (res->variables) */
1762 if (res != NULL)
1763 snmp_free_pdu (res);
1764 res = NULL;
1766 DEBUG ("snmp plugin: -> plugin_dispatch_values (&vl);");
1767 plugin_dispatch_values (&vl);
1768 sfree (vl.values);
1770 return (0);
1771 } /* int csnmp_read_value */
1773 static int csnmp_read_host (user_data_t *ud)
1774 {
1775 host_definition_t *host;
1776 cdtime_t time_start;
1777 cdtime_t time_end;
1778 int status;
1779 int success;
1780 int i;
1782 host = ud->data;
1784 if (host->interval == 0)
1785 host->interval = plugin_get_interval ();
1787 time_start = cdtime ();
1789 if (host->sess_handle == NULL)
1790 csnmp_host_open_session (host);
1792 if (host->sess_handle == NULL)
1793 return (-1);
1795 success = 0;
1796 for (i = 0; i < host->data_list_len; i++)
1797 {
1798 data_definition_t *data = host->data_list[i];
1800 if (data->is_table)
1801 status = csnmp_read_table (host, data);
1802 else
1803 status = csnmp_read_value (host, data);
1805 if (status == 0)
1806 success++;
1807 }
1809 time_end = cdtime ();
1810 if ((time_end - time_start) > host->interval)
1811 {
1812 WARNING ("snmp plugin: Host `%s' should be queried every %.3f "
1813 "seconds, but reading all values takes %.3f seconds.",
1814 host->name,
1815 CDTIME_T_TO_DOUBLE (host->interval),
1816 CDTIME_T_TO_DOUBLE (time_end - time_start));
1817 }
1819 if (success == 0)
1820 return (-1);
1822 return (0);
1823 } /* int csnmp_read_host */
1825 static int csnmp_init (void)
1826 {
1827 call_snmp_init_once ();
1829 return (0);
1830 } /* int csnmp_init */
1832 static int csnmp_shutdown (void)
1833 {
1834 data_definition_t *data_this;
1835 data_definition_t *data_next;
1837 /* When we get here, the read threads have been stopped and all the
1838 * `host_definition_t' will be freed. */
1839 DEBUG ("snmp plugin: Destroying all data definitions.");
1841 data_this = data_head;
1842 data_head = NULL;
1843 while (data_this != NULL)
1844 {
1845 data_next = data_this->next;
1847 sfree (data_this->name);
1848 sfree (data_this->type);
1849 sfree (data_this->values);
1850 sfree (data_this->ignores);
1851 sfree (data_this);
1853 data_this = data_next;
1854 }
1856 return (0);
1857 } /* int csnmp_shutdown */
1859 void module_register (void)
1860 {
1861 plugin_register_complex_config ("snmp", csnmp_config);
1862 plugin_register_init ("snmp", csnmp_init);
1863 plugin_register_shutdown ("snmp", csnmp_shutdown);
1864 } /* void module_register */
1866 /*
1867 * vim: shiftwidth=2 softtabstop=2 tabstop=8 fdm=marker
1868 */