]> git.saurik.com Git - redis.git/blame - src/redis.h
negative caching implemented
[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>
e2641e09 21
22#include "ae.h" /* Event driven programming library */
23#include "sds.h" /* Dynamic safe strings */
24#include "dict.h" /* Hash tables */
25#include "adlist.h" /* Linked lists */
26#include "zmalloc.h" /* total memory usage aware version of malloc/free */
27#include "anet.h" /* Networking the easy way */
28#include "zipmap.h" /* Compact string -> string data structure */
29#include "ziplist.h" /* Compact list data structure */
96ffb2fe 30#include "intset.h" /* Compact integer set structure */
e2641e09 31#include "version.h"
32
33/* Error codes */
34#define REDIS_OK 0
35#define REDIS_ERR -1
36
37/* Static server configuration */
38#define REDIS_SERVERPORT 6379 /* TCP port */
39#define REDIS_MAXIDLETIME (60*5) /* default client timeout */
40#define REDIS_IOBUF_LEN 1024
41#define REDIS_LOADBUF_LEN 1024
42#define REDIS_STATIC_ARGS 8
43#define REDIS_DEFAULT_DBNUM 16
44#define REDIS_CONFIGLINE_MAX 1024
e2641e09 45#define REDIS_MAX_SYNC_TIME 60 /* Slave can't take more to sync */
46#define REDIS_EXPIRELOOKUPS_PER_CRON 10 /* lookup 10 expires per loop */
47#define REDIS_MAX_WRITE_PER_EVENT (1024*64)
48#define REDIS_REQUEST_MAX_SIZE (1024*1024*256) /* max bytes in inline command */
49#define REDIS_SHARED_INTEGERS 10000
36c19d03 50#define REDIS_REPLY_CHUNK_BYTES (5*1500) /* 5 TCP packets with default MTU */
e1a586ee 51#define REDIS_MAX_LOGMSG_LEN 1024 /* Default maximum length of syslog messages */
834ef78e 52
e2641e09 53/* If more then REDIS_WRITEV_THRESHOLD write packets are pending use writev */
54#define REDIS_WRITEV_THRESHOLD 3
55/* Max number of iovecs used for each writev call */
56#define REDIS_WRITEV_IOVEC_COUNT 256
57
58/* Hash table parameters */
59#define REDIS_HT_MINFILL 10 /* Minimal hash table fill 10% */
60
33aba595
PN
61/* Command flags:
62 * REDIS_CMD_DENYOOM:
63 * Commands marked with this flag will return an error when 'maxmemory' is
64 * set and the server is using more than 'maxmemory' bytes of memory.
65 * In short: commands with this flag are denied on low memory conditions.
66 * REDIS_CMD_FORCE_REPLICATION:
67 * Force replication even if dirty is 0. */
68#define REDIS_CMD_DENYOOM 4
69#define REDIS_CMD_FORCE_REPLICATION 8
e2641e09 70
71/* Object types */
72#define REDIS_STRING 0
73#define REDIS_LIST 1
74#define REDIS_SET 2
75#define REDIS_ZSET 3
76#define REDIS_HASH 4
77#define REDIS_VMPOINTER 8
78
79/* Objects encoding. Some kind of objects like Strings and Hashes can be
80 * internally represented in multiple ways. The 'encoding' field of the object
81 * is set to one of this fields for this object. */
82#define REDIS_ENCODING_RAW 0 /* Raw representation */
83#define REDIS_ENCODING_INT 1 /* Encoded as integer */
84#define REDIS_ENCODING_HT 2 /* Encoded as hash table */
85#define REDIS_ENCODING_ZIPMAP 3 /* Encoded as zipmap */
86#define REDIS_ENCODING_LINKEDLIST 4 /* Encoded as regular linked list */
87#define REDIS_ENCODING_ZIPLIST 5 /* Encoded as ziplist */
96ffb2fe 88#define REDIS_ENCODING_INTSET 6 /* Encoded as intset */
e2641e09 89
90/* Object types only used for dumping to disk */
91#define REDIS_EXPIRETIME 253
92#define REDIS_SELECTDB 254
93#define REDIS_EOF 255
94
95/* Defines related to the dump file format. To store 32 bits lengths for short
96 * keys requires a lot of space, so we check the most significant 2 bits of
97 * the first byte to interpreter the length:
98 *
99 * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
100 * 01|000000 00000000 => 01, the len is 14 byes, 6 bits + 8 bits of next byte
101 * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
102 * 11|000000 this means: specially encoded object will follow. The six bits
103 * number specify the kind of object that follows.
104 * See the REDIS_RDB_ENC_* defines.
105 *
106 * Lenghts up to 63 are stored using a single byte, most DB keys, and may
107 * values, will fit inside. */
108#define REDIS_RDB_6BITLEN 0
109#define REDIS_RDB_14BITLEN 1
110#define REDIS_RDB_32BITLEN 2
111#define REDIS_RDB_ENCVAL 3
112#define REDIS_RDB_LENERR UINT_MAX
113
114/* When a length of a string object stored on disk has the first two bits
115 * set, the remaining two bits specify a special encoding for the object
116 * accordingly to the following defines: */
117#define REDIS_RDB_ENC_INT8 0 /* 8 bit signed integer */
118#define REDIS_RDB_ENC_INT16 1 /* 16 bit signed integer */
119#define REDIS_RDB_ENC_INT32 2 /* 32 bit signed integer */
120#define REDIS_RDB_ENC_LZF 3 /* string compressed with FASTLZ */
121
16d77878 122/* Disk store cache object->storage values */
123#define REDIS_DS_MEMORY 0 /* The object is on memory */
124#define REDIS_DS_DIRTY 1 /* The object was modified */
125#define REDIS_DS_SAVING 2 /* There is an IO Job created for this obj. */
126
e2641e09 127#define REDIS_MAX_COMPLETED_JOBS_PROCESSED 1
f34a6cd8 128#define REDIS_THREAD_STACK_SIZE (1024*1024*4)
e2641e09 129
130/* Client flags */
131#define REDIS_SLAVE 1 /* This client is a slave server */
132#define REDIS_MASTER 2 /* This client is a master server */
133#define REDIS_MONITOR 4 /* This client is a slave monitor, see MONITOR */
134#define REDIS_MULTI 8 /* This client is in a MULTI context */
135#define REDIS_BLOCKED 16 /* The client is waiting in a blocking operation */
136#define REDIS_IO_WAIT 32 /* The client is waiting for Virtual Memory I/O */
137#define REDIS_DIRTY_CAS 64 /* Watched keys modified. EXEC will fail. */
5e78edb3 138#define REDIS_CLOSE_AFTER_REPLY 128 /* Close after writing entire reply. */
cd8788f2
PN
139
140/* Client request types */
141#define REDIS_REQ_INLINE 1
142#define REDIS_REQ_MULTIBULK 2
e2641e09 143
144/* Slave replication state - slave side */
145#define REDIS_REPL_NONE 0 /* No active replication */
146#define REDIS_REPL_CONNECT 1 /* Must connect to master */
62ec599c 147#define REDIS_REPL_TRANSFER 2 /* Receiving .rdb from master */
f4aa600b 148#define REDIS_REPL_CONNECTED 3 /* Connected to master */
e2641e09 149
150/* Slave replication state - from the point of view of master
151 * Note that in SEND_BULK and ONLINE state the slave receives new updates
152 * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
153 * to start the next background saving in order to send updates to it. */
154#define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
155#define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
156#define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
157#define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */
158
159/* List related stuff */
160#define REDIS_HEAD 0
161#define REDIS_TAIL 1
162
163/* Sort operations */
164#define REDIS_SORT_GET 0
165#define REDIS_SORT_ASC 1
166#define REDIS_SORT_DESC 2
167#define REDIS_SORTKEY_MAX 1024
168
169/* Log levels */
170#define REDIS_DEBUG 0
171#define REDIS_VERBOSE 1
172#define REDIS_NOTICE 2
173#define REDIS_WARNING 3
174
175/* Anti-warning macro... */
176#define REDIS_NOTUSED(V) ((void) V)
177
178#define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
179#define ZSKIPLIST_P 0.25 /* Skiplist P = 1/4 */
180
181/* Append only defines */
182#define APPENDFSYNC_NO 0
183#define APPENDFSYNC_ALWAYS 1
184#define APPENDFSYNC_EVERYSEC 2
185
186/* Zip structure related defaults */
187#define REDIS_HASH_MAX_ZIPMAP_ENTRIES 64
188#define REDIS_HASH_MAX_ZIPMAP_VALUE 512
6a246b1e 189#define REDIS_LIST_MAX_ZIPLIST_ENTRIES 512
190#define REDIS_LIST_MAX_ZIPLIST_VALUE 64
191#define REDIS_SET_MAX_INTSET_ENTRIES 512
e2641e09 192
193/* Sets operations codes */
194#define REDIS_OP_UNION 0
195#define REDIS_OP_DIFF 1
196#define REDIS_OP_INTER 2
197
165346ca 198/* Redis maxmemory strategies */
199#define REDIS_MAXMEMORY_VOLATILE_LRU 0
200#define REDIS_MAXMEMORY_VOLATILE_TTL 1
201#define REDIS_MAXMEMORY_VOLATILE_RANDOM 2
202#define REDIS_MAXMEMORY_ALLKEYS_LRU 3
203#define REDIS_MAXMEMORY_ALLKEYS_RANDOM 4
5402c426 204#define REDIS_MAXMEMORY_NO_EVICTION 5
165346ca 205
e2641e09 206/* We can print the stacktrace, so our assert is defined this way: */
207#define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1)))
208#define redisPanic(_e) _redisPanic(#_e,__FILE__,__LINE__),_exit(1)
209void _redisAssert(char *estr, char *file, int line);
210void _redisPanic(char *msg, char *file, int line);
211
212/*-----------------------------------------------------------------------------
213 * Data types
214 *----------------------------------------------------------------------------*/
215
216/* A redis object, that is a type able to hold a string / list / set */
217
218/* The actual Redis Object */
ef59a8bc 219#define REDIS_LRU_CLOCK_MAX ((1<<21)-1) /* Max value of obj->lru */
165346ca 220#define REDIS_LRU_CLOCK_RESOLUTION 10 /* LRU clock resolution in seconds */
e2641e09 221typedef struct redisObject {
222 unsigned type:4;
223 unsigned storage:2; /* REDIS_VM_MEMORY or REDIS_VM_SWAPPING */
224 unsigned encoding:4;
225 unsigned lru:22; /* lru time (relative to server.lruclock) */
226 int refcount;
227 void *ptr;
228 /* VM fields are only allocated if VM is active, otherwise the
229 * object allocation function will just allocate
230 * sizeof(redisObjct) minus sizeof(redisObjectVM), so using
231 * Redis without VM active will not have any overhead. */
232} robj;
233
234/* The VM pointer structure - identifies an object in the swap file.
235 *
236 * This object is stored in place of the value
237 * object in the main key->value hash table representing a database.
238 * Note that the first fields (type, storage) are the same as the redisObject
239 * structure so that vmPointer strucuters can be accessed even when casted
240 * as redisObject structures.
241 *
242 * This is useful as we don't know if a value object is or not on disk, but we
243 * are always able to read obj->storage to check this. For vmPointer
244 * structures "type" is set to REDIS_VMPOINTER (even if without this field
245 * is still possible to check the kind of object from the value of 'storage').*/
246typedef struct vmPointer {
247 unsigned type:4;
248 unsigned storage:2; /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
249 unsigned notused:26;
250 unsigned int vtype; /* type of the object stored in the swap file */
251 off_t page; /* the page at witch the object is stored on disk */
252 off_t usedpages; /* number of pages used on disk */
253} vmpointer;
254
255/* Macro used to initalize a Redis object allocated on the stack.
256 * Note that this macro is taken near the structure definition to make sure
257 * we'll update it when the structure is changed, to avoid bugs like
258 * bug #85 introduced exactly in this way. */
259#define initStaticStringObject(_var,_ptr) do { \
260 _var.refcount = 1; \
261 _var.type = REDIS_STRING; \
262 _var.encoding = REDIS_ENCODING_RAW; \
263 _var.ptr = _ptr; \
16d77878 264 _var.storage = REDIS_DS_MEMORY; \
e2641e09 265} while(0);
266
267typedef struct redisDb {
268 dict *dict; /* The keyspace for this DB */
269 dict *expires; /* Timeout of keys with a timeout set */
270 dict *blocking_keys; /* Keys with clients waiting for data (BLPOP) */
271 dict *io_keys; /* Keys with clients waiting for VM I/O */
d934e1e8 272 dict *io_negcache; /* Negative caching for disk store */
e2641e09 273 dict *watched_keys; /* WATCHED keys for MULTI/EXEC CAS */
274 int id;
275} redisDb;
276
277/* Client MULTI/EXEC state */
278typedef struct multiCmd {
279 robj **argv;
280 int argc;
281 struct redisCommand *cmd;
282} multiCmd;
283
284typedef struct multiState {
285 multiCmd *commands; /* Array of MULTI commands */
286 int count; /* Total number of MULTI commands */
287} multiState;
288
357a8417
DJMM
289typedef struct blockingState {
290 robj **keys; /* The key we are waiting to terminate a blocking
291 * operation such as BLPOP. Otherwise NULL. */
292 int count; /* Number of blocking keys */
293 time_t timeout; /* Blocking operation timeout. If UNIX current time
294 * is >= timeout then the operation timed out. */
295 robj *target; /* The key that should receive the element,
296 * for BRPOPLPUSH. */
297} blockingState;
298
e2641e09 299/* With multiplexing we need to take per-clinet state.
300 * Clients are taken in a liked list. */
301typedef struct redisClient {
302 int fd;
303 redisDb *db;
304 int dictid;
305 sds querybuf;
cd8788f2
PN
306 int argc;
307 robj **argv;
308 int reqtype;
309 int multibulklen; /* number of multi bulk arguments left to read */
310 long bulklen; /* length of bulk argument in multi bulk request */
e2641e09 311 list *reply;
312 int sentlen;
313 time_t lastinteraction; /* time of the last interaction, used for timeout */
314 int flags; /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
315 int slaveseldb; /* slave selected db, if this client is a slave */
316 int authenticated; /* when requirepass is non-NULL */
317 int replstate; /* replication state if this is a slave */
318 int repldbfd; /* replication DB file descriptor */
319 long repldboff; /* replication DB file offset */
320 off_t repldbsize; /* replication DB file size */
321 multiState mstate; /* MULTI/EXEC state */
e3c51c4b 322 blockingState bpop; /* blocking state */
e2641e09 323 list *io_keys; /* Keys this client is waiting to be loaded from the
324 * swap file in order to continue. */
325 list *watched_keys; /* Keys WATCHED for MULTI/EXEC CAS */
326 dict *pubsub_channels; /* channels a client is interested in (SUBSCRIBE) */
327 list *pubsub_patterns; /* patterns a client is interested in (SUBSCRIBE) */
834ef78e
PN
328
329 /* Response buffer */
330 int bufpos;
f3357792 331 char buf[REDIS_REPLY_CHUNK_BYTES];
e2641e09 332} redisClient;
333
334struct saveparam {
335 time_t seconds;
336 int changes;
337};
338
339struct sharedObjectsStruct {
340 robj *crlf, *ok, *err, *emptybulk, *czero, *cone, *cnegone, *pong, *space,
341 *colon, *nullbulk, *nullmultibulk, *queued,
342 *emptymultibulk, *wrongtypeerr, *nokeyerr, *syntaxerr, *sameobjecterr,
97e7f8ae 343 *outofrangeerr, *loadingerr, *plus,
e2641e09 344 *select0, *select1, *select2, *select3, *select4,
345 *select5, *select6, *select7, *select8, *select9,
346 *messagebulk, *pmessagebulk, *subscribebulk, *unsubscribebulk, *mbulk3,
347 *mbulk4, *psubscribebulk, *punsubscribebulk,
348 *integers[REDIS_SHARED_INTEGERS];
349};
350
351/* Global server state structure */
352struct redisServer {
0e5441d8 353 pthread_t mainthread;
e2641e09 354 int port;
a5639e7d 355 char *bindaddr;
5d10923f 356 char *unixsocket;
a5639e7d
PN
357 int ipfd;
358 int sofd;
e2641e09 359 redisDb *db;
360 long long dirty; /* changes to DB from the last save */
2f6b31c3 361 long long dirty_before_bgsave; /* used to restore dirty on failed BGSAVE */
e2641e09 362 list *clients;
1b1f47c9 363 dict *commands; /* Command table hahs table */
97e7f8ae 364 /* RDB / AOF loading information */
365 int loading;
366 off_t loading_total_bytes;
367 off_t loading_loaded_bytes;
368 time_t loading_start_time;
4ebfc455 369 /* Fast pointers to often looked up command */
370 struct redisCommand *delCommand, *multiCommand;
e2641e09 371 list *slaves, *monitors;
372 char neterr[ANET_ERR_LEN];
373 aeEventLoop *el;
374 int cronloops; /* number of times the cron function run */
53eeeaff 375 time_t lastsave; /* Unix time of last save succeeede */
e2641e09 376 /* Fields used only for stats */
53eeeaff 377 time_t stat_starttime; /* server start time */
378 long long stat_numcommands; /* number of processed commands */
379 long long stat_numconnections; /* number of connections received */
380 long long stat_expiredkeys; /* number of expired keys */
f21779ff 381 long long stat_evictedkeys; /* number of evicted keys (maxmemory) */
53eeeaff 382 long long stat_keyspace_hits; /* number of successful lookups of keys */
383 long long stat_keyspace_misses; /* number of failed lookups of keys */
e2641e09 384 /* Configuration */
385 int verbosity;
386 int glueoutputbuf;
387 int maxidletime;
388 int dbnum;
389 int daemonize;
390 int appendonly;
391 int appendfsync;
392 int no_appendfsync_on_rewrite;
393 int shutdown_asap;
394 time_t lastfsync;
395 int appendfd;
396 int appendseldb;
397 char *pidfile;
398 pid_t bgsavechildpid;
399 pid_t bgrewritechildpid;
400 sds bgrewritebuf; /* buffer taken by parent during oppend only rewrite */
401 sds aofbuf; /* AOF buffer, written before entering the event loop */
402 struct saveparam *saveparams;
403 int saveparamslen;
404 char *logfile;
e1a586ee
JH
405 int syslog_enabled;
406 char *syslog_ident;
407 int syslog_facility;
e2641e09 408 char *dbfilename;
409 char *appendfilename;
410 char *requirepass;
411 int rdbcompression;
412 int activerehashing;
413 /* Replication related */
414 int isslave;
f4aa600b 415 /* Slave specific fields */
e2641e09 416 char *masterauth;
417 char *masterhost;
418 int masterport;
419 redisClient *master; /* client that is master for this slave */
f4aa600b 420 int replstate; /* replication status if the instance is a slave */
62ec599c 421 off_t repl_transfer_left; /* bytes left reading .rdb */
f4aa600b 422 int repl_transfer_s; /* slave -> master SYNC socket */
423 int repl_transfer_fd; /* slave -> master SYNC temp file descriptor */
424 char *repl_transfer_tmpfile; /* slave-> master SYNC temp file name */
425 time_t repl_transfer_lastio; /* unix time of the latest read, for timeout */
4ebfc455 426 int repl_serve_stale_data; /* Serve stale data when link is down? */
f4aa600b 427 /* Limits */
e2641e09 428 unsigned int maxclients;
429 unsigned long long maxmemory;
165346ca 430 int maxmemory_policy;
431 int maxmemory_samples;
f4aa600b 432 /* Blocked clients */
5fa95ad7 433 unsigned int bpop_blocked_clients;
697af434 434 unsigned int cache_blocked_clients;
cea8c5cd 435 list *unblocked_clients; /* list of clients to unblock before next loop */
436 list *cache_flush_queue; /* keys to flush on disk */
437 int cache_flush_delay; /* seconds to wait before flushing keys */
e2641e09 438 /* Sort parameters - qsort_r() is only available under BSD so we
439 * have to take this state global, in order to pass it to sortCompare() */
440 int sort_desc;
441 int sort_alpha;
442 int sort_bypattern;
443 /* Virtual memory configuration */
697af434 444 int ds_enabled; /* backend disk in redis.conf */
445 char *ds_path; /* location of the disk store on disk */
446 unsigned long long cache_max_memory;
e2641e09 447 /* Zip structure config */
448 size_t hash_max_zipmap_entries;
449 size_t hash_max_zipmap_value;
450 size_t list_max_ziplist_entries;
451 size_t list_max_ziplist_value;
96ffb2fe 452 size_t set_max_intset_entries;
e2641e09 453 time_t unixtime; /* Unix time sampled every second. */
454 /* Virtual memory I/O threads stuff */
455 /* An I/O thread process an element taken from the io_jobs queue and
456 * put the result of the operation in the io_done list. While the
457 * job is being processed, it's put on io_processing queue. */
458 list *io_newjobs; /* List of VM I/O jobs yet to be processed */
459 list *io_processing; /* List of VM I/O jobs being processed */
460 list *io_processed; /* List of VM I/O jobs already processed */
461 list *io_ready_clients; /* Clients ready to be unblocked. All keys loaded */
462 pthread_mutex_t io_mutex; /* lock to access io_jobs/io_done/io_thread_job */
98a9abb6 463 pthread_cond_t io_condvar; /* I/O threads conditional variable */
e2641e09 464 pthread_attr_t io_threads_attr; /* attributes for threads creation */
465 int io_active_threads; /* Number of running I/O threads */
466 int vm_max_threads; /* Max number of I/O threads running at the same time */
467 /* Our main thread is blocked on the event loop, locking for sockets ready
468 * to be read or written, so when a threaded I/O operation is ready to be
469 * processed by the main thread, the I/O thread will use a unix pipe to
470 * awake the main thread. The followings are the two pipe FDs. */
471 int io_ready_pipe_read;
472 int io_ready_pipe_write;
473 /* Virtual memory stats */
474 unsigned long long vm_stats_used_pages;
475 unsigned long long vm_stats_swapped_objects;
476 unsigned long long vm_stats_swapouts;
477 unsigned long long vm_stats_swapins;
478 /* Pubsub */
479 dict *pubsub_channels; /* Map channels to list of subscribed clients */
480 list *pubsub_patterns; /* A list of pubsub_patterns */
481 /* Misc */
e2641e09 482 unsigned lruclock:22; /* clock incrementing every minute, for LRU */
483 unsigned lruclock_padding:10;
484};
485
486typedef struct pubsubPattern {
487 redisClient *client;
488 robj *pattern;
489} pubsubPattern;
490
491typedef void redisCommandProc(redisClient *c);
492typedef void redisVmPreloadProc(redisClient *c, struct redisCommand *cmd, int argc, robj **argv);
493struct redisCommand {
494 char *name;
495 redisCommandProc *proc;
496 int arity;
497 int flags;
498 /* Use a function to determine which keys need to be loaded
499 * in the background prior to executing this command. Takes precedence
500 * over vm_firstkey and others, ignored when NULL */
501 redisVmPreloadProc *vm_preload_proc;
502 /* What keys should be loaded in background when calling this command? */
503 int vm_firstkey; /* The first argument that's a key (0 = no keys) */
504 int vm_lastkey; /* THe last argument that's a key */
505 int vm_keystep; /* The step between first and last key */
506};
507
508struct redisFunctionSym {
509 char *name;
510 unsigned long pointer;
511};
512
513typedef struct _redisSortObject {
514 robj *obj;
515 union {
516 double score;
517 robj *cmpobj;
518 } u;
519} redisSortObject;
520
521typedef struct _redisSortOperation {
522 int type;
523 robj *pattern;
524} redisSortOperation;
525
526/* ZSETs use a specialized version of Skiplists */
e2641e09 527typedef struct zskiplistNode {
e2641e09 528 robj *obj;
2159782b
PN
529 double score;
530 struct zskiplistNode *backward;
531 struct zskiplistLevel {
532 struct zskiplistNode *forward;
533 unsigned int span;
534 } level[];
e2641e09 535} zskiplistNode;
536
537typedef struct zskiplist {
538 struct zskiplistNode *header, *tail;
539 unsigned long length;
540 int level;
541} zskiplist;
542
543typedef struct zset {
544 dict *dict;
545 zskiplist *zsl;
546} zset;
547
548/* VM threaded I/O request message */
f34a6cd8 549#define REDIS_IOJOB_LOAD 0
550#define REDIS_IOJOB_SAVE 1
551
e2641e09 552typedef struct iojob {
553 int type; /* Request type, REDIS_IOJOB_* */
554 redisDb *db;/* Redis database */
f34a6cd8 555 robj *key; /* This I/O request is about this key */
556 robj *val; /* the value to swap for REDIS_IOJOB_SAVE, otherwise this
557 * field is populated by the I/O thread for REDIS_IOJOB_LOAD. */
4ab98823 558 time_t expire; /* Expire time for this key on REDIS_IOJOB_LOAD */
e2641e09 559} iojob;
560
cea8c5cd 561/* When diskstore is enabled and a flush operation is requested we push
562 * one of this structures into server.cache_flush_queue. */
563typedef struct dirtykey {
564 redisDb *db;
565 robj *key;
566 time_t ctime; /* This is the creation time of the entry. */
567} dirtykey;
568
e2641e09 569/* Structure to hold list iteration abstraction. */
570typedef struct {
571 robj *subject;
572 unsigned char encoding;
573 unsigned char direction; /* Iteration direction */
574 unsigned char *zi;
575 listNode *ln;
576} listTypeIterator;
577
578/* Structure for an entry while iterating over a list. */
579typedef struct {
580 listTypeIterator *li;
581 unsigned char *zi; /* Entry in ziplist */
582 listNode *ln; /* Entry in linked list */
583} listTypeEntry;
584
96ffb2fe
PN
585/* Structure to hold set iteration abstraction. */
586typedef struct {
587 robj *subject;
588 int encoding;
589 int ii; /* intset iterator */
590 dictIterator *di;
cb72d0f1 591} setTypeIterator;
96ffb2fe 592
e2641e09 593/* Structure to hold hash iteration abstration. Note that iteration over
594 * hashes involves both fields and values. Because it is possible that
595 * not both are required, store pointers in the iterator to avoid
596 * unnecessary memory allocation for fields/values. */
597typedef struct {
598 int encoding;
599 unsigned char *zi;
600 unsigned char *zk, *zv;
601 unsigned int zklen, zvlen;
602
603 dictIterator *di;
604 dictEntry *de;
605} hashTypeIterator;
606
607#define REDIS_HASH_KEY 1
608#define REDIS_HASH_VALUE 2
609
610/*-----------------------------------------------------------------------------
611 * Extern declarations
612 *----------------------------------------------------------------------------*/
613
614extern struct redisServer server;
615extern struct sharedObjectsStruct shared;
616extern dictType setDictType;
617extern dictType zsetDictType;
618extern double R_Zero, R_PosInf, R_NegInf, R_Nan;
619dictType hashDictType;
620
621/*-----------------------------------------------------------------------------
622 * Functions prototypes
623 *----------------------------------------------------------------------------*/
624
625/* networking.c -- Networking and Client related operations */
626redisClient *createClient(int fd);
627void closeTimedoutClients(void);
628void freeClient(redisClient *c);
629void resetClient(redisClient *c);
630void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask);
631void sendReplyToClientWritev(aeEventLoop *el, int fd, void *privdata, int mask);
632void addReply(redisClient *c, robj *obj);
b301c1fc
PN
633void *addDeferredMultiBulkLength(redisClient *c);
634void setDeferredMultiBulkLength(redisClient *c, void *node, long length);
e2641e09 635void addReplySds(redisClient *c, sds s);
636void processInputBuffer(redisClient *c);
ab17b909
PN
637void acceptTcpHandler(aeEventLoop *el, int fd, void *privdata, int mask);
638void acceptUnixHandler(aeEventLoop *el, int fd, void *privdata, int mask);
e2641e09 639void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask);
640void addReplyBulk(redisClient *c, robj *obj);
641void addReplyBulkCString(redisClient *c, char *s);
d51ebef5 642void addReplyBulkCBuffer(redisClient *c, void *p, size_t len);
643void addReplyBulkLongLong(redisClient *c, long long ll);
e2641e09 644void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask);
645void addReply(redisClient *c, robj *obj);
646void addReplySds(redisClient *c, sds s);
3ab20376
PN
647void addReplyError(redisClient *c, char *err);
648void addReplyStatus(redisClient *c, char *status);
e2641e09 649void addReplyDouble(redisClient *c, double d);
650void addReplyLongLong(redisClient *c, long long ll);
0537e7bf 651void addReplyMultiBulkLen(redisClient *c, long length);
e2641e09 652void *dupClientReplyValue(void *o);
653
3ab20376
PN
654#ifdef __GNUC__
655void addReplyErrorFormat(redisClient *c, const char *fmt, ...)
656 __attribute__((format(printf, 2, 3)));
657void addReplyStatusFormat(redisClient *c, const char *fmt, ...)
658 __attribute__((format(printf, 2, 3)));
659#else
660void addReplyErrorFormat(redisClient *c, const char *fmt, ...);
661void addReplyStatusFormat(redisClient *c, const char *fmt, ...);
662#endif
663
e2641e09 664/* List data type */
665void listTypeTryConversion(robj *subject, robj *value);
666void listTypePush(robj *subject, robj *value, int where);
667robj *listTypePop(robj *subject, int where);
668unsigned long listTypeLength(robj *subject);
669listTypeIterator *listTypeInitIterator(robj *subject, int index, unsigned char direction);
670void listTypeReleaseIterator(listTypeIterator *li);
671int listTypeNext(listTypeIterator *li, listTypeEntry *entry);
672robj *listTypeGet(listTypeEntry *entry);
673void listTypeInsert(listTypeEntry *entry, robj *value, int where);
674int listTypeEqual(listTypeEntry *entry, robj *o);
675void listTypeDelete(listTypeEntry *entry);
676void listTypeConvert(robj *subject, int enc);
677void unblockClientWaitingData(redisClient *c);
678int handleClientsWaitingListPush(redisClient *c, robj *key, robj *ele);
679void popGenericCommand(redisClient *c, int where);
680
681/* MULTI/EXEC/WATCH... */
682void unwatchAllKeys(redisClient *c);
683void initClientMultiState(redisClient *c);
684void freeClientMultiState(redisClient *c);
685void queueMultiCommand(redisClient *c, struct redisCommand *cmd);
686void touchWatchedKey(redisDb *db, robj *key);
687void touchWatchedKeysOnFlush(int dbid);
688
689/* Redis object implementation */
690void decrRefCount(void *o);
691void incrRefCount(robj *o);
692void freeStringObject(robj *o);
693void freeListObject(robj *o);
694void freeSetObject(robj *o);
695void freeZsetObject(robj *o);
696void freeHashObject(robj *o);
697robj *createObject(int type, void *ptr);
698robj *createStringObject(char *ptr, size_t len);
699robj *dupStringObject(robj *o);
700robj *tryObjectEncoding(robj *o);
701robj *getDecodedObject(robj *o);
702size_t stringObjectLen(robj *o);
e2641e09 703robj *createStringObjectFromLongLong(long long value);
704robj *createListObject(void);
705robj *createZiplistObject(void);
706robj *createSetObject(void);
96ffb2fe 707robj *createIntsetObject(void);
e2641e09 708robj *createHashObject(void);
709robj *createZsetObject(void);
710int getLongFromObjectOrReply(redisClient *c, robj *o, long *target, const char *msg);
711int checkType(redisClient *c, robj *o, int type);
712int getLongLongFromObjectOrReply(redisClient *c, robj *o, long long *target, const char *msg);
713int getDoubleFromObjectOrReply(redisClient *c, robj *o, double *target, const char *msg);
714int getLongLongFromObject(robj *o, long long *target);
715char *strEncoding(int encoding);
716int compareStringObjects(robj *a, robj *b);
717int equalStringObjects(robj *a, robj *b);
ef59a8bc 718unsigned long estimateObjectIdleTime(robj *o);
e2641e09 719
19e61097 720/* Synchronous I/O with timeout */
721int syncWrite(int fd, char *ptr, ssize_t size, int timeout);
722int syncRead(int fd, char *ptr, ssize_t size, int timeout);
723int syncReadLine(int fd, char *ptr, ssize_t size, int timeout);
d08fac3e 724int fwriteBulkString(FILE *fp, char *s, unsigned long len);
725int fwriteBulkDouble(FILE *fp, double d);
726int fwriteBulkLongLong(FILE *fp, long long l);
244201f6 727int fwriteBulkObject(FILE *fp, robj *obj);
19e61097 728
e2641e09 729/* Replication */
730void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc);
731void replicationFeedMonitors(list *monitors, int dictid, robj **argv, int argc);
732int syncWithMaster(void);
733void updateSlavesWaitingBgsave(int bgsaveerr);
f4aa600b 734void replicationCron(void);
e2641e09 735
97e7f8ae 736/* Generic persistence functions */
737void startLoading(FILE *fp);
738void loadingProgress(off_t pos);
739void stopLoading(void);
740
e2641e09 741/* RDB persistence */
742int rdbLoad(char *filename);
743int rdbSaveBackground(char *filename);
744void rdbRemoveTempFile(pid_t childpid);
745int rdbSave(char *filename);
746int rdbSaveObject(FILE *fp, robj *o);
bd70a5f5
PN
747off_t rdbSavedObjectLen(robj *o);
748off_t rdbSavedObjectPages(robj *o);
e2641e09 749robj *rdbLoadObject(int type, FILE *fp);
750void backgroundSaveDoneHandler(int statloc);
4ab98823 751int rdbSaveKeyValuePair(FILE *fp, redisDb *db, robj *key, robj *val, time_t now);
1fce3201 752int rdbLoadType(FILE *fp);
753time_t rdbLoadTime(FILE *fp);
754robj *rdbLoadStringObject(FILE *fp);
e2641e09 755
756/* AOF persistence */
757void flushAppendOnlyFile(void);
758void feedAppendOnlyFile(struct redisCommand *cmd, int dictid, robj **argv, int argc);
759void aofRemoveTempFile(pid_t childpid);
760int rewriteAppendOnlyFileBackground(void);
761int loadAppendOnlyFile(char *filename);
762void stopAppendOnly(void);
763int startAppendOnly(void);
764void backgroundRewriteDoneHandler(int statloc);
765
766/* Sorted sets data type */
767zskiplist *zslCreate(void);
768void zslFree(zskiplist *zsl);
69ef89f2 769zskiplistNode *zslInsert(zskiplist *zsl, double score, robj *obj);
e2641e09 770
771/* Core functions */
772void freeMemoryIfNeeded(void);
773int processCommand(redisClient *c);
774void setupSigSegvAction(void);
1b1f47c9 775struct redisCommand *lookupCommand(sds name);
776struct redisCommand *lookupCommandByCString(char *s);
e2641e09 777void call(redisClient *c, struct redisCommand *cmd);
778int prepareForShutdown();
779void redisLog(int level, const char *fmt, ...);
780void usage();
781void updateDictResizePolicy(void);
782int htNeedsResize(dict *dict);
783void oom(const char *msg);
1b1f47c9 784void populateCommandTable(void);
e2641e09 785
33388d43 786/* Disk store */
787int dsOpen(void);
788int dsClose(void);
789int dsSet(redisDb *db, robj *key, robj *val);
1fce3201 790robj *dsGet(redisDb *db, robj *key, time_t *expire);
5ef64098 791int dsDel(redisDb *db, robj *key);
33388d43 792int dsExists(redisDb *db, robj *key);
cea8c5cd 793int dsFlushDb(int dbid);
33388d43 794
795/* Disk Store Cache */
cea8c5cd 796void dsInit(void);
e2641e09 797void vmThreadedIOCompletedJob(aeEventLoop *el, int fd, void *privdata, int mask);
e2641e09 798void lockThreadedIO(void);
799void unlockThreadedIO(void);
e2641e09 800void freeIOJob(iojob *j);
801void queueIOJob(iojob *j);
e2641e09 802void waitEmptyIOJobsQueue(void);
8d51fb6a 803void processAllPendingIOJobs(void);
e2641e09 804void zunionInterBlockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd, int argc, robj **argv);
805void execBlockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd, int argc, robj **argv);
806int blockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd);
807int dontWaitForSwappedKey(redisClient *c, robj *key);
808void handleClientsBlockedOnSwappedKey(redisDb *db, robj *key);
cea8c5cd 809int cacheFreeOneEntry(void);
f63f0928 810void cacheScheduleForFlush(redisDb *db, robj *key);
811void cacheCron(void);
31222292 812int cacheKeyMayExist(redisDb *db, robj *key);
d934e1e8 813void cacheSetKeyExists(redisDb *db, robj *key);
814void cacheSetKeyDoesNotExist(redisDb *db, robj *key);
815void cacheSetKeyDoesNotExistRemember(redisDb *db, robj *key);
e2641e09 816
96ffb2fe
PN
817/* Set data type */
818robj *setTypeCreate(robj *value);
819int setTypeAdd(robj *subject, robj *value);
820int setTypeRemove(robj *subject, robj *value);
821int setTypeIsMember(robj *subject, robj *value);
cb72d0f1
PN
822setTypeIterator *setTypeInitIterator(robj *subject);
823void setTypeReleaseIterator(setTypeIterator *si);
1b508da7 824int setTypeNext(setTypeIterator *si, robj **objele, int64_t *llele);
825robj *setTypeNextObject(setTypeIterator *si);
dd48de74 826int setTypeRandomElement(robj *setobj, robj **objele, int64_t *llele);
96ffb2fe
PN
827unsigned long setTypeSize(robj *subject);
828void setTypeConvert(robj *subject, int enc);
829
e2641e09 830/* Hash data type */
831void convertToRealHash(robj *o);
832void hashTypeTryConversion(robj *subject, robj **argv, int start, int end);
833void hashTypeTryObjectEncoding(robj *subject, robj **o1, robj **o2);
3d24304f 834int hashTypeGet(robj *o, robj *key, robj **objval, unsigned char **v, unsigned int *vlen);
835robj *hashTypeGetObject(robj *o, robj *key);
e2641e09 836int hashTypeExists(robj *o, robj *key);
837int hashTypeSet(robj *o, robj *key, robj *value);
838int hashTypeDelete(robj *o, robj *key);
839unsigned long hashTypeLength(robj *o);
840hashTypeIterator *hashTypeInitIterator(robj *subject);
841void hashTypeReleaseIterator(hashTypeIterator *hi);
842int hashTypeNext(hashTypeIterator *hi);
8c304be3 843int hashTypeCurrent(hashTypeIterator *hi, int what, robj **objval, unsigned char **v, unsigned int *vlen);
844robj *hashTypeCurrentObject(hashTypeIterator *hi, int what);
e2641e09 845robj *hashTypeLookupWriteOrCreate(redisClient *c, robj *key);
846
847/* Pub / Sub */
848int pubsubUnsubscribeAllChannels(redisClient *c, int notify);
849int pubsubUnsubscribeAllPatterns(redisClient *c, int notify);
850void freePubsubPattern(void *p);
851int listMatchPubsubPattern(void *a, void *b);
852
853/* Utility functions */
854int stringmatchlen(const char *pattern, int patternLen,
855 const char *string, int stringLen, int nocase);
856int stringmatch(const char *pattern, const char *string, int nocase);
857long long memtoll(const char *p, int *err);
858int ll2string(char *s, size_t len, long long value);
859int isStringRepresentableAsLong(sds s, long *longval);
ec7e1389 860int isStringRepresentableAsLongLong(sds s, long long *longval);
861int isObjectRepresentableAsLongLong(robj *o, long long *llongval);
e2641e09 862
863/* Configuration */
864void loadServerConfig(char *filename);
865void appendServerSaveParams(time_t seconds, int changes);
866void resetServerSaveParams();
867
868/* db.c -- Keyspace access API */
869int removeExpire(redisDb *db, robj *key);
bcf2995c 870void propagateExpire(redisDb *db, robj *key);
e2641e09 871int expireIfNeeded(redisDb *db, robj *key);
e2641e09 872time_t getExpire(redisDb *db, robj *key);
0cf5b7b5 873void setExpire(redisDb *db, robj *key, time_t when);
e2641e09 874robj *lookupKey(redisDb *db, robj *key);
875robj *lookupKeyRead(redisDb *db, robj *key);
876robj *lookupKeyWrite(redisDb *db, robj *key);
877robj *lookupKeyReadOrReply(redisClient *c, robj *key, robj *reply);
878robj *lookupKeyWriteOrReply(redisClient *c, robj *key, robj *reply);
879int dbAdd(redisDb *db, robj *key, robj *val);
880int dbReplace(redisDb *db, robj *key, robj *val);
881int dbExists(redisDb *db, robj *key);
882robj *dbRandomKey(redisDb *db);
883int dbDelete(redisDb *db, robj *key);
884long long emptyDb();
885int selectDb(redisClient *c, int id);
cea8c5cd 886void signalModifiedKey(redisDb *db, robj *key);
887void signalFlushedDb(int dbid);
e2641e09 888
889/* Git SHA1 */
890char *redisGitSHA1(void);
891char *redisGitDirty(void);
892
893/* Commands prototypes */
894void authCommand(redisClient *c);
895void pingCommand(redisClient *c);
896void echoCommand(redisClient *c);
897void setCommand(redisClient *c);
898void setnxCommand(redisClient *c);
899void setexCommand(redisClient *c);
900void getCommand(redisClient *c);
901void delCommand(redisClient *c);
902void existsCommand(redisClient *c);
3c1bf495
PN
903void setbitCommand(redisClient *c);
904void getbitCommand(redisClient *c);
9f9e1cea 905void setrangeCommand(redisClient *c);
ef11bccc 906void getrangeCommand(redisClient *c);
e2641e09 907void incrCommand(redisClient *c);
908void decrCommand(redisClient *c);
909void incrbyCommand(redisClient *c);
910void decrbyCommand(redisClient *c);
911void selectCommand(redisClient *c);
912void randomkeyCommand(redisClient *c);
913void keysCommand(redisClient *c);
914void dbsizeCommand(redisClient *c);
915void lastsaveCommand(redisClient *c);
916void saveCommand(redisClient *c);
917void bgsaveCommand(redisClient *c);
918void bgrewriteaofCommand(redisClient *c);
919void shutdownCommand(redisClient *c);
920void moveCommand(redisClient *c);
921void renameCommand(redisClient *c);
922void renamenxCommand(redisClient *c);
923void lpushCommand(redisClient *c);
924void rpushCommand(redisClient *c);
925void lpushxCommand(redisClient *c);
926void rpushxCommand(redisClient *c);
927void linsertCommand(redisClient *c);
928void lpopCommand(redisClient *c);
929void rpopCommand(redisClient *c);
930void llenCommand(redisClient *c);
931void lindexCommand(redisClient *c);
932void lrangeCommand(redisClient *c);
933void ltrimCommand(redisClient *c);
934void typeCommand(redisClient *c);
935void lsetCommand(redisClient *c);
936void saddCommand(redisClient *c);
937void sremCommand(redisClient *c);
938void smoveCommand(redisClient *c);
939void sismemberCommand(redisClient *c);
940void scardCommand(redisClient *c);
941void spopCommand(redisClient *c);
942void srandmemberCommand(redisClient *c);
943void sinterCommand(redisClient *c);
944void sinterstoreCommand(redisClient *c);
945void sunionCommand(redisClient *c);
946void sunionstoreCommand(redisClient *c);
947void sdiffCommand(redisClient *c);
948void sdiffstoreCommand(redisClient *c);
949void syncCommand(redisClient *c);
950void flushdbCommand(redisClient *c);
951void flushallCommand(redisClient *c);
952void sortCommand(redisClient *c);
953void lremCommand(redisClient *c);
8a979f03 954void rpoplpushCommand(redisClient *c);
e2641e09 955void infoCommand(redisClient *c);
956void mgetCommand(redisClient *c);
957void monitorCommand(redisClient *c);
958void expireCommand(redisClient *c);
959void expireatCommand(redisClient *c);
960void getsetCommand(redisClient *c);
961void ttlCommand(redisClient *c);
a539d29a 962void persistCommand(redisClient *c);
e2641e09 963void slaveofCommand(redisClient *c);
964void debugCommand(redisClient *c);
965void msetCommand(redisClient *c);
966void msetnxCommand(redisClient *c);
967void zaddCommand(redisClient *c);
968void zincrbyCommand(redisClient *c);
969void zrangeCommand(redisClient *c);
970void zrangebyscoreCommand(redisClient *c);
25bb8a44 971void zrevrangebyscoreCommand(redisClient *c);
e2641e09 972void zcountCommand(redisClient *c);
973void zrevrangeCommand(redisClient *c);
974void zcardCommand(redisClient *c);
975void zremCommand(redisClient *c);
976void zscoreCommand(redisClient *c);
977void zremrangebyscoreCommand(redisClient *c);
978void multiCommand(redisClient *c);
979void execCommand(redisClient *c);
980void discardCommand(redisClient *c);
981void blpopCommand(redisClient *c);
982void brpopCommand(redisClient *c);
b2a7fd0c 983void brpoplpushCommand(redisClient *c);
e2641e09 984void appendCommand(redisClient *c);
80091bba 985void strlenCommand(redisClient *c);
e2641e09 986void zrankCommand(redisClient *c);
987void zrevrankCommand(redisClient *c);
988void hsetCommand(redisClient *c);
989void hsetnxCommand(redisClient *c);
990void hgetCommand(redisClient *c);
991void hmsetCommand(redisClient *c);
992void hmgetCommand(redisClient *c);
993void hdelCommand(redisClient *c);
994void hlenCommand(redisClient *c);
995void zremrangebyrankCommand(redisClient *c);
996void zunionstoreCommand(redisClient *c);
997void zinterstoreCommand(redisClient *c);
998void hkeysCommand(redisClient *c);
999void hvalsCommand(redisClient *c);
1000void hgetallCommand(redisClient *c);
1001void hexistsCommand(redisClient *c);
1002void configCommand(redisClient *c);
1003void hincrbyCommand(redisClient *c);
1004void subscribeCommand(redisClient *c);
1005void unsubscribeCommand(redisClient *c);
1006void psubscribeCommand(redisClient *c);
1007void punsubscribeCommand(redisClient *c);
1008void publishCommand(redisClient *c);
1009void watchCommand(redisClient *c);
1010void unwatchCommand(redisClient *c);
1011
b3aa6d71 1012#if defined(__GNUC__)
b3aa6d71 1013void *calloc(size_t count, size_t size) __attribute__ ((deprecated));
1014void free(void *ptr) __attribute__ ((deprecated));
1015void *malloc(size_t size) __attribute__ ((deprecated));
1016void *realloc(void *ptr, size_t size) __attribute__ ((deprecated));
1017#endif
1018
e2641e09 1019#endif