redis1.2.6 redis-cli.c

/* Redis CLI (command line interface)
 *
 * Copyright (c) 2009-2010, Salvatore Sanfilippo <antirez at gmail dot com>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   * Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *   * Neither the name of Redis nor the names of its contributors may be used
 *     to endorse or promote products derived from this software without
 *     specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#include "fmacros.h"

#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <unistd.h>

#include "anet.h"
#include "sds.h"
#include "adlist.h"
#include "zmalloc.h"
#include "linenoise.h"//C命令行处理工具

#define REDIS_CMD_INLINE 1
#define REDIS_CMD_BULK 2
#define REDIS_CMD_MULTIBULK 4

#define REDIS_NOTUSED(V) ((void) V)
// 配置结构体
static struct config {
    char *hostip;       // ip地址
    int hostport;       // 端口号
    long repeat;        //重复多次次命令
    int dbnum;          // 数据库选择
    int interactive;    
    char *auth;         // 权限
} config;
// 命令
struct redisCommand {
    char *name;         //命令名称
    int arity;          //正数代表此命令长度 负数代表可以小于此长度但不能超过
    int flags;
};

static struct redisCommand cmdTable[] = {
    {"auth",2,REDIS_CMD_INLINE},
    // 字符串
    {"get",2,REDIS_CMD_INLINE},
    {"set",3,REDIS_CMD_BULK},
    {"setnx",3,REDIS_CMD_BULK},
    {"append",3,REDIS_CMD_BULK},
    {"substr",4,REDIS_CMD_INLINE},
    {"del",-2,REDIS_CMD_INLINE},
    {"exists",2,REDIS_CMD_INLINE},
    {"incr",2,REDIS_CMD_INLINE},
    {"decr",2,REDIS_CMD_INLINE},
    // 列表
    {"rpush",3,REDIS_CMD_BULK},
    {"lpush",3,REDIS_CMD_BULK},
    {"rpop",2,REDIS_CMD_INLINE},
    {"lpop",2,REDIS_CMD_INLINE},
    {"brpop",-3,REDIS_CMD_INLINE},
    {"blpop",-3,REDIS_CMD_INLINE},
    {"llen",2,REDIS_CMD_INLINE},
    {"lindex",3,REDIS_CMD_INLINE},
    {"lset",4,REDIS_CMD_BULK},
    {"lrange",4,REDIS_CMD_INLINE},
    {"ltrim",4,REDIS_CMD_INLINE},
    {"lrem",4,REDIS_CMD_BULK},
    {"rpoplpush",3,REDIS_CMD_BULK},
    // 集合
    {"sadd",3,REDIS_CMD_BULK},
    {"srem",3,REDIS_CMD_BULK},
    {"smove",4,REDIS_CMD_BULK},
    {"sismember",3,REDIS_CMD_BULK},
    {"scard",2,REDIS_CMD_INLINE},
    {"spop",2,REDIS_CMD_INLINE},
    {"srandmember",2,REDIS_CMD_INLINE},
    {"sinter",-2,REDIS_CMD_INLINE},
    {"sinterstore",-3,REDIS_CMD_INLINE},
    {"sunion",-2,REDIS_CMD_INLINE},
    {"sunionstore",-3,REDIS_CMD_INLINE},
    {"sdiff",-2,REDIS_CMD_INLINE},
    {"sdiffstore",-3,REDIS_CMD_INLINE},
    {"smembers",2,REDIS_CMD_INLINE},
    // 有序集合
    {"zadd",4,REDIS_CMD_BULK},
    {"zincrby",4,REDIS_CMD_BULK},
    {"zrem",3,REDIS_CMD_BULK},
    {"zremrangebyscore",4,REDIS_CMD_INLINE},
    {"zmerge",-3,REDIS_CMD_INLINE},
    {"zmergeweighed",-4,REDIS_CMD_INLINE},
    {"zrange",-4,REDIS_CMD_INLINE},
    {"zrank",3,REDIS_CMD_BULK},
    {"zrevrank",3,REDIS_CMD_BULK},
    {"zrangebyscore",-4,REDIS_CMD_INLINE},
    {"zcount",4,REDIS_CMD_INLINE},
    {"zrevrange",-4,REDIS_CMD_INLINE},
    {"zcard",2,REDIS_CMD_INLINE},
    {"zscore",3,REDIS_CMD_BULK},

    {"incrby",3,REDIS_CMD_INLINE},
    {"decrby",3,REDIS_CMD_INLINE},
    {"getset",3,REDIS_CMD_BULK},
    {"randomkey",1,REDIS_CMD_INLINE},
    {"select",2,REDIS_CMD_INLINE},
    {"move",3,REDIS_CMD_INLINE},
    {"rename",3,REDIS_CMD_INLINE},
    {"renamenx",3,REDIS_CMD_INLINE},
    {"keys",2,REDIS_CMD_INLINE},
    {"dbsize",1,REDIS_CMD_INLINE},
    {"ping",1,REDIS_CMD_INLINE},
    {"echo",2,REDIS_CMD_BULK},
    {"save",1,REDIS_CMD_INLINE},
    {"bgsave",1,REDIS_CMD_INLINE},
    {"rewriteaof",1,REDIS_CMD_INLINE},
    {"bgrewriteaof",1,REDIS_CMD_INLINE},
    {"shutdown",1,REDIS_CMD_INLINE},
    {"lastsave",1,REDIS_CMD_INLINE},
    {"type",2,REDIS_CMD_INLINE},
    {"flushdb",1,REDIS_CMD_INLINE},
    {"flushall",1,REDIS_CMD_INLINE},
    {"sort",-2,REDIS_CMD_INLINE},
    {"info",1,REDIS_CMD_INLINE},
    {"mget",-2,REDIS_CMD_INLINE},
    {"expire",3,REDIS_CMD_INLINE},
    {"expireat",3,REDIS_CMD_INLINE},
    {"ttl",2,REDIS_CMD_INLINE},
    {"slaveof",3,REDIS_CMD_INLINE},
    {"debug",-2,REDIS_CMD_INLINE},
    {"mset",-3,REDIS_CMD_MULTIBULK},
    {"msetnx",-3,REDIS_CMD_MULTIBULK},
    {"monitor",1,REDIS_CMD_INLINE},
    {"multi",1,REDIS_CMD_INLINE},
    {"exec",1,REDIS_CMD_INLINE},
    {"discard",1,REDIS_CMD_INLINE},
    // 哈希
    {"hset",4,REDIS_CMD_MULTIBULK},
    {"hget",3,REDIS_CMD_BULK},
    {"hdel",3,REDIS_CMD_BULK},
    {"hlen",2,REDIS_CMD_INLINE},
    {"hkeys",2,REDIS_CMD_INLINE},
    {"hvals",2,REDIS_CMD_INLINE},
    {"hgetall",2,REDIS_CMD_INLINE},
    {"hexists",3,REDIS_CMD_BULK},
    {"config",-2,REDIS_CMD_BULK},
    {NULL,0,0}
};

static int cliReadReply(int fd);
static void usage();
//c从命令表cmdTable中找到响应的命令
static struct redisCommand *lookupCommand(char *name) {
    int j = 0;
    while(cmdTable[j].name != NULL) {
        if (!strcasecmp(name,cmdTable[j].name)) return &cmdTable[j];
        j++;
    }
    return NULL;
}
//与服务器连接
static int cliConnect(void) {
    char err[ANET_ERR_LEN];
    static int fd = ANET_ERR;

    if (fd == ANET_ERR) {
        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);//设置一些socket关联的选项
    }
    return fd;
}
//读取内容 直到出现0或者\n 返回读取到的内容
static sds cliReadLine(int fd) {
    sds line = sdsempty();

    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')) {//0或者换行符的时候直接break
            break;
        } else {
            line = sdscatlen(line,&c,1);//将字符c追加到line中
        }
    }
    return sdstrim(line,"\r\n");
}
/*cliReadSingleLineReply 读取回复
* @param int fd             socket描述符
* @param int quiet          如果为1 也就是为真 打印读取的信息 如果为0 为假 不执行打印操作
* @return int               1代表没有返回的信息，0代表有返回的信息
*/
static int cliReadSingleLineReply(int fd, int quiet) {
    sds reply = cliReadLine(fd);

    if (reply == NULL) return 1;
    if (!quiet)//打印返回的信息
        printf("%s\n", reply);
    sdsfree(reply);
    return 0;
}
/*cliReadBulkReply 先读取长度，再根据长度读取回复
* @param int fd             socket描述符
*/
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) {//转换为-1是空....
        sdsfree(replylen);
        printf("(nil)\n");
        return 0;
    }
    reply = zmalloc(bulklen);
    anetRead(fd,reply,bulklen);
    anetRead(fd,crlf,2);
    if (bulklen && fwrite(reply,bulklen,1,stdout) == 0) {//输入到标准输出流
        zfree(reply);
        return 1;
    }
    //isatty判断文件描述词是否是为终端机
    if (isatty(fileno(stdout)) && reply[bulklen-1] != '\n')
        printf("\n");
    zfree(reply);
    return 0;
}
//先读取有几项 向列表有许多元素 然后在读取内容
static int cliReadMultiBulkReply(int fd) {
    sds replylen = cliReadLine(fd);//总共几个元素
    int elements, c = 1;

    if (replylen == NULL) return 1;
    elements = atoi(replylen);
    if (elements == -1) {
        sdsfree(replylen);
        printf("(nil)\n");
        return 0;
    }
    if (elements == 0) {
        printf("(empty list or set)\n");
    }
    while(elements--) {
        printf("%d. ", c);
        if (cliReadReply(fd)) return 1;
        c++;
    }
    return 0;
}
//接收回复  先接收类型 再根据类型调用相应的函数
static int cliReadReply(int fd) {
    char type;

    if (anetRead(fd,&type,1) <= 0) 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);
    default:
        printf("protocol error, got '%c' as reply type byte\n", type);
        return 1;
    }
}
/*selectDb 设置数据库
* @param int fd         socket描述符
* @return int           0应该是成功 1可能有些问题
*/
static int selectDb(int fd) {
    int retval;
    sds cmd;
    char type;

    if (config.dbnum == 0)
        return 0;

    cmd = sdsempty();//一个空的sds
    cmd = sdscatprintf(cmd,"SELECT %d\r\n",config.dbnum);//格式化打印到cmd中
    anetWrite(fd,cmd,sdslen(cmd));//发送命令
    anetRead(fd,&type,1);//读取1个字节
    if (type <= 0 || type != '+') return 1;//我在更改config.dbnum = 1时 type返回的时+
    retval = cliReadSingleLineReply(fd,1);
    if (retval) {
        return retval;
    }
    return 0;
}
/*cliSendCommand 客户端发送命令
* @param int argc           参数个数
* @param char **argv        sds字符串数组
* @param int repeat         重复次数
* @return int               失败为1 成功为0
*/
static int cliSendCommand(int argc, char **argv, int repeat) {
    struct redisCommand *rc = lookupCommand(argv[0]);//寻找命令
    int fd, j, retval = 0;
    int read_forever = 0;
    sds cmd;

    if (!rc) {//不存在命令 错误信息
        fprintf(stderr,"Unknown command '%s'\n",argv[0]);
        return 1;
    }

    if ((rc->arity > 0 && argc != rc->arity) ||
        (rc->arity < 0 && argc < -rc->arity)) {//验证命令长度是否合法
            fprintf(stderr,"Wrong number of arguments for '%s'\n",rc->name);
            return 1;
    }
    if (!strcasecmp(rc->name,"monitor")) read_forever = 1;//监视命令，只读
    if ((fd = cliConnect()) == -1) return 1;

    /* Select db number */
    retval = selectDb(fd);
    if (retval) {
        fprintf(stderr,"Error setting DB num\n");
        return 1;
    }

    while(repeat--) {//一般都是1 意思为循环一次 执行一次命令
        /* Build the command to send */
        cmd = sdsempty();
        if (rc->flags & REDIS_CMD_MULTIBULK) {
            //命令；mset name wwz age 21
            cmd = sdscatprintf(cmd,"*%d\r\n",argc);//*5\r\n
            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);
            }
            //*5\r\n$4mset\r\n$4name\r\n$3wwz\r\n$3age$221\r\n
        } else {
            for (j = 0; j < argc; j++) {
                if (j != 0) cmd = sdscat(cmd," ");
                if (j == argc-1 && rc->flags & REDIS_CMD_BULK) {
                    cmd = sdscatprintf(cmd,"%lu",
                        (unsigned long)sdslen(argv[j]));
                } else {
                    cmd = sdscatlen(cmd,argv[j],sdslen(argv[j]));
                }
            }
            cmd = sdscat(cmd,"\r\n");
            if (rc->flags & REDIS_CMD_BULK) {
                cmd = sdscatlen(cmd,argv[argc-1],sdslen(argv[argc-1]));
                cmd = sdscatlen(cmd,"\r\n",2);
            }
        }
        //发送--------》》》》》
        anetWrite(fd,cmd,sdslen(cmd));
        sdsfree(cmd);

        while (read_forever) {//监视吧
            cliReadSingleLineReply(fd,0);
        }
//读取，判断类型再进行进一步读取，注意cliReadMultiBulkReply[多元的]的每一个元素都调用了cliReadBulkReply（就是类型为$的）
        retval = cliReadReply(fd);
        if (retval) {
            return retval;
        }
    }
    return 0;
}
/* parseOptions函数 解析命令行的参数，以及其各种参数对应的操作，修改config值
 * @param int       argc 命令行参数个数
 * @param char**    argv 命令行具体参数内容
 * @return int      正常来说返回的int类型的值为argc 参数个数  
*/
static int parseOptions(int argc, char **argv) {
    int i;
    //为什么从1开始？因为参数的内容 第一个元素是命令行的路径
    for (i = 1; i < argc; i++) {
        int lastarg = i==argc-1;//是否是最后一个参数

        if (!strcmp(argv[i],"-h") && !lastarg) {//这里主要处理的是IP地址
            char *ip = zmalloc(32);
            if (anetResolve(NULL,argv[i+1],ip) == ANET_ERR) {//IP不合法
                printf("Can't resolve %s\n", argv[i]);
                exit(1);
            }
            config.hostip = ip;//重新设置IP
            i++;
        } else if (!strcmp(argv[i],"-h") && lastarg) {// 打印帮助信息
            usage();
        } else if (!strcmp(argv[i],"-p") && !lastarg) {// 端口号
            config.hostport = atoi(argv[i+1]);
            i++;
        } else if (!strcmp(argv[i],"-r") && !lastarg) {// 重复执行多少次
            //-r(repeat）选项代表将命令执行多次，例如下面操作将会执行三次ping命令：
            //redis-cli -r 3 ping  
            //PONG  
            //PONG  
            //PONG 
            config.repeat = strtoll(argv[i+1],NULL,10);
            i++;
        } else if (!strcmp(argv[i],"-n") && !lastarg) {// 选择数据库
            config.dbnum = atoi(argv[i+1]);
            i++;
        } else if (!strcmp(argv[i],"-a") && !lastarg) {// 权限密码
            //$redis-cli -h 127.0.0.1 -p 6379 -a "mypass" 
            //连接到主机为 127.0.0.1，端口为 6379 ，密码为 mypass 的 redis 服务上。
            config.auth = argv[i+1];
            i++;
        } else if (!strcmp(argv[i],"-i")) {
            
            config.interactive = 1;
        } else {
            break;
        }
    }
    return i;
}
// 从标准输入流读取字节 返回sds类型的字符串
static sds readArgFromStdin(void) {
    char buf[1024];
    sds arg = sdsempty();

    while(1) {
        int nread = read(fileno(stdin),buf,1024);

        if (nread == 0) break;
        else if (nread == -1) {
            perror("Reading from standard input");
            exit(1);
        }
        arg = sdscatlen(arg,buf,nread);
    }
    return arg;
}
/*帮助信息*/
static void usage() {
    fprintf(stderr, "usage: redis-cli [-h host] [-p port] [-a authpw] [-r repeat_times] [-n db_num] [-i] cmd arg1 arg2 arg3 ... argN\n");
    fprintf(stderr, "usage: echo \"argN\" | redis-cli [-h host] [-a authpw] [-p port] [-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");
    exit(1);
}

/* Turn the plain C strings into Sds strings */
static char **convertToSds(int count, char** args) {
  //set name wwz 命令  创建3个sds，在同一数组下 例如sds[0]就是set sds[1]就是name
  int j;
  char **sds = zmalloc(sizeof(char*)*count+1);

  for(j = 0; j < count; j++)
    sds[j] = sdsnew(args[j]);

  return sds;
}
//当interactive == 1时的交互操作
static void repl() {
    int size = 4096, max = size >> 1, argc;
    char *line;
    char **ap, *args[max];

    while((line = linenoise("redis> ")) != NULL) {
        if (line[0] != '\0') {
          linenoiseHistoryAdd(line);//添加至历史
          argc = 0;

          for (ap = args; (*ap = strsep(&line, " \t")) != NULL;) {
              if (**ap != '\0') {
                  if (argc >= max) break;
                  if (strcasecmp(*ap,"quit") == 0 || strcasecmp(*ap,"exit") == 0)//断开处理
                      exit(0);
                  //为args中存入命令
                  ap++;
                  argc++;
              }
          }

          cliSendCommand(argc, convertToSds(argc, args), 1);
        }

        free(line);
    }

    exit(0);
}

int main(int argc, char **argv) {
    int firstarg;
    char **argvcopy;
    struct redisCommand *rc;
    //设置基本配置
    config.hostip = "127.0.0.1";
    config.hostport = 6379;
    config.repeat = 1;
    config.dbnum = 0;
    config.interactive = 0;
    config.auth = NULL;

    firstarg = parseOptions(argc,argv);//格式化命令行参数，返回参数为执行参数的个数
    argc -= firstarg;//还有几个参数未执行
    argv += firstarg;//将argv修改到 参数已经处理完毕的位置

    if (config.auth != NULL) {//有权限
        char *authargv[2];

        authargv[0] = "AUTH";
        authargv[1] = config.auth;
        cliSendCommand(2, convertToSds(2, authargv), 1);
    }

    if (argc == 0 || config.interactive == 1) repl();
    //将后面的未执行的命令拷贝到argvcopy
    //例如./redis-cli set name wwz argvcopy[0] = set argvcopy[1] = name...
    argvcopy = convertToSds(argc, argv);

    /* Read the last argument from stdandard input if needed */
    if ((rc = lookupCommand(argv[0])) != NULL) {
      if (rc->arity > 0 && argc == rc->arity-1) {//这个时arity是正数且合法长度的
        sds lastarg = readArgFromStdin();
        argvcopy[argc] = lastarg;//再来一个结束符
        argc++;
      }
    }

    return cliSendCommand(argc, argvcopy, config.repeat);
}

// atoi函数 字符串转换成整型数 stdlib.h库

// anetResolve函数 anet.c文件



/**
 * list 接收过程
 * 使用lrange命令 接收是先cliReadReply判断返回类型为*
 * 之后采取cliReadMultiBulkReply函数，因是列表，则有许多元素，
 * 所以再每一次遍历元素时，则使用cliReadBulkReply函数进行读取每一个元素
 */