redis-cli.c

   1 /* Redis CLI (command line interface)
   2  *
   3  * Copyright (c) 2009-2010, Salvatore Sanfilippo <antirez at gmail dot com>
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions are met:
   8  *
   9  *   * Redistributions of source code must retain the above copyright notice,
  10  *     this list of conditions and the following disclaimer.
  11  *   * Redistributions in binary form must reproduce the above copyright
  12  *     notice, this list of conditions and the following disclaimer in the
  13  *     documentation and/or other materials provided with the distribution.
  14  *   * Neither the name of Redis nor the names of its contributors may be used
  15  *     to endorse or promote products derived from this software without
  16  *     specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28  * POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #include "fmacros.h"
  32
  33 #include <stdio.h>
  34 #include <string.h>
  35 #include <stdlib.h>
  36 #include <unistd.h>
  37
  38 #include "anet.h"
  39 #include "sds.h"
  40 #include "adlist.h"
  41 #include "zmalloc.h"
  42
  43 #define REDIS_CMD_INLINE 1
  44 #define REDIS_CMD_BULK 2
  45 #define REDIS_CMD_MULTIBULK 4
  46
  47 #define REDIS_NOTUSED(V) ((void) V)
  48
  49 static struct config {
  50     char *hostip;
  51     int hostport;
  52     long repeat;
  53     int dbnum;
  54 } config;
  55
  56 struct redisCommand {
  57     char *name;
  58     int arity;
  59     int flags;
  60 };
  61
  62 static struct redisCommand cmdTable[] = {
  63     {"get",2,REDIS_CMD_INLINE},
  64     {"set",3,REDIS_CMD_BULK},
  65     {"setnx",3,REDIS_CMD_BULK},
  66     {"append",3,REDIS_CMD_BULK},
  67     {"del",-2,REDIS_CMD_INLINE},
  68     {"exists",2,REDIS_CMD_INLINE},
  69     {"incr",2,REDIS_CMD_INLINE},
  70     {"decr",2,REDIS_CMD_INLINE},
  71     {"rpush",3,REDIS_CMD_BULK},
  72     {"lpush",3,REDIS_CMD_BULK},
  73     {"rpop",2,REDIS_CMD_INLINE},
  74     {"lpop",2,REDIS_CMD_INLINE},
  75     {"brpop",-3,REDIS_CMD_INLINE},
  76     {"blpop",-3,REDIS_CMD_INLINE},
  77     {"llen",2,REDIS_CMD_INLINE},
  78     {"lindex",3,REDIS_CMD_INLINE},
  79     {"lset",4,REDIS_CMD_BULK},
  80     {"lrange",4,REDIS_CMD_INLINE},
  81     {"ltrim",4,REDIS_CMD_INLINE},
  82     {"lrem",4,REDIS_CMD_BULK},
  83     {"rpoplpush",3,REDIS_CMD_BULK},
  84     {"sadd",3,REDIS_CMD_BULK},
  85     {"srem",3,REDIS_CMD_BULK},
  86     {"smove",4,REDIS_CMD_BULK},
  87     {"sismember",3,REDIS_CMD_BULK},
  88     {"scard",2,REDIS_CMD_INLINE},
  89     {"spop",2,REDIS_CMD_INLINE},
  90     {"srandmember",2,REDIS_CMD_INLINE},
  91     {"sinter",-2,REDIS_CMD_INLINE},
  92     {"sinterstore",-3,REDIS_CMD_INLINE},
  93     {"sunion",-2,REDIS_CMD_INLINE},
  94     {"sunionstore",-3,REDIS_CMD_INLINE},
  95     {"sdiff",-2,REDIS_CMD_INLINE},
  96     {"sdiffstore",-3,REDIS_CMD_INLINE},
  97     {"smembers",2,REDIS_CMD_INLINE},
  98     {"zadd",4,REDIS_CMD_BULK},
  99     {"zincrby",4,REDIS_CMD_BULK},
 100     {"zrem",3,REDIS_CMD_BULK},
 101     {"zremrangebyscore",4,REDIS_CMD_INLINE},
 102     {"zrange",-4,REDIS_CMD_INLINE},
 103     {"zrangebyscore",-4,REDIS_CMD_INLINE},
 104     {"zcount",4,REDIS_CMD_INLINE},
 105     {"zrevrange",-4,REDIS_CMD_INLINE},
 106     {"zcard",2,REDIS_CMD_INLINE},
 107     {"zscore",3,REDIS_CMD_BULK},
 108     {"incrby",3,REDIS_CMD_INLINE},
 109     {"decrby",3,REDIS_CMD_INLINE},
 110     {"getset",3,REDIS_CMD_BULK},
 111     {"randomkey",1,REDIS_CMD_INLINE},
 112     {"select",2,REDIS_CMD_INLINE},
 113     {"move",3,REDIS_CMD_INLINE},
 114     {"rename",3,REDIS_CMD_INLINE},
 115     {"renamenx",3,REDIS_CMD_INLINE},
 116     {"keys",2,REDIS_CMD_INLINE},
 117     {"dbsize",1,REDIS_CMD_INLINE},
 118     {"ping",1,REDIS_CMD_INLINE},
 119     {"echo",2,REDIS_CMD_BULK},
 120     {"save",1,REDIS_CMD_INLINE},
 121     {"bgsave",1,REDIS_CMD_INLINE},
 122     {"rewriteaof",1,REDIS_CMD_INLINE},
 123     {"bgrewriteaof",1,REDIS_CMD_INLINE},
 124     {"shutdown",1,REDIS_CMD_INLINE},
 125     {"lastsave",1,REDIS_CMD_INLINE},
 126     {"type",2,REDIS_CMD_INLINE},
 127     {"flushdb",1,REDIS_CMD_INLINE},
 128     {"flushall",1,REDIS_CMD_INLINE},
 129     {"sort",-2,REDIS_CMD_INLINE},
 130     {"info",1,REDIS_CMD_INLINE},
 131     {"mget",-2,REDIS_CMD_INLINE},
 132     {"expire",3,REDIS_CMD_INLINE},
 133     {"expireat",3,REDIS_CMD_INLINE},
 134     {"ttl",2,REDIS_CMD_INLINE},
 135     {"slaveof",3,REDIS_CMD_INLINE},
 136     {"debug",-2,REDIS_CMD_INLINE},
 137     {"mset",-3,REDIS_CMD_MULTIBULK},
 138     {"msetnx",-3,REDIS_CMD_MULTIBULK},
 139     {"monitor",1,REDIS_CMD_INLINE},
 140     {NULL,0,0}
 141 };
 142
 143 static int cliReadReply(int fd);
 144 static void usage();
 145
 146 static struct redisCommand *lookupCommand(char *name) {
 147     int j = 0;
 148     while(cmdTable[j].name != NULL) {
 149         if (!strcasecmp(name,cmdTable[j].name)) return &cmdTable[j];
 150         j++;
 151     }
 152     return NULL;
 153 }
 154
 155 static int cliConnect(void) {
 156     char err[ANET_ERR_LEN];
 157     int fd;
 158
 159     fd = anetTcpConnect(err,config.hostip,config.hostport);
 160     if (fd == ANET_ERR) {
 161         fprintf(stderr,"Connect: %s\n",err);
 162         return -1;
 163     }
 164     anetTcpNoDelay(NULL,fd);
 165     return fd;
 166 }
 167
 168 static sds cliReadLine(int fd) {
 169     sds line = sdsempty();
 170
 171     while(1) {
 172         char c;
 173         ssize_t ret;
 174
 175         ret = read(fd,&c,1);
 176         if (ret == -1) {
 177             sdsfree(line);
 178             return NULL;
 179         } else if ((ret == 0) || (c == '\n')) {
 180             break;
 181         } else {
 182             line = sdscatlen(line,&c,1);
 183         }
 184     }
 185     return sdstrim(line,"\r\n");
 186 }
 187
 188 static int cliReadSingleLineReply(int fd, int quiet) {
 189     sds reply = cliReadLine(fd);
 190
 191     if (reply == NULL) return 1;
 192     if (!quiet)
 193         printf("%s\n", reply);
 194     sdsfree(reply);
 195     return 0;
 196 }
 197
 198 static int cliReadBulkReply(int fd) {
 199     sds replylen = cliReadLine(fd);
 200     char *reply, crlf[2];
 201     int bulklen;
 202
 203     if (replylen == NULL) return 1;
 204     bulklen = atoi(replylen);
 205     if (bulklen == -1) {
 206         sdsfree(replylen);
 207         printf("(nil)\n");
 208         return 0;
 209     }
 210     reply = zmalloc(bulklen);
 211     anetRead(fd,reply,bulklen);
 212     anetRead(fd,crlf,2);
 213     if (bulklen && fwrite(reply,bulklen,1,stdout) == 0) {
 214         zfree(reply);
 215         return 1;
 216     }
 217     if (isatty(fileno(stdout)) && reply[bulklen-1] != '\n')
 218         printf("\n");
 219     zfree(reply);
 220     return 0;
 221 }
 222
 223 static int cliReadMultiBulkReply(int fd) {
 224     sds replylen = cliReadLine(fd);
 225     int elements, c = 1;
 226
 227     if (replylen == NULL) return 1;
 228     elements = atoi(replylen);
 229     if (elements == -1) {
 230         sdsfree(replylen);
 231         printf("(nil)\n");
 232         return 0;
 233     }
 234     if (elements == 0) {
 235         printf("(empty list or set)\n");
 236     }
 237     while(elements--) {
 238         printf("%d. ", c);
 239         if (cliReadReply(fd)) return 1;
 240         c++;
 241     }
 242     return 0;
 243 }
 244
 245 static int cliReadReply(int fd) {
 246     char type;
 247
 248     if (anetRead(fd,&type,1) <= 0) exit(1);
 249     switch(type) {
 250     case '-':
 251         printf("(error) ");
 252         cliReadSingleLineReply(fd,0);
 253         return 1;
 254     case '+':
 255         return cliReadSingleLineReply(fd,0);
 256     case ':':
 257         printf("(integer) ");
 258         return cliReadSingleLineReply(fd,0);
 259     case '$':
 260         return cliReadBulkReply(fd);
 261     case '*':
 262         return cliReadMultiBulkReply(fd);
 263     default:
 264         printf("protocol error, got '%c' as reply type byte\n", type);
 265         return 1;
 266     }
 267 }
 268
 269 static int selectDb(int fd)
 270 {
 271     int retval;
 272     sds cmd;
 273     char type;
 274
 275     if (config.dbnum == 0)
 276         return 0;
 277
 278     cmd = sdsempty();
 279     cmd = sdscatprintf(cmd,"SELECT %d\r\n",config.dbnum);
 280     anetWrite(fd,cmd,sdslen(cmd));
 281     anetRead(fd,&type,1);
 282     if (type <= 0 || type != '+') return 1;
 283     retval = cliReadSingleLineReply(fd,1);
 284     if (retval) {
 285         close(fd);
 286         return retval;
 287     }
 288     return 0;
 289 }
 290
 291 static int cliSendCommand(int argc, char **argv) {
 292     struct redisCommand *rc = lookupCommand(argv[0]);
 293     int fd, j, retval = 0;
 294     int read_forever = 0;
 295     sds cmd;
 296
 297     if (!rc) {
 298         fprintf(stderr,"Unknown command '%s'\n",argv[0]);
 299         return 1;
 300     }
 301
 302     if ((rc->arity > 0 && argc != rc->arity) ||
 303         (rc->arity < 0 && argc < -rc->arity)) {
 304             fprintf(stderr,"Wrong number of arguments for '%s'\n",rc->name);
 305             return 1;
 306     }
 307     if (!strcasecmp(rc->name,"monitor")) read_forever = 1;
 308     if ((fd = cliConnect()) == -1) return 1;
 309
 310     /* Select db number */
 311     retval = selectDb(fd);
 312     if (retval) {
 313         fprintf(stderr,"Error setting DB num\n");
 314         return 1;
 315     }
 316
 317     while(config.repeat--) {
 318         /* Build the command to send */
 319         cmd = sdsempty();
 320         if (rc->flags & REDIS_CMD_MULTIBULK) {
 321             cmd = sdscatprintf(cmd,"*%d\r\n",argc);
 322             for (j = 0; j < argc; j++) {
 323                 cmd = sdscatprintf(cmd,"$%lu\r\n",
 324                     (unsigned long)sdslen(argv[j]));
 325                 cmd = sdscatlen(cmd,argv[j],sdslen(argv[j]));
 326                 cmd = sdscatlen(cmd,"\r\n",2);
 327             }
 328         } else {
 329             for (j = 0; j < argc; j++) {
 330                 if (j != 0) cmd = sdscat(cmd," ");
 331                 if (j == argc-1 && rc->flags & REDIS_CMD_BULK) {
 332                     cmd = sdscatprintf(cmd,"%lu",
 333                         (unsigned long)sdslen(argv[j]));
 334                 } else {
 335                     cmd = sdscatlen(cmd,argv[j],sdslen(argv[j]));
 336                 }
 337             }
 338             cmd = sdscat(cmd,"\r\n");
 339             if (rc->flags & REDIS_CMD_BULK) {
 340                 cmd = sdscatlen(cmd,argv[argc-1],sdslen(argv[argc-1]));
 341                 cmd = sdscatlen(cmd,"\r\n",2);
 342             }
 343         }
 344         anetWrite(fd,cmd,sdslen(cmd));
 345         sdsfree(cmd);
 346
 347         while (read_forever) {
 348             cliReadSingleLineReply(fd,0);
 349         }
 350
 351         retval = cliReadReply(fd);
 352         if (retval) {
 353             close(fd);
 354             return retval;
 355         }
 356     }
 357     close(fd);
 358     return 0;
 359 }
 360
 361 static int parseOptions(int argc, char **argv) {
 362     int i;
 363
 364     for (i = 1; i < argc; i++) {
 365         int lastarg = i==argc-1;
 366
 367         if (!strcmp(argv[i],"-h") && !lastarg) {
 368             char *ip = zmalloc(32);
 369             if (anetResolve(NULL,argv[i+1],ip) == ANET_ERR) {
 370                 printf("Can't resolve %s\n", argv[i]);
 371                 exit(1);
 372             }
 373             config.hostip = ip;
 374             i++;
 375         } else if (!strcmp(argv[i],"-h") && lastarg) {
 376             usage();
 377         } else if (!strcmp(argv[i],"-p") && !lastarg) {
 378             config.hostport = atoi(argv[i+1]);
 379             i++;
 380         } else if (!strcmp(argv[i],"-r") && !lastarg) {
 381             config.repeat = strtoll(argv[i+1],NULL,10);
 382             i++;
 383         } else if (!strcmp(argv[i],"-n") && !lastarg) {
 384             config.dbnum = atoi(argv[i+1]);
 385             i++;
 386         } else {
 387             break;
 388         }
 389     }
 390     return i;
 391 }
 392
 393 static sds readArgFromStdin(void) {
 394     char buf[1024];
 395     sds arg = sdsempty();
 396
 397     while(1) {
 398         int nread = read(fileno(stdin),buf,1024);
 399
 400         if (nread == 0) break;
 401         else if (nread == -1) {
 402             perror("Reading from standard input");
 403             exit(1);
 404         }
 405         arg = sdscatlen(arg,buf,nread);
 406     }
 407     return arg;
 408 }
 409
 410 static void usage() {
 411     fprintf(stderr, "usage: redis-cli [-h host] [-p port] [-r repeat_times] [-n db_num] cmd arg1 arg2 arg3 ... argN\n");
 412     fprintf(stderr, "usage: echo \"argN\" | redis-cli [-h host] [-p port] [-r repeat_times] [-n db_num] cmd arg1 arg2 ... arg(N-1)\n");
 413     fprintf(stderr, "\nIf a pipe from standard input is detected this data is used as last argument.\n\n");
 414     fprintf(stderr, "example: cat /etc/passwd | redis-cli set my_passwd\n");
 415     fprintf(stderr, "example: redis-cli get my_passwd\n");
 416     fprintf(stderr, "example: redis-cli -r 100 lpush mylist x\n");
 417     exit(1);
 418 }
 419
 420 int main(int argc, char **argv) {
 421     int firstarg, j;
 422     char **argvcopy;
 423     struct redisCommand *rc;
 424
 425     config.hostip = "127.0.0.1";
 426     config.hostport = 6379;
 427     config.repeat = 1;
 428     config.dbnum = 0;
 429
 430     firstarg = parseOptions(argc,argv);
 431     argc -= firstarg;
 432     argv += firstarg;
 433
 434     /* Turn the plain C strings into Sds strings */
 435     argvcopy = zmalloc(sizeof(char*)*argc+1);
 436     for(j = 0; j < argc; j++)
 437         argvcopy[j] = sdsnew(argv[j]);
 438
 439     if (argc < 1) usage();
 440
 441     /* Read the last argument from stdandard input if needed */
 442     if ((rc = lookupCommand(argv[0])) != NULL) {
 443         if (rc->arity > 0 && argc == rc->arity-1) {
 444             sds lastarg = readArgFromStdin();
 445             argvcopy[argc] = lastarg;
 446             argc++;
 447         }
 448     }
 449
 450     return cliSendCommand(argc, argvcopy);
 451 }