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

   1 /*  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
   2  *
   3  *  Libmemcached library
   4  *
   5  *  Copyright (C) 2011 Data Differential, http://datadifferential.com/
   6  *  Copyright (C) 2006-2009 Brian Aker All rights reserved.
   7  *
   8  *  Redistribution and use in source and binary forms, with or without
   9  *  modification, are permitted provided that the following conditions are
  10  *  met:
  11  *
  12  *      * Redistributions of source code must retain the above copyright
  13  *  notice, this list of conditions and the following disclaimer.
  14  *
  15  *      * Redistributions in binary form must reproduce the above
  16  *  copyright notice, this list of conditions and the following disclaimer
  17  *  in the documentation and/or other materials provided with the
  18  *  distribution.
  19  *
  20  *      * The names of its contributors may not be used to endorse or
  21  *  promote products derived from this software without specific prior
  22  *  written permission.
  23  *
  24  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  26  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  27  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  28  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  29  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  30  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  31  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  32  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  33  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  34  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  35  *
  36  */
  37
  38 #include <libmemcached/common.h>
  39
  40 #include <libmemcached/options.hpp>
  41 #include <libmemcached/virtual_bucket.h>
  42
  43 static inline bool _memcached_init(memcached_st *self)
  44 {
  45   self->state.is_purging= false;
  46   self->state.is_processing_input= false;
  47   self->state.is_time_for_rebuild= false;
  48
  49   self->flags.auto_eject_hosts= false;
  50   self->flags.binary_protocol= false;
  51   self->flags.buffer_requests= false;
  52   self->flags.hash_with_namespace= false;
  53   self->flags.no_block= false;
  54   self->flags.reply= true;
  55   self->flags.randomize_replica_read= false;
  56   self->flags.support_cas= false;
  57   self->flags.tcp_nodelay= false;
  58   self->flags.use_sort_hosts= false;
  59   self->flags.use_udp= false;
  60   self->flags.verify_key= false;
  61   self->flags.tcp_keepalive= false;
  62
  63   self->virtual_bucket= NULL;
  64
  65   self->distribution= MEMCACHED_DISTRIBUTION_MODULA;
  66
  67   if (hashkit_create(&self->hashkit) == NULL)
  68   {
  69     return false;
  70   }
  71
  72   self->server_info.version= 0;
  73
  74   self->ketama.continuum= NULL;
  75   self->ketama.continuum_count= 0;
  76   self->ketama.continuum_points_counter= 0;
  77   self->ketama.next_distribution_rebuild= 0;
  78   self->ketama.weighted= false;
  79
  80   self->number_of_hosts= 0;
  81   self->servers= NULL;
  82   self->last_disconnected_server= NULL;
  83
  84   self->snd_timeout= 0;
  85   self->rcv_timeout= 0;
  86   self->server_failure_limit= MEMCACHED_SERVER_FAILURE_LIMIT;
  87   self->query_id= 1; // 0 is considered invalid
  88
  89   /* TODO, Document why we picked these defaults */
  90   self->io_msg_watermark= 500;
  91   self->io_bytes_watermark= 65 * 1024;
  92
  93   self->tcp_keepidle= 0;
  94
  95   self->io_key_prefetch= 0;
  96   self->poll_timeout= MEMCACHED_DEFAULT_TIMEOUT;
  97   self->connect_timeout= MEMCACHED_DEFAULT_CONNECT_TIMEOUT;
  98   self->retry_timeout= MEMCACHED_SERVER_FAILURE_RETRY_TIMEOUT;
  99   self->dead_timeout= MEMCACHED_SERVER_FAILURE_DEAD_TIMEOUT;
 100
 101   self->send_size= -1;
 102   self->recv_size= -1;
 103
 104   self->user_data= NULL;
 105   self->number_of_replicas= 0;
 106
 107   self->allocators= memcached_allocators_return_default();
 108
 109   self->on_clone= NULL;
 110   self->on_cleanup= NULL;
 111   self->get_key_failure= NULL;
 112   self->delete_trigger= NULL;
 113   self->callbacks= NULL;
 114   self->sasl.callbacks= NULL;
 115   self->sasl.is_allocated= false;
 116
 117   self->error_messages= NULL;
 118   self->_namespace= NULL;
 119   self->configure.initial_pool_size= 1;
 120   self->configure.max_pool_size= 1;
 121   self->configure.version= -1;
 122   self->configure.filename= NULL;
 123
 124   return true;
 125 }
 126
 127 static void __memcached_free(memcached_st *ptr, bool release_st)
 128 {
 129   /* If we have anything open, lets close it now */
 130   send_quit(ptr);
 131   memcached_server_list_free(memcached_server_list(ptr));
 132   memcached_result_free(&ptr->result);
 133
 134   memcached_virtual_bucket_free(ptr);
 135
 136   memcached_server_free(ptr->last_disconnected_server);
 137
 138   if (ptr->on_cleanup)
 139   {
 140     ptr->on_cleanup(ptr);
 141   }
 142
 143   libmemcached_free(ptr, ptr->ketama.continuum);
 144
 145   memcached_array_free(ptr->_namespace);
 146   ptr->_namespace= NULL;
 147
 148   memcached_error_free(*ptr);
 149
 150   if (LIBMEMCACHED_WITH_SASL_SUPPORT and ptr->sasl.callbacks)
 151   {
 152     memcached_destroy_sasl_auth_data(ptr);
 153   }
 154
 155   if (release_st)
 156   {
 157     memcached_array_free(ptr->configure.filename);
 158     ptr->configure.filename= NULL;
 159   }
 160
 161   hashkit_free(&ptr->hashkit);
 162
 163   if (memcached_is_allocated(ptr) and release_st)
 164   {
 165     libmemcached_free(ptr, ptr);
 166   }
 167 }
 168
 169 memcached_st *memcached_create(memcached_st *ptr)
 170 {
 171   if (ptr)
 172   {
 173     ptr->options.is_allocated= false;
 174   }
 175   else
 176   {
 177     ptr= (memcached_st *)libmemcached_xmalloc(NULL, memcached_st);
 178
 179     if (ptr == NULL)
 180     {
 181       return NULL; /*  MEMCACHED_MEMORY_ALLOCATION_FAILURE */
 182     }
 183
 184     ptr->options.is_allocated= true;
 185   }
 186
 187   if (_memcached_init(ptr) == false)
 188   {
 189     memcached_free(ptr);
 190     return NULL;
 191   }
 192
 193   if (memcached_result_create(ptr, &ptr->result) == NULL)
 194   {
 195     memcached_free(ptr);
 196     return NULL;
 197   }
 198
 199   WATCHPOINT_ASSERT_INITIALIZED(&ptr->result);
 200
 201   return ptr;
 202 }
 203
 204 memcached_st *memcached(const char *string, size_t length)
 205 {
 206   if (length == 0 and string)
 207   {
 208     return NULL;
 209   }
 210
 211   if (length and string == NULL)
 212   {
 213     return NULL;
 214   }
 215
 216   if (length == 0)
 217   {
 218     if (bool(getenv("LIBMEMCACHED")))
 219     {
 220       string= getenv("LIBMEMCACHED");
 221       length= string ? strlen(string) : 0;
 222     }
 223   }
 224
 225   memcached_st *memc= memcached_create(NULL);
 226   if (memc == NULL)
 227   {
 228     return NULL;
 229   }
 230
 231   if (length == 0 or string == NULL)
 232   {
 233     return memc;
 234   }
 235
 236   memcached_return_t rc= memcached_parse_configuration(memc, string, length);
 237   if (memcached_success(rc) and memcached_parse_filename(memc))
 238   {
 239     rc= memcached_parse_configure_file(*memc, memcached_parse_filename(memc), memcached_parse_filename_length(memc));
 240   }
 241
 242   if (memcached_failed(rc))
 243   {
 244     memcached_free(memc);
 245     return NULL;
 246   }
 247
 248   return memc;
 249 }
 250
 251 memcached_return_t memcached_reset(memcached_st *ptr)
 252 {
 253   WATCHPOINT_ASSERT(ptr);
 254   if (ptr == NULL)
 255   {
 256     return MEMCACHED_INVALID_ARGUMENTS;
 257   }
 258
 259   bool stored_is_allocated= memcached_is_allocated(ptr);
 260   uint64_t query_id= ptr->query_id;
 261   __memcached_free(ptr, false);
 262   memcached_create(ptr);
 263   memcached_set_allocated(ptr, stored_is_allocated);
 264   ptr->query_id= query_id;
 265
 266   if (ptr->configure.filename)
 267   {
 268     return memcached_parse_configure_file(*ptr, memcached_param_array(ptr->configure.filename));
 269   }
 270
 271   return MEMCACHED_SUCCESS;
 272 }
 273
 274 void memcached_servers_reset(memcached_st *self)
 275 {
 276   if (self)
 277   {
 278     memcached_server_list_free(memcached_server_list(self));
 279
 280     memcached_server_list_set(self, NULL);
 281     self->number_of_hosts= 0;
 282     memcached_server_free(self->last_disconnected_server);
 283     self->last_disconnected_server= NULL;
 284   }
 285 }
 286
 287 void memcached_reset_last_disconnected_server(memcached_st *self)
 288 {
 289   if (self)
 290   {
 291     memcached_server_free(self->last_disconnected_server);
 292     self->last_disconnected_server= NULL;
 293   }
 294 }
 295
 296 void memcached_free(memcached_st *ptr)
 297 {
 298   if (ptr)
 299   {
 300     __memcached_free(ptr, true);
 301   }
 302 }
 303
 304 /*
 305   clone is the destination, while source is the structure to clone.
 306   If source is NULL the call is the same as if a memcached_create() was
 307   called.
 308 */
 309 memcached_st *memcached_clone(memcached_st *clone, const memcached_st *source)
 310 {
 311   if (source == NULL)
 312   {
 313     return memcached_create(clone);
 314   }
 315
 316   if (clone and memcached_is_allocated(clone))
 317   {
 318     return NULL;
 319   }
 320
 321   memcached_st *new_clone= memcached_create(clone);
 322
 323   if (new_clone == NULL)
 324   {
 325     return NULL;
 326   }
 327
 328   new_clone->flags= source->flags;
 329   new_clone->send_size= source->send_size;
 330   new_clone->recv_size= source->recv_size;
 331   new_clone->poll_timeout= source->poll_timeout;
 332   new_clone->connect_timeout= source->connect_timeout;
 333   new_clone->retry_timeout= source->retry_timeout;
 334   new_clone->dead_timeout= source->dead_timeout;
 335   new_clone->distribution= source->distribution;
 336
 337   if (hashkit_clone(&new_clone->hashkit, &source->hashkit) == NULL)
 338   {
 339     memcached_free(new_clone);
 340     return NULL;
 341   }
 342
 343   new_clone->user_data= source->user_data;
 344
 345   new_clone->snd_timeout= source->snd_timeout;
 346   new_clone->rcv_timeout= source->rcv_timeout;
 347
 348   new_clone->on_clone= source->on_clone;
 349   new_clone->on_cleanup= source->on_cleanup;
 350
 351   new_clone->allocators= source->allocators;
 352
 353   new_clone->get_key_failure= source->get_key_failure;
 354   new_clone->delete_trigger= source->delete_trigger;
 355   new_clone->server_failure_limit= source->server_failure_limit;
 356   new_clone->io_msg_watermark= source->io_msg_watermark;
 357   new_clone->io_bytes_watermark= source->io_bytes_watermark;
 358   new_clone->io_key_prefetch= source->io_key_prefetch;
 359   new_clone->number_of_replicas= source->number_of_replicas;
 360   new_clone->tcp_keepidle= source->tcp_keepidle;
 361
 362   if (memcached_server_count(source))
 363   {
 364     if (memcached_failed(memcached_push(new_clone, source)))
 365     {
 366       return NULL;
 367     }
 368   }
 369
 370
 371   new_clone->_namespace= memcached_array_clone(new_clone, source->_namespace);
 372   new_clone->configure.filename= memcached_array_clone(new_clone, source->_namespace);
 373   new_clone->configure.version= source->configure.version;
 374
 375   if (LIBMEMCACHED_WITH_SASL_SUPPORT and source->sasl.callbacks)
 376   {
 377     if (memcached_failed(memcached_clone_sasl(new_clone, source)))
 378     {
 379       memcached_free(new_clone);
 380       return NULL;
 381     }
 382   }
 383
 384   if (memcached_failed(run_distribution(new_clone)))
 385   {
 386     memcached_free(new_clone);
 387
 388     return NULL;
 389   }
 390
 391   if (source->on_clone)
 392   {
 393     source->on_clone(new_clone, source);
 394   }
 395
 396   return new_clone;
 397 }
 398
 399 void *memcached_get_user_data(const memcached_st *ptr)
 400 {
 401   if (ptr == NULL)
 402   {
 403     return NULL;
 404   }
 405
 406   return ptr->user_data;
 407 }
 408
 409 void *memcached_set_user_data(memcached_st *ptr, void *data)
 410 {
 411   if (ptr == NULL)
 412   {
 413     return NULL;
 414   }
 415
 416   void *ret= ptr->user_data;
 417   ptr->user_data= data;
 418
 419   return ret;
 420 }
 421
 422 memcached_return_t memcached_push(memcached_st *destination, const memcached_st *source)
 423 {
 424   return memcached_server_push(destination, source->servers);
 425 }
 426
 427 memcached_server_write_instance_st memcached_server_instance_fetch(memcached_st *ptr, uint32_t server_key)
 428 {
 429   if (ptr == NULL)
 430   {
 431     return NULL;
 432   }
 433
 434   return &ptr->servers[server_key];
 435 }
 436
 437 memcached_server_instance_st memcached_server_instance_by_position(const memcached_st *ptr, uint32_t server_key)
 438 {
 439   if (ptr == NULL)
 440   {
 441     return NULL;
 442   }
 443
 444   return &ptr->servers[server_key];
 445 }
 446
 447 uint64_t memcached_query_id(const memcached_st *self)
 448 {
 449   if (self == NULL)
 450   {
 451     return 0;
 452   }
 453
 454   return self->query_id;
 455 }