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