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