#include <string.h>
#include <stdlib.h>
#include <unistd.h>
+#include <time.h>
#include <ctype.h>
#include <errno.h>
+#include <sys/stat.h>
+#include <sys/time.h>
+#include <assert.h>
-#include "anet.h"
+#include "hiredis.h"
#include "sds.h"
-#include "adlist.h"
#include "zmalloc.h"
#include "linenoise.h"
-
-#define REDIS_CMD_INLINE 1
-#define REDIS_CMD_BULK 2
-#define REDIS_CMD_MULTIBULK 4
+#include "help.h"
+#include "anet.h"
+#include "ae.h"
#define REDIS_NOTUSED(V) ((void) V)
+#define OUTPUT_STANDARD 0
+#define OUTPUT_RAW 1
+#define OUTPUT_CSV 2
+
+static redisContext *context;
static struct config {
char *hostip;
int hostport;
+ char *hostsocket;
long repeat;
+ long interval;
int dbnum;
- int argn_from_stdin;
int interactive;
int shutdown;
int monitor_mode;
int pubsub_mode;
- int raw_output;
+ int latency_mode;
+ int cluster_mode;
+ int cluster_reissue_command;
+ int slave_mode;
+ int pipe_mode;
+ int bigkeys;
+ int stdinarg; /* get last arg from stdin. (-x option) */
char *auth;
- char *historyfile;
+ int output; /* output mode, see OUTPUT_* defines */
+ sds mb_delim;
+ char prompt[128];
+ char *eval;
} config;
-static int cliReadReply(int fd);
static void usage();
+char *redisGitSHA1(void);
+char *redisGitDirty(void);
-/* Connect to the client. If force is not zero the connection is performed
- * even if there is already a connected socket. */
-static int cliConnect(int force) {
- char err[ANET_ERR_LEN];
- static int fd = ANET_ERR;
-
- if (fd == ANET_ERR || force) {
- if (force) close(fd);
- fd = anetTcpConnect(err,config.hostip,config.hostport);
- if (fd == ANET_ERR) {
- fprintf(stderr, "Could not connect to Redis at %s:%d: %s", config.hostip, config.hostport, err);
- return -1;
- }
- anetTcpNoDelay(NULL,fd);
+/*------------------------------------------------------------------------------
+ * Utility functions
+ *--------------------------------------------------------------------------- */
+
+static long long mstime(void) {
+ struct timeval tv;
+ long long mst;
+
+ gettimeofday(&tv, NULL);
+ mst = ((long)tv.tv_sec)*1000;
+ mst += tv.tv_usec/1000;
+ return mst;
+}
+
+static void cliRefreshPrompt(void) {
+ int len;
+
+ if (config.hostsocket != NULL)
+ len = snprintf(config.prompt,sizeof(config.prompt),"redis %s",
+ config.hostsocket);
+ else
+ len = snprintf(config.prompt,sizeof(config.prompt),"redis %s:%d",
+ config.hostip, config.hostport);
+ /* Add [dbnum] if needed */
+ if (config.dbnum != 0)
+ len += snprintf(config.prompt+len,sizeof(config.prompt)-len,"[%d]",
+ config.dbnum);
+ snprintf(config.prompt+len,sizeof(config.prompt)-len,"> ");
+}
+
+/*------------------------------------------------------------------------------
+ * Help functions
+ *--------------------------------------------------------------------------- */
+
+#define CLI_HELP_COMMAND 1
+#define CLI_HELP_GROUP 2
+
+typedef struct {
+ int type;
+ int argc;
+ sds *argv;
+ sds full;
+
+ /* Only used for help on commands */
+ struct commandHelp *org;
+} helpEntry;
+
+static helpEntry *helpEntries;
+static int helpEntriesLen;
+
+static sds cliVersion() {
+ sds version;
+ version = sdscatprintf(sdsempty(), "%s", REDIS_VERSION);
+
+ /* Add git commit and working tree status when available */
+ if (strtoll(redisGitSHA1(),NULL,16)) {
+ version = sdscatprintf(version, " (git:%s", redisGitSHA1());
+ if (strtoll(redisGitDirty(),NULL,10))
+ version = sdscatprintf(version, "-dirty");
+ version = sdscat(version, ")");
}
- return fd;
+ return version;
}
-static sds cliReadLine(int fd) {
- sds line = sdsempty();
+static void cliInitHelp() {
+ int commandslen = sizeof(commandHelp)/sizeof(struct commandHelp);
+ int groupslen = sizeof(commandGroups)/sizeof(char*);
+ int i, len, pos = 0;
+ helpEntry tmp;
- while(1) {
- char c;
- ssize_t ret;
-
- ret = read(fd,&c,1);
- if (ret == -1) {
- sdsfree(line);
- return NULL;
- } else if ((ret == 0) || (c == '\n')) {
- break;
- } else {
- line = sdscatlen(line,&c,1);
- }
+ helpEntriesLen = len = commandslen+groupslen;
+ helpEntries = malloc(sizeof(helpEntry)*len);
+
+ for (i = 0; i < groupslen; i++) {
+ tmp.argc = 1;
+ tmp.argv = malloc(sizeof(sds));
+ tmp.argv[0] = sdscatprintf(sdsempty(),"@%s",commandGroups[i]);
+ tmp.full = tmp.argv[0];
+ tmp.type = CLI_HELP_GROUP;
+ tmp.org = NULL;
+ helpEntries[pos++] = tmp;
+ }
+
+ for (i = 0; i < commandslen; i++) {
+ tmp.argv = sdssplitargs(commandHelp[i].name,&tmp.argc);
+ tmp.full = sdsnew(commandHelp[i].name);
+ tmp.type = CLI_HELP_COMMAND;
+ tmp.org = &commandHelp[i];
+ helpEntries[pos++] = tmp;
}
- return sdstrim(line,"\r\n");
}
-static int cliReadSingleLineReply(int fd, int quiet) {
- sds reply = cliReadLine(fd);
+/* Output command help to stdout. */
+static void cliOutputCommandHelp(struct commandHelp *help, int group) {
+ printf("\r\n \x1b[1m%s\x1b[0m \x1b[90m%s\x1b[0m\r\n", help->name, help->params);
+ printf(" \x1b[33msummary:\x1b[0m %s\r\n", help->summary);
+ printf(" \x1b[33msince:\x1b[0m %s\r\n", help->since);
+ if (group) {
+ printf(" \x1b[33mgroup:\x1b[0m %s\r\n", commandGroups[help->group]);
+ }
+}
- if (reply == NULL) return 1;
- if (!quiet)
- printf("%s\n", reply);
- sdsfree(reply);
- return 0;
+/* Print generic help. */
+static void cliOutputGenericHelp() {
+ sds version = cliVersion();
+ printf(
+ "redis-cli %s\r\n"
+ "Type: \"help @<group>\" to get a list of commands in <group>\r\n"
+ " \"help <command>\" for help on <command>\r\n"
+ " \"help <tab>\" to get a list of possible help topics\r\n"
+ " \"quit\" to exit\r\n",
+ version
+ );
+ sdsfree(version);
}
-static void printStringRepr(char *s, int len) {
- printf("\"");
- while(len--) {
- switch(*s) {
- case '\\':
- case '"':
- printf("\\%c",*s);
- break;
- case '\n': printf("\\n"); break;
- case '\r': printf("\\r"); break;
- case '\t': printf("\\t"); break;
- case '\a': printf("\\a"); break;
- case '\b': printf("\\b"); break;
- default:
- if (isprint(*s))
- printf("%c",*s);
- else
- printf("\\x%02x",(unsigned char)*s);
- break;
+/* Output all command help, filtering by group or command name. */
+static void cliOutputHelp(int argc, char **argv) {
+ int i, j, len;
+ int group = -1;
+ helpEntry *entry;
+ struct commandHelp *help;
+
+ if (argc == 0) {
+ cliOutputGenericHelp();
+ return;
+ } else if (argc > 0 && argv[0][0] == '@') {
+ len = sizeof(commandGroups)/sizeof(char*);
+ for (i = 0; i < len; i++) {
+ if (strcasecmp(argv[0]+1,commandGroups[i]) == 0) {
+ group = i;
+ break;
+ }
}
- s++;
}
- printf("\"\n");
-}
-static int cliReadBulkReply(int fd) {
- sds replylen = cliReadLine(fd);
- char *reply, crlf[2];
- int bulklen;
-
- if (replylen == NULL) return 1;
- bulklen = atoi(replylen);
- if (bulklen == -1) {
- sdsfree(replylen);
- printf("(nil)\n");
- return 0;
- }
- reply = zmalloc(bulklen);
- anetRead(fd,reply,bulklen);
- anetRead(fd,crlf,2);
- if (config.raw_output || !isatty(fileno(stdout))) {
- if (bulklen && fwrite(reply,bulklen,1,stdout) == 0) {
- zfree(reply);
- return 1;
+ assert(argc > 0);
+ for (i = 0; i < helpEntriesLen; i++) {
+ entry = &helpEntries[i];
+ if (entry->type != CLI_HELP_COMMAND) continue;
+
+ help = entry->org;
+ if (group == -1) {
+ /* Compare all arguments */
+ if (argc == entry->argc) {
+ for (j = 0; j < argc; j++) {
+ if (strcasecmp(argv[j],entry->argv[j]) != 0) break;
+ }
+ if (j == argc) {
+ cliOutputCommandHelp(help,1);
+ }
+ }
+ } else {
+ if (group == help->group) {
+ cliOutputCommandHelp(help,0);
+ }
}
+ }
+ printf("\r\n");
+}
+
+static void completionCallback(const char *buf, linenoiseCompletions *lc) {
+ size_t startpos = 0;
+ int mask;
+ int i;
+ size_t matchlen;
+ sds tmp;
+
+ if (strncasecmp(buf,"help ",5) == 0) {
+ startpos = 5;
+ while (isspace(buf[startpos])) startpos++;
+ mask = CLI_HELP_COMMAND | CLI_HELP_GROUP;
} else {
- /* If you are producing output for the standard output we want
- * a more interesting output with quoted characters and so forth */
- printStringRepr(reply,bulklen);
+ mask = CLI_HELP_COMMAND;
+ }
+
+ for (i = 0; i < helpEntriesLen; i++) {
+ if (!(helpEntries[i].type & mask)) continue;
+
+ matchlen = strlen(buf+startpos);
+ if (strncasecmp(buf+startpos,helpEntries[i].full,matchlen) == 0) {
+ tmp = sdsnewlen(buf,startpos);
+ tmp = sdscat(tmp,helpEntries[i].full);
+ linenoiseAddCompletion(lc,tmp);
+ sdsfree(tmp);
+ }
}
- zfree(reply);
- return 0;
}
-static int cliReadMultiBulkReply(int fd) {
- sds replylen = cliReadLine(fd);
- int elements, c = 1;
- int retval = 0;
+/*------------------------------------------------------------------------------
+ * Networking / parsing
+ *--------------------------------------------------------------------------- */
- if (replylen == NULL) return 1;
- elements = atoi(replylen);
- if (elements == -1) {
- sdsfree(replylen);
- printf("(nil)\n");
- return 0;
+/* Send AUTH command to the server */
+static int cliAuth() {
+ redisReply *reply;
+ if (config.auth == NULL) return REDIS_OK;
+
+ reply = redisCommand(context,"AUTH %s",config.auth);
+ if (reply != NULL) {
+ freeReplyObject(reply);
+ return REDIS_OK;
}
- if (elements == 0) {
- printf("(empty list or set)\n");
+ return REDIS_ERR;
+}
+
+/* Send SELECT dbnum to the server */
+static int cliSelect() {
+ redisReply *reply;
+ if (config.dbnum == 0) return REDIS_OK;
+
+ reply = redisCommand(context,"SELECT %d",config.dbnum);
+ if (reply != NULL) {
+ freeReplyObject(reply);
+ return REDIS_OK;
}
- while(elements--) {
- printf("%d. ", c);
- if (cliReadReply(fd)) retval = 1;
- c++;
+ return REDIS_ERR;
+}
+
+/* Connect to the client. If force is not zero the connection is performed
+ * even if there is already a connected socket. */
+static int cliConnect(int force) {
+ if (context == NULL || force) {
+ if (context != NULL)
+ redisFree(context);
+
+ if (config.hostsocket == NULL) {
+ context = redisConnect(config.hostip,config.hostport);
+ } else {
+ context = redisConnectUnix(config.hostsocket);
+ }
+
+ if (context->err) {
+ fprintf(stderr,"Could not connect to Redis at ");
+ if (config.hostsocket == NULL)
+ fprintf(stderr,"%s:%d: %s\n",config.hostip,config.hostport,context->errstr);
+ else
+ fprintf(stderr,"%s: %s\n",config.hostsocket,context->errstr);
+ redisFree(context);
+ context = NULL;
+ return REDIS_ERR;
+ }
+
+ /* Do AUTH and select the right DB. */
+ if (cliAuth() != REDIS_OK)
+ return REDIS_ERR;
+ if (cliSelect() != REDIS_OK)
+ return REDIS_ERR;
}
- return retval;
+ return REDIS_OK;
}
-static int cliReadReply(int fd) {
- char type;
- int nread;
+static void cliPrintContextError() {
+ if (context == NULL) return;
+ fprintf(stderr,"Error: %s\n",context->errstr);
+}
- if ((nread = anetRead(fd,&type,1)) <= 0) {
- if (config.shutdown) return 0;
- if (config.interactive &&
- (nread == 0 || (nread == -1 && errno == ECONNRESET)))
- {
- return ECONNRESET;
+static sds cliFormatReplyTTY(redisReply *r, char *prefix) {
+ sds out = sdsempty();
+ switch (r->type) {
+ case REDIS_REPLY_ERROR:
+ out = sdscatprintf(out,"(error) %s\n", r->str);
+ break;
+ case REDIS_REPLY_STATUS:
+ out = sdscat(out,r->str);
+ out = sdscat(out,"\n");
+ break;
+ case REDIS_REPLY_INTEGER:
+ out = sdscatprintf(out,"(integer) %lld\n",r->integer);
+ break;
+ case REDIS_REPLY_STRING:
+ /* If you are producing output for the standard output we want
+ * a more interesting output with quoted characters and so forth */
+ out = sdscatrepr(out,r->str,r->len);
+ out = sdscat(out,"\n");
+ break;
+ case REDIS_REPLY_NIL:
+ out = sdscat(out,"(nil)\n");
+ break;
+ case REDIS_REPLY_ARRAY:
+ if (r->elements == 0) {
+ out = sdscat(out,"(empty list or set)\n");
} else {
- printf("I/O error while reading from socket: %s",strerror(errno));
- exit(1);
+ unsigned int i, idxlen = 0;
+ char _prefixlen[16];
+ char _prefixfmt[16];
+ sds _prefix;
+ sds tmp;
+
+ /* Calculate chars needed to represent the largest index */
+ i = r->elements;
+ do {
+ idxlen++;
+ i /= 10;
+ } while(i);
+
+ /* Prefix for nested multi bulks should grow with idxlen+2 spaces */
+ memset(_prefixlen,' ',idxlen+2);
+ _prefixlen[idxlen+2] = '\0';
+ _prefix = sdscat(sdsnew(prefix),_prefixlen);
+
+ /* Setup prefix format for every entry */
+ snprintf(_prefixfmt,sizeof(_prefixfmt),"%%s%%%dd) ",idxlen);
+
+ for (i = 0; i < r->elements; i++) {
+ /* Don't use the prefix for the first element, as the parent
+ * caller already prepended the index number. */
+ out = sdscatprintf(out,_prefixfmt,i == 0 ? "" : prefix,i+1);
+
+ /* Format the multi bulk entry */
+ tmp = cliFormatReplyTTY(r->element[i],_prefix);
+ out = sdscatlen(out,tmp,sdslen(tmp));
+ sdsfree(tmp);
+ }
+ sdsfree(_prefix);
+ }
+ break;
+ default:
+ fprintf(stderr,"Unknown reply type: %d\n", r->type);
+ exit(1);
+ }
+ return out;
+}
+
+static sds cliFormatReplyRaw(redisReply *r) {
+ sds out = sdsempty(), tmp;
+ size_t i;
+
+ switch (r->type) {
+ case REDIS_REPLY_NIL:
+ /* Nothing... */
+ break;
+ case REDIS_REPLY_ERROR:
+ out = sdscatlen(out,r->str,r->len);
+ out = sdscatlen(out,"\n",1);
+ break;
+ case REDIS_REPLY_STATUS:
+ case REDIS_REPLY_STRING:
+ out = sdscatlen(out,r->str,r->len);
+ break;
+ case REDIS_REPLY_INTEGER:
+ out = sdscatprintf(out,"%lld",r->integer);
+ break;
+ case REDIS_REPLY_ARRAY:
+ for (i = 0; i < r->elements; i++) {
+ if (i > 0) out = sdscat(out,config.mb_delim);
+ tmp = cliFormatReplyRaw(r->element[i]);
+ out = sdscatlen(out,tmp,sdslen(tmp));
+ sdsfree(tmp);
}
+ break;
+ default:
+ fprintf(stderr,"Unknown reply type: %d\n", r->type);
+ exit(1);
}
- switch(type) {
- case '-':
- printf("(error) ");
- cliReadSingleLineReply(fd,0);
- return 1;
- case '+':
- return cliReadSingleLineReply(fd,0);
- case ':':
- printf("(integer) ");
- return cliReadSingleLineReply(fd,0);
- case '$':
- return cliReadBulkReply(fd);
- case '*':
- return cliReadMultiBulkReply(fd);
+ return out;
+}
+
+static sds cliFormatReplyCSV(redisReply *r) {
+ unsigned int i;
+
+ sds out = sdsempty();
+ switch (r->type) {
+ case REDIS_REPLY_ERROR:
+ out = sdscat(out,"ERROR,");
+ out = sdscatrepr(out,r->str,strlen(r->str));
+ break;
+ case REDIS_REPLY_STATUS:
+ out = sdscatrepr(out,r->str,r->len);
+ break;
+ case REDIS_REPLY_INTEGER:
+ out = sdscatprintf(out,"%lld",r->integer);
+ break;
+ case REDIS_REPLY_STRING:
+ out = sdscatrepr(out,r->str,r->len);
+ break;
+ case REDIS_REPLY_NIL:
+ out = sdscat(out,"NIL\n");
+ break;
+ case REDIS_REPLY_ARRAY:
+ for (i = 0; i < r->elements; i++) {
+ sds tmp = cliFormatReplyCSV(r->element[i]);
+ out = sdscatlen(out,tmp,sdslen(tmp));
+ if (i != r->elements-1) out = sdscat(out,",");
+ sdsfree(tmp);
+ }
+ break;
default:
- printf("protocol error, got '%c' as reply type byte\n", type);
- return 1;
+ fprintf(stderr,"Unknown reply type: %d\n", r->type);
+ exit(1);
}
+ return out;
}
-static int selectDb(int fd) {
- int retval;
- sds cmd;
- char type;
+static int cliReadReply(int output_raw_strings) {
+ void *_reply;
+ redisReply *reply;
+ sds out = NULL;
+ int output = 1;
+
+ if (redisGetReply(context,&_reply) != REDIS_OK) {
+ if (config.shutdown)
+ return REDIS_OK;
+ if (config.interactive) {
+ /* Filter cases where we should reconnect */
+ if (context->err == REDIS_ERR_IO && errno == ECONNRESET)
+ return REDIS_ERR;
+ if (context->err == REDIS_ERR_EOF)
+ return REDIS_ERR;
+ }
+ cliPrintContextError();
+ exit(1);
+ return REDIS_ERR; /* avoid compiler warning */
+ }
- if (config.dbnum == 0)
- return 0;
+ reply = (redisReply*)_reply;
- cmd = sdsempty();
- cmd = sdscatprintf(cmd,"SELECT %d\r\n",config.dbnum);
- anetWrite(fd,cmd,sdslen(cmd));
- anetRead(fd,&type,1);
- if (type <= 0 || type != '+') return 1;
- retval = cliReadSingleLineReply(fd,1);
- if (retval) {
- return retval;
+ /* Check if we need to connect to a different node and reissue the
+ * request. */
+ if (config.cluster_mode && reply->type == REDIS_REPLY_ERROR &&
+ (!strncmp(reply->str,"MOVED",5) || !strcmp(reply->str,"ASK")))
+ {
+ char *p = reply->str, *s;
+ int slot;
+
+ output = 0;
+ /* Comments show the position of the pointer as:
+ *
+ * [S] for pointer 's'
+ * [P] for pointer 'p'
+ */
+ s = strchr(p,' '); /* MOVED[S]3999 127.0.0.1:6381 */
+ p = strchr(s+1,' '); /* MOVED[S]3999[P]127.0.0.1:6381 */
+ *p = '\0';
+ slot = atoi(s+1);
+ s = strchr(p+1,':'); /* MOVED 3999[P]127.0.0.1[S]6381 */
+ *s = '\0';
+ sdsfree(config.hostip);
+ config.hostip = sdsnew(p+1);
+ config.hostport = atoi(s+1);
+ if (config.interactive)
+ printf("-> Redirected to slot [%d] located at %s:%d\n",
+ slot, config.hostip, config.hostport);
+ config.cluster_reissue_command = 1;
+ }
+
+ if (output) {
+ if (output_raw_strings) {
+ out = cliFormatReplyRaw(reply);
+ } else {
+ if (config.output == OUTPUT_RAW) {
+ out = cliFormatReplyRaw(reply);
+ out = sdscat(out,"\n");
+ } else if (config.output == OUTPUT_STANDARD) {
+ out = cliFormatReplyTTY(reply,"");
+ } else if (config.output == OUTPUT_CSV) {
+ out = cliFormatReplyCSV(reply);
+ out = sdscat(out,"\n");
+ }
+ }
+ fwrite(out,sdslen(out),1,stdout);
+ sdsfree(out);
}
- return 0;
+ freeReplyObject(reply);
+ return REDIS_OK;
}
static int cliSendCommand(int argc, char **argv, int repeat) {
char *command = argv[0];
- int fd, j, retval = 0;
- sds cmd;
+ size_t *argvlen;
+ int j, output_raw;
+
+ if (!strcasecmp(command,"help") || !strcasecmp(command,"?")) {
+ cliOutputHelp(--argc, ++argv);
+ return REDIS_OK;
+ }
+
+ if (context == NULL) return REDIS_ERR;
+
+ output_raw = 0;
+ if (!strcasecmp(command,"info") ||
+ (argc == 2 && !strcasecmp(command,"cluster") &&
+ (!strcasecmp(argv[1],"nodes") ||
+ !strcasecmp(argv[1],"info"))) ||
+ (argc == 2 && !strcasecmp(command,"client") &&
+ !strcasecmp(argv[1],"list")))
+
+ {
+ output_raw = 1;
+ }
- config.raw_output = !strcasecmp(command,"info");
if (!strcasecmp(command,"shutdown")) config.shutdown = 1;
if (!strcasecmp(command,"monitor")) config.monitor_mode = 1;
if (!strcasecmp(command,"subscribe") ||
!strcasecmp(command,"psubscribe")) config.pubsub_mode = 1;
- if ((fd = cliConnect(0)) == -1) return 1;
- /* Select db number */
- retval = selectDb(fd);
- if (retval) {
- fprintf(stderr,"Error setting DB num\n");
- return 1;
- }
-
- /* Build the command to send */
- cmd = sdscatprintf(sdsempty(),"*%d\r\n",argc);
- for (j = 0; j < argc; j++) {
- cmd = sdscatprintf(cmd,"$%lu\r\n",
- (unsigned long)sdslen(argv[j]));
- cmd = sdscatlen(cmd,argv[j],sdslen(argv[j]));
- cmd = sdscatlen(cmd,"\r\n",2);
- }
+ /* Setup argument length */
+ argvlen = malloc(argc*sizeof(size_t));
+ for (j = 0; j < argc; j++)
+ argvlen[j] = sdslen(argv[j]);
while(repeat--) {
- anetWrite(fd,cmd,sdslen(cmd));
+ redisAppendCommandArgv(context,argc,(const char**)argv,argvlen);
while (config.monitor_mode) {
- cliReadSingleLineReply(fd,0);
+ if (cliReadReply(output_raw) != REDIS_OK) exit(1);
+ fflush(stdout);
}
if (config.pubsub_mode) {
- printf("Reading messages... (press Ctrl-c to quit)\n");
+ if (config.output != OUTPUT_RAW)
+ printf("Reading messages... (press Ctrl-C to quit)\n");
while (1) {
- cliReadReply(fd);
- printf("\n");
+ if (cliReadReply(output_raw) != REDIS_OK) exit(1);
}
}
- retval = cliReadReply(fd);
- if (retval) {
- return retval;
+ if (cliReadReply(output_raw) != REDIS_OK) {
+ free(argvlen);
+ return REDIS_ERR;
+ } else {
+ /* Store database number when SELECT was successfully executed. */
+ if (!strcasecmp(command,"select") && argc == 2) {
+ config.dbnum = atoi(argv[1]);
+ cliRefreshPrompt();
+ }
}
+ if (config.interval) usleep(config.interval);
+ fflush(stdout); /* Make it grep friendly */
}
- return 0;
+
+ free(argvlen);
+ return REDIS_OK;
}
+/*------------------------------------------------------------------------------
+ * User interface
+ *--------------------------------------------------------------------------- */
+
static int parseOptions(int argc, char **argv) {
int i;
int lastarg = i==argc-1;
if (!strcmp(argv[i],"-h") && !lastarg) {
- char *ip = zmalloc(32);
- if (anetResolve(NULL,argv[i+1],ip) == ANET_ERR) {
- printf("Can't resolve %s\n", argv[i]);
- exit(1);
- }
- config.hostip = ip;
- i++;
+ sdsfree(config.hostip);
+ config.hostip = sdsnew(argv[++i]);
} else if (!strcmp(argv[i],"-h") && lastarg) {
usage();
+ } else if (!strcmp(argv[i],"--help")) {
+ usage();
+ } else if (!strcmp(argv[i],"-x")) {
+ config.stdinarg = 1;
} else if (!strcmp(argv[i],"-p") && !lastarg) {
- config.hostport = atoi(argv[i+1]);
- i++;
+ config.hostport = atoi(argv[++i]);
+ } else if (!strcmp(argv[i],"-s") && !lastarg) {
+ config.hostsocket = argv[++i];
} else if (!strcmp(argv[i],"-r") && !lastarg) {
- config.repeat = strtoll(argv[i+1],NULL,10);
- i++;
+ config.repeat = strtoll(argv[++i],NULL,10);
+ } else if (!strcmp(argv[i],"-i") && !lastarg) {
+ double seconds = atof(argv[++i]);
+ config.interval = seconds*1000000;
} else if (!strcmp(argv[i],"-n") && !lastarg) {
- config.dbnum = atoi(argv[i+1]);
- i++;
+ config.dbnum = atoi(argv[++i]);
} else if (!strcmp(argv[i],"-a") && !lastarg) {
- config.auth = argv[i+1];
- i++;
- } else if (!strcmp(argv[i],"-i")) {
- config.interactive = 1;
+ config.auth = argv[++i];
+ } else if (!strcmp(argv[i],"--raw")) {
+ config.output = OUTPUT_RAW;
+ } else if (!strcmp(argv[i],"--csv")) {
+ config.output = OUTPUT_CSV;
+ } else if (!strcmp(argv[i],"--latency")) {
+ config.latency_mode = 1;
+ } else if (!strcmp(argv[i],"--slave")) {
+ config.slave_mode = 1;
+ } else if (!strcmp(argv[i],"--pipe")) {
+ config.pipe_mode = 1;
+ } else if (!strcmp(argv[i],"--bigkeys")) {
+ config.bigkeys = 1;
+ } else if (!strcmp(argv[i],"--eval") && !lastarg) {
+ config.eval = argv[++i];
} else if (!strcmp(argv[i],"-c")) {
- config.argn_from_stdin = 1;
- } else if (!strcmp(argv[i],"-v")) {
- printf("redis-cli shipped with Redis verison %s\n", REDIS_VERSION);
+ config.cluster_mode = 1;
+ } else if (!strcmp(argv[i],"-d") && !lastarg) {
+ sdsfree(config.mb_delim);
+ config.mb_delim = sdsnew(argv[++i]);
+ } else if (!strcmp(argv[i],"-v") || !strcmp(argv[i], "--version")) {
+ sds version = cliVersion();
+ printf("redis-cli %s\n", version);
+ sdsfree(version);
exit(0);
} else {
break;
}
static void usage() {
- fprintf(stderr, "usage: redis-cli [-iv] [-h host] [-p port] [-a authpw] [-r repeat_times] [-n db_num] cmd arg1 arg2 arg3 ... argN\n");
- fprintf(stderr, "usage: echo \"argN\" | redis-cli -c [-h host] [-p port] [-a authpw] [-r repeat_times] [-n db_num] cmd arg1 arg2 ... arg(N-1)\n");
- fprintf(stderr, "\nIf a pipe from standard input is detected this data is used as last argument.\n\n");
- fprintf(stderr, "example: cat /etc/passwd | redis-cli set my_passwd\n");
- fprintf(stderr, "example: redis-cli get my_passwd\n");
- fprintf(stderr, "example: redis-cli -r 100 lpush mylist x\n");
- fprintf(stderr, "\nRun in interactive mode: redis-cli -i or just don't pass any command\n");
+ sds version = cliVersion();
+ fprintf(stderr,
+"redis-cli %s\n"
+"\n"
+"Usage: redis-cli [OPTIONS] [cmd [arg [arg ...]]]\n"
+" -h <hostname> Server hostname (default: 127.0.0.1)\n"
+" -p <port> Server port (default: 6379)\n"
+" -s <socket> Server socket (overrides hostname and port)\n"
+" -a <password> Password to use when connecting to the server\n"
+" -r <repeat> Execute specified command N times\n"
+" -i <interval> When -r is used, waits <interval> seconds per command.\n"
+" It is possible to specify sub-second times like -i 0.1\n"
+" -n <db> Database number\n"
+" -x Read last argument from STDIN\n"
+" -d <delimiter> Multi-bulk delimiter in for raw formatting (default: \\n)\n"
+" -c Enable cluster mode (follow -ASK and -MOVED redirections)\n"
+" --raw Use raw formatting for replies (default when STDOUT is not a tty)\n"
+" --latency Enter a special mode continuously sampling latency\n"
+" --slave Simulate a slave showing commands received from the master\n"
+" --pipe Transfer raw Redis protocol from stdin to server\n"
+" --bigkeys Sample Redis keys looking for big keys\n"
+" --eval <file> Send an EVAL command using the Lua script at <file>\n"
+" --help Output this help and exit\n"
+" --version Output version and exit\n"
+"\n"
+"Examples:\n"
+" cat /etc/passwd | redis-cli -x set mypasswd\n"
+" redis-cli get mypasswd\n"
+" redis-cli -r 100 lpush mylist x\n"
+" redis-cli -r 100 -i 1 info | grep used_memory_human:\n"
+" redis-cli --eval myscript.lua key1 key2 , arg1 arg2 arg3\n"
+" (Note: when using --eval the comma separates KEYS[] from ARGV[] items)\n"
+"\n"
+"When no command is given, redis-cli starts in interactive mode.\n"
+"Type \"help\" in interactive mode for information on available commands.\n"
+"\n",
+ version);
+ sdsfree(version);
exit(1);
}
#define LINE_BUFLEN 4096
static void repl() {
- int argc, j;
+ sds historyfile = NULL;
+ int history = 0;
char *line;
+ int argc;
sds *argv;
- while((line = linenoise("redis> ")) != NULL) {
+ config.interactive = 1;
+ linenoiseSetCompletionCallback(completionCallback);
+
+ /* Only use history when stdin is a tty. */
+ if (isatty(fileno(stdin))) {
+ history = 1;
+
+ if (getenv("HOME") != NULL) {
+ historyfile = sdscatprintf(sdsempty(),"%s/.rediscli_history",getenv("HOME"));
+ linenoiseHistoryLoad(historyfile);
+ }
+ }
+
+ cliRefreshPrompt();
+ while((line = linenoise(context ? config.prompt : "not connected> ")) != NULL) {
if (line[0] != '\0') {
argv = sdssplitargs(line,&argc);
- linenoiseHistoryAdd(line);
- if (config.historyfile) linenoiseHistorySave(config.historyfile);
- if (argc > 0) {
+ if (history) linenoiseHistoryAdd(line);
+ if (historyfile) linenoiseHistorySave(historyfile);
+
+ if (argv == NULL) {
+ printf("Invalid argument(s)\n");
+ free(line);
+ continue;
+ } else if (argc > 0) {
if (strcasecmp(argv[0],"quit") == 0 ||
strcasecmp(argv[0],"exit") == 0)
{
exit(0);
+ } else if (argc == 3 && !strcasecmp(argv[0],"connect")) {
+ sdsfree(config.hostip);
+ config.hostip = sdsnew(argv[1]);
+ config.hostport = atoi(argv[2]);
+ cliConnect(1);
+ } else if (argc == 1 && !strcasecmp(argv[0],"clear")) {
+ linenoiseClearScreen();
} else {
- int err;
-
- if ((err = cliSendCommand(argc, argv, 1)) != 0) {
- if (err == ECONNRESET) {
- printf("Reconnecting... ");
- fflush(stdout);
- if (cliConnect(1) == -1) exit(1);
- printf("OK\n");
- cliSendCommand(argc,argv,1);
+ long long start_time = mstime(), elapsed;
+ int repeat, skipargs = 0;
+
+ repeat = atoi(argv[0]);
+ if (argc > 1 && repeat) {
+ skipargs = 1;
+ } else {
+ repeat = 1;
+ }
+
+ while (1) {
+ config.cluster_reissue_command = 0;
+ if (cliSendCommand(argc-skipargs,argv+skipargs,repeat)
+ != REDIS_OK)
+ {
+ cliConnect(1);
+
+ /* If we still cannot send the command print error.
+ * We'll try to reconnect the next time. */
+ if (cliSendCommand(argc-skipargs,argv+skipargs,repeat)
+ != REDIS_OK)
+ cliPrintContextError();
+ }
+ /* Issue the command again if we got redirected in cluster mode */
+ if (config.cluster_mode && config.cluster_reissue_command) {
+ cliConnect(1);
+ } else {
+ break;
}
}
+ elapsed = mstime()-start_time;
+ if (elapsed >= 500) {
+ printf("(%.2fs)\n",(double)elapsed/1000);
+ }
}
}
/* Free the argument vector */
- for (j = 0; j < argc; j++)
- sdsfree(argv[j]);
+ while(argc--) sdsfree(argv[argc]);
zfree(argv);
}
/* linenoise() returns malloc-ed lines like readline() */
exit(0);
}
+static int noninteractive(int argc, char **argv) {
+ int retval = 0;
+ if (config.stdinarg) {
+ argv = zrealloc(argv, (argc+1)*sizeof(char*));
+ argv[argc] = readArgFromStdin();
+ retval = cliSendCommand(argc+1, argv, config.repeat);
+ } else {
+ /* stdin is probably a tty, can be tested with S_ISCHR(s.st_mode) */
+ retval = cliSendCommand(argc, argv, config.repeat);
+ }
+ return retval;
+}
+
+static int evalMode(int argc, char **argv) {
+ sds script = sdsempty();
+ FILE *fp;
+ char buf[1024];
+ size_t nread;
+ char **argv2;
+ int j, got_comma = 0, keys = 0;
+
+ /* Load the script from the file, as an sds string. */
+ fp = fopen(config.eval,"r");
+ if (!fp) {
+ fprintf(stderr,
+ "Can't open file '%s': %s\n", config.eval, strerror(errno));
+ exit(1);
+ }
+ while((nread = fread(buf,1,sizeof(buf),fp)) != 0) {
+ script = sdscatlen(script,buf,nread);
+ }
+ fclose(fp);
+
+ /* Create our argument vector */
+ argv2 = zmalloc(sizeof(sds)*(argc+3));
+ argv2[0] = sdsnew("EVAL");
+ argv2[1] = script;
+ for (j = 0; j < argc; j++) {
+ if (!got_comma && argv[j][0] == ',' && argv[j][1] == 0) {
+ got_comma = 1;
+ continue;
+ }
+ argv2[j+3-got_comma] = sdsnew(argv[j]);
+ if (!got_comma) keys++;
+ }
+ argv2[2] = sdscatprintf(sdsempty(),"%d",keys);
+
+ /* Call it */
+ return cliSendCommand(argc+3-got_comma, argv2, config.repeat);
+}
+
+static void latencyMode(void) {
+ redisReply *reply;
+ long long start, latency, min = 0, max = 0, tot = 0, count = 0;
+ double avg;
+
+ if (!context) exit(1);
+ while(1) {
+ start = mstime();
+ reply = redisCommand(context,"PING");
+ if (reply == NULL) {
+ fprintf(stderr,"\nI/O error\n");
+ exit(1);
+ }
+ latency = mstime()-start;
+ freeReplyObject(reply);
+ count++;
+ if (count == 1) {
+ min = max = tot = latency;
+ avg = (double) latency;
+ } else {
+ if (latency < min) min = latency;
+ if (latency > max) max = latency;
+ tot += latency;
+ avg = (double) tot/count;
+ }
+ printf("\x1b[0G\x1b[2Kmin: %lld, max: %lld, avg: %.2f (%lld samples)",
+ min, max, avg, count);
+ fflush(stdout);
+ usleep(10000);
+ }
+}
+
+static void slaveMode(void) {
+ /* To start we need to send the SYNC command and return the payload.
+ * The hiredis client lib does not understand this part of the protocol
+ * and we don't want to mess with its buffers, so everything is performed
+ * using direct low-level I/O. */
+ int fd = context->fd;
+ char buf[1024], *p;
+ ssize_t nread;
+ unsigned long long payload;
+
+ /* Send the SYNC command. */
+ if (write(fd,"SYNC\r\n",6) != 6) {
+ fprintf(stderr,"Error writing to master\n");
+ exit(1);
+ }
+
+ /* Read $<payload>\r\n, making sure to read just up to "\n" */
+ p = buf;
+ while(1) {
+ nread = read(fd,p,1);
+ if (nread <= 0) {
+ fprintf(stderr,"Error reading bulk length while SYNCing\n");
+ exit(1);
+ }
+ if (*p == '\n') break;
+ p++;
+ }
+ *p = '\0';
+ payload = strtoull(buf+1,NULL,10);
+ fprintf(stderr,"SYNC with master, discarding %lld bytes of bulk tranfer...\n",
+ payload);
+
+ /* Discard the payload. */
+ while(payload) {
+ nread = read(fd,buf,(payload > sizeof(buf)) ? sizeof(buf) : payload);
+ if (nread <= 0) {
+ fprintf(stderr,"Error reading RDB payload while SYNCing\n");
+ exit(1);
+ }
+ payload -= nread;
+ }
+ fprintf(stderr,"SYNC done. Logging commands from master.\n");
+
+ /* Now we can use the hiredis to read the incoming protocol. */
+ config.output = OUTPUT_CSV;
+ while (cliReadReply(0) == REDIS_OK);
+}
+
+static void pipeMode(void) {
+ int fd = context->fd;
+ long long errors = 0, replies = 0, obuf_len = 0, obuf_pos = 0;
+ char ibuf[1024*16], obuf[1024*16]; /* Input and output buffers */
+ char aneterr[ANET_ERR_LEN];
+ redisReader *reader = redisReaderCreate();
+ redisReply *reply;
+ int eof = 0; /* True once we consumed all the standard input. */
+ int done = 0;
+ char magic[20]; /* Special reply we recognize. */
+
+ srand(time(NULL));
+
+ /* Use non blocking I/O. */
+ if (anetNonBlock(aneterr,fd) == ANET_ERR) {
+ fprintf(stderr, "Can't set the socket in non blocking mode: %s\n",
+ aneterr);
+ exit(1);
+ }
+
+ /* Transfer raw protocol and read replies from the server at the same
+ * time. */
+ while(!done) {
+ int mask = AE_READABLE;
+
+ if (!eof || obuf_len != 0) mask |= AE_WRITABLE;
+ mask = aeWait(fd,mask,1000);
+
+ /* Handle the readable state: we can read replies from the server. */
+ if (mask & AE_READABLE) {
+ ssize_t nread;
+
+ /* Read from socket and feed the hiredis reader. */
+ do {
+ nread = read(fd,ibuf,sizeof(ibuf));
+ if (nread == -1 && errno != EAGAIN && errno != EINTR) {
+ fprintf(stderr, "Error reading from the server: %s\n",
+ strerror(errno));
+ exit(1);
+ }
+ if (nread > 0) redisReaderFeed(reader,ibuf,nread);
+ } while(nread > 0);
+
+ /* Consume replies. */
+ do {
+ if (redisReaderGetReply(reader,(void**)&reply) == REDIS_ERR) {
+ fprintf(stderr, "Error reading replies from server\n");
+ exit(1);
+ }
+ if (reply) {
+ if (reply->type == REDIS_REPLY_ERROR) {
+ fprintf(stderr,"%s\n", reply->str);
+ errors++;
+ } else if (eof && reply->type == REDIS_REPLY_STRING &&
+ reply->len == 20) {
+ /* Check if this is the reply to our final ECHO
+ * command. If so everything was received
+ * from the server. */
+ if (memcmp(reply->str,magic,20) == 0) {
+ printf("Last reply received from server.\n");
+ done = 1;
+ replies--;
+ }
+ }
+ replies++;
+ freeReplyObject(reply);
+ }
+ } while(reply);
+ }
+
+ /* Handle the writable state: we can send protocol to the server. */
+ if (mask & AE_WRITABLE) {
+ while(1) {
+ /* Transfer current buffer to server. */
+ if (obuf_len != 0) {
+ ssize_t nwritten = write(fd,obuf+obuf_pos,obuf_len);
+
+ if (nwritten == -1) {
+ if (errno != EAGAIN && errno != EINTR) {
+ fprintf(stderr, "Error writing to the server: %s\n",
+ strerror(errno));
+ exit(1);
+ } else {
+ nwritten = 0;
+ }
+ }
+ obuf_len -= nwritten;
+ obuf_pos += nwritten;
+ if (obuf_len != 0) break; /* Can't accept more data. */
+ }
+ /* If buffer is empty, load from stdin. */
+ if (obuf_len == 0 && !eof) {
+ ssize_t nread = read(STDIN_FILENO,obuf,sizeof(obuf));
+
+ if (nread == 0) {
+ char echo[] =
+ "*2\r\n$4\r\nECHO\r\n$20\r\n01234567890123456789\r\n";
+ int j;
+
+ eof = 1;
+ /* Everything transfered, so we queue a special
+ * ECHO command that we can match in the replies
+ * to make sure everything was read from the server. */
+ for (j = 0; j < 20; j++)
+ magic[j] = rand() & 0xff;
+ memcpy(echo+19,magic,20);
+ memcpy(obuf,echo,sizeof(echo)-1);
+ obuf_len = sizeof(echo)-1;
+ obuf_pos = 0;
+ printf("All data transferred. Waiting for the last reply...\n");
+ } else if (nread == -1) {
+ fprintf(stderr, "Error reading from stdin: %s\n",
+ strerror(errno));
+ exit(1);
+ } else {
+ obuf_len = nread;
+ obuf_pos = 0;
+ }
+ }
+ if (obuf_len == 0 && eof) break;
+ }
+ }
+ }
+ redisReaderFree(reader);
+ printf("errors: %lld, replies: %lld\n", errors, replies);
+ if (errors)
+ exit(1);
+ else
+ exit(0);
+}
+
+#define TYPE_STRING 0
+#define TYPE_LIST 1
+#define TYPE_SET 2
+#define TYPE_HASH 3
+#define TYPE_ZSET 4
+
+static void findBigKeys(void) {
+ unsigned long long biggest[5] = {0,0,0,0,0};
+ unsigned long long samples = 0;
+ redisReply *reply1, *reply2, *reply3 = NULL;
+ char *sizecmd, *typename[] = {"string","list","set","hash","zset"};
+ int type;
+
+ printf("\n# Press ctrl+c when you have had enough of it... :)\n");
+ printf("# You can use -i 0.1 to sleep 0.1 sec every 100 sampled keys\n");
+ printf("# in order to reduce server load (usually not needed).\n\n");
+ while(1) {
+ /* Sample with RANDOMKEY */
+ reply1 = redisCommand(context,"RANDOMKEY");
+ if (reply1 == NULL) {
+ fprintf(stderr,"\nI/O error\n");
+ exit(1);
+ } else if (reply1->type == REDIS_REPLY_ERROR) {
+ fprintf(stderr, "RANDOMKEY error: %s\n",
+ reply1->str);
+ exit(1);
+ }
+ /* Get the key type */
+ reply2 = redisCommand(context,"TYPE %s",reply1->str);
+ assert(reply2 && reply2->type == REDIS_REPLY_STATUS);
+ samples++;
+
+ /* Get the key "size" */
+ if (!strcmp(reply2->str,"string")) {
+ sizecmd = "STRLEN";
+ type = TYPE_STRING;
+ } else if (!strcmp(reply2->str,"list")) {
+ sizecmd = "LLEN";
+ type = TYPE_LIST;
+ } else if (!strcmp(reply2->str,"set")) {
+ sizecmd = "SCARD";
+ type = TYPE_SET;
+ } else if (!strcmp(reply2->str,"hash")) {
+ sizecmd = "HLEN";
+ type = TYPE_HASH;
+ } else if (!strcmp(reply2->str,"zset")) {
+ sizecmd = "ZCARD";
+ type = TYPE_ZSET;
+ } else if (!strcmp(reply2->str,"none")) {
+ freeReplyObject(reply1);
+ freeReplyObject(reply2);
+ freeReplyObject(reply3);
+ continue;
+ } else {
+ fprintf(stderr, "Unknown key type '%s' for key '%s'\n",
+ reply2->str, reply1->str);
+ exit(1);
+ }
+
+ reply3 = redisCommand(context,"%s %s", sizecmd, reply1->str);
+ if (reply3 && reply3->type == REDIS_REPLY_INTEGER) {
+ if (biggest[type] < reply3->integer) {
+ printf("[%6s] %s | biggest so far with size %llu\n",
+ typename[type], reply1->str,
+ (unsigned long long) reply3->integer);
+ biggest[type] = reply3->integer;
+ }
+ }
+
+ if ((samples % 1000000) == 0)
+ printf("(%llu keys sampled)\n", samples);
+
+ if ((samples % 100) == 0 && config.interval)
+ usleep(config.interval);
+
+ freeReplyObject(reply1);
+ freeReplyObject(reply2);
+ if (reply3) freeReplyObject(reply3);
+ }
+}
+
int main(int argc, char **argv) {
int firstarg;
- char **argvcopy;
- config.hostip = "127.0.0.1";
+ config.hostip = sdsnew("127.0.0.1");
config.hostport = 6379;
+ config.hostsocket = NULL;
config.repeat = 1;
+ config.interval = 0;
config.dbnum = 0;
- config.argn_from_stdin = 0;
- config.shutdown = 0;
config.interactive = 0;
+ config.shutdown = 0;
config.monitor_mode = 0;
config.pubsub_mode = 0;
- config.raw_output = 0;
+ config.latency_mode = 0;
+ config.cluster_mode = 0;
+ config.slave_mode = 0;
+ config.pipe_mode = 0;
+ config.bigkeys = 0;
+ config.stdinarg = 0;
config.auth = NULL;
- config.historyfile = NULL;
-
- if (getenv("HOME") != NULL) {
- config.historyfile = malloc(256);
- snprintf(config.historyfile,256,"%s/.rediscli_history",getenv("HOME"));
- linenoiseHistoryLoad(config.historyfile);
- }
+ config.eval = NULL;
+ if (!isatty(fileno(stdout)) && (getenv("FAKETTY") == NULL))
+ config.output = OUTPUT_RAW;
+ else
+ config.output = OUTPUT_STANDARD;
+ config.mb_delim = sdsnew("\n");
+ cliInitHelp();
firstarg = parseOptions(argc,argv);
argc -= firstarg;
argv += firstarg;
- if (config.auth != NULL) {
- char *authargv[2];
+ /* Latency mode */
+ if (config.latency_mode) {
+ cliConnect(0);
+ latencyMode();
+ }
+
+ /* Slave mode */
+ if (config.slave_mode) {
+ cliConnect(0);
+ slaveMode();
+ }
- authargv[0] = "AUTH";
- authargv[1] = config.auth;
- cliSendCommand(2, convertToSds(2, authargv), 1);
+ /* Pipe mode */
+ if (config.pipe_mode) {
+ cliConnect(0);
+ pipeMode();
}
- if (argc == 0) config.interactive = 1;
- if (config.interactive) repl();
+ /* Find big keys */
+ if (config.bigkeys) {
+ cliConnect(0);
+ findBigKeys();
+ }
- argvcopy = convertToSds(argc+1, argv);
- if (config.argn_from_stdin) {
- sds lastarg = readArgFromStdin();
- argvcopy[argc] = lastarg;
- argc++;
+ /* Start interactive mode when no command is provided */
+ if (argc == 0 && !config.eval) {
+ /* Note that in repl mode we don't abort on connection error.
+ * A new attempt will be performed for every command send. */
+ cliConnect(0);
+ repl();
+ }
+
+ /* Otherwise, we have some arguments to execute */
+ if (cliConnect(0) != REDIS_OK) exit(1);
+ if (config.eval) {
+ return evalMode(argc,argv);
+ } else {
+ return noninteractive(argc,convertToSds(argc,argv));
}
- return cliSendCommand(argc, argvcopy, config.repeat);
}