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