2 * RRDTool - src/rrd_client.c
3 * Copyright (C) 2008-2010 Florian octo Forster
5 * Permission is hereby granted, free of charge, to any person obtaining a copy
6 * of this software and associated documentation files (the "Software"), to
7 * deal in the Software without restriction, including without limitation the
8 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
9 * sell copies of the Software, and to permit persons to whom the Software is
10 * 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 DEALINGS
24 * Florian octo Forster <octo at verplant.org>
25 * Sebastian tokkee Harl <sh at tokkee.org>
30 #include "rrd_client.h"
39 #include <sys/types.h>
40 #include <sys/socket.h>
46 #define ENODATA ENOENT
49 struct rrdc_response_s
56 typedef struct rrdc_response_s rrdc_response_t;
58 static pthread_mutex_t lock = PTHREAD_MUTEX_INITIALIZER;
60 static FILE *sh = NULL;
61 static char *sd_path = NULL; /* cache the path for sd */
63 /* get_path: Return a path name appropriate to be sent to the daemon.
65 * When talking to a local daemon (thru a UNIX socket), relative path names
66 * are resolved to absolute path names to allow for transparent integration
67 * into existing solutions (as requested by Tobi). Else, absolute path names
68 * are not allowed, since path name translation is done by the server.
70 * One must hold `lock' when calling this function. */
71 static const char *get_path (const char *path, char *resolved_path) /* {{{ */
73 const char *ret = path;
76 if ((path == NULL) || (resolved_path == NULL) || (sd_path == NULL))
80 || (strncmp ("unix:", sd_path, strlen ("unix:")) == 0))
85 ret = realpath(path, resolved_path);
87 rrd_set_error("realpath(%s): %s", path, rrd_strerror(errno));
92 if (*path == '/') /* not absolute path */
94 rrd_set_error ("absolute path names not allowed when talking "
95 "to a remote daemon");
101 } /* }}} char *get_path */
103 static size_t strsplit (char *string, char **fields, size_t size) /* {{{ */
112 while ((fields[i] = strtok_r (ptr, " \t\r\n", &saveptr)) != NULL)
122 } /* }}} size_t strsplit */
124 static int parse_header (char *line, /* {{{ */
125 char **ret_key, char **ret_value)
131 tmp = strchr (line, ':');
140 while ((tmp[0] == ' ') || (tmp[0] == '\t'));
147 } /* }}} int parse_header */
149 static int parse_ulong_header (char *line, /* {{{ */
150 char **ret_key, unsigned long *ret_value)
157 status = parse_header (line, ret_key, &str_value);
163 *ret_value = (unsigned long) strtol (str_value, &endptr, /* base = */ 0);
164 if ((endptr == str_value) || (errno != 0))
168 } /* }}} int parse_ulong_header */
170 static int parse_char_array_header (char *line, /* {{{ */
171 char **ret_key, char **array, size_t array_len, int alloc)
173 char *tmp_array[array_len];
179 status = parse_header (line, ret_key, &value);
183 num = strsplit (value, tmp_array, array_len);
184 if (num != array_len)
189 memcpy (array, tmp_array, sizeof (tmp_array));
195 for (i = 0; i < array_len; i++)
196 array[i] = strdup (tmp_array[i]);
200 } /* }}} int parse_char_array_header */
202 static int parse_value_array_header (char *line, /* {{{ */
203 time_t *ret_time, rrd_value_t *array, size_t array_len)
206 char *str_array[array_len];
212 status = parse_char_array_header (line, &str_key,
213 str_array, array_len, /* alloc = */ 0);
219 *ret_time = (time_t) strtol (str_key, &endptr, /* base = */ 10);
220 if ((endptr == str_key) || (errno != 0))
223 for (i = 0; i < array_len; i++)
226 array[i] = (rrd_value_t) strtod (str_array[i], &endptr);
227 if ((endptr == str_array[i]) || (errno != 0))
232 } /* }}} int parse_value_array_header */
234 /* One must hold `lock' when calling `close_connection'. */
235 static void close_connection (void) /* {{{ */
252 } /* }}} void close_connection */
254 static int buffer_add_string (const char *str, /* {{{ */
255 char **buffer_ret, size_t *buffer_size_ret)
263 buffer = *buffer_ret;
264 buffer_size = *buffer_size_ret;
269 while (buffer_pos < buffer_size)
273 buffer[buffer_pos] = ' ';
278 else if ((str[i] == ' ') || (str[i] == '\\'))
280 if (buffer_pos >= (buffer_size - 1))
282 buffer[buffer_pos] = '\\';
284 buffer[buffer_pos] = str[i];
289 buffer[buffer_pos] = str[i];
293 } /* while (buffer_pos < buffer_size) */
298 *buffer_ret = buffer + buffer_pos;
299 *buffer_size_ret = buffer_size - buffer_pos;
302 } /* }}} int buffer_add_string */
304 static int buffer_add_value (const char *value, /* {{{ */
305 char **buffer_ret, size_t *buffer_size_ret)
309 if (strncmp (value, "N:", 2) == 0)
310 snprintf (temp, sizeof (temp), "%lu:%s",
311 (unsigned long) time (NULL), value + 2);
313 strncpy (temp, value, sizeof (temp));
314 temp[sizeof (temp) - 1] = 0;
316 return (buffer_add_string (temp, buffer_ret, buffer_size_ret));
317 } /* }}} int buffer_add_value */
319 static int buffer_add_ulong (const unsigned long value, /* {{{ */
320 char **buffer_ret, size_t *buffer_size_ret)
324 snprintf (temp, sizeof (temp), "%lu", value);
325 temp[sizeof (temp) - 1] = 0;
326 return (buffer_add_string (temp, buffer_ret, buffer_size_ret));
327 } /* }}} int buffer_add_ulong */
329 /* Remove trailing newline (NL) and carriage return (CR) characters. Similar to
330 * the Perl function `chomp'. Returns the number of characters that have been
332 static int chomp (char *str) /* {{{ */
342 while ((len > 0) && ((str[len - 1] == '\n') || (str[len - 1] == '\r')))
350 } /* }}} int chomp */
352 static void response_free (rrdc_response_t *res) /* {{{ */
357 if (res->lines != NULL)
361 for (i = 0; i < res->lines_num; i++)
362 if (res->lines[i] != NULL)
363 free (res->lines[i]);
368 } /* }}} void response_free */
370 static int response_read (rrdc_response_t **ret_response) /* {{{ */
372 rrdc_response_t *ret = NULL;
380 #define DIE(code) do { status = code; goto err_out; } while(0)
385 ret = (rrdc_response_t *) malloc (sizeof (rrdc_response_t));
388 memset (ret, 0, sizeof (*ret));
392 buffer_ptr = fgets (buffer, sizeof (buffer), sh);
393 if (buffer_ptr == NULL)
398 ret->status = strtol (buffer, &ret->message, 0);
399 if (buffer == ret->message)
402 /* Skip leading whitespace of the status message */
403 ret->message += strspn (ret->message, " \t");
405 if (ret->status <= 0)
408 rrd_set_error("rrdcached: %s", ret->message);
412 ret->lines = (char **) malloc (sizeof (char *) * ret->status);
413 if (ret->lines == NULL)
416 memset (ret->lines, 0, sizeof (char *) * ret->status);
417 ret->lines_num = (size_t) ret->status;
419 for (i = 0; i < ret->lines_num; i++)
421 buffer_ptr = fgets (buffer, sizeof (buffer), sh);
422 if (buffer_ptr == NULL)
427 ret->lines[i] = strdup (buffer);
428 if (ret->lines[i] == NULL)
444 } /* }}} rrdc_response_t *response_read */
446 static int request (const char *buffer, size_t buffer_size, /* {{{ */
447 rrdc_response_t **ret_response)
450 rrdc_response_t *res;
455 status = (int) fwrite (buffer, buffer_size, /* nmemb = */ 1, sh);
459 rrd_set_error("request: socket error (%d) while talking to rrdcached",
466 status = response_read (&res);
471 rrd_set_error("request: internal error while talking to rrdcached");
477 } /* }}} int request */
479 /* determine whether we are connected to the specified daemon_addr if
480 * NULL, return whether we are connected at all
482 int rrdc_is_connected(const char *daemon_addr) /* {{{ */
486 else if (daemon_addr == NULL)
488 /* here we have to handle the case i.e.
489 * UPDATE --daemon ...; UPDATEV (no --daemon) ...
490 * In other words: we have a cached connection,
491 * but it is not specified in the current command.
492 * Daemon is only implied in this case if set in ENV
494 if (getenv(ENV_RRDCACHED_ADDRESS) != NULL)
499 else if (strcmp(daemon_addr, sd_path) == 0)
504 } /* }}} int rrdc_is_connected */
506 static int rrdc_connect_unix (const char *path) /* {{{ */
508 struct sockaddr_un sa;
511 assert (path != NULL);
514 sd = socket (PF_UNIX, SOCK_STREAM, /* protocol = */ 0);
521 memset (&sa, 0, sizeof (sa));
522 sa.sun_family = AF_UNIX;
523 strncpy (sa.sun_path, path, sizeof (sa.sun_path) - 1);
525 status = connect (sd, (struct sockaddr *) &sa, sizeof (sa));
533 sh = fdopen (sd, "r+");
542 } /* }}} int rrdc_connect_unix */
544 static int rrdc_connect_network (const char *addr_orig) /* {{{ */
546 struct addrinfo ai_hints;
547 struct addrinfo *ai_res;
548 struct addrinfo *ai_ptr;
549 char addr_copy[NI_MAXHOST];
553 assert (addr_orig != NULL);
556 strncpy(addr_copy, addr_orig, sizeof(addr_copy));
557 addr_copy[sizeof(addr_copy) - 1] = '\0';
561 memset (&ai_hints, 0, sizeof (ai_hints));
562 ai_hints.ai_flags = 0;
564 ai_hints.ai_flags |= AI_ADDRCONFIG;
566 ai_hints.ai_family = AF_UNSPEC;
567 ai_hints.ai_socktype = SOCK_STREAM;
570 if (*addr == '[') /* IPv6+port format */
572 /* `addr' is something like "[2001:780:104:2:211:24ff:feab:26f8]:12345" */
575 port = strchr (addr, ']');
578 rrd_set_error("malformed address: %s", addr_orig);
590 rrd_set_error("garbage after address: %s", port);
593 } /* if (*addr == '[') */
596 port = rindex(addr, ':');
605 status = getaddrinfo (addr,
606 port == NULL ? RRDCACHED_DEFAULT_PORT : port,
610 rrd_set_error ("failed to resolve address `%s' (port %s): %s",
611 addr, port == NULL ? RRDCACHED_DEFAULT_PORT : port,
612 gai_strerror (status));
616 for (ai_ptr = ai_res; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
618 sd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol);
626 status = connect (sd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
634 sh = fdopen (sd, "r+");
642 assert (status == 0);
646 freeaddrinfo(ai_res);
649 } /* }}} int rrdc_connect_network */
651 int rrdc_connect (const char *addr) /* {{{ */
656 addr = getenv (ENV_RRDCACHED_ADDRESS);
661 pthread_mutex_lock(&lock);
663 if (sd >= 0 && sd_path != NULL && strcmp(addr, sd_path) == 0)
665 /* connection to the same daemon; use cached connection */
666 pthread_mutex_unlock (&lock);
675 if (strncmp ("unix:", addr, strlen ("unix:")) == 0)
676 status = rrdc_connect_unix (addr + strlen ("unix:"));
677 else if (addr[0] == '/')
678 status = rrdc_connect_unix (addr);
680 status = rrdc_connect_network(addr);
682 if (status == 0 && sd >= 0)
683 sd_path = strdup(addr);
686 char *err = rrd_test_error () ? rrd_get_error () : "Internal error";
687 /* err points the string that gets written to by rrd_set_error(), thus we
688 * cannot pass it to that function */
690 rrd_set_error("Unable to connect to rrdcached: %s",
692 ? (err ? err : "Internal error")
693 : rrd_strerror (status));
698 pthread_mutex_unlock (&lock);
700 } /* }}} int rrdc_connect */
702 int rrdc_disconnect (void) /* {{{ */
704 pthread_mutex_lock (&lock);
708 pthread_mutex_unlock (&lock);
711 } /* }}} int rrdc_disconnect */
713 int rrdc_update (const char *filename, int values_num, /* {{{ */
714 const char * const *values)
720 rrdc_response_t *res;
723 char file_path[PATH_MAX];
725 memset (buffer, 0, sizeof (buffer));
726 buffer_ptr = &buffer[0];
727 buffer_free = sizeof (buffer);
729 status = buffer_add_string ("update", &buffer_ptr, &buffer_free);
733 pthread_mutex_lock (&lock);
734 filename = get_path (filename, file_path);
735 if (filename == NULL)
737 pthread_mutex_unlock (&lock);
741 status = buffer_add_string (filename, &buffer_ptr, &buffer_free);
744 pthread_mutex_unlock (&lock);
748 for (i = 0; i < values_num; i++)
750 status = buffer_add_value (values[i], &buffer_ptr, &buffer_free);
753 pthread_mutex_unlock (&lock);
758 assert (buffer_free < sizeof (buffer));
759 buffer_size = sizeof (buffer) - buffer_free;
760 assert (buffer[buffer_size - 1] == ' ');
761 buffer[buffer_size - 1] = '\n';
764 status = request (buffer, buffer_size, &res);
765 pthread_mutex_unlock (&lock);
770 status = res->status;
774 } /* }}} int rrdc_update */
776 int rrdc_flush (const char *filename) /* {{{ */
782 rrdc_response_t *res;
784 char file_path[PATH_MAX];
786 if (filename == NULL)
789 memset (buffer, 0, sizeof (buffer));
790 buffer_ptr = &buffer[0];
791 buffer_free = sizeof (buffer);
793 status = buffer_add_string ("flush", &buffer_ptr, &buffer_free);
797 pthread_mutex_lock (&lock);
798 filename = get_path (filename, file_path);
799 if (filename == NULL)
801 pthread_mutex_unlock (&lock);
805 status = buffer_add_string (filename, &buffer_ptr, &buffer_free);
808 pthread_mutex_unlock (&lock);
812 assert (buffer_free < sizeof (buffer));
813 buffer_size = sizeof (buffer) - buffer_free;
814 assert (buffer[buffer_size - 1] == ' ');
815 buffer[buffer_size - 1] = '\n';
818 status = request (buffer, buffer_size, &res);
819 pthread_mutex_unlock (&lock);
824 status = res->status;
828 } /* }}} int rrdc_flush */
830 rrd_info_t * rrdc_info (const char *filename) /* {{{ */
836 rrdc_response_t *res;
838 char file_path[PATH_MAX];
839 rrd_info_t *data = NULL, *cd;
842 rrd_info_type_t itype;
845 if (filename == NULL) {
846 rrd_set_error ("rrdc_info: no filename");
850 memset (buffer, 0, sizeof (buffer));
851 buffer_ptr = &buffer[0];
852 buffer_free = sizeof (buffer);
854 status = buffer_add_string ("info", &buffer_ptr, &buffer_free);
856 rrd_set_error ("rrdc_info: out of memory");
860 pthread_mutex_lock (&lock);
861 filename = get_path (filename, file_path);
862 if (filename == NULL)
864 pthread_mutex_unlock (&lock);
868 status = buffer_add_string (filename, &buffer_ptr, &buffer_free);
871 pthread_mutex_unlock (&lock);
872 rrd_set_error ("rrdc_info: out of memory");
876 assert (buffer_free < sizeof (buffer));
877 buffer_size = sizeof (buffer) - buffer_free;
878 assert (buffer[buffer_size - 1] == ' ');
879 buffer[buffer_size - 1] = '\n';
882 status = request (buffer, buffer_size, &res);
883 pthread_mutex_unlock (&lock);
886 rrd_set_error ("rrdcached: %s", res->message);
890 for( l=0 ; l < res->lines_num ; l++ ) {
891 /* first extract the keyword */
892 for(k = s = res->lines[l];s && *s;s++) {
893 if(*s == ' ') { *s = 0; s++; break; }
896 itype = atoi(s); /* extract type code */
897 for(;*s;s++) { if(*s == ' ') { *s = 0; s++; break; } }
899 /* finally, we're pointing to the value */
902 if(*s == 'N') { info.u_val = DNAN; } else { info.u_val = atof(s); }
905 info.u_cnt = atol(s);
908 info.u_int = atoi(s);
912 info.u_str = (char*)malloc(sizeof(char) * (strlen(s) + 1));
913 strcpy(info.u_str,s);
916 rrd_set_error ("rrdc_info: BLOB objects are not supported");
919 rrd_set_error ("rrdc_info: Unsupported info type %d",itype);
923 cd = rrd_info_push(cd, sprintf_alloc("%s",k), itype, info);
929 } /* }}} int rrdc_info */
931 time_t rrdc_last (const char *filename) /* {{{ */
937 rrdc_response_t *res;
939 char file_path[PATH_MAX];
942 if (filename == NULL) {
943 rrd_set_error ("rrdc_last: no filename");
947 memset (buffer, 0, sizeof (buffer));
948 buffer_ptr = &buffer[0];
949 buffer_free = sizeof (buffer);
951 status = buffer_add_string ("last", &buffer_ptr, &buffer_free);
953 rrd_set_error ("rrdc_last: out of memory");
957 pthread_mutex_lock (&lock);
958 filename = get_path (filename, file_path);
959 if (filename == NULL)
961 pthread_mutex_unlock (&lock);
965 status = buffer_add_string (filename, &buffer_ptr, &buffer_free);
968 pthread_mutex_unlock (&lock);
969 rrd_set_error ("rrdc_last: out of memory");
973 assert (buffer_free < sizeof (buffer));
974 buffer_size = sizeof (buffer) - buffer_free;
975 assert (buffer[buffer_size - 1] == ' ');
976 buffer[buffer_size - 1] = '\n';
979 status = request (buffer, buffer_size, &res);
980 pthread_mutex_unlock (&lock);
983 rrd_set_error ("rrdcached: %s", res->message);
986 lastup = atol(res->message);
990 } /* }}} int rrdc_last */
992 time_t rrdc_first (const char *filename, int rraindex) /* {{{ */
998 rrdc_response_t *res;
1000 char file_path[PATH_MAX];
1003 if (filename == NULL) {
1004 rrd_set_error ("rrdc_first: no filename specified");
1008 memset (buffer, 0, sizeof (buffer));
1009 buffer_ptr = &buffer[0];
1010 buffer_free = sizeof (buffer);
1012 status = buffer_add_string ("first", &buffer_ptr, &buffer_free);
1014 rrd_set_error ("rrdc_first: out of memory");
1018 pthread_mutex_lock (&lock);
1019 filename = get_path (filename, file_path);
1020 if (filename == NULL)
1022 pthread_mutex_unlock (&lock);
1026 status = buffer_add_string (filename, &buffer_ptr, &buffer_free);
1029 pthread_mutex_unlock (&lock);
1030 rrd_set_error ("rrdc_first: out of memory");
1033 status = buffer_add_ulong (rraindex, &buffer_ptr, &buffer_free);
1036 pthread_mutex_unlock (&lock);
1037 rrd_set_error ("rrdc_first: out of memory");
1041 assert (buffer_free < sizeof (buffer));
1042 buffer_size = sizeof (buffer) - buffer_free;
1043 assert (buffer[buffer_size - 1] == ' ');
1044 buffer[buffer_size - 1] = '\n';
1047 status = request (buffer, buffer_size, &res);
1048 pthread_mutex_unlock (&lock);
1051 rrd_set_error ("rrdcached: %s", res->message);
1054 firstup = atol(res->message);
1055 response_free (res);
1058 } /* }}} int rrdc_first */
1060 int rrdc_create (const char *filename, /* {{{ */
1061 unsigned long pdp_step,
1071 rrdc_response_t *res;
1073 char file_path[PATH_MAX];
1076 if (filename == NULL) {
1077 rrd_set_error ("rrdc_create: no filename specified");
1081 memset (buffer, 0, sizeof (buffer));
1082 buffer_ptr = &buffer[0];
1083 buffer_free = sizeof (buffer);
1085 status = buffer_add_string ("create", &buffer_ptr, &buffer_free);
1087 rrd_set_error ("rrdc_create: out of memory");
1091 pthread_mutex_lock (&lock);
1092 filename = get_path (filename, file_path);
1093 if (filename == NULL)
1095 pthread_mutex_unlock (&lock);
1099 status = buffer_add_string (filename, &buffer_ptr, &buffer_free);
1100 status = buffer_add_string ("-b", &buffer_ptr, &buffer_free);
1101 status = buffer_add_ulong (last_up, &buffer_ptr, &buffer_free);
1102 status = buffer_add_string ("-s", &buffer_ptr, &buffer_free);
1103 status = buffer_add_ulong (pdp_step, &buffer_ptr, &buffer_free);
1105 status = buffer_add_string ("-O", &buffer_ptr, &buffer_free);
1109 pthread_mutex_unlock (&lock);
1110 rrd_set_error ("rrdc_create: out of memory");
1114 for( i=0; i<argc; i++ ) {
1116 status = buffer_add_string (argv[i], &buffer_ptr, &buffer_free);
1119 pthread_mutex_unlock (&lock);
1120 rrd_set_error ("rrdc_create: out of memory");
1126 /* buffer ready to send? */
1127 assert (buffer_free < sizeof (buffer));
1128 buffer_size = sizeof (buffer) - buffer_free;
1129 assert (buffer[buffer_size - 1] == ' ');
1130 buffer[buffer_size - 1] = '\n';
1133 status = request (buffer, buffer_size, &res);
1134 pthread_mutex_unlock (&lock);
1137 rrd_set_error ("rrdcached: %s", res->message);
1140 response_free (res);
1142 } /* }}} int rrdc_create */
1144 int rrdc_fetch (const char *filename, /* {{{ */
1146 time_t *ret_start, time_t *ret_end,
1147 unsigned long *ret_step,
1148 unsigned long *ret_ds_num,
1149 char ***ret_ds_names,
1150 rrd_value_t **ret_data)
1156 rrdc_response_t *res;
1157 char path_buffer[PATH_MAX];
1158 const char *path_ptr;
1161 unsigned long flush_version;
1166 unsigned long ds_num;
1174 size_t current_line;
1177 if ((filename == NULL) || (cf == NULL))
1180 /* Send request {{{ */
1181 memset (buffer, 0, sizeof (buffer));
1182 buffer_ptr = &buffer[0];
1183 buffer_free = sizeof (buffer);
1185 status = buffer_add_string ("FETCH", &buffer_ptr, &buffer_free);
1189 /* change to path for rrdcached */
1190 path_ptr = get_path (filename, path_buffer);
1191 if (path_ptr == NULL)
1194 status = buffer_add_string (path_ptr, &buffer_ptr, &buffer_free);
1198 status = buffer_add_string (cf, &buffer_ptr, &buffer_free);
1202 if ((ret_start != NULL) && (*ret_start > 0))
1205 snprintf (tmp, sizeof (tmp), "%lu", (unsigned long) *ret_start);
1206 tmp[sizeof (tmp) - 1] = 0;
1207 status = buffer_add_string (tmp, &buffer_ptr, &buffer_free);
1211 if ((ret_end != NULL) && (*ret_end > 0))
1213 snprintf (tmp, sizeof (tmp), "%lu", (unsigned long) *ret_end);
1214 tmp[sizeof (tmp) - 1] = 0;
1215 status = buffer_add_string (tmp, &buffer_ptr, &buffer_free);
1221 assert (buffer_free < sizeof (buffer));
1222 buffer_size = sizeof (buffer) - buffer_free;
1223 assert (buffer[buffer_size - 1] == ' ');
1224 buffer[buffer_size - 1] = '\n';
1227 status = request (buffer, buffer_size, &res);
1231 status = res->status;
1234 rrd_set_error ("rrdcached: %s", res->message);
1235 response_free (res);
1238 /* }}} Send request */
1245 /* Macros to make error handling a little easier (i. e. less to type and
1246 * read. `BAIL_OUT' sets the error message, frees all dynamically allocated
1247 * variables and returns the provided status code. */
1248 #define BAIL_OUT(status, ...) do { \
1249 rrd_set_error ("rrdc_fetch: " __VA_ARGS__); \
1251 if (ds_names != 0) { size_t k; for (k = 0; k < ds_num; k++) free (ds_names[k]); } \
1253 response_free (res); \
1257 #define READ_NUMERIC_FIELD(name,type,var) do { \
1259 unsigned long value; \
1260 assert (current_line < res->lines_num); \
1261 status = parse_ulong_header (res->lines[current_line], &key, &value); \
1263 BAIL_OUT (-1, "Unable to parse header `%s'", name); \
1264 if (strcasecmp (key, name) != 0) \
1265 BAIL_OUT (-1, "Unexpected header line: Expected `%s', got `%s'", name, key); \
1266 var = (type) value; \
1270 if (res->lines_num < 1)
1271 BAIL_OUT (-1, "Premature end of response packet");
1273 /* We're making some very strong assumptions about the fields below. We
1274 * therefore check the version of the `flush' command first, so that later
1275 * versions can change the order of fields and it's easier to implement
1276 * backwards compatibility. */
1277 READ_NUMERIC_FIELD ("FlushVersion", unsigned long, flush_version);
1278 if (flush_version != 1)
1279 BAIL_OUT (-1, "Don't know how to handle flush format version %lu.",
1282 if (res->lines_num < 5)
1283 BAIL_OUT (-1, "Premature end of response packet");
1285 READ_NUMERIC_FIELD ("Start", time_t, start);
1286 READ_NUMERIC_FIELD ("End", time_t, end);
1288 BAIL_OUT (-1, "Malformed start and end times: start = %lu; end = %lu;",
1289 (unsigned long) start,
1290 (unsigned long) end);
1292 READ_NUMERIC_FIELD ("Step", unsigned long, step);
1294 BAIL_OUT (-1, "Invalid number for Step: %lu", step);
1296 READ_NUMERIC_FIELD ("DSCount", unsigned long, ds_num);
1298 BAIL_OUT (-1, "Invalid number for DSCount: %lu", ds_num);
1300 /* It's time to allocate some memory */
1301 ds_names = calloc ((size_t) ds_num, sizeof (*ds_names));
1302 if (ds_names == NULL)
1303 BAIL_OUT (-1, "Out of memory");
1305 status = parse_char_array_header (res->lines[current_line],
1306 &str_tmp, ds_names, (size_t) ds_num, /* alloc = */ 1);
1308 BAIL_OUT (-1, "Unable to parse header `DSName'");
1309 if (strcasecmp ("DSName", str_tmp) != 0)
1310 BAIL_OUT (-1, "Unexpected header line: Expected `DSName', got `%s'", str_tmp);
1313 data_size = ds_num * (end - start) / step;
1315 BAIL_OUT (-1, "No data returned or headers invalid.");
1317 if (res->lines_num != (6 + (data_size / ds_num)))
1318 BAIL_OUT (-1, "Got %zu lines, expected %zu",
1319 res->lines_num, (6 + (data_size / ds_num)));
1321 data = calloc (data_size, sizeof (*data));
1323 BAIL_OUT (-1, "Out of memory");
1327 for (t = start + step; t <= end; t += step, current_line++)
1331 assert (current_line < res->lines_num);
1333 status = parse_value_array_header (res->lines[current_line],
1334 &tmp, data + data_fill, (size_t) ds_num);
1336 BAIL_OUT (-1, "Cannot parse value line");
1338 data_fill += (size_t) ds_num;
1344 *ret_ds_num = ds_num;
1345 *ret_ds_names = ds_names;
1348 response_free (res);
1350 #undef READ_NUMERIC_FIELD
1352 } /* }}} int rrdc_flush */
1354 /* convenience function; if there is a daemon specified, or if we can
1355 * detect one from the environment, then flush the file. Otherwise, no-op
1357 int rrdc_flush_if_daemon (const char *opt_daemon, const char *filename) /* {{{ */
1361 rrdc_connect(opt_daemon);
1363 if (rrdc_is_connected(opt_daemon))
1366 status = rrdc_flush (filename);
1368 if (status != 0 && !rrd_test_error())
1372 rrd_set_error("rrdc_flush (%s) failed: %s",
1373 filename, rrd_strerror(status));
1375 else if (status < 0)
1377 rrd_set_error("rrdc_flush (%s) failed with status %i.",
1381 } /* if (rrdc_is_connected(..)) */
1384 } /* }}} int rrdc_flush_if_daemon */
1387 int rrdc_stats_get (rrdc_stats_t **ret_stats) /* {{{ */
1392 rrdc_response_t *res;
1397 /* Protocol example: {{{
1399 * <- 5 Statistics follow
1401 * <- UpdatesWritten: 0
1402 * <- DataSetsWritten: 0
1403 * <- TreeNodesNumber: 0
1408 pthread_mutex_lock (&lock);
1409 status = request ("STATS\n", strlen ("STATS\n"), &res);
1410 pthread_mutex_unlock (&lock);
1415 if (res->status <= 0)
1417 response_free (res);
1423 for (i = 0; i < res->lines_num; i++)
1430 key = res->lines[i];
1431 value = strchr (key, ':');
1437 while ((value[0] == ' ') || (value[0] == '\t'))
1440 s = (rrdc_stats_t *) malloc (sizeof (rrdc_stats_t));
1443 memset (s, 0, sizeof (*s));
1445 s->name = strdup (key);
1448 if ((strcmp ("QueueLength", key) == 0)
1449 || (strcmp ("TreeDepth", key) == 0)
1450 || (strcmp ("TreeNodesNumber", key) == 0))
1452 s->type = RRDC_STATS_TYPE_GAUGE;
1453 s->value.gauge = strtod (value, &endptr);
1455 else if ((strcmp ("DataSetsWritten", key) == 0)
1456 || (strcmp ("FlushesReceived", key) == 0)
1457 || (strcmp ("JournalBytes", key) == 0)
1458 || (strcmp ("JournalRotate", key) == 0)
1459 || (strcmp ("UpdatesReceived", key) == 0)
1460 || (strcmp ("UpdatesWritten", key) == 0))
1462 s->type = RRDC_STATS_TYPE_COUNTER;
1463 s->value.counter = (uint64_t) strtoll (value, &endptr, /* base = */ 0);
1471 /* Conversion failed */
1472 if (endptr == value)
1489 } /* for (i = 0; i < res->lines_num; i++) */
1491 response_free (res);
1498 } /* }}} int rrdc_stats_get */
1500 void rrdc_stats_free (rrdc_stats_t *ret_stats) /* {{{ */
1505 while (this != NULL)
1511 if (this->name != NULL)
1513 free ((char *)this->name);
1519 } /* while (this != NULL) */
1520 } /* }}} void rrdc_stats_free */
1523 * vim: set sw=2 sts=2 ts=8 et fdm=marker :