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