2c4c930cb652dce0c5f3a7642a12b5f347a561d3
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"
26 #include <pthread.h>
28 #include <net-snmp/net-snmp-config.h>
29 #include <net-snmp/net-snmp-includes.h>
31 /*
32 * Private data structes
33 */
34 struct oid_s
35 {
36 oid oid[MAX_OID_LEN];
37 size_t oid_len;
38 };
39 typedef struct oid_s oid_t;
41 union instance_u
42 {
43 char string[DATA_MAX_NAME_LEN];
44 oid_t oid;
45 };
46 typedef union instance_u instance_t;
48 struct data_definition_s
49 {
50 char *name; /* used to reference this from the `Collect' option */
51 char *type; /* used to find the data_set */
52 int is_table;
53 instance_t instance;
54 oid_t *values;
55 int values_len;
56 struct data_definition_s *next;
57 };
58 typedef struct data_definition_s data_definition_t;
60 struct host_definition_s
61 {
62 char *name;
63 char *address;
64 char *community;
65 int version;
66 void *sess_handle;
67 int16_t skip_num;
68 int16_t skip_left;
69 data_definition_t **data_list;
70 int data_list_len;
71 enum /****************************************************/
72 { /* This host.. */
73 STATE_IDLE, /* - just sits there until `skip_left < interval_g' */
74 STATE_WAIT, /* - waits to be queried. */
75 STATE_BUSY /* - is currently being queried. */
76 } state; /****************************************************/
77 struct host_definition_s *next;
78 };
79 typedef struct host_definition_s host_definition_t;
81 /* These two types are used to cache values in `csnmp_read_table' to handle
82 * gaps in tables. */
83 struct csnmp_list_instances_s
84 {
85 oid subid;
86 char instance[DATA_MAX_NAME_LEN];
87 struct csnmp_list_instances_s *next;
88 };
89 typedef struct csnmp_list_instances_s csnmp_list_instances_t;
91 struct csnmp_table_values_s
92 {
93 oid subid;
94 value_t value;
95 struct csnmp_table_values_s *next;
96 };
97 typedef struct csnmp_table_values_s csnmp_table_values_t;
99 /*
100 * Private variables
101 */
102 static int do_shutdown = 0;
104 pthread_t *threads = NULL;
105 int threads_num = 0;
107 static data_definition_t *data_head = NULL;
108 static host_definition_t *host_head = NULL;
110 static pthread_mutex_t host_lock = PTHREAD_MUTEX_INITIALIZER;
111 static pthread_cond_t host_cond = PTHREAD_COND_INITIALIZER;
113 /*
114 * Private functions
115 */
116 /* First there are many functions which do configuration stuff. It's a big
117 * bloated and messy, I'm afraid. */
119 /*
120 * Callgraph for the config stuff:
121 * csnmp_config
122 * +-> call_snmp_init_once
123 * +-> csnmp_config_add_data
124 * ! +-> csnmp_config_add_data_type
125 * ! +-> csnmp_config_add_data_table
126 * ! +-> csnmp_config_add_data_instance
127 * ! +-> csnmp_config_add_data_values
128 * +-> csnmp_config_add_host
129 * +-> csnmp_config_add_host_address
130 * +-> csnmp_config_add_host_community
131 * +-> csnmp_config_add_host_version
132 * +-> csnmp_config_add_host_collect
133 * +-> csnmp_config_add_host_interval
134 */
135 static void call_snmp_init_once (void)
136 {
137 static int have_init = 0;
139 if (have_init == 0)
140 init_snmp (PACKAGE_NAME);
141 have_init = 1;
142 } /* void call_snmp_init_once */
144 static int csnmp_config_add_data_type (data_definition_t *dd, oconfig_item_t *ci)
145 {
146 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
147 {
148 WARNING ("snmp plugin: `Type' needs exactly one string argument.");
149 return (-1);
150 }
152 if (dd->type != NULL)
153 free (dd->type);
155 dd->type = strdup (ci->values[0].value.string);
156 if (dd->type == NULL)
157 return (-1);
159 return (0);
160 } /* int csnmp_config_add_data_type */
162 static int csnmp_config_add_data_table (data_definition_t *dd, oconfig_item_t *ci)
163 {
164 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_BOOLEAN))
165 {
166 WARNING ("snmp plugin: `Table' needs exactly one boolean argument.");
167 return (-1);
168 }
170 dd->is_table = ci->values[0].value.boolean ? 1 : 0;
172 return (0);
173 } /* int csnmp_config_add_data_table */
175 static int csnmp_config_add_data_instance (data_definition_t *dd, oconfig_item_t *ci)
176 {
177 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
178 {
179 WARNING ("snmp plugin: `Instance' needs exactly one string argument.");
180 return (-1);
181 }
183 if (dd->is_table)
184 {
185 /* Instance is an OID */
186 dd->instance.oid.oid_len = MAX_OID_LEN;
188 if (!read_objid (ci->values[0].value.string,
189 dd->instance.oid.oid, &dd->instance.oid.oid_len))
190 {
191 ERROR ("snmp plugin: read_objid (%s) failed.",
192 ci->values[0].value.string);
193 return (-1);
194 }
195 }
196 else
197 {
198 /* Instance is a simple string */
199 strncpy (dd->instance.string, ci->values[0].value.string, DATA_MAX_NAME_LEN - 1);
200 }
202 return (0);
203 } /* int csnmp_config_add_data_instance */
205 static int csnmp_config_add_data_values (data_definition_t *dd, oconfig_item_t *ci)
206 {
207 int i;
209 if (ci->values_num < 1)
210 {
211 WARNING ("snmp plugin: `Values' needs at least one argument.");
212 return (-1);
213 }
215 for (i = 0; i < ci->values_num; i++)
216 if (ci->values[i].type != OCONFIG_TYPE_STRING)
217 {
218 WARNING ("snmp plugin: `Values' needs only string argument.");
219 return (-1);
220 }
222 if (dd->values != NULL)
223 free (dd->values);
224 dd->values = (oid_t *) malloc (sizeof (oid_t) * ci->values_num);
225 if (dd->values == NULL)
226 return (-1);
227 dd->values_len = ci->values_num;
229 for (i = 0; i < ci->values_num; i++)
230 {
231 dd->values[i].oid_len = MAX_OID_LEN;
233 if (NULL == snmp_parse_oid (ci->values[i].value.string,
234 dd->values[i].oid, &dd->values[i].oid_len))
235 {
236 ERROR ("snmp plugin: snmp_parse_oid (%s) failed.",
237 ci->values[i].value.string);
238 free (dd->values);
239 dd->values = NULL;
240 dd->values_len = 0;
241 return (-1);
242 }
243 }
245 return (0);
246 } /* int csnmp_config_add_data_instance */
248 static int csnmp_config_add_data (oconfig_item_t *ci)
249 {
250 data_definition_t *dd;
251 int status = 0;
252 int i;
254 if ((ci->values_num != 1)
255 || (ci->values[0].type != OCONFIG_TYPE_STRING))
256 {
257 WARNING ("snmp plugin: The `Data' config option needs exactly one string argument.");
258 return (-1);
259 }
261 dd = (data_definition_t *) malloc (sizeof (data_definition_t));
262 if (dd == NULL)
263 return (-1);
264 memset (dd, '\0', sizeof (data_definition_t));
266 dd->name = strdup (ci->values[0].value.string);
267 if (dd->name == NULL)
268 {
269 free (dd);
270 return (-1);
271 }
273 for (i = 0; i < ci->children_num; i++)
274 {
275 oconfig_item_t *option = ci->children + i;
276 status = 0;
278 if (strcasecmp ("Type", option->key) == 0)
279 status = csnmp_config_add_data_type (dd, option);
280 else if (strcasecmp ("Table", option->key) == 0)
281 status = csnmp_config_add_data_table (dd, option);
282 else if (strcasecmp ("Instance", option->key) == 0)
283 status = csnmp_config_add_data_instance (dd, option);
284 else if (strcasecmp ("Values", option->key) == 0)
285 status = csnmp_config_add_data_values (dd, option);
286 else
287 {
288 WARNING ("snmp plugin: Option `%s' not allowed here.", option->key);
289 status = -1;
290 }
292 if (status != 0)
293 break;
294 } /* for (ci->children) */
296 while (status == 0)
297 {
298 if (dd->type == NULL)
299 {
300 WARNING ("snmp plugin: `Type' not given for data `%s'", dd->name);
301 status = -1;
302 break;
303 }
304 if (dd->values == NULL)
305 {
306 WARNING ("snmp plugin: No `Value' given for data `%s'", dd->name);
307 status = -1;
308 break;
309 }
311 break;
312 } /* while (status == 0) */
314 if (status != 0)
315 {
316 sfree (dd->name);
317 sfree (dd->values);
318 sfree (dd);
319 return (-1);
320 }
322 DEBUG ("snmp plugin: dd = { name = %s, type = %s, is_table = %s, values_len = %i }",
323 dd->name, dd->type, (dd->is_table != 0) ? "true" : "false", dd->values_len);
325 if (data_head == NULL)
326 data_head = dd;
327 else
328 {
329 data_definition_t *last;
330 last = data_head;
331 while (last->next != NULL)
332 last = last->next;
333 last->next = dd;
334 }
336 return (0);
337 } /* int csnmp_config_add_data */
339 static int csnmp_config_add_host_address (host_definition_t *hd, oconfig_item_t *ci)
340 {
341 if ((ci->values_num != 1)
342 || (ci->values[0].type != OCONFIG_TYPE_STRING))
343 {
344 WARNING ("snmp plugin: The `Address' config option needs exactly one string argument.");
345 return (-1);
346 }
348 if (hd->address == NULL)
349 free (hd->address);
351 hd->address = strdup (ci->values[0].value.string);
352 if (hd->address == NULL)
353 return (-1);
355 DEBUG ("snmp plugin: host = %s; host->address = %s;",
356 hd->name, hd->address);
358 return (0);
359 } /* int csnmp_config_add_host_address */
361 static int csnmp_config_add_host_community (host_definition_t *hd, oconfig_item_t *ci)
362 {
363 if ((ci->values_num != 1)
364 || (ci->values[0].type != OCONFIG_TYPE_STRING))
365 {
366 WARNING ("snmp plugin: The `Community' config option needs exactly one string argument.");
367 return (-1);
368 }
370 if (hd->community == NULL)
371 free (hd->community);
373 hd->community = strdup (ci->values[0].value.string);
374 if (hd->community == NULL)
375 return (-1);
377 DEBUG ("snmp plugin: host = %s; host->community = %s;",
378 hd->name, hd->community);
380 return (0);
381 } /* int csnmp_config_add_host_community */
383 static int csnmp_config_add_host_version (host_definition_t *hd, oconfig_item_t *ci)
384 {
385 int version;
387 if ((ci->values_num != 1)
388 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
389 {
390 WARNING ("snmp plugin: The `Version' config option needs exactly one number argument.");
391 return (-1);
392 }
394 version = (int) ci->values[0].value.number;
395 if ((version != 1) && (version != 2))
396 {
397 WARNING ("snmp plugin: `Version' must either be `1' or `2'.");
398 return (-1);
399 }
401 hd->version = version;
403 return (0);
404 } /* int csnmp_config_add_host_address */
406 static int csnmp_config_add_host_collect (host_definition_t *host,
407 oconfig_item_t *ci)
408 {
409 data_definition_t *data;
410 data_definition_t **data_list;
411 int data_list_len;
412 int i;
414 if (ci->values_num < 1)
415 {
416 WARNING ("snmp plugin: `Collect' needs at least one argument.");
417 return (-1);
418 }
420 for (i = 0; i < ci->values_num; i++)
421 if (ci->values[i].type != OCONFIG_TYPE_STRING)
422 {
423 WARNING ("snmp plugin: All arguments to `Collect' must be strings.");
424 return (-1);
425 }
427 data_list_len = host->data_list_len + ci->values_num;
428 data_list = (data_definition_t **) realloc (host->data_list,
429 sizeof (data_definition_t *) * data_list_len);
430 if (data_list == NULL)
431 return (-1);
432 host->data_list = data_list;
434 for (i = 0; i < ci->values_num; i++)
435 {
436 for (data = data_head; data != NULL; data = data->next)
437 if (strcasecmp (ci->values[i].value.string, data->name) == 0)
438 break;
440 if (data == NULL)
441 {
442 WARNING ("snmp plugin: No such data configured: `%s'",
443 ci->values[i].value.string);
444 continue;
445 }
447 DEBUG ("snmp plugin: Collect: host = %s, data[%i] = %s;",
448 host->name, host->data_list_len, data->name);
450 host->data_list[host->data_list_len] = data;
451 host->data_list_len++;
452 } /* for (values_num) */
454 return (0);
455 } /* int csnmp_config_add_host_collect */
457 static int csnmp_config_add_host_interval (host_definition_t *hd, oconfig_item_t *ci)
458 {
459 int interval;
461 if ((ci->values_num != 1)
462 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
463 {
464 WARNING ("snmp plugin: The `Interval' config option needs exactly one number argument.");
465 return (-1);
466 }
468 interval = (int) ci->values[0].value.number;
469 hd->skip_num = interval;
470 if (hd->skip_num < 0)
471 hd->skip_num = 0;
473 return (0);
474 } /* int csnmp_config_add_host_interval */
476 static int csnmp_config_add_host (oconfig_item_t *ci)
477 {
478 host_definition_t *hd;
479 int status = 0;
480 int i;
482 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
483 {
484 WARNING ("snmp plugin: `Host' needs exactly one string argument.");
485 return (-1);
486 }
488 hd = (host_definition_t *) malloc (sizeof (host_definition_t));
489 if (hd == NULL)
490 return (-1);
491 memset (hd, '\0', sizeof (host_definition_t));
492 hd->version = 2;
494 hd->name = strdup (ci->values[0].value.string);
495 if (hd->name == NULL)
496 {
497 free (hd);
498 return (-1);
499 }
501 hd->sess_handle = NULL;
502 hd->skip_num = 0;
503 hd->skip_left = 0;
504 hd->state = STATE_IDLE;
506 for (i = 0; i < ci->children_num; i++)
507 {
508 oconfig_item_t *option = ci->children + i;
509 status = 0;
511 if (strcasecmp ("Address", option->key) == 0)
512 status = csnmp_config_add_host_address (hd, option);
513 else if (strcasecmp ("Community", option->key) == 0)
514 status = csnmp_config_add_host_community (hd, option);
515 else if (strcasecmp ("Version", option->key) == 0)
516 status = csnmp_config_add_host_version (hd, option);
517 else if (strcasecmp ("Collect", option->key) == 0)
518 csnmp_config_add_host_collect (hd, option);
519 else if (strcasecmp ("Interval", option->key) == 0)
520 csnmp_config_add_host_interval (hd, option);
521 else
522 {
523 WARNING ("snmp plugin: csnmp_config_add_host: Option `%s' not allowed here.", option->key);
524 status = -1;
525 }
527 if (status != 0)
528 break;
529 } /* for (ci->children) */
531 while (status == 0)
532 {
533 if (hd->address == NULL)
534 {
535 WARNING ("snmp plugin: `Address' not given for host `%s'", hd->name);
536 status = -1;
537 break;
538 }
539 if (hd->community == NULL)
540 {
541 WARNING ("snmp plugin: `Community' not given for host `%s'", hd->name);
542 status = -1;
543 break;
544 }
546 break;
547 } /* while (status == 0) */
549 if (status != 0)
550 {
551 sfree (hd->name);
552 sfree (hd);
553 return (-1);
554 }
556 DEBUG ("snmp plugin: hd = { name = %s, address = %s, community = %s, version = %i }",
557 hd->name, hd->address, hd->community, hd->version);
559 if (host_head == NULL)
560 host_head = hd;
561 else
562 {
563 host_definition_t *last;
564 last = host_head;
565 while (last->next != NULL)
566 last = last->next;
567 last->next = hd;
568 }
570 return (0);
571 } /* int csnmp_config_add_host */
573 static int csnmp_config (oconfig_item_t *ci)
574 {
575 int i;
577 call_snmp_init_once ();
579 for (i = 0; i < ci->children_num; i++)
580 {
581 oconfig_item_t *child = ci->children + i;
582 if (strcasecmp ("Data", child->key) == 0)
583 csnmp_config_add_data (child);
584 else if (strcasecmp ("Host", child->key) == 0)
585 csnmp_config_add_host (child);
586 else
587 {
588 WARNING ("snmp plugin: Ignoring unknown config option `%s'.", child->key);
589 }
590 } /* for (ci->children) */
592 return (0);
593 } /* int csnmp_config */
595 /* End of the config stuff. Now the interesting part begins */
597 static void csnmp_host_close_session (host_definition_t *host)
598 {
599 int status;
601 if (host->sess_handle == NULL)
602 return;
604 status = snmp_sess_close (host->sess_handle);
606 if (status != 0)
607 {
608 char *errstr = NULL;
610 snmp_sess_error (host->sess_handle, NULL, NULL, &errstr);
612 ERROR ("snmp plugin: snmp_sess_close failed: %s",
613 (errstr == NULL) ? "Unknown problem" : errstr);
614 sfree (errstr);
615 }
617 host->sess_handle = NULL;
618 } /* void csnmp_host_close_session */
620 static void csnmp_host_open_session (host_definition_t *host)
621 {
622 struct snmp_session sess;
624 if (host->sess_handle != NULL)
625 csnmp_host_close_session (host);
627 snmp_sess_init (&sess);
628 sess.peername = host->address;
629 sess.community = (u_char *) host->community;
630 sess.community_len = strlen (host->community);
631 sess.version = (host->version == 1) ? SNMP_VERSION_1 : SNMP_VERSION_2c;
633 /* snmp_sess_open will copy the `struct snmp_session *'. */
634 host->sess_handle = snmp_sess_open (&sess);
636 if (host->sess_handle == NULL)
637 {
638 char *errstr = NULL;
640 snmp_error (&sess, NULL, NULL, &errstr);
642 ERROR ("snmp plugin: snmp_sess_open failed: %s",
643 (errstr == NULL) ? "Unknown problem" : errstr);
644 sfree (errstr);
645 }
646 } /* void csnmp_host_open_session */
648 static value_t csnmp_value_list_to_value (struct variable_list *vl, int type)
649 {
650 value_t ret;
651 uint64_t temp = 0;
652 int defined = 1;
654 if ((vl->type == ASN_INTEGER)
655 || (vl->type == ASN_UINTEGER)
656 || (vl->type == ASN_COUNTER)
657 || (vl->type == ASN_GAUGE))
658 {
659 temp = (uint32_t) *vl->val.integer;
660 DEBUG ("snmp plugin: Parsed int32 value is %llu.", temp);
661 }
662 else if (vl->type == ASN_COUNTER64)
663 {
664 temp = (uint32_t) vl->val.counter64->high;
665 temp = temp << 32;
666 temp += (uint32_t) vl->val.counter64->low;
667 DEBUG ("snmp plugin: Parsed int64 value is %llu.", temp);
668 }
669 else
670 {
671 WARNING ("snmp plugin: I don't know the ASN type `%i'", (int) vl->type);
672 defined = 0;
673 }
675 if (type == DS_TYPE_COUNTER)
676 {
677 ret.counter = temp;
678 }
679 else if (type == DS_TYPE_GAUGE)
680 {
681 ret.gauge = NAN;
682 if (defined != 0)
683 ret.gauge = temp;
684 }
686 return (ret);
687 } /* value_t csnmp_value_list_to_value */
689 static int csnmp_dispatch_table (host_definition_t *host, data_definition_t *data,
690 csnmp_list_instances_t *instance_list,
691 csnmp_table_values_t **value_table)
692 {
693 const data_set_t *ds;
694 value_list_t vl = VALUE_LIST_INIT;
696 csnmp_list_instances_t *instance_list_ptr;
697 csnmp_table_values_t **value_table_ptr;
699 int i;
701 ds = plugin_get_ds (data->type);
702 if (!ds)
703 {
704 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
705 return (-1);
706 }
707 assert (ds->ds_num == data->values_len);
709 value_table_ptr = (csnmp_table_values_t **) malloc (sizeof (csnmp_table_values_t *)
710 * data->values_len);
711 if (value_table_ptr == NULL)
712 return (-1);
713 for (i = 0; i < data->values_len; i++)
714 value_table_ptr[i] = value_table[i];
716 vl.values_len = ds->ds_num;
717 vl.values = (value_t *) malloc (sizeof (value_t) * vl.values_len);
718 if (vl.values == NULL)
719 {
720 sfree (value_table_ptr);
721 return (-1);
722 }
724 strncpy (vl.host, host->name, sizeof (vl.host));
725 vl.host[sizeof (vl.host) - 1] = '\0';
726 strcpy (vl.plugin, "snmp");
728 vl.interval = host->skip_num;
729 vl.time = time (NULL);
731 for (instance_list_ptr = instance_list;
732 instance_list_ptr != NULL;
733 instance_list_ptr = instance_list_ptr->next)
734 {
735 strncpy (vl.type_instance, instance_list_ptr->instance, sizeof (vl.type_instance));
736 vl.type_instance[sizeof (vl.type_instance) - 1] = '\0';
738 for (i = 0; i < data->values_len; i++)
739 {
740 while ((value_table_ptr[i] != NULL)
741 && (value_table_ptr[i]->subid < instance_list_ptr->subid))
742 value_table_ptr[i] = value_table_ptr[i]->next;
743 if ((value_table_ptr[i] == NULL)
744 || (value_table_ptr[i]->subid != instance_list_ptr->subid))
745 break;
746 vl.values[i] = value_table_ptr[i]->value;
747 } /* for (data->values_len) */
749 /* If the for-loop was aborted early, not all subid's match. */
750 if (i < data->values_len)
751 {
752 DEBUG ("snmp plugin: host = %s; data = %s; i = %i; "
753 "Skipping SUBID %i",
754 host->name, data->name, i, instance_list_ptr->subid);
755 continue;
756 }
758 /* If we get here `vl.type_instance' and all `vl.values' have been set */
759 plugin_dispatch_values (data->type, &vl);
760 } /* for (instance_list) */
762 sfree (vl.values);
763 sfree (value_table_ptr);
765 return (0);
766 } /* int csnmp_dispatch_table */
768 static int csnmp_read_table (host_definition_t *host, data_definition_t *data)
769 {
770 struct snmp_pdu *req;
771 struct snmp_pdu *res;
772 struct variable_list *vb;
774 const data_set_t *ds;
775 oid_t *oid_list;
776 uint32_t oid_list_len;
778 int status;
779 int i;
781 /* `value_table' and `value_table_ptr' implement a linked list for each
782 * value. `instance_list' and `instance_list_ptr' implement a linked list of
783 * instance names. This is used to jump gaps in the table. */
784 csnmp_list_instances_t *instance_list;
785 csnmp_list_instances_t *instance_list_ptr;
786 csnmp_table_values_t **value_table;
787 csnmp_table_values_t **value_table_ptr;
789 DEBUG ("snmp plugin: csnmp_read_table (host = %s, data = %s)",
790 host->name, data->name);
792 ds = plugin_get_ds (data->type);
793 if (!ds)
794 {
795 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
796 return (-1);
797 }
799 if (ds->ds_num != data->values_len)
800 {
801 ERROR ("snmp plugin: DataSet `%s' requires %i values, but config talks about %i",
802 data->type, ds->ds_num, data->values_len);
803 return (-1);
804 }
806 /* We need a copy of all the OIDs, because GETNEXT will destroy them. */
807 oid_list_len = data->values_len + 1;
808 oid_list = (oid_t *) malloc (sizeof (oid_t) * (oid_list_len));
809 if (oid_list == NULL)
810 return (-1);
811 memcpy (oid_list, &data->instance.oid, sizeof (oid_t));
812 for (i = 0; i < data->values_len; i++)
813 memcpy (oid_list + (i + 1), data->values + i, sizeof (oid_t));
815 /* Allocate the `value_table' */
816 value_table = (csnmp_table_values_t **) malloc (sizeof (csnmp_table_values_t *)
817 * 2 * data->values_len);
818 if (value_table == NULL)
819 {
820 sfree (oid_list);
821 return (-1);
822 }
823 memset (value_table, '\0', sizeof (csnmp_table_values_t *) * 2 * data->values_len);
824 value_table_ptr = value_table + data->values_len;
826 instance_list = NULL;
827 instance_list_ptr = NULL;
829 status = 0;
830 while (status == 0)
831 {
832 csnmp_list_instances_t *il;
834 req = snmp_pdu_create (SNMP_MSG_GETNEXT);
835 if (req == NULL)
836 {
837 ERROR ("snmp plugin: snmp_pdu_create failed.");
838 status = -1;
839 break;
840 }
842 for (i = 0; i < oid_list_len; i++)
843 snmp_add_null_var (req, oid_list[i].oid, oid_list[i].oid_len);
845 status = snmp_sess_synch_response (host->sess_handle, req, &res);
847 if (status != STAT_SUCCESS)
848 {
849 char *errstr = NULL;
851 snmp_sess_error (host->sess_handle, NULL, NULL, &errstr);
852 ERROR ("snmp plugin: snmp_sess_synch_response failed: %s",
853 (errstr == NULL) ? "Unknown problem" : errstr);
854 csnmp_host_close_session (host);
856 status = -1;
857 break;
858 }
859 status = 0;
860 assert (res != NULL);
862 vb = res->variables;
863 if (vb == NULL)
864 {
865 status = -1;
866 break;
867 }
869 /* Check if we left the subtree */
870 if (snmp_oid_ncompare (data->instance.oid.oid, data->instance.oid.oid_len,
871 vb->name, vb->name_length,
872 data->instance.oid.oid_len) != 0)
873 break;
875 /* Allocate a new `csnmp_list_instances_t', insert the instance name and
876 * add it to the list */
877 il = (csnmp_list_instances_t *) malloc (sizeof (csnmp_list_instances_t));
878 if (il == NULL)
879 {
880 status = -1;
881 break;
882 }
883 il->subid = vb->name[vb->name_length - 1];
884 il->next = NULL;
886 /* Get instance name */
887 if ((vb->type == ASN_OCTET_STR) || (vb->type == ASN_BIT_STR))
888 {
889 char *ptr;
890 size_t instance_len;
892 instance_len = sizeof (il->instance) - 1;
893 if (instance_len > vb->val_len)
894 instance_len = vb->val_len;
896 strncpy (il->instance, (char *) ((vb->type == ASN_OCTET_STR)
897 ? vb->val.string
898 : vb->val.bitstring),
899 instance_len);
900 il->instance[instance_len] = '\0';
902 for (ptr = il->instance; *ptr != '\0'; ptr++)
903 {
904 if ((*ptr > 0) && (*ptr < 32))
905 *ptr = ' ';
906 else if (*ptr == '/')
907 *ptr = '_';
908 }
909 DEBUG ("snmp plugin: il->instance = `%s';", il->instance);
910 }
911 else
912 {
913 value_t val = csnmp_value_list_to_value (vb, DS_TYPE_COUNTER);
914 snprintf (il->instance, sizeof (il->instance),
915 "%llu", val.counter);
916 }
917 il->instance[sizeof (il->instance) - 1] = '\0';
918 DEBUG ("snmp plugin: data = `%s'; il->instance = `%s';",
919 data->name, il->instance);
921 if (instance_list_ptr == NULL)
922 instance_list = il;
923 else
924 instance_list_ptr->next = il;
925 instance_list_ptr = il;
927 /* Copy OID to oid_list[0] */
928 memcpy (oid_list[0].oid, vb->name, sizeof (oid) * vb->name_length);
929 oid_list[0].oid_len = vb->name_length;
931 for (i = 0; i < data->values_len; i++)
932 {
933 csnmp_table_values_t *vt;
935 vb = vb->next_variable;
936 if (vb == NULL)
937 {
938 status = -1;
939 break;
940 }
942 /* Check if we left the subtree */
943 if (snmp_oid_ncompare (data->values[i].oid,
944 data->values[i].oid_len,
945 vb->name, vb->name_length,
946 data->values[i].oid_len) != 0)
947 {
948 DEBUG ("snmp plugin: host = %s; data = %s; Value %i left its subtree.",
949 host->name, data->name, i);
950 continue;
951 }
953 if ((value_table_ptr[i] != NULL)
954 && (vb->name[vb->name_length - 1] <= value_table_ptr[i]->subid))
955 {
956 DEBUG ("snmp plugin: host = %s; data = %s; i = %i; SUBID is not increasing.",
957 host->name, data->name, i);
958 continue;
959 }
961 vt = (csnmp_table_values_t *) malloc (sizeof (csnmp_table_values_t));
962 if (vt != NULL)
963 {
964 vt->subid = vb->name[vb->name_length - 1];
965 vt->value = csnmp_value_list_to_value (vb, ds->ds[i].type);
966 vt->next = NULL;
968 if (value_table_ptr[i] == NULL)
969 value_table[i] = vt;
970 else
971 value_table_ptr[i]->next = vt;
972 value_table_ptr[i] = vt;
973 }
975 /* Copy OID to oid_list[i + 1] */
976 memcpy (oid_list[i + 1].oid, vb->name, sizeof (oid) * vb->name_length);
977 oid_list[i + 1].oid_len = vb->name_length;
978 } /* for (i = data->values_len) */
980 if (res != NULL)
981 snmp_free_pdu (res);
982 res = NULL;
983 } /* while (status == 0) */
985 if (status == 0)
986 csnmp_dispatch_table (host, data, instance_list, value_table);
988 /* Free all allocated variables here */
989 while (instance_list != NULL)
990 {
991 instance_list_ptr = instance_list->next;
992 sfree (instance_list);
993 instance_list = instance_list_ptr;
994 }
996 for (i = 0; i < data->values_len; i++)
997 {
998 csnmp_table_values_t *tmp;
999 while (value_table[i] != NULL)
1000 {
1001 tmp = value_table[i]->next;
1002 sfree (value_table[i]);
1003 value_table[i] = tmp;
1004 }
1005 }
1007 sfree (value_table);
1008 sfree (oid_list);
1010 return (0);
1011 } /* int csnmp_read_table */
1013 static int csnmp_read_value (host_definition_t *host, data_definition_t *data)
1014 {
1015 struct snmp_pdu *req;
1016 struct snmp_pdu *res;
1017 struct variable_list *vb;
1019 const data_set_t *ds;
1020 value_list_t vl = VALUE_LIST_INIT;
1022 int status;
1023 int i;
1025 DEBUG ("snmp plugin: csnmp_read_value (host = %s, data = %s)",
1026 host->name, data->name);
1028 ds = plugin_get_ds (data->type);
1029 if (!ds)
1030 {
1031 ERROR ("snmp plugin: DataSet `%s' not defined.", data->type);
1032 return (-1);
1033 }
1035 if (ds->ds_num != data->values_len)
1036 {
1037 ERROR ("snmp plugin: DataSet `%s' requires %i values, but config talks about %i",
1038 data->type, ds->ds_num, data->values_len);
1039 return (-1);
1040 }
1042 vl.values_len = ds->ds_num;
1043 vl.values = (value_t *) malloc (sizeof (value_t) * vl.values_len);
1044 if (vl.values == NULL)
1045 return (-1);
1046 for (i = 0; i < vl.values_len; i++)
1047 {
1048 if (ds->ds[i].type == DS_TYPE_COUNTER)
1049 vl.values[i].counter = 0;
1050 else
1051 vl.values[i].gauge = NAN;
1052 }
1054 strncpy (vl.host, host->name, sizeof (vl.host));
1055 vl.host[sizeof (vl.host) - 1] = '\0';
1056 strcpy (vl.plugin, "snmp");
1057 strncpy (vl.type_instance, data->instance.string, sizeof (vl.type_instance));
1058 vl.type_instance[sizeof (vl.type_instance) - 1] = '\0';
1060 vl.interval = host->skip_num;
1062 req = snmp_pdu_create (SNMP_MSG_GET);
1063 if (req == NULL)
1064 {
1065 ERROR ("snmp plugin: snmp_pdu_create failed.");
1066 sfree (vl.values);
1067 return (-1);
1068 }
1070 for (i = 0; i < data->values_len; i++)
1071 snmp_add_null_var (req, data->values[i].oid, data->values[i].oid_len);
1072 status = snmp_sess_synch_response (host->sess_handle, req, &res);
1074 if (status != STAT_SUCCESS)
1075 {
1076 char *errstr = NULL;
1078 snmp_sess_error (host->sess_handle, NULL, NULL, &errstr);
1079 ERROR ("snmp plugin: snmp_sess_synch_response failed: %s",
1080 (errstr == NULL) ? "Unknown problem" : errstr);
1081 csnmp_host_close_session (host);
1082 sfree (errstr);
1084 return (-1);
1085 }
1087 vl.time = time (NULL);
1089 for (vb = res->variables; vb != NULL; vb = vb->next_variable)
1090 {
1091 char buffer[1024];
1092 snprint_variable (buffer, sizeof (buffer),
1093 vb->name, vb->name_length, vb);
1094 DEBUG ("snmp plugin: Got this variable: %s", buffer);
1096 for (i = 0; i < data->values_len; i++)
1097 if (snmp_oid_compare (data->values[i].oid, data->values[i].oid_len,
1098 vb->name, vb->name_length) == 0)
1099 vl.values[i] = csnmp_value_list_to_value (vb, ds->ds[i].type);
1100 } /* for (res->variables) */
1102 snmp_free_pdu (res);
1104 DEBUG ("snmp plugin: -> plugin_dispatch_values (%s, &vl);", data->type);
1105 plugin_dispatch_values (data->type, &vl);
1106 sfree (vl.values);
1108 return (0);
1109 } /* int csnmp_read_value */
1111 static int csnmp_read_host (host_definition_t *host)
1112 {
1113 int i;
1115 DEBUG ("snmp plugin: csnmp_read_host (%s);", host->name);
1117 if (host->sess_handle == NULL)
1118 csnmp_host_open_session (host);
1120 if (host->sess_handle == NULL)
1121 return (-1);
1123 for (i = 0; i < host->data_list_len; i++)
1124 {
1125 data_definition_t *data = host->data_list[i];
1127 if (data->is_table)
1128 csnmp_read_table (host, data);
1129 else
1130 csnmp_read_value (host, data);
1131 }
1133 return (0);
1134 } /* int csnmp_read_host */
1136 static void *csnmp_read_thread (void *data)
1137 {
1138 host_definition_t *host;
1140 pthread_mutex_lock (&host_lock);
1141 while (do_shutdown == 0)
1142 {
1143 pthread_cond_wait (&host_cond, &host_lock);
1145 for (host = host_head; host != NULL; host = host->next)
1146 {
1147 if (do_shutdown != 0)
1148 break;
1149 if (host->state != STATE_WAIT)
1150 continue;
1152 host->state = STATE_BUSY;
1153 pthread_mutex_unlock (&host_lock);
1154 csnmp_read_host (host);
1155 pthread_mutex_lock (&host_lock);
1156 host->state = STATE_IDLE;
1157 } /* for (host) */
1158 } /* while (do_shutdown == 0) */
1159 pthread_mutex_unlock (&host_lock);
1161 pthread_exit ((void *) 0);
1162 return ((void *) 0);
1163 } /* void *csnmp_read_thread */
1165 static int csnmp_init (void)
1166 {
1167 host_definition_t *host;
1168 int i;
1170 if (host_head == NULL)
1171 return (-1);
1173 call_snmp_init_once ();
1175 threads_num = 0;
1176 for (host = host_head; host != NULL; host = host->next)
1177 {
1178 threads_num++;
1179 /* We need to initialize `skip_num' here, because `interval_g' isn't
1180 * initialized during `configure'. */
1181 host->skip_left = interval_g;
1182 if (host->skip_num == 0)
1183 {
1184 host->skip_num = interval_g;
1185 }
1186 else if (host->skip_num < interval_g)
1187 {
1188 host->skip_num = interval_g;
1189 WARNING ("snmp plugin: Data for host `%s' will be collected every %i seconds.",
1190 host->name, host->skip_num);
1191 }
1193 csnmp_host_open_session (host);
1194 } /* for (host) */
1196 /* Now start the reading threads */
1197 if (threads_num > 3)
1198 {
1199 threads_num = 3 + ((threads_num - 3) / 10);
1200 if (threads_num > 10)
1201 threads_num = 10;
1202 }
1204 threads = (pthread_t *) malloc (threads_num * sizeof (pthread_t));
1205 if (threads == NULL)
1206 return (-1);
1207 memset (threads, '\0', threads_num * sizeof (pthread_t));
1209 for (i = 0; i < threads_num; i++)
1210 pthread_create (threads + i, NULL, csnmp_read_thread, (void *) 0);
1212 return (0);
1213 } /* int csnmp_init */
1215 static int csnmp_read (void)
1216 {
1217 host_definition_t *host;
1218 time_t now;
1220 if (host_head == NULL)
1221 {
1222 INFO ("snmp plugin: No hosts configured.");
1223 return (-1);
1224 }
1226 now = time (NULL);
1228 pthread_mutex_lock (&host_lock);
1229 for (host = host_head; host != NULL; host = host->next)
1230 {
1231 if (host->state != STATE_IDLE)
1232 continue;
1234 host->skip_left -= interval_g;
1235 if (host->skip_left >= interval_g)
1236 continue;
1238 host->state = STATE_WAIT;
1240 host->skip_left = host->skip_num;
1241 } /* for (host) */
1243 pthread_cond_broadcast (&host_cond);
1244 pthread_mutex_unlock (&host_lock);
1246 return (0);
1247 } /* int csnmp_read */
1249 static int csnmp_shutdown (void)
1250 {
1251 host_definition_t *host_this;
1252 host_definition_t *host_next;
1254 data_definition_t *data_this;
1255 data_definition_t *data_next;
1257 int i;
1259 pthread_mutex_lock (&host_lock);
1260 do_shutdown = 1;
1261 pthread_cond_broadcast (&host_cond);
1262 pthread_mutex_unlock (&host_lock);
1264 for (i = 0; i < threads_num; i++)
1265 pthread_join (threads[i], NULL);
1267 /* Now that all the threads have exited, let's free all the global variables.
1268 * This isn't really neccessary, I guess, but I think it's good stile to do
1269 * so anyway. */
1270 host_this = host_head;
1271 host_head = NULL;
1272 while (host_this != NULL)
1273 {
1274 host_next = host_this->next;
1276 csnmp_host_close_session (host_this);
1278 sfree (host_this->name);
1279 sfree (host_this->address);
1280 sfree (host_this->community);
1281 sfree (host_this->data_list);
1282 sfree (host_this);
1284 host_this = host_next;
1285 }
1287 data_this = data_head;
1288 data_head = NULL;
1289 while (data_this != NULL)
1290 {
1291 data_next = data_this->next;
1293 sfree (data_this->name);
1294 sfree (data_this->type);
1295 sfree (data_this->values);
1296 sfree (data_this);
1298 data_this = data_next;
1299 }
1301 return (0);
1302 } /* int csnmp_shutdown */
1304 void module_register (void)
1305 {
1306 plugin_register_complex_config ("snmp", csnmp_config);
1307 plugin_register_init ("snmp", csnmp_init);
1308 plugin_register_read ("snmp", csnmp_read);
1309 plugin_register_shutdown ("snmp", csnmp_shutdown);
1310 } /* void module_register */
1312 /*
1313 * vim: shiftwidth=2 softtabstop=2 tabstop=8
1314 */