]> git.saurik.com Git - redis.git/blob - src/redis.h
projects / redis.git / blob
? search:


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