git.m6w6.name Git - awesomized/libmemcached/blob - libmemcached/behavior.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 #include <libmemcached/options.hpp>
  40 #include <libmemcached/virtual_bucket.h>
  41
  42 #include <ctime>
  43 #include <sys/types.h>
  44
  45 bool memcached_is_consistent_distribution(const Memcached* memc)
  46 {
  47   switch (memc->distribution)
  48   {
  49   case MEMCACHED_DISTRIBUTION_CONSISTENT:
  50   case MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA:
  51   case MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA_SPY:
  52   case MEMCACHED_DISTRIBUTION_CONSISTENT_WEIGHTED:
  53     return true;
  54
  55   case MEMCACHED_DISTRIBUTION_MODULA:
  56   case MEMCACHED_DISTRIBUTION_RANDOM:
  57   case MEMCACHED_DISTRIBUTION_VIRTUAL_BUCKET:
  58   case MEMCACHED_DISTRIBUTION_CONSISTENT_MAX:
  59     break;
  60   }
  61
  62   return false;
  63 }
  64
  65 /*
  66   This function is used to modify the behavior of running client.
  67
  68   We quit all connections so we can reset the sockets.
  69 */
  70
  71 memcached_return_t memcached_behavior_set(memcached_st *shell,
  72                                           const memcached_behavior_t flag,
  73                                           uint64_t data)
  74 {
  75   Memcached* ptr= memcached2Memcached(shell);
  76   if (ptr == NULL)
  77   {
  78     return MEMCACHED_INVALID_ARGUMENTS;
  79   }
  80
  81   switch (flag)
  82   {
  83   case MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS:
  84     ptr->number_of_replicas= (uint32_t)data;
  85     break;
  86
  87   case MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK:
  88     ptr->io_msg_watermark= (uint32_t) data;
  89     break;
  90
  91   case MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK:
  92     ptr->io_bytes_watermark= (uint32_t)data;
  93     break;
  94
  95   case MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH:
  96     ptr->io_key_prefetch = (uint32_t)data;
  97     break;
  98
  99   case MEMCACHED_BEHAVIOR_SND_TIMEOUT:
 100     ptr->snd_timeout= (int32_t)data;
 101     break;
 102
 103   case MEMCACHED_BEHAVIOR_RCV_TIMEOUT:
 104     ptr->rcv_timeout= (int32_t)data;
 105     break;
 106
 107   case MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS:
 108     ptr->flags.auto_eject_hosts= bool(data);
 109
 110   case MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT:
 111     if (data == 0)
 112     {
 113       return memcached_set_error(*ptr, MEMCACHED_INVALID_ARGUMENTS, MEMCACHED_AT,
 114                                         memcached_literal_param("MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT requires a value greater then zero."));
 115     }
 116     ptr->server_failure_limit= uint32_t(data);
 117     break;
 118
 119   case MEMCACHED_BEHAVIOR_BINARY_PROTOCOL:
 120     send_quit(ptr); // We need t shutdown all of the connections to make sure we do the correct protocol
 121     if (data)
 122     {
 123       ptr->flags.verify_key= false;
 124     }
 125     ptr->flags.binary_protocol= bool(data);
 126     break;
 127
 128   case MEMCACHED_BEHAVIOR_SUPPORT_CAS:
 129     ptr->flags.support_cas= bool(data);
 130     break;
 131
 132   case MEMCACHED_BEHAVIOR_NO_BLOCK:
 133     ptr->flags.no_block= bool(data);
 134     send_quit(ptr);
 135     break;
 136
 137   case MEMCACHED_BEHAVIOR_BUFFER_REQUESTS:
 138     if (memcached_is_udp(ptr))
 139     {
 140       return memcached_set_error(*ptr, MEMCACHED_INVALID_ARGUMENTS, MEMCACHED_AT,
 141                                  memcached_literal_param("MEMCACHED_BEHAVIOR_BUFFER_REQUESTS cannot be set while MEMCACHED_BEHAVIOR_USE_UDP is enabled."));
 142     }
 143     ptr->flags.buffer_requests= bool(data);
 144     send_quit(ptr);
 145     break;
 146
 147   case MEMCACHED_BEHAVIOR_USE_UDP:
 148     send_quit(ptr); // We need t shutdown all of the connections to make sure we do the correct protocol
 149     ptr->flags.use_udp= bool(data);
 150     if (bool(data))
 151     {
 152       ptr->flags.reply= false;
 153       ptr->flags.buffer_requests= false;
 154     }
 155     else
 156     {
 157       ptr->flags.reply= true;
 158     }
 159     break;
 160
 161   case MEMCACHED_BEHAVIOR_TCP_NODELAY:
 162     ptr->flags.tcp_nodelay= bool(data);
 163     send_quit(ptr);
 164     break;
 165
 166   case MEMCACHED_BEHAVIOR_TCP_KEEPALIVE:
 167     ptr->flags.tcp_keepalive= bool(data);
 168     send_quit(ptr);
 169     break;
 170
 171   case MEMCACHED_BEHAVIOR_DISTRIBUTION:
 172     return memcached_behavior_set_distribution(ptr, (memcached_server_distribution_t)data);
 173
 174   case MEMCACHED_BEHAVIOR_KETAMA:
 175     {
 176       if (data) // Turn on
 177       {
 178         return memcached_behavior_set_distribution(ptr, MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA);
 179       }
 180
 181       return memcached_behavior_set_distribution(ptr, MEMCACHED_DISTRIBUTION_MODULA);
 182     }
 183
 184   case MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED:
 185     {
 186       if (bool(data) == false)
 187       {
 188         return memcached_behavior_set(ptr, MEMCACHED_BEHAVIOR_KETAMA, true);
 189       }
 190
 191       (void)memcached_behavior_set_key_hash(ptr, MEMCACHED_HASH_MD5);
 192       (void)memcached_behavior_set_distribution_hash(ptr, MEMCACHED_HASH_MD5);
 193       /**
 194         @note We try to keep the same distribution going. This should be deprecated and rewritten.
 195       */
 196       return memcached_behavior_set_distribution(ptr, MEMCACHED_DISTRIBUTION_CONSISTENT_WEIGHTED);
 197     }
 198
 199   case MEMCACHED_BEHAVIOR_HASH:
 200     return memcached_behavior_set_key_hash(ptr, (memcached_hash_t)(data));
 201
 202   case MEMCACHED_BEHAVIOR_KETAMA_HASH:
 203     return memcached_behavior_set_distribution_hash(ptr, (memcached_hash_t)(data));
 204
 205   case MEMCACHED_BEHAVIOR_CACHE_LOOKUPS:
 206     return memcached_set_error(*ptr, MEMCACHED_DEPRECATED, MEMCACHED_AT,
 207                                       memcached_literal_param("MEMCACHED_BEHAVIOR_CACHE_LOOKUPS has been deprecated."));
 208
 209   case MEMCACHED_BEHAVIOR_VERIFY_KEY:
 210     if (ptr->flags.binary_protocol)
 211     {
 212       return memcached_set_error(*ptr, MEMCACHED_INVALID_ARGUMENTS, MEMCACHED_AT,
 213                                         memcached_literal_param("MEMCACHED_BEHAVIOR_VERIFY_KEY if the binary protocol has been enabled."));
 214     }
 215     ptr->flags.verify_key= bool(data);
 216     break;
 217
 218   case MEMCACHED_BEHAVIOR_SORT_HOSTS:
 219     {
 220       ptr->flags.use_sort_hosts= bool(data);
 221       return run_distribution(ptr);
 222     }
 223
 224   case MEMCACHED_BEHAVIOR_POLL_TIMEOUT:
 225     ptr->poll_timeout= (int32_t)data;
 226     break;
 227
 228   case MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT:
 229     ptr->connect_timeout= (int32_t)data;
 230     break;
 231
 232   case MEMCACHED_BEHAVIOR_RETRY_TIMEOUT:
 233     if (data == 0)
 234     {
 235       return memcached_set_error(*ptr, MEMCACHED_INVALID_ARGUMENTS, MEMCACHED_AT,
 236                                         memcached_literal_param("MEMCACHED_BEHAVIOR_RETRY_TIMEOUT requires a value greater then zero."));
 237     }
 238     ptr->retry_timeout= int32_t(data);
 239     break;
 240
 241   case MEMCACHED_BEHAVIOR_DEAD_TIMEOUT:
 242     ptr->dead_timeout= int32_t(data);
 243     break;
 244
 245   case MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE:
 246     ptr->send_size= (int32_t)data;
 247     send_quit(ptr);
 248     break;
 249
 250   case MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE:
 251     ptr->recv_size= (int32_t)data;
 252     send_quit(ptr);
 253     break;
 254
 255   case MEMCACHED_BEHAVIOR_TCP_KEEPIDLE:
 256     ptr->tcp_keepidle= (uint32_t)data;
 257     send_quit(ptr);
 258     break;
 259
 260   case MEMCACHED_BEHAVIOR_USER_DATA:
 261     return memcached_set_error(*ptr, MEMCACHED_DEPRECATED, MEMCACHED_AT,
 262                                memcached_literal_param("MEMCACHED_BEHAVIOR_USER_DATA deprecated."));
 263
 264   case MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY:
 265     ptr->flags.hash_with_namespace= bool(data);
 266     break;
 267
 268   case MEMCACHED_BEHAVIOR_NOREPLY:
 269     if (memcached_is_udp(ptr) and bool(data) == false)
 270     {
 271       return memcached_set_error(*ptr, MEMCACHED_INVALID_ARGUMENTS, MEMCACHED_AT,
 272                                  memcached_literal_param("MEMCACHED_BEHAVIOR_NOREPLY cannot be disabled while MEMCACHED_BEHAVIOR_USE_UDP is enabled."));
 273     }
 274     // We reverse the logic here to make it easier to understand throughout the
 275     // code.
 276     ptr->flags.reply= bool(data) ? false : true;
 277     break;
 278
 279   case MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS:
 280     ptr->flags.auto_eject_hosts= bool(data);
 281     break;
 282
 283   case MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ:
 284       srandom((uint32_t) time(NULL));
 285       ptr->flags.randomize_replica_read= bool(data);
 286       break;
 287
 288   case MEMCACHED_BEHAVIOR_CORK:
 289       return memcached_set_error(*ptr, MEMCACHED_DEPRECATED, MEMCACHED_AT,
 290                                  memcached_literal_param("MEMCACHED_BEHAVIOR_CORK is now incorporated into the driver by default."));
 291
 292   case MEMCACHED_BEHAVIOR_LOAD_FROM_FILE:
 293       return memcached_set_error(*ptr, MEMCACHED_INVALID_ARGUMENTS, MEMCACHED_AT,
 294                                  memcached_literal_param("MEMCACHED_BEHAVIOR_LOAD_FROM_FILE can not be set with memcached_behavior_set()"));
 295
 296   case MEMCACHED_BEHAVIOR_MAX:
 297   default:
 298       /* Shouldn't get here */
 299       assert_msg(0, "Invalid behavior passed to memcached_behavior_set()");
 300       return memcached_set_error(*ptr, MEMCACHED_INVALID_ARGUMENTS, MEMCACHED_AT,
 301                                  memcached_literal_param("Invalid behavior passed to memcached_behavior_set()"));
 302   }
 303
 304   return MEMCACHED_SUCCESS;
 305 }
 306
 307 bool _is_auto_eject_host(const memcached_st *ptr)
 308 {
 309   return ptr->flags.auto_eject_hosts;
 310 }
 311
 312 uint64_t memcached_behavior_get(memcached_st *shell,
 313                                 const memcached_behavior_t flag)
 314 {
 315   Memcached* ptr= memcached2Memcached(shell);
 316   if (ptr == NULL)
 317   {
 318     return MEMCACHED_INVALID_ARGUMENTS;
 319   }
 320
 321   switch (flag)
 322   {
 323   case MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS:
 324     return ptr->number_of_replicas;
 325
 326   case MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK:
 327     return ptr->io_msg_watermark;
 328
 329   case MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK:
 330     return ptr->io_bytes_watermark;
 331
 332   case MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH:
 333     return ptr->io_key_prefetch;
 334
 335   case MEMCACHED_BEHAVIOR_BINARY_PROTOCOL:
 336     return ptr->flags.binary_protocol;
 337
 338   case MEMCACHED_BEHAVIOR_SUPPORT_CAS:
 339     return ptr->flags.support_cas;
 340
 341   case MEMCACHED_BEHAVIOR_CACHE_LOOKUPS:
 342     return true;
 343
 344   case MEMCACHED_BEHAVIOR_NO_BLOCK:
 345     return ptr->flags.no_block;
 346
 347   case MEMCACHED_BEHAVIOR_BUFFER_REQUESTS:
 348     return ptr->flags.buffer_requests;
 349
 350   case MEMCACHED_BEHAVIOR_USE_UDP:
 351     return memcached_is_udp(ptr);
 352
 353   case MEMCACHED_BEHAVIOR_TCP_NODELAY:
 354     return ptr->flags.tcp_nodelay;
 355
 356   case MEMCACHED_BEHAVIOR_VERIFY_KEY:
 357     return ptr->flags.verify_key;
 358
 359   case MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED:
 360     if (memcached_is_consistent_distribution(ptr))
 361     {
 362       return memcached_is_weighted_ketama(ptr);
 363     }
 364     return false;
 365
 366   case MEMCACHED_BEHAVIOR_DISTRIBUTION:
 367     return ptr->distribution;
 368
 369   case MEMCACHED_BEHAVIOR_KETAMA:
 370     return memcached_is_consistent_distribution(ptr);
 371
 372   case MEMCACHED_BEHAVIOR_HASH:
 373     return hashkit_get_function(&ptr->hashkit);
 374
 375   case MEMCACHED_BEHAVIOR_KETAMA_HASH:
 376     return hashkit_get_function(&ptr->hashkit);
 377
 378   case MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS:
 379   case MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT:
 380     return ptr->server_failure_limit;
 381
 382   case MEMCACHED_BEHAVIOR_SORT_HOSTS:
 383     return ptr->flags.use_sort_hosts;
 384
 385   case MEMCACHED_BEHAVIOR_POLL_TIMEOUT:
 386     return (uint64_t)ptr->poll_timeout;
 387
 388   case MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT:
 389     return (uint64_t)ptr->connect_timeout;
 390
 391   case MEMCACHED_BEHAVIOR_RETRY_TIMEOUT:
 392     return (uint64_t)ptr->retry_timeout;
 393
 394   case MEMCACHED_BEHAVIOR_DEAD_TIMEOUT:
 395     return uint64_t(ptr->dead_timeout);
 396
 397   case MEMCACHED_BEHAVIOR_SND_TIMEOUT:
 398     return (uint64_t)ptr->snd_timeout;
 399
 400   case MEMCACHED_BEHAVIOR_RCV_TIMEOUT:
 401     return (uint64_t)ptr->rcv_timeout;
 402
 403   case MEMCACHED_BEHAVIOR_TCP_KEEPIDLE:
 404     return (uint64_t)ptr->tcp_keepidle;
 405
 406   case MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE:
 407     {
 408       int sock_size= 0;
 409       socklen_t sock_length= sizeof(int);
 410
 411       if (ptr->send_size != -1) // If value is -1 then we are using the default
 412       {
 413         return (uint64_t) ptr->send_size;
 414       }
 415
 416       org::libmemcached::Instance* instance= memcached_instance_fetch(ptr, 0);
 417
 418       if (instance) // If we have an instance we test, otherwise we just set and pray
 419       {
 420         /* REFACTOR */
 421         /* We just try the first host, and if it is down we return zero */
 422         if (memcached_failed(memcached_connect(instance)))
 423         {
 424           return 0;
 425         }
 426
 427         if (memcached_failed(memcached_io_wait_for_write(instance)))
 428         {
 429           return 0;
 430         }
 431
 432         if (getsockopt(instance->fd, SOL_SOCKET, SO_SNDBUF, (char*)&sock_size, &sock_length) < 0)
 433         {
 434           memcached_set_errno(*ptr, get_socket_errno(), MEMCACHED_AT);
 435           return 0; /* Zero means error */
 436         }
 437       }
 438
 439       return (uint64_t) sock_size;
 440     }
 441
 442   case MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE:
 443     {
 444       int sock_size= 0;
 445       socklen_t sock_length= sizeof(int);
 446
 447       if (ptr->recv_size != -1) // If value is -1 then we are using the default
 448         return (uint64_t) ptr->recv_size;
 449
 450       org::libmemcached::Instance* instance= memcached_instance_fetch(ptr, 0);
 451
 452       /**
 453         @note REFACTOR
 454       */
 455       if (instance)
 456       {
 457         /* We just try the first host, and if it is down we return zero */
 458         if (memcached_failed(memcached_connect(instance)))
 459         {
 460           return 0;
 461         }
 462
 463         if (memcached_failed(memcached_io_wait_for_write(instance)))
 464         {
 465           return 0;
 466         }
 467
 468         if (getsockopt(instance->fd, SOL_SOCKET, SO_RCVBUF, (char*)&sock_size, &sock_length) < 0)
 469         {
 470           memcached_set_errno(*ptr, get_socket_errno(), MEMCACHED_AT);
 471           return 0; /* Zero means error */
 472         }
 473       }
 474
 475       return (uint64_t) sock_size;
 476     }
 477
 478   case MEMCACHED_BEHAVIOR_USER_DATA:
 479     memcached_set_error(*ptr, MEMCACHED_DEPRECATED, MEMCACHED_AT,
 480                         memcached_literal_param("MEMCACHED_BEHAVIOR_USER_DATA deprecated."));
 481     return 0;
 482
 483   case MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY:
 484     return ptr->flags.hash_with_namespace;
 485
 486   case MEMCACHED_BEHAVIOR_NOREPLY:
 487     return ptr->flags.reply ? false : true;
 488
 489   case MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS:
 490     return ptr->flags.auto_eject_hosts;
 491
 492   case MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ:
 493     return ptr->flags.randomize_replica_read;
 494
 495   case MEMCACHED_BEHAVIOR_CORK:
 496 #ifdef HAVE_MSG_MORE
 497     return true;
 498 #else
 499     return false;
 500 #endif
 501
 502   case MEMCACHED_BEHAVIOR_TCP_KEEPALIVE:
 503     return ptr->flags.tcp_keepalive;
 504
 505   case MEMCACHED_BEHAVIOR_LOAD_FROM_FILE:
 506     return bool(memcached_parse_filename(ptr));
 507
 508   case MEMCACHED_BEHAVIOR_MAX:
 509   default:
 510     assert_msg(0, "Invalid behavior passed to memcached_behavior_get()");
 511     return 0;
 512   }
 513
 514   /* NOTREACHED */
 515 }
 516
 517
 518 memcached_return_t memcached_behavior_set_distribution(memcached_st *shell, memcached_server_distribution_t type)
 519 {
 520   Memcached* ptr= memcached2Memcached(shell);
 521   if (ptr)
 522   {
 523     switch (type)
 524     {
 525     case MEMCACHED_DISTRIBUTION_MODULA:
 526       break;
 527
 528     case MEMCACHED_DISTRIBUTION_CONSISTENT:
 529     case MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA:
 530       memcached_set_weighted_ketama(ptr, false);
 531       break;
 532
 533     case MEMCACHED_DISTRIBUTION_RANDOM:
 534       break;
 535
 536     case MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA_SPY:
 537       break;
 538
 539     case MEMCACHED_DISTRIBUTION_CONSISTENT_WEIGHTED:
 540       memcached_set_weighted_ketama(ptr, true);
 541       break;
 542
 543     case MEMCACHED_DISTRIBUTION_VIRTUAL_BUCKET:
 544       break;
 545
 546     default:
 547     case MEMCACHED_DISTRIBUTION_CONSISTENT_MAX:
 548       return memcached_set_error(*ptr, MEMCACHED_INVALID_ARGUMENTS, MEMCACHED_AT,
 549                                  memcached_literal_param("Invalid memcached_server_distribution_t"));
 550     }
 551     ptr->distribution= type;
 552
 553     return run_distribution(ptr);
 554   }
 555
 556   return MEMCACHED_INVALID_ARGUMENTS;
 557 }
 558
 559
 560 memcached_server_distribution_t memcached_behavior_get_distribution(memcached_st *shell)
 561 {
 562   Memcached* ptr= memcached2Memcached(shell);
 563   if (ptr)
 564   {
 565     return ptr->distribution;
 566   }
 567
 568   return MEMCACHED_DISTRIBUTION_CONSISTENT_MAX;
 569 }
 570
 571 memcached_return_t memcached_behavior_set_key_hash(memcached_st *shell, memcached_hash_t type)
 572 {
 573   Memcached* ptr= memcached2Memcached(shell);
 574   if (ptr)
 575   {
 576     if (hashkit_success(hashkit_set_function(&ptr->hashkit, (hashkit_hash_algorithm_t)type)))
 577     {
 578       return MEMCACHED_SUCCESS;
 579     }
 580
 581     return memcached_set_error(*ptr, MEMCACHED_INVALID_ARGUMENTS, MEMCACHED_AT,
 582                                memcached_literal_param("Invalid memcached_hash_t()"));
 583   }
 584
 585   return MEMCACHED_INVALID_ARGUMENTS;
 586 }
 587
 588 memcached_hash_t memcached_behavior_get_key_hash(memcached_st *shell)
 589 {
 590   Memcached* ptr= memcached2Memcached(shell);
 591   if (ptr)
 592   {
 593     return (memcached_hash_t)hashkit_get_function(&ptr->hashkit);
 594   }
 595
 596   return MEMCACHED_HASH_MAX;
 597 }
 598
 599 memcached_return_t memcached_behavior_set_distribution_hash(memcached_st *shell, memcached_hash_t type)
 600 {
 601   Memcached* ptr= memcached2Memcached(shell);
 602   if (ptr)
 603   {
 604     if (hashkit_success(hashkit_set_distribution_function(&ptr->hashkit, (hashkit_hash_algorithm_t)type)))
 605     {
 606       return MEMCACHED_SUCCESS;
 607     }
 608
 609     return memcached_set_error(*ptr, MEMCACHED_INVALID_ARGUMENTS, MEMCACHED_AT,
 610                                memcached_literal_param("Invalid memcached_hash_t()"));
 611   }
 612
 613   return MEMCACHED_INVALID_ARGUMENTS;
 614 }
 615
 616 memcached_hash_t memcached_behavior_get_distribution_hash(memcached_st *shell)
 617 {
 618   Memcached* ptr= memcached2Memcached(shell);
 619   if (ptr)
 620   {
 621     return (memcached_hash_t)hashkit_get_function(&ptr->hashkit);
 622   }
 623
 624   return MEMCACHED_HASH_MAX;
 625 }
 626
 627 const char *libmemcached_string_behavior(const memcached_behavior_t flag)
 628 {
 629   switch (flag)
 630   {
 631   case MEMCACHED_BEHAVIOR_NO_BLOCK: return "MEMCACHED_BEHAVIOR_NO_BLOCK";
 632   case MEMCACHED_BEHAVIOR_TCP_NODELAY: return "MEMCACHED_BEHAVIOR_TCP_NODELAY";
 633   case MEMCACHED_BEHAVIOR_HASH: return "MEMCACHED_BEHAVIOR_HASH";
 634   case MEMCACHED_BEHAVIOR_KETAMA: return "MEMCACHED_BEHAVIOR_KETAMA";
 635   case MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE: return "MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE";
 636   case MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE: return "MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE";
 637   case MEMCACHED_BEHAVIOR_CACHE_LOOKUPS: return "MEMCACHED_BEHAVIOR_CACHE_LOOKUPS";
 638   case MEMCACHED_BEHAVIOR_SUPPORT_CAS: return "MEMCACHED_BEHAVIOR_SUPPORT_CAS";
 639   case MEMCACHED_BEHAVIOR_POLL_TIMEOUT: return "MEMCACHED_BEHAVIOR_POLL_TIMEOUT";
 640   case MEMCACHED_BEHAVIOR_DISTRIBUTION: return "MEMCACHED_BEHAVIOR_DISTRIBUTION";
 641   case MEMCACHED_BEHAVIOR_BUFFER_REQUESTS: return "MEMCACHED_BEHAVIOR_BUFFER_REQUESTS";
 642   case MEMCACHED_BEHAVIOR_USER_DATA: return "MEMCACHED_BEHAVIOR_USER_DATA";
 643   case MEMCACHED_BEHAVIOR_SORT_HOSTS: return "MEMCACHED_BEHAVIOR_SORT_HOSTS";
 644   case MEMCACHED_BEHAVIOR_VERIFY_KEY: return "MEMCACHED_BEHAVIOR_VERIFY_KEY";
 645   case MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT: return "MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT";
 646   case MEMCACHED_BEHAVIOR_RETRY_TIMEOUT: return "MEMCACHED_BEHAVIOR_RETRY_TIMEOUT";
 647   case MEMCACHED_BEHAVIOR_DEAD_TIMEOUT: return "MEMCACHED_BEHAVIOR_DEAD_TIMEOUT";
 648   case MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED: return "MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED";
 649   case MEMCACHED_BEHAVIOR_KETAMA_HASH: return "MEMCACHED_BEHAVIOR_KETAMA_HASH";
 650   case MEMCACHED_BEHAVIOR_BINARY_PROTOCOL: return "MEMCACHED_BEHAVIOR_BINARY_PROTOCOL";
 651   case MEMCACHED_BEHAVIOR_SND_TIMEOUT: return "MEMCACHED_BEHAVIOR_SND_TIMEOUT";
 652   case MEMCACHED_BEHAVIOR_RCV_TIMEOUT: return "MEMCACHED_BEHAVIOR_RCV_TIMEOUT";
 653   case MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT: return "MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT";
 654   case MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK: return "MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK";
 655   case MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK: return "MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK";
 656   case MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH: return "MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH";
 657   case MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY: return "MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY";
 658   case MEMCACHED_BEHAVIOR_NOREPLY: return "MEMCACHED_BEHAVIOR_NOREPLY";
 659   case MEMCACHED_BEHAVIOR_USE_UDP: return "MEMCACHED_BEHAVIOR_USE_UDP";
 660   case MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS: return "MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS";
 661   case MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS: return "MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS";
 662   case MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS: return "MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS";
 663   case MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ: return "MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ";
 664   case MEMCACHED_BEHAVIOR_CORK: return "MEMCACHED_BEHAVIOR_CORK";
 665   case MEMCACHED_BEHAVIOR_TCP_KEEPALIVE: return "MEMCACHED_BEHAVIOR_TCP_KEEPALIVE";
 666   case MEMCACHED_BEHAVIOR_TCP_KEEPIDLE: return "MEMCACHED_BEHAVIOR_TCP_KEEPIDLE";
 667   case MEMCACHED_BEHAVIOR_LOAD_FROM_FILE: return "MEMCACHED_BEHAVIOR_LOAD_FROM_FILE";
 668   default:
 669   case MEMCACHED_BEHAVIOR_MAX: return "INVALID memcached_behavior_t";
 670   }
 671 }
 672
 673 const char *libmemcached_string_distribution(const memcached_server_distribution_t flag)
 674 {
 675   switch (flag)
 676   {
 677   case MEMCACHED_DISTRIBUTION_MODULA: return "MEMCACHED_DISTRIBUTION_MODULA";
 678   case MEMCACHED_DISTRIBUTION_CONSISTENT: return "MEMCACHED_DISTRIBUTION_CONSISTENT";
 679   case MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA: return "MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA";
 680   case MEMCACHED_DISTRIBUTION_RANDOM: return "MEMCACHED_DISTRIBUTION_RANDOM";
 681   case MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA_SPY: return "MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA_SPY";
 682   case MEMCACHED_DISTRIBUTION_CONSISTENT_WEIGHTED: return "MEMCACHED_DISTRIBUTION_CONSISTENT_WEIGHTED";
 683   case MEMCACHED_DISTRIBUTION_VIRTUAL_BUCKET: return "MEMCACHED_DISTRIBUTION_VIRTUAL_BUCKET";
 684   default:
 685   case MEMCACHED_DISTRIBUTION_CONSISTENT_MAX: return "INVALID memcached_server_distribution_t";
 686   }
 687 }
 688
 689 memcached_return_t memcached_bucket_set(memcached_st *shell,
 690                                         const uint32_t *host_map,
 691                                         const uint32_t *forward_map,
 692                                         const uint32_t buckets,
 693                                         const uint32_t replicas)
 694 {
 695   Memcached* self= memcached2Memcached(shell);
 696   memcached_return_t rc;
 697
 698   if (self == NULL)
 699   {
 700     return MEMCACHED_INVALID_ARGUMENTS;
 701   }
 702
 703   if (host_map == NULL)
 704   {
 705     return MEMCACHED_INVALID_ARGUMENTS;
 706   }
 707
 708   memcached_server_distribution_t old= memcached_behavior_get_distribution(self);
 709
 710   if (memcached_failed(rc =memcached_behavior_set_distribution(self, MEMCACHED_DISTRIBUTION_VIRTUAL_BUCKET)))
 711   {
 712     return rc;
 713   }
 714
 715   if (memcached_failed(rc= memcached_virtual_bucket_create(self, host_map, forward_map, buckets, replicas)))
 716   {
 717     memcached_behavior_set_distribution(self, old);
 718   }
 719
 720   return rc;
 721 }