src/redis.h

   1 #ifndef __REDIS_H
   2 #define __REDIS_H
   3
   4 #include "fmacros.h"
   5 #include "config.h"
   6
   7 #if defined(__sun)
   8 #include "solarisfixes.h"
   9 #endif
  10
  11 #include <stdio.h>
  12 #include <stdlib.h>
  13 #include <string.h>
  14 #include <time.h>
  15 #include <limits.h>
  16 #include <unistd.h>
  17 #include <errno.h>
  18 #include <inttypes.h>
  19 #include <pthread.h>
  20 #include <syslog.h>
  21 #include <netinet/in.h>
  22 #include <lua.h>
  23 #include <signal.h>
  24
  25 #include "ae.h"      /* Event driven programming library */
  26 #include "sds.h"     /* Dynamic safe strings */
  27 #include "dict.h"    /* Hash tables */
  28 #include "adlist.h"  /* Linked lists */
  29 #include "zmalloc.h" /* total memory usage aware version of malloc/free */
  30 #include "anet.h"    /* Networking the easy way */
  31 #include "ziplist.h" /* Compact list data structure */
  32 #include "intset.h"  /* Compact integer set structure */
  33 #include "version.h" /* Version macro */
  34 #include "util.h"    /* Misc functions useful in many places */
  35
  36 /* Error codes */
  37 #define REDIS_OK                0
  38 #define REDIS_ERR               -1
  39
  40 /* Static server configuration */
  41 #define REDIS_HZ                100     /* Time interrupt calls/sec. */
  42 #define REDIS_SERVERPORT        6379    /* TCP port */
  43 #define REDIS_MAXIDLETIME       0       /* default client timeout: infinite */
  44 #define REDIS_DEFAULT_DBNUM     16
  45 #define REDIS_CONFIGLINE_MAX    1024
  46 #define REDIS_EXPIRELOOKUPS_PER_CRON    10 /* lookup 10 expires per loop */
  47 #define REDIS_EXPIRELOOKUPS_TIME_PERC   25 /* CPU max % for keys collection */
  48 #define REDIS_MAX_WRITE_PER_EVENT (1024*64)
  49 #define REDIS_SHARED_SELECT_CMDS 10
  50 #define REDIS_SHARED_INTEGERS 10000
  51 #define REDIS_SHARED_BULKHDR_LEN 32
  52 #define REDIS_MAX_LOGMSG_LEN    1024 /* Default maximum length of syslog messages */
  53 #define REDIS_AOF_REWRITE_PERC  100
  54 #define REDIS_AOF_REWRITE_MIN_SIZE (1024*1024)
  55 #define REDIS_AOF_REWRITE_ITEMS_PER_CMD 64
  56 #define REDIS_SLOWLOG_LOG_SLOWER_THAN 10000
  57 #define REDIS_SLOWLOG_MAX_LEN 128
  58 #define REDIS_MAX_CLIENTS 10000
  59 #define REDIS_AUTHPASS_MAX_LEN 512
  60 #define REDIS_DEFAULT_SLAVE_PRIORITY 100
  61 #define REDIS_REPL_TIMEOUT 60
  62 #define REDIS_REPL_PING_SLAVE_PERIOD 10
  63 #define REDIS_RUN_ID_SIZE 40
  64 #define REDIS_OPS_SEC_SAMPLES 16
  65
  66 /* Protocol and I/O related defines */
  67 #define REDIS_MAX_QUERYBUF_LEN  (1024*1024*1024) /* 1GB max query buffer. */
  68 #define REDIS_IOBUF_LEN         (1024*16)  /* Generic I/O buffer size */
  69 #define REDIS_REPLY_CHUNK_BYTES (16*1024) /* 16k output buffer */
  70 #define REDIS_INLINE_MAX_SIZE   (1024*64) /* Max size of inline reads */
  71 #define REDIS_MBULK_BIG_ARG     (1024*32)
  72
  73 /* Hash table parameters */
  74 #define REDIS_HT_MINFILL        10      /* Minimal hash table fill 10% */
  75
  76 /* Command flags. Please check the command table defined in the redis.c file
  77  * for more information about the meaning of every flag. */
  78 #define REDIS_CMD_WRITE 1                   /* "w" flag */
  79 #define REDIS_CMD_READONLY 2                /* "r" flag */
  80 #define REDIS_CMD_DENYOOM 4                 /* "m" flag */
  81 #define REDIS_CMD_FORCE_REPLICATION 8       /* "f" flag */
  82 #define REDIS_CMD_ADMIN 16                  /* "a" flag */
  83 #define REDIS_CMD_PUBSUB 32                 /* "p" flag */
  84 #define REDIS_CMD_NOSCRIPT  64              /* "s" flag */
  85 #define REDIS_CMD_RANDOM 128                /* "R" flag */
  86 #define REDIS_CMD_SORT_FOR_SCRIPT 256       /* "S" flag */
  87 #define REDIS_CMD_LOADING 512               /* "l" flag */
  88 #define REDIS_CMD_STALE 1024                /* "t" flag */
  89
  90 /* Object types */
  91 #define REDIS_STRING 0
  92 #define REDIS_LIST 1
  93 #define REDIS_SET 2
  94 #define REDIS_ZSET 3
  95 #define REDIS_HASH 4
  96
  97 /* Objects encoding. Some kind of objects like Strings and Hashes can be
  98  * internally represented in multiple ways. The 'encoding' field of the object
  99  * is set to one of this fields for this object. */
 100 #define REDIS_ENCODING_RAW 0     /* Raw representation */
 101 #define REDIS_ENCODING_INT 1     /* Encoded as integer */
 102 #define REDIS_ENCODING_HT 2      /* Encoded as hash table */
 103 #define REDIS_ENCODING_ZIPMAP 3  /* Encoded as zipmap */
 104 #define REDIS_ENCODING_LINKEDLIST 4 /* Encoded as regular linked list */
 105 #define REDIS_ENCODING_ZIPLIST 5 /* Encoded as ziplist */
 106 #define REDIS_ENCODING_INTSET 6  /* Encoded as intset */
 107 #define REDIS_ENCODING_SKIPLIST 7  /* Encoded as skiplist */
 108
 109 /* Defines related to the dump file format. To store 32 bits lengths for short
 110  * keys requires a lot of space, so we check the most significant 2 bits of
 111  * the first byte to interpreter the length:
 112  *
 113  * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
 114  * 01|000000 00000000 =>  01, the len is 14 byes, 6 bits + 8 bits of next byte
 115  * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
 116  * 11|000000 this means: specially encoded object will follow. The six bits
 117  *           number specify the kind of object that follows.
 118  *           See the REDIS_RDB_ENC_* defines.
 119  *
 120  * Lenghts up to 63 are stored using a single byte, most DB keys, and may
 121  * values, will fit inside. */
 122 #define REDIS_RDB_6BITLEN 0
 123 #define REDIS_RDB_14BITLEN 1
 124 #define REDIS_RDB_32BITLEN 2
 125 #define REDIS_RDB_ENCVAL 3
 126 #define REDIS_RDB_LENERR UINT_MAX
 127
 128 /* When a length of a string object stored on disk has the first two bits
 129  * set, the remaining two bits specify a special encoding for the object
 130  * accordingly to the following defines: */
 131 #define REDIS_RDB_ENC_INT8 0        /* 8 bit signed integer */
 132 #define REDIS_RDB_ENC_INT16 1       /* 16 bit signed integer */
 133 #define REDIS_RDB_ENC_INT32 2       /* 32 bit signed integer */
 134 #define REDIS_RDB_ENC_LZF 3         /* string compressed with FASTLZ */
 135
 136 /* AOF states */
 137 #define REDIS_AOF_OFF 0             /* AOF is off */
 138 #define REDIS_AOF_ON 1              /* AOF is on */
 139 #define REDIS_AOF_WAIT_REWRITE 2    /* AOF waits rewrite to start appending */
 140
 141 /* Client flags */
 142 #define REDIS_SLAVE 1       /* This client is a slave server */
 143 #define REDIS_MASTER 2      /* This client is a master server */
 144 #define REDIS_MONITOR 4     /* This client is a slave monitor, see MONITOR */
 145 #define REDIS_MULTI 8       /* This client is in a MULTI context */
 146 #define REDIS_BLOCKED 16    /* The client is waiting in a blocking operation */
 147 #define REDIS_DIRTY_CAS 64  /* Watched keys modified. EXEC will fail. */
 148 #define REDIS_CLOSE_AFTER_REPLY 128 /* Close after writing entire reply. */
 149 #define REDIS_UNBLOCKED 256 /* This client was unblocked and is stored in
 150                                server.unblocked_clients */
 151 #define REDIS_LUA_CLIENT 512 /* This is a non connected client used by Lua */
 152 #define REDIS_ASKING 1024   /* Client issued the ASKING command */
 153 #define REDIS_CLOSE_ASAP 2048 /* Close this client ASAP */
 154
 155 /* Client request types */
 156 #define REDIS_REQ_INLINE 1
 157 #define REDIS_REQ_MULTIBULK 2
 158
 159 /* Client classes for client limits, currently used only for
 160  * the max-client-output-buffer limit implementation. */
 161 #define REDIS_CLIENT_LIMIT_CLASS_NORMAL 0
 162 #define REDIS_CLIENT_LIMIT_CLASS_SLAVE 1
 163 #define REDIS_CLIENT_LIMIT_CLASS_PUBSUB 2
 164 #define REDIS_CLIENT_LIMIT_NUM_CLASSES 3
 165
 166 /* Slave replication state - slave side */
 167 #define REDIS_REPL_NONE 0 /* No active replication */
 168 #define REDIS_REPL_CONNECT 1 /* Must connect to master */
 169 #define REDIS_REPL_CONNECTING 2 /* Connecting to master */
 170 #define REDIS_REPL_RECEIVE_PONG 3 /* Wait for PING reply */
 171 #define REDIS_REPL_TRANSFER 4 /* Receiving .rdb from master */
 172 #define REDIS_REPL_CONNECTED 5 /* Connected to master */
 173
 174 /* Synchronous read timeout - slave side */
 175 #define REDIS_REPL_SYNCIO_TIMEOUT 5
 176
 177 /* Slave replication state - from the point of view of master
 178  * Note that in SEND_BULK and ONLINE state the slave receives new updates
 179  * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
 180  * to start the next background saving in order to send updates to it. */
 181 #define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
 182 #define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
 183 #define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
 184 #define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */
 185
 186 /* List related stuff */
 187 #define REDIS_HEAD 0
 188 #define REDIS_TAIL 1
 189
 190 /* Sort operations */
 191 #define REDIS_SORT_GET 0
 192 #define REDIS_SORT_ASC 1
 193 #define REDIS_SORT_DESC 2
 194 #define REDIS_SORTKEY_MAX 1024
 195
 196 /* Log levels */
 197 #define REDIS_DEBUG 0
 198 #define REDIS_VERBOSE 1
 199 #define REDIS_NOTICE 2
 200 #define REDIS_WARNING 3
 201 #define REDIS_LOG_RAW (1<<10) /* Modifier to log without timestamp */
 202
 203 /* Anti-warning macro... */
 204 #define REDIS_NOTUSED(V) ((void) V)
 205
 206 #define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
 207 #define ZSKIPLIST_P 0.25      /* Skiplist P = 1/4 */
 208
 209 /* Append only defines */
 210 #define AOF_FSYNC_NO 0
 211 #define AOF_FSYNC_ALWAYS 1
 212 #define AOF_FSYNC_EVERYSEC 2
 213
 214 /* Zip structure related defaults */
 215 #define REDIS_HASH_MAX_ZIPLIST_ENTRIES 512
 216 #define REDIS_HASH_MAX_ZIPLIST_VALUE 64
 217 #define REDIS_LIST_MAX_ZIPLIST_ENTRIES 512
 218 #define REDIS_LIST_MAX_ZIPLIST_VALUE 64
 219 #define REDIS_SET_MAX_INTSET_ENTRIES 512
 220 #define REDIS_ZSET_MAX_ZIPLIST_ENTRIES 128
 221 #define REDIS_ZSET_MAX_ZIPLIST_VALUE 64
 222
 223 /* Sets operations codes */
 224 #define REDIS_OP_UNION 0
 225 #define REDIS_OP_DIFF 1
 226 #define REDIS_OP_INTER 2
 227
 228 /* Redis maxmemory strategies */
 229 #define REDIS_MAXMEMORY_VOLATILE_LRU 0
 230 #define REDIS_MAXMEMORY_VOLATILE_TTL 1
 231 #define REDIS_MAXMEMORY_VOLATILE_RANDOM 2
 232 #define REDIS_MAXMEMORY_ALLKEYS_LRU 3
 233 #define REDIS_MAXMEMORY_ALLKEYS_RANDOM 4
 234 #define REDIS_MAXMEMORY_NO_EVICTION 5
 235
 236 /* Scripting */
 237 #define REDIS_LUA_TIME_LIMIT 5000 /* milliseconds */
 238
 239 /* Units */
 240 #define UNIT_SECONDS 0
 241 #define UNIT_MILLISECONDS 1
 242
 243 /* SHUTDOWN flags */
 244 #define REDIS_SHUTDOWN_SAVE 1       /* Force SAVE on SHUTDOWN even if no save
 245                                        points are configured. */
 246 #define REDIS_SHUTDOWN_NOSAVE 2     /* Don't SAVE on SHUTDOWN. */
 247
 248 /* Command call flags, see call() function */
 249 #define REDIS_CALL_NONE 0
 250 #define REDIS_CALL_SLOWLOG 1
 251 #define REDIS_CALL_STATS 2
 252 #define REDIS_CALL_PROPAGATE 4
 253 #define REDIS_CALL_FULL (REDIS_CALL_SLOWLOG | REDIS_CALL_STATS | REDIS_CALL_PROPAGATE)
 254
 255 /* Command propagation flags, see propagate() function */
 256 #define REDIS_PROPAGATE_NONE 0
 257 #define REDIS_PROPAGATE_AOF 1
 258 #define REDIS_PROPAGATE_REPL 2
 259
 260 /* Using the following macro you can run code inside serverCron() with the
 261  * specified period, specified in milliseconds.
 262  * The actual resolution depends on REDIS_HZ. */
 263 #define run_with_period(_ms_) if (!(server.cronloops%((_ms_)/(1000/REDIS_HZ))))
 264
 265 /* We can print the stacktrace, so our assert is defined this way: */
 266 #define redisAssertWithInfo(_c,_o,_e) ((_e)?(void)0 : (_redisAssertWithInfo(_c,_o,#_e,__FILE__,__LINE__),_exit(1)))
 267 #define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1)))
 268 #define redisPanic(_e) _redisPanic(#_e,__FILE__,__LINE__),_exit(1)
 269
 270 /*-----------------------------------------------------------------------------
 271  * Data types
 272  *----------------------------------------------------------------------------*/
 273
 274 /* A redis object, that is a type able to hold a string / list / set */
 275
 276 /* The actual Redis Object */
 277 #define REDIS_LRU_CLOCK_MAX ((1<<21)-1) /* Max value of obj->lru */
 278 #define REDIS_LRU_CLOCK_RESOLUTION 10 /* LRU clock resolution in seconds */
 279 typedef struct redisObject {
 280     unsigned type:4;
 281     unsigned notused:2;     /* Not used */
 282     unsigned encoding:4;
 283     unsigned lru:22;        /* lru time (relative to server.lruclock) */
 284     int refcount;
 285     void *ptr;
 286 } robj;
 287
 288 /* Macro used to initalize a Redis object allocated on the stack.
 289  * Note that this macro is taken near the structure definition to make sure
 290  * we'll update it when the structure is changed, to avoid bugs like
 291  * bug #85 introduced exactly in this way. */
 292 #define initStaticStringObject(_var,_ptr) do { \
 293     _var.refcount = 1; \
 294     _var.type = REDIS_STRING; \
 295     _var.encoding = REDIS_ENCODING_RAW; \
 296     _var.ptr = _ptr; \
 297 } while(0);
 298
 299 typedef struct redisDb {
 300     dict *dict;                 /* The keyspace for this DB */
 301     dict *expires;              /* Timeout of keys with a timeout set */
 302     dict *blocking_keys;        /* Keys with clients waiting for data (BLPOP) */
 303     dict *ready_keys;           /* Blocked keys that received a PUSH */
 304     dict *watched_keys;         /* WATCHED keys for MULTI/EXEC CAS */
 305     int id;
 306 } redisDb;
 307
 308 /* Client MULTI/EXEC state */
 309 typedef struct multiCmd {
 310     robj **argv;
 311     int argc;
 312     struct redisCommand *cmd;
 313 } multiCmd;
 314
 315 typedef struct multiState {
 316     multiCmd *commands;     /* Array of MULTI commands */
 317     int count;              /* Total number of MULTI commands */
 318 } multiState;
 319
 320 typedef struct blockingState {
 321     robj **keys;            /* The key we are waiting to terminate a blocking
 322                              * operation such as BLPOP. Otherwise NULL. */
 323     int count;              /* Number of blocking keys */
 324     time_t timeout;         /* Blocking operation timeout. If UNIX current time
 325                              * is >= timeout then the operation timed out. */
 326     robj *target;           /* The key that should receive the element,
 327                              * for BRPOPLPUSH. */
 328 } blockingState;
 329
 330 /* The following structure represents a node in the server.ready_keys list,
 331  * where we accumulate all the keys that had clients blocked with a blocking
 332  * operation such as B[LR]POP, but received new data in the context of the
 333  * last executed command.
 334  *
 335  * After the execution of every command or script, we run this list to check
 336  * if as a result we should serve data to clients blocked, unblocking them.
 337  * Note that server.ready_keys will not have duplicates as there dictionary
 338  * also called ready_keys in every structure representing a Redis database,
 339  * where we make sure to remember if a given key was already added in the
 340  * server.ready_keys list. */
 341 typedef struct readyList {
 342     redisDb *db;
 343     robj *key;
 344 } readyList;
 345
 346 /* With multiplexing we need to take per-clinet state.
 347  * Clients are taken in a liked list. */
 348 typedef struct redisClient {
 349     int fd;
 350     redisDb *db;
 351     int dictid;
 352     sds querybuf;
 353     size_t querybuf_peak;   /* Recent (100ms or more) peak of querybuf size */
 354     int argc;
 355     robj **argv;
 356     struct redisCommand *cmd, *lastcmd;
 357     int reqtype;
 358     int multibulklen;       /* number of multi bulk arguments left to read */
 359     long bulklen;           /* length of bulk argument in multi bulk request */
 360     list *reply;
 361     unsigned long reply_bytes; /* Tot bytes of objects in reply list */
 362     int sentlen;
 363     time_t ctime;           /* Client creation time */
 364     time_t lastinteraction; /* time of the last interaction, used for timeout */
 365     time_t obuf_soft_limit_reached_time;
 366     int flags;              /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
 367     int slaveseldb;         /* slave selected db, if this client is a slave */
 368     int authenticated;      /* when requirepass is non-NULL */
 369     int replstate;          /* replication state if this is a slave */
 370     int repldbfd;           /* replication DB file descriptor */
 371     long repldboff;         /* replication DB file offset */
 372     off_t repldbsize;       /* replication DB file size */
 373     int slave_listening_port; /* As configured with: SLAVECONF listening-port */
 374     multiState mstate;      /* MULTI/EXEC state */
 375     blockingState bpop;   /* blocking state */
 376     list *io_keys;          /* Keys this client is waiting to be loaded from the
 377                              * swap file in order to continue. */
 378     list *watched_keys;     /* Keys WATCHED for MULTI/EXEC CAS */
 379     dict *pubsub_channels;  /* channels a client is interested in (SUBSCRIBE) */
 380     list *pubsub_patterns;  /* patterns a client is interested in (SUBSCRIBE) */
 381
 382     /* Response buffer */
 383     int bufpos;
 384     char buf[REDIS_REPLY_CHUNK_BYTES];
 385 } redisClient;
 386
 387 struct saveparam {
 388     time_t seconds;
 389     int changes;
 390 };
 391
 392 struct sharedObjectsStruct {
 393     robj *crlf, *ok, *err, *emptybulk, *czero, *cone, *cnegone, *pong, *space,
 394     *colon, *nullbulk, *nullmultibulk, *queued,
 395     *emptymultibulk, *wrongtypeerr, *nokeyerr, *syntaxerr, *sameobjecterr,
 396     *outofrangeerr, *noscripterr, *loadingerr, *slowscripterr, *bgsaveerr,
 397     *masterdownerr, *roslaveerr,
 398     *oomerr, *plus, *messagebulk, *pmessagebulk, *subscribebulk,
 399     *unsubscribebulk, *psubscribebulk, *punsubscribebulk, *del, *rpop, *lpop,
 400     *lpush,
 401     *select[REDIS_SHARED_SELECT_CMDS],
 402     *integers[REDIS_SHARED_INTEGERS],
 403     *mbulkhdr[REDIS_SHARED_BULKHDR_LEN], /* "*<value>\r\n" */
 404     *bulkhdr[REDIS_SHARED_BULKHDR_LEN];  /* "$<value>\r\n" */
 405 };
 406
 407 /* ZSETs use a specialized version of Skiplists */
 408 typedef struct zskiplistNode {
 409     robj *obj;
 410     double score;
 411     struct zskiplistNode *backward;
 412     struct zskiplistLevel {
 413         struct zskiplistNode *forward;
 414         unsigned int span;
 415     } level[];
 416 } zskiplistNode;
 417
 418 typedef struct zskiplist {
 419     struct zskiplistNode *header, *tail;
 420     unsigned long length;
 421     int level;
 422 } zskiplist;
 423
 424 typedef struct zset {
 425     dict *dict;
 426     zskiplist *zsl;
 427 } zset;
 428
 429 typedef struct clientBufferLimitsConfig {
 430     unsigned long long hard_limit_bytes;
 431     unsigned long long soft_limit_bytes;
 432     time_t soft_limit_seconds;
 433 } clientBufferLimitsConfig;
 434
 435 /* The redisOp structure defines a Redis Operation, that is an instance of
 436  * a command with an argument vector, database ID, propagation target
 437  * (REDIS_PROPAGATE_*), and command pointer.
 438  *
 439  * Currently only used to additionally propagate more commands to AOF/Replication
 440  * after the propagation of the executed command. */
 441 typedef struct redisOp {
 442     robj **argv;
 443     int argc, dbid, target;
 444     struct redisCommand *cmd;
 445 } redisOp;
 446
 447 /* Defines an array of Redis operations. There is an API to add to this
 448  * structure in a easy way.
 449  *
 450  * redisOpArrayInit();
 451  * redisOpArrayAppend();
 452  * redisOpArrayFree();
 453  */
 454 typedef struct redisOpArray {
 455     redisOp *ops;
 456     int numops;
 457 } redisOpArray;
 458
 459 /*-----------------------------------------------------------------------------
 460  * Redis cluster data structures
 461  *----------------------------------------------------------------------------*/
 462
 463 #define REDIS_CLUSTER_SLOTS 4096
 464 #define REDIS_CLUSTER_OK 0          /* Everything looks ok */
 465 #define REDIS_CLUSTER_FAIL 1        /* The cluster can't work */
 466 #define REDIS_CLUSTER_NEEDHELP 2    /* The cluster works, but needs some help */
 467 #define REDIS_CLUSTER_NAMELEN 40    /* sha1 hex length */
 468 #define REDIS_CLUSTER_PORT_INCR 10000 /* Cluster port = baseport + PORT_INCR */
 469
 470 struct clusterNode;
 471
 472 /* clusterLink encapsulates everything needed to talk with a remote node. */
 473 typedef struct clusterLink {
 474     int fd;                     /* TCP socket file descriptor */
 475     sds sndbuf;                 /* Packet send buffer */
 476     sds rcvbuf;                 /* Packet reception buffer */
 477     struct clusterNode *node;   /* Node related to this link if any, or NULL */
 478 } clusterLink;
 479
 480 /* Node flags */
 481 #define REDIS_NODE_MASTER 1     /* The node is a master */
 482 #define REDIS_NODE_SLAVE 2      /* The node is a slave */
 483 #define REDIS_NODE_PFAIL 4      /* Failure? Need acknowledge */
 484 #define REDIS_NODE_FAIL 8       /* The node is believed to be malfunctioning */
 485 #define REDIS_NODE_MYSELF 16    /* This node is myself */
 486 #define REDIS_NODE_HANDSHAKE 32 /* We have still to exchange the first ping */
 487 #define REDIS_NODE_NOADDR   64  /* We don't know the address of this node */
 488 #define REDIS_NODE_MEET 128     /* Send a MEET message to this node */
 489 #define REDIS_NODE_NULL_NAME "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
 490
 491 struct clusterNode {
 492     char name[REDIS_CLUSTER_NAMELEN]; /* Node name, hex string, sha1-size */
 493     int flags;      /* REDIS_NODE_... */
 494     unsigned char slots[REDIS_CLUSTER_SLOTS/8]; /* slots handled by this node */
 495     int numslaves;  /* Number of slave nodes, if this is a master */
 496     struct clusterNode **slaves; /* pointers to slave nodes */
 497     struct clusterNode *slaveof; /* pointer to the master node */
 498     time_t ping_sent;       /* Unix time we sent latest ping */
 499     time_t pong_received;   /* Unix time we received the pong */
 500     char *configdigest;         /* Configuration digest of this node */
 501     time_t configdigest_ts;     /* Configuration digest timestamp */
 502     char ip[16];                /* Latest known IP address of this node */
 503     int port;                   /* Latest known port of this node */
 504     clusterLink *link;          /* TCP/IP link with this node */
 505 };
 506 typedef struct clusterNode clusterNode;
 507
 508 typedef struct {
 509     char *configfile;
 510     clusterNode *myself;  /* This node */
 511     int state;            /* REDIS_CLUSTER_OK, REDIS_CLUSTER_FAIL, ... */
 512     int node_timeout;
 513     dict *nodes;          /* Hash table of name -> clusterNode structures */
 514     clusterNode *migrating_slots_to[REDIS_CLUSTER_SLOTS];
 515     clusterNode *importing_slots_from[REDIS_CLUSTER_SLOTS];
 516     clusterNode *slots[REDIS_CLUSTER_SLOTS];
 517     zskiplist *slots_to_keys;
 518 } clusterState;
 519
 520 /* Redis cluster messages header */
 521
 522 /* Note that the PING, PONG and MEET messages are actually the same exact
 523  * kind of packet. PONG is the reply to ping, in the extact format as a PING,
 524  * while MEET is a special PING that forces the receiver to add the sender
 525  * as a node (if it is not already in the list). */
 526 #define CLUSTERMSG_TYPE_PING 0          /* Ping */
 527 #define CLUSTERMSG_TYPE_PONG 1          /* Pong (reply to Ping) */
 528 #define CLUSTERMSG_TYPE_MEET 2          /* Meet "let's join" message */
 529 #define CLUSTERMSG_TYPE_FAIL 3          /* Mark node xxx as failing */
 530 #define CLUSTERMSG_TYPE_PUBLISH 4       /* Pub/Sub Publish propatagion */
 531
 532 /* Initially we don't know our "name", but we'll find it once we connect
 533  * to the first node, using the getsockname() function. Then we'll use this
 534  * address for all the next messages. */
 535 typedef struct {
 536     char nodename[REDIS_CLUSTER_NAMELEN];
 537     uint32_t ping_sent;
 538     uint32_t pong_received;
 539     char ip[16];    /* IP address last time it was seen */
 540     uint16_t port;  /* port last time it was seen */
 541     uint16_t flags;
 542     uint32_t notused; /* for 64 bit alignment */
 543 } clusterMsgDataGossip;
 544
 545 typedef struct {
 546     char nodename[REDIS_CLUSTER_NAMELEN];
 547 } clusterMsgDataFail;
 548
 549 typedef struct {
 550     uint32_t channel_len;
 551     uint32_t message_len;
 552     unsigned char bulk_data[8]; /* defined as 8 just for alignment concerns. */
 553 } clusterMsgDataPublish;
 554
 555 union clusterMsgData {
 556     /* PING, MEET and PONG */
 557     struct {
 558         /* Array of N clusterMsgDataGossip structures */
 559         clusterMsgDataGossip gossip[1];
 560     } ping;
 561
 562     /* FAIL */
 563     struct {
 564         clusterMsgDataFail about;
 565     } fail;
 566
 567     /* PUBLISH */
 568     struct {
 569         clusterMsgDataPublish msg;
 570     } publish;
 571 };
 572
 573 typedef struct {
 574     uint32_t totlen;    /* Total length of this message */
 575     uint16_t type;      /* Message type */
 576     uint16_t count;     /* Only used for some kind of messages. */
 577     char sender[REDIS_CLUSTER_NAMELEN]; /* Name of the sender node */
 578     unsigned char myslots[REDIS_CLUSTER_SLOTS/8];
 579     char slaveof[REDIS_CLUSTER_NAMELEN];
 580     char configdigest[32];
 581     uint16_t port;      /* Sender TCP base port */
 582     unsigned char state; /* Cluster state from the POV of the sender */
 583     unsigned char notused[5]; /* Reserved for future use. For alignment. */
 584     union clusterMsgData data;
 585 } clusterMsg;
 586
 587 /*-----------------------------------------------------------------------------
 588  * Global server state
 589  *----------------------------------------------------------------------------*/
 590
 591 struct redisServer {
 592     /* General */
 593     redisDb *db;
 594     dict *commands;             /* Command table hahs table */
 595     aeEventLoop *el;
 596     unsigned lruclock:22;       /* Clock incrementing every minute, for LRU */
 597     unsigned lruclock_padding:10;
 598     int shutdown_asap;          /* SHUTDOWN needed ASAP */
 599     int activerehashing;        /* Incremental rehash in serverCron() */
 600     char *requirepass;          /* Pass for AUTH command, or NULL */
 601     char *pidfile;              /* PID file path */
 602     int arch_bits;              /* 32 or 64 depending on sizeof(long) */
 603     int cronloops;              /* Number of times the cron function run */
 604     char runid[REDIS_RUN_ID_SIZE+1];  /* ID always different at every exec. */
 605     int sentinel_mode;          /* True if this instance is a Sentinel. */
 606     /* Networking */
 607     int port;                   /* TCP listening port */
 608     char *bindaddr;             /* Bind address or NULL */
 609     char *unixsocket;           /* UNIX socket path */
 610     mode_t unixsocketperm;      /* UNIX socket permission */
 611     int ipfd;                   /* TCP socket file descriptor */
 612     int sofd;                   /* Unix socket file descriptor */
 613     int cfd;                    /* Cluster bus lisetning socket */
 614     list *clients;              /* List of active clients */
 615     list *clients_to_close;     /* Clients to close asynchronously */
 616     list *slaves, *monitors;    /* List of slaves and MONITORs */
 617     redisClient *current_client; /* Current client, only used on crash report */
 618     char neterr[ANET_ERR_LEN];  /* Error buffer for anet.c */
 619     /* RDB / AOF loading information */
 620     int loading;                /* We are loading data from disk if true */
 621     off_t loading_total_bytes;
 622     off_t loading_loaded_bytes;
 623     time_t loading_start_time;
 624     /* Fast pointers to often looked up command */
 625     struct redisCommand *delCommand, *multiCommand, *lpushCommand, *lpopCommand,
 626                         *rpopCommand;
 627     /* Fields used only for stats */
 628     time_t stat_starttime;          /* Server start time */
 629     long long stat_numcommands;     /* Number of processed commands */
 630     long long stat_numconnections;  /* Number of connections received */
 631     long long stat_expiredkeys;     /* Number of expired keys */
 632     long long stat_evictedkeys;     /* Number of evicted keys (maxmemory) */
 633     long long stat_keyspace_hits;   /* Number of successful lookups of keys */
 634     long long stat_keyspace_misses; /* Number of failed lookups of keys */
 635     size_t stat_peak_memory;        /* Max used memory record */
 636     long long stat_fork_time;       /* Time needed to perform latets fork() */
 637     long long stat_rejected_conn;   /* Clients rejected because of maxclients */
 638     list *slowlog;                  /* SLOWLOG list of commands */
 639     long long slowlog_entry_id;     /* SLOWLOG current entry ID */
 640     long long slowlog_log_slower_than; /* SLOWLOG time limit (to get logged) */
 641     unsigned long slowlog_max_len;     /* SLOWLOG max number of items logged */
 642     /* The following two are used to track instantaneous "load" in terms
 643      * of operations per second. */
 644     long long ops_sec_last_sample_time; /* Timestamp of last sample (in ms) */
 645     long long ops_sec_last_sample_ops;  /* numcommands in last sample */
 646     long long ops_sec_samples[REDIS_OPS_SEC_SAMPLES];
 647     int ops_sec_idx;
 648     /* Configuration */
 649     int verbosity;                  /* Loglevel in redis.conf */
 650     int maxidletime;                /* Client timeout in seconds */
 651     size_t client_max_querybuf_len; /* Limit for client query buffer length */
 652     int dbnum;                      /* Total number of configured DBs */
 653     int daemonize;                  /* True if running as a daemon */
 654     clientBufferLimitsConfig client_obuf_limits[REDIS_CLIENT_LIMIT_NUM_CLASSES];
 655     /* AOF persistence */
 656     int aof_state;                  /* REDIS_AOF_(ON|OFF|WAIT_REWRITE) */
 657     int aof_fsync;                  /* Kind of fsync() policy */
 658     char *aof_filename;             /* Name of the AOF file */
 659     int aof_no_fsync_on_rewrite;    /* Don't fsync if a rewrite is in prog. */
 660     int aof_rewrite_perc;           /* Rewrite AOF if % growth is > M and... */
 661     off_t aof_rewrite_min_size;     /* the AOF file is at least N bytes. */
 662     off_t aof_rewrite_base_size;    /* AOF size on latest startup or rewrite. */
 663     off_t aof_current_size;         /* AOF current size. */
 664     int aof_rewrite_scheduled;      /* Rewrite once BGSAVE terminates. */
 665     pid_t aof_child_pid;            /* PID if rewriting process */
 666     list *aof_rewrite_buf_blocks;   /* Hold changes during an AOF rewrite. */
 667     sds aof_buf;      /* AOF buffer, written before entering the event loop */
 668     int aof_fd;       /* File descriptor of currently selected AOF file */
 669     int aof_selected_db; /* Currently selected DB in AOF */
 670     time_t aof_flush_postponed_start; /* UNIX time of postponed AOF flush */
 671     time_t aof_last_fsync;            /* UNIX time of last fsync() */
 672     time_t aof_rewrite_time_last;   /* Time used by last AOF rewrite run. */
 673     time_t aof_rewrite_time_start;  /* Current AOF rewrite start time. */
 674     int aof_lastbgrewrite_status;   /* REDIS_OK or REDIS_ERR */
 675     unsigned long aof_delayed_fsync;  /* delayed AOF fsync() counter */
 676     /* RDB persistence */
 677     long long dirty;                /* Changes to DB from the last save */
 678     long long dirty_before_bgsave;  /* Used to restore dirty on failed BGSAVE */
 679     pid_t rdb_child_pid;            /* PID of RDB saving child */
 680     struct saveparam *saveparams;   /* Save points array for RDB */
 681     int saveparamslen;              /* Number of saving points */
 682     char *rdb_filename;             /* Name of RDB file */
 683     int rdb_compression;            /* Use compression in RDB? */
 684     int rdb_checksum;               /* Use RDB checksum? */
 685     time_t lastsave;                /* Unix time of last save succeeede */
 686     time_t rdb_save_time_last;      /* Time used by last RDB save run. */
 687     time_t rdb_save_time_start;     /* Current RDB save start time. */
 688     int lastbgsave_status;          /* REDIS_OK or REDIS_ERR */
 689     int stop_writes_on_bgsave_err;  /* Don't allow writes if can't BGSAVE */
 690     /* Propagation of commands in AOF / replication */
 691     redisOpArray also_propagate;    /* Additional command to propagate. */
 692     /* Logging */
 693     char *logfile;                  /* Path of log file */
 694     int syslog_enabled;             /* Is syslog enabled? */
 695     char *syslog_ident;             /* Syslog ident */
 696     int syslog_facility;            /* Syslog facility */
 697     /* Slave specific fields */
 698     char *masterauth;               /* AUTH with this password with master */
 699     char *masterhost;               /* Hostname of master */
 700     int masterport;                 /* Port of master */
 701     int repl_ping_slave_period;     /* Master pings the slave every N seconds */
 702     int repl_timeout;               /* Timeout after N seconds of master idle */
 703     redisClient *master;     /* Client that is master for this slave */
 704     int repl_syncio_timeout; /* Timeout for synchronous I/O calls */
 705     int repl_state;          /* Replication status if the instance is a slave */
 706     off_t repl_transfer_size; /* Size of RDB to read from master during sync. */
 707     off_t repl_transfer_read; /* Amount of RDB read from master during sync. */
 708     off_t repl_transfer_last_fsync_off; /* Offset when we fsync-ed last time. */
 709     int repl_transfer_s;     /* Slave -> Master SYNC socket */
 710     int repl_transfer_fd;    /* Slave -> Master SYNC temp file descriptor */
 711     char *repl_transfer_tmpfile; /* Slave-> master SYNC temp file name */
 712     time_t repl_transfer_lastio; /* Unix time of the latest read, for timeout */
 713     int repl_serve_stale_data; /* Serve stale data when link is down? */
 714     int repl_slave_ro;          /* Slave is read only? */
 715     time_t repl_down_since; /* Unix time at which link with master went down */
 716     int slave_priority;             /* Reported in INFO and used by Sentinel. */
 717     /* Limits */
 718     unsigned int maxclients;        /* Max number of simultaneous clients */
 719     unsigned long long maxmemory;   /* Max number of memory bytes to use */
 720     int maxmemory_policy;           /* Policy for key evition */
 721     int maxmemory_samples;          /* Pricision of random sampling */
 722     /* Blocked clients */
 723     unsigned int bpop_blocked_clients; /* Number of clients blocked by lists */
 724     list *unblocked_clients; /* list of clients to unblock before next loop */
 725     list *ready_keys;        /* List of readyList structures for BLPOP & co */
 726     /* Sort parameters - qsort_r() is only available under BSD so we
 727      * have to take this state global, in order to pass it to sortCompare() */
 728     int sort_desc;
 729     int sort_alpha;
 730     int sort_bypattern;
 731     /* Zip structure config, see redis.conf for more information  */
 732     size_t hash_max_ziplist_entries;
 733     size_t hash_max_ziplist_value;
 734     size_t list_max_ziplist_entries;
 735     size_t list_max_ziplist_value;
 736     size_t set_max_intset_entries;
 737     size_t zset_max_ziplist_entries;
 738     size_t zset_max_ziplist_value;
 739     time_t unixtime;        /* Unix time sampled every second. */
 740     /* Pubsub */
 741     dict *pubsub_channels;  /* Map channels to list of subscribed clients */
 742     list *pubsub_patterns;  /* A list of pubsub_patterns */
 743     /* Cluster */
 744     int cluster_enabled;    /* Is cluster enabled? */
 745     clusterState cluster;   /* State of the cluster */
 746     /* Scripting */
 747     lua_State *lua; /* The Lua interpreter. We use just one for all clients */
 748     redisClient *lua_client;   /* The "fake client" to query Redis from Lua */
 749     redisClient *lua_caller;   /* The client running EVAL right now, or NULL */
 750     dict *lua_scripts;         /* A dictionary of SHA1 -> Lua scripts */
 751     long long lua_time_limit;  /* Script timeout in seconds */
 752     long long lua_time_start;  /* Start time of script */
 753     int lua_write_dirty;  /* True if a write command was called during the
 754                              execution of the current script. */
 755     int lua_random_dirty; /* True if a random command was called during the
 756                              execution of the current script. */
 757     int lua_timedout;     /* True if we reached the time limit for script
 758                              execution. */
 759     int lua_kill;         /* Kill the script if true. */
 760     /* Assert & bug reportign */
 761     char *assert_failed;
 762     char *assert_file;
 763     int assert_line;
 764     int bug_report_start; /* True if bug report header was already logged. */
 765     int watchdog_period;  /* Software watchdog period in ms. 0 = off */
 766 };
 767
 768 typedef struct pubsubPattern {
 769     redisClient *client;
 770     robj *pattern;
 771 } pubsubPattern;
 772
 773 typedef void redisCommandProc(redisClient *c);
 774 typedef int *redisGetKeysProc(struct redisCommand *cmd, robj **argv, int argc, int *numkeys, int flags);
 775 struct redisCommand {
 776     char *name;
 777     redisCommandProc *proc;
 778     int arity;
 779     char *sflags; /* Flags as string represenation, one char per flag. */
 780     int flags;    /* The actual flags, obtained from the 'sflags' field. */
 781     /* Use a function to determine keys arguments in a command line.
 782      * Used for Redis Cluster redirect. */
 783     redisGetKeysProc *getkeys_proc;
 784     /* What keys should be loaded in background when calling this command? */
 785     int firstkey; /* The first argument that's a key (0 = no keys) */
 786     int lastkey;  /* THe last argument that's a key */
 787     int keystep;  /* The step between first and last key */
 788     long long microseconds, calls;
 789 };
 790
 791 struct redisFunctionSym {
 792     char *name;
 793     unsigned long pointer;
 794 };
 795
 796 typedef struct _redisSortObject {
 797     robj *obj;
 798     union {
 799         double score;
 800         robj *cmpobj;
 801     } u;
 802 } redisSortObject;
 803
 804 typedef struct _redisSortOperation {
 805     int type;
 806     robj *pattern;
 807 } redisSortOperation;
 808
 809 /* Structure to hold list iteration abstraction. */
 810 typedef struct {
 811     robj *subject;
 812     unsigned char encoding;
 813     unsigned char direction; /* Iteration direction */
 814     unsigned char *zi;
 815     listNode *ln;
 816 } listTypeIterator;
 817
 818 /* Structure for an entry while iterating over a list. */
 819 typedef struct {
 820     listTypeIterator *li;
 821     unsigned char *zi;  /* Entry in ziplist */
 822     listNode *ln;       /* Entry in linked list */
 823 } listTypeEntry;
 824
 825 /* Structure to hold set iteration abstraction. */
 826 typedef struct {
 827     robj *subject;
 828     int encoding;
 829     int ii; /* intset iterator */
 830     dictIterator *di;
 831 } setTypeIterator;
 832
 833 /* Structure to hold hash iteration abstration. Note that iteration over
 834  * hashes involves both fields and values. Because it is possible that
 835  * not both are required, store pointers in the iterator to avoid
 836  * unnecessary memory allocation for fields/values. */
 837 typedef struct {
 838     robj *subject;
 839     int encoding;
 840
 841     unsigned char *fptr, *vptr;
 842
 843     dictIterator *di;
 844     dictEntry *de;
 845 } hashTypeIterator;
 846
 847 #define REDIS_HASH_KEY 1
 848 #define REDIS_HASH_VALUE 2
 849
 850 /*-----------------------------------------------------------------------------
 851  * Extern declarations
 852  *----------------------------------------------------------------------------*/
 853
 854 extern struct redisServer server;
 855 extern struct sharedObjectsStruct shared;
 856 extern dictType setDictType;
 857 extern dictType zsetDictType;
 858 extern dictType clusterNodesDictType;
 859 extern dictType dbDictType;
 860 extern double R_Zero, R_PosInf, R_NegInf, R_Nan;
 861 extern dictType hashDictType;
 862
 863 /*-----------------------------------------------------------------------------
 864  * Functions prototypes
 865  *----------------------------------------------------------------------------*/
 866
 867 /* Utils */
 868 long long ustime(void);
 869 long long mstime(void);
 870 void getRandomHexChars(char *p, unsigned int len);
 871 uint64_t crc64(uint64_t crc, const unsigned char *s, uint64_t l);
 872 void exitFromChild(int retcode);
 873
 874 /* networking.c -- Networking and Client related operations */
 875 redisClient *createClient(int fd);
 876 void closeTimedoutClients(void);
 877 void freeClient(redisClient *c);
 878 void resetClient(redisClient *c);
 879 void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask);
 880 void addReply(redisClient *c, robj *obj);
 881 void *addDeferredMultiBulkLength(redisClient *c);
 882 void setDeferredMultiBulkLength(redisClient *c, void *node, long length);
 883 void addReplySds(redisClient *c, sds s);
 884 void processInputBuffer(redisClient *c);
 885 void acceptTcpHandler(aeEventLoop *el, int fd, void *privdata, int mask);
 886 void acceptUnixHandler(aeEventLoop *el, int fd, void *privdata, int mask);
 887 void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask);
 888 void addReplyBulk(redisClient *c, robj *obj);
 889 void addReplyBulkCString(redisClient *c, char *s);
 890 void addReplyBulkCBuffer(redisClient *c, void *p, size_t len);
 891 void addReplyBulkLongLong(redisClient *c, long long ll);
 892 void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask);
 893 void addReply(redisClient *c, robj *obj);
 894 void addReplySds(redisClient *c, sds s);
 895 void addReplyError(redisClient *c, char *err);
 896 void addReplyStatus(redisClient *c, char *status);
 897 void addReplyDouble(redisClient *c, double d);
 898 void addReplyLongLong(redisClient *c, long long ll);
 899 void addReplyMultiBulkLen(redisClient *c, long length);
 900 void copyClientOutputBuffer(redisClient *dst, redisClient *src);
 901 void *dupClientReplyValue(void *o);
 902 void getClientsMaxBuffers(unsigned long *longest_output_list,
 903                           unsigned long *biggest_input_buffer);
 904 sds getClientInfoString(redisClient *client);
 905 sds getAllClientsInfoString(void);
 906 void rewriteClientCommandVector(redisClient *c, int argc, ...);
 907 void rewriteClientCommandArgument(redisClient *c, int i, robj *newval);
 908 unsigned long getClientOutputBufferMemoryUsage(redisClient *c);
 909 void freeClientsInAsyncFreeQueue(void);
 910 void asyncCloseClientOnOutputBufferLimitReached(redisClient *c);
 911 int getClientLimitClassByName(char *name);
 912 char *getClientLimitClassName(int class);
 913 void flushSlavesOutputBuffers(void);
 914 void disconnectSlaves(void);
 915
 916 #ifdef __GNUC__
 917 void addReplyErrorFormat(redisClient *c, const char *fmt, ...)
 918     __attribute__((format(printf, 2, 3)));
 919 void addReplyStatusFormat(redisClient *c, const char *fmt, ...)
 920     __attribute__((format(printf, 2, 3)));
 921 #else
 922 void addReplyErrorFormat(redisClient *c, const char *fmt, ...);
 923 void addReplyStatusFormat(redisClient *c, const char *fmt, ...);
 924 #endif
 925
 926 /* List data type */
 927 void listTypeTryConversion(robj *subject, robj *value);
 928 void listTypePush(robj *subject, robj *value, int where);
 929 robj *listTypePop(robj *subject, int where);
 930 unsigned long listTypeLength(robj *subject);
 931 listTypeIterator *listTypeInitIterator(robj *subject, long index, unsigned char direction);
 932 void listTypeReleaseIterator(listTypeIterator *li);
 933 int listTypeNext(listTypeIterator *li, listTypeEntry *entry);
 934 robj *listTypeGet(listTypeEntry *entry);
 935 void listTypeInsert(listTypeEntry *entry, robj *value, int where);
 936 int listTypeEqual(listTypeEntry *entry, robj *o);
 937 void listTypeDelete(listTypeEntry *entry);
 938 void listTypeConvert(robj *subject, int enc);
 939 void unblockClientWaitingData(redisClient *c);
 940 void handleClientsBlockedOnLists(void);
 941 void popGenericCommand(redisClient *c, int where);
 942
 943 /* MULTI/EXEC/WATCH... */
 944 void unwatchAllKeys(redisClient *c);
 945 void initClientMultiState(redisClient *c);
 946 void freeClientMultiState(redisClient *c);
 947 void queueMultiCommand(redisClient *c);
 948 void touchWatchedKey(redisDb *db, robj *key);
 949 void touchWatchedKeysOnFlush(int dbid);
 950 void discardTransaction(redisClient *c);
 951
 952 /* Redis object implementation */
 953 void decrRefCount(void *o);
 954 void incrRefCount(robj *o);
 955 robj *resetRefCount(robj *obj);
 956 void freeStringObject(robj *o);
 957 void freeListObject(robj *o);
 958 void freeSetObject(robj *o);
 959 void freeZsetObject(robj *o);
 960 void freeHashObject(robj *o);
 961 robj *createObject(int type, void *ptr);
 962 robj *createStringObject(char *ptr, size_t len);
 963 robj *dupStringObject(robj *o);
 964 int isObjectRepresentableAsLongLong(robj *o, long long *llongval);
 965 robj *tryObjectEncoding(robj *o);
 966 robj *getDecodedObject(robj *o);
 967 size_t stringObjectLen(robj *o);
 968 robj *createStringObjectFromLongLong(long long value);
 969 robj *createStringObjectFromLongDouble(long double value);
 970 robj *createListObject(void);
 971 robj *createZiplistObject(void);
 972 robj *createSetObject(void);
 973 robj *createIntsetObject(void);
 974 robj *createHashObject(void);
 975 robj *createZsetObject(void);
 976 robj *createZsetZiplistObject(void);
 977 int getLongFromObjectOrReply(redisClient *c, robj *o, long *target, const char *msg);
 978 int checkType(redisClient *c, robj *o, int type);
 979 int getLongLongFromObjectOrReply(redisClient *c, robj *o, long long *target, const char *msg);
 980 int getDoubleFromObjectOrReply(redisClient *c, robj *o, double *target, const char *msg);
 981 int getLongLongFromObject(robj *o, long long *target);
 982 int getLongDoubleFromObject(robj *o, long double *target);
 983 int getLongDoubleFromObjectOrReply(redisClient *c, robj *o, long double *target, const char *msg);
 984 char *strEncoding(int encoding);
 985 int compareStringObjects(robj *a, robj *b);
 986 int equalStringObjects(robj *a, robj *b);
 987 unsigned long estimateObjectIdleTime(robj *o);
 988
 989 /* Synchronous I/O with timeout */
 990 ssize_t syncWrite(int fd, char *ptr, ssize_t size, long long timeout);
 991 ssize_t syncRead(int fd, char *ptr, ssize_t size, long long timeout);
 992 ssize_t syncReadLine(int fd, char *ptr, ssize_t size, long long timeout);
 993
 994 /* Replication */
 995 void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc);
 996 void replicationFeedMonitors(redisClient *c, list *monitors, int dictid, robj **argv, int argc);
 997 void updateSlavesWaitingBgsave(int bgsaveerr);
 998 void replicationCron(void);
 999
1000 /* Generic persistence functions */
1001 void startLoading(FILE *fp);
1002 void loadingProgress(off_t pos);
1003 void stopLoading(void);
1004
1005 /* RDB persistence */
1006 #include "rdb.h"
1007
1008 /* AOF persistence */
1009 void flushAppendOnlyFile(int force);
1010 void feedAppendOnlyFile(struct redisCommand *cmd, int dictid, robj **argv, int argc);
1011 void aofRemoveTempFile(pid_t childpid);
1012 int rewriteAppendOnlyFileBackground(void);
1013 int loadAppendOnlyFile(char *filename);
1014 void stopAppendOnly(void);
1015 int startAppendOnly(void);
1016 void backgroundRewriteDoneHandler(int exitcode, int bysignal);
1017 void aofRewriteBufferReset(void);
1018 unsigned long aofRewriteBufferSize(void);
1019
1020 /* Sorted sets data type */
1021
1022 /* Struct to hold a inclusive/exclusive range spec. */
1023 typedef struct {
1024     double min, max;
1025     int minex, maxex; /* are min or max exclusive? */
1026 } zrangespec;
1027
1028 zskiplist *zslCreate(void);
1029 void zslFree(zskiplist *zsl);
1030 zskiplistNode *zslInsert(zskiplist *zsl, double score, robj *obj);
1031 unsigned char *zzlInsert(unsigned char *zl, robj *ele, double score);
1032 int zslDelete(zskiplist *zsl, double score, robj *obj);
1033 zskiplistNode *zslFirstInRange(zskiplist *zsl, zrangespec range);
1034 double zzlGetScore(unsigned char *sptr);
1035 void zzlNext(unsigned char *zl, unsigned char **eptr, unsigned char **sptr);
1036 void zzlPrev(unsigned char *zl, unsigned char **eptr, unsigned char **sptr);
1037 unsigned int zsetLength(robj *zobj);
1038 void zsetConvert(robj *zobj, int encoding);
1039
1040 /* Core functions */
1041 int freeMemoryIfNeeded(void);
1042 int processCommand(redisClient *c);
1043 void setupSignalHandlers(void);
1044 struct redisCommand *lookupCommand(sds name);
1045 struct redisCommand *lookupCommandByCString(char *s);
1046 void call(redisClient *c, int flags);
1047 void propagate(struct redisCommand *cmd, int dbid, robj **argv, int argc, int flags);
1048 void alsoPropagate(struct redisCommand *cmd, int dbid, robj **argv, int argc, int target);
1049 int prepareForShutdown();
1050 void redisLog(int level, const char *fmt, ...);
1051 void redisLogRaw(int level, const char *msg);
1052 void redisLogFromHandler(int level, const char *msg);
1053 void usage();
1054 void updateDictResizePolicy(void);
1055 int htNeedsResize(dict *dict);
1056 void oom(const char *msg);
1057 void populateCommandTable(void);
1058 void resetCommandTableStats(void);
1059
1060 /* Set data type */
1061 robj *setTypeCreate(robj *value);
1062 int setTypeAdd(robj *subject, robj *value);
1063 int setTypeRemove(robj *subject, robj *value);
1064 int setTypeIsMember(robj *subject, robj *value);
1065 setTypeIterator *setTypeInitIterator(robj *subject);
1066 void setTypeReleaseIterator(setTypeIterator *si);
1067 int setTypeNext(setTypeIterator *si, robj **objele, int64_t *llele);
1068 robj *setTypeNextObject(setTypeIterator *si);
1069 int setTypeRandomElement(robj *setobj, robj **objele, int64_t *llele);
1070 unsigned long setTypeSize(robj *subject);
1071 void setTypeConvert(robj *subject, int enc);
1072
1073 /* Hash data type */
1074 void hashTypeConvert(robj *o, int enc);
1075 void hashTypeTryConversion(robj *subject, robj **argv, int start, int end);
1076 void hashTypeTryObjectEncoding(robj *subject, robj **o1, robj **o2);
1077 robj *hashTypeGetObject(robj *o, robj *key);
1078 int hashTypeExists(robj *o, robj *key);
1079 int hashTypeSet(robj *o, robj *key, robj *value);
1080 int hashTypeDelete(robj *o, robj *key);
1081 unsigned long hashTypeLength(robj *o);
1082 hashTypeIterator *hashTypeInitIterator(robj *subject);
1083 void hashTypeReleaseIterator(hashTypeIterator *hi);
1084 int hashTypeNext(hashTypeIterator *hi);
1085 void hashTypeCurrentFromZiplist(hashTypeIterator *hi, int what,
1086                                 unsigned char **vstr,
1087                                 unsigned int *vlen,
1088                                 long long *vll);
1089 void hashTypeCurrentFromHashTable(hashTypeIterator *hi, int what, robj **dst);
1090 robj *hashTypeCurrentObject(hashTypeIterator *hi, int what);
1091 robj *hashTypeLookupWriteOrCreate(redisClient *c, robj *key);
1092
1093 /* Pub / Sub */
1094 int pubsubUnsubscribeAllChannels(redisClient *c, int notify);
1095 int pubsubUnsubscribeAllPatterns(redisClient *c, int notify);
1096 void freePubsubPattern(void *p);
1097 int listMatchPubsubPattern(void *a, void *b);
1098 int pubsubPublishMessage(robj *channel, robj *message);
1099
1100 /* Configuration */
1101 void loadServerConfig(char *filename, char *options);
1102 void appendServerSaveParams(time_t seconds, int changes);
1103 void resetServerSaveParams();
1104
1105 /* db.c -- Keyspace access API */
1106 int removeExpire(redisDb *db, robj *key);
1107 void propagateExpire(redisDb *db, robj *key);
1108 int expireIfNeeded(redisDb *db, robj *key);
1109 long long getExpire(redisDb *db, robj *key);
1110 void setExpire(redisDb *db, robj *key, long long when);
1111 robj *lookupKey(redisDb *db, robj *key);
1112 robj *lookupKeyRead(redisDb *db, robj *key);
1113 robj *lookupKeyWrite(redisDb *db, robj *key);
1114 robj *lookupKeyReadOrReply(redisClient *c, robj *key, robj *reply);
1115 robj *lookupKeyWriteOrReply(redisClient *c, robj *key, robj *reply);
1116 void dbAdd(redisDb *db, robj *key, robj *val);
1117 void dbOverwrite(redisDb *db, robj *key, robj *val);
1118 void setKey(redisDb *db, robj *key, robj *val);
1119 int dbExists(redisDb *db, robj *key);
1120 robj *dbRandomKey(redisDb *db);
1121 int dbDelete(redisDb *db, robj *key);
1122 long long emptyDb();
1123 int selectDb(redisClient *c, int id);
1124 void signalModifiedKey(redisDb *db, robj *key);
1125 void signalFlushedDb(int dbid);
1126 unsigned int GetKeysInSlot(unsigned int hashslot, robj **keys, unsigned int count);
1127
1128 /* API to get key arguments from commands */
1129 #define REDIS_GETKEYS_ALL 0
1130 #define REDIS_GETKEYS_PRELOAD 1
1131 int *getKeysFromCommand(struct redisCommand *cmd, robj **argv, int argc, int *numkeys, int flags);
1132 void getKeysFreeResult(int *result);
1133 int *noPreloadGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags);
1134 int *renameGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags);
1135 int *zunionInterGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags);
1136
1137 /* Cluster */
1138 void clusterInit(void);
1139 unsigned short crc16(const char *buf, int len);
1140 unsigned int keyHashSlot(char *key, int keylen);
1141 clusterNode *createClusterNode(char *nodename, int flags);
1142 int clusterAddNode(clusterNode *node);
1143 void clusterCron(void);
1144 clusterNode *getNodeByQuery(redisClient *c, struct redisCommand *cmd, robj **argv, int argc, int *hashslot, int *ask);
1145 void clusterPropagatePublish(robj *channel, robj *message);
1146
1147 /* Sentinel */
1148 void initSentinelConfig(void);
1149 void initSentinel(void);
1150 void sentinelTimer(void);
1151 char *sentinelHandleConfiguration(char **argv, int argc);
1152
1153 /* Scripting */
1154 void scriptingInit(void);
1155
1156 /* Git SHA1 */
1157 char *redisGitSHA1(void);
1158 char *redisGitDirty(void);
1159
1160 /* Commands prototypes */
1161 void authCommand(redisClient *c);
1162 void pingCommand(redisClient *c);
1163 void echoCommand(redisClient *c);
1164 void setCommand(redisClient *c);
1165 void setnxCommand(redisClient *c);
1166 void setexCommand(redisClient *c);
1167 void psetexCommand(redisClient *c);
1168 void getCommand(redisClient *c);
1169 void delCommand(redisClient *c);
1170 void existsCommand(redisClient *c);
1171 void setbitCommand(redisClient *c);
1172 void getbitCommand(redisClient *c);
1173 void setrangeCommand(redisClient *c);
1174 void getrangeCommand(redisClient *c);
1175 void incrCommand(redisClient *c);
1176 void decrCommand(redisClient *c);
1177 void incrbyCommand(redisClient *c);
1178 void decrbyCommand(redisClient *c);
1179 void incrbyfloatCommand(redisClient *c);
1180 void selectCommand(redisClient *c);
1181 void randomkeyCommand(redisClient *c);
1182 void keysCommand(redisClient *c);
1183 void dbsizeCommand(redisClient *c);
1184 void lastsaveCommand(redisClient *c);
1185 void saveCommand(redisClient *c);
1186 void bgsaveCommand(redisClient *c);
1187 void bgrewriteaofCommand(redisClient *c);
1188 void shutdownCommand(redisClient *c);
1189 void moveCommand(redisClient *c);
1190 void renameCommand(redisClient *c);
1191 void renamenxCommand(redisClient *c);
1192 void lpushCommand(redisClient *c);
1193 void rpushCommand(redisClient *c);
1194 void lpushxCommand(redisClient *c);
1195 void rpushxCommand(redisClient *c);
1196 void linsertCommand(redisClient *c);
1197 void lpopCommand(redisClient *c);
1198 void rpopCommand(redisClient *c);
1199 void llenCommand(redisClient *c);
1200 void lindexCommand(redisClient *c);
1201 void lrangeCommand(redisClient *c);
1202 void ltrimCommand(redisClient *c);
1203 void typeCommand(redisClient *c);
1204 void lsetCommand(redisClient *c);
1205 void saddCommand(redisClient *c);
1206 void sremCommand(redisClient *c);
1207 void smoveCommand(redisClient *c);
1208 void sismemberCommand(redisClient *c);
1209 void scardCommand(redisClient *c);
1210 void spopCommand(redisClient *c);
1211 void srandmemberCommand(redisClient *c);
1212 void sinterCommand(redisClient *c);
1213 void sinterstoreCommand(redisClient *c);
1214 void sunionCommand(redisClient *c);
1215 void sunionstoreCommand(redisClient *c);
1216 void sdiffCommand(redisClient *c);
1217 void sdiffstoreCommand(redisClient *c);
1218 void syncCommand(redisClient *c);
1219 void flushdbCommand(redisClient *c);
1220 void flushallCommand(redisClient *c);
1221 void sortCommand(redisClient *c);
1222 void lremCommand(redisClient *c);
1223 void rpoplpushCommand(redisClient *c);
1224 void infoCommand(redisClient *c);
1225 void mgetCommand(redisClient *c);
1226 void monitorCommand(redisClient *c);
1227 void expireCommand(redisClient *c);
1228 void expireatCommand(redisClient *c);
1229 void pexpireCommand(redisClient *c);
1230 void pexpireatCommand(redisClient *c);
1231 void getsetCommand(redisClient *c);
1232 void ttlCommand(redisClient *c);
1233 void pttlCommand(redisClient *c);
1234 void persistCommand(redisClient *c);
1235 void slaveofCommand(redisClient *c);
1236 void debugCommand(redisClient *c);
1237 void msetCommand(redisClient *c);
1238 void msetnxCommand(redisClient *c);
1239 void zaddCommand(redisClient *c);
1240 void zincrbyCommand(redisClient *c);
1241 void zrangeCommand(redisClient *c);
1242 void zrangebyscoreCommand(redisClient *c);
1243 void zrevrangebyscoreCommand(redisClient *c);
1244 void zcountCommand(redisClient *c);
1245 void zrevrangeCommand(redisClient *c);
1246 void zcardCommand(redisClient *c);
1247 void zremCommand(redisClient *c);
1248 void zscoreCommand(redisClient *c);
1249 void zremrangebyscoreCommand(redisClient *c);
1250 void multiCommand(redisClient *c);
1251 void execCommand(redisClient *c);
1252 void discardCommand(redisClient *c);
1253 void blpopCommand(redisClient *c);
1254 void brpopCommand(redisClient *c);
1255 void brpoplpushCommand(redisClient *c);
1256 void appendCommand(redisClient *c);
1257 void strlenCommand(redisClient *c);
1258 void zrankCommand(redisClient *c);
1259 void zrevrankCommand(redisClient *c);
1260 void hsetCommand(redisClient *c);
1261 void hsetnxCommand(redisClient *c);
1262 void hgetCommand(redisClient *c);
1263 void hmsetCommand(redisClient *c);
1264 void hmgetCommand(redisClient *c);
1265 void hdelCommand(redisClient *c);
1266 void hlenCommand(redisClient *c);
1267 void zremrangebyrankCommand(redisClient *c);
1268 void zunionstoreCommand(redisClient *c);
1269 void zinterstoreCommand(redisClient *c);
1270 void hkeysCommand(redisClient *c);
1271 void hvalsCommand(redisClient *c);
1272 void hgetallCommand(redisClient *c);
1273 void hexistsCommand(redisClient *c);
1274 void configCommand(redisClient *c);
1275 void hincrbyCommand(redisClient *c);
1276 void hincrbyfloatCommand(redisClient *c);
1277 void subscribeCommand(redisClient *c);
1278 void unsubscribeCommand(redisClient *c);
1279 void psubscribeCommand(redisClient *c);
1280 void punsubscribeCommand(redisClient *c);
1281 void publishCommand(redisClient *c);
1282 void watchCommand(redisClient *c);
1283 void unwatchCommand(redisClient *c);
1284 void clusterCommand(redisClient *c);
1285 void restoreCommand(redisClient *c);
1286 void migrateCommand(redisClient *c);
1287 void askingCommand(redisClient *c);
1288 void dumpCommand(redisClient *c);
1289 void objectCommand(redisClient *c);
1290 void clientCommand(redisClient *c);
1291 void evalCommand(redisClient *c);
1292 void evalShaCommand(redisClient *c);
1293 void scriptCommand(redisClient *c);
1294 void timeCommand(redisClient *c);
1295 void bitopCommand(redisClient *c);
1296 void bitcountCommand(redisClient *c);
1297 void replconfCommand(redisClient *c);
1298
1299 #if defined(__GNUC__)
1300 void *calloc(size_t count, size_t size) __attribute__ ((deprecated));
1301 void free(void *ptr) __attribute__ ((deprecated));
1302 void *malloc(size_t size) __attribute__ ((deprecated));
1303 void *realloc(void *ptr, size_t size) __attribute__ ((deprecated));
1304 #endif
1305
1306 /* Debugging stuff */
1307 void _redisAssertWithInfo(redisClient *c, robj *o, char *estr, char *file, int line);
1308 void _redisAssert(char *estr, char *file, int line);
1309 void _redisPanic(char *msg, char *file, int line);
1310 void bugReportStart(void);
1311 void redisLogObjectDebugInfo(robj *o);
1312 void sigsegvHandler(int sig, siginfo_t *info, void *secret);
1313 sds genRedisInfoString(char *section);
1314 void enableWatchdog(int period);
1315 void disableWatchdog(void);
1316 void watchdogScheduleSignal(int period);
1317 void redisLogHexDump(int level, char *descr, void *value, size_t len);
1318
1319 #define redisDebug(fmt, ...) \
1320     printf("DEBUG %s:%d > " fmt "\n", __FILE__, __LINE__, __VA_ARGS__)
1321 #define redisDebugMark() \
1322     printf("-- MARK %s:%d --\n", __FILE__, __LINE__)
1323
1324 #endif