cluster.c 150.5 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 45 46 47
/* A global reference to myself is handy to make code more clear.
 * Myself always points to server.cluster->myself, that is, the clusterNode
 * that represents this node. */
clusterNode *myself = NULL;

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

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

76 77 78
/* Return the greatest configEpoch found in the cluster. */
uint64_t clusterGetMaxEpoch(void) {
    uint64_t max = 0;
79 80 81 82 83 84
    dictIterator *di;
    dictEntry *de;

    di = dictGetSafeIterator(server.cluster->nodes);
    while((de = dictNext(di)) != NULL) {
        clusterNode *node = dictGetVal(de);
85
        if (node->configEpoch > max) max = node->configEpoch;
86 87
    }
    dictReleaseIterator(di);
88
    return max;
89 90
}

A
antirez 已提交
91 92
int clusterLoadConfig(char *filename) {
    FILE *fp = fopen(filename,"r");
A
antirez 已提交
93
    char *line;
94
    int maxline, j;
A
antirez 已提交
95
   
A
antirez 已提交
96
    if (fp == NULL) return REDIS_ERR;
A
antirez 已提交
97 98 99

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

113 114 115 116 117 118 119 120 121
        /* 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;

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

176
        /* Set ping sent / pong received timestamps */
177 178
        if (atoi(argv[4])) n->ping_sent = mstime();
        if (atoi(argv[5])) n->pong_received = mstime();
179

180 181 182
        /* Set configEpoch for this node. */
        n->configEpoch = strtoull(argv[6],NULL,10);

183
        /* Populate hash slots served by this instance. */
184
        for (j = 8; j < argc; j++) {
185 186
            int start, stop;

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

220
        sdsfreesplitres(argv,argc);
A
antirez 已提交
221 222
    }
    zfree(line);
A
antirez 已提交
223 224
    fclose(fp);

A
antirez 已提交
225
    /* Config sanity check */
226
    redisAssert(server.cluster->myself != NULL);
227
    redisLog(REDIS_NOTICE,"Node configuration loaded, I'm %.40s", myself->name);
228 229 230 231
    /* Set the currentEpoch to the max epoch found in the master.
     * FIXME: this should actually be part of the persistent state, as
     * documented in the Github issue #1479. */
    server.cluster->currentEpoch = clusterGetMaxEpoch();
A
antirez 已提交
232 233 234
    return REDIS_OK;

fmterr:
G
guiquanz 已提交
235
    redisLog(REDIS_WARNING,"Unrecoverable error: corrupted cluster config file.");
A
antirez 已提交
236 237 238 239
    fclose(fp);
    exit(1);
}

A
antirez 已提交
240 241 242
/* Cluster node configuration is exactly the same as CLUSTER NODES output.
 *
 * This function writes the node config and returns 0, on error -1
243 244 245 246 247 248 249 250 251
 * 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 已提交
252
int clusterSaveConfig(int do_fsync) {
253
    sds ci = clusterGenNodesDescription(REDIS_NODE_HANDSHAKE);
254 255
    size_t content_size = sdslen(ci);
    struct stat sb;
A
antirez 已提交
256 257
    int fd;
    
258
    if ((fd = open(server.cluster_configfile,O_WRONLY|O_CREAT,0644))
A
antirez 已提交
259
        == -1) goto err;
260 261 262 263 264 265 266 267

    /* 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 已提交
268
    if (write(fd,ci,sdslen(ci)) != (ssize_t)sdslen(ci)) goto err;
A
antirez 已提交
269
    if (do_fsync) fsync(fd);
270 271 272 273 274 275

    /* 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 已提交
276 277 278 279 280
    close(fd);
    sdsfree(ci);
    return 0;

err:
281
    if (fd != -1) close(fd);
A
antirez 已提交
282 283 284 285
    sdsfree(ci);
    return -1;
}

A
antirez 已提交
286 287
void clusterSaveConfigOrDie(int do_fsync) {
    if (clusterSaveConfig(do_fsync) == -1) {
288 289 290 291 292
        redisLog(REDIS_WARNING,"Fatal: can't update cluster config file.");
        exit(1);
    }
}

A
antirez 已提交
293
void clusterInit(void) {
294
    int saveconf = 0;
295

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

    /* We need a listening TCP port for our cluster messaging needs. */
331
    server.cfd_count = 0;
332 333 334 335
    if (listenToPort(server.port+REDIS_CLUSTER_PORT_INCR,
        server.cfd,&server.cfd_count) == REDIS_ERR)
    {
        exit(1);
336 337 338 339 340 341 342 343 344
    } 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 已提交
345
    }
346 347

    /* The slots -> keys map is a sorted set. Init it. */
348
    server.cluster->slots_to_keys = zslCreate();
349
    resetManualFailover();
A
antirez 已提交
350 351 352 353 354 355 356 357
}

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

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

390
    cfd = anetTcpAccept(server.neterr, fd, cip, sizeof(cip), &cport);
A
antirez 已提交
391 392 393 394
    if (cfd == AE_ERR) {
        redisLog(REDIS_VERBOSE,"Accepting cluster node: %s", server.neterr);
        return;
    }
395 396 397 398
    anetNonBlock(NULL,cfd);
    anetEnableTcpNoDelay(NULL,cfd);

    /* Use non-blocking I/O for cluster messages. */
399
    /* IPV6: might want to wrap a v6 address in [] */
A
antirez 已提交
400 401 402 403 404 405 406 407 408 409 410 411 412
    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
 * -------------------------------------------------------------------------- */

413
/* We have 16384 hash slots. The hash slot of a given key is obtained
414 415 416 417 418
 * as the least significant 14 bits of the crc16 of the key.
 *
 * However if the key contains the {...} pattern, only the part between
 * { and } is hashed. This may be useful in the future to force certain
 * keys to be in the same node (assuming no resharding is in progress). */
A
antirez 已提交
419
unsigned int keyHashSlot(char *key, int keylen) {
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
    int s, e; /* start-end indexes of { and } */

    for (s = 0; s < keylen; s++)
        if (key[s] == '{') break;

    /* No '{' ? Hash the whole key. This is the base case. */
    if (s == keylen) return crc16(key,keylen) & 0x3FFF;

    /* '{' found? Check if we have the corresponding '}'. */
    for (e = s+1; e < keylen; e++)
        if (key[e] == '}') break;

    /* No '}' or nothing betweeen {} ? Hash the whole key. */
    if (e == keylen || e == s+1) return crc16(key,keylen) & 0x3FFF;

    /* If we are here there is both a { and a } on its right. Hash
     * what is in the middle between { and }. */
    return crc16(key+s+1,e-s-1) & 0x3FFF;
A
antirez 已提交
438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
}

/* -----------------------------------------------------------------------------
 * 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
457
        getRandomHexChars(node->name, REDIS_CLUSTER_NAMELEN);
458
    node->ctime = mstime();
459
    node->configEpoch = 0;
A
antirez 已提交
460 461
    node->flags = flags;
    memset(node->slots,0,sizeof(node->slots));
462
    node->numslots = 0;
A
antirez 已提交
463 464 465 466
    node->numslaves = 0;
    node->slaves = NULL;
    node->slaveof = NULL;
    node->ping_sent = node->pong_received = 0;
A
antirez 已提交
467
    node->fail_time = 0;
A
antirez 已提交
468
    node->link = NULL;
469
    memset(node->ip,0,sizeof(node->ip));
470
    node->port = 0;
471
    node->fail_reports = listCreate();
472
    node->voted_time = 0;
473 474
    node->repl_offset_time = 0;
    node->repl_offset = 0;
475
    listSetFreeMethod(node->fail_reports,zfree);
A
antirez 已提交
476 477 478
    return node;
}

479 480 481 482 483
/* 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
484 485 486 487 488 489
 * '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) {
490 491 492 493 494 495 496 497 498 499 500
    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) {
501
            fr->time = mstime();
502
            return 0;
503 504 505 506 507 508
        }
    }

    /* Otherwise create a new report. */
    fr = zmalloc(sizeof(*fr));
    fr->node = sender;
509
    fr->time = mstime();
510
    listAddNodeTail(l,fr);
511
    return 1;
512 513
}

514 515 516 517 518 519 520 521 522 523
/* 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;
524
    mstime_t maxtime = server.cluster_node_timeout *
525
                     REDIS_CLUSTER_FAIL_REPORT_VALIDITY_MULT;
526
    mstime_t now = mstime();
527 528 529 530 531 532 533 534

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

535 536 537 538 539 540 541
/* 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
542 543 544 545 546
 * time.
 *
 * The function returns 1 if the failure report was found and removed.
 * Otherwise 0 is returned. */
int clusterNodeDelFailureReport(clusterNode *node, clusterNode *sender) {
547 548 549 550 551 552 553 554 555 556 557
    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;
    }
558
    if (!ln) return 0; /* No failure report from this sender. */
559 560 561

    /* Remove the failure report. */
    listDelNode(l,ln);
562
    clusterNodeCleanupFailureReports(node);
563
    return 1;
564 565
}

566 567 568 569 570 571 572 573
/* 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 已提交
574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603
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;
604
    n->slaves = NULL;
A
antirez 已提交
605 606
}

607 608 609 610 611 612 613 614
int clusterCountNonFailingSlaves(clusterNode *n) {
    int j, okslaves = 0;

    for (j = 0; j < n->numslaves; j++)
        if (!nodeFailed(n->slaves[j])) okslaves++;
    return okslaves;
}

A
antirez 已提交
615 616
void freeClusterNode(clusterNode *n) {
    sds nodename;
617

A
antirez 已提交
618
    nodename = sdsnewlen(n->name, REDIS_CLUSTER_NAMELEN);
619
    redisAssert(dictDelete(server.cluster->nodes,nodename) == DICT_OK);
A
antirez 已提交
620 621 622
    sdsfree(nodename);
    if (n->slaveof) clusterNodeRemoveSlave(n->slaveof, n);
    if (n->link) freeClusterLink(n->link);
623
    listRelease(n->fail_reports);
A
antirez 已提交
624 625 626 627 628 629 630
    zfree(n);
}

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

A
antirez 已提交
636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657
/* 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. */
658
    di = dictGetSafeIterator(server.cluster->nodes);
A
antirez 已提交
659 660 661 662 663 664 665 666 667 668 669 670
    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 已提交
671 672 673 674 675
/* Node lookup by name */
clusterNode *clusterLookupNode(char *name) {
    sds s = sdsnewlen(name, REDIS_CLUSTER_NAMELEN);
    struct dictEntry *de;

676
    de = dictFind(server.cluster->nodes,s);
A
antirez 已提交
677 678
    sdsfree(s);
    if (de == NULL) return NULL;
679
    return dictGetVal(de);
A
antirez 已提交
680 681 682 683 684 685 686 687 688 689 690 691
}

/* 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);
692
    retval = dictDelete(server.cluster->nodes, s);
A
antirez 已提交
693 694 695 696 697 698
    sdsfree(s);
    redisAssert(retval == DICT_OK);
    memcpy(node->name, newname, REDIS_CLUSTER_NAMELEN);
    clusterAddNode(node);
}

699 700 701 702 703 704 705 706 707 708 709 710 711 712
/* -----------------------------------------------------------------------------
 * 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
713
 * in the cluster without dealing with the problem of other nodes re-adding
714 715
 * back the node to nodes we already sent the FORGET command to.
 *
716
 * The data structure used is a hash table with an sds string representing
717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749
 * 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();
750 751 752 753 754 755
    if (dictAdd(server.cluster->nodes_black_list,id,NULL) == DICT_OK) {
        /* If the key was added, duplicate the sds string representation of
         * the key for the next lookup. We'll free it at the end. */
        id = sdsdup(id);
    }
    de = dictFind(server.cluster->nodes_black_list,id);
756
    dictSetUnsignedIntegerVal(de,time(NULL)+REDIS_CLUSTER_BLACKLIST_TTL);
757
    sdsfree(id);
758 759 760 761 762 763 764 765 766
}

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

767
    clusterBlacklistCleanup();
768 769 770 771 772
    retval = dictFind(server.cluster->nodes_black_list,id) != NULL;
    sdsfree(id);
    return retval;
}

A
antirez 已提交
773 774 775 776
/* -----------------------------------------------------------------------------
 * CLUSTER messages exchange - PING/PONG and gossip
 * -------------------------------------------------------------------------- */

777 778 779
/* This function checks if a given node should be marked as FAIL.
 * It happens if the following conditions are met:
 *
780 781 782 783
 * 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.
784 785 786
 *
 * 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.
787 788 789 790 791 792 793 794 795 796
 *
 * 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.
797 798 799 800 801
 */
void markNodeAsFailingIfNeeded(clusterNode *node) {
    int failures;
    int needed_quorum = (server.cluster->size / 2) + 1;

802 803
    if (!nodeTimedOut(node)) return; /* We can reach it. */
    if (nodeFailed(node)) return; /* Already FAILing. */
804

805 806
    failures = clusterNodeFailureReportsCount(node);
    /* Also count myself as a voter if I'm a master. */
807
    if (nodeIsMaster(myself)) failures++;
808
    if (failures < needed_quorum) return; /* No weak agreement from masters. */
809 810 811 812 813 814 815

    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;
816
    node->fail_time = mstime();
817

818 819
    /* Broadcast the failing node name to everybody, forcing all the other
     * reachable nodes to flag the node as FAIL. */
820
    if (nodeIsMaster(myself)) clusterSendFail(node->name);
A
antirez 已提交
821
    clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
822 823 824 825
}

/* 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
826
 * state. */
827
void clearNodeFailureIfNeeded(clusterNode *node) {
828
    mstime_t now = mstime();
A
antirez 已提交
829

830
    redisAssert(nodeFailed(node));
A
antirez 已提交
831 832 833

    /* For slaves we always clear the FAIL flag if we can contact the
     * node again. */
834
    if (nodeIsSlave(node) || node->numslots == 0) {
A
antirez 已提交
835
        redisLog(REDIS_NOTICE,
836
            "Clear FAIL state for node %.40s: %s is reachable again.",
837 838
                node->name,
                nodeIsSlave(node) ? "slave" : "master without slots");
A
antirez 已提交
839
        node->flags &= ~REDIS_NODE_FAIL;
A
antirez 已提交
840
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
A
antirez 已提交
841 842 843
    }

    /* If it is a master and...
844
     * 1) The FAIL state is old enough.
A
antirez 已提交
845 846
     * 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. */
847
    if (nodeIsMaster(node) && node->numslots > 0 &&
848
        (now - node->fail_time) >
849
        (server.cluster_node_timeout * REDIS_CLUSTER_FAIL_UNDO_TIME_MULT))
A
antirez 已提交
850
    {
851
        redisLog(REDIS_NOTICE,
A
antirez 已提交
852
            "Clear FAIL state for node %.40s: is reachable again and nobody is serving its slots after some time.",
853
                node->name);
854
        node->flags &= ~REDIS_NODE_FAIL;
A
antirez 已提交
855
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
856 857 858
    }
}

859 860 861 862 863 864 865 866 867 868 869
/* 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);

870
        if (!nodeInHandshake(node)) continue;
871 872 873 874 875 876
        if (!strcasecmp(node->ip,ip) && node->port == port) break;
    }
    dictReleaseIterator(di);
    return de != NULL;
}

877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 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 926 927 928 929 930 931 932 933 934
/* 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 已提交
935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967
/* 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);
968
        if (node) {
969 970
            /* We already know this node.
               Handle failure reports, only when the sender is a master. */
971
            if (sender && nodeIsMaster(sender) && node != myself) {
972 973
                if (flags & (REDIS_NODE_FAIL|REDIS_NODE_PFAIL)) {
                    if (clusterNodeAddFailureReport(node,sender)) {
974
                        redisLog(REDIS_VERBOSE,
975 976 977 978 979 980
                            "Node %.40s reported node %.40s as not reachable.",
                            sender->name, node->name);
                    }
                    markNodeAsFailingIfNeeded(node);
                } else {
                    if (clusterNodeDelFailureReport(node,sender)) {
981
                        redisLog(REDIS_VERBOSE,
982 983 984 985
                            "Node %.40s reported node %.40s is back online.",
                            sender->name, node->name);
                    }
                }
A
antirez 已提交
986
            }
987 988 989 990 991 992 993 994 995 996 997

            /* 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 已提交
998 999
        } else {
            /* If it's not in NOADDR state and we don't have it, we
1000
             * start a handshake process against this IP/PORT pairs.
A
antirez 已提交
1001 1002 1003 1004
             *
             * 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. */
1005 1006 1007 1008
            if (sender &&
                !(flags & REDIS_NODE_NOADDR) &&
                !clusterBlacklistExists(g->nodename))
            {
1009
                clusterStartHandshake(g->ip,ntohs(g->port));
1010
            }
A
antirez 已提交
1011 1012 1013 1014 1015 1016 1017
        }

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

1018
/* IP -> string conversion. 'buf' is supposed to at least be 46 bytes. */
A
antirez 已提交
1019
void nodeIp2String(char *buf, clusterLink *link) {
1020
    struct sockaddr_storage sa;
A
antirez 已提交
1021 1022 1023 1024
    socklen_t salen = sizeof(sa);

    if (getpeername(link->fd, (struct sockaddr*) &sa, &salen) == -1)
        redisPanic("getpeername() failed.");
1025 1026 1027 1028 1029 1030 1031 1032

    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 已提交
1033 1034 1035 1036
}


/* Update the node address to the IP address that can be extracted
A
antirez 已提交
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
 * 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);
1066 1067 1068

    /* Check if this is our master and we have to change the
     * replication target as well. */
1069
    if (nodeIsSlave(myself) && myself->slaveof == node)
1070
        replicationSetMaster(node->ip, node->port);
A
antirez 已提交
1071
    return 1;
A
antirez 已提交
1072 1073
}

1074 1075 1076 1077
/* 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) {
1078
    if (nodeIsMaster(n)) return;
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

    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. */
1110
    curmaster = nodeIsMaster(myself) ? myself : myself->slaveof;
1111 1112 1113 1114 1115

    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.
1116 1117 1118 1119
             * 2) The new node claims it with a greater configEpoch.
             * 3) We are not currently importing the slot. */
            if (server.cluster->slots[j] == sender ||
                server.cluster->importing_slots_from[j]) continue;
1120
            if (server.cluster->slots[j] == NULL ||
1121
                server.cluster->slots[j]->configEpoch < senderConfigEpoch)
1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149
            {
                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 已提交
1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162
/* 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 已提交
1163
    uint16_t flags = ntohs(hdr->flags);
1164
    uint64_t senderCurrentEpoch = 0, senderConfigEpoch = 0;
A
antirez 已提交
1165 1166
    clusterNode *sender;

1167
    server.cluster->stats_bus_messages_received++;
1168 1169
    redisLog(REDIS_DEBUG,"--- Processing packet of type %d, %lu bytes",
        type, (unsigned long) totlen);
1170 1171

    /* Perform sanity checks */
1172 1173
    if (totlen < 16) return 1; /* At least signature, version, totlen, count. */
    if (ntohs(hdr->ver) != 0) return 1; /* Can't handle versions other than 0. */
A
antirez 已提交
1174 1175 1176 1177 1178 1179 1180 1181 1182 1183
    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;
1184
    } else if (type == CLUSTERMSG_TYPE_FAIL) {
A
antirez 已提交
1185 1186 1187 1188
        uint32_t explen = sizeof(clusterMsg)-sizeof(union clusterMsgData);

        explen += sizeof(clusterMsgDataFail);
        if (totlen != explen) return 1;
1189
    } else if (type == CLUSTERMSG_TYPE_PUBLISH) {
1190 1191 1192 1193 1194 1195
        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;
1196
    } else if (type == CLUSTERMSG_TYPE_FAILOVER_AUTH_REQUEST ||
1197 1198 1199
               type == CLUSTERMSG_TYPE_FAILOVER_AUTH_ACK ||
               type == CLUSTERMSG_TYPE_MFSTART)
    {
1200 1201
        uint32_t explen = sizeof(clusterMsg)-sizeof(union clusterMsgData);

1202 1203 1204 1205 1206
        if (totlen != explen) return 1;
    } else if (type == CLUSTERMSG_TYPE_UPDATE) {
        uint32_t explen = sizeof(clusterMsg)-sizeof(union clusterMsgData);

        explen += sizeof(clusterMsgDataUpdate);
1207
        if (totlen != explen) return 1;
1208
    }
A
antirez 已提交
1209

1210
    /* Check if the sender is a known node. */
A
antirez 已提交
1211
    sender = clusterLookupNode(hdr->sender);
1212
    if (sender && !nodeInHandshake(sender)) {
1213
        /* Update our curretEpoch if we see a newer epoch in the cluster. */
1214 1215 1216 1217
        senderCurrentEpoch = ntohu64(hdr->currentEpoch);
        senderConfigEpoch = ntohu64(hdr->configEpoch);
        if (senderCurrentEpoch > server.cluster->currentEpoch)
            server.cluster->currentEpoch = senderCurrentEpoch;
1218
        /* Update the sender configEpoch if it is publishing a newer one. */
1219
        if (senderConfigEpoch > sender->configEpoch) {
1220
            sender->configEpoch = senderConfigEpoch;
A
antirez 已提交
1221
            clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|CLUSTER_TODO_FSYNC_CONFIG);
1222
        }
1223 1224 1225
        /* Update the replication offset info for this node. */
        sender->repl_offset = ntohu64(hdr->offset);
        sender->repl_offset_time = mstime();
1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236
        /* If we are a slave performing a manual failover and our master
         * sent its offset while already paused, populate the MF state. */
        if (server.cluster->mf_end &&
            nodeIsSlave(myself) &&
            myself->slaveof == sender &&
            hdr->mflags[0] & CLUSTERMSG_FLAG0_PAUSED &&
            server.cluster->mf_master_offset == 0)
        {
            server.cluster->mf_master_offset = sender->repl_offset;
            redisLog(REDIS_WARNING,"Received replication offset for paused master manual failover: %lld", server.cluster->mf_master_offset);
        }
1237
    }
1238

1239
    /* Process packets by type. */
A
antirez 已提交
1240
    if (type == CLUSTERMSG_TYPE_PING || type == CLUSTERMSG_TYPE_MEET) {
1241
        redisLog(REDIS_DEBUG,"Ping packet received: %p", (void*)link->node);
A
antirez 已提交
1242 1243 1244 1245

        /* 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
1246
         * resolved when we'll receive PONGs from the node. */
A
antirez 已提交
1247 1248 1249 1250 1251 1252 1253
        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 已提交
1254
            clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG);
A
antirez 已提交
1255 1256 1257 1258 1259 1260 1261
        }

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

        /* Anyway reply with a PONG */
        clusterSendPing(link,CLUSTERMSG_TYPE_PONG);
1262 1263 1264
    }

    /* PING or PONG: process config information. */
1265 1266 1267
    if (type == CLUSTERMSG_TYPE_PING || type == CLUSTERMSG_TYPE_PONG ||
        type == CLUSTERMSG_TYPE_MEET)
    {
1268 1269 1270
        redisLog(REDIS_DEBUG,"%s packet received: %p",
            type == CLUSTERMSG_TYPE_PING ? "ping" : "pong",
            (void*)link->node);
A
antirez 已提交
1271
        if (link->node) {
1272
            if (nodeInHandshake(link->node)) {
A
antirez 已提交
1273 1274 1275 1276 1277
                /* 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 已提交
1278 1279
                    if (nodeUpdateAddressIfNeeded(sender,link,ntohs(hdr->port)))
                    {
A
antirez 已提交
1280 1281
                        clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                                             CLUSTER_TODO_UPDATE_STATE);
A
antirez 已提交
1282 1283 1284 1285
                    }
                    /* Free this node as we alrady have it. This will
                     * cause the link to be freed as well. */
                    freeClusterNode(link->node);
A
antirez 已提交
1286 1287 1288 1289
                    return 0;
                }

                /* First thing to do is replacing the random name with the
1290
                 * right node name if this was a handshake stage. */
A
antirez 已提交
1291 1292 1293 1294
                clusterRenameNode(link->node, hdr->sender);
                redisLog(REDIS_DEBUG,"Handshake with node %.40s completed.",
                    link->node->name);
                link->node->flags &= ~REDIS_NODE_HANDSHAKE;
1295
                link->node->flags |= flags&(REDIS_NODE_MASTER|REDIS_NODE_SLAVE);
A
antirez 已提交
1296
                clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG);
A
antirez 已提交
1297 1298 1299 1300 1301 1302 1303 1304
            } 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;
1305 1306
                link->node->ip[0] = '\0';
                link->node->port = 0;
A
antirez 已提交
1307
                freeClusterLink(link);
A
antirez 已提交
1308
                clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG);
A
antirez 已提交
1309 1310 1311
                return 0;
            }
        }
1312

A
antirez 已提交
1313 1314
        /* Update the node address if it changed. */
        if (sender && type == CLUSTERMSG_TYPE_PING &&
1315
            !nodeInHandshake(sender) &&
A
antirez 已提交
1316 1317
            nodeUpdateAddressIfNeeded(sender,link,ntohs(hdr->port)))
        {
A
antirez 已提交
1318
            clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|CLUSTER_TODO_UPDATE_STATE);
A
antirez 已提交
1319 1320
        }

A
antirez 已提交
1321
        /* Update our info about the node */
1322
        if (link->node && type == CLUSTERMSG_TYPE_PONG) {
1323
            link->node->pong_received = mstime();
1324 1325 1326
            link->node->ping_sent = 0;

            /* The PFAIL condition can be reversed without external
1327
             * help if it is momentary (that is, if it does not
1328 1329 1330 1331
             * turn into a FAIL state).
             *
             * The FAIL condition is also reversible under specific
             * conditions detected by clearNodeFailureIfNeeded(). */
1332
            if (nodeTimedOut(link->node)) {
1333
                link->node->flags &= ~REDIS_NODE_PFAIL;
A
antirez 已提交
1334 1335
                clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                                     CLUSTER_TODO_UPDATE_STATE);
1336
            } else if (nodeFailed(link->node)) {
1337 1338 1339
                clearNodeFailureIfNeeded(link->node);
            }
        }
A
antirez 已提交
1340

1341
        /* Check for role switch: slave -> master or master -> slave. */
A
antirez 已提交
1342 1343 1344 1345
        if (sender) {
            if (!memcmp(hdr->slaveof,REDIS_NODE_NULL_NAME,
                sizeof(hdr->slaveof)))
            {
1346
                /* Node is a master. */
1347
                clusterSetNodeAsMaster(sender);
A
antirez 已提交
1348
            } else {
1349
                /* Node is a slave. */
A
antirez 已提交
1350 1351
                clusterNode *master = clusterLookupNode(hdr->slaveof);

1352
                if (nodeIsMaster(sender)) {
1353
                    /* Master turned into a slave! Reconfigure the node. */
1354
                    clusterDelNodeSlots(sender);
1355 1356
                    sender->flags &= ~REDIS_NODE_MASTER;
                    sender->flags |= REDIS_NODE_SLAVE;
1357

1358 1359
                    /* Remove the list of slaves from the node. */
                    if (sender->numslaves) clusterNodeResetSlaves(sender);
1360 1361

                    /* Update config and state. */
A
antirez 已提交
1362 1363
                    clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                                         CLUSTER_TODO_UPDATE_STATE);
1364 1365
                }

1366
                /* Master node changed for this slave? */
1367
                if (master && sender->slaveof != master) {
1368 1369
                    if (sender->slaveof)
                        clusterNodeRemoveSlave(sender->slaveof,sender);
1370 1371
                    clusterNodeAddSlave(master,sender);
                    sender->slaveof = master;
1372 1373

                    /* Update config. */
A
antirez 已提交
1374
                    clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG);
1375
                }
A
antirez 已提交
1376 1377 1378
            }
        }

1379
        /* Update our info about served slots.
1380
         *
1381 1382
         * Note: this MUST happen after we update the master/slave state
         * so that REDIS_NODE_MASTER flag will be set. */
1383 1384

        /* Many checks are only needed if the set of served slots this
1385 1386 1387 1388
         * 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. */
1389 1390 1391
        int dirty_slots = 0; /* Sender claimed slots don't match my view? */

        if (sender) {
1392
            sender_master = nodeIsMaster(sender) ? sender : sender->slaveof;
1393 1394 1395 1396 1397 1398
            if (sender_master) {
                dirty_slots = memcmp(sender_master->slots,
                        hdr->myslots,sizeof(hdr->myslots)) != 0;
            }
        }

1399 1400 1401
        /* 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. */
1402
        if (sender && nodeIsMaster(sender) && dirty_slots)
1403
            clusterUpdateSlotsConfigWith(sender,senderConfigEpoch,hdr->myslots);
1404

1405 1406 1407
        /* 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.
1408
         *
1409 1410 1411 1412
         * 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:
1413 1414 1415 1416 1417 1418
         *
         * 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
1419 1420 1421 1422
         * 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). */
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432
        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)
                    {
1433 1434
                        redisLog(REDIS_WARNING,
                            "Node %.40s has old slots configuration, sending "
1435
                            "an UPDATE message about %.40s",
1436 1437
                                sender->name, server.cluster->slots[j]->name);
                        clusterSendUpdate(sender->link,server.cluster->slots[j]);
1438 1439 1440 1441 1442

                        /* TODO: instead of exiting the loop send every other
                         * UPDATE packet for other nodes that are the new owner
                         * of sender's slots. */
                        break;
1443
                    }
1444
                }
A
antirez 已提交
1445 1446 1447 1448 1449
            }
        }

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

1453 1454
        if (sender) {
            failing = clusterLookupNode(hdr->data.fail.about.nodename);
1455 1456
            if (failing &&
                !(failing->flags & (REDIS_NODE_FAIL|REDIS_NODE_MYSELF)))
1457 1458 1459 1460 1461
            {
                redisLog(REDIS_NOTICE,
                    "FAIL message received from %.40s about %.40s",
                    hdr->sender, hdr->data.fail.about.nodename);
                failing->flags |= REDIS_NODE_FAIL;
1462
                failing->fail_time = mstime();
1463
                failing->flags &= ~REDIS_NODE_PFAIL;
A
antirez 已提交
1464
                clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|CLUSTER_TODO_UPDATE_STATE);
1465 1466
            }
        } else {
A
antirez 已提交
1467
            redisLog(REDIS_NOTICE,
1468
                "Ignoring FAIL message from unknonw node %.40s about %.40s",
A
antirez 已提交
1469 1470
                hdr->sender, hdr->data.fail.about.nodename);
        }
1471 1472 1473 1474
    } else if (type == CLUSTERMSG_TYPE_PUBLISH) {
        robj *channel, *message;
        uint32_t channel_len, message_len;

A
antirez 已提交
1475 1476
        /* Don't bother creating useless objects if there are no
         * Pub/Sub subscribers. */
1477 1478 1479
        if (dictSize(server.pubsub_channels) ||
           listLength(server.pubsub_patterns))
        {
1480 1481 1482 1483 1484
            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(
1485 1486
                        (char*)hdr->data.publish.msg.bulk_data+channel_len,
                        message_len);
1487 1488 1489 1490
            pubsubPublishMessage(channel,message);
            decrRefCount(channel);
            decrRefCount(message);
        }
1491
    } else if (type == CLUSTERMSG_TYPE_FAILOVER_AUTH_REQUEST) {
A
antirez 已提交
1492
        if (!sender) return 1;  /* We don't know that node. */
1493
        clusterSendFailoverAuthIfNeeded(sender,hdr);
1494
    } else if (type == CLUSTERMSG_TYPE_FAILOVER_AUTH_ACK) {
A
antirez 已提交
1495
        if (!sender) return 1;  /* We don't know that node. */
1496
        /* We consider this vote only if the sender is a master serving
1497 1498
         * a non zero number of slots, and its currentEpoch is greater or
         * equal to epoch where this node started the election. */
1499
        if (nodeIsMaster(sender) && sender->numslots > 0 &&
1500
            senderCurrentEpoch >= server.cluster->failover_auth_epoch)
1501
        {
1502
            server.cluster->failover_auth_count++;
1503 1504
            /* Maybe we reached a quorum here, set a flag to make sure
             * we check ASAP. */
A
antirez 已提交
1505
            clusterDoBeforeSleep(CLUSTER_TODO_HANDLE_FAILOVER);
1506
        }
1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518
    } else if (type == CLUSTERMSG_TYPE_MFSTART) {
        /* This message is acceptable only if I'm a master and the sender
         * is one of my slaves. */
        if (!sender || sender->slaveof != myself) return 1;
        /* Manual failover requested from slaves. Initialize the state
         * accordingly. */
        resetManualFailover();
        server.cluster->mf_end = mstime() + REDIS_CLUSTER_MF_TIMEOUT;
        server.cluster->mf_slave = sender;
        pauseClients(mstime()+(REDIS_CLUSTER_MF_TIMEOUT*2));
        redisLog(REDIS_WARNING,"Manual failover requested by slave %.40s.",
            sender->name);
1519 1520 1521 1522 1523 1524 1525 1526 1527 1528
    } 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. */
1529
        if (nodeIsSlave(n)) clusterSetNodeAsMaster(n);
1530

1531 1532
        /* Check the bitmap of served slots and udpate our
         * config accordingly. */
1533 1534
        clusterUpdateSlotsConfigWith(n,reportedConfigEpoch,
            hdr->data.update.nodecfg.slots);
A
antirez 已提交
1535
    } else {
1536
        redisLog(REDIS_WARNING,"Received unknown packet type: %d", type);
A
antirez 已提交
1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561
    }
    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) {
1562
        redisLog(REDIS_DEBUG,"I/O error writing to node link: %s",
A
antirez 已提交
1563 1564 1565 1566
            strerror(errno));
        handleLinkIOError(link);
        return;
    }
1567
    sdsrange(link->sndbuf,nwritten,-1);
A
antirez 已提交
1568 1569 1570 1571 1572 1573 1574 1575
    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) {
1576
    char buf[sizeof(clusterMsg)];
A
antirez 已提交
1577 1578 1579
    ssize_t nread;
    clusterMsg *hdr;
    clusterLink *link = (clusterLink*) privdata;
1580
    int readlen, rcvbuflen;
A
antirez 已提交
1581 1582 1583
    REDIS_NOTUSED(el);
    REDIS_NOTUSED(mask);

1584 1585
    while(1) { /* Read as long as there is data to read. */
        rcvbuflen = sdslen(link->rcvbuf);
1586 1587
        if (rcvbuflen < 8) {
            /* First, obtain the first 8 bytes to get the full message
1588
             * length. */
1589
            readlen = 8 - rcvbuflen;
1590 1591 1592
        } else {
            /* Finally read the full message. */
            hdr = (clusterMsg*) link->rcvbuf;
1593 1594 1595 1596 1597 1598
            if (rcvbuflen == 8) {
                /* Perform some sanity check on the message signature
                 * and length. */
                if (memcmp(hdr->sig,"RCmb",4) != 0 ||
                    ntohl(hdr->totlen) < CLUSTERMSG_MIN_LEN)
                {
1599
                    redisLog(REDIS_WARNING,
1600 1601
                        "Bad message length or signature received "
                        "from Cluster bus.");
1602 1603 1604
                    handleLinkIOError(link);
                    return;
                }
1605
            }
1606 1607
            readlen = ntohl(hdr->totlen) - rcvbuflen;
            if (readlen > sizeof(buf)) readlen = sizeof(buf);
1608
        }
A
antirez 已提交
1609

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

1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624
        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 已提交
1625

1626
        /* Total length obtained? Process this packet. */
1627
        if (rcvbuflen >= 8 && rcvbuflen == ntohl(hdr->totlen)) {
1628 1629 1630 1631 1632 1633
            if (clusterProcessPacket(link)) {
                sdsfree(link->rcvbuf);
                link->rcvbuf = sdsempty();
            } else {
                return; /* Link no longer valid. */
            }
A
antirez 已提交
1634 1635 1636 1637
        }
    }
}

1638 1639 1640 1641 1642
/* 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 已提交
1643 1644 1645 1646 1647 1648
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);
1649
    server.cluster->stats_bus_messages_sent++;
A
antirez 已提交
1650 1651
}

1652
/* Send a message to all the nodes that are part of the cluster having
1653 1654 1655 1656 1657
 * 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. */
1658 1659 1660 1661
void clusterBroadcastMessage(void *buf, size_t len) {
    dictIterator *di;
    dictEntry *de;

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

        if (!node->link) continue;
1667 1668
        if (node->flags & (REDIS_NODE_MYSELF|REDIS_NODE_HANDSHAKE))
            continue;
1669 1670 1671 1672 1673
        clusterSendMessage(node->link,buf,len);
    }
    dictReleaseIterator(di);
}

A
antirez 已提交
1674 1675
/* Build the message header */
void clusterBuildMessageHdr(clusterMsg *hdr, int type) {
1676
    int totlen = 0;
1677
    uint64_t offset;
1678
    clusterNode *master;
1679 1680 1681 1682 1683

    /* 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. */
1684
    master = (nodeIsSlave(myself) && myself->slaveof) ?
1685
              myself->slaveof : myself;
A
antirez 已提交
1686 1687

    memset(hdr,0,sizeof(*hdr));
1688 1689
    hdr->sig[0] = 'R';
    hdr->sig[1] = 'C';
1690
    hdr->sig[2] = 'm';
1691
    hdr->sig[3] = 'b';
A
antirez 已提交
1692
    hdr->type = htons(type);
1693
    memcpy(hdr->sender,myself->name,REDIS_CLUSTER_NAMELEN);
1694 1695

    memcpy(hdr->myslots,master->slots,sizeof(hdr->myslots));
A
antirez 已提交
1696
    memset(hdr->slaveof,0,REDIS_CLUSTER_NAMELEN);
1697 1698
    if (myself->slaveof != NULL)
        memcpy(hdr->slaveof,myself->slaveof->name, REDIS_CLUSTER_NAMELEN);
A
antirez 已提交
1699
    hdr->port = htons(server.port);
1700
    hdr->flags = htons(myself->flags);
1701
    hdr->state = server.cluster->state;
A
antirez 已提交
1702

1703
    /* Set the currentEpoch and configEpochs. */
1704
    hdr->currentEpoch = htonu64(server.cluster->currentEpoch);
1705
    hdr->configEpoch = htonu64(master->configEpoch);
1706

1707
    /* Set the replication offset. */
1708 1709 1710
    if (nodeIsSlave(myself))
        offset = replicationGetSlaveOffset();
    else
1711 1712 1713
        offset = server.master_repl_offset;
    hdr->offset = htonu64(offset);

1714 1715 1716 1717
    /* Set the message flags. */
    if (nodeIsMaster(myself) && server.cluster->mf_end)
        hdr->mflags[0] |= CLUSTERMSG_FLAG0_PAUSED;

1718 1719
    /* Compute the message length for certain messages. For other messages
     * this is up to the caller. */
A
antirez 已提交
1720 1721 1722
    if (type == CLUSTERMSG_TYPE_FAIL) {
        totlen = sizeof(clusterMsg)-sizeof(union clusterMsgData);
        totlen += sizeof(clusterMsgDataFail);
1723 1724 1725
    } else if (type == CLUSTERMSG_TYPE_UPDATE) {
        totlen = sizeof(clusterMsg)-sizeof(union clusterMsgData);
        totlen += sizeof(clusterMsgDataUpdate);
A
antirez 已提交
1726 1727
    }
    hdr->totlen = htonl(totlen);
1728
    /* For PING, PONG, and MEET, fixing the totlen field is up to the caller. */
A
antirez 已提交
1729 1730 1731 1732 1733
}

/* Send a PING or PONG packet to the specified node, making sure to add enough
 * gossip informations. */
void clusterSendPing(clusterLink *link, int type) {
1734
    unsigned char buf[sizeof(clusterMsg)];
A
antirez 已提交
1735 1736 1737 1738 1739 1740 1741 1742
    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. */
1743
    int freshnodes = dictSize(server.cluster->nodes)-2;
A
antirez 已提交
1744 1745

    if (link->node && type == CLUSTERMSG_TYPE_PING)
1746
        link->node->ping_sent = mstime();
A
antirez 已提交
1747 1748 1749 1750
    clusterBuildMessageHdr(hdr,type);
        
    /* Populate the gossip fields */
    while(freshnodes > 0 && gossipcount < 3) {
1751
        struct dictEntry *de = dictGetRandomKey(server.cluster->nodes);
1752
        clusterNode *this = dictGetVal(de);
A
antirez 已提交
1753 1754 1755
        clusterMsgDataGossip *gossip;
        int j;

1756 1757 1758 1759 1760 1761
        /* 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.
         */
1762
        if (this == myself ||
1763
            this->flags & (REDIS_NODE_HANDSHAKE|REDIS_NODE_NOADDR) ||
1764
            (this->link == NULL && this->numslots == 0))
1765
        {
A
antirez 已提交
1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794
                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);
}

1795 1796
/* Send a PONG packet to every connected node that's not in handshake state
 * and for which we have a valid link.
1797
 *
1798 1799
 * In Redis Cluster pongs are not used just for failure detection, but also
 * to carry important configuration information. So broadcasting a pong is
1800
 * useful when something changes in the configuration and we want to make
1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811
 * the cluster aware ASAP (for instance after a slave promotion).
 *
 * The 'target' argument specifies the receiving instances using the
 * defines below:
 *
 * CLUSTER_BROADCAST_ALL -> All known instances.
 * CLUSTER_BROADCAST_LOCAL_SLAVES -> All slaves in my master-slaves ring.
 */
#define CLUSTER_BROADCAST_ALL 0
#define CLUSTER_BROADCAST_LOCAL_SLAVES 1
void clusterBroadcastPong(int target) {
1812 1813 1814
    dictIterator *di;
    dictEntry *de;

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

1819
        if (!node->link) continue;
1820
        if (node == myself || nodeInHandshake(node)) continue;
1821 1822
        if (target == CLUSTER_BROADCAST_LOCAL_SLAVES) {
            int local_slave =
1823
                nodeIsSlave(node) && node->slaveof &&
1824 1825 1826
                (node->slaveof == myself || node->slaveof == myself->slaveof);
            if (!local_slave) continue;
        }
1827 1828 1829 1830 1831
        clusterSendPing(node->link,CLUSTERMSG_TYPE_PONG);
    }
    dictReleaseIterator(di);
}

1832 1833 1834 1835
/* 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) {
1836
    unsigned char buf[sizeof(clusterMsg)], *payload;
1837 1838 1839
    clusterMsg *hdr = (clusterMsg*) buf;
    uint32_t totlen;
    uint32_t channel_len, message_len;
A
antirez 已提交
1840

1841 1842 1843 1844
    channel = getDecodedObject(channel);
    message = getDecodedObject(message);
    channel_len = sdslen(channel->ptr);
    message_len = sdslen(message->ptr);
A
antirez 已提交
1845

1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858
    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);
1859
        memcpy(payload,hdr,sizeof(*hdr));
1860
        hdr = (clusterMsg*) payload;
A
antirez 已提交
1861
    }
1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873
    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 已提交
1874 1875 1876 1877 1878 1879 1880 1881
}

/* 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) {
1882
    unsigned char buf[sizeof(clusterMsg)];
A
antirez 已提交
1883 1884 1885 1886 1887 1888 1889
    clusterMsg *hdr = (clusterMsg*) buf;

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

1890 1891 1892 1893
/* 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) {
1894
    unsigned char buf[sizeof(clusterMsg)];
1895 1896
    clusterMsg *hdr = (clusterMsg*) buf;

1897
    if (link == NULL) return;
1898 1899 1900 1901 1902 1903 1904
    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));
}

1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915
/* -----------------------------------------------------------------------------
 * 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);
}

1916 1917 1918 1919
/* -----------------------------------------------------------------------------
 * SLAVE node specific functions
 * -------------------------------------------------------------------------- */

1920 1921 1922 1923 1924 1925 1926
/* 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) {
1927
    unsigned char buf[sizeof(clusterMsg)];
1928 1929 1930 1931
    clusterMsg *hdr = (clusterMsg*) buf;
    uint32_t totlen;

    clusterBuildMessageHdr(hdr,CLUSTERMSG_TYPE_FAILOVER_AUTH_REQUEST);
1932 1933 1934 1935
    /* If this is a manual failover, set the CLUSTERMSG_FLAG0_FORCEACK bit
     * in the header to communicate the nodes receiving the message that
     * they should authorized the failover even if the master is working. */
    if (server.cluster->mf_end) hdr->mflags[0] |= CLUSTERMSG_FLAG0_FORCEACK;
1936 1937
    totlen = sizeof(clusterMsg)-sizeof(union clusterMsgData);
    hdr->totlen = htonl(totlen);
1938
    clusterBroadcastMessage(buf,totlen);
1939 1940
}

1941 1942
/* Send a FAILOVER_AUTH_ACK message to the specified node. */
void clusterSendFailoverAuth(clusterNode *node) {
1943
    unsigned char buf[sizeof(clusterMsg)];
1944 1945 1946 1947 1948 1949 1950
    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);
1951
    clusterSendMessage(node->link,buf,totlen);
1952 1953
}

1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966
/* Send a MFSTART message to the specified node. */
void clusterSendMFStart(clusterNode *node) {
    unsigned char buf[sizeof(clusterMsg)];
    clusterMsg *hdr = (clusterMsg*) buf;
    uint32_t totlen;

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

1967
/* Vote for the node asking for our vote if there are the conditions. */
1968
void clusterSendFailoverAuthIfNeeded(clusterNode *node, clusterMsg *request) {
1969
    clusterNode *master = node->slaveof;
1970 1971 1972
    uint64_t requestCurrentEpoch = ntohu64(request->currentEpoch);
    uint64_t requestConfigEpoch = ntohu64(request->configEpoch);
    unsigned char *claimed_slots = request->myslots;
1973
    int force_ack = request->mflags[0] & CLUSTERMSG_FLAG0_FORCEACK;
1974
    int j;
1975 1976 1977

    /* 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
1978 1979
     * of masters serving at least one slot, and quorum is the cluster
     * size + 1 */
1980
    if (nodeIsSlave(myself) || myself->numslots == 0) return;
1981 1982

    /* Request epoch must be >= our currentEpoch. */
1983
    if (requestCurrentEpoch < server.cluster->currentEpoch) return;
1984

1985
    /* I already voted for this epoch? Return ASAP. */
1986
    if (server.cluster->last_vote_epoch == server.cluster->currentEpoch) return;
1987

1988 1989 1990 1991 1992
    /* Node must be a slave and its master down.
     * The master can be non failing if the request is flagged
     * with CLUSTERMSG_FLAG0_FORCEACK (manual failover). */
    if (nodeIsMaster(node) || master == NULL ||
        (!nodeFailed(master) && !force_ack)) return;
1993

1994 1995 1996
    /* 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. */
1997 1998
    if (mstime() - node->slaveof->voted_time < server.cluster_node_timeout * 2)
        return;
1999

2000 2001 2002
    /* 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. */
2003 2004 2005 2006 2007 2008 2009 2010 2011 2012
    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. */
        return;
    }

2013
    /* We can vote for this slave. */
2014
    clusterSendFailoverAuth(node);
2015
    server.cluster->last_vote_epoch = server.cluster->currentEpoch;
2016
    node->slaveof->voted_time = mstime();
2017 2018
}

2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046
/* This function returns the "rank" of this instance, a slave, in the context
 * of its master-slaves ring. The rank of the slave is given by the number of
 * other slaves for the same master that have a better replication offset
 * compared to the local one (better means, greater, so they claim more data).
 *
 * A slave with rank 0 is the one with the greatest (most up to date)
 * replication offset, and so forth. Note that because how the rank is computed
 * multiple slaves may have the same rank, in case they have the same offset.
 *
 * The slave rank is used to add a delay to start an election in order to
 * get voted and replace a failing master. Slaves with better replication
 * offsets are more likely to win. */
int clusterGetSlaveRank(void) {
    long long myoffset;
    int j, rank = 0;
    clusterNode *master;

    redisAssert(nodeIsSlave(myself));
    master = myself->slaveof;
    if (master == NULL) return 0; /* Never called by slaves without master. */

    myoffset = replicationGetSlaveOffset();
    for (j = 0; j < master->numslaves; j++)
        if (master->slaves[j] != myself &&
            master->slaves[j]->repl_offset > myoffset) rank++;
    return rank;
}

2047
/* This function is called if we are a slave node and our master serving
2048
 * a non-zero amount of hash slots is in FAIL state.
2049 2050 2051
 *
 * The gaol of this function is:
 * 1) To check if we are able to perform a failover, is our data updated?
2052
 * 2) Try to get elected by masters.
2053
 * 3) Perform the failover informing all the other nodes.
2054 2055
 */
void clusterHandleSlaveFailover(void) {
2056
    mstime_t data_age;
2057
    mstime_t auth_age = mstime() - server.cluster->failover_auth_time;
2058
    int needed_quorum = (server.cluster->size / 2) + 1;
2059 2060
    int manual_failover = server.cluster->mf_end != 0 &&
                          server.cluster->mf_can_start;
2061
    int j;
2062

2063 2064
    /* Pre conditions to run the function:
     * 1) We are a slave.
2065
     * 2) Our master is flagged as FAIL, or this is a manual failover.
2066
     * 3) It is serving slots. */
2067
    if (nodeIsMaster(myself) ||
2068
        myself->slaveof == NULL ||
2069
        (!nodeFailed(myself->slaveof) && !manual_failover) ||
2070
        myself->slaveof->numslots == 0) return;
2071

2072 2073
    /* If this is a manual failover, are we ready to start? */

2074 2075 2076 2077 2078 2079 2080 2081
    /* Set data_age to the number of seconds we are disconnected from
     * the master. */
    if (server.repl_state == REDIS_REPL_CONNECTED) {
        data_age = (server.unixtime - server.master->lastinteraction) * 1000;
    } else {
        data_age = (server.unixtime - server.repl_down_since) * 1000;
    }

2082 2083 2084 2085 2086 2087
    /* 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;

2088 2089 2090
    /* 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. */
2091
    if (data_age >
2092 2093
        (server.repl_ping_slave_period * 1000) +
        (server.cluster_node_timeout * REDIS_CLUSTER_SLAVE_VALIDITY_MULT))
2094
        return;
2095

2096
    /* Compute the time at which we can start an election. */
2097
    if (auth_age >
2098
        server.cluster_node_timeout * REDIS_CLUSTER_FAILOVER_AUTH_RETRY_MULT)
2099
    {
2100 2101 2102
        server.cluster->failover_auth_time = mstime() +
            500 + /* Fixed delay of 500 milliseconds, let FAIL msg propagate. */
            random() % 500; /* Random delay between 0 and 500 milliseconds. */
2103
        server.cluster->failover_auth_count = 0;
2104
        server.cluster->failover_auth_sent = 0;
2105 2106 2107 2108 2109 2110
        server.cluster->failover_auth_rank = clusterGetSlaveRank();
        /* We add another delay that is proportional to the slave rank.
         * Specifically 1 second * rank. This way slaves that have a probably
         * less updated replication offset, are penalized. */
        server.cluster->failover_auth_time +=
            server.cluster->failover_auth_rank * 1000;
2111 2112 2113 2114 2115
        /* However if this is a manual failover, no delay is needed. */
        if (server.cluster->mf_end) {
            server.cluster->failover_auth_time = mstime();
            server.cluster->failover_auth_rank = 0;
        }
2116
        redisLog(REDIS_WARNING,
2117 2118
            "Start of election delayed for %lld milliseconds "
            "(rank #%d, offset %lld).",
2119
            server.cluster->failover_auth_time - mstime(),
2120 2121
            server.cluster->failover_auth_rank,
            replicationGetSlaveOffset());
2122 2123 2124 2125
        /* Now that we have a scheduled election, broadcast our offset
         * to all the other slaves so that they'll updated their offsets
         * if our offset is better. */
        clusterBroadcastPong(CLUSTER_BROADCAST_LOCAL_SLAVES);
2126 2127 2128 2129 2130 2131
        return;
    }

    /* It is possible that we received more updated offsets from other
     * slaves for the same master since we computed our election delay.
     * Update the delay if our rank changed. */
2132 2133 2134
    if (server.cluster->failover_auth_sent == 0 &&
        server.cluster->mf_end == 0)
    {
2135 2136 2137 2138 2139 2140 2141 2142 2143 2144
        int newrank = clusterGetSlaveRank();
        if (newrank > server.cluster->failover_auth_rank) {
            long long added_delay =
                (newrank - server.cluster->failover_auth_rank) * 1000;
            server.cluster->failover_auth_time += added_delay;
            server.cluster->failover_auth_rank = newrank;
            redisLog(REDIS_WARNING,
                "Slave rank updated to #%d, added %lld milliseconds of delay.",
                newrank, added_delay);
        }
2145 2146 2147 2148 2149 2150
    }

    /* 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. */
2151
    if (auth_age > server.cluster_node_timeout) return;
2152 2153 2154 2155 2156 2157

    /* 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.",
2158
            (unsigned long long) server.cluster->currentEpoch);
2159
        clusterRequestFailoverAuth();
2160
        server.cluster->failover_auth_sent = 1;
A
antirez 已提交
2161 2162 2163
        clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                             CLUSTER_TODO_UPDATE_STATE|
                             CLUSTER_TODO_FSYNC_CONFIG);
2164 2165 2166 2167
        return; /* Wait for replies. */
    }

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

2171
        redisLog(REDIS_WARNING,
A
antirez 已提交
2172
            "Failover election won: I'm the new master.");
A
antirez 已提交
2173 2174 2175 2176
        /* We have the quorum, perform all the steps to correctly promote
         * this slave to a master.
         *
         * 1) Turn this node into a master. */
2177 2178 2179 2180
        clusterNodeRemoveSlave(myself->slaveof, myself);
        myself->flags &= ~REDIS_NODE_SLAVE;
        myself->flags |= REDIS_NODE_MASTER;
        myself->slaveof = NULL;
A
antirez 已提交
2181 2182
        replicationUnsetMaster();

2183 2184 2185 2186
        /* 2) Claim all the slots assigned to our master. */
        for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
            if (clusterNodeGetSlotBit(oldmaster,j)) {
                clusterDelSlot(j);
2187
                clusterAddSlot(myself,j);
2188 2189 2190
            }
        }

2191
        /* 3) Update my configEpoch to the epoch of the election. */
2192
        myself->configEpoch = server.cluster->failover_auth_epoch;
2193

2194
        /* 4) Update state and save config. */
2195
        clusterUpdateState();
A
antirez 已提交
2196
        clusterSaveConfigOrDie(1);
2197 2198 2199

        /* 5) Pong all the other nodes so that they can update the state
         *    accordingly and detect that we switched to master role. */
2200
        clusterBroadcastPong(CLUSTER_BROADCAST_ALL);
2201 2202 2203

        /* 6) If there was a manual failover in progress, clear the state. */
        resetManualFailover();
2204
    }
2205 2206
}

2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242
/* -----------------------------------------------------------------------------
 * CLUSTER slave migration
 *
 * Slave migration is the process that allows a slave of a master that is
 * already covered by at least another slave, to "migrate" to a master that
 * is orpaned, that is, left with no working slaves.
 * -------------------------------------------------------------------------- */

/* This function is responsible to decide if this replica should be migrated
 * to a different (orphaned) master. It is called by the clusterCron() function
 * only if:
 *
 * 1) We are a slave node.
 * 2) It was detected that there is at least one orphaned master in
 *    the cluster.
 * 3) We are a slave of one of the masters with the greatest number of
 *    slaves.
 *
 * This checks are performed by the caller since it requires to iterate
 * the nodes anyway, so we spend time into clusterHandleSlaveMigration()
 * if definitely needed.
 *
 * The fuction is called with a pre-computed max_slaves, that is the max
 * number of working (not in FAIL state) slaves for a single master.
 *
 * Additional conditions for migration are examined inside the function.
 */
void clusterHandleSlaveMigration(int max_slaves) {
    int j, okslaves = 0;
    clusterNode *mymaster = myself->slaveof, *target = NULL, *candidate = NULL;
    dictIterator *di;
    dictEntry *de;

    /* Step 1: Don't migrate if the cluster state is not ok. */
    if (server.cluster->state != REDIS_CLUSTER_OK) return;

2243 2244
    /* Step 2: Don't migrate if my master will not be left with at least
     *         'migration-barrier' slaves after my migration. */
2245 2246 2247 2248
    if (mymaster == NULL) return;
    for (j = 0; j < mymaster->numslaves; j++)
        if (!nodeFailed(mymaster->slaves[j]) &&
            !nodeTimedOut(mymaster->slaves[j])) okslaves++;
2249
    if (okslaves <= server.cluster_migration_barrier) return;
2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269

    /* Step 3: Idenitfy a candidate for migration, and check if among the
     * masters with the greatest number of ok slaves, I'm the one with the
     * smaller node ID.
     *
     * Note that this means that eventually a replica migration will occurr
     * since slaves that are reachable again always have their FAIL flag
     * cleared. At the same time this does not mean that there are no
     * race conditions possible (two slaves migrating at the same time), but
     * this is extremely unlikely to happen, and harmless. */
    candidate = myself;
    di = dictGetSafeIterator(server.cluster->nodes);
    while((de = dictNext(di)) != NULL) {
        clusterNode *node = dictGetVal(de);
        int okslaves;

        /* Only iterate over working masters. */
        if (nodeIsSlave(node) || nodeFailed(node)) continue;
        okslaves = clusterCountNonFailingSlaves(node);

2270
        if (okslaves == 0 && target == NULL && node->numslots > 0) target = node;
2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291
        if (okslaves == max_slaves) {
            for (j = 0; j < node->numslaves; j++) {
                if (memcmp(node->slaves[j]->name,
                           candidate->name,
                           REDIS_CLUSTER_NAMELEN) < 0)
                {
                    candidate = node->slaves[j];
                }
            }
        }
    }

    /* Step 4: perform the migration if there is a target, and if I'm the
     * candidate. */
    if (target && candidate == myself) {
        redisLog(REDIS_WARNING,"Migrating to orphaned master %.40s",
            target->name);
        clusterSetMaster(target);
    }
}

2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338
/* -----------------------------------------------------------------------------
 * CLUSTER manual failover
 *
 * This are the important steps performed by slaves during a manual failover:
 * 1) User send CLUSTER FAILOVER command. The failover state is initialized
 *    setting mf_end to the millisecond unix time at which we'll abort the
 *    attempt.
 * 2) Slave sends a MFSTART message to the master requesting to pause clients
 *    for two times the manual failover timeout REDIS_CLUSTER_MF_TIMEOUT.
 *    When master is paused for manual failover, it also starts to flag
 *    packets with CLUSTERMSG_FLAG0_PAUSED.
 * 3) Slave waits for master to send its replication offset flagged as PAUSED.
 * 4) If slave received the offset from the master, and its offset matches,
 *    mf_can_start is set to 1, and clusterHandleSlaveFailover() will perform
 *    the failover as usually, with the difference that the vote request
 *    will be modified to force masters to vote for a slave that has a
 *    working master.
 *
 * From the point of view of the master things are simpler: when a
 * PAUSE_CLIENTS packet is received the master sets mf_end as well and
 * the sender in mf_slave. During the time limit for the manual failover
 * the master will just send PINGs more often to this slave, flagged with
 * the PAUSED flag, so that the slave will set mf_master_offset when receiving
 * a packet from the master with this flag set.
 *
 * The gaol of the manual failover is to perform a fast failover without
 * data loss due to the asynchronous master-slave replication.
 * -------------------------------------------------------------------------- */

/* Reset the manual failover state. This works for both masters and slavesa
 * as all the state about manual failover is cleared.
 *
 * The function can be used both to initialize the manual failover state at
 * startup or to abort a manual failover in progress. */
void resetManualFailover(void) {
    if (server.cluster->mf_end && clientsArePaused()) {
        server.clients_pause_end_time = 0;
        clientsArePaused(); /* Just use the side effect of the function. */
    }
    server.cluster->mf_end = 0; /* No manual failover in progress. */
    server.cluster->mf_can_start = 0;
    server.cluster->mf_slave = NULL;
    server.cluster->mf_master_offset = 0;
}

/* If a manual failover timed out, abort it. */
void manualFailoverCheckTimeout(void) {
2339
    if (server.cluster->mf_end && server.cluster->mf_end < mstime()) {
2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364
        redisLog(REDIS_WARNING,"Manual failover timed out.");
        resetManualFailover();
    }
}

/* This function is called from the cluster cron function in order to go
 * forward with a manual failover state machine. */
void clusterHandleManualFailover(void) {
    /* Return ASAP if no manual failover is in progress. */
    if (server.cluster->mf_end == 0) return;

    /* If mf_can_start is non-zero, the failover was alrady triggered so the
     * next steps are performed by clusterHandleSlaveFailover(). */
    if (server.cluster->mf_can_start) return;

    if (server.cluster->mf_master_offset == 0) return; /* Wait for offset... */

    if (server.cluster->mf_master_offset == replicationGetSlaveOffset()) {
        /* Our replication offset matches the master replication offset
         * announced after clients were paused. We can start the failover. */
        server.cluster->mf_can_start = 1;
        redisLog(REDIS_WARNING,"All master replication stream processed, manual failover can start.");
    }
}

A
antirez 已提交
2365 2366 2367 2368
/* -----------------------------------------------------------------------------
 * CLUSTER cron job
 * -------------------------------------------------------------------------- */

2369
/* This is executed 10 times every second */
A
antirez 已提交
2370 2371 2372
void clusterCron(void) {
    dictIterator *di;
    dictEntry *de;
2373 2374 2375 2376
    int update_state = 0;
    int orphaned_masters; /* How many masters there are without ok slaves. */
    int max_slaves; /* Max number of ok slaves for a single master. */
    int this_slaves; /* Number of ok slaves for our master (if we are slave). */
2377
    mstime_t min_pong = 0, now = mstime();
2378
    clusterNode *min_pong_node = NULL;
2379
    static unsigned long long iteration = 0;
2380
    mstime_t handshake_timeout;
2381 2382

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

2384
    /* The handshake timeout is the time after which a handshake node that was
2385 2386 2387 2388 2389 2390
     * 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 已提交
2391
    /* Check if we have disconnected nodes and re-establish the connection. */
2392
    di = dictGetSafeIterator(server.cluster->nodes);
A
antirez 已提交
2393
    while((de = dictNext(di)) != NULL) {
2394
        clusterNode *node = dictGetVal(de);
A
antirez 已提交
2395 2396

        if (node->flags & (REDIS_NODE_MYSELF|REDIS_NODE_NOADDR)) continue;
2397 2398 2399

        /* A Node in HANDSHAKE state has a limited lifespan equal to the
         * configured node timeout. */
2400
        if (nodeInHandshake(node) && now - node->ctime > handshake_timeout) {
2401 2402 2403 2404
            freeClusterNode(node);
            continue;
        }

A
antirez 已提交
2405 2406
        if (node->link == NULL) {
            int fd;
2407
            mstime_t old_ping_sent;
A
antirez 已提交
2408 2409 2410 2411 2412 2413 2414 2415 2416
            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);
2417 2418 2419 2420
            /* 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 已提交
2421 2422
             * of a PING one, to force the receiver to add us in its node
             * table. */
2423
            old_ping_sent = node->ping_sent;
A
antirez 已提交
2424 2425
            clusterSendPing(link, node->flags & REDIS_NODE_MEET ?
                    CLUSTERMSG_TYPE_MEET : CLUSTERMSG_TYPE_PING);
2426 2427 2428 2429 2430 2431
            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 已提交
2432 2433 2434 2435 2436 2437 2438
            /* 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;

2439
            redisLog(REDIS_DEBUG,"Connecting with Node %.40s at %s:%d", node->name, node->ip, node->port+REDIS_CLUSTER_PORT_INCR);
A
antirez 已提交
2440 2441 2442 2443
        }
    }
    dictReleaseIterator(di);

2444 2445 2446
    /* Ping some random node 1 time every 10 iterations, so that we usually ping
     * one random node every second. */
    if (!(iteration % 10)) {
2447 2448
        int j;

2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465
        /* 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 已提交
2466 2467 2468
        }
    }

2469 2470 2471 2472 2473 2474 2475 2476 2477
    /* Iterate nodes to check if we need to flag something as failing.
     * This loop is also responsible to:
     * 1) Check if there are orphaned masters (masters without non failing
     *    slaves).
     * 2) Count the max number of non failing slaves for a single master.
     * 3) Count the number of slaves for our master, if we are a slave. */
    orphaned_masters = 0;
    max_slaves = 0;
    this_slaves = 0;
2478
    di = dictGetSafeIterator(server.cluster->nodes);
A
antirez 已提交
2479
    while((de = dictNext(di)) != NULL) {
2480
        clusterNode *node = dictGetVal(de);
2481
        now = mstime(); /* Use an updated time at every iteration. */
2482
        mstime_t delay;
A
antirez 已提交
2483 2484

        if (node->flags &
2485 2486
            (REDIS_NODE_MYSELF|REDIS_NODE_NOADDR|REDIS_NODE_HANDSHAKE))
                continue;
2487

2488 2489 2490 2491 2492
        /* Orphaned master check, useful only if the current instance
         * is a slave that may migrate to another master. */
        if (nodeIsSlave(myself) && nodeIsMaster(node) && !nodeFailed(node)) {
            int okslaves = clusterCountNonFailingSlaves(node);

2493
            if (okslaves == 0 && node->numslots > 0) orphaned_masters++;
2494 2495 2496 2497 2498
            if (okslaves > max_slaves) max_slaves = okslaves;
            if (nodeIsSlave(myself) && myself->slaveof == node)
                this_slaves = okslaves;
        }

2499 2500 2501 2502
        /* 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 */
2503
            now - node->link->ctime >
2504
            server.cluster_node_timeout && /* was not already reconnected */
2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517
            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. */
2518
        if (node->link &&
2519 2520
            node->ping_sent == 0 &&
            (now - node->pong_received) > server.cluster_node_timeout/2)
2521 2522 2523 2524 2525
        {
            clusterSendPing(node->link, CLUSTERMSG_TYPE_PING);
            continue;
        }

2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536
        /* If we are a master and one of the slaves requested a manual
         * failover, ping it continuously. */
        if (server.cluster->mf_end &&
            nodeIsMaster(myself) &&
            server.cluster->mf_slave == node &&
            node->link)
        {
            clusterSendPing(node->link, CLUSTERMSG_TYPE_PING);
            continue;
        }

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

2540 2541 2542 2543
        /* 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;
2544

2545
        if (delay > server.cluster_node_timeout) {
G
guiquanz 已提交
2546
            /* Timeout reached. Set the node as possibly failing if it is
2547
             * not already in this state. */
2548
            if (!(node->flags & (REDIS_NODE_PFAIL|REDIS_NODE_FAIL))) {
A
antirez 已提交
2549 2550 2551
                redisLog(REDIS_DEBUG,"*** NODE %.40s possibly failing",
                    node->name);
                node->flags |= REDIS_NODE_PFAIL;
2552
                update_state = 1;
A
antirez 已提交
2553 2554 2555 2556
            }
        }
    }
    dictReleaseIterator(di);
2557 2558 2559 2560

    /* 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. */
2561
    if (nodeIsSlave(myself) &&
2562
        server.masterhost == NULL &&
2563
        myself->slaveof &&
2564
        nodeHasAddr(myself->slaveof))
2565
    {
2566
        replicationSetMaster(myself->slaveof->ip, myself->slaveof->port);
2567
    }
2568

2569 2570 2571
    /* Abourt a manual failover if the timeout is reached. */
    manualFailoverCheckTimeout();

2572
    if (nodeIsSlave(myself)) {
2573
        clusterHandleManualFailover();
2574 2575 2576 2577 2578 2579 2580 2581 2582 2583
        clusterHandleSlaveFailover();
        /* If there are orphaned slaves, and we are a slave among the masters
         * with the max number of non-failing slaves, consider migrating to
         * the orphaned masters. Note that it does not make sense to try
         * a migration if there is no master with at least *two* working
         * slaves. */
        if (orphaned_masters && max_slaves >= 2 && this_slaves == max_slaves)
            clusterHandleSlaveMigration(max_slaves);
    }

2584 2585
    if (update_state || server.cluster->state == REDIS_CLUSTER_FAIL)
        clusterUpdateState();
2586 2587 2588 2589 2590
}

/* 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 已提交
2591 2592
 * handlers, or to perform potentially expansive tasks that we need to do
 * a single time before replying to clients. */
2593
void clusterBeforeSleep(void) {
A
antirez 已提交
2594 2595 2596
    /* 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)
2597
        clusterHandleSlaveFailover();
A
antirez 已提交
2598 2599 2600 2601 2602 2603 2604 2605 2606

    /* 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);
2607
    }
A
antirez 已提交
2608 2609 2610 2611 2612 2613 2614

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

void clusterDoBeforeSleep(int flags) {
    server.cluster->todo_before_sleep |= flags;
A
antirez 已提交
2615 2616 2617 2618 2619 2620
}

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

2621
/* Test bit 'pos' in a generic bitmap. Return 1 if the bit is set,
2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642
 * 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 已提交
2643 2644
/* Set the slot bit and return the old value. */
int clusterNodeSetSlotBit(clusterNode *n, int slot) {
2645 2646
    int old = bitmapTestBit(n->slots,slot);
    bitmapSetBit(n->slots,slot);
2647
    if (!old) n->numslots++;
A
antirez 已提交
2648 2649 2650 2651 2652
    return old;
}

/* Clear the slot bit and return the old value. */
int clusterNodeClearSlotBit(clusterNode *n, int slot) {
2653 2654
    int old = bitmapTestBit(n->slots,slot);
    bitmapClearBit(n->slots,slot);
2655
    if (old) n->numslots--;
A
antirez 已提交
2656 2657 2658 2659 2660
    return old;
}

/* Return the slot bit from the cluster node structure. */
int clusterNodeGetSlotBit(clusterNode *n, int slot) {
2661
    return bitmapTestBit(n->slots,slot);
A
antirez 已提交
2662 2663 2664 2665 2666 2667 2668
}

/* 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) {
2669 2670
    if (server.cluster->slots[slot]) return REDIS_ERR;
    clusterNodeSetSlotBit(n,slot);
2671
    server.cluster->slots[slot] = n;
A
antirez 已提交
2672 2673 2674
    return REDIS_OK;
}

A
antirez 已提交
2675 2676 2677 2678
/* 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) {
2679
    clusterNode *n = server.cluster->slots[slot];
A
antirez 已提交
2680 2681 2682

    if (!n) return REDIS_ERR;
    redisAssert(clusterNodeClearSlotBit(n,slot) == 1);
2683
    server.cluster->slots[slot] = NULL;
A
antirez 已提交
2684 2685 2686
    return REDIS_OK;
}

2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698
/* 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 已提交
2699 2700 2701
/* -----------------------------------------------------------------------------
 * Cluster state evaluation function
 * -------------------------------------------------------------------------- */
2702

2703 2704 2705 2706
/* The following are defines that are only used in the evaluation function
 * and are based on heuristics. Actaully the main point about the rejoin and
 * writable delay is that they should be a few orders of magnitude larger
 * than the network latency. */
2707
#define REDIS_CLUSTER_MAX_REJOIN_DELAY 5000
2708
#define REDIS_CLUSTER_MIN_REJOIN_DELAY 500
2709
#define REDIS_CLUSTER_WRITABLE_DELAY 2000
2710

A
antirez 已提交
2711
void clusterUpdateState(void) {
2712
    int j, new_state;
2713
    int unreachable_masters = 0;
2714
    static mstime_t among_minority_time;
2715 2716 2717 2718 2719 2720 2721 2722 2723
    static mstime_t first_call_time = 0;

    /* If this is a master node, wait some time before turning the state
     * into OK, since it is not a good idea to rejoin the cluster as a writable
     * master, after a reboot, without giving the cluster a chance to
     * reconfigure this node. Note that the delay is calculated starting from
     * the first call to this function and not since the server start, in order
     * to don't count the DB loading time. */
    if (first_call_time == 0) first_call_time = mstime();
2724
    if (nodeIsMaster(myself) &&
2725
        mstime() - first_call_time < REDIS_CLUSTER_WRITABLE_DELAY) return;
A
antirez 已提交
2726

2727 2728
    /* Start assuming the state is OK. We'll turn it into FAIL if there
     * are the right conditions. */
2729
    new_state = REDIS_CLUSTER_OK;
2730

2731
    /* Check if all the slots are covered. */
A
antirez 已提交
2732
    for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
2733 2734
        if (server.cluster->slots[j] == NULL ||
            server.cluster->slots[j]->flags & (REDIS_NODE_FAIL))
A
antirez 已提交
2735
        {
2736
            new_state = REDIS_CLUSTER_FAIL;
A
antirez 已提交
2737 2738 2739
            break;
        }
    }
2740

2741
    /* Compute the cluster size, that is the number of master nodes
2742 2743 2744 2745
     * serving at least a single slot.
     *
     * At the same time count the number of unreachable masters with
     * at least one node. */
2746 2747 2748 2749 2750
    {
        dictIterator *di;
        dictEntry *de;

        server.cluster->size = 0;
2751
        di = dictGetSafeIterator(server.cluster->nodes);
2752 2753 2754
        while((de = dictNext(di)) != NULL) {
            clusterNode *node = dictGetVal(de);

2755
            if (nodeIsMaster(node) && node->numslots) {
2756
                server.cluster->size++;
2757 2758 2759
                if (node->flags & (REDIS_NODE_FAIL|REDIS_NODE_PFAIL))
                    unreachable_masters++;
            }
2760 2761 2762
        }
        dictReleaseIterator(di);
    }
2763

2764
    /* If we can't reach at least half the masters, change the cluster state
2765
     * to FAIL, as we are not even able to mark nodes as FAIL in this side
2766
     * of the netsplit because of lack of majority. */
2767 2768 2769
    {
        int needed_quorum = (server.cluster->size / 2) + 1;
        
2770 2771 2772 2773
        if (unreachable_masters >= needed_quorum) {
            new_state = REDIS_CLUSTER_FAIL;
            among_minority_time = mstime();
        }
2774 2775
    }

2776
    /* Log a state change */
2777 2778 2779 2780 2781 2782 2783 2784 2785
    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;
2786 2787
        if (rejoin_delay < REDIS_CLUSTER_MIN_REJOIN_DELAY)
            rejoin_delay = REDIS_CLUSTER_MIN_REJOIN_DELAY;
2788 2789

        if (new_state == REDIS_CLUSTER_OK &&
2790
            nodeIsMaster(myself) &&
2791 2792 2793 2794 2795 2796
            mstime() - among_minority_time < rejoin_delay)
        {
            return;
        }

        /* Change the state and log the event. */
2797
        redisLog(REDIS_WARNING,"Cluster state changed: %s",
2798 2799 2800
            new_state == REDIS_CLUSTER_OK ? "ok" : "fail");
        server.cluster->state = new_state;
    }
A
antirez 已提交
2801 2802
}

2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825
/* 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) {
2826 2827 2828
    int j;
    int update_config = 0;

2829 2830
    /* If this node is a slave, don't perform the check at all as we
     * completely depend on the replication stream. */
2831
    if (nodeIsSlave(myself)) return REDIS_OK;
2832

2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844
    /* 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. */
2845
        if (server.cluster->slots[j] == myself ||
2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857
            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);
2858
            clusterAddSlot(myself,j);
2859 2860 2861 2862 2863 2864 2865
        } 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 已提交
2866
    if (update_config) clusterSaveConfigOrDie(1);
2867 2868 2869
    return REDIS_OK;
}

2870 2871 2872 2873
/* -----------------------------------------------------------------------------
 * SLAVE nodes handling
 * -------------------------------------------------------------------------- */

2874 2875
/* Set the specified node 'n' as master. Setup the node as a slave if
 * needed. */
2876 2877
void clusterSetMaster(clusterNode *n) {
    redisAssert(n != myself);
2878
    redisAssert(myself->numslots == 0);
2879

2880
    if (nodeIsMaster(myself)) {
2881 2882
        myself->flags &= ~REDIS_NODE_MASTER;
        myself->flags |= REDIS_NODE_SLAVE;
2883 2884 2885
    } else {
        if (myself->slaveof)
            clusterNodeRemoveSlave(myself->slaveof,myself);
2886 2887
    }
    myself->slaveof = n;
2888
    clusterNodeAddSlave(n,myself);
2889
    replicationSetMaster(n->ip, n->port);
2890
    resetManualFailover();
2891 2892
}

A
antirez 已提交
2893 2894 2895 2896
/* -----------------------------------------------------------------------------
 * CLUSTER command
 * -------------------------------------------------------------------------- */

2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972
/* Generate a csv-alike representation of the specified cluster node.
 * See clusterGenNodesDescription() top comment for more information.
 *
 * The function returns the string representation as an SDS string. */
sds clusterGenNodeDescription(clusterNode *node) {
    int j, start;
    sds ci;

    /* Node coordinates */
    ci = sdscatprintf(sdsempty(),"%.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 */
    ci = sdscatprintf(ci,"%lld %lld %llu %s",
        (long long) node->ping_sent,
        (long long) node->pong_received,
        (unsigned long long) node->configEpoch,
        (node->link || node->flags & REDIS_NODE_MYSELF) ?
                    "connected" : "disconnected");

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

    /* 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++) {
            if (server.cluster->migrating_slots_to[j]) {
                ci = sdscatprintf(ci," [%d->-%.40s]",j,
                    server.cluster->migrating_slots_to[j]->name);
            } else if (server.cluster->importing_slots_from[j]) {
                ci = sdscatprintf(ci," [%d-<-%.40s]",j,
                    server.cluster->importing_slots_from[j]->name);
            }
        }
    }
    return ci;
}

2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985
/* 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) {
2986
    sds ci = sdsempty(), ni;
A
antirez 已提交
2987 2988 2989
    dictIterator *di;
    dictEntry *de;

2990
    di = dictGetSafeIterator(server.cluster->nodes);
A
antirez 已提交
2991
    while((de = dictNext(di)) != NULL) {
2992
        clusterNode *node = dictGetVal(de);
A
antirez 已提交
2993

2994
        if (node->flags & filter) continue;
2995 2996 2997
        ni = clusterGenNodeDescription(node);
        ci = sdscatsds(ci,ni);
        sdsfree(ni);
2998
        ci = sdscatlen(ci,"\n",1);
A
antirez 已提交
2999 3000 3001 3002 3003
    }
    dictReleaseIterator(di);
    return ci;
}

3004 3005 3006 3007
int getSlotOrReply(redisClient *c, robj *o) {
    long long slot;

    if (getLongLongFromObject(o,&slot) != REDIS_OK ||
3008
        slot < 0 || slot >= REDIS_CLUSTER_SLOTS)
3009 3010 3011 3012 3013 3014 3015
    {
        addReplyError(c,"Invalid or out of range slot");
        return -1;
    }
    return (int) slot;
}

A
antirez 已提交
3016 3017 3018 3019 3020 3021 3022 3023 3024
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;

3025
        if (getLongFromObjectOrReply(c, c->argv[3], &port, NULL) != REDIS_OK) {
A
antirez 已提交
3026 3027 3028 3029
            addReplyError(c,"Invalid TCP port specified");
            return;
        }

3030 3031 3032 3033 3034 3035 3036
        if (clusterStartHandshake(c->argv[2]->ptr,port) == 0 &&
            errno == EINVAL)
        {
            addReplyError(c,"Invalid node address specified");
        } else {
            addReply(c,shared.ok);
        }
A
antirez 已提交
3037
    } else if (!strcasecmp(c->argv[1]->ptr,"nodes") && c->argc == 2) {
3038
        /* CLUSTER NODES */
A
antirez 已提交
3039
        robj *o;
3040
        sds ci = clusterGenNodesDescription(0);
A
antirez 已提交
3041 3042 3043 3044

        o = createObject(REDIS_STRING,ci);
        addReplyBulk(c,o);
        decrRefCount(o);
3045 3046 3047 3048 3049 3050
    } 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;
        }
3051
        clusterDelNodeSlots(myself);
A
antirez 已提交
3052
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
3053
        addReply(c,shared.ok);
A
antirez 已提交
3054
    } else if ((!strcasecmp(c->argv[1]->ptr,"addslots") ||
A
antirez 已提交
3055 3056 3057 3058
               !strcasecmp(c->argv[1]->ptr,"delslots")) && c->argc >= 3)
    {
        /* CLUSTER ADDSLOTS <slot> [slot] ... */
        /* CLUSTER DELSLOTS <slot> [slot] ... */
3059
        int j, slot;
A
antirez 已提交
3060
        unsigned char *slots = zmalloc(REDIS_CLUSTER_SLOTS);
A
antirez 已提交
3061
        int del = !strcasecmp(c->argv[1]->ptr,"delslots");
A
antirez 已提交
3062 3063 3064 3065 3066

        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++) {
3067
            if ((slot = getSlotOrReply(c,c->argv[j])) == -1) {
A
antirez 已提交
3068 3069 3070
                zfree(slots);
                return;
            }
3071
            if (del && server.cluster->slots[slot] == NULL) {
3072
                addReplyErrorFormat(c,"Slot %d is already unassigned", slot);
A
antirez 已提交
3073 3074
                zfree(slots);
                return;
3075
            } else if (!del && server.cluster->slots[slot]) {
3076
                addReplyErrorFormat(c,"Slot %d is already busy", slot);
A
antirez 已提交
3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088
                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]) {
3089 3090 3091 3092
                int retval;

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

                retval = del ? clusterDelSlot(j) :
3097
                               clusterAddSlot(myself,j);
3098
                redisAssertWithInfo(c,NULL,retval == REDIS_OK);
A
antirez 已提交
3099 3100 3101
            }
        }
        zfree(slots);
A
antirez 已提交
3102
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
A
antirez 已提交
3103
        addReply(c,shared.ok);
3104
    } else if (!strcasecmp(c->argv[1]->ptr,"setslot") && c->argc >= 4) {
A
antirez 已提交
3105 3106
        /* SETSLOT 10 MIGRATING <node ID> */
        /* SETSLOT 10 IMPORTING <node ID> */
3107
        /* SETSLOT 10 STABLE */
A
antirez 已提交
3108
        /* SETSLOT 10 NODE <node ID> */
3109
        int slot;
3110 3111
        clusterNode *n;

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

3114
        if (!strcasecmp(c->argv[3]->ptr,"migrating") && c->argc == 5) {
3115
            if (server.cluster->slots[slot] != myself) {
3116 3117 3118
                addReplyErrorFormat(c,"I'm not the owner of hash slot %u",slot);
                return;
            }
3119 3120 3121 3122 3123
            if ((n = clusterLookupNode(c->argv[4]->ptr)) == NULL) {
                addReplyErrorFormat(c,"I don't know about node %s",
                    (char*)c->argv[4]->ptr);
                return;
            }
3124
            server.cluster->migrating_slots_to[slot] = n;
3125
        } else if (!strcasecmp(c->argv[3]->ptr,"importing") && c->argc == 5) {
3126
            if (server.cluster->slots[slot] == myself) {
3127 3128 3129 3130
                addReplyErrorFormat(c,
                    "I'm already the owner of hash slot %u",slot);
                return;
            }
3131 3132 3133 3134 3135
            if ((n = clusterLookupNode(c->argv[4]->ptr)) == NULL) {
                addReplyErrorFormat(c,"I don't know about node %s",
                    (char*)c->argv[3]->ptr);
                return;
            }
3136
            server.cluster->importing_slots_from[slot] = n;
3137
        } else if (!strcasecmp(c->argv[3]->ptr,"stable") && c->argc == 4) {
3138
            /* CLUSTER SETSLOT <SLOT> STABLE */
3139 3140
            server.cluster->importing_slots_from[slot] = NULL;
            server.cluster->migrating_slots_to[slot] = NULL;
3141
        } else if (!strcasecmp(c->argv[3]->ptr,"node") && c->argc == 5) {
3142 3143 3144
            /* CLUSTER SETSLOT <SLOT> NODE <NODE ID> */
            clusterNode *n = clusterLookupNode(c->argv[4]->ptr);

3145 3146 3147 3148 3149
            if (!n) {
                addReplyErrorFormat(c,"Unknown node %s",
                    (char*)c->argv[4]->ptr);
                return;
            }
3150 3151
            /* If this hash slot was served by 'myself' before to switch
             * make sure there are no longer local keys for this hash slot. */
3152
            if (server.cluster->slots[slot] == myself && n != myself) {
3153
                if (countKeysInSlot(slot) != 0) {
3154 3155 3156 3157
                    addReplyErrorFormat(c, "Can't assign hashslot %d to a different node while I still hold keys for this hash slot.", slot);
                    return;
                }
            }
3158 3159
            /* If this slot is in migrating status but we have no keys
             * for it assigning the slot to another node will clear
3160
             * the migratig status. */
3161
            if (countKeysInSlot(slot) == 0 &&
3162 3163
                server.cluster->migrating_slots_to[slot])
                server.cluster->migrating_slots_to[slot] = NULL;
3164

3165 3166
            /* If this node was importing this slot, assigning the slot to
             * itself also clears the importing status. */
3167
            if (n == myself &&
3168
                server.cluster->importing_slots_from[slot])
3169 3170
            {
                /* This slot was manually migrated, set this node configEpoch
3171 3172 3173 3174 3175 3176
                 * to a new epoch so that the new version can be propagated
                 * by the cluster.
                 *
                 * FIXME: the new version should be agreed otherwise a race
                 * is possible if while a manual resharding is in progress
                 * the master is failed over by a slave. */
3177 3178 3179 3180 3181 3182 3183
                uint64_t maxEpoch = clusterGetMaxEpoch();

                if (myself->configEpoch != maxEpoch) {
                    server.cluster->currentEpoch++;
                    myself->configEpoch = server.cluster->currentEpoch;
                    clusterDoBeforeSleep(CLUSTER_TODO_FSYNC_CONFIG);
                }
3184
                server.cluster->importing_slots_from[slot] = NULL;
3185
            }
3186 3187
            clusterDelSlot(slot);
            clusterAddSlot(n,slot);
3188 3189
        } else {
            addReplyError(c,"Invalid CLUSTER SETSLOT action or number of arguments");
3190
            return;
3191
        }
3192
        clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|CLUSTER_TODO_UPDATE_STATE);
3193
        addReply(c,shared.ok);
A
antirez 已提交
3194
    } else if (!strcasecmp(c->argv[1]->ptr,"info") && c->argc == 2) {
3195
        /* CLUSTER INFO */
A
antirez 已提交
3196 3197 3198 3199 3200
        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++) {
3201
            clusterNode *n = server.cluster->slots[j];
A
antirez 已提交
3202 3203 3204

            if (n == NULL) continue;
            slots_assigned++;
3205
            if (nodeFailed(n)) {
A
antirez 已提交
3206
                slots_fail++;
3207
            } else if (nodeTimedOut(n)) {
A
antirez 已提交
3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219
                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"
3220
            "cluster_known_nodes:%lu\r\n"
3221
            "cluster_size:%d\r\n"
3222
            "cluster_current_epoch:%llu\r\n"
3223 3224
            "cluster_stats_messages_sent:%lld\r\n"
            "cluster_stats_messages_received:%lld\r\n"
3225
            , statestr[server.cluster->state],
A
antirez 已提交
3226 3227 3228
            slots_assigned,
            slots_ok,
            slots_pfail,
3229
            slots_fail,
3230
            dictSize(server.cluster->nodes),
3231
            server.cluster->size,
3232 3233 3234
            (unsigned long long) server.cluster->currentEpoch,
            server.cluster->stats_bus_messages_sent,
            server.cluster->stats_bus_messages_received
A
antirez 已提交
3235 3236 3237 3238 3239
        );
        addReplySds(c,sdscatprintf(sdsempty(),"$%lu\r\n",
            (unsigned long)sdslen(info)));
        addReplySds(c,info);
        addReply(c,shared.crlf);
3240
    } else if (!strcasecmp(c->argv[1]->ptr,"saveconfig") && c->argc == 2) {
A
antirez 已提交
3241
        int retval = clusterSaveConfig(1);
3242 3243 3244 3245 3246 3247

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

        addReplyLongLong(c,keyHashSlot(key,sdslen(key)));
3253
    } else if (!strcasecmp(c->argv[1]->ptr,"countkeysinslot") && c->argc == 3) {
3254
        /* CLUSTER COUNTKEYSINSLOT <slot> */
3255 3256 3257 3258
        long long slot;

        if (getLongLongFromObjectOrReply(c,c->argv[2],&slot,NULL) != REDIS_OK)
            return;
3259 3260 3261 3262
        if (slot < 0 || slot >= REDIS_CLUSTER_SLOTS) {
            addReplyError(c,"Invalid slot");
            return;
        }
3263
        addReplyLongLong(c,countKeysInSlot(slot));
A
antirez 已提交
3264
    } else if (!strcasecmp(c->argv[1]->ptr,"getkeysinslot") && c->argc == 4) {
3265
        /* CLUSTER GETKEYSINSLOT <slot> <count> */
A
antirez 已提交
3266
        long long maxkeys, slot;
3267
        unsigned int numkeys, j;
A
antirez 已提交
3268 3269 3270 3271 3272 3273
        robj **keys;

        if (getLongLongFromObjectOrReply(c,c->argv[2],&slot,NULL) != REDIS_OK)
            return;
        if (getLongLongFromObjectOrReply(c,c->argv[3],&maxkeys,NULL) != REDIS_OK)
            return;
3274
        if (slot < 0 || slot >= REDIS_CLUSTER_SLOTS || maxkeys < 0) {
A
antirez 已提交
3275 3276 3277 3278 3279
            addReplyError(c,"Invalid slot or number of keys");
            return;
        }

        keys = zmalloc(sizeof(robj*)*maxkeys);
3280
        numkeys = getKeysInSlot(slot, keys, maxkeys);
A
antirez 已提交
3281 3282 3283
        addReplyMultiBulkLen(c,numkeys);
        for (j = 0; j < numkeys; j++) addReplyBulk(c,keys[j]);
        zfree(keys);
A
antirez 已提交
3284 3285 3286 3287
    } else if (!strcasecmp(c->argv[1]->ptr,"forget") && c->argc == 3) {
        /* CLUSTER FORGET <NODE ID> */
        clusterNode *n = clusterLookupNode(c->argv[2]->ptr);

3288
        if (!n) {
A
antirez 已提交
3289 3290
            addReplyErrorFormat(c,"Unknown node %s", (char*)c->argv[2]->ptr);
            return;
3291
        } else if (n == myself) {
3292 3293
            addReplyError(c,"I tried hard but I can't forget myself...");
            return;
3294
        } else if (nodeIsSlave(myself) && myself->slaveof == n) {
3295 3296
            addReplyError(c,"Can't forget my master!");
            return;
A
antirez 已提交
3297
        }
3298
        clusterBlacklistAddNode(n);
A
antirez 已提交
3299
        clusterDelNode(n);
A
antirez 已提交
3300
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
A
antirez 已提交
3301
        addReply(c,shared.ok);
3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312
    } 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. */
3313
        if (n == myself) {
3314 3315 3316 3317 3318 3319 3320 3321 3322 3323
            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;
        }

3324 3325 3326
        /* If the instance is currently a master, it should have no assigned
         * slots nor keys to accept to replicate some other node.
         * Slaves can switch to another master without issues. */
3327 3328
        if (nodeIsMaster(myself) &&
            (myself->numslots != 0 || dictSize(server.db[0].dict) != 0)) {
3329 3330 3331 3332 3333 3334
            addReplyError(c,"To set a master the node must be empty and without assigned slots.");
            return;
        }

        /* Set the master. */
        clusterSetMaster(n);
A
antirez 已提交
3335
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
3336
        addReply(c,shared.ok);
3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347
    } else if (!strcasecmp(c->argv[1]->ptr,"slaves") && c->argc == 3) {
        /* CLUSTER SLAVES <NODE ID> */
        clusterNode *n = clusterLookupNode(c->argv[2]->ptr);
        int j;

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

3348
        if (nodeIsSlave(n)) {
3349 3350 3351 3352 3353 3354 3355 3356 3357 3358
            addReplyError(c,"The specified node is not a master");
            return;
        }

        addReplyMultiBulkLen(c,n->numslaves);
        for (j = 0; j < n->numslaves; j++) {
            sds ni = clusterGenNodeDescription(n->slaves[j]);
            addReplyBulkCString(c,ni);
            sdsfree(ni);
        }
3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372
    } else if (!strcasecmp(c->argv[1]->ptr,"failover") && c->argc == 2) {
        if (nodeIsMaster(myself)) {
            addReplyError(c,"You should send CLUSTER FAILOVER to a slave");
            return;
        } else if (myself->slaveof == NULL || nodeFailed(myself->slaveof) ||
                   myself->slaveof->link == NULL)
        {
            addReplyError(c,"Master is down or failed, "
                            "please use CLUSTER FAILOVER FORCE");
            return;
        }
        resetManualFailover();
        server.cluster->mf_end = mstime() + REDIS_CLUSTER_MF_TIMEOUT;
        clusterSendMFStart(myself->slaveof);
3373 3374
        redisLog(REDIS_WARNING,"Manual failover user request accepted.");
        addReply(c,shared.ok);
A
antirez 已提交
3375 3376 3377 3378 3379 3380
    } else {
        addReplyError(c,"Wrong CLUSTER subcommand or number of arguments");
    }
}

/* -----------------------------------------------------------------------------
3381
 * DUMP, RESTORE and MIGRATE commands
A
antirez 已提交
3382 3383
 * -------------------------------------------------------------------------- */

3384 3385 3386
/* 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) {
3387 3388
    unsigned char buf[2];
    uint64_t crc;
3389 3390 3391 3392 3393 3394 3395 3396

    /* 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:
3397 3398 3399 3400 3401
     * ----------------+---------------------+---------------+
     * ... RDB payload | 2 bytes RDB version | 8 bytes CRC64 |
     * ----------------+---------------------+---------------+
     * RDB version and CRC are both in little endian.
     */
3402 3403

    /* RDB version */
3404 3405
    buf[0] = REDIS_RDB_VERSION & 0xff;
    buf[1] = (REDIS_RDB_VERSION >> 8) & 0xff;
3406 3407
    payload->io.buffer.ptr = sdscatlen(payload->io.buffer.ptr,buf,2);

3408
    /* CRC64 */
3409
    crc = crc64(0,(unsigned char*)payload->io.buffer.ptr,
3410 3411 3412
                sdslen(payload->io.buffer.ptr));
    memrev64ifbe(&crc);
    payload->io.buffer.ptr = sdscatlen(payload->io.buffer.ptr,&crc,8);
3413 3414 3415
}

/* Verify that the RDB version of the dump payload matches the one of this Redis
3416
 * instance and that the checksum is ok.
3417 3418 3419
 * If the DUMP payload looks valid REDIS_OK is returned, otherwise REDIS_ERR
 * is returned. */
int verifyDumpPayload(unsigned char *p, size_t len) {
3420
    unsigned char *footer;
3421
    uint16_t rdbver;
3422
    uint64_t crc;
3423

3424
    /* At least 2 bytes of RDB version and 8 of CRC64 should be present. */
3425 3426
    if (len < 10) return REDIS_ERR;
    footer = p+(len-10);
3427 3428

    /* Verify RDB version */
3429
    rdbver = (footer[1] << 8) | footer[0];
3430
    if (rdbver != REDIS_RDB_VERSION) return REDIS_ERR;
3431

3432
    /* Verify CRC64 */
3433
    crc = crc64(0,p,len-8);
3434 3435
    memrev64ifbe(&crc);
    return (memcmp(&crc,footer+2,8) == 0) ? REDIS_OK : REDIS_ERR;
3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460
}

/* 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 已提交
3461
/* RESTORE key ttl serialized-value [REPLACE] */
A
antirez 已提交
3462
void restoreCommand(redisClient *c) {
3463
    long long ttl;
3464
    rio payload;
A
antirez 已提交
3465
    int j, type, replace = 0;
3466
    robj *obj;
A
antirez 已提交
3467

A
antirez 已提交
3468 3469 3470 3471 3472 3473 3474 3475 3476 3477
    /* 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 已提交
3478
    /* Make sure this key does not already exist here... */
A
antirez 已提交
3479
    if (!replace && lookupKeyWrite(c->db,c->argv[1]) != NULL) {
A
antirez 已提交
3480 3481 3482 3483 3484
        addReplyError(c,"Target key name is busy.");
        return;
    }

    /* Check if the TTL value makes sense */
3485
    if (getLongLongFromObjectOrReply(c,c->argv[2],&ttl,NULL) != REDIS_OK) {
A
antirez 已提交
3486 3487 3488 3489 3490 3491
        return;
    } else if (ttl < 0) {
        addReplyError(c,"Invalid TTL value, must be >= 0");
        return;
    }

3492
    /* Verify RDB version and data checksum. */
3493 3494
    if (verifyDumpPayload(c->argv[3]->ptr,sdslen(c->argv[3]->ptr)) == REDIS_ERR)
    {
3495 3496 3497 3498
        addReplyError(c,"DUMP payload version or checksum are wrong");
        return;
    }

3499
    rioInitWithBuffer(&payload,c->argv[3]->ptr);
3500 3501
    if (((type = rdbLoadObjectType(&payload)) == -1) ||
        ((obj = rdbLoadObject(type,&payload)) == NULL))
3502
    {
3503
        addReplyError(c,"Bad data format");
A
antirez 已提交
3504 3505 3506
        return;
    }

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

A
antirez 已提交
3510
    /* Create the key and set the TTL if any */
3511
    dbAdd(c->db,c->argv[1],obj);
3512
    if (ttl) setExpire(c->db,c->argv[1],mstime()+ttl);
3513
    signalModifiedKey(c->db,c->argv[1]);
A
antirez 已提交
3514
    addReply(c,shared.ok);
3515
    server.dirty++;
A
antirez 已提交
3516 3517
}

A
antirez 已提交
3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577
/* 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;
    }
3578
    anetEnableTcpNoDelay(server.neterr,fd);
A
antirez 已提交
3579 3580

    /* Check if it connects within the specified timeout. */
3581
    if ((aeWait(fd,AE_WRITABLE,timeout) & AE_WRITABLE) == 0) {
A
antirez 已提交
3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631
        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 已提交
3632
/* MIGRATE host port key dbid timeout [COPY | REPLACE] */
A
antirez 已提交
3633
void migrateCommand(redisClient *c) {
A
antirez 已提交
3634
    int fd, copy, replace, j;
A
antirez 已提交
3635 3636
    long timeout;
    long dbid;
A
antirez 已提交
3637
    long long ttl, expireat;
A
antirez 已提交
3638
    robj *o;
3639
    rio cmd, payload;
A
antirez 已提交
3640 3641 3642 3643 3644 3645 3646
    int retry_num = 0;

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

A
antirez 已提交
3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659
    /* 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 已提交
3660 3661 3662 3663 3664
    /* Sanity check */
    if (getLongFromObjectOrReply(c,c->argv[5],&timeout,NULL) != REDIS_OK)
        return;
    if (getLongFromObjectOrReply(c,c->argv[4],&dbid,NULL) != REDIS_OK)
        return;
3665
    if (timeout <= 0) timeout = 1000;
A
antirez 已提交
3666 3667 3668 3669 3670

    /* 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) {
3671
        addReplySds(c,sdsnew("+NOKEY\r\n"));
A
antirez 已提交
3672 3673 3674 3675
        return;
    }
    
    /* Connect */
A
antirez 已提交
3676 3677
    fd = migrateGetSocket(c,c->argv[1],c->argv[2],timeout);
    if (fd == -1) return; /* error sent to the client by migrateGetSocket() */
A
antirez 已提交
3678

3679
    /* Create RESTORE payload and generate the protocol to call the command. */
3680
    rioInitWithBuffer(&cmd,sdsempty());
3681 3682 3683
    redisAssertWithInfo(c,NULL,rioWriteBulkCount(&cmd,'*',2));
    redisAssertWithInfo(c,NULL,rioWriteBulkString(&cmd,"SELECT",6));
    redisAssertWithInfo(c,NULL,rioWriteBulkLongLong(&cmd,dbid));
A
antirez 已提交
3684

A
antirez 已提交
3685 3686 3687 3688 3689
    expireat = getExpire(c->db,c->argv[3]);
    if (expireat != -1) {
        ttl = expireat-mstime();
        if (ttl < 1) ttl = 1;
    }
A
antirez 已提交
3690
    redisAssertWithInfo(c,NULL,rioWriteBulkCount(&cmd,'*',replace ? 5 : 4));
3691 3692 3693 3694 3695
    if (server.cluster_enabled)
        redisAssertWithInfo(c,NULL,
            rioWriteBulkString(&cmd,"RESTORE-ASKING",14));
    else
        redisAssertWithInfo(c,NULL,rioWriteBulkString(&cmd,"RESTORE",7));
3696
    redisAssertWithInfo(c,NULL,sdsEncodedObject(c->argv[3]));
3697
    redisAssertWithInfo(c,NULL,rioWriteBulkString(&cmd,c->argv[3]->ptr,sdslen(c->argv[3]->ptr)));
3698
    redisAssertWithInfo(c,NULL,rioWriteBulkLongLong(&cmd,ttl));
A
antirez 已提交
3699

G
guiquanz 已提交
3700
    /* Emit the payload argument, that is the serialized object using
A
antirez 已提交
3701
     * the DUMP format. */
3702 3703 3704
    createDumpPayload(&payload,o);
    redisAssertWithInfo(c,NULL,rioWriteBulkString(&cmd,payload.io.buffer.ptr,
                                sdslen(payload.io.buffer.ptr)));
3705 3706
    sdsfree(payload.io.buffer.ptr);

A
antirez 已提交
3707 3708 3709 3710 3711
    /* 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 已提交
3712
    /* Transfer the query to the other node in 64K chunks. */
A
antirez 已提交
3713
    errno = 0;
A
antirez 已提交
3714
    {
3715 3716 3717 3718 3719 3720
        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);
3721
            nwritten = syncWrite(fd,buf+pos,towrite,timeout);
3722 3723
            if (nwritten != (signed)towrite) goto socket_wr_err;
            pos += nwritten;
A
antirez 已提交
3724 3725 3726
        }
    }

3727
    /* Read back the reply. */
A
antirez 已提交
3728 3729 3730 3731 3732 3733 3734 3735
    {
        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)
3736
            goto socket_rd_err;
A
antirez 已提交
3737 3738 3739 3740
        if (buf1[0] == '-' || buf2[0] == '-') {
            addReplyErrorFormat(c,"Target instance replied with error: %s",
                (buf1[0] == '-') ? buf1+1 : buf2+1);
        } else {
3741 3742
            robj *aux;

A
antirez 已提交
3743 3744 3745 3746 3747
            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 已提交
3748
            addReply(c,shared.ok);
3749 3750 3751
            server.dirty++;

            /* Translate MIGRATE as DEL for replication/AOF. */
A
antirez 已提交
3752
            aux = createStringObject("DEL",3);
3753 3754
            rewriteClientCommandVector(c,2,aux,c->argv[3]);
            decrRefCount(aux);
A
antirez 已提交
3755 3756 3757
        }
    }

3758
    sdsfree(cmd.io.buffer.ptr);
3759
    return;
A
antirez 已提交
3760 3761

socket_wr_err:
3762
    sdsfree(cmd.io.buffer.ptr);
A
antirez 已提交
3763
    migrateCloseSocket(c->argv[1],c->argv[2]);
A
antirez 已提交
3764 3765 3766
    if (errno != ETIMEDOUT && retry_num++ == 0) goto try_again;
    addReplySds(c,
        sdsnew("-IOERR error or timeout writing to target instance\r\n"));
3767
    return;
A
antirez 已提交
3768 3769

socket_rd_err:
3770
    sdsfree(cmd.io.buffer.ptr);
A
antirez 已提交
3771
    migrateCloseSocket(c->argv[1],c->argv[2]);
A
antirez 已提交
3772 3773 3774
    if (errno != ETIMEDOUT && retry_num++ == 0) goto try_again;
    addReplySds(c,
        sdsnew("-IOERR error or timeout reading from target node\r\n"));
3775 3776 3777
    return;
}

3778 3779 3780 3781
/* -----------------------------------------------------------------------------
 * Cluster functions related to serving / redirecting clients
 * -------------------------------------------------------------------------- */

3782
/* The ASKING command is required after a -ASK redirection.
G
guiquanz 已提交
3783
 * The client should issue ASKING before to actually send the command to
3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794
 * 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);
}

3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811
/* 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 已提交
3812

3813 3814 3815
/* 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 已提交
3816
 *
3817 3818 3819 3820
 * 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.
 *
3821 3822
 * If the command contains multiple keys, and as a consequence it is not
 * possible to handle the request in Redis Cluster, NULL is returned. */
3823
clusterNode *getNodeByQuery(redisClient *c, struct redisCommand *cmd, robj **argv, int argc, int *hashslot, int *ask) {
A
antirez 已提交
3824
    clusterNode *n = NULL;
3825
    robj *firstkey = NULL;
A
antirez 已提交
3826 3827
    multiState *ms, _ms;
    multiCmd mc;
3828
    int i, slot = 0;
A
antirez 已提交
3829 3830 3831 3832 3833 3834

    /* 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. */
3835
        if (!(c->flags & REDIS_MULTI)) return myself;
A
antirez 已提交
3836 3837
        ms = &c->mstate;
    } else {
3838 3839 3840
        /* 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 已提交
3841 3842 3843 3844 3845 3846 3847 3848
        ms = &_ms;
        _ms.commands = &mc;
        _ms.count = 1;
        mc.argv = argv;
        mc.argc = argc;
        mc.cmd = cmd;
    }

3849 3850
    /* Check that all the keys are the same key, and get the slot and
     * node for this key. */
A
antirez 已提交
3851 3852 3853 3854 3855 3856 3857 3858 3859 3860
    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,
3861
                                      REDIS_GETKEYS_ALL);
A
antirez 已提交
3862
        for (j = 0; j < numkeys; j++) {
3863 3864 3865 3866 3867 3868
            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));
3869
                n = server.cluster->slots[slot];
3870
                redisAssertWithInfo(c,firstkey,n != NULL);
A
antirez 已提交
3871
            } else {
3872 3873 3874 3875 3876 3877
                /* 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 已提交
3878 3879 3880 3881
            }
        }
        getKeysFreeResult(keyindex);
    }
3882 3883 3884
    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. */
3885
    if (n == NULL) return myself;
3886 3887 3888 3889 3890
    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. */
3891
    if (n == myself && server.cluster->migrating_slots_to[slot] != NULL) {
3892 3893
        if (lookupKeyRead(&server.db[0],firstkey) == NULL) {
            if (ask) *ask = 1;
3894
            return server.cluster->migrating_slots_to[slot];
3895 3896 3897 3898
        }
    }
    /* 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
3899 3900
     * it is assigned to a different node, but only if the client
     * issued an ASKING command before. */
3901
    if (server.cluster->importing_slots_from[slot] != NULL &&
3902
        (c->flags & REDIS_ASKING || cmd->flags & REDIS_CMD_ASKING)) {
3903
        return myself;
3904
    }
3905 3906 3907 3908 3909
    /* 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 &&
3910
        nodeIsSlave(myself) &&
3911
        myself->slaveof == n)
3912
    {
3913
        return myself;
3914
    }
3915 3916
    /* It's not a -ASK case. Base case: just return the right node. */
    return n;
A
antirez 已提交
3917
}