git.m6w6.name Git - m6w6/libmemcached/blob - src/libmemcached/behavior.cc

   1 /*
   2     +--------------------------------------------------------------------+
   3     | libmemcached - C/C++ Client Library for memcached                  |
   4     +--------------------------------------------------------------------+
   5     | Redistribution and use in source and binary forms, with or without |
   6     | modification, are permitted under the terms of the BSD license.    |
   7     | You should have received a copy of the license in a bundled file   |
   8     | named LICENSE; in case you did not receive a copy you can review   |
   9     | the terms online at: https://opensource.org/licenses/BSD-3-Clause  |
  10     +--------------------------------------------------------------------+
  11     | Copyright (c) 2006-2014 Brian Aker   https://datadifferential.com/ |
  12     | Copyright (c) 2020 Michael Wallner   <mike@php.net>                |
  13     +--------------------------------------------------------------------+
  14 */
  15
  16 #include "libmemcached/common.h"
  17 #include "libmemcached/options.hpp"
  18 #include "libmemcached/virtual_bucket.h"
  19
  20 #include <ctime>
  21 #include <sys/types.h>
  22
  23 bool memcached_is_consistent_distribution(const Memcached *memc) {
  24   switch (memc->distribution) {
  25   case MEMCACHED_DISTRIBUTION_CONSISTENT:
  26   case MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA:
  27   case MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA_SPY:
  28   case MEMCACHED_DISTRIBUTION_CONSISTENT_WEIGHTED: return true;
  29
  30   case MEMCACHED_DISTRIBUTION_MODULA:
  31   case MEMCACHED_DISTRIBUTION_RANDOM:
  32   case MEMCACHED_DISTRIBUTION_VIRTUAL_BUCKET:
  33   case MEMCACHED_DISTRIBUTION_CONSISTENT_MAX: break;
  34   }
  35
  36   return false;
  37 }
  38
  39 /*
  40   This function is used to modify the behavior of running client.
  41
  42   We quit all connections so we can reset the sockets.
  43 */
  44
  45 memcached_return_t memcached_behavior_set(memcached_st *shell, const memcached_behavior_t flag,
  46                                           uint64_t data) {
  47   Memcached *ptr = memcached2Memcached(shell);
  48   if (ptr == NULL) {
  49     return MEMCACHED_INVALID_ARGUMENTS;
  50   }
  51
  52   switch (flag) {
  53   case MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS: ptr->number_of_replicas = (uint32_t) data; break;
  54
  55   case MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK: ptr->io_msg_watermark = (uint32_t) data; break;
  56
  57   case MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK: ptr->io_bytes_watermark = (uint32_t) data; break;
  58
  59   case MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH: ptr->io_key_prefetch = (uint32_t) data; break;
  60
  61   case MEMCACHED_BEHAVIOR_SND_TIMEOUT: ptr->snd_timeout = (int32_t) data; break;
  62
  63   case MEMCACHED_BEHAVIOR_RCV_TIMEOUT: ptr->rcv_timeout = (int32_t) data; break;
  64
  65   case MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS: ptr->flags.auto_eject_hosts = bool(data); break;
  66
  67   case MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT:
  68     if (data == 0) {
  69       return memcached_set_error(
  70           *ptr, MEMCACHED_INVALID_ARGUMENTS, MEMCACHED_AT,
  71           memcached_literal_param(
  72               "MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT requires a value greater then zero."));
  73     }
  74     ptr->server_failure_limit = uint32_t(data);
  75     break;
  76
  77   case MEMCACHED_BEHAVIOR_SERVER_TIMEOUT_LIMIT: ptr->server_timeout_limit = uint32_t(data); break;
  78
  79   case MEMCACHED_BEHAVIOR_BINARY_PROTOCOL:
  80     send_quit(
  81         ptr); // We need t shutdown all of the connections to make sure we do the correct protocol
  82     if (data) {
  83       ptr->flags.verify_key = false;
  84     }
  85     ptr->flags.binary_protocol = bool(data);
  86     break;
  87
  88   case MEMCACHED_BEHAVIOR_SUPPORT_CAS: ptr->flags.support_cas = bool(data); break;
  89
  90   case MEMCACHED_BEHAVIOR_NO_BLOCK:
  91     ptr->flags.no_block = bool(data);
  92     send_quit(ptr);
  93     break;
  94
  95   case MEMCACHED_BEHAVIOR_BUFFER_REQUESTS:
  96     if (memcached_is_udp(ptr)) {
  97       return memcached_set_error(
  98           *ptr, MEMCACHED_INVALID_ARGUMENTS, MEMCACHED_AT,
  99           memcached_literal_param("MEMCACHED_BEHAVIOR_BUFFER_REQUESTS cannot be set while "
 100                                   "MEMCACHED_BEHAVIOR_USE_UDP is enabled."));
 101     }
 102     ptr->flags.buffer_requests = bool(data);
 103     send_quit(ptr);
 104     break;
 105
 106   case MEMCACHED_BEHAVIOR_USE_UDP:
 107     send_quit(
 108         ptr); // We need t shutdown all of the connections to make sure we do the correct protocol
 109     ptr->flags.use_udp = bool(data);
 110     if (bool(data)) {
 111       ptr->flags.reply = false;
 112       ptr->flags.buffer_requests = false;
 113     } else {
 114       ptr->flags.reply = true;
 115     }
 116     break;
 117
 118   case MEMCACHED_BEHAVIOR_TCP_NODELAY:
 119     ptr->flags.tcp_nodelay = bool(data);
 120     send_quit(ptr);
 121     break;
 122
 123   case MEMCACHED_BEHAVIOR_TCP_KEEPALIVE:
 124     ptr->flags.tcp_keepalive = bool(data);
 125     send_quit(ptr);
 126     break;
 127
 128   case MEMCACHED_BEHAVIOR_DISTRIBUTION:
 129     return memcached_behavior_set_distribution(ptr, (memcached_server_distribution_t) data);
 130
 131   case MEMCACHED_BEHAVIOR_KETAMA: {
 132     if (data) // Turn on
 133     {
 134       return memcached_behavior_set_distribution(ptr, MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA);
 135     }
 136
 137     return memcached_behavior_set_distribution(ptr, MEMCACHED_DISTRIBUTION_MODULA);
 138   }
 139
 140   case MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED: {
 141     if (bool(data) == false) {
 142       return memcached_behavior_set(ptr, MEMCACHED_BEHAVIOR_KETAMA, true);
 143     }
 144
 145     (void) memcached_behavior_set_key_hash(ptr, MEMCACHED_HASH_MD5);
 146     (void) memcached_behavior_set_distribution_hash(ptr, MEMCACHED_HASH_MD5);
 147     /**
 148       @note We try to keep the same distribution going. This should be deprecated and rewritten.
 149     */
 150     return memcached_behavior_set_distribution(ptr, MEMCACHED_DISTRIBUTION_CONSISTENT_WEIGHTED);
 151   }
 152
 153   case MEMCACHED_BEHAVIOR_HASH:
 154     return memcached_behavior_set_key_hash(ptr, (memcached_hash_t)(data));
 155
 156   case MEMCACHED_BEHAVIOR_KETAMA_HASH:
 157     return memcached_behavior_set_distribution_hash(ptr, (memcached_hash_t)(data));
 158
 159   case MEMCACHED_BEHAVIOR_CACHE_LOOKUPS:
 160     return memcached_set_error(
 161         *ptr, MEMCACHED_DEPRECATED, MEMCACHED_AT,
 162         memcached_literal_param("MEMCACHED_BEHAVIOR_CACHE_LOOKUPS has been deprecated."));
 163
 164   case MEMCACHED_BEHAVIOR_VERIFY_KEY:
 165     if (ptr->flags.binary_protocol) {
 166       return memcached_set_error(
 167           *ptr, MEMCACHED_INVALID_ARGUMENTS, MEMCACHED_AT,
 168           memcached_literal_param(
 169               "MEMCACHED_BEHAVIOR_VERIFY_KEY if the binary protocol has been enabled."));
 170     }
 171     ptr->flags.verify_key = bool(data);
 172     break;
 173
 174   case MEMCACHED_BEHAVIOR_SORT_HOSTS: {
 175     ptr->flags.use_sort_hosts = bool(data);
 176     return run_distribution(ptr);
 177   }
 178
 179   case MEMCACHED_BEHAVIOR_POLL_TIMEOUT: ptr->poll_timeout = (int32_t) data; break;
 180
 181   case MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT: ptr->connect_timeout = (int32_t) data; break;
 182
 183   case MEMCACHED_BEHAVIOR_RETRY_TIMEOUT: ptr->retry_timeout = int32_t(data); break;
 184
 185   case MEMCACHED_BEHAVIOR_DEAD_TIMEOUT: ptr->dead_timeout = int32_t(data); break;
 186
 187   case MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE:
 188     ptr->send_size = (int32_t) data;
 189     send_quit(ptr);
 190     break;
 191
 192   case MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE:
 193     ptr->recv_size = (int32_t) data;
 194     send_quit(ptr);
 195     break;
 196
 197   case MEMCACHED_BEHAVIOR_TCP_KEEPIDLE:
 198     ptr->tcp_keepidle = (uint32_t) data;
 199     send_quit(ptr);
 200     break;
 201
 202   case MEMCACHED_BEHAVIOR_USER_DATA:
 203     return memcached_set_error(*ptr, MEMCACHED_DEPRECATED, MEMCACHED_AT,
 204                                memcached_literal_param("MEMCACHED_BEHAVIOR_USER_DATA deprecated."));
 205
 206   case MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY: ptr->flags.hash_with_namespace = bool(data); break;
 207
 208   case MEMCACHED_BEHAVIOR_NOREPLY:
 209     if (memcached_is_udp(ptr) and bool(data) == false) {
 210       return memcached_set_error(
 211           *ptr, MEMCACHED_INVALID_ARGUMENTS, MEMCACHED_AT,
 212           memcached_literal_param("MEMCACHED_BEHAVIOR_NOREPLY cannot be disabled while "
 213                                   "MEMCACHED_BEHAVIOR_USE_UDP is enabled."));
 214     }
 215     // We reverse the logic here to make it easier to understand throughout the
 216     // code.
 217     ptr->flags.reply = bool(data) ? false : true;
 218     break;
 219
 220   case MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS: ptr->flags.auto_eject_hosts = bool(data); break;
 221
 222   case MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ:
 223     srandom((uint32_t) time(NULL));
 224     ptr->flags.randomize_replica_read = bool(data);
 225     break;
 226
 227   case MEMCACHED_BEHAVIOR_CORK:
 228     return memcached_set_error(
 229         *ptr, MEMCACHED_DEPRECATED, MEMCACHED_AT,
 230         memcached_literal_param(
 231             "MEMCACHED_BEHAVIOR_CORK is now incorporated into the driver by default."));
 232
 233   case MEMCACHED_BEHAVIOR_LOAD_FROM_FILE:
 234     return memcached_set_error(
 235         *ptr, MEMCACHED_INVALID_ARGUMENTS, MEMCACHED_AT,
 236         memcached_literal_param(
 237             "MEMCACHED_BEHAVIOR_LOAD_FROM_FILE can not be set with memcached_behavior_set()"));
 238
 239   case MEMCACHED_BEHAVIOR_MAX:
 240   default:
 241     /* Shouldn't get here */
 242     assert_msg(0, "Invalid behavior passed to memcached_behavior_set()");
 243     return memcached_set_error(
 244         *ptr, MEMCACHED_INVALID_ARGUMENTS, MEMCACHED_AT,
 245         memcached_literal_param("Invalid behavior passed to memcached_behavior_set()"));
 246   }
 247
 248   return MEMCACHED_SUCCESS;
 249 }
 250
 251 bool _is_auto_eject_host(const memcached_st *ptr) {
 252   return ptr->flags.auto_eject_hosts;
 253 }
 254
 255 uint64_t memcached_behavior_get(memcached_st *shell, const memcached_behavior_t flag) {
 256   Memcached *ptr = memcached2Memcached(shell);
 257   if (ptr == NULL) {
 258     return MEMCACHED_INVALID_ARGUMENTS;
 259   }
 260
 261   switch (flag) {
 262   case MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS: return ptr->number_of_replicas;
 263
 264   case MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK: return ptr->io_msg_watermark;
 265
 266   case MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK: return ptr->io_bytes_watermark;
 267
 268   case MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH: return ptr->io_key_prefetch;
 269
 270   case MEMCACHED_BEHAVIOR_BINARY_PROTOCOL: return ptr->flags.binary_protocol;
 271
 272   case MEMCACHED_BEHAVIOR_SUPPORT_CAS: return ptr->flags.support_cas;
 273
 274   case MEMCACHED_BEHAVIOR_CACHE_LOOKUPS: return true;
 275
 276   case MEMCACHED_BEHAVIOR_NO_BLOCK: return ptr->flags.no_block;
 277
 278   case MEMCACHED_BEHAVIOR_BUFFER_REQUESTS: return ptr->flags.buffer_requests;
 279
 280   case MEMCACHED_BEHAVIOR_USE_UDP: return memcached_is_udp(ptr);
 281
 282   case MEMCACHED_BEHAVIOR_TCP_NODELAY: return ptr->flags.tcp_nodelay;
 283
 284   case MEMCACHED_BEHAVIOR_VERIFY_KEY: return ptr->flags.verify_key;
 285
 286   case MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED:
 287     if (memcached_is_consistent_distribution(ptr)) {
 288       return memcached_is_weighted_ketama(ptr);
 289     }
 290     return false;
 291
 292   case MEMCACHED_BEHAVIOR_DISTRIBUTION: return ptr->distribution;
 293
 294   case MEMCACHED_BEHAVIOR_KETAMA: return memcached_is_consistent_distribution(ptr);
 295
 296   case MEMCACHED_BEHAVIOR_HASH: return hashkit_get_function(&ptr->hashkit);
 297
 298   case MEMCACHED_BEHAVIOR_KETAMA_HASH: return hashkit_get_distribution_function(&ptr->hashkit);
 299
 300   case MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS: return ptr->flags.auto_eject_hosts;
 301
 302   case MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT: return ptr->server_failure_limit;
 303
 304   case MEMCACHED_BEHAVIOR_SERVER_TIMEOUT_LIMIT: return ptr->server_timeout_limit;
 305
 306   case MEMCACHED_BEHAVIOR_SORT_HOSTS: return ptr->flags.use_sort_hosts;
 307
 308   case MEMCACHED_BEHAVIOR_POLL_TIMEOUT: return (uint64_t) ptr->poll_timeout;
 309
 310   case MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT: return (uint64_t) ptr->connect_timeout;
 311
 312   case MEMCACHED_BEHAVIOR_RETRY_TIMEOUT: return (uint64_t) ptr->retry_timeout;
 313
 314   case MEMCACHED_BEHAVIOR_DEAD_TIMEOUT: return uint64_t(ptr->dead_timeout);
 315
 316   case MEMCACHED_BEHAVIOR_SND_TIMEOUT: return (uint64_t) ptr->snd_timeout;
 317
 318   case MEMCACHED_BEHAVIOR_RCV_TIMEOUT: return (uint64_t) ptr->rcv_timeout;
 319
 320   case MEMCACHED_BEHAVIOR_TCP_KEEPIDLE: return (uint64_t) ptr->tcp_keepidle;
 321
 322   case MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE: {
 323     int sock_size = 0;
 324     socklen_t sock_length = sizeof(int);
 325
 326     if (ptr->send_size != -1) // If value is -1 then we are using the default
 327     {
 328       return (uint64_t) ptr->send_size;
 329     }
 330
 331     memcached_instance_st *instance = memcached_instance_fetch(ptr, 0);
 332
 333     if (instance) // If we have an instance we test, otherwise we just set and pray
 334     {
 335       /* REFACTOR */
 336       /* We just try the first host, and if it is down we return zero */
 337       if (memcached_failed(memcached_connect(instance))) {
 338         return 0;
 339       }
 340
 341       if (memcached_failed(memcached_io_wait_for_write(instance))) {
 342         return 0;
 343       }
 344
 345       if (getsockopt(instance->fd, SOL_SOCKET, SO_SNDBUF, (char *) &sock_size, &sock_length) < 0) {
 346         memcached_set_errno(*ptr, get_socket_errno(), MEMCACHED_AT);
 347         return 0; /* Zero means error */
 348       }
 349     }
 350
 351     return (uint64_t) sock_size;
 352   }
 353
 354   case MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE: {
 355     int sock_size = 0;
 356     socklen_t sock_length = sizeof(int);
 357
 358     if (ptr->recv_size != -1) // If value is -1 then we are using the default
 359       return (uint64_t) ptr->recv_size;
 360
 361     memcached_instance_st *instance = memcached_instance_fetch(ptr, 0);
 362
 363     /**
 364       @note REFACTOR
 365     */
 366     if (instance) {
 367       /* We just try the first host, and if it is down we return zero */
 368       if (memcached_failed(memcached_connect(instance))) {
 369         return 0;
 370       }
 371
 372       if (memcached_failed(memcached_io_wait_for_write(instance))) {
 373         return 0;
 374       }
 375
 376       if (getsockopt(instance->fd, SOL_SOCKET, SO_RCVBUF, (char *) &sock_size, &sock_length) < 0) {
 377         memcached_set_errno(*ptr, get_socket_errno(), MEMCACHED_AT);
 378         return 0; /* Zero means error */
 379       }
 380     }
 381
 382     return (uint64_t) sock_size;
 383   }
 384
 385   case MEMCACHED_BEHAVIOR_USER_DATA:
 386     memcached_set_error(*ptr, MEMCACHED_DEPRECATED, MEMCACHED_AT,
 387                         memcached_literal_param("MEMCACHED_BEHAVIOR_USER_DATA deprecated."));
 388     return 0;
 389
 390   case MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY: return ptr->flags.hash_with_namespace;
 391
 392   case MEMCACHED_BEHAVIOR_NOREPLY: return ptr->flags.reply ? false : true;
 393
 394   case MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS: return ptr->flags.auto_eject_hosts;
 395
 396   case MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ: return ptr->flags.randomize_replica_read;
 397
 398   case MEMCACHED_BEHAVIOR_CORK:
 399 #ifdef HAVE_MSG_MORE
 400     return true;
 401 #else
 402     return false;
 403 #endif
 404
 405   case MEMCACHED_BEHAVIOR_TCP_KEEPALIVE: return ptr->flags.tcp_keepalive;
 406
 407   case MEMCACHED_BEHAVIOR_LOAD_FROM_FILE: return bool(memcached_parse_filename(ptr));
 408
 409   case MEMCACHED_BEHAVIOR_MAX:
 410   default: assert_msg(0, "Invalid behavior passed to memcached_behavior_get()"); return 0;
 411   }
 412
 413   /* NOTREACHED */
 414 }
 415
 416 memcached_return_t memcached_behavior_set_distribution(memcached_st *shell,
 417                                                        memcached_server_distribution_t type) {
 418   Memcached *ptr = memcached2Memcached(shell);
 419   if (ptr) {
 420     switch (type) {
 421     case MEMCACHED_DISTRIBUTION_MODULA: break;
 422
 423     case MEMCACHED_DISTRIBUTION_CONSISTENT:
 424     case MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA: memcached_set_weighted_ketama(ptr, false); break;
 425
 426     case MEMCACHED_DISTRIBUTION_RANDOM: break;
 427
 428     case MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA_SPY: break;
 429
 430     case MEMCACHED_DISTRIBUTION_CONSISTENT_WEIGHTED:
 431       memcached_set_weighted_ketama(ptr, true);
 432       break;
 433
 434     case MEMCACHED_DISTRIBUTION_VIRTUAL_BUCKET: break;
 435
 436     default:
 437     case MEMCACHED_DISTRIBUTION_CONSISTENT_MAX:
 438       return memcached_set_error(
 439           *ptr, MEMCACHED_INVALID_ARGUMENTS, MEMCACHED_AT,
 440           memcached_literal_param("Invalid memcached_server_distribution_t"));
 441     }
 442     ptr->distribution = type;
 443
 444     return run_distribution(ptr);
 445   }
 446
 447   return MEMCACHED_INVALID_ARGUMENTS;
 448 }
 449
 450 memcached_server_distribution_t memcached_behavior_get_distribution(memcached_st *shell) {
 451   Memcached *ptr = memcached2Memcached(shell);
 452   if (ptr) {
 453     return ptr->distribution;
 454   }
 455
 456   return MEMCACHED_DISTRIBUTION_CONSISTENT_MAX;
 457 }
 458
 459 memcached_return_t memcached_behavior_set_key_hash(memcached_st *shell, memcached_hash_t type) {
 460   Memcached *ptr = memcached2Memcached(shell);
 461   if (ptr) {
 462     if (hashkit_success(hashkit_set_function(&ptr->hashkit, (hashkit_hash_algorithm_t) type))) {
 463       return MEMCACHED_SUCCESS;
 464     }
 465
 466     return memcached_set_error(*ptr, MEMCACHED_INVALID_ARGUMENTS, MEMCACHED_AT,
 467                                memcached_literal_param("Invalid memcached_hash_t()"));
 468   }
 469
 470   return MEMCACHED_INVALID_ARGUMENTS;
 471 }
 472
 473 memcached_hash_t memcached_behavior_get_key_hash(memcached_st *shell) {
 474   Memcached *ptr = memcached2Memcached(shell);
 475   if (ptr) {
 476     return (memcached_hash_t) hashkit_get_function(&ptr->hashkit);
 477   }
 478
 479   return MEMCACHED_HASH_MAX;
 480 }
 481
 482 memcached_return_t memcached_behavior_set_distribution_hash(memcached_st *shell,
 483                                                             memcached_hash_t type) {
 484   Memcached *ptr = memcached2Memcached(shell);
 485   if (ptr) {
 486     if (hashkit_success(
 487             hashkit_set_distribution_function(&ptr->hashkit, (hashkit_hash_algorithm_t) type)))
 488     {
 489       return MEMCACHED_SUCCESS;
 490     }
 491
 492     return memcached_set_error(*ptr, MEMCACHED_INVALID_ARGUMENTS, MEMCACHED_AT,
 493                                memcached_literal_param("Invalid memcached_hash_t()"));
 494   }
 495
 496   return MEMCACHED_INVALID_ARGUMENTS;
 497 }
 498
 499 memcached_hash_t memcached_behavior_get_distribution_hash(memcached_st *shell) {
 500   Memcached *ptr = memcached2Memcached(shell);
 501   if (ptr) {
 502     return (memcached_hash_t) hashkit_get_function(&ptr->hashkit);
 503   }
 504
 505   return MEMCACHED_HASH_MAX;
 506 }
 507
 508 const char *libmemcached_string_behavior(const memcached_behavior_t flag) {
 509   switch (flag) {
 510   case MEMCACHED_BEHAVIOR_SERVER_TIMEOUT_LIMIT: return "MEMCACHED_BEHAVIOR_SERVER_TIMEOUT_LIMIT";
 511   case MEMCACHED_BEHAVIOR_NO_BLOCK: return "MEMCACHED_BEHAVIOR_NO_BLOCK";
 512   case MEMCACHED_BEHAVIOR_TCP_NODELAY: return "MEMCACHED_BEHAVIOR_TCP_NODELAY";
 513   case MEMCACHED_BEHAVIOR_HASH: return "MEMCACHED_BEHAVIOR_HASH";
 514   case MEMCACHED_BEHAVIOR_KETAMA: return "MEMCACHED_BEHAVIOR_KETAMA";
 515   case MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE: return "MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE";
 516   case MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE: return "MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE";
 517   case MEMCACHED_BEHAVIOR_CACHE_LOOKUPS: return "MEMCACHED_BEHAVIOR_CACHE_LOOKUPS";
 518   case MEMCACHED_BEHAVIOR_SUPPORT_CAS: return "MEMCACHED_BEHAVIOR_SUPPORT_CAS";
 519   case MEMCACHED_BEHAVIOR_POLL_TIMEOUT: return "MEMCACHED_BEHAVIOR_POLL_TIMEOUT";
 520   case MEMCACHED_BEHAVIOR_DISTRIBUTION: return "MEMCACHED_BEHAVIOR_DISTRIBUTION";
 521   case MEMCACHED_BEHAVIOR_BUFFER_REQUESTS: return "MEMCACHED_BEHAVIOR_BUFFER_REQUESTS";
 522   case MEMCACHED_BEHAVIOR_USER_DATA: return "MEMCACHED_BEHAVIOR_USER_DATA";
 523   case MEMCACHED_BEHAVIOR_SORT_HOSTS: return "MEMCACHED_BEHAVIOR_SORT_HOSTS";
 524   case MEMCACHED_BEHAVIOR_VERIFY_KEY: return "MEMCACHED_BEHAVIOR_VERIFY_KEY";
 525   case MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT: return "MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT";
 526   case MEMCACHED_BEHAVIOR_RETRY_TIMEOUT: return "MEMCACHED_BEHAVIOR_RETRY_TIMEOUT";
 527   case MEMCACHED_BEHAVIOR_DEAD_TIMEOUT: return "MEMCACHED_BEHAVIOR_DEAD_TIMEOUT";
 528   case MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED: return "MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED";
 529   case MEMCACHED_BEHAVIOR_KETAMA_HASH: return "MEMCACHED_BEHAVIOR_KETAMA_HASH";
 530   case MEMCACHED_BEHAVIOR_BINARY_PROTOCOL: return "MEMCACHED_BEHAVIOR_BINARY_PROTOCOL";
 531   case MEMCACHED_BEHAVIOR_SND_TIMEOUT: return "MEMCACHED_BEHAVIOR_SND_TIMEOUT";
 532   case MEMCACHED_BEHAVIOR_RCV_TIMEOUT: return "MEMCACHED_BEHAVIOR_RCV_TIMEOUT";
 533   case MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT: return "MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT";
 534   case MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK: return "MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK";
 535   case MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK: return "MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK";
 536   case MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH: return "MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH";
 537   case MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY: return "MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY";
 538   case MEMCACHED_BEHAVIOR_NOREPLY: return "MEMCACHED_BEHAVIOR_NOREPLY";
 539   case MEMCACHED_BEHAVIOR_USE_UDP: return "MEMCACHED_BEHAVIOR_USE_UDP";
 540   case MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS: return "MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS";
 541   case MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS: return "MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS";
 542   case MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS: return "MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS";
 543   case MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ:
 544     return "MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ";
 545   case MEMCACHED_BEHAVIOR_CORK: return "MEMCACHED_BEHAVIOR_CORK";
 546   case MEMCACHED_BEHAVIOR_TCP_KEEPALIVE: return "MEMCACHED_BEHAVIOR_TCP_KEEPALIVE";
 547   case MEMCACHED_BEHAVIOR_TCP_KEEPIDLE: return "MEMCACHED_BEHAVIOR_TCP_KEEPIDLE";
 548   case MEMCACHED_BEHAVIOR_LOAD_FROM_FILE: return "MEMCACHED_BEHAVIOR_LOAD_FROM_FILE";
 549   default:
 550   case MEMCACHED_BEHAVIOR_MAX: return "INVALID memcached_behavior_t";
 551   }
 552 }
 553
 554 const char *libmemcached_string_distribution(const memcached_server_distribution_t flag) {
 555   switch (flag) {
 556   case MEMCACHED_DISTRIBUTION_MODULA: return "MEMCACHED_DISTRIBUTION_MODULA";
 557   case MEMCACHED_DISTRIBUTION_CONSISTENT: return "MEMCACHED_DISTRIBUTION_CONSISTENT";
 558   case MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA: return "MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA";
 559   case MEMCACHED_DISTRIBUTION_RANDOM: return "MEMCACHED_DISTRIBUTION_RANDOM";
 560   case MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA_SPY:
 561     return "MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA_SPY";
 562   case MEMCACHED_DISTRIBUTION_CONSISTENT_WEIGHTED:
 563     return "MEMCACHED_DISTRIBUTION_CONSISTENT_WEIGHTED";
 564   case MEMCACHED_DISTRIBUTION_VIRTUAL_BUCKET: return "MEMCACHED_DISTRIBUTION_VIRTUAL_BUCKET";
 565   default:
 566   case MEMCACHED_DISTRIBUTION_CONSISTENT_MAX: return "INVALID memcached_server_distribution_t";
 567   }
 568 }
 569
 570 memcached_return_t memcached_bucket_set(memcached_st *shell, const uint32_t *host_map,
 571                                         const uint32_t *forward_map, const uint32_t buckets,
 572                                         const uint32_t replicas) {
 573   Memcached *self = memcached2Memcached(shell);
 574   memcached_return_t rc;
 575
 576   if (self == NULL) {
 577     return MEMCACHED_INVALID_ARGUMENTS;
 578   }
 579
 580   if (host_map == NULL) {
 581     return MEMCACHED_INVALID_ARGUMENTS;
 582   }
 583
 584   memcached_server_distribution_t old = memcached_behavior_get_distribution(self);
 585
 586   if (memcached_failed(
 587           rc = memcached_behavior_set_distribution(self, MEMCACHED_DISTRIBUTION_VIRTUAL_BUCKET)))
 588   {
 589     return rc;
 590   }
 591
 592   if (memcached_failed(
 593           rc = memcached_virtual_bucket_create(self, host_map, forward_map, buckets, replicas)))
 594   {
 595     memcached_behavior_set_distribution(self, old);
 596   }
 597
 598   return rc;
 599 }