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
:
99 (void)memcached_behavior_set_key_hash(ptr
, MEMCACHED_HASH_MD5
);
100 (void)memcached_behavior_set_distribution_hash(ptr
, MEMCACHED_HASH_MD5
);
101 (void)memcached_behavior_set_distribution(ptr
, MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA
);
105 (void)memcached_behavior_set_key_hash(ptr
, MEMCACHED_HASH_DEFAULT
);
106 (void)memcached_behavior_set_distribution_hash(ptr
, MEMCACHED_HASH_DEFAULT
);
107 (void)memcached_behavior_set_distribution(ptr
, MEMCACHED_DISTRIBUTION_MODULA
);
112 case MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED
:
114 (void)memcached_behavior_set_key_hash(ptr
, MEMCACHED_HASH_MD5
);
115 (void)memcached_behavior_set_distribution_hash(ptr
, MEMCACHED_HASH_MD5
);
116 ptr
->flags
.ketama_weighted
= set_flag(data
);
118 @note We try to keep the same distribution going. This should be deprecated and rewritten.
120 return memcached_behavior_set_distribution(ptr
, MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA
);
122 case MEMCACHED_BEHAVIOR_HASH
:
123 return memcached_behavior_set_key_hash(ptr
, (memcached_hash_t
)(data
));
124 case MEMCACHED_BEHAVIOR_KETAMA_HASH
:
125 return memcached_behavior_set_distribution_hash(ptr
, (memcached_hash_t
)(data
));
126 case MEMCACHED_BEHAVIOR_CACHE_LOOKUPS
:
127 ptr
->flags
.use_cache_lookups
= set_flag(data
);
130 case MEMCACHED_BEHAVIOR_VERIFY_KEY
:
131 if (ptr
->flags
.binary_protocol
)
132 return memcached_set_error_string(ptr
, MEMCACHED_FAILURE
,
133 memcached_string_with_size("MEMCACHED_BEHAVIOR_VERIFY_KEY if the binary protocol has been enabled."));
134 ptr
->flags
.verify_key
= set_flag(data
);
136 case MEMCACHED_BEHAVIOR_SORT_HOSTS
:
138 ptr
->flags
.use_sort_hosts
= set_flag(data
);
139 run_distribution(ptr
);
143 case MEMCACHED_BEHAVIOR_POLL_TIMEOUT
:
144 ptr
->poll_timeout
= (int32_t)data
;
146 case MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT
:
147 ptr
->connect_timeout
= (int32_t)data
;
149 case MEMCACHED_BEHAVIOR_RETRY_TIMEOUT
:
150 ptr
->retry_timeout
= (int32_t)data
;
152 case MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
:
153 ptr
->send_size
= (int32_t)data
;
156 case MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
:
157 ptr
->recv_size
= (int32_t)data
;
160 case MEMCACHED_BEHAVIOR_TCP_KEEPIDLE
:
161 ptr
->tcp_keepidle
= (uint32_t)data
;
164 case MEMCACHED_BEHAVIOR_USER_DATA
:
165 return memcached_set_error_string(ptr
, MEMCACHED_FAILURE
,
166 memcached_string_with_size("MEMCACHED_BEHAVIOR_USER_DATA deprecated."));
167 case MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY
:
168 ptr
->flags
.hash_with_prefix_key
= set_flag(data
);
170 case MEMCACHED_BEHAVIOR_NOREPLY
:
171 ptr
->flags
.no_reply
= set_flag(data
);
173 case MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS
:
174 ptr
->flags
.auto_eject_hosts
= set_flag(data
);
176 case MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ
:
177 srandom((uint32_t) time(NULL
));
178 ptr
->flags
.randomize_replica_read
= set_flag(data
);
180 case MEMCACHED_BEHAVIOR_CORK
:
182 memcached_server_write_instance_st instance
;
183 bool action
= set_flag(data
);
187 ptr
->flags
.cork
= set_flag(false);
188 return MEMCACHED_SUCCESS
;
191 instance
= memcached_server_instance_fetch(ptr
, 0);
193 return MEMCACHED_NO_SERVERS
;
196 /* We just try the first host, and if it is down we return zero */
197 memcached_return_t rc
;
198 rc
= memcached_connect(instance
);
199 if (rc
!= MEMCACHED_SUCCESS
)
205 memcached_ternary_t enabled
;
206 enabled
= test_cork(instance
, true);
211 return ptr
->cached_errno
? MEMCACHED_ERRNO
: MEMCACHED_FAILURE
;
214 enabled
= test_cork(instance
, false);
216 if (enabled
== false) // Possible bug in OS?
218 memcached_quit_server(instance
, false); // We should reset everything on this error.
219 return MEMCACHED_ERRNO
; // Errno will be true because we will have already set it.
221 ptr
->flags
.cork
= true;
222 ptr
->flags
.tcp_nodelay
= true;
223 memcached_quit(ptr
); // We go on and reset the connections.
228 return memcached_set_error_string(ptr
, MEMCACHED_NOT_SUPPORTED
,
229 memcached_string_with_size("MEMCACHED_BEHAVIOR_CORK is not supported on this platform."));
233 case MEMCACHED_BEHAVIOR_LOAD_FROM_FILE
:
234 return memcached_set_error_string(ptr
, MEMCACHED_INVALID_ARGUMENTS
,
235 memcached_string_with_size("MEMCACHED_BEHAVIOR_LOAD_FROM_FILE can not be set with memcached_behavior_set()"));
236 case MEMCACHED_BEHAVIOR_MAX
:
238 /* Shouldn't get here */
239 WATCHPOINT_ASSERT(0);
240 return memcached_set_error_string(ptr
, MEMCACHED_INVALID_ARGUMENTS
,
241 memcached_string_with_size("Invalid behavior passed to memcached_behavior_set()"));
244 return MEMCACHED_SUCCESS
;
247 bool _is_auto_eject_host(const memcached_st
*ptr
)
249 return ptr
->flags
.auto_eject_hosts
;
252 uint64_t memcached_behavior_get(memcached_st
*ptr
,
253 const memcached_behavior_t flag
)
257 case MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS
:
258 return ptr
->number_of_replicas
;
259 case MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK
:
260 return ptr
->io_msg_watermark
;
261 case MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK
:
262 return ptr
->io_bytes_watermark
;
263 case MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH
:
264 return ptr
->io_key_prefetch
;
265 case MEMCACHED_BEHAVIOR_BINARY_PROTOCOL
:
266 return ptr
->flags
.binary_protocol
;
267 case MEMCACHED_BEHAVIOR_SUPPORT_CAS
:
268 return ptr
->flags
.support_cas
;
269 case MEMCACHED_BEHAVIOR_CACHE_LOOKUPS
:
270 return ptr
->flags
.use_cache_lookups
;
271 case MEMCACHED_BEHAVIOR_NO_BLOCK
:
272 return ptr
->flags
.no_block
;
273 case MEMCACHED_BEHAVIOR_BUFFER_REQUESTS
:
274 return ptr
->flags
.buffer_requests
;
275 case MEMCACHED_BEHAVIOR_USE_UDP
:
276 return ptr
->flags
.use_udp
;
277 case MEMCACHED_BEHAVIOR_TCP_NODELAY
:
278 return ptr
->flags
.tcp_nodelay
;
279 case MEMCACHED_BEHAVIOR_VERIFY_KEY
:
280 return ptr
->flags
.verify_key
;
281 case MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED
:
282 return ptr
->flags
.ketama_weighted
;
283 case MEMCACHED_BEHAVIOR_DISTRIBUTION
:
284 return ptr
->distribution
;
285 case MEMCACHED_BEHAVIOR_KETAMA
:
286 return (ptr
->distribution
== MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA
) ? (uint64_t) 1 : 0;
287 case MEMCACHED_BEHAVIOR_HASH
:
288 return hashkit_get_function(&ptr
->hashkit
);
289 case MEMCACHED_BEHAVIOR_KETAMA_HASH
:
290 return hashkit_get_function(&ptr
->distribution_hashkit
);
291 case MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
:
292 return ptr
->server_failure_limit
;
293 case MEMCACHED_BEHAVIOR_SORT_HOSTS
:
294 return ptr
->flags
.use_sort_hosts
;
295 case MEMCACHED_BEHAVIOR_POLL_TIMEOUT
:
296 return (uint64_t)ptr
->poll_timeout
;
297 case MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT
:
298 return (uint64_t)ptr
->connect_timeout
;
299 case MEMCACHED_BEHAVIOR_RETRY_TIMEOUT
:
300 return (uint64_t)ptr
->retry_timeout
;
301 case MEMCACHED_BEHAVIOR_SND_TIMEOUT
:
302 return (uint64_t)ptr
->snd_timeout
;
303 case MEMCACHED_BEHAVIOR_RCV_TIMEOUT
:
304 return (uint64_t)ptr
->rcv_timeout
;
305 case MEMCACHED_BEHAVIOR_TCP_KEEPIDLE
:
306 return (uint64_t)ptr
->tcp_keepidle
;
307 case MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
:
310 socklen_t sock_length
= sizeof(int);
311 memcached_server_write_instance_st instance
;
313 if (ptr
->send_size
!= -1) // If value is -1 then we are using the default
314 return (uint64_t) ptr
->send_size
;
316 instance
= memcached_server_instance_fetch(ptr
, 0);
318 if (instance
) // If we have an instance we test, otherwise we just set and pray
321 /* We just try the first host, and if it is down we return zero */
322 if ((memcached_connect(instance
)) != MEMCACHED_SUCCESS
)
327 if (memcached_io_wait_for_write(instance
) != MEMCACHED_SUCCESS
)
332 if (getsockopt(instance
->fd
, SOL_SOCKET
, SO_SNDBUF
, &sock_size
, &sock_length
) < 0)
334 ptr
->cached_errno
= errno
;
335 return 0; /* Zero means error */
339 return (uint64_t) sock_size
;
341 case MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
:
344 socklen_t sock_length
= sizeof(int);
345 memcached_server_write_instance_st instance
;
347 if (ptr
->recv_size
!= -1) // If value is -1 then we are using the default
348 return (uint64_t) ptr
->recv_size
;
350 instance
= memcached_server_instance_fetch(ptr
, 0);
357 /* We just try the first host, and if it is down we return zero */
358 if ((memcached_connect(instance
)) != MEMCACHED_SUCCESS
)
363 if (memcached_io_wait_for_write(instance
) != MEMCACHED_SUCCESS
)
368 if (getsockopt(instance
->fd
, SOL_SOCKET
, SO_RCVBUF
, &sock_size
, &sock_length
) < 0)
370 ptr
->cached_errno
= errno
;
371 return 0; /* Zero means error */
376 return (uint64_t) sock_size
;
378 case MEMCACHED_BEHAVIOR_USER_DATA
:
379 return memcached_set_error_string(ptr
, MEMCACHED_FAILURE
,
380 memcached_string_with_size("MEMCACHED_BEHAVIOR_USER_DATA deprecated."));
381 case MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY
:
382 return ptr
->flags
.hash_with_prefix_key
;
383 case MEMCACHED_BEHAVIOR_NOREPLY
:
384 return ptr
->flags
.no_reply
;
385 case MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS
:
386 return ptr
->flags
.auto_eject_hosts
;
387 case MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ
:
388 return ptr
->flags
.randomize_replica_read
;
389 case MEMCACHED_BEHAVIOR_CORK
:
390 return ptr
->flags
.cork
;
391 case MEMCACHED_BEHAVIOR_TCP_KEEPALIVE
:
392 return ptr
->flags
.tcp_keepalive
;
393 case MEMCACHED_BEHAVIOR_LOAD_FROM_FILE
:
394 return ptr
->configure
.filename
? true : false;
395 case MEMCACHED_BEHAVIOR_MAX
:
397 WATCHPOINT_ASSERT(0); /* Programming mistake if it gets this far */
405 memcached_return_t
memcached_behavior_set_distribution(memcached_st
*ptr
, memcached_server_distribution_t type
)
407 if (type
< MEMCACHED_DISTRIBUTION_CONSISTENT_MAX
)
409 ptr
->distribution
= type
;
410 run_distribution(ptr
);
411 return MEMCACHED_SUCCESS
;
414 return memcached_set_error_string(ptr
, MEMCACHED_INVALID_ARGUMENTS
,
415 memcached_string_with_size("Invalid memcached_server_distribution_t"));
419 memcached_server_distribution_t
memcached_behavior_get_distribution(memcached_st
*ptr
)
421 return ptr
->distribution
;
424 memcached_return_t
memcached_behavior_set_key_hash(memcached_st
*ptr
, memcached_hash_t type
)
426 if (hashkit_set_function(&ptr
->hashkit
, (hashkit_hash_algorithm_t
)type
) == HASHKIT_SUCCESS
)
427 return MEMCACHED_SUCCESS
;
429 return memcached_set_error_string(ptr
, MEMCACHED_INVALID_ARGUMENTS
,
430 memcached_string_with_size("Invalid memcached_hash_t()"));
433 memcached_hash_t
memcached_behavior_get_key_hash(memcached_st
*ptr
)
435 return (memcached_hash_t
)hashkit_get_function(&ptr
->hashkit
);
438 memcached_return_t
memcached_behavior_set_distribution_hash(memcached_st
*ptr
, memcached_hash_t type
)
440 if (hashkit_set_function(&ptr
->distribution_hashkit
, (hashkit_hash_algorithm_t
)type
) == HASHKIT_SUCCESS
)
441 return MEMCACHED_SUCCESS
;
443 return memcached_set_error_string(ptr
, MEMCACHED_INVALID_ARGUMENTS
,
444 memcached_string_with_size("Invalid memcached_hash_t()"));
447 memcached_hash_t
memcached_behavior_get_distribution_hash(memcached_st
*ptr
)
449 return (memcached_hash_t
)hashkit_get_function(&ptr
->distribution_hashkit
);
452 const char *libmemcached_string_behavior(const memcached_behavior_t flag
)
456 case MEMCACHED_BEHAVIOR_NO_BLOCK
: return "MEMCACHED_BEHAVIOR_NO_BLOCK";
457 case MEMCACHED_BEHAVIOR_TCP_NODELAY
: return "MEMCACHED_BEHAVIOR_TCP_NODELAY";
458 case MEMCACHED_BEHAVIOR_HASH
: return "MEMCACHED_BEHAVIOR_HASH";
459 case MEMCACHED_BEHAVIOR_KETAMA
: return "MEMCACHED_BEHAVIOR_KETAMA";
460 case MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
: return "MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE";
461 case MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
: return "MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE";
462 case MEMCACHED_BEHAVIOR_CACHE_LOOKUPS
: return "MEMCACHED_BEHAVIOR_CACHE_LOOKUPS";
463 case MEMCACHED_BEHAVIOR_SUPPORT_CAS
: return "MEMCACHED_BEHAVIOR_SUPPORT_CAS";
464 case MEMCACHED_BEHAVIOR_POLL_TIMEOUT
: return "MEMCACHED_BEHAVIOR_POLL_TIMEOUT";
465 case MEMCACHED_BEHAVIOR_DISTRIBUTION
: return "MEMCACHED_BEHAVIOR_DISTRIBUTION";
466 case MEMCACHED_BEHAVIOR_BUFFER_REQUESTS
: return "MEMCACHED_BEHAVIOR_BUFFER_REQUESTS";
467 case MEMCACHED_BEHAVIOR_USER_DATA
: return "MEMCACHED_BEHAVIOR_USER_DATA";
468 case MEMCACHED_BEHAVIOR_SORT_HOSTS
: return "MEMCACHED_BEHAVIOR_SORT_HOSTS";
469 case MEMCACHED_BEHAVIOR_VERIFY_KEY
: return "MEMCACHED_BEHAVIOR_VERIFY_KEY";
470 case MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT
: return "MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT";
471 case MEMCACHED_BEHAVIOR_RETRY_TIMEOUT
: return "MEMCACHED_BEHAVIOR_RETRY_TIMEOUT";
472 case MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED
: return "MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED";
473 case MEMCACHED_BEHAVIOR_KETAMA_HASH
: return "MEMCACHED_BEHAVIOR_KETAMA_HASH";
474 case MEMCACHED_BEHAVIOR_BINARY_PROTOCOL
: return "MEMCACHED_BEHAVIOR_BINARY_PROTOCOL";
475 case MEMCACHED_BEHAVIOR_SND_TIMEOUT
: return "MEMCACHED_BEHAVIOR_SND_TIMEOUT";
476 case MEMCACHED_BEHAVIOR_RCV_TIMEOUT
: return "MEMCACHED_BEHAVIOR_RCV_TIMEOUT";
477 case MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
: return "MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT";
478 case MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK
: return "MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK";
479 case MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK
: return "MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK";
480 case MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH
: return "MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH";
481 case MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY
: return "MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY";
482 case MEMCACHED_BEHAVIOR_NOREPLY
: return "MEMCACHED_BEHAVIOR_NOREPLY";
483 case MEMCACHED_BEHAVIOR_USE_UDP
: return "MEMCACHED_BEHAVIOR_USE_UDP";
484 case MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS
: return "MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS";
485 case MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS
: return "MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS";
486 case MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ
: return "MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ";
487 case MEMCACHED_BEHAVIOR_CORK
: return "MEMCACHED_BEHAVIOR_CORK";
488 case MEMCACHED_BEHAVIOR_TCP_KEEPALIVE
: return "MEMCACHED_BEHAVIOR_TCP_KEEPALIVE";
489 case MEMCACHED_BEHAVIOR_TCP_KEEPIDLE
: return "MEMCACHED_BEHAVIOR_TCP_KEEPIDLE";
490 case MEMCACHED_BEHAVIOR_LOAD_FROM_FILE
: return "MEMCACHED_BEHAVIOR_LOAD_FROM_FILE";
492 case MEMCACHED_BEHAVIOR_MAX
: return "INVALID BEHAVIOR";