2 * collectd - src/modbus.c
3 * Copyright (C) 2010,2011 noris network AG
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU Lesser General Public License as published by
7 * the Free Software Foundation; only version 2.1 of the License is
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public License
16 * along with this program; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 * Florian Forster <octo at noris.net>
26 #include "configfile.h"
32 #ifndef LIBMODBUS_VERSION_CHECK
33 /* Assume version 2.0.3 */
34 # define LEGACY_LIBMODBUS 1
36 /* Assume version 2.9.2 */
39 #ifndef MODBUS_TCP_DEFAULT_PORT
40 # ifdef MODBUS_TCP_PORT
41 # define MODBUS_TCP_DEFAULT_PORT MODBUS_TCP_PORT
43 # define MODBUS_TCP_DEFAULT_PORT 502
61 * Instance "foobar" # optional
70 enum mb_register_type_e /* {{{ */
78 typedef enum mb_register_type_e mb_register_type_t;
81 typedef struct mb_data_s mb_data_t;
82 struct mb_data_s /* {{{ */
86 mb_register_type_t register_type;
87 char type[DATA_MAX_NAME_LEN];
88 char instance[DATA_MAX_NAME_LEN];
93 struct mb_slave_s /* {{{ */
96 char instance[DATA_MAX_NAME_LEN];
99 typedef struct mb_slave_s mb_slave_t;
101 struct mb_host_s /* {{{ */
103 char host[DATA_MAX_NAME_LEN];
104 char node[NI_MAXHOST];
105 /* char service[NI_MAXSERV]; */
113 modbus_param_t connection;
115 modbus_t *connection;
119 typedef struct mb_host_s mb_host_t;
121 struct mb_data_group_s;
122 typedef struct mb_data_group_s mb_data_group_t;
123 struct mb_data_group_s /* {{{ */
125 mb_data_t *registers;
126 size_t registers_num;
128 mb_data_group_t *next;
134 static mb_data_t *data_definitions = NULL;
139 static mb_data_t *data_get_by_name (mb_data_t *src, /* {{{ */
147 for (ptr = src; ptr != NULL; ptr = ptr->next)
148 if (strcasecmp (ptr->name, name) == 0)
152 } /* }}} mb_data_t *data_get_by_name */
154 static int data_append (mb_data_t **dst, mb_data_t *src) /* {{{ */
158 if ((dst == NULL) || (src == NULL))
169 while (ptr->next != NULL)
175 } /* }}} int data_append */
177 /* Copy a single mb_data_t and append it to another list. */
178 static int data_copy (mb_data_t **dst, const mb_data_t *src) /* {{{ */
183 if ((dst == NULL) || (src == NULL))
186 tmp = malloc (sizeof (*tmp));
189 memcpy (tmp, src, sizeof (*tmp));
193 tmp->name = strdup (src->name);
194 if (tmp->name == NULL)
200 status = data_append (dst, tmp);
209 } /* }}} int data_copy */
211 /* Lookup a single mb_data_t instance, copy it and append the copy to another
213 static int data_copy_by_name (mb_data_t **dst, mb_data_t *src, /* {{{ */
218 if ((dst == NULL) || (src == NULL) || (name == NULL))
221 ptr = data_get_by_name (src, name);
225 return (data_copy (dst, ptr));
226 } /* }}} int data_copy_by_name */
230 static int mb_submit (mb_host_t *host, mb_slave_t *slave, /* {{{ */
231 mb_data_t *data, value_t value)
233 value_list_t vl = VALUE_LIST_INIT;
235 if ((host == NULL) || (slave == NULL) || (data == NULL))
238 if (host->interval <= 0)
239 host->interval = plugin_get_interval ();
241 if (slave->instance[0] == 0)
242 ssnprintf (slave->instance, sizeof (slave->instance), "slave_%i",
247 vl.interval = host->interval;
248 sstrncpy (vl.host, host->host, sizeof (vl.host));
249 sstrncpy (vl.plugin, "modbus", sizeof (vl.plugin));
250 sstrncpy (vl.plugin_instance, slave->instance, sizeof (vl.plugin_instance));
251 sstrncpy (vl.type, data->type, sizeof (vl.type));
252 sstrncpy (vl.type_instance, data->instance, sizeof (vl.type_instance));
254 return (plugin_dispatch_values (&vl));
255 } /* }}} int mb_submit */
257 static float mb_register_to_float (uint16_t hi, uint16_t lo) /* {{{ */
266 #if BYTE_ORDER == LITTLE_ENDIAN
268 conv.b[0] = lo & 0x00ff;
269 conv.b[1] = (lo >> 8) & 0x00ff;
270 conv.b[2] = hi & 0x00ff;
271 conv.b[3] = (hi >> 8) & 0x00ff;
273 conv.b[3] = lo & 0x00ff;
274 conv.b[2] = (lo >> 8) & 0x00ff;
275 conv.b[1] = hi & 0x00ff;
276 conv.b[0] = (hi >> 8) & 0x00ff;
280 } /* }}} float mb_register_to_float */
284 static int mb_init_connection (mb_host_t *host) /* {{{ */
292 modbus_set_debug (&host->connection, 1);
295 /* We'll do the error handling ourselves. */
296 modbus_set_error_handling (&host->connection, NOP_ON_ERROR);
298 if ((host->port < 1) || (host->port > 65535))
299 host->port = MODBUS_TCP_DEFAULT_PORT;
301 DEBUG ("Modbus plugin: Trying to connect to \"%s\", port %i.",
302 host->node, host->port);
304 modbus_init_tcp (&host->connection,
305 /* host = */ host->node,
306 /* port = */ host->port);
308 status = modbus_connect (&host->connection);
311 ERROR ("Modbus plugin: modbus_connect (%s, %i) failed with status %i.",
312 host->node, host->port, status);
316 host->is_connected = 1;
318 } /* }}} int mb_init_connection */
319 /* #endif LEGACY_LIBMODBUS */
321 #else /* if !LEGACY_LIBMODBUS */
323 static int mb_init_connection (mb_host_t *host) /* {{{ */
330 if (host->connection != NULL)
333 if ((host->port < 1) || (host->port > 65535))
334 host->port = MODBUS_TCP_DEFAULT_PORT;
336 DEBUG ("Modbus plugin: Trying to connect to \"%s\", port %i.",
337 host->node, host->port);
339 host->connection = modbus_new_tcp (host->node, host->port);
340 if (host->connection == NULL)
342 ERROR ("Modbus plugin: Creating new Modbus/TCP object failed.");
347 modbus_set_debug (host->connection, 1);
350 /* We'll do the error handling ourselves. */
351 modbus_set_error_recovery (host->connection, 0);
353 status = modbus_connect (host->connection);
356 ERROR ("Modbus plugin: modbus_connect (%s, %i) failed with status %i.",
357 host->node, host->port, status);
358 modbus_free (host->connection);
359 host->connection = NULL;
364 } /* }}} int mb_init_connection */
365 #endif /* !LEGACY_LIBMODBUS */
367 #define CAST_TO_VALUE_T(ds,vt,raw) do { \
368 if ((ds)->ds[0].type == DS_TYPE_COUNTER) \
369 (vt).counter = (counter_t) (raw); \
370 else if ((ds)->ds[0].type == DS_TYPE_GAUGE) \
371 (vt).gauge = (gauge_t) (raw); \
372 else if ((ds)->ds[0].type == DS_TYPE_DERIVE) \
373 (vt).derive = (derive_t) (raw); \
374 else /* if (ds->ds[0].type == DS_TYPE_ABSOLUTE) */ \
375 (vt).absolute = (absolute_t) (raw); \
378 static int mb_read_data (mb_host_t *host, mb_slave_t *slave, /* {{{ */
383 const data_set_t *ds;
386 if ((host == NULL) || (slave == NULL) || (data == NULL))
389 ds = plugin_get_ds (data->type);
392 ERROR ("Modbus plugin: Type \"%s\" is not defined.", data->type);
398 ERROR ("Modbus plugin: The type \"%s\" has %i data sources. "
399 "I can only handle data sets with only one data source.",
400 data->type, ds->ds_num);
404 if ((ds->ds[0].type != DS_TYPE_GAUGE)
405 && (data->register_type != REG_TYPE_INT32)
406 && (data->register_type != REG_TYPE_UINT32))
408 NOTICE ("Modbus plugin: The data source of type \"%s\" is %s, not gauge. "
409 "This will most likely result in problems, because the register type "
410 "is not UINT32.", data->type, DS_TYPE_TO_STRING (ds->ds[0].type));
413 memset (values, 0, sizeof (values));
414 if ((data->register_type == REG_TYPE_INT32)
415 || (data->register_type == REG_TYPE_UINT32)
416 || (data->register_type == REG_TYPE_FLOAT))
421 if (host->connection == NULL)
427 struct sockaddr sockaddr;
428 socklen_t saddrlen = sizeof (sockaddr);
430 status = getpeername (modbus_get_socket (host->connection),
431 &sockaddr, &saddrlen);
436 if ((status == EBADF) || (status == ENOTSOCK) || (status == ENOTCONN))
438 status = mb_init_connection (host);
441 ERROR ("Modbus plugin: mb_init_connection (%s/%s) failed. ",
442 host->host, host->node);
443 host->is_connected = 0;
444 host->connection = NULL;
448 else if (status != 0)
451 modbus_close (&host->connection);
453 modbus_close (host->connection);
454 modbus_free (host->connection);
459 /* Version 2.0.3: Pass the connection struct as a pointer and pass the slave
460 * id to each call of "read_holding_registers". */
461 # define modbus_read_registers(ctx, addr, nb, dest) \
462 read_holding_registers (&(ctx), slave->id, (addr), (nb), (dest))
463 #else /* if !LEGACY_LIBMODBUS */
464 /* Version 2.9.2: Set the slave id once before querying the registers. */
465 status = modbus_set_slave (host->connection, slave->id);
468 ERROR ("Modbus plugin: modbus_set_slave (%i) failed with status %i.",
474 status = modbus_read_registers (host->connection,
475 /* start_addr = */ data->register_base,
476 /* num_registers = */ values_num, /* buffer = */ values);
477 if (status != values_num)
479 ERROR ("Modbus plugin: modbus_read_registers (%s/%s) failed. status = %i, values_num = %i "
480 "Giving up.", host->host, host->node, status, values_num);
482 modbus_close (&host->connection);
484 modbus_close (host->connection);
485 modbus_free (host->connection);
487 host->connection = NULL;
491 DEBUG ("Modbus plugin: mb_read_data: Success! "
492 "modbus_read_registers returned with status %i.", status);
494 if (data->register_type == REG_TYPE_FLOAT)
499 float_value = mb_register_to_float (values[0], values[1]);
500 DEBUG ("Modbus plugin: mb_read_data: "
501 "Returned float value is %g", (double) float_value);
503 CAST_TO_VALUE_T (ds, vt, float_value);
504 mb_submit (host, slave, data, vt);
506 else if (data->register_type == REG_TYPE_INT32)
515 v.u32 = (((uint32_t) values[0]) << 16)
516 | ((uint32_t) values[1]);
517 DEBUG ("Modbus plugin: mb_read_data: "
518 "Returned int32 value is %"PRIi32, v.i32);
520 CAST_TO_VALUE_T (ds, vt, v.i32);
521 mb_submit (host, slave, data, vt);
523 else if (data->register_type == REG_TYPE_INT16)
534 DEBUG ("Modbus plugin: mb_read_data: "
535 "Returned int16 value is %"PRIi16, v.i16);
537 CAST_TO_VALUE_T (ds, vt, v.i16);
538 mb_submit (host, slave, data, vt);
540 else if (data->register_type == REG_TYPE_UINT32)
545 v32 = (((uint32_t) values[0]) << 16)
546 | ((uint32_t) values[1]);
547 DEBUG ("Modbus plugin: mb_read_data: "
548 "Returned uint32 value is %"PRIu32, v32);
550 CAST_TO_VALUE_T (ds, vt, v32);
551 mb_submit (host, slave, data, vt);
553 else /* if (data->register_type == REG_TYPE_UINT16) */
557 DEBUG ("Modbus plugin: mb_read_data: "
558 "Returned uint16 value is %"PRIu16, values[0]);
560 CAST_TO_VALUE_T (ds, vt, values[0]);
561 mb_submit (host, slave, data, vt);
565 } /* }}} int mb_read_data */
567 static int mb_read_slave (mb_host_t *host, mb_slave_t *slave) /* {{{ */
573 if ((host == NULL) || (slave == NULL))
577 for (data = slave->collect; data != NULL; data = data->next)
579 status = mb_read_data (host, slave, data);
588 } /* }}} int mb_read_slave */
590 static int mb_read (user_data_t *user_data) /* {{{ */
597 if ((user_data == NULL) || (user_data->data == NULL))
600 host = user_data->data;
603 for (i = 0; i < host->slaves_num; i++)
605 status = mb_read_slave (host, host->slaves + i);
614 } /* }}} int mb_read */
618 static void data_free_one (mb_data_t *data) /* {{{ */
625 } /* }}} void data_free_one */
627 static void data_free_all (mb_data_t *data) /* {{{ */
635 data_free_one (data);
637 data_free_all (next);
638 } /* }}} void data_free_all */
640 static void slaves_free_all (mb_slave_t *slaves, size_t slaves_num) /* {{{ */
647 for (i = 0; i < slaves_num; i++)
648 data_free_all (slaves[i].collect);
650 } /* }}} void slaves_free_all */
652 static void host_free (void *void_host) /* {{{ */
654 mb_host_t *host = void_host;
659 slaves_free_all (host->slaves, host->slaves_num);
661 } /* }}} void host_free */
663 /* Config functions */
665 static int mb_config_add_data (oconfig_item_t *ci) /* {{{ */
671 memset (&data, 0, sizeof (data));
673 data.register_type = REG_TYPE_UINT16;
676 status = cf_util_get_string (ci, &data.name);
680 for (i = 0; i < ci->children_num; i++)
682 oconfig_item_t *child = ci->children + i;
684 if (strcasecmp ("Type", child->key) == 0)
685 status = cf_util_get_string_buffer (child,
686 data.type, sizeof (data.type));
687 else if (strcasecmp ("Instance", child->key) == 0)
688 status = cf_util_get_string_buffer (child,
689 data.instance, sizeof (data.instance));
690 else if (strcasecmp ("RegisterBase", child->key) == 0)
691 status = cf_util_get_int (child, &data.register_base);
692 else if (strcasecmp ("RegisterType", child->key) == 0)
695 status = cf_util_get_string_buffer (child, tmp, sizeof (tmp));
698 else if (strcasecmp ("Int16", tmp) == 0)
699 data.register_type = REG_TYPE_INT16;
700 else if (strcasecmp ("Int32", tmp) == 0)
701 data.register_type = REG_TYPE_INT32;
702 else if (strcasecmp ("Uint16", tmp) == 0)
703 data.register_type = REG_TYPE_UINT16;
704 else if (strcasecmp ("Uint32", tmp) == 0)
705 data.register_type = REG_TYPE_UINT32;
706 else if (strcasecmp ("Float", tmp) == 0)
707 data.register_type = REG_TYPE_FLOAT;
710 ERROR ("Modbus plugin: The register type \"%s\" is unknown.", tmp);
716 ERROR ("Modbus plugin: Unknown configuration option: %s", child->key);
722 } /* for (i = 0; i < ci->children_num; i++) */
724 assert (data.name != NULL);
725 if (data.type[0] == 0)
727 ERROR ("Modbus plugin: Data block \"%s\": No type has been specified.",
733 data_copy (&data_definitions, &data);
738 } /* }}} int mb_config_add_data */
740 static int mb_config_set_host_address (mb_host_t *host, /* {{{ */
743 struct addrinfo *ai_list;
744 struct addrinfo *ai_ptr;
745 struct addrinfo ai_hints;
748 if ((host == NULL) || (address == NULL))
751 memset (&ai_hints, 0, sizeof (ai_hints));
753 ai_hints.ai_flags |= AI_ADDRCONFIG;
755 /* XXX: libmodbus can only handle IPv4 addresses. */
756 ai_hints.ai_family = AF_INET;
757 ai_hints.ai_addr = NULL;
758 ai_hints.ai_canonname = NULL;
759 ai_hints.ai_next = NULL;
762 status = getaddrinfo (address, /* service = */ NULL,
763 &ai_hints, &ai_list);
767 ERROR ("Modbus plugin: getaddrinfo failed: %s",
768 (status == EAI_SYSTEM)
769 ? sstrerror (errno, errbuf, sizeof (errbuf))
770 : gai_strerror (status));
774 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
776 status = getnameinfo (ai_ptr->ai_addr, ai_ptr->ai_addrlen,
777 host->node, sizeof (host->node),
778 /* service = */ NULL, /* length = */ 0,
779 /* flags = */ NI_NUMERICHOST);
784 freeaddrinfo (ai_list);
787 ERROR ("Modbus plugin: Unable to translate node name: \"%s\"", address);
788 else /* if (status == 0) */
790 DEBUG ("Modbus plugin: mb_config_set_host_address: %s -> %s",
791 address, host->node);
795 } /* }}} int mb_config_set_host_address */
797 static int mb_config_add_slave (mb_host_t *host, oconfig_item_t *ci) /* {{{ */
803 if ((host == NULL) || (ci == NULL))
806 slave = realloc (host->slaves, sizeof (*slave) * (host->slaves_num + 1));
809 host->slaves = slave;
810 slave = host->slaves + host->slaves_num;
811 memset (slave, 0, sizeof (*slave));
812 slave->collect = NULL;
814 status = cf_util_get_int (ci, &slave->id);
818 for (i = 0; i < ci->children_num; i++)
820 oconfig_item_t *child = ci->children + i;
822 if (strcasecmp ("Instance", child->key) == 0)
823 status = cf_util_get_string_buffer (child,
824 slave->instance, sizeof (slave->instance));
825 else if (strcasecmp ("Collect", child->key) == 0)
828 status = cf_util_get_string_buffer (child, buffer, sizeof (buffer));
830 data_copy_by_name (&slave->collect, data_definitions, buffer);
831 status = 0; /* continue after failure. */
835 ERROR ("Modbus plugin: Unknown configuration option: %s", child->key);
843 if ((status == 0) && (slave->collect == NULL))
851 else /* if (status != 0) */
852 data_free_all (slave->collect);
855 } /* }}} int mb_config_add_slave */
857 static int mb_config_add_host (oconfig_item_t *ci) /* {{{ */
863 host = malloc (sizeof (*host));
866 memset (host, 0, sizeof (*host));
869 status = cf_util_get_string_buffer (ci, host->host, sizeof (host->host));
875 if (host->host[0] == 0)
881 for (i = 0; i < ci->children_num; i++)
883 oconfig_item_t *child = ci->children + i;
886 if (strcasecmp ("Address", child->key) == 0)
888 char buffer[NI_MAXHOST];
889 status = cf_util_get_string_buffer (child, buffer, sizeof (buffer));
891 status = mb_config_set_host_address (host, buffer);
893 else if (strcasecmp ("Port", child->key) == 0)
895 host->port = cf_util_get_port_number (child);
899 else if (strcasecmp ("Interval", child->key) == 0)
900 status = cf_util_get_cdtime (child, &host->interval);
901 else if (strcasecmp ("Slave", child->key) == 0)
902 /* Don't set status: Gracefully continue if a slave fails. */
903 mb_config_add_slave (host, child);
906 ERROR ("Modbus plugin: Unknown configuration option: %s", child->key);
912 } /* for (i = 0; i < ci->children_num; i++) */
914 assert (host->host[0] != 0);
915 if (host->host[0] == 0)
917 ERROR ("Modbus plugin: Data block \"%s\": No type has been specified.",
926 struct timespec interval = { 0, 0 };
929 ud.free_func = host_free;
931 ssnprintf (name, sizeof (name), "modbus-%s", host->host);
933 CDTIME_T_TO_TIMESPEC (host->interval, &interval);
935 plugin_register_complex_read (/* group = */ NULL, name,
936 /* callback = */ mb_read,
937 /* interval = */ (host->interval > 0) ? &interval : NULL,
946 } /* }}} int mb_config_add_host */
948 static int mb_config (oconfig_item_t *ci) /* {{{ */
955 for (i = 0; i < ci->children_num; i++)
957 oconfig_item_t *child = ci->children + i;
959 if (strcasecmp ("Data", child->key) == 0)
960 mb_config_add_data (child);
961 else if (strcasecmp ("Host", child->key) == 0)
962 mb_config_add_host (child);
964 ERROR ("Modbus plugin: Unknown configuration option: %s", child->key);
968 } /* }}} int mb_config */
972 static int mb_shutdown (void) /* {{{ */
974 data_free_all (data_definitions);
975 data_definitions = NULL;
978 } /* }}} int mb_shutdown */
980 void module_register (void)
982 plugin_register_complex_config ("modbus", mb_config);
983 plugin_register_shutdown ("modbus", mb_shutdown);
984 } /* void module_register */
986 /* vim: set sw=2 sts=2 et fdm=marker : */