-
Notifications
You must be signed in to change notification settings - Fork 456
/
cmd_server.cc
1366 lines (1229 loc) · 47.8 KB
/
cmd_server.cc
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
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*/
#include "command_parser.h"
#include "commander.h"
#include "commands/scan_base.h"
#include "common/io_util.h"
#include "common/rdb_stream.h"
#include "config/config.h"
#include "error_constants.h"
#include "server/redis_connection.h"
#include "server/redis_reply.h"
#include "server/server.h"
#include "stats/disk_stats.h"
#include "storage/rdb.h"
#include "string_util.h"
#include "time_util.h"
namespace redis {
class CommandAuth : public Commander {
public:
Status Execute(Server *srv, Connection *conn, std::string *output) override {
auto &user_password = args_[1];
std::string ns;
AuthResult result = srv->AuthenticateUser(user_password, &ns);
switch (result) {
case AuthResult::NO_REQUIRE_PASS:
return {Status::RedisExecErr, "Client sent AUTH, but no password is set"};
case AuthResult::INVALID_PASSWORD:
return {Status::RedisExecErr, "Invalid password"};
case AuthResult::IS_USER:
conn->BecomeUser();
break;
case AuthResult::IS_ADMIN:
conn->BecomeAdmin();
break;
}
conn->SetNamespace(ns);
*output = redis::SimpleString("OK");
return Status::OK();
}
};
class CommandNamespace : public Commander {
public:
Status Execute(Server *srv, Connection *conn, std::string *output) override {
if (!conn->IsAdmin()) {
return {Status::RedisExecErr, errAdminPermissionRequired};
}
Config *config = srv->GetConfig();
std::string sub_command = util::ToLower(args_[1]);
if (config->repl_namespace_enabled && config->IsSlave() && sub_command != "get") {
return {Status::RedisExecErr, "namespace is read-only for slave"};
}
if (args_.size() == 3 && sub_command == "get") {
if (args_[2] == "*") {
std::vector<std::string> namespaces;
auto tokens = srv->GetNamespace()->List();
for (auto &token : tokens) {
namespaces.emplace_back(token.second); // namespace
namespaces.emplace_back(token.first); // token
}
namespaces.emplace_back(kDefaultNamespace);
namespaces.emplace_back(config->requirepass);
*output = ArrayOfBulkStrings(namespaces);
} else {
auto token = srv->GetNamespace()->Get(args_[2]);
if (token.Is<Status::NotFound>()) {
*output = conn->NilString();
} else {
*output = redis::BulkString(token.GetValue());
}
}
} else if (args_.size() == 4 && sub_command == "set") {
Status s = srv->GetNamespace()->Set(args_[2], args_[3]);
*output = s.IsOK() ? redis::SimpleString("OK") : redis::Error(s);
LOG(WARNING) << "Updated namespace: " << args_[2] << " with token: " << args_[3] << ", addr: " << conn->GetAddr()
<< ", result: " << s.Msg();
} else if (args_.size() == 4 && sub_command == "add") {
Status s = srv->GetNamespace()->Add(args_[2], args_[3]);
*output = s.IsOK() ? redis::SimpleString("OK") : redis::Error(s);
LOG(WARNING) << "New namespace: " << args_[2] << " with token: " << args_[3] << ", addr: " << conn->GetAddr()
<< ", result: " << s.Msg();
} else if (args_.size() == 3 && sub_command == "del") {
Status s = srv->GetNamespace()->Del(args_[2]);
*output = s.IsOK() ? redis::SimpleString("OK") : redis::Error(s);
LOG(WARNING) << "Deleted namespace: " << args_[2] << ", addr: " << conn->GetAddr() << ", result: " << s.Msg();
} else {
return {Status::RedisExecErr, "NAMESPACE subcommand must be one of GET, SET, DEL, ADD"};
}
return Status::OK();
}
};
class CommandKeys : public Commander {
public:
Status Execute(Server *srv, Connection *conn, std::string *output) override {
std::string prefix = args_[1];
std::vector<std::string> keys;
redis::Database redis(srv->storage, conn->GetNamespace());
engine::Context ctx(srv->storage);
rocksdb::Status s;
if (prefix == "*") {
s = redis.Keys(ctx, std::string(), &keys);
} else {
if (prefix[prefix.size() - 1] != '*') {
return {Status::RedisExecErr, "only keys prefix match was supported"};
}
s = redis.Keys(ctx, prefix.substr(0, prefix.size() - 1), &keys);
}
if (!s.ok()) {
return {Status::RedisExecErr, s.ToString()};
}
*output = conn->MultiBulkString(keys);
return Status::OK();
}
};
class CommandFlushDB : public Commander {
public:
Status Execute(Server *srv, Connection *conn, std::string *output) override {
if (srv->GetConfig()->cluster_enabled) {
if (srv->slot_migrator->IsMigrationInProgress()) {
srv->slot_migrator->SetStopMigrationFlag(true);
LOG(INFO) << "Stop migration task for flushdb";
}
}
redis::Database redis(srv->storage, conn->GetNamespace());
engine::Context ctx(srv->storage);
auto s = redis.FlushDB(ctx);
LOG(WARNING) << "DB keys in namespace: " << conn->GetNamespace() << " was flushed, addr: " << conn->GetAddr();
if (s.ok()) {
*output = redis::SimpleString("OK");
return Status::OK();
}
return {Status::RedisExecErr, s.ToString()};
}
};
class CommandFlushAll : public Commander {
public:
Status Execute(Server *srv, Connection *conn, std::string *output) override {
if (!conn->IsAdmin()) {
return {Status::RedisExecErr, errAdminPermissionRequired};
}
if (srv->GetConfig()->cluster_enabled) {
if (srv->slot_migrator->IsMigrationInProgress()) {
srv->slot_migrator->SetStopMigrationFlag(true);
LOG(INFO) << "Stop migration task for flushall";
}
}
redis::Database redis(srv->storage, conn->GetNamespace());
engine::Context ctx(srv->storage);
auto s = redis.FlushAll(ctx);
if (s.ok()) {
LOG(WARNING) << "All DB keys was flushed, addr: " << conn->GetAddr();
*output = redis::SimpleString("OK");
return Status::OK();
}
return {Status::RedisExecErr, s.ToString()};
}
};
class CommandPing : public Commander {
public:
Status Execute([[maybe_unused]] Server *srv, [[maybe_unused]] Connection *conn, std::string *output) override {
if (args_.size() == 1) {
*output = redis::SimpleString("PONG");
} else if (args_.size() == 2) {
*output = redis::BulkString(args_[1]);
} else {
return {Status::NotOK, errWrongNumOfArguments};
}
return Status::OK();
}
};
class CommandSelect : public Commander {
public:
Status Execute([[maybe_unused]] Server *srv, [[maybe_unused]] Connection *conn, std::string *output) override {
*output = redis::SimpleString("OK");
return Status::OK();
}
};
class CommandConfig : public Commander {
public:
Status Execute(Server *srv, Connection *conn, std::string *output) override {
if (!conn->IsAdmin()) {
return {Status::RedisExecErr, errAdminPermissionRequired};
}
Config *config = srv->GetConfig();
std::string sub_command = util::ToLower(args_[1]);
if ((sub_command == "rewrite" && args_.size() != 2) || (sub_command == "get" && args_.size() != 3) ||
(sub_command == "set" && args_.size() != 4)) {
return {Status::RedisExecErr, errWrongNumOfArguments};
}
if (args_.size() == 2 && sub_command == "rewrite") {
Status s = config->Rewrite(srv->GetNamespace()->List());
if (!s.IsOK()) return s;
*output = redis::SimpleString("OK");
LOG(INFO) << "# CONFIG REWRITE executed with success";
} else if (args_.size() == 3 && sub_command == "get") {
std::vector<std::string> values;
config->Get(args_[2], &values);
*output = conn->MapOfBulkStrings(values);
} else if (args_.size() == 4 && sub_command == "set") {
Status s = config->Set(srv, args_[2], args_[3]);
if (!s.IsOK()) {
return {Status::RedisExecErr, "CONFIG SET '" + args_[2] + "' error: " + s.Msg()};
} else {
*output = redis::SimpleString("OK");
}
} else {
return {Status::RedisExecErr, "CONFIG subcommand must be one of GET, SET, REWRITE"};
}
return Status::OK();
}
};
class CommandInfo : public Commander {
public:
Status Execute(Server *srv, Connection *conn, std::string *output) override {
std::string section = "all";
if (args_.size() == 2) {
section = util::ToLower(args_[1]);
} else if (args_.size() > 2) {
return {Status::RedisParseErr, errInvalidSyntax};
}
std::string info;
srv->GetInfo(conn->GetNamespace(), section, &info);
*output = conn->VerbatimString("txt", info);
return Status::OK();
}
};
class CommandDisk : public Commander {
public:
Status Parse(const std::vector<std::string> &args) override {
std::string opname = util::ToLower(args[1]);
if (opname != "usage") return {Status::RedisInvalidCmd, "Unknown operation"};
return Commander::Parse(args);
}
Status Execute(Server *srv, Connection *conn, std::string *output) override {
RedisType type = kRedisNone;
redis::Disk disk_db(srv->storage, conn->GetNamespace());
engine::Context ctx(srv->storage);
auto s = disk_db.Type(ctx, args_[2], &type);
if (!s.ok()) return {Status::RedisExecErr, s.ToString()};
uint64_t result = 0;
s = disk_db.GetKeySize(ctx, args_[2], type, &result);
if (!s.ok()) {
// Redis returns the Nil string when the key does not exist
if (s.IsNotFound()) {
*output = conn->NilString();
return Status::OK();
}
return {Status::RedisExecErr, s.ToString()};
}
*output = redis::Integer(result);
return Status::OK();
}
};
class CommandMemory : public CommandDisk {};
class CommandRole : public Commander {
public:
Status Execute(Server *srv, [[maybe_unused]] Connection *conn, std::string *output) override {
srv->GetRoleInfo(output);
return Status::OK();
}
};
class CommandDBSize : public Commander {
public:
Status Execute(Server *srv, Connection *conn, std::string *output) override {
std::string ns = conn->GetNamespace();
if (args_.size() == 1) {
KeyNumStats stats;
srv->GetLatestKeyNumStats(ns, &stats);
*output = redis::Integer(stats.n_key);
} else if (args_.size() == 2 && util::EqualICase(args_[1], "scan")) {
Status s = srv->AsyncScanDBSize(ns);
if (s.IsOK()) {
*output = redis::SimpleString("OK");
} else {
return s;
}
} else {
return {Status::RedisExecErr, "DBSIZE subcommand only supports scan"};
}
return Status::OK();
}
};
class CommandPerfLog : public Commander {
public:
Status Parse(const std::vector<std::string> &args) override {
subcommand_ = util::ToLower(args[1]);
if (subcommand_ != "reset" && subcommand_ != "get" && subcommand_ != "len") {
return {Status::NotOK, "PERFLOG subcommand must be one of RESET, LEN, GET"};
}
if (subcommand_ == "get" && args.size() >= 3) {
if (args[2] == "*") {
cnt_ = 0;
} else {
cnt_ = GET_OR_RET(ParseInt<int64_t>(args[2], 10));
}
}
return Status::OK();
}
Status Execute(Server *srv, [[maybe_unused]] Connection *conn, std::string *output) override {
auto perf_log = srv->GetPerfLog();
if (subcommand_ == "len") {
*output = redis::Integer(static_cast<int64_t>(perf_log->Size()));
} else if (subcommand_ == "reset") {
perf_log->Reset();
*output = redis::SimpleString("OK");
} else if (subcommand_ == "get") {
*output = perf_log->GetLatestEntries(cnt_);
}
return Status::OK();
}
private:
std::string subcommand_;
int64_t cnt_ = 10;
};
class CommandSlowlog : public Commander {
public:
Status Parse(const std::vector<std::string> &args) override {
subcommand_ = util::ToLower(args[1]);
if (subcommand_ != "reset" && subcommand_ != "get" && subcommand_ != "len") {
return {Status::NotOK, "SLOWLOG subcommand must be one of RESET, LEN, GET"};
}
if (subcommand_ == "get" && args.size() >= 3) {
if (args[2] == "*") {
cnt_ = 0;
} else {
cnt_ = GET_OR_RET(ParseInt<int64_t>(args[2], 10));
}
}
return Status::OK();
}
Status Execute(Server *srv, [[maybe_unused]] Connection *conn, std::string *output) override {
auto slowlog = srv->GetSlowLog();
if (subcommand_ == "reset") {
slowlog->Reset();
*output = redis::SimpleString("OK");
return Status::OK();
} else if (subcommand_ == "len") {
*output = redis::Integer(static_cast<int64_t>(slowlog->Size()));
return Status::OK();
} else if (subcommand_ == "get") {
*output = slowlog->GetLatestEntries(cnt_);
return Status::OK();
}
return {Status::NotOK, "SLOWLOG subcommand must be one of RESET, LEN, GET"};
}
private:
std::string subcommand_;
int64_t cnt_ = 10;
};
class CommandClient : public Commander {
public:
Status Parse(const std::vector<std::string> &args) override {
subcommand_ = util::ToLower(args[1]);
// subcommand: getname id kill list info setname
if ((subcommand_ == "id" || subcommand_ == "getname" || subcommand_ == "list" || subcommand_ == "info") &&
args.size() == 2) {
return Status::OK();
}
if ((subcommand_ == "setname") && args.size() == 3) {
// Check if the charset is ok. We need to do this otherwise
// CLIENT LIST or CLIENT INFO format will break. You should always be able to
// split by space to get the different fields.
for (auto ch : args[2]) {
if (ch < '!' || ch > '~') {
return {Status::RedisInvalidCmd, "Client names cannot contain spaces, newlines or special characters"};
}
}
conn_name_ = args[2];
return Status::OK();
}
if ((subcommand_ == "kill")) {
if (args.size() == 2) {
return {Status::RedisParseErr, errInvalidSyntax};
}
if (args.size() == 3) {
addr_ = args[2];
new_format_ = false;
return Status::OK();
}
size_t i = 2;
new_format_ = true;
while (i < args.size()) {
bool more_args = i < args.size();
if (!strcasecmp(args[i].c_str(), "addr") && more_args) {
addr_ = args[i + 1];
} else if (!strcasecmp(args[i].c_str(), "id") && more_args) {
auto parse_result = ParseInt<uint64_t>(args[i + 1], 10);
if (!parse_result) {
return {Status::RedisParseErr, errValueNotInteger};
}
id_ = *parse_result;
} else if (!strcasecmp(args[i].c_str(), "skipme") && more_args) {
if (!strcasecmp(args[i + 1].c_str(), "yes")) {
skipme_ = true;
} else if (!strcasecmp(args[i + 1].c_str(), "no")) {
skipme_ = false;
} else {
return {Status::RedisParseErr, errInvalidSyntax};
}
} else if (!strcasecmp(args[i].c_str(), "type") && more_args) {
if (!strcasecmp(args[i + 1].c_str(), "normal")) {
kill_type_ |= kTypeNormal;
} else if (!strcasecmp(args[i + 1].c_str(), "pubsub")) {
kill_type_ |= kTypePubsub;
} else if (!strcasecmp(args[i + 1].c_str(), "master")) {
kill_type_ |= kTypeMaster;
} else if (!strcasecmp(args[i + 1].c_str(), "replica") || !strcasecmp(args[i + 1].c_str(), "slave")) {
kill_type_ |= kTypeSlave;
} else {
return {Status::RedisParseErr, errInvalidSyntax};
}
} else {
return {Status::RedisParseErr, errInvalidSyntax};
}
i += 2;
}
return Status::OK();
}
return {Status::RedisInvalidCmd, "Syntax error, try CLIENT LIST|INFO|KILL ip:port|GETNAME|SETNAME"};
}
Status Execute(Server *srv, Connection *conn, std::string *output) override {
if (subcommand_ == "list") {
*output = conn->VerbatimString("txt", srv->GetClientsStr());
return Status::OK();
} else if (subcommand_ == "info") {
*output = conn->VerbatimString("txt", conn->ToString());
return Status::OK();
} else if (subcommand_ == "setname") {
conn->SetName(conn_name_);
*output = redis::SimpleString("OK");
return Status::OK();
} else if (subcommand_ == "getname") {
std::string name = conn->GetName();
*output = name == "" ? conn->NilString() : redis::BulkString(name);
return Status::OK();
} else if (subcommand_ == "id") {
*output = redis::Integer(conn->GetID());
return Status::OK();
} else if (subcommand_ == "kill") {
int64_t killed = 0;
srv->KillClient(&killed, addr_, id_, kill_type_, skipme_, conn);
if (new_format_) {
*output = redis::Integer(killed);
} else {
if (killed == 0)
return {Status::RedisExecErr, "No such client"};
else
*output = redis::SimpleString("OK");
}
return Status::OK();
}
return {Status::RedisInvalidCmd, "Syntax error, try CLIENT LIST|INFO|KILL ip:port|GETNAME|SETNAME"};
}
private:
std::string addr_;
std::string conn_name_;
std::string subcommand_;
bool skipme_ = false;
int64_t kill_type_ = 0;
uint64_t id_ = 0;
bool new_format_ = true;
};
class CommandMonitor : public Commander {
public:
Status Execute([[maybe_unused]] Server *srv, Connection *conn, std::string *output) override {
conn->Owner()->BecomeMonitorConn(conn);
*output = redis::SimpleString("OK");
return Status::OK();
}
};
class CommandShutdown : public Commander {
public:
Status Execute(Server *srv, Connection *conn, [[maybe_unused]] std::string *output) override {
if (!conn->IsAdmin()) {
return {Status::RedisExecErr, errAdminPermissionRequired};
}
if (!srv->IsStopped()) {
LOG(INFO) << "bye bye";
srv->Stop();
}
return Status::OK();
}
};
class CommandQuit : public Commander {
public:
Status Execute([[maybe_unused]] Server *srv, Connection *conn, std::string *output) override {
conn->EnableFlag(redis::Connection::kCloseAfterReply);
*output = redis::SimpleString("OK");
return Status::OK();
}
};
class CommandDebug : public Commander {
public:
Status Parse(const std::vector<std::string> &args) override {
subcommand_ = util::ToLower(args[1]);
if ((subcommand_ == "sleep") && args.size() == 3) {
auto second = ParseFloat(args[2]);
if (!second) {
return {Status::RedisParseErr, "invalid debug sleep time"};
}
microsecond_ = static_cast<uint64_t>(*second * 1000 * 1000);
return Status::OK();
} else if (subcommand_ == "protocol" && args.size() == 3) {
protocol_type_ = util::ToLower(args[2]);
return Status::OK();
} else if (subcommand_ == "dbsize-limit" && args.size() == 3) {
auto val = ParseInt<int32_t>(args[2], {0, 1}, 10);
if (!val) {
return {Status::RedisParseErr, "invalid debug dbsize-limit value"};
}
dbsize_limit_ = static_cast<bool>(val);
return Status::OK();
}
return {Status::RedisInvalidCmd, "Syntax error, DEBUG SLEEP <seconds>|PROTOCOL <type>|DBSIZE-LIMIT <0|1>"};
}
Status Execute(Server *srv, Connection *conn, std::string *output) override {
if (subcommand_ == "sleep") {
usleep(microsecond_);
*output = redis::SimpleString("OK");
} else if (subcommand_ == "protocol") { // protocol type
if (protocol_type_ == "string") {
*output = redis::BulkString("Hello World");
} else if (protocol_type_ == "integer") {
*output = redis::Integer(12345);
} else if (protocol_type_ == "double") {
*output = conn->Double(3.141);
} else if (protocol_type_ == "array") {
*output = redis::MultiLen(3);
for (int i = 0; i < 3; i++) {
*output += redis::Integer(i);
}
} else if (protocol_type_ == "set") {
*output = conn->HeaderOfSet(3);
for (int i = 0; i < 3; i++) {
*output += redis::Integer(i);
}
} else if (protocol_type_ == "map") {
*output = conn->HeaderOfMap(3);
for (int i = 0; i < 3; i++) {
*output += redis::Integer(i);
*output += conn->Bool(i == 1);
}
} else if (protocol_type_ == "bignum") {
*output = conn->BigNumber("1234567999999999999999999999999999999");
} else if (protocol_type_ == "true") {
*output = conn->Bool(true);
} else if (protocol_type_ == "false") {
*output = conn->Bool(false);
} else if (protocol_type_ == "null") {
*output = conn->NilString();
} else if (protocol_type_ == "attrib") {
*output = conn->HeaderOfAttribute(1);
*output += redis::BulkString("key-popularity");
*output += redis::Array({
redis::BulkString("key:123"),
redis::Integer(90),
});
} else if (protocol_type_ == "verbatim") { // verbatim string
*output = conn->VerbatimString("txt", "verbatim string");
} else {
return {Status::RedisErrorNoPrefix,
"Wrong protocol type name. Please use one of the following: "
"string|integer|double|array|set|bignum|true|false|null|attrib|verbatim"};
}
} else if (subcommand_ == "dbsize-limit") {
srv->storage->SetDBSizeLimit(dbsize_limit_);
*output = redis::SimpleString("OK");
} else {
return {Status::RedisInvalidCmd, "Unknown subcommand, should be SLEEP, PROTOCOL or DBSIZE-LIMIT"};
}
return Status::OK();
}
private:
std::string subcommand_;
std::string protocol_type_;
uint64_t microsecond_ = 0;
bool dbsize_limit_ = false;
};
class CommandCommand : public Commander {
public:
Status Execute([[maybe_unused]] Server *srv, Connection *conn, std::string *output) override {
if (args_.size() == 1) {
CommandTable::GetAllCommandsInfo(output);
} else {
std::string sub_command = util::ToLower(args_[1]);
if ((sub_command == "count" && args_.size() != 2) || (sub_command == "getkeys" && args_.size() < 3) ||
(sub_command == "info" && args_.size() < 3)) {
return {Status::RedisExecErr, errWrongNumOfArguments};
}
if (sub_command == "count") {
*output = redis::Integer(CommandTable::Size());
} else if (sub_command == "info") {
CommandTable::GetCommandsInfo(output, std::vector<std::string>(args_.begin() + 2, args_.end()));
} else if (sub_command == "getkeys") {
auto cmd_iter = CommandTable::GetOriginal()->find(util::ToLower(args_[2]));
if (cmd_iter == CommandTable::GetOriginal()->end()) {
return {Status::RedisUnknownCmd, "Invalid command specified"};
}
std::vector<int> keys_indexes;
auto s = CommandTable::GetKeysFromCommand(
cmd_iter->second, std::vector<std::string>(args_.begin() + 2, args_.end()), &keys_indexes);
if (!s.IsOK()) return s;
if (keys_indexes.size() == 0) {
return {Status::RedisExecErr, "Invalid arguments specified for command"};
}
std::vector<std::string> keys;
keys.reserve(keys_indexes.size());
for (const auto &key_index : keys_indexes) {
keys.emplace_back(args_[key_index + 2]);
}
*output = conn->MultiBulkString(keys);
} else {
return {Status::RedisExecErr, "Command subcommand must be one of COUNT, GETKEYS, INFO"};
}
}
return Status::OK();
}
};
class CommandEcho : public Commander {
public:
Status Execute([[maybe_unused]] Server *srv, [[maybe_unused]] Connection *conn, std::string *output) override {
*output = redis::BulkString(args_[1]);
return Status::OK();
}
};
class CommandTime : public Commander {
public:
Status Execute([[maybe_unused]] Server *srv, [[maybe_unused]] Connection *conn, std::string *output) override {
uint64_t now = util::GetTimeStampUS();
uint64_t s = now / 1000 / 1000; // unix time in seconds.
uint64_t us = now - (s * 1000 * 1000); // microseconds.
*output = redis::MultiLen(2);
*output += redis::BulkString(std::to_string(s));
*output += redis::BulkString(std::to_string(us));
return Status::OK();
}
};
/*
* HELLO [<protocol-version> [AUTH [<password>|<username> <password>]] [SETNAME <name>] ]
* Note that the <username> should always be `default` if provided otherwise AUTH fails.
* And it is only meant to be aligning syntax with Redis HELLO.
*/
class CommandHello final : public Commander {
public:
Status Execute(Server *srv, Connection *conn, std::string *output) override {
size_t next_arg = 1;
int protocol = 2; // default protocol version is 2
if (args_.size() >= 2) {
auto parse_result = ParseInt<int>(args_[next_arg], 10);
++next_arg;
if (!parse_result) {
return {Status::NotOK, "Protocol version is not an integer or out of range"};
}
protocol = *parse_result;
// In redis, it will check protocol < 2 or protocol > 3,
// kvrocks only supports REPL2 by now, but for supporting some
// `hello 3`, it will not report error when using 3.
if (protocol < 2 || protocol > 3) {
return {Status::RedisNoProto, "unsupported protocol version"};
}
}
// Handling AUTH and SETNAME
for (; next_arg < args_.size(); ++next_arg) {
size_t more_args = args_.size() - next_arg - 1;
const std::string &opt = args_[next_arg];
if (util::ToLower(opt) == "auth" && more_args != 0) {
if (more_args == 2 || more_args == 4) {
if (args_[next_arg + 1] != "default") {
return {Status::NotOK, "Invalid password"};
}
next_arg++;
}
const auto &user_password = args_[next_arg + 1];
std::string ns;
AuthResult auth_result = srv->AuthenticateUser(user_password, &ns);
switch (auth_result) {
case AuthResult::NO_REQUIRE_PASS:
return {Status::NotOK, "Client sent AUTH, but no password is set"};
case AuthResult::INVALID_PASSWORD:
return {Status::NotOK, "Invalid password"};
case AuthResult::IS_USER:
conn->BecomeUser();
break;
case AuthResult::IS_ADMIN:
conn->BecomeAdmin();
break;
}
conn->SetNamespace(ns);
next_arg += 1;
} else if (util::ToLower(opt) == "setname" && more_args != 0) {
const std::string &name = args_[next_arg + 1];
conn->SetName(name);
next_arg += 1;
} else {
return {Status::RedisExecErr, "Syntax error in HELLO option " + opt};
}
}
std::vector<std::string> output_list;
output_list.push_back(redis::BulkString("server"));
output_list.push_back(redis::BulkString("redis"));
output_list.push_back(redis::BulkString("version"));
// What the client want is the Redis compatible version instead of the Kvrocks version.
output_list.push_back(redis::BulkString(REDIS_VERSION));
output_list.push_back(redis::BulkString("proto"));
if (srv->GetConfig()->resp3_enabled) {
output_list.push_back(redis::Integer(protocol));
conn->SetProtocolVersion(protocol == 3 ? RESP::v3 : RESP::v2);
} else {
output_list.push_back(redis::Integer(2));
}
output_list.push_back(redis::BulkString("mode"));
// Note: sentinel is not supported in kvrocks.
if (srv->GetConfig()->cluster_enabled) {
output_list.push_back(redis::BulkString("cluster"));
} else {
output_list.push_back(redis::BulkString("standalone"));
}
output_list.push_back(redis::BulkString("role"));
output_list.push_back(redis::BulkString(srv->IsSlave() ? "slave" : "master"));
// For Kvrocks, the modules is not supported.
output_list.push_back(redis::BulkString("modules"));
output_list.push_back(conn->NilArray());
*output = conn->HeaderOfMap(output_list.size() / 2);
for (const auto &item : output_list) {
*output += item;
}
return Status::OK();
}
};
class CommandScan : public CommandScanBase {
public:
CommandScan() : CommandScanBase() {}
static std::string GenerateOutput(Server *srv, [[maybe_unused]] const Connection *conn,
const std::vector<std::string> &keys, const std::string &end_cursor) {
std::vector<std::string> list;
if (!end_cursor.empty()) {
list.emplace_back(
redis::BulkString(srv->GenerateCursorFromKeyName(end_cursor, CursorType::kTypeBase, kCursorPrefix)));
} else {
list.emplace_back(redis::BulkString("0"));
}
list.emplace_back(ArrayOfBulkStrings(keys));
return redis::Array(list);
}
Status Execute(Server *srv, Connection *conn, std::string *output) override {
redis::Database redis_db(srv->storage, conn->GetNamespace());
auto key_name = srv->GetKeyNameFromCursor(cursor_, CursorType::kTypeBase);
std::vector<std::string> keys;
std::string end_key;
engine::Context ctx(srv->storage);
auto s = redis_db.Scan(ctx, key_name, limit_, prefix_, &keys, &end_key, type_);
if (!s.ok()) {
return {Status::RedisExecErr, s.ToString()};
}
*output = GenerateOutput(srv, conn, keys, end_key);
return Status::OK();
}
};
class CommandRandomKey : public Commander {
public:
Status Execute(Server *srv, Connection *conn, std::string *output) override {
std::string key;
auto cursor = srv->GetLastRandomKeyCursor();
redis::Database redis(srv->storage, conn->GetNamespace());
engine::Context ctx(srv->storage);
auto s = redis.RandomKey(ctx, cursor, &key);
if (!s.ok()) {
return {Status::RedisExecErr, s.ToString()};
}
srv->SetLastRandomKeyCursor(key);
*output = redis::BulkString(key);
return Status::OK();
}
};
class CommandCompact : public Commander {
public:
Status Execute(Server *srv, Connection *conn, std::string *output) override {
std::string begin_key, end_key;
auto ns = conn->GetNamespace();
if (ns != kDefaultNamespace) {
begin_key = ComposeNamespaceKey(ns, "", false);
end_key = util::StringNext(begin_key);
}
Status s = srv->AsyncCompactDB(begin_key, end_key);
if (!s.IsOK()) return s;
*output = redis::SimpleString("OK");
LOG(INFO) << "Compact was triggered by manual with executed success";
return Status::OK();
}
};
class CommandBGSave : public Commander {
public:
Status Execute(Server *srv, Connection *conn, std::string *output) override {
if (!conn->IsAdmin()) {
return {Status::RedisExecErr, errAdminPermissionRequired};
}
Status s = srv->AsyncBgSaveDB();
if (!s.IsOK()) return s;
*output = redis::SimpleString("OK");
LOG(INFO) << "BGSave was triggered by manual with executed success";
return Status::OK();
}
};
class CommandFlushBackup : public Commander {
public:
Status Execute(Server *srv, Connection *conn, std::string *output) override {
if (!conn->IsAdmin()) {
return {Status::RedisExecErr, errAdminPermissionRequired};
}
Status s = srv->AsyncPurgeOldBackups(0, 0);
if (!s.IsOK()) return s;
*output = redis::SimpleString("OK");
LOG(INFO) << "flushbackup was triggered by manual with executed success";
return Status::OK();
}
};
class CommandSlaveOf : public Commander {
public:
static Status IsTryingToReplicateItself(Server *srv, const std::string &host, uint32_t port) {
auto ip_addresses = util::LookupHostByName(host);
if (!ip_addresses) {
return {Status::NotOK, "Can not resolve hostname: " + host};
}
for (auto &ip : *ip_addresses) {
if (util::MatchListeningIP(srv->GetConfig()->binds, ip) && port == srv->GetConfig()->port) {
return {Status::NotOK, "can't replicate itself"};
}
for (std::pair<std::string, uint32_t> &host_port_pair : srv->GetSlaveHostAndPort()) {
if (host_port_pair.first == ip && host_port_pair.second == port) {
return {Status::NotOK, "can't replicate your own replicas"};
}
}
}
return Status::OK();
}
Status Parse(const std::vector<std::string> &args) override {
host_ = args[1];
const auto &port = args[2];
if (util::ToLower(host_) == "no" && util::ToLower(port) == "one") {
host_.clear();
return Status::OK();
}
auto parse_result = ParseInt<uint32_t>(port, 10);
if (!parse_result) {
return {Status::RedisParseErr, "port should be number"};
}
port_ = *parse_result;
return Commander::Parse(args);
}
Status Execute(Server *srv, Connection *conn, std::string *output) override {
if (srv->GetConfig()->cluster_enabled) {
return {Status::RedisExecErr, "can't change to slave in cluster mode"};
}
if (srv->GetConfig()->rocks_db.write_options.disable_wal) {
return {Status::RedisExecErr, "slaveof doesn't work with disable_wal option"};
}
if (!conn->IsAdmin()) {
return {Status::RedisExecErr, errAdminPermissionRequired};
}
if (host_.empty()) {
auto s = srv->RemoveMaster();
if (!s.IsOK()) {
return s.Prefixed("failed to remove master");
}
*output = redis::SimpleString("OK");
LOG(WARNING) << "MASTER MODE enabled (user request from '" << conn->GetAddr() << "')";
if (srv->GetConfig()->cluster_enabled) {
srv->slot_migrator->SetStopMigrationFlag(false);
LOG(INFO) << "Change server role to master, restart migration task";
}
return Status::OK();
}
auto s = IsTryingToReplicateItself(srv, host_, port_);
if (!s.IsOK()) return s;
s = srv->AddMaster(host_, port_, false);
if (s.IsOK()) {
*output = redis::SimpleString("OK");
LOG(WARNING) << "SLAVE OF " << host_ << ":" << port_ << " enabled (user request from '" << conn->GetAddr()
<< "')";
if (srv->GetConfig()->cluster_enabled) {
srv->slot_migrator->SetStopMigrationFlag(true);
LOG(INFO) << "Change server role to slave, stop migration task";
}
} else {
LOG(ERROR) << "SLAVE OF " << host_ << ":" << port_ << " (user request from '" << conn->GetAddr()