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