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