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