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