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