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


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