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_FAILURE
;
133 ptr
->flags
.verify_key
= set_flag(data
);
135 case MEMCACHED_BEHAVIOR_SORT_HOSTS
:
137 ptr
->flags
.use_sort_hosts
= set_flag(data
);
138 run_distribution(ptr
);
142 case MEMCACHED_BEHAVIOR_POLL_TIMEOUT
:
143 ptr
->poll_timeout
= (int32_t)data
;
145 case MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT
:
146 ptr
->connect_timeout
= (int32_t)data
;
148 case MEMCACHED_BEHAVIOR_RETRY_TIMEOUT
:
149 ptr
->retry_timeout
= (int32_t)data
;
151 case MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
:
152 ptr
->send_size
= (int32_t)data
;
155 case MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
:
156 ptr
->recv_size
= (int32_t)data
;
159 case MEMCACHED_BEHAVIOR_TCP_KEEPIDLE
:
160 ptr
->tcp_keepidle
= (uint32_t)data
;
163 case MEMCACHED_BEHAVIOR_USER_DATA
:
164 return MEMCACHED_FAILURE
;
165 case MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY
:
166 ptr
->flags
.hash_with_prefix_key
= set_flag(data
);
168 case MEMCACHED_BEHAVIOR_NOREPLY
:
169 ptr
->flags
.no_reply
= set_flag(data
);
171 case MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS
:
172 ptr
->flags
.auto_eject_hosts
= set_flag(data
);
174 case MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ
:
175 srandom((uint32_t) time(NULL
));
176 ptr
->flags
.randomize_replica_read
= set_flag(data
);
178 case MEMCACHED_BEHAVIOR_CORK
:
180 memcached_server_write_instance_st instance
;
181 bool action
= set_flag(data
);
185 ptr
->flags
.cork
= set_flag(false);
186 return MEMCACHED_SUCCESS
;
189 instance
= memcached_server_instance_fetch(ptr
, 0);
191 return MEMCACHED_NO_SERVERS
;
194 /* We just try the first host, and if it is down we return zero */
195 memcached_return_t rc
;
196 rc
= memcached_connect(instance
);
197 if (rc
!= MEMCACHED_SUCCESS
)
203 memcached_ternary_t enabled
;
204 enabled
= test_cork(instance
, true);
209 return ptr
->cached_errno
? MEMCACHED_ERRNO
: MEMCACHED_FAILURE
;
212 enabled
= test_cork(instance
, false);
214 if (enabled
== false) // Possible bug in OS?
216 memcached_quit_server(instance
, false); // We should reset everything on this error.
217 return MEMCACHED_ERRNO
; // Errno will be true because we will have already set it.
219 ptr
->flags
.cork
= true;
220 ptr
->flags
.tcp_nodelay
= true;
221 memcached_quit(ptr
); // We go on and reset the connections.
226 return MEMCACHED_NOT_SUPPORTED
;
230 case MEMCACHED_BEHAVIOR_LOAD_FROM_FILE
:
231 ptr
->flags
.load_from_file
= set_flag(data
);
233 case MEMCACHED_BEHAVIOR_MAX
:
235 /* Shouldn't get here */
236 WATCHPOINT_ASSERT(0);
237 return MEMCACHED_FAILURE
;
240 return MEMCACHED_SUCCESS
;
243 bool _is_auto_eject_host(const memcached_st
*ptr
)
245 return ptr
->flags
.auto_eject_hosts
;
248 uint64_t memcached_behavior_get(memcached_st
*ptr
,
249 const memcached_behavior_t flag
)
253 case MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS
:
254 return ptr
->number_of_replicas
;
255 case MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK
:
256 return ptr
->io_msg_watermark
;
257 case MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK
:
258 return ptr
->io_bytes_watermark
;
259 case MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH
:
260 return ptr
->io_key_prefetch
;
261 case MEMCACHED_BEHAVIOR_BINARY_PROTOCOL
:
262 return ptr
->flags
.binary_protocol
;
263 case MEMCACHED_BEHAVIOR_SUPPORT_CAS
:
264 return ptr
->flags
.support_cas
;
265 case MEMCACHED_BEHAVIOR_CACHE_LOOKUPS
:
266 return ptr
->flags
.use_cache_lookups
;
267 case MEMCACHED_BEHAVIOR_NO_BLOCK
:
268 return ptr
->flags
.no_block
;
269 case MEMCACHED_BEHAVIOR_BUFFER_REQUESTS
:
270 return ptr
->flags
.buffer_requests
;
271 case MEMCACHED_BEHAVIOR_USE_UDP
:
272 return ptr
->flags
.use_udp
;
273 case MEMCACHED_BEHAVIOR_TCP_NODELAY
:
274 return ptr
->flags
.tcp_nodelay
;
275 case MEMCACHED_BEHAVIOR_VERIFY_KEY
:
276 return ptr
->flags
.verify_key
;
277 case MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED
:
278 return ptr
->flags
.ketama_weighted
;
279 case MEMCACHED_BEHAVIOR_DISTRIBUTION
:
280 return ptr
->distribution
;
281 case MEMCACHED_BEHAVIOR_KETAMA
:
282 return (ptr
->distribution
== MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA
) ? (uint64_t) 1 : 0;
283 case MEMCACHED_BEHAVIOR_HASH
:
284 return hashkit_get_function(&ptr
->hashkit
);
285 case MEMCACHED_BEHAVIOR_KETAMA_HASH
:
286 return hashkit_get_function(&ptr
->distribution_hashkit
);
287 case MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
:
288 return ptr
->server_failure_limit
;
289 case MEMCACHED_BEHAVIOR_SORT_HOSTS
:
290 return ptr
->flags
.use_sort_hosts
;
291 case MEMCACHED_BEHAVIOR_POLL_TIMEOUT
:
292 return (uint64_t)ptr
->poll_timeout
;
293 case MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT
:
294 return (uint64_t)ptr
->connect_timeout
;
295 case MEMCACHED_BEHAVIOR_RETRY_TIMEOUT
:
296 return (uint64_t)ptr
->retry_timeout
;
297 case MEMCACHED_BEHAVIOR_SND_TIMEOUT
:
298 return (uint64_t)ptr
->snd_timeout
;
299 case MEMCACHED_BEHAVIOR_RCV_TIMEOUT
:
300 return (uint64_t)ptr
->rcv_timeout
;
301 case MEMCACHED_BEHAVIOR_TCP_KEEPIDLE
:
302 return (uint64_t)ptr
->tcp_keepidle
;
303 case MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
:
306 socklen_t sock_length
= sizeof(int);
307 memcached_server_write_instance_st instance
;
309 if (ptr
->send_size
!= -1) // If value is -1 then we are using the default
310 return (uint64_t) ptr
->send_size
;
312 instance
= memcached_server_instance_fetch(ptr
, 0);
314 if (instance
) // If we have an instance we test, otherwise we just set and pray
317 /* We just try the first host, and if it is down we return zero */
318 if ((memcached_connect(instance
)) != MEMCACHED_SUCCESS
)
323 if (memcached_io_wait_for_write(instance
) != MEMCACHED_SUCCESS
)
328 if (getsockopt(instance
->fd
, SOL_SOCKET
, SO_SNDBUF
, &sock_size
, &sock_length
) < 0)
330 ptr
->cached_errno
= errno
;
331 return 0; /* Zero means error */
335 return (uint64_t) sock_size
;
337 case MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
:
340 socklen_t sock_length
= sizeof(int);
341 memcached_server_write_instance_st instance
;
343 if (ptr
->recv_size
!= -1) // If value is -1 then we are using the default
344 return (uint64_t) ptr
->recv_size
;
346 instance
= memcached_server_instance_fetch(ptr
, 0);
353 /* We just try the first host, and if it is down we return zero */
354 if ((memcached_connect(instance
)) != MEMCACHED_SUCCESS
)
359 if (memcached_io_wait_for_write(instance
) != MEMCACHED_SUCCESS
)
364 if (getsockopt(instance
->fd
, SOL_SOCKET
, SO_RCVBUF
, &sock_size
, &sock_length
) < 0)
366 ptr
->cached_errno
= errno
;
367 return 0; /* Zero means error */
372 return (uint64_t) sock_size
;
374 case MEMCACHED_BEHAVIOR_USER_DATA
:
375 return MEMCACHED_FAILURE
;
376 case MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY
:
377 return ptr
->flags
.hash_with_prefix_key
;
378 case MEMCACHED_BEHAVIOR_NOREPLY
:
379 return ptr
->flags
.no_reply
;
380 case MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS
:
381 return ptr
->flags
.auto_eject_hosts
;
382 case MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ
:
383 return ptr
->flags
.randomize_replica_read
;
384 case MEMCACHED_BEHAVIOR_CORK
:
385 return ptr
->flags
.cork
;
386 case MEMCACHED_BEHAVIOR_TCP_KEEPALIVE
:
387 return ptr
->flags
.tcp_keepalive
;
388 case MEMCACHED_BEHAVIOR_LOAD_FROM_FILE
:
389 return ptr
->flags
.load_from_file
;
390 case MEMCACHED_BEHAVIOR_MAX
:
392 WATCHPOINT_ASSERT(0); /* Programming mistake if it gets this far */
400 memcached_return_t
memcached_behavior_set_distribution(memcached_st
*ptr
, memcached_server_distribution_t type
)
402 if (type
< MEMCACHED_DISTRIBUTION_CONSISTENT_MAX
)
404 ptr
->distribution
= type
;
405 run_distribution(ptr
);
409 return MEMCACHED_FAILURE
;
412 return MEMCACHED_SUCCESS
;
416 memcached_server_distribution_t
memcached_behavior_get_distribution(memcached_st
*ptr
)
418 return ptr
->distribution
;
421 memcached_return_t
memcached_behavior_set_key_hash(memcached_st
*ptr
, memcached_hash_t type
)
424 rc
= hashkit_set_function(&ptr
->hashkit
, (hashkit_hash_algorithm_t
)type
);
426 return rc
== HASHKIT_SUCCESS
? MEMCACHED_SUCCESS
: MEMCACHED_FAILURE
;
429 memcached_hash_t
memcached_behavior_get_key_hash(memcached_st
*ptr
)
431 return (memcached_hash_t
)hashkit_get_function(&ptr
->hashkit
);
434 memcached_return_t
memcached_behavior_set_distribution_hash(memcached_st
*ptr
, memcached_hash_t type
)
437 rc
= hashkit_set_function(&ptr
->distribution_hashkit
, (hashkit_hash_algorithm_t
)type
);
439 return rc
== HASHKIT_SUCCESS
? MEMCACHED_SUCCESS
: MEMCACHED_FAILURE
;
442 memcached_hash_t
memcached_behavior_get_distribution_hash(memcached_st
*ptr
)
444 return (memcached_hash_t
)hashkit_get_function(&ptr
->distribution_hashkit
);