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