]> git.saurik.com Git - redis.git/blob - redis.c
check if the list encoding needs to be changed on LPUSHX, RPUSHX, LINSERT
[redis.git] / redis.c
1 /*
2 * Copyright (c) 2009-2010, Salvatore Sanfilippo <antirez at gmail dot com>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 *
8 * * Redistributions of source code must retain the above copyright notice,
9 * this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * * Neither the name of Redis nor the names of its contributors may be used
14 * to endorse or promote products derived from this software without
15 * specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 * POSSIBILITY OF SUCH DAMAGE.
28 */
29
30 #define REDIS_VERSION "2.1.1"
31
32 #include "fmacros.h"
33 #include "config.h"
34
35 #include <stdio.h>
36 #include <stdlib.h>
37 #include <string.h>
38 #include <time.h>
39 #include <unistd.h>
40 #include <signal.h>
41
42 #ifdef HAVE_BACKTRACE
43 #include <execinfo.h>
44 #include <ucontext.h>
45 #endif /* HAVE_BACKTRACE */
46
47 #include <sys/wait.h>
48 #include <errno.h>
49 #include <assert.h>
50 #include <ctype.h>
51 #include <stdarg.h>
52 #include <inttypes.h>
53 #include <arpa/inet.h>
54 #include <sys/stat.h>
55 #include <fcntl.h>
56 #include <sys/time.h>
57 #include <sys/resource.h>
58 #include <sys/uio.h>
59 #include <limits.h>
60 #include <float.h>
61 #include <math.h>
62 #include <pthread.h>
63
64 #if defined(__sun)
65 #include "solarisfixes.h"
66 #endif
67
68 #include "redis.h"
69 #include "ae.h" /* Event driven programming library */
70 #include "sds.h" /* Dynamic safe strings */
71 #include "anet.h" /* Networking the easy way */
72 #include "dict.h" /* Hash tables */
73 #include "adlist.h" /* Linked lists */
74 #include "zmalloc.h" /* total memory usage aware version of malloc/free */
75 #include "lzf.h" /* LZF compression library */
76 #include "pqsort.h" /* Partial qsort for SORT+LIMIT */
77 #include "zipmap.h" /* Compact dictionary-alike data structure */
78 #include "ziplist.h" /* Compact list data structure */
79 #include "sha1.h" /* SHA1 is used for DEBUG DIGEST */
80 #include "release.h" /* Release and/or git repository information */
81
82 /* Error codes */
83 #define REDIS_OK 0
84 #define REDIS_ERR -1
85
86 /* Static server configuration */
87 #define REDIS_SERVERPORT 6379 /* TCP port */
88 #define REDIS_MAXIDLETIME (60*5) /* default client timeout */
89 #define REDIS_IOBUF_LEN 1024
90 #define REDIS_LOADBUF_LEN 1024
91 #define REDIS_STATIC_ARGS 8
92 #define REDIS_DEFAULT_DBNUM 16
93 #define REDIS_CONFIGLINE_MAX 1024
94 #define REDIS_OBJFREELIST_MAX 1000000 /* Max number of objects to cache */
95 #define REDIS_MAX_SYNC_TIME 60 /* Slave can't take more to sync */
96 #define REDIS_EXPIRELOOKUPS_PER_CRON 10 /* lookup 10 expires per loop */
97 #define REDIS_MAX_WRITE_PER_EVENT (1024*64)
98 #define REDIS_REQUEST_MAX_SIZE (1024*1024*256) /* max bytes in inline command */
99
100 /* If more then REDIS_WRITEV_THRESHOLD write packets are pending use writev */
101 #define REDIS_WRITEV_THRESHOLD 3
102 /* Max number of iovecs used for each writev call */
103 #define REDIS_WRITEV_IOVEC_COUNT 256
104
105 /* Hash table parameters */
106 #define REDIS_HT_MINFILL 10 /* Minimal hash table fill 10% */
107
108 /* Command flags */
109 #define REDIS_CMD_BULK 1 /* Bulk write command */
110 #define REDIS_CMD_INLINE 2 /* Inline command */
111 /* REDIS_CMD_DENYOOM reserves a longer comment: all the commands marked with
112 this flags will return an error when the 'maxmemory' option is set in the
113 config file and the server is using more than maxmemory bytes of memory.
114 In short this commands are denied on low memory conditions. */
115 #define REDIS_CMD_DENYOOM 4
116 #define REDIS_CMD_FORCE_REPLICATION 8 /* Force replication even if dirty is 0 */
117
118 /* Object types */
119 #define REDIS_STRING 0
120 #define REDIS_LIST 1
121 #define REDIS_SET 2
122 #define REDIS_ZSET 3
123 #define REDIS_HASH 4
124 #define REDIS_VMPOINTER 8
125
126 /* Objects encoding. Some kind of objects like Strings and Hashes can be
127 * internally represented in multiple ways. The 'encoding' field of the object
128 * is set to one of this fields for this object. */
129 #define REDIS_ENCODING_RAW 0 /* Raw representation */
130 #define REDIS_ENCODING_INT 1 /* Encoded as integer */
131 #define REDIS_ENCODING_HT 2 /* Encoded as hash table */
132 #define REDIS_ENCODING_ZIPMAP 3 /* Encoded as zipmap */
133 #define REDIS_ENCODING_LIST 4 /* Encoded as zipmap */
134 #define REDIS_ENCODING_ZIPLIST 5 /* Encoded as ziplist */
135
136 static char* strencoding[] = {
137 "raw", "int", "hashtable", "zipmap", "list", "ziplist"
138 };
139
140 /* Object types only used for dumping to disk */
141 #define REDIS_EXPIRETIME 253
142 #define REDIS_SELECTDB 254
143 #define REDIS_EOF 255
144
145 /* Defines related to the dump file format. To store 32 bits lengths for short
146 * keys requires a lot of space, so we check the most significant 2 bits of
147 * the first byte to interpreter the length:
148 *
149 * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
150 * 01|000000 00000000 => 01, the len is 14 byes, 6 bits + 8 bits of next byte
151 * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
152 * 11|000000 this means: specially encoded object will follow. The six bits
153 * number specify the kind of object that follows.
154 * See the REDIS_RDB_ENC_* defines.
155 *
156 * Lenghts up to 63 are stored using a single byte, most DB keys, and may
157 * values, will fit inside. */
158 #define REDIS_RDB_6BITLEN 0
159 #define REDIS_RDB_14BITLEN 1
160 #define REDIS_RDB_32BITLEN 2
161 #define REDIS_RDB_ENCVAL 3
162 #define REDIS_RDB_LENERR UINT_MAX
163
164 /* When a length of a string object stored on disk has the first two bits
165 * set, the remaining two bits specify a special encoding for the object
166 * accordingly to the following defines: */
167 #define REDIS_RDB_ENC_INT8 0 /* 8 bit signed integer */
168 #define REDIS_RDB_ENC_INT16 1 /* 16 bit signed integer */
169 #define REDIS_RDB_ENC_INT32 2 /* 32 bit signed integer */
170 #define REDIS_RDB_ENC_LZF 3 /* string compressed with FASTLZ */
171
172 /* Virtual memory object->where field. */
173 #define REDIS_VM_MEMORY 0 /* The object is on memory */
174 #define REDIS_VM_SWAPPED 1 /* The object is on disk */
175 #define REDIS_VM_SWAPPING 2 /* Redis is swapping this object on disk */
176 #define REDIS_VM_LOADING 3 /* Redis is loading this object from disk */
177
178 /* Virtual memory static configuration stuff.
179 * Check vmFindContiguousPages() to know more about this magic numbers. */
180 #define REDIS_VM_MAX_NEAR_PAGES 65536
181 #define REDIS_VM_MAX_RANDOM_JUMP 4096
182 #define REDIS_VM_MAX_THREADS 32
183 #define REDIS_THREAD_STACK_SIZE (1024*1024*4)
184 /* The following is the *percentage* of completed I/O jobs to process when the
185 * handelr is called. While Virtual Memory I/O operations are performed by
186 * threads, this operations must be processed by the main thread when completed
187 * in order to take effect. */
188 #define REDIS_MAX_COMPLETED_JOBS_PROCESSED 1
189
190 /* Client flags */
191 #define REDIS_SLAVE 1 /* This client is a slave server */
192 #define REDIS_MASTER 2 /* This client is a master server */
193 #define REDIS_MONITOR 4 /* This client is a slave monitor, see MONITOR */
194 #define REDIS_MULTI 8 /* This client is in a MULTI context */
195 #define REDIS_BLOCKED 16 /* The client is waiting in a blocking operation */
196 #define REDIS_IO_WAIT 32 /* The client is waiting for Virtual Memory I/O */
197 #define REDIS_DIRTY_CAS 64 /* Watched keys modified. EXEC will fail. */
198
199 /* Slave replication state - slave side */
200 #define REDIS_REPL_NONE 0 /* No active replication */
201 #define REDIS_REPL_CONNECT 1 /* Must connect to master */
202 #define REDIS_REPL_CONNECTED 2 /* Connected to master */
203
204 /* Slave replication state - from the point of view of master
205 * Note that in SEND_BULK and ONLINE state the slave receives new updates
206 * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
207 * to start the next background saving in order to send updates to it. */
208 #define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
209 #define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
210 #define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
211 #define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */
212
213 /* List related stuff */
214 #define REDIS_HEAD 0
215 #define REDIS_TAIL 1
216
217 /* Sort operations */
218 #define REDIS_SORT_GET 0
219 #define REDIS_SORT_ASC 1
220 #define REDIS_SORT_DESC 2
221 #define REDIS_SORTKEY_MAX 1024
222
223 /* Log levels */
224 #define REDIS_DEBUG 0
225 #define REDIS_VERBOSE 1
226 #define REDIS_NOTICE 2
227 #define REDIS_WARNING 3
228
229 /* Anti-warning macro... */
230 #define REDIS_NOTUSED(V) ((void) V)
231
232 #define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
233 #define ZSKIPLIST_P 0.25 /* Skiplist P = 1/4 */
234
235 /* Append only defines */
236 #define APPENDFSYNC_NO 0
237 #define APPENDFSYNC_ALWAYS 1
238 #define APPENDFSYNC_EVERYSEC 2
239
240 /* Zip structure related defaults */
241 #define REDIS_HASH_MAX_ZIPMAP_ENTRIES 64
242 #define REDIS_HASH_MAX_ZIPMAP_VALUE 512
243 #define REDIS_LIST_MAX_ZIPLIST_ENTRIES 1024
244 #define REDIS_LIST_MAX_ZIPLIST_VALUE 32
245
246 /* We can print the stacktrace, so our assert is defined this way: */
247 #define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1)))
248 #define redisPanic(_e) _redisPanic(#_e,__FILE__,__LINE__),_exit(1)
249 static void _redisAssert(char *estr, char *file, int line);
250 static void _redisPanic(char *msg, char *file, int line);
251
252 /*================================= Data types ============================== */
253
254 /* A redis object, that is a type able to hold a string / list / set */
255
256 /* The actual Redis Object */
257 typedef struct redisObject {
258 unsigned type:4;
259 unsigned storage:2; /* REDIS_VM_MEMORY or REDIS_VM_SWAPPING */
260 unsigned encoding:4;
261 unsigned lru:22; /* lru time (relative to server.lruclock) */
262 int refcount;
263 void *ptr;
264 /* VM fields are only allocated if VM is active, otherwise the
265 * object allocation function will just allocate
266 * sizeof(redisObjct) minus sizeof(redisObjectVM), so using
267 * Redis without VM active will not have any overhead. */
268 } robj;
269
270 /* The VM pointer structure - identifies an object in the swap file.
271 *
272 * This object is stored in place of the value
273 * object in the main key->value hash table representing a database.
274 * Note that the first fields (type, storage) are the same as the redisObject
275 * structure so that vmPointer strucuters can be accessed even when casted
276 * as redisObject structures.
277 *
278 * This is useful as we don't know if a value object is or not on disk, but we
279 * are always able to read obj->storage to check this. For vmPointer
280 * structures "type" is set to REDIS_VMPOINTER (even if without this field
281 * is still possible to check the kind of object from the value of 'storage').*/
282 typedef struct vmPointer {
283 unsigned type:4;
284 unsigned storage:2; /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
285 unsigned notused:26;
286 unsigned int vtype; /* type of the object stored in the swap file */
287 off_t page; /* the page at witch the object is stored on disk */
288 off_t usedpages; /* number of pages used on disk */
289 } vmpointer;
290
291 /* Macro used to initalize a Redis object allocated on the stack.
292 * Note that this macro is taken near the structure definition to make sure
293 * we'll update it when the structure is changed, to avoid bugs like
294 * bug #85 introduced exactly in this way. */
295 #define initStaticStringObject(_var,_ptr) do { \
296 _var.refcount = 1; \
297 _var.type = REDIS_STRING; \
298 _var.encoding = REDIS_ENCODING_RAW; \
299 _var.ptr = _ptr; \
300 _var.storage = REDIS_VM_MEMORY; \
301 } while(0);
302
303 typedef struct redisDb {
304 dict *dict; /* The keyspace for this DB */
305 dict *expires; /* Timeout of keys with a timeout set */
306 dict *blocking_keys; /* Keys with clients waiting for data (BLPOP) */
307 dict *io_keys; /* Keys with clients waiting for VM I/O */
308 dict *watched_keys; /* WATCHED keys for MULTI/EXEC CAS */
309 int id;
310 } redisDb;
311
312 /* Client MULTI/EXEC state */
313 typedef struct multiCmd {
314 robj **argv;
315 int argc;
316 struct redisCommand *cmd;
317 } multiCmd;
318
319 typedef struct multiState {
320 multiCmd *commands; /* Array of MULTI commands */
321 int count; /* Total number of MULTI commands */
322 } multiState;
323
324 /* With multiplexing we need to take per-clinet state.
325 * Clients are taken in a liked list. */
326 typedef struct redisClient {
327 int fd;
328 redisDb *db;
329 int dictid;
330 sds querybuf;
331 robj **argv, **mbargv;
332 int argc, mbargc;
333 int bulklen; /* bulk read len. -1 if not in bulk read mode */
334 int multibulk; /* multi bulk command format active */
335 list *reply;
336 int sentlen;
337 time_t lastinteraction; /* time of the last interaction, used for timeout */
338 int flags; /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
339 int slaveseldb; /* slave selected db, if this client is a slave */
340 int authenticated; /* when requirepass is non-NULL */
341 int replstate; /* replication state if this is a slave */
342 int repldbfd; /* replication DB file descriptor */
343 long repldboff; /* replication DB file offset */
344 off_t repldbsize; /* replication DB file size */
345 multiState mstate; /* MULTI/EXEC state */
346 robj **blocking_keys; /* The key we are waiting to terminate a blocking
347 * operation such as BLPOP. Otherwise NULL. */
348 int blocking_keys_num; /* Number of blocking keys */
349 time_t blockingto; /* Blocking operation timeout. If UNIX current time
350 * is >= blockingto then the operation timed out. */
351 list *io_keys; /* Keys this client is waiting to be loaded from the
352 * swap file in order to continue. */
353 list *watched_keys; /* Keys WATCHED for MULTI/EXEC CAS */
354 dict *pubsub_channels; /* channels a client is interested in (SUBSCRIBE) */
355 list *pubsub_patterns; /* patterns a client is interested in (SUBSCRIBE) */
356 } redisClient;
357
358 struct saveparam {
359 time_t seconds;
360 int changes;
361 };
362
363 /* Global server state structure */
364 struct redisServer {
365 int port;
366 int fd;
367 redisDb *db;
368 long long dirty; /* changes to DB from the last save */
369 list *clients;
370 list *slaves, *monitors;
371 char neterr[ANET_ERR_LEN];
372 aeEventLoop *el;
373 int cronloops; /* number of times the cron function run */
374 list *objfreelist; /* A list of freed objects to avoid malloc() */
375 time_t lastsave; /* Unix time of last save succeeede */
376 /* Fields used only for stats */
377 time_t stat_starttime; /* server start time */
378 long long stat_numcommands; /* number of processed commands */
379 long long stat_numconnections; /* number of connections received */
380 long long stat_expiredkeys; /* number of expired keys */
381 /* Configuration */
382 int verbosity;
383 int glueoutputbuf;
384 int maxidletime;
385 int dbnum;
386 int daemonize;
387 int appendonly;
388 int appendfsync;
389 int no_appendfsync_on_rewrite;
390 int shutdown_asap;
391 time_t lastfsync;
392 int appendfd;
393 int appendseldb;
394 char *pidfile;
395 pid_t bgsavechildpid;
396 pid_t bgrewritechildpid;
397 sds bgrewritebuf; /* buffer taken by parent during oppend only rewrite */
398 sds aofbuf; /* AOF buffer, written before entering the event loop */
399 struct saveparam *saveparams;
400 int saveparamslen;
401 char *logfile;
402 char *bindaddr;
403 char *dbfilename;
404 char *appendfilename;
405 char *requirepass;
406 int rdbcompression;
407 int activerehashing;
408 /* Replication related */
409 int isslave;
410 char *masterauth;
411 char *masterhost;
412 int masterport;
413 redisClient *master; /* client that is master for this slave */
414 int replstate;
415 unsigned int maxclients;
416 unsigned long long maxmemory;
417 unsigned int blpop_blocked_clients;
418 unsigned int vm_blocked_clients;
419 /* Sort parameters - qsort_r() is only available under BSD so we
420 * have to take this state global, in order to pass it to sortCompare() */
421 int sort_desc;
422 int sort_alpha;
423 int sort_bypattern;
424 /* Virtual memory configuration */
425 int vm_enabled;
426 char *vm_swap_file;
427 off_t vm_page_size;
428 off_t vm_pages;
429 unsigned long long vm_max_memory;
430 /* Zip structure config */
431 size_t hash_max_zipmap_entries;
432 size_t hash_max_zipmap_value;
433 size_t list_max_ziplist_entries;
434 size_t list_max_ziplist_value;
435 /* Virtual memory state */
436 FILE *vm_fp;
437 int vm_fd;
438 off_t vm_next_page; /* Next probably empty page */
439 off_t vm_near_pages; /* Number of pages allocated sequentially */
440 unsigned char *vm_bitmap; /* Bitmap of free/used pages */
441 time_t unixtime; /* Unix time sampled every second. */
442 /* Virtual memory I/O threads stuff */
443 /* An I/O thread process an element taken from the io_jobs queue and
444 * put the result of the operation in the io_done list. While the
445 * job is being processed, it's put on io_processing queue. */
446 list *io_newjobs; /* List of VM I/O jobs yet to be processed */
447 list *io_processing; /* List of VM I/O jobs being processed */
448 list *io_processed; /* List of VM I/O jobs already processed */
449 list *io_ready_clients; /* Clients ready to be unblocked. All keys loaded */
450 pthread_mutex_t io_mutex; /* lock to access io_jobs/io_done/io_thread_job */
451 pthread_mutex_t obj_freelist_mutex; /* safe redis objects creation/free */
452 pthread_mutex_t io_swapfile_mutex; /* So we can lseek + write */
453 pthread_attr_t io_threads_attr; /* attributes for threads creation */
454 int io_active_threads; /* Number of running I/O threads */
455 int vm_max_threads; /* Max number of I/O threads running at the same time */
456 /* Our main thread is blocked on the event loop, locking for sockets ready
457 * to be read or written, so when a threaded I/O operation is ready to be
458 * processed by the main thread, the I/O thread will use a unix pipe to
459 * awake the main thread. The followings are the two pipe FDs. */
460 int io_ready_pipe_read;
461 int io_ready_pipe_write;
462 /* Virtual memory stats */
463 unsigned long long vm_stats_used_pages;
464 unsigned long long vm_stats_swapped_objects;
465 unsigned long long vm_stats_swapouts;
466 unsigned long long vm_stats_swapins;
467 /* Pubsub */
468 dict *pubsub_channels; /* Map channels to list of subscribed clients */
469 list *pubsub_patterns; /* A list of pubsub_patterns */
470 /* Misc */
471 FILE *devnull;
472 unsigned lruclock:22; /* clock incrementing every minute, for LRU */
473 unsigned lruclock_padding:10;
474 };
475
476 typedef struct pubsubPattern {
477 redisClient *client;
478 robj *pattern;
479 } pubsubPattern;
480
481 typedef void redisCommandProc(redisClient *c);
482 typedef void redisVmPreloadProc(redisClient *c, struct redisCommand *cmd, int argc, robj **argv);
483 struct redisCommand {
484 char *name;
485 redisCommandProc *proc;
486 int arity;
487 int flags;
488 /* Use a function to determine which keys need to be loaded
489 * in the background prior to executing this command. Takes precedence
490 * over vm_firstkey and others, ignored when NULL */
491 redisVmPreloadProc *vm_preload_proc;
492 /* What keys should be loaded in background when calling this command? */
493 int vm_firstkey; /* The first argument that's a key (0 = no keys) */
494 int vm_lastkey; /* THe last argument that's a key */
495 int vm_keystep; /* The step between first and last key */
496 };
497
498 struct redisFunctionSym {
499 char *name;
500 unsigned long pointer;
501 };
502
503 typedef struct _redisSortObject {
504 robj *obj;
505 union {
506 double score;
507 robj *cmpobj;
508 } u;
509 } redisSortObject;
510
511 typedef struct _redisSortOperation {
512 int type;
513 robj *pattern;
514 } redisSortOperation;
515
516 /* ZSETs use a specialized version of Skiplists */
517
518 typedef struct zskiplistNode {
519 struct zskiplistNode **forward;
520 struct zskiplistNode *backward;
521 unsigned int *span;
522 double score;
523 robj *obj;
524 } zskiplistNode;
525
526 typedef struct zskiplist {
527 struct zskiplistNode *header, *tail;
528 unsigned long length;
529 int level;
530 } zskiplist;
531
532 typedef struct zset {
533 dict *dict;
534 zskiplist *zsl;
535 } zset;
536
537 /* Our shared "common" objects */
538
539 #define REDIS_SHARED_INTEGERS 10000
540 struct sharedObjectsStruct {
541 robj *crlf, *ok, *err, *emptybulk, *czero, *cone, *pong, *space,
542 *colon, *nullbulk, *nullmultibulk, *queued,
543 *emptymultibulk, *wrongtypeerr, *nokeyerr, *syntaxerr, *sameobjecterr,
544 *outofrangeerr, *plus,
545 *select0, *select1, *select2, *select3, *select4,
546 *select5, *select6, *select7, *select8, *select9,
547 *messagebulk, *pmessagebulk, *subscribebulk, *unsubscribebulk, *mbulk3,
548 *mbulk4, *psubscribebulk, *punsubscribebulk,
549 *integers[REDIS_SHARED_INTEGERS];
550 } shared;
551
552 /* Global vars that are actally used as constants. The following double
553 * values are used for double on-disk serialization, and are initialized
554 * at runtime to avoid strange compiler optimizations. */
555
556 static double R_Zero, R_PosInf, R_NegInf, R_Nan;
557
558 /* VM threaded I/O request message */
559 #define REDIS_IOJOB_LOAD 0 /* Load from disk to memory */
560 #define REDIS_IOJOB_PREPARE_SWAP 1 /* Compute needed pages */
561 #define REDIS_IOJOB_DO_SWAP 2 /* Swap from memory to disk */
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 swapping this key */
566 robj *id; /* Unique identifier of this job:
567 this is the object to swap for REDIS_IOREQ_*_SWAP, or the
568 vmpointer objct for REDIS_IOREQ_LOAD. */
569 robj *val; /* the value to swap for REDIS_IOREQ_*_SWAP, otherwise this
570 * field is populated by the I/O thread for REDIS_IOREQ_LOAD. */
571 off_t page; /* Swap page where to read/write the object */
572 off_t pages; /* Swap pages needed to save object. PREPARE_SWAP return val */
573 int canceled; /* True if this command was canceled by blocking side of VM */
574 pthread_t thread; /* ID of the thread processing this entry */
575 } iojob;
576
577 /*================================ Prototypes =============================== */
578
579 static void freeStringObject(robj *o);
580 static void freeListObject(robj *o);
581 static void freeSetObject(robj *o);
582 static void decrRefCount(void *o);
583 static robj *createObject(int type, void *ptr);
584 static void freeClient(redisClient *c);
585 static int rdbLoad(char *filename);
586 static void addReply(redisClient *c, robj *obj);
587 static void addReplySds(redisClient *c, sds s);
588 static void incrRefCount(robj *o);
589 static int rdbSaveBackground(char *filename);
590 static robj *createStringObject(char *ptr, size_t len);
591 static robj *dupStringObject(robj *o);
592 static void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc);
593 static void replicationFeedMonitors(list *monitors, int dictid, robj **argv, int argc);
594 static void flushAppendOnlyFile(void);
595 static void feedAppendOnlyFile(struct redisCommand *cmd, int dictid, robj **argv, int argc);
596 static int syncWithMaster(void);
597 static robj *tryObjectEncoding(robj *o);
598 static robj *getDecodedObject(robj *o);
599 static int removeExpire(redisDb *db, robj *key);
600 static int expireIfNeeded(redisDb *db, robj *key);
601 static int deleteIfVolatile(redisDb *db, robj *key);
602 static int dbDelete(redisDb *db, robj *key);
603 static time_t getExpire(redisDb *db, robj *key);
604 static int setExpire(redisDb *db, robj *key, time_t when);
605 static void updateSlavesWaitingBgsave(int bgsaveerr);
606 static void freeMemoryIfNeeded(void);
607 static int processCommand(redisClient *c);
608 static void setupSigSegvAction(void);
609 static void rdbRemoveTempFile(pid_t childpid);
610 static void aofRemoveTempFile(pid_t childpid);
611 static size_t stringObjectLen(robj *o);
612 static void processInputBuffer(redisClient *c);
613 static zskiplist *zslCreate(void);
614 static void zslFree(zskiplist *zsl);
615 static void zslInsert(zskiplist *zsl, double score, robj *obj);
616 static void sendReplyToClientWritev(aeEventLoop *el, int fd, void *privdata, int mask);
617 static void initClientMultiState(redisClient *c);
618 static void freeClientMultiState(redisClient *c);
619 static void queueMultiCommand(redisClient *c, struct redisCommand *cmd);
620 static void unblockClientWaitingData(redisClient *c);
621 static int handleClientsWaitingListPush(redisClient *c, robj *key, robj *ele);
622 static void vmInit(void);
623 static void vmMarkPagesFree(off_t page, off_t count);
624 static robj *vmLoadObject(robj *o);
625 static robj *vmPreviewObject(robj *o);
626 static int vmSwapOneObjectBlocking(void);
627 static int vmSwapOneObjectThreaded(void);
628 static int vmCanSwapOut(void);
629 static int tryFreeOneObjectFromFreelist(void);
630 static void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask);
631 static void vmThreadedIOCompletedJob(aeEventLoop *el, int fd, void *privdata, int mask);
632 static void vmCancelThreadedIOJob(robj *o);
633 static void lockThreadedIO(void);
634 static void unlockThreadedIO(void);
635 static int vmSwapObjectThreaded(robj *key, robj *val, redisDb *db);
636 static void freeIOJob(iojob *j);
637 static void queueIOJob(iojob *j);
638 static int vmWriteObjectOnSwap(robj *o, off_t page);
639 static robj *vmReadObjectFromSwap(off_t page, int type);
640 static void waitEmptyIOJobsQueue(void);
641 static void vmReopenSwapFile(void);
642 static int vmFreePage(off_t page);
643 static void zunionInterBlockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd, int argc, robj **argv);
644 static void execBlockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd, int argc, robj **argv);
645 static int blockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd);
646 static int dontWaitForSwappedKey(redisClient *c, robj *key);
647 static void handleClientsBlockedOnSwappedKey(redisDb *db, robj *key);
648 static void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask);
649 static struct redisCommand *lookupCommand(char *name);
650 static void call(redisClient *c, struct redisCommand *cmd);
651 static void resetClient(redisClient *c);
652 static void convertToRealHash(robj *o);
653 static void listTypeConvert(robj *o, int enc);
654 static int pubsubUnsubscribeAllChannels(redisClient *c, int notify);
655 static int pubsubUnsubscribeAllPatterns(redisClient *c, int notify);
656 static void freePubsubPattern(void *p);
657 static int listMatchPubsubPattern(void *a, void *b);
658 static int compareStringObjects(robj *a, robj *b);
659 static int equalStringObjects(robj *a, robj *b);
660 static void usage();
661 static int rewriteAppendOnlyFileBackground(void);
662 static vmpointer *vmSwapObjectBlocking(robj *val);
663 static int prepareForShutdown();
664 static void touchWatchedKey(redisDb *db, robj *key);
665 static void touchWatchedKeysOnFlush(int dbid);
666 static void unwatchAllKeys(redisClient *c);
667
668 static void authCommand(redisClient *c);
669 static void pingCommand(redisClient *c);
670 static void echoCommand(redisClient *c);
671 static void setCommand(redisClient *c);
672 static void setnxCommand(redisClient *c);
673 static void setexCommand(redisClient *c);
674 static void getCommand(redisClient *c);
675 static void delCommand(redisClient *c);
676 static void existsCommand(redisClient *c);
677 static void incrCommand(redisClient *c);
678 static void decrCommand(redisClient *c);
679 static void incrbyCommand(redisClient *c);
680 static void decrbyCommand(redisClient *c);
681 static void selectCommand(redisClient *c);
682 static void randomkeyCommand(redisClient *c);
683 static void keysCommand(redisClient *c);
684 static void dbsizeCommand(redisClient *c);
685 static void lastsaveCommand(redisClient *c);
686 static void saveCommand(redisClient *c);
687 static void bgsaveCommand(redisClient *c);
688 static void bgrewriteaofCommand(redisClient *c);
689 static void shutdownCommand(redisClient *c);
690 static void moveCommand(redisClient *c);
691 static void renameCommand(redisClient *c);
692 static void renamenxCommand(redisClient *c);
693 static void lpushCommand(redisClient *c);
694 static void rpushCommand(redisClient *c);
695 static void lpushxCommand(redisClient *c);
696 static void rpushxCommand(redisClient *c);
697 static void linsertCommand(redisClient *c);
698 static void lpopCommand(redisClient *c);
699 static void rpopCommand(redisClient *c);
700 static void llenCommand(redisClient *c);
701 static void lindexCommand(redisClient *c);
702 static void lrangeCommand(redisClient *c);
703 static void ltrimCommand(redisClient *c);
704 static void typeCommand(redisClient *c);
705 static void lsetCommand(redisClient *c);
706 static void saddCommand(redisClient *c);
707 static void sremCommand(redisClient *c);
708 static void smoveCommand(redisClient *c);
709 static void sismemberCommand(redisClient *c);
710 static void scardCommand(redisClient *c);
711 static void spopCommand(redisClient *c);
712 static void srandmemberCommand(redisClient *c);
713 static void sinterCommand(redisClient *c);
714 static void sinterstoreCommand(redisClient *c);
715 static void sunionCommand(redisClient *c);
716 static void sunionstoreCommand(redisClient *c);
717 static void sdiffCommand(redisClient *c);
718 static void sdiffstoreCommand(redisClient *c);
719 static void syncCommand(redisClient *c);
720 static void flushdbCommand(redisClient *c);
721 static void flushallCommand(redisClient *c);
722 static void sortCommand(redisClient *c);
723 static void lremCommand(redisClient *c);
724 static void rpoplpushcommand(redisClient *c);
725 static void infoCommand(redisClient *c);
726 static void mgetCommand(redisClient *c);
727 static void monitorCommand(redisClient *c);
728 static void expireCommand(redisClient *c);
729 static void expireatCommand(redisClient *c);
730 static void getsetCommand(redisClient *c);
731 static void ttlCommand(redisClient *c);
732 static void slaveofCommand(redisClient *c);
733 static void debugCommand(redisClient *c);
734 static void msetCommand(redisClient *c);
735 static void msetnxCommand(redisClient *c);
736 static void zaddCommand(redisClient *c);
737 static void zincrbyCommand(redisClient *c);
738 static void zrangeCommand(redisClient *c);
739 static void zrangebyscoreCommand(redisClient *c);
740 static void zcountCommand(redisClient *c);
741 static void zrevrangeCommand(redisClient *c);
742 static void zcardCommand(redisClient *c);
743 static void zremCommand(redisClient *c);
744 static void zscoreCommand(redisClient *c);
745 static void zremrangebyscoreCommand(redisClient *c);
746 static void multiCommand(redisClient *c);
747 static void execCommand(redisClient *c);
748 static void discardCommand(redisClient *c);
749 static void blpopCommand(redisClient *c);
750 static void brpopCommand(redisClient *c);
751 static void appendCommand(redisClient *c);
752 static void substrCommand(redisClient *c);
753 static void zrankCommand(redisClient *c);
754 static void zrevrankCommand(redisClient *c);
755 static void hsetCommand(redisClient *c);
756 static void hsetnxCommand(redisClient *c);
757 static void hgetCommand(redisClient *c);
758 static void hmsetCommand(redisClient *c);
759 static void hmgetCommand(redisClient *c);
760 static void hdelCommand(redisClient *c);
761 static void hlenCommand(redisClient *c);
762 static void zremrangebyrankCommand(redisClient *c);
763 static void zunionstoreCommand(redisClient *c);
764 static void zinterstoreCommand(redisClient *c);
765 static void hkeysCommand(redisClient *c);
766 static void hvalsCommand(redisClient *c);
767 static void hgetallCommand(redisClient *c);
768 static void hexistsCommand(redisClient *c);
769 static void configCommand(redisClient *c);
770 static void hincrbyCommand(redisClient *c);
771 static void subscribeCommand(redisClient *c);
772 static void unsubscribeCommand(redisClient *c);
773 static void psubscribeCommand(redisClient *c);
774 static void punsubscribeCommand(redisClient *c);
775 static void publishCommand(redisClient *c);
776 static void watchCommand(redisClient *c);
777 static void unwatchCommand(redisClient *c);
778
779 /*================================= Globals ================================= */
780
781 /* Global vars */
782 static struct redisServer server; /* server global state */
783 static struct redisCommand *commandTable;
784 static struct redisCommand readonlyCommandTable[] = {
785 {"get",getCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
786 {"set",setCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,0,0,0},
787 {"setnx",setnxCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,0,0,0},
788 {"setex",setexCommand,4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,0,0,0},
789 {"append",appendCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
790 {"substr",substrCommand,4,REDIS_CMD_INLINE,NULL,1,1,1},
791 {"del",delCommand,-2,REDIS_CMD_INLINE,NULL,0,0,0},
792 {"exists",existsCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
793 {"incr",incrCommand,2,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,1,1},
794 {"decr",decrCommand,2,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,1,1},
795 {"mget",mgetCommand,-2,REDIS_CMD_INLINE,NULL,1,-1,1},
796 {"rpush",rpushCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
797 {"lpush",lpushCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
798 {"rpushx",rpushxCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
799 {"lpushx",lpushxCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
800 {"linsert",linsertCommand,5,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
801 {"rpop",rpopCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
802 {"lpop",lpopCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
803 {"brpop",brpopCommand,-3,REDIS_CMD_INLINE,NULL,1,1,1},
804 {"blpop",blpopCommand,-3,REDIS_CMD_INLINE,NULL,1,1,1},
805 {"llen",llenCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
806 {"lindex",lindexCommand,3,REDIS_CMD_INLINE,NULL,1,1,1},
807 {"lset",lsetCommand,4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
808 {"lrange",lrangeCommand,4,REDIS_CMD_INLINE,NULL,1,1,1},
809 {"ltrim",ltrimCommand,4,REDIS_CMD_INLINE,NULL,1,1,1},
810 {"lrem",lremCommand,4,REDIS_CMD_BULK,NULL,1,1,1},
811 {"rpoplpush",rpoplpushcommand,3,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,2,1},
812 {"sadd",saddCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
813 {"srem",sremCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
814 {"smove",smoveCommand,4,REDIS_CMD_BULK,NULL,1,2,1},
815 {"sismember",sismemberCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
816 {"scard",scardCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
817 {"spop",spopCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
818 {"srandmember",srandmemberCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
819 {"sinter",sinterCommand,-2,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,-1,1},
820 {"sinterstore",sinterstoreCommand,-3,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,2,-1,1},
821 {"sunion",sunionCommand,-2,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,-1,1},
822 {"sunionstore",sunionstoreCommand,-3,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,2,-1,1},
823 {"sdiff",sdiffCommand,-2,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,-1,1},
824 {"sdiffstore",sdiffstoreCommand,-3,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,2,-1,1},
825 {"smembers",sinterCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
826 {"zadd",zaddCommand,4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
827 {"zincrby",zincrbyCommand,4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
828 {"zrem",zremCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
829 {"zremrangebyscore",zremrangebyscoreCommand,4,REDIS_CMD_INLINE,NULL,1,1,1},
830 {"zremrangebyrank",zremrangebyrankCommand,4,REDIS_CMD_INLINE,NULL,1,1,1},
831 {"zunionstore",zunionstoreCommand,-4,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,zunionInterBlockClientOnSwappedKeys,0,0,0},
832 {"zinterstore",zinterstoreCommand,-4,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,zunionInterBlockClientOnSwappedKeys,0,0,0},
833 {"zrange",zrangeCommand,-4,REDIS_CMD_INLINE,NULL,1,1,1},
834 {"zrangebyscore",zrangebyscoreCommand,-4,REDIS_CMD_INLINE,NULL,1,1,1},
835 {"zcount",zcountCommand,4,REDIS_CMD_INLINE,NULL,1,1,1},
836 {"zrevrange",zrevrangeCommand,-4,REDIS_CMD_INLINE,NULL,1,1,1},
837 {"zcard",zcardCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
838 {"zscore",zscoreCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
839 {"zrank",zrankCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
840 {"zrevrank",zrevrankCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
841 {"hset",hsetCommand,4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
842 {"hsetnx",hsetnxCommand,4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
843 {"hget",hgetCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
844 {"hmset",hmsetCommand,-4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
845 {"hmget",hmgetCommand,-3,REDIS_CMD_BULK,NULL,1,1,1},
846 {"hincrby",hincrbyCommand,4,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,1,1},
847 {"hdel",hdelCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
848 {"hlen",hlenCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
849 {"hkeys",hkeysCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
850 {"hvals",hvalsCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
851 {"hgetall",hgetallCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
852 {"hexists",hexistsCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
853 {"incrby",incrbyCommand,3,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,1,1},
854 {"decrby",decrbyCommand,3,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,1,1},
855 {"getset",getsetCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
856 {"mset",msetCommand,-3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,-1,2},
857 {"msetnx",msetnxCommand,-3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,-1,2},
858 {"randomkey",randomkeyCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
859 {"select",selectCommand,2,REDIS_CMD_INLINE,NULL,0,0,0},
860 {"move",moveCommand,3,REDIS_CMD_INLINE,NULL,1,1,1},
861 {"rename",renameCommand,3,REDIS_CMD_INLINE,NULL,1,1,1},
862 {"renamenx",renamenxCommand,3,REDIS_CMD_INLINE,NULL,1,1,1},
863 {"expire",expireCommand,3,REDIS_CMD_INLINE,NULL,0,0,0},
864 {"expireat",expireatCommand,3,REDIS_CMD_INLINE,NULL,0,0,0},
865 {"keys",keysCommand,2,REDIS_CMD_INLINE,NULL,0,0,0},
866 {"dbsize",dbsizeCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
867 {"auth",authCommand,2,REDIS_CMD_INLINE,NULL,0,0,0},
868 {"ping",pingCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
869 {"echo",echoCommand,2,REDIS_CMD_BULK,NULL,0,0,0},
870 {"save",saveCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
871 {"bgsave",bgsaveCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
872 {"bgrewriteaof",bgrewriteaofCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
873 {"shutdown",shutdownCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
874 {"lastsave",lastsaveCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
875 {"type",typeCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
876 {"multi",multiCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
877 {"exec",execCommand,1,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,execBlockClientOnSwappedKeys,0,0,0},
878 {"discard",discardCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
879 {"sync",syncCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
880 {"flushdb",flushdbCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
881 {"flushall",flushallCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
882 {"sort",sortCommand,-2,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,1,1},
883 {"info",infoCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
884 {"monitor",monitorCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
885 {"ttl",ttlCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
886 {"slaveof",slaveofCommand,3,REDIS_CMD_INLINE,NULL,0,0,0},
887 {"debug",debugCommand,-2,REDIS_CMD_INLINE,NULL,0,0,0},
888 {"config",configCommand,-2,REDIS_CMD_BULK,NULL,0,0,0},
889 {"subscribe",subscribeCommand,-2,REDIS_CMD_INLINE,NULL,0,0,0},
890 {"unsubscribe",unsubscribeCommand,-1,REDIS_CMD_INLINE,NULL,0,0,0},
891 {"psubscribe",psubscribeCommand,-2,REDIS_CMD_INLINE,NULL,0,0,0},
892 {"punsubscribe",punsubscribeCommand,-1,REDIS_CMD_INLINE,NULL,0,0,0},
893 {"publish",publishCommand,3,REDIS_CMD_BULK|REDIS_CMD_FORCE_REPLICATION,NULL,0,0,0},
894 {"watch",watchCommand,-2,REDIS_CMD_INLINE,NULL,0,0,0},
895 {"unwatch",unwatchCommand,1,REDIS_CMD_INLINE,NULL,0,0,0}
896 };
897
898 /*============================ Utility functions ============================ */
899
900 /* Glob-style pattern matching. */
901 static int stringmatchlen(const char *pattern, int patternLen,
902 const char *string, int stringLen, int nocase)
903 {
904 while(patternLen) {
905 switch(pattern[0]) {
906 case '*':
907 while (pattern[1] == '*') {
908 pattern++;
909 patternLen--;
910 }
911 if (patternLen == 1)
912 return 1; /* match */
913 while(stringLen) {
914 if (stringmatchlen(pattern+1, patternLen-1,
915 string, stringLen, nocase))
916 return 1; /* match */
917 string++;
918 stringLen--;
919 }
920 return 0; /* no match */
921 break;
922 case '?':
923 if (stringLen == 0)
924 return 0; /* no match */
925 string++;
926 stringLen--;
927 break;
928 case '[':
929 {
930 int not, match;
931
932 pattern++;
933 patternLen--;
934 not = pattern[0] == '^';
935 if (not) {
936 pattern++;
937 patternLen--;
938 }
939 match = 0;
940 while(1) {
941 if (pattern[0] == '\\') {
942 pattern++;
943 patternLen--;
944 if (pattern[0] == string[0])
945 match = 1;
946 } else if (pattern[0] == ']') {
947 break;
948 } else if (patternLen == 0) {
949 pattern--;
950 patternLen++;
951 break;
952 } else if (pattern[1] == '-' && patternLen >= 3) {
953 int start = pattern[0];
954 int end = pattern[2];
955 int c = string[0];
956 if (start > end) {
957 int t = start;
958 start = end;
959 end = t;
960 }
961 if (nocase) {
962 start = tolower(start);
963 end = tolower(end);
964 c = tolower(c);
965 }
966 pattern += 2;
967 patternLen -= 2;
968 if (c >= start && c <= end)
969 match = 1;
970 } else {
971 if (!nocase) {
972 if (pattern[0] == string[0])
973 match = 1;
974 } else {
975 if (tolower((int)pattern[0]) == tolower((int)string[0]))
976 match = 1;
977 }
978 }
979 pattern++;
980 patternLen--;
981 }
982 if (not)
983 match = !match;
984 if (!match)
985 return 0; /* no match */
986 string++;
987 stringLen--;
988 break;
989 }
990 case '\\':
991 if (patternLen >= 2) {
992 pattern++;
993 patternLen--;
994 }
995 /* fall through */
996 default:
997 if (!nocase) {
998 if (pattern[0] != string[0])
999 return 0; /* no match */
1000 } else {
1001 if (tolower((int)pattern[0]) != tolower((int)string[0]))
1002 return 0; /* no match */
1003 }
1004 string++;
1005 stringLen--;
1006 break;
1007 }
1008 pattern++;
1009 patternLen--;
1010 if (stringLen == 0) {
1011 while(*pattern == '*') {
1012 pattern++;
1013 patternLen--;
1014 }
1015 break;
1016 }
1017 }
1018 if (patternLen == 0 && stringLen == 0)
1019 return 1;
1020 return 0;
1021 }
1022
1023 static int stringmatch(const char *pattern, const char *string, int nocase) {
1024 return stringmatchlen(pattern,strlen(pattern),string,strlen(string),nocase);
1025 }
1026
1027 /* Convert a string representing an amount of memory into the number of
1028 * bytes, so for instance memtoll("1Gi") will return 1073741824 that is
1029 * (1024*1024*1024).
1030 *
1031 * On parsing error, if *err is not NULL, it's set to 1, otherwise it's
1032 * set to 0 */
1033 static long long memtoll(const char *p, int *err) {
1034 const char *u;
1035 char buf[128];
1036 long mul; /* unit multiplier */
1037 long long val;
1038 unsigned int digits;
1039
1040 if (err) *err = 0;
1041 /* Search the first non digit character. */
1042 u = p;
1043 if (*u == '-') u++;
1044 while(*u && isdigit(*u)) u++;
1045 if (*u == '\0' || !strcasecmp(u,"b")) {
1046 mul = 1;
1047 } else if (!strcasecmp(u,"k")) {
1048 mul = 1000;
1049 } else if (!strcasecmp(u,"kb")) {
1050 mul = 1024;
1051 } else if (!strcasecmp(u,"m")) {
1052 mul = 1000*1000;
1053 } else if (!strcasecmp(u,"mb")) {
1054 mul = 1024*1024;
1055 } else if (!strcasecmp(u,"g")) {
1056 mul = 1000L*1000*1000;
1057 } else if (!strcasecmp(u,"gb")) {
1058 mul = 1024L*1024*1024;
1059 } else {
1060 if (err) *err = 1;
1061 mul = 1;
1062 }
1063 digits = u-p;
1064 if (digits >= sizeof(buf)) {
1065 if (err) *err = 1;
1066 return LLONG_MAX;
1067 }
1068 memcpy(buf,p,digits);
1069 buf[digits] = '\0';
1070 val = strtoll(buf,NULL,10);
1071 return val*mul;
1072 }
1073
1074 /* Convert a long long into a string. Returns the number of
1075 * characters needed to represent the number, that can be shorter if passed
1076 * buffer length is not enough to store the whole number. */
1077 static int ll2string(char *s, size_t len, long long value) {
1078 char buf[32], *p;
1079 unsigned long long v;
1080 size_t l;
1081
1082 if (len == 0) return 0;
1083 v = (value < 0) ? -value : value;
1084 p = buf+31; /* point to the last character */
1085 do {
1086 *p-- = '0'+(v%10);
1087 v /= 10;
1088 } while(v);
1089 if (value < 0) *p-- = '-';
1090 p++;
1091 l = 32-(p-buf);
1092 if (l+1 > len) l = len-1; /* Make sure it fits, including the nul term */
1093 memcpy(s,p,l);
1094 s[l] = '\0';
1095 return l;
1096 }
1097
1098 static void redisLog(int level, const char *fmt, ...) {
1099 va_list ap;
1100 FILE *fp;
1101
1102 fp = (server.logfile == NULL) ? stdout : fopen(server.logfile,"a");
1103 if (!fp) return;
1104
1105 va_start(ap, fmt);
1106 if (level >= server.verbosity) {
1107 char *c = ".-*#";
1108 char buf[64];
1109 time_t now;
1110
1111 now = time(NULL);
1112 strftime(buf,64,"%d %b %H:%M:%S",localtime(&now));
1113 fprintf(fp,"[%d] %s %c ",(int)getpid(),buf,c[level]);
1114 vfprintf(fp, fmt, ap);
1115 fprintf(fp,"\n");
1116 fflush(fp);
1117 }
1118 va_end(ap);
1119
1120 if (server.logfile) fclose(fp);
1121 }
1122
1123 /*====================== Hash table type implementation ==================== */
1124
1125 /* This is an hash table type that uses the SDS dynamic strings libary as
1126 * keys and radis objects as values (objects can hold SDS strings,
1127 * lists, sets). */
1128
1129 static void dictVanillaFree(void *privdata, void *val)
1130 {
1131 DICT_NOTUSED(privdata);
1132 zfree(val);
1133 }
1134
1135 static void dictListDestructor(void *privdata, void *val)
1136 {
1137 DICT_NOTUSED(privdata);
1138 listRelease((list*)val);
1139 }
1140
1141 static int dictSdsKeyCompare(void *privdata, const void *key1,
1142 const void *key2)
1143 {
1144 int l1,l2;
1145 DICT_NOTUSED(privdata);
1146
1147 l1 = sdslen((sds)key1);
1148 l2 = sdslen((sds)key2);
1149 if (l1 != l2) return 0;
1150 return memcmp(key1, key2, l1) == 0;
1151 }
1152
1153 static void dictRedisObjectDestructor(void *privdata, void *val)
1154 {
1155 DICT_NOTUSED(privdata);
1156
1157 if (val == NULL) return; /* Values of swapped out keys as set to NULL */
1158 decrRefCount(val);
1159 }
1160
1161 static void dictSdsDestructor(void *privdata, void *val)
1162 {
1163 DICT_NOTUSED(privdata);
1164
1165 sdsfree(val);
1166 }
1167
1168 static int dictObjKeyCompare(void *privdata, const void *key1,
1169 const void *key2)
1170 {
1171 const robj *o1 = key1, *o2 = key2;
1172 return dictSdsKeyCompare(privdata,o1->ptr,o2->ptr);
1173 }
1174
1175 static unsigned int dictObjHash(const void *key) {
1176 const robj *o = key;
1177 return dictGenHashFunction(o->ptr, sdslen((sds)o->ptr));
1178 }
1179
1180 static unsigned int dictSdsHash(const void *key) {
1181 return dictGenHashFunction((unsigned char*)key, sdslen((char*)key));
1182 }
1183
1184 static int dictEncObjKeyCompare(void *privdata, const void *key1,
1185 const void *key2)
1186 {
1187 robj *o1 = (robj*) key1, *o2 = (robj*) key2;
1188 int cmp;
1189
1190 if (o1->encoding == REDIS_ENCODING_INT &&
1191 o2->encoding == REDIS_ENCODING_INT)
1192 return o1->ptr == o2->ptr;
1193
1194 o1 = getDecodedObject(o1);
1195 o2 = getDecodedObject(o2);
1196 cmp = dictSdsKeyCompare(privdata,o1->ptr,o2->ptr);
1197 decrRefCount(o1);
1198 decrRefCount(o2);
1199 return cmp;
1200 }
1201
1202 static unsigned int dictEncObjHash(const void *key) {
1203 robj *o = (robj*) key;
1204
1205 if (o->encoding == REDIS_ENCODING_RAW) {
1206 return dictGenHashFunction(o->ptr, sdslen((sds)o->ptr));
1207 } else {
1208 if (o->encoding == REDIS_ENCODING_INT) {
1209 char buf[32];
1210 int len;
1211
1212 len = ll2string(buf,32,(long)o->ptr);
1213 return dictGenHashFunction((unsigned char*)buf, len);
1214 } else {
1215 unsigned int hash;
1216
1217 o = getDecodedObject(o);
1218 hash = dictGenHashFunction(o->ptr, sdslen((sds)o->ptr));
1219 decrRefCount(o);
1220 return hash;
1221 }
1222 }
1223 }
1224
1225 /* Sets type */
1226 static dictType setDictType = {
1227 dictEncObjHash, /* hash function */
1228 NULL, /* key dup */
1229 NULL, /* val dup */
1230 dictEncObjKeyCompare, /* key compare */
1231 dictRedisObjectDestructor, /* key destructor */
1232 NULL /* val destructor */
1233 };
1234
1235 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
1236 static dictType zsetDictType = {
1237 dictEncObjHash, /* hash function */
1238 NULL, /* key dup */
1239 NULL, /* val dup */
1240 dictEncObjKeyCompare, /* key compare */
1241 dictRedisObjectDestructor, /* key destructor */
1242 dictVanillaFree /* val destructor of malloc(sizeof(double)) */
1243 };
1244
1245 /* Db->dict, keys are sds strings, vals are Redis objects. */
1246 static dictType dbDictType = {
1247 dictSdsHash, /* hash function */
1248 NULL, /* key dup */
1249 NULL, /* val dup */
1250 dictSdsKeyCompare, /* key compare */
1251 dictSdsDestructor, /* key destructor */
1252 dictRedisObjectDestructor /* val destructor */
1253 };
1254
1255 /* Db->expires */
1256 static dictType keyptrDictType = {
1257 dictSdsHash, /* hash function */
1258 NULL, /* key dup */
1259 NULL, /* val dup */
1260 dictSdsKeyCompare, /* key compare */
1261 dictSdsDestructor, /* key destructor */
1262 NULL /* val destructor */
1263 };
1264
1265 /* Hash type hash table (note that small hashes are represented with zimpaps) */
1266 static dictType hashDictType = {
1267 dictEncObjHash, /* hash function */
1268 NULL, /* key dup */
1269 NULL, /* val dup */
1270 dictEncObjKeyCompare, /* key compare */
1271 dictRedisObjectDestructor, /* key destructor */
1272 dictRedisObjectDestructor /* val destructor */
1273 };
1274
1275 /* Keylist hash table type has unencoded redis objects as keys and
1276 * lists as values. It's used for blocking operations (BLPOP) and to
1277 * map swapped keys to a list of clients waiting for this keys to be loaded. */
1278 static dictType keylistDictType = {
1279 dictObjHash, /* hash function */
1280 NULL, /* key dup */
1281 NULL, /* val dup */
1282 dictObjKeyCompare, /* key compare */
1283 dictRedisObjectDestructor, /* key destructor */
1284 dictListDestructor /* val destructor */
1285 };
1286
1287 static void version();
1288
1289 /* ========================= Random utility functions ======================= */
1290
1291 /* Redis generally does not try to recover from out of memory conditions
1292 * when allocating objects or strings, it is not clear if it will be possible
1293 * to report this condition to the client since the networking layer itself
1294 * is based on heap allocation for send buffers, so we simply abort.
1295 * At least the code will be simpler to read... */
1296 static void oom(const char *msg) {
1297 redisLog(REDIS_WARNING, "%s: Out of memory\n",msg);
1298 sleep(1);
1299 abort();
1300 }
1301
1302 /* ====================== Redis server networking stuff ===================== */
1303 static void closeTimedoutClients(void) {
1304 redisClient *c;
1305 listNode *ln;
1306 time_t now = time(NULL);
1307 listIter li;
1308
1309 listRewind(server.clients,&li);
1310 while ((ln = listNext(&li)) != NULL) {
1311 c = listNodeValue(ln);
1312 if (server.maxidletime &&
1313 !(c->flags & REDIS_SLAVE) && /* no timeout for slaves */
1314 !(c->flags & REDIS_MASTER) && /* no timeout for masters */
1315 dictSize(c->pubsub_channels) == 0 && /* no timeout for pubsub */
1316 listLength(c->pubsub_patterns) == 0 &&
1317 (now - c->lastinteraction > server.maxidletime))
1318 {
1319 redisLog(REDIS_VERBOSE,"Closing idle client");
1320 freeClient(c);
1321 } else if (c->flags & REDIS_BLOCKED) {
1322 if (c->blockingto != 0 && c->blockingto < now) {
1323 addReply(c,shared.nullmultibulk);
1324 unblockClientWaitingData(c);
1325 }
1326 }
1327 }
1328 }
1329
1330 static int htNeedsResize(dict *dict) {
1331 long long size, used;
1332
1333 size = dictSlots(dict);
1334 used = dictSize(dict);
1335 return (size && used && size > DICT_HT_INITIAL_SIZE &&
1336 (used*100/size < REDIS_HT_MINFILL));
1337 }
1338
1339 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
1340 * we resize the hash table to save memory */
1341 static void tryResizeHashTables(void) {
1342 int j;
1343
1344 for (j = 0; j < server.dbnum; j++) {
1345 if (htNeedsResize(server.db[j].dict))
1346 dictResize(server.db[j].dict);
1347 if (htNeedsResize(server.db[j].expires))
1348 dictResize(server.db[j].expires);
1349 }
1350 }
1351
1352 /* Our hash table implementation performs rehashing incrementally while
1353 * we write/read from the hash table. Still if the server is idle, the hash
1354 * table will use two tables for a long time. So we try to use 1 millisecond
1355 * of CPU time at every serverCron() loop in order to rehash some key. */
1356 static void incrementallyRehash(void) {
1357 int j;
1358
1359 for (j = 0; j < server.dbnum; j++) {
1360 if (dictIsRehashing(server.db[j].dict)) {
1361 dictRehashMilliseconds(server.db[j].dict,1);
1362 break; /* already used our millisecond for this loop... */
1363 }
1364 }
1365 }
1366
1367 /* A background saving child (BGSAVE) terminated its work. Handle this. */
1368 void backgroundSaveDoneHandler(int statloc) {
1369 int exitcode = WEXITSTATUS(statloc);
1370 int bysignal = WIFSIGNALED(statloc);
1371
1372 if (!bysignal && exitcode == 0) {
1373 redisLog(REDIS_NOTICE,
1374 "Background saving terminated with success");
1375 server.dirty = 0;
1376 server.lastsave = time(NULL);
1377 } else if (!bysignal && exitcode != 0) {
1378 redisLog(REDIS_WARNING, "Background saving error");
1379 } else {
1380 redisLog(REDIS_WARNING,
1381 "Background saving terminated by signal %d", WTERMSIG(statloc));
1382 rdbRemoveTempFile(server.bgsavechildpid);
1383 }
1384 server.bgsavechildpid = -1;
1385 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1386 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1387 updateSlavesWaitingBgsave(exitcode == 0 ? REDIS_OK : REDIS_ERR);
1388 }
1389
1390 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1391 * Handle this. */
1392 void backgroundRewriteDoneHandler(int statloc) {
1393 int exitcode = WEXITSTATUS(statloc);
1394 int bysignal = WIFSIGNALED(statloc);
1395
1396 if (!bysignal && exitcode == 0) {
1397 int fd;
1398 char tmpfile[256];
1399
1400 redisLog(REDIS_NOTICE,
1401 "Background append only file rewriting terminated with success");
1402 /* Now it's time to flush the differences accumulated by the parent */
1403 snprintf(tmpfile,256,"temp-rewriteaof-bg-%d.aof", (int) server.bgrewritechildpid);
1404 fd = open(tmpfile,O_WRONLY|O_APPEND);
1405 if (fd == -1) {
1406 redisLog(REDIS_WARNING, "Not able to open the temp append only file produced by the child: %s", strerror(errno));
1407 goto cleanup;
1408 }
1409 /* Flush our data... */
1410 if (write(fd,server.bgrewritebuf,sdslen(server.bgrewritebuf)) !=
1411 (signed) sdslen(server.bgrewritebuf)) {
1412 redisLog(REDIS_WARNING, "Error or short write trying to flush the parent diff of the append log file in the child temp file: %s", strerror(errno));
1413 close(fd);
1414 goto cleanup;
1415 }
1416 redisLog(REDIS_NOTICE,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server.bgrewritebuf));
1417 /* Now our work is to rename the temp file into the stable file. And
1418 * switch the file descriptor used by the server for append only. */
1419 if (rename(tmpfile,server.appendfilename) == -1) {
1420 redisLog(REDIS_WARNING,"Can't rename the temp append only file into the stable one: %s", strerror(errno));
1421 close(fd);
1422 goto cleanup;
1423 }
1424 /* Mission completed... almost */
1425 redisLog(REDIS_NOTICE,"Append only file successfully rewritten.");
1426 if (server.appendfd != -1) {
1427 /* If append only is actually enabled... */
1428 close(server.appendfd);
1429 server.appendfd = fd;
1430 if (server.appendfsync != APPENDFSYNC_NO) aof_fsync(fd);
1431 server.appendseldb = -1; /* Make sure it will issue SELECT */
1432 redisLog(REDIS_NOTICE,"The new append only file was selected for future appends.");
1433 } else {
1434 /* If append only is disabled we just generate a dump in this
1435 * format. Why not? */
1436 close(fd);
1437 }
1438 } else if (!bysignal && exitcode != 0) {
1439 redisLog(REDIS_WARNING, "Background append only file rewriting error");
1440 } else {
1441 redisLog(REDIS_WARNING,
1442 "Background append only file rewriting terminated by signal %d",
1443 WTERMSIG(statloc));
1444 }
1445 cleanup:
1446 sdsfree(server.bgrewritebuf);
1447 server.bgrewritebuf = sdsempty();
1448 aofRemoveTempFile(server.bgrewritechildpid);
1449 server.bgrewritechildpid = -1;
1450 }
1451
1452 /* This function is called once a background process of some kind terminates,
1453 * as we want to avoid resizing the hash tables when there is a child in order
1454 * to play well with copy-on-write (otherwise when a resize happens lots of
1455 * memory pages are copied). The goal of this function is to update the ability
1456 * for dict.c to resize the hash tables accordingly to the fact we have o not
1457 * running childs. */
1458 static void updateDictResizePolicy(void) {
1459 if (server.bgsavechildpid == -1 && server.bgrewritechildpid == -1)
1460 dictEnableResize();
1461 else
1462 dictDisableResize();
1463 }
1464
1465 static int serverCron(struct aeEventLoop *eventLoop, long long id, void *clientData) {
1466 int j, loops = server.cronloops++;
1467 REDIS_NOTUSED(eventLoop);
1468 REDIS_NOTUSED(id);
1469 REDIS_NOTUSED(clientData);
1470
1471 /* We take a cached value of the unix time in the global state because
1472 * with virtual memory and aging there is to store the current time
1473 * in objects at every object access, and accuracy is not needed.
1474 * To access a global var is faster than calling time(NULL) */
1475 server.unixtime = time(NULL);
1476 /* We have just 21 bits per object for LRU information.
1477 * So we use an (eventually wrapping) LRU clock with minutes resolution.
1478 *
1479 * When we need to select what object to swap, we compute the minimum
1480 * time distance between the current lruclock and the object last access
1481 * lruclock info. Even if clocks will wrap on overflow, there is
1482 * the interesting property that we are sure that at least
1483 * ABS(A-B) minutes passed between current time and timestamp B.
1484 *
1485 * This is not precise but we don't need at all precision, but just
1486 * something statistically reasonable.
1487 */
1488 server.lruclock = (time(NULL)/60)&((1<<21)-1);
1489
1490 /* We received a SIGTERM, shutting down here in a safe way, as it is
1491 * not ok doing so inside the signal handler. */
1492 if (server.shutdown_asap) {
1493 if (prepareForShutdown() == REDIS_OK) exit(0);
1494 redisLog(REDIS_WARNING,"SIGTERM received but errors trying to shut down the server, check the logs for more information");
1495 }
1496
1497 /* Show some info about non-empty databases */
1498 for (j = 0; j < server.dbnum; j++) {
1499 long long size, used, vkeys;
1500
1501 size = dictSlots(server.db[j].dict);
1502 used = dictSize(server.db[j].dict);
1503 vkeys = dictSize(server.db[j].expires);
1504 if (!(loops % 50) && (used || vkeys)) {
1505 redisLog(REDIS_VERBOSE,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j,used,vkeys,size);
1506 /* dictPrintStats(server.dict); */
1507 }
1508 }
1509
1510 /* We don't want to resize the hash tables while a bacground saving
1511 * is in progress: the saving child is created using fork() that is
1512 * implemented with a copy-on-write semantic in most modern systems, so
1513 * if we resize the HT while there is the saving child at work actually
1514 * a lot of memory movements in the parent will cause a lot of pages
1515 * copied. */
1516 if (server.bgsavechildpid == -1 && server.bgrewritechildpid == -1) {
1517 if (!(loops % 10)) tryResizeHashTables();
1518 if (server.activerehashing) incrementallyRehash();
1519 }
1520
1521 /* Show information about connected clients */
1522 if (!(loops % 50)) {
1523 redisLog(REDIS_VERBOSE,"%d clients connected (%d slaves), %zu bytes in use",
1524 listLength(server.clients)-listLength(server.slaves),
1525 listLength(server.slaves),
1526 zmalloc_used_memory());
1527 }
1528
1529 /* Close connections of timedout clients */
1530 if ((server.maxidletime && !(loops % 100)) || server.blpop_blocked_clients)
1531 closeTimedoutClients();
1532
1533 /* Check if a background saving or AOF rewrite in progress terminated */
1534 if (server.bgsavechildpid != -1 || server.bgrewritechildpid != -1) {
1535 int statloc;
1536 pid_t pid;
1537
1538 if ((pid = wait3(&statloc,WNOHANG,NULL)) != 0) {
1539 if (pid == server.bgsavechildpid) {
1540 backgroundSaveDoneHandler(statloc);
1541 } else {
1542 backgroundRewriteDoneHandler(statloc);
1543 }
1544 updateDictResizePolicy();
1545 }
1546 } else {
1547 /* If there is not a background saving in progress check if
1548 * we have to save now */
1549 time_t now = time(NULL);
1550 for (j = 0; j < server.saveparamslen; j++) {
1551 struct saveparam *sp = server.saveparams+j;
1552
1553 if (server.dirty >= sp->changes &&
1554 now-server.lastsave > sp->seconds) {
1555 redisLog(REDIS_NOTICE,"%d changes in %d seconds. Saving...",
1556 sp->changes, sp->seconds);
1557 rdbSaveBackground(server.dbfilename);
1558 break;
1559 }
1560 }
1561 }
1562
1563 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1564 * will use few CPU cycles if there are few expiring keys, otherwise
1565 * it will get more aggressive to avoid that too much memory is used by
1566 * keys that can be removed from the keyspace. */
1567 for (j = 0; j < server.dbnum; j++) {
1568 int expired;
1569 redisDb *db = server.db+j;
1570
1571 /* Continue to expire if at the end of the cycle more than 25%
1572 * of the keys were expired. */
1573 do {
1574 long num = dictSize(db->expires);
1575 time_t now = time(NULL);
1576
1577 expired = 0;
1578 if (num > REDIS_EXPIRELOOKUPS_PER_CRON)
1579 num = REDIS_EXPIRELOOKUPS_PER_CRON;
1580 while (num--) {
1581 dictEntry *de;
1582 time_t t;
1583
1584 if ((de = dictGetRandomKey(db->expires)) == NULL) break;
1585 t = (time_t) dictGetEntryVal(de);
1586 if (now > t) {
1587 sds key = dictGetEntryKey(de);
1588 robj *keyobj = createStringObject(key,sdslen(key));
1589
1590 dbDelete(db,keyobj);
1591 decrRefCount(keyobj);
1592 expired++;
1593 server.stat_expiredkeys++;
1594 }
1595 }
1596 } while (expired > REDIS_EXPIRELOOKUPS_PER_CRON/4);
1597 }
1598
1599 /* Swap a few keys on disk if we are over the memory limit and VM
1600 * is enbled. Try to free objects from the free list first. */
1601 if (vmCanSwapOut()) {
1602 while (server.vm_enabled && zmalloc_used_memory() >
1603 server.vm_max_memory)
1604 {
1605 int retval;
1606
1607 if (tryFreeOneObjectFromFreelist() == REDIS_OK) continue;
1608 retval = (server.vm_max_threads == 0) ?
1609 vmSwapOneObjectBlocking() :
1610 vmSwapOneObjectThreaded();
1611 if (retval == REDIS_ERR && !(loops % 300) &&
1612 zmalloc_used_memory() >
1613 (server.vm_max_memory+server.vm_max_memory/10))
1614 {
1615 redisLog(REDIS_WARNING,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1616 }
1617 /* Note that when using threade I/O we free just one object,
1618 * because anyway when the I/O thread in charge to swap this
1619 * object out will finish, the handler of completed jobs
1620 * will try to swap more objects if we are still out of memory. */
1621 if (retval == REDIS_ERR || server.vm_max_threads > 0) break;
1622 }
1623 }
1624
1625 /* Check if we should connect to a MASTER */
1626 if (server.replstate == REDIS_REPL_CONNECT && !(loops % 10)) {
1627 redisLog(REDIS_NOTICE,"Connecting to MASTER...");
1628 if (syncWithMaster() == REDIS_OK) {
1629 redisLog(REDIS_NOTICE,"MASTER <-> SLAVE sync succeeded");
1630 if (server.appendonly) rewriteAppendOnlyFileBackground();
1631 }
1632 }
1633 return 100;
1634 }
1635
1636 /* This function gets called every time Redis is entering the
1637 * main loop of the event driven library, that is, before to sleep
1638 * for ready file descriptors. */
1639 static void beforeSleep(struct aeEventLoop *eventLoop) {
1640 REDIS_NOTUSED(eventLoop);
1641
1642 /* Awake clients that got all the swapped keys they requested */
1643 if (server.vm_enabled && listLength(server.io_ready_clients)) {
1644 listIter li;
1645 listNode *ln;
1646
1647 listRewind(server.io_ready_clients,&li);
1648 while((ln = listNext(&li))) {
1649 redisClient *c = ln->value;
1650 struct redisCommand *cmd;
1651
1652 /* Resume the client. */
1653 listDelNode(server.io_ready_clients,ln);
1654 c->flags &= (~REDIS_IO_WAIT);
1655 server.vm_blocked_clients--;
1656 aeCreateFileEvent(server.el, c->fd, AE_READABLE,
1657 readQueryFromClient, c);
1658 cmd = lookupCommand(c->argv[0]->ptr);
1659 assert(cmd != NULL);
1660 call(c,cmd);
1661 resetClient(c);
1662 /* There may be more data to process in the input buffer. */
1663 if (c->querybuf && sdslen(c->querybuf) > 0)
1664 processInputBuffer(c);
1665 }
1666 }
1667 /* Write the AOF buffer on disk */
1668 flushAppendOnlyFile();
1669 }
1670
1671 static void createSharedObjects(void) {
1672 int j;
1673
1674 shared.crlf = createObject(REDIS_STRING,sdsnew("\r\n"));
1675 shared.ok = createObject(REDIS_STRING,sdsnew("+OK\r\n"));
1676 shared.err = createObject(REDIS_STRING,sdsnew("-ERR\r\n"));
1677 shared.emptybulk = createObject(REDIS_STRING,sdsnew("$0\r\n\r\n"));
1678 shared.czero = createObject(REDIS_STRING,sdsnew(":0\r\n"));
1679 shared.cone = createObject(REDIS_STRING,sdsnew(":1\r\n"));
1680 shared.nullbulk = createObject(REDIS_STRING,sdsnew("$-1\r\n"));
1681 shared.nullmultibulk = createObject(REDIS_STRING,sdsnew("*-1\r\n"));
1682 shared.emptymultibulk = createObject(REDIS_STRING,sdsnew("*0\r\n"));
1683 shared.pong = createObject(REDIS_STRING,sdsnew("+PONG\r\n"));
1684 shared.queued = createObject(REDIS_STRING,sdsnew("+QUEUED\r\n"));
1685 shared.wrongtypeerr = createObject(REDIS_STRING,sdsnew(
1686 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1687 shared.nokeyerr = createObject(REDIS_STRING,sdsnew(
1688 "-ERR no such key\r\n"));
1689 shared.syntaxerr = createObject(REDIS_STRING,sdsnew(
1690 "-ERR syntax error\r\n"));
1691 shared.sameobjecterr = createObject(REDIS_STRING,sdsnew(
1692 "-ERR source and destination objects are the same\r\n"));
1693 shared.outofrangeerr = createObject(REDIS_STRING,sdsnew(
1694 "-ERR index out of range\r\n"));
1695 shared.space = createObject(REDIS_STRING,sdsnew(" "));
1696 shared.colon = createObject(REDIS_STRING,sdsnew(":"));
1697 shared.plus = createObject(REDIS_STRING,sdsnew("+"));
1698 shared.select0 = createStringObject("select 0\r\n",10);
1699 shared.select1 = createStringObject("select 1\r\n",10);
1700 shared.select2 = createStringObject("select 2\r\n",10);
1701 shared.select3 = createStringObject("select 3\r\n",10);
1702 shared.select4 = createStringObject("select 4\r\n",10);
1703 shared.select5 = createStringObject("select 5\r\n",10);
1704 shared.select6 = createStringObject("select 6\r\n",10);
1705 shared.select7 = createStringObject("select 7\r\n",10);
1706 shared.select8 = createStringObject("select 8\r\n",10);
1707 shared.select9 = createStringObject("select 9\r\n",10);
1708 shared.messagebulk = createStringObject("$7\r\nmessage\r\n",13);
1709 shared.pmessagebulk = createStringObject("$8\r\npmessage\r\n",14);
1710 shared.subscribebulk = createStringObject("$9\r\nsubscribe\r\n",15);
1711 shared.unsubscribebulk = createStringObject("$11\r\nunsubscribe\r\n",18);
1712 shared.psubscribebulk = createStringObject("$10\r\npsubscribe\r\n",17);
1713 shared.punsubscribebulk = createStringObject("$12\r\npunsubscribe\r\n",19);
1714 shared.mbulk3 = createStringObject("*3\r\n",4);
1715 shared.mbulk4 = createStringObject("*4\r\n",4);
1716 for (j = 0; j < REDIS_SHARED_INTEGERS; j++) {
1717 shared.integers[j] = createObject(REDIS_STRING,(void*)(long)j);
1718 shared.integers[j]->encoding = REDIS_ENCODING_INT;
1719 }
1720 }
1721
1722 static void appendServerSaveParams(time_t seconds, int changes) {
1723 server.saveparams = zrealloc(server.saveparams,sizeof(struct saveparam)*(server.saveparamslen+1));
1724 server.saveparams[server.saveparamslen].seconds = seconds;
1725 server.saveparams[server.saveparamslen].changes = changes;
1726 server.saveparamslen++;
1727 }
1728
1729 static void resetServerSaveParams() {
1730 zfree(server.saveparams);
1731 server.saveparams = NULL;
1732 server.saveparamslen = 0;
1733 }
1734
1735 static void initServerConfig() {
1736 server.dbnum = REDIS_DEFAULT_DBNUM;
1737 server.port = REDIS_SERVERPORT;
1738 server.verbosity = REDIS_VERBOSE;
1739 server.maxidletime = REDIS_MAXIDLETIME;
1740 server.saveparams = NULL;
1741 server.logfile = NULL; /* NULL = log on standard output */
1742 server.bindaddr = NULL;
1743 server.glueoutputbuf = 1;
1744 server.daemonize = 0;
1745 server.appendonly = 0;
1746 server.appendfsync = APPENDFSYNC_EVERYSEC;
1747 server.no_appendfsync_on_rewrite = 0;
1748 server.lastfsync = time(NULL);
1749 server.appendfd = -1;
1750 server.appendseldb = -1; /* Make sure the first time will not match */
1751 server.pidfile = zstrdup("/var/run/redis.pid");
1752 server.dbfilename = zstrdup("dump.rdb");
1753 server.appendfilename = zstrdup("appendonly.aof");
1754 server.requirepass = NULL;
1755 server.rdbcompression = 1;
1756 server.activerehashing = 1;
1757 server.maxclients = 0;
1758 server.blpop_blocked_clients = 0;
1759 server.maxmemory = 0;
1760 server.vm_enabled = 0;
1761 server.vm_swap_file = zstrdup("/tmp/redis-%p.vm");
1762 server.vm_page_size = 256; /* 256 bytes per page */
1763 server.vm_pages = 1024*1024*100; /* 104 millions of pages */
1764 server.vm_max_memory = 1024LL*1024*1024*1; /* 1 GB of RAM */
1765 server.vm_max_threads = 4;
1766 server.vm_blocked_clients = 0;
1767 server.hash_max_zipmap_entries = REDIS_HASH_MAX_ZIPMAP_ENTRIES;
1768 server.hash_max_zipmap_value = REDIS_HASH_MAX_ZIPMAP_VALUE;
1769 server.list_max_ziplist_entries = REDIS_LIST_MAX_ZIPLIST_ENTRIES;
1770 server.list_max_ziplist_value = REDIS_LIST_MAX_ZIPLIST_VALUE;
1771 server.shutdown_asap = 0;
1772
1773 resetServerSaveParams();
1774
1775 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1776 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1777 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1778 /* Replication related */
1779 server.isslave = 0;
1780 server.masterauth = NULL;
1781 server.masterhost = NULL;
1782 server.masterport = 6379;
1783 server.master = NULL;
1784 server.replstate = REDIS_REPL_NONE;
1785
1786 /* Double constants initialization */
1787 R_Zero = 0.0;
1788 R_PosInf = 1.0/R_Zero;
1789 R_NegInf = -1.0/R_Zero;
1790 R_Nan = R_Zero/R_Zero;
1791 }
1792
1793 static void initServer() {
1794 int j;
1795
1796 signal(SIGHUP, SIG_IGN);
1797 signal(SIGPIPE, SIG_IGN);
1798 setupSigSegvAction();
1799
1800 server.devnull = fopen("/dev/null","w");
1801 if (server.devnull == NULL) {
1802 redisLog(REDIS_WARNING, "Can't open /dev/null: %s", server.neterr);
1803 exit(1);
1804 }
1805 server.clients = listCreate();
1806 server.slaves = listCreate();
1807 server.monitors = listCreate();
1808 server.objfreelist = listCreate();
1809 createSharedObjects();
1810 server.el = aeCreateEventLoop();
1811 server.db = zmalloc(sizeof(redisDb)*server.dbnum);
1812 server.fd = anetTcpServer(server.neterr, server.port, server.bindaddr);
1813 if (server.fd == -1) {
1814 redisLog(REDIS_WARNING, "Opening TCP port: %s", server.neterr);
1815 exit(1);
1816 }
1817 for (j = 0; j < server.dbnum; j++) {
1818 server.db[j].dict = dictCreate(&dbDictType,NULL);
1819 server.db[j].expires = dictCreate(&keyptrDictType,NULL);
1820 server.db[j].blocking_keys = dictCreate(&keylistDictType,NULL);
1821 server.db[j].watched_keys = dictCreate(&keylistDictType,NULL);
1822 if (server.vm_enabled)
1823 server.db[j].io_keys = dictCreate(&keylistDictType,NULL);
1824 server.db[j].id = j;
1825 }
1826 server.pubsub_channels = dictCreate(&keylistDictType,NULL);
1827 server.pubsub_patterns = listCreate();
1828 listSetFreeMethod(server.pubsub_patterns,freePubsubPattern);
1829 listSetMatchMethod(server.pubsub_patterns,listMatchPubsubPattern);
1830 server.cronloops = 0;
1831 server.bgsavechildpid = -1;
1832 server.bgrewritechildpid = -1;
1833 server.bgrewritebuf = sdsempty();
1834 server.aofbuf = sdsempty();
1835 server.lastsave = time(NULL);
1836 server.dirty = 0;
1837 server.stat_numcommands = 0;
1838 server.stat_numconnections = 0;
1839 server.stat_expiredkeys = 0;
1840 server.stat_starttime = time(NULL);
1841 server.unixtime = time(NULL);
1842 aeCreateTimeEvent(server.el, 1, serverCron, NULL, NULL);
1843 if (aeCreateFileEvent(server.el, server.fd, AE_READABLE,
1844 acceptHandler, NULL) == AE_ERR) oom("creating file event");
1845
1846 if (server.appendonly) {
1847 server.appendfd = open(server.appendfilename,O_WRONLY|O_APPEND|O_CREAT,0644);
1848 if (server.appendfd == -1) {
1849 redisLog(REDIS_WARNING, "Can't open the append-only file: %s",
1850 strerror(errno));
1851 exit(1);
1852 }
1853 }
1854
1855 if (server.vm_enabled) vmInit();
1856 }
1857
1858 /* Empty the whole database */
1859 static long long emptyDb() {
1860 int j;
1861 long long removed = 0;
1862
1863 for (j = 0; j < server.dbnum; j++) {
1864 removed += dictSize(server.db[j].dict);
1865 dictEmpty(server.db[j].dict);
1866 dictEmpty(server.db[j].expires);
1867 }
1868 return removed;
1869 }
1870
1871 static int yesnotoi(char *s) {
1872 if (!strcasecmp(s,"yes")) return 1;
1873 else if (!strcasecmp(s,"no")) return 0;
1874 else return -1;
1875 }
1876
1877 /* I agree, this is a very rudimental way to load a configuration...
1878 will improve later if the config gets more complex */
1879 static void loadServerConfig(char *filename) {
1880 FILE *fp;
1881 char buf[REDIS_CONFIGLINE_MAX+1], *err = NULL;
1882 int linenum = 0;
1883 sds line = NULL;
1884
1885 if (filename[0] == '-' && filename[1] == '\0')
1886 fp = stdin;
1887 else {
1888 if ((fp = fopen(filename,"r")) == NULL) {
1889 redisLog(REDIS_WARNING, "Fatal error, can't open config file '%s'", filename);
1890 exit(1);
1891 }
1892 }
1893
1894 while(fgets(buf,REDIS_CONFIGLINE_MAX+1,fp) != NULL) {
1895 sds *argv;
1896 int argc, j;
1897
1898 linenum++;
1899 line = sdsnew(buf);
1900 line = sdstrim(line," \t\r\n");
1901
1902 /* Skip comments and blank lines*/
1903 if (line[0] == '#' || line[0] == '\0') {
1904 sdsfree(line);
1905 continue;
1906 }
1907
1908 /* Split into arguments */
1909 argv = sdssplitlen(line,sdslen(line)," ",1,&argc);
1910 sdstolower(argv[0]);
1911
1912 /* Execute config directives */
1913 if (!strcasecmp(argv[0],"timeout") && argc == 2) {
1914 server.maxidletime = atoi(argv[1]);
1915 if (server.maxidletime < 0) {
1916 err = "Invalid timeout value"; goto loaderr;
1917 }
1918 } else if (!strcasecmp(argv[0],"port") && argc == 2) {
1919 server.port = atoi(argv[1]);
1920 if (server.port < 1 || server.port > 65535) {
1921 err = "Invalid port"; goto loaderr;
1922 }
1923 } else if (!strcasecmp(argv[0],"bind") && argc == 2) {
1924 server.bindaddr = zstrdup(argv[1]);
1925 } else if (!strcasecmp(argv[0],"save") && argc == 3) {
1926 int seconds = atoi(argv[1]);
1927 int changes = atoi(argv[2]);
1928 if (seconds < 1 || changes < 0) {
1929 err = "Invalid save parameters"; goto loaderr;
1930 }
1931 appendServerSaveParams(seconds,changes);
1932 } else if (!strcasecmp(argv[0],"dir") && argc == 2) {
1933 if (chdir(argv[1]) == -1) {
1934 redisLog(REDIS_WARNING,"Can't chdir to '%s': %s",
1935 argv[1], strerror(errno));
1936 exit(1);
1937 }
1938 } else if (!strcasecmp(argv[0],"loglevel") && argc == 2) {
1939 if (!strcasecmp(argv[1],"debug")) server.verbosity = REDIS_DEBUG;
1940 else if (!strcasecmp(argv[1],"verbose")) server.verbosity = REDIS_VERBOSE;
1941 else if (!strcasecmp(argv[1],"notice")) server.verbosity = REDIS_NOTICE;
1942 else if (!strcasecmp(argv[1],"warning")) server.verbosity = REDIS_WARNING;
1943 else {
1944 err = "Invalid log level. Must be one of debug, notice, warning";
1945 goto loaderr;
1946 }
1947 } else if (!strcasecmp(argv[0],"logfile") && argc == 2) {
1948 FILE *logfp;
1949
1950 server.logfile = zstrdup(argv[1]);
1951 if (!strcasecmp(server.logfile,"stdout")) {
1952 zfree(server.logfile);
1953 server.logfile = NULL;
1954 }
1955 if (server.logfile) {
1956 /* Test if we are able to open the file. The server will not
1957 * be able to abort just for this problem later... */
1958 logfp = fopen(server.logfile,"a");
1959 if (logfp == NULL) {
1960 err = sdscatprintf(sdsempty(),
1961 "Can't open the log file: %s", strerror(errno));
1962 goto loaderr;
1963 }
1964 fclose(logfp);
1965 }
1966 } else if (!strcasecmp(argv[0],"databases") && argc == 2) {
1967 server.dbnum = atoi(argv[1]);
1968 if (server.dbnum < 1) {
1969 err = "Invalid number of databases"; goto loaderr;
1970 }
1971 } else if (!strcasecmp(argv[0],"include") && argc == 2) {
1972 loadServerConfig(argv[1]);
1973 } else if (!strcasecmp(argv[0],"maxclients") && argc == 2) {
1974 server.maxclients = atoi(argv[1]);
1975 } else if (!strcasecmp(argv[0],"maxmemory") && argc == 2) {
1976 server.maxmemory = memtoll(argv[1],NULL);
1977 } else if (!strcasecmp(argv[0],"slaveof") && argc == 3) {
1978 server.masterhost = sdsnew(argv[1]);
1979 server.masterport = atoi(argv[2]);
1980 server.replstate = REDIS_REPL_CONNECT;
1981 } else if (!strcasecmp(argv[0],"masterauth") && argc == 2) {
1982 server.masterauth = zstrdup(argv[1]);
1983 } else if (!strcasecmp(argv[0],"glueoutputbuf") && argc == 2) {
1984 if ((server.glueoutputbuf = yesnotoi(argv[1])) == -1) {
1985 err = "argument must be 'yes' or 'no'"; goto loaderr;
1986 }
1987 } else if (!strcasecmp(argv[0],"rdbcompression") && argc == 2) {
1988 if ((server.rdbcompression = yesnotoi(argv[1])) == -1) {
1989 err = "argument must be 'yes' or 'no'"; goto loaderr;
1990 }
1991 } else if (!strcasecmp(argv[0],"activerehashing") && argc == 2) {
1992 if ((server.activerehashing = yesnotoi(argv[1])) == -1) {
1993 err = "argument must be 'yes' or 'no'"; goto loaderr;
1994 }
1995 } else if (!strcasecmp(argv[0],"daemonize") && argc == 2) {
1996 if ((server.daemonize = yesnotoi(argv[1])) == -1) {
1997 err = "argument must be 'yes' or 'no'"; goto loaderr;
1998 }
1999 } else if (!strcasecmp(argv[0],"appendonly") && argc == 2) {
2000 if ((server.appendonly = yesnotoi(argv[1])) == -1) {
2001 err = "argument must be 'yes' or 'no'"; goto loaderr;
2002 }
2003 } else if (!strcasecmp(argv[0],"appendfilename") && argc == 2) {
2004 zfree(server.appendfilename);
2005 server.appendfilename = zstrdup(argv[1]);
2006 } else if (!strcasecmp(argv[0],"no-appendfsync-on-rewrite")
2007 && argc == 2) {
2008 if ((server.no_appendfsync_on_rewrite= yesnotoi(argv[1])) == -1) {
2009 err = "argument must be 'yes' or 'no'"; goto loaderr;
2010 }
2011 } else if (!strcasecmp(argv[0],"appendfsync") && argc == 2) {
2012 if (!strcasecmp(argv[1],"no")) {
2013 server.appendfsync = APPENDFSYNC_NO;
2014 } else if (!strcasecmp(argv[1],"always")) {
2015 server.appendfsync = APPENDFSYNC_ALWAYS;
2016 } else if (!strcasecmp(argv[1],"everysec")) {
2017 server.appendfsync = APPENDFSYNC_EVERYSEC;
2018 } else {
2019 err = "argument must be 'no', 'always' or 'everysec'";
2020 goto loaderr;
2021 }
2022 } else if (!strcasecmp(argv[0],"requirepass") && argc == 2) {
2023 server.requirepass = zstrdup(argv[1]);
2024 } else if (!strcasecmp(argv[0],"pidfile") && argc == 2) {
2025 zfree(server.pidfile);
2026 server.pidfile = zstrdup(argv[1]);
2027 } else if (!strcasecmp(argv[0],"dbfilename") && argc == 2) {
2028 zfree(server.dbfilename);
2029 server.dbfilename = zstrdup(argv[1]);
2030 } else if (!strcasecmp(argv[0],"vm-enabled") && argc == 2) {
2031 if ((server.vm_enabled = yesnotoi(argv[1])) == -1) {
2032 err = "argument must be 'yes' or 'no'"; goto loaderr;
2033 }
2034 } else if (!strcasecmp(argv[0],"vm-swap-file") && argc == 2) {
2035 zfree(server.vm_swap_file);
2036 server.vm_swap_file = zstrdup(argv[1]);
2037 } else if (!strcasecmp(argv[0],"vm-max-memory") && argc == 2) {
2038 server.vm_max_memory = memtoll(argv[1],NULL);
2039 } else if (!strcasecmp(argv[0],"vm-page-size") && argc == 2) {
2040 server.vm_page_size = memtoll(argv[1], NULL);
2041 } else if (!strcasecmp(argv[0],"vm-pages") && argc == 2) {
2042 server.vm_pages = memtoll(argv[1], NULL);
2043 } else if (!strcasecmp(argv[0],"vm-max-threads") && argc == 2) {
2044 server.vm_max_threads = strtoll(argv[1], NULL, 10);
2045 } else if (!strcasecmp(argv[0],"hash-max-zipmap-entries") && argc == 2){
2046 server.hash_max_zipmap_entries = memtoll(argv[1], NULL);
2047 } else if (!strcasecmp(argv[0],"hash-max-zipmap-value") && argc == 2){
2048 server.hash_max_zipmap_value = memtoll(argv[1], NULL);
2049 } else if (!strcasecmp(argv[0],"list-max-ziplist-entries") && argc == 2){
2050 server.list_max_ziplist_entries = memtoll(argv[1], NULL);
2051 } else if (!strcasecmp(argv[0],"list-max-ziplist-value") && argc == 2){
2052 server.list_max_ziplist_value = memtoll(argv[1], NULL);
2053 } else {
2054 err = "Bad directive or wrong number of arguments"; goto loaderr;
2055 }
2056 for (j = 0; j < argc; j++)
2057 sdsfree(argv[j]);
2058 zfree(argv);
2059 sdsfree(line);
2060 }
2061 if (fp != stdin) fclose(fp);
2062 return;
2063
2064 loaderr:
2065 fprintf(stderr, "\n*** FATAL CONFIG FILE ERROR ***\n");
2066 fprintf(stderr, "Reading the configuration file, at line %d\n", linenum);
2067 fprintf(stderr, ">>> '%s'\n", line);
2068 fprintf(stderr, "%s\n", err);
2069 exit(1);
2070 }
2071
2072 static void freeClientArgv(redisClient *c) {
2073 int j;
2074
2075 for (j = 0; j < c->argc; j++)
2076 decrRefCount(c->argv[j]);
2077 for (j = 0; j < c->mbargc; j++)
2078 decrRefCount(c->mbargv[j]);
2079 c->argc = 0;
2080 c->mbargc = 0;
2081 }
2082
2083 static void freeClient(redisClient *c) {
2084 listNode *ln;
2085
2086 /* Note that if the client we are freeing is blocked into a blocking
2087 * call, we have to set querybuf to NULL *before* to call
2088 * unblockClientWaitingData() to avoid processInputBuffer() will get
2089 * called. Also it is important to remove the file events after
2090 * this, because this call adds the READABLE event. */
2091 sdsfree(c->querybuf);
2092 c->querybuf = NULL;
2093 if (c->flags & REDIS_BLOCKED)
2094 unblockClientWaitingData(c);
2095
2096 /* UNWATCH all the keys */
2097 unwatchAllKeys(c);
2098 listRelease(c->watched_keys);
2099 /* Unsubscribe from all the pubsub channels */
2100 pubsubUnsubscribeAllChannels(c,0);
2101 pubsubUnsubscribeAllPatterns(c,0);
2102 dictRelease(c->pubsub_channels);
2103 listRelease(c->pubsub_patterns);
2104 /* Obvious cleanup */
2105 aeDeleteFileEvent(server.el,c->fd,AE_READABLE);
2106 aeDeleteFileEvent(server.el,c->fd,AE_WRITABLE);
2107 listRelease(c->reply);
2108 freeClientArgv(c);
2109 close(c->fd);
2110 /* Remove from the list of clients */
2111 ln = listSearchKey(server.clients,c);
2112 redisAssert(ln != NULL);
2113 listDelNode(server.clients,ln);
2114 /* Remove from the list of clients that are now ready to be restarted
2115 * after waiting for swapped keys */
2116 if (c->flags & REDIS_IO_WAIT && listLength(c->io_keys) == 0) {
2117 ln = listSearchKey(server.io_ready_clients,c);
2118 if (ln) {
2119 listDelNode(server.io_ready_clients,ln);
2120 server.vm_blocked_clients--;
2121 }
2122 }
2123 /* Remove from the list of clients waiting for swapped keys */
2124 while (server.vm_enabled && listLength(c->io_keys)) {
2125 ln = listFirst(c->io_keys);
2126 dontWaitForSwappedKey(c,ln->value);
2127 }
2128 listRelease(c->io_keys);
2129 /* Master/slave cleanup */
2130 if (c->flags & REDIS_SLAVE) {
2131 if (c->replstate == REDIS_REPL_SEND_BULK && c->repldbfd != -1)
2132 close(c->repldbfd);
2133 list *l = (c->flags & REDIS_MONITOR) ? server.monitors : server.slaves;
2134 ln = listSearchKey(l,c);
2135 redisAssert(ln != NULL);
2136 listDelNode(l,ln);
2137 }
2138 if (c->flags & REDIS_MASTER) {
2139 server.master = NULL;
2140 server.replstate = REDIS_REPL_CONNECT;
2141 }
2142 /* Release memory */
2143 zfree(c->argv);
2144 zfree(c->mbargv);
2145 freeClientMultiState(c);
2146 zfree(c);
2147 }
2148
2149 #define GLUEREPLY_UP_TO (1024)
2150 static void glueReplyBuffersIfNeeded(redisClient *c) {
2151 int copylen = 0;
2152 char buf[GLUEREPLY_UP_TO];
2153 listNode *ln;
2154 listIter li;
2155 robj *o;
2156
2157 listRewind(c->reply,&li);
2158 while((ln = listNext(&li))) {
2159 int objlen;
2160
2161 o = ln->value;
2162 objlen = sdslen(o->ptr);
2163 if (copylen + objlen <= GLUEREPLY_UP_TO) {
2164 memcpy(buf+copylen,o->ptr,objlen);
2165 copylen += objlen;
2166 listDelNode(c->reply,ln);
2167 } else {
2168 if (copylen == 0) return;
2169 break;
2170 }
2171 }
2172 /* Now the output buffer is empty, add the new single element */
2173 o = createObject(REDIS_STRING,sdsnewlen(buf,copylen));
2174 listAddNodeHead(c->reply,o);
2175 }
2176
2177 static void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask) {
2178 redisClient *c = privdata;
2179 int nwritten = 0, totwritten = 0, objlen;
2180 robj *o;
2181 REDIS_NOTUSED(el);
2182 REDIS_NOTUSED(mask);
2183
2184 /* Use writev() if we have enough buffers to send */
2185 if (!server.glueoutputbuf &&
2186 listLength(c->reply) > REDIS_WRITEV_THRESHOLD &&
2187 !(c->flags & REDIS_MASTER))
2188 {
2189 sendReplyToClientWritev(el, fd, privdata, mask);
2190 return;
2191 }
2192
2193 while(listLength(c->reply)) {
2194 if (server.glueoutputbuf && listLength(c->reply) > 1)
2195 glueReplyBuffersIfNeeded(c);
2196
2197 o = listNodeValue(listFirst(c->reply));
2198 objlen = sdslen(o->ptr);
2199
2200 if (objlen == 0) {
2201 listDelNode(c->reply,listFirst(c->reply));
2202 continue;
2203 }
2204
2205 if (c->flags & REDIS_MASTER) {
2206 /* Don't reply to a master */
2207 nwritten = objlen - c->sentlen;
2208 } else {
2209 nwritten = write(fd, ((char*)o->ptr)+c->sentlen, objlen - c->sentlen);
2210 if (nwritten <= 0) break;
2211 }
2212 c->sentlen += nwritten;
2213 totwritten += nwritten;
2214 /* If we fully sent the object on head go to the next one */
2215 if (c->sentlen == objlen) {
2216 listDelNode(c->reply,listFirst(c->reply));
2217 c->sentlen = 0;
2218 }
2219 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
2220 * bytes, in a single threaded server it's a good idea to serve
2221 * other clients as well, even if a very large request comes from
2222 * super fast link that is always able to accept data (in real world
2223 * scenario think about 'KEYS *' against the loopback interfae) */
2224 if (totwritten > REDIS_MAX_WRITE_PER_EVENT) break;
2225 }
2226 if (nwritten == -1) {
2227 if (errno == EAGAIN) {
2228 nwritten = 0;
2229 } else {
2230 redisLog(REDIS_VERBOSE,
2231 "Error writing to client: %s", strerror(errno));
2232 freeClient(c);
2233 return;
2234 }
2235 }
2236 if (totwritten > 0) c->lastinteraction = time(NULL);
2237 if (listLength(c->reply) == 0) {
2238 c->sentlen = 0;
2239 aeDeleteFileEvent(server.el,c->fd,AE_WRITABLE);
2240 }
2241 }
2242
2243 static void sendReplyToClientWritev(aeEventLoop *el, int fd, void *privdata, int mask)
2244 {
2245 redisClient *c = privdata;
2246 int nwritten = 0, totwritten = 0, objlen, willwrite;
2247 robj *o;
2248 struct iovec iov[REDIS_WRITEV_IOVEC_COUNT];
2249 int offset, ion = 0;
2250 REDIS_NOTUSED(el);
2251 REDIS_NOTUSED(mask);
2252
2253 listNode *node;
2254 while (listLength(c->reply)) {
2255 offset = c->sentlen;
2256 ion = 0;
2257 willwrite = 0;
2258
2259 /* fill-in the iov[] array */
2260 for(node = listFirst(c->reply); node; node = listNextNode(node)) {
2261 o = listNodeValue(node);
2262 objlen = sdslen(o->ptr);
2263
2264 if (totwritten + objlen - offset > REDIS_MAX_WRITE_PER_EVENT)
2265 break;
2266
2267 if(ion == REDIS_WRITEV_IOVEC_COUNT)
2268 break; /* no more iovecs */
2269
2270 iov[ion].iov_base = ((char*)o->ptr) + offset;
2271 iov[ion].iov_len = objlen - offset;
2272 willwrite += objlen - offset;
2273 offset = 0; /* just for the first item */
2274 ion++;
2275 }
2276
2277 if(willwrite == 0)
2278 break;
2279
2280 /* write all collected blocks at once */
2281 if((nwritten = writev(fd, iov, ion)) < 0) {
2282 if (errno != EAGAIN) {
2283 redisLog(REDIS_VERBOSE,
2284 "Error writing to client: %s", strerror(errno));
2285 freeClient(c);
2286 return;
2287 }
2288 break;
2289 }
2290
2291 totwritten += nwritten;
2292 offset = c->sentlen;
2293
2294 /* remove written robjs from c->reply */
2295 while (nwritten && listLength(c->reply)) {
2296 o = listNodeValue(listFirst(c->reply));
2297 objlen = sdslen(o->ptr);
2298
2299 if(nwritten >= objlen - offset) {
2300 listDelNode(c->reply, listFirst(c->reply));
2301 nwritten -= objlen - offset;
2302 c->sentlen = 0;
2303 } else {
2304 /* partial write */
2305 c->sentlen += nwritten;
2306 break;
2307 }
2308 offset = 0;
2309 }
2310 }
2311
2312 if (totwritten > 0)
2313 c->lastinteraction = time(NULL);
2314
2315 if (listLength(c->reply) == 0) {
2316 c->sentlen = 0;
2317 aeDeleteFileEvent(server.el,c->fd,AE_WRITABLE);
2318 }
2319 }
2320
2321 static int qsortRedisCommands(const void *r1, const void *r2) {
2322 return strcasecmp(
2323 ((struct redisCommand*)r1)->name,
2324 ((struct redisCommand*)r2)->name);
2325 }
2326
2327 static void sortCommandTable() {
2328 /* Copy and sort the read-only version of the command table */
2329 commandTable = (struct redisCommand*)malloc(sizeof(readonlyCommandTable));
2330 memcpy(commandTable,readonlyCommandTable,sizeof(readonlyCommandTable));
2331 qsort(commandTable,
2332 sizeof(readonlyCommandTable)/sizeof(struct redisCommand),
2333 sizeof(struct redisCommand),qsortRedisCommands);
2334 }
2335
2336 static struct redisCommand *lookupCommand(char *name) {
2337 struct redisCommand tmp = {name,NULL,0,0,NULL,0,0,0};
2338 return bsearch(
2339 &tmp,
2340 commandTable,
2341 sizeof(readonlyCommandTable)/sizeof(struct redisCommand),
2342 sizeof(struct redisCommand),
2343 qsortRedisCommands);
2344 }
2345
2346 /* resetClient prepare the client to process the next command */
2347 static void resetClient(redisClient *c) {
2348 freeClientArgv(c);
2349 c->bulklen = -1;
2350 c->multibulk = 0;
2351 }
2352
2353 /* Call() is the core of Redis execution of a command */
2354 static void call(redisClient *c, struct redisCommand *cmd) {
2355 long long dirty;
2356
2357 dirty = server.dirty;
2358 cmd->proc(c);
2359 dirty = server.dirty-dirty;
2360
2361 if (server.appendonly && dirty)
2362 feedAppendOnlyFile(cmd,c->db->id,c->argv,c->argc);
2363 if ((dirty || cmd->flags & REDIS_CMD_FORCE_REPLICATION) &&
2364 listLength(server.slaves))
2365 replicationFeedSlaves(server.slaves,c->db->id,c->argv,c->argc);
2366 if (listLength(server.monitors))
2367 replicationFeedMonitors(server.monitors,c->db->id,c->argv,c->argc);
2368 server.stat_numcommands++;
2369 }
2370
2371 /* If this function gets called we already read a whole
2372 * command, argments are in the client argv/argc fields.
2373 * processCommand() execute the command or prepare the
2374 * server for a bulk read from the client.
2375 *
2376 * If 1 is returned the client is still alive and valid and
2377 * and other operations can be performed by the caller. Otherwise
2378 * if 0 is returned the client was destroied (i.e. after QUIT). */
2379 static int processCommand(redisClient *c) {
2380 struct redisCommand *cmd;
2381
2382 /* Free some memory if needed (maxmemory setting) */
2383 if (server.maxmemory) freeMemoryIfNeeded();
2384
2385 /* Handle the multi bulk command type. This is an alternative protocol
2386 * supported by Redis in order to receive commands that are composed of
2387 * multiple binary-safe "bulk" arguments. The latency of processing is
2388 * a bit higher but this allows things like multi-sets, so if this
2389 * protocol is used only for MSET and similar commands this is a big win. */
2390 if (c->multibulk == 0 && c->argc == 1 && ((char*)(c->argv[0]->ptr))[0] == '*') {
2391 c->multibulk = atoi(((char*)c->argv[0]->ptr)+1);
2392 if (c->multibulk <= 0) {
2393 resetClient(c);
2394 return 1;
2395 } else {
2396 decrRefCount(c->argv[c->argc-1]);
2397 c->argc--;
2398 return 1;
2399 }
2400 } else if (c->multibulk) {
2401 if (c->bulklen == -1) {
2402 if (((char*)c->argv[0]->ptr)[0] != '$') {
2403 addReplySds(c,sdsnew("-ERR multi bulk protocol error\r\n"));
2404 resetClient(c);
2405 return 1;
2406 } else {
2407 int bulklen = atoi(((char*)c->argv[0]->ptr)+1);
2408 decrRefCount(c->argv[0]);
2409 if (bulklen < 0 || bulklen > 1024*1024*1024) {
2410 c->argc--;
2411 addReplySds(c,sdsnew("-ERR invalid bulk write count\r\n"));
2412 resetClient(c);
2413 return 1;
2414 }
2415 c->argc--;
2416 c->bulklen = bulklen+2; /* add two bytes for CR+LF */
2417 return 1;
2418 }
2419 } else {
2420 c->mbargv = zrealloc(c->mbargv,(sizeof(robj*))*(c->mbargc+1));
2421 c->mbargv[c->mbargc] = c->argv[0];
2422 c->mbargc++;
2423 c->argc--;
2424 c->multibulk--;
2425 if (c->multibulk == 0) {
2426 robj **auxargv;
2427 int auxargc;
2428
2429 /* Here we need to swap the multi-bulk argc/argv with the
2430 * normal argc/argv of the client structure. */
2431 auxargv = c->argv;
2432 c->argv = c->mbargv;
2433 c->mbargv = auxargv;
2434
2435 auxargc = c->argc;
2436 c->argc = c->mbargc;
2437 c->mbargc = auxargc;
2438
2439 /* We need to set bulklen to something different than -1
2440 * in order for the code below to process the command without
2441 * to try to read the last argument of a bulk command as
2442 * a special argument. */
2443 c->bulklen = 0;
2444 /* continue below and process the command */
2445 } else {
2446 c->bulklen = -1;
2447 return 1;
2448 }
2449 }
2450 }
2451 /* -- end of multi bulk commands processing -- */
2452
2453 /* The QUIT command is handled as a special case. Normal command
2454 * procs are unable to close the client connection safely */
2455 if (!strcasecmp(c->argv[0]->ptr,"quit")) {
2456 freeClient(c);
2457 return 0;
2458 }
2459
2460 /* Now lookup the command and check ASAP about trivial error conditions
2461 * such wrong arity, bad command name and so forth. */
2462 cmd = lookupCommand(c->argv[0]->ptr);
2463 if (!cmd) {
2464 addReplySds(c,
2465 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2466 (char*)c->argv[0]->ptr));
2467 resetClient(c);
2468 return 1;
2469 } else if ((cmd->arity > 0 && cmd->arity != c->argc) ||
2470 (c->argc < -cmd->arity)) {
2471 addReplySds(c,
2472 sdscatprintf(sdsempty(),
2473 "-ERR wrong number of arguments for '%s' command\r\n",
2474 cmd->name));
2475 resetClient(c);
2476 return 1;
2477 } else if (cmd->flags & REDIS_CMD_BULK && c->bulklen == -1) {
2478 /* This is a bulk command, we have to read the last argument yet. */
2479 int bulklen = atoi(c->argv[c->argc-1]->ptr);
2480
2481 decrRefCount(c->argv[c->argc-1]);
2482 if (bulklen < 0 || bulklen > 1024*1024*1024) {
2483 c->argc--;
2484 addReplySds(c,sdsnew("-ERR invalid bulk write count\r\n"));
2485 resetClient(c);
2486 return 1;
2487 }
2488 c->argc--;
2489 c->bulklen = bulklen+2; /* add two bytes for CR+LF */
2490 /* It is possible that the bulk read is already in the
2491 * buffer. Check this condition and handle it accordingly.
2492 * This is just a fast path, alternative to call processInputBuffer().
2493 * It's a good idea since the code is small and this condition
2494 * happens most of the times. */
2495 if ((signed)sdslen(c->querybuf) >= c->bulklen) {
2496 c->argv[c->argc] = createStringObject(c->querybuf,c->bulklen-2);
2497 c->argc++;
2498 c->querybuf = sdsrange(c->querybuf,c->bulklen,-1);
2499 } else {
2500 /* Otherwise return... there is to read the last argument
2501 * from the socket. */
2502 return 1;
2503 }
2504 }
2505 /* Let's try to encode the bulk object to save space. */
2506 if (cmd->flags & REDIS_CMD_BULK)
2507 c->argv[c->argc-1] = tryObjectEncoding(c->argv[c->argc-1]);
2508
2509 /* Check if the user is authenticated */
2510 if (server.requirepass && !c->authenticated && cmd->proc != authCommand) {
2511 addReplySds(c,sdsnew("-ERR operation not permitted\r\n"));
2512 resetClient(c);
2513 return 1;
2514 }
2515
2516 /* Handle the maxmemory directive */
2517 if (server.maxmemory && (cmd->flags & REDIS_CMD_DENYOOM) &&
2518 zmalloc_used_memory() > server.maxmemory)
2519 {
2520 addReplySds(c,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2521 resetClient(c);
2522 return 1;
2523 }
2524
2525 /* Only allow SUBSCRIBE and UNSUBSCRIBE in the context of Pub/Sub */
2526 if ((dictSize(c->pubsub_channels) > 0 || listLength(c->pubsub_patterns) > 0)
2527 &&
2528 cmd->proc != subscribeCommand && cmd->proc != unsubscribeCommand &&
2529 cmd->proc != psubscribeCommand && cmd->proc != punsubscribeCommand) {
2530 addReplySds(c,sdsnew("-ERR only (P)SUBSCRIBE / (P)UNSUBSCRIBE / QUIT allowed in this context\r\n"));
2531 resetClient(c);
2532 return 1;
2533 }
2534
2535 /* Exec the command */
2536 if (c->flags & REDIS_MULTI &&
2537 cmd->proc != execCommand && cmd->proc != discardCommand &&
2538 cmd->proc != multiCommand && cmd->proc != watchCommand)
2539 {
2540 queueMultiCommand(c,cmd);
2541 addReply(c,shared.queued);
2542 } else {
2543 if (server.vm_enabled && server.vm_max_threads > 0 &&
2544 blockClientOnSwappedKeys(c,cmd)) return 1;
2545 call(c,cmd);
2546 }
2547
2548 /* Prepare the client for the next command */
2549 resetClient(c);
2550 return 1;
2551 }
2552
2553 static void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc) {
2554 listNode *ln;
2555 listIter li;
2556 int outc = 0, j;
2557 robj **outv;
2558 /* We need 1+(ARGS*3) objects since commands are using the new protocol
2559 * and we one 1 object for the first "*<count>\r\n" multibulk count, then
2560 * for every additional object we have "$<count>\r\n" + object + "\r\n". */
2561 robj *static_outv[REDIS_STATIC_ARGS*3+1];
2562 robj *lenobj;
2563
2564 if (argc <= REDIS_STATIC_ARGS) {
2565 outv = static_outv;
2566 } else {
2567 outv = zmalloc(sizeof(robj*)*(argc*3+1));
2568 }
2569
2570 lenobj = createObject(REDIS_STRING,
2571 sdscatprintf(sdsempty(), "*%d\r\n", argc));
2572 lenobj->refcount = 0;
2573 outv[outc++] = lenobj;
2574 for (j = 0; j < argc; j++) {
2575 lenobj = createObject(REDIS_STRING,
2576 sdscatprintf(sdsempty(),"$%lu\r\n",
2577 (unsigned long) stringObjectLen(argv[j])));
2578 lenobj->refcount = 0;
2579 outv[outc++] = lenobj;
2580 outv[outc++] = argv[j];
2581 outv[outc++] = shared.crlf;
2582 }
2583
2584 /* Increment all the refcounts at start and decrement at end in order to
2585 * be sure to free objects if there is no slave in a replication state
2586 * able to be feed with commands */
2587 for (j = 0; j < outc; j++) incrRefCount(outv[j]);
2588 listRewind(slaves,&li);
2589 while((ln = listNext(&li))) {
2590 redisClient *slave = ln->value;
2591
2592 /* Don't feed slaves that are still waiting for BGSAVE to start */
2593 if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_START) continue;
2594
2595 /* Feed all the other slaves, MONITORs and so on */
2596 if (slave->slaveseldb != dictid) {
2597 robj *selectcmd;
2598
2599 switch(dictid) {
2600 case 0: selectcmd = shared.select0; break;
2601 case 1: selectcmd = shared.select1; break;
2602 case 2: selectcmd = shared.select2; break;
2603 case 3: selectcmd = shared.select3; break;
2604 case 4: selectcmd = shared.select4; break;
2605 case 5: selectcmd = shared.select5; break;
2606 case 6: selectcmd = shared.select6; break;
2607 case 7: selectcmd = shared.select7; break;
2608 case 8: selectcmd = shared.select8; break;
2609 case 9: selectcmd = shared.select9; break;
2610 default:
2611 selectcmd = createObject(REDIS_STRING,
2612 sdscatprintf(sdsempty(),"select %d\r\n",dictid));
2613 selectcmd->refcount = 0;
2614 break;
2615 }
2616 addReply(slave,selectcmd);
2617 slave->slaveseldb = dictid;
2618 }
2619 for (j = 0; j < outc; j++) addReply(slave,outv[j]);
2620 }
2621 for (j = 0; j < outc; j++) decrRefCount(outv[j]);
2622 if (outv != static_outv) zfree(outv);
2623 }
2624
2625 static sds sdscatrepr(sds s, char *p, size_t len) {
2626 s = sdscatlen(s,"\"",1);
2627 while(len--) {
2628 switch(*p) {
2629 case '\\':
2630 case '"':
2631 s = sdscatprintf(s,"\\%c",*p);
2632 break;
2633 case '\n': s = sdscatlen(s,"\\n",1); break;
2634 case '\r': s = sdscatlen(s,"\\r",1); break;
2635 case '\t': s = sdscatlen(s,"\\t",1); break;
2636 case '\a': s = sdscatlen(s,"\\a",1); break;
2637 case '\b': s = sdscatlen(s,"\\b",1); break;
2638 default:
2639 if (isprint(*p))
2640 s = sdscatprintf(s,"%c",*p);
2641 else
2642 s = sdscatprintf(s,"\\x%02x",(unsigned char)*p);
2643 break;
2644 }
2645 p++;
2646 }
2647 return sdscatlen(s,"\"",1);
2648 }
2649
2650 static void replicationFeedMonitors(list *monitors, int dictid, robj **argv, int argc) {
2651 listNode *ln;
2652 listIter li;
2653 int j;
2654 sds cmdrepr = sdsnew("+");
2655 robj *cmdobj;
2656 struct timeval tv;
2657
2658 gettimeofday(&tv,NULL);
2659 cmdrepr = sdscatprintf(cmdrepr,"%ld.%ld ",(long)tv.tv_sec,(long)tv.tv_usec);
2660 if (dictid != 0) cmdrepr = sdscatprintf(cmdrepr,"(db %d) ", dictid);
2661
2662 for (j = 0; j < argc; j++) {
2663 if (argv[j]->encoding == REDIS_ENCODING_INT) {
2664 cmdrepr = sdscatprintf(cmdrepr, "%ld", (long)argv[j]->ptr);
2665 } else {
2666 cmdrepr = sdscatrepr(cmdrepr,(char*)argv[j]->ptr,
2667 sdslen(argv[j]->ptr));
2668 }
2669 if (j != argc-1)
2670 cmdrepr = sdscatlen(cmdrepr," ",1);
2671 }
2672 cmdrepr = sdscatlen(cmdrepr,"\r\n",2);
2673 cmdobj = createObject(REDIS_STRING,cmdrepr);
2674
2675 listRewind(monitors,&li);
2676 while((ln = listNext(&li))) {
2677 redisClient *monitor = ln->value;
2678 addReply(monitor,cmdobj);
2679 }
2680 decrRefCount(cmdobj);
2681 }
2682
2683 static void processInputBuffer(redisClient *c) {
2684 again:
2685 /* Before to process the input buffer, make sure the client is not
2686 * waitig for a blocking operation such as BLPOP. Note that the first
2687 * iteration the client is never blocked, otherwise the processInputBuffer
2688 * would not be called at all, but after the execution of the first commands
2689 * in the input buffer the client may be blocked, and the "goto again"
2690 * will try to reiterate. The following line will make it return asap. */
2691 if (c->flags & REDIS_BLOCKED || c->flags & REDIS_IO_WAIT) return;
2692 if (c->bulklen == -1) {
2693 /* Read the first line of the query */
2694 char *p = strchr(c->querybuf,'\n');
2695 size_t querylen;
2696
2697 if (p) {
2698 sds query, *argv;
2699 int argc, j;
2700
2701 query = c->querybuf;
2702 c->querybuf = sdsempty();
2703 querylen = 1+(p-(query));
2704 if (sdslen(query) > querylen) {
2705 /* leave data after the first line of the query in the buffer */
2706 c->querybuf = sdscatlen(c->querybuf,query+querylen,sdslen(query)-querylen);
2707 }
2708 *p = '\0'; /* remove "\n" */
2709 if (*(p-1) == '\r') *(p-1) = '\0'; /* and "\r" if any */
2710 sdsupdatelen(query);
2711
2712 /* Now we can split the query in arguments */
2713 argv = sdssplitlen(query,sdslen(query)," ",1,&argc);
2714 sdsfree(query);
2715
2716 if (c->argv) zfree(c->argv);
2717 c->argv = zmalloc(sizeof(robj*)*argc);
2718
2719 for (j = 0; j < argc; j++) {
2720 if (sdslen(argv[j])) {
2721 c->argv[c->argc] = createObject(REDIS_STRING,argv[j]);
2722 c->argc++;
2723 } else {
2724 sdsfree(argv[j]);
2725 }
2726 }
2727 zfree(argv);
2728 if (c->argc) {
2729 /* Execute the command. If the client is still valid
2730 * after processCommand() return and there is something
2731 * on the query buffer try to process the next command. */
2732 if (processCommand(c) && sdslen(c->querybuf)) goto again;
2733 } else {
2734 /* Nothing to process, argc == 0. Just process the query
2735 * buffer if it's not empty or return to the caller */
2736 if (sdslen(c->querybuf)) goto again;
2737 }
2738 return;
2739 } else if (sdslen(c->querybuf) >= REDIS_REQUEST_MAX_SIZE) {
2740 redisLog(REDIS_VERBOSE, "Client protocol error");
2741 freeClient(c);
2742 return;
2743 }
2744 } else {
2745 /* Bulk read handling. Note that if we are at this point
2746 the client already sent a command terminated with a newline,
2747 we are reading the bulk data that is actually the last
2748 argument of the command. */
2749 int qbl = sdslen(c->querybuf);
2750
2751 if (c->bulklen <= qbl) {
2752 /* Copy everything but the final CRLF as final argument */
2753 c->argv[c->argc] = createStringObject(c->querybuf,c->bulklen-2);
2754 c->argc++;
2755 c->querybuf = sdsrange(c->querybuf,c->bulklen,-1);
2756 /* Process the command. If the client is still valid after
2757 * the processing and there is more data in the buffer
2758 * try to parse it. */
2759 if (processCommand(c) && sdslen(c->querybuf)) goto again;
2760 return;
2761 }
2762 }
2763 }
2764
2765 static void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask) {
2766 redisClient *c = (redisClient*) privdata;
2767 char buf[REDIS_IOBUF_LEN];
2768 int nread;
2769 REDIS_NOTUSED(el);
2770 REDIS_NOTUSED(mask);
2771
2772 nread = read(fd, buf, REDIS_IOBUF_LEN);
2773 if (nread == -1) {
2774 if (errno == EAGAIN) {
2775 nread = 0;
2776 } else {
2777 redisLog(REDIS_VERBOSE, "Reading from client: %s",strerror(errno));
2778 freeClient(c);
2779 return;
2780 }
2781 } else if (nread == 0) {
2782 redisLog(REDIS_VERBOSE, "Client closed connection");
2783 freeClient(c);
2784 return;
2785 }
2786 if (nread) {
2787 c->querybuf = sdscatlen(c->querybuf, buf, nread);
2788 c->lastinteraction = time(NULL);
2789 } else {
2790 return;
2791 }
2792 processInputBuffer(c);
2793 }
2794
2795 static int selectDb(redisClient *c, int id) {
2796 if (id < 0 || id >= server.dbnum)
2797 return REDIS_ERR;
2798 c->db = &server.db[id];
2799 return REDIS_OK;
2800 }
2801
2802 static void *dupClientReplyValue(void *o) {
2803 incrRefCount((robj*)o);
2804 return o;
2805 }
2806
2807 static int listMatchObjects(void *a, void *b) {
2808 return equalStringObjects(a,b);
2809 }
2810
2811 static redisClient *createClient(int fd) {
2812 redisClient *c = zmalloc(sizeof(*c));
2813
2814 anetNonBlock(NULL,fd);
2815 anetTcpNoDelay(NULL,fd);
2816 if (!c) return NULL;
2817 selectDb(c,0);
2818 c->fd = fd;
2819 c->querybuf = sdsempty();
2820 c->argc = 0;
2821 c->argv = NULL;
2822 c->bulklen = -1;
2823 c->multibulk = 0;
2824 c->mbargc = 0;
2825 c->mbargv = NULL;
2826 c->sentlen = 0;
2827 c->flags = 0;
2828 c->lastinteraction = time(NULL);
2829 c->authenticated = 0;
2830 c->replstate = REDIS_REPL_NONE;
2831 c->reply = listCreate();
2832 listSetFreeMethod(c->reply,decrRefCount);
2833 listSetDupMethod(c->reply,dupClientReplyValue);
2834 c->blocking_keys = NULL;
2835 c->blocking_keys_num = 0;
2836 c->io_keys = listCreate();
2837 c->watched_keys = listCreate();
2838 listSetFreeMethod(c->io_keys,decrRefCount);
2839 c->pubsub_channels = dictCreate(&setDictType,NULL);
2840 c->pubsub_patterns = listCreate();
2841 listSetFreeMethod(c->pubsub_patterns,decrRefCount);
2842 listSetMatchMethod(c->pubsub_patterns,listMatchObjects);
2843 if (aeCreateFileEvent(server.el, c->fd, AE_READABLE,
2844 readQueryFromClient, c) == AE_ERR) {
2845 freeClient(c);
2846 return NULL;
2847 }
2848 listAddNodeTail(server.clients,c);
2849 initClientMultiState(c);
2850 return c;
2851 }
2852
2853 static void addReply(redisClient *c, robj *obj) {
2854 if (listLength(c->reply) == 0 &&
2855 (c->replstate == REDIS_REPL_NONE ||
2856 c->replstate == REDIS_REPL_ONLINE) &&
2857 aeCreateFileEvent(server.el, c->fd, AE_WRITABLE,
2858 sendReplyToClient, c) == AE_ERR) return;
2859
2860 if (server.vm_enabled && obj->storage != REDIS_VM_MEMORY) {
2861 obj = dupStringObject(obj);
2862 obj->refcount = 0; /* getDecodedObject() will increment the refcount */
2863 }
2864 listAddNodeTail(c->reply,getDecodedObject(obj));
2865 }
2866
2867 static void addReplySds(redisClient *c, sds s) {
2868 robj *o = createObject(REDIS_STRING,s);
2869 addReply(c,o);
2870 decrRefCount(o);
2871 }
2872
2873 static void addReplyDouble(redisClient *c, double d) {
2874 char buf[128];
2875
2876 snprintf(buf,sizeof(buf),"%.17g",d);
2877 addReplySds(c,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2878 (unsigned long) strlen(buf),buf));
2879 }
2880
2881 static void addReplyLongLong(redisClient *c, long long ll) {
2882 char buf[128];
2883 size_t len;
2884
2885 if (ll == 0) {
2886 addReply(c,shared.czero);
2887 return;
2888 } else if (ll == 1) {
2889 addReply(c,shared.cone);
2890 return;
2891 }
2892 buf[0] = ':';
2893 len = ll2string(buf+1,sizeof(buf)-1,ll);
2894 buf[len+1] = '\r';
2895 buf[len+2] = '\n';
2896 addReplySds(c,sdsnewlen(buf,len+3));
2897 }
2898
2899 static void addReplyUlong(redisClient *c, unsigned long ul) {
2900 char buf[128];
2901 size_t len;
2902
2903 if (ul == 0) {
2904 addReply(c,shared.czero);
2905 return;
2906 } else if (ul == 1) {
2907 addReply(c,shared.cone);
2908 return;
2909 }
2910 len = snprintf(buf,sizeof(buf),":%lu\r\n",ul);
2911 addReplySds(c,sdsnewlen(buf,len));
2912 }
2913
2914 static void addReplyBulkLen(redisClient *c, robj *obj) {
2915 size_t len, intlen;
2916 char buf[128];
2917
2918 if (obj->encoding == REDIS_ENCODING_RAW) {
2919 len = sdslen(obj->ptr);
2920 } else {
2921 long n = (long)obj->ptr;
2922
2923 /* Compute how many bytes will take this integer as a radix 10 string */
2924 len = 1;
2925 if (n < 0) {
2926 len++;
2927 n = -n;
2928 }
2929 while((n = n/10) != 0) {
2930 len++;
2931 }
2932 }
2933 buf[0] = '$';
2934 intlen = ll2string(buf+1,sizeof(buf)-1,(long long)len);
2935 buf[intlen+1] = '\r';
2936 buf[intlen+2] = '\n';
2937 addReplySds(c,sdsnewlen(buf,intlen+3));
2938 }
2939
2940 static void addReplyBulk(redisClient *c, robj *obj) {
2941 addReplyBulkLen(c,obj);
2942 addReply(c,obj);
2943 addReply(c,shared.crlf);
2944 }
2945
2946 static void addReplyBulkSds(redisClient *c, sds s) {
2947 robj *o = createStringObject(s, sdslen(s));
2948 addReplyBulk(c,o);
2949 decrRefCount(o);
2950 }
2951
2952 /* In the CONFIG command we need to add vanilla C string as bulk replies */
2953 static void addReplyBulkCString(redisClient *c, char *s) {
2954 if (s == NULL) {
2955 addReply(c,shared.nullbulk);
2956 } else {
2957 robj *o = createStringObject(s,strlen(s));
2958 addReplyBulk(c,o);
2959 decrRefCount(o);
2960 }
2961 }
2962
2963 static void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask) {
2964 int cport, cfd;
2965 char cip[128];
2966 redisClient *c;
2967 REDIS_NOTUSED(el);
2968 REDIS_NOTUSED(mask);
2969 REDIS_NOTUSED(privdata);
2970
2971 cfd = anetAccept(server.neterr, fd, cip, &cport);
2972 if (cfd == AE_ERR) {
2973 redisLog(REDIS_VERBOSE,"Accepting client connection: %s", server.neterr);
2974 return;
2975 }
2976 redisLog(REDIS_VERBOSE,"Accepted %s:%d", cip, cport);
2977 if ((c = createClient(cfd)) == NULL) {
2978 redisLog(REDIS_WARNING,"Error allocating resoures for the client");
2979 close(cfd); /* May be already closed, just ingore errors */
2980 return;
2981 }
2982 /* If maxclient directive is set and this is one client more... close the
2983 * connection. Note that we create the client instead to check before
2984 * for this condition, since now the socket is already set in nonblocking
2985 * mode and we can send an error for free using the Kernel I/O */
2986 if (server.maxclients && listLength(server.clients) > server.maxclients) {
2987 char *err = "-ERR max number of clients reached\r\n";
2988
2989 /* That's a best effort error message, don't check write errors */
2990 if (write(c->fd,err,strlen(err)) == -1) {
2991 /* Nothing to do, Just to avoid the warning... */
2992 }
2993 freeClient(c);
2994 return;
2995 }
2996 server.stat_numconnections++;
2997 }
2998
2999 /* ======================= Redis objects implementation ===================== */
3000
3001 static robj *createObject(int type, void *ptr) {
3002 robj *o;
3003
3004 if (server.vm_enabled) pthread_mutex_lock(&server.obj_freelist_mutex);
3005 if (listLength(server.objfreelist)) {
3006 listNode *head = listFirst(server.objfreelist);
3007 o = listNodeValue(head);
3008 listDelNode(server.objfreelist,head);
3009 if (server.vm_enabled) pthread_mutex_unlock(&server.obj_freelist_mutex);
3010 } else {
3011 if (server.vm_enabled)
3012 pthread_mutex_unlock(&server.obj_freelist_mutex);
3013 o = zmalloc(sizeof(*o));
3014 }
3015 o->type = type;
3016 o->encoding = REDIS_ENCODING_RAW;
3017 o->ptr = ptr;
3018 o->refcount = 1;
3019 if (server.vm_enabled) {
3020 /* Note that this code may run in the context of an I/O thread
3021 * and accessing server.lruclock in theory is an error
3022 * (no locks). But in practice this is safe, and even if we read
3023 * garbage Redis will not fail. */
3024 o->lru = server.lruclock;
3025 o->storage = REDIS_VM_MEMORY;
3026 }
3027 return o;
3028 }
3029
3030 static robj *createStringObject(char *ptr, size_t len) {
3031 return createObject(REDIS_STRING,sdsnewlen(ptr,len));
3032 }
3033
3034 static robj *createStringObjectFromLongLong(long long value) {
3035 robj *o;
3036 if (value >= 0 && value < REDIS_SHARED_INTEGERS) {
3037 incrRefCount(shared.integers[value]);
3038 o = shared.integers[value];
3039 } else {
3040 if (value >= LONG_MIN && value <= LONG_MAX) {
3041 o = createObject(REDIS_STRING, NULL);
3042 o->encoding = REDIS_ENCODING_INT;
3043 o->ptr = (void*)((long)value);
3044 } else {
3045 o = createObject(REDIS_STRING,sdsfromlonglong(value));
3046 }
3047 }
3048 return o;
3049 }
3050
3051 static robj *dupStringObject(robj *o) {
3052 assert(o->encoding == REDIS_ENCODING_RAW);
3053 return createStringObject(o->ptr,sdslen(o->ptr));
3054 }
3055
3056 static robj *createListObject(void) {
3057 list *l = listCreate();
3058 robj *o = createObject(REDIS_LIST,l);
3059 listSetFreeMethod(l,decrRefCount);
3060 o->encoding = REDIS_ENCODING_LIST;
3061 return o;
3062 }
3063
3064 static robj *createZiplistObject(void) {
3065 unsigned char *zl = ziplistNew();
3066 robj *o = createObject(REDIS_LIST,zl);
3067 o->encoding = REDIS_ENCODING_ZIPLIST;
3068 return o;
3069 }
3070
3071 static robj *createSetObject(void) {
3072 dict *d = dictCreate(&setDictType,NULL);
3073 return createObject(REDIS_SET,d);
3074 }
3075
3076 static robj *createHashObject(void) {
3077 /* All the Hashes start as zipmaps. Will be automatically converted
3078 * into hash tables if there are enough elements or big elements
3079 * inside. */
3080 unsigned char *zm = zipmapNew();
3081 robj *o = createObject(REDIS_HASH,zm);
3082 o->encoding = REDIS_ENCODING_ZIPMAP;
3083 return o;
3084 }
3085
3086 static robj *createZsetObject(void) {
3087 zset *zs = zmalloc(sizeof(*zs));
3088
3089 zs->dict = dictCreate(&zsetDictType,NULL);
3090 zs->zsl = zslCreate();
3091 return createObject(REDIS_ZSET,zs);
3092 }
3093
3094 static void freeStringObject(robj *o) {
3095 if (o->encoding == REDIS_ENCODING_RAW) {
3096 sdsfree(o->ptr);
3097 }
3098 }
3099
3100 static void freeListObject(robj *o) {
3101 switch (o->encoding) {
3102 case REDIS_ENCODING_LIST:
3103 listRelease((list*) o->ptr);
3104 break;
3105 case REDIS_ENCODING_ZIPLIST:
3106 zfree(o->ptr);
3107 break;
3108 default:
3109 redisPanic("Unknown list encoding type");
3110 }
3111 }
3112
3113 static void freeSetObject(robj *o) {
3114 dictRelease((dict*) o->ptr);
3115 }
3116
3117 static void freeZsetObject(robj *o) {
3118 zset *zs = o->ptr;
3119
3120 dictRelease(zs->dict);
3121 zslFree(zs->zsl);
3122 zfree(zs);
3123 }
3124
3125 static void freeHashObject(robj *o) {
3126 switch (o->encoding) {
3127 case REDIS_ENCODING_HT:
3128 dictRelease((dict*) o->ptr);
3129 break;
3130 case REDIS_ENCODING_ZIPMAP:
3131 zfree(o->ptr);
3132 break;
3133 default:
3134 redisPanic("Unknown hash encoding type");
3135 break;
3136 }
3137 }
3138
3139 static void incrRefCount(robj *o) {
3140 o->refcount++;
3141 }
3142
3143 static void decrRefCount(void *obj) {
3144 robj *o = obj;
3145
3146 /* Object is a swapped out value, or in the process of being loaded. */
3147 if (server.vm_enabled &&
3148 (o->storage == REDIS_VM_SWAPPED || o->storage == REDIS_VM_LOADING))
3149 {
3150 vmpointer *vp = obj;
3151 if (o->storage == REDIS_VM_LOADING) vmCancelThreadedIOJob(o);
3152 vmMarkPagesFree(vp->page,vp->usedpages);
3153 server.vm_stats_swapped_objects--;
3154 zfree(vp);
3155 return;
3156 }
3157
3158 if (o->refcount <= 0) redisPanic("decrRefCount against refcount <= 0");
3159 /* Object is in memory, or in the process of being swapped out.
3160 *
3161 * If the object is being swapped out, abort the operation on
3162 * decrRefCount even if the refcount does not drop to 0: the object
3163 * is referenced at least two times, as value of the key AND as
3164 * job->val in the iojob. So if we don't invalidate the iojob, when it is
3165 * done but the relevant key was removed in the meantime, the
3166 * complete jobs handler will not find the key about the job and the
3167 * assert will fail. */
3168 if (server.vm_enabled && o->storage == REDIS_VM_SWAPPING)
3169 vmCancelThreadedIOJob(o);
3170 if (--(o->refcount) == 0) {
3171 switch(o->type) {
3172 case REDIS_STRING: freeStringObject(o); break;
3173 case REDIS_LIST: freeListObject(o); break;
3174 case REDIS_SET: freeSetObject(o); break;
3175 case REDIS_ZSET: freeZsetObject(o); break;
3176 case REDIS_HASH: freeHashObject(o); break;
3177 default: redisPanic("Unknown object type"); break;
3178 }
3179 if (server.vm_enabled) pthread_mutex_lock(&server.obj_freelist_mutex);
3180 if (listLength(server.objfreelist) > REDIS_OBJFREELIST_MAX ||
3181 !listAddNodeHead(server.objfreelist,o))
3182 zfree(o);
3183 if (server.vm_enabled) pthread_mutex_unlock(&server.obj_freelist_mutex);
3184 }
3185 }
3186
3187 static int checkType(redisClient *c, robj *o, int type) {
3188 if (o->type != type) {
3189 addReply(c,shared.wrongtypeerr);
3190 return 1;
3191 }
3192 return 0;
3193 }
3194
3195 /* Check if the nul-terminated string 's' can be represented by a long
3196 * (that is, is a number that fits into long without any other space or
3197 * character before or after the digits).
3198 *
3199 * If so, the function returns REDIS_OK and *longval is set to the value
3200 * of the number. Otherwise REDIS_ERR is returned */
3201 static int isStringRepresentableAsLong(sds s, long *longval) {
3202 char buf[32], *endptr;
3203 long value;
3204 int slen;
3205
3206 value = strtol(s, &endptr, 10);
3207 if (endptr[0] != '\0') return REDIS_ERR;
3208 slen = ll2string(buf,32,value);
3209
3210 /* If the number converted back into a string is not identical
3211 * then it's not possible to encode the string as integer */
3212 if (sdslen(s) != (unsigned)slen || memcmp(buf,s,slen)) return REDIS_ERR;
3213 if (longval) *longval = value;
3214 return REDIS_OK;
3215 }
3216
3217 /* Try to encode a string object in order to save space */
3218 static robj *tryObjectEncoding(robj *o) {
3219 long value;
3220 sds s = o->ptr;
3221
3222 if (o->encoding != REDIS_ENCODING_RAW)
3223 return o; /* Already encoded */
3224
3225 /* It's not safe to encode shared objects: shared objects can be shared
3226 * everywhere in the "object space" of Redis. Encoded objects can only
3227 * appear as "values" (and not, for instance, as keys) */
3228 if (o->refcount > 1) return o;
3229
3230 /* Currently we try to encode only strings */
3231 redisAssert(o->type == REDIS_STRING);
3232
3233 /* Check if we can represent this string as a long integer */
3234 if (isStringRepresentableAsLong(s,&value) == REDIS_ERR) return o;
3235
3236 /* Ok, this object can be encoded */
3237 if (value >= 0 && value < REDIS_SHARED_INTEGERS) {
3238 decrRefCount(o);
3239 incrRefCount(shared.integers[value]);
3240 return shared.integers[value];
3241 } else {
3242 o->encoding = REDIS_ENCODING_INT;
3243 sdsfree(o->ptr);
3244 o->ptr = (void*) value;
3245 return o;
3246 }
3247 }
3248
3249 /* Get a decoded version of an encoded object (returned as a new object).
3250 * If the object is already raw-encoded just increment the ref count. */
3251 static robj *getDecodedObject(robj *o) {
3252 robj *dec;
3253
3254 if (o->encoding == REDIS_ENCODING_RAW) {
3255 incrRefCount(o);
3256 return o;
3257 }
3258 if (o->type == REDIS_STRING && o->encoding == REDIS_ENCODING_INT) {
3259 char buf[32];
3260
3261 ll2string(buf,32,(long)o->ptr);
3262 dec = createStringObject(buf,strlen(buf));
3263 return dec;
3264 } else {
3265 redisPanic("Unknown encoding type");
3266 }
3267 }
3268
3269 /* Compare two string objects via strcmp() or alike.
3270 * Note that the objects may be integer-encoded. In such a case we
3271 * use ll2string() to get a string representation of the numbers on the stack
3272 * and compare the strings, it's much faster than calling getDecodedObject().
3273 *
3274 * Important note: if objects are not integer encoded, but binary-safe strings,
3275 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
3276 * binary safe. */
3277 static int compareStringObjects(robj *a, robj *b) {
3278 redisAssert(a->type == REDIS_STRING && b->type == REDIS_STRING);
3279 char bufa[128], bufb[128], *astr, *bstr;
3280 int bothsds = 1;
3281
3282 if (a == b) return 0;
3283 if (a->encoding != REDIS_ENCODING_RAW) {
3284 ll2string(bufa,sizeof(bufa),(long) a->ptr);
3285 astr = bufa;
3286 bothsds = 0;
3287 } else {
3288 astr = a->ptr;
3289 }
3290 if (b->encoding != REDIS_ENCODING_RAW) {
3291 ll2string(bufb,sizeof(bufb),(long) b->ptr);
3292 bstr = bufb;
3293 bothsds = 0;
3294 } else {
3295 bstr = b->ptr;
3296 }
3297 return bothsds ? sdscmp(astr,bstr) : strcmp(astr,bstr);
3298 }
3299
3300 /* Equal string objects return 1 if the two objects are the same from the
3301 * point of view of a string comparison, otherwise 0 is returned. Note that
3302 * this function is faster then checking for (compareStringObject(a,b) == 0)
3303 * because it can perform some more optimization. */
3304 static int equalStringObjects(robj *a, robj *b) {
3305 if (a->encoding != REDIS_ENCODING_RAW && b->encoding != REDIS_ENCODING_RAW){
3306 return a->ptr == b->ptr;
3307 } else {
3308 return compareStringObjects(a,b) == 0;
3309 }
3310 }
3311
3312 static size_t stringObjectLen(robj *o) {
3313 redisAssert(o->type == REDIS_STRING);
3314 if (o->encoding == REDIS_ENCODING_RAW) {
3315 return sdslen(o->ptr);
3316 } else {
3317 char buf[32];
3318
3319 return ll2string(buf,32,(long)o->ptr);
3320 }
3321 }
3322
3323 static int getDoubleFromObject(robj *o, double *target) {
3324 double value;
3325 char *eptr;
3326
3327 if (o == NULL) {
3328 value = 0;
3329 } else {
3330 redisAssert(o->type == REDIS_STRING);
3331 if (o->encoding == REDIS_ENCODING_RAW) {
3332 value = strtod(o->ptr, &eptr);
3333 if (eptr[0] != '\0') return REDIS_ERR;
3334 } else if (o->encoding == REDIS_ENCODING_INT) {
3335 value = (long)o->ptr;
3336 } else {
3337 redisPanic("Unknown string encoding");
3338 }
3339 }
3340
3341 *target = value;
3342 return REDIS_OK;
3343 }
3344
3345 static int getDoubleFromObjectOrReply(redisClient *c, robj *o, double *target, const char *msg) {
3346 double value;
3347 if (getDoubleFromObject(o, &value) != REDIS_OK) {
3348 if (msg != NULL) {
3349 addReplySds(c, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg));
3350 } else {
3351 addReplySds(c, sdsnew("-ERR value is not a double\r\n"));
3352 }
3353 return REDIS_ERR;
3354 }
3355
3356 *target = value;
3357 return REDIS_OK;
3358 }
3359
3360 static int getLongLongFromObject(robj *o, long long *target) {
3361 long long value;
3362 char *eptr;
3363
3364 if (o == NULL) {
3365 value = 0;
3366 } else {
3367 redisAssert(o->type == REDIS_STRING);
3368 if (o->encoding == REDIS_ENCODING_RAW) {
3369 value = strtoll(o->ptr, &eptr, 10);
3370 if (eptr[0] != '\0') return REDIS_ERR;
3371 } else if (o->encoding == REDIS_ENCODING_INT) {
3372 value = (long)o->ptr;
3373 } else {
3374 redisPanic("Unknown string encoding");
3375 }
3376 }
3377
3378 *target = value;
3379 return REDIS_OK;
3380 }
3381
3382 static int getLongLongFromObjectOrReply(redisClient *c, robj *o, long long *target, const char *msg) {
3383 long long value;
3384 if (getLongLongFromObject(o, &value) != REDIS_OK) {
3385 if (msg != NULL) {
3386 addReplySds(c, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg));
3387 } else {
3388 addReplySds(c, sdsnew("-ERR value is not an integer\r\n"));
3389 }
3390 return REDIS_ERR;
3391 }
3392
3393 *target = value;
3394 return REDIS_OK;
3395 }
3396
3397 static int getLongFromObjectOrReply(redisClient *c, robj *o, long *target, const char *msg) {
3398 long long value;
3399
3400 if (getLongLongFromObjectOrReply(c, o, &value, msg) != REDIS_OK) return REDIS_ERR;
3401 if (value < LONG_MIN || value > LONG_MAX) {
3402 if (msg != NULL) {
3403 addReplySds(c, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg));
3404 } else {
3405 addReplySds(c, sdsnew("-ERR value is out of range\r\n"));
3406 }
3407 return REDIS_ERR;
3408 }
3409
3410 *target = value;
3411 return REDIS_OK;
3412 }
3413
3414 /* =========================== Keyspace access API ========================== */
3415
3416 static robj *lookupKey(redisDb *db, robj *key) {
3417 dictEntry *de = dictFind(db->dict,key->ptr);
3418 if (de) {
3419 robj *val = dictGetEntryVal(de);
3420
3421 if (server.vm_enabled) {
3422 if (val->storage == REDIS_VM_MEMORY ||
3423 val->storage == REDIS_VM_SWAPPING)
3424 {
3425 /* If we were swapping the object out, cancel the operation */
3426 if (val->storage == REDIS_VM_SWAPPING)
3427 vmCancelThreadedIOJob(val);
3428 /* Update the access time for the aging algorithm. */
3429 val->lru = server.lruclock;
3430 } else {
3431 int notify = (val->storage == REDIS_VM_LOADING);
3432
3433 /* Our value was swapped on disk. Bring it at home. */
3434 redisAssert(val->type == REDIS_VMPOINTER);
3435 val = vmLoadObject(val);
3436 dictGetEntryVal(de) = val;
3437
3438 /* Clients blocked by the VM subsystem may be waiting for
3439 * this key... */
3440 if (notify) handleClientsBlockedOnSwappedKey(db,key);
3441 }
3442 }
3443 return val;
3444 } else {
3445 return NULL;
3446 }
3447 }
3448
3449 static robj *lookupKeyRead(redisDb *db, robj *key) {
3450 expireIfNeeded(db,key);
3451 return lookupKey(db,key);
3452 }
3453
3454 static robj *lookupKeyWrite(redisDb *db, robj *key) {
3455 deleteIfVolatile(db,key);
3456 touchWatchedKey(db,key);
3457 return lookupKey(db,key);
3458 }
3459
3460 static robj *lookupKeyReadOrReply(redisClient *c, robj *key, robj *reply) {
3461 robj *o = lookupKeyRead(c->db, key);
3462 if (!o) addReply(c,reply);
3463 return o;
3464 }
3465
3466 static robj *lookupKeyWriteOrReply(redisClient *c, robj *key, robj *reply) {
3467 robj *o = lookupKeyWrite(c->db, key);
3468 if (!o) addReply(c,reply);
3469 return o;
3470 }
3471
3472 /* Add the key to the DB. If the key already exists REDIS_ERR is returned,
3473 * otherwise REDIS_OK is returned, and the caller should increment the
3474 * refcount of 'val'. */
3475 static int dbAdd(redisDb *db, robj *key, robj *val) {
3476 /* Perform a lookup before adding the key, as we need to copy the
3477 * key value. */
3478 if (dictFind(db->dict, key->ptr) != NULL) {
3479 return REDIS_ERR;
3480 } else {
3481 sds copy = sdsdup(key->ptr);
3482 dictAdd(db->dict, copy, val);
3483 return REDIS_OK;
3484 }
3485 }
3486
3487 /* If the key does not exist, this is just like dbAdd(). Otherwise
3488 * the value associated to the key is replaced with the new one.
3489 *
3490 * On update (key already existed) 0 is returned. Otherwise 1. */
3491 static int dbReplace(redisDb *db, robj *key, robj *val) {
3492 if (dictFind(db->dict,key->ptr) == NULL) {
3493 sds copy = sdsdup(key->ptr);
3494 dictAdd(db->dict, copy, val);
3495 return 1;
3496 } else {
3497 dictReplace(db->dict, key->ptr, val);
3498 return 0;
3499 }
3500 }
3501
3502 static int dbExists(redisDb *db, robj *key) {
3503 return dictFind(db->dict,key->ptr) != NULL;
3504 }
3505
3506 /* Return a random key, in form of a Redis object.
3507 * If there are no keys, NULL is returned.
3508 *
3509 * The function makes sure to return keys not already expired. */
3510 static robj *dbRandomKey(redisDb *db) {
3511 struct dictEntry *de;
3512
3513 while(1) {
3514 sds key;
3515 robj *keyobj;
3516
3517 de = dictGetRandomKey(db->dict);
3518 if (de == NULL) return NULL;
3519
3520 key = dictGetEntryKey(de);
3521 keyobj = createStringObject(key,sdslen(key));
3522 if (dictFind(db->expires,key)) {
3523 if (expireIfNeeded(db,keyobj)) {
3524 decrRefCount(keyobj);
3525 continue; /* search for another key. This expired. */
3526 }
3527 }
3528 return keyobj;
3529 }
3530 }
3531
3532 /* Delete a key, value, and associated expiration entry if any, from the DB */
3533 static int dbDelete(redisDb *db, robj *key) {
3534 int retval;
3535
3536 if (dictSize(db->expires)) dictDelete(db->expires,key->ptr);
3537 retval = dictDelete(db->dict,key->ptr);
3538
3539 return retval == DICT_OK;
3540 }
3541
3542 /*============================ RDB saving/loading =========================== */
3543
3544 static int rdbSaveType(FILE *fp, unsigned char type) {
3545 if (fwrite(&type,1,1,fp) == 0) return -1;
3546 return 0;
3547 }
3548
3549 static int rdbSaveTime(FILE *fp, time_t t) {
3550 int32_t t32 = (int32_t) t;
3551 if (fwrite(&t32,4,1,fp) == 0) return -1;
3552 return 0;
3553 }
3554
3555 /* check rdbLoadLen() comments for more info */
3556 static int rdbSaveLen(FILE *fp, uint32_t len) {
3557 unsigned char buf[2];
3558
3559 if (len < (1<<6)) {
3560 /* Save a 6 bit len */
3561 buf[0] = (len&0xFF)|(REDIS_RDB_6BITLEN<<6);
3562 if (fwrite(buf,1,1,fp) == 0) return -1;
3563 } else if (len < (1<<14)) {
3564 /* Save a 14 bit len */
3565 buf[0] = ((len>>8)&0xFF)|(REDIS_RDB_14BITLEN<<6);
3566 buf[1] = len&0xFF;
3567 if (fwrite(buf,2,1,fp) == 0) return -1;
3568 } else {
3569 /* Save a 32 bit len */
3570 buf[0] = (REDIS_RDB_32BITLEN<<6);
3571 if (fwrite(buf,1,1,fp) == 0) return -1;
3572 len = htonl(len);
3573 if (fwrite(&len,4,1,fp) == 0) return -1;
3574 }
3575 return 0;
3576 }
3577
3578 /* Encode 'value' as an integer if possible (if integer will fit the
3579 * supported range). If the function sucessful encoded the integer
3580 * then the (up to 5 bytes) encoded representation is written in the
3581 * string pointed by 'enc' and the length is returned. Otherwise
3582 * 0 is returned. */
3583 static int rdbEncodeInteger(long long value, unsigned char *enc) {
3584 /* Finally check if it fits in our ranges */
3585 if (value >= -(1<<7) && value <= (1<<7)-1) {
3586 enc[0] = (REDIS_RDB_ENCVAL<<6)|REDIS_RDB_ENC_INT8;
3587 enc[1] = value&0xFF;
3588 return 2;
3589 } else if (value >= -(1<<15) && value <= (1<<15)-1) {
3590 enc[0] = (REDIS_RDB_ENCVAL<<6)|REDIS_RDB_ENC_INT16;
3591 enc[1] = value&0xFF;
3592 enc[2] = (value>>8)&0xFF;
3593 return 3;
3594 } else if (value >= -((long long)1<<31) && value <= ((long long)1<<31)-1) {
3595 enc[0] = (REDIS_RDB_ENCVAL<<6)|REDIS_RDB_ENC_INT32;
3596 enc[1] = value&0xFF;
3597 enc[2] = (value>>8)&0xFF;
3598 enc[3] = (value>>16)&0xFF;
3599 enc[4] = (value>>24)&0xFF;
3600 return 5;
3601 } else {
3602 return 0;
3603 }
3604 }
3605
3606 /* String objects in the form "2391" "-100" without any space and with a
3607 * range of values that can fit in an 8, 16 or 32 bit signed value can be
3608 * encoded as integers to save space */
3609 static int rdbTryIntegerEncoding(char *s, size_t len, unsigned char *enc) {
3610 long long value;
3611 char *endptr, buf[32];
3612
3613 /* Check if it's possible to encode this value as a number */
3614 value = strtoll(s, &endptr, 10);
3615 if (endptr[0] != '\0') return 0;
3616 ll2string(buf,32,value);
3617
3618 /* If the number converted back into a string is not identical
3619 * then it's not possible to encode the string as integer */
3620 if (strlen(buf) != len || memcmp(buf,s,len)) return 0;
3621
3622 return rdbEncodeInteger(value,enc);
3623 }
3624
3625 static int rdbSaveLzfStringObject(FILE *fp, unsigned char *s, size_t len) {
3626 size_t comprlen, outlen;
3627 unsigned char byte;
3628 void *out;
3629
3630 /* We require at least four bytes compression for this to be worth it */
3631 if (len <= 4) return 0;
3632 outlen = len-4;
3633 if ((out = zmalloc(outlen+1)) == NULL) return 0;
3634 comprlen = lzf_compress(s, len, out, outlen);
3635 if (comprlen == 0) {
3636 zfree(out);
3637 return 0;
3638 }
3639 /* Data compressed! Let's save it on disk */
3640 byte = (REDIS_RDB_ENCVAL<<6)|REDIS_RDB_ENC_LZF;
3641 if (fwrite(&byte,1,1,fp) == 0) goto writeerr;
3642 if (rdbSaveLen(fp,comprlen) == -1) goto writeerr;
3643 if (rdbSaveLen(fp,len) == -1) goto writeerr;
3644 if (fwrite(out,comprlen,1,fp) == 0) goto writeerr;
3645 zfree(out);
3646 return comprlen;
3647
3648 writeerr:
3649 zfree(out);
3650 return -1;
3651 }
3652
3653 /* Save a string objet as [len][data] on disk. If the object is a string
3654 * representation of an integer value we try to safe it in a special form */
3655 static int rdbSaveRawString(FILE *fp, unsigned char *s, size_t len) {
3656 int enclen;
3657
3658 /* Try integer encoding */
3659 if (len <= 11) {
3660 unsigned char buf[5];
3661 if ((enclen = rdbTryIntegerEncoding((char*)s,len,buf)) > 0) {
3662 if (fwrite(buf,enclen,1,fp) == 0) return -1;
3663 return 0;
3664 }
3665 }
3666
3667 /* Try LZF compression - under 20 bytes it's unable to compress even
3668 * aaaaaaaaaaaaaaaaaa so skip it */
3669 if (server.rdbcompression && len > 20) {
3670 int retval;
3671
3672 retval = rdbSaveLzfStringObject(fp,s,len);
3673 if (retval == -1) return -1;
3674 if (retval > 0) return 0;
3675 /* retval == 0 means data can't be compressed, save the old way */
3676 }
3677
3678 /* Store verbatim */
3679 if (rdbSaveLen(fp,len) == -1) return -1;
3680 if (len && fwrite(s,len,1,fp) == 0) return -1;
3681 return 0;
3682 }
3683
3684 /* Save a long long value as either an encoded string or a string. */
3685 static int rdbSaveLongLongAsStringObject(FILE *fp, long long value) {
3686 unsigned char buf[32];
3687 int enclen = rdbEncodeInteger(value,buf);
3688 if (enclen > 0) {
3689 if (fwrite(buf,enclen,1,fp) == 0) return -1;
3690 } else {
3691 /* Encode as string */
3692 enclen = ll2string((char*)buf,32,value);
3693 redisAssert(enclen < 32);
3694 if (rdbSaveLen(fp,enclen) == -1) return -1;
3695 if (fwrite(buf,enclen,1,fp) == 0) return -1;
3696 }
3697 return 0;
3698 }
3699
3700 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
3701 static int rdbSaveStringObject(FILE *fp, robj *obj) {
3702 /* Avoid to decode the object, then encode it again, if the
3703 * object is alrady integer encoded. */
3704 if (obj->encoding == REDIS_ENCODING_INT) {
3705 return rdbSaveLongLongAsStringObject(fp,(long)obj->ptr);
3706 } else {
3707 redisAssert(obj->encoding == REDIS_ENCODING_RAW);
3708 return rdbSaveRawString(fp,obj->ptr,sdslen(obj->ptr));
3709 }
3710 }
3711
3712 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
3713 * 8 bit integer specifing the length of the representation.
3714 * This 8 bit integer has special values in order to specify the following
3715 * conditions:
3716 * 253: not a number
3717 * 254: + inf
3718 * 255: - inf
3719 */
3720 static int rdbSaveDoubleValue(FILE *fp, double val) {
3721 unsigned char buf[128];
3722 int len;
3723
3724 if (isnan(val)) {
3725 buf[0] = 253;
3726 len = 1;
3727 } else if (!isfinite(val)) {
3728 len = 1;
3729 buf[0] = (val < 0) ? 255 : 254;
3730 } else {
3731 #if (DBL_MANT_DIG >= 52) && (LLONG_MAX == 0x7fffffffffffffffLL)
3732 /* Check if the float is in a safe range to be casted into a
3733 * long long. We are assuming that long long is 64 bit here.
3734 * Also we are assuming that there are no implementations around where
3735 * double has precision < 52 bit.
3736 *
3737 * Under this assumptions we test if a double is inside an interval
3738 * where casting to long long is safe. Then using two castings we
3739 * make sure the decimal part is zero. If all this is true we use
3740 * integer printing function that is much faster. */
3741 double min = -4503599627370495; /* (2^52)-1 */
3742 double max = 4503599627370496; /* -(2^52) */
3743 if (val > min && val < max && val == ((double)((long long)val)))
3744 ll2string((char*)buf+1,sizeof(buf),(long long)val);
3745 else
3746 #endif
3747 snprintf((char*)buf+1,sizeof(buf)-1,"%.17g",val);
3748 buf[0] = strlen((char*)buf+1);
3749 len = buf[0]+1;
3750 }
3751 if (fwrite(buf,len,1,fp) == 0) return -1;
3752 return 0;
3753 }
3754
3755 /* Save a Redis object. */
3756 static int rdbSaveObject(FILE *fp, robj *o) {
3757 if (o->type == REDIS_STRING) {
3758 /* Save a string value */
3759 if (rdbSaveStringObject(fp,o) == -1) return -1;
3760 } else if (o->type == REDIS_LIST) {
3761 /* Save a list value */
3762 if (o->encoding == REDIS_ENCODING_ZIPLIST) {
3763 unsigned char *p;
3764 unsigned char *vstr;
3765 unsigned int vlen;
3766 long long vlong;
3767
3768 if (rdbSaveLen(fp,ziplistLen(o->ptr)) == -1) return -1;
3769 p = ziplistIndex(o->ptr,0);
3770 while(ziplistGet(p,&vstr,&vlen,&vlong)) {
3771 if (vstr) {
3772 if (rdbSaveRawString(fp,vstr,vlen) == -1)
3773 return -1;
3774 } else {
3775 if (rdbSaveLongLongAsStringObject(fp,vlong) == -1)
3776 return -1;
3777 }
3778 p = ziplistNext(o->ptr,p);
3779 }
3780 } else if (o->encoding == REDIS_ENCODING_LIST) {
3781 list *list = o->ptr;
3782 listIter li;
3783 listNode *ln;
3784
3785 if (rdbSaveLen(fp,listLength(list)) == -1) return -1;
3786 listRewind(list,&li);
3787 while((ln = listNext(&li))) {
3788 robj *eleobj = listNodeValue(ln);
3789 if (rdbSaveStringObject(fp,eleobj) == -1) return -1;
3790 }
3791 } else {
3792 redisPanic("Unknown list encoding");
3793 }
3794 } else if (o->type == REDIS_SET) {
3795 /* Save a set value */
3796 dict *set = o->ptr;
3797 dictIterator *di = dictGetIterator(set);
3798 dictEntry *de;
3799
3800 if (rdbSaveLen(fp,dictSize(set)) == -1) return -1;
3801 while((de = dictNext(di)) != NULL) {
3802 robj *eleobj = dictGetEntryKey(de);
3803
3804 if (rdbSaveStringObject(fp,eleobj) == -1) return -1;
3805 }
3806 dictReleaseIterator(di);
3807 } else if (o->type == REDIS_ZSET) {
3808 /* Save a set value */
3809 zset *zs = o->ptr;
3810 dictIterator *di = dictGetIterator(zs->dict);
3811 dictEntry *de;
3812
3813 if (rdbSaveLen(fp,dictSize(zs->dict)) == -1) return -1;
3814 while((de = dictNext(di)) != NULL) {
3815 robj *eleobj = dictGetEntryKey(de);
3816 double *score = dictGetEntryVal(de);
3817
3818 if (rdbSaveStringObject(fp,eleobj) == -1) return -1;
3819 if (rdbSaveDoubleValue(fp,*score) == -1) return -1;
3820 }
3821 dictReleaseIterator(di);
3822 } else if (o->type == REDIS_HASH) {
3823 /* Save a hash value */
3824 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
3825 unsigned char *p = zipmapRewind(o->ptr);
3826 unsigned int count = zipmapLen(o->ptr);
3827 unsigned char *key, *val;
3828 unsigned int klen, vlen;
3829
3830 if (rdbSaveLen(fp,count) == -1) return -1;
3831 while((p = zipmapNext(p,&key,&klen,&val,&vlen)) != NULL) {
3832 if (rdbSaveRawString(fp,key,klen) == -1) return -1;
3833 if (rdbSaveRawString(fp,val,vlen) == -1) return -1;
3834 }
3835 } else {
3836 dictIterator *di = dictGetIterator(o->ptr);
3837 dictEntry *de;
3838
3839 if (rdbSaveLen(fp,dictSize((dict*)o->ptr)) == -1) return -1;
3840 while((de = dictNext(di)) != NULL) {
3841 robj *key = dictGetEntryKey(de);
3842 robj *val = dictGetEntryVal(de);
3843
3844 if (rdbSaveStringObject(fp,key) == -1) return -1;
3845 if (rdbSaveStringObject(fp,val) == -1) return -1;
3846 }
3847 dictReleaseIterator(di);
3848 }
3849 } else {
3850 redisPanic("Unknown object type");
3851 }
3852 return 0;
3853 }
3854
3855 /* Return the length the object will have on disk if saved with
3856 * the rdbSaveObject() function. Currently we use a trick to get
3857 * this length with very little changes to the code. In the future
3858 * we could switch to a faster solution. */
3859 static off_t rdbSavedObjectLen(robj *o, FILE *fp) {
3860 if (fp == NULL) fp = server.devnull;
3861 rewind(fp);
3862 assert(rdbSaveObject(fp,o) != 1);
3863 return ftello(fp);
3864 }
3865
3866 /* Return the number of pages required to save this object in the swap file */
3867 static off_t rdbSavedObjectPages(robj *o, FILE *fp) {
3868 off_t bytes = rdbSavedObjectLen(o,fp);
3869
3870 return (bytes+(server.vm_page_size-1))/server.vm_page_size;
3871 }
3872
3873 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3874 static int rdbSave(char *filename) {
3875 dictIterator *di = NULL;
3876 dictEntry *de;
3877 FILE *fp;
3878 char tmpfile[256];
3879 int j;
3880 time_t now = time(NULL);
3881
3882 /* Wait for I/O therads to terminate, just in case this is a
3883 * foreground-saving, to avoid seeking the swap file descriptor at the
3884 * same time. */
3885 if (server.vm_enabled)
3886 waitEmptyIOJobsQueue();
3887
3888 snprintf(tmpfile,256,"temp-%d.rdb", (int) getpid());
3889 fp = fopen(tmpfile,"w");
3890 if (!fp) {
3891 redisLog(REDIS_WARNING, "Failed saving the DB: %s", strerror(errno));
3892 return REDIS_ERR;
3893 }
3894 if (fwrite("REDIS0001",9,1,fp) == 0) goto werr;
3895 for (j = 0; j < server.dbnum; j++) {
3896 redisDb *db = server.db+j;
3897 dict *d = db->dict;
3898 if (dictSize(d) == 0) continue;
3899 di = dictGetIterator(d);
3900 if (!di) {
3901 fclose(fp);
3902 return REDIS_ERR;
3903 }
3904
3905 /* Write the SELECT DB opcode */
3906 if (rdbSaveType(fp,REDIS_SELECTDB) == -1) goto werr;
3907 if (rdbSaveLen(fp,j) == -1) goto werr;
3908
3909 /* Iterate this DB writing every entry */
3910 while((de = dictNext(di)) != NULL) {
3911 sds keystr = dictGetEntryKey(de);
3912 robj key, *o = dictGetEntryVal(de);
3913 time_t expiretime;
3914
3915 initStaticStringObject(key,keystr);
3916 expiretime = getExpire(db,&key);
3917
3918 /* Save the expire time */
3919 if (expiretime != -1) {
3920 /* If this key is already expired skip it */
3921 if (expiretime < now) continue;
3922 if (rdbSaveType(fp,REDIS_EXPIRETIME) == -1) goto werr;
3923 if (rdbSaveTime(fp,expiretime) == -1) goto werr;
3924 }
3925 /* Save the key and associated value. This requires special
3926 * handling if the value is swapped out. */
3927 if (!server.vm_enabled || o->storage == REDIS_VM_MEMORY ||
3928 o->storage == REDIS_VM_SWAPPING) {
3929 /* Save type, key, value */
3930 if (rdbSaveType(fp,o->type) == -1) goto werr;
3931 if (rdbSaveStringObject(fp,&key) == -1) goto werr;
3932 if (rdbSaveObject(fp,o) == -1) goto werr;
3933 } else {
3934 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3935 robj *po;
3936 /* Get a preview of the object in memory */
3937 po = vmPreviewObject(o);
3938 /* Save type, key, value */
3939 if (rdbSaveType(fp,po->type) == -1) goto werr;
3940 if (rdbSaveStringObject(fp,&key) == -1) goto werr;
3941 if (rdbSaveObject(fp,po) == -1) goto werr;
3942 /* Remove the loaded object from memory */
3943 decrRefCount(po);
3944 }
3945 }
3946 dictReleaseIterator(di);
3947 }
3948 /* EOF opcode */
3949 if (rdbSaveType(fp,REDIS_EOF) == -1) goto werr;
3950
3951 /* Make sure data will not remain on the OS's output buffers */
3952 fflush(fp);
3953 fsync(fileno(fp));
3954 fclose(fp);
3955
3956 /* Use RENAME to make sure the DB file is changed atomically only
3957 * if the generate DB file is ok. */
3958 if (rename(tmpfile,filename) == -1) {
3959 redisLog(REDIS_WARNING,"Error moving temp DB file on the final destination: %s", strerror(errno));
3960 unlink(tmpfile);
3961 return REDIS_ERR;
3962 }
3963 redisLog(REDIS_NOTICE,"DB saved on disk");
3964 server.dirty = 0;
3965 server.lastsave = time(NULL);
3966 return REDIS_OK;
3967
3968 werr:
3969 fclose(fp);
3970 unlink(tmpfile);
3971 redisLog(REDIS_WARNING,"Write error saving DB on disk: %s", strerror(errno));
3972 if (di) dictReleaseIterator(di);
3973 return REDIS_ERR;
3974 }
3975
3976 static int rdbSaveBackground(char *filename) {
3977 pid_t childpid;
3978
3979 if (server.bgsavechildpid != -1) return REDIS_ERR;
3980 if (server.vm_enabled) waitEmptyIOJobsQueue();
3981 if ((childpid = fork()) == 0) {
3982 /* Child */
3983 if (server.vm_enabled) vmReopenSwapFile();
3984 close(server.fd);
3985 if (rdbSave(filename) == REDIS_OK) {
3986 _exit(0);
3987 } else {
3988 _exit(1);
3989 }
3990 } else {
3991 /* Parent */
3992 if (childpid == -1) {
3993 redisLog(REDIS_WARNING,"Can't save in background: fork: %s",
3994 strerror(errno));
3995 return REDIS_ERR;
3996 }
3997 redisLog(REDIS_NOTICE,"Background saving started by pid %d",childpid);
3998 server.bgsavechildpid = childpid;
3999 updateDictResizePolicy();
4000 return REDIS_OK;
4001 }
4002 return REDIS_OK; /* unreached */
4003 }
4004
4005 static void rdbRemoveTempFile(pid_t childpid) {
4006 char tmpfile[256];
4007
4008 snprintf(tmpfile,256,"temp-%d.rdb", (int) childpid);
4009 unlink(tmpfile);
4010 }
4011
4012 static int rdbLoadType(FILE *fp) {
4013 unsigned char type;
4014 if (fread(&type,1,1,fp) == 0) return -1;
4015 return type;
4016 }
4017
4018 static time_t rdbLoadTime(FILE *fp) {
4019 int32_t t32;
4020 if (fread(&t32,4,1,fp) == 0) return -1;
4021 return (time_t) t32;
4022 }
4023
4024 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
4025 * of this file for a description of how this are stored on disk.
4026 *
4027 * isencoded is set to 1 if the readed length is not actually a length but
4028 * an "encoding type", check the above comments for more info */
4029 static uint32_t rdbLoadLen(FILE *fp, int *isencoded) {
4030 unsigned char buf[2];
4031 uint32_t len;
4032 int type;
4033
4034 if (isencoded) *isencoded = 0;
4035 if (fread(buf,1,1,fp) == 0) return REDIS_RDB_LENERR;
4036 type = (buf[0]&0xC0)>>6;
4037 if (type == REDIS_RDB_6BITLEN) {
4038 /* Read a 6 bit len */
4039 return buf[0]&0x3F;
4040 } else if (type == REDIS_RDB_ENCVAL) {
4041 /* Read a 6 bit len encoding type */
4042 if (isencoded) *isencoded = 1;
4043 return buf[0]&0x3F;
4044 } else if (type == REDIS_RDB_14BITLEN) {
4045 /* Read a 14 bit len */
4046 if (fread(buf+1,1,1,fp) == 0) return REDIS_RDB_LENERR;
4047 return ((buf[0]&0x3F)<<8)|buf[1];
4048 } else {
4049 /* Read a 32 bit len */
4050 if (fread(&len,4,1,fp) == 0) return REDIS_RDB_LENERR;
4051 return ntohl(len);
4052 }
4053 }
4054
4055 /* Load an integer-encoded object from file 'fp', with the specified
4056 * encoding type 'enctype'. If encode is true the function may return
4057 * an integer-encoded object as reply, otherwise the returned object
4058 * will always be encoded as a raw string. */
4059 static robj *rdbLoadIntegerObject(FILE *fp, int enctype, int encode) {
4060 unsigned char enc[4];
4061 long long val;
4062
4063 if (enctype == REDIS_RDB_ENC_INT8) {
4064 if (fread(enc,1,1,fp) == 0) return NULL;
4065 val = (signed char)enc[0];
4066 } else if (enctype == REDIS_RDB_ENC_INT16) {
4067 uint16_t v;
4068 if (fread(enc,2,1,fp) == 0) return NULL;
4069 v = enc[0]|(enc[1]<<8);
4070 val = (int16_t)v;
4071 } else if (enctype == REDIS_RDB_ENC_INT32) {
4072 uint32_t v;
4073 if (fread(enc,4,1,fp) == 0) return NULL;
4074 v = enc[0]|(enc[1]<<8)|(enc[2]<<16)|(enc[3]<<24);
4075 val = (int32_t)v;
4076 } else {
4077 val = 0; /* anti-warning */
4078 redisPanic("Unknown RDB integer encoding type");
4079 }
4080 if (encode)
4081 return createStringObjectFromLongLong(val);
4082 else
4083 return createObject(REDIS_STRING,sdsfromlonglong(val));
4084 }
4085
4086 static robj *rdbLoadLzfStringObject(FILE*fp) {
4087 unsigned int len, clen;
4088 unsigned char *c = NULL;
4089 sds val = NULL;
4090
4091 if ((clen = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
4092 if ((len = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
4093 if ((c = zmalloc(clen)) == NULL) goto err;
4094 if ((val = sdsnewlen(NULL,len)) == NULL) goto err;
4095 if (fread(c,clen,1,fp) == 0) goto err;
4096 if (lzf_decompress(c,clen,val,len) == 0) goto err;
4097 zfree(c);
4098 return createObject(REDIS_STRING,val);
4099 err:
4100 zfree(c);
4101 sdsfree(val);
4102 return NULL;
4103 }
4104
4105 static robj *rdbGenericLoadStringObject(FILE*fp, int encode) {
4106 int isencoded;
4107 uint32_t len;
4108 sds val;
4109
4110 len = rdbLoadLen(fp,&isencoded);
4111 if (isencoded) {
4112 switch(len) {
4113 case REDIS_RDB_ENC_INT8:
4114 case REDIS_RDB_ENC_INT16:
4115 case REDIS_RDB_ENC_INT32:
4116 return rdbLoadIntegerObject(fp,len,encode);
4117 case REDIS_RDB_ENC_LZF:
4118 return rdbLoadLzfStringObject(fp);
4119 default:
4120 redisPanic("Unknown RDB encoding type");
4121 }
4122 }
4123
4124 if (len == REDIS_RDB_LENERR) return NULL;
4125 val = sdsnewlen(NULL,len);
4126 if (len && fread(val,len,1,fp) == 0) {
4127 sdsfree(val);
4128 return NULL;
4129 }
4130 return createObject(REDIS_STRING,val);
4131 }
4132
4133 static robj *rdbLoadStringObject(FILE *fp) {
4134 return rdbGenericLoadStringObject(fp,0);
4135 }
4136
4137 static robj *rdbLoadEncodedStringObject(FILE *fp) {
4138 return rdbGenericLoadStringObject(fp,1);
4139 }
4140
4141 /* For information about double serialization check rdbSaveDoubleValue() */
4142 static int rdbLoadDoubleValue(FILE *fp, double *val) {
4143 char buf[128];
4144 unsigned char len;
4145
4146 if (fread(&len,1,1,fp) == 0) return -1;
4147 switch(len) {
4148 case 255: *val = R_NegInf; return 0;
4149 case 254: *val = R_PosInf; return 0;
4150 case 253: *val = R_Nan; return 0;
4151 default:
4152 if (fread(buf,len,1,fp) == 0) return -1;
4153 buf[len] = '\0';
4154 sscanf(buf, "%lg", val);
4155 return 0;
4156 }
4157 }
4158
4159 /* Load a Redis object of the specified type from the specified file.
4160 * On success a newly allocated object is returned, otherwise NULL. */
4161 static robj *rdbLoadObject(int type, FILE *fp) {
4162 robj *o, *ele, *dec;
4163 size_t len;
4164
4165 redisLog(REDIS_DEBUG,"LOADING OBJECT %d (at %d)\n",type,ftell(fp));
4166 if (type == REDIS_STRING) {
4167 /* Read string value */
4168 if ((o = rdbLoadEncodedStringObject(fp)) == NULL) return NULL;
4169 o = tryObjectEncoding(o);
4170 } else if (type == REDIS_LIST) {
4171 /* Read list value */
4172 if ((len = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
4173
4174 /* Use a real list when there are too many entries */
4175 if (len > server.list_max_ziplist_entries) {
4176 o = createListObject();
4177 } else {
4178 o = createZiplistObject();
4179 }
4180
4181 /* Load every single element of the list */
4182 while(len--) {
4183 if ((ele = rdbLoadEncodedStringObject(fp)) == NULL) return NULL;
4184
4185 /* If we are using a ziplist and the value is too big, convert
4186 * the object to a real list. */
4187 if (o->encoding == REDIS_ENCODING_ZIPLIST &&
4188 ele->encoding == REDIS_ENCODING_RAW &&
4189 sdslen(ele->ptr) > server.list_max_ziplist_value)
4190 listTypeConvert(o,REDIS_ENCODING_LIST);
4191
4192 if (o->encoding == REDIS_ENCODING_ZIPLIST) {
4193 dec = getDecodedObject(ele);
4194 o->ptr = ziplistPush(o->ptr,dec->ptr,sdslen(dec->ptr),REDIS_TAIL);
4195 decrRefCount(dec);
4196 decrRefCount(ele);
4197 } else {
4198 ele = tryObjectEncoding(ele);
4199 listAddNodeTail(o->ptr,ele);
4200 }
4201 }
4202 } else if (type == REDIS_SET) {
4203 /* Read list/set value */
4204 if ((len = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
4205 o = createSetObject();
4206 /* It's faster to expand the dict to the right size asap in order
4207 * to avoid rehashing */
4208 if (len > DICT_HT_INITIAL_SIZE)
4209 dictExpand(o->ptr,len);
4210 /* Load every single element of the list/set */
4211 while(len--) {
4212 if ((ele = rdbLoadEncodedStringObject(fp)) == NULL) return NULL;
4213 ele = tryObjectEncoding(ele);
4214 dictAdd((dict*)o->ptr,ele,NULL);
4215 }
4216 } else if (type == REDIS_ZSET) {
4217 /* Read list/set value */
4218 size_t zsetlen;
4219 zset *zs;
4220
4221 if ((zsetlen = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
4222 o = createZsetObject();
4223 zs = o->ptr;
4224 /* Load every single element of the list/set */
4225 while(zsetlen--) {
4226 robj *ele;
4227 double *score = zmalloc(sizeof(double));
4228
4229 if ((ele = rdbLoadEncodedStringObject(fp)) == NULL) return NULL;
4230 ele = tryObjectEncoding(ele);
4231 if (rdbLoadDoubleValue(fp,score) == -1) return NULL;
4232 dictAdd(zs->dict,ele,score);
4233 zslInsert(zs->zsl,*score,ele);
4234 incrRefCount(ele); /* added to skiplist */
4235 }
4236 } else if (type == REDIS_HASH) {
4237 size_t hashlen;
4238
4239 if ((hashlen = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
4240 o = createHashObject();
4241 /* Too many entries? Use an hash table. */
4242 if (hashlen > server.hash_max_zipmap_entries)
4243 convertToRealHash(o);
4244 /* Load every key/value, then set it into the zipmap or hash
4245 * table, as needed. */
4246 while(hashlen--) {
4247 robj *key, *val;
4248
4249 if ((key = rdbLoadStringObject(fp)) == NULL) return NULL;
4250 if ((val = rdbLoadStringObject(fp)) == NULL) return NULL;
4251 /* If we are using a zipmap and there are too big values
4252 * the object is converted to real hash table encoding. */
4253 if (o->encoding != REDIS_ENCODING_HT &&
4254 (sdslen(key->ptr) > server.hash_max_zipmap_value ||
4255 sdslen(val->ptr) > server.hash_max_zipmap_value))
4256 {
4257 convertToRealHash(o);
4258 }
4259
4260 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
4261 unsigned char *zm = o->ptr;
4262
4263 zm = zipmapSet(zm,key->ptr,sdslen(key->ptr),
4264 val->ptr,sdslen(val->ptr),NULL);
4265 o->ptr = zm;
4266 decrRefCount(key);
4267 decrRefCount(val);
4268 } else {
4269 key = tryObjectEncoding(key);
4270 val = tryObjectEncoding(val);
4271 dictAdd((dict*)o->ptr,key,val);
4272 }
4273 }
4274 } else {
4275 redisPanic("Unknown object type");
4276 }
4277 return o;
4278 }
4279
4280 static int rdbLoad(char *filename) {
4281 FILE *fp;
4282 uint32_t dbid;
4283 int type, retval, rdbver;
4284 int swap_all_values = 0;
4285 redisDb *db = server.db+0;
4286 char buf[1024];
4287 time_t expiretime, now = time(NULL);
4288
4289 fp = fopen(filename,"r");
4290 if (!fp) return REDIS_ERR;
4291 if (fread(buf,9,1,fp) == 0) goto eoferr;
4292 buf[9] = '\0';
4293 if (memcmp(buf,"REDIS",5) != 0) {
4294 fclose(fp);
4295 redisLog(REDIS_WARNING,"Wrong signature trying to load DB from file");
4296 return REDIS_ERR;
4297 }
4298 rdbver = atoi(buf+5);
4299 if (rdbver != 1) {
4300 fclose(fp);
4301 redisLog(REDIS_WARNING,"Can't handle RDB format version %d",rdbver);
4302 return REDIS_ERR;
4303 }
4304 while(1) {
4305 robj *key, *val;
4306 int force_swapout;
4307
4308 expiretime = -1;
4309 /* Read type. */
4310 if ((type = rdbLoadType(fp)) == -1) goto eoferr;
4311 if (type == REDIS_EXPIRETIME) {
4312 if ((expiretime = rdbLoadTime(fp)) == -1) goto eoferr;
4313 /* We read the time so we need to read the object type again */
4314 if ((type = rdbLoadType(fp)) == -1) goto eoferr;
4315 }
4316 if (type == REDIS_EOF) break;
4317 /* Handle SELECT DB opcode as a special case */
4318 if (type == REDIS_SELECTDB) {
4319 if ((dbid = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR)
4320 goto eoferr;
4321 if (dbid >= (unsigned)server.dbnum) {
4322 redisLog(REDIS_WARNING,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server.dbnum);
4323 exit(1);
4324 }
4325 db = server.db+dbid;
4326 continue;
4327 }
4328 /* Read key */
4329 if ((key = rdbLoadStringObject(fp)) == NULL) goto eoferr;
4330 /* Read value */
4331 if ((val = rdbLoadObject(type,fp)) == NULL) goto eoferr;
4332 /* Check if the key already expired */
4333 if (expiretime != -1 && expiretime < now) {
4334 decrRefCount(key);
4335 decrRefCount(val);
4336 continue;
4337 }
4338 /* Add the new object in the hash table */
4339 retval = dbAdd(db,key,val);
4340 if (retval == REDIS_ERR) {
4341 redisLog(REDIS_WARNING,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", key->ptr);
4342 exit(1);
4343 }
4344 /* Set the expire time if needed */
4345 if (expiretime != -1) setExpire(db,key,expiretime);
4346
4347 /* Handle swapping while loading big datasets when VM is on */
4348
4349 /* If we detecter we are hopeless about fitting something in memory
4350 * we just swap every new key on disk. Directly...
4351 * Note that's important to check for this condition before resorting
4352 * to random sampling, otherwise we may try to swap already
4353 * swapped keys. */
4354 if (swap_all_values) {
4355 dictEntry *de = dictFind(db->dict,key->ptr);
4356
4357 /* de may be NULL since the key already expired */
4358 if (de) {
4359 vmpointer *vp;
4360 val = dictGetEntryVal(de);
4361
4362 if (val->refcount == 1 &&
4363 (vp = vmSwapObjectBlocking(val)) != NULL)
4364 dictGetEntryVal(de) = vp;
4365 }
4366 decrRefCount(key);
4367 continue;
4368 }
4369 decrRefCount(key);
4370
4371 /* Flush data on disk once 32 MB of additional RAM are used... */
4372 force_swapout = 0;
4373 if ((zmalloc_used_memory() - server.vm_max_memory) > 1024*1024*32)
4374 force_swapout = 1;
4375
4376 /* If we have still some hope of having some value fitting memory
4377 * then we try random sampling. */
4378 if (!swap_all_values && server.vm_enabled && force_swapout) {
4379 while (zmalloc_used_memory() > server.vm_max_memory) {
4380 if (vmSwapOneObjectBlocking() == REDIS_ERR) break;
4381 }
4382 if (zmalloc_used_memory() > server.vm_max_memory)
4383 swap_all_values = 1; /* We are already using too much mem */
4384 }
4385 }
4386 fclose(fp);
4387 return REDIS_OK;
4388
4389 eoferr: /* unexpected end of file is handled here with a fatal exit */
4390 redisLog(REDIS_WARNING,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
4391 exit(1);
4392 return REDIS_ERR; /* Just to avoid warning */
4393 }
4394
4395 /*================================== Shutdown =============================== */
4396 static int prepareForShutdown() {
4397 redisLog(REDIS_WARNING,"User requested shutdown, saving DB...");
4398 /* Kill the saving child if there is a background saving in progress.
4399 We want to avoid race conditions, for instance our saving child may
4400 overwrite the synchronous saving did by SHUTDOWN. */
4401 if (server.bgsavechildpid != -1) {
4402 redisLog(REDIS_WARNING,"There is a live saving child. Killing it!");
4403 kill(server.bgsavechildpid,SIGKILL);
4404 rdbRemoveTempFile(server.bgsavechildpid);
4405 }
4406 if (server.appendonly) {
4407 /* Append only file: fsync() the AOF and exit */
4408 aof_fsync(server.appendfd);
4409 if (server.vm_enabled) unlink(server.vm_swap_file);
4410 } else {
4411 /* Snapshotting. Perform a SYNC SAVE and exit */
4412 if (rdbSave(server.dbfilename) == REDIS_OK) {
4413 if (server.daemonize)
4414 unlink(server.pidfile);
4415 redisLog(REDIS_WARNING,"%zu bytes used at exit",zmalloc_used_memory());
4416 } else {
4417 /* Ooops.. error saving! The best we can do is to continue
4418 * operating. Note that if there was a background saving process,
4419 * in the next cron() Redis will be notified that the background
4420 * saving aborted, handling special stuff like slaves pending for
4421 * synchronization... */
4422 redisLog(REDIS_WARNING,"Error trying to save the DB, can't exit");
4423 return REDIS_ERR;
4424 }
4425 }
4426 redisLog(REDIS_WARNING,"Server exit now, bye bye...");
4427 return REDIS_OK;
4428 }
4429
4430 /*================================== Commands =============================== */
4431
4432 static void authCommand(redisClient *c) {
4433 if (!server.requirepass || !strcmp(c->argv[1]->ptr, server.requirepass)) {
4434 c->authenticated = 1;
4435 addReply(c,shared.ok);
4436 } else {
4437 c->authenticated = 0;
4438 addReplySds(c,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
4439 }
4440 }
4441
4442 static void pingCommand(redisClient *c) {
4443 addReply(c,shared.pong);
4444 }
4445
4446 static void echoCommand(redisClient *c) {
4447 addReplyBulk(c,c->argv[1]);
4448 }
4449
4450 /*=================================== Strings =============================== */
4451
4452 static void setGenericCommand(redisClient *c, int nx, robj *key, robj *val, robj *expire) {
4453 int retval;
4454 long seconds = 0; /* initialized to avoid an harmness warning */
4455
4456 if (expire) {
4457 if (getLongFromObjectOrReply(c, expire, &seconds, NULL) != REDIS_OK)
4458 return;
4459 if (seconds <= 0) {
4460 addReplySds(c,sdsnew("-ERR invalid expire time in SETEX\r\n"));
4461 return;
4462 }
4463 }
4464
4465 touchWatchedKey(c->db,key);
4466 if (nx) deleteIfVolatile(c->db,key);
4467 retval = dbAdd(c->db,key,val);
4468 if (retval == REDIS_ERR) {
4469 if (!nx) {
4470 dbReplace(c->db,key,val);
4471 incrRefCount(val);
4472 } else {
4473 addReply(c,shared.czero);
4474 return;
4475 }
4476 } else {
4477 incrRefCount(val);
4478 }
4479 server.dirty++;
4480 removeExpire(c->db,key);
4481 if (expire) setExpire(c->db,key,time(NULL)+seconds);
4482 addReply(c, nx ? shared.cone : shared.ok);
4483 }
4484
4485 static void setCommand(redisClient *c) {
4486 setGenericCommand(c,0,c->argv[1],c->argv[2],NULL);
4487 }
4488
4489 static void setnxCommand(redisClient *c) {
4490 setGenericCommand(c,1,c->argv[1],c->argv[2],NULL);
4491 }
4492
4493 static void setexCommand(redisClient *c) {
4494 setGenericCommand(c,0,c->argv[1],c->argv[3],c->argv[2]);
4495 }
4496
4497 static int getGenericCommand(redisClient *c) {
4498 robj *o;
4499
4500 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL)
4501 return REDIS_OK;
4502
4503 if (o->type != REDIS_STRING) {
4504 addReply(c,shared.wrongtypeerr);
4505 return REDIS_ERR;
4506 } else {
4507 addReplyBulk(c,o);
4508 return REDIS_OK;
4509 }
4510 }
4511
4512 static void getCommand(redisClient *c) {
4513 getGenericCommand(c);
4514 }
4515
4516 static void getsetCommand(redisClient *c) {
4517 if (getGenericCommand(c) == REDIS_ERR) return;
4518 dbReplace(c->db,c->argv[1],c->argv[2]);
4519 incrRefCount(c->argv[2]);
4520 server.dirty++;
4521 removeExpire(c->db,c->argv[1]);
4522 }
4523
4524 static void mgetCommand(redisClient *c) {
4525 int j;
4526
4527 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",c->argc-1));
4528 for (j = 1; j < c->argc; j++) {
4529 robj *o = lookupKeyRead(c->db,c->argv[j]);
4530 if (o == NULL) {
4531 addReply(c,shared.nullbulk);
4532 } else {
4533 if (o->type != REDIS_STRING) {
4534 addReply(c,shared.nullbulk);
4535 } else {
4536 addReplyBulk(c,o);
4537 }
4538 }
4539 }
4540 }
4541
4542 static void msetGenericCommand(redisClient *c, int nx) {
4543 int j, busykeys = 0;
4544
4545 if ((c->argc % 2) == 0) {
4546 addReplySds(c,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
4547 return;
4548 }
4549 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
4550 * set nothing at all if at least one already key exists. */
4551 if (nx) {
4552 for (j = 1; j < c->argc; j += 2) {
4553 if (lookupKeyWrite(c->db,c->argv[j]) != NULL) {
4554 busykeys++;
4555 }
4556 }
4557 }
4558 if (busykeys) {
4559 addReply(c, shared.czero);
4560 return;
4561 }
4562
4563 for (j = 1; j < c->argc; j += 2) {
4564 c->argv[j+1] = tryObjectEncoding(c->argv[j+1]);
4565 dbReplace(c->db,c->argv[j],c->argv[j+1]);
4566 incrRefCount(c->argv[j+1]);
4567 removeExpire(c->db,c->argv[j]);
4568 }
4569 server.dirty += (c->argc-1)/2;
4570 addReply(c, nx ? shared.cone : shared.ok);
4571 }
4572
4573 static void msetCommand(redisClient *c) {
4574 msetGenericCommand(c,0);
4575 }
4576
4577 static void msetnxCommand(redisClient *c) {
4578 msetGenericCommand(c,1);
4579 }
4580
4581 static void incrDecrCommand(redisClient *c, long long incr) {
4582 long long value;
4583 robj *o;
4584
4585 o = lookupKeyWrite(c->db,c->argv[1]);
4586 if (o != NULL && checkType(c,o,REDIS_STRING)) return;
4587 if (getLongLongFromObjectOrReply(c,o,&value,NULL) != REDIS_OK) return;
4588
4589 value += incr;
4590 o = createStringObjectFromLongLong(value);
4591 dbReplace(c->db,c->argv[1],o);
4592 server.dirty++;
4593 addReply(c,shared.colon);
4594 addReply(c,o);
4595 addReply(c,shared.crlf);
4596 }
4597
4598 static void incrCommand(redisClient *c) {
4599 incrDecrCommand(c,1);
4600 }
4601
4602 static void decrCommand(redisClient *c) {
4603 incrDecrCommand(c,-1);
4604 }
4605
4606 static void incrbyCommand(redisClient *c) {
4607 long long incr;
4608
4609 if (getLongLongFromObjectOrReply(c, c->argv[2], &incr, NULL) != REDIS_OK) return;
4610 incrDecrCommand(c,incr);
4611 }
4612
4613 static void decrbyCommand(redisClient *c) {
4614 long long incr;
4615
4616 if (getLongLongFromObjectOrReply(c, c->argv[2], &incr, NULL) != REDIS_OK) return;
4617 incrDecrCommand(c,-incr);
4618 }
4619
4620 static void appendCommand(redisClient *c) {
4621 int retval;
4622 size_t totlen;
4623 robj *o;
4624
4625 o = lookupKeyWrite(c->db,c->argv[1]);
4626 if (o == NULL) {
4627 /* Create the key */
4628 retval = dbAdd(c->db,c->argv[1],c->argv[2]);
4629 incrRefCount(c->argv[2]);
4630 totlen = stringObjectLen(c->argv[2]);
4631 } else {
4632 if (o->type != REDIS_STRING) {
4633 addReply(c,shared.wrongtypeerr);
4634 return;
4635 }
4636 /* If the object is specially encoded or shared we have to make
4637 * a copy */
4638 if (o->refcount != 1 || o->encoding != REDIS_ENCODING_RAW) {
4639 robj *decoded = getDecodedObject(o);
4640
4641 o = createStringObject(decoded->ptr, sdslen(decoded->ptr));
4642 decrRefCount(decoded);
4643 dbReplace(c->db,c->argv[1],o);
4644 }
4645 /* APPEND! */
4646 if (c->argv[2]->encoding == REDIS_ENCODING_RAW) {
4647 o->ptr = sdscatlen(o->ptr,
4648 c->argv[2]->ptr, sdslen(c->argv[2]->ptr));
4649 } else {
4650 o->ptr = sdscatprintf(o->ptr, "%ld",
4651 (unsigned long) c->argv[2]->ptr);
4652 }
4653 totlen = sdslen(o->ptr);
4654 }
4655 server.dirty++;
4656 addReplySds(c,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen));
4657 }
4658
4659 static void substrCommand(redisClient *c) {
4660 robj *o;
4661 long start = atoi(c->argv[2]->ptr);
4662 long end = atoi(c->argv[3]->ptr);
4663 size_t rangelen, strlen;
4664 sds range;
4665
4666 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
4667 checkType(c,o,REDIS_STRING)) return;
4668
4669 o = getDecodedObject(o);
4670 strlen = sdslen(o->ptr);
4671
4672 /* convert negative indexes */
4673 if (start < 0) start = strlen+start;
4674 if (end < 0) end = strlen+end;
4675 if (start < 0) start = 0;
4676 if (end < 0) end = 0;
4677
4678 /* indexes sanity checks */
4679 if (start > end || (size_t)start >= strlen) {
4680 /* Out of range start or start > end result in null reply */
4681 addReply(c,shared.nullbulk);
4682 decrRefCount(o);
4683 return;
4684 }
4685 if ((size_t)end >= strlen) end = strlen-1;
4686 rangelen = (end-start)+1;
4687
4688 /* Return the result */
4689 addReplySds(c,sdscatprintf(sdsempty(),"$%zu\r\n",rangelen));
4690 range = sdsnewlen((char*)o->ptr+start,rangelen);
4691 addReplySds(c,range);
4692 addReply(c,shared.crlf);
4693 decrRefCount(o);
4694 }
4695
4696 /* ========================= Type agnostic commands ========================= */
4697
4698 static void delCommand(redisClient *c) {
4699 int deleted = 0, j;
4700
4701 for (j = 1; j < c->argc; j++) {
4702 if (dbDelete(c->db,c->argv[j])) {
4703 touchWatchedKey(c->db,c->argv[j]);
4704 server.dirty++;
4705 deleted++;
4706 }
4707 }
4708 addReplyLongLong(c,deleted);
4709 }
4710
4711 static void existsCommand(redisClient *c) {
4712 expireIfNeeded(c->db,c->argv[1]);
4713 if (dbExists(c->db,c->argv[1])) {
4714 addReply(c, shared.cone);
4715 } else {
4716 addReply(c, shared.czero);
4717 }
4718 }
4719
4720 static void selectCommand(redisClient *c) {
4721 int id = atoi(c->argv[1]->ptr);
4722
4723 if (selectDb(c,id) == REDIS_ERR) {
4724 addReplySds(c,sdsnew("-ERR invalid DB index\r\n"));
4725 } else {
4726 addReply(c,shared.ok);
4727 }
4728 }
4729
4730 static void randomkeyCommand(redisClient *c) {
4731 robj *key;
4732
4733 if ((key = dbRandomKey(c->db)) == NULL) {
4734 addReply(c,shared.nullbulk);
4735 return;
4736 }
4737
4738 addReplyBulk(c,key);
4739 decrRefCount(key);
4740 }
4741
4742 static void keysCommand(redisClient *c) {
4743 dictIterator *di;
4744 dictEntry *de;
4745 sds pattern = c->argv[1]->ptr;
4746 int plen = sdslen(pattern);
4747 unsigned long numkeys = 0;
4748 robj *lenobj = createObject(REDIS_STRING,NULL);
4749
4750 di = dictGetIterator(c->db->dict);
4751 addReply(c,lenobj);
4752 decrRefCount(lenobj);
4753 while((de = dictNext(di)) != NULL) {
4754 sds key = dictGetEntryKey(de);
4755 robj *keyobj;
4756
4757 if ((pattern[0] == '*' && pattern[1] == '\0') ||
4758 stringmatchlen(pattern,plen,key,sdslen(key),0)) {
4759 keyobj = createStringObject(key,sdslen(key));
4760 if (expireIfNeeded(c->db,keyobj) == 0) {
4761 addReplyBulk(c,keyobj);
4762 numkeys++;
4763 }
4764 decrRefCount(keyobj);
4765 }
4766 }
4767 dictReleaseIterator(di);
4768 lenobj->ptr = sdscatprintf(sdsempty(),"*%lu\r\n",numkeys);
4769 }
4770
4771 static void dbsizeCommand(redisClient *c) {
4772 addReplySds(c,
4773 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c->db->dict)));
4774 }
4775
4776 static void lastsaveCommand(redisClient *c) {
4777 addReplySds(c,
4778 sdscatprintf(sdsempty(),":%lu\r\n",server.lastsave));
4779 }
4780
4781 static void typeCommand(redisClient *c) {
4782 robj *o;
4783 char *type;
4784
4785 o = lookupKeyRead(c->db,c->argv[1]);
4786 if (o == NULL) {
4787 type = "+none";
4788 } else {
4789 switch(o->type) {
4790 case REDIS_STRING: type = "+string"; break;
4791 case REDIS_LIST: type = "+list"; break;
4792 case REDIS_SET: type = "+set"; break;
4793 case REDIS_ZSET: type = "+zset"; break;
4794 case REDIS_HASH: type = "+hash"; break;
4795 default: type = "+unknown"; break;
4796 }
4797 }
4798 addReplySds(c,sdsnew(type));
4799 addReply(c,shared.crlf);
4800 }
4801
4802 static void saveCommand(redisClient *c) {
4803 if (server.bgsavechildpid != -1) {
4804 addReplySds(c,sdsnew("-ERR background save in progress\r\n"));
4805 return;
4806 }
4807 if (rdbSave(server.dbfilename) == REDIS_OK) {
4808 addReply(c,shared.ok);
4809 } else {
4810 addReply(c,shared.err);
4811 }
4812 }
4813
4814 static void bgsaveCommand(redisClient *c) {
4815 if (server.bgsavechildpid != -1) {
4816 addReplySds(c,sdsnew("-ERR background save already in progress\r\n"));
4817 return;
4818 }
4819 if (rdbSaveBackground(server.dbfilename) == REDIS_OK) {
4820 char *status = "+Background saving started\r\n";
4821 addReplySds(c,sdsnew(status));
4822 } else {
4823 addReply(c,shared.err);
4824 }
4825 }
4826
4827 static void shutdownCommand(redisClient *c) {
4828 if (prepareForShutdown() == REDIS_OK)
4829 exit(0);
4830 addReplySds(c, sdsnew("-ERR Errors trying to SHUTDOWN. Check logs.\r\n"));
4831 }
4832
4833 static void renameGenericCommand(redisClient *c, int nx) {
4834 robj *o;
4835
4836 /* To use the same key as src and dst is probably an error */
4837 if (sdscmp(c->argv[1]->ptr,c->argv[2]->ptr) == 0) {
4838 addReply(c,shared.sameobjecterr);
4839 return;
4840 }
4841
4842 if ((o = lookupKeyWriteOrReply(c,c->argv[1],shared.nokeyerr)) == NULL)
4843 return;
4844
4845 incrRefCount(o);
4846 deleteIfVolatile(c->db,c->argv[2]);
4847 if (dbAdd(c->db,c->argv[2],o) == REDIS_ERR) {
4848 if (nx) {
4849 decrRefCount(o);
4850 addReply(c,shared.czero);
4851 return;
4852 }
4853 dbReplace(c->db,c->argv[2],o);
4854 }
4855 dbDelete(c->db,c->argv[1]);
4856 touchWatchedKey(c->db,c->argv[2]);
4857 server.dirty++;
4858 addReply(c,nx ? shared.cone : shared.ok);
4859 }
4860
4861 static void renameCommand(redisClient *c) {
4862 renameGenericCommand(c,0);
4863 }
4864
4865 static void renamenxCommand(redisClient *c) {
4866 renameGenericCommand(c,1);
4867 }
4868
4869 static void moveCommand(redisClient *c) {
4870 robj *o;
4871 redisDb *src, *dst;
4872 int srcid;
4873
4874 /* Obtain source and target DB pointers */
4875 src = c->db;
4876 srcid = c->db->id;
4877 if (selectDb(c,atoi(c->argv[2]->ptr)) == REDIS_ERR) {
4878 addReply(c,shared.outofrangeerr);
4879 return;
4880 }
4881 dst = c->db;
4882 selectDb(c,srcid); /* Back to the source DB */
4883
4884 /* If the user is moving using as target the same
4885 * DB as the source DB it is probably an error. */
4886 if (src == dst) {
4887 addReply(c,shared.sameobjecterr);
4888 return;
4889 }
4890
4891 /* Check if the element exists and get a reference */
4892 o = lookupKeyWrite(c->db,c->argv[1]);
4893 if (!o) {
4894 addReply(c,shared.czero);
4895 return;
4896 }
4897
4898 /* Try to add the element to the target DB */
4899 deleteIfVolatile(dst,c->argv[1]);
4900 if (dbAdd(dst,c->argv[1],o) == REDIS_ERR) {
4901 addReply(c,shared.czero);
4902 return;
4903 }
4904 incrRefCount(o);
4905
4906 /* OK! key moved, free the entry in the source DB */
4907 dbDelete(src,c->argv[1]);
4908 server.dirty++;
4909 addReply(c,shared.cone);
4910 }
4911
4912 /* =================================== Lists ================================ */
4913
4914
4915 /* Check the argument length to see if it requires us to convert the ziplist
4916 * to a real list. Only check raw-encoded objects because integer encoded
4917 * objects are never too long. */
4918 static void listTypeTryConversion(robj *subject, robj *value) {
4919 if (subject->encoding != REDIS_ENCODING_ZIPLIST) return;
4920 if (value->encoding == REDIS_ENCODING_RAW &&
4921 sdslen(value->ptr) > server.list_max_ziplist_value)
4922 listTypeConvert(subject,REDIS_ENCODING_LIST);
4923 }
4924
4925 static void listTypePush(robj *subject, robj *value, int where) {
4926 /* Check if we need to convert the ziplist */
4927 listTypeTryConversion(subject,value);
4928 if (subject->encoding == REDIS_ENCODING_ZIPLIST &&
4929 ziplistLen(subject->ptr) >= server.list_max_ziplist_entries)
4930 listTypeConvert(subject,REDIS_ENCODING_LIST);
4931
4932 if (subject->encoding == REDIS_ENCODING_ZIPLIST) {
4933 int pos = (where == REDIS_HEAD) ? ZIPLIST_HEAD : ZIPLIST_TAIL;
4934 value = getDecodedObject(value);
4935 subject->ptr = ziplistPush(subject->ptr,value->ptr,sdslen(value->ptr),pos);
4936 decrRefCount(value);
4937 } else if (subject->encoding == REDIS_ENCODING_LIST) {
4938 if (where == REDIS_HEAD) {
4939 listAddNodeHead(subject->ptr,value);
4940 } else {
4941 listAddNodeTail(subject->ptr,value);
4942 }
4943 incrRefCount(value);
4944 } else {
4945 redisPanic("Unknown list encoding");
4946 }
4947 }
4948
4949 static robj *listTypePop(robj *subject, int where) {
4950 robj *value = NULL;
4951 if (subject->encoding == REDIS_ENCODING_ZIPLIST) {
4952 unsigned char *p;
4953 unsigned char *vstr;
4954 unsigned int vlen;
4955 long long vlong;
4956 int pos = (where == REDIS_HEAD) ? 0 : -1;
4957 p = ziplistIndex(subject->ptr,pos);
4958 if (ziplistGet(p,&vstr,&vlen,&vlong)) {
4959 if (vstr) {
4960 value = createStringObject((char*)vstr,vlen);
4961 } else {
4962 value = createStringObjectFromLongLong(vlong);
4963 }
4964 /* We only need to delete an element when it exists */
4965 subject->ptr = ziplistDelete(subject->ptr,&p);
4966 }
4967 } else if (subject->encoding == REDIS_ENCODING_LIST) {
4968 list *list = subject->ptr;
4969 listNode *ln;
4970 if (where == REDIS_HEAD) {
4971 ln = listFirst(list);
4972 } else {
4973 ln = listLast(list);
4974 }
4975 if (ln != NULL) {
4976 value = listNodeValue(ln);
4977 incrRefCount(value);
4978 listDelNode(list,ln);
4979 }
4980 } else {
4981 redisPanic("Unknown list encoding");
4982 }
4983 return value;
4984 }
4985
4986 static unsigned long listTypeLength(robj *subject) {
4987 if (subject->encoding == REDIS_ENCODING_ZIPLIST) {
4988 return ziplistLen(subject->ptr);
4989 } else if (subject->encoding == REDIS_ENCODING_LIST) {
4990 return listLength((list*)subject->ptr);
4991 } else {
4992 redisPanic("Unknown list encoding");
4993 }
4994 }
4995
4996 /* Structure to hold set iteration abstraction. */
4997 typedef struct {
4998 robj *subject;
4999 unsigned char encoding;
5000 unsigned char direction; /* Iteration direction */
5001 unsigned char *zi;
5002 listNode *ln;
5003 } listTypeIterator;
5004
5005 /* Structure for an entry while iterating over a list. */
5006 typedef struct {
5007 listTypeIterator *li;
5008 unsigned char *zi; /* Entry in ziplist */
5009 listNode *ln; /* Entry in linked list */
5010 } listTypeEntry;
5011
5012 /* Initialize an iterator at the specified index. */
5013 static listTypeIterator *listTypeInitIterator(robj *subject, int index, unsigned char direction) {
5014 listTypeIterator *li = zmalloc(sizeof(listTypeIterator));
5015 li->subject = subject;
5016 li->encoding = subject->encoding;
5017 li->direction = direction;
5018 if (li->encoding == REDIS_ENCODING_ZIPLIST) {
5019 li->zi = ziplistIndex(subject->ptr,index);
5020 } else if (li->encoding == REDIS_ENCODING_LIST) {
5021 li->ln = listIndex(subject->ptr,index);
5022 } else {
5023 redisPanic("Unknown list encoding");
5024 }
5025 return li;
5026 }
5027
5028 /* Clean up the iterator. */
5029 static void listTypeReleaseIterator(listTypeIterator *li) {
5030 zfree(li);
5031 }
5032
5033 /* Stores pointer to current the entry in the provided entry structure
5034 * and advances the position of the iterator. Returns 1 when the current
5035 * entry is in fact an entry, 0 otherwise. */
5036 static int listTypeNext(listTypeIterator *li, listTypeEntry *entry) {
5037 /* Protect from converting when iterating */
5038 redisAssert(li->subject->encoding == li->encoding);
5039
5040 entry->li = li;
5041 if (li->encoding == REDIS_ENCODING_ZIPLIST) {
5042 entry->zi = li->zi;
5043 if (entry->zi != NULL) {
5044 if (li->direction == REDIS_TAIL)
5045 li->zi = ziplistNext(li->subject->ptr,li->zi);
5046 else
5047 li->zi = ziplistPrev(li->subject->ptr,li->zi);
5048 return 1;
5049 }
5050 } else if (li->encoding == REDIS_ENCODING_LIST) {
5051 entry->ln = li->ln;
5052 if (entry->ln != NULL) {
5053 if (li->direction == REDIS_TAIL)
5054 li->ln = li->ln->next;
5055 else
5056 li->ln = li->ln->prev;
5057 return 1;
5058 }
5059 } else {
5060 redisPanic("Unknown list encoding");
5061 }
5062 return 0;
5063 }
5064
5065 /* Return entry or NULL at the current position of the iterator. */
5066 static robj *listTypeGet(listTypeEntry *entry) {
5067 listTypeIterator *li = entry->li;
5068 robj *value = NULL;
5069 if (li->encoding == REDIS_ENCODING_ZIPLIST) {
5070 unsigned char *vstr;
5071 unsigned int vlen;
5072 long long vlong;
5073 redisAssert(entry->zi != NULL);
5074 if (ziplistGet(entry->zi,&vstr,&vlen,&vlong)) {
5075 if (vstr) {
5076 value = createStringObject((char*)vstr,vlen);
5077 } else {
5078 value = createStringObjectFromLongLong(vlong);
5079 }
5080 }
5081 } else if (li->encoding == REDIS_ENCODING_LIST) {
5082 redisAssert(entry->ln != NULL);
5083 value = listNodeValue(entry->ln);
5084 incrRefCount(value);
5085 } else {
5086 redisPanic("Unknown list encoding");
5087 }
5088 return value;
5089 }
5090
5091 static void listTypeInsert(listTypeEntry *entry, robj *value, int where) {
5092 robj *subject = entry->li->subject;
5093 if (entry->li->encoding == REDIS_ENCODING_ZIPLIST) {
5094 value = getDecodedObject(value);
5095 if (where == REDIS_TAIL) {
5096 unsigned char *next = ziplistNext(subject->ptr,entry->zi);
5097
5098 /* When we insert after the current element, but the current element
5099 * is the tail of the list, we need to do a push. */
5100 if (next == NULL) {
5101 subject->ptr = ziplistPush(subject->ptr,value->ptr,sdslen(value->ptr),REDIS_TAIL);
5102 } else {
5103 subject->ptr = ziplistInsert(subject->ptr,next,value->ptr,sdslen(value->ptr));
5104 }
5105 } else {
5106 subject->ptr = ziplistInsert(subject->ptr,entry->zi,value->ptr,sdslen(value->ptr));
5107 }
5108 decrRefCount(value);
5109 } else if (entry->li->encoding == REDIS_ENCODING_LIST) {
5110 if (where == REDIS_TAIL) {
5111 listInsertNode(subject->ptr,entry->ln,value,AL_START_TAIL);
5112 } else {
5113 listInsertNode(subject->ptr,entry->ln,value,AL_START_HEAD);
5114 }
5115 incrRefCount(value);
5116 } else {
5117 redisPanic("Unknown list encoding");
5118 }
5119 }
5120
5121 /* Compare the given object with the entry at the current position. */
5122 static int listTypeEqual(listTypeEntry *entry, robj *o) {
5123 listTypeIterator *li = entry->li;
5124 if (li->encoding == REDIS_ENCODING_ZIPLIST) {
5125 redisAssert(o->encoding == REDIS_ENCODING_RAW);
5126 return ziplistCompare(entry->zi,o->ptr,sdslen(o->ptr));
5127 } else if (li->encoding == REDIS_ENCODING_LIST) {
5128 return equalStringObjects(o,listNodeValue(entry->ln));
5129 } else {
5130 redisPanic("Unknown list encoding");
5131 }
5132 }
5133
5134 /* Delete the element pointed to. */
5135 static void listTypeDelete(listTypeEntry *entry) {
5136 listTypeIterator *li = entry->li;
5137 if (li->encoding == REDIS_ENCODING_ZIPLIST) {
5138 unsigned char *p = entry->zi;
5139 li->subject->ptr = ziplistDelete(li->subject->ptr,&p);
5140
5141 /* Update position of the iterator depending on the direction */
5142 if (li->direction == REDIS_TAIL)
5143 li->zi = p;
5144 else
5145 li->zi = ziplistPrev(li->subject->ptr,p);
5146 } else if (entry->li->encoding == REDIS_ENCODING_LIST) {
5147 listNode *next;
5148 if (li->direction == REDIS_TAIL)
5149 next = entry->ln->next;
5150 else
5151 next = entry->ln->prev;
5152 listDelNode(li->subject->ptr,entry->ln);
5153 li->ln = next;
5154 } else {
5155 redisPanic("Unknown list encoding");
5156 }
5157 }
5158
5159 static void listTypeConvert(robj *subject, int enc) {
5160 listTypeIterator *li;
5161 listTypeEntry entry;
5162 redisAssert(subject->type == REDIS_LIST);
5163
5164 if (enc == REDIS_ENCODING_LIST) {
5165 list *l = listCreate();
5166 listSetFreeMethod(l,decrRefCount);
5167
5168 /* listTypeGet returns a robj with incremented refcount */
5169 li = listTypeInitIterator(subject,0,REDIS_TAIL);
5170 while (listTypeNext(li,&entry)) listAddNodeTail(l,listTypeGet(&entry));
5171 listTypeReleaseIterator(li);
5172
5173 subject->encoding = REDIS_ENCODING_LIST;
5174 zfree(subject->ptr);
5175 subject->ptr = l;
5176 } else {
5177 redisPanic("Unsupported list conversion");
5178 }
5179 }
5180
5181 static void pushGenericCommand(redisClient *c, int where) {
5182 robj *lobj = lookupKeyWrite(c->db,c->argv[1]);
5183 if (lobj == NULL) {
5184 if (handleClientsWaitingListPush(c,c->argv[1],c->argv[2])) {
5185 addReply(c,shared.cone);
5186 return;
5187 }
5188 lobj = createZiplistObject();
5189 dbAdd(c->db,c->argv[1],lobj);
5190 } else {
5191 if (lobj->type != REDIS_LIST) {
5192 addReply(c,shared.wrongtypeerr);
5193 return;
5194 }
5195 if (handleClientsWaitingListPush(c,c->argv[1],c->argv[2])) {
5196 addReply(c,shared.cone);
5197 return;
5198 }
5199 }
5200 listTypePush(lobj,c->argv[2],where);
5201 addReplyLongLong(c,listTypeLength(lobj));
5202 server.dirty++;
5203 }
5204
5205 static void lpushCommand(redisClient *c) {
5206 pushGenericCommand(c,REDIS_HEAD);
5207 }
5208
5209 static void rpushCommand(redisClient *c) {
5210 pushGenericCommand(c,REDIS_TAIL);
5211 }
5212
5213 static void pushxGenericCommand(redisClient *c, robj *refval, robj *val, int where) {
5214 robj *subject;
5215 listTypeIterator *iter;
5216 listTypeEntry entry;
5217 int inserted = 0;
5218
5219 if ((subject = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
5220 checkType(c,subject,REDIS_LIST)) return;
5221 if (handleClientsWaitingListPush(c,c->argv[1],val)) {
5222 addReply(c,shared.cone);
5223 return;
5224 }
5225
5226 if (refval != NULL) {
5227 /* Note: we expect refval to be string-encoded because it is *not* the
5228 * last argument of the multi-bulk LINSERT. */
5229 redisAssert(refval->encoding == REDIS_ENCODING_RAW);
5230
5231 /* We're not sure if this value can be inserted yet, but we cannot
5232 * convert the list inside the iterator. We don't want to loop over
5233 * the list twice (once to see if the value can be inserted and once
5234 * to do the actual insert), so we assume this value can be inserted
5235 * and convert the ziplist to a regular list if necessary. */
5236 listTypeTryConversion(subject,val);
5237
5238 /* Seek refval from head to tail */
5239 iter = listTypeInitIterator(subject,0,REDIS_TAIL);
5240 while (listTypeNext(iter,&entry)) {
5241 if (listTypeEqual(&entry,refval)) {
5242 listTypeInsert(&entry,val,where);
5243 inserted = 1;
5244 break;
5245 }
5246 }
5247 listTypeReleaseIterator(iter);
5248
5249 if (inserted) {
5250 /* Check if the length exceeds the ziplist length threshold. */
5251 if (subject->encoding == REDIS_ENCODING_ZIPLIST &&
5252 ziplistLen(subject->ptr) > server.list_max_ziplist_entries)
5253 listTypeConvert(subject,REDIS_ENCODING_LIST);
5254 server.dirty++;
5255 }
5256 } else {
5257 listTypePush(subject,val,where);
5258 server.dirty++;
5259 }
5260
5261 addReplyUlong(c,listTypeLength(subject));
5262 }
5263
5264 static void lpushxCommand(redisClient *c) {
5265 pushxGenericCommand(c,NULL,c->argv[2],REDIS_HEAD);
5266 }
5267
5268 static void rpushxCommand(redisClient *c) {
5269 pushxGenericCommand(c,NULL,c->argv[2],REDIS_TAIL);
5270 }
5271
5272 static void linsertCommand(redisClient *c) {
5273 if (strcasecmp(c->argv[2]->ptr,"after") == 0) {
5274 pushxGenericCommand(c,c->argv[3],c->argv[4],REDIS_TAIL);
5275 } else if (strcasecmp(c->argv[2]->ptr,"before") == 0) {
5276 pushxGenericCommand(c,c->argv[3],c->argv[4],REDIS_HEAD);
5277 } else {
5278 addReply(c,shared.syntaxerr);
5279 }
5280 }
5281
5282 static void llenCommand(redisClient *c) {
5283 robj *o = lookupKeyReadOrReply(c,c->argv[1],shared.czero);
5284 if (o == NULL || checkType(c,o,REDIS_LIST)) return;
5285 addReplyUlong(c,listTypeLength(o));
5286 }
5287
5288 static void lindexCommand(redisClient *c) {
5289 robj *o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk);
5290 if (o == NULL || checkType(c,o,REDIS_LIST)) return;
5291 int index = atoi(c->argv[2]->ptr);
5292 robj *value = NULL;
5293
5294 if (o->encoding == REDIS_ENCODING_ZIPLIST) {
5295 unsigned char *p;
5296 unsigned char *vstr;
5297 unsigned int vlen;
5298 long long vlong;
5299 p = ziplistIndex(o->ptr,index);
5300 if (ziplistGet(p,&vstr,&vlen,&vlong)) {
5301 if (vstr) {
5302 value = createStringObject((char*)vstr,vlen);
5303 } else {
5304 value = createStringObjectFromLongLong(vlong);
5305 }
5306 addReplyBulk(c,value);
5307 decrRefCount(value);
5308 } else {
5309 addReply(c,shared.nullbulk);
5310 }
5311 } else if (o->encoding == REDIS_ENCODING_LIST) {
5312 listNode *ln = listIndex(o->ptr,index);
5313 if (ln != NULL) {
5314 value = listNodeValue(ln);
5315 addReplyBulk(c,value);
5316 } else {
5317 addReply(c,shared.nullbulk);
5318 }
5319 } else {
5320 redisPanic("Unknown list encoding");
5321 }
5322 }
5323
5324 static void lsetCommand(redisClient *c) {
5325 robj *o = lookupKeyWriteOrReply(c,c->argv[1],shared.nokeyerr);
5326 if (o == NULL || checkType(c,o,REDIS_LIST)) return;
5327 int index = atoi(c->argv[2]->ptr);
5328 robj *value = c->argv[3];
5329
5330 listTypeTryConversion(o,value);
5331 if (o->encoding == REDIS_ENCODING_ZIPLIST) {
5332 unsigned char *p, *zl = o->ptr;
5333 p = ziplistIndex(zl,index);
5334 if (p == NULL) {
5335 addReply(c,shared.outofrangeerr);
5336 } else {
5337 o->ptr = ziplistDelete(o->ptr,&p);
5338 value = getDecodedObject(value);
5339 o->ptr = ziplistInsert(o->ptr,p,value->ptr,sdslen(value->ptr));
5340 decrRefCount(value);
5341 addReply(c,shared.ok);
5342 server.dirty++;
5343 }
5344 } else if (o->encoding == REDIS_ENCODING_LIST) {
5345 listNode *ln = listIndex(o->ptr,index);
5346 if (ln == NULL) {
5347 addReply(c,shared.outofrangeerr);
5348 } else {
5349 decrRefCount((robj*)listNodeValue(ln));
5350 listNodeValue(ln) = value;
5351 incrRefCount(value);
5352 addReply(c,shared.ok);
5353 server.dirty++;
5354 }
5355 } else {
5356 redisPanic("Unknown list encoding");
5357 }
5358 }
5359
5360 static void popGenericCommand(redisClient *c, int where) {
5361 robj *o = lookupKeyWriteOrReply(c,c->argv[1],shared.nullbulk);
5362 if (o == NULL || checkType(c,o,REDIS_LIST)) return;
5363
5364 robj *value = listTypePop(o,where);
5365 if (value == NULL) {
5366 addReply(c,shared.nullbulk);
5367 } else {
5368 addReplyBulk(c,value);
5369 decrRefCount(value);
5370 if (listTypeLength(o) == 0) dbDelete(c->db,c->argv[1]);
5371 server.dirty++;
5372 }
5373 }
5374
5375 static void lpopCommand(redisClient *c) {
5376 popGenericCommand(c,REDIS_HEAD);
5377 }
5378
5379 static void rpopCommand(redisClient *c) {
5380 popGenericCommand(c,REDIS_TAIL);
5381 }
5382
5383 static void lrangeCommand(redisClient *c) {
5384 robj *o, *value;
5385 int start = atoi(c->argv[2]->ptr);
5386 int end = atoi(c->argv[3]->ptr);
5387 int llen;
5388 int rangelen, j;
5389 listTypeEntry entry;
5390
5391 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.emptymultibulk)) == NULL
5392 || checkType(c,o,REDIS_LIST)) return;
5393 llen = listTypeLength(o);
5394
5395 /* convert negative indexes */
5396 if (start < 0) start = llen+start;
5397 if (end < 0) end = llen+end;
5398 if (start < 0) start = 0;
5399 if (end < 0) end = 0;
5400
5401 /* indexes sanity checks */
5402 if (start > end || start >= llen) {
5403 /* Out of range start or start > end result in empty list */
5404 addReply(c,shared.emptymultibulk);
5405 return;
5406 }
5407 if (end >= llen) end = llen-1;
5408 rangelen = (end-start)+1;
5409
5410 /* Return the result in form of a multi-bulk reply */
5411 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",rangelen));
5412 listTypeIterator *li = listTypeInitIterator(o,start,REDIS_TAIL);
5413 for (j = 0; j < rangelen; j++) {
5414 redisAssert(listTypeNext(li,&entry));
5415 value = listTypeGet(&entry);
5416 addReplyBulk(c,value);
5417 decrRefCount(value);
5418 }
5419 listTypeReleaseIterator(li);
5420 }
5421
5422 static void ltrimCommand(redisClient *c) {
5423 robj *o;
5424 int start = atoi(c->argv[2]->ptr);
5425 int end = atoi(c->argv[3]->ptr);
5426 int llen;
5427 int j, ltrim, rtrim;
5428 list *list;
5429 listNode *ln;
5430
5431 if ((o = lookupKeyWriteOrReply(c,c->argv[1],shared.ok)) == NULL ||
5432 checkType(c,o,REDIS_LIST)) return;
5433 llen = listTypeLength(o);
5434
5435 /* convert negative indexes */
5436 if (start < 0) start = llen+start;
5437 if (end < 0) end = llen+end;
5438 if (start < 0) start = 0;
5439 if (end < 0) end = 0;
5440
5441 /* indexes sanity checks */
5442 if (start > end || start >= llen) {
5443 /* Out of range start or start > end result in empty list */
5444 ltrim = llen;
5445 rtrim = 0;
5446 } else {
5447 if (end >= llen) end = llen-1;
5448 ltrim = start;
5449 rtrim = llen-end-1;
5450 }
5451
5452 /* Remove list elements to perform the trim */
5453 if (o->encoding == REDIS_ENCODING_ZIPLIST) {
5454 o->ptr = ziplistDeleteRange(o->ptr,0,ltrim);
5455 o->ptr = ziplistDeleteRange(o->ptr,-rtrim,rtrim);
5456 } else if (o->encoding == REDIS_ENCODING_LIST) {
5457 list = o->ptr;
5458 for (j = 0; j < ltrim; j++) {
5459 ln = listFirst(list);
5460 listDelNode(list,ln);
5461 }
5462 for (j = 0; j < rtrim; j++) {
5463 ln = listLast(list);
5464 listDelNode(list,ln);
5465 }
5466 } else {
5467 redisPanic("Unknown list encoding");
5468 }
5469 if (listTypeLength(o) == 0) dbDelete(c->db,c->argv[1]);
5470 server.dirty++;
5471 addReply(c,shared.ok);
5472 }
5473
5474 static void lremCommand(redisClient *c) {
5475 robj *subject, *obj = c->argv[3];
5476 int toremove = atoi(c->argv[2]->ptr);
5477 int removed = 0;
5478 listTypeEntry entry;
5479
5480 subject = lookupKeyWriteOrReply(c,c->argv[1],shared.czero);
5481 if (subject == NULL || checkType(c,subject,REDIS_LIST)) return;
5482
5483 /* Make sure obj is raw when we're dealing with a ziplist */
5484 if (subject->encoding == REDIS_ENCODING_ZIPLIST)
5485 obj = getDecodedObject(obj);
5486
5487 listTypeIterator *li;
5488 if (toremove < 0) {
5489 toremove = -toremove;
5490 li = listTypeInitIterator(subject,-1,REDIS_HEAD);
5491 } else {
5492 li = listTypeInitIterator(subject,0,REDIS_TAIL);
5493 }
5494
5495 while (listTypeNext(li,&entry)) {
5496 if (listTypeEqual(&entry,obj)) {
5497 listTypeDelete(&entry);
5498 server.dirty++;
5499 removed++;
5500 if (toremove && removed == toremove) break;
5501 }
5502 }
5503 listTypeReleaseIterator(li);
5504
5505 /* Clean up raw encoded object */
5506 if (subject->encoding == REDIS_ENCODING_ZIPLIST)
5507 decrRefCount(obj);
5508
5509 if (listTypeLength(subject) == 0) dbDelete(c->db,c->argv[1]);
5510 addReplySds(c,sdscatprintf(sdsempty(),":%d\r\n",removed));
5511 }
5512
5513 /* This is the semantic of this command:
5514 * RPOPLPUSH srclist dstlist:
5515 * IF LLEN(srclist) > 0
5516 * element = RPOP srclist
5517 * LPUSH dstlist element
5518 * RETURN element
5519 * ELSE
5520 * RETURN nil
5521 * END
5522 * END
5523 *
5524 * The idea is to be able to get an element from a list in a reliable way
5525 * since the element is not just returned but pushed against another list
5526 * as well. This command was originally proposed by Ezra Zygmuntowicz.
5527 */
5528 static void rpoplpushcommand(redisClient *c) {
5529 robj *sobj, *value;
5530 if ((sobj = lookupKeyWriteOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
5531 checkType(c,sobj,REDIS_LIST)) return;
5532
5533 if (listTypeLength(sobj) == 0) {
5534 addReply(c,shared.nullbulk);
5535 } else {
5536 robj *dobj = lookupKeyWrite(c->db,c->argv[2]);
5537 if (dobj && checkType(c,dobj,REDIS_LIST)) return;
5538 value = listTypePop(sobj,REDIS_TAIL);
5539
5540 /* Add the element to the target list (unless it's directly
5541 * passed to some BLPOP-ing client */
5542 if (!handleClientsWaitingListPush(c,c->argv[2],value)) {
5543 /* Create the list if the key does not exist */
5544 if (!dobj) {
5545 dobj = createZiplistObject();
5546 dbAdd(c->db,c->argv[2],dobj);
5547 }
5548 listTypePush(dobj,value,REDIS_HEAD);
5549 }
5550
5551 /* Send the element to the client as reply as well */
5552 addReplyBulk(c,value);
5553
5554 /* listTypePop returns an object with its refcount incremented */
5555 decrRefCount(value);
5556
5557 /* Delete the source list when it is empty */
5558 if (listTypeLength(sobj) == 0) dbDelete(c->db,c->argv[1]);
5559 server.dirty++;
5560 }
5561 }
5562
5563 /* ==================================== Sets ================================ */
5564
5565 static void saddCommand(redisClient *c) {
5566 robj *set;
5567
5568 set = lookupKeyWrite(c->db,c->argv[1]);
5569 if (set == NULL) {
5570 set = createSetObject();
5571 dbAdd(c->db,c->argv[1],set);
5572 } else {
5573 if (set->type != REDIS_SET) {
5574 addReply(c,shared.wrongtypeerr);
5575 return;
5576 }
5577 }
5578 if (dictAdd(set->ptr,c->argv[2],NULL) == DICT_OK) {
5579 incrRefCount(c->argv[2]);
5580 server.dirty++;
5581 addReply(c,shared.cone);
5582 } else {
5583 addReply(c,shared.czero);
5584 }
5585 }
5586
5587 static void sremCommand(redisClient *c) {
5588 robj *set;
5589
5590 if ((set = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
5591 checkType(c,set,REDIS_SET)) return;
5592
5593 if (dictDelete(set->ptr,c->argv[2]) == DICT_OK) {
5594 server.dirty++;
5595 if (htNeedsResize(set->ptr)) dictResize(set->ptr);
5596 if (dictSize((dict*)set->ptr) == 0) dbDelete(c->db,c->argv[1]);
5597 addReply(c,shared.cone);
5598 } else {
5599 addReply(c,shared.czero);
5600 }
5601 }
5602
5603 static void smoveCommand(redisClient *c) {
5604 robj *srcset, *dstset;
5605
5606 srcset = lookupKeyWrite(c->db,c->argv[1]);
5607 dstset = lookupKeyWrite(c->db,c->argv[2]);
5608
5609 /* If the source key does not exist return 0, if it's of the wrong type
5610 * raise an error */
5611 if (srcset == NULL || srcset->type != REDIS_SET) {
5612 addReply(c, srcset ? shared.wrongtypeerr : shared.czero);
5613 return;
5614 }
5615 /* Error if the destination key is not a set as well */
5616 if (dstset && dstset->type != REDIS_SET) {
5617 addReply(c,shared.wrongtypeerr);
5618 return;
5619 }
5620 /* Remove the element from the source set */
5621 if (dictDelete(srcset->ptr,c->argv[3]) == DICT_ERR) {
5622 /* Key not found in the src set! return zero */
5623 addReply(c,shared.czero);
5624 return;
5625 }
5626 if (dictSize((dict*)srcset->ptr) == 0 && srcset != dstset)
5627 dbDelete(c->db,c->argv[1]);
5628 server.dirty++;
5629 /* Add the element to the destination set */
5630 if (!dstset) {
5631 dstset = createSetObject();
5632 dbAdd(c->db,c->argv[2],dstset);
5633 }
5634 if (dictAdd(dstset->ptr,c->argv[3],NULL) == DICT_OK)
5635 incrRefCount(c->argv[3]);
5636 addReply(c,shared.cone);
5637 }
5638
5639 static void sismemberCommand(redisClient *c) {
5640 robj *set;
5641
5642 if ((set = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
5643 checkType(c,set,REDIS_SET)) return;
5644
5645 if (dictFind(set->ptr,c->argv[2]))
5646 addReply(c,shared.cone);
5647 else
5648 addReply(c,shared.czero);
5649 }
5650
5651 static void scardCommand(redisClient *c) {
5652 robj *o;
5653 dict *s;
5654
5655 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
5656 checkType(c,o,REDIS_SET)) return;
5657
5658 s = o->ptr;
5659 addReplyUlong(c,dictSize(s));
5660 }
5661
5662 static void spopCommand(redisClient *c) {
5663 robj *set;
5664 dictEntry *de;
5665
5666 if ((set = lookupKeyWriteOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
5667 checkType(c,set,REDIS_SET)) return;
5668
5669 de = dictGetRandomKey(set->ptr);
5670 if (de == NULL) {
5671 addReply(c,shared.nullbulk);
5672 } else {
5673 robj *ele = dictGetEntryKey(de);
5674
5675 addReplyBulk(c,ele);
5676 dictDelete(set->ptr,ele);
5677 if (htNeedsResize(set->ptr)) dictResize(set->ptr);
5678 if (dictSize((dict*)set->ptr) == 0) dbDelete(c->db,c->argv[1]);
5679 server.dirty++;
5680 }
5681 }
5682
5683 static void srandmemberCommand(redisClient *c) {
5684 robj *set;
5685 dictEntry *de;
5686
5687 if ((set = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
5688 checkType(c,set,REDIS_SET)) return;
5689
5690 de = dictGetRandomKey(set->ptr);
5691 if (de == NULL) {
5692 addReply(c,shared.nullbulk);
5693 } else {
5694 robj *ele = dictGetEntryKey(de);
5695
5696 addReplyBulk(c,ele);
5697 }
5698 }
5699
5700 static int qsortCompareSetsByCardinality(const void *s1, const void *s2) {
5701 dict **d1 = (void*) s1, **d2 = (void*) s2;
5702
5703 return dictSize(*d1)-dictSize(*d2);
5704 }
5705
5706 static void sinterGenericCommand(redisClient *c, robj **setskeys, unsigned long setsnum, robj *dstkey) {
5707 dict **dv = zmalloc(sizeof(dict*)*setsnum);
5708 dictIterator *di;
5709 dictEntry *de;
5710 robj *lenobj = NULL, *dstset = NULL;
5711 unsigned long j, cardinality = 0;
5712
5713 for (j = 0; j < setsnum; j++) {
5714 robj *setobj;
5715
5716 setobj = dstkey ?
5717 lookupKeyWrite(c->db,setskeys[j]) :
5718 lookupKeyRead(c->db,setskeys[j]);
5719 if (!setobj) {
5720 zfree(dv);
5721 if (dstkey) {
5722 if (dbDelete(c->db,dstkey))
5723 server.dirty++;
5724 addReply(c,shared.czero);
5725 } else {
5726 addReply(c,shared.emptymultibulk);
5727 }
5728 return;
5729 }
5730 if (setobj->type != REDIS_SET) {
5731 zfree(dv);
5732 addReply(c,shared.wrongtypeerr);
5733 return;
5734 }
5735 dv[j] = setobj->ptr;
5736 }
5737 /* Sort sets from the smallest to largest, this will improve our
5738 * algorithm's performace */
5739 qsort(dv,setsnum,sizeof(dict*),qsortCompareSetsByCardinality);
5740
5741 /* The first thing we should output is the total number of elements...
5742 * since this is a multi-bulk write, but at this stage we don't know
5743 * the intersection set size, so we use a trick, append an empty object
5744 * to the output list and save the pointer to later modify it with the
5745 * right length */
5746 if (!dstkey) {
5747 lenobj = createObject(REDIS_STRING,NULL);
5748 addReply(c,lenobj);
5749 decrRefCount(lenobj);
5750 } else {
5751 /* If we have a target key where to store the resulting set
5752 * create this key with an empty set inside */
5753 dstset = createSetObject();
5754 }
5755
5756 /* Iterate all the elements of the first (smallest) set, and test
5757 * the element against all the other sets, if at least one set does
5758 * not include the element it is discarded */
5759 di = dictGetIterator(dv[0]);
5760
5761 while((de = dictNext(di)) != NULL) {
5762 robj *ele;
5763
5764 for (j = 1; j < setsnum; j++)
5765 if (dictFind(dv[j],dictGetEntryKey(de)) == NULL) break;
5766 if (j != setsnum)
5767 continue; /* at least one set does not contain the member */
5768 ele = dictGetEntryKey(de);
5769 if (!dstkey) {
5770 addReplyBulk(c,ele);
5771 cardinality++;
5772 } else {
5773 dictAdd(dstset->ptr,ele,NULL);
5774 incrRefCount(ele);
5775 }
5776 }
5777 dictReleaseIterator(di);
5778
5779 if (dstkey) {
5780 /* Store the resulting set into the target, if the intersection
5781 * is not an empty set. */
5782 dbDelete(c->db,dstkey);
5783 if (dictSize((dict*)dstset->ptr) > 0) {
5784 dbAdd(c->db,dstkey,dstset);
5785 addReplyLongLong(c,dictSize((dict*)dstset->ptr));
5786 } else {
5787 decrRefCount(dstset);
5788 addReply(c,shared.czero);
5789 }
5790 server.dirty++;
5791 } else {
5792 lenobj->ptr = sdscatprintf(sdsempty(),"*%lu\r\n",cardinality);
5793 }
5794 zfree(dv);
5795 }
5796
5797 static void sinterCommand(redisClient *c) {
5798 sinterGenericCommand(c,c->argv+1,c->argc-1,NULL);
5799 }
5800
5801 static void sinterstoreCommand(redisClient *c) {
5802 sinterGenericCommand(c,c->argv+2,c->argc-2,c->argv[1]);
5803 }
5804
5805 #define REDIS_OP_UNION 0
5806 #define REDIS_OP_DIFF 1
5807 #define REDIS_OP_INTER 2
5808
5809 static void sunionDiffGenericCommand(redisClient *c, robj **setskeys, int setsnum, robj *dstkey, int op) {
5810 dict **dv = zmalloc(sizeof(dict*)*setsnum);
5811 dictIterator *di;
5812 dictEntry *de;
5813 robj *dstset = NULL;
5814 int j, cardinality = 0;
5815
5816 for (j = 0; j < setsnum; j++) {
5817 robj *setobj;
5818
5819 setobj = dstkey ?
5820 lookupKeyWrite(c->db,setskeys[j]) :
5821 lookupKeyRead(c->db,setskeys[j]);
5822 if (!setobj) {
5823 dv[j] = NULL;
5824 continue;
5825 }
5826 if (setobj->type != REDIS_SET) {
5827 zfree(dv);
5828 addReply(c,shared.wrongtypeerr);
5829 return;
5830 }
5831 dv[j] = setobj->ptr;
5832 }
5833
5834 /* We need a temp set object to store our union. If the dstkey
5835 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
5836 * this set object will be the resulting object to set into the target key*/
5837 dstset = createSetObject();
5838
5839 /* Iterate all the elements of all the sets, add every element a single
5840 * time to the result set */
5841 for (j = 0; j < setsnum; j++) {
5842 if (op == REDIS_OP_DIFF && j == 0 && !dv[j]) break; /* result set is empty */
5843 if (!dv[j]) continue; /* non existing keys are like empty sets */
5844
5845 di = dictGetIterator(dv[j]);
5846
5847 while((de = dictNext(di)) != NULL) {
5848 robj *ele;
5849
5850 /* dictAdd will not add the same element multiple times */
5851 ele = dictGetEntryKey(de);
5852 if (op == REDIS_OP_UNION || j == 0) {
5853 if (dictAdd(dstset->ptr,ele,NULL) == DICT_OK) {
5854 incrRefCount(ele);
5855 cardinality++;
5856 }
5857 } else if (op == REDIS_OP_DIFF) {
5858 if (dictDelete(dstset->ptr,ele) == DICT_OK) {
5859 cardinality--;
5860 }
5861 }
5862 }
5863 dictReleaseIterator(di);
5864
5865 /* result set is empty? Exit asap. */
5866 if (op == REDIS_OP_DIFF && cardinality == 0) break;
5867 }
5868
5869 /* Output the content of the resulting set, if not in STORE mode */
5870 if (!dstkey) {
5871 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",cardinality));
5872 di = dictGetIterator(dstset->ptr);
5873 while((de = dictNext(di)) != NULL) {
5874 robj *ele;
5875
5876 ele = dictGetEntryKey(de);
5877 addReplyBulk(c,ele);
5878 }
5879 dictReleaseIterator(di);
5880 decrRefCount(dstset);
5881 } else {
5882 /* If we have a target key where to store the resulting set
5883 * create this key with the result set inside */
5884 dbDelete(c->db,dstkey);
5885 if (dictSize((dict*)dstset->ptr) > 0) {
5886 dbAdd(c->db,dstkey,dstset);
5887 addReplyLongLong(c,dictSize((dict*)dstset->ptr));
5888 } else {
5889 decrRefCount(dstset);
5890 addReply(c,shared.czero);
5891 }
5892 server.dirty++;
5893 }
5894 zfree(dv);
5895 }
5896
5897 static void sunionCommand(redisClient *c) {
5898 sunionDiffGenericCommand(c,c->argv+1,c->argc-1,NULL,REDIS_OP_UNION);
5899 }
5900
5901 static void sunionstoreCommand(redisClient *c) {
5902 sunionDiffGenericCommand(c,c->argv+2,c->argc-2,c->argv[1],REDIS_OP_UNION);
5903 }
5904
5905 static void sdiffCommand(redisClient *c) {
5906 sunionDiffGenericCommand(c,c->argv+1,c->argc-1,NULL,REDIS_OP_DIFF);
5907 }
5908
5909 static void sdiffstoreCommand(redisClient *c) {
5910 sunionDiffGenericCommand(c,c->argv+2,c->argc-2,c->argv[1],REDIS_OP_DIFF);
5911 }
5912
5913 /* ==================================== ZSets =============================== */
5914
5915 /* ZSETs are ordered sets using two data structures to hold the same elements
5916 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
5917 * data structure.
5918 *
5919 * The elements are added to an hash table mapping Redis objects to scores.
5920 * At the same time the elements are added to a skip list mapping scores
5921 * to Redis objects (so objects are sorted by scores in this "view"). */
5922
5923 /* This skiplist implementation is almost a C translation of the original
5924 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
5925 * Alternative to Balanced Trees", modified in three ways:
5926 * a) this implementation allows for repeated values.
5927 * b) the comparison is not just by key (our 'score') but by satellite data.
5928 * c) there is a back pointer, so it's a doubly linked list with the back
5929 * pointers being only at "level 1". This allows to traverse the list
5930 * from tail to head, useful for ZREVRANGE. */
5931
5932 static zskiplistNode *zslCreateNode(int level, double score, robj *obj) {
5933 zskiplistNode *zn = zmalloc(sizeof(*zn));
5934
5935 zn->forward = zmalloc(sizeof(zskiplistNode*) * level);
5936 if (level > 1)
5937 zn->span = zmalloc(sizeof(unsigned int) * (level - 1));
5938 else
5939 zn->span = NULL;
5940 zn->score = score;
5941 zn->obj = obj;
5942 return zn;
5943 }
5944
5945 static zskiplist *zslCreate(void) {
5946 int j;
5947 zskiplist *zsl;
5948
5949 zsl = zmalloc(sizeof(*zsl));
5950 zsl->level = 1;
5951 zsl->length = 0;
5952 zsl->header = zslCreateNode(ZSKIPLIST_MAXLEVEL,0,NULL);
5953 for (j = 0; j < ZSKIPLIST_MAXLEVEL; j++) {
5954 zsl->header->forward[j] = NULL;
5955
5956 /* span has space for ZSKIPLIST_MAXLEVEL-1 elements */
5957 if (j < ZSKIPLIST_MAXLEVEL-1)
5958 zsl->header->span[j] = 0;
5959 }
5960 zsl->header->backward = NULL;
5961 zsl->tail = NULL;
5962 return zsl;
5963 }
5964
5965 static void zslFreeNode(zskiplistNode *node) {
5966 decrRefCount(node->obj);
5967 zfree(node->forward);
5968 zfree(node->span);
5969 zfree(node);
5970 }
5971
5972 static void zslFree(zskiplist *zsl) {
5973 zskiplistNode *node = zsl->header->forward[0], *next;
5974
5975 zfree(zsl->header->forward);
5976 zfree(zsl->header->span);
5977 zfree(zsl->header);
5978 while(node) {
5979 next = node->forward[0];
5980 zslFreeNode(node);
5981 node = next;
5982 }
5983 zfree(zsl);
5984 }
5985
5986 static int zslRandomLevel(void) {
5987 int level = 1;
5988 while ((random()&0xFFFF) < (ZSKIPLIST_P * 0xFFFF))
5989 level += 1;
5990 return (level<ZSKIPLIST_MAXLEVEL) ? level : ZSKIPLIST_MAXLEVEL;
5991 }
5992
5993 static void zslInsert(zskiplist *zsl, double score, robj *obj) {
5994 zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;
5995 unsigned int rank[ZSKIPLIST_MAXLEVEL];
5996 int i, level;
5997
5998 x = zsl->header;
5999 for (i = zsl->level-1; i >= 0; i--) {
6000 /* store rank that is crossed to reach the insert position */
6001 rank[i] = i == (zsl->level-1) ? 0 : rank[i+1];
6002
6003 while (x->forward[i] &&
6004 (x->forward[i]->score < score ||
6005 (x->forward[i]->score == score &&
6006 compareStringObjects(x->forward[i]->obj,obj) < 0))) {
6007 rank[i] += i > 0 ? x->span[i-1] : 1;
6008 x = x->forward[i];
6009 }
6010 update[i] = x;
6011 }
6012 /* we assume the key is not already inside, since we allow duplicated
6013 * scores, and the re-insertion of score and redis object should never
6014 * happpen since the caller of zslInsert() should test in the hash table
6015 * if the element is already inside or not. */
6016 level = zslRandomLevel();
6017 if (level > zsl->level) {
6018 for (i = zsl->level; i < level; i++) {
6019 rank[i] = 0;
6020 update[i] = zsl->header;
6021 update[i]->span[i-1] = zsl->length;
6022 }
6023 zsl->level = level;
6024 }
6025 x = zslCreateNode(level,score,obj);
6026 for (i = 0; i < level; i++) {
6027 x->forward[i] = update[i]->forward[i];
6028 update[i]->forward[i] = x;
6029
6030 /* update span covered by update[i] as x is inserted here */
6031 if (i > 0) {
6032 x->span[i-1] = update[i]->span[i-1] - (rank[0] - rank[i]);
6033 update[i]->span[i-1] = (rank[0] - rank[i]) + 1;
6034 }
6035 }
6036
6037 /* increment span for untouched levels */
6038 for (i = level; i < zsl->level; i++) {
6039 update[i]->span[i-1]++;
6040 }
6041
6042 x->backward = (update[0] == zsl->header) ? NULL : update[0];
6043 if (x->forward[0])
6044 x->forward[0]->backward = x;
6045 else
6046 zsl->tail = x;
6047 zsl->length++;
6048 }
6049
6050 /* Internal function used by zslDelete, zslDeleteByScore and zslDeleteByRank */
6051 void zslDeleteNode(zskiplist *zsl, zskiplistNode *x, zskiplistNode **update) {
6052 int i;
6053 for (i = 0; i < zsl->level; i++) {
6054 if (update[i]->forward[i] == x) {
6055 if (i > 0) {
6056 update[i]->span[i-1] += x->span[i-1] - 1;
6057 }
6058 update[i]->forward[i] = x->forward[i];
6059 } else {
6060 /* invariant: i > 0, because update[0]->forward[0]
6061 * is always equal to x */
6062 update[i]->span[i-1] -= 1;
6063 }
6064 }
6065 if (x->forward[0]) {
6066 x->forward[0]->backward = x->backward;
6067 } else {
6068 zsl->tail = x->backward;
6069 }
6070 while(zsl->level > 1 && zsl->header->forward[zsl->level-1] == NULL)
6071 zsl->level--;
6072 zsl->length--;
6073 }
6074
6075 /* Delete an element with matching score/object from the skiplist. */
6076 static int zslDelete(zskiplist *zsl, double score, robj *obj) {
6077 zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;
6078 int i;
6079
6080 x = zsl->header;
6081 for (i = zsl->level-1; i >= 0; i--) {
6082 while (x->forward[i] &&
6083 (x->forward[i]->score < score ||
6084 (x->forward[i]->score == score &&
6085 compareStringObjects(x->forward[i]->obj,obj) < 0)))
6086 x = x->forward[i];
6087 update[i] = x;
6088 }
6089 /* We may have multiple elements with the same score, what we need
6090 * is to find the element with both the right score and object. */
6091 x = x->forward[0];
6092 if (x && score == x->score && equalStringObjects(x->obj,obj)) {
6093 zslDeleteNode(zsl, x, update);
6094 zslFreeNode(x);
6095 return 1;
6096 } else {
6097 return 0; /* not found */
6098 }
6099 return 0; /* not found */
6100 }
6101
6102 /* Delete all the elements with score between min and max from the skiplist.
6103 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
6104 * Note that this function takes the reference to the hash table view of the
6105 * sorted set, in order to remove the elements from the hash table too. */
6106 static unsigned long zslDeleteRangeByScore(zskiplist *zsl, double min, double max, dict *dict) {
6107 zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;
6108 unsigned long removed = 0;
6109 int i;
6110
6111 x = zsl->header;
6112 for (i = zsl->level-1; i >= 0; i--) {
6113 while (x->forward[i] && x->forward[i]->score < min)
6114 x = x->forward[i];
6115 update[i] = x;
6116 }
6117 /* We may have multiple elements with the same score, what we need
6118 * is to find the element with both the right score and object. */
6119 x = x->forward[0];
6120 while (x && x->score <= max) {
6121 zskiplistNode *next = x->forward[0];
6122 zslDeleteNode(zsl, x, update);
6123 dictDelete(dict,x->obj);
6124 zslFreeNode(x);
6125 removed++;
6126 x = next;
6127 }
6128 return removed; /* not found */
6129 }
6130
6131 /* Delete all the elements with rank between start and end from the skiplist.
6132 * Start and end are inclusive. Note that start and end need to be 1-based */
6133 static unsigned long zslDeleteRangeByRank(zskiplist *zsl, unsigned int start, unsigned int end, dict *dict) {
6134 zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;
6135 unsigned long traversed = 0, removed = 0;
6136 int i;
6137
6138 x = zsl->header;
6139 for (i = zsl->level-1; i >= 0; i--) {
6140 while (x->forward[i] && (traversed + (i > 0 ? x->span[i-1] : 1)) < start) {
6141 traversed += i > 0 ? x->span[i-1] : 1;
6142 x = x->forward[i];
6143 }
6144 update[i] = x;
6145 }
6146
6147 traversed++;
6148 x = x->forward[0];
6149 while (x && traversed <= end) {
6150 zskiplistNode *next = x->forward[0];
6151 zslDeleteNode(zsl, x, update);
6152 dictDelete(dict,x->obj);
6153 zslFreeNode(x);
6154 removed++;
6155 traversed++;
6156 x = next;
6157 }
6158 return removed;
6159 }
6160
6161 /* Find the first node having a score equal or greater than the specified one.
6162 * Returns NULL if there is no match. */
6163 static zskiplistNode *zslFirstWithScore(zskiplist *zsl, double score) {
6164 zskiplistNode *x;
6165 int i;
6166
6167 x = zsl->header;
6168 for (i = zsl->level-1; i >= 0; i--) {
6169 while (x->forward[i] && x->forward[i]->score < score)
6170 x = x->forward[i];
6171 }
6172 /* We may have multiple elements with the same score, what we need
6173 * is to find the element with both the right score and object. */
6174 return x->forward[0];
6175 }
6176
6177 /* Find the rank for an element by both score and key.
6178 * Returns 0 when the element cannot be found, rank otherwise.
6179 * Note that the rank is 1-based due to the span of zsl->header to the
6180 * first element. */
6181 static unsigned long zslistTypeGetRank(zskiplist *zsl, double score, robj *o) {
6182 zskiplistNode *x;
6183 unsigned long rank = 0;
6184 int i;
6185
6186 x = zsl->header;
6187 for (i = zsl->level-1; i >= 0; i--) {
6188 while (x->forward[i] &&
6189 (x->forward[i]->score < score ||
6190 (x->forward[i]->score == score &&
6191 compareStringObjects(x->forward[i]->obj,o) <= 0))) {
6192 rank += i > 0 ? x->span[i-1] : 1;
6193 x = x->forward[i];
6194 }
6195
6196 /* x might be equal to zsl->header, so test if obj is non-NULL */
6197 if (x->obj && equalStringObjects(x->obj,o)) {
6198 return rank;
6199 }
6200 }
6201 return 0;
6202 }
6203
6204 /* Finds an element by its rank. The rank argument needs to be 1-based. */
6205 zskiplistNode* zslistTypeGetElementByRank(zskiplist *zsl, unsigned long rank) {
6206 zskiplistNode *x;
6207 unsigned long traversed = 0;
6208 int i;
6209
6210 x = zsl->header;
6211 for (i = zsl->level-1; i >= 0; i--) {
6212 while (x->forward[i] && (traversed + (i>0 ? x->span[i-1] : 1)) <= rank)
6213 {
6214 traversed += i > 0 ? x->span[i-1] : 1;
6215 x = x->forward[i];
6216 }
6217 if (traversed == rank) {
6218 return x;
6219 }
6220 }
6221 return NULL;
6222 }
6223
6224 /* The actual Z-commands implementations */
6225
6226 /* This generic command implements both ZADD and ZINCRBY.
6227 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
6228 * the increment if the operation is a ZINCRBY (doincrement == 1). */
6229 static void zaddGenericCommand(redisClient *c, robj *key, robj *ele, double scoreval, int doincrement) {
6230 robj *zsetobj;
6231 zset *zs;
6232 double *score;
6233
6234 if (isnan(scoreval)) {
6235 addReplySds(c,sdsnew("-ERR provide score is Not A Number (nan)\r\n"));
6236 return;
6237 }
6238
6239 zsetobj = lookupKeyWrite(c->db,key);
6240 if (zsetobj == NULL) {
6241 zsetobj = createZsetObject();
6242 dbAdd(c->db,key,zsetobj);
6243 } else {
6244 if (zsetobj->type != REDIS_ZSET) {
6245 addReply(c,shared.wrongtypeerr);
6246 return;
6247 }
6248 }
6249 zs = zsetobj->ptr;
6250
6251 /* Ok now since we implement both ZADD and ZINCRBY here the code
6252 * needs to handle the two different conditions. It's all about setting
6253 * '*score', that is, the new score to set, to the right value. */
6254 score = zmalloc(sizeof(double));
6255 if (doincrement) {
6256 dictEntry *de;
6257
6258 /* Read the old score. If the element was not present starts from 0 */
6259 de = dictFind(zs->dict,ele);
6260 if (de) {
6261 double *oldscore = dictGetEntryVal(de);
6262 *score = *oldscore + scoreval;
6263 } else {
6264 *score = scoreval;
6265 }
6266 if (isnan(*score)) {
6267 addReplySds(c,
6268 sdsnew("-ERR resulting score is Not A Number (nan)\r\n"));
6269 zfree(score);
6270 /* Note that we don't need to check if the zset may be empty and
6271 * should be removed here, as we can only obtain Nan as score if
6272 * there was already an element in the sorted set. */
6273 return;
6274 }
6275 } else {
6276 *score = scoreval;
6277 }
6278
6279 /* What follows is a simple remove and re-insert operation that is common
6280 * to both ZADD and ZINCRBY... */
6281 if (dictAdd(zs->dict,ele,score) == DICT_OK) {
6282 /* case 1: New element */
6283 incrRefCount(ele); /* added to hash */
6284 zslInsert(zs->zsl,*score,ele);
6285 incrRefCount(ele); /* added to skiplist */
6286 server.dirty++;
6287 if (doincrement)
6288 addReplyDouble(c,*score);
6289 else
6290 addReply(c,shared.cone);
6291 } else {
6292 dictEntry *de;
6293 double *oldscore;
6294
6295 /* case 2: Score update operation */
6296 de = dictFind(zs->dict,ele);
6297 redisAssert(de != NULL);
6298 oldscore = dictGetEntryVal(de);
6299 if (*score != *oldscore) {
6300 int deleted;
6301
6302 /* Remove and insert the element in the skip list with new score */
6303 deleted = zslDelete(zs->zsl,*oldscore,ele);
6304 redisAssert(deleted != 0);
6305 zslInsert(zs->zsl,*score,ele);
6306 incrRefCount(ele);
6307 /* Update the score in the hash table */
6308 dictReplace(zs->dict,ele,score);
6309 server.dirty++;
6310 } else {
6311 zfree(score);
6312 }
6313 if (doincrement)
6314 addReplyDouble(c,*score);
6315 else
6316 addReply(c,shared.czero);
6317 }
6318 }
6319
6320 static void zaddCommand(redisClient *c) {
6321 double scoreval;
6322
6323 if (getDoubleFromObjectOrReply(c, c->argv[2], &scoreval, NULL) != REDIS_OK) return;
6324 zaddGenericCommand(c,c->argv[1],c->argv[3],scoreval,0);
6325 }
6326
6327 static void zincrbyCommand(redisClient *c) {
6328 double scoreval;
6329
6330 if (getDoubleFromObjectOrReply(c, c->argv[2], &scoreval, NULL) != REDIS_OK) return;
6331 zaddGenericCommand(c,c->argv[1],c->argv[3],scoreval,1);
6332 }
6333
6334 static void zremCommand(redisClient *c) {
6335 robj *zsetobj;
6336 zset *zs;
6337 dictEntry *de;
6338 double *oldscore;
6339 int deleted;
6340
6341 if ((zsetobj = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
6342 checkType(c,zsetobj,REDIS_ZSET)) return;
6343
6344 zs = zsetobj->ptr;
6345 de = dictFind(zs->dict,c->argv[2]);
6346 if (de == NULL) {
6347 addReply(c,shared.czero);
6348 return;
6349 }
6350 /* Delete from the skiplist */
6351 oldscore = dictGetEntryVal(de);
6352 deleted = zslDelete(zs->zsl,*oldscore,c->argv[2]);
6353 redisAssert(deleted != 0);
6354
6355 /* Delete from the hash table */
6356 dictDelete(zs->dict,c->argv[2]);
6357 if (htNeedsResize(zs->dict)) dictResize(zs->dict);
6358 if (dictSize(zs->dict) == 0) dbDelete(c->db,c->argv[1]);
6359 server.dirty++;
6360 addReply(c,shared.cone);
6361 }
6362
6363 static void zremrangebyscoreCommand(redisClient *c) {
6364 double min;
6365 double max;
6366 long deleted;
6367 robj *zsetobj;
6368 zset *zs;
6369
6370 if ((getDoubleFromObjectOrReply(c, c->argv[2], &min, NULL) != REDIS_OK) ||
6371 (getDoubleFromObjectOrReply(c, c->argv[3], &max, NULL) != REDIS_OK)) return;
6372
6373 if ((zsetobj = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
6374 checkType(c,zsetobj,REDIS_ZSET)) return;
6375
6376 zs = zsetobj->ptr;
6377 deleted = zslDeleteRangeByScore(zs->zsl,min,max,zs->dict);
6378 if (htNeedsResize(zs->dict)) dictResize(zs->dict);
6379 if (dictSize(zs->dict) == 0) dbDelete(c->db,c->argv[1]);
6380 server.dirty += deleted;
6381 addReplyLongLong(c,deleted);
6382 }
6383
6384 static void zremrangebyrankCommand(redisClient *c) {
6385 long start;
6386 long end;
6387 int llen;
6388 long deleted;
6389 robj *zsetobj;
6390 zset *zs;
6391
6392 if ((getLongFromObjectOrReply(c, c->argv[2], &start, NULL) != REDIS_OK) ||
6393 (getLongFromObjectOrReply(c, c->argv[3], &end, NULL) != REDIS_OK)) return;
6394
6395 if ((zsetobj = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
6396 checkType(c,zsetobj,REDIS_ZSET)) return;
6397 zs = zsetobj->ptr;
6398 llen = zs->zsl->length;
6399
6400 /* convert negative indexes */
6401 if (start < 0) start = llen+start;
6402 if (end < 0) end = llen+end;
6403 if (start < 0) start = 0;
6404 if (end < 0) end = 0;
6405
6406 /* indexes sanity checks */
6407 if (start > end || start >= llen) {
6408 addReply(c,shared.czero);
6409 return;
6410 }
6411 if (end >= llen) end = llen-1;
6412
6413 /* increment start and end because zsl*Rank functions
6414 * use 1-based rank */
6415 deleted = zslDeleteRangeByRank(zs->zsl,start+1,end+1,zs->dict);
6416 if (htNeedsResize(zs->dict)) dictResize(zs->dict);
6417 if (dictSize(zs->dict) == 0) dbDelete(c->db,c->argv[1]);
6418 server.dirty += deleted;
6419 addReplyLongLong(c, deleted);
6420 }
6421
6422 typedef struct {
6423 dict *dict;
6424 double weight;
6425 } zsetopsrc;
6426
6427 static int qsortCompareZsetopsrcByCardinality(const void *s1, const void *s2) {
6428 zsetopsrc *d1 = (void*) s1, *d2 = (void*) s2;
6429 unsigned long size1, size2;
6430 size1 = d1->dict ? dictSize(d1->dict) : 0;
6431 size2 = d2->dict ? dictSize(d2->dict) : 0;
6432 return size1 - size2;
6433 }
6434
6435 #define REDIS_AGGR_SUM 1
6436 #define REDIS_AGGR_MIN 2
6437 #define REDIS_AGGR_MAX 3
6438 #define zunionInterDictValue(_e) (dictGetEntryVal(_e) == NULL ? 1.0 : *(double*)dictGetEntryVal(_e))
6439
6440 inline static void zunionInterAggregate(double *target, double val, int aggregate) {
6441 if (aggregate == REDIS_AGGR_SUM) {
6442 *target = *target + val;
6443 } else if (aggregate == REDIS_AGGR_MIN) {
6444 *target = val < *target ? val : *target;
6445 } else if (aggregate == REDIS_AGGR_MAX) {
6446 *target = val > *target ? val : *target;
6447 } else {
6448 /* safety net */
6449 redisPanic("Unknown ZUNION/INTER aggregate type");
6450 }
6451 }
6452
6453 static void zunionInterGenericCommand(redisClient *c, robj *dstkey, int op) {
6454 int i, j, setnum;
6455 int aggregate = REDIS_AGGR_SUM;
6456 zsetopsrc *src;
6457 robj *dstobj;
6458 zset *dstzset;
6459 dictIterator *di;
6460 dictEntry *de;
6461
6462 /* expect setnum input keys to be given */
6463 setnum = atoi(c->argv[2]->ptr);
6464 if (setnum < 1) {
6465 addReplySds(c,sdsnew("-ERR at least 1 input key is needed for ZUNIONSTORE/ZINTERSTORE\r\n"));
6466 return;
6467 }
6468
6469 /* test if the expected number of keys would overflow */
6470 if (3+setnum > c->argc) {
6471 addReply(c,shared.syntaxerr);
6472 return;
6473 }
6474
6475 /* read keys to be used for input */
6476 src = zmalloc(sizeof(zsetopsrc) * setnum);
6477 for (i = 0, j = 3; i < setnum; i++, j++) {
6478 robj *obj = lookupKeyWrite(c->db,c->argv[j]);
6479 if (!obj) {
6480 src[i].dict = NULL;
6481 } else {
6482 if (obj->type == REDIS_ZSET) {
6483 src[i].dict = ((zset*)obj->ptr)->dict;
6484 } else if (obj->type == REDIS_SET) {
6485 src[i].dict = (obj->ptr);
6486 } else {
6487 zfree(src);
6488 addReply(c,shared.wrongtypeerr);
6489 return;
6490 }
6491 }
6492
6493 /* default all weights to 1 */
6494 src[i].weight = 1.0;
6495 }
6496
6497 /* parse optional extra arguments */
6498 if (j < c->argc) {
6499 int remaining = c->argc - j;
6500
6501 while (remaining) {
6502 if (remaining >= (setnum + 1) && !strcasecmp(c->argv[j]->ptr,"weights")) {
6503 j++; remaining--;
6504 for (i = 0; i < setnum; i++, j++, remaining--) {
6505 if (getDoubleFromObjectOrReply(c, c->argv[j], &src[i].weight, NULL) != REDIS_OK)
6506 return;
6507 }
6508 } else if (remaining >= 2 && !strcasecmp(c->argv[j]->ptr,"aggregate")) {
6509 j++; remaining--;
6510 if (!strcasecmp(c->argv[j]->ptr,"sum")) {
6511 aggregate = REDIS_AGGR_SUM;
6512 } else if (!strcasecmp(c->argv[j]->ptr,"min")) {
6513 aggregate = REDIS_AGGR_MIN;
6514 } else if (!strcasecmp(c->argv[j]->ptr,"max")) {
6515 aggregate = REDIS_AGGR_MAX;
6516 } else {
6517 zfree(src);
6518 addReply(c,shared.syntaxerr);
6519 return;
6520 }
6521 j++; remaining--;
6522 } else {
6523 zfree(src);
6524 addReply(c,shared.syntaxerr);
6525 return;
6526 }
6527 }
6528 }
6529
6530 /* sort sets from the smallest to largest, this will improve our
6531 * algorithm's performance */
6532 qsort(src,setnum,sizeof(zsetopsrc),qsortCompareZsetopsrcByCardinality);
6533
6534 dstobj = createZsetObject();
6535 dstzset = dstobj->ptr;
6536
6537 if (op == REDIS_OP_INTER) {
6538 /* skip going over all entries if the smallest zset is NULL or empty */
6539 if (src[0].dict && dictSize(src[0].dict) > 0) {
6540 /* precondition: as src[0].dict is non-empty and the zsets are ordered
6541 * from small to large, all src[i > 0].dict are non-empty too */
6542 di = dictGetIterator(src[0].dict);
6543 while((de = dictNext(di)) != NULL) {
6544 double *score = zmalloc(sizeof(double)), value;
6545 *score = src[0].weight * zunionInterDictValue(de);
6546
6547 for (j = 1; j < setnum; j++) {
6548 dictEntry *other = dictFind(src[j].dict,dictGetEntryKey(de));
6549 if (other) {
6550 value = src[j].weight * zunionInterDictValue(other);
6551 zunionInterAggregate(score, value, aggregate);
6552 } else {
6553 break;
6554 }
6555 }
6556
6557 /* skip entry when not present in every source dict */
6558 if (j != setnum) {
6559 zfree(score);
6560 } else {
6561 robj *o = dictGetEntryKey(de);
6562 dictAdd(dstzset->dict,o,score);
6563 incrRefCount(o); /* added to dictionary */
6564 zslInsert(dstzset->zsl,*score,o);
6565 incrRefCount(o); /* added to skiplist */
6566 }
6567 }
6568 dictReleaseIterator(di);
6569 }
6570 } else if (op == REDIS_OP_UNION) {
6571 for (i = 0; i < setnum; i++) {
6572 if (!src[i].dict) continue;
6573
6574 di = dictGetIterator(src[i].dict);
6575 while((de = dictNext(di)) != NULL) {
6576 /* skip key when already processed */
6577 if (dictFind(dstzset->dict,dictGetEntryKey(de)) != NULL) continue;
6578
6579 double *score = zmalloc(sizeof(double)), value;
6580 *score = src[i].weight * zunionInterDictValue(de);
6581
6582 /* because the zsets are sorted by size, its only possible
6583 * for sets at larger indices to hold this entry */
6584 for (j = (i+1); j < setnum; j++) {
6585 dictEntry *other = dictFind(src[j].dict,dictGetEntryKey(de));
6586 if (other) {
6587 value = src[j].weight * zunionInterDictValue(other);
6588 zunionInterAggregate(score, value, aggregate);
6589 }
6590 }
6591
6592 robj *o = dictGetEntryKey(de);
6593 dictAdd(dstzset->dict,o,score);
6594 incrRefCount(o); /* added to dictionary */
6595 zslInsert(dstzset->zsl,*score,o);
6596 incrRefCount(o); /* added to skiplist */
6597 }
6598 dictReleaseIterator(di);
6599 }
6600 } else {
6601 /* unknown operator */
6602 redisAssert(op == REDIS_OP_INTER || op == REDIS_OP_UNION);
6603 }
6604
6605 dbDelete(c->db,dstkey);
6606 if (dstzset->zsl->length) {
6607 dbAdd(c->db,dstkey,dstobj);
6608 addReplyLongLong(c, dstzset->zsl->length);
6609 server.dirty++;
6610 } else {
6611 decrRefCount(dstobj);
6612 addReply(c, shared.czero);
6613 }
6614 zfree(src);
6615 }
6616
6617 static void zunionstoreCommand(redisClient *c) {
6618 zunionInterGenericCommand(c,c->argv[1], REDIS_OP_UNION);
6619 }
6620
6621 static void zinterstoreCommand(redisClient *c) {
6622 zunionInterGenericCommand(c,c->argv[1], REDIS_OP_INTER);
6623 }
6624
6625 static void zrangeGenericCommand(redisClient *c, int reverse) {
6626 robj *o;
6627 long start;
6628 long end;
6629 int withscores = 0;
6630 int llen;
6631 int rangelen, j;
6632 zset *zsetobj;
6633 zskiplist *zsl;
6634 zskiplistNode *ln;
6635 robj *ele;
6636
6637 if ((getLongFromObjectOrReply(c, c->argv[2], &start, NULL) != REDIS_OK) ||
6638 (getLongFromObjectOrReply(c, c->argv[3], &end, NULL) != REDIS_OK)) return;
6639
6640 if (c->argc == 5 && !strcasecmp(c->argv[4]->ptr,"withscores")) {
6641 withscores = 1;
6642 } else if (c->argc >= 5) {
6643 addReply(c,shared.syntaxerr);
6644 return;
6645 }
6646
6647 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.emptymultibulk)) == NULL
6648 || checkType(c,o,REDIS_ZSET)) return;
6649 zsetobj = o->ptr;
6650 zsl = zsetobj->zsl;
6651 llen = zsl->length;
6652
6653 /* convert negative indexes */
6654 if (start < 0) start = llen+start;
6655 if (end < 0) end = llen+end;
6656 if (start < 0) start = 0;
6657 if (end < 0) end = 0;
6658
6659 /* indexes sanity checks */
6660 if (start > end || start >= llen) {
6661 /* Out of range start or start > end result in empty list */
6662 addReply(c,shared.emptymultibulk);
6663 return;
6664 }
6665 if (end >= llen) end = llen-1;
6666 rangelen = (end-start)+1;
6667
6668 /* check if starting point is trivial, before searching
6669 * the element in log(N) time */
6670 if (reverse) {
6671 ln = start == 0 ? zsl->tail : zslistTypeGetElementByRank(zsl, llen-start);
6672 } else {
6673 ln = start == 0 ?
6674 zsl->header->forward[0] : zslistTypeGetElementByRank(zsl, start+1);
6675 }
6676
6677 /* Return the result in form of a multi-bulk reply */
6678 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",
6679 withscores ? (rangelen*2) : rangelen));
6680 for (j = 0; j < rangelen; j++) {
6681 ele = ln->obj;
6682 addReplyBulk(c,ele);
6683 if (withscores)
6684 addReplyDouble(c,ln->score);
6685 ln = reverse ? ln->backward : ln->forward[0];
6686 }
6687 }
6688
6689 static void zrangeCommand(redisClient *c) {
6690 zrangeGenericCommand(c,0);
6691 }
6692
6693 static void zrevrangeCommand(redisClient *c) {
6694 zrangeGenericCommand(c,1);
6695 }
6696
6697 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
6698 * If justcount is non-zero, just the count is returned. */
6699 static void genericZrangebyscoreCommand(redisClient *c, int justcount) {
6700 robj *o;
6701 double min, max;
6702 int minex = 0, maxex = 0; /* are min or max exclusive? */
6703 int offset = 0, limit = -1;
6704 int withscores = 0;
6705 int badsyntax = 0;
6706
6707 /* Parse the min-max interval. If one of the values is prefixed
6708 * by the "(" character, it's considered "open". For instance
6709 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
6710 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
6711 if (((char*)c->argv[2]->ptr)[0] == '(') {
6712 min = strtod((char*)c->argv[2]->ptr+1,NULL);
6713 minex = 1;
6714 } else {
6715 min = strtod(c->argv[2]->ptr,NULL);
6716 }
6717 if (((char*)c->argv[3]->ptr)[0] == '(') {
6718 max = strtod((char*)c->argv[3]->ptr+1,NULL);
6719 maxex = 1;
6720 } else {
6721 max = strtod(c->argv[3]->ptr,NULL);
6722 }
6723
6724 /* Parse "WITHSCORES": note that if the command was called with
6725 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
6726 * enter the following paths to parse WITHSCORES and LIMIT. */
6727 if (c->argc == 5 || c->argc == 8) {
6728 if (strcasecmp(c->argv[c->argc-1]->ptr,"withscores") == 0)
6729 withscores = 1;
6730 else
6731 badsyntax = 1;
6732 }
6733 if (c->argc != (4 + withscores) && c->argc != (7 + withscores))
6734 badsyntax = 1;
6735 if (badsyntax) {
6736 addReplySds(c,
6737 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
6738 return;
6739 }
6740
6741 /* Parse "LIMIT" */
6742 if (c->argc == (7 + withscores) && strcasecmp(c->argv[4]->ptr,"limit")) {
6743 addReply(c,shared.syntaxerr);
6744 return;
6745 } else if (c->argc == (7 + withscores)) {
6746 offset = atoi(c->argv[5]->ptr);
6747 limit = atoi(c->argv[6]->ptr);
6748 if (offset < 0) offset = 0;
6749 }
6750
6751 /* Ok, lookup the key and get the range */
6752 o = lookupKeyRead(c->db,c->argv[1]);
6753 if (o == NULL) {
6754 addReply(c,justcount ? shared.czero : shared.emptymultibulk);
6755 } else {
6756 if (o->type != REDIS_ZSET) {
6757 addReply(c,shared.wrongtypeerr);
6758 } else {
6759 zset *zsetobj = o->ptr;
6760 zskiplist *zsl = zsetobj->zsl;
6761 zskiplistNode *ln;
6762 robj *ele, *lenobj = NULL;
6763 unsigned long rangelen = 0;
6764
6765 /* Get the first node with the score >= min, or with
6766 * score > min if 'minex' is true. */
6767 ln = zslFirstWithScore(zsl,min);
6768 while (minex && ln && ln->score == min) ln = ln->forward[0];
6769
6770 if (ln == NULL) {
6771 /* No element matching the speciifed interval */
6772 addReply(c,justcount ? shared.czero : shared.emptymultibulk);
6773 return;
6774 }
6775
6776 /* We don't know in advance how many matching elements there
6777 * are in the list, so we push this object that will represent
6778 * the multi-bulk length in the output buffer, and will "fix"
6779 * it later */
6780 if (!justcount) {
6781 lenobj = createObject(REDIS_STRING,NULL);
6782 addReply(c,lenobj);
6783 decrRefCount(lenobj);
6784 }
6785
6786 while(ln && (maxex ? (ln->score < max) : (ln->score <= max))) {
6787 if (offset) {
6788 offset--;
6789 ln = ln->forward[0];
6790 continue;
6791 }
6792 if (limit == 0) break;
6793 if (!justcount) {
6794 ele = ln->obj;
6795 addReplyBulk(c,ele);
6796 if (withscores)
6797 addReplyDouble(c,ln->score);
6798 }
6799 ln = ln->forward[0];
6800 rangelen++;
6801 if (limit > 0) limit--;
6802 }
6803 if (justcount) {
6804 addReplyLongLong(c,(long)rangelen);
6805 } else {
6806 lenobj->ptr = sdscatprintf(sdsempty(),"*%lu\r\n",
6807 withscores ? (rangelen*2) : rangelen);
6808 }
6809 }
6810 }
6811 }
6812
6813 static void zrangebyscoreCommand(redisClient *c) {
6814 genericZrangebyscoreCommand(c,0);
6815 }
6816
6817 static void zcountCommand(redisClient *c) {
6818 genericZrangebyscoreCommand(c,1);
6819 }
6820
6821 static void zcardCommand(redisClient *c) {
6822 robj *o;
6823 zset *zs;
6824
6825 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
6826 checkType(c,o,REDIS_ZSET)) return;
6827
6828 zs = o->ptr;
6829 addReplyUlong(c,zs->zsl->length);
6830 }
6831
6832 static void zscoreCommand(redisClient *c) {
6833 robj *o;
6834 zset *zs;
6835 dictEntry *de;
6836
6837 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
6838 checkType(c,o,REDIS_ZSET)) return;
6839
6840 zs = o->ptr;
6841 de = dictFind(zs->dict,c->argv[2]);
6842 if (!de) {
6843 addReply(c,shared.nullbulk);
6844 } else {
6845 double *score = dictGetEntryVal(de);
6846
6847 addReplyDouble(c,*score);
6848 }
6849 }
6850
6851 static void zrankGenericCommand(redisClient *c, int reverse) {
6852 robj *o;
6853 zset *zs;
6854 zskiplist *zsl;
6855 dictEntry *de;
6856 unsigned long rank;
6857 double *score;
6858
6859 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
6860 checkType(c,o,REDIS_ZSET)) return;
6861
6862 zs = o->ptr;
6863 zsl = zs->zsl;
6864 de = dictFind(zs->dict,c->argv[2]);
6865 if (!de) {
6866 addReply(c,shared.nullbulk);
6867 return;
6868 }
6869
6870 score = dictGetEntryVal(de);
6871 rank = zslistTypeGetRank(zsl, *score, c->argv[2]);
6872 if (rank) {
6873 if (reverse) {
6874 addReplyLongLong(c, zsl->length - rank);
6875 } else {
6876 addReplyLongLong(c, rank-1);
6877 }
6878 } else {
6879 addReply(c,shared.nullbulk);
6880 }
6881 }
6882
6883 static void zrankCommand(redisClient *c) {
6884 zrankGenericCommand(c, 0);
6885 }
6886
6887 static void zrevrankCommand(redisClient *c) {
6888 zrankGenericCommand(c, 1);
6889 }
6890
6891 /* ========================= Hashes utility functions ======================= */
6892 #define REDIS_HASH_KEY 1
6893 #define REDIS_HASH_VALUE 2
6894
6895 /* Check the length of a number of objects to see if we need to convert a
6896 * zipmap to a real hash. Note that we only check string encoded objects
6897 * as their string length can be queried in constant time. */
6898 static void hashTypeTryConversion(robj *subject, robj **argv, int start, int end) {
6899 int i;
6900 if (subject->encoding != REDIS_ENCODING_ZIPMAP) return;
6901
6902 for (i = start; i <= end; i++) {
6903 if (argv[i]->encoding == REDIS_ENCODING_RAW &&
6904 sdslen(argv[i]->ptr) > server.hash_max_zipmap_value)
6905 {
6906 convertToRealHash(subject);
6907 return;
6908 }
6909 }
6910 }
6911
6912 /* Encode given objects in-place when the hash uses a dict. */
6913 static void hashTypeTryObjectEncoding(robj *subject, robj **o1, robj **o2) {
6914 if (subject->encoding == REDIS_ENCODING_HT) {
6915 if (o1) *o1 = tryObjectEncoding(*o1);
6916 if (o2) *o2 = tryObjectEncoding(*o2);
6917 }
6918 }
6919
6920 /* Get the value from a hash identified by key. Returns either a string
6921 * object or NULL if the value cannot be found. The refcount of the object
6922 * is always increased by 1 when the value was found. */
6923 static robj *hashTypeGet(robj *o, robj *key) {
6924 robj *value = NULL;
6925 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
6926 unsigned char *v;
6927 unsigned int vlen;
6928 key = getDecodedObject(key);
6929 if (zipmapGet(o->ptr,key->ptr,sdslen(key->ptr),&v,&vlen)) {
6930 value = createStringObject((char*)v,vlen);
6931 }
6932 decrRefCount(key);
6933 } else {
6934 dictEntry *de = dictFind(o->ptr,key);
6935 if (de != NULL) {
6936 value = dictGetEntryVal(de);
6937 incrRefCount(value);
6938 }
6939 }
6940 return value;
6941 }
6942
6943 /* Test if the key exists in the given hash. Returns 1 if the key
6944 * exists and 0 when it doesn't. */
6945 static int hashTypeExists(robj *o, robj *key) {
6946 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
6947 key = getDecodedObject(key);
6948 if (zipmapExists(o->ptr,key->ptr,sdslen(key->ptr))) {
6949 decrRefCount(key);
6950 return 1;
6951 }
6952 decrRefCount(key);
6953 } else {
6954 if (dictFind(o->ptr,key) != NULL) {
6955 return 1;
6956 }
6957 }
6958 return 0;
6959 }
6960
6961 /* Add an element, discard the old if the key already exists.
6962 * Return 0 on insert and 1 on update. */
6963 static int hashTypeSet(robj *o, robj *key, robj *value) {
6964 int update = 0;
6965 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
6966 key = getDecodedObject(key);
6967 value = getDecodedObject(value);
6968 o->ptr = zipmapSet(o->ptr,
6969 key->ptr,sdslen(key->ptr),
6970 value->ptr,sdslen(value->ptr), &update);
6971 decrRefCount(key);
6972 decrRefCount(value);
6973
6974 /* Check if the zipmap needs to be upgraded to a real hash table */
6975 if (zipmapLen(o->ptr) > server.hash_max_zipmap_entries)
6976 convertToRealHash(o);
6977 } else {
6978 if (dictReplace(o->ptr,key,value)) {
6979 /* Insert */
6980 incrRefCount(key);
6981 } else {
6982 /* Update */
6983 update = 1;
6984 }
6985 incrRefCount(value);
6986 }
6987 return update;
6988 }
6989
6990 /* Delete an element from a hash.
6991 * Return 1 on deleted and 0 on not found. */
6992 static int hashTypeDelete(robj *o, robj *key) {
6993 int deleted = 0;
6994 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
6995 key = getDecodedObject(key);
6996 o->ptr = zipmapDel(o->ptr,key->ptr,sdslen(key->ptr), &deleted);
6997 decrRefCount(key);
6998 } else {
6999 deleted = dictDelete((dict*)o->ptr,key) == DICT_OK;
7000 /* Always check if the dictionary needs a resize after a delete. */
7001 if (deleted && htNeedsResize(o->ptr)) dictResize(o->ptr);
7002 }
7003 return deleted;
7004 }
7005
7006 /* Return the number of elements in a hash. */
7007 static unsigned long hashTypeLength(robj *o) {
7008 return (o->encoding == REDIS_ENCODING_ZIPMAP) ?
7009 zipmapLen((unsigned char*)o->ptr) : dictSize((dict*)o->ptr);
7010 }
7011
7012 /* Structure to hold hash iteration abstration. Note that iteration over
7013 * hashes involves both fields and values. Because it is possible that
7014 * not both are required, store pointers in the iterator to avoid
7015 * unnecessary memory allocation for fields/values. */
7016 typedef struct {
7017 int encoding;
7018 unsigned char *zi;
7019 unsigned char *zk, *zv;
7020 unsigned int zklen, zvlen;
7021
7022 dictIterator *di;
7023 dictEntry *de;
7024 } hashTypeIterator;
7025
7026 static hashTypeIterator *hashTypeInitIterator(robj *subject) {
7027 hashTypeIterator *hi = zmalloc(sizeof(hashTypeIterator));
7028 hi->encoding = subject->encoding;
7029 if (hi->encoding == REDIS_ENCODING_ZIPMAP) {
7030 hi->zi = zipmapRewind(subject->ptr);
7031 } else if (hi->encoding == REDIS_ENCODING_HT) {
7032 hi->di = dictGetIterator(subject->ptr);
7033 } else {
7034 redisAssert(NULL);
7035 }
7036 return hi;
7037 }
7038
7039 static void hashTypeReleaseIterator(hashTypeIterator *hi) {
7040 if (hi->encoding == REDIS_ENCODING_HT) {
7041 dictReleaseIterator(hi->di);
7042 }
7043 zfree(hi);
7044 }
7045
7046 /* Move to the next entry in the hash. Return REDIS_OK when the next entry
7047 * could be found and REDIS_ERR when the iterator reaches the end. */
7048 static int hashTypeNext(hashTypeIterator *hi) {
7049 if (hi->encoding == REDIS_ENCODING_ZIPMAP) {
7050 if ((hi->zi = zipmapNext(hi->zi, &hi->zk, &hi->zklen,
7051 &hi->zv, &hi->zvlen)) == NULL) return REDIS_ERR;
7052 } else {
7053 if ((hi->de = dictNext(hi->di)) == NULL) return REDIS_ERR;
7054 }
7055 return REDIS_OK;
7056 }
7057
7058 /* Get key or value object at current iteration position.
7059 * This increases the refcount of the field object by 1. */
7060 static robj *hashTypeCurrent(hashTypeIterator *hi, int what) {
7061 robj *o;
7062 if (hi->encoding == REDIS_ENCODING_ZIPMAP) {
7063 if (what & REDIS_HASH_KEY) {
7064 o = createStringObject((char*)hi->zk,hi->zklen);
7065 } else {
7066 o = createStringObject((char*)hi->zv,hi->zvlen);
7067 }
7068 } else {
7069 if (what & REDIS_HASH_KEY) {
7070 o = dictGetEntryKey(hi->de);
7071 } else {
7072 o = dictGetEntryVal(hi->de);
7073 }
7074 incrRefCount(o);
7075 }
7076 return o;
7077 }
7078
7079 static robj *hashTypeLookupWriteOrCreate(redisClient *c, robj *key) {
7080 robj *o = lookupKeyWrite(c->db,key);
7081 if (o == NULL) {
7082 o = createHashObject();
7083 dbAdd(c->db,key,o);
7084 } else {
7085 if (o->type != REDIS_HASH) {
7086 addReply(c,shared.wrongtypeerr);
7087 return NULL;
7088 }
7089 }
7090 return o;
7091 }
7092
7093 /* ============================= Hash commands ============================== */
7094 static void hsetCommand(redisClient *c) {
7095 int update;
7096 robj *o;
7097
7098 if ((o = hashTypeLookupWriteOrCreate(c,c->argv[1])) == NULL) return;
7099 hashTypeTryConversion(o,c->argv,2,3);
7100 hashTypeTryObjectEncoding(o,&c->argv[2], &c->argv[3]);
7101 update = hashTypeSet(o,c->argv[2],c->argv[3]);
7102 addReply(c, update ? shared.czero : shared.cone);
7103 server.dirty++;
7104 }
7105
7106 static void hsetnxCommand(redisClient *c) {
7107 robj *o;
7108 if ((o = hashTypeLookupWriteOrCreate(c,c->argv[1])) == NULL) return;
7109 hashTypeTryConversion(o,c->argv,2,3);
7110
7111 if (hashTypeExists(o, c->argv[2])) {
7112 addReply(c, shared.czero);
7113 } else {
7114 hashTypeTryObjectEncoding(o,&c->argv[2], &c->argv[3]);
7115 hashTypeSet(o,c->argv[2],c->argv[3]);
7116 addReply(c, shared.cone);
7117 server.dirty++;
7118 }
7119 }
7120
7121 static void hmsetCommand(redisClient *c) {
7122 int i;
7123 robj *o;
7124
7125 if ((c->argc % 2) == 1) {
7126 addReplySds(c,sdsnew("-ERR wrong number of arguments for HMSET\r\n"));
7127 return;
7128 }
7129
7130 if ((o = hashTypeLookupWriteOrCreate(c,c->argv[1])) == NULL) return;
7131 hashTypeTryConversion(o,c->argv,2,c->argc-1);
7132 for (i = 2; i < c->argc; i += 2) {
7133 hashTypeTryObjectEncoding(o,&c->argv[i], &c->argv[i+1]);
7134 hashTypeSet(o,c->argv[i],c->argv[i+1]);
7135 }
7136 addReply(c, shared.ok);
7137 server.dirty++;
7138 }
7139
7140 static void hincrbyCommand(redisClient *c) {
7141 long long value, incr;
7142 robj *o, *current, *new;
7143
7144 if (getLongLongFromObjectOrReply(c,c->argv[3],&incr,NULL) != REDIS_OK) return;
7145 if ((o = hashTypeLookupWriteOrCreate(c,c->argv[1])) == NULL) return;
7146 if ((current = hashTypeGet(o,c->argv[2])) != NULL) {
7147 if (getLongLongFromObjectOrReply(c,current,&value,
7148 "hash value is not an integer") != REDIS_OK) {
7149 decrRefCount(current);
7150 return;
7151 }
7152 decrRefCount(current);
7153 } else {
7154 value = 0;
7155 }
7156
7157 value += incr;
7158 new = createStringObjectFromLongLong(value);
7159 hashTypeTryObjectEncoding(o,&c->argv[2],NULL);
7160 hashTypeSet(o,c->argv[2],new);
7161 decrRefCount(new);
7162 addReplyLongLong(c,value);
7163 server.dirty++;
7164 }
7165
7166 static void hgetCommand(redisClient *c) {
7167 robj *o, *value;
7168 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
7169 checkType(c,o,REDIS_HASH)) return;
7170
7171 if ((value = hashTypeGet(o,c->argv[2])) != NULL) {
7172 addReplyBulk(c,value);
7173 decrRefCount(value);
7174 } else {
7175 addReply(c,shared.nullbulk);
7176 }
7177 }
7178
7179 static void hmgetCommand(redisClient *c) {
7180 int i;
7181 robj *o, *value;
7182 o = lookupKeyRead(c->db,c->argv[1]);
7183 if (o != NULL && o->type != REDIS_HASH) {
7184 addReply(c,shared.wrongtypeerr);
7185 }
7186
7187 /* Note the check for o != NULL happens inside the loop. This is
7188 * done because objects that cannot be found are considered to be
7189 * an empty hash. The reply should then be a series of NULLs. */
7190 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",c->argc-2));
7191 for (i = 2; i < c->argc; i++) {
7192 if (o != NULL && (value = hashTypeGet(o,c->argv[i])) != NULL) {
7193 addReplyBulk(c,value);
7194 decrRefCount(value);
7195 } else {
7196 addReply(c,shared.nullbulk);
7197 }
7198 }
7199 }
7200
7201 static void hdelCommand(redisClient *c) {
7202 robj *o;
7203 if ((o = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
7204 checkType(c,o,REDIS_HASH)) return;
7205
7206 if (hashTypeDelete(o,c->argv[2])) {
7207 if (hashTypeLength(o) == 0) dbDelete(c->db,c->argv[1]);
7208 addReply(c,shared.cone);
7209 server.dirty++;
7210 } else {
7211 addReply(c,shared.czero);
7212 }
7213 }
7214
7215 static void hlenCommand(redisClient *c) {
7216 robj *o;
7217 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
7218 checkType(c,o,REDIS_HASH)) return;
7219
7220 addReplyUlong(c,hashTypeLength(o));
7221 }
7222
7223 static void genericHgetallCommand(redisClient *c, int flags) {
7224 robj *o, *lenobj, *obj;
7225 unsigned long count = 0;
7226 hashTypeIterator *hi;
7227
7228 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.emptymultibulk)) == NULL
7229 || checkType(c,o,REDIS_HASH)) return;
7230
7231 lenobj = createObject(REDIS_STRING,NULL);
7232 addReply(c,lenobj);
7233 decrRefCount(lenobj);
7234
7235 hi = hashTypeInitIterator(o);
7236 while (hashTypeNext(hi) != REDIS_ERR) {
7237 if (flags & REDIS_HASH_KEY) {
7238 obj = hashTypeCurrent(hi,REDIS_HASH_KEY);
7239 addReplyBulk(c,obj);
7240 decrRefCount(obj);
7241 count++;
7242 }
7243 if (flags & REDIS_HASH_VALUE) {
7244 obj = hashTypeCurrent(hi,REDIS_HASH_VALUE);
7245 addReplyBulk(c,obj);
7246 decrRefCount(obj);
7247 count++;
7248 }
7249 }
7250 hashTypeReleaseIterator(hi);
7251
7252 lenobj->ptr = sdscatprintf(sdsempty(),"*%lu\r\n",count);
7253 }
7254
7255 static void hkeysCommand(redisClient *c) {
7256 genericHgetallCommand(c,REDIS_HASH_KEY);
7257 }
7258
7259 static void hvalsCommand(redisClient *c) {
7260 genericHgetallCommand(c,REDIS_HASH_VALUE);
7261 }
7262
7263 static void hgetallCommand(redisClient *c) {
7264 genericHgetallCommand(c,REDIS_HASH_KEY|REDIS_HASH_VALUE);
7265 }
7266
7267 static void hexistsCommand(redisClient *c) {
7268 robj *o;
7269 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
7270 checkType(c,o,REDIS_HASH)) return;
7271
7272 addReply(c, hashTypeExists(o,c->argv[2]) ? shared.cone : shared.czero);
7273 }
7274
7275 static void convertToRealHash(robj *o) {
7276 unsigned char *key, *val, *p, *zm = o->ptr;
7277 unsigned int klen, vlen;
7278 dict *dict = dictCreate(&hashDictType,NULL);
7279
7280 assert(o->type == REDIS_HASH && o->encoding != REDIS_ENCODING_HT);
7281 p = zipmapRewind(zm);
7282 while((p = zipmapNext(p,&key,&klen,&val,&vlen)) != NULL) {
7283 robj *keyobj, *valobj;
7284
7285 keyobj = createStringObject((char*)key,klen);
7286 valobj = createStringObject((char*)val,vlen);
7287 keyobj = tryObjectEncoding(keyobj);
7288 valobj = tryObjectEncoding(valobj);
7289 dictAdd(dict,keyobj,valobj);
7290 }
7291 o->encoding = REDIS_ENCODING_HT;
7292 o->ptr = dict;
7293 zfree(zm);
7294 }
7295
7296 /* ========================= Non type-specific commands ==================== */
7297
7298 static void flushdbCommand(redisClient *c) {
7299 server.dirty += dictSize(c->db->dict);
7300 touchWatchedKeysOnFlush(c->db->id);
7301 dictEmpty(c->db->dict);
7302 dictEmpty(c->db->expires);
7303 addReply(c,shared.ok);
7304 }
7305
7306 static void flushallCommand(redisClient *c) {
7307 touchWatchedKeysOnFlush(-1);
7308 server.dirty += emptyDb();
7309 addReply(c,shared.ok);
7310 if (server.bgsavechildpid != -1) {
7311 kill(server.bgsavechildpid,SIGKILL);
7312 rdbRemoveTempFile(server.bgsavechildpid);
7313 }
7314 rdbSave(server.dbfilename);
7315 server.dirty++;
7316 }
7317
7318 static redisSortOperation *createSortOperation(int type, robj *pattern) {
7319 redisSortOperation *so = zmalloc(sizeof(*so));
7320 so->type = type;
7321 so->pattern = pattern;
7322 return so;
7323 }
7324
7325 /* Return the value associated to the key with a name obtained
7326 * substituting the first occurence of '*' in 'pattern' with 'subst'.
7327 * The returned object will always have its refcount increased by 1
7328 * when it is non-NULL. */
7329 static robj *lookupKeyByPattern(redisDb *db, robj *pattern, robj *subst) {
7330 char *p, *f;
7331 sds spat, ssub;
7332 robj keyobj, fieldobj, *o;
7333 int prefixlen, sublen, postfixlen, fieldlen;
7334 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
7335 struct {
7336 long len;
7337 long free;
7338 char buf[REDIS_SORTKEY_MAX+1];
7339 } keyname, fieldname;
7340
7341 /* If the pattern is "#" return the substitution object itself in order
7342 * to implement the "SORT ... GET #" feature. */
7343 spat = pattern->ptr;
7344 if (spat[0] == '#' && spat[1] == '\0') {
7345 incrRefCount(subst);
7346 return subst;
7347 }
7348
7349 /* The substitution object may be specially encoded. If so we create
7350 * a decoded object on the fly. Otherwise getDecodedObject will just
7351 * increment the ref count, that we'll decrement later. */
7352 subst = getDecodedObject(subst);
7353
7354 ssub = subst->ptr;
7355 if (sdslen(spat)+sdslen(ssub)-1 > REDIS_SORTKEY_MAX) return NULL;
7356 p = strchr(spat,'*');
7357 if (!p) {
7358 decrRefCount(subst);
7359 return NULL;
7360 }
7361
7362 /* Find out if we're dealing with a hash dereference. */
7363 if ((f = strstr(p+1, "->")) != NULL) {
7364 fieldlen = sdslen(spat)-(f-spat);
7365 /* this also copies \0 character */
7366 memcpy(fieldname.buf,f+2,fieldlen-1);
7367 fieldname.len = fieldlen-2;
7368 } else {
7369 fieldlen = 0;
7370 }
7371
7372 prefixlen = p-spat;
7373 sublen = sdslen(ssub);
7374 postfixlen = sdslen(spat)-(prefixlen+1)-fieldlen;
7375 memcpy(keyname.buf,spat,prefixlen);
7376 memcpy(keyname.buf+prefixlen,ssub,sublen);
7377 memcpy(keyname.buf+prefixlen+sublen,p+1,postfixlen);
7378 keyname.buf[prefixlen+sublen+postfixlen] = '\0';
7379 keyname.len = prefixlen+sublen+postfixlen;
7380 decrRefCount(subst);
7381
7382 /* Lookup substituted key */
7383 initStaticStringObject(keyobj,((char*)&keyname)+(sizeof(long)*2));
7384 o = lookupKeyRead(db,&keyobj);
7385 if (o == NULL) return NULL;
7386
7387 if (fieldlen > 0) {
7388 if (o->type != REDIS_HASH || fieldname.len < 1) return NULL;
7389
7390 /* Retrieve value from hash by the field name. This operation
7391 * already increases the refcount of the returned object. */
7392 initStaticStringObject(fieldobj,((char*)&fieldname)+(sizeof(long)*2));
7393 o = hashTypeGet(o, &fieldobj);
7394 } else {
7395 if (o->type != REDIS_STRING) return NULL;
7396
7397 /* Every object that this function returns needs to have its refcount
7398 * increased. sortCommand decreases it again. */
7399 incrRefCount(o);
7400 }
7401
7402 return o;
7403 }
7404
7405 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
7406 * the additional parameter is not standard but a BSD-specific we have to
7407 * pass sorting parameters via the global 'server' structure */
7408 static int sortCompare(const void *s1, const void *s2) {
7409 const redisSortObject *so1 = s1, *so2 = s2;
7410 int cmp;
7411
7412 if (!server.sort_alpha) {
7413 /* Numeric sorting. Here it's trivial as we precomputed scores */
7414 if (so1->u.score > so2->u.score) {
7415 cmp = 1;
7416 } else if (so1->u.score < so2->u.score) {
7417 cmp = -1;
7418 } else {
7419 cmp = 0;
7420 }
7421 } else {
7422 /* Alphanumeric sorting */
7423 if (server.sort_bypattern) {
7424 if (!so1->u.cmpobj || !so2->u.cmpobj) {
7425 /* At least one compare object is NULL */
7426 if (so1->u.cmpobj == so2->u.cmpobj)
7427 cmp = 0;
7428 else if (so1->u.cmpobj == NULL)
7429 cmp = -1;
7430 else
7431 cmp = 1;
7432 } else {
7433 /* We have both the objects, use strcoll */
7434 cmp = strcoll(so1->u.cmpobj->ptr,so2->u.cmpobj->ptr);
7435 }
7436 } else {
7437 /* Compare elements directly. */
7438 cmp = compareStringObjects(so1->obj,so2->obj);
7439 }
7440 }
7441 return server.sort_desc ? -cmp : cmp;
7442 }
7443
7444 /* The SORT command is the most complex command in Redis. Warning: this code
7445 * is optimized for speed and a bit less for readability */
7446 static void sortCommand(redisClient *c) {
7447 list *operations;
7448 unsigned int outputlen = 0;
7449 int desc = 0, alpha = 0;
7450 int limit_start = 0, limit_count = -1, start, end;
7451 int j, dontsort = 0, vectorlen;
7452 int getop = 0; /* GET operation counter */
7453 robj *sortval, *sortby = NULL, *storekey = NULL;
7454 redisSortObject *vector; /* Resulting vector to sort */
7455
7456 /* Lookup the key to sort. It must be of the right types */
7457 sortval = lookupKeyRead(c->db,c->argv[1]);
7458 if (sortval == NULL) {
7459 addReply(c,shared.emptymultibulk);
7460 return;
7461 }
7462 if (sortval->type != REDIS_SET && sortval->type != REDIS_LIST &&
7463 sortval->type != REDIS_ZSET)
7464 {
7465 addReply(c,shared.wrongtypeerr);
7466 return;
7467 }
7468
7469 /* Create a list of operations to perform for every sorted element.
7470 * Operations can be GET/DEL/INCR/DECR */
7471 operations = listCreate();
7472 listSetFreeMethod(operations,zfree);
7473 j = 2;
7474
7475 /* Now we need to protect sortval incrementing its count, in the future
7476 * SORT may have options able to overwrite/delete keys during the sorting
7477 * and the sorted key itself may get destroied */
7478 incrRefCount(sortval);
7479
7480 /* The SORT command has an SQL-alike syntax, parse it */
7481 while(j < c->argc) {
7482 int leftargs = c->argc-j-1;
7483 if (!strcasecmp(c->argv[j]->ptr,"asc")) {
7484 desc = 0;
7485 } else if (!strcasecmp(c->argv[j]->ptr,"desc")) {
7486 desc = 1;
7487 } else if (!strcasecmp(c->argv[j]->ptr,"alpha")) {
7488 alpha = 1;
7489 } else if (!strcasecmp(c->argv[j]->ptr,"limit") && leftargs >= 2) {
7490 limit_start = atoi(c->argv[j+1]->ptr);
7491 limit_count = atoi(c->argv[j+2]->ptr);
7492 j+=2;
7493 } else if (!strcasecmp(c->argv[j]->ptr,"store") && leftargs >= 1) {
7494 storekey = c->argv[j+1];
7495 j++;
7496 } else if (!strcasecmp(c->argv[j]->ptr,"by") && leftargs >= 1) {
7497 sortby = c->argv[j+1];
7498 /* If the BY pattern does not contain '*', i.e. it is constant,
7499 * we don't need to sort nor to lookup the weight keys. */
7500 if (strchr(c->argv[j+1]->ptr,'*') == NULL) dontsort = 1;
7501 j++;
7502 } else if (!strcasecmp(c->argv[j]->ptr,"get") && leftargs >= 1) {
7503 listAddNodeTail(operations,createSortOperation(
7504 REDIS_SORT_GET,c->argv[j+1]));
7505 getop++;
7506 j++;
7507 } else {
7508 decrRefCount(sortval);
7509 listRelease(operations);
7510 addReply(c,shared.syntaxerr);
7511 return;
7512 }
7513 j++;
7514 }
7515
7516 /* Load the sorting vector with all the objects to sort */
7517 switch(sortval->type) {
7518 case REDIS_LIST: vectorlen = listTypeLength(sortval); break;
7519 case REDIS_SET: vectorlen = dictSize((dict*)sortval->ptr); break;
7520 case REDIS_ZSET: vectorlen = dictSize(((zset*)sortval->ptr)->dict); break;
7521 default: vectorlen = 0; redisPanic("Bad SORT type"); /* Avoid GCC warning */
7522 }
7523 vector = zmalloc(sizeof(redisSortObject)*vectorlen);
7524 j = 0;
7525
7526 if (sortval->type == REDIS_LIST) {
7527 listTypeIterator *li = listTypeInitIterator(sortval,0,REDIS_TAIL);
7528 listTypeEntry entry;
7529 while(listTypeNext(li,&entry)) {
7530 vector[j].obj = listTypeGet(&entry);
7531 vector[j].u.score = 0;
7532 vector[j].u.cmpobj = NULL;
7533 j++;
7534 }
7535 listTypeReleaseIterator(li);
7536 } else {
7537 dict *set;
7538 dictIterator *di;
7539 dictEntry *setele;
7540
7541 if (sortval->type == REDIS_SET) {
7542 set = sortval->ptr;
7543 } else {
7544 zset *zs = sortval->ptr;
7545 set = zs->dict;
7546 }
7547
7548 di = dictGetIterator(set);
7549 while((setele = dictNext(di)) != NULL) {
7550 vector[j].obj = dictGetEntryKey(setele);
7551 vector[j].u.score = 0;
7552 vector[j].u.cmpobj = NULL;
7553 j++;
7554 }
7555 dictReleaseIterator(di);
7556 }
7557 redisAssert(j == vectorlen);
7558
7559 /* Now it's time to load the right scores in the sorting vector */
7560 if (dontsort == 0) {
7561 for (j = 0; j < vectorlen; j++) {
7562 robj *byval;
7563 if (sortby) {
7564 /* lookup value to sort by */
7565 byval = lookupKeyByPattern(c->db,sortby,vector[j].obj);
7566 if (!byval) continue;
7567 } else {
7568 /* use object itself to sort by */
7569 byval = vector[j].obj;
7570 }
7571
7572 if (alpha) {
7573 if (sortby) vector[j].u.cmpobj = getDecodedObject(byval);
7574 } else {
7575 if (byval->encoding == REDIS_ENCODING_RAW) {
7576 vector[j].u.score = strtod(byval->ptr,NULL);
7577 } else if (byval->encoding == REDIS_ENCODING_INT) {
7578 /* Don't need to decode the object if it's
7579 * integer-encoded (the only encoding supported) so
7580 * far. We can just cast it */
7581 vector[j].u.score = (long)byval->ptr;
7582 } else {
7583 redisAssert(1 != 1);
7584 }
7585 }
7586
7587 /* when the object was retrieved using lookupKeyByPattern,
7588 * its refcount needs to be decreased. */
7589 if (sortby) {
7590 decrRefCount(byval);
7591 }
7592 }
7593 }
7594
7595 /* We are ready to sort the vector... perform a bit of sanity check
7596 * on the LIMIT option too. We'll use a partial version of quicksort. */
7597 start = (limit_start < 0) ? 0 : limit_start;
7598 end = (limit_count < 0) ? vectorlen-1 : start+limit_count-1;
7599 if (start >= vectorlen) {
7600 start = vectorlen-1;
7601 end = vectorlen-2;
7602 }
7603 if (end >= vectorlen) end = vectorlen-1;
7604
7605 if (dontsort == 0) {
7606 server.sort_desc = desc;
7607 server.sort_alpha = alpha;
7608 server.sort_bypattern = sortby ? 1 : 0;
7609 if (sortby && (start != 0 || end != vectorlen-1))
7610 pqsort(vector,vectorlen,sizeof(redisSortObject),sortCompare, start,end);
7611 else
7612 qsort(vector,vectorlen,sizeof(redisSortObject),sortCompare);
7613 }
7614
7615 /* Send command output to the output buffer, performing the specified
7616 * GET/DEL/INCR/DECR operations if any. */
7617 outputlen = getop ? getop*(end-start+1) : end-start+1;
7618 if (storekey == NULL) {
7619 /* STORE option not specified, sent the sorting result to client */
7620 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",outputlen));
7621 for (j = start; j <= end; j++) {
7622 listNode *ln;
7623 listIter li;
7624
7625 if (!getop) addReplyBulk(c,vector[j].obj);
7626 listRewind(operations,&li);
7627 while((ln = listNext(&li))) {
7628 redisSortOperation *sop = ln->value;
7629 robj *val = lookupKeyByPattern(c->db,sop->pattern,
7630 vector[j].obj);
7631
7632 if (sop->type == REDIS_SORT_GET) {
7633 if (!val) {
7634 addReply(c,shared.nullbulk);
7635 } else {
7636 addReplyBulk(c,val);
7637 decrRefCount(val);
7638 }
7639 } else {
7640 redisAssert(sop->type == REDIS_SORT_GET); /* always fails */
7641 }
7642 }
7643 }
7644 } else {
7645 robj *sobj = createZiplistObject();
7646
7647 /* STORE option specified, set the sorting result as a List object */
7648 for (j = start; j <= end; j++) {
7649 listNode *ln;
7650 listIter li;
7651
7652 if (!getop) {
7653 listTypePush(sobj,vector[j].obj,REDIS_TAIL);
7654 } else {
7655 listRewind(operations,&li);
7656 while((ln = listNext(&li))) {
7657 redisSortOperation *sop = ln->value;
7658 robj *val = lookupKeyByPattern(c->db,sop->pattern,
7659 vector[j].obj);
7660
7661 if (sop->type == REDIS_SORT_GET) {
7662 if (!val) val = createStringObject("",0);
7663
7664 /* listTypePush does an incrRefCount, so we should take care
7665 * care of the incremented refcount caused by either
7666 * lookupKeyByPattern or createStringObject("",0) */
7667 listTypePush(sobj,val,REDIS_TAIL);
7668 decrRefCount(val);
7669 } else {
7670 /* always fails */
7671 redisAssert(sop->type == REDIS_SORT_GET);
7672 }
7673 }
7674 }
7675 }
7676 dbReplace(c->db,storekey,sobj);
7677 /* Note: we add 1 because the DB is dirty anyway since even if the
7678 * SORT result is empty a new key is set and maybe the old content
7679 * replaced. */
7680 server.dirty += 1+outputlen;
7681 addReplySds(c,sdscatprintf(sdsempty(),":%d\r\n",outputlen));
7682 }
7683
7684 /* Cleanup */
7685 if (sortval->type == REDIS_LIST)
7686 for (j = 0; j < vectorlen; j++)
7687 decrRefCount(vector[j].obj);
7688 decrRefCount(sortval);
7689 listRelease(operations);
7690 for (j = 0; j < vectorlen; j++) {
7691 if (alpha && vector[j].u.cmpobj)
7692 decrRefCount(vector[j].u.cmpobj);
7693 }
7694 zfree(vector);
7695 }
7696
7697 /* Convert an amount of bytes into a human readable string in the form
7698 * of 100B, 2G, 100M, 4K, and so forth. */
7699 static void bytesToHuman(char *s, unsigned long long n) {
7700 double d;
7701
7702 if (n < 1024) {
7703 /* Bytes */
7704 sprintf(s,"%lluB",n);
7705 return;
7706 } else if (n < (1024*1024)) {
7707 d = (double)n/(1024);
7708 sprintf(s,"%.2fK",d);
7709 } else if (n < (1024LL*1024*1024)) {
7710 d = (double)n/(1024*1024);
7711 sprintf(s,"%.2fM",d);
7712 } else if (n < (1024LL*1024*1024*1024)) {
7713 d = (double)n/(1024LL*1024*1024);
7714 sprintf(s,"%.2fG",d);
7715 }
7716 }
7717
7718 /* Create the string returned by the INFO command. This is decoupled
7719 * by the INFO command itself as we need to report the same information
7720 * on memory corruption problems. */
7721 static sds genRedisInfoString(void) {
7722 sds info;
7723 time_t uptime = time(NULL)-server.stat_starttime;
7724 int j;
7725 char hmem[64];
7726
7727 bytesToHuman(hmem,zmalloc_used_memory());
7728 info = sdscatprintf(sdsempty(),
7729 "redis_version:%s\r\n"
7730 "redis_git_sha1:%s\r\n"
7731 "redis_git_dirty:%d\r\n"
7732 "arch_bits:%s\r\n"
7733 "multiplexing_api:%s\r\n"
7734 "process_id:%ld\r\n"
7735 "uptime_in_seconds:%ld\r\n"
7736 "uptime_in_days:%ld\r\n"
7737 "connected_clients:%d\r\n"
7738 "connected_slaves:%d\r\n"
7739 "blocked_clients:%d\r\n"
7740 "used_memory:%zu\r\n"
7741 "used_memory_human:%s\r\n"
7742 "changes_since_last_save:%lld\r\n"
7743 "bgsave_in_progress:%d\r\n"
7744 "last_save_time:%ld\r\n"
7745 "bgrewriteaof_in_progress:%d\r\n"
7746 "total_connections_received:%lld\r\n"
7747 "total_commands_processed:%lld\r\n"
7748 "expired_keys:%lld\r\n"
7749 "hash_max_zipmap_entries:%zu\r\n"
7750 "hash_max_zipmap_value:%zu\r\n"
7751 "pubsub_channels:%ld\r\n"
7752 "pubsub_patterns:%u\r\n"
7753 "vm_enabled:%d\r\n"
7754 "role:%s\r\n"
7755 ,REDIS_VERSION,
7756 REDIS_GIT_SHA1,
7757 strtol(REDIS_GIT_DIRTY,NULL,10) > 0,
7758 (sizeof(long) == 8) ? "64" : "32",
7759 aeGetApiName(),
7760 (long) getpid(),
7761 uptime,
7762 uptime/(3600*24),
7763 listLength(server.clients)-listLength(server.slaves),
7764 listLength(server.slaves),
7765 server.blpop_blocked_clients,
7766 zmalloc_used_memory(),
7767 hmem,
7768 server.dirty,
7769 server.bgsavechildpid != -1,
7770 server.lastsave,
7771 server.bgrewritechildpid != -1,
7772 server.stat_numconnections,
7773 server.stat_numcommands,
7774 server.stat_expiredkeys,
7775 server.hash_max_zipmap_entries,
7776 server.hash_max_zipmap_value,
7777 dictSize(server.pubsub_channels),
7778 listLength(server.pubsub_patterns),
7779 server.vm_enabled != 0,
7780 server.masterhost == NULL ? "master" : "slave"
7781 );
7782 if (server.masterhost) {
7783 info = sdscatprintf(info,
7784 "master_host:%s\r\n"
7785 "master_port:%d\r\n"
7786 "master_link_status:%s\r\n"
7787 "master_last_io_seconds_ago:%d\r\n"
7788 ,server.masterhost,
7789 server.masterport,
7790 (server.replstate == REDIS_REPL_CONNECTED) ?
7791 "up" : "down",
7792 server.master ? ((int)(time(NULL)-server.master->lastinteraction)) : -1
7793 );
7794 }
7795 if (server.vm_enabled) {
7796 lockThreadedIO();
7797 info = sdscatprintf(info,
7798 "vm_conf_max_memory:%llu\r\n"
7799 "vm_conf_page_size:%llu\r\n"
7800 "vm_conf_pages:%llu\r\n"
7801 "vm_stats_used_pages:%llu\r\n"
7802 "vm_stats_swapped_objects:%llu\r\n"
7803 "vm_stats_swappin_count:%llu\r\n"
7804 "vm_stats_swappout_count:%llu\r\n"
7805 "vm_stats_io_newjobs_len:%lu\r\n"
7806 "vm_stats_io_processing_len:%lu\r\n"
7807 "vm_stats_io_processed_len:%lu\r\n"
7808 "vm_stats_io_active_threads:%lu\r\n"
7809 "vm_stats_blocked_clients:%lu\r\n"
7810 ,(unsigned long long) server.vm_max_memory,
7811 (unsigned long long) server.vm_page_size,
7812 (unsigned long long) server.vm_pages,
7813 (unsigned long long) server.vm_stats_used_pages,
7814 (unsigned long long) server.vm_stats_swapped_objects,
7815 (unsigned long long) server.vm_stats_swapins,
7816 (unsigned long long) server.vm_stats_swapouts,
7817 (unsigned long) listLength(server.io_newjobs),
7818 (unsigned long) listLength(server.io_processing),
7819 (unsigned long) listLength(server.io_processed),
7820 (unsigned long) server.io_active_threads,
7821 (unsigned long) server.vm_blocked_clients
7822 );
7823 unlockThreadedIO();
7824 }
7825 for (j = 0; j < server.dbnum; j++) {
7826 long long keys, vkeys;
7827
7828 keys = dictSize(server.db[j].dict);
7829 vkeys = dictSize(server.db[j].expires);
7830 if (keys || vkeys) {
7831 info = sdscatprintf(info, "db%d:keys=%lld,expires=%lld\r\n",
7832 j, keys, vkeys);
7833 }
7834 }
7835 return info;
7836 }
7837
7838 static void infoCommand(redisClient *c) {
7839 sds info = genRedisInfoString();
7840 addReplySds(c,sdscatprintf(sdsempty(),"$%lu\r\n",
7841 (unsigned long)sdslen(info)));
7842 addReplySds(c,info);
7843 addReply(c,shared.crlf);
7844 }
7845
7846 static void monitorCommand(redisClient *c) {
7847 /* ignore MONITOR if aleady slave or in monitor mode */
7848 if (c->flags & REDIS_SLAVE) return;
7849
7850 c->flags |= (REDIS_SLAVE|REDIS_MONITOR);
7851 c->slaveseldb = 0;
7852 listAddNodeTail(server.monitors,c);
7853 addReply(c,shared.ok);
7854 }
7855
7856 /* ================================= Expire ================================= */
7857 static int removeExpire(redisDb *db, robj *key) {
7858 if (dictDelete(db->expires,key->ptr) == DICT_OK) {
7859 return 1;
7860 } else {
7861 return 0;
7862 }
7863 }
7864
7865 static int setExpire(redisDb *db, robj *key, time_t when) {
7866 sds copy = sdsdup(key->ptr);
7867 if (dictAdd(db->expires,copy,(void*)when) == DICT_ERR) {
7868 sdsfree(copy);
7869 return 0;
7870 } else {
7871 return 1;
7872 }
7873 }
7874
7875 /* Return the expire time of the specified key, or -1 if no expire
7876 * is associated with this key (i.e. the key is non volatile) */
7877 static time_t getExpire(redisDb *db, robj *key) {
7878 dictEntry *de;
7879
7880 /* No expire? return ASAP */
7881 if (dictSize(db->expires) == 0 ||
7882 (de = dictFind(db->expires,key->ptr)) == NULL) return -1;
7883
7884 return (time_t) dictGetEntryVal(de);
7885 }
7886
7887 static int expireIfNeeded(redisDb *db, robj *key) {
7888 time_t when;
7889 dictEntry *de;
7890
7891 /* No expire? return ASAP */
7892 if (dictSize(db->expires) == 0 ||
7893 (de = dictFind(db->expires,key->ptr)) == NULL) return 0;
7894
7895 /* Lookup the expire */
7896 when = (time_t) dictGetEntryVal(de);
7897 if (time(NULL) <= when) return 0;
7898
7899 /* Delete the key */
7900 dbDelete(db,key);
7901 server.stat_expiredkeys++;
7902 return 1;
7903 }
7904
7905 static int deleteIfVolatile(redisDb *db, robj *key) {
7906 dictEntry *de;
7907
7908 /* No expire? return ASAP */
7909 if (dictSize(db->expires) == 0 ||
7910 (de = dictFind(db->expires,key->ptr)) == NULL) return 0;
7911
7912 /* Delete the key */
7913 server.dirty++;
7914 server.stat_expiredkeys++;
7915 dictDelete(db->expires,key->ptr);
7916 return dictDelete(db->dict,key->ptr) == DICT_OK;
7917 }
7918
7919 static void expireGenericCommand(redisClient *c, robj *key, robj *param, long offset) {
7920 dictEntry *de;
7921 time_t seconds;
7922
7923 if (getLongFromObjectOrReply(c, param, &seconds, NULL) != REDIS_OK) return;
7924
7925 seconds -= offset;
7926
7927 de = dictFind(c->db->dict,key->ptr);
7928 if (de == NULL) {
7929 addReply(c,shared.czero);
7930 return;
7931 }
7932 if (seconds <= 0) {
7933 if (dbDelete(c->db,key)) server.dirty++;
7934 addReply(c, shared.cone);
7935 return;
7936 } else {
7937 time_t when = time(NULL)+seconds;
7938 if (setExpire(c->db,key,when)) {
7939 addReply(c,shared.cone);
7940 server.dirty++;
7941 } else {
7942 addReply(c,shared.czero);
7943 }
7944 return;
7945 }
7946 }
7947
7948 static void expireCommand(redisClient *c) {
7949 expireGenericCommand(c,c->argv[1],c->argv[2],0);
7950 }
7951
7952 static void expireatCommand(redisClient *c) {
7953 expireGenericCommand(c,c->argv[1],c->argv[2],time(NULL));
7954 }
7955
7956 static void ttlCommand(redisClient *c) {
7957 time_t expire;
7958 int ttl = -1;
7959
7960 expire = getExpire(c->db,c->argv[1]);
7961 if (expire != -1) {
7962 ttl = (int) (expire-time(NULL));
7963 if (ttl < 0) ttl = -1;
7964 }
7965 addReplySds(c,sdscatprintf(sdsempty(),":%d\r\n",ttl));
7966 }
7967
7968 /* ================================ MULTI/EXEC ============================== */
7969
7970 /* Client state initialization for MULTI/EXEC */
7971 static void initClientMultiState(redisClient *c) {
7972 c->mstate.commands = NULL;
7973 c->mstate.count = 0;
7974 }
7975
7976 /* Release all the resources associated with MULTI/EXEC state */
7977 static void freeClientMultiState(redisClient *c) {
7978 int j;
7979
7980 for (j = 0; j < c->mstate.count; j++) {
7981 int i;
7982 multiCmd *mc = c->mstate.commands+j;
7983
7984 for (i = 0; i < mc->argc; i++)
7985 decrRefCount(mc->argv[i]);
7986 zfree(mc->argv);
7987 }
7988 zfree(c->mstate.commands);
7989 }
7990
7991 /* Add a new command into the MULTI commands queue */
7992 static void queueMultiCommand(redisClient *c, struct redisCommand *cmd) {
7993 multiCmd *mc;
7994 int j;
7995
7996 c->mstate.commands = zrealloc(c->mstate.commands,
7997 sizeof(multiCmd)*(c->mstate.count+1));
7998 mc = c->mstate.commands+c->mstate.count;
7999 mc->cmd = cmd;
8000 mc->argc = c->argc;
8001 mc->argv = zmalloc(sizeof(robj*)*c->argc);
8002 memcpy(mc->argv,c->argv,sizeof(robj*)*c->argc);
8003 for (j = 0; j < c->argc; j++)
8004 incrRefCount(mc->argv[j]);
8005 c->mstate.count++;
8006 }
8007
8008 static void multiCommand(redisClient *c) {
8009 if (c->flags & REDIS_MULTI) {
8010 addReplySds(c,sdsnew("-ERR MULTI calls can not be nested\r\n"));
8011 return;
8012 }
8013 c->flags |= REDIS_MULTI;
8014 addReply(c,shared.ok);
8015 }
8016
8017 static void discardCommand(redisClient *c) {
8018 if (!(c->flags & REDIS_MULTI)) {
8019 addReplySds(c,sdsnew("-ERR DISCARD without MULTI\r\n"));
8020 return;
8021 }
8022
8023 freeClientMultiState(c);
8024 initClientMultiState(c);
8025 c->flags &= (~REDIS_MULTI);
8026 addReply(c,shared.ok);
8027 }
8028
8029 /* Send a MULTI command to all the slaves and AOF file. Check the execCommand
8030 * implememntation for more information. */
8031 static void execCommandReplicateMulti(redisClient *c) {
8032 struct redisCommand *cmd;
8033 robj *multistring = createStringObject("MULTI",5);
8034
8035 cmd = lookupCommand("multi");
8036 if (server.appendonly)
8037 feedAppendOnlyFile(cmd,c->db->id,&multistring,1);
8038 if (listLength(server.slaves))
8039 replicationFeedSlaves(server.slaves,c->db->id,&multistring,1);
8040 decrRefCount(multistring);
8041 }
8042
8043 static void execCommand(redisClient *c) {
8044 int j;
8045 robj **orig_argv;
8046 int orig_argc;
8047
8048 if (!(c->flags & REDIS_MULTI)) {
8049 addReplySds(c,sdsnew("-ERR EXEC without MULTI\r\n"));
8050 return;
8051 }
8052
8053 /* Check if we need to abort the EXEC if some WATCHed key was touched.
8054 * A failed EXEC will return a multi bulk nil object. */
8055 if (c->flags & REDIS_DIRTY_CAS) {
8056 freeClientMultiState(c);
8057 initClientMultiState(c);
8058 c->flags &= ~(REDIS_MULTI|REDIS_DIRTY_CAS);
8059 unwatchAllKeys(c);
8060 addReply(c,shared.nullmultibulk);
8061 return;
8062 }
8063
8064 /* Replicate a MULTI request now that we are sure the block is executed.
8065 * This way we'll deliver the MULTI/..../EXEC block as a whole and
8066 * both the AOF and the replication link will have the same consistency
8067 * and atomicity guarantees. */
8068 execCommandReplicateMulti(c);
8069
8070 /* Exec all the queued commands */
8071 unwatchAllKeys(c); /* Unwatch ASAP otherwise we'll waste CPU cycles */
8072 orig_argv = c->argv;
8073 orig_argc = c->argc;
8074 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",c->mstate.count));
8075 for (j = 0; j < c->mstate.count; j++) {
8076 c->argc = c->mstate.commands[j].argc;
8077 c->argv = c->mstate.commands[j].argv;
8078 call(c,c->mstate.commands[j].cmd);
8079 }
8080 c->argv = orig_argv;
8081 c->argc = orig_argc;
8082 freeClientMultiState(c);
8083 initClientMultiState(c);
8084 c->flags &= ~(REDIS_MULTI|REDIS_DIRTY_CAS);
8085 /* Make sure the EXEC command is always replicated / AOF, since we
8086 * always send the MULTI command (we can't know beforehand if the
8087 * next operations will contain at least a modification to the DB). */
8088 server.dirty++;
8089 }
8090
8091 /* =========================== Blocking Operations ========================= */
8092
8093 /* Currently Redis blocking operations support is limited to list POP ops,
8094 * so the current implementation is not fully generic, but it is also not
8095 * completely specific so it will not require a rewrite to support new
8096 * kind of blocking operations in the future.
8097 *
8098 * Still it's important to note that list blocking operations can be already
8099 * used as a notification mechanism in order to implement other blocking
8100 * operations at application level, so there must be a very strong evidence
8101 * of usefulness and generality before new blocking operations are implemented.
8102 *
8103 * This is how the current blocking POP works, we use BLPOP as example:
8104 * - If the user calls BLPOP and the key exists and contains a non empty list
8105 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
8106 * if there is not to block.
8107 * - If instead BLPOP is called and the key does not exists or the list is
8108 * empty we need to block. In order to do so we remove the notification for
8109 * new data to read in the client socket (so that we'll not serve new
8110 * requests if the blocking request is not served). Also we put the client
8111 * in a dictionary (db->blocking_keys) mapping keys to a list of clients
8112 * blocking for this keys.
8113 * - If a PUSH operation against a key with blocked clients waiting is
8114 * performed, we serve the first in the list: basically instead to push
8115 * the new element inside the list we return it to the (first / oldest)
8116 * blocking client, unblock the client, and remove it form the list.
8117 *
8118 * The above comment and the source code should be enough in order to understand
8119 * the implementation and modify / fix it later.
8120 */
8121
8122 /* Set a client in blocking mode for the specified key, with the specified
8123 * timeout */
8124 static void blockForKeys(redisClient *c, robj **keys, int numkeys, time_t timeout) {
8125 dictEntry *de;
8126 list *l;
8127 int j;
8128
8129 c->blocking_keys = zmalloc(sizeof(robj*)*numkeys);
8130 c->blocking_keys_num = numkeys;
8131 c->blockingto = timeout;
8132 for (j = 0; j < numkeys; j++) {
8133 /* Add the key in the client structure, to map clients -> keys */
8134 c->blocking_keys[j] = keys[j];
8135 incrRefCount(keys[j]);
8136
8137 /* And in the other "side", to map keys -> clients */
8138 de = dictFind(c->db->blocking_keys,keys[j]);
8139 if (de == NULL) {
8140 int retval;
8141
8142 /* For every key we take a list of clients blocked for it */
8143 l = listCreate();
8144 retval = dictAdd(c->db->blocking_keys,keys[j],l);
8145 incrRefCount(keys[j]);
8146 assert(retval == DICT_OK);
8147 } else {
8148 l = dictGetEntryVal(de);
8149 }
8150 listAddNodeTail(l,c);
8151 }
8152 /* Mark the client as a blocked client */
8153 c->flags |= REDIS_BLOCKED;
8154 server.blpop_blocked_clients++;
8155 }
8156
8157 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
8158 static void unblockClientWaitingData(redisClient *c) {
8159 dictEntry *de;
8160 list *l;
8161 int j;
8162
8163 assert(c->blocking_keys != NULL);
8164 /* The client may wait for multiple keys, so unblock it for every key. */
8165 for (j = 0; j < c->blocking_keys_num; j++) {
8166 /* Remove this client from the list of clients waiting for this key. */
8167 de = dictFind(c->db->blocking_keys,c->blocking_keys[j]);
8168 assert(de != NULL);
8169 l = dictGetEntryVal(de);
8170 listDelNode(l,listSearchKey(l,c));
8171 /* If the list is empty we need to remove it to avoid wasting memory */
8172 if (listLength(l) == 0)
8173 dictDelete(c->db->blocking_keys,c->blocking_keys[j]);
8174 decrRefCount(c->blocking_keys[j]);
8175 }
8176 /* Cleanup the client structure */
8177 zfree(c->blocking_keys);
8178 c->blocking_keys = NULL;
8179 c->flags &= (~REDIS_BLOCKED);
8180 server.blpop_blocked_clients--;
8181 /* We want to process data if there is some command waiting
8182 * in the input buffer. Note that this is safe even if
8183 * unblockClientWaitingData() gets called from freeClient() because
8184 * freeClient() will be smart enough to call this function
8185 * *after* c->querybuf was set to NULL. */
8186 if (c->querybuf && sdslen(c->querybuf) > 0) processInputBuffer(c);
8187 }
8188
8189 /* This should be called from any function PUSHing into lists.
8190 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
8191 * 'ele' is the element pushed.
8192 *
8193 * If the function returns 0 there was no client waiting for a list push
8194 * against this key.
8195 *
8196 * If the function returns 1 there was a client waiting for a list push
8197 * against this key, the element was passed to this client thus it's not
8198 * needed to actually add it to the list and the caller should return asap. */
8199 static int handleClientsWaitingListPush(redisClient *c, robj *key, robj *ele) {
8200 struct dictEntry *de;
8201 redisClient *receiver;
8202 list *l;
8203 listNode *ln;
8204
8205 de = dictFind(c->db->blocking_keys,key);
8206 if (de == NULL) return 0;
8207 l = dictGetEntryVal(de);
8208 ln = listFirst(l);
8209 assert(ln != NULL);
8210 receiver = ln->value;
8211
8212 addReplySds(receiver,sdsnew("*2\r\n"));
8213 addReplyBulk(receiver,key);
8214 addReplyBulk(receiver,ele);
8215 unblockClientWaitingData(receiver);
8216 return 1;
8217 }
8218
8219 /* Blocking RPOP/LPOP */
8220 static void blockingPopGenericCommand(redisClient *c, int where) {
8221 robj *o;
8222 time_t timeout;
8223 int j;
8224
8225 for (j = 1; j < c->argc-1; j++) {
8226 o = lookupKeyWrite(c->db,c->argv[j]);
8227 if (o != NULL) {
8228 if (o->type != REDIS_LIST) {
8229 addReply(c,shared.wrongtypeerr);
8230 return;
8231 } else {
8232 list *list = o->ptr;
8233 if (listLength(list) != 0) {
8234 /* If the list contains elements fall back to the usual
8235 * non-blocking POP operation */
8236 robj *argv[2], **orig_argv;
8237 int orig_argc;
8238
8239 /* We need to alter the command arguments before to call
8240 * popGenericCommand() as the command takes a single key. */
8241 orig_argv = c->argv;
8242 orig_argc = c->argc;
8243 argv[1] = c->argv[j];
8244 c->argv = argv;
8245 c->argc = 2;
8246
8247 /* Also the return value is different, we need to output
8248 * the multi bulk reply header and the key name. The
8249 * "real" command will add the last element (the value)
8250 * for us. If this souds like an hack to you it's just
8251 * because it is... */
8252 addReplySds(c,sdsnew("*2\r\n"));
8253 addReplyBulk(c,argv[1]);
8254 popGenericCommand(c,where);
8255
8256 /* Fix the client structure with the original stuff */
8257 c->argv = orig_argv;
8258 c->argc = orig_argc;
8259 return;
8260 }
8261 }
8262 }
8263 }
8264 /* If the list is empty or the key does not exists we must block */
8265 timeout = strtol(c->argv[c->argc-1]->ptr,NULL,10);
8266 if (timeout > 0) timeout += time(NULL);
8267 blockForKeys(c,c->argv+1,c->argc-2,timeout);
8268 }
8269
8270 static void blpopCommand(redisClient *c) {
8271 blockingPopGenericCommand(c,REDIS_HEAD);
8272 }
8273
8274 static void brpopCommand(redisClient *c) {
8275 blockingPopGenericCommand(c,REDIS_TAIL);
8276 }
8277
8278 /* =============================== Replication ============================= */
8279
8280 static int syncWrite(int fd, char *ptr, ssize_t size, int timeout) {
8281 ssize_t nwritten, ret = size;
8282 time_t start = time(NULL);
8283
8284 timeout++;
8285 while(size) {
8286 if (aeWait(fd,AE_WRITABLE,1000) & AE_WRITABLE) {
8287 nwritten = write(fd,ptr,size);
8288 if (nwritten == -1) return -1;
8289 ptr += nwritten;
8290 size -= nwritten;
8291 }
8292 if ((time(NULL)-start) > timeout) {
8293 errno = ETIMEDOUT;
8294 return -1;
8295 }
8296 }
8297 return ret;
8298 }
8299
8300 static int syncRead(int fd, char *ptr, ssize_t size, int timeout) {
8301 ssize_t nread, totread = 0;
8302 time_t start = time(NULL);
8303
8304 timeout++;
8305 while(size) {
8306 if (aeWait(fd,AE_READABLE,1000) & AE_READABLE) {
8307 nread = read(fd,ptr,size);
8308 if (nread == -1) return -1;
8309 ptr += nread;
8310 size -= nread;
8311 totread += nread;
8312 }
8313 if ((time(NULL)-start) > timeout) {
8314 errno = ETIMEDOUT;
8315 return -1;
8316 }
8317 }
8318 return totread;
8319 }
8320
8321 static int syncReadLine(int fd, char *ptr, ssize_t size, int timeout) {
8322 ssize_t nread = 0;
8323
8324 size--;
8325 while(size) {
8326 char c;
8327
8328 if (syncRead(fd,&c,1,timeout) == -1) return -1;
8329 if (c == '\n') {
8330 *ptr = '\0';
8331 if (nread && *(ptr-1) == '\r') *(ptr-1) = '\0';
8332 return nread;
8333 } else {
8334 *ptr++ = c;
8335 *ptr = '\0';
8336 nread++;
8337 }
8338 }
8339 return nread;
8340 }
8341
8342 static void syncCommand(redisClient *c) {
8343 /* ignore SYNC if aleady slave or in monitor mode */
8344 if (c->flags & REDIS_SLAVE) return;
8345
8346 /* SYNC can't be issued when the server has pending data to send to
8347 * the client about already issued commands. We need a fresh reply
8348 * buffer registering the differences between the BGSAVE and the current
8349 * dataset, so that we can copy to other slaves if needed. */
8350 if (listLength(c->reply) != 0) {
8351 addReplySds(c,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
8352 return;
8353 }
8354
8355 redisLog(REDIS_NOTICE,"Slave ask for synchronization");
8356 /* Here we need to check if there is a background saving operation
8357 * in progress, or if it is required to start one */
8358 if (server.bgsavechildpid != -1) {
8359 /* Ok a background save is in progress. Let's check if it is a good
8360 * one for replication, i.e. if there is another slave that is
8361 * registering differences since the server forked to save */
8362 redisClient *slave;
8363 listNode *ln;
8364 listIter li;
8365
8366 listRewind(server.slaves,&li);
8367 while((ln = listNext(&li))) {
8368 slave = ln->value;
8369 if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_END) break;
8370 }
8371 if (ln) {
8372 /* Perfect, the server is already registering differences for
8373 * another slave. Set the right state, and copy the buffer. */
8374 listRelease(c->reply);
8375 c->reply = listDup(slave->reply);
8376 c->replstate = REDIS_REPL_WAIT_BGSAVE_END;
8377 redisLog(REDIS_NOTICE,"Waiting for end of BGSAVE for SYNC");
8378 } else {
8379 /* No way, we need to wait for the next BGSAVE in order to
8380 * register differences */
8381 c->replstate = REDIS_REPL_WAIT_BGSAVE_START;
8382 redisLog(REDIS_NOTICE,"Waiting for next BGSAVE for SYNC");
8383 }
8384 } else {
8385 /* Ok we don't have a BGSAVE in progress, let's start one */
8386 redisLog(REDIS_NOTICE,"Starting BGSAVE for SYNC");
8387 if (rdbSaveBackground(server.dbfilename) != REDIS_OK) {
8388 redisLog(REDIS_NOTICE,"Replication failed, can't BGSAVE");
8389 addReplySds(c,sdsnew("-ERR Unalbe to perform background save\r\n"));
8390 return;
8391 }
8392 c->replstate = REDIS_REPL_WAIT_BGSAVE_END;
8393 }
8394 c->repldbfd = -1;
8395 c->flags |= REDIS_SLAVE;
8396 c->slaveseldb = 0;
8397 listAddNodeTail(server.slaves,c);
8398 return;
8399 }
8400
8401 static void sendBulkToSlave(aeEventLoop *el, int fd, void *privdata, int mask) {
8402 redisClient *slave = privdata;
8403 REDIS_NOTUSED(el);
8404 REDIS_NOTUSED(mask);
8405 char buf[REDIS_IOBUF_LEN];
8406 ssize_t nwritten, buflen;
8407
8408 if (slave->repldboff == 0) {
8409 /* Write the bulk write count before to transfer the DB. In theory here
8410 * we don't know how much room there is in the output buffer of the
8411 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
8412 * operations) will never be smaller than the few bytes we need. */
8413 sds bulkcount;
8414
8415 bulkcount = sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
8416 slave->repldbsize);
8417 if (write(fd,bulkcount,sdslen(bulkcount)) != (signed)sdslen(bulkcount))
8418 {
8419 sdsfree(bulkcount);
8420 freeClient(slave);
8421 return;
8422 }
8423 sdsfree(bulkcount);
8424 }
8425 lseek(slave->repldbfd,slave->repldboff,SEEK_SET);
8426 buflen = read(slave->repldbfd,buf,REDIS_IOBUF_LEN);
8427 if (buflen <= 0) {
8428 redisLog(REDIS_WARNING,"Read error sending DB to slave: %s",
8429 (buflen == 0) ? "premature EOF" : strerror(errno));
8430 freeClient(slave);
8431 return;
8432 }
8433 if ((nwritten = write(fd,buf,buflen)) == -1) {
8434 redisLog(REDIS_VERBOSE,"Write error sending DB to slave: %s",
8435 strerror(errno));
8436 freeClient(slave);
8437 return;
8438 }
8439 slave->repldboff += nwritten;
8440 if (slave->repldboff == slave->repldbsize) {
8441 close(slave->repldbfd);
8442 slave->repldbfd = -1;
8443 aeDeleteFileEvent(server.el,slave->fd,AE_WRITABLE);
8444 slave->replstate = REDIS_REPL_ONLINE;
8445 if (aeCreateFileEvent(server.el, slave->fd, AE_WRITABLE,
8446 sendReplyToClient, slave) == AE_ERR) {
8447 freeClient(slave);
8448 return;
8449 }
8450 addReplySds(slave,sdsempty());
8451 redisLog(REDIS_NOTICE,"Synchronization with slave succeeded");
8452 }
8453 }
8454
8455 /* This function is called at the end of every backgrond saving.
8456 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
8457 * otherwise REDIS_ERR is passed to the function.
8458 *
8459 * The goal of this function is to handle slaves waiting for a successful
8460 * background saving in order to perform non-blocking synchronization. */
8461 static void updateSlavesWaitingBgsave(int bgsaveerr) {
8462 listNode *ln;
8463 int startbgsave = 0;
8464 listIter li;
8465
8466 listRewind(server.slaves,&li);
8467 while((ln = listNext(&li))) {
8468 redisClient *slave = ln->value;
8469
8470 if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_START) {
8471 startbgsave = 1;
8472 slave->replstate = REDIS_REPL_WAIT_BGSAVE_END;
8473 } else if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_END) {
8474 struct redis_stat buf;
8475
8476 if (bgsaveerr != REDIS_OK) {
8477 freeClient(slave);
8478 redisLog(REDIS_WARNING,"SYNC failed. BGSAVE child returned an error");
8479 continue;
8480 }
8481 if ((slave->repldbfd = open(server.dbfilename,O_RDONLY)) == -1 ||
8482 redis_fstat(slave->repldbfd,&buf) == -1) {
8483 freeClient(slave);
8484 redisLog(REDIS_WARNING,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno));
8485 continue;
8486 }
8487 slave->repldboff = 0;
8488 slave->repldbsize = buf.st_size;
8489 slave->replstate = REDIS_REPL_SEND_BULK;
8490 aeDeleteFileEvent(server.el,slave->fd,AE_WRITABLE);
8491 if (aeCreateFileEvent(server.el, slave->fd, AE_WRITABLE, sendBulkToSlave, slave) == AE_ERR) {
8492 freeClient(slave);
8493 continue;
8494 }
8495 }
8496 }
8497 if (startbgsave) {
8498 if (rdbSaveBackground(server.dbfilename) != REDIS_OK) {
8499 listIter li;
8500
8501 listRewind(server.slaves,&li);
8502 redisLog(REDIS_WARNING,"SYNC failed. BGSAVE failed");
8503 while((ln = listNext(&li))) {
8504 redisClient *slave = ln->value;
8505
8506 if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_START)
8507 freeClient(slave);
8508 }
8509 }
8510 }
8511 }
8512
8513 static int syncWithMaster(void) {
8514 char buf[1024], tmpfile[256], authcmd[1024];
8515 long dumpsize;
8516 int fd = anetTcpConnect(NULL,server.masterhost,server.masterport);
8517 int dfd, maxtries = 5;
8518
8519 if (fd == -1) {
8520 redisLog(REDIS_WARNING,"Unable to connect to MASTER: %s",
8521 strerror(errno));
8522 return REDIS_ERR;
8523 }
8524
8525 /* AUTH with the master if required. */
8526 if(server.masterauth) {
8527 snprintf(authcmd, 1024, "AUTH %s\r\n", server.masterauth);
8528 if (syncWrite(fd, authcmd, strlen(server.masterauth)+7, 5) == -1) {
8529 close(fd);
8530 redisLog(REDIS_WARNING,"Unable to AUTH to MASTER: %s",
8531 strerror(errno));
8532 return REDIS_ERR;
8533 }
8534 /* Read the AUTH result. */
8535 if (syncReadLine(fd,buf,1024,3600) == -1) {
8536 close(fd);
8537 redisLog(REDIS_WARNING,"I/O error reading auth result from MASTER: %s",
8538 strerror(errno));
8539 return REDIS_ERR;
8540 }
8541 if (buf[0] != '+') {
8542 close(fd);
8543 redisLog(REDIS_WARNING,"Cannot AUTH to MASTER, is the masterauth password correct?");
8544 return REDIS_ERR;
8545 }
8546 }
8547
8548 /* Issue the SYNC command */
8549 if (syncWrite(fd,"SYNC \r\n",7,5) == -1) {
8550 close(fd);
8551 redisLog(REDIS_WARNING,"I/O error writing to MASTER: %s",
8552 strerror(errno));
8553 return REDIS_ERR;
8554 }
8555 /* Read the bulk write count */
8556 if (syncReadLine(fd,buf,1024,3600) == -1) {
8557 close(fd);
8558 redisLog(REDIS_WARNING,"I/O error reading bulk count from MASTER: %s",
8559 strerror(errno));
8560 return REDIS_ERR;
8561 }
8562 if (buf[0] != '$') {
8563 close(fd);
8564 redisLog(REDIS_WARNING,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
8565 return REDIS_ERR;
8566 }
8567 dumpsize = strtol(buf+1,NULL,10);
8568 redisLog(REDIS_NOTICE,"Receiving %ld bytes data dump from MASTER",dumpsize);
8569 /* Read the bulk write data on a temp file */
8570 while(maxtries--) {
8571 snprintf(tmpfile,256,
8572 "temp-%d.%ld.rdb",(int)time(NULL),(long int)getpid());
8573 dfd = open(tmpfile,O_CREAT|O_WRONLY|O_EXCL,0644);
8574 if (dfd != -1) break;
8575 sleep(1);
8576 }
8577 if (dfd == -1) {
8578 close(fd);
8579 redisLog(REDIS_WARNING,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno));
8580 return REDIS_ERR;
8581 }
8582 while(dumpsize) {
8583 int nread, nwritten;
8584
8585 nread = read(fd,buf,(dumpsize < 1024)?dumpsize:1024);
8586 if (nread == -1) {
8587 redisLog(REDIS_WARNING,"I/O error trying to sync with MASTER: %s",
8588 strerror(errno));
8589 close(fd);
8590 close(dfd);
8591 return REDIS_ERR;
8592 }
8593 nwritten = write(dfd,buf,nread);
8594 if (nwritten == -1) {
8595 redisLog(REDIS_WARNING,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno));
8596 close(fd);
8597 close(dfd);
8598 return REDIS_ERR;
8599 }
8600 dumpsize -= nread;
8601 }
8602 close(dfd);
8603 if (rename(tmpfile,server.dbfilename) == -1) {
8604 redisLog(REDIS_WARNING,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno));
8605 unlink(tmpfile);
8606 close(fd);
8607 return REDIS_ERR;
8608 }
8609 emptyDb();
8610 if (rdbLoad(server.dbfilename) != REDIS_OK) {
8611 redisLog(REDIS_WARNING,"Failed trying to load the MASTER synchronization DB from disk");
8612 close(fd);
8613 return REDIS_ERR;
8614 }
8615 server.master = createClient(fd);
8616 server.master->flags |= REDIS_MASTER;
8617 server.master->authenticated = 1;
8618 server.replstate = REDIS_REPL_CONNECTED;
8619 return REDIS_OK;
8620 }
8621
8622 static void slaveofCommand(redisClient *c) {
8623 if (!strcasecmp(c->argv[1]->ptr,"no") &&
8624 !strcasecmp(c->argv[2]->ptr,"one")) {
8625 if (server.masterhost) {
8626 sdsfree(server.masterhost);
8627 server.masterhost = NULL;
8628 if (server.master) freeClient(server.master);
8629 server.replstate = REDIS_REPL_NONE;
8630 redisLog(REDIS_NOTICE,"MASTER MODE enabled (user request)");
8631 }
8632 } else {
8633 sdsfree(server.masterhost);
8634 server.masterhost = sdsdup(c->argv[1]->ptr);
8635 server.masterport = atoi(c->argv[2]->ptr);
8636 if (server.master) freeClient(server.master);
8637 server.replstate = REDIS_REPL_CONNECT;
8638 redisLog(REDIS_NOTICE,"SLAVE OF %s:%d enabled (user request)",
8639 server.masterhost, server.masterport);
8640 }
8641 addReply(c,shared.ok);
8642 }
8643
8644 /* ============================ Maxmemory directive ======================== */
8645
8646 /* Try to free one object form the pre-allocated objects free list.
8647 * This is useful under low mem conditions as by default we take 1 million
8648 * free objects allocated. On success REDIS_OK is returned, otherwise
8649 * REDIS_ERR. */
8650 static int tryFreeOneObjectFromFreelist(void) {
8651 robj *o;
8652
8653 if (server.vm_enabled) pthread_mutex_lock(&server.obj_freelist_mutex);
8654 if (listLength(server.objfreelist)) {
8655 listNode *head = listFirst(server.objfreelist);
8656 o = listNodeValue(head);
8657 listDelNode(server.objfreelist,head);
8658 if (server.vm_enabled) pthread_mutex_unlock(&server.obj_freelist_mutex);
8659 zfree(o);
8660 return REDIS_OK;
8661 } else {
8662 if (server.vm_enabled) pthread_mutex_unlock(&server.obj_freelist_mutex);
8663 return REDIS_ERR;
8664 }
8665 }
8666
8667 /* This function gets called when 'maxmemory' is set on the config file to limit
8668 * the max memory used by the server, and we are out of memory.
8669 * This function will try to, in order:
8670 *
8671 * - Free objects from the free list
8672 * - Try to remove keys with an EXPIRE set
8673 *
8674 * It is not possible to free enough memory to reach used-memory < maxmemory
8675 * the server will start refusing commands that will enlarge even more the
8676 * memory usage.
8677 */
8678 static void freeMemoryIfNeeded(void) {
8679 while (server.maxmemory && zmalloc_used_memory() > server.maxmemory) {
8680 int j, k, freed = 0;
8681
8682 if (tryFreeOneObjectFromFreelist() == REDIS_OK) continue;
8683 for (j = 0; j < server.dbnum; j++) {
8684 int minttl = -1;
8685 robj *minkey = NULL;
8686 struct dictEntry *de;
8687
8688 if (dictSize(server.db[j].expires)) {
8689 freed = 1;
8690 /* From a sample of three keys drop the one nearest to
8691 * the natural expire */
8692 for (k = 0; k < 3; k++) {
8693 time_t t;
8694
8695 de = dictGetRandomKey(server.db[j].expires);
8696 t = (time_t) dictGetEntryVal(de);
8697 if (minttl == -1 || t < minttl) {
8698 minkey = dictGetEntryKey(de);
8699 minttl = t;
8700 }
8701 }
8702 dbDelete(server.db+j,minkey);
8703 }
8704 }
8705 if (!freed) return; /* nothing to free... */
8706 }
8707 }
8708
8709 /* ============================== Append Only file ========================== */
8710
8711 /* Called when the user switches from "appendonly yes" to "appendonly no"
8712 * at runtime using the CONFIG command. */
8713 static void stopAppendOnly(void) {
8714 flushAppendOnlyFile();
8715 aof_fsync(server.appendfd);
8716 close(server.appendfd);
8717
8718 server.appendfd = -1;
8719 server.appendseldb = -1;
8720 server.appendonly = 0;
8721 /* rewrite operation in progress? kill it, wait child exit */
8722 if (server.bgsavechildpid != -1) {
8723 int statloc;
8724
8725 if (kill(server.bgsavechildpid,SIGKILL) != -1)
8726 wait3(&statloc,0,NULL);
8727 /* reset the buffer accumulating changes while the child saves */
8728 sdsfree(server.bgrewritebuf);
8729 server.bgrewritebuf = sdsempty();
8730 server.bgsavechildpid = -1;
8731 }
8732 }
8733
8734 /* Called when the user switches from "appendonly no" to "appendonly yes"
8735 * at runtime using the CONFIG command. */
8736 static int startAppendOnly(void) {
8737 server.appendonly = 1;
8738 server.lastfsync = time(NULL);
8739 server.appendfd = open(server.appendfilename,O_WRONLY|O_APPEND|O_CREAT,0644);
8740 if (server.appendfd == -1) {
8741 redisLog(REDIS_WARNING,"Used tried to switch on AOF via CONFIG, but I can't open the AOF file: %s",strerror(errno));
8742 return REDIS_ERR;
8743 }
8744 if (rewriteAppendOnlyFileBackground() == REDIS_ERR) {
8745 server.appendonly = 0;
8746 close(server.appendfd);
8747 redisLog(REDIS_WARNING,"Used tried to switch on AOF via CONFIG, I can't trigger a background AOF rewrite operation. Check the above logs for more info about the error.",strerror(errno));
8748 return REDIS_ERR;
8749 }
8750 return REDIS_OK;
8751 }
8752
8753 /* Write the append only file buffer on disk.
8754 *
8755 * Since we are required to write the AOF before replying to the client,
8756 * and the only way the client socket can get a write is entering when the
8757 * the event loop, we accumulate all the AOF writes in a memory
8758 * buffer and write it on disk using this function just before entering
8759 * the event loop again. */
8760 static void flushAppendOnlyFile(void) {
8761 time_t now;
8762 ssize_t nwritten;
8763
8764 if (sdslen(server.aofbuf) == 0) return;
8765
8766 /* We want to perform a single write. This should be guaranteed atomic
8767 * at least if the filesystem we are writing is a real physical one.
8768 * While this will save us against the server being killed I don't think
8769 * there is much to do about the whole server stopping for power problems
8770 * or alike */
8771 nwritten = write(server.appendfd,server.aofbuf,sdslen(server.aofbuf));
8772 if (nwritten != (signed)sdslen(server.aofbuf)) {
8773 /* Ooops, we are in troubles. The best thing to do for now is
8774 * aborting instead of giving the illusion that everything is
8775 * working as expected. */
8776 if (nwritten == -1) {
8777 redisLog(REDIS_WARNING,"Exiting on error writing to the append-only file: %s",strerror(errno));
8778 } else {
8779 redisLog(REDIS_WARNING,"Exiting on short write while writing to the append-only file: %s",strerror(errno));
8780 }
8781 exit(1);
8782 }
8783 sdsfree(server.aofbuf);
8784 server.aofbuf = sdsempty();
8785
8786 /* Don't Fsync if no-appendfsync-on-rewrite is set to yes and we have
8787 * childs performing heavy I/O on disk. */
8788 if (server.no_appendfsync_on_rewrite &&
8789 (server.bgrewritechildpid != -1 || server.bgsavechildpid != -1))
8790 return;
8791 /* Fsync if needed */
8792 now = time(NULL);
8793 if (server.appendfsync == APPENDFSYNC_ALWAYS ||
8794 (server.appendfsync == APPENDFSYNC_EVERYSEC &&
8795 now-server.lastfsync > 1))
8796 {
8797 /* aof_fsync is defined as fdatasync() for Linux in order to avoid
8798 * flushing metadata. */
8799 aof_fsync(server.appendfd); /* Let's try to get this data on the disk */
8800 server.lastfsync = now;
8801 }
8802 }
8803
8804 static sds catAppendOnlyGenericCommand(sds buf, int argc, robj **argv) {
8805 int j;
8806 buf = sdscatprintf(buf,"*%d\r\n",argc);
8807 for (j = 0; j < argc; j++) {
8808 robj *o = getDecodedObject(argv[j]);
8809 buf = sdscatprintf(buf,"$%lu\r\n",(unsigned long)sdslen(o->ptr));
8810 buf = sdscatlen(buf,o->ptr,sdslen(o->ptr));
8811 buf = sdscatlen(buf,"\r\n",2);
8812 decrRefCount(o);
8813 }
8814 return buf;
8815 }
8816
8817 static sds catAppendOnlyExpireAtCommand(sds buf, robj *key, robj *seconds) {
8818 int argc = 3;
8819 long when;
8820 robj *argv[3];
8821
8822 /* Make sure we can use strtol */
8823 seconds = getDecodedObject(seconds);
8824 when = time(NULL)+strtol(seconds->ptr,NULL,10);
8825 decrRefCount(seconds);
8826
8827 argv[0] = createStringObject("EXPIREAT",8);
8828 argv[1] = key;
8829 argv[2] = createObject(REDIS_STRING,
8830 sdscatprintf(sdsempty(),"%ld",when));
8831 buf = catAppendOnlyGenericCommand(buf, argc, argv);
8832 decrRefCount(argv[0]);
8833 decrRefCount(argv[2]);
8834 return buf;
8835 }
8836
8837 static void feedAppendOnlyFile(struct redisCommand *cmd, int dictid, robj **argv, int argc) {
8838 sds buf = sdsempty();
8839 robj *tmpargv[3];
8840
8841 /* The DB this command was targetting is not the same as the last command
8842 * we appendend. To issue a SELECT command is needed. */
8843 if (dictid != server.appendseldb) {
8844 char seldb[64];
8845
8846 snprintf(seldb,sizeof(seldb),"%d",dictid);
8847 buf = sdscatprintf(buf,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
8848 (unsigned long)strlen(seldb),seldb);
8849 server.appendseldb = dictid;
8850 }
8851
8852 if (cmd->proc == expireCommand) {
8853 /* Translate EXPIRE into EXPIREAT */
8854 buf = catAppendOnlyExpireAtCommand(buf,argv[1],argv[2]);
8855 } else if (cmd->proc == setexCommand) {
8856 /* Translate SETEX to SET and EXPIREAT */
8857 tmpargv[0] = createStringObject("SET",3);
8858 tmpargv[1] = argv[1];
8859 tmpargv[2] = argv[3];
8860 buf = catAppendOnlyGenericCommand(buf,3,tmpargv);
8861 decrRefCount(tmpargv[0]);
8862 buf = catAppendOnlyExpireAtCommand(buf,argv[1],argv[2]);
8863 } else {
8864 buf = catAppendOnlyGenericCommand(buf,argc,argv);
8865 }
8866
8867 /* Append to the AOF buffer. This will be flushed on disk just before
8868 * of re-entering the event loop, so before the client will get a
8869 * positive reply about the operation performed. */
8870 server.aofbuf = sdscatlen(server.aofbuf,buf,sdslen(buf));
8871
8872 /* If a background append only file rewriting is in progress we want to
8873 * accumulate the differences between the child DB and the current one
8874 * in a buffer, so that when the child process will do its work we
8875 * can append the differences to the new append only file. */
8876 if (server.bgrewritechildpid != -1)
8877 server.bgrewritebuf = sdscatlen(server.bgrewritebuf,buf,sdslen(buf));
8878
8879 sdsfree(buf);
8880 }
8881
8882 /* In Redis commands are always executed in the context of a client, so in
8883 * order to load the append only file we need to create a fake client. */
8884 static struct redisClient *createFakeClient(void) {
8885 struct redisClient *c = zmalloc(sizeof(*c));
8886
8887 selectDb(c,0);
8888 c->fd = -1;
8889 c->querybuf = sdsempty();
8890 c->argc = 0;
8891 c->argv = NULL;
8892 c->flags = 0;
8893 /* We set the fake client as a slave waiting for the synchronization
8894 * so that Redis will not try to send replies to this client. */
8895 c->replstate = REDIS_REPL_WAIT_BGSAVE_START;
8896 c->reply = listCreate();
8897 listSetFreeMethod(c->reply,decrRefCount);
8898 listSetDupMethod(c->reply,dupClientReplyValue);
8899 initClientMultiState(c);
8900 return c;
8901 }
8902
8903 static void freeFakeClient(struct redisClient *c) {
8904 sdsfree(c->querybuf);
8905 listRelease(c->reply);
8906 freeClientMultiState(c);
8907 zfree(c);
8908 }
8909
8910 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
8911 * error (the append only file is zero-length) REDIS_ERR is returned. On
8912 * fatal error an error message is logged and the program exists. */
8913 int loadAppendOnlyFile(char *filename) {
8914 struct redisClient *fakeClient;
8915 FILE *fp = fopen(filename,"r");
8916 struct redis_stat sb;
8917 int appendonly = server.appendonly;
8918
8919 if (redis_fstat(fileno(fp),&sb) != -1 && sb.st_size == 0)
8920 return REDIS_ERR;
8921
8922 if (fp == NULL) {
8923 redisLog(REDIS_WARNING,"Fatal error: can't open the append log file for reading: %s",strerror(errno));
8924 exit(1);
8925 }
8926
8927 /* Temporarily disable AOF, to prevent EXEC from feeding a MULTI
8928 * to the same file we're about to read. */
8929 server.appendonly = 0;
8930
8931 fakeClient = createFakeClient();
8932 while(1) {
8933 int argc, j;
8934 unsigned long len;
8935 robj **argv;
8936 char buf[128];
8937 sds argsds;
8938 struct redisCommand *cmd;
8939 int force_swapout;
8940
8941 if (fgets(buf,sizeof(buf),fp) == NULL) {
8942 if (feof(fp))
8943 break;
8944 else
8945 goto readerr;
8946 }
8947 if (buf[0] != '*') goto fmterr;
8948 argc = atoi(buf+1);
8949 argv = zmalloc(sizeof(robj*)*argc);
8950 for (j = 0; j < argc; j++) {
8951 if (fgets(buf,sizeof(buf),fp) == NULL) goto readerr;
8952 if (buf[0] != '$') goto fmterr;
8953 len = strtol(buf+1,NULL,10);
8954 argsds = sdsnewlen(NULL,len);
8955 if (len && fread(argsds,len,1,fp) == 0) goto fmterr;
8956 argv[j] = createObject(REDIS_STRING,argsds);
8957 if (fread(buf,2,1,fp) == 0) goto fmterr; /* discard CRLF */
8958 }
8959
8960 /* Command lookup */
8961 cmd = lookupCommand(argv[0]->ptr);
8962 if (!cmd) {
8963 redisLog(REDIS_WARNING,"Unknown command '%s' reading the append only file", argv[0]->ptr);
8964 exit(1);
8965 }
8966 /* Try object encoding */
8967 if (cmd->flags & REDIS_CMD_BULK)
8968 argv[argc-1] = tryObjectEncoding(argv[argc-1]);
8969 /* Run the command in the context of a fake client */
8970 fakeClient->argc = argc;
8971 fakeClient->argv = argv;
8972 cmd->proc(fakeClient);
8973 /* Discard the reply objects list from the fake client */
8974 while(listLength(fakeClient->reply))
8975 listDelNode(fakeClient->reply,listFirst(fakeClient->reply));
8976 /* Clean up, ready for the next command */
8977 for (j = 0; j < argc; j++) decrRefCount(argv[j]);
8978 zfree(argv);
8979 /* Handle swapping while loading big datasets when VM is on */
8980 force_swapout = 0;
8981 if ((zmalloc_used_memory() - server.vm_max_memory) > 1024*1024*32)
8982 force_swapout = 1;
8983
8984 if (server.vm_enabled && force_swapout) {
8985 while (zmalloc_used_memory() > server.vm_max_memory) {
8986 if (vmSwapOneObjectBlocking() == REDIS_ERR) break;
8987 }
8988 }
8989 }
8990
8991 /* This point can only be reached when EOF is reached without errors.
8992 * If the client is in the middle of a MULTI/EXEC, log error and quit. */
8993 if (fakeClient->flags & REDIS_MULTI) goto readerr;
8994
8995 fclose(fp);
8996 freeFakeClient(fakeClient);
8997 server.appendonly = appendonly;
8998 return REDIS_OK;
8999
9000 readerr:
9001 if (feof(fp)) {
9002 redisLog(REDIS_WARNING,"Unexpected end of file reading the append only file");
9003 } else {
9004 redisLog(REDIS_WARNING,"Unrecoverable error reading the append only file: %s", strerror(errno));
9005 }
9006 exit(1);
9007 fmterr:
9008 redisLog(REDIS_WARNING,"Bad file format reading the append only file");
9009 exit(1);
9010 }
9011
9012 /* Write binary-safe string into a file in the bulkformat
9013 * $<count>\r\n<payload>\r\n */
9014 static int fwriteBulkString(FILE *fp, char *s, unsigned long len) {
9015 char cbuf[128];
9016 int clen;
9017 cbuf[0] = '$';
9018 clen = 1+ll2string(cbuf+1,sizeof(cbuf)-1,len);
9019 cbuf[clen++] = '\r';
9020 cbuf[clen++] = '\n';
9021 if (fwrite(cbuf,clen,1,fp) == 0) return 0;
9022 if (len > 0 && fwrite(s,len,1,fp) == 0) return 0;
9023 if (fwrite("\r\n",2,1,fp) == 0) return 0;
9024 return 1;
9025 }
9026
9027 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
9028 static int fwriteBulkDouble(FILE *fp, double d) {
9029 char buf[128], dbuf[128];
9030
9031 snprintf(dbuf,sizeof(dbuf),"%.17g\r\n",d);
9032 snprintf(buf,sizeof(buf),"$%lu\r\n",(unsigned long)strlen(dbuf)-2);
9033 if (fwrite(buf,strlen(buf),1,fp) == 0) return 0;
9034 if (fwrite(dbuf,strlen(dbuf),1,fp) == 0) return 0;
9035 return 1;
9036 }
9037
9038 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
9039 static int fwriteBulkLongLong(FILE *fp, long long l) {
9040 char bbuf[128], lbuf[128];
9041 unsigned int blen, llen;
9042 llen = ll2string(lbuf,32,l);
9043 blen = snprintf(bbuf,sizeof(bbuf),"$%u\r\n%s\r\n",llen,lbuf);
9044 if (fwrite(bbuf,blen,1,fp) == 0) return 0;
9045 return 1;
9046 }
9047
9048 /* Delegate writing an object to writing a bulk string or bulk long long. */
9049 static int fwriteBulkObject(FILE *fp, robj *obj) {
9050 /* Avoid using getDecodedObject to help copy-on-write (we are often
9051 * in a child process when this function is called). */
9052 if (obj->encoding == REDIS_ENCODING_INT) {
9053 return fwriteBulkLongLong(fp,(long)obj->ptr);
9054 } else if (obj->encoding == REDIS_ENCODING_RAW) {
9055 return fwriteBulkString(fp,obj->ptr,sdslen(obj->ptr));
9056 } else {
9057 redisPanic("Unknown string encoding");
9058 }
9059 }
9060
9061 /* Write a sequence of commands able to fully rebuild the dataset into
9062 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
9063 static int rewriteAppendOnlyFile(char *filename) {
9064 dictIterator *di = NULL;
9065 dictEntry *de;
9066 FILE *fp;
9067 char tmpfile[256];
9068 int j;
9069 time_t now = time(NULL);
9070
9071 /* Note that we have to use a different temp name here compared to the
9072 * one used by rewriteAppendOnlyFileBackground() function. */
9073 snprintf(tmpfile,256,"temp-rewriteaof-%d.aof", (int) getpid());
9074 fp = fopen(tmpfile,"w");
9075 if (!fp) {
9076 redisLog(REDIS_WARNING, "Failed rewriting the append only file: %s", strerror(errno));
9077 return REDIS_ERR;
9078 }
9079 for (j = 0; j < server.dbnum; j++) {
9080 char selectcmd[] = "*2\r\n$6\r\nSELECT\r\n";
9081 redisDb *db = server.db+j;
9082 dict *d = db->dict;
9083 if (dictSize(d) == 0) continue;
9084 di = dictGetIterator(d);
9085 if (!di) {
9086 fclose(fp);
9087 return REDIS_ERR;
9088 }
9089
9090 /* SELECT the new DB */
9091 if (fwrite(selectcmd,sizeof(selectcmd)-1,1,fp) == 0) goto werr;
9092 if (fwriteBulkLongLong(fp,j) == 0) goto werr;
9093
9094 /* Iterate this DB writing every entry */
9095 while((de = dictNext(di)) != NULL) {
9096 sds keystr = dictGetEntryKey(de);
9097 robj key, *o;
9098 time_t expiretime;
9099 int swapped;
9100
9101 keystr = dictGetEntryKey(de);
9102 o = dictGetEntryVal(de);
9103 initStaticStringObject(key,keystr);
9104 /* If the value for this key is swapped, load a preview in memory.
9105 * We use a "swapped" flag to remember if we need to free the
9106 * value object instead to just increment the ref count anyway
9107 * in order to avoid copy-on-write of pages if we are forked() */
9108 if (!server.vm_enabled || o->storage == REDIS_VM_MEMORY ||
9109 o->storage == REDIS_VM_SWAPPING) {
9110 swapped = 0;
9111 } else {
9112 o = vmPreviewObject(o);
9113 swapped = 1;
9114 }
9115 expiretime = getExpire(db,&key);
9116
9117 /* Save the key and associated value */
9118 if (o->type == REDIS_STRING) {
9119 /* Emit a SET command */
9120 char cmd[]="*3\r\n$3\r\nSET\r\n";
9121 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
9122 /* Key and value */
9123 if (fwriteBulkObject(fp,&key) == 0) goto werr;
9124 if (fwriteBulkObject(fp,o) == 0) goto werr;
9125 } else if (o->type == REDIS_LIST) {
9126 /* Emit the RPUSHes needed to rebuild the list */
9127 char cmd[]="*3\r\n$5\r\nRPUSH\r\n";
9128 if (o->encoding == REDIS_ENCODING_ZIPLIST) {
9129 unsigned char *zl = o->ptr;
9130 unsigned char *p = ziplistIndex(zl,0);
9131 unsigned char *vstr;
9132 unsigned int vlen;
9133 long long vlong;
9134
9135 while(ziplistGet(p,&vstr,&vlen,&vlong)) {
9136 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
9137 if (fwriteBulkObject(fp,&key) == 0) goto werr;
9138 if (vstr) {
9139 if (fwriteBulkString(fp,(char*)vstr,vlen) == 0)
9140 goto werr;
9141 } else {
9142 if (fwriteBulkLongLong(fp,vlong) == 0)
9143 goto werr;
9144 }
9145 p = ziplistNext(zl,p);
9146 }
9147 } else if (o->encoding == REDIS_ENCODING_LIST) {
9148 list *list = o->ptr;
9149 listNode *ln;
9150 listIter li;
9151
9152 listRewind(list,&li);
9153 while((ln = listNext(&li))) {
9154 robj *eleobj = listNodeValue(ln);
9155
9156 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
9157 if (fwriteBulkObject(fp,&key) == 0) goto werr;
9158 if (fwriteBulkObject(fp,eleobj) == 0) goto werr;
9159 }
9160 } else {
9161 redisPanic("Unknown list encoding");
9162 }
9163 } else if (o->type == REDIS_SET) {
9164 /* Emit the SADDs needed to rebuild the set */
9165 dict *set = o->ptr;
9166 dictIterator *di = dictGetIterator(set);
9167 dictEntry *de;
9168
9169 while((de = dictNext(di)) != NULL) {
9170 char cmd[]="*3\r\n$4\r\nSADD\r\n";
9171 robj *eleobj = dictGetEntryKey(de);
9172
9173 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
9174 if (fwriteBulkObject(fp,&key) == 0) goto werr;
9175 if (fwriteBulkObject(fp,eleobj) == 0) goto werr;
9176 }
9177 dictReleaseIterator(di);
9178 } else if (o->type == REDIS_ZSET) {
9179 /* Emit the ZADDs needed to rebuild the sorted set */
9180 zset *zs = o->ptr;
9181 dictIterator *di = dictGetIterator(zs->dict);
9182 dictEntry *de;
9183
9184 while((de = dictNext(di)) != NULL) {
9185 char cmd[]="*4\r\n$4\r\nZADD\r\n";
9186 robj *eleobj = dictGetEntryKey(de);
9187 double *score = dictGetEntryVal(de);
9188
9189 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
9190 if (fwriteBulkObject(fp,&key) == 0) goto werr;
9191 if (fwriteBulkDouble(fp,*score) == 0) goto werr;
9192 if (fwriteBulkObject(fp,eleobj) == 0) goto werr;
9193 }
9194 dictReleaseIterator(di);
9195 } else if (o->type == REDIS_HASH) {
9196 char cmd[]="*4\r\n$4\r\nHSET\r\n";
9197
9198 /* Emit the HSETs needed to rebuild the hash */
9199 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
9200 unsigned char *p = zipmapRewind(o->ptr);
9201 unsigned char *field, *val;
9202 unsigned int flen, vlen;
9203
9204 while((p = zipmapNext(p,&field,&flen,&val,&vlen)) != NULL) {
9205 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
9206 if (fwriteBulkObject(fp,&key) == 0) goto werr;
9207 if (fwriteBulkString(fp,(char*)field,flen) == -1)
9208 return -1;
9209 if (fwriteBulkString(fp,(char*)val,vlen) == -1)
9210 return -1;
9211 }
9212 } else {
9213 dictIterator *di = dictGetIterator(o->ptr);
9214 dictEntry *de;
9215
9216 while((de = dictNext(di)) != NULL) {
9217 robj *field = dictGetEntryKey(de);
9218 robj *val = dictGetEntryVal(de);
9219
9220 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
9221 if (fwriteBulkObject(fp,&key) == 0) goto werr;
9222 if (fwriteBulkObject(fp,field) == -1) return -1;
9223 if (fwriteBulkObject(fp,val) == -1) return -1;
9224 }
9225 dictReleaseIterator(di);
9226 }
9227 } else {
9228 redisPanic("Unknown object type");
9229 }
9230 /* Save the expire time */
9231 if (expiretime != -1) {
9232 char cmd[]="*3\r\n$8\r\nEXPIREAT\r\n";
9233 /* If this key is already expired skip it */
9234 if (expiretime < now) continue;
9235 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
9236 if (fwriteBulkObject(fp,&key) == 0) goto werr;
9237 if (fwriteBulkLongLong(fp,expiretime) == 0) goto werr;
9238 }
9239 if (swapped) decrRefCount(o);
9240 }
9241 dictReleaseIterator(di);
9242 }
9243
9244 /* Make sure data will not remain on the OS's output buffers */
9245 fflush(fp);
9246 aof_fsync(fileno(fp));
9247 fclose(fp);
9248
9249 /* Use RENAME to make sure the DB file is changed atomically only
9250 * if the generate DB file is ok. */
9251 if (rename(tmpfile,filename) == -1) {
9252 redisLog(REDIS_WARNING,"Error moving temp append only file on the final destination: %s", strerror(errno));
9253 unlink(tmpfile);
9254 return REDIS_ERR;
9255 }
9256 redisLog(REDIS_NOTICE,"SYNC append only file rewrite performed");
9257 return REDIS_OK;
9258
9259 werr:
9260 fclose(fp);
9261 unlink(tmpfile);
9262 redisLog(REDIS_WARNING,"Write error writing append only file on disk: %s", strerror(errno));
9263 if (di) dictReleaseIterator(di);
9264 return REDIS_ERR;
9265 }
9266
9267 /* This is how rewriting of the append only file in background works:
9268 *
9269 * 1) The user calls BGREWRITEAOF
9270 * 2) Redis calls this function, that forks():
9271 * 2a) the child rewrite the append only file in a temp file.
9272 * 2b) the parent accumulates differences in server.bgrewritebuf.
9273 * 3) When the child finished '2a' exists.
9274 * 4) The parent will trap the exit code, if it's OK, will append the
9275 * data accumulated into server.bgrewritebuf into the temp file, and
9276 * finally will rename(2) the temp file in the actual file name.
9277 * The the new file is reopened as the new append only file. Profit!
9278 */
9279 static int rewriteAppendOnlyFileBackground(void) {
9280 pid_t childpid;
9281
9282 if (server.bgrewritechildpid != -1) return REDIS_ERR;
9283 if (server.vm_enabled) waitEmptyIOJobsQueue();
9284 if ((childpid = fork()) == 0) {
9285 /* Child */
9286 char tmpfile[256];
9287
9288 if (server.vm_enabled) vmReopenSwapFile();
9289 close(server.fd);
9290 snprintf(tmpfile,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
9291 if (rewriteAppendOnlyFile(tmpfile) == REDIS_OK) {
9292 _exit(0);
9293 } else {
9294 _exit(1);
9295 }
9296 } else {
9297 /* Parent */
9298 if (childpid == -1) {
9299 redisLog(REDIS_WARNING,
9300 "Can't rewrite append only file in background: fork: %s",
9301 strerror(errno));
9302 return REDIS_ERR;
9303 }
9304 redisLog(REDIS_NOTICE,
9305 "Background append only file rewriting started by pid %d",childpid);
9306 server.bgrewritechildpid = childpid;
9307 updateDictResizePolicy();
9308 /* We set appendseldb to -1 in order to force the next call to the
9309 * feedAppendOnlyFile() to issue a SELECT command, so the differences
9310 * accumulated by the parent into server.bgrewritebuf will start
9311 * with a SELECT statement and it will be safe to merge. */
9312 server.appendseldb = -1;
9313 return REDIS_OK;
9314 }
9315 return REDIS_OK; /* unreached */
9316 }
9317
9318 static void bgrewriteaofCommand(redisClient *c) {
9319 if (server.bgrewritechildpid != -1) {
9320 addReplySds(c,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
9321 return;
9322 }
9323 if (rewriteAppendOnlyFileBackground() == REDIS_OK) {
9324 char *status = "+Background append only file rewriting started\r\n";
9325 addReplySds(c,sdsnew(status));
9326 } else {
9327 addReply(c,shared.err);
9328 }
9329 }
9330
9331 static void aofRemoveTempFile(pid_t childpid) {
9332 char tmpfile[256];
9333
9334 snprintf(tmpfile,256,"temp-rewriteaof-bg-%d.aof", (int) childpid);
9335 unlink(tmpfile);
9336 }
9337
9338 /* Virtual Memory is composed mainly of two subsystems:
9339 * - Blocking Virutal Memory
9340 * - Threaded Virtual Memory I/O
9341 * The two parts are not fully decoupled, but functions are split among two
9342 * different sections of the source code (delimited by comments) in order to
9343 * make more clear what functionality is about the blocking VM and what about
9344 * the threaded (not blocking) VM.
9345 *
9346 * Redis VM design:
9347 *
9348 * Redis VM is a blocking VM (one that blocks reading swapped values from
9349 * disk into memory when a value swapped out is needed in memory) that is made
9350 * unblocking by trying to examine the command argument vector in order to
9351 * load in background values that will likely be needed in order to exec
9352 * the command. The command is executed only once all the relevant keys
9353 * are loaded into memory.
9354 *
9355 * This basically is almost as simple of a blocking VM, but almost as parallel
9356 * as a fully non-blocking VM.
9357 */
9358
9359 /* =================== Virtual Memory - Blocking Side ====================== */
9360
9361 /* Create a VM pointer object. This kind of objects are used in place of
9362 * values in the key -> value hash table, for swapped out objects. */
9363 static vmpointer *createVmPointer(int vtype) {
9364 vmpointer *vp = zmalloc(sizeof(vmpointer));
9365
9366 vp->type = REDIS_VMPOINTER;
9367 vp->storage = REDIS_VM_SWAPPED;
9368 vp->vtype = vtype;
9369 return vp;
9370 }
9371
9372 static void vmInit(void) {
9373 off_t totsize;
9374 int pipefds[2];
9375 size_t stacksize;
9376 struct flock fl;
9377
9378 if (server.vm_max_threads != 0)
9379 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
9380
9381 redisLog(REDIS_NOTICE,"Using '%s' as swap file",server.vm_swap_file);
9382 /* Try to open the old swap file, otherwise create it */
9383 if ((server.vm_fp = fopen(server.vm_swap_file,"r+b")) == NULL) {
9384 server.vm_fp = fopen(server.vm_swap_file,"w+b");
9385 }
9386 if (server.vm_fp == NULL) {
9387 redisLog(REDIS_WARNING,
9388 "Can't open the swap file: %s. Exiting.",
9389 strerror(errno));
9390 exit(1);
9391 }
9392 server.vm_fd = fileno(server.vm_fp);
9393 /* Lock the swap file for writing, this is useful in order to avoid
9394 * another instance to use the same swap file for a config error. */
9395 fl.l_type = F_WRLCK;
9396 fl.l_whence = SEEK_SET;
9397 fl.l_start = fl.l_len = 0;
9398 if (fcntl(server.vm_fd,F_SETLK,&fl) == -1) {
9399 redisLog(REDIS_WARNING,
9400 "Can't lock the swap file at '%s': %s. Make sure it is not used by another Redis instance.", server.vm_swap_file, strerror(errno));
9401 exit(1);
9402 }
9403 /* Initialize */
9404 server.vm_next_page = 0;
9405 server.vm_near_pages = 0;
9406 server.vm_stats_used_pages = 0;
9407 server.vm_stats_swapped_objects = 0;
9408 server.vm_stats_swapouts = 0;
9409 server.vm_stats_swapins = 0;
9410 totsize = server.vm_pages*server.vm_page_size;
9411 redisLog(REDIS_NOTICE,"Allocating %lld bytes of swap file",totsize);
9412 if (ftruncate(server.vm_fd,totsize) == -1) {
9413 redisLog(REDIS_WARNING,"Can't ftruncate swap file: %s. Exiting.",
9414 strerror(errno));
9415 exit(1);
9416 } else {
9417 redisLog(REDIS_NOTICE,"Swap file allocated with success");
9418 }
9419 server.vm_bitmap = zmalloc((server.vm_pages+7)/8);
9420 redisLog(REDIS_VERBOSE,"Allocated %lld bytes page table for %lld pages",
9421 (long long) (server.vm_pages+7)/8, server.vm_pages);
9422 memset(server.vm_bitmap,0,(server.vm_pages+7)/8);
9423
9424 /* Initialize threaded I/O (used by Virtual Memory) */
9425 server.io_newjobs = listCreate();
9426 server.io_processing = listCreate();
9427 server.io_processed = listCreate();
9428 server.io_ready_clients = listCreate();
9429 pthread_mutex_init(&server.io_mutex,NULL);
9430 pthread_mutex_init(&server.obj_freelist_mutex,NULL);
9431 pthread_mutex_init(&server.io_swapfile_mutex,NULL);
9432 server.io_active_threads = 0;
9433 if (pipe(pipefds) == -1) {
9434 redisLog(REDIS_WARNING,"Unable to intialized VM: pipe(2): %s. Exiting."
9435 ,strerror(errno));
9436 exit(1);
9437 }
9438 server.io_ready_pipe_read = pipefds[0];
9439 server.io_ready_pipe_write = pipefds[1];
9440 redisAssert(anetNonBlock(NULL,server.io_ready_pipe_read) != ANET_ERR);
9441 /* LZF requires a lot of stack */
9442 pthread_attr_init(&server.io_threads_attr);
9443 pthread_attr_getstacksize(&server.io_threads_attr, &stacksize);
9444 while (stacksize < REDIS_THREAD_STACK_SIZE) stacksize *= 2;
9445 pthread_attr_setstacksize(&server.io_threads_attr, stacksize);
9446 /* Listen for events in the threaded I/O pipe */
9447 if (aeCreateFileEvent(server.el, server.io_ready_pipe_read, AE_READABLE,
9448 vmThreadedIOCompletedJob, NULL) == AE_ERR)
9449 oom("creating file event");
9450 }
9451
9452 /* Mark the page as used */
9453 static void vmMarkPageUsed(off_t page) {
9454 off_t byte = page/8;
9455 int bit = page&7;
9456 redisAssert(vmFreePage(page) == 1);
9457 server.vm_bitmap[byte] |= 1<<bit;
9458 }
9459
9460 /* Mark N contiguous pages as used, with 'page' being the first. */
9461 static void vmMarkPagesUsed(off_t page, off_t count) {
9462 off_t j;
9463
9464 for (j = 0; j < count; j++)
9465 vmMarkPageUsed(page+j);
9466 server.vm_stats_used_pages += count;
9467 redisLog(REDIS_DEBUG,"Mark USED pages: %lld pages at %lld\n",
9468 (long long)count, (long long)page);
9469 }
9470
9471 /* Mark the page as free */
9472 static void vmMarkPageFree(off_t page) {
9473 off_t byte = page/8;
9474 int bit = page&7;
9475 redisAssert(vmFreePage(page) == 0);
9476 server.vm_bitmap[byte] &= ~(1<<bit);
9477 }
9478
9479 /* Mark N contiguous pages as free, with 'page' being the first. */
9480 static void vmMarkPagesFree(off_t page, off_t count) {
9481 off_t j;
9482
9483 for (j = 0; j < count; j++)
9484 vmMarkPageFree(page+j);
9485 server.vm_stats_used_pages -= count;
9486 redisLog(REDIS_DEBUG,"Mark FREE pages: %lld pages at %lld\n",
9487 (long long)count, (long long)page);
9488 }
9489
9490 /* Test if the page is free */
9491 static int vmFreePage(off_t page) {
9492 off_t byte = page/8;
9493 int bit = page&7;
9494 return (server.vm_bitmap[byte] & (1<<bit)) == 0;
9495 }
9496
9497 /* Find N contiguous free pages storing the first page of the cluster in *first.
9498 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
9499 * REDIS_ERR is returned.
9500 *
9501 * This function uses a simple algorithm: we try to allocate
9502 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
9503 * again from the start of the swap file searching for free spaces.
9504 *
9505 * If it looks pretty clear that there are no free pages near our offset
9506 * we try to find less populated places doing a forward jump of
9507 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
9508 * without hurry, and then we jump again and so forth...
9509 *
9510 * This function can be improved using a free list to avoid to guess
9511 * too much, since we could collect data about freed pages.
9512 *
9513 * note: I implemented this function just after watching an episode of
9514 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
9515 */
9516 static int vmFindContiguousPages(off_t *first, off_t n) {
9517 off_t base, offset = 0, since_jump = 0, numfree = 0;
9518
9519 if (server.vm_near_pages == REDIS_VM_MAX_NEAR_PAGES) {
9520 server.vm_near_pages = 0;
9521 server.vm_next_page = 0;
9522 }
9523 server.vm_near_pages++; /* Yet another try for pages near to the old ones */
9524 base = server.vm_next_page;
9525
9526 while(offset < server.vm_pages) {
9527 off_t this = base+offset;
9528
9529 /* If we overflow, restart from page zero */
9530 if (this >= server.vm_pages) {
9531 this -= server.vm_pages;
9532 if (this == 0) {
9533 /* Just overflowed, what we found on tail is no longer
9534 * interesting, as it's no longer contiguous. */
9535 numfree = 0;
9536 }
9537 }
9538 if (vmFreePage(this)) {
9539 /* This is a free page */
9540 numfree++;
9541 /* Already got N free pages? Return to the caller, with success */
9542 if (numfree == n) {
9543 *first = this-(n-1);
9544 server.vm_next_page = this+1;
9545 redisLog(REDIS_DEBUG, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n, (long long) *first);
9546 return REDIS_OK;
9547 }
9548 } else {
9549 /* The current one is not a free page */
9550 numfree = 0;
9551 }
9552
9553 /* Fast-forward if the current page is not free and we already
9554 * searched enough near this place. */
9555 since_jump++;
9556 if (!numfree && since_jump >= REDIS_VM_MAX_RANDOM_JUMP/4) {
9557 offset += random() % REDIS_VM_MAX_RANDOM_JUMP;
9558 since_jump = 0;
9559 /* Note that even if we rewind after the jump, we are don't need
9560 * to make sure numfree is set to zero as we only jump *if* it
9561 * is set to zero. */
9562 } else {
9563 /* Otherwise just check the next page */
9564 offset++;
9565 }
9566 }
9567 return REDIS_ERR;
9568 }
9569
9570 /* Write the specified object at the specified page of the swap file */
9571 static int vmWriteObjectOnSwap(robj *o, off_t page) {
9572 if (server.vm_enabled) pthread_mutex_lock(&server.io_swapfile_mutex);
9573 if (fseeko(server.vm_fp,page*server.vm_page_size,SEEK_SET) == -1) {
9574 if (server.vm_enabled) pthread_mutex_unlock(&server.io_swapfile_mutex);
9575 redisLog(REDIS_WARNING,
9576 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
9577 strerror(errno));
9578 return REDIS_ERR;
9579 }
9580 rdbSaveObject(server.vm_fp,o);
9581 fflush(server.vm_fp);
9582 if (server.vm_enabled) pthread_mutex_unlock(&server.io_swapfile_mutex);
9583 return REDIS_OK;
9584 }
9585
9586 /* Transfers the 'val' object to disk. Store all the information
9587 * a 'vmpointer' object containing all the information needed to load the
9588 * object back later is returned.
9589 *
9590 * If we can't find enough contiguous empty pages to swap the object on disk
9591 * NULL is returned. */
9592 static vmpointer *vmSwapObjectBlocking(robj *val) {
9593 off_t pages = rdbSavedObjectPages(val,NULL);
9594 off_t page;
9595 vmpointer *vp;
9596
9597 assert(val->storage == REDIS_VM_MEMORY);
9598 assert(val->refcount == 1);
9599 if (vmFindContiguousPages(&page,pages) == REDIS_ERR) return NULL;
9600 if (vmWriteObjectOnSwap(val,page) == REDIS_ERR) return NULL;
9601
9602 vp = createVmPointer(val->type);
9603 vp->page = page;
9604 vp->usedpages = pages;
9605 decrRefCount(val); /* Deallocate the object from memory. */
9606 vmMarkPagesUsed(page,pages);
9607 redisLog(REDIS_DEBUG,"VM: object %p swapped out at %lld (%lld pages)",
9608 (void*) val,
9609 (unsigned long long) page, (unsigned long long) pages);
9610 server.vm_stats_swapped_objects++;
9611 server.vm_stats_swapouts++;
9612 return vp;
9613 }
9614
9615 static robj *vmReadObjectFromSwap(off_t page, int type) {
9616 robj *o;
9617
9618 if (server.vm_enabled) pthread_mutex_lock(&server.io_swapfile_mutex);
9619 if (fseeko(server.vm_fp,page*server.vm_page_size,SEEK_SET) == -1) {
9620 redisLog(REDIS_WARNING,
9621 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
9622 strerror(errno));
9623 _exit(1);
9624 }
9625 o = rdbLoadObject(type,server.vm_fp);
9626 if (o == NULL) {
9627 redisLog(REDIS_WARNING, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno));
9628 _exit(1);
9629 }
9630 if (server.vm_enabled) pthread_mutex_unlock(&server.io_swapfile_mutex);
9631 return o;
9632 }
9633
9634 /* Load the specified object from swap to memory.
9635 * The newly allocated object is returned.
9636 *
9637 * If preview is true the unserialized object is returned to the caller but
9638 * the pages are not marked as freed, nor the vp object is freed. */
9639 static robj *vmGenericLoadObject(vmpointer *vp, int preview) {
9640 robj *val;
9641
9642 redisAssert(vp->type == REDIS_VMPOINTER &&
9643 (vp->storage == REDIS_VM_SWAPPED || vp->storage == REDIS_VM_LOADING));
9644 val = vmReadObjectFromSwap(vp->page,vp->vtype);
9645 if (!preview) {
9646 redisLog(REDIS_DEBUG, "VM: object %p loaded from disk", (void*)vp);
9647 vmMarkPagesFree(vp->page,vp->usedpages);
9648 zfree(vp);
9649 server.vm_stats_swapped_objects--;
9650 } else {
9651 redisLog(REDIS_DEBUG, "VM: object %p previewed from disk", (void*)vp);
9652 }
9653 server.vm_stats_swapins++;
9654 return val;
9655 }
9656
9657 /* Plain object loading, from swap to memory.
9658 *
9659 * 'o' is actually a redisVmPointer structure that will be freed by the call.
9660 * The return value is the loaded object. */
9661 static robj *vmLoadObject(robj *o) {
9662 /* If we are loading the object in background, stop it, we
9663 * need to load this object synchronously ASAP. */
9664 if (o->storage == REDIS_VM_LOADING)
9665 vmCancelThreadedIOJob(o);
9666 return vmGenericLoadObject((vmpointer*)o,0);
9667 }
9668
9669 /* Just load the value on disk, without to modify the key.
9670 * This is useful when we want to perform some operation on the value
9671 * without to really bring it from swap to memory, like while saving the
9672 * dataset or rewriting the append only log. */
9673 static robj *vmPreviewObject(robj *o) {
9674 return vmGenericLoadObject((vmpointer*)o,1);
9675 }
9676
9677 /* How a good candidate is this object for swapping?
9678 * The better candidate it is, the greater the returned value.
9679 *
9680 * Currently we try to perform a fast estimation of the object size in
9681 * memory, and combine it with aging informations.
9682 *
9683 * Basically swappability = idle-time * log(estimated size)
9684 *
9685 * Bigger objects are preferred over smaller objects, but not
9686 * proportionally, this is why we use the logarithm. This algorithm is
9687 * just a first try and will probably be tuned later. */
9688 static double computeObjectSwappability(robj *o) {
9689 /* actual age can be >= minage, but not < minage. As we use wrapping
9690 * 21 bit clocks with minutes resolution for the LRU. */
9691 time_t minage = abs(server.lruclock - o->lru);
9692 long asize = 0, elesize;
9693 robj *ele;
9694 list *l;
9695 listNode *ln;
9696 dict *d;
9697 struct dictEntry *de;
9698 int z;
9699
9700 if (minage <= 0) return 0;
9701 switch(o->type) {
9702 case REDIS_STRING:
9703 if (o->encoding != REDIS_ENCODING_RAW) {
9704 asize = sizeof(*o);
9705 } else {
9706 asize = sdslen(o->ptr)+sizeof(*o)+sizeof(long)*2;
9707 }
9708 break;
9709 case REDIS_LIST:
9710 if (o->encoding == REDIS_ENCODING_ZIPLIST) {
9711 asize = sizeof(*o)+ziplistSize(o->ptr);
9712 } else {
9713 l = o->ptr;
9714 ln = listFirst(l);
9715 asize = sizeof(list);
9716 if (ln) {
9717 ele = ln->value;
9718 elesize = (ele->encoding == REDIS_ENCODING_RAW) ?
9719 (sizeof(*o)+sdslen(ele->ptr)) : sizeof(*o);
9720 asize += (sizeof(listNode)+elesize)*listLength(l);
9721 }
9722 }
9723 break;
9724 case REDIS_SET:
9725 case REDIS_ZSET:
9726 z = (o->type == REDIS_ZSET);
9727 d = z ? ((zset*)o->ptr)->dict : o->ptr;
9728
9729 asize = sizeof(dict)+(sizeof(struct dictEntry*)*dictSlots(d));
9730 if (z) asize += sizeof(zset)-sizeof(dict);
9731 if (dictSize(d)) {
9732 de = dictGetRandomKey(d);
9733 ele = dictGetEntryKey(de);
9734 elesize = (ele->encoding == REDIS_ENCODING_RAW) ?
9735 (sizeof(*o)+sdslen(ele->ptr)) : sizeof(*o);
9736 asize += (sizeof(struct dictEntry)+elesize)*dictSize(d);
9737 if (z) asize += sizeof(zskiplistNode)*dictSize(d);
9738 }
9739 break;
9740 case REDIS_HASH:
9741 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
9742 unsigned char *p = zipmapRewind((unsigned char*)o->ptr);
9743 unsigned int len = zipmapLen((unsigned char*)o->ptr);
9744 unsigned int klen, vlen;
9745 unsigned char *key, *val;
9746
9747 if ((p = zipmapNext(p,&key,&klen,&val,&vlen)) == NULL) {
9748 klen = 0;
9749 vlen = 0;
9750 }
9751 asize = len*(klen+vlen+3);
9752 } else if (o->encoding == REDIS_ENCODING_HT) {
9753 d = o->ptr;
9754 asize = sizeof(dict)+(sizeof(struct dictEntry*)*dictSlots(d));
9755 if (dictSize(d)) {
9756 de = dictGetRandomKey(d);
9757 ele = dictGetEntryKey(de);
9758 elesize = (ele->encoding == REDIS_ENCODING_RAW) ?
9759 (sizeof(*o)+sdslen(ele->ptr)) : sizeof(*o);
9760 ele = dictGetEntryVal(de);
9761 elesize = (ele->encoding == REDIS_ENCODING_RAW) ?
9762 (sizeof(*o)+sdslen(ele->ptr)) : sizeof(*o);
9763 asize += (sizeof(struct dictEntry)+elesize)*dictSize(d);
9764 }
9765 }
9766 break;
9767 }
9768 return (double)minage*log(1+asize);
9769 }
9770
9771 /* Try to swap an object that's a good candidate for swapping.
9772 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
9773 * to swap any object at all.
9774 *
9775 * If 'usethreaded' is true, Redis will try to swap the object in background
9776 * using I/O threads. */
9777 static int vmSwapOneObject(int usethreads) {
9778 int j, i;
9779 struct dictEntry *best = NULL;
9780 double best_swappability = 0;
9781 redisDb *best_db = NULL;
9782 robj *val;
9783 sds key;
9784
9785 for (j = 0; j < server.dbnum; j++) {
9786 redisDb *db = server.db+j;
9787 /* Why maxtries is set to 100?
9788 * Because this way (usually) we'll find 1 object even if just 1% - 2%
9789 * are swappable objects */
9790 int maxtries = 100;
9791
9792 if (dictSize(db->dict) == 0) continue;
9793 for (i = 0; i < 5; i++) {
9794 dictEntry *de;
9795 double swappability;
9796
9797 if (maxtries) maxtries--;
9798 de = dictGetRandomKey(db->dict);
9799 val = dictGetEntryVal(de);
9800 /* Only swap objects that are currently in memory.
9801 *
9802 * Also don't swap shared objects: not a good idea in general and
9803 * we need to ensure that the main thread does not touch the
9804 * object while the I/O thread is using it, but we can't
9805 * control other keys without adding additional mutex. */
9806 if (val->storage != REDIS_VM_MEMORY || val->refcount != 1) {
9807 if (maxtries) i--; /* don't count this try */
9808 continue;
9809 }
9810 swappability = computeObjectSwappability(val);
9811 if (!best || swappability > best_swappability) {
9812 best = de;
9813 best_swappability = swappability;
9814 best_db = db;
9815 }
9816 }
9817 }
9818 if (best == NULL) return REDIS_ERR;
9819 key = dictGetEntryKey(best);
9820 val = dictGetEntryVal(best);
9821
9822 redisLog(REDIS_DEBUG,"Key with best swappability: %s, %f",
9823 key, best_swappability);
9824
9825 /* Swap it */
9826 if (usethreads) {
9827 robj *keyobj = createStringObject(key,sdslen(key));
9828 vmSwapObjectThreaded(keyobj,val,best_db);
9829 decrRefCount(keyobj);
9830 return REDIS_OK;
9831 } else {
9832 vmpointer *vp;
9833
9834 if ((vp = vmSwapObjectBlocking(val)) != NULL) {
9835 dictGetEntryVal(best) = vp;
9836 return REDIS_OK;
9837 } else {
9838 return REDIS_ERR;
9839 }
9840 }
9841 }
9842
9843 static int vmSwapOneObjectBlocking() {
9844 return vmSwapOneObject(0);
9845 }
9846
9847 static int vmSwapOneObjectThreaded() {
9848 return vmSwapOneObject(1);
9849 }
9850
9851 /* Return true if it's safe to swap out objects in a given moment.
9852 * Basically we don't want to swap objects out while there is a BGSAVE
9853 * or a BGAEOREWRITE running in backgroud. */
9854 static int vmCanSwapOut(void) {
9855 return (server.bgsavechildpid == -1 && server.bgrewritechildpid == -1);
9856 }
9857
9858 /* =================== Virtual Memory - Threaded I/O ======================= */
9859
9860 static void freeIOJob(iojob *j) {
9861 if ((j->type == REDIS_IOJOB_PREPARE_SWAP ||
9862 j->type == REDIS_IOJOB_DO_SWAP ||
9863 j->type == REDIS_IOJOB_LOAD) && j->val != NULL)
9864 {
9865 /* we fix the storage type, otherwise decrRefCount() will try to
9866 * kill the I/O thread Job (that does no longer exists). */
9867 if (j->val->storage == REDIS_VM_SWAPPING)
9868 j->val->storage = REDIS_VM_MEMORY;
9869 decrRefCount(j->val);
9870 }
9871 decrRefCount(j->key);
9872 zfree(j);
9873 }
9874
9875 /* Every time a thread finished a Job, it writes a byte into the write side
9876 * of an unix pipe in order to "awake" the main thread, and this function
9877 * is called. */
9878 static void vmThreadedIOCompletedJob(aeEventLoop *el, int fd, void *privdata,
9879 int mask)
9880 {
9881 char buf[1];
9882 int retval, processed = 0, toprocess = -1, trytoswap = 1;
9883 REDIS_NOTUSED(el);
9884 REDIS_NOTUSED(mask);
9885 REDIS_NOTUSED(privdata);
9886
9887 /* For every byte we read in the read side of the pipe, there is one
9888 * I/O job completed to process. */
9889 while((retval = read(fd,buf,1)) == 1) {
9890 iojob *j;
9891 listNode *ln;
9892 struct dictEntry *de;
9893
9894 redisLog(REDIS_DEBUG,"Processing I/O completed job");
9895
9896 /* Get the processed element (the oldest one) */
9897 lockThreadedIO();
9898 assert(listLength(server.io_processed) != 0);
9899 if (toprocess == -1) {
9900 toprocess = (listLength(server.io_processed)*REDIS_MAX_COMPLETED_JOBS_PROCESSED)/100;
9901 if (toprocess <= 0) toprocess = 1;
9902 }
9903 ln = listFirst(server.io_processed);
9904 j = ln->value;
9905 listDelNode(server.io_processed,ln);
9906 unlockThreadedIO();
9907 /* If this job is marked as canceled, just ignore it */
9908 if (j->canceled) {
9909 freeIOJob(j);
9910 continue;
9911 }
9912 /* Post process it in the main thread, as there are things we
9913 * can do just here to avoid race conditions and/or invasive locks */
9914 redisLog(REDIS_DEBUG,"COMPLETED Job type: %d, ID %p, key: %s", j->type, (void*)j->id, (unsigned char*)j->key->ptr);
9915 de = dictFind(j->db->dict,j->key->ptr);
9916 redisAssert(de != NULL);
9917 if (j->type == REDIS_IOJOB_LOAD) {
9918 redisDb *db;
9919 vmpointer *vp = dictGetEntryVal(de);
9920
9921 /* Key loaded, bring it at home */
9922 vmMarkPagesFree(vp->page,vp->usedpages);
9923 redisLog(REDIS_DEBUG, "VM: object %s loaded from disk (threaded)",
9924 (unsigned char*) j->key->ptr);
9925 server.vm_stats_swapped_objects--;
9926 server.vm_stats_swapins++;
9927 dictGetEntryVal(de) = j->val;
9928 incrRefCount(j->val);
9929 db = j->db;
9930 /* Handle clients waiting for this key to be loaded. */
9931 handleClientsBlockedOnSwappedKey(db,j->key);
9932 freeIOJob(j);
9933 zfree(vp);
9934 } else if (j->type == REDIS_IOJOB_PREPARE_SWAP) {
9935 /* Now we know the amount of pages required to swap this object.
9936 * Let's find some space for it, and queue this task again
9937 * rebranded as REDIS_IOJOB_DO_SWAP. */
9938 if (!vmCanSwapOut() ||
9939 vmFindContiguousPages(&j->page,j->pages) == REDIS_ERR)
9940 {
9941 /* Ooops... no space or we can't swap as there is
9942 * a fork()ed Redis trying to save stuff on disk. */
9943 j->val->storage = REDIS_VM_MEMORY; /* undo operation */
9944 freeIOJob(j);
9945 } else {
9946 /* Note that we need to mark this pages as used now,
9947 * if the job will be canceled, we'll mark them as freed
9948 * again. */
9949 vmMarkPagesUsed(j->page,j->pages);
9950 j->type = REDIS_IOJOB_DO_SWAP;
9951 lockThreadedIO();
9952 queueIOJob(j);
9953 unlockThreadedIO();
9954 }
9955 } else if (j->type == REDIS_IOJOB_DO_SWAP) {
9956 vmpointer *vp;
9957
9958 /* Key swapped. We can finally free some memory. */
9959 if (j->val->storage != REDIS_VM_SWAPPING) {
9960 vmpointer *vp = (vmpointer*) j->id;
9961 printf("storage: %d\n",vp->storage);
9962 printf("key->name: %s\n",(char*)j->key->ptr);
9963 printf("val: %p\n",(void*)j->val);
9964 printf("val->type: %d\n",j->val->type);
9965 printf("val->ptr: %s\n",(char*)j->val->ptr);
9966 }
9967 redisAssert(j->val->storage == REDIS_VM_SWAPPING);
9968 vp = createVmPointer(j->val->type);
9969 vp->page = j->page;
9970 vp->usedpages = j->pages;
9971 dictGetEntryVal(de) = vp;
9972 /* Fix the storage otherwise decrRefCount will attempt to
9973 * remove the associated I/O job */
9974 j->val->storage = REDIS_VM_MEMORY;
9975 decrRefCount(j->val);
9976 redisLog(REDIS_DEBUG,
9977 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
9978 (unsigned char*) j->key->ptr,
9979 (unsigned long long) j->page, (unsigned long long) j->pages);
9980 server.vm_stats_swapped_objects++;
9981 server.vm_stats_swapouts++;
9982 freeIOJob(j);
9983 /* Put a few more swap requests in queue if we are still
9984 * out of memory */
9985 if (trytoswap && vmCanSwapOut() &&
9986 zmalloc_used_memory() > server.vm_max_memory)
9987 {
9988 int more = 1;
9989 while(more) {
9990 lockThreadedIO();
9991 more = listLength(server.io_newjobs) <
9992 (unsigned) server.vm_max_threads;
9993 unlockThreadedIO();
9994 /* Don't waste CPU time if swappable objects are rare. */
9995 if (vmSwapOneObjectThreaded() == REDIS_ERR) {
9996 trytoswap = 0;
9997 break;
9998 }
9999 }
10000 }
10001 }
10002 processed++;
10003 if (processed == toprocess) return;
10004 }
10005 if (retval < 0 && errno != EAGAIN) {
10006 redisLog(REDIS_WARNING,
10007 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
10008 strerror(errno));
10009 }
10010 }
10011
10012 static void lockThreadedIO(void) {
10013 pthread_mutex_lock(&server.io_mutex);
10014 }
10015
10016 static void unlockThreadedIO(void) {
10017 pthread_mutex_unlock(&server.io_mutex);
10018 }
10019
10020 /* Remove the specified object from the threaded I/O queue if still not
10021 * processed, otherwise make sure to flag it as canceled. */
10022 static void vmCancelThreadedIOJob(robj *o) {
10023 list *lists[3] = {
10024 server.io_newjobs, /* 0 */
10025 server.io_processing, /* 1 */
10026 server.io_processed /* 2 */
10027 };
10028 int i;
10029
10030 assert(o->storage == REDIS_VM_LOADING || o->storage == REDIS_VM_SWAPPING);
10031 again:
10032 lockThreadedIO();
10033 /* Search for a matching object in one of the queues */
10034 for (i = 0; i < 3; i++) {
10035 listNode *ln;
10036 listIter li;
10037
10038 listRewind(lists[i],&li);
10039 while ((ln = listNext(&li)) != NULL) {
10040 iojob *job = ln->value;
10041
10042 if (job->canceled) continue; /* Skip this, already canceled. */
10043 if (job->id == o) {
10044 redisLog(REDIS_DEBUG,"*** CANCELED %p (key %s) (type %d) (LIST ID %d)\n",
10045 (void*)job, (char*)job->key->ptr, job->type, i);
10046 /* Mark the pages as free since the swap didn't happened
10047 * or happened but is now discarded. */
10048 if (i != 1 && job->type == REDIS_IOJOB_DO_SWAP)
10049 vmMarkPagesFree(job->page,job->pages);
10050 /* Cancel the job. It depends on the list the job is
10051 * living in. */
10052 switch(i) {
10053 case 0: /* io_newjobs */
10054 /* If the job was yet not processed the best thing to do
10055 * is to remove it from the queue at all */
10056 freeIOJob(job);
10057 listDelNode(lists[i],ln);
10058 break;
10059 case 1: /* io_processing */
10060 /* Oh Shi- the thread is messing with the Job:
10061 *
10062 * Probably it's accessing the object if this is a
10063 * PREPARE_SWAP or DO_SWAP job.
10064 * If it's a LOAD job it may be reading from disk and
10065 * if we don't wait for the job to terminate before to
10066 * cancel it, maybe in a few microseconds data can be
10067 * corrupted in this pages. So the short story is:
10068 *
10069 * Better to wait for the job to move into the
10070 * next queue (processed)... */
10071
10072 /* We try again and again until the job is completed. */
10073 unlockThreadedIO();
10074 /* But let's wait some time for the I/O thread
10075 * to finish with this job. After all this condition
10076 * should be very rare. */
10077 usleep(1);
10078 goto again;
10079 case 2: /* io_processed */
10080 /* The job was already processed, that's easy...
10081 * just mark it as canceled so that we'll ignore it
10082 * when processing completed jobs. */
10083 job->canceled = 1;
10084 break;
10085 }
10086 /* Finally we have to adjust the storage type of the object
10087 * in order to "UNDO" the operaiton. */
10088 if (o->storage == REDIS_VM_LOADING)
10089 o->storage = REDIS_VM_SWAPPED;
10090 else if (o->storage == REDIS_VM_SWAPPING)
10091 o->storage = REDIS_VM_MEMORY;
10092 unlockThreadedIO();
10093 redisLog(REDIS_DEBUG,"*** DONE");
10094 return;
10095 }
10096 }
10097 }
10098 unlockThreadedIO();
10099 printf("Not found: %p\n", (void*)o);
10100 redisAssert(1 != 1); /* We should never reach this */
10101 }
10102
10103 static void *IOThreadEntryPoint(void *arg) {
10104 iojob *j;
10105 listNode *ln;
10106 REDIS_NOTUSED(arg);
10107
10108 pthread_detach(pthread_self());
10109 while(1) {
10110 /* Get a new job to process */
10111 lockThreadedIO();
10112 if (listLength(server.io_newjobs) == 0) {
10113 /* No new jobs in queue, exit. */
10114 redisLog(REDIS_DEBUG,"Thread %ld exiting, nothing to do",
10115 (long) pthread_self());
10116 server.io_active_threads--;
10117 unlockThreadedIO();
10118 return NULL;
10119 }
10120 ln = listFirst(server.io_newjobs);
10121 j = ln->value;
10122 listDelNode(server.io_newjobs,ln);
10123 /* Add the job in the processing queue */
10124 j->thread = pthread_self();
10125 listAddNodeTail(server.io_processing,j);
10126 ln = listLast(server.io_processing); /* We use ln later to remove it */
10127 unlockThreadedIO();
10128 redisLog(REDIS_DEBUG,"Thread %ld got a new job (type %d): %p about key '%s'",
10129 (long) pthread_self(), j->type, (void*)j, (char*)j->key->ptr);
10130
10131 /* Process the Job */
10132 if (j->type == REDIS_IOJOB_LOAD) {
10133 vmpointer *vp = (vmpointer*)j->id;
10134 j->val = vmReadObjectFromSwap(j->page,vp->vtype);
10135 } else if (j->type == REDIS_IOJOB_PREPARE_SWAP) {
10136 FILE *fp = fopen("/dev/null","w+");
10137 j->pages = rdbSavedObjectPages(j->val,fp);
10138 fclose(fp);
10139 } else if (j->type == REDIS_IOJOB_DO_SWAP) {
10140 if (vmWriteObjectOnSwap(j->val,j->page) == REDIS_ERR)
10141 j->canceled = 1;
10142 }
10143
10144 /* Done: insert the job into the processed queue */
10145 redisLog(REDIS_DEBUG,"Thread %ld completed the job: %p (key %s)",
10146 (long) pthread_self(), (void*)j, (char*)j->key->ptr);
10147 lockThreadedIO();
10148 listDelNode(server.io_processing,ln);
10149 listAddNodeTail(server.io_processed,j);
10150 unlockThreadedIO();
10151
10152 /* Signal the main thread there is new stuff to process */
10153 assert(write(server.io_ready_pipe_write,"x",1) == 1);
10154 }
10155 return NULL; /* never reached */
10156 }
10157
10158 static void spawnIOThread(void) {
10159 pthread_t thread;
10160 sigset_t mask, omask;
10161 int err;
10162
10163 sigemptyset(&mask);
10164 sigaddset(&mask,SIGCHLD);
10165 sigaddset(&mask,SIGHUP);
10166 sigaddset(&mask,SIGPIPE);
10167 pthread_sigmask(SIG_SETMASK, &mask, &omask);
10168 while ((err = pthread_create(&thread,&server.io_threads_attr,IOThreadEntryPoint,NULL)) != 0) {
10169 redisLog(REDIS_WARNING,"Unable to spawn an I/O thread: %s",
10170 strerror(err));
10171 usleep(1000000);
10172 }
10173 pthread_sigmask(SIG_SETMASK, &omask, NULL);
10174 server.io_active_threads++;
10175 }
10176
10177 /* We need to wait for the last thread to exit before we are able to
10178 * fork() in order to BGSAVE or BGREWRITEAOF. */
10179 static void waitEmptyIOJobsQueue(void) {
10180 while(1) {
10181 int io_processed_len;
10182
10183 lockThreadedIO();
10184 if (listLength(server.io_newjobs) == 0 &&
10185 listLength(server.io_processing) == 0 &&
10186 server.io_active_threads == 0)
10187 {
10188 unlockThreadedIO();
10189 return;
10190 }
10191 /* While waiting for empty jobs queue condition we post-process some
10192 * finshed job, as I/O threads may be hanging trying to write against
10193 * the io_ready_pipe_write FD but there are so much pending jobs that
10194 * it's blocking. */
10195 io_processed_len = listLength(server.io_processed);
10196 unlockThreadedIO();
10197 if (io_processed_len) {
10198 vmThreadedIOCompletedJob(NULL,server.io_ready_pipe_read,NULL,0);
10199 usleep(1000); /* 1 millisecond */
10200 } else {
10201 usleep(10000); /* 10 milliseconds */
10202 }
10203 }
10204 }
10205
10206 static void vmReopenSwapFile(void) {
10207 /* Note: we don't close the old one as we are in the child process
10208 * and don't want to mess at all with the original file object. */
10209 server.vm_fp = fopen(server.vm_swap_file,"r+b");
10210 if (server.vm_fp == NULL) {
10211 redisLog(REDIS_WARNING,"Can't re-open the VM swap file: %s. Exiting.",
10212 server.vm_swap_file);
10213 _exit(1);
10214 }
10215 server.vm_fd = fileno(server.vm_fp);
10216 }
10217
10218 /* This function must be called while with threaded IO locked */
10219 static void queueIOJob(iojob *j) {
10220 redisLog(REDIS_DEBUG,"Queued IO Job %p type %d about key '%s'\n",
10221 (void*)j, j->type, (char*)j->key->ptr);
10222 listAddNodeTail(server.io_newjobs,j);
10223 if (server.io_active_threads < server.vm_max_threads)
10224 spawnIOThread();
10225 }
10226
10227 static int vmSwapObjectThreaded(robj *key, robj *val, redisDb *db) {
10228 iojob *j;
10229
10230 j = zmalloc(sizeof(*j));
10231 j->type = REDIS_IOJOB_PREPARE_SWAP;
10232 j->db = db;
10233 j->key = key;
10234 incrRefCount(key);
10235 j->id = j->val = val;
10236 incrRefCount(val);
10237 j->canceled = 0;
10238 j->thread = (pthread_t) -1;
10239 val->storage = REDIS_VM_SWAPPING;
10240
10241 lockThreadedIO();
10242 queueIOJob(j);
10243 unlockThreadedIO();
10244 return REDIS_OK;
10245 }
10246
10247 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
10248
10249 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
10250 * If there is not already a job loading the key, it is craeted.
10251 * The key is added to the io_keys list in the client structure, and also
10252 * in the hash table mapping swapped keys to waiting clients, that is,
10253 * server.io_waited_keys. */
10254 static int waitForSwappedKey(redisClient *c, robj *key) {
10255 struct dictEntry *de;
10256 robj *o;
10257 list *l;
10258
10259 /* If the key does not exist or is already in RAM we don't need to
10260 * block the client at all. */
10261 de = dictFind(c->db->dict,key->ptr);
10262 if (de == NULL) return 0;
10263 o = dictGetEntryVal(de);
10264 if (o->storage == REDIS_VM_MEMORY) {
10265 return 0;
10266 } else if (o->storage == REDIS_VM_SWAPPING) {
10267 /* We were swapping the key, undo it! */
10268 vmCancelThreadedIOJob(o);
10269 return 0;
10270 }
10271
10272 /* OK: the key is either swapped, or being loaded just now. */
10273
10274 /* Add the key to the list of keys this client is waiting for.
10275 * This maps clients to keys they are waiting for. */
10276 listAddNodeTail(c->io_keys,key);
10277 incrRefCount(key);
10278
10279 /* Add the client to the swapped keys => clients waiting map. */
10280 de = dictFind(c->db->io_keys,key);
10281 if (de == NULL) {
10282 int retval;
10283
10284 /* For every key we take a list of clients blocked for it */
10285 l = listCreate();
10286 retval = dictAdd(c->db->io_keys,key,l);
10287 incrRefCount(key);
10288 assert(retval == DICT_OK);
10289 } else {
10290 l = dictGetEntryVal(de);
10291 }
10292 listAddNodeTail(l,c);
10293
10294 /* Are we already loading the key from disk? If not create a job */
10295 if (o->storage == REDIS_VM_SWAPPED) {
10296 iojob *j;
10297 vmpointer *vp = (vmpointer*)o;
10298
10299 o->storage = REDIS_VM_LOADING;
10300 j = zmalloc(sizeof(*j));
10301 j->type = REDIS_IOJOB_LOAD;
10302 j->db = c->db;
10303 j->id = (robj*)vp;
10304 j->key = key;
10305 incrRefCount(key);
10306 j->page = vp->page;
10307 j->val = NULL;
10308 j->canceled = 0;
10309 j->thread = (pthread_t) -1;
10310 lockThreadedIO();
10311 queueIOJob(j);
10312 unlockThreadedIO();
10313 }
10314 return 1;
10315 }
10316
10317 /* Preload keys for any command with first, last and step values for
10318 * the command keys prototype, as defined in the command table. */
10319 static void waitForMultipleSwappedKeys(redisClient *c, struct redisCommand *cmd, int argc, robj **argv) {
10320 int j, last;
10321 if (cmd->vm_firstkey == 0) return;
10322 last = cmd->vm_lastkey;
10323 if (last < 0) last = argc+last;
10324 for (j = cmd->vm_firstkey; j <= last; j += cmd->vm_keystep) {
10325 redisAssert(j < argc);
10326 waitForSwappedKey(c,argv[j]);
10327 }
10328 }
10329
10330 /* Preload keys needed for the ZUNIONSTORE and ZINTERSTORE commands.
10331 * Note that the number of keys to preload is user-defined, so we need to
10332 * apply a sanity check against argc. */
10333 static void zunionInterBlockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd, int argc, robj **argv) {
10334 int i, num;
10335 REDIS_NOTUSED(cmd);
10336
10337 num = atoi(argv[2]->ptr);
10338 if (num > (argc-3)) return;
10339 for (i = 0; i < num; i++) {
10340 waitForSwappedKey(c,argv[3+i]);
10341 }
10342 }
10343
10344 /* Preload keys needed to execute the entire MULTI/EXEC block.
10345 *
10346 * This function is called by blockClientOnSwappedKeys when EXEC is issued,
10347 * and will block the client when any command requires a swapped out value. */
10348 static void execBlockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd, int argc, robj **argv) {
10349 int i, margc;
10350 struct redisCommand *mcmd;
10351 robj **margv;
10352 REDIS_NOTUSED(cmd);
10353 REDIS_NOTUSED(argc);
10354 REDIS_NOTUSED(argv);
10355
10356 if (!(c->flags & REDIS_MULTI)) return;
10357 for (i = 0; i < c->mstate.count; i++) {
10358 mcmd = c->mstate.commands[i].cmd;
10359 margc = c->mstate.commands[i].argc;
10360 margv = c->mstate.commands[i].argv;
10361
10362 if (mcmd->vm_preload_proc != NULL) {
10363 mcmd->vm_preload_proc(c,mcmd,margc,margv);
10364 } else {
10365 waitForMultipleSwappedKeys(c,mcmd,margc,margv);
10366 }
10367 }
10368 }
10369
10370 /* Is this client attempting to run a command against swapped keys?
10371 * If so, block it ASAP, load the keys in background, then resume it.
10372 *
10373 * The important idea about this function is that it can fail! If keys will
10374 * still be swapped when the client is resumed, this key lookups will
10375 * just block loading keys from disk. In practical terms this should only
10376 * happen with SORT BY command or if there is a bug in this function.
10377 *
10378 * Return 1 if the client is marked as blocked, 0 if the client can
10379 * continue as the keys it is going to access appear to be in memory. */
10380 static int blockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd) {
10381 if (cmd->vm_preload_proc != NULL) {
10382 cmd->vm_preload_proc(c,cmd,c->argc,c->argv);
10383 } else {
10384 waitForMultipleSwappedKeys(c,cmd,c->argc,c->argv);
10385 }
10386
10387 /* If the client was blocked for at least one key, mark it as blocked. */
10388 if (listLength(c->io_keys)) {
10389 c->flags |= REDIS_IO_WAIT;
10390 aeDeleteFileEvent(server.el,c->fd,AE_READABLE);
10391 server.vm_blocked_clients++;
10392 return 1;
10393 } else {
10394 return 0;
10395 }
10396 }
10397
10398 /* Remove the 'key' from the list of blocked keys for a given client.
10399 *
10400 * The function returns 1 when there are no longer blocking keys after
10401 * the current one was removed (and the client can be unblocked). */
10402 static int dontWaitForSwappedKey(redisClient *c, robj *key) {
10403 list *l;
10404 listNode *ln;
10405 listIter li;
10406 struct dictEntry *de;
10407
10408 /* Remove the key from the list of keys this client is waiting for. */
10409 listRewind(c->io_keys,&li);
10410 while ((ln = listNext(&li)) != NULL) {
10411 if (equalStringObjects(ln->value,key)) {
10412 listDelNode(c->io_keys,ln);
10413 break;
10414 }
10415 }
10416 assert(ln != NULL);
10417
10418 /* Remove the client form the key => waiting clients map. */
10419 de = dictFind(c->db->io_keys,key);
10420 assert(de != NULL);
10421 l = dictGetEntryVal(de);
10422 ln = listSearchKey(l,c);
10423 assert(ln != NULL);
10424 listDelNode(l,ln);
10425 if (listLength(l) == 0)
10426 dictDelete(c->db->io_keys,key);
10427
10428 return listLength(c->io_keys) == 0;
10429 }
10430
10431 /* Every time we now a key was loaded back in memory, we handle clients
10432 * waiting for this key if any. */
10433 static void handleClientsBlockedOnSwappedKey(redisDb *db, robj *key) {
10434 struct dictEntry *de;
10435 list *l;
10436 listNode *ln;
10437 int len;
10438
10439 de = dictFind(db->io_keys,key);
10440 if (!de) return;
10441
10442 l = dictGetEntryVal(de);
10443 len = listLength(l);
10444 /* Note: we can't use something like while(listLength(l)) as the list
10445 * can be freed by the calling function when we remove the last element. */
10446 while (len--) {
10447 ln = listFirst(l);
10448 redisClient *c = ln->value;
10449
10450 if (dontWaitForSwappedKey(c,key)) {
10451 /* Put the client in the list of clients ready to go as we
10452 * loaded all the keys about it. */
10453 listAddNodeTail(server.io_ready_clients,c);
10454 }
10455 }
10456 }
10457
10458 /* =========================== Remote Configuration ========================= */
10459
10460 static void configSetCommand(redisClient *c) {
10461 robj *o = getDecodedObject(c->argv[3]);
10462 long long ll;
10463
10464 if (!strcasecmp(c->argv[2]->ptr,"dbfilename")) {
10465 zfree(server.dbfilename);
10466 server.dbfilename = zstrdup(o->ptr);
10467 } else if (!strcasecmp(c->argv[2]->ptr,"requirepass")) {
10468 zfree(server.requirepass);
10469 server.requirepass = zstrdup(o->ptr);
10470 } else if (!strcasecmp(c->argv[2]->ptr,"masterauth")) {
10471 zfree(server.masterauth);
10472 server.masterauth = zstrdup(o->ptr);
10473 } else if (!strcasecmp(c->argv[2]->ptr,"maxmemory")) {
10474 if (getLongLongFromObject(o,&ll) == REDIS_ERR ||
10475 ll < 0) goto badfmt;
10476 server.maxmemory = ll;
10477 } else if (!strcasecmp(c->argv[2]->ptr,"timeout")) {
10478 if (getLongLongFromObject(o,&ll) == REDIS_ERR ||
10479 ll < 0 || ll > LONG_MAX) goto badfmt;
10480 server.maxidletime = ll;
10481 } else if (!strcasecmp(c->argv[2]->ptr,"appendfsync")) {
10482 if (!strcasecmp(o->ptr,"no")) {
10483 server.appendfsync = APPENDFSYNC_NO;
10484 } else if (!strcasecmp(o->ptr,"everysec")) {
10485 server.appendfsync = APPENDFSYNC_EVERYSEC;
10486 } else if (!strcasecmp(o->ptr,"always")) {
10487 server.appendfsync = APPENDFSYNC_ALWAYS;
10488 } else {
10489 goto badfmt;
10490 }
10491 } else if (!strcasecmp(c->argv[2]->ptr,"no-appendfsync-on-rewrite")) {
10492 int yn = yesnotoi(o->ptr);
10493
10494 if (yn == -1) goto badfmt;
10495 server.no_appendfsync_on_rewrite = yn;
10496 } else if (!strcasecmp(c->argv[2]->ptr,"appendonly")) {
10497 int old = server.appendonly;
10498 int new = yesnotoi(o->ptr);
10499
10500 if (new == -1) goto badfmt;
10501 if (old != new) {
10502 if (new == 0) {
10503 stopAppendOnly();
10504 } else {
10505 if (startAppendOnly() == REDIS_ERR) {
10506 addReplySds(c,sdscatprintf(sdsempty(),
10507 "-ERR Unable to turn on AOF. Check server logs.\r\n"));
10508 decrRefCount(o);
10509 return;
10510 }
10511 }
10512 }
10513 } else if (!strcasecmp(c->argv[2]->ptr,"save")) {
10514 int vlen, j;
10515 sds *v = sdssplitlen(o->ptr,sdslen(o->ptr)," ",1,&vlen);
10516
10517 /* Perform sanity check before setting the new config:
10518 * - Even number of args
10519 * - Seconds >= 1, changes >= 0 */
10520 if (vlen & 1) {
10521 sdsfreesplitres(v,vlen);
10522 goto badfmt;
10523 }
10524 for (j = 0; j < vlen; j++) {
10525 char *eptr;
10526 long val;
10527
10528 val = strtoll(v[j], &eptr, 10);
10529 if (eptr[0] != '\0' ||
10530 ((j & 1) == 0 && val < 1) ||
10531 ((j & 1) == 1 && val < 0)) {
10532 sdsfreesplitres(v,vlen);
10533 goto badfmt;
10534 }
10535 }
10536 /* Finally set the new config */
10537 resetServerSaveParams();
10538 for (j = 0; j < vlen; j += 2) {
10539 time_t seconds;
10540 int changes;
10541
10542 seconds = strtoll(v[j],NULL,10);
10543 changes = strtoll(v[j+1],NULL,10);
10544 appendServerSaveParams(seconds, changes);
10545 }
10546 sdsfreesplitres(v,vlen);
10547 } else {
10548 addReplySds(c,sdscatprintf(sdsempty(),
10549 "-ERR not supported CONFIG parameter %s\r\n",
10550 (char*)c->argv[2]->ptr));
10551 decrRefCount(o);
10552 return;
10553 }
10554 decrRefCount(o);
10555 addReply(c,shared.ok);
10556 return;
10557
10558 badfmt: /* Bad format errors */
10559 addReplySds(c,sdscatprintf(sdsempty(),
10560 "-ERR invalid argument '%s' for CONFIG SET '%s'\r\n",
10561 (char*)o->ptr,
10562 (char*)c->argv[2]->ptr));
10563 decrRefCount(o);
10564 }
10565
10566 static void configGetCommand(redisClient *c) {
10567 robj *o = getDecodedObject(c->argv[2]);
10568 robj *lenobj = createObject(REDIS_STRING,NULL);
10569 char *pattern = o->ptr;
10570 int matches = 0;
10571
10572 addReply(c,lenobj);
10573 decrRefCount(lenobj);
10574
10575 if (stringmatch(pattern,"dbfilename",0)) {
10576 addReplyBulkCString(c,"dbfilename");
10577 addReplyBulkCString(c,server.dbfilename);
10578 matches++;
10579 }
10580 if (stringmatch(pattern,"requirepass",0)) {
10581 addReplyBulkCString(c,"requirepass");
10582 addReplyBulkCString(c,server.requirepass);
10583 matches++;
10584 }
10585 if (stringmatch(pattern,"masterauth",0)) {
10586 addReplyBulkCString(c,"masterauth");
10587 addReplyBulkCString(c,server.masterauth);
10588 matches++;
10589 }
10590 if (stringmatch(pattern,"maxmemory",0)) {
10591 char buf[128];
10592
10593 ll2string(buf,128,server.maxmemory);
10594 addReplyBulkCString(c,"maxmemory");
10595 addReplyBulkCString(c,buf);
10596 matches++;
10597 }
10598 if (stringmatch(pattern,"timeout",0)) {
10599 char buf[128];
10600
10601 ll2string(buf,128,server.maxidletime);
10602 addReplyBulkCString(c,"timeout");
10603 addReplyBulkCString(c,buf);
10604 matches++;
10605 }
10606 if (stringmatch(pattern,"appendonly",0)) {
10607 addReplyBulkCString(c,"appendonly");
10608 addReplyBulkCString(c,server.appendonly ? "yes" : "no");
10609 matches++;
10610 }
10611 if (stringmatch(pattern,"no-appendfsync-on-rewrite",0)) {
10612 addReplyBulkCString(c,"no-appendfsync-on-rewrite");
10613 addReplyBulkCString(c,server.no_appendfsync_on_rewrite ? "yes" : "no");
10614 matches++;
10615 }
10616 if (stringmatch(pattern,"appendfsync",0)) {
10617 char *policy;
10618
10619 switch(server.appendfsync) {
10620 case APPENDFSYNC_NO: policy = "no"; break;
10621 case APPENDFSYNC_EVERYSEC: policy = "everysec"; break;
10622 case APPENDFSYNC_ALWAYS: policy = "always"; break;
10623 default: policy = "unknown"; break; /* too harmless to panic */
10624 }
10625 addReplyBulkCString(c,"appendfsync");
10626 addReplyBulkCString(c,policy);
10627 matches++;
10628 }
10629 if (stringmatch(pattern,"save",0)) {
10630 sds buf = sdsempty();
10631 int j;
10632
10633 for (j = 0; j < server.saveparamslen; j++) {
10634 buf = sdscatprintf(buf,"%ld %d",
10635 server.saveparams[j].seconds,
10636 server.saveparams[j].changes);
10637 if (j != server.saveparamslen-1)
10638 buf = sdscatlen(buf," ",1);
10639 }
10640 addReplyBulkCString(c,"save");
10641 addReplyBulkCString(c,buf);
10642 sdsfree(buf);
10643 matches++;
10644 }
10645 decrRefCount(o);
10646 lenobj->ptr = sdscatprintf(sdsempty(),"*%d\r\n",matches*2);
10647 }
10648
10649 static void configCommand(redisClient *c) {
10650 if (!strcasecmp(c->argv[1]->ptr,"set")) {
10651 if (c->argc != 4) goto badarity;
10652 configSetCommand(c);
10653 } else if (!strcasecmp(c->argv[1]->ptr,"get")) {
10654 if (c->argc != 3) goto badarity;
10655 configGetCommand(c);
10656 } else if (!strcasecmp(c->argv[1]->ptr,"resetstat")) {
10657 if (c->argc != 2) goto badarity;
10658 server.stat_numcommands = 0;
10659 server.stat_numconnections = 0;
10660 server.stat_expiredkeys = 0;
10661 server.stat_starttime = time(NULL);
10662 addReply(c,shared.ok);
10663 } else {
10664 addReplySds(c,sdscatprintf(sdsempty(),
10665 "-ERR CONFIG subcommand must be one of GET, SET, RESETSTAT\r\n"));
10666 }
10667 return;
10668
10669 badarity:
10670 addReplySds(c,sdscatprintf(sdsempty(),
10671 "-ERR Wrong number of arguments for CONFIG %s\r\n",
10672 (char*) c->argv[1]->ptr));
10673 }
10674
10675 /* =========================== Pubsub implementation ======================== */
10676
10677 static void freePubsubPattern(void *p) {
10678 pubsubPattern *pat = p;
10679
10680 decrRefCount(pat->pattern);
10681 zfree(pat);
10682 }
10683
10684 static int listMatchPubsubPattern(void *a, void *b) {
10685 pubsubPattern *pa = a, *pb = b;
10686
10687 return (pa->client == pb->client) &&
10688 (equalStringObjects(pa->pattern,pb->pattern));
10689 }
10690
10691 /* Subscribe a client to a channel. Returns 1 if the operation succeeded, or
10692 * 0 if the client was already subscribed to that channel. */
10693 static int pubsubSubscribeChannel(redisClient *c, robj *channel) {
10694 struct dictEntry *de;
10695 list *clients = NULL;
10696 int retval = 0;
10697
10698 /* Add the channel to the client -> channels hash table */
10699 if (dictAdd(c->pubsub_channels,channel,NULL) == DICT_OK) {
10700 retval = 1;
10701 incrRefCount(channel);
10702 /* Add the client to the channel -> list of clients hash table */
10703 de = dictFind(server.pubsub_channels,channel);
10704 if (de == NULL) {
10705 clients = listCreate();
10706 dictAdd(server.pubsub_channels,channel,clients);
10707 incrRefCount(channel);
10708 } else {
10709 clients = dictGetEntryVal(de);
10710 }
10711 listAddNodeTail(clients,c);
10712 }
10713 /* Notify the client */
10714 addReply(c,shared.mbulk3);
10715 addReply(c,shared.subscribebulk);
10716 addReplyBulk(c,channel);
10717 addReplyLongLong(c,dictSize(c->pubsub_channels)+listLength(c->pubsub_patterns));
10718 return retval;
10719 }
10720
10721 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
10722 * 0 if the client was not subscribed to the specified channel. */
10723 static int pubsubUnsubscribeChannel(redisClient *c, robj *channel, int notify) {
10724 struct dictEntry *de;
10725 list *clients;
10726 listNode *ln;
10727 int retval = 0;
10728
10729 /* Remove the channel from the client -> channels hash table */
10730 incrRefCount(channel); /* channel may be just a pointer to the same object
10731 we have in the hash tables. Protect it... */
10732 if (dictDelete(c->pubsub_channels,channel) == DICT_OK) {
10733 retval = 1;
10734 /* Remove the client from the channel -> clients list hash table */
10735 de = dictFind(server.pubsub_channels,channel);
10736 assert(de != NULL);
10737 clients = dictGetEntryVal(de);
10738 ln = listSearchKey(clients,c);
10739 assert(ln != NULL);
10740 listDelNode(clients,ln);
10741 if (listLength(clients) == 0) {
10742 /* Free the list and associated hash entry at all if this was
10743 * the latest client, so that it will be possible to abuse
10744 * Redis PUBSUB creating millions of channels. */
10745 dictDelete(server.pubsub_channels,channel);
10746 }
10747 }
10748 /* Notify the client */
10749 if (notify) {
10750 addReply(c,shared.mbulk3);
10751 addReply(c,shared.unsubscribebulk);
10752 addReplyBulk(c,channel);
10753 addReplyLongLong(c,dictSize(c->pubsub_channels)+
10754 listLength(c->pubsub_patterns));
10755
10756 }
10757 decrRefCount(channel); /* it is finally safe to release it */
10758 return retval;
10759 }
10760
10761 /* Subscribe a client to a pattern. Returns 1 if the operation succeeded, or 0 if the clinet was already subscribed to that pattern. */
10762 static int pubsubSubscribePattern(redisClient *c, robj *pattern) {
10763 int retval = 0;
10764
10765 if (listSearchKey(c->pubsub_patterns,pattern) == NULL) {
10766 retval = 1;
10767 pubsubPattern *pat;
10768 listAddNodeTail(c->pubsub_patterns,pattern);
10769 incrRefCount(pattern);
10770 pat = zmalloc(sizeof(*pat));
10771 pat->pattern = getDecodedObject(pattern);
10772 pat->client = c;
10773 listAddNodeTail(server.pubsub_patterns,pat);
10774 }
10775 /* Notify the client */
10776 addReply(c,shared.mbulk3);
10777 addReply(c,shared.psubscribebulk);
10778 addReplyBulk(c,pattern);
10779 addReplyLongLong(c,dictSize(c->pubsub_channels)+listLength(c->pubsub_patterns));
10780 return retval;
10781 }
10782
10783 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
10784 * 0 if the client was not subscribed to the specified channel. */
10785 static int pubsubUnsubscribePattern(redisClient *c, robj *pattern, int notify) {
10786 listNode *ln;
10787 pubsubPattern pat;
10788 int retval = 0;
10789
10790 incrRefCount(pattern); /* Protect the object. May be the same we remove */
10791 if ((ln = listSearchKey(c->pubsub_patterns,pattern)) != NULL) {
10792 retval = 1;
10793 listDelNode(c->pubsub_patterns,ln);
10794 pat.client = c;
10795 pat.pattern = pattern;
10796 ln = listSearchKey(server.pubsub_patterns,&pat);
10797 listDelNode(server.pubsub_patterns,ln);
10798 }
10799 /* Notify the client */
10800 if (notify) {
10801 addReply(c,shared.mbulk3);
10802 addReply(c,shared.punsubscribebulk);
10803 addReplyBulk(c,pattern);
10804 addReplyLongLong(c,dictSize(c->pubsub_channels)+
10805 listLength(c->pubsub_patterns));
10806 }
10807 decrRefCount(pattern);
10808 return retval;
10809 }
10810
10811 /* Unsubscribe from all the channels. Return the number of channels the
10812 * client was subscribed from. */
10813 static int pubsubUnsubscribeAllChannels(redisClient *c, int notify) {
10814 dictIterator *di = dictGetIterator(c->pubsub_channels);
10815 dictEntry *de;
10816 int count = 0;
10817
10818 while((de = dictNext(di)) != NULL) {
10819 robj *channel = dictGetEntryKey(de);
10820
10821 count += pubsubUnsubscribeChannel(c,channel,notify);
10822 }
10823 dictReleaseIterator(di);
10824 return count;
10825 }
10826
10827 /* Unsubscribe from all the patterns. Return the number of patterns the
10828 * client was subscribed from. */
10829 static int pubsubUnsubscribeAllPatterns(redisClient *c, int notify) {
10830 listNode *ln;
10831 listIter li;
10832 int count = 0;
10833
10834 listRewind(c->pubsub_patterns,&li);
10835 while ((ln = listNext(&li)) != NULL) {
10836 robj *pattern = ln->value;
10837
10838 count += pubsubUnsubscribePattern(c,pattern,notify);
10839 }
10840 return count;
10841 }
10842
10843 /* Publish a message */
10844 static int pubsubPublishMessage(robj *channel, robj *message) {
10845 int receivers = 0;
10846 struct dictEntry *de;
10847 listNode *ln;
10848 listIter li;
10849
10850 /* Send to clients listening for that channel */
10851 de = dictFind(server.pubsub_channels,channel);
10852 if (de) {
10853 list *list = dictGetEntryVal(de);
10854 listNode *ln;
10855 listIter li;
10856
10857 listRewind(list,&li);
10858 while ((ln = listNext(&li)) != NULL) {
10859 redisClient *c = ln->value;
10860
10861 addReply(c,shared.mbulk3);
10862 addReply(c,shared.messagebulk);
10863 addReplyBulk(c,channel);
10864 addReplyBulk(c,message);
10865 receivers++;
10866 }
10867 }
10868 /* Send to clients listening to matching channels */
10869 if (listLength(server.pubsub_patterns)) {
10870 listRewind(server.pubsub_patterns,&li);
10871 channel = getDecodedObject(channel);
10872 while ((ln = listNext(&li)) != NULL) {
10873 pubsubPattern *pat = ln->value;
10874
10875 if (stringmatchlen((char*)pat->pattern->ptr,
10876 sdslen(pat->pattern->ptr),
10877 (char*)channel->ptr,
10878 sdslen(channel->ptr),0)) {
10879 addReply(pat->client,shared.mbulk4);
10880 addReply(pat->client,shared.pmessagebulk);
10881 addReplyBulk(pat->client,pat->pattern);
10882 addReplyBulk(pat->client,channel);
10883 addReplyBulk(pat->client,message);
10884 receivers++;
10885 }
10886 }
10887 decrRefCount(channel);
10888 }
10889 return receivers;
10890 }
10891
10892 static void subscribeCommand(redisClient *c) {
10893 int j;
10894
10895 for (j = 1; j < c->argc; j++)
10896 pubsubSubscribeChannel(c,c->argv[j]);
10897 }
10898
10899 static void unsubscribeCommand(redisClient *c) {
10900 if (c->argc == 1) {
10901 pubsubUnsubscribeAllChannels(c,1);
10902 return;
10903 } else {
10904 int j;
10905
10906 for (j = 1; j < c->argc; j++)
10907 pubsubUnsubscribeChannel(c,c->argv[j],1);
10908 }
10909 }
10910
10911 static void psubscribeCommand(redisClient *c) {
10912 int j;
10913
10914 for (j = 1; j < c->argc; j++)
10915 pubsubSubscribePattern(c,c->argv[j]);
10916 }
10917
10918 static void punsubscribeCommand(redisClient *c) {
10919 if (c->argc == 1) {
10920 pubsubUnsubscribeAllPatterns(c,1);
10921 return;
10922 } else {
10923 int j;
10924
10925 for (j = 1; j < c->argc; j++)
10926 pubsubUnsubscribePattern(c,c->argv[j],1);
10927 }
10928 }
10929
10930 static void publishCommand(redisClient *c) {
10931 int receivers = pubsubPublishMessage(c->argv[1],c->argv[2]);
10932 addReplyLongLong(c,receivers);
10933 }
10934
10935 /* ===================== WATCH (CAS alike for MULTI/EXEC) ===================
10936 *
10937 * The implementation uses a per-DB hash table mapping keys to list of clients
10938 * WATCHing those keys, so that given a key that is going to be modified
10939 * we can mark all the associated clients as dirty.
10940 *
10941 * Also every client contains a list of WATCHed keys so that's possible to
10942 * un-watch such keys when the client is freed or when UNWATCH is called. */
10943
10944 /* In the client->watched_keys list we need to use watchedKey structures
10945 * as in order to identify a key in Redis we need both the key name and the
10946 * DB */
10947 typedef struct watchedKey {
10948 robj *key;
10949 redisDb *db;
10950 } watchedKey;
10951
10952 /* Watch for the specified key */
10953 static void watchForKey(redisClient *c, robj *key) {
10954 list *clients = NULL;
10955 listIter li;
10956 listNode *ln;
10957 watchedKey *wk;
10958
10959 /* Check if we are already watching for this key */
10960 listRewind(c->watched_keys,&li);
10961 while((ln = listNext(&li))) {
10962 wk = listNodeValue(ln);
10963 if (wk->db == c->db && equalStringObjects(key,wk->key))
10964 return; /* Key already watched */
10965 }
10966 /* This key is not already watched in this DB. Let's add it */
10967 clients = dictFetchValue(c->db->watched_keys,key);
10968 if (!clients) {
10969 clients = listCreate();
10970 dictAdd(c->db->watched_keys,key,clients);
10971 incrRefCount(key);
10972 }
10973 listAddNodeTail(clients,c);
10974 /* Add the new key to the lits of keys watched by this client */
10975 wk = zmalloc(sizeof(*wk));
10976 wk->key = key;
10977 wk->db = c->db;
10978 incrRefCount(key);
10979 listAddNodeTail(c->watched_keys,wk);
10980 }
10981
10982 /* Unwatch all the keys watched by this client. To clean the EXEC dirty
10983 * flag is up to the caller. */
10984 static void unwatchAllKeys(redisClient *c) {
10985 listIter li;
10986 listNode *ln;
10987
10988 if (listLength(c->watched_keys) == 0) return;
10989 listRewind(c->watched_keys,&li);
10990 while((ln = listNext(&li))) {
10991 list *clients;
10992 watchedKey *wk;
10993
10994 /* Lookup the watched key -> clients list and remove the client
10995 * from the list */
10996 wk = listNodeValue(ln);
10997 clients = dictFetchValue(wk->db->watched_keys, wk->key);
10998 assert(clients != NULL);
10999 listDelNode(clients,listSearchKey(clients,c));
11000 /* Kill the entry at all if this was the only client */
11001 if (listLength(clients) == 0)
11002 dictDelete(wk->db->watched_keys, wk->key);
11003 /* Remove this watched key from the client->watched list */
11004 listDelNode(c->watched_keys,ln);
11005 decrRefCount(wk->key);
11006 zfree(wk);
11007 }
11008 }
11009
11010 /* "Touch" a key, so that if this key is being WATCHed by some client the
11011 * next EXEC will fail. */
11012 static void touchWatchedKey(redisDb *db, robj *key) {
11013 list *clients;
11014 listIter li;
11015 listNode *ln;
11016
11017 if (dictSize(db->watched_keys) == 0) return;
11018 clients = dictFetchValue(db->watched_keys, key);
11019 if (!clients) return;
11020
11021 /* Mark all the clients watching this key as REDIS_DIRTY_CAS */
11022 /* Check if we are already watching for this key */
11023 listRewind(clients,&li);
11024 while((ln = listNext(&li))) {
11025 redisClient *c = listNodeValue(ln);
11026
11027 c->flags |= REDIS_DIRTY_CAS;
11028 }
11029 }
11030
11031 /* On FLUSHDB or FLUSHALL all the watched keys that are present before the
11032 * flush but will be deleted as effect of the flushing operation should
11033 * be touched. "dbid" is the DB that's getting the flush. -1 if it is
11034 * a FLUSHALL operation (all the DBs flushed). */
11035 static void touchWatchedKeysOnFlush(int dbid) {
11036 listIter li1, li2;
11037 listNode *ln;
11038
11039 /* For every client, check all the waited keys */
11040 listRewind(server.clients,&li1);
11041 while((ln = listNext(&li1))) {
11042 redisClient *c = listNodeValue(ln);
11043 listRewind(c->watched_keys,&li2);
11044 while((ln = listNext(&li2))) {
11045 watchedKey *wk = listNodeValue(ln);
11046
11047 /* For every watched key matching the specified DB, if the
11048 * key exists, mark the client as dirty, as the key will be
11049 * removed. */
11050 if (dbid == -1 || wk->db->id == dbid) {
11051 if (dictFind(wk->db->dict, wk->key->ptr) != NULL)
11052 c->flags |= REDIS_DIRTY_CAS;
11053 }
11054 }
11055 }
11056 }
11057
11058 static void watchCommand(redisClient *c) {
11059 int j;
11060
11061 if (c->flags & REDIS_MULTI) {
11062 addReplySds(c,sdsnew("-ERR WATCH inside MULTI is not allowed\r\n"));
11063 return;
11064 }
11065 for (j = 1; j < c->argc; j++)
11066 watchForKey(c,c->argv[j]);
11067 addReply(c,shared.ok);
11068 }
11069
11070 static void unwatchCommand(redisClient *c) {
11071 unwatchAllKeys(c);
11072 c->flags &= (~REDIS_DIRTY_CAS);
11073 addReply(c,shared.ok);
11074 }
11075
11076 /* ================================= Debugging ============================== */
11077
11078 /* Compute the sha1 of string at 's' with 'len' bytes long.
11079 * The SHA1 is then xored againt the string pointed by digest.
11080 * Since xor is commutative, this operation is used in order to
11081 * "add" digests relative to unordered elements.
11082 *
11083 * So digest(a,b,c,d) will be the same of digest(b,a,c,d) */
11084 static void xorDigest(unsigned char *digest, void *ptr, size_t len) {
11085 SHA1_CTX ctx;
11086 unsigned char hash[20], *s = ptr;
11087 int j;
11088
11089 SHA1Init(&ctx);
11090 SHA1Update(&ctx,s,len);
11091 SHA1Final(hash,&ctx);
11092
11093 for (j = 0; j < 20; j++)
11094 digest[j] ^= hash[j];
11095 }
11096
11097 static void xorObjectDigest(unsigned char *digest, robj *o) {
11098 o = getDecodedObject(o);
11099 xorDigest(digest,o->ptr,sdslen(o->ptr));
11100 decrRefCount(o);
11101 }
11102
11103 /* This function instead of just computing the SHA1 and xoring it
11104 * against diget, also perform the digest of "digest" itself and
11105 * replace the old value with the new one.
11106 *
11107 * So the final digest will be:
11108 *
11109 * digest = SHA1(digest xor SHA1(data))
11110 *
11111 * This function is used every time we want to preserve the order so
11112 * that digest(a,b,c,d) will be different than digest(b,c,d,a)
11113 *
11114 * Also note that mixdigest("foo") followed by mixdigest("bar")
11115 * will lead to a different digest compared to "fo", "obar".
11116 */
11117 static void mixDigest(unsigned char *digest, void *ptr, size_t len) {
11118 SHA1_CTX ctx;
11119 char *s = ptr;
11120
11121 xorDigest(digest,s,len);
11122 SHA1Init(&ctx);
11123 SHA1Update(&ctx,digest,20);
11124 SHA1Final(digest,&ctx);
11125 }
11126
11127 static void mixObjectDigest(unsigned char *digest, robj *o) {
11128 o = getDecodedObject(o);
11129 mixDigest(digest,o->ptr,sdslen(o->ptr));
11130 decrRefCount(o);
11131 }
11132
11133 /* Compute the dataset digest. Since keys, sets elements, hashes elements
11134 * are not ordered, we use a trick: every aggregate digest is the xor
11135 * of the digests of their elements. This way the order will not change
11136 * the result. For list instead we use a feedback entering the output digest
11137 * as input in order to ensure that a different ordered list will result in
11138 * a different digest. */
11139 static void computeDatasetDigest(unsigned char *final) {
11140 unsigned char digest[20];
11141 char buf[128];
11142 dictIterator *di = NULL;
11143 dictEntry *de;
11144 int j;
11145 uint32_t aux;
11146
11147 memset(final,0,20); /* Start with a clean result */
11148
11149 for (j = 0; j < server.dbnum; j++) {
11150 redisDb *db = server.db+j;
11151
11152 if (dictSize(db->dict) == 0) continue;
11153 di = dictGetIterator(db->dict);
11154
11155 /* hash the DB id, so the same dataset moved in a different
11156 * DB will lead to a different digest */
11157 aux = htonl(j);
11158 mixDigest(final,&aux,sizeof(aux));
11159
11160 /* Iterate this DB writing every entry */
11161 while((de = dictNext(di)) != NULL) {
11162 sds key;
11163 robj *keyobj, *o;
11164 time_t expiretime;
11165
11166 memset(digest,0,20); /* This key-val digest */
11167 key = dictGetEntryKey(de);
11168 keyobj = createStringObject(key,sdslen(key));
11169
11170 mixDigest(digest,key,sdslen(key));
11171
11172 /* Make sure the key is loaded if VM is active */
11173 o = lookupKeyRead(db,keyobj);
11174
11175 aux = htonl(o->type);
11176 mixDigest(digest,&aux,sizeof(aux));
11177 expiretime = getExpire(db,keyobj);
11178
11179 /* Save the key and associated value */
11180 if (o->type == REDIS_STRING) {
11181 mixObjectDigest(digest,o);
11182 } else if (o->type == REDIS_LIST) {
11183 listTypeIterator *li = listTypeInitIterator(o,0,REDIS_TAIL);
11184 listTypeEntry entry;
11185 while(listTypeNext(li,&entry)) {
11186 robj *eleobj = listTypeGet(&entry);
11187 mixObjectDigest(digest,eleobj);
11188 decrRefCount(eleobj);
11189 }
11190 listTypeReleaseIterator(li);
11191 } else if (o->type == REDIS_SET) {
11192 dict *set = o->ptr;
11193 dictIterator *di = dictGetIterator(set);
11194 dictEntry *de;
11195
11196 while((de = dictNext(di)) != NULL) {
11197 robj *eleobj = dictGetEntryKey(de);
11198
11199 xorObjectDigest(digest,eleobj);
11200 }
11201 dictReleaseIterator(di);
11202 } else if (o->type == REDIS_ZSET) {
11203 zset *zs = o->ptr;
11204 dictIterator *di = dictGetIterator(zs->dict);
11205 dictEntry *de;
11206
11207 while((de = dictNext(di)) != NULL) {
11208 robj *eleobj = dictGetEntryKey(de);
11209 double *score = dictGetEntryVal(de);
11210 unsigned char eledigest[20];
11211
11212 snprintf(buf,sizeof(buf),"%.17g",*score);
11213 memset(eledigest,0,20);
11214 mixObjectDigest(eledigest,eleobj);
11215 mixDigest(eledigest,buf,strlen(buf));
11216 xorDigest(digest,eledigest,20);
11217 }
11218 dictReleaseIterator(di);
11219 } else if (o->type == REDIS_HASH) {
11220 hashTypeIterator *hi;
11221 robj *obj;
11222
11223 hi = hashTypeInitIterator(o);
11224 while (hashTypeNext(hi) != REDIS_ERR) {
11225 unsigned char eledigest[20];
11226
11227 memset(eledigest,0,20);
11228 obj = hashTypeCurrent(hi,REDIS_HASH_KEY);
11229 mixObjectDigest(eledigest,obj);
11230 decrRefCount(obj);
11231 obj = hashTypeCurrent(hi,REDIS_HASH_VALUE);
11232 mixObjectDigest(eledigest,obj);
11233 decrRefCount(obj);
11234 xorDigest(digest,eledigest,20);
11235 }
11236 hashTypeReleaseIterator(hi);
11237 } else {
11238 redisPanic("Unknown object type");
11239 }
11240 /* If the key has an expire, add it to the mix */
11241 if (expiretime != -1) xorDigest(digest,"!!expire!!",10);
11242 /* We can finally xor the key-val digest to the final digest */
11243 xorDigest(final,digest,20);
11244 decrRefCount(keyobj);
11245 }
11246 dictReleaseIterator(di);
11247 }
11248 }
11249
11250 static void debugCommand(redisClient *c) {
11251 if (!strcasecmp(c->argv[1]->ptr,"segfault")) {
11252 *((char*)-1) = 'x';
11253 } else if (!strcasecmp(c->argv[1]->ptr,"reload")) {
11254 if (rdbSave(server.dbfilename) != REDIS_OK) {
11255 addReply(c,shared.err);
11256 return;
11257 }
11258 emptyDb();
11259 if (rdbLoad(server.dbfilename) != REDIS_OK) {
11260 addReply(c,shared.err);
11261 return;
11262 }
11263 redisLog(REDIS_WARNING,"DB reloaded by DEBUG RELOAD");
11264 addReply(c,shared.ok);
11265 } else if (!strcasecmp(c->argv[1]->ptr,"loadaof")) {
11266 emptyDb();
11267 if (loadAppendOnlyFile(server.appendfilename) != REDIS_OK) {
11268 addReply(c,shared.err);
11269 return;
11270 }
11271 redisLog(REDIS_WARNING,"Append Only File loaded by DEBUG LOADAOF");
11272 addReply(c,shared.ok);
11273 } else if (!strcasecmp(c->argv[1]->ptr,"object") && c->argc == 3) {
11274 dictEntry *de = dictFind(c->db->dict,c->argv[2]->ptr);
11275 robj *val;
11276
11277 if (!de) {
11278 addReply(c,shared.nokeyerr);
11279 return;
11280 }
11281 val = dictGetEntryVal(de);
11282 if (!server.vm_enabled || (val->storage == REDIS_VM_MEMORY ||
11283 val->storage == REDIS_VM_SWAPPING)) {
11284 char *strenc;
11285 char buf[128];
11286
11287 if (val->encoding < (sizeof(strencoding)/sizeof(char*))) {
11288 strenc = strencoding[val->encoding];
11289 } else {
11290 snprintf(buf,64,"unknown encoding %d\n", val->encoding);
11291 strenc = buf;
11292 }
11293 addReplySds(c,sdscatprintf(sdsempty(),
11294 "+Value at:%p refcount:%d "
11295 "encoding:%s serializedlength:%lld\r\n",
11296 (void*)val, val->refcount,
11297 strenc, (long long) rdbSavedObjectLen(val,NULL)));
11298 } else {
11299 vmpointer *vp = (vmpointer*) val;
11300 addReplySds(c,sdscatprintf(sdsempty(),
11301 "+Value swapped at: page %llu "
11302 "using %llu pages\r\n",
11303 (unsigned long long) vp->page,
11304 (unsigned long long) vp->usedpages));
11305 }
11306 } else if (!strcasecmp(c->argv[1]->ptr,"swapin") && c->argc == 3) {
11307 lookupKeyRead(c->db,c->argv[2]);
11308 addReply(c,shared.ok);
11309 } else if (!strcasecmp(c->argv[1]->ptr,"swapout") && c->argc == 3) {
11310 dictEntry *de = dictFind(c->db->dict,c->argv[2]->ptr);
11311 robj *val;
11312 vmpointer *vp;
11313
11314 if (!server.vm_enabled) {
11315 addReplySds(c,sdsnew("-ERR Virtual Memory is disabled\r\n"));
11316 return;
11317 }
11318 if (!de) {
11319 addReply(c,shared.nokeyerr);
11320 return;
11321 }
11322 val = dictGetEntryVal(de);
11323 /* Swap it */
11324 if (val->storage != REDIS_VM_MEMORY) {
11325 addReplySds(c,sdsnew("-ERR This key is not in memory\r\n"));
11326 } else if (val->refcount != 1) {
11327 addReplySds(c,sdsnew("-ERR Object is shared\r\n"));
11328 } else if ((vp = vmSwapObjectBlocking(val)) != NULL) {
11329 dictGetEntryVal(de) = vp;
11330 addReply(c,shared.ok);
11331 } else {
11332 addReply(c,shared.err);
11333 }
11334 } else if (!strcasecmp(c->argv[1]->ptr,"populate") && c->argc == 3) {
11335 long keys, j;
11336 robj *key, *val;
11337 char buf[128];
11338
11339 if (getLongFromObjectOrReply(c, c->argv[2], &keys, NULL) != REDIS_OK)
11340 return;
11341 for (j = 0; j < keys; j++) {
11342 snprintf(buf,sizeof(buf),"key:%lu",j);
11343 key = createStringObject(buf,strlen(buf));
11344 if (lookupKeyRead(c->db,key) != NULL) {
11345 decrRefCount(key);
11346 continue;
11347 }
11348 snprintf(buf,sizeof(buf),"value:%lu",j);
11349 val = createStringObject(buf,strlen(buf));
11350 dbAdd(c->db,key,val);
11351 decrRefCount(key);
11352 }
11353 addReply(c,shared.ok);
11354 } else if (!strcasecmp(c->argv[1]->ptr,"digest") && c->argc == 2) {
11355 unsigned char digest[20];
11356 sds d = sdsnew("+");
11357 int j;
11358
11359 computeDatasetDigest(digest);
11360 for (j = 0; j < 20; j++)
11361 d = sdscatprintf(d, "%02x",digest[j]);
11362
11363 d = sdscatlen(d,"\r\n",2);
11364 addReplySds(c,d);
11365 } else {
11366 addReplySds(c,sdsnew(
11367 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPIN <key>|SWAPOUT <key>|RELOAD]\r\n"));
11368 }
11369 }
11370
11371 static void _redisAssert(char *estr, char *file, int line) {
11372 redisLog(REDIS_WARNING,"=== ASSERTION FAILED ===");
11373 redisLog(REDIS_WARNING,"==> %s:%d '%s' is not true",file,line,estr);
11374 #ifdef HAVE_BACKTRACE
11375 redisLog(REDIS_WARNING,"(forcing SIGSEGV in order to print the stack trace)");
11376 *((char*)-1) = 'x';
11377 #endif
11378 }
11379
11380 static void _redisPanic(char *msg, char *file, int line) {
11381 redisLog(REDIS_WARNING,"!!! Software Failure. Press left mouse button to continue");
11382 redisLog(REDIS_WARNING,"Guru Meditation: %s #%s:%d",msg,file,line);
11383 #ifdef HAVE_BACKTRACE
11384 redisLog(REDIS_WARNING,"(forcing SIGSEGV in order to print the stack trace)");
11385 *((char*)-1) = 'x';
11386 #endif
11387 }
11388
11389 /* =================================== Main! ================================ */
11390
11391 #ifdef __linux__
11392 int linuxOvercommitMemoryValue(void) {
11393 FILE *fp = fopen("/proc/sys/vm/overcommit_memory","r");
11394 char buf[64];
11395
11396 if (!fp) return -1;
11397 if (fgets(buf,64,fp) == NULL) {
11398 fclose(fp);
11399 return -1;
11400 }
11401 fclose(fp);
11402
11403 return atoi(buf);
11404 }
11405
11406 void linuxOvercommitMemoryWarning(void) {
11407 if (linuxOvercommitMemoryValue() == 0) {
11408 redisLog(REDIS_WARNING,"WARNING overcommit_memory is set to 0! Background save may fail under low memory condition. To fix this issue add 'vm.overcommit_memory = 1' to /etc/sysctl.conf and then reboot or run the command 'sysctl vm.overcommit_memory=1' for this to take effect.");
11409 }
11410 }
11411 #endif /* __linux__ */
11412
11413 static void daemonize(void) {
11414 int fd;
11415 FILE *fp;
11416
11417 if (fork() != 0) exit(0); /* parent exits */
11418 setsid(); /* create a new session */
11419
11420 /* Every output goes to /dev/null. If Redis is daemonized but
11421 * the 'logfile' is set to 'stdout' in the configuration file
11422 * it will not log at all. */
11423 if ((fd = open("/dev/null", O_RDWR, 0)) != -1) {
11424 dup2(fd, STDIN_FILENO);
11425 dup2(fd, STDOUT_FILENO);
11426 dup2(fd, STDERR_FILENO);
11427 if (fd > STDERR_FILENO) close(fd);
11428 }
11429 /* Try to write the pid file */
11430 fp = fopen(server.pidfile,"w");
11431 if (fp) {
11432 fprintf(fp,"%d\n",getpid());
11433 fclose(fp);
11434 }
11435 }
11436
11437 static void version() {
11438 printf("Redis server version %s (%s:%d)\n", REDIS_VERSION,
11439 REDIS_GIT_SHA1, atoi(REDIS_GIT_DIRTY) > 0);
11440 exit(0);
11441 }
11442
11443 static void usage() {
11444 fprintf(stderr,"Usage: ./redis-server [/path/to/redis.conf]\n");
11445 fprintf(stderr," ./redis-server - (read config from stdin)\n");
11446 exit(1);
11447 }
11448
11449 int main(int argc, char **argv) {
11450 time_t start;
11451
11452 initServerConfig();
11453 sortCommandTable();
11454 if (argc == 2) {
11455 if (strcmp(argv[1], "-v") == 0 ||
11456 strcmp(argv[1], "--version") == 0) version();
11457 if (strcmp(argv[1], "--help") == 0) usage();
11458 resetServerSaveParams();
11459 loadServerConfig(argv[1]);
11460 } else if ((argc > 2)) {
11461 usage();
11462 } else {
11463 redisLog(REDIS_WARNING,"Warning: no config file specified, using the default config. In order to specify a config file use 'redis-server /path/to/redis.conf'");
11464 }
11465 if (server.daemonize) daemonize();
11466 initServer();
11467 redisLog(REDIS_NOTICE,"Server started, Redis version " REDIS_VERSION);
11468 #ifdef __linux__
11469 linuxOvercommitMemoryWarning();
11470 #endif
11471 start = time(NULL);
11472 if (server.appendonly) {
11473 if (loadAppendOnlyFile(server.appendfilename) == REDIS_OK)
11474 redisLog(REDIS_NOTICE,"DB loaded from append only file: %ld seconds",time(NULL)-start);
11475 } else {
11476 if (rdbLoad(server.dbfilename) == REDIS_OK)
11477 redisLog(REDIS_NOTICE,"DB loaded from disk: %ld seconds",time(NULL)-start);
11478 }
11479 redisLog(REDIS_NOTICE,"The server is now ready to accept connections on port %d", server.port);
11480 aeSetBeforeSleepProc(server.el,beforeSleep);
11481 aeMain(server.el);
11482 aeDeleteEventLoop(server.el);
11483 return 0;
11484 }
11485
11486 /* ============================= Backtrace support ========================= */
11487
11488 #ifdef HAVE_BACKTRACE
11489 static char *findFuncName(void *pointer, unsigned long *offset);
11490
11491 static void *getMcontextEip(ucontext_t *uc) {
11492 #if defined(__FreeBSD__)
11493 return (void*) uc->uc_mcontext.mc_eip;
11494 #elif defined(__dietlibc__)
11495 return (void*) uc->uc_mcontext.eip;
11496 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
11497 #if __x86_64__
11498 return (void*) uc->uc_mcontext->__ss.__rip;
11499 #else
11500 return (void*) uc->uc_mcontext->__ss.__eip;
11501 #endif
11502 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
11503 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
11504 return (void*) uc->uc_mcontext->__ss.__rip;
11505 #else
11506 return (void*) uc->uc_mcontext->__ss.__eip;
11507 #endif
11508 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
11509 return (void*) uc->uc_mcontext.gregs[REG_EIP]; /* Linux 32/64 bit */
11510 #elif defined(__ia64__) /* Linux IA64 */
11511 return (void*) uc->uc_mcontext.sc_ip;
11512 #else
11513 return NULL;
11514 #endif
11515 }
11516
11517 static void segvHandler(int sig, siginfo_t *info, void *secret) {
11518 void *trace[100];
11519 char **messages = NULL;
11520 int i, trace_size = 0;
11521 unsigned long offset=0;
11522 ucontext_t *uc = (ucontext_t*) secret;
11523 sds infostring;
11524 REDIS_NOTUSED(info);
11525
11526 redisLog(REDIS_WARNING,
11527 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION, sig);
11528 infostring = genRedisInfoString();
11529 redisLog(REDIS_WARNING, "%s",infostring);
11530 /* It's not safe to sdsfree() the returned string under memory
11531 * corruption conditions. Let it leak as we are going to abort */
11532
11533 trace_size = backtrace(trace, 100);
11534 /* overwrite sigaction with caller's address */
11535 if (getMcontextEip(uc) != NULL) {
11536 trace[1] = getMcontextEip(uc);
11537 }
11538 messages = backtrace_symbols(trace, trace_size);
11539
11540 for (i=1; i<trace_size; ++i) {
11541 char *fn = findFuncName(trace[i], &offset), *p;
11542
11543 p = strchr(messages[i],'+');
11544 if (!fn || (p && ((unsigned long)strtol(p+1,NULL,10)) < offset)) {
11545 redisLog(REDIS_WARNING,"%s", messages[i]);
11546 } else {
11547 redisLog(REDIS_WARNING,"%d redis-server %p %s + %d", i, trace[i], fn, (unsigned int)offset);
11548 }
11549 }
11550 /* free(messages); Don't call free() with possibly corrupted memory. */
11551 _exit(0);
11552 }
11553
11554 static void sigtermHandler(int sig) {
11555 REDIS_NOTUSED(sig);
11556
11557 redisLog(REDIS_WARNING,"SIGTERM received, scheduling shutting down...");
11558 server.shutdown_asap = 1;
11559 }
11560
11561 static void setupSigSegvAction(void) {
11562 struct sigaction act;
11563
11564 sigemptyset (&act.sa_mask);
11565 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
11566 * is used. Otherwise, sa_handler is used */
11567 act.sa_flags = SA_NODEFER | SA_ONSTACK | SA_RESETHAND | SA_SIGINFO;
11568 act.sa_sigaction = segvHandler;
11569 sigaction (SIGSEGV, &act, NULL);
11570 sigaction (SIGBUS, &act, NULL);
11571 sigaction (SIGFPE, &act, NULL);
11572 sigaction (SIGILL, &act, NULL);
11573 sigaction (SIGBUS, &act, NULL);
11574
11575 act.sa_flags = SA_NODEFER | SA_ONSTACK | SA_RESETHAND;
11576 act.sa_handler = sigtermHandler;
11577 sigaction (SIGTERM, &act, NULL);
11578 return;
11579 }
11580
11581 #include "staticsymbols.h"
11582 /* This function try to convert a pointer into a function name. It's used in
11583 * oreder to provide a backtrace under segmentation fault that's able to
11584 * display functions declared as static (otherwise the backtrace is useless). */
11585 static char *findFuncName(void *pointer, unsigned long *offset){
11586 int i, ret = -1;
11587 unsigned long off, minoff = 0;
11588
11589 /* Try to match against the Symbol with the smallest offset */
11590 for (i=0; symsTable[i].pointer; i++) {
11591 unsigned long lp = (unsigned long) pointer;
11592
11593 if (lp != (unsigned long)-1 && lp >= symsTable[i].pointer) {
11594 off=lp-symsTable[i].pointer;
11595 if (ret < 0 || off < minoff) {
11596 minoff=off;
11597 ret=i;
11598 }
11599 }
11600 }
11601 if (ret == -1) return NULL;
11602 *offset = minoff;
11603 return symsTable[ret].name;
11604 }
11605 #else /* HAVE_BACKTRACE */
11606 static void setupSigSegvAction(void) {
11607 }
11608 #endif /* HAVE_BACKTRACE */
11609
11610
11611
11612 /* The End */
11613
11614
11615