1 /* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
5 * Copyright (C) 2011 Data Differential, http://datadifferential.com/
6 * Copyright (C) 2006-2009 Brian Aker All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * * Redistributions in binary form must reproduce the above
16 * copyright notice, this list of conditions and the following disclaimer
17 * in the documentation and/or other materials provided with the
20 * * The names of its contributors may not be used to endorse or
21 * promote products derived from this software without specific prior
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 #include <libmemcached/common.h>
41 What happens if no servers exist?
43 char *memcached_get(memcached_st
*ptr
, const char *key
,
47 memcached_return_t
*error
)
49 return memcached_get_by_key(ptr
, NULL
, 0, key
, key_length
, value_length
,
53 static memcached_return_t
memcached_mget_by_key_real(memcached_st
*ptr
,
54 const char *group_key
,
55 size_t group_key_length
,
56 const char * const *keys
,
57 const size_t *key_length
,
58 size_t number_of_keys
,
61 char *memcached_get_by_key(memcached_st
*ptr
,
62 const char *group_key
,
63 size_t group_key_length
,
64 const char *key
, size_t key_length
,
67 memcached_return_t
*error
)
69 memcached_return_t unused
;
78 query_id
= ptr
->query_id
;
82 *error
= memcached_mget_by_key_real(ptr
, group_key
, group_key_length
,
83 (const char * const *)&key
, &key_length
,
87 assert_msg(ptr
->query_id
== query_id
+1, "Programmer error, the query_id was not incremented.");
90 if (memcached_failed(*error
))
94 if (memcached_has_current_error(*ptr
)) // Find the most accurate error
96 *error
= memcached_last_error(ptr
);
108 char *value
= memcached_fetch(ptr
, NULL
, NULL
,
109 value_length
, flags
, error
);
110 assert_msg(ptr
->query_id
== query_id
+1, "Programmer error, the query_id was not incremented.");
112 /* This is for historical reasons */
113 if (*error
== MEMCACHED_END
)
114 *error
= MEMCACHED_NOTFOUND
;
118 if (ptr
->get_key_failure
&& *error
== MEMCACHED_NOTFOUND
)
120 memcached_result_reset(&ptr
->result
);
121 memcached_return_t rc
= ptr
->get_key_failure(ptr
, key
, key_length
, &ptr
->result
);
123 /* On all failure drop to returning NULL */
124 if (rc
== MEMCACHED_SUCCESS
|| rc
== MEMCACHED_BUFFERED
)
126 if (rc
== MEMCACHED_BUFFERED
)
128 uint64_t latch
; /* We use latch to track the state of the original socket */
129 latch
= memcached_behavior_get(ptr
, MEMCACHED_BEHAVIOR_BUFFER_REQUESTS
);
131 memcached_behavior_set(ptr
, MEMCACHED_BEHAVIOR_BUFFER_REQUESTS
, 1);
133 rc
= memcached_set(ptr
, key
, key_length
,
134 (memcached_result_value(&ptr
->result
)),
135 (memcached_result_length(&ptr
->result
)),
137 (memcached_result_flags(&ptr
->result
)));
139 if (rc
== MEMCACHED_BUFFERED
&& latch
== 0)
141 memcached_behavior_set(ptr
, MEMCACHED_BEHAVIOR_BUFFER_REQUESTS
, 0);
146 rc
= memcached_set(ptr
, key
, key_length
,
147 (memcached_result_value(&ptr
->result
)),
148 (memcached_result_length(&ptr
->result
)),
150 (memcached_result_flags(&ptr
->result
)));
153 if (rc
== MEMCACHED_SUCCESS
|| rc
== MEMCACHED_BUFFERED
)
156 *value_length
= memcached_result_length(&ptr
->result
);
157 *flags
= memcached_result_flags(&ptr
->result
);
158 return memcached_string_take_value(&ptr
->result
.value
);
162 assert_msg(ptr
->query_id
== query_id
+1, "Programmer error, the query_id was not incremented.");
168 uint32_t dummy_flags
;
169 memcached_return_t dummy_error
;
171 char *dummy_value
= memcached_fetch(ptr
, NULL
, NULL
,
172 &dummy_length
, &dummy_flags
,
174 assert_msg(dummy_value
== 0, "memcached_fetch() returned additional values beyond the single get it expected");
175 assert_msg(dummy_length
== 0, "memcached_fetch() returned additional values beyond the single get it expected");
176 assert_msg(ptr
->query_id
== query_id
+1, "Programmer error, the query_id was not incremented.");
181 memcached_return_t
memcached_mget(memcached_st
*ptr
,
182 const char * const *keys
,
183 const size_t *key_length
,
184 size_t number_of_keys
)
186 return memcached_mget_by_key(ptr
, NULL
, 0, keys
, key_length
, number_of_keys
);
189 static memcached_return_t
binary_mget_by_key(memcached_st
*ptr
,
190 uint32_t master_server_key
,
191 bool is_group_key_set
,
192 const char * const *keys
,
193 const size_t *key_length
,
194 size_t number_of_keys
,
197 static memcached_return_t
memcached_mget_by_key_real(memcached_st
*ptr
,
198 const char *group_key
,
199 size_t group_key_length
,
200 const char * const *keys
,
201 const size_t *key_length
,
202 size_t number_of_keys
,
205 bool failures_occured_in_sending
= false;
206 const char *get_command
= "get ";
207 uint8_t get_command_length
= 4;
208 unsigned int master_server_key
= (unsigned int)-1; /* 0 is a valid server id! */
210 memcached_return_t rc
;
211 if (memcached_failed(rc
= initialize_query(ptr
, true)))
216 if (memcached_is_udp(ptr
))
218 return memcached_set_error(*ptr
, MEMCACHED_NOT_SUPPORTED
, MEMCACHED_AT
);
221 LIBMEMCACHED_MEMCACHED_MGET_START();
223 if (number_of_keys
== 0)
225 return memcached_set_error(*ptr
, MEMCACHED_NOTFOUND
, MEMCACHED_AT
, memcached_literal_param("number_of_keys was zero"));
228 if (memcached_failed(memcached_key_test(*ptr
, keys
, key_length
, number_of_keys
)))
230 return memcached_set_error(*ptr
, MEMCACHED_BAD_KEY_PROVIDED
, MEMCACHED_AT
, memcached_literal_param("A bad key value was provided"));
233 bool is_group_key_set
= false;
234 if (group_key
and group_key_length
)
236 if (memcached_failed(memcached_key_test(*ptr
, (const char * const *)&group_key
, &group_key_length
, 1)))
238 return memcached_set_error(*ptr
, MEMCACHED_BAD_KEY_PROVIDED
, MEMCACHED_AT
, memcached_literal_param("A bad group key was provided."));
241 master_server_key
= memcached_generate_hash_with_redistribution(ptr
, group_key
, group_key_length
);
242 is_group_key_set
= true;
246 Here is where we pay for the non-block API. We need to remove any data sitting
247 in the queue before we start our get.
249 It might be optimum to bounce the connection if count > some number.
251 for (uint32_t x
= 0; x
< memcached_server_count(ptr
); x
++)
253 memcached_server_write_instance_st instance
=
254 memcached_server_instance_fetch(ptr
, x
);
256 if (memcached_server_response_count(instance
))
258 char buffer
[MEMCACHED_DEFAULT_COMMAND_SIZE
];
260 if (ptr
->flags
.no_block
)
262 memcached_io_write(instance
);
265 while(memcached_server_response_count(instance
))
267 (void)memcached_response(instance
, buffer
, MEMCACHED_DEFAULT_COMMAND_SIZE
, &ptr
->result
);
272 if (ptr
->flags
.binary_protocol
)
274 return binary_mget_by_key(ptr
, master_server_key
, is_group_key_set
, keys
,
275 key_length
, number_of_keys
, mget_mode
);
278 if (ptr
->flags
.support_cas
)
280 get_command
= "gets ";
281 get_command_length
= 5;
285 If a server fails we warn about errors and start all over with sending keys
288 WATCHPOINT_ASSERT(rc
== MEMCACHED_SUCCESS
);
289 size_t hosts_connected
= 0;
290 for (uint32_t x
= 0; x
< number_of_keys
; x
++)
292 memcached_server_write_instance_st instance
;
295 if (is_group_key_set
)
297 server_key
= master_server_key
;
301 server_key
= memcached_generate_hash_with_redistribution(ptr
, keys
[x
], key_length
[x
]);
304 instance
= memcached_server_instance_fetch(ptr
, server_key
);
306 libmemcached_io_vector_st vector
[]=
308 { get_command
, get_command_length
},
309 { memcached_array_string(ptr
->_namespace
), memcached_array_size(ptr
->_namespace
) },
310 { keys
[x
], key_length
[x
] },
311 { memcached_literal_param(" ") }
315 if (memcached_server_response_count(instance
) == 0)
317 rc
= memcached_connect(instance
);
319 if (memcached_failed(rc
))
321 memcached_set_error(*instance
, rc
, MEMCACHED_AT
);
326 if ((memcached_io_writev(instance
, vector
, 4, false)) == -1)
328 failures_occured_in_sending
= true;
331 WATCHPOINT_ASSERT(instance
->cursor_active
== 0);
332 memcached_server_response_increment(instance
);
333 WATCHPOINT_ASSERT(instance
->cursor_active
== 1);
337 if ((memcached_io_writev(instance
, (vector
+ 1), 3, false)) == -1)
339 memcached_server_response_reset(instance
);
340 failures_occured_in_sending
= true;
346 if (hosts_connected
== 0)
348 LIBMEMCACHED_MEMCACHED_MGET_END();
350 if (memcached_failed(rc
))
353 return memcached_set_error(*ptr
, MEMCACHED_NO_SERVERS
, MEMCACHED_AT
);
358 Should we muddle on if some servers are dead?
360 bool success_happened
= false;
361 for (uint32_t x
= 0; x
< memcached_server_count(ptr
); x
++)
363 memcached_server_write_instance_st instance
=
364 memcached_server_instance_fetch(ptr
, x
);
366 if (memcached_server_response_count(instance
))
368 /* We need to do something about non-connnected hosts in the future */
369 if ((memcached_io_write(instance
, "\r\n", 2, true)) == -1)
371 failures_occured_in_sending
= true;
375 success_happened
= true;
380 LIBMEMCACHED_MEMCACHED_MGET_END();
382 if (failures_occured_in_sending
&& success_happened
)
384 return MEMCACHED_SOME_ERRORS
;
387 if (success_happened
)
388 return MEMCACHED_SUCCESS
;
390 return MEMCACHED_FAILURE
; // Complete failure occurred
393 memcached_return_t
memcached_mget_by_key(memcached_st
*ptr
,
394 const char *group_key
,
395 size_t group_key_length
,
396 const char * const *keys
,
397 const size_t *key_length
,
398 size_t number_of_keys
)
400 return memcached_mget_by_key_real(ptr
, group_key
, group_key_length
, keys
,
401 key_length
, number_of_keys
, true);
404 memcached_return_t
memcached_mget_execute(memcached_st
*ptr
,
405 const char * const *keys
,
406 const size_t *key_length
,
407 size_t number_of_keys
,
408 memcached_execute_fn
*callback
,
410 unsigned int number_of_callbacks
)
412 return memcached_mget_execute_by_key(ptr
, NULL
, 0, keys
, key_length
,
413 number_of_keys
, callback
,
414 context
, number_of_callbacks
);
417 memcached_return_t
memcached_mget_execute_by_key(memcached_st
*ptr
,
418 const char *group_key
,
419 size_t group_key_length
,
420 const char * const *keys
,
421 const size_t *key_length
,
422 size_t number_of_keys
,
423 memcached_execute_fn
*callback
,
425 unsigned int number_of_callbacks
)
427 memcached_return_t rc
;
428 if (memcached_failed(rc
= initialize_query(ptr
, false)))
433 if (memcached_is_udp(ptr
))
435 return memcached_set_error(*ptr
, MEMCACHED_NOT_SUPPORTED
, MEMCACHED_AT
);
438 if (memcached_is_binary(ptr
) == false)
440 return MEMCACHED_NOT_SUPPORTED
;
443 memcached_callback_st
*original_callbacks
= ptr
->callbacks
;
444 memcached_callback_st cb
= {
451 rc
= memcached_mget_by_key(ptr
, group_key
, group_key_length
, keys
,
452 key_length
, number_of_keys
);
453 ptr
->callbacks
= original_callbacks
;
457 static memcached_return_t
simple_binary_mget(memcached_st
*ptr
,
458 uint32_t master_server_key
,
459 bool is_group_key_set
,
460 const char * const *keys
,
461 const size_t *key_length
,
462 size_t number_of_keys
, bool mget_mode
)
464 memcached_return_t rc
= MEMCACHED_NOTFOUND
;
466 bool flush
= (number_of_keys
== 1);
469 If a server fails we warn about errors and start all over with sending keys
472 for (uint32_t x
= 0; x
< number_of_keys
; ++x
)
476 if (is_group_key_set
)
478 server_key
= master_server_key
;
482 server_key
= memcached_generate_hash_with_redistribution(ptr
, keys
[x
], key_length
[x
]);
485 memcached_server_write_instance_st instance
= memcached_server_instance_fetch(ptr
, server_key
);
487 if (memcached_server_response_count(instance
) == 0)
489 rc
= memcached_connect(instance
);
490 if (memcached_failed(rc
))
496 protocol_binary_request_getk request
= { }; //= {.bytes= {0}};
497 request
.message
.header
.request
.magic
= PROTOCOL_BINARY_REQ
;
499 request
.message
.header
.request
.opcode
= PROTOCOL_BINARY_CMD_GETKQ
;
501 request
.message
.header
.request
.opcode
= PROTOCOL_BINARY_CMD_GETK
;
503 memcached_return_t vk
;
504 vk
= memcached_validate_key_length(key_length
[x
],
505 ptr
->flags
.binary_protocol
);
506 unlikely (vk
!= MEMCACHED_SUCCESS
)
510 memcached_io_reset(instance
);
516 request
.message
.header
.request
.keylen
= htons((uint16_t)(key_length
[x
] + memcached_array_size(ptr
->_namespace
)));
517 request
.message
.header
.request
.datatype
= PROTOCOL_BINARY_RAW_BYTES
;
518 request
.message
.header
.request
.bodylen
= htonl((uint32_t)( key_length
[x
] + memcached_array_size(ptr
->_namespace
)));
520 libmemcached_io_vector_st vector
[]=
522 { request
.bytes
, sizeof(request
.bytes
) },
523 { memcached_array_string(ptr
->_namespace
), memcached_array_size(ptr
->_namespace
) },
524 { keys
[x
], key_length
[x
] }
527 if (memcached_io_writev(instance
, vector
, 3, flush
) == -1)
529 memcached_server_response_reset(instance
);
530 rc
= MEMCACHED_SOME_ERRORS
;
534 /* We just want one pending response per server */
535 memcached_server_response_reset(instance
);
536 memcached_server_response_increment(instance
);
537 if ((x
> 0 && x
== ptr
->io_key_prefetch
) && memcached_flush_buffers(ptr
) != MEMCACHED_SUCCESS
)
539 rc
= MEMCACHED_SOME_ERRORS
;
546 Send a noop command to flush the buffers
548 protocol_binary_request_noop request
= {}; //= {.bytes= {0}};
549 request
.message
.header
.request
.magic
= PROTOCOL_BINARY_REQ
;
550 request
.message
.header
.request
.opcode
= PROTOCOL_BINARY_CMD_NOOP
;
551 request
.message
.header
.request
.datatype
= PROTOCOL_BINARY_RAW_BYTES
;
553 for (uint32_t x
= 0; x
< memcached_server_count(ptr
); ++x
)
555 memcached_server_write_instance_st instance
= memcached_server_instance_fetch(ptr
, x
);
557 if (memcached_server_response_count(instance
))
559 if (memcached_io_write(instance
) == false)
561 memcached_server_response_reset(instance
);
562 memcached_io_reset(instance
);
563 rc
= MEMCACHED_SOME_ERRORS
;
566 if (memcached_io_write(instance
, request
.bytes
,
567 sizeof(request
.bytes
), true) == -1)
569 memcached_server_response_reset(instance
);
570 memcached_io_reset(instance
);
571 rc
= MEMCACHED_SOME_ERRORS
;
581 static memcached_return_t
replication_binary_mget(memcached_st
*ptr
,
584 const char *const *keys
,
585 const size_t *key_length
,
586 size_t number_of_keys
)
588 memcached_return_t rc
= MEMCACHED_NOTFOUND
;
590 uint64_t randomize_read
= memcached_behavior_get(ptr
, MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ
);
593 start
= (uint32_t)random() % (uint32_t)(ptr
->number_of_replicas
+ 1);
595 /* Loop for each replica */
596 for (uint32_t replica
= 0; replica
<= ptr
->number_of_replicas
; ++replica
)
600 for (uint32_t x
= 0; x
< number_of_keys
; ++x
)
602 if (hash
[x
] == memcached_server_count(ptr
))
603 continue; /* Already successfully sent */
605 uint32_t server
= hash
[x
] + replica
;
607 /* In case of randomized reads */
608 if (randomize_read
&& ((server
+ start
) <= (hash
[x
] + ptr
->number_of_replicas
)))
611 while (server
>= memcached_server_count(ptr
))
613 server
-= memcached_server_count(ptr
);
616 if (dead_servers
[server
])
621 memcached_server_write_instance_st instance
= memcached_server_instance_fetch(ptr
, server
);
623 if (memcached_server_response_count(instance
) == 0)
625 rc
= memcached_connect(instance
);
627 if (memcached_failed(rc
))
629 memcached_io_reset(instance
);
630 dead_servers
[server
]= true;
636 protocol_binary_request_getk request
= {};
637 request
.message
.header
.request
.magic
= PROTOCOL_BINARY_REQ
;
638 request
.message
.header
.request
.opcode
= PROTOCOL_BINARY_CMD_GETK
;
639 request
.message
.header
.request
.keylen
= htons((uint16_t)(key_length
[x
] + memcached_array_size(ptr
->_namespace
)));
640 request
.message
.header
.request
.datatype
= PROTOCOL_BINARY_RAW_BYTES
;
641 request
.message
.header
.request
.bodylen
= htonl((uint32_t)(key_length
[x
] + memcached_array_size(ptr
->_namespace
)));
644 * We need to disable buffering to actually know that the request was
645 * successfully sent to the server (so that we should expect a result
646 * back). It would be nice to do this in buffered mode, but then it
647 * would be complex to handle all error situations if we got to send
648 * some of the messages, and then we failed on writing out some others
649 * and we used the callback interface from memcached_mget_execute so
650 * that we might have processed some of the responses etc. For now,
651 * just make sure we work _correctly_
653 libmemcached_io_vector_st vector
[]=
655 { request
.bytes
, sizeof(request
.bytes
) },
656 { memcached_array_string(ptr
->_namespace
), memcached_array_size(ptr
->_namespace
) },
657 { keys
[x
], key_length
[x
] }
660 if (memcached_io_writev(instance
, vector
, 3, true) == -1)
662 memcached_io_reset(instance
);
663 dead_servers
[server
]= true;
668 memcached_server_response_increment(instance
);
669 hash
[x
]= memcached_server_count(ptr
);
681 static memcached_return_t
binary_mget_by_key(memcached_st
*ptr
,
682 uint32_t master_server_key
,
683 bool is_group_key_set
,
684 const char * const *keys
,
685 const size_t *key_length
,
686 size_t number_of_keys
,
689 if (ptr
->number_of_replicas
== 0)
691 return simple_binary_mget(ptr
, master_server_key
, is_group_key_set
,
692 keys
, key_length
, number_of_keys
, mget_mode
);
695 uint32_t* hash
= libmemcached_xvalloc(ptr
, number_of_keys
, uint32_t);
696 bool* dead_servers
= libmemcached_xcalloc(ptr
, memcached_server_count(ptr
), bool);
698 if (hash
== NULL
|| dead_servers
== NULL
)
700 libmemcached_free(ptr
, hash
);
701 libmemcached_free(ptr
, dead_servers
);
702 return MEMCACHED_MEMORY_ALLOCATION_FAILURE
;
705 if (is_group_key_set
)
707 for (size_t x
= 0; x
< number_of_keys
; x
++)
709 hash
[x
]= master_server_key
;
714 for (size_t x
= 0; x
< number_of_keys
; x
++)
716 hash
[x
]= memcached_generate_hash_with_redistribution(ptr
, keys
[x
], key_length
[x
]);
720 memcached_return_t rc
= replication_binary_mget(ptr
, hash
, dead_servers
, keys
,
721 key_length
, number_of_keys
);
723 WATCHPOINT_IFERROR(rc
);
724 libmemcached_free(ptr
, hash
);
725 libmemcached_free(ptr
, dead_servers
);
727 return MEMCACHED_SUCCESS
;