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