]> git.saurik.com Git - redis.git/blob - redis.c
40a32282d80725f156941ed8cc9cc2cce908c5b8
[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.0"
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 "sha1.h" /* SHA1 is used for DEBUG DIGEST */
79 #include "release.h" /* Release and/or git repository information */
80
81 /* Error codes */
82 #define REDIS_OK 0
83 #define REDIS_ERR -1
84
85 /* Static server configuration */
86 #define REDIS_SERVERPORT 6379 /* TCP port */
87 #define REDIS_MAXIDLETIME (60*5) /* default client timeout */
88 #define REDIS_IOBUF_LEN 1024
89 #define REDIS_LOADBUF_LEN 1024
90 #define REDIS_STATIC_ARGS 8
91 #define REDIS_DEFAULT_DBNUM 16
92 #define REDIS_CONFIGLINE_MAX 1024
93 #define REDIS_OBJFREELIST_MAX 1000000 /* Max number of objects to cache */
94 #define REDIS_MAX_SYNC_TIME 60 /* Slave can't take more to sync */
95 #define REDIS_EXPIRELOOKUPS_PER_CRON 10 /* lookup 10 expires per loop */
96 #define REDIS_MAX_WRITE_PER_EVENT (1024*64)
97 #define REDIS_REQUEST_MAX_SIZE (1024*1024*256) /* max bytes in inline command */
98
99 /* If more then REDIS_WRITEV_THRESHOLD write packets are pending use writev */
100 #define REDIS_WRITEV_THRESHOLD 3
101 /* Max number of iovecs used for each writev call */
102 #define REDIS_WRITEV_IOVEC_COUNT 256
103
104 /* Hash table parameters */
105 #define REDIS_HT_MINFILL 10 /* Minimal hash table fill 10% */
106
107 /* Command flags */
108 #define REDIS_CMD_BULK 1 /* Bulk write command */
109 #define REDIS_CMD_INLINE 2 /* Inline command */
110 /* REDIS_CMD_DENYOOM reserves a longer comment: all the commands marked with
111 this flags will return an error when the 'maxmemory' option is set in the
112 config file and the server is using more than maxmemory bytes of memory.
113 In short this commands are denied on low memory conditions. */
114 #define REDIS_CMD_DENYOOM 4
115 #define REDIS_CMD_FORCE_REPLICATION 8 /* Force replication even if dirty is 0 */
116
117 /* Object types */
118 #define REDIS_STRING 0
119 #define REDIS_LIST 1
120 #define REDIS_SET 2
121 #define REDIS_ZSET 3
122 #define REDIS_HASH 4
123
124 /* Objects encoding. Some kind of objects like Strings and Hashes can be
125 * internally represented in multiple ways. The 'encoding' field of the object
126 * is set to one of this fields for this object. */
127 #define REDIS_ENCODING_RAW 0 /* Raw representation */
128 #define REDIS_ENCODING_INT 1 /* Encoded as integer */
129 #define REDIS_ENCODING_ZIPMAP 2 /* Encoded as zipmap */
130 #define REDIS_ENCODING_HT 3 /* Encoded as an hash table */
131
132 static char* strencoding[] = {
133 "raw", "int", "zipmap", "hashtable"
134 };
135
136 /* Object types only used for dumping to disk */
137 #define REDIS_EXPIRETIME 253
138 #define REDIS_SELECTDB 254
139 #define REDIS_EOF 255
140
141 /* Defines related to the dump file format. To store 32 bits lengths for short
142 * keys requires a lot of space, so we check the most significant 2 bits of
143 * the first byte to interpreter the length:
144 *
145 * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
146 * 01|000000 00000000 => 01, the len is 14 byes, 6 bits + 8 bits of next byte
147 * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
148 * 11|000000 this means: specially encoded object will follow. The six bits
149 * number specify the kind of object that follows.
150 * See the REDIS_RDB_ENC_* defines.
151 *
152 * Lenghts up to 63 are stored using a single byte, most DB keys, and may
153 * values, will fit inside. */
154 #define REDIS_RDB_6BITLEN 0
155 #define REDIS_RDB_14BITLEN 1
156 #define REDIS_RDB_32BITLEN 2
157 #define REDIS_RDB_ENCVAL 3
158 #define REDIS_RDB_LENERR UINT_MAX
159
160 /* When a length of a string object stored on disk has the first two bits
161 * set, the remaining two bits specify a special encoding for the object
162 * accordingly to the following defines: */
163 #define REDIS_RDB_ENC_INT8 0 /* 8 bit signed integer */
164 #define REDIS_RDB_ENC_INT16 1 /* 16 bit signed integer */
165 #define REDIS_RDB_ENC_INT32 2 /* 32 bit signed integer */
166 #define REDIS_RDB_ENC_LZF 3 /* string compressed with FASTLZ */
167
168 /* Virtual memory object->where field. */
169 #define REDIS_VM_MEMORY 0 /* The object is on memory */
170 #define REDIS_VM_SWAPPED 1 /* The object is on disk */
171 #define REDIS_VM_SWAPPING 2 /* Redis is swapping this object on disk */
172 #define REDIS_VM_LOADING 3 /* Redis is loading this object from disk */
173
174 /* Virtual memory static configuration stuff.
175 * Check vmFindContiguousPages() to know more about this magic numbers. */
176 #define REDIS_VM_MAX_NEAR_PAGES 65536
177 #define REDIS_VM_MAX_RANDOM_JUMP 4096
178 #define REDIS_VM_MAX_THREADS 32
179 #define REDIS_THREAD_STACK_SIZE (1024*1024*4)
180 /* The following is the *percentage* of completed I/O jobs to process when the
181 * handelr is called. While Virtual Memory I/O operations are performed by
182 * threads, this operations must be processed by the main thread when completed
183 * in order to take effect. */
184 #define REDIS_MAX_COMPLETED_JOBS_PROCESSED 1
185
186 /* Client flags */
187 #define REDIS_SLAVE 1 /* This client is a slave server */
188 #define REDIS_MASTER 2 /* This client is a master server */
189 #define REDIS_MONITOR 4 /* This client is a slave monitor, see MONITOR */
190 #define REDIS_MULTI 8 /* This client is in a MULTI context */
191 #define REDIS_BLOCKED 16 /* The client is waiting in a blocking operation */
192 #define REDIS_IO_WAIT 32 /* The client is waiting for Virtual Memory I/O */
193 #define REDIS_DIRTY_CAS 64 /* Watched keys modified. EXEC will fail. */
194
195 /* Slave replication state - slave side */
196 #define REDIS_REPL_NONE 0 /* No active replication */
197 #define REDIS_REPL_CONNECT 1 /* Must connect to master */
198 #define REDIS_REPL_CONNECTED 2 /* Connected to master */
199
200 /* Slave replication state - from the point of view of master
201 * Note that in SEND_BULK and ONLINE state the slave receives new updates
202 * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
203 * to start the next background saving in order to send updates to it. */
204 #define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
205 #define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
206 #define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
207 #define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */
208
209 /* List related stuff */
210 #define REDIS_HEAD 0
211 #define REDIS_TAIL 1
212
213 /* Sort operations */
214 #define REDIS_SORT_GET 0
215 #define REDIS_SORT_ASC 1
216 #define REDIS_SORT_DESC 2
217 #define REDIS_SORTKEY_MAX 1024
218
219 /* Log levels */
220 #define REDIS_DEBUG 0
221 #define REDIS_VERBOSE 1
222 #define REDIS_NOTICE 2
223 #define REDIS_WARNING 3
224
225 /* Anti-warning macro... */
226 #define REDIS_NOTUSED(V) ((void) V)
227
228 #define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
229 #define ZSKIPLIST_P 0.25 /* Skiplist P = 1/4 */
230
231 /* Append only defines */
232 #define APPENDFSYNC_NO 0
233 #define APPENDFSYNC_ALWAYS 1
234 #define APPENDFSYNC_EVERYSEC 2
235
236 /* Hashes related defaults */
237 #define REDIS_HASH_MAX_ZIPMAP_ENTRIES 64
238 #define REDIS_HASH_MAX_ZIPMAP_VALUE 512
239
240 /* We can print the stacktrace, so our assert is defined this way: */
241 #define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1)))
242 #define redisPanic(_e) _redisPanic(#_e,__FILE__,__LINE__),_exit(1)
243 static void _redisAssert(char *estr, char *file, int line);
244 static void _redisPanic(char *msg, char *file, int line);
245
246 /*================================= Data types ============================== */
247
248 /* A redis object, that is a type able to hold a string / list / set */
249
250 /* The VM object structure */
251 struct redisObjectVM {
252 off_t page; /* the page at witch the object is stored on disk */
253 off_t usedpages; /* number of pages used on disk */
254 time_t atime; /* Last access time */
255 } vm;
256
257 /* The actual Redis Object */
258 typedef struct redisObject {
259 void *ptr;
260 unsigned char type;
261 unsigned char encoding;
262 unsigned char storage; /* If this object is a key, where is the value?
263 * REDIS_VM_MEMORY, REDIS_VM_SWAPPED, ... */
264 unsigned char vtype; /* If this object is a key, and value is swapped out,
265 * this is the type of the swapped out object. */
266 int refcount;
267 /* VM fields, this are only allocated if VM is active, otherwise the
268 * object allocation function will just allocate
269 * sizeof(redisObjct) minus sizeof(redisObjectVM), so using
270 * Redis without VM active will not have any overhead. */
271 struct redisObjectVM vm;
272 } robj;
273
274 /* Macro used to initalize a Redis object allocated on the stack.
275 * Note that this macro is taken near the structure definition to make sure
276 * we'll update it when the structure is changed, to avoid bugs like
277 * bug #85 introduced exactly in this way. */
278 #define initStaticStringObject(_var,_ptr) do { \
279 _var.refcount = 1; \
280 _var.type = REDIS_STRING; \
281 _var.encoding = REDIS_ENCODING_RAW; \
282 _var.ptr = _ptr; \
283 if (server.vm_enabled) _var.storage = REDIS_VM_MEMORY; \
284 } while(0);
285
286 typedef struct redisDb {
287 dict *dict; /* The keyspace for this DB */
288 dict *expires; /* Timeout of keys with a timeout set */
289 dict *blocking_keys; /* Keys with clients waiting for data (BLPOP) */
290 dict *io_keys; /* Keys with clients waiting for VM I/O */
291 dict *watched_keys; /* WATCHED keys for MULTI/EXEC CAS */
292 int id;
293 } redisDb;
294
295 /* Client MULTI/EXEC state */
296 typedef struct multiCmd {
297 robj **argv;
298 int argc;
299 struct redisCommand *cmd;
300 } multiCmd;
301
302 typedef struct multiState {
303 multiCmd *commands; /* Array of MULTI commands */
304 int count; /* Total number of MULTI commands */
305 } multiState;
306
307 /* With multiplexing we need to take per-clinet state.
308 * Clients are taken in a liked list. */
309 typedef struct redisClient {
310 int fd;
311 redisDb *db;
312 int dictid;
313 sds querybuf;
314 robj **argv, **mbargv;
315 int argc, mbargc;
316 int bulklen; /* bulk read len. -1 if not in bulk read mode */
317 int multibulk; /* multi bulk command format active */
318 list *reply;
319 int sentlen;
320 time_t lastinteraction; /* time of the last interaction, used for timeout */
321 int flags; /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
322 int slaveseldb; /* slave selected db, if this client is a slave */
323 int authenticated; /* when requirepass is non-NULL */
324 int replstate; /* replication state if this is a slave */
325 int repldbfd; /* replication DB file descriptor */
326 long repldboff; /* replication DB file offset */
327 off_t repldbsize; /* replication DB file size */
328 multiState mstate; /* MULTI/EXEC state */
329 robj **blocking_keys; /* The key we are waiting to terminate a blocking
330 * operation such as BLPOP. Otherwise NULL. */
331 int blocking_keys_num; /* Number of blocking keys */
332 time_t blockingto; /* Blocking operation timeout. If UNIX current time
333 * is >= blockingto then the operation timed out. */
334 list *io_keys; /* Keys this client is waiting to be loaded from the
335 * swap file in order to continue. */
336 list *watched_keys; /* Keys WATCHED for MULTI/EXEC CAS */
337 dict *pubsub_channels; /* channels a client is interested in (SUBSCRIBE) */
338 list *pubsub_patterns; /* patterns a client is interested in (SUBSCRIBE) */
339 } redisClient;
340
341 struct saveparam {
342 time_t seconds;
343 int changes;
344 };
345
346 /* Global server state structure */
347 struct redisServer {
348 int port;
349 int fd;
350 redisDb *db;
351 long long dirty; /* changes to DB from the last save */
352 list *clients;
353 list *slaves, *monitors;
354 char neterr[ANET_ERR_LEN];
355 aeEventLoop *el;
356 int cronloops; /* number of times the cron function run */
357 list *objfreelist; /* A list of freed objects to avoid malloc() */
358 time_t lastsave; /* Unix time of last save succeeede */
359 /* Fields used only for stats */
360 time_t stat_starttime; /* server start time */
361 long long stat_numcommands; /* number of processed commands */
362 long long stat_numconnections; /* number of connections received */
363 long long stat_expiredkeys; /* number of expired keys */
364 /* Configuration */
365 int verbosity;
366 int glueoutputbuf;
367 int maxidletime;
368 int dbnum;
369 int daemonize;
370 int appendonly;
371 int appendfsync;
372 int shutdown_asap;
373 time_t lastfsync;
374 int appendfd;
375 int appendseldb;
376 char *pidfile;
377 pid_t bgsavechildpid;
378 pid_t bgrewritechildpid;
379 sds bgrewritebuf; /* buffer taken by parent during oppend only rewrite */
380 sds aofbuf; /* AOF buffer, written before entering the event loop */
381 struct saveparam *saveparams;
382 int saveparamslen;
383 char *logfile;
384 char *bindaddr;
385 char *dbfilename;
386 char *appendfilename;
387 char *requirepass;
388 int rdbcompression;
389 int activerehashing;
390 /* Replication related */
391 int isslave;
392 char *masterauth;
393 char *masterhost;
394 int masterport;
395 redisClient *master; /* client that is master for this slave */
396 int replstate;
397 unsigned int maxclients;
398 unsigned long long maxmemory;
399 unsigned int blpop_blocked_clients;
400 unsigned int vm_blocked_clients;
401 /* Sort parameters - qsort_r() is only available under BSD so we
402 * have to take this state global, in order to pass it to sortCompare() */
403 int sort_desc;
404 int sort_alpha;
405 int sort_bypattern;
406 /* Virtual memory configuration */
407 int vm_enabled;
408 char *vm_swap_file;
409 off_t vm_page_size;
410 off_t vm_pages;
411 unsigned long long vm_max_memory;
412 /* Hashes config */
413 size_t hash_max_zipmap_entries;
414 size_t hash_max_zipmap_value;
415 /* Virtual memory state */
416 FILE *vm_fp;
417 int vm_fd;
418 off_t vm_next_page; /* Next probably empty page */
419 off_t vm_near_pages; /* Number of pages allocated sequentially */
420 unsigned char *vm_bitmap; /* Bitmap of free/used pages */
421 time_t unixtime; /* Unix time sampled every second. */
422 /* Virtual memory I/O threads stuff */
423 /* An I/O thread process an element taken from the io_jobs queue and
424 * put the result of the operation in the io_done list. While the
425 * job is being processed, it's put on io_processing queue. */
426 list *io_newjobs; /* List of VM I/O jobs yet to be processed */
427 list *io_processing; /* List of VM I/O jobs being processed */
428 list *io_processed; /* List of VM I/O jobs already processed */
429 list *io_ready_clients; /* Clients ready to be unblocked. All keys loaded */
430 pthread_mutex_t io_mutex; /* lock to access io_jobs/io_done/io_thread_job */
431 pthread_mutex_t obj_freelist_mutex; /* safe redis objects creation/free */
432 pthread_mutex_t io_swapfile_mutex; /* So we can lseek + write */
433 pthread_attr_t io_threads_attr; /* attributes for threads creation */
434 int io_active_threads; /* Number of running I/O threads */
435 int vm_max_threads; /* Max number of I/O threads running at the same time */
436 /* Our main thread is blocked on the event loop, locking for sockets ready
437 * to be read or written, so when a threaded I/O operation is ready to be
438 * processed by the main thread, the I/O thread will use a unix pipe to
439 * awake the main thread. The followings are the two pipe FDs. */
440 int io_ready_pipe_read;
441 int io_ready_pipe_write;
442 /* Virtual memory stats */
443 unsigned long long vm_stats_used_pages;
444 unsigned long long vm_stats_swapped_objects;
445 unsigned long long vm_stats_swapouts;
446 unsigned long long vm_stats_swapins;
447 /* Pubsub */
448 dict *pubsub_channels; /* Map channels to list of subscribed clients */
449 list *pubsub_patterns; /* A list of pubsub_patterns */
450 /* Misc */
451 FILE *devnull;
452 };
453
454 typedef struct pubsubPattern {
455 redisClient *client;
456 robj *pattern;
457 } pubsubPattern;
458
459 typedef void redisCommandProc(redisClient *c);
460 typedef void redisVmPreloadProc(redisClient *c, struct redisCommand *cmd, int argc, robj **argv);
461 struct redisCommand {
462 char *name;
463 redisCommandProc *proc;
464 int arity;
465 int flags;
466 /* Use a function to determine which keys need to be loaded
467 * in the background prior to executing this command. Takes precedence
468 * over vm_firstkey and others, ignored when NULL */
469 redisVmPreloadProc *vm_preload_proc;
470 /* What keys should be loaded in background when calling this command? */
471 int vm_firstkey; /* The first argument that's a key (0 = no keys) */
472 int vm_lastkey; /* THe last argument that's a key */
473 int vm_keystep; /* The step between first and last key */
474 };
475
476 struct redisFunctionSym {
477 char *name;
478 unsigned long pointer;
479 };
480
481 typedef struct _redisSortObject {
482 robj *obj;
483 union {
484 double score;
485 robj *cmpobj;
486 } u;
487 } redisSortObject;
488
489 typedef struct _redisSortOperation {
490 int type;
491 robj *pattern;
492 } redisSortOperation;
493
494 /* ZSETs use a specialized version of Skiplists */
495
496 typedef struct zskiplistNode {
497 struct zskiplistNode **forward;
498 struct zskiplistNode *backward;
499 unsigned int *span;
500 double score;
501 robj *obj;
502 } zskiplistNode;
503
504 typedef struct zskiplist {
505 struct zskiplistNode *header, *tail;
506 unsigned long length;
507 int level;
508 } zskiplist;
509
510 typedef struct zset {
511 dict *dict;
512 zskiplist *zsl;
513 } zset;
514
515 /* Our shared "common" objects */
516
517 #define REDIS_SHARED_INTEGERS 10000
518 struct sharedObjectsStruct {
519 robj *crlf, *ok, *err, *emptybulk, *czero, *cone, *pong, *space,
520 *colon, *nullbulk, *nullmultibulk, *queued,
521 *emptymultibulk, *wrongtypeerr, *nokeyerr, *syntaxerr, *sameobjecterr,
522 *outofrangeerr, *plus,
523 *select0, *select1, *select2, *select3, *select4,
524 *select5, *select6, *select7, *select8, *select9,
525 *messagebulk, *pmessagebulk, *subscribebulk, *unsubscribebulk, *mbulk3,
526 *mbulk4, *psubscribebulk, *punsubscribebulk,
527 *integers[REDIS_SHARED_INTEGERS];
528 } shared;
529
530 /* Global vars that are actally used as constants. The following double
531 * values are used for double on-disk serialization, and are initialized
532 * at runtime to avoid strange compiler optimizations. */
533
534 static double R_Zero, R_PosInf, R_NegInf, R_Nan;
535
536 /* VM threaded I/O request message */
537 #define REDIS_IOJOB_LOAD 0 /* Load from disk to memory */
538 #define REDIS_IOJOB_PREPARE_SWAP 1 /* Compute needed pages */
539 #define REDIS_IOJOB_DO_SWAP 2 /* Swap from memory to disk */
540 typedef struct iojob {
541 int type; /* Request type, REDIS_IOJOB_* */
542 redisDb *db;/* Redis database */
543 robj *key; /* This I/O request is about swapping this key */
544 robj *val; /* the value to swap for REDIS_IOREQ_*_SWAP, otherwise this
545 * field is populated by the I/O thread for REDIS_IOREQ_LOAD. */
546 off_t page; /* Swap page where to read/write the object */
547 off_t pages; /* Swap pages needed to save object. PREPARE_SWAP return val */
548 int canceled; /* True if this command was canceled by blocking side of VM */
549 pthread_t thread; /* ID of the thread processing this entry */
550 } iojob;
551
552 /*================================ Prototypes =============================== */
553
554 static void freeStringObject(robj *o);
555 static void freeListObject(robj *o);
556 static void freeSetObject(robj *o);
557 static void decrRefCount(void *o);
558 static robj *createObject(int type, void *ptr);
559 static void freeClient(redisClient *c);
560 static int rdbLoad(char *filename);
561 static void addReply(redisClient *c, robj *obj);
562 static void addReplySds(redisClient *c, sds s);
563 static void incrRefCount(robj *o);
564 static int rdbSaveBackground(char *filename);
565 static robj *createStringObject(char *ptr, size_t len);
566 static robj *dupStringObject(robj *o);
567 static void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc);
568 static void replicationFeedMonitors(list *monitors, int dictid, robj **argv, int argc);
569 static void flushAppendOnlyFile(void);
570 static void feedAppendOnlyFile(struct redisCommand *cmd, int dictid, robj **argv, int argc);
571 static int syncWithMaster(void);
572 static robj *tryObjectEncoding(robj *o);
573 static robj *getDecodedObject(robj *o);
574 static int removeExpire(redisDb *db, robj *key);
575 static int expireIfNeeded(redisDb *db, robj *key);
576 static int deleteIfVolatile(redisDb *db, robj *key);
577 static int deleteIfSwapped(redisDb *db, robj *key);
578 static int deleteKey(redisDb *db, robj *key);
579 static time_t getExpire(redisDb *db, robj *key);
580 static int setExpire(redisDb *db, robj *key, time_t when);
581 static void updateSlavesWaitingBgsave(int bgsaveerr);
582 static void freeMemoryIfNeeded(void);
583 static int processCommand(redisClient *c);
584 static void setupSigSegvAction(void);
585 static void rdbRemoveTempFile(pid_t childpid);
586 static void aofRemoveTempFile(pid_t childpid);
587 static size_t stringObjectLen(robj *o);
588 static void processInputBuffer(redisClient *c);
589 static zskiplist *zslCreate(void);
590 static void zslFree(zskiplist *zsl);
591 static void zslInsert(zskiplist *zsl, double score, robj *obj);
592 static void sendReplyToClientWritev(aeEventLoop *el, int fd, void *privdata, int mask);
593 static void initClientMultiState(redisClient *c);
594 static void freeClientMultiState(redisClient *c);
595 static void queueMultiCommand(redisClient *c, struct redisCommand *cmd);
596 static void unblockClientWaitingData(redisClient *c);
597 static int handleClientsWaitingListPush(redisClient *c, robj *key, robj *ele);
598 static void vmInit(void);
599 static void vmMarkPagesFree(off_t page, off_t count);
600 static robj *vmLoadObject(robj *key);
601 static robj *vmPreviewObject(robj *key);
602 static int vmSwapOneObjectBlocking(void);
603 static int vmSwapOneObjectThreaded(void);
604 static int vmCanSwapOut(void);
605 static int tryFreeOneObjectFromFreelist(void);
606 static void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask);
607 static void vmThreadedIOCompletedJob(aeEventLoop *el, int fd, void *privdata, int mask);
608 static void vmCancelThreadedIOJob(robj *o);
609 static void lockThreadedIO(void);
610 static void unlockThreadedIO(void);
611 static int vmSwapObjectThreaded(robj *key, robj *val, redisDb *db);
612 static void freeIOJob(iojob *j);
613 static void queueIOJob(iojob *j);
614 static int vmWriteObjectOnSwap(robj *o, off_t page);
615 static robj *vmReadObjectFromSwap(off_t page, int type);
616 static void waitEmptyIOJobsQueue(void);
617 static void vmReopenSwapFile(void);
618 static int vmFreePage(off_t page);
619 static void zunionInterBlockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd, int argc, robj **argv);
620 static void execBlockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd, int argc, robj **argv);
621 static int blockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd);
622 static int dontWaitForSwappedKey(redisClient *c, robj *key);
623 static void handleClientsBlockedOnSwappedKey(redisDb *db, robj *key);
624 static void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask);
625 static struct redisCommand *lookupCommand(char *name);
626 static void call(redisClient *c, struct redisCommand *cmd);
627 static void resetClient(redisClient *c);
628 static void convertToRealHash(robj *o);
629 static int pubsubUnsubscribeAllChannels(redisClient *c, int notify);
630 static int pubsubUnsubscribeAllPatterns(redisClient *c, int notify);
631 static void freePubsubPattern(void *p);
632 static int listMatchPubsubPattern(void *a, void *b);
633 static int compareStringObjects(robj *a, robj *b);
634 static int equalStringObjects(robj *a, robj *b);
635 static void usage();
636 static int rewriteAppendOnlyFileBackground(void);
637 static int vmSwapObjectBlocking(robj *key, robj *val);
638 static int prepareForShutdown();
639 static void touchWatchedKey(redisDb *db, robj *key);
640 static void touchWatchedKeysOnFlush(int dbid);
641 static void unwatchAllKeys(redisClient *c);
642
643 static void authCommand(redisClient *c);
644 static void pingCommand(redisClient *c);
645 static void echoCommand(redisClient *c);
646 static void setCommand(redisClient *c);
647 static void setnxCommand(redisClient *c);
648 static void setexCommand(redisClient *c);
649 static void getCommand(redisClient *c);
650 static void delCommand(redisClient *c);
651 static void existsCommand(redisClient *c);
652 static void incrCommand(redisClient *c);
653 static void decrCommand(redisClient *c);
654 static void incrbyCommand(redisClient *c);
655 static void decrbyCommand(redisClient *c);
656 static void selectCommand(redisClient *c);
657 static void randomkeyCommand(redisClient *c);
658 static void keysCommand(redisClient *c);
659 static void dbsizeCommand(redisClient *c);
660 static void lastsaveCommand(redisClient *c);
661 static void saveCommand(redisClient *c);
662 static void bgsaveCommand(redisClient *c);
663 static void bgrewriteaofCommand(redisClient *c);
664 static void shutdownCommand(redisClient *c);
665 static void moveCommand(redisClient *c);
666 static void renameCommand(redisClient *c);
667 static void renamenxCommand(redisClient *c);
668 static void lpushCommand(redisClient *c);
669 static void rpushCommand(redisClient *c);
670 static void lpopCommand(redisClient *c);
671 static void rpopCommand(redisClient *c);
672 static void llenCommand(redisClient *c);
673 static void lindexCommand(redisClient *c);
674 static void lrangeCommand(redisClient *c);
675 static void ltrimCommand(redisClient *c);
676 static void typeCommand(redisClient *c);
677 static void lsetCommand(redisClient *c);
678 static void saddCommand(redisClient *c);
679 static void sremCommand(redisClient *c);
680 static void smoveCommand(redisClient *c);
681 static void sismemberCommand(redisClient *c);
682 static void scardCommand(redisClient *c);
683 static void spopCommand(redisClient *c);
684 static void srandmemberCommand(redisClient *c);
685 static void sinterCommand(redisClient *c);
686 static void sinterstoreCommand(redisClient *c);
687 static void sunionCommand(redisClient *c);
688 static void sunionstoreCommand(redisClient *c);
689 static void sdiffCommand(redisClient *c);
690 static void sdiffstoreCommand(redisClient *c);
691 static void syncCommand(redisClient *c);
692 static void flushdbCommand(redisClient *c);
693 static void flushallCommand(redisClient *c);
694 static void sortCommand(redisClient *c);
695 static void lremCommand(redisClient *c);
696 static void rpoplpushcommand(redisClient *c);
697 static void infoCommand(redisClient *c);
698 static void mgetCommand(redisClient *c);
699 static void monitorCommand(redisClient *c);
700 static void expireCommand(redisClient *c);
701 static void expireatCommand(redisClient *c);
702 static void getsetCommand(redisClient *c);
703 static void ttlCommand(redisClient *c);
704 static void slaveofCommand(redisClient *c);
705 static void debugCommand(redisClient *c);
706 static void msetCommand(redisClient *c);
707 static void msetnxCommand(redisClient *c);
708 static void zaddCommand(redisClient *c);
709 static void zincrbyCommand(redisClient *c);
710 static void zrangeCommand(redisClient *c);
711 static void zrangebyscoreCommand(redisClient *c);
712 static void zcountCommand(redisClient *c);
713 static void zrevrangeCommand(redisClient *c);
714 static void zcardCommand(redisClient *c);
715 static void zremCommand(redisClient *c);
716 static void zscoreCommand(redisClient *c);
717 static void zremrangebyscoreCommand(redisClient *c);
718 static void multiCommand(redisClient *c);
719 static void execCommand(redisClient *c);
720 static void discardCommand(redisClient *c);
721 static void blpopCommand(redisClient *c);
722 static void brpopCommand(redisClient *c);
723 static void appendCommand(redisClient *c);
724 static void substrCommand(redisClient *c);
725 static void zrankCommand(redisClient *c);
726 static void zrevrankCommand(redisClient *c);
727 static void hsetCommand(redisClient *c);
728 static void hsetnxCommand(redisClient *c);
729 static void hgetCommand(redisClient *c);
730 static void hmsetCommand(redisClient *c);
731 static void hmgetCommand(redisClient *c);
732 static void hdelCommand(redisClient *c);
733 static void hlenCommand(redisClient *c);
734 static void zremrangebyrankCommand(redisClient *c);
735 static void zunionstoreCommand(redisClient *c);
736 static void zinterstoreCommand(redisClient *c);
737 static void hkeysCommand(redisClient *c);
738 static void hvalsCommand(redisClient *c);
739 static void hgetallCommand(redisClient *c);
740 static void hexistsCommand(redisClient *c);
741 static void configCommand(redisClient *c);
742 static void hincrbyCommand(redisClient *c);
743 static void subscribeCommand(redisClient *c);
744 static void unsubscribeCommand(redisClient *c);
745 static void psubscribeCommand(redisClient *c);
746 static void punsubscribeCommand(redisClient *c);
747 static void publishCommand(redisClient *c);
748 static void watchCommand(redisClient *c);
749 static void unwatchCommand(redisClient *c);
750
751 /*================================= Globals ================================= */
752
753 /* Global vars */
754 static struct redisServer server; /* server global state */
755 static struct redisCommand cmdTable[] = {
756 {"get",getCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
757 {"set",setCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,0,0,0},
758 {"setnx",setnxCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,0,0,0},
759 {"setex",setexCommand,4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,0,0,0},
760 {"append",appendCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
761 {"substr",substrCommand,4,REDIS_CMD_INLINE,NULL,1,1,1},
762 {"del",delCommand,-2,REDIS_CMD_INLINE,NULL,0,0,0},
763 {"exists",existsCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
764 {"incr",incrCommand,2,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,1,1},
765 {"decr",decrCommand,2,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,1,1},
766 {"mget",mgetCommand,-2,REDIS_CMD_INLINE,NULL,1,-1,1},
767 {"rpush",rpushCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
768 {"lpush",lpushCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
769 {"rpop",rpopCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
770 {"lpop",lpopCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
771 {"brpop",brpopCommand,-3,REDIS_CMD_INLINE,NULL,1,1,1},
772 {"blpop",blpopCommand,-3,REDIS_CMD_INLINE,NULL,1,1,1},
773 {"llen",llenCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
774 {"lindex",lindexCommand,3,REDIS_CMD_INLINE,NULL,1,1,1},
775 {"lset",lsetCommand,4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
776 {"lrange",lrangeCommand,4,REDIS_CMD_INLINE,NULL,1,1,1},
777 {"ltrim",ltrimCommand,4,REDIS_CMD_INLINE,NULL,1,1,1},
778 {"lrem",lremCommand,4,REDIS_CMD_BULK,NULL,1,1,1},
779 {"rpoplpush",rpoplpushcommand,3,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,2,1},
780 {"sadd",saddCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
781 {"srem",sremCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
782 {"smove",smoveCommand,4,REDIS_CMD_BULK,NULL,1,2,1},
783 {"sismember",sismemberCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
784 {"scard",scardCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
785 {"spop",spopCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
786 {"srandmember",srandmemberCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
787 {"sinter",sinterCommand,-2,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,-1,1},
788 {"sinterstore",sinterstoreCommand,-3,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,2,-1,1},
789 {"sunion",sunionCommand,-2,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,-1,1},
790 {"sunionstore",sunionstoreCommand,-3,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,2,-1,1},
791 {"sdiff",sdiffCommand,-2,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,-1,1},
792 {"sdiffstore",sdiffstoreCommand,-3,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,2,-1,1},
793 {"smembers",sinterCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
794 {"zadd",zaddCommand,4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
795 {"zincrby",zincrbyCommand,4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
796 {"zrem",zremCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
797 {"zremrangebyscore",zremrangebyscoreCommand,4,REDIS_CMD_INLINE,NULL,1,1,1},
798 {"zremrangebyrank",zremrangebyrankCommand,4,REDIS_CMD_INLINE,NULL,1,1,1},
799 {"zunionstore",zunionstoreCommand,-4,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,zunionInterBlockClientOnSwappedKeys,0,0,0},
800 {"zinterstore",zinterstoreCommand,-4,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,zunionInterBlockClientOnSwappedKeys,0,0,0},
801 {"zrange",zrangeCommand,-4,REDIS_CMD_INLINE,NULL,1,1,1},
802 {"zrangebyscore",zrangebyscoreCommand,-4,REDIS_CMD_INLINE,NULL,1,1,1},
803 {"zcount",zcountCommand,4,REDIS_CMD_INLINE,NULL,1,1,1},
804 {"zrevrange",zrevrangeCommand,-4,REDIS_CMD_INLINE,NULL,1,1,1},
805 {"zcard",zcardCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
806 {"zscore",zscoreCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
807 {"zrank",zrankCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
808 {"zrevrank",zrevrankCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
809 {"hset",hsetCommand,4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
810 {"hsetnx",hsetnxCommand,4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
811 {"hget",hgetCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
812 {"hmset",hmsetCommand,-4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
813 {"hmget",hmgetCommand,-3,REDIS_CMD_BULK,NULL,1,1,1},
814 {"hincrby",hincrbyCommand,4,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,1,1},
815 {"hdel",hdelCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
816 {"hlen",hlenCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
817 {"hkeys",hkeysCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
818 {"hvals",hvalsCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
819 {"hgetall",hgetallCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
820 {"hexists",hexistsCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
821 {"incrby",incrbyCommand,3,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,1,1},
822 {"decrby",decrbyCommand,3,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,1,1},
823 {"getset",getsetCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
824 {"mset",msetCommand,-3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,-1,2},
825 {"msetnx",msetnxCommand,-3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,-1,2},
826 {"randomkey",randomkeyCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
827 {"select",selectCommand,2,REDIS_CMD_INLINE,NULL,0,0,0},
828 {"move",moveCommand,3,REDIS_CMD_INLINE,NULL,1,1,1},
829 {"rename",renameCommand,3,REDIS_CMD_INLINE,NULL,1,1,1},
830 {"renamenx",renamenxCommand,3,REDIS_CMD_INLINE,NULL,1,1,1},
831 {"expire",expireCommand,3,REDIS_CMD_INLINE,NULL,0,0,0},
832 {"expireat",expireatCommand,3,REDIS_CMD_INLINE,NULL,0,0,0},
833 {"keys",keysCommand,2,REDIS_CMD_INLINE,NULL,0,0,0},
834 {"dbsize",dbsizeCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
835 {"auth",authCommand,2,REDIS_CMD_INLINE,NULL,0,0,0},
836 {"ping",pingCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
837 {"echo",echoCommand,2,REDIS_CMD_BULK,NULL,0,0,0},
838 {"save",saveCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
839 {"bgsave",bgsaveCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
840 {"bgrewriteaof",bgrewriteaofCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
841 {"shutdown",shutdownCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
842 {"lastsave",lastsaveCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
843 {"type",typeCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
844 {"multi",multiCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
845 {"exec",execCommand,1,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,execBlockClientOnSwappedKeys,0,0,0},
846 {"discard",discardCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
847 {"sync",syncCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
848 {"flushdb",flushdbCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
849 {"flushall",flushallCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
850 {"sort",sortCommand,-2,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,1,1},
851 {"info",infoCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
852 {"monitor",monitorCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
853 {"ttl",ttlCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
854 {"slaveof",slaveofCommand,3,REDIS_CMD_INLINE,NULL,0,0,0},
855 {"debug",debugCommand,-2,REDIS_CMD_INLINE,NULL,0,0,0},
856 {"config",configCommand,-2,REDIS_CMD_BULK,NULL,0,0,0},
857 {"subscribe",subscribeCommand,-2,REDIS_CMD_INLINE,NULL,0,0,0},
858 {"unsubscribe",unsubscribeCommand,-1,REDIS_CMD_INLINE,NULL,0,0,0},
859 {"psubscribe",psubscribeCommand,-2,REDIS_CMD_INLINE,NULL,0,0,0},
860 {"punsubscribe",punsubscribeCommand,-1,REDIS_CMD_INLINE,NULL,0,0,0},
861 {"publish",publishCommand,3,REDIS_CMD_BULK|REDIS_CMD_FORCE_REPLICATION,NULL,0,0,0},
862 {"watch",watchCommand,-2,REDIS_CMD_INLINE,NULL,0,0,0},
863 {"unwatch",unwatchCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
864 {NULL,NULL,0,0,NULL,0,0,0}
865 };
866
867 /*============================ Utility functions ============================ */
868
869 /* Glob-style pattern matching. */
870 static int stringmatchlen(const char *pattern, int patternLen,
871 const char *string, int stringLen, int nocase)
872 {
873 while(patternLen) {
874 switch(pattern[0]) {
875 case '*':
876 while (pattern[1] == '*') {
877 pattern++;
878 patternLen--;
879 }
880 if (patternLen == 1)
881 return 1; /* match */
882 while(stringLen) {
883 if (stringmatchlen(pattern+1, patternLen-1,
884 string, stringLen, nocase))
885 return 1; /* match */
886 string++;
887 stringLen--;
888 }
889 return 0; /* no match */
890 break;
891 case '?':
892 if (stringLen == 0)
893 return 0; /* no match */
894 string++;
895 stringLen--;
896 break;
897 case '[':
898 {
899 int not, match;
900
901 pattern++;
902 patternLen--;
903 not = pattern[0] == '^';
904 if (not) {
905 pattern++;
906 patternLen--;
907 }
908 match = 0;
909 while(1) {
910 if (pattern[0] == '\\') {
911 pattern++;
912 patternLen--;
913 if (pattern[0] == string[0])
914 match = 1;
915 } else if (pattern[0] == ']') {
916 break;
917 } else if (patternLen == 0) {
918 pattern--;
919 patternLen++;
920 break;
921 } else if (pattern[1] == '-' && patternLen >= 3) {
922 int start = pattern[0];
923 int end = pattern[2];
924 int c = string[0];
925 if (start > end) {
926 int t = start;
927 start = end;
928 end = t;
929 }
930 if (nocase) {
931 start = tolower(start);
932 end = tolower(end);
933 c = tolower(c);
934 }
935 pattern += 2;
936 patternLen -= 2;
937 if (c >= start && c <= end)
938 match = 1;
939 } else {
940 if (!nocase) {
941 if (pattern[0] == string[0])
942 match = 1;
943 } else {
944 if (tolower((int)pattern[0]) == tolower((int)string[0]))
945 match = 1;
946 }
947 }
948 pattern++;
949 patternLen--;
950 }
951 if (not)
952 match = !match;
953 if (!match)
954 return 0; /* no match */
955 string++;
956 stringLen--;
957 break;
958 }
959 case '\\':
960 if (patternLen >= 2) {
961 pattern++;
962 patternLen--;
963 }
964 /* fall through */
965 default:
966 if (!nocase) {
967 if (pattern[0] != string[0])
968 return 0; /* no match */
969 } else {
970 if (tolower((int)pattern[0]) != tolower((int)string[0]))
971 return 0; /* no match */
972 }
973 string++;
974 stringLen--;
975 break;
976 }
977 pattern++;
978 patternLen--;
979 if (stringLen == 0) {
980 while(*pattern == '*') {
981 pattern++;
982 patternLen--;
983 }
984 break;
985 }
986 }
987 if (patternLen == 0 && stringLen == 0)
988 return 1;
989 return 0;
990 }
991
992 static int stringmatch(const char *pattern, const char *string, int nocase) {
993 return stringmatchlen(pattern,strlen(pattern),string,strlen(string),nocase);
994 }
995
996 /* Convert a string representing an amount of memory into the number of
997 * bytes, so for instance memtoll("1Gi") will return 1073741824 that is
998 * (1024*1024*1024).
999 *
1000 * On parsing error, if *err is not NULL, it's set to 1, otherwise it's
1001 * set to 0 */
1002 static long long memtoll(const char *p, int *err) {
1003 const char *u;
1004 char buf[128];
1005 long mul; /* unit multiplier */
1006 long long val;
1007 unsigned int digits;
1008
1009 if (err) *err = 0;
1010 /* Search the first non digit character. */
1011 u = p;
1012 if (*u == '-') u++;
1013 while(*u && isdigit(*u)) u++;
1014 if (*u == '\0' || !strcasecmp(u,"b")) {
1015 mul = 1;
1016 } else if (!strcasecmp(u,"k")) {
1017 mul = 1000;
1018 } else if (!strcasecmp(u,"kb")) {
1019 mul = 1024;
1020 } else if (!strcasecmp(u,"m")) {
1021 mul = 1000*1000;
1022 } else if (!strcasecmp(u,"mb")) {
1023 mul = 1024*1024;
1024 } else if (!strcasecmp(u,"g")) {
1025 mul = 1000L*1000*1000;
1026 } else if (!strcasecmp(u,"gb")) {
1027 mul = 1024L*1024*1024;
1028 } else {
1029 if (err) *err = 1;
1030 mul = 1;
1031 }
1032 digits = u-p;
1033 if (digits >= sizeof(buf)) {
1034 if (err) *err = 1;
1035 return LLONG_MAX;
1036 }
1037 memcpy(buf,p,digits);
1038 buf[digits] = '\0';
1039 val = strtoll(buf,NULL,10);
1040 return val*mul;
1041 }
1042
1043 /* Convert a long long into a string. Returns the number of
1044 * characters needed to represent the number, that can be shorter if passed
1045 * buffer length is not enough to store the whole number. */
1046 static int ll2string(char *s, size_t len, long long value) {
1047 char buf[32], *p;
1048 unsigned long long v;
1049 size_t l;
1050
1051 if (len == 0) return 0;
1052 v = (value < 0) ? -value : value;
1053 p = buf+31; /* point to the last character */
1054 do {
1055 *p-- = '0'+(v%10);
1056 v /= 10;
1057 } while(v);
1058 if (value < 0) *p-- = '-';
1059 p++;
1060 l = 32-(p-buf);
1061 if (l+1 > len) l = len-1; /* Make sure it fits, including the nul term */
1062 memcpy(s,p,l);
1063 s[l] = '\0';
1064 return l;
1065 }
1066
1067 static void redisLog(int level, const char *fmt, ...) {
1068 va_list ap;
1069 FILE *fp;
1070
1071 fp = (server.logfile == NULL) ? stdout : fopen(server.logfile,"a");
1072 if (!fp) return;
1073
1074 va_start(ap, fmt);
1075 if (level >= server.verbosity) {
1076 char *c = ".-*#";
1077 char buf[64];
1078 time_t now;
1079
1080 now = time(NULL);
1081 strftime(buf,64,"%d %b %H:%M:%S",localtime(&now));
1082 fprintf(fp,"[%d] %s %c ",(int)getpid(),buf,c[level]);
1083 vfprintf(fp, fmt, ap);
1084 fprintf(fp,"\n");
1085 fflush(fp);
1086 }
1087 va_end(ap);
1088
1089 if (server.logfile) fclose(fp);
1090 }
1091
1092 /*====================== Hash table type implementation ==================== */
1093
1094 /* This is an hash table type that uses the SDS dynamic strings libary as
1095 * keys and radis objects as values (objects can hold SDS strings,
1096 * lists, sets). */
1097
1098 static void dictVanillaFree(void *privdata, void *val)
1099 {
1100 DICT_NOTUSED(privdata);
1101 zfree(val);
1102 }
1103
1104 static void dictListDestructor(void *privdata, void *val)
1105 {
1106 DICT_NOTUSED(privdata);
1107 listRelease((list*)val);
1108 }
1109
1110 static int sdsDictKeyCompare(void *privdata, const void *key1,
1111 const void *key2)
1112 {
1113 int l1,l2;
1114 DICT_NOTUSED(privdata);
1115
1116 l1 = sdslen((sds)key1);
1117 l2 = sdslen((sds)key2);
1118 if (l1 != l2) return 0;
1119 return memcmp(key1, key2, l1) == 0;
1120 }
1121
1122 static void dictRedisObjectDestructor(void *privdata, void *val)
1123 {
1124 DICT_NOTUSED(privdata);
1125
1126 if (val == NULL) return; /* Values of swapped out keys as set to NULL */
1127 decrRefCount(val);
1128 }
1129
1130 static int dictObjKeyCompare(void *privdata, const void *key1,
1131 const void *key2)
1132 {
1133 const robj *o1 = key1, *o2 = key2;
1134 return sdsDictKeyCompare(privdata,o1->ptr,o2->ptr);
1135 }
1136
1137 static unsigned int dictObjHash(const void *key) {
1138 const robj *o = key;
1139 return dictGenHashFunction(o->ptr, sdslen((sds)o->ptr));
1140 }
1141
1142 static int dictEncObjKeyCompare(void *privdata, const void *key1,
1143 const void *key2)
1144 {
1145 robj *o1 = (robj*) key1, *o2 = (robj*) key2;
1146 int cmp;
1147
1148 if (o1->encoding == REDIS_ENCODING_INT &&
1149 o2->encoding == REDIS_ENCODING_INT)
1150 return o1->ptr == o2->ptr;
1151
1152 o1 = getDecodedObject(o1);
1153 o2 = getDecodedObject(o2);
1154 cmp = sdsDictKeyCompare(privdata,o1->ptr,o2->ptr);
1155 decrRefCount(o1);
1156 decrRefCount(o2);
1157 return cmp;
1158 }
1159
1160 static unsigned int dictEncObjHash(const void *key) {
1161 robj *o = (robj*) key;
1162
1163 if (o->encoding == REDIS_ENCODING_RAW) {
1164 return dictGenHashFunction(o->ptr, sdslen((sds)o->ptr));
1165 } else {
1166 if (o->encoding == REDIS_ENCODING_INT) {
1167 char buf[32];
1168 int len;
1169
1170 len = ll2string(buf,32,(long)o->ptr);
1171 return dictGenHashFunction((unsigned char*)buf, len);
1172 } else {
1173 unsigned int hash;
1174
1175 o = getDecodedObject(o);
1176 hash = dictGenHashFunction(o->ptr, sdslen((sds)o->ptr));
1177 decrRefCount(o);
1178 return hash;
1179 }
1180 }
1181 }
1182
1183 /* Sets type and expires */
1184 static dictType setDictType = {
1185 dictEncObjHash, /* hash function */
1186 NULL, /* key dup */
1187 NULL, /* val dup */
1188 dictEncObjKeyCompare, /* key compare */
1189 dictRedisObjectDestructor, /* key destructor */
1190 NULL /* val destructor */
1191 };
1192
1193 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
1194 static dictType zsetDictType = {
1195 dictEncObjHash, /* hash function */
1196 NULL, /* key dup */
1197 NULL, /* val dup */
1198 dictEncObjKeyCompare, /* key compare */
1199 dictRedisObjectDestructor, /* key destructor */
1200 dictVanillaFree /* val destructor of malloc(sizeof(double)) */
1201 };
1202
1203 /* Db->dict */
1204 static dictType dbDictType = {
1205 dictObjHash, /* hash function */
1206 NULL, /* key dup */
1207 NULL, /* val dup */
1208 dictObjKeyCompare, /* key compare */
1209 dictRedisObjectDestructor, /* key destructor */
1210 dictRedisObjectDestructor /* val destructor */
1211 };
1212
1213 /* Db->expires */
1214 static dictType keyptrDictType = {
1215 dictObjHash, /* hash function */
1216 NULL, /* key dup */
1217 NULL, /* val dup */
1218 dictObjKeyCompare, /* key compare */
1219 dictRedisObjectDestructor, /* key destructor */
1220 NULL /* val destructor */
1221 };
1222
1223 /* Hash type hash table (note that small hashes are represented with zimpaps) */
1224 static dictType hashDictType = {
1225 dictEncObjHash, /* hash function */
1226 NULL, /* key dup */
1227 NULL, /* val dup */
1228 dictEncObjKeyCompare, /* key compare */
1229 dictRedisObjectDestructor, /* key destructor */
1230 dictRedisObjectDestructor /* val destructor */
1231 };
1232
1233 /* Keylist hash table type has unencoded redis objects as keys and
1234 * lists as values. It's used for blocking operations (BLPOP) and to
1235 * map swapped keys to a list of clients waiting for this keys to be loaded. */
1236 static dictType keylistDictType = {
1237 dictObjHash, /* hash function */
1238 NULL, /* key dup */
1239 NULL, /* val dup */
1240 dictObjKeyCompare, /* key compare */
1241 dictRedisObjectDestructor, /* key destructor */
1242 dictListDestructor /* val destructor */
1243 };
1244
1245 static void version();
1246
1247 /* ========================= Random utility functions ======================= */
1248
1249 /* Redis generally does not try to recover from out of memory conditions
1250 * when allocating objects or strings, it is not clear if it will be possible
1251 * to report this condition to the client since the networking layer itself
1252 * is based on heap allocation for send buffers, so we simply abort.
1253 * At least the code will be simpler to read... */
1254 static void oom(const char *msg) {
1255 redisLog(REDIS_WARNING, "%s: Out of memory\n",msg);
1256 sleep(1);
1257 abort();
1258 }
1259
1260 /* ====================== Redis server networking stuff ===================== */
1261 static void closeTimedoutClients(void) {
1262 redisClient *c;
1263 listNode *ln;
1264 time_t now = time(NULL);
1265 listIter li;
1266
1267 listRewind(server.clients,&li);
1268 while ((ln = listNext(&li)) != NULL) {
1269 c = listNodeValue(ln);
1270 if (server.maxidletime &&
1271 !(c->flags & REDIS_SLAVE) && /* no timeout for slaves */
1272 !(c->flags & REDIS_MASTER) && /* no timeout for masters */
1273 dictSize(c->pubsub_channels) == 0 && /* no timeout for pubsub */
1274 listLength(c->pubsub_patterns) == 0 &&
1275 (now - c->lastinteraction > server.maxidletime))
1276 {
1277 redisLog(REDIS_VERBOSE,"Closing idle client");
1278 freeClient(c);
1279 } else if (c->flags & REDIS_BLOCKED) {
1280 if (c->blockingto != 0 && c->blockingto < now) {
1281 addReply(c,shared.nullmultibulk);
1282 unblockClientWaitingData(c);
1283 }
1284 }
1285 }
1286 }
1287
1288 static int htNeedsResize(dict *dict) {
1289 long long size, used;
1290
1291 size = dictSlots(dict);
1292 used = dictSize(dict);
1293 return (size && used && size > DICT_HT_INITIAL_SIZE &&
1294 (used*100/size < REDIS_HT_MINFILL));
1295 }
1296
1297 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
1298 * we resize the hash table to save memory */
1299 static void tryResizeHashTables(void) {
1300 int j;
1301
1302 for (j = 0; j < server.dbnum; j++) {
1303 if (htNeedsResize(server.db[j].dict))
1304 dictResize(server.db[j].dict);
1305 if (htNeedsResize(server.db[j].expires))
1306 dictResize(server.db[j].expires);
1307 }
1308 }
1309
1310 /* Our hash table implementation performs rehashing incrementally while
1311 * we write/read from the hash table. Still if the server is idle, the hash
1312 * table will use two tables for a long time. So we try to use 1 millisecond
1313 * of CPU time at every serverCron() loop in order to rehash some key. */
1314 static void incrementallyRehash(void) {
1315 int j;
1316
1317 for (j = 0; j < server.dbnum; j++) {
1318 if (dictIsRehashing(server.db[j].dict)) {
1319 dictRehashMilliseconds(server.db[j].dict,1);
1320 break; /* already used our millisecond for this loop... */
1321 }
1322 }
1323 }
1324
1325 /* A background saving child (BGSAVE) terminated its work. Handle this. */
1326 void backgroundSaveDoneHandler(int statloc) {
1327 int exitcode = WEXITSTATUS(statloc);
1328 int bysignal = WIFSIGNALED(statloc);
1329
1330 if (!bysignal && exitcode == 0) {
1331 redisLog(REDIS_NOTICE,
1332 "Background saving terminated with success");
1333 server.dirty = 0;
1334 server.lastsave = time(NULL);
1335 } else if (!bysignal && exitcode != 0) {
1336 redisLog(REDIS_WARNING, "Background saving error");
1337 } else {
1338 redisLog(REDIS_WARNING,
1339 "Background saving terminated by signal %d", WTERMSIG(statloc));
1340 rdbRemoveTempFile(server.bgsavechildpid);
1341 }
1342 server.bgsavechildpid = -1;
1343 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1344 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1345 updateSlavesWaitingBgsave(exitcode == 0 ? REDIS_OK : REDIS_ERR);
1346 }
1347
1348 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1349 * Handle this. */
1350 void backgroundRewriteDoneHandler(int statloc) {
1351 int exitcode = WEXITSTATUS(statloc);
1352 int bysignal = WIFSIGNALED(statloc);
1353
1354 if (!bysignal && exitcode == 0) {
1355 int fd;
1356 char tmpfile[256];
1357
1358 redisLog(REDIS_NOTICE,
1359 "Background append only file rewriting terminated with success");
1360 /* Now it's time to flush the differences accumulated by the parent */
1361 snprintf(tmpfile,256,"temp-rewriteaof-bg-%d.aof", (int) server.bgrewritechildpid);
1362 fd = open(tmpfile,O_WRONLY|O_APPEND);
1363 if (fd == -1) {
1364 redisLog(REDIS_WARNING, "Not able to open the temp append only file produced by the child: %s", strerror(errno));
1365 goto cleanup;
1366 }
1367 /* Flush our data... */
1368 if (write(fd,server.bgrewritebuf,sdslen(server.bgrewritebuf)) !=
1369 (signed) sdslen(server.bgrewritebuf)) {
1370 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));
1371 close(fd);
1372 goto cleanup;
1373 }
1374 redisLog(REDIS_NOTICE,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server.bgrewritebuf));
1375 /* Now our work is to rename the temp file into the stable file. And
1376 * switch the file descriptor used by the server for append only. */
1377 if (rename(tmpfile,server.appendfilename) == -1) {
1378 redisLog(REDIS_WARNING,"Can't rename the temp append only file into the stable one: %s", strerror(errno));
1379 close(fd);
1380 goto cleanup;
1381 }
1382 /* Mission completed... almost */
1383 redisLog(REDIS_NOTICE,"Append only file successfully rewritten.");
1384 if (server.appendfd != -1) {
1385 /* If append only is actually enabled... */
1386 close(server.appendfd);
1387 server.appendfd = fd;
1388 fsync(fd);
1389 server.appendseldb = -1; /* Make sure it will issue SELECT */
1390 redisLog(REDIS_NOTICE,"The new append only file was selected for future appends.");
1391 } else {
1392 /* If append only is disabled we just generate a dump in this
1393 * format. Why not? */
1394 close(fd);
1395 }
1396 } else if (!bysignal && exitcode != 0) {
1397 redisLog(REDIS_WARNING, "Background append only file rewriting error");
1398 } else {
1399 redisLog(REDIS_WARNING,
1400 "Background append only file rewriting terminated by signal %d",
1401 WTERMSIG(statloc));
1402 }
1403 cleanup:
1404 sdsfree(server.bgrewritebuf);
1405 server.bgrewritebuf = sdsempty();
1406 aofRemoveTempFile(server.bgrewritechildpid);
1407 server.bgrewritechildpid = -1;
1408 }
1409
1410 /* This function is called once a background process of some kind terminates,
1411 * as we want to avoid resizing the hash tables when there is a child in order
1412 * to play well with copy-on-write (otherwise when a resize happens lots of
1413 * memory pages are copied). The goal of this function is to update the ability
1414 * for dict.c to resize the hash tables accordingly to the fact we have o not
1415 * running childs. */
1416 static void updateDictResizePolicy(void) {
1417 if (server.bgsavechildpid == -1 && server.bgrewritechildpid == -1)
1418 dictEnableResize();
1419 else
1420 dictDisableResize();
1421 }
1422
1423 static int serverCron(struct aeEventLoop *eventLoop, long long id, void *clientData) {
1424 int j, loops = server.cronloops++;
1425 REDIS_NOTUSED(eventLoop);
1426 REDIS_NOTUSED(id);
1427 REDIS_NOTUSED(clientData);
1428
1429 /* We take a cached value of the unix time in the global state because
1430 * with virtual memory and aging there is to store the current time
1431 * in objects at every object access, and accuracy is not needed.
1432 * To access a global var is faster than calling time(NULL) */
1433 server.unixtime = time(NULL);
1434
1435 /* We received a SIGTERM, shutting down here in a safe way, as it is
1436 * not ok doing so inside the signal handler. */
1437 if (server.shutdown_asap) {
1438 if (prepareForShutdown() == REDIS_OK) exit(0);
1439 redisLog(REDIS_WARNING,"SIGTERM received but errors trying to shut down the server, check the logs for more information");
1440 }
1441
1442 /* Show some info about non-empty databases */
1443 for (j = 0; j < server.dbnum; j++) {
1444 long long size, used, vkeys;
1445
1446 size = dictSlots(server.db[j].dict);
1447 used = dictSize(server.db[j].dict);
1448 vkeys = dictSize(server.db[j].expires);
1449 if (!(loops % 50) && (used || vkeys)) {
1450 redisLog(REDIS_VERBOSE,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j,used,vkeys,size);
1451 /* dictPrintStats(server.dict); */
1452 }
1453 }
1454
1455 /* We don't want to resize the hash tables while a bacground saving
1456 * is in progress: the saving child is created using fork() that is
1457 * implemented with a copy-on-write semantic in most modern systems, so
1458 * if we resize the HT while there is the saving child at work actually
1459 * a lot of memory movements in the parent will cause a lot of pages
1460 * copied. */
1461 if (server.bgsavechildpid == -1 && server.bgrewritechildpid == -1) {
1462 if (!(loops % 10)) tryResizeHashTables();
1463 if (server.activerehashing) incrementallyRehash();
1464 }
1465
1466 /* Show information about connected clients */
1467 if (!(loops % 50)) {
1468 redisLog(REDIS_VERBOSE,"%d clients connected (%d slaves), %zu bytes in use",
1469 listLength(server.clients)-listLength(server.slaves),
1470 listLength(server.slaves),
1471 zmalloc_used_memory());
1472 }
1473
1474 /* Close connections of timedout clients */
1475 if ((server.maxidletime && !(loops % 100)) || server.blpop_blocked_clients)
1476 closeTimedoutClients();
1477
1478 /* Check if a background saving or AOF rewrite in progress terminated */
1479 if (server.bgsavechildpid != -1 || server.bgrewritechildpid != -1) {
1480 int statloc;
1481 pid_t pid;
1482
1483 if ((pid = wait3(&statloc,WNOHANG,NULL)) != 0) {
1484 if (pid == server.bgsavechildpid) {
1485 backgroundSaveDoneHandler(statloc);
1486 } else {
1487 backgroundRewriteDoneHandler(statloc);
1488 }
1489 updateDictResizePolicy();
1490 }
1491 } else {
1492 /* If there is not a background saving in progress check if
1493 * we have to save now */
1494 time_t now = time(NULL);
1495 for (j = 0; j < server.saveparamslen; j++) {
1496 struct saveparam *sp = server.saveparams+j;
1497
1498 if (server.dirty >= sp->changes &&
1499 now-server.lastsave > sp->seconds) {
1500 redisLog(REDIS_NOTICE,"%d changes in %d seconds. Saving...",
1501 sp->changes, sp->seconds);
1502 rdbSaveBackground(server.dbfilename);
1503 break;
1504 }
1505 }
1506 }
1507
1508 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1509 * will use few CPU cycles if there are few expiring keys, otherwise
1510 * it will get more aggressive to avoid that too much memory is used by
1511 * keys that can be removed from the keyspace. */
1512 for (j = 0; j < server.dbnum; j++) {
1513 int expired;
1514 redisDb *db = server.db+j;
1515
1516 /* Continue to expire if at the end of the cycle more than 25%
1517 * of the keys were expired. */
1518 do {
1519 long num = dictSize(db->expires);
1520 time_t now = time(NULL);
1521
1522 expired = 0;
1523 if (num > REDIS_EXPIRELOOKUPS_PER_CRON)
1524 num = REDIS_EXPIRELOOKUPS_PER_CRON;
1525 while (num--) {
1526 dictEntry *de;
1527 time_t t;
1528
1529 if ((de = dictGetRandomKey(db->expires)) == NULL) break;
1530 t = (time_t) dictGetEntryVal(de);
1531 if (now > t) {
1532 deleteKey(db,dictGetEntryKey(de));
1533 expired++;
1534 server.stat_expiredkeys++;
1535 }
1536 }
1537 } while (expired > REDIS_EXPIRELOOKUPS_PER_CRON/4);
1538 }
1539
1540 /* Swap a few keys on disk if we are over the memory limit and VM
1541 * is enbled. Try to free objects from the free list first. */
1542 if (vmCanSwapOut()) {
1543 while (server.vm_enabled && zmalloc_used_memory() >
1544 server.vm_max_memory)
1545 {
1546 int retval;
1547
1548 if (tryFreeOneObjectFromFreelist() == REDIS_OK) continue;
1549 retval = (server.vm_max_threads == 0) ?
1550 vmSwapOneObjectBlocking() :
1551 vmSwapOneObjectThreaded();
1552 if (retval == REDIS_ERR && !(loops % 300) &&
1553 zmalloc_used_memory() >
1554 (server.vm_max_memory+server.vm_max_memory/10))
1555 {
1556 redisLog(REDIS_WARNING,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1557 }
1558 /* Note that when using threade I/O we free just one object,
1559 * because anyway when the I/O thread in charge to swap this
1560 * object out will finish, the handler of completed jobs
1561 * will try to swap more objects if we are still out of memory. */
1562 if (retval == REDIS_ERR || server.vm_max_threads > 0) break;
1563 }
1564 }
1565
1566 /* Check if we should connect to a MASTER */
1567 if (server.replstate == REDIS_REPL_CONNECT && !(loops % 10)) {
1568 redisLog(REDIS_NOTICE,"Connecting to MASTER...");
1569 if (syncWithMaster() == REDIS_OK) {
1570 redisLog(REDIS_NOTICE,"MASTER <-> SLAVE sync succeeded");
1571 if (server.appendonly) rewriteAppendOnlyFileBackground();
1572 }
1573 }
1574 return 100;
1575 }
1576
1577 /* This function gets called every time Redis is entering the
1578 * main loop of the event driven library, that is, before to sleep
1579 * for ready file descriptors. */
1580 static void beforeSleep(struct aeEventLoop *eventLoop) {
1581 REDIS_NOTUSED(eventLoop);
1582
1583 /* Awake clients that got all the swapped keys they requested */
1584 if (server.vm_enabled && listLength(server.io_ready_clients)) {
1585 listIter li;
1586 listNode *ln;
1587
1588 listRewind(server.io_ready_clients,&li);
1589 while((ln = listNext(&li))) {
1590 redisClient *c = ln->value;
1591 struct redisCommand *cmd;
1592
1593 /* Resume the client. */
1594 listDelNode(server.io_ready_clients,ln);
1595 c->flags &= (~REDIS_IO_WAIT);
1596 server.vm_blocked_clients--;
1597 aeCreateFileEvent(server.el, c->fd, AE_READABLE,
1598 readQueryFromClient, c);
1599 cmd = lookupCommand(c->argv[0]->ptr);
1600 assert(cmd != NULL);
1601 call(c,cmd);
1602 resetClient(c);
1603 /* There may be more data to process in the input buffer. */
1604 if (c->querybuf && sdslen(c->querybuf) > 0)
1605 processInputBuffer(c);
1606 }
1607 }
1608 /* Write the AOF buffer on disk */
1609 flushAppendOnlyFile();
1610 }
1611
1612 static void createSharedObjects(void) {
1613 int j;
1614
1615 shared.crlf = createObject(REDIS_STRING,sdsnew("\r\n"));
1616 shared.ok = createObject(REDIS_STRING,sdsnew("+OK\r\n"));
1617 shared.err = createObject(REDIS_STRING,sdsnew("-ERR\r\n"));
1618 shared.emptybulk = createObject(REDIS_STRING,sdsnew("$0\r\n\r\n"));
1619 shared.czero = createObject(REDIS_STRING,sdsnew(":0\r\n"));
1620 shared.cone = createObject(REDIS_STRING,sdsnew(":1\r\n"));
1621 shared.nullbulk = createObject(REDIS_STRING,sdsnew("$-1\r\n"));
1622 shared.nullmultibulk = createObject(REDIS_STRING,sdsnew("*-1\r\n"));
1623 shared.emptymultibulk = createObject(REDIS_STRING,sdsnew("*0\r\n"));
1624 shared.pong = createObject(REDIS_STRING,sdsnew("+PONG\r\n"));
1625 shared.queued = createObject(REDIS_STRING,sdsnew("+QUEUED\r\n"));
1626 shared.wrongtypeerr = createObject(REDIS_STRING,sdsnew(
1627 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1628 shared.nokeyerr = createObject(REDIS_STRING,sdsnew(
1629 "-ERR no such key\r\n"));
1630 shared.syntaxerr = createObject(REDIS_STRING,sdsnew(
1631 "-ERR syntax error\r\n"));
1632 shared.sameobjecterr = createObject(REDIS_STRING,sdsnew(
1633 "-ERR source and destination objects are the same\r\n"));
1634 shared.outofrangeerr = createObject(REDIS_STRING,sdsnew(
1635 "-ERR index out of range\r\n"));
1636 shared.space = createObject(REDIS_STRING,sdsnew(" "));
1637 shared.colon = createObject(REDIS_STRING,sdsnew(":"));
1638 shared.plus = createObject(REDIS_STRING,sdsnew("+"));
1639 shared.select0 = createStringObject("select 0\r\n",10);
1640 shared.select1 = createStringObject("select 1\r\n",10);
1641 shared.select2 = createStringObject("select 2\r\n",10);
1642 shared.select3 = createStringObject("select 3\r\n",10);
1643 shared.select4 = createStringObject("select 4\r\n",10);
1644 shared.select5 = createStringObject("select 5\r\n",10);
1645 shared.select6 = createStringObject("select 6\r\n",10);
1646 shared.select7 = createStringObject("select 7\r\n",10);
1647 shared.select8 = createStringObject("select 8\r\n",10);
1648 shared.select9 = createStringObject("select 9\r\n",10);
1649 shared.messagebulk = createStringObject("$7\r\nmessage\r\n",13);
1650 shared.pmessagebulk = createStringObject("$8\r\npmessage\r\n",14);
1651 shared.subscribebulk = createStringObject("$9\r\nsubscribe\r\n",15);
1652 shared.unsubscribebulk = createStringObject("$11\r\nunsubscribe\r\n",18);
1653 shared.psubscribebulk = createStringObject("$10\r\npsubscribe\r\n",17);
1654 shared.punsubscribebulk = createStringObject("$12\r\npunsubscribe\r\n",19);
1655 shared.mbulk3 = createStringObject("*3\r\n",4);
1656 shared.mbulk4 = createStringObject("*4\r\n",4);
1657 for (j = 0; j < REDIS_SHARED_INTEGERS; j++) {
1658 shared.integers[j] = createObject(REDIS_STRING,(void*)(long)j);
1659 shared.integers[j]->encoding = REDIS_ENCODING_INT;
1660 }
1661 }
1662
1663 static void appendServerSaveParams(time_t seconds, int changes) {
1664 server.saveparams = zrealloc(server.saveparams,sizeof(struct saveparam)*(server.saveparamslen+1));
1665 server.saveparams[server.saveparamslen].seconds = seconds;
1666 server.saveparams[server.saveparamslen].changes = changes;
1667 server.saveparamslen++;
1668 }
1669
1670 static void resetServerSaveParams() {
1671 zfree(server.saveparams);
1672 server.saveparams = NULL;
1673 server.saveparamslen = 0;
1674 }
1675
1676 static void initServerConfig() {
1677 server.dbnum = REDIS_DEFAULT_DBNUM;
1678 server.port = REDIS_SERVERPORT;
1679 server.verbosity = REDIS_VERBOSE;
1680 server.maxidletime = REDIS_MAXIDLETIME;
1681 server.saveparams = NULL;
1682 server.logfile = NULL; /* NULL = log on standard output */
1683 server.bindaddr = NULL;
1684 server.glueoutputbuf = 1;
1685 server.daemonize = 0;
1686 server.appendonly = 0;
1687 server.appendfsync = APPENDFSYNC_EVERYSEC;
1688 server.lastfsync = time(NULL);
1689 server.appendfd = -1;
1690 server.appendseldb = -1; /* Make sure the first time will not match */
1691 server.pidfile = zstrdup("/var/run/redis.pid");
1692 server.dbfilename = zstrdup("dump.rdb");
1693 server.appendfilename = zstrdup("appendonly.aof");
1694 server.requirepass = NULL;
1695 server.rdbcompression = 1;
1696 server.activerehashing = 1;
1697 server.maxclients = 0;
1698 server.blpop_blocked_clients = 0;
1699 server.maxmemory = 0;
1700 server.vm_enabled = 0;
1701 server.vm_swap_file = zstrdup("/tmp/redis-%p.vm");
1702 server.vm_page_size = 256; /* 256 bytes per page */
1703 server.vm_pages = 1024*1024*100; /* 104 millions of pages */
1704 server.vm_max_memory = 1024LL*1024*1024*1; /* 1 GB of RAM */
1705 server.vm_max_threads = 4;
1706 server.vm_blocked_clients = 0;
1707 server.hash_max_zipmap_entries = REDIS_HASH_MAX_ZIPMAP_ENTRIES;
1708 server.hash_max_zipmap_value = REDIS_HASH_MAX_ZIPMAP_VALUE;
1709 server.shutdown_asap = 0;
1710
1711 resetServerSaveParams();
1712
1713 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1714 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1715 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1716 /* Replication related */
1717 server.isslave = 0;
1718 server.masterauth = NULL;
1719 server.masterhost = NULL;
1720 server.masterport = 6379;
1721 server.master = NULL;
1722 server.replstate = REDIS_REPL_NONE;
1723
1724 /* Double constants initialization */
1725 R_Zero = 0.0;
1726 R_PosInf = 1.0/R_Zero;
1727 R_NegInf = -1.0/R_Zero;
1728 R_Nan = R_Zero/R_Zero;
1729 }
1730
1731 static void initServer() {
1732 int j;
1733
1734 signal(SIGHUP, SIG_IGN);
1735 signal(SIGPIPE, SIG_IGN);
1736 setupSigSegvAction();
1737
1738 server.devnull = fopen("/dev/null","w");
1739 if (server.devnull == NULL) {
1740 redisLog(REDIS_WARNING, "Can't open /dev/null: %s", server.neterr);
1741 exit(1);
1742 }
1743 server.clients = listCreate();
1744 server.slaves = listCreate();
1745 server.monitors = listCreate();
1746 server.objfreelist = listCreate();
1747 createSharedObjects();
1748 server.el = aeCreateEventLoop();
1749 server.db = zmalloc(sizeof(redisDb)*server.dbnum);
1750 server.fd = anetTcpServer(server.neterr, server.port, server.bindaddr);
1751 if (server.fd == -1) {
1752 redisLog(REDIS_WARNING, "Opening TCP port: %s", server.neterr);
1753 exit(1);
1754 }
1755 for (j = 0; j < server.dbnum; j++) {
1756 server.db[j].dict = dictCreate(&dbDictType,NULL);
1757 server.db[j].expires = dictCreate(&keyptrDictType,NULL);
1758 server.db[j].blocking_keys = dictCreate(&keylistDictType,NULL);
1759 server.db[j].watched_keys = dictCreate(&keylistDictType,NULL);
1760 if (server.vm_enabled)
1761 server.db[j].io_keys = dictCreate(&keylistDictType,NULL);
1762 server.db[j].id = j;
1763 }
1764 server.pubsub_channels = dictCreate(&keylistDictType,NULL);
1765 server.pubsub_patterns = listCreate();
1766 listSetFreeMethod(server.pubsub_patterns,freePubsubPattern);
1767 listSetMatchMethod(server.pubsub_patterns,listMatchPubsubPattern);
1768 server.cronloops = 0;
1769 server.bgsavechildpid = -1;
1770 server.bgrewritechildpid = -1;
1771 server.bgrewritebuf = sdsempty();
1772 server.aofbuf = sdsempty();
1773 server.lastsave = time(NULL);
1774 server.dirty = 0;
1775 server.stat_numcommands = 0;
1776 server.stat_numconnections = 0;
1777 server.stat_expiredkeys = 0;
1778 server.stat_starttime = time(NULL);
1779 server.unixtime = time(NULL);
1780 aeCreateTimeEvent(server.el, 1, serverCron, NULL, NULL);
1781 if (aeCreateFileEvent(server.el, server.fd, AE_READABLE,
1782 acceptHandler, NULL) == AE_ERR) oom("creating file event");
1783
1784 if (server.appendonly) {
1785 server.appendfd = open(server.appendfilename,O_WRONLY|O_APPEND|O_CREAT,0644);
1786 if (server.appendfd == -1) {
1787 redisLog(REDIS_WARNING, "Can't open the append-only file: %s",
1788 strerror(errno));
1789 exit(1);
1790 }
1791 }
1792
1793 if (server.vm_enabled) vmInit();
1794 }
1795
1796 /* Empty the whole database */
1797 static long long emptyDb() {
1798 int j;
1799 long long removed = 0;
1800
1801 for (j = 0; j < server.dbnum; j++) {
1802 removed += dictSize(server.db[j].dict);
1803 dictEmpty(server.db[j].dict);
1804 dictEmpty(server.db[j].expires);
1805 }
1806 return removed;
1807 }
1808
1809 static int yesnotoi(char *s) {
1810 if (!strcasecmp(s,"yes")) return 1;
1811 else if (!strcasecmp(s,"no")) return 0;
1812 else return -1;
1813 }
1814
1815 /* I agree, this is a very rudimental way to load a configuration...
1816 will improve later if the config gets more complex */
1817 static void loadServerConfig(char *filename) {
1818 FILE *fp;
1819 char buf[REDIS_CONFIGLINE_MAX+1], *err = NULL;
1820 int linenum = 0;
1821 sds line = NULL;
1822
1823 if (filename[0] == '-' && filename[1] == '\0')
1824 fp = stdin;
1825 else {
1826 if ((fp = fopen(filename,"r")) == NULL) {
1827 redisLog(REDIS_WARNING, "Fatal error, can't open config file '%s'", filename);
1828 exit(1);
1829 }
1830 }
1831
1832 while(fgets(buf,REDIS_CONFIGLINE_MAX+1,fp) != NULL) {
1833 sds *argv;
1834 int argc, j;
1835
1836 linenum++;
1837 line = sdsnew(buf);
1838 line = sdstrim(line," \t\r\n");
1839
1840 /* Skip comments and blank lines*/
1841 if (line[0] == '#' || line[0] == '\0') {
1842 sdsfree(line);
1843 continue;
1844 }
1845
1846 /* Split into arguments */
1847 argv = sdssplitlen(line,sdslen(line)," ",1,&argc);
1848 sdstolower(argv[0]);
1849
1850 /* Execute config directives */
1851 if (!strcasecmp(argv[0],"timeout") && argc == 2) {
1852 server.maxidletime = atoi(argv[1]);
1853 if (server.maxidletime < 0) {
1854 err = "Invalid timeout value"; goto loaderr;
1855 }
1856 } else if (!strcasecmp(argv[0],"port") && argc == 2) {
1857 server.port = atoi(argv[1]);
1858 if (server.port < 1 || server.port > 65535) {
1859 err = "Invalid port"; goto loaderr;
1860 }
1861 } else if (!strcasecmp(argv[0],"bind") && argc == 2) {
1862 server.bindaddr = zstrdup(argv[1]);
1863 } else if (!strcasecmp(argv[0],"save") && argc == 3) {
1864 int seconds = atoi(argv[1]);
1865 int changes = atoi(argv[2]);
1866 if (seconds < 1 || changes < 0) {
1867 err = "Invalid save parameters"; goto loaderr;
1868 }
1869 appendServerSaveParams(seconds,changes);
1870 } else if (!strcasecmp(argv[0],"dir") && argc == 2) {
1871 if (chdir(argv[1]) == -1) {
1872 redisLog(REDIS_WARNING,"Can't chdir to '%s': %s",
1873 argv[1], strerror(errno));
1874 exit(1);
1875 }
1876 } else if (!strcasecmp(argv[0],"loglevel") && argc == 2) {
1877 if (!strcasecmp(argv[1],"debug")) server.verbosity = REDIS_DEBUG;
1878 else if (!strcasecmp(argv[1],"verbose")) server.verbosity = REDIS_VERBOSE;
1879 else if (!strcasecmp(argv[1],"notice")) server.verbosity = REDIS_NOTICE;
1880 else if (!strcasecmp(argv[1],"warning")) server.verbosity = REDIS_WARNING;
1881 else {
1882 err = "Invalid log level. Must be one of debug, notice, warning";
1883 goto loaderr;
1884 }
1885 } else if (!strcasecmp(argv[0],"logfile") && argc == 2) {
1886 FILE *logfp;
1887
1888 server.logfile = zstrdup(argv[1]);
1889 if (!strcasecmp(server.logfile,"stdout")) {
1890 zfree(server.logfile);
1891 server.logfile = NULL;
1892 }
1893 if (server.logfile) {
1894 /* Test if we are able to open the file. The server will not
1895 * be able to abort just for this problem later... */
1896 logfp = fopen(server.logfile,"a");
1897 if (logfp == NULL) {
1898 err = sdscatprintf(sdsempty(),
1899 "Can't open the log file: %s", strerror(errno));
1900 goto loaderr;
1901 }
1902 fclose(logfp);
1903 }
1904 } else if (!strcasecmp(argv[0],"databases") && argc == 2) {
1905 server.dbnum = atoi(argv[1]);
1906 if (server.dbnum < 1) {
1907 err = "Invalid number of databases"; goto loaderr;
1908 }
1909 } else if (!strcasecmp(argv[0],"include") && argc == 2) {
1910 loadServerConfig(argv[1]);
1911 } else if (!strcasecmp(argv[0],"maxclients") && argc == 2) {
1912 server.maxclients = atoi(argv[1]);
1913 } else if (!strcasecmp(argv[0],"maxmemory") && argc == 2) {
1914 server.maxmemory = memtoll(argv[1],NULL);
1915 } else if (!strcasecmp(argv[0],"slaveof") && argc == 3) {
1916 server.masterhost = sdsnew(argv[1]);
1917 server.masterport = atoi(argv[2]);
1918 server.replstate = REDIS_REPL_CONNECT;
1919 } else if (!strcasecmp(argv[0],"masterauth") && argc == 2) {
1920 server.masterauth = zstrdup(argv[1]);
1921 } else if (!strcasecmp(argv[0],"glueoutputbuf") && argc == 2) {
1922 if ((server.glueoutputbuf = yesnotoi(argv[1])) == -1) {
1923 err = "argument must be 'yes' or 'no'"; goto loaderr;
1924 }
1925 } else if (!strcasecmp(argv[0],"rdbcompression") && argc == 2) {
1926 if ((server.rdbcompression = yesnotoi(argv[1])) == -1) {
1927 err = "argument must be 'yes' or 'no'"; goto loaderr;
1928 }
1929 } else if (!strcasecmp(argv[0],"activerehashing") && argc == 2) {
1930 if ((server.activerehashing = yesnotoi(argv[1])) == -1) {
1931 err = "argument must be 'yes' or 'no'"; goto loaderr;
1932 }
1933 } else if (!strcasecmp(argv[0],"daemonize") && argc == 2) {
1934 if ((server.daemonize = yesnotoi(argv[1])) == -1) {
1935 err = "argument must be 'yes' or 'no'"; goto loaderr;
1936 }
1937 } else if (!strcasecmp(argv[0],"appendonly") && argc == 2) {
1938 if ((server.appendonly = yesnotoi(argv[1])) == -1) {
1939 err = "argument must be 'yes' or 'no'"; goto loaderr;
1940 }
1941 } else if (!strcasecmp(argv[0],"appendfilename") && argc == 2) {
1942 zfree(server.appendfilename);
1943 server.appendfilename = zstrdup(argv[1]);
1944 } else if (!strcasecmp(argv[0],"appendfsync") && argc == 2) {
1945 if (!strcasecmp(argv[1],"no")) {
1946 server.appendfsync = APPENDFSYNC_NO;
1947 } else if (!strcasecmp(argv[1],"always")) {
1948 server.appendfsync = APPENDFSYNC_ALWAYS;
1949 } else if (!strcasecmp(argv[1],"everysec")) {
1950 server.appendfsync = APPENDFSYNC_EVERYSEC;
1951 } else {
1952 err = "argument must be 'no', 'always' or 'everysec'";
1953 goto loaderr;
1954 }
1955 } else if (!strcasecmp(argv[0],"requirepass") && argc == 2) {
1956 server.requirepass = zstrdup(argv[1]);
1957 } else if (!strcasecmp(argv[0],"pidfile") && argc == 2) {
1958 zfree(server.pidfile);
1959 server.pidfile = zstrdup(argv[1]);
1960 } else if (!strcasecmp(argv[0],"dbfilename") && argc == 2) {
1961 zfree(server.dbfilename);
1962 server.dbfilename = zstrdup(argv[1]);
1963 } else if (!strcasecmp(argv[0],"vm-enabled") && argc == 2) {
1964 if ((server.vm_enabled = yesnotoi(argv[1])) == -1) {
1965 err = "argument must be 'yes' or 'no'"; goto loaderr;
1966 }
1967 } else if (!strcasecmp(argv[0],"vm-swap-file") && argc == 2) {
1968 zfree(server.vm_swap_file);
1969 server.vm_swap_file = zstrdup(argv[1]);
1970 } else if (!strcasecmp(argv[0],"vm-max-memory") && argc == 2) {
1971 server.vm_max_memory = memtoll(argv[1],NULL);
1972 } else if (!strcasecmp(argv[0],"vm-page-size") && argc == 2) {
1973 server.vm_page_size = memtoll(argv[1], NULL);
1974 } else if (!strcasecmp(argv[0],"vm-pages") && argc == 2) {
1975 server.vm_pages = memtoll(argv[1], NULL);
1976 } else if (!strcasecmp(argv[0],"vm-max-threads") && argc == 2) {
1977 server.vm_max_threads = strtoll(argv[1], NULL, 10);
1978 } else if (!strcasecmp(argv[0],"hash-max-zipmap-entries") && argc == 2){
1979 server.hash_max_zipmap_entries = memtoll(argv[1], NULL);
1980 } else if (!strcasecmp(argv[0],"hash-max-zipmap-value") && argc == 2){
1981 server.hash_max_zipmap_value = memtoll(argv[1], NULL);
1982 } else {
1983 err = "Bad directive or wrong number of arguments"; goto loaderr;
1984 }
1985 for (j = 0; j < argc; j++)
1986 sdsfree(argv[j]);
1987 zfree(argv);
1988 sdsfree(line);
1989 }
1990 if (fp != stdin) fclose(fp);
1991 return;
1992
1993 loaderr:
1994 fprintf(stderr, "\n*** FATAL CONFIG FILE ERROR ***\n");
1995 fprintf(stderr, "Reading the configuration file, at line %d\n", linenum);
1996 fprintf(stderr, ">>> '%s'\n", line);
1997 fprintf(stderr, "%s\n", err);
1998 exit(1);
1999 }
2000
2001 static void freeClientArgv(redisClient *c) {
2002 int j;
2003
2004 for (j = 0; j < c->argc; j++)
2005 decrRefCount(c->argv[j]);
2006 for (j = 0; j < c->mbargc; j++)
2007 decrRefCount(c->mbargv[j]);
2008 c->argc = 0;
2009 c->mbargc = 0;
2010 }
2011
2012 static void freeClient(redisClient *c) {
2013 listNode *ln;
2014
2015 /* Note that if the client we are freeing is blocked into a blocking
2016 * call, we have to set querybuf to NULL *before* to call
2017 * unblockClientWaitingData() to avoid processInputBuffer() will get
2018 * called. Also it is important to remove the file events after
2019 * this, because this call adds the READABLE event. */
2020 sdsfree(c->querybuf);
2021 c->querybuf = NULL;
2022 if (c->flags & REDIS_BLOCKED)
2023 unblockClientWaitingData(c);
2024
2025 /* UNWATCH all the keys */
2026 unwatchAllKeys(c);
2027 listRelease(c->watched_keys);
2028 /* Unsubscribe from all the pubsub channels */
2029 pubsubUnsubscribeAllChannels(c,0);
2030 pubsubUnsubscribeAllPatterns(c,0);
2031 dictRelease(c->pubsub_channels);
2032 listRelease(c->pubsub_patterns);
2033 /* Obvious cleanup */
2034 aeDeleteFileEvent(server.el,c->fd,AE_READABLE);
2035 aeDeleteFileEvent(server.el,c->fd,AE_WRITABLE);
2036 listRelease(c->reply);
2037 freeClientArgv(c);
2038 close(c->fd);
2039 /* Remove from the list of clients */
2040 ln = listSearchKey(server.clients,c);
2041 redisAssert(ln != NULL);
2042 listDelNode(server.clients,ln);
2043 /* Remove from the list of clients that are now ready to be restarted
2044 * after waiting for swapped keys */
2045 if (c->flags & REDIS_IO_WAIT && listLength(c->io_keys) == 0) {
2046 ln = listSearchKey(server.io_ready_clients,c);
2047 if (ln) {
2048 listDelNode(server.io_ready_clients,ln);
2049 server.vm_blocked_clients--;
2050 }
2051 }
2052 /* Remove from the list of clients waiting for swapped keys */
2053 while (server.vm_enabled && listLength(c->io_keys)) {
2054 ln = listFirst(c->io_keys);
2055 dontWaitForSwappedKey(c,ln->value);
2056 }
2057 listRelease(c->io_keys);
2058 /* Master/slave cleanup */
2059 if (c->flags & REDIS_SLAVE) {
2060 if (c->replstate == REDIS_REPL_SEND_BULK && c->repldbfd != -1)
2061 close(c->repldbfd);
2062 list *l = (c->flags & REDIS_MONITOR) ? server.monitors : server.slaves;
2063 ln = listSearchKey(l,c);
2064 redisAssert(ln != NULL);
2065 listDelNode(l,ln);
2066 }
2067 if (c->flags & REDIS_MASTER) {
2068 server.master = NULL;
2069 server.replstate = REDIS_REPL_CONNECT;
2070 }
2071 /* Release memory */
2072 zfree(c->argv);
2073 zfree(c->mbargv);
2074 freeClientMultiState(c);
2075 zfree(c);
2076 }
2077
2078 #define GLUEREPLY_UP_TO (1024)
2079 static void glueReplyBuffersIfNeeded(redisClient *c) {
2080 int copylen = 0;
2081 char buf[GLUEREPLY_UP_TO];
2082 listNode *ln;
2083 listIter li;
2084 robj *o;
2085
2086 listRewind(c->reply,&li);
2087 while((ln = listNext(&li))) {
2088 int objlen;
2089
2090 o = ln->value;
2091 objlen = sdslen(o->ptr);
2092 if (copylen + objlen <= GLUEREPLY_UP_TO) {
2093 memcpy(buf+copylen,o->ptr,objlen);
2094 copylen += objlen;
2095 listDelNode(c->reply,ln);
2096 } else {
2097 if (copylen == 0) return;
2098 break;
2099 }
2100 }
2101 /* Now the output buffer is empty, add the new single element */
2102 o = createObject(REDIS_STRING,sdsnewlen(buf,copylen));
2103 listAddNodeHead(c->reply,o);
2104 }
2105
2106 static void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask) {
2107 redisClient *c = privdata;
2108 int nwritten = 0, totwritten = 0, objlen;
2109 robj *o;
2110 REDIS_NOTUSED(el);
2111 REDIS_NOTUSED(mask);
2112
2113 /* Use writev() if we have enough buffers to send */
2114 if (!server.glueoutputbuf &&
2115 listLength(c->reply) > REDIS_WRITEV_THRESHOLD &&
2116 !(c->flags & REDIS_MASTER))
2117 {
2118 sendReplyToClientWritev(el, fd, privdata, mask);
2119 return;
2120 }
2121
2122 while(listLength(c->reply)) {
2123 if (server.glueoutputbuf && listLength(c->reply) > 1)
2124 glueReplyBuffersIfNeeded(c);
2125
2126 o = listNodeValue(listFirst(c->reply));
2127 objlen = sdslen(o->ptr);
2128
2129 if (objlen == 0) {
2130 listDelNode(c->reply,listFirst(c->reply));
2131 continue;
2132 }
2133
2134 if (c->flags & REDIS_MASTER) {
2135 /* Don't reply to a master */
2136 nwritten = objlen - c->sentlen;
2137 } else {
2138 nwritten = write(fd, ((char*)o->ptr)+c->sentlen, objlen - c->sentlen);
2139 if (nwritten <= 0) break;
2140 }
2141 c->sentlen += nwritten;
2142 totwritten += nwritten;
2143 /* If we fully sent the object on head go to the next one */
2144 if (c->sentlen == objlen) {
2145 listDelNode(c->reply,listFirst(c->reply));
2146 c->sentlen = 0;
2147 }
2148 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
2149 * bytes, in a single threaded server it's a good idea to serve
2150 * other clients as well, even if a very large request comes from
2151 * super fast link that is always able to accept data (in real world
2152 * scenario think about 'KEYS *' against the loopback interfae) */
2153 if (totwritten > REDIS_MAX_WRITE_PER_EVENT) break;
2154 }
2155 if (nwritten == -1) {
2156 if (errno == EAGAIN) {
2157 nwritten = 0;
2158 } else {
2159 redisLog(REDIS_VERBOSE,
2160 "Error writing to client: %s", strerror(errno));
2161 freeClient(c);
2162 return;
2163 }
2164 }
2165 if (totwritten > 0) c->lastinteraction = time(NULL);
2166 if (listLength(c->reply) == 0) {
2167 c->sentlen = 0;
2168 aeDeleteFileEvent(server.el,c->fd,AE_WRITABLE);
2169 }
2170 }
2171
2172 static void sendReplyToClientWritev(aeEventLoop *el, int fd, void *privdata, int mask)
2173 {
2174 redisClient *c = privdata;
2175 int nwritten = 0, totwritten = 0, objlen, willwrite;
2176 robj *o;
2177 struct iovec iov[REDIS_WRITEV_IOVEC_COUNT];
2178 int offset, ion = 0;
2179 REDIS_NOTUSED(el);
2180 REDIS_NOTUSED(mask);
2181
2182 listNode *node;
2183 while (listLength(c->reply)) {
2184 offset = c->sentlen;
2185 ion = 0;
2186 willwrite = 0;
2187
2188 /* fill-in the iov[] array */
2189 for(node = listFirst(c->reply); node; node = listNextNode(node)) {
2190 o = listNodeValue(node);
2191 objlen = sdslen(o->ptr);
2192
2193 if (totwritten + objlen - offset > REDIS_MAX_WRITE_PER_EVENT)
2194 break;
2195
2196 if(ion == REDIS_WRITEV_IOVEC_COUNT)
2197 break; /* no more iovecs */
2198
2199 iov[ion].iov_base = ((char*)o->ptr) + offset;
2200 iov[ion].iov_len = objlen - offset;
2201 willwrite += objlen - offset;
2202 offset = 0; /* just for the first item */
2203 ion++;
2204 }
2205
2206 if(willwrite == 0)
2207 break;
2208
2209 /* write all collected blocks at once */
2210 if((nwritten = writev(fd, iov, ion)) < 0) {
2211 if (errno != EAGAIN) {
2212 redisLog(REDIS_VERBOSE,
2213 "Error writing to client: %s", strerror(errno));
2214 freeClient(c);
2215 return;
2216 }
2217 break;
2218 }
2219
2220 totwritten += nwritten;
2221 offset = c->sentlen;
2222
2223 /* remove written robjs from c->reply */
2224 while (nwritten && listLength(c->reply)) {
2225 o = listNodeValue(listFirst(c->reply));
2226 objlen = sdslen(o->ptr);
2227
2228 if(nwritten >= objlen - offset) {
2229 listDelNode(c->reply, listFirst(c->reply));
2230 nwritten -= objlen - offset;
2231 c->sentlen = 0;
2232 } else {
2233 /* partial write */
2234 c->sentlen += nwritten;
2235 break;
2236 }
2237 offset = 0;
2238 }
2239 }
2240
2241 if (totwritten > 0)
2242 c->lastinteraction = time(NULL);
2243
2244 if (listLength(c->reply) == 0) {
2245 c->sentlen = 0;
2246 aeDeleteFileEvent(server.el,c->fd,AE_WRITABLE);
2247 }
2248 }
2249
2250 static struct redisCommand *lookupCommand(char *name) {
2251 int j = 0;
2252 while(cmdTable[j].name != NULL) {
2253 if (!strcasecmp(name,cmdTable[j].name)) return &cmdTable[j];
2254 j++;
2255 }
2256 return NULL;
2257 }
2258
2259 /* resetClient prepare the client to process the next command */
2260 static void resetClient(redisClient *c) {
2261 freeClientArgv(c);
2262 c->bulklen = -1;
2263 c->multibulk = 0;
2264 }
2265
2266 /* Call() is the core of Redis execution of a command */
2267 static void call(redisClient *c, struct redisCommand *cmd) {
2268 long long dirty;
2269
2270 dirty = server.dirty;
2271 cmd->proc(c);
2272 dirty = server.dirty-dirty;
2273
2274 if (server.appendonly && dirty)
2275 feedAppendOnlyFile(cmd,c->db->id,c->argv,c->argc);
2276 if ((dirty || cmd->flags & REDIS_CMD_FORCE_REPLICATION) &&
2277 listLength(server.slaves))
2278 replicationFeedSlaves(server.slaves,c->db->id,c->argv,c->argc);
2279 if (listLength(server.monitors))
2280 replicationFeedMonitors(server.monitors,c->db->id,c->argv,c->argc);
2281 server.stat_numcommands++;
2282 }
2283
2284 /* If this function gets called we already read a whole
2285 * command, argments are in the client argv/argc fields.
2286 * processCommand() execute the command or prepare the
2287 * server for a bulk read from the client.
2288 *
2289 * If 1 is returned the client is still alive and valid and
2290 * and other operations can be performed by the caller. Otherwise
2291 * if 0 is returned the client was destroied (i.e. after QUIT). */
2292 static int processCommand(redisClient *c) {
2293 struct redisCommand *cmd;
2294
2295 /* Free some memory if needed (maxmemory setting) */
2296 if (server.maxmemory) freeMemoryIfNeeded();
2297
2298 /* Handle the multi bulk command type. This is an alternative protocol
2299 * supported by Redis in order to receive commands that are composed of
2300 * multiple binary-safe "bulk" arguments. The latency of processing is
2301 * a bit higher but this allows things like multi-sets, so if this
2302 * protocol is used only for MSET and similar commands this is a big win. */
2303 if (c->multibulk == 0 && c->argc == 1 && ((char*)(c->argv[0]->ptr))[0] == '*') {
2304 c->multibulk = atoi(((char*)c->argv[0]->ptr)+1);
2305 if (c->multibulk <= 0) {
2306 resetClient(c);
2307 return 1;
2308 } else {
2309 decrRefCount(c->argv[c->argc-1]);
2310 c->argc--;
2311 return 1;
2312 }
2313 } else if (c->multibulk) {
2314 if (c->bulklen == -1) {
2315 if (((char*)c->argv[0]->ptr)[0] != '$') {
2316 addReplySds(c,sdsnew("-ERR multi bulk protocol error\r\n"));
2317 resetClient(c);
2318 return 1;
2319 } else {
2320 int bulklen = atoi(((char*)c->argv[0]->ptr)+1);
2321 decrRefCount(c->argv[0]);
2322 if (bulklen < 0 || bulklen > 1024*1024*1024) {
2323 c->argc--;
2324 addReplySds(c,sdsnew("-ERR invalid bulk write count\r\n"));
2325 resetClient(c);
2326 return 1;
2327 }
2328 c->argc--;
2329 c->bulklen = bulklen+2; /* add two bytes for CR+LF */
2330 return 1;
2331 }
2332 } else {
2333 c->mbargv = zrealloc(c->mbargv,(sizeof(robj*))*(c->mbargc+1));
2334 c->mbargv[c->mbargc] = c->argv[0];
2335 c->mbargc++;
2336 c->argc--;
2337 c->multibulk--;
2338 if (c->multibulk == 0) {
2339 robj **auxargv;
2340 int auxargc;
2341
2342 /* Here we need to swap the multi-bulk argc/argv with the
2343 * normal argc/argv of the client structure. */
2344 auxargv = c->argv;
2345 c->argv = c->mbargv;
2346 c->mbargv = auxargv;
2347
2348 auxargc = c->argc;
2349 c->argc = c->mbargc;
2350 c->mbargc = auxargc;
2351
2352 /* We need to set bulklen to something different than -1
2353 * in order for the code below to process the command without
2354 * to try to read the last argument of a bulk command as
2355 * a special argument. */
2356 c->bulklen = 0;
2357 /* continue below and process the command */
2358 } else {
2359 c->bulklen = -1;
2360 return 1;
2361 }
2362 }
2363 }
2364 /* -- end of multi bulk commands processing -- */
2365
2366 /* The QUIT command is handled as a special case. Normal command
2367 * procs are unable to close the client connection safely */
2368 if (!strcasecmp(c->argv[0]->ptr,"quit")) {
2369 freeClient(c);
2370 return 0;
2371 }
2372
2373 /* Now lookup the command and check ASAP about trivial error conditions
2374 * such wrong arity, bad command name and so forth. */
2375 cmd = lookupCommand(c->argv[0]->ptr);
2376 if (!cmd) {
2377 addReplySds(c,
2378 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2379 (char*)c->argv[0]->ptr));
2380 resetClient(c);
2381 return 1;
2382 } else if ((cmd->arity > 0 && cmd->arity != c->argc) ||
2383 (c->argc < -cmd->arity)) {
2384 addReplySds(c,
2385 sdscatprintf(sdsempty(),
2386 "-ERR wrong number of arguments for '%s' command\r\n",
2387 cmd->name));
2388 resetClient(c);
2389 return 1;
2390 } else if (cmd->flags & REDIS_CMD_BULK && c->bulklen == -1) {
2391 /* This is a bulk command, we have to read the last argument yet. */
2392 int bulklen = atoi(c->argv[c->argc-1]->ptr);
2393
2394 decrRefCount(c->argv[c->argc-1]);
2395 if (bulklen < 0 || bulklen > 1024*1024*1024) {
2396 c->argc--;
2397 addReplySds(c,sdsnew("-ERR invalid bulk write count\r\n"));
2398 resetClient(c);
2399 return 1;
2400 }
2401 c->argc--;
2402 c->bulklen = bulklen+2; /* add two bytes for CR+LF */
2403 /* It is possible that the bulk read is already in the
2404 * buffer. Check this condition and handle it accordingly.
2405 * This is just a fast path, alternative to call processInputBuffer().
2406 * It's a good idea since the code is small and this condition
2407 * happens most of the times. */
2408 if ((signed)sdslen(c->querybuf) >= c->bulklen) {
2409 c->argv[c->argc] = createStringObject(c->querybuf,c->bulklen-2);
2410 c->argc++;
2411 c->querybuf = sdsrange(c->querybuf,c->bulklen,-1);
2412 } else {
2413 /* Otherwise return... there is to read the last argument
2414 * from the socket. */
2415 return 1;
2416 }
2417 }
2418 /* Let's try to encode the bulk object to save space. */
2419 if (cmd->flags & REDIS_CMD_BULK)
2420 c->argv[c->argc-1] = tryObjectEncoding(c->argv[c->argc-1]);
2421
2422 /* Check if the user is authenticated */
2423 if (server.requirepass && !c->authenticated && cmd->proc != authCommand) {
2424 addReplySds(c,sdsnew("-ERR operation not permitted\r\n"));
2425 resetClient(c);
2426 return 1;
2427 }
2428
2429 /* Handle the maxmemory directive */
2430 if (server.maxmemory && (cmd->flags & REDIS_CMD_DENYOOM) &&
2431 zmalloc_used_memory() > server.maxmemory)
2432 {
2433 addReplySds(c,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2434 resetClient(c);
2435 return 1;
2436 }
2437
2438 /* Only allow SUBSCRIBE and UNSUBSCRIBE in the context of Pub/Sub */
2439 if ((dictSize(c->pubsub_channels) > 0 || listLength(c->pubsub_patterns) > 0)
2440 &&
2441 cmd->proc != subscribeCommand && cmd->proc != unsubscribeCommand &&
2442 cmd->proc != psubscribeCommand && cmd->proc != punsubscribeCommand) {
2443 addReplySds(c,sdsnew("-ERR only (P)SUBSCRIBE / (P)UNSUBSCRIBE / QUIT allowed in this context\r\n"));
2444 resetClient(c);
2445 return 1;
2446 }
2447
2448 /* Exec the command */
2449 if (c->flags & REDIS_MULTI && cmd->proc != execCommand && cmd->proc != discardCommand) {
2450 queueMultiCommand(c,cmd);
2451 addReply(c,shared.queued);
2452 } else {
2453 if (server.vm_enabled && server.vm_max_threads > 0 &&
2454 blockClientOnSwappedKeys(c,cmd)) return 1;
2455 call(c,cmd);
2456 }
2457
2458 /* Prepare the client for the next command */
2459 resetClient(c);
2460 return 1;
2461 }
2462
2463 static void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc) {
2464 listNode *ln;
2465 listIter li;
2466 int outc = 0, j;
2467 robj **outv;
2468 /* We need 1+(ARGS*3) objects since commands are using the new protocol
2469 * and we one 1 object for the first "*<count>\r\n" multibulk count, then
2470 * for every additional object we have "$<count>\r\n" + object + "\r\n". */
2471 robj *static_outv[REDIS_STATIC_ARGS*3+1];
2472 robj *lenobj;
2473
2474 if (argc <= REDIS_STATIC_ARGS) {
2475 outv = static_outv;
2476 } else {
2477 outv = zmalloc(sizeof(robj*)*(argc*3+1));
2478 }
2479
2480 lenobj = createObject(REDIS_STRING,
2481 sdscatprintf(sdsempty(), "*%d\r\n", argc));
2482 lenobj->refcount = 0;
2483 outv[outc++] = lenobj;
2484 for (j = 0; j < argc; j++) {
2485 lenobj = createObject(REDIS_STRING,
2486 sdscatprintf(sdsempty(),"$%lu\r\n",
2487 (unsigned long) stringObjectLen(argv[j])));
2488 lenobj->refcount = 0;
2489 outv[outc++] = lenobj;
2490 outv[outc++] = argv[j];
2491 outv[outc++] = shared.crlf;
2492 }
2493
2494 /* Increment all the refcounts at start and decrement at end in order to
2495 * be sure to free objects if there is no slave in a replication state
2496 * able to be feed with commands */
2497 for (j = 0; j < outc; j++) incrRefCount(outv[j]);
2498 listRewind(slaves,&li);
2499 while((ln = listNext(&li))) {
2500 redisClient *slave = ln->value;
2501
2502 /* Don't feed slaves that are still waiting for BGSAVE to start */
2503 if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_START) continue;
2504
2505 /* Feed all the other slaves, MONITORs and so on */
2506 if (slave->slaveseldb != dictid) {
2507 robj *selectcmd;
2508
2509 switch(dictid) {
2510 case 0: selectcmd = shared.select0; break;
2511 case 1: selectcmd = shared.select1; break;
2512 case 2: selectcmd = shared.select2; break;
2513 case 3: selectcmd = shared.select3; break;
2514 case 4: selectcmd = shared.select4; break;
2515 case 5: selectcmd = shared.select5; break;
2516 case 6: selectcmd = shared.select6; break;
2517 case 7: selectcmd = shared.select7; break;
2518 case 8: selectcmd = shared.select8; break;
2519 case 9: selectcmd = shared.select9; break;
2520 default:
2521 selectcmd = createObject(REDIS_STRING,
2522 sdscatprintf(sdsempty(),"select %d\r\n",dictid));
2523 selectcmd->refcount = 0;
2524 break;
2525 }
2526 addReply(slave,selectcmd);
2527 slave->slaveseldb = dictid;
2528 }
2529 for (j = 0; j < outc; j++) addReply(slave,outv[j]);
2530 }
2531 for (j = 0; j < outc; j++) decrRefCount(outv[j]);
2532 if (outv != static_outv) zfree(outv);
2533 }
2534
2535 static sds sdscatrepr(sds s, char *p, size_t len) {
2536 s = sdscatlen(s,"\"",1);
2537 while(len--) {
2538 switch(*p) {
2539 case '\\':
2540 case '"':
2541 s = sdscatprintf(s,"\\%c",*p);
2542 break;
2543 case '\n': s = sdscatlen(s,"\\n",1); break;
2544 case '\r': s = sdscatlen(s,"\\r",1); break;
2545 case '\t': s = sdscatlen(s,"\\t",1); break;
2546 case '\a': s = sdscatlen(s,"\\a",1); break;
2547 case '\b': s = sdscatlen(s,"\\b",1); break;
2548 default:
2549 if (isprint(*p))
2550 s = sdscatprintf(s,"%c",*p);
2551 else
2552 s = sdscatprintf(s,"\\x%02x",(unsigned char)*p);
2553 break;
2554 }
2555 p++;
2556 }
2557 return sdscatlen(s,"\"",1);
2558 }
2559
2560 static void replicationFeedMonitors(list *monitors, int dictid, robj **argv, int argc) {
2561 listNode *ln;
2562 listIter li;
2563 int j;
2564 sds cmdrepr = sdsnew("+");
2565 robj *cmdobj;
2566 struct timeval tv;
2567
2568 gettimeofday(&tv,NULL);
2569 cmdrepr = sdscatprintf(cmdrepr,"%ld.%ld ",(long)tv.tv_sec,(long)tv.tv_usec);
2570 if (dictid != 0) cmdrepr = sdscatprintf(cmdrepr,"(db %d) ", dictid);
2571
2572 for (j = 0; j < argc; j++) {
2573 if (argv[j]->encoding == REDIS_ENCODING_INT) {
2574 cmdrepr = sdscatprintf(cmdrepr, "%ld", (long)argv[j]->ptr);
2575 } else {
2576 cmdrepr = sdscatrepr(cmdrepr,(char*)argv[j]->ptr,
2577 sdslen(argv[j]->ptr));
2578 }
2579 if (j != argc-1)
2580 cmdrepr = sdscatlen(cmdrepr," ",1);
2581 }
2582 cmdrepr = sdscatlen(cmdrepr,"\r\n",2);
2583 cmdobj = createObject(REDIS_STRING,cmdrepr);
2584
2585 listRewind(monitors,&li);
2586 while((ln = listNext(&li))) {
2587 redisClient *monitor = ln->value;
2588 addReply(monitor,cmdobj);
2589 }
2590 decrRefCount(cmdobj);
2591 }
2592
2593 static void processInputBuffer(redisClient *c) {
2594 again:
2595 /* Before to process the input buffer, make sure the client is not
2596 * waitig for a blocking operation such as BLPOP. Note that the first
2597 * iteration the client is never blocked, otherwise the processInputBuffer
2598 * would not be called at all, but after the execution of the first commands
2599 * in the input buffer the client may be blocked, and the "goto again"
2600 * will try to reiterate. The following line will make it return asap. */
2601 if (c->flags & REDIS_BLOCKED || c->flags & REDIS_IO_WAIT) return;
2602 if (c->bulklen == -1) {
2603 /* Read the first line of the query */
2604 char *p = strchr(c->querybuf,'\n');
2605 size_t querylen;
2606
2607 if (p) {
2608 sds query, *argv;
2609 int argc, j;
2610
2611 query = c->querybuf;
2612 c->querybuf = sdsempty();
2613 querylen = 1+(p-(query));
2614 if (sdslen(query) > querylen) {
2615 /* leave data after the first line of the query in the buffer */
2616 c->querybuf = sdscatlen(c->querybuf,query+querylen,sdslen(query)-querylen);
2617 }
2618 *p = '\0'; /* remove "\n" */
2619 if (*(p-1) == '\r') *(p-1) = '\0'; /* and "\r" if any */
2620 sdsupdatelen(query);
2621
2622 /* Now we can split the query in arguments */
2623 argv = sdssplitlen(query,sdslen(query)," ",1,&argc);
2624 sdsfree(query);
2625
2626 if (c->argv) zfree(c->argv);
2627 c->argv = zmalloc(sizeof(robj*)*argc);
2628
2629 for (j = 0; j < argc; j++) {
2630 if (sdslen(argv[j])) {
2631 c->argv[c->argc] = createObject(REDIS_STRING,argv[j]);
2632 c->argc++;
2633 } else {
2634 sdsfree(argv[j]);
2635 }
2636 }
2637 zfree(argv);
2638 if (c->argc) {
2639 /* Execute the command. If the client is still valid
2640 * after processCommand() return and there is something
2641 * on the query buffer try to process the next command. */
2642 if (processCommand(c) && sdslen(c->querybuf)) goto again;
2643 } else {
2644 /* Nothing to process, argc == 0. Just process the query
2645 * buffer if it's not empty or return to the caller */
2646 if (sdslen(c->querybuf)) goto again;
2647 }
2648 return;
2649 } else if (sdslen(c->querybuf) >= REDIS_REQUEST_MAX_SIZE) {
2650 redisLog(REDIS_VERBOSE, "Client protocol error");
2651 freeClient(c);
2652 return;
2653 }
2654 } else {
2655 /* Bulk read handling. Note that if we are at this point
2656 the client already sent a command terminated with a newline,
2657 we are reading the bulk data that is actually the last
2658 argument of the command. */
2659 int qbl = sdslen(c->querybuf);
2660
2661 if (c->bulklen <= qbl) {
2662 /* Copy everything but the final CRLF as final argument */
2663 c->argv[c->argc] = createStringObject(c->querybuf,c->bulklen-2);
2664 c->argc++;
2665 c->querybuf = sdsrange(c->querybuf,c->bulklen,-1);
2666 /* Process the command. If the client is still valid after
2667 * the processing and there is more data in the buffer
2668 * try to parse it. */
2669 if (processCommand(c) && sdslen(c->querybuf)) goto again;
2670 return;
2671 }
2672 }
2673 }
2674
2675 static void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask) {
2676 redisClient *c = (redisClient*) privdata;
2677 char buf[REDIS_IOBUF_LEN];
2678 int nread;
2679 REDIS_NOTUSED(el);
2680 REDIS_NOTUSED(mask);
2681
2682 nread = read(fd, buf, REDIS_IOBUF_LEN);
2683 if (nread == -1) {
2684 if (errno == EAGAIN) {
2685 nread = 0;
2686 } else {
2687 redisLog(REDIS_VERBOSE, "Reading from client: %s",strerror(errno));
2688 freeClient(c);
2689 return;
2690 }
2691 } else if (nread == 0) {
2692 redisLog(REDIS_VERBOSE, "Client closed connection");
2693 freeClient(c);
2694 return;
2695 }
2696 if (nread) {
2697 c->querybuf = sdscatlen(c->querybuf, buf, nread);
2698 c->lastinteraction = time(NULL);
2699 } else {
2700 return;
2701 }
2702 processInputBuffer(c);
2703 }
2704
2705 static int selectDb(redisClient *c, int id) {
2706 if (id < 0 || id >= server.dbnum)
2707 return REDIS_ERR;
2708 c->db = &server.db[id];
2709 return REDIS_OK;
2710 }
2711
2712 static void *dupClientReplyValue(void *o) {
2713 incrRefCount((robj*)o);
2714 return o;
2715 }
2716
2717 static int listMatchObjects(void *a, void *b) {
2718 return equalStringObjects(a,b);
2719 }
2720
2721 static redisClient *createClient(int fd) {
2722 redisClient *c = zmalloc(sizeof(*c));
2723
2724 anetNonBlock(NULL,fd);
2725 anetTcpNoDelay(NULL,fd);
2726 if (!c) return NULL;
2727 selectDb(c,0);
2728 c->fd = fd;
2729 c->querybuf = sdsempty();
2730 c->argc = 0;
2731 c->argv = NULL;
2732 c->bulklen = -1;
2733 c->multibulk = 0;
2734 c->mbargc = 0;
2735 c->mbargv = NULL;
2736 c->sentlen = 0;
2737 c->flags = 0;
2738 c->lastinteraction = time(NULL);
2739 c->authenticated = 0;
2740 c->replstate = REDIS_REPL_NONE;
2741 c->reply = listCreate();
2742 listSetFreeMethod(c->reply,decrRefCount);
2743 listSetDupMethod(c->reply,dupClientReplyValue);
2744 c->blocking_keys = NULL;
2745 c->blocking_keys_num = 0;
2746 c->io_keys = listCreate();
2747 c->watched_keys = listCreate();
2748 listSetFreeMethod(c->io_keys,decrRefCount);
2749 c->pubsub_channels = dictCreate(&setDictType,NULL);
2750 c->pubsub_patterns = listCreate();
2751 listSetFreeMethod(c->pubsub_patterns,decrRefCount);
2752 listSetMatchMethod(c->pubsub_patterns,listMatchObjects);
2753 if (aeCreateFileEvent(server.el, c->fd, AE_READABLE,
2754 readQueryFromClient, c) == AE_ERR) {
2755 freeClient(c);
2756 return NULL;
2757 }
2758 listAddNodeTail(server.clients,c);
2759 initClientMultiState(c);
2760 return c;
2761 }
2762
2763 static void addReply(redisClient *c, robj *obj) {
2764 if (listLength(c->reply) == 0 &&
2765 (c->replstate == REDIS_REPL_NONE ||
2766 c->replstate == REDIS_REPL_ONLINE) &&
2767 aeCreateFileEvent(server.el, c->fd, AE_WRITABLE,
2768 sendReplyToClient, c) == AE_ERR) return;
2769
2770 if (server.vm_enabled && obj->storage != REDIS_VM_MEMORY) {
2771 obj = dupStringObject(obj);
2772 obj->refcount = 0; /* getDecodedObject() will increment the refcount */
2773 }
2774 listAddNodeTail(c->reply,getDecodedObject(obj));
2775 }
2776
2777 static void addReplySds(redisClient *c, sds s) {
2778 robj *o = createObject(REDIS_STRING,s);
2779 addReply(c,o);
2780 decrRefCount(o);
2781 }
2782
2783 static void addReplyDouble(redisClient *c, double d) {
2784 char buf[128];
2785
2786 snprintf(buf,sizeof(buf),"%.17g",d);
2787 addReplySds(c,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2788 (unsigned long) strlen(buf),buf));
2789 }
2790
2791 static void addReplyLongLong(redisClient *c, long long ll) {
2792 char buf[128];
2793 size_t len;
2794
2795 if (ll == 0) {
2796 addReply(c,shared.czero);
2797 return;
2798 } else if (ll == 1) {
2799 addReply(c,shared.cone);
2800 return;
2801 }
2802 buf[0] = ':';
2803 len = ll2string(buf+1,sizeof(buf)-1,ll);
2804 buf[len+1] = '\r';
2805 buf[len+2] = '\n';
2806 addReplySds(c,sdsnewlen(buf,len+3));
2807 }
2808
2809 static void addReplyUlong(redisClient *c, unsigned long ul) {
2810 char buf[128];
2811 size_t len;
2812
2813 if (ul == 0) {
2814 addReply(c,shared.czero);
2815 return;
2816 } else if (ul == 1) {
2817 addReply(c,shared.cone);
2818 return;
2819 }
2820 len = snprintf(buf,sizeof(buf),":%lu\r\n",ul);
2821 addReplySds(c,sdsnewlen(buf,len));
2822 }
2823
2824 static void addReplyBulkLen(redisClient *c, robj *obj) {
2825 size_t len, intlen;
2826 char buf[128];
2827
2828 if (obj->encoding == REDIS_ENCODING_RAW) {
2829 len = sdslen(obj->ptr);
2830 } else {
2831 long n = (long)obj->ptr;
2832
2833 /* Compute how many bytes will take this integer as a radix 10 string */
2834 len = 1;
2835 if (n < 0) {
2836 len++;
2837 n = -n;
2838 }
2839 while((n = n/10) != 0) {
2840 len++;
2841 }
2842 }
2843 buf[0] = '$';
2844 intlen = ll2string(buf+1,sizeof(buf)-1,(long long)len);
2845 buf[intlen+1] = '\r';
2846 buf[intlen+2] = '\n';
2847 addReplySds(c,sdsnewlen(buf,intlen+3));
2848 }
2849
2850 static void addReplyBulk(redisClient *c, robj *obj) {
2851 addReplyBulkLen(c,obj);
2852 addReply(c,obj);
2853 addReply(c,shared.crlf);
2854 }
2855
2856 /* In the CONFIG command we need to add vanilla C string as bulk replies */
2857 static void addReplyBulkCString(redisClient *c, char *s) {
2858 if (s == NULL) {
2859 addReply(c,shared.nullbulk);
2860 } else {
2861 robj *o = createStringObject(s,strlen(s));
2862 addReplyBulk(c,o);
2863 decrRefCount(o);
2864 }
2865 }
2866
2867 static void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask) {
2868 int cport, cfd;
2869 char cip[128];
2870 redisClient *c;
2871 REDIS_NOTUSED(el);
2872 REDIS_NOTUSED(mask);
2873 REDIS_NOTUSED(privdata);
2874
2875 cfd = anetAccept(server.neterr, fd, cip, &cport);
2876 if (cfd == AE_ERR) {
2877 redisLog(REDIS_VERBOSE,"Accepting client connection: %s", server.neterr);
2878 return;
2879 }
2880 redisLog(REDIS_VERBOSE,"Accepted %s:%d", cip, cport);
2881 if ((c = createClient(cfd)) == NULL) {
2882 redisLog(REDIS_WARNING,"Error allocating resoures for the client");
2883 close(cfd); /* May be already closed, just ingore errors */
2884 return;
2885 }
2886 /* If maxclient directive is set and this is one client more... close the
2887 * connection. Note that we create the client instead to check before
2888 * for this condition, since now the socket is already set in nonblocking
2889 * mode and we can send an error for free using the Kernel I/O */
2890 if (server.maxclients && listLength(server.clients) > server.maxclients) {
2891 char *err = "-ERR max number of clients reached\r\n";
2892
2893 /* That's a best effort error message, don't check write errors */
2894 if (write(c->fd,err,strlen(err)) == -1) {
2895 /* Nothing to do, Just to avoid the warning... */
2896 }
2897 freeClient(c);
2898 return;
2899 }
2900 server.stat_numconnections++;
2901 }
2902
2903 /* ======================= Redis objects implementation ===================== */
2904
2905 static robj *createObject(int type, void *ptr) {
2906 robj *o;
2907
2908 if (server.vm_enabled) pthread_mutex_lock(&server.obj_freelist_mutex);
2909 if (listLength(server.objfreelist)) {
2910 listNode *head = listFirst(server.objfreelist);
2911 o = listNodeValue(head);
2912 listDelNode(server.objfreelist,head);
2913 if (server.vm_enabled) pthread_mutex_unlock(&server.obj_freelist_mutex);
2914 } else {
2915 if (server.vm_enabled) {
2916 pthread_mutex_unlock(&server.obj_freelist_mutex);
2917 o = zmalloc(sizeof(*o));
2918 } else {
2919 o = zmalloc(sizeof(*o)-sizeof(struct redisObjectVM));
2920 }
2921 }
2922 o->type = type;
2923 o->encoding = REDIS_ENCODING_RAW;
2924 o->ptr = ptr;
2925 o->refcount = 1;
2926 if (server.vm_enabled) {
2927 /* Note that this code may run in the context of an I/O thread
2928 * and accessing to server.unixtime in theory is an error
2929 * (no locks). But in practice this is safe, and even if we read
2930 * garbage Redis will not fail, as it's just a statistical info */
2931 o->vm.atime = server.unixtime;
2932 o->storage = REDIS_VM_MEMORY;
2933 }
2934 return o;
2935 }
2936
2937 static robj *createStringObject(char *ptr, size_t len) {
2938 return createObject(REDIS_STRING,sdsnewlen(ptr,len));
2939 }
2940
2941 static robj *createStringObjectFromLongLong(long long value) {
2942 robj *o;
2943 if (value >= 0 && value < REDIS_SHARED_INTEGERS) {
2944 incrRefCount(shared.integers[value]);
2945 o = shared.integers[value];
2946 } else {
2947 if (value >= LONG_MIN && value <= LONG_MAX) {
2948 o = createObject(REDIS_STRING, NULL);
2949 o->encoding = REDIS_ENCODING_INT;
2950 o->ptr = (void*)((long)value);
2951 } else {
2952 o = createObject(REDIS_STRING,sdsfromlonglong(value));
2953 }
2954 }
2955 return o;
2956 }
2957
2958 static robj *dupStringObject(robj *o) {
2959 assert(o->encoding == REDIS_ENCODING_RAW);
2960 return createStringObject(o->ptr,sdslen(o->ptr));
2961 }
2962
2963 static robj *createListObject(void) {
2964 list *l = listCreate();
2965
2966 listSetFreeMethod(l,decrRefCount);
2967 return createObject(REDIS_LIST,l);
2968 }
2969
2970 static robj *createSetObject(void) {
2971 dict *d = dictCreate(&setDictType,NULL);
2972 return createObject(REDIS_SET,d);
2973 }
2974
2975 static robj *createHashObject(void) {
2976 /* All the Hashes start as zipmaps. Will be automatically converted
2977 * into hash tables if there are enough elements or big elements
2978 * inside. */
2979 unsigned char *zm = zipmapNew();
2980 robj *o = createObject(REDIS_HASH,zm);
2981 o->encoding = REDIS_ENCODING_ZIPMAP;
2982 return o;
2983 }
2984
2985 static robj *createZsetObject(void) {
2986 zset *zs = zmalloc(sizeof(*zs));
2987
2988 zs->dict = dictCreate(&zsetDictType,NULL);
2989 zs->zsl = zslCreate();
2990 return createObject(REDIS_ZSET,zs);
2991 }
2992
2993 static void freeStringObject(robj *o) {
2994 if (o->encoding == REDIS_ENCODING_RAW) {
2995 sdsfree(o->ptr);
2996 }
2997 }
2998
2999 static void freeListObject(robj *o) {
3000 listRelease((list*) o->ptr);
3001 }
3002
3003 static void freeSetObject(robj *o) {
3004 dictRelease((dict*) o->ptr);
3005 }
3006
3007 static void freeZsetObject(robj *o) {
3008 zset *zs = o->ptr;
3009
3010 dictRelease(zs->dict);
3011 zslFree(zs->zsl);
3012 zfree(zs);
3013 }
3014
3015 static void freeHashObject(robj *o) {
3016 switch (o->encoding) {
3017 case REDIS_ENCODING_HT:
3018 dictRelease((dict*) o->ptr);
3019 break;
3020 case REDIS_ENCODING_ZIPMAP:
3021 zfree(o->ptr);
3022 break;
3023 default:
3024 redisPanic("Unknown hash encoding type");
3025 break;
3026 }
3027 }
3028
3029 static void incrRefCount(robj *o) {
3030 o->refcount++;
3031 }
3032
3033 static void decrRefCount(void *obj) {
3034 robj *o = obj;
3035
3036 if (o->refcount <= 0) redisPanic("decrRefCount against refcount <= 0");
3037 /* Object is a key of a swapped out value, or in the process of being
3038 * loaded. */
3039 if (server.vm_enabled &&
3040 (o->storage == REDIS_VM_SWAPPED || o->storage == REDIS_VM_LOADING))
3041 {
3042 if (o->storage == REDIS_VM_LOADING) vmCancelThreadedIOJob(obj);
3043 redisAssert(o->type == REDIS_STRING);
3044 freeStringObject(o);
3045 vmMarkPagesFree(o->vm.page,o->vm.usedpages);
3046 pthread_mutex_lock(&server.obj_freelist_mutex);
3047 if (listLength(server.objfreelist) > REDIS_OBJFREELIST_MAX ||
3048 !listAddNodeHead(server.objfreelist,o))
3049 zfree(o);
3050 pthread_mutex_unlock(&server.obj_freelist_mutex);
3051 server.vm_stats_swapped_objects--;
3052 return;
3053 }
3054 /* Object is in memory, or in the process of being swapped out. */
3055 if (--(o->refcount) == 0) {
3056 if (server.vm_enabled && o->storage == REDIS_VM_SWAPPING)
3057 vmCancelThreadedIOJob(obj);
3058 switch(o->type) {
3059 case REDIS_STRING: freeStringObject(o); break;
3060 case REDIS_LIST: freeListObject(o); break;
3061 case REDIS_SET: freeSetObject(o); break;
3062 case REDIS_ZSET: freeZsetObject(o); break;
3063 case REDIS_HASH: freeHashObject(o); break;
3064 default: redisPanic("Unknown object type"); break;
3065 }
3066 if (server.vm_enabled) pthread_mutex_lock(&server.obj_freelist_mutex);
3067 if (listLength(server.objfreelist) > REDIS_OBJFREELIST_MAX ||
3068 !listAddNodeHead(server.objfreelist,o))
3069 zfree(o);
3070 if (server.vm_enabled) pthread_mutex_unlock(&server.obj_freelist_mutex);
3071 }
3072 }
3073
3074 static robj *lookupKey(redisDb *db, robj *key) {
3075 dictEntry *de = dictFind(db->dict,key);
3076 if (de) {
3077 robj *key = dictGetEntryKey(de);
3078 robj *val = dictGetEntryVal(de);
3079
3080 if (server.vm_enabled) {
3081 if (key->storage == REDIS_VM_MEMORY ||
3082 key->storage == REDIS_VM_SWAPPING)
3083 {
3084 /* If we were swapping the object out, stop it, this key
3085 * was requested. */
3086 if (key->storage == REDIS_VM_SWAPPING)
3087 vmCancelThreadedIOJob(key);
3088 /* Update the access time of the key for the aging algorithm. */
3089 key->vm.atime = server.unixtime;
3090 } else {
3091 int notify = (key->storage == REDIS_VM_LOADING);
3092
3093 /* Our value was swapped on disk. Bring it at home. */
3094 redisAssert(val == NULL);
3095 val = vmLoadObject(key);
3096 dictGetEntryVal(de) = val;
3097
3098 /* Clients blocked by the VM subsystem may be waiting for
3099 * this key... */
3100 if (notify) handleClientsBlockedOnSwappedKey(db,key);
3101 }
3102 }
3103 return val;
3104 } else {
3105 return NULL;
3106 }
3107 }
3108
3109 static robj *lookupKeyRead(redisDb *db, robj *key) {
3110 expireIfNeeded(db,key);
3111 return lookupKey(db,key);
3112 }
3113
3114 static robj *lookupKeyWrite(redisDb *db, robj *key) {
3115 deleteIfVolatile(db,key);
3116 touchWatchedKey(db,key);
3117 return lookupKey(db,key);
3118 }
3119
3120 static robj *lookupKeyReadOrReply(redisClient *c, robj *key, robj *reply) {
3121 robj *o = lookupKeyRead(c->db, key);
3122 if (!o) addReply(c,reply);
3123 return o;
3124 }
3125
3126 static robj *lookupKeyWriteOrReply(redisClient *c, robj *key, robj *reply) {
3127 robj *o = lookupKeyWrite(c->db, key);
3128 if (!o) addReply(c,reply);
3129 return o;
3130 }
3131
3132 static int checkType(redisClient *c, robj *o, int type) {
3133 if (o->type != type) {
3134 addReply(c,shared.wrongtypeerr);
3135 return 1;
3136 }
3137 return 0;
3138 }
3139
3140 static int deleteKey(redisDb *db, robj *key) {
3141 int retval;
3142
3143 /* We need to protect key from destruction: after the first dictDelete()
3144 * it may happen that 'key' is no longer valid if we don't increment
3145 * it's count. This may happen when we get the object reference directly
3146 * from the hash table with dictRandomKey() or dict iterators */
3147 incrRefCount(key);
3148 if (dictSize(db->expires)) dictDelete(db->expires,key);
3149 retval = dictDelete(db->dict,key);
3150 decrRefCount(key);
3151
3152 return retval == DICT_OK;
3153 }
3154
3155 /* Check if the nul-terminated string 's' can be represented by a long
3156 * (that is, is a number that fits into long without any other space or
3157 * character before or after the digits).
3158 *
3159 * If so, the function returns REDIS_OK and *longval is set to the value
3160 * of the number. Otherwise REDIS_ERR is returned */
3161 static int isStringRepresentableAsLong(sds s, long *longval) {
3162 char buf[32], *endptr;
3163 long value;
3164 int slen;
3165
3166 value = strtol(s, &endptr, 10);
3167 if (endptr[0] != '\0') return REDIS_ERR;
3168 slen = ll2string(buf,32,value);
3169
3170 /* If the number converted back into a string is not identical
3171 * then it's not possible to encode the string as integer */
3172 if (sdslen(s) != (unsigned)slen || memcmp(buf,s,slen)) return REDIS_ERR;
3173 if (longval) *longval = value;
3174 return REDIS_OK;
3175 }
3176
3177 /* Try to encode a string object in order to save space */
3178 static robj *tryObjectEncoding(robj *o) {
3179 long value;
3180 sds s = o->ptr;
3181
3182 if (o->encoding != REDIS_ENCODING_RAW)
3183 return o; /* Already encoded */
3184
3185 /* It's not safe to encode shared objects: shared objects can be shared
3186 * everywhere in the "object space" of Redis. Encoded objects can only
3187 * appear as "values" (and not, for instance, as keys) */
3188 if (o->refcount > 1) return o;
3189
3190 /* Currently we try to encode only strings */
3191 redisAssert(o->type == REDIS_STRING);
3192
3193 /* Check if we can represent this string as a long integer */
3194 if (isStringRepresentableAsLong(s,&value) == REDIS_ERR) return o;
3195
3196 /* Ok, this object can be encoded */
3197 if (value >= 0 && value < REDIS_SHARED_INTEGERS) {
3198 decrRefCount(o);
3199 incrRefCount(shared.integers[value]);
3200 return shared.integers[value];
3201 } else {
3202 o->encoding = REDIS_ENCODING_INT;
3203 sdsfree(o->ptr);
3204 o->ptr = (void*) value;
3205 return o;
3206 }
3207 }
3208
3209 /* Get a decoded version of an encoded object (returned as a new object).
3210 * If the object is already raw-encoded just increment the ref count. */
3211 static robj *getDecodedObject(robj *o) {
3212 robj *dec;
3213
3214 if (o->encoding == REDIS_ENCODING_RAW) {
3215 incrRefCount(o);
3216 return o;
3217 }
3218 if (o->type == REDIS_STRING && o->encoding == REDIS_ENCODING_INT) {
3219 char buf[32];
3220
3221 ll2string(buf,32,(long)o->ptr);
3222 dec = createStringObject(buf,strlen(buf));
3223 return dec;
3224 } else {
3225 redisPanic("Unknown encoding type");
3226 }
3227 }
3228
3229 /* Compare two string objects via strcmp() or alike.
3230 * Note that the objects may be integer-encoded. In such a case we
3231 * use ll2string() to get a string representation of the numbers on the stack
3232 * and compare the strings, it's much faster than calling getDecodedObject().
3233 *
3234 * Important note: if objects are not integer encoded, but binary-safe strings,
3235 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
3236 * binary safe. */
3237 static int compareStringObjects(robj *a, robj *b) {
3238 redisAssert(a->type == REDIS_STRING && b->type == REDIS_STRING);
3239 char bufa[128], bufb[128], *astr, *bstr;
3240 int bothsds = 1;
3241
3242 if (a == b) return 0;
3243 if (a->encoding != REDIS_ENCODING_RAW) {
3244 ll2string(bufa,sizeof(bufa),(long) a->ptr);
3245 astr = bufa;
3246 bothsds = 0;
3247 } else {
3248 astr = a->ptr;
3249 }
3250 if (b->encoding != REDIS_ENCODING_RAW) {
3251 ll2string(bufb,sizeof(bufb),(long) b->ptr);
3252 bstr = bufb;
3253 bothsds = 0;
3254 } else {
3255 bstr = b->ptr;
3256 }
3257 return bothsds ? sdscmp(astr,bstr) : strcmp(astr,bstr);
3258 }
3259
3260 /* Equal string objects return 1 if the two objects are the same from the
3261 * point of view of a string comparison, otherwise 0 is returned. Note that
3262 * this function is faster then checking for (compareStringObject(a,b) == 0)
3263 * because it can perform some more optimization. */
3264 static int equalStringObjects(robj *a, robj *b) {
3265 if (a->encoding != REDIS_ENCODING_RAW && b->encoding != REDIS_ENCODING_RAW){
3266 return a->ptr == b->ptr;
3267 } else {
3268 return compareStringObjects(a,b) == 0;
3269 }
3270 }
3271
3272 static size_t stringObjectLen(robj *o) {
3273 redisAssert(o->type == REDIS_STRING);
3274 if (o->encoding == REDIS_ENCODING_RAW) {
3275 return sdslen(o->ptr);
3276 } else {
3277 char buf[32];
3278
3279 return ll2string(buf,32,(long)o->ptr);
3280 }
3281 }
3282
3283 static int getDoubleFromObject(robj *o, double *target) {
3284 double value;
3285 char *eptr;
3286
3287 if (o == NULL) {
3288 value = 0;
3289 } else {
3290 redisAssert(o->type == REDIS_STRING);
3291 if (o->encoding == REDIS_ENCODING_RAW) {
3292 value = strtod(o->ptr, &eptr);
3293 if (eptr[0] != '\0') return REDIS_ERR;
3294 } else if (o->encoding == REDIS_ENCODING_INT) {
3295 value = (long)o->ptr;
3296 } else {
3297 redisPanic("Unknown string encoding");
3298 }
3299 }
3300
3301 *target = value;
3302 return REDIS_OK;
3303 }
3304
3305 static int getDoubleFromObjectOrReply(redisClient *c, robj *o, double *target, const char *msg) {
3306 double value;
3307 if (getDoubleFromObject(o, &value) != REDIS_OK) {
3308 if (msg != NULL) {
3309 addReplySds(c, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg));
3310 } else {
3311 addReplySds(c, sdsnew("-ERR value is not a double\r\n"));
3312 }
3313 return REDIS_ERR;
3314 }
3315
3316 *target = value;
3317 return REDIS_OK;
3318 }
3319
3320 static int getLongLongFromObject(robj *o, long long *target) {
3321 long long value;
3322 char *eptr;
3323
3324 if (o == NULL) {
3325 value = 0;
3326 } else {
3327 redisAssert(o->type == REDIS_STRING);
3328 if (o->encoding == REDIS_ENCODING_RAW) {
3329 value = strtoll(o->ptr, &eptr, 10);
3330 if (eptr[0] != '\0') return REDIS_ERR;
3331 } else if (o->encoding == REDIS_ENCODING_INT) {
3332 value = (long)o->ptr;
3333 } else {
3334 redisPanic("Unknown string encoding");
3335 }
3336 }
3337
3338 *target = value;
3339 return REDIS_OK;
3340 }
3341
3342 static int getLongLongFromObjectOrReply(redisClient *c, robj *o, long long *target, const char *msg) {
3343 long long value;
3344 if (getLongLongFromObject(o, &value) != REDIS_OK) {
3345 if (msg != NULL) {
3346 addReplySds(c, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg));
3347 } else {
3348 addReplySds(c, sdsnew("-ERR value is not an integer\r\n"));
3349 }
3350 return REDIS_ERR;
3351 }
3352
3353 *target = value;
3354 return REDIS_OK;
3355 }
3356
3357 static int getLongFromObjectOrReply(redisClient *c, robj *o, long *target, const char *msg) {
3358 long long value;
3359
3360 if (getLongLongFromObjectOrReply(c, o, &value, msg) != REDIS_OK) return REDIS_ERR;
3361 if (value < LONG_MIN || value > LONG_MAX) {
3362 if (msg != NULL) {
3363 addReplySds(c, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg));
3364 } else {
3365 addReplySds(c, sdsnew("-ERR value is out of range\r\n"));
3366 }
3367 return REDIS_ERR;
3368 }
3369
3370 *target = value;
3371 return REDIS_OK;
3372 }
3373
3374 /*============================ RDB saving/loading =========================== */
3375
3376 static int rdbSaveType(FILE *fp, unsigned char type) {
3377 if (fwrite(&type,1,1,fp) == 0) return -1;
3378 return 0;
3379 }
3380
3381 static int rdbSaveTime(FILE *fp, time_t t) {
3382 int32_t t32 = (int32_t) t;
3383 if (fwrite(&t32,4,1,fp) == 0) return -1;
3384 return 0;
3385 }
3386
3387 /* check rdbLoadLen() comments for more info */
3388 static int rdbSaveLen(FILE *fp, uint32_t len) {
3389 unsigned char buf[2];
3390
3391 if (len < (1<<6)) {
3392 /* Save a 6 bit len */
3393 buf[0] = (len&0xFF)|(REDIS_RDB_6BITLEN<<6);
3394 if (fwrite(buf,1,1,fp) == 0) return -1;
3395 } else if (len < (1<<14)) {
3396 /* Save a 14 bit len */
3397 buf[0] = ((len>>8)&0xFF)|(REDIS_RDB_14BITLEN<<6);
3398 buf[1] = len&0xFF;
3399 if (fwrite(buf,2,1,fp) == 0) return -1;
3400 } else {
3401 /* Save a 32 bit len */
3402 buf[0] = (REDIS_RDB_32BITLEN<<6);
3403 if (fwrite(buf,1,1,fp) == 0) return -1;
3404 len = htonl(len);
3405 if (fwrite(&len,4,1,fp) == 0) return -1;
3406 }
3407 return 0;
3408 }
3409
3410 /* Encode 'value' as an integer if possible (if integer will fit the
3411 * supported range). If the function sucessful encoded the integer
3412 * then the (up to 5 bytes) encoded representation is written in the
3413 * string pointed by 'enc' and the length is returned. Otherwise
3414 * 0 is returned. */
3415 static int rdbEncodeInteger(long long value, unsigned char *enc) {
3416 /* Finally check if it fits in our ranges */
3417 if (value >= -(1<<7) && value <= (1<<7)-1) {
3418 enc[0] = (REDIS_RDB_ENCVAL<<6)|REDIS_RDB_ENC_INT8;
3419 enc[1] = value&0xFF;
3420 return 2;
3421 } else if (value >= -(1<<15) && value <= (1<<15)-1) {
3422 enc[0] = (REDIS_RDB_ENCVAL<<6)|REDIS_RDB_ENC_INT16;
3423 enc[1] = value&0xFF;
3424 enc[2] = (value>>8)&0xFF;
3425 return 3;
3426 } else if (value >= -((long long)1<<31) && value <= ((long long)1<<31)-1) {
3427 enc[0] = (REDIS_RDB_ENCVAL<<6)|REDIS_RDB_ENC_INT32;
3428 enc[1] = value&0xFF;
3429 enc[2] = (value>>8)&0xFF;
3430 enc[3] = (value>>16)&0xFF;
3431 enc[4] = (value>>24)&0xFF;
3432 return 5;
3433 } else {
3434 return 0;
3435 }
3436 }
3437
3438 /* String objects in the form "2391" "-100" without any space and with a
3439 * range of values that can fit in an 8, 16 or 32 bit signed value can be
3440 * encoded as integers to save space */
3441 static int rdbTryIntegerEncoding(char *s, size_t len, unsigned char *enc) {
3442 long long value;
3443 char *endptr, buf[32];
3444
3445 /* Check if it's possible to encode this value as a number */
3446 value = strtoll(s, &endptr, 10);
3447 if (endptr[0] != '\0') return 0;
3448 ll2string(buf,32,value);
3449
3450 /* If the number converted back into a string is not identical
3451 * then it's not possible to encode the string as integer */
3452 if (strlen(buf) != len || memcmp(buf,s,len)) return 0;
3453
3454 return rdbEncodeInteger(value,enc);
3455 }
3456
3457 static int rdbSaveLzfStringObject(FILE *fp, unsigned char *s, size_t len) {
3458 size_t comprlen, outlen;
3459 unsigned char byte;
3460 void *out;
3461
3462 /* We require at least four bytes compression for this to be worth it */
3463 if (len <= 4) return 0;
3464 outlen = len-4;
3465 if ((out = zmalloc(outlen+1)) == NULL) return 0;
3466 comprlen = lzf_compress(s, len, out, outlen);
3467 if (comprlen == 0) {
3468 zfree(out);
3469 return 0;
3470 }
3471 /* Data compressed! Let's save it on disk */
3472 byte = (REDIS_RDB_ENCVAL<<6)|REDIS_RDB_ENC_LZF;
3473 if (fwrite(&byte,1,1,fp) == 0) goto writeerr;
3474 if (rdbSaveLen(fp,comprlen) == -1) goto writeerr;
3475 if (rdbSaveLen(fp,len) == -1) goto writeerr;
3476 if (fwrite(out,comprlen,1,fp) == 0) goto writeerr;
3477 zfree(out);
3478 return comprlen;
3479
3480 writeerr:
3481 zfree(out);
3482 return -1;
3483 }
3484
3485 /* Save a string objet as [len][data] on disk. If the object is a string
3486 * representation of an integer value we try to safe it in a special form */
3487 static int rdbSaveRawString(FILE *fp, unsigned char *s, size_t len) {
3488 int enclen;
3489
3490 /* Try integer encoding */
3491 if (len <= 11) {
3492 unsigned char buf[5];
3493 if ((enclen = rdbTryIntegerEncoding((char*)s,len,buf)) > 0) {
3494 if (fwrite(buf,enclen,1,fp) == 0) return -1;
3495 return 0;
3496 }
3497 }
3498
3499 /* Try LZF compression - under 20 bytes it's unable to compress even
3500 * aaaaaaaaaaaaaaaaaa so skip it */
3501 if (server.rdbcompression && len > 20) {
3502 int retval;
3503
3504 retval = rdbSaveLzfStringObject(fp,s,len);
3505 if (retval == -1) return -1;
3506 if (retval > 0) return 0;
3507 /* retval == 0 means data can't be compressed, save the old way */
3508 }
3509
3510 /* Store verbatim */
3511 if (rdbSaveLen(fp,len) == -1) return -1;
3512 if (len && fwrite(s,len,1,fp) == 0) return -1;
3513 return 0;
3514 }
3515
3516 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
3517 static int rdbSaveStringObject(FILE *fp, robj *obj) {
3518 int retval;
3519
3520 /* Avoid to decode the object, then encode it again, if the
3521 * object is alrady integer encoded. */
3522 if (obj->encoding == REDIS_ENCODING_INT) {
3523 long val = (long) obj->ptr;
3524 unsigned char buf[5];
3525 int enclen;
3526
3527 if ((enclen = rdbEncodeInteger(val,buf)) > 0) {
3528 if (fwrite(buf,enclen,1,fp) == 0) return -1;
3529 return 0;
3530 }
3531 /* otherwise... fall throught and continue with the usual
3532 * code path. */
3533 }
3534
3535 /* Avoid incr/decr ref count business when possible.
3536 * This plays well with copy-on-write given that we are probably
3537 * in a child process (BGSAVE). Also this makes sure key objects
3538 * of swapped objects are not incRefCount-ed (an assert does not allow
3539 * this in order to avoid bugs) */
3540 if (obj->encoding != REDIS_ENCODING_RAW) {
3541 obj = getDecodedObject(obj);
3542 retval = rdbSaveRawString(fp,obj->ptr,sdslen(obj->ptr));
3543 decrRefCount(obj);
3544 } else {
3545 retval = rdbSaveRawString(fp,obj->ptr,sdslen(obj->ptr));
3546 }
3547 return retval;
3548 }
3549
3550 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
3551 * 8 bit integer specifing the length of the representation.
3552 * This 8 bit integer has special values in order to specify the following
3553 * conditions:
3554 * 253: not a number
3555 * 254: + inf
3556 * 255: - inf
3557 */
3558 static int rdbSaveDoubleValue(FILE *fp, double val) {
3559 unsigned char buf[128];
3560 int len;
3561
3562 if (isnan(val)) {
3563 buf[0] = 253;
3564 len = 1;
3565 } else if (!isfinite(val)) {
3566 len = 1;
3567 buf[0] = (val < 0) ? 255 : 254;
3568 } else {
3569 #if (DBL_MANT_DIG >= 52) && (LLONG_MAX == 0x7fffffffffffffffLL)
3570 /* Check if the float is in a safe range to be casted into a
3571 * long long. We are assuming that long long is 64 bit here.
3572 * Also we are assuming that there are no implementations around where
3573 * double has precision < 52 bit.
3574 *
3575 * Under this assumptions we test if a double is inside an interval
3576 * where casting to long long is safe. Then using two castings we
3577 * make sure the decimal part is zero. If all this is true we use
3578 * integer printing function that is much faster. */
3579 double min = -4503599627370495; /* (2^52)-1 */
3580 double max = 4503599627370496; /* -(2^52) */
3581 if (val > min && val < max && val == ((double)((long long)val)))
3582 ll2string((char*)buf+1,sizeof(buf),(long long)val);
3583 else
3584 #endif
3585 snprintf((char*)buf+1,sizeof(buf)-1,"%.17g",val);
3586 buf[0] = strlen((char*)buf+1);
3587 len = buf[0]+1;
3588 }
3589 if (fwrite(buf,len,1,fp) == 0) return -1;
3590 return 0;
3591 }
3592
3593 /* Save a Redis object. */
3594 static int rdbSaveObject(FILE *fp, robj *o) {
3595 if (o->type == REDIS_STRING) {
3596 /* Save a string value */
3597 if (rdbSaveStringObject(fp,o) == -1) return -1;
3598 } else if (o->type == REDIS_LIST) {
3599 /* Save a list value */
3600 list *list = o->ptr;
3601 listIter li;
3602 listNode *ln;
3603
3604 if (rdbSaveLen(fp,listLength(list)) == -1) return -1;
3605 listRewind(list,&li);
3606 while((ln = listNext(&li))) {
3607 robj *eleobj = listNodeValue(ln);
3608
3609 if (rdbSaveStringObject(fp,eleobj) == -1) return -1;
3610 }
3611 } else if (o->type == REDIS_SET) {
3612 /* Save a set value */
3613 dict *set = o->ptr;
3614 dictIterator *di = dictGetIterator(set);
3615 dictEntry *de;
3616
3617 if (rdbSaveLen(fp,dictSize(set)) == -1) return -1;
3618 while((de = dictNext(di)) != NULL) {
3619 robj *eleobj = dictGetEntryKey(de);
3620
3621 if (rdbSaveStringObject(fp,eleobj) == -1) return -1;
3622 }
3623 dictReleaseIterator(di);
3624 } else if (o->type == REDIS_ZSET) {
3625 /* Save a set value */
3626 zset *zs = o->ptr;
3627 dictIterator *di = dictGetIterator(zs->dict);
3628 dictEntry *de;
3629
3630 if (rdbSaveLen(fp,dictSize(zs->dict)) == -1) return -1;
3631 while((de = dictNext(di)) != NULL) {
3632 robj *eleobj = dictGetEntryKey(de);
3633 double *score = dictGetEntryVal(de);
3634
3635 if (rdbSaveStringObject(fp,eleobj) == -1) return -1;
3636 if (rdbSaveDoubleValue(fp,*score) == -1) return -1;
3637 }
3638 dictReleaseIterator(di);
3639 } else if (o->type == REDIS_HASH) {
3640 /* Save a hash value */
3641 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
3642 unsigned char *p = zipmapRewind(o->ptr);
3643 unsigned int count = zipmapLen(o->ptr);
3644 unsigned char *key, *val;
3645 unsigned int klen, vlen;
3646
3647 if (rdbSaveLen(fp,count) == -1) return -1;
3648 while((p = zipmapNext(p,&key,&klen,&val,&vlen)) != NULL) {
3649 if (rdbSaveRawString(fp,key,klen) == -1) return -1;
3650 if (rdbSaveRawString(fp,val,vlen) == -1) return -1;
3651 }
3652 } else {
3653 dictIterator *di = dictGetIterator(o->ptr);
3654 dictEntry *de;
3655
3656 if (rdbSaveLen(fp,dictSize((dict*)o->ptr)) == -1) return -1;
3657 while((de = dictNext(di)) != NULL) {
3658 robj *key = dictGetEntryKey(de);
3659 robj *val = dictGetEntryVal(de);
3660
3661 if (rdbSaveStringObject(fp,key) == -1) return -1;
3662 if (rdbSaveStringObject(fp,val) == -1) return -1;
3663 }
3664 dictReleaseIterator(di);
3665 }
3666 } else {
3667 redisPanic("Unknown object type");
3668 }
3669 return 0;
3670 }
3671
3672 /* Return the length the object will have on disk if saved with
3673 * the rdbSaveObject() function. Currently we use a trick to get
3674 * this length with very little changes to the code. In the future
3675 * we could switch to a faster solution. */
3676 static off_t rdbSavedObjectLen(robj *o, FILE *fp) {
3677 if (fp == NULL) fp = server.devnull;
3678 rewind(fp);
3679 assert(rdbSaveObject(fp,o) != 1);
3680 return ftello(fp);
3681 }
3682
3683 /* Return the number of pages required to save this object in the swap file */
3684 static off_t rdbSavedObjectPages(robj *o, FILE *fp) {
3685 off_t bytes = rdbSavedObjectLen(o,fp);
3686
3687 return (bytes+(server.vm_page_size-1))/server.vm_page_size;
3688 }
3689
3690 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3691 static int rdbSave(char *filename) {
3692 dictIterator *di = NULL;
3693 dictEntry *de;
3694 FILE *fp;
3695 char tmpfile[256];
3696 int j;
3697 time_t now = time(NULL);
3698
3699 /* Wait for I/O therads to terminate, just in case this is a
3700 * foreground-saving, to avoid seeking the swap file descriptor at the
3701 * same time. */
3702 if (server.vm_enabled)
3703 waitEmptyIOJobsQueue();
3704
3705 snprintf(tmpfile,256,"temp-%d.rdb", (int) getpid());
3706 fp = fopen(tmpfile,"w");
3707 if (!fp) {
3708 redisLog(REDIS_WARNING, "Failed saving the DB: %s", strerror(errno));
3709 return REDIS_ERR;
3710 }
3711 if (fwrite("REDIS0001",9,1,fp) == 0) goto werr;
3712 for (j = 0; j < server.dbnum; j++) {
3713 redisDb *db = server.db+j;
3714 dict *d = db->dict;
3715 if (dictSize(d) == 0) continue;
3716 di = dictGetIterator(d);
3717 if (!di) {
3718 fclose(fp);
3719 return REDIS_ERR;
3720 }
3721
3722 /* Write the SELECT DB opcode */
3723 if (rdbSaveType(fp,REDIS_SELECTDB) == -1) goto werr;
3724 if (rdbSaveLen(fp,j) == -1) goto werr;
3725
3726 /* Iterate this DB writing every entry */
3727 while((de = dictNext(di)) != NULL) {
3728 robj *key = dictGetEntryKey(de);
3729 robj *o = dictGetEntryVal(de);
3730 time_t expiretime = getExpire(db,key);
3731
3732 /* Save the expire time */
3733 if (expiretime != -1) {
3734 /* If this key is already expired skip it */
3735 if (expiretime < now) continue;
3736 if (rdbSaveType(fp,REDIS_EXPIRETIME) == -1) goto werr;
3737 if (rdbSaveTime(fp,expiretime) == -1) goto werr;
3738 }
3739 /* Save the key and associated value. This requires special
3740 * handling if the value is swapped out. */
3741 if (!server.vm_enabled || key->storage == REDIS_VM_MEMORY ||
3742 key->storage == REDIS_VM_SWAPPING) {
3743 /* Save type, key, value */
3744 if (rdbSaveType(fp,o->type) == -1) goto werr;
3745 if (rdbSaveStringObject(fp,key) == -1) goto werr;
3746 if (rdbSaveObject(fp,o) == -1) goto werr;
3747 } else {
3748 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3749 robj *po;
3750 /* Get a preview of the object in memory */
3751 po = vmPreviewObject(key);
3752 /* Save type, key, value */
3753 if (rdbSaveType(fp,key->vtype) == -1) goto werr;
3754 if (rdbSaveStringObject(fp,key) == -1) goto werr;
3755 if (rdbSaveObject(fp,po) == -1) goto werr;
3756 /* Remove the loaded object from memory */
3757 decrRefCount(po);
3758 }
3759 }
3760 dictReleaseIterator(di);
3761 }
3762 /* EOF opcode */
3763 if (rdbSaveType(fp,REDIS_EOF) == -1) goto werr;
3764
3765 /* Make sure data will not remain on the OS's output buffers */
3766 fflush(fp);
3767 fsync(fileno(fp));
3768 fclose(fp);
3769
3770 /* Use RENAME to make sure the DB file is changed atomically only
3771 * if the generate DB file is ok. */
3772 if (rename(tmpfile,filename) == -1) {
3773 redisLog(REDIS_WARNING,"Error moving temp DB file on the final destination: %s", strerror(errno));
3774 unlink(tmpfile);
3775 return REDIS_ERR;
3776 }
3777 redisLog(REDIS_NOTICE,"DB saved on disk");
3778 server.dirty = 0;
3779 server.lastsave = time(NULL);
3780 return REDIS_OK;
3781
3782 werr:
3783 fclose(fp);
3784 unlink(tmpfile);
3785 redisLog(REDIS_WARNING,"Write error saving DB on disk: %s", strerror(errno));
3786 if (di) dictReleaseIterator(di);
3787 return REDIS_ERR;
3788 }
3789
3790 static int rdbSaveBackground(char *filename) {
3791 pid_t childpid;
3792
3793 if (server.bgsavechildpid != -1) return REDIS_ERR;
3794 if (server.vm_enabled) waitEmptyIOJobsQueue();
3795 if ((childpid = fork()) == 0) {
3796 /* Child */
3797 if (server.vm_enabled) vmReopenSwapFile();
3798 close(server.fd);
3799 if (rdbSave(filename) == REDIS_OK) {
3800 _exit(0);
3801 } else {
3802 _exit(1);
3803 }
3804 } else {
3805 /* Parent */
3806 if (childpid == -1) {
3807 redisLog(REDIS_WARNING,"Can't save in background: fork: %s",
3808 strerror(errno));
3809 return REDIS_ERR;
3810 }
3811 redisLog(REDIS_NOTICE,"Background saving started by pid %d",childpid);
3812 server.bgsavechildpid = childpid;
3813 updateDictResizePolicy();
3814 return REDIS_OK;
3815 }
3816 return REDIS_OK; /* unreached */
3817 }
3818
3819 static void rdbRemoveTempFile(pid_t childpid) {
3820 char tmpfile[256];
3821
3822 snprintf(tmpfile,256,"temp-%d.rdb", (int) childpid);
3823 unlink(tmpfile);
3824 }
3825
3826 static int rdbLoadType(FILE *fp) {
3827 unsigned char type;
3828 if (fread(&type,1,1,fp) == 0) return -1;
3829 return type;
3830 }
3831
3832 static time_t rdbLoadTime(FILE *fp) {
3833 int32_t t32;
3834 if (fread(&t32,4,1,fp) == 0) return -1;
3835 return (time_t) t32;
3836 }
3837
3838 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3839 * of this file for a description of how this are stored on disk.
3840 *
3841 * isencoded is set to 1 if the readed length is not actually a length but
3842 * an "encoding type", check the above comments for more info */
3843 static uint32_t rdbLoadLen(FILE *fp, int *isencoded) {
3844 unsigned char buf[2];
3845 uint32_t len;
3846 int type;
3847
3848 if (isencoded) *isencoded = 0;
3849 if (fread(buf,1,1,fp) == 0) return REDIS_RDB_LENERR;
3850 type = (buf[0]&0xC0)>>6;
3851 if (type == REDIS_RDB_6BITLEN) {
3852 /* Read a 6 bit len */
3853 return buf[0]&0x3F;
3854 } else if (type == REDIS_RDB_ENCVAL) {
3855 /* Read a 6 bit len encoding type */
3856 if (isencoded) *isencoded = 1;
3857 return buf[0]&0x3F;
3858 } else if (type == REDIS_RDB_14BITLEN) {
3859 /* Read a 14 bit len */
3860 if (fread(buf+1,1,1,fp) == 0) return REDIS_RDB_LENERR;
3861 return ((buf[0]&0x3F)<<8)|buf[1];
3862 } else {
3863 /* Read a 32 bit len */
3864 if (fread(&len,4,1,fp) == 0) return REDIS_RDB_LENERR;
3865 return ntohl(len);
3866 }
3867 }
3868
3869 /* Load an integer-encoded object from file 'fp', with the specified
3870 * encoding type 'enctype'. If encode is true the function may return
3871 * an integer-encoded object as reply, otherwise the returned object
3872 * will always be encoded as a raw string. */
3873 static robj *rdbLoadIntegerObject(FILE *fp, int enctype, int encode) {
3874 unsigned char enc[4];
3875 long long val;
3876
3877 if (enctype == REDIS_RDB_ENC_INT8) {
3878 if (fread(enc,1,1,fp) == 0) return NULL;
3879 val = (signed char)enc[0];
3880 } else if (enctype == REDIS_RDB_ENC_INT16) {
3881 uint16_t v;
3882 if (fread(enc,2,1,fp) == 0) return NULL;
3883 v = enc[0]|(enc[1]<<8);
3884 val = (int16_t)v;
3885 } else if (enctype == REDIS_RDB_ENC_INT32) {
3886 uint32_t v;
3887 if (fread(enc,4,1,fp) == 0) return NULL;
3888 v = enc[0]|(enc[1]<<8)|(enc[2]<<16)|(enc[3]<<24);
3889 val = (int32_t)v;
3890 } else {
3891 val = 0; /* anti-warning */
3892 redisPanic("Unknown RDB integer encoding type");
3893 }
3894 if (encode)
3895 return createStringObjectFromLongLong(val);
3896 else
3897 return createObject(REDIS_STRING,sdsfromlonglong(val));
3898 }
3899
3900 static robj *rdbLoadLzfStringObject(FILE*fp) {
3901 unsigned int len, clen;
3902 unsigned char *c = NULL;
3903 sds val = NULL;
3904
3905 if ((clen = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
3906 if ((len = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
3907 if ((c = zmalloc(clen)) == NULL) goto err;
3908 if ((val = sdsnewlen(NULL,len)) == NULL) goto err;
3909 if (fread(c,clen,1,fp) == 0) goto err;
3910 if (lzf_decompress(c,clen,val,len) == 0) goto err;
3911 zfree(c);
3912 return createObject(REDIS_STRING,val);
3913 err:
3914 zfree(c);
3915 sdsfree(val);
3916 return NULL;
3917 }
3918
3919 static robj *rdbGenericLoadStringObject(FILE*fp, int encode) {
3920 int isencoded;
3921 uint32_t len;
3922 sds val;
3923
3924 len = rdbLoadLen(fp,&isencoded);
3925 if (isencoded) {
3926 switch(len) {
3927 case REDIS_RDB_ENC_INT8:
3928 case REDIS_RDB_ENC_INT16:
3929 case REDIS_RDB_ENC_INT32:
3930 return rdbLoadIntegerObject(fp,len,encode);
3931 case REDIS_RDB_ENC_LZF:
3932 return rdbLoadLzfStringObject(fp);
3933 default:
3934 redisPanic("Unknown RDB encoding type");
3935 }
3936 }
3937
3938 if (len == REDIS_RDB_LENERR) return NULL;
3939 val = sdsnewlen(NULL,len);
3940 if (len && fread(val,len,1,fp) == 0) {
3941 sdsfree(val);
3942 return NULL;
3943 }
3944 return createObject(REDIS_STRING,val);
3945 }
3946
3947 static robj *rdbLoadStringObject(FILE *fp) {
3948 return rdbGenericLoadStringObject(fp,0);
3949 }
3950
3951 static robj *rdbLoadEncodedStringObject(FILE *fp) {
3952 return rdbGenericLoadStringObject(fp,1);
3953 }
3954
3955 /* For information about double serialization check rdbSaveDoubleValue() */
3956 static int rdbLoadDoubleValue(FILE *fp, double *val) {
3957 char buf[128];
3958 unsigned char len;
3959
3960 if (fread(&len,1,1,fp) == 0) return -1;
3961 switch(len) {
3962 case 255: *val = R_NegInf; return 0;
3963 case 254: *val = R_PosInf; return 0;
3964 case 253: *val = R_Nan; return 0;
3965 default:
3966 if (fread(buf,len,1,fp) == 0) return -1;
3967 buf[len] = '\0';
3968 sscanf(buf, "%lg", val);
3969 return 0;
3970 }
3971 }
3972
3973 /* Load a Redis object of the specified type from the specified file.
3974 * On success a newly allocated object is returned, otherwise NULL. */
3975 static robj *rdbLoadObject(int type, FILE *fp) {
3976 robj *o;
3977
3978 redisLog(REDIS_DEBUG,"LOADING OBJECT %d (at %d)\n",type,ftell(fp));
3979 if (type == REDIS_STRING) {
3980 /* Read string value */
3981 if ((o = rdbLoadEncodedStringObject(fp)) == NULL) return NULL;
3982 o = tryObjectEncoding(o);
3983 } else if (type == REDIS_LIST || type == REDIS_SET) {
3984 /* Read list/set value */
3985 uint32_t listlen;
3986
3987 if ((listlen = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
3988 o = (type == REDIS_LIST) ? createListObject() : createSetObject();
3989 /* It's faster to expand the dict to the right size asap in order
3990 * to avoid rehashing */
3991 if (type == REDIS_SET && listlen > DICT_HT_INITIAL_SIZE)
3992 dictExpand(o->ptr,listlen);
3993 /* Load every single element of the list/set */
3994 while(listlen--) {
3995 robj *ele;
3996
3997 if ((ele = rdbLoadEncodedStringObject(fp)) == NULL) return NULL;
3998 ele = tryObjectEncoding(ele);
3999 if (type == REDIS_LIST) {
4000 listAddNodeTail((list*)o->ptr,ele);
4001 } else {
4002 dictAdd((dict*)o->ptr,ele,NULL);
4003 }
4004 }
4005 } else if (type == REDIS_ZSET) {
4006 /* Read list/set value */
4007 size_t zsetlen;
4008 zset *zs;
4009
4010 if ((zsetlen = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
4011 o = createZsetObject();
4012 zs = o->ptr;
4013 /* Load every single element of the list/set */
4014 while(zsetlen--) {
4015 robj *ele;
4016 double *score = zmalloc(sizeof(double));
4017
4018 if ((ele = rdbLoadEncodedStringObject(fp)) == NULL) return NULL;
4019 ele = tryObjectEncoding(ele);
4020 if (rdbLoadDoubleValue(fp,score) == -1) return NULL;
4021 dictAdd(zs->dict,ele,score);
4022 zslInsert(zs->zsl,*score,ele);
4023 incrRefCount(ele); /* added to skiplist */
4024 }
4025 } else if (type == REDIS_HASH) {
4026 size_t hashlen;
4027
4028 if ((hashlen = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
4029 o = createHashObject();
4030 /* Too many entries? Use an hash table. */
4031 if (hashlen > server.hash_max_zipmap_entries)
4032 convertToRealHash(o);
4033 /* Load every key/value, then set it into the zipmap or hash
4034 * table, as needed. */
4035 while(hashlen--) {
4036 robj *key, *val;
4037
4038 if ((key = rdbLoadStringObject(fp)) == NULL) return NULL;
4039 if ((val = rdbLoadStringObject(fp)) == NULL) return NULL;
4040 /* If we are using a zipmap and there are too big values
4041 * the object is converted to real hash table encoding. */
4042 if (o->encoding != REDIS_ENCODING_HT &&
4043 (sdslen(key->ptr) > server.hash_max_zipmap_value ||
4044 sdslen(val->ptr) > server.hash_max_zipmap_value))
4045 {
4046 convertToRealHash(o);
4047 }
4048
4049 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
4050 unsigned char *zm = o->ptr;
4051
4052 zm = zipmapSet(zm,key->ptr,sdslen(key->ptr),
4053 val->ptr,sdslen(val->ptr),NULL);
4054 o->ptr = zm;
4055 decrRefCount(key);
4056 decrRefCount(val);
4057 } else {
4058 key = tryObjectEncoding(key);
4059 val = tryObjectEncoding(val);
4060 dictAdd((dict*)o->ptr,key,val);
4061 }
4062 }
4063 } else {
4064 redisPanic("Unknown object type");
4065 }
4066 return o;
4067 }
4068
4069 static int rdbLoad(char *filename) {
4070 FILE *fp;
4071 uint32_t dbid;
4072 int type, retval, rdbver;
4073 int swap_all_values = 0;
4074 dict *d = server.db[0].dict;
4075 redisDb *db = server.db+0;
4076 char buf[1024];
4077 time_t expiretime, now = time(NULL);
4078 long long loadedkeys = 0;
4079
4080 fp = fopen(filename,"r");
4081 if (!fp) return REDIS_ERR;
4082 if (fread(buf,9,1,fp) == 0) goto eoferr;
4083 buf[9] = '\0';
4084 if (memcmp(buf,"REDIS",5) != 0) {
4085 fclose(fp);
4086 redisLog(REDIS_WARNING,"Wrong signature trying to load DB from file");
4087 return REDIS_ERR;
4088 }
4089 rdbver = atoi(buf+5);
4090 if (rdbver != 1) {
4091 fclose(fp);
4092 redisLog(REDIS_WARNING,"Can't handle RDB format version %d",rdbver);
4093 return REDIS_ERR;
4094 }
4095 while(1) {
4096 robj *key, *val;
4097
4098 expiretime = -1;
4099 /* Read type. */
4100 if ((type = rdbLoadType(fp)) == -1) goto eoferr;
4101 if (type == REDIS_EXPIRETIME) {
4102 if ((expiretime = rdbLoadTime(fp)) == -1) goto eoferr;
4103 /* We read the time so we need to read the object type again */
4104 if ((type = rdbLoadType(fp)) == -1) goto eoferr;
4105 }
4106 if (type == REDIS_EOF) break;
4107 /* Handle SELECT DB opcode as a special case */
4108 if (type == REDIS_SELECTDB) {
4109 if ((dbid = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR)
4110 goto eoferr;
4111 if (dbid >= (unsigned)server.dbnum) {
4112 redisLog(REDIS_WARNING,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server.dbnum);
4113 exit(1);
4114 }
4115 db = server.db+dbid;
4116 d = db->dict;
4117 continue;
4118 }
4119 /* Read key */
4120 if ((key = rdbLoadStringObject(fp)) == NULL) goto eoferr;
4121 /* Read value */
4122 if ((val = rdbLoadObject(type,fp)) == NULL) goto eoferr;
4123 /* Check if the key already expired */
4124 if (expiretime != -1 && expiretime < now) {
4125 decrRefCount(key);
4126 decrRefCount(val);
4127 continue;
4128 }
4129 /* Add the new object in the hash table */
4130 retval = dictAdd(d,key,val);
4131 if (retval == DICT_ERR) {
4132 redisLog(REDIS_WARNING,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", key->ptr);
4133 exit(1);
4134 }
4135 loadedkeys++;
4136 /* Set the expire time if needed */
4137 if (expiretime != -1) setExpire(db,key,expiretime);
4138
4139 /* Handle swapping while loading big datasets when VM is on */
4140
4141 /* If we detecter we are hopeless about fitting something in memory
4142 * we just swap every new key on disk. Directly...
4143 * Note that's important to check for this condition before resorting
4144 * to random sampling, otherwise we may try to swap already
4145 * swapped keys. */
4146 if (swap_all_values) {
4147 dictEntry *de = dictFind(d,key);
4148
4149 /* de may be NULL since the key already expired */
4150 if (de) {
4151 key = dictGetEntryKey(de);
4152 val = dictGetEntryVal(de);
4153
4154 if (vmSwapObjectBlocking(key,val) == REDIS_OK) {
4155 dictGetEntryVal(de) = NULL;
4156 }
4157 }
4158 continue;
4159 }
4160
4161 /* If we have still some hope of having some value fitting memory
4162 * then we try random sampling. */
4163 if (!swap_all_values && server.vm_enabled && (loadedkeys % 5000) == 0) {
4164 while (zmalloc_used_memory() > server.vm_max_memory) {
4165 if (vmSwapOneObjectBlocking() == REDIS_ERR) break;
4166 }
4167 if (zmalloc_used_memory() > server.vm_max_memory)
4168 swap_all_values = 1; /* We are already using too much mem */
4169 }
4170 }
4171 fclose(fp);
4172 return REDIS_OK;
4173
4174 eoferr: /* unexpected end of file is handled here with a fatal exit */
4175 redisLog(REDIS_WARNING,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
4176 exit(1);
4177 return REDIS_ERR; /* Just to avoid warning */
4178 }
4179
4180 /*================================== Shutdown =============================== */
4181 static int prepareForShutdown() {
4182 redisLog(REDIS_WARNING,"User requested shutdown, saving DB...");
4183 /* Kill the saving child if there is a background saving in progress.
4184 We want to avoid race conditions, for instance our saving child may
4185 overwrite the synchronous saving did by SHUTDOWN. */
4186 if (server.bgsavechildpid != -1) {
4187 redisLog(REDIS_WARNING,"There is a live saving child. Killing it!");
4188 kill(server.bgsavechildpid,SIGKILL);
4189 rdbRemoveTempFile(server.bgsavechildpid);
4190 }
4191 if (server.appendonly) {
4192 /* Append only file: fsync() the AOF and exit */
4193 fsync(server.appendfd);
4194 if (server.vm_enabled) unlink(server.vm_swap_file);
4195 } else {
4196 /* Snapshotting. Perform a SYNC SAVE and exit */
4197 if (rdbSave(server.dbfilename) == REDIS_OK) {
4198 if (server.daemonize)
4199 unlink(server.pidfile);
4200 redisLog(REDIS_WARNING,"%zu bytes used at exit",zmalloc_used_memory());
4201 } else {
4202 /* Ooops.. error saving! The best we can do is to continue
4203 * operating. Note that if there was a background saving process,
4204 * in the next cron() Redis will be notified that the background
4205 * saving aborted, handling special stuff like slaves pending for
4206 * synchronization... */
4207 redisLog(REDIS_WARNING,"Error trying to save the DB, can't exit");
4208 return REDIS_ERR;
4209 }
4210 }
4211 redisLog(REDIS_WARNING,"Server exit now, bye bye...");
4212 return REDIS_OK;
4213 }
4214
4215 /*================================== Commands =============================== */
4216
4217 static void authCommand(redisClient *c) {
4218 if (!server.requirepass || !strcmp(c->argv[1]->ptr, server.requirepass)) {
4219 c->authenticated = 1;
4220 addReply(c,shared.ok);
4221 } else {
4222 c->authenticated = 0;
4223 addReplySds(c,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
4224 }
4225 }
4226
4227 static void pingCommand(redisClient *c) {
4228 addReply(c,shared.pong);
4229 }
4230
4231 static void echoCommand(redisClient *c) {
4232 addReplyBulk(c,c->argv[1]);
4233 }
4234
4235 /*=================================== Strings =============================== */
4236
4237 static void setGenericCommand(redisClient *c, int nx, robj *key, robj *val, robj *expire) {
4238 int retval;
4239 long seconds = 0; /* initialized to avoid an harmness warning */
4240
4241 if (expire) {
4242 if (getLongFromObjectOrReply(c, expire, &seconds, NULL) != REDIS_OK)
4243 return;
4244 if (seconds <= 0) {
4245 addReplySds(c,sdsnew("-ERR invalid expire time in SETEX\r\n"));
4246 return;
4247 }
4248 }
4249
4250 touchWatchedKey(c->db,key);
4251 if (nx) deleteIfVolatile(c->db,key);
4252 retval = dictAdd(c->db->dict,key,val);
4253 if (retval == DICT_ERR) {
4254 if (!nx) {
4255 /* If the key is about a swapped value, we want a new key object
4256 * to overwrite the old. So we delete the old key in the database.
4257 * This will also make sure that swap pages about the old object
4258 * will be marked as free. */
4259 if (server.vm_enabled && deleteIfSwapped(c->db,key))
4260 incrRefCount(key);
4261 dictReplace(c->db->dict,key,val);
4262 incrRefCount(val);
4263 } else {
4264 addReply(c,shared.czero);
4265 return;
4266 }
4267 } else {
4268 incrRefCount(key);
4269 incrRefCount(val);
4270 }
4271 server.dirty++;
4272 removeExpire(c->db,key);
4273 if (expire) setExpire(c->db,key,time(NULL)+seconds);
4274 addReply(c, nx ? shared.cone : shared.ok);
4275 }
4276
4277 static void setCommand(redisClient *c) {
4278 setGenericCommand(c,0,c->argv[1],c->argv[2],NULL);
4279 }
4280
4281 static void setnxCommand(redisClient *c) {
4282 setGenericCommand(c,1,c->argv[1],c->argv[2],NULL);
4283 }
4284
4285 static void setexCommand(redisClient *c) {
4286 setGenericCommand(c,0,c->argv[1],c->argv[3],c->argv[2]);
4287 }
4288
4289 static int getGenericCommand(redisClient *c) {
4290 robj *o;
4291
4292 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL)
4293 return REDIS_OK;
4294
4295 if (o->type != REDIS_STRING) {
4296 addReply(c,shared.wrongtypeerr);
4297 return REDIS_ERR;
4298 } else {
4299 addReplyBulk(c,o);
4300 return REDIS_OK;
4301 }
4302 }
4303
4304 static void getCommand(redisClient *c) {
4305 getGenericCommand(c);
4306 }
4307
4308 static void getsetCommand(redisClient *c) {
4309 if (getGenericCommand(c) == REDIS_ERR) return;
4310 if (dictAdd(c->db->dict,c->argv[1],c->argv[2]) == DICT_ERR) {
4311 dictReplace(c->db->dict,c->argv[1],c->argv[2]);
4312 } else {
4313 incrRefCount(c->argv[1]);
4314 }
4315 incrRefCount(c->argv[2]);
4316 server.dirty++;
4317 removeExpire(c->db,c->argv[1]);
4318 }
4319
4320 static void mgetCommand(redisClient *c) {
4321 int j;
4322
4323 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",c->argc-1));
4324 for (j = 1; j < c->argc; j++) {
4325 robj *o = lookupKeyRead(c->db,c->argv[j]);
4326 if (o == NULL) {
4327 addReply(c,shared.nullbulk);
4328 } else {
4329 if (o->type != REDIS_STRING) {
4330 addReply(c,shared.nullbulk);
4331 } else {
4332 addReplyBulk(c,o);
4333 }
4334 }
4335 }
4336 }
4337
4338 static void msetGenericCommand(redisClient *c, int nx) {
4339 int j, busykeys = 0;
4340
4341 if ((c->argc % 2) == 0) {
4342 addReplySds(c,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
4343 return;
4344 }
4345 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
4346 * set nothing at all if at least one already key exists. */
4347 if (nx) {
4348 for (j = 1; j < c->argc; j += 2) {
4349 if (lookupKeyWrite(c->db,c->argv[j]) != NULL) {
4350 busykeys++;
4351 }
4352 }
4353 }
4354 if (busykeys) {
4355 addReply(c, shared.czero);
4356 return;
4357 }
4358
4359 for (j = 1; j < c->argc; j += 2) {
4360 int retval;
4361
4362 c->argv[j+1] = tryObjectEncoding(c->argv[j+1]);
4363 retval = dictAdd(c->db->dict,c->argv[j],c->argv[j+1]);
4364 if (retval == DICT_ERR) {
4365 dictReplace(c->db->dict,c->argv[j],c->argv[j+1]);
4366 incrRefCount(c->argv[j+1]);
4367 } else {
4368 incrRefCount(c->argv[j]);
4369 incrRefCount(c->argv[j+1]);
4370 }
4371 removeExpire(c->db,c->argv[j]);
4372 }
4373 server.dirty += (c->argc-1)/2;
4374 addReply(c, nx ? shared.cone : shared.ok);
4375 }
4376
4377 static void msetCommand(redisClient *c) {
4378 msetGenericCommand(c,0);
4379 }
4380
4381 static void msetnxCommand(redisClient *c) {
4382 msetGenericCommand(c,1);
4383 }
4384
4385 static void incrDecrCommand(redisClient *c, long long incr) {
4386 long long value;
4387 int retval;
4388 robj *o;
4389
4390 o = lookupKeyWrite(c->db,c->argv[1]);
4391 if (o != NULL && checkType(c,o,REDIS_STRING)) return;
4392 if (getLongLongFromObjectOrReply(c,o,&value,NULL) != REDIS_OK) return;
4393
4394 value += incr;
4395 o = createStringObjectFromLongLong(value);
4396 retval = dictAdd(c->db->dict,c->argv[1],o);
4397 if (retval == DICT_ERR) {
4398 dictReplace(c->db->dict,c->argv[1],o);
4399 removeExpire(c->db,c->argv[1]);
4400 } else {
4401 incrRefCount(c->argv[1]);
4402 }
4403 server.dirty++;
4404 addReply(c,shared.colon);
4405 addReply(c,o);
4406 addReply(c,shared.crlf);
4407 }
4408
4409 static void incrCommand(redisClient *c) {
4410 incrDecrCommand(c,1);
4411 }
4412
4413 static void decrCommand(redisClient *c) {
4414 incrDecrCommand(c,-1);
4415 }
4416
4417 static void incrbyCommand(redisClient *c) {
4418 long long incr;
4419
4420 if (getLongLongFromObjectOrReply(c, c->argv[2], &incr, NULL) != REDIS_OK) return;
4421 incrDecrCommand(c,incr);
4422 }
4423
4424 static void decrbyCommand(redisClient *c) {
4425 long long incr;
4426
4427 if (getLongLongFromObjectOrReply(c, c->argv[2], &incr, NULL) != REDIS_OK) return;
4428 incrDecrCommand(c,-incr);
4429 }
4430
4431 static void appendCommand(redisClient *c) {
4432 int retval;
4433 size_t totlen;
4434 robj *o;
4435
4436 o = lookupKeyWrite(c->db,c->argv[1]);
4437 if (o == NULL) {
4438 /* Create the key */
4439 retval = dictAdd(c->db->dict,c->argv[1],c->argv[2]);
4440 incrRefCount(c->argv[1]);
4441 incrRefCount(c->argv[2]);
4442 totlen = stringObjectLen(c->argv[2]);
4443 } else {
4444 dictEntry *de;
4445
4446 de = dictFind(c->db->dict,c->argv[1]);
4447 assert(de != NULL);
4448
4449 o = dictGetEntryVal(de);
4450 if (o->type != REDIS_STRING) {
4451 addReply(c,shared.wrongtypeerr);
4452 return;
4453 }
4454 /* If the object is specially encoded or shared we have to make
4455 * a copy */
4456 if (o->refcount != 1 || o->encoding != REDIS_ENCODING_RAW) {
4457 robj *decoded = getDecodedObject(o);
4458
4459 o = createStringObject(decoded->ptr, sdslen(decoded->ptr));
4460 decrRefCount(decoded);
4461 dictReplace(c->db->dict,c->argv[1],o);
4462 }
4463 /* APPEND! */
4464 if (c->argv[2]->encoding == REDIS_ENCODING_RAW) {
4465 o->ptr = sdscatlen(o->ptr,
4466 c->argv[2]->ptr, sdslen(c->argv[2]->ptr));
4467 } else {
4468 o->ptr = sdscatprintf(o->ptr, "%ld",
4469 (unsigned long) c->argv[2]->ptr);
4470 }
4471 totlen = sdslen(o->ptr);
4472 }
4473 server.dirty++;
4474 addReplySds(c,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen));
4475 }
4476
4477 static void substrCommand(redisClient *c) {
4478 robj *o;
4479 long start = atoi(c->argv[2]->ptr);
4480 long end = atoi(c->argv[3]->ptr);
4481 size_t rangelen, strlen;
4482 sds range;
4483
4484 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
4485 checkType(c,o,REDIS_STRING)) return;
4486
4487 o = getDecodedObject(o);
4488 strlen = sdslen(o->ptr);
4489
4490 /* convert negative indexes */
4491 if (start < 0) start = strlen+start;
4492 if (end < 0) end = strlen+end;
4493 if (start < 0) start = 0;
4494 if (end < 0) end = 0;
4495
4496 /* indexes sanity checks */
4497 if (start > end || (size_t)start >= strlen) {
4498 /* Out of range start or start > end result in null reply */
4499 addReply(c,shared.nullbulk);
4500 decrRefCount(o);
4501 return;
4502 }
4503 if ((size_t)end >= strlen) end = strlen-1;
4504 rangelen = (end-start)+1;
4505
4506 /* Return the result */
4507 addReplySds(c,sdscatprintf(sdsempty(),"$%zu\r\n",rangelen));
4508 range = sdsnewlen((char*)o->ptr+start,rangelen);
4509 addReplySds(c,range);
4510 addReply(c,shared.crlf);
4511 decrRefCount(o);
4512 }
4513
4514 /* ========================= Type agnostic commands ========================= */
4515
4516 static void delCommand(redisClient *c) {
4517 int deleted = 0, j;
4518
4519 for (j = 1; j < c->argc; j++) {
4520 if (deleteKey(c->db,c->argv[j])) {
4521 touchWatchedKey(c->db,c->argv[j]);
4522 server.dirty++;
4523 deleted++;
4524 }
4525 }
4526 addReplyLongLong(c,deleted);
4527 }
4528
4529 static void existsCommand(redisClient *c) {
4530 expireIfNeeded(c->db,c->argv[1]);
4531 if (dictFind(c->db->dict,c->argv[1])) {
4532 addReply(c, shared.cone);
4533 } else {
4534 addReply(c, shared.czero);
4535 }
4536 }
4537
4538 static void selectCommand(redisClient *c) {
4539 int id = atoi(c->argv[1]->ptr);
4540
4541 if (selectDb(c,id) == REDIS_ERR) {
4542 addReplySds(c,sdsnew("-ERR invalid DB index\r\n"));
4543 } else {
4544 addReply(c,shared.ok);
4545 }
4546 }
4547
4548 static void randomkeyCommand(redisClient *c) {
4549 dictEntry *de;
4550 robj *key;
4551
4552 while(1) {
4553 de = dictGetRandomKey(c->db->dict);
4554 if (!de || expireIfNeeded(c->db,dictGetEntryKey(de)) == 0) break;
4555 }
4556
4557 if (de == NULL) {
4558 addReply(c,shared.nullbulk);
4559 return;
4560 }
4561
4562 key = dictGetEntryKey(de);
4563 if (server.vm_enabled) {
4564 key = dupStringObject(key);
4565 addReplyBulk(c,key);
4566 decrRefCount(key);
4567 } else {
4568 addReplyBulk(c,key);
4569 }
4570 }
4571
4572 static void keysCommand(redisClient *c) {
4573 dictIterator *di;
4574 dictEntry *de;
4575 sds pattern = c->argv[1]->ptr;
4576 int plen = sdslen(pattern);
4577 unsigned long numkeys = 0;
4578 robj *lenobj = createObject(REDIS_STRING,NULL);
4579
4580 di = dictGetIterator(c->db->dict);
4581 addReply(c,lenobj);
4582 decrRefCount(lenobj);
4583 while((de = dictNext(di)) != NULL) {
4584 robj *keyobj = dictGetEntryKey(de);
4585
4586 sds key = keyobj->ptr;
4587 if ((pattern[0] == '*' && pattern[1] == '\0') ||
4588 stringmatchlen(pattern,plen,key,sdslen(key),0)) {
4589 if (expireIfNeeded(c->db,keyobj) == 0) {
4590 addReplyBulk(c,keyobj);
4591 numkeys++;
4592 }
4593 }
4594 }
4595 dictReleaseIterator(di);
4596 lenobj->ptr = sdscatprintf(sdsempty(),"*%lu\r\n",numkeys);
4597 }
4598
4599 static void dbsizeCommand(redisClient *c) {
4600 addReplySds(c,
4601 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c->db->dict)));
4602 }
4603
4604 static void lastsaveCommand(redisClient *c) {
4605 addReplySds(c,
4606 sdscatprintf(sdsempty(),":%lu\r\n",server.lastsave));
4607 }
4608
4609 static void typeCommand(redisClient *c) {
4610 robj *o;
4611 char *type;
4612
4613 o = lookupKeyRead(c->db,c->argv[1]);
4614 if (o == NULL) {
4615 type = "+none";
4616 } else {
4617 switch(o->type) {
4618 case REDIS_STRING: type = "+string"; break;
4619 case REDIS_LIST: type = "+list"; break;
4620 case REDIS_SET: type = "+set"; break;
4621 case REDIS_ZSET: type = "+zset"; break;
4622 case REDIS_HASH: type = "+hash"; break;
4623 default: type = "+unknown"; break;
4624 }
4625 }
4626 addReplySds(c,sdsnew(type));
4627 addReply(c,shared.crlf);
4628 }
4629
4630 static void saveCommand(redisClient *c) {
4631 if (server.bgsavechildpid != -1) {
4632 addReplySds(c,sdsnew("-ERR background save in progress\r\n"));
4633 return;
4634 }
4635 if (rdbSave(server.dbfilename) == REDIS_OK) {
4636 addReply(c,shared.ok);
4637 } else {
4638 addReply(c,shared.err);
4639 }
4640 }
4641
4642 static void bgsaveCommand(redisClient *c) {
4643 if (server.bgsavechildpid != -1) {
4644 addReplySds(c,sdsnew("-ERR background save already in progress\r\n"));
4645 return;
4646 }
4647 if (rdbSaveBackground(server.dbfilename) == REDIS_OK) {
4648 char *status = "+Background saving started\r\n";
4649 addReplySds(c,sdsnew(status));
4650 } else {
4651 addReply(c,shared.err);
4652 }
4653 }
4654
4655 static void shutdownCommand(redisClient *c) {
4656 if (prepareForShutdown() == REDIS_OK)
4657 exit(0);
4658 addReplySds(c, sdsnew("-ERR Errors trying to SHUTDOWN. Check logs.\r\n"));
4659 }
4660
4661 static void renameGenericCommand(redisClient *c, int nx) {
4662 robj *o;
4663
4664 /* To use the same key as src and dst is probably an error */
4665 if (sdscmp(c->argv[1]->ptr,c->argv[2]->ptr) == 0) {
4666 addReply(c,shared.sameobjecterr);
4667 return;
4668 }
4669
4670 if ((o = lookupKeyWriteOrReply(c,c->argv[1],shared.nokeyerr)) == NULL)
4671 return;
4672
4673 incrRefCount(o);
4674 deleteIfVolatile(c->db,c->argv[2]);
4675 if (dictAdd(c->db->dict,c->argv[2],o) == DICT_ERR) {
4676 if (nx) {
4677 decrRefCount(o);
4678 addReply(c,shared.czero);
4679 return;
4680 }
4681 dictReplace(c->db->dict,c->argv[2],o);
4682 } else {
4683 incrRefCount(c->argv[2]);
4684 }
4685 deleteKey(c->db,c->argv[1]);
4686 server.dirty++;
4687 addReply(c,nx ? shared.cone : shared.ok);
4688 }
4689
4690 static void renameCommand(redisClient *c) {
4691 renameGenericCommand(c,0);
4692 }
4693
4694 static void renamenxCommand(redisClient *c) {
4695 renameGenericCommand(c,1);
4696 }
4697
4698 static void moveCommand(redisClient *c) {
4699 robj *o;
4700 redisDb *src, *dst;
4701 int srcid;
4702
4703 /* Obtain source and target DB pointers */
4704 src = c->db;
4705 srcid = c->db->id;
4706 if (selectDb(c,atoi(c->argv[2]->ptr)) == REDIS_ERR) {
4707 addReply(c,shared.outofrangeerr);
4708 return;
4709 }
4710 dst = c->db;
4711 selectDb(c,srcid); /* Back to the source DB */
4712
4713 /* If the user is moving using as target the same
4714 * DB as the source DB it is probably an error. */
4715 if (src == dst) {
4716 addReply(c,shared.sameobjecterr);
4717 return;
4718 }
4719
4720 /* Check if the element exists and get a reference */
4721 o = lookupKeyWrite(c->db,c->argv[1]);
4722 if (!o) {
4723 addReply(c,shared.czero);
4724 return;
4725 }
4726
4727 /* Try to add the element to the target DB */
4728 deleteIfVolatile(dst,c->argv[1]);
4729 if (dictAdd(dst->dict,c->argv[1],o) == DICT_ERR) {
4730 addReply(c,shared.czero);
4731 return;
4732 }
4733 incrRefCount(c->argv[1]);
4734 incrRefCount(o);
4735
4736 /* OK! key moved, free the entry in the source DB */
4737 deleteKey(src,c->argv[1]);
4738 server.dirty++;
4739 addReply(c,shared.cone);
4740 }
4741
4742 /* =================================== Lists ================================ */
4743 static void pushGenericCommand(redisClient *c, int where) {
4744 robj *lobj;
4745 list *list;
4746
4747 lobj = lookupKeyWrite(c->db,c->argv[1]);
4748 if (lobj == NULL) {
4749 if (handleClientsWaitingListPush(c,c->argv[1],c->argv[2])) {
4750 addReply(c,shared.cone);
4751 return;
4752 }
4753 lobj = createListObject();
4754 list = lobj->ptr;
4755 if (where == REDIS_HEAD) {
4756 listAddNodeHead(list,c->argv[2]);
4757 } else {
4758 listAddNodeTail(list,c->argv[2]);
4759 }
4760 dictAdd(c->db->dict,c->argv[1],lobj);
4761 incrRefCount(c->argv[1]);
4762 incrRefCount(c->argv[2]);
4763 } else {
4764 if (lobj->type != REDIS_LIST) {
4765 addReply(c,shared.wrongtypeerr);
4766 return;
4767 }
4768 if (handleClientsWaitingListPush(c,c->argv[1],c->argv[2])) {
4769 addReply(c,shared.cone);
4770 return;
4771 }
4772 list = lobj->ptr;
4773 if (where == REDIS_HEAD) {
4774 listAddNodeHead(list,c->argv[2]);
4775 } else {
4776 listAddNodeTail(list,c->argv[2]);
4777 }
4778 incrRefCount(c->argv[2]);
4779 }
4780 server.dirty++;
4781 addReplyLongLong(c,listLength(list));
4782 }
4783
4784 static void lpushCommand(redisClient *c) {
4785 pushGenericCommand(c,REDIS_HEAD);
4786 }
4787
4788 static void rpushCommand(redisClient *c) {
4789 pushGenericCommand(c,REDIS_TAIL);
4790 }
4791
4792 static void llenCommand(redisClient *c) {
4793 robj *o;
4794 list *l;
4795
4796 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
4797 checkType(c,o,REDIS_LIST)) return;
4798
4799 l = o->ptr;
4800 addReplyUlong(c,listLength(l));
4801 }
4802
4803 static void lindexCommand(redisClient *c) {
4804 robj *o;
4805 int index = atoi(c->argv[2]->ptr);
4806 list *list;
4807 listNode *ln;
4808
4809 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
4810 checkType(c,o,REDIS_LIST)) return;
4811 list = o->ptr;
4812
4813 ln = listIndex(list, index);
4814 if (ln == NULL) {
4815 addReply(c,shared.nullbulk);
4816 } else {
4817 robj *ele = listNodeValue(ln);
4818 addReplyBulk(c,ele);
4819 }
4820 }
4821
4822 static void lsetCommand(redisClient *c) {
4823 robj *o;
4824 int index = atoi(c->argv[2]->ptr);
4825 list *list;
4826 listNode *ln;
4827
4828 if ((o = lookupKeyWriteOrReply(c,c->argv[1],shared.nokeyerr)) == NULL ||
4829 checkType(c,o,REDIS_LIST)) return;
4830 list = o->ptr;
4831
4832 ln = listIndex(list, index);
4833 if (ln == NULL) {
4834 addReply(c,shared.outofrangeerr);
4835 } else {
4836 robj *ele = listNodeValue(ln);
4837
4838 decrRefCount(ele);
4839 listNodeValue(ln) = c->argv[3];
4840 incrRefCount(c->argv[3]);
4841 addReply(c,shared.ok);
4842 server.dirty++;
4843 }
4844 }
4845
4846 static void popGenericCommand(redisClient *c, int where) {
4847 robj *o;
4848 list *list;
4849 listNode *ln;
4850
4851 if ((o = lookupKeyWriteOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
4852 checkType(c,o,REDIS_LIST)) return;
4853 list = o->ptr;
4854
4855 if (where == REDIS_HEAD)
4856 ln = listFirst(list);
4857 else
4858 ln = listLast(list);
4859
4860 if (ln == NULL) {
4861 addReply(c,shared.nullbulk);
4862 } else {
4863 robj *ele = listNodeValue(ln);
4864 addReplyBulk(c,ele);
4865 listDelNode(list,ln);
4866 if (listLength(list) == 0) deleteKey(c->db,c->argv[1]);
4867 server.dirty++;
4868 }
4869 }
4870
4871 static void lpopCommand(redisClient *c) {
4872 popGenericCommand(c,REDIS_HEAD);
4873 }
4874
4875 static void rpopCommand(redisClient *c) {
4876 popGenericCommand(c,REDIS_TAIL);
4877 }
4878
4879 static void lrangeCommand(redisClient *c) {
4880 robj *o;
4881 int start = atoi(c->argv[2]->ptr);
4882 int end = atoi(c->argv[3]->ptr);
4883 int llen;
4884 int rangelen, j;
4885 list *list;
4886 listNode *ln;
4887 robj *ele;
4888
4889 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.emptymultibulk)) == NULL
4890 || checkType(c,o,REDIS_LIST)) return;
4891 list = o->ptr;
4892 llen = listLength(list);
4893
4894 /* convert negative indexes */
4895 if (start < 0) start = llen+start;
4896 if (end < 0) end = llen+end;
4897 if (start < 0) start = 0;
4898 if (end < 0) end = 0;
4899
4900 /* indexes sanity checks */
4901 if (start > end || start >= llen) {
4902 /* Out of range start or start > end result in empty list */
4903 addReply(c,shared.emptymultibulk);
4904 return;
4905 }
4906 if (end >= llen) end = llen-1;
4907 rangelen = (end-start)+1;
4908
4909 /* Return the result in form of a multi-bulk reply */
4910 ln = listIndex(list, start);
4911 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",rangelen));
4912 for (j = 0; j < rangelen; j++) {
4913 ele = listNodeValue(ln);
4914 addReplyBulk(c,ele);
4915 ln = ln->next;
4916 }
4917 }
4918
4919 static void ltrimCommand(redisClient *c) {
4920 robj *o;
4921 int start = atoi(c->argv[2]->ptr);
4922 int end = atoi(c->argv[3]->ptr);
4923 int llen;
4924 int j, ltrim, rtrim;
4925 list *list;
4926 listNode *ln;
4927
4928 if ((o = lookupKeyWriteOrReply(c,c->argv[1],shared.ok)) == NULL ||
4929 checkType(c,o,REDIS_LIST)) return;
4930 list = o->ptr;
4931 llen = listLength(list);
4932
4933 /* convert negative indexes */
4934 if (start < 0) start = llen+start;
4935 if (end < 0) end = llen+end;
4936 if (start < 0) start = 0;
4937 if (end < 0) end = 0;
4938
4939 /* indexes sanity checks */
4940 if (start > end || start >= llen) {
4941 /* Out of range start or start > end result in empty list */
4942 ltrim = llen;
4943 rtrim = 0;
4944 } else {
4945 if (end >= llen) end = llen-1;
4946 ltrim = start;
4947 rtrim = llen-end-1;
4948 }
4949
4950 /* Remove list elements to perform the trim */
4951 for (j = 0; j < ltrim; j++) {
4952 ln = listFirst(list);
4953 listDelNode(list,ln);
4954 }
4955 for (j = 0; j < rtrim; j++) {
4956 ln = listLast(list);
4957 listDelNode(list,ln);
4958 }
4959 if (listLength(list) == 0) deleteKey(c->db,c->argv[1]);
4960 server.dirty++;
4961 addReply(c,shared.ok);
4962 }
4963
4964 static void lremCommand(redisClient *c) {
4965 robj *o;
4966 list *list;
4967 listNode *ln, *next;
4968 int toremove = atoi(c->argv[2]->ptr);
4969 int removed = 0;
4970 int fromtail = 0;
4971
4972 if ((o = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
4973 checkType(c,o,REDIS_LIST)) return;
4974 list = o->ptr;
4975
4976 if (toremove < 0) {
4977 toremove = -toremove;
4978 fromtail = 1;
4979 }
4980 ln = fromtail ? list->tail : list->head;
4981 while (ln) {
4982 robj *ele = listNodeValue(ln);
4983
4984 next = fromtail ? ln->prev : ln->next;
4985 if (equalStringObjects(ele,c->argv[3])) {
4986 listDelNode(list,ln);
4987 server.dirty++;
4988 removed++;
4989 if (toremove && removed == toremove) break;
4990 }
4991 ln = next;
4992 }
4993 if (listLength(list) == 0) deleteKey(c->db,c->argv[1]);
4994 addReplySds(c,sdscatprintf(sdsempty(),":%d\r\n",removed));
4995 }
4996
4997 /* This is the semantic of this command:
4998 * RPOPLPUSH srclist dstlist:
4999 * IF LLEN(srclist) > 0
5000 * element = RPOP srclist
5001 * LPUSH dstlist element
5002 * RETURN element
5003 * ELSE
5004 * RETURN nil
5005 * END
5006 * END
5007 *
5008 * The idea is to be able to get an element from a list in a reliable way
5009 * since the element is not just returned but pushed against another list
5010 * as well. This command was originally proposed by Ezra Zygmuntowicz.
5011 */
5012 static void rpoplpushcommand(redisClient *c) {
5013 robj *sobj;
5014 list *srclist;
5015 listNode *ln;
5016
5017 if ((sobj = lookupKeyWriteOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
5018 checkType(c,sobj,REDIS_LIST)) return;
5019 srclist = sobj->ptr;
5020 ln = listLast(srclist);
5021
5022 if (ln == NULL) {
5023 addReply(c,shared.nullbulk);
5024 } else {
5025 robj *dobj = lookupKeyWrite(c->db,c->argv[2]);
5026 robj *ele = listNodeValue(ln);
5027 list *dstlist;
5028
5029 if (dobj && dobj->type != REDIS_LIST) {
5030 addReply(c,shared.wrongtypeerr);
5031 return;
5032 }
5033
5034 /* Add the element to the target list (unless it's directly
5035 * passed to some BLPOP-ing client */
5036 if (!handleClientsWaitingListPush(c,c->argv[2],ele)) {
5037 if (dobj == NULL) {
5038 /* Create the list if the key does not exist */
5039 dobj = createListObject();
5040 dictAdd(c->db->dict,c->argv[2],dobj);
5041 incrRefCount(c->argv[2]);
5042 }
5043 dstlist = dobj->ptr;
5044 listAddNodeHead(dstlist,ele);
5045 incrRefCount(ele);
5046 }
5047
5048 /* Send the element to the client as reply as well */
5049 addReplyBulk(c,ele);
5050
5051 /* Finally remove the element from the source list */
5052 listDelNode(srclist,ln);
5053 if (listLength(srclist) == 0) deleteKey(c->db,c->argv[1]);
5054 server.dirty++;
5055 }
5056 }
5057
5058 /* ==================================== Sets ================================ */
5059
5060 static void saddCommand(redisClient *c) {
5061 robj *set;
5062
5063 set = lookupKeyWrite(c->db,c->argv[1]);
5064 if (set == NULL) {
5065 set = createSetObject();
5066 dictAdd(c->db->dict,c->argv[1],set);
5067 incrRefCount(c->argv[1]);
5068 } else {
5069 if (set->type != REDIS_SET) {
5070 addReply(c,shared.wrongtypeerr);
5071 return;
5072 }
5073 }
5074 if (dictAdd(set->ptr,c->argv[2],NULL) == DICT_OK) {
5075 incrRefCount(c->argv[2]);
5076 server.dirty++;
5077 addReply(c,shared.cone);
5078 } else {
5079 addReply(c,shared.czero);
5080 }
5081 }
5082
5083 static void sremCommand(redisClient *c) {
5084 robj *set;
5085
5086 if ((set = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
5087 checkType(c,set,REDIS_SET)) return;
5088
5089 if (dictDelete(set->ptr,c->argv[2]) == DICT_OK) {
5090 server.dirty++;
5091 if (htNeedsResize(set->ptr)) dictResize(set->ptr);
5092 if (dictSize((dict*)set->ptr) == 0) deleteKey(c->db,c->argv[1]);
5093 addReply(c,shared.cone);
5094 } else {
5095 addReply(c,shared.czero);
5096 }
5097 }
5098
5099 static void smoveCommand(redisClient *c) {
5100 robj *srcset, *dstset;
5101
5102 srcset = lookupKeyWrite(c->db,c->argv[1]);
5103 dstset = lookupKeyWrite(c->db,c->argv[2]);
5104
5105 /* If the source key does not exist return 0, if it's of the wrong type
5106 * raise an error */
5107 if (srcset == NULL || srcset->type != REDIS_SET) {
5108 addReply(c, srcset ? shared.wrongtypeerr : shared.czero);
5109 return;
5110 }
5111 /* Error if the destination key is not a set as well */
5112 if (dstset && dstset->type != REDIS_SET) {
5113 addReply(c,shared.wrongtypeerr);
5114 return;
5115 }
5116 /* Remove the element from the source set */
5117 if (dictDelete(srcset->ptr,c->argv[3]) == DICT_ERR) {
5118 /* Key not found in the src set! return zero */
5119 addReply(c,shared.czero);
5120 return;
5121 }
5122 if (dictSize((dict*)srcset->ptr) == 0 && srcset != dstset)
5123 deleteKey(c->db,c->argv[1]);
5124 server.dirty++;
5125 /* Add the element to the destination set */
5126 if (!dstset) {
5127 dstset = createSetObject();
5128 dictAdd(c->db->dict,c->argv[2],dstset);
5129 incrRefCount(c->argv[2]);
5130 }
5131 if (dictAdd(dstset->ptr,c->argv[3],NULL) == DICT_OK)
5132 incrRefCount(c->argv[3]);
5133 addReply(c,shared.cone);
5134 }
5135
5136 static void sismemberCommand(redisClient *c) {
5137 robj *set;
5138
5139 if ((set = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
5140 checkType(c,set,REDIS_SET)) return;
5141
5142 if (dictFind(set->ptr,c->argv[2]))
5143 addReply(c,shared.cone);
5144 else
5145 addReply(c,shared.czero);
5146 }
5147
5148 static void scardCommand(redisClient *c) {
5149 robj *o;
5150 dict *s;
5151
5152 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
5153 checkType(c,o,REDIS_SET)) return;
5154
5155 s = o->ptr;
5156 addReplyUlong(c,dictSize(s));
5157 }
5158
5159 static void spopCommand(redisClient *c) {
5160 robj *set;
5161 dictEntry *de;
5162
5163 if ((set = lookupKeyWriteOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
5164 checkType(c,set,REDIS_SET)) return;
5165
5166 de = dictGetRandomKey(set->ptr);
5167 if (de == NULL) {
5168 addReply(c,shared.nullbulk);
5169 } else {
5170 robj *ele = dictGetEntryKey(de);
5171
5172 addReplyBulk(c,ele);
5173 dictDelete(set->ptr,ele);
5174 if (htNeedsResize(set->ptr)) dictResize(set->ptr);
5175 if (dictSize((dict*)set->ptr) == 0) deleteKey(c->db,c->argv[1]);
5176 server.dirty++;
5177 }
5178 }
5179
5180 static void srandmemberCommand(redisClient *c) {
5181 robj *set;
5182 dictEntry *de;
5183
5184 if ((set = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
5185 checkType(c,set,REDIS_SET)) return;
5186
5187 de = dictGetRandomKey(set->ptr);
5188 if (de == NULL) {
5189 addReply(c,shared.nullbulk);
5190 } else {
5191 robj *ele = dictGetEntryKey(de);
5192
5193 addReplyBulk(c,ele);
5194 }
5195 }
5196
5197 static int qsortCompareSetsByCardinality(const void *s1, const void *s2) {
5198 dict **d1 = (void*) s1, **d2 = (void*) s2;
5199
5200 return dictSize(*d1)-dictSize(*d2);
5201 }
5202
5203 static void sinterGenericCommand(redisClient *c, robj **setskeys, unsigned long setsnum, robj *dstkey) {
5204 dict **dv = zmalloc(sizeof(dict*)*setsnum);
5205 dictIterator *di;
5206 dictEntry *de;
5207 robj *lenobj = NULL, *dstset = NULL;
5208 unsigned long j, cardinality = 0;
5209
5210 for (j = 0; j < setsnum; j++) {
5211 robj *setobj;
5212
5213 setobj = dstkey ?
5214 lookupKeyWrite(c->db,setskeys[j]) :
5215 lookupKeyRead(c->db,setskeys[j]);
5216 if (!setobj) {
5217 zfree(dv);
5218 if (dstkey) {
5219 if (deleteKey(c->db,dstkey))
5220 server.dirty++;
5221 addReply(c,shared.czero);
5222 } else {
5223 addReply(c,shared.emptymultibulk);
5224 }
5225 return;
5226 }
5227 if (setobj->type != REDIS_SET) {
5228 zfree(dv);
5229 addReply(c,shared.wrongtypeerr);
5230 return;
5231 }
5232 dv[j] = setobj->ptr;
5233 }
5234 /* Sort sets from the smallest to largest, this will improve our
5235 * algorithm's performace */
5236 qsort(dv,setsnum,sizeof(dict*),qsortCompareSetsByCardinality);
5237
5238 /* The first thing we should output is the total number of elements...
5239 * since this is a multi-bulk write, but at this stage we don't know
5240 * the intersection set size, so we use a trick, append an empty object
5241 * to the output list and save the pointer to later modify it with the
5242 * right length */
5243 if (!dstkey) {
5244 lenobj = createObject(REDIS_STRING,NULL);
5245 addReply(c,lenobj);
5246 decrRefCount(lenobj);
5247 } else {
5248 /* If we have a target key where to store the resulting set
5249 * create this key with an empty set inside */
5250 dstset = createSetObject();
5251 }
5252
5253 /* Iterate all the elements of the first (smallest) set, and test
5254 * the element against all the other sets, if at least one set does
5255 * not include the element it is discarded */
5256 di = dictGetIterator(dv[0]);
5257
5258 while((de = dictNext(di)) != NULL) {
5259 robj *ele;
5260
5261 for (j = 1; j < setsnum; j++)
5262 if (dictFind(dv[j],dictGetEntryKey(de)) == NULL) break;
5263 if (j != setsnum)
5264 continue; /* at least one set does not contain the member */
5265 ele = dictGetEntryKey(de);
5266 if (!dstkey) {
5267 addReplyBulk(c,ele);
5268 cardinality++;
5269 } else {
5270 dictAdd(dstset->ptr,ele,NULL);
5271 incrRefCount(ele);
5272 }
5273 }
5274 dictReleaseIterator(di);
5275
5276 if (dstkey) {
5277 /* Store the resulting set into the target, if the intersection
5278 * is not an empty set. */
5279 deleteKey(c->db,dstkey);
5280 if (dictSize((dict*)dstset->ptr) > 0) {
5281 dictAdd(c->db->dict,dstkey,dstset);
5282 incrRefCount(dstkey);
5283 addReplyLongLong(c,dictSize((dict*)dstset->ptr));
5284 } else {
5285 decrRefCount(dstset);
5286 addReply(c,shared.czero);
5287 }
5288 server.dirty++;
5289 } else {
5290 lenobj->ptr = sdscatprintf(sdsempty(),"*%lu\r\n",cardinality);
5291 }
5292 zfree(dv);
5293 }
5294
5295 static void sinterCommand(redisClient *c) {
5296 sinterGenericCommand(c,c->argv+1,c->argc-1,NULL);
5297 }
5298
5299 static void sinterstoreCommand(redisClient *c) {
5300 sinterGenericCommand(c,c->argv+2,c->argc-2,c->argv[1]);
5301 }
5302
5303 #define REDIS_OP_UNION 0
5304 #define REDIS_OP_DIFF 1
5305 #define REDIS_OP_INTER 2
5306
5307 static void sunionDiffGenericCommand(redisClient *c, robj **setskeys, int setsnum, robj *dstkey, int op) {
5308 dict **dv = zmalloc(sizeof(dict*)*setsnum);
5309 dictIterator *di;
5310 dictEntry *de;
5311 robj *dstset = NULL;
5312 int j, cardinality = 0;
5313
5314 for (j = 0; j < setsnum; j++) {
5315 robj *setobj;
5316
5317 setobj = dstkey ?
5318 lookupKeyWrite(c->db,setskeys[j]) :
5319 lookupKeyRead(c->db,setskeys[j]);
5320 if (!setobj) {
5321 dv[j] = NULL;
5322 continue;
5323 }
5324 if (setobj->type != REDIS_SET) {
5325 zfree(dv);
5326 addReply(c,shared.wrongtypeerr);
5327 return;
5328 }
5329 dv[j] = setobj->ptr;
5330 }
5331
5332 /* We need a temp set object to store our union. If the dstkey
5333 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
5334 * this set object will be the resulting object to set into the target key*/
5335 dstset = createSetObject();
5336
5337 /* Iterate all the elements of all the sets, add every element a single
5338 * time to the result set */
5339 for (j = 0; j < setsnum; j++) {
5340 if (op == REDIS_OP_DIFF && j == 0 && !dv[j]) break; /* result set is empty */
5341 if (!dv[j]) continue; /* non existing keys are like empty sets */
5342
5343 di = dictGetIterator(dv[j]);
5344
5345 while((de = dictNext(di)) != NULL) {
5346 robj *ele;
5347
5348 /* dictAdd will not add the same element multiple times */
5349 ele = dictGetEntryKey(de);
5350 if (op == REDIS_OP_UNION || j == 0) {
5351 if (dictAdd(dstset->ptr,ele,NULL) == DICT_OK) {
5352 incrRefCount(ele);
5353 cardinality++;
5354 }
5355 } else if (op == REDIS_OP_DIFF) {
5356 if (dictDelete(dstset->ptr,ele) == DICT_OK) {
5357 cardinality--;
5358 }
5359 }
5360 }
5361 dictReleaseIterator(di);
5362
5363 /* result set is empty? Exit asap. */
5364 if (op == REDIS_OP_DIFF && cardinality == 0) break;
5365 }
5366
5367 /* Output the content of the resulting set, if not in STORE mode */
5368 if (!dstkey) {
5369 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",cardinality));
5370 di = dictGetIterator(dstset->ptr);
5371 while((de = dictNext(di)) != NULL) {
5372 robj *ele;
5373
5374 ele = dictGetEntryKey(de);
5375 addReplyBulk(c,ele);
5376 }
5377 dictReleaseIterator(di);
5378 decrRefCount(dstset);
5379 } else {
5380 /* If we have a target key where to store the resulting set
5381 * create this key with the result set inside */
5382 deleteKey(c->db,dstkey);
5383 if (dictSize((dict*)dstset->ptr) > 0) {
5384 dictAdd(c->db->dict,dstkey,dstset);
5385 incrRefCount(dstkey);
5386 addReplyLongLong(c,dictSize((dict*)dstset->ptr));
5387 } else {
5388 decrRefCount(dstset);
5389 addReply(c,shared.czero);
5390 }
5391 server.dirty++;
5392 }
5393 zfree(dv);
5394 }
5395
5396 static void sunionCommand(redisClient *c) {
5397 sunionDiffGenericCommand(c,c->argv+1,c->argc-1,NULL,REDIS_OP_UNION);
5398 }
5399
5400 static void sunionstoreCommand(redisClient *c) {
5401 sunionDiffGenericCommand(c,c->argv+2,c->argc-2,c->argv[1],REDIS_OP_UNION);
5402 }
5403
5404 static void sdiffCommand(redisClient *c) {
5405 sunionDiffGenericCommand(c,c->argv+1,c->argc-1,NULL,REDIS_OP_DIFF);
5406 }
5407
5408 static void sdiffstoreCommand(redisClient *c) {
5409 sunionDiffGenericCommand(c,c->argv+2,c->argc-2,c->argv[1],REDIS_OP_DIFF);
5410 }
5411
5412 /* ==================================== ZSets =============================== */
5413
5414 /* ZSETs are ordered sets using two data structures to hold the same elements
5415 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
5416 * data structure.
5417 *
5418 * The elements are added to an hash table mapping Redis objects to scores.
5419 * At the same time the elements are added to a skip list mapping scores
5420 * to Redis objects (so objects are sorted by scores in this "view"). */
5421
5422 /* This skiplist implementation is almost a C translation of the original
5423 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
5424 * Alternative to Balanced Trees", modified in three ways:
5425 * a) this implementation allows for repeated values.
5426 * b) the comparison is not just by key (our 'score') but by satellite data.
5427 * c) there is a back pointer, so it's a doubly linked list with the back
5428 * pointers being only at "level 1". This allows to traverse the list
5429 * from tail to head, useful for ZREVRANGE. */
5430
5431 static zskiplistNode *zslCreateNode(int level, double score, robj *obj) {
5432 zskiplistNode *zn = zmalloc(sizeof(*zn));
5433
5434 zn->forward = zmalloc(sizeof(zskiplistNode*) * level);
5435 if (level > 1)
5436 zn->span = zmalloc(sizeof(unsigned int) * (level - 1));
5437 else
5438 zn->span = NULL;
5439 zn->score = score;
5440 zn->obj = obj;
5441 return zn;
5442 }
5443
5444 static zskiplist *zslCreate(void) {
5445 int j;
5446 zskiplist *zsl;
5447
5448 zsl = zmalloc(sizeof(*zsl));
5449 zsl->level = 1;
5450 zsl->length = 0;
5451 zsl->header = zslCreateNode(ZSKIPLIST_MAXLEVEL,0,NULL);
5452 for (j = 0; j < ZSKIPLIST_MAXLEVEL; j++) {
5453 zsl->header->forward[j] = NULL;
5454
5455 /* span has space for ZSKIPLIST_MAXLEVEL-1 elements */
5456 if (j < ZSKIPLIST_MAXLEVEL-1)
5457 zsl->header->span[j] = 0;
5458 }
5459 zsl->header->backward = NULL;
5460 zsl->tail = NULL;
5461 return zsl;
5462 }
5463
5464 static void zslFreeNode(zskiplistNode *node) {
5465 decrRefCount(node->obj);
5466 zfree(node->forward);
5467 zfree(node->span);
5468 zfree(node);
5469 }
5470
5471 static void zslFree(zskiplist *zsl) {
5472 zskiplistNode *node = zsl->header->forward[0], *next;
5473
5474 zfree(zsl->header->forward);
5475 zfree(zsl->header->span);
5476 zfree(zsl->header);
5477 while(node) {
5478 next = node->forward[0];
5479 zslFreeNode(node);
5480 node = next;
5481 }
5482 zfree(zsl);
5483 }
5484
5485 static int zslRandomLevel(void) {
5486 int level = 1;
5487 while ((random()&0xFFFF) < (ZSKIPLIST_P * 0xFFFF))
5488 level += 1;
5489 return (level<ZSKIPLIST_MAXLEVEL) ? level : ZSKIPLIST_MAXLEVEL;
5490 }
5491
5492 static void zslInsert(zskiplist *zsl, double score, robj *obj) {
5493 zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;
5494 unsigned int rank[ZSKIPLIST_MAXLEVEL];
5495 int i, level;
5496
5497 x = zsl->header;
5498 for (i = zsl->level-1; i >= 0; i--) {
5499 /* store rank that is crossed to reach the insert position */
5500 rank[i] = i == (zsl->level-1) ? 0 : rank[i+1];
5501
5502 while (x->forward[i] &&
5503 (x->forward[i]->score < score ||
5504 (x->forward[i]->score == score &&
5505 compareStringObjects(x->forward[i]->obj,obj) < 0))) {
5506 rank[i] += i > 0 ? x->span[i-1] : 1;
5507 x = x->forward[i];
5508 }
5509 update[i] = x;
5510 }
5511 /* we assume the key is not already inside, since we allow duplicated
5512 * scores, and the re-insertion of score and redis object should never
5513 * happpen since the caller of zslInsert() should test in the hash table
5514 * if the element is already inside or not. */
5515 level = zslRandomLevel();
5516 if (level > zsl->level) {
5517 for (i = zsl->level; i < level; i++) {
5518 rank[i] = 0;
5519 update[i] = zsl->header;
5520 update[i]->span[i-1] = zsl->length;
5521 }
5522 zsl->level = level;
5523 }
5524 x = zslCreateNode(level,score,obj);
5525 for (i = 0; i < level; i++) {
5526 x->forward[i] = update[i]->forward[i];
5527 update[i]->forward[i] = x;
5528
5529 /* update span covered by update[i] as x is inserted here */
5530 if (i > 0) {
5531 x->span[i-1] = update[i]->span[i-1] - (rank[0] - rank[i]);
5532 update[i]->span[i-1] = (rank[0] - rank[i]) + 1;
5533 }
5534 }
5535
5536 /* increment span for untouched levels */
5537 for (i = level; i < zsl->level; i++) {
5538 update[i]->span[i-1]++;
5539 }
5540
5541 x->backward = (update[0] == zsl->header) ? NULL : update[0];
5542 if (x->forward[0])
5543 x->forward[0]->backward = x;
5544 else
5545 zsl->tail = x;
5546 zsl->length++;
5547 }
5548
5549 /* Internal function used by zslDelete, zslDeleteByScore and zslDeleteByRank */
5550 void zslDeleteNode(zskiplist *zsl, zskiplistNode *x, zskiplistNode **update) {
5551 int i;
5552 for (i = 0; i < zsl->level; i++) {
5553 if (update[i]->forward[i] == x) {
5554 if (i > 0) {
5555 update[i]->span[i-1] += x->span[i-1] - 1;
5556 }
5557 update[i]->forward[i] = x->forward[i];
5558 } else {
5559 /* invariant: i > 0, because update[0]->forward[0]
5560 * is always equal to x */
5561 update[i]->span[i-1] -= 1;
5562 }
5563 }
5564 if (x->forward[0]) {
5565 x->forward[0]->backward = x->backward;
5566 } else {
5567 zsl->tail = x->backward;
5568 }
5569 while(zsl->level > 1 && zsl->header->forward[zsl->level-1] == NULL)
5570 zsl->level--;
5571 zsl->length--;
5572 }
5573
5574 /* Delete an element with matching score/object from the skiplist. */
5575 static int zslDelete(zskiplist *zsl, double score, robj *obj) {
5576 zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;
5577 int i;
5578
5579 x = zsl->header;
5580 for (i = zsl->level-1; i >= 0; i--) {
5581 while (x->forward[i] &&
5582 (x->forward[i]->score < score ||
5583 (x->forward[i]->score == score &&
5584 compareStringObjects(x->forward[i]->obj,obj) < 0)))
5585 x = x->forward[i];
5586 update[i] = x;
5587 }
5588 /* We may have multiple elements with the same score, what we need
5589 * is to find the element with both the right score and object. */
5590 x = x->forward[0];
5591 if (x && score == x->score && equalStringObjects(x->obj,obj)) {
5592 zslDeleteNode(zsl, x, update);
5593 zslFreeNode(x);
5594 return 1;
5595 } else {
5596 return 0; /* not found */
5597 }
5598 return 0; /* not found */
5599 }
5600
5601 /* Delete all the elements with score between min and max from the skiplist.
5602 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
5603 * Note that this function takes the reference to the hash table view of the
5604 * sorted set, in order to remove the elements from the hash table too. */
5605 static unsigned long zslDeleteRangeByScore(zskiplist *zsl, double min, double max, dict *dict) {
5606 zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;
5607 unsigned long removed = 0;
5608 int i;
5609
5610 x = zsl->header;
5611 for (i = zsl->level-1; i >= 0; i--) {
5612 while (x->forward[i] && x->forward[i]->score < min)
5613 x = x->forward[i];
5614 update[i] = x;
5615 }
5616 /* We may have multiple elements with the same score, what we need
5617 * is to find the element with both the right score and object. */
5618 x = x->forward[0];
5619 while (x && x->score <= max) {
5620 zskiplistNode *next = x->forward[0];
5621 zslDeleteNode(zsl, x, update);
5622 dictDelete(dict,x->obj);
5623 zslFreeNode(x);
5624 removed++;
5625 x = next;
5626 }
5627 return removed; /* not found */
5628 }
5629
5630 /* Delete all the elements with rank between start and end from the skiplist.
5631 * Start and end are inclusive. Note that start and end need to be 1-based */
5632 static unsigned long zslDeleteRangeByRank(zskiplist *zsl, unsigned int start, unsigned int end, dict *dict) {
5633 zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;
5634 unsigned long traversed = 0, removed = 0;
5635 int i;
5636
5637 x = zsl->header;
5638 for (i = zsl->level-1; i >= 0; i--) {
5639 while (x->forward[i] && (traversed + (i > 0 ? x->span[i-1] : 1)) < start) {
5640 traversed += i > 0 ? x->span[i-1] : 1;
5641 x = x->forward[i];
5642 }
5643 update[i] = x;
5644 }
5645
5646 traversed++;
5647 x = x->forward[0];
5648 while (x && traversed <= end) {
5649 zskiplistNode *next = x->forward[0];
5650 zslDeleteNode(zsl, x, update);
5651 dictDelete(dict,x->obj);
5652 zslFreeNode(x);
5653 removed++;
5654 traversed++;
5655 x = next;
5656 }
5657 return removed;
5658 }
5659
5660 /* Find the first node having a score equal or greater than the specified one.
5661 * Returns NULL if there is no match. */
5662 static zskiplistNode *zslFirstWithScore(zskiplist *zsl, double score) {
5663 zskiplistNode *x;
5664 int i;
5665
5666 x = zsl->header;
5667 for (i = zsl->level-1; i >= 0; i--) {
5668 while (x->forward[i] && x->forward[i]->score < score)
5669 x = x->forward[i];
5670 }
5671 /* We may have multiple elements with the same score, what we need
5672 * is to find the element with both the right score and object. */
5673 return x->forward[0];
5674 }
5675
5676 /* Find the rank for an element by both score and key.
5677 * Returns 0 when the element cannot be found, rank otherwise.
5678 * Note that the rank is 1-based due to the span of zsl->header to the
5679 * first element. */
5680 static unsigned long zslGetRank(zskiplist *zsl, double score, robj *o) {
5681 zskiplistNode *x;
5682 unsigned long rank = 0;
5683 int i;
5684
5685 x = zsl->header;
5686 for (i = zsl->level-1; i >= 0; i--) {
5687 while (x->forward[i] &&
5688 (x->forward[i]->score < score ||
5689 (x->forward[i]->score == score &&
5690 compareStringObjects(x->forward[i]->obj,o) <= 0))) {
5691 rank += i > 0 ? x->span[i-1] : 1;
5692 x = x->forward[i];
5693 }
5694
5695 /* x might be equal to zsl->header, so test if obj is non-NULL */
5696 if (x->obj && equalStringObjects(x->obj,o)) {
5697 return rank;
5698 }
5699 }
5700 return 0;
5701 }
5702
5703 /* Finds an element by its rank. The rank argument needs to be 1-based. */
5704 zskiplistNode* zslGetElementByRank(zskiplist *zsl, unsigned long rank) {
5705 zskiplistNode *x;
5706 unsigned long traversed = 0;
5707 int i;
5708
5709 x = zsl->header;
5710 for (i = zsl->level-1; i >= 0; i--) {
5711 while (x->forward[i] && (traversed + (i>0 ? x->span[i-1] : 1)) <= rank)
5712 {
5713 traversed += i > 0 ? x->span[i-1] : 1;
5714 x = x->forward[i];
5715 }
5716 if (traversed == rank) {
5717 return x;
5718 }
5719 }
5720 return NULL;
5721 }
5722
5723 /* The actual Z-commands implementations */
5724
5725 /* This generic command implements both ZADD and ZINCRBY.
5726 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
5727 * the increment if the operation is a ZINCRBY (doincrement == 1). */
5728 static void zaddGenericCommand(redisClient *c, robj *key, robj *ele, double scoreval, int doincrement) {
5729 robj *zsetobj;
5730 zset *zs;
5731 double *score;
5732
5733 zsetobj = lookupKeyWrite(c->db,key);
5734 if (zsetobj == NULL) {
5735 zsetobj = createZsetObject();
5736 dictAdd(c->db->dict,key,zsetobj);
5737 incrRefCount(key);
5738 } else {
5739 if (zsetobj->type != REDIS_ZSET) {
5740 addReply(c,shared.wrongtypeerr);
5741 return;
5742 }
5743 }
5744 zs = zsetobj->ptr;
5745
5746 /* Ok now since we implement both ZADD and ZINCRBY here the code
5747 * needs to handle the two different conditions. It's all about setting
5748 * '*score', that is, the new score to set, to the right value. */
5749 score = zmalloc(sizeof(double));
5750 if (doincrement) {
5751 dictEntry *de;
5752
5753 /* Read the old score. If the element was not present starts from 0 */
5754 de = dictFind(zs->dict,ele);
5755 if (de) {
5756 double *oldscore = dictGetEntryVal(de);
5757 *score = *oldscore + scoreval;
5758 } else {
5759 *score = scoreval;
5760 }
5761 } else {
5762 *score = scoreval;
5763 }
5764
5765 /* What follows is a simple remove and re-insert operation that is common
5766 * to both ZADD and ZINCRBY... */
5767 if (dictAdd(zs->dict,ele,score) == DICT_OK) {
5768 /* case 1: New element */
5769 incrRefCount(ele); /* added to hash */
5770 zslInsert(zs->zsl,*score,ele);
5771 incrRefCount(ele); /* added to skiplist */
5772 server.dirty++;
5773 if (doincrement)
5774 addReplyDouble(c,*score);
5775 else
5776 addReply(c,shared.cone);
5777 } else {
5778 dictEntry *de;
5779 double *oldscore;
5780
5781 /* case 2: Score update operation */
5782 de = dictFind(zs->dict,ele);
5783 redisAssert(de != NULL);
5784 oldscore = dictGetEntryVal(de);
5785 if (*score != *oldscore) {
5786 int deleted;
5787
5788 /* Remove and insert the element in the skip list with new score */
5789 deleted = zslDelete(zs->zsl,*oldscore,ele);
5790 redisAssert(deleted != 0);
5791 zslInsert(zs->zsl,*score,ele);
5792 incrRefCount(ele);
5793 /* Update the score in the hash table */
5794 dictReplace(zs->dict,ele,score);
5795 server.dirty++;
5796 } else {
5797 zfree(score);
5798 }
5799 if (doincrement)
5800 addReplyDouble(c,*score);
5801 else
5802 addReply(c,shared.czero);
5803 }
5804 }
5805
5806 static void zaddCommand(redisClient *c) {
5807 double scoreval;
5808
5809 if (getDoubleFromObjectOrReply(c, c->argv[2], &scoreval, NULL) != REDIS_OK) return;
5810 zaddGenericCommand(c,c->argv[1],c->argv[3],scoreval,0);
5811 }
5812
5813 static void zincrbyCommand(redisClient *c) {
5814 double scoreval;
5815
5816 if (getDoubleFromObjectOrReply(c, c->argv[2], &scoreval, NULL) != REDIS_OK) return;
5817 zaddGenericCommand(c,c->argv[1],c->argv[3],scoreval,1);
5818 }
5819
5820 static void zremCommand(redisClient *c) {
5821 robj *zsetobj;
5822 zset *zs;
5823 dictEntry *de;
5824 double *oldscore;
5825 int deleted;
5826
5827 if ((zsetobj = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
5828 checkType(c,zsetobj,REDIS_ZSET)) return;
5829
5830 zs = zsetobj->ptr;
5831 de = dictFind(zs->dict,c->argv[2]);
5832 if (de == NULL) {
5833 addReply(c,shared.czero);
5834 return;
5835 }
5836 /* Delete from the skiplist */
5837 oldscore = dictGetEntryVal(de);
5838 deleted = zslDelete(zs->zsl,*oldscore,c->argv[2]);
5839 redisAssert(deleted != 0);
5840
5841 /* Delete from the hash table */
5842 dictDelete(zs->dict,c->argv[2]);
5843 if (htNeedsResize(zs->dict)) dictResize(zs->dict);
5844 if (dictSize(zs->dict) == 0) deleteKey(c->db,c->argv[1]);
5845 server.dirty++;
5846 addReply(c,shared.cone);
5847 }
5848
5849 static void zremrangebyscoreCommand(redisClient *c) {
5850 double min;
5851 double max;
5852 long deleted;
5853 robj *zsetobj;
5854 zset *zs;
5855
5856 if ((getDoubleFromObjectOrReply(c, c->argv[2], &min, NULL) != REDIS_OK) ||
5857 (getDoubleFromObjectOrReply(c, c->argv[3], &max, NULL) != REDIS_OK)) return;
5858
5859 if ((zsetobj = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
5860 checkType(c,zsetobj,REDIS_ZSET)) return;
5861
5862 zs = zsetobj->ptr;
5863 deleted = zslDeleteRangeByScore(zs->zsl,min,max,zs->dict);
5864 if (htNeedsResize(zs->dict)) dictResize(zs->dict);
5865 if (dictSize(zs->dict) == 0) deleteKey(c->db,c->argv[1]);
5866 server.dirty += deleted;
5867 addReplyLongLong(c,deleted);
5868 }
5869
5870 static void zremrangebyrankCommand(redisClient *c) {
5871 long start;
5872 long end;
5873 int llen;
5874 long deleted;
5875 robj *zsetobj;
5876 zset *zs;
5877
5878 if ((getLongFromObjectOrReply(c, c->argv[2], &start, NULL) != REDIS_OK) ||
5879 (getLongFromObjectOrReply(c, c->argv[3], &end, NULL) != REDIS_OK)) return;
5880
5881 if ((zsetobj = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
5882 checkType(c,zsetobj,REDIS_ZSET)) return;
5883 zs = zsetobj->ptr;
5884 llen = zs->zsl->length;
5885
5886 /* convert negative indexes */
5887 if (start < 0) start = llen+start;
5888 if (end < 0) end = llen+end;
5889 if (start < 0) start = 0;
5890 if (end < 0) end = 0;
5891
5892 /* indexes sanity checks */
5893 if (start > end || start >= llen) {
5894 addReply(c,shared.czero);
5895 return;
5896 }
5897 if (end >= llen) end = llen-1;
5898
5899 /* increment start and end because zsl*Rank functions
5900 * use 1-based rank */
5901 deleted = zslDeleteRangeByRank(zs->zsl,start+1,end+1,zs->dict);
5902 if (htNeedsResize(zs->dict)) dictResize(zs->dict);
5903 if (dictSize(zs->dict) == 0) deleteKey(c->db,c->argv[1]);
5904 server.dirty += deleted;
5905 addReplyLongLong(c, deleted);
5906 }
5907
5908 typedef struct {
5909 dict *dict;
5910 double weight;
5911 } zsetopsrc;
5912
5913 static int qsortCompareZsetopsrcByCardinality(const void *s1, const void *s2) {
5914 zsetopsrc *d1 = (void*) s1, *d2 = (void*) s2;
5915 unsigned long size1, size2;
5916 size1 = d1->dict ? dictSize(d1->dict) : 0;
5917 size2 = d2->dict ? dictSize(d2->dict) : 0;
5918 return size1 - size2;
5919 }
5920
5921 #define REDIS_AGGR_SUM 1
5922 #define REDIS_AGGR_MIN 2
5923 #define REDIS_AGGR_MAX 3
5924
5925 inline static void zunionInterAggregate(double *target, double val, int aggregate) {
5926 if (aggregate == REDIS_AGGR_SUM) {
5927 *target = *target + val;
5928 } else if (aggregate == REDIS_AGGR_MIN) {
5929 *target = val < *target ? val : *target;
5930 } else if (aggregate == REDIS_AGGR_MAX) {
5931 *target = val > *target ? val : *target;
5932 } else {
5933 /* safety net */
5934 redisPanic("Unknown ZUNION/INTER aggregate type");
5935 }
5936 }
5937
5938 static void zunionInterGenericCommand(redisClient *c, robj *dstkey, int op) {
5939 int i, j, zsetnum;
5940 int aggregate = REDIS_AGGR_SUM;
5941 zsetopsrc *src;
5942 robj *dstobj;
5943 zset *dstzset;
5944 dictIterator *di;
5945 dictEntry *de;
5946
5947 /* expect zsetnum input keys to be given */
5948 zsetnum = atoi(c->argv[2]->ptr);
5949 if (zsetnum < 1) {
5950 addReplySds(c,sdsnew("-ERR at least 1 input key is needed for ZUNIONSTORE/ZINTERSTORE\r\n"));
5951 return;
5952 }
5953
5954 /* test if the expected number of keys would overflow */
5955 if (3+zsetnum > c->argc) {
5956 addReply(c,shared.syntaxerr);
5957 return;
5958 }
5959
5960 /* read keys to be used for input */
5961 src = zmalloc(sizeof(zsetopsrc) * zsetnum);
5962 for (i = 0, j = 3; i < zsetnum; i++, j++) {
5963 robj *zsetobj = lookupKeyWrite(c->db,c->argv[j]);
5964 if (!zsetobj) {
5965 src[i].dict = NULL;
5966 } else {
5967 if (zsetobj->type != REDIS_ZSET) {
5968 zfree(src);
5969 addReply(c,shared.wrongtypeerr);
5970 return;
5971 }
5972 src[i].dict = ((zset*)zsetobj->ptr)->dict;
5973 }
5974
5975 /* default all weights to 1 */
5976 src[i].weight = 1.0;
5977 }
5978
5979 /* parse optional extra arguments */
5980 if (j < c->argc) {
5981 int remaining = c->argc - j;
5982
5983 while (remaining) {
5984 if (remaining >= (zsetnum + 1) && !strcasecmp(c->argv[j]->ptr,"weights")) {
5985 j++; remaining--;
5986 for (i = 0; i < zsetnum; i++, j++, remaining--) {
5987 if (getDoubleFromObjectOrReply(c, c->argv[j], &src[i].weight, NULL) != REDIS_OK)
5988 return;
5989 }
5990 } else if (remaining >= 2 && !strcasecmp(c->argv[j]->ptr,"aggregate")) {
5991 j++; remaining--;
5992 if (!strcasecmp(c->argv[j]->ptr,"sum")) {
5993 aggregate = REDIS_AGGR_SUM;
5994 } else if (!strcasecmp(c->argv[j]->ptr,"min")) {
5995 aggregate = REDIS_AGGR_MIN;
5996 } else if (!strcasecmp(c->argv[j]->ptr,"max")) {
5997 aggregate = REDIS_AGGR_MAX;
5998 } else {
5999 zfree(src);
6000 addReply(c,shared.syntaxerr);
6001 return;
6002 }
6003 j++; remaining--;
6004 } else {
6005 zfree(src);
6006 addReply(c,shared.syntaxerr);
6007 return;
6008 }
6009 }
6010 }
6011
6012 /* sort sets from the smallest to largest, this will improve our
6013 * algorithm's performance */
6014 qsort(src,zsetnum,sizeof(zsetopsrc), qsortCompareZsetopsrcByCardinality);
6015
6016 dstobj = createZsetObject();
6017 dstzset = dstobj->ptr;
6018
6019 if (op == REDIS_OP_INTER) {
6020 /* skip going over all entries if the smallest zset is NULL or empty */
6021 if (src[0].dict && dictSize(src[0].dict) > 0) {
6022 /* precondition: as src[0].dict is non-empty and the zsets are ordered
6023 * from small to large, all src[i > 0].dict are non-empty too */
6024 di = dictGetIterator(src[0].dict);
6025 while((de = dictNext(di)) != NULL) {
6026 double *score = zmalloc(sizeof(double)), value;
6027 *score = src[0].weight * (*(double*)dictGetEntryVal(de));
6028
6029 for (j = 1; j < zsetnum; j++) {
6030 dictEntry *other = dictFind(src[j].dict,dictGetEntryKey(de));
6031 if (other) {
6032 value = src[j].weight * (*(double*)dictGetEntryVal(other));
6033 zunionInterAggregate(score, value, aggregate);
6034 } else {
6035 break;
6036 }
6037 }
6038
6039 /* skip entry when not present in every source dict */
6040 if (j != zsetnum) {
6041 zfree(score);
6042 } else {
6043 robj *o = dictGetEntryKey(de);
6044 dictAdd(dstzset->dict,o,score);
6045 incrRefCount(o); /* added to dictionary */
6046 zslInsert(dstzset->zsl,*score,o);
6047 incrRefCount(o); /* added to skiplist */
6048 }
6049 }
6050 dictReleaseIterator(di);
6051 }
6052 } else if (op == REDIS_OP_UNION) {
6053 for (i = 0; i < zsetnum; i++) {
6054 if (!src[i].dict) continue;
6055
6056 di = dictGetIterator(src[i].dict);
6057 while((de = dictNext(di)) != NULL) {
6058 /* skip key when already processed */
6059 if (dictFind(dstzset->dict,dictGetEntryKey(de)) != NULL) continue;
6060
6061 double *score = zmalloc(sizeof(double)), value;
6062 *score = src[i].weight * (*(double*)dictGetEntryVal(de));
6063
6064 /* because the zsets are sorted by size, its only possible
6065 * for sets at larger indices to hold this entry */
6066 for (j = (i+1); j < zsetnum; j++) {
6067 dictEntry *other = dictFind(src[j].dict,dictGetEntryKey(de));
6068 if (other) {
6069 value = src[j].weight * (*(double*)dictGetEntryVal(other));
6070 zunionInterAggregate(score, value, aggregate);
6071 }
6072 }
6073
6074 robj *o = dictGetEntryKey(de);
6075 dictAdd(dstzset->dict,o,score);
6076 incrRefCount(o); /* added to dictionary */
6077 zslInsert(dstzset->zsl,*score,o);
6078 incrRefCount(o); /* added to skiplist */
6079 }
6080 dictReleaseIterator(di);
6081 }
6082 } else {
6083 /* unknown operator */
6084 redisAssert(op == REDIS_OP_INTER || op == REDIS_OP_UNION);
6085 }
6086
6087 deleteKey(c->db,dstkey);
6088 if (dstzset->zsl->length) {
6089 dictAdd(c->db->dict,dstkey,dstobj);
6090 incrRefCount(dstkey);
6091 addReplyLongLong(c, dstzset->zsl->length);
6092 server.dirty++;
6093 } else {
6094 decrRefCount(dstobj);
6095 addReply(c, shared.czero);
6096 }
6097 zfree(src);
6098 }
6099
6100 static void zunionstoreCommand(redisClient *c) {
6101 zunionInterGenericCommand(c,c->argv[1], REDIS_OP_UNION);
6102 }
6103
6104 static void zinterstoreCommand(redisClient *c) {
6105 zunionInterGenericCommand(c,c->argv[1], REDIS_OP_INTER);
6106 }
6107
6108 static void zrangeGenericCommand(redisClient *c, int reverse) {
6109 robj *o;
6110 long start;
6111 long end;
6112 int withscores = 0;
6113 int llen;
6114 int rangelen, j;
6115 zset *zsetobj;
6116 zskiplist *zsl;
6117 zskiplistNode *ln;
6118 robj *ele;
6119
6120 if ((getLongFromObjectOrReply(c, c->argv[2], &start, NULL) != REDIS_OK) ||
6121 (getLongFromObjectOrReply(c, c->argv[3], &end, NULL) != REDIS_OK)) return;
6122
6123 if (c->argc == 5 && !strcasecmp(c->argv[4]->ptr,"withscores")) {
6124 withscores = 1;
6125 } else if (c->argc >= 5) {
6126 addReply(c,shared.syntaxerr);
6127 return;
6128 }
6129
6130 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.emptymultibulk)) == NULL
6131 || checkType(c,o,REDIS_ZSET)) return;
6132 zsetobj = o->ptr;
6133 zsl = zsetobj->zsl;
6134 llen = zsl->length;
6135
6136 /* convert negative indexes */
6137 if (start < 0) start = llen+start;
6138 if (end < 0) end = llen+end;
6139 if (start < 0) start = 0;
6140 if (end < 0) end = 0;
6141
6142 /* indexes sanity checks */
6143 if (start > end || start >= llen) {
6144 /* Out of range start or start > end result in empty list */
6145 addReply(c,shared.emptymultibulk);
6146 return;
6147 }
6148 if (end >= llen) end = llen-1;
6149 rangelen = (end-start)+1;
6150
6151 /* check if starting point is trivial, before searching
6152 * the element in log(N) time */
6153 if (reverse) {
6154 ln = start == 0 ? zsl->tail : zslGetElementByRank(zsl, llen-start);
6155 } else {
6156 ln = start == 0 ?
6157 zsl->header->forward[0] : zslGetElementByRank(zsl, start+1);
6158 }
6159
6160 /* Return the result in form of a multi-bulk reply */
6161 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",
6162 withscores ? (rangelen*2) : rangelen));
6163 for (j = 0; j < rangelen; j++) {
6164 ele = ln->obj;
6165 addReplyBulk(c,ele);
6166 if (withscores)
6167 addReplyDouble(c,ln->score);
6168 ln = reverse ? ln->backward : ln->forward[0];
6169 }
6170 }
6171
6172 static void zrangeCommand(redisClient *c) {
6173 zrangeGenericCommand(c,0);
6174 }
6175
6176 static void zrevrangeCommand(redisClient *c) {
6177 zrangeGenericCommand(c,1);
6178 }
6179
6180 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
6181 * If justcount is non-zero, just the count is returned. */
6182 static void genericZrangebyscoreCommand(redisClient *c, int justcount) {
6183 robj *o;
6184 double min, max;
6185 int minex = 0, maxex = 0; /* are min or max exclusive? */
6186 int offset = 0, limit = -1;
6187 int withscores = 0;
6188 int badsyntax = 0;
6189
6190 /* Parse the min-max interval. If one of the values is prefixed
6191 * by the "(" character, it's considered "open". For instance
6192 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
6193 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
6194 if (((char*)c->argv[2]->ptr)[0] == '(') {
6195 min = strtod((char*)c->argv[2]->ptr+1,NULL);
6196 minex = 1;
6197 } else {
6198 min = strtod(c->argv[2]->ptr,NULL);
6199 }
6200 if (((char*)c->argv[3]->ptr)[0] == '(') {
6201 max = strtod((char*)c->argv[3]->ptr+1,NULL);
6202 maxex = 1;
6203 } else {
6204 max = strtod(c->argv[3]->ptr,NULL);
6205 }
6206
6207 /* Parse "WITHSCORES": note that if the command was called with
6208 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
6209 * enter the following paths to parse WITHSCORES and LIMIT. */
6210 if (c->argc == 5 || c->argc == 8) {
6211 if (strcasecmp(c->argv[c->argc-1]->ptr,"withscores") == 0)
6212 withscores = 1;
6213 else
6214 badsyntax = 1;
6215 }
6216 if (c->argc != (4 + withscores) && c->argc != (7 + withscores))
6217 badsyntax = 1;
6218 if (badsyntax) {
6219 addReplySds(c,
6220 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
6221 return;
6222 }
6223
6224 /* Parse "LIMIT" */
6225 if (c->argc == (7 + withscores) && strcasecmp(c->argv[4]->ptr,"limit")) {
6226 addReply(c,shared.syntaxerr);
6227 return;
6228 } else if (c->argc == (7 + withscores)) {
6229 offset = atoi(c->argv[5]->ptr);
6230 limit = atoi(c->argv[6]->ptr);
6231 if (offset < 0) offset = 0;
6232 }
6233
6234 /* Ok, lookup the key and get the range */
6235 o = lookupKeyRead(c->db,c->argv[1]);
6236 if (o == NULL) {
6237 addReply(c,justcount ? shared.czero : shared.emptymultibulk);
6238 } else {
6239 if (o->type != REDIS_ZSET) {
6240 addReply(c,shared.wrongtypeerr);
6241 } else {
6242 zset *zsetobj = o->ptr;
6243 zskiplist *zsl = zsetobj->zsl;
6244 zskiplistNode *ln;
6245 robj *ele, *lenobj = NULL;
6246 unsigned long rangelen = 0;
6247
6248 /* Get the first node with the score >= min, or with
6249 * score > min if 'minex' is true. */
6250 ln = zslFirstWithScore(zsl,min);
6251 while (minex && ln && ln->score == min) ln = ln->forward[0];
6252
6253 if (ln == NULL) {
6254 /* No element matching the speciifed interval */
6255 addReply(c,justcount ? shared.czero : shared.emptymultibulk);
6256 return;
6257 }
6258
6259 /* We don't know in advance how many matching elements there
6260 * are in the list, so we push this object that will represent
6261 * the multi-bulk length in the output buffer, and will "fix"
6262 * it later */
6263 if (!justcount) {
6264 lenobj = createObject(REDIS_STRING,NULL);
6265 addReply(c,lenobj);
6266 decrRefCount(lenobj);
6267 }
6268
6269 while(ln && (maxex ? (ln->score < max) : (ln->score <= max))) {
6270 if (offset) {
6271 offset--;
6272 ln = ln->forward[0];
6273 continue;
6274 }
6275 if (limit == 0) break;
6276 if (!justcount) {
6277 ele = ln->obj;
6278 addReplyBulk(c,ele);
6279 if (withscores)
6280 addReplyDouble(c,ln->score);
6281 }
6282 ln = ln->forward[0];
6283 rangelen++;
6284 if (limit > 0) limit--;
6285 }
6286 if (justcount) {
6287 addReplyLongLong(c,(long)rangelen);
6288 } else {
6289 lenobj->ptr = sdscatprintf(sdsempty(),"*%lu\r\n",
6290 withscores ? (rangelen*2) : rangelen);
6291 }
6292 }
6293 }
6294 }
6295
6296 static void zrangebyscoreCommand(redisClient *c) {
6297 genericZrangebyscoreCommand(c,0);
6298 }
6299
6300 static void zcountCommand(redisClient *c) {
6301 genericZrangebyscoreCommand(c,1);
6302 }
6303
6304 static void zcardCommand(redisClient *c) {
6305 robj *o;
6306 zset *zs;
6307
6308 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
6309 checkType(c,o,REDIS_ZSET)) return;
6310
6311 zs = o->ptr;
6312 addReplyUlong(c,zs->zsl->length);
6313 }
6314
6315 static void zscoreCommand(redisClient *c) {
6316 robj *o;
6317 zset *zs;
6318 dictEntry *de;
6319
6320 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
6321 checkType(c,o,REDIS_ZSET)) return;
6322
6323 zs = o->ptr;
6324 de = dictFind(zs->dict,c->argv[2]);
6325 if (!de) {
6326 addReply(c,shared.nullbulk);
6327 } else {
6328 double *score = dictGetEntryVal(de);
6329
6330 addReplyDouble(c,*score);
6331 }
6332 }
6333
6334 static void zrankGenericCommand(redisClient *c, int reverse) {
6335 robj *o;
6336 zset *zs;
6337 zskiplist *zsl;
6338 dictEntry *de;
6339 unsigned long rank;
6340 double *score;
6341
6342 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
6343 checkType(c,o,REDIS_ZSET)) return;
6344
6345 zs = o->ptr;
6346 zsl = zs->zsl;
6347 de = dictFind(zs->dict,c->argv[2]);
6348 if (!de) {
6349 addReply(c,shared.nullbulk);
6350 return;
6351 }
6352
6353 score = dictGetEntryVal(de);
6354 rank = zslGetRank(zsl, *score, c->argv[2]);
6355 if (rank) {
6356 if (reverse) {
6357 addReplyLongLong(c, zsl->length - rank);
6358 } else {
6359 addReplyLongLong(c, rank-1);
6360 }
6361 } else {
6362 addReply(c,shared.nullbulk);
6363 }
6364 }
6365
6366 static void zrankCommand(redisClient *c) {
6367 zrankGenericCommand(c, 0);
6368 }
6369
6370 static void zrevrankCommand(redisClient *c) {
6371 zrankGenericCommand(c, 1);
6372 }
6373
6374 /* ========================= Hashes utility functions ======================= */
6375 #define REDIS_HASH_KEY 1
6376 #define REDIS_HASH_VALUE 2
6377
6378 /* Check the length of a number of objects to see if we need to convert a
6379 * zipmap to a real hash. Note that we only check string encoded objects
6380 * as their string length can be queried in constant time. */
6381 static void hashTryConversion(robj *subject, robj **argv, int start, int end) {
6382 int i;
6383 if (subject->encoding != REDIS_ENCODING_ZIPMAP) return;
6384
6385 for (i = start; i <= end; i++) {
6386 if (argv[i]->encoding == REDIS_ENCODING_RAW &&
6387 sdslen(argv[i]->ptr) > server.hash_max_zipmap_value)
6388 {
6389 convertToRealHash(subject);
6390 return;
6391 }
6392 }
6393 }
6394
6395 /* Encode given objects in-place when the hash uses a dict. */
6396 static void hashTryObjectEncoding(robj *subject, robj **o1, robj **o2) {
6397 if (subject->encoding == REDIS_ENCODING_HT) {
6398 if (o1) *o1 = tryObjectEncoding(*o1);
6399 if (o2) *o2 = tryObjectEncoding(*o2);
6400 }
6401 }
6402
6403 /* Get the value from a hash identified by key. Returns either a string
6404 * object or NULL if the value cannot be found. The refcount of the object
6405 * is always increased by 1 when the value was found. */
6406 static robj *hashGet(robj *o, robj *key) {
6407 robj *value = NULL;
6408 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
6409 unsigned char *v;
6410 unsigned int vlen;
6411 key = getDecodedObject(key);
6412 if (zipmapGet(o->ptr,key->ptr,sdslen(key->ptr),&v,&vlen)) {
6413 value = createStringObject((char*)v,vlen);
6414 }
6415 decrRefCount(key);
6416 } else {
6417 dictEntry *de = dictFind(o->ptr,key);
6418 if (de != NULL) {
6419 value = dictGetEntryVal(de);
6420 incrRefCount(value);
6421 }
6422 }
6423 return value;
6424 }
6425
6426 /* Test if the key exists in the given hash. Returns 1 if the key
6427 * exists and 0 when it doesn't. */
6428 static int hashExists(robj *o, robj *key) {
6429 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
6430 key = getDecodedObject(key);
6431 if (zipmapExists(o->ptr,key->ptr,sdslen(key->ptr))) {
6432 decrRefCount(key);
6433 return 1;
6434 }
6435 decrRefCount(key);
6436 } else {
6437 if (dictFind(o->ptr,key) != NULL) {
6438 return 1;
6439 }
6440 }
6441 return 0;
6442 }
6443
6444 /* Add an element, discard the old if the key already exists.
6445 * Return 0 on insert and 1 on update. */
6446 static int hashSet(robj *o, robj *key, robj *value) {
6447 int update = 0;
6448 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
6449 key = getDecodedObject(key);
6450 value = getDecodedObject(value);
6451 o->ptr = zipmapSet(o->ptr,
6452 key->ptr,sdslen(key->ptr),
6453 value->ptr,sdslen(value->ptr), &update);
6454 decrRefCount(key);
6455 decrRefCount(value);
6456
6457 /* Check if the zipmap needs to be upgraded to a real hash table */
6458 if (zipmapLen(o->ptr) > server.hash_max_zipmap_entries)
6459 convertToRealHash(o);
6460 } else {
6461 if (dictReplace(o->ptr,key,value)) {
6462 /* Insert */
6463 incrRefCount(key);
6464 } else {
6465 /* Update */
6466 update = 1;
6467 }
6468 incrRefCount(value);
6469 }
6470 return update;
6471 }
6472
6473 /* Delete an element from a hash.
6474 * Return 1 on deleted and 0 on not found. */
6475 static int hashDelete(robj *o, robj *key) {
6476 int deleted = 0;
6477 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
6478 key = getDecodedObject(key);
6479 o->ptr = zipmapDel(o->ptr,key->ptr,sdslen(key->ptr), &deleted);
6480 decrRefCount(key);
6481 } else {
6482 deleted = dictDelete((dict*)o->ptr,key) == DICT_OK;
6483 /* Always check if the dictionary needs a resize after a delete. */
6484 if (deleted && htNeedsResize(o->ptr)) dictResize(o->ptr);
6485 }
6486 return deleted;
6487 }
6488
6489 /* Return the number of elements in a hash. */
6490 static unsigned long hashLength(robj *o) {
6491 return (o->encoding == REDIS_ENCODING_ZIPMAP) ?
6492 zipmapLen((unsigned char*)o->ptr) : dictSize((dict*)o->ptr);
6493 }
6494
6495 /* Structure to hold hash iteration abstration. Note that iteration over
6496 * hashes involves both fields and values. Because it is possible that
6497 * not both are required, store pointers in the iterator to avoid
6498 * unnecessary memory allocation for fields/values. */
6499 typedef struct {
6500 int encoding;
6501 unsigned char *zi;
6502 unsigned char *zk, *zv;
6503 unsigned int zklen, zvlen;
6504
6505 dictIterator *di;
6506 dictEntry *de;
6507 } hashIterator;
6508
6509 static hashIterator *hashInitIterator(robj *subject) {
6510 hashIterator *hi = zmalloc(sizeof(hashIterator));
6511 hi->encoding = subject->encoding;
6512 if (hi->encoding == REDIS_ENCODING_ZIPMAP) {
6513 hi->zi = zipmapRewind(subject->ptr);
6514 } else if (hi->encoding == REDIS_ENCODING_HT) {
6515 hi->di = dictGetIterator(subject->ptr);
6516 } else {
6517 redisAssert(NULL);
6518 }
6519 return hi;
6520 }
6521
6522 static void hashReleaseIterator(hashIterator *hi) {
6523 if (hi->encoding == REDIS_ENCODING_HT) {
6524 dictReleaseIterator(hi->di);
6525 }
6526 zfree(hi);
6527 }
6528
6529 /* Move to the next entry in the hash. Return REDIS_OK when the next entry
6530 * could be found and REDIS_ERR when the iterator reaches the end. */
6531 static int hashNext(hashIterator *hi) {
6532 if (hi->encoding == REDIS_ENCODING_ZIPMAP) {
6533 if ((hi->zi = zipmapNext(hi->zi, &hi->zk, &hi->zklen,
6534 &hi->zv, &hi->zvlen)) == NULL) return REDIS_ERR;
6535 } else {
6536 if ((hi->de = dictNext(hi->di)) == NULL) return REDIS_ERR;
6537 }
6538 return REDIS_OK;
6539 }
6540
6541 /* Get key or value object at current iteration position.
6542 * This increases the refcount of the field object by 1. */
6543 static robj *hashCurrent(hashIterator *hi, int what) {
6544 robj *o;
6545 if (hi->encoding == REDIS_ENCODING_ZIPMAP) {
6546 if (what & REDIS_HASH_KEY) {
6547 o = createStringObject((char*)hi->zk,hi->zklen);
6548 } else {
6549 o = createStringObject((char*)hi->zv,hi->zvlen);
6550 }
6551 } else {
6552 if (what & REDIS_HASH_KEY) {
6553 o = dictGetEntryKey(hi->de);
6554 } else {
6555 o = dictGetEntryVal(hi->de);
6556 }
6557 incrRefCount(o);
6558 }
6559 return o;
6560 }
6561
6562 static robj *hashLookupWriteOrCreate(redisClient *c, robj *key) {
6563 robj *o = lookupKeyWrite(c->db,key);
6564 if (o == NULL) {
6565 o = createHashObject();
6566 dictAdd(c->db->dict,key,o);
6567 incrRefCount(key);
6568 } else {
6569 if (o->type != REDIS_HASH) {
6570 addReply(c,shared.wrongtypeerr);
6571 return NULL;
6572 }
6573 }
6574 return o;
6575 }
6576
6577 /* ============================= Hash commands ============================== */
6578 static void hsetCommand(redisClient *c) {
6579 int update;
6580 robj *o;
6581
6582 if ((o = hashLookupWriteOrCreate(c,c->argv[1])) == NULL) return;
6583 hashTryConversion(o,c->argv,2,3);
6584 hashTryObjectEncoding(o,&c->argv[2], &c->argv[3]);
6585 update = hashSet(o,c->argv[2],c->argv[3]);
6586 addReply(c, update ? shared.czero : shared.cone);
6587 server.dirty++;
6588 }
6589
6590 static void hsetnxCommand(redisClient *c) {
6591 robj *o;
6592 if ((o = hashLookupWriteOrCreate(c,c->argv[1])) == NULL) return;
6593 hashTryConversion(o,c->argv,2,3);
6594
6595 if (hashExists(o, c->argv[2])) {
6596 addReply(c, shared.czero);
6597 } else {
6598 hashTryObjectEncoding(o,&c->argv[2], &c->argv[3]);
6599 hashSet(o,c->argv[2],c->argv[3]);
6600 addReply(c, shared.cone);
6601 server.dirty++;
6602 }
6603 }
6604
6605 static void hmsetCommand(redisClient *c) {
6606 int i;
6607 robj *o;
6608
6609 if ((c->argc % 2) == 1) {
6610 addReplySds(c,sdsnew("-ERR wrong number of arguments for HMSET\r\n"));
6611 return;
6612 }
6613
6614 if ((o = hashLookupWriteOrCreate(c,c->argv[1])) == NULL) return;
6615 hashTryConversion(o,c->argv,2,c->argc-1);
6616 for (i = 2; i < c->argc; i += 2) {
6617 hashTryObjectEncoding(o,&c->argv[i], &c->argv[i+1]);
6618 hashSet(o,c->argv[i],c->argv[i+1]);
6619 }
6620 addReply(c, shared.ok);
6621 server.dirty++;
6622 }
6623
6624 static void hincrbyCommand(redisClient *c) {
6625 long long value, incr;
6626 robj *o, *current, *new;
6627
6628 if (getLongLongFromObjectOrReply(c,c->argv[3],&incr,NULL) != REDIS_OK) return;
6629 if ((o = hashLookupWriteOrCreate(c,c->argv[1])) == NULL) return;
6630 if ((current = hashGet(o,c->argv[2])) != NULL) {
6631 if (getLongLongFromObjectOrReply(c,current,&value,
6632 "hash value is not an integer") != REDIS_OK) {
6633 decrRefCount(current);
6634 return;
6635 }
6636 decrRefCount(current);
6637 } else {
6638 value = 0;
6639 }
6640
6641 value += incr;
6642 new = createStringObjectFromLongLong(value);
6643 hashTryObjectEncoding(o,&c->argv[2],NULL);
6644 hashSet(o,c->argv[2],new);
6645 decrRefCount(new);
6646 addReplyLongLong(c,value);
6647 server.dirty++;
6648 }
6649
6650 static void hgetCommand(redisClient *c) {
6651 robj *o, *value;
6652 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
6653 checkType(c,o,REDIS_HASH)) return;
6654
6655 if ((value = hashGet(o,c->argv[2])) != NULL) {
6656 addReplyBulk(c,value);
6657 decrRefCount(value);
6658 } else {
6659 addReply(c,shared.nullbulk);
6660 }
6661 }
6662
6663 static void hmgetCommand(redisClient *c) {
6664 int i;
6665 robj *o, *value;
6666 o = lookupKeyRead(c->db,c->argv[1]);
6667 if (o != NULL && o->type != REDIS_HASH) {
6668 addReply(c,shared.wrongtypeerr);
6669 }
6670
6671 /* Note the check for o != NULL happens inside the loop. This is
6672 * done because objects that cannot be found are considered to be
6673 * an empty hash. The reply should then be a series of NULLs. */
6674 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",c->argc-2));
6675 for (i = 2; i < c->argc; i++) {
6676 if (o != NULL && (value = hashGet(o,c->argv[i])) != NULL) {
6677 addReplyBulk(c,value);
6678 decrRefCount(value);
6679 } else {
6680 addReply(c,shared.nullbulk);
6681 }
6682 }
6683 }
6684
6685 static void hdelCommand(redisClient *c) {
6686 robj *o;
6687 if ((o = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
6688 checkType(c,o,REDIS_HASH)) return;
6689
6690 if (hashDelete(o,c->argv[2])) {
6691 if (hashLength(o) == 0) deleteKey(c->db,c->argv[1]);
6692 addReply(c,shared.cone);
6693 server.dirty++;
6694 } else {
6695 addReply(c,shared.czero);
6696 }
6697 }
6698
6699 static void hlenCommand(redisClient *c) {
6700 robj *o;
6701 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
6702 checkType(c,o,REDIS_HASH)) return;
6703
6704 addReplyUlong(c,hashLength(o));
6705 }
6706
6707 static void genericHgetallCommand(redisClient *c, int flags) {
6708 robj *o, *lenobj, *obj;
6709 unsigned long count = 0;
6710 hashIterator *hi;
6711
6712 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.emptymultibulk)) == NULL
6713 || checkType(c,o,REDIS_HASH)) return;
6714
6715 lenobj = createObject(REDIS_STRING,NULL);
6716 addReply(c,lenobj);
6717 decrRefCount(lenobj);
6718
6719 hi = hashInitIterator(o);
6720 while (hashNext(hi) != REDIS_ERR) {
6721 if (flags & REDIS_HASH_KEY) {
6722 obj = hashCurrent(hi,REDIS_HASH_KEY);
6723 addReplyBulk(c,obj);
6724 decrRefCount(obj);
6725 count++;
6726 }
6727 if (flags & REDIS_HASH_VALUE) {
6728 obj = hashCurrent(hi,REDIS_HASH_VALUE);
6729 addReplyBulk(c,obj);
6730 decrRefCount(obj);
6731 count++;
6732 }
6733 }
6734 hashReleaseIterator(hi);
6735
6736 lenobj->ptr = sdscatprintf(sdsempty(),"*%lu\r\n",count);
6737 }
6738
6739 static void hkeysCommand(redisClient *c) {
6740 genericHgetallCommand(c,REDIS_HASH_KEY);
6741 }
6742
6743 static void hvalsCommand(redisClient *c) {
6744 genericHgetallCommand(c,REDIS_HASH_VALUE);
6745 }
6746
6747 static void hgetallCommand(redisClient *c) {
6748 genericHgetallCommand(c,REDIS_HASH_KEY|REDIS_HASH_VALUE);
6749 }
6750
6751 static void hexistsCommand(redisClient *c) {
6752 robj *o;
6753 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
6754 checkType(c,o,REDIS_HASH)) return;
6755
6756 addReply(c, hashExists(o,c->argv[2]) ? shared.cone : shared.czero);
6757 }
6758
6759 static void convertToRealHash(robj *o) {
6760 unsigned char *key, *val, *p, *zm = o->ptr;
6761 unsigned int klen, vlen;
6762 dict *dict = dictCreate(&hashDictType,NULL);
6763
6764 assert(o->type == REDIS_HASH && o->encoding != REDIS_ENCODING_HT);
6765 p = zipmapRewind(zm);
6766 while((p = zipmapNext(p,&key,&klen,&val,&vlen)) != NULL) {
6767 robj *keyobj, *valobj;
6768
6769 keyobj = createStringObject((char*)key,klen);
6770 valobj = createStringObject((char*)val,vlen);
6771 keyobj = tryObjectEncoding(keyobj);
6772 valobj = tryObjectEncoding(valobj);
6773 dictAdd(dict,keyobj,valobj);
6774 }
6775 o->encoding = REDIS_ENCODING_HT;
6776 o->ptr = dict;
6777 zfree(zm);
6778 }
6779
6780 /* ========================= Non type-specific commands ==================== */
6781
6782 static void flushdbCommand(redisClient *c) {
6783 server.dirty += dictSize(c->db->dict);
6784 touchWatchedKeysOnFlush(c->db->id);
6785 dictEmpty(c->db->dict);
6786 dictEmpty(c->db->expires);
6787 addReply(c,shared.ok);
6788 }
6789
6790 static void flushallCommand(redisClient *c) {
6791 touchWatchedKeysOnFlush(-1);
6792 server.dirty += emptyDb();
6793 addReply(c,shared.ok);
6794 if (server.bgsavechildpid != -1) {
6795 kill(server.bgsavechildpid,SIGKILL);
6796 rdbRemoveTempFile(server.bgsavechildpid);
6797 }
6798 rdbSave(server.dbfilename);
6799 server.dirty++;
6800 }
6801
6802 static redisSortOperation *createSortOperation(int type, robj *pattern) {
6803 redisSortOperation *so = zmalloc(sizeof(*so));
6804 so->type = type;
6805 so->pattern = pattern;
6806 return so;
6807 }
6808
6809 /* Return the value associated to the key with a name obtained
6810 * substituting the first occurence of '*' in 'pattern' with 'subst'.
6811 * The returned object will always have its refcount increased by 1
6812 * when it is non-NULL. */
6813 static robj *lookupKeyByPattern(redisDb *db, robj *pattern, robj *subst) {
6814 char *p, *f;
6815 sds spat, ssub;
6816 robj keyobj, fieldobj, *o;
6817 int prefixlen, sublen, postfixlen, fieldlen;
6818 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
6819 struct {
6820 long len;
6821 long free;
6822 char buf[REDIS_SORTKEY_MAX+1];
6823 } keyname, fieldname;
6824
6825 /* If the pattern is "#" return the substitution object itself in order
6826 * to implement the "SORT ... GET #" feature. */
6827 spat = pattern->ptr;
6828 if (spat[0] == '#' && spat[1] == '\0') {
6829 incrRefCount(subst);
6830 return subst;
6831 }
6832
6833 /* The substitution object may be specially encoded. If so we create
6834 * a decoded object on the fly. Otherwise getDecodedObject will just
6835 * increment the ref count, that we'll decrement later. */
6836 subst = getDecodedObject(subst);
6837
6838 ssub = subst->ptr;
6839 if (sdslen(spat)+sdslen(ssub)-1 > REDIS_SORTKEY_MAX) return NULL;
6840 p = strchr(spat,'*');
6841 if (!p) {
6842 decrRefCount(subst);
6843 return NULL;
6844 }
6845
6846 /* Find out if we're dealing with a hash dereference. */
6847 if ((f = strstr(p+1, "->")) != NULL) {
6848 fieldlen = sdslen(spat)-(f-spat);
6849 /* this also copies \0 character */
6850 memcpy(fieldname.buf,f+2,fieldlen-1);
6851 fieldname.len = fieldlen-2;
6852 } else {
6853 fieldlen = 0;
6854 }
6855
6856 prefixlen = p-spat;
6857 sublen = sdslen(ssub);
6858 postfixlen = sdslen(spat)-(prefixlen+1)-fieldlen;
6859 memcpy(keyname.buf,spat,prefixlen);
6860 memcpy(keyname.buf+prefixlen,ssub,sublen);
6861 memcpy(keyname.buf+prefixlen+sublen,p+1,postfixlen);
6862 keyname.buf[prefixlen+sublen+postfixlen] = '\0';
6863 keyname.len = prefixlen+sublen+postfixlen;
6864 decrRefCount(subst);
6865
6866 /* Lookup substituted key */
6867 initStaticStringObject(keyobj,((char*)&keyname)+(sizeof(long)*2));
6868 o = lookupKeyRead(db,&keyobj);
6869 if (o == NULL) return NULL;
6870
6871 if (fieldlen > 0) {
6872 if (o->type != REDIS_HASH || fieldname.len < 1) return NULL;
6873
6874 /* Retrieve value from hash by the field name. This operation
6875 * already increases the refcount of the returned object. */
6876 initStaticStringObject(fieldobj,((char*)&fieldname)+(sizeof(long)*2));
6877 o = hashGet(o, &fieldobj);
6878 } else {
6879 if (o->type != REDIS_STRING) return NULL;
6880
6881 /* Every object that this function returns needs to have its refcount
6882 * increased. sortCommand decreases it again. */
6883 incrRefCount(o);
6884 }
6885
6886 return o;
6887 }
6888
6889 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
6890 * the additional parameter is not standard but a BSD-specific we have to
6891 * pass sorting parameters via the global 'server' structure */
6892 static int sortCompare(const void *s1, const void *s2) {
6893 const redisSortObject *so1 = s1, *so2 = s2;
6894 int cmp;
6895
6896 if (!server.sort_alpha) {
6897 /* Numeric sorting. Here it's trivial as we precomputed scores */
6898 if (so1->u.score > so2->u.score) {
6899 cmp = 1;
6900 } else if (so1->u.score < so2->u.score) {
6901 cmp = -1;
6902 } else {
6903 cmp = 0;
6904 }
6905 } else {
6906 /* Alphanumeric sorting */
6907 if (server.sort_bypattern) {
6908 if (!so1->u.cmpobj || !so2->u.cmpobj) {
6909 /* At least one compare object is NULL */
6910 if (so1->u.cmpobj == so2->u.cmpobj)
6911 cmp = 0;
6912 else if (so1->u.cmpobj == NULL)
6913 cmp = -1;
6914 else
6915 cmp = 1;
6916 } else {
6917 /* We have both the objects, use strcoll */
6918 cmp = strcoll(so1->u.cmpobj->ptr,so2->u.cmpobj->ptr);
6919 }
6920 } else {
6921 /* Compare elements directly. */
6922 cmp = compareStringObjects(so1->obj,so2->obj);
6923 }
6924 }
6925 return server.sort_desc ? -cmp : cmp;
6926 }
6927
6928 /* The SORT command is the most complex command in Redis. Warning: this code
6929 * is optimized for speed and a bit less for readability */
6930 static void sortCommand(redisClient *c) {
6931 list *operations;
6932 int outputlen = 0;
6933 int desc = 0, alpha = 0;
6934 int limit_start = 0, limit_count = -1, start, end;
6935 int j, dontsort = 0, vectorlen;
6936 int getop = 0; /* GET operation counter */
6937 robj *sortval, *sortby = NULL, *storekey = NULL;
6938 redisSortObject *vector; /* Resulting vector to sort */
6939
6940 /* Lookup the key to sort. It must be of the right types */
6941 sortval = lookupKeyRead(c->db,c->argv[1]);
6942 if (sortval == NULL) {
6943 addReply(c,shared.emptymultibulk);
6944 return;
6945 }
6946 if (sortval->type != REDIS_SET && sortval->type != REDIS_LIST &&
6947 sortval->type != REDIS_ZSET)
6948 {
6949 addReply(c,shared.wrongtypeerr);
6950 return;
6951 }
6952
6953 /* Create a list of operations to perform for every sorted element.
6954 * Operations can be GET/DEL/INCR/DECR */
6955 operations = listCreate();
6956 listSetFreeMethod(operations,zfree);
6957 j = 2;
6958
6959 /* Now we need to protect sortval incrementing its count, in the future
6960 * SORT may have options able to overwrite/delete keys during the sorting
6961 * and the sorted key itself may get destroied */
6962 incrRefCount(sortval);
6963
6964 /* The SORT command has an SQL-alike syntax, parse it */
6965 while(j < c->argc) {
6966 int leftargs = c->argc-j-1;
6967 if (!strcasecmp(c->argv[j]->ptr,"asc")) {
6968 desc = 0;
6969 } else if (!strcasecmp(c->argv[j]->ptr,"desc")) {
6970 desc = 1;
6971 } else if (!strcasecmp(c->argv[j]->ptr,"alpha")) {
6972 alpha = 1;
6973 } else if (!strcasecmp(c->argv[j]->ptr,"limit") && leftargs >= 2) {
6974 limit_start = atoi(c->argv[j+1]->ptr);
6975 limit_count = atoi(c->argv[j+2]->ptr);
6976 j+=2;
6977 } else if (!strcasecmp(c->argv[j]->ptr,"store") && leftargs >= 1) {
6978 storekey = c->argv[j+1];
6979 j++;
6980 } else if (!strcasecmp(c->argv[j]->ptr,"by") && leftargs >= 1) {
6981 sortby = c->argv[j+1];
6982 /* If the BY pattern does not contain '*', i.e. it is constant,
6983 * we don't need to sort nor to lookup the weight keys. */
6984 if (strchr(c->argv[j+1]->ptr,'*') == NULL) dontsort = 1;
6985 j++;
6986 } else if (!strcasecmp(c->argv[j]->ptr,"get") && leftargs >= 1) {
6987 listAddNodeTail(operations,createSortOperation(
6988 REDIS_SORT_GET,c->argv[j+1]));
6989 getop++;
6990 j++;
6991 } else {
6992 decrRefCount(sortval);
6993 listRelease(operations);
6994 addReply(c,shared.syntaxerr);
6995 return;
6996 }
6997 j++;
6998 }
6999
7000 /* Load the sorting vector with all the objects to sort */
7001 switch(sortval->type) {
7002 case REDIS_LIST: vectorlen = listLength((list*)sortval->ptr); break;
7003 case REDIS_SET: vectorlen = dictSize((dict*)sortval->ptr); break;
7004 case REDIS_ZSET: vectorlen = dictSize(((zset*)sortval->ptr)->dict); break;
7005 default: vectorlen = 0; redisPanic("Bad SORT type"); /* Avoid GCC warning */
7006 }
7007 vector = zmalloc(sizeof(redisSortObject)*vectorlen);
7008 j = 0;
7009
7010 if (sortval->type == REDIS_LIST) {
7011 list *list = sortval->ptr;
7012 listNode *ln;
7013 listIter li;
7014
7015 listRewind(list,&li);
7016 while((ln = listNext(&li))) {
7017 robj *ele = ln->value;
7018 vector[j].obj = ele;
7019 vector[j].u.score = 0;
7020 vector[j].u.cmpobj = NULL;
7021 j++;
7022 }
7023 } else {
7024 dict *set;
7025 dictIterator *di;
7026 dictEntry *setele;
7027
7028 if (sortval->type == REDIS_SET) {
7029 set = sortval->ptr;
7030 } else {
7031 zset *zs = sortval->ptr;
7032 set = zs->dict;
7033 }
7034
7035 di = dictGetIterator(set);
7036 while((setele = dictNext(di)) != NULL) {
7037 vector[j].obj = dictGetEntryKey(setele);
7038 vector[j].u.score = 0;
7039 vector[j].u.cmpobj = NULL;
7040 j++;
7041 }
7042 dictReleaseIterator(di);
7043 }
7044 redisAssert(j == vectorlen);
7045
7046 /* Now it's time to load the right scores in the sorting vector */
7047 if (dontsort == 0) {
7048 for (j = 0; j < vectorlen; j++) {
7049 robj *byval;
7050 if (sortby) {
7051 /* lookup value to sort by */
7052 byval = lookupKeyByPattern(c->db,sortby,vector[j].obj);
7053 if (!byval) continue;
7054 } else {
7055 /* use object itself to sort by */
7056 byval = vector[j].obj;
7057 }
7058
7059 if (alpha) {
7060 if (sortby) vector[j].u.cmpobj = getDecodedObject(byval);
7061 } else {
7062 if (byval->encoding == REDIS_ENCODING_RAW) {
7063 vector[j].u.score = strtod(byval->ptr,NULL);
7064 } else if (byval->encoding == REDIS_ENCODING_INT) {
7065 /* Don't need to decode the object if it's
7066 * integer-encoded (the only encoding supported) so
7067 * far. We can just cast it */
7068 vector[j].u.score = (long)byval->ptr;
7069 } else {
7070 redisAssert(1 != 1);
7071 }
7072 }
7073
7074 /* when the object was retrieved using lookupKeyByPattern,
7075 * its refcount needs to be decreased. */
7076 if (sortby) {
7077 decrRefCount(byval);
7078 }
7079 }
7080 }
7081
7082 /* We are ready to sort the vector... perform a bit of sanity check
7083 * on the LIMIT option too. We'll use a partial version of quicksort. */
7084 start = (limit_start < 0) ? 0 : limit_start;
7085 end = (limit_count < 0) ? vectorlen-1 : start+limit_count-1;
7086 if (start >= vectorlen) {
7087 start = vectorlen-1;
7088 end = vectorlen-2;
7089 }
7090 if (end >= vectorlen) end = vectorlen-1;
7091
7092 if (dontsort == 0) {
7093 server.sort_desc = desc;
7094 server.sort_alpha = alpha;
7095 server.sort_bypattern = sortby ? 1 : 0;
7096 if (sortby && (start != 0 || end != vectorlen-1))
7097 pqsort(vector,vectorlen,sizeof(redisSortObject),sortCompare, start,end);
7098 else
7099 qsort(vector,vectorlen,sizeof(redisSortObject),sortCompare);
7100 }
7101
7102 /* Send command output to the output buffer, performing the specified
7103 * GET/DEL/INCR/DECR operations if any. */
7104 outputlen = getop ? getop*(end-start+1) : end-start+1;
7105 if (storekey == NULL) {
7106 /* STORE option not specified, sent the sorting result to client */
7107 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",outputlen));
7108 for (j = start; j <= end; j++) {
7109 listNode *ln;
7110 listIter li;
7111
7112 if (!getop) addReplyBulk(c,vector[j].obj);
7113 listRewind(operations,&li);
7114 while((ln = listNext(&li))) {
7115 redisSortOperation *sop = ln->value;
7116 robj *val = lookupKeyByPattern(c->db,sop->pattern,
7117 vector[j].obj);
7118
7119 if (sop->type == REDIS_SORT_GET) {
7120 if (!val) {
7121 addReply(c,shared.nullbulk);
7122 } else {
7123 addReplyBulk(c,val);
7124 decrRefCount(val);
7125 }
7126 } else {
7127 redisAssert(sop->type == REDIS_SORT_GET); /* always fails */
7128 }
7129 }
7130 }
7131 } else {
7132 robj *listObject = createListObject();
7133 list *listPtr = (list*) listObject->ptr;
7134
7135 /* STORE option specified, set the sorting result as a List object */
7136 for (j = start; j <= end; j++) {
7137 listNode *ln;
7138 listIter li;
7139
7140 if (!getop) {
7141 listAddNodeTail(listPtr,vector[j].obj);
7142 incrRefCount(vector[j].obj);
7143 }
7144 listRewind(operations,&li);
7145 while((ln = listNext(&li))) {
7146 redisSortOperation *sop = ln->value;
7147 robj *val = lookupKeyByPattern(c->db,sop->pattern,
7148 vector[j].obj);
7149
7150 if (sop->type == REDIS_SORT_GET) {
7151 if (!val) {
7152 listAddNodeTail(listPtr,createStringObject("",0));
7153 } else {
7154 /* We should do a incrRefCount on val because it is
7155 * added to the list, but also a decrRefCount because
7156 * it is returned by lookupKeyByPattern. This results
7157 * in doing nothing at all. */
7158 listAddNodeTail(listPtr,val);
7159 }
7160 } else {
7161 redisAssert(sop->type == REDIS_SORT_GET); /* always fails */
7162 }
7163 }
7164 }
7165 if (dictReplace(c->db->dict,storekey,listObject)) {
7166 incrRefCount(storekey);
7167 }
7168 /* Note: we add 1 because the DB is dirty anyway since even if the
7169 * SORT result is empty a new key is set and maybe the old content
7170 * replaced. */
7171 server.dirty += 1+outputlen;
7172 addReplySds(c,sdscatprintf(sdsempty(),":%d\r\n",outputlen));
7173 }
7174
7175 /* Cleanup */
7176 decrRefCount(sortval);
7177 listRelease(operations);
7178 for (j = 0; j < vectorlen; j++) {
7179 if (alpha && vector[j].u.cmpobj)
7180 decrRefCount(vector[j].u.cmpobj);
7181 }
7182 zfree(vector);
7183 }
7184
7185 /* Convert an amount of bytes into a human readable string in the form
7186 * of 100B, 2G, 100M, 4K, and so forth. */
7187 static void bytesToHuman(char *s, unsigned long long n) {
7188 double d;
7189
7190 if (n < 1024) {
7191 /* Bytes */
7192 sprintf(s,"%lluB",n);
7193 return;
7194 } else if (n < (1024*1024)) {
7195 d = (double)n/(1024);
7196 sprintf(s,"%.2fK",d);
7197 } else if (n < (1024LL*1024*1024)) {
7198 d = (double)n/(1024*1024);
7199 sprintf(s,"%.2fM",d);
7200 } else if (n < (1024LL*1024*1024*1024)) {
7201 d = (double)n/(1024LL*1024*1024);
7202 sprintf(s,"%.2fG",d);
7203 }
7204 }
7205
7206 /* Create the string returned by the INFO command. This is decoupled
7207 * by the INFO command itself as we need to report the same information
7208 * on memory corruption problems. */
7209 static sds genRedisInfoString(void) {
7210 sds info;
7211 time_t uptime = time(NULL)-server.stat_starttime;
7212 int j;
7213 char hmem[64];
7214
7215 bytesToHuman(hmem,zmalloc_used_memory());
7216 info = sdscatprintf(sdsempty(),
7217 "redis_version:%s\r\n"
7218 "redis_git_sha1:%s\r\n"
7219 "redis_git_dirty:%d\r\n"
7220 "arch_bits:%s\r\n"
7221 "multiplexing_api:%s\r\n"
7222 "process_id:%ld\r\n"
7223 "uptime_in_seconds:%ld\r\n"
7224 "uptime_in_days:%ld\r\n"
7225 "connected_clients:%d\r\n"
7226 "connected_slaves:%d\r\n"
7227 "blocked_clients:%d\r\n"
7228 "used_memory:%zu\r\n"
7229 "used_memory_human:%s\r\n"
7230 "changes_since_last_save:%lld\r\n"
7231 "bgsave_in_progress:%d\r\n"
7232 "last_save_time:%ld\r\n"
7233 "bgrewriteaof_in_progress:%d\r\n"
7234 "total_connections_received:%lld\r\n"
7235 "total_commands_processed:%lld\r\n"
7236 "expired_keys:%lld\r\n"
7237 "hash_max_zipmap_entries:%zu\r\n"
7238 "hash_max_zipmap_value:%zu\r\n"
7239 "pubsub_channels:%ld\r\n"
7240 "pubsub_patterns:%u\r\n"
7241 "vm_enabled:%d\r\n"
7242 "role:%s\r\n"
7243 ,REDIS_VERSION,
7244 REDIS_GIT_SHA1,
7245 strtol(REDIS_GIT_DIRTY,NULL,10) > 0,
7246 (sizeof(long) == 8) ? "64" : "32",
7247 aeGetApiName(),
7248 (long) getpid(),
7249 uptime,
7250 uptime/(3600*24),
7251 listLength(server.clients)-listLength(server.slaves),
7252 listLength(server.slaves),
7253 server.blpop_blocked_clients,
7254 zmalloc_used_memory(),
7255 hmem,
7256 server.dirty,
7257 server.bgsavechildpid != -1,
7258 server.lastsave,
7259 server.bgrewritechildpid != -1,
7260 server.stat_numconnections,
7261 server.stat_numcommands,
7262 server.stat_expiredkeys,
7263 server.hash_max_zipmap_entries,
7264 server.hash_max_zipmap_value,
7265 dictSize(server.pubsub_channels),
7266 listLength(server.pubsub_patterns),
7267 server.vm_enabled != 0,
7268 server.masterhost == NULL ? "master" : "slave"
7269 );
7270 if (server.masterhost) {
7271 info = sdscatprintf(info,
7272 "master_host:%s\r\n"
7273 "master_port:%d\r\n"
7274 "master_link_status:%s\r\n"
7275 "master_last_io_seconds_ago:%d\r\n"
7276 ,server.masterhost,
7277 server.masterport,
7278 (server.replstate == REDIS_REPL_CONNECTED) ?
7279 "up" : "down",
7280 server.master ? ((int)(time(NULL)-server.master->lastinteraction)) : -1
7281 );
7282 }
7283 if (server.vm_enabled) {
7284 lockThreadedIO();
7285 info = sdscatprintf(info,
7286 "vm_conf_max_memory:%llu\r\n"
7287 "vm_conf_page_size:%llu\r\n"
7288 "vm_conf_pages:%llu\r\n"
7289 "vm_stats_used_pages:%llu\r\n"
7290 "vm_stats_swapped_objects:%llu\r\n"
7291 "vm_stats_swappin_count:%llu\r\n"
7292 "vm_stats_swappout_count:%llu\r\n"
7293 "vm_stats_io_newjobs_len:%lu\r\n"
7294 "vm_stats_io_processing_len:%lu\r\n"
7295 "vm_stats_io_processed_len:%lu\r\n"
7296 "vm_stats_io_active_threads:%lu\r\n"
7297 "vm_stats_blocked_clients:%lu\r\n"
7298 ,(unsigned long long) server.vm_max_memory,
7299 (unsigned long long) server.vm_page_size,
7300 (unsigned long long) server.vm_pages,
7301 (unsigned long long) server.vm_stats_used_pages,
7302 (unsigned long long) server.vm_stats_swapped_objects,
7303 (unsigned long long) server.vm_stats_swapins,
7304 (unsigned long long) server.vm_stats_swapouts,
7305 (unsigned long) listLength(server.io_newjobs),
7306 (unsigned long) listLength(server.io_processing),
7307 (unsigned long) listLength(server.io_processed),
7308 (unsigned long) server.io_active_threads,
7309 (unsigned long) server.vm_blocked_clients
7310 );
7311 unlockThreadedIO();
7312 }
7313 for (j = 0; j < server.dbnum; j++) {
7314 long long keys, vkeys;
7315
7316 keys = dictSize(server.db[j].dict);
7317 vkeys = dictSize(server.db[j].expires);
7318 if (keys || vkeys) {
7319 info = sdscatprintf(info, "db%d:keys=%lld,expires=%lld\r\n",
7320 j, keys, vkeys);
7321 }
7322 }
7323 return info;
7324 }
7325
7326 static void infoCommand(redisClient *c) {
7327 sds info = genRedisInfoString();
7328 addReplySds(c,sdscatprintf(sdsempty(),"$%lu\r\n",
7329 (unsigned long)sdslen(info)));
7330 addReplySds(c,info);
7331 addReply(c,shared.crlf);
7332 }
7333
7334 static void monitorCommand(redisClient *c) {
7335 /* ignore MONITOR if aleady slave or in monitor mode */
7336 if (c->flags & REDIS_SLAVE) return;
7337
7338 c->flags |= (REDIS_SLAVE|REDIS_MONITOR);
7339 c->slaveseldb = 0;
7340 listAddNodeTail(server.monitors,c);
7341 addReply(c,shared.ok);
7342 }
7343
7344 /* ================================= Expire ================================= */
7345 static int removeExpire(redisDb *db, robj *key) {
7346 if (dictDelete(db->expires,key) == DICT_OK) {
7347 return 1;
7348 } else {
7349 return 0;
7350 }
7351 }
7352
7353 static int setExpire(redisDb *db, robj *key, time_t when) {
7354 if (dictAdd(db->expires,key,(void*)when) == DICT_ERR) {
7355 return 0;
7356 } else {
7357 incrRefCount(key);
7358 return 1;
7359 }
7360 }
7361
7362 /* Return the expire time of the specified key, or -1 if no expire
7363 * is associated with this key (i.e. the key is non volatile) */
7364 static time_t getExpire(redisDb *db, robj *key) {
7365 dictEntry *de;
7366
7367 /* No expire? return ASAP */
7368 if (dictSize(db->expires) == 0 ||
7369 (de = dictFind(db->expires,key)) == NULL) return -1;
7370
7371 return (time_t) dictGetEntryVal(de);
7372 }
7373
7374 static int expireIfNeeded(redisDb *db, robj *key) {
7375 time_t when;
7376 dictEntry *de;
7377
7378 /* No expire? return ASAP */
7379 if (dictSize(db->expires) == 0 ||
7380 (de = dictFind(db->expires,key)) == NULL) return 0;
7381
7382 /* Lookup the expire */
7383 when = (time_t) dictGetEntryVal(de);
7384 if (time(NULL) <= when) return 0;
7385
7386 /* Delete the key */
7387 dictDelete(db->expires,key);
7388 server.stat_expiredkeys++;
7389 return dictDelete(db->dict,key) == DICT_OK;
7390 }
7391
7392 static int deleteIfVolatile(redisDb *db, robj *key) {
7393 dictEntry *de;
7394
7395 /* No expire? return ASAP */
7396 if (dictSize(db->expires) == 0 ||
7397 (de = dictFind(db->expires,key)) == NULL) return 0;
7398
7399 /* Delete the key */
7400 server.dirty++;
7401 server.stat_expiredkeys++;
7402 dictDelete(db->expires,key);
7403 return dictDelete(db->dict,key) == DICT_OK;
7404 }
7405
7406 static void expireGenericCommand(redisClient *c, robj *key, robj *param, long offset) {
7407 dictEntry *de;
7408 time_t seconds;
7409
7410 if (getLongFromObjectOrReply(c, param, &seconds, NULL) != REDIS_OK) return;
7411
7412 seconds -= offset;
7413
7414 de = dictFind(c->db->dict,key);
7415 if (de == NULL) {
7416 addReply(c,shared.czero);
7417 return;
7418 }
7419 if (seconds <= 0) {
7420 if (deleteKey(c->db,key)) server.dirty++;
7421 addReply(c, shared.cone);
7422 return;
7423 } else {
7424 time_t when = time(NULL)+seconds;
7425 if (setExpire(c->db,key,when)) {
7426 addReply(c,shared.cone);
7427 server.dirty++;
7428 } else {
7429 addReply(c,shared.czero);
7430 }
7431 return;
7432 }
7433 }
7434
7435 static void expireCommand(redisClient *c) {
7436 expireGenericCommand(c,c->argv[1],c->argv[2],0);
7437 }
7438
7439 static void expireatCommand(redisClient *c) {
7440 expireGenericCommand(c,c->argv[1],c->argv[2],time(NULL));
7441 }
7442
7443 static void ttlCommand(redisClient *c) {
7444 time_t expire;
7445 int ttl = -1;
7446
7447 expire = getExpire(c->db,c->argv[1]);
7448 if (expire != -1) {
7449 ttl = (int) (expire-time(NULL));
7450 if (ttl < 0) ttl = -1;
7451 }
7452 addReplySds(c,sdscatprintf(sdsempty(),":%d\r\n",ttl));
7453 }
7454
7455 /* ================================ MULTI/EXEC ============================== */
7456
7457 /* Client state initialization for MULTI/EXEC */
7458 static void initClientMultiState(redisClient *c) {
7459 c->mstate.commands = NULL;
7460 c->mstate.count = 0;
7461 }
7462
7463 /* Release all the resources associated with MULTI/EXEC state */
7464 static void freeClientMultiState(redisClient *c) {
7465 int j;
7466
7467 for (j = 0; j < c->mstate.count; j++) {
7468 int i;
7469 multiCmd *mc = c->mstate.commands+j;
7470
7471 for (i = 0; i < mc->argc; i++)
7472 decrRefCount(mc->argv[i]);
7473 zfree(mc->argv);
7474 }
7475 zfree(c->mstate.commands);
7476 }
7477
7478 /* Add a new command into the MULTI commands queue */
7479 static void queueMultiCommand(redisClient *c, struct redisCommand *cmd) {
7480 multiCmd *mc;
7481 int j;
7482
7483 c->mstate.commands = zrealloc(c->mstate.commands,
7484 sizeof(multiCmd)*(c->mstate.count+1));
7485 mc = c->mstate.commands+c->mstate.count;
7486 mc->cmd = cmd;
7487 mc->argc = c->argc;
7488 mc->argv = zmalloc(sizeof(robj*)*c->argc);
7489 memcpy(mc->argv,c->argv,sizeof(robj*)*c->argc);
7490 for (j = 0; j < c->argc; j++)
7491 incrRefCount(mc->argv[j]);
7492 c->mstate.count++;
7493 }
7494
7495 static void multiCommand(redisClient *c) {
7496 c->flags |= REDIS_MULTI;
7497 addReply(c,shared.ok);
7498 }
7499
7500 static void discardCommand(redisClient *c) {
7501 if (!(c->flags & REDIS_MULTI)) {
7502 addReplySds(c,sdsnew("-ERR DISCARD without MULTI\r\n"));
7503 return;
7504 }
7505
7506 freeClientMultiState(c);
7507 initClientMultiState(c);
7508 c->flags &= (~REDIS_MULTI);
7509 addReply(c,shared.ok);
7510 }
7511
7512 /* Send a MULTI command to all the slaves and AOF file. Check the execCommand
7513 * implememntation for more information. */
7514 static void execCommandReplicateMulti(redisClient *c) {
7515 struct redisCommand *cmd;
7516 robj *multistring = createStringObject("MULTI",5);
7517
7518 cmd = lookupCommand("multi");
7519 if (server.appendonly)
7520 feedAppendOnlyFile(cmd,c->db->id,&multistring,1);
7521 if (listLength(server.slaves))
7522 replicationFeedSlaves(server.slaves,c->db->id,&multistring,1);
7523 decrRefCount(multistring);
7524 }
7525
7526 static void execCommand(redisClient *c) {
7527 int j;
7528 robj **orig_argv;
7529 int orig_argc;
7530
7531 if (!(c->flags & REDIS_MULTI)) {
7532 addReplySds(c,sdsnew("-ERR EXEC without MULTI\r\n"));
7533 return;
7534 }
7535
7536 /* Check if we need to abort the EXEC if some WATCHed key was touched.
7537 * A failed EXEC will return a multi bulk nil object. */
7538 if (c->flags & REDIS_DIRTY_CAS) {
7539 freeClientMultiState(c);
7540 initClientMultiState(c);
7541 c->flags &= ~(REDIS_MULTI|REDIS_DIRTY_CAS);
7542 unwatchAllKeys(c);
7543 addReply(c,shared.nullmultibulk);
7544 return;
7545 }
7546
7547 /* Replicate a MULTI request now that we are sure the block is executed.
7548 * This way we'll deliver the MULTI/..../EXEC block as a whole and
7549 * both the AOF and the replication link will have the same consistency
7550 * and atomicity guarantees. */
7551 execCommandReplicateMulti(c);
7552
7553 /* Exec all the queued commands */
7554 orig_argv = c->argv;
7555 orig_argc = c->argc;
7556 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",c->mstate.count));
7557 for (j = 0; j < c->mstate.count; j++) {
7558 c->argc = c->mstate.commands[j].argc;
7559 c->argv = c->mstate.commands[j].argv;
7560 call(c,c->mstate.commands[j].cmd);
7561 }
7562 c->argv = orig_argv;
7563 c->argc = orig_argc;
7564 freeClientMultiState(c);
7565 initClientMultiState(c);
7566 c->flags &= (~REDIS_MULTI);
7567 unwatchAllKeys(c);
7568 /* Make sure the EXEC command is always replicated / AOF, since we
7569 * always send the MULTI command (we can't know beforehand if the
7570 * next operations will contain at least a modification to the DB). */
7571 server.dirty++;
7572 }
7573
7574 /* =========================== Blocking Operations ========================= */
7575
7576 /* Currently Redis blocking operations support is limited to list POP ops,
7577 * so the current implementation is not fully generic, but it is also not
7578 * completely specific so it will not require a rewrite to support new
7579 * kind of blocking operations in the future.
7580 *
7581 * Still it's important to note that list blocking operations can be already
7582 * used as a notification mechanism in order to implement other blocking
7583 * operations at application level, so there must be a very strong evidence
7584 * of usefulness and generality before new blocking operations are implemented.
7585 *
7586 * This is how the current blocking POP works, we use BLPOP as example:
7587 * - If the user calls BLPOP and the key exists and contains a non empty list
7588 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
7589 * if there is not to block.
7590 * - If instead BLPOP is called and the key does not exists or the list is
7591 * empty we need to block. In order to do so we remove the notification for
7592 * new data to read in the client socket (so that we'll not serve new
7593 * requests if the blocking request is not served). Also we put the client
7594 * in a dictionary (db->blocking_keys) mapping keys to a list of clients
7595 * blocking for this keys.
7596 * - If a PUSH operation against a key with blocked clients waiting is
7597 * performed, we serve the first in the list: basically instead to push
7598 * the new element inside the list we return it to the (first / oldest)
7599 * blocking client, unblock the client, and remove it form the list.
7600 *
7601 * The above comment and the source code should be enough in order to understand
7602 * the implementation and modify / fix it later.
7603 */
7604
7605 /* Set a client in blocking mode for the specified key, with the specified
7606 * timeout */
7607 static void blockForKeys(redisClient *c, robj **keys, int numkeys, time_t timeout) {
7608 dictEntry *de;
7609 list *l;
7610 int j;
7611
7612 c->blocking_keys = zmalloc(sizeof(robj*)*numkeys);
7613 c->blocking_keys_num = numkeys;
7614 c->blockingto = timeout;
7615 for (j = 0; j < numkeys; j++) {
7616 /* Add the key in the client structure, to map clients -> keys */
7617 c->blocking_keys[j] = keys[j];
7618 incrRefCount(keys[j]);
7619
7620 /* And in the other "side", to map keys -> clients */
7621 de = dictFind(c->db->blocking_keys,keys[j]);
7622 if (de == NULL) {
7623 int retval;
7624
7625 /* For every key we take a list of clients blocked for it */
7626 l = listCreate();
7627 retval = dictAdd(c->db->blocking_keys,keys[j],l);
7628 incrRefCount(keys[j]);
7629 assert(retval == DICT_OK);
7630 } else {
7631 l = dictGetEntryVal(de);
7632 }
7633 listAddNodeTail(l,c);
7634 }
7635 /* Mark the client as a blocked client */
7636 c->flags |= REDIS_BLOCKED;
7637 server.blpop_blocked_clients++;
7638 }
7639
7640 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
7641 static void unblockClientWaitingData(redisClient *c) {
7642 dictEntry *de;
7643 list *l;
7644 int j;
7645
7646 assert(c->blocking_keys != NULL);
7647 /* The client may wait for multiple keys, so unblock it for every key. */
7648 for (j = 0; j < c->blocking_keys_num; j++) {
7649 /* Remove this client from the list of clients waiting for this key. */
7650 de = dictFind(c->db->blocking_keys,c->blocking_keys[j]);
7651 assert(de != NULL);
7652 l = dictGetEntryVal(de);
7653 listDelNode(l,listSearchKey(l,c));
7654 /* If the list is empty we need to remove it to avoid wasting memory */
7655 if (listLength(l) == 0)
7656 dictDelete(c->db->blocking_keys,c->blocking_keys[j]);
7657 decrRefCount(c->blocking_keys[j]);
7658 }
7659 /* Cleanup the client structure */
7660 zfree(c->blocking_keys);
7661 c->blocking_keys = NULL;
7662 c->flags &= (~REDIS_BLOCKED);
7663 server.blpop_blocked_clients--;
7664 /* We want to process data if there is some command waiting
7665 * in the input buffer. Note that this is safe even if
7666 * unblockClientWaitingData() gets called from freeClient() because
7667 * freeClient() will be smart enough to call this function
7668 * *after* c->querybuf was set to NULL. */
7669 if (c->querybuf && sdslen(c->querybuf) > 0) processInputBuffer(c);
7670 }
7671
7672 /* This should be called from any function PUSHing into lists.
7673 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
7674 * 'ele' is the element pushed.
7675 *
7676 * If the function returns 0 there was no client waiting for a list push
7677 * against this key.
7678 *
7679 * If the function returns 1 there was a client waiting for a list push
7680 * against this key, the element was passed to this client thus it's not
7681 * needed to actually add it to the list and the caller should return asap. */
7682 static int handleClientsWaitingListPush(redisClient *c, robj *key, robj *ele) {
7683 struct dictEntry *de;
7684 redisClient *receiver;
7685 list *l;
7686 listNode *ln;
7687
7688 de = dictFind(c->db->blocking_keys,key);
7689 if (de == NULL) return 0;
7690 l = dictGetEntryVal(de);
7691 ln = listFirst(l);
7692 assert(ln != NULL);
7693 receiver = ln->value;
7694
7695 addReplySds(receiver,sdsnew("*2\r\n"));
7696 addReplyBulk(receiver,key);
7697 addReplyBulk(receiver,ele);
7698 unblockClientWaitingData(receiver);
7699 return 1;
7700 }
7701
7702 /* Blocking RPOP/LPOP */
7703 static void blockingPopGenericCommand(redisClient *c, int where) {
7704 robj *o;
7705 time_t timeout;
7706 int j;
7707
7708 for (j = 1; j < c->argc-1; j++) {
7709 o = lookupKeyWrite(c->db,c->argv[j]);
7710 if (o != NULL) {
7711 if (o->type != REDIS_LIST) {
7712 addReply(c,shared.wrongtypeerr);
7713 return;
7714 } else {
7715 list *list = o->ptr;
7716 if (listLength(list) != 0) {
7717 /* If the list contains elements fall back to the usual
7718 * non-blocking POP operation */
7719 robj *argv[2], **orig_argv;
7720 int orig_argc;
7721
7722 /* We need to alter the command arguments before to call
7723 * popGenericCommand() as the command takes a single key. */
7724 orig_argv = c->argv;
7725 orig_argc = c->argc;
7726 argv[1] = c->argv[j];
7727 c->argv = argv;
7728 c->argc = 2;
7729
7730 /* Also the return value is different, we need to output
7731 * the multi bulk reply header and the key name. The
7732 * "real" command will add the last element (the value)
7733 * for us. If this souds like an hack to you it's just
7734 * because it is... */
7735 addReplySds(c,sdsnew("*2\r\n"));
7736 addReplyBulk(c,argv[1]);
7737 popGenericCommand(c,where);
7738
7739 /* Fix the client structure with the original stuff */
7740 c->argv = orig_argv;
7741 c->argc = orig_argc;
7742 return;
7743 }
7744 }
7745 }
7746 }
7747 /* If the list is empty or the key does not exists we must block */
7748 timeout = strtol(c->argv[c->argc-1]->ptr,NULL,10);
7749 if (timeout > 0) timeout += time(NULL);
7750 blockForKeys(c,c->argv+1,c->argc-2,timeout);
7751 }
7752
7753 static void blpopCommand(redisClient *c) {
7754 blockingPopGenericCommand(c,REDIS_HEAD);
7755 }
7756
7757 static void brpopCommand(redisClient *c) {
7758 blockingPopGenericCommand(c,REDIS_TAIL);
7759 }
7760
7761 /* =============================== Replication ============================= */
7762
7763 static int syncWrite(int fd, char *ptr, ssize_t size, int timeout) {
7764 ssize_t nwritten, ret = size;
7765 time_t start = time(NULL);
7766
7767 timeout++;
7768 while(size) {
7769 if (aeWait(fd,AE_WRITABLE,1000) & AE_WRITABLE) {
7770 nwritten = write(fd,ptr,size);
7771 if (nwritten == -1) return -1;
7772 ptr += nwritten;
7773 size -= nwritten;
7774 }
7775 if ((time(NULL)-start) > timeout) {
7776 errno = ETIMEDOUT;
7777 return -1;
7778 }
7779 }
7780 return ret;
7781 }
7782
7783 static int syncRead(int fd, char *ptr, ssize_t size, int timeout) {
7784 ssize_t nread, totread = 0;
7785 time_t start = time(NULL);
7786
7787 timeout++;
7788 while(size) {
7789 if (aeWait(fd,AE_READABLE,1000) & AE_READABLE) {
7790 nread = read(fd,ptr,size);
7791 if (nread == -1) return -1;
7792 ptr += nread;
7793 size -= nread;
7794 totread += nread;
7795 }
7796 if ((time(NULL)-start) > timeout) {
7797 errno = ETIMEDOUT;
7798 return -1;
7799 }
7800 }
7801 return totread;
7802 }
7803
7804 static int syncReadLine(int fd, char *ptr, ssize_t size, int timeout) {
7805 ssize_t nread = 0;
7806
7807 size--;
7808 while(size) {
7809 char c;
7810
7811 if (syncRead(fd,&c,1,timeout) == -1) return -1;
7812 if (c == '\n') {
7813 *ptr = '\0';
7814 if (nread && *(ptr-1) == '\r') *(ptr-1) = '\0';
7815 return nread;
7816 } else {
7817 *ptr++ = c;
7818 *ptr = '\0';
7819 nread++;
7820 }
7821 }
7822 return nread;
7823 }
7824
7825 static void syncCommand(redisClient *c) {
7826 /* ignore SYNC if aleady slave or in monitor mode */
7827 if (c->flags & REDIS_SLAVE) return;
7828
7829 /* SYNC can't be issued when the server has pending data to send to
7830 * the client about already issued commands. We need a fresh reply
7831 * buffer registering the differences between the BGSAVE and the current
7832 * dataset, so that we can copy to other slaves if needed. */
7833 if (listLength(c->reply) != 0) {
7834 addReplySds(c,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
7835 return;
7836 }
7837
7838 redisLog(REDIS_NOTICE,"Slave ask for synchronization");
7839 /* Here we need to check if there is a background saving operation
7840 * in progress, or if it is required to start one */
7841 if (server.bgsavechildpid != -1) {
7842 /* Ok a background save is in progress. Let's check if it is a good
7843 * one for replication, i.e. if there is another slave that is
7844 * registering differences since the server forked to save */
7845 redisClient *slave;
7846 listNode *ln;
7847 listIter li;
7848
7849 listRewind(server.slaves,&li);
7850 while((ln = listNext(&li))) {
7851 slave = ln->value;
7852 if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_END) break;
7853 }
7854 if (ln) {
7855 /* Perfect, the server is already registering differences for
7856 * another slave. Set the right state, and copy the buffer. */
7857 listRelease(c->reply);
7858 c->reply = listDup(slave->reply);
7859 c->replstate = REDIS_REPL_WAIT_BGSAVE_END;
7860 redisLog(REDIS_NOTICE,"Waiting for end of BGSAVE for SYNC");
7861 } else {
7862 /* No way, we need to wait for the next BGSAVE in order to
7863 * register differences */
7864 c->replstate = REDIS_REPL_WAIT_BGSAVE_START;
7865 redisLog(REDIS_NOTICE,"Waiting for next BGSAVE for SYNC");
7866 }
7867 } else {
7868 /* Ok we don't have a BGSAVE in progress, let's start one */
7869 redisLog(REDIS_NOTICE,"Starting BGSAVE for SYNC");
7870 if (rdbSaveBackground(server.dbfilename) != REDIS_OK) {
7871 redisLog(REDIS_NOTICE,"Replication failed, can't BGSAVE");
7872 addReplySds(c,sdsnew("-ERR Unalbe to perform background save\r\n"));
7873 return;
7874 }
7875 c->replstate = REDIS_REPL_WAIT_BGSAVE_END;
7876 }
7877 c->repldbfd = -1;
7878 c->flags |= REDIS_SLAVE;
7879 c->slaveseldb = 0;
7880 listAddNodeTail(server.slaves,c);
7881 return;
7882 }
7883
7884 static void sendBulkToSlave(aeEventLoop *el, int fd, void *privdata, int mask) {
7885 redisClient *slave = privdata;
7886 REDIS_NOTUSED(el);
7887 REDIS_NOTUSED(mask);
7888 char buf[REDIS_IOBUF_LEN];
7889 ssize_t nwritten, buflen;
7890
7891 if (slave->repldboff == 0) {
7892 /* Write the bulk write count before to transfer the DB. In theory here
7893 * we don't know how much room there is in the output buffer of the
7894 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
7895 * operations) will never be smaller than the few bytes we need. */
7896 sds bulkcount;
7897
7898 bulkcount = sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
7899 slave->repldbsize);
7900 if (write(fd,bulkcount,sdslen(bulkcount)) != (signed)sdslen(bulkcount))
7901 {
7902 sdsfree(bulkcount);
7903 freeClient(slave);
7904 return;
7905 }
7906 sdsfree(bulkcount);
7907 }
7908 lseek(slave->repldbfd,slave->repldboff,SEEK_SET);
7909 buflen = read(slave->repldbfd,buf,REDIS_IOBUF_LEN);
7910 if (buflen <= 0) {
7911 redisLog(REDIS_WARNING,"Read error sending DB to slave: %s",
7912 (buflen == 0) ? "premature EOF" : strerror(errno));
7913 freeClient(slave);
7914 return;
7915 }
7916 if ((nwritten = write(fd,buf,buflen)) == -1) {
7917 redisLog(REDIS_VERBOSE,"Write error sending DB to slave: %s",
7918 strerror(errno));
7919 freeClient(slave);
7920 return;
7921 }
7922 slave->repldboff += nwritten;
7923 if (slave->repldboff == slave->repldbsize) {
7924 close(slave->repldbfd);
7925 slave->repldbfd = -1;
7926 aeDeleteFileEvent(server.el,slave->fd,AE_WRITABLE);
7927 slave->replstate = REDIS_REPL_ONLINE;
7928 if (aeCreateFileEvent(server.el, slave->fd, AE_WRITABLE,
7929 sendReplyToClient, slave) == AE_ERR) {
7930 freeClient(slave);
7931 return;
7932 }
7933 addReplySds(slave,sdsempty());
7934 redisLog(REDIS_NOTICE,"Synchronization with slave succeeded");
7935 }
7936 }
7937
7938 /* This function is called at the end of every backgrond saving.
7939 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
7940 * otherwise REDIS_ERR is passed to the function.
7941 *
7942 * The goal of this function is to handle slaves waiting for a successful
7943 * background saving in order to perform non-blocking synchronization. */
7944 static void updateSlavesWaitingBgsave(int bgsaveerr) {
7945 listNode *ln;
7946 int startbgsave = 0;
7947 listIter li;
7948
7949 listRewind(server.slaves,&li);
7950 while((ln = listNext(&li))) {
7951 redisClient *slave = ln->value;
7952
7953 if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_START) {
7954 startbgsave = 1;
7955 slave->replstate = REDIS_REPL_WAIT_BGSAVE_END;
7956 } else if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_END) {
7957 struct redis_stat buf;
7958
7959 if (bgsaveerr != REDIS_OK) {
7960 freeClient(slave);
7961 redisLog(REDIS_WARNING,"SYNC failed. BGSAVE child returned an error");
7962 continue;
7963 }
7964 if ((slave->repldbfd = open(server.dbfilename,O_RDONLY)) == -1 ||
7965 redis_fstat(slave->repldbfd,&buf) == -1) {
7966 freeClient(slave);
7967 redisLog(REDIS_WARNING,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno));
7968 continue;
7969 }
7970 slave->repldboff = 0;
7971 slave->repldbsize = buf.st_size;
7972 slave->replstate = REDIS_REPL_SEND_BULK;
7973 aeDeleteFileEvent(server.el,slave->fd,AE_WRITABLE);
7974 if (aeCreateFileEvent(server.el, slave->fd, AE_WRITABLE, sendBulkToSlave, slave) == AE_ERR) {
7975 freeClient(slave);
7976 continue;
7977 }
7978 }
7979 }
7980 if (startbgsave) {
7981 if (rdbSaveBackground(server.dbfilename) != REDIS_OK) {
7982 listIter li;
7983
7984 listRewind(server.slaves,&li);
7985 redisLog(REDIS_WARNING,"SYNC failed. BGSAVE failed");
7986 while((ln = listNext(&li))) {
7987 redisClient *slave = ln->value;
7988
7989 if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_START)
7990 freeClient(slave);
7991 }
7992 }
7993 }
7994 }
7995
7996 static int syncWithMaster(void) {
7997 char buf[1024], tmpfile[256], authcmd[1024];
7998 long dumpsize;
7999 int fd = anetTcpConnect(NULL,server.masterhost,server.masterport);
8000 int dfd, maxtries = 5;
8001
8002 if (fd == -1) {
8003 redisLog(REDIS_WARNING,"Unable to connect to MASTER: %s",
8004 strerror(errno));
8005 return REDIS_ERR;
8006 }
8007
8008 /* AUTH with the master if required. */
8009 if(server.masterauth) {
8010 snprintf(authcmd, 1024, "AUTH %s\r\n", server.masterauth);
8011 if (syncWrite(fd, authcmd, strlen(server.masterauth)+7, 5) == -1) {
8012 close(fd);
8013 redisLog(REDIS_WARNING,"Unable to AUTH to MASTER: %s",
8014 strerror(errno));
8015 return REDIS_ERR;
8016 }
8017 /* Read the AUTH result. */
8018 if (syncReadLine(fd,buf,1024,3600) == -1) {
8019 close(fd);
8020 redisLog(REDIS_WARNING,"I/O error reading auth result from MASTER: %s",
8021 strerror(errno));
8022 return REDIS_ERR;
8023 }
8024 if (buf[0] != '+') {
8025 close(fd);
8026 redisLog(REDIS_WARNING,"Cannot AUTH to MASTER, is the masterauth password correct?");
8027 return REDIS_ERR;
8028 }
8029 }
8030
8031 /* Issue the SYNC command */
8032 if (syncWrite(fd,"SYNC \r\n",7,5) == -1) {
8033 close(fd);
8034 redisLog(REDIS_WARNING,"I/O error writing to MASTER: %s",
8035 strerror(errno));
8036 return REDIS_ERR;
8037 }
8038 /* Read the bulk write count */
8039 if (syncReadLine(fd,buf,1024,3600) == -1) {
8040 close(fd);
8041 redisLog(REDIS_WARNING,"I/O error reading bulk count from MASTER: %s",
8042 strerror(errno));
8043 return REDIS_ERR;
8044 }
8045 if (buf[0] != '$') {
8046 close(fd);
8047 redisLog(REDIS_WARNING,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
8048 return REDIS_ERR;
8049 }
8050 dumpsize = strtol(buf+1,NULL,10);
8051 redisLog(REDIS_NOTICE,"Receiving %ld bytes data dump from MASTER",dumpsize);
8052 /* Read the bulk write data on a temp file */
8053 while(maxtries--) {
8054 snprintf(tmpfile,256,
8055 "temp-%d.%ld.rdb",(int)time(NULL),(long int)getpid());
8056 dfd = open(tmpfile,O_CREAT|O_WRONLY|O_EXCL,0644);
8057 if (dfd != -1) break;
8058 sleep(1);
8059 }
8060 if (dfd == -1) {
8061 close(fd);
8062 redisLog(REDIS_WARNING,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno));
8063 return REDIS_ERR;
8064 }
8065 while(dumpsize) {
8066 int nread, nwritten;
8067
8068 nread = read(fd,buf,(dumpsize < 1024)?dumpsize:1024);
8069 if (nread == -1) {
8070 redisLog(REDIS_WARNING,"I/O error trying to sync with MASTER: %s",
8071 strerror(errno));
8072 close(fd);
8073 close(dfd);
8074 return REDIS_ERR;
8075 }
8076 nwritten = write(dfd,buf,nread);
8077 if (nwritten == -1) {
8078 redisLog(REDIS_WARNING,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno));
8079 close(fd);
8080 close(dfd);
8081 return REDIS_ERR;
8082 }
8083 dumpsize -= nread;
8084 }
8085 close(dfd);
8086 if (rename(tmpfile,server.dbfilename) == -1) {
8087 redisLog(REDIS_WARNING,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno));
8088 unlink(tmpfile);
8089 close(fd);
8090 return REDIS_ERR;
8091 }
8092 emptyDb();
8093 if (rdbLoad(server.dbfilename) != REDIS_OK) {
8094 redisLog(REDIS_WARNING,"Failed trying to load the MASTER synchronization DB from disk");
8095 close(fd);
8096 return REDIS_ERR;
8097 }
8098 server.master = createClient(fd);
8099 server.master->flags |= REDIS_MASTER;
8100 server.master->authenticated = 1;
8101 server.replstate = REDIS_REPL_CONNECTED;
8102 return REDIS_OK;
8103 }
8104
8105 static void slaveofCommand(redisClient *c) {
8106 if (!strcasecmp(c->argv[1]->ptr,"no") &&
8107 !strcasecmp(c->argv[2]->ptr,"one")) {
8108 if (server.masterhost) {
8109 sdsfree(server.masterhost);
8110 server.masterhost = NULL;
8111 if (server.master) freeClient(server.master);
8112 server.replstate = REDIS_REPL_NONE;
8113 redisLog(REDIS_NOTICE,"MASTER MODE enabled (user request)");
8114 }
8115 } else {
8116 sdsfree(server.masterhost);
8117 server.masterhost = sdsdup(c->argv[1]->ptr);
8118 server.masterport = atoi(c->argv[2]->ptr);
8119 if (server.master) freeClient(server.master);
8120 server.replstate = REDIS_REPL_CONNECT;
8121 redisLog(REDIS_NOTICE,"SLAVE OF %s:%d enabled (user request)",
8122 server.masterhost, server.masterport);
8123 }
8124 addReply(c,shared.ok);
8125 }
8126
8127 /* ============================ Maxmemory directive ======================== */
8128
8129 /* Try to free one object form the pre-allocated objects free list.
8130 * This is useful under low mem conditions as by default we take 1 million
8131 * free objects allocated. On success REDIS_OK is returned, otherwise
8132 * REDIS_ERR. */
8133 static int tryFreeOneObjectFromFreelist(void) {
8134 robj *o;
8135
8136 if (server.vm_enabled) pthread_mutex_lock(&server.obj_freelist_mutex);
8137 if (listLength(server.objfreelist)) {
8138 listNode *head = listFirst(server.objfreelist);
8139 o = listNodeValue(head);
8140 listDelNode(server.objfreelist,head);
8141 if (server.vm_enabled) pthread_mutex_unlock(&server.obj_freelist_mutex);
8142 zfree(o);
8143 return REDIS_OK;
8144 } else {
8145 if (server.vm_enabled) pthread_mutex_unlock(&server.obj_freelist_mutex);
8146 return REDIS_ERR;
8147 }
8148 }
8149
8150 /* This function gets called when 'maxmemory' is set on the config file to limit
8151 * the max memory used by the server, and we are out of memory.
8152 * This function will try to, in order:
8153 *
8154 * - Free objects from the free list
8155 * - Try to remove keys with an EXPIRE set
8156 *
8157 * It is not possible to free enough memory to reach used-memory < maxmemory
8158 * the server will start refusing commands that will enlarge even more the
8159 * memory usage.
8160 */
8161 static void freeMemoryIfNeeded(void) {
8162 while (server.maxmemory && zmalloc_used_memory() > server.maxmemory) {
8163 int j, k, freed = 0;
8164
8165 if (tryFreeOneObjectFromFreelist() == REDIS_OK) continue;
8166 for (j = 0; j < server.dbnum; j++) {
8167 int minttl = -1;
8168 robj *minkey = NULL;
8169 struct dictEntry *de;
8170
8171 if (dictSize(server.db[j].expires)) {
8172 freed = 1;
8173 /* From a sample of three keys drop the one nearest to
8174 * the natural expire */
8175 for (k = 0; k < 3; k++) {
8176 time_t t;
8177
8178 de = dictGetRandomKey(server.db[j].expires);
8179 t = (time_t) dictGetEntryVal(de);
8180 if (minttl == -1 || t < minttl) {
8181 minkey = dictGetEntryKey(de);
8182 minttl = t;
8183 }
8184 }
8185 deleteKey(server.db+j,minkey);
8186 }
8187 }
8188 if (!freed) return; /* nothing to free... */
8189 }
8190 }
8191
8192 /* ============================== Append Only file ========================== */
8193
8194 /* Write the append only file buffer on disk.
8195 *
8196 * Since we are required to write the AOF before replying to the client,
8197 * and the only way the client socket can get a write is entering when the
8198 * the event loop, we accumulate all the AOF writes in a memory
8199 * buffer and write it on disk using this function just before entering
8200 * the event loop again. */
8201 static void flushAppendOnlyFile(void) {
8202 time_t now;
8203 ssize_t nwritten;
8204
8205 if (sdslen(server.aofbuf) == 0) return;
8206
8207 /* We want to perform a single write. This should be guaranteed atomic
8208 * at least if the filesystem we are writing is a real physical one.
8209 * While this will save us against the server being killed I don't think
8210 * there is much to do about the whole server stopping for power problems
8211 * or alike */
8212 nwritten = write(server.appendfd,server.aofbuf,sdslen(server.aofbuf));
8213 if (nwritten != (signed)sdslen(server.aofbuf)) {
8214 /* Ooops, we are in troubles. The best thing to do for now is
8215 * aborting instead of giving the illusion that everything is
8216 * working as expected. */
8217 if (nwritten == -1) {
8218 redisLog(REDIS_WARNING,"Exiting on error writing to the append-only file: %s",strerror(errno));
8219 } else {
8220 redisLog(REDIS_WARNING,"Exiting on short write while writing to the append-only file: %s",strerror(errno));
8221 }
8222 exit(1);
8223 }
8224 sdsfree(server.aofbuf);
8225 server.aofbuf = sdsempty();
8226
8227 /* Fsync if needed */
8228 now = time(NULL);
8229 if (server.appendfsync == APPENDFSYNC_ALWAYS ||
8230 (server.appendfsync == APPENDFSYNC_EVERYSEC &&
8231 now-server.lastfsync > 1))
8232 {
8233 /* aof_fsync is defined as fdatasync() for Linux in order to avoid
8234 * flushing metadata. */
8235 aof_fsync(server.appendfd); /* Let's try to get this data on the disk */
8236 server.lastfsync = now;
8237 }
8238 }
8239
8240 static sds catAppendOnlyGenericCommand(sds buf, int argc, robj **argv) {
8241 int j;
8242 buf = sdscatprintf(buf,"*%d\r\n",argc);
8243 for (j = 0; j < argc; j++) {
8244 robj *o = getDecodedObject(argv[j]);
8245 buf = sdscatprintf(buf,"$%lu\r\n",(unsigned long)sdslen(o->ptr));
8246 buf = sdscatlen(buf,o->ptr,sdslen(o->ptr));
8247 buf = sdscatlen(buf,"\r\n",2);
8248 decrRefCount(o);
8249 }
8250 return buf;
8251 }
8252
8253 static sds catAppendOnlyExpireAtCommand(sds buf, robj *key, robj *seconds) {
8254 int argc = 3;
8255 long when;
8256 robj *argv[3];
8257
8258 /* Make sure we can use strtol */
8259 seconds = getDecodedObject(seconds);
8260 when = time(NULL)+strtol(seconds->ptr,NULL,10);
8261 decrRefCount(seconds);
8262
8263 argv[0] = createStringObject("EXPIREAT",8);
8264 argv[1] = key;
8265 argv[2] = createObject(REDIS_STRING,
8266 sdscatprintf(sdsempty(),"%ld",when));
8267 buf = catAppendOnlyGenericCommand(buf, argc, argv);
8268 decrRefCount(argv[0]);
8269 decrRefCount(argv[2]);
8270 return buf;
8271 }
8272
8273 static void feedAppendOnlyFile(struct redisCommand *cmd, int dictid, robj **argv, int argc) {
8274 sds buf = sdsempty();
8275 robj *tmpargv[3];
8276
8277 /* The DB this command was targetting is not the same as the last command
8278 * we appendend. To issue a SELECT command is needed. */
8279 if (dictid != server.appendseldb) {
8280 char seldb[64];
8281
8282 snprintf(seldb,sizeof(seldb),"%d",dictid);
8283 buf = sdscatprintf(buf,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
8284 (unsigned long)strlen(seldb),seldb);
8285 server.appendseldb = dictid;
8286 }
8287
8288 if (cmd->proc == expireCommand) {
8289 /* Translate EXPIRE into EXPIREAT */
8290 buf = catAppendOnlyExpireAtCommand(buf,argv[1],argv[2]);
8291 } else if (cmd->proc == setexCommand) {
8292 /* Translate SETEX to SET and EXPIREAT */
8293 tmpargv[0] = createStringObject("SET",3);
8294 tmpargv[1] = argv[1];
8295 tmpargv[2] = argv[3];
8296 buf = catAppendOnlyGenericCommand(buf,3,tmpargv);
8297 decrRefCount(tmpargv[0]);
8298 buf = catAppendOnlyExpireAtCommand(buf,argv[1],argv[2]);
8299 } else {
8300 buf = catAppendOnlyGenericCommand(buf,argc,argv);
8301 }
8302
8303 /* Append to the AOF buffer. This will be flushed on disk just before
8304 * of re-entering the event loop, so before the client will get a
8305 * positive reply about the operation performed. */
8306 server.aofbuf = sdscatlen(server.aofbuf,buf,sdslen(buf));
8307
8308 /* If a background append only file rewriting is in progress we want to
8309 * accumulate the differences between the child DB and the current one
8310 * in a buffer, so that when the child process will do its work we
8311 * can append the differences to the new append only file. */
8312 if (server.bgrewritechildpid != -1)
8313 server.bgrewritebuf = sdscatlen(server.bgrewritebuf,buf,sdslen(buf));
8314
8315 sdsfree(buf);
8316 }
8317
8318 /* In Redis commands are always executed in the context of a client, so in
8319 * order to load the append only file we need to create a fake client. */
8320 static struct redisClient *createFakeClient(void) {
8321 struct redisClient *c = zmalloc(sizeof(*c));
8322
8323 selectDb(c,0);
8324 c->fd = -1;
8325 c->querybuf = sdsempty();
8326 c->argc = 0;
8327 c->argv = NULL;
8328 c->flags = 0;
8329 /* We set the fake client as a slave waiting for the synchronization
8330 * so that Redis will not try to send replies to this client. */
8331 c->replstate = REDIS_REPL_WAIT_BGSAVE_START;
8332 c->reply = listCreate();
8333 listSetFreeMethod(c->reply,decrRefCount);
8334 listSetDupMethod(c->reply,dupClientReplyValue);
8335 initClientMultiState(c);
8336 return c;
8337 }
8338
8339 static void freeFakeClient(struct redisClient *c) {
8340 sdsfree(c->querybuf);
8341 listRelease(c->reply);
8342 freeClientMultiState(c);
8343 zfree(c);
8344 }
8345
8346 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
8347 * error (the append only file is zero-length) REDIS_ERR is returned. On
8348 * fatal error an error message is logged and the program exists. */
8349 int loadAppendOnlyFile(char *filename) {
8350 struct redisClient *fakeClient;
8351 FILE *fp = fopen(filename,"r");
8352 struct redis_stat sb;
8353 unsigned long long loadedkeys = 0;
8354 int appendonly = server.appendonly;
8355
8356 if (redis_fstat(fileno(fp),&sb) != -1 && sb.st_size == 0)
8357 return REDIS_ERR;
8358
8359 if (fp == NULL) {
8360 redisLog(REDIS_WARNING,"Fatal error: can't open the append log file for reading: %s",strerror(errno));
8361 exit(1);
8362 }
8363
8364 /* Temporarily disable AOF, to prevent EXEC from feeding a MULTI
8365 * to the same file we're about to read. */
8366 server.appendonly = 0;
8367
8368 fakeClient = createFakeClient();
8369 while(1) {
8370 int argc, j;
8371 unsigned long len;
8372 robj **argv;
8373 char buf[128];
8374 sds argsds;
8375 struct redisCommand *cmd;
8376
8377 if (fgets(buf,sizeof(buf),fp) == NULL) {
8378 if (feof(fp))
8379 break;
8380 else
8381 goto readerr;
8382 }
8383 if (buf[0] != '*') goto fmterr;
8384 argc = atoi(buf+1);
8385 argv = zmalloc(sizeof(robj*)*argc);
8386 for (j = 0; j < argc; j++) {
8387 if (fgets(buf,sizeof(buf),fp) == NULL) goto readerr;
8388 if (buf[0] != '$') goto fmterr;
8389 len = strtol(buf+1,NULL,10);
8390 argsds = sdsnewlen(NULL,len);
8391 if (len && fread(argsds,len,1,fp) == 0) goto fmterr;
8392 argv[j] = createObject(REDIS_STRING,argsds);
8393 if (fread(buf,2,1,fp) == 0) goto fmterr; /* discard CRLF */
8394 }
8395
8396 /* Command lookup */
8397 cmd = lookupCommand(argv[0]->ptr);
8398 if (!cmd) {
8399 redisLog(REDIS_WARNING,"Unknown command '%s' reading the append only file", argv[0]->ptr);
8400 exit(1);
8401 }
8402 /* Try object encoding */
8403 if (cmd->flags & REDIS_CMD_BULK)
8404 argv[argc-1] = tryObjectEncoding(argv[argc-1]);
8405 /* Run the command in the context of a fake client */
8406 fakeClient->argc = argc;
8407 fakeClient->argv = argv;
8408 cmd->proc(fakeClient);
8409 /* Discard the reply objects list from the fake client */
8410 while(listLength(fakeClient->reply))
8411 listDelNode(fakeClient->reply,listFirst(fakeClient->reply));
8412 /* Clean up, ready for the next command */
8413 for (j = 0; j < argc; j++) decrRefCount(argv[j]);
8414 zfree(argv);
8415 /* Handle swapping while loading big datasets when VM is on */
8416 loadedkeys++;
8417 if (server.vm_enabled && (loadedkeys % 5000) == 0) {
8418 while (zmalloc_used_memory() > server.vm_max_memory) {
8419 if (vmSwapOneObjectBlocking() == REDIS_ERR) break;
8420 }
8421 }
8422 }
8423
8424 /* This point can only be reached when EOF is reached without errors.
8425 * If the client is in the middle of a MULTI/EXEC, log error and quit. */
8426 if (fakeClient->flags & REDIS_MULTI) goto readerr;
8427
8428 fclose(fp);
8429 freeFakeClient(fakeClient);
8430 server.appendonly = appendonly;
8431 return REDIS_OK;
8432
8433 readerr:
8434 if (feof(fp)) {
8435 redisLog(REDIS_WARNING,"Unexpected end of file reading the append only file");
8436 } else {
8437 redisLog(REDIS_WARNING,"Unrecoverable error reading the append only file: %s", strerror(errno));
8438 }
8439 exit(1);
8440 fmterr:
8441 redisLog(REDIS_WARNING,"Bad file format reading the append only file");
8442 exit(1);
8443 }
8444
8445 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
8446 static int fwriteBulkObject(FILE *fp, robj *obj) {
8447 char buf[128];
8448 int decrrc = 0;
8449
8450 /* Avoid the incr/decr ref count business if possible to help
8451 * copy-on-write (we are often in a child process when this function
8452 * is called).
8453 * Also makes sure that key objects don't get incrRefCount-ed when VM
8454 * is enabled */
8455 if (obj->encoding != REDIS_ENCODING_RAW) {
8456 obj = getDecodedObject(obj);
8457 decrrc = 1;
8458 }
8459 snprintf(buf,sizeof(buf),"$%ld\r\n",(long)sdslen(obj->ptr));
8460 if (fwrite(buf,strlen(buf),1,fp) == 0) goto err;
8461 if (sdslen(obj->ptr) && fwrite(obj->ptr,sdslen(obj->ptr),1,fp) == 0)
8462 goto err;
8463 if (fwrite("\r\n",2,1,fp) == 0) goto err;
8464 if (decrrc) decrRefCount(obj);
8465 return 1;
8466 err:
8467 if (decrrc) decrRefCount(obj);
8468 return 0;
8469 }
8470
8471 /* Write binary-safe string into a file in the bulkformat
8472 * $<count>\r\n<payload>\r\n */
8473 static int fwriteBulkString(FILE *fp, char *s, unsigned long len) {
8474 char buf[128];
8475
8476 snprintf(buf,sizeof(buf),"$%ld\r\n",(unsigned long)len);
8477 if (fwrite(buf,strlen(buf),1,fp) == 0) return 0;
8478 if (len && fwrite(s,len,1,fp) == 0) return 0;
8479 if (fwrite("\r\n",2,1,fp) == 0) return 0;
8480 return 1;
8481 }
8482
8483 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
8484 static int fwriteBulkDouble(FILE *fp, double d) {
8485 char buf[128], dbuf[128];
8486
8487 snprintf(dbuf,sizeof(dbuf),"%.17g\r\n",d);
8488 snprintf(buf,sizeof(buf),"$%lu\r\n",(unsigned long)strlen(dbuf)-2);
8489 if (fwrite(buf,strlen(buf),1,fp) == 0) return 0;
8490 if (fwrite(dbuf,strlen(dbuf),1,fp) == 0) return 0;
8491 return 1;
8492 }
8493
8494 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
8495 static int fwriteBulkLong(FILE *fp, long l) {
8496 char buf[128], lbuf[128];
8497
8498 snprintf(lbuf,sizeof(lbuf),"%ld\r\n",l);
8499 snprintf(buf,sizeof(buf),"$%lu\r\n",(unsigned long)strlen(lbuf)-2);
8500 if (fwrite(buf,strlen(buf),1,fp) == 0) return 0;
8501 if (fwrite(lbuf,strlen(lbuf),1,fp) == 0) return 0;
8502 return 1;
8503 }
8504
8505 /* Write a sequence of commands able to fully rebuild the dataset into
8506 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
8507 static int rewriteAppendOnlyFile(char *filename) {
8508 dictIterator *di = NULL;
8509 dictEntry *de;
8510 FILE *fp;
8511 char tmpfile[256];
8512 int j;
8513 time_t now = time(NULL);
8514
8515 /* Note that we have to use a different temp name here compared to the
8516 * one used by rewriteAppendOnlyFileBackground() function. */
8517 snprintf(tmpfile,256,"temp-rewriteaof-%d.aof", (int) getpid());
8518 fp = fopen(tmpfile,"w");
8519 if (!fp) {
8520 redisLog(REDIS_WARNING, "Failed rewriting the append only file: %s", strerror(errno));
8521 return REDIS_ERR;
8522 }
8523 for (j = 0; j < server.dbnum; j++) {
8524 char selectcmd[] = "*2\r\n$6\r\nSELECT\r\n";
8525 redisDb *db = server.db+j;
8526 dict *d = db->dict;
8527 if (dictSize(d) == 0) continue;
8528 di = dictGetIterator(d);
8529 if (!di) {
8530 fclose(fp);
8531 return REDIS_ERR;
8532 }
8533
8534 /* SELECT the new DB */
8535 if (fwrite(selectcmd,sizeof(selectcmd)-1,1,fp) == 0) goto werr;
8536 if (fwriteBulkLong(fp,j) == 0) goto werr;
8537
8538 /* Iterate this DB writing every entry */
8539 while((de = dictNext(di)) != NULL) {
8540 robj *key, *o;
8541 time_t expiretime;
8542 int swapped;
8543
8544 key = dictGetEntryKey(de);
8545 /* If the value for this key is swapped, load a preview in memory.
8546 * We use a "swapped" flag to remember if we need to free the
8547 * value object instead to just increment the ref count anyway
8548 * in order to avoid copy-on-write of pages if we are forked() */
8549 if (!server.vm_enabled || key->storage == REDIS_VM_MEMORY ||
8550 key->storage == REDIS_VM_SWAPPING) {
8551 o = dictGetEntryVal(de);
8552 swapped = 0;
8553 } else {
8554 o = vmPreviewObject(key);
8555 swapped = 1;
8556 }
8557 expiretime = getExpire(db,key);
8558
8559 /* Save the key and associated value */
8560 if (o->type == REDIS_STRING) {
8561 /* Emit a SET command */
8562 char cmd[]="*3\r\n$3\r\nSET\r\n";
8563 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
8564 /* Key and value */
8565 if (fwriteBulkObject(fp,key) == 0) goto werr;
8566 if (fwriteBulkObject(fp,o) == 0) goto werr;
8567 } else if (o->type == REDIS_LIST) {
8568 /* Emit the RPUSHes needed to rebuild the list */
8569 list *list = o->ptr;
8570 listNode *ln;
8571 listIter li;
8572
8573 listRewind(list,&li);
8574 while((ln = listNext(&li))) {
8575 char cmd[]="*3\r\n$5\r\nRPUSH\r\n";
8576 robj *eleobj = listNodeValue(ln);
8577
8578 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
8579 if (fwriteBulkObject(fp,key) == 0) goto werr;
8580 if (fwriteBulkObject(fp,eleobj) == 0) goto werr;
8581 }
8582 } else if (o->type == REDIS_SET) {
8583 /* Emit the SADDs needed to rebuild the set */
8584 dict *set = o->ptr;
8585 dictIterator *di = dictGetIterator(set);
8586 dictEntry *de;
8587
8588 while((de = dictNext(di)) != NULL) {
8589 char cmd[]="*3\r\n$4\r\nSADD\r\n";
8590 robj *eleobj = dictGetEntryKey(de);
8591
8592 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
8593 if (fwriteBulkObject(fp,key) == 0) goto werr;
8594 if (fwriteBulkObject(fp,eleobj) == 0) goto werr;
8595 }
8596 dictReleaseIterator(di);
8597 } else if (o->type == REDIS_ZSET) {
8598 /* Emit the ZADDs needed to rebuild the sorted set */
8599 zset *zs = o->ptr;
8600 dictIterator *di = dictGetIterator(zs->dict);
8601 dictEntry *de;
8602
8603 while((de = dictNext(di)) != NULL) {
8604 char cmd[]="*4\r\n$4\r\nZADD\r\n";
8605 robj *eleobj = dictGetEntryKey(de);
8606 double *score = dictGetEntryVal(de);
8607
8608 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
8609 if (fwriteBulkObject(fp,key) == 0) goto werr;
8610 if (fwriteBulkDouble(fp,*score) == 0) goto werr;
8611 if (fwriteBulkObject(fp,eleobj) == 0) goto werr;
8612 }
8613 dictReleaseIterator(di);
8614 } else if (o->type == REDIS_HASH) {
8615 char cmd[]="*4\r\n$4\r\nHSET\r\n";
8616
8617 /* Emit the HSETs needed to rebuild the hash */
8618 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
8619 unsigned char *p = zipmapRewind(o->ptr);
8620 unsigned char *field, *val;
8621 unsigned int flen, vlen;
8622
8623 while((p = zipmapNext(p,&field,&flen,&val,&vlen)) != NULL) {
8624 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
8625 if (fwriteBulkObject(fp,key) == 0) goto werr;
8626 if (fwriteBulkString(fp,(char*)field,flen) == -1)
8627 return -1;
8628 if (fwriteBulkString(fp,(char*)val,vlen) == -1)
8629 return -1;
8630 }
8631 } else {
8632 dictIterator *di = dictGetIterator(o->ptr);
8633 dictEntry *de;
8634
8635 while((de = dictNext(di)) != NULL) {
8636 robj *field = dictGetEntryKey(de);
8637 robj *val = dictGetEntryVal(de);
8638
8639 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
8640 if (fwriteBulkObject(fp,key) == 0) goto werr;
8641 if (fwriteBulkObject(fp,field) == -1) return -1;
8642 if (fwriteBulkObject(fp,val) == -1) return -1;
8643 }
8644 dictReleaseIterator(di);
8645 }
8646 } else {
8647 redisPanic("Unknown object type");
8648 }
8649 /* Save the expire time */
8650 if (expiretime != -1) {
8651 char cmd[]="*3\r\n$8\r\nEXPIREAT\r\n";
8652 /* If this key is already expired skip it */
8653 if (expiretime < now) continue;
8654 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
8655 if (fwriteBulkObject(fp,key) == 0) goto werr;
8656 if (fwriteBulkLong(fp,expiretime) == 0) goto werr;
8657 }
8658 if (swapped) decrRefCount(o);
8659 }
8660 dictReleaseIterator(di);
8661 }
8662
8663 /* Make sure data will not remain on the OS's output buffers */
8664 fflush(fp);
8665 fsync(fileno(fp));
8666 fclose(fp);
8667
8668 /* Use RENAME to make sure the DB file is changed atomically only
8669 * if the generate DB file is ok. */
8670 if (rename(tmpfile,filename) == -1) {
8671 redisLog(REDIS_WARNING,"Error moving temp append only file on the final destination: %s", strerror(errno));
8672 unlink(tmpfile);
8673 return REDIS_ERR;
8674 }
8675 redisLog(REDIS_NOTICE,"SYNC append only file rewrite performed");
8676 return REDIS_OK;
8677
8678 werr:
8679 fclose(fp);
8680 unlink(tmpfile);
8681 redisLog(REDIS_WARNING,"Write error writing append only file on disk: %s", strerror(errno));
8682 if (di) dictReleaseIterator(di);
8683 return REDIS_ERR;
8684 }
8685
8686 /* This is how rewriting of the append only file in background works:
8687 *
8688 * 1) The user calls BGREWRITEAOF
8689 * 2) Redis calls this function, that forks():
8690 * 2a) the child rewrite the append only file in a temp file.
8691 * 2b) the parent accumulates differences in server.bgrewritebuf.
8692 * 3) When the child finished '2a' exists.
8693 * 4) The parent will trap the exit code, if it's OK, will append the
8694 * data accumulated into server.bgrewritebuf into the temp file, and
8695 * finally will rename(2) the temp file in the actual file name.
8696 * The the new file is reopened as the new append only file. Profit!
8697 */
8698 static int rewriteAppendOnlyFileBackground(void) {
8699 pid_t childpid;
8700
8701 if (server.bgrewritechildpid != -1) return REDIS_ERR;
8702 if (server.vm_enabled) waitEmptyIOJobsQueue();
8703 if ((childpid = fork()) == 0) {
8704 /* Child */
8705 char tmpfile[256];
8706
8707 if (server.vm_enabled) vmReopenSwapFile();
8708 close(server.fd);
8709 snprintf(tmpfile,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
8710 if (rewriteAppendOnlyFile(tmpfile) == REDIS_OK) {
8711 _exit(0);
8712 } else {
8713 _exit(1);
8714 }
8715 } else {
8716 /* Parent */
8717 if (childpid == -1) {
8718 redisLog(REDIS_WARNING,
8719 "Can't rewrite append only file in background: fork: %s",
8720 strerror(errno));
8721 return REDIS_ERR;
8722 }
8723 redisLog(REDIS_NOTICE,
8724 "Background append only file rewriting started by pid %d",childpid);
8725 server.bgrewritechildpid = childpid;
8726 updateDictResizePolicy();
8727 /* We set appendseldb to -1 in order to force the next call to the
8728 * feedAppendOnlyFile() to issue a SELECT command, so the differences
8729 * accumulated by the parent into server.bgrewritebuf will start
8730 * with a SELECT statement and it will be safe to merge. */
8731 server.appendseldb = -1;
8732 return REDIS_OK;
8733 }
8734 return REDIS_OK; /* unreached */
8735 }
8736
8737 static void bgrewriteaofCommand(redisClient *c) {
8738 if (server.bgrewritechildpid != -1) {
8739 addReplySds(c,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
8740 return;
8741 }
8742 if (rewriteAppendOnlyFileBackground() == REDIS_OK) {
8743 char *status = "+Background append only file rewriting started\r\n";
8744 addReplySds(c,sdsnew(status));
8745 } else {
8746 addReply(c,shared.err);
8747 }
8748 }
8749
8750 static void aofRemoveTempFile(pid_t childpid) {
8751 char tmpfile[256];
8752
8753 snprintf(tmpfile,256,"temp-rewriteaof-bg-%d.aof", (int) childpid);
8754 unlink(tmpfile);
8755 }
8756
8757 /* Virtual Memory is composed mainly of two subsystems:
8758 * - Blocking Virutal Memory
8759 * - Threaded Virtual Memory I/O
8760 * The two parts are not fully decoupled, but functions are split among two
8761 * different sections of the source code (delimited by comments) in order to
8762 * make more clear what functionality is about the blocking VM and what about
8763 * the threaded (not blocking) VM.
8764 *
8765 * Redis VM design:
8766 *
8767 * Redis VM is a blocking VM (one that blocks reading swapped values from
8768 * disk into memory when a value swapped out is needed in memory) that is made
8769 * unblocking by trying to examine the command argument vector in order to
8770 * load in background values that will likely be needed in order to exec
8771 * the command. The command is executed only once all the relevant keys
8772 * are loaded into memory.
8773 *
8774 * This basically is almost as simple of a blocking VM, but almost as parallel
8775 * as a fully non-blocking VM.
8776 */
8777
8778 /* Called when the user switches from "appendonly yes" to "appendonly no"
8779 * at runtime using the CONFIG command. */
8780 static void stopAppendOnly(void) {
8781 flushAppendOnlyFile();
8782 fsync(server.appendfd);
8783 close(server.appendfd);
8784
8785 server.appendfd = -1;
8786 server.appendseldb = -1;
8787 server.appendonly = 0;
8788 /* rewrite operation in progress? kill it, wait child exit */
8789 if (server.bgsavechildpid != -1) {
8790 int statloc;
8791
8792 if (kill(server.bgsavechildpid,SIGKILL) != -1)
8793 wait3(&statloc,0,NULL);
8794 /* reset the buffer accumulating changes while the child saves */
8795 sdsfree(server.bgrewritebuf);
8796 server.bgrewritebuf = sdsempty();
8797 server.bgsavechildpid = -1;
8798 }
8799 }
8800
8801 /* Called when the user switches from "appendonly no" to "appendonly yes"
8802 * at runtime using the CONFIG command. */
8803 static int startAppendOnly(void) {
8804 server.appendonly = 1;
8805 server.lastfsync = time(NULL);
8806 server.appendfd = open(server.appendfilename,O_WRONLY|O_APPEND|O_CREAT,0644);
8807 if (server.appendfd == -1) {
8808 redisLog(REDIS_WARNING,"Used tried to switch on AOF via CONFIG, but I can't open the AOF file: %s",strerror(errno));
8809 return REDIS_ERR;
8810 }
8811 if (rewriteAppendOnlyFileBackground() == REDIS_ERR) {
8812 server.appendonly = 0;
8813 close(server.appendfd);
8814 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));
8815 return REDIS_ERR;
8816 }
8817 return REDIS_OK;
8818 }
8819
8820 /* =================== Virtual Memory - Blocking Side ====================== */
8821
8822 static void vmInit(void) {
8823 off_t totsize;
8824 int pipefds[2];
8825 size_t stacksize;
8826 struct flock fl;
8827
8828 if (server.vm_max_threads != 0)
8829 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
8830
8831 redisLog(REDIS_NOTICE,"Using '%s' as swap file",server.vm_swap_file);
8832 /* Try to open the old swap file, otherwise create it */
8833 if ((server.vm_fp = fopen(server.vm_swap_file,"r+b")) == NULL) {
8834 server.vm_fp = fopen(server.vm_swap_file,"w+b");
8835 }
8836 if (server.vm_fp == NULL) {
8837 redisLog(REDIS_WARNING,
8838 "Can't open the swap file: %s. Exiting.",
8839 strerror(errno));
8840 exit(1);
8841 }
8842 server.vm_fd = fileno(server.vm_fp);
8843 /* Lock the swap file for writing, this is useful in order to avoid
8844 * another instance to use the same swap file for a config error. */
8845 fl.l_type = F_WRLCK;
8846 fl.l_whence = SEEK_SET;
8847 fl.l_start = fl.l_len = 0;
8848 if (fcntl(server.vm_fd,F_SETLK,&fl) == -1) {
8849 redisLog(REDIS_WARNING,
8850 "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));
8851 exit(1);
8852 }
8853 /* Initialize */
8854 server.vm_next_page = 0;
8855 server.vm_near_pages = 0;
8856 server.vm_stats_used_pages = 0;
8857 server.vm_stats_swapped_objects = 0;
8858 server.vm_stats_swapouts = 0;
8859 server.vm_stats_swapins = 0;
8860 totsize = server.vm_pages*server.vm_page_size;
8861 redisLog(REDIS_NOTICE,"Allocating %lld bytes of swap file",totsize);
8862 if (ftruncate(server.vm_fd,totsize) == -1) {
8863 redisLog(REDIS_WARNING,"Can't ftruncate swap file: %s. Exiting.",
8864 strerror(errno));
8865 exit(1);
8866 } else {
8867 redisLog(REDIS_NOTICE,"Swap file allocated with success");
8868 }
8869 server.vm_bitmap = zmalloc((server.vm_pages+7)/8);
8870 redisLog(REDIS_VERBOSE,"Allocated %lld bytes page table for %lld pages",
8871 (long long) (server.vm_pages+7)/8, server.vm_pages);
8872 memset(server.vm_bitmap,0,(server.vm_pages+7)/8);
8873
8874 /* Initialize threaded I/O (used by Virtual Memory) */
8875 server.io_newjobs = listCreate();
8876 server.io_processing = listCreate();
8877 server.io_processed = listCreate();
8878 server.io_ready_clients = listCreate();
8879 pthread_mutex_init(&server.io_mutex,NULL);
8880 pthread_mutex_init(&server.obj_freelist_mutex,NULL);
8881 pthread_mutex_init(&server.io_swapfile_mutex,NULL);
8882 server.io_active_threads = 0;
8883 if (pipe(pipefds) == -1) {
8884 redisLog(REDIS_WARNING,"Unable to intialized VM: pipe(2): %s. Exiting."
8885 ,strerror(errno));
8886 exit(1);
8887 }
8888 server.io_ready_pipe_read = pipefds[0];
8889 server.io_ready_pipe_write = pipefds[1];
8890 redisAssert(anetNonBlock(NULL,server.io_ready_pipe_read) != ANET_ERR);
8891 /* LZF requires a lot of stack */
8892 pthread_attr_init(&server.io_threads_attr);
8893 pthread_attr_getstacksize(&server.io_threads_attr, &stacksize);
8894 while (stacksize < REDIS_THREAD_STACK_SIZE) stacksize *= 2;
8895 pthread_attr_setstacksize(&server.io_threads_attr, stacksize);
8896 /* Listen for events in the threaded I/O pipe */
8897 if (aeCreateFileEvent(server.el, server.io_ready_pipe_read, AE_READABLE,
8898 vmThreadedIOCompletedJob, NULL) == AE_ERR)
8899 oom("creating file event");
8900 }
8901
8902 /* Mark the page as used */
8903 static void vmMarkPageUsed(off_t page) {
8904 off_t byte = page/8;
8905 int bit = page&7;
8906 redisAssert(vmFreePage(page) == 1);
8907 server.vm_bitmap[byte] |= 1<<bit;
8908 }
8909
8910 /* Mark N contiguous pages as used, with 'page' being the first. */
8911 static void vmMarkPagesUsed(off_t page, off_t count) {
8912 off_t j;
8913
8914 for (j = 0; j < count; j++)
8915 vmMarkPageUsed(page+j);
8916 server.vm_stats_used_pages += count;
8917 redisLog(REDIS_DEBUG,"Mark USED pages: %lld pages at %lld\n",
8918 (long long)count, (long long)page);
8919 }
8920
8921 /* Mark the page as free */
8922 static void vmMarkPageFree(off_t page) {
8923 off_t byte = page/8;
8924 int bit = page&7;
8925 redisAssert(vmFreePage(page) == 0);
8926 server.vm_bitmap[byte] &= ~(1<<bit);
8927 }
8928
8929 /* Mark N contiguous pages as free, with 'page' being the first. */
8930 static void vmMarkPagesFree(off_t page, off_t count) {
8931 off_t j;
8932
8933 for (j = 0; j < count; j++)
8934 vmMarkPageFree(page+j);
8935 server.vm_stats_used_pages -= count;
8936 redisLog(REDIS_DEBUG,"Mark FREE pages: %lld pages at %lld\n",
8937 (long long)count, (long long)page);
8938 }
8939
8940 /* Test if the page is free */
8941 static int vmFreePage(off_t page) {
8942 off_t byte = page/8;
8943 int bit = page&7;
8944 return (server.vm_bitmap[byte] & (1<<bit)) == 0;
8945 }
8946
8947 /* Find N contiguous free pages storing the first page of the cluster in *first.
8948 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
8949 * REDIS_ERR is returned.
8950 *
8951 * This function uses a simple algorithm: we try to allocate
8952 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
8953 * again from the start of the swap file searching for free spaces.
8954 *
8955 * If it looks pretty clear that there are no free pages near our offset
8956 * we try to find less populated places doing a forward jump of
8957 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
8958 * without hurry, and then we jump again and so forth...
8959 *
8960 * This function can be improved using a free list to avoid to guess
8961 * too much, since we could collect data about freed pages.
8962 *
8963 * note: I implemented this function just after watching an episode of
8964 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
8965 */
8966 static int vmFindContiguousPages(off_t *first, off_t n) {
8967 off_t base, offset = 0, since_jump = 0, numfree = 0;
8968
8969 if (server.vm_near_pages == REDIS_VM_MAX_NEAR_PAGES) {
8970 server.vm_near_pages = 0;
8971 server.vm_next_page = 0;
8972 }
8973 server.vm_near_pages++; /* Yet another try for pages near to the old ones */
8974 base = server.vm_next_page;
8975
8976 while(offset < server.vm_pages) {
8977 off_t this = base+offset;
8978
8979 /* If we overflow, restart from page zero */
8980 if (this >= server.vm_pages) {
8981 this -= server.vm_pages;
8982 if (this == 0) {
8983 /* Just overflowed, what we found on tail is no longer
8984 * interesting, as it's no longer contiguous. */
8985 numfree = 0;
8986 }
8987 }
8988 if (vmFreePage(this)) {
8989 /* This is a free page */
8990 numfree++;
8991 /* Already got N free pages? Return to the caller, with success */
8992 if (numfree == n) {
8993 *first = this-(n-1);
8994 server.vm_next_page = this+1;
8995 redisLog(REDIS_DEBUG, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n, (long long) *first);
8996 return REDIS_OK;
8997 }
8998 } else {
8999 /* The current one is not a free page */
9000 numfree = 0;
9001 }
9002
9003 /* Fast-forward if the current page is not free and we already
9004 * searched enough near this place. */
9005 since_jump++;
9006 if (!numfree && since_jump >= REDIS_VM_MAX_RANDOM_JUMP/4) {
9007 offset += random() % REDIS_VM_MAX_RANDOM_JUMP;
9008 since_jump = 0;
9009 /* Note that even if we rewind after the jump, we are don't need
9010 * to make sure numfree is set to zero as we only jump *if* it
9011 * is set to zero. */
9012 } else {
9013 /* Otherwise just check the next page */
9014 offset++;
9015 }
9016 }
9017 return REDIS_ERR;
9018 }
9019
9020 /* Write the specified object at the specified page of the swap file */
9021 static int vmWriteObjectOnSwap(robj *o, off_t page) {
9022 if (server.vm_enabled) pthread_mutex_lock(&server.io_swapfile_mutex);
9023 if (fseeko(server.vm_fp,page*server.vm_page_size,SEEK_SET) == -1) {
9024 if (server.vm_enabled) pthread_mutex_unlock(&server.io_swapfile_mutex);
9025 redisLog(REDIS_WARNING,
9026 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
9027 strerror(errno));
9028 return REDIS_ERR;
9029 }
9030 rdbSaveObject(server.vm_fp,o);
9031 fflush(server.vm_fp);
9032 if (server.vm_enabled) pthread_mutex_unlock(&server.io_swapfile_mutex);
9033 return REDIS_OK;
9034 }
9035
9036 /* Swap the 'val' object relative to 'key' into disk. Store all the information
9037 * needed to later retrieve the object into the key object.
9038 * If we can't find enough contiguous empty pages to swap the object on disk
9039 * REDIS_ERR is returned. */
9040 static int vmSwapObjectBlocking(robj *key, robj *val) {
9041 off_t pages = rdbSavedObjectPages(val,NULL);
9042 off_t page;
9043
9044 assert(key->storage == REDIS_VM_MEMORY);
9045 assert(key->refcount == 1);
9046 if (vmFindContiguousPages(&page,pages) == REDIS_ERR) return REDIS_ERR;
9047 if (vmWriteObjectOnSwap(val,page) == REDIS_ERR) return REDIS_ERR;
9048 key->vm.page = page;
9049 key->vm.usedpages = pages;
9050 key->storage = REDIS_VM_SWAPPED;
9051 key->vtype = val->type;
9052 decrRefCount(val); /* Deallocate the object from memory. */
9053 vmMarkPagesUsed(page,pages);
9054 redisLog(REDIS_DEBUG,"VM: object %s swapped out at %lld (%lld pages)",
9055 (unsigned char*) key->ptr,
9056 (unsigned long long) page, (unsigned long long) pages);
9057 server.vm_stats_swapped_objects++;
9058 server.vm_stats_swapouts++;
9059 return REDIS_OK;
9060 }
9061
9062 static robj *vmReadObjectFromSwap(off_t page, int type) {
9063 robj *o;
9064
9065 if (server.vm_enabled) pthread_mutex_lock(&server.io_swapfile_mutex);
9066 if (fseeko(server.vm_fp,page*server.vm_page_size,SEEK_SET) == -1) {
9067 redisLog(REDIS_WARNING,
9068 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
9069 strerror(errno));
9070 _exit(1);
9071 }
9072 o = rdbLoadObject(type,server.vm_fp);
9073 if (o == NULL) {
9074 redisLog(REDIS_WARNING, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno));
9075 _exit(1);
9076 }
9077 if (server.vm_enabled) pthread_mutex_unlock(&server.io_swapfile_mutex);
9078 return o;
9079 }
9080
9081 /* Load the value object relative to the 'key' object from swap to memory.
9082 * The newly allocated object is returned.
9083 *
9084 * If preview is true the unserialized object is returned to the caller but
9085 * no changes are made to the key object, nor the pages are marked as freed */
9086 static robj *vmGenericLoadObject(robj *key, int preview) {
9087 robj *val;
9088
9089 redisAssert(key->storage == REDIS_VM_SWAPPED || key->storage == REDIS_VM_LOADING);
9090 val = vmReadObjectFromSwap(key->vm.page,key->vtype);
9091 if (!preview) {
9092 key->storage = REDIS_VM_MEMORY;
9093 key->vm.atime = server.unixtime;
9094 vmMarkPagesFree(key->vm.page,key->vm.usedpages);
9095 redisLog(REDIS_DEBUG, "VM: object %s loaded from disk",
9096 (unsigned char*) key->ptr);
9097 server.vm_stats_swapped_objects--;
9098 } else {
9099 redisLog(REDIS_DEBUG, "VM: object %s previewed from disk",
9100 (unsigned char*) key->ptr);
9101 }
9102 server.vm_stats_swapins++;
9103 return val;
9104 }
9105
9106 /* Plain object loading, from swap to memory */
9107 static robj *vmLoadObject(robj *key) {
9108 /* If we are loading the object in background, stop it, we
9109 * need to load this object synchronously ASAP. */
9110 if (key->storage == REDIS_VM_LOADING)
9111 vmCancelThreadedIOJob(key);
9112 return vmGenericLoadObject(key,0);
9113 }
9114
9115 /* Just load the value on disk, without to modify the key.
9116 * This is useful when we want to perform some operation on the value
9117 * without to really bring it from swap to memory, like while saving the
9118 * dataset or rewriting the append only log. */
9119 static robj *vmPreviewObject(robj *key) {
9120 return vmGenericLoadObject(key,1);
9121 }
9122
9123 /* How a good candidate is this object for swapping?
9124 * The better candidate it is, the greater the returned value.
9125 *
9126 * Currently we try to perform a fast estimation of the object size in
9127 * memory, and combine it with aging informations.
9128 *
9129 * Basically swappability = idle-time * log(estimated size)
9130 *
9131 * Bigger objects are preferred over smaller objects, but not
9132 * proportionally, this is why we use the logarithm. This algorithm is
9133 * just a first try and will probably be tuned later. */
9134 static double computeObjectSwappability(robj *o) {
9135 time_t age = server.unixtime - o->vm.atime;
9136 long asize = 0;
9137 list *l;
9138 dict *d;
9139 struct dictEntry *de;
9140 int z;
9141
9142 if (age <= 0) return 0;
9143 switch(o->type) {
9144 case REDIS_STRING:
9145 if (o->encoding != REDIS_ENCODING_RAW) {
9146 asize = sizeof(*o);
9147 } else {
9148 asize = sdslen(o->ptr)+sizeof(*o)+sizeof(long)*2;
9149 }
9150 break;
9151 case REDIS_LIST:
9152 l = o->ptr;
9153 listNode *ln = listFirst(l);
9154
9155 asize = sizeof(list);
9156 if (ln) {
9157 robj *ele = ln->value;
9158 long elesize;
9159
9160 elesize = (ele->encoding == REDIS_ENCODING_RAW) ?
9161 (sizeof(*o)+sdslen(ele->ptr)) :
9162 sizeof(*o);
9163 asize += (sizeof(listNode)+elesize)*listLength(l);
9164 }
9165 break;
9166 case REDIS_SET:
9167 case REDIS_ZSET:
9168 z = (o->type == REDIS_ZSET);
9169 d = z ? ((zset*)o->ptr)->dict : o->ptr;
9170
9171 asize = sizeof(dict)+(sizeof(struct dictEntry*)*dictSlots(d));
9172 if (z) asize += sizeof(zset)-sizeof(dict);
9173 if (dictSize(d)) {
9174 long elesize;
9175 robj *ele;
9176
9177 de = dictGetRandomKey(d);
9178 ele = dictGetEntryKey(de);
9179 elesize = (ele->encoding == REDIS_ENCODING_RAW) ?
9180 (sizeof(*o)+sdslen(ele->ptr)) :
9181 sizeof(*o);
9182 asize += (sizeof(struct dictEntry)+elesize)*dictSize(d);
9183 if (z) asize += sizeof(zskiplistNode)*dictSize(d);
9184 }
9185 break;
9186 case REDIS_HASH:
9187 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
9188 unsigned char *p = zipmapRewind((unsigned char*)o->ptr);
9189 unsigned int len = zipmapLen((unsigned char*)o->ptr);
9190 unsigned int klen, vlen;
9191 unsigned char *key, *val;
9192
9193 if ((p = zipmapNext(p,&key,&klen,&val,&vlen)) == NULL) {
9194 klen = 0;
9195 vlen = 0;
9196 }
9197 asize = len*(klen+vlen+3);
9198 } else if (o->encoding == REDIS_ENCODING_HT) {
9199 d = o->ptr;
9200 asize = sizeof(dict)+(sizeof(struct dictEntry*)*dictSlots(d));
9201 if (dictSize(d)) {
9202 long elesize;
9203 robj *ele;
9204
9205 de = dictGetRandomKey(d);
9206 ele = dictGetEntryKey(de);
9207 elesize = (ele->encoding == REDIS_ENCODING_RAW) ?
9208 (sizeof(*o)+sdslen(ele->ptr)) :
9209 sizeof(*o);
9210 ele = dictGetEntryVal(de);
9211 elesize = (ele->encoding == REDIS_ENCODING_RAW) ?
9212 (sizeof(*o)+sdslen(ele->ptr)) :
9213 sizeof(*o);
9214 asize += (sizeof(struct dictEntry)+elesize)*dictSize(d);
9215 }
9216 }
9217 break;
9218 }
9219 return (double)age*log(1+asize);
9220 }
9221
9222 /* Try to swap an object that's a good candidate for swapping.
9223 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
9224 * to swap any object at all.
9225 *
9226 * If 'usethreaded' is true, Redis will try to swap the object in background
9227 * using I/O threads. */
9228 static int vmSwapOneObject(int usethreads) {
9229 int j, i;
9230 struct dictEntry *best = NULL;
9231 double best_swappability = 0;
9232 redisDb *best_db = NULL;
9233 robj *key, *val;
9234
9235 for (j = 0; j < server.dbnum; j++) {
9236 redisDb *db = server.db+j;
9237 /* Why maxtries is set to 100?
9238 * Because this way (usually) we'll find 1 object even if just 1% - 2%
9239 * are swappable objects */
9240 int maxtries = 100;
9241
9242 if (dictSize(db->dict) == 0) continue;
9243 for (i = 0; i < 5; i++) {
9244 dictEntry *de;
9245 double swappability;
9246
9247 if (maxtries) maxtries--;
9248 de = dictGetRandomKey(db->dict);
9249 key = dictGetEntryKey(de);
9250 val = dictGetEntryVal(de);
9251 /* Only swap objects that are currently in memory.
9252 *
9253 * Also don't swap shared objects if threaded VM is on, as we
9254 * try to ensure that the main thread does not touch the
9255 * object while the I/O thread is using it, but we can't
9256 * control other keys without adding additional mutex. */
9257 if (key->storage != REDIS_VM_MEMORY ||
9258 (server.vm_max_threads != 0 && val->refcount != 1)) {
9259 if (maxtries) i--; /* don't count this try */
9260 continue;
9261 }
9262 swappability = computeObjectSwappability(val);
9263 if (!best || swappability > best_swappability) {
9264 best = de;
9265 best_swappability = swappability;
9266 best_db = db;
9267 }
9268 }
9269 }
9270 if (best == NULL) return REDIS_ERR;
9271 key = dictGetEntryKey(best);
9272 val = dictGetEntryVal(best);
9273
9274 redisLog(REDIS_DEBUG,"Key with best swappability: %s, %f",
9275 key->ptr, best_swappability);
9276
9277 /* Unshare the key if needed */
9278 if (key->refcount > 1) {
9279 robj *newkey = dupStringObject(key);
9280 decrRefCount(key);
9281 key = dictGetEntryKey(best) = newkey;
9282 }
9283 /* Swap it */
9284 if (usethreads) {
9285 vmSwapObjectThreaded(key,val,best_db);
9286 return REDIS_OK;
9287 } else {
9288 if (vmSwapObjectBlocking(key,val) == REDIS_OK) {
9289 dictGetEntryVal(best) = NULL;
9290 return REDIS_OK;
9291 } else {
9292 return REDIS_ERR;
9293 }
9294 }
9295 }
9296
9297 static int vmSwapOneObjectBlocking() {
9298 return vmSwapOneObject(0);
9299 }
9300
9301 static int vmSwapOneObjectThreaded() {
9302 return vmSwapOneObject(1);
9303 }
9304
9305 /* Return true if it's safe to swap out objects in a given moment.
9306 * Basically we don't want to swap objects out while there is a BGSAVE
9307 * or a BGAEOREWRITE running in backgroud. */
9308 static int vmCanSwapOut(void) {
9309 return (server.bgsavechildpid == -1 && server.bgrewritechildpid == -1);
9310 }
9311
9312 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
9313 * and was deleted. Otherwise 0 is returned. */
9314 static int deleteIfSwapped(redisDb *db, robj *key) {
9315 dictEntry *de;
9316 robj *foundkey;
9317
9318 if ((de = dictFind(db->dict,key)) == NULL) return 0;
9319 foundkey = dictGetEntryKey(de);
9320 if (foundkey->storage == REDIS_VM_MEMORY) return 0;
9321 deleteKey(db,key);
9322 return 1;
9323 }
9324
9325 /* =================== Virtual Memory - Threaded I/O ======================= */
9326
9327 static void freeIOJob(iojob *j) {
9328 if ((j->type == REDIS_IOJOB_PREPARE_SWAP ||
9329 j->type == REDIS_IOJOB_DO_SWAP ||
9330 j->type == REDIS_IOJOB_LOAD) && j->val != NULL)
9331 decrRefCount(j->val);
9332 /* We don't decrRefCount the j->key field as we did't incremented
9333 * the count creating IO Jobs. This is because the key field here is
9334 * just used as an indentifier and if a key is removed the Job should
9335 * never be touched again. */
9336 zfree(j);
9337 }
9338
9339 /* Every time a thread finished a Job, it writes a byte into the write side
9340 * of an unix pipe in order to "awake" the main thread, and this function
9341 * is called. */
9342 static void vmThreadedIOCompletedJob(aeEventLoop *el, int fd, void *privdata,
9343 int mask)
9344 {
9345 char buf[1];
9346 int retval, processed = 0, toprocess = -1, trytoswap = 1;
9347 REDIS_NOTUSED(el);
9348 REDIS_NOTUSED(mask);
9349 REDIS_NOTUSED(privdata);
9350
9351 /* For every byte we read in the read side of the pipe, there is one
9352 * I/O job completed to process. */
9353 while((retval = read(fd,buf,1)) == 1) {
9354 iojob *j;
9355 listNode *ln;
9356 robj *key;
9357 struct dictEntry *de;
9358
9359 redisLog(REDIS_DEBUG,"Processing I/O completed job");
9360
9361 /* Get the processed element (the oldest one) */
9362 lockThreadedIO();
9363 assert(listLength(server.io_processed) != 0);
9364 if (toprocess == -1) {
9365 toprocess = (listLength(server.io_processed)*REDIS_MAX_COMPLETED_JOBS_PROCESSED)/100;
9366 if (toprocess <= 0) toprocess = 1;
9367 }
9368 ln = listFirst(server.io_processed);
9369 j = ln->value;
9370 listDelNode(server.io_processed,ln);
9371 unlockThreadedIO();
9372 /* If this job is marked as canceled, just ignore it */
9373 if (j->canceled) {
9374 freeIOJob(j);
9375 continue;
9376 }
9377 /* Post process it in the main thread, as there are things we
9378 * can do just here to avoid race conditions and/or invasive locks */
9379 redisLog(REDIS_DEBUG,"Job %p type: %d, key at %p (%s) refcount: %d\n", (void*) j, j->type, (void*)j->key, (char*)j->key->ptr, j->key->refcount);
9380 de = dictFind(j->db->dict,j->key);
9381 assert(de != NULL);
9382 key = dictGetEntryKey(de);
9383 if (j->type == REDIS_IOJOB_LOAD) {
9384 redisDb *db;
9385
9386 /* Key loaded, bring it at home */
9387 key->storage = REDIS_VM_MEMORY;
9388 key->vm.atime = server.unixtime;
9389 vmMarkPagesFree(key->vm.page,key->vm.usedpages);
9390 redisLog(REDIS_DEBUG, "VM: object %s loaded from disk (threaded)",
9391 (unsigned char*) key->ptr);
9392 server.vm_stats_swapped_objects--;
9393 server.vm_stats_swapins++;
9394 dictGetEntryVal(de) = j->val;
9395 incrRefCount(j->val);
9396 db = j->db;
9397 freeIOJob(j);
9398 /* Handle clients waiting for this key to be loaded. */
9399 handleClientsBlockedOnSwappedKey(db,key);
9400 } else if (j->type == REDIS_IOJOB_PREPARE_SWAP) {
9401 /* Now we know the amount of pages required to swap this object.
9402 * Let's find some space for it, and queue this task again
9403 * rebranded as REDIS_IOJOB_DO_SWAP. */
9404 if (!vmCanSwapOut() ||
9405 vmFindContiguousPages(&j->page,j->pages) == REDIS_ERR)
9406 {
9407 /* Ooops... no space or we can't swap as there is
9408 * a fork()ed Redis trying to save stuff on disk. */
9409 freeIOJob(j);
9410 key->storage = REDIS_VM_MEMORY; /* undo operation */
9411 } else {
9412 /* Note that we need to mark this pages as used now,
9413 * if the job will be canceled, we'll mark them as freed
9414 * again. */
9415 vmMarkPagesUsed(j->page,j->pages);
9416 j->type = REDIS_IOJOB_DO_SWAP;
9417 lockThreadedIO();
9418 queueIOJob(j);
9419 unlockThreadedIO();
9420 }
9421 } else if (j->type == REDIS_IOJOB_DO_SWAP) {
9422 robj *val;
9423
9424 /* Key swapped. We can finally free some memory. */
9425 if (key->storage != REDIS_VM_SWAPPING) {
9426 printf("key->storage: %d\n",key->storage);
9427 printf("key->name: %s\n",(char*)key->ptr);
9428 printf("key->refcount: %d\n",key->refcount);
9429 printf("val: %p\n",(void*)j->val);
9430 printf("val->type: %d\n",j->val->type);
9431 printf("val->ptr: %s\n",(char*)j->val->ptr);
9432 }
9433 redisAssert(key->storage == REDIS_VM_SWAPPING);
9434 val = dictGetEntryVal(de);
9435 key->vm.page = j->page;
9436 key->vm.usedpages = j->pages;
9437 key->storage = REDIS_VM_SWAPPED;
9438 key->vtype = j->val->type;
9439 decrRefCount(val); /* Deallocate the object from memory. */
9440 dictGetEntryVal(de) = NULL;
9441 redisLog(REDIS_DEBUG,
9442 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
9443 (unsigned char*) key->ptr,
9444 (unsigned long long) j->page, (unsigned long long) j->pages);
9445 server.vm_stats_swapped_objects++;
9446 server.vm_stats_swapouts++;
9447 freeIOJob(j);
9448 /* Put a few more swap requests in queue if we are still
9449 * out of memory */
9450 if (trytoswap && vmCanSwapOut() &&
9451 zmalloc_used_memory() > server.vm_max_memory)
9452 {
9453 int more = 1;
9454 while(more) {
9455 lockThreadedIO();
9456 more = listLength(server.io_newjobs) <
9457 (unsigned) server.vm_max_threads;
9458 unlockThreadedIO();
9459 /* Don't waste CPU time if swappable objects are rare. */
9460 if (vmSwapOneObjectThreaded() == REDIS_ERR) {
9461 trytoswap = 0;
9462 break;
9463 }
9464 }
9465 }
9466 }
9467 processed++;
9468 if (processed == toprocess) return;
9469 }
9470 if (retval < 0 && errno != EAGAIN) {
9471 redisLog(REDIS_WARNING,
9472 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
9473 strerror(errno));
9474 }
9475 }
9476
9477 static void lockThreadedIO(void) {
9478 pthread_mutex_lock(&server.io_mutex);
9479 }
9480
9481 static void unlockThreadedIO(void) {
9482 pthread_mutex_unlock(&server.io_mutex);
9483 }
9484
9485 /* Remove the specified object from the threaded I/O queue if still not
9486 * processed, otherwise make sure to flag it as canceled. */
9487 static void vmCancelThreadedIOJob(robj *o) {
9488 list *lists[3] = {
9489 server.io_newjobs, /* 0 */
9490 server.io_processing, /* 1 */
9491 server.io_processed /* 2 */
9492 };
9493 int i;
9494
9495 assert(o->storage == REDIS_VM_LOADING || o->storage == REDIS_VM_SWAPPING);
9496 again:
9497 lockThreadedIO();
9498 /* Search for a matching key in one of the queues */
9499 for (i = 0; i < 3; i++) {
9500 listNode *ln;
9501 listIter li;
9502
9503 listRewind(lists[i],&li);
9504 while ((ln = listNext(&li)) != NULL) {
9505 iojob *job = ln->value;
9506
9507 if (job->canceled) continue; /* Skip this, already canceled. */
9508 if (job->key == o) {
9509 redisLog(REDIS_DEBUG,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
9510 (void*)job, (char*)o->ptr, job->type, i);
9511 /* Mark the pages as free since the swap didn't happened
9512 * or happened but is now discarded. */
9513 if (i != 1 && job->type == REDIS_IOJOB_DO_SWAP)
9514 vmMarkPagesFree(job->page,job->pages);
9515 /* Cancel the job. It depends on the list the job is
9516 * living in. */
9517 switch(i) {
9518 case 0: /* io_newjobs */
9519 /* If the job was yet not processed the best thing to do
9520 * is to remove it from the queue at all */
9521 freeIOJob(job);
9522 listDelNode(lists[i],ln);
9523 break;
9524 case 1: /* io_processing */
9525 /* Oh Shi- the thread is messing with the Job:
9526 *
9527 * Probably it's accessing the object if this is a
9528 * PREPARE_SWAP or DO_SWAP job.
9529 * If it's a LOAD job it may be reading from disk and
9530 * if we don't wait for the job to terminate before to
9531 * cancel it, maybe in a few microseconds data can be
9532 * corrupted in this pages. So the short story is:
9533 *
9534 * Better to wait for the job to move into the
9535 * next queue (processed)... */
9536
9537 /* We try again and again until the job is completed. */
9538 unlockThreadedIO();
9539 /* But let's wait some time for the I/O thread
9540 * to finish with this job. After all this condition
9541 * should be very rare. */
9542 usleep(1);
9543 goto again;
9544 case 2: /* io_processed */
9545 /* The job was already processed, that's easy...
9546 * just mark it as canceled so that we'll ignore it
9547 * when processing completed jobs. */
9548 job->canceled = 1;
9549 break;
9550 }
9551 /* Finally we have to adjust the storage type of the object
9552 * in order to "UNDO" the operaiton. */
9553 if (o->storage == REDIS_VM_LOADING)
9554 o->storage = REDIS_VM_SWAPPED;
9555 else if (o->storage == REDIS_VM_SWAPPING)
9556 o->storage = REDIS_VM_MEMORY;
9557 unlockThreadedIO();
9558 return;
9559 }
9560 }
9561 }
9562 unlockThreadedIO();
9563 assert(1 != 1); /* We should never reach this */
9564 }
9565
9566 static void *IOThreadEntryPoint(void *arg) {
9567 iojob *j;
9568 listNode *ln;
9569 REDIS_NOTUSED(arg);
9570
9571 pthread_detach(pthread_self());
9572 while(1) {
9573 /* Get a new job to process */
9574 lockThreadedIO();
9575 if (listLength(server.io_newjobs) == 0) {
9576 /* No new jobs in queue, exit. */
9577 redisLog(REDIS_DEBUG,"Thread %ld exiting, nothing to do",
9578 (long) pthread_self());
9579 server.io_active_threads--;
9580 unlockThreadedIO();
9581 return NULL;
9582 }
9583 ln = listFirst(server.io_newjobs);
9584 j = ln->value;
9585 listDelNode(server.io_newjobs,ln);
9586 /* Add the job in the processing queue */
9587 j->thread = pthread_self();
9588 listAddNodeTail(server.io_processing,j);
9589 ln = listLast(server.io_processing); /* We use ln later to remove it */
9590 unlockThreadedIO();
9591 redisLog(REDIS_DEBUG,"Thread %ld got a new job (type %d): %p about key '%s'",
9592 (long) pthread_self(), j->type, (void*)j, (char*)j->key->ptr);
9593
9594 /* Process the Job */
9595 if (j->type == REDIS_IOJOB_LOAD) {
9596 j->val = vmReadObjectFromSwap(j->page,j->key->vtype);
9597 } else if (j->type == REDIS_IOJOB_PREPARE_SWAP) {
9598 FILE *fp = fopen("/dev/null","w+");
9599 j->pages = rdbSavedObjectPages(j->val,fp);
9600 fclose(fp);
9601 } else if (j->type == REDIS_IOJOB_DO_SWAP) {
9602 if (vmWriteObjectOnSwap(j->val,j->page) == REDIS_ERR)
9603 j->canceled = 1;
9604 }
9605
9606 /* Done: insert the job into the processed queue */
9607 redisLog(REDIS_DEBUG,"Thread %ld completed the job: %p (key %s)",
9608 (long) pthread_self(), (void*)j, (char*)j->key->ptr);
9609 lockThreadedIO();
9610 listDelNode(server.io_processing,ln);
9611 listAddNodeTail(server.io_processed,j);
9612 unlockThreadedIO();
9613
9614 /* Signal the main thread there is new stuff to process */
9615 assert(write(server.io_ready_pipe_write,"x",1) == 1);
9616 }
9617 return NULL; /* never reached */
9618 }
9619
9620 static void spawnIOThread(void) {
9621 pthread_t thread;
9622 sigset_t mask, omask;
9623 int err;
9624
9625 sigemptyset(&mask);
9626 sigaddset(&mask,SIGCHLD);
9627 sigaddset(&mask,SIGHUP);
9628 sigaddset(&mask,SIGPIPE);
9629 pthread_sigmask(SIG_SETMASK, &mask, &omask);
9630 while ((err = pthread_create(&thread,&server.io_threads_attr,IOThreadEntryPoint,NULL)) != 0) {
9631 redisLog(REDIS_WARNING,"Unable to spawn an I/O thread: %s",
9632 strerror(err));
9633 usleep(1000000);
9634 }
9635 pthread_sigmask(SIG_SETMASK, &omask, NULL);
9636 server.io_active_threads++;
9637 }
9638
9639 /* We need to wait for the last thread to exit before we are able to
9640 * fork() in order to BGSAVE or BGREWRITEAOF. */
9641 static void waitEmptyIOJobsQueue(void) {
9642 while(1) {
9643 int io_processed_len;
9644
9645 lockThreadedIO();
9646 if (listLength(server.io_newjobs) == 0 &&
9647 listLength(server.io_processing) == 0 &&
9648 server.io_active_threads == 0)
9649 {
9650 unlockThreadedIO();
9651 return;
9652 }
9653 /* While waiting for empty jobs queue condition we post-process some
9654 * finshed job, as I/O threads may be hanging trying to write against
9655 * the io_ready_pipe_write FD but there are so much pending jobs that
9656 * it's blocking. */
9657 io_processed_len = listLength(server.io_processed);
9658 unlockThreadedIO();
9659 if (io_processed_len) {
9660 vmThreadedIOCompletedJob(NULL,server.io_ready_pipe_read,NULL,0);
9661 usleep(1000); /* 1 millisecond */
9662 } else {
9663 usleep(10000); /* 10 milliseconds */
9664 }
9665 }
9666 }
9667
9668 static void vmReopenSwapFile(void) {
9669 /* Note: we don't close the old one as we are in the child process
9670 * and don't want to mess at all with the original file object. */
9671 server.vm_fp = fopen(server.vm_swap_file,"r+b");
9672 if (server.vm_fp == NULL) {
9673 redisLog(REDIS_WARNING,"Can't re-open the VM swap file: %s. Exiting.",
9674 server.vm_swap_file);
9675 _exit(1);
9676 }
9677 server.vm_fd = fileno(server.vm_fp);
9678 }
9679
9680 /* This function must be called while with threaded IO locked */
9681 static void queueIOJob(iojob *j) {
9682 redisLog(REDIS_DEBUG,"Queued IO Job %p type %d about key '%s'\n",
9683 (void*)j, j->type, (char*)j->key->ptr);
9684 listAddNodeTail(server.io_newjobs,j);
9685 if (server.io_active_threads < server.vm_max_threads)
9686 spawnIOThread();
9687 }
9688
9689 static int vmSwapObjectThreaded(robj *key, robj *val, redisDb *db) {
9690 iojob *j;
9691
9692 assert(key->storage == REDIS_VM_MEMORY);
9693 assert(key->refcount == 1);
9694
9695 j = zmalloc(sizeof(*j));
9696 j->type = REDIS_IOJOB_PREPARE_SWAP;
9697 j->db = db;
9698 j->key = key;
9699 j->val = val;
9700 incrRefCount(val);
9701 j->canceled = 0;
9702 j->thread = (pthread_t) -1;
9703 key->storage = REDIS_VM_SWAPPING;
9704
9705 lockThreadedIO();
9706 queueIOJob(j);
9707 unlockThreadedIO();
9708 return REDIS_OK;
9709 }
9710
9711 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
9712
9713 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
9714 * If there is not already a job loading the key, it is craeted.
9715 * The key is added to the io_keys list in the client structure, and also
9716 * in the hash table mapping swapped keys to waiting clients, that is,
9717 * server.io_waited_keys. */
9718 static int waitForSwappedKey(redisClient *c, robj *key) {
9719 struct dictEntry *de;
9720 robj *o;
9721 list *l;
9722
9723 /* If the key does not exist or is already in RAM we don't need to
9724 * block the client at all. */
9725 de = dictFind(c->db->dict,key);
9726 if (de == NULL) return 0;
9727 o = dictGetEntryKey(de);
9728 if (o->storage == REDIS_VM_MEMORY) {
9729 return 0;
9730 } else if (o->storage == REDIS_VM_SWAPPING) {
9731 /* We were swapping the key, undo it! */
9732 vmCancelThreadedIOJob(o);
9733 return 0;
9734 }
9735
9736 /* OK: the key is either swapped, or being loaded just now. */
9737
9738 /* Add the key to the list of keys this client is waiting for.
9739 * This maps clients to keys they are waiting for. */
9740 listAddNodeTail(c->io_keys,key);
9741 incrRefCount(key);
9742
9743 /* Add the client to the swapped keys => clients waiting map. */
9744 de = dictFind(c->db->io_keys,key);
9745 if (de == NULL) {
9746 int retval;
9747
9748 /* For every key we take a list of clients blocked for it */
9749 l = listCreate();
9750 retval = dictAdd(c->db->io_keys,key,l);
9751 incrRefCount(key);
9752 assert(retval == DICT_OK);
9753 } else {
9754 l = dictGetEntryVal(de);
9755 }
9756 listAddNodeTail(l,c);
9757
9758 /* Are we already loading the key from disk? If not create a job */
9759 if (o->storage == REDIS_VM_SWAPPED) {
9760 iojob *j;
9761
9762 o->storage = REDIS_VM_LOADING;
9763 j = zmalloc(sizeof(*j));
9764 j->type = REDIS_IOJOB_LOAD;
9765 j->db = c->db;
9766 j->key = o;
9767 j->key->vtype = o->vtype;
9768 j->page = o->vm.page;
9769 j->val = NULL;
9770 j->canceled = 0;
9771 j->thread = (pthread_t) -1;
9772 lockThreadedIO();
9773 queueIOJob(j);
9774 unlockThreadedIO();
9775 }
9776 return 1;
9777 }
9778
9779 /* Preload keys for any command with first, last and step values for
9780 * the command keys prototype, as defined in the command table. */
9781 static void waitForMultipleSwappedKeys(redisClient *c, struct redisCommand *cmd, int argc, robj **argv) {
9782 int j, last;
9783 if (cmd->vm_firstkey == 0) return;
9784 last = cmd->vm_lastkey;
9785 if (last < 0) last = argc+last;
9786 for (j = cmd->vm_firstkey; j <= last; j += cmd->vm_keystep) {
9787 redisAssert(j < argc);
9788 waitForSwappedKey(c,argv[j]);
9789 }
9790 }
9791
9792 /* Preload keys needed for the ZUNIONSTORE and ZINTERSTORE commands.
9793 * Note that the number of keys to preload is user-defined, so we need to
9794 * apply a sanity check against argc. */
9795 static void zunionInterBlockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd, int argc, robj **argv) {
9796 int i, num;
9797 REDIS_NOTUSED(cmd);
9798
9799 num = atoi(argv[2]->ptr);
9800 if (num > (argc-3)) return;
9801 for (i = 0; i < num; i++) {
9802 waitForSwappedKey(c,argv[3+i]);
9803 }
9804 }
9805
9806 /* Preload keys needed to execute the entire MULTI/EXEC block.
9807 *
9808 * This function is called by blockClientOnSwappedKeys when EXEC is issued,
9809 * and will block the client when any command requires a swapped out value. */
9810 static void execBlockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd, int argc, robj **argv) {
9811 int i, margc;
9812 struct redisCommand *mcmd;
9813 robj **margv;
9814 REDIS_NOTUSED(cmd);
9815 REDIS_NOTUSED(argc);
9816 REDIS_NOTUSED(argv);
9817
9818 if (!(c->flags & REDIS_MULTI)) return;
9819 for (i = 0; i < c->mstate.count; i++) {
9820 mcmd = c->mstate.commands[i].cmd;
9821 margc = c->mstate.commands[i].argc;
9822 margv = c->mstate.commands[i].argv;
9823
9824 if (mcmd->vm_preload_proc != NULL) {
9825 mcmd->vm_preload_proc(c,mcmd,margc,margv);
9826 } else {
9827 waitForMultipleSwappedKeys(c,mcmd,margc,margv);
9828 }
9829 }
9830 }
9831
9832 /* Is this client attempting to run a command against swapped keys?
9833 * If so, block it ASAP, load the keys in background, then resume it.
9834 *
9835 * The important idea about this function is that it can fail! If keys will
9836 * still be swapped when the client is resumed, this key lookups will
9837 * just block loading keys from disk. In practical terms this should only
9838 * happen with SORT BY command or if there is a bug in this function.
9839 *
9840 * Return 1 if the client is marked as blocked, 0 if the client can
9841 * continue as the keys it is going to access appear to be in memory. */
9842 static int blockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd) {
9843 if (cmd->vm_preload_proc != NULL) {
9844 cmd->vm_preload_proc(c,cmd,c->argc,c->argv);
9845 } else {
9846 waitForMultipleSwappedKeys(c,cmd,c->argc,c->argv);
9847 }
9848
9849 /* If the client was blocked for at least one key, mark it as blocked. */
9850 if (listLength(c->io_keys)) {
9851 c->flags |= REDIS_IO_WAIT;
9852 aeDeleteFileEvent(server.el,c->fd,AE_READABLE);
9853 server.vm_blocked_clients++;
9854 return 1;
9855 } else {
9856 return 0;
9857 }
9858 }
9859
9860 /* Remove the 'key' from the list of blocked keys for a given client.
9861 *
9862 * The function returns 1 when there are no longer blocking keys after
9863 * the current one was removed (and the client can be unblocked). */
9864 static int dontWaitForSwappedKey(redisClient *c, robj *key) {
9865 list *l;
9866 listNode *ln;
9867 listIter li;
9868 struct dictEntry *de;
9869
9870 /* Remove the key from the list of keys this client is waiting for. */
9871 listRewind(c->io_keys,&li);
9872 while ((ln = listNext(&li)) != NULL) {
9873 if (equalStringObjects(ln->value,key)) {
9874 listDelNode(c->io_keys,ln);
9875 break;
9876 }
9877 }
9878 assert(ln != NULL);
9879
9880 /* Remove the client form the key => waiting clients map. */
9881 de = dictFind(c->db->io_keys,key);
9882 assert(de != NULL);
9883 l = dictGetEntryVal(de);
9884 ln = listSearchKey(l,c);
9885 assert(ln != NULL);
9886 listDelNode(l,ln);
9887 if (listLength(l) == 0)
9888 dictDelete(c->db->io_keys,key);
9889
9890 return listLength(c->io_keys) == 0;
9891 }
9892
9893 static void handleClientsBlockedOnSwappedKey(redisDb *db, robj *key) {
9894 struct dictEntry *de;
9895 list *l;
9896 listNode *ln;
9897 int len;
9898
9899 de = dictFind(db->io_keys,key);
9900 if (!de) return;
9901
9902 l = dictGetEntryVal(de);
9903 len = listLength(l);
9904 /* Note: we can't use something like while(listLength(l)) as the list
9905 * can be freed by the calling function when we remove the last element. */
9906 while (len--) {
9907 ln = listFirst(l);
9908 redisClient *c = ln->value;
9909
9910 if (dontWaitForSwappedKey(c,key)) {
9911 /* Put the client in the list of clients ready to go as we
9912 * loaded all the keys about it. */
9913 listAddNodeTail(server.io_ready_clients,c);
9914 }
9915 }
9916 }
9917
9918 /* =========================== Remote Configuration ========================= */
9919
9920 static void configSetCommand(redisClient *c) {
9921 robj *o = getDecodedObject(c->argv[3]);
9922 long long ll;
9923
9924 if (!strcasecmp(c->argv[2]->ptr,"dbfilename")) {
9925 zfree(server.dbfilename);
9926 server.dbfilename = zstrdup(o->ptr);
9927 } else if (!strcasecmp(c->argv[2]->ptr,"requirepass")) {
9928 zfree(server.requirepass);
9929 server.requirepass = zstrdup(o->ptr);
9930 } else if (!strcasecmp(c->argv[2]->ptr,"masterauth")) {
9931 zfree(server.masterauth);
9932 server.masterauth = zstrdup(o->ptr);
9933 } else if (!strcasecmp(c->argv[2]->ptr,"maxmemory")) {
9934 if (getLongLongFromObject(o,&ll) == REDIS_ERR ||
9935 ll < 0) goto badfmt;
9936 server.maxmemory = ll;
9937 } else if (!strcasecmp(c->argv[2]->ptr,"timeout")) {
9938 if (getLongLongFromObject(o,&ll) == REDIS_ERR ||
9939 ll < 0 || ll > LONG_MAX) goto badfmt;
9940 server.maxidletime = ll;
9941 } else if (!strcasecmp(c->argv[2]->ptr,"appendfsync")) {
9942 if (!strcasecmp(o->ptr,"no")) {
9943 server.appendfsync = APPENDFSYNC_NO;
9944 } else if (!strcasecmp(o->ptr,"everysec")) {
9945 server.appendfsync = APPENDFSYNC_EVERYSEC;
9946 } else if (!strcasecmp(o->ptr,"always")) {
9947 server.appendfsync = APPENDFSYNC_ALWAYS;
9948 } else {
9949 goto badfmt;
9950 }
9951 } else if (!strcasecmp(c->argv[2]->ptr,"appendonly")) {
9952 int old = server.appendonly;
9953 int new = yesnotoi(o->ptr);
9954
9955 if (new == -1) goto badfmt;
9956 if (old != new) {
9957 if (new == 0) {
9958 stopAppendOnly();
9959 } else {
9960 if (startAppendOnly() == REDIS_ERR) {
9961 addReplySds(c,sdscatprintf(sdsempty(),
9962 "-ERR Unable to turn on AOF. Check server logs.\r\n"));
9963 decrRefCount(o);
9964 return;
9965 }
9966 }
9967 }
9968 } else if (!strcasecmp(c->argv[2]->ptr,"save")) {
9969 int vlen, j;
9970 sds *v = sdssplitlen(o->ptr,sdslen(o->ptr)," ",1,&vlen);
9971
9972 /* Perform sanity check before setting the new config:
9973 * - Even number of args
9974 * - Seconds >= 1, changes >= 0 */
9975 if (vlen & 1) {
9976 sdsfreesplitres(v,vlen);
9977 goto badfmt;
9978 }
9979 for (j = 0; j < vlen; j++) {
9980 char *eptr;
9981 long val;
9982
9983 val = strtoll(v[j], &eptr, 10);
9984 if (eptr[0] != '\0' ||
9985 ((j & 1) == 0 && val < 1) ||
9986 ((j & 1) == 1 && val < 0)) {
9987 sdsfreesplitres(v,vlen);
9988 goto badfmt;
9989 }
9990 }
9991 /* Finally set the new config */
9992 resetServerSaveParams();
9993 for (j = 0; j < vlen; j += 2) {
9994 time_t seconds;
9995 int changes;
9996
9997 seconds = strtoll(v[j],NULL,10);
9998 changes = strtoll(v[j+1],NULL,10);
9999 appendServerSaveParams(seconds, changes);
10000 }
10001 sdsfreesplitres(v,vlen);
10002 } else {
10003 addReplySds(c,sdscatprintf(sdsempty(),
10004 "-ERR not supported CONFIG parameter %s\r\n",
10005 (char*)c->argv[2]->ptr));
10006 decrRefCount(o);
10007 return;
10008 }
10009 decrRefCount(o);
10010 addReply(c,shared.ok);
10011 return;
10012
10013 badfmt: /* Bad format errors */
10014 addReplySds(c,sdscatprintf(sdsempty(),
10015 "-ERR invalid argument '%s' for CONFIG SET '%s'\r\n",
10016 (char*)o->ptr,
10017 (char*)c->argv[2]->ptr));
10018 decrRefCount(o);
10019 }
10020
10021 static void configGetCommand(redisClient *c) {
10022 robj *o = getDecodedObject(c->argv[2]);
10023 robj *lenobj = createObject(REDIS_STRING,NULL);
10024 char *pattern = o->ptr;
10025 int matches = 0;
10026
10027 addReply(c,lenobj);
10028 decrRefCount(lenobj);
10029
10030 if (stringmatch(pattern,"dbfilename",0)) {
10031 addReplyBulkCString(c,"dbfilename");
10032 addReplyBulkCString(c,server.dbfilename);
10033 matches++;
10034 }
10035 if (stringmatch(pattern,"requirepass",0)) {
10036 addReplyBulkCString(c,"requirepass");
10037 addReplyBulkCString(c,server.requirepass);
10038 matches++;
10039 }
10040 if (stringmatch(pattern,"masterauth",0)) {
10041 addReplyBulkCString(c,"masterauth");
10042 addReplyBulkCString(c,server.masterauth);
10043 matches++;
10044 }
10045 if (stringmatch(pattern,"maxmemory",0)) {
10046 char buf[128];
10047
10048 ll2string(buf,128,server.maxmemory);
10049 addReplyBulkCString(c,"maxmemory");
10050 addReplyBulkCString(c,buf);
10051 matches++;
10052 }
10053 if (stringmatch(pattern,"timeout",0)) {
10054 char buf[128];
10055
10056 ll2string(buf,128,server.maxidletime);
10057 addReplyBulkCString(c,"timeout");
10058 addReplyBulkCString(c,buf);
10059 matches++;
10060 }
10061 if (stringmatch(pattern,"appendonly",0)) {
10062 addReplyBulkCString(c,"appendonly");
10063 addReplyBulkCString(c,server.appendonly ? "yes" : "no");
10064 matches++;
10065 }
10066 if (stringmatch(pattern,"appendfsync",0)) {
10067 char *policy;
10068
10069 switch(server.appendfsync) {
10070 case APPENDFSYNC_NO: policy = "no"; break;
10071 case APPENDFSYNC_EVERYSEC: policy = "everysec"; break;
10072 case APPENDFSYNC_ALWAYS: policy = "always"; break;
10073 default: policy = "unknown"; break; /* too harmless to panic */
10074 }
10075 addReplyBulkCString(c,"appendfsync");
10076 addReplyBulkCString(c,policy);
10077 matches++;
10078 }
10079 if (stringmatch(pattern,"save",0)) {
10080 sds buf = sdsempty();
10081 int j;
10082
10083 for (j = 0; j < server.saveparamslen; j++) {
10084 buf = sdscatprintf(buf,"%ld %d",
10085 server.saveparams[j].seconds,
10086 server.saveparams[j].changes);
10087 if (j != server.saveparamslen-1)
10088 buf = sdscatlen(buf," ",1);
10089 }
10090 addReplyBulkCString(c,"save");
10091 addReplyBulkCString(c,buf);
10092 sdsfree(buf);
10093 matches++;
10094 }
10095 decrRefCount(o);
10096 lenobj->ptr = sdscatprintf(sdsempty(),"*%d\r\n",matches*2);
10097 }
10098
10099 static void configCommand(redisClient *c) {
10100 if (!strcasecmp(c->argv[1]->ptr,"set")) {
10101 if (c->argc != 4) goto badarity;
10102 configSetCommand(c);
10103 } else if (!strcasecmp(c->argv[1]->ptr,"get")) {
10104 if (c->argc != 3) goto badarity;
10105 configGetCommand(c);
10106 } else if (!strcasecmp(c->argv[1]->ptr,"resetstat")) {
10107 if (c->argc != 2) goto badarity;
10108 server.stat_numcommands = 0;
10109 server.stat_numconnections = 0;
10110 server.stat_expiredkeys = 0;
10111 server.stat_starttime = time(NULL);
10112 addReply(c,shared.ok);
10113 } else {
10114 addReplySds(c,sdscatprintf(sdsempty(),
10115 "-ERR CONFIG subcommand must be one of GET, SET, RESETSTAT\r\n"));
10116 }
10117 return;
10118
10119 badarity:
10120 addReplySds(c,sdscatprintf(sdsempty(),
10121 "-ERR Wrong number of arguments for CONFIG %s\r\n",
10122 (char*) c->argv[1]->ptr));
10123 }
10124
10125 /* =========================== Pubsub implementation ======================== */
10126
10127 static void freePubsubPattern(void *p) {
10128 pubsubPattern *pat = p;
10129
10130 decrRefCount(pat->pattern);
10131 zfree(pat);
10132 }
10133
10134 static int listMatchPubsubPattern(void *a, void *b) {
10135 pubsubPattern *pa = a, *pb = b;
10136
10137 return (pa->client == pb->client) &&
10138 (equalStringObjects(pa->pattern,pb->pattern));
10139 }
10140
10141 /* Subscribe a client to a channel. Returns 1 if the operation succeeded, or
10142 * 0 if the client was already subscribed to that channel. */
10143 static int pubsubSubscribeChannel(redisClient *c, robj *channel) {
10144 struct dictEntry *de;
10145 list *clients = NULL;
10146 int retval = 0;
10147
10148 /* Add the channel to the client -> channels hash table */
10149 if (dictAdd(c->pubsub_channels,channel,NULL) == DICT_OK) {
10150 retval = 1;
10151 incrRefCount(channel);
10152 /* Add the client to the channel -> list of clients hash table */
10153 de = dictFind(server.pubsub_channels,channel);
10154 if (de == NULL) {
10155 clients = listCreate();
10156 dictAdd(server.pubsub_channels,channel,clients);
10157 incrRefCount(channel);
10158 } else {
10159 clients = dictGetEntryVal(de);
10160 }
10161 listAddNodeTail(clients,c);
10162 }
10163 /* Notify the client */
10164 addReply(c,shared.mbulk3);
10165 addReply(c,shared.subscribebulk);
10166 addReplyBulk(c,channel);
10167 addReplyLongLong(c,dictSize(c->pubsub_channels)+listLength(c->pubsub_patterns));
10168 return retval;
10169 }
10170
10171 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
10172 * 0 if the client was not subscribed to the specified channel. */
10173 static int pubsubUnsubscribeChannel(redisClient *c, robj *channel, int notify) {
10174 struct dictEntry *de;
10175 list *clients;
10176 listNode *ln;
10177 int retval = 0;
10178
10179 /* Remove the channel from the client -> channels hash table */
10180 incrRefCount(channel); /* channel may be just a pointer to the same object
10181 we have in the hash tables. Protect it... */
10182 if (dictDelete(c->pubsub_channels,channel) == DICT_OK) {
10183 retval = 1;
10184 /* Remove the client from the channel -> clients list hash table */
10185 de = dictFind(server.pubsub_channels,channel);
10186 assert(de != NULL);
10187 clients = dictGetEntryVal(de);
10188 ln = listSearchKey(clients,c);
10189 assert(ln != NULL);
10190 listDelNode(clients,ln);
10191 if (listLength(clients) == 0) {
10192 /* Free the list and associated hash entry at all if this was
10193 * the latest client, so that it will be possible to abuse
10194 * Redis PUBSUB creating millions of channels. */
10195 dictDelete(server.pubsub_channels,channel);
10196 }
10197 }
10198 /* Notify the client */
10199 if (notify) {
10200 addReply(c,shared.mbulk3);
10201 addReply(c,shared.unsubscribebulk);
10202 addReplyBulk(c,channel);
10203 addReplyLongLong(c,dictSize(c->pubsub_channels)+
10204 listLength(c->pubsub_patterns));
10205
10206 }
10207 decrRefCount(channel); /* it is finally safe to release it */
10208 return retval;
10209 }
10210
10211 /* Subscribe a client to a pattern. Returns 1 if the operation succeeded, or 0 if the clinet was already subscribed to that pattern. */
10212 static int pubsubSubscribePattern(redisClient *c, robj *pattern) {
10213 int retval = 0;
10214
10215 if (listSearchKey(c->pubsub_patterns,pattern) == NULL) {
10216 retval = 1;
10217 pubsubPattern *pat;
10218 listAddNodeTail(c->pubsub_patterns,pattern);
10219 incrRefCount(pattern);
10220 pat = zmalloc(sizeof(*pat));
10221 pat->pattern = getDecodedObject(pattern);
10222 pat->client = c;
10223 listAddNodeTail(server.pubsub_patterns,pat);
10224 }
10225 /* Notify the client */
10226 addReply(c,shared.mbulk3);
10227 addReply(c,shared.psubscribebulk);
10228 addReplyBulk(c,pattern);
10229 addReplyLongLong(c,dictSize(c->pubsub_channels)+listLength(c->pubsub_patterns));
10230 return retval;
10231 }
10232
10233 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
10234 * 0 if the client was not subscribed to the specified channel. */
10235 static int pubsubUnsubscribePattern(redisClient *c, robj *pattern, int notify) {
10236 listNode *ln;
10237 pubsubPattern pat;
10238 int retval = 0;
10239
10240 incrRefCount(pattern); /* Protect the object. May be the same we remove */
10241 if ((ln = listSearchKey(c->pubsub_patterns,pattern)) != NULL) {
10242 retval = 1;
10243 listDelNode(c->pubsub_patterns,ln);
10244 pat.client = c;
10245 pat.pattern = pattern;
10246 ln = listSearchKey(server.pubsub_patterns,&pat);
10247 listDelNode(server.pubsub_patterns,ln);
10248 }
10249 /* Notify the client */
10250 if (notify) {
10251 addReply(c,shared.mbulk3);
10252 addReply(c,shared.punsubscribebulk);
10253 addReplyBulk(c,pattern);
10254 addReplyLongLong(c,dictSize(c->pubsub_channels)+
10255 listLength(c->pubsub_patterns));
10256 }
10257 decrRefCount(pattern);
10258 return retval;
10259 }
10260
10261 /* Unsubscribe from all the channels. Return the number of channels the
10262 * client was subscribed from. */
10263 static int pubsubUnsubscribeAllChannels(redisClient *c, int notify) {
10264 dictIterator *di = dictGetIterator(c->pubsub_channels);
10265 dictEntry *de;
10266 int count = 0;
10267
10268 while((de = dictNext(di)) != NULL) {
10269 robj *channel = dictGetEntryKey(de);
10270
10271 count += pubsubUnsubscribeChannel(c,channel,notify);
10272 }
10273 dictReleaseIterator(di);
10274 return count;
10275 }
10276
10277 /* Unsubscribe from all the patterns. Return the number of patterns the
10278 * client was subscribed from. */
10279 static int pubsubUnsubscribeAllPatterns(redisClient *c, int notify) {
10280 listNode *ln;
10281 listIter li;
10282 int count = 0;
10283
10284 listRewind(c->pubsub_patterns,&li);
10285 while ((ln = listNext(&li)) != NULL) {
10286 robj *pattern = ln->value;
10287
10288 count += pubsubUnsubscribePattern(c,pattern,notify);
10289 }
10290 return count;
10291 }
10292
10293 /* Publish a message */
10294 static int pubsubPublishMessage(robj *channel, robj *message) {
10295 int receivers = 0;
10296 struct dictEntry *de;
10297 listNode *ln;
10298 listIter li;
10299
10300 /* Send to clients listening for that channel */
10301 de = dictFind(server.pubsub_channels,channel);
10302 if (de) {
10303 list *list = dictGetEntryVal(de);
10304 listNode *ln;
10305 listIter li;
10306
10307 listRewind(list,&li);
10308 while ((ln = listNext(&li)) != NULL) {
10309 redisClient *c = ln->value;
10310
10311 addReply(c,shared.mbulk3);
10312 addReply(c,shared.messagebulk);
10313 addReplyBulk(c,channel);
10314 addReplyBulk(c,message);
10315 receivers++;
10316 }
10317 }
10318 /* Send to clients listening to matching channels */
10319 if (listLength(server.pubsub_patterns)) {
10320 listRewind(server.pubsub_patterns,&li);
10321 channel = getDecodedObject(channel);
10322 while ((ln = listNext(&li)) != NULL) {
10323 pubsubPattern *pat = ln->value;
10324
10325 if (stringmatchlen((char*)pat->pattern->ptr,
10326 sdslen(pat->pattern->ptr),
10327 (char*)channel->ptr,
10328 sdslen(channel->ptr),0)) {
10329 addReply(pat->client,shared.mbulk4);
10330 addReply(pat->client,shared.pmessagebulk);
10331 addReplyBulk(pat->client,pat->pattern);
10332 addReplyBulk(pat->client,channel);
10333 addReplyBulk(pat->client,message);
10334 receivers++;
10335 }
10336 }
10337 decrRefCount(channel);
10338 }
10339 return receivers;
10340 }
10341
10342 static void subscribeCommand(redisClient *c) {
10343 int j;
10344
10345 for (j = 1; j < c->argc; j++)
10346 pubsubSubscribeChannel(c,c->argv[j]);
10347 }
10348
10349 static void unsubscribeCommand(redisClient *c) {
10350 if (c->argc == 1) {
10351 pubsubUnsubscribeAllChannels(c,1);
10352 return;
10353 } else {
10354 int j;
10355
10356 for (j = 1; j < c->argc; j++)
10357 pubsubUnsubscribeChannel(c,c->argv[j],1);
10358 }
10359 }
10360
10361 static void psubscribeCommand(redisClient *c) {
10362 int j;
10363
10364 for (j = 1; j < c->argc; j++)
10365 pubsubSubscribePattern(c,c->argv[j]);
10366 }
10367
10368 static void punsubscribeCommand(redisClient *c) {
10369 if (c->argc == 1) {
10370 pubsubUnsubscribeAllPatterns(c,1);
10371 return;
10372 } else {
10373 int j;
10374
10375 for (j = 1; j < c->argc; j++)
10376 pubsubUnsubscribePattern(c,c->argv[j],1);
10377 }
10378 }
10379
10380 static void publishCommand(redisClient *c) {
10381 int receivers = pubsubPublishMessage(c->argv[1],c->argv[2]);
10382 addReplyLongLong(c,receivers);
10383 }
10384
10385 /* ===================== WATCH (CAS alike for MULTI/EXEC) ===================
10386 *
10387 * The implementation uses a per-DB hash table mapping keys to list of clients
10388 * WATCHing those keys, so that given a key that is going to be modified
10389 * we can mark all the associated clients as dirty.
10390 *
10391 * Also every client contains a list of WATCHed keys so that's possible to
10392 * un-watch such keys when the client is freed or when UNWATCH is called. */
10393
10394 /* In the client->watched_keys list we need to use watchedKey structures
10395 * as in order to identify a key in Redis we need both the key name and the
10396 * DB */
10397 typedef struct watchedKey {
10398 robj *key;
10399 redisDb *db;
10400 } watchedKey;
10401
10402 /* Watch for the specified key */
10403 static void watchForKey(redisClient *c, robj *key) {
10404 list *clients = NULL;
10405 listIter li;
10406 listNode *ln;
10407 watchedKey *wk;
10408
10409 /* Check if we are already watching for this key */
10410 listRewind(c->watched_keys,&li);
10411 while((ln = listNext(&li))) {
10412 wk = listNodeValue(ln);
10413 if (wk->db == c->db && equalStringObjects(key,wk->key))
10414 return; /* Key already watched */
10415 }
10416 /* This key is not already watched in this DB. Let's add it */
10417 clients = dictFetchValue(c->db->watched_keys,key);
10418 if (!clients) {
10419 clients = listCreate();
10420 dictAdd(c->db->watched_keys,key,clients);
10421 incrRefCount(key);
10422 }
10423 listAddNodeTail(clients,c);
10424 /* Add the new key to the lits of keys watched by this client */
10425 wk = zmalloc(sizeof(*wk));
10426 wk->key = key;
10427 wk->db = c->db;
10428 incrRefCount(key);
10429 listAddNodeTail(c->watched_keys,wk);
10430 }
10431
10432 /* Unwatch all the keys watched by this client. To clean the EXEC dirty
10433 * flag is up to the caller. */
10434 static void unwatchAllKeys(redisClient *c) {
10435 listIter li;
10436 listNode *ln;
10437
10438 if (listLength(c->watched_keys) == 0) return;
10439 listRewind(c->watched_keys,&li);
10440 while((ln = listNext(&li))) {
10441 list *clients;
10442 watchedKey *wk;
10443
10444 /* Lookup the watched key -> clients list and remove the client
10445 * from the list */
10446 wk = listNodeValue(ln);
10447 clients = dictFetchValue(wk->db->watched_keys, wk->key);
10448 assert(clients != NULL);
10449 listDelNode(clients,listSearchKey(clients,c));
10450 /* Kill the entry at all if this was the only client */
10451 if (listLength(clients) == 0)
10452 dictDelete(wk->db->watched_keys, wk->key);
10453 /* Remove this watched key from the client->watched list */
10454 listDelNode(c->watched_keys,ln);
10455 decrRefCount(wk->key);
10456 zfree(wk);
10457 }
10458 }
10459
10460 /* "Touch" a key, so that if this key is being WATCHed by soem client the
10461 * next EXEC will fail. */
10462 static void touchWatchedKey(redisDb *db, robj *key) {
10463 list *clients;
10464 listIter li;
10465 listNode *ln;
10466
10467 if (dictSize(db->watched_keys) == 0) return;
10468 clients = dictFetchValue(db->watched_keys, key);
10469 if (!clients) return;
10470
10471 /* Mark all the clients watching this key as REDIS_DIRTY_CAS */
10472 /* Check if we are already watching for this key */
10473 listRewind(clients,&li);
10474 while((ln = listNext(&li))) {
10475 redisClient *c = listNodeValue(ln);
10476
10477 c->flags |= REDIS_DIRTY_CAS;
10478 }
10479 }
10480
10481 /* On FLUSHDB or FLUSHALL all the watched keys that are present before the
10482 * flush but will be deleted as effect of the flushing operation should
10483 * be touched. "dbid" is the DB that's getting the flush. -1 if it is
10484 * a FLUSHALL operation (all the DBs flushed). */
10485 static void touchWatchedKeysOnFlush(int dbid) {
10486 listIter li1, li2;
10487 listNode *ln;
10488
10489 /* For every client, check all the waited keys */
10490 listRewind(server.clients,&li1);
10491 while((ln = listNext(&li1))) {
10492 redisClient *c = listNodeValue(ln);
10493 listRewind(c->watched_keys,&li2);
10494 while((ln = listNext(&li2))) {
10495 watchedKey *wk = listNodeValue(ln);
10496
10497 /* For every watched key matching the specified DB, if the
10498 * key exists, mark the client as dirty, as the key will be
10499 * removed. */
10500 if (dbid == -1 || wk->db->id == dbid) {
10501 if (dictFind(wk->db->dict, wk->key) != NULL)
10502 c->flags |= REDIS_DIRTY_CAS;
10503 }
10504 }
10505 }
10506 }
10507
10508 static void watchCommand(redisClient *c) {
10509 int j;
10510
10511 for (j = 1; j < c->argc; j++)
10512 watchForKey(c,c->argv[j]);
10513 addReply(c,shared.ok);
10514 }
10515
10516 static void unwatchCommand(redisClient *c) {
10517 unwatchAllKeys(c);
10518 c->flags &= (~REDIS_DIRTY_CAS);
10519 addReply(c,shared.ok);
10520 }
10521
10522 /* ================================= Debugging ============================== */
10523
10524 /* Compute the sha1 of string at 's' with 'len' bytes long.
10525 * The SHA1 is then xored againt the string pointed by digest.
10526 * Since xor is commutative, this operation is used in order to
10527 * "add" digests relative to unordered elements.
10528 *
10529 * So digest(a,b,c,d) will be the same of digest(b,a,c,d) */
10530 static void xorDigest(unsigned char *digest, void *ptr, size_t len) {
10531 SHA1_CTX ctx;
10532 unsigned char hash[20], *s = ptr;
10533 int j;
10534
10535 SHA1Init(&ctx);
10536 SHA1Update(&ctx,s,len);
10537 SHA1Final(hash,&ctx);
10538
10539 for (j = 0; j < 20; j++)
10540 digest[j] ^= hash[j];
10541 }
10542
10543 static void xorObjectDigest(unsigned char *digest, robj *o) {
10544 o = getDecodedObject(o);
10545 xorDigest(digest,o->ptr,sdslen(o->ptr));
10546 decrRefCount(o);
10547 }
10548
10549 /* This function instead of just computing the SHA1 and xoring it
10550 * against diget, also perform the digest of "digest" itself and
10551 * replace the old value with the new one.
10552 *
10553 * So the final digest will be:
10554 *
10555 * digest = SHA1(digest xor SHA1(data))
10556 *
10557 * This function is used every time we want to preserve the order so
10558 * that digest(a,b,c,d) will be different than digest(b,c,d,a)
10559 *
10560 * Also note that mixdigest("foo") followed by mixdigest("bar")
10561 * will lead to a different digest compared to "fo", "obar".
10562 */
10563 static void mixDigest(unsigned char *digest, void *ptr, size_t len) {
10564 SHA1_CTX ctx;
10565 char *s = ptr;
10566
10567 xorDigest(digest,s,len);
10568 SHA1Init(&ctx);
10569 SHA1Update(&ctx,digest,20);
10570 SHA1Final(digest,&ctx);
10571 }
10572
10573 static void mixObjectDigest(unsigned char *digest, robj *o) {
10574 o = getDecodedObject(o);
10575 mixDigest(digest,o->ptr,sdslen(o->ptr));
10576 decrRefCount(o);
10577 }
10578
10579 /* Compute the dataset digest. Since keys, sets elements, hashes elements
10580 * are not ordered, we use a trick: every aggregate digest is the xor
10581 * of the digests of their elements. This way the order will not change
10582 * the result. For list instead we use a feedback entering the output digest
10583 * as input in order to ensure that a different ordered list will result in
10584 * a different digest. */
10585 static void computeDatasetDigest(unsigned char *final) {
10586 unsigned char digest[20];
10587 char buf[128];
10588 dictIterator *di = NULL;
10589 dictEntry *de;
10590 int j;
10591 uint32_t aux;
10592
10593 memset(final,0,20); /* Start with a clean result */
10594
10595 for (j = 0; j < server.dbnum; j++) {
10596 redisDb *db = server.db+j;
10597
10598 if (dictSize(db->dict) == 0) continue;
10599 di = dictGetIterator(db->dict);
10600
10601 /* hash the DB id, so the same dataset moved in a different
10602 * DB will lead to a different digest */
10603 aux = htonl(j);
10604 mixDigest(final,&aux,sizeof(aux));
10605
10606 /* Iterate this DB writing every entry */
10607 while((de = dictNext(di)) != NULL) {
10608 robj *key, *o, *kcopy;
10609 time_t expiretime;
10610
10611 memset(digest,0,20); /* This key-val digest */
10612 key = dictGetEntryKey(de);
10613
10614 if (!server.vm_enabled) {
10615 mixObjectDigest(digest,key);
10616 o = dictGetEntryVal(de);
10617 } else {
10618 /* Don't work with the key directly as when VM is active
10619 * this is unsafe: TODO: fix decrRefCount to check if the
10620 * count really reached 0 to avoid this mess */
10621 kcopy = dupStringObject(key);
10622 mixObjectDigest(digest,kcopy);
10623 o = lookupKeyRead(db,kcopy);
10624 decrRefCount(kcopy);
10625 }
10626 aux = htonl(o->type);
10627 mixDigest(digest,&aux,sizeof(aux));
10628 expiretime = getExpire(db,key);
10629
10630 /* Save the key and associated value */
10631 if (o->type == REDIS_STRING) {
10632 mixObjectDigest(digest,o);
10633 } else if (o->type == REDIS_LIST) {
10634 list *list = o->ptr;
10635 listNode *ln;
10636 listIter li;
10637
10638 listRewind(list,&li);
10639 while((ln = listNext(&li))) {
10640 robj *eleobj = listNodeValue(ln);
10641
10642 mixObjectDigest(digest,eleobj);
10643 }
10644 } else if (o->type == REDIS_SET) {
10645 dict *set = o->ptr;
10646 dictIterator *di = dictGetIterator(set);
10647 dictEntry *de;
10648
10649 while((de = dictNext(di)) != NULL) {
10650 robj *eleobj = dictGetEntryKey(de);
10651
10652 xorObjectDigest(digest,eleobj);
10653 }
10654 dictReleaseIterator(di);
10655 } else if (o->type == REDIS_ZSET) {
10656 zset *zs = o->ptr;
10657 dictIterator *di = dictGetIterator(zs->dict);
10658 dictEntry *de;
10659
10660 while((de = dictNext(di)) != NULL) {
10661 robj *eleobj = dictGetEntryKey(de);
10662 double *score = dictGetEntryVal(de);
10663 unsigned char eledigest[20];
10664
10665 snprintf(buf,sizeof(buf),"%.17g",*score);
10666 memset(eledigest,0,20);
10667 mixObjectDigest(eledigest,eleobj);
10668 mixDigest(eledigest,buf,strlen(buf));
10669 xorDigest(digest,eledigest,20);
10670 }
10671 dictReleaseIterator(di);
10672 } else if (o->type == REDIS_HASH) {
10673 hashIterator *hi;
10674 robj *obj;
10675
10676 hi = hashInitIterator(o);
10677 while (hashNext(hi) != REDIS_ERR) {
10678 unsigned char eledigest[20];
10679
10680 memset(eledigest,0,20);
10681 obj = hashCurrent(hi,REDIS_HASH_KEY);
10682 mixObjectDigest(eledigest,obj);
10683 decrRefCount(obj);
10684 obj = hashCurrent(hi,REDIS_HASH_VALUE);
10685 mixObjectDigest(eledigest,obj);
10686 decrRefCount(obj);
10687 xorDigest(digest,eledigest,20);
10688 }
10689 hashReleaseIterator(hi);
10690 } else {
10691 redisPanic("Unknown object type");
10692 }
10693 /* If the key has an expire, add it to the mix */
10694 if (expiretime != -1) xorDigest(digest,"!!expire!!",10);
10695 /* We can finally xor the key-val digest to the final digest */
10696 xorDigest(final,digest,20);
10697 }
10698 dictReleaseIterator(di);
10699 }
10700 }
10701
10702 static void debugCommand(redisClient *c) {
10703 if (!strcasecmp(c->argv[1]->ptr,"segfault")) {
10704 *((char*)-1) = 'x';
10705 } else if (!strcasecmp(c->argv[1]->ptr,"reload")) {
10706 if (rdbSave(server.dbfilename) != REDIS_OK) {
10707 addReply(c,shared.err);
10708 return;
10709 }
10710 emptyDb();
10711 if (rdbLoad(server.dbfilename) != REDIS_OK) {
10712 addReply(c,shared.err);
10713 return;
10714 }
10715 redisLog(REDIS_WARNING,"DB reloaded by DEBUG RELOAD");
10716 addReply(c,shared.ok);
10717 } else if (!strcasecmp(c->argv[1]->ptr,"loadaof")) {
10718 emptyDb();
10719 if (loadAppendOnlyFile(server.appendfilename) != REDIS_OK) {
10720 addReply(c,shared.err);
10721 return;
10722 }
10723 redisLog(REDIS_WARNING,"Append Only File loaded by DEBUG LOADAOF");
10724 addReply(c,shared.ok);
10725 } else if (!strcasecmp(c->argv[1]->ptr,"object") && c->argc == 3) {
10726 dictEntry *de = dictFind(c->db->dict,c->argv[2]);
10727 robj *key, *val;
10728
10729 if (!de) {
10730 addReply(c,shared.nokeyerr);
10731 return;
10732 }
10733 key = dictGetEntryKey(de);
10734 val = dictGetEntryVal(de);
10735 if (!server.vm_enabled || (key->storage == REDIS_VM_MEMORY ||
10736 key->storage == REDIS_VM_SWAPPING)) {
10737 char *strenc;
10738 char buf[128];
10739
10740 if (val->encoding < (sizeof(strencoding)/sizeof(char*))) {
10741 strenc = strencoding[val->encoding];
10742 } else {
10743 snprintf(buf,64,"unknown encoding %d\n", val->encoding);
10744 strenc = buf;
10745 }
10746 addReplySds(c,sdscatprintf(sdsempty(),
10747 "+Key at:%p refcount:%d, value at:%p refcount:%d "
10748 "encoding:%s serializedlength:%lld\r\n",
10749 (void*)key, key->refcount, (void*)val, val->refcount,
10750 strenc, (long long) rdbSavedObjectLen(val,NULL)));
10751 } else {
10752 addReplySds(c,sdscatprintf(sdsempty(),
10753 "+Key at:%p refcount:%d, value swapped at: page %llu "
10754 "using %llu pages\r\n",
10755 (void*)key, key->refcount, (unsigned long long) key->vm.page,
10756 (unsigned long long) key->vm.usedpages));
10757 }
10758 } else if (!strcasecmp(c->argv[1]->ptr,"swapin") && c->argc == 3) {
10759 lookupKeyRead(c->db,c->argv[2]);
10760 addReply(c,shared.ok);
10761 } else if (!strcasecmp(c->argv[1]->ptr,"swapout") && c->argc == 3) {
10762 dictEntry *de = dictFind(c->db->dict,c->argv[2]);
10763 robj *key, *val;
10764
10765 if (!server.vm_enabled) {
10766 addReplySds(c,sdsnew("-ERR Virtual Memory is disabled\r\n"));
10767 return;
10768 }
10769 if (!de) {
10770 addReply(c,shared.nokeyerr);
10771 return;
10772 }
10773 key = dictGetEntryKey(de);
10774 val = dictGetEntryVal(de);
10775 /* If the key is shared we want to create a copy */
10776 if (key->refcount > 1) {
10777 robj *newkey = dupStringObject(key);
10778 decrRefCount(key);
10779 key = dictGetEntryKey(de) = newkey;
10780 }
10781 /* Swap it */
10782 if (key->storage != REDIS_VM_MEMORY) {
10783 addReplySds(c,sdsnew("-ERR This key is not in memory\r\n"));
10784 } else if (vmSwapObjectBlocking(key,val) == REDIS_OK) {
10785 dictGetEntryVal(de) = NULL;
10786 addReply(c,shared.ok);
10787 } else {
10788 addReply(c,shared.err);
10789 }
10790 } else if (!strcasecmp(c->argv[1]->ptr,"populate") && c->argc == 3) {
10791 long keys, j;
10792 robj *key, *val;
10793 char buf[128];
10794
10795 if (getLongFromObjectOrReply(c, c->argv[2], &keys, NULL) != REDIS_OK)
10796 return;
10797 for (j = 0; j < keys; j++) {
10798 snprintf(buf,sizeof(buf),"key:%lu",j);
10799 key = createStringObject(buf,strlen(buf));
10800 if (lookupKeyRead(c->db,key) != NULL) {
10801 decrRefCount(key);
10802 continue;
10803 }
10804 snprintf(buf,sizeof(buf),"value:%lu",j);
10805 val = createStringObject(buf,strlen(buf));
10806 dictAdd(c->db->dict,key,val);
10807 }
10808 addReply(c,shared.ok);
10809 } else if (!strcasecmp(c->argv[1]->ptr,"digest") && c->argc == 2) {
10810 unsigned char digest[20];
10811 sds d = sdsnew("+");
10812 int j;
10813
10814 computeDatasetDigest(digest);
10815 for (j = 0; j < 20; j++)
10816 d = sdscatprintf(d, "%02x",digest[j]);
10817
10818 d = sdscatlen(d,"\r\n",2);
10819 addReplySds(c,d);
10820 } else {
10821 addReplySds(c,sdsnew(
10822 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPIN <key>|SWAPOUT <key>|RELOAD]\r\n"));
10823 }
10824 }
10825
10826 static void _redisAssert(char *estr, char *file, int line) {
10827 redisLog(REDIS_WARNING,"=== ASSERTION FAILED ===");
10828 redisLog(REDIS_WARNING,"==> %s:%d '%s' is not true",file,line,estr);
10829 #ifdef HAVE_BACKTRACE
10830 redisLog(REDIS_WARNING,"(forcing SIGSEGV in order to print the stack trace)");
10831 *((char*)-1) = 'x';
10832 #endif
10833 }
10834
10835 static void _redisPanic(char *msg, char *file, int line) {
10836 redisLog(REDIS_WARNING,"!!! Software Failure. Press left mouse button to continue");
10837 redisLog(REDIS_WARNING,"Guru Meditation: %s #%s:%d",msg,file,line);
10838 #ifdef HAVE_BACKTRACE
10839 redisLog(REDIS_WARNING,"(forcing SIGSEGV in order to print the stack trace)");
10840 *((char*)-1) = 'x';
10841 #endif
10842 }
10843
10844 /* =================================== Main! ================================ */
10845
10846 #ifdef __linux__
10847 int linuxOvercommitMemoryValue(void) {
10848 FILE *fp = fopen("/proc/sys/vm/overcommit_memory","r");
10849 char buf[64];
10850
10851 if (!fp) return -1;
10852 if (fgets(buf,64,fp) == NULL) {
10853 fclose(fp);
10854 return -1;
10855 }
10856 fclose(fp);
10857
10858 return atoi(buf);
10859 }
10860
10861 void linuxOvercommitMemoryWarning(void) {
10862 if (linuxOvercommitMemoryValue() == 0) {
10863 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.");
10864 }
10865 }
10866 #endif /* __linux__ */
10867
10868 static void daemonize(void) {
10869 int fd;
10870 FILE *fp;
10871
10872 if (fork() != 0) exit(0); /* parent exits */
10873 setsid(); /* create a new session */
10874
10875 /* Every output goes to /dev/null. If Redis is daemonized but
10876 * the 'logfile' is set to 'stdout' in the configuration file
10877 * it will not log at all. */
10878 if ((fd = open("/dev/null", O_RDWR, 0)) != -1) {
10879 dup2(fd, STDIN_FILENO);
10880 dup2(fd, STDOUT_FILENO);
10881 dup2(fd, STDERR_FILENO);
10882 if (fd > STDERR_FILENO) close(fd);
10883 }
10884 /* Try to write the pid file */
10885 fp = fopen(server.pidfile,"w");
10886 if (fp) {
10887 fprintf(fp,"%d\n",getpid());
10888 fclose(fp);
10889 }
10890 }
10891
10892 static void version() {
10893 printf("Redis server version %s\n", REDIS_VERSION);
10894 exit(0);
10895 }
10896
10897 static void usage() {
10898 fprintf(stderr,"Usage: ./redis-server [/path/to/redis.conf]\n");
10899 fprintf(stderr," ./redis-server - (read config from stdin)\n");
10900 exit(1);
10901 }
10902
10903 int main(int argc, char **argv) {
10904 time_t start;
10905
10906 initServerConfig();
10907 if (argc == 2) {
10908 if (strcmp(argv[1], "-v") == 0 ||
10909 strcmp(argv[1], "--version") == 0) version();
10910 if (strcmp(argv[1], "--help") == 0) usage();
10911 resetServerSaveParams();
10912 loadServerConfig(argv[1]);
10913 } else if ((argc > 2)) {
10914 usage();
10915 } else {
10916 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'");
10917 }
10918 if (server.daemonize) daemonize();
10919 initServer();
10920 redisLog(REDIS_NOTICE,"Server started, Redis version " REDIS_VERSION);
10921 #ifdef __linux__
10922 linuxOvercommitMemoryWarning();
10923 #endif
10924 start = time(NULL);
10925 if (server.appendonly) {
10926 if (loadAppendOnlyFile(server.appendfilename) == REDIS_OK)
10927 redisLog(REDIS_NOTICE,"DB loaded from append only file: %ld seconds",time(NULL)-start);
10928 } else {
10929 if (rdbLoad(server.dbfilename) == REDIS_OK)
10930 redisLog(REDIS_NOTICE,"DB loaded from disk: %ld seconds",time(NULL)-start);
10931 }
10932 redisLog(REDIS_NOTICE,"The server is now ready to accept connections on port %d", server.port);
10933 aeSetBeforeSleepProc(server.el,beforeSleep);
10934 aeMain(server.el);
10935 aeDeleteEventLoop(server.el);
10936 return 0;
10937 }
10938
10939 /* ============================= Backtrace support ========================= */
10940
10941 #ifdef HAVE_BACKTRACE
10942 static char *findFuncName(void *pointer, unsigned long *offset);
10943
10944 static void *getMcontextEip(ucontext_t *uc) {
10945 #if defined(__FreeBSD__)
10946 return (void*) uc->uc_mcontext.mc_eip;
10947 #elif defined(__dietlibc__)
10948 return (void*) uc->uc_mcontext.eip;
10949 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
10950 #if __x86_64__
10951 return (void*) uc->uc_mcontext->__ss.__rip;
10952 #else
10953 return (void*) uc->uc_mcontext->__ss.__eip;
10954 #endif
10955 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
10956 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
10957 return (void*) uc->uc_mcontext->__ss.__rip;
10958 #else
10959 return (void*) uc->uc_mcontext->__ss.__eip;
10960 #endif
10961 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
10962 return (void*) uc->uc_mcontext.gregs[REG_EIP]; /* Linux 32/64 bit */
10963 #elif defined(__ia64__) /* Linux IA64 */
10964 return (void*) uc->uc_mcontext.sc_ip;
10965 #else
10966 return NULL;
10967 #endif
10968 }
10969
10970 static void segvHandler(int sig, siginfo_t *info, void *secret) {
10971 void *trace[100];
10972 char **messages = NULL;
10973 int i, trace_size = 0;
10974 unsigned long offset=0;
10975 ucontext_t *uc = (ucontext_t*) secret;
10976 sds infostring;
10977 REDIS_NOTUSED(info);
10978
10979 redisLog(REDIS_WARNING,
10980 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION, sig);
10981 infostring = genRedisInfoString();
10982 redisLog(REDIS_WARNING, "%s",infostring);
10983 /* It's not safe to sdsfree() the returned string under memory
10984 * corruption conditions. Let it leak as we are going to abort */
10985
10986 trace_size = backtrace(trace, 100);
10987 /* overwrite sigaction with caller's address */
10988 if (getMcontextEip(uc) != NULL) {
10989 trace[1] = getMcontextEip(uc);
10990 }
10991 messages = backtrace_symbols(trace, trace_size);
10992
10993 for (i=1; i<trace_size; ++i) {
10994 char *fn = findFuncName(trace[i], &offset), *p;
10995
10996 p = strchr(messages[i],'+');
10997 if (!fn || (p && ((unsigned long)strtol(p+1,NULL,10)) < offset)) {
10998 redisLog(REDIS_WARNING,"%s", messages[i]);
10999 } else {
11000 redisLog(REDIS_WARNING,"%d redis-server %p %s + %d", i, trace[i], fn, (unsigned int)offset);
11001 }
11002 }
11003 /* free(messages); Don't call free() with possibly corrupted memory. */
11004 _exit(0);
11005 }
11006
11007 static void sigtermHandler(int sig) {
11008 REDIS_NOTUSED(sig);
11009
11010 redisLog(REDIS_WARNING,"SIGTERM received, scheduling shutting down...");
11011 server.shutdown_asap = 1;
11012 }
11013
11014 static void setupSigSegvAction(void) {
11015 struct sigaction act;
11016
11017 sigemptyset (&act.sa_mask);
11018 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
11019 * is used. Otherwise, sa_handler is used */
11020 act.sa_flags = SA_NODEFER | SA_ONSTACK | SA_RESETHAND | SA_SIGINFO;
11021 act.sa_sigaction = segvHandler;
11022 sigaction (SIGSEGV, &act, NULL);
11023 sigaction (SIGBUS, &act, NULL);
11024 sigaction (SIGFPE, &act, NULL);
11025 sigaction (SIGILL, &act, NULL);
11026 sigaction (SIGBUS, &act, NULL);
11027
11028 act.sa_flags = SA_NODEFER | SA_ONSTACK | SA_RESETHAND;
11029 act.sa_handler = sigtermHandler;
11030 sigaction (SIGTERM, &act, NULL);
11031 return;
11032 }
11033
11034 #include "staticsymbols.h"
11035 /* This function try to convert a pointer into a function name. It's used in
11036 * oreder to provide a backtrace under segmentation fault that's able to
11037 * display functions declared as static (otherwise the backtrace is useless). */
11038 static char *findFuncName(void *pointer, unsigned long *offset){
11039 int i, ret = -1;
11040 unsigned long off, minoff = 0;
11041
11042 /* Try to match against the Symbol with the smallest offset */
11043 for (i=0; symsTable[i].pointer; i++) {
11044 unsigned long lp = (unsigned long) pointer;
11045
11046 if (lp != (unsigned long)-1 && lp >= symsTable[i].pointer) {
11047 off=lp-symsTable[i].pointer;
11048 if (ret < 0 || off < minoff) {
11049 minoff=off;
11050 ret=i;
11051 }
11052 }
11053 }
11054 if (ret == -1) return NULL;
11055 *offset = minoff;
11056 return symsTable[ret].name;
11057 }
11058 #else /* HAVE_BACKTRACE */
11059 static void setupSigSegvAction(void) {
11060 }
11061 #endif /* HAVE_BACKTRACE */
11062
11063
11064
11065 /* The End */
11066
11067
11068