2 +--------------------------------------------------------------------+
3 | libmemcached - C/C++ Client Library for memcached |
4 +--------------------------------------------------------------------+
5 | Redistribution and use in source and binary forms, with or without |
6 | modification, are permitted under the terms of the BSD license. |
7 | You should have received a copy of the license in a bundled file |
8 | named LICENSE; in case you did not receive a copy you can review |
9 | the terms online at: https://opensource.org/licenses/BSD-3-Clause |
10 +--------------------------------------------------------------------+
11 | Copyright (c) 2006-2014 Brian Aker https://datadifferential.com/ |
12 | Copyright (c) 2020 Michael Wallner <mike@php.net> |
13 +--------------------------------------------------------------------+
16 #ifndef PROTOCOL_BINARY_H
17 #define PROTOCOL_BINARY_H
19 #include "libmemcachedprotocol-0/vbucket.h"
22 * \addtogroup Protocol
27 * This file contains definitions of the constants and packet formats
28 * defined in the binary specification. Please note that you _MUST_ remember
29 * to convert each multibyte field to / from network byte order to / from
40 * Definition of the legal "magic" values used in a packet.
41 * See section 3.1 Magic byte
43 typedef enum { PROTOCOL_BINARY_REQ
= 0x80, PROTOCOL_BINARY_RES
= 0x81 } protocol_binary_magic
;
46 * Definition of the valid response status numbers.
47 * See section 3.2 Response Status
50 PROTOCOL_BINARY_RESPONSE_SUCCESS
= 0x00,
51 PROTOCOL_BINARY_RESPONSE_KEY_ENOENT
= 0x01,
52 PROTOCOL_BINARY_RESPONSE_KEY_EEXISTS
= 0x02,
53 PROTOCOL_BINARY_RESPONSE_E2BIG
= 0x03,
54 PROTOCOL_BINARY_RESPONSE_EINVAL
= 0x04,
55 PROTOCOL_BINARY_RESPONSE_NOT_STORED
= 0x05,
56 PROTOCOL_BINARY_RESPONSE_DELTA_BADVAL
= 0x06,
57 PROTOCOL_BINARY_RESPONSE_NOT_MY_VBUCKET
= 0x07,
58 PROTOCOL_BINARY_RESPONSE_AUTH_ERROR
= 0x20,
59 PROTOCOL_BINARY_RESPONSE_AUTH_CONTINUE
= 0x21,
60 PROTOCOL_BINARY_RESPONSE_UNKNOWN_COMMAND
= 0x81,
61 PROTOCOL_BINARY_RESPONSE_ENOMEM
= 0x82,
62 PROTOCOL_BINARY_RESPONSE_NOT_SUPPORTED
= 0x83,
63 PROTOCOL_BINARY_RESPONSE_EINTERNAL
= 0x84,
64 PROTOCOL_BINARY_RESPONSE_EBUSY
= 0x85,
65 PROTOCOL_BINARY_RESPONSE_ETMPFAIL
= 0x86
66 } protocol_binary_response_status
;
69 * Defintion of the different command opcodes.
70 * See section 3.3 Command Opcodes
73 PROTOCOL_BINARY_CMD_GET
= 0x00,
74 PROTOCOL_BINARY_CMD_SET
= 0x01,
75 PROTOCOL_BINARY_CMD_ADD
= 0x02,
76 PROTOCOL_BINARY_CMD_REPLACE
= 0x03,
77 PROTOCOL_BINARY_CMD_DELETE
= 0x04,
78 PROTOCOL_BINARY_CMD_INCREMENT
= 0x05,
79 PROTOCOL_BINARY_CMD_DECREMENT
= 0x06,
80 PROTOCOL_BINARY_CMD_QUIT
= 0x07,
81 PROTOCOL_BINARY_CMD_FLUSH
= 0x08,
82 PROTOCOL_BINARY_CMD_GETQ
= 0x09,
83 PROTOCOL_BINARY_CMD_NOOP
= 0x0a,
84 PROTOCOL_BINARY_CMD_VERSION
= 0x0b,
85 PROTOCOL_BINARY_CMD_GETK
= 0x0c,
86 PROTOCOL_BINARY_CMD_GETKQ
= 0x0d,
87 PROTOCOL_BINARY_CMD_APPEND
= 0x0e,
88 PROTOCOL_BINARY_CMD_PREPEND
= 0x0f,
89 PROTOCOL_BINARY_CMD_STAT
= 0x10,
90 PROTOCOL_BINARY_CMD_SETQ
= 0x11,
91 PROTOCOL_BINARY_CMD_ADDQ
= 0x12,
92 PROTOCOL_BINARY_CMD_REPLACEQ
= 0x13,
93 PROTOCOL_BINARY_CMD_DELETEQ
= 0x14,
94 PROTOCOL_BINARY_CMD_INCREMENTQ
= 0x15,
95 PROTOCOL_BINARY_CMD_DECREMENTQ
= 0x16,
96 PROTOCOL_BINARY_CMD_QUITQ
= 0x17,
97 PROTOCOL_BINARY_CMD_FLUSHQ
= 0x18,
98 PROTOCOL_BINARY_CMD_APPENDQ
= 0x19,
99 PROTOCOL_BINARY_CMD_PREPENDQ
= 0x1a,
100 PROTOCOL_BINARY_CMD_VERBOSITY
= 0x1b,
101 PROTOCOL_BINARY_CMD_TOUCH
= 0x1c,
102 PROTOCOL_BINARY_CMD_GAT
= 0x1d,
103 PROTOCOL_BINARY_CMD_GATQ
= 0x1e,
104 PROTOCOL_BINARY_CMD_GATK
= 0x23,
105 PROTOCOL_BINARY_CMD_GATKQ
= 0x24,
107 PROTOCOL_BINARY_CMD_SASL_LIST_MECHS
= 0x20,
108 PROTOCOL_BINARY_CMD_SASL_AUTH
= 0x21,
109 PROTOCOL_BINARY_CMD_SASL_STEP
= 0x22,
111 /* These commands are used for range operations and exist within
112 * this header for use in other projects. Range operations are
113 * not expected to be implemented in the memcached server itself.
115 PROTOCOL_BINARY_CMD_RGET
= 0x30,
116 PROTOCOL_BINARY_CMD_RSET
= 0x31,
117 PROTOCOL_BINARY_CMD_RSETQ
= 0x32,
118 PROTOCOL_BINARY_CMD_RAPPEND
= 0x33,
119 PROTOCOL_BINARY_CMD_RAPPENDQ
= 0x34,
120 PROTOCOL_BINARY_CMD_RPREPEND
= 0x35,
121 PROTOCOL_BINARY_CMD_RPREPENDQ
= 0x36,
122 PROTOCOL_BINARY_CMD_RDELETE
= 0x37,
123 PROTOCOL_BINARY_CMD_RDELETEQ
= 0x38,
124 PROTOCOL_BINARY_CMD_RINCR
= 0x39,
125 PROTOCOL_BINARY_CMD_RINCRQ
= 0x3a,
126 PROTOCOL_BINARY_CMD_RDECR
= 0x3b,
127 PROTOCOL_BINARY_CMD_RDECRQ
= 0x3c,
128 /* End Range operations */
130 /* VBucket commands */
131 PROTOCOL_BINARY_CMD_SET_VBUCKET
= 0x3d,
132 PROTOCOL_BINARY_CMD_GET_VBUCKET
= 0x3e,
133 PROTOCOL_BINARY_CMD_DEL_VBUCKET
= 0x3f,
134 /* End VBucket commands */
137 PROTOCOL_BINARY_CMD_TAP_CONNECT
= 0x40,
138 PROTOCOL_BINARY_CMD_TAP_MUTATION
= 0x41,
139 PROTOCOL_BINARY_CMD_TAP_DELETE
= 0x42,
140 PROTOCOL_BINARY_CMD_TAP_FLUSH
= 0x43,
141 PROTOCOL_BINARY_CMD_TAP_OPAQUE
= 0x44,
142 PROTOCOL_BINARY_CMD_TAP_VBUCKET_SET
= 0x45,
143 PROTOCOL_BINARY_CMD_TAP_CHECKPOINT_START
= 0x46,
144 PROTOCOL_BINARY_CMD_TAP_CHECKPOINT_END
= 0x47,
147 PROTOCOL_BINARY_CMD_LAST_RESERVED
= 0xef,
150 PROTOCOL_BINARY_CMD_SCRUB
= 0xf0
151 } protocol_binary_command
;
154 * Definition of the data types in the packet
155 * See section 3.4 Data Types
157 typedef enum { PROTOCOL_BINARY_RAW_BYTES
= 0x00 } protocol_binary_datatypes
;
160 * Definition of the header structure for a request packet.
176 } protocol_binary_request_header
;
179 * Definition of the header structure for a response packet.
195 } protocol_binary_response_header
;
198 * Definition of a request-packet containing no extras
200 union protocol_binary_request_no_extras
{
202 protocol_binary_request_header header
;
204 uint8_t bytes
[sizeof(protocol_binary_request_header
)];
206 typedef union protocol_binary_request_no_extras protocol_binary_request_no_extras
;
209 * Definition of a response-packet containing no extras
213 protocol_binary_response_header header
;
215 uint8_t bytes
[sizeof(protocol_binary_response_header
)];
216 } protocol_binary_response_no_extras
;
219 * Definition of the packet used by the get, getq, getk and getkq command.
222 typedef protocol_binary_request_no_extras protocol_binary_request_get
;
223 typedef protocol_binary_request_no_extras protocol_binary_request_getq
;
224 typedef protocol_binary_request_no_extras protocol_binary_request_getk
;
225 typedef protocol_binary_request_no_extras protocol_binary_request_getkq
;
228 * Definition of the packet returned from a successful get, getq, getk and
234 protocol_binary_response_header header
;
239 uint8_t bytes
[sizeof(protocol_binary_response_header
) + 4];
240 } protocol_binary_response_get
;
242 typedef protocol_binary_response_get protocol_binary_response_getq
;
243 typedef protocol_binary_response_get protocol_binary_response_getk
;
244 typedef protocol_binary_response_get protocol_binary_response_getkq
;
247 * Definition of the packet used by the delete command
250 typedef protocol_binary_request_no_extras protocol_binary_request_delete
;
253 * Definition of the packet returned by the delete command
256 typedef protocol_binary_response_no_extras protocol_binary_response_delete
;
259 * Definition of the packet used by the flush command
261 * Please note that the expiration field is optional, so remember to see
262 * check the header.bodysize to see if it is present.
266 protocol_binary_request_header header
;
271 uint8_t bytes
[sizeof(protocol_binary_request_header
) + 4];
272 } protocol_binary_request_flush
;
275 * Definition of the packet returned by the flush command
278 typedef protocol_binary_response_no_extras protocol_binary_response_flush
;
281 * Definition of the packet used by set, add and replace
286 protocol_binary_request_header header
;
292 uint8_t bytes
[sizeof(protocol_binary_request_header
) + 8];
293 } protocol_binary_request_set
;
294 typedef protocol_binary_request_set protocol_binary_request_add
;
295 typedef protocol_binary_request_set protocol_binary_request_replace
;
298 * Definition of the packet returned by set, add and replace
301 typedef protocol_binary_response_no_extras protocol_binary_response_set
;
302 typedef protocol_binary_response_no_extras protocol_binary_response_add
;
303 typedef protocol_binary_response_no_extras protocol_binary_response_replace
;
306 * Definition of the noop packet
309 typedef protocol_binary_request_no_extras protocol_binary_request_noop
;
312 * Definition of the packet returned by the noop command
315 typedef protocol_binary_response_no_extras protocol_binary_response_noop
;
318 * Definition of the structure used by the increment and decrement
324 protocol_binary_request_header header
;
331 uint8_t bytes
[sizeof(protocol_binary_request_header
) + 20];
332 } protocol_binary_request_incr
;
333 typedef protocol_binary_request_incr protocol_binary_request_decr
;
336 * Definition of the response from an incr or decr command
342 protocol_binary_response_header header
;
347 uint8_t bytes
[sizeof(protocol_binary_response_header
) + 8];
348 } protocol_binary_response_incr
;
349 typedef protocol_binary_response_incr protocol_binary_response_decr
;
352 * Definition of the quit
355 typedef protocol_binary_request_no_extras protocol_binary_request_quit
;
358 * Definition of the packet returned by the quit command
361 typedef protocol_binary_response_no_extras protocol_binary_response_quit
;
364 * Definition of the packet used by append and prepend command
367 typedef protocol_binary_request_no_extras protocol_binary_request_append
;
368 typedef protocol_binary_request_no_extras protocol_binary_request_prepend
;
371 * Definition of the packet returned from a successful append or prepend
374 typedef protocol_binary_response_no_extras protocol_binary_response_append
;
375 typedef protocol_binary_response_no_extras protocol_binary_response_prepend
;
378 * Definition of the packet used by the version command
381 typedef protocol_binary_request_no_extras protocol_binary_request_version
;
384 * Definition of the packet returned from a successful version command
387 typedef protocol_binary_response_no_extras protocol_binary_response_version
;
390 * Definition of the packet used by the stats command.
393 typedef protocol_binary_request_no_extras protocol_binary_request_stats
;
396 * Definition of the packet returned from a successful stats command
399 typedef protocol_binary_response_no_extras protocol_binary_response_stats
;
402 * Definition of the packet used by the verbosity command
406 protocol_binary_request_header header
;
411 uint8_t bytes
[sizeof(protocol_binary_request_header
) + 4];
412 } protocol_binary_request_verbosity
;
415 * Definition of the packet returned from the verbosity command
417 typedef protocol_binary_response_no_extras protocol_binary_response_verbosity
;
420 * Definition of the packet used by the touch command.
424 protocol_binary_request_header header
;
429 uint8_t bytes
[sizeof(protocol_binary_request_header
) + 4];
430 } protocol_binary_request_touch
;
433 * Definition of the packet returned from the touch command
435 typedef protocol_binary_response_no_extras protocol_binary_response_touch
;
438 * Definition of the packet used by the GAT(Q) command.
442 protocol_binary_request_header header
;
447 uint8_t bytes
[sizeof(protocol_binary_request_header
) + 4];
448 } protocol_binary_request_gat
;
450 typedef protocol_binary_request_gat protocol_binary_request_gatq
;
453 * Definition of the packet returned from the GAT(Q)
455 typedef protocol_binary_response_get protocol_binary_response_gat
;
456 typedef protocol_binary_response_get protocol_binary_response_gatq
;
459 * Definition of a request for a range operation.
460 * See http://code.google.com/p/memcached/wiki/RangeOps
462 * These types are used for range operations and exist within
463 * this header for use in other projects. Range operations are
464 * not expected to be implemented in the memcached server itself.
468 protocol_binary_response_header header
;
473 uint32_t max_results
;
476 uint8_t bytes
[sizeof(protocol_binary_request_header
) + 4];
477 } protocol_binary_request_rangeop
;
479 typedef protocol_binary_request_rangeop protocol_binary_request_rget
;
480 typedef protocol_binary_request_rangeop protocol_binary_request_rset
;
481 typedef protocol_binary_request_rangeop protocol_binary_request_rsetq
;
482 typedef protocol_binary_request_rangeop protocol_binary_request_rappend
;
483 typedef protocol_binary_request_rangeop protocol_binary_request_rappendq
;
484 typedef protocol_binary_request_rangeop protocol_binary_request_rprepend
;
485 typedef protocol_binary_request_rangeop protocol_binary_request_rprependq
;
486 typedef protocol_binary_request_rangeop protocol_binary_request_rdelete
;
487 typedef protocol_binary_request_rangeop protocol_binary_request_rdeleteq
;
488 typedef protocol_binary_request_rangeop protocol_binary_request_rincr
;
489 typedef protocol_binary_request_rangeop protocol_binary_request_rincrq
;
490 typedef protocol_binary_request_rangeop protocol_binary_request_rdecr
;
491 typedef protocol_binary_request_rangeop protocol_binary_request_rdecrq
;
494 * Definition of tap commands
501 protocol_binary_request_header header
;
504 * flags is a bitmask used to set properties for the
505 * the connection. Please In order to be forward compatible
506 * you should set all undefined bits to 0.
508 * If the bit require extra userdata, it will be stored
509 * in the user-data field of the body (passed to the engine
510 * as enginespeciffic). That means that when you parse the
511 * flags and the engine-specific data, you have to work your
512 * way from bit 0 and upwards to find the correct offset for
521 * By using this flag you can limit the amount of data being
522 * transmitted. If you don't specify a backfill age, the
523 * server will transmit everything it contains.
525 * The first 8 bytes in the engine specific data contains
526 * the oldest entry (from epoc) you're interested in.
527 * Specifying a time in the future (for the server you are
528 * connecting to), will cause it to start streaming current
531 #define TAP_CONNECT_FLAG_BACKFILL 0x01
533 * Dump will cause the server to send the data stored on the
534 * server, but disconnect when the keys stored in the server
537 #define TAP_CONNECT_FLAG_DUMP 0x02
539 * The body contains a list of 16 bits words in network byte
540 * order specifying the vbucket ids to monitor. The first 16
541 * bit word contains the number of buckets. The number of 0
542 * means "all buckets"
544 #define TAP_CONNECT_FLAG_LIST_VBUCKETS 0x04
546 * The responsibility of the vbuckets is to be transferred
547 * over to the caller when all items are transferred.
549 #define TAP_CONNECT_FLAG_TAKEOVER_VBUCKETS 0x08
551 * The tap consumer supports ack'ing of tap messages
553 #define TAP_CONNECT_SUPPORT_ACK 0x10
555 * The tap consumer would prefer to just get the keys
556 * back. If the engine supports this it will set
557 * the TAP_FLAG_NO_VALUE flag in each of the
558 * tap packets returned.
560 #define TAP_CONNECT_REQUEST_KEYS_ONLY 0x20
562 * The body contains a list of (vbucket_id, last_checkpoint_id)
563 * pairs. This provides the checkpoint support in TAP streams.
564 * The last checkpoint id represents the last checkpoint that
565 * was successfully persisted.
567 #define TAP_CONNECT_CHECKPOINT 0x40
569 * The tap consumer is a registered tap client, which means that
570 * the tap server will maintain its checkpoint cursor permanently.
572 #define TAP_CONNECT_REGISTERED_CLIENT 0x80
575 uint8_t bytes
[sizeof(protocol_binary_request_header
) + 4];
576 } protocol_binary_request_tap_connect
;
580 protocol_binary_request_header header
;
583 uint16_t enginespecific_length
;
585 * The flag section support the following flags
588 * Request that the consumer send a response packet
589 * for this packet. The opaque field must be preserved
592 #define TAP_FLAG_ACK 0x01
594 * The value for the key is not included in the packet
596 #define TAP_FLAG_NO_VALUE 0x02
609 uint8_t bytes
[sizeof(protocol_binary_request_header
) + 16];
610 } protocol_binary_request_tap_mutation
;
614 protocol_binary_request_header header
;
617 uint16_t enginespecific_length
;
619 * See the definition of the flags for
620 * protocol_binary_request_tap_mutation for a description
621 * of the available flags.
631 uint8_t bytes
[sizeof(protocol_binary_request_header
) + 8];
632 } protocol_binary_request_tap_no_extras
;
634 typedef protocol_binary_request_tap_no_extras protocol_binary_request_tap_delete
;
635 typedef protocol_binary_request_tap_no_extras protocol_binary_request_tap_flush
;
636 typedef protocol_binary_request_tap_no_extras protocol_binary_request_tap_opaque
;
637 typedef protocol_binary_request_tap_no_extras protocol_binary_request_tap_vbucket_set
;
640 * Definition of the packet used by the scrub.
642 typedef protocol_binary_request_no_extras protocol_binary_request_scrub
;
645 * Definition of the packet returned from scrub.
647 typedef protocol_binary_response_no_extras protocol_binary_response_scrub
;
650 * Definition of the packet used by set vbucket
654 protocol_binary_request_header header
;
656 vbucket_state_t state
;
659 uint8_t bytes
[sizeof(protocol_binary_request_header
) + sizeof(vbucket_state_t
)];
660 } protocol_binary_request_set_vbucket
;
662 * Definition of the packet returned from set vbucket
664 typedef protocol_binary_response_no_extras protocol_binary_response_set_vbucket
;
666 * Definition of the packet used by del vbucket
668 typedef protocol_binary_request_no_extras protocol_binary_request_del_vbucket
;
670 * Definition of the packet returned from del vbucket
672 typedef protocol_binary_response_no_extras protocol_binary_response_del_vbucket
;
675 * Definition of the packet used by get vbucket
677 typedef protocol_binary_request_no_extras protocol_binary_request_get_vbucket
;
680 * Definition of the packet returned from get vbucket
684 protocol_binary_response_header header
;
686 vbucket_state_t state
;
689 uint8_t bytes
[sizeof(protocol_binary_response_header
) + sizeof(vbucket_state_t
)];
690 } protocol_binary_response_get_vbucket
;
699 #endif /* PROTOCOL_BINARY_H */