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;
24 static memcached_return_t
set_hash(memcached_hash_t
*store
, memcached_hash_t type
)
26 #ifndef HAVE_HSIEH_HASH
27 if (type
== MEMCACHED_HASH_HSIEH
)
28 return MEMCACHED_FAILURE
;
30 if (type
< MEMCACHED_HASH_MAX
)
36 return MEMCACHED_FAILURE
;
39 return MEMCACHED_SUCCESS
;
42 This function is used to modify the behavior of running client.
44 We quit all connections so we can reset the sockets.
47 memcached_return_t
memcached_behavior_set(memcached_st
*ptr
,
48 const memcached_behavior_t flag
,
53 case MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS
:
54 ptr
->number_of_replicas
= (uint32_t)data
;
56 case MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK
:
57 ptr
->io_msg_watermark
= (uint32_t) data
;
59 case MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK
:
60 ptr
->io_bytes_watermark
= (uint32_t)data
;
62 case MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH
:
63 ptr
->io_key_prefetch
= (uint32_t)data
;
65 case MEMCACHED_BEHAVIOR_SND_TIMEOUT
:
66 ptr
->snd_timeout
= (int32_t)data
;
68 case MEMCACHED_BEHAVIOR_RCV_TIMEOUT
:
69 ptr
->rcv_timeout
= (int32_t)data
;
71 case MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
:
72 ptr
->server_failure_limit
= (uint32_t)data
;
74 case MEMCACHED_BEHAVIOR_BINARY_PROTOCOL
:
77 ptr
->flags
.verify_key
= false;
79 ptr
->flags
.binary_protocol
= set_flag(data
);
81 case MEMCACHED_BEHAVIOR_SUPPORT_CAS
:
82 ptr
->flags
.support_cas
= set_flag(data
);
84 case MEMCACHED_BEHAVIOR_NO_BLOCK
:
85 ptr
->flags
.no_block
= set_flag(data
);
88 case MEMCACHED_BEHAVIOR_BUFFER_REQUESTS
:
89 ptr
->flags
.buffer_requests
= set_flag(data
);
92 case MEMCACHED_BEHAVIOR_USE_UDP
:
93 if (memcached_server_count(ptr
))
95 return MEMCACHED_FAILURE
;
97 ptr
->flags
.use_udp
= set_flag(data
);
100 ptr
->flags
.no_reply
= set_flag(data
);
103 case MEMCACHED_BEHAVIOR_TCP_NODELAY
:
104 ptr
->flags
.tcp_nodelay
= set_flag(data
);
107 case MEMCACHED_BEHAVIOR_DISTRIBUTION
:
108 return memcached_behavior_set_distribution(ptr
, (memcached_server_distribution_t
)data
);
109 case MEMCACHED_BEHAVIOR_KETAMA
:
113 (void)memcached_behavior_set_key_hash(ptr
, MEMCACHED_HASH_MD5
);
114 (void)memcached_behavior_set_distribution_hash(ptr
, MEMCACHED_HASH_MD5
);
115 (void)memcached_behavior_set_distribution(ptr
, MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA
);
119 (void)memcached_behavior_set_key_hash(ptr
, MEMCACHED_HASH_DEFAULT
);
120 (void)memcached_behavior_set_distribution_hash(ptr
, MEMCACHED_HASH_DEFAULT
);
121 (void)memcached_behavior_set_distribution(ptr
, MEMCACHED_DISTRIBUTION_MODULA
);
126 case MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED
:
128 (void)memcached_behavior_set_key_hash(ptr
, MEMCACHED_HASH_MD5
);
129 (void)memcached_behavior_set_distribution_hash(ptr
, MEMCACHED_HASH_MD5
);
130 ptr
->flags
.ketama_weighted
= set_flag(data
);
132 @note We try to keep the same distribution going. This should be deprecated and rewritten.
134 return memcached_behavior_set_distribution(ptr
, MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA
);
136 case MEMCACHED_BEHAVIOR_HASH
:
137 return memcached_behavior_set_key_hash(ptr
, (memcached_hash_t
)(data
));
138 case MEMCACHED_BEHAVIOR_KETAMA_HASH
:
139 return memcached_behavior_set_distribution_hash(ptr
, (memcached_hash_t
)(data
));
140 case MEMCACHED_BEHAVIOR_CACHE_LOOKUPS
:
141 ptr
->flags
.use_cache_lookups
= set_flag(data
);
144 case MEMCACHED_BEHAVIOR_VERIFY_KEY
:
145 if (ptr
->flags
.binary_protocol
)
146 return MEMCACHED_FAILURE
;
147 ptr
->flags
.verify_key
= set_flag(data
);
149 case MEMCACHED_BEHAVIOR_SORT_HOSTS
:
151 ptr
->flags
.use_sort_hosts
= set_flag(data
);
152 run_distribution(ptr
);
156 case MEMCACHED_BEHAVIOR_POLL_TIMEOUT
:
157 ptr
->poll_timeout
= (int32_t)data
;
159 case MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT
:
160 ptr
->connect_timeout
= (int32_t)data
;
162 case MEMCACHED_BEHAVIOR_RETRY_TIMEOUT
:
163 ptr
->retry_timeout
= (int32_t)data
;
165 case MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
:
166 ptr
->send_size
= (int32_t)data
;
169 case MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
:
170 ptr
->recv_size
= (int32_t)data
;
173 case MEMCACHED_BEHAVIOR_USER_DATA
:
174 return MEMCACHED_FAILURE
;
175 case MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY
:
176 ptr
->flags
.hash_with_prefix_key
= set_flag(data
);
178 case MEMCACHED_BEHAVIOR_NOREPLY
:
179 ptr
->flags
.no_reply
= set_flag(data
);
181 case MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS
:
182 ptr
->flags
.auto_eject_hosts
= set_flag(data
);
184 case MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ
:
185 srandom((uint32_t) time(NULL
));
186 ptr
->flags
.randomize_replica_read
= set_flag(data
);
188 case MEMCACHED_BEHAVIOR_CORK
:
190 memcached_server_instance_st
*instance
;
191 bool action
= set_flag(data
);
195 ptr
->flags
.cork
= set_flag(false);
196 return MEMCACHED_SUCCESS
;
199 instance
= memcached_server_instance_fetch(ptr
, 0);
201 return MEMCACHED_NO_SERVERS
;
204 /* We just try the first host, and if it is down we return zero */
205 memcached_return_t rc
;
206 rc
= memcached_connect(instance
);
207 if (rc
!= MEMCACHED_SUCCESS
)
213 memcached_ternary_t enabled
;
214 enabled
= cork_switch(instance
, true);
219 return ptr
->cached_errno
? MEMCACHED_ERRNO
: MEMCACHED_FAILURE
;
222 enabled
= cork_switch(instance
, false);
224 if (enabled
== false) // Possible bug in OS?
226 memcached_quit_server(instance
, false); // We should reset everything on this error.
227 return MEMCACHED_ERRNO
; // Errno will be true because we will have already set it.
229 ptr
->flags
.cork
= true;
230 ptr
->flags
.tcp_nodelay
= true;
235 return MEMCACHED_NOT_SUPPORTED
;
239 case MEMCACHED_BEHAVIOR_MAX
:
241 /* Shouldn't get here */
242 WATCHPOINT_ASSERT(0);
243 return MEMCACHED_FAILURE
;
246 return MEMCACHED_SUCCESS
;
249 uint64_t memcached_behavior_get(memcached_st
*ptr
,
250 const memcached_behavior_t flag
)
254 case MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS
:
255 return ptr
->number_of_replicas
;
256 case MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK
:
257 return ptr
->io_msg_watermark
;
258 case MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK
:
259 return ptr
->io_bytes_watermark
;
260 case MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH
:
261 return ptr
->io_key_prefetch
;
262 case MEMCACHED_BEHAVIOR_BINARY_PROTOCOL
:
263 return ptr
->flags
.binary_protocol
;
264 case MEMCACHED_BEHAVIOR_SUPPORT_CAS
:
265 return ptr
->flags
.support_cas
;
266 case MEMCACHED_BEHAVIOR_CACHE_LOOKUPS
:
267 return ptr
->flags
.use_cache_lookups
;
268 case MEMCACHED_BEHAVIOR_NO_BLOCK
:
269 return ptr
->flags
.no_block
;
270 case MEMCACHED_BEHAVIOR_BUFFER_REQUESTS
:
271 return ptr
->flags
.buffer_requests
;
272 case MEMCACHED_BEHAVIOR_USE_UDP
:
273 return ptr
->flags
.use_udp
;
274 case MEMCACHED_BEHAVIOR_TCP_NODELAY
:
275 return ptr
->flags
.tcp_nodelay
;
276 case MEMCACHED_BEHAVIOR_VERIFY_KEY
:
277 return ptr
->flags
.verify_key
;
278 case MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED
:
279 return ptr
->flags
.ketama_weighted
;
280 case MEMCACHED_BEHAVIOR_DISTRIBUTION
:
281 return ptr
->distribution
;
282 case MEMCACHED_BEHAVIOR_KETAMA
:
283 return (ptr
->distribution
== MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA
) ? (uint64_t) 1 : 0;
284 case MEMCACHED_BEHAVIOR_HASH
:
286 case MEMCACHED_BEHAVIOR_KETAMA_HASH
:
287 return ptr
->distribution_hash
;
288 case MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
:
289 return ptr
->server_failure_limit
;
290 case MEMCACHED_BEHAVIOR_SORT_HOSTS
:
291 return ptr
->flags
.use_sort_hosts
;
292 case MEMCACHED_BEHAVIOR_POLL_TIMEOUT
:
293 return (uint64_t)ptr
->poll_timeout
;
294 case MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT
:
295 return (uint64_t)ptr
->connect_timeout
;
296 case MEMCACHED_BEHAVIOR_RETRY_TIMEOUT
:
297 return (uint64_t)ptr
->retry_timeout
;
298 case MEMCACHED_BEHAVIOR_SND_TIMEOUT
:
299 return (uint64_t)ptr
->snd_timeout
;
300 case MEMCACHED_BEHAVIOR_RCV_TIMEOUT
:
301 return (uint64_t)ptr
->rcv_timeout
;
302 case MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
:
305 socklen_t sock_length
= sizeof(int);
306 memcached_server_instance_st
*instance
;
308 if (ptr
->send_size
!= -1) // If value is -1 then we are using the default
309 return (uint64_t) ptr
->send_size
;
311 instance
= memcached_server_instance_fetch(ptr
, 0);
313 if (instance
) // If we have an instance we test, otherwise we just set and pray
316 /* We just try the first host, and if it is down we return zero */
317 if ((memcached_connect(instance
)) != MEMCACHED_SUCCESS
)
320 if (getsockopt(instance
->fd
, SOL_SOCKET
,
321 SO_SNDBUF
, &sock_size
, &sock_length
))
322 return 0; /* Zero means error */
325 return (uint64_t) sock_size
;
327 case MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
:
330 socklen_t sock_length
= sizeof(int);
331 memcached_server_instance_st
*instance
;
333 if (ptr
->recv_size
!= -1) // If value is -1 then we are using the default
334 return (uint64_t) ptr
->recv_size
;
336 instance
= memcached_server_instance_fetch(ptr
, 0);
343 /* We just try the first host, and if it is down we return zero */
344 if ((memcached_connect(instance
)) != MEMCACHED_SUCCESS
)
347 if (getsockopt(instance
->fd
, SOL_SOCKET
,
348 SO_RCVBUF
, &sock_size
, &sock_length
))
349 return 0; /* Zero means error */
353 return (uint64_t) sock_size
;
355 case MEMCACHED_BEHAVIOR_USER_DATA
:
356 return MEMCACHED_FAILURE
;
357 case MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY
:
358 return ptr
->flags
.hash_with_prefix_key
;
359 case MEMCACHED_BEHAVIOR_NOREPLY
:
360 return ptr
->flags
.no_reply
;
361 case MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS
:
362 return ptr
->flags
.auto_eject_hosts
;
363 case MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ
:
364 return ptr
->flags
.randomize_replica_read
;
365 case MEMCACHED_BEHAVIOR_CORK
:
366 return ptr
->flags
.cork
;
367 case MEMCACHED_BEHAVIOR_MAX
:
369 WATCHPOINT_ASSERT(0); /* Programming mistake if it gets this far */
377 memcached_return_t
memcached_behavior_set_distribution(memcached_st
*ptr
, memcached_server_distribution_t type
)
379 if (type
< MEMCACHED_DISTRIBUTION_CONSISTENT_MAX
)
381 ptr
->distribution
= type
;
382 run_distribution(ptr
);
386 return MEMCACHED_FAILURE
;
389 return MEMCACHED_SUCCESS
;
393 memcached_server_distribution_t
memcached_behavior_get_distribution(memcached_st
*ptr
)
395 return ptr
->distribution
;
398 memcached_return_t
memcached_behavior_set_key_hash(memcached_st
*ptr
, memcached_hash_t type
)
400 return set_hash(&ptr
->hash
, type
);
403 memcached_hash_t
memcached_behavior_get_key_hash(memcached_st
*ptr
)
408 memcached_return_t
memcached_behavior_set_distribution_hash(memcached_st
*ptr
, memcached_hash_t type
)
410 return set_hash(&ptr
->distribution_hash
, type
);
413 memcached_hash_t
memcached_behavior_get_distribution_hash(memcached_st
*ptr
)
415 return ptr
->distribution_hash
;