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