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>
15 #include <sys/socket.h>
16 #include <netinet/tcp.h>
18 static bool set_flag(uint64_t data
)
21 return data
? true : false;
25 This function is used to modify the behavior of running client.
27 We quit all connections so we can reset the sockets.
30 memcached_return_t
memcached_behavior_set(memcached_st
*ptr
,
31 const memcached_behavior_t flag
,
36 case MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS
:
37 ptr
->number_of_replicas
= (uint32_t)data
;
39 case MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK
:
40 ptr
->io_msg_watermark
= (uint32_t) data
;
42 case MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK
:
43 ptr
->io_bytes_watermark
= (uint32_t)data
;
45 case MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH
:
46 ptr
->io_key_prefetch
= (uint32_t)data
;
48 case MEMCACHED_BEHAVIOR_SND_TIMEOUT
:
49 ptr
->snd_timeout
= (int32_t)data
;
51 case MEMCACHED_BEHAVIOR_RCV_TIMEOUT
:
52 ptr
->rcv_timeout
= (int32_t)data
;
54 case MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
:
55 ptr
->server_failure_limit
= (uint32_t)data
;
57 case MEMCACHED_BEHAVIOR_BINARY_PROTOCOL
:
60 ptr
->flags
.verify_key
= false;
62 ptr
->flags
.binary_protocol
= set_flag(data
);
64 case MEMCACHED_BEHAVIOR_SUPPORT_CAS
:
65 ptr
->flags
.support_cas
= set_flag(data
);
67 case MEMCACHED_BEHAVIOR_NO_BLOCK
:
68 ptr
->flags
.no_block
= set_flag(data
);
71 case MEMCACHED_BEHAVIOR_BUFFER_REQUESTS
:
72 ptr
->flags
.buffer_requests
= set_flag(data
);
75 case MEMCACHED_BEHAVIOR_USE_UDP
:
76 if (memcached_server_count(ptr
))
78 return MEMCACHED_FAILURE
;
80 ptr
->flags
.use_udp
= set_flag(data
);
83 ptr
->flags
.no_reply
= set_flag(data
);
86 case MEMCACHED_BEHAVIOR_TCP_NODELAY
:
87 ptr
->flags
.tcp_nodelay
= set_flag(data
);
90 case MEMCACHED_BEHAVIOR_TCP_KEEPALIVE
:
91 ptr
->flags
.tcp_keepalive
= set_flag(data
);
94 case MEMCACHED_BEHAVIOR_DISTRIBUTION
:
95 return memcached_behavior_set_distribution(ptr
, (memcached_server_distribution_t
)data
);
96 case MEMCACHED_BEHAVIOR_KETAMA
:
100 (void)memcached_behavior_set_key_hash(ptr
, MEMCACHED_HASH_MD5
);
101 (void)memcached_behavior_set_distribution_hash(ptr
, MEMCACHED_HASH_MD5
);
102 (void)memcached_behavior_set_distribution(ptr
, MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA
);
106 (void)memcached_behavior_set_key_hash(ptr
, MEMCACHED_HASH_DEFAULT
);
107 (void)memcached_behavior_set_distribution_hash(ptr
, MEMCACHED_HASH_DEFAULT
);
108 (void)memcached_behavior_set_distribution(ptr
, MEMCACHED_DISTRIBUTION_MODULA
);
113 case MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED
:
115 (void)memcached_behavior_set_key_hash(ptr
, MEMCACHED_HASH_MD5
);
116 (void)memcached_behavior_set_distribution_hash(ptr
, MEMCACHED_HASH_MD5
);
117 ptr
->flags
.ketama_weighted
= set_flag(data
);
119 @note We try to keep the same distribution going. This should be deprecated and rewritten.
121 return memcached_behavior_set_distribution(ptr
, MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA
);
123 case MEMCACHED_BEHAVIOR_HASH
:
124 return memcached_behavior_set_key_hash(ptr
, (memcached_hash_t
)(data
));
125 case MEMCACHED_BEHAVIOR_KETAMA_HASH
:
126 return memcached_behavior_set_distribution_hash(ptr
, (memcached_hash_t
)(data
));
127 case MEMCACHED_BEHAVIOR_CACHE_LOOKUPS
:
128 ptr
->flags
.use_cache_lookups
= set_flag(data
);
131 case MEMCACHED_BEHAVIOR_VERIFY_KEY
:
132 if (ptr
->flags
.binary_protocol
)
133 return MEMCACHED_FAILURE
;
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_FAILURE
;
166 case MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY
:
167 ptr
->flags
.hash_with_prefix_key
= set_flag(data
);
169 case MEMCACHED_BEHAVIOR_NOREPLY
:
170 ptr
->flags
.no_reply
= set_flag(data
);
172 case MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS
:
173 ptr
->flags
.auto_eject_hosts
= set_flag(data
);
175 case MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ
:
176 srandom((uint32_t) time(NULL
));
177 ptr
->flags
.randomize_replica_read
= set_flag(data
);
179 case MEMCACHED_BEHAVIOR_CORK
:
181 memcached_server_write_instance_st instance
;
182 bool action
= set_flag(data
);
186 ptr
->flags
.cork
= set_flag(false);
187 return MEMCACHED_SUCCESS
;
190 instance
= memcached_server_instance_fetch(ptr
, 0);
192 return MEMCACHED_NO_SERVERS
;
195 /* We just try the first host, and if it is down we return zero */
196 memcached_return_t rc
;
197 rc
= memcached_connect(instance
);
198 if (rc
!= MEMCACHED_SUCCESS
)
204 memcached_ternary_t enabled
;
205 enabled
= test_cork(instance
, true);
210 return ptr
->cached_errno
? MEMCACHED_ERRNO
: MEMCACHED_FAILURE
;
213 enabled
= test_cork(instance
, false);
215 if (enabled
== false) // Possible bug in OS?
217 memcached_quit_server(instance
, false); // We should reset everything on this error.
218 return MEMCACHED_ERRNO
; // Errno will be true because we will have already set it.
220 ptr
->flags
.cork
= true;
221 ptr
->flags
.tcp_nodelay
= true;
222 memcached_quit(ptr
); // We go on and reset the connections.
227 return MEMCACHED_NOT_SUPPORTED
;
231 case MEMCACHED_BEHAVIOR_MAX
:
233 /* Shouldn't get here */
234 WATCHPOINT_ASSERT(0);
235 return MEMCACHED_FAILURE
;
238 return MEMCACHED_SUCCESS
;
241 bool _is_auto_eject_host(const memcached_st
*ptr
)
243 return ptr
->flags
.auto_eject_hosts
;
246 uint64_t memcached_behavior_get(memcached_st
*ptr
,
247 const memcached_behavior_t flag
)
251 case MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS
:
252 return ptr
->number_of_replicas
;
253 case MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK
:
254 return ptr
->io_msg_watermark
;
255 case MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK
:
256 return ptr
->io_bytes_watermark
;
257 case MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH
:
258 return ptr
->io_key_prefetch
;
259 case MEMCACHED_BEHAVIOR_BINARY_PROTOCOL
:
260 return ptr
->flags
.binary_protocol
;
261 case MEMCACHED_BEHAVIOR_SUPPORT_CAS
:
262 return ptr
->flags
.support_cas
;
263 case MEMCACHED_BEHAVIOR_CACHE_LOOKUPS
:
264 return ptr
->flags
.use_cache_lookups
;
265 case MEMCACHED_BEHAVIOR_NO_BLOCK
:
266 return ptr
->flags
.no_block
;
267 case MEMCACHED_BEHAVIOR_BUFFER_REQUESTS
:
268 return ptr
->flags
.buffer_requests
;
269 case MEMCACHED_BEHAVIOR_USE_UDP
:
270 return ptr
->flags
.use_udp
;
271 case MEMCACHED_BEHAVIOR_TCP_NODELAY
:
272 return ptr
->flags
.tcp_nodelay
;
273 case MEMCACHED_BEHAVIOR_VERIFY_KEY
:
274 return ptr
->flags
.verify_key
;
275 case MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED
:
276 return ptr
->flags
.ketama_weighted
;
277 case MEMCACHED_BEHAVIOR_DISTRIBUTION
:
278 return ptr
->distribution
;
279 case MEMCACHED_BEHAVIOR_KETAMA
:
280 return (ptr
->distribution
== MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA
) ? (uint64_t) 1 : 0;
281 case MEMCACHED_BEHAVIOR_HASH
:
282 return hashkit_get_function(&ptr
->hashkit
);
283 case MEMCACHED_BEHAVIOR_KETAMA_HASH
:
284 return hashkit_get_function(&ptr
->distribution_hashkit
);
285 case MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
:
286 return ptr
->server_failure_limit
;
287 case MEMCACHED_BEHAVIOR_SORT_HOSTS
:
288 return ptr
->flags
.use_sort_hosts
;
289 case MEMCACHED_BEHAVIOR_POLL_TIMEOUT
:
290 return (uint64_t)ptr
->poll_timeout
;
291 case MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT
:
292 return (uint64_t)ptr
->connect_timeout
;
293 case MEMCACHED_BEHAVIOR_RETRY_TIMEOUT
:
294 return (uint64_t)ptr
->retry_timeout
;
295 case MEMCACHED_BEHAVIOR_SND_TIMEOUT
:
296 return (uint64_t)ptr
->snd_timeout
;
297 case MEMCACHED_BEHAVIOR_RCV_TIMEOUT
:
298 return (uint64_t)ptr
->rcv_timeout
;
299 case MEMCACHED_BEHAVIOR_TCP_KEEPIDLE
:
300 return (uint64_t)ptr
->tcp_keepidle
;
301 case MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
:
304 socklen_t sock_length
= sizeof(int);
305 memcached_server_write_instance_st instance
;
307 if (ptr
->send_size
!= -1) // If value is -1 then we are using the default
308 return (uint64_t) ptr
->send_size
;
310 instance
= memcached_server_instance_fetch(ptr
, 0);
312 if (instance
) // If we have an instance we test, otherwise we just set and pray
315 /* We just try the first host, and if it is down we return zero */
316 if ((memcached_connect(instance
)) != MEMCACHED_SUCCESS
)
319 if (getsockopt(instance
->fd
, SOL_SOCKET
,
320 SO_SNDBUF
, &sock_size
, &sock_length
))
321 return 0; /* Zero means error */
324 return (uint64_t) sock_size
;
326 case MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
:
329 socklen_t sock_length
= sizeof(int);
330 memcached_server_write_instance_st instance
;
332 if (ptr
->recv_size
!= -1) // If value is -1 then we are using the default
333 return (uint64_t) ptr
->recv_size
;
335 instance
= memcached_server_instance_fetch(ptr
, 0);
342 /* We just try the first host, and if it is down we return zero */
343 if ((memcached_connect(instance
)) != MEMCACHED_SUCCESS
)
346 if (getsockopt(instance
->fd
, SOL_SOCKET
,
347 SO_RCVBUF
, &sock_size
, &sock_length
))
348 return 0; /* Zero means error */
352 return (uint64_t) sock_size
;
354 case MEMCACHED_BEHAVIOR_USER_DATA
:
355 return MEMCACHED_FAILURE
;
356 case MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY
:
357 return ptr
->flags
.hash_with_prefix_key
;
358 case MEMCACHED_BEHAVIOR_NOREPLY
:
359 return ptr
->flags
.no_reply
;
360 case MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS
:
361 return ptr
->flags
.auto_eject_hosts
;
362 case MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ
:
363 return ptr
->flags
.randomize_replica_read
;
364 case MEMCACHED_BEHAVIOR_CORK
:
365 return ptr
->flags
.cork
;
366 case MEMCACHED_BEHAVIOR_TCP_KEEPALIVE
:
367 return ptr
->flags
.tcp_keepalive
;
368 case MEMCACHED_BEHAVIOR_MAX
:
370 WATCHPOINT_ASSERT(0); /* Programming mistake if it gets this far */
378 memcached_return_t
memcached_behavior_set_distribution(memcached_st
*ptr
, memcached_server_distribution_t type
)
380 if (type
< MEMCACHED_DISTRIBUTION_CONSISTENT_MAX
)
382 ptr
->distribution
= type
;
383 run_distribution(ptr
);
387 return MEMCACHED_FAILURE
;
390 return MEMCACHED_SUCCESS
;
394 memcached_server_distribution_t
memcached_behavior_get_distribution(memcached_st
*ptr
)
396 return ptr
->distribution
;
399 memcached_return_t
memcached_behavior_set_key_hash(memcached_st
*ptr
, memcached_hash_t type
)
402 rc
= hashkit_set_function(&ptr
->hashkit
, (hashkit_hash_algorithm_t
)type
);
404 return rc
== HASHKIT_SUCCESS
? MEMCACHED_SUCCESS
: MEMCACHED_FAILURE
;
407 memcached_hash_t
memcached_behavior_get_key_hash(memcached_st
*ptr
)
409 return (memcached_hash_t
)hashkit_get_function(&ptr
->hashkit
);
412 memcached_return_t
memcached_behavior_set_distribution_hash(memcached_st
*ptr
, memcached_hash_t type
)
415 rc
= hashkit_set_function(&ptr
->distribution_hashkit
, (hashkit_hash_algorithm_t
)type
);
417 return rc
== HASHKIT_SUCCESS
? MEMCACHED_SUCCESS
: MEMCACHED_FAILURE
;
420 memcached_hash_t
memcached_behavior_get_distribution_hash(memcached_st
*ptr
)
422 return (memcached_hash_t
)hashkit_get_function(&ptr
->distribution_hashkit
);