cluster.c 131.1 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 "cluster.h"
33
#include "endianconv.h"
A
antirez 已提交
34

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

43 44
clusterNode *createClusterNode(char *nodename, int flags);
int clusterAddNode(clusterNode *node);
A
antirez 已提交
45 46 47 48
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);
49
void clusterSendFailoverAuthIfNeeded(clusterNode *node, clusterMsg *request);
A
antirez 已提交
50 51
void clusterUpdateState(void);
int clusterNodeGetSlotBit(clusterNode *n, int slot);
52
sds clusterGenNodesDescription(int filter);
53 54
clusterNode *clusterLookupNode(char *name);
int clusterNodeAddSlave(clusterNode *master, clusterNode *slave);
55
int clusterAddSlot(clusterNode *n, int slot);
56
int clusterDelSlot(int slot);
57
int clusterDelNodeSlots(clusterNode *node);
58
int clusterNodeSetSlotBit(clusterNode *n, int slot);
59
void clusterSetMaster(clusterNode *n);
60
void clusterHandleSlaveFailover(void);
61
int bitmapTestBit(unsigned char *bitmap, int pos);
A
antirez 已提交
62
void clusterDoBeforeSleep(int flags);
63
void clusterSendUpdate(clusterLink *link, clusterNode *node);
A
antirez 已提交
64 65 66 67 68

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

69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
/* 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 已提交
86 87
int clusterLoadConfig(char *filename) {
    FILE *fp = fopen(filename,"r");
A
antirez 已提交
88
    char *line;
89
    int maxline, j;
A
antirez 已提交
90
   
A
antirez 已提交
91
    if (fp == NULL) return REDIS_ERR;
A
antirez 已提交
92 93 94

    /* 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.
95 96 97 98 99 100
     * 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 已提交
101 102 103
    line = zmalloc(maxline);
    while(fgets(line,maxline,fp) != NULL) {
        int argc;
104
        sds *argv;
105 106 107
        clusterNode *n, *master;
        char *p, *s;

108 109 110 111 112 113 114 115 116
        /* Skip blank lines, they can be created either by users manually
         * editing nodes.conf or by the config writing process if stopped
         * before the truncate() call. */
        if (line[0] == '\n') continue;

        /* Split the line into arguments for processing. */
        argv = sdssplitargs(line,&argc);
        if (argv == NULL) goto fmterr;

117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
        /* 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")) {
135 136
                redisAssert(server.cluster->myself == NULL);
                server.cluster->myself = n;
137 138 139 140 141 142 143 144 145
                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;
146
                n->fail_time = mstime();
147 148 149 150
            } else if (!strcasecmp(s,"handshake")) {
                n->flags |= REDIS_NODE_HANDSHAKE;
            } else if (!strcasecmp(s,"noaddr")) {
                n->flags |= REDIS_NODE_NOADDR;
151 152
            } else if (!strcasecmp(s,"noflags")) {
                /* nothing to do */
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
            } 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);
        }

171
        /* Set ping sent / pong received timestamps */
172 173
        if (atoi(argv[4])) n->ping_sent = mstime();
        if (atoi(argv[5])) n->pong_received = mstime();
174

175 176 177
        /* Set configEpoch for this node. */
        n->configEpoch = strtoull(argv[6],NULL,10);

178
        /* Populate hash slots served by this instance. */
179
        for (j = 8; j < argc; j++) {
180 181
            int start, stop;

A
antirez 已提交
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
            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 == '>') {
200
                    server.cluster->migrating_slots_to[slot] = cn;
A
antirez 已提交
201
                } else {
202
                    server.cluster->importing_slots_from[slot] = cn;
A
antirez 已提交
203 204 205
                }
                continue;
            } else if ((p = strchr(argv[j],'-')) != NULL) {
206 207 208 209 210 211 212 213
                *p = '\0';
                start = atoi(argv[j]);
                stop = atoi(p+1);
            } else {
                start = stop = atoi(argv[j]);
            }
            while(start <= stop) clusterAddSlot(n, start++);
        }
A
antirez 已提交
214

215
        sdsfreesplitres(argv,argc);
A
antirez 已提交
216 217
    }
    zfree(line);
A
antirez 已提交
218 219
    fclose(fp);

A
antirez 已提交
220
    /* Config sanity check */
221
    redisAssert(server.cluster->myself != NULL);
A
antirez 已提交
222
    redisLog(REDIS_NOTICE,"Node configuration loaded, I'm %.40s",
223
        server.cluster->myself->name);
224
    clusterSetStartupEpoch();
225
    clusterUpdateState();
A
antirez 已提交
226 227 228
    return REDIS_OK;

fmterr:
G
guiquanz 已提交
229
    redisLog(REDIS_WARNING,"Unrecoverable error: corrupted cluster config file.");
A
antirez 已提交
230 231 232 233
    fclose(fp);
    exit(1);
}

A
antirez 已提交
234 235 236
/* Cluster node configuration is exactly the same as CLUSTER NODES output.
 *
 * This function writes the node config and returns 0, on error -1
237 238 239 240 241 242 243 244 245
 * is returned.
 *
 * Note: we need to write the file in an atomic way from the point of view
 * of the POSIX filesystem semantics, so that if the server is stopped
 * or crashes during the write, we'll end with either the old file or the
 * new one. Since we have the full payload to write available we can use
 * a single write to write the whole file. If the pre-existing file was
 * bigger we pad our payload with newlines that are anyway ignored and truncate
 * the file afterward. */
A
antirez 已提交
246
int clusterSaveConfig(int do_fsync) {
247
    sds ci = clusterGenNodesDescription(REDIS_NODE_HANDSHAKE);
248 249
    size_t content_size = sdslen(ci);
    struct stat sb;
A
antirez 已提交
250 251
    int fd;
    
252
    if ((fd = open(server.cluster_configfile,O_WRONLY|O_CREAT,0644))
A
antirez 已提交
253
        == -1) goto err;
254 255 256 257 258 259 260 261

    /* Pad the new payload if the existing file length is greater. */
    if (fstat(fd,&sb) != -1) {
        if (sb.st_size > content_size) {
            ci = sdsgrowzero(ci,sb.st_size);
            memset(ci+content_size,'\n',sb.st_size-content_size);
        }
    }
A
antirez 已提交
262
    if (write(fd,ci,sdslen(ci)) != (ssize_t)sdslen(ci)) goto err;
A
antirez 已提交
263
    if (do_fsync) fsync(fd);
264 265 266 267 268 269

    /* Truncate the file if needed to remove the final \n padding that
     * is just garbage. */
    if (content_size != sdslen(ci) && ftruncate(fd,content_size) == -1) {
        /* ftruncate() failing is not a critical error. */
    }
A
antirez 已提交
270 271 272 273 274
    close(fd);
    sdsfree(ci);
    return 0;

err:
275
    if (fd != -1) close(fd);
A
antirez 已提交
276 277 278 279
    sdsfree(ci);
    return -1;
}

A
antirez 已提交
280 281
void clusterSaveConfigOrDie(int do_fsync) {
    if (clusterSaveConfig(do_fsync) == -1) {
282 283 284 285 286
        redisLog(REDIS_WARNING,"Fatal: can't update cluster config file.");
        exit(1);
    }
}

A
antirez 已提交
287
void clusterInit(void) {
288
    int saveconf = 0;
289

290 291
    server.cluster = zmalloc(sizeof(clusterState));
    server.cluster->myself = NULL;
292
    server.cluster->currentEpoch = 0;
293
    server.cluster->state = REDIS_CLUSTER_FAIL;
294
    server.cluster->size = 1;
295
    server.cluster->todo_before_sleep = 0;
296
    server.cluster->nodes = dictCreate(&clusterNodesDictType,NULL);
297 298
    server.cluster->nodes_black_list =
        dictCreate(&clusterNodesBlackListDictType,NULL);
299 300
    server.cluster->failover_auth_time = 0;
    server.cluster->failover_auth_count = 0;
301
    server.cluster->failover_auth_epoch = 0;
302
    server.cluster->last_vote_epoch = 0;
303 304
    server.cluster->stats_bus_messages_sent = 0;
    server.cluster->stats_bus_messages_received = 0;
305 306 307 308 309 310 311
    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 已提交
312 313
        /* No configuration found. We will just use the random name provided
         * by the createClusterNode() function. */
314 315
        server.cluster->myself =
            createClusterNode(NULL,REDIS_NODE_MYSELF|REDIS_NODE_MASTER);
A
antirez 已提交
316
        redisLog(REDIS_NOTICE,"No cluster configuration found, I'm %.40s",
317 318
            server.cluster->myself->name);
        clusterAddNode(server.cluster->myself);
319 320
        saveconf = 1;
    }
A
antirez 已提交
321
    if (saveconf) clusterSaveConfigOrDie(1);
322 323

    /* We need a listening TCP port for our cluster messaging needs. */
324
    server.cfd_count = 0;
325 326 327 328
    if (listenToPort(server.port+REDIS_CLUSTER_PORT_INCR,
        server.cfd,&server.cfd_count) == REDIS_ERR)
    {
        exit(1);
329 330 331 332 333 334 335 336 337
    } 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 已提交
338
    }
339 340

    /* The slots -> keys map is a sorted set. Init it. */
341
    server.cluster->slots_to_keys = zslCreate();
A
antirez 已提交
342 343 344 345 346 347 348 349
}

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

clusterLink *createClusterLink(clusterNode *node) {
    clusterLink *link = zmalloc(sizeof(*link));
350
    link->ctime = mstime();
A
antirez 已提交
351 352 353 354 355 356 357 358
    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.
359
 * This function will just make sure that the original node associated
A
antirez 已提交
360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
 * 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;
376
    char cip[REDIS_IP_STR_LEN];
A
antirez 已提交
377 378 379 380 381
    clusterLink *link;
    REDIS_NOTUSED(el);
    REDIS_NOTUSED(mask);
    REDIS_NOTUSED(privdata);

382
    cfd = anetTcpAccept(server.neterr, fd, cip, sizeof(cip), &cport);
A
antirez 已提交
383 384 385 386
    if (cfd == AE_ERR) {
        redisLog(REDIS_VERBOSE,"Accepting cluster node: %s", server.neterr);
        return;
    }
387 388 389 390
    anetNonBlock(NULL,cfd);
    anetEnableTcpNoDelay(NULL,cfd);

    /* Use non-blocking I/O for cluster messages. */
391
    /* IPV6: might want to wrap a v6 address in [] */
A
antirez 已提交
392 393 394 395 396 397 398 399 400 401 402 403 404
    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
 * -------------------------------------------------------------------------- */

405 406
/* 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 已提交
407
unsigned int keyHashSlot(char *key, int keylen) {
408
    return crc16(key,keylen) & 0x3FFF;
A
antirez 已提交
409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
}

/* -----------------------------------------------------------------------------
 * 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
428
        getRandomHexChars(node->name, REDIS_CLUSTER_NAMELEN);
429
    node->ctime = mstime();
430
    node->configEpoch = 0;
A
antirez 已提交
431 432
    node->flags = flags;
    memset(node->slots,0,sizeof(node->slots));
433
    node->numslots = 0;
A
antirez 已提交
434 435 436 437
    node->numslaves = 0;
    node->slaves = NULL;
    node->slaveof = NULL;
    node->ping_sent = node->pong_received = 0;
A
antirez 已提交
438
    node->fail_time = 0;
A
antirez 已提交
439
    node->link = NULL;
440
    memset(node->ip,0,sizeof(node->ip));
441
    node->port = 0;
442
    node->fail_reports = listCreate();
443
    node->voted_time = 0;
444
    listSetFreeMethod(node->fail_reports,zfree);
A
antirez 已提交
445 446 447
    return node;
}

448 449 450 451 452
/* 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
453 454 455 456 457 458
 * '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) {
459 460 461 462 463 464 465 466 467 468 469
    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) {
470
            fr->time = mstime();
471
            return 0;
472 473 474 475 476 477
        }
    }

    /* Otherwise create a new report. */
    fr = zmalloc(sizeof(*fr));
    fr->node = sender;
478
    fr->time = mstime();
479
    listAddNodeTail(l,fr);
480
    return 1;
481 482
}

483 484 485 486 487 488 489 490 491 492
/* 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;
493
    mstime_t maxtime = server.cluster_node_timeout *
494
                     REDIS_CLUSTER_FAIL_REPORT_VALIDITY_MULT;
495
    mstime_t now = mstime();
496 497 498 499 500 501 502 503

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

504 505 506 507 508 509 510
/* 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
511 512 513 514 515
 * time.
 *
 * The function returns 1 if the failure report was found and removed.
 * Otherwise 0 is returned. */
int clusterNodeDelFailureReport(clusterNode *node, clusterNode *sender) {
516 517 518 519 520 521 522 523 524 525 526
    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;
    }
527
    if (!ln) return 0; /* No failure report from this sender. */
528 529 530

    /* Remove the failure report. */
    listDelNode(l,ln);
531
    clusterNodeCleanupFailureReports(node);
532
    return 1;
533 534
}

535 536 537 538 539 540 541 542
/* 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 已提交
543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
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;
573
    n->slaves = NULL;
A
antirez 已提交
574 575 576 577
}

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

A
antirez 已提交
579
    nodename = sdsnewlen(n->name, REDIS_CLUSTER_NAMELEN);
580
    redisAssert(dictDelete(server.cluster->nodes,nodename) == DICT_OK);
A
antirez 已提交
581 582 583
    sdsfree(nodename);
    if (n->slaveof) clusterNodeRemoveSlave(n->slaveof, n);
    if (n->link) freeClusterLink(n->link);
584
    listRelease(n->fail_reports);
A
antirez 已提交
585 586 587 588 589 590 591
    zfree(n);
}

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

A
antirez 已提交
597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618
/* 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. */
619
    di = dictGetSafeIterator(server.cluster->nodes);
A
antirez 已提交
620 621 622 623 624 625 626 627 628 629 630 631
    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 已提交
632 633 634 635 636
/* Node lookup by name */
clusterNode *clusterLookupNode(char *name) {
    sds s = sdsnewlen(name, REDIS_CLUSTER_NAMELEN);
    struct dictEntry *de;

637
    de = dictFind(server.cluster->nodes,s);
A
antirez 已提交
638 639
    sdsfree(s);
    if (de == NULL) return NULL;
640
    return dictGetVal(de);
A
antirez 已提交
641 642 643 644 645 646 647 648 649 650 651 652
}

/* 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);
653
    retval = dictDelete(server.cluster->nodes, s);
A
antirez 已提交
654 655 656 657 658 659
    sdsfree(s);
    redisAssert(retval == DICT_OK);
    memcpy(node->name, newname, REDIS_CLUSTER_NAMELEN);
    clusterAddNode(node);
}

660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676
/* -----------------------------------------------------------------------------
 * CLUSTER nodes blacklist
 *
 * The nodes blacklist is just a way to ensure that a given node with a given
 * Node ID is not readded before some time elapsed (this time is specified
 * in seconds in REDIS_CLUSTER_BLACKLIST_TTL).
 *
 * This is useful when we want to remove a node from the cluster completely:
 * when CLUSTER FORGET is called, it also puts the node into the blacklist so
 * that even if we receive gossip messages from other nodes that still remember
 * about the node we want to remove, we don't re-add it before some time.
 *
 * Currently the REDIS_CLUSTER_BLACKLIST_TTL is set to 1 minute, this means
 * that redis-trib has 60 seconds to send CLUSTER FORGET messages to nodes
 * in the cluster without dealing with the problem if other nodes re-adding
 * back the node to nodes we already sent the FORGET command to.
 *
677
 * The data structure used is a hash table with an sds string representing
678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728
 * the node ID as key, and the time when it is ok to re-add the node as
 * value.
 * -------------------------------------------------------------------------- */

#define REDIS_CLUSTER_BLACKLIST_TTL 60      /* 1 minute. */


/* Before of the addNode() or Exists() operations we always remove expired
 * entries from the black list. This is an O(N) operation but it is not a
 * problem since add / exists operations are called very infrequently and
 * the hash table is supposed to contain very little elements at max.
 * However without the cleanup during long uptimes and with some automated
 * node add/removal procedures, entries could accumulate. */
void clusterBlacklistCleanup(void) {
    dictIterator *di;
    dictEntry *de;

    di = dictGetSafeIterator(server.cluster->nodes_black_list);
    while((de = dictNext(di)) != NULL) {
        int64_t expire = dictGetUnsignedIntegerVal(de);

        if (expire < server.unixtime)
            dictDelete(server.cluster->nodes_black_list,dictGetKey(de));
    }
    dictReleaseIterator(di);
}

/* Cleanup the blacklist and add a new node ID to the black list. */
void clusterBlacklistAddNode(clusterNode *node) {
    dictEntry *de;
    sds id = sdsnewlen(node->name,REDIS_CLUSTER_NAMELEN);

    clusterBlacklistCleanup();
    if (dictAdd(server.cluster->nodes_black_list,id,NULL) == DICT_ERR)
        sdsfree(id); /* Key was already there. */
    de = dictFind(server.cluster->nodes_black_list,node->name);
    dictSetUnsignedIntegerVal(de,time(NULL));
}

/* Return non-zero if the specified node ID exists in the blacklist.
 * You don't need to pass an sds string here, any pointer to 40 bytes
 * will work. */
int clusterBlacklistExists(char *nodeid) {
    sds id = sdsnewlen(nodeid,REDIS_CLUSTER_NAMELEN);
    int retval;

    retval = dictFind(server.cluster->nodes_black_list,id) != NULL;
    sdsfree(id);
    return retval;
}

A
antirez 已提交
729 730 731 732
/* -----------------------------------------------------------------------------
 * CLUSTER messages exchange - PING/PONG and gossip
 * -------------------------------------------------------------------------- */

733 734 735
/* This function checks if a given node should be marked as FAIL.
 * It happens if the following conditions are met:
 *
736 737 738 739
 * 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.
740 741 742
 *
 * 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.
743 744 745 746 747 748 749 750 751 752
 *
 * 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.
753 754 755 756 757 758 759 760
 */
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. */

761 762 763 764 765
    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. */
766 767 768 769 770 771 772

    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;
773
    node->fail_time = mstime();
774

775 776 777 778
    /* 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);
A
antirez 已提交
779
    clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
780 781 782 783
}

/* 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
784
 * state. */
785
void clearNodeFailureIfNeeded(clusterNode *node) {
786
    mstime_t now = mstime();
A
antirez 已提交
787 788 789 790 791 792 793

    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,
794
            "Clear FAIL state for node %.40s: slave is reachable again.",
A
antirez 已提交
795 796
                node->name);
        node->flags &= ~REDIS_NODE_FAIL;
A
antirez 已提交
797
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
A
antirez 已提交
798 799 800
    }

    /* If it is a master and...
801
     * 1) The FAIL state is old enough.
A
antirez 已提交
802 803 804 805
     * 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 &&
806
        (now - node->fail_time) >
807
        (server.cluster_node_timeout * REDIS_CLUSTER_FAIL_UNDO_TIME_MULT))
A
antirez 已提交
808
    {
809
        redisLog(REDIS_NOTICE,
A
antirez 已提交
810
            "Clear FAIL state for node %.40s: is reachable again and nobody is serving its slots after some time.",
811
                node->name);
812
        node->flags &= ~REDIS_NODE_FAIL;
A
antirez 已提交
813
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
814 815 816
    }
}

817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834
/* 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;
}

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 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892
/* Start an handshake with the specified address if there is not one
 * already in progress. Returns non-zero if the handshake was actually
 * started. On error zero is returned and errno is set to one of the
 * following values:
 *
 * EAGAIN - There is already an handshake in progress for this address.
 * EINVAL - IP or port are not valid. */
int clusterStartHandshake(char *ip, int port) {
    clusterNode *n;
    char norm_ip[REDIS_IP_STR_LEN];
    struct sockaddr_storage sa;

    /* IP sanity check */
    if (inet_pton(AF_INET,ip,
            &(((struct sockaddr_in *)&sa)->sin_addr)))
    {
        sa.ss_family = AF_INET;
    } else if (inet_pton(AF_INET6,ip,
            &(((struct sockaddr_in6 *)&sa)->sin6_addr)))
    {
        sa.ss_family = AF_INET6;
    } else {
        errno = EINVAL;
        return 0;
    }

    /* Port sanity check */
    if (port <= 0 || port > (65535-REDIS_CLUSTER_PORT_INCR)) {
        errno = EINVAL;
        return 0;
    }

    /* Set norm_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),
            norm_ip,REDIS_CLUSTER_IPLEN);
    else
        inet_ntop(AF_INET6,
            (void*)&(((struct sockaddr_in6 *)&sa)->sin6_addr),
            norm_ip,REDIS_CLUSTER_IPLEN);

    if (clusterHandshakeInProgress(norm_ip,port)) {
        errno = EAGAIN;
        return 0;
    }

    /* Add the node with a random address (NULL as first argument to
     * createClusterNode()). Everything will be fixed during the
     * handskake. */
    n = createClusterNode(NULL,REDIS_NODE_HANDSHAKE|REDIS_NODE_MEET);
    memcpy(n->ip,norm_ip,sizeof(n->ip));
    n->port = port;
    clusterAddNode(n);
    return 1;
}

A
antirez 已提交
893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925
/* Process the gossip section of PING or PONG packets.
 * Note that this function assumes that the packet is already sanity-checked
 * by the caller, not in the content of the gossip section, but in the
 * length. */
void clusterProcessGossipSection(clusterMsg *hdr, clusterLink *link) {
    uint16_t count = ntohs(hdr->count);
    clusterMsgDataGossip *g = (clusterMsgDataGossip*) hdr->data.ping.gossip;
    clusterNode *sender = link->node ? link->node : clusterLookupNode(hdr->sender);

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

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

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

        /* Update our state accordingly to the gossip sections */
        node = clusterLookupNode(g->nodename);
926
        if (node) {
927 928
            /* We already know this node.
               Handle failure reports, only when the sender is a master. */
929 930 931
            if (sender && sender->flags & REDIS_NODE_MASTER &&
                node != server.cluster->myself)
            {
932 933
                if (flags & (REDIS_NODE_FAIL|REDIS_NODE_PFAIL)) {
                    if (clusterNodeAddFailureReport(node,sender)) {
934
                        redisLog(REDIS_VERBOSE,
935 936 937 938 939 940
                            "Node %.40s reported node %.40s as not reachable.",
                            sender->name, node->name);
                    }
                    markNodeAsFailingIfNeeded(node);
                } else {
                    if (clusterNodeDelFailureReport(node,sender)) {
941
                        redisLog(REDIS_VERBOSE,
942 943 944 945
                            "Node %.40s reported node %.40s is back online.",
                            sender->name, node->name);
                    }
                }
A
antirez 已提交
946
            }
947 948 949 950 951 952 953 954 955 956 957

            /* If we already know this node, but it is not reachable, and
             * we see a different address in the gossip section, start an
             * handshake with the (possibly) new address: this will result
             * into a node address update if the handshake will be
             * successful. */
            if (node->flags & (REDIS_NODE_FAIL|REDIS_NODE_PFAIL) &&
                (strcasecmp(node->ip,g->ip) || node->port != ntohs(g->port)))
            {
                clusterStartHandshake(g->ip,ntohs(g->port));
            }
A
antirez 已提交
958 959
        } else {
            /* If it's not in NOADDR state and we don't have it, we
960
             * start a handshake process against this IP/PORT pairs.
A
antirez 已提交
961 962 963 964
             *
             * 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. */
965 966
            if (sender && !(flags & REDIS_NODE_NOADDR))
                clusterStartHandshake(g->ip,ntohs(g->port));
A
antirez 已提交
967 968 969 970 971 972 973
        }

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

974
/* IP -> string conversion. 'buf' is supposed to at least be 46 bytes. */
A
antirez 已提交
975
void nodeIp2String(char *buf, clusterLink *link) {
976
    struct sockaddr_storage sa;
A
antirez 已提交
977 978 979 980
    socklen_t salen = sizeof(sa);

    if (getpeername(link->fd, (struct sockaddr*) &sa, &salen) == -1)
        redisPanic("getpeername() failed.");
981 982 983 984 985 986 987 988

    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 已提交
989 990 991 992
}


/* Update the node address to the IP address that can be extracted
A
antirez 已提交
993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021
 * 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);
1022 1023 1024 1025 1026 1027 1028 1029

    /* Check if this is our master and we have to change the
     * replication target as well. */
    if (server.cluster->myself->flags & REDIS_NODE_SLAVE &&
        server.cluster->myself->slaveof == node)
    {
        replicationSetMaster(node->ip, node->port);
    }
A
antirez 已提交
1030
    return 1;
A
antirez 已提交
1031 1032
}

1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110
/* Reconfigure the specified node 'n' as a master. This function is called when
 * a node that we believed to be a slave is now acting as master in order to
 * update the state of the node. */
void clusterSetNodeAsMaster(clusterNode *n) {
    if (n->flags & REDIS_NODE_MASTER) return;

    if (n->slaveof) clusterNodeRemoveSlave(n->slaveof,n);
    n->flags &= ~REDIS_NODE_SLAVE;
    n->flags |= REDIS_NODE_MASTER;
    n->slaveof = NULL;

    /* Update config and state. */
    clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                         CLUSTER_TODO_UPDATE_STATE);
}

/* This function is called when we receive a master configuration via a
 * PING, PONG or UPDATE packet. What we receive is a node, a configEpoch of the
 * node, and the set of slots claimed under this configEpoch.
 *
 * What we do is to rebind the slots with newer configuration compared to our
 * local configuration, and if needed, we turn ourself into a replica of the
 * node (see the function comments for more info).
 *
 * The 'sender' is the node for which we received a configuration update.
 * Sometimes it is not actaully the "Sender" of the information, like in the case
 * we receive the info via an UPDATE packet. */
void clusterUpdateSlotsConfigWith(clusterNode *sender, uint64_t senderConfigEpoch,
                                  unsigned char *slots)
{
    int j;
    clusterNode *curmaster, *newmaster = NULL;

    /* Here we set curmaster to this node or the node this node
     * replicates to if it's a slave. In the for loop we are
     * interested to check if slots are taken away from curmaster. */
    if (server.cluster->myself->flags & REDIS_NODE_MASTER)
        curmaster = server.cluster->myself;
    else
        curmaster = server.cluster->myself->slaveof;

    for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
        if (bitmapTestBit(slots,j)) {
            /* We rebind the slot to the new node claiming it if:
             * 1) The slot was unassigned.
             * 2) The new node claims it with a greater configEpoch. */
            if (server.cluster->slots[j] == sender) continue;
            if (server.cluster->slots[j] == NULL ||
                server.cluster->slots[j]->configEpoch <
                senderConfigEpoch)
            {
                if (server.cluster->slots[j] == curmaster)
                    newmaster = sender;
                clusterDelSlot(j);
                clusterAddSlot(sender,j);
                clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                                     CLUSTER_TODO_UPDATE_STATE|
                                     CLUSTER_TODO_FSYNC_CONFIG);
            }
        }
    }

    /* If at least one slot was reassigned from a node to another node
     * with a greater configEpoch, it is possible that:
     * 1) We are a master left without slots. This means that we were
     *    failed over and we should turn into a replica of the new
     *    master.
     * 2) We are a slave and our master is left without slots. We need
     *    to replicate to the new slots owner. */
    if (newmaster && curmaster->numslots == 0) {
        redisLog(REDIS_WARNING,"Configuration change detected. Reconfiguring myself as a replica of %.40s", sender->name);
        clusterSetMaster(sender);
        clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                             CLUSTER_TODO_UPDATE_STATE|
                             CLUSTER_TODO_FSYNC_CONFIG);
    }
}

A
antirez 已提交
1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123
/* 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 已提交
1124
    uint16_t flags = ntohs(hdr->flags);
1125
    uint64_t senderCurrentEpoch = 0, senderConfigEpoch = 0;
A
antirez 已提交
1126 1127
    clusterNode *sender;

1128
    server.cluster->stats_bus_messages_received++;
1129 1130
    redisLog(REDIS_DEBUG,"--- Processing packet of type %d, %lu bytes",
        type, (unsigned long) totlen);
1131 1132

    /* Perform sanity checks */
A
antirez 已提交
1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143
    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;
1144
    } else if (type == CLUSTERMSG_TYPE_FAIL) {
A
antirez 已提交
1145 1146 1147 1148
        uint32_t explen = sizeof(clusterMsg)-sizeof(union clusterMsgData);

        explen += sizeof(clusterMsgDataFail);
        if (totlen != explen) return 1;
1149
    } else if (type == CLUSTERMSG_TYPE_PUBLISH) {
1150 1151 1152 1153 1154 1155
        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;
1156 1157
    } else if (type == CLUSTERMSG_TYPE_FAILOVER_AUTH_REQUEST ||
               type == CLUSTERMSG_TYPE_FAILOVER_AUTH_ACK) {
1158 1159
        uint32_t explen = sizeof(clusterMsg)-sizeof(union clusterMsgData);

1160 1161 1162 1163 1164
        if (totlen != explen) return 1;
    } else if (type == CLUSTERMSG_TYPE_UPDATE) {
        uint32_t explen = sizeof(clusterMsg)-sizeof(union clusterMsgData);

        explen += sizeof(clusterMsgDataUpdate);
1165
        if (totlen != explen) return 1;
1166
    }
A
antirez 已提交
1167

1168
    /* Check if the sender is a known node. */
A
antirez 已提交
1169
    sender = clusterLookupNode(hdr->sender);
1170
    if (sender && !(sender->flags & REDIS_NODE_HANDSHAKE)) {
1171
        /* Update our curretEpoch if we see a newer epoch in the cluster. */
1172 1173 1174 1175
        senderCurrentEpoch = ntohu64(hdr->currentEpoch);
        senderConfigEpoch = ntohu64(hdr->configEpoch);
        if (senderCurrentEpoch > server.cluster->currentEpoch)
            server.cluster->currentEpoch = senderCurrentEpoch;
1176
        /* Update the sender configEpoch if it is publishing a newer one. */
1177
        if (senderConfigEpoch > sender->configEpoch) {
1178
            sender->configEpoch = senderConfigEpoch;
A
antirez 已提交
1179
            clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|CLUSTER_TODO_FSYNC_CONFIG);
1180
        }
1181
    }
1182

1183
    /* Process packets by type. */
A
antirez 已提交
1184
    if (type == CLUSTERMSG_TYPE_PING || type == CLUSTERMSG_TYPE_MEET) {
1185
        redisLog(REDIS_DEBUG,"Ping packet received: %p", (void*)link->node);
A
antirez 已提交
1186 1187 1188 1189

        /* 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
1190
         * resolved when we'll receive PONGs from the node. */
A
antirez 已提交
1191 1192 1193 1194 1195 1196 1197
        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);
A
antirez 已提交
1198
            clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG);
A
antirez 已提交
1199 1200 1201 1202 1203 1204 1205
        }

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

        /* Anyway reply with a PONG */
        clusterSendPing(link,CLUSTERMSG_TYPE_PONG);
1206 1207 1208
    }

    /* PING or PONG: process config information. */
1209 1210 1211
    if (type == CLUSTERMSG_TYPE_PING || type == CLUSTERMSG_TYPE_PONG ||
        type == CLUSTERMSG_TYPE_MEET)
    {
1212 1213 1214
        redisLog(REDIS_DEBUG,"%s packet received: %p",
            type == CLUSTERMSG_TYPE_PING ? "ping" : "pong",
            (void*)link->node);
A
antirez 已提交
1215 1216 1217 1218 1219 1220 1221
        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 已提交
1222 1223
                    if (nodeUpdateAddressIfNeeded(sender,link,ntohs(hdr->port)))
                    {
A
antirez 已提交
1224 1225
                        clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                                             CLUSTER_TODO_UPDATE_STATE);
A
antirez 已提交
1226 1227 1228 1229
                    }
                    /* Free this node as we alrady have it. This will
                     * cause the link to be freed as well. */
                    freeClusterNode(link->node);
A
antirez 已提交
1230 1231 1232 1233
                    return 0;
                }

                /* First thing to do is replacing the random name with the
1234
                 * right node name if this was a handshake stage. */
A
antirez 已提交
1235 1236 1237 1238
                clusterRenameNode(link->node, hdr->sender);
                redisLog(REDIS_DEBUG,"Handshake with node %.40s completed.",
                    link->node->name);
                link->node->flags &= ~REDIS_NODE_HANDSHAKE;
1239
                link->node->flags |= flags&(REDIS_NODE_MASTER|REDIS_NODE_SLAVE);
A
antirez 已提交
1240
                clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG);
A
antirez 已提交
1241 1242 1243 1244 1245 1246 1247 1248
            } 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;
1249 1250
                link->node->ip[0] = '\0';
                link->node->port = 0;
A
antirez 已提交
1251
                freeClusterLink(link);
A
antirez 已提交
1252
                clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG);
A
antirez 已提交
1253 1254 1255
                return 0;
            }
        }
1256

A
antirez 已提交
1257 1258 1259 1260 1261
        /* Update the node address if it changed. */
        if (sender && type == CLUSTERMSG_TYPE_PING &&
            !(sender->flags & REDIS_NODE_HANDSHAKE) &&
            nodeUpdateAddressIfNeeded(sender,link,ntohs(hdr->port)))
        {
A
antirez 已提交
1262
            clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|CLUSTER_TODO_UPDATE_STATE);
A
antirez 已提交
1263 1264
        }

A
antirez 已提交
1265
        /* Update our info about the node */
1266
        if (link->node && type == CLUSTERMSG_TYPE_PONG) {
1267
            link->node->pong_received = mstime();
1268 1269 1270
            link->node->ping_sent = 0;

            /* The PFAIL condition can be reversed without external
1271
             * help if it is momentary (that is, if it does not
1272 1273 1274 1275 1276 1277
             * 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;
A
antirez 已提交
1278 1279
                clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                                     CLUSTER_TODO_UPDATE_STATE);
1280 1281 1282 1283
            } else if (link->node->flags & REDIS_NODE_FAIL) {
                clearNodeFailureIfNeeded(link->node);
            }
        }
A
antirez 已提交
1284

1285
        /* Check for role switch: slave -> master or master -> slave. */
A
antirez 已提交
1286 1287 1288 1289
        if (sender) {
            if (!memcmp(hdr->slaveof,REDIS_NODE_NULL_NAME,
                sizeof(hdr->slaveof)))
            {
1290
                /* Node is a master. */
1291
                clusterSetNodeAsMaster(sender);
A
antirez 已提交
1292
            } else {
1293
                /* Node is a slave. */
A
antirez 已提交
1294 1295
                clusterNode *master = clusterLookupNode(hdr->slaveof);

1296
                if (sender->flags & REDIS_NODE_MASTER) {
1297
                    /* Master turned into a slave! Reconfigure the node. */
1298
                    clusterDelNodeSlots(sender);
1299 1300
                    sender->flags &= ~REDIS_NODE_MASTER;
                    sender->flags |= REDIS_NODE_SLAVE;
1301

1302 1303
                    /* Remove the list of slaves from the node. */
                    if (sender->numslaves) clusterNodeResetSlaves(sender);
1304 1305

                    /* Update config and state. */
A
antirez 已提交
1306 1307
                    clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                                         CLUSTER_TODO_UPDATE_STATE);
1308 1309
                }

1310 1311
                /* Master node changed for this slave? */
                if (sender->slaveof != master) {
1312 1313
                    if (sender->slaveof)
                        clusterNodeRemoveSlave(sender->slaveof,sender);
1314 1315
                    clusterNodeAddSlave(master,sender);
                    sender->slaveof = master;
1316 1317

                    /* Update config. */
A
antirez 已提交
1318
                    clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG);
1319
                }
A
antirez 已提交
1320 1321 1322
            }
        }

1323
        /* Update our info about served slots.
1324
         *
1325 1326
         * Note: this MUST happen after we update the master/slave state
         * so that REDIS_NODE_MASTER flag will be set. */
1327 1328

        /* Many checks are only needed if the set of served slots this
1329 1330 1331 1332
         * instance claims is different compared to the set of slots we have
         * for it. Check this ASAP to avoid other computational expansive
         * checks later. */
        clusterNode *sender_master = NULL; /* Sender or its master if slave. */
1333 1334 1335
        int dirty_slots = 0; /* Sender claimed slots don't match my view? */

        if (sender) {
1336 1337
            sender_master = (sender->flags & REDIS_NODE_MASTER) ?
                sender : sender->slaveof;
1338 1339 1340 1341 1342 1343
            if (sender_master) {
                dirty_slots = memcmp(sender_master->slots,
                        hdr->myslots,sizeof(hdr->myslots)) != 0;
            }
        }

1344 1345 1346
        /* 1) If the sender of the message is a master, and we detected that
         *    the set of slots it claims changed, scan the slots to see if we
         *    need to update our configuration. */
1347
        if (sender && sender->flags & REDIS_NODE_MASTER && dirty_slots) {
1348
            clusterUpdateSlotsConfigWith(sender,senderConfigEpoch,hdr->myslots);
1349 1350
        }

1351 1352 1353
        /* 2) We also check for the reverse condition, that is, the sender
         *    claims to serve slots we know are served by a master with a
         *    greater configEpoch. If this happens we inform the sender.
1354
         *
1355 1356 1357 1358
         * This is useful because sometimes after a partition heals, a
         * reappearing master may be the last one to claim a given set of
         * hash slots, but with a configuration that other instances know to
         * be deprecated. Example:
1359 1360 1361 1362 1363 1364
         *
         * A and B are master and slave for slots 1,2,3.
         * A is partitioned away, B gets promoted.
         * B is partitioned away, and A returns available.
         *
         * Usually B would PING A publishing its set of served slots and its
1365 1366 1367 1368
         * configEpoch, but because of the partition B can't inform A of the
         * new configuration, so other nodes that have an updated table must
         * do it. In this way A will stop to act as a master (or can try to
         * failover if there are the conditions to win the election). */
1369 1370 1371 1372 1373 1374 1375 1376 1377 1378
        if (sender && dirty_slots) {
            int j;

            for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
                if (bitmapTestBit(hdr->myslots,j)) {
                    if (server.cluster->slots[j] == sender ||
                        server.cluster->slots[j] == NULL) continue;
                    if (server.cluster->slots[j]->configEpoch >
                        senderConfigEpoch)
                    {
1379 1380
                        redisLog(REDIS_WARNING,
                            "Node %.40s has old slots configuration, sending "
1381
                            "an UPDATE message about %.40s",
1382 1383
                                sender->name, server.cluster->slots[j]->name);
                        clusterSendUpdate(sender->link,server.cluster->slots[j]);
1384 1385 1386 1387 1388

                        /* TODO: instead of exiting the loop send every other
                         * UPDATE packet for other nodes that are the new owner
                         * of sender's slots. */
                        break;
1389
                    }
1390
                }
A
antirez 已提交
1391 1392 1393 1394 1395
            }
        }

        /* Get info from the gossip section */
        clusterProcessGossipSection(hdr,link);
1396
    } else if (type == CLUSTERMSG_TYPE_FAIL) {
A
antirez 已提交
1397 1398
        clusterNode *failing;

1399 1400
        if (sender) {
            failing = clusterLookupNode(hdr->data.fail.about.nodename);
1401 1402
            if (failing &&
                !(failing->flags & (REDIS_NODE_FAIL|REDIS_NODE_MYSELF)))
1403 1404 1405 1406 1407
            {
                redisLog(REDIS_NOTICE,
                    "FAIL message received from %.40s about %.40s",
                    hdr->sender, hdr->data.fail.about.nodename);
                failing->flags |= REDIS_NODE_FAIL;
1408
                failing->fail_time = mstime();
1409
                failing->flags &= ~REDIS_NODE_PFAIL;
A
antirez 已提交
1410
                clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|CLUSTER_TODO_UPDATE_STATE);
1411 1412
            }
        } else {
A
antirez 已提交
1413
            redisLog(REDIS_NOTICE,
1414
                "Ignoring FAIL message from unknonw node %.40s about %.40s",
A
antirez 已提交
1415 1416
                hdr->sender, hdr->data.fail.about.nodename);
        }
1417 1418 1419 1420
    } else if (type == CLUSTERMSG_TYPE_PUBLISH) {
        robj *channel, *message;
        uint32_t channel_len, message_len;

A
antirez 已提交
1421 1422
        /* Don't bother creating useless objects if there are no
         * Pub/Sub subscribers. */
1423 1424 1425
        if (dictSize(server.pubsub_channels) ||
           listLength(server.pubsub_patterns))
        {
1426 1427 1428 1429 1430
            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(
1431 1432
                        (char*)hdr->data.publish.msg.bulk_data+channel_len,
                        message_len);
1433 1434 1435 1436
            pubsubPublishMessage(channel,message);
            decrRefCount(channel);
            decrRefCount(message);
        }
1437
    } else if (type == CLUSTERMSG_TYPE_FAILOVER_AUTH_REQUEST) {
A
antirez 已提交
1438
        if (!sender) return 1;  /* We don't know that node. */
1439
        clusterSendFailoverAuthIfNeeded(sender,hdr);
1440
    } else if (type == CLUSTERMSG_TYPE_FAILOVER_AUTH_ACK) {
A
antirez 已提交
1441
        if (!sender) return 1;  /* We don't know that node. */
1442
        /* We consider this vote only if the sender is a master serving
1443 1444
         * a non zero number of slots, and its currentEpoch is greater or
         * equal to epoch where this node started the election. */
1445 1446
        if (sender->flags & REDIS_NODE_MASTER &&
            sender->numslots > 0 &&
1447
            senderCurrentEpoch >= server.cluster->failover_auth_epoch)
1448
        {
1449
            server.cluster->failover_auth_count++;
1450 1451
            /* Maybe we reached a quorum here, set a flag to make sure
             * we check ASAP. */
A
antirez 已提交
1452
            clusterDoBeforeSleep(CLUSTER_TODO_HANDLE_FAILOVER);
1453
        }
1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465
    } else if (type == CLUSTERMSG_TYPE_UPDATE) {
        clusterNode *n; /* The node the update is about. */
        uint64_t reportedConfigEpoch = ntohu64(hdr->data.update.nodecfg.configEpoch);

        if (!sender) return 1;  /* We don't know the sender. */
        n = clusterLookupNode(hdr->data.update.nodecfg.nodename);
        if (!n) return 1;   /* We don't know the reported node. */
        if (n->configEpoch >= reportedConfigEpoch) return 1; /* Nothing new. */

        /* If in our current config the node is a slave, set it as a master. */
        if (n->flags & REDIS_NODE_SLAVE) clusterSetNodeAsMaster(n);

1466 1467
        /* Check the bitmap of served slots and udpate our
         * config accordingly. */
1468 1469
        clusterUpdateSlotsConfigWith(n,reportedConfigEpoch,
            hdr->data.update.nodecfg.slots);
A
antirez 已提交
1470
    } else {
1471
        redisLog(REDIS_WARNING,"Received unknown packet type: %d", type);
A
antirez 已提交
1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496
    }
    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) {
1497
        redisLog(REDIS_DEBUG,"I/O error writing to node link: %s",
A
antirez 已提交
1498 1499 1500 1501
            strerror(errno));
        handleLinkIOError(link);
        return;
    }
1502
    sdsrange(link->sndbuf,nwritten,-1);
A
antirez 已提交
1503 1504 1505 1506 1507 1508 1509 1510
    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) {
1511
    char buf[sizeof(clusterMsg)];
A
antirez 已提交
1512 1513 1514
    ssize_t nread;
    clusterMsg *hdr;
    clusterLink *link = (clusterLink*) privdata;
1515
    int readlen, rcvbuflen;
A
antirez 已提交
1516 1517 1518
    REDIS_NOTUSED(el);
    REDIS_NOTUSED(mask);

1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535
    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;
                }
1536
            }
1537 1538
            readlen = ntohl(hdr->totlen) - rcvbuflen;
            if (readlen > sizeof(buf)) readlen = sizeof(buf);
1539
        }
A
antirez 已提交
1540

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

1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555
        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 已提交
1556

1557 1558 1559 1560 1561 1562 1563 1564
        /* 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 已提交
1565 1566 1567 1568
        }
    }
}

1569 1570 1571 1572 1573
/* Put stuff into the send buffer.
 *
 * It is guaranteed that this function will never have as a side effect
 * the link to be invalidated, so it is safe to call this function
 * from event handlers that will do stuff with the same link later. */
A
antirez 已提交
1574 1575 1576 1577 1578 1579
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);
1580
    server.cluster->stats_bus_messages_sent++;
A
antirez 已提交
1581 1582
}

1583
/* Send a message to all the nodes that are part of the cluster having
1584 1585 1586 1587 1588
 * a connected link.
 * 
 * It is guaranteed that this function will never have as a side effect
 * some node->link to be invalidated, so it is safe to call this function
 * from event handlers that will do stuff with node links later. */
1589 1590 1591 1592
void clusterBroadcastMessage(void *buf, size_t len) {
    dictIterator *di;
    dictEntry *de;

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

        if (!node->link) continue;
1598 1599
        if (node->flags & (REDIS_NODE_MYSELF|REDIS_NODE_HANDSHAKE))
            continue;
1600 1601 1602 1603 1604
        clusterSendMessage(node->link,buf,len);
    }
    dictReleaseIterator(di);
}

A
antirez 已提交
1605 1606
/* Build the message header */
void clusterBuildMessageHdr(clusterMsg *hdr, int type) {
1607
    int totlen = 0;
1608 1609 1610 1611 1612 1613 1614 1615 1616
    clusterNode *master;

    /* If this node is a master, we send its slots bitmap and configEpoch.
     * If this node is a slave we send the master's information instead (the
     * node is flagged as slave so the receiver knows that it is NOT really
     * in charge for this slots. */
    master = (server.cluster->myself->flags & REDIS_NODE_SLAVE &&
              server.cluster->myself->slaveof) ?
              server.cluster->myself->slaveof : server.cluster->myself;
A
antirez 已提交
1617 1618 1619

    memset(hdr,0,sizeof(*hdr));
    hdr->type = htons(type);
1620
    memcpy(hdr->sender,server.cluster->myself->name,REDIS_CLUSTER_NAMELEN);
1621 1622

    memcpy(hdr->myslots,master->slots,sizeof(hdr->myslots));
A
antirez 已提交
1623
    memset(hdr->slaveof,0,REDIS_CLUSTER_NAMELEN);
1624 1625
    if (server.cluster->myself->slaveof != NULL) {
        memcpy(hdr->slaveof,server.cluster->myself->slaveof->name,
A
antirez 已提交
1626 1627 1628
                                    REDIS_CLUSTER_NAMELEN);
    }
    hdr->port = htons(server.port);
1629
    hdr->flags = htons(server.cluster->myself->flags);
1630
    hdr->state = server.cluster->state;
A
antirez 已提交
1631

1632
    /* Set the currentEpoch and configEpochs. */
1633
    hdr->currentEpoch = htonu64(server.cluster->currentEpoch);
1634
    hdr->configEpoch = htonu64(master->configEpoch);
1635

A
antirez 已提交
1636 1637 1638
    if (type == CLUSTERMSG_TYPE_FAIL) {
        totlen = sizeof(clusterMsg)-sizeof(union clusterMsgData);
        totlen += sizeof(clusterMsgDataFail);
1639 1640 1641
    } else if (type == CLUSTERMSG_TYPE_UPDATE) {
        totlen = sizeof(clusterMsg)-sizeof(union clusterMsgData);
        totlen += sizeof(clusterMsgDataUpdate);
A
antirez 已提交
1642 1643
    }
    hdr->totlen = htonl(totlen);
1644
    /* For PING, PONG, and MEET, fixing the totlen field is up to the caller. */
A
antirez 已提交
1645 1646 1647 1648 1649
}

/* Send a PING or PONG packet to the specified node, making sure to add enough
 * gossip informations. */
void clusterSendPing(clusterLink *link, int type) {
1650
    unsigned char buf[sizeof(clusterMsg)];
A
antirez 已提交
1651 1652 1653 1654 1655 1656 1657 1658
    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. */
1659
    int freshnodes = dictSize(server.cluster->nodes)-2;
A
antirez 已提交
1660 1661

    if (link->node && type == CLUSTERMSG_TYPE_PING)
1662
        link->node->ping_sent = mstime();
A
antirez 已提交
1663 1664 1665 1666
    clusterBuildMessageHdr(hdr,type);
        
    /* Populate the gossip fields */
    while(freshnodes > 0 && gossipcount < 3) {
1667
        struct dictEntry *de = dictGetRandomKey(server.cluster->nodes);
1668
        clusterNode *this = dictGetVal(de);
A
antirez 已提交
1669 1670 1671
        clusterMsgDataGossip *gossip;
        int j;

1672 1673 1674 1675 1676 1677
        /* 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.
         */
1678
        if (this == server.cluster->myself ||
1679
            this->flags & (REDIS_NODE_HANDSHAKE|REDIS_NODE_NOADDR) ||
1680
            (this->link == NULL && this->numslots == 0))
1681
        {
A
antirez 已提交
1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710
                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);
}

1711 1712
/* Send a PONG packet to every connected node that's not in handshake state
 * and for which we have a valid link.
1713
 *
1714 1715
 * In Redis Cluster pongs are not used just for failure detection, but also
 * to carry important configuration information. So broadcasting a pong is
1716 1717
 * useful when something changes in the configuration and we want to make
 * the cluster aware ASAP (for instance after a slave promotion). */
1718
void clusterBroadcastPong(void) {
1719 1720 1721
    dictIterator *di;
    dictEntry *de;

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

1726
        if (!node->link) continue;
1727 1728 1729 1730 1731 1732
        if (node->flags & (REDIS_NODE_MYSELF|REDIS_NODE_HANDSHAKE)) continue;
        clusterSendPing(node->link,CLUSTERMSG_TYPE_PONG);
    }
    dictReleaseIterator(di);
}

1733 1734 1735 1736
/* 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) {
1737
    unsigned char buf[sizeof(clusterMsg)], *payload;
1738 1739 1740
    clusterMsg *hdr = (clusterMsg*) buf;
    uint32_t totlen;
    uint32_t channel_len, message_len;
A
antirez 已提交
1741

1742 1743 1744 1745
    channel = getDecodedObject(channel);
    message = getDecodedObject(message);
    channel_len = sdslen(channel->ptr);
    message_len = sdslen(message->ptr);
A
antirez 已提交
1746

1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759
    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);
1760
        memcpy(payload,hdr,sizeof(*hdr));
1761
        hdr = (clusterMsg*) payload;
A
antirez 已提交
1762
    }
1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774
    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 已提交
1775 1776 1777 1778 1779 1780 1781 1782
}

/* 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) {
1783
    unsigned char buf[sizeof(clusterMsg)];
A
antirez 已提交
1784 1785 1786 1787 1788 1789 1790
    clusterMsg *hdr = (clusterMsg*) buf;

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

1791 1792 1793 1794
/* Send an UPDATE message to the specified link carrying the specified 'node'
 * slots configuration. The node name, slots bitmap, and configEpoch info
 * are included. */
void clusterSendUpdate(clusterLink *link, clusterNode *node) {
1795
    unsigned char buf[sizeof(clusterMsg)];
1796 1797
    clusterMsg *hdr = (clusterMsg*) buf;

1798
    if (link == NULL) return;
1799 1800 1801 1802 1803 1804 1805
    clusterBuildMessageHdr(hdr,CLUSTERMSG_TYPE_UPDATE);
    memcpy(hdr->data.update.nodecfg.nodename,node->name,REDIS_CLUSTER_NAMELEN);
    hdr->data.update.nodecfg.configEpoch = htonu64(node->configEpoch);
    memcpy(hdr->data.update.nodecfg.slots,node->slots,sizeof(node->slots));
    clusterSendMessage(link,buf,ntohl(hdr->totlen));
}

1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816
/* -----------------------------------------------------------------------------
 * 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);
}

1817 1818 1819 1820
/* -----------------------------------------------------------------------------
 * SLAVE node specific functions
 * -------------------------------------------------------------------------- */

1821 1822 1823 1824 1825 1826 1827
/* 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) {
1828
    unsigned char buf[sizeof(clusterMsg)];
1829 1830 1831 1832 1833 1834
    clusterMsg *hdr = (clusterMsg*) buf;
    uint32_t totlen;

    clusterBuildMessageHdr(hdr,CLUSTERMSG_TYPE_FAILOVER_AUTH_REQUEST);
    totlen = sizeof(clusterMsg)-sizeof(union clusterMsgData);
    hdr->totlen = htonl(totlen);
1835
    clusterBroadcastMessage(buf,totlen);
1836 1837
}

1838 1839
/* Send a FAILOVER_AUTH_ACK message to the specified node. */
void clusterSendFailoverAuth(clusterNode *node) {
1840
    unsigned char buf[sizeof(clusterMsg)];
1841 1842 1843 1844 1845 1846 1847
    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);
1848
    clusterSendMessage(node->link,buf,totlen);
1849 1850
}

1851
/* Vote for the node asking for our vote if there are the conditions. */
1852
void clusterSendFailoverAuthIfNeeded(clusterNode *node, clusterMsg *request) {
1853
    clusterNode *master = node->slaveof;
1854 1855 1856 1857
    uint64_t requestCurrentEpoch = ntohu64(request->currentEpoch);
    uint64_t requestConfigEpoch = ntohu64(request->configEpoch);
    unsigned char *claimed_slots = request->myslots;
    int j;
1858 1859 1860

    /* IF we are not a master serving at least 1 slot, we don't have the
     * right to vote, as the cluster size in Redis Cluster is the number
1861 1862
     * of masters serving at least one slot, and quorum is the cluster
     * size + 1 */
1863 1864 1865 1866
    if (!(server.cluster->myself->flags & REDIS_NODE_MASTER)) return;
    if (server.cluster->myself->numslots == 0) return;

    /* Request epoch must be >= our currentEpoch. */
1867 1868 1869 1870
    if (requestCurrentEpoch < server.cluster->currentEpoch) {
        printf("REFUSED BECAUSE OF EPOCH\n");
        return;
    }
1871

1872
    /* I already voted for this epoch? Return ASAP. */
1873 1874 1875 1876
    if (server.cluster->last_vote_epoch == server.cluster->currentEpoch) {
        printf("REFUSED BECAUSE ALREADY VOTED FOR EPOCH\n");
        return;
    }
1877 1878

    /* Node must be a slave and its master down. */
1879 1880
    if (!(node->flags & REDIS_NODE_SLAVE) ||
        master == NULL ||
1881 1882 1883 1884 1885
        !(master->flags & REDIS_NODE_FAIL))
    {
        printf("REFUSED BECAUSE NOT A SLAVE OR MASTER NOT FAIL.\n");
        return;
    }
1886

1887 1888 1889
    /* We did not voted for a slave about this master for two
     * times the node timeout. This is not strictly needed for correctness
     * of the algorithm but makes the base case more linear. */
1890
    if (mstime() - node->slaveof->voted_time < server.cluster_node_timeout * 2)
1891 1892
    {
        printf("REFUSED BECAUSE ALREADY VOTED WITHIN NODE_TIMEOUT*2.\n");
1893
        return;
1894
    }
1895

1896 1897 1898
    /* The slave requesting the vote must have a configEpoch for the claimed
     * slots that is >= the one of the masters currently serving the same
     * slots in the current configuration. */
1899 1900 1901 1902 1903 1904 1905
    for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
        if (bitmapTestBit(claimed_slots, j) == 0) continue;
        if (server.cluster->slots[j] == NULL ||
            server.cluster->slots[j]->configEpoch <= requestConfigEpoch) continue;
        /* If we reached this point we found a slot that in our current slots
         * is served by a master with a greater configEpoch than the one claimed
         * by the slave requesting our vote. Refuse to vote for this slave. */
1906
        printf("REFUSED BECAUSE SLAVE CONFIG EPOCH FOR SLOTS IS STALE.\n");
1907 1908 1909
        return;
    }

1910
    /* We can vote for this slave. */
1911
    printf("I VOTED.\n");
1912
    clusterSendFailoverAuth(node);
1913
    server.cluster->last_vote_epoch = server.cluster->currentEpoch;
1914
    node->slaveof->voted_time = mstime();
1915 1916
}

1917
/* This function is called if we are a slave node and our master serving
1918
 * a non-zero amount of hash slots is in FAIL state.
1919 1920 1921
 *
 * The gaol of this function is:
 * 1) To check if we are able to perform a failover, is our data updated?
1922
 * 2) Try to get elected by masters.
1923
 * 3) Perform the failover informing all the other nodes.
1924 1925
 */
void clusterHandleSlaveFailover(void) {
1926
    mstime_t data_age;
1927
    mstime_t auth_age = mstime() - server.cluster->failover_auth_time;
1928
    int needed_quorum = (server.cluster->size / 2) + 1;
1929
    int j;
1930

1931 1932
    /* Set data_age to the number of seconds we are disconnected from
     * the master. */
1933
    if (server.repl_state == REDIS_REPL_CONNECTED) {
1934
        data_age = (server.unixtime - server.master->lastinteraction) * 1000;
1935
    } else {
1936
        data_age = (server.unixtime - server.repl_down_since) * 1000;
1937 1938
    }

1939 1940 1941 1942 1943 1944 1945 1946 1947
    /* Pre conditions to run the function:
     * 1) We are a slave.
     * 2) Our master is flagged as FAIL.
     * 3) It is serving slots. */
    if (!(server.cluster->myself->flags & REDIS_NODE_SLAVE) ||
        server.cluster->myself->slaveof == NULL ||
        !(server.cluster->myself->slaveof->flags & REDIS_NODE_FAIL) ||
        server.cluster->myself->slaveof->numslots == 0) return;

1948 1949 1950 1951 1952 1953
    /* Remove the node timeout from the data age as it is fine that we are
     * disconnected from our master at least for the time it was down to be
     * flagged as FAIL, that's the baseline. */
    if (data_age > server.cluster_node_timeout)
        data_age -= server.cluster_node_timeout;

1954 1955 1956
    /* 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. */
1957
    if (data_age >
1958 1959
        (server.repl_ping_slave_period * 1000) +
        (server.cluster_node_timeout * REDIS_CLUSTER_SLAVE_VALIDITY_MULT))
1960
        return;
1961

1962
    /* Compute the time at which we can start an election. */
1963
    if (auth_age >
1964
        server.cluster_node_timeout * REDIS_CLUSTER_FAILOVER_AUTH_RETRY_MULT)
1965
    {
1966 1967
        server.cluster->failover_auth_time = mstime() +
            500 + /* Fixed delay of 500 milliseconds, let FAIL msg propagate. */
1968
            data_age / 10 + /* Add 100 milliseconds for every second of age. */
1969
            random() % 500; /* Random delay between 0 and 500 milliseconds. */
1970
        server.cluster->failover_auth_count = 0;
1971
        server.cluster->failover_auth_sent = 0;
1972 1973
        redisLog(REDIS_WARNING,
            "Start of election delayed for %lld milliseconds.",
1974 1975 1976 1977 1978 1979 1980 1981
            server.cluster->failover_auth_time - mstime());
        return;
    }

    /* Return ASAP if we can't still start the election. */
    if (mstime() < server.cluster->failover_auth_time) return;

    /* Return ASAP if the election is too old to be valid. */
1982
    if (auth_age > server.cluster_node_timeout) return;
1983 1984 1985 1986 1987 1988

    /* Ask for votes if needed. */
    if (server.cluster->failover_auth_sent == 0) {
        server.cluster->currentEpoch++;
        server.cluster->failover_auth_epoch = server.cluster->currentEpoch;
        redisLog(REDIS_WARNING,"Starting a failover election for epoch %llu.",
1989
            (unsigned long long) server.cluster->currentEpoch);
1990
        clusterRequestFailoverAuth();
1991
        server.cluster->failover_auth_sent = 1;
A
antirez 已提交
1992 1993 1994
        clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                             CLUSTER_TODO_UPDATE_STATE|
                             CLUSTER_TODO_FSYNC_CONFIG);
1995 1996 1997 1998
        return; /* Wait for replies. */
    }

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

2002
        redisLog(REDIS_WARNING,
A
antirez 已提交
2003
            "Failover election won: I'm the new master.");
A
antirez 已提交
2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014
        /* 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;
        server.cluster->myself->slaveof = NULL;
        replicationUnsetMaster();

2015 2016 2017 2018 2019 2020 2021 2022
        /* 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);
            }
        }

2023
        /* 3) Update my configEpoch to the epoch of the election. */
2024 2025
        server.cluster->myself->configEpoch =
            server.cluster->failover_auth_epoch;
2026

2027
        /* 4) Update state and save config. */
2028
        clusterUpdateState();
A
antirez 已提交
2029
        clusterSaveConfigOrDie(1);
2030 2031 2032 2033

        /* 5) Pong all the other nodes so that they can update the state
         *    accordingly and detect that we switched to master role. */
        clusterBroadcastPong();
2034
    }
2035 2036
}

A
antirez 已提交
2037 2038 2039 2040
/* -----------------------------------------------------------------------------
 * CLUSTER cron job
 * -------------------------------------------------------------------------- */

2041
/* This is executed 10 times every second */
A
antirez 已提交
2042 2043 2044
void clusterCron(void) {
    dictIterator *di;
    dictEntry *de;
2045
    int j, update_state = 0;
2046
    mstime_t min_pong = 0, now = mstime();
2047
    clusterNode *min_pong_node = NULL;
2048
    static unsigned long long iteration = 0;
2049
    mstime_t handshake_timeout;
2050 2051

    iteration++; /* Number of times this function was called so far. */
A
antirez 已提交
2052

2053
    /* The handshake timeout is the time after which a handshake node that was
2054 2055 2056 2057 2058 2059
     * not turned into a normal node is removed from the nodes. Usually it is
     * just the NODE_TIMEOUT value, but when NODE_TIMEOUT is too small we use
     * the value of 1 second. */
    handshake_timeout = server.cluster_node_timeout;
    if (handshake_timeout < 1000) handshake_timeout = 1000;

G
guiquanz 已提交
2060
    /* Check if we have disconnected nodes and re-establish the connection. */
2061
    di = dictGetSafeIterator(server.cluster->nodes);
A
antirez 已提交
2062
    while((de = dictNext(di)) != NULL) {
2063
        clusterNode *node = dictGetVal(de);
A
antirez 已提交
2064 2065

        if (node->flags & (REDIS_NODE_MYSELF|REDIS_NODE_NOADDR)) continue;
2066 2067 2068 2069

        /* A Node in HANDSHAKE state has a limited lifespan equal to the
         * configured node timeout. */
        if (node->flags & REDIS_NODE_HANDSHAKE &&
2070
            now - node->ctime > handshake_timeout)
2071 2072 2073 2074 2075
        {
            freeClusterNode(node);
            continue;
        }

A
antirez 已提交
2076 2077
        if (node->link == NULL) {
            int fd;
2078
            mstime_t old_ping_sent;
A
antirez 已提交
2079 2080 2081 2082 2083 2084 2085 2086 2087
            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);
2088 2089 2090 2091
            /* 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 已提交
2092 2093
             * of a PING one, to force the receiver to add us in its node
             * table. */
2094
            old_ping_sent = node->ping_sent;
A
antirez 已提交
2095 2096
            clusterSendPing(link, node->flags & REDIS_NODE_MEET ?
                    CLUSTERMSG_TYPE_MEET : CLUSTERMSG_TYPE_PING);
2097 2098 2099 2100 2101 2102
            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 已提交
2103 2104 2105 2106 2107 2108 2109
            /* 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;

2110
            redisLog(REDIS_DEBUG,"Connecting with Node %.40s at %s:%d", node->name, node->ip, node->port+REDIS_CLUSTER_PORT_INCR);
A
antirez 已提交
2111 2112 2113 2114
        }
    }
    dictReleaseIterator(di);

2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134
    /* Ping some random node 1 time every 10 iterations, so that we usually ping
     * one random node every second. */
    if (!(iteration % 10)) {
        /* Check a few random nodes and ping the one with the oldest
         * pong_received time. */
        for (j = 0; j < 5; j++) {
            de = dictGetRandomKey(server.cluster->nodes);
            clusterNode *this = dictGetVal(de);

            /* Don't ping nodes disconnected or with a ping currently active. */
            if (this->link == NULL || this->ping_sent != 0) continue;
            if (this->flags & (REDIS_NODE_MYSELF|REDIS_NODE_HANDSHAKE)) continue;
            if (min_pong_node == NULL || min_pong > this->pong_received) {
                min_pong_node = this;
                min_pong = this->pong_received;
            }
        }
        if (min_pong_node) {
            redisLog(REDIS_DEBUG,"Pinging node %.40s", min_pong_node->name);
            clusterSendPing(min_pong_node->link, CLUSTERMSG_TYPE_PING);
A
antirez 已提交
2135 2136 2137 2138
        }
    }

    /* Iterate nodes to check if we need to flag something as failing */
2139
    di = dictGetSafeIterator(server.cluster->nodes);
A
antirez 已提交
2140
    while((de = dictNext(di)) != NULL) {
2141
        clusterNode *node = dictGetVal(de);
2142
        now = mstime(); /* Use an updated time at every iteration. */
2143
        mstime_t delay;
A
antirez 已提交
2144 2145

        if (node->flags &
2146 2147
            (REDIS_NODE_MYSELF|REDIS_NODE_NOADDR|REDIS_NODE_HANDSHAKE))
                continue;
2148

2149 2150 2151 2152
        /* 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 */
2153
            now - node->link->ctime >
2154
            server.cluster_node_timeout && /* was not already reconnected */
2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167
            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. */
2168
        if (node->link &&
2169 2170
            node->ping_sent == 0 &&
            (now - node->pong_received) > server.cluster_node_timeout/2)
2171 2172 2173 2174 2175
        {
            clusterSendPing(node->link, CLUSTERMSG_TYPE_PING);
            continue;
        }

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

2179 2180 2181 2182
        /* 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;
2183

2184
        if (delay > server.cluster_node_timeout) {
G
guiquanz 已提交
2185
            /* Timeout reached. Set the node as possibly failing if it is
2186
             * not already in this state. */
2187
            if (!(node->flags & (REDIS_NODE_PFAIL|REDIS_NODE_FAIL))) {
A
antirez 已提交
2188 2189 2190
                redisLog(REDIS_DEBUG,"*** NODE %.40s possibly failing",
                    node->name);
                node->flags |= REDIS_NODE_PFAIL;
2191
                update_state = 1;
A
antirez 已提交
2192 2193 2194 2195
            }
        }
    }
    dictReleaseIterator(di);
2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207

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

2209 2210 2211 2212 2213 2214 2215
    clusterHandleSlaveFailover();
    if (update_state) clusterUpdateState();
}

/* This function is called before the event handler returns to sleep for
 * events. It is useful to perform operations that must be done ASAP in
 * reaction to events fired but that are not safe to perform inside event
A
antirez 已提交
2216 2217
 * handlers, or to perform potentially expansive tasks that we need to do
 * a single time before replying to clients. */
2218
void clusterBeforeSleep(void) {
A
antirez 已提交
2219 2220 2221
    /* Handle failover, this is needed when it is likely that there is already
     * the quorum from masters in order to react fast. */
    if (server.cluster->todo_before_sleep & CLUSTER_TODO_HANDLE_FAILOVER)
2222
        clusterHandleSlaveFailover();
A
antirez 已提交
2223 2224 2225 2226 2227 2228 2229 2230 2231

    /* Update the cluster state. */
    if (server.cluster->todo_before_sleep & CLUSTER_TODO_UPDATE_STATE)
        clusterUpdateState();

    /* Save the config, possibly using fsync. */
    if (server.cluster->todo_before_sleep & CLUSTER_TODO_SAVE_CONFIG) {
        int fsync = server.cluster->todo_before_sleep & CLUSTER_TODO_FSYNC_CONFIG;
        clusterSaveConfigOrDie(fsync);
2232
    }
A
antirez 已提交
2233 2234 2235 2236 2237 2238 2239

    /* Reset our flags. */
    server.cluster->todo_before_sleep = 0;
}

void clusterDoBeforeSleep(int flags) {
    server.cluster->todo_before_sleep |= flags;
A
antirez 已提交
2240 2241 2242 2243 2244 2245
}

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

2246
/* Test bit 'pos' in a generic bitmap. Return 1 if the bit is set,
2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267
 * 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 已提交
2268 2269
/* Set the slot bit and return the old value. */
int clusterNodeSetSlotBit(clusterNode *n, int slot) {
2270 2271
    int old = bitmapTestBit(n->slots,slot);
    bitmapSetBit(n->slots,slot);
2272
    if (!old) n->numslots++;
A
antirez 已提交
2273 2274 2275 2276 2277
    return old;
}

/* Clear the slot bit and return the old value. */
int clusterNodeClearSlotBit(clusterNode *n, int slot) {
2278 2279
    int old = bitmapTestBit(n->slots,slot);
    bitmapClearBit(n->slots,slot);
2280
    if (old) n->numslots--;
A
antirez 已提交
2281 2282 2283 2284 2285
    return old;
}

/* Return the slot bit from the cluster node structure. */
int clusterNodeGetSlotBit(clusterNode *n, int slot) {
2286
    return bitmapTestBit(n->slots,slot);
A
antirez 已提交
2287 2288 2289 2290 2291 2292 2293
}

/* 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) {
2294 2295
    if (server.cluster->slots[slot]) return REDIS_ERR;
    clusterNodeSetSlotBit(n,slot);
2296
    server.cluster->slots[slot] = n;
A
antirez 已提交
2297 2298 2299
    return REDIS_OK;
}

A
antirez 已提交
2300 2301 2302 2303
/* 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) {
2304
    clusterNode *n = server.cluster->slots[slot];
A
antirez 已提交
2305 2306 2307

    if (!n) return REDIS_ERR;
    redisAssert(clusterNodeClearSlotBit(n,slot) == 1);
2308
    server.cluster->slots[slot] = NULL;
A
antirez 已提交
2309 2310 2311
    return REDIS_OK;
}

2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323
/* 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 已提交
2324 2325 2326
/* -----------------------------------------------------------------------------
 * Cluster state evaluation function
 * -------------------------------------------------------------------------- */
2327 2328 2329

#define REDIS_CLUSTER_MAX_REJOIN_DELAY 5000

A
antirez 已提交
2330
void clusterUpdateState(void) {
2331
    int j, new_state;
2332
    int unreachable_masters = 0;
2333
    static mstime_t among_minority_time;
A
antirez 已提交
2334

2335 2336
    /* Start assuming the state is OK. We'll turn it into FAIL if there
     * are the right conditions. */
2337
    new_state = REDIS_CLUSTER_OK;
2338

2339
    /* Check if all the slots are covered. */
A
antirez 已提交
2340
    for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
2341 2342
        if (server.cluster->slots[j] == NULL ||
            server.cluster->slots[j]->flags & (REDIS_NODE_FAIL))
A
antirez 已提交
2343
        {
2344
            new_state = REDIS_CLUSTER_FAIL;
A
antirez 已提交
2345 2346 2347
            break;
        }
    }
2348

2349
    /* Compute the cluster size, that is the number of master nodes
2350 2351 2352 2353
     * serving at least a single slot.
     *
     * At the same time count the number of unreachable masters with
     * at least one node. */
2354 2355 2356 2357 2358
    {
        dictIterator *di;
        dictEntry *de;

        server.cluster->size = 0;
2359
        di = dictGetSafeIterator(server.cluster->nodes);
2360 2361 2362
        while((de = dictNext(di)) != NULL) {
            clusterNode *node = dictGetVal(de);

2363
            if (node->flags & REDIS_NODE_MASTER && node->numslots) {
2364
                server.cluster->size++;
2365 2366 2367
                if (node->flags & (REDIS_NODE_FAIL|REDIS_NODE_PFAIL))
                    unreachable_masters++;
            }
2368 2369 2370
        }
        dictReleaseIterator(di);
    }
2371

2372
    /* If we can't reach at least half the masters, change the cluster state
2373
     * to FAIL, as we are not even able to mark nodes as FAIL in this side
2374
     * of the netsplit because of lack of majority. */
2375 2376 2377
    {
        int needed_quorum = (server.cluster->size / 2) + 1;
        
2378 2379 2380 2381
        if (unreachable_masters >= needed_quorum) {
            new_state = REDIS_CLUSTER_FAIL;
            among_minority_time = mstime();
        }
2382 2383
    }

2384
    /* Log a state change */
2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402
    if (new_state != server.cluster->state) {
        mstime_t rejoin_delay = server.cluster_node_timeout;

        /* If the instance is a master and was partitioned away with the
         * minority, don't let it accept queries for some time after the
         * partition heals, to make sure there is enough time to receive
         * a configuration update. */
        if (rejoin_delay > REDIS_CLUSTER_MAX_REJOIN_DELAY)
            rejoin_delay = REDIS_CLUSTER_MAX_REJOIN_DELAY;

        if (new_state == REDIS_CLUSTER_OK &&
            server.cluster->myself->flags & REDIS_NODE_MASTER &&
            mstime() - among_minority_time < rejoin_delay)
        {
            return;
        }

        /* Change the state and log the event. */
2403
        redisLog(REDIS_WARNING,"Cluster state changed: %s",
2404 2405 2406
            new_state == REDIS_CLUSTER_OK ? "ok" : "fail");
        server.cluster->state = new_state;
    }
A
antirez 已提交
2407 2408
}

2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431
/* 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) {
2432 2433 2434
    int j;
    int update_config = 0;

2435 2436 2437 2438
    /* 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;

2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471
    /* 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];
        }
    }
A
antirez 已提交
2472
    if (update_config) clusterSaveConfigOrDie(1);
2473 2474 2475
    return REDIS_OK;
}

2476 2477 2478 2479
/* -----------------------------------------------------------------------------
 * SLAVE nodes handling
 * -------------------------------------------------------------------------- */

2480 2481
/* Set the specified node 'n' as master. Setup the node as a slave if
 * needed. */
2482 2483 2484 2485
void clusterSetMaster(clusterNode *n) {
    clusterNode *myself = server.cluster->myself;

    redisAssert(n != myself);
2486
    redisAssert(myself->numslots == 0);
2487 2488 2489 2490 2491 2492

    if (myself->flags & REDIS_NODE_MASTER) {
        myself->flags &= ~REDIS_NODE_MASTER;
        myself->flags |= REDIS_NODE_SLAVE;
    }
    myself->slaveof = n;
2493
    replicationSetMaster(n->ip, n->port);
2494 2495
}

A
antirez 已提交
2496 2497 2498 2499
/* -----------------------------------------------------------------------------
 * CLUSTER command
 * -------------------------------------------------------------------------- */

2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512
/* 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 已提交
2513 2514 2515
    sds ci = sdsempty();
    dictIterator *di;
    dictEntry *de;
2516
    int j, start;
A
antirez 已提交
2517

2518
    di = dictGetSafeIterator(server.cluster->nodes);
A
antirez 已提交
2519
    while((de = dictNext(di)) != NULL) {
2520
        clusterNode *node = dictGetVal(de);
A
antirez 已提交
2521

2522 2523
        if (node->flags & filter) continue;

A
antirez 已提交
2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547
        /* Node coordinates */
        ci = sdscatprintf(ci,"%.40s %s:%d ",
            node->name,
            node->ip,
            node->port);

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

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

        /* Latency from the POV of this node, link status */
2548 2549 2550
        ci = sdscatprintf(ci,"%lld %lld %llu %s",
            (long long) node->ping_sent,
            (long long) node->pong_received,
2551
            (unsigned long long) node->configEpoch,
2552 2553
            (node->link || node->flags & REDIS_NODE_MYSELF) ?
                        "connected" : "disconnected");
2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573

        /* 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;
            }
        }
2574 2575 2576 2577 2578 2579

        /* 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++) {
2580
                if (server.cluster->migrating_slots_to[j]) {
A
antirez 已提交
2581
                    ci = sdscatprintf(ci," [%d->-%.40s]",j,
2582 2583
                        server.cluster->migrating_slots_to[j]->name);
                } else if (server.cluster->importing_slots_from[j]) {
A
antirez 已提交
2584
                    ci = sdscatprintf(ci," [%d-<-%.40s]",j,
2585
                        server.cluster->importing_slots_from[j]->name);
2586 2587 2588
                }
            }
        }
2589
        ci = sdscatlen(ci,"\n",1);
A
antirez 已提交
2590 2591 2592 2593 2594
    }
    dictReleaseIterator(di);
    return ci;
}

2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606
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 已提交
2607 2608 2609 2610 2611 2612 2613 2614 2615
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) {
        long port;

2616
        if (getLongFromObjectOrReply(c, c->argv[3], &port, NULL) != REDIS_OK) {
A
antirez 已提交
2617 2618 2619 2620
            addReplyError(c,"Invalid TCP port specified");
            return;
        }

2621 2622 2623 2624 2625 2626 2627
        if (clusterStartHandshake(c->argv[2]->ptr,port) == 0 &&
            errno == EINVAL)
        {
            addReplyError(c,"Invalid node address specified");
        } else {
            addReply(c,shared.ok);
        }
A
antirez 已提交
2628
    } else if (!strcasecmp(c->argv[1]->ptr,"nodes") && c->argc == 2) {
2629
        /* CLUSTER NODES */
A
antirez 已提交
2630
        robj *o;
2631
        sds ci = clusterGenNodesDescription(0);
A
antirez 已提交
2632 2633 2634 2635

        o = createObject(REDIS_STRING,ci);
        addReplyBulk(c,o);
        decrRefCount(o);
2636 2637 2638 2639 2640 2641 2642
    } 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);
A
antirez 已提交
2643
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
2644
        addReply(c,shared.ok);
A
antirez 已提交
2645
    } else if ((!strcasecmp(c->argv[1]->ptr,"addslots") ||
A
antirez 已提交
2646 2647 2648 2649
               !strcasecmp(c->argv[1]->ptr,"delslots")) && c->argc >= 3)
    {
        /* CLUSTER ADDSLOTS <slot> [slot] ... */
        /* CLUSTER DELSLOTS <slot> [slot] ... */
2650
        int j, slot;
A
antirez 已提交
2651
        unsigned char *slots = zmalloc(REDIS_CLUSTER_SLOTS);
A
antirez 已提交
2652
        int del = !strcasecmp(c->argv[1]->ptr,"delslots");
A
antirez 已提交
2653 2654 2655 2656 2657

        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++) {
2658
            if ((slot = getSlotOrReply(c,c->argv[j])) == -1) {
A
antirez 已提交
2659 2660 2661
                zfree(slots);
                return;
            }
2662
            if (del && server.cluster->slots[slot] == NULL) {
2663
                addReplyErrorFormat(c,"Slot %d is already unassigned", slot);
A
antirez 已提交
2664 2665
                zfree(slots);
                return;
2666
            } else if (!del && server.cluster->slots[slot]) {
2667
                addReplyErrorFormat(c,"Slot %d is already busy", slot);
A
antirez 已提交
2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679
                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]) {
2680 2681 2682 2683
                int retval;

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

                retval = del ? clusterDelSlot(j) :
2688
                               clusterAddSlot(server.cluster->myself,j);
2689
                redisAssertWithInfo(c,NULL,retval == REDIS_OK);
A
antirez 已提交
2690 2691 2692
            }
        }
        zfree(slots);
A
antirez 已提交
2693
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
A
antirez 已提交
2694
        addReply(c,shared.ok);
2695
    } else if (!strcasecmp(c->argv[1]->ptr,"setslot") && c->argc >= 4) {
A
antirez 已提交
2696 2697
        /* SETSLOT 10 MIGRATING <node ID> */
        /* SETSLOT 10 IMPORTING <node ID> */
2698
        /* SETSLOT 10 STABLE */
A
antirez 已提交
2699
        /* SETSLOT 10 NODE <node ID> */
2700
        int slot;
2701 2702
        clusterNode *n;

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

2705
        if (!strcasecmp(c->argv[3]->ptr,"migrating") && c->argc == 5) {
2706
            if (server.cluster->slots[slot] != server.cluster->myself) {
2707 2708 2709
                addReplyErrorFormat(c,"I'm not the owner of hash slot %u",slot);
                return;
            }
2710 2711 2712 2713 2714
            if ((n = clusterLookupNode(c->argv[4]->ptr)) == NULL) {
                addReplyErrorFormat(c,"I don't know about node %s",
                    (char*)c->argv[4]->ptr);
                return;
            }
2715
            server.cluster->migrating_slots_to[slot] = n;
2716
        } else if (!strcasecmp(c->argv[3]->ptr,"importing") && c->argc == 5) {
2717
            if (server.cluster->slots[slot] == server.cluster->myself) {
2718 2719 2720 2721
                addReplyErrorFormat(c,
                    "I'm already the owner of hash slot %u",slot);
                return;
            }
2722 2723 2724 2725 2726
            if ((n = clusterLookupNode(c->argv[4]->ptr)) == NULL) {
                addReplyErrorFormat(c,"I don't know about node %s",
                    (char*)c->argv[3]->ptr);
                return;
            }
2727
            server.cluster->importing_slots_from[slot] = n;
2728
        } else if (!strcasecmp(c->argv[3]->ptr,"stable") && c->argc == 4) {
2729
            /* CLUSTER SETSLOT <SLOT> STABLE */
2730 2731
            server.cluster->importing_slots_from[slot] = NULL;
            server.cluster->migrating_slots_to[slot] = NULL;
2732
        } else if (!strcasecmp(c->argv[3]->ptr,"node") && c->argc == 5) {
2733 2734 2735
            /* CLUSTER SETSLOT <SLOT> NODE <NODE ID> */
            clusterNode *n = clusterLookupNode(c->argv[4]->ptr);

2736 2737 2738 2739 2740
            if (!n) {
                addReplyErrorFormat(c,"Unknown node %s",
                    (char*)c->argv[4]->ptr);
                return;
            }
2741 2742
            /* If this hash slot was served by 'myself' before to switch
             * make sure there are no longer local keys for this hash slot. */
2743 2744
            if (server.cluster->slots[slot] == server.cluster->myself &&
                n != server.cluster->myself)
2745
            {
2746
                if (countKeysInSlot(slot) != 0) {
2747 2748 2749 2750
                    addReplyErrorFormat(c, "Can't assign hashslot %d to a different node while I still hold keys for this hash slot.", slot);
                    return;
                }
            }
2751 2752 2753
            /* 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. */
2754 2755 2756
            if (server.cluster->slots[slot] == server.cluster->myself &&
                server.cluster->migrating_slots_to[slot])
                server.cluster->migrating_slots_to[slot] = NULL;
2757

2758 2759
            /* If this node was importing this slot, assigning the slot to
             * itself also clears the importing status. */
2760 2761
            if (n == server.cluster->myself &&
                server.cluster->importing_slots_from[slot])
2762
                server.cluster->importing_slots_from[slot] = NULL;
2763 2764
            clusterDelSlot(slot);
            clusterAddSlot(n,slot);
2765 2766
        } else {
            addReplyError(c,"Invalid CLUSTER SETSLOT action or number of arguments");
2767
            return;
2768
        }
A
antirez 已提交
2769
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
2770
        addReply(c,shared.ok);
A
antirez 已提交
2771
    } else if (!strcasecmp(c->argv[1]->ptr,"info") && c->argc == 2) {
2772
        /* CLUSTER INFO */
A
antirez 已提交
2773 2774 2775 2776 2777
        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++) {
2778
            clusterNode *n = server.cluster->slots[j];
A
antirez 已提交
2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796

            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"
2797
            "cluster_known_nodes:%lu\r\n"
2798
            "cluster_size:%d\r\n"
2799
            "cluster_current_epoch:%llu\r\n"
2800 2801
            "cluster_stats_messages_sent:%lld\r\n"
            "cluster_stats_messages_received:%lld\r\n"
2802
            , statestr[server.cluster->state],
A
antirez 已提交
2803 2804 2805
            slots_assigned,
            slots_ok,
            slots_pfail,
2806
            slots_fail,
2807
            dictSize(server.cluster->nodes),
2808
            server.cluster->size,
2809 2810 2811
            (unsigned long long) server.cluster->currentEpoch,
            server.cluster->stats_bus_messages_sent,
            server.cluster->stats_bus_messages_received
A
antirez 已提交
2812 2813 2814 2815 2816
        );
        addReplySds(c,sdscatprintf(sdsempty(),"$%lu\r\n",
            (unsigned long)sdslen(info)));
        addReplySds(c,info);
        addReply(c,shared.crlf);
2817
    } else if (!strcasecmp(c->argv[1]->ptr,"saveconfig") && c->argc == 2) {
A
antirez 已提交
2818
        int retval = clusterSaveConfig(1);
2819 2820 2821 2822 2823 2824

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

        addReplyLongLong(c,keyHashSlot(key,sdslen(key)));
2830
    } else if (!strcasecmp(c->argv[1]->ptr,"countkeysinslot") && c->argc == 3) {
2831
        /* CLUSTER COUNTKEYSINSLOT <slot> */
2832 2833 2834 2835
        long long slot;

        if (getLongLongFromObjectOrReply(c,c->argv[2],&slot,NULL) != REDIS_OK)
            return;
2836 2837 2838 2839
        if (slot < 0 || slot >= REDIS_CLUSTER_SLOTS) {
            addReplyError(c,"Invalid slot");
            return;
        }
2840
        addReplyLongLong(c,countKeysInSlot(slot));
A
antirez 已提交
2841
    } else if (!strcasecmp(c->argv[1]->ptr,"getkeysinslot") && c->argc == 4) {
2842
        /* CLUSTER GETKEYSINSLOT <slot> <count> */
A
antirez 已提交
2843
        long long maxkeys, slot;
2844
        unsigned int numkeys, j;
A
antirez 已提交
2845 2846 2847 2848 2849 2850
        robj **keys;

        if (getLongLongFromObjectOrReply(c,c->argv[2],&slot,NULL) != REDIS_OK)
            return;
        if (getLongLongFromObjectOrReply(c,c->argv[3],&maxkeys,NULL) != REDIS_OK)
            return;
2851
        if (slot < 0 || slot >= REDIS_CLUSTER_SLOTS || maxkeys < 0) {
A
antirez 已提交
2852 2853 2854 2855 2856
            addReplyError(c,"Invalid slot or number of keys");
            return;
        }

        keys = zmalloc(sizeof(robj*)*maxkeys);
2857
        numkeys = getKeysInSlot(slot, keys, maxkeys);
A
antirez 已提交
2858 2859 2860
        addReplyMultiBulkLen(c,numkeys);
        for (j = 0; j < numkeys; j++) addReplyBulk(c,keys[j]);
        zfree(keys);
A
antirez 已提交
2861 2862 2863 2864 2865 2866 2867 2868 2869
    } 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);
A
antirez 已提交
2870
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
A
antirez 已提交
2871
        addReply(c,shared.ok);
2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904
    } 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);
A
antirez 已提交
2905
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
2906
        addReply(c,shared.ok);
A
antirez 已提交
2907 2908 2909 2910 2911 2912
    } else {
        addReplyError(c,"Wrong CLUSTER subcommand or number of arguments");
    }
}

/* -----------------------------------------------------------------------------
2913
 * DUMP, RESTORE and MIGRATE commands
A
antirez 已提交
2914 2915
 * -------------------------------------------------------------------------- */

2916 2917 2918
/* 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) {
2919 2920
    unsigned char buf[2];
    uint64_t crc;
2921 2922 2923 2924 2925 2926 2927 2928

    /* 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:
2929 2930 2931 2932 2933
     * ----------------+---------------------+---------------+
     * ... RDB payload | 2 bytes RDB version | 8 bytes CRC64 |
     * ----------------+---------------------+---------------+
     * RDB version and CRC are both in little endian.
     */
2934 2935

    /* RDB version */
2936 2937
    buf[0] = REDIS_RDB_VERSION & 0xff;
    buf[1] = (REDIS_RDB_VERSION >> 8) & 0xff;
2938 2939
    payload->io.buffer.ptr = sdscatlen(payload->io.buffer.ptr,buf,2);

2940
    /* CRC64 */
2941
    crc = crc64(0,(unsigned char*)payload->io.buffer.ptr,
2942 2943 2944
                sdslen(payload->io.buffer.ptr));
    memrev64ifbe(&crc);
    payload->io.buffer.ptr = sdscatlen(payload->io.buffer.ptr,&crc,8);
2945 2946 2947
}

/* Verify that the RDB version of the dump payload matches the one of this Redis
2948
 * instance and that the checksum is ok.
2949 2950 2951
 * If the DUMP payload looks valid REDIS_OK is returned, otherwise REDIS_ERR
 * is returned. */
int verifyDumpPayload(unsigned char *p, size_t len) {
2952
    unsigned char *footer;
2953
    uint16_t rdbver;
2954
    uint64_t crc;
2955

2956
    /* At least 2 bytes of RDB version and 8 of CRC64 should be present. */
2957 2958
    if (len < 10) return REDIS_ERR;
    footer = p+(len-10);
2959 2960

    /* Verify RDB version */
2961
    rdbver = (footer[1] << 8) | footer[0];
2962
    if (rdbver != REDIS_RDB_VERSION) return REDIS_ERR;
2963

2964
    /* Verify CRC64 */
2965
    crc = crc64(0,p,len-8);
2966 2967
    memrev64ifbe(&crc);
    return (memcmp(&crc,footer+2,8) == 0) ? REDIS_OK : REDIS_ERR;
2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992
}

/* 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 已提交
2993
/* RESTORE key ttl serialized-value [REPLACE] */
A
antirez 已提交
2994
void restoreCommand(redisClient *c) {
2995
    long long ttl;
2996
    rio payload;
A
antirez 已提交
2997
    int j, type, replace = 0;
2998
    robj *obj;
A
antirez 已提交
2999

A
antirez 已提交
3000 3001 3002 3003 3004 3005 3006 3007 3008 3009
    /* 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 已提交
3010
    /* Make sure this key does not already exist here... */
A
antirez 已提交
3011
    if (!replace && lookupKeyWrite(c->db,c->argv[1]) != NULL) {
A
antirez 已提交
3012 3013 3014 3015 3016
        addReplyError(c,"Target key name is busy.");
        return;
    }

    /* Check if the TTL value makes sense */
3017
    if (getLongLongFromObjectOrReply(c,c->argv[2],&ttl,NULL) != REDIS_OK) {
A
antirez 已提交
3018 3019 3020 3021 3022 3023
        return;
    } else if (ttl < 0) {
        addReplyError(c,"Invalid TTL value, must be >= 0");
        return;
    }

3024
    /* Verify RDB version and data checksum. */
3025 3026
    if (verifyDumpPayload(c->argv[3]->ptr,sdslen(c->argv[3]->ptr)) == REDIS_ERR)
    {
3027 3028 3029 3030
        addReplyError(c,"DUMP payload version or checksum are wrong");
        return;
    }

3031
    rioInitWithBuffer(&payload,c->argv[3]->ptr);
3032 3033
    if (((type = rdbLoadObjectType(&payload)) == -1) ||
        ((obj = rdbLoadObject(type,&payload)) == NULL))
3034
    {
3035
        addReplyError(c,"Bad data format");
A
antirez 已提交
3036 3037 3038
        return;
    }

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

A
antirez 已提交
3042
    /* Create the key and set the TTL if any */
3043
    dbAdd(c->db,c->argv[1],obj);
3044
    if (ttl) setExpire(c->db,c->argv[1],mstime()+ttl);
3045
    signalModifiedKey(c->db,c->argv[1]);
A
antirez 已提交
3046
    addReply(c,shared.ok);
3047
    server.dirty++;
A
antirez 已提交
3048 3049
}

A
antirez 已提交
3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109
/* 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;
    }
3110
    anetEnableTcpNoDelay(server.neterr,fd);
A
antirez 已提交
3111 3112

    /* Check if it connects within the specified timeout. */
3113
    if ((aeWait(fd,AE_WRITABLE,timeout) & AE_WRITABLE) == 0) {
A
antirez 已提交
3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163
        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 已提交
3164
/* MIGRATE host port key dbid timeout [COPY | REPLACE] */
A
antirez 已提交
3165
void migrateCommand(redisClient *c) {
A
antirez 已提交
3166
    int fd, copy, replace, j;
A
antirez 已提交
3167 3168
    long timeout;
    long dbid;
A
antirez 已提交
3169
    long long ttl, expireat;
A
antirez 已提交
3170
    robj *o;
3171
    rio cmd, payload;
A
antirez 已提交
3172 3173 3174 3175 3176 3177 3178
    int retry_num = 0;

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

A
antirez 已提交
3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191
    /* 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 已提交
3192 3193 3194 3195 3196
    /* Sanity check */
    if (getLongFromObjectOrReply(c,c->argv[5],&timeout,NULL) != REDIS_OK)
        return;
    if (getLongFromObjectOrReply(c,c->argv[4],&dbid,NULL) != REDIS_OK)
        return;
3197
    if (timeout <= 0) timeout = 1000;
A
antirez 已提交
3198 3199 3200 3201 3202

    /* 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) {
3203
        addReplySds(c,sdsnew("+NOKEY\r\n"));
A
antirez 已提交
3204 3205 3206 3207
        return;
    }
    
    /* Connect */
A
antirez 已提交
3208 3209
    fd = migrateGetSocket(c,c->argv[1],c->argv[2],timeout);
    if (fd == -1) return; /* error sent to the client by migrateGetSocket() */
A
antirez 已提交
3210

3211
    /* Create RESTORE payload and generate the protocol to call the command. */
3212
    rioInitWithBuffer(&cmd,sdsempty());
3213 3214 3215
    redisAssertWithInfo(c,NULL,rioWriteBulkCount(&cmd,'*',2));
    redisAssertWithInfo(c,NULL,rioWriteBulkString(&cmd,"SELECT",6));
    redisAssertWithInfo(c,NULL,rioWriteBulkLongLong(&cmd,dbid));
A
antirez 已提交
3216

A
antirez 已提交
3217 3218 3219 3220 3221
    expireat = getExpire(c->db,c->argv[3]);
    if (expireat != -1) {
        ttl = expireat-mstime();
        if (ttl < 1) ttl = 1;
    }
A
antirez 已提交
3222
    redisAssertWithInfo(c,NULL,rioWriteBulkCount(&cmd,'*',replace ? 5 : 4));
3223 3224 3225 3226 3227
    if (server.cluster_enabled)
        redisAssertWithInfo(c,NULL,
            rioWriteBulkString(&cmd,"RESTORE-ASKING",14));
    else
        redisAssertWithInfo(c,NULL,rioWriteBulkString(&cmd,"RESTORE",7));
3228
    redisAssertWithInfo(c,NULL,sdsEncodedObject(c->argv[3]));
3229
    redisAssertWithInfo(c,NULL,rioWriteBulkString(&cmd,c->argv[3]->ptr,sdslen(c->argv[3]->ptr)));
3230
    redisAssertWithInfo(c,NULL,rioWriteBulkLongLong(&cmd,ttl));
A
antirez 已提交
3231

G
guiquanz 已提交
3232
    /* Emit the payload argument, that is the serialized object using
A
antirez 已提交
3233
     * the DUMP format. */
3234 3235 3236
    createDumpPayload(&payload,o);
    redisAssertWithInfo(c,NULL,rioWriteBulkString(&cmd,payload.io.buffer.ptr,
                                sdslen(payload.io.buffer.ptr)));
3237 3238
    sdsfree(payload.io.buffer.ptr);

A
antirez 已提交
3239 3240 3241 3242 3243
    /* 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 已提交
3244
    /* Transfer the query to the other node in 64K chunks. */
A
antirez 已提交
3245
    errno = 0;
A
antirez 已提交
3246
    {
3247 3248 3249 3250 3251 3252
        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);
3253
            nwritten = syncWrite(fd,buf+pos,towrite,timeout);
3254 3255
            if (nwritten != (signed)towrite) goto socket_wr_err;
            pos += nwritten;
A
antirez 已提交
3256 3257 3258
        }
    }

3259
    /* Read back the reply. */
A
antirez 已提交
3260 3261 3262 3263 3264 3265 3266 3267
    {
        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)
3268
            goto socket_rd_err;
A
antirez 已提交
3269 3270 3271 3272
        if (buf1[0] == '-' || buf2[0] == '-') {
            addReplyErrorFormat(c,"Target instance replied with error: %s",
                (buf1[0] == '-') ? buf1+1 : buf2+1);
        } else {
3273 3274
            robj *aux;

A
antirez 已提交
3275 3276 3277 3278 3279
            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 已提交
3280
            addReply(c,shared.ok);
3281 3282 3283
            server.dirty++;

            /* Translate MIGRATE as DEL for replication/AOF. */
A
antirez 已提交
3284
            aux = createStringObject("DEL",3);
3285 3286
            rewriteClientCommandVector(c,2,aux,c->argv[3]);
            decrRefCount(aux);
A
antirez 已提交
3287 3288 3289
        }
    }

3290
    sdsfree(cmd.io.buffer.ptr);
3291
    return;
A
antirez 已提交
3292 3293

socket_wr_err:
3294
    sdsfree(cmd.io.buffer.ptr);
A
antirez 已提交
3295
    migrateCloseSocket(c->argv[1],c->argv[2]);
A
antirez 已提交
3296 3297 3298
    if (errno != ETIMEDOUT && retry_num++ == 0) goto try_again;
    addReplySds(c,
        sdsnew("-IOERR error or timeout writing to target instance\r\n"));
3299
    return;
A
antirez 已提交
3300 3301

socket_rd_err:
3302
    sdsfree(cmd.io.buffer.ptr);
A
antirez 已提交
3303
    migrateCloseSocket(c->argv[1],c->argv[2]);
A
antirez 已提交
3304 3305 3306
    if (errno != ETIMEDOUT && retry_num++ == 0) goto try_again;
    addReplySds(c,
        sdsnew("-IOERR error or timeout reading from target node\r\n"));
3307 3308 3309
    return;
}

3310 3311 3312 3313
/* -----------------------------------------------------------------------------
 * Cluster functions related to serving / redirecting clients
 * -------------------------------------------------------------------------- */

3314
/* The ASKING command is required after a -ASK redirection.
G
guiquanz 已提交
3315
 * The client should issue ASKING before to actually send the command to
3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326
 * 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);
}

3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343
/* The READONLY command is uesd by clients to enter the read-only mode.
 * In this mode slaves will not redirect clients as long as clients access
 * with read-only commands to keys that are served by the slave's master. */
void readonlyCommand(redisClient *c) {
    if (server.cluster_enabled == 0) {
        addReplyError(c,"This instance has cluster support disabled");
        return;
    }
    c->flags |= REDIS_READONLY;
    addReply(c,shared.ok);
}

/* The READWRITE command just clears the READONLY command state. */
void readwriteCommand(redisClient *c) {
    c->flags &= ~REDIS_READONLY;
    addReply(c,shared.ok);
}
A
antirez 已提交
3344

3345 3346 3347
/* 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 已提交
3348
 *
3349 3350 3351 3352
 * 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.
 *
3353 3354
 * If the command contains multiple keys, and as a consequence it is not
 * possible to handle the request in Redis Cluster, NULL is returned. */
3355
clusterNode *getNodeByQuery(redisClient *c, struct redisCommand *cmd, robj **argv, int argc, int *hashslot, int *ask) {
A
antirez 已提交
3356
    clusterNode *n = NULL;
3357
    robj *firstkey = NULL;
A
antirez 已提交
3358 3359
    multiState *ms, _ms;
    multiCmd mc;
3360
    int i, slot = 0;
A
antirez 已提交
3361 3362 3363 3364 3365 3366

    /* 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. */
3367
        if (!(c->flags & REDIS_MULTI)) return server.cluster->myself;
A
antirez 已提交
3368 3369
        ms = &c->mstate;
    } else {
3370 3371 3372
        /* 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 已提交
3373 3374 3375 3376 3377 3378 3379 3380
        ms = &_ms;
        _ms.commands = &mc;
        _ms.count = 1;
        mc.argv = argv;
        mc.argc = argc;
        mc.cmd = cmd;
    }

3381 3382
    /* Check that all the keys are the same key, and get the slot and
     * node for this key. */
A
antirez 已提交
3383 3384 3385 3386 3387 3388 3389 3390 3391 3392
    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,
3393
                                      REDIS_GETKEYS_ALL);
A
antirez 已提交
3394
        for (j = 0; j < numkeys; j++) {
3395 3396 3397 3398 3399 3400
            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));
3401
                n = server.cluster->slots[slot];
3402
                redisAssertWithInfo(c,firstkey,n != NULL);
A
antirez 已提交
3403
            } else {
3404 3405 3406 3407 3408 3409
                /* 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 已提交
3410 3411 3412 3413
            }
        }
        getKeysFreeResult(keyindex);
    }
3414 3415 3416
    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. */
3417
    if (n == NULL) return server.cluster->myself;
3418 3419 3420 3421 3422
    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. */
3423 3424
    if (n == server.cluster->myself &&
        server.cluster->migrating_slots_to[slot] != NULL)
3425 3426 3427
    {
        if (lookupKeyRead(&server.db[0],firstkey) == NULL) {
            if (ask) *ask = 1;
3428
            return server.cluster->migrating_slots_to[slot];
3429 3430 3431 3432
        }
    }
    /* 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
3433 3434
     * it is assigned to a different node, but only if the client
     * issued an ASKING command before. */
3435
    if (server.cluster->importing_slots_from[slot] != NULL &&
3436
        (c->flags & REDIS_ASKING || cmd->flags & REDIS_CMD_ASKING)) {
3437
        return server.cluster->myself;
3438
    }
3439 3440 3441 3442 3443 3444 3445 3446 3447 3448
    /* Handle the read-only client case reading from a slave: if this
     * node is a slave and the request is about an hash slot our master
     * is serving, we can reply without redirection. */
    if (c->flags & REDIS_READONLY &&
        cmd->flags & REDIS_CMD_READONLY &&
        server.cluster->myself->flags & REDIS_NODE_SLAVE &&
        server.cluster->myself->slaveof == n)
    {
        return server.cluster->myself;
    }
3449 3450
    /* It's not a -ASK case. Base case: just return the right node. */
    return n;
A
antirez 已提交
3451
}