1 /**
2 * collectd - src/snmp.c
3 * Copyright (C) 2007 Florian octo Forster
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; only version 2 of the License is applicable.
8 *
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
17 *
18 * Authors:
19 * Florian octo Forster <octo at verplant.org>
20 **/
22 #include "collectd.h"
23 #include "common.h"
24 #include "plugin.h"
25 #include "utils_complain.h"
27 #include <pthread.h>
29 #include <net-snmp/net-snmp-config.h>
30 #include <net-snmp/net-snmp-includes.h>
32 /*
33 * Private data structes
34 */
35 struct oid_s
36 {
37 oid oid[MAX_OID_LEN];
38 size_t oid_len;
39 };
40 typedef struct oid_s oid_t;
42 union instance_u
43 {
44 char string[DATA_MAX_NAME_LEN];
45 oid_t oid;
46 };
47 typedef union instance_u instance_t;
49 struct data_definition_s
50 {
51 char *name; /* used to reference this from the `Collect' option */
52 char *type; /* used to find the data_set */
53 int is_table;
54 instance_t instance;
55 char *instance_prefix;
56 oid_t *values;
57 int values_len;
58 double scale;
59 double shift;
60 struct data_definition_s *next;
61 };
62 typedef struct data_definition_s data_definition_t;
64 struct host_definition_s
65 {
66 char *name;
67 char *address;
68 char *community;
69 int version;
70 void *sess_handle;
71 c_complain_t complaint;
72 uint32_t interval;
73 data_definition_t **data_list;
74 int data_list_len;
75 };
76 typedef struct host_definition_s host_definition_t;
78 /* These two types are used to cache values in `csnmp_read_table' to handle
79 * gaps in tables. */
80 struct csnmp_list_instances_s
81 {
82 oid subid;
83 char instance[DATA_MAX_NAME_LEN];
84 struct csnmp_list_instances_s *next;
85 };
86 typedef struct csnmp_list_instances_s csnmp_list_instances_t;
88 struct csnmp_table_values_s
89 {
90 oid subid;
91 value_t value;
92 struct csnmp_table_values_s *next;
93 };
94 typedef struct csnmp_table_values_s csnmp_table_values_t;
96 /*
97 * Private variables
98 */
99 static data_definition_t *data_head = NULL;
101 /*
102 * Prototypes
103 */
104 static int csnmp_read_host (user_data_t *ud);
106 /*
107 * Private functions
108 */
109 static void csnmp_host_close_session (host_definition_t *host) /* {{{ */
110 {
111 if (host->sess_handle == NULL)
112 return;
114 snmp_sess_close (host->sess_handle);
115 host->sess_handle = NULL;
116 } /* }}} void csnmp_host_close_session */
118 static void csnmp_host_definition_destroy (void *arg) /* {{{ */
119 {
120 host_definition_t *hd;
122 hd = arg;
124 if (hd == NULL)
125 return;
127 if (hd->name != NULL)
128 {
129 DEBUG ("snmp plugin: Destroying host definition for host `%s'.",
130 hd->name);
131 }
133 csnmp_host_close_session (hd);
135 sfree (hd->name);
136 sfree (hd->address);
137 sfree (hd->community);
138 sfree (hd->data_list);
140 sfree (hd);
141 } /* }}} void csnmp_host_definition_destroy */
143 /* Many functions to handle the configuration. {{{ */
144 /* First there are many functions which do configuration stuff. It's a big
145 * bloated and messy, I'm afraid. */
147 /*
148 * Callgraph for the config stuff:
149 * csnmp_config
150 * +-> call_snmp_init_once
151 * +-> csnmp_config_add_data
152 * ! +-> csnmp_config_add_data_type
153 * ! +-> csnmp_config_add_data_table
154 * ! +-> csnmp_config_add_data_instance
155 * ! +-> csnmp_config_add_data_instance_prefix
156 * ! +-> csnmp_config_add_data_values
157 * +-> csnmp_config_add_host
158 * +-> csnmp_config_add_host_address
159 * +-> csnmp_config_add_host_community
160 * +-> csnmp_config_add_host_version
161 * +-> csnmp_config_add_host_collect
162 * +-> csnmp_config_add_host_interval
163 */
164 static void call_snmp_init_once (void)
165 {
166 static int have_init = 0;
168 if (have_init == 0)
169 init_snmp (PACKAGE_NAME);
170 have_init = 1;
171 } /* void call_snmp_init_once */
173 static int csnmp_config_add_data_type (data_definition_t *dd, oconfig_item_t *ci)
174 {
175 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
176 {
177 WARNING ("snmp plugin: `Type' needs exactly one string argument.");
178 return (-1);
179 }
181 sfree (dd->type);
182 dd->type = strdup (ci->values[0].value.string);
183 if (dd->type == NULL)
184 return (-1);
186 return (0);
187 } /* int csnmp_config_add_data_type */
189 static int csnmp_config_add_data_table (data_definition_t *dd, oconfig_item_t *ci)
190 {
191 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_BOOLEAN))
192 {
193 WARNING ("snmp plugin: `Table' needs exactly one boolean argument.");
194 return (-1);
195 }
197 dd->is_table = ci->values[0].value.boolean ? 1 : 0;
199 return (0);
200 } /* int csnmp_config_add_data_table */
202 static int csnmp_config_add_data_instance (data_definition_t *dd, oconfig_item_t *ci)
203 {
204 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
205 {
206 WARNING ("snmp plugin: `Instance' needs exactly one string argument.");
207 return (-1);
208 }
210 if (dd->is_table)
211 {
212 /* Instance is an OID */
213 dd->instance.oid.oid_len = MAX_OID_LEN;
215 if (!read_objid (ci->values[0].value.string,
216 dd->instance.oid.oid, &dd->instance.oid.oid_len))
217 {
218 ERROR ("snmp plugin: read_objid (%s) failed.",
219 ci->values[0].value.string);
220 return (-1);
221 }
222 }
223 else
224 {
225 /* Instance is a simple string */
226 sstrncpy (dd->instance.string, ci->values[0].value.string,
227 sizeof (dd->instance.string));
228 }
230 return (0);
231 } /* int csnmp_config_add_data_instance */
233 static int csnmp_config_add_data_instance_prefix (data_definition_t *dd,
234 oconfig_item_t *ci)
235 {
236 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
237 {
238 WARNING ("snmp plugin: `InstancePrefix' needs exactly one string argument.");
239 return (-1);
240 }
242 if (!dd->is_table)
243 {
244 WARNING ("snmp plugin: data %s: InstancePrefix is ignored when `Table' "
245 "is set to `false'.", dd->name);
246 return (-1);
247 }
249 sfree (dd->instance_prefix);
250 dd->instance_prefix = strdup (ci->values[0].value.string);
251 if (dd->instance_prefix == NULL)
252 return (-1);
254 return (0);
255 } /* int csnmp_config_add_data_instance_prefix */
257 static int csnmp_config_add_data_values (data_definition_t *dd, oconfig_item_t *ci)
258 {
259 int i;
261 if (ci->values_num < 1)
262 {
263 WARNING ("snmp plugin: `Values' needs at least one argument.");
264 return (-1);
265 }
267 for (i = 0; i < ci->values_num; i++)
268 if (ci->values[i].type != OCONFIG_TYPE_STRING)
269 {
270 WARNING ("snmp plugin: `Values' needs only string argument.");
271 return (-1);
272 }
274 sfree (dd->values);
275 dd->values_len = 0;
276 dd->values = (oid_t *) malloc (sizeof (oid_t) * ci->values_num);
277 if (dd->values == NULL)
278 return (-1);
279 dd->values_len = ci->values_num;
281 for (i = 0; i < ci->values_num; i++)
282 {
283 dd->values[i].oid_len = MAX_OID_LEN;
285 if (NULL == snmp_parse_oid (ci->values[i].value.string,
286 dd->values[i].oid, &dd->values[i].oid_len))
287 {
288 ERROR ("snmp plugin: snmp_parse_oid (%s) failed.",
289 ci->values[i].value.string);
290 free (dd->values);
291 dd->values = NULL;
292 dd->values_len = 0;
293 return (-1);
294 }
295 }
297 return (0);
298 } /* int csnmp_config_add_data_instance */
300 static int csnmp_config_add_data_shift (data_definition_t *dd, oconfig_item_t *ci)
301 {
302 if ((ci->values_num != 1)
303 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
304 {
305 WARNING ("snmp plugin: The `Scale' config option needs exactly one number argument.");
306 return (-1);
307 }
309 dd->shift = ci->values[0].value.number;
311 return (0);
312 } /* int csnmp_config_add_data_shift */
314 static int csnmp_config_add_data_scale (data_definition_t *dd, oconfig_item_t *ci)
315 {
316 if ((ci->values_num != 1)
317 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
318 {
319 WARNING ("snmp plugin: The `Scale' config option needs exactly one number argument.");
320 return (-1);
321 }
323 dd->scale = ci->values[0].value.number;
325 return (0);
326 } /* int csnmp_config_add_data_scale */
328 static int csnmp_config_add_data (oconfig_item_t *ci)
329 {
330 data_definition_t *dd;
331 int status = 0;
332 int i;
334 if ((ci->values_num != 1)
335 || (ci->values[0].type != OCONFIG_TYPE_STRING))
336 {
337 WARNING ("snmp plugin: The `Data' config option needs exactly one string argument.");
338 return (-1);
339 }
341 dd = (data_definition_t *) malloc (sizeof (data_definition_t));
342 if (dd == NULL)
343 return (-1);
344 memset (dd, '\0', sizeof (data_definition_t));
346 dd->name = strdup (ci->values[0].value.string);
347 if (dd->name == NULL)
348 {
349 free (dd);
350 return (-1);
351 }
352 dd->scale = 1.0;
353 dd->shift = 0.0;
355 for (i = 0; i < ci->children_num; i++)
356 {
357 oconfig_item_t *option = ci->children + i;
358 status = 0;
360 if (strcasecmp ("Type", option->key) == 0)
361 status = csnmp_config_add_data_type (dd, option);
362 else if (strcasecmp ("Table", option->key) == 0)
363 status = csnmp_config_add_data_table (dd, option);
364 else if (strcasecmp ("Instance", option->key) == 0)
365 status = csnmp_config_add_data_instance (dd, option);
366 else if (strcasecmp ("InstancePrefix", option->key) == 0)
367 status = csnmp_config_add_data_instance_prefix (dd, option);
368 else if (strcasecmp ("Values", option->key) == 0)
369 status = csnmp_config_add_data_values (dd, option);
370 else if (strcasecmp ("Shift", option->key) == 0)
371 status = csnmp_config_add_data_shift (dd, option);
372 else if (strcasecmp ("Scale", option->key) == 0)
373 status = csnmp_config_add_data_scale (dd, option);
374 else
375 {
376 WARNING ("snmp plugin: Option `%s' not allowed here.", option->key);
377 status = -1;
378 }
380 if (status != 0)
381 break;
382 } /* for (ci->children) */
384 while (status == 0)
385 {
386 if (dd->type == NULL)
387 {
388 WARNING ("snmp plugin: `Type' not given for data `%s'", dd->name);
389 status = -1;
390 break;
391 }
392 if (dd->values == NULL)
393 {
394 WARNING ("snmp plugin: No `Value' given for data `%s'", dd->name);
395 status = -1;
396 break;
397 }
399 break;
400 } /* while (status == 0) */
402 if (status != 0)
403 {
404 sfree (dd->name);
405 sfree (dd->instance_prefix);
406 sfree (dd->values);
407 sfree (dd);
408 return (-1);
409 }
411 DEBUG ("snmp plugin: dd = { name = %s, type = %s, is_table = %s, values_len = %i }",
412 dd->name, dd->type, (dd->is_table != 0) ? "true" : "false", dd->values_len);
414 if (data_head == NULL)
415 data_head = dd;
416 else
417 {
418 data_definition_t *last;
419 last = data_head;
420 while (last->next != NULL)
421 last = last->next;
422 last->next = dd;
423 }
425 return (0);
426 } /* int csnmp_config_add_data */
428 static int csnmp_config_add_host_address (host_definition_t *hd, oconfig_item_t *ci)
429 {
430 if ((ci->values_num != 1)
431 || (ci->values[0].type != OCONFIG_TYPE_STRING))
432 {
433 WARNING ("snmp plugin: The `Address' config option needs exactly one string argument.");
434 return (-1);
435 }
437 if (hd->address == NULL)
438 free (hd->address);
440 hd->address = strdup (ci->values[0].value.string);
441 if (hd->address == NULL)
442 return (-1);
444 DEBUG ("snmp plugin: host = %s; host->address = %s;",
445 hd->name, hd->address);
447 return (0);
448 } /* int csnmp_config_add_host_address */
450 static int csnmp_config_add_host_community (host_definition_t *hd, oconfig_item_t *ci)
451 {
452 if ((ci->values_num != 1)
453 || (ci->values[0].type != OCONFIG_TYPE_STRING))
454 {
455 WARNING ("snmp plugin: The `Community' config option needs exactly one string argument.");
456 return (-1);
457 }
459 if (hd->community == NULL)
460 free (hd->community);
462 hd->community = strdup (ci->values[0].value.string);
463 if (hd->community == NULL)
464 return (-1);
466 DEBUG ("snmp plugin: host = %s; host->community = %s;",
467 hd->name, hd->community);
469 return (0);
470 } /* int csnmp_config_add_host_community */
472 static int csnmp_config_add_host_version (host_definition_t *hd, oconfig_item_t *ci)
473 {
474 int version;
476 if ((ci->values_num != 1)
477 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
478 {
479 WARNING ("snmp plugin: The `Version' config option needs exactly one number argument.");
480 return (-1);
481 }
483 version = (int) ci->values[0].value.number;
484 if ((version != 1) && (version != 2))
485 {
486 WARNING ("snmp plugin: `Version' must either be `1' or `2'.");
487 return (-1);
488 }
490 hd->version = version;
492 return (0);
493 } /* int csnmp_config_add_host_address */
495 static int csnmp_config_add_host_collect (host_definition_t *host,
496 oconfig_item_t *ci)
497 {
498 data_definition_t *data;
499 data_definition_t **data_list;
500 int data_list_len;
501 int i;
503 if (ci->values_num < 1)
504 {
505 WARNING ("snmp plugin: `Collect' needs at least one argument.");
506 return (-1);
507 }
509 for (i = 0; i < ci->values_num; i++)
510 if (ci->values[i].type != OCONFIG_TYPE_STRING)
511 {
512 WARNING ("snmp plugin: All arguments to `Collect' must be strings.");
513 return (-1);
514 }
516 data_list_len = host->data_list_len + ci->values_num;
517 data_list = (data_definition_t **) realloc (host->data_list,
518 sizeof (data_definition_t *) * data_list_len);
519 if (data_list == NULL)
520 return (-1);
521 host->data_list = data_list;
523 for (i = 0; i < ci->values_num; i++)
524 {
525 for (data = data_head; data != NULL; data = data->next)
526 if (strcasecmp (ci->values[i].value.string, data->name) == 0)
527 break;
529 if (data == NULL)
530 {
531 WARNING ("snmp plugin: No such data configured: `%s'",
532 ci->values[i].value.string);
533 continue;
534 }
536 DEBUG ("snmp plugin: Collect: host = %s, data[%i] = %s;",
537 host->name, host->data_list_len, data->name);
539 host->data_list[host->data_list_len] = data;
540 host->data_list_len++;
541 } /* for (values_num) */
543 return (0);
544 } /* int csnmp_config_add_host_collect */
546 static int csnmp_config_add_host_interval (host_definition_t *hd, oconfig_item_t *ci)
547 {
548 if ((ci->values_num != 1)
549 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
550 {
551 WARNING ("snmp plugin: The `Interval' config option needs exactly one number argument.");
552 return (-1);
553 }
555 hd->interval = ci->values[0].value.number >= 0
556 ? (uint32_t) ci->values[0].value.number
557 : 0;
559 return (0);
560 } /* int csnmp_config_add_host_interval */
562 static int csnmp_config_add_host (oconfig_item_t *ci)
563 {
564 host_definition_t *hd;
565 int status = 0;
566 int i;
568 /* Registration stuff. */
569 char cb_name[DATA_MAX_NAME_LEN];
570 user_data_t cb_data;
571 struct timespec cb_interval;
573 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
574 {
575 WARNING ("snmp plugin: `Host' needs exactly one string argument.");
576 return (-1);
577 }
579 hd = (host_definition_t *) malloc (sizeof (host_definition_t));
580 if (hd == NULL)
581 return (-1);
582 memset (hd, '\0', sizeof (host_definition_t));
583 hd->version = 2;
584 C_COMPLAIN_INIT (&hd->complaint);
586 hd->name = strdup (ci->values[0].value.string);
587 if (hd->name == NULL)
588 {
589 free (hd);
590 return (-1);
591 }
593 hd->sess_handle = NULL;
594 hd->interval = 0;
596 for (i = 0; i < ci->children_num; i++)
597 {
598 oconfig_item_t *option = ci->children + i;
599 status = 0;
601 if (strcasecmp ("Address", option->key) == 0)
602 status = csnmp_config_add_host_address (hd, option);
603 else if (strcasecmp ("Community", option->key) == 0)
604 status = csnmp_config_add_host_community (hd, option);
605 else if (strcasecmp ("Version", option->key) == 0)
606 status = csnmp_config_add_host_version (hd, option);
607 else if (strcasecmp ("Collect", option->key) == 0)
608 csnmp_config_add_host_collect (hd, option);
609 else if (strcasecmp ("Interval", option->key) == 0)
610 csnmp_config_add_host_interval (hd, option);
611 else
612 {
613 WARNING ("snmp plugin: csnmp_config_add_host: Option `%s' not allowed here.", option->key);
614 status = -1;
615 }
617 if (status != 0)
618 break;
619 } /* for (ci->children) */
621 while (status == 0)
622 {
623 if (hd->address == NULL)
624 {
625 WARNING ("snmp plugin: `Address' not given for host `%s'", hd->name);
626 status = -1;
627 break;
628 }
629 if (hd->community == NULL)
630 {
631 WARNING ("snmp plugin: `Community' not given for host `%s'", hd->name);
632 status = -1;
633 break;
634 }
636 break;
637 } /* while (status == 0) */
639 if (status != 0)
640 {
641 csnmp_host_definition_destroy (hd);
642 return (-1);
643 }
645 DEBUG ("snmp plugin: hd = { name = %s, address = %s, community = %s, version = %i }",
646 hd->name, hd->address, hd->community, hd->version);
648 ssnprintf (cb_name, sizeof (cb_name), "snmp-%s", hd->name);
650 memset (&cb_data, 0, sizeof (cb_data));
651 cb_data.data = hd;
652 cb_data.free_func = csnmp_host_definition_destroy;
654 memset (&cb_interval, 0, sizeof (cb_interval));
655 if (hd->interval != 0)
656 cb_interval.tv_sec = (time_t) hd->interval;
658 status = plugin_register_complex_read (cb_name, csnmp_read_host,
659 /* interval = */ &cb_interval, /* user_data = */ &cb_data);
660 if (status != 0)
661 {
662 ERROR ("snmp plugin: Registering complex read function failed.");
663 csnmp_host_definition_destroy (hd);
664 return (-1);
665 }
667 return (0);
668 } /* int csnmp_config_add_host */
670 static int csnmp_config (oconfig_item_t *ci)
671 {
672 int i;
674 call_snmp_init_once ();
676 for (i = 0; i < ci->children_num; i++)
677 {
678 oconfig_item_t *child = ci->children + i;
679 if (strcasecmp ("Data", child->key) == 0)
680 csnmp_config_add_data (child);
681 else if (strcasecmp ("Host", child->key) == 0)
682 csnmp_config_add_host (child);
683 else
684 {
685 WARNING ("snmp plugin: Ignoring unknown config option `%s'.", child->key);
686 }
687 } /* for (ci->children) */
689 return (0);
690 } /* int csnmp_config */
692 /* }}} End of the config stuff. Now the interesting part begins */
694 static void csnmp_host_open_session (host_definition_t *host)
695 {
696 struct snmp_session sess;
698 if (host->sess_handle != NULL)
699 csnmp_host_close_session (host);
701 snmp_sess_init (&sess);
702 sess.peername = host->address;
703 sess.community = (u_char *) host->community;
704 sess.community_len = strlen (host->community);
705 sess.version = (host->version == 1) ? SNMP_VERSION_1 : SNMP_VERSION_2c;
707 /* snmp_sess_open will copy the `struct snmp_session *'. */
708 host->sess_handle = snmp_sess_open (&sess);
710 if (host->sess_handle == NULL)
711 {
712 char *errstr = NULL;
714 snmp_error (&sess, NULL, NULL, &errstr);
716 ERROR ("snmp plugin: host %s: snmp_sess_open failed: %s",
717 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
718 sfree (errstr);
719 }
720 } /* void csnmp_host_open_session */
722 /* TODO: Check if negative values wrap around. Problem: negative temperatures. */
723 static value_t csnmp_value_list_to_value (struct variable_list *vl, int type,
724 double scale, double shift)
725 {
726 value_t ret;
727 uint64_t tmp_unsigned = 0;
728 int64_t tmp_signed = 0;
729 int defined = 1;
731 if ((vl->type == ASN_INTEGER)
732 || (vl->type == ASN_UINTEGER)
733 || (vl->type == ASN_COUNTER)
734 #ifdef ASN_TIMETICKS
735 || (vl->type == ASN_TIMETICKS)
736 #endif
737 || (vl->type == ASN_GAUGE))
738 {
739 tmp_unsigned = (uint32_t) *vl->val.integer;
740 tmp_signed = (int32_t) *vl->val.integer;
741 DEBUG ("snmp plugin: Parsed int32 value is %"PRIi64".", tmp_signed);
742 }
743 else if (vl->type == ASN_COUNTER64)
744 {
745 tmp_unsigned = (uint32_t) vl->val.counter64->high;
746 tmp_unsigned = tmp_unsigned << 32;
747 tmp_unsigned += (uint32_t) vl->val.counter64->low;
748 tmp_signed = (int64_t) tmp_unsigned;
749 DEBUG ("snmp plugin: Parsed int64 value is %"PRIu64".", tmp_unsigned);
750 }
751 else if (vl->type == ASN_OCTET_STR)
752 {
753 /* We'll handle this later.. */
754 }
755 else
756 {
757 WARNING ("snmp plugin: I don't know the ASN type `%i'", (int) vl->type);
758 defined = 0;
759 }
761 if (vl->type == ASN_OCTET_STR)
762 {
763 char *endptr;
765 endptr = NULL;
766 if (vl->val.string != NULL)
767 {
768 char string[64];
769 size_t string_length;
771 string_length = sizeof (string) - 1;
772 if (vl->val_len < string_length)
773 string_length = vl->val_len;
775 /* The strings we get from the Net-SNMP library may not be null
776 * terminated. That is why we're using `membpy' here and not `strcpy'.
777 * `string_length' is set to `vl->val_len' which holds the length of the
778 * string. -octo */
779 memcpy (string, vl->val.string, string_length);
780 string[string_length] = 0;
782 if (type == DS_TYPE_COUNTER)
783 {
784 ret.counter = (counter_t) strtoll (string, &endptr, /* base = */ 0);
785 DEBUG ("snmp plugin: csnmp_value_list_to_value: String to counter: %s -> %llu",
786 string, (unsigned long long) ret.counter);
787 }
788 else if (type == DS_TYPE_GAUGE)
789 {
790 ret.gauge = (gauge_t) strtod (string, &endptr);
791 DEBUG ("snmp plugin: csnmp_value_list_to_value: String to gauge: %s -> %g",
792 string, (double) ret.gauge);
793 }
794 }
796 /* Check if an error occurred */
797 if ((vl->val.string == NULL) || (endptr == (char *) vl->val.string))
798 {
799 if (type == DS_TYPE_COUNTER)
800 ret.counter = 0;
801 else if (type == DS_TYPE_GAUGE)
802 ret.gauge = NAN;
803 }
804 }
805 else if (type == DS_TYPE_COUNTER)
806 {
807 ret.counter = tmp_unsigned;
808 }
809 else if (type == DS_TYPE_GAUGE)
810 {
811 ret.gauge = NAN;
812 if (defined != 0)
813 ret.gauge = (scale * tmp_signed) + shift;
814 }
816 return (ret);
817 } /* value_t csnmp_value_list_to_value */
819 /* Returns true if all OIDs have left their subtree */
820 static int csnmp_check_res_left_subtree (const host_definition_t *host,
821 const data_definition_t *data,
822 struct snmp_pdu *res)
823 {
824 struct variable_list *vb;
825 int num_checked;
826 int num_left_subtree;
827 int i;
829 vb = res->variables;
830 if (vb == NULL)
831 return (-1);
833 num_checked = 0;
834 num_left_subtree = 0;
836 /* check all the variables and count how many have left their subtree */
837 for (vb = res->variables, i = 0;
838 (vb != NULL) && (i < data->values_len);
839 vb = vb->next_variable, i++)
840 {
841 num_checked++;
842 if (snmp_oid_ncompare (data->values[i].oid,
843 data->values[i].oid_len,
844 vb->name, vb->name_length,
845 data->values[i].oid_len) != 0)
846 num_left_subtree++;
847 }
849 /* check if enough variables have been returned */
850 if (i < data->values_len)
851 {
852 ERROR ("snmp plugin: host %s: Expected %i variables, but got only %i",
853 host->name, data->values_len, i);
854 return (-1);
855 }
857 if (data->instance.oid.oid_len > 0)
858 {
859 if (vb == NULL)
860 {
861 ERROR ("snmp plugin: host %s: Expected one more variable for "
862 "the instance..", host->name);
863 return (-1);
864 }
866 num_checked++;
867 if (snmp_oid_ncompare (data->instance.oid.oid,
868 data->instance.oid.oid_len,
869 vb->name, vb->name_length,
870 data->instance.oid.oid_len) != 0)
871 num_left_subtree++;
872 }
874 DEBUG ("snmp plugin: csnmp_check_res_left_subtree: %i of %i variables have "
875 "left their subtree",
876 num_left_subtree, num_checked);
877 if (num_left_subtree >= num_checked)
878 return (1);
879 return (0);
880 } /* int csnmp_check_res_left_subtree */
882 static int csnmp_instance_list_add (csnmp_list_instances_t **head,
883 csnmp_list_instances_t **tail,
884 const struct snmp_pdu *res)
885 {
886 csnmp_list_instances_t *il;
887 struct variable_list *vb;
889 /* Set vb on the last variable */
890 for (vb = res->variables;
891 (vb != NULL) && (vb->next_variable != NULL);
892 vb = vb->next_variable)
893 /* do nothing */;
894 if (vb == NULL)
895 return (-1);
897 il = (csnmp_list_instances_t *) malloc (sizeof (csnmp_list_instances_t));
898 if (il == NULL)
899 {
900 ERROR ("snmp plugin: malloc failed.");
901 return (-1);
902 }
903 il->subid = vb->name[vb->name_length - 1];
904 il->next = NULL;
906 /* Get instance name */
907 if ((vb->type == ASN_OCTET_STR) || (vb->type == ASN_BIT_STR))
908 {
909 char *ptr;
910 size_t instance_len;
912 memset (il->instance, 0, sizeof (il->instance));
913 instance_len = sizeof (il->instance) - 1;
914 if (instance_len > vb->val_len)
915 instance_len = vb->val_len;
917 sstrncpy (il->instance, (char *) ((vb->type == ASN_OCTET_STR)
918 ? vb->val.string
919 : vb->val.bitstring),
920 instance_len + 1);
922 for (ptr = il->instance; *ptr != '\0'; ptr++)
923 {
924 if ((*ptr > 0) && (*ptr < 32))
925 *ptr = ' ';
926 else if (*ptr == '/')
927 *ptr = '_';
928 }
929 DEBUG ("snmp plugin: il->instance = `%s';", il->instance);
930 }
931 else
932 {
933 value_t val = csnmp_value_list_to_value (vb, DS_TYPE_COUNTER, 1.0, 0.0);
934 ssnprintf (il->instance, sizeof (il->instance),
935 "%llu", val.counter);
936 }
938 /* TODO: Debugging output */
940 if (*head == NULL)
941 *head = il;
942 else
943 (*tail)->next = il;
944 *tail = il;
946 return (0);
947 } /* int csnmp_instance_list_add */
949 static int csnmp_dispatch_table (host_definition_t *host, data_definition_t *data,
950 csnmp_list_instances_t *instance_list,
951 csnmp_table_values_t **value_table)
952 {
953 const data_set_t *ds;
954 value_list_t vl = VALUE_LIST_INIT;
956 csnmp_list_instances_t *instance_list_ptr;
957 csnmp_table_values_t **value_table_ptr;
959 int i;
960 oid subid;
961 int have_more;
963 ds = plugin_get_ds (data->type);
964 if (!ds)
965 {
966 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
967 return (-1);
968 }
969 assert (ds->ds_num == data->values_len);
971 instance_list_ptr = instance_list;
973 value_table_ptr = (csnmp_table_values_t **) malloc (sizeof (csnmp_table_values_t *)
974 * data->values_len);
975 if (value_table_ptr == NULL)
976 return (-1);
977 for (i = 0; i < data->values_len; i++)
978 value_table_ptr[i] = value_table[i];
980 vl.values_len = ds->ds_num;
981 vl.values = (value_t *) malloc (sizeof (value_t) * vl.values_len);
982 if (vl.values == NULL)
983 {
984 ERROR ("snmp plugin: malloc failed.");
985 sfree (value_table_ptr);
986 return (-1);
987 }
989 sstrncpy (vl.host, host->name, sizeof (vl.host));
990 sstrncpy (vl.plugin, "snmp", sizeof (vl.plugin));
992 vl.interval = host->interval;
994 subid = 0;
995 have_more = 1;
997 while (have_more != 0)
998 {
999 if (instance_list != NULL)
1000 {
1001 while ((instance_list_ptr != NULL)
1002 && (instance_list_ptr->subid < subid))
1003 instance_list_ptr = instance_list_ptr->next;
1005 if (instance_list_ptr == NULL)
1006 {
1007 have_more = 0;
1008 continue;
1009 }
1010 else if (instance_list_ptr->subid > subid)
1011 {
1012 subid = instance_list_ptr->subid;
1013 continue;
1014 }
1015 } /* if (instance_list != NULL) */
1017 for (i = 0; i < data->values_len; i++)
1018 {
1019 while ((value_table_ptr[i] != NULL)
1020 && (value_table_ptr[i]->subid < subid))
1021 value_table_ptr[i] = value_table_ptr[i]->next;
1023 if (value_table_ptr[i] == NULL)
1024 {
1025 have_more = 0;
1026 break;
1027 }
1028 else if (value_table_ptr[i]->subid > subid)
1029 {
1030 subid = value_table_ptr[i]->subid;
1031 break;
1032 }
1033 } /* for (i = 0; i < columns; i++) */
1034 /* The subid has been increased - start scanning from the beginning
1035 * again.. */
1036 if (i < data->values_len)
1037 continue;
1039 /* if we reach this line, all value_table_ptr[i] are non-NULL and are set
1040 * to the same subid. instance_list_ptr is either NULL or points to the
1041 * same subid, too. */
1042 #if COLLECT_DEBUG
1043 for (i = 1; i < data->values_len; i++)
1044 {
1045 assert (value_table_ptr[i] != NULL);
1046 assert (value_table_ptr[i-1]->subid == value_table_ptr[i]->subid);
1047 }
1048 assert ((instance_list_ptr == NULL)
1049 || (instance_list_ptr->subid == value_table_ptr[0]->subid));
1050 #endif
1052 sstrncpy (vl.type, data->type, sizeof (vl.type));
1054 {
1055 char temp[DATA_MAX_NAME_LEN];
1057 if (instance_list_ptr == NULL)
1058 ssnprintf (temp, sizeof (temp), "%u", (uint32_t) subid);
1059 else
1060 sstrncpy (temp, instance_list_ptr->instance, sizeof (temp));
1062 if (data->instance_prefix == NULL)
1063 sstrncpy (vl.type_instance, temp, sizeof (vl.type_instance));
1064 else
1065 ssnprintf (vl.type_instance, sizeof (vl.type_instance), "%s%s",
1066 data->instance_prefix, temp);
1067 }
1069 for (i = 0; i < data->values_len; i++)
1070 vl.values[i] = value_table_ptr[i]->value;
1072 /* If we get here `vl.type_instance' and all `vl.values' have been set */
1073 plugin_dispatch_values (&vl);
1075 subid++;
1076 } /* while (have_more != 0) */
1078 sfree (vl.values);
1079 sfree (value_table_ptr);
1081 return (0);
1082 } /* int csnmp_dispatch_table */
1084 static int csnmp_read_table (host_definition_t *host, data_definition_t *data)
1085 {
1086 struct snmp_pdu *req;
1087 struct snmp_pdu *res;
1088 struct variable_list *vb;
1090 const data_set_t *ds;
1091 oid_t *oid_list;
1092 uint32_t oid_list_len;
1094 int status;
1095 int i;
1097 /* `value_table' and `value_table_ptr' implement a linked list for each
1098 * value. `instance_list' and `instance_list_ptr' implement a linked list of
1099 * instance names. This is used to jump gaps in the table. */
1100 csnmp_list_instances_t *instance_list;
1101 csnmp_list_instances_t *instance_list_ptr;
1102 csnmp_table_values_t **value_table;
1103 csnmp_table_values_t **value_table_ptr;
1105 DEBUG ("snmp plugin: csnmp_read_table (host = %s, data = %s)",
1106 host->name, data->name);
1108 if (host->sess_handle == NULL)
1109 {
1110 DEBUG ("snmp plugin: csnmp_read_table: host->sess_handle == NULL");
1111 return (-1);
1112 }
1114 ds = plugin_get_ds (data->type);
1115 if (!ds)
1116 {
1117 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
1118 return (-1);
1119 }
1121 if (ds->ds_num != data->values_len)
1122 {
1123 ERROR ("snmp plugin: DataSet `%s' requires %i values, but config talks about %i",
1124 data->type, ds->ds_num, data->values_len);
1125 return (-1);
1126 }
1128 /* We need a copy of all the OIDs, because GETNEXT will destroy them. */
1129 oid_list_len = data->values_len + 1;
1130 oid_list = (oid_t *) malloc (sizeof (oid_t) * (oid_list_len));
1131 if (oid_list == NULL)
1132 {
1133 ERROR ("snmp plugin: csnmp_read_table: malloc failed.");
1134 return (-1);
1135 }
1136 memcpy (oid_list, data->values, data->values_len * sizeof (oid_t));
1137 if (data->instance.oid.oid_len > 0)
1138 memcpy (oid_list + data->values_len, &data->instance.oid, sizeof (oid_t));
1139 else
1140 oid_list_len--;
1142 /* Allocate the `value_table' */
1143 value_table = (csnmp_table_values_t **) malloc (sizeof (csnmp_table_values_t *)
1144 * 2 * data->values_len);
1145 if (value_table == NULL)
1146 {
1147 ERROR ("snmp plugin: csnmp_read_table: malloc failed.");
1148 sfree (oid_list);
1149 return (-1);
1150 }
1151 memset (value_table, '\0', sizeof (csnmp_table_values_t *) * 2 * data->values_len);
1152 value_table_ptr = value_table + data->values_len;
1154 instance_list = NULL;
1155 instance_list_ptr = NULL;
1157 status = 0;
1158 while (status == 0)
1159 {
1160 req = snmp_pdu_create (SNMP_MSG_GETNEXT);
1161 if (req == NULL)
1162 {
1163 ERROR ("snmp plugin: snmp_pdu_create failed.");
1164 status = -1;
1165 break;
1166 }
1168 for (i = 0; (uint32_t) i < oid_list_len; i++)
1169 snmp_add_null_var (req, oid_list[i].oid, oid_list[i].oid_len);
1171 res = NULL;
1172 status = snmp_sess_synch_response (host->sess_handle, req, &res);
1174 if ((status != STAT_SUCCESS) || (res == NULL))
1175 {
1176 char *errstr = NULL;
1178 snmp_sess_error (host->sess_handle, NULL, NULL, &errstr);
1180 c_complain (LOG_ERR, &host->complaint,
1181 "snmp plugin: host %s: snmp_sess_synch_response failed: %s",
1182 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
1184 if (res != NULL)
1185 snmp_free_pdu (res);
1186 res = NULL;
1188 sfree (errstr);
1189 csnmp_host_close_session (host);
1191 status = -1;
1192 break;
1193 }
1194 status = 0;
1195 assert (res != NULL);
1196 c_release (LOG_INFO, &host->complaint,
1197 "snmp plugin: host %s: snmp_sess_synch_response successful.",
1198 host->name);
1200 vb = res->variables;
1201 if (vb == NULL)
1202 {
1203 status = -1;
1204 break;
1205 }
1207 /* Check if all values (and possibly the instance) have left their
1208 * subtree */
1209 if (csnmp_check_res_left_subtree (host, data, res) != 0)
1210 {
1211 status = 0;
1212 break;
1213 }
1215 /* if an instance-OID is configured.. */
1216 if (data->instance.oid.oid_len > 0)
1217 {
1218 /* Allocate a new `csnmp_list_instances_t', insert the instance name and
1219 * add it to the list */
1220 if (csnmp_instance_list_add (&instance_list, &instance_list_ptr,
1221 res) != 0)
1222 {
1223 ERROR ("snmp plugin: csnmp_instance_list_add failed.");
1224 status = -1;
1225 break;
1226 }
1228 /* Set vb on the last variable */
1229 for (vb = res->variables;
1230 (vb != NULL) && (vb->next_variable != NULL);
1231 vb = vb->next_variable)
1232 /* do nothing */;
1233 assert (vb != NULL);
1235 /* Copy OID to oid_list[data->values_len] */
1236 memcpy (oid_list[data->values_len].oid, vb->name,
1237 sizeof (oid) * vb->name_length);
1238 oid_list[data->values_len].oid_len = vb->name_length;
1239 }
1241 for (vb = res->variables, i = 0;
1242 (vb != NULL) && (i < data->values_len);
1243 vb = vb->next_variable, i++)
1244 {
1245 csnmp_table_values_t *vt;
1247 /* Check if we left the subtree */
1248 if (snmp_oid_ncompare (data->values[i].oid,
1249 data->values[i].oid_len,
1250 vb->name, vb->name_length,
1251 data->values[i].oid_len) != 0)
1252 {
1253 DEBUG ("snmp plugin: host = %s; data = %s; Value %i left its subtree.",
1254 host->name, data->name, i);
1255 continue;
1256 }
1258 if ((value_table_ptr[i] != NULL)
1259 && (vb->name[vb->name_length - 1] <= value_table_ptr[i]->subid))
1260 {
1261 DEBUG ("snmp plugin: host = %s; data = %s; i = %i; "
1262 "SUBID is not increasing.",
1263 host->name, data->name, i);
1264 continue;
1265 }
1267 vt = (csnmp_table_values_t *) malloc (sizeof (csnmp_table_values_t));
1268 if (vt == NULL)
1269 {
1270 ERROR ("snmp plugin: malloc failed.");
1271 status = -1;
1272 break;
1273 }
1275 vt->subid = vb->name[vb->name_length - 1];
1276 vt->value = csnmp_value_list_to_value (vb, ds->ds[i].type,
1277 data->scale, data->shift);
1278 vt->next = NULL;
1280 if (value_table_ptr[i] == NULL)
1281 value_table[i] = vt;
1282 else
1283 value_table_ptr[i]->next = vt;
1284 value_table_ptr[i] = vt;
1286 /* Copy OID to oid_list[i + 1] */
1287 memcpy (oid_list[i].oid, vb->name, sizeof (oid) * vb->name_length);
1288 oid_list[i].oid_len = vb->name_length;
1289 } /* for (i = data->values_len) */
1291 if (res != NULL)
1292 snmp_free_pdu (res);
1293 res = NULL;
1294 } /* while (status == 0) */
1296 if (res != NULL)
1297 snmp_free_pdu (res);
1298 res = NULL;
1300 if (status == 0)
1301 csnmp_dispatch_table (host, data, instance_list, value_table);
1303 /* Free all allocated variables here */
1304 while (instance_list != NULL)
1305 {
1306 instance_list_ptr = instance_list->next;
1307 sfree (instance_list);
1308 instance_list = instance_list_ptr;
1309 }
1311 for (i = 0; i < data->values_len; i++)
1312 {
1313 csnmp_table_values_t *tmp;
1314 while (value_table[i] != NULL)
1315 {
1316 tmp = value_table[i]->next;
1317 sfree (value_table[i]);
1318 value_table[i] = tmp;
1319 }
1320 }
1322 sfree (value_table);
1323 sfree (oid_list);
1325 return (0);
1326 } /* int csnmp_read_table */
1328 static int csnmp_read_value (host_definition_t *host, data_definition_t *data)
1329 {
1330 struct snmp_pdu *req;
1331 struct snmp_pdu *res;
1332 struct variable_list *vb;
1334 const data_set_t *ds;
1335 value_list_t vl = VALUE_LIST_INIT;
1337 int status;
1338 int i;
1340 DEBUG ("snmp plugin: csnmp_read_value (host = %s, data = %s)",
1341 host->name, data->name);
1343 if (host->sess_handle == NULL)
1344 {
1345 DEBUG ("snmp plugin: csnmp_read_table: host->sess_handle == NULL");
1346 return (-1);
1347 }
1349 ds = plugin_get_ds (data->type);
1350 if (!ds)
1351 {
1352 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
1353 return (-1);
1354 }
1356 if (ds->ds_num != data->values_len)
1357 {
1358 ERROR ("snmp plugin: DataSet `%s' requires %i values, but config talks about %i",
1359 data->type, ds->ds_num, data->values_len);
1360 return (-1);
1361 }
1363 vl.values_len = ds->ds_num;
1364 vl.values = (value_t *) malloc (sizeof (value_t) * vl.values_len);
1365 if (vl.values == NULL)
1366 return (-1);
1367 for (i = 0; i < vl.values_len; i++)
1368 {
1369 if (ds->ds[i].type == DS_TYPE_COUNTER)
1370 vl.values[i].counter = 0;
1371 else
1372 vl.values[i].gauge = NAN;
1373 }
1375 sstrncpy (vl.host, host->name, sizeof (vl.host));
1376 sstrncpy (vl.plugin, "snmp", sizeof (vl.plugin));
1377 sstrncpy (vl.type, data->type, sizeof (vl.type));
1378 sstrncpy (vl.type_instance, data->instance.string, sizeof (vl.type_instance));
1380 vl.interval = host->interval;
1382 req = snmp_pdu_create (SNMP_MSG_GET);
1383 if (req == NULL)
1384 {
1385 ERROR ("snmp plugin: snmp_pdu_create failed.");
1386 sfree (vl.values);
1387 return (-1);
1388 }
1390 for (i = 0; i < data->values_len; i++)
1391 snmp_add_null_var (req, data->values[i].oid, data->values[i].oid_len);
1393 res = NULL;
1394 status = snmp_sess_synch_response (host->sess_handle, req, &res);
1396 if ((status != STAT_SUCCESS) || (res == NULL))
1397 {
1398 char *errstr = NULL;
1400 snmp_sess_error (host->sess_handle, NULL, NULL, &errstr);
1401 ERROR ("snmp plugin: host %s: snmp_sess_synch_response failed: %s",
1402 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
1404 if (res != NULL)
1405 snmp_free_pdu (res);
1406 res = NULL;
1408 sfree (errstr);
1409 csnmp_host_close_session (host);
1411 return (-1);
1412 }
1415 for (vb = res->variables; vb != NULL; vb = vb->next_variable)
1416 {
1417 #if COLLECT_DEBUG
1418 char buffer[1024];
1419 snprint_variable (buffer, sizeof (buffer),
1420 vb->name, vb->name_length, vb);
1421 DEBUG ("snmp plugin: Got this variable: %s", buffer);
1422 #endif /* COLLECT_DEBUG */
1424 for (i = 0; i < data->values_len; i++)
1425 if (snmp_oid_compare (data->values[i].oid, data->values[i].oid_len,
1426 vb->name, vb->name_length) == 0)
1427 vl.values[i] = csnmp_value_list_to_value (vb, ds->ds[i].type,
1428 data->scale, data->shift);
1429 } /* for (res->variables) */
1431 if (res != NULL)
1432 snmp_free_pdu (res);
1433 res = NULL;
1435 DEBUG ("snmp plugin: -> plugin_dispatch_values (&vl);");
1436 plugin_dispatch_values (&vl);
1437 sfree (vl.values);
1439 return (0);
1440 } /* int csnmp_read_value */
1442 static int csnmp_read_host (user_data_t *ud)
1443 {
1444 host_definition_t *host;
1445 time_t time_start;
1446 time_t time_end;
1447 int status;
1448 int success;
1449 int i;
1451 host = ud->data;
1453 if (host->interval == 0)
1454 host->interval = interval_g;
1456 time_start = time (NULL);
1457 DEBUG ("snmp plugin: csnmp_read_host (%s) started at %u;", host->name,
1458 (unsigned int) time_start);
1460 if (host->sess_handle == NULL)
1461 csnmp_host_open_session (host);
1463 if (host->sess_handle == NULL)
1464 return (-1);
1466 success = 0;
1467 for (i = 0; i < host->data_list_len; i++)
1468 {
1469 data_definition_t *data = host->data_list[i];
1471 if (data->is_table)
1472 status = csnmp_read_table (host, data);
1473 else
1474 status = csnmp_read_value (host, data);
1476 if (status == 0)
1477 success++;
1478 }
1480 time_end = time (NULL);
1481 DEBUG ("snmp plugin: csnmp_read_host (%s) finished at %u;", host->name,
1482 (unsigned int) time_end);
1483 if ((uint32_t) (time_end - time_start) > host->interval)
1484 {
1485 WARNING ("snmp plugin: Host `%s' should be queried every %"PRIu32
1486 " seconds, but reading all values takes %u seconds.",
1487 host->name, host->interval, (unsigned int) (time_end - time_start));
1488 }
1490 if (success == 0)
1491 return (-1);
1493 return (0);
1494 } /* int csnmp_read_host */
1496 static int csnmp_init (void)
1497 {
1498 call_snmp_init_once ();
1500 return (0);
1501 } /* int csnmp_init */
1503 static int csnmp_shutdown (void)
1504 {
1505 data_definition_t *data_this;
1506 data_definition_t *data_next;
1508 /* When we get here, the read threads have been stopped and all the
1509 * `host_definition_t' will be freed. */
1510 DEBUG ("snmp plugin: Destroying all data definitions.");
1512 data_this = data_head;
1513 data_head = NULL;
1514 while (data_this != NULL)
1515 {
1516 data_next = data_this->next;
1518 sfree (data_this->name);
1519 sfree (data_this->type);
1520 sfree (data_this->values);
1521 sfree (data_this);
1523 data_this = data_next;
1524 }
1526 return (0);
1527 } /* int csnmp_shutdown */
1529 void module_register (void)
1530 {
1531 plugin_register_complex_config ("snmp", csnmp_config);
1532 plugin_register_init ("snmp", csnmp_init);
1533 plugin_register_shutdown ("snmp", csnmp_shutdown);
1534 } /* void module_register */
1536 /*
1537 * vim: shiftwidth=2 softtabstop=2 tabstop=8 fdm=marker
1538 */