src/zeromq.c

   1 /**
   2  * collectd - src/zeromq.c
   3  * Copyright (C) 2005-2009  Florian octo Forster
   4  * Copyright (C) 2009       Aman Gupta
   5  * Copyright (C) 2010       Julien Ammous
   6  *
   7  * This program is free software; you can redistribute it and/or modify it
   8  * under the terms of the GNU General Public License as published by the
   9  * Free Software Foundation; only version 2 of the License is applicable.
  10  *
  11  * This program is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  *
  20  * Authors:
  21  *   Florian octo Forster <octo at verplant.org>
  22  *   Aman Gupta <aman at tmm1.net>
  23  *   Julien Ammous
  24  **/
  25
  26 #include "collectd.h"
  27 #include "common.h" /* auxiliary functions */
  28 #include "plugin.h" /* plugin_register_*, plugin_dispatch_values */
  29 #include "utils_cache.h"
  30 #include "network.h"
  31
  32 #include <pthread.h>
  33 #include <zmq.h>
  34
  35 // copy/paste from network.c ...
  36
  37 static value_list_t     send_buffer_vl = VALUE_LIST_STATIC;
  38
  39 static uint64_t stats_values_not_dispatched = 0;
  40 static uint64_t stats_values_dispatched = 0;
  41
  42 /*                      1 1 1 1 1 1 1 1 1 1 2 2 2 2 2 2 2 2 2 2 3 3
  43  *  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  44  * +-------+-----------------------+-------------------------------+
  45  * ! Ver.  !                       ! Length                        !
  46  * +-------+-----------------------+-------------------------------+
  47  */
  48 struct part_header_s
  49 {
  50         uint16_t type;
  51         uint16_t length;
  52 };
  53 typedef struct part_header_s part_header_t;
  54
  55 // we do not want to crypt here
  56 #undef HAVE_LIBGCRYPT
  57
  58 static _Bool check_receive_okay (const value_list_t *vl) /* {{{ */
  59 {
  60   uint64_t time_sent = 0;
  61   int status;
  62
  63   status = uc_meta_data_get_unsigned_int (vl,
  64       "network:time_sent", &time_sent);
  65
  66   /* This is a value we already sent. Don't allow it to be received again in
  67    * order to avoid looping. */
  68   if ((status == 0) && (time_sent >= ((uint64_t) vl->time)))
  69     return (false);
  70
  71   return (true);
  72 } /* }}} _Bool check_receive_okay */
  73
  74 static int network_dispatch_values (value_list_t *vl, /* {{{ */
  75     const char *username)
  76 {
  77   int status;
  78
  79   // DEBUG("host: %s", vl->host);
  80   // DEBUG("plugin: %s", vl->plugin);
  81   // DEBUG("plugin_instance: %s", vl->plugin_instance);
  82   // DEBUG("type: %s", vl->type);
  83   // DEBUG("type_instance: %s", vl->type_instance);
  84
  85   if ((vl->time <= 0)
  86       || (strlen (vl->host) <= 0)
  87       || (strlen (vl->plugin) <= 0)
  88       || (strlen (vl->type) <= 0))
  89     return (-EINVAL);
  90
  91   if (!check_receive_okay (vl))
  92   {
  93 #if COLLECT_DEBUG
  94     char name[6*DATA_MAX_NAME_LEN];
  95     FORMAT_VL (name, sizeof (name), vl);
  96     name[sizeof (name) - 1] = 0;
  97     DEBUG ("network plugin: network_dispatch_values: "
  98         "NOT dispatching %s.", name);
  99 #endif
 100     stats_values_not_dispatched++;
 101     return (0);
 102   }
 103
 104   assert (vl->meta == NULL);
 105
 106   vl->meta = meta_data_create ();
 107   if (vl->meta == NULL)
 108   {
 109     ERROR ("network plugin: meta_data_create failed.");
 110     return (-ENOMEM);
 111   }
 112
 113   status = meta_data_add_boolean (vl->meta, "network:received", true);
 114   if (status != 0)
 115   {
 116     ERROR ("network plugin: meta_data_add_boolean failed.");
 117     meta_data_destroy (vl->meta);
 118     vl->meta = NULL;
 119     return (status);
 120   }
 121
 122   if (username != NULL)
 123   {
 124     status = meta_data_add_string (vl->meta, "network:username", username);
 125     if (status != 0)
 126     {
 127       ERROR ("network plugin: meta_data_add_string failed.");
 128       meta_data_destroy (vl->meta);
 129       vl->meta = NULL;
 130       return (status);
 131     }
 132   }
 133
 134   // DEBUG("dispatching %d values", vl->values_len);
 135   plugin_dispatch_values (vl);
 136   stats_values_dispatched++;
 137
 138   meta_data_destroy (vl->meta);
 139   vl->meta = NULL;
 140
 141   return (0);
 142 } /* }}} int network_dispatch_values */
 143
 144 static int write_part_values (char **ret_buffer, int *ret_buffer_len, const data_set_t *ds, const value_list_t *vl)
 145 {
 146   char *packet_ptr;
 147   int packet_len;
 148   int num_values;
 149
 150   part_header_t pkg_ph;
 151   uint16_t      pkg_num_values;
 152   uint8_t      *pkg_values_types;
 153   value_t      *pkg_values;
 154
 155   int offset;
 156   int i;
 157
 158   num_values = vl->values_len;
 159   packet_len = sizeof (part_header_t) + sizeof (uint16_t)
 160     + (num_values * sizeof (uint8_t))
 161     + (num_values * sizeof (value_t));
 162
 163   if (*ret_buffer_len < packet_len)
 164     return (-1);
 165
 166   pkg_values_types = (uint8_t *) malloc (num_values * sizeof (uint8_t));
 167   if (pkg_values_types == NULL)
 168   {
 169     ERROR ("network plugin: write_part_values: malloc failed.");
 170     return (-1);
 171   }
 172
 173   pkg_values = (value_t *) malloc (num_values * sizeof (value_t));
 174   if (pkg_values == NULL)
 175   {
 176     free (pkg_values_types);
 177     ERROR ("network plugin: write_part_values: malloc failed.");
 178     return (-1);
 179   }
 180
 181   pkg_ph.type = htons (TYPE_VALUES);
 182   pkg_ph.length = htons (packet_len);
 183
 184   pkg_num_values = htons ((uint16_t) vl->values_len);
 185
 186   for (i = 0; i < num_values; i++)
 187   {
 188     pkg_values_types[i] = (uint8_t) ds->ds[i].type;
 189     switch (ds->ds[i].type)
 190     {
 191       case DS_TYPE_COUNTER:
 192         pkg_values[i].counter = htonll (vl->values[i].counter);
 193         break;
 194
 195       case DS_TYPE_GAUGE:
 196         pkg_values[i].gauge = htond (vl->values[i].gauge);
 197         break;
 198
 199       case DS_TYPE_DERIVE:
 200         pkg_values[i].derive = htonll (vl->values[i].derive);
 201         break;
 202
 203       case DS_TYPE_ABSOLUTE:
 204         pkg_values[i].absolute = htonll (vl->values[i].absolute);
 205         break;
 206
 207       default:
 208         free (pkg_values_types);
 209         free (pkg_values);
 210         ERROR ("network plugin: write_part_values: "
 211             "Unknown data source type: %i",
 212             ds->ds[i].type);
 213         return (-1);
 214     } /* switch (ds->ds[i].type) */
 215   } /* for (num_values) */
 216
 217   /*
 218    * Use `memcpy' to write everything to the buffer, because the pointer
 219    * may be unaligned and some architectures, such as SPARC, can't handle
 220    * that.
 221    */
 222   packet_ptr = *ret_buffer;
 223   offset = 0;
 224   memcpy (packet_ptr + offset, &pkg_ph, sizeof (pkg_ph));
 225   offset += sizeof (pkg_ph);
 226   memcpy (packet_ptr + offset, &pkg_num_values, sizeof (pkg_num_values));
 227   offset += sizeof (pkg_num_values);
 228   memcpy (packet_ptr + offset, pkg_values_types, num_values * sizeof (uint8_t));
 229   offset += num_values * sizeof (uint8_t);
 230   memcpy (packet_ptr + offset, pkg_values, num_values * sizeof (value_t));
 231   offset += num_values * sizeof (value_t);
 232
 233   assert (offset == packet_len);
 234
 235   *ret_buffer = packet_ptr + packet_len;
 236   *ret_buffer_len -= packet_len;
 237
 238   free (pkg_values_types);
 239   free (pkg_values);
 240
 241   return (0);
 242 } /* int write_part_values */
 243
 244 static int write_part_number (char **ret_buffer, int *ret_buffer_len,
 245     int type, uint64_t value)
 246 {
 247   char *packet_ptr;
 248   int packet_len;
 249
 250   part_header_t pkg_head;
 251   uint64_t pkg_value;
 252
 253   int offset;
 254
 255   packet_len = sizeof (pkg_head) + sizeof (pkg_value);
 256
 257   if (*ret_buffer_len < packet_len)
 258     return (-1);
 259
 260   pkg_head.type = htons (type);
 261   pkg_head.length = htons (packet_len);
 262   pkg_value = htonll (value);
 263
 264   packet_ptr = *ret_buffer;
 265   offset = 0;
 266   memcpy (packet_ptr + offset, &pkg_head, sizeof (pkg_head));
 267   offset += sizeof (pkg_head);
 268   memcpy (packet_ptr + offset, &pkg_value, sizeof (pkg_value));
 269   offset += sizeof (pkg_value);
 270
 271   assert (offset == packet_len);
 272
 273   *ret_buffer = packet_ptr + packet_len;
 274   *ret_buffer_len -= packet_len;
 275
 276   return (0);
 277 } /* int write_part_number */
 278
 279 static int write_part_string (char **ret_buffer, int *ret_buffer_len,
 280     int type, const char *str, int str_len)
 281 {
 282   char *buffer;
 283   int buffer_len;
 284
 285   uint16_t pkg_type;
 286   uint16_t pkg_length;
 287
 288   int offset;
 289
 290   buffer_len = 2 * sizeof (uint16_t) + str_len + 1;
 291   if (*ret_buffer_len < buffer_len)
 292     return (-1);
 293
 294   pkg_type = htons (type);
 295   pkg_length = htons (buffer_len);
 296
 297   buffer = *ret_buffer;
 298   offset = 0;
 299   memcpy (buffer + offset, (void *) &pkg_type, sizeof (pkg_type));
 300   offset += sizeof (pkg_type);
 301   memcpy (buffer + offset, (void *) &pkg_length, sizeof (pkg_length));
 302   offset += sizeof (pkg_length);
 303   memcpy (buffer + offset, str, str_len);
 304   offset += str_len;
 305   memset (buffer + offset, '\0', 1);
 306   offset += 1;
 307
 308   assert (offset == buffer_len);
 309
 310   *ret_buffer = buffer + buffer_len;
 311   *ret_buffer_len -= buffer_len;
 312
 313   return (0);
 314 } /* int write_part_string */
 315
 316 static int parse_part_values (void **ret_buffer, size_t *ret_buffer_len,
 317     value_t **ret_values, int *ret_num_values)
 318 {
 319   char *buffer = *ret_buffer;
 320   size_t buffer_len = *ret_buffer_len;
 321
 322   uint16_t tmp16;
 323   size_t exp_size;
 324   int   i;
 325
 326   uint16_t pkg_length;
 327   uint16_t pkg_type;
 328   uint16_t pkg_numval;
 329
 330   uint8_t *pkg_types;
 331   value_t *pkg_values;
 332
 333   if (buffer_len < 15)
 334   {
 335     NOTICE ("network plugin: packet is too short: "
 336         "buffer_len = %zu", buffer_len);
 337     return (-1);
 338   }
 339
 340   memcpy ((void *) &tmp16, buffer, sizeof (tmp16));
 341   buffer += sizeof (tmp16);
 342   pkg_type = ntohs (tmp16);
 343
 344   memcpy ((void *) &tmp16, buffer, sizeof (tmp16));
 345   buffer += sizeof (tmp16);
 346   pkg_length = ntohs (tmp16);
 347
 348   memcpy ((void *) &tmp16, buffer, sizeof (tmp16));
 349   buffer += sizeof (tmp16);
 350   pkg_numval = ntohs (tmp16);
 351
 352   assert (pkg_type == TYPE_VALUES);
 353
 354   exp_size = 3 * sizeof (uint16_t)
 355     + pkg_numval * (sizeof (uint8_t) + sizeof (value_t));
 356   if ((buffer_len < 0) || (buffer_len < exp_size))
 357   {
 358     WARNING ("network plugin: parse_part_values: "
 359         "Packet too short: "
 360         "Chunk of size %zu expected, "
 361         "but buffer has only %zu bytes left.",
 362         exp_size, buffer_len);
 363     return (-1);
 364   }
 365
 366   if (pkg_length != exp_size)
 367   {
 368     WARNING ("network plugin: parse_part_values: "
 369         "Length and number of values "
 370         "in the packet don't match.");
 371     return (-1);
 372   }
 373
 374   pkg_types = (uint8_t *) malloc (pkg_numval * sizeof (uint8_t));
 375   pkg_values = (value_t *) malloc (pkg_numval * sizeof (value_t));
 376   if ((pkg_types == NULL) || (pkg_values == NULL))
 377   {
 378     sfree (pkg_types);
 379     sfree (pkg_values);
 380     ERROR ("network plugin: parse_part_values: malloc failed.");
 381     return (-1);
 382   }
 383
 384   memcpy ((void *) pkg_types, (void *) buffer, pkg_numval * sizeof (uint8_t));
 385   buffer += pkg_numval * sizeof (uint8_t);
 386   memcpy ((void *) pkg_values, (void *) buffer, pkg_numval * sizeof (value_t));
 387   buffer += pkg_numval * sizeof (value_t);
 388
 389   for (i = 0; i < pkg_numval; i++)
 390   {
 391     switch (pkg_types[i])
 392     {
 393       case DS_TYPE_COUNTER:
 394         pkg_values[i].counter = (counter_t) ntohll (pkg_values[i].counter);
 395         break;
 396
 397       case DS_TYPE_GAUGE:
 398         pkg_values[i].gauge = (gauge_t) ntohd (pkg_values[i].gauge);
 399         break;
 400
 401       case DS_TYPE_DERIVE:
 402         pkg_values[i].derive = (derive_t) ntohll (pkg_values[i].derive);
 403         break;
 404
 405       case DS_TYPE_ABSOLUTE:
 406         pkg_values[i].absolute = (absolute_t) ntohll (pkg_values[i].absolute);
 407         break;
 408
 409       default:
 410         NOTICE ("network plugin: parse_part_values: "
 411       "Don't know how to handle data source type %"PRIu8,
 412       pkg_types[i]);
 413         sfree (pkg_types);
 414         sfree (pkg_values);
 415         return (-1);
 416     } /* switch (pkg_types[i]) */
 417   }
 418
 419   *ret_buffer     = buffer;
 420   *ret_buffer_len = buffer_len - pkg_length;
 421   *ret_num_values = pkg_numval;
 422   *ret_values     = pkg_values;
 423
 424   sfree (pkg_types);
 425
 426   return (0);
 427 } /* int parse_part_values */
 428
 429 static int add_to_buffer (char *buffer, int buffer_size, /* {{{ */
 430     value_list_t *vl_def,
 431     const data_set_t *ds, const value_list_t *vl)
 432 {
 433   char *buffer_orig = buffer;
 434
 435   if (write_part_string (&buffer, &buffer_size, TYPE_HOST, vl->host, strlen (vl->host)) != 0)
 436     return (-1);
 437
 438   if (write_part_number (&buffer, &buffer_size, TYPE_TIME, (uint64_t) vl->time))
 439     return (-1);
 440
 441   if (write_part_number (&buffer, &buffer_size, TYPE_INTERVAL, (uint64_t) vl->interval))
 442     return (-1);
 443
 444   if (write_part_string (&buffer, &buffer_size, TYPE_PLUGIN, vl->plugin, strlen (vl->plugin)) != 0)
 445     return (-1);
 446
 447   if (write_part_string (&buffer, &buffer_size, TYPE_PLUGIN_INSTANCE, vl->plugin_instance, strlen (vl->plugin_instance)) != 0)
 448     return (-1);
 449
 450   if (write_part_string (&buffer, &buffer_size, TYPE_TYPE, vl->type, strlen (vl->type)) != 0)
 451     return (-1);
 452
 453   if (write_part_string (&buffer, &buffer_size, TYPE_TYPE_INSTANCE, vl->type_instance, strlen (vl->type_instance)) != 0)
 454     return (-1);
 455
 456   if (write_part_values (&buffer, &buffer_size, ds, vl) != 0)
 457     return (-1);
 458
 459   return (buffer - buffer_orig);
 460 } /* }}} int add_to_buffer */
 461
 462 static int parse_part_number (void **ret_buffer, size_t *ret_buffer_len,
 463     uint64_t *value)
 464 {
 465   char *buffer = *ret_buffer;
 466   size_t buffer_len = *ret_buffer_len;
 467
 468   uint16_t tmp16;
 469   uint64_t tmp64;
 470   size_t exp_size = 2 * sizeof (uint16_t) + sizeof (uint64_t);
 471
 472   uint16_t pkg_length;
 473   uint16_t pkg_type;
 474
 475   if ((buffer_len < 0) || ((size_t) buffer_len < exp_size))
 476   {
 477     WARNING ("network plugin: parse_part_number: "
 478         "Packet too short: "
 479         "Chunk of size %zu expected, "
 480         "but buffer has only %zu bytes left.",
 481         exp_size, buffer_len);
 482     return (-1);
 483   }
 484
 485   memcpy ((void *) &tmp16, buffer, sizeof (tmp16));
 486   buffer += sizeof (tmp16);
 487   pkg_type = ntohs (tmp16);
 488
 489   memcpy ((void *) &tmp16, buffer, sizeof (tmp16));
 490   buffer += sizeof (tmp16);
 491   pkg_length = ntohs (tmp16);
 492
 493   memcpy ((void *) &tmp64, buffer, sizeof (tmp64));
 494   buffer += sizeof (tmp64);
 495   *value = ntohll (tmp64);
 496
 497   *ret_buffer = buffer;
 498   *ret_buffer_len = buffer_len - pkg_length;
 499
 500   return (0);
 501 } /* int parse_part_number */
 502
 503 static int parse_part_string (void **ret_buffer, size_t *ret_buffer_len,
 504     char *output, int output_len)
 505 {
 506   char *buffer = *ret_buffer;
 507   size_t buffer_len = *ret_buffer_len;
 508
 509   uint16_t tmp16;
 510   size_t header_size = 2 * sizeof (uint16_t);
 511
 512   uint16_t pkg_length;
 513   uint16_t pkg_type;
 514
 515   if ((buffer_len < 0) || (buffer_len < header_size))
 516   {
 517     WARNING ("network plugin: parse_part_string: "
 518         "Packet too short: "
 519         "Chunk of at least size %zu expected, "
 520         "but buffer has only %zu bytes left.",
 521         header_size, buffer_len);
 522     return (-1);
 523   }
 524
 525   memcpy ((void *) &tmp16, buffer, sizeof (tmp16));
 526   buffer += sizeof (tmp16);
 527   pkg_type = ntohs (tmp16);
 528
 529   memcpy ((void *) &tmp16, buffer, sizeof (tmp16));
 530   buffer += sizeof (tmp16);
 531   pkg_length = ntohs (tmp16);
 532
 533   /* Check that packet fits in the input buffer */
 534   if (pkg_length > buffer_len)
 535   {
 536     WARNING ("network plugin: parse_part_string: "
 537         "Packet too big: "
 538         "Chunk of size %"PRIu16" received, "
 539         "but buffer has only %zu bytes left.",
 540         pkg_length, buffer_len);
 541     return (-1);
 542   }
 543
 544   /* Check that pkg_length is in the valid range */
 545   if (pkg_length <= header_size)
 546   {
 547     WARNING ("network plugin: parse_part_string: "
 548         "Packet too short: "
 549         "Header claims this packet is only %hu "
 550         "bytes long.", pkg_length);
 551     return (-1);
 552   }
 553
 554   /* Check that the package data fits into the output buffer.
 555    * The previous if-statement ensures that:
 556    * `pkg_length > header_size' */
 557   if ((output_len < 0)
 558       || ((size_t) output_len < ((size_t) pkg_length - header_size)))
 559   {
 560     WARNING ("network plugin: parse_part_string: "
 561         "Output buffer too small.");
 562     return (-1);
 563   }
 564
 565   /* All sanity checks successfull, let's copy the data over */
 566   output_len = pkg_length - header_size;
 567   memcpy ((void *) output, (void *) buffer, output_len);
 568   buffer += output_len;
 569
 570   /* For some very weird reason '\0' doesn't do the trick on SPARC in
 571    * this statement. */
 572   if (output[output_len - 1] != 0)
 573   {
 574     WARNING ("network plugin: parse_part_string: "
 575         "Received string does not end "
 576         "with a NULL-byte.");
 577     return (-1);
 578   }
 579
 580   *ret_buffer = buffer;
 581   *ret_buffer_len = buffer_len - pkg_length;
 582
 583   return (0);
 584 } /* int parse_part_string */
 585
 586
 587 static int parse_packet (void *se, /* {{{ */
 588     void *buffer, size_t buffer_size, int flags,
 589     const char *username)
 590 {
 591   int status;
 592
 593   value_list_t vl = VALUE_LIST_INIT;
 594   notification_t n;
 595
 596 #if HAVE_LIBGCRYPT
 597   int packet_was_signed = (flags & PP_SIGNED);
 598         int packet_was_encrypted = (flags & PP_ENCRYPTED);
 599   int printed_ignore_warning = 0;
 600 #endif /* HAVE_LIBGCRYPT */
 601
 602
 603   memset (&vl, '\0', sizeof (vl));
 604   memset (&n, '\0', sizeof (n));
 605   status = 0;
 606
 607   while ((status == 0) && (0 < buffer_size)
 608       && ((unsigned int) buffer_size > sizeof (part_header_t)))
 609   {
 610     uint16_t pkg_length;
 611     uint16_t pkg_type;
 612
 613     memcpy ((void *) &pkg_type,
 614         (void *) buffer,
 615         sizeof (pkg_type));
 616     memcpy ((void *) &pkg_length,
 617         (void *) (buffer + sizeof (pkg_type)),
 618         sizeof (pkg_length));
 619
 620     pkg_length = ntohs (pkg_length);
 621     pkg_type = ntohs (pkg_type);
 622
 623     if (pkg_length > buffer_size)
 624       break;
 625     /* Ensure that this loop terminates eventually */
 626     if (pkg_length < (2 * sizeof (uint16_t)))
 627       break;
 628
 629     if (pkg_type == TYPE_ENCR_AES256)
 630     {
 631       // status = parse_part_encr_aes256 (se,
 632       //     &buffer, &buffer_size, flags);
 633       // if (status != 0)
 634       // {
 635         ERROR ("network plugin: Decrypting AES256 "
 636             "part failed "
 637             "with status %i.", status);
 638         break;
 639       // }
 640     }
 641 #if HAVE_LIBGCRYPT
 642     else if ((se->data.server.security_level == SECURITY_LEVEL_ENCRYPT)
 643         && (packet_was_encrypted == 0))
 644     {
 645       if (printed_ignore_warning == 0)
 646       {
 647         INFO ("network plugin: Unencrypted packet or "
 648             "part has been ignored.");
 649         printed_ignore_warning = 1;
 650       }
 651       buffer = ((char *) buffer) + pkg_length;
 652       continue;
 653     }
 654 #endif /* HAVE_LIBGCRYPT */
 655     else if (pkg_type == TYPE_SIGN_SHA256)
 656     {
 657       // status = parse_part_sign_sha256 (se,
 658       //                                   &buffer, &buffer_size, flags);
 659       // if (status != 0)
 660       // {
 661         ERROR ("network plugin: Verifying HMAC-SHA-256 "
 662             "signature failed "
 663             "with status %i.", status);
 664         break;
 665       // }
 666     }
 667 #if HAVE_LIBGCRYPT
 668     else if ((se->data.server.security_level == SECURITY_LEVEL_SIGN)
 669         && (packet_was_encrypted == 0)
 670         && (packet_was_signed == 0))
 671     {
 672       if (printed_ignore_warning == 0)
 673       {
 674         INFO ("network plugin: Unsigned packet or "
 675             "part has been ignored.");
 676         printed_ignore_warning = 1;
 677       }
 678       buffer = ((char *) buffer) + pkg_length;
 679       continue;
 680     }
 681 #endif /* HAVE_LIBGCRYPT */
 682     else if (pkg_type == TYPE_VALUES)
 683     {
 684       status = parse_part_values (&buffer, &buffer_size,
 685           &vl.values, &vl.values_len);
 686       if (status != 0)
 687         break;
 688
 689       network_dispatch_values (&vl, username);
 690
 691       sfree (vl.values);
 692     }
 693     else if (pkg_type == TYPE_TIME)
 694     {
 695       uint64_t tmp = 0;
 696       status = parse_part_number (&buffer, &buffer_size,
 697           &tmp);
 698       if (status == 0)
 699       {
 700         vl.time = (time_t) tmp;
 701         n.time = (time_t) tmp;
 702       }
 703     }
 704     else if (pkg_type == TYPE_INTERVAL)
 705     {
 706       uint64_t tmp = 0;
 707       status = parse_part_number (&buffer, &buffer_size,
 708           &tmp);
 709       if (status == 0)
 710         vl.interval = (int) tmp;
 711     }
 712     else if (pkg_type == TYPE_HOST)
 713     {
 714       status = parse_part_string (&buffer, &buffer_size,
 715           vl.host, sizeof (vl.host));
 716       if (status == 0)
 717         sstrncpy (n.host, vl.host, sizeof (n.host));
 718     }
 719     else if (pkg_type == TYPE_PLUGIN)
 720     {
 721       status = parse_part_string (&buffer, &buffer_size,
 722           vl.plugin, sizeof (vl.plugin));
 723       if (status == 0)
 724         sstrncpy (n.plugin, vl.plugin,
 725             sizeof (n.plugin));
 726     }
 727     else if (pkg_type == TYPE_PLUGIN_INSTANCE)
 728     {
 729       status = parse_part_string (&buffer, &buffer_size,
 730           vl.plugin_instance,
 731           sizeof (vl.plugin_instance));
 732       if (status == 0)
 733         sstrncpy (n.plugin_instance,
 734             vl.plugin_instance,
 735             sizeof (n.plugin_instance));
 736     }
 737     else if (pkg_type == TYPE_TYPE)
 738     {
 739       status = parse_part_string (&buffer, &buffer_size,
 740           vl.type, sizeof (vl.type));
 741       if (status == 0)
 742         sstrncpy (n.type, vl.type, sizeof (n.type));
 743     }
 744     else if (pkg_type == TYPE_TYPE_INSTANCE)
 745     {
 746       status = parse_part_string (&buffer, &buffer_size,
 747           vl.type_instance,
 748           sizeof (vl.type_instance));
 749       if (status == 0)
 750         sstrncpy (n.type_instance, vl.type_instance,
 751             sizeof (n.type_instance));
 752     }
 753     else if (pkg_type == TYPE_MESSAGE)
 754     {
 755       status = parse_part_string (&buffer, &buffer_size,
 756           n.message, sizeof (n.message));
 757
 758       if (status != 0)
 759       {
 760         /* do nothing */
 761       }
 762       else if ((n.severity != NOTIF_FAILURE)
 763           && (n.severity != NOTIF_WARNING)
 764           && (n.severity != NOTIF_OKAY))
 765       {
 766         INFO ("network plugin: "
 767             "Ignoring notification with "
 768             "unknown severity %i.",
 769             n.severity);
 770       }
 771       else if (n.time <= 0)
 772       {
 773         INFO ("network plugin: "
 774             "Ignoring notification with "
 775             "time == 0.");
 776       }
 777       else if (strlen (n.message) <= 0)
 778       {
 779         INFO ("network plugin: "
 780             "Ignoring notification with "
 781             "an empty message.");
 782       }
 783       else
 784       {
 785         plugin_dispatch_notification (&n);
 786       }
 787     }
 788     else if (pkg_type == TYPE_SEVERITY)
 789     {
 790       uint64_t tmp = 0;
 791       status = parse_part_number (&buffer, &buffer_size,
 792           &tmp);
 793       if (status == 0)
 794         n.severity = (int) tmp;
 795     }
 796     else
 797     {
 798       DEBUG ("network plugin: parse_packet: Unknown part"
 799           " type: 0x%04hx", pkg_type);
 800       buffer = ((char *) buffer) + pkg_length;
 801     }
 802   } /* while (buffer_size > sizeof (part_header_t)) */
 803
 804   if (status == 0 && buffer_size > 0)
 805     WARNING ("network plugin: parse_packet: Received truncated "
 806         "packet, try increasing `MaxPacketSize'");
 807
 808   return (status);
 809 } /* }}} int parse_packet */
 810
 811
 812
 813
 814
 815
 816
 817
 818 ////////////////////////////
 819 //// END OF COPY / PASTE ///
 820 ////////////////////////////
 821
 822
 823
 824
 825 static const char *config_keys[] =
 826 {
 827   "ListenOn",
 828   "SendDataTo"
 829 };
 830 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
 831
 832 // config data
 833 static char *zmq_listen_on = NULL;
 834 static char *zmq_send_to = NULL;
 835
 836 // private data
 837 static int thread_running = 1;
 838 static pthread_t listen_thread_id;
 839 static void *zmq_context = NULL;
 840 static void *push_socket = NULL;
 841 static void *pull_socket = NULL;
 842
 843 // return values:
 844 // 0  => success
 845 // -1 => error
 846 //
 847
 848 static int my_config (const char *key, const char *value)
 849 {
 850   if( strcasecmp(key, "ListenOn") == 0 ) {
 851     if( zmq_listen_on != NULL ) {
 852       free(zmq_listen_on);
 853       zmq_listen_on = NULL;
 854     }
 855
 856     if( (zmq_listen_on = strdup(value)) == NULL ) {
 857       return 1;
 858     }
 859   }
 860   else if( strcasecmp(key, "SendDataTo") == 0 ) {
 861     if( zmq_send_to != NULL ) {
 862       free(zmq_send_to);
 863       zmq_send_to = NULL;
 864     }
 865
 866     if( (zmq_send_to = strdup(value)) == NULL ) {
 867       return 1;
 868     }
 869   }
 870
 871
 872   return 0;
 873 }
 874
 875 static void *receive_thread (void __attribute__((unused)) *arg)
 876 {
 877   int status;
 878   zmq_msg_t msg;
 879   char *data = NULL;
 880   size_t data_size;
 881
 882   while( thread_running ) {
 883     status = zmq_msg_init(&msg);
 884     assert( status == 0 );
 885     if( zmq_recv(pull_socket, &msg, 0) != 0 ) {
 886       WARNING("zmq_recv : %s", zmq_strerror(errno));
 887       continue;
 888     }
 889
 890     data = zmq_msg_data(&msg);
 891     data_size = zmq_msg_size(&msg);
 892
 893     parse_packet(NULL, data, data_size,
 894       /* flags = */ 0,
 895       /* username = */ NULL);
 896
 897     DEBUG("ZeroMQ: received data, parse returned %d", status);
 898
 899     if( zmq_msg_close(&msg) != 0 ) {
 900       ERROR("zmq_msg_close : %s", zmq_strerror(errno));
 901     }
 902
 903   }
 904
 905   return NULL;
 906 }
 907
 908 static int plugin_init (void)
 909 {
 910   int major, minor, patch, status;
 911   zmq_version (&major, &minor, &patch);
 912
 913
 914   // init zeromq (1 I/O thread)
 915   zmq_context = zmq_init(1);
 916   if( zmq_context == NULL ) {
 917     ERROR("zmq_init : %s", zmq_strerror(errno));
 918     return 1;
 919   }
 920
 921   // start listening socket
 922   if( zmq_listen_on != NULL ) {
 923     pull_socket = zmq_socket(zmq_context, ZMQ_PULL);
 924     if( pull_socket == NULL ) {
 925       ERROR("zmq_socket : %s", zmq_strerror(errno));
 926       return 1;
 927     }
 928
 929     // and bind it to the inbound queue
 930     if( zmq_bind(pull_socket, zmq_listen_on) != 0 ) {
 931       ERROR("zmq_bind : %s", zmq_strerror(errno));
 932       return 1;
 933     }
 934
 935     // listenining thread
 936     status = pthread_create(&listen_thread_id,
 937       NULL /* no attributes */,
 938       receive_thread,
 939       NULL /* no argument */);
 940
 941     if( status != 0 ) {
 942       ERROR("network: pthread_create failed: %s", strerror(errno));
 943       return 1;
 944     }
 945
 946     INFO("ZeroMQ listening on %s", zmq_listen_on);
 947   }
 948
 949   // start send socket
 950   if( zmq_send_to != NULL ) {
 951     push_socket = zmq_socket(zmq_context, ZMQ_PUSH);
 952
 953     if( push_socket == NULL ) {
 954       ERROR("zmq_socket : %s", zmq_strerror(errno));
 955       return 1;
 956     }
 957
 958     // and connect to remote host
 959     if( zmq_connect(push_socket, zmq_send_to) != 0 ) {
 960       ERROR("zmq_connect : %s", zmq_strerror(errno));
 961       return 1;
 962     }
 963
 964     INFO("ZeroMQ pushing to %s", zmq_send_to);
 965   }
 966
 967
 968
 969   INFO("ZeroMQ plugin initialized (zeromq v%d.%d.%d).", major, minor, patch);
 970   return 0;
 971 }
 972
 973
 974
 975 static int write_notification (const notification_t *n, user_data_t __attribute__((unused)) *user_data)
 976 {
 977   DEBUG("ZeroMQ: received notification, not implemented yet");
 978   return 0;
 979 }
 980
 981 void free_data(void *data, void *hint)
 982 {
 983   free(data);
 984 }
 985
 986 #define PACKET_SIZE   512
 987
 988 static int write_value (const data_set_t *ds, const value_list_t *vl,
 989                 user_data_t __attribute__((unused)) *user_data)
 990 {
 991   zmq_msg_t msg;
 992   char      *send_buffer;
 993   int       send_buffer_size = PACKET_SIZE, real_size;
 994
 995   // do nothing if no socket open
 996   if( zmq_send_to == NULL )
 997     return 0;
 998
 999   send_buffer = malloc(PACKET_SIZE);
1000   if( send_buffer == NULL ) {
1001     ERROR("Unable to allocate memory for send_buffer, aborting write");
1002     return 1;
1003   }
1004
1005   // empty buffer
1006   memset(send_buffer, 0, PACKET_SIZE);
1007
1008   real_size = add_to_buffer(send_buffer, send_buffer_size, &send_buffer_vl, ds, vl);
1009
1010   // zeromq will free the memory when needed by calling the free_data function
1011   if( zmq_msg_init_data(&msg, send_buffer, real_size, free_data, NULL) != 0 ) {
1012     ERROR("zmq_msg_init : %s", zmq_strerror(errno));
1013     return 1;
1014   }
1015
1016   // try to send the message
1017   if( zmq_send(push_socket, &msg, ZMQ_NOBLOCK) != 0 ) {
1018     if( errno == EAGAIN ) {
1019       WARNING("ZeroMQ: Cannot send message, queue is full");
1020     }
1021     else {
1022       ERROR("zmq_send : %s", zmq_strerror(errno));
1023       return 1;
1024     }
1025   }
1026
1027   DEBUG("ZeroMQ: data sent");
1028
1029   return 0;
1030 }
1031
1032 static int my_shutdown (void)
1033 {
1034   if( zmq_context ) {
1035
1036     thread_running = 0;
1037
1038     DEBUG("ZeroMQ: shutting down");
1039
1040     if( zmq_term(zmq_context) != 0 ) {
1041       ERROR("zmq_term : %s", zmq_strerror(errno));
1042       return 1;
1043     }
1044
1045     pthread_join(listen_thread_id, NULL);
1046   }
1047
1048   return 0;
1049 }
1050
1051 void module_register (void)
1052 {
1053   plugin_register_config("zeromq", my_config, config_keys, config_keys_num);
1054   plugin_register_init("zeromq", plugin_init);
1055   plugin_register_write("zeromq", write_value,
1056       /* user_data = */ NULL);
1057   plugin_register_notification ("network", write_notification,
1058       /* user_data = */ NULL);
1059   plugin_register_shutdown ("zeromq", my_shutdown);
1060 }