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

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