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