2 * collectd - src/zeromq.c
3 * Copyright (C) 2005-2010 Florian octo Forster
4 * Copyright (C) 2009 Aman Gupta
5 * Copyright (C) 2010 Julien Ammous
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.
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.
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
21 * Florian octo Forster <octo at verplant.org>
22 * Aman Gupta <aman at tmm1.net>
27 // mostly copy/pasted from network.c ...
28 // this whole file will be dropped as soon as
29 // it can be replaced by network_buffer library
32 static value_list_t send_buffer_vl = VALUE_LIST_STATIC;
34 static uint64_t stats_values_not_dispatched = 0;
35 static uint64_t stats_values_dispatched = 0;
37 /* 1 1 1 1 1 1 1 1 1 1 2 2 2 2 2 2 2 2 2 2 3 3
38 * 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
39 * +-------+-----------------------+-------------------------------+
41 * +-------+-----------------------+-------------------------------+
48 typedef struct part_header_s part_header_t;
50 // we do not want to crypt here
53 static _Bool check_receive_okay (const value_list_t *vl) /* {{{ */
55 uint64_t time_sent = 0;
58 status = uc_meta_data_get_unsigned_int (vl,
59 "zeromq:time_sent", &time_sent);
61 /* This is a value we already sent. Don't allow it to be received again in
62 * order to avoid looping. */
63 if ((status == 0) && (time_sent >= ((uint64_t) vl->time)))
67 } /* }}} _Bool check_receive_okay */
69 static int network_dispatch_values (value_list_t *vl, /* {{{ */
74 // DEBUG("host: %s", vl->host);
75 // DEBUG("plugin: %s", vl->plugin);
76 // DEBUG("plugin_instance: %s", vl->plugin_instance);
77 // DEBUG("type: %s", vl->type);
78 // DEBUG("type_instance: %s", vl->type_instance);
81 || (strlen (vl->host) <= 0)
82 || (strlen (vl->plugin) <= 0)
83 || (strlen (vl->type) <= 0))
86 if (!check_receive_okay (vl))
89 char name[6*DATA_MAX_NAME_LEN];
90 FORMAT_VL (name, sizeof (name), vl);
91 name[sizeof (name) - 1] = 0;
92 DEBUG ("network plugin: network_dispatch_values: "
93 "NOT dispatching %s.", name);
95 stats_values_not_dispatched++;
99 assert (vl->meta == NULL);
101 vl->meta = meta_data_create ();
102 if (vl->meta == NULL)
104 ERROR ("network plugin: meta_data_create failed.");
108 status = meta_data_add_boolean (vl->meta, "zeromq:received", 1);
111 ERROR ("network plugin: meta_data_add_boolean failed.");
112 meta_data_destroy (vl->meta);
117 if (username != NULL)
119 status = meta_data_add_string (vl->meta, "zeromq:username", username);
122 ERROR ("network plugin: meta_data_add_string failed.");
123 meta_data_destroy (vl->meta);
129 // DEBUG("dispatching %d values", vl->values_len);
130 plugin_dispatch_values (vl);
131 stats_values_dispatched++;
133 meta_data_destroy (vl->meta);
137 } /* }}} int network_dispatch_values */
139 static int write_part_values (char **ret_buffer, int *ret_buffer_len, const data_set_t *ds, const value_list_t *vl)
145 part_header_t pkg_ph;
146 uint16_t pkg_num_values;
147 uint8_t *pkg_values_types;
153 num_values = vl->values_len;
154 packet_len = sizeof (part_header_t) + sizeof (uint16_t)
155 + (num_values * sizeof (uint8_t))
156 + (num_values * sizeof (value_t));
158 if (*ret_buffer_len < packet_len)
161 pkg_values_types = (uint8_t *) malloc (num_values * sizeof (uint8_t));
162 if (pkg_values_types == NULL)
164 ERROR ("network plugin: write_part_values: malloc failed.");
168 pkg_values = (value_t *) malloc (num_values * sizeof (value_t));
169 if (pkg_values == NULL)
171 free (pkg_values_types);
172 ERROR ("network plugin: write_part_values: malloc failed.");
176 pkg_ph.type = htons (TYPE_VALUES);
177 pkg_ph.length = htons (packet_len);
179 pkg_num_values = htons ((uint16_t) vl->values_len);
181 for (i = 0; i < num_values; i++)
183 pkg_values_types[i] = (uint8_t) ds->ds[i].type;
184 switch (ds->ds[i].type)
186 case DS_TYPE_COUNTER:
187 pkg_values[i].counter = htonll (vl->values[i].counter);
191 pkg_values[i].gauge = htond (vl->values[i].gauge);
195 pkg_values[i].derive = htonll (vl->values[i].derive);
198 case DS_TYPE_ABSOLUTE:
199 pkg_values[i].absolute = htonll (vl->values[i].absolute);
203 free (pkg_values_types);
205 ERROR ("network plugin: write_part_values: "
206 "Unknown data source type: %i",
209 } /* switch (ds->ds[i].type) */
210 } /* for (num_values) */
213 * Use `memcpy' to write everything to the buffer, because the pointer
214 * may be unaligned and some architectures, such as SPARC, can't handle
217 packet_ptr = *ret_buffer;
219 memcpy (packet_ptr + offset, &pkg_ph, sizeof (pkg_ph));
220 offset += sizeof (pkg_ph);
221 memcpy (packet_ptr + offset, &pkg_num_values, sizeof (pkg_num_values));
222 offset += sizeof (pkg_num_values);
223 memcpy (packet_ptr + offset, pkg_values_types, num_values * sizeof (uint8_t));
224 offset += num_values * sizeof (uint8_t);
225 memcpy (packet_ptr + offset, pkg_values, num_values * sizeof (value_t));
226 offset += num_values * sizeof (value_t);
228 assert (offset == packet_len);
230 *ret_buffer = packet_ptr + packet_len;
231 *ret_buffer_len -= packet_len;
233 free (pkg_values_types);
237 } /* int write_part_values */
239 static int write_part_number (char **ret_buffer, int *ret_buffer_len,
240 int type, uint64_t value)
245 part_header_t pkg_head;
250 packet_len = sizeof (pkg_head) + sizeof (pkg_value);
252 if (*ret_buffer_len < packet_len)
255 pkg_head.type = htons (type);
256 pkg_head.length = htons (packet_len);
257 pkg_value = htonll (value);
259 packet_ptr = *ret_buffer;
261 memcpy (packet_ptr + offset, &pkg_head, sizeof (pkg_head));
262 offset += sizeof (pkg_head);
263 memcpy (packet_ptr + offset, &pkg_value, sizeof (pkg_value));
264 offset += sizeof (pkg_value);
266 assert (offset == packet_len);
268 *ret_buffer = packet_ptr + packet_len;
269 *ret_buffer_len -= packet_len;
272 } /* int write_part_number */
274 static int write_part_string (char **ret_buffer, int *ret_buffer_len,
275 int type, const char *str, int str_len)
285 buffer_len = 2 * sizeof (uint16_t) + str_len + 1;
286 if (*ret_buffer_len < buffer_len)
289 pkg_type = htons (type);
290 pkg_length = htons (buffer_len);
292 buffer = *ret_buffer;
294 memcpy (buffer + offset, (void *) &pkg_type, sizeof (pkg_type));
295 offset += sizeof (pkg_type);
296 memcpy (buffer + offset, (void *) &pkg_length, sizeof (pkg_length));
297 offset += sizeof (pkg_length);
298 memcpy (buffer + offset, str, str_len);
300 memset (buffer + offset, '\0', 1);
303 assert (offset == buffer_len);
305 *ret_buffer = buffer + buffer_len;
306 *ret_buffer_len -= buffer_len;
309 } /* int write_part_string */
311 static int parse_part_values (void **ret_buffer, size_t *ret_buffer_len,
312 value_t **ret_values, int *ret_num_values)
314 char *buffer = *ret_buffer;
315 size_t buffer_len = *ret_buffer_len;
330 NOTICE ("network plugin: packet is too short: "
331 "buffer_len = %zu", buffer_len);
335 memcpy ((void *) &tmp16, buffer, sizeof (tmp16));
336 buffer += sizeof (tmp16);
337 pkg_type = ntohs (tmp16);
339 memcpy ((void *) &tmp16, buffer, sizeof (tmp16));
340 buffer += sizeof (tmp16);
341 pkg_length = ntohs (tmp16);
343 memcpy ((void *) &tmp16, buffer, sizeof (tmp16));
344 buffer += sizeof (tmp16);
345 pkg_numval = ntohs (tmp16);
347 assert (pkg_type == TYPE_VALUES);
349 exp_size = 3 * sizeof (uint16_t)
350 + pkg_numval * (sizeof (uint8_t) + sizeof (value_t));
351 if ((buffer_len < 0) || (buffer_len < exp_size))
353 WARNING ("network plugin: parse_part_values: "
355 "Chunk of size %zu expected, "
356 "but buffer has only %zu bytes left.",
357 exp_size, buffer_len);
361 if (pkg_length != exp_size)
363 WARNING ("network plugin: parse_part_values: "
364 "Length and number of values "
365 "in the packet don't match.");
369 pkg_types = (uint8_t *) malloc (pkg_numval * sizeof (uint8_t));
370 pkg_values = (value_t *) malloc (pkg_numval * sizeof (value_t));
371 if ((pkg_types == NULL) || (pkg_values == NULL))
375 ERROR ("network plugin: parse_part_values: malloc failed.");
379 memcpy ((void *) pkg_types, (void *) buffer, pkg_numval * sizeof (uint8_t));
380 buffer += pkg_numval * sizeof (uint8_t);
381 memcpy ((void *) pkg_values, (void *) buffer, pkg_numval * sizeof (value_t));
382 buffer += pkg_numval * sizeof (value_t);
384 for (i = 0; i < pkg_numval; i++)
386 switch (pkg_types[i])
388 case DS_TYPE_COUNTER:
389 pkg_values[i].counter = (counter_t) ntohll (pkg_values[i].counter);
393 pkg_values[i].gauge = (gauge_t) ntohd (pkg_values[i].gauge);
397 pkg_values[i].derive = (derive_t) ntohll (pkg_values[i].derive);
400 case DS_TYPE_ABSOLUTE:
401 pkg_values[i].absolute = (absolute_t) ntohll (pkg_values[i].absolute);
405 NOTICE ("network plugin: parse_part_values: "
406 "Don't know how to handle data source type %"PRIu8,
411 } /* switch (pkg_types[i]) */
414 *ret_buffer = buffer;
415 *ret_buffer_len = buffer_len - pkg_length;
416 *ret_num_values = pkg_numval;
417 *ret_values = pkg_values;
422 } /* int parse_part_values */
424 static int add_to_buffer (char *buffer, int buffer_size, /* {{{ */
425 value_list_t *vl_def,
426 const data_set_t *ds, const value_list_t *vl)
428 char *buffer_orig = buffer;
430 if (write_part_string (&buffer, &buffer_size, TYPE_HOST, vl->host, strlen (vl->host)) != 0)
433 if (write_part_number (&buffer, &buffer_size, TYPE_TIME, (uint64_t) vl->time))
436 if (write_part_number (&buffer, &buffer_size, TYPE_INTERVAL, (uint64_t) vl->interval))
439 if (write_part_string (&buffer, &buffer_size, TYPE_PLUGIN, vl->plugin, strlen (vl->plugin)) != 0)
442 if (write_part_string (&buffer, &buffer_size, TYPE_PLUGIN_INSTANCE, vl->plugin_instance, strlen (vl->plugin_instance)) != 0)
445 if (write_part_string (&buffer, &buffer_size, TYPE_TYPE, vl->type, strlen (vl->type)) != 0)
448 if (write_part_string (&buffer, &buffer_size, TYPE_TYPE_INSTANCE, vl->type_instance, strlen (vl->type_instance)) != 0)
451 if (write_part_values (&buffer, &buffer_size, ds, vl) != 0)
454 return (buffer - buffer_orig);
455 } /* }}} int add_to_buffer */
457 static int parse_part_number (void **ret_buffer, size_t *ret_buffer_len,
460 char *buffer = *ret_buffer;
461 size_t buffer_len = *ret_buffer_len;
465 size_t exp_size = 2 * sizeof (uint16_t) + sizeof (uint64_t);
470 if ((buffer_len < 0) || ((size_t) buffer_len < exp_size))
472 WARNING ("network plugin: parse_part_number: "
474 "Chunk of size %zu expected, "
475 "but buffer has only %zu bytes left.",
476 exp_size, buffer_len);
480 memcpy ((void *) &tmp16, buffer, sizeof (tmp16));
481 buffer += sizeof (tmp16);
482 pkg_type = ntohs (tmp16);
484 memcpy ((void *) &tmp16, buffer, sizeof (tmp16));
485 buffer += sizeof (tmp16);
486 pkg_length = ntohs (tmp16);
488 memcpy ((void *) &tmp64, buffer, sizeof (tmp64));
489 buffer += sizeof (tmp64);
490 *value = ntohll (tmp64);
492 *ret_buffer = buffer;
493 *ret_buffer_len = buffer_len - pkg_length;
496 } /* int parse_part_number */
498 static int parse_part_string (void **ret_buffer, size_t *ret_buffer_len,
499 char *output, int output_len)
501 char *buffer = *ret_buffer;
502 size_t buffer_len = *ret_buffer_len;
505 size_t header_size = 2 * sizeof (uint16_t);
510 if ((buffer_len < 0) || (buffer_len < header_size))
512 WARNING ("network plugin: parse_part_string: "
514 "Chunk of at least size %zu expected, "
515 "but buffer has only %zu bytes left.",
516 header_size, buffer_len);
520 memcpy ((void *) &tmp16, buffer, sizeof (tmp16));
521 buffer += sizeof (tmp16);
522 pkg_type = ntohs (tmp16);
524 memcpy ((void *) &tmp16, buffer, sizeof (tmp16));
525 buffer += sizeof (tmp16);
526 pkg_length = ntohs (tmp16);
528 /* Check that packet fits in the input buffer */
529 if (pkg_length > buffer_len)
531 WARNING ("network plugin: parse_part_string: "
533 "Chunk of size %"PRIu16" received, "
534 "but buffer has only %zu bytes left.",
535 pkg_length, buffer_len);
539 /* Check that pkg_length is in the valid range */
540 if (pkg_length <= header_size)
542 WARNING ("network plugin: parse_part_string: "
544 "Header claims this packet is only %hu "
545 "bytes long.", pkg_length);
549 /* Check that the package data fits into the output buffer.
550 * The previous if-statement ensures that:
551 * `pkg_length > header_size' */
553 || ((size_t) output_len < ((size_t) pkg_length - header_size)))
555 WARNING ("network plugin: parse_part_string: "
556 "Output buffer too small.");
560 /* All sanity checks successfull, let's copy the data over */
561 output_len = pkg_length - header_size;
562 memcpy ((void *) output, (void *) buffer, output_len);
563 buffer += output_len;
565 /* For some very weird reason '\0' doesn't do the trick on SPARC in
567 if (output[output_len - 1] != 0)
569 WARNING ("network plugin: parse_part_string: "
570 "Received string does not end "
571 "with a NULL-byte.");
575 *ret_buffer = buffer;
576 *ret_buffer_len = buffer_len - pkg_length;
579 } /* int parse_part_string */
582 static int parse_packet (void *se, /* {{{ */
583 void *buffer, size_t buffer_size, int flags,
584 const char *username)
588 value_list_t vl = VALUE_LIST_INIT;
592 int packet_was_signed = (flags & PP_SIGNED);
593 int packet_was_encrypted = (flags & PP_ENCRYPTED);
594 int printed_ignore_warning = 0;
595 #endif /* HAVE_LIBGCRYPT */
598 memset (&vl, '\0', sizeof (vl));
599 memset (&n, '\0', sizeof (n));
602 while ((status == 0) && (0 < buffer_size)
603 && ((unsigned int) buffer_size > sizeof (part_header_t)))
608 memcpy ((void *) &pkg_type,
611 memcpy ((void *) &pkg_length,
612 (void *) (buffer + sizeof (pkg_type)),
613 sizeof (pkg_length));
615 pkg_length = ntohs (pkg_length);
616 pkg_type = ntohs (pkg_type);
618 if (pkg_length > buffer_size)
620 /* Ensure that this loop terminates eventually */
621 if (pkg_length < (2 * sizeof (uint16_t)))
624 if (pkg_type == TYPE_ENCR_AES256)
626 // status = parse_part_encr_aes256 (se,
627 // &buffer, &buffer_size, flags);
630 ERROR ("network plugin: Decrypting AES256 "
632 "with status %i.", status);
637 else if ((se->data.server.security_level == SECURITY_LEVEL_ENCRYPT)
638 && (packet_was_encrypted == 0))
640 if (printed_ignore_warning == 0)
642 INFO ("network plugin: Unencrypted packet or "
643 "part has been ignored.");
644 printed_ignore_warning = 1;
646 buffer = ((char *) buffer) + pkg_length;
649 #endif /* HAVE_LIBGCRYPT */
650 else if (pkg_type == TYPE_SIGN_SHA256)
652 // status = parse_part_sign_sha256 (se,
653 // &buffer, &buffer_size, flags);
656 ERROR ("network plugin: Verifying HMAC-SHA-256 "
658 "with status %i.", status);
663 else if ((se->data.server.security_level == SECURITY_LEVEL_SIGN)
664 && (packet_was_encrypted == 0)
665 && (packet_was_signed == 0))
667 if (printed_ignore_warning == 0)
669 INFO ("network plugin: Unsigned packet or "
670 "part has been ignored.");
671 printed_ignore_warning = 1;
673 buffer = ((char *) buffer) + pkg_length;
676 #endif /* HAVE_LIBGCRYPT */
677 else if (pkg_type == TYPE_VALUES)
679 status = parse_part_values (&buffer, &buffer_size,
680 &vl.values, &vl.values_len);
684 network_dispatch_values (&vl, username);
688 else if (pkg_type == TYPE_TIME)
691 status = parse_part_number (&buffer, &buffer_size,
695 vl.time = (time_t) tmp;
696 n.time = (time_t) tmp;
699 else if (pkg_type == TYPE_INTERVAL)
702 status = parse_part_number (&buffer, &buffer_size,
705 vl.interval = (int) tmp;
707 else if (pkg_type == TYPE_HOST)
709 status = parse_part_string (&buffer, &buffer_size,
710 vl.host, sizeof (vl.host));
712 sstrncpy (n.host, vl.host, sizeof (n.host));
714 else if (pkg_type == TYPE_PLUGIN)
716 status = parse_part_string (&buffer, &buffer_size,
717 vl.plugin, sizeof (vl.plugin));
719 sstrncpy (n.plugin, vl.plugin,
722 else if (pkg_type == TYPE_PLUGIN_INSTANCE)
724 status = parse_part_string (&buffer, &buffer_size,
726 sizeof (vl.plugin_instance));
728 sstrncpy (n.plugin_instance,
730 sizeof (n.plugin_instance));
732 else if (pkg_type == TYPE_TYPE)
734 status = parse_part_string (&buffer, &buffer_size,
735 vl.type, sizeof (vl.type));
737 sstrncpy (n.type, vl.type, sizeof (n.type));
739 else if (pkg_type == TYPE_TYPE_INSTANCE)
741 status = parse_part_string (&buffer, &buffer_size,
743 sizeof (vl.type_instance));
745 sstrncpy (n.type_instance, vl.type_instance,
746 sizeof (n.type_instance));
748 else if (pkg_type == TYPE_MESSAGE)
750 status = parse_part_string (&buffer, &buffer_size,
751 n.message, sizeof (n.message));
757 else if ((n.severity != NOTIF_FAILURE)
758 && (n.severity != NOTIF_WARNING)
759 && (n.severity != NOTIF_OKAY))
761 INFO ("network plugin: "
762 "Ignoring notification with "
763 "unknown severity %i.",
766 else if (n.time <= 0)
768 INFO ("network plugin: "
769 "Ignoring notification with "
772 else if (strlen (n.message) <= 0)
774 INFO ("network plugin: "
775 "Ignoring notification with "
776 "an empty message.");
780 plugin_dispatch_notification (&n);
783 else if (pkg_type == TYPE_SEVERITY)
786 status = parse_part_number (&buffer, &buffer_size,
789 n.severity = (int) tmp;
793 DEBUG ("network plugin: parse_packet: Unknown part"
794 " type: 0x%04hx", pkg_type);
795 buffer = ((char *) buffer) + pkg_length;
797 } /* while (buffer_size > sizeof (part_header_t)) */
799 if (status == 0 && buffer_size > 0)
800 WARNING ("network plugin: parse_packet: Received truncated "
801 "packet, try increasing `MaxPacketSize'");
804 } /* }}} int parse_packet */