]> git.saurik.com Git - redis.git/blame - src/redis.h
Test: more MIGRATE tests.
[redis.git] / src / redis.h
CommitLineData
4365e5b2 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
e2641e09 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>
3688d7f3 47#include <inttypes.h>
d06a5b23 48#include <pthread.h>
e1a586ee 49#include <syslog.h>
ecc91094 50#include <netinet/in.h>
7585836e 51#include <lua.h>
eea8c7a4 52#include <signal.h>
e2641e09 53
daa70b17 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 */
e2641e09 58#include "zmalloc.h" /* total memory usage aware version of malloc/free */
daa70b17 59#include "anet.h" /* Networking the easy way */
e2641e09 60#include "ziplist.h" /* Compact list data structure */
daa70b17 61#include "intset.h" /* Compact integer set structure */
62#include "version.h" /* Version macro */
63#include "util.h" /* Misc functions useful in many places */
e2641e09 64
65/* Error codes */
66#define REDIS_OK 0
67#define REDIS_ERR -1
68
69/* Static server configuration */
61daf891 70#define REDIS_HZ 100 /* Time interrupt calls/sec. */
e2641e09 71#define REDIS_SERVERPORT 6379 /* TCP port */
3570629f 72#define REDIS_MAXIDLETIME 0 /* default client timeout: infinite */
e2641e09 73#define REDIS_DEFAULT_DBNUM 16
74#define REDIS_CONFIGLINE_MAX 1024
e2641e09 75#define REDIS_EXPIRELOOKUPS_PER_CRON 10 /* lookup 10 expires per loop */
94343492 76#define REDIS_EXPIRELOOKUPS_TIME_PERC 25 /* CPU max % for keys collection */
e2641e09 77#define REDIS_MAX_WRITE_PER_EVENT (1024*64)
f892797e 78#define REDIS_SHARED_SELECT_CMDS 10
e2641e09 79#define REDIS_SHARED_INTEGERS 10000
355f8591 80#define REDIS_SHARED_BULKHDR_LEN 32
e1a586ee 81#define REDIS_MAX_LOGMSG_LEN 1024 /* Default maximum length of syslog messages */
2c915bcf 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
daa70b17 85#define REDIS_SLOWLOG_LOG_SLOWER_THAN 10000
d3701d27 86#define REDIS_SLOWLOG_MAX_LEN 128
58732c23 87#define REDIS_MAX_CLIENTS 10000
31a1439b 88#define REDIS_AUTHPASS_MAX_LEN 512
169a44cb 89#define REDIS_DEFAULT_SLAVE_PRIORITY 100
8996bf77 90#define REDIS_REPL_TIMEOUT 60
91#define REDIS_REPL_PING_SLAVE_PERIOD 10
44f508f1 92#define REDIS_RUN_ID_SIZE 40
250e7f69 93#define REDIS_OPS_SEC_SAMPLES 16
44f508f1 94
f42e2f1b 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 */
11e0c4c5 99#define REDIS_INLINE_MAX_SIZE (1024*64) /* Max size of inline reads */
f42e2f1b 100#define REDIS_MBULK_BIG_ARG (1024*32)
8996bf77 101
e2641e09 102/* Hash table parameters */
103#define REDIS_HT_MINFILL 10 /* Minimal hash table fill 10% */
104
5d02b00f 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 */
b60ed6e8 113#define REDIS_CMD_NOSCRIPT 64 /* "s" flag */
114#define REDIS_CMD_RANDOM 128 /* "R" flag */
548efd91 115#define REDIS_CMD_SORT_FOR_SCRIPT 256 /* "S" flag */
5d73073f 116#define REDIS_CMD_LOADING 512 /* "l" flag */
117#define REDIS_CMD_STALE 1024 /* "t" flag */
a1b1c1ea 118#define REDIS_CMD_SKIP_MONITOR 2048 /* "M" flag */
e2641e09 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
e12b27ac 126
e2641e09 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 */
96ffb2fe 136#define REDIS_ENCODING_INTSET 6 /* Encoded as intset */
0b7f6d09 137#define REDIS_ENCODING_SKIPLIST 7 /* Encoded as skiplist */
e2641e09 138
e2641e09 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
c6ac7d03 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
e2641e09 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 */
e2641e09 177#define REDIS_DIRTY_CAS 64 /* Watched keys modified. EXEC will fail. */
5e78edb3 178#define REDIS_CLOSE_AFTER_REPLY 128 /* Close after writing entire reply. */
3bcffcbe
PN
179#define REDIS_UNBLOCKED 256 /* This client was unblocked and is stored in
180 server.unblocked_clients */
7156f43c 181#define REDIS_LUA_CLIENT 512 /* This is a non connected client used by Lua */
6856c7b4 182#define REDIS_ASKING 1024 /* Client issued the ASKING command */
7eac2a75 183#define REDIS_CLOSE_ASAP 2048 /* Close this client ASAP */
2ea41242 184#define REDIS_UNIX_SOCKET 4096 /* Client connected via Unix domain socket */
cd8788f2
PN
185
186/* Client request types */
187#define REDIS_REQ_INLINE 1
188#define REDIS_REQ_MULTIBULK 2
e2641e09 189
498dc555 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
7eac2a75 195#define REDIS_CLIENT_LIMIT_NUM_CLASSES 3
498dc555 196
e2641e09 197/* Slave replication state - slave side */
a3309139
PN
198#define REDIS_REPL_NONE 0 /* No active replication */
199#define REDIS_REPL_CONNECT 1 /* Must connect to master */
b075621f 200#define REDIS_REPL_CONNECTING 2 /* Connecting to master */
bb66fc31 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 */
e2641e09 204
890a2ed9
PN
205/* Synchronous read timeout - slave side */
206#define REDIS_REPL_SYNCIO_TIMEOUT 5
e2641e09 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
996d503d 232#define REDIS_LOG_RAW (1<<10) /* Modifier to log without timestamp */
e2641e09 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 */
2c915bcf 241#define AOF_FSYNC_NO 0
242#define AOF_FSYNC_ALWAYS 1
243#define AOF_FSYNC_EVERYSEC 2
e2641e09 244
245/* Zip structure related defaults */
ebd85e9a
PN
246#define REDIS_HASH_MAX_ZIPLIST_ENTRIES 512
247#define REDIS_HASH_MAX_ZIPLIST_VALUE 64
6a246b1e 248#define REDIS_LIST_MAX_ZIPLIST_ENTRIES 512
249#define REDIS_LIST_MAX_ZIPLIST_VALUE 64
250#define REDIS_SET_MAX_INTSET_ENTRIES 512
3ea204e1
PN
251#define REDIS_ZSET_MAX_ZIPLIST_ENTRIES 128
252#define REDIS_ZSET_MAX_ZIPLIST_VALUE 64
e2641e09 253
254/* Sets operations codes */
255#define REDIS_OP_UNION 0
256#define REDIS_OP_DIFF 1
257#define REDIS_OP_INTER 2
258
165346ca 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
5402c426 265#define REDIS_MAXMEMORY_NO_EVICTION 5
165346ca 266
eeffcf38 267/* Scripting */
8cb8d417 268#define REDIS_LUA_TIME_LIMIT 5000 /* milliseconds */
eeffcf38 269
12d293ca 270/* Units */
271#define UNIT_SECONDS 0
272#define UNIT_MILLISECONDS 1
273
4ab8695d 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
ce8b772b 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
ad08d059 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
6b5daa2d 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
e2641e09 296/* We can print the stacktrace, so our assert is defined this way: */
bab205f7 297#define redisAssertWithInfo(_c,_o,_e) ((_e)?(void)0 : (_redisAssertWithInfo(_c,_o,#_e,__FILE__,__LINE__),_exit(1)))
e2641e09 298#define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1)))
299#define redisPanic(_e) _redisPanic(#_e,__FILE__,__LINE__),_exit(1)
e2641e09 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 */
ef59a8bc 308#define REDIS_LRU_CLOCK_MAX ((1<<21)-1) /* Max value of obj->lru */
165346ca 309#define REDIS_LRU_CLOCK_RESOLUTION 10 /* LRU clock resolution in seconds */
e2641e09 310typedef struct redisObject {
311 unsigned type:4;
3be00d7e 312 unsigned notused:2; /* Not used */
e2641e09 313 unsigned encoding:4;
314 unsigned lru:22; /* lru time (relative to server.lruclock) */
315 int refcount;
316 void *ptr;
e2641e09 317} robj;
318
e2641e09 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; \
e2641e09 328} while(0);
329
330typedef 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) */
7eb850ef 334 dict *ready_keys; /* Blocked keys that received a PUSH */
e2641e09 335 dict *watched_keys; /* WATCHED keys for MULTI/EXEC CAS */
336 int id;
337} redisDb;
338
339/* Client MULTI/EXEC state */
340typedef struct multiCmd {
341 robj **argv;
342 int argc;
343 struct redisCommand *cmd;
344} multiCmd;
345
346typedef struct multiState {
347 multiCmd *commands; /* Array of MULTI commands */
348 int count; /* Total number of MULTI commands */
349} multiState;
350
357a8417
DJMM
351typedef 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
7eb850ef 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. */
372typedef struct readyList {
373 redisDb *db;
374 robj *key;
375} readyList;
376
e2641e09 377/* With multiplexing we need to take per-clinet state.
378 * Clients are taken in a liked list. */
379typedef struct redisClient {
380 int fd;
381 redisDb *db;
382 int dictid;
383 sds querybuf;
ae22bf1e 384 size_t querybuf_peak; /* Recent (100ms or more) peak of querybuf size */
cd8788f2
PN
385 int argc;
386 robj **argv;
2c74a9f9 387 struct redisCommand *cmd, *lastcmd;
cd8788f2
PN
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 */
e2641e09 391 list *reply;
3853c168 392 unsigned long reply_bytes; /* Tot bytes of objects in reply list */
e2641e09 393 int sentlen;
e74dca73 394 time_t ctime; /* Client creation time */
e2641e09 395 time_t lastinteraction; /* time of the last interaction, used for timeout */
7eac2a75 396 time_t obuf_soft_limit_reached_time;
e2641e09 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 */
3a328978 404 int slave_listening_port; /* As configured with: SLAVECONF listening-port */
e2641e09 405 multiState mstate; /* MULTI/EXEC state */
e3c51c4b 406 blockingState bpop; /* blocking state */
e2641e09 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) */
834ef78e
PN
412
413 /* Response buffer */
414 int bufpos;
f3357792 415 char buf[REDIS_REPLY_CHUNK_BYTES];
e2641e09 416} redisClient;
417
418struct saveparam {
419 time_t seconds;
420 int changes;
421};
422
423struct sharedObjectsStruct {
424 robj *crlf, *ok, *err, *emptybulk, *czero, *cone, *cnegone, *pong, *space,
425 *colon, *nullbulk, *nullmultibulk, *queued,
426 *emptymultibulk, *wrongtypeerr, *nokeyerr, *syntaxerr, *sameobjecterr,
c25e7eaf 427 *outofrangeerr, *noscripterr, *loadingerr, *slowscripterr, *bgsaveerr,
ae62d29d 428 *masterdownerr, *roslaveerr,
429 *oomerr, *plus, *messagebulk, *pmessagebulk, *subscribebulk,
f892797e 430 *unsubscribebulk, *psubscribebulk, *punsubscribebulk, *del, *rpop, *lpop,
7eb850ef 431 *lpush,
f892797e 432 *select[REDIS_SHARED_SELECT_CMDS],
355f8591 433 *integers[REDIS_SHARED_INTEGERS],
434 *mbulkhdr[REDIS_SHARED_BULKHDR_LEN], /* "*<value>\r\n" */
435 *bulkhdr[REDIS_SHARED_BULKHDR_LEN]; /* "$<value>\r\n" */
e2641e09 436};
437
c772d9c6 438/* ZSETs use a specialized version of Skiplists */
439typedef 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
449typedef struct zskiplist {
450 struct zskiplistNode *header, *tail;
451 unsigned long length;
452 int level;
453} zskiplist;
454
455typedef struct zset {
456 dict *dict;
457 zskiplist *zsl;
458} zset;
459
7eac2a75 460typedef struct clientBufferLimitsConfig {
7fe8d49a 461 unsigned long long hard_limit_bytes;
462 unsigned long long soft_limit_bytes;
7eac2a75 463 time_t soft_limit_seconds;
464} clientBufferLimitsConfig;
465
78d6a22d 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. */
472typedef struct redisOp {
eeb34eff 473 robj **argv;
474 int argc, dbid, target;
475 struct redisCommand *cmd;
78d6a22d 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 */
485typedef struct redisOpArray {
486 redisOp *ops;
487 int numops;
488} redisOpArray;
eeb34eff 489
ecc91094 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
501struct clusterNode;
502
503/* clusterLink encapsulates everything needed to talk with a remote node. */
504typedef 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
522struct 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};
537typedef struct clusterNode clusterNode;
538
539typedef struct {
ef21ab96 540 char *configfile;
ecc91094 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];
c772d9c6 548 zskiplist *slots_to_keys;
ecc91094 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 */
c563ce46 561#define CLUSTERMSG_TYPE_PUBLISH 4 /* Pub/Sub Publish propatagion */
ecc91094 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. */
566typedef 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
576typedef struct {
577 char nodename[REDIS_CLUSTER_NAMELEN];
578} clusterMsgDataFail;
579
c563ce46 580typedef 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
ecc91094 586union clusterMsgData {
587 /* PING, MEET and PONG */
588 struct {
589 /* Array of N clusterMsgDataGossip structures */
590 clusterMsgDataGossip gossip[1];
591 } ping;
c563ce46 592
ecc91094 593 /* FAIL */
594 struct {
595 clusterMsgDataFail about;
596 } fail;
c563ce46 597
598 /* PUBLISH */
599 struct {
600 clusterMsgDataPublish msg;
601 } publish;
ecc91094 602};
603
604typedef 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
e2641e09 622struct redisServer {
5b831607 623 /* General */
5b831607 624 redisDb *db;
c23c657c 625 dict *commands; /* Command table hash table */
5b831607 626 aeEventLoop *el;
c6ac7d03 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 */
75eaac5c 633 int arch_bits; /* 32 or 64 depending on sizeof(long) */
c25e7eaf 634 int cronloops; /* Number of times the cron function run */
91d664d6 635 char runid[REDIS_RUN_ID_SIZE+1]; /* ID always different at every exec. */
6b5daa2d 636 int sentinel_mode; /* True if this instance is a Sentinel. */
5b831607 637 /* Networking */
c6ac7d03 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 */
7eac2a75 646 list *clients_to_close; /* Clients to close asynchronously */
c6ac7d03 647 list *slaves, *monitors; /* List of slaves and MONITORs */
00010fa9 648 redisClient *current_client; /* Current client, only used on crash report */
e23d281e 649 char neterr[ANET_ERR_LEN]; /* Error buffer for anet.c */
650 dict *migrate_cached_sockets;/* MIGRATE cached sockets */
97e7f8ae 651 /* RDB / AOF loading information */
c6ac7d03 652 int loading; /* We are loading data from disk if true */
97e7f8ae 653 off_t loading_total_bytes;
654 off_t loading_loaded_bytes;
655 time_t loading_start_time;
4ebfc455 656 /* Fast pointers to often looked up command */
7eb850ef 657 struct redisCommand *delCommand, *multiCommand, *lpushCommand, *lpopCommand,
658 *rpopCommand;
e2641e09 659 /* Fields used only for stats */
c6ac7d03 660 time_t stat_starttime; /* Server start time */
661 long long stat_numcommands; /* Number of processed commands */
662 long long stat_numconnections; /* Number of connections received */
663 long long stat_expiredkeys; /* Number of expired keys */
664 long long stat_evictedkeys; /* Number of evicted keys (maxmemory) */
665 long long stat_keyspace_hits; /* Number of successful lookups of keys */
666 long long stat_keyspace_misses; /* Number of failed lookups of keys */
667 size_t stat_peak_memory; /* Max used memory record */
668 long long stat_fork_time; /* Time needed to perform latets fork() */
669 long long stat_rejected_conn; /* Clients rejected because of maxclients */
670 list *slowlog; /* SLOWLOG list of commands */
671 long long slowlog_entry_id; /* SLOWLOG current entry ID */
672 long long slowlog_log_slower_than; /* SLOWLOG time limit (to get logged) */
673 unsigned long slowlog_max_len; /* SLOWLOG max number of items logged */
250e7f69 674 /* The following two are used to track instantaneous "load" in terms
675 * of operations per second. */
676 long long ops_sec_last_sample_time; /* Timestamp of last sample (in ms) */
677 long long ops_sec_last_sample_ops; /* numcommands in last sample */
678 long long ops_sec_samples[REDIS_OPS_SEC_SAMPLES];
679 int ops_sec_idx;
e2641e09 680 /* Configuration */
c6ac7d03 681 int verbosity; /* Loglevel in redis.conf */
682 int maxidletime; /* Client timeout in seconds */
683 size_t client_max_querybuf_len; /* Limit for client query buffer length */
684 int dbnum; /* Total number of configured DBs */
685 int daemonize; /* True if running as a daemon */
7eac2a75 686 clientBufferLimitsConfig client_obuf_limits[REDIS_CLIENT_LIMIT_NUM_CLASSES];
c6ac7d03 687 /* AOF persistence */
688 int aof_state; /* REDIS_AOF_(ON|OFF|WAIT_REWRITE) */
2c915bcf 689 int aof_fsync; /* Kind of fsync() policy */
690 char *aof_filename; /* Name of the AOF file */
691 int aof_no_fsync_on_rewrite; /* Don't fsync if a rewrite is in prog. */
692 int aof_rewrite_perc; /* Rewrite AOF if % growth is > M and... */
693 off_t aof_rewrite_min_size; /* the AOF file is at least N bytes. */
694 off_t aof_rewrite_base_size; /* AOF size on latest startup or rewrite. */
695 off_t aof_current_size; /* AOF current size. */
696 int aof_rewrite_scheduled; /* Rewrite once BGSAVE terminates. */
ff2145ad 697 pid_t aof_child_pid; /* PID if rewriting process */
47ca4b6e 698 list *aof_rewrite_buf_blocks; /* Hold changes during an AOF rewrite. */
ff2145ad 699 sds aof_buf; /* AOF buffer, written before entering the event loop */
700 int aof_fd; /* File descriptor of currently selected AOF file */
701 int aof_selected_db; /* Currently selected DB in AOF */
c6ac7d03 702 time_t aof_flush_postponed_start; /* UNIX time of postponed AOF flush */
ff2145ad 703 time_t aof_last_fsync; /* UNIX time of last fsync() */
33e1db36 704 time_t aof_rewrite_time_last; /* Time used by last AOF rewrite run. */
705 time_t aof_rewrite_time_start; /* Current AOF rewrite start time. */
48553a29 706 int aof_lastbgrewrite_status; /* REDIS_OK or REDIS_ERR */
c1d01b3c 707 unsigned long aof_delayed_fsync; /* delayed AOF fsync() counter */
c6ac7d03 708 /* RDB persistence */
709 long long dirty; /* Changes to DB from the last save */
710 long long dirty_before_bgsave; /* Used to restore dirty on failed BGSAVE */
f48cd4b9 711 pid_t rdb_child_pid; /* PID of RDB saving child */
c6ac7d03 712 struct saveparam *saveparams; /* Save points array for RDB */
713 int saveparamslen; /* Number of saving points */
f48cd4b9 714 char *rdb_filename; /* Name of RDB file */
715 int rdb_compression; /* Use compression in RDB? */
84bcd3aa 716 int rdb_checksum; /* Use RDB checksum? */
c25e7eaf 717 time_t lastsave; /* Unix time of last save succeeede */
33e1db36 718 time_t rdb_save_time_last; /* Time used by last RDB save run. */
719 time_t rdb_save_time_start; /* Current RDB save start time. */
c25e7eaf 720 int lastbgsave_status; /* REDIS_OK or REDIS_ERR */
4d3bbf35 721 int stop_writes_on_bgsave_err; /* Don't allow writes if can't BGSAVE */
eeb34eff 722 /* Propagation of commands in AOF / replication */
78d6a22d 723 redisOpArray also_propagate; /* Additional command to propagate. */
36c17a53 724 /* Logging */
c6ac7d03 725 char *logfile; /* Path of log file */
726 int syslog_enabled; /* Is syslog enabled? */
727 char *syslog_ident; /* Syslog ident */
728 int syslog_facility; /* Syslog facility */
f4aa600b 729 /* Slave specific fields */
c6ac7d03 730 char *masterauth; /* AUTH with this password with master */
731 char *masterhost; /* Hostname of master */
732 int masterport; /* Port of master */
9edfe635 733 int repl_ping_slave_period; /* Master pings the slave every N seconds */
c6ac7d03 734 int repl_timeout; /* Timeout after N seconds of master idle */
735 redisClient *master; /* Client that is master for this slave */
736 int repl_syncio_timeout; /* Timeout for synchronous I/O calls */
1844f990 737 int repl_state; /* Replication status if the instance is a slave */
784b9308 738 off_t repl_transfer_size; /* Size of RDB to read from master during sync. */
739 off_t repl_transfer_read; /* Amount of RDB read from master during sync. */
740 off_t repl_transfer_last_fsync_off; /* Offset when we fsync-ed last time. */
c6ac7d03 741 int repl_transfer_s; /* Slave -> Master SYNC socket */
742 int repl_transfer_fd; /* Slave -> Master SYNC temp file descriptor */
743 char *repl_transfer_tmpfile; /* Slave-> master SYNC temp file name */
744 time_t repl_transfer_lastio; /* Unix time of the latest read, for timeout */
4ebfc455 745 int repl_serve_stale_data; /* Serve stale data when link is down? */
f3fd419f 746 int repl_slave_ro; /* Slave is read only? */
c6ac7d03 747 time_t repl_down_since; /* Unix time at which link with master went down */
169a44cb 748 int slave_priority; /* Reported in INFO and used by Sentinel. */
f4aa600b 749 /* Limits */
c6ac7d03 750 unsigned int maxclients; /* Max number of simultaneous clients */
751 unsigned long long maxmemory; /* Max number of memory bytes to use */
752 int maxmemory_policy; /* Policy for key evition */
753 int maxmemory_samples; /* Pricision of random sampling */
f4aa600b 754 /* Blocked clients */
c6ac7d03 755 unsigned int bpop_blocked_clients; /* Number of clients blocked by lists */
cea8c5cd 756 list *unblocked_clients; /* list of clients to unblock before next loop */
7eb850ef 757 list *ready_keys; /* List of readyList structures for BLPOP & co */
e2641e09 758 /* Sort parameters - qsort_r() is only available under BSD so we
759 * have to take this state global, in order to pass it to sortCompare() */
760 int sort_desc;
761 int sort_alpha;
762 int sort_bypattern;
c6ac7d03 763 /* Zip structure config, see redis.conf for more information */
ebd85e9a
PN
764 size_t hash_max_ziplist_entries;
765 size_t hash_max_ziplist_value;
e2641e09 766 size_t list_max_ziplist_entries;
767 size_t list_max_ziplist_value;
96ffb2fe 768 size_t set_max_intset_entries;
3ea204e1
PN
769 size_t zset_max_ziplist_entries;
770 size_t zset_max_ziplist_value;
c6ac7d03 771 time_t unixtime; /* Unix time sampled every second. */
e2641e09 772 /* Pubsub */
c6ac7d03 773 dict *pubsub_channels; /* Map channels to list of subscribed clients */
774 list *pubsub_patterns; /* A list of pubsub_patterns */
c772d9c6 775 /* Cluster */
c6ac7d03 776 int cluster_enabled; /* Is cluster enabled? */
777 clusterState cluster; /* State of the cluster */
7585836e 778 /* Scripting */
4dd444bb 779 lua_State *lua; /* The Lua interpreter. We use just one for all clients */
c6ac7d03 780 redisClient *lua_client; /* The "fake client" to query Redis from Lua */
781 redisClient *lua_caller; /* The client running EVAL right now, or NULL */
782 dict *lua_scripts; /* A dictionary of SHA1 -> Lua scripts */
783 long long lua_time_limit; /* Script timeout in seconds */
784 long long lua_time_start; /* Start time of script */
4ab8695d 785 int lua_write_dirty; /* True if a write command was called during the
786 execution of the current script. */
9f772cc2 787 int lua_random_dirty; /* True if a random command was called during the
4ab8695d 788 execution of the current script. */
115e3ff3 789 int lua_timedout; /* True if we reached the time limit for script
790 execution. */
4ab8695d 791 int lua_kill; /* Kill the script if true. */
fa5af017 792 /* Assert & bug reportign */
793 char *assert_failed;
794 char *assert_file;
795 int assert_line;
c6ac7d03 796 int bug_report_start; /* True if bug report header was already logged. */
39bd025c 797 int watchdog_period; /* Software watchdog period in ms. 0 = off */
e2641e09 798};
799
800typedef struct pubsubPattern {
801 redisClient *client;
802 robj *pattern;
803} pubsubPattern;
804
805typedef void redisCommandProc(redisClient *c);
9791f0f8 806typedef int *redisGetKeysProc(struct redisCommand *cmd, robj **argv, int argc, int *numkeys, int flags);
e2641e09 807struct redisCommand {
808 char *name;
809 redisCommandProc *proc;
810 int arity;
5d02b00f 811 char *sflags; /* Flags as string represenation, one char per flag. */
812 int flags; /* The actual flags, obtained from the 'sflags' field. */
9791f0f8 813 /* Use a function to determine keys arguments in a command line.
c9d0c362 814 * Used for Redis Cluster redirect. */
9791f0f8 815 redisGetKeysProc *getkeys_proc;
e2641e09 816 /* What keys should be loaded in background when calling this command? */
9791f0f8 817 int firstkey; /* The first argument that's a key (0 = no keys) */
818 int lastkey; /* THe last argument that's a key */
819 int keystep; /* The step between first and last key */
0d808ef2 820 long long microseconds, calls;
e2641e09 821};
822
823struct redisFunctionSym {
824 char *name;
825 unsigned long pointer;
826};
827
828typedef struct _redisSortObject {
829 robj *obj;
830 union {
831 double score;
832 robj *cmpobj;
833 } u;
834} redisSortObject;
835
836typedef struct _redisSortOperation {
837 int type;
838 robj *pattern;
839} redisSortOperation;
840
e2641e09 841/* Structure to hold list iteration abstraction. */
842typedef struct {
843 robj *subject;
844 unsigned char encoding;
845 unsigned char direction; /* Iteration direction */
846 unsigned char *zi;
847 listNode *ln;
848} listTypeIterator;
849
850/* Structure for an entry while iterating over a list. */
851typedef struct {
852 listTypeIterator *li;
853 unsigned char *zi; /* Entry in ziplist */
854 listNode *ln; /* Entry in linked list */
855} listTypeEntry;
856
96ffb2fe
PN
857/* Structure to hold set iteration abstraction. */
858typedef struct {
859 robj *subject;
860 int encoding;
861 int ii; /* intset iterator */
862 dictIterator *di;
cb72d0f1 863} setTypeIterator;
96ffb2fe 864
e2641e09 865/* Structure to hold hash iteration abstration. Note that iteration over
866 * hashes involves both fields and values. Because it is possible that
867 * not both are required, store pointers in the iterator to avoid
868 * unnecessary memory allocation for fields/values. */
869typedef struct {
ebd85e9a 870 robj *subject;
e2641e09 871 int encoding;
ebd85e9a
PN
872
873 unsigned char *fptr, *vptr;
e2641e09 874
875 dictIterator *di;
876 dictEntry *de;
877} hashTypeIterator;
878
879#define REDIS_HASH_KEY 1
880#define REDIS_HASH_VALUE 2
881
882/*-----------------------------------------------------------------------------
883 * Extern declarations
884 *----------------------------------------------------------------------------*/
885
886extern struct redisServer server;
887extern struct sharedObjectsStruct shared;
888extern dictType setDictType;
889extern dictType zsetDictType;
ecc91094 890extern dictType clusterNodesDictType;
4dd444bb 891extern dictType dbDictType;
e2641e09 892extern double R_Zero, R_PosInf, R_NegInf, R_Nan;
8af9fe84 893extern dictType hashDictType;
e2641e09 894
895/*-----------------------------------------------------------------------------
896 * Functions prototypes
897 *----------------------------------------------------------------------------*/
898
419e1cca 899/* Utils */
900long long ustime(void);
2c2b2085 901long long mstime(void);
44f508f1 902void getRandomHexChars(char *p, unsigned int len);
88c1d955 903uint64_t crc64(uint64_t crc, const unsigned char *s, uint64_t l);
2cbdab90 904void exitFromChild(int retcode);
419e1cca 905
e2641e09 906/* networking.c -- Networking and Client related operations */
907redisClient *createClient(int fd);
908void closeTimedoutClients(void);
909void freeClient(redisClient *c);
910void resetClient(redisClient *c);
911void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask);
e2641e09 912void addReply(redisClient *c, robj *obj);
b301c1fc
PN
913void *addDeferredMultiBulkLength(redisClient *c);
914void setDeferredMultiBulkLength(redisClient *c, void *node, long length);
e2641e09 915void addReplySds(redisClient *c, sds s);
916void processInputBuffer(redisClient *c);
ab17b909
PN
917void acceptTcpHandler(aeEventLoop *el, int fd, void *privdata, int mask);
918void acceptUnixHandler(aeEventLoop *el, int fd, void *privdata, int mask);
e2641e09 919void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask);
920void addReplyBulk(redisClient *c, robj *obj);
921void addReplyBulkCString(redisClient *c, char *s);
d51ebef5 922void addReplyBulkCBuffer(redisClient *c, void *p, size_t len);
923void addReplyBulkLongLong(redisClient *c, long long ll);
e2641e09 924void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask);
925void addReply(redisClient *c, robj *obj);
926void addReplySds(redisClient *c, sds s);
3ab20376
PN
927void addReplyError(redisClient *c, char *err);
928void addReplyStatus(redisClient *c, char *status);
e2641e09 929void addReplyDouble(redisClient *c, double d);
930void addReplyLongLong(redisClient *c, long long ll);
0537e7bf 931void addReplyMultiBulkLen(redisClient *c, long length);
1824e3a3 932void copyClientOutputBuffer(redisClient *dst, redisClient *src);
e2641e09 933void *dupClientReplyValue(void *o);
7a1fd61e 934void getClientsMaxBuffers(unsigned long *longest_output_list,
935 unsigned long *biggest_input_buffer);
becf5fdb 936sds getClientInfoString(redisClient *client);
45e7a1ce 937sds getAllClientsInfoString(void);
c1c9d551 938void rewriteClientCommandVector(redisClient *c, int argc, ...);
4dd444bb 939void rewriteClientCommandArgument(redisClient *c, int i, robj *newval);
3853c168 940unsigned long getClientOutputBufferMemoryUsage(redisClient *c);
7eac2a75 941void freeClientsInAsyncFreeQueue(void);
06b3dced 942void asyncCloseClientOnOutputBufferLimitReached(redisClient *c);
7fe8d49a 943int getClientLimitClassByName(char *name);
944char *getClientLimitClassName(int class);
8b7c3455 945void flushSlavesOutputBuffers(void);
179e54d2 946void disconnectSlaves(void);
e2641e09 947
3ab20376
PN
948#ifdef __GNUC__
949void addReplyErrorFormat(redisClient *c, const char *fmt, ...)
950 __attribute__((format(printf, 2, 3)));
951void addReplyStatusFormat(redisClient *c, const char *fmt, ...)
952 __attribute__((format(printf, 2, 3)));
953#else
954void addReplyErrorFormat(redisClient *c, const char *fmt, ...);
955void addReplyStatusFormat(redisClient *c, const char *fmt, ...);
956#endif
957
e2641e09 958/* List data type */
959void listTypeTryConversion(robj *subject, robj *value);
960void listTypePush(robj *subject, robj *value, int where);
961robj *listTypePop(robj *subject, int where);
962unsigned long listTypeLength(robj *subject);
3c08fdae 963listTypeIterator *listTypeInitIterator(robj *subject, long index, unsigned char direction);
e2641e09 964void listTypeReleaseIterator(listTypeIterator *li);
965int listTypeNext(listTypeIterator *li, listTypeEntry *entry);
966robj *listTypeGet(listTypeEntry *entry);
967void listTypeInsert(listTypeEntry *entry, robj *value, int where);
968int listTypeEqual(listTypeEntry *entry, robj *o);
969void listTypeDelete(listTypeEntry *entry);
970void listTypeConvert(robj *subject, int enc);
971void unblockClientWaitingData(redisClient *c);
7eb850ef 972void handleClientsBlockedOnLists(void);
e2641e09 973void popGenericCommand(redisClient *c, int where);
974
975/* MULTI/EXEC/WATCH... */
976void unwatchAllKeys(redisClient *c);
977void initClientMultiState(redisClient *c);
978void freeClientMultiState(redisClient *c);
09e2d9ee 979void queueMultiCommand(redisClient *c);
e2641e09 980void touchWatchedKey(redisDb *db, robj *key);
981void touchWatchedKeysOnFlush(int dbid);
f3fd419f 982void discardTransaction(redisClient *c);
e2641e09 983
984/* Redis object implementation */
985void decrRefCount(void *o);
986void incrRefCount(robj *o);
4dd444bb 987robj *resetRefCount(robj *obj);
e2641e09 988void freeStringObject(robj *o);
989void freeListObject(robj *o);
990void freeSetObject(robj *o);
991void freeZsetObject(robj *o);
992void freeHashObject(robj *o);
993robj *createObject(int type, void *ptr);
994robj *createStringObject(char *ptr, size_t len);
995robj *dupStringObject(robj *o);
5d081931 996int isObjectRepresentableAsLongLong(robj *o, long long *llongval);
e2641e09 997robj *tryObjectEncoding(robj *o);
998robj *getDecodedObject(robj *o);
999size_t stringObjectLen(robj *o);
e2641e09 1000robj *createStringObjectFromLongLong(long long value);
5574b53e 1001robj *createStringObjectFromLongDouble(long double value);
e2641e09 1002robj *createListObject(void);
1003robj *createZiplistObject(void);
1004robj *createSetObject(void);
96ffb2fe 1005robj *createIntsetObject(void);
e2641e09 1006robj *createHashObject(void);
1007robj *createZsetObject(void);
9e7cee0e 1008robj *createZsetZiplistObject(void);
e2641e09 1009int getLongFromObjectOrReply(redisClient *c, robj *o, long *target, const char *msg);
1010int checkType(redisClient *c, robj *o, int type);
1011int getLongLongFromObjectOrReply(redisClient *c, robj *o, long long *target, const char *msg);
1012int getDoubleFromObjectOrReply(redisClient *c, robj *o, double *target, const char *msg);
1013int getLongLongFromObject(robj *o, long long *target);
5574b53e 1014int getLongDoubleFromObject(robj *o, long double *target);
1015int getLongDoubleFromObjectOrReply(redisClient *c, robj *o, long double *target, const char *msg);
e2641e09 1016char *strEncoding(int encoding);
1017int compareStringObjects(robj *a, robj *b);
1018int equalStringObjects(robj *a, robj *b);
ef59a8bc 1019unsigned long estimateObjectIdleTime(robj *o);
e2641e09 1020
19e61097 1021/* Synchronous I/O with timeout */
04d360fd 1022ssize_t syncWrite(int fd, char *ptr, ssize_t size, long long timeout);
1023ssize_t syncRead(int fd, char *ptr, ssize_t size, long long timeout);
1024ssize_t syncReadLine(int fd, char *ptr, ssize_t size, long long timeout);
19e61097 1025
e2641e09 1026/* Replication */
1027void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc);
e31b615e 1028void replicationFeedMonitors(redisClient *c, list *monitors, int dictid, robj **argv, int argc);
e2641e09 1029void updateSlavesWaitingBgsave(int bgsaveerr);
f4aa600b 1030void replicationCron(void);
e2641e09 1031
97e7f8ae 1032/* Generic persistence functions */
1033void startLoading(FILE *fp);
1034void loadingProgress(off_t pos);
1035void stopLoading(void);
1036
e2641e09 1037/* RDB persistence */
2e4b0e77 1038#include "rdb.h"
e2641e09 1039
1040/* AOF persistence */
a3fcd6bc 1041void flushAppendOnlyFile(int force);
e2641e09 1042void feedAppendOnlyFile(struct redisCommand *cmd, int dictid, robj **argv, int argc);
1043void aofRemoveTempFile(pid_t childpid);
1044int rewriteAppendOnlyFileBackground(void);
1045int loadAppendOnlyFile(char *filename);
1046void stopAppendOnly(void);
1047int startAppendOnly(void);
36c17a53 1048void backgroundRewriteDoneHandler(int exitcode, int bysignal);
47ca4b6e 1049void aofRewriteBufferReset(void);
1050unsigned long aofRewriteBufferSize(void);
e2641e09 1051
1052/* Sorted sets data type */
c772d9c6 1053
1054/* Struct to hold a inclusive/exclusive range spec. */
1055typedef struct {
1056 double min, max;
1057 int minex, maxex; /* are min or max exclusive? */
1058} zrangespec;
1059
e2641e09 1060zskiplist *zslCreate(void);
1061void zslFree(zskiplist *zsl);
69ef89f2 1062zskiplistNode *zslInsert(zskiplist *zsl, double score, robj *obj);
8588bfa3 1063unsigned char *zzlInsert(unsigned char *zl, robj *ele, double score);
c772d9c6 1064int zslDelete(zskiplist *zsl, double score, robj *obj);
1065zskiplistNode *zslFirstInRange(zskiplist *zsl, zrangespec range);
dddf5335
PN
1066double zzlGetScore(unsigned char *sptr);
1067void zzlNext(unsigned char *zl, unsigned char **eptr, unsigned char **sptr);
1068void zzlPrev(unsigned char *zl, unsigned char **eptr, unsigned char **sptr);
df26a0ae
PN
1069unsigned int zsetLength(robj *zobj);
1070void zsetConvert(robj *zobj, int encoding);
e2641e09 1071
1072/* Core functions */
f6b32c14 1073int freeMemoryIfNeeded(void);
e2641e09 1074int processCommand(redisClient *c);
633a9410 1075void setupSignalHandlers(void);
1b1f47c9 1076struct redisCommand *lookupCommand(sds name);
1077struct redisCommand *lookupCommandByCString(char *s);
ce8b772b 1078void call(redisClient *c, int flags);
d8b1228b 1079void propagate(struct redisCommand *cmd, int dbid, robj **argv, int argc, int flags);
eeb34eff 1080void alsoPropagate(struct redisCommand *cmd, int dbid, robj **argv, int argc, int target);
e2641e09 1081int prepareForShutdown();
1082void redisLog(int level, const char *fmt, ...);
288f811f 1083void redisLogRaw(int level, const char *msg);
a7d12cba 1084void redisLogFromHandler(int level, const char *msg);
e2641e09 1085void usage();
1086void updateDictResizePolicy(void);
1087int htNeedsResize(dict *dict);
1088void oom(const char *msg);
1b1f47c9 1089void populateCommandTable(void);
d7ed7fd2 1090void resetCommandTableStats(void);
e2641e09 1091
96ffb2fe
PN
1092/* Set data type */
1093robj *setTypeCreate(robj *value);
1094int setTypeAdd(robj *subject, robj *value);
1095int setTypeRemove(robj *subject, robj *value);
1096int setTypeIsMember(robj *subject, robj *value);
cb72d0f1
PN
1097setTypeIterator *setTypeInitIterator(robj *subject);
1098void setTypeReleaseIterator(setTypeIterator *si);
1b508da7 1099int setTypeNext(setTypeIterator *si, robj **objele, int64_t *llele);
1100robj *setTypeNextObject(setTypeIterator *si);
dd48de74 1101int setTypeRandomElement(robj *setobj, robj **objele, int64_t *llele);
96ffb2fe
PN
1102unsigned long setTypeSize(robj *subject);
1103void setTypeConvert(robj *subject, int enc);
1104
e2641e09 1105/* Hash data type */
ebd85e9a 1106void hashTypeConvert(robj *o, int enc);
e2641e09 1107void hashTypeTryConversion(robj *subject, robj **argv, int start, int end);
1108void hashTypeTryObjectEncoding(robj *subject, robj **o1, robj **o2);
3d24304f 1109robj *hashTypeGetObject(robj *o, robj *key);
e2641e09 1110int hashTypeExists(robj *o, robj *key);
1111int hashTypeSet(robj *o, robj *key, robj *value);
1112int hashTypeDelete(robj *o, robj *key);
1113unsigned long hashTypeLength(robj *o);
1114hashTypeIterator *hashTypeInitIterator(robj *subject);
1115void hashTypeReleaseIterator(hashTypeIterator *hi);
1116int hashTypeNext(hashTypeIterator *hi);
ebd85e9a
PN
1117void hashTypeCurrentFromZiplist(hashTypeIterator *hi, int what,
1118 unsigned char **vstr,
1119 unsigned int *vlen,
1120 long long *vll);
1121void hashTypeCurrentFromHashTable(hashTypeIterator *hi, int what, robj **dst);
8c304be3 1122robj *hashTypeCurrentObject(hashTypeIterator *hi, int what);
e2641e09 1123robj *hashTypeLookupWriteOrCreate(redisClient *c, robj *key);
1124
1125/* Pub / Sub */
1126int pubsubUnsubscribeAllChannels(redisClient *c, int notify);
1127int pubsubUnsubscribeAllPatterns(redisClient *c, int notify);
1128void freePubsubPattern(void *p);
1129int listMatchPubsubPattern(void *a, void *b);
d38ef520 1130int pubsubPublishMessage(robj *channel, robj *message);
e2641e09 1131
e2641e09 1132/* Configuration */
67c6f0f6 1133void loadServerConfig(char *filename, char *options);
e2641e09 1134void appendServerSaveParams(time_t seconds, int changes);
1135void resetServerSaveParams();
1136
1137/* db.c -- Keyspace access API */
1138int removeExpire(redisDb *db, robj *key);
bcf2995c 1139void propagateExpire(redisDb *db, robj *key);
e2641e09 1140int expireIfNeeded(redisDb *db, robj *key);
7dcc10b6 1141long long getExpire(redisDb *db, robj *key);
1142void setExpire(redisDb *db, robj *key, long long when);
e2641e09 1143robj *lookupKey(redisDb *db, robj *key);
1144robj *lookupKeyRead(redisDb *db, robj *key);
1145robj *lookupKeyWrite(redisDb *db, robj *key);
1146robj *lookupKeyReadOrReply(redisClient *c, robj *key, robj *reply);
1147robj *lookupKeyWriteOrReply(redisClient *c, robj *key, robj *reply);
f85cd526 1148void dbAdd(redisDb *db, robj *key, robj *val);
1149void dbOverwrite(redisDb *db, robj *key, robj *val);
1150void setKey(redisDb *db, robj *key, robj *val);
e2641e09 1151int dbExists(redisDb *db, robj *key);
1152robj *dbRandomKey(redisDb *db);
1153int dbDelete(redisDb *db, robj *key);
1154long long emptyDb();
1155int selectDb(redisClient *c, int id);
cea8c5cd 1156void signalModifiedKey(redisDb *db, robj *key);
1157void signalFlushedDb(int dbid);
484354ff 1158unsigned int GetKeysInSlot(unsigned int hashslot, robj **keys, unsigned int count);
e2641e09 1159
9791f0f8 1160/* API to get key arguments from commands */
1161#define REDIS_GETKEYS_ALL 0
1162#define REDIS_GETKEYS_PRELOAD 1
1163int *getKeysFromCommand(struct redisCommand *cmd, robj **argv, int argc, int *numkeys, int flags);
1164void getKeysFreeResult(int *result);
1165int *noPreloadGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags);
1166int *renameGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags);
1167int *zunionInterGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags);
1168
ecc91094 1169/* Cluster */
1170void clusterInit(void);
1171unsigned short crc16(const char *buf, int len);
1172unsigned int keyHashSlot(char *key, int keylen);
1173clusterNode *createClusterNode(char *nodename, int flags);
1174int clusterAddNode(clusterNode *node);
1175void clusterCron(void);
eda827f8 1176clusterNode *getNodeByQuery(redisClient *c, struct redisCommand *cmd, robj **argv, int argc, int *hashslot, int *ask);
c563ce46 1177void clusterPropagatePublish(robj *channel, robj *message);
e23d281e 1178void migrateCloseTimedoutSockets(void);
ecc91094 1179
6b5daa2d 1180/* Sentinel */
1181void initSentinelConfig(void);
1182void initSentinel(void);
1183void sentinelTimer(void);
1184char *sentinelHandleConfiguration(char **argv, int argc);
1185
7585836e 1186/* Scripting */
1187void scriptingInit(void);
1188
e2641e09 1189/* Git SHA1 */
1190char *redisGitSHA1(void);
1191char *redisGitDirty(void);
1192
1193/* Commands prototypes */
1194void authCommand(redisClient *c);
1195void pingCommand(redisClient *c);
1196void echoCommand(redisClient *c);
1197void setCommand(redisClient *c);
1198void setnxCommand(redisClient *c);
1199void setexCommand(redisClient *c);
12d293ca 1200void psetexCommand(redisClient *c);
e2641e09 1201void getCommand(redisClient *c);
1202void delCommand(redisClient *c);
1203void existsCommand(redisClient *c);
3c1bf495
PN
1204void setbitCommand(redisClient *c);
1205void getbitCommand(redisClient *c);
9f9e1cea 1206void setrangeCommand(redisClient *c);
ef11bccc 1207void getrangeCommand(redisClient *c);
e2641e09 1208void incrCommand(redisClient *c);
1209void decrCommand(redisClient *c);
1210void incrbyCommand(redisClient *c);
1211void decrbyCommand(redisClient *c);
5574b53e 1212void incrbyfloatCommand(redisClient *c);
e2641e09 1213void selectCommand(redisClient *c);
1214void randomkeyCommand(redisClient *c);
1215void keysCommand(redisClient *c);
1216void dbsizeCommand(redisClient *c);
1217void lastsaveCommand(redisClient *c);
1218void saveCommand(redisClient *c);
1219void bgsaveCommand(redisClient *c);
1220void bgrewriteaofCommand(redisClient *c);
1221void shutdownCommand(redisClient *c);
1222void moveCommand(redisClient *c);
1223void renameCommand(redisClient *c);
1224void renamenxCommand(redisClient *c);
1225void lpushCommand(redisClient *c);
1226void rpushCommand(redisClient *c);
1227void lpushxCommand(redisClient *c);
1228void rpushxCommand(redisClient *c);
1229void linsertCommand(redisClient *c);
1230void lpopCommand(redisClient *c);
1231void rpopCommand(redisClient *c);
1232void llenCommand(redisClient *c);
1233void lindexCommand(redisClient *c);
1234void lrangeCommand(redisClient *c);
1235void ltrimCommand(redisClient *c);
1236void typeCommand(redisClient *c);
1237void lsetCommand(redisClient *c);
1238void saddCommand(redisClient *c);
1239void sremCommand(redisClient *c);
1240void smoveCommand(redisClient *c);
1241void sismemberCommand(redisClient *c);
1242void scardCommand(redisClient *c);
1243void spopCommand(redisClient *c);
1244void srandmemberCommand(redisClient *c);
1245void sinterCommand(redisClient *c);
1246void sinterstoreCommand(redisClient *c);
1247void sunionCommand(redisClient *c);
1248void sunionstoreCommand(redisClient *c);
1249void sdiffCommand(redisClient *c);
1250void sdiffstoreCommand(redisClient *c);
1251void syncCommand(redisClient *c);
1252void flushdbCommand(redisClient *c);
1253void flushallCommand(redisClient *c);
1254void sortCommand(redisClient *c);
1255void lremCommand(redisClient *c);
8a979f03 1256void rpoplpushCommand(redisClient *c);
e2641e09 1257void infoCommand(redisClient *c);
1258void mgetCommand(redisClient *c);
1259void monitorCommand(redisClient *c);
1260void expireCommand(redisClient *c);
1261void expireatCommand(redisClient *c);
12d293ca 1262void pexpireCommand(redisClient *c);
1263void pexpireatCommand(redisClient *c);
e2641e09 1264void getsetCommand(redisClient *c);
1265void ttlCommand(redisClient *c);
12d293ca 1266void pttlCommand(redisClient *c);
a539d29a 1267void persistCommand(redisClient *c);
e2641e09 1268void slaveofCommand(redisClient *c);
1269void debugCommand(redisClient *c);
1270void msetCommand(redisClient *c);
1271void msetnxCommand(redisClient *c);
1272void zaddCommand(redisClient *c);
1273void zincrbyCommand(redisClient *c);
1274void zrangeCommand(redisClient *c);
1275void zrangebyscoreCommand(redisClient *c);
25bb8a44 1276void zrevrangebyscoreCommand(redisClient *c);
e2641e09 1277void zcountCommand(redisClient *c);
1278void zrevrangeCommand(redisClient *c);
1279void zcardCommand(redisClient *c);
1280void zremCommand(redisClient *c);
1281void zscoreCommand(redisClient *c);
1282void zremrangebyscoreCommand(redisClient *c);
1283void multiCommand(redisClient *c);
1284void execCommand(redisClient *c);
1285void discardCommand(redisClient *c);
1286void blpopCommand(redisClient *c);
1287void brpopCommand(redisClient *c);
b2a7fd0c 1288void brpoplpushCommand(redisClient *c);
e2641e09 1289void appendCommand(redisClient *c);
80091bba 1290void strlenCommand(redisClient *c);
e2641e09 1291void zrankCommand(redisClient *c);
1292void zrevrankCommand(redisClient *c);
1293void hsetCommand(redisClient *c);
1294void hsetnxCommand(redisClient *c);
1295void hgetCommand(redisClient *c);
1296void hmsetCommand(redisClient *c);
1297void hmgetCommand(redisClient *c);
1298void hdelCommand(redisClient *c);
1299void hlenCommand(redisClient *c);
1300void zremrangebyrankCommand(redisClient *c);
1301void zunionstoreCommand(redisClient *c);
1302void zinterstoreCommand(redisClient *c);
1303void hkeysCommand(redisClient *c);
1304void hvalsCommand(redisClient *c);
1305void hgetallCommand(redisClient *c);
1306void hexistsCommand(redisClient *c);
1307void configCommand(redisClient *c);
1308void hincrbyCommand(redisClient *c);
68bfe993 1309void hincrbyfloatCommand(redisClient *c);
e2641e09 1310void subscribeCommand(redisClient *c);
1311void unsubscribeCommand(redisClient *c);
1312void psubscribeCommand(redisClient *c);
1313void punsubscribeCommand(redisClient *c);
1314void publishCommand(redisClient *c);
1315void watchCommand(redisClient *c);
1316void unwatchCommand(redisClient *c);
ecc91094 1317void clusterCommand(redisClient *c);
1318void restoreCommand(redisClient *c);
1319void migrateCommand(redisClient *c);
6856c7b4 1320void askingCommand(redisClient *c);
626f6b2d 1321void dumpCommand(redisClient *c);
ece74202 1322void objectCommand(redisClient *c);
3cd12b56 1323void clientCommand(redisClient *c);
7585836e 1324void evalCommand(redisClient *c);
7229d60d 1325void evalShaCommand(redisClient *c);
070e3945 1326void scriptCommand(redisClient *c);
9494f1f1 1327void timeCommand(redisClient *c);
0bd6d68e 1328void bitopCommand(redisClient *c);
1329void bitcountCommand(redisClient *c);
3a328978 1330void replconfCommand(redisClient *c);
e2641e09 1331
b3aa6d71 1332#if defined(__GNUC__)
b3aa6d71 1333void *calloc(size_t count, size_t size) __attribute__ ((deprecated));
1334void free(void *ptr) __attribute__ ((deprecated));
1335void *malloc(size_t size) __attribute__ ((deprecated));
1336void *realloc(void *ptr, size_t size) __attribute__ ((deprecated));
1337#endif
1338
e3e69935 1339/* Debugging stuff */
bab205f7 1340void _redisAssertWithInfo(redisClient *c, robj *o, char *estr, char *file, int line);
e3e69935 1341void _redisAssert(char *estr, char *file, int line);
1342void _redisPanic(char *msg, char *file, int line);
fa5af017 1343void bugReportStart(void);
00010fa9 1344void redisLogObjectDebugInfo(robj *o);
d4d20859 1345void sigsegvHandler(int sig, siginfo_t *info, void *secret);
1346sds genRedisInfoString(char *section);
39bd025c 1347void enableWatchdog(int period);
1348void disableWatchdog(void);
1349void watchdogScheduleSignal(int period);
ee789e15 1350void redisLogHexDump(int level, char *descr, void *value, size_t len);
6b5daa2d 1351
1352#define redisDebug(fmt, ...) \
1353 printf("DEBUG %s:%d > " fmt "\n", __FILE__, __LINE__, __VA_ARGS__)
1354#define redisDebugMark() \
1355 printf("-- MARK %s:%d --\n", __FILE__, __LINE__)
1356
e2641e09 1357#endif