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   struct sockaddr sockaddr;
 381   socklen_t saddrlen = sizeof(sockaddr);
 382   int status;
 383
 384   if ((host == NULL) || (slave == NULL) || (data == NULL))
 385     return (EINVAL);
 386
 387   ds = plugin_get_ds (data->type);
 388   if (ds == NULL)
 389   {
 390     ERROR ("Modbus plugin: Type \"%s\" is not defined.", data->type);
 391     return (-1);
 392   }
 393
 394   if (ds->ds_num != 1)
 395   {
 396     ERROR ("Modbus plugin: The type \"%s\" has %i data sources. "
 397         "I can only handle data sets with only one data source.",
 398         data->type, ds->ds_num);
 399     return (-1);
 400   }
 401
 402   if ((ds->ds[0].type != DS_TYPE_GAUGE)
 403       && (data->register_type != REG_TYPE_INT32)
 404       && (data->register_type != REG_TYPE_UINT32))
 405   {
 406     NOTICE ("Modbus plugin: The data source of type \"%s\" is %s, not gauge. "
 407         "This will most likely result in problems, because the register type "
 408         "is not UINT32.", data->type, DS_TYPE_TO_STRING (ds->ds[0].type));
 409   }
 410
 411   memset (values, 0, sizeof (values));
 412   if ((data->register_type == REG_TYPE_INT32)
 413       || (data->register_type == REG_TYPE_UINT32)
 414       || (data->register_type == REG_TYPE_FLOAT))
 415     values_num = 2;
 416   else
 417     values_num = 1;
 418
 419   if(host->connection == NULL)
 420     goto try_connect;
 421
 422   if(getpeername(modbus_get_socket(host->connection),
 423                  &sockaddr, &saddrlen) != 0)
 424     switch(errno){
 425     case EBADF:
 426     case ENOTSOCK:
 427     case ENOTCONN:
 428     try_connect:
 429       status = mb_init_connection (host);
 430       if (status != 0)
 431       {
 432         ERROR ("Modbus plugin: mb_init_connection (%s/%s) failed. ",
 433            host->host, host->node);
 434         host->is_connected = 0;
 435         host->connection = NULL;
 436         return (-1);
 437       }
 438     break;
 439     default:
 440 #if LEGACY_LIBMODBUS
 441       modbus_close (&host->connection);
 442 #else
 443       modbus_close (host->connection);
 444       modbus_free (host->connection);
 445 #endif
 446   }
 447
 448 #if LEGACY_LIBMODBUS
 449   /* Version 2.0.3: Pass the connection struct as a pointer and pass the slave
 450    * id to each call of "read_holding_registers". */
 451 # define modbus_read_registers(ctx, addr, nb, dest) \
 452   read_holding_registers (&(ctx), slave->id, (addr), (nb), (dest))
 453 #else /* if !LEGACY_LIBMODBUS */
 454   /* Version 2.9.2: Set the slave id once before querying the registers. */
 455   status = modbus_set_slave (host->connection, slave->id);
 456   if (status != 0)
 457   {
 458     ERROR ("Modbus plugin: modbus_set_slave (%i) failed with status %i.",
 459         slave->id, status);
 460     return (-1);
 461   }
 462 #endif
 463
 464   status = modbus_read_registers (host->connection,
 465         /* start_addr = */ data->register_base,
 466         /* num_registers = */ values_num, /* buffer = */ values);
 467   if (status != values_num)
 468   {
 469     ERROR ("Modbus plugin: modbus_read_registers (%s) failed. "
 470         "Giving up.", host->host);
 471     return (-1);
 472   }
 473
 474   DEBUG ("Modbus plugin: mb_read_data: Success! "
 475       "modbus_read_registers returned with status %i.", status);
 476
 477   if (data->register_type == REG_TYPE_FLOAT)
 478   {
 479     float float_value;
 480     value_t vt;
 481
 482     float_value = mb_register_to_float (values[0], values[1]);
 483     DEBUG ("Modbus plugin: mb_read_data: "
 484         "Returned float value is %g", (double) float_value);
 485
 486     CAST_TO_VALUE_T (ds, vt, float_value);
 487     mb_submit (host, slave, data, vt);
 488   }
 489   else if (data->register_type == REG_TYPE_INT32)
 490   {
 491     union
 492     {
 493       uint32_t u32;
 494       int32_t  i32;
 495     } v;
 496     value_t vt;
 497
 498     v.u32 = (((uint32_t) values[0]) << 16)
 499       | ((uint32_t) values[1]);
 500     DEBUG ("Modbus plugin: mb_read_data: "
 501         "Returned int32 value is %"PRIi32, v.i32);
 502
 503     CAST_TO_VALUE_T (ds, vt, v.i32);
 504     mb_submit (host, slave, data, vt);
 505   }
 506   else if (data->register_type == REG_TYPE_INT16)
 507   {
 508     union
 509     {
 510       uint16_t u16;
 511       int16_t  i16;
 512     } v;
 513     value_t vt;
 514
 515     v.u16 = values[0];
 516
 517     DEBUG ("Modbus plugin: mb_read_data: "
 518         "Returned int16 value is %"PRIi16, v.i16);
 519
 520     CAST_TO_VALUE_T (ds, vt, v.i16);
 521     mb_submit (host, slave, data, vt);
 522   }
 523   else if (data->register_type == REG_TYPE_UINT32)
 524   {
 525     uint32_t v32;
 526     value_t vt;
 527
 528     v32 = (((uint32_t) values[0]) << 16)
 529       | ((uint32_t) values[1]);
 530     DEBUG ("Modbus plugin: mb_read_data: "
 531         "Returned uint32 value is %"PRIu32, v32);
 532
 533     CAST_TO_VALUE_T (ds, vt, v32);
 534     mb_submit (host, slave, data, vt);
 535   }
 536   else /* if (data->register_type == REG_TYPE_UINT16) */
 537   {
 538     value_t vt;
 539
 540     DEBUG ("Modbus plugin: mb_read_data: "
 541         "Returned uint16 value is %"PRIu16, values[0]);
 542
 543     CAST_TO_VALUE_T (ds, vt, values[0]);
 544     mb_submit (host, slave, data, vt);
 545   }
 546
 547   return (0);
 548 } /* }}} int mb_read_data */
 549
 550 static int mb_read_slave (mb_host_t *host, mb_slave_t *slave) /* {{{ */
 551 {
 552   mb_data_t *data;
 553   int success;
 554   int status;
 555
 556   if ((host == NULL) || (slave == NULL))
 557     return (EINVAL);
 558
 559   success = 0;
 560   for (data = slave->collect; data != NULL; data = data->next)
 561   {
 562     status = mb_read_data (host, slave, data);
 563     if (status == 0)
 564       success++;
 565   }
 566
 567   if (success == 0)
 568     return (-1);
 569   else
 570     return (0);
 571 } /* }}} int mb_read_slave */
 572
 573 static int mb_read (user_data_t *user_data) /* {{{ */
 574 {
 575   mb_host_t *host;
 576   size_t i;
 577   int success;
 578   int status;
 579
 580   if ((user_data == NULL) || (user_data->data == NULL))
 581     return (EINVAL);
 582
 583   host = user_data->data;
 584
 585   success = 0;
 586   for (i = 0; i < host->slaves_num; i++)
 587   {
 588     status = mb_read_slave (host, host->slaves + i);
 589     if (status == 0)
 590       success++;
 591   }
 592
 593   if (success == 0)
 594     return (-1);
 595   else
 596     return (0);
 597 } /* }}} int mb_read */
 598
 599 /* Free functions */
 600
 601 static void data_free_one (mb_data_t *data) /* {{{ */
 602 {
 603   if (data == NULL)
 604     return;
 605
 606   sfree (data->name);
 607   sfree (data);
 608 } /* }}} void data_free_one */
 609
 610 static void data_free_all (mb_data_t *data) /* {{{ */
 611 {
 612   mb_data_t *next;
 613
 614   if (data == NULL)
 615     return;
 616
 617   next = data->next;
 618   data_free_one (data);
 619
 620   data_free_all (next);
 621 } /* }}} void data_free_all */
 622
 623 static void slaves_free_all (mb_slave_t *slaves, size_t slaves_num) /* {{{ */
 624 {
 625   size_t i;
 626
 627   if (slaves == NULL)
 628     return;
 629
 630   for (i = 0; i < slaves_num; i++)
 631     data_free_all (slaves[i].collect);
 632   sfree (slaves);
 633 } /* }}} void slaves_free_all */
 634
 635 static void host_free (void *void_host) /* {{{ */
 636 {
 637   mb_host_t *host = void_host;
 638
 639   if (host == NULL)
 640     return;
 641
 642   slaves_free_all (host->slaves, host->slaves_num);
 643   sfree (host);
 644 } /* }}} void host_free */
 645
 646 /* Config functions */
 647
 648 static int mb_config_add_data (oconfig_item_t *ci) /* {{{ */
 649 {
 650   mb_data_t data;
 651   int status;
 652   int i;
 653
 654   memset (&data, 0, sizeof (data));
 655   data.name = NULL;
 656   data.register_type = REG_TYPE_UINT16;
 657   data.next = NULL;
 658
 659   status = cf_util_get_string (ci, &data.name);
 660   if (status != 0)
 661     return (status);
 662
 663   for (i = 0; i < ci->children_num; i++)
 664   {
 665     oconfig_item_t *child = ci->children + i;
 666     status = 0;
 667
 668     if (strcasecmp ("Type", child->key) == 0)
 669       status = cf_util_get_string_buffer (child,
 670           data.type, sizeof (data.type));
 671     else if (strcasecmp ("Instance", child->key) == 0)
 672       status = cf_util_get_string_buffer (child,
 673           data.instance, sizeof (data.instance));
 674     else if (strcasecmp ("RegisterBase", child->key) == 0)
 675       status = cf_util_get_int (child, &data.register_base);
 676     else if (strcasecmp ("RegisterType", child->key) == 0)
 677     {
 678       char tmp[16];
 679       status = cf_util_get_string_buffer (child, tmp, sizeof (tmp));
 680       if (status != 0)
 681         /* do nothing */;
 682       else if (strcasecmp ("Int16", tmp) == 0)
 683         data.register_type = REG_TYPE_INT16;
 684       else if (strcasecmp ("Int32", tmp) == 0)
 685         data.register_type = REG_TYPE_INT32;
 686       else if (strcasecmp ("Uint16", tmp) == 0)
 687         data.register_type = REG_TYPE_UINT16;
 688       else if (strcasecmp ("Uint32", tmp) == 0)
 689         data.register_type = REG_TYPE_UINT32;
 690       else if (strcasecmp ("Float", tmp) == 0)
 691         data.register_type = REG_TYPE_FLOAT;
 692       else
 693       {
 694         ERROR ("Modbus plugin: The register type \"%s\" is unknown.", tmp);
 695         status = -1;
 696       }
 697     }
 698     else
 699     {
 700       ERROR ("Modbus plugin: Unknown configuration option: %s", child->key);
 701       status = -1;
 702     }
 703
 704     if (status != 0)
 705       break;
 706   } /* for (i = 0; i < ci->children_num; i++) */
 707
 708   assert (data.name != NULL);
 709   if (data.type[0] == 0)
 710   {
 711     ERROR ("Modbus plugin: Data block \"%s\": No type has been specified.",
 712         data.name);
 713     status = -1;
 714   }
 715
 716   if (status == 0)
 717     data_copy (&data_definitions, &data);
 718
 719   sfree (data.name);
 720
 721   return (status);
 722 } /* }}} int mb_config_add_data */
 723
 724 static int mb_config_set_host_address (mb_host_t *host, /* {{{ */
 725     const char *address)
 726 {
 727   struct addrinfo *ai_list;
 728   struct addrinfo *ai_ptr;
 729   struct addrinfo  ai_hints;
 730   int status;
 731
 732   if ((host == NULL) || (address == NULL))
 733     return (EINVAL);
 734
 735   memset (&ai_hints, 0, sizeof (ai_hints));
 736 #if AI_ADDRCONFIG
 737   ai_hints.ai_flags |= AI_ADDRCONFIG;
 738 #endif
 739   /* XXX: libmodbus can only handle IPv4 addresses. */
 740   ai_hints.ai_family = AF_INET;
 741   ai_hints.ai_addr = NULL;
 742   ai_hints.ai_canonname = NULL;
 743   ai_hints.ai_next = NULL;
 744
 745   ai_list = NULL;
 746   status = getaddrinfo (address, /* service = */ NULL,
 747       &ai_hints, &ai_list);
 748   if (status != 0)
 749   {
 750     char errbuf[1024];
 751     ERROR ("Modbus plugin: getaddrinfo failed: %s",
 752         (status == EAI_SYSTEM)
 753         ? sstrerror (errno, errbuf, sizeof (errbuf))
 754         : gai_strerror (status));
 755     return (status);
 756   }
 757
 758   for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
 759   {
 760     status = getnameinfo (ai_ptr->ai_addr, ai_ptr->ai_addrlen,
 761         host->node, sizeof (host->node),
 762         /* service = */ NULL, /* length = */ 0,
 763         /* flags = */ NI_NUMERICHOST);
 764     if (status == 0)
 765       break;
 766   } /* for (ai_ptr) */
 767
 768   freeaddrinfo (ai_list);
 769
 770   if (status != 0)
 771     ERROR ("Modbus plugin: Unable to translate node name: \"%s\"", address);
 772   else /* if (status == 0) */
 773   {
 774     DEBUG ("Modbus plugin: mb_config_set_host_address: %s -> %s",
 775         address, host->node);
 776   }
 777
 778   return (status);
 779 } /* }}} int mb_config_set_host_address */
 780
 781 static int mb_config_add_slave (mb_host_t *host, oconfig_item_t *ci) /* {{{ */
 782 {
 783   mb_slave_t *slave;
 784   int status;
 785   int i;
 786
 787   if ((host == NULL) || (ci == NULL))
 788     return (EINVAL);
 789
 790   slave = realloc (host->slaves, sizeof (*slave) * (host->slaves_num + 1));
 791   if (slave == NULL)
 792     return (ENOMEM);
 793   host->slaves = slave;
 794   slave = host->slaves + host->slaves_num;
 795   memset (slave, 0, sizeof (*slave));
 796   slave->collect = NULL;
 797
 798   status = cf_util_get_int (ci, &slave->id);
 799   if (status != 0)
 800     return (status);
 801
 802   for (i = 0; i < ci->children_num; i++)
 803   {
 804     oconfig_item_t *child = ci->children + i;
 805     status = 0;
 806
 807     if (strcasecmp ("Instance", child->key) == 0)
 808       status = cf_util_get_string_buffer (child,
 809           slave->instance, sizeof (slave->instance));
 810     else if (strcasecmp ("Collect", child->key) == 0)
 811     {
 812       char buffer[1024];
 813       status = cf_util_get_string_buffer (child, buffer, sizeof (buffer));
 814       if (status == 0)
 815         data_copy_by_name (&slave->collect, data_definitions, buffer);
 816       status = 0; /* continue after failure. */
 817     }
 818     else
 819     {
 820       ERROR ("Modbus plugin: Unknown configuration option: %s", child->key);
 821       status = -1;
 822     }
 823
 824     if (status != 0)
 825       break;
 826   }
 827
 828   if ((status == 0) && (slave->collect == NULL))
 829     status = EINVAL;
 830
 831   if (slave->id < 0)
 832     status = EINVAL;
 833
 834   if (status == 0)
 835     host->slaves_num++;
 836   else /* if (status != 0) */
 837     data_free_all (slave->collect);
 838
 839   return (status);
 840 } /* }}} int mb_config_add_slave */
 841
 842 static int mb_config_add_host (oconfig_item_t *ci) /* {{{ */
 843 {
 844   mb_host_t *host;
 845   int status;
 846   int i;
 847
 848   host = malloc (sizeof (*host));
 849   if (host == NULL)
 850     return (ENOMEM);
 851   memset (host, 0, sizeof (*host));
 852   host->slaves = NULL;
 853
 854   status = cf_util_get_string_buffer (ci, host->host, sizeof (host->host));
 855   if (status != 0)
 856     return (status);
 857   if (host->host[0] == 0)
 858     return (EINVAL);
 859
 860   for (i = 0; i < ci->children_num; i++)
 861   {
 862     oconfig_item_t *child = ci->children + i;
 863     status = 0;
 864
 865     if (strcasecmp ("Address", child->key) == 0)
 866     {
 867       char buffer[NI_MAXHOST];
 868       status = cf_util_get_string_buffer (child, buffer, sizeof (buffer));
 869       if (status == 0)
 870         status = mb_config_set_host_address (host, buffer);
 871     }
 872     else if (strcasecmp ("Port", child->key) == 0)
 873     {
 874       host->port = cf_util_get_port_number (child);
 875       if (host->port <= 0)
 876         status = -1;
 877     }
 878     else if (strcasecmp ("Interval", child->key) == 0)
 879       status = cf_util_get_cdtime (child, &host->interval);
 880     else if (strcasecmp ("Slave", child->key) == 0)
 881       /* Don't set status: Gracefully continue if a slave fails. */
 882       mb_config_add_slave (host, child);
 883     else
 884     {
 885       ERROR ("Modbus plugin: Unknown configuration option: %s", child->key);
 886       status = -1;
 887     }
 888
 889     if (status != 0)
 890       break;
 891   } /* for (i = 0; i < ci->children_num; i++) */
 892
 893   assert (host->host[0] != 0);
 894   if (host->host[0] == 0)
 895   {
 896     ERROR ("Modbus plugin: Data block \"%s\": No type has been specified.",
 897         host->host);
 898     status = -1;
 899   }
 900
 901   if (status == 0)
 902   {
 903     user_data_t ud;
 904     char name[1024];
 905     struct timespec interval = { 0, 0 };
 906
 907     ud.data = host;
 908     ud.free_func = host_free;
 909
 910     ssnprintf (name, sizeof (name), "modbus-%s", host->host);
 911
 912     CDTIME_T_TO_TIMESPEC (host->interval, &interval);
 913
 914     plugin_register_complex_read (/* group = */ NULL, name,
 915         /* callback = */ mb_read,
 916         /* interval = */ (host->interval > 0) ? &interval : NULL,
 917         &ud);
 918   }
 919   else
 920   {
 921     host_free (host);
 922   }
 923
 924   return (status);
 925 } /* }}} int mb_config_add_host */
 926
 927 static int mb_config (oconfig_item_t *ci) /* {{{ */
 928 {
 929   int i;
 930
 931   if (ci == NULL)
 932     return (EINVAL);
 933
 934   for (i = 0; i < ci->children_num; i++)
 935   {
 936     oconfig_item_t *child = ci->children + i;
 937
 938     if (strcasecmp ("Data", child->key) == 0)
 939       mb_config_add_data (child);
 940     else if (strcasecmp ("Host", child->key) == 0)
 941       mb_config_add_host (child);
 942     else
 943       ERROR ("Modbus plugin: Unknown configuration option: %s", child->key);
 944   }
 945
 946   return (0);
 947 } /* }}} int mb_config */
 948
 949 /* ========= */
 950
 951 static int mb_shutdown (void) /* {{{ */
 952 {
 953   data_free_all (data_definitions);
 954   data_definitions = NULL;
 955
 956   return (0);
 957 } /* }}} int mb_shutdown */
 958
 959 void module_register (void)
 960 {
 961   plugin_register_complex_config ("modbus", mb_config);
 962   plugin_register_shutdown ("modbus", mb_shutdown);
 963 } /* void module_register */
 964
 965 /* vim: set sw=2 sts=2 et fdm=marker : */