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