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