]> git.saurik.com Git - redis.git/blame - src/redis.h
EVALSHA implemented
[redis.git] / src / redis.h
CommitLineData
e2641e09 1#ifndef __REDIS_H
2#define __REDIS_H
3
4#include "fmacros.h"
5#include "config.h"
6
7#if defined(__sun)
8#include "solarisfixes.h"
9#endif
10
11#include <stdio.h>
12#include <stdlib.h>
13#include <string.h>
14#include <time.h>
15#include <limits.h>
16#include <unistd.h>
17#include <errno.h>
3688d7f3 18#include <inttypes.h>
d06a5b23 19#include <pthread.h>
e1a586ee 20#include <syslog.h>
ecc91094 21#include <netinet/in.h>
7585836e 22#include <lua.h>
e2641e09 23
24#include "ae.h" /* Event driven programming library */
25#include "sds.h" /* Dynamic safe strings */
26#include "dict.h" /* Hash tables */
27#include "adlist.h" /* Linked lists */
28#include "zmalloc.h" /* total memory usage aware version of malloc/free */
29#include "anet.h" /* Networking the easy way */
30#include "zipmap.h" /* Compact string -> string data structure */
31#include "ziplist.h" /* Compact list data structure */
96ffb2fe 32#include "intset.h" /* Compact integer set structure */
e2641e09 33#include "version.h"
5d081931 34#include "util.h"
e2641e09 35
36/* Error codes */
37#define REDIS_OK 0
38#define REDIS_ERR -1
39
40/* Static server configuration */
41#define REDIS_SERVERPORT 6379 /* TCP port */
42#define REDIS_MAXIDLETIME (60*5) /* default client timeout */
43#define REDIS_IOBUF_LEN 1024
44#define REDIS_LOADBUF_LEN 1024
45#define REDIS_STATIC_ARGS 8
46#define REDIS_DEFAULT_DBNUM 16
47#define REDIS_CONFIGLINE_MAX 1024
e2641e09 48#define REDIS_MAX_SYNC_TIME 60 /* Slave can't take more to sync */
49#define REDIS_EXPIRELOOKUPS_PER_CRON 10 /* lookup 10 expires per loop */
50#define REDIS_MAX_WRITE_PER_EVENT (1024*64)
51#define REDIS_REQUEST_MAX_SIZE (1024*1024*256) /* max bytes in inline command */
52#define REDIS_SHARED_INTEGERS 10000
36c19d03 53#define REDIS_REPLY_CHUNK_BYTES (5*1500) /* 5 TCP packets with default MTU */
e1a586ee 54#define REDIS_MAX_LOGMSG_LEN 1024 /* Default maximum length of syslog messages */
834ef78e 55
e2641e09 56/* Hash table parameters */
57#define REDIS_HT_MINFILL 10 /* Minimal hash table fill 10% */
58
33aba595
PN
59/* Command flags:
60 * REDIS_CMD_DENYOOM:
61 * Commands marked with this flag will return an error when 'maxmemory' is
62 * set and the server is using more than 'maxmemory' bytes of memory.
63 * In short: commands with this flag are denied on low memory conditions.
64 * REDIS_CMD_FORCE_REPLICATION:
65 * Force replication even if dirty is 0. */
66#define REDIS_CMD_DENYOOM 4
67#define REDIS_CMD_FORCE_REPLICATION 8
e2641e09 68
69/* Object types */
70#define REDIS_STRING 0
71#define REDIS_LIST 1
72#define REDIS_SET 2
73#define REDIS_ZSET 3
74#define REDIS_HASH 4
75#define REDIS_VMPOINTER 8
e12b27ac 76
2cc99365 77/* Object types only used for persistence in .rdb files */
78#define REDIS_HASH_ZIPMAP 9
9ad853cc 79#define REDIS_LIST_ZIPLIST 10
80#define REDIS_SET_INTSET 11
e12b27ac 81#define REDIS_ZSET_ZIPLIST 12
e2641e09 82
83/* Objects encoding. Some kind of objects like Strings and Hashes can be
84 * internally represented in multiple ways. The 'encoding' field of the object
85 * is set to one of this fields for this object. */
86#define REDIS_ENCODING_RAW 0 /* Raw representation */
87#define REDIS_ENCODING_INT 1 /* Encoded as integer */
88#define REDIS_ENCODING_HT 2 /* Encoded as hash table */
89#define REDIS_ENCODING_ZIPMAP 3 /* Encoded as zipmap */
90#define REDIS_ENCODING_LINKEDLIST 4 /* Encoded as regular linked list */
91#define REDIS_ENCODING_ZIPLIST 5 /* Encoded as ziplist */
96ffb2fe 92#define REDIS_ENCODING_INTSET 6 /* Encoded as intset */
0b7f6d09 93#define REDIS_ENCODING_SKIPLIST 7 /* Encoded as skiplist */
e2641e09 94
95/* Object types only used for dumping to disk */
96#define REDIS_EXPIRETIME 253
97#define REDIS_SELECTDB 254
98#define REDIS_EOF 255
99
100/* Defines related to the dump file format. To store 32 bits lengths for short
101 * keys requires a lot of space, so we check the most significant 2 bits of
102 * the first byte to interpreter the length:
103 *
104 * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
105 * 01|000000 00000000 => 01, the len is 14 byes, 6 bits + 8 bits of next byte
106 * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
107 * 11|000000 this means: specially encoded object will follow. The six bits
108 * number specify the kind of object that follows.
109 * See the REDIS_RDB_ENC_* defines.
110 *
111 * Lenghts up to 63 are stored using a single byte, most DB keys, and may
112 * values, will fit inside. */
113#define REDIS_RDB_6BITLEN 0
114#define REDIS_RDB_14BITLEN 1
115#define REDIS_RDB_32BITLEN 2
116#define REDIS_RDB_ENCVAL 3
117#define REDIS_RDB_LENERR UINT_MAX
118
119/* When a length of a string object stored on disk has the first two bits
120 * set, the remaining two bits specify a special encoding for the object
121 * accordingly to the following defines: */
122#define REDIS_RDB_ENC_INT8 0 /* 8 bit signed integer */
123#define REDIS_RDB_ENC_INT16 1 /* 16 bit signed integer */
124#define REDIS_RDB_ENC_INT32 2 /* 32 bit signed integer */
125#define REDIS_RDB_ENC_LZF 3 /* string compressed with FASTLZ */
126
3be00d7e 127/* Scheduled IO opeations flags. */
128#define REDIS_IO_LOAD 1
129#define REDIS_IO_SAVE 2
130#define REDIS_IO_LOADINPROG 4
131#define REDIS_IO_SAVEINPROG 8
16d77878 132
f771dc23 133/* Generic IO flags */
134#define REDIS_IO_ONLYLOADS 1
135#define REDIS_IO_ASAP 2
136
e2641e09 137#define REDIS_MAX_COMPLETED_JOBS_PROCESSED 1
f34a6cd8 138#define REDIS_THREAD_STACK_SIZE (1024*1024*4)
e2641e09 139
140/* Client flags */
141#define REDIS_SLAVE 1 /* This client is a slave server */
142#define REDIS_MASTER 2 /* This client is a master server */
143#define REDIS_MONITOR 4 /* This client is a slave monitor, see MONITOR */
144#define REDIS_MULTI 8 /* This client is in a MULTI context */
145#define REDIS_BLOCKED 16 /* The client is waiting in a blocking operation */
146#define REDIS_IO_WAIT 32 /* The client is waiting for Virtual Memory I/O */
147#define REDIS_DIRTY_CAS 64 /* Watched keys modified. EXEC will fail. */
5e78edb3 148#define REDIS_CLOSE_AFTER_REPLY 128 /* Close after writing entire reply. */
3bcffcbe
PN
149#define REDIS_UNBLOCKED 256 /* This client was unblocked and is stored in
150 server.unblocked_clients */
7156f43c 151#define REDIS_LUA_CLIENT 512 /* This is a non connected client used by Lua */
cd8788f2
PN
152
153/* Client request types */
154#define REDIS_REQ_INLINE 1
155#define REDIS_REQ_MULTIBULK 2
e2641e09 156
157/* Slave replication state - slave side */
158#define REDIS_REPL_NONE 0 /* No active replication */
159#define REDIS_REPL_CONNECT 1 /* Must connect to master */
62ec599c 160#define REDIS_REPL_TRANSFER 2 /* Receiving .rdb from master */
f4aa600b 161#define REDIS_REPL_CONNECTED 3 /* Connected to master */
e2641e09 162
163/* Slave replication state - from the point of view of master
164 * Note that in SEND_BULK and ONLINE state the slave receives new updates
165 * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
166 * to start the next background saving in order to send updates to it. */
167#define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
168#define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
169#define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
170#define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */
171
172/* List related stuff */
173#define REDIS_HEAD 0
174#define REDIS_TAIL 1
175
176/* Sort operations */
177#define REDIS_SORT_GET 0
178#define REDIS_SORT_ASC 1
179#define REDIS_SORT_DESC 2
180#define REDIS_SORTKEY_MAX 1024
181
182/* Log levels */
183#define REDIS_DEBUG 0
184#define REDIS_VERBOSE 1
185#define REDIS_NOTICE 2
186#define REDIS_WARNING 3
996d503d 187#define REDIS_LOG_RAW (1<<10) /* Modifier to log without timestamp */
e2641e09 188
189/* Anti-warning macro... */
190#define REDIS_NOTUSED(V) ((void) V)
191
192#define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
193#define ZSKIPLIST_P 0.25 /* Skiplist P = 1/4 */
194
195/* Append only defines */
196#define APPENDFSYNC_NO 0
197#define APPENDFSYNC_ALWAYS 1
198#define APPENDFSYNC_EVERYSEC 2
199
200/* Zip structure related defaults */
52dc87bb 201#define REDIS_HASH_MAX_ZIPMAP_ENTRIES 512
202#define REDIS_HASH_MAX_ZIPMAP_VALUE 64
6a246b1e 203#define REDIS_LIST_MAX_ZIPLIST_ENTRIES 512
204#define REDIS_LIST_MAX_ZIPLIST_VALUE 64
205#define REDIS_SET_MAX_INTSET_ENTRIES 512
3ea204e1
PN
206#define REDIS_ZSET_MAX_ZIPLIST_ENTRIES 128
207#define REDIS_ZSET_MAX_ZIPLIST_VALUE 64
e2641e09 208
209/* Sets operations codes */
210#define REDIS_OP_UNION 0
211#define REDIS_OP_DIFF 1
212#define REDIS_OP_INTER 2
213
165346ca 214/* Redis maxmemory strategies */
215#define REDIS_MAXMEMORY_VOLATILE_LRU 0
216#define REDIS_MAXMEMORY_VOLATILE_TTL 1
217#define REDIS_MAXMEMORY_VOLATILE_RANDOM 2
218#define REDIS_MAXMEMORY_ALLKEYS_LRU 3
219#define REDIS_MAXMEMORY_ALLKEYS_RANDOM 4
5402c426 220#define REDIS_MAXMEMORY_NO_EVICTION 5
165346ca 221
36c17a53 222/* Diskstore background saving thread states */
223#define REDIS_BGSAVE_THREAD_UNACTIVE 0
224#define REDIS_BGSAVE_THREAD_ACTIVE 1
225#define REDIS_BGSAVE_THREAD_DONE_OK 2
226#define REDIS_BGSAVE_THREAD_DONE_ERR 3
227
eeffcf38 228/* Scripting */
229#define REDIS_LUA_TIME_LIMIT 60000 /* milliseconds */
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,
7229d60d 368 *outofrangeerr, *noscripterr, *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 */
e2641e09 551 /* Configuration */
552 int verbosity;
e2641e09 553 int maxidletime;
554 int dbnum;
555 int daemonize;
556 int appendonly;
557 int appendfsync;
558 int no_appendfsync_on_rewrite;
559 int shutdown_asap;
36c17a53 560 int activerehashing;
561 char *requirepass;
562 /* Persistence */
5b831607 563 long long dirty; /* changes to DB from the last save */
564 long long dirty_before_bgsave; /* used to restore dirty on failed BGSAVE */
e2641e09 565 time_t lastfsync;
566 int appendfd;
567 int appendseldb;
568 char *pidfile;
569 pid_t bgsavechildpid;
570 pid_t bgrewritechildpid;
36c17a53 571 int bgsavethread_state;
572 pthread_mutex_t bgsavethread_mutex;
573 pthread_t bgsavethread;
e2641e09 574 sds bgrewritebuf; /* buffer taken by parent during oppend only rewrite */
575 sds aofbuf; /* AOF buffer, written before entering the event loop */
576 struct saveparam *saveparams;
577 int saveparamslen;
36c17a53 578 char *dbfilename;
579 int rdbcompression;
580 char *appendfilename;
581 /* Logging */
e2641e09 582 char *logfile;
e1a586ee
JH
583 int syslog_enabled;
584 char *syslog_ident;
585 int syslog_facility;
e2641e09 586 /* Replication related */
587 int isslave;
f4aa600b 588 /* Slave specific fields */
e2641e09 589 char *masterauth;
590 char *masterhost;
591 int masterport;
592 redisClient *master; /* client that is master for this slave */
f4aa600b 593 int replstate; /* replication status if the instance is a slave */
62ec599c 594 off_t repl_transfer_left; /* bytes left reading .rdb */
f4aa600b 595 int repl_transfer_s; /* slave -> master SYNC socket */
596 int repl_transfer_fd; /* slave -> master SYNC temp file descriptor */
597 char *repl_transfer_tmpfile; /* slave-> master SYNC temp file name */
598 time_t repl_transfer_lastio; /* unix time of the latest read, for timeout */
4ebfc455 599 int repl_serve_stale_data; /* Serve stale data when link is down? */
f4aa600b 600 /* Limits */
e2641e09 601 unsigned int maxclients;
602 unsigned long long maxmemory;
165346ca 603 int maxmemory_policy;
604 int maxmemory_samples;
f4aa600b 605 /* Blocked clients */
5fa95ad7 606 unsigned int bpop_blocked_clients;
697af434 607 unsigned int cache_blocked_clients;
cea8c5cd 608 list *unblocked_clients; /* list of clients to unblock before next loop */
3be00d7e 609 list *cache_io_queue; /* IO operations queue */
cea8c5cd 610 int cache_flush_delay; /* seconds to wait before flushing keys */
e2641e09 611 /* Sort parameters - qsort_r() is only available under BSD so we
612 * have to take this state global, in order to pass it to sortCompare() */
613 int sort_desc;
614 int sort_alpha;
615 int sort_bypattern;
616 /* Virtual memory configuration */
697af434 617 int ds_enabled; /* backend disk in redis.conf */
618 char *ds_path; /* location of the disk store on disk */
619 unsigned long long cache_max_memory;
e2641e09 620 /* Zip structure config */
621 size_t hash_max_zipmap_entries;
622 size_t hash_max_zipmap_value;
623 size_t list_max_ziplist_entries;
624 size_t list_max_ziplist_value;
96ffb2fe 625 size_t set_max_intset_entries;
3ea204e1
PN
626 size_t zset_max_ziplist_entries;
627 size_t zset_max_ziplist_value;
e2641e09 628 time_t unixtime; /* Unix time sampled every second. */
629 /* Virtual memory I/O threads stuff */
630 /* An I/O thread process an element taken from the io_jobs queue and
631 * put the result of the operation in the io_done list. While the
632 * job is being processed, it's put on io_processing queue. */
633 list *io_newjobs; /* List of VM I/O jobs yet to be processed */
634 list *io_processing; /* List of VM I/O jobs being processed */
635 list *io_processed; /* List of VM I/O jobs already processed */
636 list *io_ready_clients; /* Clients ready to be unblocked. All keys loaded */
637 pthread_mutex_t io_mutex; /* lock to access io_jobs/io_done/io_thread_job */
98a9abb6 638 pthread_cond_t io_condvar; /* I/O threads conditional variable */
e2641e09 639 pthread_attr_t io_threads_attr; /* attributes for threads creation */
640 int io_active_threads; /* Number of running I/O threads */
641 int vm_max_threads; /* Max number of I/O threads running at the same time */
642 /* Our main thread is blocked on the event loop, locking for sockets ready
643 * to be read or written, so when a threaded I/O operation is ready to be
644 * processed by the main thread, the I/O thread will use a unix pipe to
645 * awake the main thread. The followings are the two pipe FDs. */
646 int io_ready_pipe_read;
647 int io_ready_pipe_write;
648 /* Virtual memory stats */
649 unsigned long long vm_stats_used_pages;
650 unsigned long long vm_stats_swapped_objects;
651 unsigned long long vm_stats_swapouts;
652 unsigned long long vm_stats_swapins;
653 /* Pubsub */
654 dict *pubsub_channels; /* Map channels to list of subscribed clients */
655 list *pubsub_patterns; /* A list of pubsub_patterns */
656 /* Misc */
e2641e09 657 unsigned lruclock:22; /* clock incrementing every minute, for LRU */
658 unsigned lruclock_padding:10;
c772d9c6 659 /* Cluster */
ecc91094 660 int cluster_enabled;
661 clusterState cluster;
7585836e 662 /* Scripting */
663 lua_State *lua;
0f1d64ca 664 redisClient *lua_client;
eeffcf38 665 long long lua_time_limit;
666 long long lua_time_start;
e2641e09 667};
668
669typedef struct pubsubPattern {
670 redisClient *client;
671 robj *pattern;
672} pubsubPattern;
673
674typedef void redisCommandProc(redisClient *c);
9791f0f8 675typedef int *redisGetKeysProc(struct redisCommand *cmd, robj **argv, int argc, int *numkeys, int flags);
e2641e09 676struct redisCommand {
677 char *name;
678 redisCommandProc *proc;
679 int arity;
680 int flags;
9791f0f8 681 /* Use a function to determine keys arguments in a command line.
682 * Used both for diskstore preloading and Redis Cluster. */
683 redisGetKeysProc *getkeys_proc;
e2641e09 684 /* What keys should be loaded in background when calling this command? */
9791f0f8 685 int firstkey; /* The first argument that's a key (0 = no keys) */
686 int lastkey; /* THe last argument that's a key */
687 int keystep; /* The step between first and last key */
0d808ef2 688 long long microseconds, calls;
e2641e09 689};
690
691struct redisFunctionSym {
692 char *name;
693 unsigned long pointer;
694};
695
696typedef struct _redisSortObject {
697 robj *obj;
698 union {
699 double score;
700 robj *cmpobj;
701 } u;
702} redisSortObject;
703
704typedef struct _redisSortOperation {
705 int type;
706 robj *pattern;
707} redisSortOperation;
708
3be00d7e 709/* DIsk store threaded I/O request message */
f34a6cd8 710#define REDIS_IOJOB_LOAD 0
711#define REDIS_IOJOB_SAVE 1
712
e2641e09 713typedef struct iojob {
714 int type; /* Request type, REDIS_IOJOB_* */
715 redisDb *db;/* Redis database */
f34a6cd8 716 robj *key; /* This I/O request is about this key */
717 robj *val; /* the value to swap for REDIS_IOJOB_SAVE, otherwise this
718 * field is populated by the I/O thread for REDIS_IOJOB_LOAD. */
4ab98823 719 time_t expire; /* Expire time for this key on REDIS_IOJOB_LOAD */
e2641e09 720} iojob;
721
3be00d7e 722/* IO operations scheduled -- check dscache.c for more info */
723typedef struct ioop {
724 int type;
cea8c5cd 725 redisDb *db;
726 robj *key;
727 time_t ctime; /* This is the creation time of the entry. */
3be00d7e 728} ioop;
cea8c5cd 729
e2641e09 730/* Structure to hold list iteration abstraction. */
731typedef struct {
732 robj *subject;
733 unsigned char encoding;
734 unsigned char direction; /* Iteration direction */
735 unsigned char *zi;
736 listNode *ln;
737} listTypeIterator;
738
739/* Structure for an entry while iterating over a list. */
740typedef struct {
741 listTypeIterator *li;
742 unsigned char *zi; /* Entry in ziplist */
743 listNode *ln; /* Entry in linked list */
744} listTypeEntry;
745
96ffb2fe
PN
746/* Structure to hold set iteration abstraction. */
747typedef struct {
748 robj *subject;
749 int encoding;
750 int ii; /* intset iterator */
751 dictIterator *di;
cb72d0f1 752} setTypeIterator;
96ffb2fe 753
e2641e09 754/* Structure to hold hash iteration abstration. Note that iteration over
755 * hashes involves both fields and values. Because it is possible that
756 * not both are required, store pointers in the iterator to avoid
757 * unnecessary memory allocation for fields/values. */
758typedef struct {
759 int encoding;
760 unsigned char *zi;
761 unsigned char *zk, *zv;
762 unsigned int zklen, zvlen;
763
764 dictIterator *di;
765 dictEntry *de;
766} hashTypeIterator;
767
768#define REDIS_HASH_KEY 1
769#define REDIS_HASH_VALUE 2
770
771/*-----------------------------------------------------------------------------
772 * Extern declarations
773 *----------------------------------------------------------------------------*/
774
775extern struct redisServer server;
776extern struct sharedObjectsStruct shared;
777extern dictType setDictType;
778extern dictType zsetDictType;
ecc91094 779extern dictType clusterNodesDictType;
e2641e09 780extern double R_Zero, R_PosInf, R_NegInf, R_Nan;
781dictType hashDictType;
782
783/*-----------------------------------------------------------------------------
784 * Functions prototypes
785 *----------------------------------------------------------------------------*/
786
419e1cca 787/* Utils */
788long long ustime(void);
789
e2641e09 790/* networking.c -- Networking and Client related operations */
791redisClient *createClient(int fd);
792void closeTimedoutClients(void);
793void freeClient(redisClient *c);
794void resetClient(redisClient *c);
795void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask);
e2641e09 796void addReply(redisClient *c, robj *obj);
b301c1fc
PN
797void *addDeferredMultiBulkLength(redisClient *c);
798void setDeferredMultiBulkLength(redisClient *c, void *node, long length);
e2641e09 799void addReplySds(redisClient *c, sds s);
800void processInputBuffer(redisClient *c);
ab17b909
PN
801void acceptTcpHandler(aeEventLoop *el, int fd, void *privdata, int mask);
802void acceptUnixHandler(aeEventLoop *el, int fd, void *privdata, int mask);
e2641e09 803void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask);
804void addReplyBulk(redisClient *c, robj *obj);
805void addReplyBulkCString(redisClient *c, char *s);
d51ebef5 806void addReplyBulkCBuffer(redisClient *c, void *p, size_t len);
807void addReplyBulkLongLong(redisClient *c, long long ll);
e2641e09 808void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask);
809void addReply(redisClient *c, robj *obj);
810void addReplySds(redisClient *c, sds s);
3ab20376
PN
811void addReplyError(redisClient *c, char *err);
812void addReplyStatus(redisClient *c, char *status);
e2641e09 813void addReplyDouble(redisClient *c, double d);
814void addReplyLongLong(redisClient *c, long long ll);
0537e7bf 815void addReplyMultiBulkLen(redisClient *c, long length);
e2641e09 816void *dupClientReplyValue(void *o);
7a1fd61e 817void getClientsMaxBuffers(unsigned long *longest_output_list,
818 unsigned long *biggest_input_buffer);
e2641e09 819
3ab20376
PN
820#ifdef __GNUC__
821void addReplyErrorFormat(redisClient *c, const char *fmt, ...)
822 __attribute__((format(printf, 2, 3)));
823void addReplyStatusFormat(redisClient *c, const char *fmt, ...)
824 __attribute__((format(printf, 2, 3)));
825#else
826void addReplyErrorFormat(redisClient *c, const char *fmt, ...);
827void addReplyStatusFormat(redisClient *c, const char *fmt, ...);
828#endif
829
e2641e09 830/* List data type */
831void listTypeTryConversion(robj *subject, robj *value);
832void listTypePush(robj *subject, robj *value, int where);
833robj *listTypePop(robj *subject, int where);
834unsigned long listTypeLength(robj *subject);
835listTypeIterator *listTypeInitIterator(robj *subject, int index, unsigned char direction);
836void listTypeReleaseIterator(listTypeIterator *li);
837int listTypeNext(listTypeIterator *li, listTypeEntry *entry);
838robj *listTypeGet(listTypeEntry *entry);
839void listTypeInsert(listTypeEntry *entry, robj *value, int where);
840int listTypeEqual(listTypeEntry *entry, robj *o);
841void listTypeDelete(listTypeEntry *entry);
842void listTypeConvert(robj *subject, int enc);
843void unblockClientWaitingData(redisClient *c);
844int handleClientsWaitingListPush(redisClient *c, robj *key, robj *ele);
845void popGenericCommand(redisClient *c, int where);
846
847/* MULTI/EXEC/WATCH... */
848void unwatchAllKeys(redisClient *c);
849void initClientMultiState(redisClient *c);
850void freeClientMultiState(redisClient *c);
851void queueMultiCommand(redisClient *c, struct redisCommand *cmd);
852void touchWatchedKey(redisDb *db, robj *key);
853void touchWatchedKeysOnFlush(int dbid);
854
855/* Redis object implementation */
856void decrRefCount(void *o);
857void incrRefCount(robj *o);
858void freeStringObject(robj *o);
859void freeListObject(robj *o);
860void freeSetObject(robj *o);
861void freeZsetObject(robj *o);
862void freeHashObject(robj *o);
863robj *createObject(int type, void *ptr);
864robj *createStringObject(char *ptr, size_t len);
865robj *dupStringObject(robj *o);
5d081931 866int isObjectRepresentableAsLongLong(robj *o, long long *llongval);
e2641e09 867robj *tryObjectEncoding(robj *o);
868robj *getDecodedObject(robj *o);
869size_t stringObjectLen(robj *o);
e2641e09 870robj *createStringObjectFromLongLong(long long value);
871robj *createListObject(void);
872robj *createZiplistObject(void);
873robj *createSetObject(void);
96ffb2fe 874robj *createIntsetObject(void);
e2641e09 875robj *createHashObject(void);
876robj *createZsetObject(void);
9e7cee0e 877robj *createZsetZiplistObject(void);
e2641e09 878int getLongFromObjectOrReply(redisClient *c, robj *o, long *target, const char *msg);
879int checkType(redisClient *c, robj *o, int type);
880int getLongLongFromObjectOrReply(redisClient *c, robj *o, long long *target, const char *msg);
881int getDoubleFromObjectOrReply(redisClient *c, robj *o, double *target, const char *msg);
882int getLongLongFromObject(robj *o, long long *target);
883char *strEncoding(int encoding);
884int compareStringObjects(robj *a, robj *b);
885int equalStringObjects(robj *a, robj *b);
ef59a8bc 886unsigned long estimateObjectIdleTime(robj *o);
e2641e09 887
19e61097 888/* Synchronous I/O with timeout */
889int syncWrite(int fd, char *ptr, ssize_t size, int timeout);
890int syncRead(int fd, char *ptr, ssize_t size, int timeout);
891int syncReadLine(int fd, char *ptr, ssize_t size, int timeout);
d08fac3e 892int fwriteBulkString(FILE *fp, char *s, unsigned long len);
893int fwriteBulkDouble(FILE *fp, double d);
894int fwriteBulkLongLong(FILE *fp, long long l);
244201f6 895int fwriteBulkObject(FILE *fp, robj *obj);
ecc91094 896int fwriteBulkCount(FILE *fp, char prefix, int count);
19e61097 897
e2641e09 898/* Replication */
899void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc);
900void replicationFeedMonitors(list *monitors, int dictid, robj **argv, int argc);
901int syncWithMaster(void);
902void updateSlavesWaitingBgsave(int bgsaveerr);
f4aa600b 903void replicationCron(void);
e2641e09 904
97e7f8ae 905/* Generic persistence functions */
906void startLoading(FILE *fp);
907void loadingProgress(off_t pos);
908void stopLoading(void);
909
e2641e09 910/* RDB persistence */
911int rdbLoad(char *filename);
912int rdbSaveBackground(char *filename);
913void rdbRemoveTempFile(pid_t childpid);
914int rdbSave(char *filename);
915int rdbSaveObject(FILE *fp, robj *o);
bd70a5f5
PN
916off_t rdbSavedObjectLen(robj *o);
917off_t rdbSavedObjectPages(robj *o);
e2641e09 918robj *rdbLoadObject(int type, FILE *fp);
5b8ce853 919void backgroundSaveDoneHandler(int exitcode, int bysignal);
05600eb8 920int rdbSaveKeyValuePair(FILE *fp, robj *key, robj *val, time_t expireitme, time_t now);
1fce3201 921int rdbLoadType(FILE *fp);
922time_t rdbLoadTime(FILE *fp);
923robj *rdbLoadStringObject(FILE *fp);
f03fe802 924int rdbSaveType(FILE *fp, unsigned char type);
925int rdbSaveLen(FILE *fp, uint32_t len);
e2641e09 926
927/* AOF persistence */
928void flushAppendOnlyFile(void);
929void feedAppendOnlyFile(struct redisCommand *cmd, int dictid, robj **argv, int argc);
930void aofRemoveTempFile(pid_t childpid);
931int rewriteAppendOnlyFileBackground(void);
932int loadAppendOnlyFile(char *filename);
933void stopAppendOnly(void);
934int startAppendOnly(void);
36c17a53 935void backgroundRewriteDoneHandler(int exitcode, int bysignal);
e2641e09 936
937/* Sorted sets data type */
c772d9c6 938
939/* Struct to hold a inclusive/exclusive range spec. */
940typedef struct {
941 double min, max;
942 int minex, maxex; /* are min or max exclusive? */
943} zrangespec;
944
e2641e09 945zskiplist *zslCreate(void);
946void zslFree(zskiplist *zsl);
69ef89f2 947zskiplistNode *zslInsert(zskiplist *zsl, double score, robj *obj);
8588bfa3 948unsigned char *zzlInsert(unsigned char *zl, robj *ele, double score);
c772d9c6 949int zslDelete(zskiplist *zsl, double score, robj *obj);
950zskiplistNode *zslFirstInRange(zskiplist *zsl, zrangespec range);
dddf5335
PN
951double zzlGetScore(unsigned char *sptr);
952void zzlNext(unsigned char *zl, unsigned char **eptr, unsigned char **sptr);
953void zzlPrev(unsigned char *zl, unsigned char **eptr, unsigned char **sptr);
df26a0ae
PN
954unsigned int zsetLength(robj *zobj);
955void zsetConvert(robj *zobj, int encoding);
e2641e09 956
957/* Core functions */
958void freeMemoryIfNeeded(void);
959int processCommand(redisClient *c);
633a9410 960void setupSignalHandlers(void);
1b1f47c9 961struct redisCommand *lookupCommand(sds name);
962struct redisCommand *lookupCommandByCString(char *s);
e2641e09 963void call(redisClient *c, struct redisCommand *cmd);
964int prepareForShutdown();
965void redisLog(int level, const char *fmt, ...);
966void usage();
967void updateDictResizePolicy(void);
968int htNeedsResize(dict *dict);
969void oom(const char *msg);
1b1f47c9 970void populateCommandTable(void);
d7ed7fd2 971void resetCommandTableStats(void);
e2641e09 972
33388d43 973/* Disk store */
974int dsOpen(void);
975int dsClose(void);
05600eb8 976int dsSet(redisDb *db, robj *key, robj *val, time_t expire);
1fce3201 977robj *dsGet(redisDb *db, robj *key, time_t *expire);
5ef64098 978int dsDel(redisDb *db, robj *key);
33388d43 979int dsExists(redisDb *db, robj *key);
120b9ba8 980void dsFlushDb(int dbid);
cc275067 981int dsRdbSaveBackground(char *filename);
5b8ce853 982int dsRdbSave(char *filename);
33388d43 983
984/* Disk Store Cache */
cea8c5cd 985void dsInit(void);
e2641e09 986void vmThreadedIOCompletedJob(aeEventLoop *el, int fd, void *privdata, int mask);
e2641e09 987void lockThreadedIO(void);
988void unlockThreadedIO(void);
e2641e09 989void freeIOJob(iojob *j);
990void queueIOJob(iojob *j);
e2641e09 991void waitEmptyIOJobsQueue(void);
8d51fb6a 992void processAllPendingIOJobs(void);
e2641e09 993int blockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd);
994int dontWaitForSwappedKey(redisClient *c, robj *key);
995void handleClientsBlockedOnSwappedKey(redisDb *db, robj *key);
cea8c5cd 996int cacheFreeOneEntry(void);
3be00d7e 997void cacheScheduleIOAddFlag(redisDb *db, robj *key, long flag);
998void cacheScheduleIODelFlag(redisDb *db, robj *key, long flag);
999int cacheScheduleIOGetFlags(redisDb *db, robj *key);
1000void cacheScheduleIO(redisDb *db, robj *key, int type);
f63f0928 1001void cacheCron(void);
31222292 1002int cacheKeyMayExist(redisDb *db, robj *key);
c15a3887 1003void cacheSetKeyMayExist(redisDb *db, robj *key);
d934e1e8 1004void cacheSetKeyDoesNotExist(redisDb *db, robj *key);
249ad25f 1005void cacheForcePointInTime(void);
e2641e09 1006
96ffb2fe
PN
1007/* Set data type */
1008robj *setTypeCreate(robj *value);
1009int setTypeAdd(robj *subject, robj *value);
1010int setTypeRemove(robj *subject, robj *value);
1011int setTypeIsMember(robj *subject, robj *value);
cb72d0f1
PN
1012setTypeIterator *setTypeInitIterator(robj *subject);
1013void setTypeReleaseIterator(setTypeIterator *si);
1b508da7 1014int setTypeNext(setTypeIterator *si, robj **objele, int64_t *llele);
1015robj *setTypeNextObject(setTypeIterator *si);
dd48de74 1016int setTypeRandomElement(robj *setobj, robj **objele, int64_t *llele);
96ffb2fe
PN
1017unsigned long setTypeSize(robj *subject);
1018void setTypeConvert(robj *subject, int enc);
1019
e2641e09 1020/* Hash data type */
1021void convertToRealHash(robj *o);
1022void hashTypeTryConversion(robj *subject, robj **argv, int start, int end);
1023void hashTypeTryObjectEncoding(robj *subject, robj **o1, robj **o2);
3d24304f 1024int hashTypeGet(robj *o, robj *key, robj **objval, unsigned char **v, unsigned int *vlen);
1025robj *hashTypeGetObject(robj *o, robj *key);
e2641e09 1026int hashTypeExists(robj *o, robj *key);
1027int hashTypeSet(robj *o, robj *key, robj *value);
1028int hashTypeDelete(robj *o, robj *key);
1029unsigned long hashTypeLength(robj *o);
1030hashTypeIterator *hashTypeInitIterator(robj *subject);
1031void hashTypeReleaseIterator(hashTypeIterator *hi);
1032int hashTypeNext(hashTypeIterator *hi);
8c304be3 1033int hashTypeCurrent(hashTypeIterator *hi, int what, robj **objval, unsigned char **v, unsigned int *vlen);
1034robj *hashTypeCurrentObject(hashTypeIterator *hi, int what);
e2641e09 1035robj *hashTypeLookupWriteOrCreate(redisClient *c, robj *key);
1036
1037/* Pub / Sub */
1038int pubsubUnsubscribeAllChannels(redisClient *c, int notify);
1039int pubsubUnsubscribeAllPatterns(redisClient *c, int notify);
1040void freePubsubPattern(void *p);
1041int listMatchPubsubPattern(void *a, void *b);
1042
e2641e09 1043/* Configuration */
1044void loadServerConfig(char *filename);
1045void appendServerSaveParams(time_t seconds, int changes);
1046void resetServerSaveParams();
1047
1048/* db.c -- Keyspace access API */
1049int removeExpire(redisDb *db, robj *key);
bcf2995c 1050void propagateExpire(redisDb *db, robj *key);
e2641e09 1051int expireIfNeeded(redisDb *db, robj *key);
e2641e09 1052time_t getExpire(redisDb *db, robj *key);
0cf5b7b5 1053void setExpire(redisDb *db, robj *key, time_t when);
e2641e09 1054robj *lookupKey(redisDb *db, robj *key);
1055robj *lookupKeyRead(redisDb *db, robj *key);
1056robj *lookupKeyWrite(redisDb *db, robj *key);
1057robj *lookupKeyReadOrReply(redisClient *c, robj *key, robj *reply);
1058robj *lookupKeyWriteOrReply(redisClient *c, robj *key, robj *reply);
1059int dbAdd(redisDb *db, robj *key, robj *val);
1060int dbReplace(redisDb *db, robj *key, robj *val);
1061int dbExists(redisDb *db, robj *key);
1062robj *dbRandomKey(redisDb *db);
1063int dbDelete(redisDb *db, robj *key);
1064long long emptyDb();
1065int selectDb(redisClient *c, int id);
cea8c5cd 1066void signalModifiedKey(redisDb *db, robj *key);
1067void signalFlushedDb(int dbid);
484354ff 1068unsigned int GetKeysInSlot(unsigned int hashslot, robj **keys, unsigned int count);
e2641e09 1069
9791f0f8 1070/* API to get key arguments from commands */
1071#define REDIS_GETKEYS_ALL 0
1072#define REDIS_GETKEYS_PRELOAD 1
1073int *getKeysFromCommand(struct redisCommand *cmd, robj **argv, int argc, int *numkeys, int flags);
1074void getKeysFreeResult(int *result);
1075int *noPreloadGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags);
1076int *renameGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags);
1077int *zunionInterGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags);
1078
ecc91094 1079/* Cluster */
1080void clusterInit(void);
1081unsigned short crc16(const char *buf, int len);
1082unsigned int keyHashSlot(char *key, int keylen);
1083clusterNode *createClusterNode(char *nodename, int flags);
1084int clusterAddNode(clusterNode *node);
1085void clusterCron(void);
eda827f8 1086clusterNode *getNodeByQuery(redisClient *c, struct redisCommand *cmd, robj **argv, int argc, int *hashslot, int *ask);
ecc91094 1087
7585836e 1088/* Scripting */
1089void scriptingInit(void);
1090
e2641e09 1091/* Git SHA1 */
1092char *redisGitSHA1(void);
1093char *redisGitDirty(void);
1094
1095/* Commands prototypes */
1096void authCommand(redisClient *c);
1097void pingCommand(redisClient *c);
1098void echoCommand(redisClient *c);
1099void setCommand(redisClient *c);
1100void setnxCommand(redisClient *c);
1101void setexCommand(redisClient *c);
1102void getCommand(redisClient *c);
1103void delCommand(redisClient *c);
1104void existsCommand(redisClient *c);
3c1bf495
PN
1105void setbitCommand(redisClient *c);
1106void getbitCommand(redisClient *c);
9f9e1cea 1107void setrangeCommand(redisClient *c);
ef11bccc 1108void getrangeCommand(redisClient *c);
e2641e09 1109void incrCommand(redisClient *c);
1110void decrCommand(redisClient *c);
1111void incrbyCommand(redisClient *c);
1112void decrbyCommand(redisClient *c);
1113void selectCommand(redisClient *c);
1114void randomkeyCommand(redisClient *c);
1115void keysCommand(redisClient *c);
1116void dbsizeCommand(redisClient *c);
1117void lastsaveCommand(redisClient *c);
1118void saveCommand(redisClient *c);
1119void bgsaveCommand(redisClient *c);
1120void bgrewriteaofCommand(redisClient *c);
1121void shutdownCommand(redisClient *c);
1122void moveCommand(redisClient *c);
1123void renameCommand(redisClient *c);
1124void renamenxCommand(redisClient *c);
1125void lpushCommand(redisClient *c);
1126void rpushCommand(redisClient *c);
1127void lpushxCommand(redisClient *c);
1128void rpushxCommand(redisClient *c);
1129void linsertCommand(redisClient *c);
1130void lpopCommand(redisClient *c);
1131void rpopCommand(redisClient *c);
1132void llenCommand(redisClient *c);
1133void lindexCommand(redisClient *c);
1134void lrangeCommand(redisClient *c);
1135void ltrimCommand(redisClient *c);
1136void typeCommand(redisClient *c);
1137void lsetCommand(redisClient *c);
1138void saddCommand(redisClient *c);
1139void sremCommand(redisClient *c);
1140void smoveCommand(redisClient *c);
1141void sismemberCommand(redisClient *c);
1142void scardCommand(redisClient *c);
1143void spopCommand(redisClient *c);
1144void srandmemberCommand(redisClient *c);
1145void sinterCommand(redisClient *c);
1146void sinterstoreCommand(redisClient *c);
1147void sunionCommand(redisClient *c);
1148void sunionstoreCommand(redisClient *c);
1149void sdiffCommand(redisClient *c);
1150void sdiffstoreCommand(redisClient *c);
1151void syncCommand(redisClient *c);
1152void flushdbCommand(redisClient *c);
1153void flushallCommand(redisClient *c);
1154void sortCommand(redisClient *c);
1155void lremCommand(redisClient *c);
8a979f03 1156void rpoplpushCommand(redisClient *c);
e2641e09 1157void infoCommand(redisClient *c);
1158void mgetCommand(redisClient *c);
1159void monitorCommand(redisClient *c);
1160void expireCommand(redisClient *c);
1161void expireatCommand(redisClient *c);
1162void getsetCommand(redisClient *c);
1163void ttlCommand(redisClient *c);
a539d29a 1164void persistCommand(redisClient *c);
e2641e09 1165void slaveofCommand(redisClient *c);
1166void debugCommand(redisClient *c);
1167void msetCommand(redisClient *c);
1168void msetnxCommand(redisClient *c);
1169void zaddCommand(redisClient *c);
1170void zincrbyCommand(redisClient *c);
1171void zrangeCommand(redisClient *c);
1172void zrangebyscoreCommand(redisClient *c);
25bb8a44 1173void zrevrangebyscoreCommand(redisClient *c);
e2641e09 1174void zcountCommand(redisClient *c);
1175void zrevrangeCommand(redisClient *c);
1176void zcardCommand(redisClient *c);
1177void zremCommand(redisClient *c);
1178void zscoreCommand(redisClient *c);
1179void zremrangebyscoreCommand(redisClient *c);
1180void multiCommand(redisClient *c);
1181void execCommand(redisClient *c);
1182void discardCommand(redisClient *c);
1183void blpopCommand(redisClient *c);
1184void brpopCommand(redisClient *c);
b2a7fd0c 1185void brpoplpushCommand(redisClient *c);
e2641e09 1186void appendCommand(redisClient *c);
80091bba 1187void strlenCommand(redisClient *c);
e2641e09 1188void zrankCommand(redisClient *c);
1189void zrevrankCommand(redisClient *c);
1190void hsetCommand(redisClient *c);
1191void hsetnxCommand(redisClient *c);
1192void hgetCommand(redisClient *c);
1193void hmsetCommand(redisClient *c);
1194void hmgetCommand(redisClient *c);
1195void hdelCommand(redisClient *c);
1196void hlenCommand(redisClient *c);
1197void zremrangebyrankCommand(redisClient *c);
1198void zunionstoreCommand(redisClient *c);
1199void zinterstoreCommand(redisClient *c);
1200void hkeysCommand(redisClient *c);
1201void hvalsCommand(redisClient *c);
1202void hgetallCommand(redisClient *c);
1203void hexistsCommand(redisClient *c);
1204void configCommand(redisClient *c);
1205void hincrbyCommand(redisClient *c);
1206void subscribeCommand(redisClient *c);
1207void unsubscribeCommand(redisClient *c);
1208void psubscribeCommand(redisClient *c);
1209void punsubscribeCommand(redisClient *c);
1210void publishCommand(redisClient *c);
1211void watchCommand(redisClient *c);
1212void unwatchCommand(redisClient *c);
ecc91094 1213void clusterCommand(redisClient *c);
1214void restoreCommand(redisClient *c);
1215void migrateCommand(redisClient *c);
626f6b2d 1216void dumpCommand(redisClient *c);
ece74202 1217void objectCommand(redisClient *c);
3cd12b56 1218void clientCommand(redisClient *c);
7585836e 1219void evalCommand(redisClient *c);
7229d60d 1220void evalShaCommand(redisClient *c);
e2641e09 1221
b3aa6d71 1222#if defined(__GNUC__)
b3aa6d71 1223void *calloc(size_t count, size_t size) __attribute__ ((deprecated));
1224void free(void *ptr) __attribute__ ((deprecated));
1225void *malloc(size_t size) __attribute__ ((deprecated));
1226void *realloc(void *ptr, size_t size) __attribute__ ((deprecated));
1227#endif
1228
e2641e09 1229#endif