2 * RRDTool - src/rrd_client.c
3 * Copyright (C) 2008 Florian octo Forster
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; only version 2 of the License is applicable.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 * Florian octo Forster <octo at verplant.org>
23 #include "rrd_client.h"
31 #include <sys/types.h>
32 #include <sys/socket.h>
37 #define ENODATA ENOENT
40 struct rrdc_response_s
47 typedef struct rrdc_response_s rrdc_response_t;
49 static pthread_mutex_t lock = PTHREAD_MUTEX_INITIALIZER;
51 static FILE *sh = NULL;
52 static char *sd_path = NULL; /* cache the path for sd */
54 /* One must hold `lock' when calling `close_connection'. */
55 static void close_connection (void) /* {{{ */
72 } /* }}} void close_connection */
74 static int buffer_add_string (const char *str, /* {{{ */
75 char **buffer_ret, size_t *buffer_size_ret)
84 buffer_size = *buffer_size_ret;
89 while (buffer_pos < buffer_size)
93 buffer[buffer_pos] = ' ';
98 else if ((str[i] == ' ') || (str[i] == '\\'))
100 if (buffer_pos >= (buffer_size - 1))
102 buffer[buffer_pos] = '\\';
104 buffer[buffer_pos] = str[i];
109 buffer[buffer_pos] = str[i];
113 } /* while (buffer_pos < buffer_size) */
118 *buffer_ret = buffer + buffer_pos;
119 *buffer_size_ret = buffer_size - buffer_pos;
122 } /* }}} int buffer_add_string */
124 static int buffer_add_value (const char *value, /* {{{ */
125 char **buffer_ret, size_t *buffer_size_ret)
129 if (strncmp (value, "N:", 2) == 0)
130 snprintf (temp, sizeof (temp), "%lu:%s",
131 (unsigned long) time (NULL), value + 2);
133 strncpy (temp, value, sizeof (temp));
134 temp[sizeof (temp) - 1] = 0;
136 return (buffer_add_string (temp, buffer_ret, buffer_size_ret));
137 } /* }}} int buffer_add_value */
139 /* Remove trailing newline (NL) and carriage return (CR) characters. Similar to
140 * the Perl function `chomp'. Returns the number of characters that have been
142 static int chomp (char *str) /* {{{ */
152 while ((len > 0) && ((str[len - 1] == '\n') || (str[len - 1] == '\r')))
160 } /* }}} int chomp */
162 static void response_free (rrdc_response_t *res) /* {{{ */
167 if (res->lines != NULL)
171 for (i = 0; i < res->lines_num; i++)
172 if (res->lines[i] != NULL)
173 free (res->lines[i]);
178 } /* }}} void response_free */
180 static int response_read (rrdc_response_t **ret_response) /* {{{ */
182 rrdc_response_t *ret;
192 ret = (rrdc_response_t *) malloc (sizeof (rrdc_response_t));
195 memset (ret, 0, sizeof (*ret));
199 buffer_ptr = fgets (buffer, sizeof (buffer), sh);
200 if (buffer_ptr == NULL)
204 ret->status = strtol (buffer, &ret->message, 0);
205 if (buffer == ret->message)
210 /* Skip leading whitespace of the status message */
211 ret->message += strspn (ret->message, " \t");
213 if (ret->status <= 0)
219 ret->lines = (char **) malloc (sizeof (char *) * ret->status);
220 if (ret->lines == NULL)
225 memset (ret->lines, 0, sizeof (char *) * ret->status);
226 ret->lines_num = (size_t) ret->status;
228 for (i = 0; i < ret->lines_num; i++)
230 buffer_ptr = fgets (buffer, sizeof (buffer), sh);
231 if (buffer_ptr == NULL)
238 ret->lines[i] = strdup (buffer);
239 if (ret->lines[i] == NULL)
248 } /* }}} rrdc_response_t *response_read */
250 static int request (const char *buffer, size_t buffer_size, /* {{{ */
251 rrdc_response_t **ret_response)
254 rrdc_response_t *res;
256 pthread_mutex_lock (&lock);
260 pthread_mutex_unlock (&lock);
264 status = (int) fwrite (buffer, buffer_size, /* nmemb = */ 1, sh);
268 pthread_mutex_unlock (&lock);
274 status = response_read (&res);
276 pthread_mutex_unlock (&lock);
283 } /* }}} int request */
285 /* determine whether we are connected to the specified daemon_addr if
286 * NULL, return whether we are connected at all
288 int rrdc_is_connected(const char *daemon_addr) /* {{{ */
292 else if (daemon_addr == NULL)
294 /* here we have to handle the case i.e.
295 * UPDATE --daemon ...; UPDATEV (no --daemon) ...
296 * In other words: we have a cached connection,
297 * but it is not specified in the current command.
298 * Daemon is only implied in this case if set in ENV
300 if (getenv(ENV_RRDCACHED_ADDRESS) != NULL)
305 else if (strcmp(daemon_addr, sd_path) == 0)
310 } /* }}} int rrdc_is_connected */
312 static int rrdc_connect_unix (const char *path) /* {{{ */
314 struct sockaddr_un sa;
317 assert (path != NULL);
320 sd = socket (PF_UNIX, SOCK_STREAM, /* protocol = */ 0);
327 memset (&sa, 0, sizeof (sa));
328 sa.sun_family = AF_UNIX;
329 strncpy (sa.sun_path, path, sizeof (sa.sun_path) - 1);
331 status = connect (sd, (struct sockaddr *) &sa, sizeof (sa));
339 sh = fdopen (sd, "r+");
348 } /* }}} int rrdc_connect_unix */
350 static int rrdc_connect_network (const char *addr) /* {{{ */
352 struct addrinfo ai_hints;
353 struct addrinfo *ai_res;
354 struct addrinfo *ai_ptr;
356 assert (addr != NULL);
360 memset (&ai_hints, 0, sizeof (ai_hints));
361 ai_hints.ai_flags = 0;
363 ai_hints.ai_flags |= AI_ADDRCONFIG;
365 ai_hints.ai_family = AF_UNSPEC;
366 ai_hints.ai_socktype = SOCK_STREAM;
369 status = getaddrinfo (addr, RRDCACHED_DEFAULT_PORT, &ai_hints, &ai_res);
373 for (ai_ptr = ai_res; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
375 sd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol);
383 status = connect (sd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
391 sh = fdopen (sd, "r+");
399 assert (status == 0);
404 } /* }}} int rrdc_connect_network */
406 int rrdc_connect (const char *addr) /* {{{ */
411 addr = getenv (ENV_RRDCACHED_ADDRESS);
416 pthread_mutex_lock(&lock);
418 if (sd >= 0 && sd_path != NULL && strcmp(addr, sd_path) == 0)
420 /* connection to the same daemon; use cached connection */
421 pthread_mutex_unlock (&lock);
429 if (strncmp ("unix:", addr, strlen ("unix:")) == 0)
430 status = rrdc_connect_unix (addr + strlen ("unix:"));
431 else if (addr[0] == '/')
432 status = rrdc_connect_unix (addr);
434 status = rrdc_connect_network(addr);
436 if (status == 0 && sd >= 0)
437 sd_path = strdup(addr);
439 rrd_set_error("Unable to connect to rrdcached: %s",
442 : rrd_strerror (status));
444 pthread_mutex_unlock (&lock);
446 } /* }}} int rrdc_connect */
448 int rrdc_disconnect (void) /* {{{ */
450 pthread_mutex_lock (&lock);
454 pthread_mutex_unlock (&lock);
457 } /* }}} int rrdc_disconnect */
459 int rrdc_update (const char *filename, int values_num, /* {{{ */
460 const char * const *values)
466 rrdc_response_t *res;
470 memset (buffer, 0, sizeof (buffer));
471 buffer_ptr = &buffer[0];
472 buffer_free = sizeof (buffer);
474 status = buffer_add_string ("update", &buffer_ptr, &buffer_free);
478 status = buffer_add_string (filename, &buffer_ptr, &buffer_free);
482 for (i = 0; i < values_num; i++)
484 status = buffer_add_value (values[i], &buffer_ptr, &buffer_free);
489 assert (buffer_free < sizeof (buffer));
490 buffer_size = sizeof (buffer) - buffer_free;
491 assert (buffer[buffer_size - 1] == ' ');
492 buffer[buffer_size - 1] = '\n';
495 status = request (buffer, buffer_size, &res);
499 status = res->status;
503 } /* }}} int rrdc_update */
505 int rrdc_flush (const char *filename) /* {{{ */
511 rrdc_response_t *res;
514 if (filename == NULL)
517 memset (buffer, 0, sizeof (buffer));
518 buffer_ptr = &buffer[0];
519 buffer_free = sizeof (buffer);
521 status = buffer_add_string ("flush", &buffer_ptr, &buffer_free);
525 status = buffer_add_string (filename, &buffer_ptr, &buffer_free);
529 assert (buffer_free < sizeof (buffer));
530 buffer_size = sizeof (buffer) - buffer_free;
531 assert (buffer[buffer_size - 1] == ' ');
532 buffer[buffer_size - 1] = '\n';
535 status = request (buffer, buffer_size, &res);
539 status = res->status;
543 } /* }}} int rrdc_flush */
546 /* convenience function; if there is a daemon specified, or if we can
547 * detect one from the environment, then flush the file. Otherwise, no-op
549 int rrdc_flush_if_daemon (const char *opt_daemon, const char *filename) /* {{{ */
553 rrdc_connect(opt_daemon);
555 if (rrdc_is_connected(opt_daemon))
557 status = rrdc_flush (filename);
560 rrd_set_error ("rrdc_flush (%s) failed with status %i.",
563 } /* if (daemon_addr) */
566 } /* }}} int rrdc_flush_if_daemon */
569 int rrdc_stats_get (rrdc_stats_t **ret_stats) /* {{{ */
574 rrdc_response_t *res;
579 /* Protocol example: {{{
581 * <- 5 Statistics follow
583 * <- UpdatesWritten: 0
584 * <- DataSetsWritten: 0
585 * <- TreeNodesNumber: 0
590 status = request ("STATS\n", strlen ("STATS\n"), &res);
594 if (res->status <= 0)
602 for (i = 0; i < res->lines_num; i++)
610 value = strchr (key, ':');
616 while ((value[0] == ' ') || (value[0] == '\t'))
619 s = (rrdc_stats_t *) malloc (sizeof (rrdc_stats_t));
622 memset (s, 0, sizeof (*s));
624 s->name = strdup (key);
627 if ((strcmp ("QueueLength", key) == 0)
628 || (strcmp ("TreeDepth", key) == 0)
629 || (strcmp ("TreeNodesNumber", key) == 0))
631 s->type = RRDC_STATS_TYPE_GAUGE;
632 s->value.gauge = strtod (value, &endptr);
634 else if ((strcmp ("DataSetsWritten", key) == 0)
635 || (strcmp ("FlushesReceived", key) == 0)
636 || (strcmp ("JournalBytes", key) == 0)
637 || (strcmp ("JournalRotate", key) == 0)
638 || (strcmp ("UpdatesReceived", key) == 0)
639 || (strcmp ("UpdatesWritten", key) == 0))
641 s->type = RRDC_STATS_TYPE_COUNTER;
642 s->value.counter = (uint64_t) strtoll (value, &endptr, /* base = */ 0);
650 /* Conversion failed */
668 } /* for (i = 0; i < res->lines_num; i++) */
677 } /* }}} int rrdc_stats_get */
679 void rrdc_stats_free (rrdc_stats_t *ret_stats) /* {{{ */
690 if (this->name != NULL)
698 } /* while (this != NULL) */
699 } /* }}} void rrdc_stats_free */
702 * vim: set sw=2 sts=2 ts=8 et fdm=marker :