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