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_DISTRIBUTION
:
91 return memcached_behavior_set_distribution(ptr
, (memcached_server_distribution_t
)data
);
92 case MEMCACHED_BEHAVIOR_KETAMA
:
96 (void)memcached_behavior_set_key_hash(ptr
, MEMCACHED_HASH_MD5
);
97 (void)memcached_behavior_set_distribution_hash(ptr
, MEMCACHED_HASH_MD5
);
98 (void)memcached_behavior_set_distribution(ptr
, MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA
);
102 (void)memcached_behavior_set_key_hash(ptr
, MEMCACHED_HASH_DEFAULT
);
103 (void)memcached_behavior_set_distribution_hash(ptr
, MEMCACHED_HASH_DEFAULT
);
104 (void)memcached_behavior_set_distribution(ptr
, MEMCACHED_DISTRIBUTION_MODULA
);
109 case MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED
:
111 (void)memcached_behavior_set_key_hash(ptr
, MEMCACHED_HASH_MD5
);
112 (void)memcached_behavior_set_distribution_hash(ptr
, MEMCACHED_HASH_MD5
);
113 ptr
->flags
.ketama_weighted
= set_flag(data
);
115 @note We try to keep the same distribution going. This should be deprecated and rewritten.
117 return memcached_behavior_set_distribution(ptr
, MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA
);
119 case MEMCACHED_BEHAVIOR_HASH
:
120 return memcached_behavior_set_key_hash(ptr
, (memcached_hash_t
)(data
));
121 case MEMCACHED_BEHAVIOR_KETAMA_HASH
:
122 return memcached_behavior_set_distribution_hash(ptr
, (memcached_hash_t
)(data
));
123 case MEMCACHED_BEHAVIOR_CACHE_LOOKUPS
:
124 ptr
->flags
.use_cache_lookups
= set_flag(data
);
127 case MEMCACHED_BEHAVIOR_VERIFY_KEY
:
128 if (ptr
->flags
.binary_protocol
)
129 return MEMCACHED_FAILURE
;
130 ptr
->flags
.verify_key
= set_flag(data
);
132 case MEMCACHED_BEHAVIOR_SORT_HOSTS
:
134 ptr
->flags
.use_sort_hosts
= set_flag(data
);
135 run_distribution(ptr
);
139 case MEMCACHED_BEHAVIOR_POLL_TIMEOUT
:
140 ptr
->poll_timeout
= (int32_t)data
;
142 case MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT
:
143 ptr
->connect_timeout
= (int32_t)data
;
145 case MEMCACHED_BEHAVIOR_RETRY_TIMEOUT
:
146 ptr
->retry_timeout
= (int32_t)data
;
148 case MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
:
149 ptr
->send_size
= (int32_t)data
;
152 case MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
:
153 ptr
->recv_size
= (int32_t)data
;
156 case MEMCACHED_BEHAVIOR_USER_DATA
:
157 return MEMCACHED_FAILURE
;
158 case MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY
:
159 ptr
->flags
.hash_with_prefix_key
= set_flag(data
);
161 case MEMCACHED_BEHAVIOR_NOREPLY
:
162 ptr
->flags
.no_reply
= set_flag(data
);
164 case MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS
:
165 ptr
->flags
.auto_eject_hosts
= set_flag(data
);
167 case MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ
:
168 srandom((uint32_t) time(NULL
));
169 ptr
->flags
.randomize_replica_read
= set_flag(data
);
171 case MEMCACHED_BEHAVIOR_CORK
:
173 memcached_server_write_instance_st instance
;
174 bool action
= set_flag(data
);
178 ptr
->flags
.cork
= set_flag(false);
179 return MEMCACHED_SUCCESS
;
182 instance
= memcached_server_instance_fetch(ptr
, 0);
184 return MEMCACHED_NO_SERVERS
;
187 /* We just try the first host, and if it is down we return zero */
188 memcached_return_t rc
;
189 rc
= memcached_connect(instance
);
190 if (rc
!= MEMCACHED_SUCCESS
)
196 memcached_ternary_t enabled
;
197 enabled
= test_cork(instance
, true);
202 return ptr
->cached_errno
? MEMCACHED_ERRNO
: MEMCACHED_FAILURE
;
205 enabled
= test_cork(instance
, false);
207 if (enabled
== false) // Possible bug in OS?
209 memcached_quit_server(instance
, false); // We should reset everything on this error.
210 return MEMCACHED_ERRNO
; // Errno will be true because we will have already set it.
212 ptr
->flags
.cork
= true;
213 ptr
->flags
.tcp_nodelay
= true;
214 memcached_quit(ptr
); // We go on and reset the connections.
219 return MEMCACHED_NOT_SUPPORTED
;
223 case MEMCACHED_BEHAVIOR_MAX
:
225 /* Shouldn't get here */
226 WATCHPOINT_ASSERT(0);
227 return MEMCACHED_FAILURE
;
230 return MEMCACHED_SUCCESS
;
233 inline bool _is_auto_eject_host(const memcached_st
*ptr
)
235 return ptr
->flags
.auto_eject_hosts
;
238 uint64_t memcached_behavior_get(memcached_st
*ptr
,
239 const memcached_behavior_t flag
)
243 case MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS
:
244 return ptr
->number_of_replicas
;
245 case MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK
:
246 return ptr
->io_msg_watermark
;
247 case MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK
:
248 return ptr
->io_bytes_watermark
;
249 case MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH
:
250 return ptr
->io_key_prefetch
;
251 case MEMCACHED_BEHAVIOR_BINARY_PROTOCOL
:
252 return ptr
->flags
.binary_protocol
;
253 case MEMCACHED_BEHAVIOR_SUPPORT_CAS
:
254 return ptr
->flags
.support_cas
;
255 case MEMCACHED_BEHAVIOR_CACHE_LOOKUPS
:
256 return ptr
->flags
.use_cache_lookups
;
257 case MEMCACHED_BEHAVIOR_NO_BLOCK
:
258 return ptr
->flags
.no_block
;
259 case MEMCACHED_BEHAVIOR_BUFFER_REQUESTS
:
260 return ptr
->flags
.buffer_requests
;
261 case MEMCACHED_BEHAVIOR_USE_UDP
:
262 return ptr
->flags
.use_udp
;
263 case MEMCACHED_BEHAVIOR_TCP_NODELAY
:
264 return ptr
->flags
.tcp_nodelay
;
265 case MEMCACHED_BEHAVIOR_VERIFY_KEY
:
266 return ptr
->flags
.verify_key
;
267 case MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED
:
268 return ptr
->flags
.ketama_weighted
;
269 case MEMCACHED_BEHAVIOR_DISTRIBUTION
:
270 return ptr
->distribution
;
271 case MEMCACHED_BEHAVIOR_KETAMA
:
272 return (ptr
->distribution
== MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA
) ? (uint64_t) 1 : 0;
273 case MEMCACHED_BEHAVIOR_HASH
:
274 return hashkit_get_function(&ptr
->hashkit
);
275 case MEMCACHED_BEHAVIOR_KETAMA_HASH
:
276 return hashkit_get_function(&ptr
->distribution_hashkit
);
277 case MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
:
278 return ptr
->server_failure_limit
;
279 case MEMCACHED_BEHAVIOR_SORT_HOSTS
:
280 return ptr
->flags
.use_sort_hosts
;
281 case MEMCACHED_BEHAVIOR_POLL_TIMEOUT
:
282 return (uint64_t)ptr
->poll_timeout
;
283 case MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT
:
284 return (uint64_t)ptr
->connect_timeout
;
285 case MEMCACHED_BEHAVIOR_RETRY_TIMEOUT
:
286 return (uint64_t)ptr
->retry_timeout
;
287 case MEMCACHED_BEHAVIOR_SND_TIMEOUT
:
288 return (uint64_t)ptr
->snd_timeout
;
289 case MEMCACHED_BEHAVIOR_RCV_TIMEOUT
:
290 return (uint64_t)ptr
->rcv_timeout
;
291 case MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
:
294 socklen_t sock_length
= sizeof(int);
295 memcached_server_write_instance_st instance
;
297 if (ptr
->send_size
!= -1) // If value is -1 then we are using the default
298 return (uint64_t) ptr
->send_size
;
300 instance
= memcached_server_instance_fetch(ptr
, 0);
302 if (instance
) // If we have an instance we test, otherwise we just set and pray
305 /* We just try the first host, and if it is down we return zero */
306 if ((memcached_connect(instance
)) != MEMCACHED_SUCCESS
)
309 if (getsockopt(instance
->fd
, SOL_SOCKET
,
310 SO_SNDBUF
, &sock_size
, &sock_length
))
311 return 0; /* Zero means error */
314 return (uint64_t) sock_size
;
316 case MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
:
319 socklen_t sock_length
= sizeof(int);
320 memcached_server_write_instance_st instance
;
322 if (ptr
->recv_size
!= -1) // If value is -1 then we are using the default
323 return (uint64_t) ptr
->recv_size
;
325 instance
= memcached_server_instance_fetch(ptr
, 0);
332 /* We just try the first host, and if it is down we return zero */
333 if ((memcached_connect(instance
)) != MEMCACHED_SUCCESS
)
336 if (getsockopt(instance
->fd
, SOL_SOCKET
,
337 SO_RCVBUF
, &sock_size
, &sock_length
))
338 return 0; /* Zero means error */
342 return (uint64_t) sock_size
;
344 case MEMCACHED_BEHAVIOR_USER_DATA
:
345 return MEMCACHED_FAILURE
;
346 case MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY
:
347 return ptr
->flags
.hash_with_prefix_key
;
348 case MEMCACHED_BEHAVIOR_NOREPLY
:
349 return ptr
->flags
.no_reply
;
350 case MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS
:
351 return ptr
->flags
.auto_eject_hosts
;
352 case MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ
:
353 return ptr
->flags
.randomize_replica_read
;
354 case MEMCACHED_BEHAVIOR_CORK
:
355 return ptr
->flags
.cork
;
356 case MEMCACHED_BEHAVIOR_MAX
:
358 WATCHPOINT_ASSERT(0); /* Programming mistake if it gets this far */
366 memcached_return_t
memcached_behavior_set_distribution(memcached_st
*ptr
, memcached_server_distribution_t type
)
368 if (type
< MEMCACHED_DISTRIBUTION_CONSISTENT_MAX
)
370 ptr
->distribution
= type
;
371 run_distribution(ptr
);
375 return MEMCACHED_FAILURE
;
378 return MEMCACHED_SUCCESS
;
382 memcached_server_distribution_t
memcached_behavior_get_distribution(memcached_st
*ptr
)
384 return ptr
->distribution
;
387 memcached_return_t
memcached_behavior_set_key_hash(memcached_st
*ptr
, memcached_hash_t type
)
390 rc
= hashkit_set_function(&ptr
->hashkit
, (hashkit_hash_algorithm_t
)type
);
392 return rc
== HASHKIT_SUCCESS
? MEMCACHED_SUCCESS
: MEMCACHED_FAILURE
;
395 memcached_hash_t
memcached_behavior_get_key_hash(memcached_st
*ptr
)
397 return (memcached_hash_t
)hashkit_get_function(&ptr
->hashkit
);
400 memcached_return_t
memcached_behavior_set_distribution_hash(memcached_st
*ptr
, memcached_hash_t type
)
403 rc
= hashkit_set_function(&ptr
->distribution_hashkit
, (hashkit_hash_algorithm_t
)type
);
405 return rc
== HASHKIT_SUCCESS
? MEMCACHED_SUCCESS
: MEMCACHED_FAILURE
;
408 memcached_hash_t
memcached_behavior_get_distribution_hash(memcached_st
*ptr
)
410 return (memcached_hash_t
)hashkit_get_function(&ptr
->distribution_hashkit
);