]>
git.saurik.com Git - redis.git/blob - src/cluster.c
7 void clusterAcceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
8 void clusterReadHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
9 void clusterSendPing(clusterLink
*link
, int type
);
10 void clusterSendFail(char *nodename
);
11 void clusterUpdateState(void);
12 int clusterNodeGetSlotBit(clusterNode
*n
, int slot
);
13 sds
clusterGenNodesDescription(void);
14 clusterNode
*clusterLookupNode(char *name
);
15 int clusterNodeAddSlave(clusterNode
*master
, clusterNode
*slave
);
16 int clusterAddSlot(clusterNode
*n
, int slot
);
18 /* -----------------------------------------------------------------------------
20 * -------------------------------------------------------------------------- */
22 void clusterGetRandomName(char *p
) {
23 FILE *fp
= fopen("/dev/urandom","r");
24 char *charset
= "0123456789abcdef";
28 redisLog(REDIS_WARNING
,
29 "Unrecovarable error: can't open /dev/urandom:%s" ,strerror(errno
));
32 fread(p
,REDIS_CLUSTER_NAMELEN
,1,fp
);
33 for (j
= 0; j
< REDIS_CLUSTER_NAMELEN
; j
++)
34 p
[j
] = charset
[p
[j
] & 0x0F];
38 int clusterLoadConfig(char *filename
) {
39 FILE *fp
= fopen(filename
,"r");
43 if (fp
== NULL
) return REDIS_ERR
;
45 /* Parse the file. Note that single liens of the cluster config file can
46 * be really long as they include all the hash slots of the node.
47 * This means in the worst possible case REDIS_CLUSTER_SLOTS/2 integers.
48 * To simplify we allocate 1024+REDIS_CLUSTER_SLOTS*16 bytes per line. */
49 maxline
= 1024+REDIS_CLUSTER_SLOTS
*16;
50 line
= zmalloc(maxline
);
51 while(fgets(line
,maxline
,fp
) != NULL
) {
53 sds
*argv
= sdssplitargs(line
,&argc
);
54 clusterNode
*n
, *master
;
57 /* Create this node if it does not exist */
58 n
= clusterLookupNode(argv
[0]);
60 n
= createClusterNode(argv
[0],0);
63 /* Address and port */
64 if ((p
= strchr(argv
[1],':')) == NULL
) goto fmterr
;
66 memcpy(n
->ip
,argv
[1],strlen(argv
[1])+1);
74 if (!strcasecmp(s
,"myself")) {
75 redisAssert(server
.cluster
.myself
== NULL
);
76 server
.cluster
.myself
= n
;
77 n
->flags
|= REDIS_NODE_MYSELF
;
78 } else if (!strcasecmp(s
,"master")) {
79 n
->flags
|= REDIS_NODE_MASTER
;
80 } else if (!strcasecmp(s
,"slave")) {
81 n
->flags
|= REDIS_NODE_SLAVE
;
82 } else if (!strcasecmp(s
,"fail?")) {
83 n
->flags
|= REDIS_NODE_PFAIL
;
84 } else if (!strcasecmp(s
,"fail")) {
85 n
->flags
|= REDIS_NODE_FAIL
;
86 } else if (!strcasecmp(s
,"handshake")) {
87 n
->flags
|= REDIS_NODE_HANDSHAKE
;
88 } else if (!strcasecmp(s
,"noaddr")) {
89 n
->flags
|= REDIS_NODE_NOADDR
;
90 } else if (!strcasecmp(s
,"noflags")) {
93 redisPanic("Unknown flag in redis cluster config file");
98 /* Get master if any. Set the master and populate master's
100 if (argv
[3][0] != '-') {
101 master
= clusterLookupNode(argv
[3]);
103 master
= createClusterNode(argv
[3],0);
104 clusterAddNode(master
);
107 clusterNodeAddSlave(master
,n
);
110 /* Set ping sent / pong received timestamps */
111 if (atoi(argv
[4])) n
->ping_sent
= time(NULL
);
112 if (atoi(argv
[5])) n
->pong_received
= time(NULL
);
114 /* Populate hash slots served by this instance. */
115 for (j
= 7; j
< argc
; j
++) {
118 if ((p
= strchr(argv
[j
],'-')) != NULL
) {
120 start
= atoi(argv
[j
]);
123 start
= stop
= atoi(argv
[j
]);
125 while(start
<= stop
) clusterAddSlot(n
, start
++);
128 sdssplitargs_free(argv
,argc
);
133 /* Config sanity check */
134 redisAssert(server
.cluster
.myself
!= NULL
);
135 redisLog(REDIS_NOTICE
,"Node configuration loaded, I'm %.40s",
136 server
.cluster
.myself
->name
);
137 clusterUpdateState();
141 redisLog(REDIS_WARNING
,"Unrecovarable error: corrupted cluster config file.");
146 /* Cluster node configuration is exactly the same as CLUSTER NODES output.
148 * This function writes the node config and returns 0, on error -1
150 int clusterSaveConfig(void) {
151 sds ci
= clusterGenNodesDescription();
154 if ((fd
= open(server
.cluster
.configfile
,O_WRONLY
|O_CREAT
|O_TRUNC
,0644))
156 if (write(fd
,ci
,sdslen(ci
)) != (ssize_t
)sdslen(ci
)) goto err
;
166 void clusterSaveConfigOrDie(void) {
167 if (clusterSaveConfig() == -1) {
168 redisLog(REDIS_WARNING
,"Fatal: can't update cluster config file.");
173 void clusterInit(void) {
176 server
.cluster
.myself
= NULL
;
177 server
.cluster
.state
= REDIS_CLUSTER_FAIL
;
178 server
.cluster
.nodes
= dictCreate(&clusterNodesDictType
,NULL
);
179 server
.cluster
.node_timeout
= 15;
180 memset(server
.cluster
.migrating_slots_to
,0,
181 sizeof(server
.cluster
.migrating_slots_to
));
182 memset(server
.cluster
.importing_slots_from
,0,
183 sizeof(server
.cluster
.importing_slots_from
));
184 memset(server
.cluster
.slots
,0,
185 sizeof(server
.cluster
.slots
));
186 if (clusterLoadConfig(server
.cluster
.configfile
) == REDIS_ERR
) {
187 /* No configuration found. We will just use the random name provided
188 * by the createClusterNode() function. */
189 server
.cluster
.myself
= createClusterNode(NULL
,REDIS_NODE_MYSELF
);
190 redisLog(REDIS_NOTICE
,"No cluster configuration found, I'm %.40s",
191 server
.cluster
.myself
->name
);
192 clusterAddNode(server
.cluster
.myself
);
195 if (saveconf
) clusterSaveConfigOrDie();
196 /* We need a listening TCP port for our cluster messaging needs */
197 server
.cfd
= anetTcpServer(server
.neterr
,
198 server
.port
+REDIS_CLUSTER_PORT_INCR
, server
.bindaddr
);
199 if (server
.cfd
== -1) {
200 redisLog(REDIS_WARNING
, "Opening cluster TCP port: %s", server
.neterr
);
203 if (aeCreateFileEvent(server
.el
, server
.cfd
, AE_READABLE
,
204 clusterAcceptHandler
, NULL
) == AE_ERR
) oom("creating file event");
205 server
.cluster
.slots_to_keys
= zslCreate();
208 /* -----------------------------------------------------------------------------
209 * CLUSTER communication link
210 * -------------------------------------------------------------------------- */
212 clusterLink
*createClusterLink(clusterNode
*node
) {
213 clusterLink
*link
= zmalloc(sizeof(*link
));
214 link
->sndbuf
= sdsempty();
215 link
->rcvbuf
= sdsempty();
221 /* Free a cluster link, but does not free the associated node of course.
222 * Just this function will make sure that the original node associated
223 * with this link will have the 'link' field set to NULL. */
224 void freeClusterLink(clusterLink
*link
) {
225 if (link
->fd
!= -1) {
226 aeDeleteFileEvent(server
.el
, link
->fd
, AE_WRITABLE
);
227 aeDeleteFileEvent(server
.el
, link
->fd
, AE_READABLE
);
229 sdsfree(link
->sndbuf
);
230 sdsfree(link
->rcvbuf
);
232 link
->node
->link
= NULL
;
237 void clusterAcceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
243 REDIS_NOTUSED(privdata
);
245 cfd
= anetTcpAccept(server
.neterr
, fd
, cip
, &cport
);
247 redisLog(REDIS_VERBOSE
,"Accepting cluster node: %s", server
.neterr
);
250 redisLog(REDIS_VERBOSE
,"Accepted cluster node %s:%d", cip
, cport
);
251 /* We need to create a temporary node in order to read the incoming
252 * packet in a valid contest. This node will be released once we
253 * read the packet and reply. */
254 link
= createClusterLink(NULL
);
256 aeCreateFileEvent(server
.el
,cfd
,AE_READABLE
,clusterReadHandler
,link
);
259 /* -----------------------------------------------------------------------------
261 * -------------------------------------------------------------------------- */
263 /* We have 4096 hash slots. The hash slot of a given key is obtained
264 * as the least significant 12 bits of the crc16 of the key. */
265 unsigned int keyHashSlot(char *key
, int keylen
) {
266 return crc16(key
,keylen
) & 0x0FFF;
269 /* -----------------------------------------------------------------------------
271 * -------------------------------------------------------------------------- */
273 /* Create a new cluster node, with the specified flags.
274 * If "nodename" is NULL this is considered a first handshake and a random
275 * node name is assigned to this node (it will be fixed later when we'll
276 * receive the first pong).
278 * The node is created and returned to the user, but it is not automatically
279 * added to the nodes hash table. */
280 clusterNode
*createClusterNode(char *nodename
, int flags
) {
281 clusterNode
*node
= zmalloc(sizeof(*node
));
284 memcpy(node
->name
, nodename
, REDIS_CLUSTER_NAMELEN
);
286 clusterGetRandomName(node
->name
);
288 memset(node
->slots
,0,sizeof(node
->slots
));
291 node
->slaveof
= NULL
;
292 node
->ping_sent
= node
->pong_received
= 0;
293 node
->configdigest
= NULL
;
294 node
->configdigest_ts
= 0;
299 int clusterNodeRemoveSlave(clusterNode
*master
, clusterNode
*slave
) {
302 for (j
= 0; j
< master
->numslaves
; j
++) {
303 if (master
->slaves
[j
] == slave
) {
304 memmove(master
->slaves
+j
,master
->slaves
+(j
+1),
305 (master
->numslaves
-1)-j
);
313 int clusterNodeAddSlave(clusterNode
*master
, clusterNode
*slave
) {
316 /* If it's already a slave, don't add it again. */
317 for (j
= 0; j
< master
->numslaves
; j
++)
318 if (master
->slaves
[j
] == slave
) return REDIS_ERR
;
319 master
->slaves
= zrealloc(master
->slaves
,
320 sizeof(clusterNode
*)*(master
->numslaves
+1));
321 master
->slaves
[master
->numslaves
] = slave
;
326 void clusterNodeResetSlaves(clusterNode
*n
) {
331 void freeClusterNode(clusterNode
*n
) {
334 nodename
= sdsnewlen(n
->name
, REDIS_CLUSTER_NAMELEN
);
335 redisAssert(dictDelete(server
.cluster
.nodes
,nodename
) == DICT_OK
);
337 if (n
->slaveof
) clusterNodeRemoveSlave(n
->slaveof
, n
);
338 if (n
->link
) freeClusterLink(n
->link
);
342 /* Add a node to the nodes hash table */
343 int clusterAddNode(clusterNode
*node
) {
346 retval
= dictAdd(server
.cluster
.nodes
,
347 sdsnewlen(node
->name
,REDIS_CLUSTER_NAMELEN
), node
);
348 return (retval
== DICT_OK
) ? REDIS_OK
: REDIS_ERR
;
351 /* Node lookup by name */
352 clusterNode
*clusterLookupNode(char *name
) {
353 sds s
= sdsnewlen(name
, REDIS_CLUSTER_NAMELEN
);
354 struct dictEntry
*de
;
356 de
= dictFind(server
.cluster
.nodes
,s
);
358 if (de
== NULL
) return NULL
;
359 return dictGetEntryVal(de
);
362 /* This is only used after the handshake. When we connect a given IP/PORT
363 * as a result of CLUSTER MEET we don't have the node name yet, so we
364 * pick a random one, and will fix it when we receive the PONG request using
366 void clusterRenameNode(clusterNode
*node
, char *newname
) {
368 sds s
= sdsnewlen(node
->name
, REDIS_CLUSTER_NAMELEN
);
370 redisLog(REDIS_DEBUG
,"Renaming node %.40s into %.40s",
371 node
->name
, newname
);
372 retval
= dictDelete(server
.cluster
.nodes
, s
);
374 redisAssert(retval
== DICT_OK
);
375 memcpy(node
->name
, newname
, REDIS_CLUSTER_NAMELEN
);
376 clusterAddNode(node
);
379 /* -----------------------------------------------------------------------------
380 * CLUSTER messages exchange - PING/PONG and gossip
381 * -------------------------------------------------------------------------- */
383 /* Process the gossip section of PING or PONG packets.
384 * Note that this function assumes that the packet is already sanity-checked
385 * by the caller, not in the content of the gossip section, but in the
387 void clusterProcessGossipSection(clusterMsg
*hdr
, clusterLink
*link
) {
388 uint16_t count
= ntohs(hdr
->count
);
389 clusterMsgDataGossip
*g
= (clusterMsgDataGossip
*) hdr
->data
.ping
.gossip
;
390 clusterNode
*sender
= link
->node
? link
->node
: clusterLookupNode(hdr
->sender
);
394 uint16_t flags
= ntohs(g
->flags
);
397 if (flags
== 0) ci
= sdscat(ci
,"noflags,");
398 if (flags
& REDIS_NODE_MYSELF
) ci
= sdscat(ci
,"myself,");
399 if (flags
& REDIS_NODE_MASTER
) ci
= sdscat(ci
,"master,");
400 if (flags
& REDIS_NODE_SLAVE
) ci
= sdscat(ci
,"slave,");
401 if (flags
& REDIS_NODE_PFAIL
) ci
= sdscat(ci
,"fail?,");
402 if (flags
& REDIS_NODE_FAIL
) ci
= sdscat(ci
,"fail,");
403 if (flags
& REDIS_NODE_HANDSHAKE
) ci
= sdscat(ci
,"handshake,");
404 if (flags
& REDIS_NODE_NOADDR
) ci
= sdscat(ci
,"noaddr,");
405 if (ci
[sdslen(ci
)-1] == ',') ci
[sdslen(ci
)-1] = ' ';
407 redisLog(REDIS_DEBUG
,"GOSSIP %.40s %s:%d %s",
414 /* Update our state accordingly to the gossip sections */
415 node
= clusterLookupNode(g
->nodename
);
417 /* We already know this node. Let's start updating the last
418 * time PONG figure if it is newer than our figure.
419 * Note that it's not a problem if we have a PING already
420 * in progress against this node. */
421 if (node
->pong_received
< ntohl(g
->pong_received
)) {
422 redisLog(REDIS_DEBUG
,"Node pong_received updated by gossip");
423 node
->pong_received
= ntohl(g
->pong_received
);
425 /* Mark this node as FAILED if we think it is possibly failing
426 * and another node also thinks it's failing. */
427 if (node
->flags
& REDIS_NODE_PFAIL
&&
428 (flags
& (REDIS_NODE_FAIL
|REDIS_NODE_PFAIL
)))
430 redisLog(REDIS_NOTICE
,"Received a PFAIL acknowledge from node %.40s, marking node %.40s as FAIL!", hdr
->sender
, node
->name
);
431 node
->flags
&= ~REDIS_NODE_PFAIL
;
432 node
->flags
|= REDIS_NODE_FAIL
;
433 /* Broadcast the failing node name to everybody */
434 clusterSendFail(node
->name
);
435 clusterUpdateState();
436 clusterSaveConfigOrDie();
439 /* If it's not in NOADDR state and we don't have it, we
440 * start an handshake process against this IP/PORT pairs.
442 * Note that we require that the sender of this gossip message
443 * is a well known node in our cluster, otherwise we risk
444 * joining another cluster. */
445 if (sender
&& !(flags
& REDIS_NODE_NOADDR
)) {
446 clusterNode
*newnode
;
448 redisLog(REDIS_DEBUG
,"Adding the new node");
449 newnode
= createClusterNode(NULL
,REDIS_NODE_HANDSHAKE
);
450 memcpy(newnode
->ip
,g
->ip
,sizeof(g
->ip
));
451 newnode
->port
= ntohs(g
->port
);
452 clusterAddNode(newnode
);
461 /* IP -> string conversion. 'buf' is supposed to at least be 16 bytes. */
462 void nodeIp2String(char *buf
, clusterLink
*link
) {
463 struct sockaddr_in sa
;
464 socklen_t salen
= sizeof(sa
);
466 if (getpeername(link
->fd
, (struct sockaddr
*) &sa
, &salen
) == -1)
467 redisPanic("getpeername() failed.");
468 strncpy(buf
,inet_ntoa(sa
.sin_addr
),sizeof(link
->node
->ip
));
472 /* Update the node address to the IP address that can be extracted
473 * from link->fd, and at the specified port. */
474 void nodeUpdateAddress(clusterNode
*node
, clusterLink
*link
, int port
) {
477 /* When this function is called, there is a packet to process starting
478 * at node->rcvbuf. Releasing the buffer is up to the caller, so this
479 * function should just handle the higher level stuff of processing the
480 * packet, modifying the cluster state if needed.
482 * The function returns 1 if the link is still valid after the packet
483 * was processed, otherwise 0 if the link was freed since the packet
484 * processing lead to some inconsistency error (for instance a PONG
485 * received from the wrong sender ID). */
486 int clusterProcessPacket(clusterLink
*link
) {
487 clusterMsg
*hdr
= (clusterMsg
*) link
->rcvbuf
;
488 uint32_t totlen
= ntohl(hdr
->totlen
);
489 uint16_t type
= ntohs(hdr
->type
);
492 redisLog(REDIS_DEBUG
,"--- packet to process %lu bytes (%lu) ---",
493 (unsigned long) totlen
, sdslen(link
->rcvbuf
));
494 if (totlen
< 8) return 1;
495 if (totlen
> sdslen(link
->rcvbuf
)) return 1;
496 if (type
== CLUSTERMSG_TYPE_PING
|| type
== CLUSTERMSG_TYPE_PONG
||
497 type
== CLUSTERMSG_TYPE_MEET
)
499 uint16_t count
= ntohs(hdr
->count
);
500 uint32_t explen
; /* expected length of this packet */
502 explen
= sizeof(clusterMsg
)-sizeof(union clusterMsgData
);
503 explen
+= (sizeof(clusterMsgDataGossip
)*count
);
504 if (totlen
!= explen
) return 1;
506 if (type
== CLUSTERMSG_TYPE_FAIL
) {
507 uint32_t explen
= sizeof(clusterMsg
)-sizeof(union clusterMsgData
);
509 explen
+= sizeof(clusterMsgDataFail
);
510 if (totlen
!= explen
) return 1;
513 sender
= clusterLookupNode(hdr
->sender
);
514 if (type
== CLUSTERMSG_TYPE_PING
|| type
== CLUSTERMSG_TYPE_MEET
) {
515 int update_config
= 0;
516 redisLog(REDIS_DEBUG
,"Ping packet received: %p", link
->node
);
518 /* Add this node if it is new for us and the msg type is MEET.
519 * In this stage we don't try to add the node with the right
520 * flags, slaveof pointer, and so forth, as this details will be
521 * resolved when we'll receive PONGs from the server. */
522 if (!sender
&& type
== CLUSTERMSG_TYPE_MEET
) {
525 node
= createClusterNode(NULL
,REDIS_NODE_HANDSHAKE
);
526 nodeIp2String(node
->ip
,link
);
527 node
->port
= ntohs(hdr
->port
);
528 clusterAddNode(node
);
532 /* Get info from the gossip section */
533 clusterProcessGossipSection(hdr
,link
);
535 /* Anyway reply with a PONG */
536 clusterSendPing(link
,CLUSTERMSG_TYPE_PONG
);
538 /* Update config if needed */
539 if (update_config
) clusterSaveConfigOrDie();
540 } else if (type
== CLUSTERMSG_TYPE_PONG
) {
541 int update_state
= 0;
542 int update_config
= 0;
544 redisLog(REDIS_DEBUG
,"Pong packet received: %p", link
->node
);
546 if (link
->node
->flags
& REDIS_NODE_HANDSHAKE
) {
547 /* If we already have this node, try to change the
548 * IP/port of the node with the new one. */
550 redisLog(REDIS_WARNING
,
551 "Handshake error: we already know node %.40s, updating the address if needed.", sender
->name
);
552 nodeUpdateAddress(sender
,link
,ntohs(hdr
->port
));
553 freeClusterNode(link
->node
); /* will free the link too */
557 /* First thing to do is replacing the random name with the
558 * right node name if this was an handshake stage. */
559 clusterRenameNode(link
->node
, hdr
->sender
);
560 redisLog(REDIS_DEBUG
,"Handshake with node %.40s completed.",
562 link
->node
->flags
&= ~REDIS_NODE_HANDSHAKE
;
564 } else if (memcmp(link
->node
->name
,hdr
->sender
,
565 REDIS_CLUSTER_NAMELEN
) != 0)
567 /* If the reply has a non matching node ID we
568 * disconnect this node and set it as not having an associated
570 redisLog(REDIS_DEBUG
,"PONG contains mismatching sender ID");
571 link
->node
->flags
|= REDIS_NODE_NOADDR
;
572 freeClusterLink(link
);
574 /* FIXME: remove this node if we already have it.
576 * If we already have it but the IP is different, use
577 * the new one if the old node is in FAIL, PFAIL, or NOADDR
582 /* Update our info about the node */
583 link
->node
->pong_received
= time(NULL
);
585 /* Update master/slave info */
587 if (!memcmp(hdr
->slaveof
,REDIS_NODE_NULL_NAME
,
588 sizeof(hdr
->slaveof
)))
590 sender
->flags
&= ~REDIS_NODE_SLAVE
;
591 sender
->flags
|= REDIS_NODE_MASTER
;
592 sender
->slaveof
= NULL
;
594 clusterNode
*master
= clusterLookupNode(hdr
->slaveof
);
596 sender
->flags
&= ~REDIS_NODE_MASTER
;
597 sender
->flags
|= REDIS_NODE_SLAVE
;
598 if (sender
->numslaves
) clusterNodeResetSlaves(sender
);
599 if (master
) clusterNodeAddSlave(master
,sender
);
603 /* Update our info about served slots if this new node is serving
604 * slots that are not served from our point of view. */
605 if (sender
&& sender
->flags
& REDIS_NODE_MASTER
) {
609 memcmp(sender
->slots
,hdr
->myslots
,sizeof(hdr
->myslots
)) != 0;
610 memcpy(sender
->slots
,hdr
->myslots
,sizeof(hdr
->myslots
));
612 for (j
= 0; j
< REDIS_CLUSTER_SLOTS
; j
++) {
613 if (clusterNodeGetSlotBit(sender
,j
)) {
614 if (server
.cluster
.slots
[j
] == sender
) continue;
615 if (server
.cluster
.slots
[j
] == NULL
||
616 server
.cluster
.slots
[j
]->flags
& REDIS_NODE_FAIL
)
618 server
.cluster
.slots
[j
] = sender
;
619 update_state
= update_config
= 1;
626 /* Get info from the gossip section */
627 clusterProcessGossipSection(hdr
,link
);
629 /* Update the cluster state if needed */
630 if (update_state
) clusterUpdateState();
631 if (update_config
) clusterSaveConfigOrDie();
632 } else if (type
== CLUSTERMSG_TYPE_FAIL
&& sender
) {
633 clusterNode
*failing
;
635 failing
= clusterLookupNode(hdr
->data
.fail
.about
.nodename
);
636 if (failing
&& !(failing
->flags
& (REDIS_NODE_FAIL
|REDIS_NODE_MYSELF
)))
638 redisLog(REDIS_NOTICE
,
639 "FAIL message received from %.40s about %.40s",
640 hdr
->sender
, hdr
->data
.fail
.about
.nodename
);
641 failing
->flags
|= REDIS_NODE_FAIL
;
642 failing
->flags
&= ~REDIS_NODE_PFAIL
;
643 clusterUpdateState();
644 clusterSaveConfigOrDie();
647 redisLog(REDIS_NOTICE
,"Received unknown packet type: %d", type
);
652 /* This function is called when we detect the link with this node is lost.
653 We set the node as no longer connected. The Cluster Cron will detect
654 this connection and will try to get it connected again.
656 Instead if the node is a temporary node used to accept a query, we
657 completely free the node on error. */
658 void handleLinkIOError(clusterLink
*link
) {
659 freeClusterLink(link
);
662 /* Send data. This is handled using a trivial send buffer that gets
663 * consumed by write(). We don't try to optimize this for speed too much
664 * as this is a very low traffic channel. */
665 void clusterWriteHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
666 clusterLink
*link
= (clusterLink
*) privdata
;
671 nwritten
= write(fd
, link
->sndbuf
, sdslen(link
->sndbuf
));
673 redisLog(REDIS_NOTICE
,"I/O error writing to node link: %s",
675 handleLinkIOError(link
);
678 link
->sndbuf
= sdsrange(link
->sndbuf
,nwritten
,-1);
679 if (sdslen(link
->sndbuf
) == 0)
680 aeDeleteFileEvent(server
.el
, link
->fd
, AE_WRITABLE
);
683 /* Read data. Try to read the first field of the header first to check the
684 * full length of the packet. When a whole packet is in memory this function
685 * will call the function to process the packet. And so forth. */
686 void clusterReadHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
690 clusterLink
*link
= (clusterLink
*) privdata
;
696 if (sdslen(link
->rcvbuf
) >= 4) {
697 hdr
= (clusterMsg
*) link
->rcvbuf
;
698 readlen
= ntohl(hdr
->totlen
) - sdslen(link
->rcvbuf
);
700 readlen
= 4 - sdslen(link
->rcvbuf
);
703 nread
= read(fd
,buf
,readlen
);
704 if (nread
== -1 && errno
== EAGAIN
) return; /* Just no data */
708 redisLog(REDIS_NOTICE
,"I/O error reading from node link: %s",
709 (nread
== 0) ? "connection closed" : strerror(errno
));
710 handleLinkIOError(link
);
713 /* Read data and recast the pointer to the new buffer. */
714 link
->rcvbuf
= sdscatlen(link
->rcvbuf
,buf
,nread
);
715 hdr
= (clusterMsg
*) link
->rcvbuf
;
718 /* Total length obtained? read the payload now instead of burning
719 * cycles waiting for a new event to fire. */
720 if (sdslen(link
->rcvbuf
) == 4) goto again
;
722 /* Whole packet in memory? We can process it. */
723 if (sdslen(link
->rcvbuf
) == ntohl(hdr
->totlen
)) {
724 if (clusterProcessPacket(link
)) {
725 sdsfree(link
->rcvbuf
);
726 link
->rcvbuf
= sdsempty();
731 /* Put stuff into the send buffer. */
732 void clusterSendMessage(clusterLink
*link
, unsigned char *msg
, size_t msglen
) {
733 if (sdslen(link
->sndbuf
) == 0 && msglen
!= 0)
734 aeCreateFileEvent(server
.el
,link
->fd
,AE_WRITABLE
,
735 clusterWriteHandler
,link
);
737 link
->sndbuf
= sdscatlen(link
->sndbuf
, msg
, msglen
);
740 /* Build the message header */
741 void clusterBuildMessageHdr(clusterMsg
*hdr
, int type
) {
744 memset(hdr
,0,sizeof(*hdr
));
745 hdr
->type
= htons(type
);
746 memcpy(hdr
->sender
,server
.cluster
.myself
->name
,REDIS_CLUSTER_NAMELEN
);
747 memcpy(hdr
->myslots
,server
.cluster
.myself
->slots
,
748 sizeof(hdr
->myslots
));
749 memset(hdr
->slaveof
,0,REDIS_CLUSTER_NAMELEN
);
750 if (server
.cluster
.myself
->slaveof
!= NULL
) {
751 memcpy(hdr
->slaveof
,server
.cluster
.myself
->slaveof
->name
,
752 REDIS_CLUSTER_NAMELEN
);
754 hdr
->port
= htons(server
.port
);
755 hdr
->state
= server
.cluster
.state
;
756 memset(hdr
->configdigest
,0,32); /* FIXME: set config digest */
758 if (type
== CLUSTERMSG_TYPE_FAIL
) {
759 totlen
= sizeof(clusterMsg
)-sizeof(union clusterMsgData
);
760 totlen
+= sizeof(clusterMsgDataFail
);
762 hdr
->totlen
= htonl(totlen
);
763 /* For PING, PONG, and MEET, fixing the totlen field is up to the caller */
766 /* Send a PING or PONG packet to the specified node, making sure to add enough
767 * gossip informations. */
768 void clusterSendPing(clusterLink
*link
, int type
) {
769 unsigned char buf
[1024];
770 clusterMsg
*hdr
= (clusterMsg
*) buf
;
771 int gossipcount
= 0, totlen
;
772 /* freshnodes is the number of nodes we can still use to populate the
773 * gossip section of the ping packet. Basically we start with the nodes
774 * we have in memory minus two (ourself and the node we are sending the
775 * message to). Every time we add a node we decrement the counter, so when
776 * it will drop to <= zero we know there is no more gossip info we can
778 int freshnodes
= dictSize(server
.cluster
.nodes
)-2;
780 if (link
->node
&& type
== CLUSTERMSG_TYPE_PING
)
781 link
->node
->ping_sent
= time(NULL
);
782 clusterBuildMessageHdr(hdr
,type
);
784 /* Populate the gossip fields */
785 while(freshnodes
> 0 && gossipcount
< 3) {
786 struct dictEntry
*de
= dictGetRandomKey(server
.cluster
.nodes
);
787 clusterNode
*this = dictGetEntryVal(de
);
788 clusterMsgDataGossip
*gossip
;
791 /* Not interesting to gossip about ourself.
792 * Nor to send gossip info about HANDSHAKE state nodes (zero info). */
793 if (this == server
.cluster
.myself
||
794 this->flags
& REDIS_NODE_HANDSHAKE
) {
795 freshnodes
--; /* otherwise we may loop forever. */
799 /* Check if we already added this node */
800 for (j
= 0; j
< gossipcount
; j
++) {
801 if (memcmp(hdr
->data
.ping
.gossip
[j
].nodename
,this->name
,
802 REDIS_CLUSTER_NAMELEN
) == 0) break;
804 if (j
!= gossipcount
) continue;
808 gossip
= &(hdr
->data
.ping
.gossip
[gossipcount
]);
809 memcpy(gossip
->nodename
,this->name
,REDIS_CLUSTER_NAMELEN
);
810 gossip
->ping_sent
= htonl(this->ping_sent
);
811 gossip
->pong_received
= htonl(this->pong_received
);
812 memcpy(gossip
->ip
,this->ip
,sizeof(this->ip
));
813 gossip
->port
= htons(this->port
);
814 gossip
->flags
= htons(this->flags
);
817 totlen
= sizeof(clusterMsg
)-sizeof(union clusterMsgData
);
818 totlen
+= (sizeof(clusterMsgDataGossip
)*gossipcount
);
819 hdr
->count
= htons(gossipcount
);
820 hdr
->totlen
= htonl(totlen
);
821 clusterSendMessage(link
,buf
,totlen
);
824 /* Send a message to all the nodes with a reliable link */
825 void clusterBroadcastMessage(void *buf
, size_t len
) {
829 di
= dictGetIterator(server
.cluster
.nodes
);
830 while((de
= dictNext(di
)) != NULL
) {
831 clusterNode
*node
= dictGetEntryVal(de
);
833 if (!node
->link
) continue;
834 if (node
->flags
& (REDIS_NODE_MYSELF
|REDIS_NODE_NOADDR
)) continue;
835 clusterSendMessage(node
->link
,buf
,len
);
837 dictReleaseIterator(di
);
840 /* Send a FAIL message to all the nodes we are able to contact.
841 * The FAIL message is sent when we detect that a node is failing
842 * (REDIS_NODE_PFAIL) and we also receive a gossip confirmation of this:
843 * we switch the node state to REDIS_NODE_FAIL and ask all the other
844 * nodes to do the same ASAP. */
845 void clusterSendFail(char *nodename
) {
846 unsigned char buf
[1024];
847 clusterMsg
*hdr
= (clusterMsg
*) buf
;
849 clusterBuildMessageHdr(hdr
,CLUSTERMSG_TYPE_FAIL
);
850 memcpy(hdr
->data
.fail
.about
.nodename
,nodename
,REDIS_CLUSTER_NAMELEN
);
851 clusterBroadcastMessage(buf
,ntohl(hdr
->totlen
));
854 /* -----------------------------------------------------------------------------
856 * -------------------------------------------------------------------------- */
858 /* This is executed 1 time every second */
859 void clusterCron(void) {
863 time_t min_ping_sent
= 0;
864 clusterNode
*min_ping_node
= NULL
;
866 /* Check if we have disconnected nodes and reestablish the connection. */
867 di
= dictGetIterator(server
.cluster
.nodes
);
868 while((de
= dictNext(di
)) != NULL
) {
869 clusterNode
*node
= dictGetEntryVal(de
);
871 if (node
->flags
& (REDIS_NODE_MYSELF
|REDIS_NODE_NOADDR
)) continue;
872 if (node
->link
== NULL
) {
876 fd
= anetTcpNonBlockConnect(server
.neterr
, node
->ip
,
877 node
->port
+REDIS_CLUSTER_PORT_INCR
);
878 if (fd
== -1) continue;
879 link
= createClusterLink(node
);
882 aeCreateFileEvent(server
.el
,link
->fd
,AE_READABLE
,clusterReadHandler
,link
);
883 /* If the node is flagged as MEET, we send a MEET message instead
884 * of a PING one, to force the receiver to add us in its node
886 clusterSendPing(link
, node
->flags
& REDIS_NODE_MEET
?
887 CLUSTERMSG_TYPE_MEET
: CLUSTERMSG_TYPE_PING
);
888 /* We can clear the flag after the first packet is sent.
889 * If we'll never receive a PONG, we'll never send new packets
890 * to this node. Instead after the PONG is received and we
891 * are no longer in meet/handshake status, we want to send
892 * normal PING packets. */
893 node
->flags
&= ~REDIS_NODE_MEET
;
895 redisLog(REDIS_NOTICE
,"Connecting with Node %.40s at %s:%d", node
->name
, node
->ip
, node
->port
+REDIS_CLUSTER_PORT_INCR
);
898 dictReleaseIterator(di
);
900 /* Ping some random node. Check a few random nodes and ping the one with
901 * the oldest ping_sent time */
902 for (j
= 0; j
< 5; j
++) {
903 de
= dictGetRandomKey(server
.cluster
.nodes
);
904 clusterNode
*this = dictGetEntryVal(de
);
906 if (this->link
== NULL
) continue;
907 if (this->flags
& (REDIS_NODE_MYSELF
|REDIS_NODE_HANDSHAKE
)) continue;
908 if (min_ping_node
== NULL
|| min_ping_sent
> this->ping_sent
) {
909 min_ping_node
= this;
910 min_ping_sent
= this->ping_sent
;
914 redisLog(REDIS_DEBUG
,"Pinging node %40s", min_ping_node
->name
);
915 clusterSendPing(min_ping_node
->link
, CLUSTERMSG_TYPE_PING
);
918 /* Iterate nodes to check if we need to flag something as failing */
919 di
= dictGetIterator(server
.cluster
.nodes
);
920 while((de
= dictNext(di
)) != NULL
) {
921 clusterNode
*node
= dictGetEntryVal(de
);
925 (REDIS_NODE_MYSELF
|REDIS_NODE_NOADDR
|REDIS_NODE_HANDSHAKE
))
927 /* Check only if we already sent a ping and did not received
929 if (node
->ping_sent
== 0 ||
930 node
->ping_sent
<= node
->pong_received
) continue;
932 delay
= time(NULL
) - node
->pong_received
;
933 if (delay
< server
.cluster
.node_timeout
) {
934 /* The PFAIL condition can be reversed without external
935 * help if it is not transitive (that is, if it does not
936 * turn into a FAIL state).
938 * The FAIL condition is also reversible if there are no slaves
939 * for this host, so no slave election should be in progress.
941 * TODO: consider all the implications of resurrecting a
943 if (node
->flags
& REDIS_NODE_PFAIL
) {
944 node
->flags
&= ~REDIS_NODE_PFAIL
;
945 } else if (node
->flags
& REDIS_NODE_FAIL
&& !node
->numslaves
) {
946 node
->flags
&= ~REDIS_NODE_FAIL
;
947 clusterUpdateState();
950 /* Timeout reached. Set the noad se possibly failing if it is
951 * not already in this state. */
952 if (!(node
->flags
& (REDIS_NODE_PFAIL
|REDIS_NODE_FAIL
))) {
953 redisLog(REDIS_DEBUG
,"*** NODE %.40s possibly failing",
955 node
->flags
|= REDIS_NODE_PFAIL
;
959 dictReleaseIterator(di
);
962 /* -----------------------------------------------------------------------------
964 * -------------------------------------------------------------------------- */
966 /* Set the slot bit and return the old value. */
967 int clusterNodeSetSlotBit(clusterNode
*n
, int slot
) {
970 int old
= (n
->slots
[byte
] & (1<<bit
)) != 0;
971 n
->slots
[byte
] |= 1<<bit
;
975 /* Clear the slot bit and return the old value. */
976 int clusterNodeClearSlotBit(clusterNode
*n
, int slot
) {
979 int old
= (n
->slots
[byte
] & (1<<bit
)) != 0;
980 n
->slots
[byte
] &= ~(1<<bit
);
984 /* Return the slot bit from the cluster node structure. */
985 int clusterNodeGetSlotBit(clusterNode
*n
, int slot
) {
988 return (n
->slots
[byte
] & (1<<bit
)) != 0;
991 /* Add the specified slot to the list of slots that node 'n' will
992 * serve. Return REDIS_OK if the operation ended with success.
993 * If the slot is already assigned to another instance this is considered
994 * an error and REDIS_ERR is returned. */
995 int clusterAddSlot(clusterNode
*n
, int slot
) {
996 redisAssert(clusterNodeSetSlotBit(n
,slot
) == 0);
997 server
.cluster
.slots
[slot
] = n
;
1001 /* -----------------------------------------------------------------------------
1002 * Cluster state evaluation function
1003 * -------------------------------------------------------------------------- */
1004 void clusterUpdateState(void) {
1008 for (j
= 0; j
< REDIS_CLUSTER_SLOTS
; j
++) {
1009 if (server
.cluster
.slots
[j
] == NULL
||
1010 server
.cluster
.slots
[j
]->flags
& (REDIS_NODE_FAIL
))
1017 if (server
.cluster
.state
== REDIS_CLUSTER_NEEDHELP
) {
1018 server
.cluster
.state
= REDIS_CLUSTER_NEEDHELP
;
1020 server
.cluster
.state
= REDIS_CLUSTER_OK
;
1023 server
.cluster
.state
= REDIS_CLUSTER_FAIL
;
1027 /* -----------------------------------------------------------------------------
1029 * -------------------------------------------------------------------------- */
1031 sds
clusterGenNodesDescription(void) {
1032 sds ci
= sdsempty();
1037 di
= dictGetIterator(server
.cluster
.nodes
);
1038 while((de
= dictNext(di
)) != NULL
) {
1039 clusterNode
*node
= dictGetEntryVal(de
);
1041 /* Node coordinates */
1042 ci
= sdscatprintf(ci
,"%.40s %s:%d ",
1048 if (node
->flags
== 0) ci
= sdscat(ci
,"noflags,");
1049 if (node
->flags
& REDIS_NODE_MYSELF
) ci
= sdscat(ci
,"myself,");
1050 if (node
->flags
& REDIS_NODE_MASTER
) ci
= sdscat(ci
,"master,");
1051 if (node
->flags
& REDIS_NODE_SLAVE
) ci
= sdscat(ci
,"slave,");
1052 if (node
->flags
& REDIS_NODE_PFAIL
) ci
= sdscat(ci
,"fail?,");
1053 if (node
->flags
& REDIS_NODE_FAIL
) ci
= sdscat(ci
,"fail,");
1054 if (node
->flags
& REDIS_NODE_HANDSHAKE
) ci
=sdscat(ci
,"handshake,");
1055 if (node
->flags
& REDIS_NODE_NOADDR
) ci
= sdscat(ci
,"noaddr,");
1056 if (ci
[sdslen(ci
)-1] == ',') ci
[sdslen(ci
)-1] = ' ';
1058 /* Slave of... or just "-" */
1060 ci
= sdscatprintf(ci
,"%.40s ",node
->slaveof
->name
);
1062 ci
= sdscatprintf(ci
,"- ");
1064 /* Latency from the POV of this node, link status */
1065 ci
= sdscatprintf(ci
,"%ld %ld %s",
1066 (long) node
->ping_sent
,
1067 (long) node
->pong_received
,
1068 node
->link
? "connected" : "disconnected");
1070 /* Slots served by this instance */
1072 for (j
= 0; j
< REDIS_CLUSTER_SLOTS
; j
++) {
1075 if ((bit
= clusterNodeGetSlotBit(node
,j
)) != 0) {
1076 if (start
== -1) start
= j
;
1078 if (start
!= -1 && (!bit
|| j
== REDIS_CLUSTER_SLOTS
-1)) {
1079 if (j
== REDIS_CLUSTER_SLOTS
-1) j
++;
1082 ci
= sdscatprintf(ci
," %d",start
);
1084 ci
= sdscatprintf(ci
," %d-%d",start
,j
-1);
1089 ci
= sdscatlen(ci
,"\n",1);
1091 dictReleaseIterator(di
);
1095 void clusterCommand(redisClient
*c
) {
1096 if (server
.cluster_enabled
== 0) {
1097 addReplyError(c
,"This instance has cluster support disabled");
1101 if (!strcasecmp(c
->argv
[1]->ptr
,"meet") && c
->argc
== 4) {
1103 struct sockaddr_in sa
;
1106 /* Perform sanity checks on IP/port */
1107 if (inet_aton(c
->argv
[2]->ptr
,&sa
.sin_addr
) == 0) {
1108 addReplyError(c
,"Invalid IP address in MEET");
1111 if (getLongFromObjectOrReply(c
, c
->argv
[3], &port
, NULL
) != REDIS_OK
||
1112 port
< 0 || port
> (65535-REDIS_CLUSTER_PORT_INCR
))
1114 addReplyError(c
,"Invalid TCP port specified");
1118 /* Finally add the node to the cluster with a random name, this
1119 * will get fixed in the first handshake (ping/pong). */
1120 n
= createClusterNode(NULL
,REDIS_NODE_HANDSHAKE
|REDIS_NODE_MEET
);
1121 strncpy(n
->ip
,inet_ntoa(sa
.sin_addr
),sizeof(n
->ip
));
1124 addReply(c
,shared
.ok
);
1125 } else if (!strcasecmp(c
->argv
[1]->ptr
,"nodes") && c
->argc
== 2) {
1127 sds ci
= clusterGenNodesDescription();
1129 o
= createObject(REDIS_STRING
,ci
);
1132 } else if (!strcasecmp(c
->argv
[1]->ptr
,"addslots") && c
->argc
>= 3) {
1135 unsigned char *slots
= zmalloc(REDIS_CLUSTER_SLOTS
);
1137 memset(slots
,0,REDIS_CLUSTER_SLOTS
);
1138 /* Check that all the arguments are parsable and that all the
1139 * slots are not already busy. */
1140 for (j
= 2; j
< c
->argc
; j
++) {
1141 if (getLongLongFromObject(c
->argv
[j
],&slot
) != REDIS_OK
||
1142 slot
< 0 || slot
> REDIS_CLUSTER_SLOTS
)
1144 addReplyError(c
,"Invalid or out of range slot index");
1148 if (server
.cluster
.slots
[slot
]) {
1149 addReplyErrorFormat(c
,"Slot %lld is already busy", slot
);
1153 if (slots
[slot
]++ == 1) {
1154 addReplyErrorFormat(c
,"Slot %d specified multiple times",
1160 for (j
= 0; j
< REDIS_CLUSTER_SLOTS
; j
++) {
1162 int retval
= clusterAddSlot(server
.cluster
.myself
,j
);
1164 redisAssert(retval
== REDIS_OK
);
1168 clusterUpdateState();
1169 clusterSaveConfigOrDie();
1170 addReply(c
,shared
.ok
);
1171 } else if (!strcasecmp(c
->argv
[1]->ptr
,"setslot") && c
->argc
>= 4) {
1172 /* SETSLOT 10 MIGRATING <instance ID> */
1173 /* SETSLOT 10 IMPORTING <instance ID> */
1174 /* SETSLOT 10 STABLE */
1179 if (getLongLongFromObjectOrReply(c
,c
->argv
[2],&aux
,NULL
) != REDIS_OK
)
1181 if (aux
< 0 || aux
>= REDIS_CLUSTER_SLOTS
) {
1182 addReplyError(c
,"Slot out of range");
1185 slot
= (unsigned int) aux
;
1186 if (server
.cluster
.slots
[slot
] != server
.cluster
.myself
) {
1187 addReplyErrorFormat(c
,"I'm not the owner of hash slot %u",slot
);
1190 if (!strcasecmp(c
->argv
[3]->ptr
,"migrating") && c
->argc
== 5) {
1191 if ((n
= clusterLookupNode(c
->argv
[4]->ptr
)) == NULL
) {
1192 addReplyErrorFormat(c
,"I don't know about node %s",
1193 (char*)c
->argv
[4]->ptr
);
1196 server
.cluster
.migrating_slots_to
[slot
] = n
;
1197 } else if (!strcasecmp(c
->argv
[3]->ptr
,"importing") && c
->argc
== 5) {
1198 if ((n
= clusterLookupNode(c
->argv
[4]->ptr
)) == NULL
) {
1199 addReplyErrorFormat(c
,"I don't know about node %s",
1200 (char*)c
->argv
[3]->ptr
);
1203 server
.cluster
.importing_slots_from
[slot
] = n
;
1204 } else if (!strcasecmp(c
->argv
[3]->ptr
,"stable") && c
->argc
== 4) {
1205 server
.cluster
.importing_slots_from
[slot
] = NULL
;
1207 addReplyError(c
,"Invalid CLUSTER SETSLOT action or number of arguments");
1209 } else if (!strcasecmp(c
->argv
[1]->ptr
,"info") && c
->argc
== 2) {
1210 char *statestr
[] = {"ok","fail","needhelp"};
1211 int slots_assigned
= 0, slots_ok
= 0, slots_pfail
= 0, slots_fail
= 0;
1214 for (j
= 0; j
< REDIS_CLUSTER_SLOTS
; j
++) {
1215 clusterNode
*n
= server
.cluster
.slots
[j
];
1217 if (n
== NULL
) continue;
1219 if (n
->flags
& REDIS_NODE_FAIL
) {
1221 } else if (n
->flags
& REDIS_NODE_PFAIL
) {
1228 sds info
= sdscatprintf(sdsempty(),
1229 "cluster_state:%s\r\n"
1230 "cluster_slots_assigned:%d\r\n"
1231 "cluster_slots_ok:%d\r\n"
1232 "cluster_slots_pfail:%d\r\n"
1233 "cluster_slots_fail:%d\r\n"
1234 "cluster_known_nodes:%lu\r\n"
1235 , statestr
[server
.cluster
.state
],
1240 dictSize(server
.cluster
.nodes
)
1242 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
1243 (unsigned long)sdslen(info
)));
1244 addReplySds(c
,info
);
1245 addReply(c
,shared
.crlf
);
1246 } else if (!strcasecmp(c
->argv
[1]->ptr
,"keyslot") && c
->argc
== 3) {
1247 sds key
= c
->argv
[2]->ptr
;
1249 addReplyLongLong(c
,keyHashSlot(key
,sdslen(key
)));
1250 } else if (!strcasecmp(c
->argv
[1]->ptr
,"getkeysinslot") && c
->argc
== 4) {
1251 long long maxkeys
, slot
;
1252 unsigned int numkeys
, j
;
1255 if (getLongLongFromObjectOrReply(c
,c
->argv
[2],&slot
,NULL
) != REDIS_OK
)
1257 if (getLongLongFromObjectOrReply(c
,c
->argv
[3],&maxkeys
,NULL
) != REDIS_OK
)
1259 if (slot
< 0 || slot
>= REDIS_CLUSTER_SLOTS
|| maxkeys
< 0 ||
1260 maxkeys
> 1024*1024) {
1261 addReplyError(c
,"Invalid slot or number of keys");
1265 keys
= zmalloc(sizeof(robj
*)*maxkeys
);
1266 numkeys
= GetKeysInSlot(slot
, keys
, maxkeys
);
1267 addReplyMultiBulkLen(c
,numkeys
);
1268 for (j
= 0; j
< numkeys
; j
++) addReplyBulk(c
,keys
[j
]);
1271 addReplyError(c
,"Wrong CLUSTER subcommand or number of arguments");
1275 /* -----------------------------------------------------------------------------
1276 * RESTORE and MIGRATE commands
1277 * -------------------------------------------------------------------------- */
1279 /* RESTORE key ttl serialized-value */
1280 void restoreCommand(redisClient
*c
) {
1284 unsigned char *data
;
1287 /* Make sure this key does not already exist here... */
1288 if (dbExists(c
->db
,c
->argv
[1])) {
1289 addReplyError(c
,"Target key name is busy.");
1293 /* Check if the TTL value makes sense */
1294 if (getLongFromObjectOrReply(c
,c
->argv
[2],&ttl
,NULL
) != REDIS_OK
) {
1296 } else if (ttl
< 0) {
1297 addReplyError(c
,"Invalid TTL value, must be >= 0");
1301 /* rdbLoadObject() only works against file descriptors so we need to
1302 * dump the serialized object into a file and reload. */
1303 snprintf(buf
,sizeof(buf
),"redis-restore-%d.tmp",getpid());
1304 fp
= fopen(buf
,"w+");
1306 redisLog(REDIS_WARNING
,"Can't open tmp file for RESTORE: %s",
1308 addReplyErrorFormat(c
,"RESTORE failed, tmp file creation error: %s",
1314 /* Write the actual data and rewind the file */
1315 data
= (unsigned char*) c
->argv
[3]->ptr
;
1316 if (fwrite(data
+1,sdslen((sds
)data
)-1,1,fp
) != 1) {
1317 redisLog(REDIS_WARNING
,"Can't write against tmp file for RESTORE: %s",
1319 addReplyError(c
,"RESTORE failed, tmp file I/O error.");
1325 /* Finally create the object from the serialized dump and
1326 * store it at the specified key. */
1327 if ((data
[0] > 4 && data
[0] < 9) ||
1329 (o
= rdbLoadObject(data
[0],fp
)) == NULL
)
1331 addReplyError(c
,"Bad data format.");
1337 /* Create the key and set the TTL if any */
1338 dbAdd(c
->db
,c
->argv
[1],o
);
1339 if (ttl
) setExpire(c
->db
,c
->argv
[1],time(NULL
)+ttl
);
1340 addReply(c
,shared
.ok
);
1343 /* MIGRATE host port key dbid timeout */
1344 void migrateCommand(redisClient
*c
) {
1356 if (getLongFromObjectOrReply(c
,c
->argv
[5],&timeout
,NULL
) != REDIS_OK
)
1358 if (getLongFromObjectOrReply(c
,c
->argv
[4],&dbid
,NULL
) != REDIS_OK
)
1360 if (timeout
<= 0) timeout
= 1;
1362 /* Check if the key is here. If not we reply with success as there is
1363 * nothing to migrate (for instance the key expired in the meantime), but
1364 * we include such information in the reply string. */
1365 if ((o
= lookupKeyRead(c
->db
,c
->argv
[3])) == NULL
) {
1366 addReplySds(c
,sdsnew("+NOKEY"));
1371 fd
= anetTcpNonBlockConnect(server
.neterr
,c
->argv
[1]->ptr
,
1372 atoi(c
->argv
[2]->ptr
));
1374 addReplyErrorFormat(c
,"Can't connect to target node: %s",
1378 if ((aeWait(fd
,AE_WRITABLE
,timeout
*1000) & AE_WRITABLE
) == 0) {
1379 addReplyError(c
,"Timeout connecting to the client");
1383 /* Create temp file */
1384 snprintf(buf
,sizeof(buf
),"redis-migrate-%d.tmp",getpid());
1385 fp
= fopen(buf
,"w+");
1387 redisLog(REDIS_WARNING
,"Can't open tmp file for MIGRATE: %s",
1389 addReplyErrorFormat(c
,"MIGRATE failed, tmp file creation error: %s.",
1395 /* Build the SELECT + RESTORE query writing it in our temp file. */
1396 if (fwriteBulkCount(fp
,'*',2) == 0) goto file_wr_err
;
1397 if (fwriteBulkString(fp
,"SELECT",6) == 0) goto file_wr_err
;
1398 if (fwriteBulkLongLong(fp
,dbid
) == 0) goto file_wr_err
;
1400 ttl
= getExpire(c
->db
,c
->argv
[3]);
1402 if (fwriteBulkCount(fp
,'*',4) == 0) goto file_wr_err
;
1403 if (fwriteBulkString(fp
,"RESTORE",7) == 0) goto file_wr_err
;
1404 if (fwriteBulkObject(fp
,c
->argv
[3]) == 0) goto file_wr_err
;
1405 if (fwriteBulkLongLong(fp
, (ttl
== -1) ? 0 : ttl
) == 0) goto file_wr_err
;
1407 /* Finally the last argument that is the serailized object payload
1408 * in the form: <type><rdb-serailized-object>. */
1409 payload_len
= rdbSavedObjectLen(o
);
1410 if (fwriteBulkCount(fp
,'$',payload_len
+1) == 0) goto file_wr_err
;
1411 if (fwrite(&type
,1,1,fp
) == 0) goto file_wr_err
;
1412 if (rdbSaveObject(fp
,o
) == -1) goto file_wr_err
;
1413 if (fwrite("\r\n",2,1,fp
) == 0) goto file_wr_err
;
1415 /* Tranfer the query to the other node */
1421 while ((nread
= fread(buf
,1,sizeof(buf
),fp
)) != 0) {
1424 nwritten
= syncWrite(fd
,buf
,nread
,timeout
);
1425 if (nwritten
!= (signed)nread
) goto socket_wr_err
;
1427 if (ferror(fp
)) goto file_rd_err
;
1430 /* Read back the reply */
1435 /* Read the two replies */
1436 if (syncReadLine(fd
, buf1
, sizeof(buf1
), timeout
) <= 0)
1438 if (syncReadLine(fd
, buf2
, sizeof(buf2
), timeout
) <= 0)
1440 if (buf1
[0] == '-' || buf2
[0] == '-') {
1441 addReplyErrorFormat(c
,"Target instance replied with error: %s",
1442 (buf1
[0] == '-') ? buf1
+1 : buf2
+1);
1444 dbDelete(c
->db
,c
->argv
[3]);
1445 addReply(c
,shared
.ok
);
1453 redisLog(REDIS_WARNING
,"Can't write on tmp file for MIGRATE: %s",
1455 addReplyErrorFormat(c
,"MIGRATE failed, tmp file write error: %s.",
1462 redisLog(REDIS_WARNING
,"Can't read from tmp file for MIGRATE: %s",
1464 addReplyErrorFormat(c
,"MIGRATE failed, tmp file read error: %s.",
1471 redisLog(REDIS_NOTICE
,"Can't write to target node for MIGRATE: %s",
1473 addReplyErrorFormat(c
,"MIGRATE failed, writing to target node: %s.",
1480 redisLog(REDIS_NOTICE
,"Can't read from target node for MIGRATE: %s",
1482 addReplyErrorFormat(c
,"MIGRATE failed, reading from target node: %s.",
1490 * DUMP is actually not used by Redis Cluster but it is the obvious
1491 * complement of RESTORE and can be useful for different applications. */
1492 void dumpCommand(redisClient
*c
) {
1500 /* Check if the key is here. */
1501 if ((o
= lookupKeyRead(c
->db
,c
->argv
[1])) == NULL
) {
1502 addReply(c
,shared
.nullbulk
);
1506 /* Create temp file */
1507 snprintf(buf
,sizeof(buf
),"redis-dump-%d.tmp",getpid());
1508 fp
= fopen(buf
,"w+");
1510 redisLog(REDIS_WARNING
,"Can't open tmp file for MIGRATE: %s",
1512 addReplyErrorFormat(c
,"DUMP failed, tmp file creation error: %s.",
1518 /* Dump the serailized object and read it back in memory.
1519 * We prefix it with a one byte containing the type ID.
1520 * This is the serialization format understood by RESTORE. */
1521 if (rdbSaveObject(fp
,o
) == -1) goto file_wr_err
;
1522 payload_len
= ftello(fp
);
1523 if (fseeko(fp
,0,SEEK_SET
) == -1) goto file_rd_err
;
1524 dump
= sdsnewlen(NULL
,payload_len
+1);
1525 if (payload_len
&& fread(dump
+1,payload_len
,1,fp
) != 1) goto file_rd_err
;
1528 if (type
== REDIS_LIST
&& o
->encoding
== REDIS_ENCODING_ZIPLIST
)
1529 type
= REDIS_LIST_ZIPLIST
;
1530 else if (type
== REDIS_HASH
&& o
->encoding
== REDIS_ENCODING_ZIPMAP
)
1531 type
= REDIS_HASH_ZIPMAP
;
1532 else if (type
== REDIS_SET
&& o
->encoding
== REDIS_ENCODING_INTSET
)
1533 type
= REDIS_SET_INTSET
;
1538 /* Transfer to the client */
1539 dumpobj
= createObject(REDIS_STRING
,dump
);
1540 addReplyBulk(c
,dumpobj
);
1541 decrRefCount(dumpobj
);
1545 redisLog(REDIS_WARNING
,"Can't write on tmp file for DUMP: %s",
1547 addReplyErrorFormat(c
,"DUMP failed, tmp file write error: %s.",
1554 redisLog(REDIS_WARNING
,"Can't read from tmp file for DUMP: %s",
1556 addReplyErrorFormat(c
,"DUMP failed, tmp file read error: %s.",
1563 /* -----------------------------------------------------------------------------
1564 * Cluster functions related to serving / redirecting clients
1565 * -------------------------------------------------------------------------- */
1567 /* Return the pointer to the cluster node that is able to serve the query
1568 * as all the keys belong to hash slots for which the node is in charge.
1570 * If keys in query spawn multiple nodes NULL is returned. */
1571 clusterNode
*getNodeByQuery(redisClient
*c
, struct redisCommand
*cmd
, robj
**argv
, int argc
, int *hashslot
) {
1572 clusterNode
*n
= NULL
;
1573 multiState
*ms
, _ms
;
1577 /* We handle all the cases as if they were EXEC commands, so we have
1578 * a common code path for everything */
1579 if (cmd
->proc
== execCommand
) {
1580 /* If REDIS_MULTI flag is not set EXEC is just going to return an
1582 if (!(c
->flags
& REDIS_MULTI
)) return server
.cluster
.myself
;
1585 /* Create a fake Multi State structure, with just one command */
1594 for (i
= 0; i
< ms
->count
; i
++) {
1595 struct redisCommand
*mcmd
;
1597 int margc
, *keyindex
, numkeys
, j
;
1599 mcmd
= ms
->commands
[i
].cmd
;
1600 margc
= ms
->commands
[i
].argc
;
1601 margv
= ms
->commands
[i
].argv
;
1603 keyindex
= getKeysFromCommand(mcmd
,margv
,margc
,&numkeys
,
1604 REDIS_GETKEYS_PRELOAD
);
1605 for (j
= 0; j
< numkeys
; j
++) {
1606 int slot
= keyHashSlot((char*)margv
[keyindex
[j
]]->ptr
,
1607 sdslen(margv
[keyindex
[j
]]->ptr
));
1608 struct clusterNode
*slotnode
;
1610 slotnode
= server
.cluster
.slots
[slot
];
1611 if (hashslot
) *hashslot
= slot
;
1612 /* Node not assigned? (Should never happen actually
1613 * if we reached this function).
1614 * Different node than the previous one?
1615 * Return NULL, the cluster can't serve multi-node requests */
1616 if (slotnode
== NULL
|| (n
&& slotnode
!= n
)) {
1617 getKeysFreeResult(keyindex
);
1623 getKeysFreeResult(keyindex
);
1625 return (n
== NULL
) ? server
.cluster
.myself
: n
;