src/modbus.c

   1 /**
   2  * collectd - src/modbus.c
   3  * Copyright (C) 2010,2011  noris network AG
   4  *
   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
   8  * applicable.
   9  *
  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.
  14  *
  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
  18  *
  19  * Authors:
  20  *   Florian Forster <octo at noris.net>
  21  **/
  22
  23 #include "collectd.h"
  24
  25 #include "common.h"
  26 #include "plugin.h"
  27 #include "configfile.h"
  28
  29 #include <netdb.h>
  30
  31 #include <modbus.h>
  32
  33 #ifndef LIBMODBUS_VERSION_CHECK
  34 /* Assume version 2.0.3 */
  35 # define LEGACY_LIBMODBUS 1
  36 #else
  37 /* Assume version 2.9.2 */
  38 #endif
  39
  40 #ifndef MODBUS_TCP_DEFAULT_PORT
  41 # ifdef MODBUS_TCP_PORT
  42 #  define MODBUS_TCP_DEFAULT_PORT MODBUS_TCP_PORT
  43 # else
  44 #  define MODBUS_TCP_DEFAULT_PORT 502
  45 # endif
  46 #endif
  47
  48 /*
  49  * <Data "data_name">
  50  *   RegisterBase 1234
  51  *   RegisterCmd ReadHolding
  52  *   RegisterType float
  53  *   Type gauge
  54  *   Instance "..."
  55  * </Data>
  56  *
  57  * <Host "name">
  58  *   Address "addr"
  59  *   Port "1234"
  60  *   # Or:
  61  *   # Device "/dev/ttyUSB0"
  62  *   # Baudrate 38400
  63  *   # (Assumes 8N1)
  64  *   Interval 60
  65  *
  66  *   <Slave 1>
  67  *     Instance "foobar" # optional
  68  *     Collect "data_name"
  69  *   </Slave>
  70  * </Host>
  71  */
  72
  73 /*
  74  * Data structures
  75  */
  76 enum mb_register_type_e /* {{{ */
  77 {
  78   REG_TYPE_INT16,
  79   REG_TYPE_INT32,
  80   REG_TYPE_UINT16,
  81   REG_TYPE_UINT32,
  82   REG_TYPE_FLOAT
  83 }; /* }}} */
  84 enum mb_mreg_type_e /* {{{ */
  85 {
  86   MREG_HOLDING,
  87   MREG_INPUT
  88 }; /* }}} */
  89 typedef enum mb_register_type_e mb_register_type_t;
  90 typedef enum mb_mreg_type_e mb_mreg_type_t;
  91
  92 /* TCP or RTU depending on what is specified in host config block */
  93 enum mb_conntype_e /* {{{ */
  94 {
  95   MBCONN_TCP,
  96   MBCONN_RTU
  97 }; /* }}} */
  98 typedef enum mb_conntype_e mb_conntype_t;
  99
 100 struct mb_data_s;
 101 typedef struct mb_data_s mb_data_t;
 102 struct mb_data_s /* {{{ */
 103 {
 104   char *name;
 105   int register_base;
 106   mb_register_type_t register_type;
 107   mb_mreg_type_t modbus_register_type;
 108   char type[DATA_MAX_NAME_LEN];
 109   char instance[DATA_MAX_NAME_LEN];
 110
 111   mb_data_t *next;
 112 }; /* }}} */
 113
 114 struct mb_slave_s /* {{{ */
 115 {
 116   int id;
 117   char instance[DATA_MAX_NAME_LEN];
 118   mb_data_t *collect;
 119 }; /* }}} */
 120 typedef struct mb_slave_s mb_slave_t;
 121
 122 struct mb_host_s /* {{{ */
 123 {
 124   char host[DATA_MAX_NAME_LEN];
 125   char node[NI_MAXHOST];        /* TCP hostname or RTU serial device */
 126   /* char service[NI_MAXSERV]; */
 127   int port;                     /* for Modbus/TCP */
 128   int baudrate;                 /* for Modbus/RTU */
 129   mb_conntype_t conntype;
 130   cdtime_t interval;
 131
 132   mb_slave_t *slaves;
 133   size_t slaves_num;
 134
 135 #if LEGACY_LIBMODBUS
 136   modbus_param_t connection;
 137 #else
 138   modbus_t *connection;
 139 #endif
 140   _Bool is_connected;
 141 }; /* }}} */
 142 typedef struct mb_host_s mb_host_t;
 143
 144 struct mb_data_group_s;
 145 typedef struct mb_data_group_s mb_data_group_t;
 146 struct mb_data_group_s /* {{{ */
 147 {
 148   mb_data_t *registers;
 149   size_t registers_num;
 150
 151   mb_data_group_t *next;
 152 }; /* }}} */
 153
 154 /*
 155  * Global variables
 156  */
 157 static mb_data_t *data_definitions = NULL;
 158
 159 /*
 160  * Functions
 161  */
 162 static mb_data_t *data_get_by_name (mb_data_t *src, /* {{{ */
 163     const char *name)
 164 {
 165   if (name == NULL)
 166     return (NULL);
 167
 168   for (mb_data_t *ptr = src; ptr != NULL; ptr = ptr->next)
 169     if (strcasecmp (ptr->name, name) == 0)
 170       return (ptr);
 171
 172   return (NULL);
 173 } /* }}} mb_data_t *data_get_by_name */
 174
 175 static int data_append (mb_data_t **dst, mb_data_t *src) /* {{{ */
 176 {
 177   mb_data_t *ptr;
 178
 179   if ((dst == NULL) || (src == NULL))
 180     return (EINVAL);
 181
 182   ptr = *dst;
 183
 184   if (ptr == NULL)
 185   {
 186     *dst = src;
 187     return (0);
 188   }
 189
 190   while (ptr->next != NULL)
 191     ptr = ptr->next;
 192
 193   ptr->next = src;
 194
 195   return (0);
 196 } /* }}} int data_append */
 197
 198 /* Copy a single mb_data_t and append it to another list. */
 199 static int data_copy (mb_data_t **dst, const mb_data_t *src) /* {{{ */
 200 {
 201   mb_data_t *tmp;
 202   int status;
 203
 204   if ((dst == NULL) || (src == NULL))
 205     return (EINVAL);
 206
 207   tmp = malloc (sizeof (*tmp));
 208   if (tmp == NULL)
 209     return (ENOMEM);
 210   memcpy (tmp, src, sizeof (*tmp));
 211   tmp->name = NULL;
 212   tmp->next = NULL;
 213
 214   tmp->name = strdup (src->name);
 215   if (tmp->name == NULL)
 216   {
 217     sfree (tmp);
 218     return (ENOMEM);
 219   }
 220
 221   status = data_append (dst, tmp);
 222   if (status != 0)
 223   {
 224     sfree (tmp->name);
 225     sfree (tmp);
 226     return (status);
 227   }
 228
 229   return (0);
 230 } /* }}} int data_copy */
 231
 232 /* Lookup a single mb_data_t instance, copy it and append the copy to another
 233  * list. */
 234 static int data_copy_by_name (mb_data_t **dst, mb_data_t *src, /* {{{ */
 235     const char *name)
 236 {
 237   mb_data_t *ptr;
 238
 239   if ((dst == NULL) || (src == NULL) || (name == NULL))
 240     return (EINVAL);
 241
 242   ptr = data_get_by_name (src, name);
 243   if (ptr == NULL)
 244     return (ENOENT);
 245
 246   return (data_copy (dst, ptr));
 247 } /* }}} int data_copy_by_name */
 248
 249 /* Read functions */
 250
 251 static int mb_submit (mb_host_t *host, mb_slave_t *slave, /* {{{ */
 252     mb_data_t *data, value_t value)
 253 {
 254   value_list_t vl = VALUE_LIST_INIT;
 255
 256   if ((host == NULL) || (slave == NULL) || (data == NULL))
 257     return (EINVAL);
 258
 259   if (host->interval == 0)
 260     host->interval = plugin_get_interval ();
 261
 262   if (slave->instance[0] == 0)
 263     ssnprintf (slave->instance, sizeof (slave->instance), "slave_%i",
 264         slave->id);
 265
 266   vl.values = &value;
 267   vl.values_len = 1;
 268   vl.interval = host->interval;
 269   sstrncpy (vl.host, host->host, sizeof (vl.host));
 270   sstrncpy (vl.plugin, "modbus", sizeof (vl.plugin));
 271   sstrncpy (vl.plugin_instance, slave->instance, sizeof (vl.plugin_instance));
 272   sstrncpy (vl.type, data->type, sizeof (vl.type));
 273   sstrncpy (vl.type_instance, data->instance, sizeof (vl.type_instance));
 274
 275   return (plugin_dispatch_values (&vl));
 276 } /* }}} int mb_submit */
 277
 278 static float mb_register_to_float (uint16_t hi, uint16_t lo) /* {{{ */
 279 {
 280   union
 281   {
 282     uint8_t b[4];
 283     uint16_t s[2];
 284     float f;
 285   } conv;
 286
 287 #if BYTE_ORDER == LITTLE_ENDIAN
 288   /* little endian */
 289   conv.b[0] = lo & 0x00ff;
 290   conv.b[1] = (lo >> 8) & 0x00ff;
 291   conv.b[2] = hi & 0x00ff;
 292   conv.b[3] = (hi >> 8) & 0x00ff;
 293 #else
 294   conv.b[3] = lo & 0x00ff;
 295   conv.b[2] = (lo >> 8) & 0x00ff;
 296   conv.b[1] = hi & 0x00ff;
 297   conv.b[0] = (hi >> 8) & 0x00ff;
 298 #endif
 299
 300   return (conv.f);
 301 } /* }}} float mb_register_to_float */
 302
 303 #if LEGACY_LIBMODBUS
 304 /* Version 2.0.3 */
 305 static int mb_init_connection (mb_host_t *host) /* {{{ */
 306 {
 307   int status;
 308
 309   if (host == NULL)
 310     return (EINVAL);
 311
 312 #if COLLECT_DEBUG
 313   modbus_set_debug (&host->connection, 1);
 314 #endif
 315
 316   /* We'll do the error handling ourselves. */
 317   modbus_set_error_handling (&host->connection, NOP_ON_ERROR);
 318
 319   if (host->conntype == MBCONN_TCP)
 320   {
 321     if ((host->port < 1) || (host->port > 65535))
 322       host->port = MODBUS_TCP_DEFAULT_PORT;
 323
 324     DEBUG ("Modbus plugin: Trying to connect to \"%s\", port %i.",
 325         host->node, host->port);
 326
 327     modbus_init_tcp (&host->connection,
 328         /* host = */ host->node,
 329         /* port = */ host->port);
 330   }
 331   else  /* MBCONN_RTU */
 332   {
 333     DEBUG ("Modbus plugin: Trying to connect to \"%s\".", host->node);
 334
 335     modbus_init_rtu (&host->connection,
 336        /* device = */ host->node,
 337      /* baudrate = */ host->baudrate,
 338                       'N', 8, 1, 0);
 339   }
 340
 341   status = modbus_connect (&host->connection);
 342   if (status != 0)
 343   {
 344     ERROR ("Modbus plugin: modbus_connect (%s, %i) failed with status %i.",
 345         host->node, host->port ? host->port : host->baudrate, status);
 346     return (status);
 347   }
 348
 349   host->is_connected = 1;
 350   return (0);
 351 } /* }}} int mb_init_connection */
 352 /* #endif LEGACY_LIBMODBUS */
 353
 354 #else /* if !LEGACY_LIBMODBUS */
 355 /* Version 2.9.2 */
 356 static int mb_init_connection (mb_host_t *host) /* {{{ */
 357 {
 358   int status;
 359
 360   if (host == NULL)
 361     return (EINVAL);
 362
 363   if (host->connection != NULL)
 364     return (0);
 365
 366   if (host->conntype == MBCONN_TCP)
 367   {
 368     if ((host->port < 1) || (host->port > 65535))
 369       host->port = MODBUS_TCP_DEFAULT_PORT;
 370
 371     DEBUG ("Modbus plugin: Trying to connect to \"%s\", port %i.",
 372         host->node, host->port);
 373
 374     host->connection = modbus_new_tcp (host->node, host->port);
 375     if (host->connection == NULL)
 376     {
 377       ERROR ("Modbus plugin: Creating new Modbus/TCP object failed.");
 378       return (-1);
 379     }
 380   }
 381   else
 382   {
 383     DEBUG ("Modbus plugin: Trying to connect to \"%s\", baudrate %i.",
 384         host->node, host->baudrate);
 385
 386     host->connection = modbus_new_rtu (host->node, host->baudrate, 'N', 8, 1);
 387     if (host->connection == NULL)
 388     {
 389       ERROR ("Modbus plugin: Creating new Modbus/RTU object failed.");
 390       return (-1);
 391     }
 392   }
 393
 394 #if COLLECT_DEBUG
 395   modbus_set_debug (host->connection, 1);
 396 #endif
 397
 398   /* We'll do the error handling ourselves. */
 399   modbus_set_error_recovery (host->connection, 0);
 400
 401   status = modbus_connect (host->connection);
 402   if (status != 0)
 403   {
 404     ERROR ("Modbus plugin: modbus_connect (%s, %i) failed with status %i.",
 405         host->node, host->port ? host->port : host->baudrate, status);
 406     modbus_free (host->connection);
 407     host->connection = NULL;
 408     return (status);
 409   }
 410
 411   return (0);
 412 } /* }}} int mb_init_connection */
 413 #endif /* !LEGACY_LIBMODBUS */
 414
 415 #define CAST_TO_VALUE_T(ds,vt,raw) do { \
 416   if ((ds)->ds[0].type == DS_TYPE_COUNTER) \
 417     (vt).counter = (counter_t) (raw); \
 418   else if ((ds)->ds[0].type == DS_TYPE_GAUGE) \
 419     (vt).gauge = (gauge_t) (raw); \
 420   else if ((ds)->ds[0].type == DS_TYPE_DERIVE) \
 421     (vt).derive = (derive_t) (raw); \
 422   else /* if (ds->ds[0].type == DS_TYPE_ABSOLUTE) */ \
 423     (vt).absolute = (absolute_t) (raw); \
 424 } while (0)
 425
 426 static int mb_read_data (mb_host_t *host, mb_slave_t *slave, /* {{{ */
 427     mb_data_t *data)
 428 {
 429   uint16_t values[2] = { 0 };
 430   int values_num;
 431   const data_set_t *ds;
 432   int status = 0;
 433
 434   if ((host == NULL) || (slave == NULL) || (data == NULL))
 435     return (EINVAL);
 436
 437   ds = plugin_get_ds (data->type);
 438   if (ds == NULL)
 439   {
 440     ERROR ("Modbus plugin: Type \"%s\" is not defined.", data->type);
 441     return (-1);
 442   }
 443
 444   if (ds->ds_num != 1)
 445   {
 446     ERROR ("Modbus plugin: The type \"%s\" has %zu data sources. "
 447         "I can only handle data sets with only one data source.",
 448         data->type, ds->ds_num);
 449     return (-1);
 450   }
 451
 452   if ((ds->ds[0].type != DS_TYPE_GAUGE)
 453       && (data->register_type != REG_TYPE_INT32)
 454       && (data->register_type != REG_TYPE_UINT32))
 455   {
 456     NOTICE ("Modbus plugin: The data source of type \"%s\" is %s, not gauge. "
 457         "This will most likely result in problems, because the register type "
 458         "is not UINT32.", data->type, DS_TYPE_TO_STRING (ds->ds[0].type));
 459   }
 460
 461   if ((data->register_type == REG_TYPE_INT32)
 462       || (data->register_type == REG_TYPE_UINT32)
 463       || (data->register_type == REG_TYPE_FLOAT))
 464     values_num = 2;
 465   else
 466     values_num = 1;
 467
 468   if (host->connection == NULL)
 469   {
 470     status = EBADF;
 471   }
 472   else if (host->conntype == MBCONN_TCP)
 473   {
 474     struct sockaddr sockaddr;
 475     socklen_t saddrlen = sizeof (sockaddr);
 476
 477     status = getpeername (modbus_get_socket (host->connection),
 478         &sockaddr, &saddrlen);
 479     if (status != 0)
 480       status = errno;
 481   }
 482
 483   if ((status == EBADF) || (status == ENOTSOCK) || (status == ENOTCONN))
 484   {
 485     status = mb_init_connection (host);
 486     if (status != 0)
 487     {
 488       ERROR ("Modbus plugin: mb_init_connection (%s/%s) failed. ",
 489           host->host, host->node);
 490       host->is_connected = 0;
 491       host->connection = NULL;
 492       return (-1);
 493     }
 494   }
 495   else if (status != 0)
 496   {
 497 #if LEGACY_LIBMODBUS
 498     modbus_close (&host->connection);
 499 #else
 500     modbus_close (host->connection);
 501     modbus_free (host->connection);
 502 #endif
 503   }
 504
 505 #if LEGACY_LIBMODBUS
 506   /* Version 2.0.3: Pass the connection struct as a pointer and pass the slave
 507    * id to each call of "read_holding_registers". */
 508 # define modbus_read_registers(ctx, addr, nb, dest) \
 509   read_holding_registers (&(ctx), slave->id, (addr), (nb), (dest))
 510 #else /* if !LEGACY_LIBMODBUS */
 511   /* Version 2.9.2: Set the slave id once before querying the registers. */
 512   status = modbus_set_slave (host->connection, slave->id);
 513   if (status != 0)
 514   {
 515     ERROR ("Modbus plugin: modbus_set_slave (%i) failed with status %i.",
 516         slave->id, status);
 517     return (-1);
 518   }
 519 #endif
 520   if (data->modbus_register_type == MREG_INPUT){
 521     status = modbus_read_input_registers (host->connection,
 522         /* start_addr = */ data->register_base,
 523         /* num_registers = */ values_num, /* buffer = */ values);
 524   }
 525   else{
 526     status = modbus_read_registers (host->connection,
 527         /* start_addr = */ data->register_base,
 528         /* num_registers = */ values_num, /* buffer = */ values);
 529   }
 530   if (status != values_num)
 531   {
 532     ERROR ("Modbus plugin: modbus read function (%s/%s) failed. "
 533            " status = %i, values_num = %i. Giving up.",
 534            host->host, host->node, status, values_num);
 535 #if LEGACY_LIBMODBUS
 536     modbus_close (&host->connection);
 537 #else
 538     modbus_close (host->connection);
 539     modbus_free (host->connection);
 540 #endif
 541     host->connection = NULL;
 542     return (-1);
 543   }
 544
 545   DEBUG ("Modbus plugin: mb_read_data: Success! "
 546       "modbus_read_registers returned with status %i.", status);
 547
 548   if (data->register_type == REG_TYPE_FLOAT)
 549   {
 550     float float_value;
 551     value_t vt;
 552
 553     float_value = mb_register_to_float (values[0], values[1]);
 554     DEBUG ("Modbus plugin: mb_read_data: "
 555         "Returned float value is %g", (double) float_value);
 556
 557     CAST_TO_VALUE_T (ds, vt, float_value);
 558     mb_submit (host, slave, data, vt);
 559   }
 560   else if (data->register_type == REG_TYPE_INT32)
 561   {
 562     union
 563     {
 564       uint32_t u32;
 565       int32_t  i32;
 566     } v;
 567     value_t vt;
 568
 569     v.u32 = (((uint32_t) values[0]) << 16)
 570       | ((uint32_t) values[1]);
 571     DEBUG ("Modbus plugin: mb_read_data: "
 572         "Returned int32 value is %"PRIi32, v.i32);
 573
 574     CAST_TO_VALUE_T (ds, vt, v.i32);
 575     mb_submit (host, slave, data, vt);
 576   }
 577   else if (data->register_type == REG_TYPE_INT16)
 578   {
 579     union
 580     {
 581       uint16_t u16;
 582       int16_t  i16;
 583     } v;
 584     value_t vt;
 585
 586     v.u16 = values[0];
 587
 588     DEBUG ("Modbus plugin: mb_read_data: "
 589         "Returned int16 value is %"PRIi16, v.i16);
 590
 591     CAST_TO_VALUE_T (ds, vt, v.i16);
 592     mb_submit (host, slave, data, vt);
 593   }
 594   else if (data->register_type == REG_TYPE_UINT32)
 595   {
 596     uint32_t v32;
 597     value_t vt;
 598
 599     v32 = (((uint32_t) values[0]) << 16)
 600       | ((uint32_t) values[1]);
 601     DEBUG ("Modbus plugin: mb_read_data: "
 602         "Returned uint32 value is %"PRIu32, v32);
 603
 604     CAST_TO_VALUE_T (ds, vt, v32);
 605     mb_submit (host, slave, data, vt);
 606   }
 607   else /* if (data->register_type == REG_TYPE_UINT16) */
 608   {
 609     value_t vt;
 610
 611     DEBUG ("Modbus plugin: mb_read_data: "
 612         "Returned uint16 value is %"PRIu16, values[0]);
 613
 614     CAST_TO_VALUE_T (ds, vt, values[0]);
 615     mb_submit (host, slave, data, vt);
 616   }
 617
 618   return (0);
 619 } /* }}} int mb_read_data */
 620
 621 static int mb_read_slave (mb_host_t *host, mb_slave_t *slave) /* {{{ */
 622 {
 623   int success;
 624   int status;
 625
 626   if ((host == NULL) || (slave == NULL))
 627     return (EINVAL);
 628
 629   success = 0;
 630   for (mb_data_t *data = slave->collect; data != NULL; data = data->next)
 631   {
 632     status = mb_read_data (host, slave, data);
 633     if (status == 0)
 634       success++;
 635   }
 636
 637   if (success == 0)
 638     return (-1);
 639   else
 640     return (0);
 641 } /* }}} int mb_read_slave */
 642
 643 static int mb_read (user_data_t *user_data) /* {{{ */
 644 {
 645   mb_host_t *host;
 646   int success;
 647   int status;
 648
 649   if ((user_data == NULL) || (user_data->data == NULL))
 650     return (EINVAL);
 651
 652   host = user_data->data;
 653
 654   success = 0;
 655   for (size_t i = 0; i < host->slaves_num; i++)
 656   {
 657     status = mb_read_slave (host, host->slaves + i);
 658     if (status == 0)
 659       success++;
 660   }
 661
 662   if (success == 0)
 663     return (-1);
 664   else
 665     return (0);
 666 } /* }}} int mb_read */
 667
 668 /* Free functions */
 669
 670 static void data_free_one (mb_data_t *data) /* {{{ */
 671 {
 672   if (data == NULL)
 673     return;
 674
 675   sfree (data->name);
 676   sfree (data);
 677 } /* }}} void data_free_one */
 678
 679 static void data_free_all (mb_data_t *data) /* {{{ */
 680 {
 681   mb_data_t *next;
 682
 683   if (data == NULL)
 684     return;
 685
 686   next = data->next;
 687   data_free_one (data);
 688
 689   data_free_all (next);
 690 } /* }}} void data_free_all */
 691
 692 static void slaves_free_all (mb_slave_t *slaves, size_t slaves_num) /* {{{ */
 693 {
 694   if (slaves == NULL)
 695     return;
 696
 697   for (size_t i = 0; i < slaves_num; i++)
 698     data_free_all (slaves[i].collect);
 699   sfree (slaves);
 700 } /* }}} void slaves_free_all */
 701
 702 static void host_free (void *void_host) /* {{{ */
 703 {
 704   mb_host_t *host = void_host;
 705
 706   if (host == NULL)
 707     return;
 708
 709   slaves_free_all (host->slaves, host->slaves_num);
 710   sfree (host);
 711 } /* }}} void host_free */
 712
 713 /* Config functions */
 714
 715 static int mb_config_add_data (oconfig_item_t *ci) /* {{{ */
 716 {
 717   mb_data_t data = { 0 };
 718   int status;
 719
 720   data.name = NULL;
 721   data.register_type = REG_TYPE_UINT16;
 722   data.next = NULL;
 723
 724   status = cf_util_get_string (ci, &data.name);
 725   if (status != 0)
 726     return (status);
 727
 728   for (int i = 0; i < ci->children_num; i++)
 729   {
 730     oconfig_item_t *child = ci->children + i;
 731
 732     if (strcasecmp ("Type", child->key) == 0)
 733       status = cf_util_get_string_buffer (child,
 734           data.type, sizeof (data.type));
 735     else if (strcasecmp ("Instance", child->key) == 0)
 736       status = cf_util_get_string_buffer (child,
 737           data.instance, sizeof (data.instance));
 738     else if (strcasecmp ("RegisterBase", child->key) == 0)
 739       status = cf_util_get_int (child, &data.register_base);
 740     else if (strcasecmp ("RegisterType", child->key) == 0)
 741     {
 742       char tmp[16];
 743       status = cf_util_get_string_buffer (child, tmp, sizeof (tmp));
 744       if (status != 0)
 745         /* do nothing */;
 746       else if (strcasecmp ("Int16", tmp) == 0)
 747         data.register_type = REG_TYPE_INT16;
 748       else if (strcasecmp ("Int32", tmp) == 0)
 749         data.register_type = REG_TYPE_INT32;
 750       else if (strcasecmp ("Uint16", tmp) == 0)
 751         data.register_type = REG_TYPE_UINT16;
 752       else if (strcasecmp ("Uint32", tmp) == 0)
 753         data.register_type = REG_TYPE_UINT32;
 754       else if (strcasecmp ("Float", tmp) == 0)
 755         data.register_type = REG_TYPE_FLOAT;
 756       else
 757       {
 758         ERROR ("Modbus plugin: The register type \"%s\" is unknown.", tmp);
 759         status = -1;
 760       }
 761     }
 762     else if (strcasecmp ("RegisterCmd", child->key) == 0)
 763     {
 764 #if LEGACY_LIBMODBUS
 765       ERROR("Modbus plugin: RegisterCmd parameter can not be used "
 766             "with your libmodbus version");
 767 #else
 768       char tmp[16];
 769       status = cf_util_get_string_buffer (child, tmp, sizeof (tmp));
 770       if (status != 0)
 771         /* do nothing */;
 772       else if (strcasecmp ("ReadHolding", tmp) == 0)
 773         data.modbus_register_type = MREG_HOLDING;
 774       else if (strcasecmp ("ReadInput", tmp) == 0)
 775         data.modbus_register_type = MREG_INPUT;
 776       else
 777       {
 778         ERROR ("Modbus plugin: The modbus_register_type \"%s\" is unknown.",
 779                tmp);
 780         status = -1;
 781       }
 782 #endif
 783     }
 784     else
 785     {
 786       ERROR ("Modbus plugin: Unknown configuration option: %s", child->key);
 787       status = -1;
 788     }
 789
 790     if (status != 0)
 791       break;
 792   } /* for (i = 0; i < ci->children_num; i++) */
 793
 794   assert (data.name != NULL);
 795   if (data.type[0] == 0)
 796   {
 797     ERROR ("Modbus plugin: Data block \"%s\": No type has been specified.",
 798         data.name);
 799     status = -1;
 800   }
 801
 802   if (status == 0)
 803     data_copy (&data_definitions, &data);
 804
 805   sfree (data.name);
 806
 807   return (status);
 808 } /* }}} int mb_config_add_data */
 809
 810 static int mb_config_set_host_address (mb_host_t *host, /* {{{ */
 811     const char *address)
 812 {
 813   struct addrinfo *ai_list;
 814   int status;
 815
 816   if ((host == NULL) || (address == NULL))
 817     return (EINVAL);
 818
 819   struct addrinfo  ai_hints = {
 820     /* XXX: libmodbus can only handle IPv4 addresses. */
 821     .ai_family = AF_INET,
 822     .ai_flags = AI_ADDRCONFIG
 823   };
 824
 825   status = getaddrinfo (address, /* service = */ NULL,
 826       &ai_hints, &ai_list);
 827   if (status != 0)
 828   {
 829     char errbuf[1024];
 830     ERROR ("Modbus plugin: getaddrinfo failed: %s",
 831         (status == EAI_SYSTEM)
 832         ? sstrerror (errno, errbuf, sizeof (errbuf))
 833         : gai_strerror (status));
 834     return (status);
 835   }
 836
 837   for (struct addrinfo *ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
 838   {
 839     status = getnameinfo (ai_ptr->ai_addr, ai_ptr->ai_addrlen,
 840         host->node, sizeof (host->node),
 841         /* service = */ NULL, /* length = */ 0,
 842         /* flags = */ NI_NUMERICHOST);
 843     if (status == 0)
 844       break;
 845   } /* for (ai_ptr) */
 846
 847   freeaddrinfo (ai_list);
 848
 849   if (status != 0)
 850     ERROR ("Modbus plugin: Unable to translate node name: \"%s\"", address);
 851   else /* if (status == 0) */
 852   {
 853     DEBUG ("Modbus plugin: mb_config_set_host_address: %s -> %s",
 854         address, host->node);
 855   }
 856
 857   return (status);
 858 } /* }}} int mb_config_set_host_address */
 859
 860 static int mb_config_add_slave (mb_host_t *host, oconfig_item_t *ci) /* {{{ */
 861 {
 862   mb_slave_t *slave;
 863   int status;
 864
 865   if ((host == NULL) || (ci == NULL))
 866     return (EINVAL);
 867
 868   slave = realloc (host->slaves, sizeof (*slave) * (host->slaves_num + 1));
 869   if (slave == NULL)
 870     return (ENOMEM);
 871   host->slaves = slave;
 872   slave = host->slaves + host->slaves_num;
 873   memset (slave, 0, sizeof (*slave));
 874   slave->collect = NULL;
 875
 876   status = cf_util_get_int (ci, &slave->id);
 877   if (status != 0)
 878     return (status);
 879
 880   for (int i = 0; i < ci->children_num; i++)
 881   {
 882     oconfig_item_t *child = ci->children + i;
 883
 884     if (strcasecmp ("Instance", child->key) == 0)
 885       status = cf_util_get_string_buffer (child,
 886           slave->instance, sizeof (slave->instance));
 887     else if (strcasecmp ("Collect", child->key) == 0)
 888     {
 889       char buffer[1024];
 890       status = cf_util_get_string_buffer (child, buffer, sizeof (buffer));
 891       if (status == 0)
 892         data_copy_by_name (&slave->collect, data_definitions, buffer);
 893       status = 0; /* continue after failure. */
 894     }
 895     else
 896     {
 897       ERROR ("Modbus plugin: Unknown configuration option: %s", child->key);
 898       status = -1;
 899     }
 900
 901     if (status != 0)
 902       break;
 903   }
 904
 905   if ((status == 0) && (slave->collect == NULL))
 906     status = EINVAL;
 907
 908   if (slave->id < 0)
 909     status = EINVAL;
 910
 911   if (status == 0)
 912     host->slaves_num++;
 913   else /* if (status != 0) */
 914     data_free_all (slave->collect);
 915
 916   return (status);
 917 } /* }}} int mb_config_add_slave */
 918
 919 static int mb_config_add_host (oconfig_item_t *ci) /* {{{ */
 920 {
 921   mb_host_t *host;
 922   int status;
 923
 924   host = calloc (1, sizeof (*host));
 925   if (host == NULL)
 926     return (ENOMEM);
 927   host->slaves = NULL;
 928
 929   status = cf_util_get_string_buffer (ci, host->host, sizeof (host->host));
 930   if (status != 0)
 931   {
 932     sfree (host);
 933     return (status);
 934   }
 935   if (host->host[0] == 0)
 936   {
 937     sfree (host);
 938     return (EINVAL);
 939   }
 940
 941   for (int i = 0; i < ci->children_num; i++)
 942   {
 943     oconfig_item_t *child = ci->children + i;
 944     status = 0;
 945
 946     if (strcasecmp ("Address", child->key) == 0)
 947     {
 948       char buffer[NI_MAXHOST];
 949       status = cf_util_get_string_buffer (child, buffer, sizeof (buffer));
 950       if (status == 0)
 951         status = mb_config_set_host_address (host, buffer);
 952       if (status == 0)
 953         host->conntype = MBCONN_TCP;
 954     }
 955     else if (strcasecmp ("Port", child->key) == 0)
 956     {
 957       host->port = cf_util_get_port_number (child);
 958       if (host->port <= 0)
 959         status = -1;
 960     }
 961     else if (strcasecmp ("Device", child->key) == 0)
 962     {
 963       status = cf_util_get_string_buffer (child, host->node, sizeof (host->node));
 964       if (status == 0)
 965         host->conntype = MBCONN_RTU;
 966     }
 967     else if (strcasecmp ("Baudrate", child->key) == 0)
 968       status = cf_util_get_int(child, &host->baudrate);
 969     else if (strcasecmp ("Interval", child->key) == 0)
 970       status = cf_util_get_cdtime (child, &host->interval);
 971     else if (strcasecmp ("Slave", child->key) == 0)
 972       /* Don't set status: Gracefully continue if a slave fails. */
 973       mb_config_add_slave (host, child);
 974     else
 975     {
 976       ERROR ("Modbus plugin: Unknown configuration option: %s", child->key);
 977       status = -1;
 978     }
 979
 980     if (status != 0)
 981       break;
 982   } /* for (i = 0; i < ci->children_num; i++) */
 983
 984   assert (host->host[0] != 0);
 985   if (host->node[0] == 0)
 986   {
 987     ERROR ("Modbus plugin: Data block \"%s\": No address or device has been specified.",
 988         host->host);
 989     status = -1;
 990   }
 991   if (host->conntype == MBCONN_RTU && !host->baudrate)
 992   {
 993     ERROR ("Modbus plugin: Data block \"%s\": No serial baudrate has been specified.",
 994         host->host);
 995     status = -1;
 996   }
 997   if ((host->conntype == MBCONN_TCP && host->baudrate) ||
 998       (host->conntype == MBCONN_RTU && host->port))
 999   {
1000     ERROR ("Modbus plugin: Data block \"%s\": You've mixed up RTU and TCP options.",
1001         host->host);
1002     status = -1;
1003   }
1004
1005   if (status == 0)
1006   {
1007     user_data_t ud;
1008     char name[1024];
1009
1010     ud.data = host;
1011     ud.free_func = host_free;
1012
1013     ssnprintf (name, sizeof (name), "modbus-%s", host->host);
1014
1015     plugin_register_complex_read (/* group = */ NULL, name,
1016         /* callback = */ mb_read,
1017         /* interval = */ host->interval,
1018         &ud);
1019   }
1020   else
1021   {
1022     host_free (host);
1023   }
1024
1025   return (status);
1026 } /* }}} int mb_config_add_host */
1027
1028 static int mb_config (oconfig_item_t *ci) /* {{{ */
1029 {
1030   if (ci == NULL)
1031     return (EINVAL);
1032
1033   for (int i = 0; i < ci->children_num; i++)
1034   {
1035     oconfig_item_t *child = ci->children + i;
1036
1037     if (strcasecmp ("Data", child->key) == 0)
1038       mb_config_add_data (child);
1039     else if (strcasecmp ("Host", child->key) == 0)
1040       mb_config_add_host (child);
1041     else
1042       ERROR ("Modbus plugin: Unknown configuration option: %s", child->key);
1043   }
1044
1045   return (0);
1046 } /* }}} int mb_config */
1047
1048 /* ========= */
1049
1050 static int mb_shutdown (void) /* {{{ */
1051 {
1052   data_free_all (data_definitions);
1053   data_definitions = NULL;
1054
1055   return (0);
1056 } /* }}} int mb_shutdown */
1057
1058 void module_register (void)
1059 {
1060   plugin_register_complex_config ("modbus", mb_config);
1061   plugin_register_shutdown ("modbus", mb_shutdown);
1062 } /* void module_register */
1063
1064 /* vim: set sw=2 sts=2 et fdm=marker : */