Initial commit of RedisCluster class and library

This is an initial commmit which adds a RedisCluster class as well
as the framework around which we'll be building proper cluster
support.

The first commit just contains the code to set up and use our new
RedisCluster class as well as parsing logic to handline CLUSTER NODES
such that we can map the keyspace.

Next up, command processing and then pipelining in a sane way.

Author: michael-grunder

cluster_library.c

@@ -0,0 +1,97 @@
+#ifndef _PHPREDIS_CLUSTER_LIBRARY_H
+#define _PHPREDIS_CLUSTER_LIBRARY_H
+
+#include "common.h"
+
+#ifdef ZTS
+#include "TSRM.h"
+#endif
+
+/* Redis cluster hash slots and N-1 which we'll use to find it */
+#define REDIS_CLUSTER_SLOTS 16384
+#define REDIS_CLUSTER_MOD   (REDIS_CLUSTER_SLOTS-1)
+
+/* Nodes we expect for slave or master */
+#define CLUSTER_NODES_MASTER_ELE 9
+#define CLUSTER_NODES_SLAVE_ELE 8
+
+/* Length of a cluster name */
+#define CLUSTER_NAME_LEN 40
+
+/* The parts for our cluster nodes command */
+#define CLUSTER_NODES_HASH        0
+#define CLUSTER_NODES_HOST_PORT   1
+#define CLUSTER_NODES_TYPE        2
+#define CLUSTER_NODES_MASTER_HASH 3
+#define CLUSTER_NODES_PING        4
+#define CLUSTER_NODES_PONG        5
+#define CLUSTER_NODES_EPOCH       6
+#define CLUSTER_NODES_CONNECTED   7
+#define CLUSTER_SLOTS             8
+
+/* Specific destructor to free a cluster object */
+// void redis_destructor_redis_cluster(zend_rsrc_list_entry *rsrc TSRMLS_DC);
+
+/* Bits related to CLUSTER NODES output */
+typedef struct clusterNodeInfo {
+    char *name, *master_name;
+
+    short seed;
+
+    char *host;
+    int host_len;
+
+    unsigned short port;
+
+    unsigned short start_slot;
+    unsigned short end_slot;
+} clusterNodeInfo;
+
+/* A Redis Cluster master node */
+typedef struct redisClusterNode {
+    /* Our cluster ID and master ID */
+    char            *name;
+    char            *master_name;
+
+    /* Our Redis socket in question */
+    RedisSock *sock;
+
+    /* Our start and end slots that we serve */
+    unsigned short start_slot;
+    unsigned short end_slot;    
+
+    /* A HashTable containing any slaves */
+    HashTable *slaves;
+} redisClusterNode;
+
+/* RedisCluster implementation structure */
+typedef struct redisCluster {
+    /* Object reference for Zend */
+    zend_object std;
+
+    /* Timeout and read timeout */
+    double timeout;
+    double read_timeout;
+
+    /* Hash table of seed host/ports */
+    HashTable *seeds;
+
+    /* RedisCluster masters, by direct slot */
+    redisClusterNode *master[REDIS_CLUSTER_SLOTS];
+
+    /* All RedisCluster objects we've created/are connected to */
+    HashTable *nodes;
+} redisCluster;
+
+/* Hash a key to it's slot, using the Redis Cluster hash algorithm */
+unsigned short cluster_hash_key(const char *key, int len);
+
+PHPAPI int cluster_init_seeds(redisCluster *cluster, HashTable *ht_seeds);
+PHPAPI int cluster_map_keyspace(redisCluster *cluster TSRMLS_DC);
+PHPAPI void cluster_free_node(redisClusterNode *node);
+
+PHPAPI char **cluster_sock_read_multibulk_reply(RedisSock *redis_sock, int *len TSRMLS_DC);
+
+PHPAPI int cluster_node_add_slave(redisCluster *cluster, redisClusterNode *master, clusterNodeInfo *slave TSRMLS_DC);
+
+#endif

cluster_library.h

@@ -53,6 +53,13 @@ typedef enum _PUBSUB_TYPE {
     PUBSUB_NUMPAT
 } PUBSUB_TYPE;
 
+/* Cluster redirection type */
+typedef enum _MOVED_TYPE {
+    MOVED_NONE,
+    MOVED_MOVED,
+    MOVED_ASK
+} MOVED_TYPE;
+
 /* options */
 #define REDIS_OPT_SERIALIZER		1
 #define REDIS_OPT_PREFIX		    2
@@ -177,6 +184,13 @@ else if(redis_sock->mode == MULTI) { \
 
 #define REDIS_PROCESS_RESPONSE(function) REDIS_PROCESS_RESPONSE_CLOSURE(function, NULL)
 
+/* Clear redirection info */
+#define REDIS_MOVED_CLEAR(redis_sock) \
+    redis_sock->redir_slot = 0; \
+    redis_sock->redir_port = 0; \
+    redis_sock->redir_type = MOVED_NONE; \
+    
+
 /* Extended SET argument detection */
 #define IS_EX_ARG(a) ((a[0]=='e' || a[0]=='E') && (a[1]=='x' || a[1]=='X') && a[2]=='\0')
 #define IS_PX_ARG(a) ((a[0]=='p' || a[0]=='P') && (a[1]=='x' || a[1]=='X') && a[2]=='\0')
@@ -239,6 +253,12 @@ typedef struct {
     zend_bool      lazy_connect;
 
     int            scan;
+
+    /* Cluster node redirection */
+    MOVED_TYPE     redir_type;
+    char           *redir_host;
+    unsigned short redir_port;
+    unsigned short redir_slot;
 } RedisSock;
 /* }}} */
 

common.h

@@ -99,5 +99,5 @@ dnl Check for igbinary
   dnl
   dnl PHP_SUBST(REDIS_SHARED_LIBADD)
 
-  PHP_NEW_EXTENSION(redis, redis.c library.c redis_session.c redis_array.c redis_array_impl.c, $ext_shared)
+  PHP_NEW_EXTENSION(redis, redis.c library.c redis_session.c redis_array.c redis_array_impl.c redis_cluster.c cluster_library.c, $ext_shared)
 fi

config.m4

@@ -0,0 +1,87 @@
+/*
+ * Copyright 2001-2010 Georges Menie (www.menie.org)
+ * Copyright 2010 Salvatore Sanfilippo (adapted to Redis coding style)
+ * 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 the University of California, Berkeley 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 REGENTS 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 REGENTS AND 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.
+ */
+
+/* CRC16 implementation according to CCITT standards.
+ *
+ * Note by @antirez: this is actually the XMODEM CRC 16 algorithm, using the
+ * following parameters:
+ *
+ * Name                       : "XMODEM", also known as "ZMODEM", "CRC-16/ACORN"
+ * Width                      : 16 bit
+ * Poly                       : 1021 (That is actually x^16 + x^12 + x^5 + 1)
+ * Initialization             : 0000
+ * Reflect Input byte         : False
+ * Reflect Output CRC         : False
+ * Xor constant to output CRC : 0000
+ * Output for "123456789"     : 31C3
+ */
+
+#include <stdint.h>
+
+static const uint16_t crc16tab[256]= {
+    0x0000,0x1021,0x2042,0x3063,0x4084,0x50a5,0x60c6,0x70e7,
+    0x8108,0x9129,0xa14a,0xb16b,0xc18c,0xd1ad,0xe1ce,0xf1ef,
+    0x1231,0x0210,0x3273,0x2252,0x52b5,0x4294,0x72f7,0x62d6,
+    0x9339,0x8318,0xb37b,0xa35a,0xd3bd,0xc39c,0xf3ff,0xe3de,
+    0x2462,0x3443,0x0420,0x1401,0x64e6,0x74c7,0x44a4,0x5485,
+    0xa56a,0xb54b,0x8528,0x9509,0xe5ee,0xf5cf,0xc5ac,0xd58d,
+    0x3653,0x2672,0x1611,0x0630,0x76d7,0x66f6,0x5695,0x46b4,
+    0xb75b,0xa77a,0x9719,0x8738,0xf7df,0xe7fe,0xd79d,0xc7bc,
+    0x48c4,0x58e5,0x6886,0x78a7,0x0840,0x1861,0x2802,0x3823,
+    0xc9cc,0xd9ed,0xe98e,0xf9af,0x8948,0x9969,0xa90a,0xb92b,
+    0x5af5,0x4ad4,0x7ab7,0x6a96,0x1a71,0x0a50,0x3a33,0x2a12,
+    0xdbfd,0xcbdc,0xfbbf,0xeb9e,0x9b79,0x8b58,0xbb3b,0xab1a,
+    0x6ca6,0x7c87,0x4ce4,0x5cc5,0x2c22,0x3c03,0x0c60,0x1c41,
+    0xedae,0xfd8f,0xcdec,0xddcd,0xad2a,0xbd0b,0x8d68,0x9d49,
+    0x7e97,0x6eb6,0x5ed5,0x4ef4,0x3e13,0x2e32,0x1e51,0x0e70,
+    0xff9f,0xefbe,0xdfdd,0xcffc,0xbf1b,0xaf3a,0x9f59,0x8f78,
+    0x9188,0x81a9,0xb1ca,0xa1eb,0xd10c,0xc12d,0xf14e,0xe16f,
+    0x1080,0x00a1,0x30c2,0x20e3,0x5004,0x4025,0x7046,0x6067,
+    0x83b9,0x9398,0xa3fb,0xb3da,0xc33d,0xd31c,0xe37f,0xf35e,
+    0x02b1,0x1290,0x22f3,0x32d2,0x4235,0x5214,0x6277,0x7256,
+    0xb5ea,0xa5cb,0x95a8,0x8589,0xf56e,0xe54f,0xd52c,0xc50d,
+    0x34e2,0x24c3,0x14a0,0x0481,0x7466,0x6447,0x5424,0x4405,
+    0xa7db,0xb7fa,0x8799,0x97b8,0xe75f,0xf77e,0xc71d,0xd73c,
+    0x26d3,0x36f2,0x0691,0x16b0,0x6657,0x7676,0x4615,0x5634,
+    0xd94c,0xc96d,0xf90e,0xe92f,0x99c8,0x89e9,0xb98a,0xa9ab,
+    0x5844,0x4865,0x7806,0x6827,0x18c0,0x08e1,0x3882,0x28a3,
+    0xcb7d,0xdb5c,0xeb3f,0xfb1e,0x8bf9,0x9bd8,0xabbb,0xbb9a,
+    0x4a75,0x5a54,0x6a37,0x7a16,0x0af1,0x1ad0,0x2ab3,0x3a92,
+    0xfd2e,0xed0f,0xdd6c,0xcd4d,0xbdaa,0xad8b,0x9de8,0x8dc9,
+    0x7c26,0x6c07,0x5c64,0x4c45,0x3ca2,0x2c83,0x1ce0,0x0cc1,
+    0xef1f,0xff3e,0xcf5d,0xdf7c,0xaf9b,0xbfba,0x8fd9,0x9ff8,
+    0x6e17,0x7e36,0x4e55,0x5e74,0x2e93,0x3eb2,0x0ed1,0x1ef0
+};
+
+static uint16_t crc16(const char *buf, int len) {
+    int counter;
+    uint16_t crc = 0;
+    for (counter = 0; counter < len; counter++)
+            crc = (crc<<8) ^ crc16tab[((crc>>8) ^ *buf++)&0x00FF];
+    return crc;
+}

crc16.h

@@ -320,6 +320,58 @@ PHP_REDIS_API char *redis_sock_read_bulk_reply(RedisSock *redis_sock, int bytes
     return reply;
 }
 
+/**
+ * Parse MOVED or ASK redirection (Redis Cluster)
+ * We should get slot host:port
+ */
+PHPAPI 
+int redis_sock_redir(RedisSock *redis_sock, const char *msg, int len, 
+                     MOVED_TYPE type TSRMLS_DC) 
+{
+    char buf[24], *p1, *p2;
+
+    // Find the space and ':' seperating host/port and do a sanity check on the
+    // lengths we get back.
+    if(!(p1 = strchr(msg, ' ')) || !(p2 = strchr(p1,':')) || (len-(p2-msg)>6))
+    {
+        zend_throw_exception(redis_exception_ce, 
+            "Error parsing MOVED/ASK redirection", 0 TSRMLS_CC);
+        return -1;
+    }
+
+    // Free previously stored redirection host
+    if(redis_sock->redir_host) efree(redis_sock->redir_host);
+
+    // Copy and convert slot
+    strncpy(buf, msg, p1-msg);
+    buf[p1-msg]='\0';
+    redis_sock->redir_slot = (unsigned short)atoi(buf);
+
+    // Make a copy of our host
+    redis_sock->redir_host = estrndup(p1+1, p2-p1-1);
+
+    // Copy and convert port
+    strncpy(buf, p2+1, len-(p2-msg));
+    buf[len-(p2-msg)+1]='\0';
+    redis_sock->redir_port = (unsigned short)atoi(buf);
+
+    // Success
+    return 0;
+}
+
+/**
+ * Clear redirection information
+ */
+PHPAPI void redis_sock_redir_clear(RedisSock *redis_sock)
+{
+    if(redis_sock->redir_host) {
+        efree(redis_sock->redir_host);
+        redis_sock->redir_host = NULL;
+    }
+    redis_sock->redir_slot = 0;
+    redis_sock->redir_port = 0;
+}
+
 /**
  * redis_sock_read
  */
@@ -343,15 +395,25 @@ PHP_REDIS_API char *redis_sock_read(RedisSock *redis_sock, int *buf_len TSRMLS_D
         return NULL;
     }
 
+    // Clear any previous MOVED or ASK redirection
+    REDIS_MOVED_CLEAR(redis_sock);
+
     switch(inbuf[0]) {
         case '-':
 			/* Set the last error */
             err_len = strlen(inbuf+1) - 2;
 			redis_sock_set_err(redis_sock, inbuf+1, err_len);
 
-            /* Filter our ERROR through the few that should actually throw */
-            redis_error_throw(inbuf + 1, err_len TSRMLS_CC);
-
+            /* Handle stale data or MOVED/ASK redirection */
+			if(memcmp(inbuf + 1, "-ERR SYNC ", 10) == 0) {
+				zend_throw_exception(redis_exception_ce, "SYNC with master in progress", 0 TSRMLS_CC);
+			} else if(memcmp(inbuf, "-MOVED ", sizeof("-MOVED ")-1)==0) {
+                redis_sock_redir(redis_sock,inbuf+sizeof("-MOVED "), 
+                    err_len-sizeof("-MOVED ")-1, MOVED_MOVED TSRMLS_CC);
+            } else if(memcmp(inbuf, "-ASK ", sizeof("-ASK ")-1)==0) {
+                redis_sock_redir(redis_sock,inbuf+sizeof("-ASK "), 
+                    err_len-sizeof("-ASK ")-1, MOVED_ASK TSRMLS_CC);
+            }
             return NULL;
         case '$':
             *buf_len = atoi(inbuf + 1);
@@ -1821,6 +1883,9 @@ PHP_REDIS_API void redis_free_socket(RedisSock *redis_sock)
     if(redis_sock->persistent_id) {
         efree(redis_sock->persistent_id);
     }
+    if(redis_sock->redir_host) {
+        efree(redis_sock->redir_host);
+    }
     efree(redis_sock->host);
     efree(redis_sock);
 }