2 * Copyright (C) 2006-2009 Brian Aker
5 * Use and distribution licensed under the BSD license. See
6 * the COPYING file in the parent directory for full text.
8 * Summary: Change the behavior of the memcached connection.
14 #include <sys/types.h>
16 static bool set_flag(uint64_t data
)
19 return data
? true : false;
23 This function is used to modify the behavior of running client.
25 We quit all connections so we can reset the sockets.
28 memcached_return_t
memcached_behavior_set(memcached_st
*ptr
,
29 const memcached_behavior_t flag
,
34 case MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS
:
35 ptr
->number_of_replicas
= (uint32_t)data
;
37 case MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK
:
38 ptr
->io_msg_watermark
= (uint32_t) data
;
40 case MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK
:
41 ptr
->io_bytes_watermark
= (uint32_t)data
;
43 case MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH
:
44 ptr
->io_key_prefetch
= (uint32_t)data
;
46 case MEMCACHED_BEHAVIOR_SND_TIMEOUT
:
47 ptr
->snd_timeout
= (int32_t)data
;
49 case MEMCACHED_BEHAVIOR_RCV_TIMEOUT
:
50 ptr
->rcv_timeout
= (int32_t)data
;
52 case MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
:
53 ptr
->server_failure_limit
= (uint32_t)data
;
55 case MEMCACHED_BEHAVIOR_BINARY_PROTOCOL
:
56 memcached_quit(ptr
); // We need t shutdown all of the connections to make sure we do the correct protocol
59 ptr
->flags
.verify_key
= false;
61 ptr
->flags
.binary_protocol
= set_flag(data
);
63 case MEMCACHED_BEHAVIOR_SUPPORT_CAS
:
64 ptr
->flags
.support_cas
= set_flag(data
);
66 case MEMCACHED_BEHAVIOR_NO_BLOCK
:
67 ptr
->flags
.no_block
= set_flag(data
);
70 case MEMCACHED_BEHAVIOR_BUFFER_REQUESTS
:
71 ptr
->flags
.buffer_requests
= set_flag(data
);
74 case MEMCACHED_BEHAVIOR_USE_UDP
:
75 if (memcached_server_count(ptr
))
77 return MEMCACHED_FAILURE
;
79 ptr
->flags
.use_udp
= set_flag(data
);
82 ptr
->flags
.no_reply
= set_flag(data
);
85 case MEMCACHED_BEHAVIOR_TCP_NODELAY
:
86 ptr
->flags
.tcp_nodelay
= set_flag(data
);
89 case MEMCACHED_BEHAVIOR_TCP_KEEPALIVE
:
90 ptr
->flags
.tcp_keepalive
= set_flag(data
);
93 case MEMCACHED_BEHAVIOR_DISTRIBUTION
:
94 return memcached_behavior_set_distribution(ptr
, (memcached_server_distribution_t
)data
);
95 case MEMCACHED_BEHAVIOR_KETAMA
:
98 return memcached_behavior_set_distribution(ptr
, MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA
);
100 return memcached_behavior_set_distribution(ptr
, MEMCACHED_DISTRIBUTION_MODULA
);
102 case MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED
:
104 (void)memcached_behavior_set_key_hash(ptr
, MEMCACHED_HASH_MD5
);
105 (void)memcached_behavior_set_distribution_hash(ptr
, MEMCACHED_HASH_MD5
);
106 ptr
->flags
.ketama_weighted
= set_flag(data
);
108 @note We try to keep the same distribution going. This should be deprecated and rewritten.
110 return memcached_behavior_set_distribution(ptr
, MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA
);
112 case MEMCACHED_BEHAVIOR_HASH
:
113 return memcached_behavior_set_key_hash(ptr
, (memcached_hash_t
)(data
));
114 case MEMCACHED_BEHAVIOR_KETAMA_HASH
:
115 return memcached_behavior_set_distribution_hash(ptr
, (memcached_hash_t
)(data
));
116 case MEMCACHED_BEHAVIOR_CACHE_LOOKUPS
:
117 ptr
->flags
.use_cache_lookups
= set_flag(data
);
120 case MEMCACHED_BEHAVIOR_VERIFY_KEY
:
121 if (ptr
->flags
.binary_protocol
)
122 return memcached_set_error_string(ptr
, MEMCACHED_FAILURE
,
123 memcached_string_with_size("MEMCACHED_BEHAVIOR_VERIFY_KEY if the binary protocol has been enabled."));
124 ptr
->flags
.verify_key
= set_flag(data
);
126 case MEMCACHED_BEHAVIOR_SORT_HOSTS
:
128 ptr
->flags
.use_sort_hosts
= set_flag(data
);
129 run_distribution(ptr
);
133 case MEMCACHED_BEHAVIOR_POLL_TIMEOUT
:
134 ptr
->poll_timeout
= (int32_t)data
;
136 case MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT
:
137 ptr
->connect_timeout
= (int32_t)data
;
139 case MEMCACHED_BEHAVIOR_RETRY_TIMEOUT
:
140 ptr
->retry_timeout
= (int32_t)data
;
142 case MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
:
143 ptr
->send_size
= (int32_t)data
;
146 case MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
:
147 ptr
->recv_size
= (int32_t)data
;
150 case MEMCACHED_BEHAVIOR_TCP_KEEPIDLE
:
151 ptr
->tcp_keepidle
= (uint32_t)data
;
154 case MEMCACHED_BEHAVIOR_USER_DATA
:
155 return memcached_set_error_string(ptr
, MEMCACHED_FAILURE
,
156 memcached_string_with_size("MEMCACHED_BEHAVIOR_USER_DATA deprecated."));
157 case MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY
:
158 ptr
->flags
.hash_with_prefix_key
= set_flag(data
);
160 case MEMCACHED_BEHAVIOR_NOREPLY
:
161 ptr
->flags
.no_reply
= set_flag(data
);
163 case MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS
:
164 ptr
->flags
.auto_eject_hosts
= set_flag(data
);
166 case MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ
:
167 srandom((uint32_t) time(NULL
));
168 ptr
->flags
.randomize_replica_read
= set_flag(data
);
170 case MEMCACHED_BEHAVIOR_CORK
:
172 memcached_server_write_instance_st instance
;
173 bool action
= set_flag(data
);
177 ptr
->flags
.cork
= set_flag(false);
178 return MEMCACHED_SUCCESS
;
181 instance
= memcached_server_instance_fetch(ptr
, 0);
183 return MEMCACHED_NO_SERVERS
;
186 /* We just try the first host, and if it is down we return zero */
187 memcached_return_t rc
;
188 rc
= memcached_connect(instance
);
189 if (rc
!= MEMCACHED_SUCCESS
)
195 memcached_ternary_t enabled
;
196 enabled
= test_cork(instance
, true);
201 return ptr
->cached_errno
? MEMCACHED_ERRNO
: MEMCACHED_FAILURE
;
204 enabled
= test_cork(instance
, false);
206 if (enabled
== false) // Possible bug in OS?
208 memcached_quit_server(instance
, false); // We should reset everything on this error.
209 return MEMCACHED_ERRNO
; // Errno will be true because we will have already set it.
211 ptr
->flags
.cork
= true;
212 ptr
->flags
.tcp_nodelay
= true;
213 memcached_quit(ptr
); // We go on and reset the connections.
218 return memcached_set_error_string(ptr
, MEMCACHED_NOT_SUPPORTED
,
219 memcached_string_with_size("MEMCACHED_BEHAVIOR_CORK is not supported on this platform."));
223 case MEMCACHED_BEHAVIOR_LOAD_FROM_FILE
:
224 return memcached_set_error_string(ptr
, MEMCACHED_INVALID_ARGUMENTS
,
225 memcached_string_with_size("MEMCACHED_BEHAVIOR_LOAD_FROM_FILE can not be set with memcached_behavior_set()"));
226 case MEMCACHED_BEHAVIOR_MAX
:
228 /* Shouldn't get here */
229 WATCHPOINT_ASSERT(0);
230 return memcached_set_error_string(ptr
, MEMCACHED_INVALID_ARGUMENTS
,
231 memcached_string_with_size("Invalid behavior passed to memcached_behavior_set()"));
234 return MEMCACHED_SUCCESS
;
237 bool _is_auto_eject_host(const memcached_st
*ptr
)
239 return ptr
->flags
.auto_eject_hosts
;
242 uint64_t memcached_behavior_get(memcached_st
*ptr
,
243 const memcached_behavior_t flag
)
247 case MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS
:
248 return ptr
->number_of_replicas
;
249 case MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK
:
250 return ptr
->io_msg_watermark
;
251 case MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK
:
252 return ptr
->io_bytes_watermark
;
253 case MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH
:
254 return ptr
->io_key_prefetch
;
255 case MEMCACHED_BEHAVIOR_BINARY_PROTOCOL
:
256 return ptr
->flags
.binary_protocol
;
257 case MEMCACHED_BEHAVIOR_SUPPORT_CAS
:
258 return ptr
->flags
.support_cas
;
259 case MEMCACHED_BEHAVIOR_CACHE_LOOKUPS
:
260 return ptr
->flags
.use_cache_lookups
;
261 case MEMCACHED_BEHAVIOR_NO_BLOCK
:
262 return ptr
->flags
.no_block
;
263 case MEMCACHED_BEHAVIOR_BUFFER_REQUESTS
:
264 return ptr
->flags
.buffer_requests
;
265 case MEMCACHED_BEHAVIOR_USE_UDP
:
266 return ptr
->flags
.use_udp
;
267 case MEMCACHED_BEHAVIOR_TCP_NODELAY
:
268 return ptr
->flags
.tcp_nodelay
;
269 case MEMCACHED_BEHAVIOR_VERIFY_KEY
:
270 return ptr
->flags
.verify_key
;
271 case MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED
:
272 return ptr
->flags
.ketama_weighted
;
273 case MEMCACHED_BEHAVIOR_DISTRIBUTION
:
274 return ptr
->distribution
;
275 case MEMCACHED_BEHAVIOR_KETAMA
:
276 return (ptr
->distribution
== MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA
) ? (uint64_t) 1 : 0;
277 case MEMCACHED_BEHAVIOR_HASH
:
278 return hashkit_get_function(&ptr
->hashkit
);
279 case MEMCACHED_BEHAVIOR_KETAMA_HASH
:
280 return hashkit_get_function(&ptr
->distribution_hashkit
);
281 case MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
:
282 return ptr
->server_failure_limit
;
283 case MEMCACHED_BEHAVIOR_SORT_HOSTS
:
284 return ptr
->flags
.use_sort_hosts
;
285 case MEMCACHED_BEHAVIOR_POLL_TIMEOUT
:
286 return (uint64_t)ptr
->poll_timeout
;
287 case MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT
:
288 return (uint64_t)ptr
->connect_timeout
;
289 case MEMCACHED_BEHAVIOR_RETRY_TIMEOUT
:
290 return (uint64_t)ptr
->retry_timeout
;
291 case MEMCACHED_BEHAVIOR_SND_TIMEOUT
:
292 return (uint64_t)ptr
->snd_timeout
;
293 case MEMCACHED_BEHAVIOR_RCV_TIMEOUT
:
294 return (uint64_t)ptr
->rcv_timeout
;
295 case MEMCACHED_BEHAVIOR_TCP_KEEPIDLE
:
296 return (uint64_t)ptr
->tcp_keepidle
;
297 case MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
:
300 socklen_t sock_length
= sizeof(int);
301 memcached_server_write_instance_st instance
;
303 if (ptr
->send_size
!= -1) // If value is -1 then we are using the default
304 return (uint64_t) ptr
->send_size
;
306 instance
= memcached_server_instance_fetch(ptr
, 0);
308 if (instance
) // If we have an instance we test, otherwise we just set and pray
311 /* We just try the first host, and if it is down we return zero */
312 if ((memcached_connect(instance
)) != MEMCACHED_SUCCESS
)
317 if (memcached_io_wait_for_write(instance
) != MEMCACHED_SUCCESS
)
322 if (getsockopt(instance
->fd
, SOL_SOCKET
, SO_SNDBUF
, &sock_size
, &sock_length
) < 0)
324 ptr
->cached_errno
= errno
;
325 return 0; /* Zero means error */
329 return (uint64_t) sock_size
;
331 case MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
:
334 socklen_t sock_length
= sizeof(int);
335 memcached_server_write_instance_st instance
;
337 if (ptr
->recv_size
!= -1) // If value is -1 then we are using the default
338 return (uint64_t) ptr
->recv_size
;
340 instance
= memcached_server_instance_fetch(ptr
, 0);
347 /* We just try the first host, and if it is down we return zero */
348 if ((memcached_connect(instance
)) != MEMCACHED_SUCCESS
)
353 if (memcached_io_wait_for_write(instance
) != MEMCACHED_SUCCESS
)
358 if (getsockopt(instance
->fd
, SOL_SOCKET
, SO_RCVBUF
, &sock_size
, &sock_length
) < 0)
360 ptr
->cached_errno
= errno
;
361 return 0; /* Zero means error */
366 return (uint64_t) sock_size
;
368 case MEMCACHED_BEHAVIOR_USER_DATA
:
369 return memcached_set_error_string(ptr
, MEMCACHED_FAILURE
,
370 memcached_string_with_size("MEMCACHED_BEHAVIOR_USER_DATA deprecated."));
371 case MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY
:
372 return ptr
->flags
.hash_with_prefix_key
;
373 case MEMCACHED_BEHAVIOR_NOREPLY
:
374 return ptr
->flags
.no_reply
;
375 case MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS
:
376 return ptr
->flags
.auto_eject_hosts
;
377 case MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ
:
378 return ptr
->flags
.randomize_replica_read
;
379 case MEMCACHED_BEHAVIOR_CORK
:
380 return ptr
->flags
.cork
;
381 case MEMCACHED_BEHAVIOR_TCP_KEEPALIVE
:
382 return ptr
->flags
.tcp_keepalive
;
383 case MEMCACHED_BEHAVIOR_LOAD_FROM_FILE
:
384 return ptr
->configure
.filename
? true : false;
385 case MEMCACHED_BEHAVIOR_MAX
:
387 WATCHPOINT_ASSERT(0); /* Programming mistake if it gets this far */
395 memcached_return_t
memcached_behavior_set_distribution(memcached_st
*ptr
, memcached_server_distribution_t type
)
397 if (type
< MEMCACHED_DISTRIBUTION_CONSISTENT_MAX
)
399 ptr
->distribution
= type
;
400 run_distribution(ptr
);
401 return MEMCACHED_SUCCESS
;
404 return memcached_set_error_string(ptr
, MEMCACHED_INVALID_ARGUMENTS
,
405 memcached_string_with_size("Invalid memcached_server_distribution_t"));
409 memcached_server_distribution_t
memcached_behavior_get_distribution(memcached_st
*ptr
)
411 return ptr
->distribution
;
414 memcached_return_t
memcached_behavior_set_key_hash(memcached_st
*ptr
, memcached_hash_t type
)
416 if (hashkit_set_function(&ptr
->hashkit
, (hashkit_hash_algorithm_t
)type
) == HASHKIT_SUCCESS
)
417 return MEMCACHED_SUCCESS
;
419 return memcached_set_error_string(ptr
, MEMCACHED_INVALID_ARGUMENTS
,
420 memcached_string_with_size("Invalid memcached_hash_t()"));
423 memcached_hash_t
memcached_behavior_get_key_hash(memcached_st
*ptr
)
425 return (memcached_hash_t
)hashkit_get_function(&ptr
->hashkit
);
428 memcached_return_t
memcached_behavior_set_distribution_hash(memcached_st
*ptr
, memcached_hash_t type
)
430 if (hashkit_set_function(&ptr
->distribution_hashkit
, (hashkit_hash_algorithm_t
)type
) == HASHKIT_SUCCESS
)
431 return MEMCACHED_SUCCESS
;
433 return memcached_set_error_string(ptr
, MEMCACHED_INVALID_ARGUMENTS
,
434 memcached_string_with_size("Invalid memcached_hash_t()"));
437 memcached_hash_t
memcached_behavior_get_distribution_hash(memcached_st
*ptr
)
439 return (memcached_hash_t
)hashkit_get_function(&ptr
->distribution_hashkit
);
442 const char *libmemcached_string_behavior(const memcached_behavior_t flag
)
446 case MEMCACHED_BEHAVIOR_NO_BLOCK
: return "MEMCACHED_BEHAVIOR_NO_BLOCK";
447 case MEMCACHED_BEHAVIOR_TCP_NODELAY
: return "MEMCACHED_BEHAVIOR_TCP_NODELAY";
448 case MEMCACHED_BEHAVIOR_HASH
: return "MEMCACHED_BEHAVIOR_HASH";
449 case MEMCACHED_BEHAVIOR_KETAMA
: return "MEMCACHED_BEHAVIOR_KETAMA";
450 case MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
: return "MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE";
451 case MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
: return "MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE";
452 case MEMCACHED_BEHAVIOR_CACHE_LOOKUPS
: return "MEMCACHED_BEHAVIOR_CACHE_LOOKUPS";
453 case MEMCACHED_BEHAVIOR_SUPPORT_CAS
: return "MEMCACHED_BEHAVIOR_SUPPORT_CAS";
454 case MEMCACHED_BEHAVIOR_POLL_TIMEOUT
: return "MEMCACHED_BEHAVIOR_POLL_TIMEOUT";
455 case MEMCACHED_BEHAVIOR_DISTRIBUTION
: return "MEMCACHED_BEHAVIOR_DISTRIBUTION";
456 case MEMCACHED_BEHAVIOR_BUFFER_REQUESTS
: return "MEMCACHED_BEHAVIOR_BUFFER_REQUESTS";
457 case MEMCACHED_BEHAVIOR_USER_DATA
: return "MEMCACHED_BEHAVIOR_USER_DATA";
458 case MEMCACHED_BEHAVIOR_SORT_HOSTS
: return "MEMCACHED_BEHAVIOR_SORT_HOSTS";
459 case MEMCACHED_BEHAVIOR_VERIFY_KEY
: return "MEMCACHED_BEHAVIOR_VERIFY_KEY";
460 case MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT
: return "MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT";
461 case MEMCACHED_BEHAVIOR_RETRY_TIMEOUT
: return "MEMCACHED_BEHAVIOR_RETRY_TIMEOUT";
462 case MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED
: return "MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED";
463 case MEMCACHED_BEHAVIOR_KETAMA_HASH
: return "MEMCACHED_BEHAVIOR_KETAMA_HASH";
464 case MEMCACHED_BEHAVIOR_BINARY_PROTOCOL
: return "MEMCACHED_BEHAVIOR_BINARY_PROTOCOL";
465 case MEMCACHED_BEHAVIOR_SND_TIMEOUT
: return "MEMCACHED_BEHAVIOR_SND_TIMEOUT";
466 case MEMCACHED_BEHAVIOR_RCV_TIMEOUT
: return "MEMCACHED_BEHAVIOR_RCV_TIMEOUT";
467 case MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
: return "MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT";
468 case MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK
: return "MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK";
469 case MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK
: return "MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK";
470 case MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH
: return "MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH";
471 case MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY
: return "MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY";
472 case MEMCACHED_BEHAVIOR_NOREPLY
: return "MEMCACHED_BEHAVIOR_NOREPLY";
473 case MEMCACHED_BEHAVIOR_USE_UDP
: return "MEMCACHED_BEHAVIOR_USE_UDP";
474 case MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS
: return "MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS";
475 case MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS
: return "MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS";
476 case MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ
: return "MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ";
477 case MEMCACHED_BEHAVIOR_CORK
: return "MEMCACHED_BEHAVIOR_CORK";
478 case MEMCACHED_BEHAVIOR_TCP_KEEPALIVE
: return "MEMCACHED_BEHAVIOR_TCP_KEEPALIVE";
479 case MEMCACHED_BEHAVIOR_TCP_KEEPIDLE
: return "MEMCACHED_BEHAVIOR_TCP_KEEPIDLE";
480 case MEMCACHED_BEHAVIOR_LOAD_FROM_FILE
: return "MEMCACHED_BEHAVIOR_LOAD_FROM_FILE";
482 case MEMCACHED_BEHAVIOR_MAX
: return "INVALID memcached_behavior_t";
486 const char *libmemcached_string_distribution(const memcached_server_distribution_t flag
)
490 case MEMCACHED_DISTRIBUTION_MODULA
: return "MEMCACHED_DISTRIBUTION_MODULA";
491 case MEMCACHED_DISTRIBUTION_CONSISTENT
: return "MEMCACHED_DISTRIBUTION_CONSISTENT";
492 case MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA
: return "MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA";
493 case MEMCACHED_DISTRIBUTION_RANDOM
: return "MEMCACHED_DISTRIBUTION_RANDOM";
494 case MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA_SPY
: return "MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA_SPY";
496 case MEMCACHED_DISTRIBUTION_CONSISTENT_MAX
: return "INVALID memcached_server_distribution_t";