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>
40 static memcached_return_t
textual_read_one_response(memcached_server_write_instance_st ptr
,
41 char *buffer
, size_t buffer_length
,
42 memcached_result_st
*result
);
43 static memcached_return_t
binary_read_one_response(memcached_server_write_instance_st ptr
,
44 char *buffer
, size_t buffer_length
,
45 memcached_result_st
*result
);
47 memcached_return_t
memcached_read_one_response(memcached_server_write_instance_st ptr
,
48 char *buffer
, size_t buffer_length
,
49 memcached_result_st
*result
)
51 memcached_server_response_decrement(ptr
);
55 memcached_st
*root
= (memcached_st
*)ptr
->root
;
56 result
= &root
->result
;
59 memcached_return_t rc
;
60 if (ptr
->root
->flags
.binary_protocol
)
61 rc
= binary_read_one_response(ptr
, buffer
, buffer_length
, result
);
63 rc
= textual_read_one_response(ptr
, buffer
, buffer_length
, result
);
65 unlikely(rc
== MEMCACHED_UNKNOWN_READ_FAILURE
||
66 rc
== MEMCACHED_PROTOCOL_ERROR
||
67 rc
== MEMCACHED_CLIENT_ERROR
||
68 rc
== MEMCACHED_MEMORY_ALLOCATION_FAILURE
)
69 memcached_io_reset(ptr
);
74 memcached_return_t
memcached_response(memcached_server_write_instance_st ptr
,
75 char *buffer
, size_t buffer_length
,
76 memcached_result_st
*result
)
78 /* We may have old commands in the buffer not set, first purge */
79 if ((ptr
->root
->flags
.no_block
) && (memcached_is_processing_input(ptr
->root
) == false))
81 (void)memcached_io_write(ptr
, NULL
, 0, true);
85 * The previous implementation purged all pending requests and just
86 * returned the last one. Purge all pending messages to ensure backwards
89 if (ptr
->root
->flags
.binary_protocol
== false)
91 while (memcached_server_response_count(ptr
) > 1)
93 memcached_return_t rc
= memcached_read_one_response(ptr
, buffer
, buffer_length
, result
);
95 unlikely (rc
!= MEMCACHED_END
&&
96 rc
!= MEMCACHED_STORED
&&
97 rc
!= MEMCACHED_SUCCESS
&&
98 rc
!= MEMCACHED_STAT
&&
99 rc
!= MEMCACHED_DELETED
&&
100 rc
!= MEMCACHED_NOTFOUND
&&
101 rc
!= MEMCACHED_NOTSTORED
&&
102 rc
!= MEMCACHED_DATA_EXISTS
)
107 return memcached_read_one_response(ptr
, buffer
, buffer_length
, result
);
110 static memcached_return_t
textual_value_fetch(memcached_server_write_instance_st ptr
,
112 memcached_result_st
*result
)
114 memcached_return_t rc
= MEMCACHED_SUCCESS
;
121 ssize_t read_length
= 0;
122 memcached_return_t rrc
;
124 if (ptr
->root
->flags
.use_udp
)
125 return MEMCACHED_NOT_SUPPORTED
;
127 WATCHPOINT_ASSERT(ptr
->root
);
128 end_ptr
= buffer
+ MEMCACHED_DEFAULT_COMMAND_SIZE
;
130 memcached_result_reset(result
);
133 string_ptr
+= 6; /* "VALUE " */
136 /* We load the key */
139 size_t prefix_length
;
141 key
= result
->item_key
;
142 result
->key_length
= 0;
144 for (prefix_length
= memcached_array_size(ptr
->root
->prefix_key
); !(iscntrl(*string_ptr
) || isspace(*string_ptr
)) ; string_ptr
++)
146 if (prefix_length
== 0)
150 result
->key_length
++;
155 result
->item_key
[result
->key_length
]= 0;
158 if (end_ptr
== string_ptr
)
161 /* Flags fetch move past space */
163 if (end_ptr
== string_ptr
)
165 for (next_ptr
= string_ptr
; isdigit(*string_ptr
); string_ptr
++);
166 result
->item_flags
= (uint32_t) strtoul(next_ptr
, &string_ptr
, 10);
168 if (end_ptr
== string_ptr
)
171 /* Length fetch move past space*/
173 if (end_ptr
== string_ptr
)
176 for (next_ptr
= string_ptr
; isdigit(*string_ptr
); string_ptr
++);
177 value_length
= (size_t)strtoull(next_ptr
, &string_ptr
, 10);
179 if (end_ptr
== string_ptr
)
183 if (*string_ptr
== '\r')
185 /* Skip past the \r\n */
191 for (next_ptr
= string_ptr
; isdigit(*string_ptr
); string_ptr
++);
192 result
->item_cas
= strtoull(next_ptr
, &string_ptr
, 10);
195 if (end_ptr
< string_ptr
)
198 /* We add two bytes so that we can walk the \r\n */
199 rc
= memcached_string_check(&result
->value
, value_length
+2);
200 if (rc
!= MEMCACHED_SUCCESS
)
203 return MEMCACHED_MEMORY_ALLOCATION_FAILURE
;
206 value_ptr
= memcached_string_value_mutable(&result
->value
);
208 We read the \r\n into the string since not doing so is more
209 cycles then the waster of memory to do so.
211 We are null terminating through, which will most likely make
212 some people lazy about using the return length.
214 to_read
= (value_length
) + 2;
215 rrc
= memcached_io_read(ptr
, value_ptr
, to_read
, &read_length
);
216 if (rrc
!= MEMCACHED_SUCCESS
)
219 if (read_length
!= (ssize_t
)(value_length
+ 2))
224 /* This next bit blows the API, but this is internal....*/
227 char_ptr
= memcached_string_value_mutable(&result
->value
);;
228 char_ptr
[value_length
]= 0;
229 char_ptr
[value_length
+ 1]= 0;
230 memcached_string_set_length(&result
->value
, value_length
);
233 return MEMCACHED_SUCCESS
;
236 memcached_io_reset(ptr
);
238 return MEMCACHED_PARTIAL_READ
;
241 static memcached_return_t
textual_read_one_response(memcached_server_write_instance_st ptr
,
242 char *buffer
, size_t buffer_length
,
243 memcached_result_st
*result
)
245 memcached_return_t rc
= memcached_io_readline(ptr
, buffer
, buffer_length
);
246 if (rc
!= MEMCACHED_SUCCESS
)
251 case 'V': /* VALUE || VERSION */
252 if (buffer
[1] == 'A') /* VALUE */
254 /* We add back in one because we will need to search for END */
255 memcached_server_response_increment(ptr
);
256 return textual_value_fetch(ptr
, buffer
, result
);
258 else if (buffer
[1] == 'E') /* VERSION */
260 return MEMCACHED_SUCCESS
;
264 WATCHPOINT_STRING(buffer
);
265 return MEMCACHED_UNKNOWN_READ_FAILURE
;
268 return MEMCACHED_SUCCESS
;
269 case 'S': /* STORED STATS SERVER_ERROR */
271 if (buffer
[2] == 'A') /* STORED STATS */
273 memcached_server_response_increment(ptr
);
274 return MEMCACHED_STAT
;
276 else if (buffer
[1] == 'E') /* SERVER_ERROR */
279 char *startptr
= buffer
+ 13, *endptr
= startptr
;
281 while (*endptr
!= '\r' && *endptr
!= '\n') endptr
++;
284 Yes, we could make this "efficent" but to do that we would need
285 to maintain more state for the size of the buffer. Why waste
286 memory in the struct, which is important, for something that
287 rarely should happen?
289 rel_ptr
= (char *)libmemcached_realloc(ptr
->root
,
290 ptr
->cached_server_error
,
291 (size_t) (endptr
- startptr
+ 1));
295 /* If we happened to have some memory, we just null it since we don't know the size */
296 if (ptr
->cached_server_error
)
297 ptr
->cached_server_error
[0]= 0;
298 return MEMCACHED_SERVER_ERROR
;
300 ptr
->cached_server_error
= rel_ptr
;
302 memcpy(ptr
->cached_server_error
, startptr
, (size_t) (endptr
- startptr
));
303 ptr
->cached_server_error
[endptr
- startptr
]= 0;
304 return MEMCACHED_SERVER_ERROR
;
306 else if (buffer
[1] == 'T')
307 return MEMCACHED_STORED
;
310 WATCHPOINT_STRING(buffer
);
311 return MEMCACHED_UNKNOWN_READ_FAILURE
;
314 case 'D': /* DELETED */
315 return MEMCACHED_DELETED
;
316 case 'N': /* NOT_FOUND */
318 if (buffer
[4] == 'F')
319 return MEMCACHED_NOTFOUND
;
320 else if (buffer
[4] == 'S')
321 return MEMCACHED_NOTSTORED
;
324 WATCHPOINT_STRING(buffer
);
325 return MEMCACHED_UNKNOWN_READ_FAILURE
;
328 case 'E': /* PROTOCOL ERROR or END */
330 if (buffer
[1] == 'N')
331 return MEMCACHED_END
;
332 else if (buffer
[1] == 'R')
333 return MEMCACHED_PROTOCOL_ERROR
;
334 else if (buffer
[1] == 'X')
335 return MEMCACHED_DATA_EXISTS
;
338 WATCHPOINT_STRING(buffer
);
339 return MEMCACHED_UNKNOWN_READ_FAILURE
;
343 case 'I': /* CLIENT ERROR */
344 /* We add back in one because we will need to search for END */
345 memcached_server_response_increment(ptr
);
346 return MEMCACHED_ITEM
;
347 case 'C': /* CLIENT ERROR */
348 return MEMCACHED_CLIENT_ERROR
;
351 unsigned long long auto_return_value
;
353 if (sscanf(buffer
, "%llu", &auto_return_value
) == 1)
354 return MEMCACHED_SUCCESS
;
356 WATCHPOINT_STRING(buffer
);
357 return MEMCACHED_UNKNOWN_READ_FAILURE
;
364 static memcached_return_t
binary_read_one_response(memcached_server_write_instance_st ptr
,
365 char *buffer
, size_t buffer_length
,
366 memcached_result_st
*result
)
368 memcached_return_t rc
;
369 protocol_binary_response_header header
;
371 if ((rc
= memcached_safe_read(ptr
, &header
.bytes
, sizeof(header
.bytes
))) != MEMCACHED_SUCCESS
)
373 WATCHPOINT_ERROR(rc
);
377 if (header
.response
.magic
!= PROTOCOL_BINARY_RES
)
379 return MEMCACHED_PROTOCOL_ERROR
;
383 ** Convert the header to host local endian!
385 header
.response
.keylen
= ntohs(header
.response
.keylen
);
386 header
.response
.status
= ntohs(header
.response
.status
);
387 header
.response
.bodylen
= ntohl(header
.response
.bodylen
);
388 header
.response
.cas
= ntohll(header
.response
.cas
);
389 uint32_t bodylen
= header
.response
.bodylen
;
391 if (header
.response
.status
== PROTOCOL_BINARY_RESPONSE_SUCCESS
||
392 header
.response
.status
== PROTOCOL_BINARY_RESPONSE_AUTH_CONTINUE
)
394 switch (header
.response
.opcode
)
396 case PROTOCOL_BINARY_CMD_GETKQ
:
398 * We didn't increment the response counter for the GETKQ packet
399 * (only the final NOOP), so we need to increment the counter again.
401 memcached_server_response_increment(ptr
);
403 case PROTOCOL_BINARY_CMD_GETK
:
405 uint16_t keylen
= header
.response
.keylen
;
406 memcached_result_reset(result
);
407 result
->item_cas
= header
.response
.cas
;
409 if ((rc
= memcached_safe_read(ptr
, &result
->item_flags
, sizeof (result
->item_flags
))) != MEMCACHED_SUCCESS
)
411 WATCHPOINT_ERROR(rc
);
412 return MEMCACHED_UNKNOWN_READ_FAILURE
;
415 result
->item_flags
= ntohl(result
->item_flags
);
416 bodylen
-= header
.response
.extlen
;
418 result
->key_length
= keylen
;
419 if ((rc
= memcached_safe_read(ptr
, result
->item_key
, keylen
)) != MEMCACHED_SUCCESS
)
421 WATCHPOINT_ERROR(rc
);
422 return MEMCACHED_UNKNOWN_READ_FAILURE
;
426 if (memcached_string_check(&result
->value
,
427 bodylen
) != MEMCACHED_SUCCESS
)
428 return MEMCACHED_MEMORY_ALLOCATION_FAILURE
;
430 char *vptr
= memcached_string_value_mutable(&result
->value
);
431 if ((rc
= memcached_safe_read(ptr
, vptr
, bodylen
)) != MEMCACHED_SUCCESS
)
433 WATCHPOINT_ERROR(rc
);
434 return MEMCACHED_UNKNOWN_READ_FAILURE
;
437 memcached_string_set_length(&result
->value
, bodylen
);
440 case PROTOCOL_BINARY_CMD_INCREMENT
:
441 case PROTOCOL_BINARY_CMD_DECREMENT
:
443 if (bodylen
!= sizeof(uint64_t) || buffer_length
!= sizeof(uint64_t))
444 return MEMCACHED_PROTOCOL_ERROR
;
446 WATCHPOINT_ASSERT(bodylen
== buffer_length
);
448 if ((rc
= memcached_safe_read(ptr
, &val
, sizeof(val
))) != MEMCACHED_SUCCESS
)
450 WATCHPOINT_ERROR(rc
);
451 return MEMCACHED_UNKNOWN_READ_FAILURE
;
455 memcpy(buffer
, &val
, sizeof(val
));
458 case PROTOCOL_BINARY_CMD_SASL_LIST_MECHS
:
459 case PROTOCOL_BINARY_CMD_VERSION
:
461 memset(buffer
, 0, buffer_length
);
462 if (bodylen
>= buffer_length
)
464 /* not enough space in buffer.. should not happen... */
465 return MEMCACHED_UNKNOWN_READ_FAILURE
;
467 else if ((rc
= memcached_safe_read(ptr
, buffer
, bodylen
)) != MEMCACHED_SUCCESS
)
469 WATCHPOINT_ERROR(rc
);
470 return MEMCACHED_UNKNOWN_READ_FAILURE
;
474 case PROTOCOL_BINARY_CMD_FLUSH
:
475 case PROTOCOL_BINARY_CMD_QUIT
:
476 case PROTOCOL_BINARY_CMD_SET
:
477 case PROTOCOL_BINARY_CMD_ADD
:
478 case PROTOCOL_BINARY_CMD_REPLACE
:
479 case PROTOCOL_BINARY_CMD_APPEND
:
480 case PROTOCOL_BINARY_CMD_PREPEND
:
481 case PROTOCOL_BINARY_CMD_DELETE
:
483 WATCHPOINT_ASSERT(bodylen
== 0);
484 return MEMCACHED_SUCCESS
;
486 case PROTOCOL_BINARY_CMD_NOOP
:
488 WATCHPOINT_ASSERT(bodylen
== 0);
489 return MEMCACHED_END
;
491 case PROTOCOL_BINARY_CMD_STAT
:
495 return MEMCACHED_END
;
497 else if (bodylen
+ 1 > buffer_length
)
499 /* not enough space in buffer.. should not happen... */
500 return MEMCACHED_UNKNOWN_READ_FAILURE
;
504 size_t keylen
= header
.response
.keylen
;
505 memset(buffer
, 0, buffer_length
);
506 if ((rc
= memcached_safe_read(ptr
, buffer
, keylen
)) != MEMCACHED_SUCCESS
||
507 (rc
= memcached_safe_read(ptr
, buffer
+ keylen
+ 1, bodylen
- keylen
)) != MEMCACHED_SUCCESS
)
509 WATCHPOINT_ERROR(rc
);
510 return MEMCACHED_UNKNOWN_READ_FAILURE
;
516 case PROTOCOL_BINARY_CMD_SASL_AUTH
:
517 case PROTOCOL_BINARY_CMD_SASL_STEP
:
519 memcached_result_reset(result
);
520 result
->item_cas
= header
.response
.cas
;
522 if (memcached_string_check(&result
->value
,
523 bodylen
) != MEMCACHED_SUCCESS
)
524 return MEMCACHED_MEMORY_ALLOCATION_FAILURE
;
526 char *vptr
= memcached_string_value_mutable(&result
->value
);
527 if ((rc
= memcached_safe_read(ptr
, vptr
, bodylen
)) != MEMCACHED_SUCCESS
)
529 WATCHPOINT_ERROR(rc
);
530 return MEMCACHED_UNKNOWN_READ_FAILURE
;
533 memcached_string_set_length(&result
->value
, bodylen
);
538 /* Command not implemented yet! */
539 WATCHPOINT_ASSERT(0);
540 return MEMCACHED_PROTOCOL_ERROR
;
544 else if (header
.response
.bodylen
)
546 /* What should I do with the error message??? just discard it for now */
547 char hole
[SMALL_STRING_LEN
];
550 size_t nr
= (bodylen
> SMALL_STRING_LEN
) ? SMALL_STRING_LEN
: bodylen
;
551 if ((rc
= memcached_safe_read(ptr
, hole
, nr
)) != MEMCACHED_SUCCESS
)
553 WATCHPOINT_ERROR(rc
);
554 return MEMCACHED_UNKNOWN_READ_FAILURE
;
556 bodylen
-= (uint32_t) nr
;
559 /* This might be an error from one of the quiet commands.. if
560 * so, just throw it away and get the next one. What about creating
561 * a callback to the user with the error information?
563 switch (header
.response
.opcode
)
565 case PROTOCOL_BINARY_CMD_SETQ
:
566 case PROTOCOL_BINARY_CMD_ADDQ
:
567 case PROTOCOL_BINARY_CMD_REPLACEQ
:
568 case PROTOCOL_BINARY_CMD_APPENDQ
:
569 case PROTOCOL_BINARY_CMD_PREPENDQ
:
570 return binary_read_one_response(ptr
, buffer
, buffer_length
, result
);
576 rc
= MEMCACHED_SUCCESS
;
577 unlikely(header
.response
.status
!= 0)
578 switch (header
.response
.status
)
580 case PROTOCOL_BINARY_RESPONSE_KEY_ENOENT
:
581 rc
= MEMCACHED_NOTFOUND
;
583 case PROTOCOL_BINARY_RESPONSE_KEY_EEXISTS
:
584 rc
= MEMCACHED_DATA_EXISTS
;
586 case PROTOCOL_BINARY_RESPONSE_NOT_STORED
:
587 rc
= MEMCACHED_NOTSTORED
;
589 case PROTOCOL_BINARY_RESPONSE_E2BIG
:
592 case PROTOCOL_BINARY_RESPONSE_ENOMEM
:
593 rc
= MEMCACHED_MEMORY_ALLOCATION_FAILURE
;
595 case PROTOCOL_BINARY_RESPONSE_AUTH_CONTINUE
:
596 rc
= MEMCACHED_AUTH_CONTINUE
;
598 case PROTOCOL_BINARY_RESPONSE_AUTH_ERROR
:
599 rc
= MEMCACHED_AUTH_FAILURE
;
601 case PROTOCOL_BINARY_RESPONSE_EINVAL
:
602 case PROTOCOL_BINARY_RESPONSE_UNKNOWN_COMMAND
:
604 /* @todo fix the error mappings */
605 rc
= MEMCACHED_PROTOCOL_ERROR
;