2 * collectd - src/snmp_agent.c
4 * Copyright(c) 2017 Intel Corporation. All rights reserved.
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25 * Roman Korynkevych <romanx.korynkevych@intel.com>
26 * Serhiy Pshyk <serhiyx.pshyk@intel.com>
32 #include "utils_avltree.h"
33 #include "utils_cache.h"
34 #include "utils_llist.h"
36 #include <net-snmp/net-snmp-config.h>
38 #include <net-snmp/net-snmp-includes.h>
40 #include <net-snmp/agent/net-snmp-agent-includes.h>
42 #define PLUGIN_NAME "snmp_agent"
43 #define ERR_BUF_SIZE 1024
44 #define TYPE_STRING -1
47 #define MIN(x, y) ((x) < (y) ? (x) : (y))
55 typedef struct oid_s oid_t;
57 struct table_definition_s {
62 c_avl_tree_t *instance_index;
63 c_avl_tree_t *index_instance;
65 typedef struct table_definition_s table_definition_t;
67 struct data_definition_s {
70 char *plugin_instance;
73 const table_definition_t *table;
80 typedef struct data_definition_s data_definition_t;
82 struct snmp_agent_ctx_s {
85 pthread_mutex_t agentx_lock;
91 typedef struct snmp_agent_ctx_s snmp_agent_ctx_t;
93 static snmp_agent_ctx_t *g_agent = NULL;
95 #define CHECK_DD_TYPE(_dd, _p, _pi, _t, _ti) \
96 (_dd->plugin ? !strcmp(_dd->plugin, _p) : 0) && \
97 (_dd->plugin_instance ? !strcmp(_dd->plugin_instance, _pi) : 1) && \
98 (_dd->type ? !strcmp(_dd->type, _t) : 0) && \
99 (_dd->type_instance ? !strcmp(_dd->type_instance, _ti) : 1)
101 static void *snmp_agent_thread_run(void *arg);
102 static int snmp_agent_register_oid(oid_t *oid, Netsnmp_Node_Handler *handler);
103 static int snmp_agent_set_vardata(void *dst_buf, size_t *dst_buf_len,
104 u_char asn_type, double scale, double shift,
105 const void *value, size_t len, int type);
106 static int snmp_agent_unregister_oid_index(oid_t *oid, int index);
108 static u_char snmp_agent_get_asn_type(oid *oid, size_t oid_len) {
109 struct tree *node = get_tree(oid, oid_len, g_agent->tp);
111 return (node != NULL) ? mib_to_asn_type(node->type) : 0;
114 static char *snmp_agent_get_oid_name(oid *oid, size_t oid_len) {
115 struct tree *node = get_tree(oid, oid_len, g_agent->tp);
117 return (node != NULL) ? node->label : NULL;
120 static int snmp_agent_oid_to_string(char *buf, size_t buf_size,
122 char oid_str[MAX_OID_LEN][16];
123 char *oid_str_ptr[MAX_OID_LEN];
125 for (size_t i = 0; i < o->oid_len; i++) {
126 ssnprintf(oid_str[i], sizeof(oid_str[i]), "%lu", (unsigned long)o->oid[i]);
127 oid_str_ptr[i] = oid_str[i];
130 return strjoin(buf, buf_size, oid_str_ptr, o->oid_len, ".");
133 static void snmp_agent_dump_data(void) {
135 char oid_str[DATA_MAX_NAME_LEN];
137 for (llentry_t *te = llist_head(g_agent->tables); te != NULL; te = te->next) {
138 table_definition_t *td = te->value;
140 DEBUG(PLUGIN_NAME ": Table:");
141 DEBUG(PLUGIN_NAME ": Name: %s", td->name);
142 if (td->index_oid.oid_len != 0) {
143 snmp_agent_oid_to_string(oid_str, sizeof(oid_str), &td->index_oid);
144 DEBUG(PLUGIN_NAME ": IndexOID: %s", oid_str);
146 if (td->size_oid.oid_len != 0) {
147 snmp_agent_oid_to_string(oid_str, sizeof(oid_str), &td->size_oid);
148 DEBUG(PLUGIN_NAME ": SizeOID: %s", oid_str);
151 for (llentry_t *de = llist_head(td->columns); de != NULL; de = de->next) {
152 data_definition_t *dd = de->value;
154 DEBUG(PLUGIN_NAME ": Column:");
155 DEBUG(PLUGIN_NAME ": Name: %s", dd->name);
157 DEBUG(PLUGIN_NAME ": Plugin: %s", dd->plugin);
158 if (dd->plugin_instance)
159 DEBUG(PLUGIN_NAME ": PluginInstance: %s", dd->plugin_instance);
161 DEBUG(PLUGIN_NAME ": Instance: true");
163 DEBUG(PLUGIN_NAME ": Type: %s", dd->type);
164 if (dd->type_instance)
165 DEBUG(PLUGIN_NAME ": TypeInstance: %s", dd->type_instance);
166 for (size_t i = 0; i < dd->oids_len; i++) {
167 snmp_agent_oid_to_string(oid_str, sizeof(oid_str), &dd->oids[i]);
168 DEBUG(PLUGIN_NAME ": OID[%zu]: %s", i, oid_str);
170 DEBUG(PLUGIN_NAME ": Scale: %g", dd->scale);
171 DEBUG(PLUGIN_NAME ": Shift: %g", dd->shift);
175 for (llentry_t *e = llist_head(g_agent->scalars); e != NULL; e = e->next) {
176 data_definition_t *dd = e->value;
178 DEBUG(PLUGIN_NAME ": Scalar:");
179 DEBUG(PLUGIN_NAME ": Name: %s", dd->name);
181 DEBUG(PLUGIN_NAME ": Plugin: %s", dd->plugin);
182 if (dd->plugin_instance)
183 DEBUG(PLUGIN_NAME ": PluginInstance: %s", dd->plugin_instance);
185 DEBUG(PLUGIN_NAME ": Instance: true");
187 DEBUG(PLUGIN_NAME ": Type: %s", dd->type);
188 if (dd->type_instance)
189 DEBUG(PLUGIN_NAME ": TypeInstance: %s", dd->type_instance);
190 for (size_t i = 0; i < dd->oids_len; i++) {
191 snmp_agent_oid_to_string(oid_str, sizeof(oid_str), &dd->oids[i]);
192 DEBUG(PLUGIN_NAME ": OID[%zu]: %s", i, oid_str);
194 DEBUG(PLUGIN_NAME ": Scale: %g", dd->scale);
195 DEBUG(PLUGIN_NAME ": Shift: %g", dd->shift);
197 #endif /* COLLECT_DEBUG */
200 static int snmp_agent_validate_data(void) {
202 snmp_agent_dump_data();
204 for (llentry_t *te = llist_head(g_agent->tables); te != NULL; te = te->next) {
205 table_definition_t *td = te->value;
207 for (llentry_t *de = llist_head(td->columns); de != NULL; de = de->next) {
208 data_definition_t *dd = de->value;
211 ERROR(PLUGIN_NAME ": Plugin not defined for '%s'.'%s'", td->name,
216 if (dd->plugin_instance) {
217 ERROR(PLUGIN_NAME ": PluginInstance should not be defined for table "
218 "data type '%s'.'%s'",
223 if (dd->oids_len == 0) {
224 ERROR(PLUGIN_NAME ": No OIDs defined for '%s'.'%s'", td->name,
229 if (dd->is_instance) {
231 if (dd->type || dd->type_instance) {
232 ERROR(PLUGIN_NAME ": Type and TypeInstance are not valid for "
233 "instance data '%s'.'%s'",
238 if (dd->oids_len > 1) {
241 ": Only one OID should be specified for instance data '%s'.'%s'",
248 ERROR(PLUGIN_NAME ": Type not defined for data '%s'.'%s'", td->name,
256 for (llentry_t *e = llist_head(g_agent->scalars); e != NULL; e = e->next) {
257 data_definition_t *dd = e->value;
260 ERROR(PLUGIN_NAME ": Plugin not defined for '%s'", dd->name);
264 if (dd->oids_len == 0) {
265 ERROR(PLUGIN_NAME ": No OIDs defined for '%s'", dd->name);
269 if (dd->is_instance) {
271 ": Instance flag can't be specified for scalar data '%s'",
277 ERROR(PLUGIN_NAME ": Type not defined for data '%s'", dd->name);
285 static void snmp_agent_generate_oid2string(oid_t *oid, size_t offset, char *key) {
286 int key_len = oid->oid[offset];
289 for (i = 0; i < key_len && offset < oid->oid_len; i++)
290 key[i] = oid->oid[++offset];
295 static int snmp_agent_generate_string2oid(oid_t *oid, const char *key) {
296 int key_len = strlen(key);
298 oid->oid[oid->oid_len++] = key_len;
299 for (int i = 0; i < key_len; i++) {
300 oid->oid[oid->oid_len++] = key[i];
301 if (oid->oid_len >= MAX_OID_LEN) {
302 ERROR(PLUGIN_NAME ": Conversion key string %s to OID failed", key);
310 static int snmp_agent_register_oid_string(oid_t *oid, const char *key,
311 Netsnmp_Node_Handler *handler) {
314 memcpy(&new_oid, oid, sizeof(*oid));
315 int ret = snmp_agent_generate_string2oid(&new_oid, key);
319 return snmp_agent_register_oid(&new_oid, handler);
322 static int snmp_agent_unregister_oid_string(oid_t *oid, const char *key) {
325 memcpy(&new_oid, oid, sizeof(*oid));
326 int ret = snmp_agent_generate_string2oid(&new_oid, key);
330 return unregister_mib(new_oid.oid, new_oid.oid_len);
333 static int snmp_agent_table_row_remove(table_definition_t *td,
334 const char *instance) {
338 if (td->index_oid.oid_len) {
339 if ((c_avl_get(td->instance_index, instance, (void **)&index) != 0) ||
340 (c_avl_get(td->index_instance, index, (void **)&ins) != 0))
343 if (c_avl_get(td->instance_index, instance, (void **)&ins) != 0)
347 pthread_mutex_lock(&g_agent->agentx_lock);
349 if (td->index_oid.oid_len)
350 snmp_agent_unregister_oid_index(&td->index_oid, *index);
352 for (llentry_t *de = llist_head(td->columns); de != NULL; de = de->next) {
353 data_definition_t *dd = de->value;
355 for (size_t i = 0; i < dd->oids_len; i++)
356 if (td->index_oid.oid_len)
357 snmp_agent_unregister_oid_index(&dd->oids[i], *index);
359 snmp_agent_unregister_oid_string(&dd->oids[i], ins);
362 pthread_mutex_unlock(&g_agent->agentx_lock);
364 DEBUG(PLUGIN_NAME ": Removed row for '%s' table [%d, %s]", td->name,
365 (index != NULL) ? *index : -1, ins);
368 .severity = NOTIF_WARNING, .time = cdtime(), .plugin = PLUGIN_NAME};
369 sstrncpy(n.host, hostname_g, sizeof(n.host));
370 sstrncpy(n.plugin_instance, ins, sizeof(n.plugin_instance));
371 ssnprintf(n.message, sizeof(n.message),
372 "Removed data row from table %s instance %s index %d", td->name,
373 ins, (index != NULL) ? *index : -1);
374 plugin_dispatch_notification(&n);
376 if (td->index_oid.oid_len) {
377 c_avl_remove(td->index_instance, index, NULL, (void **)&ins);
378 c_avl_remove(td->instance_index, instance, NULL, (void **)&index);
382 c_avl_remove(td->instance_index, instance, NULL, (void **)&ins);
389 static int snmp_agent_clear_missing(const value_list_t *vl,
390 __attribute__((unused)) user_data_t *ud) {
394 for (llentry_t *te = llist_head(g_agent->tables); te != NULL; te = te->next) {
395 table_definition_t *td = te->value;
397 for (llentry_t *de = llist_head(td->columns); de != NULL; de = de->next) {
398 data_definition_t *dd = de->value;
400 if (!dd->is_instance) {
401 if (CHECK_DD_TYPE(dd, vl->plugin, vl->plugin_instance, vl->type,
402 vl->type_instance)) {
403 snmp_agent_table_row_remove(td, vl->plugin_instance);
413 static void snmp_agent_free_data(data_definition_t **dd) {
415 if (dd == NULL || *dd == NULL)
418 /* unregister scalar type OID */
419 if ((*dd)->table == NULL) {
420 for (size_t i = 0; i < (*dd)->oids_len; i++)
421 unregister_mib((*dd)->oids[i].oid, (*dd)->oids[i].oid_len);
425 sfree((*dd)->plugin);
426 sfree((*dd)->plugin_instance);
428 sfree((*dd)->type_instance);
436 static void snmp_agent_free_table_columns(table_definition_t *td) {
437 if (td->columns == NULL)
440 for (llentry_t *de = llist_head(td->columns); de != NULL; de = de->next) {
441 data_definition_t *dd = de->value;
443 if (td->index_oid.oid_len) {
447 c_avl_iterator_t *iter = c_avl_get_iterator(td->index_instance);
448 while (c_avl_iterator_next(iter, (void *)&index, (void *)&instance) ==
450 for (size_t i = 0; i < dd->oids_len; i++)
451 snmp_agent_unregister_oid_index(&dd->oids[i], *index);
453 c_avl_iterator_destroy(iter);
457 c_avl_iterator_t *iter = c_avl_get_iterator(dd->table->instance_index);
458 while (c_avl_iterator_next(iter, (void *)&instance, (void *)&instance) ==
460 for (size_t i = 0; i < dd->oids_len; i++)
461 snmp_agent_unregister_oid_string(&dd->oids[i], instance);
463 c_avl_iterator_destroy(iter);
466 snmp_agent_free_data(&dd);
469 llist_destroy(td->columns);
471 } /* void snmp_agent_free_table_columns */
473 static void snmp_agent_free_table(table_definition_t **td) {
475 if (td == NULL || *td == NULL)
478 if ((*td)->size_oid.oid_len)
479 unregister_mib((*td)->size_oid.oid, (*td)->size_oid.oid_len);
481 /* Unregister Index OIDs */
482 if ((*td)->index_oid.oid_len) {
486 c_avl_iterator_t *iter = c_avl_get_iterator((*td)->index_instance);
487 while (c_avl_iterator_next(iter, (void *)&index, (void *)&instance) == 0)
488 snmp_agent_unregister_oid_index(&(*td)->index_oid, *index);
490 c_avl_iterator_destroy(iter);
493 /* Unregister all table columns and their registered OIDs */
494 snmp_agent_free_table_columns(*td);
499 /* index_instance and instance_index contain the same pointers */
500 c_avl_destroy((*td)->index_instance);
501 (*td)->index_instance = NULL;
503 if ((*td)->instance_index != NULL) {
504 while (c_avl_pick((*td)->instance_index, &key, &value) == 0) {
509 c_avl_destroy((*td)->instance_index);
510 (*td)->instance_index = NULL;
519 static int snmp_agent_form_reply(struct netsnmp_request_info_s *requests,
520 data_definition_t *dd, char *instance,
522 char name[DATA_MAX_NAME_LEN];
523 format_name(name, sizeof(name), hostname_g, dd->plugin,
524 instance ? instance : dd->plugin_instance, dd->type,
526 DEBUG(PLUGIN_NAME ": Identifier '%s'", name);
530 const data_set_t *ds = plugin_get_ds(dd->type);
532 ERROR(PLUGIN_NAME ": Data set not found for '%s' type", dd->type);
533 return SNMP_NOSUCHINSTANCE;
536 int ret = uc_get_value_by_name(name, &values, &values_num);
539 ERROR(PLUGIN_NAME ": Failed to get value for '%s'", name);
540 return SNMP_NOSUCHINSTANCE;
543 assert(ds->ds_num == values_num);
544 assert(oid_index < (int)values_num);
546 char data[DATA_MAX_NAME_LEN];
547 size_t data_len = sizeof(data);
548 ret = snmp_agent_set_vardata(
549 data, &data_len, dd->oids[oid_index].type, dd->scale, dd->shift,
550 &values[oid_index], sizeof(values[oid_index]), ds->ds[oid_index].type);
555 ERROR(PLUGIN_NAME ": Failed to convert '%s' value to snmp data", name);
556 return SNMP_NOSUCHINSTANCE;
559 requests->requestvb->type = dd->oids[oid_index].type;
560 snmp_set_var_typed_value(requests->requestvb, requests->requestvb->type,
561 (const u_char *)data, data_len);
563 return SNMP_ERR_NOERROR;
567 snmp_agent_table_oid_handler(struct netsnmp_mib_handler_s *handler,
568 struct netsnmp_handler_registration_s *reginfo,
569 struct netsnmp_agent_request_info_s *reqinfo,
570 struct netsnmp_request_info_s *requests) {
572 if (reqinfo->mode != MODE_GET && reqinfo->mode != MODE_GETNEXT) {
573 DEBUG(PLUGIN_NAME ": Not supported request mode (%d)", reqinfo->mode);
574 return SNMP_ERR_NOERROR;
577 pthread_mutex_lock(&g_agent->lock);
580 memcpy(oid.oid, requests->requestvb->name,
581 sizeof(oid.oid[0]) * requests->requestvb->name_length);
582 oid.oid_len = requests->requestvb->name_length;
585 char oid_str[DATA_MAX_NAME_LEN];
586 snmp_agent_oid_to_string(oid_str, sizeof(oid_str), &oid);
587 DEBUG(PLUGIN_NAME ": Get request received for table OID '%s'", oid_str);
590 for (llentry_t *te = llist_head(g_agent->tables); te != NULL; te = te->next) {
591 table_definition_t *td = te->value;
593 for (llentry_t *de = llist_head(td->columns); de != NULL; de = de->next) {
594 data_definition_t *dd = de->value;
596 for (size_t i = 0; i < dd->oids_len; i++) {
597 int ret = snmp_oid_ncompare(oid.oid, oid.oid_len, dd->oids[i].oid,
599 MIN(oid.oid_len, dd->oids[i].oid_len));
605 if (!td->index_oid.oid_len) {
606 char key[MAX_OID_LEN];
608 memset(key, 0, sizeof(key));
609 snmp_agent_generate_oid2string(
610 &oid, MIN(oid.oid_len, dd->oids[i].oid_len), key);
612 ret = c_avl_get(td->instance_index, key, (void **)&instance);
614 DEBUG(PLUGIN_NAME ": Nonexisting index string '%s' requested", key);
615 pthread_mutex_unlock(&g_agent->lock);
616 return SNMP_NOSUCHINSTANCE;
619 int index = oid.oid[oid.oid_len - 1];
621 ret = c_avl_get(td->index_instance, &index, (void **)&instance);
623 DEBUG(PLUGIN_NAME ": Nonexisting index '%d' requested", index);
624 pthread_mutex_unlock(&g_agent->lock);
625 return SNMP_NOSUCHINSTANCE;
629 if (dd->is_instance) {
630 requests->requestvb->type = ASN_OCTET_STR;
631 snmp_set_var_typed_value(requests->requestvb,
632 requests->requestvb->type, (const u_char *)instance,
635 pthread_mutex_unlock(&g_agent->lock);
637 return SNMP_ERR_NOERROR;
640 ret = snmp_agent_form_reply(requests, dd, instance, i);
642 pthread_mutex_unlock(&g_agent->lock);
649 pthread_mutex_unlock(&g_agent->lock);
651 return SNMP_NOSUCHINSTANCE;
654 static int snmp_agent_table_index_oid_handler(
655 struct netsnmp_mib_handler_s *handler,
656 struct netsnmp_handler_registration_s *reginfo,
657 struct netsnmp_agent_request_info_s *reqinfo,
658 struct netsnmp_request_info_s *requests) {
660 if (reqinfo->mode != MODE_GET && reqinfo->mode != MODE_GETNEXT) {
661 DEBUG(PLUGIN_NAME ": Not supported request mode (%d)", reqinfo->mode);
662 return SNMP_ERR_NOERROR;
665 pthread_mutex_lock(&g_agent->lock);
668 memcpy(oid.oid, requests->requestvb->name,
669 sizeof(oid.oid[0]) * requests->requestvb->name_length);
670 oid.oid_len = requests->requestvb->name_length;
672 for (llentry_t *te = llist_head(g_agent->tables); te != NULL; te = te->next) {
673 table_definition_t *td = te->value;
675 if (td->index_oid.oid_len &&
676 (snmp_oid_ncompare(oid.oid, oid.oid_len, td->index_oid.oid,
677 td->index_oid.oid_len,
678 MIN(oid.oid_len, td->index_oid.oid_len)) == 0)) {
680 DEBUG(PLUGIN_NAME ": Handle '%s' table index OID", td->name);
682 int index = oid.oid[oid.oid_len - 1];
684 int ret = c_avl_get(td->index_instance, &index, &(void *){NULL});
686 /* nonexisting index requested */
687 pthread_mutex_unlock(&g_agent->lock);
688 return SNMP_NOSUCHINSTANCE;
691 requests->requestvb->type = ASN_INTEGER;
692 snmp_set_var_typed_value(requests->requestvb, requests->requestvb->type,
693 (const u_char *)&index, sizeof(index));
695 pthread_mutex_unlock(&g_agent->lock);
697 return SNMP_ERR_NOERROR;
701 pthread_mutex_unlock(&g_agent->lock);
703 return SNMP_NOSUCHINSTANCE;
706 static int snmp_agent_table_size_oid_handler(
707 struct netsnmp_mib_handler_s *handler,
708 struct netsnmp_handler_registration_s *reginfo,
709 struct netsnmp_agent_request_info_s *reqinfo,
710 struct netsnmp_request_info_s *requests) {
712 if (reqinfo->mode != MODE_GET && reqinfo->mode != MODE_GETNEXT) {
713 DEBUG(PLUGIN_NAME ": Not supported request mode (%d)", reqinfo->mode);
714 return SNMP_ERR_NOERROR;
717 pthread_mutex_lock(&g_agent->lock);
720 memcpy(oid.oid, requests->requestvb->name,
721 sizeof(oid.oid[0]) * requests->requestvb->name_length);
722 oid.oid_len = requests->requestvb->name_length;
724 DEBUG(PLUGIN_NAME ": Get request received for table size OID");
726 for (llentry_t *te = llist_head(g_agent->tables); te != NULL; te = te->next) {
727 table_definition_t *td = te->value;
729 if (td->size_oid.oid_len &&
730 (snmp_oid_ncompare(oid.oid, oid.oid_len, td->size_oid.oid,
731 td->size_oid.oid_len,
732 MIN(oid.oid_len, td->size_oid.oid_len)) == 0)) {
733 DEBUG(PLUGIN_NAME ": Handle '%s' table size OID", td->name);
735 long size = c_avl_size(td->index_instance);
737 requests->requestvb->type = td->size_oid.type;
738 snmp_set_var_typed_value(requests->requestvb, requests->requestvb->type,
739 (const u_char *)&size, sizeof(size));
741 pthread_mutex_unlock(&g_agent->lock);
743 return SNMP_ERR_NOERROR;
747 pthread_mutex_unlock(&g_agent->lock);
749 return SNMP_NOSUCHINSTANCE;
753 snmp_agent_scalar_oid_handler(struct netsnmp_mib_handler_s *handler,
754 struct netsnmp_handler_registration_s *reginfo,
755 struct netsnmp_agent_request_info_s *reqinfo,
756 struct netsnmp_request_info_s *requests) {
758 if (reqinfo->mode != MODE_GET && reqinfo->mode != MODE_GETNEXT) {
759 DEBUG(PLUGIN_NAME ": Not supported request mode (%d)", reqinfo->mode);
760 return SNMP_ERR_NOERROR;
763 pthread_mutex_lock(&g_agent->lock);
766 memcpy(oid.oid, requests->requestvb->name,
767 sizeof(oid.oid[0]) * requests->requestvb->name_length);
768 oid.oid_len = requests->requestvb->name_length;
771 char oid_str[DATA_MAX_NAME_LEN];
772 snmp_agent_oid_to_string(oid_str, sizeof(oid_str), &oid);
773 DEBUG(PLUGIN_NAME ": Get request received for scalar OID '%s'", oid_str);
776 for (llentry_t *de = llist_head(g_agent->scalars); de != NULL;
778 data_definition_t *dd = de->value;
780 for (size_t i = 0; i < dd->oids_len; i++) {
782 int ret = snmp_oid_compare(oid.oid, oid.oid_len, dd->oids[i].oid,
783 dd->oids[i].oid_len);
787 ret = snmp_agent_form_reply(requests, dd, NULL, i);
789 pthread_mutex_unlock(&g_agent->lock);
795 pthread_mutex_unlock(&g_agent->lock);
797 return SNMP_NOSUCHINSTANCE;
800 static int snmp_agent_register_table_oids(void) {
802 for (llentry_t *te = llist_head(g_agent->tables); te != NULL; te = te->next) {
803 table_definition_t *td = te->value;
805 if (td->size_oid.oid_len != 0) {
807 snmp_agent_get_asn_type(td->size_oid.oid, td->size_oid.oid_len);
808 td->size_oid.oid_len++;
809 int ret = snmp_agent_register_oid(&td->size_oid,
810 snmp_agent_table_size_oid_handler);
815 for (llentry_t *de = llist_head(td->columns); de != NULL; de = de->next) {
816 data_definition_t *dd = de->value;
818 for (size_t i = 0; i < dd->oids_len; i++) {
820 snmp_agent_get_asn_type(dd->oids[i].oid, dd->oids[i].oid_len);
828 static int snmp_agent_register_scalar_oids(void) {
830 for (llentry_t *e = llist_head(g_agent->scalars); e != NULL; e = e->next) {
831 data_definition_t *dd = e->value;
833 for (size_t i = 0; i < dd->oids_len; i++) {
836 snmp_agent_get_asn_type(dd->oids[i].oid, dd->oids[i].oid_len);
839 snmp_agent_register_oid(&dd->oids[i], snmp_agent_scalar_oid_handler);
848 static int snmp_agent_config_data_oids(data_definition_t *dd,
849 oconfig_item_t *ci) {
850 if (ci->values_num < 1) {
851 WARNING(PLUGIN_NAME ": `OIDs' needs at least one argument");
855 for (int i = 0; i < ci->values_num; i++)
856 if (ci->values[i].type != OCONFIG_TYPE_STRING) {
857 WARNING(PLUGIN_NAME ": `OIDs' needs only string argument");
861 if (dd->oids != NULL)
864 dd->oids = calloc(ci->values_num, sizeof(*dd->oids));
865 if (dd->oids == NULL)
867 dd->oids_len = (size_t)ci->values_num;
869 for (int i = 0; i < ci->values_num; i++) {
870 dd->oids[i].oid_len = MAX_OID_LEN;
872 if (NULL == snmp_parse_oid(ci->values[i].value.string, dd->oids[i].oid,
873 &dd->oids[i].oid_len)) {
874 ERROR(PLUGIN_NAME ": snmp_parse_oid (%s) failed",
875 ci->values[i].value.string);
885 static int snmp_agent_config_table_size_oid(table_definition_t *td,
886 oconfig_item_t *ci) {
887 if (ci->values_num < 1) {
888 WARNING(PLUGIN_NAME ": `TableSizeOID' is empty");
892 if (ci->values[0].type != OCONFIG_TYPE_STRING) {
893 WARNING(PLUGIN_NAME ": `TableSizeOID' needs only string argument");
897 td->size_oid.oid_len = MAX_OID_LEN;
899 if (NULL == snmp_parse_oid(ci->values[0].value.string, td->size_oid.oid,
900 &td->size_oid.oid_len)) {
901 ERROR(PLUGIN_NAME ": Failed to parse table size OID (%s)",
902 ci->values[0].value.string);
903 td->size_oid.oid_len = 0;
910 static int snmp_agent_config_table_index_oid(table_definition_t *td,
911 oconfig_item_t *ci) {
913 if (ci->values_num < 1) {
914 WARNING(PLUGIN_NAME ": `IndexOID' is empty");
918 if (ci->values[0].type != OCONFIG_TYPE_STRING) {
919 WARNING(PLUGIN_NAME ": `IndexOID' needs only string argument");
923 td->index_oid.oid_len = MAX_OID_LEN;
925 if (NULL == snmp_parse_oid(ci->values[0].value.string, td->index_oid.oid,
926 &td->index_oid.oid_len)) {
927 ERROR(PLUGIN_NAME ": Failed to parse table index OID (%s)",
928 ci->values[0].value.string);
929 td->index_oid.oid_len = 0;
936 static int snmp_agent_config_table_data(table_definition_t *td,
937 oconfig_item_t *ci) {
938 data_definition_t *dd;
943 dd = calloc(1, sizeof(*dd));
945 ERROR(PLUGIN_NAME ": Failed to allocate memory for table data definition");
949 ret = cf_util_get_string(ci, &dd->name);
960 for (int i = 0; i < ci->children_num; i++) {
961 oconfig_item_t *option = ci->children + i;
963 if (strcasecmp("Instance", option->key) == 0)
964 ret = cf_util_get_boolean(option, &dd->is_instance);
965 else if (strcasecmp("Plugin", option->key) == 0)
966 ret = cf_util_get_string(option, &dd->plugin);
967 else if (strcasecmp("PluginInstance", option->key) == 0)
968 ret = cf_util_get_string(option, &dd->plugin_instance);
969 else if (strcasecmp("Type", option->key) == 0)
970 ret = cf_util_get_string(option, &dd->type);
971 else if (strcasecmp("TypeInstance", option->key) == 0)
972 ret = cf_util_get_string(option, &dd->type_instance);
973 else if (strcasecmp("Shift", option->key) == 0)
974 ret = cf_util_get_double(option, &dd->shift);
975 else if (strcasecmp("Scale", option->key) == 0)
976 ret = cf_util_get_double(option, &dd->scale);
977 else if (strcasecmp("OIDs", option->key) == 0)
978 ret = snmp_agent_config_data_oids(dd, option);
980 WARNING(PLUGIN_NAME ": Option `%s' not allowed here", option->key);
985 snmp_agent_free_data(&dd);
990 llentry_t *entry = llentry_create(dd->name, dd);
992 snmp_agent_free_data(&dd);
996 llist_append(td->columns, entry);
1001 static int snmp_agent_config_data(oconfig_item_t *ci) {
1002 data_definition_t *dd;
1007 dd = calloc(1, sizeof(*dd));
1009 ERROR(PLUGIN_NAME ": Failed to allocate memory for data definition");
1013 ret = cf_util_get_string(ci, &dd->name);
1022 for (int i = 0; i < ci->children_num; i++) {
1023 oconfig_item_t *option = ci->children + i;
1025 if (strcasecmp("Instance", option->key) == 0)
1026 ret = cf_util_get_boolean(option, &dd->is_instance);
1027 else if (strcasecmp("Plugin", option->key) == 0)
1028 ret = cf_util_get_string(option, &dd->plugin);
1029 else if (strcasecmp("PluginInstance", option->key) == 0)
1030 ret = cf_util_get_string(option, &dd->plugin_instance);
1031 else if (strcasecmp("Type", option->key) == 0)
1032 ret = cf_util_get_string(option, &dd->type);
1033 else if (strcasecmp("TypeInstance", option->key) == 0)
1034 ret = cf_util_get_string(option, &dd->type_instance);
1035 else if (strcasecmp("Shift", option->key) == 0)
1036 ret = cf_util_get_double(option, &dd->shift);
1037 else if (strcasecmp("Scale", option->key) == 0)
1038 ret = cf_util_get_double(option, &dd->scale);
1039 else if (strcasecmp("OIDs", option->key) == 0)
1040 ret = snmp_agent_config_data_oids(dd, option);
1042 WARNING(PLUGIN_NAME ": Option `%s' not allowed here", option->key);
1047 snmp_agent_free_data(&dd);
1052 llentry_t *entry = llentry_create(dd->name, dd);
1053 if (entry == NULL) {
1054 snmp_agent_free_data(&dd);
1058 llist_append(g_agent->scalars, entry);
1063 static int num_compare(const int *a, const int *b) {
1064 assert((a != NULL) && (b != NULL));
1073 static int snmp_agent_config_table(oconfig_item_t *ci) {
1074 table_definition_t *td;
1079 td = calloc(1, sizeof(*td));
1081 ERROR(PLUGIN_NAME ": Failed to allocate memory for table definition");
1085 ret = cf_util_get_string(ci, &td->name);
1091 td->columns = llist_create();
1092 if (td->columns == NULL) {
1093 ERROR(PLUGIN_NAME ": Failed to allocate memory for columns list");
1094 snmp_agent_free_table(&td);
1098 for (int i = 0; i < ci->children_num; i++) {
1099 oconfig_item_t *option = ci->children + i;
1101 if (strcasecmp("IndexOID", option->key) == 0)
1102 ret = snmp_agent_config_table_index_oid(td, option);
1103 else if (strcasecmp("SizeOID", option->key) == 0)
1104 ret = snmp_agent_config_table_size_oid(td, option);
1105 else if (strcasecmp("Data", option->key) == 0)
1106 ret = snmp_agent_config_table_data(td, option);
1108 WARNING(PLUGIN_NAME ": Option `%s' not allowed here", option->key);
1113 snmp_agent_free_table(&td);
1118 llentry_t *entry = llentry_create(td->name, td);
1119 if (entry == NULL) {
1120 snmp_agent_free_table(&td);
1124 td->instance_index =
1125 c_avl_create((int (*)(const void *, const void *))strcmp);
1126 if (td->instance_index == NULL) {
1127 snmp_agent_free_table(&td);
1131 td->index_instance =
1132 c_avl_create((int (*)(const void *, const void *))num_compare);
1133 if (td->index_instance == NULL) {
1134 snmp_agent_free_table(&td);
1138 llist_append(g_agent->tables, entry);
1143 static int snmp_agent_get_value_from_ds_type(const value_t *val, int type,
1144 double scale, double shift,
1147 case DS_TYPE_COUNTER:
1148 *value = (long)((val->counter * scale) + shift);
1150 case DS_TYPE_ABSOLUTE:
1151 *value = (long)((val->absolute * scale) + shift);
1153 case DS_TYPE_DERIVE:
1154 *value = (long)((val->derive * scale) + shift);
1157 *value = (long)((val->gauge * scale) + shift);
1162 ERROR(PLUGIN_NAME ": Unknown data source type: %i", type);
1169 static int snmp_agent_set_vardata(void *data, size_t *data_len, u_char asn_type,
1170 double scale, double shift, const void *value,
1171 size_t len, int type) {
1174 netsnmp_vardata var;
1179 var.string = (u_char *)data;
1181 ret = snmp_agent_get_value_from_ds_type(val, type, scale, shift, &new_value);
1191 if (*data_len < sizeof(*var.integer))
1193 *var.integer = new_value;
1194 *data_len = sizeof(*var.integer);
1197 if (*data_len < sizeof(*var.counter64))
1199 var.counter64->high = (u_long)((int64_t)new_value >> 32);
1200 var.counter64->low = (u_long)((int64_t)new_value & 0xFFFFFFFF);
1201 *data_len = sizeof(*var.counter64);
1204 if (type == DS_TYPE_GAUGE) {
1205 char buf[DATA_MAX_NAME_LEN];
1206 snprintf(buf, sizeof(buf), "%.2f", val->gauge);
1207 if (*data_len < strlen(buf))
1209 *data_len = strlen(buf);
1210 memcpy(var.string, buf, *data_len);
1212 ERROR(PLUGIN_NAME ": Failed to convert %d ds type to %d asn type", type,
1218 ERROR(PLUGIN_NAME ": Failed to convert %d ds type to %d asn type", type,
1226 static int snmp_agent_register_oid_index(oid_t *oid, int index,
1227 Netsnmp_Node_Handler *handler) {
1229 memcpy(&new_oid, oid, sizeof(*oid));
1230 new_oid.oid[new_oid.oid_len++] = index;
1231 return snmp_agent_register_oid(&new_oid, handler);
1234 static int snmp_agent_unregister_oid_index(oid_t *oid, int index) {
1236 memcpy(&new_oid, oid, sizeof(*oid));
1237 new_oid.oid[new_oid.oid_len++] = index;
1238 return unregister_mib(new_oid.oid, new_oid.oid_len);
1241 static int snmp_agent_update_index(table_definition_t *td,
1242 const char *instance) {
1244 if (c_avl_get(td->instance_index, instance, NULL) == 0)
1251 ins = strdup(instance);
1255 /* need to generate index for the table */
1256 if (td->index_oid.oid_len) {
1257 index = calloc(1, sizeof(*index));
1258 if (index == NULL) {
1263 *index = c_avl_size(td->instance_index) + 1;
1265 ret = c_avl_insert(td->instance_index, ins, index);
1272 ret = c_avl_insert(td->index_instance, index, ins);
1274 DEBUG(PLUGIN_NAME ": Failed to update index_instance for '%s' table",
1276 c_avl_remove(td->instance_index, ins, NULL, (void **)&index);
1282 ret = snmp_agent_register_oid_index(&td->index_oid, *index,
1283 snmp_agent_table_index_oid_handler);
1287 /* instance as a key is required for any table */
1288 ret = c_avl_insert(td->instance_index, ins, ins);
1295 /* register new oids for all columns */
1296 for (llentry_t *de = llist_head(td->columns); de != NULL; de = de->next) {
1297 data_definition_t *dd = de->value;
1299 for (size_t i = 0; i < dd->oids_len; i++) {
1300 if (td->index_oid.oid_len) {
1301 ret = snmp_agent_register_oid_index(&dd->oids[i], *index,
1302 snmp_agent_table_oid_handler);
1304 ret = snmp_agent_register_oid_string(&dd->oids[i], ins,
1305 snmp_agent_table_oid_handler);
1313 DEBUG(PLUGIN_NAME ": Updated index for '%s' table [%d, %s]", td->name,
1314 (index != NULL) ? *index : -1, ins);
1316 notification_t n = {
1317 .severity = NOTIF_OKAY, .time = cdtime(), .plugin = PLUGIN_NAME};
1318 sstrncpy(n.host, hostname_g, sizeof(n.host));
1319 sstrncpy(n.plugin_instance, ins, sizeof(n.plugin_instance));
1320 ssnprintf(n.message, sizeof(n.message),
1321 "Data row added to table %s instance %s index %d", td->name, ins,
1322 (index != NULL) ? *index : -1);
1323 plugin_dispatch_notification(&n);
1328 static int snmp_agent_write(value_list_t const *vl) {
1333 for (llentry_t *te = llist_head(g_agent->tables); te != NULL; te = te->next) {
1334 table_definition_t *td = te->value;
1336 for (llentry_t *de = llist_head(td->columns); de != NULL; de = de->next) {
1337 data_definition_t *dd = de->value;
1339 if (!dd->is_instance) {
1340 if (CHECK_DD_TYPE(dd, vl->plugin, vl->plugin_instance, vl->type,
1341 vl->type_instance)) {
1342 snmp_agent_update_index(td, vl->plugin_instance);
1352 static int snmp_agent_collect(const data_set_t *ds, const value_list_t *vl,
1353 user_data_t __attribute__((unused)) * user_data) {
1355 pthread_mutex_lock(&g_agent->lock);
1357 snmp_agent_write(vl);
1359 pthread_mutex_unlock(&g_agent->lock);
1364 static int snmp_agent_preinit(void) {
1365 if (g_agent != NULL) {
1366 /* already initialized if config callback was called before init callback */
1370 g_agent = calloc(1, sizeof(*g_agent));
1371 if (g_agent == NULL) {
1372 ERROR(PLUGIN_NAME ": Failed to allocate memory for snmp agent context");
1376 g_agent->tables = llist_create();
1377 g_agent->scalars = llist_create();
1379 if (g_agent->tables == NULL || g_agent->scalars == NULL) {
1380 ERROR(PLUGIN_NAME ": llist_create() failed");
1381 llist_destroy(g_agent->scalars);
1382 llist_destroy(g_agent->tables);
1387 /* make us a agentx client. */
1388 err = netsnmp_ds_set_boolean(NETSNMP_DS_APPLICATION_ID, NETSNMP_DS_AGENT_ROLE,
1391 ERROR(PLUGIN_NAME ": Failed to set agent role (%d)", err);
1392 llist_destroy(g_agent->scalars);
1393 llist_destroy(g_agent->tables);
1398 * For SNMP debug purposes uses snmp_set_do_debugging(1);
1401 /* initialize the agent library */
1402 err = init_agent(PLUGIN_NAME);
1404 ERROR(PLUGIN_NAME ": Failed to initialize the agent library (%d)", err);
1405 llist_destroy(g_agent->scalars);
1406 llist_destroy(g_agent->tables);
1410 init_snmp(PLUGIN_NAME);
1412 g_agent->tp = read_all_mibs();
1417 static int snmp_agent_init(void) {
1420 ret = snmp_agent_preinit();
1424 ret = snmp_agent_register_scalar_oids();
1428 ret = snmp_agent_register_table_oids();
1432 ret = pthread_mutex_init(&g_agent->lock, NULL);
1434 ERROR(PLUGIN_NAME ": Failed to initialize mutex, err %u", ret);
1438 ret = pthread_mutex_init(&g_agent->agentx_lock, NULL);
1440 ERROR(PLUGIN_NAME ": Failed to initialize AgentX mutex, err %u", ret);
1444 /* create a second thread to listen for requests from AgentX*/
1445 ret = pthread_create(&g_agent->thread, NULL, &snmp_agent_thread_run, NULL);
1447 ERROR(PLUGIN_NAME ": Failed to create a separate thread, err %u", ret);
1454 static void *snmp_agent_thread_run(void __attribute__((unused)) * arg) {
1455 INFO(PLUGIN_NAME ": Thread is up and running");
1458 pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, NULL);
1460 pthread_mutex_lock(&g_agent->agentx_lock);
1461 agent_check_and_process(0); /* 0 == don't block */
1462 pthread_mutex_unlock(&g_agent->agentx_lock);
1464 pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL);
1471 static int snmp_agent_register_oid(oid_t *oid, Netsnmp_Node_Handler *handler) {
1472 netsnmp_handler_registration *reg;
1473 char *oid_name = snmp_agent_get_oid_name(oid->oid, oid->oid_len - 1);
1474 char oid_str[DATA_MAX_NAME_LEN];
1476 snmp_agent_oid_to_string(oid_str, sizeof(oid_str), oid);
1478 if (oid_name == NULL) {
1480 ": Skipped registration: OID (%s) is not found in main tree",
1485 reg = netsnmp_create_handler_registration(oid_name, handler, oid->oid,
1486 oid->oid_len, HANDLER_CAN_RONLY);
1488 ERROR(PLUGIN_NAME ": Failed to create handler registration for OID (%s)",
1493 pthread_mutex_lock(&g_agent->agentx_lock);
1495 if (netsnmp_register_instance(reg) != MIB_REGISTERED_OK) {
1496 ERROR(PLUGIN_NAME ": Failed to register handler for OID (%s)", oid_str);
1497 pthread_mutex_unlock(&g_agent->agentx_lock);
1501 pthread_mutex_unlock(&g_agent->agentx_lock);
1503 DEBUG(PLUGIN_NAME ": Registered handler for OID (%s)", oid_str);
1508 static int snmp_agent_free_config(void) {
1510 if (g_agent == NULL)
1513 for (llentry_t *te = llist_head(g_agent->tables); te != NULL; te = te->next)
1514 snmp_agent_free_table((table_definition_t **)&te->value);
1515 llist_destroy(g_agent->tables);
1517 for (llentry_t *de = llist_head(g_agent->scalars); de != NULL; de = de->next)
1518 snmp_agent_free_data((data_definition_t **)&de->value);
1519 llist_destroy(g_agent->scalars);
1524 static int snmp_agent_shutdown(void) {
1527 DEBUG(PLUGIN_NAME ": snmp_agent_shutdown");
1529 if (g_agent == NULL) {
1530 ERROR(PLUGIN_NAME ": snmp_agent_shutdown: plugin not initialized");
1534 if (pthread_cancel(g_agent->thread) != 0)
1535 ERROR(PLUGIN_NAME ": snmp_agent_shutdown: failed to cancel the thread");
1537 if (pthread_join(g_agent->thread, NULL) != 0)
1538 ERROR(PLUGIN_NAME ": snmp_agent_shutdown: failed to join the thread");
1540 snmp_agent_free_config();
1542 snmp_shutdown(PLUGIN_NAME);
1544 pthread_mutex_destroy(&g_agent->lock);
1545 pthread_mutex_destroy(&g_agent->agentx_lock);
1552 static int snmp_agent_config(oconfig_item_t *ci) {
1554 int ret = snmp_agent_preinit();
1561 for (int i = 0; i < ci->children_num; i++) {
1562 oconfig_item_t *child = ci->children + i;
1563 if (strcasecmp("Data", child->key) == 0) {
1564 ret = snmp_agent_config_data(child);
1565 } else if (strcasecmp("Table", child->key) == 0) {
1566 ret = snmp_agent_config_table(child);
1568 ERROR(PLUGIN_NAME ": Unknown configuration option `%s'", child->key);
1573 ERROR(PLUGIN_NAME ": Failed to parse configuration");
1574 snmp_agent_free_config();
1575 snmp_shutdown(PLUGIN_NAME);
1581 ret = snmp_agent_validate_data();
1583 ERROR(PLUGIN_NAME ": Invalid configuration provided");
1584 snmp_agent_free_config();
1585 snmp_shutdown(PLUGIN_NAME);
1593 void module_register(void) {
1594 plugin_register_init(PLUGIN_NAME, snmp_agent_init);
1595 plugin_register_complex_config(PLUGIN_NAME, snmp_agent_config);
1596 plugin_register_write(PLUGIN_NAME, snmp_agent_collect, NULL);
1597 plugin_register_missing(PLUGIN_NAME, snmp_agent_clear_missing, NULL);
1598 plugin_register_shutdown(PLUGIN_NAME, snmp_agent_shutdown);