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