git.m6w6.name Git - m6w6/libmemcached/blob - libmemcached/memcached/protocol_binary.h

   1 /*
   2  * Copyright (c) <2008>, Sun Microsystems, Inc.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are met:
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of the  nor the
  13  *       names of its contributors may be used to endorse or promote products
  14  *       derived from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY SUN MICROSYSTEMS, INC. ``AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL SUN MICROSYSTEMS, INC. BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27 /*
  28  * Summary: Constants used by to implement the binary protocol.
  29  *
  30  * Copy: See Copyright for the status of this software.
  31  *
  32  * Author: Trond Norbye <trond.norbye@sun.com>
  33  */
  34
  35 #ifndef PROTOCOL_BINARY_H
  36 #define PROTOCOL_BINARY_H
  37
  38 #include <stdint.h>
  39
  40 /**
  41  * This file contains definitions of the constants and packet formats
  42  * defined in the binary specification. Please note that you _MUST_ remember
  43  * to convert each multibyte field to / from network byte order to / from
  44  * host order.
  45  */
  46 #ifdef __cplusplus
  47 extern "C"
  48 {
  49 #endif
  50
  51   /**
  52    * Definition of the legal "magic" values used in a packet.
  53    * See section 3.1 Magic byte
  54    */
  55   typedef enum {
  56     PROTOCOL_BINARY_REQ = 0x80,
  57     PROTOCOL_BINARY_RES = 0x81
  58   } protocol_binary_magic;
  59
  60   /**
  61    * Definition of the valid response status numbers.
  62    * See section 3.2 Response Status
  63    */
  64   typedef enum {
  65     PROTOCOL_BINARY_RESPONSE_SUCCESS = 0x00,
  66     PROTOCOL_BINARY_RESPONSE_KEY_ENOENT = 0x01,
  67     PROTOCOL_BINARY_RESPONSE_KEY_EEXISTS = 0x02,
  68     PROTOCOL_BINARY_RESPONSE_E2BIG = 0x03,
  69     PROTOCOL_BINARY_RESPONSE_EINVAL = 0x04,
  70     PROTOCOL_BINARY_RESPONSE_NOT_STORED = 0x05,
  71     PROTOCOL_BINARY_RESPONSE_UNKNOWN_COMMAND = 0x81,
  72     PROTOCOL_BINARY_RESPONSE_ENOMEM = 0x82,
  73
  74
  75     PROTOCOL_BINARY_RESPONSE_EIO = 0xff
  76   } protocol_binary_response_status;
  77
  78   /**
  79    * Defintion of the different command opcodes.
  80    * See section 3.3 Command Opcodes
  81    */
  82   typedef enum {
  83     PROTOCOL_BINARY_CMD_GET = 0x00,
  84     PROTOCOL_BINARY_CMD_SET = 0x01,
  85     PROTOCOL_BINARY_CMD_ADD = 0x02,
  86     PROTOCOL_BINARY_CMD_REPLACE = 0x03,
  87     PROTOCOL_BINARY_CMD_DELETE = 0x04,
  88     PROTOCOL_BINARY_CMD_INCREMENT = 0x05,
  89     PROTOCOL_BINARY_CMD_DECREMENT = 0x06,
  90     PROTOCOL_BINARY_CMD_QUIT = 0x07,
  91     PROTOCOL_BINARY_CMD_FLUSH = 0x08,
  92     PROTOCOL_BINARY_CMD_GETQ = 0x09,
  93     PROTOCOL_BINARY_CMD_NOOP = 0x0a,
  94     PROTOCOL_BINARY_CMD_VERSION = 0x0b,
  95     PROTOCOL_BINARY_CMD_GETK = 0x0c,
  96     PROTOCOL_BINARY_CMD_GETKQ = 0x0d,
  97     PROTOCOL_BINARY_CMD_APPEND = 0x0e,
  98     PROTOCOL_BINARY_CMD_PREPEND = 0x0f,
  99     PROTOCOL_BINARY_CMD_STAT = 0x10,
 100     PROTOCOL_BINARY_CMD_SETQ = 0x11,
 101     PROTOCOL_BINARY_CMD_ADDQ = 0x12,
 102     PROTOCOL_BINARY_CMD_REPLACEQ = 0x13,
 103     PROTOCOL_BINARY_CMD_DELETEQ = 0x14,
 104     PROTOCOL_BINARY_CMD_INCREMENTQ = 0x15,
 105     PROTOCOL_BINARY_CMD_DECREMENTQ = 0x16,
 106     PROTOCOL_BINARY_CMD_QUITQ = 0x17,
 107     PROTOCOL_BINARY_CMD_FLUSHQ = 0x18,
 108     PROTOCOL_BINARY_CMD_APPENDQ = 0x19,
 109     PROTOCOL_BINARY_CMD_PREPENDQ = 0x1a
 110   } protocol_binary_command;
 111
 112   /**
 113    * Definition of the data types in the packet
 114    * See section 3.4 Data Types
 115    */
 116   typedef enum {
 117     PROTOCOL_BINARY_RAW_BYTES = 0x00
 118   } protocol_binary_datatypes;
 119
 120   /**
 121    * Definition of the header structure for a request packet.
 122    * See section 2
 123    */
 124   typedef union {
 125     struct {
 126       uint8_t magic;
 127       uint8_t opcode;
 128       uint16_t keylen;
 129       uint8_t extlen;
 130       uint8_t datatype;
 131       uint16_t reserved;
 132       uint32_t bodylen;
 133       uint32_t opaque;
 134       uint64_t cas;
 135     } request;
 136     uint8_t bytes[24];
 137   } protocol_binary_request_header;
 138
 139   /**
 140    * Definition of the header structure for a response packet.
 141    * See section 2
 142    */
 143   typedef union {
 144     struct {
 145       uint8_t magic;
 146       uint8_t opcode;
 147       uint16_t keylen;
 148       uint8_t extlen;
 149       uint8_t datatype;
 150       uint16_t status;
 151       uint32_t bodylen;
 152       uint32_t opaque;
 153       uint64_t cas;
 154     } response;
 155     uint8_t bytes[24];
 156   } protocol_binary_response_header;
 157
 158   /**
 159    * Definition of a request-packet containing no extras
 160    */
 161   typedef union {
 162     struct {
 163       protocol_binary_request_header header;
 164     } message;
 165     uint8_t bytes[sizeof(protocol_binary_request_header)];
 166   } protocol_binary_request_no_extras;
 167
 168   /**
 169    * Definition of a response-packet containing no extras
 170    */
 171   typedef union {
 172     struct {
 173       protocol_binary_response_header header;
 174     } message;
 175     uint8_t bytes[sizeof(protocol_binary_response_header)];
 176   } protocol_binary_response_no_extras;
 177
 178   /**
 179    * Definition of the packet used by the get, getq, getk and getkq command.
 180    * See section 4
 181    */
 182   typedef protocol_binary_request_no_extras protocol_binary_request_get;
 183   typedef protocol_binary_request_no_extras protocol_binary_request_getq;
 184   typedef protocol_binary_request_no_extras protocol_binary_request_getk;
 185   typedef protocol_binary_request_no_extras protocol_binary_request_getkq;
 186
 187   /**
 188    * Definition of the packet returned from a successful get, getq, getk and
 189    * getkq.
 190    * See section 4
 191    */
 192   typedef union {
 193     struct {
 194       protocol_binary_response_header header;
 195       struct {
 196         uint32_t flags;
 197       } body;
 198     } message;
 199     uint8_t bytes[sizeof(protocol_binary_response_header) + 4];
 200   } protocol_binary_response_get;
 201
 202   typedef protocol_binary_response_get protocol_binary_response_getq;
 203   typedef protocol_binary_response_get protocol_binary_response_getk;
 204   typedef protocol_binary_response_get protocol_binary_response_getkq;
 205
 206   /**
 207    * Definition of the packet used by the delete command
 208    * See section 4
 209    */
 210   typedef protocol_binary_request_no_extras protocol_binary_request_delete;
 211
 212   /**
 213    * Definition of the packet returned by the delete command
 214    * See section 4
 215    */
 216   typedef protocol_binary_response_no_extras protocol_binary_response_delete;
 217
 218   /**
 219    * Definition of the packet used by the flush command
 220    * See section 4
 221    * Please note that the expiration field is optional, so remember to see
 222    * check the header.bodysize to see if it is present.
 223    */
 224   typedef union {
 225     struct {
 226       protocol_binary_request_header header;
 227       struct {
 228         uint32_t expiration;
 229       } body;
 230     } message;
 231     uint8_t bytes[sizeof(protocol_binary_request_header) + 4];
 232   } protocol_binary_request_flush;
 233
 234   /**
 235    * Definition of the packet returned by the flush command
 236    * See section 4
 237    */
 238   typedef protocol_binary_response_no_extras protocol_binary_response_flush;
 239
 240   /**
 241    * Definition of the packet used by set, add and replace
 242    * See section 4
 243    */
 244   typedef union {
 245     struct {
 246       protocol_binary_request_header header;
 247       struct {
 248         uint32_t flags;
 249         uint32_t expiration;
 250       } body;
 251     } message;
 252     uint8_t bytes[sizeof(protocol_binary_request_header) + 8];
 253   } protocol_binary_request_set;
 254   typedef protocol_binary_request_set protocol_binary_request_add;
 255   typedef protocol_binary_request_set protocol_binary_request_replace;
 256
 257   /**
 258    * Definition of the packet returned by set, add and replace
 259    * See section 4
 260    */
 261   typedef protocol_binary_response_no_extras protocol_binary_response_set;
 262   typedef protocol_binary_response_no_extras protocol_binary_response_add;
 263   typedef protocol_binary_response_no_extras protocol_binary_response_replace;
 264
 265   /**
 266    * Definition of the noop packet
 267    * See section 4
 268    */
 269   typedef protocol_binary_request_no_extras protocol_binary_request_noop;
 270
 271   /**
 272    * Definition of the packet returned by the noop command
 273    * See section 4
 274    */
 275   typedef protocol_binary_response_no_extras protocol_binary_response_noop;
 276
 277   /**
 278    * Definition of the structure used by the increment and decrement
 279    * command.
 280    * See section 4
 281    */
 282   typedef union {
 283     struct {
 284       protocol_binary_request_header header;
 285       struct {
 286         uint64_t delta;
 287         uint64_t initial;
 288         uint32_t expiration;
 289       } body;
 290     } message;
 291     uint8_t bytes[sizeof(protocol_binary_request_header) + 20];
 292   } protocol_binary_request_incr;
 293   typedef protocol_binary_request_incr protocol_binary_request_decr;
 294
 295   /**
 296    * Definition of the response from an incr or decr command
 297    * command.
 298    * See section 4
 299    */
 300   typedef union {
 301     struct {
 302       protocol_binary_response_header header;
 303       struct {
 304         uint64_t value;
 305       } body;
 306     } message;
 307     uint8_t bytes[sizeof(protocol_binary_response_header) + 8];
 308   } protocol_binary_response_incr;
 309   typedef protocol_binary_response_incr protocol_binary_response_decr;
 310
 311   /**
 312    * Definition of the quit
 313    * See section 4
 314    */
 315   typedef protocol_binary_request_no_extras protocol_binary_request_quit;
 316
 317   /**
 318    * Definition of the packet returned by the quit command
 319    * See section 4
 320    */
 321   typedef protocol_binary_response_no_extras protocol_binary_response_quit;
 322
 323   /**
 324    * Definition of the packet used by append and prepend command
 325    * See section 4
 326    */
 327   typedef protocol_binary_request_no_extras protocol_binary_request_append;
 328   typedef protocol_binary_request_no_extras protocol_binary_request_prepend;
 329
 330   /**
 331    * Definition of the packet returned from a successful append or prepend
 332    * See section 4
 333    */
 334   typedef protocol_binary_response_no_extras protocol_binary_response_append;
 335   typedef protocol_binary_response_no_extras protocol_binary_response_prepend;
 336
 337   /**
 338    * Definition of the packet used by the version command
 339    * See section 4
 340    */
 341   typedef protocol_binary_request_no_extras protocol_binary_request_version;
 342
 343   /**
 344    * Definition of the packet returned from a successful version command
 345    * See section 4
 346    */
 347   typedef protocol_binary_response_no_extras protocol_binary_response_version;
 348
 349
 350   /**
 351    * Definition of the packet used by the stats command.
 352    * See section 4
 353    */
 354   typedef protocol_binary_request_no_extras protocol_binary_request_stats;
 355
 356   /**
 357    * Definition of the packet returned from a successful stats command
 358    * See section 4
 359    */
 360   typedef protocol_binary_response_no_extras protocol_binary_response_stats;
 361 #ifdef __cplusplus
 362 }
 363 #endif
 364 #endif /* PROTOCOL_BINARY_H */