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 _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   if (memcached_is_allocated(ptr) && release_st)
 162   {
 163     libmemcached_free(ptr, ptr);
 164   }
 165 }
 166
 167 memcached_st *memcached_create(memcached_st *ptr)
 168 {
 169   if (ptr)
 170   {
 171     ptr->options.is_allocated= false;
 172   }
 173   else
 174   {
 175     ptr= (memcached_st *)malloc(sizeof(memcached_st));
 176
 177     if (ptr == NULL)
 178     {
 179       return NULL; /*  MEMCACHED_MEMORY_ALLOCATION_FAILURE */
 180     }
 181
 182     ptr->options.is_allocated= true;
 183   }
 184
 185 #if 0
 186   memcached_set_purging(ptr, false);
 187   memcached_set_processing_input(ptr, false);
 188 #endif
 189
 190   if (_memcached_init(ptr) == false)
 191   {
 192     memcached_free(ptr);
 193     return NULL;
 194   }
 195
 196   if (memcached_result_create(ptr, &ptr->result) == NULL)
 197   {
 198     memcached_free(ptr);
 199     return NULL;
 200   }
 201
 202   WATCHPOINT_ASSERT_INITIALIZED(&ptr->result);
 203
 204   return ptr;
 205 }
 206
 207 memcached_st *memcached(const char *string, size_t length)
 208 {
 209   memcached_st *self= memcached_create(NULL);
 210   if (self == NULL)
 211   {
 212     return NULL;
 213   }
 214
 215   if (length == 0)
 216   {
 217     return self;
 218   }
 219
 220   memcached_return_t rc= memcached_parse_configuration(self, string, length);
 221   if (memcached_success(rc) and memcached_parse_filename(self))
 222   {
 223     rc= memcached_parse_configure_file(*self, memcached_parse_filename(self), memcached_parse_filename_length(self));
 224   }
 225
 226   if (memcached_failed(rc))
 227   {
 228     memcached_free(self);
 229     return NULL;
 230   }
 231
 232   return self;
 233 }
 234
 235 memcached_return_t memcached_reset(memcached_st *ptr)
 236 {
 237   WATCHPOINT_ASSERT(ptr);
 238   if (ptr == NULL)
 239   {
 240     return MEMCACHED_INVALID_ARGUMENTS;
 241   }
 242
 243   bool stored_is_allocated= memcached_is_allocated(ptr);
 244   uint64_t query_id= ptr->query_id;
 245   _free(ptr, false);
 246   memcached_create(ptr);
 247   memcached_set_allocated(ptr, stored_is_allocated);
 248   ptr->query_id= query_id;
 249
 250   if (ptr->configure.filename)
 251   {
 252     return memcached_parse_configure_file(*ptr, memcached_param_array(ptr->configure.filename));
 253   }
 254
 255   return MEMCACHED_SUCCESS;
 256 }
 257
 258 void memcached_servers_reset(memcached_st *self)
 259 {
 260   if (self)
 261   {
 262     memcached_server_list_free(memcached_server_list(self));
 263
 264     memcached_server_list_set(self, NULL);
 265     self->number_of_hosts= 0;
 266     memcached_server_free(self->last_disconnected_server);
 267     self->last_disconnected_server= NULL;
 268   }
 269 }
 270
 271 void memcached_reset_last_disconnected_server(memcached_st *self)
 272 {
 273   if (self)
 274   {
 275     memcached_server_free(self->last_disconnected_server);
 276     self->last_disconnected_server= NULL;
 277   }
 278 }
 279
 280 void memcached_free(memcached_st *ptr)
 281 {
 282   if (ptr)
 283   {
 284     _free(ptr, true);
 285   }
 286 }
 287
 288 /*
 289   clone is the destination, while source is the structure to clone.
 290   If source is NULL the call is the same as if a memcached_create() was
 291   called.
 292 */
 293 memcached_st *memcached_clone(memcached_st *clone, const memcached_st *source)
 294 {
 295   if (source == NULL)
 296   {
 297     return memcached_create(clone);
 298   }
 299
 300   if (clone and memcached_is_allocated(clone))
 301   {
 302     return NULL;
 303   }
 304
 305   memcached_st *new_clone= memcached_create(clone);
 306
 307   if (new_clone == NULL)
 308   {
 309     return NULL;
 310   }
 311
 312   new_clone->flags= source->flags;
 313   new_clone->send_size= source->send_size;
 314   new_clone->recv_size= source->recv_size;
 315   new_clone->poll_timeout= source->poll_timeout;
 316   new_clone->connect_timeout= source->connect_timeout;
 317   new_clone->retry_timeout= source->retry_timeout;
 318   new_clone->dead_timeout= source->dead_timeout;
 319   new_clone->distribution= source->distribution;
 320
 321   if (hashkit_clone(&new_clone->hashkit, &source->hashkit) == NULL)
 322   {
 323     memcached_free(new_clone);
 324     return NULL;
 325   }
 326
 327   new_clone->user_data= source->user_data;
 328
 329   new_clone->snd_timeout= source->snd_timeout;
 330   new_clone->rcv_timeout= source->rcv_timeout;
 331
 332   new_clone->on_clone= source->on_clone;
 333   new_clone->on_cleanup= source->on_cleanup;
 334
 335   new_clone->allocators= source->allocators;
 336
 337   new_clone->get_key_failure= source->get_key_failure;
 338   new_clone->delete_trigger= source->delete_trigger;
 339   new_clone->server_failure_limit= source->server_failure_limit;
 340   new_clone->io_msg_watermark= source->io_msg_watermark;
 341   new_clone->io_bytes_watermark= source->io_bytes_watermark;
 342   new_clone->io_key_prefetch= source->io_key_prefetch;
 343   new_clone->number_of_replicas= source->number_of_replicas;
 344   new_clone->tcp_keepidle= source->tcp_keepidle;
 345
 346   if (memcached_server_count(source))
 347   {
 348     if (memcached_failed(memcached_push(new_clone, source)))
 349     {
 350       return NULL;
 351     }
 352   }
 353
 354
 355   new_clone->_namespace= memcached_array_clone(new_clone, source->_namespace);
 356   new_clone->configure.filename= memcached_array_clone(new_clone, source->_namespace);
 357   new_clone->configure.version= source->configure.version;
 358
 359   if (LIBMEMCACHED_WITH_SASL_SUPPORT and source->sasl.callbacks)
 360   {
 361     if (memcached_failed(memcached_clone_sasl(new_clone, source)))
 362     {
 363       memcached_free(new_clone);
 364       return NULL;
 365     }
 366   }
 367
 368   if (memcached_failed(run_distribution(new_clone)))
 369   {
 370     memcached_free(new_clone);
 371
 372     return NULL;
 373   }
 374
 375   if (source->on_clone)
 376   {
 377     source->on_clone(new_clone, source);
 378   }
 379
 380   return new_clone;
 381 }
 382
 383 void *memcached_get_user_data(const memcached_st *ptr)
 384 {
 385   return ptr->user_data;
 386 }
 387
 388 void *memcached_set_user_data(memcached_st *ptr, void *data)
 389 {
 390   void *ret= ptr->user_data;
 391   ptr->user_data= data;
 392
 393   return ret;
 394 }
 395
 396 memcached_return_t memcached_push(memcached_st *destination, const memcached_st *source)
 397 {
 398   return memcached_server_push(destination, source->servers);
 399 }
 400
 401 memcached_server_write_instance_st memcached_server_instance_fetch(memcached_st *ptr, uint32_t server_key)
 402 {
 403   return &ptr->servers[server_key];
 404 }
 405
 406 memcached_server_instance_st memcached_server_instance_by_position(const memcached_st *ptr, uint32_t server_key)
 407 {
 408   return &ptr->servers[server_key];
 409 }
 410
 411 uint64_t memcached_query_id(const memcached_st *self)
 412 {
 413   if (not self)
 414     return 0;
 415
 416   return self->query_id;
 417 }