]> git.saurik.com Git - redis.git/blame - src/redis.h
disk store logged messages improved
[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 */
272 dict *watched_keys; /* WATCHED keys for MULTI/EXEC CAS */
273 int id;
274} redisDb;
275
276/* Client MULTI/EXEC state */
277typedef struct multiCmd {
278 robj **argv;
279 int argc;
280 struct redisCommand *cmd;
281} multiCmd;
282
283typedef struct multiState {
284 multiCmd *commands; /* Array of MULTI commands */
285 int count; /* Total number of MULTI commands */
286} multiState;
287
357a8417
DJMM
288typedef struct blockingState {
289 robj **keys; /* The key we are waiting to terminate a blocking
290 * operation such as BLPOP. Otherwise NULL. */
291 int count; /* Number of blocking keys */
292 time_t timeout; /* Blocking operation timeout. If UNIX current time
293 * is >= timeout then the operation timed out. */
294 robj *target; /* The key that should receive the element,
295 * for BRPOPLPUSH. */
296} blockingState;
297
e2641e09 298/* With multiplexing we need to take per-clinet state.
299 * Clients are taken in a liked list. */
300typedef struct redisClient {
301 int fd;
302 redisDb *db;
303 int dictid;
304 sds querybuf;
cd8788f2
PN
305 int argc;
306 robj **argv;
307 int reqtype;
308 int multibulklen; /* number of multi bulk arguments left to read */
309 long bulklen; /* length of bulk argument in multi bulk request */
e2641e09 310 list *reply;
311 int sentlen;
312 time_t lastinteraction; /* time of the last interaction, used for timeout */
313 int flags; /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
314 int slaveseldb; /* slave selected db, if this client is a slave */
315 int authenticated; /* when requirepass is non-NULL */
316 int replstate; /* replication state if this is a slave */
317 int repldbfd; /* replication DB file descriptor */
318 long repldboff; /* replication DB file offset */
319 off_t repldbsize; /* replication DB file size */
320 multiState mstate; /* MULTI/EXEC state */
e3c51c4b 321 blockingState bpop; /* blocking state */
e2641e09 322 list *io_keys; /* Keys this client is waiting to be loaded from the
323 * swap file in order to continue. */
324 list *watched_keys; /* Keys WATCHED for MULTI/EXEC CAS */
325 dict *pubsub_channels; /* channels a client is interested in (SUBSCRIBE) */
326 list *pubsub_patterns; /* patterns a client is interested in (SUBSCRIBE) */
834ef78e
PN
327
328 /* Response buffer */
329 int bufpos;
f3357792 330 char buf[REDIS_REPLY_CHUNK_BYTES];
e2641e09 331} redisClient;
332
333struct saveparam {
334 time_t seconds;
335 int changes;
336};
337
338struct sharedObjectsStruct {
339 robj *crlf, *ok, *err, *emptybulk, *czero, *cone, *cnegone, *pong, *space,
340 *colon, *nullbulk, *nullmultibulk, *queued,
341 *emptymultibulk, *wrongtypeerr, *nokeyerr, *syntaxerr, *sameobjecterr,
97e7f8ae 342 *outofrangeerr, *loadingerr, *plus,
e2641e09 343 *select0, *select1, *select2, *select3, *select4,
344 *select5, *select6, *select7, *select8, *select9,
345 *messagebulk, *pmessagebulk, *subscribebulk, *unsubscribebulk, *mbulk3,
346 *mbulk4, *psubscribebulk, *punsubscribebulk,
347 *integers[REDIS_SHARED_INTEGERS];
348};
349
350/* Global server state structure */
351struct redisServer {
0e5441d8 352 pthread_t mainthread;
e2641e09 353 int port;
a5639e7d 354 char *bindaddr;
5d10923f 355 char *unixsocket;
a5639e7d
PN
356 int ipfd;
357 int sofd;
e2641e09 358 redisDb *db;
359 long long dirty; /* changes to DB from the last save */
2f6b31c3 360 long long dirty_before_bgsave; /* used to restore dirty on failed BGSAVE */
e2641e09 361 list *clients;
1b1f47c9 362 dict *commands; /* Command table hahs table */
97e7f8ae 363 /* RDB / AOF loading information */
364 int loading;
365 off_t loading_total_bytes;
366 off_t loading_loaded_bytes;
367 time_t loading_start_time;
4ebfc455 368 /* Fast pointers to often looked up command */
369 struct redisCommand *delCommand, *multiCommand;
e2641e09 370 list *slaves, *monitors;
371 char neterr[ANET_ERR_LEN];
372 aeEventLoop *el;
373 int cronloops; /* number of times the cron function run */
53eeeaff 374 time_t lastsave; /* Unix time of last save succeeede */
e2641e09 375 /* Fields used only for stats */
53eeeaff 376 time_t stat_starttime; /* server start time */
377 long long stat_numcommands; /* number of processed commands */
378 long long stat_numconnections; /* number of connections received */
379 long long stat_expiredkeys; /* number of expired keys */
f21779ff 380 long long stat_evictedkeys; /* number of evicted keys (maxmemory) */
53eeeaff 381 long long stat_keyspace_hits; /* number of successful lookups of keys */
382 long long stat_keyspace_misses; /* number of failed lookups of keys */
e2641e09 383 /* Configuration */
384 int verbosity;
385 int glueoutputbuf;
386 int maxidletime;
387 int dbnum;
388 int daemonize;
389 int appendonly;
390 int appendfsync;
391 int no_appendfsync_on_rewrite;
392 int shutdown_asap;
393 time_t lastfsync;
394 int appendfd;
395 int appendseldb;
396 char *pidfile;
397 pid_t bgsavechildpid;
398 pid_t bgrewritechildpid;
399 sds bgrewritebuf; /* buffer taken by parent during oppend only rewrite */
400 sds aofbuf; /* AOF buffer, written before entering the event loop */
401 struct saveparam *saveparams;
402 int saveparamslen;
403 char *logfile;
e1a586ee
JH
404 int syslog_enabled;
405 char *syslog_ident;
406 int syslog_facility;
e2641e09 407 char *dbfilename;
408 char *appendfilename;
409 char *requirepass;
410 int rdbcompression;
411 int activerehashing;
412 /* Replication related */
413 int isslave;
f4aa600b 414 /* Slave specific fields */
e2641e09 415 char *masterauth;
416 char *masterhost;
417 int masterport;
418 redisClient *master; /* client that is master for this slave */
f4aa600b 419 int replstate; /* replication status if the instance is a slave */
62ec599c 420 off_t repl_transfer_left; /* bytes left reading .rdb */
f4aa600b 421 int repl_transfer_s; /* slave -> master SYNC socket */
422 int repl_transfer_fd; /* slave -> master SYNC temp file descriptor */
423 char *repl_transfer_tmpfile; /* slave-> master SYNC temp file name */
424 time_t repl_transfer_lastio; /* unix time of the latest read, for timeout */
4ebfc455 425 int repl_serve_stale_data; /* Serve stale data when link is down? */
f4aa600b 426 /* Limits */
e2641e09 427 unsigned int maxclients;
428 unsigned long long maxmemory;
165346ca 429 int maxmemory_policy;
430 int maxmemory_samples;
f4aa600b 431 /* Blocked clients */
5fa95ad7 432 unsigned int bpop_blocked_clients;
697af434 433 unsigned int cache_blocked_clients;
cea8c5cd 434 list *unblocked_clients; /* list of clients to unblock before next loop */
435 list *cache_flush_queue; /* keys to flush on disk */
436 int cache_flush_delay; /* seconds to wait before flushing keys */
e2641e09 437 /* Sort parameters - qsort_r() is only available under BSD so we
438 * have to take this state global, in order to pass it to sortCompare() */
439 int sort_desc;
440 int sort_alpha;
441 int sort_bypattern;
442 /* Virtual memory configuration */
697af434 443 int ds_enabled; /* backend disk in redis.conf */
444 char *ds_path; /* location of the disk store on disk */
445 unsigned long long cache_max_memory;
e2641e09 446 /* Zip structure config */
447 size_t hash_max_zipmap_entries;
448 size_t hash_max_zipmap_value;
449 size_t list_max_ziplist_entries;
450 size_t list_max_ziplist_value;
96ffb2fe 451 size_t set_max_intset_entries;
e2641e09 452 time_t unixtime; /* Unix time sampled every second. */
453 /* Virtual memory I/O threads stuff */
454 /* An I/O thread process an element taken from the io_jobs queue and
455 * put the result of the operation in the io_done list. While the
456 * job is being processed, it's put on io_processing queue. */
457 list *io_newjobs; /* List of VM I/O jobs yet to be processed */
458 list *io_processing; /* List of VM I/O jobs being processed */
459 list *io_processed; /* List of VM I/O jobs already processed */
460 list *io_ready_clients; /* Clients ready to be unblocked. All keys loaded */
461 pthread_mutex_t io_mutex; /* lock to access io_jobs/io_done/io_thread_job */
e2641e09 462 pthread_mutex_t io_swapfile_mutex; /* So we can lseek + write */
463 pthread_attr_t io_threads_attr; /* attributes for threads creation */
464 int io_active_threads; /* Number of running I/O threads */
465 int vm_max_threads; /* Max number of I/O threads running at the same time */
466 /* Our main thread is blocked on the event loop, locking for sockets ready
467 * to be read or written, so when a threaded I/O operation is ready to be
468 * processed by the main thread, the I/O thread will use a unix pipe to
469 * awake the main thread. The followings are the two pipe FDs. */
470 int io_ready_pipe_read;
471 int io_ready_pipe_write;
472 /* Virtual memory stats */
473 unsigned long long vm_stats_used_pages;
474 unsigned long long vm_stats_swapped_objects;
475 unsigned long long vm_stats_swapouts;
476 unsigned long long vm_stats_swapins;
477 /* Pubsub */
478 dict *pubsub_channels; /* Map channels to list of subscribed clients */
479 list *pubsub_patterns; /* A list of pubsub_patterns */
480 /* Misc */
e2641e09 481 unsigned lruclock:22; /* clock incrementing every minute, for LRU */
482 unsigned lruclock_padding:10;
483};
484
485typedef struct pubsubPattern {
486 redisClient *client;
487 robj *pattern;
488} pubsubPattern;
489
490typedef void redisCommandProc(redisClient *c);
491typedef void redisVmPreloadProc(redisClient *c, struct redisCommand *cmd, int argc, robj **argv);
492struct redisCommand {
493 char *name;
494 redisCommandProc *proc;
495 int arity;
496 int flags;
497 /* Use a function to determine which keys need to be loaded
498 * in the background prior to executing this command. Takes precedence
499 * over vm_firstkey and others, ignored when NULL */
500 redisVmPreloadProc *vm_preload_proc;
501 /* What keys should be loaded in background when calling this command? */
502 int vm_firstkey; /* The first argument that's a key (0 = no keys) */
503 int vm_lastkey; /* THe last argument that's a key */
504 int vm_keystep; /* The step between first and last key */
505};
506
507struct redisFunctionSym {
508 char *name;
509 unsigned long pointer;
510};
511
512typedef struct _redisSortObject {
513 robj *obj;
514 union {
515 double score;
516 robj *cmpobj;
517 } u;
518} redisSortObject;
519
520typedef struct _redisSortOperation {
521 int type;
522 robj *pattern;
523} redisSortOperation;
524
525/* ZSETs use a specialized version of Skiplists */
e2641e09 526typedef struct zskiplistNode {
e2641e09 527 robj *obj;
2159782b
PN
528 double score;
529 struct zskiplistNode *backward;
530 struct zskiplistLevel {
531 struct zskiplistNode *forward;
532 unsigned int span;
533 } level[];
e2641e09 534} zskiplistNode;
535
536typedef struct zskiplist {
537 struct zskiplistNode *header, *tail;
538 unsigned long length;
539 int level;
540} zskiplist;
541
542typedef struct zset {
543 dict *dict;
544 zskiplist *zsl;
545} zset;
546
547/* VM threaded I/O request message */
f34a6cd8 548#define REDIS_IOJOB_LOAD 0
549#define REDIS_IOJOB_SAVE 1
550
e2641e09 551typedef struct iojob {
552 int type; /* Request type, REDIS_IOJOB_* */
553 redisDb *db;/* Redis database */
f34a6cd8 554 robj *key; /* This I/O request is about this key */
555 robj *val; /* the value to swap for REDIS_IOJOB_SAVE, otherwise this
556 * field is populated by the I/O thread for REDIS_IOJOB_LOAD. */
e2641e09 557} iojob;
558
cea8c5cd 559/* When diskstore is enabled and a flush operation is requested we push
560 * one of this structures into server.cache_flush_queue. */
561typedef struct dirtykey {
562 redisDb *db;
563 robj *key;
564 time_t ctime; /* This is the creation time of the entry. */
565} dirtykey;
566
e2641e09 567/* Structure to hold list iteration abstraction. */
568typedef struct {
569 robj *subject;
570 unsigned char encoding;
571 unsigned char direction; /* Iteration direction */
572 unsigned char *zi;
573 listNode *ln;
574} listTypeIterator;
575
576/* Structure for an entry while iterating over a list. */
577typedef struct {
578 listTypeIterator *li;
579 unsigned char *zi; /* Entry in ziplist */
580 listNode *ln; /* Entry in linked list */
581} listTypeEntry;
582
96ffb2fe
PN
583/* Structure to hold set iteration abstraction. */
584typedef struct {
585 robj *subject;
586 int encoding;
587 int ii; /* intset iterator */
588 dictIterator *di;
cb72d0f1 589} setTypeIterator;
96ffb2fe 590
e2641e09 591/* Structure to hold hash iteration abstration. Note that iteration over
592 * hashes involves both fields and values. Because it is possible that
593 * not both are required, store pointers in the iterator to avoid
594 * unnecessary memory allocation for fields/values. */
595typedef struct {
596 int encoding;
597 unsigned char *zi;
598 unsigned char *zk, *zv;
599 unsigned int zklen, zvlen;
600
601 dictIterator *di;
602 dictEntry *de;
603} hashTypeIterator;
604
605#define REDIS_HASH_KEY 1
606#define REDIS_HASH_VALUE 2
607
608/*-----------------------------------------------------------------------------
609 * Extern declarations
610 *----------------------------------------------------------------------------*/
611
612extern struct redisServer server;
613extern struct sharedObjectsStruct shared;
614extern dictType setDictType;
615extern dictType zsetDictType;
616extern double R_Zero, R_PosInf, R_NegInf, R_Nan;
617dictType hashDictType;
618
619/*-----------------------------------------------------------------------------
620 * Functions prototypes
621 *----------------------------------------------------------------------------*/
622
623/* networking.c -- Networking and Client related operations */
624redisClient *createClient(int fd);
625void closeTimedoutClients(void);
626void freeClient(redisClient *c);
627void resetClient(redisClient *c);
628void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask);
629void sendReplyToClientWritev(aeEventLoop *el, int fd, void *privdata, int mask);
630void addReply(redisClient *c, robj *obj);
b301c1fc
PN
631void *addDeferredMultiBulkLength(redisClient *c);
632void setDeferredMultiBulkLength(redisClient *c, void *node, long length);
e2641e09 633void addReplySds(redisClient *c, sds s);
634void processInputBuffer(redisClient *c);
ab17b909
PN
635void acceptTcpHandler(aeEventLoop *el, int fd, void *privdata, int mask);
636void acceptUnixHandler(aeEventLoop *el, int fd, void *privdata, int mask);
e2641e09 637void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask);
638void addReplyBulk(redisClient *c, robj *obj);
639void addReplyBulkCString(redisClient *c, char *s);
d51ebef5 640void addReplyBulkCBuffer(redisClient *c, void *p, size_t len);
641void addReplyBulkLongLong(redisClient *c, long long ll);
e2641e09 642void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask);
643void addReply(redisClient *c, robj *obj);
644void addReplySds(redisClient *c, sds s);
3ab20376
PN
645void addReplyError(redisClient *c, char *err);
646void addReplyStatus(redisClient *c, char *status);
e2641e09 647void addReplyDouble(redisClient *c, double d);
648void addReplyLongLong(redisClient *c, long long ll);
0537e7bf 649void addReplyMultiBulkLen(redisClient *c, long length);
e2641e09 650void *dupClientReplyValue(void *o);
651
3ab20376
PN
652#ifdef __GNUC__
653void addReplyErrorFormat(redisClient *c, const char *fmt, ...)
654 __attribute__((format(printf, 2, 3)));
655void addReplyStatusFormat(redisClient *c, const char *fmt, ...)
656 __attribute__((format(printf, 2, 3)));
657#else
658void addReplyErrorFormat(redisClient *c, const char *fmt, ...);
659void addReplyStatusFormat(redisClient *c, const char *fmt, ...);
660#endif
661
e2641e09 662/* List data type */
663void listTypeTryConversion(robj *subject, robj *value);
664void listTypePush(robj *subject, robj *value, int where);
665robj *listTypePop(robj *subject, int where);
666unsigned long listTypeLength(robj *subject);
667listTypeIterator *listTypeInitIterator(robj *subject, int index, unsigned char direction);
668void listTypeReleaseIterator(listTypeIterator *li);
669int listTypeNext(listTypeIterator *li, listTypeEntry *entry);
670robj *listTypeGet(listTypeEntry *entry);
671void listTypeInsert(listTypeEntry *entry, robj *value, int where);
672int listTypeEqual(listTypeEntry *entry, robj *o);
673void listTypeDelete(listTypeEntry *entry);
674void listTypeConvert(robj *subject, int enc);
675void unblockClientWaitingData(redisClient *c);
676int handleClientsWaitingListPush(redisClient *c, robj *key, robj *ele);
677void popGenericCommand(redisClient *c, int where);
678
679/* MULTI/EXEC/WATCH... */
680void unwatchAllKeys(redisClient *c);
681void initClientMultiState(redisClient *c);
682void freeClientMultiState(redisClient *c);
683void queueMultiCommand(redisClient *c, struct redisCommand *cmd);
684void touchWatchedKey(redisDb *db, robj *key);
685void touchWatchedKeysOnFlush(int dbid);
686
687/* Redis object implementation */
688void decrRefCount(void *o);
689void incrRefCount(robj *o);
690void freeStringObject(robj *o);
691void freeListObject(robj *o);
692void freeSetObject(robj *o);
693void freeZsetObject(robj *o);
694void freeHashObject(robj *o);
695robj *createObject(int type, void *ptr);
696robj *createStringObject(char *ptr, size_t len);
697robj *dupStringObject(robj *o);
698robj *tryObjectEncoding(robj *o);
699robj *getDecodedObject(robj *o);
700size_t stringObjectLen(robj *o);
e2641e09 701robj *createStringObjectFromLongLong(long long value);
702robj *createListObject(void);
703robj *createZiplistObject(void);
704robj *createSetObject(void);
96ffb2fe 705robj *createIntsetObject(void);
e2641e09 706robj *createHashObject(void);
707robj *createZsetObject(void);
708int getLongFromObjectOrReply(redisClient *c, robj *o, long *target, const char *msg);
709int checkType(redisClient *c, robj *o, int type);
710int getLongLongFromObjectOrReply(redisClient *c, robj *o, long long *target, const char *msg);
711int getDoubleFromObjectOrReply(redisClient *c, robj *o, double *target, const char *msg);
712int getLongLongFromObject(robj *o, long long *target);
713char *strEncoding(int encoding);
714int compareStringObjects(robj *a, robj *b);
715int equalStringObjects(robj *a, robj *b);
ef59a8bc 716unsigned long estimateObjectIdleTime(robj *o);
e2641e09 717
19e61097 718/* Synchronous I/O with timeout */
719int syncWrite(int fd, char *ptr, ssize_t size, int timeout);
720int syncRead(int fd, char *ptr, ssize_t size, int timeout);
721int syncReadLine(int fd, char *ptr, ssize_t size, int timeout);
d08fac3e 722int fwriteBulkString(FILE *fp, char *s, unsigned long len);
723int fwriteBulkDouble(FILE *fp, double d);
724int fwriteBulkLongLong(FILE *fp, long long l);
244201f6 725int fwriteBulkObject(FILE *fp, robj *obj);
19e61097 726
e2641e09 727/* Replication */
728void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc);
729void replicationFeedMonitors(list *monitors, int dictid, robj **argv, int argc);
730int syncWithMaster(void);
731void updateSlavesWaitingBgsave(int bgsaveerr);
f4aa600b 732void replicationCron(void);
e2641e09 733
97e7f8ae 734/* Generic persistence functions */
735void startLoading(FILE *fp);
736void loadingProgress(off_t pos);
737void stopLoading(void);
738
e2641e09 739/* RDB persistence */
740int rdbLoad(char *filename);
741int rdbSaveBackground(char *filename);
742void rdbRemoveTempFile(pid_t childpid);
743int rdbSave(char *filename);
744int rdbSaveObject(FILE *fp, robj *o);
bd70a5f5
PN
745off_t rdbSavedObjectLen(robj *o);
746off_t rdbSavedObjectPages(robj *o);
e2641e09 747robj *rdbLoadObject(int type, FILE *fp);
748void backgroundSaveDoneHandler(int statloc);
749
750/* AOF persistence */
751void flushAppendOnlyFile(void);
752void feedAppendOnlyFile(struct redisCommand *cmd, int dictid, robj **argv, int argc);
753void aofRemoveTempFile(pid_t childpid);
754int rewriteAppendOnlyFileBackground(void);
755int loadAppendOnlyFile(char *filename);
756void stopAppendOnly(void);
757int startAppendOnly(void);
758void backgroundRewriteDoneHandler(int statloc);
759
760/* Sorted sets data type */
761zskiplist *zslCreate(void);
762void zslFree(zskiplist *zsl);
69ef89f2 763zskiplistNode *zslInsert(zskiplist *zsl, double score, robj *obj);
e2641e09 764
765/* Core functions */
766void freeMemoryIfNeeded(void);
767int processCommand(redisClient *c);
768void setupSigSegvAction(void);
1b1f47c9 769struct redisCommand *lookupCommand(sds name);
770struct redisCommand *lookupCommandByCString(char *s);
e2641e09 771void call(redisClient *c, struct redisCommand *cmd);
772int prepareForShutdown();
773void redisLog(int level, const char *fmt, ...);
774void usage();
775void updateDictResizePolicy(void);
776int htNeedsResize(dict *dict);
777void oom(const char *msg);
1b1f47c9 778void populateCommandTable(void);
e2641e09 779
33388d43 780/* Disk store */
781int dsOpen(void);
782int dsClose(void);
783int dsSet(redisDb *db, robj *key, robj *val);
784robj *dsGet(redisDb *db, robj *key);
5ef64098 785int dsDel(redisDb *db, robj *key);
33388d43 786int dsExists(redisDb *db, robj *key);
cea8c5cd 787int dsFlushDb(int dbid);
33388d43 788
789/* Disk Store Cache */
cea8c5cd 790void dsInit(void);
e2641e09 791void vmThreadedIOCompletedJob(aeEventLoop *el, int fd, void *privdata, int mask);
e2641e09 792void lockThreadedIO(void);
793void unlockThreadedIO(void);
e2641e09 794void freeIOJob(iojob *j);
795void queueIOJob(iojob *j);
e2641e09 796void waitEmptyIOJobsQueue(void);
e2641e09 797void zunionInterBlockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd, int argc, robj **argv);
798void execBlockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd, int argc, robj **argv);
799int blockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd);
800int dontWaitForSwappedKey(redisClient *c, robj *key);
801void handleClientsBlockedOnSwappedKey(redisDb *db, robj *key);
cea8c5cd 802int cacheFreeOneEntry(void);
f63f0928 803void cacheScheduleForFlush(redisDb *db, robj *key);
804void cacheCron(void);
e2641e09 805
96ffb2fe
PN
806/* Set data type */
807robj *setTypeCreate(robj *value);
808int setTypeAdd(robj *subject, robj *value);
809int setTypeRemove(robj *subject, robj *value);
810int setTypeIsMember(robj *subject, robj *value);
cb72d0f1
PN
811setTypeIterator *setTypeInitIterator(robj *subject);
812void setTypeReleaseIterator(setTypeIterator *si);
1b508da7 813int setTypeNext(setTypeIterator *si, robj **objele, int64_t *llele);
814robj *setTypeNextObject(setTypeIterator *si);
dd48de74 815int setTypeRandomElement(robj *setobj, robj **objele, int64_t *llele);
96ffb2fe
PN
816unsigned long setTypeSize(robj *subject);
817void setTypeConvert(robj *subject, int enc);
818
e2641e09 819/* Hash data type */
820void convertToRealHash(robj *o);
821void hashTypeTryConversion(robj *subject, robj **argv, int start, int end);
822void hashTypeTryObjectEncoding(robj *subject, robj **o1, robj **o2);
3d24304f 823int hashTypeGet(robj *o, robj *key, robj **objval, unsigned char **v, unsigned int *vlen);
824robj *hashTypeGetObject(robj *o, robj *key);
e2641e09 825int hashTypeExists(robj *o, robj *key);
826int hashTypeSet(robj *o, robj *key, robj *value);
827int hashTypeDelete(robj *o, robj *key);
828unsigned long hashTypeLength(robj *o);
829hashTypeIterator *hashTypeInitIterator(robj *subject);
830void hashTypeReleaseIterator(hashTypeIterator *hi);
831int hashTypeNext(hashTypeIterator *hi);
8c304be3 832int hashTypeCurrent(hashTypeIterator *hi, int what, robj **objval, unsigned char **v, unsigned int *vlen);
833robj *hashTypeCurrentObject(hashTypeIterator *hi, int what);
e2641e09 834robj *hashTypeLookupWriteOrCreate(redisClient *c, robj *key);
835
836/* Pub / Sub */
837int pubsubUnsubscribeAllChannels(redisClient *c, int notify);
838int pubsubUnsubscribeAllPatterns(redisClient *c, int notify);
839void freePubsubPattern(void *p);
840int listMatchPubsubPattern(void *a, void *b);
841
842/* Utility functions */
843int stringmatchlen(const char *pattern, int patternLen,
844 const char *string, int stringLen, int nocase);
845int stringmatch(const char *pattern, const char *string, int nocase);
846long long memtoll(const char *p, int *err);
847int ll2string(char *s, size_t len, long long value);
848int isStringRepresentableAsLong(sds s, long *longval);
ec7e1389 849int isStringRepresentableAsLongLong(sds s, long long *longval);
850int isObjectRepresentableAsLongLong(robj *o, long long *llongval);
e2641e09 851
852/* Configuration */
853void loadServerConfig(char *filename);
854void appendServerSaveParams(time_t seconds, int changes);
855void resetServerSaveParams();
856
857/* db.c -- Keyspace access API */
858int removeExpire(redisDb *db, robj *key);
bcf2995c 859void propagateExpire(redisDb *db, robj *key);
e2641e09 860int expireIfNeeded(redisDb *db, robj *key);
e2641e09 861time_t getExpire(redisDb *db, robj *key);
0cf5b7b5 862void setExpire(redisDb *db, robj *key, time_t when);
e2641e09 863robj *lookupKey(redisDb *db, robj *key);
864robj *lookupKeyRead(redisDb *db, robj *key);
865robj *lookupKeyWrite(redisDb *db, robj *key);
866robj *lookupKeyReadOrReply(redisClient *c, robj *key, robj *reply);
867robj *lookupKeyWriteOrReply(redisClient *c, robj *key, robj *reply);
868int dbAdd(redisDb *db, robj *key, robj *val);
869int dbReplace(redisDb *db, robj *key, robj *val);
870int dbExists(redisDb *db, robj *key);
871robj *dbRandomKey(redisDb *db);
872int dbDelete(redisDb *db, robj *key);
873long long emptyDb();
874int selectDb(redisClient *c, int id);
cea8c5cd 875void signalModifiedKey(redisDb *db, robj *key);
876void signalFlushedDb(int dbid);
e2641e09 877
878/* Git SHA1 */
879char *redisGitSHA1(void);
880char *redisGitDirty(void);
881
882/* Commands prototypes */
883void authCommand(redisClient *c);
884void pingCommand(redisClient *c);
885void echoCommand(redisClient *c);
886void setCommand(redisClient *c);
887void setnxCommand(redisClient *c);
888void setexCommand(redisClient *c);
889void getCommand(redisClient *c);
890void delCommand(redisClient *c);
891void existsCommand(redisClient *c);
3c1bf495
PN
892void setbitCommand(redisClient *c);
893void getbitCommand(redisClient *c);
9f9e1cea 894void setrangeCommand(redisClient *c);
ef11bccc 895void getrangeCommand(redisClient *c);
e2641e09 896void incrCommand(redisClient *c);
897void decrCommand(redisClient *c);
898void incrbyCommand(redisClient *c);
899void decrbyCommand(redisClient *c);
900void selectCommand(redisClient *c);
901void randomkeyCommand(redisClient *c);
902void keysCommand(redisClient *c);
903void dbsizeCommand(redisClient *c);
904void lastsaveCommand(redisClient *c);
905void saveCommand(redisClient *c);
906void bgsaveCommand(redisClient *c);
907void bgrewriteaofCommand(redisClient *c);
908void shutdownCommand(redisClient *c);
909void moveCommand(redisClient *c);
910void renameCommand(redisClient *c);
911void renamenxCommand(redisClient *c);
912void lpushCommand(redisClient *c);
913void rpushCommand(redisClient *c);
914void lpushxCommand(redisClient *c);
915void rpushxCommand(redisClient *c);
916void linsertCommand(redisClient *c);
917void lpopCommand(redisClient *c);
918void rpopCommand(redisClient *c);
919void llenCommand(redisClient *c);
920void lindexCommand(redisClient *c);
921void lrangeCommand(redisClient *c);
922void ltrimCommand(redisClient *c);
923void typeCommand(redisClient *c);
924void lsetCommand(redisClient *c);
925void saddCommand(redisClient *c);
926void sremCommand(redisClient *c);
927void smoveCommand(redisClient *c);
928void sismemberCommand(redisClient *c);
929void scardCommand(redisClient *c);
930void spopCommand(redisClient *c);
931void srandmemberCommand(redisClient *c);
932void sinterCommand(redisClient *c);
933void sinterstoreCommand(redisClient *c);
934void sunionCommand(redisClient *c);
935void sunionstoreCommand(redisClient *c);
936void sdiffCommand(redisClient *c);
937void sdiffstoreCommand(redisClient *c);
938void syncCommand(redisClient *c);
939void flushdbCommand(redisClient *c);
940void flushallCommand(redisClient *c);
941void sortCommand(redisClient *c);
942void lremCommand(redisClient *c);
8a979f03 943void rpoplpushCommand(redisClient *c);
e2641e09 944void infoCommand(redisClient *c);
945void mgetCommand(redisClient *c);
946void monitorCommand(redisClient *c);
947void expireCommand(redisClient *c);
948void expireatCommand(redisClient *c);
949void getsetCommand(redisClient *c);
950void ttlCommand(redisClient *c);
a539d29a 951void persistCommand(redisClient *c);
e2641e09 952void slaveofCommand(redisClient *c);
953void debugCommand(redisClient *c);
954void msetCommand(redisClient *c);
955void msetnxCommand(redisClient *c);
956void zaddCommand(redisClient *c);
957void zincrbyCommand(redisClient *c);
958void zrangeCommand(redisClient *c);
959void zrangebyscoreCommand(redisClient *c);
25bb8a44 960void zrevrangebyscoreCommand(redisClient *c);
e2641e09 961void zcountCommand(redisClient *c);
962void zrevrangeCommand(redisClient *c);
963void zcardCommand(redisClient *c);
964void zremCommand(redisClient *c);
965void zscoreCommand(redisClient *c);
966void zremrangebyscoreCommand(redisClient *c);
967void multiCommand(redisClient *c);
968void execCommand(redisClient *c);
969void discardCommand(redisClient *c);
970void blpopCommand(redisClient *c);
971void brpopCommand(redisClient *c);
b2a7fd0c 972void brpoplpushCommand(redisClient *c);
e2641e09 973void appendCommand(redisClient *c);
80091bba 974void strlenCommand(redisClient *c);
e2641e09 975void zrankCommand(redisClient *c);
976void zrevrankCommand(redisClient *c);
977void hsetCommand(redisClient *c);
978void hsetnxCommand(redisClient *c);
979void hgetCommand(redisClient *c);
980void hmsetCommand(redisClient *c);
981void hmgetCommand(redisClient *c);
982void hdelCommand(redisClient *c);
983void hlenCommand(redisClient *c);
984void zremrangebyrankCommand(redisClient *c);
985void zunionstoreCommand(redisClient *c);
986void zinterstoreCommand(redisClient *c);
987void hkeysCommand(redisClient *c);
988void hvalsCommand(redisClient *c);
989void hgetallCommand(redisClient *c);
990void hexistsCommand(redisClient *c);
991void configCommand(redisClient *c);
992void hincrbyCommand(redisClient *c);
993void subscribeCommand(redisClient *c);
994void unsubscribeCommand(redisClient *c);
995void psubscribeCommand(redisClient *c);
996void punsubscribeCommand(redisClient *c);
997void publishCommand(redisClient *c);
998void watchCommand(redisClient *c);
999void unwatchCommand(redisClient *c);
1000
b3aa6d71 1001#if defined(__GNUC__)
b3aa6d71 1002void *calloc(size_t count, size_t size) __attribute__ ((deprecated));
1003void free(void *ptr) __attribute__ ((deprecated));
1004void *malloc(size_t size) __attribute__ ((deprecated));
1005void *realloc(void *ptr, size_t size) __attribute__ ((deprecated));
1006#endif
1007
e2641e09 1008#endif