]> git.saurik.com Git - redis.git/blame - src/redis.h
Fix parenthesis error on decrementing *argc
[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 */
338 list *clients;
339 list *slaves, *monitors;
340 char neterr[ANET_ERR_LEN];
341 aeEventLoop *el;
342 int cronloops; /* number of times the cron function run */
343 list *objfreelist; /* A list of freed objects to avoid malloc() */
344 time_t lastsave; /* Unix time of last save succeeede */
345 /* Fields used only for stats */
346 time_t stat_starttime; /* server start time */
347 long long stat_numcommands; /* number of processed commands */
348 long long stat_numconnections; /* number of connections received */
349 long long stat_expiredkeys; /* number of expired keys */
350 /* Configuration */
351 int verbosity;
352 int glueoutputbuf;
353 int maxidletime;
354 int dbnum;
355 int daemonize;
356 int appendonly;
357 int appendfsync;
358 int no_appendfsync_on_rewrite;
359 int shutdown_asap;
360 time_t lastfsync;
361 int appendfd;
362 int appendseldb;
363 char *pidfile;
364 pid_t bgsavechildpid;
365 pid_t bgrewritechildpid;
366 sds bgrewritebuf; /* buffer taken by parent during oppend only rewrite */
367 sds aofbuf; /* AOF buffer, written before entering the event loop */
368 struct saveparam *saveparams;
369 int saveparamslen;
370 char *logfile;
371 char *bindaddr;
372 char *dbfilename;
373 char *appendfilename;
374 char *requirepass;
375 int rdbcompression;
376 int activerehashing;
377 /* Replication related */
378 int isslave;
379 char *masterauth;
380 char *masterhost;
381 int masterport;
382 redisClient *master; /* client that is master for this slave */
383 int replstate;
384 unsigned int maxclients;
385 unsigned long long maxmemory;
386 unsigned int blpop_blocked_clients;
387 unsigned int vm_blocked_clients;
388 /* Sort parameters - qsort_r() is only available under BSD so we
389 * have to take this state global, in order to pass it to sortCompare() */
390 int sort_desc;
391 int sort_alpha;
392 int sort_bypattern;
393 /* Virtual memory configuration */
394 int vm_enabled;
395 char *vm_swap_file;
396 off_t vm_page_size;
397 off_t vm_pages;
398 unsigned long long vm_max_memory;
399 /* Zip structure config */
400 size_t hash_max_zipmap_entries;
401 size_t hash_max_zipmap_value;
402 size_t list_max_ziplist_entries;
403 size_t list_max_ziplist_value;
96ffb2fe 404 size_t set_max_intset_entries;
e2641e09 405 /* Virtual memory state */
406 FILE *vm_fp;
407 int vm_fd;
408 off_t vm_next_page; /* Next probably empty page */
409 off_t vm_near_pages; /* Number of pages allocated sequentially */
410 unsigned char *vm_bitmap; /* Bitmap of free/used pages */
411 time_t unixtime; /* Unix time sampled every second. */
412 /* Virtual memory I/O threads stuff */
413 /* An I/O thread process an element taken from the io_jobs queue and
414 * put the result of the operation in the io_done list. While the
415 * job is being processed, it's put on io_processing queue. */
416 list *io_newjobs; /* List of VM I/O jobs yet to be processed */
417 list *io_processing; /* List of VM I/O jobs being processed */
418 list *io_processed; /* List of VM I/O jobs already processed */
419 list *io_ready_clients; /* Clients ready to be unblocked. All keys loaded */
420 pthread_mutex_t io_mutex; /* lock to access io_jobs/io_done/io_thread_job */
421 pthread_mutex_t obj_freelist_mutex; /* safe redis objects creation/free */
422 pthread_mutex_t io_swapfile_mutex; /* So we can lseek + write */
423 pthread_attr_t io_threads_attr; /* attributes for threads creation */
424 int io_active_threads; /* Number of running I/O threads */
425 int vm_max_threads; /* Max number of I/O threads running at the same time */
426 /* Our main thread is blocked on the event loop, locking for sockets ready
427 * to be read or written, so when a threaded I/O operation is ready to be
428 * processed by the main thread, the I/O thread will use a unix pipe to
429 * awake the main thread. The followings are the two pipe FDs. */
430 int io_ready_pipe_read;
431 int io_ready_pipe_write;
432 /* Virtual memory stats */
433 unsigned long long vm_stats_used_pages;
434 unsigned long long vm_stats_swapped_objects;
435 unsigned long long vm_stats_swapouts;
436 unsigned long long vm_stats_swapins;
437 /* Pubsub */
438 dict *pubsub_channels; /* Map channels to list of subscribed clients */
439 list *pubsub_patterns; /* A list of pubsub_patterns */
440 /* Misc */
441 FILE *devnull;
442 unsigned lruclock:22; /* clock incrementing every minute, for LRU */
443 unsigned lruclock_padding:10;
444};
445
446typedef struct pubsubPattern {
447 redisClient *client;
448 robj *pattern;
449} pubsubPattern;
450
451typedef void redisCommandProc(redisClient *c);
452typedef void redisVmPreloadProc(redisClient *c, struct redisCommand *cmd, int argc, robj **argv);
453struct redisCommand {
454 char *name;
455 redisCommandProc *proc;
456 int arity;
457 int flags;
458 /* Use a function to determine which keys need to be loaded
459 * in the background prior to executing this command. Takes precedence
460 * over vm_firstkey and others, ignored when NULL */
461 redisVmPreloadProc *vm_preload_proc;
462 /* What keys should be loaded in background when calling this command? */
463 int vm_firstkey; /* The first argument that's a key (0 = no keys) */
464 int vm_lastkey; /* THe last argument that's a key */
465 int vm_keystep; /* The step between first and last key */
466};
467
468struct redisFunctionSym {
469 char *name;
470 unsigned long pointer;
471};
472
473typedef struct _redisSortObject {
474 robj *obj;
475 union {
476 double score;
477 robj *cmpobj;
478 } u;
479} redisSortObject;
480
481typedef struct _redisSortOperation {
482 int type;
483 robj *pattern;
484} redisSortOperation;
485
486/* ZSETs use a specialized version of Skiplists */
487
488typedef struct zskiplistNode {
489 struct zskiplistNode **forward;
490 struct zskiplistNode *backward;
491 unsigned int *span;
492 double score;
493 robj *obj;
494} zskiplistNode;
495
496typedef struct zskiplist {
497 struct zskiplistNode *header, *tail;
498 unsigned long length;
499 int level;
500} zskiplist;
501
502typedef struct zset {
503 dict *dict;
504 zskiplist *zsl;
505} zset;
506
507/* VM threaded I/O request message */
508#define REDIS_IOJOB_LOAD 0 /* Load from disk to memory */
509#define REDIS_IOJOB_PREPARE_SWAP 1 /* Compute needed pages */
510#define REDIS_IOJOB_DO_SWAP 2 /* Swap from memory to disk */
511typedef struct iojob {
512 int type; /* Request type, REDIS_IOJOB_* */
513 redisDb *db;/* Redis database */
514 robj *key; /* This I/O request is about swapping this key */
515 robj *id; /* Unique identifier of this job:
516 this is the object to swap for REDIS_IOREQ_*_SWAP, or the
517 vmpointer objct for REDIS_IOREQ_LOAD. */
518 robj *val; /* the value to swap for REDIS_IOREQ_*_SWAP, otherwise this
519 * field is populated by the I/O thread for REDIS_IOREQ_LOAD. */
520 off_t page; /* Swap page where to read/write the object */
521 off_t pages; /* Swap pages needed to save object. PREPARE_SWAP return val */
522 int canceled; /* True if this command was canceled by blocking side of VM */
523 pthread_t thread; /* ID of the thread processing this entry */
524} iojob;
525
526/* Structure to hold list iteration abstraction. */
527typedef struct {
528 robj *subject;
529 unsigned char encoding;
530 unsigned char direction; /* Iteration direction */
531 unsigned char *zi;
532 listNode *ln;
533} listTypeIterator;
534
535/* Structure for an entry while iterating over a list. */
536typedef struct {
537 listTypeIterator *li;
538 unsigned char *zi; /* Entry in ziplist */
539 listNode *ln; /* Entry in linked list */
540} listTypeEntry;
541
96ffb2fe
PN
542/* Structure to hold set iteration abstraction. */
543typedef struct {
544 robj *subject;
545 int encoding;
546 int ii; /* intset iterator */
547 dictIterator *di;
cb72d0f1 548} setTypeIterator;
96ffb2fe 549
e2641e09 550/* Structure to hold hash iteration abstration. Note that iteration over
551 * hashes involves both fields and values. Because it is possible that
552 * not both are required, store pointers in the iterator to avoid
553 * unnecessary memory allocation for fields/values. */
554typedef struct {
555 int encoding;
556 unsigned char *zi;
557 unsigned char *zk, *zv;
558 unsigned int zklen, zvlen;
559
560 dictIterator *di;
561 dictEntry *de;
562} hashTypeIterator;
563
564#define REDIS_HASH_KEY 1
565#define REDIS_HASH_VALUE 2
566
567/*-----------------------------------------------------------------------------
568 * Extern declarations
569 *----------------------------------------------------------------------------*/
570
571extern struct redisServer server;
572extern struct sharedObjectsStruct shared;
573extern dictType setDictType;
574extern dictType zsetDictType;
575extern double R_Zero, R_PosInf, R_NegInf, R_Nan;
576dictType hashDictType;
577
578/*-----------------------------------------------------------------------------
579 * Functions prototypes
580 *----------------------------------------------------------------------------*/
581
582/* networking.c -- Networking and Client related operations */
583redisClient *createClient(int fd);
584void closeTimedoutClients(void);
585void freeClient(redisClient *c);
586void resetClient(redisClient *c);
587void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask);
588void sendReplyToClientWritev(aeEventLoop *el, int fd, void *privdata, int mask);
589void addReply(redisClient *c, robj *obj);
590void addReplySds(redisClient *c, sds s);
591void processInputBuffer(redisClient *c);
592void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask);
593void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask);
594void addReplyBulk(redisClient *c, robj *obj);
595void addReplyBulkCString(redisClient *c, char *s);
596void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask);
597void addReply(redisClient *c, robj *obj);
598void addReplySds(redisClient *c, sds s);
599void addReplyDouble(redisClient *c, double d);
600void addReplyLongLong(redisClient *c, long long ll);
601void addReplyUlong(redisClient *c, unsigned long ul);
602void *dupClientReplyValue(void *o);
603
604/* List data type */
605void listTypeTryConversion(robj *subject, robj *value);
606void listTypePush(robj *subject, robj *value, int where);
607robj *listTypePop(robj *subject, int where);
608unsigned long listTypeLength(robj *subject);
609listTypeIterator *listTypeInitIterator(robj *subject, int index, unsigned char direction);
610void listTypeReleaseIterator(listTypeIterator *li);
611int listTypeNext(listTypeIterator *li, listTypeEntry *entry);
612robj *listTypeGet(listTypeEntry *entry);
613void listTypeInsert(listTypeEntry *entry, robj *value, int where);
614int listTypeEqual(listTypeEntry *entry, robj *o);
615void listTypeDelete(listTypeEntry *entry);
616void listTypeConvert(robj *subject, int enc);
617void unblockClientWaitingData(redisClient *c);
618int handleClientsWaitingListPush(redisClient *c, robj *key, robj *ele);
619void popGenericCommand(redisClient *c, int where);
620
621/* MULTI/EXEC/WATCH... */
622void unwatchAllKeys(redisClient *c);
623void initClientMultiState(redisClient *c);
624void freeClientMultiState(redisClient *c);
625void queueMultiCommand(redisClient *c, struct redisCommand *cmd);
626void touchWatchedKey(redisDb *db, robj *key);
627void touchWatchedKeysOnFlush(int dbid);
628
629/* Redis object implementation */
630void decrRefCount(void *o);
631void incrRefCount(robj *o);
632void freeStringObject(robj *o);
633void freeListObject(robj *o);
634void freeSetObject(robj *o);
635void freeZsetObject(robj *o);
636void freeHashObject(robj *o);
637robj *createObject(int type, void *ptr);
638robj *createStringObject(char *ptr, size_t len);
639robj *dupStringObject(robj *o);
640robj *tryObjectEncoding(robj *o);
641robj *getDecodedObject(robj *o);
642size_t stringObjectLen(robj *o);
643int tryFreeOneObjectFromFreelist(void);
644robj *createStringObjectFromLongLong(long long value);
645robj *createListObject(void);
646robj *createZiplistObject(void);
647robj *createSetObject(void);
96ffb2fe 648robj *createIntsetObject(void);
e2641e09 649robj *createHashObject(void);
650robj *createZsetObject(void);
651int getLongFromObjectOrReply(redisClient *c, robj *o, long *target, const char *msg);
652int checkType(redisClient *c, robj *o, int type);
653int getLongLongFromObjectOrReply(redisClient *c, robj *o, long long *target, const char *msg);
654int getDoubleFromObjectOrReply(redisClient *c, robj *o, double *target, const char *msg);
655int getLongLongFromObject(robj *o, long long *target);
656char *strEncoding(int encoding);
657int compareStringObjects(robj *a, robj *b);
658int equalStringObjects(robj *a, robj *b);
659
660/* Replication */
661void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc);
662void replicationFeedMonitors(list *monitors, int dictid, robj **argv, int argc);
663int syncWithMaster(void);
664void updateSlavesWaitingBgsave(int bgsaveerr);
665
666/* RDB persistence */
667int rdbLoad(char *filename);
668int rdbSaveBackground(char *filename);
669void rdbRemoveTempFile(pid_t childpid);
670int rdbSave(char *filename);
671int rdbSaveObject(FILE *fp, robj *o);
672off_t rdbSavedObjectPages(robj *o, FILE *fp);
673off_t rdbSavedObjectLen(robj *o, FILE *fp);
674robj *rdbLoadObject(int type, FILE *fp);
675void backgroundSaveDoneHandler(int statloc);
676
677/* AOF persistence */
678void flushAppendOnlyFile(void);
679void feedAppendOnlyFile(struct redisCommand *cmd, int dictid, robj **argv, int argc);
680void aofRemoveTempFile(pid_t childpid);
681int rewriteAppendOnlyFileBackground(void);
682int loadAppendOnlyFile(char *filename);
683void stopAppendOnly(void);
684int startAppendOnly(void);
685void backgroundRewriteDoneHandler(int statloc);
686
687/* Sorted sets data type */
688zskiplist *zslCreate(void);
689void zslFree(zskiplist *zsl);
690void zslInsert(zskiplist *zsl, double score, robj *obj);
691
692/* Core functions */
693void freeMemoryIfNeeded(void);
694int processCommand(redisClient *c);
695void setupSigSegvAction(void);
696struct redisCommand *lookupCommand(char *name);
697void call(redisClient *c, struct redisCommand *cmd);
698int prepareForShutdown();
699void redisLog(int level, const char *fmt, ...);
700void usage();
701void updateDictResizePolicy(void);
702int htNeedsResize(dict *dict);
703void oom(const char *msg);
704
705/* Virtual Memory */
706void vmInit(void);
707void vmMarkPagesFree(off_t page, off_t count);
708robj *vmLoadObject(robj *o);
709robj *vmPreviewObject(robj *o);
710int vmSwapOneObjectBlocking(void);
711int vmSwapOneObjectThreaded(void);
712int vmCanSwapOut(void);
713void vmThreadedIOCompletedJob(aeEventLoop *el, int fd, void *privdata, int mask);
714void vmCancelThreadedIOJob(robj *o);
715void lockThreadedIO(void);
716void unlockThreadedIO(void);
717int vmSwapObjectThreaded(robj *key, robj *val, redisDb *db);
718void freeIOJob(iojob *j);
719void queueIOJob(iojob *j);
720int vmWriteObjectOnSwap(robj *o, off_t page);
721robj *vmReadObjectFromSwap(off_t page, int type);
722void waitEmptyIOJobsQueue(void);
723void vmReopenSwapFile(void);
724int vmFreePage(off_t page);
725void zunionInterBlockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd, int argc, robj **argv);
726void execBlockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd, int argc, robj **argv);
727int blockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd);
728int dontWaitForSwappedKey(redisClient *c, robj *key);
729void handleClientsBlockedOnSwappedKey(redisDb *db, robj *key);
730vmpointer *vmSwapObjectBlocking(robj *val);
731
96ffb2fe
PN
732/* Set data type */
733robj *setTypeCreate(robj *value);
734int setTypeAdd(robj *subject, robj *value);
735int setTypeRemove(robj *subject, robj *value);
736int setTypeIsMember(robj *subject, robj *value);
cb72d0f1
PN
737setTypeIterator *setTypeInitIterator(robj *subject);
738void setTypeReleaseIterator(setTypeIterator *si);
739robj *setTypeNext(setTypeIterator *si);
96ffb2fe
PN
740robj *setTypeRandomElement(robj *subject);
741unsigned long setTypeSize(robj *subject);
742void setTypeConvert(robj *subject, int enc);
743
e2641e09 744/* Hash data type */
745void convertToRealHash(robj *o);
746void hashTypeTryConversion(robj *subject, robj **argv, int start, int end);
747void hashTypeTryObjectEncoding(robj *subject, robj **o1, robj **o2);
748robj *hashTypeGet(robj *o, robj *key);
749int hashTypeExists(robj *o, robj *key);
750int hashTypeSet(robj *o, robj *key, robj *value);
751int hashTypeDelete(robj *o, robj *key);
752unsigned long hashTypeLength(robj *o);
753hashTypeIterator *hashTypeInitIterator(robj *subject);
754void hashTypeReleaseIterator(hashTypeIterator *hi);
755int hashTypeNext(hashTypeIterator *hi);
756robj *hashTypeCurrent(hashTypeIterator *hi, int what);
757robj *hashTypeLookupWriteOrCreate(redisClient *c, robj *key);
758
759/* Pub / Sub */
760int pubsubUnsubscribeAllChannels(redisClient *c, int notify);
761int pubsubUnsubscribeAllPatterns(redisClient *c, int notify);
762void freePubsubPattern(void *p);
763int listMatchPubsubPattern(void *a, void *b);
764
765/* Utility functions */
766int stringmatchlen(const char *pattern, int patternLen,
767 const char *string, int stringLen, int nocase);
768int stringmatch(const char *pattern, const char *string, int nocase);
769long long memtoll(const char *p, int *err);
770int ll2string(char *s, size_t len, long long value);
771int isStringRepresentableAsLong(sds s, long *longval);
772
773/* Configuration */
774void loadServerConfig(char *filename);
775void appendServerSaveParams(time_t seconds, int changes);
776void resetServerSaveParams();
777
778/* db.c -- Keyspace access API */
779int removeExpire(redisDb *db, robj *key);
bcf2995c 780void propagateExpire(redisDb *db, robj *key);
e2641e09 781int expireIfNeeded(redisDb *db, robj *key);
e2641e09 782time_t getExpire(redisDb *db, robj *key);
0cf5b7b5 783void setExpire(redisDb *db, robj *key, time_t when);
e2641e09 784robj *lookupKey(redisDb *db, robj *key);
785robj *lookupKeyRead(redisDb *db, robj *key);
786robj *lookupKeyWrite(redisDb *db, robj *key);
787robj *lookupKeyReadOrReply(redisClient *c, robj *key, robj *reply);
788robj *lookupKeyWriteOrReply(redisClient *c, robj *key, robj *reply);
789int dbAdd(redisDb *db, robj *key, robj *val);
790int dbReplace(redisDb *db, robj *key, robj *val);
791int dbExists(redisDb *db, robj *key);
792robj *dbRandomKey(redisDb *db);
793int dbDelete(redisDb *db, robj *key);
794long long emptyDb();
795int selectDb(redisClient *c, int id);
796
797/* Git SHA1 */
798char *redisGitSHA1(void);
799char *redisGitDirty(void);
800
801/* Commands prototypes */
802void authCommand(redisClient *c);
803void pingCommand(redisClient *c);
804void echoCommand(redisClient *c);
805void setCommand(redisClient *c);
806void setnxCommand(redisClient *c);
807void setexCommand(redisClient *c);
808void getCommand(redisClient *c);
809void delCommand(redisClient *c);
810void existsCommand(redisClient *c);
811void incrCommand(redisClient *c);
812void decrCommand(redisClient *c);
813void incrbyCommand(redisClient *c);
814void decrbyCommand(redisClient *c);
815void selectCommand(redisClient *c);
816void randomkeyCommand(redisClient *c);
817void keysCommand(redisClient *c);
818void dbsizeCommand(redisClient *c);
819void lastsaveCommand(redisClient *c);
820void saveCommand(redisClient *c);
821void bgsaveCommand(redisClient *c);
822void bgrewriteaofCommand(redisClient *c);
823void shutdownCommand(redisClient *c);
824void moveCommand(redisClient *c);
825void renameCommand(redisClient *c);
826void renamenxCommand(redisClient *c);
827void lpushCommand(redisClient *c);
828void rpushCommand(redisClient *c);
829void lpushxCommand(redisClient *c);
830void rpushxCommand(redisClient *c);
831void linsertCommand(redisClient *c);
832void lpopCommand(redisClient *c);
833void rpopCommand(redisClient *c);
834void llenCommand(redisClient *c);
835void lindexCommand(redisClient *c);
836void lrangeCommand(redisClient *c);
837void ltrimCommand(redisClient *c);
838void typeCommand(redisClient *c);
839void lsetCommand(redisClient *c);
840void saddCommand(redisClient *c);
841void sremCommand(redisClient *c);
842void smoveCommand(redisClient *c);
843void sismemberCommand(redisClient *c);
844void scardCommand(redisClient *c);
845void spopCommand(redisClient *c);
846void srandmemberCommand(redisClient *c);
847void sinterCommand(redisClient *c);
848void sinterstoreCommand(redisClient *c);
849void sunionCommand(redisClient *c);
850void sunionstoreCommand(redisClient *c);
851void sdiffCommand(redisClient *c);
852void sdiffstoreCommand(redisClient *c);
853void syncCommand(redisClient *c);
854void flushdbCommand(redisClient *c);
855void flushallCommand(redisClient *c);
856void sortCommand(redisClient *c);
857void lremCommand(redisClient *c);
858void rpoplpushcommand(redisClient *c);
859void infoCommand(redisClient *c);
860void mgetCommand(redisClient *c);
861void monitorCommand(redisClient *c);
862void expireCommand(redisClient *c);
863void expireatCommand(redisClient *c);
864void getsetCommand(redisClient *c);
865void ttlCommand(redisClient *c);
a539d29a 866void persistCommand(redisClient *c);
e2641e09 867void slaveofCommand(redisClient *c);
868void debugCommand(redisClient *c);
869void msetCommand(redisClient *c);
870void msetnxCommand(redisClient *c);
871void zaddCommand(redisClient *c);
872void zincrbyCommand(redisClient *c);
873void zrangeCommand(redisClient *c);
874void zrangebyscoreCommand(redisClient *c);
875void zcountCommand(redisClient *c);
876void zrevrangeCommand(redisClient *c);
877void zcardCommand(redisClient *c);
878void zremCommand(redisClient *c);
879void zscoreCommand(redisClient *c);
880void zremrangebyscoreCommand(redisClient *c);
881void multiCommand(redisClient *c);
882void execCommand(redisClient *c);
883void discardCommand(redisClient *c);
884void blpopCommand(redisClient *c);
885void brpopCommand(redisClient *c);
886void appendCommand(redisClient *c);
887void substrCommand(redisClient *c);
80091bba 888void strlenCommand(redisClient *c);
e2641e09 889void zrankCommand(redisClient *c);
890void zrevrankCommand(redisClient *c);
891void hsetCommand(redisClient *c);
892void hsetnxCommand(redisClient *c);
893void hgetCommand(redisClient *c);
894void hmsetCommand(redisClient *c);
895void hmgetCommand(redisClient *c);
896void hdelCommand(redisClient *c);
897void hlenCommand(redisClient *c);
898void zremrangebyrankCommand(redisClient *c);
899void zunionstoreCommand(redisClient *c);
900void zinterstoreCommand(redisClient *c);
901void hkeysCommand(redisClient *c);
902void hvalsCommand(redisClient *c);
903void hgetallCommand(redisClient *c);
904void hexistsCommand(redisClient *c);
905void configCommand(redisClient *c);
906void hincrbyCommand(redisClient *c);
907void subscribeCommand(redisClient *c);
908void unsubscribeCommand(redisClient *c);
909void psubscribeCommand(redisClient *c);
910void punsubscribeCommand(redisClient *c);
911void publishCommand(redisClient *c);
912void watchCommand(redisClient *c);
913void unwatchCommand(redisClient *c);
914
b3aa6d71 915#if defined(__GNUC__)
b3aa6d71 916void *calloc(size_t count, size_t size) __attribute__ ((deprecated));
917void free(void *ptr) __attribute__ ((deprecated));
918void *malloc(size_t size) __attribute__ ((deprecated));
919void *realloc(void *ptr, size_t size) __attribute__ ((deprecated));
920#endif
921
e2641e09 922#endif