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
->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
:
175 return memcached_set_error_string(ptr
, MEMCACHED_NOT_SUPPORTED
,
176 memcached_string_with_size("MEMCACHED_BEHAVIOR_CORK is not supported on this platform."));
180 case MEMCACHED_BEHAVIOR_LOAD_FROM_FILE
:
181 return memcached_set_error_string(ptr
, MEMCACHED_INVALID_ARGUMENTS
,
182 memcached_string_with_size("MEMCACHED_BEHAVIOR_LOAD_FROM_FILE can not be set with memcached_behavior_set()"));
183 case MEMCACHED_BEHAVIOR_MAX
:
185 /* Shouldn't get here */
186 WATCHPOINT_ASSERT(0);
187 return memcached_set_error_string(ptr
, MEMCACHED_INVALID_ARGUMENTS
,
188 memcached_string_with_size("Invalid behavior passed to memcached_behavior_set()"));
191 return MEMCACHED_SUCCESS
;
194 bool _is_auto_eject_host(const memcached_st
*ptr
)
196 return ptr
->flags
.auto_eject_hosts
;
199 uint64_t memcached_behavior_get(memcached_st
*ptr
,
200 const memcached_behavior_t flag
)
204 case MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS
:
205 return ptr
->number_of_replicas
;
206 case MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK
:
207 return ptr
->io_msg_watermark
;
208 case MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK
:
209 return ptr
->io_bytes_watermark
;
210 case MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH
:
211 return ptr
->io_key_prefetch
;
212 case MEMCACHED_BEHAVIOR_BINARY_PROTOCOL
:
213 return ptr
->flags
.binary_protocol
;
214 case MEMCACHED_BEHAVIOR_SUPPORT_CAS
:
215 return ptr
->flags
.support_cas
;
216 case MEMCACHED_BEHAVIOR_CACHE_LOOKUPS
:
217 return ptr
->flags
.use_cache_lookups
;
218 case MEMCACHED_BEHAVIOR_NO_BLOCK
:
219 return ptr
->flags
.no_block
;
220 case MEMCACHED_BEHAVIOR_BUFFER_REQUESTS
:
221 return ptr
->flags
.buffer_requests
;
222 case MEMCACHED_BEHAVIOR_USE_UDP
:
223 return ptr
->flags
.use_udp
;
224 case MEMCACHED_BEHAVIOR_TCP_NODELAY
:
225 return ptr
->flags
.tcp_nodelay
;
226 case MEMCACHED_BEHAVIOR_VERIFY_KEY
:
227 return ptr
->flags
.verify_key
;
228 case MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED
:
229 return ptr
->ketama
.weighted
;
230 case MEMCACHED_BEHAVIOR_DISTRIBUTION
:
231 return ptr
->distribution
;
232 case MEMCACHED_BEHAVIOR_KETAMA
:
233 return (ptr
->distribution
== MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA
) ? (uint64_t) 1 : 0;
234 case MEMCACHED_BEHAVIOR_HASH
:
235 return hashkit_get_function(&ptr
->hashkit
);
236 case MEMCACHED_BEHAVIOR_KETAMA_HASH
:
237 return hashkit_get_function(&ptr
->distribution_hashkit
);
238 case MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
:
239 return ptr
->server_failure_limit
;
240 case MEMCACHED_BEHAVIOR_SORT_HOSTS
:
241 return ptr
->flags
.use_sort_hosts
;
242 case MEMCACHED_BEHAVIOR_POLL_TIMEOUT
:
243 return (uint64_t)ptr
->poll_timeout
;
244 case MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT
:
245 return (uint64_t)ptr
->connect_timeout
;
246 case MEMCACHED_BEHAVIOR_RETRY_TIMEOUT
:
247 return (uint64_t)ptr
->retry_timeout
;
248 case MEMCACHED_BEHAVIOR_SND_TIMEOUT
:
249 return (uint64_t)ptr
->snd_timeout
;
250 case MEMCACHED_BEHAVIOR_RCV_TIMEOUT
:
251 return (uint64_t)ptr
->rcv_timeout
;
252 case MEMCACHED_BEHAVIOR_TCP_KEEPIDLE
:
253 return (uint64_t)ptr
->tcp_keepidle
;
254 case MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
:
257 socklen_t sock_length
= sizeof(int);
258 memcached_server_write_instance_st instance
;
260 if (ptr
->send_size
!= -1) // If value is -1 then we are using the default
261 return (uint64_t) ptr
->send_size
;
263 instance
= memcached_server_instance_fetch(ptr
, 0);
265 if (instance
) // If we have an instance we test, otherwise we just set and pray
268 /* We just try the first host, and if it is down we return zero */
269 if ((memcached_connect(instance
)) != MEMCACHED_SUCCESS
)
274 if (memcached_io_wait_for_write(instance
) != MEMCACHED_SUCCESS
)
279 if (getsockopt(instance
->fd
, SOL_SOCKET
, SO_SNDBUF
, &sock_size
, &sock_length
) < 0)
281 memcached_set_errno(ptr
, errno
, NULL
);
282 return 0; /* Zero means error */
286 return (uint64_t) sock_size
;
288 case MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
:
291 socklen_t sock_length
= sizeof(int);
292 memcached_server_write_instance_st instance
;
294 if (ptr
->recv_size
!= -1) // If value is -1 then we are using the default
295 return (uint64_t) ptr
->recv_size
;
297 instance
= memcached_server_instance_fetch(ptr
, 0);
304 /* We just try the first host, and if it is down we return zero */
305 if ((memcached_connect(instance
)) != MEMCACHED_SUCCESS
)
310 if (memcached_io_wait_for_write(instance
) != MEMCACHED_SUCCESS
)
315 if (getsockopt(instance
->fd
, SOL_SOCKET
, SO_RCVBUF
, &sock_size
, &sock_length
) < 0)
317 memcached_set_errno(ptr
, errno
, NULL
);
318 return 0; /* Zero means error */
323 return (uint64_t) sock_size
;
325 case MEMCACHED_BEHAVIOR_USER_DATA
:
326 return memcached_set_error_string(ptr
, MEMCACHED_FAILURE
,
327 memcached_string_with_size("MEMCACHED_BEHAVIOR_USER_DATA deprecated."));
328 case MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY
:
329 return ptr
->flags
.hash_with_prefix_key
;
330 case MEMCACHED_BEHAVIOR_NOREPLY
:
331 return ptr
->flags
.no_reply
;
332 case MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS
:
333 return ptr
->flags
.auto_eject_hosts
;
334 case MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ
:
335 return ptr
->flags
.randomize_replica_read
;
336 case MEMCACHED_BEHAVIOR_CORK
:
342 case MEMCACHED_BEHAVIOR_TCP_KEEPALIVE
:
343 return ptr
->flags
.tcp_keepalive
;
344 case MEMCACHED_BEHAVIOR_LOAD_FROM_FILE
:
345 return ptr
->configure
.filename
? true : false;
346 case MEMCACHED_BEHAVIOR_MAX
:
348 WATCHPOINT_ASSERT(0); /* Programming mistake if it gets this far */
356 memcached_return_t
memcached_behavior_set_distribution(memcached_st
*ptr
, memcached_server_distribution_t type
)
358 if (type
< MEMCACHED_DISTRIBUTION_CONSISTENT_MAX
)
360 if (MEMCACHED_DISTRIBUTION_CONSISTENT_WEIGHTED
)
362 ptr
->ketama
.weighted
= true;
366 ptr
->ketama
.weighted
= false;
368 ptr
->distribution
= type
;
369 run_distribution(ptr
);
370 return MEMCACHED_SUCCESS
;
373 return memcached_set_error_string(ptr
, MEMCACHED_INVALID_ARGUMENTS
,
374 memcached_string_with_size("Invalid memcached_server_distribution_t"));
378 memcached_server_distribution_t
memcached_behavior_get_distribution(memcached_st
*ptr
)
380 return ptr
->distribution
;
383 memcached_return_t
memcached_behavior_set_key_hash(memcached_st
*ptr
, memcached_hash_t type
)
385 if (hashkit_set_function(&ptr
->hashkit
, (hashkit_hash_algorithm_t
)type
) == HASHKIT_SUCCESS
)
386 return MEMCACHED_SUCCESS
;
388 return memcached_set_error_string(ptr
, MEMCACHED_INVALID_ARGUMENTS
,
389 memcached_string_with_size("Invalid memcached_hash_t()"));
392 memcached_hash_t
memcached_behavior_get_key_hash(memcached_st
*ptr
)
394 return (memcached_hash_t
)hashkit_get_function(&ptr
->hashkit
);
397 memcached_return_t
memcached_behavior_set_distribution_hash(memcached_st
*ptr
, memcached_hash_t type
)
399 if (hashkit_set_function(&ptr
->distribution_hashkit
, (hashkit_hash_algorithm_t
)type
) == HASHKIT_SUCCESS
)
400 return MEMCACHED_SUCCESS
;
402 return memcached_set_error_string(ptr
, MEMCACHED_INVALID_ARGUMENTS
,
403 memcached_string_with_size("Invalid memcached_hash_t()"));
406 memcached_hash_t
memcached_behavior_get_distribution_hash(memcached_st
*ptr
)
408 return (memcached_hash_t
)hashkit_get_function(&ptr
->distribution_hashkit
);
411 const char *libmemcached_string_behavior(const memcached_behavior_t flag
)
415 case MEMCACHED_BEHAVIOR_NO_BLOCK
: return "MEMCACHED_BEHAVIOR_NO_BLOCK";
416 case MEMCACHED_BEHAVIOR_TCP_NODELAY
: return "MEMCACHED_BEHAVIOR_TCP_NODELAY";
417 case MEMCACHED_BEHAVIOR_HASH
: return "MEMCACHED_BEHAVIOR_HASH";
418 case MEMCACHED_BEHAVIOR_KETAMA
: return "MEMCACHED_BEHAVIOR_KETAMA";
419 case MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
: return "MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE";
420 case MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
: return "MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE";
421 case MEMCACHED_BEHAVIOR_CACHE_LOOKUPS
: return "MEMCACHED_BEHAVIOR_CACHE_LOOKUPS";
422 case MEMCACHED_BEHAVIOR_SUPPORT_CAS
: return "MEMCACHED_BEHAVIOR_SUPPORT_CAS";
423 case MEMCACHED_BEHAVIOR_POLL_TIMEOUT
: return "MEMCACHED_BEHAVIOR_POLL_TIMEOUT";
424 case MEMCACHED_BEHAVIOR_DISTRIBUTION
: return "MEMCACHED_BEHAVIOR_DISTRIBUTION";
425 case MEMCACHED_BEHAVIOR_BUFFER_REQUESTS
: return "MEMCACHED_BEHAVIOR_BUFFER_REQUESTS";
426 case MEMCACHED_BEHAVIOR_USER_DATA
: return "MEMCACHED_BEHAVIOR_USER_DATA";
427 case MEMCACHED_BEHAVIOR_SORT_HOSTS
: return "MEMCACHED_BEHAVIOR_SORT_HOSTS";
428 case MEMCACHED_BEHAVIOR_VERIFY_KEY
: return "MEMCACHED_BEHAVIOR_VERIFY_KEY";
429 case MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT
: return "MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT";
430 case MEMCACHED_BEHAVIOR_RETRY_TIMEOUT
: return "MEMCACHED_BEHAVIOR_RETRY_TIMEOUT";
431 case MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED
: return "MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED";
432 case MEMCACHED_BEHAVIOR_KETAMA_HASH
: return "MEMCACHED_BEHAVIOR_KETAMA_HASH";
433 case MEMCACHED_BEHAVIOR_BINARY_PROTOCOL
: return "MEMCACHED_BEHAVIOR_BINARY_PROTOCOL";
434 case MEMCACHED_BEHAVIOR_SND_TIMEOUT
: return "MEMCACHED_BEHAVIOR_SND_TIMEOUT";
435 case MEMCACHED_BEHAVIOR_RCV_TIMEOUT
: return "MEMCACHED_BEHAVIOR_RCV_TIMEOUT";
436 case MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
: return "MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT";
437 case MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK
: return "MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK";
438 case MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK
: return "MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK";
439 case MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH
: return "MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH";
440 case MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY
: return "MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY";
441 case MEMCACHED_BEHAVIOR_NOREPLY
: return "MEMCACHED_BEHAVIOR_NOREPLY";
442 case MEMCACHED_BEHAVIOR_USE_UDP
: return "MEMCACHED_BEHAVIOR_USE_UDP";
443 case MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS
: return "MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS";
444 case MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS
: return "MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS";
445 case MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ
: return "MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ";
446 case MEMCACHED_BEHAVIOR_CORK
: return "MEMCACHED_BEHAVIOR_CORK";
447 case MEMCACHED_BEHAVIOR_TCP_KEEPALIVE
: return "MEMCACHED_BEHAVIOR_TCP_KEEPALIVE";
448 case MEMCACHED_BEHAVIOR_TCP_KEEPIDLE
: return "MEMCACHED_BEHAVIOR_TCP_KEEPIDLE";
449 case MEMCACHED_BEHAVIOR_LOAD_FROM_FILE
: return "MEMCACHED_BEHAVIOR_LOAD_FROM_FILE";
451 case MEMCACHED_BEHAVIOR_MAX
: return "INVALID memcached_behavior_t";
455 const char *libmemcached_string_distribution(const memcached_server_distribution_t flag
)
459 case MEMCACHED_DISTRIBUTION_MODULA
: return "MEMCACHED_DISTRIBUTION_MODULA";
460 case MEMCACHED_DISTRIBUTION_CONSISTENT
: return "MEMCACHED_DISTRIBUTION_CONSISTENT";
461 case MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA
: return "MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA";
462 case MEMCACHED_DISTRIBUTION_RANDOM
: return "MEMCACHED_DISTRIBUTION_RANDOM";
463 case MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA_SPY
: return "MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA_SPY";
464 case MEMCACHED_DISTRIBUTION_CONSISTENT_WEIGHTED
: return "MEMCACHED_DISTRIBUTION_CONSISTENT_WEIGHTED";
466 case MEMCACHED_DISTRIBUTION_CONSISTENT_MAX
: return "INVALID memcached_server_distribution_t";