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.
39 #include <libmemcached/common.h>
41 enum memcached_storage_action_t
{
51 static inline const char *storage_op_string(memcached_storage_action_t verb
)
77 static inline uint8_t can_by_encrypted(const memcached_storage_action_t verb
)
95 static inline uint8_t get_com_code(const memcached_storage_action_t verb
, const bool reply
)
102 return PROTOCOL_BINARY_CMD_SETQ
;
105 return PROTOCOL_BINARY_CMD_ADDQ
;
107 case CAS_OP
: /* FALLTHROUGH */
109 return PROTOCOL_BINARY_CMD_REPLACEQ
;
112 return PROTOCOL_BINARY_CMD_APPENDQ
;
115 return PROTOCOL_BINARY_CMD_PREPENDQ
;
125 return PROTOCOL_BINARY_CMD_ADD
;
127 case CAS_OP
: /* FALLTHROUGH */
129 return PROTOCOL_BINARY_CMD_REPLACE
;
132 return PROTOCOL_BINARY_CMD_APPEND
;
135 return PROTOCOL_BINARY_CMD_PREPEND
;
138 return PROTOCOL_BINARY_CMD_SET
;
141 static memcached_return_t
memcached_send_binary(memcached_st
*ptr
,
142 memcached_server_write_instance_st server
,
145 const size_t key_length
,
147 const size_t value_length
,
148 const time_t expiration
,
149 const uint32_t flags
,
153 memcached_storage_action_t verb
)
155 protocol_binary_request_set request
= {};
156 size_t send_length
= sizeof(request
.bytes
);
158 request
.message
.header
.request
.magic
= PROTOCOL_BINARY_REQ
;
159 request
.message
.header
.request
.opcode
= get_com_code(verb
, reply
);
160 request
.message
.header
.request
.keylen
= htons((uint16_t)(key_length
+ memcached_array_size(ptr
->_namespace
)));
161 request
.message
.header
.request
.datatype
= PROTOCOL_BINARY_RAW_BYTES
;
162 if (verb
== APPEND_OP
or verb
== PREPEND_OP
)
164 send_length
-= 8; /* append & prepend does not contain extras! */
168 request
.message
.header
.request
.extlen
= 8;
169 request
.message
.body
.flags
= htonl(flags
);
170 request
.message
.body
.expiration
= htonl((uint32_t)expiration
);
173 request
.message
.header
.request
.bodylen
= htonl((uint32_t) (key_length
+ memcached_array_size(ptr
->_namespace
) + value_length
+
174 request
.message
.header
.request
.extlen
));
178 request
.message
.header
.request
.cas
= memcached_htonll(cas
);
181 libmemcached_io_vector_st vector
[]=
184 { request
.bytes
, send_length
},
185 { memcached_array_string(ptr
->_namespace
), memcached_array_size(ptr
->_namespace
) },
187 { value
, value_length
}
190 /* write the header */
191 memcached_return_t rc
;
192 if ((rc
= memcached_vdo(server
, vector
, 5, flush
)) != MEMCACHED_SUCCESS
)
194 memcached_io_reset(server
);
197 if (memcached_has_error(ptr
))
199 memcached_set_error(*server
, rc
, MEMCACHED_AT
);
203 return MEMCACHED_WRITE_FAILURE
;
206 if (verb
== SET_OP
and ptr
->number_of_replicas
> 0)
208 request
.message
.header
.request
.opcode
= PROTOCOL_BINARY_CMD_SETQ
;
209 WATCHPOINT_STRING("replicating");
211 for (uint32_t x
= 0; x
< ptr
->number_of_replicas
; x
++)
214 if (server_key
== memcached_server_count(ptr
))
219 memcached_server_write_instance_st instance
= memcached_server_instance_fetch(ptr
, server_key
);
221 if (memcached_vdo(instance
, vector
, 5, false) != MEMCACHED_SUCCESS
)
223 memcached_io_reset(instance
);
227 memcached_server_response_decrement(instance
);
234 return MEMCACHED_BUFFERED
;
237 // No reply always assumes success
240 return MEMCACHED_SUCCESS
;
243 return memcached_response(server
, NULL
, 0, NULL
);
246 static memcached_return_t
memcached_send_ascii(memcached_st
*ptr
,
247 memcached_server_write_instance_st instance
,
249 const size_t key_length
,
251 const size_t value_length
,
252 const time_t expiration
,
253 const uint32_t flags
,
257 const memcached_storage_action_t verb
)
259 char flags_buffer
[MEMCACHED_MAXIMUM_INTEGER_DISPLAY_LENGTH
+1];
260 int flags_buffer_length
= snprintf(flags_buffer
, sizeof(flags_buffer
), " %u", flags
);
261 if (size_t(flags_buffer_length
) >= sizeof(flags_buffer
) or flags_buffer_length
< 0)
263 return memcached_set_error(*instance
, MEMCACHED_MEMORY_ALLOCATION_FAILURE
, MEMCACHED_AT
,
264 memcached_literal_param("snprintf(MEMCACHED_MAXIMUM_INTEGER_DISPLAY_LENGTH)"));
267 char expiration_buffer
[MEMCACHED_MAXIMUM_INTEGER_DISPLAY_LENGTH
+1];
268 int expiration_buffer_length
= snprintf(expiration_buffer
, sizeof(expiration_buffer
), " %llu", (unsigned long long)expiration
);
269 if (size_t(expiration_buffer_length
) >= sizeof(expiration_buffer
) or expiration_buffer_length
< 0)
271 return memcached_set_error(*instance
, MEMCACHED_MEMORY_ALLOCATION_FAILURE
, MEMCACHED_AT
,
272 memcached_literal_param("snprintf(MEMCACHED_MAXIMUM_INTEGER_DISPLAY_LENGTH)"));
275 char value_buffer
[MEMCACHED_MAXIMUM_INTEGER_DISPLAY_LENGTH
+1];
276 int value_buffer_length
= snprintf(value_buffer
, sizeof(value_buffer
), " %llu", (unsigned long long)value_length
);
277 if (size_t(value_buffer_length
) >= sizeof(value_buffer
) or value_buffer_length
< 0)
279 return memcached_set_error(*instance
, MEMCACHED_MEMORY_ALLOCATION_FAILURE
, MEMCACHED_AT
,
280 memcached_literal_param("snprintf(MEMCACHED_MAXIMUM_INTEGER_DISPLAY_LENGTH)"));
283 char cas_buffer
[MEMCACHED_MAXIMUM_INTEGER_DISPLAY_LENGTH
+1];
284 int cas_buffer_length
= 0;
287 cas_buffer_length
= snprintf(cas_buffer
, sizeof(cas_buffer
), " %llu", (unsigned long long)cas
);
288 if (size_t(cas_buffer_length
) >= sizeof(cas_buffer
) or cas_buffer_length
< 0)
290 return memcached_set_error(*instance
, MEMCACHED_MEMORY_ALLOCATION_FAILURE
, MEMCACHED_AT
,
291 memcached_literal_param("snprintf(MEMCACHED_MAXIMUM_INTEGER_DISPLAY_LENGTH)"));
295 libmemcached_io_vector_st vector
[]=
298 { storage_op_string(verb
), strlen(storage_op_string(verb
))},
299 { memcached_array_string(ptr
->_namespace
), memcached_array_size(ptr
->_namespace
) },
301 { flags_buffer
, flags_buffer_length
},
302 { expiration_buffer
, expiration_buffer_length
},
303 { value_buffer
, value_buffer_length
},
304 { cas_buffer
, cas_buffer_length
},
305 { " noreply", reply
? 0 : memcached_literal_param_size(" noreply") },
306 { memcached_literal_param("\r\n") },
307 { value
, value_length
},
308 { memcached_literal_param("\r\n") }
311 /* Send command header */
312 memcached_return_t rc
= memcached_vdo(instance
, vector
, 12, flush
);
314 // If we should not reply, return with MEMCACHED_SUCCESS, unless error
317 return memcached_success(rc
) ? MEMCACHED_SUCCESS
: rc
;
322 return memcached_success(rc
) ? MEMCACHED_BUFFERED
: rc
;
325 if (rc
== MEMCACHED_SUCCESS
)
327 char buffer
[MEMCACHED_DEFAULT_COMMAND_SIZE
];
328 rc
= memcached_response(instance
, buffer
, sizeof(buffer
), NULL
);
330 if (rc
== MEMCACHED_STORED
)
332 return MEMCACHED_SUCCESS
;
336 if (rc
== MEMCACHED_WRITE_FAILURE
)
338 memcached_io_reset(instance
);
341 assert(memcached_failed(rc
));
343 if (memcached_has_error(ptr
) == false)
345 return memcached_set_error(*ptr
, rc
, MEMCACHED_AT
);
352 static inline memcached_return_t
memcached_send(memcached_st
*ptr
,
353 const char *group_key
, size_t group_key_length
,
354 const char *key
, size_t key_length
,
355 const char *value
, size_t value_length
,
356 const time_t expiration
,
357 const uint32_t flags
,
359 memcached_storage_action_t verb
)
361 memcached_return_t rc
;
362 if (memcached_failed(rc
= initialize_query(ptr
, true)))
367 if (memcached_failed(memcached_key_test(*ptr
, (const char **)&key
, &key_length
, 1)))
369 return memcached_last_error(ptr
);
372 uint32_t server_key
= memcached_generate_hash_with_redistribution(ptr
, group_key
, group_key_length
);
373 memcached_server_write_instance_st instance
= memcached_server_instance_fetch(ptr
, server_key
);
375 WATCHPOINT_SET(instance
->io_wait_count
.read
= 0);
376 WATCHPOINT_SET(instance
->io_wait_count
.write
= 0);
380 if (memcached_is_buffering(instance
->root
) and verb
== SET_OP
)
385 bool reply
= memcached_is_replying(ptr
);
387 hashkit_string_st
* destination
= NULL
;
389 if (memcached_is_encrypted(ptr
))
391 if (can_by_encrypted(verb
) == false)
393 return memcached_set_error(*ptr
, MEMCACHED_NOT_SUPPORTED
, MEMCACHED_AT
,
394 memcached_literal_param("Operation not allowed while encyrption is enabled"));
397 if ((destination
= hashkit_encrypt(&ptr
->hashkit
, value
, value_length
)) == NULL
)
401 value
= hashkit_string_c_str(destination
);
402 value_length
= hashkit_string_length(destination
);
405 if (memcached_is_binary(ptr
))
407 rc
= memcached_send_binary(ptr
, instance
, server_key
,
409 value
, value_length
, expiration
,
410 flags
, cas
, flush
, reply
, verb
);
414 rc
= memcached_send_ascii(ptr
, instance
,
416 value
, value_length
, expiration
,
417 flags
, cas
, flush
, reply
, verb
);
420 hashkit_string_free(destination
);
426 memcached_return_t
memcached_set(memcached_st
*ptr
, const char *key
, size_t key_length
,
427 const char *value
, size_t value_length
,
431 memcached_return_t rc
;
432 LIBMEMCACHED_MEMCACHED_SET_START();
433 rc
= memcached_send(ptr
, key
, key_length
,
434 key
, key_length
, value
, value_length
,
435 expiration
, flags
, 0, SET_OP
);
436 LIBMEMCACHED_MEMCACHED_SET_END();
440 memcached_return_t
memcached_add(memcached_st
*ptr
,
441 const char *key
, size_t key_length
,
442 const char *value
, size_t value_length
,
446 memcached_return_t rc
;
447 LIBMEMCACHED_MEMCACHED_ADD_START();
448 rc
= memcached_send(ptr
, key
, key_length
,
449 key
, key_length
, value
, value_length
,
450 expiration
, flags
, 0, ADD_OP
);
452 LIBMEMCACHED_MEMCACHED_ADD_END();
456 memcached_return_t
memcached_replace(memcached_st
*ptr
,
457 const char *key
, size_t key_length
,
458 const char *value
, size_t value_length
,
462 memcached_return_t rc
;
463 LIBMEMCACHED_MEMCACHED_REPLACE_START();
464 rc
= memcached_send(ptr
, key
, key_length
,
465 key
, key_length
, value
, value_length
,
466 expiration
, flags
, 0, REPLACE_OP
);
467 LIBMEMCACHED_MEMCACHED_REPLACE_END();
471 memcached_return_t
memcached_prepend(memcached_st
*ptr
,
472 const char *key
, size_t key_length
,
473 const char *value
, size_t value_length
,
477 memcached_return_t rc
;
478 rc
= memcached_send(ptr
, key
, key_length
,
479 key
, key_length
, value
, value_length
,
480 expiration
, flags
, 0, PREPEND_OP
);
484 memcached_return_t
memcached_append(memcached_st
*ptr
,
485 const char *key
, size_t key_length
,
486 const char *value
, size_t value_length
,
490 memcached_return_t rc
;
491 rc
= memcached_send(ptr
, key
, key_length
,
492 key
, key_length
, value
, value_length
,
493 expiration
, flags
, 0, APPEND_OP
);
497 memcached_return_t
memcached_cas(memcached_st
*ptr
,
498 const char *key
, size_t key_length
,
499 const char *value
, size_t value_length
,
504 memcached_return_t rc
;
505 rc
= memcached_send(ptr
, key
, key_length
,
506 key
, key_length
, value
, value_length
,
507 expiration
, flags
, cas
, CAS_OP
);
511 memcached_return_t
memcached_set_by_key(memcached_st
*ptr
,
512 const char *group_key
,
513 size_t group_key_length
,
514 const char *key
, size_t key_length
,
515 const char *value
, size_t value_length
,
519 memcached_return_t rc
;
520 LIBMEMCACHED_MEMCACHED_SET_START();
521 rc
= memcached_send(ptr
, group_key
, group_key_length
,
522 key
, key_length
, value
, value_length
,
523 expiration
, flags
, 0, SET_OP
);
524 LIBMEMCACHED_MEMCACHED_SET_END();
528 memcached_return_t
memcached_add_by_key(memcached_st
*ptr
,
529 const char *group_key
, size_t group_key_length
,
530 const char *key
, size_t key_length
,
531 const char *value
, size_t value_length
,
535 memcached_return_t rc
;
536 LIBMEMCACHED_MEMCACHED_ADD_START();
537 rc
= memcached_send(ptr
, group_key
, group_key_length
,
538 key
, key_length
, value
, value_length
,
539 expiration
, flags
, 0, ADD_OP
);
540 LIBMEMCACHED_MEMCACHED_ADD_END();
544 memcached_return_t
memcached_replace_by_key(memcached_st
*ptr
,
545 const char *group_key
, size_t group_key_length
,
546 const char *key
, size_t key_length
,
547 const char *value
, size_t value_length
,
551 memcached_return_t rc
;
552 LIBMEMCACHED_MEMCACHED_REPLACE_START();
553 rc
= memcached_send(ptr
, group_key
, group_key_length
,
554 key
, key_length
, value
, value_length
,
555 expiration
, flags
, 0, REPLACE_OP
);
556 LIBMEMCACHED_MEMCACHED_REPLACE_END();
560 memcached_return_t
memcached_prepend_by_key(memcached_st
*ptr
,
561 const char *group_key
, size_t group_key_length
,
562 const char *key
, size_t key_length
,
563 const char *value
, size_t value_length
,
567 return memcached_send(ptr
, group_key
, group_key_length
,
568 key
, key_length
, value
, value_length
,
569 expiration
, flags
, 0, PREPEND_OP
);
572 memcached_return_t
memcached_append_by_key(memcached_st
*ptr
,
573 const char *group_key
, size_t group_key_length
,
574 const char *key
, size_t key_length
,
575 const char *value
, size_t value_length
,
579 return memcached_send(ptr
, group_key
, group_key_length
,
580 key
, key_length
, value
, value_length
,
581 expiration
, flags
, 0, APPEND_OP
);
584 memcached_return_t
memcached_cas_by_key(memcached_st
*ptr
,
585 const char *group_key
, size_t group_key_length
,
586 const char *key
, size_t key_length
,
587 const char *value
, size_t value_length
,
592 return memcached_send(ptr
, group_key
, group_key_length
,
593 key
, key_length
, value
, value_length
,
594 expiration
, flags
, cas
, CAS_OP
);