]>
Commit | Line | Data |
---|---|---|
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_MAX_WRITE_PER_EVENT (1024*64) | |
47 | #define REDIS_SHARED_INTEGERS 10000 | |
48 | #define REDIS_SHARED_BULKHDR_LEN 32 | |
49 | #define REDIS_MAX_LOGMSG_LEN 1024 /* Default maximum length of syslog messages */ | |
50 | #define REDIS_AOF_REWRITE_PERC 100 | |
51 | #define REDIS_AOF_REWRITE_MIN_SIZE (1024*1024) | |
52 | #define REDIS_AOF_REWRITE_ITEMS_PER_CMD 64 | |
53 | #define REDIS_SLOWLOG_LOG_SLOWER_THAN 10000 | |
54 | #define REDIS_SLOWLOG_MAX_LEN 64 | |
55 | #define REDIS_MAX_CLIENTS 10000 | |
56 | ||
57 | #define REDIS_REPL_TIMEOUT 60 | |
58 | #define REDIS_REPL_PING_SLAVE_PERIOD 10 | |
59 | ||
60 | #define REDIS_RUN_ID_SIZE 40 | |
61 | #define REDIS_OPS_SEC_SAMPLES 16 | |
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_ZIPLIST_ENTRIES 512 | |
211 | #define REDIS_HASH_MAX_ZIPLIST_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 | size_t querybuf_peak; /* Recent (100ms or more) peak of querybuf size */ | |
327 | int argc; | |
328 | robj **argv; | |
329 | struct redisCommand *cmd, *lastcmd; | |
330 | int reqtype; | |
331 | int multibulklen; /* number of multi bulk arguments left to read */ | |
332 | long bulklen; /* length of bulk argument in multi bulk request */ | |
333 | list *reply; | |
334 | unsigned long reply_bytes; /* Tot bytes of objects in reply list */ | |
335 | int sentlen; | |
336 | time_t ctime; /* Client creation time */ | |
337 | time_t lastinteraction; /* time of the last interaction, used for timeout */ | |
338 | time_t obuf_soft_limit_reached_time; | |
339 | int flags; /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */ | |
340 | int slaveseldb; /* slave selected db, if this client is a slave */ | |
341 | int authenticated; /* when requirepass is non-NULL */ | |
342 | int replstate; /* replication state if this is a slave */ | |
343 | int repldbfd; /* replication DB file descriptor */ | |
344 | long repldboff; /* replication DB file offset */ | |
345 | off_t repldbsize; /* replication DB file size */ | |
346 | multiState mstate; /* MULTI/EXEC state */ | |
347 | blockingState bpop; /* blocking state */ | |
348 | list *io_keys; /* Keys this client is waiting to be loaded from the | |
349 | * swap file in order to continue. */ | |
350 | list *watched_keys; /* Keys WATCHED for MULTI/EXEC CAS */ | |
351 | dict *pubsub_channels; /* channels a client is interested in (SUBSCRIBE) */ | |
352 | list *pubsub_patterns; /* patterns a client is interested in (SUBSCRIBE) */ | |
353 | ||
354 | /* Response buffer */ | |
355 | int bufpos; | |
356 | char buf[REDIS_REPLY_CHUNK_BYTES]; | |
357 | } redisClient; | |
358 | ||
359 | struct saveparam { | |
360 | time_t seconds; | |
361 | int changes; | |
362 | }; | |
363 | ||
364 | struct sharedObjectsStruct { | |
365 | robj *crlf, *ok, *err, *emptybulk, *czero, *cone, *cnegone, *pong, *space, | |
366 | *colon, *nullbulk, *nullmultibulk, *queued, | |
367 | *emptymultibulk, *wrongtypeerr, *nokeyerr, *syntaxerr, *sameobjecterr, | |
368 | *outofrangeerr, *noscripterr, *loadingerr, *slowscripterr, *bgsaveerr, | |
369 | *plus, *select0, *select1, *select2, *select3, *select4, | |
370 | *select5, *select6, *select7, *select8, *select9, | |
371 | *messagebulk, *pmessagebulk, *subscribebulk, *unsubscribebulk, | |
372 | *psubscribebulk, *punsubscribebulk, *del, *rpop, *lpop, | |
373 | *integers[REDIS_SHARED_INTEGERS], | |
374 | *mbulkhdr[REDIS_SHARED_BULKHDR_LEN], /* "*<value>\r\n" */ | |
375 | *bulkhdr[REDIS_SHARED_BULKHDR_LEN]; /* "$<value>\r\n" */ | |
376 | }; | |
377 | ||
378 | /* ZSETs use a specialized version of Skiplists */ | |
379 | typedef struct zskiplistNode { | |
380 | robj *obj; | |
381 | double score; | |
382 | struct zskiplistNode *backward; | |
383 | struct zskiplistLevel { | |
384 | struct zskiplistNode *forward; | |
385 | unsigned int span; | |
386 | } level[]; | |
387 | } zskiplistNode; | |
388 | ||
389 | typedef struct zskiplist { | |
390 | struct zskiplistNode *header, *tail; | |
391 | unsigned long length; | |
392 | int level; | |
393 | } zskiplist; | |
394 | ||
395 | typedef struct zset { | |
396 | dict *dict; | |
397 | zskiplist *zsl; | |
398 | } zset; | |
399 | ||
400 | typedef struct clientBufferLimitsConfig { | |
401 | unsigned long long hard_limit_bytes; | |
402 | unsigned long long soft_limit_bytes; | |
403 | time_t soft_limit_seconds; | |
404 | } clientBufferLimitsConfig; | |
405 | ||
406 | /* The redisOp structure defines a Redis Operation, that is an instance of | |
407 | * a command with an argument vector, database ID, propagation target | |
408 | * (REDIS_PROPAGATE_*), and command pointer. | |
409 | * | |
410 | * Currently only used to additionally propagate more commands to AOF/Replication | |
411 | * after the propagation of the executed command. */ | |
412 | typedef struct redisOp { | |
413 | robj **argv; | |
414 | int argc, dbid, target; | |
415 | struct redisCommand *cmd; | |
416 | } redisOp; | |
417 | ||
418 | /* Defines an array of Redis operations. There is an API to add to this | |
419 | * structure in a easy way. | |
420 | * | |
421 | * redisOpArrayInit(); | |
422 | * redisOpArrayAppend(); | |
423 | * redisOpArrayFree(); | |
424 | */ | |
425 | typedef struct redisOpArray { | |
426 | redisOp *ops; | |
427 | int numops; | |
428 | } redisOpArray; | |
429 | ||
430 | /*----------------------------------------------------------------------------- | |
431 | * Redis cluster data structures | |
432 | *----------------------------------------------------------------------------*/ | |
433 | ||
434 | #define REDIS_CLUSTER_SLOTS 4096 | |
435 | #define REDIS_CLUSTER_OK 0 /* Everything looks ok */ | |
436 | #define REDIS_CLUSTER_FAIL 1 /* The cluster can't work */ | |
437 | #define REDIS_CLUSTER_NEEDHELP 2 /* The cluster works, but needs some help */ | |
438 | #define REDIS_CLUSTER_NAMELEN 40 /* sha1 hex length */ | |
439 | #define REDIS_CLUSTER_PORT_INCR 10000 /* Cluster port = baseport + PORT_INCR */ | |
440 | ||
441 | struct clusterNode; | |
442 | ||
443 | /* clusterLink encapsulates everything needed to talk with a remote node. */ | |
444 | typedef struct clusterLink { | |
445 | int fd; /* TCP socket file descriptor */ | |
446 | sds sndbuf; /* Packet send buffer */ | |
447 | sds rcvbuf; /* Packet reception buffer */ | |
448 | struct clusterNode *node; /* Node related to this link if any, or NULL */ | |
449 | } clusterLink; | |
450 | ||
451 | /* Node flags */ | |
452 | #define REDIS_NODE_MASTER 1 /* The node is a master */ | |
453 | #define REDIS_NODE_SLAVE 2 /* The node is a slave */ | |
454 | #define REDIS_NODE_PFAIL 4 /* Failure? Need acknowledge */ | |
455 | #define REDIS_NODE_FAIL 8 /* The node is believed to be malfunctioning */ | |
456 | #define REDIS_NODE_MYSELF 16 /* This node is myself */ | |
457 | #define REDIS_NODE_HANDSHAKE 32 /* We have still to exchange the first ping */ | |
458 | #define REDIS_NODE_NOADDR 64 /* We don't know the address of this node */ | |
459 | #define REDIS_NODE_MEET 128 /* Send a MEET message to this node */ | |
460 | #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" | |
461 | ||
462 | struct clusterNode { | |
463 | char name[REDIS_CLUSTER_NAMELEN]; /* Node name, hex string, sha1-size */ | |
464 | int flags; /* REDIS_NODE_... */ | |
465 | unsigned char slots[REDIS_CLUSTER_SLOTS/8]; /* slots handled by this node */ | |
466 | int numslaves; /* Number of slave nodes, if this is a master */ | |
467 | struct clusterNode **slaves; /* pointers to slave nodes */ | |
468 | struct clusterNode *slaveof; /* pointer to the master node */ | |
469 | time_t ping_sent; /* Unix time we sent latest ping */ | |
470 | time_t pong_received; /* Unix time we received the pong */ | |
471 | char *configdigest; /* Configuration digest of this node */ | |
472 | time_t configdigest_ts; /* Configuration digest timestamp */ | |
473 | char ip[16]; /* Latest known IP address of this node */ | |
474 | int port; /* Latest known port of this node */ | |
475 | clusterLink *link; /* TCP/IP link with this node */ | |
476 | }; | |
477 | typedef struct clusterNode clusterNode; | |
478 | ||
479 | typedef struct { | |
480 | char *configfile; | |
481 | clusterNode *myself; /* This node */ | |
482 | int state; /* REDIS_CLUSTER_OK, REDIS_CLUSTER_FAIL, ... */ | |
483 | int node_timeout; | |
484 | dict *nodes; /* Hash table of name -> clusterNode structures */ | |
485 | clusterNode *migrating_slots_to[REDIS_CLUSTER_SLOTS]; | |
486 | clusterNode *importing_slots_from[REDIS_CLUSTER_SLOTS]; | |
487 | clusterNode *slots[REDIS_CLUSTER_SLOTS]; | |
488 | zskiplist *slots_to_keys; | |
489 | } clusterState; | |
490 | ||
491 | /* Redis cluster messages header */ | |
492 | ||
493 | /* Note that the PING, PONG and MEET messages are actually the same exact | |
494 | * kind of packet. PONG is the reply to ping, in the extact format as a PING, | |
495 | * while MEET is a special PING that forces the receiver to add the sender | |
496 | * as a node (if it is not already in the list). */ | |
497 | #define CLUSTERMSG_TYPE_PING 0 /* Ping */ | |
498 | #define CLUSTERMSG_TYPE_PONG 1 /* Pong (reply to Ping) */ | |
499 | #define CLUSTERMSG_TYPE_MEET 2 /* Meet "let's join" message */ | |
500 | #define CLUSTERMSG_TYPE_FAIL 3 /* Mark node xxx as failing */ | |
501 | #define CLUSTERMSG_TYPE_PUBLISH 4 /* Pub/Sub Publish propatagion */ | |
502 | ||
503 | /* Initially we don't know our "name", but we'll find it once we connect | |
504 | * to the first node, using the getsockname() function. Then we'll use this | |
505 | * address for all the next messages. */ | |
506 | typedef struct { | |
507 | char nodename[REDIS_CLUSTER_NAMELEN]; | |
508 | uint32_t ping_sent; | |
509 | uint32_t pong_received; | |
510 | char ip[16]; /* IP address last time it was seen */ | |
511 | uint16_t port; /* port last time it was seen */ | |
512 | uint16_t flags; | |
513 | uint32_t notused; /* for 64 bit alignment */ | |
514 | } clusterMsgDataGossip; | |
515 | ||
516 | typedef struct { | |
517 | char nodename[REDIS_CLUSTER_NAMELEN]; | |
518 | } clusterMsgDataFail; | |
519 | ||
520 | typedef struct { | |
521 | uint32_t channel_len; | |
522 | uint32_t message_len; | |
523 | unsigned char bulk_data[8]; /* defined as 8 just for alignment concerns. */ | |
524 | } clusterMsgDataPublish; | |
525 | ||
526 | union clusterMsgData { | |
527 | /* PING, MEET and PONG */ | |
528 | struct { | |
529 | /* Array of N clusterMsgDataGossip structures */ | |
530 | clusterMsgDataGossip gossip[1]; | |
531 | } ping; | |
532 | ||
533 | /* FAIL */ | |
534 | struct { | |
535 | clusterMsgDataFail about; | |
536 | } fail; | |
537 | ||
538 | /* PUBLISH */ | |
539 | struct { | |
540 | clusterMsgDataPublish msg; | |
541 | } publish; | |
542 | }; | |
543 | ||
544 | typedef struct { | |
545 | uint32_t totlen; /* Total length of this message */ | |
546 | uint16_t type; /* Message type */ | |
547 | uint16_t count; /* Only used for some kind of messages. */ | |
548 | char sender[REDIS_CLUSTER_NAMELEN]; /* Name of the sender node */ | |
549 | unsigned char myslots[REDIS_CLUSTER_SLOTS/8]; | |
550 | char slaveof[REDIS_CLUSTER_NAMELEN]; | |
551 | char configdigest[32]; | |
552 | uint16_t port; /* Sender TCP base port */ | |
553 | unsigned char state; /* Cluster state from the POV of the sender */ | |
554 | unsigned char notused[5]; /* Reserved for future use. For alignment. */ | |
555 | union clusterMsgData data; | |
556 | } clusterMsg; | |
557 | ||
558 | /*----------------------------------------------------------------------------- | |
559 | * Global server state | |
560 | *----------------------------------------------------------------------------*/ | |
561 | ||
562 | struct redisServer { | |
563 | /* General */ | |
564 | redisDb *db; | |
565 | dict *commands; /* Command table hahs table */ | |
566 | aeEventLoop *el; | |
567 | unsigned lruclock:22; /* Clock incrementing every minute, for LRU */ | |
568 | unsigned lruclock_padding:10; | |
569 | int shutdown_asap; /* SHUTDOWN needed ASAP */ | |
570 | int activerehashing; /* Incremental rehash in serverCron() */ | |
571 | char *requirepass; /* Pass for AUTH command, or NULL */ | |
572 | char *pidfile; /* PID file path */ | |
573 | int arch_bits; /* 32 or 64 depending on sizeof(long) */ | |
574 | int cronloops; /* Number of times the cron function run */ | |
575 | char runid[REDIS_RUN_ID_SIZE+1]; /* ID always different at every exec. */ | |
576 | /* Networking */ | |
577 | int port; /* TCP listening port */ | |
578 | char *bindaddr; /* Bind address or NULL */ | |
579 | char *unixsocket; /* UNIX socket path */ | |
580 | mode_t unixsocketperm; /* UNIX socket permission */ | |
581 | int ipfd; /* TCP socket file descriptor */ | |
582 | int sofd; /* Unix socket file descriptor */ | |
583 | int cfd; /* Cluster bus lisetning socket */ | |
584 | list *clients; /* List of active clients */ | |
585 | list *clients_to_close; /* Clients to close asynchronously */ | |
586 | list *slaves, *monitors; /* List of slaves and MONITORs */ | |
587 | redisClient *current_client; /* Current client, only used on crash report */ | |
588 | char neterr[ANET_ERR_LEN]; /* Error buffer for anet.c */ | |
589 | /* RDB / AOF loading information */ | |
590 | int loading; /* We are loading data from disk if true */ | |
591 | off_t loading_total_bytes; | |
592 | off_t loading_loaded_bytes; | |
593 | time_t loading_start_time; | |
594 | /* Fast pointers to often looked up command */ | |
595 | struct redisCommand *delCommand, *multiCommand, *lpushCommand; | |
596 | /* Fields used only for stats */ | |
597 | time_t stat_starttime; /* Server start time */ | |
598 | long long stat_numcommands; /* Number of processed commands */ | |
599 | long long stat_numconnections; /* Number of connections received */ | |
600 | long long stat_expiredkeys; /* Number of expired keys */ | |
601 | long long stat_evictedkeys; /* Number of evicted keys (maxmemory) */ | |
602 | long long stat_keyspace_hits; /* Number of successful lookups of keys */ | |
603 | long long stat_keyspace_misses; /* Number of failed lookups of keys */ | |
604 | size_t stat_peak_memory; /* Max used memory record */ | |
605 | long long stat_fork_time; /* Time needed to perform latets fork() */ | |
606 | long long stat_rejected_conn; /* Clients rejected because of maxclients */ | |
607 | list *slowlog; /* SLOWLOG list of commands */ | |
608 | long long slowlog_entry_id; /* SLOWLOG current entry ID */ | |
609 | long long slowlog_log_slower_than; /* SLOWLOG time limit (to get logged) */ | |
610 | unsigned long slowlog_max_len; /* SLOWLOG max number of items logged */ | |
611 | /* The following two are used to track instantaneous "load" in terms | |
612 | * of operations per second. */ | |
613 | long long ops_sec_last_sample_time; /* Timestamp of last sample (in ms) */ | |
614 | long long ops_sec_last_sample_ops; /* numcommands in last sample */ | |
615 | long long ops_sec_samples[REDIS_OPS_SEC_SAMPLES]; | |
616 | int ops_sec_idx; | |
617 | /* Configuration */ | |
618 | int verbosity; /* Loglevel in redis.conf */ | |
619 | int maxidletime; /* Client timeout in seconds */ | |
620 | size_t client_max_querybuf_len; /* Limit for client query buffer length */ | |
621 | int dbnum; /* Total number of configured DBs */ | |
622 | int daemonize; /* True if running as a daemon */ | |
623 | clientBufferLimitsConfig client_obuf_limits[REDIS_CLIENT_LIMIT_NUM_CLASSES]; | |
624 | /* AOF persistence */ | |
625 | int aof_state; /* REDIS_AOF_(ON|OFF|WAIT_REWRITE) */ | |
626 | int aof_fsync; /* Kind of fsync() policy */ | |
627 | char *aof_filename; /* Name of the AOF file */ | |
628 | int aof_no_fsync_on_rewrite; /* Don't fsync if a rewrite is in prog. */ | |
629 | int aof_rewrite_perc; /* Rewrite AOF if % growth is > M and... */ | |
630 | off_t aof_rewrite_min_size; /* the AOF file is at least N bytes. */ | |
631 | off_t aof_rewrite_base_size; /* AOF size on latest startup or rewrite. */ | |
632 | off_t aof_current_size; /* AOF current size. */ | |
633 | int aof_rewrite_scheduled; /* Rewrite once BGSAVE terminates. */ | |
634 | pid_t aof_child_pid; /* PID if rewriting process */ | |
635 | sds aof_rewrite_buf; /* buffer taken by parent during oppend only rewrite */ | |
636 | sds aof_buf; /* AOF buffer, written before entering the event loop */ | |
637 | int aof_fd; /* File descriptor of currently selected AOF file */ | |
638 | int aof_selected_db; /* Currently selected DB in AOF */ | |
639 | time_t aof_flush_postponed_start; /* UNIX time of postponed AOF flush */ | |
640 | time_t aof_last_fsync; /* UNIX time of last fsync() */ | |
641 | /* RDB persistence */ | |
642 | long long dirty; /* Changes to DB from the last save */ | |
643 | long long dirty_before_bgsave; /* Used to restore dirty on failed BGSAVE */ | |
644 | pid_t rdb_child_pid; /* PID of RDB saving child */ | |
645 | struct saveparam *saveparams; /* Save points array for RDB */ | |
646 | int saveparamslen; /* Number of saving points */ | |
647 | char *rdb_filename; /* Name of RDB file */ | |
648 | int rdb_compression; /* Use compression in RDB? */ | |
649 | time_t lastsave; /* Unix time of last save succeeede */ | |
650 | int lastbgsave_status; /* REDIS_OK or REDIS_ERR */ | |
651 | int stop_writes_on_bgsave_err; /* Don't allow writes if can't BGSAVE */ | |
652 | /* Propagation of commands in AOF / replication */ | |
653 | redisOpArray also_propagate; /* Additional command to propagate. */ | |
654 | /* Logging */ | |
655 | char *logfile; /* Path of log file */ | |
656 | int syslog_enabled; /* Is syslog enabled? */ | |
657 | char *syslog_ident; /* Syslog ident */ | |
658 | int syslog_facility; /* Syslog facility */ | |
659 | /* Slave specific fields */ | |
660 | char *masterauth; /* AUTH with this password with master */ | |
661 | char *masterhost; /* Hostname of master */ | |
662 | int masterport; /* Port of master */ | |
663 | int repl_ping_slave_period; /* Master pings the salve every N seconds */ | |
664 | int repl_timeout; /* Timeout after N seconds of master idle */ | |
665 | redisClient *master; /* Client that is master for this slave */ | |
666 | int repl_syncio_timeout; /* Timeout for synchronous I/O calls */ | |
667 | int repl_state; /* Replication status if the instance is a slave */ | |
668 | off_t repl_transfer_left; /* Bytes left reading .rdb */ | |
669 | int repl_transfer_s; /* Slave -> Master SYNC socket */ | |
670 | int repl_transfer_fd; /* Slave -> Master SYNC temp file descriptor */ | |
671 | char *repl_transfer_tmpfile; /* Slave-> master SYNC temp file name */ | |
672 | time_t repl_transfer_lastio; /* Unix time of the latest read, for timeout */ | |
673 | int repl_serve_stale_data; /* Serve stale data when link is down? */ | |
674 | time_t repl_down_since; /* Unix time at which link with master went down */ | |
675 | /* Limits */ | |
676 | unsigned int maxclients; /* Max number of simultaneous clients */ | |
677 | unsigned long long maxmemory; /* Max number of memory bytes to use */ | |
678 | int maxmemory_policy; /* Policy for key evition */ | |
679 | int maxmemory_samples; /* Pricision of random sampling */ | |
680 | /* Blocked clients */ | |
681 | unsigned int bpop_blocked_clients; /* Number of clients blocked by lists */ | |
682 | list *unblocked_clients; /* list of clients to unblock before next loop */ | |
683 | /* Sort parameters - qsort_r() is only available under BSD so we | |
684 | * have to take this state global, in order to pass it to sortCompare() */ | |
685 | int sort_dontsort; | |
686 | int sort_desc; | |
687 | int sort_alpha; | |
688 | int sort_bypattern; | |
689 | /* Zip structure config, see redis.conf for more information */ | |
690 | size_t hash_max_ziplist_entries; | |
691 | size_t hash_max_ziplist_value; | |
692 | size_t list_max_ziplist_entries; | |
693 | size_t list_max_ziplist_value; | |
694 | size_t set_max_intset_entries; | |
695 | size_t zset_max_ziplist_entries; | |
696 | size_t zset_max_ziplist_value; | |
697 | time_t unixtime; /* Unix time sampled every second. */ | |
698 | /* Pubsub */ | |
699 | dict *pubsub_channels; /* Map channels to list of subscribed clients */ | |
700 | list *pubsub_patterns; /* A list of pubsub_patterns */ | |
701 | /* Cluster */ | |
702 | int cluster_enabled; /* Is cluster enabled? */ | |
703 | clusterState cluster; /* State of the cluster */ | |
704 | /* Scripting */ | |
705 | lua_State *lua; /* The Lua interpreter. We use just one for all clients */ | |
706 | redisClient *lua_client; /* The "fake client" to query Redis from Lua */ | |
707 | redisClient *lua_caller; /* The client running EVAL right now, or NULL */ | |
708 | dict *lua_scripts; /* A dictionary of SHA1 -> Lua scripts */ | |
709 | long long lua_time_limit; /* Script timeout in seconds */ | |
710 | long long lua_time_start; /* Start time of script */ | |
711 | int lua_write_dirty; /* True if a write command was called during the | |
712 | execution of the current script. */ | |
713 | int lua_random_dirty; /* True if a random command was called during the | |
714 | execution of the current script. */ | |
715 | int lua_timedout; /* True if we reached the time limit for script | |
716 | execution. */ | |
717 | int lua_kill; /* Kill the script if true. */ | |
718 | /* Assert & bug reportign */ | |
719 | char *assert_failed; | |
720 | char *assert_file; | |
721 | int assert_line; | |
722 | int bug_report_start; /* True if bug report header was already logged. */ | |
723 | }; | |
724 | ||
725 | typedef struct pubsubPattern { | |
726 | redisClient *client; | |
727 | robj *pattern; | |
728 | } pubsubPattern; | |
729 | ||
730 | typedef void redisCommandProc(redisClient *c); | |
731 | typedef int *redisGetKeysProc(struct redisCommand *cmd, robj **argv, int argc, int *numkeys, int flags); | |
732 | struct redisCommand { | |
733 | char *name; | |
734 | redisCommandProc *proc; | |
735 | int arity; | |
736 | char *sflags; /* Flags as string represenation, one char per flag. */ | |
737 | int flags; /* The actual flags, obtained from the 'sflags' field. */ | |
738 | /* Use a function to determine keys arguments in a command line. | |
739 | * Used for Redis Cluster redirect. */ | |
740 | redisGetKeysProc *getkeys_proc; | |
741 | /* What keys should be loaded in background when calling this command? */ | |
742 | int firstkey; /* The first argument that's a key (0 = no keys) */ | |
743 | int lastkey; /* THe last argument that's a key */ | |
744 | int keystep; /* The step between first and last key */ | |
745 | long long microseconds, calls; | |
746 | }; | |
747 | ||
748 | struct redisFunctionSym { | |
749 | char *name; | |
750 | unsigned long pointer; | |
751 | }; | |
752 | ||
753 | typedef struct _redisSortObject { | |
754 | robj *obj; | |
755 | union { | |
756 | double score; | |
757 | robj *cmpobj; | |
758 | } u; | |
759 | } redisSortObject; | |
760 | ||
761 | typedef struct _redisSortOperation { | |
762 | int type; | |
763 | robj *pattern; | |
764 | } redisSortOperation; | |
765 | ||
766 | /* Structure to hold list iteration abstraction. */ | |
767 | typedef struct { | |
768 | robj *subject; | |
769 | unsigned char encoding; | |
770 | unsigned char direction; /* Iteration direction */ | |
771 | unsigned char *zi; | |
772 | listNode *ln; | |
773 | } listTypeIterator; | |
774 | ||
775 | /* Structure for an entry while iterating over a list. */ | |
776 | typedef struct { | |
777 | listTypeIterator *li; | |
778 | unsigned char *zi; /* Entry in ziplist */ | |
779 | listNode *ln; /* Entry in linked list */ | |
780 | } listTypeEntry; | |
781 | ||
782 | /* Structure to hold set iteration abstraction. */ | |
783 | typedef struct { | |
784 | robj *subject; | |
785 | int encoding; | |
786 | int ii; /* intset iterator */ | |
787 | dictIterator *di; | |
788 | } setTypeIterator; | |
789 | ||
790 | /* Structure to hold hash iteration abstration. Note that iteration over | |
791 | * hashes involves both fields and values. Because it is possible that | |
792 | * not both are required, store pointers in the iterator to avoid | |
793 | * unnecessary memory allocation for fields/values. */ | |
794 | typedef struct { | |
795 | robj *subject; | |
796 | int encoding; | |
797 | ||
798 | unsigned char *fptr, *vptr; | |
799 | ||
800 | dictIterator *di; | |
801 | dictEntry *de; | |
802 | } hashTypeIterator; | |
803 | ||
804 | #define REDIS_HASH_KEY 1 | |
805 | #define REDIS_HASH_VALUE 2 | |
806 | ||
807 | /*----------------------------------------------------------------------------- | |
808 | * Extern declarations | |
809 | *----------------------------------------------------------------------------*/ | |
810 | ||
811 | extern struct redisServer server; | |
812 | extern struct sharedObjectsStruct shared; | |
813 | extern dictType setDictType; | |
814 | extern dictType zsetDictType; | |
815 | extern dictType clusterNodesDictType; | |
816 | extern dictType dbDictType; | |
817 | extern double R_Zero, R_PosInf, R_NegInf, R_Nan; | |
818 | dictType hashDictType; | |
819 | ||
820 | /*----------------------------------------------------------------------------- | |
821 | * Functions prototypes | |
822 | *----------------------------------------------------------------------------*/ | |
823 | ||
824 | /* Utils */ | |
825 | long long ustime(void); | |
826 | long long mstime(void); | |
827 | void getRandomHexChars(char *p, unsigned int len); | |
828 | ||
829 | /* networking.c -- Networking and Client related operations */ | |
830 | redisClient *createClient(int fd); | |
831 | void closeTimedoutClients(void); | |
832 | void freeClient(redisClient *c); | |
833 | void resetClient(redisClient *c); | |
834 | void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask); | |
835 | void addReply(redisClient *c, robj *obj); | |
836 | void *addDeferredMultiBulkLength(redisClient *c); | |
837 | void setDeferredMultiBulkLength(redisClient *c, void *node, long length); | |
838 | void addReplySds(redisClient *c, sds s); | |
839 | void processInputBuffer(redisClient *c); | |
840 | void acceptTcpHandler(aeEventLoop *el, int fd, void *privdata, int mask); | |
841 | void acceptUnixHandler(aeEventLoop *el, int fd, void *privdata, int mask); | |
842 | void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask); | |
843 | void addReplyBulk(redisClient *c, robj *obj); | |
844 | void addReplyBulkCString(redisClient *c, char *s); | |
845 | void addReplyBulkCBuffer(redisClient *c, void *p, size_t len); | |
846 | void addReplyBulkLongLong(redisClient *c, long long ll); | |
847 | void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask); | |
848 | void addReply(redisClient *c, robj *obj); | |
849 | void addReplySds(redisClient *c, sds s); | |
850 | void addReplyError(redisClient *c, char *err); | |
851 | void addReplyStatus(redisClient *c, char *status); | |
852 | void addReplyDouble(redisClient *c, double d); | |
853 | void addReplyLongLong(redisClient *c, long long ll); | |
854 | void addReplyMultiBulkLen(redisClient *c, long length); | |
855 | void copyClientOutputBuffer(redisClient *dst, redisClient *src); | |
856 | void *dupClientReplyValue(void *o); | |
857 | void getClientsMaxBuffers(unsigned long *longest_output_list, | |
858 | unsigned long *biggest_input_buffer); | |
859 | sds getClientInfoString(redisClient *client); | |
860 | sds getAllClientsInfoString(void); | |
861 | void rewriteClientCommandVector(redisClient *c, int argc, ...); | |
862 | void rewriteClientCommandArgument(redisClient *c, int i, robj *newval); | |
863 | unsigned long getClientOutputBufferMemoryUsage(redisClient *c); | |
864 | void freeClientsInAsyncFreeQueue(void); | |
865 | void asyncCloseClientOnOutputBufferLimitReached(redisClient *c); | |
866 | int getClientLimitClassByName(char *name); | |
867 | char *getClientLimitClassName(int class); | |
868 | void flushSlavesOutputBuffers(void); | |
869 | ||
870 | #ifdef __GNUC__ | |
871 | void addReplyErrorFormat(redisClient *c, const char *fmt, ...) | |
872 | __attribute__((format(printf, 2, 3))); | |
873 | void addReplyStatusFormat(redisClient *c, const char *fmt, ...) | |
874 | __attribute__((format(printf, 2, 3))); | |
875 | #else | |
876 | void addReplyErrorFormat(redisClient *c, const char *fmt, ...); | |
877 | void addReplyStatusFormat(redisClient *c, const char *fmt, ...); | |
878 | #endif | |
879 | ||
880 | /* List data type */ | |
881 | void listTypeTryConversion(robj *subject, robj *value); | |
882 | void listTypePush(robj *subject, robj *value, int where); | |
883 | robj *listTypePop(robj *subject, int where); | |
884 | unsigned long listTypeLength(robj *subject); | |
885 | listTypeIterator *listTypeInitIterator(robj *subject, long index, unsigned char direction); | |
886 | void listTypeReleaseIterator(listTypeIterator *li); | |
887 | int listTypeNext(listTypeIterator *li, listTypeEntry *entry); | |
888 | robj *listTypeGet(listTypeEntry *entry); | |
889 | void listTypeInsert(listTypeEntry *entry, robj *value, int where); | |
890 | int listTypeEqual(listTypeEntry *entry, robj *o); | |
891 | void listTypeDelete(listTypeEntry *entry); | |
892 | void listTypeConvert(robj *subject, int enc); | |
893 | void unblockClientWaitingData(redisClient *c); | |
894 | int handleClientsWaitingListPush(redisClient *c, robj *key, robj *ele); | |
895 | void popGenericCommand(redisClient *c, int where); | |
896 | ||
897 | /* MULTI/EXEC/WATCH... */ | |
898 | void unwatchAllKeys(redisClient *c); | |
899 | void initClientMultiState(redisClient *c); | |
900 | void freeClientMultiState(redisClient *c); | |
901 | void queueMultiCommand(redisClient *c); | |
902 | void touchWatchedKey(redisDb *db, robj *key); | |
903 | void touchWatchedKeysOnFlush(int dbid); | |
904 | ||
905 | /* Redis object implementation */ | |
906 | void decrRefCount(void *o); | |
907 | void incrRefCount(robj *o); | |
908 | robj *resetRefCount(robj *obj); | |
909 | void freeStringObject(robj *o); | |
910 | void freeListObject(robj *o); | |
911 | void freeSetObject(robj *o); | |
912 | void freeZsetObject(robj *o); | |
913 | void freeHashObject(robj *o); | |
914 | robj *createObject(int type, void *ptr); | |
915 | robj *createStringObject(char *ptr, size_t len); | |
916 | robj *dupStringObject(robj *o); | |
917 | int isObjectRepresentableAsLongLong(robj *o, long long *llongval); | |
918 | robj *tryObjectEncoding(robj *o); | |
919 | robj *getDecodedObject(robj *o); | |
920 | size_t stringObjectLen(robj *o); | |
921 | robj *createStringObjectFromLongLong(long long value); | |
922 | robj *createStringObjectFromLongDouble(long double value); | |
923 | robj *createListObject(void); | |
924 | robj *createZiplistObject(void); | |
925 | robj *createSetObject(void); | |
926 | robj *createIntsetObject(void); | |
927 | robj *createHashObject(void); | |
928 | robj *createZsetObject(void); | |
929 | robj *createZsetZiplistObject(void); | |
930 | int getLongFromObjectOrReply(redisClient *c, robj *o, long *target, const char *msg); | |
931 | int checkType(redisClient *c, robj *o, int type); | |
932 | int getLongLongFromObjectOrReply(redisClient *c, robj *o, long long *target, const char *msg); | |
933 | int getDoubleFromObjectOrReply(redisClient *c, robj *o, double *target, const char *msg); | |
934 | int getLongLongFromObject(robj *o, long long *target); | |
935 | int getLongDoubleFromObject(robj *o, long double *target); | |
936 | int getLongDoubleFromObjectOrReply(redisClient *c, robj *o, long double *target, const char *msg); | |
937 | char *strEncoding(int encoding); | |
938 | int compareStringObjects(robj *a, robj *b); | |
939 | int equalStringObjects(robj *a, robj *b); | |
940 | unsigned long estimateObjectIdleTime(robj *o); | |
941 | ||
942 | /* Synchronous I/O with timeout */ | |
943 | int syncWrite(int fd, char *ptr, ssize_t size, int timeout); | |
944 | int syncRead(int fd, char *ptr, ssize_t size, int timeout); | |
945 | int syncReadLine(int fd, char *ptr, ssize_t size, int timeout); | |
946 | ||
947 | /* Replication */ | |
948 | void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc); | |
949 | void replicationFeedMonitors(redisClient *c, list *monitors, int dictid, robj **argv, int argc); | |
950 | void updateSlavesWaitingBgsave(int bgsaveerr); | |
951 | void replicationCron(void); | |
952 | ||
953 | /* Generic persistence functions */ | |
954 | void startLoading(FILE *fp); | |
955 | void loadingProgress(off_t pos); | |
956 | void stopLoading(void); | |
957 | ||
958 | /* RDB persistence */ | |
959 | #include "rdb.h" | |
960 | ||
961 | /* AOF persistence */ | |
962 | void flushAppendOnlyFile(int force); | |
963 | void feedAppendOnlyFile(struct redisCommand *cmd, int dictid, robj **argv, int argc); | |
964 | void aofRemoveTempFile(pid_t childpid); | |
965 | int rewriteAppendOnlyFileBackground(void); | |
966 | int loadAppendOnlyFile(char *filename); | |
967 | void stopAppendOnly(void); | |
968 | int startAppendOnly(void); | |
969 | void backgroundRewriteDoneHandler(int exitcode, int bysignal); | |
970 | ||
971 | /* Sorted sets data type */ | |
972 | ||
973 | /* Struct to hold a inclusive/exclusive range spec. */ | |
974 | typedef struct { | |
975 | double min, max; | |
976 | int minex, maxex; /* are min or max exclusive? */ | |
977 | } zrangespec; | |
978 | ||
979 | zskiplist *zslCreate(void); | |
980 | void zslFree(zskiplist *zsl); | |
981 | zskiplistNode *zslInsert(zskiplist *zsl, double score, robj *obj); | |
982 | unsigned char *zzlInsert(unsigned char *zl, robj *ele, double score); | |
983 | int zslDelete(zskiplist *zsl, double score, robj *obj); | |
984 | zskiplistNode *zslFirstInRange(zskiplist *zsl, zrangespec range); | |
985 | double zzlGetScore(unsigned char *sptr); | |
986 | void zzlNext(unsigned char *zl, unsigned char **eptr, unsigned char **sptr); | |
987 | void zzlPrev(unsigned char *zl, unsigned char **eptr, unsigned char **sptr); | |
988 | unsigned int zsetLength(robj *zobj); | |
989 | void zsetConvert(robj *zobj, int encoding); | |
990 | ||
991 | /* Core functions */ | |
992 | int freeMemoryIfNeeded(void); | |
993 | int processCommand(redisClient *c); | |
994 | void setupSignalHandlers(void); | |
995 | struct redisCommand *lookupCommand(sds name); | |
996 | struct redisCommand *lookupCommandByCString(char *s); | |
997 | void call(redisClient *c, int flags); | |
998 | void propagate(struct redisCommand *cmd, int dbid, robj **argv, int argc, int flags); | |
999 | void alsoPropagate(struct redisCommand *cmd, int dbid, robj **argv, int argc, int target); | |
1000 | int prepareForShutdown(); | |
1001 | void redisLog(int level, const char *fmt, ...); | |
1002 | void redisLogRaw(int level, const char *msg); | |
1003 | void usage(); | |
1004 | void updateDictResizePolicy(void); | |
1005 | int htNeedsResize(dict *dict); | |
1006 | void oom(const char *msg); | |
1007 | void populateCommandTable(void); | |
1008 | void resetCommandTableStats(void); | |
1009 | ||
1010 | /* Set data type */ | |
1011 | robj *setTypeCreate(robj *value); | |
1012 | int setTypeAdd(robj *subject, robj *value); | |
1013 | int setTypeRemove(robj *subject, robj *value); | |
1014 | int setTypeIsMember(robj *subject, robj *value); | |
1015 | setTypeIterator *setTypeInitIterator(robj *subject); | |
1016 | void setTypeReleaseIterator(setTypeIterator *si); | |
1017 | int setTypeNext(setTypeIterator *si, robj **objele, int64_t *llele); | |
1018 | robj *setTypeNextObject(setTypeIterator *si); | |
1019 | int setTypeRandomElement(robj *setobj, robj **objele, int64_t *llele); | |
1020 | unsigned long setTypeSize(robj *subject); | |
1021 | void setTypeConvert(robj *subject, int enc); | |
1022 | ||
1023 | /* Hash data type */ | |
1024 | void hashTypeConvert(robj *o, int enc); | |
1025 | void hashTypeTryConversion(robj *subject, robj **argv, int start, int end); | |
1026 | void hashTypeTryObjectEncoding(robj *subject, robj **o1, robj **o2); | |
1027 | robj *hashTypeGetObject(robj *o, robj *key); | |
1028 | int hashTypeExists(robj *o, robj *key); | |
1029 | int hashTypeSet(robj *o, robj *key, robj *value); | |
1030 | int hashTypeDelete(robj *o, robj *key); | |
1031 | unsigned long hashTypeLength(robj *o); | |
1032 | hashTypeIterator *hashTypeInitIterator(robj *subject); | |
1033 | void hashTypeReleaseIterator(hashTypeIterator *hi); | |
1034 | int hashTypeNext(hashTypeIterator *hi); | |
1035 | void hashTypeCurrentFromZiplist(hashTypeIterator *hi, int what, | |
1036 | unsigned char **vstr, | |
1037 | unsigned int *vlen, | |
1038 | long long *vll); | |
1039 | void hashTypeCurrentFromHashTable(hashTypeIterator *hi, int what, robj **dst); | |
1040 | robj *hashTypeCurrentObject(hashTypeIterator *hi, int what); | |
1041 | robj *hashTypeLookupWriteOrCreate(redisClient *c, robj *key); | |
1042 | ||
1043 | /* Pub / Sub */ | |
1044 | int pubsubUnsubscribeAllChannels(redisClient *c, int notify); | |
1045 | int pubsubUnsubscribeAllPatterns(redisClient *c, int notify); | |
1046 | void freePubsubPattern(void *p); | |
1047 | int listMatchPubsubPattern(void *a, void *b); | |
1048 | int pubsubPublishMessage(robj *channel, robj *message); | |
1049 | ||
1050 | /* Configuration */ | |
1051 | void loadServerConfig(char *filename, char *options); | |
1052 | void appendServerSaveParams(time_t seconds, int changes); | |
1053 | void resetServerSaveParams(); | |
1054 | ||
1055 | /* db.c -- Keyspace access API */ | |
1056 | int removeExpire(redisDb *db, robj *key); | |
1057 | void propagateExpire(redisDb *db, robj *key); | |
1058 | int expireIfNeeded(redisDb *db, robj *key); | |
1059 | long long getExpire(redisDb *db, robj *key); | |
1060 | void setExpire(redisDb *db, robj *key, long long when); | |
1061 | robj *lookupKey(redisDb *db, robj *key); | |
1062 | robj *lookupKeyRead(redisDb *db, robj *key); | |
1063 | robj *lookupKeyWrite(redisDb *db, robj *key); | |
1064 | robj *lookupKeyReadOrReply(redisClient *c, robj *key, robj *reply); | |
1065 | robj *lookupKeyWriteOrReply(redisClient *c, robj *key, robj *reply); | |
1066 | void dbAdd(redisDb *db, robj *key, robj *val); | |
1067 | void dbOverwrite(redisDb *db, robj *key, robj *val); | |
1068 | void setKey(redisDb *db, robj *key, robj *val); | |
1069 | int dbExists(redisDb *db, robj *key); | |
1070 | robj *dbRandomKey(redisDb *db); | |
1071 | int dbDelete(redisDb *db, robj *key); | |
1072 | long long emptyDb(); | |
1073 | int selectDb(redisClient *c, int id); | |
1074 | void signalModifiedKey(redisDb *db, robj *key); | |
1075 | void signalFlushedDb(int dbid); | |
1076 | unsigned int GetKeysInSlot(unsigned int hashslot, robj **keys, unsigned int count); | |
1077 | ||
1078 | /* API to get key arguments from commands */ | |
1079 | #define REDIS_GETKEYS_ALL 0 | |
1080 | #define REDIS_GETKEYS_PRELOAD 1 | |
1081 | int *getKeysFromCommand(struct redisCommand *cmd, robj **argv, int argc, int *numkeys, int flags); | |
1082 | void getKeysFreeResult(int *result); | |
1083 | int *noPreloadGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags); | |
1084 | int *renameGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags); | |
1085 | int *zunionInterGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags); | |
1086 | ||
1087 | /* Cluster */ | |
1088 | void clusterInit(void); | |
1089 | unsigned short crc16(const char *buf, int len); | |
1090 | unsigned int keyHashSlot(char *key, int keylen); | |
1091 | clusterNode *createClusterNode(char *nodename, int flags); | |
1092 | int clusterAddNode(clusterNode *node); | |
1093 | void clusterCron(void); | |
1094 | clusterNode *getNodeByQuery(redisClient *c, struct redisCommand *cmd, robj **argv, int argc, int *hashslot, int *ask); | |
1095 | void clusterPropagatePublish(robj *channel, robj *message); | |
1096 | ||
1097 | /* Scripting */ | |
1098 | void scriptingInit(void); | |
1099 | ||
1100 | /* Git SHA1 */ | |
1101 | char *redisGitSHA1(void); | |
1102 | char *redisGitDirty(void); | |
1103 | ||
1104 | /* Commands prototypes */ | |
1105 | void authCommand(redisClient *c); | |
1106 | void pingCommand(redisClient *c); | |
1107 | void echoCommand(redisClient *c); | |
1108 | void setCommand(redisClient *c); | |
1109 | void setnxCommand(redisClient *c); | |
1110 | void setexCommand(redisClient *c); | |
1111 | void psetexCommand(redisClient *c); | |
1112 | void getCommand(redisClient *c); | |
1113 | void delCommand(redisClient *c); | |
1114 | void existsCommand(redisClient *c); | |
1115 | void setbitCommand(redisClient *c); | |
1116 | void getbitCommand(redisClient *c); | |
1117 | void setrangeCommand(redisClient *c); | |
1118 | void getrangeCommand(redisClient *c); | |
1119 | void incrCommand(redisClient *c); | |
1120 | void decrCommand(redisClient *c); | |
1121 | void incrbyCommand(redisClient *c); | |
1122 | void decrbyCommand(redisClient *c); | |
1123 | void incrbyfloatCommand(redisClient *c); | |
1124 | void selectCommand(redisClient *c); | |
1125 | void randomkeyCommand(redisClient *c); | |
1126 | void keysCommand(redisClient *c); | |
1127 | void dbsizeCommand(redisClient *c); | |
1128 | void lastsaveCommand(redisClient *c); | |
1129 | void saveCommand(redisClient *c); | |
1130 | void bgsaveCommand(redisClient *c); | |
1131 | void bgrewriteaofCommand(redisClient *c); | |
1132 | void shutdownCommand(redisClient *c); | |
1133 | void moveCommand(redisClient *c); | |
1134 | void renameCommand(redisClient *c); | |
1135 | void renamenxCommand(redisClient *c); | |
1136 | void lpushCommand(redisClient *c); | |
1137 | void rpushCommand(redisClient *c); | |
1138 | void lpushxCommand(redisClient *c); | |
1139 | void rpushxCommand(redisClient *c); | |
1140 | void linsertCommand(redisClient *c); | |
1141 | void lpopCommand(redisClient *c); | |
1142 | void rpopCommand(redisClient *c); | |
1143 | void llenCommand(redisClient *c); | |
1144 | void lindexCommand(redisClient *c); | |
1145 | void lrangeCommand(redisClient *c); | |
1146 | void ltrimCommand(redisClient *c); | |
1147 | void typeCommand(redisClient *c); | |
1148 | void lsetCommand(redisClient *c); | |
1149 | void saddCommand(redisClient *c); | |
1150 | void sremCommand(redisClient *c); | |
1151 | void smoveCommand(redisClient *c); | |
1152 | void sismemberCommand(redisClient *c); | |
1153 | void scardCommand(redisClient *c); | |
1154 | void spopCommand(redisClient *c); | |
1155 | void srandmemberCommand(redisClient *c); | |
1156 | void sinterCommand(redisClient *c); | |
1157 | void sinterstoreCommand(redisClient *c); | |
1158 | void sunionCommand(redisClient *c); | |
1159 | void sunionstoreCommand(redisClient *c); | |
1160 | void sdiffCommand(redisClient *c); | |
1161 | void sdiffstoreCommand(redisClient *c); | |
1162 | void syncCommand(redisClient *c); | |
1163 | void flushdbCommand(redisClient *c); | |
1164 | void flushallCommand(redisClient *c); | |
1165 | void sortCommand(redisClient *c); | |
1166 | void lremCommand(redisClient *c); | |
1167 | void rpoplpushCommand(redisClient *c); | |
1168 | void infoCommand(redisClient *c); | |
1169 | void mgetCommand(redisClient *c); | |
1170 | void monitorCommand(redisClient *c); | |
1171 | void expireCommand(redisClient *c); | |
1172 | void expireatCommand(redisClient *c); | |
1173 | void pexpireCommand(redisClient *c); | |
1174 | void pexpireatCommand(redisClient *c); | |
1175 | void getsetCommand(redisClient *c); | |
1176 | void ttlCommand(redisClient *c); | |
1177 | void pttlCommand(redisClient *c); | |
1178 | void persistCommand(redisClient *c); | |
1179 | void slaveofCommand(redisClient *c); | |
1180 | void debugCommand(redisClient *c); | |
1181 | void msetCommand(redisClient *c); | |
1182 | void msetnxCommand(redisClient *c); | |
1183 | void zaddCommand(redisClient *c); | |
1184 | void zincrbyCommand(redisClient *c); | |
1185 | void zrangeCommand(redisClient *c); | |
1186 | void zrangebyscoreCommand(redisClient *c); | |
1187 | void zrevrangebyscoreCommand(redisClient *c); | |
1188 | void zcountCommand(redisClient *c); | |
1189 | void zrevrangeCommand(redisClient *c); | |
1190 | void zcardCommand(redisClient *c); | |
1191 | void zremCommand(redisClient *c); | |
1192 | void zscoreCommand(redisClient *c); | |
1193 | void zremrangebyscoreCommand(redisClient *c); | |
1194 | void multiCommand(redisClient *c); | |
1195 | void execCommand(redisClient *c); | |
1196 | void discardCommand(redisClient *c); | |
1197 | void blpopCommand(redisClient *c); | |
1198 | void brpopCommand(redisClient *c); | |
1199 | void brpoplpushCommand(redisClient *c); | |
1200 | void appendCommand(redisClient *c); | |
1201 | void strlenCommand(redisClient *c); | |
1202 | void zrankCommand(redisClient *c); | |
1203 | void zrevrankCommand(redisClient *c); | |
1204 | void hsetCommand(redisClient *c); | |
1205 | void hsetnxCommand(redisClient *c); | |
1206 | void hgetCommand(redisClient *c); | |
1207 | void hmsetCommand(redisClient *c); | |
1208 | void hmgetCommand(redisClient *c); | |
1209 | void hdelCommand(redisClient *c); | |
1210 | void hlenCommand(redisClient *c); | |
1211 | void zremrangebyrankCommand(redisClient *c); | |
1212 | void zunionstoreCommand(redisClient *c); | |
1213 | void zinterstoreCommand(redisClient *c); | |
1214 | void hkeysCommand(redisClient *c); | |
1215 | void hvalsCommand(redisClient *c); | |
1216 | void hgetallCommand(redisClient *c); | |
1217 | void hexistsCommand(redisClient *c); | |
1218 | void configCommand(redisClient *c); | |
1219 | void hincrbyCommand(redisClient *c); | |
1220 | void hincrbyfloatCommand(redisClient *c); | |
1221 | void subscribeCommand(redisClient *c); | |
1222 | void unsubscribeCommand(redisClient *c); | |
1223 | void psubscribeCommand(redisClient *c); | |
1224 | void punsubscribeCommand(redisClient *c); | |
1225 | void publishCommand(redisClient *c); | |
1226 | void watchCommand(redisClient *c); | |
1227 | void unwatchCommand(redisClient *c); | |
1228 | void clusterCommand(redisClient *c); | |
1229 | void restoreCommand(redisClient *c); | |
1230 | void migrateCommand(redisClient *c); | |
1231 | void askingCommand(redisClient *c); | |
1232 | void dumpCommand(redisClient *c); | |
1233 | void objectCommand(redisClient *c); | |
1234 | void clientCommand(redisClient *c); | |
1235 | void evalCommand(redisClient *c); | |
1236 | void evalShaCommand(redisClient *c); | |
1237 | void scriptCommand(redisClient *c); | |
1238 | void timeCommand(redisClient *c); | |
1239 | ||
1240 | #if defined(__GNUC__) | |
1241 | void *calloc(size_t count, size_t size) __attribute__ ((deprecated)); | |
1242 | void free(void *ptr) __attribute__ ((deprecated)); | |
1243 | void *malloc(size_t size) __attribute__ ((deprecated)); | |
1244 | void *realloc(void *ptr, size_t size) __attribute__ ((deprecated)); | |
1245 | #endif | |
1246 | ||
1247 | /* Debugging stuff */ | |
1248 | void _redisAssertWithInfo(redisClient *c, robj *o, char *estr, char *file, int line); | |
1249 | void _redisAssert(char *estr, char *file, int line); | |
1250 | void _redisPanic(char *msg, char *file, int line); | |
1251 | void bugReportStart(void); | |
1252 | void redisLogObjectDebugInfo(robj *o); | |
1253 | void sigsegvHandler(int sig, siginfo_t *info, void *secret); | |
1254 | sds genRedisInfoString(char *section); | |
1255 | #endif |