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