]> git.saurik.com Git - redis.git/blob - src/redis.h
projects / redis.git / blob
? search:


4ce5311b92727651ba2d868d920db35505e84419
[redis.git] / src / redis.h
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>
18 #include <inttypes.h>
19 #include <pthread.h>
20 #include <syslog.h>
21 #include <netinet/in.h>
22 #include <lua.h>
23 #include <signal.h>
24
25 #include "ae.h" /* Event driven programming library */
26 #include "sds.h" /* Dynamic safe strings */
27 #include "dict.h" /* Hash tables */
28 #include "adlist.h" /* Linked lists */
29 #include "zmalloc.h" /* total memory usage aware version of malloc/free */
30 #include "anet.h" /* Networking the easy way */
31 #include "ziplist.h" /* Compact list data structure */
32 #include "intset.h" /* Compact integer set structure */
33 #include "version.h" /* Version macro */
34 #include "util.h" /* Misc functions useful in many places */
35
36 /* Error codes */
37 #define REDIS_OK 0
38 #define REDIS_ERR -1
39
40 /* Static server configuration */
41 #define REDIS_HZ 100 /* Time interrupt calls/sec. */
42 #define REDIS_SERVERPORT 6379 /* TCP port */
43 #define REDIS_MAXIDLETIME 0 /* default client timeout: infinite */
44 #define REDIS_DEFAULT_DBNUM 16
45 #define REDIS_CONFIGLINE_MAX 1024
46 #define REDIS_EXPIRELOOKUPS_PER_CRON 10 /* lookup 10 expires per loop */
47 #define REDIS_EXPIRELOOKUPS_TIME_PERC 25 /* CPU max % for keys collection */
48 #define REDIS_MAX_WRITE_PER_EVENT (1024*64)
49 #define REDIS_SHARED_SELECT_CMDS 10
50 #define REDIS_SHARED_INTEGERS 10000
51 #define REDIS_SHARED_BULKHDR_LEN 32
52 #define REDIS_MAX_LOGMSG_LEN 1024 /* Default maximum length of syslog messages */
53 #define REDIS_AOF_REWRITE_PERC 100
54 #define REDIS_AOF_REWRITE_MIN_SIZE (1024*1024)
55 #define REDIS_AOF_REWRITE_ITEMS_PER_CMD 64
56 #define REDIS_SLOWLOG_LOG_SLOWER_THAN 10000
57 #define REDIS_SLOWLOG_MAX_LEN 128
58 #define REDIS_MAX_CLIENTS 10000
59
60 #define REDIS_REPL_TIMEOUT 60
61 #define REDIS_REPL_PING_SLAVE_PERIOD 10
62
63 #define REDIS_RUN_ID_SIZE 40
64 #define REDIS_OPS_SEC_SAMPLES 16
65
66 /* Protocol and I/O related defines */
67 #define REDIS_MAX_QUERYBUF_LEN (1024*1024*1024) /* 1GB max query buffer. */
68 #define REDIS_IOBUF_LEN (1024*16) /* Generic I/O buffer size */
69 #define REDIS_REPLY_CHUNK_BYTES (16*1024) /* 16k output buffer */
70 #define REDIS_INLINE_MAX_SIZE (1024*64) /* Max size of inline reads */
71 #define REDIS_MBULK_BIG_ARG (1024*32)
72
73 /* Hash table parameters */
74 #define REDIS_HT_MINFILL 10 /* Minimal hash table fill 10% */
75
76 /* Command flags. Please check the command table defined in the redis.c file
77 * for more information about the meaning of every flag. */
78 #define REDIS_CMD_WRITE 1 /* "w" flag */
79 #define REDIS_CMD_READONLY 2 /* "r" flag */
80 #define REDIS_CMD_DENYOOM 4 /* "m" flag */
81 #define REDIS_CMD_FORCE_REPLICATION 8 /* "f" flag */
82 #define REDIS_CMD_ADMIN 16 /* "a" flag */
83 #define REDIS_CMD_PUBSUB 32 /* "p" flag */
84 #define REDIS_CMD_NOSCRIPT 64 /* "s" flag */
85 #define REDIS_CMD_RANDOM 128 /* "R" flag */
86 #define REDIS_CMD_SORT_FOR_SCRIPT 256 /* "S" flag */
87
88 /* Object types */
89 #define REDIS_STRING 0
90 #define REDIS_LIST 1
91 #define REDIS_SET 2
92 #define REDIS_ZSET 3
93 #define REDIS_HASH 4
94
95 /* Objects encoding. Some kind of objects like Strings and Hashes can be
96 * internally represented in multiple ways. The 'encoding' field of the object
97 * is set to one of this fields for this object. */
98 #define REDIS_ENCODING_RAW 0 /* Raw representation */
99 #define REDIS_ENCODING_INT 1 /* Encoded as integer */
100 #define REDIS_ENCODING_HT 2 /* Encoded as hash table */
101 #define REDIS_ENCODING_ZIPMAP 3 /* Encoded as zipmap */
102 #define REDIS_ENCODING_LINKEDLIST 4 /* Encoded as regular linked list */
103 #define REDIS_ENCODING_ZIPLIST 5 /* Encoded as ziplist */
104 #define REDIS_ENCODING_INTSET 6 /* Encoded as intset */
105 #define REDIS_ENCODING_SKIPLIST 7 /* Encoded as skiplist */
106
107 /* Defines related to the dump file format. To store 32 bits lengths for short
108 * keys requires a lot of space, so we check the most significant 2 bits of
109 * the first byte to interpreter the length:
110 *
111 * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
112 * 01|000000 00000000 => 01, the len is 14 byes, 6 bits + 8 bits of next byte
113 * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
114 * 11|000000 this means: specially encoded object will follow. The six bits
115 * number specify the kind of object that follows.
116 * See the REDIS_RDB_ENC_* defines.
117 *
118 * Lenghts up to 63 are stored using a single byte, most DB keys, and may
119 * values, will fit inside. */
120 #define REDIS_RDB_6BITLEN 0
121 #define REDIS_RDB_14BITLEN 1
122 #define REDIS_RDB_32BITLEN 2
123 #define REDIS_RDB_ENCVAL 3
124 #define REDIS_RDB_LENERR UINT_MAX
125
126 /* When a length of a string object stored on disk has the first two bits
127 * set, the remaining two bits specify a special encoding for the object
128 * accordingly to the following defines: */
129 #define REDIS_RDB_ENC_INT8 0 /* 8 bit signed integer */
130 #define REDIS_RDB_ENC_INT16 1 /* 16 bit signed integer */
131 #define REDIS_RDB_ENC_INT32 2 /* 32 bit signed integer */
132 #define REDIS_RDB_ENC_LZF 3 /* string compressed with FASTLZ */
133
134 /* AOF states */
135 #define REDIS_AOF_OFF 0 /* AOF is off */
136 #define REDIS_AOF_ON 1 /* AOF is on */
137 #define REDIS_AOF_WAIT_REWRITE 2 /* AOF waits rewrite to start appending */
138
139 /* Client flags */
140 #define REDIS_SLAVE 1 /* This client is a slave server */
141 #define REDIS_MASTER 2 /* This client is a master server */
142 #define REDIS_MONITOR 4 /* This client is a slave monitor, see MONITOR */
143 #define REDIS_MULTI 8 /* This client is in a MULTI context */
144 #define REDIS_BLOCKED 16 /* The client is waiting in a blocking operation */
145 #define REDIS_DIRTY_CAS 64 /* Watched keys modified. EXEC will fail. */
146 #define REDIS_CLOSE_AFTER_REPLY 128 /* Close after writing entire reply. */
147 #define REDIS_UNBLOCKED 256 /* This client was unblocked and is stored in
148 server.unblocked_clients */
149 #define REDIS_LUA_CLIENT 512 /* This is a non connected client used by Lua */
150 #define REDIS_ASKING 1024 /* Client issued the ASKING command */
151 #define REDIS_CLOSE_ASAP 2048 /* Close this client ASAP */
152
153 /* Client request types */
154 #define REDIS_REQ_INLINE 1
155 #define REDIS_REQ_MULTIBULK 2
156
157 /* Client classes for client limits, currently used only for
158 * the max-client-output-buffer limit implementation. */
159 #define REDIS_CLIENT_LIMIT_CLASS_NORMAL 0
160 #define REDIS_CLIENT_LIMIT_CLASS_SLAVE 1
161 #define REDIS_CLIENT_LIMIT_CLASS_PUBSUB 2
162 #define REDIS_CLIENT_LIMIT_NUM_CLASSES 3
163
164 /* Slave replication state - slave side */
165 #define REDIS_REPL_NONE 0 /* No active replication */
166 #define REDIS_REPL_CONNECT 1 /* Must connect to master */
167 #define REDIS_REPL_CONNECTING 2 /* Connecting to master */
168 #define REDIS_REPL_TRANSFER 3 /* Receiving .rdb from master */
169 #define REDIS_REPL_CONNECTED 4 /* Connected to master */
170
171 /* Synchronous read timeout - slave side */
172 #define REDIS_REPL_SYNCIO_TIMEOUT 5
173
174 /* Slave replication state - from the point of view of master
175 * Note that in SEND_BULK and ONLINE state the slave receives new updates
176 * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
177 * to start the next background saving in order to send updates to it. */
178 #define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
179 #define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
180 #define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
181 #define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */
182
183 /* List related stuff */
184 #define REDIS_HEAD 0
185 #define REDIS_TAIL 1
186
187 /* Sort operations */
188 #define REDIS_SORT_GET 0
189 #define REDIS_SORT_ASC 1
190 #define REDIS_SORT_DESC 2
191 #define REDIS_SORTKEY_MAX 1024
192
193 /* Log levels */
194 #define REDIS_DEBUG 0
195 #define REDIS_VERBOSE 1
196 #define REDIS_NOTICE 2
197 #define REDIS_WARNING 3
198 #define REDIS_LOG_RAW (1<<10) /* Modifier to log without timestamp */
199
200 /* Anti-warning macro... */
201 #define REDIS_NOTUSED(V) ((void) V)
202
203 #define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
204 #define ZSKIPLIST_P 0.25 /* Skiplist P = 1/4 */
205
206 /* Append only defines */
207 #define AOF_FSYNC_NO 0
208 #define AOF_FSYNC_ALWAYS 1
209 #define AOF_FSYNC_EVERYSEC 2
210
211 /* Zip structure related defaults */
212 #define REDIS_HASH_MAX_ZIPLIST_ENTRIES 512
213 #define REDIS_HASH_MAX_ZIPLIST_VALUE 64
214 #define REDIS_LIST_MAX_ZIPLIST_ENTRIES 512
215 #define REDIS_LIST_MAX_ZIPLIST_VALUE 64
216 #define REDIS_SET_MAX_INTSET_ENTRIES 512
217 #define REDIS_ZSET_MAX_ZIPLIST_ENTRIES 128
218 #define REDIS_ZSET_MAX_ZIPLIST_VALUE 64
219
220 /* Sets operations codes */
221 #define REDIS_OP_UNION 0
222 #define REDIS_OP_DIFF 1
223 #define REDIS_OP_INTER 2
224
225 /* Redis maxmemory strategies */
226 #define REDIS_MAXMEMORY_VOLATILE_LRU 0
227 #define REDIS_MAXMEMORY_VOLATILE_TTL 1
228 #define REDIS_MAXMEMORY_VOLATILE_RANDOM 2
229 #define REDIS_MAXMEMORY_ALLKEYS_LRU 3
230 #define REDIS_MAXMEMORY_ALLKEYS_RANDOM 4
231 #define REDIS_MAXMEMORY_NO_EVICTION 5
232
233 /* Scripting */
234 #define REDIS_LUA_TIME_LIMIT 5000 /* milliseconds */
235
236 /* Units */
237 #define UNIT_SECONDS 0
238 #define UNIT_MILLISECONDS 1
239
240 /* SHUTDOWN flags */
241 #define REDIS_SHUTDOWN_SAVE 1 /* Force SAVE on SHUTDOWN even if no save
242 points are configured. */
243 #define REDIS_SHUTDOWN_NOSAVE 2 /* Don't SAVE on SHUTDOWN. */
244
245 /* Command call flags, see call() function */
246 #define REDIS_CALL_NONE 0
247 #define REDIS_CALL_SLOWLOG 1
248 #define REDIS_CALL_STATS 2
249 #define REDIS_CALL_PROPAGATE 4
250 #define REDIS_CALL_FULL (REDIS_CALL_SLOWLOG | REDIS_CALL_STATS | REDIS_CALL_PROPAGATE)
251
252 /* Command propagation flags, see propagate() function */
253 #define REDIS_PROPAGATE_NONE 0
254 #define REDIS_PROPAGATE_AOF 1
255 #define REDIS_PROPAGATE_REPL 2
256
257 /* We can print the stacktrace, so our assert is defined this way: */
258 #define redisAssertWithInfo(_c,_o,_e) ((_e)?(void)0 : (_redisAssertWithInfo(_c,_o,#_e,__FILE__,__LINE__),_exit(1)))
259 #define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1)))
260 #define redisPanic(_e) _redisPanic(#_e,__FILE__,__LINE__),_exit(1)
261
262 /*-----------------------------------------------------------------------------
263 * Data types
264 *----------------------------------------------------------------------------*/
265
266 /* A redis object, that is a type able to hold a string / list / set */
267
268 /* The actual Redis Object */
269 #define REDIS_LRU_CLOCK_MAX ((1<<21)-1) /* Max value of obj->lru */
270 #define REDIS_LRU_CLOCK_RESOLUTION 10 /* LRU clock resolution in seconds */
271 typedef struct redisObject {
272 unsigned type:4;
273 unsigned notused:2; /* Not used */
274 unsigned encoding:4;
275 unsigned lru:22; /* lru time (relative to server.lruclock) */
276 int refcount;
277 void *ptr;
278 } robj;
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; \
289 } while(0);
290
291 typedef 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) */
295 dict *watched_keys; /* WATCHED keys for MULTI/EXEC CAS */
296 int id;
297 } redisDb;
298
299 /* Client MULTI/EXEC state */
300 typedef struct multiCmd {
301 robj **argv;
302 int argc;
303 struct redisCommand *cmd;
304 } multiCmd;
305
306 typedef struct multiState {
307 multiCmd *commands; /* Array of MULTI commands */
308 int count; /* Total number of MULTI commands */
309 } multiState;
310
311 typedef struct blockingState {
312 robj **keys; /* The key we are waiting to terminate a blocking
313 * operation such as BLPOP. Otherwise NULL. */
314 int count; /* Number of blocking keys */
315 time_t timeout; /* Blocking operation timeout. If UNIX current time
316 * is >= timeout then the operation timed out. */
317 robj *target; /* The key that should receive the element,
318 * for BRPOPLPUSH. */
319 } blockingState;
320
321 /* With multiplexing we need to take per-clinet state.
322 * Clients are taken in a liked list. */
323 typedef struct redisClient {
324 int fd;
325 redisDb *db;
326 int dictid;
327 sds querybuf;
328 size_t querybuf_peak; /* Recent (100ms or more) peak of querybuf size */
329 int argc;
330 robj **argv;
331 struct redisCommand *cmd, *lastcmd;
332 int reqtype;
333 int multibulklen; /* number of multi bulk arguments left to read */
334 long bulklen; /* length of bulk argument in multi bulk request */
335 list *reply;
336 unsigned long reply_bytes; /* Tot bytes of objects in reply list */
337 int sentlen;
338 time_t ctime; /* Client creation time */
339 time_t lastinteraction; /* time of the last interaction, used for timeout */
340 time_t obuf_soft_limit_reached_time;
341 int flags; /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
342 int slaveseldb; /* slave selected db, if this client is a slave */
343 int authenticated; /* when requirepass is non-NULL */
344 int replstate; /* replication state if this is a slave */
345 int repldbfd; /* replication DB file descriptor */
346 long repldboff; /* replication DB file offset */
347 off_t repldbsize; /* replication DB file size */
348 multiState mstate; /* MULTI/EXEC state */
349 blockingState bpop; /* blocking state */
350 list *io_keys; /* Keys this client is waiting to be loaded from the
351 * swap file in order to continue. */
352 list *watched_keys; /* Keys WATCHED for MULTI/EXEC CAS */
353 dict *pubsub_channels; /* channels a client is interested in (SUBSCRIBE) */
354 list *pubsub_patterns; /* patterns a client is interested in (SUBSCRIBE) */
355
356 /* Response buffer */
357 int bufpos;
358 char buf[REDIS_REPLY_CHUNK_BYTES];
359 } redisClient;
360
361 struct saveparam {
362 time_t seconds;
363 int changes;
364 };
365
366 struct sharedObjectsStruct {
367 robj *crlf, *ok, *err, *emptybulk, *czero, *cone, *cnegone, *pong, *space,
368 *colon, *nullbulk, *nullmultibulk, *queued,
369 *emptymultibulk, *wrongtypeerr, *nokeyerr, *syntaxerr, *sameobjecterr,
370 *outofrangeerr, *noscripterr, *loadingerr, *slowscripterr, *bgsaveerr,
371 *masterdownerr, *roslaveerr,
372 *oomerr, *plus, *messagebulk, *pmessagebulk, *subscribebulk,
373 *unsubscribebulk, *psubscribebulk, *punsubscribebulk, *del, *rpop, *lpop,
374 *select[REDIS_SHARED_SELECT_CMDS],
375 *integers[REDIS_SHARED_INTEGERS],
376 *mbulkhdr[REDIS_SHARED_BULKHDR_LEN], /* "*<value>\r\n" */
377 *bulkhdr[REDIS_SHARED_BULKHDR_LEN]; /* "$<value>\r\n" */
378 };
379
380 /* ZSETs use a specialized version of Skiplists */
381 typedef struct zskiplistNode {
382 robj *obj;
383 double score;
384 struct zskiplistNode *backward;
385 struct zskiplistLevel {
386 struct zskiplistNode *forward;
387 unsigned int span;
388 } level[];
389 } zskiplistNode;
390
391 typedef struct zskiplist {
392 struct zskiplistNode *header, *tail;
393 unsigned long length;
394 int level;
395 } zskiplist;
396
397 typedef struct zset {
398 dict *dict;
399 zskiplist *zsl;
400 } zset;
401
402 typedef struct clientBufferLimitsConfig {
403 unsigned long long hard_limit_bytes;
404 unsigned long long soft_limit_bytes;
405 time_t soft_limit_seconds;
406 } clientBufferLimitsConfig;
407
408 /* The redisOp structure defines a Redis Operation, that is an instance of
409 * a command with an argument vector, database ID, propagation target
410 * (REDIS_PROPAGATE_*), and command pointer.
411 *
412 * Currently only used to additionally propagate more commands to AOF/Replication
413 * after the propagation of the executed command. */
414 typedef struct redisOp {
415 robj **argv;
416 int argc, dbid, target;
417 struct redisCommand *cmd;
418 } redisOp;
419
420 /* Defines an array of Redis operations. There is an API to add to this
421 * structure in a easy way.
422 *
423 * redisOpArrayInit();
424 * redisOpArrayAppend();
425 * redisOpArrayFree();
426 */
427 typedef struct redisOpArray {
428 redisOp *ops;
429 int numops;
430 } redisOpArray;
431
432 /*-----------------------------------------------------------------------------
433 * Redis cluster data structures
434 *----------------------------------------------------------------------------*/
435
436 #define REDIS_CLUSTER_SLOTS 4096
437 #define REDIS_CLUSTER_OK 0 /* Everything looks ok */
438 #define REDIS_CLUSTER_FAIL 1 /* The cluster can't work */
439 #define REDIS_CLUSTER_NEEDHELP 2 /* The cluster works, but needs some help */
440 #define REDIS_CLUSTER_NAMELEN 40 /* sha1 hex length */
441 #define REDIS_CLUSTER_PORT_INCR 10000 /* Cluster port = baseport + PORT_INCR */
442
443 struct clusterNode;
444
445 /* clusterLink encapsulates everything needed to talk with a remote node. */
446 typedef struct clusterLink {
447 int fd; /* TCP socket file descriptor */
448 sds sndbuf; /* Packet send buffer */
449 sds rcvbuf; /* Packet reception buffer */
450 struct clusterNode *node; /* Node related to this link if any, or NULL */
451 } clusterLink;
452
453 /* Node flags */
454 #define REDIS_NODE_MASTER 1 /* The node is a master */
455 #define REDIS_NODE_SLAVE 2 /* The node is a slave */
456 #define REDIS_NODE_PFAIL 4 /* Failure? Need acknowledge */
457 #define REDIS_NODE_FAIL 8 /* The node is believed to be malfunctioning */
458 #define REDIS_NODE_MYSELF 16 /* This node is myself */
459 #define REDIS_NODE_HANDSHAKE 32 /* We have still to exchange the first ping */
460 #define REDIS_NODE_NOADDR 64 /* We don't know the address of this node */
461 #define REDIS_NODE_MEET 128 /* Send a MEET message to this node */
462 #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"
463
464 struct clusterNode {
465 char name[REDIS_CLUSTER_NAMELEN]; /* Node name, hex string, sha1-size */
466 int flags; /* REDIS_NODE_... */
467 unsigned char slots[REDIS_CLUSTER_SLOTS/8]; /* slots handled by this node */
468 int numslaves; /* Number of slave nodes, if this is a master */
469 struct clusterNode **slaves; /* pointers to slave nodes */
470 struct clusterNode *slaveof; /* pointer to the master node */
471 time_t ping_sent; /* Unix time we sent latest ping */
472 time_t pong_received; /* Unix time we received the pong */
473 char *configdigest; /* Configuration digest of this node */
474 time_t configdigest_ts; /* Configuration digest timestamp */
475 char ip[16]; /* Latest known IP address of this node */
476 int port; /* Latest known port of this node */
477 clusterLink *link; /* TCP/IP link with this node */
478 };
479 typedef struct clusterNode clusterNode;
480
481 typedef struct {
482 char *configfile;
483 clusterNode *myself; /* This node */
484 int state; /* REDIS_CLUSTER_OK, REDIS_CLUSTER_FAIL, ... */
485 int node_timeout;
486 dict *nodes; /* Hash table of name -> clusterNode structures */
487 clusterNode *migrating_slots_to[REDIS_CLUSTER_SLOTS];
488 clusterNode *importing_slots_from[REDIS_CLUSTER_SLOTS];
489 clusterNode *slots[REDIS_CLUSTER_SLOTS];
490 zskiplist *slots_to_keys;
491 } clusterState;
492
493 /* Redis cluster messages header */
494
495 /* Note that the PING, PONG and MEET messages are actually the same exact
496 * kind of packet. PONG is the reply to ping, in the extact format as a PING,
497 * while MEET is a special PING that forces the receiver to add the sender
498 * as a node (if it is not already in the list). */
499 #define CLUSTERMSG_TYPE_PING 0 /* Ping */
500 #define CLUSTERMSG_TYPE_PONG 1 /* Pong (reply to Ping) */
501 #define CLUSTERMSG_TYPE_MEET 2 /* Meet "let's join" message */
502 #define CLUSTERMSG_TYPE_FAIL 3 /* Mark node xxx as failing */
503 #define CLUSTERMSG_TYPE_PUBLISH 4 /* Pub/Sub Publish propatagion */
504
505 /* Initially we don't know our "name", but we'll find it once we connect
506 * to the first node, using the getsockname() function. Then we'll use this
507 * address for all the next messages. */
508 typedef struct {
509 char nodename[REDIS_CLUSTER_NAMELEN];
510 uint32_t ping_sent;
511 uint32_t pong_received;
512 char ip[16]; /* IP address last time it was seen */
513 uint16_t port; /* port last time it was seen */
514 uint16_t flags;
515 uint32_t notused; /* for 64 bit alignment */
516 } clusterMsgDataGossip;
517
518 typedef struct {
519 char nodename[REDIS_CLUSTER_NAMELEN];
520 } clusterMsgDataFail;
521
522 typedef struct {
523 uint32_t channel_len;
524 uint32_t message_len;
525 unsigned char bulk_data[8]; /* defined as 8 just for alignment concerns. */
526 } clusterMsgDataPublish;
527
528 union clusterMsgData {
529 /* PING, MEET and PONG */
530 struct {
531 /* Array of N clusterMsgDataGossip structures */
532 clusterMsgDataGossip gossip[1];
533 } ping;
534
535 /* FAIL */
536 struct {
537 clusterMsgDataFail about;
538 } fail;
539
540 /* PUBLISH */
541 struct {
542 clusterMsgDataPublish msg;
543 } publish;
544 };
545
546 typedef struct {
547 uint32_t totlen; /* Total length of this message */
548 uint16_t type; /* Message type */
549 uint16_t count; /* Only used for some kind of messages. */
550 char sender[REDIS_CLUSTER_NAMELEN]; /* Name of the sender node */
551 unsigned char myslots[REDIS_CLUSTER_SLOTS/8];
552 char slaveof[REDIS_CLUSTER_NAMELEN];
553 char configdigest[32];
554 uint16_t port; /* Sender TCP base port */
555 unsigned char state; /* Cluster state from the POV of the sender */
556 unsigned char notused[5]; /* Reserved for future use. For alignment. */
557 union clusterMsgData data;
558 } clusterMsg;
559
560 /*-----------------------------------------------------------------------------
561 * Global server state
562 *----------------------------------------------------------------------------*/
563
564 struct redisServer {
565 /* General */
566 redisDb *db;
567 dict *commands; /* Command table hahs table */
568 aeEventLoop *el;
569 unsigned lruclock:22; /* Clock incrementing every minute, for LRU */
570 unsigned lruclock_padding:10;
571 int shutdown_asap; /* SHUTDOWN needed ASAP */
572 int activerehashing; /* Incremental rehash in serverCron() */
573 char *requirepass; /* Pass for AUTH command, or NULL */
574 char *pidfile; /* PID file path */
575 int arch_bits; /* 32 or 64 depending on sizeof(long) */
576 int cronloops; /* Number of times the cron function run */
577 char runid[REDIS_RUN_ID_SIZE+1]; /* ID always different at every exec. */
578 /* Networking */
579 int port; /* TCP listening port */
580 char *bindaddr; /* Bind address or NULL */
581 char *unixsocket; /* UNIX socket path */
582 mode_t unixsocketperm; /* UNIX socket permission */
583 int ipfd; /* TCP socket file descriptor */
584 int sofd; /* Unix socket file descriptor */
585 int cfd; /* Cluster bus lisetning socket */
586 list *clients; /* List of active clients */
587 list *clients_to_close; /* Clients to close asynchronously */
588 list *slaves, *monitors; /* List of slaves and MONITORs */
589 redisClient *current_client; /* Current client, only used on crash report */
590 char neterr[ANET_ERR_LEN]; /* Error buffer for anet.c */
591 /* RDB / AOF loading information */
592 int loading; /* We are loading data from disk if true */
593 off_t loading_total_bytes;
594 off_t loading_loaded_bytes;
595 time_t loading_start_time;
596 /* Fast pointers to often looked up command */
597 struct redisCommand *delCommand, *multiCommand, *lpushCommand;
598 /* Fields used only for stats */
599 time_t stat_starttime; /* Server start time */
600 long long stat_numcommands; /* Number of processed commands */
601 long long stat_numconnections; /* Number of connections received */
602 long long stat_expiredkeys; /* Number of expired keys */
603 long long stat_evictedkeys; /* Number of evicted keys (maxmemory) */
604 long long stat_keyspace_hits; /* Number of successful lookups of keys */
605 long long stat_keyspace_misses; /* Number of failed lookups of keys */
606 size_t stat_peak_memory; /* Max used memory record */
607 long long stat_fork_time; /* Time needed to perform latets fork() */
608 long long stat_rejected_conn; /* Clients rejected because of maxclients */
609 list *slowlog; /* SLOWLOG list of commands */
610 long long slowlog_entry_id; /* SLOWLOG current entry ID */
611 long long slowlog_log_slower_than; /* SLOWLOG time limit (to get logged) */
612 unsigned long slowlog_max_len; /* SLOWLOG max number of items logged */
613 /* The following two are used to track instantaneous "load" in terms
614 * of operations per second. */
615 long long ops_sec_last_sample_time; /* Timestamp of last sample (in ms) */
616 long long ops_sec_last_sample_ops; /* numcommands in last sample */
617 long long ops_sec_samples[REDIS_OPS_SEC_SAMPLES];
618 int ops_sec_idx;
619 /* Configuration */
620 int verbosity; /* Loglevel in redis.conf */
621 int maxidletime; /* Client timeout in seconds */
622 size_t client_max_querybuf_len; /* Limit for client query buffer length */
623 int dbnum; /* Total number of configured DBs */
624 int daemonize; /* True if running as a daemon */
625 clientBufferLimitsConfig client_obuf_limits[REDIS_CLIENT_LIMIT_NUM_CLASSES];
626 /* AOF persistence */
627 int aof_state; /* REDIS_AOF_(ON|OFF|WAIT_REWRITE) */
628 int aof_fsync; /* Kind of fsync() policy */
629 char *aof_filename; /* Name of the AOF file */
630 int aof_no_fsync_on_rewrite; /* Don't fsync if a rewrite is in prog. */
631 int aof_rewrite_perc; /* Rewrite AOF if % growth is > M and... */
632 off_t aof_rewrite_min_size; /* the AOF file is at least N bytes. */
633 off_t aof_rewrite_base_size; /* AOF size on latest startup or rewrite. */
634 off_t aof_current_size; /* AOF current size. */
635 int aof_rewrite_scheduled; /* Rewrite once BGSAVE terminates. */
636 pid_t aof_child_pid; /* PID if rewriting process */
637 list *aof_rewrite_buf_blocks; /* Hold changes during an AOF rewrite. */
638 sds aof_buf; /* AOF buffer, written before entering the event loop */
639 int aof_fd; /* File descriptor of currently selected AOF file */
640 int aof_selected_db; /* Currently selected DB in AOF */
641 time_t aof_flush_postponed_start; /* UNIX time of postponed AOF flush */
642 time_t aof_last_fsync; /* UNIX time of last fsync() */
643 time_t aof_rewrite_time_last; /* Time used by last AOF rewrite run. */
644 time_t aof_rewrite_time_start; /* Current AOF rewrite start time. */
645 unsigned long aof_delayed_fsync; /* delayed AOF fsync() counter */
646 /* RDB persistence */
647 long long dirty; /* Changes to DB from the last save */
648 long long dirty_before_bgsave; /* Used to restore dirty on failed BGSAVE */
649 pid_t rdb_child_pid; /* PID of RDB saving child */
650 struct saveparam *saveparams; /* Save points array for RDB */
651 int saveparamslen; /* Number of saving points */
652 char *rdb_filename; /* Name of RDB file */
653 int rdb_compression; /* Use compression in RDB? */
654 int rdb_checksum; /* Use RDB checksum? */
655 time_t lastsave; /* Unix time of last save succeeede */
656 time_t rdb_save_time_last; /* Time used by last RDB save run. */
657 time_t rdb_save_time_start; /* Current RDB save start time. */
658 int lastbgsave_status; /* REDIS_OK or REDIS_ERR */
659 int stop_writes_on_bgsave_err; /* Don't allow writes if can't BGSAVE */
660 /* Propagation of commands in AOF / replication */
661 redisOpArray also_propagate; /* Additional command to propagate. */
662 /* Logging */
663 char *logfile; /* Path of log file */
664 int syslog_enabled; /* Is syslog enabled? */
665 char *syslog_ident; /* Syslog ident */
666 int syslog_facility; /* Syslog facility */
667 /* Slave specific fields */
668 char *masterauth; /* AUTH with this password with master */
669 char *masterhost; /* Hostname of master */
670 int masterport; /* Port of master */
671 int repl_ping_slave_period; /* Master pings the salve every N seconds */
672 int repl_timeout; /* Timeout after N seconds of master idle */
673 redisClient *master; /* Client that is master for this slave */
674 int repl_syncio_timeout; /* Timeout for synchronous I/O calls */
675 int repl_state; /* Replication status if the instance is a slave */
676 off_t repl_transfer_left; /* Bytes left reading .rdb */
677 int repl_transfer_s; /* Slave -> Master SYNC socket */
678 int repl_transfer_fd; /* Slave -> Master SYNC temp file descriptor */
679 char *repl_transfer_tmpfile; /* Slave-> master SYNC temp file name */
680 time_t repl_transfer_lastio; /* Unix time of the latest read, for timeout */
681 int repl_serve_stale_data; /* Serve stale data when link is down? */
682 int repl_slave_ro; /* Slave is read only? */
683 time_t repl_down_since; /* Unix time at which link with master went down */
684 /* Limits */
685 unsigned int maxclients; /* Max number of simultaneous clients */
686 unsigned long long maxmemory; /* Max number of memory bytes to use */
687 int maxmemory_policy; /* Policy for key evition */
688 int maxmemory_samples; /* Pricision of random sampling */
689 /* Blocked clients */
690 unsigned int bpop_blocked_clients; /* Number of clients blocked by lists */
691 list *unblocked_clients; /* list of clients to unblock before next loop */
692 /* Sort parameters - qsort_r() is only available under BSD so we
693 * have to take this state global, in order to pass it to sortCompare() */
694 int sort_dontsort;
695 int sort_desc;
696 int sort_alpha;
697 int sort_bypattern;
698 /* Zip structure config, see redis.conf for more information */
699 size_t hash_max_ziplist_entries;
700 size_t hash_max_ziplist_value;
701 size_t list_max_ziplist_entries;
702 size_t list_max_ziplist_value;
703 size_t set_max_intset_entries;
704 size_t zset_max_ziplist_entries;
705 size_t zset_max_ziplist_value;
706 time_t unixtime; /* Unix time sampled every second. */
707 /* Pubsub */
708 dict *pubsub_channels; /* Map channels to list of subscribed clients */
709 list *pubsub_patterns; /* A list of pubsub_patterns */
710 /* Cluster */
711 int cluster_enabled; /* Is cluster enabled? */
712 clusterState cluster; /* State of the cluster */
713 /* Scripting */
714 lua_State *lua; /* The Lua interpreter. We use just one for all clients */
715 redisClient *lua_client; /* The "fake client" to query Redis from Lua */
716 redisClient *lua_caller; /* The client running EVAL right now, or NULL */
717 dict *lua_scripts; /* A dictionary of SHA1 -> Lua scripts */
718 long long lua_time_limit; /* Script timeout in seconds */
719 long long lua_time_start; /* Start time of script */
720 int lua_write_dirty; /* True if a write command was called during the
721 execution of the current script. */
722 int lua_random_dirty; /* True if a random command was called during the
723 execution of the current script. */
724 int lua_timedout; /* True if we reached the time limit for script
725 execution. */
726 int lua_kill; /* Kill the script if true. */
727 /* Assert & bug reportign */
728 char *assert_failed;
729 char *assert_file;
730 int assert_line;
731 int bug_report_start; /* True if bug report header was already logged. */
732 int watchdog_period; /* Software watchdog period in ms. 0 = off */
733 };
734
735 typedef struct pubsubPattern {
736 redisClient *client;
737 robj *pattern;
738 } pubsubPattern;
739
740 typedef void redisCommandProc(redisClient *c);
741 typedef int *redisGetKeysProc(struct redisCommand *cmd, robj **argv, int argc, int *numkeys, int flags);
742 struct redisCommand {
743 char *name;
744 redisCommandProc *proc;
745 int arity;
746 char *sflags; /* Flags as string represenation, one char per flag. */
747 int flags; /* The actual flags, obtained from the 'sflags' field. */
748 /* Use a function to determine keys arguments in a command line.
749 * Used for Redis Cluster redirect. */
750 redisGetKeysProc *getkeys_proc;
751 /* What keys should be loaded in background when calling this command? */
752 int firstkey; /* The first argument that's a key (0 = no keys) */
753 int lastkey; /* THe last argument that's a key */
754 int keystep; /* The step between first and last key */
755 long long microseconds, calls;
756 };
757
758 struct redisFunctionSym {
759 char *name;
760 unsigned long pointer;
761 };
762
763 typedef struct _redisSortObject {
764 robj *obj;
765 union {
766 double score;
767 robj *cmpobj;
768 } u;
769 } redisSortObject;
770
771 typedef struct _redisSortOperation {
772 int type;
773 robj *pattern;
774 } redisSortOperation;
775
776 /* Structure to hold list iteration abstraction. */
777 typedef struct {
778 robj *subject;
779 unsigned char encoding;
780 unsigned char direction; /* Iteration direction */
781 unsigned char *zi;
782 listNode *ln;
783 } listTypeIterator;
784
785 /* Structure for an entry while iterating over a list. */
786 typedef struct {
787 listTypeIterator *li;
788 unsigned char *zi; /* Entry in ziplist */
789 listNode *ln; /* Entry in linked list */
790 } listTypeEntry;
791
792 /* Structure to hold set iteration abstraction. */
793 typedef struct {
794 robj *subject;
795 int encoding;
796 int ii; /* intset iterator */
797 dictIterator *di;
798 } setTypeIterator;
799
800 /* Structure to hold hash iteration abstration. Note that iteration over
801 * hashes involves both fields and values. Because it is possible that
802 * not both are required, store pointers in the iterator to avoid
803 * unnecessary memory allocation for fields/values. */
804 typedef struct {
805 robj *subject;
806 int encoding;
807
808 unsigned char *fptr, *vptr;
809
810 dictIterator *di;
811 dictEntry *de;
812 } hashTypeIterator;
813
814 #define REDIS_HASH_KEY 1
815 #define REDIS_HASH_VALUE 2
816
817 /*-----------------------------------------------------------------------------
818 * Extern declarations
819 *----------------------------------------------------------------------------*/
820
821 extern struct redisServer server;
822 extern struct sharedObjectsStruct shared;
823 extern dictType setDictType;
824 extern dictType zsetDictType;
825 extern dictType clusterNodesDictType;
826 extern dictType dbDictType;
827 extern double R_Zero, R_PosInf, R_NegInf, R_Nan;
828 extern dictType hashDictType;
829
830 /*-----------------------------------------------------------------------------
831 * Functions prototypes
832 *----------------------------------------------------------------------------*/
833
834 /* Utils */
835 long long ustime(void);
836 long long mstime(void);
837 void getRandomHexChars(char *p, unsigned int len);
838 uint64_t crc64(uint64_t crc, const unsigned char *s, uint64_t l);
839 void exitFromChild(int retcode);
840
841 /* networking.c -- Networking and Client related operations */
842 redisClient *createClient(int fd);
843 void closeTimedoutClients(void);
844 void freeClient(redisClient *c);
845 void resetClient(redisClient *c);
846 void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask);
847 void addReply(redisClient *c, robj *obj);
848 void *addDeferredMultiBulkLength(redisClient *c);
849 void setDeferredMultiBulkLength(redisClient *c, void *node, long length);
850 void addReplySds(redisClient *c, sds s);
851 void processInputBuffer(redisClient *c);
852 void acceptTcpHandler(aeEventLoop *el, int fd, void *privdata, int mask);
853 void acceptUnixHandler(aeEventLoop *el, int fd, void *privdata, int mask);
854 void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask);
855 void addReplyBulk(redisClient *c, robj *obj);
856 void addReplyBulkCString(redisClient *c, char *s);
857 void addReplyBulkCBuffer(redisClient *c, void *p, size_t len);
858 void addReplyBulkLongLong(redisClient *c, long long ll);
859 void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask);
860 void addReply(redisClient *c, robj *obj);
861 void addReplySds(redisClient *c, sds s);
862 void addReplyError(redisClient *c, char *err);
863 void addReplyStatus(redisClient *c, char *status);
864 void addReplyDouble(redisClient *c, double d);
865 void addReplyLongLong(redisClient *c, long long ll);
866 void addReplyMultiBulkLen(redisClient *c, long length);
867 void copyClientOutputBuffer(redisClient *dst, redisClient *src);
868 void *dupClientReplyValue(void *o);
869 void getClientsMaxBuffers(unsigned long *longest_output_list,
870 unsigned long *biggest_input_buffer);
871 sds getClientInfoString(redisClient *client);
872 sds getAllClientsInfoString(void);
873 void rewriteClientCommandVector(redisClient *c, int argc, ...);
874 void rewriteClientCommandArgument(redisClient *c, int i, robj *newval);
875 unsigned long getClientOutputBufferMemoryUsage(redisClient *c);
876 void freeClientsInAsyncFreeQueue(void);
877 void asyncCloseClientOnOutputBufferLimitReached(redisClient *c);
878 int getClientLimitClassByName(char *name);
879 char *getClientLimitClassName(int class);
880 void flushSlavesOutputBuffers(void);
881 void disconnectSlaves(void);
882
883 #ifdef __GNUC__
884 void addReplyErrorFormat(redisClient *c, const char *fmt, ...)
885 __attribute__((format(printf, 2, 3)));
886 void addReplyStatusFormat(redisClient *c, const char *fmt, ...)
887 __attribute__((format(printf, 2, 3)));
888 #else
889 void addReplyErrorFormat(redisClient *c, const char *fmt, ...);
890 void addReplyStatusFormat(redisClient *c, const char *fmt, ...);
891 #endif
892
893 /* List data type */
894 void listTypeTryConversion(robj *subject, robj *value);
895 void listTypePush(robj *subject, robj *value, int where);
896 robj *listTypePop(robj *subject, int where);
897 unsigned long listTypeLength(robj *subject);
898 listTypeIterator *listTypeInitIterator(robj *subject, long index, unsigned char direction);
899 void listTypeReleaseIterator(listTypeIterator *li);
900 int listTypeNext(listTypeIterator *li, listTypeEntry *entry);
901 robj *listTypeGet(listTypeEntry *entry);
902 void listTypeInsert(listTypeEntry *entry, robj *value, int where);
903 int listTypeEqual(listTypeEntry *entry, robj *o);
904 void listTypeDelete(listTypeEntry *entry);
905 void listTypeConvert(robj *subject, int enc);
906 void unblockClientWaitingData(redisClient *c);
907 int handleClientsWaitingListPush(redisClient *c, robj *key, robj *ele);
908 void popGenericCommand(redisClient *c, int where);
909
910 /* MULTI/EXEC/WATCH... */
911 void unwatchAllKeys(redisClient *c);
912 void initClientMultiState(redisClient *c);
913 void freeClientMultiState(redisClient *c);
914 void queueMultiCommand(redisClient *c);
915 void touchWatchedKey(redisDb *db, robj *key);
916 void touchWatchedKeysOnFlush(int dbid);
917 void discardTransaction(redisClient *c);
918
919 /* Redis object implementation */
920 void decrRefCount(void *o);
921 void incrRefCount(robj *o);
922 robj *resetRefCount(robj *obj);
923 void freeStringObject(robj *o);
924 void freeListObject(robj *o);
925 void freeSetObject(robj *o);
926 void freeZsetObject(robj *o);
927 void freeHashObject(robj *o);
928 robj *createObject(int type, void *ptr);
929 robj *createStringObject(char *ptr, size_t len);
930 robj *dupStringObject(robj *o);
931 int isObjectRepresentableAsLongLong(robj *o, long long *llongval);
932 robj *tryObjectEncoding(robj *o);
933 robj *getDecodedObject(robj *o);
934 size_t stringObjectLen(robj *o);
935 robj *createStringObjectFromLongLong(long long value);
936 robj *createStringObjectFromLongDouble(long double value);
937 robj *createListObject(void);
938 robj *createZiplistObject(void);
939 robj *createSetObject(void);
940 robj *createIntsetObject(void);
941 robj *createHashObject(void);
942 robj *createZsetObject(void);
943 robj *createZsetZiplistObject(void);
944 int getLongFromObjectOrReply(redisClient *c, robj *o, long *target, const char *msg);
945 int checkType(redisClient *c, robj *o, int type);
946 int getLongLongFromObjectOrReply(redisClient *c, robj *o, long long *target, const char *msg);
947 int getDoubleFromObjectOrReply(redisClient *c, robj *o, double *target, const char *msg);
948 int getLongLongFromObject(robj *o, long long *target);
949 int getLongDoubleFromObject(robj *o, long double *target);
950 int getLongDoubleFromObjectOrReply(redisClient *c, robj *o, long double *target, const char *msg);
951 char *strEncoding(int encoding);
952 int compareStringObjects(robj *a, robj *b);
953 int equalStringObjects(robj *a, robj *b);
954 unsigned long estimateObjectIdleTime(robj *o);
955
956 /* Synchronous I/O with timeout */
957 ssize_t syncWrite(int fd, char *ptr, ssize_t size, long long timeout);
958 ssize_t syncRead(int fd, char *ptr, ssize_t size, long long timeout);
959 ssize_t syncReadLine(int fd, char *ptr, ssize_t size, long long timeout);
960
961 /* Replication */
962 void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc);
963 void replicationFeedMonitors(redisClient *c, list *monitors, int dictid, robj **argv, int argc);
964 void updateSlavesWaitingBgsave(int bgsaveerr);
965 void replicationCron(void);
966
967 /* Generic persistence functions */
968 void startLoading(FILE *fp);
969 void loadingProgress(off_t pos);
970 void stopLoading(void);
971
972 /* RDB persistence */
973 #include "rdb.h"
974
975 /* AOF persistence */
976 void flushAppendOnlyFile(int force);
977 void feedAppendOnlyFile(struct redisCommand *cmd, int dictid, robj **argv, int argc);
978 void aofRemoveTempFile(pid_t childpid);
979 int rewriteAppendOnlyFileBackground(void);
980 int loadAppendOnlyFile(char *filename);
981 void stopAppendOnly(void);
982 int startAppendOnly(void);
983 void backgroundRewriteDoneHandler(int exitcode, int bysignal);
984 void aofRewriteBufferReset(void);
985 unsigned long aofRewriteBufferSize(void);
986
987 /* Sorted sets data type */
988
989 /* Struct to hold a inclusive/exclusive range spec. */
990 typedef struct {
991 double min, max;
992 int minex, maxex; /* are min or max exclusive? */
993 } zrangespec;
994
995 zskiplist *zslCreate(void);
996 void zslFree(zskiplist *zsl);
997 zskiplistNode *zslInsert(zskiplist *zsl, double score, robj *obj);
998 unsigned char *zzlInsert(unsigned char *zl, robj *ele, double score);
999 int zslDelete(zskiplist *zsl, double score, robj *obj);
1000 zskiplistNode *zslFirstInRange(zskiplist *zsl, zrangespec range);
1001 double zzlGetScore(unsigned char *sptr);
1002 void zzlNext(unsigned char *zl, unsigned char **eptr, unsigned char **sptr);
1003 void zzlPrev(unsigned char *zl, unsigned char **eptr, unsigned char **sptr);
1004 unsigned int zsetLength(robj *zobj);
1005 void zsetConvert(robj *zobj, int encoding);
1006
1007 /* Core functions */
1008 int freeMemoryIfNeeded(void);
1009 int processCommand(redisClient *c);
1010 void setupSignalHandlers(void);
1011 struct redisCommand *lookupCommand(sds name);
1012 struct redisCommand *lookupCommandByCString(char *s);
1013 void call(redisClient *c, int flags);
1014 void propagate(struct redisCommand *cmd, int dbid, robj **argv, int argc, int flags);
1015 void alsoPropagate(struct redisCommand *cmd, int dbid, robj **argv, int argc, int target);
1016 int prepareForShutdown();
1017 void redisLog(int level, const char *fmt, ...);
1018 void redisLogRaw(int level, const char *msg);
1019 void redisLogFromHandler(int level, const char *msg);
1020 void usage();
1021 void updateDictResizePolicy(void);
1022 int htNeedsResize(dict *dict);
1023 void oom(const char *msg);
1024 void populateCommandTable(void);
1025 void resetCommandTableStats(void);
1026
1027 /* Set data type */
1028 robj *setTypeCreate(robj *value);
1029 int setTypeAdd(robj *subject, robj *value);
1030 int setTypeRemove(robj *subject, robj *value);
1031 int setTypeIsMember(robj *subject, robj *value);
1032 setTypeIterator *setTypeInitIterator(robj *subject);
1033 void setTypeReleaseIterator(setTypeIterator *si);
1034 int setTypeNext(setTypeIterator *si, robj **objele, int64_t *llele);
1035 robj *setTypeNextObject(setTypeIterator *si);
1036 int setTypeRandomElement(robj *setobj, robj **objele, int64_t *llele);
1037 unsigned long setTypeSize(robj *subject);
1038 void setTypeConvert(robj *subject, int enc);
1039
1040 /* Hash data type */
1041 void hashTypeConvert(robj *o, int enc);
1042 void hashTypeTryConversion(robj *subject, robj **argv, int start, int end);
1043 void hashTypeTryObjectEncoding(robj *subject, robj **o1, robj **o2);
1044 robj *hashTypeGetObject(robj *o, robj *key);
1045 int hashTypeExists(robj *o, robj *key);
1046 int hashTypeSet(robj *o, robj *key, robj *value);
1047 int hashTypeDelete(robj *o, robj *key);
1048 unsigned long hashTypeLength(robj *o);
1049 hashTypeIterator *hashTypeInitIterator(robj *subject);
1050 void hashTypeReleaseIterator(hashTypeIterator *hi);
1051 int hashTypeNext(hashTypeIterator *hi);
1052 void hashTypeCurrentFromZiplist(hashTypeIterator *hi, int what,
1053 unsigned char **vstr,
1054 unsigned int *vlen,
1055 long long *vll);
1056 void hashTypeCurrentFromHashTable(hashTypeIterator *hi, int what, robj **dst);
1057 robj *hashTypeCurrentObject(hashTypeIterator *hi, int what);
1058 robj *hashTypeLookupWriteOrCreate(redisClient *c, robj *key);
1059
1060 /* Pub / Sub */
1061 int pubsubUnsubscribeAllChannels(redisClient *c, int notify);
1062 int pubsubUnsubscribeAllPatterns(redisClient *c, int notify);
1063 void freePubsubPattern(void *p);
1064 int listMatchPubsubPattern(void *a, void *b);
1065 int pubsubPublishMessage(robj *channel, robj *message);
1066
1067 /* Configuration */
1068 void loadServerConfig(char *filename, char *options);
1069 void appendServerSaveParams(time_t seconds, int changes);
1070 void resetServerSaveParams();
1071
1072 /* db.c -- Keyspace access API */
1073 int removeExpire(redisDb *db, robj *key);
1074 void propagateExpire(redisDb *db, robj *key);
1075 int expireIfNeeded(redisDb *db, robj *key);
1076 long long getExpire(redisDb *db, robj *key);
1077 void setExpire(redisDb *db, robj *key, long long when);
1078 robj *lookupKey(redisDb *db, robj *key);
1079 robj *lookupKeyRead(redisDb *db, robj *key);
1080 robj *lookupKeyWrite(redisDb *db, robj *key);
1081 robj *lookupKeyReadOrReply(redisClient *c, robj *key, robj *reply);
1082 robj *lookupKeyWriteOrReply(redisClient *c, robj *key, robj *reply);
1083 void dbAdd(redisDb *db, robj *key, robj *val);
1084 void dbOverwrite(redisDb *db, robj *key, robj *val);
1085 void setKey(redisDb *db, robj *key, robj *val);
1086 int dbExists(redisDb *db, robj *key);
1087 robj *dbRandomKey(redisDb *db);
1088 int dbDelete(redisDb *db, robj *key);
1089 long long emptyDb();
1090 int selectDb(redisClient *c, int id);
1091 void signalModifiedKey(redisDb *db, robj *key);
1092 void signalFlushedDb(int dbid);
1093 unsigned int GetKeysInSlot(unsigned int hashslot, robj **keys, unsigned int count);
1094
1095 /* API to get key arguments from commands */
1096 #define REDIS_GETKEYS_ALL 0
1097 #define REDIS_GETKEYS_PRELOAD 1
1098 int *getKeysFromCommand(struct redisCommand *cmd, robj **argv, int argc, int *numkeys, int flags);
1099 void getKeysFreeResult(int *result);
1100 int *noPreloadGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags);
1101 int *renameGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags);
1102 int *zunionInterGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags);
1103
1104 /* Cluster */
1105 void clusterInit(void);
1106 unsigned short crc16(const char *buf, int len);
1107 unsigned int keyHashSlot(char *key, int keylen);
1108 clusterNode *createClusterNode(char *nodename, int flags);
1109 int clusterAddNode(clusterNode *node);
1110 void clusterCron(void);
1111 clusterNode *getNodeByQuery(redisClient *c, struct redisCommand *cmd, robj **argv, int argc, int *hashslot, int *ask);
1112 void clusterPropagatePublish(robj *channel, robj *message);
1113
1114 /* Scripting */
1115 void scriptingInit(void);
1116
1117 /* Git SHA1 */
1118 char *redisGitSHA1(void);
1119 char *redisGitDirty(void);
1120
1121 /* Commands prototypes */
1122 void authCommand(redisClient *c);
1123 void pingCommand(redisClient *c);
1124 void echoCommand(redisClient *c);
1125 void setCommand(redisClient *c);
1126 void setnxCommand(redisClient *c);
1127 void setexCommand(redisClient *c);
1128 void psetexCommand(redisClient *c);
1129 void getCommand(redisClient *c);
1130 void delCommand(redisClient *c);
1131 void existsCommand(redisClient *c);
1132 void setbitCommand(redisClient *c);
1133 void getbitCommand(redisClient *c);
1134 void setrangeCommand(redisClient *c);
1135 void getrangeCommand(redisClient *c);
1136 void incrCommand(redisClient *c);
1137 void decrCommand(redisClient *c);
1138 void incrbyCommand(redisClient *c);
1139 void decrbyCommand(redisClient *c);
1140 void incrbyfloatCommand(redisClient *c);
1141 void selectCommand(redisClient *c);
1142 void randomkeyCommand(redisClient *c);
1143 void keysCommand(redisClient *c);
1144 void dbsizeCommand(redisClient *c);
1145 void lastsaveCommand(redisClient *c);
1146 void saveCommand(redisClient *c);
1147 void bgsaveCommand(redisClient *c);
1148 void bgrewriteaofCommand(redisClient *c);
1149 void shutdownCommand(redisClient *c);
1150 void moveCommand(redisClient *c);
1151 void renameCommand(redisClient *c);
1152 void renamenxCommand(redisClient *c);
1153 void lpushCommand(redisClient *c);
1154 void rpushCommand(redisClient *c);
1155 void lpushxCommand(redisClient *c);
1156 void rpushxCommand(redisClient *c);
1157 void linsertCommand(redisClient *c);
1158 void lpopCommand(redisClient *c);
1159 void rpopCommand(redisClient *c);
1160 void llenCommand(redisClient *c);
1161 void lindexCommand(redisClient *c);
1162 void lrangeCommand(redisClient *c);
1163 void ltrimCommand(redisClient *c);
1164 void typeCommand(redisClient *c);
1165 void lsetCommand(redisClient *c);
1166 void saddCommand(redisClient *c);
1167 void sremCommand(redisClient *c);
1168 void smoveCommand(redisClient *c);
1169 void sismemberCommand(redisClient *c);
1170 void scardCommand(redisClient *c);
1171 void spopCommand(redisClient *c);
1172 void srandmemberCommand(redisClient *c);
1173 void sinterCommand(redisClient *c);
1174 void sinterstoreCommand(redisClient *c);
1175 void sunionCommand(redisClient *c);
1176 void sunionstoreCommand(redisClient *c);
1177 void sdiffCommand(redisClient *c);
1178 void sdiffstoreCommand(redisClient *c);
1179 void syncCommand(redisClient *c);
1180 void flushdbCommand(redisClient *c);
1181 void flushallCommand(redisClient *c);
1182 void sortCommand(redisClient *c);
1183 void lremCommand(redisClient *c);
1184 void rpoplpushCommand(redisClient *c);
1185 void infoCommand(redisClient *c);
1186 void mgetCommand(redisClient *c);
1187 void monitorCommand(redisClient *c);
1188 void expireCommand(redisClient *c);
1189 void expireatCommand(redisClient *c);
1190 void pexpireCommand(redisClient *c);
1191 void pexpireatCommand(redisClient *c);
1192 void getsetCommand(redisClient *c);
1193 void ttlCommand(redisClient *c);
1194 void pttlCommand(redisClient *c);
1195 void persistCommand(redisClient *c);
1196 void slaveofCommand(redisClient *c);
1197 void debugCommand(redisClient *c);
1198 void msetCommand(redisClient *c);
1199 void msetnxCommand(redisClient *c);
1200 void zaddCommand(redisClient *c);
1201 void zincrbyCommand(redisClient *c);
1202 void zrangeCommand(redisClient *c);
1203 void zrangebyscoreCommand(redisClient *c);
1204 void zrevrangebyscoreCommand(redisClient *c);
1205 void zcountCommand(redisClient *c);
1206 void zrevrangeCommand(redisClient *c);
1207 void zcardCommand(redisClient *c);
1208 void zremCommand(redisClient *c);
1209 void zscoreCommand(redisClient *c);
1210 void zremrangebyscoreCommand(redisClient *c);
1211 void multiCommand(redisClient *c);
1212 void execCommand(redisClient *c);
1213 void discardCommand(redisClient *c);
1214 void blpopCommand(redisClient *c);
1215 void brpopCommand(redisClient *c);
1216 void brpoplpushCommand(redisClient *c);
1217 void appendCommand(redisClient *c);
1218 void strlenCommand(redisClient *c);
1219 void zrankCommand(redisClient *c);
1220 void zrevrankCommand(redisClient *c);
1221 void hsetCommand(redisClient *c);
1222 void hsetnxCommand(redisClient *c);
1223 void hgetCommand(redisClient *c);
1224 void hmsetCommand(redisClient *c);
1225 void hmgetCommand(redisClient *c);
1226 void hdelCommand(redisClient *c);
1227 void hlenCommand(redisClient *c);
1228 void zremrangebyrankCommand(redisClient *c);
1229 void zunionstoreCommand(redisClient *c);
1230 void zinterstoreCommand(redisClient *c);
1231 void hkeysCommand(redisClient *c);
1232 void hvalsCommand(redisClient *c);
1233 void hgetallCommand(redisClient *c);
1234 void hexistsCommand(redisClient *c);
1235 void configCommand(redisClient *c);
1236 void hincrbyCommand(redisClient *c);
1237 void hincrbyfloatCommand(redisClient *c);
1238 void subscribeCommand(redisClient *c);
1239 void unsubscribeCommand(redisClient *c);
1240 void psubscribeCommand(redisClient *c);
1241 void punsubscribeCommand(redisClient *c);
1242 void publishCommand(redisClient *c);
1243 void watchCommand(redisClient *c);
1244 void unwatchCommand(redisClient *c);
1245 void clusterCommand(redisClient *c);
1246 void restoreCommand(redisClient *c);
1247 void migrateCommand(redisClient *c);
1248 void askingCommand(redisClient *c);
1249 void dumpCommand(redisClient *c);
1250 void objectCommand(redisClient *c);
1251 void clientCommand(redisClient *c);
1252 void evalCommand(redisClient *c);
1253 void evalShaCommand(redisClient *c);
1254 void scriptCommand(redisClient *c);
1255 void timeCommand(redisClient *c);
1256 void bitopCommand(redisClient *c);
1257 void bitcountCommand(redisClient *c);
1258
1259 #if defined(__GNUC__)
1260 void *calloc(size_t count, size_t size) __attribute__ ((deprecated));
1261 void free(void *ptr) __attribute__ ((deprecated));
1262 void *malloc(size_t size) __attribute__ ((deprecated));
1263 void *realloc(void *ptr, size_t size) __attribute__ ((deprecated));
1264 #endif
1265
1266 /* Debugging stuff */
1267 void _redisAssertWithInfo(redisClient *c, robj *o, char *estr, char *file, int line);
1268 void _redisAssert(char *estr, char *file, int line);
1269 void _redisPanic(char *msg, char *file, int line);
1270 void bugReportStart(void);
1271 void redisLogObjectDebugInfo(robj *o);
1272 void sigsegvHandler(int sig, siginfo_t *info, void *secret);
1273 sds genRedisInfoString(char *section);
1274 void enableWatchdog(int period);
1275 void disableWatchdog(void);
1276 void watchdogScheduleSignal(int period);
1277 void redisLogHexDump(int level, char *descr, void *value, size_t len);
1278 #endif
Redis += OpenLDAP MDB