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