1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
use crate::resp2::types::Frame as Resp2Frame;
use crate::resp3::types::Frame as Resp3Frame;
use crate::types::*;
use bytes::BytesMut;
use cookie_factory::GenError;
use crc16::{State, XMODEM};
use std::str;
pub const KB: usize = 1024;
pub const ZEROED_KB: &'static [u8; 1024] = &[0; 1024];
pub const REDIS_CLUSTER_SLOTS: u16 = 16384;
pub const PUBSUB_PREFIX: &'static str = "message";
pub const PATTERN_PUBSUB_PREFIX: &'static str = "pmessage";
pub const PUBSUB_PUSH_PREFIX: &'static str = "pubsub";
macro_rules! unwrap_return(
($expr:expr) => {
match $expr {
Some(val) => val,
None => return None,
}
};
);
macro_rules! encode_checks(
($x:ident, $required:expr) => {
let _ = crate::utils::check_offset(&$x)?;
let required = $required;
let remaining = $x.0.len() - $x.1;
if remaining < required {
return Err(cookie_factory::GenError::BufferTooSmall(required - remaining));
}
}
);
pub fn resp2_frame_to_resp3(frame: Resp2Frame) -> Resp3Frame {
if frame.is_normal_pubsub() {
let mut out = Vec::with_capacity(4);
out.push(Resp3Frame::SimpleString {
data: PUBSUB_PUSH_PREFIX.to_owned(),
attributes: None,
});
out.push(Resp3Frame::SimpleString {
data: PUBSUB_PREFIX.to_owned(),
attributes: None,
});
if let Resp2Frame::Array(mut inner) = frame {
let message = inner.pop().unwrap();
let channel = inner.pop().unwrap();
out.push(resp2_frame_to_resp3(channel));
out.push(resp2_frame_to_resp3(message));
} else {
panic!("Invalid pubsub frame conversion to resp3. This is a bug.");
}
return Resp3Frame::Push {
data: out,
attributes: None,
};
}
if frame.is_pattern_pubsub_message() {
let mut out = Vec::with_capacity(4);
out.push(Resp3Frame::SimpleString {
data: PUBSUB_PUSH_PREFIX.to_owned(),
attributes: None,
});
out.push(Resp3Frame::SimpleString {
data: PATTERN_PUBSUB_PREFIX.to_owned(),
attributes: None,
});
if let Resp2Frame::Array(mut inner) = frame {
let message = inner.pop().unwrap();
let channel = inner.pop().unwrap();
out.push(resp2_frame_to_resp3(channel));
out.push(resp2_frame_to_resp3(message));
} else {
panic!("Invalid pattern pubsub frame conversion to resp3. This is a bug.");
}
return Resp3Frame::Push {
data: out,
attributes: None,
};
}
match frame {
Resp2Frame::Integer(i) => Resp3Frame::Number {
data: i,
attributes: None,
},
Resp2Frame::Error(s) => Resp3Frame::SimpleError {
data: s,
attributes: None,
},
Resp2Frame::BulkString(d) => {
if d.len() < 6 {
match str::from_utf8(&d).ok() {
Some(s) => match s.as_ref() {
"true" => Resp3Frame::Boolean {
data: true,
attributes: None,
},
"false" => Resp3Frame::Boolean {
data: false,
attributes: None,
},
_ => Resp3Frame::BlobString {
data: d,
attributes: None,
},
},
None => Resp3Frame::BlobString {
data: d,
attributes: None,
},
}
} else {
Resp3Frame::BlobString {
data: d,
attributes: None,
}
}
}
Resp2Frame::SimpleString(s) => Resp3Frame::SimpleString {
data: s,
attributes: None,
},
Resp2Frame::Null => Resp3Frame::Null,
Resp2Frame::Array(data) => {
let mut out = Vec::with_capacity(data.len());
for frame in data.into_iter() {
out.push(resp2_frame_to_resp3(frame));
}
Resp3Frame::Array {
data: out,
attributes: None,
}
}
}
}
pub fn resp3_frame_to_resp2(frame: Resp3Frame) -> Result<Resp2Frame, RedisProtocolError> {
if frame.attributes().is_some() {
return Err(RedisProtocolError::new(
RedisProtocolErrorKind::Unknown,
"Cannot convert RESP3 frame with attributes to RESP2.",
));
}
if frame.is_pubsub_message() {
let mut out = Vec::with_capacity(3);
out.push(Resp2Frame::SimpleString(PUBSUB_PREFIX.to_owned()));
if let Resp3Frame::Push { mut data, .. } = frame {
let message = data.pop().unwrap();
let channel = data.pop().unwrap();
out.push(resp3_frame_to_resp2(channel)?);
out.push(resp3_frame_to_resp2(message)?);
} else {
panic!("Invalid pubsub frame converting to resp2 frame.");
}
return Ok(Resp2Frame::Array(out));
}
match frame {
Resp3Frame::Array { data, .. } => {
let mut out = Vec::with_capacity(data.len());
for frame in data.into_iter() {
out.push(resp3_frame_to_resp2(frame)?);
}
Ok(Resp2Frame::Array(out))
}
Resp3Frame::Push { data: _, .. } => Err(RedisProtocolError::new(
RedisProtocolErrorKind::Unknown,
"Cannot convert non-pubsub PUSH frame to RESP2 frame.",
)),
Resp3Frame::BlobString { data, .. } => Ok(Resp2Frame::BulkString(data)),
Resp3Frame::BlobError { data: _, .. } => Err(RedisProtocolError::new(
RedisProtocolErrorKind::Unknown,
"Cannot convert BlobError to RESP2 frame.",
)),
Resp3Frame::BigNumber { data, .. } => Ok(Resp2Frame::BulkString(data)),
Resp3Frame::Boolean { data, .. } => {
if data {
Ok(Resp2Frame::BulkString("true".into()))
} else {
Ok(Resp2Frame::BulkString("false".into()))
}
}
Resp3Frame::Number { data, .. } => Ok(Resp2Frame::Integer(data)),
Resp3Frame::Double { data, .. } => Ok(Resp2Frame::BulkString(data.to_string().into_bytes())),
Resp3Frame::VerbatimString { data, .. } => Ok(Resp2Frame::BulkString(data)),
Resp3Frame::SimpleError { data, .. } => Ok(Resp2Frame::Error(data)),
Resp3Frame::SimpleString { data, .. } => Ok(Resp2Frame::SimpleString(data)),
Resp3Frame::Set { data, .. } => {
let mut out = Vec::with_capacity(data.len());
for frame in data.into_iter() {
out.push(resp3_frame_to_resp2(frame)?);
}
Ok(Resp2Frame::Array(out))
}
Resp3Frame::Map { data: _, .. } => Err(RedisProtocolError::new(
RedisProtocolErrorKind::Unknown,
"Cannot convert Map to RESP2 frame.",
)),
Resp3Frame::Null => Ok(Resp2Frame::Null),
Resp3Frame::ChunkedString(_) => Err(RedisProtocolError::new(
RedisProtocolErrorKind::Unknown,
"Cannot convert ChunkedString to RESP2 frame.",
)),
Resp3Frame::Hello { .. } => Err(RedisProtocolError::new(
RedisProtocolErrorKind::Unknown,
"Cannot convert HELLO to RESP2 frame.",
)),
}
}
pub fn check_offset(x: &(&mut [u8], usize)) -> Result<(), GenError> {
if x.1 > x.0.len() {
error!("Invalid offset of {} with buf len {}", x.1, x.0.len());
Err(GenError::InvalidOffset)
} else {
Ok(())
}
}
pub fn digits_in_number(d: usize) -> usize {
if d == 0 {
return 1;
}
((d as f64).log10()).floor() as usize + 1
}
pub fn zero_extend(buf: &mut BytesMut, mut amt: usize) {
trace!("allocating more, len: {}, amt: {}", buf.len(), amt);
buf.reserve(amt);
while amt >= KB {
buf.extend_from_slice(ZEROED_KB);
amt -= KB;
}
if amt > 0 {
buf.extend_from_slice(&ZEROED_KB[0..amt]);
}
}
pub fn is_cluster_error(payload: &str) -> bool {
if payload.starts_with("MOVED") || payload.starts_with("ASK") {
payload.split(" ").fold(0, |c, _| c + 1) == 3
} else {
false
}
}
pub fn read_cluster_error(payload: &str) -> Option<Redirection> {
if payload.starts_with("MOVED") {
let parts: Vec<&str> = payload.split(" ").collect();
if parts.len() == 3 {
let slot = unwrap_return!(parts[1].parse::<u16>().ok());
let server = parts[2].to_owned();
Some(Redirection::Moved { slot, server })
} else {
None
}
} else if payload.starts_with("ASK") {
let parts: Vec<&str> = payload.split(" ").collect();
if parts.len() == 3 {
let slot = unwrap_return!(parts[1].parse::<u16>().ok());
let server = parts[2].to_owned();
Some(Redirection::Ask { slot, server })
} else {
None
}
} else {
None
}
}
fn crc16_xmodem(key: &str) -> u16 {
State::<XMODEM>::calculate(key.as_bytes()) % REDIS_CLUSTER_SLOTS
}
pub fn redis_keyslot(key: &str) -> u16 {
let (mut i, mut j): (Option<usize>, Option<usize>) = (None, None);
for (idx, c) in key.chars().enumerate() {
if c == '{' {
i = Some(idx);
break;
}
}
if i.is_none() || (i.is_some() && i.unwrap() == key.len() - 1) {
return crc16_xmodem(key);
}
let i = i.unwrap();
for (idx, c) in key[i + 1..].chars().enumerate() {
if c == '}' {
j = Some(idx);
break;
}
}
if j.is_none() {
return crc16_xmodem(key);
}
let j = j.unwrap();
let out = if i + j == key.len() || j == 0 {
crc16_xmodem(key)
} else {
crc16_xmodem(&key[i + 1..i + j + 1])
};
trace!("mapped {} to redis slot {}", key, out);
out
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn should_crc16_123456789() {
let key = "123456789";
let expected: u16 = 12739;
let actual = redis_keyslot(key);
assert_eq!(actual, expected);
}
#[test]
fn should_crc16_with_brackets() {
let key = "foo{123456789}bar";
let expected: u16 = 12739;
let actual = redis_keyslot(key);
assert_eq!(actual, expected);
}
#[test]
fn should_crc16_with_brackets_no_padding() {
let key = "{123456789}";
let expected: u16 = 12739;
let actual = redis_keyslot(key);
assert_eq!(actual, expected);
}
#[test]
fn should_crc16_with_invalid_brackets_lhs() {
let key = "foo{123456789";
let expected: u16 = 10378;
let actual = redis_keyslot(key);
assert_eq!(actual, expected);
}
#[test]
fn should_crc16_with_invalid_brackets_rhs() {
let key = "foo}123456789";
let expected: u16 = 6965;
let actual = redis_keyslot(key);
assert_eq!(actual, expected);
}
#[test]
fn should_crc16_with_random_string() {
let key = "8xjx7vWrfPq54mKfFD3Y1CcjjofpnAcQ";
let expected: u16 = 5458;
let actual = redis_keyslot(key);
assert_eq!(actual, expected);
}
}