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