libaster/protocol/redis/
resp.rs

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
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
use crate::com::*;
use crate::proxy::cluster::Redirect;
use crate::utils::simdfind;
use crate::utils::Range;

use aho_corasick::AhoCorasick;
use bytes::{BufMut, Bytes, BytesMut};

pub const RESP_STRING: u8 = b'+';
pub const RESP_INT: u8 = b':';
pub const RESP_ERROR: u8 = b'-';
pub const RESP_BULK: u8 = b'$';
pub const RESP_ARRAY: u8 = b'*';

pub const BYTE_CR: u8 = b'\r';
pub const BYTE_LF: u8 = b'\n';

pub const BYTES_CMD_CLUSTER_SLOTS: &[u8] = b"*2\r\n$7\r\nCLUSTER\r\n$5\r\nSLOTS\r\n";
pub const BYTES_CMD_CLUSTER_NODES: &[u8] = b"*2\r\n$7\r\nCLUSTER\r\n$5\r\nNODES\r\n";

// contains Range means body cursor range [begin..end] for non-array type
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum RespType {
    String(Range),
    Error(Range),
    Integer(Range),
    // contains head range and bulk body range
    Bulk(Range, Range),
    // contains head range and sub vecs
    Array(Range, Vec<RespType>),

    Inline(Vec<Range>),
}

impl RespType {
    pub fn array(self) -> Option<Vec<RespType>> {
        match self {
            RespType::Array(_, rv) => Some(rv),
            _ => None,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct MessageMut {
    pub rtype: RespType,
    pub data: BytesMut,
}

impl MessageMut {
    fn try_parse_inline(src: &[u8]) -> Result<Option<MsgPack>, AsError> {
        let mut cursor = 0;
        let mut fields = Vec::new();
        for data in src.split(|x| *x == BYTE_SPACE) {
            fields.push(Range::new(cursor, cursor + data.len()));
            cursor = cursor + data.len() + 1;
        }
        Ok(Some(MsgPack {
            rtype: RespType::Inline(fields),
            size: src.len(),
        }))
    }

    fn parse_inner(cursor: usize, src: &[u8]) -> Result<Option<MsgPack>, AsError> {
        let pos = if let Some(p) = simdfind::find_lf_simd(&src[cursor..]) {
            p
        } else {
            return Ok(None);
        };

        if pos == 0 {
            return Err(AsError::BadMessage);
        }

        // detect pos -1 is CR
        if src[cursor + pos - 1] != BYTE_CR {
            // should detect inline
            return Self::try_parse_inline(&src[cursor..cursor + pos + 1]);
        }

        match src[cursor] {
            RESP_STRING => {
                return Ok(Some(MsgPack {
                    rtype: RespType::String(Range::new(cursor, cursor + pos + 1)),
                    size: pos + 1,
                }));
            }
            RESP_INT => {
                return Ok(Some(MsgPack {
                    rtype: RespType::Integer(Range::new(cursor, cursor + pos + 1)),
                    size: pos + 1,
                }));
            }
            RESP_ERROR => {
                return Ok(Some(MsgPack {
                    rtype: RespType::Error(Range::new(cursor, cursor + pos + 1)),
                    size: pos + 1,
                }));
            }
            RESP_BULK => {
                let csize = match btoi::btoi::<isize>(&src[cursor + 1..cursor + pos - 1]) {
                    Ok(csize) => csize,
                    Err(_err) => return Err(AsError::BadMessage),
                };

                if csize == -1 {
                    return Ok(Some(MsgPack {
                        rtype: RespType::Bulk(
                            Range::new(cursor, cursor + 5),
                            Range::new(cursor, cursor + 5),
                        ),
                        size: 5,
                    }));
                } else if csize < 0 {
                    return Err(AsError::BadMessage);
                }

                let total_size = (pos + 1) + (csize as usize) + 2;

                if src.len() >= cursor + total_size {
                    return Ok(Some(MsgPack {
                        rtype: RespType::Bulk(
                            Range::new(cursor, cursor + pos + 1),
                            Range::new(cursor + pos + 1, cursor + total_size),
                        ),
                        size: total_size,
                    }));
                }
            }
            RESP_ARRAY => {
                let csize = match btoi::btoi::<isize>(&src[cursor + 1..cursor + pos - 1]) {
                    Ok(csize) => csize,
                    Err(_err) => return Err(AsError::BadMessage),
                };
                if csize == -1 {
                    return Ok(Some(MsgPack {
                        rtype: RespType::Array(Range::new(cursor, cursor + 5), vec![]),
                        size: 5,
                    }));
                } else if csize < 0 {
                    return Err(AsError::BadMessage);
                }
                let mut mycursor = cursor + pos + 1;
                let mut items = Vec::new();
                for _ in 0..csize {
                    if let Some(MsgPack { rtype, size }) = Self::parse_inner(mycursor, &src[..])? {
                        mycursor += size;
                        items.push(rtype);
                    } else {
                        return Ok(None);
                    }
                }
                return Ok(Some(MsgPack {
                    rtype: RespType::Array(Range::new(cursor, cursor + pos + 1), items),
                    size: mycursor - cursor,
                }));
            }
            _ => {
                if cursor != 0 {
                    return Err(AsError::BadMessage);
                }
                // inline command
                return Self::try_parse_inline(&src[cursor..cursor + pos + 1]);
            }
        }

        Ok(None)
    }

    pub fn parse(src: &mut BytesMut) -> Result<Option<MessageMut>, AsError> {
        let rslt = match Self::parse_inner(0, &src[..]) {
            Ok(r) => r,
            Err(err) => {
                // TODO: should change it as wrong bad command error
                if let Some(pos) = simdfind::find_lf_simd(&src[..]) {
                    src.advance(pos + 1);
                }
                return Err(err);
            }
        };

        if let Some(MsgPack { size, rtype }) = rslt {
            let data = src.split_to(size);
            return Ok(Some(MessageMut { data, rtype }));
        }
        Ok(None)
    }
}

impl MessageMut {
    pub fn nth_mut(&mut self, index: usize) -> Option<&mut [u8]> {
        if let Some(range) = self.get_nth_data_range(index) {
            Some(&mut self.data.as_mut()[range.begin()..range.end()])
        } else {
            None
        }
    }

    pub fn nth(&self, index: usize) -> Option<&[u8]> {
        if let Some(range) = self.get_nth_data_range(index) {
            Some(&self.data.as_ref()[range.begin()..range.end()])
        } else {
            None
        }
    }

    fn get_nth_data_range(&self, index: usize) -> Option<Range> {
        if let RespType::Array(_, items) = &self.rtype {
            if let Some(item) = items.get(index) {
                match item {
                    RespType::String(Range { begin, end }) => {
                        return Some(Range {
                            begin: begin + 1,
                            end: end - 2,
                        });
                    }
                    RespType::Error(Range { begin, end }) => {
                        return Some(Range {
                            begin: begin + 1,
                            end: end - 2,
                        });
                    }
                    RespType::Integer(Range { begin, end }) => {
                        return Some(Range {
                            begin: begin + 1,
                            end: end - 2,
                        });
                    }
                    RespType::Bulk(_, Range { begin, end }) => {
                        return Some(Range {
                            begin: *begin,
                            end: end - 2,
                        });
                    }
                    _ => return None,
                }
            }
        }
        if let RespType::Inline(fields) = &self.rtype {
            if let Some(rng) = fields.get(index) {
                let mut end = rng.end();
                let len = rng.range();
                if len == 0 {
                    return Some(*rng);
                }
                if len > 0 && self.data[len - 1] == BYTE_LF {
                    end -= 1;
                    if len > 1 && self.data[len - 2] == BYTE_CR {
                        end -= 1;
                    }
                }
                return Some(Range::new(rng.begin(), end));
            }
        }
        None
    }
}

struct MsgPack {
    rtype: RespType,
    size: usize,
}

impl From<MessageMut> for Message {
    fn from(MessageMut { rtype, data }: MessageMut) -> Message {
        Message {
            data: data.freeze(),
            rtype,
        }
    }
}

pub struct MessageIter<'a> {
    msg: &'a Message,
    index: usize,
}

impl<'a> Iterator for MessageIter<'a> {
    type Item = &'a [u8];

    fn next(&mut self) -> Option<Self::Item> {
        let current = self.index;
        self.index += 1;
        self.msg.nth(current)
    }
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub struct Message {
    pub rtype: RespType,
    pub data: Bytes,
}

impl Message {
    pub fn new_cluster_slots() -> Message {
        Message {
            data: Bytes::from(BYTES_CMD_CLUSTER_SLOTS),
            rtype: RespType::Array(
                Range::new(0, 4),
                vec![
                    RespType::Bulk(Range::new(4, 8), Range::new(8, 17)),
                    RespType::Bulk(Range::new(17, 21), Range::new(21, 28)),
                ],
            ),
        }
    }

    pub fn new_read_only() -> Message {
        Message {
            data: Bytes::from("*1\r\n$8\r\nREADONLY\r\n"),
            rtype: RespType::Array(
                Range::new(0, 4),
                vec![RespType::Bulk(Range::new(4, 8), Range::new(8, 18))],
            ),
        }
    }

    pub fn new_ping_request() -> Message {
        Message {
            data: Bytes::from("*1\r\n$4\r\nPING\r\n"),
            rtype: RespType::Array(
                Range::new(0, 4),
                vec![RespType::Bulk(Range::new(4, 8), Range::new(8, 14))],
            ),
        }
    }

    pub fn inline_raw(data: Bytes) -> Message {
        let rngs = vec![Range::new(0, data.len())];
        Message {
            rtype: RespType::Inline(rngs),
            data,
        }
    }

    pub fn plain<I: Into<Bytes>>(data: I, resp_type: u8) -> Message {
        let bytes = data.into();
        let mut rdata = BytesMut::new();
        let total_len = 1 /* resp_type */ + bytes.len() + 2 /*\r\n*/;
        rdata.reserve(total_len);
        rdata.put_u8(resp_type);
        rdata.put(&bytes);
        rdata.put_u8(BYTE_CR);
        rdata.put_u8(BYTE_LF);

        let rtype = if resp_type == RESP_STRING {
            RespType::String(Range::new(0, total_len))
        } else if resp_type == RESP_INT {
            RespType::Integer(Range::new(0, total_len))
        } else if resp_type == RESP_ERROR {
            RespType::Error(Range::new(0, total_len))
        } else {
            unreachable!("fail to create uon plain message");
        };

        Message {
            data: rdata.into(),
            rtype,
        }
    }

    pub fn save(&self, buf: &mut BytesMut) -> usize {
        self.save_by_rtype(&self.rtype, buf)
    }

    pub fn save_by_rtype(&self, rtype: &RespType, buf: &mut BytesMut) -> usize {
        match rtype {
            RespType::String(rg) => {
                buf.extend_from_slice(&self.data.as_ref()[rg.begin()..rg.end()]);
                rg.range()
            }
            RespType::Error(rg) => {
                buf.extend_from_slice(&self.data.as_ref()[rg.begin()..rg.end()]);
                rg.range()
            }
            RespType::Integer(rg) => {
                buf.extend_from_slice(&self.data.as_ref()[rg.begin()..rg.end()]);
                rg.range()
            }
            RespType::Bulk(head, body) => {
                let data = &self.data.as_ref()[head.begin()..body.end()];
                buf.extend_from_slice(data);
                (body.end - head.begin) as usize
            }
            RespType::Array(head, subs) => {
                buf.extend_from_slice(&self.data.as_ref()[head.begin()..head.end()]);
                let mut size = head.range();
                for sub in subs {
                    size += self.save_by_rtype(sub, buf);
                }
                size
            }
            RespType::Inline(fields) => {
                let first_begin = fields.first().map(|x| x.begin()).unwrap_or(0);
                let last_end = fields.last().map(|x| x.end()).unwrap_or(0);
                if first_begin != last_end {
                    buf.extend_from_slice(&self.data.as_ref()[first_begin..last_end]);
                }
                last_end - first_begin
            }
        }
    }

    pub fn raw_data(&self) -> &[u8] {
        self.data.as_ref()
    }

    pub fn data(&self) -> Option<&[u8]> {
        let range = self.get_range(Some(&self.rtype));
        range.map(|rg| &self.data.as_ref()[rg.begin()..rg.end()])
    }

    pub fn nth(&self, index: usize) -> Option<&[u8]> {
        if let Some(range) = self.get_nth_data_range(index) {
            return Some(&self.data.as_ref()[range.begin()..range.end()]);
        }

        if index == 0 {
            // only zero shot path to data
            return self.data();
        }
        None
    }

    fn get_nth_data_range(&self, index: usize) -> Option<Range> {
        if let RespType::Array(_, items) = &self.rtype {
            return self.get_range(items.get(index));
        }
        if let RespType::Inline(fields) = &self.rtype {
            if let Some(rng) = fields.get(index) {
                let mut end = rng.end();
                let len = rng.range();
                if rng.begin() == rng.end() {
                    return Some(*rng);
                }
                if len > 0 && self.data[len - 1] == BYTE_LF {
                    end -= 1;
                    if len > 1 && self.data[len - 2] == BYTE_CR {
                        end -= 1;
                    }
                }
                return Some(Range::new(rng.begin(), end));
            }
        }
        None
    }

    pub(super) fn get_data_of_range(&self, rg: Range) -> &[u8] {
        &self.data.as_ref()[rg.begin()..rg.end()]
    }

    pub(super) fn get_range(&self, rtype: Option<&RespType>) -> Option<Range> {
        if let Some(item) = rtype {
            match item {
                RespType::String(Range { begin, end }) => {
                    return Some(Range {
                        begin: begin + 1,
                        end: end - 2,
                    })
                }
                RespType::Error(Range { begin, end }) => {
                    return Some(Range {
                        begin: begin + 1,
                        end: end - 2,
                    })
                }
                RespType::Integer(Range { begin, end }) => {
                    return Some(Range {
                        begin: begin + 1,
                        end: end - 2,
                    })
                }
                RespType::Bulk(_, Range { begin, end }) => {
                    return Some(Range {
                        begin: *begin,
                        end: end - 2,
                    })
                }
                _ => return None,
            }
        }

        None
    }

    pub fn iter(&self) -> MessageIter {
        MessageIter {
            msg: &self,
            index: 0,
        }
    }

    pub fn check_redirect(&self) -> Option<Redirect> {
        match self.rtype {
            RespType::Error(_) => {}
            _ => return None,
        }
        if let Some(data) = self.data().as_ref() {
            return parse_redirect(data);
        }
        None
    }
}

const BYTE_SPACE: u8 = b' ';
const PATTERNS: &[&str] = &["ASK", "MOVED"];

lazy_static! {
    static ref FINDER: AhoCorasick = AhoCorasick::new(PATTERNS);
}

fn parse_redirect(data: &[u8]) -> Option<Redirect> {
    if let Some(mat) = FINDER.find(data) {
        let pat = mat.pattern();
        let end = mat.end();
        let rdata = &data[end + 1..];

        let pos = rdata.iter().position(|&x| x == BYTE_SPACE)?;

        let sdata = &rdata[..pos];
        let tdata = &rdata[pos + 1..];
        if let Ok(slot) = btoi::btoi::<usize>(sdata) {
            let to = String::from_utf8_lossy(tdata);
            let to = to.to_string();
            if pat == 0 {
                return Some(Redirect::Ask { slot, to });
            } else {
                // moved
                return Some(Redirect::Move { slot, to });
            }
        }
    }
    None
}

#[test]
fn test_parse() {
    let data = b"*2\r\n$3\r\nget\r\n$4\r\nab\nc\r\n";
    let mut src = BytesMut::from(&data[..]);
    let msg = MessageMut::parse(&mut src).unwrap().unwrap();
    assert_eq!(msg.data.len(), data.len());
    assert_eq!(msg.nth(0).unwrap(), b"get");
    assert_eq!(msg.nth(1).unwrap(), b"ab\nc");
    match msg.rtype {
        RespType::Array(head, vals) => {
            assert_eq!(head.begin, 0);
            assert_eq!(head.end, 4);

            if let RespType::Bulk(h, body) = vals[0] {
                assert_eq!(h.begin, 4);
                assert_eq!(h.end, 8);

                assert_eq!(body.begin, 8);
                assert_eq!(body.end, 13);
            } else {
                panic!("fail to load bulk string");
            }

            if let RespType::Bulk(h, body) = vals[1] {
                assert_eq!(h.begin, 13);
                assert_eq!(h.end, 17);

                assert_eq!(body.begin, 17);
                assert_eq!(body.end, 23);
            } else {
                panic!("fail to load bulk string");
            }
        }
        other => {
            panic!("fail to parse {:?}", other);
        }
    }
}

#[cfg(test)]
mod test {
    use self::super::*;
    use assert2::{assert, check};

    #[test]
    fn test_iter() {
        let data = b"*2\r\n$3\r\nget\r\n$4\r\nab\nc\r\n";
        let mut src = BytesMut::from(&data[..]);
        let msg: Message = MessageMut::parse(&mut src).unwrap().unwrap().into();
        assert!(msg.raw_data().len() == data.len());
        let mut iter = msg.iter();
        assert!(iter.next() == Some(b"get".as_ref()));
        assert!(iter.next() == Some(b"ab\nc".as_ref()));
    }

    #[test]
    fn test_iter_plain() {
        let data = b"+abcdef\r\n";
        let mut src = BytesMut::from(&data[..]);
        let msg: Message = MessageMut::parse(&mut src).unwrap().unwrap().into();
        assert!(msg.raw_data().len() == data.len());
        let mut iter = msg.iter();
        assert!(iter.next() == Some("abcdef".as_bytes()));
        assert!(iter.next() == None);
    }

    #[test]
    fn test_iter_bulk() {
        let data = b"$3\r\nabc\r\n";
        let mut src = BytesMut::from(&data[..]);
        let msg: Message = MessageMut::parse(&mut src).unwrap().unwrap().into();
        assert!(msg.raw_data().len() == data.len());
        let mut iter = msg.iter();
        assert!(iter.next() == Some("abc".as_bytes()));
        assert!(iter.next() == None);
    }

    #[test]
    fn test_parse_cluster_slots() {
        let data = b"*2\r\n$7\r\nCLUSTER\r\n$5\r\nSLOTS\r\n";
        let mut src = BytesMut::from(&data[..]);
        let msg: Message = MessageMut::parse(&mut src).unwrap().unwrap().into();
        assert!(
            msg == Message {
                data: Bytes::from("*2\r\n$7\r\nCLUSTER\r\n$5\r\nSLOTS\r\n"),
                rtype: RespType::Array(
                    Range::new(0, 4),
                    vec![
                        RespType::Bulk(Range::new(4, 8), Range::new(8, 17)),
                        RespType::Bulk(Range::new(17, 21), Range::new(21, 28)),
                    ],
                ),
            }
        );
    }

    #[test]
    fn test_parse_inline() {
        let data = b"GET a\n";
        let mut src = BytesMut::from(&data[..]);
        let msg: Message = MessageMut::parse(&mut src).unwrap().unwrap().into();
        assert!(
            msg == Message {
                data: Bytes::from(&data[..]),
                rtype: RespType::Inline(vec![Range::new(0, 3), Range::new(4, 6),]),
            }
        )
    }

    // ---------------------- test copy from redis/tests/unit/protocol.tcl ------------------------------------------ //

    #[test]
    fn test_handle_empy_query() {
        let data = b"\r\n";
        let mut src = BytesMut::from(data.as_ref());
        let msg = MessageMut::parse(&mut src).unwrap().unwrap();
        assert!(
            msg == MessageMut {
                data: BytesMut::from(data.as_ref()),
                rtype: RespType::Inline(vec![Range::new(0, 2)]),
            }
        );
        assert_eq!(src.len(), 0);
    }

    #[test]
    fn test_negative_multibulk_length() {
        let data = b"*-10\r\n";
        let mut src = BytesMut::from(data.as_ref());
        assert!(MessageMut::parse(&mut src).unwrap_err() == AsError::BadMessage);
    }

    #[test]
    fn test_wrong_mutlti_bulk_payload_header() {
        let data = "*3\r\n$3\r\nSET\r\n$1\r\nx\r\nfooz\r\n";
        let mut src = BytesMut::from(data.as_bytes());
        check!(MessageMut::parse(&mut src).unwrap_err() == AsError::BadMessage);
        check!(src.len() == data.len() - 4);
    }

    #[test]
    fn test_negative_mutiblk_payload_length() {
        let data = "*3\r\n\\$3\r\nSET\r\n\\$1\r\nx\r\nfooz\r\n";
        let mut src = BytesMut::from(data.as_bytes());
        assert!(MessageMut::parse(&mut src).unwrap_err() == AsError::BadMessage);
    }

    #[test]
    fn test_non_number_multibulk_payload_length() {
        let data = "*3\r\n$3\r\nSET\r\n$1\r\nx\r\n$blabla\r\n";
        let mut src = BytesMut::from(data.as_bytes());
        assert!(MessageMut::parse(&mut src).unwrap_err() == AsError::BadMessage);
    }
}