cluster.c 182.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>
42
#include <sys/file.h>
A
antirez 已提交
43

44 45 46 47 48
/* 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;

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

A
antirez 已提交
77 78 79 80
/* -----------------------------------------------------------------------------
 * Initialization
 * -------------------------------------------------------------------------- */

81 82 83
/* Return the greatest configEpoch found in the cluster. */
uint64_t clusterGetMaxEpoch(void) {
    uint64_t max = 0;
84 85 86 87 88 89
    dictIterator *di;
    dictEntry *de;

    di = dictGetSafeIterator(server.cluster->nodes);
    while((de = dictNext(di)) != NULL) {
        clusterNode *node = dictGetVal(de);
90
        if (node->configEpoch > max) max = node->configEpoch;
91 92
    }
    dictReleaseIterator(di);
93
    if (max < server.cluster->currentEpoch) max = server.cluster->currentEpoch;
94
    return max;
95 96
}

97 98 99 100 101 102
/* Load the cluster config from 'filename'.
 *
 * If the file does not exist or is zero-length (this may happen because
 * when we lock the nodes.conf file, we create a zero-length one for the
 * sake of locking if it does not already exist), REDIS_ERR is returned.
 * If the configuration was loaded from the file, REDIS_OK is returned. */
A
antirez 已提交
103 104
int clusterLoadConfig(char *filename) {
    FILE *fp = fopen(filename,"r");
105
    struct stat sb;
A
antirez 已提交
106
    char *line;
107
    int maxline, j;
108

109 110 111 112 113 114 115 116 117 118
    if (fp == NULL) {
        if (errno == ENOENT) {
            return REDIS_ERR;
        } else {
            redisLog(REDIS_WARNING,
                "Loading the cluster node config from %s: %s",
                filename, strerror(errno));
            exit(1);
        }
    }
A
antirez 已提交
119

120 121 122 123 124 125 126
    /* Check if the file is zero-length: if so return REDIS_ERR to signal
     * we have to write the config. */
    if (fstat(fileno(fp),&sb) != -1 && sb.st_size == 0) {
        fclose(fp);
        return REDIS_ERR;
    }

M
Matt Stancliff 已提交
127
    /* Parse the file. Note that single lines of the cluster config file can
A
antirez 已提交
128
     * be really long as they include all the hash slots of the node.
129 130 131 132 133 134
     * 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 已提交
135 136 137
    line = zmalloc(maxline);
    while(fgets(line,maxline,fp) != NULL) {
        int argc;
138
        sds *argv;
139 140 141
        clusterNode *n, *master;
        char *p, *s;

142 143 144 145 146 147 148 149 150
        /* 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;

151 152 153 154 155 156 157
        /* Handle the special "vars" line. Don't pretend it is the last
         * line even if it actually is when generated by Redis. */
        if (strcasecmp(argv[0],"vars") == 0) {
            for (j = 1; j < argc; j += 2) {
                if (strcasecmp(argv[j],"currentEpoch") == 0) {
                    server.cluster->currentEpoch =
                            strtoull(argv[j+1],NULL,10);
158 159
                } else if (strcasecmp(argv[j],"lastVoteEpoch") == 0) {
                    server.cluster->lastVoteEpoch =
160 161 162 163 164 165 166
                            strtoull(argv[j+1],NULL,10);
                } else {
                    redisLog(REDIS_WARNING,
                        "Skipping unknown cluster config variable '%s'",
                        argv[j]);
                }
            }
167
            sdsfreesplitres(argv,argc);
168 169 170
            continue;
        }

171 172 173
        /* Regular config lines have at least eight fields */
        if (argc < 8) goto fmterr;

174 175 176 177 178 179 180
        /* Create this node if it does not exist */
        n = clusterLookupNode(argv[0]);
        if (!n) {
            n = createClusterNode(argv[0],0);
            clusterAddNode(n);
        }
        /* Address and port */
181
        if ((p = strrchr(argv[1],':')) == NULL) goto fmterr;
182 183 184 185 186 187 188 189 190 191
        *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")) {
192
                redisAssert(server.cluster->myself == NULL);
193
                myself = server.cluster->myself = n;
194 195 196 197 198 199 200 201 202
                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;
203
                n->fail_time = mstime();
204 205 206 207
            } else if (!strcasecmp(s,"handshake")) {
                n->flags |= REDIS_NODE_HANDSHAKE;
            } else if (!strcasecmp(s,"noaddr")) {
                n->flags |= REDIS_NODE_NOADDR;
208 209
            } else if (!strcasecmp(s,"noflags")) {
                /* nothing to do */
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
            } 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);
        }

228
        /* Set ping sent / pong received timestamps */
229 230
        if (atoi(argv[4])) n->ping_sent = mstime();
        if (atoi(argv[5])) n->pong_received = mstime();
231

232 233 234
        /* Set configEpoch for this node. */
        n->configEpoch = strtoull(argv[6],NULL,10);

235
        /* Populate hash slots served by this instance. */
236
        for (j = 8; j < argc; j++) {
237 238
            int start, stop;

A
antirez 已提交
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
            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 == '>') {
257
                    server.cluster->migrating_slots_to[slot] = cn;
A
antirez 已提交
258
                } else {
259
                    server.cluster->importing_slots_from[slot] = cn;
A
antirez 已提交
260 261 262
                }
                continue;
            } else if ((p = strchr(argv[j],'-')) != NULL) {
263 264 265 266 267 268 269 270
                *p = '\0';
                start = atoi(argv[j]);
                stop = atoi(p+1);
            } else {
                start = stop = atoi(argv[j]);
            }
            while(start <= stop) clusterAddSlot(n, start++);
        }
A
antirez 已提交
271

272
        sdsfreesplitres(argv,argc);
A
antirez 已提交
273
    }
274 275 276
    /* Config sanity check */
    if (server.cluster->myself == NULL) goto fmterr;

A
antirez 已提交
277
    zfree(line);
A
antirez 已提交
278 279
    fclose(fp);

280
    redisLog(REDIS_NOTICE,"Node configuration loaded, I'm %.40s", myself->name);
281 282 283 284 285 286 287

    /* Something that should never happen: currentEpoch smaller than
     * the max epoch found in the nodes configuration. However we handle this
     * as some form of protection against manual editing of critical files. */
    if (clusterGetMaxEpoch() > server.cluster->currentEpoch) {
        server.cluster->currentEpoch = clusterGetMaxEpoch();
    }
A
antirez 已提交
288 289 290
    return REDIS_OK;

fmterr:
A
antirez 已提交
291 292
    redisLog(REDIS_WARNING,
        "Unrecoverable error: corrupted cluster config file.");
293
    zfree(line);
294
    if (fp) fclose(fp);
A
antirez 已提交
295 296 297
    exit(1);
}

A
antirez 已提交
298 299 300
/* Cluster node configuration is exactly the same as CLUSTER NODES output.
 *
 * This function writes the node config and returns 0, on error -1
301 302 303 304 305 306 307 308 309
 * 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 已提交
310
int clusterSaveConfig(int do_fsync) {
311 312
    sds ci;
    size_t content_size;
313
    struct stat sb;
A
antirez 已提交
314
    int fd;
315

316 317
    server.cluster->todo_before_sleep &= ~CLUSTER_TODO_SAVE_CONFIG;

318
    /* Get the nodes description and concatenate our "vars" directive to
319
     * save currentEpoch and lastVoteEpoch. */
320
    ci = clusterGenNodesDescription(REDIS_NODE_HANDSHAKE);
321
    ci = sdscatprintf(ci,"vars currentEpoch %llu lastVoteEpoch %llu\n",
322
        (unsigned long long) server.cluster->currentEpoch,
323
        (unsigned long long) server.cluster->lastVoteEpoch);
324
    content_size = sdslen(ci);
325

326
    if ((fd = open(server.cluster_configfile,O_WRONLY|O_CREAT,0644))
A
antirez 已提交
327
        == -1) goto err;
328 329 330

    /* Pad the new payload if the existing file length is greater. */
    if (fstat(fd,&sb) != -1) {
331
        if (sb.st_size > (off_t)content_size) {
332 333 334 335
            ci = sdsgrowzero(ci,sb.st_size);
            memset(ci+content_size,'\n',sb.st_size-content_size);
        }
    }
A
antirez 已提交
336
    if (write(fd,ci,sdslen(ci)) != (ssize_t)sdslen(ci)) goto err;
337 338 339 340
    if (do_fsync) {
        server.cluster->todo_before_sleep &= ~CLUSTER_TODO_FSYNC_CONFIG;
        fsync(fd);
    }
341 342 343 344 345 346

    /* 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 已提交
347 348 349 350 351
    close(fd);
    sdsfree(ci);
    return 0;

err:
352
    if (fd != -1) close(fd);
A
antirez 已提交
353 354 355 356
    sdsfree(ci);
    return -1;
}

A
antirez 已提交
357 358
void clusterSaveConfigOrDie(int do_fsync) {
    if (clusterSaveConfig(do_fsync) == -1) {
359 360 361 362 363
        redisLog(REDIS_WARNING,"Fatal: can't update cluster config file.");
        exit(1);
    }
}

364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403
/* Lock the cluster config using flock(), and leaks the file descritor used to
 * acquire the lock so that the file will be locked forever.
 *
 * This works because we always update nodes.conf with a new version
 * in-place, reopening the file, and writing to it in place (later adjusting
 * the length with ftruncate()).
 *
 * On success REDIS_OK is returned, otherwise an error is logged and
 * the function returns REDIS_ERR to signal a lock was not acquired. */
int clusterLockConfig(char *filename) {
    /* To lock it, we need to open the file in a way it is created if
     * it does not exist, otherwise there is a race condition with other
     * processes. */
    int fd = open(filename,O_WRONLY|O_CREAT,0644);
    if (fd == -1) {
        redisLog(REDIS_WARNING,
            "Can't open %s in order to acquire a lock: %s",
            filename, strerror(errno));
        return REDIS_ERR;
    }

    if (flock(fd,LOCK_EX|LOCK_NB) == -1) {
        if (errno == EWOULDBLOCK) {
            redisLog(REDIS_WARNING,
                 "Sorry, the cluster configuration file %s is already used "
                 "by a different Redis Cluster node. Please make sure that "
                 "different nodes use different cluster configuration "
                 "files.", filename);
        } else {
            redisLog(REDIS_WARNING,
                "Impossible to lock %s: %s", filename, strerror(errno));
        }
        close(fd);
        return REDIS_ERR;
    }
    /* Lock acquired: leak the 'fd' by not closing it, so that we'll retain the
     * lock to the file as long as the process exists. */
    return REDIS_OK;
}

A
antirez 已提交
404
void clusterInit(void) {
405
    int saveconf = 0;
406

407 408
    server.cluster = zmalloc(sizeof(clusterState));
    server.cluster->myself = NULL;
409
    server.cluster->currentEpoch = 0;
410
    server.cluster->state = REDIS_CLUSTER_FAIL;
411
    server.cluster->size = 1;
412
    server.cluster->todo_before_sleep = 0;
413
    server.cluster->nodes = dictCreate(&clusterNodesDictType,NULL);
414 415
    server.cluster->nodes_black_list =
        dictCreate(&clusterNodesBlackListDictType,NULL);
416 417
    server.cluster->failover_auth_time = 0;
    server.cluster->failover_auth_count = 0;
418
    server.cluster->failover_auth_rank = 0;
419
    server.cluster->failover_auth_epoch = 0;
420
    server.cluster->cant_failover_reason = REDIS_CLUSTER_CANT_FAILOVER_NONE;
421
    server.cluster->lastVoteEpoch = 0;
422 423
    server.cluster->stats_bus_messages_sent = 0;
    server.cluster->stats_bus_messages_received = 0;
A
antirez 已提交
424 425
    memset(server.cluster->slots,0, sizeof(server.cluster->slots));
    clusterCloseAllSlots();
426 427 428 429 430 431 432

    /* Lock the cluster config file to make sure every node uses
     * its own nodes.conf. */
    if (clusterLockConfig(server.cluster_configfile) == REDIS_ERR)
        exit(1);

    /* Load or create a new nodes configuration. */
433
    if (clusterLoadConfig(server.cluster_configfile) == REDIS_ERR) {
A
antirez 已提交
434 435
        /* No configuration found. We will just use the random name provided
         * by the createClusterNode() function. */
436
        myself = server.cluster->myself =
437
            createClusterNode(NULL,REDIS_NODE_MYSELF|REDIS_NODE_MASTER);
A
antirez 已提交
438
        redisLog(REDIS_NOTICE,"No cluster configuration found, I'm %.40s",
439 440
            myself->name);
        clusterAddNode(myself);
441 442
        saveconf = 1;
    }
A
antirez 已提交
443
    if (saveconf) clusterSaveConfigOrDie(1);
444 445

    /* We need a listening TCP port for our cluster messaging needs. */
446
    server.cfd_count = 0;
447 448

    /* Port sanity check II
A
antirez 已提交
449 450
     * The other handshake port check is triggered too late to stop
     * us from trying to use a too-high cluster port number. */
451 452 453 454 455 456
    if (server.port > (65535-REDIS_CLUSTER_PORT_INCR)) {
        redisLog(REDIS_WARNING, "Redis port number too high. "
                   "Cluster communication port is 10,000 port "
                   "numbers higher than your Redis port. "
                   "Your Redis port number must be "
                   "lower than 55535.");
A
antirez 已提交
457
        exit(1);
458 459
    }

460 461 462 463
    if (listenToPort(server.port+REDIS_CLUSTER_PORT_INCR,
        server.cfd,&server.cfd_count) == REDIS_ERR)
    {
        exit(1);
464 465 466 467 468 469 470 471 472
    } 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 已提交
473
    }
474 475

    /* The slots -> keys map is a sorted set. Init it. */
476
    server.cluster->slots_to_keys = zslCreate();
A
antirez 已提交
477 478 479 480 481

    /* Set myself->port to my listening port, we'll just need to discover
     * the IP address via MEET messages. */
    myself->port = server.port;

A
antirez 已提交
482
    server.cluster->mf_end = 0;
483
    resetManualFailover();
A
antirez 已提交
484 485
}

A
antirez 已提交
486 487 488 489 490 491 492
/* Reset a node performing a soft or hard reset:
 *
 * 1) All other nodes are forget.
 * 2) All the assigned / open slots are released.
 * 3) If the node is a slave, it turns into a master.
 * 5) Only for hard reset: a new Node ID is generated.
 * 6) Only for hard reset: currentEpoch and configEpoch are set to 0.
493 494
 * 7) The new configuration is saved and the cluster state updated.
 * 8) If the node was a slave, the whole data set is flushed away. */
A
antirez 已提交
495 496 497 498 499 500 501 502 503
void clusterReset(int hard) {
    dictIterator *di;
    dictEntry *de;
    int j;

    /* Turn into master. */
    if (nodeIsSlave(myself)) {
        clusterSetNodeAsMaster(myself);
        replicationUnsetMaster();
504
        emptyDb(NULL);
A
antirez 已提交
505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530
    }

    /* Close slots, reset manual failover state. */
    clusterCloseAllSlots();
    resetManualFailover();

    /* Unassign all the slots. */
    for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) clusterDelSlot(j);

    /* Forget all the nodes, but myself. */
    di = dictGetSafeIterator(server.cluster->nodes);
    while((de = dictNext(di)) != NULL) {
        clusterNode *node = dictGetVal(de);

        if (node == myself) continue;
        clusterDelNode(node);
    }
    dictReleaseIterator(di);

    /* Hard reset only: set epochs to 0, change node ID. */
    if (hard) {
        sds oldname;

        server.cluster->currentEpoch = 0;
        server.cluster->lastVoteEpoch = 0;
        myself->configEpoch = 0;
531
        redisLog(REDIS_WARNING, "configEpoch set to 0 via CLUSTER RESET HARD");
A
antirez 已提交
532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547

        /* To change the Node ID we need to remove the old name from the
         * nodes table, change the ID, and re-add back with new name. */
        oldname = sdsnewlen(myself->name, REDIS_CLUSTER_NAMELEN);
        dictDelete(server.cluster->nodes,oldname);
        sdsfree(oldname);
        getRandomHexChars(myself->name, REDIS_CLUSTER_NAMELEN);
        clusterAddNode(myself);
    }

    /* Make sure to persist the new config and update the state. */
    clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                         CLUSTER_TODO_UPDATE_STATE|
                         CLUSTER_TODO_FSYNC_CONFIG);
}

A
antirez 已提交
548 549 550 551 552 553
/* -----------------------------------------------------------------------------
 * CLUSTER communication link
 * -------------------------------------------------------------------------- */

clusterLink *createClusterLink(clusterNode *node) {
    clusterLink *link = zmalloc(sizeof(*link));
554
    link->ctime = mstime();
A
antirez 已提交
555 556 557 558 559 560 561 562
    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.
563
 * This function will just make sure that the original node associated
A
antirez 已提交
564 565 566 567 568 569 570 571 572 573 574 575 576 577
 * 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);
}

578
#define MAX_CLUSTER_ACCEPTS_PER_CALL 1000
A
antirez 已提交
579 580
void clusterAcceptHandler(aeEventLoop *el, int fd, void *privdata, int mask) {
    int cport, cfd;
581
    int max = MAX_CLUSTER_ACCEPTS_PER_CALL;
582
    char cip[REDIS_IP_STR_LEN];
A
antirez 已提交
583 584 585 586 587
    clusterLink *link;
    REDIS_NOTUSED(el);
    REDIS_NOTUSED(mask);
    REDIS_NOTUSED(privdata);

588 589 590 591
    /* If the server is starting up, don't accept cluster connections:
     * UPDATE messages may interact with the database content. */
    if (server.masterhost == NULL && server.loading) return;

592 593 594 595 596
    while(max--) {
        cfd = anetTcpAccept(server.neterr, fd, cip, sizeof(cip), &cport);
        if (cfd == ANET_ERR) {
            if (errno != EWOULDBLOCK)
                redisLog(REDIS_VERBOSE,
597
                    "Error accepting cluster node: %s", server.neterr);
598 599 600 601 602 603 604 605 606 607 608 609 610 611 612
            return;
        }
        anetNonBlock(NULL,cfd);
        anetEnableTcpNoDelay(NULL,cfd);

        /* Use non-blocking I/O for cluster messages. */
        redisLog(REDIS_VERBOSE,"Accepted cluster node %s:%d", cip, cport);
        /* Create a link object we use to handle the connection.
         * It gets passed to the readable handler when data is available.
         * Initiallly the link->node pointer is set to NULL as we don't know
         * which node is, but the right node is references once we know the
         * node identity. */
        link = createClusterLink(NULL);
        link->fd = cfd;
        aeCreateFileEvent(server.el,cfd,AE_READABLE,clusterReadHandler,link);
A
antirez 已提交
613 614 615 616 617 618 619
    }
}

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

620
/* We have 16384 hash slots. The hash slot of a given key is obtained
621 622 623 624 625
 * 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 已提交
626
unsigned int keyHashSlot(char *key, int keylen) {
627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644
    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 已提交
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663
}

/* -----------------------------------------------------------------------------
 * 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
664
        getRandomHexChars(node->name, REDIS_CLUSTER_NAMELEN);
665
    node->ctime = mstime();
666
    node->configEpoch = 0;
A
antirez 已提交
667 668
    node->flags = flags;
    memset(node->slots,0,sizeof(node->slots));
669
    node->numslots = 0;
A
antirez 已提交
670 671 672 673
    node->numslaves = 0;
    node->slaves = NULL;
    node->slaveof = NULL;
    node->ping_sent = node->pong_received = 0;
A
antirez 已提交
674
    node->fail_time = 0;
A
antirez 已提交
675
    node->link = NULL;
676
    memset(node->ip,0,sizeof(node->ip));
677
    node->port = 0;
678
    node->fail_reports = listCreate();
679
    node->voted_time = 0;
680 681
    node->repl_offset_time = 0;
    node->repl_offset = 0;
682
    listSetFreeMethod(node->fail_reports,zfree);
A
antirez 已提交
683 684 685
    return node;
}

686 687 688 689 690
/* 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
691 692 693 694 695 696
 * '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) {
697 698 699 700 701 702 703 704 705 706 707
    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) {
708
            fr->time = mstime();
709
            return 0;
710 711 712 713 714 715
        }
    }

    /* Otherwise create a new report. */
    fr = zmalloc(sizeof(*fr));
    fr->node = sender;
716
    fr->time = mstime();
717
    listAddNodeTail(l,fr);
718
    return 1;
719 720
}

721 722 723 724 725 726 727 728 729 730
/* 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;
731
    mstime_t maxtime = server.cluster_node_timeout *
732
                     REDIS_CLUSTER_FAIL_REPORT_VALIDITY_MULT;
733
    mstime_t now = mstime();
734 735 736 737 738 739 740 741

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

742 743 744 745 746 747 748
/* 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
749 750 751 752 753
 * time.
 *
 * The function returns 1 if the failure report was found and removed.
 * Otherwise 0 is returned. */
int clusterNodeDelFailureReport(clusterNode *node, clusterNode *sender) {
754 755 756 757 758 759 760 761 762 763 764
    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;
    }
765
    if (!ln) return 0; /* No failure report from this sender. */
766 767 768

    /* Remove the failure report. */
    listDelNode(l,ln);
769
    clusterNodeCleanupFailureReports(node);
770
    return 1;
771 772
}

773 774 775 776 777 778 779 780
/* 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 已提交
781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810
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;
811
    n->slaves = NULL;
A
antirez 已提交
812 813
}

814 815 816 817 818 819 820 821
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 已提交
822 823
void freeClusterNode(clusterNode *n) {
    sds nodename;
824

A
antirez 已提交
825
    nodename = sdsnewlen(n->name, REDIS_CLUSTER_NAMELEN);
826
    redisAssert(dictDelete(server.cluster->nodes,nodename) == DICT_OK);
A
antirez 已提交
827 828 829
    sdsfree(nodename);
    if (n->slaveof) clusterNodeRemoveSlave(n->slaveof, n);
    if (n->link) freeClusterLink(n->link);
830
    listRelease(n->fail_reports);
A
antirez 已提交
831 832 833 834 835 836
    zfree(n);
}

/* Add a node to the nodes hash table */
int clusterAddNode(clusterNode *node) {
    int retval;
837

838
    retval = dictAdd(server.cluster->nodes,
A
antirez 已提交
839 840 841 842
            sdsnewlen(node->name,REDIS_CLUSTER_NAMELEN), node);
    return (retval == DICT_OK) ? REDIS_OK : REDIS_ERR;
}

A
antirez 已提交
843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864
/* 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. */
865
    di = dictGetSafeIterator(server.cluster->nodes);
A
antirez 已提交
866 867 868 869 870 871 872 873
    while((de = dictNext(di)) != NULL) {
        clusterNode *node = dictGetVal(de);

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

874 875 876 877 878
    /* 3) Remove this node from its master's slaves if needed. */
    if (nodeIsSlave(delnode) && delnode->slaveof)
        clusterNodeRemoveSlave(delnode->slaveof,delnode);

    /* 4) Free the node, unlinking it from the cluster. */
A
antirez 已提交
879 880 881
    freeClusterNode(delnode);
}

A
antirez 已提交
882 883 884
/* Node lookup by name */
clusterNode *clusterLookupNode(char *name) {
    sds s = sdsnewlen(name, REDIS_CLUSTER_NAMELEN);
A
antirez 已提交
885
    dictEntry *de;
A
antirez 已提交
886

887
    de = dictFind(server.cluster->nodes,s);
A
antirez 已提交
888 889
    sdsfree(s);
    if (de == NULL) return NULL;
890
    return dictGetVal(de);
A
antirez 已提交
891 892 893 894 895 896 897 898 899
}

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

A
antirez 已提交
901 902
    redisLog(REDIS_DEBUG,"Renaming node %.40s into %.40s",
        node->name, newname);
903
    retval = dictDelete(server.cluster->nodes, s);
A
antirez 已提交
904 905 906 907 908 909
    sdsfree(s);
    redisAssert(retval == DICT_OK);
    memcpy(node->name, newname, REDIS_CLUSTER_NAMELEN);
    clusterAddNode(node);
}

910 911 912 913 914 915 916 917 918 919 920 921 922 923
/* -----------------------------------------------------------------------------
 * 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
924
 * in the cluster without dealing with the problem of other nodes re-adding
925 926
 * back the node to nodes we already sent the FORGET command to.
 *
927
 * The data structure used is a hash table with an sds string representing
928 929 930 931 932 933 934 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
 * 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();
961 962 963 964 965 966
    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);
967
    dictSetUnsignedIntegerVal(de,time(NULL)+REDIS_CLUSTER_BLACKLIST_TTL);
968
    sdsfree(id);
969 970 971 972 973 974 975 976 977
}

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

978
    clusterBlacklistCleanup();
979 980 981 982 983
    retval = dictFind(server.cluster->nodes_black_list,id) != NULL;
    sdsfree(id);
    return retval;
}

A
antirez 已提交
984 985 986 987
/* -----------------------------------------------------------------------------
 * CLUSTER messages exchange - PING/PONG and gossip
 * -------------------------------------------------------------------------- */

988 989 990
/* This function checks if a given node should be marked as FAIL.
 * It happens if the following conditions are met:
 *
991 992 993 994
 * 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.
995 996 997
 *
 * 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.
998 999 1000 1001 1002 1003 1004 1005 1006 1007
 *
 * 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.
1008 1009 1010 1011 1012
 */
void markNodeAsFailingIfNeeded(clusterNode *node) {
    int failures;
    int needed_quorum = (server.cluster->size / 2) + 1;

1013 1014
    if (!nodeTimedOut(node)) return; /* We can reach it. */
    if (nodeFailed(node)) return; /* Already FAILing. */
1015

1016 1017
    failures = clusterNodeFailureReportsCount(node);
    /* Also count myself as a voter if I'm a master. */
1018
    if (nodeIsMaster(myself)) failures++;
1019
    if (failures < needed_quorum) return; /* No weak agreement from masters. */
1020 1021 1022 1023 1024 1025 1026

    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;
1027
    node->fail_time = mstime();
1028

1029 1030
    /* Broadcast the failing node name to everybody, forcing all the other
     * reachable nodes to flag the node as FAIL. */
1031
    if (nodeIsMaster(myself)) clusterSendFail(node->name);
A
antirez 已提交
1032
    clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
1033 1034 1035 1036
}

/* 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
1037
 * state. */
1038
void clearNodeFailureIfNeeded(clusterNode *node) {
1039
    mstime_t now = mstime();
A
antirez 已提交
1040

1041
    redisAssert(nodeFailed(node));
A
antirez 已提交
1042 1043 1044

    /* For slaves we always clear the FAIL flag if we can contact the
     * node again. */
1045
    if (nodeIsSlave(node) || node->numslots == 0) {
A
antirez 已提交
1046
        redisLog(REDIS_NOTICE,
1047
            "Clear FAIL state for node %.40s: %s is reachable again.",
1048 1049
                node->name,
                nodeIsSlave(node) ? "slave" : "master without slots");
A
antirez 已提交
1050
        node->flags &= ~REDIS_NODE_FAIL;
A
antirez 已提交
1051
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
A
antirez 已提交
1052 1053 1054
    }

    /* If it is a master and...
1055
     * 1) The FAIL state is old enough.
A
antirez 已提交
1056 1057
     * 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. */
1058
    if (nodeIsMaster(node) && node->numslots > 0 &&
1059
        (now - node->fail_time) >
1060
        (server.cluster_node_timeout * REDIS_CLUSTER_FAIL_UNDO_TIME_MULT))
A
antirez 已提交
1061
    {
1062
        redisLog(REDIS_NOTICE,
A
antirez 已提交
1063
            "Clear FAIL state for node %.40s: is reachable again and nobody is serving its slots after some time.",
1064
                node->name);
1065
        node->flags &= ~REDIS_NODE_FAIL;
A
antirez 已提交
1066
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
1067 1068 1069
    }
}

1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080
/* 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);

1081
        if (!nodeInHandshake(node)) continue;
1082 1083 1084 1085 1086 1087
        if (!strcasecmp(node->ip,ip) && node->port == port) break;
    }
    dictReleaseIterator(di);
    return de != NULL;
}

1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121
/* 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. */
1122
    memset(norm_ip,0,REDIS_IP_STR_LEN);
1123 1124 1125
    if (sa.ss_family == AF_INET)
        inet_ntop(AF_INET,
            (void*)&(((struct sockaddr_in *)&sa)->sin_addr),
1126
            norm_ip,REDIS_IP_STR_LEN);
1127 1128 1129
    else
        inet_ntop(AF_INET6,
            (void*)&(((struct sockaddr_in6 *)&sa)->sin6_addr),
1130
            norm_ip,REDIS_IP_STR_LEN);
1131 1132 1133 1134 1135 1136 1137 1138

    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
M
Matt Stancliff 已提交
1139
     * handshake. */
1140 1141 1142 1143 1144 1145 1146
    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 已提交
1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158
/* 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--) {
        uint16_t flags = ntohs(g->flags);
        clusterNode *node;
1159
        sds ci;
A
antirez 已提交
1160

1161
        ci = representRedisNodeFlags(sdsempty(), flags);
A
antirez 已提交
1162 1163 1164 1165 1166 1167 1168 1169 1170
        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);
1171
        if (node) {
1172 1173
            /* We already know this node.
               Handle failure reports, only when the sender is a master. */
1174
            if (sender && nodeIsMaster(sender) && node != myself) {
1175 1176
                if (flags & (REDIS_NODE_FAIL|REDIS_NODE_PFAIL)) {
                    if (clusterNodeAddFailureReport(node,sender)) {
1177
                        redisLog(REDIS_VERBOSE,
1178 1179 1180 1181 1182 1183
                            "Node %.40s reported node %.40s as not reachable.",
                            sender->name, node->name);
                    }
                    markNodeAsFailingIfNeeded(node);
                } else {
                    if (clusterNodeDelFailureReport(node,sender)) {
1184
                        redisLog(REDIS_VERBOSE,
1185 1186 1187 1188
                            "Node %.40s reported node %.40s is back online.",
                            sender->name, node->name);
                    }
                }
A
antirez 已提交
1189
            }
1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200

            /* 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 已提交
1201 1202
        } else {
            /* If it's not in NOADDR state and we don't have it, we
1203
             * start a handshake process against this IP/PORT pairs.
A
antirez 已提交
1204 1205 1206 1207
             *
             * 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. */
1208 1209 1210 1211
            if (sender &&
                !(flags & REDIS_NODE_NOADDR) &&
                !clusterBlacklistExists(g->nodename))
            {
1212
                clusterStartHandshake(g->ip,ntohs(g->port));
1213
            }
A
antirez 已提交
1214 1215 1216 1217 1218 1219 1220
        }

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

1221
/* IP -> string conversion. 'buf' is supposed to at least be 46 bytes. */
A
antirez 已提交
1222
void nodeIp2String(char *buf, clusterLink *link) {
1223
    anetPeerToString(link->fd, buf, REDIS_IP_STR_LEN, NULL);
A
antirez 已提交
1224 1225 1226
}

/* Update the node address to the IP address that can be extracted
A
antirez 已提交
1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253
 * 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);
1254
    node->flags &= ~REDIS_NODE_NOADDR;
A
antirez 已提交
1255 1256
    redisLog(REDIS_WARNING,"Address updated for node %.40s, now %s:%d",
        node->name, node->ip, node->port);
1257 1258 1259

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

1265 1266 1267 1268
/* 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) {
1269
    if (nodeIsMaster(n)) return;
1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289

    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.
M
Matt Stancliff 已提交
1290
 * Sometimes it is not actually the "Sender" of the information, like in the case
1291
 * we receive the info via an UPDATE packet. */
1292
void clusterUpdateSlotsConfigWith(clusterNode *sender, uint64_t senderConfigEpoch, unsigned char *slots) {
1293 1294
    int j;
    clusterNode *curmaster, *newmaster = NULL;
1295 1296 1297 1298 1299 1300 1301 1302 1303
    /* The dirty slots list is a list of slots for which we lose the ownership
     * while having still keys inside. This usually happens after a failover
     * or after a manual cluster reconfiguration operated by the admin.
     *
     * If the update message is not able to demote a master to slave (in this
     * case we'll resync with the master updating the whole key space), we
     * need to delete all the keys in the slots we lost ownership. */
    uint16_t dirty_slots[REDIS_CLUSTER_SLOTS];
    int dirty_slots_count = 0;
1304 1305 1306 1307

    /* 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. */
1308
    curmaster = nodeIsMaster(myself) ? myself : myself->slaveof;
1309

1310 1311 1312 1313 1314
    if (sender == myself) {
        redisLog(REDIS_WARNING,"Discarding UPDATE message about myself.");
        return;
    }

1315 1316
    for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
        if (bitmapTestBit(slots,j)) {
1317 1318 1319 1320 1321 1322 1323 1324 1325
            /* The slot is already bound to the sender of this message. */
            if (server.cluster->slots[j] == sender) continue;

            /* The slot is in importing state, it should be modified only
             * manually via redis-trib (example: a resharding is in progress
             * and the migrating side slot was already closed and is advertising
             * a new config. We still want the slot to be closed manually). */
            if (server.cluster->importing_slots_from[j]) continue;

1326
            /* We rebind the slot to the new node claiming it if:
1327 1328 1329
             * 1) The slot was unassigned or the new node claims it with a
             *    greater configEpoch.
             * 2) We are not currently importing the slot. */
1330
            if (server.cluster->slots[j] == NULL ||
1331
                server.cluster->slots[j]->configEpoch < senderConfigEpoch)
1332
            {
1333 1334
                /* Was this slot mine, and still contains keys? Mark it as
                 * a dirty slot. */
1335 1336 1337 1338
                if (server.cluster->slots[j] == myself &&
                    countKeysInSlot(j) &&
                    sender != myself)
                {
1339 1340
                    dirty_slots[dirty_slots_count] = j;
                    dirty_slots_count++;
1341 1342
                }

1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361
                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) {
A
antirez 已提交
1362 1363 1364
        redisLog(REDIS_WARNING,
            "Configuration change detected. Reconfiguring myself "
            "as a replica of %.40s", sender->name);
1365 1366 1367 1368
        clusterSetMaster(sender);
        clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                             CLUSTER_TODO_UPDATE_STATE|
                             CLUSTER_TODO_FSYNC_CONFIG);
1369 1370 1371 1372 1373 1374 1375 1376 1377 1378
    } else if (dirty_slots_count) {
        /* If we are here, we received an update message which removed
         * ownership for certain slots we still have keys about, but still
         * we are serving some slots, so this master node was not demoted to
         * a slave.
         *
         * In order to maintain a consistent state between keys and slots
         * we need to remove all the keys from the slots we lost. */
        for (j = 0; j < dirty_slots_count; j++)
            delKeysInSlot(dirty_slots[j]);
1379 1380 1381
    }
}

1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434
/* This function is called when this node is a master, and we receive from
 * another master a configuration epoch that is equal to our configuration
 * epoch.
 *
 * BACKGROUND
 *
 * It is not possible that different slaves get the same config
 * epoch during a failover election, because the slaves need to get voted
 * by a majority. However when we perform a manual resharding of the cluster
 * the node will assign a configuration epoch to itself without to ask
 * for agreement. Usually resharding happens when the cluster is working well
 * and is supervised by the sysadmin, however it is possible for a failover
 * to happen exactly while the node we are resharding a slot to assigns itself
 * a new configuration epoch, but before it is able to propagate it.
 *
 * So technically it is possible in this condition that two nodes end with
 * the same configuration epoch.
 *
 * Another possibility is that there are bugs in the implementation causing
 * this to happen.
 *
 * Moreover when a new cluster is created, all the nodes start with the same
 * configEpoch. This collision resolution code allows nodes to automatically
 * end with a different configEpoch at startup automatically.
 *
 * In all the cases, we want a mechanism that resolves this issue automatically
 * as a safeguard. The same configuration epoch for masters serving different
 * set of slots is not harmful, but it is if the nodes end serving the same
 * slots for some reason (manual errors or software bugs) without a proper
 * failover procedure.
 *
 * In general we want a system that eventually always ends with different
 * masters having different configuration epochs whatever happened, since
 * nothign is worse than a split-brain condition in a distributed system.
 *
 * BEHAVIOR
 *
 * When this function gets called, what happens is that if this node
 * has the lexicographically smaller Node ID compared to the other node
 * with the conflicting epoch (the 'sender' node), it will assign itself
 * the greatest configuration epoch currently detected among nodes plus 1.
 *
 * This means that even if there are multiple nodes colliding, the node
 * with the greatest Node ID never moves forward, so eventually all the nodes
 * end with a different configuration epoch.
 */
void clusterHandleConfigEpochCollision(clusterNode *sender) {
    /* Prerequisites: nodes have the same configEpoch and are both masters. */
    if (sender->configEpoch != myself->configEpoch ||
        !nodeIsMaster(sender) || !nodeIsMaster(myself)) return;
    /* Don't act if the colliding node has a smaller Node ID. */
    if (memcmp(sender->name,myself->name,REDIS_CLUSTER_NAMELEN) <= 0) return;
    /* Get the next ID available at the best of this node knowledge. */
1435 1436
    server.cluster->currentEpoch++;
    myself->configEpoch = server.cluster->currentEpoch;
1437 1438 1439
    clusterSaveConfigOrDie(1);
    redisLog(REDIS_VERBOSE,
        "WARNING: configEpoch collision with node %.40s."
1440
        " configEpoch set to %llu",
1441 1442 1443 1444
        sender->name,
        (unsigned long long) myself->configEpoch);
}

A
antirez 已提交
1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457
/* 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 已提交
1458
    uint16_t flags = ntohs(hdr->flags);
1459
    uint64_t senderCurrentEpoch = 0, senderConfigEpoch = 0;
A
antirez 已提交
1460 1461
    clusterNode *sender;

1462
    server.cluster->stats_bus_messages_received++;
1463 1464
    redisLog(REDIS_DEBUG,"--- Processing packet of type %d, %lu bytes",
        type, (unsigned long) totlen);
1465 1466

    /* Perform sanity checks */
1467
    if (totlen < 16) return 1; /* At least signature, version, totlen, count. */
1468 1469
    if (ntohs(hdr->ver) != CLUSTER_PROTO_VER)
        return 1; /* Can't handle versions other than the current one.*/
A
antirez 已提交
1470 1471 1472 1473 1474 1475 1476 1477 1478 1479
    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;
1480
    } else if (type == CLUSTERMSG_TYPE_FAIL) {
A
antirez 已提交
1481 1482 1483 1484
        uint32_t explen = sizeof(clusterMsg)-sizeof(union clusterMsgData);

        explen += sizeof(clusterMsgDataFail);
        if (totlen != explen) return 1;
1485
    } else if (type == CLUSTERMSG_TYPE_PUBLISH) {
1486 1487
        uint32_t explen = sizeof(clusterMsg)-sizeof(union clusterMsgData);

1488 1489
        explen += sizeof(clusterMsgDataPublish) -
                8 +
1490 1491 1492
                ntohl(hdr->data.publish.msg.channel_len) +
                ntohl(hdr->data.publish.msg.message_len);
        if (totlen != explen) return 1;
1493
    } else if (type == CLUSTERMSG_TYPE_FAILOVER_AUTH_REQUEST ||
1494 1495 1496
               type == CLUSTERMSG_TYPE_FAILOVER_AUTH_ACK ||
               type == CLUSTERMSG_TYPE_MFSTART)
    {
1497 1498
        uint32_t explen = sizeof(clusterMsg)-sizeof(union clusterMsgData);

1499 1500 1501 1502 1503
        if (totlen != explen) return 1;
    } else if (type == CLUSTERMSG_TYPE_UPDATE) {
        uint32_t explen = sizeof(clusterMsg)-sizeof(union clusterMsgData);

        explen += sizeof(clusterMsgDataUpdate);
1504
        if (totlen != explen) return 1;
1505
    }
A
antirez 已提交
1506

1507
    /* Check if the sender is a known node. */
A
antirez 已提交
1508
    sender = clusterLookupNode(hdr->sender);
1509
    if (sender && !nodeInHandshake(sender)) {
1510
        /* Update our curretEpoch if we see a newer epoch in the cluster. */
1511 1512 1513 1514
        senderCurrentEpoch = ntohu64(hdr->currentEpoch);
        senderConfigEpoch = ntohu64(hdr->configEpoch);
        if (senderCurrentEpoch > server.cluster->currentEpoch)
            server.cluster->currentEpoch = senderCurrentEpoch;
1515
        /* Update the sender configEpoch if it is publishing a newer one. */
1516
        if (senderConfigEpoch > sender->configEpoch) {
1517
            sender->configEpoch = senderConfigEpoch;
A
antirez 已提交
1518 1519
            clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                                 CLUSTER_TODO_FSYNC_CONFIG);
1520
        }
1521 1522 1523
        /* Update the replication offset info for this node. */
        sender->repl_offset = ntohu64(hdr->offset);
        sender->repl_offset_time = mstime();
1524 1525 1526 1527 1528 1529 1530 1531 1532
        /* 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;
A
antirez 已提交
1533 1534 1535 1536
            redisLog(REDIS_WARNING,
                "Received replication offset for paused "
                "master manual failover: %lld",
                server.cluster->mf_master_offset);
1537
        }
1538
    }
1539

1540
    /* Initial processing of PING and MEET requests replying with a PONG. */
A
antirez 已提交
1541
    if (type == CLUSTERMSG_TYPE_PING || type == CLUSTERMSG_TYPE_MEET) {
1542
        redisLog(REDIS_DEBUG,"Ping packet received: %p", (void*)link->node);
A
antirez 已提交
1543

A
antirez 已提交
1544 1545 1546 1547 1548 1549
        /* We use incoming MEET messages in order to set the address
         * for 'myself', since only other cluster nodes will send us
         * MEET messagses on handshakes, when the cluster joins, or
         * later if we changed address, and those nodes will use our
         * official address to connect to us. So by obtaining this address
         * from the socket is a simple way to discover / update our own
1550 1551 1552 1553 1554 1555
         * address in the cluster without it being hardcoded in the config.
         *
         * However if we don't have an address at all, we update the address
         * even with a normal PING packet. If it's wrong it will be fixed
         * by MEET later. */
        if (type == CLUSTERMSG_TYPE_MEET || myself->ip[0] == '\0') {
A
antirez 已提交
1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567
            char ip[REDIS_IP_STR_LEN];

            if (anetSockName(link->fd,ip,sizeof(ip),NULL) != -1 &&
                strcmp(ip,myself->ip))
            {
                memcpy(myself->ip,ip,REDIS_IP_STR_LEN);
                redisLog(REDIS_WARNING,"IP address for this node updated to %s",
                    myself->ip);
                clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG);
            }
        }

A
antirez 已提交
1568 1569 1570
        /* 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
1571
         * resolved when we'll receive PONGs from the node. */
A
antirez 已提交
1572 1573 1574 1575 1576 1577 1578
        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 已提交
1579
            clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG);
A
antirez 已提交
1580 1581
        }

1582 1583 1584 1585 1586
        /* If this is a MEET packet from an unknown node, we still process
         * the gossip section here since we have to trust the sender because
         * of the message type. */
        if (!sender && type == CLUSTERMSG_TYPE_MEET)
            clusterProcessGossipSection(hdr,link);
A
antirez 已提交
1587 1588 1589

        /* Anyway reply with a PONG */
        clusterSendPing(link,CLUSTERMSG_TYPE_PONG);
1590 1591
    }

1592
    /* PING, PONG, MEET: process config information. */
1593 1594 1595
    if (type == CLUSTERMSG_TYPE_PING || type == CLUSTERMSG_TYPE_PONG ||
        type == CLUSTERMSG_TYPE_MEET)
    {
1596 1597 1598
        redisLog(REDIS_DEBUG,"%s packet received: %p",
            type == CLUSTERMSG_TYPE_PING ? "ping" : "pong",
            (void*)link->node);
A
antirez 已提交
1599
        if (link->node) {
1600
            if (nodeInHandshake(link->node)) {
A
antirez 已提交
1601 1602 1603
                /* If we already have this node, try to change the
                 * IP/port of the node with the new one. */
                if (sender) {
1604
                    redisLog(REDIS_VERBOSE,
A
antirez 已提交
1605 1606
                        "Handshake: we already know node %.40s, "
                        "updating the address if needed.", sender->name);
A
antirez 已提交
1607 1608
                    if (nodeUpdateAddressIfNeeded(sender,link,ntohs(hdr->port)))
                    {
A
antirez 已提交
1609 1610
                        clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                                             CLUSTER_TODO_UPDATE_STATE);
A
antirez 已提交
1611
                    }
M
Matt Stancliff 已提交
1612
                    /* Free this node as we already have it. This will
A
antirez 已提交
1613 1614
                     * cause the link to be freed as well. */
                    freeClusterNode(link->node);
A
antirez 已提交
1615 1616 1617 1618
                    return 0;
                }

                /* First thing to do is replacing the random name with the
1619
                 * right node name if this was a handshake stage. */
A
antirez 已提交
1620 1621 1622 1623
                clusterRenameNode(link->node, hdr->sender);
                redisLog(REDIS_DEBUG,"Handshake with node %.40s completed.",
                    link->node->name);
                link->node->flags &= ~REDIS_NODE_HANDSHAKE;
1624
                link->node->flags |= flags&(REDIS_NODE_MASTER|REDIS_NODE_SLAVE);
A
antirez 已提交
1625
                clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG);
A
antirez 已提交
1626 1627 1628 1629 1630 1631 1632 1633
            } 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;
1634 1635
                link->node->ip[0] = '\0';
                link->node->port = 0;
A
antirez 已提交
1636
                freeClusterLink(link);
A
antirez 已提交
1637
                clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG);
A
antirez 已提交
1638 1639 1640
                return 0;
            }
        }
1641

A
antirez 已提交
1642 1643
        /* Update the node address if it changed. */
        if (sender && type == CLUSTERMSG_TYPE_PING &&
1644
            !nodeInHandshake(sender) &&
A
antirez 已提交
1645 1646
            nodeUpdateAddressIfNeeded(sender,link,ntohs(hdr->port)))
        {
A
antirez 已提交
1647 1648
            clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                                 CLUSTER_TODO_UPDATE_STATE);
A
antirez 已提交
1649 1650
        }

A
antirez 已提交
1651
        /* Update our info about the node */
1652
        if (link->node && type == CLUSTERMSG_TYPE_PONG) {
1653
            link->node->pong_received = mstime();
1654 1655 1656
            link->node->ping_sent = 0;

            /* The PFAIL condition can be reversed without external
1657
             * help if it is momentary (that is, if it does not
1658 1659 1660 1661
             * turn into a FAIL state).
             *
             * The FAIL condition is also reversible under specific
             * conditions detected by clearNodeFailureIfNeeded(). */
1662
            if (nodeTimedOut(link->node)) {
1663
                link->node->flags &= ~REDIS_NODE_PFAIL;
A
antirez 已提交
1664 1665
                clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                                     CLUSTER_TODO_UPDATE_STATE);
1666
            } else if (nodeFailed(link->node)) {
1667 1668 1669
                clearNodeFailureIfNeeded(link->node);
            }
        }
A
antirez 已提交
1670

1671
        /* Check for role switch: slave -> master or master -> slave. */
A
antirez 已提交
1672 1673 1674 1675
        if (sender) {
            if (!memcmp(hdr->slaveof,REDIS_NODE_NULL_NAME,
                sizeof(hdr->slaveof)))
            {
1676
                /* Node is a master. */
1677
                clusterSetNodeAsMaster(sender);
A
antirez 已提交
1678
            } else {
1679
                /* Node is a slave. */
A
antirez 已提交
1680 1681
                clusterNode *master = clusterLookupNode(hdr->slaveof);

1682
                if (nodeIsMaster(sender)) {
1683
                    /* Master turned into a slave! Reconfigure the node. */
1684
                    clusterDelNodeSlots(sender);
1685 1686
                    sender->flags &= ~REDIS_NODE_MASTER;
                    sender->flags |= REDIS_NODE_SLAVE;
1687

1688 1689
                    /* Remove the list of slaves from the node. */
                    if (sender->numslaves) clusterNodeResetSlaves(sender);
1690 1691

                    /* Update config and state. */
A
antirez 已提交
1692 1693
                    clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                                         CLUSTER_TODO_UPDATE_STATE);
1694 1695
                }

1696
                /* Master node changed for this slave? */
1697
                if (master && sender->slaveof != master) {
1698 1699
                    if (sender->slaveof)
                        clusterNodeRemoveSlave(sender->slaveof,sender);
1700 1701
                    clusterNodeAddSlave(master,sender);
                    sender->slaveof = master;
1702 1703

                    /* Update config. */
A
antirez 已提交
1704
                    clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG);
1705
                }
A
antirez 已提交
1706 1707 1708
            }
        }

1709
        /* Update our info about served slots.
1710
         *
1711 1712
         * Note: this MUST happen after we update the master/slave state
         * so that REDIS_NODE_MASTER flag will be set. */
1713 1714

        /* Many checks are only needed if the set of served slots this
1715 1716 1717 1718
         * 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. */
1719 1720 1721
        int dirty_slots = 0; /* Sender claimed slots don't match my view? */

        if (sender) {
1722
            sender_master = nodeIsMaster(sender) ? sender : sender->slaveof;
1723 1724 1725 1726 1727 1728
            if (sender_master) {
                dirty_slots = memcmp(sender_master->slots,
                        hdr->myslots,sizeof(hdr->myslots)) != 0;
            }
        }

1729 1730 1731
        /* 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. */
1732
        if (sender && nodeIsMaster(sender) && dirty_slots)
1733
            clusterUpdateSlotsConfigWith(sender,senderConfigEpoch,hdr->myslots);
1734

1735 1736 1737
        /* 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.
1738
         *
1739 1740 1741 1742
         * 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:
1743 1744 1745 1746 1747 1748
         *
         * 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
1749 1750 1751 1752
         * 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). */
1753 1754 1755 1756 1757 1758 1759 1760 1761 1762
        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)
                    {
1763
                        redisLog(REDIS_VERBOSE,
1764
                            "Node %.40s has old slots configuration, sending "
1765
                            "an UPDATE message about %.40s",
1766
                                sender->name, server.cluster->slots[j]->name);
A
antirez 已提交
1767 1768
                        clusterSendUpdate(sender->link,
                            server.cluster->slots[j]);
1769 1770 1771 1772 1773

                        /* TODO: instead of exiting the loop send every other
                         * UPDATE packet for other nodes that are the new owner
                         * of sender's slots. */
                        break;
1774
                    }
1775
                }
A
antirez 已提交
1776 1777 1778
            }
        }

1779 1780 1781 1782 1783 1784 1785 1786 1787
        /* If our config epoch collides with the sender's try to fix
         * the problem. */
        if (sender &&
            nodeIsMaster(myself) && nodeIsMaster(sender) &&
            senderConfigEpoch == myself->configEpoch)
        {
            clusterHandleConfigEpochCollision(sender);
        }

A
antirez 已提交
1788
        /* Get info from the gossip section */
1789
        if (sender) clusterProcessGossipSection(hdr,link);
1790
    } else if (type == CLUSTERMSG_TYPE_FAIL) {
A
antirez 已提交
1791 1792
        clusterNode *failing;

1793 1794
        if (sender) {
            failing = clusterLookupNode(hdr->data.fail.about.nodename);
1795 1796
            if (failing &&
                !(failing->flags & (REDIS_NODE_FAIL|REDIS_NODE_MYSELF)))
1797 1798 1799 1800 1801
            {
                redisLog(REDIS_NOTICE,
                    "FAIL message received from %.40s about %.40s",
                    hdr->sender, hdr->data.fail.about.nodename);
                failing->flags |= REDIS_NODE_FAIL;
1802
                failing->fail_time = mstime();
1803
                failing->flags &= ~REDIS_NODE_PFAIL;
A
antirez 已提交
1804 1805
                clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                                     CLUSTER_TODO_UPDATE_STATE);
1806 1807
            }
        } else {
A
antirez 已提交
1808
            redisLog(REDIS_NOTICE,
M
Matt Stancliff 已提交
1809
                "Ignoring FAIL message from unknown node %.40s about %.40s",
A
antirez 已提交
1810 1811
                hdr->sender, hdr->data.fail.about.nodename);
        }
1812 1813 1814 1815
    } else if (type == CLUSTERMSG_TYPE_PUBLISH) {
        robj *channel, *message;
        uint32_t channel_len, message_len;

A
antirez 已提交
1816 1817
        /* Don't bother creating useless objects if there are no
         * Pub/Sub subscribers. */
1818 1819 1820
        if (dictSize(server.pubsub_channels) ||
           listLength(server.pubsub_patterns))
        {
1821 1822 1823 1824 1825
            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(
1826 1827
                        (char*)hdr->data.publish.msg.bulk_data+channel_len,
                        message_len);
1828 1829 1830 1831
            pubsubPublishMessage(channel,message);
            decrRefCount(channel);
            decrRefCount(message);
        }
1832
    } else if (type == CLUSTERMSG_TYPE_FAILOVER_AUTH_REQUEST) {
A
antirez 已提交
1833
        if (!sender) return 1;  /* We don't know that node. */
1834
        clusterSendFailoverAuthIfNeeded(sender,hdr);
1835
    } else if (type == CLUSTERMSG_TYPE_FAILOVER_AUTH_ACK) {
A
antirez 已提交
1836
        if (!sender) return 1;  /* We don't know that node. */
1837
        /* We consider this vote only if the sender is a master serving
1838 1839
         * a non zero number of slots, and its currentEpoch is greater or
         * equal to epoch where this node started the election. */
1840
        if (nodeIsMaster(sender) && sender->numslots > 0 &&
1841
            senderCurrentEpoch >= server.cluster->failover_auth_epoch)
1842
        {
1843
            server.cluster->failover_auth_count++;
1844 1845
            /* Maybe we reached a quorum here, set a flag to make sure
             * we check ASAP. */
A
antirez 已提交
1846
            clusterDoBeforeSleep(CLUSTER_TODO_HANDLE_FAILOVER);
1847
        }
1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859
    } 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);
1860 1861
    } else if (type == CLUSTERMSG_TYPE_UPDATE) {
        clusterNode *n; /* The node the update is about. */
A
antirez 已提交
1862 1863
        uint64_t reportedConfigEpoch =
                    ntohu64(hdr->data.update.nodecfg.configEpoch);
1864 1865 1866 1867 1868 1869 1870

        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. */
1871
        if (nodeIsSlave(n)) clusterSetNodeAsMaster(n);
1872

1873 1874
        /* Update the node's configEpoch. */
        n->configEpoch = reportedConfigEpoch;
A
antirez 已提交
1875 1876
        clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                             CLUSTER_TODO_FSYNC_CONFIG);
1877

M
Matt Stancliff 已提交
1878
        /* Check the bitmap of served slots and update our
1879
         * config accordingly. */
1880 1881
        clusterUpdateSlotsConfigWith(n,reportedConfigEpoch,
            hdr->data.update.nodecfg.slots);
A
antirez 已提交
1882
    } else {
1883
        redisLog(REDIS_WARNING,"Received unknown packet type: %d", type);
A
antirez 已提交
1884 1885 1886 1887 1888 1889 1890
    }
    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.
1891

A
antirez 已提交
1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908
   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) {
1909
        redisLog(REDIS_DEBUG,"I/O error writing to node link: %s",
A
antirez 已提交
1910 1911 1912 1913
            strerror(errno));
        handleLinkIOError(link);
        return;
    }
1914
    sdsrange(link->sndbuf,nwritten,-1);
A
antirez 已提交
1915 1916 1917 1918 1919 1920 1921 1922
    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) {
1923
    char buf[sizeof(clusterMsg)];
A
antirez 已提交
1924 1925 1926
    ssize_t nread;
    clusterMsg *hdr;
    clusterLink *link = (clusterLink*) privdata;
1927
    unsigned int readlen, rcvbuflen;
A
antirez 已提交
1928 1929 1930
    REDIS_NOTUSED(el);
    REDIS_NOTUSED(mask);

1931 1932
    while(1) { /* Read as long as there is data to read. */
        rcvbuflen = sdslen(link->rcvbuf);
1933 1934
        if (rcvbuflen < 8) {
            /* First, obtain the first 8 bytes to get the full message
1935
             * length. */
1936
            readlen = 8 - rcvbuflen;
1937 1938 1939
        } else {
            /* Finally read the full message. */
            hdr = (clusterMsg*) link->rcvbuf;
1940 1941 1942 1943 1944 1945
            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)
                {
1946
                    redisLog(REDIS_WARNING,
1947 1948
                        "Bad message length or signature received "
                        "from Cluster bus.");
1949 1950 1951
                    handleLinkIOError(link);
                    return;
                }
1952
            }
1953 1954
            readlen = ntohl(hdr->totlen) - rcvbuflen;
            if (readlen > sizeof(buf)) readlen = sizeof(buf);
1955
        }
A
antirez 已提交
1956

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

1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971
        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 已提交
1972

1973
        /* Total length obtained? Process this packet. */
1974
        if (rcvbuflen >= 8 && rcvbuflen == ntohl(hdr->totlen)) {
1975 1976 1977 1978 1979 1980
            if (clusterProcessPacket(link)) {
                sdsfree(link->rcvbuf);
                link->rcvbuf = sdsempty();
            } else {
                return; /* Link no longer valid. */
            }
A
antirez 已提交
1981 1982 1983 1984
        }
    }
}

1985 1986 1987 1988 1989
/* 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 已提交
1990 1991 1992 1993 1994 1995
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);
1996
    server.cluster->stats_bus_messages_sent++;
A
antirez 已提交
1997 1998
}

1999
/* Send a message to all the nodes that are part of the cluster having
2000
 * a connected link.
2001
 *
2002 2003 2004
 * 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. */
2005 2006 2007 2008
void clusterBroadcastMessage(void *buf, size_t len) {
    dictIterator *di;
    dictEntry *de;

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

        if (!node->link) continue;
2014 2015
        if (node->flags & (REDIS_NODE_MYSELF|REDIS_NODE_HANDSHAKE))
            continue;
2016 2017 2018 2019 2020
        clusterSendMessage(node->link,buf,len);
    }
    dictReleaseIterator(di);
}

A
antirez 已提交
2021 2022
/* Build the message header */
void clusterBuildMessageHdr(clusterMsg *hdr, int type) {
2023
    int totlen = 0;
2024
    uint64_t offset;
2025
    clusterNode *master;
2026 2027 2028 2029 2030

    /* 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. */
2031
    master = (nodeIsSlave(myself) && myself->slaveof) ?
2032
              myself->slaveof : myself;
A
antirez 已提交
2033 2034

    memset(hdr,0,sizeof(*hdr));
2035
    hdr->ver = htons(CLUSTER_PROTO_VER);
2036 2037
    hdr->sig[0] = 'R';
    hdr->sig[1] = 'C';
2038
    hdr->sig[2] = 'm';
2039
    hdr->sig[3] = 'b';
A
antirez 已提交
2040
    hdr->type = htons(type);
2041
    memcpy(hdr->sender,myself->name,REDIS_CLUSTER_NAMELEN);
2042 2043

    memcpy(hdr->myslots,master->slots,sizeof(hdr->myslots));
A
antirez 已提交
2044
    memset(hdr->slaveof,0,REDIS_CLUSTER_NAMELEN);
2045 2046
    if (myself->slaveof != NULL)
        memcpy(hdr->slaveof,myself->slaveof->name, REDIS_CLUSTER_NAMELEN);
A
antirez 已提交
2047
    hdr->port = htons(server.port);
2048
    hdr->flags = htons(myself->flags);
2049
    hdr->state = server.cluster->state;
A
antirez 已提交
2050

2051
    /* Set the currentEpoch and configEpochs. */
2052
    hdr->currentEpoch = htonu64(server.cluster->currentEpoch);
2053
    hdr->configEpoch = htonu64(master->configEpoch);
2054

2055
    /* Set the replication offset. */
2056 2057 2058
    if (nodeIsSlave(myself))
        offset = replicationGetSlaveOffset();
    else
2059 2060 2061
        offset = server.master_repl_offset;
    hdr->offset = htonu64(offset);

2062 2063 2064 2065
    /* Set the message flags. */
    if (nodeIsMaster(myself) && server.cluster->mf_end)
        hdr->mflags[0] |= CLUSTERMSG_FLAG0_PAUSED;

2066 2067
    /* Compute the message length for certain messages. For other messages
     * this is up to the caller. */
A
antirez 已提交
2068 2069 2070
    if (type == CLUSTERMSG_TYPE_FAIL) {
        totlen = sizeof(clusterMsg)-sizeof(union clusterMsgData);
        totlen += sizeof(clusterMsgDataFail);
2071 2072 2073
    } else if (type == CLUSTERMSG_TYPE_UPDATE) {
        totlen = sizeof(clusterMsg)-sizeof(union clusterMsgData);
        totlen += sizeof(clusterMsgDataUpdate);
A
antirez 已提交
2074 2075
    }
    hdr->totlen = htonl(totlen);
2076
    /* For PING, PONG, and MEET, fixing the totlen field is up to the caller. */
A
antirez 已提交
2077 2078 2079 2080 2081
}

/* Send a PING or PONG packet to the specified node, making sure to add enough
 * gossip informations. */
void clusterSendPing(clusterLink *link, int type) {
2082
    unsigned char buf[sizeof(clusterMsg)+sizeof(clusterMsgDataGossip)*3];
A
antirez 已提交
2083 2084 2085 2086 2087 2088 2089 2090
    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. */
2091
    int freshnodes = dictSize(server.cluster->nodes)-2;
A
antirez 已提交
2092 2093

    if (link->node && type == CLUSTERMSG_TYPE_PING)
2094
        link->node->ping_sent = mstime();
A
antirez 已提交
2095
    clusterBuildMessageHdr(hdr,type);
2096

A
antirez 已提交
2097 2098
    /* Populate the gossip fields */
    while(freshnodes > 0 && gossipcount < 3) {
A
antirez 已提交
2099
        dictEntry *de = dictGetRandomKey(server.cluster->nodes);
2100
        clusterNode *this = dictGetVal(de);
A
antirez 已提交
2101 2102 2103
        clusterMsgDataGossip *gossip;
        int j;

2104 2105 2106 2107 2108 2109
        /* 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.
         */
2110
        if (this == myself ||
2111
            this->flags & (REDIS_NODE_HANDSHAKE|REDIS_NODE_NOADDR) ||
2112
            (this->link == NULL && this->numslots == 0))
2113
        {
A
antirez 已提交
2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142
                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);
}

2143 2144
/* Send a PONG packet to every connected node that's not in handshake state
 * and for which we have a valid link.
2145
 *
2146 2147
 * In Redis Cluster pongs are not used just for failure detection, but also
 * to carry important configuration information. So broadcasting a pong is
2148
 * useful when something changes in the configuration and we want to make
2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159
 * 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) {
2160 2161 2162
    dictIterator *di;
    dictEntry *de;

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

2167
        if (!node->link) continue;
2168
        if (node == myself || nodeInHandshake(node)) continue;
2169 2170
        if (target == CLUSTER_BROADCAST_LOCAL_SLAVES) {
            int local_slave =
2171
                nodeIsSlave(node) && node->slaveof &&
2172 2173 2174
                (node->slaveof == myself || node->slaveof == myself->slaveof);
            if (!local_slave) continue;
        }
2175 2176 2177 2178 2179
        clusterSendPing(node->link,CLUSTERMSG_TYPE_PONG);
    }
    dictReleaseIterator(di);
}

2180 2181 2182 2183
/* 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) {
2184
    unsigned char buf[sizeof(clusterMsg)], *payload;
2185 2186 2187
    clusterMsg *hdr = (clusterMsg*) buf;
    uint32_t totlen;
    uint32_t channel_len, message_len;
A
antirez 已提交
2188

2189 2190 2191 2192
    channel = getDecodedObject(channel);
    message = getDecodedObject(message);
    channel_len = sdslen(channel->ptr);
    message_len = sdslen(message->ptr);
A
antirez 已提交
2193

2194 2195
    clusterBuildMessageHdr(hdr,CLUSTERMSG_TYPE_PUBLISH);
    totlen = sizeof(clusterMsg)-sizeof(union clusterMsgData);
2196
    totlen += sizeof(clusterMsgDataPublish) - 8 + channel_len + message_len;
2197 2198 2199 2200 2201 2202 2203 2204 2205 2206

    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);
2207
        memcpy(payload,hdr,sizeof(*hdr));
2208
        hdr = (clusterMsg*) payload;
A
antirez 已提交
2209
    }
2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221
    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 已提交
2222 2223 2224 2225 2226 2227 2228 2229
}

/* 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) {
2230
    unsigned char buf[sizeof(clusterMsg)];
A
antirez 已提交
2231 2232 2233 2234 2235 2236 2237
    clusterMsg *hdr = (clusterMsg*) buf;

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

2238 2239 2240 2241
/* 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) {
2242
    unsigned char buf[sizeof(clusterMsg)];
2243 2244
    clusterMsg *hdr = (clusterMsg*) buf;

2245
    if (link == NULL) return;
2246 2247 2248 2249 2250 2251 2252
    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));
}

2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263
/* -----------------------------------------------------------------------------
 * 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);
}

2264 2265 2266 2267
/* -----------------------------------------------------------------------------
 * SLAVE node specific functions
 * -------------------------------------------------------------------------- */

2268 2269 2270 2271 2272 2273 2274
/* 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) {
2275
    unsigned char buf[sizeof(clusterMsg)];
2276 2277 2278 2279
    clusterMsg *hdr = (clusterMsg*) buf;
    uint32_t totlen;

    clusterBuildMessageHdr(hdr,CLUSTERMSG_TYPE_FAILOVER_AUTH_REQUEST);
2280 2281 2282 2283
    /* 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;
2284 2285
    totlen = sizeof(clusterMsg)-sizeof(union clusterMsgData);
    hdr->totlen = htonl(totlen);
2286
    clusterBroadcastMessage(buf,totlen);
2287 2288
}

2289 2290
/* Send a FAILOVER_AUTH_ACK message to the specified node. */
void clusterSendFailoverAuth(clusterNode *node) {
2291
    unsigned char buf[sizeof(clusterMsg)];
2292 2293 2294 2295 2296 2297 2298
    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);
2299
    clusterSendMessage(node->link,buf,totlen);
2300 2301
}

2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314
/* 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);
}

2315
/* Vote for the node asking for our vote if there are the conditions. */
2316
void clusterSendFailoverAuthIfNeeded(clusterNode *node, clusterMsg *request) {
2317
    clusterNode *master = node->slaveof;
2318 2319 2320
    uint64_t requestCurrentEpoch = ntohu64(request->currentEpoch);
    uint64_t requestConfigEpoch = ntohu64(request->configEpoch);
    unsigned char *claimed_slots = request->myslots;
2321
    int force_ack = request->mflags[0] & CLUSTERMSG_FLAG0_FORCEACK;
2322
    int j;
2323 2324 2325

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

2330 2331 2332 2333
    /* Request epoch must be >= our currentEpoch.
     * Note that it is impossible for it to actually be greater since
     * our currentEpoch was updated as a side effect of receiving this
     * request, if the request epoch was greater. */
2334 2335 2336 2337 2338 2339 2340 2341
    if (requestCurrentEpoch < server.cluster->currentEpoch) {
        redisLog(REDIS_WARNING,
            "Failover auth denied to %.40s: reqEpoch (%llu) < curEpoch(%llu)",
            node->name,
            (unsigned long long) requestCurrentEpoch,
            (unsigned long long) server.cluster->currentEpoch);
        return;
    }
2342

2343
    /* I already voted for this epoch? Return ASAP. */
2344 2345 2346 2347 2348 2349 2350
    if (server.cluster->lastVoteEpoch == server.cluster->currentEpoch) {
        redisLog(REDIS_WARNING,
                "Failover auth denied to %.40s: already voted for epoch %llu",
                node->name,
                (unsigned long long) server.cluster->currentEpoch);
        return;
    }
2351

2352 2353 2354 2355
    /* 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 ||
2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372
        (!nodeFailed(master) && !force_ack))
    {
        if (nodeIsMaster(node)) {
            redisLog(REDIS_WARNING,
                    "Failover auth denied to %.40s: it is a master node",
                    node->name);
        } else if (master == NULL) {
            redisLog(REDIS_WARNING,
                    "Failover auth denied to %.40s: I don't know its master",
                    node->name);
        } else if (!nodeFailed(master)) {
            redisLog(REDIS_WARNING,
                    "Failover auth denied to %.40s: its master is up",
                    node->name);
        }
        return;
    }
2373

2374 2375 2376
    /* 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. */
2377
    if (mstime() - node->slaveof->voted_time < server.cluster_node_timeout * 2)
2378 2379
    {
        redisLog(REDIS_WARNING,
2380 2381
                "Failover auth denied to %.40s: "
                "can't vote about this master before %lld milliseconds",
2382
                node->name,
2383 2384
                (long long) ((server.cluster_node_timeout*2)-
                             (mstime() - node->slaveof->voted_time)));
2385
        return;
2386
    }
2387

2388 2389 2390
    /* 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. */
2391 2392 2393
    for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
        if (bitmapTestBit(claimed_slots, j) == 0) continue;
        if (server.cluster->slots[j] == NULL ||
A
antirez 已提交
2394 2395 2396 2397
            server.cluster->slots[j]->configEpoch <= requestConfigEpoch)
        {
            continue;
        }
2398 2399 2400
        /* 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. */
2401 2402 2403 2404 2405 2406
        redisLog(REDIS_WARNING,
                "Failover auth denied to %.40s: "
                "slot %d epoch (%llu) > reqEpoch (%llu)",
                node->name, j,
                (unsigned long long) server.cluster->slots[j]->configEpoch,
                (unsigned long long) requestConfigEpoch);
2407 2408 2409
        return;
    }

2410
    /* We can vote for this slave. */
2411
    clusterSendFailoverAuth(node);
2412
    server.cluster->lastVoteEpoch = server.cluster->currentEpoch;
2413
    node->slaveof->voted_time = mstime();
2414 2415
    redisLog(REDIS_WARNING, "Failover auth granted to %.40s for epoch %llu",
        node->name, (unsigned long long) server.cluster->currentEpoch);
2416 2417
}

2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445
/* 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;
}

2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507
/* This function is called by clusterHandleSlaveFailover() in order to
 * let the slave log why it is not able to failover. Sometimes there are
 * not the conditions, but since the failover function is called again and
 * again, we can't log the same things continuously.
 *
 * This function works by logging only if a given set of conditions are
 * true:
 *
 * 1) The reason for which the failover can't be initiated changed.
 *    The reasons also include a NONE reason we reset the state to
 *    when the slave finds that its master is fine (no FAIL flag).
 * 2) Also, the log is emitted again if the master is still down and
 *    the reason for not failing over is still the same, but more than
 *    REDIS_CLUSTER_CANT_FAILOVER_RELOG_PERIOD seconds elapsed.
 * 3) Finally, the function only logs if the slave is down for more than
 *    five seconds + NODE_TIMEOUT. This way nothing is logged when a
 *    failover starts in a reasonable time.
 *
 * The function is called with the reason why the slave can't failover
 * which is one of the integer macros REDIS_CLUSTER_CANT_FAILOVER_*.
 *
 * The function is guaranteed to be called only if 'myself' is a slave. */
void clusterLogCantFailover(int reason) {
    char *msg;
    static time_t lastlog_time = 0;
    mstime_t nolog_fail_time = server.cluster_node_timeout + 5000;

    /* Don't log if we have the same reason for some time. */
    if (reason == server.cluster->cant_failover_reason &&
        time(NULL)-lastlog_time < REDIS_CLUSTER_CANT_FAILOVER_RELOG_PERIOD)
        return;

    server.cluster->cant_failover_reason = reason;

    /* We also don't emit any log if the master failed no long ago, the
     * goal of this function is to log slaves in a stalled condition for
     * a long time. */
    if (myself->slaveof &&
        nodeFailed(myself->slaveof) &&
        (mstime() - myself->slaveof->fail_time) < nolog_fail_time) return;

    switch(reason) {
    case REDIS_CLUSTER_CANT_FAILOVER_DATA_AGE:
        msg = "Disconnected from master for longer than allowed.";
        break;
    case REDIS_CLUSTER_CANT_FAILOVER_WAITING_DELAY:
        msg = "Waiting the delay before I can start a new failover.";
        break;
    case REDIS_CLUSTER_CANT_FAILOVER_EXPIRED:
        msg = "Failover attempt expired.";
        break;
    case REDIS_CLUSTER_CANT_FAILOVER_WAITING_VOTES:
        msg = "Waiting for votes, but majority still not reached.";
        break;
    default:
        msg = "Unknown reason code.";
        break;
    }
    lastlog_time = time(NULL);
    redisLog(REDIS_WARNING,"Currently unable to failover: %s", msg);
}

2508
/* This function is called if we are a slave node and our master serving
2509
 * a non-zero amount of hash slots is in FAIL state.
2510 2511 2512
 *
 * The gaol of this function is:
 * 1) To check if we are able to perform a failover, is our data updated?
2513
 * 2) Try to get elected by masters.
2514
 * 3) Perform the failover informing all the other nodes.
2515 2516
 */
void clusterHandleSlaveFailover(void) {
2517
    mstime_t data_age;
2518
    mstime_t auth_age = mstime() - server.cluster->failover_auth_time;
2519
    int needed_quorum = (server.cluster->size / 2) + 1;
2520 2521
    int manual_failover = server.cluster->mf_end != 0 &&
                          server.cluster->mf_can_start;
2522
    int j;
2523 2524
    mstime_t auth_timeout, auth_retry_time;

2525 2526
    server.cluster->todo_before_sleep &= ~CLUSTER_TODO_HANDLE_FAILOVER;

2527 2528
    /* Compute the failover timeout (the max time we have to send votes
     * and wait for replies), and the failover retry time (the time to wait
2529
     * before trying to get voted again).
2530 2531 2532 2533 2534 2535 2536
     *
     * Timeout is MIN(NODE_TIMEOUT*2,2000) milliseconds.
     * Retry is two times the Timeout.
     */
    auth_timeout = server.cluster_node_timeout*2;
    if (auth_timeout < 2000) auth_timeout = 2000;
    auth_retry_time = auth_timeout*2;
2537

2538 2539
    /* Pre conditions to run the function, that must be met both in case
     * of an automatic or manual failover:
2540
     * 1) We are a slave.
2541
     * 2) Our master is flagged as FAIL, or this is a manual failover.
2542
     * 3) It is serving slots. */
2543
    if (nodeIsMaster(myself) ||
2544
        myself->slaveof == NULL ||
2545
        (!nodeFailed(myself->slaveof) && !manual_failover) ||
2546 2547 2548 2549 2550 2551 2552
        myself->slaveof->numslots == 0)
    {
        /* There are no reasons to failover, so we set the reason why we
         * are returning without failing over to NONE. */
        server.cluster->cant_failover_reason = REDIS_CLUSTER_CANT_FAILOVER_NONE;
        return;
    }
2553

2554 2555 2556
    /* Set data_age to the number of seconds we are disconnected from
     * the master. */
    if (server.repl_state == REDIS_REPL_CONNECTED) {
2557 2558
        data_age = (mstime_t)(server.unixtime - server.master->lastinteraction)
                   * 1000;
2559
    } else {
2560
        data_age = (mstime_t)(server.unixtime - server.repl_down_since) * 1000;
2561 2562
    }

2563 2564 2565 2566 2567 2568
    /* 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;

2569 2570
    /* Check if our data is recent enough according to the slave validity
     * factor configured by the user.
2571 2572
     *
     * Check bypassed for manual failovers. */
2573 2574 2575 2576
    if (server.cluster_slave_validity_factor &&
        data_age >
        (((mstime_t)server.repl_ping_slave_period * 1000) +
         (server.cluster_node_timeout * server.cluster_slave_validity_factor)))
2577
    {
2578 2579 2580 2581
        if (!manual_failover) {
            clusterLogCantFailover(REDIS_CLUSTER_CANT_FAILOVER_DATA_AGE);
            return;
        }
2582
    }
2583

2584 2585 2586
    /* If the previous failover attempt timedout and the retry time has
     * elapsed, we can setup a new one. */
    if (auth_age > auth_retry_time) {
2587 2588 2589
        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. */
2590
        server.cluster->failover_auth_count = 0;
2591
        server.cluster->failover_auth_sent = 0;
2592 2593 2594 2595 2596 2597
        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;
2598 2599 2600 2601 2602
        /* 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;
        }
2603
        redisLog(REDIS_WARNING,
2604 2605
            "Start of election delayed for %lld milliseconds "
            "(rank #%d, offset %lld).",
2606
            server.cluster->failover_auth_time - mstime(),
2607 2608
            server.cluster->failover_auth_rank,
            replicationGetSlaveOffset());
2609 2610 2611 2612
        /* 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);
2613 2614 2615 2616 2617
        return;
    }

    /* It is possible that we received more updated offsets from other
     * slaves for the same master since we computed our election delay.
2618 2619 2620
     * Update the delay if our rank changed.
     *
     * Not performed if this is a manual failover. */
2621 2622 2623
    if (server.cluster->failover_auth_sent == 0 &&
        server.cluster->mf_end == 0)
    {
2624 2625 2626 2627 2628 2629 2630 2631 2632 2633
        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);
        }
2634 2635 2636
    }

    /* Return ASAP if we can't still start the election. */
2637 2638 2639 2640
    if (mstime() < server.cluster->failover_auth_time) {
        clusterLogCantFailover(REDIS_CLUSTER_CANT_FAILOVER_WAITING_DELAY);
        return;
    }
2641 2642

    /* Return ASAP if the election is too old to be valid. */
2643 2644 2645 2646
    if (auth_age > auth_timeout) {
        clusterLogCantFailover(REDIS_CLUSTER_CANT_FAILOVER_EXPIRED);
        return;
    }
2647 2648 2649 2650 2651 2652

    /* 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.",
2653
            (unsigned long long) server.cluster->currentEpoch);
2654
        clusterRequestFailoverAuth();
2655
        server.cluster->failover_auth_sent = 1;
A
antirez 已提交
2656 2657 2658
        clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                             CLUSTER_TODO_UPDATE_STATE|
                             CLUSTER_TODO_FSYNC_CONFIG);
2659 2660 2661 2662
        return; /* Wait for replies. */
    }

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

2666
        redisLog(REDIS_WARNING,
A
antirez 已提交
2667
            "Failover election won: I'm the new master.");
A
antirez 已提交
2668 2669 2670 2671
        /* We have the quorum, perform all the steps to correctly promote
         * this slave to a master.
         *
         * 1) Turn this node into a master. */
2672
        clusterSetNodeAsMaster(myself);
A
antirez 已提交
2673 2674
        replicationUnsetMaster();

2675 2676 2677 2678
        /* 2) Claim all the slots assigned to our master. */
        for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
            if (clusterNodeGetSlotBit(oldmaster,j)) {
                clusterDelSlot(j);
2679
                clusterAddSlot(myself,j);
2680 2681 2682
            }
        }

2683
        /* 3) Update my configEpoch to the epoch of the election. */
2684
        if (myself->configEpoch < server.cluster->failover_auth_epoch) {
2685
            myself->configEpoch = server.cluster->failover_auth_epoch;
2686 2687 2688 2689
            redisLog(REDIS_WARNING,
                "configEpoch set to %llu after successful failover",
                (unsigned long long) myself->configEpoch);
        }
2690

2691
        /* 4) Update state and save config. */
2692
        clusterUpdateState();
A
antirez 已提交
2693
        clusterSaveConfigOrDie(1);
2694 2695 2696

        /* 5) Pong all the other nodes so that they can update the state
         *    accordingly and detect that we switched to master role. */
2697
        clusterBroadcastPong(CLUSTER_BROADCAST_ALL);
2698 2699 2700

        /* 6) If there was a manual failover in progress, clear the state. */
        resetManualFailover();
2701 2702
    } else {
        clusterLogCantFailover(REDIS_CLUSTER_CANT_FAILOVER_WAITING_VOTES);
2703
    }
2704 2705
}

2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741
/* -----------------------------------------------------------------------------
 * 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;

2742 2743
    /* Step 2: Don't migrate if my master will not be left with at least
     *         'migration-barrier' slaves after my migration. */
2744 2745 2746 2747
    if (mymaster == NULL) return;
    for (j = 0; j < mymaster->numslaves; j++)
        if (!nodeFailed(mymaster->slaves[j]) &&
            !nodeTimedOut(mymaster->slaves[j])) okslaves++;
2748
    if (okslaves <= server.cluster_migration_barrier) return;
2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766

    /* 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;
2767 2768 2769 2770
        /* If this master never had slaves so far, don't migrate. We want
         * to migrate to a master that remained orphaned, not masters that
         * were never configured to have slaves. */
        if (node->numslaves == 0) continue;
2771 2772
        okslaves = clusterCountNonFailingSlaves(node);

A
antirez 已提交
2773 2774 2775
        if (okslaves == 0 && target == NULL && node->numslots > 0)
            target = node;

2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796
        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);
    }
}

2797 2798 2799 2800 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 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843
/* -----------------------------------------------------------------------------
 * 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) {
2844
    if (server.cluster->mf_end && server.cluster->mf_end < mstime()) {
2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855
        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;

M
Matt Stancliff 已提交
2856
    /* If mf_can_start is non-zero, the failover was already triggered so the
2857 2858 2859 2860 2861 2862 2863 2864 2865
     * 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;
A
antirez 已提交
2866 2867 2868
        redisLog(REDIS_WARNING,
            "All master replication stream processed, "
            "manual failover can start.");
2869 2870 2871
    }
}

A
antirez 已提交
2872 2873 2874 2875
/* -----------------------------------------------------------------------------
 * CLUSTER cron job
 * -------------------------------------------------------------------------- */

2876
/* This is executed 10 times every second */
A
antirez 已提交
2877 2878 2879
void clusterCron(void) {
    dictIterator *di;
    dictEntry *de;
2880 2881 2882 2883
    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). */
2884
    mstime_t min_pong = 0, now = mstime();
2885
    clusterNode *min_pong_node = NULL;
2886
    static unsigned long long iteration = 0;
2887
    mstime_t handshake_timeout;
2888 2889

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

2891
    /* The handshake timeout is the time after which a handshake node that was
2892 2893 2894 2895 2896 2897
     * 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 已提交
2898
    /* Check if we have disconnected nodes and re-establish the connection. */
2899
    di = dictGetSafeIterator(server.cluster->nodes);
A
antirez 已提交
2900
    while((de = dictNext(di)) != NULL) {
2901
        clusterNode *node = dictGetVal(de);
A
antirez 已提交
2902 2903

        if (node->flags & (REDIS_NODE_MYSELF|REDIS_NODE_NOADDR)) continue;
2904 2905 2906

        /* A Node in HANDSHAKE state has a limited lifespan equal to the
         * configured node timeout. */
2907
        if (nodeInHandshake(node) && now - node->ctime > handshake_timeout) {
2908 2909 2910 2911
            freeClusterNode(node);
            continue;
        }

A
antirez 已提交
2912 2913
        if (node->link == NULL) {
            int fd;
2914
            mstime_t old_ping_sent;
A
antirez 已提交
2915 2916
            clusterLink *link;

2917
            fd = anetTcpNonBlockBindConnect(server.neterr, node->ip,
2918
                node->port+REDIS_CLUSTER_PORT_INCR, REDIS_BIND_ADDR);
2919
            if (fd == -1) {
2920 2921 2922 2923 2924 2925
                /* We got a synchronous error from connect before
                 * clusterSendPing() had a chance to be called.
                 * If node->ping_sent is zero, failure detection can't work,
                 * so we claim we actually sent a ping now (that will
                 * be really sent as soon as the link is obtained). */
                if (node->ping_sent == 0) node->ping_sent = mstime();
2926
                redisLog(REDIS_DEBUG, "Unable to connect to "
2927 2928 2929
                    "Cluster Node [%s]:%d -> %s", node->ip,
                    node->port+REDIS_CLUSTER_PORT_INCR,
                    server.neterr);
2930 2931
                continue;
            }
A
antirez 已提交
2932 2933 2934
            link = createClusterLink(node);
            link->fd = fd;
            node->link = link;
A
antirez 已提交
2935 2936
            aeCreateFileEvent(server.el,link->fd,AE_READABLE,
                    clusterReadHandler,link);
2937 2938 2939 2940
            /* 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 已提交
2941 2942
             * of a PING one, to force the receiver to add us in its node
             * table. */
2943
            old_ping_sent = node->ping_sent;
A
antirez 已提交
2944 2945
            clusterSendPing(link, node->flags & REDIS_NODE_MEET ?
                    CLUSTERMSG_TYPE_MEET : CLUSTERMSG_TYPE_PING);
2946 2947 2948 2949 2950 2951
            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 已提交
2952 2953 2954 2955 2956 2957 2958
            /* 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;

A
antirez 已提交
2959 2960
            redisLog(REDIS_DEBUG,"Connecting with Node %.40s at %s:%d",
                    node->name, node->ip, node->port+REDIS_CLUSTER_PORT_INCR);
A
antirez 已提交
2961 2962 2963 2964
        }
    }
    dictReleaseIterator(di);

2965 2966 2967
    /* Ping some random node 1 time every 10 iterations, so that we usually ping
     * one random node every second. */
    if (!(iteration % 10)) {
2968 2969
        int j;

2970 2971 2972 2973 2974 2975 2976 2977
        /* 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;
A
antirez 已提交
2978 2979
            if (this->flags & (REDIS_NODE_MYSELF|REDIS_NODE_HANDSHAKE))
                continue;
2980 2981 2982 2983 2984 2985 2986 2987
            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 已提交
2988 2989 2990
        }
    }

2991 2992 2993 2994 2995 2996 2997 2998 2999
    /* 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;
3000
    di = dictGetSafeIterator(server.cluster->nodes);
A
antirez 已提交
3001
    while((de = dictNext(di)) != NULL) {
3002
        clusterNode *node = dictGetVal(de);
3003
        now = mstime(); /* Use an updated time at every iteration. */
3004
        mstime_t delay;
A
antirez 已提交
3005 3006

        if (node->flags &
3007 3008
            (REDIS_NODE_MYSELF|REDIS_NODE_NOADDR|REDIS_NODE_HANDSHAKE))
                continue;
3009

3010 3011 3012 3013 3014
        /* 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);

3015 3016 3017 3018 3019
            /* A master is orphaned if it is serving a non-zero number of
             * slots, have no working slaves, but used to have at least one
             * slave. */
            if (okslaves == 0 && node->numslots > 0 && node->numslaves)
                orphaned_masters++;
3020 3021 3022 3023 3024
            if (okslaves > max_slaves) max_slaves = okslaves;
            if (nodeIsSlave(myself) && myself->slaveof == node)
                this_slaves = okslaves;
        }

3025 3026 3027 3028
        /* 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 */
3029
            now - node->link->ctime >
3030
            server.cluster_node_timeout && /* was not already reconnected */
3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043
            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. */
3044
        if (node->link &&
3045 3046
            node->ping_sent == 0 &&
            (now - node->pong_received) > server.cluster_node_timeout/2)
3047 3048 3049 3050 3051
        {
            clusterSendPing(node->link, CLUSTERMSG_TYPE_PING);
            continue;
        }

3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062
        /* 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;
        }

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

3066 3067 3068 3069
        /* 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;
3070

3071
        if (delay > server.cluster_node_timeout) {
G
guiquanz 已提交
3072
            /* Timeout reached. Set the node as possibly failing if it is
3073
             * not already in this state. */
3074
            if (!(node->flags & (REDIS_NODE_PFAIL|REDIS_NODE_FAIL))) {
A
antirez 已提交
3075 3076 3077
                redisLog(REDIS_DEBUG,"*** NODE %.40s possibly failing",
                    node->name);
                node->flags |= REDIS_NODE_PFAIL;
3078
                update_state = 1;
A
antirez 已提交
3079 3080 3081 3082
            }
        }
    }
    dictReleaseIterator(di);
3083 3084 3085 3086

    /* 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. */
3087
    if (nodeIsSlave(myself) &&
3088
        server.masterhost == NULL &&
3089
        myself->slaveof &&
3090
        nodeHasAddr(myself->slaveof))
3091
    {
3092
        replicationSetMaster(myself->slaveof->ip, myself->slaveof->port);
3093
    }
3094

3095 3096 3097
    /* Abourt a manual failover if the timeout is reached. */
    manualFailoverCheckTimeout();

3098
    if (nodeIsSlave(myself)) {
3099
        clusterHandleManualFailover();
3100 3101 3102 3103 3104 3105 3106 3107 3108 3109
        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);
    }

3110 3111
    if (update_state || server.cluster->state == REDIS_CLUSTER_FAIL)
        clusterUpdateState();
3112 3113 3114 3115 3116
}

/* 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 已提交
3117 3118
 * handlers, or to perform potentially expansive tasks that we need to do
 * a single time before replying to clients. */
3119
void clusterBeforeSleep(void) {
A
antirez 已提交
3120 3121 3122
    /* 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)
3123
        clusterHandleSlaveFailover();
A
antirez 已提交
3124 3125 3126 3127 3128 3129 3130

    /* 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) {
A
antirez 已提交
3131 3132
        int fsync = server.cluster->todo_before_sleep &
                    CLUSTER_TODO_FSYNC_CONFIG;
A
antirez 已提交
3133
        clusterSaveConfigOrDie(fsync);
3134
    }
A
antirez 已提交
3135

3136 3137
    /* Reset our flags (not strictly needed since every single function
     * called for flags set should be able to clear its flag). */
A
antirez 已提交
3138 3139 3140 3141 3142
    server.cluster->todo_before_sleep = 0;
}

void clusterDoBeforeSleep(int flags) {
    server.cluster->todo_before_sleep |= flags;
A
antirez 已提交
3143 3144 3145 3146 3147 3148
}

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

3149
/* Test bit 'pos' in a generic bitmap. Return 1 if the bit is set,
3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170
 * 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 已提交
3171 3172
/* Set the slot bit and return the old value. */
int clusterNodeSetSlotBit(clusterNode *n, int slot) {
3173 3174
    int old = bitmapTestBit(n->slots,slot);
    bitmapSetBit(n->slots,slot);
3175
    if (!old) n->numslots++;
A
antirez 已提交
3176 3177 3178 3179 3180
    return old;
}

/* Clear the slot bit and return the old value. */
int clusterNodeClearSlotBit(clusterNode *n, int slot) {
3181 3182
    int old = bitmapTestBit(n->slots,slot);
    bitmapClearBit(n->slots,slot);
3183
    if (old) n->numslots--;
A
antirez 已提交
3184 3185 3186 3187 3188
    return old;
}

/* Return the slot bit from the cluster node structure. */
int clusterNodeGetSlotBit(clusterNode *n, int slot) {
3189
    return bitmapTestBit(n->slots,slot);
A
antirez 已提交
3190 3191 3192 3193 3194 3195 3196
}

/* 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) {
3197 3198
    if (server.cluster->slots[slot]) return REDIS_ERR;
    clusterNodeSetSlotBit(n,slot);
3199
    server.cluster->slots[slot] = n;
A
antirez 已提交
3200 3201 3202
    return REDIS_OK;
}

A
antirez 已提交
3203 3204 3205 3206
/* 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) {
3207
    clusterNode *n = server.cluster->slots[slot];
A
antirez 已提交
3208 3209 3210

    if (!n) return REDIS_ERR;
    redisAssert(clusterNodeClearSlotBit(n,slot) == 1);
3211
    server.cluster->slots[slot] = NULL;
A
antirez 已提交
3212 3213 3214
    return REDIS_OK;
}

3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226
/* 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 已提交
3227 3228 3229 3230 3231 3232 3233 3234 3235
/* Clear the migrating / importing state for all the slots.
 * This is useful at initialization and when turning a master into slave. */
void clusterCloseAllSlots(void) {
    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));
}

A
antirez 已提交
3236 3237 3238
/* -----------------------------------------------------------------------------
 * Cluster state evaluation function
 * -------------------------------------------------------------------------- */
3239

3240 3241 3242 3243
/* 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. */
3244
#define REDIS_CLUSTER_MAX_REJOIN_DELAY 5000
3245
#define REDIS_CLUSTER_MIN_REJOIN_DELAY 500
3246
#define REDIS_CLUSTER_WRITABLE_DELAY 2000
3247

A
antirez 已提交
3248
void clusterUpdateState(void) {
3249
    int j, new_state;
3250
    int reachable_masters = 0;
3251
    static mstime_t among_minority_time;
3252 3253
    static mstime_t first_call_time = 0;

3254 3255
    server.cluster->todo_before_sleep &= ~CLUSTER_TODO_UPDATE_STATE;

3256 3257 3258 3259 3260 3261 3262
    /* 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();
3263
    if (nodeIsMaster(myself) &&
3264
        server.cluster->state == REDIS_CLUSTER_FAIL &&
3265
        mstime() - first_call_time < REDIS_CLUSTER_WRITABLE_DELAY) return;
A
antirez 已提交
3266

3267 3268
    /* Start assuming the state is OK. We'll turn it into FAIL if there
     * are the right conditions. */
3269
    new_state = REDIS_CLUSTER_OK;
3270

3271
    /* Check if all the slots are covered. */
3272 3273 3274 3275 3276 3277 3278 3279
    if (server.cluster_require_full_coverage) {
        for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
            if (server.cluster->slots[j] == NULL ||
                server.cluster->slots[j]->flags & (REDIS_NODE_FAIL))
            {
                new_state = REDIS_CLUSTER_FAIL;
                break;
            }
A
antirez 已提交
3280 3281
        }
    }
3282

3283
    /* Compute the cluster size, that is the number of master nodes
3284 3285
     * serving at least a single slot.
     *
3286 3287
     * At the same time count the number of reachable masters having
     * at least one slot. */
3288 3289 3290 3291 3292
    {
        dictIterator *di;
        dictEntry *de;

        server.cluster->size = 0;
3293
        di = dictGetSafeIterator(server.cluster->nodes);
3294 3295 3296
        while((de = dictNext(di)) != NULL) {
            clusterNode *node = dictGetVal(de);

3297
            if (nodeIsMaster(node) && node->numslots) {
3298
                server.cluster->size++;
3299 3300
                if ((node->flags & (REDIS_NODE_FAIL|REDIS_NODE_PFAIL)) == 0)
                    reachable_masters++;
3301
            }
3302 3303 3304
        }
        dictReleaseIterator(di);
    }
3305

3306 3307
    /* If we are in a minority partition, change the cluster state
     * to FAIL. */
3308 3309
    {
        int needed_quorum = (server.cluster->size / 2) + 1;
3310

3311
        if (reachable_masters < needed_quorum) {
3312 3313 3314
            new_state = REDIS_CLUSTER_FAIL;
            among_minority_time = mstime();
        }
3315 3316
    }

3317
    /* Log a state change */
3318 3319 3320 3321 3322 3323 3324 3325 3326
    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;
3327 3328
        if (rejoin_delay < REDIS_CLUSTER_MIN_REJOIN_DELAY)
            rejoin_delay = REDIS_CLUSTER_MIN_REJOIN_DELAY;
3329 3330

        if (new_state == REDIS_CLUSTER_OK &&
3331
            nodeIsMaster(myself) &&
3332 3333 3334 3335 3336 3337
            mstime() - among_minority_time < rejoin_delay)
        {
            return;
        }

        /* Change the state and log the event. */
3338
        redisLog(REDIS_WARNING,"Cluster state changed: %s",
3339 3340 3341
            new_state == REDIS_CLUSTER_OK ? "ok" : "fail");
        server.cluster->state = new_state;
    }
A
antirez 已提交
3342 3343
}

3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366
/* 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) {
3367 3368 3369
    int j;
    int update_config = 0;

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

3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385
    /* 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. */
3386
        if (server.cluster->slots[j] == myself ||
3387 3388 3389 3390 3391 3392 3393
            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++;
M
Matt Stancliff 已提交
3394
        /* Case A: slot is unassigned. Take responsibility for it. */
3395
        if (server.cluster->slots[j] == NULL) {
3396 3397
            redisLog(REDIS_WARNING, "I have keys for unassigned slot %d. "
                                    "Taking responsibility for it.",j);
3398
            clusterAddSlot(myself,j);
3399
        } else {
3400 3401 3402
            redisLog(REDIS_WARNING, "I have keys for slot %d, but the slot is "
                                    "assigned to another node. "
                                    "Setting it to importing state.",j);
3403 3404 3405
            server.cluster->importing_slots_from[j] = server.cluster->slots[j];
        }
    }
A
antirez 已提交
3406
    if (update_config) clusterSaveConfigOrDie(1);
3407 3408 3409
    return REDIS_OK;
}

3410 3411 3412 3413
/* -----------------------------------------------------------------------------
 * SLAVE nodes handling
 * -------------------------------------------------------------------------- */

3414 3415
/* Set the specified node 'n' as master for this node.
 * If this node is currently a master, it is turned into a slave. */
3416 3417
void clusterSetMaster(clusterNode *n) {
    redisAssert(n != myself);
3418
    redisAssert(myself->numslots == 0);
3419

3420
    if (nodeIsMaster(myself)) {
3421 3422
        myself->flags &= ~REDIS_NODE_MASTER;
        myself->flags |= REDIS_NODE_SLAVE;
3423
        clusterCloseAllSlots();
3424 3425 3426
    } else {
        if (myself->slaveof)
            clusterNodeRemoveSlave(myself->slaveof,myself);
3427 3428
    }
    myself->slaveof = n;
3429
    clusterNodeAddSlave(n,myself);
3430
    replicationSetMaster(n->ip, n->port);
3431
    resetManualFailover();
3432 3433
}

A
antirez 已提交
3434
/* -----------------------------------------------------------------------------
3435
 * Nodes to string representation functions.
A
antirez 已提交
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 3461 3462 3463 3464 3465 3466 3467 3468
struct redisNodeFlags {
    uint16_t flag;
    char *name;
};

static struct redisNodeFlags redisNodeFlagsTable[] = {
    {REDIS_NODE_MYSELF,    "myself,"},
    {REDIS_NODE_MASTER,    "master,"},
    {REDIS_NODE_SLAVE,     "slave,"},
    {REDIS_NODE_PFAIL,     "fail?,"},
    {REDIS_NODE_FAIL,      "fail,"},
    {REDIS_NODE_HANDSHAKE, "handshake,"},
    {REDIS_NODE_NOADDR,    "noaddr,"}
};

/* Concatenate the comma separated list of node flags to the given SDS
 * string 'ci'. */
sds representRedisNodeFlags(sds ci, uint16_t flags) {
    if (flags == 0) {
        ci = sdscat(ci,"noflags,");
    } else {
        int i, size = sizeof(redisNodeFlagsTable)/sizeof(struct redisNodeFlags);
        for (i = 0; i < size; i++) {
            struct redisNodeFlags *nodeflag = redisNodeFlagsTable + i;
            if (flags & nodeflag->flag) ci = sdscat(ci, nodeflag->name);
        }
    }
    sdsIncrLen(ci,-1); /* Remove trailing comma. */
    return ci;
}

3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483
/* 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 */
C
charsyam 已提交
3484
    ci = representRedisNodeFlags(ci, node->flags);
3485 3486 3487

    /* Slave of... or just "-" */
    if (node->slaveof)
3488
        ci = sdscatprintf(ci," %.40s ",node->slaveof->name);
3489
    else
3490
        ci = sdscatlen(ci," - ",3);
3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508

    /* 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)) {
3509
            if (bit && j == REDIS_CLUSTER_SLOTS-1) j++;
3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536

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

3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549
/* 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) {
3550
    sds ci = sdsempty(), ni;
A
antirez 已提交
3551 3552 3553
    dictIterator *di;
    dictEntry *de;

3554
    di = dictGetSafeIterator(server.cluster->nodes);
A
antirez 已提交
3555
    while((de = dictNext(di)) != NULL) {
3556
        clusterNode *node = dictGetVal(de);
A
antirez 已提交
3557

3558
        if (node->flags & filter) continue;
3559 3560 3561
        ni = clusterGenNodeDescription(node);
        ci = sdscatsds(ci,ni);
        sdsfree(ni);
3562
        ci = sdscatlen(ci,"\n",1);
A
antirez 已提交
3563 3564 3565 3566 3567
    }
    dictReleaseIterator(di);
    return ci;
}

3568 3569 3570 3571
/* -----------------------------------------------------------------------------
 * CLUSTER command
 * -------------------------------------------------------------------------- */

3572 3573 3574 3575
int getSlotOrReply(redisClient *c, robj *o) {
    long long slot;

    if (getLongLongFromObject(o,&slot) != REDIS_OK ||
3576
        slot < 0 || slot >= REDIS_CLUSTER_SLOTS)
3577 3578 3579 3580 3581 3582 3583
    {
        addReplyError(c,"Invalid or out of range slot");
        return -1;
    }
    return (int) slot;
}

3584 3585 3586 3587 3588 3589 3590 3591 3592 3593
void clusterReplyMultiBulkSlots(redisClient *c) {
    /* Format: 1) 1) start slot
     *            2) end slot
     *            3) 1) master IP
     *               2) master port
     *            4) 1) replica IP
     *               2) replica port
     *           ... continued until done
     */

3594 3595
    int num_masters = 0;
    void *slot_replylen = addDeferredMultiBulkLength(c);
3596 3597 3598 3599 3600 3601 3602

    dictEntry *de;
    dictIterator *di = dictGetSafeIterator(server.cluster->nodes);
    while((de = dictNext(di)) != NULL) {
        clusterNode *node = dictGetVal(de);
        int j = 0, start = -1;

3603 3604 3605
        /* Skip slaves (that are iterated when producing the output of their
         * master) and  masters not serving any slot. */
        if (!nodeIsMaster(node) || node->numslots == 0) continue;
3606 3607

        for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
3608
            int bit, i;
3609 3610 3611 3612 3613

            if ((bit = clusterNodeGetSlotBit(node,j)) != 0) {
                if (start == -1) start = j;
            }
            if (start != -1 && (!bit || j == REDIS_CLUSTER_SLOTS-1)) {
3614 3615
                int nested_elements = 3; /* slots (2) + master addr (1). */
                void *nested_replylen = addDeferredMultiBulkLength(c);
3616

3617
                if (bit && j == REDIS_CLUSTER_SLOTS-1) j++;
3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638

                /* If slot exists in output map, add to it's list.
                 * else, create a new output map for this slot */
                if (start == j-1) {
                    addReplyLongLong(c, start); /* only one slot; low==high */
                    addReplyLongLong(c, start);
                } else {
                    addReplyLongLong(c, start); /* low */
                    addReplyLongLong(c, j-1);   /* high */
                }
                start = -1;

                /* First node reply position is always the master */
                addReplyMultiBulkLen(c, 2);
                addReplyBulkCString(c, node->ip);
                addReplyLongLong(c, node->port);

                /* Remaining nodes in reply are replicas for slot range */
                for (i = 0; i < node->numslaves; i++) {
                    /* This loop is copy/pasted from clusterGenNodeDescription()
                     * with modifications for per-slot node aggregation */
3639
                    if (nodeFailed(node->slaves[i])) continue;
3640 3641 3642
                    addReplyMultiBulkLen(c, 2);
                    addReplyBulkCString(c, node->slaves[i]->ip);
                    addReplyLongLong(c, node->slaves[i]->port);
3643
                    nested_elements++;
3644
                }
3645 3646
                setDeferredMultiBulkLength(c, nested_replylen, nested_elements);
                num_masters++;
3647 3648 3649 3650
            }
        }
    }
    dictReleaseIterator(di);
3651
    setDeferredMultiBulkLength(c, slot_replylen, num_masters);
3652 3653
}

A
antirez 已提交
3654 3655 3656 3657 3658 3659 3660
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) {
3661
        long long port;
A
antirez 已提交
3662

3663 3664 3665
        if (getLongLongFromObject(c->argv[3], &port) != REDIS_OK) {
            addReplyErrorFormat(c,"Invalid TCP port specified: %s",
                                (char*)c->argv[3]->ptr);
A
antirez 已提交
3666 3667 3668
            return;
        }

3669 3670 3671
        if (clusterStartHandshake(c->argv[2]->ptr,port) == 0 &&
            errno == EINVAL)
        {
3672 3673
            addReplyErrorFormat(c,"Invalid node address specified: %s:%s",
                            (char*)c->argv[2]->ptr, (char*)c->argv[3]->ptr);
3674 3675 3676
        } else {
            addReply(c,shared.ok);
        }
A
antirez 已提交
3677
    } else if (!strcasecmp(c->argv[1]->ptr,"nodes") && c->argc == 2) {
3678
        /* CLUSTER NODES */
A
antirez 已提交
3679
        robj *o;
3680
        sds ci = clusterGenNodesDescription(0);
A
antirez 已提交
3681 3682 3683 3684

        o = createObject(REDIS_STRING,ci);
        addReplyBulk(c,o);
        decrRefCount(o);
3685 3686 3687
    } else if (!strcasecmp(c->argv[1]->ptr,"slots") && c->argc == 2) {
        /* CLUSTER SLOTS */
        clusterReplyMultiBulkSlots(c);
3688 3689 3690 3691 3692 3693
    } 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;
        }
3694
        clusterDelNodeSlots(myself);
A
antirez 已提交
3695
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
3696
        addReply(c,shared.ok);
A
antirez 已提交
3697
    } else if ((!strcasecmp(c->argv[1]->ptr,"addslots") ||
A
antirez 已提交
3698 3699 3700 3701
               !strcasecmp(c->argv[1]->ptr,"delslots")) && c->argc >= 3)
    {
        /* CLUSTER ADDSLOTS <slot> [slot] ... */
        /* CLUSTER DELSLOTS <slot> [slot] ... */
3702
        int j, slot;
A
antirez 已提交
3703
        unsigned char *slots = zmalloc(REDIS_CLUSTER_SLOTS);
A
antirez 已提交
3704
        int del = !strcasecmp(c->argv[1]->ptr,"delslots");
A
antirez 已提交
3705 3706

        memset(slots,0,REDIS_CLUSTER_SLOTS);
M
Matt Stancliff 已提交
3707
        /* Check that all the arguments are parseable and that all the
A
antirez 已提交
3708 3709
         * slots are not already busy. */
        for (j = 2; j < c->argc; j++) {
3710
            if ((slot = getSlotOrReply(c,c->argv[j])) == -1) {
A
antirez 已提交
3711 3712 3713
                zfree(slots);
                return;
            }
3714
            if (del && server.cluster->slots[slot] == NULL) {
3715
                addReplyErrorFormat(c,"Slot %d is already unassigned", slot);
A
antirez 已提交
3716 3717
                zfree(slots);
                return;
3718
            } else if (!del && server.cluster->slots[slot]) {
3719
                addReplyErrorFormat(c,"Slot %d is already busy", slot);
A
antirez 已提交
3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731
                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]) {
3732 3733
                int retval;

3734
                /* If this slot was set as importing we can clear this
3735
                 * state as now we are the real owner of the slot. */
3736 3737
                if (server.cluster->importing_slots_from[j])
                    server.cluster->importing_slots_from[j] = NULL;
3738 3739

                retval = del ? clusterDelSlot(j) :
3740
                               clusterAddSlot(myself,j);
3741
                redisAssertWithInfo(c,NULL,retval == REDIS_OK);
A
antirez 已提交
3742 3743 3744
            }
        }
        zfree(slots);
A
antirez 已提交
3745
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
A
antirez 已提交
3746
        addReply(c,shared.ok);
3747
    } else if (!strcasecmp(c->argv[1]->ptr,"setslot") && c->argc >= 4) {
A
antirez 已提交
3748 3749
        /* SETSLOT 10 MIGRATING <node ID> */
        /* SETSLOT 10 IMPORTING <node ID> */
3750
        /* SETSLOT 10 STABLE */
A
antirez 已提交
3751
        /* SETSLOT 10 NODE <node ID> */
3752
        int slot;
3753 3754
        clusterNode *n;

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

3757
        if (!strcasecmp(c->argv[3]->ptr,"migrating") && c->argc == 5) {
3758
            if (server.cluster->slots[slot] != myself) {
3759 3760 3761
                addReplyErrorFormat(c,"I'm not the owner of hash slot %u",slot);
                return;
            }
3762 3763 3764 3765 3766
            if ((n = clusterLookupNode(c->argv[4]->ptr)) == NULL) {
                addReplyErrorFormat(c,"I don't know about node %s",
                    (char*)c->argv[4]->ptr);
                return;
            }
3767
            server.cluster->migrating_slots_to[slot] = n;
3768
        } else if (!strcasecmp(c->argv[3]->ptr,"importing") && c->argc == 5) {
3769
            if (server.cluster->slots[slot] == myself) {
3770 3771 3772 3773
                addReplyErrorFormat(c,
                    "I'm already the owner of hash slot %u",slot);
                return;
            }
3774 3775 3776 3777 3778
            if ((n = clusterLookupNode(c->argv[4]->ptr)) == NULL) {
                addReplyErrorFormat(c,"I don't know about node %s",
                    (char*)c->argv[3]->ptr);
                return;
            }
3779
            server.cluster->importing_slots_from[slot] = n;
3780
        } else if (!strcasecmp(c->argv[3]->ptr,"stable") && c->argc == 4) {
3781
            /* CLUSTER SETSLOT <SLOT> STABLE */
3782 3783
            server.cluster->importing_slots_from[slot] = NULL;
            server.cluster->migrating_slots_to[slot] = NULL;
3784
        } else if (!strcasecmp(c->argv[3]->ptr,"node") && c->argc == 5) {
3785 3786 3787
            /* CLUSTER SETSLOT <SLOT> NODE <NODE ID> */
            clusterNode *n = clusterLookupNode(c->argv[4]->ptr);

3788 3789 3790 3791 3792
            if (!n) {
                addReplyErrorFormat(c,"Unknown node %s",
                    (char*)c->argv[4]->ptr);
                return;
            }
3793 3794
            /* If this hash slot was served by 'myself' before to switch
             * make sure there are no longer local keys for this hash slot. */
3795
            if (server.cluster->slots[slot] == myself && n != myself) {
3796
                if (countKeysInSlot(slot) != 0) {
A
antirez 已提交
3797 3798 3799
                    addReplyErrorFormat(c,
                        "Can't assign hashslot %d to a different node "
                        "while I still hold keys for this hash slot.", slot);
3800 3801 3802
                    return;
                }
            }
3803 3804
            /* If this slot is in migrating status but we have no keys
             * for it assigning the slot to another node will clear
3805
             * the migratig status. */
3806
            if (countKeysInSlot(slot) == 0 &&
3807 3808
                server.cluster->migrating_slots_to[slot])
                server.cluster->migrating_slots_to[slot] = NULL;
3809

3810 3811
            /* If this node was importing this slot, assigning the slot to
             * itself also clears the importing status. */
3812
            if (n == myself &&
3813
                server.cluster->importing_slots_from[slot])
3814 3815
            {
                /* This slot was manually migrated, set this node configEpoch
3816 3817 3818
                 * to a new epoch so that the new version can be propagated
                 * by the cluster.
                 *
3819 3820 3821 3822 3823
                 * Note that if this ever results in a collision with another
                 * node getting the same configEpoch, for example because a
                 * failover happens at the same time we close the slot, the
                 * configEpoch collision resolution will fix it assigning
                 * a different epoch to each node. */
3824 3825
                uint64_t maxEpoch = clusterGetMaxEpoch();

3826 3827 3828
                if (myself->configEpoch == 0 ||
                    myself->configEpoch != maxEpoch)
                {
3829 3830 3831
                    server.cluster->currentEpoch++;
                    myself->configEpoch = server.cluster->currentEpoch;
                    clusterDoBeforeSleep(CLUSTER_TODO_FSYNC_CONFIG);
3832 3833 3834
                    redisLog(REDIS_WARNING,
                        "configEpoch set to %llu after importing slot %d",
                        (unsigned long long) myself->configEpoch, slot);
3835
                }
3836
                server.cluster->importing_slots_from[slot] = NULL;
3837
            }
3838 3839
            clusterDelSlot(slot);
            clusterAddSlot(n,slot);
3840
        } else {
A
antirez 已提交
3841 3842
            addReplyError(c,
                "Invalid CLUSTER SETSLOT action or number of arguments");
3843
            return;
3844
        }
3845
        clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|CLUSTER_TODO_UPDATE_STATE);
3846
        addReply(c,shared.ok);
A
antirez 已提交
3847
    } else if (!strcasecmp(c->argv[1]->ptr,"info") && c->argc == 2) {
3848
        /* CLUSTER INFO */
A
antirez 已提交
3849 3850
        char *statestr[] = {"ok","fail","needhelp"};
        int slots_assigned = 0, slots_ok = 0, slots_pfail = 0, slots_fail = 0;
3851
        uint64_t myepoch;
A
antirez 已提交
3852 3853 3854
        int j;

        for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
3855
            clusterNode *n = server.cluster->slots[j];
A
antirez 已提交
3856 3857 3858

            if (n == NULL) continue;
            slots_assigned++;
3859
            if (nodeFailed(n)) {
A
antirez 已提交
3860
                slots_fail++;
3861
            } else if (nodeTimedOut(n)) {
A
antirez 已提交
3862 3863 3864 3865 3866 3867
                slots_pfail++;
            } else {
                slots_ok++;
            }
        }

3868 3869 3870
        myepoch = (nodeIsSlave(myself) && myself->slaveof) ?
                  myself->slaveof->configEpoch : myself->configEpoch;

A
antirez 已提交
3871 3872 3873 3874 3875 3876
        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"
3877
            "cluster_known_nodes:%lu\r\n"
3878
            "cluster_size:%d\r\n"
3879
            "cluster_current_epoch:%llu\r\n"
3880
            "cluster_my_epoch:%llu\r\n"
3881 3882
            "cluster_stats_messages_sent:%lld\r\n"
            "cluster_stats_messages_received:%lld\r\n"
3883
            , statestr[server.cluster->state],
A
antirez 已提交
3884 3885 3886
            slots_assigned,
            slots_ok,
            slots_pfail,
3887
            slots_fail,
3888
            dictSize(server.cluster->nodes),
3889
            server.cluster->size,
3890
            (unsigned long long) server.cluster->currentEpoch,
3891
            (unsigned long long) myepoch,
3892 3893
            server.cluster->stats_bus_messages_sent,
            server.cluster->stats_bus_messages_received
A
antirez 已提交
3894 3895 3896 3897 3898
        );
        addReplySds(c,sdscatprintf(sdsempty(),"$%lu\r\n",
            (unsigned long)sdslen(info)));
        addReplySds(c,info);
        addReply(c,shared.crlf);
3899
    } else if (!strcasecmp(c->argv[1]->ptr,"saveconfig") && c->argc == 2) {
A
antirez 已提交
3900
        int retval = clusterSaveConfig(1);
3901 3902 3903 3904 3905 3906

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

        addReplyLongLong(c,keyHashSlot(key,sdslen(key)));
3912
    } else if (!strcasecmp(c->argv[1]->ptr,"countkeysinslot") && c->argc == 3) {
3913
        /* CLUSTER COUNTKEYSINSLOT <slot> */
3914 3915 3916 3917
        long long slot;

        if (getLongLongFromObjectOrReply(c,c->argv[2],&slot,NULL) != REDIS_OK)
            return;
3918 3919 3920 3921
        if (slot < 0 || slot >= REDIS_CLUSTER_SLOTS) {
            addReplyError(c,"Invalid slot");
            return;
        }
3922
        addReplyLongLong(c,countKeysInSlot(slot));
A
antirez 已提交
3923
    } else if (!strcasecmp(c->argv[1]->ptr,"getkeysinslot") && c->argc == 4) {
3924
        /* CLUSTER GETKEYSINSLOT <slot> <count> */
A
antirez 已提交
3925
        long long maxkeys, slot;
3926
        unsigned int numkeys, j;
A
antirez 已提交
3927 3928 3929 3930
        robj **keys;

        if (getLongLongFromObjectOrReply(c,c->argv[2],&slot,NULL) != REDIS_OK)
            return;
A
antirez 已提交
3931 3932
        if (getLongLongFromObjectOrReply(c,c->argv[3],&maxkeys,NULL)
            != REDIS_OK)
A
antirez 已提交
3933
            return;
3934
        if (slot < 0 || slot >= REDIS_CLUSTER_SLOTS || maxkeys < 0) {
A
antirez 已提交
3935 3936 3937 3938 3939
            addReplyError(c,"Invalid slot or number of keys");
            return;
        }

        keys = zmalloc(sizeof(robj*)*maxkeys);
3940
        numkeys = getKeysInSlot(slot, keys, maxkeys);
A
antirez 已提交
3941 3942 3943
        addReplyMultiBulkLen(c,numkeys);
        for (j = 0; j < numkeys; j++) addReplyBulk(c,keys[j]);
        zfree(keys);
A
antirez 已提交
3944 3945 3946 3947
    } else if (!strcasecmp(c->argv[1]->ptr,"forget") && c->argc == 3) {
        /* CLUSTER FORGET <NODE ID> */
        clusterNode *n = clusterLookupNode(c->argv[2]->ptr);

3948
        if (!n) {
A
antirez 已提交
3949 3950
            addReplyErrorFormat(c,"Unknown node %s", (char*)c->argv[2]->ptr);
            return;
3951
        } else if (n == myself) {
3952 3953
            addReplyError(c,"I tried hard but I can't forget myself...");
            return;
3954
        } else if (nodeIsSlave(myself) && myself->slaveof == n) {
3955 3956
            addReplyError(c,"Can't forget my master!");
            return;
A
antirez 已提交
3957
        }
3958
        clusterBlacklistAddNode(n);
A
antirez 已提交
3959
        clusterDelNode(n);
A
antirez 已提交
3960 3961
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|
                             CLUSTER_TODO_SAVE_CONFIG);
A
antirez 已提交
3962
        addReply(c,shared.ok);
3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973
    } 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. */
3974
        if (n == myself) {
3975 3976 3977 3978 3979 3980 3981 3982 3983 3984
            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;
        }

3985 3986 3987
        /* 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. */
3988 3989
        if (nodeIsMaster(myself) &&
            (myself->numslots != 0 || dictSize(server.db[0].dict) != 0)) {
A
antirez 已提交
3990 3991 3992
            addReplyError(c,
                "To set a master the node must be empty and "
                "without assigned slots.");
3993 3994 3995 3996 3997
            return;
        }

        /* Set the master. */
        clusterSetMaster(n);
A
antirez 已提交
3998
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
3999
        addReply(c,shared.ok);
4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010
    } 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;
        }

4011
        if (nodeIsSlave(n)) {
4012 4013 4014 4015 4016 4017 4018 4019 4020 4021
            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);
        }
A
antirez 已提交
4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036
    } else if (!strcasecmp(c->argv[1]->ptr,"failover") &&
               (c->argc == 2 || c->argc == 3))
    {
        /* CLUSTER FAILOVER [FORCE] */
        int force = 0;

        if (c->argc == 3) {
            if (!strcasecmp(c->argv[2]->ptr,"force")) {
                force = 1;
            } else {
                addReply(c,shared.syntaxerr);
                return;
            }
        }

4037 4038 4039
        if (nodeIsMaster(myself)) {
            addReplyError(c,"You should send CLUSTER FAILOVER to a slave");
            return;
A
antirez 已提交
4040 4041 4042
        } else if (!force &&
                   (myself->slaveof == NULL || nodeFailed(myself->slaveof) ||
                   myself->slaveof->link == NULL))
4043 4044 4045 4046 4047 4048 4049
        {
            addReplyError(c,"Master is down or failed, "
                            "please use CLUSTER FAILOVER FORCE");
            return;
        }
        resetManualFailover();
        server.cluster->mf_end = mstime() + REDIS_CLUSTER_MF_TIMEOUT;
A
antirez 已提交
4050 4051 4052 4053 4054 4055 4056 4057 4058

        /* If this is a forced failover, we don't need to talk with our master
         * to agree about the offset. We just failover taking over it without
         * coordination. */
        if (force) {
            server.cluster->mf_can_start = 1;
        } else {
            clusterSendMFStart(myself->slaveof);
        }
4059 4060
        redisLog(REDIS_WARNING,"Manual failover user request accepted.");
        addReply(c,shared.ok);
A
antirez 已提交
4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083
    } else if (!strcasecmp(c->argv[1]->ptr,"set-config-epoch") && c->argc == 3)
    {
        /* CLUSTER SET-CONFIG-EPOCH <epoch>
         *
         * The user is allowed to set the config epoch only when a node is
         * totally fresh: no config epoch, no other known node, and so forth.
         * This happens at cluster creation time to start with a cluster where
         * every node has a different node ID, without to rely on the conflicts
         * resolution system which is too slow when a big cluster is created. */
        long long epoch;

        if (getLongLongFromObjectOrReply(c,c->argv[2],&epoch,NULL) != REDIS_OK)
            return;

        if (epoch < 0) {
            addReplyErrorFormat(c,"Invalid config epoch specified: %lld",epoch);
        } else if (dictSize(server.cluster->nodes) > 1) {
            addReplyError(c,"The user can assign a config epoch only when the "
                            "node does not know any other node.");
        } else if (myself->configEpoch != 0) {
            addReplyError(c,"Node config epoch is already non-zero");
        } else {
            myself->configEpoch = epoch;
4084 4085 4086 4087
            redisLog(REDIS_WARNING,
                "configEpoch set to %llu via CLUSTER SET-CONFIG-EPOCH",
                (unsigned long long) myself->configEpoch);

4088
            if (server.cluster->currentEpoch < (uint64_t)epoch)
4089
                server.cluster->currentEpoch = epoch;
A
antirez 已提交
4090 4091 4092 4093 4094 4095 4096
            /* No need to fsync the config here since in the unlucky event
             * of a failure to persist the config, the conflict resolution code
             * will assign an unique config to this node. */
            clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|
                                 CLUSTER_TODO_SAVE_CONFIG);
            addReply(c,shared.ok);
        }
A
antirez 已提交
4097 4098 4099 4100 4101 4102 4103 4104 4105 4106
    } else if (!strcasecmp(c->argv[1]->ptr,"reset") &&
               (c->argc == 2 || c->argc == 3))
    {
        /* CLUSTER RESET [SOFT|HARD] */
        int hard = 0;

        /* Parse soft/hard argument. Default is soft. */
        if (c->argc == 3) {
            if (!strcasecmp(c->argv[2]->ptr,"hard")) {
                hard = 1;
4107
            } else if (!strcasecmp(c->argv[2]->ptr,"soft")) {
A
antirez 已提交
4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123
                hard = 0;
            } else {
                addReply(c,shared.syntaxerr);
                return;
            }
        }

        /* Slaves can be reset while containing data, but not master nodes
         * that must be empty. */
        if (nodeIsMaster(myself) && dictSize(c->db->dict) != 0) {
            addReplyError(c,"CLUSTER RESET can't be called with "
                            "master nodes containing keys");
            return;
        }
        clusterReset(hard);
        addReply(c,shared.ok);
A
antirez 已提交
4124 4125 4126 4127 4128 4129
    } else {
        addReplyError(c,"Wrong CLUSTER subcommand or number of arguments");
    }
}

/* -----------------------------------------------------------------------------
4130
 * DUMP, RESTORE and MIGRATE commands
A
antirez 已提交
4131 4132
 * -------------------------------------------------------------------------- */

4133 4134 4135
/* 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) {
4136 4137
    unsigned char buf[2];
    uint64_t crc;
4138 4139 4140 4141 4142 4143 4144 4145

    /* 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:
4146 4147 4148 4149 4150
     * ----------------+---------------------+---------------+
     * ... RDB payload | 2 bytes RDB version | 8 bytes CRC64 |
     * ----------------+---------------------+---------------+
     * RDB version and CRC are both in little endian.
     */
4151 4152

    /* RDB version */
4153 4154
    buf[0] = REDIS_RDB_VERSION & 0xff;
    buf[1] = (REDIS_RDB_VERSION >> 8) & 0xff;
4155 4156
    payload->io.buffer.ptr = sdscatlen(payload->io.buffer.ptr,buf,2);

4157
    /* CRC64 */
4158
    crc = crc64(0,(unsigned char*)payload->io.buffer.ptr,
4159 4160 4161
                sdslen(payload->io.buffer.ptr));
    memrev64ifbe(&crc);
    payload->io.buffer.ptr = sdscatlen(payload->io.buffer.ptr,&crc,8);
4162 4163 4164
}

/* Verify that the RDB version of the dump payload matches the one of this Redis
4165
 * instance and that the checksum is ok.
4166 4167 4168
 * If the DUMP payload looks valid REDIS_OK is returned, otherwise REDIS_ERR
 * is returned. */
int verifyDumpPayload(unsigned char *p, size_t len) {
4169
    unsigned char *footer;
4170
    uint16_t rdbver;
4171
    uint64_t crc;
4172

4173
    /* At least 2 bytes of RDB version and 8 of CRC64 should be present. */
4174 4175
    if (len < 10) return REDIS_ERR;
    footer = p+(len-10);
4176 4177

    /* Verify RDB version */
4178
    rdbver = (footer[1] << 8) | footer[0];
4179
    if (rdbver != REDIS_RDB_VERSION) return REDIS_ERR;
4180

4181
    /* Verify CRC64 */
4182
    crc = crc64(0,p,len-8);
4183 4184
    memrev64ifbe(&crc);
    return (memcmp(&crc,footer+2,8) == 0) ? REDIS_OK : REDIS_ERR;
4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209
}

/* 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 已提交
4210
/* RESTORE key ttl serialized-value [REPLACE] */
A
antirez 已提交
4211
void restoreCommand(redisClient *c) {
4212
    long long ttl;
4213
    rio payload;
A
antirez 已提交
4214
    int j, type, replace = 0;
4215
    robj *obj;
A
antirez 已提交
4216

A
antirez 已提交
4217 4218 4219 4220 4221 4222 4223 4224 4225 4226
    /* 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 已提交
4227
    /* Make sure this key does not already exist here... */
A
antirez 已提交
4228
    if (!replace && lookupKeyWrite(c->db,c->argv[1]) != NULL) {
4229
        addReply(c,shared.busykeyerr);
A
antirez 已提交
4230 4231 4232 4233
        return;
    }

    /* Check if the TTL value makes sense */
4234
    if (getLongLongFromObjectOrReply(c,c->argv[2],&ttl,NULL) != REDIS_OK) {
A
antirez 已提交
4235 4236 4237 4238 4239 4240
        return;
    } else if (ttl < 0) {
        addReplyError(c,"Invalid TTL value, must be >= 0");
        return;
    }

4241
    /* Verify RDB version and data checksum. */
4242 4243
    if (verifyDumpPayload(c->argv[3]->ptr,sdslen(c->argv[3]->ptr)) == REDIS_ERR)
    {
4244 4245 4246 4247
        addReplyError(c,"DUMP payload version or checksum are wrong");
        return;
    }

4248
    rioInitWithBuffer(&payload,c->argv[3]->ptr);
4249 4250
    if (((type = rdbLoadObjectType(&payload)) == -1) ||
        ((obj = rdbLoadObject(type,&payload)) == NULL))
4251
    {
4252
        addReplyError(c,"Bad data format");
A
antirez 已提交
4253 4254 4255
        return;
    }

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

A
antirez 已提交
4259
    /* Create the key and set the TTL if any */
4260
    dbAdd(c->db,c->argv[1],obj);
4261
    if (ttl) setExpire(c->db,c->argv[1],mstime()+ttl);
4262
    signalModifiedKey(c->db,c->argv[1]);
A
antirez 已提交
4263
    addReply(c,shared.ok);
4264
    server.dirty++;
A
antirez 已提交
4265 4266
}

A
antirez 已提交
4267 4268 4269 4270 4271 4272 4273
/* 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. */
M
Matt Stancliff 已提交
4274
#define MIGRATE_SOCKET_CACHE_TTL 10 /* close cached sockets after 10 sec. */
A
antirez 已提交
4275 4276 4277 4278 4279 4280

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

M
Matt Stancliff 已提交
4281
/* Return a TCP socket connected with the target instance, possibly returning
A
antirez 已提交
4282 4283 4284 4285 4286 4287 4288 4289
 * 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()
M
Matt Stancliff 已提交
4290
 * should be called so that the connection will be created from scratch
A
antirez 已提交
4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318
 * 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 */
4319 4320
    fd = anetTcpNonBlockBindConnect(server.neterr,c->argv[1]->ptr,
                atoi(c->argv[2]->ptr),REDIS_BIND_ADDR);
A
antirez 已提交
4321 4322 4323 4324 4325 4326
    if (fd == -1) {
        sdsfree(name);
        addReplyErrorFormat(c,"Can't connect to target node: %s",
            server.neterr);
        return -1;
    }
4327
    anetEnableTcpNoDelay(server.neterr,fd);
A
antirez 已提交
4328 4329

    /* Check if it connects within the specified timeout. */
4330
    if ((aeWait(fd,AE_WRITABLE,timeout) & AE_WRITABLE) == 0) {
A
antirez 已提交
4331
        sdsfree(name);
A
antirez 已提交
4332 4333
        addReplySds(c,
            sdsnew("-IOERR error or timeout connecting to the client\r\n"));
A
antirez 已提交
4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381
        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 已提交
4382
/* MIGRATE host port key dbid timeout [COPY | REPLACE] */
A
antirez 已提交
4383
void migrateCommand(redisClient *c) {
A
antirez 已提交
4384
    int fd, copy, replace, j;
A
antirez 已提交
4385 4386
    long timeout;
    long dbid;
A
antirez 已提交
4387
    long long ttl, expireat;
A
antirez 已提交
4388
    robj *o;
4389
    rio cmd, payload;
A
antirez 已提交
4390 4391 4392 4393 4394 4395 4396
    int retry_num = 0;

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

A
antirez 已提交
4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409
    /* 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 已提交
4410 4411 4412 4413 4414
    /* Sanity check */
    if (getLongFromObjectOrReply(c,c->argv[5],&timeout,NULL) != REDIS_OK)
        return;
    if (getLongFromObjectOrReply(c,c->argv[4],&dbid,NULL) != REDIS_OK)
        return;
4415
    if (timeout <= 0) timeout = 1000;
A
antirez 已提交
4416 4417 4418 4419 4420

    /* 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) {
4421
        addReplySds(c,sdsnew("+NOKEY\r\n"));
A
antirez 已提交
4422 4423
        return;
    }
4424

A
antirez 已提交
4425
    /* Connect */
A
antirez 已提交
4426 4427
    fd = migrateGetSocket(c,c->argv[1],c->argv[2],timeout);
    if (fd == -1) return; /* error sent to the client by migrateGetSocket() */
A
antirez 已提交
4428

4429
    /* Create RESTORE payload and generate the protocol to call the command. */
4430
    rioInitWithBuffer(&cmd,sdsempty());
4431 4432 4433
    redisAssertWithInfo(c,NULL,rioWriteBulkCount(&cmd,'*',2));
    redisAssertWithInfo(c,NULL,rioWriteBulkString(&cmd,"SELECT",6));
    redisAssertWithInfo(c,NULL,rioWriteBulkLongLong(&cmd,dbid));
A
antirez 已提交
4434

A
antirez 已提交
4435 4436 4437 4438 4439
    expireat = getExpire(c->db,c->argv[3]);
    if (expireat != -1) {
        ttl = expireat-mstime();
        if (ttl < 1) ttl = 1;
    }
A
antirez 已提交
4440
    redisAssertWithInfo(c,NULL,rioWriteBulkCount(&cmd,'*',replace ? 5 : 4));
4441 4442 4443 4444 4445
    if (server.cluster_enabled)
        redisAssertWithInfo(c,NULL,
            rioWriteBulkString(&cmd,"RESTORE-ASKING",14));
    else
        redisAssertWithInfo(c,NULL,rioWriteBulkString(&cmd,"RESTORE",7));
4446
    redisAssertWithInfo(c,NULL,sdsEncodedObject(c->argv[3]));
A
antirez 已提交
4447 4448
    redisAssertWithInfo(c,NULL,rioWriteBulkString(&cmd,c->argv[3]->ptr,
            sdslen(c->argv[3]->ptr)));
4449
    redisAssertWithInfo(c,NULL,rioWriteBulkLongLong(&cmd,ttl));
A
antirez 已提交
4450

G
guiquanz 已提交
4451
    /* Emit the payload argument, that is the serialized object using
A
antirez 已提交
4452
     * the DUMP format. */
4453 4454 4455
    createDumpPayload(&payload,o);
    redisAssertWithInfo(c,NULL,rioWriteBulkString(&cmd,payload.io.buffer.ptr,
                                sdslen(payload.io.buffer.ptr)));
4456 4457
    sdsfree(payload.io.buffer.ptr);

A
antirez 已提交
4458 4459 4460 4461 4462
    /* 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 已提交
4463
    /* Transfer the query to the other node in 64K chunks. */
A
antirez 已提交
4464
    errno = 0;
A
antirez 已提交
4465
    {
4466 4467 4468 4469 4470 4471
        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);
4472
            nwritten = syncWrite(fd,buf+pos,towrite,timeout);
4473 4474
            if (nwritten != (signed)towrite) goto socket_wr_err;
            pos += nwritten;
A
antirez 已提交
4475 4476 4477
        }
    }

4478
    /* Read back the reply. */
A
antirez 已提交
4479 4480 4481 4482 4483 4484 4485 4486
    {
        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)
4487
            goto socket_rd_err;
A
antirez 已提交
4488 4489 4490 4491
        if (buf1[0] == '-' || buf2[0] == '-') {
            addReplyErrorFormat(c,"Target instance replied with error: %s",
                (buf1[0] == '-') ? buf1+1 : buf2+1);
        } else {
4492 4493
            robj *aux;

A
antirez 已提交
4494 4495 4496 4497 4498
            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 已提交
4499
            addReply(c,shared.ok);
4500 4501 4502
            server.dirty++;

            /* Translate MIGRATE as DEL for replication/AOF. */
A
antirez 已提交
4503
            aux = createStringObject("DEL",3);
4504 4505
            rewriteClientCommandVector(c,2,aux,c->argv[3]);
            decrRefCount(aux);
A
antirez 已提交
4506 4507 4508
        }
    }

4509
    sdsfree(cmd.io.buffer.ptr);
4510
    return;
A
antirez 已提交
4511 4512

socket_wr_err:
4513
    sdsfree(cmd.io.buffer.ptr);
A
antirez 已提交
4514
    migrateCloseSocket(c->argv[1],c->argv[2]);
A
antirez 已提交
4515 4516 4517
    if (errno != ETIMEDOUT && retry_num++ == 0) goto try_again;
    addReplySds(c,
        sdsnew("-IOERR error or timeout writing to target instance\r\n"));
4518
    return;
A
antirez 已提交
4519 4520

socket_rd_err:
4521
    sdsfree(cmd.io.buffer.ptr);
A
antirez 已提交
4522
    migrateCloseSocket(c->argv[1],c->argv[2]);
A
antirez 已提交
4523 4524 4525
    if (errno != ETIMEDOUT && retry_num++ == 0) goto try_again;
    addReplySds(c,
        sdsnew("-IOERR error or timeout reading from target node\r\n"));
4526 4527 4528
    return;
}

4529 4530 4531 4532
/* -----------------------------------------------------------------------------
 * Cluster functions related to serving / redirecting clients
 * -------------------------------------------------------------------------- */

4533
/* The ASKING command is required after a -ASK redirection.
G
guiquanz 已提交
4534
 * The client should issue ASKING before to actually send the command to
4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545
 * 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);
}

M
Matt Stancliff 已提交
4546
/* The READONLY command is used by clients to enter the read-only mode.
4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562
 * 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 已提交
4563

4564
/* Return the pointer to the cluster node that is able to serve the command.
4565
 * For the function to succeed the command should only target either:
A
antirez 已提交
4566
 *
4567 4568 4569
 * 1) A single key (even multiple times like LPOPRPUSH mylist mylist).
 * 2) Multiple keys in the same hash slot, while the slot is stable (no
 *    resharding in progress).
4570
 *
4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588
 * On success the function returns the node that is able to serve the request.
 * If the node is not 'myself' a redirection must be perfomed. The kind of
 * redirection is specified setting the integer passed by reference
 * 'error_code', which will be set to REDIS_CLUSTER_REDIR_ASK or
 * REDIS_CLUSTER_REDIR_MOVED.
 *
 * When the node is 'myself' 'error_code' is set to REDIS_CLUSTER_REDIR_NONE.
 *
 * If the command fails NULL is returned, and the reason of the failure is
 * provided via 'error_code', which will be set to:
 *
 * REDIS_CLUSTER_REDIR_CROSS_SLOT if the request contains multiple keys that
 * don't belong to the same hash slot.
 *
 * REDIS_CLUSTER_REDIR_UNSTABLE if the request contains mutliple keys
 * belonging to the same slot, but the slot is not stable (in migration or
 * importing state, likely because a resharding is in progress). */
clusterNode *getNodeByQuery(redisClient *c, struct redisCommand *cmd, robj **argv, int argc, int *hashslot, int *error_code) {
A
antirez 已提交
4589
    clusterNode *n = NULL;
4590
    robj *firstkey = NULL;
4591
    int multiple_keys = 0;
A
antirez 已提交
4592 4593
    multiState *ms, _ms;
    multiCmd mc;
4594 4595 4596 4597
    int i, slot = 0, migrating_slot = 0, importing_slot = 0, missing_keys = 0;

    /* Set error code optimistically for the base case. */
    if (error_code) *error_code = REDIS_CLUSTER_REDIR_NONE;
A
antirez 已提交
4598 4599 4600 4601 4602 4603

    /* 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. */
4604
        if (!(c->flags & REDIS_MULTI)) return myself;
A
antirez 已提交
4605 4606
        ms = &c->mstate;
    } else {
4607 4608 4609
        /* 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 已提交
4610 4611 4612 4613 4614 4615 4616 4617
        ms = &_ms;
        _ms.commands = &mc;
        _ms.count = 1;
        mc.argv = argv;
        mc.argc = argc;
        mc.cmd = cmd;
    }

4618 4619
    /* Check that all the keys are in the same hash slot, and obtain this
     * slot and the node associated. */
A
antirez 已提交
4620 4621 4622 4623 4624 4625 4626 4627 4628
    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;

4629
        keyindex = getKeysFromCommand(mcmd,margv,margc,&numkeys);
A
antirez 已提交
4630
        for (j = 0; j < numkeys; j++) {
4631 4632 4633 4634
            robj *thiskey = margv[keyindex[j]];
            int thisslot = keyHashSlot((char*)thiskey->ptr,
                                       sdslen(thiskey->ptr));

4635 4636 4637
            if (firstkey == NULL) {
                /* This is the first key we see. Check what is the slot
                 * and node. */
4638 4639
                firstkey = thiskey;
                slot = thisslot;
4640
                n = server.cluster->slots[slot];
4641
                redisAssertWithInfo(c,firstkey,n != NULL);
4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653
                /* If we are migrating or importing this slot, we need to check
                 * if we have all the keys in the request (the only way we
                 * can safely serve the request, otherwise we return a TRYAGAIN
                 * error). To do so we set the importing/migrating state and
                 * increment a counter for every missing key. */
                if (n == myself &&
                    server.cluster->migrating_slots_to[slot] != NULL)
                {
                    migrating_slot = 1;
                } else if (server.cluster->importing_slots_from[slot] != NULL) {
                    importing_slot = 1;
                }
A
antirez 已提交
4654
            } else {
4655 4656
                /* If it is not the first key, make sure it is exactly
                 * the same key as the first we saw. */
4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668
                if (!equalStringObjects(firstkey,thiskey)) {
                    if (slot != thisslot) {
                        /* Error: multiple keys from different slots. */
                        getKeysFreeResult(keyindex);
                        if (error_code)
                            *error_code = REDIS_CLUSTER_REDIR_CROSS_SLOT;
                        return NULL;
                    } else {
                        /* Flag this request as one with multiple different
                         * keys. */
                        multiple_keys = 1;
                    }
4669
                }
A
antirez 已提交
4670
            }
4671 4672 4673 4674 4675 4676 4677

            /* Migarting / Improrting slot? Count keys we don't have. */
            if ((migrating_slot || importing_slot) &&
                lookupKeyRead(&server.db[0],thiskey) == NULL)
            {
                missing_keys++;
            }
A
antirez 已提交
4678 4679 4680
        }
        getKeysFreeResult(keyindex);
    }
4681

4682
    /* No key at all in command? then we can serve the request
4683
     * without redirections or errors. */
4684
    if (n == NULL) return myself;
4685 4686

    /* Return the hashslot by reference. */
4687
    if (hashslot) *hashslot = slot;
4688

4689
    /* This request is about a slot we are migrating into another instance?
4690 4691 4692 4693 4694 4695 4696 4697 4698
     * Then if we have all the keys. */

    /* If we don't have all the keys and we are migrating the slot, send
     * an ASK redirection. */
    if (migrating_slot && missing_keys) {
        if (error_code) *error_code = REDIS_CLUSTER_REDIR_ASK;
        return server.cluster->migrating_slots_to[slot];
    }

4699 4700 4701 4702
    /* If we are receiving the slot, and the client correctly flagged the
     * request as "ASKING", we can serve the request. However if the request
     * involves multiple keys and we don't have them all, the only option is
     * to send a TRYAGAIN error. */
4703 4704 4705
    if (importing_slot &&
        (c->flags & REDIS_ASKING || cmd->flags & REDIS_CMD_ASKING))
    {
4706
        if (multiple_keys && missing_keys) {
4707 4708 4709 4710 4711
            if (error_code) *error_code = REDIS_CLUSTER_REDIR_UNSTABLE;
            return NULL;
        } else {
            return myself;
        }
4712
    }
4713

4714 4715 4716 4717 4718
    /* 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 &&
4719
        nodeIsSlave(myself) &&
4720
        myself->slaveof == n)
4721
    {
4722
        return myself;
4723
    }
4724 4725 4726 4727

    /* Base case: just return the right node. However if this node is not
     * myself, set error_code to MOVED since we need to issue a rediretion. */
    if (n != myself && error_code) *error_code = REDIS_CLUSTER_REDIR_MOVED;
4728
    return n;
A
antirez 已提交
4729
}