src/rrd_client.c

   1 /**
   2  * RRDTool - src/rrd_client.c
   3  * Copyright (C) 2008 Florian octo Forster
   4  *
   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.
   8  *
   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.
  13  *
  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
  17  *
  18  * Authors:
  19  *   Florian octo Forster <octo at verplant.org>
  20  **/
  21
  22 #include "rrd.h"
  23 #include "rrd_client.h"
  24 #include "rrd_tool.h"
  25
  26 #include <stdlib.h>
  27 #include <string.h>
  28 #include <errno.h>
  29 #include <assert.h>
  30 #include <pthread.h>
  31 #include <sys/types.h>
  32 #include <sys/socket.h>
  33 #include <sys/un.h>
  34 #include <netdb.h>
  35
  36 #ifndef ENODATA
  37 #define ENODATA ENOENT
  38 #endif
  39
  40 struct rrdc_response_s
  41 {
  42   int status;
  43   char *message;
  44   char **lines;
  45   size_t lines_num;
  46 };
  47 typedef struct rrdc_response_s rrdc_response_t;
  48
  49 static pthread_mutex_t lock = PTHREAD_MUTEX_INITIALIZER;
  50 static int sd = -1;
  51 static FILE *sh = NULL;
  52 static char *sd_path = NULL; /* cache the path for sd */
  53
  54 /* One must hold `lock' when calling `close_connection'. */
  55 static void close_connection (void) /* {{{ */
  56 {
  57   if (sh != NULL)
  58   {
  59     fclose (sh);
  60     sh = NULL;
  61     sd = -1;
  62   }
  63   else if (sd >= 0)
  64   {
  65     close (sd);
  66     sd = -1;
  67   }
  68
  69   if (sd_path != NULL)
  70     free (sd_path);
  71   sd_path = NULL;
  72 } /* }}} void close_connection */
  73
  74 static int buffer_add_string (const char *str, /* {{{ */
  75     char **buffer_ret, size_t *buffer_size_ret)
  76 {
  77   char *buffer;
  78   size_t buffer_size;
  79   size_t buffer_pos;
  80   size_t i;
  81   int status;
  82
  83   buffer = *buffer_ret;
  84   buffer_size = *buffer_size_ret;
  85   buffer_pos = 0;
  86
  87   i = 0;
  88   status = -1;
  89   while (buffer_pos < buffer_size)
  90   {
  91     if (str[i] == 0)
  92     {
  93       buffer[buffer_pos] = ' ';
  94       buffer_pos++;
  95       status = 0;
  96       break;
  97     }
  98     else if ((str[i] == ' ') || (str[i] == '\\'))
  99     {
 100       if (buffer_pos >= (buffer_size - 1))
 101         break;
 102       buffer[buffer_pos] = '\\';
 103       buffer_pos++;
 104       buffer[buffer_pos] = str[i];
 105       buffer_pos++;
 106     }
 107     else
 108     {
 109       buffer[buffer_pos] = str[i];
 110       buffer_pos++;
 111     }
 112     i++;
 113   } /* while (buffer_pos < buffer_size) */
 114
 115   if (status != 0)
 116     return (-1);
 117
 118   *buffer_ret = buffer + buffer_pos;
 119   *buffer_size_ret = buffer_size - buffer_pos;
 120
 121   return (0);
 122 } /* }}} int buffer_add_string */
 123
 124 static int buffer_add_value (const char *value, /* {{{ */
 125     char **buffer_ret, size_t *buffer_size_ret)
 126 {
 127   char temp[4096];
 128
 129   if (strncmp (value, "N:", 2) == 0)
 130     snprintf (temp, sizeof (temp), "%lu:%s",
 131         (unsigned long) time (NULL), value + 2);
 132   else
 133     strncpy (temp, value, sizeof (temp));
 134   temp[sizeof (temp) - 1] = 0;
 135
 136   return (buffer_add_string (temp, buffer_ret, buffer_size_ret));
 137 } /* }}} int buffer_add_value */
 138
 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
 141  * removed. */
 142 static int chomp (char *str) /* {{{ */
 143 {
 144   size_t len;
 145   int removed;
 146
 147   if (str == NULL)
 148     return (-1);
 149
 150   len = strlen (str);
 151   removed = 0;
 152   while ((len > 0) && ((str[len - 1] == '\n') || (str[len - 1] == '\r')))
 153   {
 154     str[len - 1] = 0;
 155     len--;
 156     removed++;
 157   }
 158
 159   return (removed);
 160 } /* }}} int chomp */
 161
 162 static void response_free (rrdc_response_t *res) /* {{{ */
 163 {
 164   if (res == NULL)
 165     return;
 166
 167   if (res->lines != NULL)
 168   {
 169     size_t i;
 170
 171     for (i = 0; i < res->lines_num; i++)
 172       if (res->lines[i] != NULL)
 173         free (res->lines[i]);
 174     free (res->lines);
 175   }
 176
 177   free (res);
 178 } /* }}} void response_free */
 179
 180 static int response_read (rrdc_response_t **ret_response) /* {{{ */
 181 {
 182   rrdc_response_t *ret;
 183
 184   char buffer[4096];
 185   char *buffer_ptr;
 186
 187   size_t i;
 188
 189   if (sh == NULL)
 190     return (-1);
 191
 192   ret = (rrdc_response_t *) malloc (sizeof (rrdc_response_t));
 193   if (ret == NULL)
 194     return (-2);
 195   memset (ret, 0, sizeof (*ret));
 196   ret->lines = NULL;
 197   ret->lines_num = 0;
 198
 199   buffer_ptr = fgets (buffer, sizeof (buffer), sh);
 200   if (buffer_ptr == NULL)
 201     return (-3);
 202   chomp (buffer);
 203
 204   ret->status = strtol (buffer, &ret->message, 0);
 205   if (buffer == ret->message)
 206   {
 207     response_free (ret);
 208     return (-4);
 209   }
 210   /* Skip leading whitespace of the status message */
 211   ret->message += strspn (ret->message, " \t");
 212
 213   if (ret->status <= 0)
 214   {
 215     *ret_response = ret;
 216     return (0);
 217   }
 218
 219   ret->lines = (char **) malloc (sizeof (char *) * ret->status);
 220   if (ret->lines == NULL)
 221   {
 222     response_free (ret);
 223     return (-5);
 224   }
 225   memset (ret->lines, 0, sizeof (char *) * ret->status);
 226   ret->lines_num = (size_t) ret->status;
 227
 228   for (i = 0; i < ret->lines_num; i++)
 229   {
 230     buffer_ptr = fgets (buffer, sizeof (buffer), sh);
 231     if (buffer_ptr == NULL)
 232     {
 233       response_free (ret);
 234       return (-6);
 235     }
 236     chomp (buffer);
 237
 238     ret->lines[i] = strdup (buffer);
 239     if (ret->lines[i] == NULL)
 240     {
 241       response_free (ret);
 242       return (-7);
 243     }
 244   }
 245
 246   *ret_response = ret;
 247   return (0);
 248 } /* }}} rrdc_response_t *response_read */
 249
 250 static int request (const char *buffer, size_t buffer_size, /* {{{ */
 251     rrdc_response_t **ret_response)
 252 {
 253   int status;
 254   rrdc_response_t *res;
 255
 256   pthread_mutex_lock (&lock);
 257
 258   if (sh == NULL)
 259   {
 260     pthread_mutex_unlock (&lock);
 261     return (ENOTCONN);
 262   }
 263
 264   status = (int) fwrite (buffer, buffer_size, /* nmemb = */ 1, sh);
 265   if (status != 1)
 266   {
 267     close_connection ();
 268     pthread_mutex_unlock (&lock);
 269     return (-1);
 270   }
 271   fflush (sh);
 272
 273   res = NULL;
 274   status = response_read (&res);
 275
 276   pthread_mutex_unlock (&lock);
 277
 278   if (status != 0)
 279     return (status);
 280
 281   *ret_response = res;
 282   return (0);
 283 } /* }}} int request */
 284
 285 /* determine whether we are connected to the specified daemon_addr if
 286  * NULL, return whether we are connected at all
 287  */
 288 int rrdc_is_connected(const char *daemon_addr) /* {{{ */
 289 {
 290   if (sd < 0)
 291     return 0;
 292   else if (daemon_addr == NULL)
 293   {
 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
 299      */
 300     if (getenv(ENV_RRDCACHED_ADDRESS) != NULL)
 301       return 1;
 302     else
 303       return 0;
 304   }
 305   else if (strcmp(daemon_addr, sd_path) == 0)
 306     return 1;
 307   else
 308     return 0;
 309
 310 } /* }}} int rrdc_is_connected */
 311
 312 static int rrdc_connect_unix (const char *path) /* {{{ */
 313 {
 314   struct sockaddr_un sa;
 315   int status;
 316
 317   assert (path != NULL);
 318   assert (sd == -1);
 319
 320   sd = socket (PF_UNIX, SOCK_STREAM, /* protocol = */ 0);
 321   if (sd < 0)
 322   {
 323     status = errno;
 324     return (status);
 325   }
 326
 327   memset (&sa, 0, sizeof (sa));
 328   sa.sun_family = AF_UNIX;
 329   strncpy (sa.sun_path, path, sizeof (sa.sun_path) - 1);
 330
 331   status = connect (sd, (struct sockaddr *) &sa, sizeof (sa));
 332   if (status != 0)
 333   {
 334     status = errno;
 335     close_connection ();
 336     return (status);
 337   }
 338
 339   sh = fdopen (sd, "r+");
 340   if (sh == NULL)
 341   {
 342     status = errno;
 343     close_connection ();
 344     return (status);
 345   }
 346
 347   return (0);
 348 } /* }}} int rrdc_connect_unix */
 349
 350 static int rrdc_connect_network (const char *addr) /* {{{ */
 351 {
 352   struct addrinfo ai_hints;
 353   struct addrinfo *ai_res;
 354   struct addrinfo *ai_ptr;
 355   char *port;
 356
 357   assert (addr != NULL);
 358   assert (sd == -1);
 359
 360   int status;
 361   memset (&ai_hints, 0, sizeof (ai_hints));
 362   ai_hints.ai_flags = 0;
 363 #ifdef AI_ADDRCONFIG
 364   ai_hints.ai_flags |= AI_ADDRCONFIG;
 365 #endif
 366   ai_hints.ai_family = AF_UNSPEC;
 367   ai_hints.ai_socktype = SOCK_STREAM;
 368
 369   port = rindex(addr, ':');
 370   if (port != NULL)
 371     *port++ = '\0';
 372
 373   ai_res = NULL;
 374   status = getaddrinfo (addr,
 375                         port == NULL ? RRDCACHED_DEFAULT_PORT : port,
 376                         &ai_hints, &ai_res);
 377   if (status != 0)
 378     return (status);
 379
 380   for (ai_ptr = ai_res; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
 381   {
 382     sd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol);
 383     if (sd < 0)
 384     {
 385       status = errno;
 386       sd = -1;
 387       continue;
 388     }
 389
 390     status = connect (sd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
 391     if (status != 0)
 392     {
 393       status = errno;
 394       close_connection();
 395       continue;
 396     }
 397
 398     sh = fdopen (sd, "r+");
 399     if (sh == NULL)
 400     {
 401       status = errno;
 402       close_connection ();
 403       continue;
 404     }
 405
 406     assert (status == 0);
 407     break;
 408   } /* for (ai_ptr) */
 409
 410   return (status);
 411 } /* }}} int rrdc_connect_network */
 412
 413 int rrdc_connect (const char *addr) /* {{{ */
 414 {
 415   int status = 0;
 416
 417   if (addr == NULL)
 418     addr = getenv (ENV_RRDCACHED_ADDRESS);
 419
 420   if (addr == NULL)
 421     return 0;
 422
 423   pthread_mutex_lock(&lock);
 424
 425   if (sd >= 0 && sd_path != NULL && strcmp(addr, sd_path) == 0)
 426   {
 427     /* connection to the same daemon; use cached connection */
 428     pthread_mutex_unlock (&lock);
 429     return (0);
 430   }
 431   else
 432   {
 433     close_connection();
 434   }
 435
 436   if (strncmp ("unix:", addr, strlen ("unix:")) == 0)
 437     status = rrdc_connect_unix (addr + strlen ("unix:"));
 438   else if (addr[0] == '/')
 439     status = rrdc_connect_unix (addr);
 440   else
 441     status = rrdc_connect_network(addr);
 442
 443   if (status == 0 && sd >= 0)
 444     sd_path = strdup(addr);
 445   else
 446     rrd_set_error("Unable to connect to rrdcached: %s",
 447                   (status < 0)
 448                   ? "Internal error"
 449                   : rrd_strerror (status));
 450
 451   pthread_mutex_unlock (&lock);
 452   return (status);
 453 } /* }}} int rrdc_connect */
 454
 455 int rrdc_disconnect (void) /* {{{ */
 456 {
 457   pthread_mutex_lock (&lock);
 458
 459   close_connection();
 460
 461   pthread_mutex_unlock (&lock);
 462
 463   return (0);
 464 } /* }}} int rrdc_disconnect */
 465
 466 int rrdc_update (const char *filename, int values_num, /* {{{ */
 467                 const char * const *values)
 468 {
 469   char buffer[4096];
 470   char *buffer_ptr;
 471   size_t buffer_free;
 472   size_t buffer_size;
 473   rrdc_response_t *res;
 474   int status;
 475   int i;
 476
 477   memset (buffer, 0, sizeof (buffer));
 478   buffer_ptr = &buffer[0];
 479   buffer_free = sizeof (buffer);
 480
 481   status = buffer_add_string ("update", &buffer_ptr, &buffer_free);
 482   if (status != 0)
 483     return (ENOBUFS);
 484
 485   status = buffer_add_string (filename, &buffer_ptr, &buffer_free);
 486   if (status != 0)
 487     return (ENOBUFS);
 488
 489   for (i = 0; i < values_num; i++)
 490   {
 491     status = buffer_add_value (values[i], &buffer_ptr, &buffer_free);
 492     if (status != 0)
 493       return (ENOBUFS);
 494   }
 495
 496   assert (buffer_free < sizeof (buffer));
 497   buffer_size = sizeof (buffer) - buffer_free;
 498   assert (buffer[buffer_size - 1] == ' ');
 499   buffer[buffer_size - 1] = '\n';
 500
 501   res = NULL;
 502   status = request (buffer, buffer_size, &res);
 503   if (status != 0)
 504     return (status);
 505
 506   status = res->status;
 507   response_free (res);
 508
 509   return (status);
 510 } /* }}} int rrdc_update */
 511
 512 int rrdc_flush (const char *filename) /* {{{ */
 513 {
 514   char buffer[4096];
 515   char *buffer_ptr;
 516   size_t buffer_free;
 517   size_t buffer_size;
 518   rrdc_response_t *res;
 519   int status;
 520
 521   if (filename == NULL)
 522     return (-1);
 523
 524   memset (buffer, 0, sizeof (buffer));
 525   buffer_ptr = &buffer[0];
 526   buffer_free = sizeof (buffer);
 527
 528   status = buffer_add_string ("flush", &buffer_ptr, &buffer_free);
 529   if (status != 0)
 530     return (ENOBUFS);
 531
 532   status = buffer_add_string (filename, &buffer_ptr, &buffer_free);
 533   if (status != 0)
 534     return (ENOBUFS);
 535
 536   assert (buffer_free < sizeof (buffer));
 537   buffer_size = sizeof (buffer) - buffer_free;
 538   assert (buffer[buffer_size - 1] == ' ');
 539   buffer[buffer_size - 1] = '\n';
 540
 541   res = NULL;
 542   status = request (buffer, buffer_size, &res);
 543   if (status != 0)
 544     return (status);
 545
 546   status = res->status;
 547   response_free (res);
 548
 549   return (status);
 550 } /* }}} int rrdc_flush */
 551
 552
 553 /* convenience function; if there is a daemon specified, or if we can
 554  * detect one from the environment, then flush the file.  Otherwise, no-op
 555  */
 556 int rrdc_flush_if_daemon (const char *opt_daemon, const char *filename) /* {{{ */
 557 {
 558   int status = 0;
 559
 560   rrdc_connect(opt_daemon);
 561
 562   if (rrdc_is_connected(opt_daemon))
 563   {
 564     status = rrdc_flush (filename);
 565     if (status != 0)
 566     {
 567       rrd_set_error ("rrdc_flush (%s) failed with status %i.",
 568                      filename, status);
 569     }
 570   } /* if (daemon_addr) */
 571
 572   return status;
 573 } /* }}} int rrdc_flush_if_daemon */
 574
 575
 576 int rrdc_stats_get (rrdc_stats_t **ret_stats) /* {{{ */
 577 {
 578   rrdc_stats_t *head;
 579   rrdc_stats_t *tail;
 580
 581   rrdc_response_t *res;
 582
 583   int status;
 584   size_t i;
 585
 586   /* Protocol example: {{{
 587    * ->  STATS
 588    * <-  5 Statistics follow
 589    * <-  QueueLength: 0
 590    * <-  UpdatesWritten: 0
 591    * <-  DataSetsWritten: 0
 592    * <-  TreeNodesNumber: 0
 593    * <-  TreeDepth: 0
 594    * }}} */
 595
 596   res = NULL;
 597   status = request ("STATS\n", strlen ("STATS\n"), &res);
 598   if (status != 0)
 599     return (status);
 600
 601   if (res->status <= 0)
 602   {
 603     response_free (res);
 604     return (EIO);
 605   }
 606
 607   head = NULL;
 608   tail = NULL;
 609   for (i = 0; i < res->lines_num; i++)
 610   {
 611     char *key;
 612     char *value;
 613     char *endptr;
 614     rrdc_stats_t *s;
 615
 616     key = res->lines[i];
 617     value = strchr (key, ':');
 618     if (value == NULL)
 619       continue;
 620     *value = 0;
 621     value++;
 622
 623     while ((value[0] == ' ') || (value[0] == '\t'))
 624       value++;
 625
 626     s = (rrdc_stats_t *) malloc (sizeof (rrdc_stats_t));
 627     if (s == NULL)
 628       continue;
 629     memset (s, 0, sizeof (*s));
 630
 631     s->name = strdup (key);
 632
 633     endptr = NULL;
 634     if ((strcmp ("QueueLength", key) == 0)
 635         || (strcmp ("TreeDepth", key) == 0)
 636         || (strcmp ("TreeNodesNumber", key) == 0))
 637     {
 638       s->type = RRDC_STATS_TYPE_GAUGE;
 639       s->value.gauge = strtod (value, &endptr);
 640     }
 641     else if ((strcmp ("DataSetsWritten", key) == 0)
 642         || (strcmp ("FlushesReceived", key) == 0)
 643         || (strcmp ("JournalBytes", key) == 0)
 644         || (strcmp ("JournalRotate", key) == 0)
 645         || (strcmp ("UpdatesReceived", key) == 0)
 646         || (strcmp ("UpdatesWritten", key) == 0))
 647     {
 648       s->type = RRDC_STATS_TYPE_COUNTER;
 649       s->value.counter = (uint64_t) strtoll (value, &endptr, /* base = */ 0);
 650     }
 651     else
 652     {
 653       free (s);
 654       continue;
 655     }
 656
 657     /* Conversion failed */
 658     if (endptr == value)
 659     {
 660       free (s);
 661       continue;
 662     }
 663
 664     if (head == NULL)
 665     {
 666       head = s;
 667       tail = s;
 668       s->next = NULL;
 669     }
 670     else
 671     {
 672       tail->next = s;
 673       tail = s;
 674     }
 675   } /* for (i = 0; i < res->lines_num; i++) */
 676
 677   response_free (res);
 678
 679   if (head == NULL)
 680     return (EPROTO);
 681
 682   *ret_stats = head;
 683   return (0);
 684 } /* }}} int rrdc_stats_get */
 685
 686 void rrdc_stats_free (rrdc_stats_t *ret_stats) /* {{{ */
 687 {
 688   rrdc_stats_t *this;
 689
 690   this = ret_stats;
 691   while (this != NULL)
 692   {
 693     rrdc_stats_t *next;
 694
 695     next = this->next;
 696
 697     if (this->name != NULL)
 698     {
 699       free (this->name);
 700       this->name = NULL;
 701     }
 702     free (this);
 703
 704     this = next;
 705   } /* while (this != NULL) */
 706 } /* }}} void rrdc_stats_free */
 707
 708 /*
 709  * vim: set sw=2 sts=2 ts=8 et fdm=marker :
 710  */