src/memcached.c

   1 /**
   2  * collectd - src/memcached.c, based on src/hddtemp.c
   3  * Copyright (C) 2007       Antony Dovgal
   4  * Copyright (C) 2007-2012  Florian Forster
   5  * Copyright (C) 2009       Doug MacEachern
   6  * Copyright (C) 2009       Franck Lombardi
   7  * Copyright (C) 2012       Nicolas Szalay
   8  * Copyright (C) 2017       Pavel Rochnyak
   9  *
  10  * This program is free software; you can redistribute it and/or modify it
  11  * under the terms of the GNU General Public License as published by the
  12  * Free Software Foundation; either version 2 of the License, or (at your
  13  * option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful, but
  16  * WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with this program; if not, write to the Free Software Foundation, Inc.,
  22  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  23  *
  24  * Authors:
  25  *   Antony Dovgal <tony at daylessday dot org>
  26  *   Florian octo Forster <octo at collectd.org>
  27  *   Doug MacEachern <dougm at hyperic.com>
  28  *   Franck Lombardi
  29  *   Nicolas Szalay
  30  *   Pavel Rochnyak <pavel2000 ngs.ru>
  31  **/
  32
  33 #include "collectd.h"
  34
  35 #include "common.h"
  36 #include "plugin.h"
  37
  38 #include <netdb.h>
  39 #include <netinet/in.h>
  40 #include <netinet/tcp.h>
  41 #include <sys/un.h>
  42
  43 #include <poll.h>
  44
  45 #define MEMCACHED_DEF_HOST "127.0.0.1"
  46 #define MEMCACHED_DEF_PORT "11211"
  47 #define MEMCACHED_CONNECT_TIMEOUT 10000
  48 #define MEMCACHED_IO_TIMEOUT 5000
  49
  50 struct prev_s {
  51   derive_t hits;
  52   derive_t gets;
  53   derive_t incr_hits;
  54   derive_t incr_misses;
  55   derive_t decr_hits;
  56   derive_t decr_misses;
  57 };
  58
  59 typedef struct prev_s prev_t;
  60
  61 struct memcached_s {
  62   char *name;
  63   char *host;
  64   char *socket;
  65   char *connhost;
  66   char *connport;
  67   int fd;
  68   prev_t prev;
  69 };
  70 typedef struct memcached_s memcached_t;
  71
  72 static _Bool memcached_have_instances = 0;
  73
  74 static void memcached_free(void *arg) {
  75   memcached_t *st = arg;
  76   if (st == NULL)
  77     return;
  78
  79   if (st->fd >= 0) {
  80     shutdown(st->fd, SHUT_RDWR);
  81     close(st->fd);
  82     st->fd = -1;
  83   }
  84
  85   sfree(st->name);
  86   sfree(st->host);
  87   sfree(st->socket);
  88   sfree(st->connhost);
  89   sfree(st->connport);
  90   sfree(st);
  91 }
  92
  93 static int memcached_connect_unix(memcached_t *st) {
  94   struct sockaddr_un serv_addr = {0};
  95
  96   serv_addr.sun_family = AF_UNIX;
  97   sstrncpy(serv_addr.sun_path, st->socket, sizeof(serv_addr.sun_path));
  98
  99   /* create our socket descriptor */
 100   int fd = socket(AF_UNIX, SOCK_STREAM, 0);
 101   if (fd < 0) {
 102     ERROR("memcached plugin: memcached_connect_unix: socket(2) failed: %s",
 103           STRERRNO);
 104     return -1;
 105   }
 106
 107   /* connect to the memcached daemon */
 108   int status = connect(fd, (struct sockaddr *)&serv_addr, sizeof(serv_addr));
 109   if (status != 0) {
 110     shutdown(fd, SHUT_RDWR);
 111     close(fd);
 112     return -1;
 113   }
 114
 115   /* switch to non-blocking mode */
 116   int flags = fcntl(fd, F_GETFL);
 117   status = fcntl(fd, F_SETFL, flags | O_NONBLOCK);
 118   if (status != 0) {
 119     close(fd);
 120     return -1;
 121   }
 122
 123   return fd;
 124 } /* int memcached_connect_unix */
 125
 126 static int memcached_connect_inet(memcached_t *st) {
 127   struct addrinfo *ai_list;
 128   int fd = -1;
 129
 130   struct addrinfo ai_hints = {.ai_family = AF_UNSPEC,
 131                               .ai_flags = AI_ADDRCONFIG,
 132                               .ai_socktype = SOCK_STREAM};
 133
 134   int status = getaddrinfo(st->connhost, st->connport, &ai_hints, &ai_list);
 135   if (status != 0) {
 136     ERROR("memcached plugin: memcached_connect_inet: "
 137           "getaddrinfo(%s,%s) failed: %s",
 138           st->connhost, st->connport,
 139           (status == EAI_SYSTEM) ? STRERRNO : gai_strerror(status));
 140     return -1;
 141   }
 142
 143   for (struct addrinfo *ai_ptr = ai_list; ai_ptr != NULL;
 144        ai_ptr = ai_ptr->ai_next) {
 145     /* create our socket descriptor */
 146     fd = socket(ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol);
 147     if (fd < 0) {
 148       WARNING("memcached plugin: memcached_connect_inet: "
 149               "socket(2) failed: %s",
 150               STRERRNO);
 151       continue;
 152     }
 153
 154     /* switch socket to non-blocking mode */
 155     int flags = fcntl(fd, F_GETFL);
 156     status = fcntl(fd, F_SETFL, flags | O_NONBLOCK);
 157     if (status != 0) {
 158       close(fd);
 159       fd = -1;
 160       continue;
 161     }
 162
 163     /* connect to the memcached daemon */
 164     status = (int)connect(fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
 165     if (status != 0 && errno != EINPROGRESS) {
 166       shutdown(fd, SHUT_RDWR);
 167       close(fd);
 168       fd = -1;
 169       continue;
 170     }
 171
 172     /* Wait until connection establishes */
 173     struct pollfd pollfd = {
 174         .fd = fd, .events = POLLOUT,
 175     };
 176     do
 177       status = poll(&pollfd, 1, MEMCACHED_CONNECT_TIMEOUT);
 178     while (status < 0 && errno == EINTR);
 179     if (status <= 0) {
 180       close(fd);
 181       fd = -1;
 182       continue;
 183     }
 184
 185     /* Check if all is good */
 186     int socket_error;
 187     status = getsockopt(fd, SOL_SOCKET, SO_ERROR, (void *)&socket_error,
 188                         &(socklen_t){sizeof(socket_error)});
 189     if (status != 0 || socket_error != 0) {
 190       close(fd);
 191       fd = -1;
 192       continue;
 193     }
 194     /* A socket is opened and connection succeeded. We're done. */
 195     break;
 196   }
 197
 198   freeaddrinfo(ai_list);
 199   return fd;
 200 } /* int memcached_connect_inet */
 201
 202 static void memcached_connect(memcached_t *st) {
 203   if (st->fd >= 0)
 204     return;
 205
 206   if (st->socket != NULL)
 207     st->fd = memcached_connect_unix(st);
 208   else
 209     st->fd = memcached_connect_inet(st);
 210
 211   if (st->fd >= 0)
 212     INFO("memcached plugin: Instance \"%s\": connection established.",
 213          st->name);
 214 }
 215
 216 static int memcached_query_daemon(char *buffer, size_t buffer_size,
 217                                   memcached_t *st) {
 218   int status;
 219   size_t buffer_fill;
 220
 221   memcached_connect(st);
 222   if (st->fd < 0) {
 223     ERROR("memcached plugin: Instance \"%s\" could not connect to daemon.",
 224           st->name);
 225     return -1;
 226   }
 227
 228   struct pollfd pollfd = {
 229       .fd = st->fd, .events = POLLOUT,
 230   };
 231
 232   do
 233     status = poll(&pollfd, 1, MEMCACHED_IO_TIMEOUT);
 234   while (status < 0 && errno == EINTR);
 235
 236   if (status <= 0) {
 237     ERROR("memcached plugin: poll() failed for write() call.");
 238     close(st->fd);
 239     st->fd = -1;
 240     return -1;
 241   }
 242
 243   status = (int)swrite(st->fd, "stats\r\n", strlen("stats\r\n"));
 244   if (status != 0) {
 245     ERROR("memcached plugin: Instance \"%s\": write(2) failed: %s", st->name,
 246           STRERRNO);
 247     shutdown(st->fd, SHUT_RDWR);
 248     close(st->fd);
 249     st->fd = -1;
 250     return -1;
 251   }
 252
 253   /* receive data from the memcached daemon */
 254   memset(buffer, 0, buffer_size);
 255
 256   buffer_fill = 0;
 257   pollfd.events = POLLIN;
 258   while (1) {
 259     do
 260       status = poll(&pollfd, 1, MEMCACHED_IO_TIMEOUT);
 261     while (status < 0 && errno == EINTR);
 262
 263     if (status <= 0) {
 264       ERROR("memcached plugin: Instance \"%s\": Timeout reading from socket",
 265             st->name);
 266       close(st->fd);
 267       st->fd = -1;
 268       return -1;
 269     }
 270
 271     do
 272       status = (int)recv(st->fd, buffer + buffer_fill,
 273                          buffer_size - buffer_fill, /* flags = */ 0);
 274     while (status < 0 && errno == EINTR);
 275
 276     char const end_token[5] = {'E', 'N', 'D', '\r', '\n'};
 277     if (status < 0) {
 278
 279       if ((errno == EAGAIN) || (errno == EWOULDBLOCK))
 280         continue;
 281
 282       ERROR("memcached plugin: Instance \"%s\": Error reading from socket: %s",
 283             st->name, STRERRNO);
 284       shutdown(st->fd, SHUT_RDWR);
 285       close(st->fd);
 286       st->fd = -1;
 287       return -1;
 288     } else if (status == 0) {
 289       ERROR("memcached plugin: Instance \"%s\": Connection closed by peer",
 290             st->name);
 291       close(st->fd);
 292       st->fd = -1;
 293       return -1;
 294     }
 295
 296     buffer_fill += (size_t)status;
 297     if (buffer_fill > buffer_size) {
 298       buffer_fill = buffer_size;
 299       WARNING("memcached plugin: Instance \"%s\": Message was truncated.",
 300               st->name);
 301       shutdown(st->fd, SHUT_RDWR);
 302       close(st->fd);
 303       st->fd = -1;
 304       break;
 305     }
 306
 307     /* If buffer ends in end_token, we have all the data. */
 308     if (memcmp(buffer + buffer_fill - sizeof(end_token), end_token,
 309                sizeof(end_token)) == 0)
 310       break;
 311   } /* while (recv) */
 312
 313   status = 0;
 314   if (buffer_fill == 0) {
 315     WARNING("memcached plugin: Instance \"%s\": No data returned by memcached.",
 316             st->name);
 317     status = -1;
 318   }
 319
 320   return status;
 321 } /* int memcached_query_daemon */
 322
 323 static void memcached_init_vl(value_list_t *vl, memcached_t const *st) {
 324   sstrncpy(vl->plugin, "memcached", sizeof(vl->plugin));
 325   if (st->host != NULL)
 326     sstrncpy(vl->host, st->host, sizeof(vl->host));
 327   if (st->name != NULL)
 328     sstrncpy(vl->plugin_instance, st->name, sizeof(vl->plugin_instance));
 329 }
 330
 331 static void submit_derive(const char *type, const char *type_inst,
 332                           derive_t value, memcached_t *st) {
 333   value_list_t vl = VALUE_LIST_INIT;
 334
 335   memcached_init_vl(&vl, st);
 336   vl.values = &(value_t){.derive = value};
 337   vl.values_len = 1;
 338   sstrncpy(vl.type, type, sizeof(vl.type));
 339   if (type_inst != NULL)
 340     sstrncpy(vl.type_instance, type_inst, sizeof(vl.type_instance));
 341
 342   plugin_dispatch_values(&vl);
 343 }
 344
 345 static void submit_derive2(const char *type, const char *type_inst,
 346                            derive_t value0, derive_t value1, memcached_t *st) {
 347   value_list_t vl = VALUE_LIST_INIT;
 348   value_t values[] = {
 349       {.derive = value0}, {.derive = value1},
 350   };
 351
 352   memcached_init_vl(&vl, st);
 353   vl.values = values;
 354   vl.values_len = STATIC_ARRAY_SIZE(values);
 355   sstrncpy(vl.type, type, sizeof(vl.type));
 356   if (type_inst != NULL)
 357     sstrncpy(vl.type_instance, type_inst, sizeof(vl.type_instance));
 358
 359   plugin_dispatch_values(&vl);
 360 }
 361
 362 static void submit_gauge(const char *type, const char *type_inst, gauge_t value,
 363                          memcached_t *st) {
 364   value_list_t vl = VALUE_LIST_INIT;
 365
 366   memcached_init_vl(&vl, st);
 367   vl.values = &(value_t){.gauge = value};
 368   vl.values_len = 1;
 369   sstrncpy(vl.type, type, sizeof(vl.type));
 370   if (type_inst != NULL)
 371     sstrncpy(vl.type_instance, type_inst, sizeof(vl.type_instance));
 372
 373   plugin_dispatch_values(&vl);
 374 }
 375
 376 static void submit_gauge2(const char *type, const char *type_inst,
 377                           gauge_t value0, gauge_t value1, memcached_t *st) {
 378   value_list_t vl = VALUE_LIST_INIT;
 379   value_t values[] = {
 380       {.gauge = value0}, {.gauge = value1},
 381   };
 382
 383   memcached_init_vl(&vl, st);
 384   vl.values = values;
 385   vl.values_len = STATIC_ARRAY_SIZE(values);
 386   sstrncpy(vl.type, type, sizeof(vl.type));
 387   if (type_inst != NULL)
 388     sstrncpy(vl.type_instance, type_inst, sizeof(vl.type_instance));
 389
 390   plugin_dispatch_values(&vl);
 391 }
 392
 393 static gauge_t calculate_ratio_percent(derive_t part, derive_t total,
 394                                        derive_t *prev_part,
 395                                        derive_t *prev_total) {
 396   if ((*prev_part == 0) || (*prev_total == 0) || (part < *prev_part) ||
 397       (total < *prev_total)) {
 398     *prev_part = part;
 399     *prev_total = total;
 400     return NAN;
 401   }
 402
 403   derive_t num = part - *prev_part;
 404   derive_t denom = total - *prev_total;
 405
 406   *prev_part = part;
 407   *prev_total = total;
 408
 409   if (denom == 0)
 410     return NAN;
 411
 412   if (num == 0)
 413     return 0;
 414
 415   return 100.0 * (gauge_t)num / (gauge_t)denom;
 416 }
 417
 418 static gauge_t calculate_ratio_percent2(derive_t part1, derive_t part2,
 419                                         derive_t *prev1, derive_t *prev2) {
 420   if ((*prev1 == 0) || (*prev2 == 0) || (part1 < *prev1) || (part2 < *prev2)) {
 421     *prev1 = part1;
 422     *prev2 = part2;
 423     return NAN;
 424   }
 425
 426   derive_t num = part1 - *prev1;
 427   derive_t denom = part2 - *prev2 + num;
 428
 429   *prev1 = part1;
 430   *prev2 = part2;
 431
 432   if (denom == 0)
 433     return NAN;
 434
 435   if (num == 0)
 436     return 0;
 437
 438   return 100.0 * (gauge_t)num / (gauge_t)denom;
 439 }
 440
 441 static int memcached_read(user_data_t *user_data) {
 442   char buf[4096];
 443   char *fields[3];
 444   char *line;
 445
 446   derive_t bytes_used = 0;
 447   derive_t bytes_total = 0;
 448   derive_t get_hits = 0;
 449   derive_t cmd_get = 0;
 450   derive_t incr_hits = 0;
 451   derive_t incr_misses = 0;
 452   derive_t decr_hits = 0;
 453   derive_t decr_misses = 0;
 454   derive_t rusage_user = 0;
 455   derive_t rusage_syst = 0;
 456   derive_t octets_rx = 0;
 457   derive_t octets_tx = 0;
 458
 459   memcached_t *st = user_data->data;
 460   prev_t *prev = &st->prev;
 461
 462   /* get data from daemon */
 463   if (memcached_query_daemon(buf, sizeof(buf), st) < 0) {
 464     return -1;
 465   }
 466
 467 #define FIELD_IS(cnst)                                                         \
 468   (((sizeof(cnst) - 1) == name_len) && (strcmp(cnst, fields[1]) == 0))
 469
 470   char *ptr = buf;
 471   char *saveptr = NULL;
 472   while ((line = strtok_r(ptr, "\n\r", &saveptr)) != NULL) {
 473     ptr = NULL;
 474
 475     if (strsplit(line, fields, 3) != 3)
 476       continue;
 477
 478     int name_len = strlen(fields[1]);
 479     if (name_len == 0)
 480       continue;
 481
 482     /*
 483      * For an explanation on these fields please refer to
 484      * <https://github.com/memcached/memcached/blob/master/doc/protocol.txt>
 485      */
 486
 487     /*
 488      * CPU time consumed by the memcached process
 489      */
 490     if (FIELD_IS("rusage_user")) {
 491       /* Convert to useconds */
 492       rusage_user = atof(fields[2]) * 1000000;
 493     } else if (FIELD_IS("rusage_system")) {
 494       rusage_syst = atof(fields[2]) * 1000000;
 495     }
 496
 497     /*
 498      * Number of threads of this instance
 499      */
 500     else if (FIELD_IS("threads")) {
 501       submit_gauge2("ps_count", NULL, NAN, atof(fields[2]), st);
 502     }
 503
 504     /*
 505      * Number of items stored
 506      */
 507     else if (FIELD_IS("curr_items")) {
 508       submit_gauge("memcached_items", "current", atof(fields[2]), st);
 509     }
 510
 511     /*
 512      * Number of bytes used and available (total - used)
 513      */
 514     else if (FIELD_IS("bytes")) {
 515       bytes_used = atoll(fields[2]);
 516     } else if (FIELD_IS("limit_maxbytes")) {
 517       bytes_total = atoll(fields[2]);
 518     }
 519
 520     /*
 521      * Connections
 522      */
 523     else if (FIELD_IS("curr_connections")) {
 524       submit_gauge("memcached_connections", "current", atof(fields[2]), st);
 525     } else if (FIELD_IS("listen_disabled_num")) {
 526       submit_derive("total_events", "listen_disabled", atoll(fields[2]), st);
 527     }
 528     /*
 529      * Total number of connections opened since the server started running
 530      * Report this as connection rate.
 531      */
 532     else if (FIELD_IS("total_connections")) {
 533       submit_derive("connections", "opened", atoll(fields[2]), st);
 534     }
 535
 536     /*
 537      * Commands
 538      */
 539     else if ((name_len > 4) && (strncmp(fields[1], "cmd_", 4) == 0)) {
 540       const char *name = fields[1] + 4;
 541       submit_derive("memcached_command", name, atoll(fields[2]), st);
 542       if (strcmp(name, "get") == 0)
 543         cmd_get = atoll(fields[2]);
 544     }
 545
 546     /*
 547      * Increment/Decrement
 548      */
 549     else if (FIELD_IS("incr_misses")) {
 550       incr_misses = atoll(fields[2]);
 551       submit_derive("memcached_ops", "incr_misses", incr_misses, st);
 552     } else if (FIELD_IS("incr_hits")) {
 553       incr_hits = atoll(fields[2]);
 554       submit_derive("memcached_ops", "incr_hits", incr_hits, st);
 555     } else if (FIELD_IS("decr_misses")) {
 556       decr_misses = atoll(fields[2]);
 557       submit_derive("memcached_ops", "decr_misses", decr_misses, st);
 558     } else if (FIELD_IS("decr_hits")) {
 559       decr_hits = atoll(fields[2]);
 560       submit_derive("memcached_ops", "decr_hits", decr_hits, st);
 561     }
 562
 563     /*
 564      * Operations on the cache:
 565      * - get hits/misses
 566      * - delete hits/misses
 567      * - evictions
 568      */
 569     else if (FIELD_IS("get_hits")) {
 570       get_hits = atoll(fields[2]);
 571       submit_derive("memcached_ops", "hits", get_hits, st);
 572     } else if (FIELD_IS("get_misses")) {
 573       submit_derive("memcached_ops", "misses", atoll(fields[2]), st);
 574     } else if (FIELD_IS("evictions")) {
 575       submit_derive("memcached_ops", "evictions", atoll(fields[2]), st);
 576     } else if (FIELD_IS("delete_hits")) {
 577       submit_derive("memcached_ops", "delete_hits", atoll(fields[2]), st);
 578     } else if (FIELD_IS("delete_misses")) {
 579       submit_derive("memcached_ops", "delete_misses", atoll(fields[2]), st);
 580     }
 581
 582     /*
 583      * Network traffic
 584      */
 585     else if (FIELD_IS("bytes_read")) {
 586       octets_rx = atoll(fields[2]);
 587     } else if (FIELD_IS("bytes_written")) {
 588       octets_tx = atoll(fields[2]);
 589     }
 590   } /* while ((line = strtok_r (ptr, "\n\r", &saveptr)) != NULL) */
 591
 592   if ((bytes_total > 0) && (bytes_used <= bytes_total))
 593     submit_gauge2("df", "cache", bytes_used, bytes_total - bytes_used, st);
 594
 595   if ((rusage_user != 0) || (rusage_syst != 0))
 596     submit_derive2("ps_cputime", NULL, rusage_user, rusage_syst, st);
 597
 598   if ((octets_rx != 0) || (octets_tx != 0))
 599     submit_derive2("memcached_octets", NULL, octets_rx, octets_tx, st);
 600
 601   if ((cmd_get != 0) && (get_hits != 0)) {
 602     gauge_t ratio =
 603         calculate_ratio_percent(get_hits, cmd_get, &prev->hits, &prev->gets);
 604     submit_gauge("percent", "hitratio", ratio, st);
 605   }
 606
 607   if ((incr_hits != 0) && (incr_misses != 0)) {
 608     gauge_t ratio = calculate_ratio_percent2(
 609         incr_hits, incr_misses, &prev->incr_hits, &prev->incr_misses);
 610     submit_gauge("percent", "incr_hitratio", ratio, st);
 611     submit_derive("memcached_ops", "incr", incr_hits + incr_misses, st);
 612   }
 613
 614   if ((decr_hits != 0) && (decr_misses != 0)) {
 615     gauge_t ratio = calculate_ratio_percent2(
 616         decr_hits, decr_misses, &prev->decr_hits, &prev->decr_misses);
 617     submit_gauge("percent", "decr_hitratio", ratio, st);
 618     submit_derive("memcached_ops", "decr", decr_hits + decr_misses, st);
 619   }
 620
 621   return 0;
 622 } /* int memcached_read */
 623
 624 static int memcached_set_defaults(memcached_t *st) {
 625   /* If no <Address> used then:
 626    * - Connect to the destination specified by <Host>, if present.
 627    *   If not, use the default address.
 628    * - Use the default hostname (set st->host to NULL), if
 629    *    - Legacy mode is used (no configuration options at all), or
 630    *    - "Host" option is not provided, or
 631    *    - "Host" option is set to "localhost" or "127.0.0.1".
 632    *
 633    * If <Address> used then host may be set to "localhost" or "127.0.0.1"
 634    * explicitly.
 635    */
 636   if (st->connhost == NULL) {
 637     if (st->host) {
 638       st->connhost = strdup(st->host);
 639       if (st->connhost == NULL)
 640         return ENOMEM;
 641
 642       if ((strcmp("127.0.0.1", st->host) == 0) ||
 643           (strcmp("localhost", st->host) == 0))
 644         sfree(st->host);
 645     } else {
 646       st->connhost = strdup(MEMCACHED_DEF_HOST);
 647       if (st->connhost == NULL)
 648         return ENOMEM;
 649     }
 650   }
 651
 652   if (st->connport == NULL) {
 653     st->connport = strdup(MEMCACHED_DEF_PORT);
 654     if (st->connport == NULL)
 655       return ENOMEM;
 656   }
 657
 658   assert(st->connhost != NULL);
 659   assert(st->connport != NULL);
 660
 661   st->prev.hits = 0;
 662   st->prev.gets = 0;
 663   st->prev.incr_hits = 0;
 664   st->prev.incr_misses = 0;
 665   st->prev.decr_hits = 0;
 666   st->prev.decr_misses = 0;
 667
 668   return 0;
 669 } /* int memcached_set_defaults */
 670
 671 static int memcached_add_read_callback(memcached_t *st) {
 672   char callback_name[3 * DATA_MAX_NAME_LEN];
 673
 674   if (memcached_set_defaults(st) != 0) {
 675     memcached_free(st);
 676     return -1;
 677   }
 678
 679   snprintf(callback_name, sizeof(callback_name), "memcached/%s",
 680            (st->name != NULL) ? st->name : "__legacy__");
 681
 682   return plugin_register_complex_read(
 683       /* group = */ "memcached",
 684       /* name      = */ callback_name,
 685       /* callback  = */ memcached_read,
 686       /* interval  = */ 0,
 687       &(user_data_t){
 688           .data = st, .free_func = memcached_free,
 689       });
 690 } /* int memcached_add_read_callback */
 691
 692 /* Configuration handling functiions
 693  * <Plugin memcached>
 694  *   <Instance "instance_name">
 695  *     Host foo.zomg.com
 696  *     Address 1.2.3.4
 697  *     Port "1234"
 698  *   </Instance>
 699  * </Plugin>
 700  */
 701 static int config_add_instance(oconfig_item_t *ci) {
 702   int status = 0;
 703
 704   /* Disable automatic generation of default instance in the init callback. */
 705   memcached_have_instances = 1;
 706
 707   memcached_t *st = calloc(1, sizeof(*st));
 708   if (st == NULL) {
 709     ERROR("memcached plugin: calloc failed.");
 710     return ENOMEM;
 711   }
 712
 713   st->name = NULL;
 714   st->host = NULL;
 715   st->socket = NULL;
 716   st->connhost = NULL;
 717   st->connport = NULL;
 718
 719   st->fd = -1;
 720
 721   if (strcasecmp(ci->key, "Instance") == 0)
 722     status = cf_util_get_string(ci, &st->name);
 723
 724   if (status != 0) {
 725     sfree(st);
 726     return status;
 727   }
 728
 729   for (int i = 0; i < ci->children_num; i++) {
 730     oconfig_item_t *child = ci->children + i;
 731
 732     if (strcasecmp("Socket", child->key) == 0)
 733       status = cf_util_get_string(child, &st->socket);
 734     else if (strcasecmp("Host", child->key) == 0)
 735       status = cf_util_get_string(child, &st->host);
 736     else if (strcasecmp("Address", child->key) == 0)
 737       status = cf_util_get_string(child, &st->connhost);
 738     else if (strcasecmp("Port", child->key) == 0)
 739       status = cf_util_get_service(child, &st->connport);
 740     else {
 741       WARNING("memcached plugin: Option `%s' not allowed here.", child->key);
 742       status = -1;
 743     }
 744
 745     if (status != 0)
 746       break;
 747   }
 748
 749   if (status != 0) {
 750     memcached_free(st);
 751     return -1;
 752   }
 753
 754   return memcached_add_read_callback(st);
 755 } /* int config_add_instance */
 756
 757 static int memcached_config(oconfig_item_t *ci) {
 758   _Bool have_instance_block = 0;
 759
 760   for (int i = 0; i < ci->children_num; i++) {
 761     oconfig_item_t *child = ci->children + i;
 762
 763     if (strcasecmp("Instance", child->key) == 0) {
 764       config_add_instance(child);
 765       have_instance_block = 1;
 766     } else if (!have_instance_block) {
 767       /* Non-instance option: Assume legacy configuration (without <Instance />
 768        * blocks) and call config_add_instance() with the <Plugin /> block. */
 769       return config_add_instance(ci);
 770     } else
 771       WARNING("memcached plugin: The configuration option "
 772               "\"%s\" is not allowed here. Did you "
 773               "forget to add an <Instance /> block "
 774               "around the configuration?",
 775               child->key);
 776   } /* for (ci->children) */
 777
 778   return 0;
 779 } /* int memcached_config */
 780
 781 static int memcached_init(void) {
 782
 783   if (memcached_have_instances)
 784     return 0;
 785
 786   /* No instances were configured, lets start a default instance. */
 787   memcached_t *st = calloc(1, sizeof(*st));
 788   if (st == NULL)
 789     return ENOMEM;
 790   st->name = NULL;
 791   st->host = NULL;
 792   st->socket = NULL;
 793   st->connhost = NULL;
 794   st->connport = NULL;
 795
 796   st->fd = -1;
 797
 798   int status = memcached_add_read_callback(st);
 799   if (status == 0)
 800     memcached_have_instances = 1;
 801
 802   return status;
 803 } /* int memcached_init */
 804
 805 void module_register(void) {
 806   plugin_register_complex_config("memcached", memcached_config);
 807   plugin_register_init("memcached", memcached_init);
 808 }