cluster.c 96.7 KB
Newer Older
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
/* Redis Cluster implementation.
 *
 * Copyright (c) 2009-2012, 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.
 */

A
antirez 已提交
31
#include "redis.h"
32
#include "endianconv.h"
A
antirez 已提交
33 34

#include <arpa/inet.h>
A
antirez 已提交
35 36
#include <fcntl.h>
#include <unistd.h>
A
antirez 已提交
37
#include <sys/socket.h>
A
antirez 已提交
38 39 40 41 42

void clusterAcceptHandler(aeEventLoop *el, int fd, void *privdata, int mask);
void clusterReadHandler(aeEventLoop *el, int fd, void *privdata, int mask);
void clusterSendPing(clusterLink *link, int type);
void clusterSendFail(char *nodename);
43
void clusterSendFailoverAuthIfNeeded(clusterNode *sender);
A
antirez 已提交
44 45
void clusterUpdateState(void);
int clusterNodeGetSlotBit(clusterNode *n, int slot);
A
antirez 已提交
46
sds clusterGenNodesDescription(void);
47 48
clusterNode *clusterLookupNode(char *name);
int clusterNodeAddSlave(clusterNode *master, clusterNode *slave);
49
int clusterAddSlot(clusterNode *n, int slot);
50
int clusterDelSlot(int slot);
51
int clusterNodeSetSlotBit(clusterNode *n, int slot);
52
int bitmapTestBit(unsigned char *bitmap, int pos);
A
antirez 已提交
53 54 55 56 57 58 59

/* -----------------------------------------------------------------------------
 * Initialization
 * -------------------------------------------------------------------------- */

int clusterLoadConfig(char *filename) {
    FILE *fp = fopen(filename,"r");
A
antirez 已提交
60
    char *line;
61
    int maxline, j;
A
antirez 已提交
62
   
A
antirez 已提交
63
    if (fp == NULL) return REDIS_ERR;
A
antirez 已提交
64 65 66

    /* Parse the file. Note that single liens of the cluster config file can
     * be really long as they include all the hash slots of the node.
67 68 69 70 71 72
     * This means in the worst possible case, half of the Redis slots will be
     * present in a single line, possibly in importing or migrating state, so
     * together with the node ID of the sender/receiver.
     *
     * To simplify we allocate 1024+REDIS_CLUSTER_SLOTS*128 bytes per line. */
    maxline = 1024+REDIS_CLUSTER_SLOTS*128;
A
antirez 已提交
73 74 75 76
    line = zmalloc(maxline);
    while(fgets(line,maxline,fp) != NULL) {
        int argc;
        sds *argv = sdssplitargs(line,&argc);
C
charsyam 已提交
77 78
        if (argv == NULL) goto fmterr;

79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
        clusterNode *n, *master;
        char *p, *s;

        /* Create this node if it does not exist */
        n = clusterLookupNode(argv[0]);
        if (!n) {
            n = createClusterNode(argv[0],0);
            clusterAddNode(n);
        }
        /* Address and port */
        if ((p = strchr(argv[1],':')) == NULL) goto fmterr;
        *p = '\0';
        memcpy(n->ip,argv[1],strlen(argv[1])+1);
        n->port = atoi(p+1);

        /* Parse flags */
        p = s = argv[2];
        while(p) {
            p = strchr(s,',');
            if (p) *p = '\0';
            if (!strcasecmp(s,"myself")) {
100 101
                redisAssert(server.cluster->myself == NULL);
                server.cluster->myself = n;
102 103 104 105 106 107 108 109 110
                n->flags |= REDIS_NODE_MYSELF;
            } else if (!strcasecmp(s,"master")) {
                n->flags |= REDIS_NODE_MASTER;
            } else if (!strcasecmp(s,"slave")) {
                n->flags |= REDIS_NODE_SLAVE;
            } else if (!strcasecmp(s,"fail?")) {
                n->flags |= REDIS_NODE_PFAIL;
            } else if (!strcasecmp(s,"fail")) {
                n->flags |= REDIS_NODE_FAIL;
A
antirez 已提交
111
                n->fail_time = time(NULL);
112 113 114 115
            } else if (!strcasecmp(s,"handshake")) {
                n->flags |= REDIS_NODE_HANDSHAKE;
            } else if (!strcasecmp(s,"noaddr")) {
                n->flags |= REDIS_NODE_NOADDR;
116 117
            } else if (!strcasecmp(s,"noflags")) {
                /* nothing to do */
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
            } else {
                redisPanic("Unknown flag in redis cluster config file");
            }
            if (p) s = p+1;
        }

        /* Get master if any. Set the master and populate master's
         * slave list. */
        if (argv[3][0] != '-') {
            master = clusterLookupNode(argv[3]);
            if (!master) {
                master = createClusterNode(argv[3],0);
                clusterAddNode(master);
            }
            n->slaveof = master;
            clusterNodeAddSlave(master,n);
        }

136 137 138 139
        /* Set ping sent / pong received timestamps */
        if (atoi(argv[4])) n->ping_sent = time(NULL);
        if (atoi(argv[5])) n->pong_received = time(NULL);

140 141 142 143
        /* Populate hash slots served by this instance. */
        for (j = 7; j < argc; j++) {
            int start, stop;

A
antirez 已提交
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
            if (argv[j][0] == '[') {
                /* Here we handle migrating / importing slots */
                int slot;
                char direction;
                clusterNode *cn;

                p = strchr(argv[j],'-');
                redisAssert(p != NULL);
                *p = '\0';
                direction = p[1]; /* Either '>' or '<' */
                slot = atoi(argv[j]+1);
                p += 3;
                cn = clusterLookupNode(p);
                if (!cn) {
                    cn = createClusterNode(p,0);
                    clusterAddNode(cn);
                }
                if (direction == '>') {
162
                    server.cluster->migrating_slots_to[slot] = cn;
A
antirez 已提交
163
                } else {
164
                    server.cluster->importing_slots_from[slot] = cn;
A
antirez 已提交
165 166 167
                }
                continue;
            } else if ((p = strchr(argv[j],'-')) != NULL) {
168 169 170 171 172 173 174 175
                *p = '\0';
                start = atoi(argv[j]);
                stop = atoi(p+1);
            } else {
                start = stop = atoi(argv[j]);
            }
            while(start <= stop) clusterAddSlot(n, start++);
        }
A
antirez 已提交
176

177
        sdsfreesplitres(argv,argc);
A
antirez 已提交
178 179
    }
    zfree(line);
A
antirez 已提交
180 181
    fclose(fp);

A
antirez 已提交
182
    /* Config sanity check */
183
    redisAssert(server.cluster->myself != NULL);
A
antirez 已提交
184
    redisLog(REDIS_NOTICE,"Node configuration loaded, I'm %.40s",
185
        server.cluster->myself->name);
186
    clusterUpdateState();
A
antirez 已提交
187 188 189
    return REDIS_OK;

fmterr:
G
guiquanz 已提交
190
    redisLog(REDIS_WARNING,"Unrecoverable error: corrupted cluster config file.");
A
antirez 已提交
191 192 193 194
    fclose(fp);
    exit(1);
}

A
antirez 已提交
195 196 197 198
/* Cluster node configuration is exactly the same as CLUSTER NODES output.
 *
 * This function writes the node config and returns 0, on error -1
 * is returned. */
199
int clusterSaveConfig(void) {
A
antirez 已提交
200 201 202
    sds ci = clusterGenNodesDescription();
    int fd;
    
203
    if ((fd = open(server.cluster_configfile,O_WRONLY|O_CREAT|O_TRUNC,0644))
A
antirez 已提交
204
        == -1) goto err;
A
antirez 已提交
205 206 207 208 209 210 211 212 213 214
    if (write(fd,ci,sdslen(ci)) != (ssize_t)sdslen(ci)) goto err;
    close(fd);
    sdsfree(ci);
    return 0;

err:
    sdsfree(ci);
    return -1;
}

215 216 217 218 219 220 221
void clusterSaveConfigOrDie(void) {
    if (clusterSaveConfig() == -1) {
        redisLog(REDIS_WARNING,"Fatal: can't update cluster config file.");
        exit(1);
    }
}

A
antirez 已提交
222
void clusterInit(void) {
223 224
    int saveconf = 0;

225 226 227
    server.cluster = zmalloc(sizeof(clusterState));
    server.cluster->myself = NULL;
    server.cluster->state = REDIS_CLUSTER_FAIL;
228
    server.cluster->size = 1;
229 230
    server.cluster->nodes = dictCreate(&clusterNodesDictType,NULL);
    server.cluster->node_timeout = 15;
231 232
    server.cluster->failover_auth_time = 0;
    server.cluster->failover_auth_count = 0;
233 234 235 236 237 238 239
    memset(server.cluster->migrating_slots_to,0,
        sizeof(server.cluster->migrating_slots_to));
    memset(server.cluster->importing_slots_from,0,
        sizeof(server.cluster->importing_slots_from));
    memset(server.cluster->slots,0,
        sizeof(server.cluster->slots));
    if (clusterLoadConfig(server.cluster_configfile) == REDIS_ERR) {
A
antirez 已提交
240 241
        /* No configuration found. We will just use the random name provided
         * by the createClusterNode() function. */
242 243
        server.cluster->myself =
            createClusterNode(NULL,REDIS_NODE_MYSELF|REDIS_NODE_MASTER);
A
antirez 已提交
244
        redisLog(REDIS_NOTICE,"No cluster configuration found, I'm %.40s",
245 246
            server.cluster->myself->name);
        clusterAddNode(server.cluster->myself);
247 248
        saveconf = 1;
    }
249
    if (saveconf) clusterSaveConfigOrDie();
A
antirez 已提交
250 251 252 253 254 255 256 257
    /* We need a listening TCP port for our cluster messaging needs */
    server.cfd = anetTcpServer(server.neterr,
            server.port+REDIS_CLUSTER_PORT_INCR, server.bindaddr);
    if (server.cfd == -1) {
        redisLog(REDIS_WARNING, "Opening cluster TCP port: %s", server.neterr);
        exit(1);
    }
    if (aeCreateFileEvent(server.el, server.cfd, AE_READABLE,
A
antirez 已提交
258
        clusterAcceptHandler, NULL) == AE_ERR) redisPanic("Unrecoverable error creating Redis Cluster file event.");
259
    server.cluster->slots_to_keys = zslCreate();
A
antirez 已提交
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
}

/* -----------------------------------------------------------------------------
 * CLUSTER communication link
 * -------------------------------------------------------------------------- */

clusterLink *createClusterLink(clusterNode *node) {
    clusterLink *link = zmalloc(sizeof(*link));
    link->sndbuf = sdsempty();
    link->rcvbuf = sdsempty();
    link->node = node;
    link->fd = -1;
    return link;
}

/* Free a cluster link, but does not free the associated node of course.
 * Just this function will make sure that the original node associated
 * with this link will have the 'link' field set to NULL. */
void freeClusterLink(clusterLink *link) {
    if (link->fd != -1) {
        aeDeleteFileEvent(server.el, link->fd, AE_WRITABLE);
        aeDeleteFileEvent(server.el, link->fd, AE_READABLE);
    }
    sdsfree(link->sndbuf);
    sdsfree(link->rcvbuf);
    if (link->node)
        link->node->link = NULL;
    close(link->fd);
    zfree(link);
}

void clusterAcceptHandler(aeEventLoop *el, int fd, void *privdata, int mask) {
    int cport, cfd;
    char cip[128];
    clusterLink *link;
    REDIS_NOTUSED(el);
    REDIS_NOTUSED(mask);
    REDIS_NOTUSED(privdata);

    cfd = anetTcpAccept(server.neterr, fd, cip, &cport);
    if (cfd == AE_ERR) {
        redisLog(REDIS_VERBOSE,"Accepting cluster node: %s", server.neterr);
        return;
    }
    redisLog(REDIS_VERBOSE,"Accepted cluster node %s:%d", cip, cport);
    /* We need to create a temporary node in order to read the incoming
     * packet in a valid contest. This node will be released once we
     * read the packet and reply. */
    link = createClusterLink(NULL);
    link->fd = cfd;
    aeCreateFileEvent(server.el,cfd,AE_READABLE,clusterReadHandler,link);
}

/* -----------------------------------------------------------------------------
 * Key space handling
 * -------------------------------------------------------------------------- */

317 318
/* We have 16384 hash slots. The hash slot of a given key is obtained
 * as the least significant 14 bits of the crc16 of the key. */
A
antirez 已提交
319
unsigned int keyHashSlot(char *key, int keylen) {
320
    return crc16(key,keylen) & 0x3FFF;
A
antirez 已提交
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339
}

/* -----------------------------------------------------------------------------
 * CLUSTER node API
 * -------------------------------------------------------------------------- */

/* Create a new cluster node, with the specified flags.
 * If "nodename" is NULL this is considered a first handshake and a random
 * node name is assigned to this node (it will be fixed later when we'll
 * receive the first pong).
 *
 * The node is created and returned to the user, but it is not automatically
 * added to the nodes hash table. */
clusterNode *createClusterNode(char *nodename, int flags) {
    clusterNode *node = zmalloc(sizeof(*node));

    if (nodename)
        memcpy(node->name, nodename, REDIS_CLUSTER_NAMELEN);
    else
340
        getRandomHexChars(node->name, REDIS_CLUSTER_NAMELEN);
A
antirez 已提交
341 342
    node->flags = flags;
    memset(node->slots,0,sizeof(node->slots));
343
    node->numslots = 0;
A
antirez 已提交
344 345 346 347
    node->numslaves = 0;
    node->slaves = NULL;
    node->slaveof = NULL;
    node->ping_sent = node->pong_received = 0;
A
antirez 已提交
348
    node->fail_time = 0;
A
antirez 已提交
349 350 351
    node->configdigest = NULL;
    node->configdigest_ts = 0;
    node->link = NULL;
352
    memset(node->ip,0,sizeof(node->ip));
353
    node->port = 0;
354 355
    node->fail_reports = listCreate();
    listSetFreeMethod(node->fail_reports,zfree);
A
antirez 已提交
356 357 358
    return node;
}

359 360 361 362 363
/* This function is called every time we get a failure report from a node.
 * The side effect is to populate the fail_reports list (or to update
 * the timestamp of an existing report).
 *
 * 'failing' is the node that is in failure state according to the
364 365 366 367 368 369
 * 'sender' node.
 *
 * The function returns 0 if it just updates a timestamp of an existing
 * failure report from the same sender. 1 is returned if a new failure
 * report is created. */
int clusterNodeAddFailureReport(clusterNode *failing, clusterNode *sender) {
370 371 372 373 374 375 376 377 378 379 380 381
    list *l = failing->fail_reports;
    listNode *ln;
    listIter li;
    clusterNodeFailReport *fr;

    /* If a failure report from the same sender already exists, just update
     * the timestamp. */
    listRewind(l,&li);
    while ((ln = listNext(&li)) != NULL) {
        fr = ln->value;
        if (fr->node == sender) {
            fr->time = time(NULL);
382
            return 0;
383 384 385 386 387 388 389 390
        }
    }

    /* Otherwise create a new report. */
    fr = zmalloc(sizeof(*fr));
    fr->node = sender;
    fr->time = time(NULL);
    listAddNodeTail(l,fr);
391
    return 1;
392 393
}

394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413
/* Remove failure reports that are too old, where too old means reasonably
 * older than the global node timeout. Note that anyway for a node to be
 * flagged as FAIL we need to have a local PFAIL state that is at least
 * older than the global node timeout, so we don't just trust the number
 * of failure reports from other nodes. */
void clusterNodeCleanupFailureReports(clusterNode *node) {
    list *l = node->fail_reports;
    listNode *ln;
    listIter li;
    clusterNodeFailReport *fr;
    time_t maxtime = server.cluster->node_timeout*2;
    time_t now = time(NULL);

    listRewind(l,&li);
    while ((ln = listNext(&li)) != NULL) {
        fr = ln->value;
        if (now - fr->time > maxtime) listDelNode(l,ln);
    }
}

414 415 416 417 418 419 420
/* Remove the failing report for 'node' if it was previously considered
 * failing by 'sender'. This function is called when a node informs us via
 * gossip that a node is OK from its point of view (no FAIL or PFAIL flags).
 *
 * Note that this function is called relatively often as it gets called even
 * when there are no nodes failing, and is O(N), however when the cluster is
 * fine the failure reports list is empty so the function runs in constant
421 422 423 424 425
 * time.
 *
 * The function returns 1 if the failure report was found and removed.
 * Otherwise 0 is returned. */
int clusterNodeDelFailureReport(clusterNode *node, clusterNode *sender) {
426 427 428 429 430 431 432 433 434 435 436
    list *l = node->fail_reports;
    listNode *ln;
    listIter li;
    clusterNodeFailReport *fr;

    /* Search for a failure report from this sender. */
    listRewind(l,&li);
    while ((ln = listNext(&li)) != NULL) {
        fr = ln->value;
        if (fr->node == sender) break;
    }
437
    if (!ln) return 0; /* No failure report from this sender. */
438 439 440

    /* Remove the failure report. */
    listDelNode(l,ln);
441
    clusterNodeCleanupFailureReports(node);
442
    return 1;
443 444
}

445 446 447 448 449 450 451 452
/* Return the number of external nodes that believe 'node' is failing,
 * not including this node, that may have a PFAIL or FAIL state for this
 * node as well. */
int clusterNodeFailureReportsCount(clusterNode *node) {
    clusterNodeCleanupFailureReports(node);
    return listLength(node->fail_reports);
}

A
antirez 已提交
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
int clusterNodeRemoveSlave(clusterNode *master, clusterNode *slave) {
    int j;

    for (j = 0; j < master->numslaves; j++) {
        if (master->slaves[j] == slave) {
            memmove(master->slaves+j,master->slaves+(j+1),
                (master->numslaves-1)-j);
            master->numslaves--;
            return REDIS_OK;
        }
    }
    return REDIS_ERR;
}

int clusterNodeAddSlave(clusterNode *master, clusterNode *slave) {
    int j;

    /* If it's already a slave, don't add it again. */
    for (j = 0; j < master->numslaves; j++)
        if (master->slaves[j] == slave) return REDIS_ERR;
    master->slaves = zrealloc(master->slaves,
        sizeof(clusterNode*)*(master->numslaves+1));
    master->slaves[master->numslaves] = slave;
    master->numslaves++;
    return REDIS_OK;
}

void clusterNodeResetSlaves(clusterNode *n) {
    zfree(n->slaves);
    n->numslaves = 0;
}

void freeClusterNode(clusterNode *n) {
    sds nodename;
487

A
antirez 已提交
488
    nodename = sdsnewlen(n->name, REDIS_CLUSTER_NAMELEN);
489
    redisAssert(dictDelete(server.cluster->nodes,nodename) == DICT_OK);
A
antirez 已提交
490 491 492
    sdsfree(nodename);
    if (n->slaveof) clusterNodeRemoveSlave(n->slaveof, n);
    if (n->link) freeClusterLink(n->link);
493
    listRelease(n->fail_reports);
A
antirez 已提交
494 495 496 497 498 499 500
    zfree(n);
}

/* Add a node to the nodes hash table */
int clusterAddNode(clusterNode *node) {
    int retval;
    
501
    retval = dictAdd(server.cluster->nodes,
A
antirez 已提交
502 503 504 505
            sdsnewlen(node->name,REDIS_CLUSTER_NAMELEN), node);
    return (retval == DICT_OK) ? REDIS_OK : REDIS_ERR;
}

A
antirez 已提交
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
/* Remove a node from the cluster:
 * 1) Mark all the nodes handled by it as unassigned.
 * 2) Remove all the failure reports sent by this node.
 * 3) Free the node, that will in turn remove it from the hash table
 *    and from the list of slaves of its master, if it is a slave node.
 */
void clusterDelNode(clusterNode *delnode) {
    int j;
    dictIterator *di;
    dictEntry *de;

    /* 1) Mark slots as unassigned. */
    for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
        if (server.cluster->importing_slots_from[j] == delnode)
            server.cluster->importing_slots_from[j] = NULL;
        if (server.cluster->migrating_slots_to[j] == delnode)
            server.cluster->migrating_slots_to[j] = NULL;
        if (server.cluster->slots[j] == delnode)
            clusterDelSlot(j);
    }

    /* 2) Remove failure reports. */
    di = dictGetIterator(server.cluster->nodes);
    while((de = dictNext(di)) != NULL) {
        clusterNode *node = dictGetVal(de);

        if (node == delnode) continue;
        clusterNodeDelFailureReport(node,delnode);
    }
    dictReleaseIterator(di);

    /* 3) Free the node, unlinking it from the cluster. */
    freeClusterNode(delnode);
}

A
antirez 已提交
541 542 543 544 545
/* Node lookup by name */
clusterNode *clusterLookupNode(char *name) {
    sds s = sdsnewlen(name, REDIS_CLUSTER_NAMELEN);
    struct dictEntry *de;

546
    de = dictFind(server.cluster->nodes,s);
A
antirez 已提交
547 548
    sdsfree(s);
    if (de == NULL) return NULL;
549
    return dictGetVal(de);
A
antirez 已提交
550 551 552 553 554 555 556 557 558 559 560 561
}

/* This is only used after the handshake. When we connect a given IP/PORT
 * as a result of CLUSTER MEET we don't have the node name yet, so we
 * pick a random one, and will fix it when we receive the PONG request using
 * this function. */
void clusterRenameNode(clusterNode *node, char *newname) {
    int retval;
    sds s = sdsnewlen(node->name, REDIS_CLUSTER_NAMELEN);
   
    redisLog(REDIS_DEBUG,"Renaming node %.40s into %.40s",
        node->name, newname);
562
    retval = dictDelete(server.cluster->nodes, s);
A
antirez 已提交
563 564 565 566 567 568 569 570 571 572
    sdsfree(s);
    redisAssert(retval == DICT_OK);
    memcpy(node->name, newname, REDIS_CLUSTER_NAMELEN);
    clusterAddNode(node);
}

/* -----------------------------------------------------------------------------
 * CLUSTER messages exchange - PING/PONG and gossip
 * -------------------------------------------------------------------------- */

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
/* This function checks if a given node should be marked as FAIL.
 * It happens if the following conditions are met:
 *
 * 1) We are a master node. Only master nodes can mark a node as failing.
 * 2) We received enough failure reports from other nodes via gossip.
 *    Enough means that the majority of the masters believe the node is
 *    down.
 * 3) We believe this node is in PFAIL state.
 *
 * If a failure is detected we also inform the whole cluster about this
 * event trying to force every other node to set the FAIL flag for the node.
 */
void markNodeAsFailingIfNeeded(clusterNode *node) {
    int failures;
    int needed_quorum = (server.cluster->size / 2) + 1;

    if (!(server.cluster->myself->flags & REDIS_NODE_MASTER)) return;
    if (!(node->flags & REDIS_NODE_PFAIL)) return; /* We can reach it. */
    if (node->flags & REDIS_NODE_FAIL) return; /* Already FAILing. */

    failures = 1 + clusterNodeFailureReportsCount(node); /* +1 is for myself. */
    if (failures < needed_quorum) return;

    redisLog(REDIS_NOTICE,
        "Marking node %.40s as failing (quorum reached).", node->name);

    /* Mark the node as failing. */
    node->flags &= ~REDIS_NODE_PFAIL;
    node->flags |= REDIS_NODE_FAIL;
A
antirez 已提交
602
    node->fail_time = time(NULL);
603 604 605 606 607 608 609 610 611 612 613 614 615 616

    /* Broadcast the failing node name to everybody */
    clusterSendFail(node->name);
    clusterUpdateState();
    clusterSaveConfigOrDie();
}

/* This function is called only if a node is marked as FAIL, but we are able
 * to reach it again. It checks if there are the conditions to undo the FAIL
 * state.
 *
 * Currently we only revert the FAIL state if there are no slaves for this
 * node, so that no election was possible. */
void clearNodeFailureIfNeeded(clusterNode *node) {
A
antirez 已提交
617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639
    int changes = 0;
    time_t now = time(NULL);

    redisAssert(node->flags & REDIS_NODE_FAIL);

    /* For slaves we always clear the FAIL flag if we can contact the
     * node again. */
    if (node->flags & REDIS_NODE_SLAVE) {
        redisLog(REDIS_NOTICE,
            "Clear FAIL state for node %.40s: slave is already reachable.",
                node->name);
        node->flags &= ~REDIS_NODE_FAIL;
        changes++;
    }

    /* If it is a master and...
     * 1) The FAIL state was set more than 2 times the node timeout + 10 sec.
     * 2) It is yet serving slots from our point of view (not failed over).
     * Apparently no one is going to fix these slots, clear the FAIL flag. */
    if (node->flags & REDIS_NODE_MASTER &&
        node->numslots > 0 &&
        (now - node->fail_time) > (server.cluster->node_timeout*2+10))
    {
640
        redisLog(REDIS_NOTICE,
A
antirez 已提交
641
            "Clear FAIL state for node %.40s: is reachable again and nobody is serving its slots after some time.",
642
                node->name);
643
        node->flags &= ~REDIS_NODE_FAIL;
A
antirez 已提交
644 645 646 647 648
        changes++;
    }

    /* Update state and save config. */
    if (changes) {
649 650
        clusterUpdateState();
        clusterSaveConfigOrDie();
651 652 653
    }
}

A
antirez 已提交
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
/* Process the gossip section of PING or PONG packets.
 * Note that this function assumes that the packet is already sanity-checked
 * by the caller, not in the content of the gossip section, but in the
 * length. */
void clusterProcessGossipSection(clusterMsg *hdr, clusterLink *link) {
    uint16_t count = ntohs(hdr->count);
    clusterMsgDataGossip *g = (clusterMsgDataGossip*) hdr->data.ping.gossip;
    clusterNode *sender = link->node ? link->node : clusterLookupNode(hdr->sender);

    while(count--) {
        sds ci = sdsempty();
        uint16_t flags = ntohs(g->flags);
        clusterNode *node;

        if (flags == 0) ci = sdscat(ci,"noflags,");
        if (flags & REDIS_NODE_MYSELF) ci = sdscat(ci,"myself,");
        if (flags & REDIS_NODE_MASTER) ci = sdscat(ci,"master,");
        if (flags & REDIS_NODE_SLAVE) ci = sdscat(ci,"slave,");
        if (flags & REDIS_NODE_PFAIL) ci = sdscat(ci,"fail?,");
        if (flags & REDIS_NODE_FAIL) ci = sdscat(ci,"fail,");
        if (flags & REDIS_NODE_HANDSHAKE) ci = sdscat(ci,"handshake,");
        if (flags & REDIS_NODE_NOADDR) ci = sdscat(ci,"noaddr,");
        if (ci[sdslen(ci)-1] == ',') ci[sdslen(ci)-1] = ' ';

        redisLog(REDIS_DEBUG,"GOSSIP %.40s %s:%d %s",
            g->nodename,
            g->ip,
            ntohs(g->port),
            ci);
        sdsfree(ci);

        /* Update our state accordingly to the gossip sections */
        node = clusterLookupNode(g->nodename);
        if (node != NULL) {
            /* We already know this node. Let's start updating the last
             * time PONG figure if it is newer than our figure.
             * Note that it's not a problem if we have a PING already 
             * in progress against this node. */
A
antirez 已提交
692
            if (node->pong_received < (signed) ntohl(g->pong_received)) {
A
antirez 已提交
693 694 695
                 redisLog(REDIS_DEBUG,"Node pong_received updated by gossip");
                node->pong_received = ntohl(g->pong_received);
            }
696
            /* Handle failure reports, only when the sender is a master. */
697 698 699
            if (sender && sender->flags & REDIS_NODE_MASTER &&
                node != server.cluster->myself)
            {
700 701 702 703 704 705 706 707 708 709 710 711 712 713
                if (flags & (REDIS_NODE_FAIL|REDIS_NODE_PFAIL)) {
                    if (clusterNodeAddFailureReport(node,sender)) {
                        redisLog(REDIS_NOTICE,
                            "Node %.40s reported node %.40s as not reachable.",
                            sender->name, node->name);
                    }
                    markNodeAsFailingIfNeeded(node);
                } else {
                    if (clusterNodeDelFailureReport(node,sender)) {
                        redisLog(REDIS_NOTICE,
                            "Node %.40s reported node %.40s is back online.",
                            sender->name, node->name);
                    }
                }
A
antirez 已提交
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
            }
        } else {
            /* If it's not in NOADDR state and we don't have it, we
             * start an handshake process against this IP/PORT pairs.
             *
             * Note that we require that the sender of this gossip message
             * is a well known node in our cluster, otherwise we risk
             * joining another cluster. */
            if (sender && !(flags & REDIS_NODE_NOADDR)) {
                clusterNode *newnode;

                redisLog(REDIS_DEBUG,"Adding the new node");
                newnode = createClusterNode(NULL,REDIS_NODE_HANDSHAKE);
                memcpy(newnode->ip,g->ip,sizeof(g->ip));
                newnode->port = ntohs(g->port);
                clusterAddNode(newnode);
            }
        }

        /* Next node */
        g++;
    }
}

/* IP -> string conversion. 'buf' is supposed to at least be 16 bytes. */
void nodeIp2String(char *buf, clusterLink *link) {
    struct sockaddr_in sa;
    socklen_t salen = sizeof(sa);

    if (getpeername(link->fd, (struct sockaddr*) &sa, &salen) == -1)
        redisPanic("getpeername() failed.");
    strncpy(buf,inet_ntoa(sa.sin_addr),sizeof(link->node->ip));
}


/* Update the node address to the IP address that can be extracted
 * from link->fd, and at the specified port. */
void nodeUpdateAddress(clusterNode *node, clusterLink *link, int port) {
752
    /* TODO */
A
antirez 已提交
753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769
}

/* When this function is called, there is a packet to process starting
 * at node->rcvbuf. Releasing the buffer is up to the caller, so this
 * function should just handle the higher level stuff of processing the
 * packet, modifying the cluster state if needed.
 *
 * The function returns 1 if the link is still valid after the packet
 * was processed, otherwise 0 if the link was freed since the packet
 * processing lead to some inconsistency error (for instance a PONG
 * received from the wrong sender ID). */
int clusterProcessPacket(clusterLink *link) {
    clusterMsg *hdr = (clusterMsg*) link->rcvbuf;
    uint32_t totlen = ntohl(hdr->totlen);
    uint16_t type = ntohs(hdr->type);
    clusterNode *sender;

770 771
    redisLog(REDIS_DEBUG,"--- Processing packet of type %d, %lu bytes",
        type, (unsigned long) totlen);
772 773

    /* Perform sanity checks */
A
antirez 已提交
774 775 776 777 778 779 780 781 782 783 784
    if (totlen < 8) return 1;
    if (totlen > sdslen(link->rcvbuf)) return 1;
    if (type == CLUSTERMSG_TYPE_PING || type == CLUSTERMSG_TYPE_PONG ||
        type == CLUSTERMSG_TYPE_MEET)
    {
        uint16_t count = ntohs(hdr->count);
        uint32_t explen; /* expected length of this packet */

        explen = sizeof(clusterMsg)-sizeof(union clusterMsgData);
        explen += (sizeof(clusterMsgDataGossip)*count);
        if (totlen != explen) return 1;
785
    } else if (type == CLUSTERMSG_TYPE_FAIL) {
A
antirez 已提交
786 787 788 789
        uint32_t explen = sizeof(clusterMsg)-sizeof(union clusterMsgData);

        explen += sizeof(clusterMsgDataFail);
        if (totlen != explen) return 1;
790
    } else if (type == CLUSTERMSG_TYPE_PUBLISH) {
791 792 793 794 795 796
        uint32_t explen = sizeof(clusterMsg)-sizeof(union clusterMsgData);

        explen += sizeof(clusterMsgDataPublish) +
                ntohl(hdr->data.publish.msg.channel_len) +
                ntohl(hdr->data.publish.msg.message_len);
        if (totlen != explen) return 1;
797 798 799 800
    } else if (type == CLUSTERMSG_TYPE_FAILOVER_AUTH_REQUEST) {
        uint32_t explen = sizeof(clusterMsg)-sizeof(union clusterMsgData);

        if (totlen != explen) return 1;
801
    }
A
antirez 已提交
802

803
    /* Ready to process the packet. Dispatch by type. */
A
antirez 已提交
804 805
    sender = clusterLookupNode(hdr->sender);
    if (type == CLUSTERMSG_TYPE_PING || type == CLUSTERMSG_TYPE_MEET) {
806
        int update_config = 0;
807
        redisLog(REDIS_DEBUG,"Ping packet received: %p", (void*)link->node);
A
antirez 已提交
808 809 810 811 812 813 814 815 816 817 818 819

        /* Add this node if it is new for us and the msg type is MEET.
         * In this stage we don't try to add the node with the right
         * flags, slaveof pointer, and so forth, as this details will be
         * resolved when we'll receive PONGs from the server. */
        if (!sender && type == CLUSTERMSG_TYPE_MEET) {
            clusterNode *node;

            node = createClusterNode(NULL,REDIS_NODE_HANDSHAKE);
            nodeIp2String(node->ip,link);
            node->port = ntohs(hdr->port);
            clusterAddNode(node);
820
            update_config = 1;
A
antirez 已提交
821 822 823 824 825 826 827
        }

        /* Get info from the gossip section */
        clusterProcessGossipSection(hdr,link);

        /* Anyway reply with a PONG */
        clusterSendPing(link,CLUSTERMSG_TYPE_PONG);
828 829 830

        /* Update config if needed */
        if (update_config) clusterSaveConfigOrDie();
A
antirez 已提交
831
    } else if (type == CLUSTERMSG_TYPE_PONG) {
832 833
        int update_state = 0;
        int update_config = 0;
A
antirez 已提交
834

835
        redisLog(REDIS_DEBUG,"Pong packet received: %p", (void*)link->node);
A
antirez 已提交
836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853
        if (link->node) {
            if (link->node->flags & REDIS_NODE_HANDSHAKE) {
                /* If we already have this node, try to change the
                 * IP/port of the node with the new one. */
                if (sender) {
                    redisLog(REDIS_WARNING,
                        "Handshake error: we already know node %.40s, updating the address if needed.", sender->name);
                    nodeUpdateAddress(sender,link,ntohs(hdr->port));
                    freeClusterNode(link->node); /* will free the link too */
                    return 0;
                }

                /* First thing to do is replacing the random name with the
                 * right node name if this was an handshake stage. */
                clusterRenameNode(link->node, hdr->sender);
                redisLog(REDIS_DEBUG,"Handshake with node %.40s completed.",
                    link->node->name);
                link->node->flags &= ~REDIS_NODE_HANDSHAKE;
854
                update_config = 1;
A
antirez 已提交
855 856 857 858 859 860 861 862
            } else if (memcmp(link->node->name,hdr->sender,
                        REDIS_CLUSTER_NAMELEN) != 0)
            {
                /* If the reply has a non matching node ID we
                 * disconnect this node and set it as not having an associated
                 * address. */
                redisLog(REDIS_DEBUG,"PONG contains mismatching sender ID");
                link->node->flags |= REDIS_NODE_NOADDR;
863 864
                link->node->ip[0] = '\0';
                link->node->port = 0;
A
antirez 已提交
865
                freeClusterLink(link);
866
                update_config = 1;
A
antirez 已提交
867 868 869 870 871 872 873
                /* FIXME: remove this node if we already have it.
                 *
                 * If we already have it but the IP is different, use
                 * the new one if the old node is in FAIL, PFAIL, or NOADDR
                 * status... */
                return 0;
            }
874 875 876 877 878
        } else if (type == CLUSTERMSG_TYPE_FAILOVER_AUTH_REQUEST) {
            if (!sender) return 0;  /* We don't know that node. */
            /* If we are not a master, ignore that message at all. */
            if (!(server.cluster->myself->flags & REDIS_NODE_MASTER)) return 0;
            clusterSendFailoverAuthIfNeeded(sender);
A
antirez 已提交
879
        }
880

A
antirez 已提交
881
        /* Update our info about the node */
882
        if (link->node) link->node->pong_received = time(NULL);
A
antirez 已提交
883 884 885 886 887 888 889 890 891 892 893 894 895 896 897

        /* Update master/slave info */
        if (sender) {
            if (!memcmp(hdr->slaveof,REDIS_NODE_NULL_NAME,
                sizeof(hdr->slaveof)))
            {
                sender->flags &= ~REDIS_NODE_SLAVE;
                sender->flags |= REDIS_NODE_MASTER;
                sender->slaveof = NULL;
            } else {
                clusterNode *master = clusterLookupNode(hdr->slaveof);

                sender->flags &= ~REDIS_NODE_MASTER;
                sender->flags |= REDIS_NODE_SLAVE;
                if (sender->numslaves) clusterNodeResetSlaves(sender);
898 899 900 901
                if (master) {
                    clusterNodeAddSlave(master,sender);
                    sender->slaveof = master;
                }
A
antirez 已提交
902 903 904
            }
        }

905
        /* Update our info about served slots. */
A
antirez 已提交
906
        if (sender && sender->flags & REDIS_NODE_MASTER) {
907
            int changes, j;
A
antirez 已提交
908

909
            changes =
A
antirez 已提交
910
                memcmp(sender->slots,hdr->myslots,sizeof(hdr->myslots)) != 0;
911
            if (changes) {
A
antirez 已提交
912
                for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
913
                    if (bitmapTestBit(hdr->myslots,j)) {
914 915 916
                        /* If this slot was not served, or served by a node
                         * in FAIL state, update the table with the new node
                         * caliming to serve the slot. */
917 918 919
                        if (server.cluster->slots[j] == sender) continue;
                        if (server.cluster->slots[j] == NULL ||
                            server.cluster->slots[j]->flags & REDIS_NODE_FAIL)
A
antirez 已提交
920
                        {
921 922
                            clusterDelSlot(j);
                            clusterAddSlot(sender,j);
923
                            update_state = update_config = 1;
A
antirez 已提交
924
                        }
925
                    } else {
926 927 928 929
                        /* This node claims to no longer handling the slot,
                         * however we don't change our config as this is likely
                         * happening because a resharding is in progress, and
                         * it already knows where to redirect clients. */
A
antirez 已提交
930 931 932 933 934 935 936 937 938
                    }
                }
            }
        }

        /* Get info from the gossip section */
        clusterProcessGossipSection(hdr,link);

        /* Update the cluster state if needed */
939 940
        if (update_state) clusterUpdateState();
        if (update_config) clusterSaveConfigOrDie();
A
antirez 已提交
941 942 943 944
    } else if (type == CLUSTERMSG_TYPE_FAIL && sender) {
        clusterNode *failing;

        failing = clusterLookupNode(hdr->data.fail.about.nodename);
945 946
        if (failing && !(failing->flags & (REDIS_NODE_FAIL|REDIS_NODE_MYSELF)))
        {
A
antirez 已提交
947 948 949 950
            redisLog(REDIS_NOTICE,
                "FAIL message received from %.40s about %.40s",
                hdr->sender, hdr->data.fail.about.nodename);
            failing->flags |= REDIS_NODE_FAIL;
A
antirez 已提交
951
            failing->fail_time = time(NULL);
A
antirez 已提交
952 953
            failing->flags &= ~REDIS_NODE_PFAIL;
            clusterUpdateState();
A
antirez 已提交
954
            clusterSaveConfigOrDie();
A
antirez 已提交
955
        }
956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971
    } else if (type == CLUSTERMSG_TYPE_PUBLISH) {
        robj *channel, *message;
        uint32_t channel_len, message_len;

        /* Don't bother creating useless objects if there are no Pub/Sub subscribers. */
        if (dictSize(server.pubsub_channels) || listLength(server.pubsub_patterns)) {
            channel_len = ntohl(hdr->data.publish.msg.channel_len);
            message_len = ntohl(hdr->data.publish.msg.message_len);
            channel = createStringObject(
                        (char*)hdr->data.publish.msg.bulk_data,channel_len);
            message = createStringObject(
                        (char*)hdr->data.publish.msg.bulk_data+channel_len, message_len);
            pubsubPublishMessage(channel,message);
            decrRefCount(channel);
            decrRefCount(message);
        }
A
antirez 已提交
972
    } else {
973
        redisLog(REDIS_WARNING,"Received unknown packet type: %d", type);
A
antirez 已提交
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
    }
    return 1;
}

/* This function is called when we detect the link with this node is lost.
   We set the node as no longer connected. The Cluster Cron will detect
   this connection and will try to get it connected again.
   
   Instead if the node is a temporary node used to accept a query, we
   completely free the node on error. */
void handleLinkIOError(clusterLink *link) {
    freeClusterLink(link);
}

/* Send data. This is handled using a trivial send buffer that gets
 * consumed by write(). We don't try to optimize this for speed too much
 * as this is a very low traffic channel. */
void clusterWriteHandler(aeEventLoop *el, int fd, void *privdata, int mask) {
    clusterLink *link = (clusterLink*) privdata;
    ssize_t nwritten;
    REDIS_NOTUSED(el);
    REDIS_NOTUSED(mask);

    nwritten = write(fd, link->sndbuf, sdslen(link->sndbuf));
    if (nwritten <= 0) {
999
        redisLog(REDIS_DEBUG,"I/O error writing to node link: %s",
A
antirez 已提交
1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
            strerror(errno));
        handleLinkIOError(link);
        return;
    }
    link->sndbuf = sdsrange(link->sndbuf,nwritten,-1);
    if (sdslen(link->sndbuf) == 0)
        aeDeleteFileEvent(server.el, link->fd, AE_WRITABLE);
}

/* Read data. Try to read the first field of the header first to check the
 * full length of the packet. When a whole packet is in memory this function
 * will call the function to process the packet. And so forth. */
void clusterReadHandler(aeEventLoop *el, int fd, void *privdata, int mask) {
1013
    char buf[4096];
A
antirez 已提交
1014 1015 1016
    ssize_t nread;
    clusterMsg *hdr;
    clusterLink *link = (clusterLink*) privdata;
1017
    int readlen, rcvbuflen;
A
antirez 已提交
1018 1019 1020 1021
    REDIS_NOTUSED(el);
    REDIS_NOTUSED(mask);

again:
1022 1023 1024 1025 1026
    rcvbuflen = sdslen(link->rcvbuf);
    if (rcvbuflen < 4) {
        /* First, obtain the first four bytes to get the full message
         * length. */
        readlen = 4 - rcvbuflen;
A
antirez 已提交
1027
    } else {
1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039
        /* Finally read the full message. */
        hdr = (clusterMsg*) link->rcvbuf;
        if (rcvbuflen == 4) {
            /* Perform some sanity check on the message length. */
            if (ntohl(hdr->totlen) < CLUSTERMSG_MIN_LEN) {
                redisLog(REDIS_WARNING,
                    "Bad message length received from Cluster bus.");
                handleLinkIOError(link);
                return;
            }
        }
        readlen = ntohl(hdr->totlen) - rcvbuflen;
A
antirez 已提交
1040 1041 1042
    }

    nread = read(fd,buf,readlen);
1043
    if (nread == -1 && errno == EAGAIN) return; /* No more data ready. */
A
antirez 已提交
1044 1045 1046

    if (nread <= 0) {
        /* I/O error... */
1047
        redisLog(REDIS_DEBUG,"I/O error reading from node link: %s",
A
antirez 已提交
1048 1049 1050 1051 1052 1053 1054
            (nread == 0) ? "connection closed" : strerror(errno));
        handleLinkIOError(link);
        return;
    } else {
        /* Read data and recast the pointer to the new buffer. */
        link->rcvbuf = sdscatlen(link->rcvbuf,buf,nread);
        hdr = (clusterMsg*) link->rcvbuf;
1055
        rcvbuflen += nread;
A
antirez 已提交
1056 1057 1058 1059
    }

    /* Total length obtained? read the payload now instead of burning
     * cycles waiting for a new event to fire. */
1060
    if (rcvbuflen == 4) goto again;
A
antirez 已提交
1061 1062

    /* Whole packet in memory? We can process it. */
1063
    if (rcvbuflen == ntohl(hdr->totlen)) {
A
antirez 已提交
1064 1065 1066
        if (clusterProcessPacket(link)) {
            sdsfree(link->rcvbuf);
            link->rcvbuf = sdsempty();
1067
            rcvbuflen = 0; /* Useless line of code currently... defensive. */
A
antirez 已提交
1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080
        }
    }
}

/* Put stuff into the send buffer. */
void clusterSendMessage(clusterLink *link, unsigned char *msg, size_t msglen) {
    if (sdslen(link->sndbuf) == 0 && msglen != 0)
        aeCreateFileEvent(server.el,link->fd,AE_WRITABLE,
                    clusterWriteHandler,link);

    link->sndbuf = sdscatlen(link->sndbuf, msg, msglen);
}

1081 1082 1083 1084 1085
/* Send a message to all the nodes with a reliable link */
void clusterBroadcastMessage(void *buf, size_t len) {
    dictIterator *di;
    dictEntry *de;

1086
    di = dictGetIterator(server.cluster->nodes);
1087
    while((de = dictNext(di)) != NULL) {
1088
        clusterNode *node = dictGetVal(de);
1089 1090 1091 1092 1093 1094 1095 1096

        if (!node->link) continue;
        if (node->flags & (REDIS_NODE_MYSELF|REDIS_NODE_NOADDR)) continue;
        clusterSendMessage(node->link,buf,len);
    }
    dictReleaseIterator(di);
}

A
antirez 已提交
1097 1098
/* Build the message header */
void clusterBuildMessageHdr(clusterMsg *hdr, int type) {
1099
    int totlen = 0;
A
antirez 已提交
1100 1101 1102

    memset(hdr,0,sizeof(*hdr));
    hdr->type = htons(type);
1103 1104
    memcpy(hdr->sender,server.cluster->myself->name,REDIS_CLUSTER_NAMELEN);
    memcpy(hdr->myslots,server.cluster->myself->slots,
A
antirez 已提交
1105 1106
        sizeof(hdr->myslots));
    memset(hdr->slaveof,0,REDIS_CLUSTER_NAMELEN);
1107 1108
    if (server.cluster->myself->slaveof != NULL) {
        memcpy(hdr->slaveof,server.cluster->myself->slaveof->name,
A
antirez 已提交
1109 1110 1111
                                    REDIS_CLUSTER_NAMELEN);
    }
    hdr->port = htons(server.port);
1112
    hdr->state = server.cluster->state;
A
antirez 已提交
1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125
    memset(hdr->configdigest,0,32); /* FIXME: set config digest */

    if (type == CLUSTERMSG_TYPE_FAIL) {
        totlen = sizeof(clusterMsg)-sizeof(union clusterMsgData);
        totlen += sizeof(clusterMsgDataFail);
    }
    hdr->totlen = htonl(totlen);
    /* For PING, PONG, and MEET, fixing the totlen field is up to the caller */
}

/* Send a PING or PONG packet to the specified node, making sure to add enough
 * gossip informations. */
void clusterSendPing(clusterLink *link, int type) {
1126
    unsigned char buf[4096];
A
antirez 已提交
1127 1128 1129 1130 1131 1132 1133 1134
    clusterMsg *hdr = (clusterMsg*) buf;
    int gossipcount = 0, totlen;
    /* freshnodes is the number of nodes we can still use to populate the
     * gossip section of the ping packet. Basically we start with the nodes
     * we have in memory minus two (ourself and the node we are sending the
     * message to). Every time we add a node we decrement the counter, so when
     * it will drop to <= zero we know there is no more gossip info we can
     * send. */
1135
    int freshnodes = dictSize(server.cluster->nodes)-2;
A
antirez 已提交
1136 1137 1138 1139 1140 1141 1142

    if (link->node && type == CLUSTERMSG_TYPE_PING)
        link->node->ping_sent = time(NULL);
    clusterBuildMessageHdr(hdr,type);
        
    /* Populate the gossip fields */
    while(freshnodes > 0 && gossipcount < 3) {
1143
        struct dictEntry *de = dictGetRandomKey(server.cluster->nodes);
1144
        clusterNode *this = dictGetVal(de);
A
antirez 已提交
1145 1146 1147
        clusterMsgDataGossip *gossip;
        int j;

1148 1149 1150 1151 1152 1153
        /* In the gossip section don't include:
         * 1) Myself.
         * 2) Nodes in HANDSHAKE state.
         * 3) Nodes with the NOADDR flag set.
         * 4) Disconnected nodes if they don't have configured slots.
         */
1154
        if (this == server.cluster->myself ||
1155
            this->flags & (REDIS_NODE_HANDSHAKE|REDIS_NODE_NOADDR) ||
1156
            (this->link == NULL && this->numslots == 0))
1157
        {
A
antirez 已提交
1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186
                freshnodes--; /* otherwise we may loop forever. */
                continue;
        }

        /* Check if we already added this node */
        for (j = 0; j < gossipcount; j++) {
            if (memcmp(hdr->data.ping.gossip[j].nodename,this->name,
                    REDIS_CLUSTER_NAMELEN) == 0) break;
        }
        if (j != gossipcount) continue;

        /* Add it */
        freshnodes--;
        gossip = &(hdr->data.ping.gossip[gossipcount]);
        memcpy(gossip->nodename,this->name,REDIS_CLUSTER_NAMELEN);
        gossip->ping_sent = htonl(this->ping_sent);
        gossip->pong_received = htonl(this->pong_received);
        memcpy(gossip->ip,this->ip,sizeof(this->ip));
        gossip->port = htons(this->port);
        gossip->flags = htons(this->flags);
        gossipcount++;
    }
    totlen = sizeof(clusterMsg)-sizeof(union clusterMsgData);
    totlen += (sizeof(clusterMsgDataGossip)*gossipcount);
    hdr->count = htons(gossipcount);
    hdr->totlen = htonl(totlen);
    clusterSendMessage(link,buf,totlen);
}

1187 1188 1189 1190 1191 1192 1193 1194
/* Send a PUBLISH message.
 *
 * If link is NULL, then the message is broadcasted to the whole cluster. */
void clusterSendPublish(clusterLink *link, robj *channel, robj *message) {
    unsigned char buf[4096], *payload;
    clusterMsg *hdr = (clusterMsg*) buf;
    uint32_t totlen;
    uint32_t channel_len, message_len;
A
antirez 已提交
1195

1196 1197 1198 1199
    channel = getDecodedObject(channel);
    message = getDecodedObject(message);
    channel_len = sdslen(channel->ptr);
    message_len = sdslen(message->ptr);
A
antirez 已提交
1200

1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214
    clusterBuildMessageHdr(hdr,CLUSTERMSG_TYPE_PUBLISH);
    totlen = sizeof(clusterMsg)-sizeof(union clusterMsgData);
    totlen += sizeof(clusterMsgDataPublish) + channel_len + message_len;

    hdr->data.publish.msg.channel_len = htonl(channel_len);
    hdr->data.publish.msg.message_len = htonl(message_len);
    hdr->totlen = htonl(totlen);

    /* Try to use the local buffer if possible */
    if (totlen < sizeof(buf)) {
        payload = buf;
    } else {
        payload = zmalloc(totlen);
        hdr = (clusterMsg*) payload;
1215
        memcpy(payload,hdr,sizeof(*hdr));
A
antirez 已提交
1216
    }
1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228
    memcpy(hdr->data.publish.msg.bulk_data,channel->ptr,sdslen(channel->ptr));
    memcpy(hdr->data.publish.msg.bulk_data+sdslen(channel->ptr),
        message->ptr,sdslen(message->ptr));

    if (link)
        clusterSendMessage(link,payload,totlen);
    else
        clusterBroadcastMessage(payload,totlen);

    decrRefCount(channel);
    decrRefCount(message);
    if (payload != buf) zfree(payload);
A
antirez 已提交
1229 1230 1231 1232 1233 1234 1235 1236
}

/* Send a FAIL message to all the nodes we are able to contact.
 * The FAIL message is sent when we detect that a node is failing
 * (REDIS_NODE_PFAIL) and we also receive a gossip confirmation of this:
 * we switch the node state to REDIS_NODE_FAIL and ask all the other
 * nodes to do the same ASAP. */
void clusterSendFail(char *nodename) {
1237
    unsigned char buf[4096];
A
antirez 已提交
1238 1239 1240 1241 1242 1243 1244
    clusterMsg *hdr = (clusterMsg*) buf;

    clusterBuildMessageHdr(hdr,CLUSTERMSG_TYPE_FAIL);
    memcpy(hdr->data.fail.about.nodename,nodename,REDIS_CLUSTER_NAMELEN);
    clusterBroadcastMessage(buf,ntohl(hdr->totlen));
}

1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255
/* -----------------------------------------------------------------------------
 * CLUSTER Pub/Sub support
 *
 * For now we do very little, just propagating PUBLISH messages across the whole
 * cluster. In the future we'll try to get smarter and avoiding propagating those
 * messages to hosts without receives for a given channel.
 * -------------------------------------------------------------------------- */
void clusterPropagatePublish(robj *channel, robj *message) {
    clusterSendPublish(NULL, channel, message);
}

1256 1257 1258 1259
/* -----------------------------------------------------------------------------
 * SLAVE node specific functions
 * -------------------------------------------------------------------------- */

1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276
/* This function sends a FAILOVE_AUTH_REQUEST message to every node in order to
 * see if there is the quorum for this slave instance to failover its failing
 * master.
 *
 * Note that we send the failover request to everybody, master and slave nodes,
 * but only the masters are supposed to reply to our query. */
void clusterRequestFailoverAuth(void) {
    unsigned char buf[4096], *payload;
    clusterMsg *hdr = (clusterMsg*) buf;
    uint32_t totlen;

    clusterBuildMessageHdr(hdr,CLUSTERMSG_TYPE_FAILOVER_AUTH_REQUEST);
    totlen = sizeof(clusterMsg)-sizeof(union clusterMsgData);
    hdr->totlen = htonl(totlen);
    clusterBroadcastMessage(payload,totlen);
}

1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289
/* Send a FAILOVER_AUTH_ACK message to the specified node. */
void clusterSendFailoverAuth(clusterNode *node) {
    unsigned char buf[4096], *payload;
    clusterMsg *hdr = (clusterMsg*) buf;
    uint32_t totlen;

    if (!node->link) return;
    clusterBuildMessageHdr(hdr,CLUSTERMSG_TYPE_FAILOVER_AUTH_ACK);
    totlen = sizeof(clusterMsg)-sizeof(union clusterMsgData);
    hdr->totlen = htonl(totlen);
    clusterSendMessage(node->link,payload,totlen);
}

1290
/* If we believe 'node' is the "first slave" of it's master, reply with
1291 1292 1293 1294 1295
 * a FAILOVER_AUTH_GRANTED packet.
 *
 * To be a first slave the sender must:
 * 1) Be a slave.
 * 2) Its master should be in FAIL state.
1296 1297
 * 3) Ordering all the slaves IDs for its master by run-id, it should be the
 *    first (the smallest) among the ones not in FAIL / PFAIL state.
1298
 */
1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323
void clusterSendFailoverAuthIfNeeded(clusterNode *node) {
    char first[REDIS_CLUSTER_NAMELEN];
    clusterNode *master = node->slaveof;
    int j;

    /* Node is a slave? Its master is down? */
    if (!(node->flags & REDIS_NODE_SLAVE) ||
        master == NULL ||
        !(master->flags & REDIS_NODE_FAIL)) return;

    /* Iterate all the master slaves to check what's the first one. */
    memset(first,0xff,sizeof(first));
    for (j = 0; j < master->numslaves; j++) {
        clusterNode *slave = master->slaves[j];

        if (slave->flags & (REDIS_NODE_FAIL|REDIS_NODE_PFAIL)) continue;
        if (memcmp(slave->name,first,sizeof(first)) < 0) {
            memcpy(first,slave->name,sizeof(first));
        }
    }

    /* Is 'node' the first slave? */
    if (memcmp(node->name,first,sizeof(first)) != 0) return;

    /* We can send the packet. */
1324
    clusterSendFailoverAuth(node);
1325 1326
}

1327 1328 1329 1330 1331 1332 1333 1334 1335 1336
/* This function is called if we are a slave node and our master serving
 * a non-zero amount of hash slots is in PFAIL state.
 *
 * The gaol of this function is:
 * 1) To check if we are able to perform a failover, is our data updated?
 * 2) Ask reachable masters the authorization to perform the failover.
 * 3) Check if there is the majority of masters agreeing we should failover.
 * 4) Perform the failover informing all the other nodes.
 */
void clusterHandleSlaveFailover(void) {
1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363
    time_t data_age = server.unixtime - server.repl_down_since;
    time_t auth_age = server.unixtime - server.cluster->failover_auth_time;
    int needed_quorum = (server.cluster->size / 2) + 1;

    /* Check if our data is recent enough. For now we just use a fixed
     * constant of ten times the node timeout since the cluster should
     * react much faster to a master down. */
    if (data_age > server.cluster->node_timeout * 10) return;

    /* TODO: check if we are the first slave as well? Or just rely on the
     * master authorization? */

    /* Ask masters if we are authorized to perform the failover. If there
     * is a pending auth request that's too old, reset it. */
    if (server.cluster->failover_auth_time == 0 || auth_age > 15) {
        server.cluster->failover_auth_time = time(NULL);
        server.cluster->failover_auth_count = 0;

        /* TODO: Broadcast the AUTH request. */
        return; /* Wait for replies. */
    }

    /* Check if we reached the quorum. */
    if (server.cluster->failover_auth_count > needed_quorum) {
        /* TODO: Perform election. */
        /* TODO: Broadcast update to cluster. */
    }
1364 1365
}

A
antirez 已提交
1366 1367 1368 1369 1370 1371 1372 1373
/* -----------------------------------------------------------------------------
 * CLUSTER cron job
 * -------------------------------------------------------------------------- */

/* This is executed 1 time every second */
void clusterCron(void) {
    dictIterator *di;
    dictEntry *de;
1374
    int j, update_state = 0;
A
antirez 已提交
1375 1376 1377
    time_t min_ping_sent = 0;
    clusterNode *min_ping_node = NULL;

G
guiquanz 已提交
1378
    /* Check if we have disconnected nodes and re-establish the connection. */
1379
    di = dictGetIterator(server.cluster->nodes);
A
antirez 已提交
1380
    while((de = dictNext(di)) != NULL) {
1381
        clusterNode *node = dictGetVal(de);
A
antirez 已提交
1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406

        if (node->flags & (REDIS_NODE_MYSELF|REDIS_NODE_NOADDR)) continue;
        if (node->link == NULL) {
            int fd;
            clusterLink *link;

            fd = anetTcpNonBlockConnect(server.neterr, node->ip,
                node->port+REDIS_CLUSTER_PORT_INCR);
            if (fd == -1) continue;
            link = createClusterLink(node);
            link->fd = fd;
            node->link = link;
            aeCreateFileEvent(server.el,link->fd,AE_READABLE,clusterReadHandler,link);
            /* If the node is flagged as MEET, we send a MEET message instead
             * of a PING one, to force the receiver to add us in its node
             * table. */
            clusterSendPing(link, node->flags & REDIS_NODE_MEET ?
                    CLUSTERMSG_TYPE_MEET : CLUSTERMSG_TYPE_PING);
            /* We can clear the flag after the first packet is sent.
             * If we'll never receive a PONG, we'll never send new packets
             * to this node. Instead after the PONG is received and we
             * are no longer in meet/handshake status, we want to send
             * normal PING packets. */
            node->flags &= ~REDIS_NODE_MEET;

1407
            redisLog(REDIS_DEBUG,"Connecting with Node %.40s at %s:%d", node->name, node->ip, node->port+REDIS_CLUSTER_PORT_INCR);
A
antirez 已提交
1408 1409 1410 1411 1412 1413 1414
        }
    }
    dictReleaseIterator(di);

    /* Ping some random node. Check a few random nodes and ping the one with
     * the oldest ping_sent time */
    for (j = 0; j < 5; j++) {
1415
        de = dictGetRandomKey(server.cluster->nodes);
1416
        clusterNode *this = dictGetVal(de);
A
antirez 已提交
1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430

        if (this->link == NULL) continue;
        if (this->flags & (REDIS_NODE_MYSELF|REDIS_NODE_HANDSHAKE)) continue;
        if (min_ping_node == NULL || min_ping_sent > this->ping_sent) {
            min_ping_node = this;
            min_ping_sent = this->ping_sent;
        }
    }
    if (min_ping_node) {
        redisLog(REDIS_DEBUG,"Pinging node %40s", min_ping_node->name);
        clusterSendPing(min_ping_node->link, CLUSTERMSG_TYPE_PING);
    }

    /* Iterate nodes to check if we need to flag something as failing */
1431
    di = dictGetIterator(server.cluster->nodes);
A
antirez 已提交
1432
    while((de = dictNext(di)) != NULL) {
1433
        clusterNode *node = dictGetVal(de);
1434
        time_t now = time(NULL);
A
antirez 已提交
1435 1436 1437
        int delay;

        if (node->flags &
1438 1439
            (REDIS_NODE_MYSELF|REDIS_NODE_NOADDR|REDIS_NODE_HANDSHAKE))
                continue;
1440

A
antirez 已提交
1441 1442 1443 1444 1445
        /* Check only if we already sent a ping and did not received
         * a reply yet. */
        if (node->ping_sent == 0 ||
            node->ping_sent <= node->pong_received) continue;

1446 1447 1448 1449 1450 1451 1452 1453 1454
        /* If our ping is older than half the cluster timeout (may happen
         * in a cluster with many nodes), send a new ping. */
        if (node->link &&
            (now - node->ping_sent) > server.cluster->node_timeout/2)
        {
            clusterSendPing(node->link, CLUSTERMSG_TYPE_PING);
            continue;
        }

1455 1456 1457
        /* If we never received a pong, use the ping time to compute
         * the delay. */
        if (node->pong_received) {
1458
            delay = now - node->pong_received;
1459
        } else {
1460
            delay = now - node->ping_sent;
1461 1462
        }

1463
        if (delay < server.cluster->node_timeout) {
A
antirez 已提交
1464 1465
            /* The PFAIL condition can be reversed without external
             * help if it is not transitive (that is, if it does not
1466 1467
             * turn into a FAIL state).
             *
1468 1469
             * The FAIL condition is also reversible under specific
             * conditions detected by clearNodeFailureIfNeeded(). */
1470
            if (node->flags & REDIS_NODE_PFAIL) {
A
antirez 已提交
1471
                node->flags &= ~REDIS_NODE_PFAIL;
1472
                update_state = 1;
1473 1474
            } else if (node->flags & REDIS_NODE_FAIL) {
                clearNodeFailureIfNeeded(node);
1475
            }
A
antirez 已提交
1476
        } else {
G
guiquanz 已提交
1477
            /* Timeout reached. Set the node as possibly failing if it is
1478
             * not already in this state. */
1479
            if (!(node->flags & (REDIS_NODE_PFAIL|REDIS_NODE_FAIL))) {
A
antirez 已提交
1480 1481 1482
                redisLog(REDIS_DEBUG,"*** NODE %.40s possibly failing",
                    node->name);
                node->flags |= REDIS_NODE_PFAIL;
1483
                update_state = 1;
A
antirez 已提交
1484 1485 1486 1487
            }
        }
    }
    dictReleaseIterator(di);
1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499

    /* If we are a slave node but the replication is still turned off,
     * enable it if we know the address of our master and it appears to
     * be up. */
    if (server.cluster->myself->flags & REDIS_NODE_SLAVE &&
        server.masterhost == NULL &&
        server.cluster->myself->slaveof &&
        !(server.cluster->myself->slaveof->flags & REDIS_NODE_NOADDR))
    {
        replicationSetMaster(server.cluster->myself->slaveof->ip,
                             server.cluster->myself->slaveof->port);
    }
1500

1501 1502 1503 1504 1505 1506 1507 1508 1509 1510
    /* If we are a slave and our master is down, but is serving slots,
     * call the function that handles the failover. */
    if (server.cluster->myself->flags & REDIS_NODE_SLAVE &&
        server.cluster->myself->slaveof &&
        server.cluster->myself->slaveof->flags & REDIS_NODE_FAIL &&
        server.cluster->myself->slaveof->numslots != 0)
    {
        clusterHandleSlaveFailover();
    }

1511
    if (update_state) clusterUpdateState();
A
antirez 已提交
1512 1513 1514 1515 1516 1517
}

/* -----------------------------------------------------------------------------
 * Slots management
 * -------------------------------------------------------------------------- */

1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539
/* Test bit 'pos' in a generic bitmap. Return 1 if the bit is zet,
 * otherwise 0. */
int bitmapTestBit(unsigned char *bitmap, int pos) {
    off_t byte = pos/8;
    int bit = pos&7;
    return (bitmap[byte] & (1<<bit)) != 0;
}

/* Set the bit at position 'pos' in a bitmap. */
void bitmapSetBit(unsigned char *bitmap, int pos) {
    off_t byte = pos/8;
    int bit = pos&7;
    bitmap[byte] |= 1<<bit;
}

/* Clear the bit at position 'pos' in a bitmap. */
void bitmapClearBit(unsigned char *bitmap, int pos) {
    off_t byte = pos/8;
    int bit = pos&7;
    bitmap[byte] &= ~(1<<bit);
}

A
antirez 已提交
1540 1541
/* Set the slot bit and return the old value. */
int clusterNodeSetSlotBit(clusterNode *n, int slot) {
1542 1543
    int old = bitmapTestBit(n->slots,slot);
    bitmapSetBit(n->slots,slot);
1544
    if (!old) n->numslots++;
A
antirez 已提交
1545 1546 1547 1548 1549
    return old;
}

/* Clear the slot bit and return the old value. */
int clusterNodeClearSlotBit(clusterNode *n, int slot) {
1550 1551
    int old = bitmapTestBit(n->slots,slot);
    bitmapClearBit(n->slots,slot);
1552
    if (old) n->numslots--;
A
antirez 已提交
1553 1554 1555 1556 1557
    return old;
}

/* Return the slot bit from the cluster node structure. */
int clusterNodeGetSlotBit(clusterNode *n, int slot) {
1558
    return bitmapTestBit(n->slots,slot);
A
antirez 已提交
1559 1560 1561 1562 1563 1564 1565
}

/* Add the specified slot to the list of slots that node 'n' will
 * serve. Return REDIS_OK if the operation ended with success.
 * If the slot is already assigned to another instance this is considered
 * an error and REDIS_ERR is returned. */
int clusterAddSlot(clusterNode *n, int slot) {
1566 1567
    if (server.cluster->slots[slot]) return REDIS_ERR;
    clusterNodeSetSlotBit(n,slot);
1568
    server.cluster->slots[slot] = n;
A
antirez 已提交
1569 1570 1571
    return REDIS_OK;
}

A
antirez 已提交
1572 1573 1574 1575
/* Delete the specified slot marking it as unassigned.
 * Returns REDIS_OK if the slot was assigned, otherwise if the slot was
 * already unassigned REDIS_ERR is returned. */
int clusterDelSlot(int slot) {
1576
    clusterNode *n = server.cluster->slots[slot];
A
antirez 已提交
1577 1578 1579

    if (!n) return REDIS_ERR;
    redisAssert(clusterNodeClearSlotBit(n,slot) == 1);
1580
    server.cluster->slots[slot] = NULL;
A
antirez 已提交
1581 1582 1583
    return REDIS_OK;
}

A
antirez 已提交
1584 1585 1586 1587
/* -----------------------------------------------------------------------------
 * Cluster state evaluation function
 * -------------------------------------------------------------------------- */
void clusterUpdateState(void) {
1588
    int j, initial_state = server.cluster->state;
1589
    int unreachable_masters = 0;
A
antirez 已提交
1590

1591 1592 1593 1594
    /* Start assuming the state is OK. We'll turn it into FAIL if there
     * are the right conditions. */
    server.cluster->state = REDIS_CLUSTER_OK;

1595
    /* Check if all the slots are covered. */
A
antirez 已提交
1596
    for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
1597 1598
        if (server.cluster->slots[j] == NULL ||
            server.cluster->slots[j]->flags & (REDIS_NODE_FAIL))
A
antirez 已提交
1599
        {
1600
            server.cluster->state = REDIS_CLUSTER_FAIL;
A
antirez 已提交
1601 1602 1603
            break;
        }
    }
1604

1605
    /* Compute the cluster size, that is the number of master nodes
1606 1607 1608 1609
     * serving at least a single slot.
     *
     * At the same time count the number of unreachable masters with
     * at least one node. */
1610 1611 1612 1613 1614 1615 1616 1617 1618
    {
        dictIterator *di;
        dictEntry *de;

        server.cluster->size = 0;
        di = dictGetIterator(server.cluster->nodes);
        while((de = dictNext(di)) != NULL) {
            clusterNode *node = dictGetVal(de);

1619
            if (node->flags & REDIS_NODE_MASTER && node->numslots) {
1620
                server.cluster->size++;
1621 1622 1623
                if (node->flags & (REDIS_NODE_FAIL|REDIS_NODE_PFAIL))
                    unreachable_masters++;
            }
1624 1625 1626
        }
        dictReleaseIterator(di);
    }
1627

1628 1629 1630 1631 1632 1633 1634 1635 1636 1637
    /* If we can't reach at least half the masters, change the cluster state
     * as FAIL, as we are not even able to mark nodes as FAIL in this side
     * of the netsplit because of lack of majority. */
    {
        int needed_quorum = (server.cluster->size / 2) + 1;
        
        if (unreachable_masters >= needed_quorum)
            server.cluster->state = REDIS_CLUSTER_FAIL;
    }

1638 1639 1640 1641
    /* Log a state change */
    if (initial_state != server.cluster->state)
        redisLog(REDIS_WARNING,"Cluster state changed: %s",
            server.cluster->state == REDIS_CLUSTER_OK ? "ok" : "fail");
A
antirez 已提交
1642 1643
}

1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666
/* This function is called after the node startup in order to verify that data
 * loaded from disk is in agreement with the cluster configuration:
 *
 * 1) If we find keys about hash slots we have no responsibility for, the
 *    following happens:
 *    A) If no other node is in charge according to the current cluster
 *       configuration, we add these slots to our node.
 *    B) If according to our config other nodes are already in charge for
 *       this lots, we set the slots as IMPORTING from our point of view
 *       in order to justify we have those slots, and in order to make
 *       redis-trib aware of the issue, so that it can try to fix it.
 * 2) If we find data in a DB different than DB0 we return REDIS_ERR to
 *    signal the caller it should quit the server with an error message
 *    or take other actions.
 *
 * The function always returns REDIS_OK even if it will try to correct
 * the error described in "1". However if data is found in DB different
 * from DB0, REDIS_ERR is returned.
 *
 * The function also uses the logging facility in order to warn the user
 * about desynchronizations between the data we have in memory and the
 * cluster configuration. */
int verifyClusterConfigWithData(void) {
1667 1668 1669
    int j;
    int update_config = 0;

1670 1671 1672 1673
    /* If this node is a slave, don't perform the check at all as we
     * completely depend on the replication stream. */
    if (server.cluster->myself->flags & REDIS_NODE_SLAVE) return REDIS_OK;

1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707
    /* Make sure we only have keys in DB0. */
    for (j = 1; j < server.dbnum; j++) {
        if (dictSize(server.db[j].dict)) return REDIS_ERR;
    }

    /* Check that all the slots we see populated memory have a corresponding
     * entry in the cluster table. Otherwise fix the table. */
    for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
        if (!countKeysInSlot(j)) continue; /* No keys in this slot. */
        /* Check if we are assigned to this slot or if we are importing it.
         * In both cases check the next slot as the configuration makes
         * sense. */
        if (server.cluster->slots[j] == server.cluster->myself ||
            server.cluster->importing_slots_from[j] != NULL) continue;

        /* If we are here data and cluster config don't agree, and we have
         * slot 'j' populated even if we are not importing it, nor we are
         * assigned to this slot. Fix this condition. */

        update_config++;
        /* Case A: slot is unassigned. Take responsability for it. */
        if (server.cluster->slots[j] == NULL) {
            redisLog(REDIS_WARNING, "I've keys about slot %d that is "
                                    "unassigned. Taking responsability "
                                    "for it.",j);
            clusterAddSlot(server.cluster->myself,j);
        } else {
            redisLog(REDIS_WARNING, "I've keys about slot %d that is "
                                    "already assigned to a different node. "
                                    "Setting it in importing state.",j);
            server.cluster->importing_slots_from[j] = server.cluster->slots[j];
        }
    }
    if (update_config) clusterSaveConfigOrDie();
1708 1709 1710
    return REDIS_OK;
}

1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725
/* -----------------------------------------------------------------------------
 * SLAVE nodes handling
 * -------------------------------------------------------------------------- */

/* Set the specified node 'n' as master. */
void clusterSetMaster(clusterNode *n) {
    clusterNode *myself = server.cluster->myself;

    redisAssert(n != myself);

    if (myself->flags & REDIS_NODE_MASTER) {
        myself->flags &= ~REDIS_NODE_MASTER;
        myself->flags |= REDIS_NODE_SLAVE;
    }
    myself->slaveof = n;
1726
    replicationSetMaster(n->ip, n->port);
1727 1728
}

A
antirez 已提交
1729 1730 1731 1732
/* -----------------------------------------------------------------------------
 * CLUSTER command
 * -------------------------------------------------------------------------- */

A
antirez 已提交
1733 1734 1735 1736
sds clusterGenNodesDescription(void) {
    sds ci = sdsempty();
    dictIterator *di;
    dictEntry *de;
1737
    int j, start;
A
antirez 已提交
1738

1739
    di = dictGetIterator(server.cluster->nodes);
A
antirez 已提交
1740
    while((de = dictNext(di)) != NULL) {
1741
        clusterNode *node = dictGetVal(de);
A
antirez 已提交
1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766

        /* Node coordinates */
        ci = sdscatprintf(ci,"%.40s %s:%d ",
            node->name,
            node->ip,
            node->port);

        /* Flags */
        if (node->flags == 0) ci = sdscat(ci,"noflags,");
        if (node->flags & REDIS_NODE_MYSELF) ci = sdscat(ci,"myself,");
        if (node->flags & REDIS_NODE_MASTER) ci = sdscat(ci,"master,");
        if (node->flags & REDIS_NODE_SLAVE) ci = sdscat(ci,"slave,");
        if (node->flags & REDIS_NODE_PFAIL) ci = sdscat(ci,"fail?,");
        if (node->flags & REDIS_NODE_FAIL) ci = sdscat(ci,"fail,");
        if (node->flags & REDIS_NODE_HANDSHAKE) ci =sdscat(ci,"handshake,");
        if (node->flags & REDIS_NODE_NOADDR) ci = sdscat(ci,"noaddr,");
        if (ci[sdslen(ci)-1] == ',') ci[sdslen(ci)-1] = ' ';

        /* Slave of... or just "-" */
        if (node->slaveof)
            ci = sdscatprintf(ci,"%.40s ",node->slaveof->name);
        else
            ci = sdscatprintf(ci,"- ");

        /* Latency from the POV of this node, link status */
1767
        ci = sdscatprintf(ci,"%ld %ld %s",
A
antirez 已提交
1768 1769
            (long) node->ping_sent,
            (long) node->pong_received,
1770 1771
            (node->link || node->flags & REDIS_NODE_MYSELF) ?
                        "connected" : "disconnected");
1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791

        /* Slots served by this instance */
        start = -1;
        for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
            int bit;

            if ((bit = clusterNodeGetSlotBit(node,j)) != 0) {
                if (start == -1) start = j;
            }
            if (start != -1 && (!bit || j == REDIS_CLUSTER_SLOTS-1)) {
                if (j == REDIS_CLUSTER_SLOTS-1) j++;

                if (start == j-1) {
                    ci = sdscatprintf(ci," %d",start);
                } else {
                    ci = sdscatprintf(ci," %d-%d",start,j-1);
                }
                start = -1;
            }
        }
1792 1793 1794 1795 1796 1797

        /* Just for MYSELF node we also dump info about slots that
         * we are migrating to other instances or importing from other
         * instances. */
        if (node->flags & REDIS_NODE_MYSELF) {
            for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
1798
                if (server.cluster->migrating_slots_to[j]) {
A
antirez 已提交
1799
                    ci = sdscatprintf(ci," [%d->-%.40s]",j,
1800 1801
                        server.cluster->migrating_slots_to[j]->name);
                } else if (server.cluster->importing_slots_from[j]) {
A
antirez 已提交
1802
                    ci = sdscatprintf(ci," [%d-<-%.40s]",j,
1803
                        server.cluster->importing_slots_from[j]->name);
1804 1805 1806
                }
            }
        }
1807
        ci = sdscatlen(ci,"\n",1);
A
antirez 已提交
1808 1809 1810 1811 1812
    }
    dictReleaseIterator(di);
    return ci;
}

1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824
int getSlotOrReply(redisClient *c, robj *o) {
    long long slot;

    if (getLongLongFromObject(o,&slot) != REDIS_OK ||
        slot < 0 || slot > REDIS_CLUSTER_SLOTS)
    {
        addReplyError(c,"Invalid or out of range slot");
        return -1;
    }
    return (int) slot;
}

A
antirez 已提交
1825 1826 1827 1828 1829 1830 1831
void clusterCommand(redisClient *c) {
    if (server.cluster_enabled == 0) {
        addReplyError(c,"This instance has cluster support disabled");
        return;
    }

    if (!strcasecmp(c->argv[1]->ptr,"meet") && c->argc == 4) {
1832
        /* CLUSTER MEET <ip> <port> */
A
antirez 已提交
1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856
        clusterNode *n;
        struct sockaddr_in sa;
        long port;

        /* Perform sanity checks on IP/port */
        if (inet_aton(c->argv[2]->ptr,&sa.sin_addr) == 0) {
            addReplyError(c,"Invalid IP address in MEET");
            return;
        }
        if (getLongFromObjectOrReply(c, c->argv[3], &port, NULL) != REDIS_OK ||
                    port < 0 || port > (65535-REDIS_CLUSTER_PORT_INCR))
        {
            addReplyError(c,"Invalid TCP port specified");
            return;
        }

        /* Finally add the node to the cluster with a random name, this 
         * will get fixed in the first handshake (ping/pong). */
        n = createClusterNode(NULL,REDIS_NODE_HANDSHAKE|REDIS_NODE_MEET);
        strncpy(n->ip,inet_ntoa(sa.sin_addr),sizeof(n->ip));
        n->port = port;
        clusterAddNode(n);
        addReply(c,shared.ok);
    } else if (!strcasecmp(c->argv[1]->ptr,"nodes") && c->argc == 2) {
1857
        /* CLUSTER NODES */
A
antirez 已提交
1858
        robj *o;
A
antirez 已提交
1859
        sds ci = clusterGenNodesDescription();
A
antirez 已提交
1860 1861 1862 1863

        o = createObject(REDIS_STRING,ci);
        addReplyBulk(c,o);
        decrRefCount(o);
A
antirez 已提交
1864
    } else if ((!strcasecmp(c->argv[1]->ptr,"addslots") ||
A
antirez 已提交
1865 1866 1867 1868
               !strcasecmp(c->argv[1]->ptr,"delslots")) && c->argc >= 3)
    {
        /* CLUSTER ADDSLOTS <slot> [slot] ... */
        /* CLUSTER DELSLOTS <slot> [slot] ... */
1869
        int j, slot;
A
antirez 已提交
1870
        unsigned char *slots = zmalloc(REDIS_CLUSTER_SLOTS);
A
antirez 已提交
1871
        int del = !strcasecmp(c->argv[1]->ptr,"delslots");
A
antirez 已提交
1872 1873 1874 1875 1876

        memset(slots,0,REDIS_CLUSTER_SLOTS);
        /* Check that all the arguments are parsable and that all the
         * slots are not already busy. */
        for (j = 2; j < c->argc; j++) {
1877
            if ((slot = getSlotOrReply(c,c->argv[j])) == -1) {
A
antirez 已提交
1878 1879 1880
                zfree(slots);
                return;
            }
1881
            if (del && server.cluster->slots[slot] == NULL) {
1882
                addReplyErrorFormat(c,"Slot %d is already unassigned", slot);
A
antirez 已提交
1883 1884
                zfree(slots);
                return;
1885
            } else if (!del && server.cluster->slots[slot]) {
1886
                addReplyErrorFormat(c,"Slot %d is already busy", slot);
A
antirez 已提交
1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898
                zfree(slots);
                return;
            }
            if (slots[slot]++ == 1) {
                addReplyErrorFormat(c,"Slot %d specified multiple times",
                    (int)slot);
                zfree(slots);
                return;
            }
        }
        for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
            if (slots[j]) {
1899 1900 1901 1902
                int retval;

                /* If this slot was set as importing we can clear this 
                 * state as now we are the real owner of the slot. */
1903 1904
                if (server.cluster->importing_slots_from[j])
                    server.cluster->importing_slots_from[j] = NULL;
1905 1906

                retval = del ? clusterDelSlot(j) :
1907
                               clusterAddSlot(server.cluster->myself,j);
1908
                redisAssertWithInfo(c,NULL,retval == REDIS_OK);
A
antirez 已提交
1909 1910 1911 1912
            }
        }
        zfree(slots);
        clusterUpdateState();
A
antirez 已提交
1913
        clusterSaveConfigOrDie();
A
antirez 已提交
1914
        addReply(c,shared.ok);
1915
    } else if (!strcasecmp(c->argv[1]->ptr,"setslot") && c->argc >= 4) {
A
antirez 已提交
1916 1917
        /* SETSLOT 10 MIGRATING <node ID> */
        /* SETSLOT 10 IMPORTING <node ID> */
1918
        /* SETSLOT 10 STABLE */
A
antirez 已提交
1919
        /* SETSLOT 10 NODE <node ID> */
1920
        int slot;
1921 1922
        clusterNode *n;

1923 1924
        if ((slot = getSlotOrReply(c,c->argv[2])) == -1) return;

1925
        if (!strcasecmp(c->argv[3]->ptr,"migrating") && c->argc == 5) {
1926
            if (server.cluster->slots[slot] != server.cluster->myself) {
1927 1928 1929
                addReplyErrorFormat(c,"I'm not the owner of hash slot %u",slot);
                return;
            }
1930 1931 1932 1933 1934
            if ((n = clusterLookupNode(c->argv[4]->ptr)) == NULL) {
                addReplyErrorFormat(c,"I don't know about node %s",
                    (char*)c->argv[4]->ptr);
                return;
            }
1935
            server.cluster->migrating_slots_to[slot] = n;
1936
        } else if (!strcasecmp(c->argv[3]->ptr,"importing") && c->argc == 5) {
1937
            if (server.cluster->slots[slot] == server.cluster->myself) {
1938 1939 1940 1941
                addReplyErrorFormat(c,
                    "I'm already the owner of hash slot %u",slot);
                return;
            }
1942 1943 1944 1945 1946
            if ((n = clusterLookupNode(c->argv[4]->ptr)) == NULL) {
                addReplyErrorFormat(c,"I don't know about node %s",
                    (char*)c->argv[3]->ptr);
                return;
            }
1947
            server.cluster->importing_slots_from[slot] = n;
1948
        } else if (!strcasecmp(c->argv[3]->ptr,"stable") && c->argc == 4) {
1949
            /* CLUSTER SETSLOT <SLOT> STABLE */
1950 1951
            server.cluster->importing_slots_from[slot] = NULL;
            server.cluster->migrating_slots_to[slot] = NULL;
1952
        } else if (!strcasecmp(c->argv[3]->ptr,"node") && c->argc == 5) {
1953 1954 1955
            /* CLUSTER SETSLOT <SLOT> NODE <NODE ID> */
            clusterNode *n = clusterLookupNode(c->argv[4]->ptr);

1956 1957 1958 1959 1960
            if (!n) {
                addReplyErrorFormat(c,"Unknown node %s",
                    (char*)c->argv[4]->ptr);
                return;
            }
1961 1962
            /* If this hash slot was served by 'myself' before to switch
             * make sure there are no longer local keys for this hash slot. */
1963 1964
            if (server.cluster->slots[slot] == server.cluster->myself &&
                n != server.cluster->myself)
1965
            {
1966
                if (countKeysInSlot(slot) != 0) {
1967 1968 1969 1970
                    addReplyErrorFormat(c, "Can't assign hashslot %d to a different node while I still hold keys for this hash slot.", slot);
                    return;
                }
            }
1971 1972 1973
            /* If this node was the slot owner and the slot was marked as
             * migrating, assigning the slot to another node will clear
             * the migratig status. */
1974 1975 1976
            if (server.cluster->slots[slot] == server.cluster->myself &&
                server.cluster->migrating_slots_to[slot])
                server.cluster->migrating_slots_to[slot] = NULL;
1977

1978 1979
            /* If this node was importing this slot, assigning the slot to
             * itself also clears the importing status. */
1980 1981
            if (n == server.cluster->myself &&
                server.cluster->importing_slots_from[slot])
1982
                server.cluster->importing_slots_from[slot] = NULL;
1983 1984
            clusterDelSlot(slot);
            clusterAddSlot(n,slot);
1985 1986
        } else {
            addReplyError(c,"Invalid CLUSTER SETSLOT action or number of arguments");
1987
            return;
1988
        }
1989
        clusterUpdateState();
A
antirez 已提交
1990
        clusterSaveConfigOrDie();
1991
        addReply(c,shared.ok);
A
antirez 已提交
1992
    } else if (!strcasecmp(c->argv[1]->ptr,"info") && c->argc == 2) {
1993
        /* CLUSTER INFO */
A
antirez 已提交
1994 1995 1996 1997 1998
        char *statestr[] = {"ok","fail","needhelp"};
        int slots_assigned = 0, slots_ok = 0, slots_pfail = 0, slots_fail = 0;
        int j;

        for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
1999
            clusterNode *n = server.cluster->slots[j];
A
antirez 已提交
2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017

            if (n == NULL) continue;
            slots_assigned++;
            if (n->flags & REDIS_NODE_FAIL) {
                slots_fail++;
            } else if (n->flags & REDIS_NODE_PFAIL) {
                slots_pfail++;
            } else {
                slots_ok++;
            }
        }

        sds info = sdscatprintf(sdsempty(),
            "cluster_state:%s\r\n"
            "cluster_slots_assigned:%d\r\n"
            "cluster_slots_ok:%d\r\n"
            "cluster_slots_pfail:%d\r\n"
            "cluster_slots_fail:%d\r\n"
2018
            "cluster_known_nodes:%lu\r\n"
2019
            "cluster_size:%d\r\n"
2020
            , statestr[server.cluster->state],
A
antirez 已提交
2021 2022 2023
            slots_assigned,
            slots_ok,
            slots_pfail,
2024
            slots_fail,
2025 2026
            dictSize(server.cluster->nodes),
            server.cluster->size
A
antirez 已提交
2027 2028 2029 2030 2031
        );
        addReplySds(c,sdscatprintf(sdsempty(),"$%lu\r\n",
            (unsigned long)sdslen(info)));
        addReplySds(c,info);
        addReply(c,shared.crlf);
A
antirez 已提交
2032
    } else if (!strcasecmp(c->argv[1]->ptr,"keyslot") && c->argc == 3) {
2033
        /* CLUSTER KEYSLOT <key> */
A
antirez 已提交
2034 2035 2036
        sds key = c->argv[2]->ptr;

        addReplyLongLong(c,keyHashSlot(key,sdslen(key)));
2037
    } else if (!strcasecmp(c->argv[1]->ptr,"countkeysinslot") && c->argc == 3) {
2038
        /* CLUSTER COUNTKEYSINSLOT <slot> */
2039 2040 2041 2042
        long long slot;

        if (getLongLongFromObjectOrReply(c,c->argv[2],&slot,NULL) != REDIS_OK)
            return;
2043 2044 2045 2046
        if (slot < 0 || slot >= REDIS_CLUSTER_SLOTS) {
            addReplyError(c,"Invalid slot");
            return;
        }
2047
        addReplyLongLong(c,countKeysInSlot(slot));
A
antirez 已提交
2048
    } else if (!strcasecmp(c->argv[1]->ptr,"getkeysinslot") && c->argc == 4) {
2049
        /* CLUSTER GETKEYSINSLOT <slot> <count> */
A
antirez 已提交
2050
        long long maxkeys, slot;
2051
        unsigned int numkeys, j;
A
antirez 已提交
2052 2053 2054 2055 2056 2057
        robj **keys;

        if (getLongLongFromObjectOrReply(c,c->argv[2],&slot,NULL) != REDIS_OK)
            return;
        if (getLongLongFromObjectOrReply(c,c->argv[3],&maxkeys,NULL) != REDIS_OK)
            return;
2058
        if (slot < 0 || slot >= REDIS_CLUSTER_SLOTS || maxkeys < 0) {
A
antirez 已提交
2059 2060 2061 2062 2063
            addReplyError(c,"Invalid slot or number of keys");
            return;
        }

        keys = zmalloc(sizeof(robj*)*maxkeys);
2064
        numkeys = getKeysInSlot(slot, keys, maxkeys);
A
antirez 已提交
2065 2066 2067
        addReplyMultiBulkLen(c,numkeys);
        for (j = 0; j < numkeys; j++) addReplyBulk(c,keys[j]);
        zfree(keys);
A
antirez 已提交
2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079
    } else if (!strcasecmp(c->argv[1]->ptr,"forget") && c->argc == 3) {
        /* CLUSTER FORGET <NODE ID> */
        clusterNode *n = clusterLookupNode(c->argv[2]->ptr);

        if (!n) {
            addReplyErrorFormat(c,"Unknown node %s", (char*)c->argv[2]->ptr);
            return;
        }
        clusterDelNode(n);
        clusterUpdateState();
        clusterSaveConfigOrDie();
        addReply(c,shared.ok);
2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112
    } else if (!strcasecmp(c->argv[1]->ptr,"replicate") && c->argc == 3) {
        /* CLUSTER REPLICATE <NODE ID> */
        clusterNode *n = clusterLookupNode(c->argv[2]->ptr);

        /* Lookup the specified node in our table. */
        if (!n) {
            addReplyErrorFormat(c,"Unknown node %s", (char*)c->argv[2]->ptr);
            return;
        }

        /* I can't replicate myself. */
        if (n == server.cluster->myself) {
            addReplyError(c,"Can't replicate myself");
            return;
        }

        /* Can't replicate a slave. */
        if (n->slaveof != NULL) {
            addReplyError(c,"I can only replicate a master, not a slave.");
            return;
        }

        /* We should have no assigned slots to accept to replicate some
         * other node. */
        if (server.cluster->myself->numslots != 0 ||
            dictSize(server.db[0].dict) != 0)
        {
            addReplyError(c,"To set a master the node must be empty and without assigned slots.");
            return;
        }

        /* Set the master. */
        clusterSetMaster(n);
2113 2114
        clusterUpdateState();
        clusterSaveConfigOrDie();
2115
        addReply(c,shared.ok);
A
antirez 已提交
2116 2117 2118 2119 2120 2121
    } else {
        addReplyError(c,"Wrong CLUSTER subcommand or number of arguments");
    }
}

/* -----------------------------------------------------------------------------
2122
 * DUMP, RESTORE and MIGRATE commands
A
antirez 已提交
2123 2124
 * -------------------------------------------------------------------------- */

2125 2126 2127
/* Generates a DUMP-format representation of the object 'o', adding it to the
 * io stream pointed by 'rio'. This function can't fail. */
void createDumpPayload(rio *payload, robj *o) {
2128 2129
    unsigned char buf[2];
    uint64_t crc;
2130 2131 2132 2133 2134 2135 2136 2137

    /* Serialize the object in a RDB-like format. It consist of an object type
     * byte followed by the serialized object. This is understood by RESTORE. */
    rioInitWithBuffer(payload,sdsempty());
    redisAssert(rdbSaveObjectType(payload,o));
    redisAssert(rdbSaveObject(payload,o));

    /* Write the footer, this is how it looks like:
2138 2139 2140 2141 2142
     * ----------------+---------------------+---------------+
     * ... RDB payload | 2 bytes RDB version | 8 bytes CRC64 |
     * ----------------+---------------------+---------------+
     * RDB version and CRC are both in little endian.
     */
2143 2144

    /* RDB version */
2145 2146
    buf[0] = REDIS_RDB_VERSION & 0xff;
    buf[1] = (REDIS_RDB_VERSION >> 8) & 0xff;
2147 2148
    payload->io.buffer.ptr = sdscatlen(payload->io.buffer.ptr,buf,2);

2149
    /* CRC64 */
2150
    crc = crc64(0,(unsigned char*)payload->io.buffer.ptr,
2151 2152 2153
                sdslen(payload->io.buffer.ptr));
    memrev64ifbe(&crc);
    payload->io.buffer.ptr = sdscatlen(payload->io.buffer.ptr,&crc,8);
2154 2155 2156
}

/* Verify that the RDB version of the dump payload matches the one of this Redis
2157
 * instance and that the checksum is ok.
2158 2159 2160
 * If the DUMP payload looks valid REDIS_OK is returned, otherwise REDIS_ERR
 * is returned. */
int verifyDumpPayload(unsigned char *p, size_t len) {
2161
    unsigned char *footer;
2162
    uint16_t rdbver;
2163
    uint64_t crc;
2164

2165
    /* At least 2 bytes of RDB version and 8 of CRC64 should be present. */
2166 2167
    if (len < 10) return REDIS_ERR;
    footer = p+(len-10);
2168 2169

    /* Verify RDB version */
2170
    rdbver = (footer[1] << 8) | footer[0];
2171
    if (rdbver != REDIS_RDB_VERSION) return REDIS_ERR;
2172

2173
    /* Verify CRC64 */
2174
    crc = crc64(0,p,len-8);
2175 2176
    memrev64ifbe(&crc);
    return (memcmp(&crc,footer+2,8) == 0) ? REDIS_OK : REDIS_ERR;
2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201
}

/* DUMP keyname
 * DUMP is actually not used by Redis Cluster but it is the obvious
 * complement of RESTORE and can be useful for different applications. */
void dumpCommand(redisClient *c) {
    robj *o, *dumpobj;
    rio payload;

    /* Check if the key is here. */
    if ((o = lookupKeyRead(c->db,c->argv[1])) == NULL) {
        addReply(c,shared.nullbulk);
        return;
    }

    /* Create the DUMP encoded representation. */
    createDumpPayload(&payload,o);

    /* Transfer to the client */
    dumpobj = createObject(REDIS_STRING,payload.io.buffer.ptr);
    addReplyBulk(c,dumpobj);
    decrRefCount(dumpobj);
    return;
}

A
antirez 已提交
2202
/* RESTORE key ttl serialized-value [REPLACE] */
A
antirez 已提交
2203 2204
void restoreCommand(redisClient *c) {
    long ttl;
2205
    rio payload;
A
antirez 已提交
2206
    int j, type, replace = 0;
2207
    robj *obj;
A
antirez 已提交
2208

A
antirez 已提交
2209 2210 2211 2212 2213 2214 2215 2216 2217 2218
    /* Parse additional options */
    for (j = 4; j < c->argc; j++) {
        if (!strcasecmp(c->argv[j]->ptr,"replace")) {
            replace = 1;
        } else {
            addReply(c,shared.syntaxerr);
            return;
        }
    }

A
antirez 已提交
2219
    /* Make sure this key does not already exist here... */
A
antirez 已提交
2220
    if (!replace && lookupKeyWrite(c->db,c->argv[1]) != NULL) {
A
antirez 已提交
2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232
        addReplyError(c,"Target key name is busy.");
        return;
    }

    /* Check if the TTL value makes sense */
    if (getLongFromObjectOrReply(c,c->argv[2],&ttl,NULL) != REDIS_OK) {
        return;
    } else if (ttl < 0) {
        addReplyError(c,"Invalid TTL value, must be >= 0");
        return;
    }

2233
    /* Verify RDB version and data checksum. */
2234 2235 2236 2237 2238
    if (verifyDumpPayload(c->argv[3]->ptr,sdslen(c->argv[3]->ptr)) == REDIS_ERR) {
        addReplyError(c,"DUMP payload version or checksum are wrong");
        return;
    }

2239
    rioInitWithBuffer(&payload,c->argv[3]->ptr);
2240 2241
    if (((type = rdbLoadObjectType(&payload)) == -1) ||
        ((obj = rdbLoadObject(type,&payload)) == NULL))
2242
    {
2243
        addReplyError(c,"Bad data format");
A
antirez 已提交
2244 2245 2246
        return;
    }

A
antirez 已提交
2247 2248 2249
    /* Remove the old key if needed. */
    if (replace) dbDelete(c->db,c->argv[1]);

A
antirez 已提交
2250
    /* Create the key and set the TTL if any */
2251
    dbAdd(c->db,c->argv[1],obj);
2252
    if (ttl) setExpire(c->db,c->argv[1],mstime()+ttl);
2253
    signalModifiedKey(c->db,c->argv[1]);
A
antirez 已提交
2254
    addReply(c,shared.ok);
2255
    server.dirty++;
A
antirez 已提交
2256 2257
}

A
antirez 已提交
2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317
/* MIGRATE socket cache implementation.
 *
 * We take a map between host:ip and a TCP socket that we used to connect
 * to this instance in recent time.
 * This sockets are closed when the max number we cache is reached, and also
 * in serverCron() when they are around for more than a few seconds. */
#define MIGRATE_SOCKET_CACHE_ITEMS 64 /* max num of items in the cache. */
#define MIGRATE_SOCKET_CACHE_TTL 10 /* close cached socekts after 10 sec. */

typedef struct migrateCachedSocket {
    int fd;
    time_t last_use_time;
} migrateCachedSocket;

/* Return a TCP scoket connected with the target instance, possibly returning
 * a cached one.
 *
 * This function is responsible of sending errors to the client if a
 * connection can't be established. In this case -1 is returned.
 * Otherwise on success the socket is returned, and the caller should not
 * attempt to free it after usage.
 *
 * If the caller detects an error while using the socket, migrateCloseSocket()
 * should be called so that the connection will be craeted from scratch
 * the next time. */
int migrateGetSocket(redisClient *c, robj *host, robj *port, long timeout) {
    int fd;
    sds name = sdsempty();
    migrateCachedSocket *cs;

    /* Check if we have an already cached socket for this ip:port pair. */
    name = sdscatlen(name,host->ptr,sdslen(host->ptr));
    name = sdscatlen(name,":",1);
    name = sdscatlen(name,port->ptr,sdslen(port->ptr));
    cs = dictFetchValue(server.migrate_cached_sockets,name);
    if (cs) {
        sdsfree(name);
        cs->last_use_time = server.unixtime;
        return cs->fd;
    }

    /* No cached socket, create one. */
    if (dictSize(server.migrate_cached_sockets) == MIGRATE_SOCKET_CACHE_ITEMS) {
        /* Too many items, drop one at random. */
        dictEntry *de = dictGetRandomKey(server.migrate_cached_sockets);
        cs = dictGetVal(de);
        close(cs->fd);
        zfree(cs);
        dictDelete(server.migrate_cached_sockets,dictGetKey(de));
    }

    /* Create the socket */
    fd = anetTcpNonBlockConnect(server.neterr,c->argv[1]->ptr,
                atoi(c->argv[2]->ptr));
    if (fd == -1) {
        sdsfree(name);
        addReplyErrorFormat(c,"Can't connect to target node: %s",
            server.neterr);
        return -1;
    }
2318
    anetEnableTcpNoDelay(server.neterr,fd);
A
antirez 已提交
2319 2320

    /* Check if it connects within the specified timeout. */
2321
    if ((aeWait(fd,AE_WRITABLE,timeout) & AE_WRITABLE) == 0) {
A
antirez 已提交
2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371
        sdsfree(name);
        addReplySds(c,sdsnew("-IOERR error or timeout connecting to the client\r\n"));
        close(fd);
        return -1;
    }

    /* Add to the cache and return it to the caller. */
    cs = zmalloc(sizeof(*cs));
    cs->fd = fd;
    cs->last_use_time = server.unixtime;
    dictAdd(server.migrate_cached_sockets,name,cs);
    return fd;
}

/* Free a migrate cached connection. */
void migrateCloseSocket(robj *host, robj *port) {
    sds name = sdsempty();
    migrateCachedSocket *cs;

    name = sdscatlen(name,host->ptr,sdslen(host->ptr));
    name = sdscatlen(name,":",1);
    name = sdscatlen(name,port->ptr,sdslen(port->ptr));
    cs = dictFetchValue(server.migrate_cached_sockets,name);
    if (!cs) {
        sdsfree(name);
        return;
    }

    close(cs->fd);
    zfree(cs);
    dictDelete(server.migrate_cached_sockets,name);
    sdsfree(name);
}

void migrateCloseTimedoutSockets(void) {
    dictIterator *di = dictGetSafeIterator(server.migrate_cached_sockets);
    dictEntry *de;

    while((de = dictNext(di)) != NULL) {
        migrateCachedSocket *cs = dictGetVal(de);

        if ((server.unixtime - cs->last_use_time) > MIGRATE_SOCKET_CACHE_TTL) {
            close(cs->fd);
            zfree(cs);
            dictDelete(server.migrate_cached_sockets,dictGetKey(de));
        }
    }
    dictReleaseIterator(di);
}

A
antirez 已提交
2372
/* MIGRATE host port key dbid timeout [COPY | REPLACE] */
A
antirez 已提交
2373
void migrateCommand(redisClient *c) {
A
antirez 已提交
2374
    int fd, copy, replace, j;
A
antirez 已提交
2375 2376
    long timeout;
    long dbid;
A
antirez 已提交
2377
    long long ttl, expireat;
A
antirez 已提交
2378
    robj *o;
2379
    rio cmd, payload;
A
antirez 已提交
2380 2381 2382 2383 2384 2385 2386
    int retry_num = 0;

try_again:
    /* Initialization */
    copy = 0;
    replace = 0;
    ttl = 0;
A
antirez 已提交
2387

A
antirez 已提交
2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399
    /* Parse additional options */
    for (j = 6; j < c->argc; j++) {
        if (!strcasecmp(c->argv[j]->ptr,"copy")) {
            copy = 1;
        } else if (!strcasecmp(c->argv[j]->ptr,"replace")) {
            replace = 1;
        } else {
            addReply(c,shared.syntaxerr);
            return;
        }
    }

A
antirez 已提交
2400 2401 2402 2403 2404
    /* Sanity check */
    if (getLongFromObjectOrReply(c,c->argv[5],&timeout,NULL) != REDIS_OK)
        return;
    if (getLongFromObjectOrReply(c,c->argv[4],&dbid,NULL) != REDIS_OK)
        return;
2405
    if (timeout <= 0) timeout = 1000;
A
antirez 已提交
2406 2407 2408 2409 2410

    /* Check if the key is here. If not we reply with success as there is
     * nothing to migrate (for instance the key expired in the meantime), but
     * we include such information in the reply string. */
    if ((o = lookupKeyRead(c->db,c->argv[3])) == NULL) {
2411
        addReplySds(c,sdsnew("+NOKEY\r\n"));
A
antirez 已提交
2412 2413 2414 2415
        return;
    }
    
    /* Connect */
A
antirez 已提交
2416 2417
    fd = migrateGetSocket(c,c->argv[1],c->argv[2],timeout);
    if (fd == -1) return; /* error sent to the client by migrateGetSocket() */
A
antirez 已提交
2418

2419
    /* Create RESTORE payload and generate the protocol to call the command. */
2420
    rioInitWithBuffer(&cmd,sdsempty());
2421 2422 2423
    redisAssertWithInfo(c,NULL,rioWriteBulkCount(&cmd,'*',2));
    redisAssertWithInfo(c,NULL,rioWriteBulkString(&cmd,"SELECT",6));
    redisAssertWithInfo(c,NULL,rioWriteBulkLongLong(&cmd,dbid));
A
antirez 已提交
2424

A
antirez 已提交
2425 2426 2427 2428 2429
    expireat = getExpire(c->db,c->argv[3]);
    if (expireat != -1) {
        ttl = expireat-mstime();
        if (ttl < 1) ttl = 1;
    }
A
antirez 已提交
2430
    redisAssertWithInfo(c,NULL,rioWriteBulkCount(&cmd,'*',replace ? 5 : 4));
2431 2432 2433 2434 2435
    if (server.cluster_enabled)
        redisAssertWithInfo(c,NULL,
            rioWriteBulkString(&cmd,"RESTORE-ASKING",14));
    else
        redisAssertWithInfo(c,NULL,rioWriteBulkString(&cmd,"RESTORE",7));
2436 2437
    redisAssertWithInfo(c,NULL,c->argv[3]->encoding == REDIS_ENCODING_RAW);
    redisAssertWithInfo(c,NULL,rioWriteBulkString(&cmd,c->argv[3]->ptr,sdslen(c->argv[3]->ptr)));
2438
    redisAssertWithInfo(c,NULL,rioWriteBulkLongLong(&cmd,ttl));
A
antirez 已提交
2439

G
guiquanz 已提交
2440
    /* Emit the payload argument, that is the serialized object using
A
antirez 已提交
2441
     * the DUMP format. */
2442 2443 2444
    createDumpPayload(&payload,o);
    redisAssertWithInfo(c,NULL,rioWriteBulkString(&cmd,payload.io.buffer.ptr,
                                sdslen(payload.io.buffer.ptr)));
2445 2446
    sdsfree(payload.io.buffer.ptr);

A
antirez 已提交
2447 2448 2449 2450 2451
    /* Add the REPLACE option to the RESTORE command if it was specified
     * as a MIGRATE option. */
    if (replace)
        redisAssertWithInfo(c,NULL,rioWriteBulkString(&cmd,"REPLACE",7));

G
guiquanz 已提交
2452
    /* Transfer the query to the other node in 64K chunks. */
A
antirez 已提交
2453
    errno = 0;
A
antirez 已提交
2454
    {
2455 2456 2457 2458 2459 2460
        sds buf = cmd.io.buffer.ptr;
        size_t pos = 0, towrite;
        int nwritten = 0;

        while ((towrite = sdslen(buf)-pos) > 0) {
            towrite = (towrite > (64*1024) ? (64*1024) : towrite);
2461
            nwritten = syncWrite(fd,buf+pos,towrite,timeout);
2462 2463
            if (nwritten != (signed)towrite) goto socket_wr_err;
            pos += nwritten;
A
antirez 已提交
2464 2465 2466
        }
    }

2467
    /* Read back the reply. */
A
antirez 已提交
2468 2469 2470 2471 2472 2473 2474 2475
    {
        char buf1[1024];
        char buf2[1024];

        /* Read the two replies */
        if (syncReadLine(fd, buf1, sizeof(buf1), timeout) <= 0)
            goto socket_rd_err;
        if (syncReadLine(fd, buf2, sizeof(buf2), timeout) <= 0)
2476
            goto socket_rd_err;
A
antirez 已提交
2477 2478 2479 2480
        if (buf1[0] == '-' || buf2[0] == '-') {
            addReplyErrorFormat(c,"Target instance replied with error: %s",
                (buf1[0] == '-') ? buf1+1 : buf2+1);
        } else {
2481 2482
            robj *aux;

A
antirez 已提交
2483 2484 2485 2486 2487
            if (!copy) {
                /* No COPY option: remove the local key, signal the change. */
                dbDelete(c->db,c->argv[3]);
                signalModifiedKey(c->db,c->argv[3]);
            }
A
antirez 已提交
2488
            addReply(c,shared.ok);
2489 2490 2491
            server.dirty++;

            /* Translate MIGRATE as DEL for replication/AOF. */
A
antirez 已提交
2492
            aux = createStringObject("DEL",3);
2493 2494
            rewriteClientCommandVector(c,2,aux,c->argv[3]);
            decrRefCount(aux);
A
antirez 已提交
2495 2496 2497
        }
    }

2498
    sdsfree(cmd.io.buffer.ptr);
2499
    return;
A
antirez 已提交
2500 2501

socket_wr_err:
2502
    sdsfree(cmd.io.buffer.ptr);
A
antirez 已提交
2503
    migrateCloseSocket(c->argv[1],c->argv[2]);
A
antirez 已提交
2504 2505 2506
    if (errno != ETIMEDOUT && retry_num++ == 0) goto try_again;
    addReplySds(c,
        sdsnew("-IOERR error or timeout writing to target instance\r\n"));
2507
    return;
A
antirez 已提交
2508 2509

socket_rd_err:
2510
    sdsfree(cmd.io.buffer.ptr);
A
antirez 已提交
2511
    migrateCloseSocket(c->argv[1],c->argv[2]);
A
antirez 已提交
2512 2513 2514
    if (errno != ETIMEDOUT && retry_num++ == 0) goto try_again;
    addReplySds(c,
        sdsnew("-IOERR error or timeout reading from target node\r\n"));
2515 2516 2517
    return;
}

2518
/* The ASKING command is required after a -ASK redirection.
G
guiquanz 已提交
2519
 * The client should issue ASKING before to actually send the command to
2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530
 * the target instance. See the Redis Cluster specification for more
 * information. */
void askingCommand(redisClient *c) {
    if (server.cluster_enabled == 0) {
        addReplyError(c,"This instance has cluster support disabled");
        return;
    }
    c->flags |= REDIS_ASKING;
    addReply(c,shared.ok);
}

A
antirez 已提交
2531 2532 2533 2534
/* -----------------------------------------------------------------------------
 * Cluster functions related to serving / redirecting clients
 * -------------------------------------------------------------------------- */

2535 2536 2537
/* Return the pointer to the cluster node that is able to serve the command.
 * For the function to succeed the command should only target a single
 * key (or the same key multiple times).
A
antirez 已提交
2538
 *
2539 2540 2541 2542
 * If the returned node should be used only for this request, the *ask
 * integer is set to '1', otherwise to '0'. This is used in order to
 * let the caller know if we should reply with -MOVED or with -ASK.
 *
2543 2544
 * If the command contains multiple keys, and as a consequence it is not
 * possible to handle the request in Redis Cluster, NULL is returned. */
2545
clusterNode *getNodeByQuery(redisClient *c, struct redisCommand *cmd, robj **argv, int argc, int *hashslot, int *ask) {
A
antirez 已提交
2546
    clusterNode *n = NULL;
2547
    robj *firstkey = NULL;
A
antirez 已提交
2548 2549
    multiState *ms, _ms;
    multiCmd mc;
2550
    int i, slot = 0;
A
antirez 已提交
2551 2552 2553 2554 2555 2556

    /* We handle all the cases as if they were EXEC commands, so we have
     * a common code path for everything */
    if (cmd->proc == execCommand) {
        /* If REDIS_MULTI flag is not set EXEC is just going to return an
         * error. */
2557
        if (!(c->flags & REDIS_MULTI)) return server.cluster->myself;
A
antirez 已提交
2558 2559
        ms = &c->mstate;
    } else {
2560 2561 2562
        /* In order to have a single codepath create a fake Multi State
         * structure if the client is not in MULTI/EXEC state, this way
         * we have a single codepath below. */
A
antirez 已提交
2563 2564 2565 2566 2567 2568 2569 2570
        ms = &_ms;
        _ms.commands = &mc;
        _ms.count = 1;
        mc.argv = argv;
        mc.argc = argc;
        mc.cmd = cmd;
    }

2571 2572
    /* Check that all the keys are the same key, and get the slot and
     * node for this key. */
A
antirez 已提交
2573 2574 2575 2576 2577 2578 2579 2580 2581 2582
    for (i = 0; i < ms->count; i++) {
        struct redisCommand *mcmd;
        robj **margv;
        int margc, *keyindex, numkeys, j;

        mcmd = ms->commands[i].cmd;
        margc = ms->commands[i].argc;
        margv = ms->commands[i].argv;

        keyindex = getKeysFromCommand(mcmd,margv,margc,&numkeys,
2583
                                      REDIS_GETKEYS_ALL);
A
antirez 已提交
2584
        for (j = 0; j < numkeys; j++) {
2585 2586 2587 2588 2589 2590
            if (firstkey == NULL) {
                /* This is the first key we see. Check what is the slot
                 * and node. */
                firstkey = margv[keyindex[j]];

                slot = keyHashSlot((char*)firstkey->ptr, sdslen(firstkey->ptr));
2591
                n = server.cluster->slots[slot];
2592
                redisAssertWithInfo(c,firstkey,n != NULL);
A
antirez 已提交
2593
            } else {
2594 2595 2596 2597 2598 2599
                /* If it is not the first key, make sure it is exactly
                 * the same key as the first we saw. */
                if (!equalStringObjects(firstkey,margv[keyindex[j]])) {
                    getKeysFreeResult(keyindex);
                    return NULL;
                }
A
antirez 已提交
2600 2601 2602 2603
            }
        }
        getKeysFreeResult(keyindex);
    }
2604 2605 2606
    if (ask) *ask = 0; /* This is the default. Set to 1 if needed later. */
    /* No key at all in command? then we can serve the request
     * without redirections. */
2607
    if (n == NULL) return server.cluster->myself;
2608 2609 2610 2611 2612
    if (hashslot) *hashslot = slot;
    /* This request is about a slot we are migrating into another instance?
     * Then we need to check if we have the key. If we have it we can reply.
     * If instead is a new key, we pass the request to the node that is
     * receiving the slot. */
2613 2614
    if (n == server.cluster->myself &&
        server.cluster->migrating_slots_to[slot] != NULL)
2615 2616 2617
    {
        if (lookupKeyRead(&server.db[0],firstkey) == NULL) {
            if (ask) *ask = 1;
2618
            return server.cluster->migrating_slots_to[slot];
2619 2620 2621 2622
        }
    }
    /* Handle the case in which we are receiving this hash slot from
     * another instance, so we'll accept the query even if in the table
2623 2624
     * it is assigned to a different node, but only if the client
     * issued an ASKING command before. */
2625
    if (server.cluster->importing_slots_from[slot] != NULL &&
2626
        (c->flags & REDIS_ASKING || cmd->flags & REDIS_CMD_ASKING)) {
2627
        return server.cluster->myself;
2628
    }
2629 2630
    /* It's not a -ASK case. Base case: just return the right node. */
    return n;
A
antirez 已提交
2631
}