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: Storage related functions, aka set, replace,..
21 } memcached_storage_action_t
;
24 static inline const char *storage_op_string(memcached_storage_action_t verb
)
41 return "tosserror"; /* This is impossible, fixes issue for compiler warning in VisualStudio */
47 static memcached_return_t
memcached_send_binary(memcached_st
*ptr
,
48 memcached_server_write_instance_st server
,
57 memcached_storage_action_t verb
);
59 static inline memcached_return_t
memcached_send(memcached_st
*ptr
,
60 const char *master_key
, size_t master_key_length
,
61 const char *key
, size_t key_length
,
62 const char *value
, size_t value_length
,
66 memcached_storage_action_t verb
)
70 memcached_return_t rc
;
71 char buffer
[MEMCACHED_DEFAULT_COMMAND_SIZE
];
73 memcached_server_write_instance_st instance
;
75 WATCHPOINT_ASSERT(!(value
== NULL
&& value_length
> 0));
77 rc
= memcached_validate_key_length(key_length
, ptr
->flags
.binary_protocol
);
78 unlikely (rc
!= MEMCACHED_SUCCESS
)
81 unlikely (memcached_server_count(ptr
) == 0)
82 return MEMCACHED_NO_SERVERS
;
84 if (ptr
->flags
.verify_key
&& (memcached_key_test((const char **)&key
, &key_length
, 1) == MEMCACHED_BAD_KEY_PROVIDED
))
85 return MEMCACHED_BAD_KEY_PROVIDED
;
87 server_key
= memcached_generate_hash_with_redistribution(ptr
, master_key
, master_key_length
);
88 instance
= memcached_server_instance_fetch(ptr
, server_key
);
90 WATCHPOINT_SET(instance
->io_wait_count
.read
= 0);
91 WATCHPOINT_SET(instance
->io_wait_count
.write
= 0);
93 if (ptr
->flags
.binary_protocol
)
95 rc
= memcached_send_binary(ptr
, instance
, server_key
,
97 value
, value_length
, expiration
,
99 WATCHPOINT_IF_LABELED_NUMBER(instance
->io_wait_count
.read
> 2, "read IO_WAIT", instance
->io_wait_count
.read
);
100 WATCHPOINT_IF_LABELED_NUMBER(instance
->io_wait_count
.write
> 2, "write_IO_WAIT", instance
->io_wait_count
.write
);
108 check_length
= snprintf(buffer
, MEMCACHED_DEFAULT_COMMAND_SIZE
,
109 "%s %.*s%.*s %u %llu %lu %llu%s\r\n",
110 storage_op_string(verb
),
111 memcached_print_array(ptr
->prefix_key
),
112 (int)key_length
, key
, flags
,
113 (unsigned long long)expiration
, (unsigned long)value_length
,
114 (unsigned long long)cas
,
115 (ptr
->flags
.no_reply
) ? " noreply" : "");
116 if (check_length
>= MEMCACHED_DEFAULT_COMMAND_SIZE
|| check_length
< 0)
118 rc
= MEMCACHED_WRITE_FAILURE
;
119 memcached_io_reset(instance
);
123 write_length
= check_length
;
127 char *buffer_ptr
= buffer
;
128 const char *command
= storage_op_string(verb
);
130 /* Copy in the command, no space needed, we handle that in the command function*/
131 memcpy(buffer_ptr
, command
, strlen(command
));
133 /* Copy in the key prefix, switch to the buffer_ptr */
134 buffer_ptr
= memcpy((buffer_ptr
+ strlen(command
)), memcached_array_string(ptr
->prefix_key
), memcached_array_size(ptr
->prefix_key
));
136 /* Copy in the key, adjust point if a key prefix was used. */
137 buffer_ptr
= memcpy(buffer_ptr
+ memcached_array_size(ptr
->prefix_key
),
139 buffer_ptr
+= key_length
;
143 write_length
= (size_t)(buffer_ptr
- buffer
);
145 check_length
= snprintf(buffer_ptr
, MEMCACHED_DEFAULT_COMMAND_SIZE
-(size_t)(buffer_ptr
- buffer
),
148 (unsigned long long)expiration
, (unsigned long)value_length
,
149 ptr
->flags
.no_reply
? " noreply" : "");
150 if ((size_t)check_length
>= MEMCACHED_DEFAULT_COMMAND_SIZE
-(size_t)(buffer_ptr
- buffer
) || check_length
< 0)
152 rc
= MEMCACHED_WRITE_FAILURE
;
153 memcached_io_reset(instance
);
158 write_length
+= (size_t)check_length
;
159 WATCHPOINT_ASSERT(write_length
< MEMCACHED_DEFAULT_COMMAND_SIZE
);
162 if (ptr
->flags
.use_udp
&& ptr
->flags
.buffer_requests
)
164 size_t cmd_size
= write_length
+ value_length
+ 2;
165 if (cmd_size
> MAX_UDP_DATAGRAM_LENGTH
- UDP_DATAGRAM_HEADER_LENGTH
)
166 return MEMCACHED_WRITE_FAILURE
;
167 if (cmd_size
+ instance
->write_buffer_offset
> MAX_UDP_DATAGRAM_LENGTH
)
168 memcached_io_write(instance
, NULL
, 0, true);
171 if (write_length
>= MEMCACHED_DEFAULT_COMMAND_SIZE
)
173 rc
= MEMCACHED_WRITE_FAILURE
;
177 struct libmemcached_io_vector_st vector
[]=
179 { .length
= write_length
, .buffer
= buffer
},
180 { .length
= value_length
, .buffer
= value
},
181 { .length
= 2, .buffer
= "\r\n" }
184 if (ptr
->flags
.buffer_requests
&& verb
== SET_OP
)
193 /* Send command header */
194 rc
= memcached_vdo(instance
, vector
, 3, to_write
);
195 if (rc
== MEMCACHED_SUCCESS
)
198 if (ptr
->flags
.no_reply
)
200 rc
= (to_write
== false) ? MEMCACHED_BUFFERED
: MEMCACHED_SUCCESS
;
202 else if (to_write
== false)
204 rc
= MEMCACHED_BUFFERED
;
208 rc
= memcached_response(instance
, buffer
, MEMCACHED_DEFAULT_COMMAND_SIZE
, NULL
);
210 if (rc
== MEMCACHED_STORED
)
211 rc
= MEMCACHED_SUCCESS
;
216 if (rc
== MEMCACHED_WRITE_FAILURE
)
217 memcached_io_reset(instance
);
220 WATCHPOINT_IF_LABELED_NUMBER(instance
->io_wait_count
.read
> 2, "read IO_WAIT", instance
->io_wait_count
.read
);
221 WATCHPOINT_IF_LABELED_NUMBER(instance
->io_wait_count
.write
> 2, "write_IO_WAIT", instance
->io_wait_count
.write
);
227 memcached_return_t
memcached_set(memcached_st
*ptr
, const char *key
, size_t key_length
,
228 const char *value
, size_t value_length
,
232 memcached_return_t rc
;
233 LIBMEMCACHED_MEMCACHED_SET_START();
234 rc
= memcached_send(ptr
, key
, key_length
,
235 key
, key_length
, value
, value_length
,
236 expiration
, flags
, 0, SET_OP
);
237 LIBMEMCACHED_MEMCACHED_SET_END();
241 memcached_return_t
memcached_add(memcached_st
*ptr
,
242 const char *key
, size_t key_length
,
243 const char *value
, size_t value_length
,
247 memcached_return_t rc
;
248 LIBMEMCACHED_MEMCACHED_ADD_START();
249 rc
= memcached_send(ptr
, key
, key_length
,
250 key
, key_length
, value
, value_length
,
251 expiration
, flags
, 0, ADD_OP
);
252 LIBMEMCACHED_MEMCACHED_ADD_END();
256 memcached_return_t
memcached_replace(memcached_st
*ptr
,
257 const char *key
, size_t key_length
,
258 const char *value
, size_t value_length
,
262 memcached_return_t rc
;
263 LIBMEMCACHED_MEMCACHED_REPLACE_START();
264 rc
= memcached_send(ptr
, key
, key_length
,
265 key
, key_length
, value
, value_length
,
266 expiration
, flags
, 0, REPLACE_OP
);
267 LIBMEMCACHED_MEMCACHED_REPLACE_END();
271 memcached_return_t
memcached_prepend(memcached_st
*ptr
,
272 const char *key
, size_t key_length
,
273 const char *value
, size_t value_length
,
277 memcached_return_t rc
;
278 rc
= memcached_send(ptr
, key
, key_length
,
279 key
, key_length
, value
, value_length
,
280 expiration
, flags
, 0, PREPEND_OP
);
284 memcached_return_t
memcached_append(memcached_st
*ptr
,
285 const char *key
, size_t key_length
,
286 const char *value
, size_t value_length
,
290 memcached_return_t rc
;
291 rc
= memcached_send(ptr
, key
, key_length
,
292 key
, key_length
, value
, value_length
,
293 expiration
, flags
, 0, APPEND_OP
);
297 memcached_return_t
memcached_cas(memcached_st
*ptr
,
298 const char *key
, size_t key_length
,
299 const char *value
, size_t value_length
,
304 memcached_return_t rc
;
305 rc
= memcached_send(ptr
, key
, key_length
,
306 key
, key_length
, value
, value_length
,
307 expiration
, flags
, cas
, CAS_OP
);
311 memcached_return_t
memcached_set_by_key(memcached_st
*ptr
,
312 const char *master_key
,
313 size_t master_key_length
,
314 const char *key
, size_t key_length
,
315 const char *value
, size_t value_length
,
319 memcached_return_t rc
;
320 LIBMEMCACHED_MEMCACHED_SET_START();
321 rc
= memcached_send(ptr
, master_key
, master_key_length
,
322 key
, key_length
, value
, value_length
,
323 expiration
, flags
, 0, SET_OP
);
324 LIBMEMCACHED_MEMCACHED_SET_END();
328 memcached_return_t
memcached_add_by_key(memcached_st
*ptr
,
329 const char *master_key
, size_t master_key_length
,
330 const char *key
, size_t key_length
,
331 const char *value
, size_t value_length
,
335 memcached_return_t rc
;
336 LIBMEMCACHED_MEMCACHED_ADD_START();
337 rc
= memcached_send(ptr
, master_key
, master_key_length
,
338 key
, key_length
, value
, value_length
,
339 expiration
, flags
, 0, ADD_OP
);
340 LIBMEMCACHED_MEMCACHED_ADD_END();
344 memcached_return_t
memcached_replace_by_key(memcached_st
*ptr
,
345 const char *master_key
, size_t master_key_length
,
346 const char *key
, size_t key_length
,
347 const char *value
, size_t value_length
,
351 memcached_return_t rc
;
352 LIBMEMCACHED_MEMCACHED_REPLACE_START();
353 rc
= memcached_send(ptr
, master_key
, master_key_length
,
354 key
, key_length
, value
, value_length
,
355 expiration
, flags
, 0, REPLACE_OP
);
356 LIBMEMCACHED_MEMCACHED_REPLACE_END();
360 memcached_return_t
memcached_prepend_by_key(memcached_st
*ptr
,
361 const char *master_key
, size_t master_key_length
,
362 const char *key
, size_t key_length
,
363 const char *value
, size_t value_length
,
367 memcached_return_t rc
;
368 rc
= memcached_send(ptr
, master_key
, master_key_length
,
369 key
, key_length
, value
, value_length
,
370 expiration
, flags
, 0, PREPEND_OP
);
374 memcached_return_t
memcached_append_by_key(memcached_st
*ptr
,
375 const char *master_key
, size_t master_key_length
,
376 const char *key
, size_t key_length
,
377 const char *value
, size_t value_length
,
381 memcached_return_t rc
;
382 rc
= memcached_send(ptr
, master_key
, master_key_length
,
383 key
, key_length
, value
, value_length
,
384 expiration
, flags
, 0, APPEND_OP
);
388 memcached_return_t
memcached_cas_by_key(memcached_st
*ptr
,
389 const char *master_key
, size_t master_key_length
,
390 const char *key
, size_t key_length
,
391 const char *value
, size_t value_length
,
396 memcached_return_t rc
;
397 rc
= memcached_send(ptr
, master_key
, master_key_length
,
398 key
, key_length
, value
, value_length
,
399 expiration
, flags
, cas
, CAS_OP
);
403 static inline uint8_t get_com_code(memcached_storage_action_t verb
, bool noreply
)
405 /* 0 isn't a value we want, but GCC 4.2 seems to think ret can otherwise
406 * be used uninitialized in this function. FAIL */
413 ret
=PROTOCOL_BINARY_CMD_SETQ
;
416 ret
=PROTOCOL_BINARY_CMD_ADDQ
;
418 case CAS_OP
: /* FALLTHROUGH */
420 ret
=PROTOCOL_BINARY_CMD_REPLACEQ
;
423 ret
=PROTOCOL_BINARY_CMD_APPENDQ
;
426 ret
=PROTOCOL_BINARY_CMD_PREPENDQ
;
429 WATCHPOINT_ASSERT(verb
);
436 ret
=PROTOCOL_BINARY_CMD_SET
;
439 ret
=PROTOCOL_BINARY_CMD_ADD
;
441 case CAS_OP
: /* FALLTHROUGH */
443 ret
=PROTOCOL_BINARY_CMD_REPLACE
;
446 ret
=PROTOCOL_BINARY_CMD_APPEND
;
449 ret
=PROTOCOL_BINARY_CMD_PREPEND
;
452 WATCHPOINT_ASSERT(verb
);
461 static memcached_return_t
memcached_send_binary(memcached_st
*ptr
,
462 memcached_server_write_instance_st server
,
471 memcached_storage_action_t verb
)
474 protocol_binary_request_set request
= {.bytes
= {0}};
475 size_t send_length
= sizeof(request
.bytes
);
477 bool noreply
= server
->root
->flags
.no_reply
;
479 request
.message
.header
.request
.magic
= PROTOCOL_BINARY_REQ
;
480 request
.message
.header
.request
.opcode
= get_com_code(verb
, noreply
);
481 request
.message
.header
.request
.keylen
= htons((uint16_t)(key_length
+ memcached_array_size(ptr
->prefix_key
)));
482 request
.message
.header
.request
.datatype
= PROTOCOL_BINARY_RAW_BYTES
;
483 if (verb
== APPEND_OP
|| verb
== PREPEND_OP
)
484 send_length
-= 8; /* append & prepend does not contain extras! */
487 request
.message
.header
.request
.extlen
= 8;
488 request
.message
.body
.flags
= htonl(flags
);
489 request
.message
.body
.expiration
= htonl((uint32_t)expiration
);
492 request
.message
.header
.request
.bodylen
= htonl((uint32_t) (key_length
+ memcached_array_size(ptr
->prefix_key
) + value_length
+
493 request
.message
.header
.request
.extlen
));
496 request
.message
.header
.request
.cas
= htonll(cas
);
498 flush
= (bool) ((server
->root
->flags
.buffer_requests
&& verb
== SET_OP
) ? 0 : 1);
500 if (server
->root
->flags
.use_udp
&& ! flush
)
502 size_t cmd_size
= send_length
+ key_length
+ value_length
;
504 if (cmd_size
> MAX_UDP_DATAGRAM_LENGTH
- UDP_DATAGRAM_HEADER_LENGTH
)
506 return MEMCACHED_WRITE_FAILURE
;
508 if (cmd_size
+ server
->write_buffer_offset
> MAX_UDP_DATAGRAM_LENGTH
)
510 memcached_io_write(server
, NULL
, 0, true);
514 struct libmemcached_io_vector_st vector
[]=
516 { .length
= send_length
, .buffer
= request
.bytes
},
517 { .length
= memcached_array_size(ptr
->prefix_key
), .buffer
= memcached_array_string(ptr
->prefix_key
) },
518 { .length
= key_length
, .buffer
= key
},
519 { .length
= value_length
, .buffer
= value
}
522 /* write the header */
523 memcached_return_t rc
;
524 if ((rc
= memcached_vdo(server
, vector
, 4, flush
)) != MEMCACHED_SUCCESS
)
526 memcached_io_reset(server
);
527 return (rc
== MEMCACHED_SUCCESS
) ? MEMCACHED_WRITE_FAILURE
: rc
;
530 if (verb
== SET_OP
&& ptr
->number_of_replicas
> 0)
532 request
.message
.header
.request
.opcode
= PROTOCOL_BINARY_CMD_SETQ
;
533 WATCHPOINT_STRING("replicating");
535 for (uint32_t x
= 0; x
< ptr
->number_of_replicas
; x
++)
537 memcached_server_write_instance_st instance
;
540 if (server_key
== memcached_server_count(ptr
))
543 instance
= memcached_server_instance_fetch(ptr
, server_key
);
545 if (memcached_vdo(instance
, vector
, 4, false) != MEMCACHED_SUCCESS
)
547 memcached_io_reset(instance
);
551 memcached_server_response_decrement(instance
);
558 return MEMCACHED_BUFFERED
;
563 return MEMCACHED_SUCCESS
;
566 return memcached_response(server
, NULL
, 0, NULL
);