cluster.c 178.0 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;
    }

A
antirez 已提交
127 128
    /* Parse the file. Note that single liens of the cluster config file can
     * be really long as they include all the hash slots of the node.
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 167 168 169
                            strtoull(argv[j+1],NULL,10);
                } else {
                    redisLog(REDIS_WARNING,
                        "Skipping unknown cluster config variable '%s'",
                        argv[j]);
                }
            }
            continue;
        }

170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
        /* Create this node if it does not exist */
        n = clusterLookupNode(argv[0]);
        if (!n) {
            n = createClusterNode(argv[0],0);
            clusterAddNode(n);
        }
        /* Address and port */
        if ((p = strchr(argv[1],':')) == NULL) goto fmterr;
        *p = '\0';
        memcpy(n->ip,argv[1],strlen(argv[1])+1);
        n->port = atoi(p+1);

        /* Parse flags */
        p = s = argv[2];
        while(p) {
            p = strchr(s,',');
            if (p) *p = '\0';
            if (!strcasecmp(s,"myself")) {
188
                redisAssert(server.cluster->myself == NULL);
189
                myself = server.cluster->myself = n;
190 191 192 193 194 195 196 197 198
                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;
199
                n->fail_time = mstime();
200 201 202 203
            } else if (!strcasecmp(s,"handshake")) {
                n->flags |= REDIS_NODE_HANDSHAKE;
            } else if (!strcasecmp(s,"noaddr")) {
                n->flags |= REDIS_NODE_NOADDR;
204 205
            } else if (!strcasecmp(s,"noflags")) {
                /* nothing to do */
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
            } 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);
        }

224
        /* Set ping sent / pong received timestamps */
225 226
        if (atoi(argv[4])) n->ping_sent = mstime();
        if (atoi(argv[5])) n->pong_received = mstime();
227

228 229 230
        /* Set configEpoch for this node. */
        n->configEpoch = strtoull(argv[6],NULL,10);

231
        /* Populate hash slots served by this instance. */
232
        for (j = 8; j < argc; j++) {
233 234
            int start, stop;

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

268
        sdsfreesplitres(argv,argc);
A
antirez 已提交
269 270
    }
    zfree(line);
A
antirez 已提交
271 272
    fclose(fp);

A
antirez 已提交
273
    /* Config sanity check */
274
    redisAssert(server.cluster->myself != NULL);
275
    redisLog(REDIS_NOTICE,"Node configuration loaded, I'm %.40s", myself->name);
276 277 278 279 280 281 282

    /* 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 已提交
283 284 285
    return REDIS_OK;

fmterr:
A
antirez 已提交
286 287
    redisLog(REDIS_WARNING,
        "Unrecoverable error: corrupted cluster config file.");
288
    zfree(line);
A
antirez 已提交
289 290 291 292
    fclose(fp);
    exit(1);
}

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

311 312
    server.cluster->todo_before_sleep &= ~CLUSTER_TODO_SAVE_CONFIG;

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

321
    if ((fd = open(server.cluster_configfile,O_WRONLY|O_CREAT,0644))
A
antirez 已提交
322
        == -1) goto err;
323 324 325

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

    /* 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 已提交
342 343 344 345 346
    close(fd);
    sdsfree(ci);
    return 0;

err:
347
    if (fd != -1) close(fd);
A
antirez 已提交
348 349 350 351
    sdsfree(ci);
    return -1;
}

A
antirez 已提交
352 353
void clusterSaveConfigOrDie(int do_fsync) {
    if (clusterSaveConfig(do_fsync) == -1) {
354 355 356 357 358
        redisLog(REDIS_WARNING,"Fatal: can't update cluster config file.");
        exit(1);
    }
}

359 360 361 362 363 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
/* 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 已提交
399
void clusterInit(void) {
400
    int saveconf = 0;
401

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

    /* 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. */
427
    if (clusterLoadConfig(server.cluster_configfile) == REDIS_ERR) {
A
antirez 已提交
428 429
        /* No configuration found. We will just use the random name provided
         * by the createClusterNode() function. */
430
        myself = server.cluster->myself =
431
            createClusterNode(NULL,REDIS_NODE_MYSELF|REDIS_NODE_MASTER);
A
antirez 已提交
432
        redisLog(REDIS_NOTICE,"No cluster configuration found, I'm %.40s",
433 434
            myself->name);
        clusterAddNode(myself);
435 436
        saveconf = 1;
    }
A
antirez 已提交
437
    if (saveconf) clusterSaveConfigOrDie(1);
438 439

    /* We need a listening TCP port for our cluster messaging needs. */
440
    server.cfd_count = 0;
441 442

    /* Port sanity check II
A
antirez 已提交
443 444
     * The other handshake port check is triggered too late to stop
     * us from trying to use a too-high cluster port number. */
445 446 447 448 449 450
    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 已提交
451
        exit(1);
452 453
    }

454 455 456 457
    if (listenToPort(server.port+REDIS_CLUSTER_PORT_INCR,
        server.cfd,&server.cfd_count) == REDIS_ERR)
    {
        exit(1);
458 459 460 461 462 463 464 465 466
    } 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 已提交
467
    }
468 469

    /* The slots -> keys map is a sorted set. Init it. */
470
    server.cluster->slots_to_keys = zslCreate();
A
antirez 已提交
471 472 473 474 475

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

476
    resetManualFailover();
A
antirez 已提交
477 478
}

A
antirez 已提交
479 480 481 482 483 484 485
/* 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.
486 487
 * 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 已提交
488 489 490 491 492 493 494 495 496
void clusterReset(int hard) {
    dictIterator *di;
    dictEntry *de;
    int j;

    /* Turn into master. */
    if (nodeIsSlave(myself)) {
        clusterSetNodeAsMaster(myself);
        replicationUnsetMaster();
497
        emptyDb(NULL);
A
antirez 已提交
498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523
    }

    /* 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;
524
        redisLog(REDIS_WARNING, "configEpoch set to 0 via CLUSTER RESET HARD");
A
antirez 已提交
525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540

        /* 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 已提交
541 542 543 544 545 546
/* -----------------------------------------------------------------------------
 * CLUSTER communication link
 * -------------------------------------------------------------------------- */

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

571
#define MAX_CLUSTER_ACCEPTS_PER_CALL 1000
A
antirez 已提交
572 573
void clusterAcceptHandler(aeEventLoop *el, int fd, void *privdata, int mask) {
    int cport, cfd;
574
    int max = MAX_CLUSTER_ACCEPTS_PER_CALL;
575
    char cip[REDIS_IP_STR_LEN];
A
antirez 已提交
576 577 578 579 580
    clusterLink *link;
    REDIS_NOTUSED(el);
    REDIS_NOTUSED(mask);
    REDIS_NOTUSED(privdata);

581 582 583 584
    /* 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;

585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605
    while(max--) {
        cfd = anetTcpAccept(server.neterr, fd, cip, sizeof(cip), &cport);
        if (cfd == ANET_ERR) {
            if (errno != EWOULDBLOCK)
                redisLog(REDIS_VERBOSE,
                    "Accepting cluster node: %s", server.neterr);
            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 已提交
606 607 608 609 610 611 612
    }
}

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

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

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

679 680 681 682 683
/* 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
684 685 686 687 688 689
 * '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) {
690 691 692 693 694 695 696 697 698 699 700
    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) {
701
            fr->time = mstime();
702
            return 0;
703 704 705 706 707 708
        }
    }

    /* Otherwise create a new report. */
    fr = zmalloc(sizeof(*fr));
    fr->node = sender;
709
    fr->time = mstime();
710
    listAddNodeTail(l,fr);
711
    return 1;
712 713
}

714 715 716 717 718 719 720 721 722 723
/* 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;
724
    mstime_t maxtime = server.cluster_node_timeout *
725
                     REDIS_CLUSTER_FAIL_REPORT_VALIDITY_MULT;
726
    mstime_t now = mstime();
727 728 729 730 731 732 733 734

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

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

    /* Remove the failure report. */
    listDelNode(l,ln);
762
    clusterNodeCleanupFailureReports(node);
763
    return 1;
764 765
}

766 767 768 769 770 771 772 773
/* 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 已提交
774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803
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;
804
    n->slaves = NULL;
A
antirez 已提交
805 806
}

807 808 809 810 811 812 813 814
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 已提交
815 816
void freeClusterNode(clusterNode *n) {
    sds nodename;
817

A
antirez 已提交
818
    nodename = sdsnewlen(n->name, REDIS_CLUSTER_NAMELEN);
819
    redisAssert(dictDelete(server.cluster->nodes,nodename) == DICT_OK);
A
antirez 已提交
820 821 822
    sdsfree(nodename);
    if (n->slaveof) clusterNodeRemoveSlave(n->slaveof, n);
    if (n->link) freeClusterLink(n->link);
823
    listRelease(n->fail_reports);
A
antirez 已提交
824 825 826 827 828 829
    zfree(n);
}

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

831
    retval = dictAdd(server.cluster->nodes,
A
antirez 已提交
832 833 834 835
            sdsnewlen(node->name,REDIS_CLUSTER_NAMELEN), node);
    return (retval == DICT_OK) ? REDIS_OK : REDIS_ERR;
}

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

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

867 868 869 870 871
    /* 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 已提交
872 873 874
    freeClusterNode(delnode);
}

A
antirez 已提交
875 876 877
/* Node lookup by name */
clusterNode *clusterLookupNode(char *name) {
    sds s = sdsnewlen(name, REDIS_CLUSTER_NAMELEN);
A
antirez 已提交
878
    dictEntry *de;
A
antirez 已提交
879

880
    de = dictFind(server.cluster->nodes,s);
A
antirez 已提交
881 882
    sdsfree(s);
    if (de == NULL) return NULL;
883
    return dictGetVal(de);
A
antirez 已提交
884 885 886 887 888 889 890 891 892
}

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

A
antirez 已提交
894 895
    redisLog(REDIS_DEBUG,"Renaming node %.40s into %.40s",
        node->name, newname);
896
    retval = dictDelete(server.cluster->nodes, s);
A
antirez 已提交
897 898 899 900 901 902
    sdsfree(s);
    redisAssert(retval == DICT_OK);
    memcpy(node->name, newname, REDIS_CLUSTER_NAMELEN);
    clusterAddNode(node);
}

903 904 905 906 907 908 909 910 911 912 913 914 915 916
/* -----------------------------------------------------------------------------
 * 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
917
 * in the cluster without dealing with the problem of other nodes re-adding
918 919
 * back the node to nodes we already sent the FORGET command to.
 *
920
 * The data structure used is a hash table with an sds string representing
921 922 923 924 925 926 927 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
 * 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();
954 955 956 957 958 959
    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);
960
    dictSetUnsignedIntegerVal(de,time(NULL)+REDIS_CLUSTER_BLACKLIST_TTL);
961
    sdsfree(id);
962 963 964 965 966 967 968 969 970
}

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

971
    clusterBlacklistCleanup();
972 973 974 975 976
    retval = dictFind(server.cluster->nodes_black_list,id) != NULL;
    sdsfree(id);
    return retval;
}

A
antirez 已提交
977 978 979 980
/* -----------------------------------------------------------------------------
 * CLUSTER messages exchange - PING/PONG and gossip
 * -------------------------------------------------------------------------- */

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

1006 1007
    if (!nodeTimedOut(node)) return; /* We can reach it. */
    if (nodeFailed(node)) return; /* Already FAILing. */
1008

1009 1010
    failures = clusterNodeFailureReportsCount(node);
    /* Also count myself as a voter if I'm a master. */
1011
    if (nodeIsMaster(myself)) failures++;
1012
    if (failures < needed_quorum) return; /* No weak agreement from masters. */
1013 1014 1015 1016 1017 1018 1019

    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;
1020
    node->fail_time = mstime();
1021

1022 1023
    /* Broadcast the failing node name to everybody, forcing all the other
     * reachable nodes to flag the node as FAIL. */
1024
    if (nodeIsMaster(myself)) clusterSendFail(node->name);
A
antirez 已提交
1025
    clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
1026 1027 1028 1029
}

/* 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
1030
 * state. */
1031
void clearNodeFailureIfNeeded(clusterNode *node) {
1032
    mstime_t now = mstime();
A
antirez 已提交
1033

1034
    redisAssert(nodeFailed(node));
A
antirez 已提交
1035 1036 1037

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

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

1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073
/* 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);

1074
        if (!nodeInHandshake(node)) continue;
1075 1076 1077 1078 1079 1080
        if (!strcasecmp(node->ip,ip) && node->port == port) break;
    }
    dictReleaseIterator(di);
    return de != NULL;
}

1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117
/* Start an handshake with the specified address if there is not one
 * already in progress. Returns non-zero if the handshake was actually
 * started. On error zero is returned and errno is set to one of the
 * following values:
 *
 * EAGAIN - There is already an handshake in progress for this address.
 * EINVAL - IP or port are not valid. */
int clusterStartHandshake(char *ip, int port) {
    clusterNode *n;
    char norm_ip[REDIS_IP_STR_LEN];
    struct sockaddr_storage sa;

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

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

    /* Set norm_ip as the normalized string representation of the node
     * IP address. */
    if (sa.ss_family == AF_INET)
        inet_ntop(AF_INET,
            (void*)&(((struct sockaddr_in *)&sa)->sin_addr),
1118
            norm_ip,REDIS_IP_STR_LEN);
1119 1120 1121
    else
        inet_ntop(AF_INET6,
            (void*)&(((struct sockaddr_in6 *)&sa)->sin6_addr),
1122
            norm_ip,REDIS_IP_STR_LEN);
1123 1124 1125 1126 1127 1128 1129 1130 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
     * handskake. */
    n = createClusterNode(NULL,REDIS_NODE_HANDSHAKE|REDIS_NODE_MEET);
    memcpy(n->ip,norm_ip,sizeof(n->ip));
    n->port = port;
    clusterAddNode(n);
    return 1;
}

A
antirez 已提交
1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150
/* 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;
1151
        sds ci;
A
antirez 已提交
1152

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

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

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

1213
/* IP -> string conversion. 'buf' is supposed to at least be 46 bytes. */
A
antirez 已提交
1214
void nodeIp2String(char *buf, clusterLink *link) {
1215
    anetPeerToString(link->fd, buf, REDIS_IP_STR_LEN, NULL);
A
antirez 已提交
1216 1217 1218
}

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

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

1257 1258 1259 1260
/* 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) {
1261
    if (nodeIsMaster(n)) return;
1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283

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

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

/* This function is called when we receive a master configuration via a
 * PING, PONG or UPDATE packet. What we receive is a node, a configEpoch of the
 * node, and the set of slots claimed under this configEpoch.
 *
 * What we do is to rebind the slots with newer configuration compared to our
 * local configuration, and if needed, we turn ourself into a replica of the
 * node (see the function comments for more info).
 *
 * The 'sender' is the node for which we received a configuration update.
 * Sometimes it is not actaully the "Sender" of the information, like in the case
 * we receive the info via an UPDATE packet. */
1284
void clusterUpdateSlotsConfigWith(clusterNode *sender, uint64_t senderConfigEpoch, unsigned char *slots) {
1285 1286
    int j;
    clusterNode *curmaster, *newmaster = NULL;
1287 1288 1289 1290 1291 1292 1293 1294 1295
    /* 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;
1296 1297 1298 1299

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

1302 1303 1304 1305 1306
    if (sender == myself) {
        redisLog(REDIS_WARNING,"Discarding UPDATE message about myself.");
        return;
    }

1307 1308
    for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
        if (bitmapTestBit(slots,j)) {
1309 1310 1311 1312 1313 1314 1315 1316 1317
            /* 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;

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

1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353
                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 已提交
1354 1355 1356
        redisLog(REDIS_WARNING,
            "Configuration change detected. Reconfiguring myself "
            "as a replica of %.40s", sender->name);
1357 1358 1359 1360
        clusterSetMaster(sender);
        clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                             CLUSTER_TODO_UPDATE_STATE|
                             CLUSTER_TODO_FSYNC_CONFIG);
1361 1362 1363 1364 1365 1366 1367 1368 1369 1370
    } 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]);
1371 1372 1373
    }
}

1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426
/* 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. */
1427 1428
    server.cluster->currentEpoch++;
    myself->configEpoch = server.cluster->currentEpoch;
1429 1430 1431
    clusterSaveConfigOrDie(1);
    redisLog(REDIS_VERBOSE,
        "WARNING: configEpoch collision with node %.40s."
1432
        " configEpoch set to %llu",
1433 1434 1435 1436
        sender->name,
        (unsigned long long) myself->configEpoch);
}

A
antirez 已提交
1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449
/* 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 已提交
1450
    uint16_t flags = ntohs(hdr->flags);
1451
    uint64_t senderCurrentEpoch = 0, senderConfigEpoch = 0;
A
antirez 已提交
1452 1453
    clusterNode *sender;

1454
    server.cluster->stats_bus_messages_received++;
1455 1456
    redisLog(REDIS_DEBUG,"--- Processing packet of type %d, %lu bytes",
        type, (unsigned long) totlen);
1457 1458

    /* Perform sanity checks */
1459
    if (totlen < 16) return 1; /* At least signature, version, totlen, count. */
A
antirez 已提交
1460
    if (ntohs(hdr->ver) != 0) return 1; /* Can't handle versions other than 0.*/
A
antirez 已提交
1461 1462 1463 1464 1465 1466 1467 1468 1469 1470
    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;
1471
    } else if (type == CLUSTERMSG_TYPE_FAIL) {
A
antirez 已提交
1472 1473 1474 1475
        uint32_t explen = sizeof(clusterMsg)-sizeof(union clusterMsgData);

        explen += sizeof(clusterMsgDataFail);
        if (totlen != explen) return 1;
1476
    } else if (type == CLUSTERMSG_TYPE_PUBLISH) {
1477 1478 1479 1480 1481 1482
        uint32_t explen = sizeof(clusterMsg)-sizeof(union clusterMsgData);

        explen += sizeof(clusterMsgDataPublish) +
                ntohl(hdr->data.publish.msg.channel_len) +
                ntohl(hdr->data.publish.msg.message_len);
        if (totlen != explen) return 1;
1483
    } else if (type == CLUSTERMSG_TYPE_FAILOVER_AUTH_REQUEST ||
1484 1485 1486
               type == CLUSTERMSG_TYPE_FAILOVER_AUTH_ACK ||
               type == CLUSTERMSG_TYPE_MFSTART)
    {
1487 1488
        uint32_t explen = sizeof(clusterMsg)-sizeof(union clusterMsgData);

1489 1490 1491 1492 1493
        if (totlen != explen) return 1;
    } else if (type == CLUSTERMSG_TYPE_UPDATE) {
        uint32_t explen = sizeof(clusterMsg)-sizeof(union clusterMsgData);

        explen += sizeof(clusterMsgDataUpdate);
1494
        if (totlen != explen) return 1;
1495
    }
A
antirez 已提交
1496

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

1530
    /* Process packets by type. */
A
antirez 已提交
1531
    if (type == CLUSTERMSG_TYPE_PING || type == CLUSTERMSG_TYPE_MEET) {
1532
        redisLog(REDIS_DEBUG,"Ping packet received: %p", (void*)link->node);
A
antirez 已提交
1533

A
antirez 已提交
1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553
        /* 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
         * address in the cluster without it being hardcoded in the config. */
        if (type == CLUSTERMSG_TYPE_MEET) {
            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 已提交
1554 1555 1556
        /* 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
1557
         * resolved when we'll receive PONGs from the node. */
A
antirez 已提交
1558 1559 1560 1561 1562 1563 1564
        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 已提交
1565
            clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG);
A
antirez 已提交
1566 1567 1568 1569 1570 1571 1572
        }

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

        /* Anyway reply with a PONG */
        clusterSendPing(link,CLUSTERMSG_TYPE_PONG);
1573 1574 1575
    }

    /* PING or PONG: process config information. */
1576 1577 1578
    if (type == CLUSTERMSG_TYPE_PING || type == CLUSTERMSG_TYPE_PONG ||
        type == CLUSTERMSG_TYPE_MEET)
    {
1579 1580 1581
        redisLog(REDIS_DEBUG,"%s packet received: %p",
            type == CLUSTERMSG_TYPE_PING ? "ping" : "pong",
            (void*)link->node);
A
antirez 已提交
1582
        if (link->node) {
1583
            if (nodeInHandshake(link->node)) {
A
antirez 已提交
1584 1585 1586
                /* If we already have this node, try to change the
                 * IP/port of the node with the new one. */
                if (sender) {
1587
                    redisLog(REDIS_VERBOSE,
A
antirez 已提交
1588 1589
                        "Handshake: we already know node %.40s, "
                        "updating the address if needed.", sender->name);
A
antirez 已提交
1590 1591
                    if (nodeUpdateAddressIfNeeded(sender,link,ntohs(hdr->port)))
                    {
A
antirez 已提交
1592 1593
                        clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                                             CLUSTER_TODO_UPDATE_STATE);
A
antirez 已提交
1594 1595 1596 1597
                    }
                    /* Free this node as we alrady have it. This will
                     * cause the link to be freed as well. */
                    freeClusterNode(link->node);
A
antirez 已提交
1598 1599 1600 1601
                    return 0;
                }

                /* First thing to do is replacing the random name with the
1602
                 * right node name if this was a handshake stage. */
A
antirez 已提交
1603 1604 1605 1606
                clusterRenameNode(link->node, hdr->sender);
                redisLog(REDIS_DEBUG,"Handshake with node %.40s completed.",
                    link->node->name);
                link->node->flags &= ~REDIS_NODE_HANDSHAKE;
1607
                link->node->flags |= flags&(REDIS_NODE_MASTER|REDIS_NODE_SLAVE);
A
antirez 已提交
1608
                clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG);
A
antirez 已提交
1609 1610 1611 1612 1613 1614 1615 1616
            } 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;
1617 1618
                link->node->ip[0] = '\0';
                link->node->port = 0;
A
antirez 已提交
1619
                freeClusterLink(link);
A
antirez 已提交
1620
                clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG);
A
antirez 已提交
1621 1622 1623
                return 0;
            }
        }
1624

A
antirez 已提交
1625 1626
        /* Update the node address if it changed. */
        if (sender && type == CLUSTERMSG_TYPE_PING &&
1627
            !nodeInHandshake(sender) &&
A
antirez 已提交
1628 1629
            nodeUpdateAddressIfNeeded(sender,link,ntohs(hdr->port)))
        {
A
antirez 已提交
1630 1631
            clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                                 CLUSTER_TODO_UPDATE_STATE);
A
antirez 已提交
1632 1633
        }

A
antirez 已提交
1634
        /* Update our info about the node */
1635
        if (link->node && type == CLUSTERMSG_TYPE_PONG) {
1636
            link->node->pong_received = mstime();
1637 1638 1639
            link->node->ping_sent = 0;

            /* The PFAIL condition can be reversed without external
1640
             * help if it is momentary (that is, if it does not
1641 1642 1643 1644
             * turn into a FAIL state).
             *
             * The FAIL condition is also reversible under specific
             * conditions detected by clearNodeFailureIfNeeded(). */
1645
            if (nodeTimedOut(link->node)) {
1646
                link->node->flags &= ~REDIS_NODE_PFAIL;
A
antirez 已提交
1647 1648
                clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                                     CLUSTER_TODO_UPDATE_STATE);
1649
            } else if (nodeFailed(link->node)) {
1650 1651 1652
                clearNodeFailureIfNeeded(link->node);
            }
        }
A
antirez 已提交
1653

1654
        /* Check for role switch: slave -> master or master -> slave. */
A
antirez 已提交
1655 1656 1657 1658
        if (sender) {
            if (!memcmp(hdr->slaveof,REDIS_NODE_NULL_NAME,
                sizeof(hdr->slaveof)))
            {
1659
                /* Node is a master. */
1660
                clusterSetNodeAsMaster(sender);
A
antirez 已提交
1661
            } else {
1662
                /* Node is a slave. */
A
antirez 已提交
1663 1664
                clusterNode *master = clusterLookupNode(hdr->slaveof);

1665
                if (nodeIsMaster(sender)) {
1666
                    /* Master turned into a slave! Reconfigure the node. */
1667
                    clusterDelNodeSlots(sender);
1668 1669
                    sender->flags &= ~REDIS_NODE_MASTER;
                    sender->flags |= REDIS_NODE_SLAVE;
1670

1671 1672
                    /* Remove the list of slaves from the node. */
                    if (sender->numslaves) clusterNodeResetSlaves(sender);
1673 1674

                    /* Update config and state. */
A
antirez 已提交
1675 1676
                    clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                                         CLUSTER_TODO_UPDATE_STATE);
1677 1678
                }

1679
                /* Master node changed for this slave? */
1680
                if (master && sender->slaveof != master) {
1681 1682
                    if (sender->slaveof)
                        clusterNodeRemoveSlave(sender->slaveof,sender);
1683 1684
                    clusterNodeAddSlave(master,sender);
                    sender->slaveof = master;
1685 1686

                    /* Update config. */
A
antirez 已提交
1687
                    clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG);
1688
                }
A
antirez 已提交
1689 1690 1691
            }
        }

1692
        /* Update our info about served slots.
1693
         *
1694 1695
         * Note: this MUST happen after we update the master/slave state
         * so that REDIS_NODE_MASTER flag will be set. */
1696 1697

        /* Many checks are only needed if the set of served slots this
1698 1699 1700 1701
         * 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. */
1702 1703 1704
        int dirty_slots = 0; /* Sender claimed slots don't match my view? */

        if (sender) {
1705
            sender_master = nodeIsMaster(sender) ? sender : sender->slaveof;
1706 1707 1708 1709 1710 1711
            if (sender_master) {
                dirty_slots = memcmp(sender_master->slots,
                        hdr->myslots,sizeof(hdr->myslots)) != 0;
            }
        }

1712 1713 1714
        /* 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. */
1715
        if (sender && nodeIsMaster(sender) && dirty_slots)
1716
            clusterUpdateSlotsConfigWith(sender,senderConfigEpoch,hdr->myslots);
1717

1718 1719 1720
        /* 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.
1721
         *
1722 1723 1724 1725
         * 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:
1726 1727 1728 1729 1730 1731
         *
         * 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
1732 1733 1734 1735
         * 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). */
1736 1737 1738 1739 1740 1741 1742 1743 1744 1745
        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)
                    {
1746
                        redisLog(REDIS_VERBOSE,
1747
                            "Node %.40s has old slots configuration, sending "
1748
                            "an UPDATE message about %.40s",
1749
                                sender->name, server.cluster->slots[j]->name);
A
antirez 已提交
1750 1751
                        clusterSendUpdate(sender->link,
                            server.cluster->slots[j]);
1752 1753 1754 1755 1756

                        /* TODO: instead of exiting the loop send every other
                         * UPDATE packet for other nodes that are the new owner
                         * of sender's slots. */
                        break;
1757
                    }
1758
                }
A
antirez 已提交
1759 1760 1761
            }
        }

1762 1763 1764 1765 1766 1767 1768 1769 1770
        /* 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 已提交
1771 1772
        /* Get info from the gossip section */
        clusterProcessGossipSection(hdr,link);
1773
    } else if (type == CLUSTERMSG_TYPE_FAIL) {
A
antirez 已提交
1774 1775
        clusterNode *failing;

1776 1777
        if (sender) {
            failing = clusterLookupNode(hdr->data.fail.about.nodename);
1778 1779
            if (failing &&
                !(failing->flags & (REDIS_NODE_FAIL|REDIS_NODE_MYSELF)))
1780 1781 1782 1783 1784
            {
                redisLog(REDIS_NOTICE,
                    "FAIL message received from %.40s about %.40s",
                    hdr->sender, hdr->data.fail.about.nodename);
                failing->flags |= REDIS_NODE_FAIL;
1785
                failing->fail_time = mstime();
1786
                failing->flags &= ~REDIS_NODE_PFAIL;
A
antirez 已提交
1787 1788
                clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                                     CLUSTER_TODO_UPDATE_STATE);
1789 1790
            }
        } else {
A
antirez 已提交
1791
            redisLog(REDIS_NOTICE,
1792
                "Ignoring FAIL message from unknonw node %.40s about %.40s",
A
antirez 已提交
1793 1794
                hdr->sender, hdr->data.fail.about.nodename);
        }
1795 1796 1797 1798
    } else if (type == CLUSTERMSG_TYPE_PUBLISH) {
        robj *channel, *message;
        uint32_t channel_len, message_len;

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

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

1856 1857
        /* Update the node's configEpoch. */
        n->configEpoch = reportedConfigEpoch;
A
antirez 已提交
1858 1859
        clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                             CLUSTER_TODO_FSYNC_CONFIG);
1860

1861 1862
        /* Check the bitmap of served slots and udpate our
         * config accordingly. */
1863 1864
        clusterUpdateSlotsConfigWith(n,reportedConfigEpoch,
            hdr->data.update.nodecfg.slots);
A
antirez 已提交
1865
    } else {
1866
        redisLog(REDIS_WARNING,"Received unknown packet type: %d", type);
A
antirez 已提交
1867 1868 1869 1870 1871 1872 1873
    }
    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.
1874

A
antirez 已提交
1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891
   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) {
1892
        redisLog(REDIS_DEBUG,"I/O error writing to node link: %s",
A
antirez 已提交
1893 1894 1895 1896
            strerror(errno));
        handleLinkIOError(link);
        return;
    }
1897
    sdsrange(link->sndbuf,nwritten,-1);
A
antirez 已提交
1898 1899 1900 1901 1902 1903 1904 1905
    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) {
1906
    char buf[sizeof(clusterMsg)];
A
antirez 已提交
1907 1908 1909
    ssize_t nread;
    clusterMsg *hdr;
    clusterLink *link = (clusterLink*) privdata;
1910
    unsigned int readlen, rcvbuflen;
A
antirez 已提交
1911 1912 1913
    REDIS_NOTUSED(el);
    REDIS_NOTUSED(mask);

1914 1915
    while(1) { /* Read as long as there is data to read. */
        rcvbuflen = sdslen(link->rcvbuf);
1916 1917
        if (rcvbuflen < 8) {
            /* First, obtain the first 8 bytes to get the full message
1918
             * length. */
1919
            readlen = 8 - rcvbuflen;
1920 1921 1922
        } else {
            /* Finally read the full message. */
            hdr = (clusterMsg*) link->rcvbuf;
1923 1924 1925 1926 1927 1928
            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)
                {
1929
                    redisLog(REDIS_WARNING,
1930 1931
                        "Bad message length or signature received "
                        "from Cluster bus.");
1932 1933 1934
                    handleLinkIOError(link);
                    return;
                }
1935
            }
1936 1937
            readlen = ntohl(hdr->totlen) - rcvbuflen;
            if (readlen > sizeof(buf)) readlen = sizeof(buf);
1938
        }
A
antirez 已提交
1939

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

1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954
        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 已提交
1955

1956
        /* Total length obtained? Process this packet. */
1957
        if (rcvbuflen >= 8 && rcvbuflen == ntohl(hdr->totlen)) {
1958 1959 1960 1961 1962 1963
            if (clusterProcessPacket(link)) {
                sdsfree(link->rcvbuf);
                link->rcvbuf = sdsempty();
            } else {
                return; /* Link no longer valid. */
            }
A
antirez 已提交
1964 1965 1966 1967
        }
    }
}

1968 1969 1970 1971 1972
/* 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 已提交
1973 1974 1975 1976 1977 1978
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);
1979
    server.cluster->stats_bus_messages_sent++;
A
antirez 已提交
1980 1981
}

1982
/* Send a message to all the nodes that are part of the cluster having
1983
 * a connected link.
1984
 *
1985 1986 1987
 * 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. */
1988 1989 1990 1991
void clusterBroadcastMessage(void *buf, size_t len) {
    dictIterator *di;
    dictEntry *de;

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

        if (!node->link) continue;
1997 1998
        if (node->flags & (REDIS_NODE_MYSELF|REDIS_NODE_HANDSHAKE))
            continue;
1999 2000 2001 2002 2003
        clusterSendMessage(node->link,buf,len);
    }
    dictReleaseIterator(di);
}

A
antirez 已提交
2004 2005
/* Build the message header */
void clusterBuildMessageHdr(clusterMsg *hdr, int type) {
2006
    int totlen = 0;
2007
    uint64_t offset;
2008
    clusterNode *master;
2009 2010 2011 2012 2013

    /* 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. */
2014
    master = (nodeIsSlave(myself) && myself->slaveof) ?
2015
              myself->slaveof : myself;
A
antirez 已提交
2016 2017

    memset(hdr,0,sizeof(*hdr));
2018 2019
    hdr->sig[0] = 'R';
    hdr->sig[1] = 'C';
2020
    hdr->sig[2] = 'm';
2021
    hdr->sig[3] = 'b';
A
antirez 已提交
2022
    hdr->type = htons(type);
2023
    memcpy(hdr->sender,myself->name,REDIS_CLUSTER_NAMELEN);
2024 2025

    memcpy(hdr->myslots,master->slots,sizeof(hdr->myslots));
A
antirez 已提交
2026
    memset(hdr->slaveof,0,REDIS_CLUSTER_NAMELEN);
2027 2028
    if (myself->slaveof != NULL)
        memcpy(hdr->slaveof,myself->slaveof->name, REDIS_CLUSTER_NAMELEN);
A
antirez 已提交
2029
    hdr->port = htons(server.port);
2030
    hdr->flags = htons(myself->flags);
2031
    hdr->state = server.cluster->state;
A
antirez 已提交
2032

2033
    /* Set the currentEpoch and configEpochs. */
2034
    hdr->currentEpoch = htonu64(server.cluster->currentEpoch);
2035
    hdr->configEpoch = htonu64(master->configEpoch);
2036

2037
    /* Set the replication offset. */
2038 2039 2040
    if (nodeIsSlave(myself))
        offset = replicationGetSlaveOffset();
    else
2041 2042 2043
        offset = server.master_repl_offset;
    hdr->offset = htonu64(offset);

2044 2045 2046 2047
    /* Set the message flags. */
    if (nodeIsMaster(myself) && server.cluster->mf_end)
        hdr->mflags[0] |= CLUSTERMSG_FLAG0_PAUSED;

2048 2049
    /* Compute the message length for certain messages. For other messages
     * this is up to the caller. */
A
antirez 已提交
2050 2051 2052
    if (type == CLUSTERMSG_TYPE_FAIL) {
        totlen = sizeof(clusterMsg)-sizeof(union clusterMsgData);
        totlen += sizeof(clusterMsgDataFail);
2053 2054 2055
    } else if (type == CLUSTERMSG_TYPE_UPDATE) {
        totlen = sizeof(clusterMsg)-sizeof(union clusterMsgData);
        totlen += sizeof(clusterMsgDataUpdate);
A
antirez 已提交
2056 2057
    }
    hdr->totlen = htonl(totlen);
2058
    /* For PING, PONG, and MEET, fixing the totlen field is up to the caller. */
A
antirez 已提交
2059 2060 2061 2062 2063
}

/* Send a PING or PONG packet to the specified node, making sure to add enough
 * gossip informations. */
void clusterSendPing(clusterLink *link, int type) {
2064
    unsigned char buf[sizeof(clusterMsg)];
A
antirez 已提交
2065 2066 2067 2068 2069 2070 2071 2072
    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. */
2073
    int freshnodes = dictSize(server.cluster->nodes)-2;
A
antirez 已提交
2074 2075

    if (link->node && type == CLUSTERMSG_TYPE_PING)
2076
        link->node->ping_sent = mstime();
A
antirez 已提交
2077
    clusterBuildMessageHdr(hdr,type);
2078

A
antirez 已提交
2079 2080
    /* Populate the gossip fields */
    while(freshnodes > 0 && gossipcount < 3) {
A
antirez 已提交
2081
        dictEntry *de = dictGetRandomKey(server.cluster->nodes);
2082
        clusterNode *this = dictGetVal(de);
A
antirez 已提交
2083 2084 2085
        clusterMsgDataGossip *gossip;
        int j;

2086 2087 2088 2089 2090 2091
        /* 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.
         */
2092
        if (this == myself ||
2093
            this->flags & (REDIS_NODE_HANDSHAKE|REDIS_NODE_NOADDR) ||
2094
            (this->link == NULL && this->numslots == 0))
2095
        {
A
antirez 已提交
2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124
                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);
}

2125 2126
/* Send a PONG packet to every connected node that's not in handshake state
 * and for which we have a valid link.
2127
 *
2128 2129
 * In Redis Cluster pongs are not used just for failure detection, but also
 * to carry important configuration information. So broadcasting a pong is
2130
 * useful when something changes in the configuration and we want to make
2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141
 * 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) {
2142 2143 2144
    dictIterator *di;
    dictEntry *de;

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

2149
        if (!node->link) continue;
2150
        if (node == myself || nodeInHandshake(node)) continue;
2151 2152
        if (target == CLUSTER_BROADCAST_LOCAL_SLAVES) {
            int local_slave =
2153
                nodeIsSlave(node) && node->slaveof &&
2154 2155 2156
                (node->slaveof == myself || node->slaveof == myself->slaveof);
            if (!local_slave) continue;
        }
2157 2158 2159 2160 2161
        clusterSendPing(node->link,CLUSTERMSG_TYPE_PONG);
    }
    dictReleaseIterator(di);
}

2162 2163 2164 2165
/* 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) {
2166
    unsigned char buf[sizeof(clusterMsg)], *payload;
2167 2168 2169
    clusterMsg *hdr = (clusterMsg*) buf;
    uint32_t totlen;
    uint32_t channel_len, message_len;
A
antirez 已提交
2170

2171 2172 2173 2174
    channel = getDecodedObject(channel);
    message = getDecodedObject(message);
    channel_len = sdslen(channel->ptr);
    message_len = sdslen(message->ptr);
A
antirez 已提交
2175

2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188
    clusterBuildMessageHdr(hdr,CLUSTERMSG_TYPE_PUBLISH);
    totlen = sizeof(clusterMsg)-sizeof(union clusterMsgData);
    totlen += sizeof(clusterMsgDataPublish) + channel_len + message_len;

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

    /* Try to use the local buffer if possible */
    if (totlen < sizeof(buf)) {
        payload = buf;
    } else {
        payload = zmalloc(totlen);
2189
        memcpy(payload,hdr,sizeof(*hdr));
2190
        hdr = (clusterMsg*) payload;
A
antirez 已提交
2191
    }
2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203
    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 已提交
2204 2205 2206 2207 2208 2209 2210 2211
}

/* 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) {
2212
    unsigned char buf[sizeof(clusterMsg)];
A
antirez 已提交
2213 2214 2215 2216 2217 2218 2219
    clusterMsg *hdr = (clusterMsg*) buf;

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

2220 2221 2222 2223
/* 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) {
2224
    unsigned char buf[sizeof(clusterMsg)];
2225 2226
    clusterMsg *hdr = (clusterMsg*) buf;

2227
    if (link == NULL) return;
2228 2229 2230 2231 2232 2233 2234
    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));
}

2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245
/* -----------------------------------------------------------------------------
 * 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);
}

2246 2247 2248 2249
/* -----------------------------------------------------------------------------
 * SLAVE node specific functions
 * -------------------------------------------------------------------------- */

2250 2251 2252 2253 2254 2255 2256
/* 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) {
2257
    unsigned char buf[sizeof(clusterMsg)];
2258 2259 2260 2261
    clusterMsg *hdr = (clusterMsg*) buf;
    uint32_t totlen;

    clusterBuildMessageHdr(hdr,CLUSTERMSG_TYPE_FAILOVER_AUTH_REQUEST);
2262 2263 2264 2265
    /* 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;
2266 2267
    totlen = sizeof(clusterMsg)-sizeof(union clusterMsgData);
    hdr->totlen = htonl(totlen);
2268
    clusterBroadcastMessage(buf,totlen);
2269 2270
}

2271 2272
/* Send a FAILOVER_AUTH_ACK message to the specified node. */
void clusterSendFailoverAuth(clusterNode *node) {
2273
    unsigned char buf[sizeof(clusterMsg)];
2274 2275 2276 2277 2278 2279 2280
    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);
2281
    clusterSendMessage(node->link,buf,totlen);
2282 2283
}

2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296
/* 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);
}

2297
/* Vote for the node asking for our vote if there are the conditions. */
2298
void clusterSendFailoverAuthIfNeeded(clusterNode *node, clusterMsg *request) {
2299
    clusterNode *master = node->slaveof;
2300 2301 2302
    uint64_t requestCurrentEpoch = ntohu64(request->currentEpoch);
    uint64_t requestConfigEpoch = ntohu64(request->configEpoch);
    unsigned char *claimed_slots = request->myslots;
2303
    int force_ack = request->mflags[0] & CLUSTERMSG_FLAG0_FORCEACK;
2304
    int j;
2305 2306 2307

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

2312 2313 2314 2315
    /* 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. */
2316 2317 2318 2319 2320 2321 2322 2323
    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;
    }
2324

2325
    /* I already voted for this epoch? Return ASAP. */
2326 2327 2328 2329 2330 2331 2332
    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;
    }
2333

2334 2335 2336 2337
    /* 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 ||
2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354
        (!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;
    }
2355

2356 2357 2358
    /* 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. */
2359
    if (mstime() - node->slaveof->voted_time < server.cluster_node_timeout * 2)
2360 2361
    {
        redisLog(REDIS_WARNING,
2362 2363
                "Failover auth denied to %.40s: "
                "can't vote about this master before %lld milliseconds",
2364
                node->name,
2365 2366
                (long long) ((server.cluster_node_timeout*2)-
                             (mstime() - node->slaveof->voted_time)));
2367
        return;
2368
    }
2369

2370 2371 2372
    /* 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. */
2373 2374 2375
    for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
        if (bitmapTestBit(claimed_slots, j) == 0) continue;
        if (server.cluster->slots[j] == NULL ||
A
antirez 已提交
2376 2377 2378 2379
            server.cluster->slots[j]->configEpoch <= requestConfigEpoch)
        {
            continue;
        }
2380 2381 2382
        /* 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. */
2383 2384 2385 2386 2387 2388
        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);
2389 2390 2391
        return;
    }

2392
    /* We can vote for this slave. */
2393
    clusterSendFailoverAuth(node);
2394
    server.cluster->lastVoteEpoch = server.cluster->currentEpoch;
2395
    node->slaveof->voted_time = mstime();
2396 2397
    redisLog(REDIS_WARNING, "Failover auth granted to %.40s for epoch %llu",
        node->name, (unsigned long long) server.cluster->currentEpoch);
2398 2399
}

2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427
/* 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;
}

2428
/* This function is called if we are a slave node and our master serving
2429
 * a non-zero amount of hash slots is in FAIL state.
2430 2431 2432
 *
 * The gaol of this function is:
 * 1) To check if we are able to perform a failover, is our data updated?
2433
 * 2) Try to get elected by masters.
2434
 * 3) Perform the failover informing all the other nodes.
2435 2436
 */
void clusterHandleSlaveFailover(void) {
2437
    mstime_t data_age;
2438
    mstime_t auth_age = mstime() - server.cluster->failover_auth_time;
2439
    int needed_quorum = (server.cluster->size / 2) + 1;
2440 2441
    int manual_failover = server.cluster->mf_end != 0 &&
                          server.cluster->mf_can_start;
2442
    int j;
2443 2444
    mstime_t auth_timeout, auth_retry_time;

2445 2446
    server.cluster->todo_before_sleep &= ~CLUSTER_TODO_HANDLE_FAILOVER;

2447 2448 2449 2450 2451 2452 2453 2454 2455 2456
    /* 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
     * before waiting again.
     *
     * 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;
2457

2458 2459
    /* Pre conditions to run the function, that must be met both in case
     * of an automatic or manual failover:
2460
     * 1) We are a slave.
2461
     * 2) Our master is flagged as FAIL, or this is a manual failover.
2462
     * 3) It is serving slots. */
2463
    if (nodeIsMaster(myself) ||
2464
        myself->slaveof == NULL ||
2465
        (!nodeFailed(myself->slaveof) && !manual_failover) ||
2466
        myself->slaveof->numslots == 0) return;
2467

2468 2469 2470
    /* Set data_age to the number of seconds we are disconnected from
     * the master. */
    if (server.repl_state == REDIS_REPL_CONNECTED) {
2471 2472
        data_age = (mstime_t)(server.unixtime - server.master->lastinteraction)
                   * 1000;
2473
    } else {
2474
        data_age = (mstime_t)(server.unixtime - server.repl_down_since) * 1000;
2475 2476
    }

2477 2478 2479 2480 2481 2482
    /* 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;

2483 2484
    /* Check if our data is recent enough according to the slave validity
     * factor configured by the user.
2485 2486
     *
     * Check bypassed for manual failovers. */
2487 2488 2489 2490
    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)))
2491 2492 2493
    {
        if (!manual_failover) return;
    }
2494

2495 2496 2497
    /* If the previous failover attempt timedout and the retry time has
     * elapsed, we can setup a new one. */
    if (auth_age > auth_retry_time) {
2498 2499 2500
        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. */
2501
        server.cluster->failover_auth_count = 0;
2502
        server.cluster->failover_auth_sent = 0;
2503 2504 2505 2506 2507 2508
        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;
2509 2510 2511 2512 2513
        /* 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;
        }
2514
        redisLog(REDIS_WARNING,
2515 2516
            "Start of election delayed for %lld milliseconds "
            "(rank #%d, offset %lld).",
2517
            server.cluster->failover_auth_time - mstime(),
2518 2519
            server.cluster->failover_auth_rank,
            replicationGetSlaveOffset());
2520 2521 2522 2523
        /* 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);
2524 2525 2526 2527 2528
        return;
    }

    /* It is possible that we received more updated offsets from other
     * slaves for the same master since we computed our election delay.
2529 2530 2531
     * Update the delay if our rank changed.
     *
     * Not performed if this is a manual failover. */
2532 2533 2534
    if (server.cluster->failover_auth_sent == 0 &&
        server.cluster->mf_end == 0)
    {
2535 2536 2537 2538 2539 2540 2541 2542 2543 2544
        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);
        }
2545 2546 2547 2548 2549 2550
    }

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

    /* Return ASAP if the election is too old to be valid. */
2551
    if (auth_age > auth_timeout) return;
2552 2553 2554 2555 2556 2557

    /* 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.",
2558
            (unsigned long long) server.cluster->currentEpoch);
2559
        clusterRequestFailoverAuth();
2560
        server.cluster->failover_auth_sent = 1;
A
antirez 已提交
2561 2562 2563
        clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                             CLUSTER_TODO_UPDATE_STATE|
                             CLUSTER_TODO_FSYNC_CONFIG);
2564 2565 2566 2567
        return; /* Wait for replies. */
    }

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

2571
        redisLog(REDIS_WARNING,
A
antirez 已提交
2572
            "Failover election won: I'm the new master.");
A
antirez 已提交
2573 2574 2575 2576
        /* We have the quorum, perform all the steps to correctly promote
         * this slave to a master.
         *
         * 1) Turn this node into a master. */
2577
        clusterSetNodeAsMaster(myself);
A
antirez 已提交
2578 2579
        replicationUnsetMaster();

2580 2581 2582 2583
        /* 2) Claim all the slots assigned to our master. */
        for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
            if (clusterNodeGetSlotBit(oldmaster,j)) {
                clusterDelSlot(j);
2584
                clusterAddSlot(myself,j);
2585 2586 2587
            }
        }

2588
        /* 3) Update my configEpoch to the epoch of the election. */
2589
        if (myself->configEpoch < server.cluster->failover_auth_epoch) {
2590
            myself->configEpoch = server.cluster->failover_auth_epoch;
2591 2592 2593 2594
            redisLog(REDIS_WARNING,
                "configEpoch set to %llu after successful failover",
                (unsigned long long) myself->configEpoch);
        }
2595

2596
        /* 4) Update state and save config. */
2597
        clusterUpdateState();
A
antirez 已提交
2598
        clusterSaveConfigOrDie(1);
2599 2600 2601

        /* 5) Pong all the other nodes so that they can update the state
         *    accordingly and detect that we switched to master role. */
2602
        clusterBroadcastPong(CLUSTER_BROADCAST_ALL);
2603 2604 2605

        /* 6) If there was a manual failover in progress, clear the state. */
        resetManualFailover();
2606
    }
2607 2608
}

2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644
/* -----------------------------------------------------------------------------
 * 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;

2645 2646
    /* Step 2: Don't migrate if my master will not be left with at least
     *         'migration-barrier' slaves after my migration. */
2647 2648 2649 2650
    if (mymaster == NULL) return;
    for (j = 0; j < mymaster->numslaves; j++)
        if (!nodeFailed(mymaster->slaves[j]) &&
            !nodeTimedOut(mymaster->slaves[j])) okslaves++;
2651
    if (okslaves <= server.cluster_migration_barrier) return;
2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669

    /* 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;
2670 2671 2672 2673
        /* 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;
2674 2675
        okslaves = clusterCountNonFailingSlaves(node);

A
antirez 已提交
2676 2677 2678
        if (okslaves == 0 && target == NULL && node->numslots > 0)
            target = node;

2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699
        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);
    }
}

2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746
/* -----------------------------------------------------------------------------
 * 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) {
2747
    if (server.cluster->mf_end && server.cluster->mf_end < mstime()) {
2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768
        redisLog(REDIS_WARNING,"Manual failover timed out.");
        resetManualFailover();
    }
}

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

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

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

    if (server.cluster->mf_master_offset == replicationGetSlaveOffset()) {
        /* Our replication offset matches the master replication offset
         * announced after clients were paused. We can start the failover. */
        server.cluster->mf_can_start = 1;
A
antirez 已提交
2769 2770 2771
        redisLog(REDIS_WARNING,
            "All master replication stream processed, "
            "manual failover can start.");
2772 2773 2774
    }
}

A
antirez 已提交
2775 2776 2777 2778
/* -----------------------------------------------------------------------------
 * CLUSTER cron job
 * -------------------------------------------------------------------------- */

2779
/* This is executed 10 times every second */
A
antirez 已提交
2780 2781 2782
void clusterCron(void) {
    dictIterator *di;
    dictEntry *de;
2783 2784 2785 2786
    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). */
2787
    mstime_t min_pong = 0, now = mstime();
2788
    clusterNode *min_pong_node = NULL;
2789
    static unsigned long long iteration = 0;
2790
    mstime_t handshake_timeout;
2791 2792

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

2794
    /* The handshake timeout is the time after which a handshake node that was
2795 2796 2797 2798 2799 2800
     * 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 已提交
2801
    /* Check if we have disconnected nodes and re-establish the connection. */
2802
    di = dictGetSafeIterator(server.cluster->nodes);
A
antirez 已提交
2803
    while((de = dictNext(di)) != NULL) {
2804
        clusterNode *node = dictGetVal(de);
A
antirez 已提交
2805 2806

        if (node->flags & (REDIS_NODE_MYSELF|REDIS_NODE_NOADDR)) continue;
2807 2808 2809

        /* A Node in HANDSHAKE state has a limited lifespan equal to the
         * configured node timeout. */
2810
        if (nodeInHandshake(node) && now - node->ctime > handshake_timeout) {
2811 2812 2813 2814
            freeClusterNode(node);
            continue;
        }

A
antirez 已提交
2815 2816
        if (node->link == NULL) {
            int fd;
2817
            mstime_t old_ping_sent;
A
antirez 已提交
2818 2819
            clusterLink *link;

2820
            fd = anetTcpNonBlockBindConnect(server.neterr, node->ip,
2821
                node->port+REDIS_CLUSTER_PORT_INCR, REDIS_BIND_ADDR);
2822 2823
            if (fd == -1) {
                redisLog(REDIS_DEBUG, "Unable to connect to "
2824 2825 2826
                    "Cluster Node [%s]:%d -> %s", node->ip,
                    node->port+REDIS_CLUSTER_PORT_INCR,
                    server.neterr);
2827 2828
                continue;
            }
A
antirez 已提交
2829 2830 2831
            link = createClusterLink(node);
            link->fd = fd;
            node->link = link;
A
antirez 已提交
2832 2833
            aeCreateFileEvent(server.el,link->fd,AE_READABLE,
                    clusterReadHandler,link);
2834 2835 2836 2837
            /* 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 已提交
2838 2839
             * of a PING one, to force the receiver to add us in its node
             * table. */
2840
            old_ping_sent = node->ping_sent;
A
antirez 已提交
2841 2842
            clusterSendPing(link, node->flags & REDIS_NODE_MEET ?
                    CLUSTERMSG_TYPE_MEET : CLUSTERMSG_TYPE_PING);
2843 2844 2845 2846 2847 2848
            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 已提交
2849 2850 2851 2852 2853 2854 2855
            /* 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 已提交
2856 2857
            redisLog(REDIS_DEBUG,"Connecting with Node %.40s at %s:%d",
                    node->name, node->ip, node->port+REDIS_CLUSTER_PORT_INCR);
A
antirez 已提交
2858 2859 2860 2861
        }
    }
    dictReleaseIterator(di);

2862 2863 2864
    /* Ping some random node 1 time every 10 iterations, so that we usually ping
     * one random node every second. */
    if (!(iteration % 10)) {
2865 2866
        int j;

2867 2868 2869 2870 2871 2872 2873 2874
        /* 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 已提交
2875 2876
            if (this->flags & (REDIS_NODE_MYSELF|REDIS_NODE_HANDSHAKE))
                continue;
2877 2878 2879 2880 2881 2882 2883 2884
            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 已提交
2885 2886 2887
        }
    }

2888 2889 2890 2891 2892 2893 2894 2895 2896
    /* 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;
2897
    di = dictGetSafeIterator(server.cluster->nodes);
A
antirez 已提交
2898
    while((de = dictNext(di)) != NULL) {
2899
        clusterNode *node = dictGetVal(de);
2900
        now = mstime(); /* Use an updated time at every iteration. */
2901
        mstime_t delay;
A
antirez 已提交
2902 2903

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

2907 2908 2909 2910 2911
        /* 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);

2912 2913 2914 2915 2916
            /* 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++;
2917 2918 2919 2920 2921
            if (okslaves > max_slaves) max_slaves = okslaves;
            if (nodeIsSlave(myself) && myself->slaveof == node)
                this_slaves = okslaves;
        }

2922 2923 2924 2925
        /* 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 */
2926
            now - node->link->ctime >
2927
            server.cluster_node_timeout && /* was not already reconnected */
2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940
            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. */
2941
        if (node->link &&
2942 2943
            node->ping_sent == 0 &&
            (now - node->pong_received) > server.cluster_node_timeout/2)
2944 2945 2946 2947 2948
        {
            clusterSendPing(node->link, CLUSTERMSG_TYPE_PING);
            continue;
        }

2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959
        /* 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;
        }

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

2963 2964 2965 2966
        /* 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;
2967

2968
        if (delay > server.cluster_node_timeout) {
G
guiquanz 已提交
2969
            /* Timeout reached. Set the node as possibly failing if it is
2970
             * not already in this state. */
2971
            if (!(node->flags & (REDIS_NODE_PFAIL|REDIS_NODE_FAIL))) {
A
antirez 已提交
2972 2973 2974
                redisLog(REDIS_DEBUG,"*** NODE %.40s possibly failing",
                    node->name);
                node->flags |= REDIS_NODE_PFAIL;
2975
                update_state = 1;
A
antirez 已提交
2976 2977 2978 2979
            }
        }
    }
    dictReleaseIterator(di);
2980 2981 2982 2983

    /* 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. */
2984
    if (nodeIsSlave(myself) &&
2985
        server.masterhost == NULL &&
2986
        myself->slaveof &&
2987
        nodeHasAddr(myself->slaveof))
2988
    {
2989
        replicationSetMaster(myself->slaveof->ip, myself->slaveof->port);
2990
    }
2991

2992 2993 2994
    /* Abourt a manual failover if the timeout is reached. */
    manualFailoverCheckTimeout();

2995
    if (nodeIsSlave(myself)) {
2996
        clusterHandleManualFailover();
2997 2998 2999 3000 3001 3002 3003 3004 3005 3006
        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);
    }

3007 3008
    if (update_state || server.cluster->state == REDIS_CLUSTER_FAIL)
        clusterUpdateState();
3009 3010 3011 3012 3013
}

/* 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 已提交
3014 3015
 * handlers, or to perform potentially expansive tasks that we need to do
 * a single time before replying to clients. */
3016
void clusterBeforeSleep(void) {
A
antirez 已提交
3017 3018 3019
    /* 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)
3020
        clusterHandleSlaveFailover();
A
antirez 已提交
3021 3022 3023 3024 3025 3026 3027

    /* 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 已提交
3028 3029
        int fsync = server.cluster->todo_before_sleep &
                    CLUSTER_TODO_FSYNC_CONFIG;
A
antirez 已提交
3030
        clusterSaveConfigOrDie(fsync);
3031
    }
A
antirez 已提交
3032

3033 3034
    /* Reset our flags (not strictly needed since every single function
     * called for flags set should be able to clear its flag). */
A
antirez 已提交
3035 3036 3037 3038 3039
    server.cluster->todo_before_sleep = 0;
}

void clusterDoBeforeSleep(int flags) {
    server.cluster->todo_before_sleep |= flags;
A
antirez 已提交
3040 3041 3042 3043 3044 3045
}

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

3046
/* Test bit 'pos' in a generic bitmap. Return 1 if the bit is set,
3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067
 * 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 已提交
3068 3069
/* Set the slot bit and return the old value. */
int clusterNodeSetSlotBit(clusterNode *n, int slot) {
3070 3071
    int old = bitmapTestBit(n->slots,slot);
    bitmapSetBit(n->slots,slot);
3072
    if (!old) n->numslots++;
A
antirez 已提交
3073 3074 3075 3076 3077
    return old;
}

/* Clear the slot bit and return the old value. */
int clusterNodeClearSlotBit(clusterNode *n, int slot) {
3078 3079
    int old = bitmapTestBit(n->slots,slot);
    bitmapClearBit(n->slots,slot);
3080
    if (old) n->numslots--;
A
antirez 已提交
3081 3082 3083 3084 3085
    return old;
}

/* Return the slot bit from the cluster node structure. */
int clusterNodeGetSlotBit(clusterNode *n, int slot) {
3086
    return bitmapTestBit(n->slots,slot);
A
antirez 已提交
3087 3088 3089 3090 3091 3092 3093
}

/* 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) {
3094 3095
    if (server.cluster->slots[slot]) return REDIS_ERR;
    clusterNodeSetSlotBit(n,slot);
3096
    server.cluster->slots[slot] = n;
A
antirez 已提交
3097 3098 3099
    return REDIS_OK;
}

A
antirez 已提交
3100 3101 3102 3103
/* 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) {
3104
    clusterNode *n = server.cluster->slots[slot];
A
antirez 已提交
3105 3106 3107

    if (!n) return REDIS_ERR;
    redisAssert(clusterNodeClearSlotBit(n,slot) == 1);
3108
    server.cluster->slots[slot] = NULL;
A
antirez 已提交
3109 3110 3111
    return REDIS_OK;
}

3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123
/* 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 已提交
3124 3125 3126 3127 3128 3129 3130 3131 3132
/* 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 已提交
3133 3134 3135
/* -----------------------------------------------------------------------------
 * Cluster state evaluation function
 * -------------------------------------------------------------------------- */
3136

3137 3138 3139 3140
/* 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. */
3141
#define REDIS_CLUSTER_MAX_REJOIN_DELAY 5000
3142
#define REDIS_CLUSTER_MIN_REJOIN_DELAY 500
3143
#define REDIS_CLUSTER_WRITABLE_DELAY 2000
3144

A
antirez 已提交
3145
void clusterUpdateState(void) {
3146
    int j, new_state;
3147
    int unreachable_masters = 0;
3148
    static mstime_t among_minority_time;
3149 3150
    static mstime_t first_call_time = 0;

3151 3152
    server.cluster->todo_before_sleep &= ~CLUSTER_TODO_UPDATE_STATE;

3153 3154 3155 3156 3157 3158 3159
    /* 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();
3160
    if (nodeIsMaster(myself) &&
3161
        server.cluster->state == REDIS_CLUSTER_FAIL &&
3162
        mstime() - first_call_time < REDIS_CLUSTER_WRITABLE_DELAY) return;
A
antirez 已提交
3163

3164 3165
    /* Start assuming the state is OK. We'll turn it into FAIL if there
     * are the right conditions. */
3166
    new_state = REDIS_CLUSTER_OK;
3167

3168
    /* Check if all the slots are covered. */
A
antirez 已提交
3169
    for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
3170 3171
        if (server.cluster->slots[j] == NULL ||
            server.cluster->slots[j]->flags & (REDIS_NODE_FAIL))
A
antirez 已提交
3172
        {
3173
            new_state = REDIS_CLUSTER_FAIL;
A
antirez 已提交
3174 3175 3176
            break;
        }
    }
3177

3178
    /* Compute the cluster size, that is the number of master nodes
3179 3180 3181 3182
     * serving at least a single slot.
     *
     * At the same time count the number of unreachable masters with
     * at least one node. */
3183 3184 3185 3186 3187
    {
        dictIterator *di;
        dictEntry *de;

        server.cluster->size = 0;
3188
        di = dictGetSafeIterator(server.cluster->nodes);
3189 3190 3191
        while((de = dictNext(di)) != NULL) {
            clusterNode *node = dictGetVal(de);

3192
            if (nodeIsMaster(node) && node->numslots) {
3193
                server.cluster->size++;
3194 3195 3196
                if (node->flags & (REDIS_NODE_FAIL|REDIS_NODE_PFAIL))
                    unreachable_masters++;
            }
3197 3198 3199
        }
        dictReleaseIterator(di);
    }
3200

3201
    /* If we can't reach at least half the masters, change the cluster state
3202
     * to FAIL, as we are not even able to mark nodes as FAIL in this side
3203
     * of the netsplit because of lack of majority. */
3204 3205
    {
        int needed_quorum = (server.cluster->size / 2) + 1;
3206

3207 3208 3209 3210
        if (unreachable_masters >= needed_quorum) {
            new_state = REDIS_CLUSTER_FAIL;
            among_minority_time = mstime();
        }
3211 3212
    }

3213
    /* Log a state change */
3214 3215 3216 3217 3218 3219 3220 3221 3222
    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;
3223 3224
        if (rejoin_delay < REDIS_CLUSTER_MIN_REJOIN_DELAY)
            rejoin_delay = REDIS_CLUSTER_MIN_REJOIN_DELAY;
3225 3226

        if (new_state == REDIS_CLUSTER_OK &&
3227
            nodeIsMaster(myself) &&
3228 3229 3230 3231 3232 3233
            mstime() - among_minority_time < rejoin_delay)
        {
            return;
        }

        /* Change the state and log the event. */
3234
        redisLog(REDIS_WARNING,"Cluster state changed: %s",
3235 3236 3237
            new_state == REDIS_CLUSTER_OK ? "ok" : "fail");
        server.cluster->state = new_state;
    }
A
antirez 已提交
3238 3239
}

3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262
/* 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) {
3263 3264 3265
    int j;
    int update_config = 0;

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

3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281
    /* 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. */
3282
        if (server.cluster->slots[j] == myself ||
3283 3284 3285 3286 3287 3288 3289 3290 3291
            server.cluster->importing_slots_from[j] != NULL) continue;

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

        update_config++;
        /* Case A: slot is unassigned. Take responsability for it. */
        if (server.cluster->slots[j] == NULL) {
3292 3293
            redisLog(REDIS_WARNING, "I have keys for unassigned slot %d. "
                                    "Taking responsibility for it.",j);
3294
            clusterAddSlot(myself,j);
3295
        } else {
3296 3297 3298
            redisLog(REDIS_WARNING, "I have keys for slot %d, but the slot is "
                                    "assigned to another node. "
                                    "Setting it to importing state.",j);
3299 3300 3301
            server.cluster->importing_slots_from[j] = server.cluster->slots[j];
        }
    }
A
antirez 已提交
3302
    if (update_config) clusterSaveConfigOrDie(1);
3303 3304 3305
    return REDIS_OK;
}

3306 3307 3308 3309
/* -----------------------------------------------------------------------------
 * SLAVE nodes handling
 * -------------------------------------------------------------------------- */

3310 3311
/* Set the specified node 'n' as master for this node.
 * If this node is currently a master, it is turned into a slave. */
3312 3313
void clusterSetMaster(clusterNode *n) {
    redisAssert(n != myself);
3314
    redisAssert(myself->numslots == 0);
3315

3316
    if (nodeIsMaster(myself)) {
3317 3318
        myself->flags &= ~REDIS_NODE_MASTER;
        myself->flags |= REDIS_NODE_SLAVE;
3319
        clusterCloseAllSlots();
3320 3321 3322
    } else {
        if (myself->slaveof)
            clusterNodeRemoveSlave(myself->slaveof,myself);
3323 3324
    }
    myself->slaveof = n;
3325
    clusterNodeAddSlave(n,myself);
3326
    replicationSetMaster(n->ip, n->port);
3327
    resetManualFailover();
3328 3329
}

A
antirez 已提交
3330
/* -----------------------------------------------------------------------------
3331
 * Nodes to string representation functions.
A
antirez 已提交
3332 3333
 * -------------------------------------------------------------------------- */

3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364
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;
}

3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379
/* 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 已提交
3380
    ci = representRedisNodeFlags(ci, node->flags);
3381 3382 3383

    /* Slave of... or just "-" */
    if (node->slaveof)
3384
        ci = sdscatprintf(ci," %.40s ",node->slaveof->name);
3385
    else
3386
        ci = sdscatlen(ci," - ",3);
3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404

    /* 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)) {
3405
            if (bit && j == REDIS_CLUSTER_SLOTS-1) j++;
3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432

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

3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445
/* 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) {
3446
    sds ci = sdsempty(), ni;
A
antirez 已提交
3447 3448 3449
    dictIterator *di;
    dictEntry *de;

3450
    di = dictGetSafeIterator(server.cluster->nodes);
A
antirez 已提交
3451
    while((de = dictNext(di)) != NULL) {
3452
        clusterNode *node = dictGetVal(de);
A
antirez 已提交
3453

3454
        if (node->flags & filter) continue;
3455 3456 3457
        ni = clusterGenNodeDescription(node);
        ci = sdscatsds(ci,ni);
        sdsfree(ni);
3458
        ci = sdscatlen(ci,"\n",1);
A
antirez 已提交
3459 3460 3461 3462 3463
    }
    dictReleaseIterator(di);
    return ci;
}

3464 3465 3466 3467
/* -----------------------------------------------------------------------------
 * CLUSTER command
 * -------------------------------------------------------------------------- */

3468 3469 3470 3471
int getSlotOrReply(redisClient *c, robj *o) {
    long long slot;

    if (getLongLongFromObject(o,&slot) != REDIS_OK ||
3472
        slot < 0 || slot >= REDIS_CLUSTER_SLOTS)
3473 3474 3475 3476 3477 3478 3479
    {
        addReplyError(c,"Invalid or out of range slot");
        return -1;
    }
    return (int) slot;
}

3480 3481 3482 3483 3484 3485 3486 3487 3488 3489
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
     */

3490 3491
    int num_masters = 0;
    void *slot_replylen = addDeferredMultiBulkLength(c);
3492 3493 3494 3495 3496 3497 3498

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

3499 3500 3501
        /* 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;
3502 3503

        for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
3504
            int bit, i;
3505 3506 3507 3508 3509

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

3513
                if (bit && j == REDIS_CLUSTER_SLOTS-1) j++;
3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534

                /* 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 */
3535
                    if (nodeFailed(node->slaves[i])) continue;
3536 3537 3538
                    addReplyMultiBulkLen(c, 2);
                    addReplyBulkCString(c, node->slaves[i]->ip);
                    addReplyLongLong(c, node->slaves[i]->port);
3539
                    nested_elements++;
3540
                }
3541 3542
                setDeferredMultiBulkLength(c, nested_replylen, nested_elements);
                num_masters++;
3543 3544 3545 3546
            }
        }
    }
    dictReleaseIterator(di);
3547
    setDeferredMultiBulkLength(c, slot_replylen, num_masters);
3548 3549
}

A
antirez 已提交
3550 3551 3552 3553 3554 3555 3556
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) {
3557
        long long port;
A
antirez 已提交
3558

3559 3560 3561
        if (getLongLongFromObject(c->argv[3], &port) != REDIS_OK) {
            addReplyErrorFormat(c,"Invalid TCP port specified: %s",
                                (char*)c->argv[3]->ptr);
A
antirez 已提交
3562 3563 3564
            return;
        }

3565 3566 3567
        if (clusterStartHandshake(c->argv[2]->ptr,port) == 0 &&
            errno == EINVAL)
        {
3568 3569
            addReplyErrorFormat(c,"Invalid node address specified: %s:%s",
                            (char*)c->argv[2]->ptr, (char*)c->argv[3]->ptr);
3570 3571 3572
        } else {
            addReply(c,shared.ok);
        }
A
antirez 已提交
3573
    } else if (!strcasecmp(c->argv[1]->ptr,"nodes") && c->argc == 2) {
3574
        /* CLUSTER NODES */
A
antirez 已提交
3575
        robj *o;
3576
        sds ci = clusterGenNodesDescription(0);
A
antirez 已提交
3577 3578 3579 3580

        o = createObject(REDIS_STRING,ci);
        addReplyBulk(c,o);
        decrRefCount(o);
3581 3582 3583
    } else if (!strcasecmp(c->argv[1]->ptr,"slots") && c->argc == 2) {
        /* CLUSTER SLOTS */
        clusterReplyMultiBulkSlots(c);
3584 3585 3586 3587 3588 3589
    } 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;
        }
3590
        clusterDelNodeSlots(myself);
A
antirez 已提交
3591
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
3592
        addReply(c,shared.ok);
A
antirez 已提交
3593
    } else if ((!strcasecmp(c->argv[1]->ptr,"addslots") ||
A
antirez 已提交
3594 3595 3596 3597
               !strcasecmp(c->argv[1]->ptr,"delslots")) && c->argc >= 3)
    {
        /* CLUSTER ADDSLOTS <slot> [slot] ... */
        /* CLUSTER DELSLOTS <slot> [slot] ... */
3598
        int j, slot;
A
antirez 已提交
3599
        unsigned char *slots = zmalloc(REDIS_CLUSTER_SLOTS);
A
antirez 已提交
3600
        int del = !strcasecmp(c->argv[1]->ptr,"delslots");
A
antirez 已提交
3601 3602 3603 3604 3605

        memset(slots,0,REDIS_CLUSTER_SLOTS);
        /* Check that all the arguments are parsable and that all the
         * slots are not already busy. */
        for (j = 2; j < c->argc; j++) {
3606
            if ((slot = getSlotOrReply(c,c->argv[j])) == -1) {
A
antirez 已提交
3607 3608 3609
                zfree(slots);
                return;
            }
3610
            if (del && server.cluster->slots[slot] == NULL) {
3611
                addReplyErrorFormat(c,"Slot %d is already unassigned", slot);
A
antirez 已提交
3612 3613
                zfree(slots);
                return;
3614
            } else if (!del && server.cluster->slots[slot]) {
3615
                addReplyErrorFormat(c,"Slot %d is already busy", slot);
A
antirez 已提交
3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627
                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]) {
3628 3629
                int retval;

3630
                /* If this slot was set as importing we can clear this
3631
                 * state as now we are the real owner of the slot. */
3632 3633
                if (server.cluster->importing_slots_from[j])
                    server.cluster->importing_slots_from[j] = NULL;
3634 3635

                retval = del ? clusterDelSlot(j) :
3636
                               clusterAddSlot(myself,j);
3637
                redisAssertWithInfo(c,NULL,retval == REDIS_OK);
A
antirez 已提交
3638 3639 3640
            }
        }
        zfree(slots);
A
antirez 已提交
3641
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
A
antirez 已提交
3642
        addReply(c,shared.ok);
3643
    } else if (!strcasecmp(c->argv[1]->ptr,"setslot") && c->argc >= 4) {
A
antirez 已提交
3644 3645
        /* SETSLOT 10 MIGRATING <node ID> */
        /* SETSLOT 10 IMPORTING <node ID> */
3646
        /* SETSLOT 10 STABLE */
A
antirez 已提交
3647
        /* SETSLOT 10 NODE <node ID> */
3648
        int slot;
3649 3650
        clusterNode *n;

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

3653
        if (!strcasecmp(c->argv[3]->ptr,"migrating") && c->argc == 5) {
3654
            if (server.cluster->slots[slot] != myself) {
3655 3656 3657
                addReplyErrorFormat(c,"I'm not the owner of hash slot %u",slot);
                return;
            }
3658 3659 3660 3661 3662
            if ((n = clusterLookupNode(c->argv[4]->ptr)) == NULL) {
                addReplyErrorFormat(c,"I don't know about node %s",
                    (char*)c->argv[4]->ptr);
                return;
            }
3663
            server.cluster->migrating_slots_to[slot] = n;
3664
        } else if (!strcasecmp(c->argv[3]->ptr,"importing") && c->argc == 5) {
3665
            if (server.cluster->slots[slot] == myself) {
3666 3667 3668 3669
                addReplyErrorFormat(c,
                    "I'm already the owner of hash slot %u",slot);
                return;
            }
3670 3671 3672 3673 3674
            if ((n = clusterLookupNode(c->argv[4]->ptr)) == NULL) {
                addReplyErrorFormat(c,"I don't know about node %s",
                    (char*)c->argv[3]->ptr);
                return;
            }
3675
            server.cluster->importing_slots_from[slot] = n;
3676
        } else if (!strcasecmp(c->argv[3]->ptr,"stable") && c->argc == 4) {
3677
            /* CLUSTER SETSLOT <SLOT> STABLE */
3678 3679
            server.cluster->importing_slots_from[slot] = NULL;
            server.cluster->migrating_slots_to[slot] = NULL;
3680
        } else if (!strcasecmp(c->argv[3]->ptr,"node") && c->argc == 5) {
3681 3682 3683
            /* CLUSTER SETSLOT <SLOT> NODE <NODE ID> */
            clusterNode *n = clusterLookupNode(c->argv[4]->ptr);

3684 3685 3686 3687 3688
            if (!n) {
                addReplyErrorFormat(c,"Unknown node %s",
                    (char*)c->argv[4]->ptr);
                return;
            }
3689 3690
            /* If this hash slot was served by 'myself' before to switch
             * make sure there are no longer local keys for this hash slot. */
3691
            if (server.cluster->slots[slot] == myself && n != myself) {
3692
                if (countKeysInSlot(slot) != 0) {
A
antirez 已提交
3693 3694 3695
                    addReplyErrorFormat(c,
                        "Can't assign hashslot %d to a different node "
                        "while I still hold keys for this hash slot.", slot);
3696 3697 3698
                    return;
                }
            }
3699 3700
            /* If this slot is in migrating status but we have no keys
             * for it assigning the slot to another node will clear
3701
             * the migratig status. */
3702
            if (countKeysInSlot(slot) == 0 &&
3703 3704
                server.cluster->migrating_slots_to[slot])
                server.cluster->migrating_slots_to[slot] = NULL;
3705

3706 3707
            /* If this node was importing this slot, assigning the slot to
             * itself also clears the importing status. */
3708
            if (n == myself &&
3709
                server.cluster->importing_slots_from[slot])
3710 3711
            {
                /* This slot was manually migrated, set this node configEpoch
3712 3713 3714
                 * to a new epoch so that the new version can be propagated
                 * by the cluster.
                 *
3715 3716 3717 3718 3719
                 * 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. */
3720 3721
                uint64_t maxEpoch = clusterGetMaxEpoch();

3722 3723 3724
                if (myself->configEpoch == 0 ||
                    myself->configEpoch != maxEpoch)
                {
3725 3726 3727
                    server.cluster->currentEpoch++;
                    myself->configEpoch = server.cluster->currentEpoch;
                    clusterDoBeforeSleep(CLUSTER_TODO_FSYNC_CONFIG);
3728 3729 3730
                    redisLog(REDIS_WARNING,
                        "configEpoch set to %llu after importing slot %d",
                        (unsigned long long) myself->configEpoch, slot);
3731
                }
3732
                server.cluster->importing_slots_from[slot] = NULL;
3733
            }
3734 3735
            clusterDelSlot(slot);
            clusterAddSlot(n,slot);
3736
        } else {
A
antirez 已提交
3737 3738
            addReplyError(c,
                "Invalid CLUSTER SETSLOT action or number of arguments");
3739
            return;
3740
        }
3741
        clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|CLUSTER_TODO_UPDATE_STATE);
3742
        addReply(c,shared.ok);
A
antirez 已提交
3743
    } else if (!strcasecmp(c->argv[1]->ptr,"info") && c->argc == 2) {
3744
        /* CLUSTER INFO */
A
antirez 已提交
3745 3746
        char *statestr[] = {"ok","fail","needhelp"};
        int slots_assigned = 0, slots_ok = 0, slots_pfail = 0, slots_fail = 0;
3747
        uint64_t myepoch;
A
antirez 已提交
3748 3749 3750
        int j;

        for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
3751
            clusterNode *n = server.cluster->slots[j];
A
antirez 已提交
3752 3753 3754

            if (n == NULL) continue;
            slots_assigned++;
3755
            if (nodeFailed(n)) {
A
antirez 已提交
3756
                slots_fail++;
3757
            } else if (nodeTimedOut(n)) {
A
antirez 已提交
3758 3759 3760 3761 3762 3763
                slots_pfail++;
            } else {
                slots_ok++;
            }
        }

3764 3765 3766
        myepoch = (nodeIsSlave(myself) && myself->slaveof) ?
                  myself->slaveof->configEpoch : myself->configEpoch;

A
antirez 已提交
3767 3768 3769 3770 3771 3772
        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"
3773
            "cluster_known_nodes:%lu\r\n"
3774
            "cluster_size:%d\r\n"
3775
            "cluster_current_epoch:%llu\r\n"
3776
            "cluster_my_epoch:%llu\r\n"
3777 3778
            "cluster_stats_messages_sent:%lld\r\n"
            "cluster_stats_messages_received:%lld\r\n"
3779
            , statestr[server.cluster->state],
A
antirez 已提交
3780 3781 3782
            slots_assigned,
            slots_ok,
            slots_pfail,
3783
            slots_fail,
3784
            dictSize(server.cluster->nodes),
3785
            server.cluster->size,
3786
            (unsigned long long) server.cluster->currentEpoch,
3787
            (unsigned long long) myepoch,
3788 3789
            server.cluster->stats_bus_messages_sent,
            server.cluster->stats_bus_messages_received
A
antirez 已提交
3790 3791 3792 3793 3794
        );
        addReplySds(c,sdscatprintf(sdsempty(),"$%lu\r\n",
            (unsigned long)sdslen(info)));
        addReplySds(c,info);
        addReply(c,shared.crlf);
3795
    } else if (!strcasecmp(c->argv[1]->ptr,"saveconfig") && c->argc == 2) {
A
antirez 已提交
3796
        int retval = clusterSaveConfig(1);
3797 3798 3799 3800 3801 3802

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

        addReplyLongLong(c,keyHashSlot(key,sdslen(key)));
3808
    } else if (!strcasecmp(c->argv[1]->ptr,"countkeysinslot") && c->argc == 3) {
3809
        /* CLUSTER COUNTKEYSINSLOT <slot> */
3810 3811 3812 3813
        long long slot;

        if (getLongLongFromObjectOrReply(c,c->argv[2],&slot,NULL) != REDIS_OK)
            return;
3814 3815 3816 3817
        if (slot < 0 || slot >= REDIS_CLUSTER_SLOTS) {
            addReplyError(c,"Invalid slot");
            return;
        }
3818
        addReplyLongLong(c,countKeysInSlot(slot));
A
antirez 已提交
3819
    } else if (!strcasecmp(c->argv[1]->ptr,"getkeysinslot") && c->argc == 4) {
3820
        /* CLUSTER GETKEYSINSLOT <slot> <count> */
A
antirez 已提交
3821
        long long maxkeys, slot;
3822
        unsigned int numkeys, j;
A
antirez 已提交
3823 3824 3825 3826
        robj **keys;

        if (getLongLongFromObjectOrReply(c,c->argv[2],&slot,NULL) != REDIS_OK)
            return;
A
antirez 已提交
3827 3828
        if (getLongLongFromObjectOrReply(c,c->argv[3],&maxkeys,NULL)
            != REDIS_OK)
A
antirez 已提交
3829
            return;
3830
        if (slot < 0 || slot >= REDIS_CLUSTER_SLOTS || maxkeys < 0) {
A
antirez 已提交
3831 3832 3833 3834 3835
            addReplyError(c,"Invalid slot or number of keys");
            return;
        }

        keys = zmalloc(sizeof(robj*)*maxkeys);
3836
        numkeys = getKeysInSlot(slot, keys, maxkeys);
A
antirez 已提交
3837 3838 3839
        addReplyMultiBulkLen(c,numkeys);
        for (j = 0; j < numkeys; j++) addReplyBulk(c,keys[j]);
        zfree(keys);
A
antirez 已提交
3840 3841 3842 3843
    } else if (!strcasecmp(c->argv[1]->ptr,"forget") && c->argc == 3) {
        /* CLUSTER FORGET <NODE ID> */
        clusterNode *n = clusterLookupNode(c->argv[2]->ptr);

3844
        if (!n) {
A
antirez 已提交
3845 3846
            addReplyErrorFormat(c,"Unknown node %s", (char*)c->argv[2]->ptr);
            return;
3847
        } else if (n == myself) {
3848 3849
            addReplyError(c,"I tried hard but I can't forget myself...");
            return;
3850
        } else if (nodeIsSlave(myself) && myself->slaveof == n) {
3851 3852
            addReplyError(c,"Can't forget my master!");
            return;
A
antirez 已提交
3853
        }
3854
        clusterBlacklistAddNode(n);
A
antirez 已提交
3855
        clusterDelNode(n);
A
antirez 已提交
3856 3857
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|
                             CLUSTER_TODO_SAVE_CONFIG);
A
antirez 已提交
3858
        addReply(c,shared.ok);
3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869
    } 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. */
3870
        if (n == myself) {
3871 3872 3873 3874 3875 3876 3877 3878 3879 3880
            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;
        }

3881 3882 3883
        /* 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. */
3884 3885
        if (nodeIsMaster(myself) &&
            (myself->numslots != 0 || dictSize(server.db[0].dict) != 0)) {
A
antirez 已提交
3886 3887 3888
            addReplyError(c,
                "To set a master the node must be empty and "
                "without assigned slots.");
3889 3890 3891 3892 3893
            return;
        }

        /* Set the master. */
        clusterSetMaster(n);
A
antirez 已提交
3894
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
3895
        addReply(c,shared.ok);
3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906
    } 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;
        }

3907
        if (nodeIsSlave(n)) {
3908 3909 3910 3911 3912 3913 3914 3915 3916 3917
            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 已提交
3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932
    } 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;
            }
        }

3933 3934 3935
        if (nodeIsMaster(myself)) {
            addReplyError(c,"You should send CLUSTER FAILOVER to a slave");
            return;
A
antirez 已提交
3936 3937 3938
        } else if (!force &&
                   (myself->slaveof == NULL || nodeFailed(myself->slaveof) ||
                   myself->slaveof->link == NULL))
3939 3940 3941 3942 3943 3944 3945
        {
            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 已提交
3946 3947 3948 3949 3950 3951 3952 3953 3954

        /* 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);
        }
3955 3956
        redisLog(REDIS_WARNING,"Manual failover user request accepted.");
        addReply(c,shared.ok);
A
antirez 已提交
3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979
    } 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;
3980 3981 3982 3983
            redisLog(REDIS_WARNING,
                "configEpoch set to %llu via CLUSTER SET-CONFIG-EPOCH",
                (unsigned long long) myself->configEpoch);

3984
            if (server.cluster->currentEpoch < (uint64_t)epoch)
3985
                server.cluster->currentEpoch = epoch;
A
antirez 已提交
3986 3987 3988 3989 3990 3991 3992
            /* 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 已提交
3993 3994 3995 3996 3997 3998 3999 4000 4001 4002
    } 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;
4003
            } else if (!strcasecmp(c->argv[2]->ptr,"soft")) {
A
antirez 已提交
4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019
                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 已提交
4020 4021 4022 4023 4024 4025
    } else {
        addReplyError(c,"Wrong CLUSTER subcommand or number of arguments");
    }
}

/* -----------------------------------------------------------------------------
4026
 * DUMP, RESTORE and MIGRATE commands
A
antirez 已提交
4027 4028
 * -------------------------------------------------------------------------- */

4029 4030 4031
/* 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) {
4032 4033
    unsigned char buf[2];
    uint64_t crc;
4034 4035 4036 4037 4038 4039 4040 4041

    /* 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:
4042 4043 4044 4045 4046
     * ----------------+---------------------+---------------+
     * ... RDB payload | 2 bytes RDB version | 8 bytes CRC64 |
     * ----------------+---------------------+---------------+
     * RDB version and CRC are both in little endian.
     */
4047 4048

    /* RDB version */
4049 4050
    buf[0] = REDIS_RDB_VERSION & 0xff;
    buf[1] = (REDIS_RDB_VERSION >> 8) & 0xff;
4051 4052
    payload->io.buffer.ptr = sdscatlen(payload->io.buffer.ptr,buf,2);

4053
    /* CRC64 */
4054
    crc = crc64(0,(unsigned char*)payload->io.buffer.ptr,
4055 4056 4057
                sdslen(payload->io.buffer.ptr));
    memrev64ifbe(&crc);
    payload->io.buffer.ptr = sdscatlen(payload->io.buffer.ptr,&crc,8);
4058 4059 4060
}

/* Verify that the RDB version of the dump payload matches the one of this Redis
4061
 * instance and that the checksum is ok.
4062 4063 4064
 * If the DUMP payload looks valid REDIS_OK is returned, otherwise REDIS_ERR
 * is returned. */
int verifyDumpPayload(unsigned char *p, size_t len) {
4065
    unsigned char *footer;
4066
    uint16_t rdbver;
4067
    uint64_t crc;
4068

4069
    /* At least 2 bytes of RDB version and 8 of CRC64 should be present. */
4070 4071
    if (len < 10) return REDIS_ERR;
    footer = p+(len-10);
4072 4073

    /* Verify RDB version */
4074
    rdbver = (footer[1] << 8) | footer[0];
4075
    if (rdbver != REDIS_RDB_VERSION) return REDIS_ERR;
4076

4077
    /* Verify CRC64 */
4078
    crc = crc64(0,p,len-8);
4079 4080
    memrev64ifbe(&crc);
    return (memcmp(&crc,footer+2,8) == 0) ? REDIS_OK : REDIS_ERR;
4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105
}

/* 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 已提交
4106
/* RESTORE key ttl serialized-value [REPLACE] */
A
antirez 已提交
4107
void restoreCommand(redisClient *c) {
4108
    long long ttl;
4109
    rio payload;
A
antirez 已提交
4110
    int j, type, replace = 0;
4111
    robj *obj;
A
antirez 已提交
4112

A
antirez 已提交
4113 4114 4115 4116 4117 4118 4119 4120 4121 4122
    /* 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 已提交
4123
    /* Make sure this key does not already exist here... */
A
antirez 已提交
4124
    if (!replace && lookupKeyWrite(c->db,c->argv[1]) != NULL) {
4125
        addReply(c,shared.busykeyerr);
A
antirez 已提交
4126 4127 4128 4129
        return;
    }

    /* Check if the TTL value makes sense */
4130
    if (getLongLongFromObjectOrReply(c,c->argv[2],&ttl,NULL) != REDIS_OK) {
A
antirez 已提交
4131 4132 4133 4134 4135 4136
        return;
    } else if (ttl < 0) {
        addReplyError(c,"Invalid TTL value, must be >= 0");
        return;
    }

4137
    /* Verify RDB version and data checksum. */
4138 4139
    if (verifyDumpPayload(c->argv[3]->ptr,sdslen(c->argv[3]->ptr)) == REDIS_ERR)
    {
4140 4141 4142 4143
        addReplyError(c,"DUMP payload version or checksum are wrong");
        return;
    }

4144
    rioInitWithBuffer(&payload,c->argv[3]->ptr);
4145 4146
    if (((type = rdbLoadObjectType(&payload)) == -1) ||
        ((obj = rdbLoadObject(type,&payload)) == NULL))
4147
    {
4148
        addReplyError(c,"Bad data format");
A
antirez 已提交
4149 4150 4151
        return;
    }

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

A
antirez 已提交
4155
    /* Create the key and set the TTL if any */
4156
    dbAdd(c->db,c->argv[1],obj);
4157
    if (ttl) setExpire(c->db,c->argv[1],mstime()+ttl);
4158
    signalModifiedKey(c->db,c->argv[1]);
A
antirez 已提交
4159
    addReply(c,shared.ok);
4160
    server.dirty++;
A
antirez 已提交
4161 4162
}

A
antirez 已提交
4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 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 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222
/* MIGRATE socket cache implementation.
 *
 * We take a map between host:ip and a TCP socket that we used to connect
 * to this instance in recent time.
 * This sockets are closed when the max number we cache is reached, and also
 * in serverCron() when they are around for more than a few seconds. */
#define MIGRATE_SOCKET_CACHE_ITEMS 64 /* max num of items in the cache. */
#define MIGRATE_SOCKET_CACHE_TTL 10 /* close cached socekts after 10 sec. */

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

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

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

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

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

    /* Check if it connects within the specified timeout. */
4226
    if ((aeWait(fd,AE_WRITABLE,timeout) & AE_WRITABLE) == 0) {
A
antirez 已提交
4227
        sdsfree(name);
A
antirez 已提交
4228 4229
        addReplySds(c,
            sdsnew("-IOERR error or timeout connecting to the client\r\n"));
A
antirez 已提交
4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277
        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 已提交
4278
/* MIGRATE host port key dbid timeout [COPY | REPLACE] */
A
antirez 已提交
4279
void migrateCommand(redisClient *c) {
A
antirez 已提交
4280
    int fd, copy, replace, j;
A
antirez 已提交
4281 4282
    long timeout;
    long dbid;
A
antirez 已提交
4283
    long long ttl, expireat;
A
antirez 已提交
4284
    robj *o;
4285
    rio cmd, payload;
A
antirez 已提交
4286 4287 4288 4289 4290 4291 4292
    int retry_num = 0;

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

A
antirez 已提交
4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305
    /* 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 已提交
4306 4307 4308 4309 4310
    /* Sanity check */
    if (getLongFromObjectOrReply(c,c->argv[5],&timeout,NULL) != REDIS_OK)
        return;
    if (getLongFromObjectOrReply(c,c->argv[4],&dbid,NULL) != REDIS_OK)
        return;
4311
    if (timeout <= 0) timeout = 1000;
A
antirez 已提交
4312 4313 4314 4315 4316

    /* 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) {
4317
        addReplySds(c,sdsnew("+NOKEY\r\n"));
A
antirez 已提交
4318 4319
        return;
    }
4320

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

4325
    /* Create RESTORE payload and generate the protocol to call the command. */
4326
    rioInitWithBuffer(&cmd,sdsempty());
4327 4328 4329
    redisAssertWithInfo(c,NULL,rioWriteBulkCount(&cmd,'*',2));
    redisAssertWithInfo(c,NULL,rioWriteBulkString(&cmd,"SELECT",6));
    redisAssertWithInfo(c,NULL,rioWriteBulkLongLong(&cmd,dbid));
A
antirez 已提交
4330

A
antirez 已提交
4331 4332 4333 4334 4335
    expireat = getExpire(c->db,c->argv[3]);
    if (expireat != -1) {
        ttl = expireat-mstime();
        if (ttl < 1) ttl = 1;
    }
A
antirez 已提交
4336
    redisAssertWithInfo(c,NULL,rioWriteBulkCount(&cmd,'*',replace ? 5 : 4));
4337 4338 4339 4340 4341
    if (server.cluster_enabled)
        redisAssertWithInfo(c,NULL,
            rioWriteBulkString(&cmd,"RESTORE-ASKING",14));
    else
        redisAssertWithInfo(c,NULL,rioWriteBulkString(&cmd,"RESTORE",7));
4342
    redisAssertWithInfo(c,NULL,sdsEncodedObject(c->argv[3]));
A
antirez 已提交
4343 4344
    redisAssertWithInfo(c,NULL,rioWriteBulkString(&cmd,c->argv[3]->ptr,
            sdslen(c->argv[3]->ptr)));
4345
    redisAssertWithInfo(c,NULL,rioWriteBulkLongLong(&cmd,ttl));
A
antirez 已提交
4346

G
guiquanz 已提交
4347
    /* Emit the payload argument, that is the serialized object using
A
antirez 已提交
4348
     * the DUMP format. */
4349 4350 4351
    createDumpPayload(&payload,o);
    redisAssertWithInfo(c,NULL,rioWriteBulkString(&cmd,payload.io.buffer.ptr,
                                sdslen(payload.io.buffer.ptr)));
4352 4353
    sdsfree(payload.io.buffer.ptr);

A
antirez 已提交
4354 4355 4356 4357 4358
    /* 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 已提交
4359
    /* Transfer the query to the other node in 64K chunks. */
A
antirez 已提交
4360
    errno = 0;
A
antirez 已提交
4361
    {
4362 4363 4364 4365 4366 4367
        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);
4368
            nwritten = syncWrite(fd,buf+pos,towrite,timeout);
4369 4370
            if (nwritten != (signed)towrite) goto socket_wr_err;
            pos += nwritten;
A
antirez 已提交
4371 4372 4373
        }
    }

4374
    /* Read back the reply. */
A
antirez 已提交
4375 4376 4377 4378 4379 4380 4381 4382
    {
        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)
4383
            goto socket_rd_err;
A
antirez 已提交
4384 4385 4386 4387
        if (buf1[0] == '-' || buf2[0] == '-') {
            addReplyErrorFormat(c,"Target instance replied with error: %s",
                (buf1[0] == '-') ? buf1+1 : buf2+1);
        } else {
4388 4389
            robj *aux;

A
antirez 已提交
4390 4391 4392 4393 4394
            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 已提交
4395
            addReply(c,shared.ok);
4396 4397 4398
            server.dirty++;

            /* Translate MIGRATE as DEL for replication/AOF. */
A
antirez 已提交
4399
            aux = createStringObject("DEL",3);
4400 4401
            rewriteClientCommandVector(c,2,aux,c->argv[3]);
            decrRefCount(aux);
A
antirez 已提交
4402 4403 4404
        }
    }

4405
    sdsfree(cmd.io.buffer.ptr);
4406
    return;
A
antirez 已提交
4407 4408

socket_wr_err:
4409
    sdsfree(cmd.io.buffer.ptr);
A
antirez 已提交
4410
    migrateCloseSocket(c->argv[1],c->argv[2]);
A
antirez 已提交
4411 4412 4413
    if (errno != ETIMEDOUT && retry_num++ == 0) goto try_again;
    addReplySds(c,
        sdsnew("-IOERR error or timeout writing to target instance\r\n"));
4414
    return;
A
antirez 已提交
4415 4416

socket_rd_err:
4417
    sdsfree(cmd.io.buffer.ptr);
A
antirez 已提交
4418
    migrateCloseSocket(c->argv[1],c->argv[2]);
A
antirez 已提交
4419 4420 4421
    if (errno != ETIMEDOUT && retry_num++ == 0) goto try_again;
    addReplySds(c,
        sdsnew("-IOERR error or timeout reading from target node\r\n"));
4422 4423 4424
    return;
}

4425 4426 4427 4428
/* -----------------------------------------------------------------------------
 * Cluster functions related to serving / redirecting clients
 * -------------------------------------------------------------------------- */

4429
/* The ASKING command is required after a -ASK redirection.
G
guiquanz 已提交
4430
 * The client should issue ASKING before to actually send the command to
4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441
 * 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);
}

4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458
/* The READONLY command is uesd by clients to enter the read-only mode.
 * In this mode slaves will not redirect clients as long as clients access
 * with read-only commands to keys that are served by the slave's master. */
void readonlyCommand(redisClient *c) {
    if (server.cluster_enabled == 0) {
        addReplyError(c,"This instance has cluster support disabled");
        return;
    }
    c->flags |= REDIS_READONLY;
    addReply(c,shared.ok);
}

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

4460
/* Return the pointer to the cluster node that is able to serve the command.
4461
 * For the function to succeed the command should only target either:
A
antirez 已提交
4462
 *
4463 4464 4465
 * 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).
4466
 *
4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484
 * 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 已提交
4485
    clusterNode *n = NULL;
4486
    robj *firstkey = NULL;
4487
    int multiple_keys = 0;
A
antirez 已提交
4488 4489
    multiState *ms, _ms;
    multiCmd mc;
4490 4491 4492 4493
    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 已提交
4494 4495 4496 4497 4498 4499

    /* 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. */
4500
        if (!(c->flags & REDIS_MULTI)) return myself;
A
antirez 已提交
4501 4502
        ms = &c->mstate;
    } else {
4503 4504 4505
        /* 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 已提交
4506 4507 4508 4509 4510 4511 4512 4513
        ms = &_ms;
        _ms.commands = &mc;
        _ms.count = 1;
        mc.argv = argv;
        mc.argc = argc;
        mc.cmd = cmd;
    }

4514 4515
    /* Check that all the keys are in the same hash slot, and obtain this
     * slot and the node associated. */
A
antirez 已提交
4516 4517 4518 4519 4520 4521 4522 4523 4524
    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;

4525
        keyindex = getKeysFromCommand(mcmd,margv,margc,&numkeys);
A
antirez 已提交
4526
        for (j = 0; j < numkeys; j++) {
4527 4528 4529 4530
            robj *thiskey = margv[keyindex[j]];
            int thisslot = keyHashSlot((char*)thiskey->ptr,
                                       sdslen(thiskey->ptr));

4531 4532 4533
            if (firstkey == NULL) {
                /* This is the first key we see. Check what is the slot
                 * and node. */
4534 4535
                firstkey = thiskey;
                slot = thisslot;
4536
                n = server.cluster->slots[slot];
4537
                redisAssertWithInfo(c,firstkey,n != NULL);
4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549
                /* 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 已提交
4550
            } else {
4551 4552
                /* If it is not the first key, make sure it is exactly
                 * the same key as the first we saw. */
4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564
                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;
                    }
4565
                }
A
antirez 已提交
4566
            }
4567 4568 4569 4570 4571 4572 4573

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

4578
    /* No key at all in command? then we can serve the request
4579
     * without redirections or errors. */
4580
    if (n == NULL) return myself;
4581 4582

    /* Return the hashslot by reference. */
4583
    if (hashslot) *hashslot = slot;
4584

4585
    /* This request is about a slot we are migrating into another instance?
4586 4587 4588 4589 4590 4591 4592 4593 4594
     * 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];
    }

4595 4596 4597 4598
    /* 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. */
4599 4600 4601
    if (importing_slot &&
        (c->flags & REDIS_ASKING || cmd->flags & REDIS_CMD_ASKING))
    {
4602
        if (multiple_keys && missing_keys) {
4603 4604 4605 4606 4607
            if (error_code) *error_code = REDIS_CLUSTER_REDIR_UNSTABLE;
            return NULL;
        } else {
            return myself;
        }
4608
    }
4609

4610 4611 4612 4613 4614
    /* 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 &&
4615
        nodeIsSlave(myself) &&
4616
        myself->slaveof == n)
4617
    {
4618
        return myself;
4619
    }
4620 4621 4622 4623

    /* 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;
4624
    return n;
A
antirez 已提交
4625
}