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