Remove cork from being optional, just use it as we need it.
[awesomized/libmemcached] / libmemcached / behavior.c
1 /* LibMemcached
2 * Copyright (C) 2006-2009 Brian Aker
3 * All rights reserved.
4 *
5 * Use and distribution licensed under the BSD license. See
6 * the COPYING file in the parent directory for full text.
7 *
8 * Summary: Change the behavior of the memcached connection.
9 *
10 */
11
12 #include "common.h"
13 #include <time.h>
14 #include <sys/types.h>
15
16 static bool set_flag(uint64_t data)
17 {
18 // Wordy :)
19 return data ? true : false;
20 }
21
22 /*
23 This function is used to modify the behavior of running client.
24
25 We quit all connections so we can reset the sockets.
26 */
27
28 memcached_return_t memcached_behavior_set(memcached_st *ptr,
29 const memcached_behavior_t flag,
30 uint64_t data)
31 {
32 switch (flag)
33 {
34 case MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS:
35 ptr->number_of_replicas= (uint32_t)data;
36 break;
37 case MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK:
38 ptr->io_msg_watermark= (uint32_t) data;
39 break;
40 case MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK:
41 ptr->io_bytes_watermark= (uint32_t)data;
42 break;
43 case MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH:
44 ptr->io_key_prefetch = (uint32_t)data;
45 break;
46 case MEMCACHED_BEHAVIOR_SND_TIMEOUT:
47 ptr->snd_timeout= (int32_t)data;
48 break;
49 case MEMCACHED_BEHAVIOR_RCV_TIMEOUT:
50 ptr->rcv_timeout= (int32_t)data;
51 break;
52 case MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT:
53 ptr->server_failure_limit= (uint32_t)data;
54 break;
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
57 if (data)
58 {
59 ptr->flags.verify_key= false;
60 }
61 ptr->flags.binary_protocol= set_flag(data);
62 break;
63 case MEMCACHED_BEHAVIOR_SUPPORT_CAS:
64 ptr->flags.support_cas= set_flag(data);
65 break;
66 case MEMCACHED_BEHAVIOR_NO_BLOCK:
67 ptr->flags.no_block= set_flag(data);
68 memcached_quit(ptr);
69 break;
70 case MEMCACHED_BEHAVIOR_BUFFER_REQUESTS:
71 ptr->flags.buffer_requests= set_flag(data);
72 memcached_quit(ptr);
73 break;
74 case MEMCACHED_BEHAVIOR_USE_UDP:
75 if (memcached_server_count(ptr))
76 {
77 return MEMCACHED_FAILURE;
78 }
79 ptr->flags.use_udp= set_flag(data);
80 if (data)
81 {
82 ptr->flags.no_reply= set_flag(data);
83 }
84 break;
85 case MEMCACHED_BEHAVIOR_TCP_NODELAY:
86 ptr->flags.tcp_nodelay= set_flag(data);
87 memcached_quit(ptr);
88 break;
89 case MEMCACHED_BEHAVIOR_TCP_KEEPALIVE:
90 ptr->flags.tcp_keepalive= set_flag(data);
91 memcached_quit(ptr);
92 break;
93 case MEMCACHED_BEHAVIOR_DISTRIBUTION:
94 return memcached_behavior_set_distribution(ptr, (memcached_server_distribution_t)data);
95 case MEMCACHED_BEHAVIOR_KETAMA:
96 {
97 if (data) // Turn on
98 return memcached_behavior_set_distribution(ptr, MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA);
99
100 return memcached_behavior_set_distribution(ptr, MEMCACHED_DISTRIBUTION_MODULA);
101 }
102 case MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED:
103 {
104 (void)memcached_behavior_set_key_hash(ptr, MEMCACHED_HASH_MD5);
105 (void)memcached_behavior_set_distribution_hash(ptr, MEMCACHED_HASH_MD5);
106 ptr->flags.ketama_weighted= set_flag(data);
107 /**
108 @note We try to keep the same distribution going. This should be deprecated and rewritten.
109 */
110 return memcached_behavior_set_distribution(ptr, MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA);
111 }
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);
118 memcached_quit(ptr);
119 break;
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);
125 break;
126 case MEMCACHED_BEHAVIOR_SORT_HOSTS:
127 {
128 ptr->flags.use_sort_hosts= set_flag(data);
129 run_distribution(ptr);
130
131 break;
132 }
133 case MEMCACHED_BEHAVIOR_POLL_TIMEOUT:
134 ptr->poll_timeout= (int32_t)data;
135 break;
136 case MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT:
137 ptr->connect_timeout= (int32_t)data;
138 break;
139 case MEMCACHED_BEHAVIOR_RETRY_TIMEOUT:
140 ptr->retry_timeout= (int32_t)data;
141 break;
142 case MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE:
143 ptr->send_size= (int32_t)data;
144 memcached_quit(ptr);
145 break;
146 case MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE:
147 ptr->recv_size= (int32_t)data;
148 memcached_quit(ptr);
149 break;
150 case MEMCACHED_BEHAVIOR_TCP_KEEPIDLE:
151 ptr->tcp_keepidle= (uint32_t)data;
152 memcached_quit(ptr);
153 break;
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);
159 break;
160 case MEMCACHED_BEHAVIOR_NOREPLY:
161 ptr->flags.no_reply= set_flag(data);
162 break;
163 case MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS:
164 ptr->flags.auto_eject_hosts= set_flag(data);
165 break;
166 case MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ:
167 srandom((uint32_t) time(NULL));
168 ptr->flags.randomize_replica_read= set_flag(data);
169 break;
170 case MEMCACHED_BEHAVIOR_CORK:
171 {
172 #ifdef HAVE_MSG_MORE
173 break;
174 #else
175 return memcached_set_error_string(ptr, MEMCACHED_NOT_SUPPORTED,
176 memcached_string_with_size("MEMCACHED_BEHAVIOR_CORK is not supported on this platform."));
177 #endif
178 }
179 break;
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:
184 default:
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()"));
189 }
190
191 return MEMCACHED_SUCCESS;
192 }
193
194 bool _is_auto_eject_host(const memcached_st *ptr)
195 {
196 return ptr->flags.auto_eject_hosts;
197 }
198
199 uint64_t memcached_behavior_get(memcached_st *ptr,
200 const memcached_behavior_t flag)
201 {
202 switch (flag)
203 {
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->flags.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:
255 {
256 int sock_size= 0;
257 socklen_t sock_length= sizeof(int);
258 memcached_server_write_instance_st instance;
259
260 if (ptr->send_size != -1) // If value is -1 then we are using the default
261 return (uint64_t) ptr->send_size;
262
263 instance= memcached_server_instance_fetch(ptr, 0);
264
265 if (instance) // If we have an instance we test, otherwise we just set and pray
266 {
267 /* REFACTOR */
268 /* We just try the first host, and if it is down we return zero */
269 if ((memcached_connect(instance)) != MEMCACHED_SUCCESS)
270 {
271 return 0;
272 }
273
274 if (memcached_io_wait_for_write(instance) != MEMCACHED_SUCCESS)
275 {
276 return 0;
277 }
278
279 if (getsockopt(instance->fd, SOL_SOCKET, SO_SNDBUF, &sock_size, &sock_length) < 0)
280 {
281 memcached_set_errno(ptr, errno, NULL);
282 return 0; /* Zero means error */
283 }
284 }
285
286 return (uint64_t) sock_size;
287 }
288 case MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE:
289 {
290 int sock_size= 0;
291 socklen_t sock_length= sizeof(int);
292 memcached_server_write_instance_st instance;
293
294 if (ptr->recv_size != -1) // If value is -1 then we are using the default
295 return (uint64_t) ptr->recv_size;
296
297 instance= memcached_server_instance_fetch(ptr, 0);
298
299 /**
300 @note REFACTOR
301 */
302 if (instance)
303 {
304 /* We just try the first host, and if it is down we return zero */
305 if ((memcached_connect(instance)) != MEMCACHED_SUCCESS)
306 {
307 return 0;
308 }
309
310 if (memcached_io_wait_for_write(instance) != MEMCACHED_SUCCESS)
311 {
312 return 0;
313 }
314
315 if (getsockopt(instance->fd, SOL_SOCKET, SO_RCVBUF, &sock_size, &sock_length) < 0)
316 {
317 memcached_set_errno(ptr, errno, NULL);
318 return 0; /* Zero means error */
319 }
320
321 }
322
323 return (uint64_t) sock_size;
324 }
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:
337 #ifdef HAVE_MSG_MORE
338 return true;
339 #else
340 return false;
341 #endif
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:
347 default:
348 WATCHPOINT_ASSERT(0); /* Programming mistake if it gets this far */
349 return 0;
350 }
351
352 /* NOTREACHED */
353 }
354
355
356 memcached_return_t memcached_behavior_set_distribution(memcached_st *ptr, memcached_server_distribution_t type)
357 {
358 if (type < MEMCACHED_DISTRIBUTION_CONSISTENT_MAX)
359 {
360 ptr->distribution= type;
361 run_distribution(ptr);
362 return MEMCACHED_SUCCESS;
363 }
364
365 return memcached_set_error_string(ptr, MEMCACHED_INVALID_ARGUMENTS,
366 memcached_string_with_size("Invalid memcached_server_distribution_t"));
367 }
368
369
370 memcached_server_distribution_t memcached_behavior_get_distribution(memcached_st *ptr)
371 {
372 return ptr->distribution;
373 }
374
375 memcached_return_t memcached_behavior_set_key_hash(memcached_st *ptr, memcached_hash_t type)
376 {
377 if (hashkit_set_function(&ptr->hashkit, (hashkit_hash_algorithm_t)type) == HASHKIT_SUCCESS)
378 return MEMCACHED_SUCCESS;
379
380 return memcached_set_error_string(ptr, MEMCACHED_INVALID_ARGUMENTS,
381 memcached_string_with_size("Invalid memcached_hash_t()"));
382 }
383
384 memcached_hash_t memcached_behavior_get_key_hash(memcached_st *ptr)
385 {
386 return (memcached_hash_t)hashkit_get_function(&ptr->hashkit);
387 }
388
389 memcached_return_t memcached_behavior_set_distribution_hash(memcached_st *ptr, memcached_hash_t type)
390 {
391 if (hashkit_set_function(&ptr->distribution_hashkit, (hashkit_hash_algorithm_t)type) == HASHKIT_SUCCESS)
392 return MEMCACHED_SUCCESS;
393
394 return memcached_set_error_string(ptr, MEMCACHED_INVALID_ARGUMENTS,
395 memcached_string_with_size("Invalid memcached_hash_t()"));
396 }
397
398 memcached_hash_t memcached_behavior_get_distribution_hash(memcached_st *ptr)
399 {
400 return (memcached_hash_t)hashkit_get_function(&ptr->distribution_hashkit);
401 }
402
403 const char *libmemcached_string_behavior(const memcached_behavior_t flag)
404 {
405 switch (flag)
406 {
407 case MEMCACHED_BEHAVIOR_NO_BLOCK: return "MEMCACHED_BEHAVIOR_NO_BLOCK";
408 case MEMCACHED_BEHAVIOR_TCP_NODELAY: return "MEMCACHED_BEHAVIOR_TCP_NODELAY";
409 case MEMCACHED_BEHAVIOR_HASH: return "MEMCACHED_BEHAVIOR_HASH";
410 case MEMCACHED_BEHAVIOR_KETAMA: return "MEMCACHED_BEHAVIOR_KETAMA";
411 case MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE: return "MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE";
412 case MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE: return "MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE";
413 case MEMCACHED_BEHAVIOR_CACHE_LOOKUPS: return "MEMCACHED_BEHAVIOR_CACHE_LOOKUPS";
414 case MEMCACHED_BEHAVIOR_SUPPORT_CAS: return "MEMCACHED_BEHAVIOR_SUPPORT_CAS";
415 case MEMCACHED_BEHAVIOR_POLL_TIMEOUT: return "MEMCACHED_BEHAVIOR_POLL_TIMEOUT";
416 case MEMCACHED_BEHAVIOR_DISTRIBUTION: return "MEMCACHED_BEHAVIOR_DISTRIBUTION";
417 case MEMCACHED_BEHAVIOR_BUFFER_REQUESTS: return "MEMCACHED_BEHAVIOR_BUFFER_REQUESTS";
418 case MEMCACHED_BEHAVIOR_USER_DATA: return "MEMCACHED_BEHAVIOR_USER_DATA";
419 case MEMCACHED_BEHAVIOR_SORT_HOSTS: return "MEMCACHED_BEHAVIOR_SORT_HOSTS";
420 case MEMCACHED_BEHAVIOR_VERIFY_KEY: return "MEMCACHED_BEHAVIOR_VERIFY_KEY";
421 case MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT: return "MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT";
422 case MEMCACHED_BEHAVIOR_RETRY_TIMEOUT: return "MEMCACHED_BEHAVIOR_RETRY_TIMEOUT";
423 case MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED: return "MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED";
424 case MEMCACHED_BEHAVIOR_KETAMA_HASH: return "MEMCACHED_BEHAVIOR_KETAMA_HASH";
425 case MEMCACHED_BEHAVIOR_BINARY_PROTOCOL: return "MEMCACHED_BEHAVIOR_BINARY_PROTOCOL";
426 case MEMCACHED_BEHAVIOR_SND_TIMEOUT: return "MEMCACHED_BEHAVIOR_SND_TIMEOUT";
427 case MEMCACHED_BEHAVIOR_RCV_TIMEOUT: return "MEMCACHED_BEHAVIOR_RCV_TIMEOUT";
428 case MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT: return "MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT";
429 case MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK: return "MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK";
430 case MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK: return "MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK";
431 case MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH: return "MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH";
432 case MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY: return "MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY";
433 case MEMCACHED_BEHAVIOR_NOREPLY: return "MEMCACHED_BEHAVIOR_NOREPLY";
434 case MEMCACHED_BEHAVIOR_USE_UDP: return "MEMCACHED_BEHAVIOR_USE_UDP";
435 case MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS: return "MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS";
436 case MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS: return "MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS";
437 case MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ: return "MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ";
438 case MEMCACHED_BEHAVIOR_CORK: return "MEMCACHED_BEHAVIOR_CORK";
439 case MEMCACHED_BEHAVIOR_TCP_KEEPALIVE: return "MEMCACHED_BEHAVIOR_TCP_KEEPALIVE";
440 case MEMCACHED_BEHAVIOR_TCP_KEEPIDLE: return "MEMCACHED_BEHAVIOR_TCP_KEEPIDLE";
441 case MEMCACHED_BEHAVIOR_LOAD_FROM_FILE: return "MEMCACHED_BEHAVIOR_LOAD_FROM_FILE";
442 default:
443 case MEMCACHED_BEHAVIOR_MAX: return "INVALID memcached_behavior_t";
444 }
445 }
446
447 const char *libmemcached_string_distribution(const memcached_server_distribution_t flag)
448 {
449 switch (flag)
450 {
451 case MEMCACHED_DISTRIBUTION_MODULA: return "MEMCACHED_DISTRIBUTION_MODULA";
452 case MEMCACHED_DISTRIBUTION_CONSISTENT: return "MEMCACHED_DISTRIBUTION_CONSISTENT";
453 case MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA: return "MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA";
454 case MEMCACHED_DISTRIBUTION_RANDOM: return "MEMCACHED_DISTRIBUTION_RANDOM";
455 case MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA_SPY: return "MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA_SPY";
456 default:
457 case MEMCACHED_DISTRIBUTION_CONSISTENT_MAX: return "INVALID memcached_server_distribution_t";
458 }
459 }