2 * libcollectdclient - src/libcollectdclient/client.c
3 * Copyright (C) 2008-2012 Florian octo Forster
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
24 * Florian octo Forster <octo at collectd.org>
31 #if !defined(__GNUC__) || !__GNUC__
32 # define __attribute__(x) /**/
35 #include "collectd/lcc_features.h"
40 #include <sys/types.h>
41 #include <sys/socket.h>
49 #include "collectd/client.h"
51 /* NI_MAXHOST has been obsoleted by RFC 3493 which is a reason for SunOS 5.11
52 * to no longer define it. We'll use the old, RFC 2553 value here. */
54 # define NI_MAXHOST 1025
57 /* OpenBSD doesn't have EPROTO, FreeBSD doesn't have EILSEQ. Oh what joy! */
60 # define EILSEQ EPROTO
62 # define EILSEQ EINVAL
66 /* Secure/static macros. They work like `strcpy' and `strcat', but assure null
67 * termination. They work for static buffers only, because they use `sizeof'.
68 * The `SSTRCATF' combines the functionality of `snprintf' and `strcat' which
69 * is very useful to add formatted stuff to the end of a buffer. */
70 #define SSTRCPY(d,s) do { \
71 strncpy ((d), (s), sizeof (d)); \
72 (d)[sizeof (d) - 1] = 0; \
75 #define SSTRCAT(d,s) do { \
76 size_t _l = strlen (d); \
77 strncpy ((d) + _l, (s), sizeof (d) - _l); \
78 (d)[sizeof (d) - 1] = 0; \
81 #define SSTRCATF(d, ...) do { \
82 char _b[sizeof (d)]; \
83 snprintf (_b, sizeof (_b), __VA_ARGS__); \
84 _b[sizeof (_b) - 1] = 0; \
89 #define LCC_SET_ERRSTR(c, ...) do { \
90 snprintf ((c)->errbuf, sizeof ((c)->errbuf), __VA_ARGS__); \
91 (c)->errbuf[sizeof ((c)->errbuf) - 1] = 0; \
95 # define LCC_DEBUG(...) printf (__VA_ARGS__)
97 # define LCC_DEBUG(...) /**/
103 struct lcc_connection_s
109 struct lcc_response_s
116 typedef struct lcc_response_s lcc_response_t;
121 /* Even though Posix requires "strerror_r" to return an "int",
122 * some systems (e.g. the GNU libc) return a "char *" _and_
123 * ignore the second argument ... -tokkee */
124 static char *sstrerror (int errnum, char *buf, size_t buflen)
129 snprintf (buf, buflen, "Error #%i; strerror_r is not available.", errnum);
130 /* #endif !HAVE_STRERROR_R */
132 #elif STRERROR_R_CHAR_P
135 temp = strerror_r (errnum, buf, buflen);
138 if ((temp != NULL) && (temp != buf) && (temp[0] != 0))
139 strncpy (buf, temp, buflen);
141 strncpy (buf, "strerror_r did not return "
142 "an error message", buflen);
145 /* #endif STRERROR_R_CHAR_P */
148 if (strerror_r (errnum, buf, buflen) != 0)
150 snprintf (buf, buflen, "Error #%i; "
151 "Additionally, strerror_r failed.",
154 #endif /* STRERROR_R_CHAR_P */
159 } /* char *sstrerror */
161 static int lcc_set_errno (lcc_connection_t *c, int err) /* {{{ */
166 sstrerror (err, c->errbuf, sizeof (c->errbuf));
167 c->errbuf[sizeof (c->errbuf) - 1] = 0;
170 } /* }}} int lcc_set_errno */
172 static char *lcc_strescape (char *dest, const char *src, size_t dest_size) /* {{{ */
177 if ((dest == NULL) || (src == NULL))
183 assert (dest_size >= 3);
185 dest[dest_pos] = '"';
190 if ((dest_pos == (dest_size - 2))
191 || (src[src_pos] == 0))
194 if ((src[src_pos] == '"') || (src[src_pos] == '\\'))
196 /* Check if there is enough space for both characters.. */
197 if (dest_pos == (dest_size - 3))
200 dest[dest_pos] = '\\';
204 dest[dest_pos] = src[src_pos];
209 assert (dest_pos <= (dest_size - 2));
211 dest[dest_pos] = '"';
219 } /* }}} char *lcc_strescape */
221 /* lcc_chomp: Removes all control-characters at the end of a string. */
222 static void lcc_chomp (char *str) /* {{{ */
226 str_len = strlen (str);
229 if (str[str_len - 1] >= 32)
231 str[str_len - 1] = 0;
234 } /* }}} void lcc_chomp */
236 static void lcc_response_free (lcc_response_t *res) /* {{{ */
241 for (size_t i = 0; i < res->lines_num; i++)
242 free (res->lines[i]);
245 } /* }}} void lcc_response_free */
247 static int lcc_send (lcc_connection_t *c, const char *command) /* {{{ */
251 LCC_DEBUG ("send: --> %s\n", command);
253 status = fprintf (c->fh, "%s\r\n", command);
256 lcc_set_errno (c, errno);
262 } /* }}} int lcc_send */
264 static int lcc_receive (lcc_connection_t *c, /* {{{ */
265 lcc_response_t *ret_res)
267 lcc_response_t res = { 0 };
272 /* Read the first line, containing the status and a message */
273 ptr = fgets (buffer, sizeof (buffer), c->fh);
276 lcc_set_errno (c, errno);
280 LCC_DEBUG ("receive: <-- %s\n", buffer);
282 /* Convert the leading status to an integer and make `ptr' to point to the
283 * beginning of the message. */
286 res.status = (int) strtol (buffer, &ptr, 0);
287 if ((errno != 0) || (ptr == &buffer[0]))
289 lcc_set_errno (c, errno);
293 /* Skip white spaces after the status number */
294 while ((*ptr == ' ') || (*ptr == '\t'))
297 /* Now copy the message. */
298 strncpy (res.message, ptr, sizeof (res.message));
299 res.message[sizeof (res.message) - 1] = 0;
301 /* Error or no lines follow: We're done. */
304 memcpy (ret_res, &res, sizeof (res));
308 /* Allocate space for the char-pointers */
309 res.lines_num = (size_t) res.status;
311 res.lines = malloc (res.lines_num * sizeof (*res.lines));
312 if (res.lines == NULL)
314 lcc_set_errno (c, ENOMEM);
318 /* Now receive all the lines */
319 for (i = 0; i < res.lines_num; i++)
321 ptr = fgets (buffer, sizeof (buffer), c->fh);
324 lcc_set_errno (c, errno);
328 LCC_DEBUG ("receive: <-- %s\n", buffer);
330 res.lines[i] = strdup (buffer);
331 if (res.lines[i] == NULL)
333 lcc_set_errno (c, ENOMEM);
338 /* Check if the for-loop exited with an error. */
339 if (i < res.lines_num)
350 memcpy (ret_res, &res, sizeof (res));
352 } /* }}} int lcc_receive */
354 static int lcc_sendreceive (lcc_connection_t *c, /* {{{ */
355 const char *command, lcc_response_t *ret_res)
357 lcc_response_t res = { 0 };
362 lcc_set_errno (c, EBADF);
366 status = lcc_send (c, command);
370 status = lcc_receive (c, &res);
372 memcpy (ret_res, &res, sizeof (*ret_res));
375 } /* }}} int lcc_sendreceive */
377 static int lcc_open_unixsocket (lcc_connection_t *c, const char *path) /* {{{ */
379 struct sockaddr_un sa = { 0 };
384 assert (c->fh == NULL);
385 assert (path != NULL);
387 /* Don't use PF_UNIX here, because it's broken on Mac OS X (10.4, possibly
389 fd = socket (AF_UNIX, SOCK_STREAM, /* protocol = */ 0);
392 lcc_set_errno (c, errno);
396 sa.sun_family = AF_UNIX;
397 strncpy (sa.sun_path, path, sizeof (sa.sun_path) - 1);
399 status = connect (fd, (struct sockaddr *) &sa, sizeof (sa));
402 lcc_set_errno (c, errno);
407 c->fh = fdopen (fd, "r+");
410 lcc_set_errno (c, errno);
416 } /* }}} int lcc_open_unixsocket */
418 static int lcc_open_netsocket (lcc_connection_t *c, /* {{{ */
419 const char *addr_orig)
421 struct addrinfo *ai_res;
422 char addr_copy[NI_MAXHOST];
429 assert (c->fh == NULL);
430 assert (addr_orig != NULL);
432 strncpy(addr_copy, addr_orig, sizeof(addr_copy));
433 addr_copy[sizeof(addr_copy) - 1] = '\0';
437 if (*addr == '[') /* IPv6+port format */
439 /* `addr' is something like "[2001:780:104:2:211:24ff:feab:26f8]:12345" */
442 port = strchr (addr, ']');
445 LCC_SET_ERRSTR (c, "malformed address: %s", addr_orig);
457 LCC_SET_ERRSTR (c, "garbage after address: %s", port);
460 } /* if (*addr = ']') */
461 else if (strchr (addr, '.') != NULL) /* Hostname or IPv4 */
463 port = strrchr (addr, ':');
471 struct addrinfo ai_hints = {
472 .ai_family = AF_UNSPEC,
473 .ai_flags = AI_ADDRCONFIG,
474 .ai_socktype = SOCK_STREAM
477 status = getaddrinfo (addr,
478 port == NULL ? LCC_DEFAULT_PORT : port,
482 LCC_SET_ERRSTR (c, "getaddrinfo: %s", gai_strerror (status));
486 for (struct addrinfo *ai_ptr = ai_res; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
488 fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol);
495 status = connect (fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
503 c->fh = fdopen (fd, "r+");
511 assert (status == 0);
517 lcc_set_errno (c, status);
518 freeaddrinfo (ai_res);
522 freeaddrinfo (ai_res);
524 } /* }}} int lcc_open_netsocket */
526 static int lcc_open_socket (lcc_connection_t *c, const char *addr) /* {{{ */
534 assert (c->fh == NULL);
535 assert (addr != NULL);
537 if (strncmp ("unix:", addr, strlen ("unix:")) == 0)
538 status = lcc_open_unixsocket (c, addr + strlen ("unix:"));
539 else if (addr[0] == '/')
540 status = lcc_open_unixsocket (c, addr);
542 status = lcc_open_netsocket (c, addr);
545 } /* }}} int lcc_open_socket */
550 unsigned int lcc_version (void) /* {{{ */
552 return (LCC_VERSION);
553 } /* }}} unsigned int lcc_version */
555 const char *lcc_version_string (void) /* {{{ */
557 return (LCC_VERSION_STRING);
558 } /* }}} const char *lcc_version_string */
560 const char *lcc_version_extra (void) /* {{{ */
562 return (LCC_VERSION_EXTRA);
563 } /* }}} const char *lcc_version_extra */
565 int lcc_connect (const char *address, lcc_connection_t **ret_con) /* {{{ */
576 c = calloc (1, sizeof (*c));
580 status = lcc_open_socket (c, address);
589 } /* }}} int lcc_connect */
591 int lcc_disconnect (lcc_connection_t *c) /* {{{ */
604 } /* }}} int lcc_disconnect */
606 int lcc_getval (lcc_connection_t *c, lcc_identifier_t *ident, /* {{{ */
607 size_t *ret_values_num, gauge_t **ret_values, char ***ret_values_names)
609 char ident_str[6 * LCC_NAME_LEN];
610 char ident_esc[12 * LCC_NAME_LEN];
611 char command[14 * LCC_NAME_LEN];
615 gauge_t *values = NULL;
616 char **values_names = NULL;
626 lcc_set_errno (c, EINVAL);
630 /* Build a commend with an escaped version of the identifier string. */
631 status = lcc_identifier_to_string (c, ident_str, sizeof (ident_str), ident);
635 snprintf (command, sizeof (command), "GETVAL %s",
636 lcc_strescape (ident_esc, ident_str, sizeof (ident_esc)));
637 command[sizeof (command) - 1] = 0;
639 /* Send talk to the daemon.. */
640 status = lcc_sendreceive (c, command, &res);
646 LCC_SET_ERRSTR (c, "Server error: %s", res.message);
647 lcc_response_free (&res);
651 values_num = res.lines_num;
653 #define BAIL_OUT(e) do { \
654 lcc_set_errno (c, (e)); \
656 if (values_names != NULL) { \
657 for (i = 0; i < values_num; i++) { \
658 free (values_names[i]); \
661 free (values_names); \
662 lcc_response_free (&res); \
666 /* If neither the values nor the names are requested, return here.. */
667 if ((ret_values == NULL) && (ret_values_names == NULL))
669 if (ret_values_num != NULL)
670 *ret_values_num = values_num;
671 lcc_response_free (&res);
675 /* Allocate space for the values */
676 if (ret_values != NULL)
678 values = malloc (values_num * sizeof (*values));
683 if (ret_values_names != NULL)
685 values_names = calloc (values_num, sizeof (*values_names));
686 if (values_names == NULL)
690 for (i = 0; i < res.lines_num; i++)
697 value = strchr (key, '=');
708 values[i] = strtod (value, &endptr);
710 if ((endptr == value) || (errno != 0))
714 if (values_names != NULL)
716 values_names[i] = strdup (key);
717 if (values_names[i] == NULL)
720 } /* for (i = 0; i < res.lines_num; i++) */
722 if (ret_values_num != NULL)
723 *ret_values_num = values_num;
724 if (ret_values != NULL)
725 *ret_values = values;
726 if (ret_values_names != NULL)
727 *ret_values_names = values_names;
729 lcc_response_free (&res);
732 } /* }}} int lcc_getval */
734 int lcc_putval (lcc_connection_t *c, const lcc_value_list_t *vl) /* {{{ */
736 char ident_str[6 * LCC_NAME_LEN];
737 char ident_esc[12 * LCC_NAME_LEN];
738 char command[1024] = "";
742 if ((c == NULL) || (vl == NULL) || (vl->values_len < 1)
743 || (vl->values == NULL) || (vl->values_types == NULL))
745 lcc_set_errno (c, EINVAL);
749 status = lcc_identifier_to_string (c, ident_str, sizeof (ident_str),
754 SSTRCATF (command, "PUTVAL %s",
755 lcc_strescape (ident_esc, ident_str, sizeof (ident_esc)));
757 if (vl->interval > 0.0)
758 SSTRCATF (command, " interval=%.3f", vl->interval);
761 SSTRCATF (command, " %.3f", vl->time);
763 SSTRCAT (command, " N");
765 for (size_t i = 0; i < vl->values_len; i++)
767 if (vl->values_types[i] == LCC_TYPE_COUNTER)
768 SSTRCATF (command, ":%"PRIu64, vl->values[i].counter);
769 else if (vl->values_types[i] == LCC_TYPE_GAUGE)
771 if (isnan (vl->values[i].gauge))
772 SSTRCATF (command, ":U");
774 SSTRCATF (command, ":%g", vl->values[i].gauge);
776 else if (vl->values_types[i] == LCC_TYPE_DERIVE)
777 SSTRCATF (command, ":%"PRIu64, vl->values[i].derive);
778 else if (vl->values_types[i] == LCC_TYPE_ABSOLUTE)
779 SSTRCATF (command, ":%"PRIu64, vl->values[i].absolute);
781 } /* for (i = 0; i < vl->values_len; i++) */
783 status = lcc_sendreceive (c, command, &res);
789 LCC_SET_ERRSTR (c, "Server error: %s", res.message);
790 lcc_response_free (&res);
794 lcc_response_free (&res);
796 } /* }}} int lcc_putval */
798 int lcc_flush (lcc_connection_t *c, const char *plugin, /* {{{ */
799 lcc_identifier_t *ident, int timeout)
801 char command[1024] = "";
807 lcc_set_errno (c, EINVAL);
811 SSTRCPY (command, "FLUSH");
814 SSTRCATF (command, " timeout=%i", timeout);
818 char buffer[2 * LCC_NAME_LEN];
819 SSTRCATF (command, " plugin=%s",
820 lcc_strescape (buffer, plugin, sizeof (buffer)));
825 char ident_str[6 * LCC_NAME_LEN];
826 char ident_esc[12 * LCC_NAME_LEN];
828 status = lcc_identifier_to_string (c, ident_str, sizeof (ident_str), ident);
832 SSTRCATF (command, " identifier=%s",
833 lcc_strescape (ident_esc, ident_str, sizeof (ident_esc)));
836 status = lcc_sendreceive (c, command, &res);
842 LCC_SET_ERRSTR (c, "Server error: %s", res.message);
843 lcc_response_free (&res);
847 lcc_response_free (&res);
849 } /* }}} int lcc_flush */
851 /* TODO: Implement lcc_putnotif */
853 int lcc_listval (lcc_connection_t *c, /* {{{ */
854 lcc_identifier_t **ret_ident, size_t *ret_ident_num)
859 lcc_identifier_t *ident;
865 if ((ret_ident == NULL) || (ret_ident_num == NULL))
867 lcc_set_errno (c, EINVAL);
871 status = lcc_sendreceive (c, "LISTVAL", &res);
877 LCC_SET_ERRSTR (c, "Server error: %s", res.message);
878 lcc_response_free (&res);
882 ident_num = res.lines_num;
883 ident = malloc (ident_num * sizeof (*ident));
886 lcc_response_free (&res);
887 lcc_set_errno (c, ENOMEM);
891 for (size_t i = 0; i < res.lines_num; i++)
896 /* First field is the time. */
897 time_str = res.lines[i];
899 /* Set `ident_str' to the beginning of the second field. */
900 ident_str = time_str;
901 while ((*ident_str != ' ') && (*ident_str != '\t') && (*ident_str != 0))
903 while ((*ident_str == ' ') || (*ident_str == '\t'))
911 lcc_set_errno (c, EILSEQ);
916 status = lcc_string_to_identifier (c, ident + i, ident_str);
921 lcc_response_free (&res);
930 *ret_ident_num = ident_num;
933 } /* }}} int lcc_listval */
935 const char *lcc_strerror (lcc_connection_t *c) /* {{{ */
938 return ("Invalid object");
940 } /* }}} const char *lcc_strerror */
942 int lcc_identifier_to_string (lcc_connection_t *c, /* {{{ */
943 char *string, size_t string_size, const lcc_identifier_t *ident)
945 if ((string == NULL) || (string_size < 6) || (ident == NULL))
947 lcc_set_errno (c, EINVAL);
951 if (ident->plugin_instance[0] == 0)
953 if (ident->type_instance[0] == 0)
954 snprintf (string, string_size, "%s/%s/%s",
959 snprintf (string, string_size, "%s/%s/%s-%s",
963 ident->type_instance);
967 if (ident->type_instance[0] == 0)
968 snprintf (string, string_size, "%s/%s-%s/%s",
971 ident->plugin_instance,
974 snprintf (string, string_size, "%s/%s-%s/%s-%s",
977 ident->plugin_instance,
979 ident->type_instance);
982 string[string_size - 1] = 0;
984 } /* }}} int lcc_identifier_to_string */
986 int lcc_string_to_identifier (lcc_connection_t *c, /* {{{ */
987 lcc_identifier_t *ident, const char *string)
992 char *plugin_instance;
996 string_copy = strdup (string);
997 if (string_copy == NULL)
999 lcc_set_errno (c, ENOMEM);
1004 plugin = strchr (host, '/');
1007 LCC_SET_ERRSTR (c, "Malformed identifier string: %s", string);
1014 type = strchr (plugin, '/');
1017 LCC_SET_ERRSTR (c, "Malformed identifier string: %s", string);
1024 plugin_instance = strchr (plugin, '-');
1025 if (plugin_instance != NULL)
1027 *plugin_instance = 0;
1031 type_instance = strchr (type, '-');
1032 if (type_instance != NULL)
1038 memset (ident, 0, sizeof (*ident));
1040 SSTRCPY (ident->host, host);
1041 SSTRCPY (ident->plugin, plugin);
1042 if (plugin_instance != NULL)
1043 SSTRCPY (ident->plugin_instance, plugin_instance);
1044 SSTRCPY (ident->type, type);
1045 if (type_instance != NULL)
1046 SSTRCPY (ident->type_instance, type_instance);
1050 } /* }}} int lcc_string_to_identifier */
1052 int lcc_identifier_compare (const void *a, /* {{{ */
1055 const lcc_identifier_t *i0 = a;
1056 const lcc_identifier_t *i1 = b;
1059 if ((i0 == NULL) && (i1 == NULL))
1061 else if (i0 == NULL)
1063 else if (i1 == NULL)
1066 #define CMP_FIELD(f) do { \
1067 status = strcmp (i0->f, i1->f); \
1074 CMP_FIELD (plugin_instance);
1076 CMP_FIELD (type_instance);
1081 } /* }}} int lcc_identifier_compare */
1083 int lcc_sort_identifiers (lcc_connection_t *c, /* {{{ */
1084 lcc_identifier_t *idents, size_t idents_num)
1088 lcc_set_errno (c, EINVAL);
1092 qsort (idents, idents_num, sizeof (*idents),
1093 lcc_identifier_compare);
1095 } /* }}} int lcc_sort_identifiers */
1097 /* vim: set sw=2 sts=2 et fdm=marker : */