]>
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> |
e2641e09 | 22 | |
23 | #include "ae.h" /* Event driven programming library */ | |
24 | #include "sds.h" /* Dynamic safe strings */ | |
25 | #include "dict.h" /* Hash tables */ | |
26 | #include "adlist.h" /* Linked lists */ | |
27 | #include "zmalloc.h" /* total memory usage aware version of malloc/free */ | |
28 | #include "anet.h" /* Networking the easy way */ | |
29 | #include "zipmap.h" /* Compact string -> string data structure */ | |
30 | #include "ziplist.h" /* Compact list data structure */ | |
96ffb2fe | 31 | #include "intset.h" /* Compact integer set structure */ |
e2641e09 | 32 | #include "version.h" |
5d081931 | 33 | #include "util.h" |
e2641e09 | 34 | |
35 | /* Error codes */ | |
36 | #define REDIS_OK 0 | |
37 | #define REDIS_ERR -1 | |
38 | ||
39 | /* Static server configuration */ | |
40 | #define REDIS_SERVERPORT 6379 /* TCP port */ | |
41 | #define REDIS_MAXIDLETIME (60*5) /* default client timeout */ | |
42 | #define REDIS_IOBUF_LEN 1024 | |
43 | #define REDIS_LOADBUF_LEN 1024 | |
e2641e09 | 44 | #define REDIS_DEFAULT_DBNUM 16 |
45 | #define REDIS_CONFIGLINE_MAX 1024 | |
e2641e09 | 46 | #define REDIS_MAX_SYNC_TIME 60 /* Slave can't take more to sync */ |
47 | #define REDIS_EXPIRELOOKUPS_PER_CRON 10 /* lookup 10 expires per loop */ | |
48 | #define REDIS_MAX_WRITE_PER_EVENT (1024*64) | |
49 | #define REDIS_REQUEST_MAX_SIZE (1024*1024*256) /* max bytes in inline command */ | |
50 | #define REDIS_SHARED_INTEGERS 10000 | |
36c19d03 | 51 | #define REDIS_REPLY_CHUNK_BYTES (5*1500) /* 5 TCP packets with default MTU */ |
e1a586ee | 52 | #define REDIS_MAX_LOGMSG_LEN 1024 /* Default maximum length of syslog messages */ |
b333e239 | 53 | #define REDIS_AUTO_AOFREWRITE_PERC 100 |
54 | #define REDIS_AUTO_AOFREWRITE_MIN_SIZE (1024*1024) | |
834ef78e | 55 | |
e2641e09 | 56 | /* Hash table parameters */ |
57 | #define REDIS_HT_MINFILL 10 /* Minimal hash table fill 10% */ | |
58 | ||
33aba595 PN |
59 | /* Command flags: |
60 | * REDIS_CMD_DENYOOM: | |
61 | * Commands marked with this flag will return an error when 'maxmemory' is | |
62 | * set and the server is using more than 'maxmemory' bytes of memory. | |
63 | * In short: commands with this flag are denied on low memory conditions. | |
64 | * REDIS_CMD_FORCE_REPLICATION: | |
65 | * Force replication even if dirty is 0. */ | |
66 | #define REDIS_CMD_DENYOOM 4 | |
67 | #define REDIS_CMD_FORCE_REPLICATION 8 | |
e2641e09 | 68 | |
69 | /* Object types */ | |
70 | #define REDIS_STRING 0 | |
71 | #define REDIS_LIST 1 | |
72 | #define REDIS_SET 2 | |
73 | #define REDIS_ZSET 3 | |
74 | #define REDIS_HASH 4 | |
75 | #define REDIS_VMPOINTER 8 | |
e12b27ac | 76 | |
2cc99365 | 77 | /* Object types only used for persistence in .rdb files */ |
78 | #define REDIS_HASH_ZIPMAP 9 | |
9ad853cc | 79 | #define REDIS_LIST_ZIPLIST 10 |
80 | #define REDIS_SET_INTSET 11 | |
e12b27ac | 81 | #define REDIS_ZSET_ZIPLIST 12 |
e2641e09 | 82 | |
83 | /* Objects encoding. Some kind of objects like Strings and Hashes can be | |
84 | * internally represented in multiple ways. The 'encoding' field of the object | |
85 | * is set to one of this fields for this object. */ | |
86 | #define REDIS_ENCODING_RAW 0 /* Raw representation */ | |
87 | #define REDIS_ENCODING_INT 1 /* Encoded as integer */ | |
88 | #define REDIS_ENCODING_HT 2 /* Encoded as hash table */ | |
89 | #define REDIS_ENCODING_ZIPMAP 3 /* Encoded as zipmap */ | |
90 | #define REDIS_ENCODING_LINKEDLIST 4 /* Encoded as regular linked list */ | |
91 | #define REDIS_ENCODING_ZIPLIST 5 /* Encoded as ziplist */ | |
96ffb2fe | 92 | #define REDIS_ENCODING_INTSET 6 /* Encoded as intset */ |
0b7f6d09 | 93 | #define REDIS_ENCODING_SKIPLIST 7 /* Encoded as skiplist */ |
e2641e09 | 94 | |
95 | /* Object types only used for dumping to disk */ | |
96 | #define REDIS_EXPIRETIME 253 | |
97 | #define REDIS_SELECTDB 254 | |
98 | #define REDIS_EOF 255 | |
99 | ||
100 | /* Defines related to the dump file format. To store 32 bits lengths for short | |
101 | * keys requires a lot of space, so we check the most significant 2 bits of | |
102 | * the first byte to interpreter the length: | |
103 | * | |
104 | * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte | |
105 | * 01|000000 00000000 => 01, the len is 14 byes, 6 bits + 8 bits of next byte | |
106 | * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow | |
107 | * 11|000000 this means: specially encoded object will follow. The six bits | |
108 | * number specify the kind of object that follows. | |
109 | * See the REDIS_RDB_ENC_* defines. | |
110 | * | |
111 | * Lenghts up to 63 are stored using a single byte, most DB keys, and may | |
112 | * values, will fit inside. */ | |
113 | #define REDIS_RDB_6BITLEN 0 | |
114 | #define REDIS_RDB_14BITLEN 1 | |
115 | #define REDIS_RDB_32BITLEN 2 | |
116 | #define REDIS_RDB_ENCVAL 3 | |
117 | #define REDIS_RDB_LENERR UINT_MAX | |
118 | ||
119 | /* When a length of a string object stored on disk has the first two bits | |
120 | * set, the remaining two bits specify a special encoding for the object | |
121 | * accordingly to the following defines: */ | |
122 | #define REDIS_RDB_ENC_INT8 0 /* 8 bit signed integer */ | |
123 | #define REDIS_RDB_ENC_INT16 1 /* 16 bit signed integer */ | |
124 | #define REDIS_RDB_ENC_INT32 2 /* 32 bit signed integer */ | |
125 | #define REDIS_RDB_ENC_LZF 3 /* string compressed with FASTLZ */ | |
126 | ||
3be00d7e | 127 | /* Scheduled IO opeations flags. */ |
128 | #define REDIS_IO_LOAD 1 | |
129 | #define REDIS_IO_SAVE 2 | |
130 | #define REDIS_IO_LOADINPROG 4 | |
131 | #define REDIS_IO_SAVEINPROG 8 | |
16d77878 | 132 | |
f771dc23 | 133 | /* Generic IO flags */ |
134 | #define REDIS_IO_ONLYLOADS 1 | |
135 | #define REDIS_IO_ASAP 2 | |
136 | ||
e2641e09 | 137 | #define REDIS_MAX_COMPLETED_JOBS_PROCESSED 1 |
f34a6cd8 | 138 | #define REDIS_THREAD_STACK_SIZE (1024*1024*4) |
e2641e09 | 139 | |
140 | /* Client flags */ | |
141 | #define REDIS_SLAVE 1 /* This client is a slave server */ | |
142 | #define REDIS_MASTER 2 /* This client is a master server */ | |
143 | #define REDIS_MONITOR 4 /* This client is a slave monitor, see MONITOR */ | |
144 | #define REDIS_MULTI 8 /* This client is in a MULTI context */ | |
145 | #define REDIS_BLOCKED 16 /* The client is waiting in a blocking operation */ | |
146 | #define REDIS_IO_WAIT 32 /* The client is waiting for Virtual Memory I/O */ | |
147 | #define REDIS_DIRTY_CAS 64 /* Watched keys modified. EXEC will fail. */ | |
5e78edb3 | 148 | #define REDIS_CLOSE_AFTER_REPLY 128 /* Close after writing entire reply. */ |
3bcffcbe PN |
149 | #define REDIS_UNBLOCKED 256 /* This client was unblocked and is stored in |
150 | server.unblocked_clients */ | |
cd8788f2 PN |
151 | |
152 | /* Client request types */ | |
153 | #define REDIS_REQ_INLINE 1 | |
154 | #define REDIS_REQ_MULTIBULK 2 | |
e2641e09 | 155 | |
156 | /* Slave replication state - slave side */ | |
a3309139 PN |
157 | #define REDIS_REPL_NONE 0 /* No active replication */ |
158 | #define REDIS_REPL_CONNECT 1 /* Must connect to master */ | |
b075621f PN |
159 | #define REDIS_REPL_CONNECTING 2 /* Connecting to master */ |
160 | #define REDIS_REPL_TRANSFER 3 /* Receiving .rdb from master */ | |
161 | #define REDIS_REPL_CONNECTED 4 /* Connected to master */ | |
e2641e09 | 162 | |
890a2ed9 PN |
163 | /* Synchronous read timeout - slave side */ |
164 | #define REDIS_REPL_SYNCIO_TIMEOUT 5 | |
165 | ||
e2641e09 | 166 | /* Slave replication state - from the point of view of master |
167 | * Note that in SEND_BULK and ONLINE state the slave receives new updates | |
168 | * in its output queue. In the WAIT_BGSAVE state instead the server is waiting | |
169 | * to start the next background saving in order to send updates to it. */ | |
170 | #define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */ | |
171 | #define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */ | |
172 | #define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */ | |
173 | #define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */ | |
174 | ||
175 | /* List related stuff */ | |
176 | #define REDIS_HEAD 0 | |
177 | #define REDIS_TAIL 1 | |
178 | ||
179 | /* Sort operations */ | |
180 | #define REDIS_SORT_GET 0 | |
181 | #define REDIS_SORT_ASC 1 | |
182 | #define REDIS_SORT_DESC 2 | |
183 | #define REDIS_SORTKEY_MAX 1024 | |
184 | ||
185 | /* Log levels */ | |
186 | #define REDIS_DEBUG 0 | |
187 | #define REDIS_VERBOSE 1 | |
188 | #define REDIS_NOTICE 2 | |
189 | #define REDIS_WARNING 3 | |
996d503d | 190 | #define REDIS_LOG_RAW (1<<10) /* Modifier to log without timestamp */ |
e2641e09 | 191 | |
192 | /* Anti-warning macro... */ | |
193 | #define REDIS_NOTUSED(V) ((void) V) | |
194 | ||
195 | #define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */ | |
196 | #define ZSKIPLIST_P 0.25 /* Skiplist P = 1/4 */ | |
197 | ||
198 | /* Append only defines */ | |
199 | #define APPENDFSYNC_NO 0 | |
200 | #define APPENDFSYNC_ALWAYS 1 | |
201 | #define APPENDFSYNC_EVERYSEC 2 | |
202 | ||
203 | /* Zip structure related defaults */ | |
52dc87bb | 204 | #define REDIS_HASH_MAX_ZIPMAP_ENTRIES 512 |
205 | #define REDIS_HASH_MAX_ZIPMAP_VALUE 64 | |
6a246b1e | 206 | #define REDIS_LIST_MAX_ZIPLIST_ENTRIES 512 |
207 | #define REDIS_LIST_MAX_ZIPLIST_VALUE 64 | |
208 | #define REDIS_SET_MAX_INTSET_ENTRIES 512 | |
3ea204e1 PN |
209 | #define REDIS_ZSET_MAX_ZIPLIST_ENTRIES 128 |
210 | #define REDIS_ZSET_MAX_ZIPLIST_VALUE 64 | |
e2641e09 | 211 | |
212 | /* Sets operations codes */ | |
213 | #define REDIS_OP_UNION 0 | |
214 | #define REDIS_OP_DIFF 1 | |
215 | #define REDIS_OP_INTER 2 | |
216 | ||
165346ca | 217 | /* Redis maxmemory strategies */ |
218 | #define REDIS_MAXMEMORY_VOLATILE_LRU 0 | |
219 | #define REDIS_MAXMEMORY_VOLATILE_TTL 1 | |
220 | #define REDIS_MAXMEMORY_VOLATILE_RANDOM 2 | |
221 | #define REDIS_MAXMEMORY_ALLKEYS_LRU 3 | |
222 | #define REDIS_MAXMEMORY_ALLKEYS_RANDOM 4 | |
5402c426 | 223 | #define REDIS_MAXMEMORY_NO_EVICTION 5 |
165346ca | 224 | |
36c17a53 | 225 | /* Diskstore background saving thread states */ |
226 | #define REDIS_BGSAVE_THREAD_UNACTIVE 0 | |
227 | #define REDIS_BGSAVE_THREAD_ACTIVE 1 | |
228 | #define REDIS_BGSAVE_THREAD_DONE_OK 2 | |
229 | #define REDIS_BGSAVE_THREAD_DONE_ERR 3 | |
230 | ||
e2641e09 | 231 | /* We can print the stacktrace, so our assert is defined this way: */ |
232 | #define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1))) | |
233 | #define redisPanic(_e) _redisPanic(#_e,__FILE__,__LINE__),_exit(1) | |
234 | void _redisAssert(char *estr, char *file, int line); | |
235 | void _redisPanic(char *msg, char *file, int line); | |
236 | ||
237 | /*----------------------------------------------------------------------------- | |
238 | * Data types | |
239 | *----------------------------------------------------------------------------*/ | |
240 | ||
241 | /* A redis object, that is a type able to hold a string / list / set */ | |
242 | ||
243 | /* The actual Redis Object */ | |
ef59a8bc | 244 | #define REDIS_LRU_CLOCK_MAX ((1<<21)-1) /* Max value of obj->lru */ |
165346ca | 245 | #define REDIS_LRU_CLOCK_RESOLUTION 10 /* LRU clock resolution in seconds */ |
e2641e09 | 246 | typedef struct redisObject { |
247 | unsigned type:4; | |
3be00d7e | 248 | unsigned notused:2; /* Not used */ |
e2641e09 | 249 | unsigned encoding:4; |
250 | unsigned lru:22; /* lru time (relative to server.lruclock) */ | |
251 | int refcount; | |
252 | void *ptr; | |
253 | /* VM fields are only allocated if VM is active, otherwise the | |
254 | * object allocation function will just allocate | |
255 | * sizeof(redisObjct) minus sizeof(redisObjectVM), so using | |
256 | * Redis without VM active will not have any overhead. */ | |
257 | } robj; | |
258 | ||
259 | /* The VM pointer structure - identifies an object in the swap file. | |
260 | * | |
261 | * This object is stored in place of the value | |
262 | * object in the main key->value hash table representing a database. | |
263 | * Note that the first fields (type, storage) are the same as the redisObject | |
264 | * structure so that vmPointer strucuters can be accessed even when casted | |
265 | * as redisObject structures. | |
266 | * | |
267 | * This is useful as we don't know if a value object is or not on disk, but we | |
268 | * are always able to read obj->storage to check this. For vmPointer | |
269 | * structures "type" is set to REDIS_VMPOINTER (even if without this field | |
270 | * is still possible to check the kind of object from the value of 'storage').*/ | |
271 | typedef struct vmPointer { | |
272 | unsigned type:4; | |
273 | unsigned storage:2; /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */ | |
274 | unsigned notused:26; | |
275 | unsigned int vtype; /* type of the object stored in the swap file */ | |
276 | off_t page; /* the page at witch the object is stored on disk */ | |
277 | off_t usedpages; /* number of pages used on disk */ | |
278 | } vmpointer; | |
279 | ||
280 | /* Macro used to initalize a Redis object allocated on the stack. | |
281 | * Note that this macro is taken near the structure definition to make sure | |
282 | * we'll update it when the structure is changed, to avoid bugs like | |
283 | * bug #85 introduced exactly in this way. */ | |
284 | #define initStaticStringObject(_var,_ptr) do { \ | |
285 | _var.refcount = 1; \ | |
286 | _var.type = REDIS_STRING; \ | |
287 | _var.encoding = REDIS_ENCODING_RAW; \ | |
288 | _var.ptr = _ptr; \ | |
e2641e09 | 289 | } while(0); |
290 | ||
291 | typedef struct redisDb { | |
292 | dict *dict; /* The keyspace for this DB */ | |
293 | dict *expires; /* Timeout of keys with a timeout set */ | |
294 | dict *blocking_keys; /* Keys with clients waiting for data (BLPOP) */ | |
3be00d7e | 295 | dict *io_keys; /* Keys with clients waiting for DS I/O */ |
d934e1e8 | 296 | dict *io_negcache; /* Negative caching for disk store */ |
3be00d7e | 297 | dict *io_queued; /* Queued IO operations hash table */ |
e2641e09 | 298 | dict *watched_keys; /* WATCHED keys for MULTI/EXEC CAS */ |
299 | int id; | |
300 | } redisDb; | |
301 | ||
302 | /* Client MULTI/EXEC state */ | |
303 | typedef struct multiCmd { | |
304 | robj **argv; | |
305 | int argc; | |
306 | struct redisCommand *cmd; | |
307 | } multiCmd; | |
308 | ||
309 | typedef struct multiState { | |
310 | multiCmd *commands; /* Array of MULTI commands */ | |
311 | int count; /* Total number of MULTI commands */ | |
312 | } multiState; | |
313 | ||
357a8417 DJMM |
314 | typedef struct blockingState { |
315 | robj **keys; /* The key we are waiting to terminate a blocking | |
316 | * operation such as BLPOP. Otherwise NULL. */ | |
317 | int count; /* Number of blocking keys */ | |
318 | time_t timeout; /* Blocking operation timeout. If UNIX current time | |
319 | * is >= timeout then the operation timed out. */ | |
320 | robj *target; /* The key that should receive the element, | |
321 | * for BRPOPLPUSH. */ | |
322 | } blockingState; | |
323 | ||
e2641e09 | 324 | /* With multiplexing we need to take per-clinet state. |
325 | * Clients are taken in a liked list. */ | |
326 | typedef struct redisClient { | |
327 | int fd; | |
328 | redisDb *db; | |
329 | int dictid; | |
330 | sds querybuf; | |
cd8788f2 PN |
331 | int argc; |
332 | robj **argv; | |
333 | int reqtype; | |
334 | int multibulklen; /* number of multi bulk arguments left to read */ | |
335 | long bulklen; /* length of bulk argument in multi bulk request */ | |
e2641e09 | 336 | list *reply; |
337 | int sentlen; | |
338 | time_t lastinteraction; /* time of the last interaction, used for timeout */ | |
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 */ | |
e3c51c4b | 347 | blockingState bpop; /* blocking state */ |
e2641e09 | 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) */ | |
834ef78e PN |
353 | |
354 | /* Response buffer */ | |
355 | int bufpos; | |
f3357792 | 356 | char buf[REDIS_REPLY_CHUNK_BYTES]; |
e2641e09 | 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, | |
97e7f8ae | 368 | *outofrangeerr, *loadingerr, *plus, |
e2641e09 | 369 | *select0, *select1, *select2, *select3, *select4, |
370 | *select5, *select6, *select7, *select8, *select9, | |
371 | *messagebulk, *pmessagebulk, *subscribebulk, *unsubscribebulk, *mbulk3, | |
372 | *mbulk4, *psubscribebulk, *punsubscribebulk, | |
373 | *integers[REDIS_SHARED_INTEGERS]; | |
374 | }; | |
375 | ||
c772d9c6 | 376 | /* ZSETs use a specialized version of Skiplists */ |
377 | typedef struct zskiplistNode { | |
378 | robj *obj; | |
379 | double score; | |
380 | struct zskiplistNode *backward; | |
381 | struct zskiplistLevel { | |
382 | struct zskiplistNode *forward; | |
383 | unsigned int span; | |
384 | } level[]; | |
385 | } zskiplistNode; | |
386 | ||
387 | typedef struct zskiplist { | |
388 | struct zskiplistNode *header, *tail; | |
389 | unsigned long length; | |
390 | int level; | |
391 | } zskiplist; | |
392 | ||
393 | typedef struct zset { | |
394 | dict *dict; | |
395 | zskiplist *zsl; | |
396 | } zset; | |
397 | ||
ecc91094 | 398 | /*----------------------------------------------------------------------------- |
399 | * Redis cluster data structures | |
400 | *----------------------------------------------------------------------------*/ | |
401 | ||
402 | #define REDIS_CLUSTER_SLOTS 4096 | |
403 | #define REDIS_CLUSTER_OK 0 /* Everything looks ok */ | |
404 | #define REDIS_CLUSTER_FAIL 1 /* The cluster can't work */ | |
405 | #define REDIS_CLUSTER_NEEDHELP 2 /* The cluster works, but needs some help */ | |
406 | #define REDIS_CLUSTER_NAMELEN 40 /* sha1 hex length */ | |
407 | #define REDIS_CLUSTER_PORT_INCR 10000 /* Cluster port = baseport + PORT_INCR */ | |
408 | ||
409 | struct clusterNode; | |
410 | ||
411 | /* clusterLink encapsulates everything needed to talk with a remote node. */ | |
412 | typedef struct clusterLink { | |
413 | int fd; /* TCP socket file descriptor */ | |
414 | sds sndbuf; /* Packet send buffer */ | |
415 | sds rcvbuf; /* Packet reception buffer */ | |
416 | struct clusterNode *node; /* Node related to this link if any, or NULL */ | |
417 | } clusterLink; | |
418 | ||
419 | /* Node flags */ | |
420 | #define REDIS_NODE_MASTER 1 /* The node is a master */ | |
421 | #define REDIS_NODE_SLAVE 2 /* The node is a slave */ | |
422 | #define REDIS_NODE_PFAIL 4 /* Failure? Need acknowledge */ | |
423 | #define REDIS_NODE_FAIL 8 /* The node is believed to be malfunctioning */ | |
424 | #define REDIS_NODE_MYSELF 16 /* This node is myself */ | |
425 | #define REDIS_NODE_HANDSHAKE 32 /* We have still to exchange the first ping */ | |
426 | #define REDIS_NODE_NOADDR 64 /* We don't know the address of this node */ | |
427 | #define REDIS_NODE_MEET 128 /* Send a MEET message to this node */ | |
428 | #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" | |
429 | ||
430 | struct clusterNode { | |
431 | char name[REDIS_CLUSTER_NAMELEN]; /* Node name, hex string, sha1-size */ | |
432 | int flags; /* REDIS_NODE_... */ | |
433 | unsigned char slots[REDIS_CLUSTER_SLOTS/8]; /* slots handled by this node */ | |
434 | int numslaves; /* Number of slave nodes, if this is a master */ | |
435 | struct clusterNode **slaves; /* pointers to slave nodes */ | |
436 | struct clusterNode *slaveof; /* pointer to the master node */ | |
437 | time_t ping_sent; /* Unix time we sent latest ping */ | |
438 | time_t pong_received; /* Unix time we received the pong */ | |
439 | char *configdigest; /* Configuration digest of this node */ | |
440 | time_t configdigest_ts; /* Configuration digest timestamp */ | |
441 | char ip[16]; /* Latest known IP address of this node */ | |
442 | int port; /* Latest known port of this node */ | |
443 | clusterLink *link; /* TCP/IP link with this node */ | |
444 | }; | |
445 | typedef struct clusterNode clusterNode; | |
446 | ||
447 | typedef struct { | |
ef21ab96 | 448 | char *configfile; |
ecc91094 | 449 | clusterNode *myself; /* This node */ |
450 | int state; /* REDIS_CLUSTER_OK, REDIS_CLUSTER_FAIL, ... */ | |
451 | int node_timeout; | |
452 | dict *nodes; /* Hash table of name -> clusterNode structures */ | |
453 | clusterNode *migrating_slots_to[REDIS_CLUSTER_SLOTS]; | |
454 | clusterNode *importing_slots_from[REDIS_CLUSTER_SLOTS]; | |
455 | clusterNode *slots[REDIS_CLUSTER_SLOTS]; | |
c772d9c6 | 456 | zskiplist *slots_to_keys; |
ecc91094 | 457 | } clusterState; |
458 | ||
459 | /* Redis cluster messages header */ | |
460 | ||
461 | /* Note that the PING, PONG and MEET messages are actually the same exact | |
462 | * kind of packet. PONG is the reply to ping, in the extact format as a PING, | |
463 | * while MEET is a special PING that forces the receiver to add the sender | |
464 | * as a node (if it is not already in the list). */ | |
465 | #define CLUSTERMSG_TYPE_PING 0 /* Ping */ | |
466 | #define CLUSTERMSG_TYPE_PONG 1 /* Pong (reply to Ping) */ | |
467 | #define CLUSTERMSG_TYPE_MEET 2 /* Meet "let's join" message */ | |
468 | #define CLUSTERMSG_TYPE_FAIL 3 /* Mark node xxx as failing */ | |
469 | ||
470 | /* Initially we don't know our "name", but we'll find it once we connect | |
471 | * to the first node, using the getsockname() function. Then we'll use this | |
472 | * address for all the next messages. */ | |
473 | typedef struct { | |
474 | char nodename[REDIS_CLUSTER_NAMELEN]; | |
475 | uint32_t ping_sent; | |
476 | uint32_t pong_received; | |
477 | char ip[16]; /* IP address last time it was seen */ | |
478 | uint16_t port; /* port last time it was seen */ | |
479 | uint16_t flags; | |
480 | uint32_t notused; /* for 64 bit alignment */ | |
481 | } clusterMsgDataGossip; | |
482 | ||
483 | typedef struct { | |
484 | char nodename[REDIS_CLUSTER_NAMELEN]; | |
485 | } clusterMsgDataFail; | |
486 | ||
487 | union clusterMsgData { | |
488 | /* PING, MEET and PONG */ | |
489 | struct { | |
490 | /* Array of N clusterMsgDataGossip structures */ | |
491 | clusterMsgDataGossip gossip[1]; | |
492 | } ping; | |
493 | /* FAIL */ | |
494 | struct { | |
495 | clusterMsgDataFail about; | |
496 | } fail; | |
497 | }; | |
498 | ||
499 | typedef struct { | |
500 | uint32_t totlen; /* Total length of this message */ | |
501 | uint16_t type; /* Message type */ | |
502 | uint16_t count; /* Only used for some kind of messages. */ | |
503 | char sender[REDIS_CLUSTER_NAMELEN]; /* Name of the sender node */ | |
504 | unsigned char myslots[REDIS_CLUSTER_SLOTS/8]; | |
505 | char slaveof[REDIS_CLUSTER_NAMELEN]; | |
506 | char configdigest[32]; | |
507 | uint16_t port; /* Sender TCP base port */ | |
508 | unsigned char state; /* Cluster state from the POV of the sender */ | |
509 | unsigned char notused[5]; /* Reserved for future use. For alignment. */ | |
510 | union clusterMsgData data; | |
511 | } clusterMsg; | |
512 | ||
513 | /*----------------------------------------------------------------------------- | |
514 | * Global server state | |
515 | *----------------------------------------------------------------------------*/ | |
516 | ||
e2641e09 | 517 | struct redisServer { |
5b831607 | 518 | /* General */ |
0e5441d8 | 519 | pthread_t mainthread; |
5b831607 | 520 | redisDb *db; |
521 | dict *commands; /* Command table hahs table */ | |
522 | aeEventLoop *el; | |
523 | /* Networking */ | |
e2641e09 | 524 | int port; |
a5639e7d | 525 | char *bindaddr; |
5d10923f | 526 | char *unixsocket; |
a5639e7d PN |
527 | int ipfd; |
528 | int sofd; | |
ecc91094 | 529 | int cfd; |
e2641e09 | 530 | list *clients; |
5b831607 | 531 | list *slaves, *monitors; |
532 | char neterr[ANET_ERR_LEN]; | |
97e7f8ae | 533 | /* RDB / AOF loading information */ |
534 | int loading; | |
535 | off_t loading_total_bytes; | |
536 | off_t loading_loaded_bytes; | |
537 | time_t loading_start_time; | |
4ebfc455 | 538 | /* Fast pointers to often looked up command */ |
539 | struct redisCommand *delCommand, *multiCommand; | |
e2641e09 | 540 | int cronloops; /* number of times the cron function run */ |
53eeeaff | 541 | time_t lastsave; /* Unix time of last save succeeede */ |
e2641e09 | 542 | /* Fields used only for stats */ |
53eeeaff | 543 | time_t stat_starttime; /* server start time */ |
544 | long long stat_numcommands; /* number of processed commands */ | |
545 | long long stat_numconnections; /* number of connections received */ | |
546 | long long stat_expiredkeys; /* number of expired keys */ | |
f21779ff | 547 | long long stat_evictedkeys; /* number of evicted keys (maxmemory) */ |
53eeeaff | 548 | long long stat_keyspace_hits; /* number of successful lookups of keys */ |
549 | long long stat_keyspace_misses; /* number of failed lookups of keys */ | |
17b24ff3 | 550 | size_t stat_peak_memory; /* max used memory record */ |
615e414c | 551 | long long stat_fork_time; /* time needed to perform latets fork() */ |
e2641e09 | 552 | /* Configuration */ |
553 | int verbosity; | |
e2641e09 | 554 | int maxidletime; |
555 | int dbnum; | |
556 | int daemonize; | |
557 | int appendonly; | |
558 | int appendfsync; | |
559 | int no_appendfsync_on_rewrite; | |
b333e239 | 560 | int auto_aofrewrite_perc; /* Rewrite AOF if % growth is > M and... */ |
561 | off_t auto_aofrewrite_min_size; /* the AOF file is at least N bytes. */ | |
562 | off_t auto_aofrewrite_base_size;/* AOF size on latest startup or rewrite. */ | |
563 | off_t appendonly_current_size; /* AOF current size. */ | |
564 | int aofrewrite_scheduled; /* Rewrite once BGSAVE terminates. */ | |
e2641e09 | 565 | int shutdown_asap; |
36c17a53 | 566 | int activerehashing; |
567 | char *requirepass; | |
568 | /* Persistence */ | |
5b831607 | 569 | long long dirty; /* changes to DB from the last save */ |
570 | long long dirty_before_bgsave; /* used to restore dirty on failed BGSAVE */ | |
e2641e09 | 571 | time_t lastfsync; |
572 | int appendfd; | |
573 | int appendseldb; | |
574 | char *pidfile; | |
575 | pid_t bgsavechildpid; | |
576 | pid_t bgrewritechildpid; | |
36c17a53 | 577 | int bgsavethread_state; |
578 | pthread_mutex_t bgsavethread_mutex; | |
579 | pthread_t bgsavethread; | |
e2641e09 | 580 | sds bgrewritebuf; /* buffer taken by parent during oppend only rewrite */ |
581 | sds aofbuf; /* AOF buffer, written before entering the event loop */ | |
582 | struct saveparam *saveparams; | |
583 | int saveparamslen; | |
36c17a53 | 584 | char *dbfilename; |
585 | int rdbcompression; | |
586 | char *appendfilename; | |
587 | /* Logging */ | |
e2641e09 | 588 | char *logfile; |
e1a586ee JH |
589 | int syslog_enabled; |
590 | char *syslog_ident; | |
591 | int syslog_facility; | |
e2641e09 | 592 | /* Replication related */ |
593 | int isslave; | |
f4aa600b | 594 | /* Slave specific fields */ |
e2641e09 | 595 | char *masterauth; |
596 | char *masterhost; | |
597 | int masterport; | |
598 | redisClient *master; /* client that is master for this slave */ | |
890a2ed9 | 599 | int repl_syncio_timeout; /* timeout for synchronous I/O calls */ |
f4aa600b | 600 | int replstate; /* replication status if the instance is a slave */ |
62ec599c | 601 | off_t repl_transfer_left; /* bytes left reading .rdb */ |
f4aa600b | 602 | int repl_transfer_s; /* slave -> master SYNC socket */ |
603 | int repl_transfer_fd; /* slave -> master SYNC temp file descriptor */ | |
604 | char *repl_transfer_tmpfile; /* slave-> master SYNC temp file name */ | |
605 | time_t repl_transfer_lastio; /* unix time of the latest read, for timeout */ | |
4ebfc455 | 606 | int repl_serve_stale_data; /* Serve stale data when link is down? */ |
07486df6 | 607 | time_t repl_down_since; /* unix time at which link with master went down */ |
f4aa600b | 608 | /* Limits */ |
e2641e09 | 609 | unsigned int maxclients; |
610 | unsigned long long maxmemory; | |
165346ca | 611 | int maxmemory_policy; |
612 | int maxmemory_samples; | |
f4aa600b | 613 | /* Blocked clients */ |
5fa95ad7 | 614 | unsigned int bpop_blocked_clients; |
697af434 | 615 | unsigned int cache_blocked_clients; |
cea8c5cd | 616 | list *unblocked_clients; /* list of clients to unblock before next loop */ |
3be00d7e | 617 | list *cache_io_queue; /* IO operations queue */ |
cea8c5cd | 618 | int cache_flush_delay; /* seconds to wait before flushing keys */ |
e2641e09 | 619 | /* Sort parameters - qsort_r() is only available under BSD so we |
620 | * have to take this state global, in order to pass it to sortCompare() */ | |
621 | int sort_desc; | |
622 | int sort_alpha; | |
623 | int sort_bypattern; | |
624 | /* Virtual memory configuration */ | |
697af434 | 625 | int ds_enabled; /* backend disk in redis.conf */ |
626 | char *ds_path; /* location of the disk store on disk */ | |
627 | unsigned long long cache_max_memory; | |
e2641e09 | 628 | /* Zip structure config */ |
629 | size_t hash_max_zipmap_entries; | |
630 | size_t hash_max_zipmap_value; | |
631 | size_t list_max_ziplist_entries; | |
632 | size_t list_max_ziplist_value; | |
96ffb2fe | 633 | size_t set_max_intset_entries; |
3ea204e1 PN |
634 | size_t zset_max_ziplist_entries; |
635 | size_t zset_max_ziplist_value; | |
e2641e09 | 636 | time_t unixtime; /* Unix time sampled every second. */ |
637 | /* Virtual memory I/O threads stuff */ | |
638 | /* An I/O thread process an element taken from the io_jobs queue and | |
639 | * put the result of the operation in the io_done list. While the | |
640 | * job is being processed, it's put on io_processing queue. */ | |
641 | list *io_newjobs; /* List of VM I/O jobs yet to be processed */ | |
642 | list *io_processing; /* List of VM I/O jobs being processed */ | |
643 | list *io_processed; /* List of VM I/O jobs already processed */ | |
644 | list *io_ready_clients; /* Clients ready to be unblocked. All keys loaded */ | |
645 | pthread_mutex_t io_mutex; /* lock to access io_jobs/io_done/io_thread_job */ | |
98a9abb6 | 646 | pthread_cond_t io_condvar; /* I/O threads conditional variable */ |
e2641e09 | 647 | pthread_attr_t io_threads_attr; /* attributes for threads creation */ |
648 | int io_active_threads; /* Number of running I/O threads */ | |
649 | int vm_max_threads; /* Max number of I/O threads running at the same time */ | |
650 | /* Our main thread is blocked on the event loop, locking for sockets ready | |
651 | * to be read or written, so when a threaded I/O operation is ready to be | |
652 | * processed by the main thread, the I/O thread will use a unix pipe to | |
653 | * awake the main thread. The followings are the two pipe FDs. */ | |
654 | int io_ready_pipe_read; | |
655 | int io_ready_pipe_write; | |
656 | /* Virtual memory stats */ | |
657 | unsigned long long vm_stats_used_pages; | |
658 | unsigned long long vm_stats_swapped_objects; | |
659 | unsigned long long vm_stats_swapouts; | |
660 | unsigned long long vm_stats_swapins; | |
661 | /* Pubsub */ | |
662 | dict *pubsub_channels; /* Map channels to list of subscribed clients */ | |
663 | list *pubsub_patterns; /* A list of pubsub_patterns */ | |
664 | /* Misc */ | |
e2641e09 | 665 | unsigned lruclock:22; /* clock incrementing every minute, for LRU */ |
666 | unsigned lruclock_padding:10; | |
c772d9c6 | 667 | /* Cluster */ |
ecc91094 | 668 | int cluster_enabled; |
669 | clusterState cluster; | |
e2641e09 | 670 | }; |
671 | ||
672 | typedef struct pubsubPattern { | |
673 | redisClient *client; | |
674 | robj *pattern; | |
675 | } pubsubPattern; | |
676 | ||
677 | typedef void redisCommandProc(redisClient *c); | |
9791f0f8 | 678 | typedef int *redisGetKeysProc(struct redisCommand *cmd, robj **argv, int argc, int *numkeys, int flags); |
e2641e09 | 679 | struct redisCommand { |
680 | char *name; | |
681 | redisCommandProc *proc; | |
682 | int arity; | |
683 | int flags; | |
9791f0f8 | 684 | /* Use a function to determine keys arguments in a command line. |
685 | * Used both for diskstore preloading and Redis Cluster. */ | |
686 | redisGetKeysProc *getkeys_proc; | |
e2641e09 | 687 | /* What keys should be loaded in background when calling this command? */ |
9791f0f8 | 688 | int firstkey; /* The first argument that's a key (0 = no keys) */ |
689 | int lastkey; /* THe last argument that's a key */ | |
690 | int keystep; /* The step between first and last key */ | |
0d808ef2 | 691 | long long microseconds, calls; |
e2641e09 | 692 | }; |
693 | ||
694 | struct redisFunctionSym { | |
695 | char *name; | |
696 | unsigned long pointer; | |
697 | }; | |
698 | ||
699 | typedef struct _redisSortObject { | |
700 | robj *obj; | |
701 | union { | |
702 | double score; | |
703 | robj *cmpobj; | |
704 | } u; | |
705 | } redisSortObject; | |
706 | ||
707 | typedef struct _redisSortOperation { | |
708 | int type; | |
709 | robj *pattern; | |
710 | } redisSortOperation; | |
711 | ||
3be00d7e | 712 | /* DIsk store threaded I/O request message */ |
f34a6cd8 | 713 | #define REDIS_IOJOB_LOAD 0 |
714 | #define REDIS_IOJOB_SAVE 1 | |
715 | ||
e2641e09 | 716 | typedef struct iojob { |
717 | int type; /* Request type, REDIS_IOJOB_* */ | |
718 | redisDb *db;/* Redis database */ | |
f34a6cd8 | 719 | robj *key; /* This I/O request is about this key */ |
720 | robj *val; /* the value to swap for REDIS_IOJOB_SAVE, otherwise this | |
721 | * field is populated by the I/O thread for REDIS_IOJOB_LOAD. */ | |
4ab98823 | 722 | time_t expire; /* Expire time for this key on REDIS_IOJOB_LOAD */ |
e2641e09 | 723 | } iojob; |
724 | ||
3be00d7e | 725 | /* IO operations scheduled -- check dscache.c for more info */ |
726 | typedef struct ioop { | |
727 | int type; | |
cea8c5cd | 728 | redisDb *db; |
729 | robj *key; | |
730 | time_t ctime; /* This is the creation time of the entry. */ | |
3be00d7e | 731 | } ioop; |
cea8c5cd | 732 | |
e2641e09 | 733 | /* Structure to hold list iteration abstraction. */ |
734 | typedef struct { | |
735 | robj *subject; | |
736 | unsigned char encoding; | |
737 | unsigned char direction; /* Iteration direction */ | |
738 | unsigned char *zi; | |
739 | listNode *ln; | |
740 | } listTypeIterator; | |
741 | ||
742 | /* Structure for an entry while iterating over a list. */ | |
743 | typedef struct { | |
744 | listTypeIterator *li; | |
745 | unsigned char *zi; /* Entry in ziplist */ | |
746 | listNode *ln; /* Entry in linked list */ | |
747 | } listTypeEntry; | |
748 | ||
96ffb2fe PN |
749 | /* Structure to hold set iteration abstraction. */ |
750 | typedef struct { | |
751 | robj *subject; | |
752 | int encoding; | |
753 | int ii; /* intset iterator */ | |
754 | dictIterator *di; | |
cb72d0f1 | 755 | } setTypeIterator; |
96ffb2fe | 756 | |
e2641e09 | 757 | /* Structure to hold hash iteration abstration. Note that iteration over |
758 | * hashes involves both fields and values. Because it is possible that | |
759 | * not both are required, store pointers in the iterator to avoid | |
760 | * unnecessary memory allocation for fields/values. */ | |
761 | typedef struct { | |
762 | int encoding; | |
763 | unsigned char *zi; | |
764 | unsigned char *zk, *zv; | |
765 | unsigned int zklen, zvlen; | |
766 | ||
767 | dictIterator *di; | |
768 | dictEntry *de; | |
769 | } hashTypeIterator; | |
770 | ||
771 | #define REDIS_HASH_KEY 1 | |
772 | #define REDIS_HASH_VALUE 2 | |
773 | ||
774 | /*----------------------------------------------------------------------------- | |
775 | * Extern declarations | |
776 | *----------------------------------------------------------------------------*/ | |
777 | ||
778 | extern struct redisServer server; | |
779 | extern struct sharedObjectsStruct shared; | |
780 | extern dictType setDictType; | |
781 | extern dictType zsetDictType; | |
ecc91094 | 782 | extern dictType clusterNodesDictType; |
e2641e09 | 783 | extern double R_Zero, R_PosInf, R_NegInf, R_Nan; |
784 | dictType hashDictType; | |
785 | ||
786 | /*----------------------------------------------------------------------------- | |
787 | * Functions prototypes | |
788 | *----------------------------------------------------------------------------*/ | |
789 | ||
419e1cca | 790 | /* Utils */ |
791 | long long ustime(void); | |
792 | ||
e2641e09 | 793 | /* networking.c -- Networking and Client related operations */ |
794 | redisClient *createClient(int fd); | |
795 | void closeTimedoutClients(void); | |
796 | void freeClient(redisClient *c); | |
797 | void resetClient(redisClient *c); | |
798 | void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask); | |
e2641e09 | 799 | void addReply(redisClient *c, robj *obj); |
b301c1fc PN |
800 | void *addDeferredMultiBulkLength(redisClient *c); |
801 | void setDeferredMultiBulkLength(redisClient *c, void *node, long length); | |
e2641e09 | 802 | void addReplySds(redisClient *c, sds s); |
803 | void processInputBuffer(redisClient *c); | |
ab17b909 PN |
804 | void acceptTcpHandler(aeEventLoop *el, int fd, void *privdata, int mask); |
805 | void acceptUnixHandler(aeEventLoop *el, int fd, void *privdata, int mask); | |
e2641e09 | 806 | void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask); |
807 | void addReplyBulk(redisClient *c, robj *obj); | |
808 | void addReplyBulkCString(redisClient *c, char *s); | |
d51ebef5 | 809 | void addReplyBulkCBuffer(redisClient *c, void *p, size_t len); |
810 | void addReplyBulkLongLong(redisClient *c, long long ll); | |
e2641e09 | 811 | void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask); |
812 | void addReply(redisClient *c, robj *obj); | |
813 | void addReplySds(redisClient *c, sds s); | |
3ab20376 PN |
814 | void addReplyError(redisClient *c, char *err); |
815 | void addReplyStatus(redisClient *c, char *status); | |
e2641e09 | 816 | void addReplyDouble(redisClient *c, double d); |
817 | void addReplyLongLong(redisClient *c, long long ll); | |
0537e7bf | 818 | void addReplyMultiBulkLen(redisClient *c, long length); |
e2641e09 | 819 | void *dupClientReplyValue(void *o); |
7a1fd61e | 820 | void getClientsMaxBuffers(unsigned long *longest_output_list, |
821 | unsigned long *biggest_input_buffer); | |
e2641e09 | 822 | |
3ab20376 PN |
823 | #ifdef __GNUC__ |
824 | void addReplyErrorFormat(redisClient *c, const char *fmt, ...) | |
825 | __attribute__((format(printf, 2, 3))); | |
826 | void addReplyStatusFormat(redisClient *c, const char *fmt, ...) | |
827 | __attribute__((format(printf, 2, 3))); | |
828 | #else | |
829 | void addReplyErrorFormat(redisClient *c, const char *fmt, ...); | |
830 | void addReplyStatusFormat(redisClient *c, const char *fmt, ...); | |
831 | #endif | |
832 | ||
e2641e09 | 833 | /* List data type */ |
834 | void listTypeTryConversion(robj *subject, robj *value); | |
835 | void listTypePush(robj *subject, robj *value, int where); | |
836 | robj *listTypePop(robj *subject, int where); | |
837 | unsigned long listTypeLength(robj *subject); | |
838 | listTypeIterator *listTypeInitIterator(robj *subject, int index, unsigned char direction); | |
839 | void listTypeReleaseIterator(listTypeIterator *li); | |
840 | int listTypeNext(listTypeIterator *li, listTypeEntry *entry); | |
841 | robj *listTypeGet(listTypeEntry *entry); | |
842 | void listTypeInsert(listTypeEntry *entry, robj *value, int where); | |
843 | int listTypeEqual(listTypeEntry *entry, robj *o); | |
844 | void listTypeDelete(listTypeEntry *entry); | |
845 | void listTypeConvert(robj *subject, int enc); | |
846 | void unblockClientWaitingData(redisClient *c); | |
847 | int handleClientsWaitingListPush(redisClient *c, robj *key, robj *ele); | |
848 | void popGenericCommand(redisClient *c, int where); | |
849 | ||
850 | /* MULTI/EXEC/WATCH... */ | |
851 | void unwatchAllKeys(redisClient *c); | |
852 | void initClientMultiState(redisClient *c); | |
853 | void freeClientMultiState(redisClient *c); | |
854 | void queueMultiCommand(redisClient *c, struct redisCommand *cmd); | |
855 | void touchWatchedKey(redisDb *db, robj *key); | |
856 | void touchWatchedKeysOnFlush(int dbid); | |
857 | ||
858 | /* Redis object implementation */ | |
859 | void decrRefCount(void *o); | |
860 | void incrRefCount(robj *o); | |
861 | void freeStringObject(robj *o); | |
862 | void freeListObject(robj *o); | |
863 | void freeSetObject(robj *o); | |
864 | void freeZsetObject(robj *o); | |
865 | void freeHashObject(robj *o); | |
866 | robj *createObject(int type, void *ptr); | |
867 | robj *createStringObject(char *ptr, size_t len); | |
868 | robj *dupStringObject(robj *o); | |
5d081931 | 869 | int isObjectRepresentableAsLongLong(robj *o, long long *llongval); |
e2641e09 | 870 | robj *tryObjectEncoding(robj *o); |
871 | robj *getDecodedObject(robj *o); | |
872 | size_t stringObjectLen(robj *o); | |
e2641e09 | 873 | robj *createStringObjectFromLongLong(long long value); |
874 | robj *createListObject(void); | |
875 | robj *createZiplistObject(void); | |
876 | robj *createSetObject(void); | |
96ffb2fe | 877 | robj *createIntsetObject(void); |
e2641e09 | 878 | robj *createHashObject(void); |
879 | robj *createZsetObject(void); | |
9e7cee0e | 880 | robj *createZsetZiplistObject(void); |
e2641e09 | 881 | int getLongFromObjectOrReply(redisClient *c, robj *o, long *target, const char *msg); |
882 | int checkType(redisClient *c, robj *o, int type); | |
883 | int getLongLongFromObjectOrReply(redisClient *c, robj *o, long long *target, const char *msg); | |
884 | int getDoubleFromObjectOrReply(redisClient *c, robj *o, double *target, const char *msg); | |
885 | int getLongLongFromObject(robj *o, long long *target); | |
886 | char *strEncoding(int encoding); | |
887 | int compareStringObjects(robj *a, robj *b); | |
888 | int equalStringObjects(robj *a, robj *b); | |
ef59a8bc | 889 | unsigned long estimateObjectIdleTime(robj *o); |
e2641e09 | 890 | |
19e61097 | 891 | /* Synchronous I/O with timeout */ |
892 | int syncWrite(int fd, char *ptr, ssize_t size, int timeout); | |
893 | int syncRead(int fd, char *ptr, ssize_t size, int timeout); | |
894 | int syncReadLine(int fd, char *ptr, ssize_t size, int timeout); | |
d08fac3e | 895 | int fwriteBulkString(FILE *fp, char *s, unsigned long len); |
896 | int fwriteBulkDouble(FILE *fp, double d); | |
897 | int fwriteBulkLongLong(FILE *fp, long long l); | |
244201f6 | 898 | int fwriteBulkObject(FILE *fp, robj *obj); |
ecc91094 | 899 | int fwriteBulkCount(FILE *fp, char prefix, int count); |
19e61097 | 900 | |
e2641e09 | 901 | /* Replication */ |
902 | void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc); | |
903 | void replicationFeedMonitors(list *monitors, int dictid, robj **argv, int argc); | |
e2641e09 | 904 | void updateSlavesWaitingBgsave(int bgsaveerr); |
f4aa600b | 905 | void replicationCron(void); |
e2641e09 | 906 | |
97e7f8ae | 907 | /* Generic persistence functions */ |
908 | void startLoading(FILE *fp); | |
909 | void loadingProgress(off_t pos); | |
910 | void stopLoading(void); | |
911 | ||
e2641e09 | 912 | /* RDB persistence */ |
913 | int rdbLoad(char *filename); | |
914 | int rdbSaveBackground(char *filename); | |
915 | void rdbRemoveTempFile(pid_t childpid); | |
916 | int rdbSave(char *filename); | |
917 | int rdbSaveObject(FILE *fp, robj *o); | |
bd70a5f5 PN |
918 | off_t rdbSavedObjectLen(robj *o); |
919 | off_t rdbSavedObjectPages(robj *o); | |
e2641e09 | 920 | robj *rdbLoadObject(int type, FILE *fp); |
5b8ce853 | 921 | void backgroundSaveDoneHandler(int exitcode, int bysignal); |
05600eb8 | 922 | int rdbSaveKeyValuePair(FILE *fp, robj *key, robj *val, time_t expireitme, time_t now); |
1fce3201 | 923 | int rdbLoadType(FILE *fp); |
924 | time_t rdbLoadTime(FILE *fp); | |
925 | robj *rdbLoadStringObject(FILE *fp); | |
f03fe802 | 926 | int rdbSaveType(FILE *fp, unsigned char type); |
927 | int rdbSaveLen(FILE *fp, uint32_t len); | |
e2641e09 | 928 | |
929 | /* AOF persistence */ | |
930 | void flushAppendOnlyFile(void); | |
931 | void feedAppendOnlyFile(struct redisCommand *cmd, int dictid, robj **argv, int argc); | |
932 | void aofRemoveTempFile(pid_t childpid); | |
933 | int rewriteAppendOnlyFileBackground(void); | |
934 | int loadAppendOnlyFile(char *filename); | |
935 | void stopAppendOnly(void); | |
936 | int startAppendOnly(void); | |
36c17a53 | 937 | void backgroundRewriteDoneHandler(int exitcode, int bysignal); |
e2641e09 | 938 | |
939 | /* Sorted sets data type */ | |
c772d9c6 | 940 | |
941 | /* Struct to hold a inclusive/exclusive range spec. */ | |
942 | typedef struct { | |
943 | double min, max; | |
944 | int minex, maxex; /* are min or max exclusive? */ | |
945 | } zrangespec; | |
946 | ||
e2641e09 | 947 | zskiplist *zslCreate(void); |
948 | void zslFree(zskiplist *zsl); | |
69ef89f2 | 949 | zskiplistNode *zslInsert(zskiplist *zsl, double score, robj *obj); |
8588bfa3 | 950 | unsigned char *zzlInsert(unsigned char *zl, robj *ele, double score); |
c772d9c6 | 951 | int zslDelete(zskiplist *zsl, double score, robj *obj); |
952 | zskiplistNode *zslFirstInRange(zskiplist *zsl, zrangespec range); | |
dddf5335 PN |
953 | double zzlGetScore(unsigned char *sptr); |
954 | void zzlNext(unsigned char *zl, unsigned char **eptr, unsigned char **sptr); | |
955 | void zzlPrev(unsigned char *zl, unsigned char **eptr, unsigned char **sptr); | |
df26a0ae PN |
956 | unsigned int zsetLength(robj *zobj); |
957 | void zsetConvert(robj *zobj, int encoding); | |
e2641e09 | 958 | |
959 | /* Core functions */ | |
960 | void freeMemoryIfNeeded(void); | |
961 | int processCommand(redisClient *c); | |
633a9410 | 962 | void setupSignalHandlers(void); |
1b1f47c9 | 963 | struct redisCommand *lookupCommand(sds name); |
964 | struct redisCommand *lookupCommandByCString(char *s); | |
e2641e09 | 965 | void call(redisClient *c, struct redisCommand *cmd); |
966 | int prepareForShutdown(); | |
967 | void redisLog(int level, const char *fmt, ...); | |
968 | void usage(); | |
969 | void updateDictResizePolicy(void); | |
970 | int htNeedsResize(dict *dict); | |
971 | void oom(const char *msg); | |
1b1f47c9 | 972 | void populateCommandTable(void); |
d7ed7fd2 | 973 | void resetCommandTableStats(void); |
e2641e09 | 974 | |
33388d43 | 975 | /* Disk store */ |
976 | int dsOpen(void); | |
977 | int dsClose(void); | |
05600eb8 | 978 | int dsSet(redisDb *db, robj *key, robj *val, time_t expire); |
1fce3201 | 979 | robj *dsGet(redisDb *db, robj *key, time_t *expire); |
5ef64098 | 980 | int dsDel(redisDb *db, robj *key); |
33388d43 | 981 | int dsExists(redisDb *db, robj *key); |
120b9ba8 | 982 | void dsFlushDb(int dbid); |
cc275067 | 983 | int dsRdbSaveBackground(char *filename); |
5b8ce853 | 984 | int dsRdbSave(char *filename); |
33388d43 | 985 | |
986 | /* Disk Store Cache */ | |
cea8c5cd | 987 | void dsInit(void); |
e2641e09 | 988 | void vmThreadedIOCompletedJob(aeEventLoop *el, int fd, void *privdata, int mask); |
e2641e09 | 989 | void lockThreadedIO(void); |
990 | void unlockThreadedIO(void); | |
e2641e09 | 991 | void freeIOJob(iojob *j); |
992 | void queueIOJob(iojob *j); | |
e2641e09 | 993 | void waitEmptyIOJobsQueue(void); |
8d51fb6a | 994 | void processAllPendingIOJobs(void); |
e2641e09 | 995 | int blockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd); |
996 | int dontWaitForSwappedKey(redisClient *c, robj *key); | |
997 | void handleClientsBlockedOnSwappedKey(redisDb *db, robj *key); | |
cea8c5cd | 998 | int cacheFreeOneEntry(void); |
3be00d7e | 999 | void cacheScheduleIOAddFlag(redisDb *db, robj *key, long flag); |
1000 | void cacheScheduleIODelFlag(redisDb *db, robj *key, long flag); | |
1001 | int cacheScheduleIOGetFlags(redisDb *db, robj *key); | |
1002 | void cacheScheduleIO(redisDb *db, robj *key, int type); | |
f63f0928 | 1003 | void cacheCron(void); |
31222292 | 1004 | int cacheKeyMayExist(redisDb *db, robj *key); |
c15a3887 | 1005 | void cacheSetKeyMayExist(redisDb *db, robj *key); |
d934e1e8 | 1006 | void cacheSetKeyDoesNotExist(redisDb *db, robj *key); |
249ad25f | 1007 | void cacheForcePointInTime(void); |
e2641e09 | 1008 | |
96ffb2fe PN |
1009 | /* Set data type */ |
1010 | robj *setTypeCreate(robj *value); | |
1011 | int setTypeAdd(robj *subject, robj *value); | |
1012 | int setTypeRemove(robj *subject, robj *value); | |
1013 | int setTypeIsMember(robj *subject, robj *value); | |
cb72d0f1 PN |
1014 | setTypeIterator *setTypeInitIterator(robj *subject); |
1015 | void setTypeReleaseIterator(setTypeIterator *si); | |
1b508da7 | 1016 | int setTypeNext(setTypeIterator *si, robj **objele, int64_t *llele); |
1017 | robj *setTypeNextObject(setTypeIterator *si); | |
dd48de74 | 1018 | int setTypeRandomElement(robj *setobj, robj **objele, int64_t *llele); |
96ffb2fe PN |
1019 | unsigned long setTypeSize(robj *subject); |
1020 | void setTypeConvert(robj *subject, int enc); | |
1021 | ||
e2641e09 | 1022 | /* Hash data type */ |
1023 | void convertToRealHash(robj *o); | |
1024 | void hashTypeTryConversion(robj *subject, robj **argv, int start, int end); | |
1025 | void hashTypeTryObjectEncoding(robj *subject, robj **o1, robj **o2); | |
3d24304f | 1026 | int hashTypeGet(robj *o, robj *key, robj **objval, unsigned char **v, unsigned int *vlen); |
1027 | robj *hashTypeGetObject(robj *o, robj *key); | |
e2641e09 | 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); | |
8c304be3 | 1035 | int hashTypeCurrent(hashTypeIterator *hi, int what, robj **objval, unsigned char **v, unsigned int *vlen); |
1036 | robj *hashTypeCurrentObject(hashTypeIterator *hi, int what); | |
e2641e09 | 1037 | robj *hashTypeLookupWriteOrCreate(redisClient *c, robj *key); |
1038 | ||
1039 | /* Pub / Sub */ | |
1040 | int pubsubUnsubscribeAllChannels(redisClient *c, int notify); | |
1041 | int pubsubUnsubscribeAllPatterns(redisClient *c, int notify); | |
1042 | void freePubsubPattern(void *p); | |
1043 | int listMatchPubsubPattern(void *a, void *b); | |
1044 | ||
e2641e09 | 1045 | /* Configuration */ |
1046 | void loadServerConfig(char *filename); | |
1047 | void appendServerSaveParams(time_t seconds, int changes); | |
1048 | void resetServerSaveParams(); | |
1049 | ||
1050 | /* db.c -- Keyspace access API */ | |
1051 | int removeExpire(redisDb *db, robj *key); | |
bcf2995c | 1052 | void propagateExpire(redisDb *db, robj *key); |
e2641e09 | 1053 | int expireIfNeeded(redisDb *db, robj *key); |
e2641e09 | 1054 | time_t getExpire(redisDb *db, robj *key); |
0cf5b7b5 | 1055 | void setExpire(redisDb *db, robj *key, time_t when); |
e2641e09 | 1056 | robj *lookupKey(redisDb *db, robj *key); |
1057 | robj *lookupKeyRead(redisDb *db, robj *key); | |
1058 | robj *lookupKeyWrite(redisDb *db, robj *key); | |
1059 | robj *lookupKeyReadOrReply(redisClient *c, robj *key, robj *reply); | |
1060 | robj *lookupKeyWriteOrReply(redisClient *c, robj *key, robj *reply); | |
1061 | int dbAdd(redisDb *db, robj *key, robj *val); | |
1062 | int dbReplace(redisDb *db, robj *key, robj *val); | |
1063 | int dbExists(redisDb *db, robj *key); | |
1064 | robj *dbRandomKey(redisDb *db); | |
1065 | int dbDelete(redisDb *db, robj *key); | |
1066 | long long emptyDb(); | |
1067 | int selectDb(redisClient *c, int id); | |
cea8c5cd | 1068 | void signalModifiedKey(redisDb *db, robj *key); |
1069 | void signalFlushedDb(int dbid); | |
484354ff | 1070 | unsigned int GetKeysInSlot(unsigned int hashslot, robj **keys, unsigned int count); |
e2641e09 | 1071 | |
9791f0f8 | 1072 | /* API to get key arguments from commands */ |
1073 | #define REDIS_GETKEYS_ALL 0 | |
1074 | #define REDIS_GETKEYS_PRELOAD 1 | |
1075 | int *getKeysFromCommand(struct redisCommand *cmd, robj **argv, int argc, int *numkeys, int flags); | |
1076 | void getKeysFreeResult(int *result); | |
1077 | int *noPreloadGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags); | |
1078 | int *renameGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags); | |
1079 | int *zunionInterGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags); | |
1080 | ||
ecc91094 | 1081 | /* Cluster */ |
1082 | void clusterInit(void); | |
1083 | unsigned short crc16(const char *buf, int len); | |
1084 | unsigned int keyHashSlot(char *key, int keylen); | |
1085 | clusterNode *createClusterNode(char *nodename, int flags); | |
1086 | int clusterAddNode(clusterNode *node); | |
1087 | void clusterCron(void); | |
eda827f8 | 1088 | clusterNode *getNodeByQuery(redisClient *c, struct redisCommand *cmd, robj **argv, int argc, int *hashslot, int *ask); |
ecc91094 | 1089 | |
e2641e09 | 1090 | /* Git SHA1 */ |
1091 | char *redisGitSHA1(void); | |
1092 | char *redisGitDirty(void); | |
1093 | ||
1094 | /* Commands prototypes */ | |
1095 | void authCommand(redisClient *c); | |
1096 | void pingCommand(redisClient *c); | |
1097 | void echoCommand(redisClient *c); | |
1098 | void setCommand(redisClient *c); | |
1099 | void setnxCommand(redisClient *c); | |
1100 | void setexCommand(redisClient *c); | |
1101 | void getCommand(redisClient *c); | |
1102 | void delCommand(redisClient *c); | |
1103 | void existsCommand(redisClient *c); | |
3c1bf495 PN |
1104 | void setbitCommand(redisClient *c); |
1105 | void getbitCommand(redisClient *c); | |
9f9e1cea | 1106 | void setrangeCommand(redisClient *c); |
ef11bccc | 1107 | void getrangeCommand(redisClient *c); |
e2641e09 | 1108 | void incrCommand(redisClient *c); |
1109 | void decrCommand(redisClient *c); | |
1110 | void incrbyCommand(redisClient *c); | |
1111 | void decrbyCommand(redisClient *c); | |
1112 | void selectCommand(redisClient *c); | |
1113 | void randomkeyCommand(redisClient *c); | |
1114 | void keysCommand(redisClient *c); | |
1115 | void dbsizeCommand(redisClient *c); | |
1116 | void lastsaveCommand(redisClient *c); | |
1117 | void saveCommand(redisClient *c); | |
1118 | void bgsaveCommand(redisClient *c); | |
1119 | void bgrewriteaofCommand(redisClient *c); | |
1120 | void shutdownCommand(redisClient *c); | |
1121 | void moveCommand(redisClient *c); | |
1122 | void renameCommand(redisClient *c); | |
1123 | void renamenxCommand(redisClient *c); | |
1124 | void lpushCommand(redisClient *c); | |
1125 | void rpushCommand(redisClient *c); | |
1126 | void lpushxCommand(redisClient *c); | |
1127 | void rpushxCommand(redisClient *c); | |
1128 | void linsertCommand(redisClient *c); | |
1129 | void lpopCommand(redisClient *c); | |
1130 | void rpopCommand(redisClient *c); | |
1131 | void llenCommand(redisClient *c); | |
1132 | void lindexCommand(redisClient *c); | |
1133 | void lrangeCommand(redisClient *c); | |
1134 | void ltrimCommand(redisClient *c); | |
1135 | void typeCommand(redisClient *c); | |
1136 | void lsetCommand(redisClient *c); | |
1137 | void saddCommand(redisClient *c); | |
1138 | void sremCommand(redisClient *c); | |
1139 | void smoveCommand(redisClient *c); | |
1140 | void sismemberCommand(redisClient *c); | |
1141 | void scardCommand(redisClient *c); | |
1142 | void spopCommand(redisClient *c); | |
1143 | void srandmemberCommand(redisClient *c); | |
1144 | void sinterCommand(redisClient *c); | |
1145 | void sinterstoreCommand(redisClient *c); | |
1146 | void sunionCommand(redisClient *c); | |
1147 | void sunionstoreCommand(redisClient *c); | |
1148 | void sdiffCommand(redisClient *c); | |
1149 | void sdiffstoreCommand(redisClient *c); | |
1150 | void syncCommand(redisClient *c); | |
1151 | void flushdbCommand(redisClient *c); | |
1152 | void flushallCommand(redisClient *c); | |
1153 | void sortCommand(redisClient *c); | |
1154 | void lremCommand(redisClient *c); | |
8a979f03 | 1155 | void rpoplpushCommand(redisClient *c); |
e2641e09 | 1156 | void infoCommand(redisClient *c); |
1157 | void mgetCommand(redisClient *c); | |
1158 | void monitorCommand(redisClient *c); | |
1159 | void expireCommand(redisClient *c); | |
1160 | void expireatCommand(redisClient *c); | |
1161 | void getsetCommand(redisClient *c); | |
1162 | void ttlCommand(redisClient *c); | |
a539d29a | 1163 | void persistCommand(redisClient *c); |
e2641e09 | 1164 | void slaveofCommand(redisClient *c); |
1165 | void debugCommand(redisClient *c); | |
1166 | void msetCommand(redisClient *c); | |
1167 | void msetnxCommand(redisClient *c); | |
1168 | void zaddCommand(redisClient *c); | |
1169 | void zincrbyCommand(redisClient *c); | |
1170 | void zrangeCommand(redisClient *c); | |
1171 | void zrangebyscoreCommand(redisClient *c); | |
25bb8a44 | 1172 | void zrevrangebyscoreCommand(redisClient *c); |
e2641e09 | 1173 | void zcountCommand(redisClient *c); |
1174 | void zrevrangeCommand(redisClient *c); | |
1175 | void zcardCommand(redisClient *c); | |
1176 | void zremCommand(redisClient *c); | |
1177 | void zscoreCommand(redisClient *c); | |
1178 | void zremrangebyscoreCommand(redisClient *c); | |
1179 | void multiCommand(redisClient *c); | |
1180 | void execCommand(redisClient *c); | |
1181 | void discardCommand(redisClient *c); | |
1182 | void blpopCommand(redisClient *c); | |
1183 | void brpopCommand(redisClient *c); | |
b2a7fd0c | 1184 | void brpoplpushCommand(redisClient *c); |
e2641e09 | 1185 | void appendCommand(redisClient *c); |
80091bba | 1186 | void strlenCommand(redisClient *c); |
e2641e09 | 1187 | void zrankCommand(redisClient *c); |
1188 | void zrevrankCommand(redisClient *c); | |
1189 | void hsetCommand(redisClient *c); | |
1190 | void hsetnxCommand(redisClient *c); | |
1191 | void hgetCommand(redisClient *c); | |
1192 | void hmsetCommand(redisClient *c); | |
1193 | void hmgetCommand(redisClient *c); | |
1194 | void hdelCommand(redisClient *c); | |
1195 | void hlenCommand(redisClient *c); | |
1196 | void zremrangebyrankCommand(redisClient *c); | |
1197 | void zunionstoreCommand(redisClient *c); | |
1198 | void zinterstoreCommand(redisClient *c); | |
1199 | void hkeysCommand(redisClient *c); | |
1200 | void hvalsCommand(redisClient *c); | |
1201 | void hgetallCommand(redisClient *c); | |
1202 | void hexistsCommand(redisClient *c); | |
1203 | void configCommand(redisClient *c); | |
1204 | void hincrbyCommand(redisClient *c); | |
1205 | void subscribeCommand(redisClient *c); | |
1206 | void unsubscribeCommand(redisClient *c); | |
1207 | void psubscribeCommand(redisClient *c); | |
1208 | void punsubscribeCommand(redisClient *c); | |
1209 | void publishCommand(redisClient *c); | |
1210 | void watchCommand(redisClient *c); | |
1211 | void unwatchCommand(redisClient *c); | |
ecc91094 | 1212 | void clusterCommand(redisClient *c); |
1213 | void restoreCommand(redisClient *c); | |
1214 | void migrateCommand(redisClient *c); | |
626f6b2d | 1215 | void dumpCommand(redisClient *c); |
ece74202 | 1216 | void objectCommand(redisClient *c); |
3cd12b56 | 1217 | void clientCommand(redisClient *c); |
e2641e09 | 1218 | |
b3aa6d71 | 1219 | #if defined(__GNUC__) |
b3aa6d71 | 1220 | void *calloc(size_t count, size_t size) __attribute__ ((deprecated)); |
1221 | void free(void *ptr) __attribute__ ((deprecated)); | |
1222 | void *malloc(size_t size) __attribute__ ((deprecated)); | |
1223 | void *realloc(void *ptr, size_t size) __attribute__ ((deprecated)); | |
1224 | #endif | |
1225 | ||
e2641e09 | 1226 | #endif |