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) /* {{{ */
243 for (i = 0; i < res->lines_num; i++)
244 free (res->lines[i]);
247 } /* }}} void lcc_response_free */
249 static int lcc_send (lcc_connection_t *c, const char *command) /* {{{ */
253 LCC_DEBUG ("send: --> %s\n", command);
255 status = fprintf (c->fh, "%s\r\n", command);
258 lcc_set_errno (c, errno);
264 } /* }}} int lcc_send */
266 static int lcc_receive (lcc_connection_t *c, /* {{{ */
267 lcc_response_t *ret_res)
269 lcc_response_t res = { 0 };
274 /* Read the first line, containing the status and a message */
275 ptr = fgets (buffer, sizeof (buffer), c->fh);
278 lcc_set_errno (c, errno);
282 LCC_DEBUG ("receive: <-- %s\n", buffer);
284 /* Convert the leading status to an integer and make `ptr' to point to the
285 * beginning of the message. */
288 res.status = (int) strtol (buffer, &ptr, 0);
289 if ((errno != 0) || (ptr == &buffer[0]))
291 lcc_set_errno (c, errno);
295 /* Skip white spaces after the status number */
296 while ((*ptr == ' ') || (*ptr == '\t'))
299 /* Now copy the message. */
300 strncpy (res.message, ptr, sizeof (res.message));
301 res.message[sizeof (res.message) - 1] = 0;
303 /* Error or no lines follow: We're done. */
306 memcpy (ret_res, &res, sizeof (res));
310 /* Allocate space for the char-pointers */
311 res.lines_num = (size_t) res.status;
313 res.lines = malloc (res.lines_num * sizeof (*res.lines));
314 if (res.lines == NULL)
316 lcc_set_errno (c, ENOMEM);
320 /* Now receive all the lines */
321 for (i = 0; i < res.lines_num; i++)
323 ptr = fgets (buffer, sizeof (buffer), c->fh);
326 lcc_set_errno (c, errno);
330 LCC_DEBUG ("receive: <-- %s\n", buffer);
332 res.lines[i] = strdup (buffer);
333 if (res.lines[i] == NULL)
335 lcc_set_errno (c, ENOMEM);
340 /* Check if the for-loop exited with an error. */
341 if (i < res.lines_num)
352 memcpy (ret_res, &res, sizeof (res));
354 } /* }}} int lcc_receive */
356 static int lcc_sendreceive (lcc_connection_t *c, /* {{{ */
357 const char *command, lcc_response_t *ret_res)
359 lcc_response_t res = { 0 };
364 lcc_set_errno (c, EBADF);
368 status = lcc_send (c, command);
372 status = lcc_receive (c, &res);
374 memcpy (ret_res, &res, sizeof (*ret_res));
377 } /* }}} int lcc_sendreceive */
379 static int lcc_open_unixsocket (lcc_connection_t *c, const char *path) /* {{{ */
381 struct sockaddr_un sa = { 0 };
386 assert (c->fh == NULL);
387 assert (path != NULL);
389 /* Don't use PF_UNIX here, because it's broken on Mac OS X (10.4, possibly
391 fd = socket (AF_UNIX, SOCK_STREAM, /* protocol = */ 0);
394 lcc_set_errno (c, errno);
398 sa.sun_family = AF_UNIX;
399 strncpy (sa.sun_path, path, sizeof (sa.sun_path) - 1);
401 status = connect (fd, (struct sockaddr *) &sa, sizeof (sa));
404 lcc_set_errno (c, errno);
409 c->fh = fdopen (fd, "r+");
412 lcc_set_errno (c, errno);
418 } /* }}} int lcc_open_unixsocket */
420 static int lcc_open_netsocket (lcc_connection_t *c, /* {{{ */
421 const char *addr_orig)
423 struct addrinfo *ai_res;
424 struct addrinfo *ai_ptr;
425 char addr_copy[NI_MAXHOST];
432 assert (c->fh == NULL);
433 assert (addr_orig != NULL);
435 strncpy(addr_copy, addr_orig, sizeof(addr_copy));
436 addr_copy[sizeof(addr_copy) - 1] = '\0';
440 if (*addr == '[') /* IPv6+port format */
442 /* `addr' is something like "[2001:780:104:2:211:24ff:feab:26f8]:12345" */
445 port = strchr (addr, ']');
448 LCC_SET_ERRSTR (c, "malformed address: %s", addr_orig);
460 LCC_SET_ERRSTR (c, "garbage after address: %s", port);
463 } /* if (*addr = ']') */
464 else if (strchr (addr, '.') != NULL) /* Hostname or IPv4 */
466 port = strrchr (addr, ':');
474 struct addrinfo ai_hints = {
475 .ai_family = AF_UNSPEC,
476 .ai_flags = AI_ADDRCONFIG,
477 .ai_socktype = SOCK_STREAM
480 status = getaddrinfo (addr,
481 port == NULL ? LCC_DEFAULT_PORT : port,
485 LCC_SET_ERRSTR (c, "getaddrinfo: %s", gai_strerror (status));
489 for (ai_ptr = ai_res; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
491 fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol);
498 status = connect (fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
506 c->fh = fdopen (fd, "r+");
514 assert (status == 0);
520 lcc_set_errno (c, status);
521 freeaddrinfo (ai_res);
525 freeaddrinfo (ai_res);
527 } /* }}} int lcc_open_netsocket */
529 static int lcc_open_socket (lcc_connection_t *c, const char *addr) /* {{{ */
537 assert (c->fh == NULL);
538 assert (addr != NULL);
540 if (strncmp ("unix:", addr, strlen ("unix:")) == 0)
541 status = lcc_open_unixsocket (c, addr + strlen ("unix:"));
542 else if (addr[0] == '/')
543 status = lcc_open_unixsocket (c, addr);
545 status = lcc_open_netsocket (c, addr);
548 } /* }}} int lcc_open_socket */
553 unsigned int lcc_version (void) /* {{{ */
555 return (LCC_VERSION);
556 } /* }}} unsigned int lcc_version */
558 const char *lcc_version_string (void) /* {{{ */
560 return (LCC_VERSION_STRING);
561 } /* }}} const char *lcc_version_string */
563 const char *lcc_version_extra (void) /* {{{ */
565 return (LCC_VERSION_EXTRA);
566 } /* }}} const char *lcc_version_extra */
568 int lcc_connect (const char *address, lcc_connection_t **ret_con) /* {{{ */
579 c = calloc (1, sizeof (*c));
583 status = lcc_open_socket (c, address);
592 } /* }}} int lcc_connect */
594 int lcc_disconnect (lcc_connection_t *c) /* {{{ */
607 } /* }}} int lcc_disconnect */
609 int lcc_getval (lcc_connection_t *c, lcc_identifier_t *ident, /* {{{ */
610 size_t *ret_values_num, gauge_t **ret_values, char ***ret_values_names)
612 char ident_str[6 * LCC_NAME_LEN];
613 char ident_esc[12 * LCC_NAME_LEN];
614 char command[14 * LCC_NAME_LEN];
618 gauge_t *values = NULL;
619 char **values_names = NULL;
629 lcc_set_errno (c, EINVAL);
633 /* Build a commend with an escaped version of the identifier string. */
634 status = lcc_identifier_to_string (c, ident_str, sizeof (ident_str), ident);
638 snprintf (command, sizeof (command), "GETVAL %s",
639 lcc_strescape (ident_esc, ident_str, sizeof (ident_esc)));
640 command[sizeof (command) - 1] = 0;
642 /* Send talk to the daemon.. */
643 status = lcc_sendreceive (c, command, &res);
649 LCC_SET_ERRSTR (c, "Server error: %s", res.message);
650 lcc_response_free (&res);
654 values_num = res.lines_num;
656 #define BAIL_OUT(e) do { \
657 lcc_set_errno (c, (e)); \
659 if (values_names != NULL) { \
660 for (i = 0; i < values_num; i++) { \
661 free (values_names[i]); \
664 free (values_names); \
665 lcc_response_free (&res); \
669 /* If neither the values nor the names are requested, return here.. */
670 if ((ret_values == NULL) && (ret_values_names == NULL))
672 if (ret_values_num != NULL)
673 *ret_values_num = values_num;
674 lcc_response_free (&res);
678 /* Allocate space for the values */
679 if (ret_values != NULL)
681 values = malloc (values_num * sizeof (*values));
686 if (ret_values_names != NULL)
688 values_names = calloc (values_num, sizeof (*values_names));
689 if (values_names == NULL)
693 for (i = 0; i < res.lines_num; i++)
700 value = strchr (key, '=');
711 values[i] = strtod (value, &endptr);
713 if ((endptr == value) || (errno != 0))
717 if (values_names != NULL)
719 values_names[i] = strdup (key);
720 if (values_names[i] == NULL)
723 } /* for (i = 0; i < res.lines_num; i++) */
725 if (ret_values_num != NULL)
726 *ret_values_num = values_num;
727 if (ret_values != NULL)
728 *ret_values = values;
729 if (ret_values_names != NULL)
730 *ret_values_names = values_names;
732 lcc_response_free (&res);
735 } /* }}} int lcc_getval */
737 int lcc_putval (lcc_connection_t *c, const lcc_value_list_t *vl) /* {{{ */
739 char ident_str[6 * LCC_NAME_LEN];
740 char ident_esc[12 * LCC_NAME_LEN];
741 char command[1024] = "";
746 if ((c == NULL) || (vl == NULL) || (vl->values_len < 1)
747 || (vl->values == NULL) || (vl->values_types == NULL))
749 lcc_set_errno (c, EINVAL);
753 status = lcc_identifier_to_string (c, ident_str, sizeof (ident_str),
758 SSTRCATF (command, "PUTVAL %s",
759 lcc_strescape (ident_esc, ident_str, sizeof (ident_esc)));
761 if (vl->interval > 0.0)
762 SSTRCATF (command, " interval=%.3f", vl->interval);
765 SSTRCATF (command, " %.3f", vl->time);
767 SSTRCAT (command, " N");
769 for (i = 0; i < vl->values_len; i++)
771 if (vl->values_types[i] == LCC_TYPE_COUNTER)
772 SSTRCATF (command, ":%"PRIu64, vl->values[i].counter);
773 else if (vl->values_types[i] == LCC_TYPE_GAUGE)
775 if (isnan (vl->values[i].gauge))
776 SSTRCATF (command, ":U");
778 SSTRCATF (command, ":%g", vl->values[i].gauge);
780 else if (vl->values_types[i] == LCC_TYPE_DERIVE)
781 SSTRCATF (command, ":%"PRIu64, vl->values[i].derive);
782 else if (vl->values_types[i] == LCC_TYPE_ABSOLUTE)
783 SSTRCATF (command, ":%"PRIu64, vl->values[i].absolute);
785 } /* for (i = 0; i < vl->values_len; i++) */
787 status = lcc_sendreceive (c, command, &res);
793 LCC_SET_ERRSTR (c, "Server error: %s", res.message);
794 lcc_response_free (&res);
798 lcc_response_free (&res);
800 } /* }}} int lcc_putval */
802 int lcc_flush (lcc_connection_t *c, const char *plugin, /* {{{ */
803 lcc_identifier_t *ident, int timeout)
805 char command[1024] = "";
811 lcc_set_errno (c, EINVAL);
815 SSTRCPY (command, "FLUSH");
818 SSTRCATF (command, " timeout=%i", timeout);
822 char buffer[2 * LCC_NAME_LEN];
823 SSTRCATF (command, " plugin=%s",
824 lcc_strescape (buffer, plugin, sizeof (buffer)));
829 char ident_str[6 * LCC_NAME_LEN];
830 char ident_esc[12 * LCC_NAME_LEN];
832 status = lcc_identifier_to_string (c, ident_str, sizeof (ident_str), ident);
836 SSTRCATF (command, " identifier=%s",
837 lcc_strescape (ident_esc, ident_str, sizeof (ident_esc)));
840 status = lcc_sendreceive (c, command, &res);
846 LCC_SET_ERRSTR (c, "Server error: %s", res.message);
847 lcc_response_free (&res);
851 lcc_response_free (&res);
853 } /* }}} int lcc_flush */
855 /* TODO: Implement lcc_putnotif */
857 int lcc_listval (lcc_connection_t *c, /* {{{ */
858 lcc_identifier_t **ret_ident, size_t *ret_ident_num)
864 lcc_identifier_t *ident;
870 if ((ret_ident == NULL) || (ret_ident_num == NULL))
872 lcc_set_errno (c, EINVAL);
876 status = lcc_sendreceive (c, "LISTVAL", &res);
882 LCC_SET_ERRSTR (c, "Server error: %s", res.message);
883 lcc_response_free (&res);
887 ident_num = res.lines_num;
888 ident = malloc (ident_num * sizeof (*ident));
891 lcc_response_free (&res);
892 lcc_set_errno (c, ENOMEM);
896 for (i = 0; i < res.lines_num; i++)
901 /* First field is the time. */
902 time_str = res.lines[i];
904 /* Set `ident_str' to the beginning of the second field. */
905 ident_str = time_str;
906 while ((*ident_str != ' ') && (*ident_str != '\t') && (*ident_str != 0))
908 while ((*ident_str == ' ') || (*ident_str == '\t'))
916 lcc_set_errno (c, EILSEQ);
921 status = lcc_string_to_identifier (c, ident + i, ident_str);
926 lcc_response_free (&res);
935 *ret_ident_num = ident_num;
938 } /* }}} int lcc_listval */
940 const char *lcc_strerror (lcc_connection_t *c) /* {{{ */
943 return ("Invalid object");
945 } /* }}} const char *lcc_strerror */
947 int lcc_identifier_to_string (lcc_connection_t *c, /* {{{ */
948 char *string, size_t string_size, const lcc_identifier_t *ident)
950 if ((string == NULL) || (string_size < 6) || (ident == NULL))
952 lcc_set_errno (c, EINVAL);
956 if (ident->plugin_instance[0] == 0)
958 if (ident->type_instance[0] == 0)
959 snprintf (string, string_size, "%s/%s/%s",
964 snprintf (string, string_size, "%s/%s/%s-%s",
968 ident->type_instance);
972 if (ident->type_instance[0] == 0)
973 snprintf (string, string_size, "%s/%s-%s/%s",
976 ident->plugin_instance,
979 snprintf (string, string_size, "%s/%s-%s/%s-%s",
982 ident->plugin_instance,
984 ident->type_instance);
987 string[string_size - 1] = 0;
989 } /* }}} int lcc_identifier_to_string */
991 int lcc_string_to_identifier (lcc_connection_t *c, /* {{{ */
992 lcc_identifier_t *ident, const char *string)
997 char *plugin_instance;
1001 string_copy = strdup (string);
1002 if (string_copy == NULL)
1004 lcc_set_errno (c, ENOMEM);
1009 plugin = strchr (host, '/');
1012 LCC_SET_ERRSTR (c, "Malformed identifier string: %s", string);
1019 type = strchr (plugin, '/');
1022 LCC_SET_ERRSTR (c, "Malformed identifier string: %s", string);
1029 plugin_instance = strchr (plugin, '-');
1030 if (plugin_instance != NULL)
1032 *plugin_instance = 0;
1036 type_instance = strchr (type, '-');
1037 if (type_instance != NULL)
1043 memset (ident, 0, sizeof (*ident));
1045 SSTRCPY (ident->host, host);
1046 SSTRCPY (ident->plugin, plugin);
1047 if (plugin_instance != NULL)
1048 SSTRCPY (ident->plugin_instance, plugin_instance);
1049 SSTRCPY (ident->type, type);
1050 if (type_instance != NULL)
1051 SSTRCPY (ident->type_instance, type_instance);
1055 } /* }}} int lcc_string_to_identifier */
1057 int lcc_identifier_compare (const void *a, /* {{{ */
1060 const lcc_identifier_t *i0 = a;
1061 const lcc_identifier_t *i1 = b;
1064 if ((i0 == NULL) && (i1 == NULL))
1066 else if (i0 == NULL)
1068 else if (i1 == NULL)
1071 #define CMP_FIELD(f) do { \
1072 status = strcmp (i0->f, i1->f); \
1079 CMP_FIELD (plugin_instance);
1081 CMP_FIELD (type_instance);
1086 } /* }}} int lcc_identifier_compare */
1088 int lcc_sort_identifiers (lcc_connection_t *c, /* {{{ */
1089 lcc_identifier_t *idents, size_t idents_num)
1093 lcc_set_errno (c, EINVAL);
1097 qsort (idents, idents_num, sizeof (*idents),
1098 lcc_identifier_compare);
1100 } /* }}} int lcc_sort_identifiers */
1102 /* vim: set sw=2 sts=2 et fdm=marker : */