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