cluster.c 135.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
/* Redis Cluster implementation.
 *
 * Copyright (c) 2009-2012, Salvatore Sanfilippo <antirez at gmail dot com>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   * Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *   * Neither the name of Redis nor the names of its contributors may be used
 *     to endorse or promote products derived from this software without
 *     specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

A
antirez 已提交
31
#include "redis.h"
32
#include "cluster.h"
33
#include "endianconv.h"
A
antirez 已提交
34

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

43 44 45 46 47
/* A global reference to myself is handy to make code more clear.
 * Myself always points to server.cluster->myself, that is, the clusterNode
 * that represents this node. */
clusterNode *myself = NULL;

48 49
clusterNode *createClusterNode(char *nodename, int flags);
int clusterAddNode(clusterNode *node);
A
antirez 已提交
50 51 52 53
void clusterAcceptHandler(aeEventLoop *el, int fd, void *privdata, int mask);
void clusterReadHandler(aeEventLoop *el, int fd, void *privdata, int mask);
void clusterSendPing(clusterLink *link, int type);
void clusterSendFail(char *nodename);
54
void clusterSendFailoverAuthIfNeeded(clusterNode *node, clusterMsg *request);
A
antirez 已提交
55 56
void clusterUpdateState(void);
int clusterNodeGetSlotBit(clusterNode *n, int slot);
57
sds clusterGenNodesDescription(int filter);
58 59
clusterNode *clusterLookupNode(char *name);
int clusterNodeAddSlave(clusterNode *master, clusterNode *slave);
60
int clusterAddSlot(clusterNode *n, int slot);
61
int clusterDelSlot(int slot);
62
int clusterDelNodeSlots(clusterNode *node);
63
int clusterNodeSetSlotBit(clusterNode *n, int slot);
64
void clusterSetMaster(clusterNode *n);
65
void clusterHandleSlaveFailover(void);
66
int bitmapTestBit(unsigned char *bitmap, int pos);
A
antirez 已提交
67
void clusterDoBeforeSleep(int flags);
68
void clusterSendUpdate(clusterLink *link, clusterNode *node);
A
antirez 已提交
69 70 71 72 73

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

74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
/* This function is called at startup in order to set the currentEpoch
 * (which is not saved on permanent storage) to the greatest configEpoch found
 * in the loaded nodes (configEpoch is stored on permanent storage as soon as
 * it changes for some node). */
void clusterSetStartupEpoch() {
    dictIterator *di;
    dictEntry *de;

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

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

    /* Parse the file. Note that single liens of the cluster config file can
     * be really long as they include all the hash slots of the node.
100 101 102 103 104 105
     * This means in the worst possible case, half of the Redis slots will be
     * present in a single line, possibly in importing or migrating state, so
     * together with the node ID of the sender/receiver.
     *
     * To simplify we allocate 1024+REDIS_CLUSTER_SLOTS*128 bytes per line. */
    maxline = 1024+REDIS_CLUSTER_SLOTS*128;
A
antirez 已提交
106 107 108
    line = zmalloc(maxline);
    while(fgets(line,maxline,fp) != NULL) {
        int argc;
109
        sds *argv;
110 111 112
        clusterNode *n, *master;
        char *p, *s;

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

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

122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
        /* Create this node if it does not exist */
        n = clusterLookupNode(argv[0]);
        if (!n) {
            n = createClusterNode(argv[0],0);
            clusterAddNode(n);
        }
        /* Address and port */
        if ((p = strchr(argv[1],':')) == NULL) goto fmterr;
        *p = '\0';
        memcpy(n->ip,argv[1],strlen(argv[1])+1);
        n->port = atoi(p+1);

        /* Parse flags */
        p = s = argv[2];
        while(p) {
            p = strchr(s,',');
            if (p) *p = '\0';
            if (!strcasecmp(s,"myself")) {
140
                redisAssert(server.cluster->myself == NULL);
141
                myself = server.cluster->myself = n;
142 143 144 145 146 147 148 149 150
                n->flags |= REDIS_NODE_MYSELF;
            } else if (!strcasecmp(s,"master")) {
                n->flags |= REDIS_NODE_MASTER;
            } else if (!strcasecmp(s,"slave")) {
                n->flags |= REDIS_NODE_SLAVE;
            } else if (!strcasecmp(s,"fail?")) {
                n->flags |= REDIS_NODE_PFAIL;
            } else if (!strcasecmp(s,"fail")) {
                n->flags |= REDIS_NODE_FAIL;
151
                n->fail_time = mstime();
152 153 154 155
            } else if (!strcasecmp(s,"handshake")) {
                n->flags |= REDIS_NODE_HANDSHAKE;
            } else if (!strcasecmp(s,"noaddr")) {
                n->flags |= REDIS_NODE_NOADDR;
156 157
            } else if (!strcasecmp(s,"noflags")) {
                /* nothing to do */
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
            } else {
                redisPanic("Unknown flag in redis cluster config file");
            }
            if (p) s = p+1;
        }

        /* Get master if any. Set the master and populate master's
         * slave list. */
        if (argv[3][0] != '-') {
            master = clusterLookupNode(argv[3]);
            if (!master) {
                master = createClusterNode(argv[3],0);
                clusterAddNode(master);
            }
            n->slaveof = master;
            clusterNodeAddSlave(master,n);
        }

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

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

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

A
antirez 已提交
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
            if (argv[j][0] == '[') {
                /* Here we handle migrating / importing slots */
                int slot;
                char direction;
                clusterNode *cn;

                p = strchr(argv[j],'-');
                redisAssert(p != NULL);
                *p = '\0';
                direction = p[1]; /* Either '>' or '<' */
                slot = atoi(argv[j]+1);
                p += 3;
                cn = clusterLookupNode(p);
                if (!cn) {
                    cn = createClusterNode(p,0);
                    clusterAddNode(cn);
                }
                if (direction == '>') {
205
                    server.cluster->migrating_slots_to[slot] = cn;
A
antirez 已提交
206
                } else {
207
                    server.cluster->importing_slots_from[slot] = cn;
A
antirez 已提交
208 209 210
                }
                continue;
            } else if ((p = strchr(argv[j],'-')) != NULL) {
211 212 213 214 215 216 217 218
                *p = '\0';
                start = atoi(argv[j]);
                stop = atoi(p+1);
            } else {
                start = stop = atoi(argv[j]);
            }
            while(start <= stop) clusterAddSlot(n, start++);
        }
A
antirez 已提交
219

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

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

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

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

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

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

err:
278
    if (fd != -1) close(fd);
A
antirez 已提交
279 280 281 282
    sdsfree(ci);
    return -1;
}

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

A
antirez 已提交
290
void clusterInit(void) {
291
    int saveconf = 0;
292

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

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

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

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

clusterLink *createClusterLink(clusterNode *node) {
    clusterLink *link = zmalloc(sizeof(*link));
354
    link->ctime = mstime();
A
antirez 已提交
355 356 357 358 359 360 361 362
    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.
363
 * This function will just make sure that the original node associated
A
antirez 已提交
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
 * with this link will have the 'link' field set to NULL. */
void freeClusterLink(clusterLink *link) {
    if (link->fd != -1) {
        aeDeleteFileEvent(server.el, link->fd, AE_WRITABLE);
        aeDeleteFileEvent(server.el, link->fd, AE_READABLE);
    }
    sdsfree(link->sndbuf);
    sdsfree(link->rcvbuf);
    if (link->node)
        link->node->link = NULL;
    close(link->fd);
    zfree(link);
}

void clusterAcceptHandler(aeEventLoop *el, int fd, void *privdata, int mask) {
    int cport, cfd;
380
    char cip[REDIS_IP_STR_LEN];
A
antirez 已提交
381 382 383 384 385
    clusterLink *link;
    REDIS_NOTUSED(el);
    REDIS_NOTUSED(mask);
    REDIS_NOTUSED(privdata);

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

    /* Use non-blocking I/O for cluster messages. */
395
    /* IPV6: might want to wrap a v6 address in [] */
A
antirez 已提交
396 397 398 399 400 401 402 403 404 405 406 407 408
    redisLog(REDIS_VERBOSE,"Accepted cluster node %s:%d", cip, cport);
    /* We need to create a temporary node in order to read the incoming
     * packet in a valid contest. This node will be released once we
     * read the packet and reply. */
    link = createClusterLink(NULL);
    link->fd = cfd;
    aeCreateFileEvent(server.el,cfd,AE_READABLE,clusterReadHandler,link);
}

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

409 410
/* We have 16384 hash slots. The hash slot of a given key is obtained
 * as the least significant 14 bits of the crc16 of the key. */
A
antirez 已提交
411
unsigned int keyHashSlot(char *key, int keylen) {
412
    return crc16(key,keylen) & 0x3FFF;
A
antirez 已提交
413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431
}

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

454 455 456 457 458
/* 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
459 460 461 462 463 464
 * '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) {
465 466 467 468 469 470 471 472 473 474 475
    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) {
476
            fr->time = mstime();
477
            return 0;
478 479 480 481 482 483
        }
    }

    /* Otherwise create a new report. */
    fr = zmalloc(sizeof(*fr));
    fr->node = sender;
484
    fr->time = mstime();
485
    listAddNodeTail(l,fr);
486
    return 1;
487 488
}

489 490 491 492 493 494 495 496 497 498
/* 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;
499
    mstime_t maxtime = server.cluster_node_timeout *
500
                     REDIS_CLUSTER_FAIL_REPORT_VALIDITY_MULT;
501
    mstime_t now = mstime();
502 503 504 505 506 507 508 509

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

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

    /* Remove the failure report. */
    listDelNode(l,ln);
537
    clusterNodeCleanupFailureReports(node);
538
    return 1;
539 540
}

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

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

A
antirez 已提交
585
    nodename = sdsnewlen(n->name, REDIS_CLUSTER_NAMELEN);
586
    redisAssert(dictDelete(server.cluster->nodes,nodename) == DICT_OK);
A
antirez 已提交
587 588 589
    sdsfree(nodename);
    if (n->slaveof) clusterNodeRemoveSlave(n->slaveof, n);
    if (n->link) freeClusterLink(n->link);
590
    listRelease(n->fail_reports);
A
antirez 已提交
591 592 593 594 595 596 597
    zfree(n);
}

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

A
antirez 已提交
603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
/* 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. */
625
    di = dictGetSafeIterator(server.cluster->nodes);
A
antirez 已提交
626 627 628 629 630 631 632 633 634 635 636 637
    while((de = dictNext(di)) != NULL) {
        clusterNode *node = dictGetVal(de);

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

    /* 3) Free the node, unlinking it from the cluster. */
    freeClusterNode(delnode);
}

A
antirez 已提交
638 639 640 641 642
/* Node lookup by name */
clusterNode *clusterLookupNode(char *name) {
    sds s = sdsnewlen(name, REDIS_CLUSTER_NAMELEN);
    struct dictEntry *de;

643
    de = dictFind(server.cluster->nodes,s);
A
antirez 已提交
644 645
    sdsfree(s);
    if (de == NULL) return NULL;
646
    return dictGetVal(de);
A
antirez 已提交
647 648 649 650 651 652 653 654 655 656 657 658
}

/* This is only used after the handshake. When we connect a given IP/PORT
 * as a result of CLUSTER MEET we don't have the node name yet, so we
 * pick a random one, and will fix it when we receive the PONG request using
 * this function. */
void clusterRenameNode(clusterNode *node, char *newname) {
    int retval;
    sds s = sdsnewlen(node->name, REDIS_CLUSTER_NAMELEN);
   
    redisLog(REDIS_DEBUG,"Renaming node %.40s into %.40s",
        node->name, newname);
659
    retval = dictDelete(server.cluster->nodes, s);
A
antirez 已提交
660 661 662 663 664 665
    sdsfree(s);
    redisAssert(retval == DICT_OK);
    memcpy(node->name, newname, REDIS_CLUSTER_NAMELEN);
    clusterAddNode(node);
}

666 667 668 669 670 671 672 673 674 675 676 677 678 679
/* -----------------------------------------------------------------------------
 * 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
680
 * in the cluster without dealing with the problem of other nodes re-adding
681 682
 * back the node to nodes we already sent the FORGET command to.
 *
683
 * The data structure used is a hash table with an sds string representing
684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716
 * 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();
717 718 719 720 721 722
    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);
723
    dictSetUnsignedIntegerVal(de,time(NULL)+REDIS_CLUSTER_BLACKLIST_TTL);
724
    sdsfree(id);
725 726 727 728 729 730 731 732 733
}

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

734
    clusterBlacklistCleanup();
735 736 737 738 739
    retval = dictFind(server.cluster->nodes_black_list,id) != NULL;
    sdsfree(id);
    return retval;
}

A
antirez 已提交
740 741 742 743
/* -----------------------------------------------------------------------------
 * CLUSTER messages exchange - PING/PONG and gossip
 * -------------------------------------------------------------------------- */

744 745 746
/* This function checks if a given node should be marked as FAIL.
 * It happens if the following conditions are met:
 *
747 748 749 750
 * 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.
751 752 753
 *
 * 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.
754 755 756 757 758 759 760 761 762 763
 *
 * 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.
764 765 766 767 768
 */
void markNodeAsFailingIfNeeded(clusterNode *node) {
    int failures;
    int needed_quorum = (server.cluster->size / 2) + 1;

769 770
    if (!nodeTimedOut(node)) return; /* We can reach it. */
    if (nodeFailed(node)) return; /* Already FAILing. */
771

772 773
    failures = clusterNodeFailureReportsCount(node);
    /* Also count myself as a voter if I'm a master. */
774
    if (nodeIsMaster(myself)) failures++;
775
    if (failures < needed_quorum) return; /* No weak agreement from masters. */
776 777 778 779 780 781 782

    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;
783
    node->fail_time = mstime();
784

785 786
    /* Broadcast the failing node name to everybody, forcing all the other
     * reachable nodes to flag the node as FAIL. */
787
    if (nodeIsMaster(myself)) clusterSendFail(node->name);
A
antirez 已提交
788
    clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
789 790 791 792
}

/* 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
793
 * state. */
794
void clearNodeFailureIfNeeded(clusterNode *node) {
795
    mstime_t now = mstime();
A
antirez 已提交
796

797
    redisAssert(nodeFailed(node));
A
antirez 已提交
798 799 800

    /* For slaves we always clear the FAIL flag if we can contact the
     * node again. */
801
    if (nodeIsSlave(node)) {
A
antirez 已提交
802
        redisLog(REDIS_NOTICE,
803
            "Clear FAIL state for node %.40s: slave is reachable again.",
A
antirez 已提交
804 805
                node->name);
        node->flags &= ~REDIS_NODE_FAIL;
A
antirez 已提交
806
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
A
antirez 已提交
807 808 809
    }

    /* If it is a master and...
810
     * 1) The FAIL state is old enough.
A
antirez 已提交
811 812
     * 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. */
813
    if (nodeIsMaster(node) && node->numslots > 0 &&
814
        (now - node->fail_time) >
815
        (server.cluster_node_timeout * REDIS_CLUSTER_FAIL_UNDO_TIME_MULT))
A
antirez 已提交
816
    {
817
        redisLog(REDIS_NOTICE,
A
antirez 已提交
818
            "Clear FAIL state for node %.40s: is reachable again and nobody is serving its slots after some time.",
819
                node->name);
820
        node->flags &= ~REDIS_NODE_FAIL;
A
antirez 已提交
821
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
822 823 824
    }
}

825 826 827 828 829 830 831 832 833 834 835
/* 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);

836
        if (!nodeInHandshake(node)) continue;
837 838 839 840 841 842
        if (!strcasecmp(node->ip,ip) && node->port == port) break;
    }
    dictReleaseIterator(di);
    return de != NULL;
}

843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900
/* Start an handshake with the specified address if there is not one
 * already in progress. Returns non-zero if the handshake was actually
 * started. On error zero is returned and errno is set to one of the
 * following values:
 *
 * EAGAIN - There is already an handshake in progress for this address.
 * EINVAL - IP or port are not valid. */
int clusterStartHandshake(char *ip, int port) {
    clusterNode *n;
    char norm_ip[REDIS_IP_STR_LEN];
    struct sockaddr_storage sa;

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

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

    /* Set norm_ip as the normalized string representation of the node
     * IP address. */
    if (sa.ss_family == AF_INET)
        inet_ntop(AF_INET,
            (void*)&(((struct sockaddr_in *)&sa)->sin_addr),
            norm_ip,REDIS_CLUSTER_IPLEN);
    else
        inet_ntop(AF_INET6,
            (void*)&(((struct sockaddr_in6 *)&sa)->sin6_addr),
            norm_ip,REDIS_CLUSTER_IPLEN);

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

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

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

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

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

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

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

            /* 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 已提交
964 965
        } else {
            /* If it's not in NOADDR state and we don't have it, we
966
             * start a handshake process against this IP/PORT pairs.
A
antirez 已提交
967 968 969 970
             *
             * 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. */
971 972 973 974
            if (sender &&
                !(flags & REDIS_NODE_NOADDR) &&
                !clusterBlacklistExists(g->nodename))
            {
975
                clusterStartHandshake(g->ip,ntohs(g->port));
976
            }
A
antirez 已提交
977 978 979 980 981 982 983
        }

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

984
/* IP -> string conversion. 'buf' is supposed to at least be 46 bytes. */
A
antirez 已提交
985
void nodeIp2String(char *buf, clusterLink *link) {
986
    struct sockaddr_storage sa;
A
antirez 已提交
987 988 989 990
    socklen_t salen = sizeof(sa);

    if (getpeername(link->fd, (struct sockaddr*) &sa, &salen) == -1)
        redisPanic("getpeername() failed.");
991 992 993 994 995 996 997 998

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


/* Update the node address to the IP address that can be extracted
A
antirez 已提交
1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
 * from link->fd, and at the specified port.
 * Also disconnect the node link so that we'll connect again to the new
 * address.
 *
 * If the ip/port pair are already correct no operation is performed at
 * all.
 *
 * The function returns 0 if the node address is still the same,
 * otherwise 1 is returned. */
int nodeUpdateAddressIfNeeded(clusterNode *node, clusterLink *link, int port) {
    char ip[REDIS_IP_STR_LEN];

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

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

    /* IP / port is different, update it. */
    memcpy(node->ip,ip,sizeof(ip));
    node->port = port;
    if (node->link) freeClusterLink(node->link);
    redisLog(REDIS_WARNING,"Address updated for node %.40s, now %s:%d",
        node->name, node->ip, node->port);
1032 1033 1034

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

1040 1041 1042 1043
/* 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) {
1044
    if (nodeIsMaster(n)) return;
1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075

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

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

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

    /* Here we set curmaster to this node or the node this node
     * replicates to if it's a slave. In the for loop we are
     * interested to check if slots are taken away from curmaster. */
1076
    curmaster = nodeIsMaster(myself) ? myself : myself->slaveof;
1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114

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

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

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

1132
    server.cluster->stats_bus_messages_received++;
1133 1134
    redisLog(REDIS_DEBUG,"--- Processing packet of type %d, %lu bytes",
        type, (unsigned long) totlen);
1135 1136

    /* Perform sanity checks */
A
antirez 已提交
1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147
    if (totlen < 8) return 1;
    if (totlen > sdslen(link->rcvbuf)) return 1;
    if (type == CLUSTERMSG_TYPE_PING || type == CLUSTERMSG_TYPE_PONG ||
        type == CLUSTERMSG_TYPE_MEET)
    {
        uint16_t count = ntohs(hdr->count);
        uint32_t explen; /* expected length of this packet */

        explen = sizeof(clusterMsg)-sizeof(union clusterMsgData);
        explen += (sizeof(clusterMsgDataGossip)*count);
        if (totlen != explen) return 1;
1148
    } else if (type == CLUSTERMSG_TYPE_FAIL) {
A
antirez 已提交
1149 1150 1151 1152
        uint32_t explen = sizeof(clusterMsg)-sizeof(union clusterMsgData);

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

1164 1165 1166 1167 1168
        if (totlen != explen) return 1;
    } else if (type == CLUSTERMSG_TYPE_UPDATE) {
        uint32_t explen = sizeof(clusterMsg)-sizeof(union clusterMsgData);

        explen += sizeof(clusterMsgDataUpdate);
1169
        if (totlen != explen) return 1;
1170
    }
A
antirez 已提交
1171

1172
    /* Check if the sender is a known node. */
A
antirez 已提交
1173
    sender = clusterLookupNode(hdr->sender);
1174
    if (sender && !nodeInHandshake(sender)) {
1175
        /* Update our curretEpoch if we see a newer epoch in the cluster. */
1176 1177 1178 1179
        senderCurrentEpoch = ntohu64(hdr->currentEpoch);
        senderConfigEpoch = ntohu64(hdr->configEpoch);
        if (senderCurrentEpoch > server.cluster->currentEpoch)
            server.cluster->currentEpoch = senderCurrentEpoch;
1180
        /* Update the sender configEpoch if it is publishing a newer one. */
1181
        if (senderConfigEpoch > sender->configEpoch) {
1182
            sender->configEpoch = senderConfigEpoch;
A
antirez 已提交
1183
            clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|CLUSTER_TODO_FSYNC_CONFIG);
1184
        }
1185 1186 1187
        /* Update the replication offset info for this node. */
        sender->repl_offset = ntohu64(hdr->offset);
        sender->repl_offset_time = mstime();
1188
    }
1189

1190
    /* Process packets by type. */
A
antirez 已提交
1191
    if (type == CLUSTERMSG_TYPE_PING || type == CLUSTERMSG_TYPE_MEET) {
1192
        redisLog(REDIS_DEBUG,"Ping packet received: %p", (void*)link->node);
A
antirez 已提交
1193 1194 1195 1196

        /* 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
1197
         * resolved when we'll receive PONGs from the node. */
A
antirez 已提交
1198 1199 1200 1201 1202 1203 1204
        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 已提交
1205
            clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG);
A
antirez 已提交
1206 1207 1208 1209 1210 1211 1212
        }

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

        /* Anyway reply with a PONG */
        clusterSendPing(link,CLUSTERMSG_TYPE_PONG);
1213 1214 1215
    }

    /* PING or PONG: process config information. */
1216 1217 1218
    if (type == CLUSTERMSG_TYPE_PING || type == CLUSTERMSG_TYPE_PONG ||
        type == CLUSTERMSG_TYPE_MEET)
    {
1219 1220 1221
        redisLog(REDIS_DEBUG,"%s packet received: %p",
            type == CLUSTERMSG_TYPE_PING ? "ping" : "pong",
            (void*)link->node);
A
antirez 已提交
1222
        if (link->node) {
1223
            if (nodeInHandshake(link->node)) {
A
antirez 已提交
1224 1225 1226 1227 1228
                /* If we already have this node, try to change the
                 * IP/port of the node with the new one. */
                if (sender) {
                    redisLog(REDIS_WARNING,
                        "Handshake error: we already know node %.40s, updating the address if needed.", sender->name);
A
antirez 已提交
1229 1230
                    if (nodeUpdateAddressIfNeeded(sender,link,ntohs(hdr->port)))
                    {
A
antirez 已提交
1231 1232
                        clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                                             CLUSTER_TODO_UPDATE_STATE);
A
antirez 已提交
1233 1234 1235 1236
                    }
                    /* Free this node as we alrady have it. This will
                     * cause the link to be freed as well. */
                    freeClusterNode(link->node);
A
antirez 已提交
1237 1238 1239 1240
                    return 0;
                }

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

A
antirez 已提交
1264 1265
        /* Update the node address if it changed. */
        if (sender && type == CLUSTERMSG_TYPE_PING &&
1266
            !nodeInHandshake(sender) &&
A
antirez 已提交
1267 1268
            nodeUpdateAddressIfNeeded(sender,link,ntohs(hdr->port)))
        {
A
antirez 已提交
1269
            clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|CLUSTER_TODO_UPDATE_STATE);
A
antirez 已提交
1270 1271
        }

A
antirez 已提交
1272
        /* Update our info about the node */
1273
        if (link->node && type == CLUSTERMSG_TYPE_PONG) {
1274
            link->node->pong_received = mstime();
1275 1276 1277
            link->node->ping_sent = 0;

            /* The PFAIL condition can be reversed without external
1278
             * help if it is momentary (that is, if it does not
1279 1280 1281 1282
             * turn into a FAIL state).
             *
             * The FAIL condition is also reversible under specific
             * conditions detected by clearNodeFailureIfNeeded(). */
1283
            if (nodeTimedOut(link->node)) {
1284
                link->node->flags &= ~REDIS_NODE_PFAIL;
A
antirez 已提交
1285 1286
                clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                                     CLUSTER_TODO_UPDATE_STATE);
1287
            } else if (nodeFailed(link->node)) {
1288 1289 1290
                clearNodeFailureIfNeeded(link->node);
            }
        }
A
antirez 已提交
1291

1292
        /* Check for role switch: slave -> master or master -> slave. */
A
antirez 已提交
1293 1294 1295 1296
        if (sender) {
            if (!memcmp(hdr->slaveof,REDIS_NODE_NULL_NAME,
                sizeof(hdr->slaveof)))
            {
1297
                /* Node is a master. */
1298
                clusterSetNodeAsMaster(sender);
A
antirez 已提交
1299
            } else {
1300
                /* Node is a slave. */
A
antirez 已提交
1301 1302
                clusterNode *master = clusterLookupNode(hdr->slaveof);

1303
                if (nodeIsMaster(sender)) {
1304
                    /* Master turned into a slave! Reconfigure the node. */
1305
                    clusterDelNodeSlots(sender);
1306 1307
                    sender->flags &= ~REDIS_NODE_MASTER;
                    sender->flags |= REDIS_NODE_SLAVE;
1308

1309 1310
                    /* Remove the list of slaves from the node. */
                    if (sender->numslaves) clusterNodeResetSlaves(sender);
1311 1312

                    /* Update config and state. */
A
antirez 已提交
1313 1314
                    clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                                         CLUSTER_TODO_UPDATE_STATE);
1315 1316
                }

1317 1318
                /* Master node changed for this slave? */
                if (sender->slaveof != master) {
1319 1320
                    if (sender->slaveof)
                        clusterNodeRemoveSlave(sender->slaveof,sender);
1321 1322
                    clusterNodeAddSlave(master,sender);
                    sender->slaveof = master;
1323 1324

                    /* Update config. */
A
antirez 已提交
1325
                    clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG);
1326
                }
A
antirez 已提交
1327 1328 1329
            }
        }

1330
        /* Update our info about served slots.
1331
         *
1332 1333
         * Note: this MUST happen after we update the master/slave state
         * so that REDIS_NODE_MASTER flag will be set. */
1334 1335

        /* Many checks are only needed if the set of served slots this
1336 1337 1338 1339
         * 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. */
1340 1341 1342
        int dirty_slots = 0; /* Sender claimed slots don't match my view? */

        if (sender) {
1343
            sender_master = nodeIsMaster(sender) ? sender : sender->slaveof;
1344 1345 1346 1347 1348 1349
            if (sender_master) {
                dirty_slots = memcmp(sender_master->slots,
                        hdr->myslots,sizeof(hdr->myslots)) != 0;
            }
        }

1350 1351 1352
        /* 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. */
1353
        if (sender && nodeIsMaster(sender) && dirty_slots)
1354
            clusterUpdateSlotsConfigWith(sender,senderConfigEpoch,hdr->myslots);
1355

1356 1357 1358
        /* 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.
1359
         *
1360 1361 1362 1363
         * 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:
1364 1365 1366 1367 1368 1369
         *
         * 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
1370 1371 1372 1373
         * 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). */
1374 1375 1376 1377 1378 1379 1380 1381 1382 1383
        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)
                    {
1384 1385
                        redisLog(REDIS_WARNING,
                            "Node %.40s has old slots configuration, sending "
1386
                            "an UPDATE message about %.40s",
1387 1388
                                sender->name, server.cluster->slots[j]->name);
                        clusterSendUpdate(sender->link,server.cluster->slots[j]);
1389 1390 1391 1392 1393

                        /* TODO: instead of exiting the loop send every other
                         * UPDATE packet for other nodes that are the new owner
                         * of sender's slots. */
                        break;
1394
                    }
1395
                }
A
antirez 已提交
1396 1397 1398 1399 1400
            }
        }

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

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

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

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

        /* If in our current config the node is a slave, set it as a master. */
1468
        if (nodeIsSlave(n)) clusterSetNodeAsMaster(n);
1469

1470 1471
        /* Check the bitmap of served slots and udpate our
         * config accordingly. */
1472 1473
        clusterUpdateSlotsConfigWith(n,reportedConfigEpoch,
            hdr->data.update.nodecfg.slots);
A
antirez 已提交
1474
    } else {
1475
        redisLog(REDIS_WARNING,"Received unknown packet type: %d", type);
A
antirez 已提交
1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500
    }
    return 1;
}

/* This function is called when we detect the link with this node is lost.
   We set the node as no longer connected. The Cluster Cron will detect
   this connection and will try to get it connected again.
   
   Instead if the node is a temporary node used to accept a query, we
   completely free the node on error. */
void handleLinkIOError(clusterLink *link) {
    freeClusterLink(link);
}

/* Send data. This is handled using a trivial send buffer that gets
 * consumed by write(). We don't try to optimize this for speed too much
 * as this is a very low traffic channel. */
void clusterWriteHandler(aeEventLoop *el, int fd, void *privdata, int mask) {
    clusterLink *link = (clusterLink*) privdata;
    ssize_t nwritten;
    REDIS_NOTUSED(el);
    REDIS_NOTUSED(mask);

    nwritten = write(fd, link->sndbuf, sdslen(link->sndbuf));
    if (nwritten <= 0) {
1501
        redisLog(REDIS_DEBUG,"I/O error writing to node link: %s",
A
antirez 已提交
1502 1503 1504 1505
            strerror(errno));
        handleLinkIOError(link);
        return;
    }
1506
    sdsrange(link->sndbuf,nwritten,-1);
A
antirez 已提交
1507 1508 1509 1510 1511 1512 1513 1514
    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) {
1515
    char buf[sizeof(clusterMsg)];
A
antirez 已提交
1516 1517 1518
    ssize_t nread;
    clusterMsg *hdr;
    clusterLink *link = (clusterLink*) privdata;
1519
    int readlen, rcvbuflen;
A
antirez 已提交
1520 1521 1522
    REDIS_NOTUSED(el);
    REDIS_NOTUSED(mask);

1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539
    while(1) { /* Read as long as there is data to read. */
        rcvbuflen = sdslen(link->rcvbuf);
        if (rcvbuflen < 4) {
            /* First, obtain the first four bytes to get the full message
             * length. */
            readlen = 4 - rcvbuflen;
        } else {
            /* Finally read the full message. */
            hdr = (clusterMsg*) link->rcvbuf;
            if (rcvbuflen == 4) {
                /* Perform some sanity check on the message length. */
                if (ntohl(hdr->totlen) < CLUSTERMSG_MIN_LEN) {
                    redisLog(REDIS_WARNING,
                        "Bad message length received from Cluster bus.");
                    handleLinkIOError(link);
                    return;
                }
1540
            }
1541 1542
            readlen = ntohl(hdr->totlen) - rcvbuflen;
            if (readlen > sizeof(buf)) readlen = sizeof(buf);
1543
        }
A
antirez 已提交
1544

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

1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559
        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 已提交
1560

1561 1562 1563 1564 1565 1566 1567 1568
        /* Total length obtained? Process this packet. */
        if (rcvbuflen >= 4 && rcvbuflen == ntohl(hdr->totlen)) {
            if (clusterProcessPacket(link)) {
                sdsfree(link->rcvbuf);
                link->rcvbuf = sdsempty();
            } else {
                return; /* Link no longer valid. */
            }
A
antirez 已提交
1569 1570 1571 1572
        }
    }
}

1573 1574 1575 1576 1577
/* 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 已提交
1578 1579 1580 1581 1582 1583
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);
1584
    server.cluster->stats_bus_messages_sent++;
A
antirez 已提交
1585 1586
}

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

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

        if (!node->link) continue;
1602 1603
        if (node->flags & (REDIS_NODE_MYSELF|REDIS_NODE_HANDSHAKE))
            continue;
1604 1605 1606 1607 1608
        clusterSendMessage(node->link,buf,len);
    }
    dictReleaseIterator(di);
}

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

    /* 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. */
1619
    master = (nodeIsSlave(myself) && myself->slaveof) ?
1620
              myself->slaveof : myself;
A
antirez 已提交
1621 1622 1623

    memset(hdr,0,sizeof(*hdr));
    hdr->type = htons(type);
1624
    memcpy(hdr->sender,myself->name,REDIS_CLUSTER_NAMELEN);
1625 1626

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

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

1638
    /* Set the replication offset. */
1639 1640 1641
    if (nodeIsSlave(myself))
        offset = replicationGetSlaveOffset();
    else
1642 1643 1644 1645 1646
        offset = server.master_repl_offset;
    hdr->offset = htonu64(offset);

    /* Compute the message length for certain messages. For other messages
     * this is up to the caller. */
A
antirez 已提交
1647 1648 1649
    if (type == CLUSTERMSG_TYPE_FAIL) {
        totlen = sizeof(clusterMsg)-sizeof(union clusterMsgData);
        totlen += sizeof(clusterMsgDataFail);
1650 1651 1652
    } else if (type == CLUSTERMSG_TYPE_UPDATE) {
        totlen = sizeof(clusterMsg)-sizeof(union clusterMsgData);
        totlen += sizeof(clusterMsgDataUpdate);
A
antirez 已提交
1653 1654
    }
    hdr->totlen = htonl(totlen);
1655
    /* For PING, PONG, and MEET, fixing the totlen field is up to the caller. */
A
antirez 已提交
1656 1657 1658 1659 1660
}

/* Send a PING or PONG packet to the specified node, making sure to add enough
 * gossip informations. */
void clusterSendPing(clusterLink *link, int type) {
1661
    unsigned char buf[sizeof(clusterMsg)];
A
antirez 已提交
1662 1663 1664 1665 1666 1667 1668 1669
    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. */
1670
    int freshnodes = dictSize(server.cluster->nodes)-2;
A
antirez 已提交
1671 1672

    if (link->node && type == CLUSTERMSG_TYPE_PING)
1673
        link->node->ping_sent = mstime();
A
antirez 已提交
1674 1675 1676 1677
    clusterBuildMessageHdr(hdr,type);
        
    /* Populate the gossip fields */
    while(freshnodes > 0 && gossipcount < 3) {
1678
        struct dictEntry *de = dictGetRandomKey(server.cluster->nodes);
1679
        clusterNode *this = dictGetVal(de);
A
antirez 已提交
1680 1681 1682
        clusterMsgDataGossip *gossip;
        int j;

1683 1684 1685 1686 1687 1688
        /* 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.
         */
1689
        if (this == myself ||
1690
            this->flags & (REDIS_NODE_HANDSHAKE|REDIS_NODE_NOADDR) ||
1691
            (this->link == NULL && this->numslots == 0))
1692
        {
A
antirez 已提交
1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721
                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);
}

1722 1723
/* Send a PONG packet to every connected node that's not in handshake state
 * and for which we have a valid link.
1724
 *
1725 1726
 * In Redis Cluster pongs are not used just for failure detection, but also
 * to carry important configuration information. So broadcasting a pong is
1727
 * useful when something changes in the configuration and we want to make
1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738
 * 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) {
1739 1740 1741
    dictIterator *di;
    dictEntry *de;

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

1746
        if (!node->link) continue;
1747
        if (node == myself || nodeInHandshake(node)) continue;
1748 1749
        if (target == CLUSTER_BROADCAST_LOCAL_SLAVES) {
            int local_slave =
1750
                nodeIsSlave(node) && node->slaveof &&
1751 1752 1753
                (node->slaveof == myself || node->slaveof == myself->slaveof);
            if (!local_slave) continue;
        }
1754 1755 1756 1757 1758
        clusterSendPing(node->link,CLUSTERMSG_TYPE_PONG);
    }
    dictReleaseIterator(di);
}

1759 1760 1761 1762
/* 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) {
1763
    unsigned char buf[sizeof(clusterMsg)], *payload;
1764 1765 1766
    clusterMsg *hdr = (clusterMsg*) buf;
    uint32_t totlen;
    uint32_t channel_len, message_len;
A
antirez 已提交
1767

1768 1769 1770 1771
    channel = getDecodedObject(channel);
    message = getDecodedObject(message);
    channel_len = sdslen(channel->ptr);
    message_len = sdslen(message->ptr);
A
antirez 已提交
1772

1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785
    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);
1786
        memcpy(payload,hdr,sizeof(*hdr));
1787
        hdr = (clusterMsg*) payload;
A
antirez 已提交
1788
    }
1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800
    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 已提交
1801 1802 1803 1804 1805 1806 1807 1808
}

/* 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) {
1809
    unsigned char buf[sizeof(clusterMsg)];
A
antirez 已提交
1810 1811 1812 1813 1814 1815 1816
    clusterMsg *hdr = (clusterMsg*) buf;

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

1817 1818 1819 1820
/* 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) {
1821
    unsigned char buf[sizeof(clusterMsg)];
1822 1823
    clusterMsg *hdr = (clusterMsg*) buf;

1824
    if (link == NULL) return;
1825 1826 1827 1828 1829 1830 1831
    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));
}

1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842
/* -----------------------------------------------------------------------------
 * 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);
}

1843 1844 1845 1846
/* -----------------------------------------------------------------------------
 * SLAVE node specific functions
 * -------------------------------------------------------------------------- */

1847 1848 1849 1850 1851 1852 1853
/* 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) {
1854
    unsigned char buf[sizeof(clusterMsg)];
1855 1856 1857 1858 1859 1860
    clusterMsg *hdr = (clusterMsg*) buf;
    uint32_t totlen;

    clusterBuildMessageHdr(hdr,CLUSTERMSG_TYPE_FAILOVER_AUTH_REQUEST);
    totlen = sizeof(clusterMsg)-sizeof(union clusterMsgData);
    hdr->totlen = htonl(totlen);
1861
    clusterBroadcastMessage(buf,totlen);
1862 1863
}

1864 1865
/* Send a FAILOVER_AUTH_ACK message to the specified node. */
void clusterSendFailoverAuth(clusterNode *node) {
1866
    unsigned char buf[sizeof(clusterMsg)];
1867 1868 1869 1870 1871 1872 1873
    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);
1874
    clusterSendMessage(node->link,buf,totlen);
1875 1876
}

1877
/* Vote for the node asking for our vote if there are the conditions. */
1878
void clusterSendFailoverAuthIfNeeded(clusterNode *node, clusterMsg *request) {
1879
    clusterNode *master = node->slaveof;
1880 1881 1882 1883
    uint64_t requestCurrentEpoch = ntohu64(request->currentEpoch);
    uint64_t requestConfigEpoch = ntohu64(request->configEpoch);
    unsigned char *claimed_slots = request->myslots;
    int j;
1884 1885 1886

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

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

1894
    /* I already voted for this epoch? Return ASAP. */
1895
    if (server.cluster->last_vote_epoch == server.cluster->currentEpoch) return;
1896 1897

    /* Node must be a slave and its master down. */
1898
    if (nodeIsMaster(node) || master == NULL || !nodeFailed(master)) return;
1899

1900 1901 1902
    /* 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. */
1903 1904
    if (mstime() - node->slaveof->voted_time < server.cluster_node_timeout * 2)
        return;
1905

1906 1907 1908
    /* 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. */
1909 1910 1911 1912 1913 1914 1915 1916 1917 1918
    for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
        if (bitmapTestBit(claimed_slots, j) == 0) continue;
        if (server.cluster->slots[j] == NULL ||
            server.cluster->slots[j]->configEpoch <= requestConfigEpoch) continue;
        /* If we reached this point we found a slot that in our current slots
         * is served by a master with a greater configEpoch than the one claimed
         * by the slave requesting our vote. Refuse to vote for this slave. */
        return;
    }

1919
    /* We can vote for this slave. */
1920
    clusterSendFailoverAuth(node);
1921
    server.cluster->last_vote_epoch = server.cluster->currentEpoch;
1922
    node->slaveof->voted_time = mstime();
1923 1924
}

1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952
/* 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;
}

1953
/* This function is called if we are a slave node and our master serving
1954
 * a non-zero amount of hash slots is in FAIL state.
1955 1956 1957
 *
 * The gaol of this function is:
 * 1) To check if we are able to perform a failover, is our data updated?
1958
 * 2) Try to get elected by masters.
1959
 * 3) Perform the failover informing all the other nodes.
1960 1961
 */
void clusterHandleSlaveFailover(void) {
1962
    mstime_t data_age;
1963
    mstime_t auth_age = mstime() - server.cluster->failover_auth_time;
1964
    int needed_quorum = (server.cluster->size / 2) + 1;
1965
    int j;
1966

1967 1968
    /* Set data_age to the number of seconds we are disconnected from
     * the master. */
1969
    if (server.repl_state == REDIS_REPL_CONNECTED) {
1970
        data_age = (server.unixtime - server.master->lastinteraction) * 1000;
1971
    } else {
1972
        data_age = (server.unixtime - server.repl_down_since) * 1000;
1973 1974
    }

1975 1976 1977 1978
    /* Pre conditions to run the function:
     * 1) We are a slave.
     * 2) Our master is flagged as FAIL.
     * 3) It is serving slots. */
1979
    if (nodeIsMaster(myself) ||
1980
        myself->slaveof == NULL ||
1981
        !nodeFailed(myself->slaveof) ||
1982
        myself->slaveof->numslots == 0) return;
1983

1984 1985 1986 1987 1988 1989
    /* 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;

1990 1991 1992
    /* Check if our data is recent enough. For now we just use a fixed
     * constant of ten times the node timeout since the cluster should
     * react much faster to a master down. */
1993
    if (data_age >
1994 1995
        (server.repl_ping_slave_period * 1000) +
        (server.cluster_node_timeout * REDIS_CLUSTER_SLAVE_VALIDITY_MULT))
1996
        return;
1997

1998
    /* Compute the time at which we can start an election. */
1999
    if (auth_age >
2000
        server.cluster_node_timeout * REDIS_CLUSTER_FAILOVER_AUTH_RETRY_MULT)
2001
    {
2002 2003 2004
        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. */
2005
        server.cluster->failover_auth_count = 0;
2006
        server.cluster->failover_auth_sent = 0;
2007 2008 2009 2010 2011 2012
        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;
2013
        redisLog(REDIS_WARNING,
2014 2015
            "Start of election delayed for %lld milliseconds "
            "(rank #%d, offset %lld).",
2016
            server.cluster->failover_auth_time - mstime(),
2017 2018
            server.cluster->failover_auth_rank,
            replicationGetSlaveOffset());
2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035
        return;
    }

    /* It is possible that we received more updated offsets from other
     * slaves for the same master since we computed our election delay.
     * Update the delay if our rank changed. */
    if (server.cluster->failover_auth_sent == 0) {
        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);
        }
2036 2037 2038 2039 2040 2041 2042
        return;
    }

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

    /* Return ASAP if the election is too old to be valid. */
2043
    if (auth_age > server.cluster_node_timeout) return;
2044 2045 2046 2047 2048 2049

    /* 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.",
2050
            (unsigned long long) server.cluster->currentEpoch);
2051
        clusterRequestFailoverAuth();
2052
        server.cluster->failover_auth_sent = 1;
A
antirez 已提交
2053 2054 2055
        clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                             CLUSTER_TODO_UPDATE_STATE|
                             CLUSTER_TODO_FSYNC_CONFIG);
2056 2057 2058 2059
        return; /* Wait for replies. */
    }

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

2063
        redisLog(REDIS_WARNING,
A
antirez 已提交
2064
            "Failover election won: I'm the new master.");
A
antirez 已提交
2065 2066 2067 2068
        /* We have the quorum, perform all the steps to correctly promote
         * this slave to a master.
         *
         * 1) Turn this node into a master. */
2069 2070 2071 2072
        clusterNodeRemoveSlave(myself->slaveof, myself);
        myself->flags &= ~REDIS_NODE_SLAVE;
        myself->flags |= REDIS_NODE_MASTER;
        myself->slaveof = NULL;
A
antirez 已提交
2073 2074
        replicationUnsetMaster();

2075 2076 2077 2078
        /* 2) Claim all the slots assigned to our master. */
        for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
            if (clusterNodeGetSlotBit(oldmaster,j)) {
                clusterDelSlot(j);
2079
                clusterAddSlot(myself,j);
2080 2081 2082
            }
        }

2083
        /* 3) Update my configEpoch to the epoch of the election. */
2084
        myself->configEpoch = server.cluster->failover_auth_epoch;
2085

2086
        /* 4) Update state and save config. */
2087
        clusterUpdateState();
A
antirez 已提交
2088
        clusterSaveConfigOrDie(1);
2089 2090 2091

        /* 5) Pong all the other nodes so that they can update the state
         *    accordingly and detect that we switched to master role. */
2092
        clusterBroadcastPong(CLUSTER_BROADCAST_ALL);
2093
    }
2094 2095
}

A
antirez 已提交
2096 2097 2098 2099
/* -----------------------------------------------------------------------------
 * CLUSTER cron job
 * -------------------------------------------------------------------------- */

2100
/* This is executed 10 times every second */
A
antirez 已提交
2101 2102 2103
void clusterCron(void) {
    dictIterator *di;
    dictEntry *de;
2104
    int j, update_state = 0;
2105
    mstime_t min_pong = 0, now = mstime();
2106
    clusterNode *min_pong_node = NULL;
2107
    static unsigned long long iteration = 0;
2108
    mstime_t handshake_timeout;
2109 2110

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

2112
    /* The handshake timeout is the time after which a handshake node that was
2113 2114 2115 2116 2117 2118
     * 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 已提交
2119
    /* Check if we have disconnected nodes and re-establish the connection. */
2120
    di = dictGetSafeIterator(server.cluster->nodes);
A
antirez 已提交
2121
    while((de = dictNext(di)) != NULL) {
2122
        clusterNode *node = dictGetVal(de);
A
antirez 已提交
2123 2124

        if (node->flags & (REDIS_NODE_MYSELF|REDIS_NODE_NOADDR)) continue;
2125 2126 2127

        /* A Node in HANDSHAKE state has a limited lifespan equal to the
         * configured node timeout. */
2128
        if (nodeInHandshake(node) && now - node->ctime > handshake_timeout) {
2129 2130 2131 2132
            freeClusterNode(node);
            continue;
        }

A
antirez 已提交
2133 2134
        if (node->link == NULL) {
            int fd;
2135
            mstime_t old_ping_sent;
A
antirez 已提交
2136 2137 2138 2139 2140 2141 2142 2143 2144
            clusterLink *link;

            fd = anetTcpNonBlockConnect(server.neterr, node->ip,
                node->port+REDIS_CLUSTER_PORT_INCR);
            if (fd == -1) continue;
            link = createClusterLink(node);
            link->fd = fd;
            node->link = link;
            aeCreateFileEvent(server.el,link->fd,AE_READABLE,clusterReadHandler,link);
2145 2146 2147 2148
            /* 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 已提交
2149 2150
             * of a PING one, to force the receiver to add us in its node
             * table. */
2151
            old_ping_sent = node->ping_sent;
A
antirez 已提交
2152 2153
            clusterSendPing(link, node->flags & REDIS_NODE_MEET ?
                    CLUSTERMSG_TYPE_MEET : CLUSTERMSG_TYPE_PING);
2154 2155 2156 2157 2158 2159
            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 已提交
2160 2161 2162 2163 2164 2165 2166
            /* 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;

2167
            redisLog(REDIS_DEBUG,"Connecting with Node %.40s at %s:%d", node->name, node->ip, node->port+REDIS_CLUSTER_PORT_INCR);
A
antirez 已提交
2168 2169 2170 2171
        }
    }
    dictReleaseIterator(di);

2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191
    /* Ping some random node 1 time every 10 iterations, so that we usually ping
     * one random node every second. */
    if (!(iteration % 10)) {
        /* Check a few random nodes and ping the one with the oldest
         * pong_received time. */
        for (j = 0; j < 5; j++) {
            de = dictGetRandomKey(server.cluster->nodes);
            clusterNode *this = dictGetVal(de);

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

    /* Iterate nodes to check if we need to flag something as failing */
2196
    di = dictGetSafeIterator(server.cluster->nodes);
A
antirez 已提交
2197
    while((de = dictNext(di)) != NULL) {
2198
        clusterNode *node = dictGetVal(de);
2199
        now = mstime(); /* Use an updated time at every iteration. */
2200
        mstime_t delay;
A
antirez 已提交
2201 2202

        if (node->flags &
2203 2204
            (REDIS_NODE_MYSELF|REDIS_NODE_NOADDR|REDIS_NODE_HANDSHAKE))
                continue;
2205

2206 2207 2208 2209
        /* 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 */
2210
            now - node->link->ctime >
2211
            server.cluster_node_timeout && /* was not already reconnected */
2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224
            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. */
2225
        if (node->link &&
2226 2227
            node->ping_sent == 0 &&
            (now - node->pong_received) > server.cluster_node_timeout/2)
2228 2229 2230 2231 2232
        {
            clusterSendPing(node->link, CLUSTERMSG_TYPE_PING);
            continue;
        }

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

2236 2237 2238 2239
        /* 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;
2240

2241
        if (delay > server.cluster_node_timeout) {
G
guiquanz 已提交
2242
            /* Timeout reached. Set the node as possibly failing if it is
2243
             * not already in this state. */
2244
            if (!(node->flags & (REDIS_NODE_PFAIL|REDIS_NODE_FAIL))) {
A
antirez 已提交
2245 2246 2247
                redisLog(REDIS_DEBUG,"*** NODE %.40s possibly failing",
                    node->name);
                node->flags |= REDIS_NODE_PFAIL;
2248
                update_state = 1;
A
antirez 已提交
2249 2250 2251 2252
            }
        }
    }
    dictReleaseIterator(di);
2253 2254 2255 2256

    /* 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. */
2257
    if (nodeIsSlave(myself) &&
2258
        server.masterhost == NULL &&
2259
        myself->slaveof &&
2260
        nodeHasAddr(myself->slaveof))
2261
    {
2262
        replicationSetMaster(myself->slaveof->ip, myself->slaveof->port);
2263
    }
2264

2265
    clusterHandleSlaveFailover();
2266 2267
    if (update_state || server.cluster->state == REDIS_CLUSTER_FAIL)
        clusterUpdateState();
2268 2269 2270 2271 2272
}

/* 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 已提交
2273 2274
 * handlers, or to perform potentially expansive tasks that we need to do
 * a single time before replying to clients. */
2275
void clusterBeforeSleep(void) {
A
antirez 已提交
2276 2277 2278
    /* 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)
2279
        clusterHandleSlaveFailover();
A
antirez 已提交
2280 2281 2282 2283 2284 2285 2286 2287 2288

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

    /* Save the config, possibly using fsync. */
    if (server.cluster->todo_before_sleep & CLUSTER_TODO_SAVE_CONFIG) {
        int fsync = server.cluster->todo_before_sleep & CLUSTER_TODO_FSYNC_CONFIG;
        clusterSaveConfigOrDie(fsync);
2289
    }
A
antirez 已提交
2290 2291 2292 2293 2294 2295 2296

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

void clusterDoBeforeSleep(int flags) {
    server.cluster->todo_before_sleep |= flags;
A
antirez 已提交
2297 2298 2299 2300 2301 2302
}

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

2303
/* Test bit 'pos' in a generic bitmap. Return 1 if the bit is set,
2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324
 * 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 已提交
2325 2326
/* Set the slot bit and return the old value. */
int clusterNodeSetSlotBit(clusterNode *n, int slot) {
2327 2328
    int old = bitmapTestBit(n->slots,slot);
    bitmapSetBit(n->slots,slot);
2329
    if (!old) n->numslots++;
A
antirez 已提交
2330 2331 2332 2333 2334
    return old;
}

/* Clear the slot bit and return the old value. */
int clusterNodeClearSlotBit(clusterNode *n, int slot) {
2335 2336
    int old = bitmapTestBit(n->slots,slot);
    bitmapClearBit(n->slots,slot);
2337
    if (old) n->numslots--;
A
antirez 已提交
2338 2339 2340 2341 2342
    return old;
}

/* Return the slot bit from the cluster node structure. */
int clusterNodeGetSlotBit(clusterNode *n, int slot) {
2343
    return bitmapTestBit(n->slots,slot);
A
antirez 已提交
2344 2345 2346 2347 2348 2349 2350
}

/* 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) {
2351 2352
    if (server.cluster->slots[slot]) return REDIS_ERR;
    clusterNodeSetSlotBit(n,slot);
2353
    server.cluster->slots[slot] = n;
A
antirez 已提交
2354 2355 2356
    return REDIS_OK;
}

A
antirez 已提交
2357 2358 2359 2360
/* 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) {
2361
    clusterNode *n = server.cluster->slots[slot];
A
antirez 已提交
2362 2363 2364

    if (!n) return REDIS_ERR;
    redisAssert(clusterNodeClearSlotBit(n,slot) == 1);
2365
    server.cluster->slots[slot] = NULL;
A
antirez 已提交
2366 2367 2368
    return REDIS_OK;
}

2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380
/* 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 已提交
2381 2382 2383
/* -----------------------------------------------------------------------------
 * Cluster state evaluation function
 * -------------------------------------------------------------------------- */
2384

2385 2386 2387 2388
/* 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. */
2389
#define REDIS_CLUSTER_MAX_REJOIN_DELAY 5000
2390
#define REDIS_CLUSTER_MIN_REJOIN_DELAY 500
2391
#define REDIS_CLUSTER_WRITABLE_DELAY 2000
2392

A
antirez 已提交
2393
void clusterUpdateState(void) {
2394
    int j, new_state;
2395
    int unreachable_masters = 0;
2396
    static mstime_t among_minority_time;
2397 2398 2399 2400 2401 2402 2403 2404 2405
    static mstime_t first_call_time = 0;

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

2409 2410
    /* Start assuming the state is OK. We'll turn it into FAIL if there
     * are the right conditions. */
2411
    new_state = REDIS_CLUSTER_OK;
2412

2413
    /* Check if all the slots are covered. */
A
antirez 已提交
2414
    for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
2415 2416
        if (server.cluster->slots[j] == NULL ||
            server.cluster->slots[j]->flags & (REDIS_NODE_FAIL))
A
antirez 已提交
2417
        {
2418
            new_state = REDIS_CLUSTER_FAIL;
A
antirez 已提交
2419 2420 2421
            break;
        }
    }
2422

2423
    /* Compute the cluster size, that is the number of master nodes
2424 2425 2426 2427
     * serving at least a single slot.
     *
     * At the same time count the number of unreachable masters with
     * at least one node. */
2428 2429 2430 2431 2432
    {
        dictIterator *di;
        dictEntry *de;

        server.cluster->size = 0;
2433
        di = dictGetSafeIterator(server.cluster->nodes);
2434 2435 2436
        while((de = dictNext(di)) != NULL) {
            clusterNode *node = dictGetVal(de);

2437
            if (nodeIsMaster(node) && node->numslots) {
2438
                server.cluster->size++;
2439 2440 2441
                if (node->flags & (REDIS_NODE_FAIL|REDIS_NODE_PFAIL))
                    unreachable_masters++;
            }
2442 2443 2444
        }
        dictReleaseIterator(di);
    }
2445

2446
    /* If we can't reach at least half the masters, change the cluster state
2447
     * to FAIL, as we are not even able to mark nodes as FAIL in this side
2448
     * of the netsplit because of lack of majority. */
2449 2450 2451
    {
        int needed_quorum = (server.cluster->size / 2) + 1;
        
2452 2453 2454 2455
        if (unreachable_masters >= needed_quorum) {
            new_state = REDIS_CLUSTER_FAIL;
            among_minority_time = mstime();
        }
2456 2457
    }

2458
    /* Log a state change */
2459 2460 2461 2462 2463 2464 2465 2466 2467
    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;
2468 2469
        if (rejoin_delay < REDIS_CLUSTER_MIN_REJOIN_DELAY)
            rejoin_delay = REDIS_CLUSTER_MIN_REJOIN_DELAY;
2470 2471

        if (new_state == REDIS_CLUSTER_OK &&
2472
            nodeIsMaster(myself) &&
2473 2474 2475 2476 2477 2478
            mstime() - among_minority_time < rejoin_delay)
        {
            return;
        }

        /* Change the state and log the event. */
2479
        redisLog(REDIS_WARNING,"Cluster state changed: %s",
2480 2481 2482
            new_state == REDIS_CLUSTER_OK ? "ok" : "fail");
        server.cluster->state = new_state;
    }
A
antirez 已提交
2483 2484
}

2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507
/* This function is called 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) {
2508 2509 2510
    int j;
    int update_config = 0;

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

2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526
    /* 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. */
2527
        if (server.cluster->slots[j] == myself ||
2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539
            server.cluster->importing_slots_from[j] != NULL) continue;

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

        update_config++;
        /* Case A: slot is unassigned. Take responsability for it. */
        if (server.cluster->slots[j] == NULL) {
            redisLog(REDIS_WARNING, "I've keys about slot %d that is "
                                    "unassigned. Taking responsability "
                                    "for it.",j);
2540
            clusterAddSlot(myself,j);
2541 2542 2543 2544 2545 2546 2547
        } else {
            redisLog(REDIS_WARNING, "I've keys about slot %d that is "
                                    "already assigned to a different node. "
                                    "Setting it in importing state.",j);
            server.cluster->importing_slots_from[j] = server.cluster->slots[j];
        }
    }
A
antirez 已提交
2548
    if (update_config) clusterSaveConfigOrDie(1);
2549 2550 2551
    return REDIS_OK;
}

2552 2553 2554 2555
/* -----------------------------------------------------------------------------
 * SLAVE nodes handling
 * -------------------------------------------------------------------------- */

2556 2557
/* Set the specified node 'n' as master. Setup the node as a slave if
 * needed. */
2558 2559
void clusterSetMaster(clusterNode *n) {
    redisAssert(n != myself);
2560
    redisAssert(myself->numslots == 0);
2561

2562
    if (nodeIsMaster(myself)) {
2563 2564
        myself->flags &= ~REDIS_NODE_MASTER;
        myself->flags |= REDIS_NODE_SLAVE;
2565 2566 2567
    } else {
        if (myself->slaveof)
            clusterNodeRemoveSlave(myself->slaveof,myself);
2568 2569
    }
    myself->slaveof = n;
2570
    clusterNodeAddSlave(n,myself);
2571
    replicationSetMaster(n->ip, n->port);
2572 2573
}

A
antirez 已提交
2574 2575 2576 2577
/* -----------------------------------------------------------------------------
 * CLUSTER command
 * -------------------------------------------------------------------------- */

2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 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 2645 2646 2647 2648 2649 2650 2651 2652 2653
/* Generate a csv-alike representation of the specified cluster node.
 * See clusterGenNodesDescription() top comment for more information.
 *
 * The function returns the string representation as an SDS string. */
sds clusterGenNodeDescription(clusterNode *node) {
    int j, start;
    sds ci;

    /* Node coordinates */
    ci = sdscatprintf(sdsempty(),"%.40s %s:%d ",
        node->name,
        node->ip,
        node->port);

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

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

    /* Latency from the POV of this node, link status */
    ci = sdscatprintf(ci,"%lld %lld %llu %s",
        (long long) node->ping_sent,
        (long long) node->pong_received,
        (unsigned long long) node->configEpoch,
        (node->link || node->flags & REDIS_NODE_MYSELF) ?
                    "connected" : "disconnected");

    /* Slots served by this instance */
    start = -1;
    for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
        int bit;

        if ((bit = clusterNodeGetSlotBit(node,j)) != 0) {
            if (start == -1) start = j;
        }
        if (start != -1 && (!bit || j == REDIS_CLUSTER_SLOTS-1)) {
            if (j == REDIS_CLUSTER_SLOTS-1) j++;

            if (start == j-1) {
                ci = sdscatprintf(ci," %d",start);
            } else {
                ci = sdscatprintf(ci," %d-%d",start,j-1);
            }
            start = -1;
        }
    }

    /* Just for MYSELF node we also dump info about slots that
     * we are migrating to other instances or importing from other
     * instances. */
    if (node->flags & REDIS_NODE_MYSELF) {
        for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
            if (server.cluster->migrating_slots_to[j]) {
                ci = sdscatprintf(ci," [%d->-%.40s]",j,
                    server.cluster->migrating_slots_to[j]->name);
            } else if (server.cluster->importing_slots_from[j]) {
                ci = sdscatprintf(ci," [%d-<-%.40s]",j,
                    server.cluster->importing_slots_from[j]->name);
            }
        }
    }
    return ci;
}

2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666
/* 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) {
2667
    sds ci = sdsempty(), ni;
A
antirez 已提交
2668 2669 2670
    dictIterator *di;
    dictEntry *de;

2671
    di = dictGetSafeIterator(server.cluster->nodes);
A
antirez 已提交
2672
    while((de = dictNext(di)) != NULL) {
2673
        clusterNode *node = dictGetVal(de);
A
antirez 已提交
2674

2675
        if (node->flags & filter) continue;
2676 2677 2678
        ni = clusterGenNodeDescription(node);
        ci = sdscatsds(ci,ni);
        sdsfree(ni);
2679
        ci = sdscatlen(ci,"\n",1);
A
antirez 已提交
2680 2681 2682 2683 2684
    }
    dictReleaseIterator(di);
    return ci;
}

2685 2686 2687 2688
int getSlotOrReply(redisClient *c, robj *o) {
    long long slot;

    if (getLongLongFromObject(o,&slot) != REDIS_OK ||
2689
        slot < 0 || slot >= REDIS_CLUSTER_SLOTS)
2690 2691 2692 2693 2694 2695 2696
    {
        addReplyError(c,"Invalid or out of range slot");
        return -1;
    }
    return (int) slot;
}

A
antirez 已提交
2697 2698 2699 2700 2701 2702 2703 2704 2705
void clusterCommand(redisClient *c) {
    if (server.cluster_enabled == 0) {
        addReplyError(c,"This instance has cluster support disabled");
        return;
    }

    if (!strcasecmp(c->argv[1]->ptr,"meet") && c->argc == 4) {
        long port;

2706
        if (getLongFromObjectOrReply(c, c->argv[3], &port, NULL) != REDIS_OK) {
A
antirez 已提交
2707 2708 2709 2710
            addReplyError(c,"Invalid TCP port specified");
            return;
        }

2711 2712 2713 2714 2715 2716 2717
        if (clusterStartHandshake(c->argv[2]->ptr,port) == 0 &&
            errno == EINVAL)
        {
            addReplyError(c,"Invalid node address specified");
        } else {
            addReply(c,shared.ok);
        }
A
antirez 已提交
2718
    } else if (!strcasecmp(c->argv[1]->ptr,"nodes") && c->argc == 2) {
2719
        /* CLUSTER NODES */
A
antirez 已提交
2720
        robj *o;
2721
        sds ci = clusterGenNodesDescription(0);
A
antirez 已提交
2722 2723 2724 2725

        o = createObject(REDIS_STRING,ci);
        addReplyBulk(c,o);
        decrRefCount(o);
2726 2727 2728 2729 2730 2731
    } 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;
        }
2732
        clusterDelNodeSlots(myself);
A
antirez 已提交
2733
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
2734
        addReply(c,shared.ok);
A
antirez 已提交
2735
    } else if ((!strcasecmp(c->argv[1]->ptr,"addslots") ||
A
antirez 已提交
2736 2737 2738 2739
               !strcasecmp(c->argv[1]->ptr,"delslots")) && c->argc >= 3)
    {
        /* CLUSTER ADDSLOTS <slot> [slot] ... */
        /* CLUSTER DELSLOTS <slot> [slot] ... */
2740
        int j, slot;
A
antirez 已提交
2741
        unsigned char *slots = zmalloc(REDIS_CLUSTER_SLOTS);
A
antirez 已提交
2742
        int del = !strcasecmp(c->argv[1]->ptr,"delslots");
A
antirez 已提交
2743 2744 2745 2746 2747

        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++) {
2748
            if ((slot = getSlotOrReply(c,c->argv[j])) == -1) {
A
antirez 已提交
2749 2750 2751
                zfree(slots);
                return;
            }
2752
            if (del && server.cluster->slots[slot] == NULL) {
2753
                addReplyErrorFormat(c,"Slot %d is already unassigned", slot);
A
antirez 已提交
2754 2755
                zfree(slots);
                return;
2756
            } else if (!del && server.cluster->slots[slot]) {
2757
                addReplyErrorFormat(c,"Slot %d is already busy", slot);
A
antirez 已提交
2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769
                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]) {
2770 2771 2772 2773
                int retval;

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

                retval = del ? clusterDelSlot(j) :
2778
                               clusterAddSlot(myself,j);
2779
                redisAssertWithInfo(c,NULL,retval == REDIS_OK);
A
antirez 已提交
2780 2781 2782
            }
        }
        zfree(slots);
A
antirez 已提交
2783
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
A
antirez 已提交
2784
        addReply(c,shared.ok);
2785
    } else if (!strcasecmp(c->argv[1]->ptr,"setslot") && c->argc >= 4) {
A
antirez 已提交
2786 2787
        /* SETSLOT 10 MIGRATING <node ID> */
        /* SETSLOT 10 IMPORTING <node ID> */
2788
        /* SETSLOT 10 STABLE */
A
antirez 已提交
2789
        /* SETSLOT 10 NODE <node ID> */
2790
        int slot;
2791 2792
        clusterNode *n;

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

2795
        if (!strcasecmp(c->argv[3]->ptr,"migrating") && c->argc == 5) {
2796
            if (server.cluster->slots[slot] != myself) {
2797 2798 2799
                addReplyErrorFormat(c,"I'm not the owner of hash slot %u",slot);
                return;
            }
2800 2801 2802 2803 2804
            if ((n = clusterLookupNode(c->argv[4]->ptr)) == NULL) {
                addReplyErrorFormat(c,"I don't know about node %s",
                    (char*)c->argv[4]->ptr);
                return;
            }
2805
            server.cluster->migrating_slots_to[slot] = n;
2806
        } else if (!strcasecmp(c->argv[3]->ptr,"importing") && c->argc == 5) {
2807
            if (server.cluster->slots[slot] == myself) {
2808 2809 2810 2811
                addReplyErrorFormat(c,
                    "I'm already the owner of hash slot %u",slot);
                return;
            }
2812 2813 2814 2815 2816
            if ((n = clusterLookupNode(c->argv[4]->ptr)) == NULL) {
                addReplyErrorFormat(c,"I don't know about node %s",
                    (char*)c->argv[3]->ptr);
                return;
            }
2817
            server.cluster->importing_slots_from[slot] = n;
2818
        } else if (!strcasecmp(c->argv[3]->ptr,"stable") && c->argc == 4) {
2819
            /* CLUSTER SETSLOT <SLOT> STABLE */
2820 2821
            server.cluster->importing_slots_from[slot] = NULL;
            server.cluster->migrating_slots_to[slot] = NULL;
2822
        } else if (!strcasecmp(c->argv[3]->ptr,"node") && c->argc == 5) {
2823 2824 2825
            /* CLUSTER SETSLOT <SLOT> NODE <NODE ID> */
            clusterNode *n = clusterLookupNode(c->argv[4]->ptr);

2826 2827 2828 2829 2830
            if (!n) {
                addReplyErrorFormat(c,"Unknown node %s",
                    (char*)c->argv[4]->ptr);
                return;
            }
2831 2832
            /* If this hash slot was served by 'myself' before to switch
             * make sure there are no longer local keys for this hash slot. */
2833
            if (server.cluster->slots[slot] == myself && n != myself) {
2834
                if (countKeysInSlot(slot) != 0) {
2835 2836 2837 2838
                    addReplyErrorFormat(c, "Can't assign hashslot %d to a different node while I still hold keys for this hash slot.", slot);
                    return;
                }
            }
2839 2840 2841
            /* If this node was the slot owner and the slot was marked as
             * migrating, assigning the slot to another node will clear
             * the migratig status. */
2842
            if (server.cluster->slots[slot] == myself &&
2843 2844
                server.cluster->migrating_slots_to[slot])
                server.cluster->migrating_slots_to[slot] = NULL;
2845

2846 2847
            /* If this node was importing this slot, assigning the slot to
             * itself also clears the importing status. */
2848
            if (n == myself &&
2849
                server.cluster->importing_slots_from[slot])
2850
                server.cluster->importing_slots_from[slot] = NULL;
2851 2852
            clusterDelSlot(slot);
            clusterAddSlot(n,slot);
2853 2854
        } else {
            addReplyError(c,"Invalid CLUSTER SETSLOT action or number of arguments");
2855
            return;
2856
        }
A
antirez 已提交
2857
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
2858
        addReply(c,shared.ok);
A
antirez 已提交
2859
    } else if (!strcasecmp(c->argv[1]->ptr,"info") && c->argc == 2) {
2860
        /* CLUSTER INFO */
A
antirez 已提交
2861 2862 2863 2864 2865
        char *statestr[] = {"ok","fail","needhelp"};
        int slots_assigned = 0, slots_ok = 0, slots_pfail = 0, slots_fail = 0;
        int j;

        for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
2866
            clusterNode *n = server.cluster->slots[j];
A
antirez 已提交
2867 2868 2869

            if (n == NULL) continue;
            slots_assigned++;
2870
            if (nodeFailed(n)) {
A
antirez 已提交
2871
                slots_fail++;
2872
            } else if (nodeTimedOut(n)) {
A
antirez 已提交
2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884
                slots_pfail++;
            } else {
                slots_ok++;
            }
        }

        sds info = sdscatprintf(sdsempty(),
            "cluster_state:%s\r\n"
            "cluster_slots_assigned:%d\r\n"
            "cluster_slots_ok:%d\r\n"
            "cluster_slots_pfail:%d\r\n"
            "cluster_slots_fail:%d\r\n"
2885
            "cluster_known_nodes:%lu\r\n"
2886
            "cluster_size:%d\r\n"
2887
            "cluster_current_epoch:%llu\r\n"
2888 2889
            "cluster_stats_messages_sent:%lld\r\n"
            "cluster_stats_messages_received:%lld\r\n"
2890
            , statestr[server.cluster->state],
A
antirez 已提交
2891 2892 2893
            slots_assigned,
            slots_ok,
            slots_pfail,
2894
            slots_fail,
2895
            dictSize(server.cluster->nodes),
2896
            server.cluster->size,
2897 2898 2899
            (unsigned long long) server.cluster->currentEpoch,
            server.cluster->stats_bus_messages_sent,
            server.cluster->stats_bus_messages_received
A
antirez 已提交
2900 2901 2902 2903 2904
        );
        addReplySds(c,sdscatprintf(sdsempty(),"$%lu\r\n",
            (unsigned long)sdslen(info)));
        addReplySds(c,info);
        addReply(c,shared.crlf);
2905
    } else if (!strcasecmp(c->argv[1]->ptr,"saveconfig") && c->argc == 2) {
A
antirez 已提交
2906
        int retval = clusterSaveConfig(1);
2907 2908 2909 2910 2911 2912

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

        addReplyLongLong(c,keyHashSlot(key,sdslen(key)));
2918
    } else if (!strcasecmp(c->argv[1]->ptr,"countkeysinslot") && c->argc == 3) {
2919
        /* CLUSTER COUNTKEYSINSLOT <slot> */
2920 2921 2922 2923
        long long slot;

        if (getLongLongFromObjectOrReply(c,c->argv[2],&slot,NULL) != REDIS_OK)
            return;
2924 2925 2926 2927
        if (slot < 0 || slot >= REDIS_CLUSTER_SLOTS) {
            addReplyError(c,"Invalid slot");
            return;
        }
2928
        addReplyLongLong(c,countKeysInSlot(slot));
A
antirez 已提交
2929
    } else if (!strcasecmp(c->argv[1]->ptr,"getkeysinslot") && c->argc == 4) {
2930
        /* CLUSTER GETKEYSINSLOT <slot> <count> */
A
antirez 已提交
2931
        long long maxkeys, slot;
2932
        unsigned int numkeys, j;
A
antirez 已提交
2933 2934 2935 2936 2937 2938
        robj **keys;

        if (getLongLongFromObjectOrReply(c,c->argv[2],&slot,NULL) != REDIS_OK)
            return;
        if (getLongLongFromObjectOrReply(c,c->argv[3],&maxkeys,NULL) != REDIS_OK)
            return;
2939
        if (slot < 0 || slot >= REDIS_CLUSTER_SLOTS || maxkeys < 0) {
A
antirez 已提交
2940 2941 2942 2943 2944
            addReplyError(c,"Invalid slot or number of keys");
            return;
        }

        keys = zmalloc(sizeof(robj*)*maxkeys);
2945
        numkeys = getKeysInSlot(slot, keys, maxkeys);
A
antirez 已提交
2946 2947 2948
        addReplyMultiBulkLen(c,numkeys);
        for (j = 0; j < numkeys; j++) addReplyBulk(c,keys[j]);
        zfree(keys);
A
antirez 已提交
2949 2950 2951 2952
    } else if (!strcasecmp(c->argv[1]->ptr,"forget") && c->argc == 3) {
        /* CLUSTER FORGET <NODE ID> */
        clusterNode *n = clusterLookupNode(c->argv[2]->ptr);

2953
        if (!n) {
A
antirez 已提交
2954 2955
            addReplyErrorFormat(c,"Unknown node %s", (char*)c->argv[2]->ptr);
            return;
2956
        } else if (n == myself) {
2957 2958
            addReplyError(c,"I tried hard but I can't forget myself...");
            return;
2959
        } else if (nodeIsSlave(myself) && myself->slaveof == n) {
2960 2961
            addReplyError(c,"Can't forget my master!");
            return;
A
antirez 已提交
2962
        }
2963
        clusterBlacklistAddNode(n);
A
antirez 已提交
2964
        clusterDelNode(n);
A
antirez 已提交
2965
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
A
antirez 已提交
2966
        addReply(c,shared.ok);
2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977
    } 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. */
2978
        if (n == myself) {
2979 2980 2981 2982 2983 2984 2985 2986 2987 2988
            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;
        }

2989 2990 2991
        /* 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. */
2992 2993
        if (nodeIsMaster(myself) &&
            (myself->numslots != 0 || dictSize(server.db[0].dict) != 0)) {
2994 2995 2996 2997 2998 2999
            addReplyError(c,"To set a master the node must be empty and without assigned slots.");
            return;
        }

        /* Set the master. */
        clusterSetMaster(n);
A
antirez 已提交
3000
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
3001
        addReply(c,shared.ok);
3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012
    } 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;
        }

3013
        if (nodeIsSlave(n)) {
3014 3015 3016 3017 3018 3019 3020 3021 3022 3023
            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 已提交
3024 3025 3026 3027 3028 3029
    } else {
        addReplyError(c,"Wrong CLUSTER subcommand or number of arguments");
    }
}

/* -----------------------------------------------------------------------------
3030
 * DUMP, RESTORE and MIGRATE commands
A
antirez 已提交
3031 3032
 * -------------------------------------------------------------------------- */

3033 3034 3035
/* 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) {
3036 3037
    unsigned char buf[2];
    uint64_t crc;
3038 3039 3040 3041 3042 3043 3044 3045

    /* 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:
3046 3047 3048 3049 3050
     * ----------------+---------------------+---------------+
     * ... RDB payload | 2 bytes RDB version | 8 bytes CRC64 |
     * ----------------+---------------------+---------------+
     * RDB version and CRC are both in little endian.
     */
3051 3052

    /* RDB version */
3053 3054
    buf[0] = REDIS_RDB_VERSION & 0xff;
    buf[1] = (REDIS_RDB_VERSION >> 8) & 0xff;
3055 3056
    payload->io.buffer.ptr = sdscatlen(payload->io.buffer.ptr,buf,2);

3057
    /* CRC64 */
3058
    crc = crc64(0,(unsigned char*)payload->io.buffer.ptr,
3059 3060 3061
                sdslen(payload->io.buffer.ptr));
    memrev64ifbe(&crc);
    payload->io.buffer.ptr = sdscatlen(payload->io.buffer.ptr,&crc,8);
3062 3063 3064
}

/* Verify that the RDB version of the dump payload matches the one of this Redis
3065
 * instance and that the checksum is ok.
3066 3067 3068
 * If the DUMP payload looks valid REDIS_OK is returned, otherwise REDIS_ERR
 * is returned. */
int verifyDumpPayload(unsigned char *p, size_t len) {
3069
    unsigned char *footer;
3070
    uint16_t rdbver;
3071
    uint64_t crc;
3072

3073
    /* At least 2 bytes of RDB version and 8 of CRC64 should be present. */
3074 3075
    if (len < 10) return REDIS_ERR;
    footer = p+(len-10);
3076 3077

    /* Verify RDB version */
3078
    rdbver = (footer[1] << 8) | footer[0];
3079
    if (rdbver != REDIS_RDB_VERSION) return REDIS_ERR;
3080

3081
    /* Verify CRC64 */
3082
    crc = crc64(0,p,len-8);
3083 3084
    memrev64ifbe(&crc);
    return (memcmp(&crc,footer+2,8) == 0) ? REDIS_OK : REDIS_ERR;
3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109
}

/* 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 已提交
3110
/* RESTORE key ttl serialized-value [REPLACE] */
A
antirez 已提交
3111
void restoreCommand(redisClient *c) {
3112
    long long ttl;
3113
    rio payload;
A
antirez 已提交
3114
    int j, type, replace = 0;
3115
    robj *obj;
A
antirez 已提交
3116

A
antirez 已提交
3117 3118 3119 3120 3121 3122 3123 3124 3125 3126
    /* 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 已提交
3127
    /* Make sure this key does not already exist here... */
A
antirez 已提交
3128
    if (!replace && lookupKeyWrite(c->db,c->argv[1]) != NULL) {
A
antirez 已提交
3129 3130 3131 3132 3133
        addReplyError(c,"Target key name is busy.");
        return;
    }

    /* Check if the TTL value makes sense */
3134
    if (getLongLongFromObjectOrReply(c,c->argv[2],&ttl,NULL) != REDIS_OK) {
A
antirez 已提交
3135 3136 3137 3138 3139 3140
        return;
    } else if (ttl < 0) {
        addReplyError(c,"Invalid TTL value, must be >= 0");
        return;
    }

3141
    /* Verify RDB version and data checksum. */
3142 3143
    if (verifyDumpPayload(c->argv[3]->ptr,sdslen(c->argv[3]->ptr)) == REDIS_ERR)
    {
3144 3145 3146 3147
        addReplyError(c,"DUMP payload version or checksum are wrong");
        return;
    }

3148
    rioInitWithBuffer(&payload,c->argv[3]->ptr);
3149 3150
    if (((type = rdbLoadObjectType(&payload)) == -1) ||
        ((obj = rdbLoadObject(type,&payload)) == NULL))
3151
    {
3152
        addReplyError(c,"Bad data format");
A
antirez 已提交
3153 3154 3155
        return;
    }

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

A
antirez 已提交
3159
    /* Create the key and set the TTL if any */
3160
    dbAdd(c->db,c->argv[1],obj);
3161
    if (ttl) setExpire(c->db,c->argv[1],mstime()+ttl);
3162
    signalModifiedKey(c->db,c->argv[1]);
A
antirez 已提交
3163
    addReply(c,shared.ok);
3164
    server.dirty++;
A
antirez 已提交
3165 3166
}

A
antirez 已提交
3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226
/* 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;
    }
3227
    anetEnableTcpNoDelay(server.neterr,fd);
A
antirez 已提交
3228 3229

    /* Check if it connects within the specified timeout. */
3230
    if ((aeWait(fd,AE_WRITABLE,timeout) & AE_WRITABLE) == 0) {
A
antirez 已提交
3231 3232 3233 3234 3235 3236 3237 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 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280
        sdsfree(name);
        addReplySds(c,sdsnew("-IOERR error or timeout connecting to the client\r\n"));
        close(fd);
        return -1;
    }

    /* Add to the cache and return it to the caller. */
    cs = zmalloc(sizeof(*cs));
    cs->fd = fd;
    cs->last_use_time = server.unixtime;
    dictAdd(server.migrate_cached_sockets,name,cs);
    return fd;
}

/* Free a migrate cached connection. */
void migrateCloseSocket(robj *host, robj *port) {
    sds name = sdsempty();
    migrateCachedSocket *cs;

    name = sdscatlen(name,host->ptr,sdslen(host->ptr));
    name = sdscatlen(name,":",1);
    name = sdscatlen(name,port->ptr,sdslen(port->ptr));
    cs = dictFetchValue(server.migrate_cached_sockets,name);
    if (!cs) {
        sdsfree(name);
        return;
    }

    close(cs->fd);
    zfree(cs);
    dictDelete(server.migrate_cached_sockets,name);
    sdsfree(name);
}

void migrateCloseTimedoutSockets(void) {
    dictIterator *di = dictGetSafeIterator(server.migrate_cached_sockets);
    dictEntry *de;

    while((de = dictNext(di)) != NULL) {
        migrateCachedSocket *cs = dictGetVal(de);

        if ((server.unixtime - cs->last_use_time) > MIGRATE_SOCKET_CACHE_TTL) {
            close(cs->fd);
            zfree(cs);
            dictDelete(server.migrate_cached_sockets,dictGetKey(de));
        }
    }
    dictReleaseIterator(di);
}

A
antirez 已提交
3281
/* MIGRATE host port key dbid timeout [COPY | REPLACE] */
A
antirez 已提交
3282
void migrateCommand(redisClient *c) {
A
antirez 已提交
3283
    int fd, copy, replace, j;
A
antirez 已提交
3284 3285
    long timeout;
    long dbid;
A
antirez 已提交
3286
    long long ttl, expireat;
A
antirez 已提交
3287
    robj *o;
3288
    rio cmd, payload;
A
antirez 已提交
3289 3290 3291 3292 3293 3294 3295
    int retry_num = 0;

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

A
antirez 已提交
3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308
    /* 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 已提交
3309 3310 3311 3312 3313
    /* Sanity check */
    if (getLongFromObjectOrReply(c,c->argv[5],&timeout,NULL) != REDIS_OK)
        return;
    if (getLongFromObjectOrReply(c,c->argv[4],&dbid,NULL) != REDIS_OK)
        return;
3314
    if (timeout <= 0) timeout = 1000;
A
antirez 已提交
3315 3316 3317 3318 3319

    /* 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) {
3320
        addReplySds(c,sdsnew("+NOKEY\r\n"));
A
antirez 已提交
3321 3322 3323 3324
        return;
    }
    
    /* Connect */
A
antirez 已提交
3325 3326
    fd = migrateGetSocket(c,c->argv[1],c->argv[2],timeout);
    if (fd == -1) return; /* error sent to the client by migrateGetSocket() */
A
antirez 已提交
3327

3328
    /* Create RESTORE payload and generate the protocol to call the command. */
3329
    rioInitWithBuffer(&cmd,sdsempty());
3330 3331 3332
    redisAssertWithInfo(c,NULL,rioWriteBulkCount(&cmd,'*',2));
    redisAssertWithInfo(c,NULL,rioWriteBulkString(&cmd,"SELECT",6));
    redisAssertWithInfo(c,NULL,rioWriteBulkLongLong(&cmd,dbid));
A
antirez 已提交
3333

A
antirez 已提交
3334 3335 3336 3337 3338
    expireat = getExpire(c->db,c->argv[3]);
    if (expireat != -1) {
        ttl = expireat-mstime();
        if (ttl < 1) ttl = 1;
    }
A
antirez 已提交
3339
    redisAssertWithInfo(c,NULL,rioWriteBulkCount(&cmd,'*',replace ? 5 : 4));
3340 3341 3342 3343 3344
    if (server.cluster_enabled)
        redisAssertWithInfo(c,NULL,
            rioWriteBulkString(&cmd,"RESTORE-ASKING",14));
    else
        redisAssertWithInfo(c,NULL,rioWriteBulkString(&cmd,"RESTORE",7));
3345
    redisAssertWithInfo(c,NULL,sdsEncodedObject(c->argv[3]));
3346
    redisAssertWithInfo(c,NULL,rioWriteBulkString(&cmd,c->argv[3]->ptr,sdslen(c->argv[3]->ptr)));
3347
    redisAssertWithInfo(c,NULL,rioWriteBulkLongLong(&cmd,ttl));
A
antirez 已提交
3348

G
guiquanz 已提交
3349
    /* Emit the payload argument, that is the serialized object using
A
antirez 已提交
3350
     * the DUMP format. */
3351 3352 3353
    createDumpPayload(&payload,o);
    redisAssertWithInfo(c,NULL,rioWriteBulkString(&cmd,payload.io.buffer.ptr,
                                sdslen(payload.io.buffer.ptr)));
3354 3355
    sdsfree(payload.io.buffer.ptr);

A
antirez 已提交
3356 3357 3358 3359 3360
    /* 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 已提交
3361
    /* Transfer the query to the other node in 64K chunks. */
A
antirez 已提交
3362
    errno = 0;
A
antirez 已提交
3363
    {
3364 3365 3366 3367 3368 3369
        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);
3370
            nwritten = syncWrite(fd,buf+pos,towrite,timeout);
3371 3372
            if (nwritten != (signed)towrite) goto socket_wr_err;
            pos += nwritten;
A
antirez 已提交
3373 3374 3375
        }
    }

3376
    /* Read back the reply. */
A
antirez 已提交
3377 3378 3379 3380 3381 3382 3383 3384
    {
        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)
3385
            goto socket_rd_err;
A
antirez 已提交
3386 3387 3388 3389
        if (buf1[0] == '-' || buf2[0] == '-') {
            addReplyErrorFormat(c,"Target instance replied with error: %s",
                (buf1[0] == '-') ? buf1+1 : buf2+1);
        } else {
3390 3391
            robj *aux;

A
antirez 已提交
3392 3393 3394 3395 3396
            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 已提交
3397
            addReply(c,shared.ok);
3398 3399 3400
            server.dirty++;

            /* Translate MIGRATE as DEL for replication/AOF. */
A
antirez 已提交
3401
            aux = createStringObject("DEL",3);
3402 3403
            rewriteClientCommandVector(c,2,aux,c->argv[3]);
            decrRefCount(aux);
A
antirez 已提交
3404 3405 3406
        }
    }

3407
    sdsfree(cmd.io.buffer.ptr);
3408
    return;
A
antirez 已提交
3409 3410

socket_wr_err:
3411
    sdsfree(cmd.io.buffer.ptr);
A
antirez 已提交
3412
    migrateCloseSocket(c->argv[1],c->argv[2]);
A
antirez 已提交
3413 3414 3415
    if (errno != ETIMEDOUT && retry_num++ == 0) goto try_again;
    addReplySds(c,
        sdsnew("-IOERR error or timeout writing to target instance\r\n"));
3416
    return;
A
antirez 已提交
3417 3418

socket_rd_err:
3419
    sdsfree(cmd.io.buffer.ptr);
A
antirez 已提交
3420
    migrateCloseSocket(c->argv[1],c->argv[2]);
A
antirez 已提交
3421 3422 3423
    if (errno != ETIMEDOUT && retry_num++ == 0) goto try_again;
    addReplySds(c,
        sdsnew("-IOERR error or timeout reading from target node\r\n"));
3424 3425 3426
    return;
}

3427 3428 3429 3430
/* -----------------------------------------------------------------------------
 * Cluster functions related to serving / redirecting clients
 * -------------------------------------------------------------------------- */

3431
/* The ASKING command is required after a -ASK redirection.
G
guiquanz 已提交
3432
 * The client should issue ASKING before to actually send the command to
3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443
 * 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);
}

3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460
/* 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 已提交
3461

3462 3463 3464
/* Return the pointer to the cluster node that is able to serve the command.
 * For the function to succeed the command should only target a single
 * key (or the same key multiple times).
A
antirez 已提交
3465
 *
3466 3467 3468 3469
 * If the returned node should be used only for this request, the *ask
 * integer is set to '1', otherwise to '0'. This is used in order to
 * let the caller know if we should reply with -MOVED or with -ASK.
 *
3470 3471
 * If the command contains multiple keys, and as a consequence it is not
 * possible to handle the request in Redis Cluster, NULL is returned. */
3472
clusterNode *getNodeByQuery(redisClient *c, struct redisCommand *cmd, robj **argv, int argc, int *hashslot, int *ask) {
A
antirez 已提交
3473
    clusterNode *n = NULL;
3474
    robj *firstkey = NULL;
A
antirez 已提交
3475 3476
    multiState *ms, _ms;
    multiCmd mc;
3477
    int i, slot = 0;
A
antirez 已提交
3478 3479 3480 3481 3482 3483

    /* 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. */
3484
        if (!(c->flags & REDIS_MULTI)) return myself;
A
antirez 已提交
3485 3486
        ms = &c->mstate;
    } else {
3487 3488 3489
        /* 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 已提交
3490 3491 3492 3493 3494 3495 3496 3497
        ms = &_ms;
        _ms.commands = &mc;
        _ms.count = 1;
        mc.argv = argv;
        mc.argc = argc;
        mc.cmd = cmd;
    }

3498 3499
    /* Check that all the keys are the same key, and get the slot and
     * node for this key. */
A
antirez 已提交
3500 3501 3502 3503 3504 3505 3506 3507 3508 3509
    for (i = 0; i < ms->count; i++) {
        struct redisCommand *mcmd;
        robj **margv;
        int margc, *keyindex, numkeys, j;

        mcmd = ms->commands[i].cmd;
        margc = ms->commands[i].argc;
        margv = ms->commands[i].argv;

        keyindex = getKeysFromCommand(mcmd,margv,margc,&numkeys,
3510
                                      REDIS_GETKEYS_ALL);
A
antirez 已提交
3511
        for (j = 0; j < numkeys; j++) {
3512 3513 3514 3515 3516 3517
            if (firstkey == NULL) {
                /* This is the first key we see. Check what is the slot
                 * and node. */
                firstkey = margv[keyindex[j]];

                slot = keyHashSlot((char*)firstkey->ptr, sdslen(firstkey->ptr));
3518
                n = server.cluster->slots[slot];
3519
                redisAssertWithInfo(c,firstkey,n != NULL);
A
antirez 已提交
3520
            } else {
3521 3522 3523 3524 3525 3526
                /* If it is not the first key, make sure it is exactly
                 * the same key as the first we saw. */
                if (!equalStringObjects(firstkey,margv[keyindex[j]])) {
                    getKeysFreeResult(keyindex);
                    return NULL;
                }
A
antirez 已提交
3527 3528 3529 3530
            }
        }
        getKeysFreeResult(keyindex);
    }
3531 3532 3533
    if (ask) *ask = 0; /* This is the default. Set to 1 if needed later. */
    /* No key at all in command? then we can serve the request
     * without redirections. */
3534
    if (n == NULL) return myself;
3535 3536 3537 3538 3539
    if (hashslot) *hashslot = slot;
    /* This request is about a slot we are migrating into another instance?
     * Then we need to check if we have the key. If we have it we can reply.
     * If instead is a new key, we pass the request to the node that is
     * receiving the slot. */
3540
    if (n == myself && server.cluster->migrating_slots_to[slot] != NULL) {
3541 3542
        if (lookupKeyRead(&server.db[0],firstkey) == NULL) {
            if (ask) *ask = 1;
3543
            return server.cluster->migrating_slots_to[slot];
3544 3545 3546 3547
        }
    }
    /* Handle the case in which we are receiving this hash slot from
     * another instance, so we'll accept the query even if in the table
3548 3549
     * it is assigned to a different node, but only if the client
     * issued an ASKING command before. */
3550
    if (server.cluster->importing_slots_from[slot] != NULL &&
3551
        (c->flags & REDIS_ASKING || cmd->flags & REDIS_CMD_ASKING)) {
3552
        return myself;
3553
    }
3554 3555 3556 3557 3558
    /* 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 &&
3559
        nodeIsSlave(myself) &&
3560
        myself->slaveof == n)
3561
    {
3562
        return myself;
3563
    }
3564 3565
    /* It's not a -ASK case. Base case: just return the right node. */
    return n;
A
antirez 已提交
3566
}