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