Skip to content

Commit 082ff30

Browse files
m6w6m6w6
committed
libmemcached: add MEMCACHED_BEHAVIOR_META_PROTOCOL
1 parent 4b22e28 commit 082ff30

32 files changed

+789
-274
lines changed

‎ChangeLog-1.1.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,10 +67,6 @@ the full list of changes since the last 1.0 release.
6767

6868
> released 2020-12-21
6969
70-
**NOTE:**
71-
This is a bug fix release, not a feature release. The minor version number
72-
was incremented due to the following changes:
73-
7470
* Ported build system to CMake.
7571
* Ported test suite to Catch2.
7672
* Build requires C++11 compiler support.

‎ChangeLog-1.2.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# ChangeLog v1.2
2+
3+
## v 1.2.0-beta1
4+
5+
> released TBD
6+
7+
* Initial transparent support for the memcached META protocol:
8+
* Add `MEMCACHED_BEHAVIOR_META_PROTOCOL` enabling the META protocol.
9+
* Add `-m` switch to client programs enabling the META protocol.
10+

‎ChangeLog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
ChangeLog-1.1.md
1+
ChangeLog-1.2.md

‎docs/source/ChangeLog-1.1.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -96,10 +96,6 @@ v 1.1.0-beta1
9696
released 2020-12-21
9797

9898

99-
**NOTE:**\ :raw-html-m2r:`<br>`
100-
This is a bug fix release, not a feature release. The minor version number
101-
was incremented due to the following changes:
102-
10399

104100
* Ported build system to CMake.
105101
* Ported test suite to Catch2.

‎docs/source/ChangeLog-1.2.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
2+
ChangeLog v1.2
3+
==============
4+
5+
v 1.2.0-beta1
6+
-------------
7+
8+
..
9+
10+
released TBD
11+
12+
13+
14+
* Initial transparent support for the memcached META protocol:
15+
16+
* Add ``MEMCACHED_BEHAVIOR_META_PROTOCOL`` enabling the META protocol.
17+
* Add ``-m`` switch to client programs enabling the META protocol.

‎docs/source/changelogs.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@ Change Logs
33

44
.. toctree::
55

6-
ChangeLog-1.1
6+
ChangeLog-1.2
77

88
.. toctree::
99
:maxdepth: 1
1010

11+
ChangeLog-1.1
1112
ChangeLog-1.0
1213
ChangeLog-0

‎docs/source/libmemcached/memcached_behavior.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,12 @@ SYNOPSIS
179179
Enable the use of the binary protocol. Please note that you cannot
180180
toggle this flag on an open connection.
181181

182+
.. enumerator:: MEMCACHED_BEHAVIOR_META_PROTOCOL
183+
184+
Enable the use of the META protocol. This setting can be switched on and
185+
off at will when using an ASCII protocol connection, but causes
186+
a reconnect when using the binary protocol.
187+
182188
.. enumerator:: MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK
183189

184190
Set this value to tune the number of messages that may be sent before

‎include/libmemcached-1.0/struct/memcached.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ struct memcached_st {
4343
bool tcp_keepalive : 1;
4444
bool is_aes : 1;
4545
bool is_fetching_version : 1;
46-
bool not_used : 1;
46+
bool meta_protocol : 1;
4747
} flags;
4848

4949
memcached_server_distribution_t distribution;

‎include/libmemcached-1.0/types/behavior.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ enum memcached_behavior_t {
5454
MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS,
5555
MEMCACHED_BEHAVIOR_DEAD_TIMEOUT,
5656
MEMCACHED_BEHAVIOR_SERVER_TIMEOUT_LIMIT,
57+
MEMCACHED_BEHAVIOR_META_PROTOCOL,
5758
MEMCACHED_BEHAVIOR_MAX
5859
};
5960

‎src/bin/common/options.hpp

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,17 @@ class client_options {
125125
}
126126
return true;
127127
};
128+
def("meta", 'm', no_argument, "Use the text based meta memcached protocol.")
129+
.apply = [](const client_options &opt_, const extended_option &ext, memcached_st *memc) {
130+
if (MEMCACHED_SUCCESS != memcached_behavior_set(memc, MEMCACHED_BEHAVIOR_META_PROTOCOL, ext.set)) {
131+
if (!opt_.isset("quiet")) {
132+
std::cerr << memcached_last_error_message(memc);
133+
}
134+
return false;
135+
}
136+
return true;
137+
};
138+
128139
def("buffer", 'B', no_argument, "Buffer requests.")
129140
.apply = [](const client_options &opt, const extended_option &ext, memcached_st *memc) {
130141
if (MEMCACHED_SUCCESS != memcached_behavior_set(memc, MEMCACHED_BEHAVIOR_BUFFER_REQUESTS, ext.set)) {

‎src/bin/memslap.cc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ int main(int argc, char *argv[]) {
242242
opt.add("noreply", 'R', no_argument, "Enable the NOREPLY behavior for storage commands.")
243243
.apply = [](const client_options &opt_, const client_options::extended_option &ext, memcached_st *memc) {
244244
if (MEMCACHED_SUCCESS != memcached_behavior_set(memc, MEMCACHED_BEHAVIOR_NOREPLY, ext.set)) {
245-
if(!opt_.isset("quiet")) {
245+
if (!opt_.isset("quiet")) {
246246
std::cerr << memcached_last_error_message(memc);
247247
}
248248
return false;

‎src/libmemcached/auto.cc

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,47 @@ static void auto_response(memcached_instance_st *instance, const bool reply, mem
3939
}
4040
}
4141

42+
static memcached_return_t meta_incr_decr(memcached_instance_st *instance, bool is_incr, bool w_init,
43+
const char *key, size_t key_len,
44+
uint64_t offset, uint64_t initial, uint32_t expiration) {
45+
char new_buf[32] = " N", inl_buf[32] = " J", dlt_buf[32] = " D", exp_buf[32] = " T";
46+
size_t new_len = strlen(new_buf), inl_len = strlen(inl_buf), dlt_len = strlen(dlt_buf), exp_len = strlen(exp_buf);
47+
size_t io_num = 0;
48+
libmemcached_io_vector_st io_vec[10] = {};
49+
50+
io_vec[io_num++] = {memcached_literal_param("ma ")};
51+
io_vec[io_num++] = {memcached_array_string(instance->root->_namespace),
52+
memcached_array_size(instance->root->_namespace)},
53+
io_vec[io_num++] = {key, key_len};
54+
55+
if (!is_incr) {
56+
io_vec[io_num++] = {memcached_literal_param(" MD")};
57+
}
58+
if (w_init) {
59+
new_len += snprintf(new_buf + new_len, sizeof(new_buf) - new_len, "%" PRIu32, expiration);
60+
io_vec[io_num++] = {new_buf, new_len};
61+
inl_len += snprintf(inl_buf + inl_len, sizeof(inl_buf) - inl_len, "%" PRIu64, initial);
62+
io_vec[io_num++] = {inl_buf, inl_len};
63+
}
64+
if (offset != 1) {
65+
dlt_len += snprintf(dlt_buf + dlt_len, sizeof(dlt_buf) - dlt_len, "%" PRIu64, offset);
66+
io_vec[io_num++] = {dlt_buf, dlt_len};
67+
}
68+
if (expiration) {
69+
exp_len += snprintf(exp_buf + exp_len, sizeof(exp_buf) - exp_len, "%" PRIu32, expiration);
70+
io_vec[io_num++] = {exp_buf, exp_len};
71+
}
72+
73+
if (memcached_is_replying(instance->root)) {
74+
io_vec[io_num++] = {memcached_literal_param(" v")};
75+
} else {
76+
io_vec[io_num++] = {memcached_literal_param(" q")};
77+
}
78+
io_vec[io_num++] = {memcached_literal_param(" O+\r\n")};
79+
80+
return memcached_vdo(instance, io_vec, io_num, true);
81+
}
82+
4283
static memcached_return_t text_incr_decr(memcached_instance_st *instance, const bool is_incr,
4384
const char *key, size_t key_length, const uint64_t offset,
4485
const bool reply) {
@@ -145,6 +186,8 @@ static memcached_return_t increment_decrement_by_key(const protocol_binary_comma
145186
if (memcached_is_binary(memc)) {
146187
rc = binary_incr_decr(instance, command, key, key_length, uint64_t(offset), 0,
147188
MEMCACHED_EXPIRATION_NOT_ADD, reply);
189+
} else if (memcached_is_meta(memc)) {
190+
rc = meta_incr_decr(instance, command == PROTOCOL_BINARY_CMD_INCREMENT, false, key, key_length, offset, 0, 0);
148191
} else {
149192
rc = text_incr_decr(instance, command == PROTOCOL_BINARY_CMD_INCREMENT ? true : false, key,
150193
key_length, offset, reply);
@@ -189,7 +232,9 @@ increment_decrement_with_initial_by_key(const protocol_binary_command command, M
189232
if (memcached_is_binary(memc)) {
190233
rc = binary_incr_decr(instance, command, key, key_length, offset, initial, uint32_t(expiration),
191234
reply);
192-
235+
} else if (memcached_is_meta(memc)) {
236+
rc = meta_incr_decr(instance, command == PROTOCOL_BINARY_CMD_INCREMENT, true,
237+
key, key_length, offset, initial, uint32_t(expiration));
193238
} else {
194239
rc = memcached_set_error(
195240
*memc, MEMCACHED_INVALID_ARGUMENTS, MEMCACHED_AT,

‎src/libmemcached/behavior.cc

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,14 +96,22 @@ memcached_return_t memcached_behavior_set(memcached_st *shell, const memcached_b
9696
break;
9797

9898
case MEMCACHED_BEHAVIOR_BINARY_PROTOCOL:
99-
send_quit(
100-
ptr); // We need t shutdown all of the connections to make sure we do the correct protocol
99+
// We need t shutdown all of the connections to make sure we do the correct protocol
100+
send_quit(ptr);
101101
if (data) {
102102
ptr->flags.verify_key = false;
103103
}
104104
ptr->flags.binary_protocol = bool(data);
105105
break;
106106

107+
case MEMCACHED_BEHAVIOR_META_PROTOCOL:
108+
if (data && ptr->flags.binary_protocol) {
109+
send_quit(ptr);
110+
ptr->flags.binary_protocol = false;
111+
}
112+
ptr->flags.meta_protocol = bool(data);
113+
break;
114+
107115
case MEMCACHED_BEHAVIOR_SUPPORT_CAS:
108116
ptr->flags.support_cas = bool(data);
109117
break;
@@ -623,6 +631,8 @@ const char *libmemcached_string_behavior(const memcached_behavior_t flag) {
623631
return "MEMCACHED_BEHAVIOR_KETAMA_HASH";
624632
case MEMCACHED_BEHAVIOR_BINARY_PROTOCOL:
625633
return "MEMCACHED_BEHAVIOR_BINARY_PROTOCOL";
634+
case MEMCACHED_BEHAVIOR_META_PROTOCOL:
635+
return "MEMCACHED_BEHAVIOR_META_PROTOCOL";
626636
case MEMCACHED_BEHAVIOR_SND_TIMEOUT:
627637
return "MEMCACHED_BEHAVIOR_SND_TIMEOUT";
628638
case MEMCACHED_BEHAVIOR_RCV_TIMEOUT:

‎src/libmemcached/delete.cc

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,30 @@ memcached_return_t memcached_delete(memcached_st *shell, const char *key, size_t
2020
return memcached_delete_by_key(shell, key, key_length, key, key_length, expiration);
2121
}
2222

23+
static inline memcached_return_t meta_delete(memcached_instance_st *instance,
24+
const char *key, size_t key_length,
25+
time_t expiration) {
26+
27+
char ex_buf[32] = " I T";
28+
size_t io_num = 0, ex_len = strlen(ex_buf);
29+
libmemcached_io_vector_st io_vec[6] = {};
30+
io_vec[io_num++] = {memcached_literal_param("md ")};
31+
io_vec[io_num++] = {memcached_array_string(instance->root->_namespace),
32+
memcached_array_size(instance->root->_namespace)};
33+
io_vec[io_num++] = {key, key_length};
34+
if (!memcached_is_replying(instance->root)) {
35+
io_vec[io_num++] = {" q", 2};
36+
}
37+
if (expiration) {
38+
ex_len += snprintf(ex_buf + ex_len, sizeof(ex_buf) - ex_len, "%llu", (unsigned long long) expiration);
39+
io_vec[io_num++] = {ex_buf, ex_len};
40+
}
41+
io_vec[io_num++] = {memcached_literal_param("\r\n")};
42+
43+
/* Send command header, only flush if we are NOT buffering */
44+
return memcached_vdo(instance, io_vec, io_num, !memcached_is_buffering(instance->root));
45+
}
46+
2347
static inline memcached_return_t ascii_delete(memcached_instance_st *instance, uint32_t,
2448
const char *key, const size_t key_length,
2549
const bool reply, const bool is_buffering) {
@@ -85,10 +109,9 @@ static inline memcached_return_t binary_delete(memcached_instance_st *instance,
85109
return rc;
86110
}
87111

88-
memcached_return_t memcached_delete_by_key(memcached_st *shell, const char *group_key,
112+
memcached_return_t memcached_delete_by_key(memcached_st *memc, const char *group_key,
89113
size_t group_key_length, const char *key,
90114
size_t key_length, time_t expiration) {
91-
Memcached *memc = memcached2Memcached(shell);
92115
LIBMEMCACHED_MEMCACHED_DELETE_START();
93116

94117
memcached_return_t rc;
@@ -100,16 +123,15 @@ memcached_return_t memcached_delete_by_key(memcached_st *shell, const char *grou
100123
return memcached_last_error(memc);
101124
}
102125

103-
if (expiration) {
126+
if (expiration && !memcached_is_meta(memc)) {
104127
return memcached_set_error(
105128
*memc, MEMCACHED_INVALID_ARGUMENTS, MEMCACHED_AT,
106129
memcached_literal_param(
107130
"Memcached server version does not allow expiration of deleted items"));
108131
}
109132

110-
uint32_t server_key =
111-
memcached_generate_hash_with_redistribution(memc, group_key, group_key_length);
112-
memcached_instance_st *instance = memcached_instance_fetch(memc, server_key);
133+
auto server_key = memcached_generate_hash_with_redistribution(memc, group_key, group_key_length);
134+
auto *instance = memcached_instance_fetch(memc, server_key);
113135

114136
bool is_buffering = memcached_is_buffering(instance->root);
115137
bool is_replying = memcached_is_replying(instance->root);
@@ -132,6 +154,8 @@ memcached_return_t memcached_delete_by_key(memcached_st *shell, const char *grou
132154

133155
if (memcached_is_binary(memc)) {
134156
rc = binary_delete(instance, server_key, key, key_length, is_replying, is_buffering);
157+
} else if (memcached_is_meta(memc)) {
158+
rc = meta_delete(instance, key, key_length, expiration);
135159
} else {
136160
rc = ascii_delete(instance, server_key, key, key_length, is_replying, is_buffering);
137161
}

‎src/libmemcached/fetch.cc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -167,8 +167,8 @@ memcached_result_st *memcached_fetch_result(memcached_st *ptr, memcached_result_
167167
*error = MEMCACHED_END;
168168
} else if (*error == MEMCACHED_MAXIMUM_RETURN and result->count) {
169169
*error = MEMCACHED_END;
170-
} else if (*error == MEMCACHED_MAXIMUM_RETURN) // while() loop was never entered
171-
{
170+
} else if (*error == MEMCACHED_MAXIMUM_RETURN) {
171+
// while() loop was never entered
172172
*error = MEMCACHED_NOTFOUND;
173173
} else if (connection_failures) {
174174
/*

0 commit comments

Comments
 (0)