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 temp = 0;
728 int defined = 1;
730 if ((vl->type == ASN_INTEGER)
731 || (vl->type == ASN_UINTEGER)
732 || (vl->type == ASN_COUNTER)
733 #ifdef ASN_TIMETICKS
734 || (vl->type == ASN_TIMETICKS)
735 #endif
736 || (vl->type == ASN_GAUGE))
737 {
738 temp = (uint32_t) *vl->val.integer;
739 DEBUG ("snmp plugin: Parsed int32 value is %"PRIu64".", temp);
740 }
741 else if (vl->type == ASN_COUNTER64)
742 {
743 temp = (uint32_t) vl->val.counter64->high;
744 temp = temp << 32;
745 temp += (uint32_t) vl->val.counter64->low;
746 DEBUG ("snmp plugin: Parsed int64 value is %"PRIu64".", temp);
747 }
748 else if (vl->type == ASN_OCTET_STR)
749 {
750 /* We'll handle this later.. */
751 }
752 else
753 {
754 WARNING ("snmp plugin: I don't know the ASN type `%i'", (int) vl->type);
755 defined = 0;
756 }
758 if (vl->type == ASN_OCTET_STR)
759 {
760 int status = -1;
762 if (vl->val.string != NULL)
763 {
764 char string[64];
765 size_t string_length;
767 string_length = sizeof (string) - 1;
768 if (vl->val_len < string_length)
769 string_length = vl->val_len;
771 /* The strings we get from the Net-SNMP library may not be null
772 * terminated. That is why we're using `memcpy' here and not `strcpy'.
773 * `string_length' is set to `vl->val_len' which holds the length of the
774 * string. -octo */
775 memcpy (string, vl->val.string, string_length);
776 string[string_length] = 0;
778 status = parse_value (string, &ret, type);
779 if (status != 0)
780 {
781 ERROR ("snmp plugin: csnmp_value_list_to_value: Parsing string as %s failed: %s",
782 DS_TYPE_TO_STRING (type), string);
783 }
784 }
786 if (status != 0)
787 {
788 switch (type)
789 {
790 case DS_TYPE_COUNTER:
791 case DS_TYPE_DERIVE:
792 case DS_TYPE_ABSOLUTE:
793 memset (&ret, 0, sizeof (ret));
794 break;
796 case DS_TYPE_GAUGE:
797 ret.gauge = NAN;
798 break;
800 default:
801 ERROR ("snmp plugin: csnmp_value_list_to_value: Unknown "
802 "data source type: %i.", type);
803 ret.gauge = NAN;
804 }
805 }
806 } /* if (vl->type == ASN_OCTET_STR) */
807 else if (type == DS_TYPE_COUNTER)
808 ret.counter = temp;
809 else if (type == DS_TYPE_GAUGE)
810 {
811 ret.gauge = NAN;
812 if (defined != 0)
813 ret.gauge = (scale * temp) + shift;
814 }
815 else if (type == DS_TYPE_DERIVE)
816 ret.derive = (derive_t) temp;
817 else if (type == DS_TYPE_ABSOLUTE)
818 ret.absolute = (absolute_t) temp;
819 else
820 {
821 ERROR ("snmp plugin: csnmp_value_list_to_value: Unknown data source "
822 "type: %i.", type);
823 ret.gauge = NAN;
824 }
826 return (ret);
827 } /* value_t csnmp_value_list_to_value */
829 /* Returns true if all OIDs have left their subtree */
830 static int csnmp_check_res_left_subtree (const host_definition_t *host,
831 const data_definition_t *data,
832 struct snmp_pdu *res)
833 {
834 struct variable_list *vb;
835 int num_checked;
836 int num_left_subtree;
837 int i;
839 vb = res->variables;
840 if (vb == NULL)
841 return (-1);
843 num_checked = 0;
844 num_left_subtree = 0;
846 /* check all the variables and count how many have left their subtree */
847 for (vb = res->variables, i = 0;
848 (vb != NULL) && (i < data->values_len);
849 vb = vb->next_variable, i++)
850 {
851 num_checked++;
852 if (snmp_oid_ncompare (data->values[i].oid,
853 data->values[i].oid_len,
854 vb->name, vb->name_length,
855 data->values[i].oid_len) != 0)
856 num_left_subtree++;
857 }
859 /* check if enough variables have been returned */
860 if (i < data->values_len)
861 {
862 ERROR ("snmp plugin: host %s: Expected %i variables, but got only %i",
863 host->name, data->values_len, i);
864 return (-1);
865 }
867 if (data->instance.oid.oid_len > 0)
868 {
869 if (vb == NULL)
870 {
871 ERROR ("snmp plugin: host %s: Expected one more variable for "
872 "the instance..", host->name);
873 return (-1);
874 }
876 num_checked++;
877 if (snmp_oid_ncompare (data->instance.oid.oid,
878 data->instance.oid.oid_len,
879 vb->name, vb->name_length,
880 data->instance.oid.oid_len) != 0)
881 num_left_subtree++;
882 }
884 DEBUG ("snmp plugin: csnmp_check_res_left_subtree: %i of %i variables have "
885 "left their subtree",
886 num_left_subtree, num_checked);
887 if (num_left_subtree >= num_checked)
888 return (1);
889 return (0);
890 } /* int csnmp_check_res_left_subtree */
892 static int csnmp_instance_list_add (csnmp_list_instances_t **head,
893 csnmp_list_instances_t **tail,
894 const struct snmp_pdu *res)
895 {
896 csnmp_list_instances_t *il;
897 struct variable_list *vb;
899 /* Set vb on the last variable */
900 for (vb = res->variables;
901 (vb != NULL) && (vb->next_variable != NULL);
902 vb = vb->next_variable)
903 /* do nothing */;
904 if (vb == NULL)
905 return (-1);
907 il = (csnmp_list_instances_t *) malloc (sizeof (csnmp_list_instances_t));
908 if (il == NULL)
909 {
910 ERROR ("snmp plugin: malloc failed.");
911 return (-1);
912 }
913 il->subid = vb->name[vb->name_length - 1];
914 il->next = NULL;
916 /* Get instance name */
917 if ((vb->type == ASN_OCTET_STR) || (vb->type == ASN_BIT_STR))
918 {
919 char *ptr;
920 size_t instance_len;
922 memset (il->instance, 0, sizeof (il->instance));
923 instance_len = sizeof (il->instance) - 1;
924 if (instance_len > vb->val_len)
925 instance_len = vb->val_len;
927 sstrncpy (il->instance, (char *) ((vb->type == ASN_OCTET_STR)
928 ? vb->val.string
929 : vb->val.bitstring),
930 instance_len + 1);
932 for (ptr = il->instance; *ptr != '\0'; ptr++)
933 {
934 if ((*ptr > 0) && (*ptr < 32))
935 *ptr = ' ';
936 else if (*ptr == '/')
937 *ptr = '_';
938 }
939 DEBUG ("snmp plugin: il->instance = `%s';", il->instance);
940 }
941 else
942 {
943 value_t val = csnmp_value_list_to_value (vb, DS_TYPE_COUNTER, 1.0, 0.0);
944 ssnprintf (il->instance, sizeof (il->instance),
945 "%llu", val.counter);
946 }
948 /* TODO: Debugging output */
950 if (*head == NULL)
951 *head = il;
952 else
953 (*tail)->next = il;
954 *tail = il;
956 return (0);
957 } /* int csnmp_instance_list_add */
959 static int csnmp_dispatch_table (host_definition_t *host, data_definition_t *data,
960 csnmp_list_instances_t *instance_list,
961 csnmp_table_values_t **value_table)
962 {
963 const data_set_t *ds;
964 value_list_t vl = VALUE_LIST_INIT;
966 csnmp_list_instances_t *instance_list_ptr;
967 csnmp_table_values_t **value_table_ptr;
969 int i;
970 oid subid;
971 int have_more;
973 ds = plugin_get_ds (data->type);
974 if (!ds)
975 {
976 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
977 return (-1);
978 }
979 assert (ds->ds_num == data->values_len);
981 instance_list_ptr = instance_list;
983 value_table_ptr = (csnmp_table_values_t **) malloc (sizeof (csnmp_table_values_t *)
984 * data->values_len);
985 if (value_table_ptr == NULL)
986 return (-1);
987 for (i = 0; i < data->values_len; i++)
988 value_table_ptr[i] = value_table[i];
990 vl.values_len = ds->ds_num;
991 vl.values = (value_t *) malloc (sizeof (value_t) * vl.values_len);
992 if (vl.values == NULL)
993 {
994 ERROR ("snmp plugin: malloc failed.");
995 sfree (value_table_ptr);
996 return (-1);
997 }
999 sstrncpy (vl.host, host->name, sizeof (vl.host));
1000 sstrncpy (vl.plugin, "snmp", sizeof (vl.plugin));
1002 vl.interval = host->interval;
1004 subid = 0;
1005 have_more = 1;
1007 while (have_more != 0)
1008 {
1009 if (instance_list != NULL)
1010 {
1011 while ((instance_list_ptr != NULL)
1012 && (instance_list_ptr->subid < subid))
1013 instance_list_ptr = instance_list_ptr->next;
1015 if (instance_list_ptr == NULL)
1016 {
1017 have_more = 0;
1018 continue;
1019 }
1020 else if (instance_list_ptr->subid > subid)
1021 {
1022 subid = instance_list_ptr->subid;
1023 continue;
1024 }
1025 } /* if (instance_list != NULL) */
1027 for (i = 0; i < data->values_len; i++)
1028 {
1029 while ((value_table_ptr[i] != NULL)
1030 && (value_table_ptr[i]->subid < subid))
1031 value_table_ptr[i] = value_table_ptr[i]->next;
1033 if (value_table_ptr[i] == NULL)
1034 {
1035 have_more = 0;
1036 break;
1037 }
1038 else if (value_table_ptr[i]->subid > subid)
1039 {
1040 subid = value_table_ptr[i]->subid;
1041 break;
1042 }
1043 } /* for (i = 0; i < columns; i++) */
1044 /* The subid has been increased - start scanning from the beginning
1045 * again.. */
1046 if (i < data->values_len)
1047 continue;
1049 /* if we reach this line, all value_table_ptr[i] are non-NULL and are set
1050 * to the same subid. instance_list_ptr is either NULL or points to the
1051 * same subid, too. */
1052 #if COLLECT_DEBUG
1053 for (i = 1; i < data->values_len; i++)
1054 {
1055 assert (value_table_ptr[i] != NULL);
1056 assert (value_table_ptr[i-1]->subid == value_table_ptr[i]->subid);
1057 }
1058 assert ((instance_list_ptr == NULL)
1059 || (instance_list_ptr->subid == value_table_ptr[0]->subid));
1060 #endif
1062 sstrncpy (vl.type, data->type, sizeof (vl.type));
1064 {
1065 char temp[DATA_MAX_NAME_LEN];
1067 if (instance_list_ptr == NULL)
1068 ssnprintf (temp, sizeof (temp), "%u", (uint32_t) subid);
1069 else
1070 sstrncpy (temp, instance_list_ptr->instance, sizeof (temp));
1072 if (data->instance_prefix == NULL)
1073 sstrncpy (vl.type_instance, temp, sizeof (vl.type_instance));
1074 else
1075 ssnprintf (vl.type_instance, sizeof (vl.type_instance), "%s%s",
1076 data->instance_prefix, temp);
1077 }
1079 for (i = 0; i < data->values_len; i++)
1080 vl.values[i] = value_table_ptr[i]->value;
1082 /* If we get here `vl.type_instance' and all `vl.values' have been set */
1083 plugin_dispatch_values (&vl);
1085 subid++;
1086 } /* while (have_more != 0) */
1088 sfree (vl.values);
1089 sfree (value_table_ptr);
1091 return (0);
1092 } /* int csnmp_dispatch_table */
1094 static int csnmp_read_table (host_definition_t *host, data_definition_t *data)
1095 {
1096 struct snmp_pdu *req;
1097 struct snmp_pdu *res;
1098 struct variable_list *vb;
1100 const data_set_t *ds;
1101 oid_t *oid_list;
1102 uint32_t oid_list_len;
1104 int status;
1105 int i;
1107 /* `value_table' and `value_table_ptr' implement a linked list for each
1108 * value. `instance_list' and `instance_list_ptr' implement a linked list of
1109 * instance names. This is used to jump gaps in the table. */
1110 csnmp_list_instances_t *instance_list;
1111 csnmp_list_instances_t *instance_list_ptr;
1112 csnmp_table_values_t **value_table;
1113 csnmp_table_values_t **value_table_ptr;
1115 DEBUG ("snmp plugin: csnmp_read_table (host = %s, data = %s)",
1116 host->name, data->name);
1118 if (host->sess_handle == NULL)
1119 {
1120 DEBUG ("snmp plugin: csnmp_read_table: host->sess_handle == NULL");
1121 return (-1);
1122 }
1124 ds = plugin_get_ds (data->type);
1125 if (!ds)
1126 {
1127 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
1128 return (-1);
1129 }
1131 if (ds->ds_num != data->values_len)
1132 {
1133 ERROR ("snmp plugin: DataSet `%s' requires %i values, but config talks about %i",
1134 data->type, ds->ds_num, data->values_len);
1135 return (-1);
1136 }
1138 /* We need a copy of all the OIDs, because GETNEXT will destroy them. */
1139 oid_list_len = data->values_len + 1;
1140 oid_list = (oid_t *) malloc (sizeof (oid_t) * (oid_list_len));
1141 if (oid_list == NULL)
1142 {
1143 ERROR ("snmp plugin: csnmp_read_table: malloc failed.");
1144 return (-1);
1145 }
1146 memcpy (oid_list, data->values, data->values_len * sizeof (oid_t));
1147 if (data->instance.oid.oid_len > 0)
1148 memcpy (oid_list + data->values_len, &data->instance.oid, sizeof (oid_t));
1149 else
1150 oid_list_len--;
1152 /* Allocate the `value_table' */
1153 value_table = (csnmp_table_values_t **) malloc (sizeof (csnmp_table_values_t *)
1154 * 2 * data->values_len);
1155 if (value_table == NULL)
1156 {
1157 ERROR ("snmp plugin: csnmp_read_table: malloc failed.");
1158 sfree (oid_list);
1159 return (-1);
1160 }
1161 memset (value_table, '\0', sizeof (csnmp_table_values_t *) * 2 * data->values_len);
1162 value_table_ptr = value_table + data->values_len;
1164 instance_list = NULL;
1165 instance_list_ptr = NULL;
1167 status = 0;
1168 while (status == 0)
1169 {
1170 req = snmp_pdu_create (SNMP_MSG_GETNEXT);
1171 if (req == NULL)
1172 {
1173 ERROR ("snmp plugin: snmp_pdu_create failed.");
1174 status = -1;
1175 break;
1176 }
1178 for (i = 0; (uint32_t) i < oid_list_len; i++)
1179 snmp_add_null_var (req, oid_list[i].oid, oid_list[i].oid_len);
1181 res = NULL;
1182 status = snmp_sess_synch_response (host->sess_handle, req, &res);
1184 if ((status != STAT_SUCCESS) || (res == NULL))
1185 {
1186 char *errstr = NULL;
1188 snmp_sess_error (host->sess_handle, NULL, NULL, &errstr);
1190 c_complain (LOG_ERR, &host->complaint,
1191 "snmp plugin: host %s: snmp_sess_synch_response failed: %s",
1192 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
1194 if (res != NULL)
1195 snmp_free_pdu (res);
1196 res = NULL;
1198 sfree (errstr);
1199 csnmp_host_close_session (host);
1201 status = -1;
1202 break;
1203 }
1204 status = 0;
1205 assert (res != NULL);
1206 c_release (LOG_INFO, &host->complaint,
1207 "snmp plugin: host %s: snmp_sess_synch_response successful.",
1208 host->name);
1210 vb = res->variables;
1211 if (vb == NULL)
1212 {
1213 status = -1;
1214 break;
1215 }
1217 /* Check if all values (and possibly the instance) have left their
1218 * subtree */
1219 if (csnmp_check_res_left_subtree (host, data, res) != 0)
1220 {
1221 status = 0;
1222 break;
1223 }
1225 /* if an instance-OID is configured.. */
1226 if (data->instance.oid.oid_len > 0)
1227 {
1228 /* Allocate a new `csnmp_list_instances_t', insert the instance name and
1229 * add it to the list */
1230 if (csnmp_instance_list_add (&instance_list, &instance_list_ptr,
1231 res) != 0)
1232 {
1233 ERROR ("snmp plugin: csnmp_instance_list_add failed.");
1234 status = -1;
1235 break;
1236 }
1238 /* Set vb on the last variable */
1239 for (vb = res->variables;
1240 (vb != NULL) && (vb->next_variable != NULL);
1241 vb = vb->next_variable)
1242 /* do nothing */;
1243 assert (vb != NULL);
1245 /* Copy OID to oid_list[data->values_len] */
1246 memcpy (oid_list[data->values_len].oid, vb->name,
1247 sizeof (oid) * vb->name_length);
1248 oid_list[data->values_len].oid_len = vb->name_length;
1249 }
1251 for (vb = res->variables, i = 0;
1252 (vb != NULL) && (i < data->values_len);
1253 vb = vb->next_variable, i++)
1254 {
1255 csnmp_table_values_t *vt;
1257 /* Check if we left the subtree */
1258 if (snmp_oid_ncompare (data->values[i].oid,
1259 data->values[i].oid_len,
1260 vb->name, vb->name_length,
1261 data->values[i].oid_len) != 0)
1262 {
1263 DEBUG ("snmp plugin: host = %s; data = %s; Value %i left its subtree.",
1264 host->name, data->name, i);
1265 continue;
1266 }
1268 if ((value_table_ptr[i] != NULL)
1269 && (vb->name[vb->name_length - 1] <= value_table_ptr[i]->subid))
1270 {
1271 DEBUG ("snmp plugin: host = %s; data = %s; i = %i; "
1272 "SUBID is not increasing.",
1273 host->name, data->name, i);
1274 continue;
1275 }
1277 vt = (csnmp_table_values_t *) malloc (sizeof (csnmp_table_values_t));
1278 if (vt == NULL)
1279 {
1280 ERROR ("snmp plugin: malloc failed.");
1281 status = -1;
1282 break;
1283 }
1285 vt->subid = vb->name[vb->name_length - 1];
1286 vt->value = csnmp_value_list_to_value (vb, ds->ds[i].type,
1287 data->scale, data->shift);
1288 vt->next = NULL;
1290 if (value_table_ptr[i] == NULL)
1291 value_table[i] = vt;
1292 else
1293 value_table_ptr[i]->next = vt;
1294 value_table_ptr[i] = vt;
1296 /* Copy OID to oid_list[i + 1] */
1297 memcpy (oid_list[i].oid, vb->name, sizeof (oid) * vb->name_length);
1298 oid_list[i].oid_len = vb->name_length;
1299 } /* for (i = data->values_len) */
1301 if (res != NULL)
1302 snmp_free_pdu (res);
1303 res = NULL;
1304 } /* while (status == 0) */
1306 if (res != NULL)
1307 snmp_free_pdu (res);
1308 res = NULL;
1310 if (status == 0)
1311 csnmp_dispatch_table (host, data, instance_list, value_table);
1313 /* Free all allocated variables here */
1314 while (instance_list != NULL)
1315 {
1316 instance_list_ptr = instance_list->next;
1317 sfree (instance_list);
1318 instance_list = instance_list_ptr;
1319 }
1321 for (i = 0; i < data->values_len; i++)
1322 {
1323 csnmp_table_values_t *tmp;
1324 while (value_table[i] != NULL)
1325 {
1326 tmp = value_table[i]->next;
1327 sfree (value_table[i]);
1328 value_table[i] = tmp;
1329 }
1330 }
1332 sfree (value_table);
1333 sfree (oid_list);
1335 return (0);
1336 } /* int csnmp_read_table */
1338 static int csnmp_read_value (host_definition_t *host, data_definition_t *data)
1339 {
1340 struct snmp_pdu *req;
1341 struct snmp_pdu *res;
1342 struct variable_list *vb;
1344 const data_set_t *ds;
1345 value_list_t vl = VALUE_LIST_INIT;
1347 int status;
1348 int i;
1350 DEBUG ("snmp plugin: csnmp_read_value (host = %s, data = %s)",
1351 host->name, data->name);
1353 if (host->sess_handle == NULL)
1354 {
1355 DEBUG ("snmp plugin: csnmp_read_table: host->sess_handle == NULL");
1356 return (-1);
1357 }
1359 ds = plugin_get_ds (data->type);
1360 if (!ds)
1361 {
1362 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
1363 return (-1);
1364 }
1366 if (ds->ds_num != data->values_len)
1367 {
1368 ERROR ("snmp plugin: DataSet `%s' requires %i values, but config talks about %i",
1369 data->type, ds->ds_num, data->values_len);
1370 return (-1);
1371 }
1373 vl.values_len = ds->ds_num;
1374 vl.values = (value_t *) malloc (sizeof (value_t) * vl.values_len);
1375 if (vl.values == NULL)
1376 return (-1);
1377 for (i = 0; i < vl.values_len; i++)
1378 {
1379 if (ds->ds[i].type == DS_TYPE_COUNTER)
1380 vl.values[i].counter = 0;
1381 else
1382 vl.values[i].gauge = NAN;
1383 }
1385 sstrncpy (vl.host, host->name, sizeof (vl.host));
1386 sstrncpy (vl.plugin, "snmp", sizeof (vl.plugin));
1387 sstrncpy (vl.type, data->type, sizeof (vl.type));
1388 sstrncpy (vl.type_instance, data->instance.string, sizeof (vl.type_instance));
1390 vl.interval = host->interval;
1392 req = snmp_pdu_create (SNMP_MSG_GET);
1393 if (req == NULL)
1394 {
1395 ERROR ("snmp plugin: snmp_pdu_create failed.");
1396 sfree (vl.values);
1397 return (-1);
1398 }
1400 for (i = 0; i < data->values_len; i++)
1401 snmp_add_null_var (req, data->values[i].oid, data->values[i].oid_len);
1403 res = NULL;
1404 status = snmp_sess_synch_response (host->sess_handle, req, &res);
1406 if ((status != STAT_SUCCESS) || (res == NULL))
1407 {
1408 char *errstr = NULL;
1410 snmp_sess_error (host->sess_handle, NULL, NULL, &errstr);
1411 ERROR ("snmp plugin: host %s: snmp_sess_synch_response failed: %s",
1412 host->name, (errstr == NULL) ? "Unknown problem" : errstr);
1414 if (res != NULL)
1415 snmp_free_pdu (res);
1416 res = NULL;
1418 sfree (errstr);
1419 csnmp_host_close_session (host);
1421 return (-1);
1422 }
1425 for (vb = res->variables; vb != NULL; vb = vb->next_variable)
1426 {
1427 #if COLLECT_DEBUG
1428 char buffer[1024];
1429 snprint_variable (buffer, sizeof (buffer),
1430 vb->name, vb->name_length, vb);
1431 DEBUG ("snmp plugin: Got this variable: %s", buffer);
1432 #endif /* COLLECT_DEBUG */
1434 for (i = 0; i < data->values_len; i++)
1435 if (snmp_oid_compare (data->values[i].oid, data->values[i].oid_len,
1436 vb->name, vb->name_length) == 0)
1437 vl.values[i] = csnmp_value_list_to_value (vb, ds->ds[i].type,
1438 data->scale, data->shift);
1439 } /* for (res->variables) */
1441 if (res != NULL)
1442 snmp_free_pdu (res);
1443 res = NULL;
1445 DEBUG ("snmp plugin: -> plugin_dispatch_values (&vl);");
1446 plugin_dispatch_values (&vl);
1447 sfree (vl.values);
1449 return (0);
1450 } /* int csnmp_read_value */
1452 static int csnmp_read_host (user_data_t *ud)
1453 {
1454 host_definition_t *host;
1455 time_t time_start;
1456 time_t time_end;
1457 int status;
1458 int success;
1459 int i;
1461 host = ud->data;
1463 if (host->interval == 0)
1464 host->interval = interval_g;
1466 time_start = time (NULL);
1467 DEBUG ("snmp plugin: csnmp_read_host (%s) started at %u;", host->name,
1468 (unsigned int) time_start);
1470 if (host->sess_handle == NULL)
1471 csnmp_host_open_session (host);
1473 if (host->sess_handle == NULL)
1474 return (-1);
1476 success = 0;
1477 for (i = 0; i < host->data_list_len; i++)
1478 {
1479 data_definition_t *data = host->data_list[i];
1481 if (data->is_table)
1482 status = csnmp_read_table (host, data);
1483 else
1484 status = csnmp_read_value (host, data);
1486 if (status == 0)
1487 success++;
1488 }
1490 time_end = time (NULL);
1491 DEBUG ("snmp plugin: csnmp_read_host (%s) finished at %u;", host->name,
1492 (unsigned int) time_end);
1493 if ((uint32_t) (time_end - time_start) > host->interval)
1494 {
1495 WARNING ("snmp plugin: Host `%s' should be queried every %"PRIu32
1496 " seconds, but reading all values takes %u seconds.",
1497 host->name, host->interval, (unsigned int) (time_end - time_start));
1498 }
1500 if (success == 0)
1501 return (-1);
1503 return (0);
1504 } /* int csnmp_read_host */
1506 static int csnmp_init (void)
1507 {
1508 call_snmp_init_once ();
1510 return (0);
1511 } /* int csnmp_init */
1513 static int csnmp_shutdown (void)
1514 {
1515 data_definition_t *data_this;
1516 data_definition_t *data_next;
1518 /* When we get here, the read threads have been stopped and all the
1519 * `host_definition_t' will be freed. */
1520 DEBUG ("snmp plugin: Destroying all data definitions.");
1522 data_this = data_head;
1523 data_head = NULL;
1524 while (data_this != NULL)
1525 {
1526 data_next = data_this->next;
1528 sfree (data_this->name);
1529 sfree (data_this->type);
1530 sfree (data_this->values);
1531 sfree (data_this);
1533 data_this = data_next;
1534 }
1536 return (0);
1537 } /* int csnmp_shutdown */
1539 void module_register (void)
1540 {
1541 plugin_register_complex_config ("snmp", csnmp_config);
1542 plugin_register_init ("snmp", csnmp_init);
1543 plugin_register_shutdown ("snmp", csnmp_shutdown);
1544 } /* void module_register */
1546 /*
1547 * vim: shiftwidth=2 softtabstop=2 tabstop=8 fdm=marker
1548 */