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