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