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