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