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

   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 #include <libmemcached/virtual_bucket.h>
  40
  41 static const memcached_st global_copy= {
  42   .state= {
  43     .is_purging= false,
  44     .is_processing_input= false,
  45     .is_time_for_rebuild= false,
  46   },
  47   .flags= {
  48     .auto_eject_hosts= false,
  49     .binary_protocol= false,
  50     .buffer_requests= false,
  51     .hash_with_prefix_key= false,
  52     .no_block= false,
  53     .no_reply= false,
  54     .randomize_replica_read= false,
  55     .support_cas= false,
  56     .tcp_nodelay= false,
  57     .use_sort_hosts= false,
  58     .use_udp= false,
  59     .verify_key= false,
  60     .tcp_keepalive= false,
  61   },
  62 };
  63
  64 static inline bool _memcached_init(memcached_st *self)
  65 {
  66   self->state= global_copy.state;
  67   self->flags= global_copy.flags;
  68   self->virtual_bucket= NULL;
  69
  70   self->distribution= MEMCACHED_DISTRIBUTION_MODULA;
  71
  72   hashkit_st *hash_ptr;
  73   hash_ptr= hashkit_create(&self->hashkit);
  74   if (! hash_ptr)
  75     return false;
  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= 0;
  90   self->query_id= 0;
  91
  92   /* TODO, Document why we picked these defaults */
  93   self->io_msg_watermark= 500;
  94   self->io_bytes_watermark= 65 * 1024;
  95
  96   self->tcp_keepidle= 0;
  97
  98   self->io_key_prefetch= 0;
  99   self->poll_timeout= MEMCACHED_DEFAULT_TIMEOUT;
 100   self->connect_timeout= MEMCACHED_DEFAULT_CONNECT_TIMEOUT;
 101   self->retry_timeout= 0;
 102
 103   self->send_size= -1;
 104   self->recv_size= -1;
 105
 106   self->user_data= NULL;
 107   self->number_of_replicas= 0;
 108   hash_ptr= hashkit_create(&self->distribution_hashkit);
 109   if (! hash_ptr)
 110     return false;
 111
 112   self->allocators= memcached_allocators_return_default();
 113
 114   self->on_clone= NULL;
 115   self->on_cleanup= NULL;
 116   self->get_key_failure= NULL;
 117   self->delete_trigger= NULL;
 118   self->callbacks= NULL;
 119   self->sasl.callbacks= NULL;
 120   self->sasl.is_allocated= false;
 121
 122   self->error_messages= NULL;
 123   self->prefix_key= NULL;
 124   self->configure.initial_pool_size= 1;
 125   self->configure.max_pool_size= 1;
 126   self->configure.version= -1;
 127   self->configure.filename= NULL;
 128
 129   return true;
 130 }
 131
 132 static void _free(memcached_st *ptr, bool release_st)
 133 {
 134   /* If we have anything open, lets close it now */
 135   send_quit(ptr);
 136   memcached_server_list_free(memcached_server_list(ptr));
 137   memcached_result_free(&ptr->result);
 138
 139   memcached_virtual_bucket_free(ptr);
 140
 141   if (ptr->last_disconnected_server)
 142     memcached_server_free(ptr->last_disconnected_server);
 143
 144   if (ptr->on_cleanup)
 145     ptr->on_cleanup(ptr);
 146
 147   if (ptr->ketama.continuum)
 148     libmemcached_free(ptr, ptr->ketama.continuum);
 149
 150   memcached_array_free(ptr->prefix_key);
 151   ptr->prefix_key= NULL;
 152
 153   memcached_error_free(ptr);
 154
 155   if (ptr->sasl.callbacks)
 156   {
 157 #ifdef LIBMEMCACHED_WITH_SASL_SUPPORT
 158     memcached_destroy_sasl_auth_data(ptr);
 159 #endif
 160   }
 161
 162   if (release_st)
 163   {
 164     memcached_array_free(ptr->configure.filename);
 165     ptr->configure.filename= NULL;
 166   }
 167
 168   if (memcached_is_allocated(ptr) && release_st)
 169   {
 170     libmemcached_free(ptr, ptr);
 171   }
 172 }
 173
 174 memcached_st *memcached_create(memcached_st *ptr)
 175 {
 176   if (ptr == NULL)
 177   {
 178     ptr= (memcached_st *)malloc(sizeof(memcached_st));
 179
 180     if (! ptr)
 181     {
 182       return NULL; /*  MEMCACHED_MEMORY_ALLOCATION_FAILURE */
 183     }
 184
 185     ptr->options.is_allocated= true;
 186   }
 187   else
 188   {
 189     ptr->options.is_allocated= false;
 190   }
 191
 192 #if 0
 193   memcached_set_purging(ptr, false);
 194   memcached_set_processing_input(ptr, false);
 195 #endif
 196
 197   if (! _memcached_init(ptr))
 198   {
 199     memcached_free(ptr);
 200     return NULL;
 201   }
 202
 203   if (! memcached_result_create(ptr, &ptr->result))
 204   {
 205     memcached_free(ptr);
 206     return NULL;
 207   }
 208
 209   WATCHPOINT_ASSERT_INITIALIZED(&ptr->result);
 210
 211   return ptr;
 212 }
 213
 214 memcached_st *memcached(const char *string, size_t length)
 215 {
 216   if (! length || ! string)
 217   {
 218     errno= EINVAL;
 219     return NULL;
 220   }
 221
 222   memcached_st *self= memcached_create(NULL);
 223   if (! self)
 224   {
 225     errno= ENOMEM;
 226     return NULL;
 227   }
 228
 229   memcached_return_t rc;
 230   rc= memcached_parse_configuration(self, string, length);
 231
 232   if (rc == MEMCACHED_SUCCESS && memcached_parse_filename(self))
 233   {
 234     rc= memcached_parse_configure_file(self, memcached_parse_filename(self), memcached_parse_filename_length(self));
 235   }
 236
 237   if (rc != MEMCACHED_SUCCESS)
 238   {
 239     memcached_free(self);
 240     errno= EINVAL;
 241     return NULL;
 242   }
 243
 244   errno= 0;
 245
 246   return self;
 247 }
 248
 249 memcached_return_t memcached_reset(memcached_st *ptr)
 250 {
 251   WATCHPOINT_ASSERT(ptr);
 252   if (! ptr)
 253     return MEMCACHED_INVALID_ARGUMENTS;
 254
 255   bool stored_is_allocated= memcached_is_allocated(ptr);
 256   uint64_t query_id= ptr->query_id;
 257   _free(ptr, false);
 258   memcached_create(ptr);
 259   memcached_set_allocated(ptr, stored_is_allocated);
 260   ptr->query_id= query_id;
 261
 262   if (ptr->configure.filename)
 263   {
 264     return memcached_parse_configure_file(ptr, memcached_param_array(ptr->configure.filename));
 265   }
 266
 267   return MEMCACHED_SUCCESS;
 268 }
 269
 270 void memcached_servers_reset(memcached_st *ptr)
 271 {
 272   if (! ptr)
 273     return;
 274
 275   memcached_server_list_free(memcached_server_list(ptr));
 276
 277   memcached_server_list_set(ptr, NULL);
 278   ptr->number_of_hosts= 0;
 279   if (ptr->last_disconnected_server)
 280   {
 281     memcached_server_free(ptr->last_disconnected_server);
 282   }
 283   ptr->last_disconnected_server= NULL;
 284   ptr->server_failure_limit= 0;
 285 }
 286
 287 void memcached_reset_last_disconnected_server(memcached_st *ptr)
 288 {
 289   if (! ptr)
 290     return;
 291
 292   if (ptr->last_disconnected_server)
 293   {
 294     memcached_server_free(ptr->last_disconnected_server);
 295     ptr->last_disconnected_server= NULL;
 296   }
 297 }
 298
 299 void memcached_free(memcached_st *ptr)
 300 {
 301   if (! ptr)
 302     return;
 303
 304   _free(ptr, true);
 305 }
 306
 307 /*
 308   clone is the destination, while source is the structure to clone.
 309   If source is NULL the call is the same as if a memcached_create() was
 310   called.
 311 */
 312 memcached_st *memcached_clone(memcached_st *clone, const memcached_st *source)
 313 {
 314   memcached_return_t rc= MEMCACHED_SUCCESS;
 315   memcached_st *new_clone;
 316
 317   if (source == NULL)
 318     return memcached_create(clone);
 319
 320   if (clone && memcached_is_allocated(clone))
 321   {
 322     return NULL;
 323   }
 324
 325   new_clone= memcached_create(clone);
 326
 327   if (new_clone == NULL)
 328     return NULL;
 329
 330   new_clone->flags= source->flags;
 331   new_clone->send_size= source->send_size;
 332   new_clone->recv_size= source->recv_size;
 333   new_clone->poll_timeout= source->poll_timeout;
 334   new_clone->connect_timeout= source->connect_timeout;
 335   new_clone->retry_timeout= source->retry_timeout;
 336   new_clone->distribution= source->distribution;
 337
 338   hashkit_st *hash_ptr;
 339
 340   hash_ptr= hashkit_clone(&new_clone->hashkit, &source->hashkit);
 341   if (! hash_ptr)
 342   {
 343     memcached_free(new_clone);
 344     return NULL;
 345   }
 346
 347   hash_ptr= hashkit_clone(&new_clone->distribution_hashkit, &source->distribution_hashkit);
 348   if (! hash_ptr)
 349   {
 350     memcached_free(new_clone);
 351     return NULL;
 352   }
 353
 354   new_clone->user_data= source->user_data;
 355
 356   new_clone->snd_timeout= source->snd_timeout;
 357   new_clone->rcv_timeout= source->rcv_timeout;
 358
 359   new_clone->on_clone= source->on_clone;
 360   new_clone->on_cleanup= source->on_cleanup;
 361
 362   new_clone->allocators= source->allocators;
 363
 364   new_clone->get_key_failure= source->get_key_failure;
 365   new_clone->delete_trigger= source->delete_trigger;
 366   new_clone->server_failure_limit= source->server_failure_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     rc= memcached_push(new_clone, source);
 375
 376   if (rc != MEMCACHED_SUCCESS)
 377   {
 378     memcached_free(new_clone);
 379
 380     return NULL;
 381   }
 382
 383
 384   new_clone->prefix_key= memcached_array_clone(new_clone, source->prefix_key);
 385
 386 #ifdef LIBMEMCACHED_WITH_SASL_SUPPORT
 387   if (source->sasl.callbacks)
 388   {
 389     if (memcached_clone_sasl(new_clone, source) != MEMCACHED_SUCCESS)
 390     {
 391       memcached_free(new_clone);
 392       return NULL;
 393     }
 394   }
 395 #endif
 396
 397   rc= run_distribution(new_clone);
 398
 399   if (rc != MEMCACHED_SUCCESS)
 400   {
 401     memcached_free(new_clone);
 402
 403     return NULL;
 404   }
 405
 406   if (source->on_clone)
 407     source->on_clone(new_clone, source);
 408
 409   return new_clone;
 410 }
 411
 412 void *memcached_get_user_data(const memcached_st *ptr)
 413 {
 414   return ptr->user_data;
 415 }
 416
 417 void *memcached_set_user_data(memcached_st *ptr, void *data)
 418 {
 419   void *ret= ptr->user_data;
 420   ptr->user_data= data;
 421
 422   return ret;
 423 }
 424
 425 memcached_return_t memcached_push(memcached_st *destination, const memcached_st *source)
 426 {
 427   return memcached_server_push(destination, source->servers);
 428 }
 429
 430 memcached_server_write_instance_st memcached_server_instance_fetch(memcached_st *ptr, uint32_t server_key)
 431 {
 432   return &ptr->servers[server_key];
 433 }
 434
 435 memcached_server_instance_st memcached_server_instance_by_position(const memcached_st *ptr, uint32_t server_key)
 436 {
 437   return &ptr->servers[server_key];
 438 }