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
use crate::ae::*;
use std::time::SystemTime;
use std::rc::Rc;
use crate::env::{read_query_from_client, send_reply_to_client};
use std::cell::RefCell;
use crate::object::{RobjPtr, Robj};
use crate::protocol;
use crate::server::Server;
use crate::command::{lookup_command, CMD_DENY_OOM};
use crate::util::*;
use crate::zalloc;
use crate::replicate;
use std::fs::File;
use mio::Token;

pub const CLIENT_CLOSE: i32 = 0b0001;
pub const CLIENT_SLAVE: i32 = 0b0010;
pub const CLIENT_MASTER: i32 = 0b0100;
pub const CLIENT_MONITOR: i32 = 0b1000;

pub const CLIENT_CLOSE_ASAP: i32 = 0b1_0000;

#[derive(Copy, Clone, PartialEq)]
pub enum ReplyState {
    None,
    Connect,
    Connected,
    WaitBgSaveStart,
    WaitBgSaveEnd,
    SendBulk,
    Online,
}

#[derive(Copy, Clone, PartialEq)]
pub enum RequestType {
    Unknown,
    MultiBulk,
    Inline,
}

enum ProcessQueryError {
    Protocol(usize),
    NotEnough,
}

pub struct Client {
    pub fd: Fd,
    pub token: Token,
    pub flags: i32,
    pub query_buf: Vec<u8>,
    pub last_interaction: SystemTime,
    pub argv: Vec<RobjPtr>,

    pub authenticate: bool,
    pub reply_state: ReplyState,
    pub reply: Vec<RobjPtr>,
    pub reply_db_file: Option<File>,
    pub reply_db_off: u64,
    pub reply_db_size: u64,
    pub reply_off: usize,

    pub request_type: RequestType,
    pub multi_bulk_len: usize,
    pub bulk_len: Option<usize>,

    pub db_idx: usize,

    pub slave_select_db: usize,
}

impl Client {
    pub fn with_fd_and_el(fd: Fd, el: &mut AeEventLoop) -> Result<Rc<RefCell<Client>>, ()> {
        let client = Rc::new(RefCell::new(
            Self::new_default_client(fd)
        ));
        el.create_file_event(
            Rc::clone(&client.borrow().fd),
            AE_READABLE,
            read_query_from_client,
            ClientData::Client(Rc::clone(&client)),
        )?;

        Ok(client)
    }

    pub fn with_fd(fd: Fd) -> Rc<RefCell<Client>> {
        let client = Rc::new(RefCell::new(
            Self::new_default_client(fd)
        ));
        client
    }

    fn new_default_client(fd: Fd) -> Client {
        let token = Token(fd.as_ptr() as usize);
        Client {
            fd,
            token,
            flags: 0,
            query_buf: vec![],
            last_interaction: SystemTime::now(),
            argv: vec![],
            authenticate: false,
            reply_state: ReplyState::None,
            reply: vec![],
            reply_db_file: None,
            reply_db_off: 0,
            reply_db_size: 0,
            reply_off: 0,

            request_type: RequestType::Unknown,
            multi_bulk_len: 0,
            bulk_len: None,

            db_idx: 0,
            slave_select_db: 0,
        }
    }

    pub fn parse_query_buf(&mut self) -> Result<(), CommandError> {
        assert!(self.argv.is_empty());

        // parse inline
        if self.query_buf[0] != b'*' {
            self.parse_inline_query()?;
            self.query_buf.clear();
            return Ok(());
        }

        let iter = match protocol::decode(&self.query_buf) {
            Err(_) => return Err(CommandError::Malformed),
            Ok(i) => i,
        };

        for obj in iter {
            let obj = match obj {
                Err(_) => return Err(CommandError::Malformed),
                Ok(o) => o,
            };
            self.argv.push(obj);
        }

        self.query_buf.clear();
        Ok(())
    }

    fn parse_inline_query(&mut self) -> Result<(), CommandError> {
        let command = match std::str::from_utf8(&self.query_buf) {
            Ok(s) => s,
            Err(_) => return Err(CommandError::Malformed),
        };
        for k in command.split_ascii_whitespace() {
            self.argv.push(Robj::create_string_object(k));
        }
        Ok(())
    }

    pub fn process_input_buffer(&mut self, server: &mut Server, el: &mut AeEventLoop) {
        while !self.query_buf.is_empty() {
            if let RequestType::Unknown = self.request_type {
                if self.query_buf[0] == b'*' {
                    self.request_type = RequestType::MultiBulk;
                } else {
                    self.request_type = RequestType::Inline;
                }
            }

            let result = match self.request_type {
                RequestType::Inline => {
                    self.process_inline_buffer()
                }
                RequestType::MultiBulk => {
                    self.process_multi_bulk_buffer()
                }
                _ => {
                    unreachable!();
                }
            };

            if let Err(e) = result {
                if let ProcessQueryError::Protocol(_) = e {
                    server.async_free_client(self);
                }
                break;
            }

            if self.argc() == 0 {
                self.reset();
            } else {
                if let Ok(_) = self.process_command(server, el) {
                    self.reset()
                }
            }
        }
    }

    fn process_inline_buffer(&mut self) -> Result<(), ProcessQueryError> {
        let mut pos: usize;
        let new_line = self.query_buf.iter()
            .enumerate()
            .find(|(_, ch)| **ch == b'\n')
            .map(|x| x.0);

        pos = new_line.ok_or(ProcessQueryError::NotEnough)?;
        // TODO: max inline buffer

        if pos > 0 && self.query_buf[pos - 1] == b'\r' {
            pos -= 1;
        }

        let s = std::str::from_utf8(&self.query_buf[0..pos]);

        let s = match s {
            Ok(s) => s,
            Err(_) => {
                self.add_str_reply("-ERR Protocol Error: Unknown char\r\n");
                return Err(ProcessQueryError::Protocol(0));
            }
        };

        for arg in s.split_ascii_whitespace() {
            self.argv.push(
                Robj::create_string_object(arg)
            );
        }

        if self.argv.is_empty() {
            self.add_str_reply("-ERR Protocol error: unbalanced quotes in request\r\n");
            return Err(ProcessQueryError::Protocol(0));
        }

        self.query_buf.drain(0..pos + 2);

        Ok(())
    }

    fn process_multi_bulk_buffer(&mut self) -> Result<(), ProcessQueryError> {
        let mut new_line;
        let mut pos: usize = 0;
        if self.multi_bulk_len == 0 {
            assert_eq!(self.argc(), 0);
            new_line = self.query_buf.iter()
                .enumerate()
                .find(|(_, ch)| **ch == b'\r')
                .map(|x| x.0);

            pos = new_line.ok_or(ProcessQueryError::NotEnough)?;

            // TODO: if pos exceed max inline length, return error

            // buffer should also contain '\n'
            if pos > self.query_buf.len() - 2 {
                return Err(ProcessQueryError::NotEnough);
            }

            assert_eq!(self.query_buf[0], b'*');

            let ll = bytes_to_i64(&self.query_buf[1..pos])
                .map_err(|_| ())
                .and_then(|x| {
                    if x > 1024 * 1024 {
                        Err(())
                    } else {
                        Ok(x)
                    }
                })
                .map_err(|_| {
                    self.add_str_reply("-ERR Protocol Error: invalid bulk length\r\n");
                    ProcessQueryError::Protocol(1)
                })?;

            pos += 2;

            if ll <= 0 {
                self.query_buf.drain(0..pos);
                return Ok(());
            }

            self.multi_bulk_len = ll as usize;

            if !self.argv.is_empty() {
                self.argv.clear();
            }

            self.argv.reserve(self.multi_bulk_len);
        }

        assert!(self.multi_bulk_len > 0);

        while self.multi_bulk_len > 0 {
            if let None = self.bulk_len {
                new_line = self.query_buf.iter()
                    .enumerate()
                    .skip(pos)
                    .find(|(_, ch)| **ch == b'\r')
                    .map(|x| x.0);

                let new_line = match new_line {
                    None => break,
                    Some(n) => n,
                };
                // TODO: if pos exceed max inline length, return error

                if pos > self.query_buf.len() - 2 {
                    break;
                }

                if self.query_buf[pos] != b'$' {
                    self.add_reply_from_string(
                        format!("-ERR Protocol Error: expected '$', got {}\r\n",
                                self.query_buf[pos] as char)
                    );
                    return Err(ProcessQueryError::Protocol(pos));
                }

                let ll = bytes_to_usize(&self.query_buf[pos + 1..new_line])
                    .map_err(|_| ())
                    .and_then(|x| {
                        if x > 512 * 1024 * 1024 {
                            Err(())
                        } else {
                            Ok(x)
                        }
                    })
                    .map_err(|_| {
                        self.add_str_reply("-ERR Protocol Error: invalid bulk length\r\n");
                        ProcessQueryError::Protocol(pos)
                    })?;

                pos = new_line + 2;
                self.bulk_len = Some(ll);
            }

            if self.query_buf.len() - pos < self.bulk_len.unwrap() + 2 {
                break;
            } else {
                let arg = Robj::create_bytes_object(
                    &self.query_buf[pos..pos + self.bulk_len.unwrap()]
                );
                pos += self.bulk_len.unwrap() + 2;
                self.argv.push(arg);
                self.bulk_len = None;
                self.multi_bulk_len -= 1;
            }
        }
        if pos > 0 {
            self.query_buf.drain(0..pos);
        }

        if self.multi_bulk_len == 0 {
            return Ok(());
        }

        Err(ProcessQueryError::NotEnough)
    }

    pub fn process_command(
        &mut self,
        server: &mut Server,
        el: &mut AeEventLoop,
    ) -> Result<(), CommandError> {
        assert!(!self.argv.is_empty());

        if server.max_memory > 0 {
            server.free_memory_if_needed()
        }

        if case_eq(self.argv[0].borrow().string(), "quit".as_bytes()) {
            return Err(CommandError::Quit);
        }

        let cmd = lookup_command(
            self.argv[0].borrow().string(),
        );
        let cmd = match cmd {
            None => {
                self.add_str_reply("-Error unknown command\r\n");
                self.reset();
                return Err(CommandError::Unknown);
            }
            Some(c) => c,
        };

        if (cmd.arity > 0 && cmd.arity as usize != self.argc())
            || (cmd.arity < 0 && (self.argc() < (-cmd.arity) as usize)) {
            self.add_str_reply("-Error wrong number of arguments\r\n");
            self.reset();
            return Err(CommandError::WrongNumber);
        } else if server.max_memory > 0 &&
            cmd.flags & CMD_DENY_OOM != 0 &&
            zalloc::allocated_memory() > server.max_memory {
            self.add_str_reply("-ERR command not allowed when used memory > 'maxmemory'\r\n");
            self.reset();
            return Err(CommandError::OOM);
        }

        // TODO: share objects to save memory

        if server.require_pass.is_some() && !self.authenticate && cmd.name != "auth" {
            self.add_str_reply("-ERR operation not permitted\r\n");
            self.reset();
            return Err(CommandError::NotPermitted);
        }

        // TODO: save server dirty bit and tackle problems with slave server ans monitors
        let dirty = server.dirty;
        (&cmd.proc)(self, server, el);
        if !server.monitors.is_empty() {
            replicate::feed_slaves(el, self, &server.monitors, self.db_idx);
        }
        if !server.slaves.is_empty() && dirty < server.dirty {
            replicate::feed_slaves(el, self, &server.slaves, self.db_idx);
        }

        server.stat_num_commands += 1;

        if self.flags & CLIENT_CLOSE != 0 {
            return Err(CommandError::Close);
        }
        self.reset();
        Ok(())
    }

    pub fn prepare_to_write(&mut self, el: &mut AeEventLoop) -> Result<(), ()> {
        if self.flags & CLIENT_MASTER != 0 {
            return Err(());
        }

        el.async_modify_active_file_event(AE_WRITABLE, send_reply_to_client);

        Ok(())
    }

    pub fn argc(&self) -> usize {
        self.argv.len()
    }

    pub fn reset(&mut self) {
        self.argv.clear();
        self.bulk_len = None;
        self.request_type = RequestType::Unknown;
    }

    pub fn add_reply(&mut self, r: RobjPtr) {
        self.reply.push(r);
    }

    pub fn add_str_reply(&mut self, s: &str) {
        self.add_reply(
            Robj::create_string_object(s),
        );
    }

    pub fn add_reply_from_string(&mut self, s: String) {
        self.add_reply(
            Robj::from_bytes(s.into_bytes())
        )
    }

    pub fn glue_reply(&mut self) {
        let mut glued: Vec<u8> = vec![];
        for obj in self.reply.iter() {
            glued.extend_from_slice(obj.borrow().string())
        }
        self.reply.clear();
        self.reply.push(Robj::from_bytes(glued));
    }

    pub fn is_slave(&self) -> bool {
        self.flags & CLIENT_SLAVE != 0
    }

    pub fn is_monitor(&self) -> bool {
        self.flags & CLIENT_MONITOR != 0
    }

    pub fn is_master(&self) -> bool {
        self.flags & CLIENT_MASTER != 0
    }
}

pub enum ClientData {
    Client(Rc<RefCell<Client>>),
    Nil(),
}

impl ClientData {
    pub fn unwrap_client(&self) -> &Rc<RefCell<Client>> {
        match self {
            Self::Client(c) => c,
            _ => panic!("not a client"),
        }
    }

    pub fn is_client(&self) -> bool {
        match self {
            Self::Client(_) => true,
            _ => false,
        }
    }
}

pub enum CommandError {
    Malformed,
    Quit,
    Close,
    Unknown,
    WrongNumber,
    OOM,
    NotPermitted,
}

impl CommandError {
    pub fn description(&self) -> &'static str {
        match self {
            Self::Malformed => "Client protocol error",
            Self::Quit => "Client quit",
            Self::Close => "Client close",
            Self::Unknown => "Unknown command",
            Self::WrongNumber => "Wrong number of arguments",
            Self::OOM => "Out of memory",
            Self::NotPermitted => "Client's action is not permitted",
        }
    }
}