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_DELTA_BADVAL = 0x06,
  72         PROTOCOL_BINARY_RESPONSE_UNKNOWN_COMMAND = 0x81,
  73         PROTOCOL_BINARY_RESPONSE_ENOMEM = 0x82,
  74         PROTOCOL_BINARY_RESPONSE_EIO = 0xff
  75     } protocol_binary_response_status;
  76
  77     /**
  78      * Defintion of the different command opcodes.
  79      * See section 3.3 Command Opcodes
  80      */
  81     typedef enum {
  82         PROTOCOL_BINARY_CMD_GET = 0x00,
  83         PROTOCOL_BINARY_CMD_SET = 0x01,
  84         PROTOCOL_BINARY_CMD_ADD = 0x02,
  85         PROTOCOL_BINARY_CMD_REPLACE = 0x03,
  86         PROTOCOL_BINARY_CMD_DELETE = 0x04,
  87         PROTOCOL_BINARY_CMD_INCREMENT = 0x05,
  88         PROTOCOL_BINARY_CMD_DECREMENT = 0x06,
  89         PROTOCOL_BINARY_CMD_QUIT = 0x07,
  90         PROTOCOL_BINARY_CMD_FLUSH = 0x08,
  91         PROTOCOL_BINARY_CMD_GETQ = 0x09,
  92         PROTOCOL_BINARY_CMD_NOOP = 0x0a,
  93         PROTOCOL_BINARY_CMD_VERSION = 0x0b,
  94         PROTOCOL_BINARY_CMD_GETK = 0x0c,
  95         PROTOCOL_BINARY_CMD_GETKQ = 0x0d,
  96         PROTOCOL_BINARY_CMD_APPEND = 0x0e,
  97         PROTOCOL_BINARY_CMD_PREPEND = 0x0f,
  98         PROTOCOL_BINARY_CMD_STAT = 0x10,
  99         PROTOCOL_BINARY_CMD_SETQ = 0x11,
 100         PROTOCOL_BINARY_CMD_ADDQ = 0x12,
 101         PROTOCOL_BINARY_CMD_REPLACEQ = 0x13,
 102         PROTOCOL_BINARY_CMD_DELETEQ = 0x14,
 103         PROTOCOL_BINARY_CMD_INCREMENTQ = 0x15,
 104         PROTOCOL_BINARY_CMD_DECREMENTQ = 0x16,
 105         PROTOCOL_BINARY_CMD_QUITQ = 0x17,
 106         PROTOCOL_BINARY_CMD_FLUSHQ = 0x18,
 107         PROTOCOL_BINARY_CMD_APPENDQ = 0x19,
 108         PROTOCOL_BINARY_CMD_PREPENDQ = 0x1a,
 109
 110         /* These commands are used for range operations and exist within
 111          * this header for use in other projects.  Range operations are
 112          * not expected to be implemented in the memcached server itself.
 113          */
 114         PROTOCOL_BINARY_CMD_RGET      = 0x30,
 115         PROTOCOL_BINARY_CMD_RSET      = 0x31,
 116         PROTOCOL_BINARY_CMD_RSETQ     = 0x32,
 117         PROTOCOL_BINARY_CMD_RAPPEND   = 0x33,
 118         PROTOCOL_BINARY_CMD_RAPPENDQ  = 0x34,
 119         PROTOCOL_BINARY_CMD_RPREPEND  = 0x35,
 120         PROTOCOL_BINARY_CMD_RPREPENDQ = 0x36,
 121         PROTOCOL_BINARY_CMD_RDELETE   = 0x37,
 122         PROTOCOL_BINARY_CMD_RDELETEQ  = 0x38,
 123         PROTOCOL_BINARY_CMD_RINCR     = 0x39,
 124         PROTOCOL_BINARY_CMD_RINCRQ    = 0x3a,
 125         PROTOCOL_BINARY_CMD_RDECR     = 0x3b,
 126         PROTOCOL_BINARY_CMD_RDECRQ    = 0x3c
 127         /* End Range operations */
 128
 129     } protocol_binary_command;
 130
 131     /**
 132      * Definition of the data types in the packet
 133      * See section 3.4 Data Types
 134      */
 135     typedef enum {
 136         PROTOCOL_BINARY_RAW_BYTES = 0x00
 137     } protocol_binary_datatypes;
 138
 139     /**
 140      * Definition of the header structure for a request 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 reserved;
 151             uint32_t bodylen;
 152             uint32_t opaque;
 153             uint64_t cas;
 154         } request;
 155         uint8_t bytes[24];
 156     } protocol_binary_request_header;
 157
 158     /**
 159      * Definition of the header structure for a response packet.
 160      * See section 2
 161      */
 162     typedef union {
 163         struct {
 164             uint8_t magic;
 165             uint8_t opcode;
 166             uint16_t keylen;
 167             uint8_t extlen;
 168             uint8_t datatype;
 169             uint16_t status;
 170             uint32_t bodylen;
 171             uint32_t opaque;
 172             uint64_t cas;
 173         } response;
 174         uint8_t bytes[24];
 175     } protocol_binary_response_header;
 176
 177     /**
 178      * Definition of a request-packet containing no extras
 179      */
 180     typedef union {
 181         struct {
 182             protocol_binary_request_header header;
 183         } message;
 184         uint8_t bytes[sizeof(protocol_binary_request_header)];
 185     } protocol_binary_request_no_extras;
 186
 187     /**
 188      * Definition of a response-packet containing no extras
 189      */
 190     typedef union {
 191         struct {
 192             protocol_binary_response_header header;
 193         } message;
 194         uint8_t bytes[sizeof(protocol_binary_response_header)];
 195     } protocol_binary_response_no_extras;
 196
 197     /**
 198      * Definition of the packet used by the get, getq, getk and getkq command.
 199      * See section 4
 200      */
 201     typedef protocol_binary_request_no_extras protocol_binary_request_get;
 202     typedef protocol_binary_request_no_extras protocol_binary_request_getq;
 203     typedef protocol_binary_request_no_extras protocol_binary_request_getk;
 204     typedef protocol_binary_request_no_extras protocol_binary_request_getkq;
 205
 206     /**
 207      * Definition of the packet returned from a successful get, getq, getk and
 208      * getkq.
 209      * See section 4
 210      */
 211     typedef union {
 212         struct {
 213             protocol_binary_response_header header;
 214             struct {
 215                 uint32_t flags;
 216             } body;
 217         } message;
 218         uint8_t bytes[sizeof(protocol_binary_response_header) + 4];
 219     } protocol_binary_response_get;
 220
 221     typedef protocol_binary_response_get protocol_binary_response_getq;
 222     typedef protocol_binary_response_get protocol_binary_response_getk;
 223     typedef protocol_binary_response_get protocol_binary_response_getkq;
 224
 225     /**
 226      * Definition of the packet used by the delete command
 227      * See section 4
 228      */
 229     typedef protocol_binary_request_no_extras protocol_binary_request_delete;
 230
 231     /**
 232      * Definition of the packet returned by the delete command
 233      * See section 4
 234      */
 235     typedef protocol_binary_response_no_extras protocol_binary_response_delete;
 236
 237     /**
 238      * Definition of the packet used by the flush command
 239      * See section 4
 240      * Please note that the expiration field is optional, so remember to see
 241      * check the header.bodysize to see if it is present.
 242      */
 243     typedef union {
 244         struct {
 245             protocol_binary_request_header header;
 246             struct {
 247                 uint32_t expiration;
 248             } body;
 249         } message;
 250         uint8_t bytes[sizeof(protocol_binary_request_header) + 4];
 251     } protocol_binary_request_flush;
 252
 253     /**
 254      * Definition of the packet returned by the flush command
 255      * See section 4
 256      */
 257     typedef protocol_binary_response_no_extras protocol_binary_response_flush;
 258
 259     /**
 260      * Definition of the packet used by set, add and replace
 261      * See section 4
 262      */
 263     typedef union {
 264         struct {
 265             protocol_binary_request_header header;
 266             struct {
 267                 uint32_t flags;
 268                 uint32_t expiration;
 269             } body;
 270         } message;
 271         uint8_t bytes[sizeof(protocol_binary_request_header) + 8];
 272     } protocol_binary_request_set;
 273     typedef protocol_binary_request_set protocol_binary_request_add;
 274     typedef protocol_binary_request_set protocol_binary_request_replace;
 275
 276     /**
 277      * Definition of the packet returned by set, add and replace
 278      * See section 4
 279      */
 280     typedef protocol_binary_response_no_extras protocol_binary_response_set;
 281     typedef protocol_binary_response_no_extras protocol_binary_response_add;
 282     typedef protocol_binary_response_no_extras protocol_binary_response_replace;
 283
 284     /**
 285      * Definition of the noop packet
 286      * See section 4
 287      */
 288     typedef protocol_binary_request_no_extras protocol_binary_request_noop;
 289
 290     /**
 291      * Definition of the packet returned by the noop command
 292      * See section 4
 293      */
 294     typedef protocol_binary_response_no_extras protocol_binary_response_noop;
 295
 296     /**
 297      * Definition of the structure used by the increment and decrement
 298      * command.
 299      * See section 4
 300      */
 301     typedef union {
 302         struct {
 303             protocol_binary_request_header header;
 304             struct {
 305                 uint64_t delta;
 306                 uint64_t initial;
 307                 uint32_t expiration;
 308             } body;
 309         } message;
 310         uint8_t bytes[sizeof(protocol_binary_request_header) + 20];
 311     } protocol_binary_request_incr;
 312     typedef protocol_binary_request_incr protocol_binary_request_decr;
 313
 314     /**
 315      * Definition of the response from an incr or decr command
 316      * command.
 317      * See section 4
 318      */
 319     typedef union {
 320         struct {
 321             protocol_binary_response_header header;
 322             struct {
 323                 uint64_t value;
 324             } body;
 325         } message;
 326         uint8_t bytes[sizeof(protocol_binary_response_header) + 8];
 327     } protocol_binary_response_incr;
 328     typedef protocol_binary_response_incr protocol_binary_response_decr;
 329
 330     /**
 331      * Definition of the quit
 332      * See section 4
 333      */
 334     typedef protocol_binary_request_no_extras protocol_binary_request_quit;
 335
 336     /**
 337      * Definition of the packet returned by the quit command
 338      * See section 4
 339      */
 340     typedef protocol_binary_response_no_extras protocol_binary_response_quit;
 341
 342     /**
 343      * Definition of the packet used by append and prepend command
 344      * See section 4
 345      */
 346     typedef protocol_binary_request_no_extras protocol_binary_request_append;
 347     typedef protocol_binary_request_no_extras protocol_binary_request_prepend;
 348
 349     /**
 350      * Definition of the packet returned from a successful append or prepend
 351      * See section 4
 352      */
 353     typedef protocol_binary_response_no_extras protocol_binary_response_append;
 354     typedef protocol_binary_response_no_extras protocol_binary_response_prepend;
 355
 356     /**
 357      * Definition of the packet used by the version command
 358      * See section 4
 359      */
 360     typedef protocol_binary_request_no_extras protocol_binary_request_version;
 361
 362     /**
 363      * Definition of the packet returned from a successful version command
 364      * See section 4
 365      */
 366     typedef protocol_binary_response_no_extras protocol_binary_response_version;
 367
 368
 369     /**
 370      * Definition of the packet used by the stats command.
 371      * See section 4
 372      */
 373     typedef protocol_binary_request_no_extras protocol_binary_request_stats;
 374
 375     /**
 376      * Definition of the packet returned from a successful stats command
 377      * See section 4
 378      */
 379     typedef protocol_binary_response_no_extras protocol_binary_response_stats;
 380
 381     /**
 382      * Definition of a request for a range operation.
 383      * See http://code.google.com/p/memcached/wiki/RangeOps
 384      *
 385      * These types are used for range operations and exist within
 386      * this header for use in other projects.  Range operations are
 387      * not expected to be implemented in the memcached server itself.
 388      */
 389     typedef union {
 390         struct {
 391             protocol_binary_response_header header;
 392             struct {
 393                 uint16_t size;
 394                 uint8_t  reserved;
 395                 uint8_t  flags;
 396                 uint32_t max_results;
 397             } body;
 398         } message;
 399         uint8_t bytes[sizeof(protocol_binary_request_header) + 4];
 400     } protocol_binary_request_rangeop;
 401
 402     typedef protocol_binary_request_rangeop protocol_binary_request_rget;
 403     typedef protocol_binary_request_rangeop protocol_binary_request_rset;
 404     typedef protocol_binary_request_rangeop protocol_binary_request_rsetq;
 405     typedef protocol_binary_request_rangeop protocol_binary_request_rappend;
 406     typedef protocol_binary_request_rangeop protocol_binary_request_rappendq;
 407     typedef protocol_binary_request_rangeop protocol_binary_request_rprepend;
 408     typedef protocol_binary_request_rangeop protocol_binary_request_rprependq;
 409     typedef protocol_binary_request_rangeop protocol_binary_request_rdelete;
 410     typedef protocol_binary_request_rangeop protocol_binary_request_rdeleteq;
 411     typedef protocol_binary_request_rangeop protocol_binary_request_rincr;
 412     typedef protocol_binary_request_rangeop protocol_binary_request_rincrq;
 413     typedef protocol_binary_request_rangeop protocol_binary_request_rdecr;
 414     typedef protocol_binary_request_rangeop protocol_binary_request_rdecrq;
 415
 416 #ifdef __cplusplus
 417 }
 418 #endif
 419 #endif /* PROTOCOL_BINARY_H */