]> git.saurik.com Git - redis.git/blame - src/redis.h
Merge branch 'unstable' of github.com:antirez/redis into unstable
[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>
e2641e09 22
23#include "ae.h" /* Event driven programming library */
24#include "sds.h" /* Dynamic safe strings */
25#include "dict.h" /* Hash tables */
26#include "adlist.h" /* Linked lists */
27#include "zmalloc.h" /* total memory usage aware version of malloc/free */
28#include "anet.h" /* Networking the easy way */
29#include "zipmap.h" /* Compact string -> string data structure */
30#include "ziplist.h" /* Compact list data structure */
96ffb2fe 31#include "intset.h" /* Compact integer set structure */
e2641e09 32#include "version.h"
33
34/* Error codes */
35#define REDIS_OK 0
36#define REDIS_ERR -1
37
38/* Static server configuration */
39#define REDIS_SERVERPORT 6379 /* TCP port */
40#define REDIS_MAXIDLETIME (60*5) /* default client timeout */
41#define REDIS_IOBUF_LEN 1024
42#define REDIS_LOADBUF_LEN 1024
43#define REDIS_STATIC_ARGS 8
44#define REDIS_DEFAULT_DBNUM 16
45#define REDIS_CONFIGLINE_MAX 1024
e2641e09 46#define REDIS_MAX_SYNC_TIME 60 /* Slave can't take more to sync */
47#define REDIS_EXPIRELOOKUPS_PER_CRON 10 /* lookup 10 expires per loop */
48#define REDIS_MAX_WRITE_PER_EVENT (1024*64)
49#define REDIS_REQUEST_MAX_SIZE (1024*1024*256) /* max bytes in inline command */
50#define REDIS_SHARED_INTEGERS 10000
36c19d03 51#define REDIS_REPLY_CHUNK_BYTES (5*1500) /* 5 TCP packets with default MTU */
e1a586ee 52#define REDIS_MAX_LOGMSG_LEN 1024 /* Default maximum length of syslog messages */
834ef78e 53
e2641e09 54/* Hash table parameters */
55#define REDIS_HT_MINFILL 10 /* Minimal hash table fill 10% */
56
33aba595
PN
57/* Command flags:
58 * REDIS_CMD_DENYOOM:
59 * Commands marked with this flag will return an error when 'maxmemory' is
60 * set and the server is using more than 'maxmemory' bytes of memory.
61 * In short: commands with this flag are denied on low memory conditions.
62 * REDIS_CMD_FORCE_REPLICATION:
63 * Force replication even if dirty is 0. */
64#define REDIS_CMD_DENYOOM 4
65#define REDIS_CMD_FORCE_REPLICATION 8
e2641e09 66
67/* Object types */
68#define REDIS_STRING 0
69#define REDIS_LIST 1
70#define REDIS_SET 2
71#define REDIS_ZSET 3
72#define REDIS_HASH 4
73#define REDIS_VMPOINTER 8
2cc99365 74/* Object types only used for persistence in .rdb files */
75#define REDIS_HASH_ZIPMAP 9
9ad853cc 76#define REDIS_LIST_ZIPLIST 10
77#define REDIS_SET_INTSET 11
e2641e09 78
79/* Objects encoding. Some kind of objects like Strings and Hashes can be
80 * internally represented in multiple ways. The 'encoding' field of the object
81 * is set to one of this fields for this object. */
82#define REDIS_ENCODING_RAW 0 /* Raw representation */
83#define REDIS_ENCODING_INT 1 /* Encoded as integer */
84#define REDIS_ENCODING_HT 2 /* Encoded as hash table */
85#define REDIS_ENCODING_ZIPMAP 3 /* Encoded as zipmap */
86#define REDIS_ENCODING_LINKEDLIST 4 /* Encoded as regular linked list */
87#define REDIS_ENCODING_ZIPLIST 5 /* Encoded as ziplist */
96ffb2fe 88#define REDIS_ENCODING_INTSET 6 /* Encoded as intset */
0b7f6d09 89#define REDIS_ENCODING_SKIPLIST 7 /* Encoded as skiplist */
e2641e09 90
91/* Object types only used for dumping to disk */
92#define REDIS_EXPIRETIME 253
93#define REDIS_SELECTDB 254
94#define REDIS_EOF 255
95
96/* Defines related to the dump file format. To store 32 bits lengths for short
97 * keys requires a lot of space, so we check the most significant 2 bits of
98 * the first byte to interpreter the length:
99 *
100 * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
101 * 01|000000 00000000 => 01, the len is 14 byes, 6 bits + 8 bits of next byte
102 * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
103 * 11|000000 this means: specially encoded object will follow. The six bits
104 * number specify the kind of object that follows.
105 * See the REDIS_RDB_ENC_* defines.
106 *
107 * Lenghts up to 63 are stored using a single byte, most DB keys, and may
108 * values, will fit inside. */
109#define REDIS_RDB_6BITLEN 0
110#define REDIS_RDB_14BITLEN 1
111#define REDIS_RDB_32BITLEN 2
112#define REDIS_RDB_ENCVAL 3
113#define REDIS_RDB_LENERR UINT_MAX
114
115/* When a length of a string object stored on disk has the first two bits
116 * set, the remaining two bits specify a special encoding for the object
117 * accordingly to the following defines: */
118#define REDIS_RDB_ENC_INT8 0 /* 8 bit signed integer */
119#define REDIS_RDB_ENC_INT16 1 /* 16 bit signed integer */
120#define REDIS_RDB_ENC_INT32 2 /* 32 bit signed integer */
121#define REDIS_RDB_ENC_LZF 3 /* string compressed with FASTLZ */
122
3be00d7e 123/* Scheduled IO opeations flags. */
124#define REDIS_IO_LOAD 1
125#define REDIS_IO_SAVE 2
126#define REDIS_IO_LOADINPROG 4
127#define REDIS_IO_SAVEINPROG 8
16d77878 128
f771dc23 129/* Generic IO flags */
130#define REDIS_IO_ONLYLOADS 1
131#define REDIS_IO_ASAP 2
132
e2641e09 133#define REDIS_MAX_COMPLETED_JOBS_PROCESSED 1
f34a6cd8 134#define REDIS_THREAD_STACK_SIZE (1024*1024*4)
e2641e09 135
136/* Client flags */
137#define REDIS_SLAVE 1 /* This client is a slave server */
138#define REDIS_MASTER 2 /* This client is a master server */
139#define REDIS_MONITOR 4 /* This client is a slave monitor, see MONITOR */
140#define REDIS_MULTI 8 /* This client is in a MULTI context */
141#define REDIS_BLOCKED 16 /* The client is waiting in a blocking operation */
142#define REDIS_IO_WAIT 32 /* The client is waiting for Virtual Memory I/O */
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 */
cd8788f2
PN
147
148/* Client request types */
149#define REDIS_REQ_INLINE 1
150#define REDIS_REQ_MULTIBULK 2
e2641e09 151
152/* Slave replication state - slave side */
153#define REDIS_REPL_NONE 0 /* No active replication */
154#define REDIS_REPL_CONNECT 1 /* Must connect to master */
62ec599c 155#define REDIS_REPL_TRANSFER 2 /* Receiving .rdb from master */
f4aa600b 156#define REDIS_REPL_CONNECTED 3 /* Connected to master */
e2641e09 157
158/* Slave replication state - from the point of view of master
159 * Note that in SEND_BULK and ONLINE state the slave receives new updates
160 * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
161 * to start the next background saving in order to send updates to it. */
162#define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
163#define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
164#define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
165#define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */
166
167/* List related stuff */
168#define REDIS_HEAD 0
169#define REDIS_TAIL 1
170
171/* Sort operations */
172#define REDIS_SORT_GET 0
173#define REDIS_SORT_ASC 1
174#define REDIS_SORT_DESC 2
175#define REDIS_SORTKEY_MAX 1024
176
177/* Log levels */
178#define REDIS_DEBUG 0
179#define REDIS_VERBOSE 1
180#define REDIS_NOTICE 2
181#define REDIS_WARNING 3
182
183/* Anti-warning macro... */
184#define REDIS_NOTUSED(V) ((void) V)
185
186#define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
187#define ZSKIPLIST_P 0.25 /* Skiplist P = 1/4 */
188
189/* Append only defines */
190#define APPENDFSYNC_NO 0
191#define APPENDFSYNC_ALWAYS 1
192#define APPENDFSYNC_EVERYSEC 2
193
194/* Zip structure related defaults */
52dc87bb 195#define REDIS_HASH_MAX_ZIPMAP_ENTRIES 512
196#define REDIS_HASH_MAX_ZIPMAP_VALUE 64
6a246b1e 197#define REDIS_LIST_MAX_ZIPLIST_ENTRIES 512
198#define REDIS_LIST_MAX_ZIPLIST_VALUE 64
199#define REDIS_SET_MAX_INTSET_ENTRIES 512
e2641e09 200
201/* Sets operations codes */
202#define REDIS_OP_UNION 0
203#define REDIS_OP_DIFF 1
204#define REDIS_OP_INTER 2
205
165346ca 206/* Redis maxmemory strategies */
207#define REDIS_MAXMEMORY_VOLATILE_LRU 0
208#define REDIS_MAXMEMORY_VOLATILE_TTL 1
209#define REDIS_MAXMEMORY_VOLATILE_RANDOM 2
210#define REDIS_MAXMEMORY_ALLKEYS_LRU 3
211#define REDIS_MAXMEMORY_ALLKEYS_RANDOM 4
5402c426 212#define REDIS_MAXMEMORY_NO_EVICTION 5
165346ca 213
36c17a53 214/* Diskstore background saving thread states */
215#define REDIS_BGSAVE_THREAD_UNACTIVE 0
216#define REDIS_BGSAVE_THREAD_ACTIVE 1
217#define REDIS_BGSAVE_THREAD_DONE_OK 2
218#define REDIS_BGSAVE_THREAD_DONE_ERR 3
219
e2641e09 220/* We can print the stacktrace, so our assert is defined this way: */
221#define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1)))
222#define redisPanic(_e) _redisPanic(#_e,__FILE__,__LINE__),_exit(1)
223void _redisAssert(char *estr, char *file, int line);
224void _redisPanic(char *msg, char *file, int line);
225
226/*-----------------------------------------------------------------------------
227 * Data types
228 *----------------------------------------------------------------------------*/
229
230/* A redis object, that is a type able to hold a string / list / set */
231
232/* The actual Redis Object */
ef59a8bc 233#define REDIS_LRU_CLOCK_MAX ((1<<21)-1) /* Max value of obj->lru */
165346ca 234#define REDIS_LRU_CLOCK_RESOLUTION 10 /* LRU clock resolution in seconds */
e2641e09 235typedef struct redisObject {
236 unsigned type:4;
3be00d7e 237 unsigned notused:2; /* Not used */
e2641e09 238 unsigned encoding:4;
239 unsigned lru:22; /* lru time (relative to server.lruclock) */
240 int refcount;
241 void *ptr;
242 /* VM fields are only allocated if VM is active, otherwise the
243 * object allocation function will just allocate
244 * sizeof(redisObjct) minus sizeof(redisObjectVM), so using
245 * Redis without VM active will not have any overhead. */
246} robj;
247
248/* The VM pointer structure - identifies an object in the swap file.
249 *
250 * This object is stored in place of the value
251 * object in the main key->value hash table representing a database.
252 * Note that the first fields (type, storage) are the same as the redisObject
253 * structure so that vmPointer strucuters can be accessed even when casted
254 * as redisObject structures.
255 *
256 * This is useful as we don't know if a value object is or not on disk, but we
257 * are always able to read obj->storage to check this. For vmPointer
258 * structures "type" is set to REDIS_VMPOINTER (even if without this field
259 * is still possible to check the kind of object from the value of 'storage').*/
260typedef struct vmPointer {
261 unsigned type:4;
262 unsigned storage:2; /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
263 unsigned notused:26;
264 unsigned int vtype; /* type of the object stored in the swap file */
265 off_t page; /* the page at witch the object is stored on disk */
266 off_t usedpages; /* number of pages used on disk */
267} vmpointer;
268
269/* Macro used to initalize a Redis object allocated on the stack.
270 * Note that this macro is taken near the structure definition to make sure
271 * we'll update it when the structure is changed, to avoid bugs like
272 * bug #85 introduced exactly in this way. */
273#define initStaticStringObject(_var,_ptr) do { \
274 _var.refcount = 1; \
275 _var.type = REDIS_STRING; \
276 _var.encoding = REDIS_ENCODING_RAW; \
277 _var.ptr = _ptr; \
e2641e09 278} while(0);
279
280typedef struct redisDb {
281 dict *dict; /* The keyspace for this DB */
282 dict *expires; /* Timeout of keys with a timeout set */
283 dict *blocking_keys; /* Keys with clients waiting for data (BLPOP) */
3be00d7e 284 dict *io_keys; /* Keys with clients waiting for DS I/O */
d934e1e8 285 dict *io_negcache; /* Negative caching for disk store */
3be00d7e 286 dict *io_queued; /* Queued IO operations hash table */
e2641e09 287 dict *watched_keys; /* WATCHED keys for MULTI/EXEC CAS */
288 int id;
289} redisDb;
290
291/* Client MULTI/EXEC state */
292typedef struct multiCmd {
293 robj **argv;
294 int argc;
295 struct redisCommand *cmd;
296} multiCmd;
297
298typedef struct multiState {
299 multiCmd *commands; /* Array of MULTI commands */
300 int count; /* Total number of MULTI commands */
301} multiState;
302
357a8417
DJMM
303typedef struct blockingState {
304 robj **keys; /* The key we are waiting to terminate a blocking
305 * operation such as BLPOP. Otherwise NULL. */
306 int count; /* Number of blocking keys */
307 time_t timeout; /* Blocking operation timeout. If UNIX current time
308 * is >= timeout then the operation timed out. */
309 robj *target; /* The key that should receive the element,
310 * for BRPOPLPUSH. */
311} blockingState;
312
e2641e09 313/* With multiplexing we need to take per-clinet state.
314 * Clients are taken in a liked list. */
315typedef struct redisClient {
316 int fd;
317 redisDb *db;
318 int dictid;
319 sds querybuf;
cd8788f2
PN
320 int argc;
321 robj **argv;
322 int reqtype;
323 int multibulklen; /* number of multi bulk arguments left to read */
324 long bulklen; /* length of bulk argument in multi bulk request */
e2641e09 325 list *reply;
326 int sentlen;
327 time_t lastinteraction; /* time of the last interaction, used for timeout */
328 int flags; /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
329 int slaveseldb; /* slave selected db, if this client is a slave */
330 int authenticated; /* when requirepass is non-NULL */
331 int replstate; /* replication state if this is a slave */
332 int repldbfd; /* replication DB file descriptor */
333 long repldboff; /* replication DB file offset */
334 off_t repldbsize; /* replication DB file size */
335 multiState mstate; /* MULTI/EXEC state */
e3c51c4b 336 blockingState bpop; /* blocking state */
e2641e09 337 list *io_keys; /* Keys this client is waiting to be loaded from the
338 * swap file in order to continue. */
339 list *watched_keys; /* Keys WATCHED for MULTI/EXEC CAS */
340 dict *pubsub_channels; /* channels a client is interested in (SUBSCRIBE) */
341 list *pubsub_patterns; /* patterns a client is interested in (SUBSCRIBE) */
834ef78e
PN
342
343 /* Response buffer */
344 int bufpos;
f3357792 345 char buf[REDIS_REPLY_CHUNK_BYTES];
e2641e09 346} redisClient;
347
348struct saveparam {
349 time_t seconds;
350 int changes;
351};
352
353struct sharedObjectsStruct {
354 robj *crlf, *ok, *err, *emptybulk, *czero, *cone, *cnegone, *pong, *space,
355 *colon, *nullbulk, *nullmultibulk, *queued,
356 *emptymultibulk, *wrongtypeerr, *nokeyerr, *syntaxerr, *sameobjecterr,
97e7f8ae 357 *outofrangeerr, *loadingerr, *plus,
e2641e09 358 *select0, *select1, *select2, *select3, *select4,
359 *select5, *select6, *select7, *select8, *select9,
360 *messagebulk, *pmessagebulk, *subscribebulk, *unsubscribebulk, *mbulk3,
361 *mbulk4, *psubscribebulk, *punsubscribebulk,
362 *integers[REDIS_SHARED_INTEGERS];
363};
364
ecc91094 365/*-----------------------------------------------------------------------------
366 * Redis cluster data structures
367 *----------------------------------------------------------------------------*/
368
369#define REDIS_CLUSTER_SLOTS 4096
370#define REDIS_CLUSTER_OK 0 /* Everything looks ok */
371#define REDIS_CLUSTER_FAIL 1 /* The cluster can't work */
372#define REDIS_CLUSTER_NEEDHELP 2 /* The cluster works, but needs some help */
373#define REDIS_CLUSTER_NAMELEN 40 /* sha1 hex length */
374#define REDIS_CLUSTER_PORT_INCR 10000 /* Cluster port = baseport + PORT_INCR */
375
376struct clusterNode;
377
378/* clusterLink encapsulates everything needed to talk with a remote node. */
379typedef struct clusterLink {
380 int fd; /* TCP socket file descriptor */
381 sds sndbuf; /* Packet send buffer */
382 sds rcvbuf; /* Packet reception buffer */
383 struct clusterNode *node; /* Node related to this link if any, or NULL */
384} clusterLink;
385
386/* Node flags */
387#define REDIS_NODE_MASTER 1 /* The node is a master */
388#define REDIS_NODE_SLAVE 2 /* The node is a slave */
389#define REDIS_NODE_PFAIL 4 /* Failure? Need acknowledge */
390#define REDIS_NODE_FAIL 8 /* The node is believed to be malfunctioning */
391#define REDIS_NODE_MYSELF 16 /* This node is myself */
392#define REDIS_NODE_HANDSHAKE 32 /* We have still to exchange the first ping */
393#define REDIS_NODE_NOADDR 64 /* We don't know the address of this node */
394#define REDIS_NODE_MEET 128 /* Send a MEET message to this node */
395#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"
396
397struct clusterNode {
398 char name[REDIS_CLUSTER_NAMELEN]; /* Node name, hex string, sha1-size */
399 int flags; /* REDIS_NODE_... */
400 unsigned char slots[REDIS_CLUSTER_SLOTS/8]; /* slots handled by this node */
401 int numslaves; /* Number of slave nodes, if this is a master */
402 struct clusterNode **slaves; /* pointers to slave nodes */
403 struct clusterNode *slaveof; /* pointer to the master node */
404 time_t ping_sent; /* Unix time we sent latest ping */
405 time_t pong_received; /* Unix time we received the pong */
406 char *configdigest; /* Configuration digest of this node */
407 time_t configdigest_ts; /* Configuration digest timestamp */
408 char ip[16]; /* Latest known IP address of this node */
409 int port; /* Latest known port of this node */
410 clusterLink *link; /* TCP/IP link with this node */
411};
412typedef struct clusterNode clusterNode;
413
414typedef struct {
ef21ab96 415 char *configfile;
ecc91094 416 clusterNode *myself; /* This node */
417 int state; /* REDIS_CLUSTER_OK, REDIS_CLUSTER_FAIL, ... */
418 int node_timeout;
419 dict *nodes; /* Hash table of name -> clusterNode structures */
420 clusterNode *migrating_slots_to[REDIS_CLUSTER_SLOTS];
421 clusterNode *importing_slots_from[REDIS_CLUSTER_SLOTS];
422 clusterNode *slots[REDIS_CLUSTER_SLOTS];
423} clusterState;
424
425/* Redis cluster messages header */
426
427/* Note that the PING, PONG and MEET messages are actually the same exact
428 * kind of packet. PONG is the reply to ping, in the extact format as a PING,
429 * while MEET is a special PING that forces the receiver to add the sender
430 * as a node (if it is not already in the list). */
431#define CLUSTERMSG_TYPE_PING 0 /* Ping */
432#define CLUSTERMSG_TYPE_PONG 1 /* Pong (reply to Ping) */
433#define CLUSTERMSG_TYPE_MEET 2 /* Meet "let's join" message */
434#define CLUSTERMSG_TYPE_FAIL 3 /* Mark node xxx as failing */
435
436/* Initially we don't know our "name", but we'll find it once we connect
437 * to the first node, using the getsockname() function. Then we'll use this
438 * address for all the next messages. */
439typedef struct {
440 char nodename[REDIS_CLUSTER_NAMELEN];
441 uint32_t ping_sent;
442 uint32_t pong_received;
443 char ip[16]; /* IP address last time it was seen */
444 uint16_t port; /* port last time it was seen */
445 uint16_t flags;
446 uint32_t notused; /* for 64 bit alignment */
447} clusterMsgDataGossip;
448
449typedef struct {
450 char nodename[REDIS_CLUSTER_NAMELEN];
451} clusterMsgDataFail;
452
453union clusterMsgData {
454 /* PING, MEET and PONG */
455 struct {
456 /* Array of N clusterMsgDataGossip structures */
457 clusterMsgDataGossip gossip[1];
458 } ping;
459 /* FAIL */
460 struct {
461 clusterMsgDataFail about;
462 } fail;
463};
464
465typedef struct {
466 uint32_t totlen; /* Total length of this message */
467 uint16_t type; /* Message type */
468 uint16_t count; /* Only used for some kind of messages. */
469 char sender[REDIS_CLUSTER_NAMELEN]; /* Name of the sender node */
470 unsigned char myslots[REDIS_CLUSTER_SLOTS/8];
471 char slaveof[REDIS_CLUSTER_NAMELEN];
472 char configdigest[32];
473 uint16_t port; /* Sender TCP base port */
474 unsigned char state; /* Cluster state from the POV of the sender */
475 unsigned char notused[5]; /* Reserved for future use. For alignment. */
476 union clusterMsgData data;
477} clusterMsg;
478
479/*-----------------------------------------------------------------------------
480 * Global server state
481 *----------------------------------------------------------------------------*/
482
e2641e09 483struct redisServer {
5b831607 484 /* General */
0e5441d8 485 pthread_t mainthread;
5b831607 486 redisDb *db;
487 dict *commands; /* Command table hahs table */
488 aeEventLoop *el;
489 /* Networking */
e2641e09 490 int port;
a5639e7d 491 char *bindaddr;
5d10923f 492 char *unixsocket;
a5639e7d
PN
493 int ipfd;
494 int sofd;
ecc91094 495 int cfd;
e2641e09 496 list *clients;
5b831607 497 list *slaves, *monitors;
498 char neterr[ANET_ERR_LEN];
97e7f8ae 499 /* RDB / AOF loading information */
500 int loading;
501 off_t loading_total_bytes;
502 off_t loading_loaded_bytes;
503 time_t loading_start_time;
4ebfc455 504 /* Fast pointers to often looked up command */
505 struct redisCommand *delCommand, *multiCommand;
e2641e09 506 int cronloops; /* number of times the cron function run */
53eeeaff 507 time_t lastsave; /* Unix time of last save succeeede */
e2641e09 508 /* Fields used only for stats */
53eeeaff 509 time_t stat_starttime; /* server start time */
510 long long stat_numcommands; /* number of processed commands */
511 long long stat_numconnections; /* number of connections received */
512 long long stat_expiredkeys; /* number of expired keys */
f21779ff 513 long long stat_evictedkeys; /* number of evicted keys (maxmemory) */
53eeeaff 514 long long stat_keyspace_hits; /* number of successful lookups of keys */
515 long long stat_keyspace_misses; /* number of failed lookups of keys */
e2641e09 516 /* Configuration */
517 int verbosity;
e2641e09 518 int maxidletime;
519 int dbnum;
520 int daemonize;
521 int appendonly;
522 int appendfsync;
523 int no_appendfsync_on_rewrite;
524 int shutdown_asap;
36c17a53 525 int activerehashing;
526 char *requirepass;
527 /* Persistence */
5b831607 528 long long dirty; /* changes to DB from the last save */
529 long long dirty_before_bgsave; /* used to restore dirty on failed BGSAVE */
e2641e09 530 time_t lastfsync;
531 int appendfd;
532 int appendseldb;
533 char *pidfile;
534 pid_t bgsavechildpid;
535 pid_t bgrewritechildpid;
36c17a53 536 int bgsavethread_state;
537 pthread_mutex_t bgsavethread_mutex;
538 pthread_t bgsavethread;
e2641e09 539 sds bgrewritebuf; /* buffer taken by parent during oppend only rewrite */
540 sds aofbuf; /* AOF buffer, written before entering the event loop */
541 struct saveparam *saveparams;
542 int saveparamslen;
36c17a53 543 char *dbfilename;
544 int rdbcompression;
545 char *appendfilename;
546 /* Logging */
e2641e09 547 char *logfile;
e1a586ee
JH
548 int syslog_enabled;
549 char *syslog_ident;
550 int syslog_facility;
e2641e09 551 /* Replication related */
552 int isslave;
f4aa600b 553 /* Slave specific fields */
e2641e09 554 char *masterauth;
555 char *masterhost;
556 int masterport;
557 redisClient *master; /* client that is master for this slave */
f4aa600b 558 int replstate; /* replication status if the instance is a slave */
62ec599c 559 off_t repl_transfer_left; /* bytes left reading .rdb */
f4aa600b 560 int repl_transfer_s; /* slave -> master SYNC socket */
561 int repl_transfer_fd; /* slave -> master SYNC temp file descriptor */
562 char *repl_transfer_tmpfile; /* slave-> master SYNC temp file name */
563 time_t repl_transfer_lastio; /* unix time of the latest read, for timeout */
4ebfc455 564 int repl_serve_stale_data; /* Serve stale data when link is down? */
f4aa600b 565 /* Limits */
e2641e09 566 unsigned int maxclients;
567 unsigned long long maxmemory;
165346ca 568 int maxmemory_policy;
569 int maxmemory_samples;
f4aa600b 570 /* Blocked clients */
5fa95ad7 571 unsigned int bpop_blocked_clients;
697af434 572 unsigned int cache_blocked_clients;
cea8c5cd 573 list *unblocked_clients; /* list of clients to unblock before next loop */
3be00d7e 574 list *cache_io_queue; /* IO operations queue */
cea8c5cd 575 int cache_flush_delay; /* seconds to wait before flushing keys */
e2641e09 576 /* Sort parameters - qsort_r() is only available under BSD so we
577 * have to take this state global, in order to pass it to sortCompare() */
578 int sort_desc;
579 int sort_alpha;
580 int sort_bypattern;
581 /* Virtual memory configuration */
697af434 582 int ds_enabled; /* backend disk in redis.conf */
583 char *ds_path; /* location of the disk store on disk */
584 unsigned long long cache_max_memory;
e2641e09 585 /* Zip structure config */
586 size_t hash_max_zipmap_entries;
587 size_t hash_max_zipmap_value;
588 size_t list_max_ziplist_entries;
589 size_t list_max_ziplist_value;
96ffb2fe 590 size_t set_max_intset_entries;
e2641e09 591 time_t unixtime; /* Unix time sampled every second. */
592 /* Virtual memory I/O threads stuff */
593 /* An I/O thread process an element taken from the io_jobs queue and
594 * put the result of the operation in the io_done list. While the
595 * job is being processed, it's put on io_processing queue. */
596 list *io_newjobs; /* List of VM I/O jobs yet to be processed */
597 list *io_processing; /* List of VM I/O jobs being processed */
598 list *io_processed; /* List of VM I/O jobs already processed */
599 list *io_ready_clients; /* Clients ready to be unblocked. All keys loaded */
600 pthread_mutex_t io_mutex; /* lock to access io_jobs/io_done/io_thread_job */
98a9abb6 601 pthread_cond_t io_condvar; /* I/O threads conditional variable */
e2641e09 602 pthread_attr_t io_threads_attr; /* attributes for threads creation */
603 int io_active_threads; /* Number of running I/O threads */
604 int vm_max_threads; /* Max number of I/O threads running at the same time */
605 /* Our main thread is blocked on the event loop, locking for sockets ready
606 * to be read or written, so when a threaded I/O operation is ready to be
607 * processed by the main thread, the I/O thread will use a unix pipe to
608 * awake the main thread. The followings are the two pipe FDs. */
609 int io_ready_pipe_read;
610 int io_ready_pipe_write;
611 /* Virtual memory stats */
612 unsigned long long vm_stats_used_pages;
613 unsigned long long vm_stats_swapped_objects;
614 unsigned long long vm_stats_swapouts;
615 unsigned long long vm_stats_swapins;
616 /* Pubsub */
617 dict *pubsub_channels; /* Map channels to list of subscribed clients */
618 list *pubsub_patterns; /* A list of pubsub_patterns */
619 /* Misc */
e2641e09 620 unsigned lruclock:22; /* clock incrementing every minute, for LRU */
621 unsigned lruclock_padding:10;
ecc91094 622 int cluster_enabled;
623 clusterState cluster;
e2641e09 624};
625
626typedef struct pubsubPattern {
627 redisClient *client;
628 robj *pattern;
629} pubsubPattern;
630
631typedef void redisCommandProc(redisClient *c);
9791f0f8 632typedef int *redisGetKeysProc(struct redisCommand *cmd, robj **argv, int argc, int *numkeys, int flags);
e2641e09 633struct redisCommand {
634 char *name;
635 redisCommandProc *proc;
636 int arity;
637 int flags;
9791f0f8 638 /* Use a function to determine keys arguments in a command line.
639 * Used both for diskstore preloading and Redis Cluster. */
640 redisGetKeysProc *getkeys_proc;
e2641e09 641 /* What keys should be loaded in background when calling this command? */
9791f0f8 642 int firstkey; /* The first argument that's a key (0 = no keys) */
643 int lastkey; /* THe last argument that's a key */
644 int keystep; /* The step between first and last key */
0d808ef2 645 long long microseconds, calls;
e2641e09 646};
647
648struct redisFunctionSym {
649 char *name;
650 unsigned long pointer;
651};
652
653typedef struct _redisSortObject {
654 robj *obj;
655 union {
656 double score;
657 robj *cmpobj;
658 } u;
659} redisSortObject;
660
661typedef struct _redisSortOperation {
662 int type;
663 robj *pattern;
664} redisSortOperation;
665
666/* ZSETs use a specialized version of Skiplists */
e2641e09 667typedef struct zskiplistNode {
e2641e09 668 robj *obj;
2159782b
PN
669 double score;
670 struct zskiplistNode *backward;
671 struct zskiplistLevel {
672 struct zskiplistNode *forward;
673 unsigned int span;
674 } level[];
e2641e09 675} zskiplistNode;
676
677typedef struct zskiplist {
678 struct zskiplistNode *header, *tail;
679 unsigned long length;
680 int level;
681} zskiplist;
682
683typedef struct zset {
684 dict *dict;
685 zskiplist *zsl;
686} zset;
687
3be00d7e 688/* DIsk store threaded I/O request message */
f34a6cd8 689#define REDIS_IOJOB_LOAD 0
690#define REDIS_IOJOB_SAVE 1
691
e2641e09 692typedef struct iojob {
693 int type; /* Request type, REDIS_IOJOB_* */
694 redisDb *db;/* Redis database */
f34a6cd8 695 robj *key; /* This I/O request is about this key */
696 robj *val; /* the value to swap for REDIS_IOJOB_SAVE, otherwise this
697 * field is populated by the I/O thread for REDIS_IOJOB_LOAD. */
4ab98823 698 time_t expire; /* Expire time for this key on REDIS_IOJOB_LOAD */
e2641e09 699} iojob;
700
3be00d7e 701/* IO operations scheduled -- check dscache.c for more info */
702typedef struct ioop {
703 int type;
cea8c5cd 704 redisDb *db;
705 robj *key;
706 time_t ctime; /* This is the creation time of the entry. */
3be00d7e 707} ioop;
cea8c5cd 708
e2641e09 709/* Structure to hold list iteration abstraction. */
710typedef struct {
711 robj *subject;
712 unsigned char encoding;
713 unsigned char direction; /* Iteration direction */
714 unsigned char *zi;
715 listNode *ln;
716} listTypeIterator;
717
718/* Structure for an entry while iterating over a list. */
719typedef struct {
720 listTypeIterator *li;
721 unsigned char *zi; /* Entry in ziplist */
722 listNode *ln; /* Entry in linked list */
723} listTypeEntry;
724
96ffb2fe
PN
725/* Structure to hold set iteration abstraction. */
726typedef struct {
727 robj *subject;
728 int encoding;
729 int ii; /* intset iterator */
730 dictIterator *di;
cb72d0f1 731} setTypeIterator;
96ffb2fe 732
e2641e09 733/* Structure to hold hash iteration abstration. Note that iteration over
734 * hashes involves both fields and values. Because it is possible that
735 * not both are required, store pointers in the iterator to avoid
736 * unnecessary memory allocation for fields/values. */
737typedef struct {
738 int encoding;
739 unsigned char *zi;
740 unsigned char *zk, *zv;
741 unsigned int zklen, zvlen;
742
743 dictIterator *di;
744 dictEntry *de;
745} hashTypeIterator;
746
747#define REDIS_HASH_KEY 1
748#define REDIS_HASH_VALUE 2
749
750/*-----------------------------------------------------------------------------
751 * Extern declarations
752 *----------------------------------------------------------------------------*/
753
754extern struct redisServer server;
755extern struct sharedObjectsStruct shared;
756extern dictType setDictType;
757extern dictType zsetDictType;
ecc91094 758extern dictType clusterNodesDictType;
e2641e09 759extern double R_Zero, R_PosInf, R_NegInf, R_Nan;
760dictType hashDictType;
761
762/*-----------------------------------------------------------------------------
763 * Functions prototypes
764 *----------------------------------------------------------------------------*/
765
419e1cca 766/* Utils */
767long long ustime(void);
768
e2641e09 769/* networking.c -- Networking and Client related operations */
770redisClient *createClient(int fd);
771void closeTimedoutClients(void);
772void freeClient(redisClient *c);
773void resetClient(redisClient *c);
774void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask);
e2641e09 775void addReply(redisClient *c, robj *obj);
b301c1fc
PN
776void *addDeferredMultiBulkLength(redisClient *c);
777void setDeferredMultiBulkLength(redisClient *c, void *node, long length);
e2641e09 778void addReplySds(redisClient *c, sds s);
779void processInputBuffer(redisClient *c);
ab17b909
PN
780void acceptTcpHandler(aeEventLoop *el, int fd, void *privdata, int mask);
781void acceptUnixHandler(aeEventLoop *el, int fd, void *privdata, int mask);
e2641e09 782void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask);
783void addReplyBulk(redisClient *c, robj *obj);
784void addReplyBulkCString(redisClient *c, char *s);
d51ebef5 785void addReplyBulkCBuffer(redisClient *c, void *p, size_t len);
786void addReplyBulkLongLong(redisClient *c, long long ll);
e2641e09 787void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask);
788void addReply(redisClient *c, robj *obj);
789void addReplySds(redisClient *c, sds s);
3ab20376
PN
790void addReplyError(redisClient *c, char *err);
791void addReplyStatus(redisClient *c, char *status);
e2641e09 792void addReplyDouble(redisClient *c, double d);
793void addReplyLongLong(redisClient *c, long long ll);
0537e7bf 794void addReplyMultiBulkLen(redisClient *c, long length);
e2641e09 795void *dupClientReplyValue(void *o);
7a1fd61e 796void getClientsMaxBuffers(unsigned long *longest_output_list,
797 unsigned long *biggest_input_buffer);
e2641e09 798
3ab20376
PN
799#ifdef __GNUC__
800void addReplyErrorFormat(redisClient *c, const char *fmt, ...)
801 __attribute__((format(printf, 2, 3)));
802void addReplyStatusFormat(redisClient *c, const char *fmt, ...)
803 __attribute__((format(printf, 2, 3)));
804#else
805void addReplyErrorFormat(redisClient *c, const char *fmt, ...);
806void addReplyStatusFormat(redisClient *c, const char *fmt, ...);
807#endif
808
e2641e09 809/* List data type */
810void listTypeTryConversion(robj *subject, robj *value);
811void listTypePush(robj *subject, robj *value, int where);
812robj *listTypePop(robj *subject, int where);
813unsigned long listTypeLength(robj *subject);
814listTypeIterator *listTypeInitIterator(robj *subject, int index, unsigned char direction);
815void listTypeReleaseIterator(listTypeIterator *li);
816int listTypeNext(listTypeIterator *li, listTypeEntry *entry);
817robj *listTypeGet(listTypeEntry *entry);
818void listTypeInsert(listTypeEntry *entry, robj *value, int where);
819int listTypeEqual(listTypeEntry *entry, robj *o);
820void listTypeDelete(listTypeEntry *entry);
821void listTypeConvert(robj *subject, int enc);
822void unblockClientWaitingData(redisClient *c);
823int handleClientsWaitingListPush(redisClient *c, robj *key, robj *ele);
824void popGenericCommand(redisClient *c, int where);
825
826/* MULTI/EXEC/WATCH... */
827void unwatchAllKeys(redisClient *c);
828void initClientMultiState(redisClient *c);
829void freeClientMultiState(redisClient *c);
830void queueMultiCommand(redisClient *c, struct redisCommand *cmd);
831void touchWatchedKey(redisDb *db, robj *key);
832void touchWatchedKeysOnFlush(int dbid);
833
834/* Redis object implementation */
835void decrRefCount(void *o);
836void incrRefCount(robj *o);
837void freeStringObject(robj *o);
838void freeListObject(robj *o);
839void freeSetObject(robj *o);
840void freeZsetObject(robj *o);
841void freeHashObject(robj *o);
842robj *createObject(int type, void *ptr);
843robj *createStringObject(char *ptr, size_t len);
844robj *dupStringObject(robj *o);
845robj *tryObjectEncoding(robj *o);
846robj *getDecodedObject(robj *o);
847size_t stringObjectLen(robj *o);
e2641e09 848robj *createStringObjectFromLongLong(long long value);
849robj *createListObject(void);
850robj *createZiplistObject(void);
851robj *createSetObject(void);
96ffb2fe 852robj *createIntsetObject(void);
e2641e09 853robj *createHashObject(void);
854robj *createZsetObject(void);
855int getLongFromObjectOrReply(redisClient *c, robj *o, long *target, const char *msg);
856int checkType(redisClient *c, robj *o, int type);
857int getLongLongFromObjectOrReply(redisClient *c, robj *o, long long *target, const char *msg);
858int getDoubleFromObjectOrReply(redisClient *c, robj *o, double *target, const char *msg);
859int getLongLongFromObject(robj *o, long long *target);
860char *strEncoding(int encoding);
861int compareStringObjects(robj *a, robj *b);
862int equalStringObjects(robj *a, robj *b);
ef59a8bc 863unsigned long estimateObjectIdleTime(robj *o);
e2641e09 864
19e61097 865/* Synchronous I/O with timeout */
866int syncWrite(int fd, char *ptr, ssize_t size, int timeout);
867int syncRead(int fd, char *ptr, ssize_t size, int timeout);
868int syncReadLine(int fd, char *ptr, ssize_t size, int timeout);
d08fac3e 869int fwriteBulkString(FILE *fp, char *s, unsigned long len);
870int fwriteBulkDouble(FILE *fp, double d);
871int fwriteBulkLongLong(FILE *fp, long long l);
244201f6 872int fwriteBulkObject(FILE *fp, robj *obj);
ecc91094 873int fwriteBulkCount(FILE *fp, char prefix, int count);
19e61097 874
e2641e09 875/* Replication */
876void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc);
877void replicationFeedMonitors(list *monitors, int dictid, robj **argv, int argc);
878int syncWithMaster(void);
879void updateSlavesWaitingBgsave(int bgsaveerr);
f4aa600b 880void replicationCron(void);
e2641e09 881
97e7f8ae 882/* Generic persistence functions */
883void startLoading(FILE *fp);
884void loadingProgress(off_t pos);
885void stopLoading(void);
886
e2641e09 887/* RDB persistence */
888int rdbLoad(char *filename);
889int rdbSaveBackground(char *filename);
890void rdbRemoveTempFile(pid_t childpid);
891int rdbSave(char *filename);
892int rdbSaveObject(FILE *fp, robj *o);
bd70a5f5
PN
893off_t rdbSavedObjectLen(robj *o);
894off_t rdbSavedObjectPages(robj *o);
e2641e09 895robj *rdbLoadObject(int type, FILE *fp);
5b8ce853 896void backgroundSaveDoneHandler(int exitcode, int bysignal);
05600eb8 897int rdbSaveKeyValuePair(FILE *fp, robj *key, robj *val, time_t expireitme, time_t now);
1fce3201 898int rdbLoadType(FILE *fp);
899time_t rdbLoadTime(FILE *fp);
900robj *rdbLoadStringObject(FILE *fp);
f03fe802 901int rdbSaveType(FILE *fp, unsigned char type);
902int rdbSaveLen(FILE *fp, uint32_t len);
e2641e09 903
904/* AOF persistence */
905void flushAppendOnlyFile(void);
906void feedAppendOnlyFile(struct redisCommand *cmd, int dictid, robj **argv, int argc);
907void aofRemoveTempFile(pid_t childpid);
908int rewriteAppendOnlyFileBackground(void);
909int loadAppendOnlyFile(char *filename);
910void stopAppendOnly(void);
911int startAppendOnly(void);
36c17a53 912void backgroundRewriteDoneHandler(int exitcode, int bysignal);
e2641e09 913
914/* Sorted sets data type */
915zskiplist *zslCreate(void);
916void zslFree(zskiplist *zsl);
69ef89f2 917zskiplistNode *zslInsert(zskiplist *zsl, double score, robj *obj);
e2641e09 918
919/* Core functions */
920void freeMemoryIfNeeded(void);
921int processCommand(redisClient *c);
633a9410 922void setupSignalHandlers(void);
1b1f47c9 923struct redisCommand *lookupCommand(sds name);
924struct redisCommand *lookupCommandByCString(char *s);
e2641e09 925void call(redisClient *c, struct redisCommand *cmd);
926int prepareForShutdown();
927void redisLog(int level, const char *fmt, ...);
928void usage();
929void updateDictResizePolicy(void);
930int htNeedsResize(dict *dict);
931void oom(const char *msg);
1b1f47c9 932void populateCommandTable(void);
d7ed7fd2 933void resetCommandTableStats(void);
e2641e09 934
33388d43 935/* Disk store */
936int dsOpen(void);
937int dsClose(void);
05600eb8 938int dsSet(redisDb *db, robj *key, robj *val, time_t expire);
1fce3201 939robj *dsGet(redisDb *db, robj *key, time_t *expire);
5ef64098 940int dsDel(redisDb *db, robj *key);
33388d43 941int dsExists(redisDb *db, robj *key);
120b9ba8 942void dsFlushDb(int dbid);
cc275067 943int dsRdbSaveBackground(char *filename);
5b8ce853 944int dsRdbSave(char *filename);
33388d43 945
946/* Disk Store Cache */
cea8c5cd 947void dsInit(void);
e2641e09 948void vmThreadedIOCompletedJob(aeEventLoop *el, int fd, void *privdata, int mask);
e2641e09 949void lockThreadedIO(void);
950void unlockThreadedIO(void);
e2641e09 951void freeIOJob(iojob *j);
952void queueIOJob(iojob *j);
e2641e09 953void waitEmptyIOJobsQueue(void);
8d51fb6a 954void processAllPendingIOJobs(void);
e2641e09 955int blockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd);
956int dontWaitForSwappedKey(redisClient *c, robj *key);
957void handleClientsBlockedOnSwappedKey(redisDb *db, robj *key);
cea8c5cd 958int cacheFreeOneEntry(void);
3be00d7e 959void cacheScheduleIOAddFlag(redisDb *db, robj *key, long flag);
960void cacheScheduleIODelFlag(redisDb *db, robj *key, long flag);
961int cacheScheduleIOGetFlags(redisDb *db, robj *key);
962void cacheScheduleIO(redisDb *db, robj *key, int type);
f63f0928 963void cacheCron(void);
31222292 964int cacheKeyMayExist(redisDb *db, robj *key);
c15a3887 965void cacheSetKeyMayExist(redisDb *db, robj *key);
d934e1e8 966void cacheSetKeyDoesNotExist(redisDb *db, robj *key);
249ad25f 967void cacheForcePointInTime(void);
e2641e09 968
96ffb2fe
PN
969/* Set data type */
970robj *setTypeCreate(robj *value);
971int setTypeAdd(robj *subject, robj *value);
972int setTypeRemove(robj *subject, robj *value);
973int setTypeIsMember(robj *subject, robj *value);
cb72d0f1
PN
974setTypeIterator *setTypeInitIterator(robj *subject);
975void setTypeReleaseIterator(setTypeIterator *si);
1b508da7 976int setTypeNext(setTypeIterator *si, robj **objele, int64_t *llele);
977robj *setTypeNextObject(setTypeIterator *si);
dd48de74 978int setTypeRandomElement(robj *setobj, robj **objele, int64_t *llele);
96ffb2fe
PN
979unsigned long setTypeSize(robj *subject);
980void setTypeConvert(robj *subject, int enc);
981
e2641e09 982/* Hash data type */
983void convertToRealHash(robj *o);
984void hashTypeTryConversion(robj *subject, robj **argv, int start, int end);
985void hashTypeTryObjectEncoding(robj *subject, robj **o1, robj **o2);
3d24304f 986int hashTypeGet(robj *o, robj *key, robj **objval, unsigned char **v, unsigned int *vlen);
987robj *hashTypeGetObject(robj *o, robj *key);
e2641e09 988int hashTypeExists(robj *o, robj *key);
989int hashTypeSet(robj *o, robj *key, robj *value);
990int hashTypeDelete(robj *o, robj *key);
991unsigned long hashTypeLength(robj *o);
992hashTypeIterator *hashTypeInitIterator(robj *subject);
993void hashTypeReleaseIterator(hashTypeIterator *hi);
994int hashTypeNext(hashTypeIterator *hi);
8c304be3 995int hashTypeCurrent(hashTypeIterator *hi, int what, robj **objval, unsigned char **v, unsigned int *vlen);
996robj *hashTypeCurrentObject(hashTypeIterator *hi, int what);
e2641e09 997robj *hashTypeLookupWriteOrCreate(redisClient *c, robj *key);
998
999/* Pub / Sub */
1000int pubsubUnsubscribeAllChannels(redisClient *c, int notify);
1001int pubsubUnsubscribeAllPatterns(redisClient *c, int notify);
1002void freePubsubPattern(void *p);
1003int listMatchPubsubPattern(void *a, void *b);
1004
1005/* Utility functions */
1006int stringmatchlen(const char *pattern, int patternLen,
1007 const char *string, int stringLen, int nocase);
1008int stringmatch(const char *pattern, const char *string, int nocase);
1009long long memtoll(const char *p, int *err);
1010int ll2string(char *s, size_t len, long long value);
1011int isStringRepresentableAsLong(sds s, long *longval);
ec7e1389 1012int isStringRepresentableAsLongLong(sds s, long long *longval);
1013int isObjectRepresentableAsLongLong(robj *o, long long *llongval);
e2641e09 1014
1015/* Configuration */
1016void loadServerConfig(char *filename);
1017void appendServerSaveParams(time_t seconds, int changes);
1018void resetServerSaveParams();
1019
1020/* db.c -- Keyspace access API */
1021int removeExpire(redisDb *db, robj *key);
bcf2995c 1022void propagateExpire(redisDb *db, robj *key);
e2641e09 1023int expireIfNeeded(redisDb *db, robj *key);
e2641e09 1024time_t getExpire(redisDb *db, robj *key);
0cf5b7b5 1025void setExpire(redisDb *db, robj *key, time_t when);
e2641e09 1026robj *lookupKey(redisDb *db, robj *key);
1027robj *lookupKeyRead(redisDb *db, robj *key);
1028robj *lookupKeyWrite(redisDb *db, robj *key);
1029robj *lookupKeyReadOrReply(redisClient *c, robj *key, robj *reply);
1030robj *lookupKeyWriteOrReply(redisClient *c, robj *key, robj *reply);
1031int dbAdd(redisDb *db, robj *key, robj *val);
1032int dbReplace(redisDb *db, robj *key, robj *val);
1033int dbExists(redisDb *db, robj *key);
1034robj *dbRandomKey(redisDb *db);
1035int dbDelete(redisDb *db, robj *key);
1036long long emptyDb();
1037int selectDb(redisClient *c, int id);
cea8c5cd 1038void signalModifiedKey(redisDb *db, robj *key);
1039void signalFlushedDb(int dbid);
e2641e09 1040
9791f0f8 1041/* API to get key arguments from commands */
1042#define REDIS_GETKEYS_ALL 0
1043#define REDIS_GETKEYS_PRELOAD 1
1044int *getKeysFromCommand(struct redisCommand *cmd, robj **argv, int argc, int *numkeys, int flags);
1045void getKeysFreeResult(int *result);
1046int *noPreloadGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags);
1047int *renameGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags);
1048int *zunionInterGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags);
1049
ecc91094 1050/* Cluster */
1051void clusterInit(void);
1052unsigned short crc16(const char *buf, int len);
1053unsigned int keyHashSlot(char *key, int keylen);
1054clusterNode *createClusterNode(char *nodename, int flags);
1055int clusterAddNode(clusterNode *node);
1056void clusterCron(void);
1057clusterNode *getNodeByQuery(redisClient *c, struct redisCommand *cmd, robj **argv, int argc, int *hashslot);
1058
e2641e09 1059/* Git SHA1 */
1060char *redisGitSHA1(void);
1061char *redisGitDirty(void);
1062
1063/* Commands prototypes */
1064void authCommand(redisClient *c);
1065void pingCommand(redisClient *c);
1066void echoCommand(redisClient *c);
1067void setCommand(redisClient *c);
1068void setnxCommand(redisClient *c);
1069void setexCommand(redisClient *c);
1070void getCommand(redisClient *c);
1071void delCommand(redisClient *c);
1072void existsCommand(redisClient *c);
3c1bf495
PN
1073void setbitCommand(redisClient *c);
1074void getbitCommand(redisClient *c);
9f9e1cea 1075void setrangeCommand(redisClient *c);
ef11bccc 1076void getrangeCommand(redisClient *c);
e2641e09 1077void incrCommand(redisClient *c);
1078void decrCommand(redisClient *c);
1079void incrbyCommand(redisClient *c);
1080void decrbyCommand(redisClient *c);
1081void selectCommand(redisClient *c);
1082void randomkeyCommand(redisClient *c);
1083void keysCommand(redisClient *c);
1084void dbsizeCommand(redisClient *c);
1085void lastsaveCommand(redisClient *c);
1086void saveCommand(redisClient *c);
1087void bgsaveCommand(redisClient *c);
1088void bgrewriteaofCommand(redisClient *c);
1089void shutdownCommand(redisClient *c);
1090void moveCommand(redisClient *c);
1091void renameCommand(redisClient *c);
1092void renamenxCommand(redisClient *c);
1093void lpushCommand(redisClient *c);
1094void rpushCommand(redisClient *c);
1095void lpushxCommand(redisClient *c);
1096void rpushxCommand(redisClient *c);
1097void linsertCommand(redisClient *c);
1098void lpopCommand(redisClient *c);
1099void rpopCommand(redisClient *c);
1100void llenCommand(redisClient *c);
1101void lindexCommand(redisClient *c);
1102void lrangeCommand(redisClient *c);
1103void ltrimCommand(redisClient *c);
1104void typeCommand(redisClient *c);
1105void lsetCommand(redisClient *c);
1106void saddCommand(redisClient *c);
1107void sremCommand(redisClient *c);
1108void smoveCommand(redisClient *c);
1109void sismemberCommand(redisClient *c);
1110void scardCommand(redisClient *c);
1111void spopCommand(redisClient *c);
1112void srandmemberCommand(redisClient *c);
1113void sinterCommand(redisClient *c);
1114void sinterstoreCommand(redisClient *c);
1115void sunionCommand(redisClient *c);
1116void sunionstoreCommand(redisClient *c);
1117void sdiffCommand(redisClient *c);
1118void sdiffstoreCommand(redisClient *c);
1119void syncCommand(redisClient *c);
1120void flushdbCommand(redisClient *c);
1121void flushallCommand(redisClient *c);
1122void sortCommand(redisClient *c);
1123void lremCommand(redisClient *c);
8a979f03 1124void rpoplpushCommand(redisClient *c);
e2641e09 1125void infoCommand(redisClient *c);
1126void mgetCommand(redisClient *c);
1127void monitorCommand(redisClient *c);
1128void expireCommand(redisClient *c);
1129void expireatCommand(redisClient *c);
1130void getsetCommand(redisClient *c);
1131void ttlCommand(redisClient *c);
a539d29a 1132void persistCommand(redisClient *c);
e2641e09 1133void slaveofCommand(redisClient *c);
1134void debugCommand(redisClient *c);
1135void msetCommand(redisClient *c);
1136void msetnxCommand(redisClient *c);
1137void zaddCommand(redisClient *c);
1138void zincrbyCommand(redisClient *c);
1139void zrangeCommand(redisClient *c);
1140void zrangebyscoreCommand(redisClient *c);
25bb8a44 1141void zrevrangebyscoreCommand(redisClient *c);
e2641e09 1142void zcountCommand(redisClient *c);
1143void zrevrangeCommand(redisClient *c);
1144void zcardCommand(redisClient *c);
1145void zremCommand(redisClient *c);
1146void zscoreCommand(redisClient *c);
1147void zremrangebyscoreCommand(redisClient *c);
1148void multiCommand(redisClient *c);
1149void execCommand(redisClient *c);
1150void discardCommand(redisClient *c);
1151void blpopCommand(redisClient *c);
1152void brpopCommand(redisClient *c);
b2a7fd0c 1153void brpoplpushCommand(redisClient *c);
e2641e09 1154void appendCommand(redisClient *c);
80091bba 1155void strlenCommand(redisClient *c);
e2641e09 1156void zrankCommand(redisClient *c);
1157void zrevrankCommand(redisClient *c);
1158void hsetCommand(redisClient *c);
1159void hsetnxCommand(redisClient *c);
1160void hgetCommand(redisClient *c);
1161void hmsetCommand(redisClient *c);
1162void hmgetCommand(redisClient *c);
1163void hdelCommand(redisClient *c);
1164void hlenCommand(redisClient *c);
1165void zremrangebyrankCommand(redisClient *c);
1166void zunionstoreCommand(redisClient *c);
1167void zinterstoreCommand(redisClient *c);
1168void hkeysCommand(redisClient *c);
1169void hvalsCommand(redisClient *c);
1170void hgetallCommand(redisClient *c);
1171void hexistsCommand(redisClient *c);
1172void configCommand(redisClient *c);
1173void hincrbyCommand(redisClient *c);
1174void subscribeCommand(redisClient *c);
1175void unsubscribeCommand(redisClient *c);
1176void psubscribeCommand(redisClient *c);
1177void punsubscribeCommand(redisClient *c);
1178void publishCommand(redisClient *c);
1179void watchCommand(redisClient *c);
1180void unwatchCommand(redisClient *c);
ecc91094 1181void clusterCommand(redisClient *c);
1182void restoreCommand(redisClient *c);
1183void migrateCommand(redisClient *c);
626f6b2d 1184void dumpCommand(redisClient *c);
ece74202 1185void objectCommand(redisClient *c);
e2641e09 1186
b3aa6d71 1187#if defined(__GNUC__)
b3aa6d71 1188void *calloc(size_t count, size_t size) __attribute__ ((deprecated));
1189void free(void *ptr) __attribute__ ((deprecated));
1190void *malloc(size_t size) __attribute__ ((deprecated));
1191void *realloc(void *ptr, size_t size) __attribute__ ((deprecated));
1192#endif
1193
e2641e09 1194#endif