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