git.m6w6.name Git - m6w6/libmemcached/blob - src/libmemcached/memcached.cc

   1 /*
   2     +--------------------------------------------------------------------+
   3     | libmemcached - C/C++ Client Library for memcached                  |
   4     +--------------------------------------------------------------------+
   5     | Redistribution and use in source and binary forms, with or without |
   6     | modification, are permitted under the terms of the BSD license.    |
   7     | You should have received a copy of the license in a bundled file   |
   8     | named LICENSE; in case you did not receive a copy you can review   |
   9     | the terms online at: https://opensource.org/licenses/BSD-3-Clause  |
  10     +--------------------------------------------------------------------+
  11     | Copyright (c) 2006-2014 Brian Aker   https://datadifferential.com/ |
  12     | Copyright (c) 2020 Michael Wallner   <mike@php.net>                |
  13     +--------------------------------------------------------------------+
  14 */
  15
  16 #include "libmemcached/common.h"
  17
  18 #include "libmemcached/options.hpp"
  19 #include "libmemcached/virtual_bucket.h"
  20
  21 static inline bool _memcached_init(Memcached *self) {
  22   self->state.is_purging = false;
  23   self->state.is_processing_input = false;
  24   self->state.is_time_for_rebuild = false;
  25   self->state.is_parsing = false;
  26
  27   self->flags.auto_eject_hosts = false;
  28   self->flags.binary_protocol = false;
  29   self->flags.buffer_requests = false;
  30   self->flags.hash_with_namespace = false;
  31   self->flags.no_block = false;
  32   self->flags.reply = true;
  33   self->flags.randomize_replica_read = false;
  34   self->flags.support_cas = false;
  35   self->flags.tcp_nodelay = false;
  36   self->flags.use_sort_hosts = false;
  37   self->flags.use_udp = false;
  38   self->flags.verify_key = false;
  39   self->flags.tcp_keepalive = false;
  40   self->flags.is_aes = false;
  41   self->flags.is_fetching_version = false;
  42
  43   self->virtual_bucket = NULL;
  44
  45   self->distribution = MEMCACHED_DISTRIBUTION_MODULA;
  46
  47   if (hashkit_create(&self->hashkit) == NULL) {
  48     return false;
  49   }
  50
  51   self->server_info.version = 0;
  52
  53   self->ketama.continuum = NULL;
  54   self->ketama.continuum_count = 0;
  55   self->ketama.continuum_points_counter = 0;
  56   self->ketama.next_distribution_rebuild = 0;
  57   self->ketama.weighted_ = false;
  58
  59   self->number_of_hosts = 0;
  60   self->servers = NULL;
  61   self->last_disconnected_server = NULL;
  62
  63   self->snd_timeout = 0;
  64   self->rcv_timeout = 0;
  65   self->server_failure_limit = MEMCACHED_SERVER_FAILURE_LIMIT;
  66   self->server_timeout_limit = MEMCACHED_SERVER_TIMEOUT_LIMIT;
  67   self->query_id = 1; // 0 is considered invalid
  68
  69   /* TODO, Document why we picked these defaults */
  70   self->io_msg_watermark = 500;
  71   self->io_bytes_watermark = 65 * 1024;
  72
  73   self->tcp_keepidle = 0;
  74
  75   self->io_key_prefetch = 0;
  76   self->poll_timeout = MEMCACHED_DEFAULT_TIMEOUT;
  77   self->connect_timeout = MEMCACHED_DEFAULT_CONNECT_TIMEOUT;
  78   self->retry_timeout = MEMCACHED_SERVER_FAILURE_RETRY_TIMEOUT;
  79   self->dead_timeout = MEMCACHED_SERVER_FAILURE_DEAD_TIMEOUT;
  80
  81   self->send_size = -1;
  82   self->recv_size = -1;
  83
  84   self->user_data = NULL;
  85   self->number_of_replicas = 0;
  86
  87   self->allocators = memcached_allocators_return_default();
  88
  89   self->on_clone = NULL;
  90   self->on_cleanup = NULL;
  91   self->get_key_failure = NULL;
  92   self->delete_trigger = NULL;
  93   self->callbacks = NULL;
  94   self->sasl.callbacks = NULL;
  95   self->sasl.is_allocated = false;
  96
  97   self->error_messages = NULL;
  98   self->_namespace = NULL;
  99   self->configure.initial_pool_size = 1;
 100   self->configure.max_pool_size = 1;
 101   self->configure.version = -1;
 102   self->configure.filename = NULL;
 103
 104   return true;
 105 }
 106
 107 static void __memcached_free(Memcached *ptr, bool release_st) {
 108   /* If we have anything open, lets close it now */
 109   send_quit(ptr);
 110   memcached_instance_list_free(memcached_instance_list(ptr), memcached_instance_list_count(ptr));
 111   memcached_result_free(&ptr->result);
 112
 113   memcached_virtual_bucket_free(ptr);
 114
 115   memcached_instance_free((memcached_instance_st *) ptr->last_disconnected_server);
 116
 117   if (ptr->on_cleanup) {
 118     ptr->on_cleanup(ptr);
 119   }
 120
 121   libmemcached_free(ptr, ptr->ketama.continuum);
 122   ptr->ketama.continuum = NULL;
 123
 124   memcached_array_free(ptr->_namespace);
 125   ptr->_namespace = NULL;
 126
 127   memcached_error_free(*ptr);
 128
 129   if (LIBMEMCACHED_WITH_SASL_SUPPORT and ptr->sasl.callbacks) {
 130     memcached_destroy_sasl_auth_data(ptr);
 131   }
 132
 133   if (release_st) {
 134     memcached_array_free(ptr->configure.filename);
 135     ptr->configure.filename = NULL;
 136   }
 137
 138   hashkit_free(&ptr->hashkit);
 139
 140   if (memcached_is_allocated(ptr) and release_st) {
 141     libmemcached_free(ptr, ptr);
 142   }
 143 }
 144
 145 memcached_st *memcached_create(memcached_st *shell) {
 146   if (shell) {
 147     shell->options.is_allocated = false;
 148   } else {
 149     shell = (memcached_st *) libmemcached_xmalloc(NULL, memcached_st);
 150
 151     if (shell == NULL) {
 152       return NULL; /*  MEMCACHED_MEMORY_ALLOCATION_FAILURE */
 153     }
 154
 155     shell->options.is_allocated = true;
 156   }
 157
 158   if (_memcached_init(shell) == false) {
 159     memcached_free(shell);
 160     return NULL;
 161   }
 162
 163   Memcached *memc = memcached2Memcached(shell);
 164   if (memcached_result_create(shell, &memc->result) == NULL) {
 165     memcached_free(shell);
 166     return NULL;
 167   }
 168
 169   WATCHPOINT_ASSERT_INITIALIZED(&memc->result);
 170
 171   return shell;
 172 }
 173
 174 memcached_st *memcached(const char *string, size_t length) {
 175   if (length == 0 and string) {
 176     return NULL;
 177   }
 178
 179   if (length and string == NULL) {
 180     return NULL;
 181   }
 182
 183   if (length == 0) {
 184     if (bool(getenv("LIBMEMCACHED"))) {
 185       string = getenv("LIBMEMCACHED");
 186       length = string ? strlen(string) : 0;
 187     }
 188   }
 189
 190   memcached_st *memc = memcached_create(NULL);
 191   if (memc == NULL) {
 192     return NULL;
 193   }
 194
 195   if (length == 0 or string == NULL) {
 196     return memc;
 197   }
 198
 199   memcached_return_t rc = memcached_parse_configuration(memc, string, length);
 200   if (memcached_success(rc) and memcached_parse_filename(memc)) {
 201     rc = memcached_parse_configure_file(*memc, memcached_parse_filename(memc),
 202                                         memcached_parse_filename_length(memc));
 203   }
 204
 205   if (memcached_failed(rc)) {
 206     memcached_free(memc);
 207     return NULL;
 208   }
 209
 210   return memc;
 211 }
 212
 213 memcached_return_t memcached_reset(memcached_st *shell) {
 214   Memcached *ptr = memcached2Memcached(shell);
 215   WATCHPOINT_ASSERT(ptr);
 216   if (ptr == NULL) {
 217     return MEMCACHED_INVALID_ARGUMENTS;
 218   }
 219
 220   bool stored_is_allocated = memcached_is_allocated(ptr);
 221   uint64_t query_id = ptr->query_id;
 222   __memcached_free(ptr, false);
 223   memcached_create(ptr);
 224   memcached_set_allocated(ptr, stored_is_allocated);
 225   ptr->query_id = query_id;
 226
 227   if (ptr->configure.filename) {
 228     return memcached_parse_configure_file(*ptr, memcached_param_array(ptr->configure.filename));
 229   }
 230
 231   return MEMCACHED_SUCCESS;
 232 }
 233
 234 void memcached_servers_reset(memcached_st *shell) {
 235   Memcached *self = memcached2Memcached(shell);
 236   if (self) {
 237     libmemcached_free(self, self->ketama.continuum);
 238     self->ketama.continuum = NULL;
 239     self->ketama.continuum_count = 0;
 240     self->ketama.continuum_points_counter = 0;
 241
 242     memcached_instance_list_free(memcached_instance_list(self), self->number_of_hosts);
 243     memcached_instance_set(self, NULL, 0);
 244
 245     memcached_reset_last_disconnected_server(self);
 246   }
 247 }
 248
 249 void memcached_reset_last_disconnected_server(memcached_st *shell) {
 250   Memcached *self = memcached2Memcached(shell);
 251   if (self) {
 252     memcached_instance_free((memcached_instance_st *) self->last_disconnected_server);
 253     self->last_disconnected_server = NULL;
 254   }
 255 }
 256
 257 void memcached_free(memcached_st *ptr) {
 258   if (ptr) {
 259     __memcached_free(ptr, true);
 260   }
 261 }
 262
 263 /*
 264   clone is the destination, while source is the structure to clone.
 265   If source is NULL the call is the same as if a memcached_create() was
 266   called.
 267 */
 268 memcached_st *memcached_clone(memcached_st *clone, const memcached_st *source) {
 269   if (source == NULL) {
 270     return memcached_create(clone);
 271   }
 272
 273   if (clone and memcached_is_allocated(clone)) {
 274     return NULL;
 275   }
 276
 277   memcached_st *new_clone = memcached_create(clone);
 278
 279   if (new_clone == NULL) {
 280     return NULL;
 281   }
 282
 283   new_clone->flags = source->flags;
 284   new_clone->send_size = source->send_size;
 285   new_clone->recv_size = source->recv_size;
 286   new_clone->poll_timeout = source->poll_timeout;
 287   new_clone->connect_timeout = source->connect_timeout;
 288   new_clone->retry_timeout = source->retry_timeout;
 289   new_clone->dead_timeout = source->dead_timeout;
 290   new_clone->distribution = source->distribution;
 291
 292   if (hashkit_clone(&new_clone->hashkit, &source->hashkit) == NULL) {
 293     memcached_free(new_clone);
 294     return NULL;
 295   }
 296
 297   new_clone->user_data = source->user_data;
 298
 299   new_clone->snd_timeout = source->snd_timeout;
 300   new_clone->rcv_timeout = source->rcv_timeout;
 301
 302   new_clone->on_clone = source->on_clone;
 303   new_clone->on_cleanup = source->on_cleanup;
 304
 305   new_clone->allocators = source->allocators;
 306
 307   new_clone->get_key_failure = source->get_key_failure;
 308   new_clone->delete_trigger = source->delete_trigger;
 309   new_clone->server_failure_limit = source->server_failure_limit;
 310   new_clone->server_timeout_limit = source->server_timeout_limit;
 311   new_clone->io_msg_watermark = source->io_msg_watermark;
 312   new_clone->io_bytes_watermark = source->io_bytes_watermark;
 313   new_clone->io_key_prefetch = source->io_key_prefetch;
 314   new_clone->number_of_replicas = source->number_of_replicas;
 315   new_clone->tcp_keepidle = source->tcp_keepidle;
 316
 317   if (memcached_server_count(source)) {
 318     if (memcached_failed(memcached_push(new_clone, source))) {
 319       return NULL;
 320     }
 321   }
 322
 323   new_clone->_namespace = memcached_array_clone(new_clone, source->_namespace);
 324   new_clone->configure.filename = memcached_array_clone(new_clone, source->_namespace);
 325   new_clone->configure.version = source->configure.version;
 326
 327   if (LIBMEMCACHED_WITH_SASL_SUPPORT and source->sasl.callbacks) {
 328     if (memcached_failed(memcached_clone_sasl(new_clone, source))) {
 329       memcached_free(new_clone);
 330       return NULL;
 331     }
 332   }
 333
 334   if (memcached_failed(run_distribution(new_clone))) {
 335     memcached_free(new_clone);
 336
 337     return NULL;
 338   }
 339
 340   if (source->on_clone) {
 341     source->on_clone(new_clone, source);
 342   }
 343
 344   return new_clone;
 345 }
 346
 347 void *memcached_get_user_data(const memcached_st *shell) {
 348   const Memcached *memc = memcached2Memcached(shell);
 349   if (memc) {
 350     return memc->user_data;
 351   }
 352
 353   return NULL;
 354 }
 355
 356 void *memcached_set_user_data(memcached_st *shell, void *data) {
 357   Memcached *memc = memcached2Memcached(shell);
 358   if (memc) {
 359     void *ret = memc->user_data;
 360     memc->user_data = data;
 361
 362     return ret;
 363   }
 364
 365   return NULL;
 366 }
 367
 368 memcached_return_t memcached_push(memcached_st *destination, const memcached_st *source) {
 369   return memcached_instance_push(destination, (memcached_instance_st *) source->servers,
 370                                  source->number_of_hosts);
 371 }
 372
 373 memcached_instance_st *memcached_instance_fetch(Memcached *ptr, uint32_t server_key) {
 374   if (ptr == NULL) {
 375     return NULL;
 376   }
 377
 378   return &ptr->servers[server_key];
 379 }
 380
 381 const memcached_instance_st *memcached_server_instance_by_position(const memcached_st *shell,
 382                                                                    uint32_t server_key) {
 383   const Memcached *memc = memcached2Memcached(shell);
 384   if (memc) {
 385     return &memc->servers[server_key];
 386   }
 387
 388   return NULL;
 389 }
 390
 391 memcached_instance_st *memcached_instance_by_position(const memcached_st *shell,
 392                                                       uint32_t server_key) {
 393   const Memcached *memc = memcached2Memcached(shell);
 394   if (memc) {
 395     return &memc->servers[server_key];
 396   }
 397
 398   return NULL;
 399 }
 400
 401 uint64_t memcached_query_id(const memcached_st *shell) {
 402   const Memcached *memc = memcached2Memcached(shell);
 403   if (memc) {
 404     return memc->query_id;
 405   }
 406
 407   return 0;
 408 }
 409
 410 memcached_instance_st *memcached_instance_list(const memcached_st *shell) {
 411   const Memcached *memc = memcached2Memcached(shell);
 412   if (memc) {
 413     return (memcached_instance_st *) memc->servers;
 414   }
 415
 416   return NULL;
 417 }