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