cluster.c 112.3 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 35
#include <sys/types.h>
#include <sys/socket.h>
A
antirez 已提交
36
#include <arpa/inet.h>
A
antirez 已提交
37 38
#include <fcntl.h>
#include <unistd.h>
A
antirez 已提交
39
#include <sys/socket.h>
A
antirez 已提交
40 41 42 43 44

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);
45
void clusterSendFailoverAuthIfNeeded(clusterNode *node, clusterMsg *request);
A
antirez 已提交
46 47
void clusterUpdateState(void);
int clusterNodeGetSlotBit(clusterNode *n, int slot);
48
sds clusterGenNodesDescription(int filter);
49 50
clusterNode *clusterLookupNode(char *name);
int clusterNodeAddSlave(clusterNode *master, clusterNode *slave);
51
int clusterAddSlot(clusterNode *n, int slot);
52
int clusterDelSlot(int slot);
53
int clusterDelNodeSlots(clusterNode *node);
54
int clusterNodeSetSlotBit(clusterNode *n, int slot);
55
void clusterSetMaster(clusterNode *n);
56
int bitmapTestBit(unsigned char *bitmap, int pos);
A
antirez 已提交
57 58 59 60 61

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

62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
/* This function is called at startup in order to set the currentEpoch
 * (which is not saved on permanent storage) to the greatest configEpoch found
 * in the loaded nodes (configEpoch is stored on permanent storage as soon as
 * it changes for some node). */
void clusterSetStartupEpoch() {
    dictIterator *di;
    dictEntry *de;

    di = dictGetSafeIterator(server.cluster->nodes);
    while((de = dictNext(di)) != NULL) {
        clusterNode *node = dictGetVal(de);
        if (node->configEpoch > server.cluster->currentEpoch)
            server.cluster->currentEpoch = node->configEpoch;
    }
    dictReleaseIterator(di);
}

A
antirez 已提交
79 80
int clusterLoadConfig(char *filename) {
    FILE *fp = fopen(filename,"r");
A
antirez 已提交
81
    char *line;
82
    int maxline, j;
A
antirez 已提交
83
   
A
antirez 已提交
84
    if (fp == NULL) return REDIS_ERR;
A
antirez 已提交
85 86 87

    /* 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.
88 89 90 91 92 93
     * 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 已提交
94 95 96 97
    line = zmalloc(maxline);
    while(fgets(line,maxline,fp) != NULL) {
        int argc;
        sds *argv = sdssplitargs(line,&argc);
C
charsyam 已提交
98 99
        if (argv == NULL) goto fmterr;

100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
        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")) {
121 122
                redisAssert(server.cluster->myself == NULL);
                server.cluster->myself = n;
123 124 125 126 127 128 129 130 131
                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 已提交
132
                n->fail_time = time(NULL);
133 134 135 136
            } else if (!strcasecmp(s,"handshake")) {
                n->flags |= REDIS_NODE_HANDSHAKE;
            } else if (!strcasecmp(s,"noaddr")) {
                n->flags |= REDIS_NODE_NOADDR;
A
antirez 已提交
137 138
            } else if (!strcasecmp(s,"promoted")) {
                n->flags |= REDIS_NODE_PROMOTED;
139 140
            } else if (!strcasecmp(s,"noflags")) {
                /* nothing to do */
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
            } 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);
        }

159 160 161 162
        /* Set ping sent / pong received timestamps */
        if (atoi(argv[4])) n->ping_sent = time(NULL);
        if (atoi(argv[5])) n->pong_received = time(NULL);

163 164 165
        /* Set configEpoch for this node. */
        n->configEpoch = strtoull(argv[6],NULL,10);

166
        /* Populate hash slots served by this instance. */
167
        for (j = 8; j < argc; j++) {
168 169
            int start, stop;

A
antirez 已提交
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
            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 == '>') {
188
                    server.cluster->migrating_slots_to[slot] = cn;
A
antirez 已提交
189
                } else {
190
                    server.cluster->importing_slots_from[slot] = cn;
A
antirez 已提交
191 192 193
                }
                continue;
            } else if ((p = strchr(argv[j],'-')) != NULL) {
194 195 196 197 198 199 200 201
                *p = '\0';
                start = atoi(argv[j]);
                stop = atoi(p+1);
            } else {
                start = stop = atoi(argv[j]);
            }
            while(start <= stop) clusterAddSlot(n, start++);
        }
A
antirez 已提交
202

203
        sdsfreesplitres(argv,argc);
A
antirez 已提交
204 205
    }
    zfree(line);
A
antirez 已提交
206 207
    fclose(fp);

A
antirez 已提交
208
    /* Config sanity check */
209
    redisAssert(server.cluster->myself != NULL);
A
antirez 已提交
210
    redisLog(REDIS_NOTICE,"Node configuration loaded, I'm %.40s",
211
        server.cluster->myself->name);
212
    clusterSetStartupEpoch();
213
    clusterUpdateState();
A
antirez 已提交
214 215 216
    return REDIS_OK;

fmterr:
G
guiquanz 已提交
217
    redisLog(REDIS_WARNING,"Unrecoverable error: corrupted cluster config file.");
A
antirez 已提交
218 219 220 221
    fclose(fp);
    exit(1);
}

A
antirez 已提交
222 223 224 225
/* 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. */
226
int clusterSaveConfig(void) {
227
    sds ci = clusterGenNodesDescription(REDIS_NODE_HANDSHAKE);
A
antirez 已提交
228 229
    int fd;
    
230
    if ((fd = open(server.cluster_configfile,O_WRONLY|O_CREAT|O_TRUNC,0644))
A
antirez 已提交
231
        == -1) goto err;
A
antirez 已提交
232 233 234 235 236 237 238 239 240 241
    if (write(fd,ci,sdslen(ci)) != (ssize_t)sdslen(ci)) goto err;
    close(fd);
    sdsfree(ci);
    return 0;

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

242 243 244 245 246 247 248
void clusterSaveConfigOrDie(void) {
    if (clusterSaveConfig() == -1) {
        redisLog(REDIS_WARNING,"Fatal: can't update cluster config file.");
        exit(1);
    }
}

A
antirez 已提交
249
void clusterInit(void) {
250
    int saveconf = 0;
251

252 253
    server.cluster = zmalloc(sizeof(clusterState));
    server.cluster->myself = NULL;
254
    server.cluster->currentEpoch = 0;
255
    server.cluster->state = REDIS_CLUSTER_FAIL;
256
    server.cluster->size = 1;
257
    server.cluster->nodes = dictCreate(&clusterNodesDictType,NULL);
258 259
    server.cluster->failover_auth_time = 0;
    server.cluster->failover_auth_count = 0;
260 261 262 263 264 265 266
    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 已提交
267 268
        /* No configuration found. We will just use the random name provided
         * by the createClusterNode() function. */
269 270
        server.cluster->myself =
            createClusterNode(NULL,REDIS_NODE_MYSELF|REDIS_NODE_MASTER);
A
antirez 已提交
271
        redisLog(REDIS_NOTICE,"No cluster configuration found, I'm %.40s",
272 273
            server.cluster->myself->name);
        clusterAddNode(server.cluster->myself);
274 275
        saveconf = 1;
    }
276
    if (saveconf) clusterSaveConfigOrDie();
277 278

    /* We need a listening TCP port for our cluster messaging needs. */
279
    server.cfd_count = 0;
280 281 282 283
    if (listenToPort(server.port+REDIS_CLUSTER_PORT_INCR,
        server.cfd,&server.cfd_count) == REDIS_ERR)
    {
        exit(1);
284 285 286 287 288 289 290 291 292
    } else {
        int j;

        for (j = 0; j < server.cfd_count; j++) {
            if (aeCreateFileEvent(server.el, server.cfd[j], AE_READABLE,
                clusterAcceptHandler, NULL) == AE_ERR)
                    redisPanic("Unrecoverable error creating Redis Cluster "
                                "file event.");
        }
A
antirez 已提交
293
    }
294 295

    /* The slots -> keys map is a sorted set. Init it. */
296
    server.cluster->slots_to_keys = zslCreate();
A
antirez 已提交
297 298 299 300 301 302 303 304
}

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

clusterLink *createClusterLink(clusterNode *node) {
    clusterLink *link = zmalloc(sizeof(*link));
305
    link->ctime = time(NULL);
A
antirez 已提交
306 307 308 309 310 311 312 313
    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.
314
 * This function will just make sure that the original node associated
A
antirez 已提交
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
 * 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;
331
    char cip[REDIS_IP_STR_LEN];
A
antirez 已提交
332 333 334 335 336
    clusterLink *link;
    REDIS_NOTUSED(el);
    REDIS_NOTUSED(mask);
    REDIS_NOTUSED(privdata);

337
    cfd = anetTcpAccept(server.neterr, fd, cip, sizeof(cip), &cport);
A
antirez 已提交
338 339 340 341
    if (cfd == AE_ERR) {
        redisLog(REDIS_VERBOSE,"Accepting cluster node: %s", server.neterr);
        return;
    }
342 343 344 345
    anetNonBlock(NULL,cfd);
    anetEnableTcpNoDelay(NULL,cfd);

    /* Use non-blocking I/O for cluster messages. */
346
    /* IPV6: might want to wrap a v6 address in [] */
A
antirez 已提交
347 348 349 350 351 352 353 354 355 356 357 358 359
    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
 * -------------------------------------------------------------------------- */

360 361
/* 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 已提交
362
unsigned int keyHashSlot(char *key, int keylen) {
363
    return crc16(key,keylen) & 0x3FFF;
A
antirez 已提交
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
}

/* -----------------------------------------------------------------------------
 * 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
383
        getRandomHexChars(node->name, REDIS_CLUSTER_NAMELEN);
384
    node->ctime = time(NULL);
385
    node->configEpoch = 0;
A
antirez 已提交
386 387
    node->flags = flags;
    memset(node->slots,0,sizeof(node->slots));
388
    node->numslots = 0;
A
antirez 已提交
389 390 391 392
    node->numslaves = 0;
    node->slaves = NULL;
    node->slaveof = NULL;
    node->ping_sent = node->pong_received = 0;
A
antirez 已提交
393
    node->fail_time = 0;
A
antirez 已提交
394
    node->link = NULL;
395
    memset(node->ip,0,sizeof(node->ip));
396
    node->port = 0;
397 398
    node->fail_reports = listCreate();
    listSetFreeMethod(node->fail_reports,zfree);
A
antirez 已提交
399 400 401
    return node;
}

402 403 404 405 406
/* 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
407 408 409 410 411 412
 * '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) {
413 414 415 416 417 418 419 420 421 422 423 424
    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);
425
            return 0;
426 427 428 429 430 431 432 433
        }
    }

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

437 438 439 440 441 442 443 444 445 446
/* 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;
447
    time_t maxtime = server.cluster_node_timeout *
448
                     REDIS_CLUSTER_FAIL_REPORT_VALIDITY_MULT;
449 450 451 452 453 454 455 456 457
    time_t now = time(NULL);

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

458 459 460 461 462 463 464
/* 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
465 466 467 468 469
 * time.
 *
 * The function returns 1 if the failure report was found and removed.
 * Otherwise 0 is returned. */
int clusterNodeDelFailureReport(clusterNode *node, clusterNode *sender) {
470 471 472 473 474 475 476 477 478 479 480
    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;
    }
481
    if (!ln) return 0; /* No failure report from this sender. */
482 483 484

    /* Remove the failure report. */
    listDelNode(l,ln);
485
    clusterNodeCleanupFailureReports(node);
486
    return 1;
487 488
}

489 490 491 492 493 494 495 496
/* 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 已提交
497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530
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;
531

A
antirez 已提交
532
    nodename = sdsnewlen(n->name, REDIS_CLUSTER_NAMELEN);
533
    redisAssert(dictDelete(server.cluster->nodes,nodename) == DICT_OK);
A
antirez 已提交
534 535 536
    sdsfree(nodename);
    if (n->slaveof) clusterNodeRemoveSlave(n->slaveof, n);
    if (n->link) freeClusterLink(n->link);
537
    listRelease(n->fail_reports);
A
antirez 已提交
538 539 540 541 542 543 544
    zfree(n);
}

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

A
antirez 已提交
550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571
/* 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. */
572
    di = dictGetSafeIterator(server.cluster->nodes);
A
antirez 已提交
573 574 575 576 577 578 579 580 581 582 583 584
    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 已提交
585 586 587 588 589
/* Node lookup by name */
clusterNode *clusterLookupNode(char *name) {
    sds s = sdsnewlen(name, REDIS_CLUSTER_NAMELEN);
    struct dictEntry *de;

590
    de = dictFind(server.cluster->nodes,s);
A
antirez 已提交
591 592
    sdsfree(s);
    if (de == NULL) return NULL;
593
    return dictGetVal(de);
A
antirez 已提交
594 595 596 597 598 599 600 601 602 603 604 605
}

/* 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);
606
    retval = dictDelete(server.cluster->nodes, s);
A
antirez 已提交
607 608 609 610 611 612 613 614 615 616
    sdsfree(s);
    redisAssert(retval == DICT_OK);
    memcpy(node->name, newname, REDIS_CLUSTER_NAMELEN);
    clusterAddNode(node);
}

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

617 618 619
/* This function checks if a given node should be marked as FAIL.
 * It happens if the following conditions are met:
 *
620 621 622 623
 * 1) We received enough failure reports from other master nodes via gossip.
 *    Enough means that the majority of the masters signaled the node is
 *    down recently.
 * 2) We believe this node is in PFAIL state.
624 625 626
 *
 * 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.
627 628 629 630 631 632 633 634 635 636
 *
 * Note that the form of agreement used here is weak, as we collect the majority
 * of masters state during some time, and even if we force agreement by
 * propagating the FAIL message, because of partitions we may not reach every
 * node. However:
 *
 * 1) Either we reach the majority and eventually the FAIL state will propagate
 *    to all the cluster.
 * 2) Or there is no majority so no slave promotion will be authorized and the
 *    FAIL flag will be cleared after some time.
637 638 639 640 641 642 643 644
 */
void markNodeAsFailingIfNeeded(clusterNode *node) {
    int failures;
    int needed_quorum = (server.cluster->size / 2) + 1;

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

645 646 647 648 649
    failures = clusterNodeFailureReportsCount(node);
    /* Also count myself as a voter if I'm a master. */
    if (server.cluster->myself->flags & REDIS_NODE_MASTER)
        failures += 1;
    if (failures < needed_quorum) return; /* No weak agreement from masters. */
650 651 652 653 654 655 656

    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 已提交
657
    node->fail_time = time(NULL);
658

659 660 661 662
    /* Broadcast the failing node name to everybody, forcing all the other
     * reachable nodes to flag the node as FAIL. */
    if (server.cluster->myself->flags & REDIS_NODE_MASTER)
        clusterSendFail(node->name);
663 664 665 666 667 668
    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
669
 * state. */
670
void clearNodeFailureIfNeeded(clusterNode *node) {
A
antirez 已提交
671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
    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...
687 688 689 690
     * 1) The FAIL state is old enough. We use our node timeout multiplicator
     *    plus some additional fixed time. The additional time is useful when
     *    the node timeout is extremely short and the reaction time of
     *    the cluster may be longer, so wait at least a few seconds always.
A
antirez 已提交
691 692 693 694
     * 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 &&
695
        (now - node->fail_time) >
696
        (server.cluster_node_timeout * REDIS_CLUSTER_FAIL_UNDO_TIME_MULT +
697
                                        REDIS_CLUSTER_FAIL_UNDO_TIME_ADD))
A
antirez 已提交
698
    {
699
        redisLog(REDIS_NOTICE,
A
antirez 已提交
700
            "Clear FAIL state for node %.40s: is reachable again and nobody is serving its slots after some time.",
701
                node->name);
702
        node->flags &= ~REDIS_NODE_FAIL;
A
antirez 已提交
703 704 705 706 707
        changes++;
    }

    /* Update state and save config. */
    if (changes) {
708 709
        clusterUpdateState();
        clusterSaveConfigOrDie();
710 711 712
    }
}

713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730
/* Return true if we already have a node in HANDSHAKE state matching the
 * specified ip address and port number. This function is used in order to
 * avoid adding a new handshake node for the same address multiple times. */
int clusterHandshakeInProgress(char *ip, int port) {
    dictIterator *di;
    dictEntry *de;

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

        if (!(node->flags & REDIS_NODE_HANDSHAKE)) continue;
        if (!strcasecmp(node->ip,ip) && node->port == port) break;
    }
    dictReleaseIterator(di);
    return de != NULL;
}

A
antirez 已提交
731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752
/* 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,");
A
antirez 已提交
753
        if (flags & REDIS_NODE_PROMOTED) ci = sdscat(ci,"promoted,");
A
antirez 已提交
754 755 756 757 758 759 760 761 762 763 764 765
        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) {
766 767
            /* We already know this node.
               Handle failure reports, only when the sender is a master. */
768 769 770
            if (sender && sender->flags & REDIS_NODE_MASTER &&
                node != server.cluster->myself)
            {
771 772 773 774 775 776 777 778 779 780 781 782 783 784
                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 已提交
785 786 787 788 789 790 791 792
            }
        } 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. */
793 794 795
            if (sender && !(flags & REDIS_NODE_NOADDR) &&
                !clusterHandshakeInProgress(g->ip,ntohs(g->port)))
            {
A
antirez 已提交
796 797 798 799 800 801 802 803 804 805 806 807 808 809 810
                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++;
    }
}

811
/* IP -> string conversion. 'buf' is supposed to at least be 46 bytes. */
A
antirez 已提交
812
void nodeIp2String(char *buf, clusterLink *link) {
813
    struct sockaddr_storage sa;
A
antirez 已提交
814 815 816 817
    socklen_t salen = sizeof(sa);

    if (getpeername(link->fd, (struct sockaddr*) &sa, &salen) == -1)
        redisPanic("getpeername() failed.");
818 819 820 821 822 823 824 825

    if (sa.ss_family == AF_INET) {
        struct sockaddr_in *s = (struct sockaddr_in *)&sa;
        inet_ntop(AF_INET,(void*)&(s->sin_addr),buf,REDIS_CLUSTER_IPLEN);
    } else {
        struct sockaddr_in6 *s = (struct sockaddr_in6 *)&sa;
        inet_ntop(AF_INET6,(void*)&(s->sin6_addr),buf,REDIS_CLUSTER_IPLEN);
    }
A
antirez 已提交
826 827 828 829
}


/* Update the node address to the IP address that can be extracted
A
antirez 已提交
830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859
 * from link->fd, and at the specified port.
 * Also disconnect the node link so that we'll connect again to the new
 * address.
 *
 * If the ip/port pair are already correct no operation is performed at
 * all.
 *
 * The function returns 0 if the node address is still the same,
 * otherwise 1 is returned. */
int nodeUpdateAddressIfNeeded(clusterNode *node, clusterLink *link, int port) {
    char ip[REDIS_IP_STR_LEN];

    /* We don't proceed if the link is the same as the sender link, as this
     * function is designed to see if the node link is consistent with the
     * symmetric link that is used to receive PINGs from the node.
     *
     * As a side effect this function never frees the passed 'link', so
     * it is safe to call during packet processing. */
    if (link == node->link) return 0;

    nodeIp2String(ip,link);
    if (node->port == port && strcmp(ip,node->ip) == 0) return 0;

    /* IP / port is different, update it. */
    memcpy(node->ip,ip,sizeof(ip));
    node->port = port;
    if (node->link) freeClusterLink(node->link);
    redisLog(REDIS_WARNING,"Address updated for node %.40s, now %s:%d",
        node->name, node->ip, node->port);
    return 1;
A
antirez 已提交
860 861 862 863 864 865 866 867 868 869 870 871 872 873 874
}

/* 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);
A
antirez 已提交
875
    uint16_t flags = ntohs(hdr->flags);
A
antirez 已提交
876 877
    clusterNode *sender;

878 879
    redisLog(REDIS_DEBUG,"--- Processing packet of type %d, %lu bytes",
        type, (unsigned long) totlen);
880 881

    /* Perform sanity checks */
A
antirez 已提交
882 883 884 885 886 887 888 889 890 891 892
    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;
893
    } else if (type == CLUSTERMSG_TYPE_FAIL) {
A
antirez 已提交
894 895 896 897
        uint32_t explen = sizeof(clusterMsg)-sizeof(union clusterMsgData);

        explen += sizeof(clusterMsgDataFail);
        if (totlen != explen) return 1;
898
    } else if (type == CLUSTERMSG_TYPE_PUBLISH) {
899 900 901 902 903 904
        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;
905 906
    } else if (type == CLUSTERMSG_TYPE_FAILOVER_AUTH_REQUEST ||
               type == CLUSTERMSG_TYPE_FAILOVER_AUTH_ACK) {
907 908 909
        uint32_t explen = sizeof(clusterMsg)-sizeof(union clusterMsgData);

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

912
    /* Process packets by type. */
A
antirez 已提交
913
    sender = clusterLookupNode(hdr->sender);
914

A
antirez 已提交
915
    if (type == CLUSTERMSG_TYPE_PING || type == CLUSTERMSG_TYPE_MEET) {
916
        int update_config = 0;
917
        redisLog(REDIS_DEBUG,"Ping packet received: %p", (void*)link->node);
A
antirez 已提交
918 919 920 921

        /* 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
922
         * resolved when we'll receive PONGs from the node. */
A
antirez 已提交
923 924 925 926 927 928 929
        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);
930
            update_config = 1;
A
antirez 已提交
931 932 933 934 935 936 937
        }

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

        /* Anyway reply with a PONG */
        clusterSendPing(link,CLUSTERMSG_TYPE_PONG);
938 939 940

        /* Update config if needed */
        if (update_config) clusterSaveConfigOrDie();
941 942 943
    }

    /* PING or PONG: process config information. */
944 945 946
    if (type == CLUSTERMSG_TYPE_PING || type == CLUSTERMSG_TYPE_PONG ||
        type == CLUSTERMSG_TYPE_MEET)
    {
947 948
        int update_state = 0;
        int update_config = 0;
A
antirez 已提交
949

950 951 952
        redisLog(REDIS_DEBUG,"%s packet received: %p",
            type == CLUSTERMSG_TYPE_PING ? "ping" : "pong",
            (void*)link->node);
A
antirez 已提交
953 954 955 956 957 958 959
        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);
A
antirez 已提交
960 961 962 963 964 965 966 967
                    if (nodeUpdateAddressIfNeeded(sender,link,ntohs(hdr->port)))
                    {
                        clusterUpdateState();
                        clusterSaveConfigOrDie();
                    }
                    /* Free this node as we alrady have it. This will
                     * cause the link to be freed as well. */
                    freeClusterNode(link->node);
A
antirez 已提交
968 969 970 971 972 973 974 975 976
                    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;
977
                link->node->flags |= flags&(REDIS_NODE_MASTER|REDIS_NODE_SLAVE);
978
                update_config = 1;
A
antirez 已提交
979 980 981 982 983 984 985 986
            } 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;
987 988
                link->node->ip[0] = '\0';
                link->node->port = 0;
A
antirez 已提交
989
                freeClusterLink(link);
990
                update_config = 1;
A
antirez 已提交
991 992 993 994 995 996 997 998
                /* 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;
            }
        }
999

A
antirez 已提交
1000 1001 1002 1003 1004 1005 1006 1007 1008
        /* Update the node address if it changed. */
        if (sender && type == CLUSTERMSG_TYPE_PING &&
            !(sender->flags & REDIS_NODE_HANDSHAKE) &&
            nodeUpdateAddressIfNeeded(sender,link,ntohs(hdr->port)))
        {
            update_state = 1;
            update_config = 1;
        }

A
antirez 已提交
1009
        /* Update our info about the node */
1010 1011 1012 1013 1014
        if (link->node && type == CLUSTERMSG_TYPE_PONG) {
            link->node->pong_received = time(NULL);
            link->node->ping_sent = 0;

            /* The PFAIL condition can be reversed without external
1015
             * help if it is momentary (that is, if it does not
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026
             * turn into a FAIL state).
             *
             * The FAIL condition is also reversible under specific
             * conditions detected by clearNodeFailureIfNeeded(). */
            if (link->node->flags & REDIS_NODE_PFAIL) {
                link->node->flags &= ~REDIS_NODE_PFAIL;
                update_state = 1;
            } else if (link->node->flags & REDIS_NODE_FAIL) {
                clearNodeFailureIfNeeded(link->node);
            }
        }
A
antirez 已提交
1027

1028
        /* Update master/slave state */
A
antirez 已提交
1029 1030 1031 1032
        if (sender) {
            if (!memcmp(hdr->slaveof,REDIS_NODE_NULL_NAME,
                sizeof(hdr->slaveof)))
            {
1033
                /* Node is a master. */
1034
                if (sender->flags & REDIS_NODE_SLAVE) {
1035 1036 1037 1038
                    /* Slave turned into master! */
                    clusterNode *oldmaster = sender->slaveof;

                    /* Reconfigure node as master. */
1039 1040 1041 1042 1043
                    if (sender->slaveof)
                        clusterNodeRemoveSlave(sender->slaveof,sender);
                    sender->flags &= ~REDIS_NODE_SLAVE;
                    sender->flags |= REDIS_NODE_MASTER;
                    sender->slaveof = NULL;
1044

A
antirez 已提交
1045 1046
                    /* If this node used to be our slave, and now has the
                     * PROMOTED flag set. We'll turn ourself into a slave
1047
                     * of the new master. */
A
antirez 已提交
1048 1049 1050
                    if (flags & REDIS_NODE_PROMOTED &&
                        oldmaster == server.cluster->myself)
                    {
1051
                        redisLog(REDIS_WARNING,"One of my slaves took my place. Reconfiguring myself as a replica of %.40s", sender->name);
1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063
                        clusterDelNodeSlots(server.cluster->myself);
                        clusterSetMaster(sender);
                    }

                    /* If we are a slave, and this node used to be a slave
                     * of our master, and now has the PROMOTED flag set, we
                     * need to switch our replication setup over it. */
                    if (flags & REDIS_NODE_PROMOTED &&
                        server.cluster->myself->flags & REDIS_NODE_SLAVE &&
                        server.cluster->myself->slaveof == oldmaster)
                    {
                        redisLog(REDIS_WARNING,"One of the slaves failed over my master. Reconfiguring myself as a replica of %.40s", sender->name);
1064
                        clusterDelNodeSlots(server.cluster->myself);
1065 1066 1067 1068
                        clusterSetMaster(sender);
                    }

                    /* Update config and state. */
1069 1070 1071
                    update_state = 1;
                    update_config = 1;
                }
A
antirez 已提交
1072
            } else {
1073
                /* Node is a slave. */
A
antirez 已提交
1074 1075
                clusterNode *master = clusterLookupNode(hdr->slaveof);

1076
                if (sender->flags & REDIS_NODE_MASTER) {
1077
                    /* Master turned into a slave! Reconfigure the node. */
1078
                    clusterDelNodeSlots(sender);
1079 1080
                    sender->flags &= ~REDIS_NODE_MASTER;
                    sender->flags |= REDIS_NODE_SLAVE;
1081

1082 1083
                    /* Remove the list of slaves from the node. */
                    if (sender->numslaves) clusterNodeResetSlaves(sender);
1084 1085

                    /* Update config and state. */
1086 1087 1088 1089
                    update_state = 1;
                    update_config = 1;
                }

1090 1091
                /* Master node changed for this slave? */
                if (sender->slaveof != master) {
1092 1093
                    if (sender->slaveof)
                        clusterNodeRemoveSlave(sender->slaveof,sender);
1094 1095 1096
                    clusterNodeAddSlave(master,sender);
                    sender->slaveof = master;
                }
A
antirez 已提交
1097 1098 1099
            }
        }

1100 1101 1102
        /* Update our info about served slots.
         * Note: this MUST happen after we update the master/slave state
         * so that REDIS_NODE_MASTER flag will be set. */
A
antirez 已提交
1103
        if (sender && sender->flags & REDIS_NODE_MASTER) {
1104
            int changes, j;
A
antirez 已提交
1105

1106
            changes =
A
antirez 已提交
1107
                memcmp(sender->slots,hdr->myslots,sizeof(hdr->myslots)) != 0;
1108
            if (changes) {
A
antirez 已提交
1109
                for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
1110
                    if (bitmapTestBit(hdr->myslots,j)) {
1111 1112
                        /* If this slot was not served, or served by a node
                         * in FAIL state, update the table with the new node
1113
                         * claiming to serve the slot. */
1114 1115 1116
                        if (server.cluster->slots[j] == sender) continue;
                        if (server.cluster->slots[j] == NULL ||
                            server.cluster->slots[j]->flags & REDIS_NODE_FAIL)
A
antirez 已提交
1117
                        {
1118 1119
                            clusterDelSlot(j);
                            clusterAddSlot(sender,j);
1120
                            update_state = update_config = 1;
A
antirez 已提交
1121
                        }
1122
                    } else {
1123 1124 1125 1126
                        /* 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 已提交
1127 1128 1129 1130 1131 1132 1133 1134 1135
                    }
                }
            }
        }

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

        /* Update the cluster state if needed */
1136 1137
        if (update_state) clusterUpdateState();
        if (update_config) clusterSaveConfigOrDie();
A
antirez 已提交
1138 1139 1140 1141
    } else if (type == CLUSTERMSG_TYPE_FAIL && sender) {
        clusterNode *failing;

        failing = clusterLookupNode(hdr->data.fail.about.nodename);
1142 1143
        if (failing && !(failing->flags & (REDIS_NODE_FAIL|REDIS_NODE_MYSELF)))
        {
A
antirez 已提交
1144 1145 1146 1147
            redisLog(REDIS_NOTICE,
                "FAIL message received from %.40s about %.40s",
                hdr->sender, hdr->data.fail.about.nodename);
            failing->flags |= REDIS_NODE_FAIL;
A
antirez 已提交
1148
            failing->fail_time = time(NULL);
A
antirez 已提交
1149 1150
            failing->flags &= ~REDIS_NODE_PFAIL;
            clusterUpdateState();
A
antirez 已提交
1151
            clusterSaveConfigOrDie();
A
antirez 已提交
1152
        }
1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168
    } 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);
        }
1169
    } else if (type == CLUSTERMSG_TYPE_FAILOVER_AUTH_REQUEST) {
A
antirez 已提交
1170
        if (!sender) return 1;  /* We don't know that node. */
1171 1172
        /* If we are not a master, ignore that message at all. */
        if (!(server.cluster->myself->flags & REDIS_NODE_MASTER)) return 0;
1173
        clusterSendFailoverAuthIfNeeded(sender,hdr);
1174
    } else if (type == CLUSTERMSG_TYPE_FAILOVER_AUTH_ACK) {
A
antirez 已提交
1175
        if (!sender) return 1;  /* We don't know that node. */
1176 1177 1178 1179
        /* If this is a master, increment the number of acknowledges
         * we received so far. */
        if (sender->flags & REDIS_NODE_MASTER)
            server.cluster->failover_auth_count++;
A
antirez 已提交
1180
    } else {
1181
        redisLog(REDIS_WARNING,"Received unknown packet type: %d", type);
A
antirez 已提交
1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206
    }
    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) {
1207
        redisLog(REDIS_DEBUG,"I/O error writing to node link: %s",
A
antirez 已提交
1208 1209 1210 1211
            strerror(errno));
        handleLinkIOError(link);
        return;
    }
1212
    sdsrange(link->sndbuf,nwritten,-1);
A
antirez 已提交
1213 1214 1215 1216 1217 1218 1219 1220
    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) {
1221
    char buf[4096];
A
antirez 已提交
1222 1223 1224
    ssize_t nread;
    clusterMsg *hdr;
    clusterLink *link = (clusterLink*) privdata;
1225
    int readlen, rcvbuflen;
A
antirez 已提交
1226 1227 1228
    REDIS_NOTUSED(el);
    REDIS_NOTUSED(mask);

1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245
    while(1) { /* Read as long as there is data to read. */
        rcvbuflen = sdslen(link->rcvbuf);
        if (rcvbuflen < 4) {
            /* First, obtain the first four bytes to get the full message
             * length. */
            readlen = 4 - rcvbuflen;
        } else {
            /* 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;
                }
1246
            }
1247 1248
            readlen = ntohl(hdr->totlen) - rcvbuflen;
            if (readlen > sizeof(buf)) readlen = sizeof(buf);
1249
        }
A
antirez 已提交
1250

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

1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265
        if (nread <= 0) {
            /* I/O error... */
            redisLog(REDIS_DEBUG,"I/O error reading from node link: %s",
                (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;
            rcvbuflen += nread;
        }
A
antirez 已提交
1266

1267 1268 1269 1270 1271 1272 1273 1274
        /* Total length obtained? Process this packet. */
        if (rcvbuflen >= 4 && rcvbuflen == ntohl(hdr->totlen)) {
            if (clusterProcessPacket(link)) {
                sdsfree(link->rcvbuf);
                link->rcvbuf = sdsempty();
            } else {
                return; /* Link no longer valid. */
            }
A
antirez 已提交
1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287
        }
    }
}

/* 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);
}

1288 1289
/* Send a message to all the nodes that are part of the cluster having
 * a connected link. */
1290 1291 1292 1293
void clusterBroadcastMessage(void *buf, size_t len) {
    dictIterator *di;
    dictEntry *de;

1294
    di = dictGetSafeIterator(server.cluster->nodes);
1295
    while((de = dictNext(di)) != NULL) {
1296
        clusterNode *node = dictGetVal(de);
1297 1298

        if (!node->link) continue;
1299 1300
        if (node->flags & (REDIS_NODE_MYSELF|REDIS_NODE_HANDSHAKE))
            continue;
1301 1302 1303 1304 1305
        clusterSendMessage(node->link,buf,len);
    }
    dictReleaseIterator(di);
}

A
antirez 已提交
1306 1307
/* Build the message header */
void clusterBuildMessageHdr(clusterMsg *hdr, int type) {
1308
    int totlen = 0;
A
antirez 已提交
1309 1310 1311

    memset(hdr,0,sizeof(*hdr));
    hdr->type = htons(type);
1312 1313
    memcpy(hdr->sender,server.cluster->myself->name,REDIS_CLUSTER_NAMELEN);
    memcpy(hdr->myslots,server.cluster->myself->slots,
A
antirez 已提交
1314 1315
        sizeof(hdr->myslots));
    memset(hdr->slaveof,0,REDIS_CLUSTER_NAMELEN);
1316 1317
    if (server.cluster->myself->slaveof != NULL) {
        memcpy(hdr->slaveof,server.cluster->myself->slaveof->name,
A
antirez 已提交
1318 1319 1320
                                    REDIS_CLUSTER_NAMELEN);
    }
    hdr->port = htons(server.port);
1321
    hdr->flags = htons(server.cluster->myself->flags);
1322
    hdr->state = server.cluster->state;
A
antirez 已提交
1323

1324 1325 1326 1327 1328 1329 1330 1331
    /* Set the currentEpoch and configEpochs. Note that configEpoch is
     * set to the master configEpoch if this node is a slave. */
    hdr->currentEpoch = htonu64(server.cluster->currentEpoch);
    if (server.cluster->myself->flags & REDIS_NODE_SLAVE)
        hdr->configEpoch = htonu64(server.cluster->myself->slaveof->configEpoch);
    else
        hdr->configEpoch = htonu64(server.cluster->myself->configEpoch);

A
antirez 已提交
1332 1333 1334 1335 1336
    if (type == CLUSTERMSG_TYPE_FAIL) {
        totlen = sizeof(clusterMsg)-sizeof(union clusterMsgData);
        totlen += sizeof(clusterMsgDataFail);
    }
    hdr->totlen = htonl(totlen);
1337
    /* For PING, PONG, and MEET, fixing the totlen field is up to the caller. */
A
antirez 已提交
1338 1339 1340 1341 1342
}

/* Send a PING or PONG packet to the specified node, making sure to add enough
 * gossip informations. */
void clusterSendPing(clusterLink *link, int type) {
1343
    unsigned char buf[4096];
A
antirez 已提交
1344 1345 1346 1347 1348 1349 1350 1351
    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. */
1352
    int freshnodes = dictSize(server.cluster->nodes)-2;
A
antirez 已提交
1353 1354 1355 1356 1357 1358 1359

    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) {
1360
        struct dictEntry *de = dictGetRandomKey(server.cluster->nodes);
1361
        clusterNode *this = dictGetVal(de);
A
antirez 已提交
1362 1363 1364
        clusterMsgDataGossip *gossip;
        int j;

1365 1366 1367 1368 1369 1370
        /* 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.
         */
1371
        if (this == server.cluster->myself ||
1372
            this->flags & (REDIS_NODE_HANDSHAKE|REDIS_NODE_NOADDR) ||
1373
            (this->link == NULL && this->numslots == 0))
1374
        {
A
antirez 已提交
1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403
                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);
}

1404
/* Send a PONG packet to every connected node that's not in handshake state.
1405
 *
1406 1407
 * In Redis Cluster pings are not just used for failure detection, but also
 * to carry important configuration informations. So broadcasting a pong is
1408 1409
 * useful when something changes in the configuration and we want to make
 * the cluster aware ASAP (for instance after a slave promotion). */
1410
void clusterBroadcastPong(void) {
1411 1412 1413
    dictIterator *di;
    dictEntry *de;

1414
    di = dictGetSafeIterator(server.cluster->nodes);
1415 1416 1417 1418 1419 1420 1421 1422 1423
    while((de = dictNext(di)) != NULL) {
        clusterNode *node = dictGetVal(de);

        if (node->flags & (REDIS_NODE_MYSELF|REDIS_NODE_HANDSHAKE)) continue;
        clusterSendPing(node->link,CLUSTERMSG_TYPE_PONG);
    }
    dictReleaseIterator(di);
}

1424 1425 1426 1427 1428 1429 1430 1431
/* 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 已提交
1432

1433 1434 1435 1436
    channel = getDecodedObject(channel);
    message = getDecodedObject(message);
    channel_len = sdslen(channel->ptr);
    message_len = sdslen(message->ptr);
A
antirez 已提交
1437

1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450
    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);
1451
        memcpy(payload,hdr,sizeof(*hdr));
1452
        hdr = (clusterMsg*) payload;
A
antirez 已提交
1453
    }
1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465
    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 已提交
1466 1467 1468 1469 1470 1471 1472 1473
}

/* 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) {
1474
    unsigned char buf[4096];
A
antirez 已提交
1475 1476 1477 1478 1479 1480 1481
    clusterMsg *hdr = (clusterMsg*) buf;

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

1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492
/* -----------------------------------------------------------------------------
 * 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);
}

1493 1494 1495 1496
/* -----------------------------------------------------------------------------
 * SLAVE node specific functions
 * -------------------------------------------------------------------------- */

1497 1498 1499 1500 1501 1502 1503
/* 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) {
1504
    unsigned char buf[4096];
1505 1506 1507 1508 1509 1510
    clusterMsg *hdr = (clusterMsg*) buf;
    uint32_t totlen;

    clusterBuildMessageHdr(hdr,CLUSTERMSG_TYPE_FAILOVER_AUTH_REQUEST);
    totlen = sizeof(clusterMsg)-sizeof(union clusterMsgData);
    hdr->totlen = htonl(totlen);
1511
    hdr->time = mstime();
1512
    clusterBroadcastMessage(buf,totlen);
1513 1514
}

1515 1516 1517 1518
/* Send a FAILOVER_AUTH_ACK message to the specified node.
 * Reqtime is the time field from the original failover auth request packet,
 * so that the receiver is able to check the reply age. */
void clusterSendFailoverAuth(clusterNode *node, uint64_t reqtime) {
1519
    unsigned char buf[4096];
1520 1521 1522 1523 1524 1525 1526
    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);
1527
    hdr->time = reqtime;
1528
    clusterSendMessage(node->link,buf,totlen);
1529 1530
}

1531
/* If we believe 'node' is the "first slave" of it's master, reply with
1532
 * a FAILOVER_AUTH_GRANTED packet.
1533 1534
 * The 'request' field points to the authorization request packet header, we
 * need it in order to copy back the 'time' field in our reply.
1535 1536 1537 1538
 *
 * To be a first slave the sender must:
 * 1) Be a slave.
 * 2) Its master should be in FAIL state.
1539 1540
 * 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.
1541
 */
1542
void clusterSendFailoverAuthIfNeeded(clusterNode *node, clusterMsg *request) {
1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566
    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. */
1567
    clusterSendFailoverAuth(node,request->time);
1568 1569
}

1570
/* This function is called if we are a slave node and our master serving
1571
 * a non-zero amount of hash slots is in FAIL state.
1572 1573 1574 1575 1576 1577 1578 1579
 *
 * 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) {
1580 1581 1582
    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;
1583
    int j;
1584 1585 1586 1587

    /* 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. */
1588
    if (data_age >
1589
        server.cluster_node_timeout * REDIS_CLUSTER_SLAVE_VALIDITY_MULT)
1590
        return;
1591 1592 1593 1594 1595 1596

    /* 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. */
1597 1598
    if (server.cluster->failover_auth_time == 0 ||
        auth_age >
1599
        server.cluster_node_timeout * REDIS_CLUSTER_FAILOVER_AUTH_RETRY_MULT)
1600
    {
1601
        redisLog(REDIS_WARNING,"Asking masters if I can failover...");
1602 1603
        server.cluster->failover_auth_time = time(NULL);
        server.cluster->failover_auth_count = 0;
1604
        clusterRequestFailoverAuth();
1605 1606 1607 1608
        return; /* Wait for replies. */
    }

    /* Check if we reached the quorum. */
1609
    if (server.cluster->failover_auth_count >= needed_quorum) {
1610 1611
        clusterNode *oldmaster = server.cluster->myself->slaveof;

1612 1613
        redisLog(REDIS_WARNING,
            "Masters quorum reached: failing over my (failing) master.");
A
antirez 已提交
1614 1615 1616 1617 1618 1619 1620 1621
        /* We have the quorum, perform all the steps to correctly promote
         * this slave to a master.
         *
         * 1) Turn this node into a master. */
        clusterNodeRemoveSlave(server.cluster->myself->slaveof,
                               server.cluster->myself);
        server.cluster->myself->flags &= ~REDIS_NODE_SLAVE;
        server.cluster->myself->flags |= REDIS_NODE_MASTER;
A
antirez 已提交
1622
        server.cluster->myself->flags |= REDIS_NODE_PROMOTED;
A
antirez 已提交
1623 1624 1625
        server.cluster->myself->slaveof = NULL;
        replicationUnsetMaster();

1626 1627 1628 1629 1630 1631 1632 1633
        /* 2) Claim all the slots assigned to our master. */
        for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
            if (clusterNodeGetSlotBit(oldmaster,j)) {
                clusterDelSlot(j);
                clusterAddSlot(server.cluster->myself,j);
            }
        }

1634
        /* 3) Pong all the other nodes so that they can update the state
A
antirez 已提交
1635
         *    accordingly and detect that we switched to master role. */
1636
        clusterBroadcastPong();
1637 1638 1639 1640

        /* 4) Update state and save config. */
        clusterUpdateState();
        clusterSaveConfigOrDie();
1641
    }
1642 1643
}

A
antirez 已提交
1644 1645 1646 1647 1648 1649 1650 1651
/* -----------------------------------------------------------------------------
 * CLUSTER cron job
 * -------------------------------------------------------------------------- */

/* This is executed 1 time every second */
void clusterCron(void) {
    dictIterator *di;
    dictEntry *de;
1652
    int j, update_state = 0;
1653 1654
    time_t min_pong = 0;
    clusterNode *min_pong_node = NULL;
A
antirez 已提交
1655

G
guiquanz 已提交
1656
    /* Check if we have disconnected nodes and re-establish the connection. */
1657
    di = dictGetSafeIterator(server.cluster->nodes);
A
antirez 已提交
1658
    while((de = dictNext(di)) != NULL) {
1659
        clusterNode *node = dictGetVal(de);
A
antirez 已提交
1660 1661

        if (node->flags & (REDIS_NODE_MYSELF|REDIS_NODE_NOADDR)) continue;
1662 1663 1664 1665 1666 1667 1668 1669 1670 1671

        /* A Node in HANDSHAKE state has a limited lifespan equal to the
         * configured node timeout. */
        if (node->flags & REDIS_NODE_HANDSHAKE &&
            server.unixtime - node->ctime > server.cluster_node_timeout)
        {
            freeClusterNode(node);
            continue;
        }

A
antirez 已提交
1672 1673
        if (node->link == NULL) {
            int fd;
1674
            time_t old_ping_sent;
A
antirez 已提交
1675 1676 1677 1678 1679 1680 1681 1682 1683
            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);
1684 1685 1686 1687
            /* Queue a PING in the new connection ASAP: this is crucial
             * to avoid false positives in failure detection.
             *
             * If the node is flagged as MEET, we send a MEET message instead
A
antirez 已提交
1688 1689
             * of a PING one, to force the receiver to add us in its node
             * table. */
1690
            old_ping_sent = node->ping_sent;
A
antirez 已提交
1691 1692
            clusterSendPing(link, node->flags & REDIS_NODE_MEET ?
                    CLUSTERMSG_TYPE_MEET : CLUSTERMSG_TYPE_PING);
1693 1694 1695 1696 1697 1698
            if (old_ping_sent) {
                /* If there was an active ping before the link was
                 * disconnected, we want to restore the ping time, otherwise
                 * replaced by the clusterSendPing() call. */
                node->ping_sent = old_ping_sent;
            }
A
antirez 已提交
1699 1700 1701 1702 1703 1704 1705
            /* 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;

1706
            redisLog(REDIS_DEBUG,"Connecting with Node %.40s at %s:%d", node->name, node->ip, node->port+REDIS_CLUSTER_PORT_INCR);
A
antirez 已提交
1707 1708 1709 1710 1711
        }
    }
    dictReleaseIterator(di);

    /* Ping some random node. Check a few random nodes and ping the one with
1712
     * the oldest pong_received time */
A
antirez 已提交
1713
    for (j = 0; j < 5; j++) {
1714
        de = dictGetRandomKey(server.cluster->nodes);
1715
        clusterNode *this = dictGetVal(de);
A
antirez 已提交
1716

1717 1718
        /* Don't ping nodes disconnected or with a ping currently active. */
        if (this->link == NULL || this->ping_sent != 0) continue;
A
antirez 已提交
1719
        if (this->flags & (REDIS_NODE_MYSELF|REDIS_NODE_HANDSHAKE)) continue;
1720 1721 1722
        if (min_pong_node == NULL || min_pong > this->pong_received) {
            min_pong_node = this;
            min_pong = this->pong_received;
A
antirez 已提交
1723 1724
        }
    }
1725 1726 1727
    if (min_pong_node) {
        redisLog(REDIS_DEBUG,"Pinging node %.40s", min_pong_node->name);
        clusterSendPing(min_pong_node->link, CLUSTERMSG_TYPE_PING);
A
antirez 已提交
1728 1729 1730
    }

    /* Iterate nodes to check if we need to flag something as failing */
1731
    di = dictGetSafeIterator(server.cluster->nodes);
A
antirez 已提交
1732
    while((de = dictNext(di)) != NULL) {
1733
        clusterNode *node = dictGetVal(de);
1734
        time_t now = time(NULL);
A
antirez 已提交
1735 1736 1737
        int delay;

        if (node->flags &
1738 1739
            (REDIS_NODE_MYSELF|REDIS_NODE_NOADDR|REDIS_NODE_HANDSHAKE))
                continue;
1740

1741 1742 1743 1744
        /* If we are waiting for the PONG more than half the cluster
         * timeout, reconnect the link: maybe there is a connection
         * issue even if the node is alive. */
        if (node->link && /* is connected */
1745 1746
            time(NULL) - node->link->ctime >
            server.cluster_node_timeout && /* was not already reconnected */
1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759
            node->ping_sent && /* we already sent a ping */
            node->pong_received < node->ping_sent && /* still waiting pong */
            /* and we are waiting for the pong more than timeout/2 */
            now - node->ping_sent > server.cluster_node_timeout/2)
        {
            /* Disconnect the link, it will be reconnected automatically. */
            freeClusterLink(node->link);
        }

        /* If we have currently no active ping in this instance, and the
         * received PONG is older than half the cluster timeout, send
         * a new ping now, to ensure all the nodes are pinged without
         * a too big delay. */
1760
        if (node->link &&
1761 1762
            node->ping_sent == 0 &&
            (now - node->pong_received) > server.cluster_node_timeout/2)
1763 1764 1765 1766 1767
        {
            clusterSendPing(node->link, CLUSTERMSG_TYPE_PING);
            continue;
        }

1768 1769
        /* Check only if we have an active ping for this instance. */
        if (node->ping_sent == 0) continue;
1770

1771 1772 1773 1774
        /* Compute the delay of the PONG. Note that if we already received
         * the PONG, then node->ping_sent is zero, so can't reach this
         * code at all. */
        delay = now - node->ping_sent;
1775

1776
        if (delay > server.cluster_node_timeout) {
G
guiquanz 已提交
1777
            /* Timeout reached. Set the node as possibly failing if it is
1778
             * not already in this state. */
1779
            if (!(node->flags & (REDIS_NODE_PFAIL|REDIS_NODE_FAIL))) {
A
antirez 已提交
1780 1781 1782
                redisLog(REDIS_DEBUG,"*** NODE %.40s possibly failing",
                    node->name);
                node->flags |= REDIS_NODE_PFAIL;
1783
                update_state = 1;
A
antirez 已提交
1784 1785 1786 1787
            }
        }
    }
    dictReleaseIterator(di);
1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799

    /* 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);
    }
1800

1801
    /* If we are a slave and our master is down, but is serving slots,
1802 1803 1804 1805 1806
     * call the function that handles the failover.
     * This function is called with a small delay in order to let the
     * FAIL message to propagate after failure detection, this is not
     * strictly required but makes 99.99% of failovers mechanically
     * simpler. */
1807 1808 1809
    if (server.cluster->myself->flags & REDIS_NODE_SLAVE &&
        server.cluster->myself->slaveof &&
        server.cluster->myself->slaveof->flags & REDIS_NODE_FAIL &&
1810 1811
        (server.unixtime - server.cluster->myself->slaveof->fail_time) >
         REDIS_CLUSTER_FAILOVER_DELAY &&
1812 1813 1814 1815 1816
        server.cluster->myself->slaveof->numslots != 0)
    {
        clusterHandleSlaveFailover();
    }

1817
    if (update_state) clusterUpdateState();
A
antirez 已提交
1818 1819 1820 1821 1822 1823
}

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

1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845
/* 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 已提交
1846 1847
/* Set the slot bit and return the old value. */
int clusterNodeSetSlotBit(clusterNode *n, int slot) {
1848 1849
    int old = bitmapTestBit(n->slots,slot);
    bitmapSetBit(n->slots,slot);
1850
    if (!old) n->numslots++;
A
antirez 已提交
1851 1852 1853 1854 1855
    return old;
}

/* Clear the slot bit and return the old value. */
int clusterNodeClearSlotBit(clusterNode *n, int slot) {
1856 1857
    int old = bitmapTestBit(n->slots,slot);
    bitmapClearBit(n->slots,slot);
1858
    if (old) n->numslots--;
A
antirez 已提交
1859 1860 1861 1862 1863
    return old;
}

/* Return the slot bit from the cluster node structure. */
int clusterNodeGetSlotBit(clusterNode *n, int slot) {
1864
    return bitmapTestBit(n->slots,slot);
A
antirez 已提交
1865 1866 1867 1868 1869 1870 1871
}

/* 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) {
1872 1873
    if (server.cluster->slots[slot]) return REDIS_ERR;
    clusterNodeSetSlotBit(n,slot);
1874
    server.cluster->slots[slot] = n;
A
antirez 已提交
1875 1876 1877
    return REDIS_OK;
}

A
antirez 已提交
1878 1879 1880 1881
/* 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) {
1882
    clusterNode *n = server.cluster->slots[slot];
A
antirez 已提交
1883 1884 1885

    if (!n) return REDIS_ERR;
    redisAssert(clusterNodeClearSlotBit(n,slot) == 1);
1886
    server.cluster->slots[slot] = NULL;
A
antirez 已提交
1887 1888 1889
    return REDIS_OK;
}

1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901
/* Delete all the slots associated with the specified node.
 * The number of deleted slots is returned. */
int clusterDelNodeSlots(clusterNode *node) {
    int deleted = 0, j;

    for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
        if (clusterNodeGetSlotBit(node,j)) clusterDelSlot(j);
        deleted++;
    }
    return deleted;
}

A
antirez 已提交
1902 1903 1904 1905
/* -----------------------------------------------------------------------------
 * Cluster state evaluation function
 * -------------------------------------------------------------------------- */
void clusterUpdateState(void) {
1906
    int j, initial_state = server.cluster->state;
1907
    int unreachable_masters = 0;
A
antirez 已提交
1908

1909 1910 1911 1912
    /* Start assuming the state is OK. We'll turn it into FAIL if there
     * are the right conditions. */
    server.cluster->state = REDIS_CLUSTER_OK;

1913
    /* Check if all the slots are covered. */
A
antirez 已提交
1914
    for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
1915 1916
        if (server.cluster->slots[j] == NULL ||
            server.cluster->slots[j]->flags & (REDIS_NODE_FAIL))
A
antirez 已提交
1917
        {
1918
            server.cluster->state = REDIS_CLUSTER_FAIL;
A
antirez 已提交
1919 1920 1921
            break;
        }
    }
1922

1923
    /* Compute the cluster size, that is the number of master nodes
1924 1925 1926 1927
     * serving at least a single slot.
     *
     * At the same time count the number of unreachable masters with
     * at least one node. */
1928 1929 1930 1931 1932
    {
        dictIterator *di;
        dictEntry *de;

        server.cluster->size = 0;
1933
        di = dictGetSafeIterator(server.cluster->nodes);
1934 1935 1936
        while((de = dictNext(di)) != NULL) {
            clusterNode *node = dictGetVal(de);

1937
            if (node->flags & REDIS_NODE_MASTER && node->numslots) {
1938
                server.cluster->size++;
1939 1940 1941
                if (node->flags & (REDIS_NODE_FAIL|REDIS_NODE_PFAIL))
                    unreachable_masters++;
            }
1942 1943 1944
        }
        dictReleaseIterator(di);
    }
1945

1946 1947 1948 1949 1950 1951 1952 1953 1954 1955
    /* 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;
    }

1956 1957 1958 1959
    /* 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 已提交
1960 1961
}

1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984
/* 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) {
1985 1986 1987
    int j;
    int update_config = 0;

1988 1989 1990 1991
    /* 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;

1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025
    /* 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();
2026 2027 2028
    return REDIS_OK;
}

2029 2030 2031 2032
/* -----------------------------------------------------------------------------
 * SLAVE nodes handling
 * -------------------------------------------------------------------------- */

2033 2034
/* Set the specified node 'n' as master. Setup the node as a slave if
 * needed. */
2035 2036 2037 2038
void clusterSetMaster(clusterNode *n) {
    clusterNode *myself = server.cluster->myself;

    redisAssert(n != myself);
2039
    redisAssert(myself->numslots == 0);
2040 2041 2042 2043 2044

    if (myself->flags & REDIS_NODE_MASTER) {
        myself->flags &= ~REDIS_NODE_MASTER;
        myself->flags |= REDIS_NODE_SLAVE;
    }
2045 2046 2047
    /* Clear the promoted flag anyway if we are a slave, to ensure it will
     * be set only when the node turns into a master because of fail over. */
    myself->flags &= ~REDIS_NODE_PROMOTED;
2048
    myself->slaveof = n;
2049
    replicationSetMaster(n->ip, n->port);
2050 2051
}

A
antirez 已提交
2052 2053 2054 2055
/* -----------------------------------------------------------------------------
 * CLUSTER command
 * -------------------------------------------------------------------------- */

2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068
/* Generate a csv-alike representation of the nodes we are aware of,
 * including the "myself" node, and return an SDS string containing the
 * representation (it is up to the caller to free it).
 *
 * All the nodes matching at least one of the node flags specified in
 * "filter" are excluded from the output, so using zero as a filter will
 * include all the known nodes in the representation, including nodes in
 * the HANDSHAKE state.
 *
 * The representation obtained using this function is used for the output
 * of the CLUSTER NODES function, and as format for the cluster
 * configuration file (nodes.conf) for a given node. */
sds clusterGenNodesDescription(int filter) {
A
antirez 已提交
2069 2070 2071
    sds ci = sdsempty();
    dictIterator *di;
    dictEntry *de;
2072
    int j, start;
A
antirez 已提交
2073

2074
    di = dictGetSafeIterator(server.cluster->nodes);
A
antirez 已提交
2075
    while((de = dictNext(di)) != NULL) {
2076
        clusterNode *node = dictGetVal(de);
A
antirez 已提交
2077

2078 2079
        if (node->flags & filter) continue;

A
antirez 已提交
2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094
        /* 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,");
A
antirez 已提交
2095
        if (node->flags & REDIS_NODE_PROMOTED) ci = sdscat(ci,"promoted,");
A
antirez 已提交
2096 2097 2098 2099 2100 2101 2102 2103 2104
        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 */
2105
        ci = sdscatprintf(ci,"%ld %ld %llu %s",
A
antirez 已提交
2106 2107
            (long) node->ping_sent,
            (long) node->pong_received,
2108
            (unsigned long long) node->configEpoch,
2109 2110
            (node->link || node->flags & REDIS_NODE_MYSELF) ?
                        "connected" : "disconnected");
2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130

        /* 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;
            }
        }
2131 2132 2133 2134 2135 2136

        /* 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++) {
2137
                if (server.cluster->migrating_slots_to[j]) {
A
antirez 已提交
2138
                    ci = sdscatprintf(ci," [%d->-%.40s]",j,
2139 2140
                        server.cluster->migrating_slots_to[j]->name);
                } else if (server.cluster->importing_slots_from[j]) {
A
antirez 已提交
2141
                    ci = sdscatprintf(ci," [%d-<-%.40s]",j,
2142
                        server.cluster->importing_slots_from[j]->name);
2143 2144 2145
                }
            }
        }
2146
        ci = sdscatlen(ci,"\n",1);
A
antirez 已提交
2147 2148 2149 2150 2151
    }
    dictReleaseIterator(di);
    return ci;
}

2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163
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 已提交
2164 2165 2166 2167 2168 2169 2170
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) {
2171
        /* CLUSTER MEET <ip> <port> */
A
antirez 已提交
2172
        clusterNode *n;
2173
        struct sockaddr_storage sa;
A
antirez 已提交
2174 2175 2176
        long port;

        /* Perform sanity checks on IP/port */
2177 2178 2179 2180 2181 2182 2183 2184 2185
        if (inet_pton(AF_INET,c->argv[2]->ptr,
            &(((struct sockaddr_in *)&sa)->sin_addr)))
        {
            sa.ss_family = AF_INET;
        } else if (inet_pton(AF_INET6,c->argv[2]->ptr,
            &(((struct sockaddr_in6 *)&sa)->sin6_addr)))
        {
            sa.ss_family = AF_INET6;
        } else {
A
antirez 已提交
2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198
            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);
2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209

        /* Set node->ip as the normalized string representation of the node
         * IP address. */
        if (sa.ss_family == AF_INET)
            inet_ntop(AF_INET,
                (void*)&(((struct sockaddr_in *)&sa)->sin_addr),
                n->ip,REDIS_CLUSTER_IPLEN);
        else
            inet_ntop(AF_INET6,
                (void*)&(((struct sockaddr_in6 *)&sa)->sin6_addr),
                n->ip,REDIS_CLUSTER_IPLEN);
A
antirez 已提交
2210 2211 2212 2213
        n->port = port;
        clusterAddNode(n);
        addReply(c,shared.ok);
    } else if (!strcasecmp(c->argv[1]->ptr,"nodes") && c->argc == 2) {
2214
        /* CLUSTER NODES */
A
antirez 已提交
2215
        robj *o;
2216
        sds ci = clusterGenNodesDescription(0);
A
antirez 已提交
2217 2218 2219 2220

        o = createObject(REDIS_STRING,ci);
        addReplyBulk(c,o);
        decrRefCount(o);
2221 2222 2223 2224 2225 2226 2227 2228 2229 2230
    } else if (!strcasecmp(c->argv[1]->ptr,"flushslots") && c->argc == 2) {
        /* CLUSTER FLUSHSLOTS */
        if (dictSize(server.db[0].dict) != 0) {
            addReplyError(c,"DB must be empty to perform CLUSTER FLUSHSLOTS.");
            return;
        }
        clusterDelNodeSlots(server.cluster->myself);
        clusterUpdateState();
        clusterSaveConfigOrDie();
        addReply(c,shared.ok);
A
antirez 已提交
2231
    } else if ((!strcasecmp(c->argv[1]->ptr,"addslots") ||
A
antirez 已提交
2232 2233 2234 2235
               !strcasecmp(c->argv[1]->ptr,"delslots")) && c->argc >= 3)
    {
        /* CLUSTER ADDSLOTS <slot> [slot] ... */
        /* CLUSTER DELSLOTS <slot> [slot] ... */
2236
        int j, slot;
A
antirez 已提交
2237
        unsigned char *slots = zmalloc(REDIS_CLUSTER_SLOTS);
A
antirez 已提交
2238
        int del = !strcasecmp(c->argv[1]->ptr,"delslots");
A
antirez 已提交
2239 2240 2241 2242 2243

        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++) {
2244
            if ((slot = getSlotOrReply(c,c->argv[j])) == -1) {
A
antirez 已提交
2245 2246 2247
                zfree(slots);
                return;
            }
2248
            if (del && server.cluster->slots[slot] == NULL) {
2249
                addReplyErrorFormat(c,"Slot %d is already unassigned", slot);
A
antirez 已提交
2250 2251
                zfree(slots);
                return;
2252
            } else if (!del && server.cluster->slots[slot]) {
2253
                addReplyErrorFormat(c,"Slot %d is already busy", slot);
A
antirez 已提交
2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265
                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]) {
2266 2267 2268 2269
                int retval;

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

                retval = del ? clusterDelSlot(j) :
2274
                               clusterAddSlot(server.cluster->myself,j);
2275
                redisAssertWithInfo(c,NULL,retval == REDIS_OK);
A
antirez 已提交
2276 2277 2278 2279
            }
        }
        zfree(slots);
        clusterUpdateState();
A
antirez 已提交
2280
        clusterSaveConfigOrDie();
A
antirez 已提交
2281
        addReply(c,shared.ok);
2282
    } else if (!strcasecmp(c->argv[1]->ptr,"setslot") && c->argc >= 4) {
A
antirez 已提交
2283 2284
        /* SETSLOT 10 MIGRATING <node ID> */
        /* SETSLOT 10 IMPORTING <node ID> */
2285
        /* SETSLOT 10 STABLE */
A
antirez 已提交
2286
        /* SETSLOT 10 NODE <node ID> */
2287
        int slot;
2288 2289
        clusterNode *n;

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

2292
        if (!strcasecmp(c->argv[3]->ptr,"migrating") && c->argc == 5) {
2293
            if (server.cluster->slots[slot] != server.cluster->myself) {
2294 2295 2296
                addReplyErrorFormat(c,"I'm not the owner of hash slot %u",slot);
                return;
            }
2297 2298 2299 2300 2301
            if ((n = clusterLookupNode(c->argv[4]->ptr)) == NULL) {
                addReplyErrorFormat(c,"I don't know about node %s",
                    (char*)c->argv[4]->ptr);
                return;
            }
2302
            server.cluster->migrating_slots_to[slot] = n;
2303
        } else if (!strcasecmp(c->argv[3]->ptr,"importing") && c->argc == 5) {
2304
            if (server.cluster->slots[slot] == server.cluster->myself) {
2305 2306 2307 2308
                addReplyErrorFormat(c,
                    "I'm already the owner of hash slot %u",slot);
                return;
            }
2309 2310 2311 2312 2313
            if ((n = clusterLookupNode(c->argv[4]->ptr)) == NULL) {
                addReplyErrorFormat(c,"I don't know about node %s",
                    (char*)c->argv[3]->ptr);
                return;
            }
2314
            server.cluster->importing_slots_from[slot] = n;
2315
        } else if (!strcasecmp(c->argv[3]->ptr,"stable") && c->argc == 4) {
2316
            /* CLUSTER SETSLOT <SLOT> STABLE */
2317 2318
            server.cluster->importing_slots_from[slot] = NULL;
            server.cluster->migrating_slots_to[slot] = NULL;
2319
        } else if (!strcasecmp(c->argv[3]->ptr,"node") && c->argc == 5) {
2320 2321 2322
            /* CLUSTER SETSLOT <SLOT> NODE <NODE ID> */
            clusterNode *n = clusterLookupNode(c->argv[4]->ptr);

2323 2324 2325 2326 2327
            if (!n) {
                addReplyErrorFormat(c,"Unknown node %s",
                    (char*)c->argv[4]->ptr);
                return;
            }
2328 2329
            /* If this hash slot was served by 'myself' before to switch
             * make sure there are no longer local keys for this hash slot. */
2330 2331
            if (server.cluster->slots[slot] == server.cluster->myself &&
                n != server.cluster->myself)
2332
            {
2333
                if (countKeysInSlot(slot) != 0) {
2334 2335 2336 2337
                    addReplyErrorFormat(c, "Can't assign hashslot %d to a different node while I still hold keys for this hash slot.", slot);
                    return;
                }
            }
2338 2339 2340
            /* 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. */
2341 2342 2343
            if (server.cluster->slots[slot] == server.cluster->myself &&
                server.cluster->migrating_slots_to[slot])
                server.cluster->migrating_slots_to[slot] = NULL;
2344

2345 2346
            /* If this node was importing this slot, assigning the slot to
             * itself also clears the importing status. */
2347 2348
            if (n == server.cluster->myself &&
                server.cluster->importing_slots_from[slot])
2349
                server.cluster->importing_slots_from[slot] = NULL;
2350 2351
            clusterDelSlot(slot);
            clusterAddSlot(n,slot);
2352 2353
        } else {
            addReplyError(c,"Invalid CLUSTER SETSLOT action or number of arguments");
2354
            return;
2355
        }
2356
        clusterUpdateState();
A
antirez 已提交
2357
        clusterSaveConfigOrDie();
2358
        addReply(c,shared.ok);
A
antirez 已提交
2359
    } else if (!strcasecmp(c->argv[1]->ptr,"info") && c->argc == 2) {
2360
        /* CLUSTER INFO */
A
antirez 已提交
2361 2362 2363 2364 2365
        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++) {
2366
            clusterNode *n = server.cluster->slots[j];
A
antirez 已提交
2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384

            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"
2385
            "cluster_known_nodes:%lu\r\n"
2386
            "cluster_size:%d\r\n"
2387
            , statestr[server.cluster->state],
A
antirez 已提交
2388 2389 2390
            slots_assigned,
            slots_ok,
            slots_pfail,
2391
            slots_fail,
2392 2393
            dictSize(server.cluster->nodes),
            server.cluster->size
A
antirez 已提交
2394 2395 2396 2397 2398
        );
        addReplySds(c,sdscatprintf(sdsempty(),"$%lu\r\n",
            (unsigned long)sdslen(info)));
        addReplySds(c,info);
        addReply(c,shared.crlf);
2399 2400 2401 2402 2403 2404 2405 2406
    } else if (!strcasecmp(c->argv[1]->ptr,"saveconfig") && c->argc == 2) {
        int retval = clusterSaveConfig();

        if (retval == 0)
            addReply(c,shared.ok);
        else
            addReplyErrorFormat(c,"error saving the cluster node config: %s",
                strerror(errno));
A
antirez 已提交
2407
    } else if (!strcasecmp(c->argv[1]->ptr,"keyslot") && c->argc == 3) {
2408
        /* CLUSTER KEYSLOT <key> */
A
antirez 已提交
2409 2410 2411
        sds key = c->argv[2]->ptr;

        addReplyLongLong(c,keyHashSlot(key,sdslen(key)));
2412
    } else if (!strcasecmp(c->argv[1]->ptr,"countkeysinslot") && c->argc == 3) {
2413
        /* CLUSTER COUNTKEYSINSLOT <slot> */
2414 2415 2416 2417
        long long slot;

        if (getLongLongFromObjectOrReply(c,c->argv[2],&slot,NULL) != REDIS_OK)
            return;
2418 2419 2420 2421
        if (slot < 0 || slot >= REDIS_CLUSTER_SLOTS) {
            addReplyError(c,"Invalid slot");
            return;
        }
2422
        addReplyLongLong(c,countKeysInSlot(slot));
A
antirez 已提交
2423
    } else if (!strcasecmp(c->argv[1]->ptr,"getkeysinslot") && c->argc == 4) {
2424
        /* CLUSTER GETKEYSINSLOT <slot> <count> */
A
antirez 已提交
2425
        long long maxkeys, slot;
2426
        unsigned int numkeys, j;
A
antirez 已提交
2427 2428 2429 2430 2431 2432
        robj **keys;

        if (getLongLongFromObjectOrReply(c,c->argv[2],&slot,NULL) != REDIS_OK)
            return;
        if (getLongLongFromObjectOrReply(c,c->argv[3],&maxkeys,NULL) != REDIS_OK)
            return;
2433
        if (slot < 0 || slot >= REDIS_CLUSTER_SLOTS || maxkeys < 0) {
A
antirez 已提交
2434 2435 2436 2437 2438
            addReplyError(c,"Invalid slot or number of keys");
            return;
        }

        keys = zmalloc(sizeof(robj*)*maxkeys);
2439
        numkeys = getKeysInSlot(slot, keys, maxkeys);
A
antirez 已提交
2440 2441 2442
        addReplyMultiBulkLen(c,numkeys);
        for (j = 0; j < numkeys; j++) addReplyBulk(c,keys[j]);
        zfree(keys);
A
antirez 已提交
2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454
    } 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);
2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487
    } 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);
2488 2489
        clusterUpdateState();
        clusterSaveConfigOrDie();
2490
        addReply(c,shared.ok);
A
antirez 已提交
2491 2492 2493 2494 2495 2496
    } else {
        addReplyError(c,"Wrong CLUSTER subcommand or number of arguments");
    }
}

/* -----------------------------------------------------------------------------
2497
 * DUMP, RESTORE and MIGRATE commands
A
antirez 已提交
2498 2499
 * -------------------------------------------------------------------------- */

2500 2501 2502
/* 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) {
2503 2504
    unsigned char buf[2];
    uint64_t crc;
2505 2506 2507 2508 2509 2510 2511 2512

    /* 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:
2513 2514 2515 2516 2517
     * ----------------+---------------------+---------------+
     * ... RDB payload | 2 bytes RDB version | 8 bytes CRC64 |
     * ----------------+---------------------+---------------+
     * RDB version and CRC are both in little endian.
     */
2518 2519

    /* RDB version */
2520 2521
    buf[0] = REDIS_RDB_VERSION & 0xff;
    buf[1] = (REDIS_RDB_VERSION >> 8) & 0xff;
2522 2523
    payload->io.buffer.ptr = sdscatlen(payload->io.buffer.ptr,buf,2);

2524
    /* CRC64 */
2525
    crc = crc64(0,(unsigned char*)payload->io.buffer.ptr,
2526 2527 2528
                sdslen(payload->io.buffer.ptr));
    memrev64ifbe(&crc);
    payload->io.buffer.ptr = sdscatlen(payload->io.buffer.ptr,&crc,8);
2529 2530 2531
}

/* Verify that the RDB version of the dump payload matches the one of this Redis
2532
 * instance and that the checksum is ok.
2533 2534 2535
 * If the DUMP payload looks valid REDIS_OK is returned, otherwise REDIS_ERR
 * is returned. */
int verifyDumpPayload(unsigned char *p, size_t len) {
2536
    unsigned char *footer;
2537
    uint16_t rdbver;
2538
    uint64_t crc;
2539

2540
    /* At least 2 bytes of RDB version and 8 of CRC64 should be present. */
2541 2542
    if (len < 10) return REDIS_ERR;
    footer = p+(len-10);
2543 2544

    /* Verify RDB version */
2545
    rdbver = (footer[1] << 8) | footer[0];
2546
    if (rdbver != REDIS_RDB_VERSION) return REDIS_ERR;
2547

2548
    /* Verify CRC64 */
2549
    crc = crc64(0,p,len-8);
2550 2551
    memrev64ifbe(&crc);
    return (memcmp(&crc,footer+2,8) == 0) ? REDIS_OK : REDIS_ERR;
2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576
}

/* 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 已提交
2577
/* RESTORE key ttl serialized-value [REPLACE] */
A
antirez 已提交
2578 2579
void restoreCommand(redisClient *c) {
    long ttl;
2580
    rio payload;
A
antirez 已提交
2581
    int j, type, replace = 0;
2582
    robj *obj;
A
antirez 已提交
2583

A
antirez 已提交
2584 2585 2586 2587 2588 2589 2590 2591 2592 2593
    /* 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 已提交
2594
    /* Make sure this key does not already exist here... */
A
antirez 已提交
2595
    if (!replace && lookupKeyWrite(c->db,c->argv[1]) != NULL) {
A
antirez 已提交
2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607
        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;
    }

2608
    /* Verify RDB version and data checksum. */
2609 2610 2611 2612 2613
    if (verifyDumpPayload(c->argv[3]->ptr,sdslen(c->argv[3]->ptr)) == REDIS_ERR) {
        addReplyError(c,"DUMP payload version or checksum are wrong");
        return;
    }

2614
    rioInitWithBuffer(&payload,c->argv[3]->ptr);
2615 2616
    if (((type = rdbLoadObjectType(&payload)) == -1) ||
        ((obj = rdbLoadObject(type,&payload)) == NULL))
2617
    {
2618
        addReplyError(c,"Bad data format");
A
antirez 已提交
2619 2620 2621
        return;
    }

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

A
antirez 已提交
2625
    /* Create the key and set the TTL if any */
2626
    dbAdd(c->db,c->argv[1],obj);
2627
    if (ttl) setExpire(c->db,c->argv[1],mstime()+ttl);
2628
    signalModifiedKey(c->db,c->argv[1]);
A
antirez 已提交
2629
    addReply(c,shared.ok);
2630
    server.dirty++;
A
antirez 已提交
2631 2632
}

A
antirez 已提交
2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692
/* 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;
    }
2693
    anetEnableTcpNoDelay(server.neterr,fd);
A
antirez 已提交
2694 2695

    /* Check if it connects within the specified timeout. */
2696
    if ((aeWait(fd,AE_WRITABLE,timeout) & AE_WRITABLE) == 0) {
A
antirez 已提交
2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746
        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 已提交
2747
/* MIGRATE host port key dbid timeout [COPY | REPLACE] */
A
antirez 已提交
2748
void migrateCommand(redisClient *c) {
A
antirez 已提交
2749
    int fd, copy, replace, j;
A
antirez 已提交
2750 2751
    long timeout;
    long dbid;
A
antirez 已提交
2752
    long long ttl, expireat;
A
antirez 已提交
2753
    robj *o;
2754
    rio cmd, payload;
A
antirez 已提交
2755 2756 2757 2758 2759 2760 2761
    int retry_num = 0;

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

A
antirez 已提交
2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774
    /* 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 已提交
2775 2776 2777 2778 2779
    /* Sanity check */
    if (getLongFromObjectOrReply(c,c->argv[5],&timeout,NULL) != REDIS_OK)
        return;
    if (getLongFromObjectOrReply(c,c->argv[4],&dbid,NULL) != REDIS_OK)
        return;
2780
    if (timeout <= 0) timeout = 1000;
A
antirez 已提交
2781 2782 2783 2784 2785

    /* 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) {
2786
        addReplySds(c,sdsnew("+NOKEY\r\n"));
A
antirez 已提交
2787 2788 2789 2790
        return;
    }
    
    /* Connect */
A
antirez 已提交
2791 2792
    fd = migrateGetSocket(c,c->argv[1],c->argv[2],timeout);
    if (fd == -1) return; /* error sent to the client by migrateGetSocket() */
A
antirez 已提交
2793

2794
    /* Create RESTORE payload and generate the protocol to call the command. */
2795
    rioInitWithBuffer(&cmd,sdsempty());
2796 2797 2798
    redisAssertWithInfo(c,NULL,rioWriteBulkCount(&cmd,'*',2));
    redisAssertWithInfo(c,NULL,rioWriteBulkString(&cmd,"SELECT",6));
    redisAssertWithInfo(c,NULL,rioWriteBulkLongLong(&cmd,dbid));
A
antirez 已提交
2799

A
antirez 已提交
2800 2801 2802 2803 2804
    expireat = getExpire(c->db,c->argv[3]);
    if (expireat != -1) {
        ttl = expireat-mstime();
        if (ttl < 1) ttl = 1;
    }
A
antirez 已提交
2805
    redisAssertWithInfo(c,NULL,rioWriteBulkCount(&cmd,'*',replace ? 5 : 4));
2806 2807 2808 2809 2810
    if (server.cluster_enabled)
        redisAssertWithInfo(c,NULL,
            rioWriteBulkString(&cmd,"RESTORE-ASKING",14));
    else
        redisAssertWithInfo(c,NULL,rioWriteBulkString(&cmd,"RESTORE",7));
2811
    redisAssertWithInfo(c,NULL,sdsEncodedObject(c->argv[3]));
2812
    redisAssertWithInfo(c,NULL,rioWriteBulkString(&cmd,c->argv[3]->ptr,sdslen(c->argv[3]->ptr)));
2813
    redisAssertWithInfo(c,NULL,rioWriteBulkLongLong(&cmd,ttl));
A
antirez 已提交
2814

G
guiquanz 已提交
2815
    /* Emit the payload argument, that is the serialized object using
A
antirez 已提交
2816
     * the DUMP format. */
2817 2818 2819
    createDumpPayload(&payload,o);
    redisAssertWithInfo(c,NULL,rioWriteBulkString(&cmd,payload.io.buffer.ptr,
                                sdslen(payload.io.buffer.ptr)));
2820 2821
    sdsfree(payload.io.buffer.ptr);

A
antirez 已提交
2822 2823 2824 2825 2826
    /* 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 已提交
2827
    /* Transfer the query to the other node in 64K chunks. */
A
antirez 已提交
2828
    errno = 0;
A
antirez 已提交
2829
    {
2830 2831 2832 2833 2834 2835
        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);
2836
            nwritten = syncWrite(fd,buf+pos,towrite,timeout);
2837 2838
            if (nwritten != (signed)towrite) goto socket_wr_err;
            pos += nwritten;
A
antirez 已提交
2839 2840 2841
        }
    }

2842
    /* Read back the reply. */
A
antirez 已提交
2843 2844 2845 2846 2847 2848 2849 2850
    {
        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)
2851
            goto socket_rd_err;
A
antirez 已提交
2852 2853 2854 2855
        if (buf1[0] == '-' || buf2[0] == '-') {
            addReplyErrorFormat(c,"Target instance replied with error: %s",
                (buf1[0] == '-') ? buf1+1 : buf2+1);
        } else {
2856 2857
            robj *aux;

A
antirez 已提交
2858 2859 2860 2861 2862
            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 已提交
2863
            addReply(c,shared.ok);
2864 2865 2866
            server.dirty++;

            /* Translate MIGRATE as DEL for replication/AOF. */
A
antirez 已提交
2867
            aux = createStringObject("DEL",3);
2868 2869
            rewriteClientCommandVector(c,2,aux,c->argv[3]);
            decrRefCount(aux);
A
antirez 已提交
2870 2871 2872
        }
    }

2873
    sdsfree(cmd.io.buffer.ptr);
2874
    return;
A
antirez 已提交
2875 2876

socket_wr_err:
2877
    sdsfree(cmd.io.buffer.ptr);
A
antirez 已提交
2878
    migrateCloseSocket(c->argv[1],c->argv[2]);
A
antirez 已提交
2879 2880 2881
    if (errno != ETIMEDOUT && retry_num++ == 0) goto try_again;
    addReplySds(c,
        sdsnew("-IOERR error or timeout writing to target instance\r\n"));
2882
    return;
A
antirez 已提交
2883 2884

socket_rd_err:
2885
    sdsfree(cmd.io.buffer.ptr);
A
antirez 已提交
2886
    migrateCloseSocket(c->argv[1],c->argv[2]);
A
antirez 已提交
2887 2888 2889
    if (errno != ETIMEDOUT && retry_num++ == 0) goto try_again;
    addReplySds(c,
        sdsnew("-IOERR error or timeout reading from target node\r\n"));
2890 2891 2892
    return;
}

2893
/* The ASKING command is required after a -ASK redirection.
G
guiquanz 已提交
2894
 * The client should issue ASKING before to actually send the command to
2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905
 * 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 已提交
2906 2907 2908 2909
/* -----------------------------------------------------------------------------
 * Cluster functions related to serving / redirecting clients
 * -------------------------------------------------------------------------- */

2910 2911 2912
/* 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 已提交
2913
 *
2914 2915 2916 2917
 * 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.
 *
2918 2919
 * If the command contains multiple keys, and as a consequence it is not
 * possible to handle the request in Redis Cluster, NULL is returned. */
2920
clusterNode *getNodeByQuery(redisClient *c, struct redisCommand *cmd, robj **argv, int argc, int *hashslot, int *ask) {
A
antirez 已提交
2921
    clusterNode *n = NULL;
2922
    robj *firstkey = NULL;
A
antirez 已提交
2923 2924
    multiState *ms, _ms;
    multiCmd mc;
2925
    int i, slot = 0;
A
antirez 已提交
2926 2927 2928 2929 2930 2931

    /* 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. */
2932
        if (!(c->flags & REDIS_MULTI)) return server.cluster->myself;
A
antirez 已提交
2933 2934
        ms = &c->mstate;
    } else {
2935 2936 2937
        /* 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 已提交
2938 2939 2940 2941 2942 2943 2944 2945
        ms = &_ms;
        _ms.commands = &mc;
        _ms.count = 1;
        mc.argv = argv;
        mc.argc = argc;
        mc.cmd = cmd;
    }

2946 2947
    /* Check that all the keys are the same key, and get the slot and
     * node for this key. */
A
antirez 已提交
2948 2949 2950 2951 2952 2953 2954 2955 2956 2957
    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,
2958
                                      REDIS_GETKEYS_ALL);
A
antirez 已提交
2959
        for (j = 0; j < numkeys; j++) {
2960 2961 2962 2963 2964 2965
            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));
2966
                n = server.cluster->slots[slot];
2967
                redisAssertWithInfo(c,firstkey,n != NULL);
A
antirez 已提交
2968
            } else {
2969 2970 2971 2972 2973 2974
                /* 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 已提交
2975 2976 2977 2978
            }
        }
        getKeysFreeResult(keyindex);
    }
2979 2980 2981
    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. */
2982
    if (n == NULL) return server.cluster->myself;
2983 2984 2985 2986 2987
    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. */
2988 2989
    if (n == server.cluster->myself &&
        server.cluster->migrating_slots_to[slot] != NULL)
2990 2991 2992
    {
        if (lookupKeyRead(&server.db[0],firstkey) == NULL) {
            if (ask) *ask = 1;
2993
            return server.cluster->migrating_slots_to[slot];
2994 2995 2996 2997
        }
    }
    /* 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
2998 2999
     * it is assigned to a different node, but only if the client
     * issued an ASKING command before. */
3000
    if (server.cluster->importing_slots_from[slot] != NULL &&
3001
        (c->flags & REDIS_ASKING || cmd->flags & REDIS_CMD_ASKING)) {
3002
        return server.cluster->myself;
3003
    }
3004 3005
    /* It's not a -ASK case. Base case: just return the right node. */
    return n;
A
antirez 已提交
3006
}