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