git.m6w6.name Git - awesomized/libmemcached/blob - libmemcached/storage.cc

   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: Storage related functions, aka set, replace,..
   9  *
  10  */
  11
  12 #include <libmemcached/common.h>
  13
  14 enum memcached_storage_action_t {
  15   SET_OP,
  16   REPLACE_OP,
  17   ADD_OP,
  18   PREPEND_OP,
  19   APPEND_OP,
  20   CAS_OP
  21 };
  22
  23 /* Inline this */
  24 static inline const char *storage_op_string(memcached_storage_action_t verb)
  25 {
  26   switch (verb)
  27   {
  28   case SET_OP:
  29     return "set ";
  30   case REPLACE_OP:
  31     return "replace ";
  32   case ADD_OP:
  33     return "add ";
  34   case PREPEND_OP:
  35     return "prepend ";
  36   case APPEND_OP:
  37     return "append ";
  38   case CAS_OP:
  39     return "cas ";
  40   default:
  41     return "tosserror"; /* This is impossible, fixes issue for compiler warning in VisualStudio */
  42   }
  43
  44   /* NOTREACHED */
  45 }
  46
  47 static memcached_return_t memcached_send_binary(memcached_st *ptr,
  48                                                 memcached_server_write_instance_st server,
  49                                                 uint32_t server_key,
  50                                                 const char *key,
  51                                                 size_t key_length,
  52                                                 const char *value,
  53                                                 size_t value_length,
  54                                                 time_t expiration,
  55                                                 uint32_t flags,
  56                                                 uint64_t cas,
  57                                                 memcached_storage_action_t verb);
  58
  59 static inline memcached_return_t memcached_send(memcached_st *ptr,
  60                                                 const char *group_key, size_t group_key_length,
  61                                                 const char *key, size_t key_length,
  62                                                 const char *value, size_t value_length,
  63                                                 time_t expiration,
  64                                                 uint32_t flags,
  65                                                 uint64_t cas,
  66                                                 memcached_storage_action_t verb)
  67 {
  68   bool to_write;
  69   size_t write_length;
  70   char buffer[MEMCACHED_DEFAULT_COMMAND_SIZE];
  71
  72   WATCHPOINT_ASSERT(!(value == NULL && value_length > 0));
  73
  74   memcached_return_t rc;
  75   if (memcached_failed(rc= initialize_query(ptr)))
  76   {
  77     return rc;
  78   }
  79
  80   if (memcached_failed(rc= memcached_validate_key_length(key_length, ptr->flags.binary_protocol)))
  81     return rc;
  82
  83   if (ptr->flags.verify_key && (memcached_key_test((const char **)&key, &key_length, 1) == MEMCACHED_BAD_KEY_PROVIDED))
  84     return MEMCACHED_BAD_KEY_PROVIDED;
  85
  86   uint32_t server_key= memcached_generate_hash_with_redistribution(ptr, group_key, group_key_length);
  87   memcached_server_write_instance_st instance= memcached_server_instance_fetch(ptr, server_key);
  88
  89   WATCHPOINT_SET(instance->io_wait_count.read= 0);
  90   WATCHPOINT_SET(instance->io_wait_count.write= 0);
  91
  92   if (ptr->flags.binary_protocol)
  93   {
  94     rc= memcached_send_binary(ptr, instance, server_key,
  95                               key, key_length,
  96                               value, value_length, expiration,
  97                               flags, cas, verb);
  98     WATCHPOINT_IF_LABELED_NUMBER(instance->io_wait_count.read > 2, "read IO_WAIT", instance->io_wait_count.read);
  99     WATCHPOINT_IF_LABELED_NUMBER(instance->io_wait_count.write > 2, "write_IO_WAIT", instance->io_wait_count.write);
 100   }
 101   else
 102   {
 103
 104     if (cas)
 105     {
 106       int check_length;
 107       check_length= snprintf(buffer, MEMCACHED_DEFAULT_COMMAND_SIZE,
 108                                     "%s %.*s%.*s %u %llu %lu %llu%s\r\n",
 109                                     storage_op_string(verb),
 110                                     memcached_print_array(ptr->prefix_key),
 111                                     (int)key_length, key, flags,
 112                                     (unsigned long long)expiration, (unsigned long)value_length,
 113                                     (unsigned long long)cas,
 114                                     (ptr->flags.no_reply) ? " noreply" : "");
 115       if (check_length >= MEMCACHED_DEFAULT_COMMAND_SIZE || check_length < 0)
 116       {
 117         rc= MEMCACHED_WRITE_FAILURE;
 118         memcached_io_reset(instance);
 119
 120         return rc;
 121       }
 122       write_length= check_length;
 123     }
 124     else
 125     {
 126       char *buffer_ptr= buffer;
 127       const char *command= storage_op_string(verb);
 128
 129       /* Copy in the command, no space needed, we handle that in the command function*/
 130       memcpy(buffer_ptr, command, strlen(command));
 131
 132       /* Copy in the key prefix, switch to the buffer_ptr */
 133       buffer_ptr= (char *)memcpy((char *)(buffer_ptr + strlen(command)), (char *)memcached_array_string(ptr->prefix_key), memcached_array_size(ptr->prefix_key));
 134
 135       /* Copy in the key, adjust point if a key prefix was used. */
 136       buffer_ptr= (char *)memcpy(buffer_ptr + memcached_array_size(ptr->prefix_key),
 137                          key, key_length);
 138       buffer_ptr+= key_length;
 139       buffer_ptr[0]=  ' ';
 140       buffer_ptr++;
 141
 142       write_length= (size_t)(buffer_ptr - buffer);
 143       int check_length= snprintf(buffer_ptr, MEMCACHED_DEFAULT_COMMAND_SIZE -(size_t)(buffer_ptr - buffer),
 144                                  "%u %llu %lu%s\r\n",
 145                                  flags,
 146                                  (unsigned long long)expiration, (unsigned long)value_length,
 147                                  ptr->flags.no_reply ? " noreply" : "");
 148       if ((size_t)check_length >= MEMCACHED_DEFAULT_COMMAND_SIZE -size_t(buffer_ptr - buffer) || check_length < 0)
 149       {
 150         rc= MEMCACHED_WRITE_FAILURE;
 151         memcached_io_reset(instance);
 152
 153         return rc;
 154       }
 155
 156       write_length+= (size_t)check_length;
 157       WATCHPOINT_ASSERT(write_length < MEMCACHED_DEFAULT_COMMAND_SIZE);
 158     }
 159
 160     if (ptr->flags.use_udp && ptr->flags.buffer_requests)
 161     {
 162       size_t cmd_size= write_length + value_length +2;
 163       if (cmd_size > MAX_UDP_DATAGRAM_LENGTH - UDP_DATAGRAM_HEADER_LENGTH)
 164         return memcached_set_error(*ptr, MEMCACHED_WRITE_FAILURE, MEMCACHED_AT);
 165
 166       if (cmd_size + instance->write_buffer_offset > MAX_UDP_DATAGRAM_LENGTH)
 167         memcached_io_write(instance, NULL, 0, true);
 168     }
 169
 170     if (write_length >= MEMCACHED_DEFAULT_COMMAND_SIZE)
 171     {
 172       rc= memcached_set_error(*ptr, MEMCACHED_WRITE_FAILURE, MEMCACHED_AT);
 173     }
 174     else
 175     {
 176       struct libmemcached_io_vector_st vector[]=
 177       {
 178         { write_length, buffer },
 179         { value_length, value },
 180         { 2, "\r\n" }
 181       };
 182
 183       if (ptr->flags.buffer_requests && verb == SET_OP)
 184       {
 185         to_write= false;
 186       }
 187       else
 188       {
 189         to_write= true;
 190       }
 191
 192       /* Send command header */
 193       rc=  memcached_vdo(instance, vector, 3, to_write);
 194       if (rc == MEMCACHED_SUCCESS)
 195       {
 196
 197         if (ptr->flags.no_reply)
 198         {
 199           rc= (to_write == false) ? MEMCACHED_BUFFERED : MEMCACHED_SUCCESS;
 200         }
 201         else if (to_write == false)
 202         {
 203           rc= MEMCACHED_BUFFERED;
 204         }
 205         else
 206         {
 207           rc= memcached_response(instance, buffer, MEMCACHED_DEFAULT_COMMAND_SIZE, NULL);
 208
 209           if (rc == MEMCACHED_STORED)
 210             rc= MEMCACHED_SUCCESS;
 211         }
 212       }
 213     }
 214
 215     if (rc == MEMCACHED_WRITE_FAILURE)
 216       memcached_io_reset(instance);
 217   }
 218
 219   WATCHPOINT_IF_LABELED_NUMBER(instance->io_wait_count.read > 2, "read IO_WAIT", instance->io_wait_count.read);
 220   WATCHPOINT_IF_LABELED_NUMBER(instance->io_wait_count.write > 2, "write_IO_WAIT", instance->io_wait_count.write);
 221
 222   return rc;
 223 }
 224
 225
 226 memcached_return_t memcached_set(memcached_st *ptr, const char *key, size_t key_length,
 227                                  const char *value, size_t value_length,
 228                                  time_t expiration,
 229                                  uint32_t flags)
 230 {
 231   memcached_return_t rc;
 232   LIBMEMCACHED_MEMCACHED_SET_START();
 233   rc= memcached_send(ptr, key, key_length,
 234                      key, key_length, value, value_length,
 235                      expiration, flags, 0, SET_OP);
 236   LIBMEMCACHED_MEMCACHED_SET_END();
 237   return rc;
 238 }
 239
 240 memcached_return_t memcached_add(memcached_st *ptr,
 241                                  const char *key, size_t key_length,
 242                                  const char *value, size_t value_length,
 243                                  time_t expiration,
 244                                  uint32_t flags)
 245 {
 246   memcached_return_t rc;
 247   LIBMEMCACHED_MEMCACHED_ADD_START();
 248   rc= memcached_send(ptr, key, key_length,
 249                      key, key_length, value, value_length,
 250                      expiration, flags, 0, ADD_OP);
 251   LIBMEMCACHED_MEMCACHED_ADD_END();
 252   return rc;
 253 }
 254
 255 memcached_return_t memcached_replace(memcached_st *ptr,
 256                                      const char *key, size_t key_length,
 257                                      const char *value, size_t value_length,
 258                                      time_t expiration,
 259                                      uint32_t flags)
 260 {
 261   memcached_return_t rc;
 262   LIBMEMCACHED_MEMCACHED_REPLACE_START();
 263   rc= memcached_send(ptr, key, key_length,
 264                      key, key_length, value, value_length,
 265                      expiration, flags, 0, REPLACE_OP);
 266   LIBMEMCACHED_MEMCACHED_REPLACE_END();
 267   return rc;
 268 }
 269
 270 memcached_return_t memcached_prepend(memcached_st *ptr,
 271                                      const char *key, size_t key_length,
 272                                      const char *value, size_t value_length,
 273                                      time_t expiration,
 274                                      uint32_t flags)
 275 {
 276   memcached_return_t rc;
 277   rc= memcached_send(ptr, key, key_length,
 278                      key, key_length, value, value_length,
 279                      expiration, flags, 0, PREPEND_OP);
 280   return rc;
 281 }
 282
 283 memcached_return_t memcached_append(memcached_st *ptr,
 284                                     const char *key, size_t key_length,
 285                                     const char *value, size_t value_length,
 286                                     time_t expiration,
 287                                     uint32_t flags)
 288 {
 289   memcached_return_t rc;
 290   rc= memcached_send(ptr, key, key_length,
 291                      key, key_length, value, value_length,
 292                      expiration, flags, 0, APPEND_OP);
 293   return rc;
 294 }
 295
 296 memcached_return_t memcached_cas(memcached_st *ptr,
 297                                  const char *key, size_t key_length,
 298                                  const char *value, size_t value_length,
 299                                  time_t expiration,
 300                                  uint32_t flags,
 301                                  uint64_t cas)
 302 {
 303   memcached_return_t rc;
 304   rc= memcached_send(ptr, key, key_length,
 305                      key, key_length, value, value_length,
 306                      expiration, flags, cas, CAS_OP);
 307   return rc;
 308 }
 309
 310 memcached_return_t memcached_set_by_key(memcached_st *ptr,
 311                                         const char *group_key,
 312                                         size_t group_key_length,
 313                                         const char *key, size_t key_length,
 314                                         const char *value, size_t value_length,
 315                                         time_t expiration,
 316                                         uint32_t flags)
 317 {
 318   memcached_return_t rc;
 319   LIBMEMCACHED_MEMCACHED_SET_START();
 320   rc= memcached_send(ptr, group_key, group_key_length,
 321                      key, key_length, value, value_length,
 322                      expiration, flags, 0, SET_OP);
 323   LIBMEMCACHED_MEMCACHED_SET_END();
 324   return rc;
 325 }
 326
 327 memcached_return_t memcached_add_by_key(memcached_st *ptr,
 328                                         const char *group_key, size_t group_key_length,
 329                                         const char *key, size_t key_length,
 330                                         const char *value, size_t value_length,
 331                                         time_t expiration,
 332                                         uint32_t flags)
 333 {
 334   memcached_return_t rc;
 335   LIBMEMCACHED_MEMCACHED_ADD_START();
 336   rc= memcached_send(ptr, group_key, group_key_length,
 337                      key, key_length, value, value_length,
 338                      expiration, flags, 0, ADD_OP);
 339   LIBMEMCACHED_MEMCACHED_ADD_END();
 340   return rc;
 341 }
 342
 343 memcached_return_t memcached_replace_by_key(memcached_st *ptr,
 344                                             const char *group_key, size_t group_key_length,
 345                                             const char *key, size_t key_length,
 346                                             const char *value, size_t value_length,
 347                                             time_t expiration,
 348                                             uint32_t flags)
 349 {
 350   memcached_return_t rc;
 351   LIBMEMCACHED_MEMCACHED_REPLACE_START();
 352   rc= memcached_send(ptr, group_key, group_key_length,
 353                      key, key_length, value, value_length,
 354                      expiration, flags, 0, REPLACE_OP);
 355   LIBMEMCACHED_MEMCACHED_REPLACE_END();
 356   return rc;
 357 }
 358
 359 memcached_return_t memcached_prepend_by_key(memcached_st *ptr,
 360                                             const char *group_key, size_t group_key_length,
 361                                             const char *key, size_t key_length,
 362                                             const char *value, size_t value_length,
 363                                             time_t expiration,
 364                                             uint32_t flags)
 365 {
 366   memcached_return_t rc;
 367   rc= memcached_send(ptr, group_key, group_key_length,
 368                      key, key_length, value, value_length,
 369                      expiration, flags, 0, PREPEND_OP);
 370   return rc;
 371 }
 372
 373 memcached_return_t memcached_append_by_key(memcached_st *ptr,
 374                                            const char *group_key, size_t group_key_length,
 375                                            const char *key, size_t key_length,
 376                                            const char *value, size_t value_length,
 377                                            time_t expiration,
 378                                            uint32_t flags)
 379 {
 380   memcached_return_t rc;
 381   rc= memcached_send(ptr, group_key, group_key_length,
 382                      key, key_length, value, value_length,
 383                      expiration, flags, 0, APPEND_OP);
 384   return rc;
 385 }
 386
 387 memcached_return_t memcached_cas_by_key(memcached_st *ptr,
 388                                         const char *group_key, size_t group_key_length,
 389                                         const char *key, size_t key_length,
 390                                         const char *value, size_t value_length,
 391                                         time_t expiration,
 392                                         uint32_t flags,
 393                                         uint64_t cas)
 394 {
 395   memcached_return_t rc;
 396   rc= memcached_send(ptr, group_key, group_key_length,
 397                      key, key_length, value, value_length,
 398                      expiration, flags, cas, CAS_OP);
 399   return rc;
 400 }
 401
 402 static inline uint8_t get_com_code(memcached_storage_action_t verb, bool noreply)
 403 {
 404   /* 0 isn't a value we want, but GCC 4.2 seems to think ret can otherwise
 405    * be used uninitialized in this function. FAIL */
 406   uint8_t ret= 0;
 407
 408   if (noreply)
 409     switch (verb)
 410     {
 411     case SET_OP:
 412       ret=PROTOCOL_BINARY_CMD_SETQ;
 413       break;
 414     case ADD_OP:
 415       ret=PROTOCOL_BINARY_CMD_ADDQ;
 416       break;
 417     case CAS_OP: /* FALLTHROUGH */
 418     case REPLACE_OP:
 419       ret=PROTOCOL_BINARY_CMD_REPLACEQ;
 420       break;
 421     case APPEND_OP:
 422       ret=PROTOCOL_BINARY_CMD_APPENDQ;
 423       break;
 424     case PREPEND_OP:
 425       ret=PROTOCOL_BINARY_CMD_PREPENDQ;
 426       break;
 427     default:
 428       WATCHPOINT_ASSERT(verb);
 429       break;
 430     }
 431   else
 432     switch (verb)
 433     {
 434     case SET_OP:
 435       ret=PROTOCOL_BINARY_CMD_SET;
 436       break;
 437     case ADD_OP:
 438       ret=PROTOCOL_BINARY_CMD_ADD;
 439       break;
 440     case CAS_OP: /* FALLTHROUGH */
 441     case REPLACE_OP:
 442       ret=PROTOCOL_BINARY_CMD_REPLACE;
 443       break;
 444     case APPEND_OP:
 445       ret=PROTOCOL_BINARY_CMD_APPEND;
 446       break;
 447     case PREPEND_OP:
 448       ret=PROTOCOL_BINARY_CMD_PREPEND;
 449       break;
 450     default:
 451       WATCHPOINT_ASSERT(verb);
 452       break;
 453     }
 454
 455   return ret;
 456 }
 457
 458
 459
 460 static memcached_return_t memcached_send_binary(memcached_st *ptr,
 461                                                 memcached_server_write_instance_st server,
 462                                                 uint32_t server_key,
 463                                                 const char *key,
 464                                                 size_t key_length,
 465                                                 const char *value,
 466                                                 size_t value_length,
 467                                                 time_t expiration,
 468                                                 uint32_t flags,
 469                                                 uint64_t cas,
 470                                                 memcached_storage_action_t verb)
 471 {
 472   bool flush;
 473   protocol_binary_request_set request= {};
 474   size_t send_length= sizeof(request.bytes);
 475
 476   bool noreply= server->root->flags.no_reply;
 477
 478   request.message.header.request.magic= PROTOCOL_BINARY_REQ;
 479   request.message.header.request.opcode= get_com_code(verb, noreply);
 480   request.message.header.request.keylen= htons((uint16_t)(key_length + memcached_array_size(ptr->prefix_key)));
 481   request.message.header.request.datatype= PROTOCOL_BINARY_RAW_BYTES;
 482   if (verb == APPEND_OP || verb == PREPEND_OP)
 483     send_length -= 8; /* append & prepend does not contain extras! */
 484   else
 485   {
 486     request.message.header.request.extlen= 8;
 487     request.message.body.flags= htonl(flags);
 488     request.message.body.expiration= htonl((uint32_t)expiration);
 489   }
 490
 491   request.message.header.request.bodylen= htonl((uint32_t) (key_length + memcached_array_size(ptr->prefix_key) + value_length +
 492                                                             request.message.header.request.extlen));
 493
 494   if (cas)
 495     request.message.header.request.cas= memcached_htonll(cas);
 496
 497   flush= (bool) ((server->root->flags.buffer_requests && verb == SET_OP) ? 0 : 1);
 498
 499   if (server->root->flags.use_udp && ! flush)
 500   {
 501     size_t cmd_size= send_length + key_length + value_length;
 502
 503     if (cmd_size > MAX_UDP_DATAGRAM_LENGTH - UDP_DATAGRAM_HEADER_LENGTH)
 504     {
 505       return MEMCACHED_WRITE_FAILURE;
 506     }
 507     if (cmd_size + server->write_buffer_offset > MAX_UDP_DATAGRAM_LENGTH)
 508     {
 509       memcached_io_write(server, NULL, 0, true);
 510     }
 511   }
 512
 513   struct libmemcached_io_vector_st vector[]=
 514   {
 515     { send_length, request.bytes },
 516     { memcached_array_size(ptr->prefix_key), memcached_array_string(ptr->prefix_key) },
 517     { key_length, key },
 518     { value_length, value }
 519   };
 520
 521   /* write the header */
 522   memcached_return_t rc;
 523   if ((rc= memcached_vdo(server, vector, 4, flush)) != MEMCACHED_SUCCESS)
 524   {
 525     memcached_io_reset(server);
 526     return (rc == MEMCACHED_SUCCESS) ? MEMCACHED_WRITE_FAILURE : rc;
 527   }
 528
 529   if (verb == SET_OP && ptr->number_of_replicas > 0)
 530   {
 531     request.message.header.request.opcode= PROTOCOL_BINARY_CMD_SETQ;
 532     WATCHPOINT_STRING("replicating");
 533
 534     for (uint32_t x= 0; x < ptr->number_of_replicas; x++)
 535     {
 536       memcached_server_write_instance_st instance;
 537
 538       ++server_key;
 539       if (server_key == memcached_server_count(ptr))
 540         server_key= 0;
 541
 542       instance= memcached_server_instance_fetch(ptr, server_key);
 543
 544       if (memcached_vdo(instance, vector, 4, false) != MEMCACHED_SUCCESS)
 545       {
 546         memcached_io_reset(instance);
 547       }
 548       else
 549       {
 550         memcached_server_response_decrement(instance);
 551       }
 552     }
 553   }
 554
 555   if (flush == false)
 556   {
 557     return MEMCACHED_BUFFERED;
 558   }
 559
 560   if (noreply)
 561   {
 562     return MEMCACHED_SUCCESS;
 563   }
 564
 565   return memcached_response(server, NULL, 0, NULL);
 566 }
 567