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