cluster.c 129.8 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>
A
antirez 已提交
41

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

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

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

    /* 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.
94 95 96 97 98 99
     * 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 已提交
100 101 102 103
    line = zmalloc(maxline);
    while(fgets(line,maxline,fp) != NULL) {
        int argc;
        sds *argv = sdssplitargs(line,&argc);
C
charsyam 已提交
104 105
        if (argv == NULL) goto fmterr;

106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
        clusterNode *n, *master;
        char *p, *s;

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

163
        /* Set ping sent / pong received timestamps */
164 165
        if (atoi(argv[4])) n->ping_sent = mstime();
        if (atoi(argv[5])) n->pong_received = mstime();
166

167 168 169
        /* Set configEpoch for this node. */
        n->configEpoch = strtoull(argv[6],NULL,10);

170
        /* Populate hash slots served by this instance. */
171
        for (j = 8; j < argc; j++) {
172 173
            int start, stop;

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

207
        sdsfreesplitres(argv,argc);
A
antirez 已提交
208 209
    }
    zfree(line);
A
antirez 已提交
210 211
    fclose(fp);

A
antirez 已提交
212
    /* Config sanity check */
213
    redisAssert(server.cluster->myself != NULL);
A
antirez 已提交
214
    redisLog(REDIS_NOTICE,"Node configuration loaded, I'm %.40s",
215
        server.cluster->myself->name);
216
    clusterSetStartupEpoch();
217
    clusterUpdateState();
A
antirez 已提交
218 219 220
    return REDIS_OK;

fmterr:
G
guiquanz 已提交
221
    redisLog(REDIS_WARNING,"Unrecoverable error: corrupted cluster config file.");
A
antirez 已提交
222 223 224 225
    fclose(fp);
    exit(1);
}

A
antirez 已提交
226 227 228 229
/* Cluster node configuration is exactly the same as CLUSTER NODES output.
 *
 * This function writes the node config and returns 0, on error -1
 * is returned. */
A
antirez 已提交
230
int clusterSaveConfig(int do_fsync) {
231
    sds ci = clusterGenNodesDescription(REDIS_NODE_HANDSHAKE);
A
antirez 已提交
232 233
    int fd;
    
234
    if ((fd = open(server.cluster_configfile,O_WRONLY|O_CREAT|O_TRUNC,0644))
A
antirez 已提交
235
        == -1) goto err;
A
antirez 已提交
236
    if (write(fd,ci,sdslen(ci)) != (ssize_t)sdslen(ci)) goto err;
A
antirez 已提交
237
    if (do_fsync) fsync(fd);
A
antirez 已提交
238 239 240 241 242 243 244 245 246
    close(fd);
    sdsfree(ci);
    return 0;

err:
    sdsfree(ci);
    return -1;
}

A
antirez 已提交
247 248
void clusterSaveConfigOrDie(int do_fsync) {
    if (clusterSaveConfig(do_fsync) == -1) {
249 250 251 252 253
        redisLog(REDIS_WARNING,"Fatal: can't update cluster config file.");
        exit(1);
    }
}

A
antirez 已提交
254
void clusterInit(void) {
255
    int saveconf = 0;
256

257 258
    server.cluster = zmalloc(sizeof(clusterState));
    server.cluster->myself = NULL;
259
    server.cluster->currentEpoch = 0;
260
    server.cluster->state = REDIS_CLUSTER_FAIL;
261
    server.cluster->size = 1;
262
    server.cluster->todo_before_sleep = 0;
263
    server.cluster->nodes = dictCreate(&clusterNodesDictType,NULL);
264 265
    server.cluster->nodes_black_list =
        dictCreate(&clusterNodesBlackListDictType,NULL);
266 267
    server.cluster->failover_auth_time = 0;
    server.cluster->failover_auth_count = 0;
268
    server.cluster->failover_auth_epoch = 0;
269
    server.cluster->last_vote_epoch = 0;
270 271
    server.cluster->stats_bus_messages_sent = 0;
    server.cluster->stats_bus_messages_received = 0;
272 273 274 275 276 277 278
    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 已提交
279 280
        /* No configuration found. We will just use the random name provided
         * by the createClusterNode() function. */
281 282
        server.cluster->myself =
            createClusterNode(NULL,REDIS_NODE_MYSELF|REDIS_NODE_MASTER);
A
antirez 已提交
283
        redisLog(REDIS_NOTICE,"No cluster configuration found, I'm %.40s",
284 285
            server.cluster->myself->name);
        clusterAddNode(server.cluster->myself);
286 287
        saveconf = 1;
    }
A
antirez 已提交
288
    if (saveconf) clusterSaveConfigOrDie(1);
289 290

    /* We need a listening TCP port for our cluster messaging needs. */
291
    server.cfd_count = 0;
292 293 294 295
    if (listenToPort(server.port+REDIS_CLUSTER_PORT_INCR,
        server.cfd,&server.cfd_count) == REDIS_ERR)
    {
        exit(1);
296 297 298 299 300 301 302 303 304
    } 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 已提交
305
    }
306 307

    /* The slots -> keys map is a sorted set. Init it. */
308
    server.cluster->slots_to_keys = zslCreate();
A
antirez 已提交
309 310 311 312 313 314 315 316
}

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

clusterLink *createClusterLink(clusterNode *node) {
    clusterLink *link = zmalloc(sizeof(*link));
317
    link->ctime = mstime();
A
antirez 已提交
318 319 320 321 322 323 324 325
    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.
326
 * This function will just make sure that the original node associated
A
antirez 已提交
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
 * 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;
343
    char cip[REDIS_IP_STR_LEN];
A
antirez 已提交
344 345 346 347 348
    clusterLink *link;
    REDIS_NOTUSED(el);
    REDIS_NOTUSED(mask);
    REDIS_NOTUSED(privdata);

349
    cfd = anetTcpAccept(server.neterr, fd, cip, sizeof(cip), &cport);
A
antirez 已提交
350 351 352 353
    if (cfd == AE_ERR) {
        redisLog(REDIS_VERBOSE,"Accepting cluster node: %s", server.neterr);
        return;
    }
354 355 356 357
    anetNonBlock(NULL,cfd);
    anetEnableTcpNoDelay(NULL,cfd);

    /* Use non-blocking I/O for cluster messages. */
358
    /* IPV6: might want to wrap a v6 address in [] */
A
antirez 已提交
359 360 361 362 363 364 365 366 367 368 369 370 371
    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
 * -------------------------------------------------------------------------- */

372 373
/* 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 已提交
374
unsigned int keyHashSlot(char *key, int keylen) {
375
    return crc16(key,keylen) & 0x3FFF;
A
antirez 已提交
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
}

/* -----------------------------------------------------------------------------
 * 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
395
        getRandomHexChars(node->name, REDIS_CLUSTER_NAMELEN);
396
    node->ctime = mstime();
397
    node->configEpoch = 0;
A
antirez 已提交
398 399
    node->flags = flags;
    memset(node->slots,0,sizeof(node->slots));
400
    node->numslots = 0;
A
antirez 已提交
401 402 403 404
    node->numslaves = 0;
    node->slaves = NULL;
    node->slaveof = NULL;
    node->ping_sent = node->pong_received = 0;
A
antirez 已提交
405
    node->fail_time = 0;
A
antirez 已提交
406
    node->link = NULL;
407
    memset(node->ip,0,sizeof(node->ip));
408
    node->port = 0;
409
    node->fail_reports = listCreate();
410
    node->voted_time = 0;
411
    listSetFreeMethod(node->fail_reports,zfree);
A
antirez 已提交
412 413 414
    return node;
}

415 416 417 418 419
/* 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
420 421 422 423 424 425
 * '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) {
426 427 428 429 430 431 432 433 434 435 436
    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) {
437
            fr->time = mstime();
438
            return 0;
439 440 441 442 443 444
        }
    }

    /* Otherwise create a new report. */
    fr = zmalloc(sizeof(*fr));
    fr->node = sender;
445
    fr->time = mstime();
446
    listAddNodeTail(l,fr);
447
    return 1;
448 449
}

450 451 452 453 454 455 456 457 458 459
/* 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;
460
    mstime_t maxtime = server.cluster_node_timeout *
461
                     REDIS_CLUSTER_FAIL_REPORT_VALIDITY_MULT;
462
    mstime_t now = mstime();
463 464 465 466 467 468 469 470

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

471 472 473 474 475 476 477
/* 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
478 479 480 481 482
 * time.
 *
 * The function returns 1 if the failure report was found and removed.
 * Otherwise 0 is returned. */
int clusterNodeDelFailureReport(clusterNode *node, clusterNode *sender) {
483 484 485 486 487 488 489 490 491 492 493
    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;
    }
494
    if (!ln) return 0; /* No failure report from this sender. */
495 496 497

    /* Remove the failure report. */
    listDelNode(l,ln);
498
    clusterNodeCleanupFailureReports(node);
499
    return 1;
500 501
}

502 503 504 505 506 507 508 509
/* 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 已提交
510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
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;
540
    n->slaves = NULL;
A
antirez 已提交
541 542 543 544
}

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

A
antirez 已提交
546
    nodename = sdsnewlen(n->name, REDIS_CLUSTER_NAMELEN);
547
    redisAssert(dictDelete(server.cluster->nodes,nodename) == DICT_OK);
A
antirez 已提交
548 549 550
    sdsfree(nodename);
    if (n->slaveof) clusterNodeRemoveSlave(n->slaveof, n);
    if (n->link) freeClusterLink(n->link);
551
    listRelease(n->fail_reports);
A
antirez 已提交
552 553 554 555 556 557 558
    zfree(n);
}

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

A
antirez 已提交
564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585
/* 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. */
586
    di = dictGetSafeIterator(server.cluster->nodes);
A
antirez 已提交
587 588 589 590 591 592 593 594 595 596 597 598
    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 已提交
599 600 601 602 603
/* Node lookup by name */
clusterNode *clusterLookupNode(char *name) {
    sds s = sdsnewlen(name, REDIS_CLUSTER_NAMELEN);
    struct dictEntry *de;

604
    de = dictFind(server.cluster->nodes,s);
A
antirez 已提交
605 606
    sdsfree(s);
    if (de == NULL) return NULL;
607
    return dictGetVal(de);
A
antirez 已提交
608 609 610 611 612 613 614 615 616 617 618 619
}

/* 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);
620
    retval = dictDelete(server.cluster->nodes, s);
A
antirez 已提交
621 622 623 624 625 626
    sdsfree(s);
    redisAssert(retval == DICT_OK);
    memcpy(node->name, newname, REDIS_CLUSTER_NAMELEN);
    clusterAddNode(node);
}

627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643
/* -----------------------------------------------------------------------------
 * CLUSTER nodes blacklist
 *
 * The nodes blacklist is just a way to ensure that a given node with a given
 * Node ID is not readded before some time elapsed (this time is specified
 * in seconds in REDIS_CLUSTER_BLACKLIST_TTL).
 *
 * This is useful when we want to remove a node from the cluster completely:
 * when CLUSTER FORGET is called, it also puts the node into the blacklist so
 * that even if we receive gossip messages from other nodes that still remember
 * about the node we want to remove, we don't re-add it before some time.
 *
 * Currently the REDIS_CLUSTER_BLACKLIST_TTL is set to 1 minute, this means
 * that redis-trib has 60 seconds to send CLUSTER FORGET messages to nodes
 * in the cluster without dealing with the problem if other nodes re-adding
 * back the node to nodes we already sent the FORGET command to.
 *
644
 * The data structure used is a hash table with an sds string representing
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695
 * the node ID as key, and the time when it is ok to re-add the node as
 * value.
 * -------------------------------------------------------------------------- */

#define REDIS_CLUSTER_BLACKLIST_TTL 60      /* 1 minute. */


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

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

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

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

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

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

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

A
antirez 已提交
696 697 698 699
/* -----------------------------------------------------------------------------
 * CLUSTER messages exchange - PING/PONG and gossip
 * -------------------------------------------------------------------------- */

700 701 702
/* This function checks if a given node should be marked as FAIL.
 * It happens if the following conditions are met:
 *
703 704 705 706
 * 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.
707 708 709
 *
 * 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.
710 711 712 713 714 715 716 717 718 719
 *
 * 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.
720 721 722 723 724 725 726 727
 */
void markNodeAsFailingIfNeeded(clusterNode *node) {
    int failures;
    int needed_quorum = (server.cluster->size / 2) + 1;

    if (!(node->flags & REDIS_NODE_PFAIL)) return; /* We can reach it. */
    if (node->flags & REDIS_NODE_FAIL) return; /* Already FAILing. */

728 729 730 731 732
    failures = clusterNodeFailureReportsCount(node);
    /* Also count myself as a voter if I'm a master. */
    if (server.cluster->myself->flags & REDIS_NODE_MASTER)
        failures += 1;
    if (failures < needed_quorum) return; /* No weak agreement from masters. */
733 734 735 736 737 738 739

    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;
740
    node->fail_time = mstime();
741

742 743 744 745
    /* Broadcast the failing node name to everybody, forcing all the other
     * reachable nodes to flag the node as FAIL. */
    if (server.cluster->myself->flags & REDIS_NODE_MASTER)
        clusterSendFail(node->name);
A
antirez 已提交
746
    clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
747 748 749 750
}

/* 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
751
 * state. */
752
void clearNodeFailureIfNeeded(clusterNode *node) {
753
    mstime_t now = mstime();
A
antirez 已提交
754 755 756 757 758 759 760

    redisAssert(node->flags & REDIS_NODE_FAIL);

    /* For slaves we always clear the FAIL flag if we can contact the
     * node again. */
    if (node->flags & REDIS_NODE_SLAVE) {
        redisLog(REDIS_NOTICE,
761
            "Clear FAIL state for node %.40s: slave is reachable again.",
A
antirez 已提交
762 763
                node->name);
        node->flags &= ~REDIS_NODE_FAIL;
A
antirez 已提交
764
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
A
antirez 已提交
765 766 767
    }

    /* If it is a master and...
768
     * 1) The FAIL state is old enough.
A
antirez 已提交
769 770 771 772
     * 2) It is yet serving slots from our point of view (not failed over).
     * Apparently no one is going to fix these slots, clear the FAIL flag. */
    if (node->flags & REDIS_NODE_MASTER &&
        node->numslots > 0 &&
773
        (now - node->fail_time) >
774
        (server.cluster_node_timeout * REDIS_CLUSTER_FAIL_UNDO_TIME_MULT))
A
antirez 已提交
775
    {
776
        redisLog(REDIS_NOTICE,
A
antirez 已提交
777
            "Clear FAIL state for node %.40s: is reachable again and nobody is serving its slots after some time.",
778
                node->name);
779
        node->flags &= ~REDIS_NODE_FAIL;
A
antirez 已提交
780
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
781 782 783
    }
}

784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801
/* Return true if we already have a node in HANDSHAKE state matching the
 * specified ip address and port number. This function is used in order to
 * avoid adding a new handshake node for the same address multiple times. */
int clusterHandshakeInProgress(char *ip, int port) {
    dictIterator *di;
    dictEntry *de;

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

        if (!(node->flags & REDIS_NODE_HANDSHAKE)) continue;
        if (!strcasecmp(node->ip,ip) && node->port == port) break;
    }
    dictReleaseIterator(di);
    return de != NULL;
}

802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859
/* 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 已提交
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
/* 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);
893
        if (node) {
894 895
            /* We already know this node.
               Handle failure reports, only when the sender is a master. */
896 897 898
            if (sender && sender->flags & REDIS_NODE_MASTER &&
                node != server.cluster->myself)
            {
899 900
                if (flags & (REDIS_NODE_FAIL|REDIS_NODE_PFAIL)) {
                    if (clusterNodeAddFailureReport(node,sender)) {
901
                        redisLog(REDIS_VERBOSE,
902 903 904 905 906 907
                            "Node %.40s reported node %.40s as not reachable.",
                            sender->name, node->name);
                    }
                    markNodeAsFailingIfNeeded(node);
                } else {
                    if (clusterNodeDelFailureReport(node,sender)) {
908
                        redisLog(REDIS_VERBOSE,
909 910 911 912
                            "Node %.40s reported node %.40s is back online.",
                            sender->name, node->name);
                    }
                }
A
antirez 已提交
913
            }
914 915 916 917 918 919 920 921 922 923 924

            /* 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 已提交
925 926
        } else {
            /* If it's not in NOADDR state and we don't have it, we
927
             * start a handshake process against this IP/PORT pairs.
A
antirez 已提交
928 929 930 931
             *
             * 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. */
932 933
            if (sender && !(flags & REDIS_NODE_NOADDR))
                clusterStartHandshake(g->ip,ntohs(g->port));
A
antirez 已提交
934 935 936 937 938 939 940
        }

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

941
/* IP -> string conversion. 'buf' is supposed to at least be 46 bytes. */
A
antirez 已提交
942
void nodeIp2String(char *buf, clusterLink *link) {
943
    struct sockaddr_storage sa;
A
antirez 已提交
944 945 946 947
    socklen_t salen = sizeof(sa);

    if (getpeername(link->fd, (struct sockaddr*) &sa, &salen) == -1)
        redisPanic("getpeername() failed.");
948 949 950 951 952 953 954 955

    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 已提交
956 957 958 959
}


/* Update the node address to the IP address that can be extracted
A
antirez 已提交
960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988
 * 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);
989 990 991 992 993 994 995 996

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

1000 1001 1002 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 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077
/* Reconfigure the specified node 'n' as a master. This function is called when
 * a node that we believed to be a slave is now acting as master in order to
 * update the state of the node. */
void clusterSetNodeAsMaster(clusterNode *n) {
    if (n->flags & REDIS_NODE_MASTER) return;

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

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

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

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

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

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

A
antirez 已提交
1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090
/* 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 已提交
1091
    uint16_t flags = ntohs(hdr->flags);
1092
    uint64_t senderCurrentEpoch = 0, senderConfigEpoch = 0;
A
antirez 已提交
1093 1094
    clusterNode *sender;

1095
    server.cluster->stats_bus_messages_received++;
1096 1097
    redisLog(REDIS_DEBUG,"--- Processing packet of type %d, %lu bytes",
        type, (unsigned long) totlen);
1098 1099

    /* Perform sanity checks */
A
antirez 已提交
1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110
    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;
1111
    } else if (type == CLUSTERMSG_TYPE_FAIL) {
A
antirez 已提交
1112 1113 1114 1115
        uint32_t explen = sizeof(clusterMsg)-sizeof(union clusterMsgData);

        explen += sizeof(clusterMsgDataFail);
        if (totlen != explen) return 1;
1116
    } else if (type == CLUSTERMSG_TYPE_PUBLISH) {
1117 1118 1119 1120 1121 1122
        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;
1123 1124
    } else if (type == CLUSTERMSG_TYPE_FAILOVER_AUTH_REQUEST ||
               type == CLUSTERMSG_TYPE_FAILOVER_AUTH_ACK) {
1125 1126
        uint32_t explen = sizeof(clusterMsg)-sizeof(union clusterMsgData);

1127 1128 1129 1130 1131
        if (totlen != explen) return 1;
    } else if (type == CLUSTERMSG_TYPE_UPDATE) {
        uint32_t explen = sizeof(clusterMsg)-sizeof(union clusterMsgData);

        explen += sizeof(clusterMsgDataUpdate);
1132
        if (totlen != explen) return 1;
1133
    }
A
antirez 已提交
1134

1135
    /* Check if the sender is a known node. */
A
antirez 已提交
1136
    sender = clusterLookupNode(hdr->sender);
1137
    if (sender && !(sender->flags & REDIS_NODE_HANDSHAKE)) {
1138
        /* Update our curretEpoch if we see a newer epoch in the cluster. */
1139 1140 1141 1142
        senderCurrentEpoch = ntohu64(hdr->currentEpoch);
        senderConfigEpoch = ntohu64(hdr->configEpoch);
        if (senderCurrentEpoch > server.cluster->currentEpoch)
            server.cluster->currentEpoch = senderCurrentEpoch;
1143
        /* Update the sender configEpoch if it is publishing a newer one. */
1144
        if (senderConfigEpoch > sender->configEpoch) {
1145
            sender->configEpoch = senderConfigEpoch;
A
antirez 已提交
1146
            clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|CLUSTER_TODO_FSYNC_CONFIG);
1147
        }
1148
    }
1149

1150
    /* Process packets by type. */
A
antirez 已提交
1151
    if (type == CLUSTERMSG_TYPE_PING || type == CLUSTERMSG_TYPE_MEET) {
1152
        redisLog(REDIS_DEBUG,"Ping packet received: %p", (void*)link->node);
A
antirez 已提交
1153 1154 1155 1156

        /* 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
1157
         * resolved when we'll receive PONGs from the node. */
A
antirez 已提交
1158 1159 1160 1161 1162 1163 1164
        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 已提交
1165
            clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG);
A
antirez 已提交
1166 1167 1168 1169 1170 1171 1172
        }

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

        /* Anyway reply with a PONG */
        clusterSendPing(link,CLUSTERMSG_TYPE_PONG);
1173 1174 1175
    }

    /* PING or PONG: process config information. */
1176 1177 1178
    if (type == CLUSTERMSG_TYPE_PING || type == CLUSTERMSG_TYPE_PONG ||
        type == CLUSTERMSG_TYPE_MEET)
    {
1179 1180 1181
        redisLog(REDIS_DEBUG,"%s packet received: %p",
            type == CLUSTERMSG_TYPE_PING ? "ping" : "pong",
            (void*)link->node);
A
antirez 已提交
1182 1183 1184 1185 1186 1187 1188
        if (link->node) {
            if (link->node->flags & REDIS_NODE_HANDSHAKE) {
                /* If we already have this node, try to change the
                 * IP/port of the node with the new one. */
                if (sender) {
                    redisLog(REDIS_WARNING,
                        "Handshake error: we already know node %.40s, updating the address if needed.", sender->name);
A
antirez 已提交
1189 1190
                    if (nodeUpdateAddressIfNeeded(sender,link,ntohs(hdr->port)))
                    {
A
antirez 已提交
1191 1192
                        clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                                             CLUSTER_TODO_UPDATE_STATE);
A
antirez 已提交
1193 1194 1195 1196
                    }
                    /* Free this node as we alrady have it. This will
                     * cause the link to be freed as well. */
                    freeClusterNode(link->node);
A
antirez 已提交
1197 1198 1199 1200
                    return 0;
                }

                /* First thing to do is replacing the random name with the
1201
                 * right node name if this was a handshake stage. */
A
antirez 已提交
1202 1203 1204 1205
                clusterRenameNode(link->node, hdr->sender);
                redisLog(REDIS_DEBUG,"Handshake with node %.40s completed.",
                    link->node->name);
                link->node->flags &= ~REDIS_NODE_HANDSHAKE;
1206
                link->node->flags |= flags&(REDIS_NODE_MASTER|REDIS_NODE_SLAVE);
A
antirez 已提交
1207
                clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG);
A
antirez 已提交
1208 1209 1210 1211 1212 1213 1214 1215
            } 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;
1216 1217
                link->node->ip[0] = '\0';
                link->node->port = 0;
A
antirez 已提交
1218
                freeClusterLink(link);
A
antirez 已提交
1219
                clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG);
A
antirez 已提交
1220 1221 1222
                return 0;
            }
        }
1223

A
antirez 已提交
1224 1225 1226 1227 1228
        /* Update the node address if it changed. */
        if (sender && type == CLUSTERMSG_TYPE_PING &&
            !(sender->flags & REDIS_NODE_HANDSHAKE) &&
            nodeUpdateAddressIfNeeded(sender,link,ntohs(hdr->port)))
        {
A
antirez 已提交
1229
            clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|CLUSTER_TODO_UPDATE_STATE);
A
antirez 已提交
1230 1231
        }

A
antirez 已提交
1232
        /* Update our info about the node */
1233
        if (link->node && type == CLUSTERMSG_TYPE_PONG) {
1234
            link->node->pong_received = mstime();
1235 1236 1237
            link->node->ping_sent = 0;

            /* The PFAIL condition can be reversed without external
1238
             * help if it is momentary (that is, if it does not
1239 1240 1241 1242 1243 1244
             * turn into a FAIL state).
             *
             * The FAIL condition is also reversible under specific
             * conditions detected by clearNodeFailureIfNeeded(). */
            if (link->node->flags & REDIS_NODE_PFAIL) {
                link->node->flags &= ~REDIS_NODE_PFAIL;
A
antirez 已提交
1245 1246
                clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                                     CLUSTER_TODO_UPDATE_STATE);
1247 1248 1249 1250
            } else if (link->node->flags & REDIS_NODE_FAIL) {
                clearNodeFailureIfNeeded(link->node);
            }
        }
A
antirez 已提交
1251

1252
        /* Check for role switch: slave -> master or master -> slave. */
A
antirez 已提交
1253 1254 1255 1256
        if (sender) {
            if (!memcmp(hdr->slaveof,REDIS_NODE_NULL_NAME,
                sizeof(hdr->slaveof)))
            {
1257
                /* Node is a master. */
1258
                clusterSetNodeAsMaster(sender);
A
antirez 已提交
1259
            } else {
1260
                /* Node is a slave. */
A
antirez 已提交
1261 1262
                clusterNode *master = clusterLookupNode(hdr->slaveof);

1263
                if (sender->flags & REDIS_NODE_MASTER) {
1264
                    /* Master turned into a slave! Reconfigure the node. */
1265
                    clusterDelNodeSlots(sender);
1266 1267
                    sender->flags &= ~REDIS_NODE_MASTER;
                    sender->flags |= REDIS_NODE_SLAVE;
1268

1269 1270
                    /* Remove the list of slaves from the node. */
                    if (sender->numslaves) clusterNodeResetSlaves(sender);
1271 1272

                    /* Update config and state. */
A
antirez 已提交
1273 1274
                    clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                                         CLUSTER_TODO_UPDATE_STATE);
1275 1276
                }

1277 1278
                /* Master node changed for this slave? */
                if (sender->slaveof != master) {
1279 1280
                    if (sender->slaveof)
                        clusterNodeRemoveSlave(sender->slaveof,sender);
1281 1282
                    clusterNodeAddSlave(master,sender);
                    sender->slaveof = master;
1283 1284

                    /* Update config. */
A
antirez 已提交
1285
                    clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG);
1286
                }
A
antirez 已提交
1287 1288 1289
            }
        }

1290
        /* Update our info about served slots.
1291
         *
1292 1293
         * Note: this MUST happen after we update the master/slave state
         * so that REDIS_NODE_MASTER flag will be set. */
1294 1295

        /* Many checks are only needed if the set of served slots this
1296 1297 1298 1299
         * 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. */
1300 1301 1302
        int dirty_slots = 0; /* Sender claimed slots don't match my view? */

        if (sender) {
1303 1304
            sender_master = (sender->flags & REDIS_NODE_MASTER) ?
                sender : sender->slaveof;
1305 1306 1307 1308 1309 1310
            if (sender_master) {
                dirty_slots = memcmp(sender_master->slots,
                        hdr->myslots,sizeof(hdr->myslots)) != 0;
            }
        }

1311 1312 1313
        /* 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. */
1314
        if (sender && sender->flags & REDIS_NODE_MASTER && dirty_slots) {
1315
            clusterUpdateSlotsConfigWith(sender,senderConfigEpoch,hdr->myslots);
1316 1317
        }

1318 1319 1320
        /* 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.
1321
         *
1322 1323 1324 1325
         * 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:
1326 1327 1328 1329 1330 1331
         *
         * 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
1332 1333 1334 1335
         * 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). */
1336 1337 1338 1339 1340 1341 1342 1343 1344 1345
        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)
                    {
1346 1347
                        redisLog(REDIS_WARNING,
                            "Node %.40s has old slots configuration, sending "
1348
                            "an UPDATE message about %.40s",
1349 1350
                                sender->name, server.cluster->slots[j]->name);
                        clusterSendUpdate(sender->link,server.cluster->slots[j]);
1351 1352 1353 1354 1355

                        /* TODO: instead of exiting the loop send every other
                         * UPDATE packet for other nodes that are the new owner
                         * of sender's slots. */
                        break;
1356
                    }
1357
                }
A
antirez 已提交
1358 1359 1360 1361 1362
            }
        }

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

1366 1367
        if (sender) {
            failing = clusterLookupNode(hdr->data.fail.about.nodename);
1368 1369
            if (failing &&
                !(failing->flags & (REDIS_NODE_FAIL|REDIS_NODE_MYSELF)))
1370 1371 1372 1373 1374
            {
                redisLog(REDIS_NOTICE,
                    "FAIL message received from %.40s about %.40s",
                    hdr->sender, hdr->data.fail.about.nodename);
                failing->flags |= REDIS_NODE_FAIL;
1375
                failing->fail_time = mstime();
1376
                failing->flags &= ~REDIS_NODE_PFAIL;
A
antirez 已提交
1377
                clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|CLUSTER_TODO_UPDATE_STATE);
1378 1379
            }
        } else {
A
antirez 已提交
1380
            redisLog(REDIS_NOTICE,
1381
                "Ignoring FAIL message from unknonw node %.40s about %.40s",
A
antirez 已提交
1382 1383
                hdr->sender, hdr->data.fail.about.nodename);
        }
1384 1385 1386 1387
    } else if (type == CLUSTERMSG_TYPE_PUBLISH) {
        robj *channel, *message;
        uint32_t channel_len, message_len;

A
antirez 已提交
1388 1389
        /* Don't bother creating useless objects if there are no
         * Pub/Sub subscribers. */
1390 1391 1392
        if (dictSize(server.pubsub_channels) ||
           listLength(server.pubsub_patterns))
        {
1393 1394 1395 1396 1397
            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(
1398 1399
                        (char*)hdr->data.publish.msg.bulk_data+channel_len,
                        message_len);
1400 1401 1402 1403
            pubsubPublishMessage(channel,message);
            decrRefCount(channel);
            decrRefCount(message);
        }
1404
    } else if (type == CLUSTERMSG_TYPE_FAILOVER_AUTH_REQUEST) {
A
antirez 已提交
1405
        if (!sender) return 1;  /* We don't know that node. */
1406
        clusterSendFailoverAuthIfNeeded(sender,hdr);
1407
    } else if (type == CLUSTERMSG_TYPE_FAILOVER_AUTH_ACK) {
A
antirez 已提交
1408
        if (!sender) return 1;  /* We don't know that node. */
1409
        /* We consider this vote only if the sender is a master serving
1410 1411
         * a non zero number of slots, and its currentEpoch is greater or
         * equal to epoch where this node started the election. */
1412 1413
        if (sender->flags & REDIS_NODE_MASTER &&
            sender->numslots > 0 &&
1414
            senderCurrentEpoch >= server.cluster->failover_auth_epoch)
1415
        {
1416
            server.cluster->failover_auth_count++;
1417 1418
            /* Maybe we reached a quorum here, set a flag to make sure
             * we check ASAP. */
A
antirez 已提交
1419
            clusterDoBeforeSleep(CLUSTER_TODO_HANDLE_FAILOVER);
1420
        }
1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432
    } else if (type == CLUSTERMSG_TYPE_UPDATE) {
        clusterNode *n; /* The node the update is about. */
        uint64_t reportedConfigEpoch = ntohu64(hdr->data.update.nodecfg.configEpoch);

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

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

1433 1434
        /* Check the bitmap of served slots and udpate our
         * config accordingly. */
1435 1436
        clusterUpdateSlotsConfigWith(n,reportedConfigEpoch,
            hdr->data.update.nodecfg.slots);
A
antirez 已提交
1437
    } else {
1438
        redisLog(REDIS_WARNING,"Received unknown packet type: %d", type);
A
antirez 已提交
1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463
    }
    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) {
1464
        redisLog(REDIS_DEBUG,"I/O error writing to node link: %s",
A
antirez 已提交
1465 1466 1467 1468
            strerror(errno));
        handleLinkIOError(link);
        return;
    }
1469
    sdsrange(link->sndbuf,nwritten,-1);
A
antirez 已提交
1470 1471 1472 1473 1474 1475 1476 1477
    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) {
1478
    char buf[sizeof(clusterMsg)];
A
antirez 已提交
1479 1480 1481
    ssize_t nread;
    clusterMsg *hdr;
    clusterLink *link = (clusterLink*) privdata;
1482
    int readlen, rcvbuflen;
A
antirez 已提交
1483 1484 1485
    REDIS_NOTUSED(el);
    REDIS_NOTUSED(mask);

1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502
    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;
                }
1503
            }
1504 1505
            readlen = ntohl(hdr->totlen) - rcvbuflen;
            if (readlen > sizeof(buf)) readlen = sizeof(buf);
1506
        }
A
antirez 已提交
1507

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

1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522
        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 已提交
1523

1524 1525 1526 1527 1528 1529 1530 1531
        /* 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 已提交
1532 1533 1534 1535
        }
    }
}

1536 1537 1538 1539 1540
/* 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 已提交
1541 1542 1543 1544 1545 1546
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);
1547
    server.cluster->stats_bus_messages_sent++;
A
antirez 已提交
1548 1549
}

1550
/* Send a message to all the nodes that are part of the cluster having
1551 1552 1553 1554 1555
 * 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. */
1556 1557 1558 1559
void clusterBroadcastMessage(void *buf, size_t len) {
    dictIterator *di;
    dictEntry *de;

1560
    di = dictGetSafeIterator(server.cluster->nodes);
1561
    while((de = dictNext(di)) != NULL) {
1562
        clusterNode *node = dictGetVal(de);
1563 1564

        if (!node->link) continue;
1565 1566
        if (node->flags & (REDIS_NODE_MYSELF|REDIS_NODE_HANDSHAKE))
            continue;
1567 1568 1569 1570 1571
        clusterSendMessage(node->link,buf,len);
    }
    dictReleaseIterator(di);
}

A
antirez 已提交
1572 1573
/* Build the message header */
void clusterBuildMessageHdr(clusterMsg *hdr, int type) {
1574
    int totlen = 0;
1575 1576 1577 1578 1579 1580 1581 1582 1583
    clusterNode *master;

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

    memset(hdr,0,sizeof(*hdr));
    hdr->type = htons(type);
1587
    memcpy(hdr->sender,server.cluster->myself->name,REDIS_CLUSTER_NAMELEN);
1588 1589

    memcpy(hdr->myslots,master->slots,sizeof(hdr->myslots));
A
antirez 已提交
1590
    memset(hdr->slaveof,0,REDIS_CLUSTER_NAMELEN);
1591 1592
    if (server.cluster->myself->slaveof != NULL) {
        memcpy(hdr->slaveof,server.cluster->myself->slaveof->name,
A
antirez 已提交
1593 1594 1595
                                    REDIS_CLUSTER_NAMELEN);
    }
    hdr->port = htons(server.port);
1596
    hdr->flags = htons(server.cluster->myself->flags);
1597
    hdr->state = server.cluster->state;
A
antirez 已提交
1598

1599
    /* Set the currentEpoch and configEpochs. */
1600
    hdr->currentEpoch = htonu64(server.cluster->currentEpoch);
1601
    hdr->configEpoch = htonu64(master->configEpoch);
1602

A
antirez 已提交
1603 1604 1605
    if (type == CLUSTERMSG_TYPE_FAIL) {
        totlen = sizeof(clusterMsg)-sizeof(union clusterMsgData);
        totlen += sizeof(clusterMsgDataFail);
1606 1607 1608
    } else if (type == CLUSTERMSG_TYPE_UPDATE) {
        totlen = sizeof(clusterMsg)-sizeof(union clusterMsgData);
        totlen += sizeof(clusterMsgDataUpdate);
A
antirez 已提交
1609 1610
    }
    hdr->totlen = htonl(totlen);
1611
    /* For PING, PONG, and MEET, fixing the totlen field is up to the caller. */
A
antirez 已提交
1612 1613 1614 1615 1616
}

/* Send a PING or PONG packet to the specified node, making sure to add enough
 * gossip informations. */
void clusterSendPing(clusterLink *link, int type) {
1617
    unsigned char buf[sizeof(clusterMsg)];
A
antirez 已提交
1618 1619 1620 1621 1622 1623 1624 1625
    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. */
1626
    int freshnodes = dictSize(server.cluster->nodes)-2;
A
antirez 已提交
1627 1628

    if (link->node && type == CLUSTERMSG_TYPE_PING)
1629
        link->node->ping_sent = mstime();
A
antirez 已提交
1630 1631 1632 1633
    clusterBuildMessageHdr(hdr,type);
        
    /* Populate the gossip fields */
    while(freshnodes > 0 && gossipcount < 3) {
1634
        struct dictEntry *de = dictGetRandomKey(server.cluster->nodes);
1635
        clusterNode *this = dictGetVal(de);
A
antirez 已提交
1636 1637 1638
        clusterMsgDataGossip *gossip;
        int j;

1639 1640 1641 1642 1643 1644
        /* 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.
         */
1645
        if (this == server.cluster->myself ||
1646
            this->flags & (REDIS_NODE_HANDSHAKE|REDIS_NODE_NOADDR) ||
1647
            (this->link == NULL && this->numslots == 0))
1648
        {
A
antirez 已提交
1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677
                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);
}

1678 1679
/* Send a PONG packet to every connected node that's not in handshake state
 * and for which we have a valid link.
1680
 *
1681 1682
 * In Redis Cluster pongs are not used just for failure detection, but also
 * to carry important configuration information. So broadcasting a pong is
1683 1684
 * useful when something changes in the configuration and we want to make
 * the cluster aware ASAP (for instance after a slave promotion). */
1685
void clusterBroadcastPong(void) {
1686 1687 1688
    dictIterator *di;
    dictEntry *de;

1689
    di = dictGetSafeIterator(server.cluster->nodes);
1690 1691 1692
    while((de = dictNext(di)) != NULL) {
        clusterNode *node = dictGetVal(de);

1693
        if (!node->link) continue;
1694 1695 1696 1697 1698 1699
        if (node->flags & (REDIS_NODE_MYSELF|REDIS_NODE_HANDSHAKE)) continue;
        clusterSendPing(node->link,CLUSTERMSG_TYPE_PONG);
    }
    dictReleaseIterator(di);
}

1700 1701 1702 1703
/* 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) {
1704
    unsigned char buf[sizeof(clusterMsg)], *payload;
1705 1706 1707
    clusterMsg *hdr = (clusterMsg*) buf;
    uint32_t totlen;
    uint32_t channel_len, message_len;
A
antirez 已提交
1708

1709 1710 1711 1712
    channel = getDecodedObject(channel);
    message = getDecodedObject(message);
    channel_len = sdslen(channel->ptr);
    message_len = sdslen(message->ptr);
A
antirez 已提交
1713

1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726
    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);
1727
        memcpy(payload,hdr,sizeof(*hdr));
1728
        hdr = (clusterMsg*) payload;
A
antirez 已提交
1729
    }
1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741
    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 已提交
1742 1743 1744 1745 1746 1747 1748 1749
}

/* 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) {
1750
    unsigned char buf[sizeof(clusterMsg)];
A
antirez 已提交
1751 1752 1753 1754 1755 1756 1757
    clusterMsg *hdr = (clusterMsg*) buf;

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

1758 1759 1760 1761
/* 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) {
1762
    unsigned char buf[sizeof(clusterMsg)];
1763 1764
    clusterMsg *hdr = (clusterMsg*) buf;

1765
    if (link == NULL) return;
1766 1767 1768 1769 1770 1771 1772
    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));
}

1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783
/* -----------------------------------------------------------------------------
 * 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);
}

1784 1785 1786 1787
/* -----------------------------------------------------------------------------
 * SLAVE node specific functions
 * -------------------------------------------------------------------------- */

1788 1789 1790 1791 1792 1793 1794
/* 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) {
1795
    unsigned char buf[sizeof(clusterMsg)];
1796 1797 1798 1799 1800 1801
    clusterMsg *hdr = (clusterMsg*) buf;
    uint32_t totlen;

    clusterBuildMessageHdr(hdr,CLUSTERMSG_TYPE_FAILOVER_AUTH_REQUEST);
    totlen = sizeof(clusterMsg)-sizeof(union clusterMsgData);
    hdr->totlen = htonl(totlen);
1802
    clusterBroadcastMessage(buf,totlen);
1803 1804
}

1805 1806
/* Send a FAILOVER_AUTH_ACK message to the specified node. */
void clusterSendFailoverAuth(clusterNode *node) {
1807
    unsigned char buf[sizeof(clusterMsg)];
1808 1809 1810 1811 1812 1813 1814
    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);
1815
    clusterSendMessage(node->link,buf,totlen);
1816 1817
}

1818
/* Vote for the node asking for our vote if there are the conditions. */
1819
void clusterSendFailoverAuthIfNeeded(clusterNode *node, clusterMsg *request) {
1820
    clusterNode *master = node->slaveof;
1821 1822 1823 1824
    uint64_t requestCurrentEpoch = ntohu64(request->currentEpoch);
    uint64_t requestConfigEpoch = ntohu64(request->configEpoch);
    unsigned char *claimed_slots = request->myslots;
    int j;
1825 1826 1827

    /* 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
1828 1829
     * of masters serving at least one slot, and quorum is the cluster
     * size + 1 */
1830 1831 1832 1833
    if (!(server.cluster->myself->flags & REDIS_NODE_MASTER)) return;
    if (server.cluster->myself->numslots == 0) return;

    /* Request epoch must be >= our currentEpoch. */
1834 1835 1836 1837
    if (requestCurrentEpoch < server.cluster->currentEpoch) {
        printf("REFUSED BECAUSE OF EPOCH\n");
        return;
    }
1838

1839
    /* I already voted for this epoch? Return ASAP. */
1840 1841 1842 1843
    if (server.cluster->last_vote_epoch == server.cluster->currentEpoch) {
        printf("REFUSED BECAUSE ALREADY VOTED FOR EPOCH\n");
        return;
    }
1844 1845

    /* Node must be a slave and its master down. */
1846 1847
    if (!(node->flags & REDIS_NODE_SLAVE) ||
        master == NULL ||
1848 1849 1850 1851 1852
        !(master->flags & REDIS_NODE_FAIL))
    {
        printf("REFUSED BECAUSE NOT A SLAVE OR MASTER NOT FAIL.\n");
        return;
    }
1853

1854 1855 1856
    /* 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. */
1857
    if (mstime() - node->slaveof->voted_time < server.cluster_node_timeout * 2)
1858 1859
    {
        printf("REFUSED BECAUSE ALREADY VOTED WITHIN NODE_TIMEOUT*2.\n");
1860
        return;
1861
    }
1862

1863 1864 1865
    /* 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. */
1866 1867 1868 1869 1870 1871 1872
    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. */
1873
        printf("REFUSED BECAUSE SLAVE CONFIG EPOCH FOR SLOTS IS STALE.\n");
1874 1875 1876
        return;
    }

1877
    /* We can vote for this slave. */
1878
    printf("I VOTED.\n");
1879
    clusterSendFailoverAuth(node);
1880
    server.cluster->last_vote_epoch = server.cluster->currentEpoch;
1881
    node->slaveof->voted_time = mstime();
1882 1883
}

1884
/* This function is called if we are a slave node and our master serving
1885
 * a non-zero amount of hash slots is in FAIL state.
1886 1887 1888
 *
 * The gaol of this function is:
 * 1) To check if we are able to perform a failover, is our data updated?
1889
 * 2) Try to get elected by masters.
1890
 * 3) Perform the failover informing all the other nodes.
1891 1892
 */
void clusterHandleSlaveFailover(void) {
1893
    mstime_t data_age;
1894
    mstime_t auth_age = mstime() - server.cluster->failover_auth_time;
1895
    int needed_quorum = (server.cluster->size / 2) + 1;
1896
    int j;
1897

1898 1899
    /* Set data_age to the number of seconds we are disconnected from
     * the master. */
1900
    if (server.repl_state == REDIS_REPL_CONNECTED) {
1901
        data_age = (server.unixtime - server.master->lastinteraction) * 1000;
1902
    } else {
1903
        data_age = (server.unixtime - server.repl_down_since) * 1000;
1904 1905
    }

1906 1907 1908 1909 1910 1911 1912 1913 1914
    /* Pre conditions to run the function:
     * 1) We are a slave.
     * 2) Our master is flagged as FAIL.
     * 3) It is serving slots. */
    if (!(server.cluster->myself->flags & REDIS_NODE_SLAVE) ||
        server.cluster->myself->slaveof == NULL ||
        !(server.cluster->myself->slaveof->flags & REDIS_NODE_FAIL) ||
        server.cluster->myself->slaveof->numslots == 0) return;

1915 1916 1917 1918 1919 1920
    /* 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;

1921 1922 1923
    /* 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. */
1924
    if (data_age >
1925 1926
        (server.repl_ping_slave_period * 1000) +
        (server.cluster_node_timeout * REDIS_CLUSTER_SLAVE_VALIDITY_MULT))
1927
        return;
1928

1929
    /* Compute the time at which we can start an election. */
1930
    if (auth_age >
1931
        server.cluster_node_timeout * REDIS_CLUSTER_FAILOVER_AUTH_RETRY_MULT)
1932
    {
1933 1934
        server.cluster->failover_auth_time = mstime() +
            500 + /* Fixed delay of 500 milliseconds, let FAIL msg propagate. */
1935
            data_age / 10 + /* Add 100 milliseconds for every second of age. */
1936
            random() % 500; /* Random delay between 0 and 500 milliseconds. */
1937
        server.cluster->failover_auth_count = 0;
1938
        server.cluster->failover_auth_sent = 0;
1939 1940
        redisLog(REDIS_WARNING,
            "Start of election delayed for %lld milliseconds.",
1941 1942 1943 1944 1945 1946 1947 1948
            server.cluster->failover_auth_time - mstime());
        return;
    }

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

    /* Return ASAP if the election is too old to be valid. */
1949
    if (auth_age > server.cluster_node_timeout) return;
1950 1951 1952 1953 1954 1955

    /* 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.",
1956
            (unsigned long long) server.cluster->currentEpoch);
1957
        clusterRequestFailoverAuth();
1958
        server.cluster->failover_auth_sent = 1;
A
antirez 已提交
1959 1960 1961
        clusterDoBeforeSleep(CLUSTER_TODO_SAVE_CONFIG|
                             CLUSTER_TODO_UPDATE_STATE|
                             CLUSTER_TODO_FSYNC_CONFIG);
1962 1963 1964 1965
        return; /* Wait for replies. */
    }

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

1969
        redisLog(REDIS_WARNING,
A
antirez 已提交
1970
            "Failover election won: I'm the new master.");
A
antirez 已提交
1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981
        /* We have the quorum, perform all the steps to correctly promote
         * this slave to a master.
         *
         * 1) Turn this node into a master. */
        clusterNodeRemoveSlave(server.cluster->myself->slaveof,
                               server.cluster->myself);
        server.cluster->myself->flags &= ~REDIS_NODE_SLAVE;
        server.cluster->myself->flags |= REDIS_NODE_MASTER;
        server.cluster->myself->slaveof = NULL;
        replicationUnsetMaster();

1982 1983 1984 1985 1986 1987 1988 1989
        /* 2) Claim all the slots assigned to our master. */
        for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
            if (clusterNodeGetSlotBit(oldmaster,j)) {
                clusterDelSlot(j);
                clusterAddSlot(server.cluster->myself,j);
            }
        }

1990
        /* 3) Update my configEpoch to the epoch of the election. */
1991 1992
        server.cluster->myself->configEpoch =
            server.cluster->failover_auth_epoch;
1993

1994
        /* 4) Update state and save config. */
1995
        clusterUpdateState();
A
antirez 已提交
1996
        clusterSaveConfigOrDie(1);
1997 1998 1999 2000

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

A
antirez 已提交
2004 2005 2006 2007
/* -----------------------------------------------------------------------------
 * CLUSTER cron job
 * -------------------------------------------------------------------------- */

2008
/* This is executed 10 times every second */
A
antirez 已提交
2009 2010 2011
void clusterCron(void) {
    dictIterator *di;
    dictEntry *de;
2012
    int j, update_state = 0;
2013
    mstime_t min_pong = 0, now = mstime();
2014
    clusterNode *min_pong_node = NULL;
2015
    static unsigned long long iteration = 0;
2016
    mstime_t handshake_timeout;
2017 2018

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

2020
    /* The handshake timeout is the time after which a handshake node that was
2021 2022 2023 2024 2025 2026
     * 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 已提交
2027
    /* Check if we have disconnected nodes and re-establish the connection. */
2028
    di = dictGetSafeIterator(server.cluster->nodes);
A
antirez 已提交
2029
    while((de = dictNext(di)) != NULL) {
2030
        clusterNode *node = dictGetVal(de);
A
antirez 已提交
2031 2032

        if (node->flags & (REDIS_NODE_MYSELF|REDIS_NODE_NOADDR)) continue;
2033 2034 2035 2036

        /* A Node in HANDSHAKE state has a limited lifespan equal to the
         * configured node timeout. */
        if (node->flags & REDIS_NODE_HANDSHAKE &&
2037
            now - node->ctime > handshake_timeout)
2038 2039 2040 2041 2042
        {
            freeClusterNode(node);
            continue;
        }

A
antirez 已提交
2043 2044
        if (node->link == NULL) {
            int fd;
2045
            mstime_t old_ping_sent;
A
antirez 已提交
2046 2047 2048 2049 2050 2051 2052 2053 2054
            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);
2055 2056 2057 2058
            /* 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 已提交
2059 2060
             * of a PING one, to force the receiver to add us in its node
             * table. */
2061
            old_ping_sent = node->ping_sent;
A
antirez 已提交
2062 2063
            clusterSendPing(link, node->flags & REDIS_NODE_MEET ?
                    CLUSTERMSG_TYPE_MEET : CLUSTERMSG_TYPE_PING);
2064 2065 2066 2067 2068 2069
            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 已提交
2070 2071 2072 2073 2074 2075 2076
            /* 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;

2077
            redisLog(REDIS_DEBUG,"Connecting with Node %.40s at %s:%d", node->name, node->ip, node->port+REDIS_CLUSTER_PORT_INCR);
A
antirez 已提交
2078 2079 2080 2081
        }
    }
    dictReleaseIterator(di);

2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101
    /* 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 已提交
2102 2103 2104 2105
        }
    }

    /* Iterate nodes to check if we need to flag something as failing */
2106
    di = dictGetSafeIterator(server.cluster->nodes);
A
antirez 已提交
2107
    while((de = dictNext(di)) != NULL) {
2108
        clusterNode *node = dictGetVal(de);
2109
        now = mstime(); /* Use an updated time at every iteration. */
2110
        mstime_t delay;
A
antirez 已提交
2111 2112

        if (node->flags &
2113 2114
            (REDIS_NODE_MYSELF|REDIS_NODE_NOADDR|REDIS_NODE_HANDSHAKE))
                continue;
2115

2116 2117 2118 2119
        /* 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 */
2120
            now - node->link->ctime >
2121
            server.cluster_node_timeout && /* was not already reconnected */
2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134
            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. */
2135
        if (node->link &&
2136 2137
            node->ping_sent == 0 &&
            (now - node->pong_received) > server.cluster_node_timeout/2)
2138 2139 2140 2141 2142
        {
            clusterSendPing(node->link, CLUSTERMSG_TYPE_PING);
            continue;
        }

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

2146 2147 2148 2149
        /* 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;
2150

2151
        if (delay > server.cluster_node_timeout) {
G
guiquanz 已提交
2152
            /* Timeout reached. Set the node as possibly failing if it is
2153
             * not already in this state. */
2154
            if (!(node->flags & (REDIS_NODE_PFAIL|REDIS_NODE_FAIL))) {
A
antirez 已提交
2155 2156 2157
                redisLog(REDIS_DEBUG,"*** NODE %.40s possibly failing",
                    node->name);
                node->flags |= REDIS_NODE_PFAIL;
2158
                update_state = 1;
A
antirez 已提交
2159 2160 2161 2162
            }
        }
    }
    dictReleaseIterator(di);
2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174

    /* If we are a slave node but the replication is still turned off,
     * enable it if we know the address of our master and it appears to
     * be up. */
    if (server.cluster->myself->flags & REDIS_NODE_SLAVE &&
        server.masterhost == NULL &&
        server.cluster->myself->slaveof &&
        !(server.cluster->myself->slaveof->flags & REDIS_NODE_NOADDR))
    {
        replicationSetMaster(server.cluster->myself->slaveof->ip,
                             server.cluster->myself->slaveof->port);
    }
2175

2176 2177 2178 2179 2180 2181 2182
    clusterHandleSlaveFailover();
    if (update_state) clusterUpdateState();
}

/* This function is called before the event handler returns to sleep for
 * events. It is useful to perform operations that must be done ASAP in
 * reaction to events fired but that are not safe to perform inside event
A
antirez 已提交
2183 2184
 * handlers, or to perform potentially expansive tasks that we need to do
 * a single time before replying to clients. */
2185
void clusterBeforeSleep(void) {
A
antirez 已提交
2186 2187 2188
    /* 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)
2189
        clusterHandleSlaveFailover();
A
antirez 已提交
2190 2191 2192 2193 2194 2195 2196 2197 2198

    /* 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);
2199
    }
A
antirez 已提交
2200 2201 2202 2203 2204 2205 2206

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

void clusterDoBeforeSleep(int flags) {
    server.cluster->todo_before_sleep |= flags;
A
antirez 已提交
2207 2208 2209 2210 2211 2212
}

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

2213
/* Test bit 'pos' in a generic bitmap. Return 1 if the bit is set,
2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234
 * 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 已提交
2235 2236
/* Set the slot bit and return the old value. */
int clusterNodeSetSlotBit(clusterNode *n, int slot) {
2237 2238
    int old = bitmapTestBit(n->slots,slot);
    bitmapSetBit(n->slots,slot);
2239
    if (!old) n->numslots++;
A
antirez 已提交
2240 2241 2242 2243 2244
    return old;
}

/* Clear the slot bit and return the old value. */
int clusterNodeClearSlotBit(clusterNode *n, int slot) {
2245 2246
    int old = bitmapTestBit(n->slots,slot);
    bitmapClearBit(n->slots,slot);
2247
    if (old) n->numslots--;
A
antirez 已提交
2248 2249 2250 2251 2252
    return old;
}

/* Return the slot bit from the cluster node structure. */
int clusterNodeGetSlotBit(clusterNode *n, int slot) {
2253
    return bitmapTestBit(n->slots,slot);
A
antirez 已提交
2254 2255 2256 2257 2258 2259 2260
}

/* 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) {
2261 2262
    if (server.cluster->slots[slot]) return REDIS_ERR;
    clusterNodeSetSlotBit(n,slot);
2263
    server.cluster->slots[slot] = n;
A
antirez 已提交
2264 2265 2266
    return REDIS_OK;
}

A
antirez 已提交
2267 2268 2269 2270
/* 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) {
2271
    clusterNode *n = server.cluster->slots[slot];
A
antirez 已提交
2272 2273 2274

    if (!n) return REDIS_ERR;
    redisAssert(clusterNodeClearSlotBit(n,slot) == 1);
2275
    server.cluster->slots[slot] = NULL;
A
antirez 已提交
2276 2277 2278
    return REDIS_OK;
}

2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290
/* 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 已提交
2291 2292 2293
/* -----------------------------------------------------------------------------
 * Cluster state evaluation function
 * -------------------------------------------------------------------------- */
2294 2295 2296

#define REDIS_CLUSTER_MAX_REJOIN_DELAY 5000

A
antirez 已提交
2297
void clusterUpdateState(void) {
2298
    int j, new_state;
2299
    int unreachable_masters = 0;
2300
    static mstime_t among_minority_time;
A
antirez 已提交
2301

2302 2303
    /* Start assuming the state is OK. We'll turn it into FAIL if there
     * are the right conditions. */
2304
    new_state = REDIS_CLUSTER_OK;
2305

2306
    /* Check if all the slots are covered. */
A
antirez 已提交
2307
    for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
2308 2309
        if (server.cluster->slots[j] == NULL ||
            server.cluster->slots[j]->flags & (REDIS_NODE_FAIL))
A
antirez 已提交
2310
        {
2311
            new_state = REDIS_CLUSTER_FAIL;
A
antirez 已提交
2312 2313 2314
            break;
        }
    }
2315

2316
    /* Compute the cluster size, that is the number of master nodes
2317 2318 2319 2320
     * serving at least a single slot.
     *
     * At the same time count the number of unreachable masters with
     * at least one node. */
2321 2322 2323 2324 2325
    {
        dictIterator *di;
        dictEntry *de;

        server.cluster->size = 0;
2326
        di = dictGetSafeIterator(server.cluster->nodes);
2327 2328 2329
        while((de = dictNext(di)) != NULL) {
            clusterNode *node = dictGetVal(de);

2330
            if (node->flags & REDIS_NODE_MASTER && node->numslots) {
2331
                server.cluster->size++;
2332 2333 2334
                if (node->flags & (REDIS_NODE_FAIL|REDIS_NODE_PFAIL))
                    unreachable_masters++;
            }
2335 2336 2337
        }
        dictReleaseIterator(di);
    }
2338

2339
    /* If we can't reach at least half the masters, change the cluster state
2340
     * to FAIL, as we are not even able to mark nodes as FAIL in this side
2341
     * of the netsplit because of lack of majority. */
2342 2343 2344
    {
        int needed_quorum = (server.cluster->size / 2) + 1;
        
2345 2346 2347 2348
        if (unreachable_masters >= needed_quorum) {
            new_state = REDIS_CLUSTER_FAIL;
            among_minority_time = mstime();
        }
2349 2350
    }

2351
    /* Log a state change */
2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369
    if (new_state != server.cluster->state) {
        mstime_t rejoin_delay = server.cluster_node_timeout;

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

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

        /* Change the state and log the event. */
2370
        redisLog(REDIS_WARNING,"Cluster state changed: %s",
2371 2372 2373
            new_state == REDIS_CLUSTER_OK ? "ok" : "fail");
        server.cluster->state = new_state;
    }
A
antirez 已提交
2374 2375
}

2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398
/* 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) {
2399 2400 2401
    int j;
    int update_config = 0;

2402 2403 2404 2405
    /* If this node is a slave, don't perform the check at all as we
     * completely depend on the replication stream. */
    if (server.cluster->myself->flags & REDIS_NODE_SLAVE) return REDIS_OK;

2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438
    /* Make sure we only have keys in DB0. */
    for (j = 1; j < server.dbnum; j++) {
        if (dictSize(server.db[j].dict)) return REDIS_ERR;
    }

    /* Check that all the slots we see populated memory have a corresponding
     * entry in the cluster table. Otherwise fix the table. */
    for (j = 0; j < REDIS_CLUSTER_SLOTS; j++) {
        if (!countKeysInSlot(j)) continue; /* No keys in this slot. */
        /* Check if we are assigned to this slot or if we are importing it.
         * In both cases check the next slot as the configuration makes
         * sense. */
        if (server.cluster->slots[j] == server.cluster->myself ||
            server.cluster->importing_slots_from[j] != NULL) continue;

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

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

2443 2444 2445 2446
/* -----------------------------------------------------------------------------
 * SLAVE nodes handling
 * -------------------------------------------------------------------------- */

2447 2448
/* Set the specified node 'n' as master. Setup the node as a slave if
 * needed. */
2449 2450 2451 2452
void clusterSetMaster(clusterNode *n) {
    clusterNode *myself = server.cluster->myself;

    redisAssert(n != myself);
2453
    redisAssert(myself->numslots == 0);
2454 2455 2456 2457 2458 2459

    if (myself->flags & REDIS_NODE_MASTER) {
        myself->flags &= ~REDIS_NODE_MASTER;
        myself->flags |= REDIS_NODE_SLAVE;
    }
    myself->slaveof = n;
2460
    replicationSetMaster(n->ip, n->port);
2461 2462
}

A
antirez 已提交
2463 2464 2465 2466
/* -----------------------------------------------------------------------------
 * CLUSTER command
 * -------------------------------------------------------------------------- */

2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479
/* Generate a csv-alike representation of the nodes we are aware of,
 * including the "myself" node, and return an SDS string containing the
 * representation (it is up to the caller to free it).
 *
 * All the nodes matching at least one of the node flags specified in
 * "filter" are excluded from the output, so using zero as a filter will
 * include all the known nodes in the representation, including nodes in
 * the HANDSHAKE state.
 *
 * The representation obtained using this function is used for the output
 * of the CLUSTER NODES function, and as format for the cluster
 * configuration file (nodes.conf) for a given node. */
sds clusterGenNodesDescription(int filter) {
A
antirez 已提交
2480 2481 2482
    sds ci = sdsempty();
    dictIterator *di;
    dictEntry *de;
2483
    int j, start;
A
antirez 已提交
2484

2485
    di = dictGetSafeIterator(server.cluster->nodes);
A
antirez 已提交
2486
    while((de = dictNext(di)) != NULL) {
2487
        clusterNode *node = dictGetVal(de);
A
antirez 已提交
2488

2489 2490
        if (node->flags & filter) continue;

A
antirez 已提交
2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514
        /* Node coordinates */
        ci = sdscatprintf(ci,"%.40s %s:%d ",
            node->name,
            node->ip,
            node->port);

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

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

        /* Latency from the POV of this node, link status */
2515 2516 2517
        ci = sdscatprintf(ci,"%lld %lld %llu %s",
            (long long) node->ping_sent,
            (long long) node->pong_received,
2518
            (unsigned long long) node->configEpoch,
2519 2520
            (node->link || node->flags & REDIS_NODE_MYSELF) ?
                        "connected" : "disconnected");
2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540

        /* 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;
            }
        }
2541 2542 2543 2544 2545 2546

        /* 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++) {
2547
                if (server.cluster->migrating_slots_to[j]) {
A
antirez 已提交
2548
                    ci = sdscatprintf(ci," [%d->-%.40s]",j,
2549 2550
                        server.cluster->migrating_slots_to[j]->name);
                } else if (server.cluster->importing_slots_from[j]) {
A
antirez 已提交
2551
                    ci = sdscatprintf(ci," [%d-<-%.40s]",j,
2552
                        server.cluster->importing_slots_from[j]->name);
2553 2554 2555
                }
            }
        }
2556
        ci = sdscatlen(ci,"\n",1);
A
antirez 已提交
2557 2558 2559 2560 2561
    }
    dictReleaseIterator(di);
    return ci;
}

2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573
int getSlotOrReply(redisClient *c, robj *o) {
    long long slot;

    if (getLongLongFromObject(o,&slot) != REDIS_OK ||
        slot < 0 || slot > REDIS_CLUSTER_SLOTS)
    {
        addReplyError(c,"Invalid or out of range slot");
        return -1;
    }
    return (int) slot;
}

A
antirez 已提交
2574 2575 2576 2577 2578 2579 2580 2581 2582
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;

2583
        if (getLongFromObjectOrReply(c, c->argv[3], &port, NULL) != REDIS_OK) {
A
antirez 已提交
2584 2585 2586 2587
            addReplyError(c,"Invalid TCP port specified");
            return;
        }

2588 2589 2590 2591 2592 2593 2594
        if (clusterStartHandshake(c->argv[2]->ptr,port) == 0 &&
            errno == EINVAL)
        {
            addReplyError(c,"Invalid node address specified");
        } else {
            addReply(c,shared.ok);
        }
A
antirez 已提交
2595
    } else if (!strcasecmp(c->argv[1]->ptr,"nodes") && c->argc == 2) {
2596
        /* CLUSTER NODES */
A
antirez 已提交
2597
        robj *o;
2598
        sds ci = clusterGenNodesDescription(0);
A
antirez 已提交
2599 2600 2601 2602

        o = createObject(REDIS_STRING,ci);
        addReplyBulk(c,o);
        decrRefCount(o);
2603 2604 2605 2606 2607 2608 2609
    } else if (!strcasecmp(c->argv[1]->ptr,"flushslots") && c->argc == 2) {
        /* CLUSTER FLUSHSLOTS */
        if (dictSize(server.db[0].dict) != 0) {
            addReplyError(c,"DB must be empty to perform CLUSTER FLUSHSLOTS.");
            return;
        }
        clusterDelNodeSlots(server.cluster->myself);
A
antirez 已提交
2610
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
2611
        addReply(c,shared.ok);
A
antirez 已提交
2612
    } else if ((!strcasecmp(c->argv[1]->ptr,"addslots") ||
A
antirez 已提交
2613 2614 2615 2616
               !strcasecmp(c->argv[1]->ptr,"delslots")) && c->argc >= 3)
    {
        /* CLUSTER ADDSLOTS <slot> [slot] ... */
        /* CLUSTER DELSLOTS <slot> [slot] ... */
2617
        int j, slot;
A
antirez 已提交
2618
        unsigned char *slots = zmalloc(REDIS_CLUSTER_SLOTS);
A
antirez 已提交
2619
        int del = !strcasecmp(c->argv[1]->ptr,"delslots");
A
antirez 已提交
2620 2621 2622 2623 2624

        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++) {
2625
            if ((slot = getSlotOrReply(c,c->argv[j])) == -1) {
A
antirez 已提交
2626 2627 2628
                zfree(slots);
                return;
            }
2629
            if (del && server.cluster->slots[slot] == NULL) {
2630
                addReplyErrorFormat(c,"Slot %d is already unassigned", slot);
A
antirez 已提交
2631 2632
                zfree(slots);
                return;
2633
            } else if (!del && server.cluster->slots[slot]) {
2634
                addReplyErrorFormat(c,"Slot %d is already busy", slot);
A
antirez 已提交
2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646
                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]) {
2647 2648 2649 2650
                int retval;

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

                retval = del ? clusterDelSlot(j) :
2655
                               clusterAddSlot(server.cluster->myself,j);
2656
                redisAssertWithInfo(c,NULL,retval == REDIS_OK);
A
antirez 已提交
2657 2658 2659
            }
        }
        zfree(slots);
A
antirez 已提交
2660
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
A
antirez 已提交
2661
        addReply(c,shared.ok);
2662
    } else if (!strcasecmp(c->argv[1]->ptr,"setslot") && c->argc >= 4) {
A
antirez 已提交
2663 2664
        /* SETSLOT 10 MIGRATING <node ID> */
        /* SETSLOT 10 IMPORTING <node ID> */
2665
        /* SETSLOT 10 STABLE */
A
antirez 已提交
2666
        /* SETSLOT 10 NODE <node ID> */
2667
        int slot;
2668 2669
        clusterNode *n;

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

2672
        if (!strcasecmp(c->argv[3]->ptr,"migrating") && c->argc == 5) {
2673
            if (server.cluster->slots[slot] != server.cluster->myself) {
2674 2675 2676
                addReplyErrorFormat(c,"I'm not the owner of hash slot %u",slot);
                return;
            }
2677 2678 2679 2680 2681
            if ((n = clusterLookupNode(c->argv[4]->ptr)) == NULL) {
                addReplyErrorFormat(c,"I don't know about node %s",
                    (char*)c->argv[4]->ptr);
                return;
            }
2682
            server.cluster->migrating_slots_to[slot] = n;
2683
        } else if (!strcasecmp(c->argv[3]->ptr,"importing") && c->argc == 5) {
2684
            if (server.cluster->slots[slot] == server.cluster->myself) {
2685 2686 2687 2688
                addReplyErrorFormat(c,
                    "I'm already the owner of hash slot %u",slot);
                return;
            }
2689 2690 2691 2692 2693
            if ((n = clusterLookupNode(c->argv[4]->ptr)) == NULL) {
                addReplyErrorFormat(c,"I don't know about node %s",
                    (char*)c->argv[3]->ptr);
                return;
            }
2694
            server.cluster->importing_slots_from[slot] = n;
2695
        } else if (!strcasecmp(c->argv[3]->ptr,"stable") && c->argc == 4) {
2696
            /* CLUSTER SETSLOT <SLOT> STABLE */
2697 2698
            server.cluster->importing_slots_from[slot] = NULL;
            server.cluster->migrating_slots_to[slot] = NULL;
2699
        } else if (!strcasecmp(c->argv[3]->ptr,"node") && c->argc == 5) {
2700 2701 2702
            /* CLUSTER SETSLOT <SLOT> NODE <NODE ID> */
            clusterNode *n = clusterLookupNode(c->argv[4]->ptr);

2703 2704 2705 2706 2707
            if (!n) {
                addReplyErrorFormat(c,"Unknown node %s",
                    (char*)c->argv[4]->ptr);
                return;
            }
2708 2709
            /* If this hash slot was served by 'myself' before to switch
             * make sure there are no longer local keys for this hash slot. */
2710 2711
            if (server.cluster->slots[slot] == server.cluster->myself &&
                n != server.cluster->myself)
2712
            {
2713
                if (countKeysInSlot(slot) != 0) {
2714 2715 2716 2717
                    addReplyErrorFormat(c, "Can't assign hashslot %d to a different node while I still hold keys for this hash slot.", slot);
                    return;
                }
            }
2718 2719 2720
            /* 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. */
2721 2722 2723
            if (server.cluster->slots[slot] == server.cluster->myself &&
                server.cluster->migrating_slots_to[slot])
                server.cluster->migrating_slots_to[slot] = NULL;
2724

2725 2726
            /* If this node was importing this slot, assigning the slot to
             * itself also clears the importing status. */
2727 2728
            if (n == server.cluster->myself &&
                server.cluster->importing_slots_from[slot])
2729
                server.cluster->importing_slots_from[slot] = NULL;
2730 2731
            clusterDelSlot(slot);
            clusterAddSlot(n,slot);
2732 2733
        } else {
            addReplyError(c,"Invalid CLUSTER SETSLOT action or number of arguments");
2734
            return;
2735
        }
A
antirez 已提交
2736
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
2737
        addReply(c,shared.ok);
A
antirez 已提交
2738
    } else if (!strcasecmp(c->argv[1]->ptr,"info") && c->argc == 2) {
2739
        /* CLUSTER INFO */
A
antirez 已提交
2740 2741 2742 2743 2744
        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++) {
2745
            clusterNode *n = server.cluster->slots[j];
A
antirez 已提交
2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763

            if (n == NULL) continue;
            slots_assigned++;
            if (n->flags & REDIS_NODE_FAIL) {
                slots_fail++;
            } else if (n->flags & REDIS_NODE_PFAIL) {
                slots_pfail++;
            } else {
                slots_ok++;
            }
        }

        sds info = sdscatprintf(sdsempty(),
            "cluster_state:%s\r\n"
            "cluster_slots_assigned:%d\r\n"
            "cluster_slots_ok:%d\r\n"
            "cluster_slots_pfail:%d\r\n"
            "cluster_slots_fail:%d\r\n"
2764
            "cluster_known_nodes:%lu\r\n"
2765
            "cluster_size:%d\r\n"
2766
            "cluster_current_epoch:%llu\r\n"
2767 2768
            "cluster_stats_messages_sent:%lld\r\n"
            "cluster_stats_messages_received:%lld\r\n"
2769
            , statestr[server.cluster->state],
A
antirez 已提交
2770 2771 2772
            slots_assigned,
            slots_ok,
            slots_pfail,
2773
            slots_fail,
2774
            dictSize(server.cluster->nodes),
2775
            server.cluster->size,
2776 2777 2778
            (unsigned long long) server.cluster->currentEpoch,
            server.cluster->stats_bus_messages_sent,
            server.cluster->stats_bus_messages_received
A
antirez 已提交
2779 2780 2781 2782 2783
        );
        addReplySds(c,sdscatprintf(sdsempty(),"$%lu\r\n",
            (unsigned long)sdslen(info)));
        addReplySds(c,info);
        addReply(c,shared.crlf);
2784
    } else if (!strcasecmp(c->argv[1]->ptr,"saveconfig") && c->argc == 2) {
A
antirez 已提交
2785
        int retval = clusterSaveConfig(1);
2786 2787 2788 2789 2790 2791

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

        addReplyLongLong(c,keyHashSlot(key,sdslen(key)));
2797
    } else if (!strcasecmp(c->argv[1]->ptr,"countkeysinslot") && c->argc == 3) {
2798
        /* CLUSTER COUNTKEYSINSLOT <slot> */
2799 2800 2801 2802
        long long slot;

        if (getLongLongFromObjectOrReply(c,c->argv[2],&slot,NULL) != REDIS_OK)
            return;
2803 2804 2805 2806
        if (slot < 0 || slot >= REDIS_CLUSTER_SLOTS) {
            addReplyError(c,"Invalid slot");
            return;
        }
2807
        addReplyLongLong(c,countKeysInSlot(slot));
A
antirez 已提交
2808
    } else if (!strcasecmp(c->argv[1]->ptr,"getkeysinslot") && c->argc == 4) {
2809
        /* CLUSTER GETKEYSINSLOT <slot> <count> */
A
antirez 已提交
2810
        long long maxkeys, slot;
2811
        unsigned int numkeys, j;
A
antirez 已提交
2812 2813 2814 2815 2816 2817
        robj **keys;

        if (getLongLongFromObjectOrReply(c,c->argv[2],&slot,NULL) != REDIS_OK)
            return;
        if (getLongLongFromObjectOrReply(c,c->argv[3],&maxkeys,NULL) != REDIS_OK)
            return;
2818
        if (slot < 0 || slot >= REDIS_CLUSTER_SLOTS || maxkeys < 0) {
A
antirez 已提交
2819 2820 2821 2822 2823
            addReplyError(c,"Invalid slot or number of keys");
            return;
        }

        keys = zmalloc(sizeof(robj*)*maxkeys);
2824
        numkeys = getKeysInSlot(slot, keys, maxkeys);
A
antirez 已提交
2825 2826 2827
        addReplyMultiBulkLen(c,numkeys);
        for (j = 0; j < numkeys; j++) addReplyBulk(c,keys[j]);
        zfree(keys);
A
antirez 已提交
2828 2829 2830 2831 2832 2833 2834 2835 2836
    } else if (!strcasecmp(c->argv[1]->ptr,"forget") && c->argc == 3) {
        /* CLUSTER FORGET <NODE ID> */
        clusterNode *n = clusterLookupNode(c->argv[2]->ptr);

        if (!n) {
            addReplyErrorFormat(c,"Unknown node %s", (char*)c->argv[2]->ptr);
            return;
        }
        clusterDelNode(n);
A
antirez 已提交
2837
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
A
antirez 已提交
2838
        addReply(c,shared.ok);
2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871
    } else if (!strcasecmp(c->argv[1]->ptr,"replicate") && c->argc == 3) {
        /* CLUSTER REPLICATE <NODE ID> */
        clusterNode *n = clusterLookupNode(c->argv[2]->ptr);

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

        /* I can't replicate myself. */
        if (n == server.cluster->myself) {
            addReplyError(c,"Can't replicate myself");
            return;
        }

        /* Can't replicate a slave. */
        if (n->slaveof != NULL) {
            addReplyError(c,"I can only replicate a master, not a slave.");
            return;
        }

        /* We should have no assigned slots to accept to replicate some
         * other node. */
        if (server.cluster->myself->numslots != 0 ||
            dictSize(server.db[0].dict) != 0)
        {
            addReplyError(c,"To set a master the node must be empty and without assigned slots.");
            return;
        }

        /* Set the master. */
        clusterSetMaster(n);
A
antirez 已提交
2872
        clusterDoBeforeSleep(CLUSTER_TODO_UPDATE_STATE|CLUSTER_TODO_SAVE_CONFIG);
2873
        addReply(c,shared.ok);
A
antirez 已提交
2874 2875 2876 2877 2878 2879
    } else {
        addReplyError(c,"Wrong CLUSTER subcommand or number of arguments");
    }
}

/* -----------------------------------------------------------------------------
2880
 * DUMP, RESTORE and MIGRATE commands
A
antirez 已提交
2881 2882
 * -------------------------------------------------------------------------- */

2883 2884 2885
/* 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) {
2886 2887
    unsigned char buf[2];
    uint64_t crc;
2888 2889 2890 2891 2892 2893 2894 2895

    /* 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:
2896 2897 2898 2899 2900
     * ----------------+---------------------+---------------+
     * ... RDB payload | 2 bytes RDB version | 8 bytes CRC64 |
     * ----------------+---------------------+---------------+
     * RDB version and CRC are both in little endian.
     */
2901 2902

    /* RDB version */
2903 2904
    buf[0] = REDIS_RDB_VERSION & 0xff;
    buf[1] = (REDIS_RDB_VERSION >> 8) & 0xff;
2905 2906
    payload->io.buffer.ptr = sdscatlen(payload->io.buffer.ptr,buf,2);

2907
    /* CRC64 */
2908
    crc = crc64(0,(unsigned char*)payload->io.buffer.ptr,
2909 2910 2911
                sdslen(payload->io.buffer.ptr));
    memrev64ifbe(&crc);
    payload->io.buffer.ptr = sdscatlen(payload->io.buffer.ptr,&crc,8);
2912 2913 2914
}

/* Verify that the RDB version of the dump payload matches the one of this Redis
2915
 * instance and that the checksum is ok.
2916 2917 2918
 * If the DUMP payload looks valid REDIS_OK is returned, otherwise REDIS_ERR
 * is returned. */
int verifyDumpPayload(unsigned char *p, size_t len) {
2919
    unsigned char *footer;
2920
    uint16_t rdbver;
2921
    uint64_t crc;
2922

2923
    /* At least 2 bytes of RDB version and 8 of CRC64 should be present. */
2924 2925
    if (len < 10) return REDIS_ERR;
    footer = p+(len-10);
2926 2927

    /* Verify RDB version */
2928
    rdbver = (footer[1] << 8) | footer[0];
2929
    if (rdbver != REDIS_RDB_VERSION) return REDIS_ERR;
2930

2931
    /* Verify CRC64 */
2932
    crc = crc64(0,p,len-8);
2933 2934
    memrev64ifbe(&crc);
    return (memcmp(&crc,footer+2,8) == 0) ? REDIS_OK : REDIS_ERR;
2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959
}

/* 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 已提交
2960
/* RESTORE key ttl serialized-value [REPLACE] */
A
antirez 已提交
2961
void restoreCommand(redisClient *c) {
2962
    long long ttl;
2963
    rio payload;
A
antirez 已提交
2964
    int j, type, replace = 0;
2965
    robj *obj;
A
antirez 已提交
2966

A
antirez 已提交
2967 2968 2969 2970 2971 2972 2973 2974 2975 2976
    /* 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 已提交
2977
    /* Make sure this key does not already exist here... */
A
antirez 已提交
2978
    if (!replace && lookupKeyWrite(c->db,c->argv[1]) != NULL) {
A
antirez 已提交
2979 2980 2981 2982 2983
        addReplyError(c,"Target key name is busy.");
        return;
    }

    /* Check if the TTL value makes sense */
2984
    if (getLongLongFromObjectOrReply(c,c->argv[2],&ttl,NULL) != REDIS_OK) {
A
antirez 已提交
2985 2986 2987 2988 2989 2990
        return;
    } else if (ttl < 0) {
        addReplyError(c,"Invalid TTL value, must be >= 0");
        return;
    }

2991
    /* Verify RDB version and data checksum. */
2992 2993
    if (verifyDumpPayload(c->argv[3]->ptr,sdslen(c->argv[3]->ptr)) == REDIS_ERR)
    {
2994 2995 2996 2997
        addReplyError(c,"DUMP payload version or checksum are wrong");
        return;
    }

2998
    rioInitWithBuffer(&payload,c->argv[3]->ptr);
2999 3000
    if (((type = rdbLoadObjectType(&payload)) == -1) ||
        ((obj = rdbLoadObject(type,&payload)) == NULL))
3001
    {
3002
        addReplyError(c,"Bad data format");
A
antirez 已提交
3003 3004 3005
        return;
    }

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

A
antirez 已提交
3009
    /* Create the key and set the TTL if any */
3010
    dbAdd(c->db,c->argv[1],obj);
3011
    if (ttl) setExpire(c->db,c->argv[1],mstime()+ttl);
3012
    signalModifiedKey(c->db,c->argv[1]);
A
antirez 已提交
3013
    addReply(c,shared.ok);
3014
    server.dirty++;
A
antirez 已提交
3015 3016
}

A
antirez 已提交
3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076
/* 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;
    }
3077
    anetEnableTcpNoDelay(server.neterr,fd);
A
antirez 已提交
3078 3079

    /* Check if it connects within the specified timeout. */
3080
    if ((aeWait(fd,AE_WRITABLE,timeout) & AE_WRITABLE) == 0) {
A
antirez 已提交
3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130
        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 已提交
3131
/* MIGRATE host port key dbid timeout [COPY | REPLACE] */
A
antirez 已提交
3132
void migrateCommand(redisClient *c) {
A
antirez 已提交
3133
    int fd, copy, replace, j;
A
antirez 已提交
3134 3135
    long timeout;
    long dbid;
A
antirez 已提交
3136
    long long ttl, expireat;
A
antirez 已提交
3137
    robj *o;
3138
    rio cmd, payload;
A
antirez 已提交
3139 3140 3141 3142 3143 3144 3145
    int retry_num = 0;

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

A
antirez 已提交
3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158
    /* 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 已提交
3159 3160 3161 3162 3163
    /* Sanity check */
    if (getLongFromObjectOrReply(c,c->argv[5],&timeout,NULL) != REDIS_OK)
        return;
    if (getLongFromObjectOrReply(c,c->argv[4],&dbid,NULL) != REDIS_OK)
        return;
3164
    if (timeout <= 0) timeout = 1000;
A
antirez 已提交
3165 3166 3167 3168 3169

    /* 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) {
3170
        addReplySds(c,sdsnew("+NOKEY\r\n"));
A
antirez 已提交
3171 3172 3173 3174
        return;
    }
    
    /* Connect */
A
antirez 已提交
3175 3176
    fd = migrateGetSocket(c,c->argv[1],c->argv[2],timeout);
    if (fd == -1) return; /* error sent to the client by migrateGetSocket() */
A
antirez 已提交
3177

3178
    /* Create RESTORE payload and generate the protocol to call the command. */
3179
    rioInitWithBuffer(&cmd,sdsempty());
3180 3181 3182
    redisAssertWithInfo(c,NULL,rioWriteBulkCount(&cmd,'*',2));
    redisAssertWithInfo(c,NULL,rioWriteBulkString(&cmd,"SELECT",6));
    redisAssertWithInfo(c,NULL,rioWriteBulkLongLong(&cmd,dbid));
A
antirez 已提交
3183

A
antirez 已提交
3184 3185 3186 3187 3188
    expireat = getExpire(c->db,c->argv[3]);
    if (expireat != -1) {
        ttl = expireat-mstime();
        if (ttl < 1) ttl = 1;
    }
A
antirez 已提交
3189
    redisAssertWithInfo(c,NULL,rioWriteBulkCount(&cmd,'*',replace ? 5 : 4));
3190 3191 3192 3193 3194
    if (server.cluster_enabled)
        redisAssertWithInfo(c,NULL,
            rioWriteBulkString(&cmd,"RESTORE-ASKING",14));
    else
        redisAssertWithInfo(c,NULL,rioWriteBulkString(&cmd,"RESTORE",7));
3195
    redisAssertWithInfo(c,NULL,sdsEncodedObject(c->argv[3]));
3196
    redisAssertWithInfo(c,NULL,rioWriteBulkString(&cmd,c->argv[3]->ptr,sdslen(c->argv[3]->ptr)));
3197
    redisAssertWithInfo(c,NULL,rioWriteBulkLongLong(&cmd,ttl));
A
antirez 已提交
3198

G
guiquanz 已提交
3199
    /* Emit the payload argument, that is the serialized object using
A
antirez 已提交
3200
     * the DUMP format. */
3201 3202 3203
    createDumpPayload(&payload,o);
    redisAssertWithInfo(c,NULL,rioWriteBulkString(&cmd,payload.io.buffer.ptr,
                                sdslen(payload.io.buffer.ptr)));
3204 3205
    sdsfree(payload.io.buffer.ptr);

A
antirez 已提交
3206 3207 3208 3209 3210
    /* 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 已提交
3211
    /* Transfer the query to the other node in 64K chunks. */
A
antirez 已提交
3212
    errno = 0;
A
antirez 已提交
3213
    {
3214 3215 3216 3217 3218 3219
        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);
3220
            nwritten = syncWrite(fd,buf+pos,towrite,timeout);
3221 3222
            if (nwritten != (signed)towrite) goto socket_wr_err;
            pos += nwritten;
A
antirez 已提交
3223 3224 3225
        }
    }

3226
    /* Read back the reply. */
A
antirez 已提交
3227 3228 3229 3230 3231 3232 3233 3234
    {
        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)
3235
            goto socket_rd_err;
A
antirez 已提交
3236 3237 3238 3239
        if (buf1[0] == '-' || buf2[0] == '-') {
            addReplyErrorFormat(c,"Target instance replied with error: %s",
                (buf1[0] == '-') ? buf1+1 : buf2+1);
        } else {
3240 3241
            robj *aux;

A
antirez 已提交
3242 3243 3244 3245 3246
            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 已提交
3247
            addReply(c,shared.ok);
3248 3249 3250
            server.dirty++;

            /* Translate MIGRATE as DEL for replication/AOF. */
A
antirez 已提交
3251
            aux = createStringObject("DEL",3);
3252 3253
            rewriteClientCommandVector(c,2,aux,c->argv[3]);
            decrRefCount(aux);
A
antirez 已提交
3254 3255 3256
        }
    }

3257
    sdsfree(cmd.io.buffer.ptr);
3258
    return;
A
antirez 已提交
3259 3260

socket_wr_err:
3261
    sdsfree(cmd.io.buffer.ptr);
A
antirez 已提交
3262
    migrateCloseSocket(c->argv[1],c->argv[2]);
A
antirez 已提交
3263 3264 3265
    if (errno != ETIMEDOUT && retry_num++ == 0) goto try_again;
    addReplySds(c,
        sdsnew("-IOERR error or timeout writing to target instance\r\n"));
3266
    return;
A
antirez 已提交
3267 3268

socket_rd_err:
3269
    sdsfree(cmd.io.buffer.ptr);
A
antirez 已提交
3270
    migrateCloseSocket(c->argv[1],c->argv[2]);
A
antirez 已提交
3271 3272 3273
    if (errno != ETIMEDOUT && retry_num++ == 0) goto try_again;
    addReplySds(c,
        sdsnew("-IOERR error or timeout reading from target node\r\n"));
3274 3275 3276
    return;
}

3277 3278 3279 3280
/* -----------------------------------------------------------------------------
 * Cluster functions related to serving / redirecting clients
 * -------------------------------------------------------------------------- */

3281
/* The ASKING command is required after a -ASK redirection.
G
guiquanz 已提交
3282
 * The client should issue ASKING before to actually send the command to
3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293
 * 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);
}

3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310
/* 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 已提交
3311

3312 3313 3314
/* 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 已提交
3315
 *
3316 3317 3318 3319
 * 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.
 *
3320 3321
 * If the command contains multiple keys, and as a consequence it is not
 * possible to handle the request in Redis Cluster, NULL is returned. */
3322
clusterNode *getNodeByQuery(redisClient *c, struct redisCommand *cmd, robj **argv, int argc, int *hashslot, int *ask) {
A
antirez 已提交
3323
    clusterNode *n = NULL;
3324
    robj *firstkey = NULL;
A
antirez 已提交
3325 3326
    multiState *ms, _ms;
    multiCmd mc;
3327
    int i, slot = 0;
A
antirez 已提交
3328 3329 3330 3331 3332 3333

    /* 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. */
3334
        if (!(c->flags & REDIS_MULTI)) return server.cluster->myself;
A
antirez 已提交
3335 3336
        ms = &c->mstate;
    } else {
3337 3338 3339
        /* 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 已提交
3340 3341 3342 3343 3344 3345 3346 3347
        ms = &_ms;
        _ms.commands = &mc;
        _ms.count = 1;
        mc.argv = argv;
        mc.argc = argc;
        mc.cmd = cmd;
    }

3348 3349
    /* Check that all the keys are the same key, and get the slot and
     * node for this key. */
A
antirez 已提交
3350 3351 3352 3353 3354 3355 3356 3357 3358 3359
    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,
3360
                                      REDIS_GETKEYS_ALL);
A
antirez 已提交
3361
        for (j = 0; j < numkeys; j++) {
3362 3363 3364 3365 3366 3367
            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));
3368
                n = server.cluster->slots[slot];
3369
                redisAssertWithInfo(c,firstkey,n != NULL);
A
antirez 已提交
3370
            } else {
3371 3372 3373 3374 3375 3376
                /* 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 已提交
3377 3378 3379 3380
            }
        }
        getKeysFreeResult(keyindex);
    }
3381 3382 3383
    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. */
3384
    if (n == NULL) return server.cluster->myself;
3385 3386 3387 3388 3389
    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. */
3390 3391
    if (n == server.cluster->myself &&
        server.cluster->migrating_slots_to[slot] != NULL)
3392 3393 3394
    {
        if (lookupKeyRead(&server.db[0],firstkey) == NULL) {
            if (ask) *ask = 1;
3395
            return server.cluster->migrating_slots_to[slot];
3396 3397 3398 3399
        }
    }
    /* 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
3400 3401
     * it is assigned to a different node, but only if the client
     * issued an ASKING command before. */
3402
    if (server.cluster->importing_slots_from[slot] != NULL &&
3403
        (c->flags & REDIS_ASKING || cmd->flags & REDIS_CMD_ASKING)) {
3404
        return server.cluster->myself;
3405
    }
3406 3407 3408 3409 3410 3411 3412 3413 3414 3415
    /* Handle the read-only client case reading from a slave: if this
     * node is a slave and the request is about an hash slot our master
     * is serving, we can reply without redirection. */
    if (c->flags & REDIS_READONLY &&
        cmd->flags & REDIS_CMD_READONLY &&
        server.cluster->myself->flags & REDIS_NODE_SLAVE &&
        server.cluster->myself->slaveof == n)
    {
        return server.cluster->myself;
    }
3416 3417
    /* It's not a -ASK case. Base case: just return the right node. */
    return n;
A
antirez 已提交
3418
}