]> git.saurik.com Git - redis.git/blob - redis.c
1ab854caefd64e35f84338ea19d27e925615ab5c
[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 "1.3.10"
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 <math.h>
61 #include <pthread.h>
62
63 #if defined(__sun)
64 #include "solarisfixes.h"
65 #endif
66
67 #include "redis.h"
68 #include "ae.h" /* Event driven programming library */
69 #include "sds.h" /* Dynamic safe strings */
70 #include "anet.h" /* Networking the easy way */
71 #include "dict.h" /* Hash tables */
72 #include "adlist.h" /* Linked lists */
73 #include "zmalloc.h" /* total memory usage aware version of malloc/free */
74 #include "lzf.h" /* LZF compression library */
75 #include "pqsort.h" /* Partial qsort for SORT+LIMIT */
76 #include "zipmap.h"
77
78 /* Error codes */
79 #define REDIS_OK 0
80 #define REDIS_ERR -1
81
82 /* Static server configuration */
83 #define REDIS_SERVERPORT 6379 /* TCP port */
84 #define REDIS_MAXIDLETIME (60*5) /* default client timeout */
85 #define REDIS_IOBUF_LEN 1024
86 #define REDIS_LOADBUF_LEN 1024
87 #define REDIS_STATIC_ARGS 8
88 #define REDIS_DEFAULT_DBNUM 16
89 #define REDIS_CONFIGLINE_MAX 1024
90 #define REDIS_OBJFREELIST_MAX 1000000 /* Max number of objects to cache */
91 #define REDIS_MAX_SYNC_TIME 60 /* Slave can't take more to sync */
92 #define REDIS_EXPIRELOOKUPS_PER_CRON 10 /* lookup 10 expires per loop */
93 #define REDIS_MAX_WRITE_PER_EVENT (1024*64)
94 #define REDIS_REQUEST_MAX_SIZE (1024*1024*256) /* max bytes in inline command */
95
96 /* If more then REDIS_WRITEV_THRESHOLD write packets are pending use writev */
97 #define REDIS_WRITEV_THRESHOLD 3
98 /* Max number of iovecs used for each writev call */
99 #define REDIS_WRITEV_IOVEC_COUNT 256
100
101 /* Hash table parameters */
102 #define REDIS_HT_MINFILL 10 /* Minimal hash table fill 10% */
103
104 /* Command flags */
105 #define REDIS_CMD_BULK 1 /* Bulk write command */
106 #define REDIS_CMD_INLINE 2 /* Inline command */
107 /* REDIS_CMD_DENYOOM reserves a longer comment: all the commands marked with
108 this flags will return an error when the 'maxmemory' option is set in the
109 config file and the server is using more than maxmemory bytes of memory.
110 In short this commands are denied on low memory conditions. */
111 #define REDIS_CMD_DENYOOM 4
112 #define REDIS_CMD_FORCE_REPLICATION 8 /* Force replication even if dirty is 0 */
113
114 /* Object types */
115 #define REDIS_STRING 0
116 #define REDIS_LIST 1
117 #define REDIS_SET 2
118 #define REDIS_ZSET 3
119 #define REDIS_HASH 4
120
121 /* Objects encoding. Some kind of objects like Strings and Hashes can be
122 * internally represented in multiple ways. The 'encoding' field of the object
123 * is set to one of this fields for this object. */
124 #define REDIS_ENCODING_RAW 0 /* Raw representation */
125 #define REDIS_ENCODING_INT 1 /* Encoded as integer */
126 #define REDIS_ENCODING_ZIPMAP 2 /* Encoded as zipmap */
127 #define REDIS_ENCODING_HT 3 /* Encoded as an hash table */
128
129 static char* strencoding[] = {
130 "raw", "int", "zipmap", "hashtable"
131 };
132
133 /* Object types only used for dumping to disk */
134 #define REDIS_EXPIRETIME 253
135 #define REDIS_SELECTDB 254
136 #define REDIS_EOF 255
137
138 /* Defines related to the dump file format. To store 32 bits lengths for short
139 * keys requires a lot of space, so we check the most significant 2 bits of
140 * the first byte to interpreter the length:
141 *
142 * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
143 * 01|000000 00000000 => 01, the len is 14 byes, 6 bits + 8 bits of next byte
144 * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
145 * 11|000000 this means: specially encoded object will follow. The six bits
146 * number specify the kind of object that follows.
147 * See the REDIS_RDB_ENC_* defines.
148 *
149 * Lenghts up to 63 are stored using a single byte, most DB keys, and may
150 * values, will fit inside. */
151 #define REDIS_RDB_6BITLEN 0
152 #define REDIS_RDB_14BITLEN 1
153 #define REDIS_RDB_32BITLEN 2
154 #define REDIS_RDB_ENCVAL 3
155 #define REDIS_RDB_LENERR UINT_MAX
156
157 /* When a length of a string object stored on disk has the first two bits
158 * set, the remaining two bits specify a special encoding for the object
159 * accordingly to the following defines: */
160 #define REDIS_RDB_ENC_INT8 0 /* 8 bit signed integer */
161 #define REDIS_RDB_ENC_INT16 1 /* 16 bit signed integer */
162 #define REDIS_RDB_ENC_INT32 2 /* 32 bit signed integer */
163 #define REDIS_RDB_ENC_LZF 3 /* string compressed with FASTLZ */
164
165 /* Virtual memory object->where field. */
166 #define REDIS_VM_MEMORY 0 /* The object is on memory */
167 #define REDIS_VM_SWAPPED 1 /* The object is on disk */
168 #define REDIS_VM_SWAPPING 2 /* Redis is swapping this object on disk */
169 #define REDIS_VM_LOADING 3 /* Redis is loading this object from disk */
170
171 /* Virtual memory static configuration stuff.
172 * Check vmFindContiguousPages() to know more about this magic numbers. */
173 #define REDIS_VM_MAX_NEAR_PAGES 65536
174 #define REDIS_VM_MAX_RANDOM_JUMP 4096
175 #define REDIS_VM_MAX_THREADS 32
176 #define REDIS_THREAD_STACK_SIZE (1024*1024*4)
177 /* The following is the *percentage* of completed I/O jobs to process when the
178 * handelr is called. While Virtual Memory I/O operations are performed by
179 * threads, this operations must be processed by the main thread when completed
180 * in order to take effect. */
181 #define REDIS_MAX_COMPLETED_JOBS_PROCESSED 1
182
183 /* Client flags */
184 #define REDIS_SLAVE 1 /* This client is a slave server */
185 #define REDIS_MASTER 2 /* This client is a master server */
186 #define REDIS_MONITOR 4 /* This client is a slave monitor, see MONITOR */
187 #define REDIS_MULTI 8 /* This client is in a MULTI context */
188 #define REDIS_BLOCKED 16 /* The client is waiting in a blocking operation */
189 #define REDIS_IO_WAIT 32 /* The client is waiting for Virtual Memory I/O */
190
191 /* Slave replication state - slave side */
192 #define REDIS_REPL_NONE 0 /* No active replication */
193 #define REDIS_REPL_CONNECT 1 /* Must connect to master */
194 #define REDIS_REPL_CONNECTED 2 /* Connected to master */
195
196 /* Slave replication state - from the point of view of master
197 * Note that in SEND_BULK and ONLINE state the slave receives new updates
198 * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
199 * to start the next background saving in order to send updates to it. */
200 #define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
201 #define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
202 #define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
203 #define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */
204
205 /* List related stuff */
206 #define REDIS_HEAD 0
207 #define REDIS_TAIL 1
208
209 /* Sort operations */
210 #define REDIS_SORT_GET 0
211 #define REDIS_SORT_ASC 1
212 #define REDIS_SORT_DESC 2
213 #define REDIS_SORTKEY_MAX 1024
214
215 /* Log levels */
216 #define REDIS_DEBUG 0
217 #define REDIS_VERBOSE 1
218 #define REDIS_NOTICE 2
219 #define REDIS_WARNING 3
220
221 /* Anti-warning macro... */
222 #define REDIS_NOTUSED(V) ((void) V)
223
224 #define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
225 #define ZSKIPLIST_P 0.25 /* Skiplist P = 1/4 */
226
227 /* Append only defines */
228 #define APPENDFSYNC_NO 0
229 #define APPENDFSYNC_ALWAYS 1
230 #define APPENDFSYNC_EVERYSEC 2
231
232 /* Hashes related defaults */
233 #define REDIS_HASH_MAX_ZIPMAP_ENTRIES 64
234 #define REDIS_HASH_MAX_ZIPMAP_VALUE 512
235
236 /* We can print the stacktrace, so our assert is defined this way: */
237 #define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1)))
238 #define redisPanic(_e) _redisPanic(#_e,__FILE__,__LINE__),_exit(1)
239 static void _redisAssert(char *estr, char *file, int line);
240 static void _redisPanic(char *msg, char *file, int line);
241
242 /*================================= Data types ============================== */
243
244 /* A redis object, that is a type able to hold a string / list / set */
245
246 /* The VM object structure */
247 struct redisObjectVM {
248 off_t page; /* the page at witch the object is stored on disk */
249 off_t usedpages; /* number of pages used on disk */
250 time_t atime; /* Last access time */
251 } vm;
252
253 /* The actual Redis Object */
254 typedef struct redisObject {
255 void *ptr;
256 unsigned char type;
257 unsigned char encoding;
258 unsigned char storage; /* If this object is a key, where is the value?
259 * REDIS_VM_MEMORY, REDIS_VM_SWAPPED, ... */
260 unsigned char vtype; /* If this object is a key, and value is swapped out,
261 * this is the type of the swapped out object. */
262 int refcount;
263 /* VM fields, this are only allocated if VM is active, otherwise the
264 * object allocation function will just allocate
265 * sizeof(redisObjct) minus sizeof(redisObjectVM), so using
266 * Redis without VM active will not have any overhead. */
267 struct redisObjectVM vm;
268 } robj;
269
270 /* Macro used to initalize a Redis object allocated on the stack.
271 * Note that this macro is taken near the structure definition to make sure
272 * we'll update it when the structure is changed, to avoid bugs like
273 * bug #85 introduced exactly in this way. */
274 #define initStaticStringObject(_var,_ptr) do { \
275 _var.refcount = 1; \
276 _var.type = REDIS_STRING; \
277 _var.encoding = REDIS_ENCODING_RAW; \
278 _var.ptr = _ptr; \
279 if (server.vm_enabled) _var.storage = REDIS_VM_MEMORY; \
280 } while(0);
281
282 typedef struct redisDb {
283 dict *dict; /* The keyspace for this DB */
284 dict *expires; /* Timeout of keys with a timeout set */
285 dict *blockingkeys; /* Keys with clients waiting for data (BLPOP) */
286 dict *io_keys; /* Keys with clients waiting for VM I/O */
287 int id;
288 } redisDb;
289
290 /* Client MULTI/EXEC state */
291 typedef struct multiCmd {
292 robj **argv;
293 int argc;
294 struct redisCommand *cmd;
295 } multiCmd;
296
297 typedef struct multiState {
298 multiCmd *commands; /* Array of MULTI commands */
299 int count; /* Total number of MULTI commands */
300 } multiState;
301
302 /* With multiplexing we need to take per-clinet state.
303 * Clients are taken in a liked list. */
304 typedef struct redisClient {
305 int fd;
306 redisDb *db;
307 int dictid;
308 sds querybuf;
309 robj **argv, **mbargv;
310 int argc, mbargc;
311 int bulklen; /* bulk read len. -1 if not in bulk read mode */
312 int multibulk; /* multi bulk command format active */
313 list *reply;
314 int sentlen;
315 time_t lastinteraction; /* time of the last interaction, used for timeout */
316 int flags; /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
317 int slaveseldb; /* slave selected db, if this client is a slave */
318 int authenticated; /* when requirepass is non-NULL */
319 int replstate; /* replication state if this is a slave */
320 int repldbfd; /* replication DB file descriptor */
321 long repldboff; /* replication DB file offset */
322 off_t repldbsize; /* replication DB file size */
323 multiState mstate; /* MULTI/EXEC state */
324 robj **blockingkeys; /* The key we are waiting to terminate a blocking
325 * operation such as BLPOP. Otherwise NULL. */
326 int blockingkeysnum; /* Number of blocking keys */
327 time_t blockingto; /* Blocking operation timeout. If UNIX current time
328 * is >= blockingto then the operation timed out. */
329 list *io_keys; /* Keys this client is waiting to be loaded from the
330 * swap file in order to continue. */
331 dict *pubsub_channels; /* channels a client is interested in (SUBSCRIBE) */
332 list *pubsub_patterns; /* patterns a client is interested in (SUBSCRIBE) */
333 } redisClient;
334
335 struct saveparam {
336 time_t seconds;
337 int changes;
338 };
339
340 /* Global server state structure */
341 struct redisServer {
342 int port;
343 int fd;
344 redisDb *db;
345 long long dirty; /* changes to DB from the last save */
346 list *clients;
347 list *slaves, *monitors;
348 char neterr[ANET_ERR_LEN];
349 aeEventLoop *el;
350 int cronloops; /* number of times the cron function run */
351 list *objfreelist; /* A list of freed objects to avoid malloc() */
352 time_t lastsave; /* Unix time of last save succeeede */
353 /* Fields used only for stats */
354 time_t stat_starttime; /* server start time */
355 long long stat_numcommands; /* number of processed commands */
356 long long stat_numconnections; /* number of connections received */
357 long long stat_expiredkeys; /* number of expired keys */
358 /* Configuration */
359 int verbosity;
360 int glueoutputbuf;
361 int maxidletime;
362 int dbnum;
363 int daemonize;
364 int appendonly;
365 int appendfsync;
366 time_t lastfsync;
367 int appendfd;
368 int appendseldb;
369 char *pidfile;
370 pid_t bgsavechildpid;
371 pid_t bgrewritechildpid;
372 sds bgrewritebuf; /* buffer taken by parent during oppend only rewrite */
373 sds aofbuf; /* AOF buffer, written before entering the event loop */
374 struct saveparam *saveparams;
375 int saveparamslen;
376 char *logfile;
377 char *bindaddr;
378 char *dbfilename;
379 char *appendfilename;
380 char *requirepass;
381 int rdbcompression;
382 int activerehashing;
383 /* Replication related */
384 int isslave;
385 char *masterauth;
386 char *masterhost;
387 int masterport;
388 redisClient *master; /* client that is master for this slave */
389 int replstate;
390 unsigned int maxclients;
391 unsigned long long maxmemory;
392 unsigned int blpop_blocked_clients;
393 unsigned int vm_blocked_clients;
394 /* Sort parameters - qsort_r() is only available under BSD so we
395 * have to take this state global, in order to pass it to sortCompare() */
396 int sort_desc;
397 int sort_alpha;
398 int sort_bypattern;
399 /* Virtual memory configuration */
400 int vm_enabled;
401 char *vm_swap_file;
402 off_t vm_page_size;
403 off_t vm_pages;
404 unsigned long long vm_max_memory;
405 /* Hashes config */
406 size_t hash_max_zipmap_entries;
407 size_t hash_max_zipmap_value;
408 /* Virtual memory state */
409 FILE *vm_fp;
410 int vm_fd;
411 off_t vm_next_page; /* Next probably empty page */
412 off_t vm_near_pages; /* Number of pages allocated sequentially */
413 unsigned char *vm_bitmap; /* Bitmap of free/used pages */
414 time_t unixtime; /* Unix time sampled every second. */
415 /* Virtual memory I/O threads stuff */
416 /* An I/O thread process an element taken from the io_jobs queue and
417 * put the result of the operation in the io_done list. While the
418 * job is being processed, it's put on io_processing queue. */
419 list *io_newjobs; /* List of VM I/O jobs yet to be processed */
420 list *io_processing; /* List of VM I/O jobs being processed */
421 list *io_processed; /* List of VM I/O jobs already processed */
422 list *io_ready_clients; /* Clients ready to be unblocked. All keys loaded */
423 pthread_mutex_t io_mutex; /* lock to access io_jobs/io_done/io_thread_job */
424 pthread_mutex_t obj_freelist_mutex; /* safe redis objects creation/free */
425 pthread_mutex_t io_swapfile_mutex; /* So we can lseek + write */
426 pthread_attr_t io_threads_attr; /* attributes for threads creation */
427 int io_active_threads; /* Number of running I/O threads */
428 int vm_max_threads; /* Max number of I/O threads running at the same time */
429 /* Our main thread is blocked on the event loop, locking for sockets ready
430 * to be read or written, so when a threaded I/O operation is ready to be
431 * processed by the main thread, the I/O thread will use a unix pipe to
432 * awake the main thread. The followings are the two pipe FDs. */
433 int io_ready_pipe_read;
434 int io_ready_pipe_write;
435 /* Virtual memory stats */
436 unsigned long long vm_stats_used_pages;
437 unsigned long long vm_stats_swapped_objects;
438 unsigned long long vm_stats_swapouts;
439 unsigned long long vm_stats_swapins;
440 /* Pubsub */
441 dict *pubsub_channels; /* Map channels to list of subscribed clients */
442 list *pubsub_patterns; /* A list of pubsub_patterns */
443 /* Misc */
444 FILE *devnull;
445 };
446
447 typedef struct pubsubPattern {
448 redisClient *client;
449 robj *pattern;
450 } pubsubPattern;
451
452 typedef void redisCommandProc(redisClient *c);
453 struct redisCommand {
454 char *name;
455 redisCommandProc *proc;
456 int arity;
457 int flags;
458 /* Use a function to determine which keys need to be loaded
459 * in the background prior to executing this command. Takes precedence
460 * over vm_firstkey and others, ignored when NULL */
461 redisCommandProc *vm_preload_proc;
462 /* What keys should be loaded in background when calling this command? */
463 int vm_firstkey; /* The first argument that's a key (0 = no keys) */
464 int vm_lastkey; /* THe last argument that's a key */
465 int vm_keystep; /* The step between first and last key */
466 };
467
468 struct redisFunctionSym {
469 char *name;
470 unsigned long pointer;
471 };
472
473 typedef struct _redisSortObject {
474 robj *obj;
475 union {
476 double score;
477 robj *cmpobj;
478 } u;
479 } redisSortObject;
480
481 typedef struct _redisSortOperation {
482 int type;
483 robj *pattern;
484 } redisSortOperation;
485
486 /* ZSETs use a specialized version of Skiplists */
487
488 typedef struct zskiplistNode {
489 struct zskiplistNode **forward;
490 struct zskiplistNode *backward;
491 unsigned int *span;
492 double score;
493 robj *obj;
494 } zskiplistNode;
495
496 typedef struct zskiplist {
497 struct zskiplistNode *header, *tail;
498 unsigned long length;
499 int level;
500 } zskiplist;
501
502 typedef struct zset {
503 dict *dict;
504 zskiplist *zsl;
505 } zset;
506
507 /* Our shared "common" objects */
508
509 #define REDIS_SHARED_INTEGERS 10000
510 struct sharedObjectsStruct {
511 robj *crlf, *ok, *err, *emptybulk, *czero, *cone, *pong, *space,
512 *colon, *nullbulk, *nullmultibulk, *queued,
513 *emptymultibulk, *wrongtypeerr, *nokeyerr, *syntaxerr, *sameobjecterr,
514 *outofrangeerr, *plus,
515 *select0, *select1, *select2, *select3, *select4,
516 *select5, *select6, *select7, *select8, *select9,
517 *messagebulk, *pmessagebulk, *subscribebulk, *unsubscribebulk, *mbulk3,
518 *mbulk4, *psubscribebulk, *punsubscribebulk,
519 *integers[REDIS_SHARED_INTEGERS];
520 } shared;
521
522 /* Global vars that are actally used as constants. The following double
523 * values are used for double on-disk serialization, and are initialized
524 * at runtime to avoid strange compiler optimizations. */
525
526 static double R_Zero, R_PosInf, R_NegInf, R_Nan;
527
528 /* VM threaded I/O request message */
529 #define REDIS_IOJOB_LOAD 0 /* Load from disk to memory */
530 #define REDIS_IOJOB_PREPARE_SWAP 1 /* Compute needed pages */
531 #define REDIS_IOJOB_DO_SWAP 2 /* Swap from memory to disk */
532 typedef struct iojob {
533 int type; /* Request type, REDIS_IOJOB_* */
534 redisDb *db;/* Redis database */
535 robj *key; /* This I/O request is about swapping this key */
536 robj *val; /* the value to swap for REDIS_IOREQ_*_SWAP, otherwise this
537 * field is populated by the I/O thread for REDIS_IOREQ_LOAD. */
538 off_t page; /* Swap page where to read/write the object */
539 off_t pages; /* Swap pages needed to save object. PREPARE_SWAP return val */
540 int canceled; /* True if this command was canceled by blocking side of VM */
541 pthread_t thread; /* ID of the thread processing this entry */
542 } iojob;
543
544 /*================================ Prototypes =============================== */
545
546 static void freeStringObject(robj *o);
547 static void freeListObject(robj *o);
548 static void freeSetObject(robj *o);
549 static void decrRefCount(void *o);
550 static robj *createObject(int type, void *ptr);
551 static void freeClient(redisClient *c);
552 static int rdbLoad(char *filename);
553 static void addReply(redisClient *c, robj *obj);
554 static void addReplySds(redisClient *c, sds s);
555 static void incrRefCount(robj *o);
556 static int rdbSaveBackground(char *filename);
557 static robj *createStringObject(char *ptr, size_t len);
558 static robj *dupStringObject(robj *o);
559 static void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc);
560 static void replicationFeedMonitors(list *monitors, int dictid, robj **argv, int argc);
561 static void flushAppendOnlyFile(void);
562 static void feedAppendOnlyFile(struct redisCommand *cmd, int dictid, robj **argv, int argc);
563 static int syncWithMaster(void);
564 static robj *tryObjectEncoding(robj *o);
565 static robj *getDecodedObject(robj *o);
566 static int removeExpire(redisDb *db, robj *key);
567 static int expireIfNeeded(redisDb *db, robj *key);
568 static int deleteIfVolatile(redisDb *db, robj *key);
569 static int deleteIfSwapped(redisDb *db, robj *key);
570 static int deleteKey(redisDb *db, robj *key);
571 static time_t getExpire(redisDb *db, robj *key);
572 static int setExpire(redisDb *db, robj *key, time_t when);
573 static void updateSlavesWaitingBgsave(int bgsaveerr);
574 static void freeMemoryIfNeeded(void);
575 static int processCommand(redisClient *c);
576 static void setupSigSegvAction(void);
577 static void rdbRemoveTempFile(pid_t childpid);
578 static void aofRemoveTempFile(pid_t childpid);
579 static size_t stringObjectLen(robj *o);
580 static void processInputBuffer(redisClient *c);
581 static zskiplist *zslCreate(void);
582 static void zslFree(zskiplist *zsl);
583 static void zslInsert(zskiplist *zsl, double score, robj *obj);
584 static void sendReplyToClientWritev(aeEventLoop *el, int fd, void *privdata, int mask);
585 static void initClientMultiState(redisClient *c);
586 static void freeClientMultiState(redisClient *c);
587 static void queueMultiCommand(redisClient *c, struct redisCommand *cmd);
588 static void unblockClientWaitingData(redisClient *c);
589 static int handleClientsWaitingListPush(redisClient *c, robj *key, robj *ele);
590 static void vmInit(void);
591 static void vmMarkPagesFree(off_t page, off_t count);
592 static robj *vmLoadObject(robj *key);
593 static robj *vmPreviewObject(robj *key);
594 static int vmSwapOneObjectBlocking(void);
595 static int vmSwapOneObjectThreaded(void);
596 static int vmCanSwapOut(void);
597 static int tryFreeOneObjectFromFreelist(void);
598 static void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask);
599 static void vmThreadedIOCompletedJob(aeEventLoop *el, int fd, void *privdata, int mask);
600 static void vmCancelThreadedIOJob(robj *o);
601 static void lockThreadedIO(void);
602 static void unlockThreadedIO(void);
603 static int vmSwapObjectThreaded(robj *key, robj *val, redisDb *db);
604 static void freeIOJob(iojob *j);
605 static void queueIOJob(iojob *j);
606 static int vmWriteObjectOnSwap(robj *o, off_t page);
607 static robj *vmReadObjectFromSwap(off_t page, int type);
608 static void waitEmptyIOJobsQueue(void);
609 static void vmReopenSwapFile(void);
610 static int vmFreePage(off_t page);
611 static void zunionInterBlockClientOnSwappedKeys(redisClient *c);
612 static int blockClientOnSwappedKeys(struct redisCommand *cmd, redisClient *c);
613 static int dontWaitForSwappedKey(redisClient *c, robj *key);
614 static void handleClientsBlockedOnSwappedKey(redisDb *db, robj *key);
615 static void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask);
616 static struct redisCommand *lookupCommand(char *name);
617 static void call(redisClient *c, struct redisCommand *cmd);
618 static void resetClient(redisClient *c);
619 static void convertToRealHash(robj *o);
620 static int pubsubUnsubscribeAllChannels(redisClient *c, int notify);
621 static int pubsubUnsubscribeAllPatterns(redisClient *c, int notify);
622 static void freePubsubPattern(void *p);
623 static int listMatchPubsubPattern(void *a, void *b);
624 static int compareStringObjects(robj *a, robj *b);
625 static int equalStringObjects(robj *a, robj *b);
626 static void usage();
627 static int rewriteAppendOnlyFileBackground(void);
628 static int vmSwapObjectBlocking(robj *key, robj *val);
629
630 static void authCommand(redisClient *c);
631 static void pingCommand(redisClient *c);
632 static void echoCommand(redisClient *c);
633 static void setCommand(redisClient *c);
634 static void setnxCommand(redisClient *c);
635 static void setexCommand(redisClient *c);
636 static void getCommand(redisClient *c);
637 static void delCommand(redisClient *c);
638 static void existsCommand(redisClient *c);
639 static void incrCommand(redisClient *c);
640 static void decrCommand(redisClient *c);
641 static void incrbyCommand(redisClient *c);
642 static void decrbyCommand(redisClient *c);
643 static void selectCommand(redisClient *c);
644 static void randomkeyCommand(redisClient *c);
645 static void keysCommand(redisClient *c);
646 static void dbsizeCommand(redisClient *c);
647 static void lastsaveCommand(redisClient *c);
648 static void saveCommand(redisClient *c);
649 static void bgsaveCommand(redisClient *c);
650 static void bgrewriteaofCommand(redisClient *c);
651 static void shutdownCommand(redisClient *c);
652 static void moveCommand(redisClient *c);
653 static void renameCommand(redisClient *c);
654 static void renamenxCommand(redisClient *c);
655 static void lpushCommand(redisClient *c);
656 static void rpushCommand(redisClient *c);
657 static void lpopCommand(redisClient *c);
658 static void rpopCommand(redisClient *c);
659 static void llenCommand(redisClient *c);
660 static void lindexCommand(redisClient *c);
661 static void lrangeCommand(redisClient *c);
662 static void ltrimCommand(redisClient *c);
663 static void typeCommand(redisClient *c);
664 static void lsetCommand(redisClient *c);
665 static void saddCommand(redisClient *c);
666 static void sremCommand(redisClient *c);
667 static void smoveCommand(redisClient *c);
668 static void sismemberCommand(redisClient *c);
669 static void scardCommand(redisClient *c);
670 static void spopCommand(redisClient *c);
671 static void srandmemberCommand(redisClient *c);
672 static void sinterCommand(redisClient *c);
673 static void sinterstoreCommand(redisClient *c);
674 static void sunionCommand(redisClient *c);
675 static void sunionstoreCommand(redisClient *c);
676 static void sdiffCommand(redisClient *c);
677 static void sdiffstoreCommand(redisClient *c);
678 static void syncCommand(redisClient *c);
679 static void flushdbCommand(redisClient *c);
680 static void flushallCommand(redisClient *c);
681 static void sortCommand(redisClient *c);
682 static void lremCommand(redisClient *c);
683 static void rpoplpushcommand(redisClient *c);
684 static void infoCommand(redisClient *c);
685 static void mgetCommand(redisClient *c);
686 static void monitorCommand(redisClient *c);
687 static void expireCommand(redisClient *c);
688 static void expireatCommand(redisClient *c);
689 static void getsetCommand(redisClient *c);
690 static void ttlCommand(redisClient *c);
691 static void slaveofCommand(redisClient *c);
692 static void debugCommand(redisClient *c);
693 static void msetCommand(redisClient *c);
694 static void msetnxCommand(redisClient *c);
695 static void zaddCommand(redisClient *c);
696 static void zincrbyCommand(redisClient *c);
697 static void zrangeCommand(redisClient *c);
698 static void zrangebyscoreCommand(redisClient *c);
699 static void zcountCommand(redisClient *c);
700 static void zrevrangeCommand(redisClient *c);
701 static void zcardCommand(redisClient *c);
702 static void zremCommand(redisClient *c);
703 static void zscoreCommand(redisClient *c);
704 static void zremrangebyscoreCommand(redisClient *c);
705 static void multiCommand(redisClient *c);
706 static void execCommand(redisClient *c);
707 static void discardCommand(redisClient *c);
708 static void blpopCommand(redisClient *c);
709 static void brpopCommand(redisClient *c);
710 static void appendCommand(redisClient *c);
711 static void substrCommand(redisClient *c);
712 static void zrankCommand(redisClient *c);
713 static void zrevrankCommand(redisClient *c);
714 static void hsetCommand(redisClient *c);
715 static void hsetnxCommand(redisClient *c);
716 static void hgetCommand(redisClient *c);
717 static void hmsetCommand(redisClient *c);
718 static void hmgetCommand(redisClient *c);
719 static void hdelCommand(redisClient *c);
720 static void hlenCommand(redisClient *c);
721 static void zremrangebyrankCommand(redisClient *c);
722 static void zunionCommand(redisClient *c);
723 static void zinterCommand(redisClient *c);
724 static void hkeysCommand(redisClient *c);
725 static void hvalsCommand(redisClient *c);
726 static void hgetallCommand(redisClient *c);
727 static void hexistsCommand(redisClient *c);
728 static void configCommand(redisClient *c);
729 static void hincrbyCommand(redisClient *c);
730 static void subscribeCommand(redisClient *c);
731 static void unsubscribeCommand(redisClient *c);
732 static void psubscribeCommand(redisClient *c);
733 static void punsubscribeCommand(redisClient *c);
734 static void publishCommand(redisClient *c);
735
736 /*================================= Globals ================================= */
737
738 /* Global vars */
739 static struct redisServer server; /* server global state */
740 static struct redisCommand cmdTable[] = {
741 {"get",getCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
742 {"set",setCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,0,0,0},
743 {"setnx",setnxCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,0,0,0},
744 {"setex",setexCommand,4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,0,0,0},
745 {"append",appendCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
746 {"substr",substrCommand,4,REDIS_CMD_INLINE,NULL,1,1,1},
747 {"del",delCommand,-2,REDIS_CMD_INLINE,NULL,0,0,0},
748 {"exists",existsCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
749 {"incr",incrCommand,2,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,1,1},
750 {"decr",decrCommand,2,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,1,1},
751 {"mget",mgetCommand,-2,REDIS_CMD_INLINE,NULL,1,-1,1},
752 {"rpush",rpushCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
753 {"lpush",lpushCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
754 {"rpop",rpopCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
755 {"lpop",lpopCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
756 {"brpop",brpopCommand,-3,REDIS_CMD_INLINE,NULL,1,1,1},
757 {"blpop",blpopCommand,-3,REDIS_CMD_INLINE,NULL,1,1,1},
758 {"llen",llenCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
759 {"lindex",lindexCommand,3,REDIS_CMD_INLINE,NULL,1,1,1},
760 {"lset",lsetCommand,4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
761 {"lrange",lrangeCommand,4,REDIS_CMD_INLINE,NULL,1,1,1},
762 {"ltrim",ltrimCommand,4,REDIS_CMD_INLINE,NULL,1,1,1},
763 {"lrem",lremCommand,4,REDIS_CMD_BULK,NULL,1,1,1},
764 {"rpoplpush",rpoplpushcommand,3,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,2,1},
765 {"sadd",saddCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
766 {"srem",sremCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
767 {"smove",smoveCommand,4,REDIS_CMD_BULK,NULL,1,2,1},
768 {"sismember",sismemberCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
769 {"scard",scardCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
770 {"spop",spopCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
771 {"srandmember",srandmemberCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
772 {"sinter",sinterCommand,-2,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,-1,1},
773 {"sinterstore",sinterstoreCommand,-3,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,2,-1,1},
774 {"sunion",sunionCommand,-2,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,-1,1},
775 {"sunionstore",sunionstoreCommand,-3,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,2,-1,1},
776 {"sdiff",sdiffCommand,-2,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,-1,1},
777 {"sdiffstore",sdiffstoreCommand,-3,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,2,-1,1},
778 {"smembers",sinterCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
779 {"zadd",zaddCommand,4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
780 {"zincrby",zincrbyCommand,4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
781 {"zrem",zremCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
782 {"zremrangebyscore",zremrangebyscoreCommand,4,REDIS_CMD_INLINE,NULL,1,1,1},
783 {"zremrangebyrank",zremrangebyrankCommand,4,REDIS_CMD_INLINE,NULL,1,1,1},
784 {"zunion",zunionCommand,-4,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,zunionInterBlockClientOnSwappedKeys,0,0,0},
785 {"zinter",zinterCommand,-4,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,zunionInterBlockClientOnSwappedKeys,0,0,0},
786 {"zrange",zrangeCommand,-4,REDIS_CMD_INLINE,NULL,1,1,1},
787 {"zrangebyscore",zrangebyscoreCommand,-4,REDIS_CMD_INLINE,NULL,1,1,1},
788 {"zcount",zcountCommand,4,REDIS_CMD_INLINE,NULL,1,1,1},
789 {"zrevrange",zrevrangeCommand,-4,REDIS_CMD_INLINE,NULL,1,1,1},
790 {"zcard",zcardCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
791 {"zscore",zscoreCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
792 {"zrank",zrankCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
793 {"zrevrank",zrevrankCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
794 {"hset",hsetCommand,4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
795 {"hsetnx",hsetnxCommand,4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
796 {"hget",hgetCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
797 {"hmset",hmsetCommand,-4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
798 {"hmget",hmgetCommand,-3,REDIS_CMD_BULK,NULL,1,1,1},
799 {"hincrby",hincrbyCommand,4,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,1,1},
800 {"hdel",hdelCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
801 {"hlen",hlenCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
802 {"hkeys",hkeysCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
803 {"hvals",hvalsCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
804 {"hgetall",hgetallCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
805 {"hexists",hexistsCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
806 {"incrby",incrbyCommand,3,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,1,1},
807 {"decrby",decrbyCommand,3,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,1,1},
808 {"getset",getsetCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
809 {"mset",msetCommand,-3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,-1,2},
810 {"msetnx",msetnxCommand,-3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,-1,2},
811 {"randomkey",randomkeyCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
812 {"select",selectCommand,2,REDIS_CMD_INLINE,NULL,0,0,0},
813 {"move",moveCommand,3,REDIS_CMD_INLINE,NULL,1,1,1},
814 {"rename",renameCommand,3,REDIS_CMD_INLINE,NULL,1,1,1},
815 {"renamenx",renamenxCommand,3,REDIS_CMD_INLINE,NULL,1,1,1},
816 {"expire",expireCommand,3,REDIS_CMD_INLINE,NULL,0,0,0},
817 {"expireat",expireatCommand,3,REDIS_CMD_INLINE,NULL,0,0,0},
818 {"keys",keysCommand,2,REDIS_CMD_INLINE,NULL,0,0,0},
819 {"dbsize",dbsizeCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
820 {"auth",authCommand,2,REDIS_CMD_INLINE,NULL,0,0,0},
821 {"ping",pingCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
822 {"echo",echoCommand,2,REDIS_CMD_BULK,NULL,0,0,0},
823 {"save",saveCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
824 {"bgsave",bgsaveCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
825 {"bgrewriteaof",bgrewriteaofCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
826 {"shutdown",shutdownCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
827 {"lastsave",lastsaveCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
828 {"type",typeCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
829 {"multi",multiCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
830 {"exec",execCommand,1,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,0,0,0},
831 {"discard",discardCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
832 {"sync",syncCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
833 {"flushdb",flushdbCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
834 {"flushall",flushallCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
835 {"sort",sortCommand,-2,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,1,1},
836 {"info",infoCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
837 {"monitor",monitorCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
838 {"ttl",ttlCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
839 {"slaveof",slaveofCommand,3,REDIS_CMD_INLINE,NULL,0,0,0},
840 {"debug",debugCommand,-2,REDIS_CMD_INLINE,NULL,0,0,0},
841 {"config",configCommand,-2,REDIS_CMD_BULK,NULL,0,0,0},
842 {"subscribe",subscribeCommand,-2,REDIS_CMD_INLINE,NULL,0,0,0},
843 {"unsubscribe",unsubscribeCommand,-1,REDIS_CMD_INLINE,NULL,0,0,0},
844 {"psubscribe",psubscribeCommand,-2,REDIS_CMD_INLINE,NULL,0,0,0},
845 {"punsubscribe",punsubscribeCommand,-1,REDIS_CMD_INLINE,NULL,0,0,0},
846 {"publish",publishCommand,3,REDIS_CMD_BULK|REDIS_CMD_FORCE_REPLICATION,NULL,0,0,0},
847 {NULL,NULL,0,0,NULL,0,0,0}
848 };
849
850 /*============================ Utility functions ============================ */
851
852 /* Glob-style pattern matching. */
853 static int stringmatchlen(const char *pattern, int patternLen,
854 const char *string, int stringLen, int nocase)
855 {
856 while(patternLen) {
857 switch(pattern[0]) {
858 case '*':
859 while (pattern[1] == '*') {
860 pattern++;
861 patternLen--;
862 }
863 if (patternLen == 1)
864 return 1; /* match */
865 while(stringLen) {
866 if (stringmatchlen(pattern+1, patternLen-1,
867 string, stringLen, nocase))
868 return 1; /* match */
869 string++;
870 stringLen--;
871 }
872 return 0; /* no match */
873 break;
874 case '?':
875 if (stringLen == 0)
876 return 0; /* no match */
877 string++;
878 stringLen--;
879 break;
880 case '[':
881 {
882 int not, match;
883
884 pattern++;
885 patternLen--;
886 not = pattern[0] == '^';
887 if (not) {
888 pattern++;
889 patternLen--;
890 }
891 match = 0;
892 while(1) {
893 if (pattern[0] == '\\') {
894 pattern++;
895 patternLen--;
896 if (pattern[0] == string[0])
897 match = 1;
898 } else if (pattern[0] == ']') {
899 break;
900 } else if (patternLen == 0) {
901 pattern--;
902 patternLen++;
903 break;
904 } else if (pattern[1] == '-' && patternLen >= 3) {
905 int start = pattern[0];
906 int end = pattern[2];
907 int c = string[0];
908 if (start > end) {
909 int t = start;
910 start = end;
911 end = t;
912 }
913 if (nocase) {
914 start = tolower(start);
915 end = tolower(end);
916 c = tolower(c);
917 }
918 pattern += 2;
919 patternLen -= 2;
920 if (c >= start && c <= end)
921 match = 1;
922 } else {
923 if (!nocase) {
924 if (pattern[0] == string[0])
925 match = 1;
926 } else {
927 if (tolower((int)pattern[0]) == tolower((int)string[0]))
928 match = 1;
929 }
930 }
931 pattern++;
932 patternLen--;
933 }
934 if (not)
935 match = !match;
936 if (!match)
937 return 0; /* no match */
938 string++;
939 stringLen--;
940 break;
941 }
942 case '\\':
943 if (patternLen >= 2) {
944 pattern++;
945 patternLen--;
946 }
947 /* fall through */
948 default:
949 if (!nocase) {
950 if (pattern[0] != string[0])
951 return 0; /* no match */
952 } else {
953 if (tolower((int)pattern[0]) != tolower((int)string[0]))
954 return 0; /* no match */
955 }
956 string++;
957 stringLen--;
958 break;
959 }
960 pattern++;
961 patternLen--;
962 if (stringLen == 0) {
963 while(*pattern == '*') {
964 pattern++;
965 patternLen--;
966 }
967 break;
968 }
969 }
970 if (patternLen == 0 && stringLen == 0)
971 return 1;
972 return 0;
973 }
974
975 static int stringmatch(const char *pattern, const char *string, int nocase) {
976 return stringmatchlen(pattern,strlen(pattern),string,strlen(string),nocase);
977 }
978
979 /* Convert a string representing an amount of memory into the number of
980 * bytes, so for instance memtoll("1Gi") will return 1073741824 that is
981 * (1024*1024*1024).
982 *
983 * On parsing error, if *err is not NULL, it's set to 1, otherwise it's
984 * set to 0 */
985 static long long memtoll(const char *p, int *err) {
986 const char *u;
987 char buf[128];
988 long mul; /* unit multiplier */
989 long long val;
990 unsigned int digits;
991
992 if (err) *err = 0;
993 /* Search the first non digit character. */
994 u = p;
995 if (*u == '-') u++;
996 while(*u && isdigit(*u)) u++;
997 if (*u == '\0' || !strcasecmp(u,"b")) {
998 mul = 1;
999 } else if (!strcasecmp(u,"k")) {
1000 mul = 1000;
1001 } else if (!strcasecmp(u,"kb")) {
1002 mul = 1024;
1003 } else if (!strcasecmp(u,"m")) {
1004 mul = 1000*1000;
1005 } else if (!strcasecmp(u,"mb")) {
1006 mul = 1024*1024;
1007 } else if (!strcasecmp(u,"g")) {
1008 mul = 1000L*1000*1000;
1009 } else if (!strcasecmp(u,"gb")) {
1010 mul = 1024L*1024*1024;
1011 } else {
1012 if (err) *err = 1;
1013 mul = 1;
1014 }
1015 digits = u-p;
1016 if (digits >= sizeof(buf)) {
1017 if (err) *err = 1;
1018 return LLONG_MAX;
1019 }
1020 memcpy(buf,p,digits);
1021 buf[digits] = '\0';
1022 val = strtoll(buf,NULL,10);
1023 return val*mul;
1024 }
1025
1026 static void redisLog(int level, const char *fmt, ...) {
1027 va_list ap;
1028 FILE *fp;
1029
1030 fp = (server.logfile == NULL) ? stdout : fopen(server.logfile,"a");
1031 if (!fp) return;
1032
1033 va_start(ap, fmt);
1034 if (level >= server.verbosity) {
1035 char *c = ".-*#";
1036 char buf[64];
1037 time_t now;
1038
1039 now = time(NULL);
1040 strftime(buf,64,"%d %b %H:%M:%S",localtime(&now));
1041 fprintf(fp,"[%d] %s %c ",(int)getpid(),buf,c[level]);
1042 vfprintf(fp, fmt, ap);
1043 fprintf(fp,"\n");
1044 fflush(fp);
1045 }
1046 va_end(ap);
1047
1048 if (server.logfile) fclose(fp);
1049 }
1050
1051 /*====================== Hash table type implementation ==================== */
1052
1053 /* This is an hash table type that uses the SDS dynamic strings libary as
1054 * keys and radis objects as values (objects can hold SDS strings,
1055 * lists, sets). */
1056
1057 static void dictVanillaFree(void *privdata, void *val)
1058 {
1059 DICT_NOTUSED(privdata);
1060 zfree(val);
1061 }
1062
1063 static void dictListDestructor(void *privdata, void *val)
1064 {
1065 DICT_NOTUSED(privdata);
1066 listRelease((list*)val);
1067 }
1068
1069 static int sdsDictKeyCompare(void *privdata, const void *key1,
1070 const void *key2)
1071 {
1072 int l1,l2;
1073 DICT_NOTUSED(privdata);
1074
1075 l1 = sdslen((sds)key1);
1076 l2 = sdslen((sds)key2);
1077 if (l1 != l2) return 0;
1078 return memcmp(key1, key2, l1) == 0;
1079 }
1080
1081 static void dictRedisObjectDestructor(void *privdata, void *val)
1082 {
1083 DICT_NOTUSED(privdata);
1084
1085 if (val == NULL) return; /* Values of swapped out keys as set to NULL */
1086 decrRefCount(val);
1087 }
1088
1089 static int dictObjKeyCompare(void *privdata, const void *key1,
1090 const void *key2)
1091 {
1092 const robj *o1 = key1, *o2 = key2;
1093 return sdsDictKeyCompare(privdata,o1->ptr,o2->ptr);
1094 }
1095
1096 static unsigned int dictObjHash(const void *key) {
1097 const robj *o = key;
1098 return dictGenHashFunction(o->ptr, sdslen((sds)o->ptr));
1099 }
1100
1101 static int dictEncObjKeyCompare(void *privdata, const void *key1,
1102 const void *key2)
1103 {
1104 robj *o1 = (robj*) key1, *o2 = (robj*) key2;
1105 int cmp;
1106
1107 if (o1->encoding == REDIS_ENCODING_INT &&
1108 o2->encoding == REDIS_ENCODING_INT)
1109 return o1->ptr == o2->ptr;
1110
1111 o1 = getDecodedObject(o1);
1112 o2 = getDecodedObject(o2);
1113 cmp = sdsDictKeyCompare(privdata,o1->ptr,o2->ptr);
1114 decrRefCount(o1);
1115 decrRefCount(o2);
1116 return cmp;
1117 }
1118
1119 static unsigned int dictEncObjHash(const void *key) {
1120 robj *o = (robj*) key;
1121
1122 if (o->encoding == REDIS_ENCODING_RAW) {
1123 return dictGenHashFunction(o->ptr, sdslen((sds)o->ptr));
1124 } else {
1125 if (o->encoding == REDIS_ENCODING_INT) {
1126 char buf[32];
1127 int len;
1128
1129 len = snprintf(buf,32,"%ld",(long)o->ptr);
1130 return dictGenHashFunction((unsigned char*)buf, len);
1131 } else {
1132 unsigned int hash;
1133
1134 o = getDecodedObject(o);
1135 hash = dictGenHashFunction(o->ptr, sdslen((sds)o->ptr));
1136 decrRefCount(o);
1137 return hash;
1138 }
1139 }
1140 }
1141
1142 /* Sets type and expires */
1143 static dictType setDictType = {
1144 dictEncObjHash, /* hash function */
1145 NULL, /* key dup */
1146 NULL, /* val dup */
1147 dictEncObjKeyCompare, /* key compare */
1148 dictRedisObjectDestructor, /* key destructor */
1149 NULL /* val destructor */
1150 };
1151
1152 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
1153 static dictType zsetDictType = {
1154 dictEncObjHash, /* hash function */
1155 NULL, /* key dup */
1156 NULL, /* val dup */
1157 dictEncObjKeyCompare, /* key compare */
1158 dictRedisObjectDestructor, /* key destructor */
1159 dictVanillaFree /* val destructor of malloc(sizeof(double)) */
1160 };
1161
1162 /* Db->dict */
1163 static dictType dbDictType = {
1164 dictObjHash, /* hash function */
1165 NULL, /* key dup */
1166 NULL, /* val dup */
1167 dictObjKeyCompare, /* key compare */
1168 dictRedisObjectDestructor, /* key destructor */
1169 dictRedisObjectDestructor /* val destructor */
1170 };
1171
1172 /* Db->expires */
1173 static dictType keyptrDictType = {
1174 dictObjHash, /* hash function */
1175 NULL, /* key dup */
1176 NULL, /* val dup */
1177 dictObjKeyCompare, /* key compare */
1178 dictRedisObjectDestructor, /* key destructor */
1179 NULL /* val destructor */
1180 };
1181
1182 /* Hash type hash table (note that small hashes are represented with zimpaps) */
1183 static dictType hashDictType = {
1184 dictEncObjHash, /* hash function */
1185 NULL, /* key dup */
1186 NULL, /* val dup */
1187 dictEncObjKeyCompare, /* key compare */
1188 dictRedisObjectDestructor, /* key destructor */
1189 dictRedisObjectDestructor /* val destructor */
1190 };
1191
1192 /* Keylist hash table type has unencoded redis objects as keys and
1193 * lists as values. It's used for blocking operations (BLPOP) and to
1194 * map swapped keys to a list of clients waiting for this keys to be loaded. */
1195 static dictType keylistDictType = {
1196 dictObjHash, /* hash function */
1197 NULL, /* key dup */
1198 NULL, /* val dup */
1199 dictObjKeyCompare, /* key compare */
1200 dictRedisObjectDestructor, /* key destructor */
1201 dictListDestructor /* val destructor */
1202 };
1203
1204 static void version();
1205
1206 /* ========================= Random utility functions ======================= */
1207
1208 /* Redis generally does not try to recover from out of memory conditions
1209 * when allocating objects or strings, it is not clear if it will be possible
1210 * to report this condition to the client since the networking layer itself
1211 * is based on heap allocation for send buffers, so we simply abort.
1212 * At least the code will be simpler to read... */
1213 static void oom(const char *msg) {
1214 redisLog(REDIS_WARNING, "%s: Out of memory\n",msg);
1215 sleep(1);
1216 abort();
1217 }
1218
1219 /* ====================== Redis server networking stuff ===================== */
1220 static void closeTimedoutClients(void) {
1221 redisClient *c;
1222 listNode *ln;
1223 time_t now = time(NULL);
1224 listIter li;
1225
1226 listRewind(server.clients,&li);
1227 while ((ln = listNext(&li)) != NULL) {
1228 c = listNodeValue(ln);
1229 if (server.maxidletime &&
1230 !(c->flags & REDIS_SLAVE) && /* no timeout for slaves */
1231 !(c->flags & REDIS_MASTER) && /* no timeout for masters */
1232 dictSize(c->pubsub_channels) == 0 && /* no timeout for pubsub */
1233 listLength(c->pubsub_patterns) == 0 &&
1234 (now - c->lastinteraction > server.maxidletime))
1235 {
1236 redisLog(REDIS_VERBOSE,"Closing idle client");
1237 freeClient(c);
1238 } else if (c->flags & REDIS_BLOCKED) {
1239 if (c->blockingto != 0 && c->blockingto < now) {
1240 addReply(c,shared.nullmultibulk);
1241 unblockClientWaitingData(c);
1242 }
1243 }
1244 }
1245 }
1246
1247 static int htNeedsResize(dict *dict) {
1248 long long size, used;
1249
1250 size = dictSlots(dict);
1251 used = dictSize(dict);
1252 return (size && used && size > DICT_HT_INITIAL_SIZE &&
1253 (used*100/size < REDIS_HT_MINFILL));
1254 }
1255
1256 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
1257 * we resize the hash table to save memory */
1258 static void tryResizeHashTables(void) {
1259 int j;
1260
1261 for (j = 0; j < server.dbnum; j++) {
1262 if (htNeedsResize(server.db[j].dict))
1263 dictResize(server.db[j].dict);
1264 if (htNeedsResize(server.db[j].expires))
1265 dictResize(server.db[j].expires);
1266 }
1267 }
1268
1269 /* Our hash table implementation performs rehashing incrementally while
1270 * we write/read from the hash table. Still if the server is idle, the hash
1271 * table will use two tables for a long time. So we try to use 1 millisecond
1272 * of CPU time at every serverCron() loop in order to rehash some key. */
1273 static void incrementallyRehash(void) {
1274 int j;
1275
1276 for (j = 0; j < server.dbnum; j++) {
1277 if (dictIsRehashing(server.db[j].dict)) {
1278 dictRehashMilliseconds(server.db[j].dict,1);
1279 break; /* already used our millisecond for this loop... */
1280 }
1281 }
1282 }
1283
1284 /* A background saving child (BGSAVE) terminated its work. Handle this. */
1285 void backgroundSaveDoneHandler(int statloc) {
1286 int exitcode = WEXITSTATUS(statloc);
1287 int bysignal = WIFSIGNALED(statloc);
1288
1289 if (!bysignal && exitcode == 0) {
1290 redisLog(REDIS_NOTICE,
1291 "Background saving terminated with success");
1292 server.dirty = 0;
1293 server.lastsave = time(NULL);
1294 } else if (!bysignal && exitcode != 0) {
1295 redisLog(REDIS_WARNING, "Background saving error");
1296 } else {
1297 redisLog(REDIS_WARNING,
1298 "Background saving terminated by signal %d", WTERMSIG(statloc));
1299 rdbRemoveTempFile(server.bgsavechildpid);
1300 }
1301 server.bgsavechildpid = -1;
1302 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1303 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1304 updateSlavesWaitingBgsave(exitcode == 0 ? REDIS_OK : REDIS_ERR);
1305 }
1306
1307 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1308 * Handle this. */
1309 void backgroundRewriteDoneHandler(int statloc) {
1310 int exitcode = WEXITSTATUS(statloc);
1311 int bysignal = WIFSIGNALED(statloc);
1312
1313 if (!bysignal && exitcode == 0) {
1314 int fd;
1315 char tmpfile[256];
1316
1317 redisLog(REDIS_NOTICE,
1318 "Background append only file rewriting terminated with success");
1319 /* Now it's time to flush the differences accumulated by the parent */
1320 snprintf(tmpfile,256,"temp-rewriteaof-bg-%d.aof", (int) server.bgrewritechildpid);
1321 fd = open(tmpfile,O_WRONLY|O_APPEND);
1322 if (fd == -1) {
1323 redisLog(REDIS_WARNING, "Not able to open the temp append only file produced by the child: %s", strerror(errno));
1324 goto cleanup;
1325 }
1326 /* Flush our data... */
1327 if (write(fd,server.bgrewritebuf,sdslen(server.bgrewritebuf)) !=
1328 (signed) sdslen(server.bgrewritebuf)) {
1329 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));
1330 close(fd);
1331 goto cleanup;
1332 }
1333 redisLog(REDIS_NOTICE,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server.bgrewritebuf));
1334 /* Now our work is to rename the temp file into the stable file. And
1335 * switch the file descriptor used by the server for append only. */
1336 if (rename(tmpfile,server.appendfilename) == -1) {
1337 redisLog(REDIS_WARNING,"Can't rename the temp append only file into the stable one: %s", strerror(errno));
1338 close(fd);
1339 goto cleanup;
1340 }
1341 /* Mission completed... almost */
1342 redisLog(REDIS_NOTICE,"Append only file successfully rewritten.");
1343 if (server.appendfd != -1) {
1344 /* If append only is actually enabled... */
1345 close(server.appendfd);
1346 server.appendfd = fd;
1347 fsync(fd);
1348 server.appendseldb = -1; /* Make sure it will issue SELECT */
1349 redisLog(REDIS_NOTICE,"The new append only file was selected for future appends.");
1350 } else {
1351 /* If append only is disabled we just generate a dump in this
1352 * format. Why not? */
1353 close(fd);
1354 }
1355 } else if (!bysignal && exitcode != 0) {
1356 redisLog(REDIS_WARNING, "Background append only file rewriting error");
1357 } else {
1358 redisLog(REDIS_WARNING,
1359 "Background append only file rewriting terminated by signal %d",
1360 WTERMSIG(statloc));
1361 }
1362 cleanup:
1363 sdsfree(server.bgrewritebuf);
1364 server.bgrewritebuf = sdsempty();
1365 aofRemoveTempFile(server.bgrewritechildpid);
1366 server.bgrewritechildpid = -1;
1367 }
1368
1369 /* This function is called once a background process of some kind terminates,
1370 * as we want to avoid resizing the hash tables when there is a child in order
1371 * to play well with copy-on-write (otherwise when a resize happens lots of
1372 * memory pages are copied). The goal of this function is to update the ability
1373 * for dict.c to resize the hash tables accordingly to the fact we have o not
1374 * running childs. */
1375 static void updateDictResizePolicy(void) {
1376 if (server.bgsavechildpid == -1 && server.bgrewritechildpid == -1)
1377 dictEnableResize();
1378 else
1379 dictDisableResize();
1380 }
1381
1382 static int serverCron(struct aeEventLoop *eventLoop, long long id, void *clientData) {
1383 int j, loops = server.cronloops++;
1384 REDIS_NOTUSED(eventLoop);
1385 REDIS_NOTUSED(id);
1386 REDIS_NOTUSED(clientData);
1387
1388 /* We take a cached value of the unix time in the global state because
1389 * with virtual memory and aging there is to store the current time
1390 * in objects at every object access, and accuracy is not needed.
1391 * To access a global var is faster than calling time(NULL) */
1392 server.unixtime = time(NULL);
1393
1394 /* Show some info about non-empty databases */
1395 for (j = 0; j < server.dbnum; j++) {
1396 long long size, used, vkeys;
1397
1398 size = dictSlots(server.db[j].dict);
1399 used = dictSize(server.db[j].dict);
1400 vkeys = dictSize(server.db[j].expires);
1401 if (!(loops % 50) && (used || vkeys)) {
1402 redisLog(REDIS_VERBOSE,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j,used,vkeys,size);
1403 /* dictPrintStats(server.dict); */
1404 }
1405 }
1406
1407 /* We don't want to resize the hash tables while a bacground saving
1408 * is in progress: the saving child is created using fork() that is
1409 * implemented with a copy-on-write semantic in most modern systems, so
1410 * if we resize the HT while there is the saving child at work actually
1411 * a lot of memory movements in the parent will cause a lot of pages
1412 * copied. */
1413 if (server.bgsavechildpid == -1 && server.bgrewritechildpid == -1) {
1414 if (!(loops % 10)) tryResizeHashTables();
1415 if (server.activerehashing) incrementallyRehash();
1416 }
1417
1418 /* Show information about connected clients */
1419 if (!(loops % 50)) {
1420 redisLog(REDIS_VERBOSE,"%d clients connected (%d slaves), %zu bytes in use",
1421 listLength(server.clients)-listLength(server.slaves),
1422 listLength(server.slaves),
1423 zmalloc_used_memory());
1424 }
1425
1426 /* Close connections of timedout clients */
1427 if ((server.maxidletime && !(loops % 100)) || server.blpop_blocked_clients)
1428 closeTimedoutClients();
1429
1430 /* Check if a background saving or AOF rewrite in progress terminated */
1431 if (server.bgsavechildpid != -1 || server.bgrewritechildpid != -1) {
1432 int statloc;
1433 pid_t pid;
1434
1435 if ((pid = wait3(&statloc,WNOHANG,NULL)) != 0) {
1436 if (pid == server.bgsavechildpid) {
1437 backgroundSaveDoneHandler(statloc);
1438 } else {
1439 backgroundRewriteDoneHandler(statloc);
1440 }
1441 updateDictResizePolicy();
1442 }
1443 } else {
1444 /* If there is not a background saving in progress check if
1445 * we have to save now */
1446 time_t now = time(NULL);
1447 for (j = 0; j < server.saveparamslen; j++) {
1448 struct saveparam *sp = server.saveparams+j;
1449
1450 if (server.dirty >= sp->changes &&
1451 now-server.lastsave > sp->seconds) {
1452 redisLog(REDIS_NOTICE,"%d changes in %d seconds. Saving...",
1453 sp->changes, sp->seconds);
1454 rdbSaveBackground(server.dbfilename);
1455 break;
1456 }
1457 }
1458 }
1459
1460 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1461 * will use few CPU cycles if there are few expiring keys, otherwise
1462 * it will get more aggressive to avoid that too much memory is used by
1463 * keys that can be removed from the keyspace. */
1464 for (j = 0; j < server.dbnum; j++) {
1465 int expired;
1466 redisDb *db = server.db+j;
1467
1468 /* Continue to expire if at the end of the cycle more than 25%
1469 * of the keys were expired. */
1470 do {
1471 long num = dictSize(db->expires);
1472 time_t now = time(NULL);
1473
1474 expired = 0;
1475 if (num > REDIS_EXPIRELOOKUPS_PER_CRON)
1476 num = REDIS_EXPIRELOOKUPS_PER_CRON;
1477 while (num--) {
1478 dictEntry *de;
1479 time_t t;
1480
1481 if ((de = dictGetRandomKey(db->expires)) == NULL) break;
1482 t = (time_t) dictGetEntryVal(de);
1483 if (now > t) {
1484 deleteKey(db,dictGetEntryKey(de));
1485 expired++;
1486 server.stat_expiredkeys++;
1487 }
1488 }
1489 } while (expired > REDIS_EXPIRELOOKUPS_PER_CRON/4);
1490 }
1491
1492 /* Swap a few keys on disk if we are over the memory limit and VM
1493 * is enbled. Try to free objects from the free list first. */
1494 if (vmCanSwapOut()) {
1495 while (server.vm_enabled && zmalloc_used_memory() >
1496 server.vm_max_memory)
1497 {
1498 int retval;
1499
1500 if (tryFreeOneObjectFromFreelist() == REDIS_OK) continue;
1501 retval = (server.vm_max_threads == 0) ?
1502 vmSwapOneObjectBlocking() :
1503 vmSwapOneObjectThreaded();
1504 if (retval == REDIS_ERR && !(loops % 300) &&
1505 zmalloc_used_memory() >
1506 (server.vm_max_memory+server.vm_max_memory/10))
1507 {
1508 redisLog(REDIS_WARNING,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1509 }
1510 /* Note that when using threade I/O we free just one object,
1511 * because anyway when the I/O thread in charge to swap this
1512 * object out will finish, the handler of completed jobs
1513 * will try to swap more objects if we are still out of memory. */
1514 if (retval == REDIS_ERR || server.vm_max_threads > 0) break;
1515 }
1516 }
1517
1518 /* Check if we should connect to a MASTER */
1519 if (server.replstate == REDIS_REPL_CONNECT && !(loops % 10)) {
1520 redisLog(REDIS_NOTICE,"Connecting to MASTER...");
1521 if (syncWithMaster() == REDIS_OK) {
1522 redisLog(REDIS_NOTICE,"MASTER <-> SLAVE sync succeeded");
1523 if (server.appendonly) rewriteAppendOnlyFileBackground();
1524 }
1525 }
1526 return 100;
1527 }
1528
1529 /* This function gets called every time Redis is entering the
1530 * main loop of the event driven library, that is, before to sleep
1531 * for ready file descriptors. */
1532 static void beforeSleep(struct aeEventLoop *eventLoop) {
1533 REDIS_NOTUSED(eventLoop);
1534
1535 /* Awake clients that got all the swapped keys they requested */
1536 if (server.vm_enabled && listLength(server.io_ready_clients)) {
1537 listIter li;
1538 listNode *ln;
1539
1540 listRewind(server.io_ready_clients,&li);
1541 while((ln = listNext(&li))) {
1542 redisClient *c = ln->value;
1543 struct redisCommand *cmd;
1544
1545 /* Resume the client. */
1546 listDelNode(server.io_ready_clients,ln);
1547 c->flags &= (~REDIS_IO_WAIT);
1548 server.vm_blocked_clients--;
1549 aeCreateFileEvent(server.el, c->fd, AE_READABLE,
1550 readQueryFromClient, c);
1551 cmd = lookupCommand(c->argv[0]->ptr);
1552 assert(cmd != NULL);
1553 call(c,cmd);
1554 resetClient(c);
1555 /* There may be more data to process in the input buffer. */
1556 if (c->querybuf && sdslen(c->querybuf) > 0)
1557 processInputBuffer(c);
1558 }
1559 }
1560 /* Write the AOF buffer on disk */
1561 flushAppendOnlyFile();
1562 }
1563
1564 static void createSharedObjects(void) {
1565 int j;
1566
1567 shared.crlf = createObject(REDIS_STRING,sdsnew("\r\n"));
1568 shared.ok = createObject(REDIS_STRING,sdsnew("+OK\r\n"));
1569 shared.err = createObject(REDIS_STRING,sdsnew("-ERR\r\n"));
1570 shared.emptybulk = createObject(REDIS_STRING,sdsnew("$0\r\n\r\n"));
1571 shared.czero = createObject(REDIS_STRING,sdsnew(":0\r\n"));
1572 shared.cone = createObject(REDIS_STRING,sdsnew(":1\r\n"));
1573 shared.nullbulk = createObject(REDIS_STRING,sdsnew("$-1\r\n"));
1574 shared.nullmultibulk = createObject(REDIS_STRING,sdsnew("*-1\r\n"));
1575 shared.emptymultibulk = createObject(REDIS_STRING,sdsnew("*0\r\n"));
1576 shared.pong = createObject(REDIS_STRING,sdsnew("+PONG\r\n"));
1577 shared.queued = createObject(REDIS_STRING,sdsnew("+QUEUED\r\n"));
1578 shared.wrongtypeerr = createObject(REDIS_STRING,sdsnew(
1579 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1580 shared.nokeyerr = createObject(REDIS_STRING,sdsnew(
1581 "-ERR no such key\r\n"));
1582 shared.syntaxerr = createObject(REDIS_STRING,sdsnew(
1583 "-ERR syntax error\r\n"));
1584 shared.sameobjecterr = createObject(REDIS_STRING,sdsnew(
1585 "-ERR source and destination objects are the same\r\n"));
1586 shared.outofrangeerr = createObject(REDIS_STRING,sdsnew(
1587 "-ERR index out of range\r\n"));
1588 shared.space = createObject(REDIS_STRING,sdsnew(" "));
1589 shared.colon = createObject(REDIS_STRING,sdsnew(":"));
1590 shared.plus = createObject(REDIS_STRING,sdsnew("+"));
1591 shared.select0 = createStringObject("select 0\r\n",10);
1592 shared.select1 = createStringObject("select 1\r\n",10);
1593 shared.select2 = createStringObject("select 2\r\n",10);
1594 shared.select3 = createStringObject("select 3\r\n",10);
1595 shared.select4 = createStringObject("select 4\r\n",10);
1596 shared.select5 = createStringObject("select 5\r\n",10);
1597 shared.select6 = createStringObject("select 6\r\n",10);
1598 shared.select7 = createStringObject("select 7\r\n",10);
1599 shared.select8 = createStringObject("select 8\r\n",10);
1600 shared.select9 = createStringObject("select 9\r\n",10);
1601 shared.messagebulk = createStringObject("$7\r\nmessage\r\n",13);
1602 shared.pmessagebulk = createStringObject("$8\r\npmessage\r\n",14);
1603 shared.subscribebulk = createStringObject("$9\r\nsubscribe\r\n",15);
1604 shared.unsubscribebulk = createStringObject("$11\r\nunsubscribe\r\n",18);
1605 shared.psubscribebulk = createStringObject("$10\r\npsubscribe\r\n",17);
1606 shared.punsubscribebulk = createStringObject("$12\r\npunsubscribe\r\n",19);
1607 shared.mbulk3 = createStringObject("*3\r\n",4);
1608 shared.mbulk4 = createStringObject("*4\r\n",4);
1609 for (j = 0; j < REDIS_SHARED_INTEGERS; j++) {
1610 shared.integers[j] = createObject(REDIS_STRING,(void*)(long)j);
1611 shared.integers[j]->encoding = REDIS_ENCODING_INT;
1612 }
1613 }
1614
1615 static void appendServerSaveParams(time_t seconds, int changes) {
1616 server.saveparams = zrealloc(server.saveparams,sizeof(struct saveparam)*(server.saveparamslen+1));
1617 server.saveparams[server.saveparamslen].seconds = seconds;
1618 server.saveparams[server.saveparamslen].changes = changes;
1619 server.saveparamslen++;
1620 }
1621
1622 static void resetServerSaveParams() {
1623 zfree(server.saveparams);
1624 server.saveparams = NULL;
1625 server.saveparamslen = 0;
1626 }
1627
1628 static void initServerConfig() {
1629 server.dbnum = REDIS_DEFAULT_DBNUM;
1630 server.port = REDIS_SERVERPORT;
1631 server.verbosity = REDIS_VERBOSE;
1632 server.maxidletime = REDIS_MAXIDLETIME;
1633 server.saveparams = NULL;
1634 server.logfile = NULL; /* NULL = log on standard output */
1635 server.bindaddr = NULL;
1636 server.glueoutputbuf = 1;
1637 server.daemonize = 0;
1638 server.appendonly = 0;
1639 server.appendfsync = APPENDFSYNC_EVERYSEC;
1640 server.lastfsync = time(NULL);
1641 server.appendfd = -1;
1642 server.appendseldb = -1; /* Make sure the first time will not match */
1643 server.pidfile = zstrdup("/var/run/redis.pid");
1644 server.dbfilename = zstrdup("dump.rdb");
1645 server.appendfilename = zstrdup("appendonly.aof");
1646 server.requirepass = NULL;
1647 server.rdbcompression = 1;
1648 server.activerehashing = 1;
1649 server.maxclients = 0;
1650 server.blpop_blocked_clients = 0;
1651 server.maxmemory = 0;
1652 server.vm_enabled = 0;
1653 server.vm_swap_file = zstrdup("/tmp/redis-%p.vm");
1654 server.vm_page_size = 256; /* 256 bytes per page */
1655 server.vm_pages = 1024*1024*100; /* 104 millions of pages */
1656 server.vm_max_memory = 1024LL*1024*1024*1; /* 1 GB of RAM */
1657 server.vm_max_threads = 4;
1658 server.vm_blocked_clients = 0;
1659 server.hash_max_zipmap_entries = REDIS_HASH_MAX_ZIPMAP_ENTRIES;
1660 server.hash_max_zipmap_value = REDIS_HASH_MAX_ZIPMAP_VALUE;
1661
1662 resetServerSaveParams();
1663
1664 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1665 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1666 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1667 /* Replication related */
1668 server.isslave = 0;
1669 server.masterauth = NULL;
1670 server.masterhost = NULL;
1671 server.masterport = 6379;
1672 server.master = NULL;
1673 server.replstate = REDIS_REPL_NONE;
1674
1675 /* Double constants initialization */
1676 R_Zero = 0.0;
1677 R_PosInf = 1.0/R_Zero;
1678 R_NegInf = -1.0/R_Zero;
1679 R_Nan = R_Zero/R_Zero;
1680 }
1681
1682 static void initServer() {
1683 int j;
1684
1685 signal(SIGHUP, SIG_IGN);
1686 signal(SIGPIPE, SIG_IGN);
1687 setupSigSegvAction();
1688
1689 server.devnull = fopen("/dev/null","w");
1690 if (server.devnull == NULL) {
1691 redisLog(REDIS_WARNING, "Can't open /dev/null: %s", server.neterr);
1692 exit(1);
1693 }
1694 server.clients = listCreate();
1695 server.slaves = listCreate();
1696 server.monitors = listCreate();
1697 server.objfreelist = listCreate();
1698 createSharedObjects();
1699 server.el = aeCreateEventLoop();
1700 server.db = zmalloc(sizeof(redisDb)*server.dbnum);
1701 server.fd = anetTcpServer(server.neterr, server.port, server.bindaddr);
1702 if (server.fd == -1) {
1703 redisLog(REDIS_WARNING, "Opening TCP port: %s", server.neterr);
1704 exit(1);
1705 }
1706 for (j = 0; j < server.dbnum; j++) {
1707 server.db[j].dict = dictCreate(&dbDictType,NULL);
1708 server.db[j].expires = dictCreate(&keyptrDictType,NULL);
1709 server.db[j].blockingkeys = dictCreate(&keylistDictType,NULL);
1710 if (server.vm_enabled)
1711 server.db[j].io_keys = dictCreate(&keylistDictType,NULL);
1712 server.db[j].id = j;
1713 }
1714 server.pubsub_channels = dictCreate(&keylistDictType,NULL);
1715 server.pubsub_patterns = listCreate();
1716 listSetFreeMethod(server.pubsub_patterns,freePubsubPattern);
1717 listSetMatchMethod(server.pubsub_patterns,listMatchPubsubPattern);
1718 server.cronloops = 0;
1719 server.bgsavechildpid = -1;
1720 server.bgrewritechildpid = -1;
1721 server.bgrewritebuf = sdsempty();
1722 server.aofbuf = sdsempty();
1723 server.lastsave = time(NULL);
1724 server.dirty = 0;
1725 server.stat_numcommands = 0;
1726 server.stat_numconnections = 0;
1727 server.stat_expiredkeys = 0;
1728 server.stat_starttime = time(NULL);
1729 server.unixtime = time(NULL);
1730 aeCreateTimeEvent(server.el, 1, serverCron, NULL, NULL);
1731 if (aeCreateFileEvent(server.el, server.fd, AE_READABLE,
1732 acceptHandler, NULL) == AE_ERR) oom("creating file event");
1733
1734 if (server.appendonly) {
1735 server.appendfd = open(server.appendfilename,O_WRONLY|O_APPEND|O_CREAT,0644);
1736 if (server.appendfd == -1) {
1737 redisLog(REDIS_WARNING, "Can't open the append-only file: %s",
1738 strerror(errno));
1739 exit(1);
1740 }
1741 }
1742
1743 if (server.vm_enabled) vmInit();
1744 }
1745
1746 /* Empty the whole database */
1747 static long long emptyDb() {
1748 int j;
1749 long long removed = 0;
1750
1751 for (j = 0; j < server.dbnum; j++) {
1752 removed += dictSize(server.db[j].dict);
1753 dictEmpty(server.db[j].dict);
1754 dictEmpty(server.db[j].expires);
1755 }
1756 return removed;
1757 }
1758
1759 static int yesnotoi(char *s) {
1760 if (!strcasecmp(s,"yes")) return 1;
1761 else if (!strcasecmp(s,"no")) return 0;
1762 else return -1;
1763 }
1764
1765 /* I agree, this is a very rudimental way to load a configuration...
1766 will improve later if the config gets more complex */
1767 static void loadServerConfig(char *filename) {
1768 FILE *fp;
1769 char buf[REDIS_CONFIGLINE_MAX+1], *err = NULL;
1770 int linenum = 0;
1771 sds line = NULL;
1772
1773 if (filename[0] == '-' && filename[1] == '\0')
1774 fp = stdin;
1775 else {
1776 if ((fp = fopen(filename,"r")) == NULL) {
1777 redisLog(REDIS_WARNING, "Fatal error, can't open config file '%s'", filename);
1778 exit(1);
1779 }
1780 }
1781
1782 while(fgets(buf,REDIS_CONFIGLINE_MAX+1,fp) != NULL) {
1783 sds *argv;
1784 int argc, j;
1785
1786 linenum++;
1787 line = sdsnew(buf);
1788 line = sdstrim(line," \t\r\n");
1789
1790 /* Skip comments and blank lines*/
1791 if (line[0] == '#' || line[0] == '\0') {
1792 sdsfree(line);
1793 continue;
1794 }
1795
1796 /* Split into arguments */
1797 argv = sdssplitlen(line,sdslen(line)," ",1,&argc);
1798 sdstolower(argv[0]);
1799
1800 /* Execute config directives */
1801 if (!strcasecmp(argv[0],"timeout") && argc == 2) {
1802 server.maxidletime = atoi(argv[1]);
1803 if (server.maxidletime < 0) {
1804 err = "Invalid timeout value"; goto loaderr;
1805 }
1806 } else if (!strcasecmp(argv[0],"port") && argc == 2) {
1807 server.port = atoi(argv[1]);
1808 if (server.port < 1 || server.port > 65535) {
1809 err = "Invalid port"; goto loaderr;
1810 }
1811 } else if (!strcasecmp(argv[0],"bind") && argc == 2) {
1812 server.bindaddr = zstrdup(argv[1]);
1813 } else if (!strcasecmp(argv[0],"save") && argc == 3) {
1814 int seconds = atoi(argv[1]);
1815 int changes = atoi(argv[2]);
1816 if (seconds < 1 || changes < 0) {
1817 err = "Invalid save parameters"; goto loaderr;
1818 }
1819 appendServerSaveParams(seconds,changes);
1820 } else if (!strcasecmp(argv[0],"dir") && argc == 2) {
1821 if (chdir(argv[1]) == -1) {
1822 redisLog(REDIS_WARNING,"Can't chdir to '%s': %s",
1823 argv[1], strerror(errno));
1824 exit(1);
1825 }
1826 } else if (!strcasecmp(argv[0],"loglevel") && argc == 2) {
1827 if (!strcasecmp(argv[1],"debug")) server.verbosity = REDIS_DEBUG;
1828 else if (!strcasecmp(argv[1],"verbose")) server.verbosity = REDIS_VERBOSE;
1829 else if (!strcasecmp(argv[1],"notice")) server.verbosity = REDIS_NOTICE;
1830 else if (!strcasecmp(argv[1],"warning")) server.verbosity = REDIS_WARNING;
1831 else {
1832 err = "Invalid log level. Must be one of debug, notice, warning";
1833 goto loaderr;
1834 }
1835 } else if (!strcasecmp(argv[0],"logfile") && argc == 2) {
1836 FILE *logfp;
1837
1838 server.logfile = zstrdup(argv[1]);
1839 if (!strcasecmp(server.logfile,"stdout")) {
1840 zfree(server.logfile);
1841 server.logfile = NULL;
1842 }
1843 if (server.logfile) {
1844 /* Test if we are able to open the file. The server will not
1845 * be able to abort just for this problem later... */
1846 logfp = fopen(server.logfile,"a");
1847 if (logfp == NULL) {
1848 err = sdscatprintf(sdsempty(),
1849 "Can't open the log file: %s", strerror(errno));
1850 goto loaderr;
1851 }
1852 fclose(logfp);
1853 }
1854 } else if (!strcasecmp(argv[0],"databases") && argc == 2) {
1855 server.dbnum = atoi(argv[1]);
1856 if (server.dbnum < 1) {
1857 err = "Invalid number of databases"; goto loaderr;
1858 }
1859 } else if (!strcasecmp(argv[0],"include") && argc == 2) {
1860 loadServerConfig(argv[1]);
1861 } else if (!strcasecmp(argv[0],"maxclients") && argc == 2) {
1862 server.maxclients = atoi(argv[1]);
1863 } else if (!strcasecmp(argv[0],"maxmemory") && argc == 2) {
1864 server.maxmemory = memtoll(argv[1],NULL);
1865 } else if (!strcasecmp(argv[0],"slaveof") && argc == 3) {
1866 server.masterhost = sdsnew(argv[1]);
1867 server.masterport = atoi(argv[2]);
1868 server.replstate = REDIS_REPL_CONNECT;
1869 } else if (!strcasecmp(argv[0],"masterauth") && argc == 2) {
1870 server.masterauth = zstrdup(argv[1]);
1871 } else if (!strcasecmp(argv[0],"glueoutputbuf") && argc == 2) {
1872 if ((server.glueoutputbuf = yesnotoi(argv[1])) == -1) {
1873 err = "argument must be 'yes' or 'no'"; goto loaderr;
1874 }
1875 } else if (!strcasecmp(argv[0],"rdbcompression") && argc == 2) {
1876 if ((server.rdbcompression = yesnotoi(argv[1])) == -1) {
1877 err = "argument must be 'yes' or 'no'"; goto loaderr;
1878 }
1879 } else if (!strcasecmp(argv[0],"activerehashing") && argc == 2) {
1880 if ((server.activerehashing = yesnotoi(argv[1])) == -1) {
1881 err = "argument must be 'yes' or 'no'"; goto loaderr;
1882 }
1883 } else if (!strcasecmp(argv[0],"daemonize") && argc == 2) {
1884 if ((server.daemonize = yesnotoi(argv[1])) == -1) {
1885 err = "argument must be 'yes' or 'no'"; goto loaderr;
1886 }
1887 } else if (!strcasecmp(argv[0],"appendonly") && argc == 2) {
1888 if ((server.appendonly = yesnotoi(argv[1])) == -1) {
1889 err = "argument must be 'yes' or 'no'"; goto loaderr;
1890 }
1891 } else if (!strcasecmp(argv[0],"appendfsync") && argc == 2) {
1892 if (!strcasecmp(argv[1],"no")) {
1893 server.appendfsync = APPENDFSYNC_NO;
1894 } else if (!strcasecmp(argv[1],"always")) {
1895 server.appendfsync = APPENDFSYNC_ALWAYS;
1896 } else if (!strcasecmp(argv[1],"everysec")) {
1897 server.appendfsync = APPENDFSYNC_EVERYSEC;
1898 } else {
1899 err = "argument must be 'no', 'always' or 'everysec'";
1900 goto loaderr;
1901 }
1902 } else if (!strcasecmp(argv[0],"requirepass") && argc == 2) {
1903 server.requirepass = zstrdup(argv[1]);
1904 } else if (!strcasecmp(argv[0],"pidfile") && argc == 2) {
1905 zfree(server.pidfile);
1906 server.pidfile = zstrdup(argv[1]);
1907 } else if (!strcasecmp(argv[0],"dbfilename") && argc == 2) {
1908 zfree(server.dbfilename);
1909 server.dbfilename = zstrdup(argv[1]);
1910 } else if (!strcasecmp(argv[0],"vm-enabled") && argc == 2) {
1911 if ((server.vm_enabled = yesnotoi(argv[1])) == -1) {
1912 err = "argument must be 'yes' or 'no'"; goto loaderr;
1913 }
1914 } else if (!strcasecmp(argv[0],"vm-swap-file") && argc == 2) {
1915 zfree(server.vm_swap_file);
1916 server.vm_swap_file = zstrdup(argv[1]);
1917 } else if (!strcasecmp(argv[0],"vm-max-memory") && argc == 2) {
1918 server.vm_max_memory = memtoll(argv[1],NULL);
1919 } else if (!strcasecmp(argv[0],"vm-page-size") && argc == 2) {
1920 server.vm_page_size = memtoll(argv[1], NULL);
1921 } else if (!strcasecmp(argv[0],"vm-pages") && argc == 2) {
1922 server.vm_pages = memtoll(argv[1], NULL);
1923 } else if (!strcasecmp(argv[0],"vm-max-threads") && argc == 2) {
1924 server.vm_max_threads = strtoll(argv[1], NULL, 10);
1925 } else if (!strcasecmp(argv[0],"hash-max-zipmap-entries") && argc == 2){
1926 server.hash_max_zipmap_entries = memtoll(argv[1], NULL);
1927 } else if (!strcasecmp(argv[0],"hash-max-zipmap-value") && argc == 2){
1928 server.hash_max_zipmap_value = memtoll(argv[1], NULL);
1929 } else {
1930 err = "Bad directive or wrong number of arguments"; goto loaderr;
1931 }
1932 for (j = 0; j < argc; j++)
1933 sdsfree(argv[j]);
1934 zfree(argv);
1935 sdsfree(line);
1936 }
1937 if (fp != stdin) fclose(fp);
1938 return;
1939
1940 loaderr:
1941 fprintf(stderr, "\n*** FATAL CONFIG FILE ERROR ***\n");
1942 fprintf(stderr, "Reading the configuration file, at line %d\n", linenum);
1943 fprintf(stderr, ">>> '%s'\n", line);
1944 fprintf(stderr, "%s\n", err);
1945 exit(1);
1946 }
1947
1948 static void freeClientArgv(redisClient *c) {
1949 int j;
1950
1951 for (j = 0; j < c->argc; j++)
1952 decrRefCount(c->argv[j]);
1953 for (j = 0; j < c->mbargc; j++)
1954 decrRefCount(c->mbargv[j]);
1955 c->argc = 0;
1956 c->mbargc = 0;
1957 }
1958
1959 static void freeClient(redisClient *c) {
1960 listNode *ln;
1961
1962 /* Note that if the client we are freeing is blocked into a blocking
1963 * call, we have to set querybuf to NULL *before* to call
1964 * unblockClientWaitingData() to avoid processInputBuffer() will get
1965 * called. Also it is important to remove the file events after
1966 * this, because this call adds the READABLE event. */
1967 sdsfree(c->querybuf);
1968 c->querybuf = NULL;
1969 if (c->flags & REDIS_BLOCKED)
1970 unblockClientWaitingData(c);
1971
1972 /* Unsubscribe from all the pubsub channels */
1973 pubsubUnsubscribeAllChannels(c,0);
1974 pubsubUnsubscribeAllPatterns(c,0);
1975 dictRelease(c->pubsub_channels);
1976 listRelease(c->pubsub_patterns);
1977 /* Obvious cleanup */
1978 aeDeleteFileEvent(server.el,c->fd,AE_READABLE);
1979 aeDeleteFileEvent(server.el,c->fd,AE_WRITABLE);
1980 listRelease(c->reply);
1981 freeClientArgv(c);
1982 close(c->fd);
1983 /* Remove from the list of clients */
1984 ln = listSearchKey(server.clients,c);
1985 redisAssert(ln != NULL);
1986 listDelNode(server.clients,ln);
1987 /* Remove from the list of clients waiting for swapped keys */
1988 if (c->flags & REDIS_IO_WAIT && listLength(c->io_keys) == 0) {
1989 ln = listSearchKey(server.io_ready_clients,c);
1990 if (ln) {
1991 listDelNode(server.io_ready_clients,ln);
1992 server.vm_blocked_clients--;
1993 }
1994 }
1995 while (server.vm_enabled && listLength(c->io_keys)) {
1996 ln = listFirst(c->io_keys);
1997 dontWaitForSwappedKey(c,ln->value);
1998 }
1999 listRelease(c->io_keys);
2000 /* Master/slave cleanup */
2001 if (c->flags & REDIS_SLAVE) {
2002 if (c->replstate == REDIS_REPL_SEND_BULK && c->repldbfd != -1)
2003 close(c->repldbfd);
2004 list *l = (c->flags & REDIS_MONITOR) ? server.monitors : server.slaves;
2005 ln = listSearchKey(l,c);
2006 redisAssert(ln != NULL);
2007 listDelNode(l,ln);
2008 }
2009 if (c->flags & REDIS_MASTER) {
2010 server.master = NULL;
2011 server.replstate = REDIS_REPL_CONNECT;
2012 }
2013 /* Release memory */
2014 zfree(c->argv);
2015 zfree(c->mbargv);
2016 freeClientMultiState(c);
2017 zfree(c);
2018 }
2019
2020 #define GLUEREPLY_UP_TO (1024)
2021 static void glueReplyBuffersIfNeeded(redisClient *c) {
2022 int copylen = 0;
2023 char buf[GLUEREPLY_UP_TO];
2024 listNode *ln;
2025 listIter li;
2026 robj *o;
2027
2028 listRewind(c->reply,&li);
2029 while((ln = listNext(&li))) {
2030 int objlen;
2031
2032 o = ln->value;
2033 objlen = sdslen(o->ptr);
2034 if (copylen + objlen <= GLUEREPLY_UP_TO) {
2035 memcpy(buf+copylen,o->ptr,objlen);
2036 copylen += objlen;
2037 listDelNode(c->reply,ln);
2038 } else {
2039 if (copylen == 0) return;
2040 break;
2041 }
2042 }
2043 /* Now the output buffer is empty, add the new single element */
2044 o = createObject(REDIS_STRING,sdsnewlen(buf,copylen));
2045 listAddNodeHead(c->reply,o);
2046 }
2047
2048 static void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask) {
2049 redisClient *c = privdata;
2050 int nwritten = 0, totwritten = 0, objlen;
2051 robj *o;
2052 REDIS_NOTUSED(el);
2053 REDIS_NOTUSED(mask);
2054
2055 /* Use writev() if we have enough buffers to send */
2056 if (!server.glueoutputbuf &&
2057 listLength(c->reply) > REDIS_WRITEV_THRESHOLD &&
2058 !(c->flags & REDIS_MASTER))
2059 {
2060 sendReplyToClientWritev(el, fd, privdata, mask);
2061 return;
2062 }
2063
2064 while(listLength(c->reply)) {
2065 if (server.glueoutputbuf && listLength(c->reply) > 1)
2066 glueReplyBuffersIfNeeded(c);
2067
2068 o = listNodeValue(listFirst(c->reply));
2069 objlen = sdslen(o->ptr);
2070
2071 if (objlen == 0) {
2072 listDelNode(c->reply,listFirst(c->reply));
2073 continue;
2074 }
2075
2076 if (c->flags & REDIS_MASTER) {
2077 /* Don't reply to a master */
2078 nwritten = objlen - c->sentlen;
2079 } else {
2080 nwritten = write(fd, ((char*)o->ptr)+c->sentlen, objlen - c->sentlen);
2081 if (nwritten <= 0) break;
2082 }
2083 c->sentlen += nwritten;
2084 totwritten += nwritten;
2085 /* If we fully sent the object on head go to the next one */
2086 if (c->sentlen == objlen) {
2087 listDelNode(c->reply,listFirst(c->reply));
2088 c->sentlen = 0;
2089 }
2090 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
2091 * bytes, in a single threaded server it's a good idea to serve
2092 * other clients as well, even if a very large request comes from
2093 * super fast link that is always able to accept data (in real world
2094 * scenario think about 'KEYS *' against the loopback interfae) */
2095 if (totwritten > REDIS_MAX_WRITE_PER_EVENT) break;
2096 }
2097 if (nwritten == -1) {
2098 if (errno == EAGAIN) {
2099 nwritten = 0;
2100 } else {
2101 redisLog(REDIS_VERBOSE,
2102 "Error writing to client: %s", strerror(errno));
2103 freeClient(c);
2104 return;
2105 }
2106 }
2107 if (totwritten > 0) c->lastinteraction = time(NULL);
2108 if (listLength(c->reply) == 0) {
2109 c->sentlen = 0;
2110 aeDeleteFileEvent(server.el,c->fd,AE_WRITABLE);
2111 }
2112 }
2113
2114 static void sendReplyToClientWritev(aeEventLoop *el, int fd, void *privdata, int mask)
2115 {
2116 redisClient *c = privdata;
2117 int nwritten = 0, totwritten = 0, objlen, willwrite;
2118 robj *o;
2119 struct iovec iov[REDIS_WRITEV_IOVEC_COUNT];
2120 int offset, ion = 0;
2121 REDIS_NOTUSED(el);
2122 REDIS_NOTUSED(mask);
2123
2124 listNode *node;
2125 while (listLength(c->reply)) {
2126 offset = c->sentlen;
2127 ion = 0;
2128 willwrite = 0;
2129
2130 /* fill-in the iov[] array */
2131 for(node = listFirst(c->reply); node; node = listNextNode(node)) {
2132 o = listNodeValue(node);
2133 objlen = sdslen(o->ptr);
2134
2135 if (totwritten + objlen - offset > REDIS_MAX_WRITE_PER_EVENT)
2136 break;
2137
2138 if(ion == REDIS_WRITEV_IOVEC_COUNT)
2139 break; /* no more iovecs */
2140
2141 iov[ion].iov_base = ((char*)o->ptr) + offset;
2142 iov[ion].iov_len = objlen - offset;
2143 willwrite += objlen - offset;
2144 offset = 0; /* just for the first item */
2145 ion++;
2146 }
2147
2148 if(willwrite == 0)
2149 break;
2150
2151 /* write all collected blocks at once */
2152 if((nwritten = writev(fd, iov, ion)) < 0) {
2153 if (errno != EAGAIN) {
2154 redisLog(REDIS_VERBOSE,
2155 "Error writing to client: %s", strerror(errno));
2156 freeClient(c);
2157 return;
2158 }
2159 break;
2160 }
2161
2162 totwritten += nwritten;
2163 offset = c->sentlen;
2164
2165 /* remove written robjs from c->reply */
2166 while (nwritten && listLength(c->reply)) {
2167 o = listNodeValue(listFirst(c->reply));
2168 objlen = sdslen(o->ptr);
2169
2170 if(nwritten >= objlen - offset) {
2171 listDelNode(c->reply, listFirst(c->reply));
2172 nwritten -= objlen - offset;
2173 c->sentlen = 0;
2174 } else {
2175 /* partial write */
2176 c->sentlen += nwritten;
2177 break;
2178 }
2179 offset = 0;
2180 }
2181 }
2182
2183 if (totwritten > 0)
2184 c->lastinteraction = time(NULL);
2185
2186 if (listLength(c->reply) == 0) {
2187 c->sentlen = 0;
2188 aeDeleteFileEvent(server.el,c->fd,AE_WRITABLE);
2189 }
2190 }
2191
2192 static struct redisCommand *lookupCommand(char *name) {
2193 int j = 0;
2194 while(cmdTable[j].name != NULL) {
2195 if (!strcasecmp(name,cmdTable[j].name)) return &cmdTable[j];
2196 j++;
2197 }
2198 return NULL;
2199 }
2200
2201 /* resetClient prepare the client to process the next command */
2202 static void resetClient(redisClient *c) {
2203 freeClientArgv(c);
2204 c->bulklen = -1;
2205 c->multibulk = 0;
2206 }
2207
2208 /* Call() is the core of Redis execution of a command */
2209 static void call(redisClient *c, struct redisCommand *cmd) {
2210 long long dirty;
2211
2212 dirty = server.dirty;
2213 cmd->proc(c);
2214 dirty = server.dirty-dirty;
2215
2216 if (server.appendonly && dirty)
2217 feedAppendOnlyFile(cmd,c->db->id,c->argv,c->argc);
2218 if ((dirty || cmd->flags & REDIS_CMD_FORCE_REPLICATION) &&
2219 listLength(server.slaves))
2220 replicationFeedSlaves(server.slaves,c->db->id,c->argv,c->argc);
2221 if (listLength(server.monitors))
2222 replicationFeedMonitors(server.monitors,c->db->id,c->argv,c->argc);
2223 server.stat_numcommands++;
2224 }
2225
2226 /* If this function gets called we already read a whole
2227 * command, argments are in the client argv/argc fields.
2228 * processCommand() execute the command or prepare the
2229 * server for a bulk read from the client.
2230 *
2231 * If 1 is returned the client is still alive and valid and
2232 * and other operations can be performed by the caller. Otherwise
2233 * if 0 is returned the client was destroied (i.e. after QUIT). */
2234 static int processCommand(redisClient *c) {
2235 struct redisCommand *cmd;
2236
2237 /* Free some memory if needed (maxmemory setting) */
2238 if (server.maxmemory) freeMemoryIfNeeded();
2239
2240 /* Handle the multi bulk command type. This is an alternative protocol
2241 * supported by Redis in order to receive commands that are composed of
2242 * multiple binary-safe "bulk" arguments. The latency of processing is
2243 * a bit higher but this allows things like multi-sets, so if this
2244 * protocol is used only for MSET and similar commands this is a big win. */
2245 if (c->multibulk == 0 && c->argc == 1 && ((char*)(c->argv[0]->ptr))[0] == '*') {
2246 c->multibulk = atoi(((char*)c->argv[0]->ptr)+1);
2247 if (c->multibulk <= 0) {
2248 resetClient(c);
2249 return 1;
2250 } else {
2251 decrRefCount(c->argv[c->argc-1]);
2252 c->argc--;
2253 return 1;
2254 }
2255 } else if (c->multibulk) {
2256 if (c->bulklen == -1) {
2257 if (((char*)c->argv[0]->ptr)[0] != '$') {
2258 addReplySds(c,sdsnew("-ERR multi bulk protocol error\r\n"));
2259 resetClient(c);
2260 return 1;
2261 } else {
2262 int bulklen = atoi(((char*)c->argv[0]->ptr)+1);
2263 decrRefCount(c->argv[0]);
2264 if (bulklen < 0 || bulklen > 1024*1024*1024) {
2265 c->argc--;
2266 addReplySds(c,sdsnew("-ERR invalid bulk write count\r\n"));
2267 resetClient(c);
2268 return 1;
2269 }
2270 c->argc--;
2271 c->bulklen = bulklen+2; /* add two bytes for CR+LF */
2272 return 1;
2273 }
2274 } else {
2275 c->mbargv = zrealloc(c->mbargv,(sizeof(robj*))*(c->mbargc+1));
2276 c->mbargv[c->mbargc] = c->argv[0];
2277 c->mbargc++;
2278 c->argc--;
2279 c->multibulk--;
2280 if (c->multibulk == 0) {
2281 robj **auxargv;
2282 int auxargc;
2283
2284 /* Here we need to swap the multi-bulk argc/argv with the
2285 * normal argc/argv of the client structure. */
2286 auxargv = c->argv;
2287 c->argv = c->mbargv;
2288 c->mbargv = auxargv;
2289
2290 auxargc = c->argc;
2291 c->argc = c->mbargc;
2292 c->mbargc = auxargc;
2293
2294 /* We need to set bulklen to something different than -1
2295 * in order for the code below to process the command without
2296 * to try to read the last argument of a bulk command as
2297 * a special argument. */
2298 c->bulklen = 0;
2299 /* continue below and process the command */
2300 } else {
2301 c->bulklen = -1;
2302 return 1;
2303 }
2304 }
2305 }
2306 /* -- end of multi bulk commands processing -- */
2307
2308 /* The QUIT command is handled as a special case. Normal command
2309 * procs are unable to close the client connection safely */
2310 if (!strcasecmp(c->argv[0]->ptr,"quit")) {
2311 freeClient(c);
2312 return 0;
2313 }
2314
2315 /* Now lookup the command and check ASAP about trivial error conditions
2316 * such wrong arity, bad command name and so forth. */
2317 cmd = lookupCommand(c->argv[0]->ptr);
2318 if (!cmd) {
2319 addReplySds(c,
2320 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2321 (char*)c->argv[0]->ptr));
2322 resetClient(c);
2323 return 1;
2324 } else if ((cmd->arity > 0 && cmd->arity != c->argc) ||
2325 (c->argc < -cmd->arity)) {
2326 addReplySds(c,
2327 sdscatprintf(sdsempty(),
2328 "-ERR wrong number of arguments for '%s' command\r\n",
2329 cmd->name));
2330 resetClient(c);
2331 return 1;
2332 } else if (cmd->flags & REDIS_CMD_BULK && c->bulklen == -1) {
2333 /* This is a bulk command, we have to read the last argument yet. */
2334 int bulklen = atoi(c->argv[c->argc-1]->ptr);
2335
2336 decrRefCount(c->argv[c->argc-1]);
2337 if (bulklen < 0 || bulklen > 1024*1024*1024) {
2338 c->argc--;
2339 addReplySds(c,sdsnew("-ERR invalid bulk write count\r\n"));
2340 resetClient(c);
2341 return 1;
2342 }
2343 c->argc--;
2344 c->bulklen = bulklen+2; /* add two bytes for CR+LF */
2345 /* It is possible that the bulk read is already in the
2346 * buffer. Check this condition and handle it accordingly.
2347 * This is just a fast path, alternative to call processInputBuffer().
2348 * It's a good idea since the code is small and this condition
2349 * happens most of the times. */
2350 if ((signed)sdslen(c->querybuf) >= c->bulklen) {
2351 c->argv[c->argc] = createStringObject(c->querybuf,c->bulklen-2);
2352 c->argc++;
2353 c->querybuf = sdsrange(c->querybuf,c->bulklen,-1);
2354 } else {
2355 /* Otherwise return... there is to read the last argument
2356 * from the socket. */
2357 return 1;
2358 }
2359 }
2360 /* Let's try to encode the bulk object to save space. */
2361 if (cmd->flags & REDIS_CMD_BULK)
2362 c->argv[c->argc-1] = tryObjectEncoding(c->argv[c->argc-1]);
2363
2364 /* Check if the user is authenticated */
2365 if (server.requirepass && !c->authenticated && cmd->proc != authCommand) {
2366 addReplySds(c,sdsnew("-ERR operation not permitted\r\n"));
2367 resetClient(c);
2368 return 1;
2369 }
2370
2371 /* Handle the maxmemory directive */
2372 if (server.maxmemory && (cmd->flags & REDIS_CMD_DENYOOM) &&
2373 zmalloc_used_memory() > server.maxmemory)
2374 {
2375 addReplySds(c,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2376 resetClient(c);
2377 return 1;
2378 }
2379
2380 /* Only allow SUBSCRIBE and UNSUBSCRIBE in the context of Pub/Sub */
2381 if ((dictSize(c->pubsub_channels) > 0 || listLength(c->pubsub_patterns) > 0)
2382 &&
2383 cmd->proc != subscribeCommand && cmd->proc != unsubscribeCommand &&
2384 cmd->proc != psubscribeCommand && cmd->proc != punsubscribeCommand) {
2385 addReplySds(c,sdsnew("-ERR only (P)SUBSCRIBE / (P)UNSUBSCRIBE / QUIT allowed in this context\r\n"));
2386 resetClient(c);
2387 return 1;
2388 }
2389
2390 /* Exec the command */
2391 if (c->flags & REDIS_MULTI && cmd->proc != execCommand && cmd->proc != discardCommand) {
2392 queueMultiCommand(c,cmd);
2393 addReply(c,shared.queued);
2394 } else {
2395 if (server.vm_enabled && server.vm_max_threads > 0 &&
2396 blockClientOnSwappedKeys(cmd,c)) return 1;
2397 call(c,cmd);
2398 }
2399
2400 /* Prepare the client for the next command */
2401 resetClient(c);
2402 return 1;
2403 }
2404
2405 static void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc) {
2406 listNode *ln;
2407 listIter li;
2408 int outc = 0, j;
2409 robj **outv;
2410 /* We need 1+(ARGS*3) objects since commands are using the new protocol
2411 * and we one 1 object for the first "*<count>\r\n" multibulk count, then
2412 * for every additional object we have "$<count>\r\n" + object + "\r\n". */
2413 robj *static_outv[REDIS_STATIC_ARGS*3+1];
2414 robj *lenobj;
2415
2416 if (argc <= REDIS_STATIC_ARGS) {
2417 outv = static_outv;
2418 } else {
2419 outv = zmalloc(sizeof(robj*)*(argc*3+1));
2420 }
2421
2422 lenobj = createObject(REDIS_STRING,
2423 sdscatprintf(sdsempty(), "*%d\r\n", argc));
2424 lenobj->refcount = 0;
2425 outv[outc++] = lenobj;
2426 for (j = 0; j < argc; j++) {
2427 lenobj = createObject(REDIS_STRING,
2428 sdscatprintf(sdsempty(),"$%lu\r\n",
2429 (unsigned long) stringObjectLen(argv[j])));
2430 lenobj->refcount = 0;
2431 outv[outc++] = lenobj;
2432 outv[outc++] = argv[j];
2433 outv[outc++] = shared.crlf;
2434 }
2435
2436 /* Increment all the refcounts at start and decrement at end in order to
2437 * be sure to free objects if there is no slave in a replication state
2438 * able to be feed with commands */
2439 for (j = 0; j < outc; j++) incrRefCount(outv[j]);
2440 listRewind(slaves,&li);
2441 while((ln = listNext(&li))) {
2442 redisClient *slave = ln->value;
2443
2444 /* Don't feed slaves that are still waiting for BGSAVE to start */
2445 if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_START) continue;
2446
2447 /* Feed all the other slaves, MONITORs and so on */
2448 if (slave->slaveseldb != dictid) {
2449 robj *selectcmd;
2450
2451 switch(dictid) {
2452 case 0: selectcmd = shared.select0; break;
2453 case 1: selectcmd = shared.select1; break;
2454 case 2: selectcmd = shared.select2; break;
2455 case 3: selectcmd = shared.select3; break;
2456 case 4: selectcmd = shared.select4; break;
2457 case 5: selectcmd = shared.select5; break;
2458 case 6: selectcmd = shared.select6; break;
2459 case 7: selectcmd = shared.select7; break;
2460 case 8: selectcmd = shared.select8; break;
2461 case 9: selectcmd = shared.select9; break;
2462 default:
2463 selectcmd = createObject(REDIS_STRING,
2464 sdscatprintf(sdsempty(),"select %d\r\n",dictid));
2465 selectcmd->refcount = 0;
2466 break;
2467 }
2468 addReply(slave,selectcmd);
2469 slave->slaveseldb = dictid;
2470 }
2471 for (j = 0; j < outc; j++) addReply(slave,outv[j]);
2472 }
2473 for (j = 0; j < outc; j++) decrRefCount(outv[j]);
2474 if (outv != static_outv) zfree(outv);
2475 }
2476
2477 static sds sdscatrepr(sds s, char *p, size_t len) {
2478 s = sdscatlen(s,"\"",1);
2479 while(len--) {
2480 switch(*p) {
2481 case '\\':
2482 case '"':
2483 s = sdscatprintf(s,"\\%c",*p);
2484 break;
2485 case '\n': s = sdscatlen(s,"\\n",1); break;
2486 case '\r': s = sdscatlen(s,"\\r",1); break;
2487 case '\t': s = sdscatlen(s,"\\t",1); break;
2488 case '\a': s = sdscatlen(s,"\\a",1); break;
2489 case '\b': s = sdscatlen(s,"\\b",1); break;
2490 default:
2491 if (isprint(*p))
2492 s = sdscatprintf(s,"%c",*p);
2493 else
2494 s = sdscatprintf(s,"\\x%02x",(unsigned char)*p);
2495 break;
2496 }
2497 p++;
2498 }
2499 return sdscatlen(s,"\"",1);
2500 }
2501
2502 static void replicationFeedMonitors(list *monitors, int dictid, robj **argv, int argc) {
2503 listNode *ln;
2504 listIter li;
2505 int j;
2506 sds cmdrepr = sdsnew("+");
2507 robj *cmdobj;
2508 struct timeval tv;
2509
2510 gettimeofday(&tv,NULL);
2511 cmdrepr = sdscatprintf(cmdrepr,"%ld.%ld ",(long)tv.tv_sec,(long)tv.tv_usec);
2512 if (dictid != 0) cmdrepr = sdscatprintf(cmdrepr,"(db %d) ", dictid);
2513
2514 for (j = 0; j < argc; j++) {
2515 if (argv[j]->encoding == REDIS_ENCODING_INT) {
2516 cmdrepr = sdscatprintf(cmdrepr, "%ld", (long)argv[j]->ptr);
2517 } else {
2518 cmdrepr = sdscatrepr(cmdrepr,(char*)argv[j]->ptr,
2519 sdslen(argv[j]->ptr));
2520 }
2521 if (j != argc-1)
2522 cmdrepr = sdscatlen(cmdrepr," ",1);
2523 }
2524 cmdrepr = sdscatlen(cmdrepr,"\r\n",2);
2525 cmdobj = createObject(REDIS_STRING,cmdrepr);
2526
2527 listRewind(monitors,&li);
2528 while((ln = listNext(&li))) {
2529 redisClient *monitor = ln->value;
2530 addReply(monitor,cmdobj);
2531 }
2532 decrRefCount(cmdobj);
2533 }
2534
2535 static void processInputBuffer(redisClient *c) {
2536 again:
2537 /* Before to process the input buffer, make sure the client is not
2538 * waitig for a blocking operation such as BLPOP. Note that the first
2539 * iteration the client is never blocked, otherwise the processInputBuffer
2540 * would not be called at all, but after the execution of the first commands
2541 * in the input buffer the client may be blocked, and the "goto again"
2542 * will try to reiterate. The following line will make it return asap. */
2543 if (c->flags & REDIS_BLOCKED || c->flags & REDIS_IO_WAIT) return;
2544 if (c->bulklen == -1) {
2545 /* Read the first line of the query */
2546 char *p = strchr(c->querybuf,'\n');
2547 size_t querylen;
2548
2549 if (p) {
2550 sds query, *argv;
2551 int argc, j;
2552
2553 query = c->querybuf;
2554 c->querybuf = sdsempty();
2555 querylen = 1+(p-(query));
2556 if (sdslen(query) > querylen) {
2557 /* leave data after the first line of the query in the buffer */
2558 c->querybuf = sdscatlen(c->querybuf,query+querylen,sdslen(query)-querylen);
2559 }
2560 *p = '\0'; /* remove "\n" */
2561 if (*(p-1) == '\r') *(p-1) = '\0'; /* and "\r" if any */
2562 sdsupdatelen(query);
2563
2564 /* Now we can split the query in arguments */
2565 argv = sdssplitlen(query,sdslen(query)," ",1,&argc);
2566 sdsfree(query);
2567
2568 if (c->argv) zfree(c->argv);
2569 c->argv = zmalloc(sizeof(robj*)*argc);
2570
2571 for (j = 0; j < argc; j++) {
2572 if (sdslen(argv[j])) {
2573 c->argv[c->argc] = createObject(REDIS_STRING,argv[j]);
2574 c->argc++;
2575 } else {
2576 sdsfree(argv[j]);
2577 }
2578 }
2579 zfree(argv);
2580 if (c->argc) {
2581 /* Execute the command. If the client is still valid
2582 * after processCommand() return and there is something
2583 * on the query buffer try to process the next command. */
2584 if (processCommand(c) && sdslen(c->querybuf)) goto again;
2585 } else {
2586 /* Nothing to process, argc == 0. Just process the query
2587 * buffer if it's not empty or return to the caller */
2588 if (sdslen(c->querybuf)) goto again;
2589 }
2590 return;
2591 } else if (sdslen(c->querybuf) >= REDIS_REQUEST_MAX_SIZE) {
2592 redisLog(REDIS_VERBOSE, "Client protocol error");
2593 freeClient(c);
2594 return;
2595 }
2596 } else {
2597 /* Bulk read handling. Note that if we are at this point
2598 the client already sent a command terminated with a newline,
2599 we are reading the bulk data that is actually the last
2600 argument of the command. */
2601 int qbl = sdslen(c->querybuf);
2602
2603 if (c->bulklen <= qbl) {
2604 /* Copy everything but the final CRLF as final argument */
2605 c->argv[c->argc] = createStringObject(c->querybuf,c->bulklen-2);
2606 c->argc++;
2607 c->querybuf = sdsrange(c->querybuf,c->bulklen,-1);
2608 /* Process the command. If the client is still valid after
2609 * the processing and there is more data in the buffer
2610 * try to parse it. */
2611 if (processCommand(c) && sdslen(c->querybuf)) goto again;
2612 return;
2613 }
2614 }
2615 }
2616
2617 static void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask) {
2618 redisClient *c = (redisClient*) privdata;
2619 char buf[REDIS_IOBUF_LEN];
2620 int nread;
2621 REDIS_NOTUSED(el);
2622 REDIS_NOTUSED(mask);
2623
2624 nread = read(fd, buf, REDIS_IOBUF_LEN);
2625 if (nread == -1) {
2626 if (errno == EAGAIN) {
2627 nread = 0;
2628 } else {
2629 redisLog(REDIS_VERBOSE, "Reading from client: %s",strerror(errno));
2630 freeClient(c);
2631 return;
2632 }
2633 } else if (nread == 0) {
2634 redisLog(REDIS_VERBOSE, "Client closed connection");
2635 freeClient(c);
2636 return;
2637 }
2638 if (nread) {
2639 c->querybuf = sdscatlen(c->querybuf, buf, nread);
2640 c->lastinteraction = time(NULL);
2641 } else {
2642 return;
2643 }
2644 processInputBuffer(c);
2645 }
2646
2647 static int selectDb(redisClient *c, int id) {
2648 if (id < 0 || id >= server.dbnum)
2649 return REDIS_ERR;
2650 c->db = &server.db[id];
2651 return REDIS_OK;
2652 }
2653
2654 static void *dupClientReplyValue(void *o) {
2655 incrRefCount((robj*)o);
2656 return o;
2657 }
2658
2659 static int listMatchObjects(void *a, void *b) {
2660 return equalStringObjects(a,b);
2661 }
2662
2663 static redisClient *createClient(int fd) {
2664 redisClient *c = zmalloc(sizeof(*c));
2665
2666 anetNonBlock(NULL,fd);
2667 anetTcpNoDelay(NULL,fd);
2668 if (!c) return NULL;
2669 selectDb(c,0);
2670 c->fd = fd;
2671 c->querybuf = sdsempty();
2672 c->argc = 0;
2673 c->argv = NULL;
2674 c->bulklen = -1;
2675 c->multibulk = 0;
2676 c->mbargc = 0;
2677 c->mbargv = NULL;
2678 c->sentlen = 0;
2679 c->flags = 0;
2680 c->lastinteraction = time(NULL);
2681 c->authenticated = 0;
2682 c->replstate = REDIS_REPL_NONE;
2683 c->reply = listCreate();
2684 listSetFreeMethod(c->reply,decrRefCount);
2685 listSetDupMethod(c->reply,dupClientReplyValue);
2686 c->blockingkeys = NULL;
2687 c->blockingkeysnum = 0;
2688 c->io_keys = listCreate();
2689 listSetFreeMethod(c->io_keys,decrRefCount);
2690 c->pubsub_channels = dictCreate(&setDictType,NULL);
2691 c->pubsub_patterns = listCreate();
2692 listSetFreeMethod(c->pubsub_patterns,decrRefCount);
2693 listSetMatchMethod(c->pubsub_patterns,listMatchObjects);
2694 if (aeCreateFileEvent(server.el, c->fd, AE_READABLE,
2695 readQueryFromClient, c) == AE_ERR) {
2696 freeClient(c);
2697 return NULL;
2698 }
2699 listAddNodeTail(server.clients,c);
2700 initClientMultiState(c);
2701 return c;
2702 }
2703
2704 static void addReply(redisClient *c, robj *obj) {
2705 if (listLength(c->reply) == 0 &&
2706 (c->replstate == REDIS_REPL_NONE ||
2707 c->replstate == REDIS_REPL_ONLINE) &&
2708 aeCreateFileEvent(server.el, c->fd, AE_WRITABLE,
2709 sendReplyToClient, c) == AE_ERR) return;
2710
2711 if (server.vm_enabled && obj->storage != REDIS_VM_MEMORY) {
2712 obj = dupStringObject(obj);
2713 obj->refcount = 0; /* getDecodedObject() will increment the refcount */
2714 }
2715 listAddNodeTail(c->reply,getDecodedObject(obj));
2716 }
2717
2718 static void addReplySds(redisClient *c, sds s) {
2719 robj *o = createObject(REDIS_STRING,s);
2720 addReply(c,o);
2721 decrRefCount(o);
2722 }
2723
2724 static void addReplyDouble(redisClient *c, double d) {
2725 char buf[128];
2726
2727 snprintf(buf,sizeof(buf),"%.17g",d);
2728 addReplySds(c,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2729 (unsigned long) strlen(buf),buf));
2730 }
2731
2732 static void addReplyLong(redisClient *c, long l) {
2733 char buf[128];
2734 size_t len;
2735
2736 if (l == 0) {
2737 addReply(c,shared.czero);
2738 return;
2739 } else if (l == 1) {
2740 addReply(c,shared.cone);
2741 return;
2742 }
2743 len = snprintf(buf,sizeof(buf),":%ld\r\n",l);
2744 addReplySds(c,sdsnewlen(buf,len));
2745 }
2746
2747 static void addReplyLongLong(redisClient *c, long long ll) {
2748 char buf[128];
2749 size_t len;
2750
2751 if (ll == 0) {
2752 addReply(c,shared.czero);
2753 return;
2754 } else if (ll == 1) {
2755 addReply(c,shared.cone);
2756 return;
2757 }
2758 len = snprintf(buf,sizeof(buf),":%lld\r\n",ll);
2759 addReplySds(c,sdsnewlen(buf,len));
2760 }
2761
2762 static void addReplyUlong(redisClient *c, unsigned long ul) {
2763 char buf[128];
2764 size_t len;
2765
2766 if (ul == 0) {
2767 addReply(c,shared.czero);
2768 return;
2769 } else if (ul == 1) {
2770 addReply(c,shared.cone);
2771 return;
2772 }
2773 len = snprintf(buf,sizeof(buf),":%lu\r\n",ul);
2774 addReplySds(c,sdsnewlen(buf,len));
2775 }
2776
2777 static void addReplyBulkLen(redisClient *c, robj *obj) {
2778 size_t len;
2779
2780 if (obj->encoding == REDIS_ENCODING_RAW) {
2781 len = sdslen(obj->ptr);
2782 } else {
2783 long n = (long)obj->ptr;
2784
2785 /* Compute how many bytes will take this integer as a radix 10 string */
2786 len = 1;
2787 if (n < 0) {
2788 len++;
2789 n = -n;
2790 }
2791 while((n = n/10) != 0) {
2792 len++;
2793 }
2794 }
2795 addReplySds(c,sdscatprintf(sdsempty(),"$%lu\r\n",(unsigned long)len));
2796 }
2797
2798 static void addReplyBulk(redisClient *c, robj *obj) {
2799 addReplyBulkLen(c,obj);
2800 addReply(c,obj);
2801 addReply(c,shared.crlf);
2802 }
2803
2804 /* In the CONFIG command we need to add vanilla C string as bulk replies */
2805 static void addReplyBulkCString(redisClient *c, char *s) {
2806 if (s == NULL) {
2807 addReply(c,shared.nullbulk);
2808 } else {
2809 robj *o = createStringObject(s,strlen(s));
2810 addReplyBulk(c,o);
2811 decrRefCount(o);
2812 }
2813 }
2814
2815 static void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask) {
2816 int cport, cfd;
2817 char cip[128];
2818 redisClient *c;
2819 REDIS_NOTUSED(el);
2820 REDIS_NOTUSED(mask);
2821 REDIS_NOTUSED(privdata);
2822
2823 cfd = anetAccept(server.neterr, fd, cip, &cport);
2824 if (cfd == AE_ERR) {
2825 redisLog(REDIS_VERBOSE,"Accepting client connection: %s", server.neterr);
2826 return;
2827 }
2828 redisLog(REDIS_VERBOSE,"Accepted %s:%d", cip, cport);
2829 if ((c = createClient(cfd)) == NULL) {
2830 redisLog(REDIS_WARNING,"Error allocating resoures for the client");
2831 close(cfd); /* May be already closed, just ingore errors */
2832 return;
2833 }
2834 /* If maxclient directive is set and this is one client more... close the
2835 * connection. Note that we create the client instead to check before
2836 * for this condition, since now the socket is already set in nonblocking
2837 * mode and we can send an error for free using the Kernel I/O */
2838 if (server.maxclients && listLength(server.clients) > server.maxclients) {
2839 char *err = "-ERR max number of clients reached\r\n";
2840
2841 /* That's a best effort error message, don't check write errors */
2842 if (write(c->fd,err,strlen(err)) == -1) {
2843 /* Nothing to do, Just to avoid the warning... */
2844 }
2845 freeClient(c);
2846 return;
2847 }
2848 server.stat_numconnections++;
2849 }
2850
2851 /* ======================= Redis objects implementation ===================== */
2852
2853 static robj *createObject(int type, void *ptr) {
2854 robj *o;
2855
2856 if (server.vm_enabled) pthread_mutex_lock(&server.obj_freelist_mutex);
2857 if (listLength(server.objfreelist)) {
2858 listNode *head = listFirst(server.objfreelist);
2859 o = listNodeValue(head);
2860 listDelNode(server.objfreelist,head);
2861 if (server.vm_enabled) pthread_mutex_unlock(&server.obj_freelist_mutex);
2862 } else {
2863 if (server.vm_enabled) {
2864 pthread_mutex_unlock(&server.obj_freelist_mutex);
2865 o = zmalloc(sizeof(*o));
2866 } else {
2867 o = zmalloc(sizeof(*o)-sizeof(struct redisObjectVM));
2868 }
2869 }
2870 o->type = type;
2871 o->encoding = REDIS_ENCODING_RAW;
2872 o->ptr = ptr;
2873 o->refcount = 1;
2874 if (server.vm_enabled) {
2875 /* Note that this code may run in the context of an I/O thread
2876 * and accessing to server.unixtime in theory is an error
2877 * (no locks). But in practice this is safe, and even if we read
2878 * garbage Redis will not fail, as it's just a statistical info */
2879 o->vm.atime = server.unixtime;
2880 o->storage = REDIS_VM_MEMORY;
2881 }
2882 return o;
2883 }
2884
2885 static robj *createStringObject(char *ptr, size_t len) {
2886 return createObject(REDIS_STRING,sdsnewlen(ptr,len));
2887 }
2888
2889 static robj *createStringObjectFromLongLong(long long value) {
2890 robj *o;
2891 if (value >= 0 && value < REDIS_SHARED_INTEGERS) {
2892 incrRefCount(shared.integers[value]);
2893 o = shared.integers[value];
2894 } else {
2895 o = createObject(REDIS_STRING, NULL);
2896 if (value >= LONG_MIN && value <= LONG_MAX) {
2897 o->encoding = REDIS_ENCODING_INT;
2898 o->ptr = (void*)((long)value);
2899 } else {
2900 char buf[32], *p;
2901 char *c = "0123456789";
2902 unsigned long v;
2903
2904 v = (value < 0) ? -value : value;
2905 p = buf+31; /* point to the last character */
2906 while(v) {
2907 *p-- = c[v%10];
2908 v /= 10;
2909 }
2910 if (value < 0) *p-- = '-';
2911 p++;
2912 o = createObject(REDIS_STRING,sdsnewlen(p,32-(p-buf+1)));
2913 }
2914 }
2915 return o;
2916 }
2917
2918 static robj *dupStringObject(robj *o) {
2919 assert(o->encoding == REDIS_ENCODING_RAW);
2920 return createStringObject(o->ptr,sdslen(o->ptr));
2921 }
2922
2923 static robj *createListObject(void) {
2924 list *l = listCreate();
2925
2926 listSetFreeMethod(l,decrRefCount);
2927 return createObject(REDIS_LIST,l);
2928 }
2929
2930 static robj *createSetObject(void) {
2931 dict *d = dictCreate(&setDictType,NULL);
2932 return createObject(REDIS_SET,d);
2933 }
2934
2935 static robj *createHashObject(void) {
2936 /* All the Hashes start as zipmaps. Will be automatically converted
2937 * into hash tables if there are enough elements or big elements
2938 * inside. */
2939 unsigned char *zm = zipmapNew();
2940 robj *o = createObject(REDIS_HASH,zm);
2941 o->encoding = REDIS_ENCODING_ZIPMAP;
2942 return o;
2943 }
2944
2945 static robj *createZsetObject(void) {
2946 zset *zs = zmalloc(sizeof(*zs));
2947
2948 zs->dict = dictCreate(&zsetDictType,NULL);
2949 zs->zsl = zslCreate();
2950 return createObject(REDIS_ZSET,zs);
2951 }
2952
2953 static void freeStringObject(robj *o) {
2954 if (o->encoding == REDIS_ENCODING_RAW) {
2955 sdsfree(o->ptr);
2956 }
2957 }
2958
2959 static void freeListObject(robj *o) {
2960 listRelease((list*) o->ptr);
2961 }
2962
2963 static void freeSetObject(robj *o) {
2964 dictRelease((dict*) o->ptr);
2965 }
2966
2967 static void freeZsetObject(robj *o) {
2968 zset *zs = o->ptr;
2969
2970 dictRelease(zs->dict);
2971 zslFree(zs->zsl);
2972 zfree(zs);
2973 }
2974
2975 static void freeHashObject(robj *o) {
2976 switch (o->encoding) {
2977 case REDIS_ENCODING_HT:
2978 dictRelease((dict*) o->ptr);
2979 break;
2980 case REDIS_ENCODING_ZIPMAP:
2981 zfree(o->ptr);
2982 break;
2983 default:
2984 redisPanic("Unknown hash encoding type");
2985 break;
2986 }
2987 }
2988
2989 static void incrRefCount(robj *o) {
2990 o->refcount++;
2991 }
2992
2993 static void decrRefCount(void *obj) {
2994 robj *o = obj;
2995
2996 if (o->refcount <= 0) redisPanic("decrRefCount against refcount <= 0");
2997 /* Object is a key of a swapped out value, or in the process of being
2998 * loaded. */
2999 if (server.vm_enabled &&
3000 (o->storage == REDIS_VM_SWAPPED || o->storage == REDIS_VM_LOADING))
3001 {
3002 if (o->storage == REDIS_VM_LOADING) vmCancelThreadedIOJob(obj);
3003 redisAssert(o->type == REDIS_STRING);
3004 freeStringObject(o);
3005 vmMarkPagesFree(o->vm.page,o->vm.usedpages);
3006 pthread_mutex_lock(&server.obj_freelist_mutex);
3007 if (listLength(server.objfreelist) > REDIS_OBJFREELIST_MAX ||
3008 !listAddNodeHead(server.objfreelist,o))
3009 zfree(o);
3010 pthread_mutex_unlock(&server.obj_freelist_mutex);
3011 server.vm_stats_swapped_objects--;
3012 return;
3013 }
3014 /* Object is in memory, or in the process of being swapped out. */
3015 if (--(o->refcount) == 0) {
3016 if (server.vm_enabled && o->storage == REDIS_VM_SWAPPING)
3017 vmCancelThreadedIOJob(obj);
3018 switch(o->type) {
3019 case REDIS_STRING: freeStringObject(o); break;
3020 case REDIS_LIST: freeListObject(o); break;
3021 case REDIS_SET: freeSetObject(o); break;
3022 case REDIS_ZSET: freeZsetObject(o); break;
3023 case REDIS_HASH: freeHashObject(o); break;
3024 default: redisPanic("Unknown object type"); break;
3025 }
3026 if (server.vm_enabled) pthread_mutex_lock(&server.obj_freelist_mutex);
3027 if (listLength(server.objfreelist) > REDIS_OBJFREELIST_MAX ||
3028 !listAddNodeHead(server.objfreelist,o))
3029 zfree(o);
3030 if (server.vm_enabled) pthread_mutex_unlock(&server.obj_freelist_mutex);
3031 }
3032 }
3033
3034 static robj *lookupKey(redisDb *db, robj *key) {
3035 dictEntry *de = dictFind(db->dict,key);
3036 if (de) {
3037 robj *key = dictGetEntryKey(de);
3038 robj *val = dictGetEntryVal(de);
3039
3040 if (server.vm_enabled) {
3041 if (key->storage == REDIS_VM_MEMORY ||
3042 key->storage == REDIS_VM_SWAPPING)
3043 {
3044 /* If we were swapping the object out, stop it, this key
3045 * was requested. */
3046 if (key->storage == REDIS_VM_SWAPPING)
3047 vmCancelThreadedIOJob(key);
3048 /* Update the access time of the key for the aging algorithm. */
3049 key->vm.atime = server.unixtime;
3050 } else {
3051 int notify = (key->storage == REDIS_VM_LOADING);
3052
3053 /* Our value was swapped on disk. Bring it at home. */
3054 redisAssert(val == NULL);
3055 val = vmLoadObject(key);
3056 dictGetEntryVal(de) = val;
3057
3058 /* Clients blocked by the VM subsystem may be waiting for
3059 * this key... */
3060 if (notify) handleClientsBlockedOnSwappedKey(db,key);
3061 }
3062 }
3063 return val;
3064 } else {
3065 return NULL;
3066 }
3067 }
3068
3069 static robj *lookupKeyRead(redisDb *db, robj *key) {
3070 expireIfNeeded(db,key);
3071 return lookupKey(db,key);
3072 }
3073
3074 static robj *lookupKeyWrite(redisDb *db, robj *key) {
3075 deleteIfVolatile(db,key);
3076 return lookupKey(db,key);
3077 }
3078
3079 static robj *lookupKeyReadOrReply(redisClient *c, robj *key, robj *reply) {
3080 robj *o = lookupKeyRead(c->db, key);
3081 if (!o) addReply(c,reply);
3082 return o;
3083 }
3084
3085 static robj *lookupKeyWriteOrReply(redisClient *c, robj *key, robj *reply) {
3086 robj *o = lookupKeyWrite(c->db, key);
3087 if (!o) addReply(c,reply);
3088 return o;
3089 }
3090
3091 static int checkType(redisClient *c, robj *o, int type) {
3092 if (o->type != type) {
3093 addReply(c,shared.wrongtypeerr);
3094 return 1;
3095 }
3096 return 0;
3097 }
3098
3099 static int deleteKey(redisDb *db, robj *key) {
3100 int retval;
3101
3102 /* We need to protect key from destruction: after the first dictDelete()
3103 * it may happen that 'key' is no longer valid if we don't increment
3104 * it's count. This may happen when we get the object reference directly
3105 * from the hash table with dictRandomKey() or dict iterators */
3106 incrRefCount(key);
3107 if (dictSize(db->expires)) dictDelete(db->expires,key);
3108 retval = dictDelete(db->dict,key);
3109 decrRefCount(key);
3110
3111 return retval == DICT_OK;
3112 }
3113
3114 /* Check if the nul-terminated string 's' can be represented by a long
3115 * (that is, is a number that fits into long without any other space or
3116 * character before or after the digits).
3117 *
3118 * If so, the function returns REDIS_OK and *longval is set to the value
3119 * of the number. Otherwise REDIS_ERR is returned */
3120 static int isStringRepresentableAsLong(sds s, long *longval) {
3121 char buf[32], *endptr;
3122 long value;
3123 int slen;
3124
3125 value = strtol(s, &endptr, 10);
3126 if (endptr[0] != '\0') return REDIS_ERR;
3127 slen = snprintf(buf,32,"%ld",value);
3128
3129 /* If the number converted back into a string is not identical
3130 * then it's not possible to encode the string as integer */
3131 if (sdslen(s) != (unsigned)slen || memcmp(buf,s,slen)) return REDIS_ERR;
3132 if (longval) *longval = value;
3133 return REDIS_OK;
3134 }
3135
3136 /* Try to encode a string object in order to save space */
3137 static robj *tryObjectEncoding(robj *o) {
3138 long value;
3139 sds s = o->ptr;
3140
3141 if (o->encoding != REDIS_ENCODING_RAW)
3142 return o; /* Already encoded */
3143
3144 /* It's not safe to encode shared objects: shared objects can be shared
3145 * everywhere in the "object space" of Redis. Encoded objects can only
3146 * appear as "values" (and not, for instance, as keys) */
3147 if (o->refcount > 1) return o;
3148
3149 /* Currently we try to encode only strings */
3150 redisAssert(o->type == REDIS_STRING);
3151
3152 /* Check if we can represent this string as a long integer */
3153 if (isStringRepresentableAsLong(s,&value) == REDIS_ERR) return o;
3154
3155 /* Ok, this object can be encoded */
3156 if (value >= 0 && value < REDIS_SHARED_INTEGERS) {
3157 decrRefCount(o);
3158 incrRefCount(shared.integers[value]);
3159 return shared.integers[value];
3160 } else {
3161 o->encoding = REDIS_ENCODING_INT;
3162 sdsfree(o->ptr);
3163 o->ptr = (void*) value;
3164 return o;
3165 }
3166 }
3167
3168 /* Get a decoded version of an encoded object (returned as a new object).
3169 * If the object is already raw-encoded just increment the ref count. */
3170 static robj *getDecodedObject(robj *o) {
3171 robj *dec;
3172
3173 if (o->encoding == REDIS_ENCODING_RAW) {
3174 incrRefCount(o);
3175 return o;
3176 }
3177 if (o->type == REDIS_STRING && o->encoding == REDIS_ENCODING_INT) {
3178 char buf[32];
3179
3180 snprintf(buf,32,"%ld",(long)o->ptr);
3181 dec = createStringObject(buf,strlen(buf));
3182 return dec;
3183 } else {
3184 redisPanic("Unknown encoding type");
3185 }
3186 }
3187
3188 /* Compare two string objects via strcmp() or alike.
3189 * Note that the objects may be integer-encoded. In such a case we
3190 * use snprintf() to get a string representation of the numbers on the stack
3191 * and compare the strings, it's much faster than calling getDecodedObject().
3192 *
3193 * Important note: if objects are not integer encoded, but binary-safe strings,
3194 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
3195 * binary safe. */
3196 static int compareStringObjects(robj *a, robj *b) {
3197 redisAssert(a->type == REDIS_STRING && b->type == REDIS_STRING);
3198 char bufa[128], bufb[128], *astr, *bstr;
3199 int bothsds = 1;
3200
3201 if (a == b) return 0;
3202 if (a->encoding != REDIS_ENCODING_RAW) {
3203 snprintf(bufa,sizeof(bufa),"%ld",(long) a->ptr);
3204 astr = bufa;
3205 bothsds = 0;
3206 } else {
3207 astr = a->ptr;
3208 }
3209 if (b->encoding != REDIS_ENCODING_RAW) {
3210 snprintf(bufb,sizeof(bufb),"%ld",(long) b->ptr);
3211 bstr = bufb;
3212 bothsds = 0;
3213 } else {
3214 bstr = b->ptr;
3215 }
3216 return bothsds ? sdscmp(astr,bstr) : strcmp(astr,bstr);
3217 }
3218
3219 /* Equal string objects return 1 if the two objects are the same from the
3220 * point of view of a string comparison, otherwise 0 is returned. Note that
3221 * this function is faster then checking for (compareStringObject(a,b) == 0)
3222 * because it can perform some more optimization. */
3223 static int equalStringObjects(robj *a, robj *b) {
3224 if (a->encoding != REDIS_ENCODING_RAW && b->encoding != REDIS_ENCODING_RAW){
3225 return a->ptr == b->ptr;
3226 } else {
3227 return compareStringObjects(a,b) == 0;
3228 }
3229 }
3230
3231 static size_t stringObjectLen(robj *o) {
3232 redisAssert(o->type == REDIS_STRING);
3233 if (o->encoding == REDIS_ENCODING_RAW) {
3234 return sdslen(o->ptr);
3235 } else {
3236 char buf[32];
3237
3238 return snprintf(buf,32,"%ld",(long)o->ptr);
3239 }
3240 }
3241
3242 static int getDoubleFromObject(robj *o, double *target) {
3243 double value;
3244 char *eptr;
3245
3246 if (o == NULL) {
3247 value = 0;
3248 } else {
3249 redisAssert(o->type == REDIS_STRING);
3250 if (o->encoding == REDIS_ENCODING_RAW) {
3251 value = strtod(o->ptr, &eptr);
3252 if (eptr[0] != '\0') return REDIS_ERR;
3253 } else if (o->encoding == REDIS_ENCODING_INT) {
3254 value = (long)o->ptr;
3255 } else {
3256 redisPanic("Unknown string encoding");
3257 }
3258 }
3259
3260 *target = value;
3261 return REDIS_OK;
3262 }
3263
3264 static int getDoubleFromObjectOrReply(redisClient *c, robj *o, double *target, const char *msg) {
3265 double value;
3266 if (getDoubleFromObject(o, &value) != REDIS_OK) {
3267 if (msg != NULL) {
3268 addReplySds(c, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg));
3269 } else {
3270 addReplySds(c, sdsnew("-ERR value is not a double\r\n"));
3271 }
3272 return REDIS_ERR;
3273 }
3274
3275 *target = value;
3276 return REDIS_OK;
3277 }
3278
3279 static int getLongLongFromObject(robj *o, long long *target) {
3280 long long value;
3281 char *eptr;
3282
3283 if (o == NULL) {
3284 value = 0;
3285 } else {
3286 redisAssert(o->type == REDIS_STRING);
3287 if (o->encoding == REDIS_ENCODING_RAW) {
3288 value = strtoll(o->ptr, &eptr, 10);
3289 if (eptr[0] != '\0') return REDIS_ERR;
3290 } else if (o->encoding == REDIS_ENCODING_INT) {
3291 value = (long)o->ptr;
3292 } else {
3293 redisPanic("Unknown string encoding");
3294 }
3295 }
3296
3297 *target = value;
3298 return REDIS_OK;
3299 }
3300
3301 static int getLongLongFromObjectOrReply(redisClient *c, robj *o, long long *target, const char *msg) {
3302 long long value;
3303 if (getLongLongFromObject(o, &value) != REDIS_OK) {
3304 if (msg != NULL) {
3305 addReplySds(c, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg));
3306 } else {
3307 addReplySds(c, sdsnew("-ERR value is not an integer\r\n"));
3308 }
3309 return REDIS_ERR;
3310 }
3311
3312 *target = value;
3313 return REDIS_OK;
3314 }
3315
3316 static int getLongFromObjectOrReply(redisClient *c, robj *o, long *target, const char *msg) {
3317 long long value;
3318
3319 if (getLongLongFromObjectOrReply(c, o, &value, msg) != REDIS_OK) return REDIS_ERR;
3320 if (value < LONG_MIN || value > LONG_MAX) {
3321 if (msg != NULL) {
3322 addReplySds(c, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg));
3323 } else {
3324 addReplySds(c, sdsnew("-ERR value is out of range\r\n"));
3325 }
3326 return REDIS_ERR;
3327 }
3328
3329 *target = value;
3330 return REDIS_OK;
3331 }
3332
3333 /*============================ RDB saving/loading =========================== */
3334
3335 static int rdbSaveType(FILE *fp, unsigned char type) {
3336 if (fwrite(&type,1,1,fp) == 0) return -1;
3337 return 0;
3338 }
3339
3340 static int rdbSaveTime(FILE *fp, time_t t) {
3341 int32_t t32 = (int32_t) t;
3342 if (fwrite(&t32,4,1,fp) == 0) return -1;
3343 return 0;
3344 }
3345
3346 /* check rdbLoadLen() comments for more info */
3347 static int rdbSaveLen(FILE *fp, uint32_t len) {
3348 unsigned char buf[2];
3349
3350 if (len < (1<<6)) {
3351 /* Save a 6 bit len */
3352 buf[0] = (len&0xFF)|(REDIS_RDB_6BITLEN<<6);
3353 if (fwrite(buf,1,1,fp) == 0) return -1;
3354 } else if (len < (1<<14)) {
3355 /* Save a 14 bit len */
3356 buf[0] = ((len>>8)&0xFF)|(REDIS_RDB_14BITLEN<<6);
3357 buf[1] = len&0xFF;
3358 if (fwrite(buf,2,1,fp) == 0) return -1;
3359 } else {
3360 /* Save a 32 bit len */
3361 buf[0] = (REDIS_RDB_32BITLEN<<6);
3362 if (fwrite(buf,1,1,fp) == 0) return -1;
3363 len = htonl(len);
3364 if (fwrite(&len,4,1,fp) == 0) return -1;
3365 }
3366 return 0;
3367 }
3368
3369 /* String objects in the form "2391" "-100" without any space and with a
3370 * range of values that can fit in an 8, 16 or 32 bit signed value can be
3371 * encoded as integers to save space */
3372 static int rdbTryIntegerEncoding(char *s, size_t len, unsigned char *enc) {
3373 long long value;
3374 char *endptr, buf[32];
3375
3376 /* Check if it's possible to encode this value as a number */
3377 value = strtoll(s, &endptr, 10);
3378 if (endptr[0] != '\0') return 0;
3379 snprintf(buf,32,"%lld",value);
3380
3381 /* If the number converted back into a string is not identical
3382 * then it's not possible to encode the string as integer */
3383 if (strlen(buf) != len || memcmp(buf,s,len)) return 0;
3384
3385 /* Finally check if it fits in our ranges */
3386 if (value >= -(1<<7) && value <= (1<<7)-1) {
3387 enc[0] = (REDIS_RDB_ENCVAL<<6)|REDIS_RDB_ENC_INT8;
3388 enc[1] = value&0xFF;
3389 return 2;
3390 } else if (value >= -(1<<15) && value <= (1<<15)-1) {
3391 enc[0] = (REDIS_RDB_ENCVAL<<6)|REDIS_RDB_ENC_INT16;
3392 enc[1] = value&0xFF;
3393 enc[2] = (value>>8)&0xFF;
3394 return 3;
3395 } else if (value >= -((long long)1<<31) && value <= ((long long)1<<31)-1) {
3396 enc[0] = (REDIS_RDB_ENCVAL<<6)|REDIS_RDB_ENC_INT32;
3397 enc[1] = value&0xFF;
3398 enc[2] = (value>>8)&0xFF;
3399 enc[3] = (value>>16)&0xFF;
3400 enc[4] = (value>>24)&0xFF;
3401 return 5;
3402 } else {
3403 return 0;
3404 }
3405 }
3406
3407 static int rdbSaveLzfStringObject(FILE *fp, unsigned char *s, size_t len) {
3408 size_t comprlen, outlen;
3409 unsigned char byte;
3410 void *out;
3411
3412 /* We require at least four bytes compression for this to be worth it */
3413 if (len <= 4) return 0;
3414 outlen = len-4;
3415 if ((out = zmalloc(outlen+1)) == NULL) return 0;
3416 comprlen = lzf_compress(s, len, out, outlen);
3417 if (comprlen == 0) {
3418 zfree(out);
3419 return 0;
3420 }
3421 /* Data compressed! Let's save it on disk */
3422 byte = (REDIS_RDB_ENCVAL<<6)|REDIS_RDB_ENC_LZF;
3423 if (fwrite(&byte,1,1,fp) == 0) goto writeerr;
3424 if (rdbSaveLen(fp,comprlen) == -1) goto writeerr;
3425 if (rdbSaveLen(fp,len) == -1) goto writeerr;
3426 if (fwrite(out,comprlen,1,fp) == 0) goto writeerr;
3427 zfree(out);
3428 return comprlen;
3429
3430 writeerr:
3431 zfree(out);
3432 return -1;
3433 }
3434
3435 /* Save a string objet as [len][data] on disk. If the object is a string
3436 * representation of an integer value we try to safe it in a special form */
3437 static int rdbSaveRawString(FILE *fp, unsigned char *s, size_t len) {
3438 int enclen;
3439
3440 /* Try integer encoding */
3441 if (len <= 11) {
3442 unsigned char buf[5];
3443 if ((enclen = rdbTryIntegerEncoding((char*)s,len,buf)) > 0) {
3444 if (fwrite(buf,enclen,1,fp) == 0) return -1;
3445 return 0;
3446 }
3447 }
3448
3449 /* Try LZF compression - under 20 bytes it's unable to compress even
3450 * aaaaaaaaaaaaaaaaaa so skip it */
3451 if (server.rdbcompression && len > 20) {
3452 int retval;
3453
3454 retval = rdbSaveLzfStringObject(fp,s,len);
3455 if (retval == -1) return -1;
3456 if (retval > 0) return 0;
3457 /* retval == 0 means data can't be compressed, save the old way */
3458 }
3459
3460 /* Store verbatim */
3461 if (rdbSaveLen(fp,len) == -1) return -1;
3462 if (len && fwrite(s,len,1,fp) == 0) return -1;
3463 return 0;
3464 }
3465
3466 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
3467 static int rdbSaveStringObject(FILE *fp, robj *obj) {
3468 int retval;
3469
3470 /* Avoid incr/decr ref count business when possible.
3471 * This plays well with copy-on-write given that we are probably
3472 * in a child process (BGSAVE). Also this makes sure key objects
3473 * of swapped objects are not incRefCount-ed (an assert does not allow
3474 * this in order to avoid bugs) */
3475 if (obj->encoding != REDIS_ENCODING_RAW) {
3476 obj = getDecodedObject(obj);
3477 retval = rdbSaveRawString(fp,obj->ptr,sdslen(obj->ptr));
3478 decrRefCount(obj);
3479 } else {
3480 retval = rdbSaveRawString(fp,obj->ptr,sdslen(obj->ptr));
3481 }
3482 return retval;
3483 }
3484
3485 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
3486 * 8 bit integer specifing the length of the representation.
3487 * This 8 bit integer has special values in order to specify the following
3488 * conditions:
3489 * 253: not a number
3490 * 254: + inf
3491 * 255: - inf
3492 */
3493 static int rdbSaveDoubleValue(FILE *fp, double val) {
3494 unsigned char buf[128];
3495 int len;
3496
3497 if (isnan(val)) {
3498 buf[0] = 253;
3499 len = 1;
3500 } else if (!isfinite(val)) {
3501 len = 1;
3502 buf[0] = (val < 0) ? 255 : 254;
3503 } else {
3504 snprintf((char*)buf+1,sizeof(buf)-1,"%.17g",val);
3505 buf[0] = strlen((char*)buf+1);
3506 len = buf[0]+1;
3507 }
3508 if (fwrite(buf,len,1,fp) == 0) return -1;
3509 return 0;
3510 }
3511
3512 /* Save a Redis object. */
3513 static int rdbSaveObject(FILE *fp, robj *o) {
3514 if (o->type == REDIS_STRING) {
3515 /* Save a string value */
3516 if (rdbSaveStringObject(fp,o) == -1) return -1;
3517 } else if (o->type == REDIS_LIST) {
3518 /* Save a list value */
3519 list *list = o->ptr;
3520 listIter li;
3521 listNode *ln;
3522
3523 if (rdbSaveLen(fp,listLength(list)) == -1) return -1;
3524 listRewind(list,&li);
3525 while((ln = listNext(&li))) {
3526 robj *eleobj = listNodeValue(ln);
3527
3528 if (rdbSaveStringObject(fp,eleobj) == -1) return -1;
3529 }
3530 } else if (o->type == REDIS_SET) {
3531 /* Save a set value */
3532 dict *set = o->ptr;
3533 dictIterator *di = dictGetIterator(set);
3534 dictEntry *de;
3535
3536 if (rdbSaveLen(fp,dictSize(set)) == -1) return -1;
3537 while((de = dictNext(di)) != NULL) {
3538 robj *eleobj = dictGetEntryKey(de);
3539
3540 if (rdbSaveStringObject(fp,eleobj) == -1) return -1;
3541 }
3542 dictReleaseIterator(di);
3543 } else if (o->type == REDIS_ZSET) {
3544 /* Save a set value */
3545 zset *zs = o->ptr;
3546 dictIterator *di = dictGetIterator(zs->dict);
3547 dictEntry *de;
3548
3549 if (rdbSaveLen(fp,dictSize(zs->dict)) == -1) return -1;
3550 while((de = dictNext(di)) != NULL) {
3551 robj *eleobj = dictGetEntryKey(de);
3552 double *score = dictGetEntryVal(de);
3553
3554 if (rdbSaveStringObject(fp,eleobj) == -1) return -1;
3555 if (rdbSaveDoubleValue(fp,*score) == -1) return -1;
3556 }
3557 dictReleaseIterator(di);
3558 } else if (o->type == REDIS_HASH) {
3559 /* Save a hash value */
3560 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
3561 unsigned char *p = zipmapRewind(o->ptr);
3562 unsigned int count = zipmapLen(o->ptr);
3563 unsigned char *key, *val;
3564 unsigned int klen, vlen;
3565
3566 if (rdbSaveLen(fp,count) == -1) return -1;
3567 while((p = zipmapNext(p,&key,&klen,&val,&vlen)) != NULL) {
3568 if (rdbSaveRawString(fp,key,klen) == -1) return -1;
3569 if (rdbSaveRawString(fp,val,vlen) == -1) return -1;
3570 }
3571 } else {
3572 dictIterator *di = dictGetIterator(o->ptr);
3573 dictEntry *de;
3574
3575 if (rdbSaveLen(fp,dictSize((dict*)o->ptr)) == -1) return -1;
3576 while((de = dictNext(di)) != NULL) {
3577 robj *key = dictGetEntryKey(de);
3578 robj *val = dictGetEntryVal(de);
3579
3580 if (rdbSaveStringObject(fp,key) == -1) return -1;
3581 if (rdbSaveStringObject(fp,val) == -1) return -1;
3582 }
3583 dictReleaseIterator(di);
3584 }
3585 } else {
3586 redisPanic("Unknown object type");
3587 }
3588 return 0;
3589 }
3590
3591 /* Return the length the object will have on disk if saved with
3592 * the rdbSaveObject() function. Currently we use a trick to get
3593 * this length with very little changes to the code. In the future
3594 * we could switch to a faster solution. */
3595 static off_t rdbSavedObjectLen(robj *o, FILE *fp) {
3596 if (fp == NULL) fp = server.devnull;
3597 rewind(fp);
3598 assert(rdbSaveObject(fp,o) != 1);
3599 return ftello(fp);
3600 }
3601
3602 /* Return the number of pages required to save this object in the swap file */
3603 static off_t rdbSavedObjectPages(robj *o, FILE *fp) {
3604 off_t bytes = rdbSavedObjectLen(o,fp);
3605
3606 return (bytes+(server.vm_page_size-1))/server.vm_page_size;
3607 }
3608
3609 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3610 static int rdbSave(char *filename) {
3611 dictIterator *di = NULL;
3612 dictEntry *de;
3613 FILE *fp;
3614 char tmpfile[256];
3615 int j;
3616 time_t now = time(NULL);
3617
3618 /* Wait for I/O therads to terminate, just in case this is a
3619 * foreground-saving, to avoid seeking the swap file descriptor at the
3620 * same time. */
3621 if (server.vm_enabled)
3622 waitEmptyIOJobsQueue();
3623
3624 snprintf(tmpfile,256,"temp-%d.rdb", (int) getpid());
3625 fp = fopen(tmpfile,"w");
3626 if (!fp) {
3627 redisLog(REDIS_WARNING, "Failed saving the DB: %s", strerror(errno));
3628 return REDIS_ERR;
3629 }
3630 if (fwrite("REDIS0001",9,1,fp) == 0) goto werr;
3631 for (j = 0; j < server.dbnum; j++) {
3632 redisDb *db = server.db+j;
3633 dict *d = db->dict;
3634 if (dictSize(d) == 0) continue;
3635 di = dictGetIterator(d);
3636 if (!di) {
3637 fclose(fp);
3638 return REDIS_ERR;
3639 }
3640
3641 /* Write the SELECT DB opcode */
3642 if (rdbSaveType(fp,REDIS_SELECTDB) == -1) goto werr;
3643 if (rdbSaveLen(fp,j) == -1) goto werr;
3644
3645 /* Iterate this DB writing every entry */
3646 while((de = dictNext(di)) != NULL) {
3647 robj *key = dictGetEntryKey(de);
3648 robj *o = dictGetEntryVal(de);
3649 time_t expiretime = getExpire(db,key);
3650
3651 /* Save the expire time */
3652 if (expiretime != -1) {
3653 /* If this key is already expired skip it */
3654 if (expiretime < now) continue;
3655 if (rdbSaveType(fp,REDIS_EXPIRETIME) == -1) goto werr;
3656 if (rdbSaveTime(fp,expiretime) == -1) goto werr;
3657 }
3658 /* Save the key and associated value. This requires special
3659 * handling if the value is swapped out. */
3660 if (!server.vm_enabled || key->storage == REDIS_VM_MEMORY ||
3661 key->storage == REDIS_VM_SWAPPING) {
3662 /* Save type, key, value */
3663 if (rdbSaveType(fp,o->type) == -1) goto werr;
3664 if (rdbSaveStringObject(fp,key) == -1) goto werr;
3665 if (rdbSaveObject(fp,o) == -1) goto werr;
3666 } else {
3667 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3668 robj *po;
3669 /* Get a preview of the object in memory */
3670 po = vmPreviewObject(key);
3671 /* Save type, key, value */
3672 if (rdbSaveType(fp,key->vtype) == -1) goto werr;
3673 if (rdbSaveStringObject(fp,key) == -1) goto werr;
3674 if (rdbSaveObject(fp,po) == -1) goto werr;
3675 /* Remove the loaded object from memory */
3676 decrRefCount(po);
3677 }
3678 }
3679 dictReleaseIterator(di);
3680 }
3681 /* EOF opcode */
3682 if (rdbSaveType(fp,REDIS_EOF) == -1) goto werr;
3683
3684 /* Make sure data will not remain on the OS's output buffers */
3685 fflush(fp);
3686 fsync(fileno(fp));
3687 fclose(fp);
3688
3689 /* Use RENAME to make sure the DB file is changed atomically only
3690 * if the generate DB file is ok. */
3691 if (rename(tmpfile,filename) == -1) {
3692 redisLog(REDIS_WARNING,"Error moving temp DB file on the final destination: %s", strerror(errno));
3693 unlink(tmpfile);
3694 return REDIS_ERR;
3695 }
3696 redisLog(REDIS_NOTICE,"DB saved on disk");
3697 server.dirty = 0;
3698 server.lastsave = time(NULL);
3699 return REDIS_OK;
3700
3701 werr:
3702 fclose(fp);
3703 unlink(tmpfile);
3704 redisLog(REDIS_WARNING,"Write error saving DB on disk: %s", strerror(errno));
3705 if (di) dictReleaseIterator(di);
3706 return REDIS_ERR;
3707 }
3708
3709 static int rdbSaveBackground(char *filename) {
3710 pid_t childpid;
3711
3712 if (server.bgsavechildpid != -1) return REDIS_ERR;
3713 if (server.vm_enabled) waitEmptyIOJobsQueue();
3714 if ((childpid = fork()) == 0) {
3715 /* Child */
3716 if (server.vm_enabled) vmReopenSwapFile();
3717 close(server.fd);
3718 if (rdbSave(filename) == REDIS_OK) {
3719 _exit(0);
3720 } else {
3721 _exit(1);
3722 }
3723 } else {
3724 /* Parent */
3725 if (childpid == -1) {
3726 redisLog(REDIS_WARNING,"Can't save in background: fork: %s",
3727 strerror(errno));
3728 return REDIS_ERR;
3729 }
3730 redisLog(REDIS_NOTICE,"Background saving started by pid %d",childpid);
3731 server.bgsavechildpid = childpid;
3732 updateDictResizePolicy();
3733 return REDIS_OK;
3734 }
3735 return REDIS_OK; /* unreached */
3736 }
3737
3738 static void rdbRemoveTempFile(pid_t childpid) {
3739 char tmpfile[256];
3740
3741 snprintf(tmpfile,256,"temp-%d.rdb", (int) childpid);
3742 unlink(tmpfile);
3743 }
3744
3745 static int rdbLoadType(FILE *fp) {
3746 unsigned char type;
3747 if (fread(&type,1,1,fp) == 0) return -1;
3748 return type;
3749 }
3750
3751 static time_t rdbLoadTime(FILE *fp) {
3752 int32_t t32;
3753 if (fread(&t32,4,1,fp) == 0) return -1;
3754 return (time_t) t32;
3755 }
3756
3757 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3758 * of this file for a description of how this are stored on disk.
3759 *
3760 * isencoded is set to 1 if the readed length is not actually a length but
3761 * an "encoding type", check the above comments for more info */
3762 static uint32_t rdbLoadLen(FILE *fp, int *isencoded) {
3763 unsigned char buf[2];
3764 uint32_t len;
3765 int type;
3766
3767 if (isencoded) *isencoded = 0;
3768 if (fread(buf,1,1,fp) == 0) return REDIS_RDB_LENERR;
3769 type = (buf[0]&0xC0)>>6;
3770 if (type == REDIS_RDB_6BITLEN) {
3771 /* Read a 6 bit len */
3772 return buf[0]&0x3F;
3773 } else if (type == REDIS_RDB_ENCVAL) {
3774 /* Read a 6 bit len encoding type */
3775 if (isencoded) *isencoded = 1;
3776 return buf[0]&0x3F;
3777 } else if (type == REDIS_RDB_14BITLEN) {
3778 /* Read a 14 bit len */
3779 if (fread(buf+1,1,1,fp) == 0) return REDIS_RDB_LENERR;
3780 return ((buf[0]&0x3F)<<8)|buf[1];
3781 } else {
3782 /* Read a 32 bit len */
3783 if (fread(&len,4,1,fp) == 0) return REDIS_RDB_LENERR;
3784 return ntohl(len);
3785 }
3786 }
3787
3788 static robj *rdbLoadIntegerObject(FILE *fp, int enctype) {
3789 unsigned char enc[4];
3790 long long val;
3791
3792 if (enctype == REDIS_RDB_ENC_INT8) {
3793 if (fread(enc,1,1,fp) == 0) return NULL;
3794 val = (signed char)enc[0];
3795 } else if (enctype == REDIS_RDB_ENC_INT16) {
3796 uint16_t v;
3797 if (fread(enc,2,1,fp) == 0) return NULL;
3798 v = enc[0]|(enc[1]<<8);
3799 val = (int16_t)v;
3800 } else if (enctype == REDIS_RDB_ENC_INT32) {
3801 uint32_t v;
3802 if (fread(enc,4,1,fp) == 0) return NULL;
3803 v = enc[0]|(enc[1]<<8)|(enc[2]<<16)|(enc[3]<<24);
3804 val = (int32_t)v;
3805 } else {
3806 val = 0; /* anti-warning */
3807 redisPanic("Unknown RDB integer encoding type");
3808 }
3809 return createStringObjectFromLongLong(val);
3810 }
3811
3812 static robj *rdbLoadLzfStringObject(FILE*fp) {
3813 unsigned int len, clen;
3814 unsigned char *c = NULL;
3815 sds val = NULL;
3816
3817 if ((clen = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
3818 if ((len = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
3819 if ((c = zmalloc(clen)) == NULL) goto err;
3820 if ((val = sdsnewlen(NULL,len)) == NULL) goto err;
3821 if (fread(c,clen,1,fp) == 0) goto err;
3822 if (lzf_decompress(c,clen,val,len) == 0) goto err;
3823 zfree(c);
3824 return createObject(REDIS_STRING,val);
3825 err:
3826 zfree(c);
3827 sdsfree(val);
3828 return NULL;
3829 }
3830
3831 static robj *rdbLoadStringObject(FILE*fp) {
3832 int isencoded;
3833 uint32_t len;
3834 sds val;
3835
3836 len = rdbLoadLen(fp,&isencoded);
3837 if (isencoded) {
3838 switch(len) {
3839 case REDIS_RDB_ENC_INT8:
3840 case REDIS_RDB_ENC_INT16:
3841 case REDIS_RDB_ENC_INT32:
3842 return rdbLoadIntegerObject(fp,len);
3843 case REDIS_RDB_ENC_LZF:
3844 return rdbLoadLzfStringObject(fp);
3845 default:
3846 redisPanic("Unknown RDB encoding type");
3847 }
3848 }
3849
3850 if (len == REDIS_RDB_LENERR) return NULL;
3851 val = sdsnewlen(NULL,len);
3852 if (len && fread(val,len,1,fp) == 0) {
3853 sdsfree(val);
3854 return NULL;
3855 }
3856 return createObject(REDIS_STRING,val);
3857 }
3858
3859 /* For information about double serialization check rdbSaveDoubleValue() */
3860 static int rdbLoadDoubleValue(FILE *fp, double *val) {
3861 char buf[128];
3862 unsigned char len;
3863
3864 if (fread(&len,1,1,fp) == 0) return -1;
3865 switch(len) {
3866 case 255: *val = R_NegInf; return 0;
3867 case 254: *val = R_PosInf; return 0;
3868 case 253: *val = R_Nan; return 0;
3869 default:
3870 if (fread(buf,len,1,fp) == 0) return -1;
3871 buf[len] = '\0';
3872 sscanf(buf, "%lg", val);
3873 return 0;
3874 }
3875 }
3876
3877 /* Load a Redis object of the specified type from the specified file.
3878 * On success a newly allocated object is returned, otherwise NULL. */
3879 static robj *rdbLoadObject(int type, FILE *fp) {
3880 robj *o;
3881
3882 redisLog(REDIS_DEBUG,"LOADING OBJECT %d (at %d)\n",type,ftell(fp));
3883 if (type == REDIS_STRING) {
3884 /* Read string value */
3885 if ((o = rdbLoadStringObject(fp)) == NULL) return NULL;
3886 o = tryObjectEncoding(o);
3887 } else if (type == REDIS_LIST || type == REDIS_SET) {
3888 /* Read list/set value */
3889 uint32_t listlen;
3890
3891 if ((listlen = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
3892 o = (type == REDIS_LIST) ? createListObject() : createSetObject();
3893 /* It's faster to expand the dict to the right size asap in order
3894 * to avoid rehashing */
3895 if (type == REDIS_SET && listlen > DICT_HT_INITIAL_SIZE)
3896 dictExpand(o->ptr,listlen);
3897 /* Load every single element of the list/set */
3898 while(listlen--) {
3899 robj *ele;
3900
3901 if ((ele = rdbLoadStringObject(fp)) == NULL) return NULL;
3902 ele = tryObjectEncoding(ele);
3903 if (type == REDIS_LIST) {
3904 listAddNodeTail((list*)o->ptr,ele);
3905 } else {
3906 dictAdd((dict*)o->ptr,ele,NULL);
3907 }
3908 }
3909 } else if (type == REDIS_ZSET) {
3910 /* Read list/set value */
3911 size_t zsetlen;
3912 zset *zs;
3913
3914 if ((zsetlen = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
3915 o = createZsetObject();
3916 zs = o->ptr;
3917 /* Load every single element of the list/set */
3918 while(zsetlen--) {
3919 robj *ele;
3920 double *score = zmalloc(sizeof(double));
3921
3922 if ((ele = rdbLoadStringObject(fp)) == NULL) return NULL;
3923 ele = tryObjectEncoding(ele);
3924 if (rdbLoadDoubleValue(fp,score) == -1) return NULL;
3925 dictAdd(zs->dict,ele,score);
3926 zslInsert(zs->zsl,*score,ele);
3927 incrRefCount(ele); /* added to skiplist */
3928 }
3929 } else if (type == REDIS_HASH) {
3930 size_t hashlen;
3931
3932 if ((hashlen = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
3933 o = createHashObject();
3934 /* Too many entries? Use an hash table. */
3935 if (hashlen > server.hash_max_zipmap_entries)
3936 convertToRealHash(o);
3937 /* Load every key/value, then set it into the zipmap or hash
3938 * table, as needed. */
3939 while(hashlen--) {
3940 robj *key, *val;
3941
3942 if ((key = rdbLoadStringObject(fp)) == NULL) return NULL;
3943 if ((val = rdbLoadStringObject(fp)) == NULL) return NULL;
3944 /* If we are using a zipmap and there are too big values
3945 * the object is converted to real hash table encoding. */
3946 if (o->encoding != REDIS_ENCODING_HT &&
3947 (sdslen(key->ptr) > server.hash_max_zipmap_value ||
3948 sdslen(val->ptr) > server.hash_max_zipmap_value))
3949 {
3950 convertToRealHash(o);
3951 }
3952
3953 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
3954 unsigned char *zm = o->ptr;
3955
3956 zm = zipmapSet(zm,key->ptr,sdslen(key->ptr),
3957 val->ptr,sdslen(val->ptr),NULL);
3958 o->ptr = zm;
3959 decrRefCount(key);
3960 decrRefCount(val);
3961 } else {
3962 key = tryObjectEncoding(key);
3963 val = tryObjectEncoding(val);
3964 dictAdd((dict*)o->ptr,key,val);
3965 }
3966 }
3967 } else {
3968 redisPanic("Unknown object type");
3969 }
3970 return o;
3971 }
3972
3973 static int rdbLoad(char *filename) {
3974 FILE *fp;
3975 uint32_t dbid;
3976 int type, retval, rdbver;
3977 int swap_all_values = 0;
3978 dict *d = server.db[0].dict;
3979 redisDb *db = server.db+0;
3980 char buf[1024];
3981 time_t expiretime, now = time(NULL);
3982 long long loadedkeys = 0;
3983
3984 fp = fopen(filename,"r");
3985 if (!fp) return REDIS_ERR;
3986 if (fread(buf,9,1,fp) == 0) goto eoferr;
3987 buf[9] = '\0';
3988 if (memcmp(buf,"REDIS",5) != 0) {
3989 fclose(fp);
3990 redisLog(REDIS_WARNING,"Wrong signature trying to load DB from file");
3991 return REDIS_ERR;
3992 }
3993 rdbver = atoi(buf+5);
3994 if (rdbver != 1) {
3995 fclose(fp);
3996 redisLog(REDIS_WARNING,"Can't handle RDB format version %d",rdbver);
3997 return REDIS_ERR;
3998 }
3999 while(1) {
4000 robj *key, *val;
4001
4002 expiretime = -1;
4003 /* Read type. */
4004 if ((type = rdbLoadType(fp)) == -1) goto eoferr;
4005 if (type == REDIS_EXPIRETIME) {
4006 if ((expiretime = rdbLoadTime(fp)) == -1) goto eoferr;
4007 /* We read the time so we need to read the object type again */
4008 if ((type = rdbLoadType(fp)) == -1) goto eoferr;
4009 }
4010 if (type == REDIS_EOF) break;
4011 /* Handle SELECT DB opcode as a special case */
4012 if (type == REDIS_SELECTDB) {
4013 if ((dbid = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR)
4014 goto eoferr;
4015 if (dbid >= (unsigned)server.dbnum) {
4016 redisLog(REDIS_WARNING,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server.dbnum);
4017 exit(1);
4018 }
4019 db = server.db+dbid;
4020 d = db->dict;
4021 continue;
4022 }
4023 /* Read key */
4024 if ((key = rdbLoadStringObject(fp)) == NULL) goto eoferr;
4025 /* Read value */
4026 if ((val = rdbLoadObject(type,fp)) == NULL) goto eoferr;
4027 /* Check if the key already expired */
4028 if (expiretime != -1 && expiretime < now) {
4029 decrRefCount(key);
4030 decrRefCount(val);
4031 continue;
4032 }
4033 /* Add the new object in the hash table */
4034 retval = dictAdd(d,key,val);
4035 if (retval == DICT_ERR) {
4036 redisLog(REDIS_WARNING,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", key->ptr);
4037 exit(1);
4038 }
4039 loadedkeys++;
4040 /* Set the expire time if needed */
4041 if (expiretime != -1) setExpire(db,key,expiretime);
4042
4043 /* Handle swapping while loading big datasets when VM is on */
4044
4045 /* If we detecter we are hopeless about fitting something in memory
4046 * we just swap every new key on disk. Directly...
4047 * Note that's important to check for this condition before resorting
4048 * to random sampling, otherwise we may try to swap already
4049 * swapped keys. */
4050 if (swap_all_values) {
4051 dictEntry *de = dictFind(d,key);
4052
4053 /* de may be NULL since the key already expired */
4054 if (de) {
4055 key = dictGetEntryKey(de);
4056 val = dictGetEntryVal(de);
4057
4058 if (vmSwapObjectBlocking(key,val) == REDIS_OK) {
4059 dictGetEntryVal(de) = NULL;
4060 }
4061 }
4062 continue;
4063 }
4064
4065 /* If we have still some hope of having some value fitting memory
4066 * then we try random sampling. */
4067 if (!swap_all_values && server.vm_enabled && (loadedkeys % 5000) == 0) {
4068 while (zmalloc_used_memory() > server.vm_max_memory) {
4069 if (vmSwapOneObjectBlocking() == REDIS_ERR) break;
4070 }
4071 if (zmalloc_used_memory() > server.vm_max_memory)
4072 swap_all_values = 1; /* We are already using too much mem */
4073 }
4074 }
4075 fclose(fp);
4076 return REDIS_OK;
4077
4078 eoferr: /* unexpected end of file is handled here with a fatal exit */
4079 redisLog(REDIS_WARNING,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
4080 exit(1);
4081 return REDIS_ERR; /* Just to avoid warning */
4082 }
4083
4084 /*================================== Commands =============================== */
4085
4086 static void authCommand(redisClient *c) {
4087 if (!server.requirepass || !strcmp(c->argv[1]->ptr, server.requirepass)) {
4088 c->authenticated = 1;
4089 addReply(c,shared.ok);
4090 } else {
4091 c->authenticated = 0;
4092 addReplySds(c,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
4093 }
4094 }
4095
4096 static void pingCommand(redisClient *c) {
4097 addReply(c,shared.pong);
4098 }
4099
4100 static void echoCommand(redisClient *c) {
4101 addReplyBulk(c,c->argv[1]);
4102 }
4103
4104 /*=================================== Strings =============================== */
4105
4106 static void setGenericCommand(redisClient *c, int nx, robj *key, robj *val, robj *expire) {
4107 int retval;
4108 long seconds = 0; /* initialized to avoid an harmness warning */
4109
4110 if (expire) {
4111 if (getLongFromObjectOrReply(c, expire, &seconds, NULL) != REDIS_OK)
4112 return;
4113 if (seconds <= 0) {
4114 addReplySds(c,sdsnew("-ERR invalid expire time in SETEX\r\n"));
4115 return;
4116 }
4117 }
4118
4119 if (nx) deleteIfVolatile(c->db,key);
4120 retval = dictAdd(c->db->dict,key,val);
4121 if (retval == DICT_ERR) {
4122 if (!nx) {
4123 /* If the key is about a swapped value, we want a new key object
4124 * to overwrite the old. So we delete the old key in the database.
4125 * This will also make sure that swap pages about the old object
4126 * will be marked as free. */
4127 if (server.vm_enabled && deleteIfSwapped(c->db,key))
4128 incrRefCount(key);
4129 dictReplace(c->db->dict,key,val);
4130 incrRefCount(val);
4131 } else {
4132 addReply(c,shared.czero);
4133 return;
4134 }
4135 } else {
4136 incrRefCount(key);
4137 incrRefCount(val);
4138 }
4139 server.dirty++;
4140 removeExpire(c->db,key);
4141 if (expire) setExpire(c->db,key,time(NULL)+seconds);
4142 addReply(c, nx ? shared.cone : shared.ok);
4143 }
4144
4145 static void setCommand(redisClient *c) {
4146 setGenericCommand(c,0,c->argv[1],c->argv[2],NULL);
4147 }
4148
4149 static void setnxCommand(redisClient *c) {
4150 setGenericCommand(c,1,c->argv[1],c->argv[2],NULL);
4151 }
4152
4153 static void setexCommand(redisClient *c) {
4154 setGenericCommand(c,0,c->argv[1],c->argv[3],c->argv[2]);
4155 }
4156
4157 static int getGenericCommand(redisClient *c) {
4158 robj *o;
4159
4160 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL)
4161 return REDIS_OK;
4162
4163 if (o->type != REDIS_STRING) {
4164 addReply(c,shared.wrongtypeerr);
4165 return REDIS_ERR;
4166 } else {
4167 addReplyBulk(c,o);
4168 return REDIS_OK;
4169 }
4170 }
4171
4172 static void getCommand(redisClient *c) {
4173 getGenericCommand(c);
4174 }
4175
4176 static void getsetCommand(redisClient *c) {
4177 if (getGenericCommand(c) == REDIS_ERR) return;
4178 if (dictAdd(c->db->dict,c->argv[1],c->argv[2]) == DICT_ERR) {
4179 dictReplace(c->db->dict,c->argv[1],c->argv[2]);
4180 } else {
4181 incrRefCount(c->argv[1]);
4182 }
4183 incrRefCount(c->argv[2]);
4184 server.dirty++;
4185 removeExpire(c->db,c->argv[1]);
4186 }
4187
4188 static void mgetCommand(redisClient *c) {
4189 int j;
4190
4191 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",c->argc-1));
4192 for (j = 1; j < c->argc; j++) {
4193 robj *o = lookupKeyRead(c->db,c->argv[j]);
4194 if (o == NULL) {
4195 addReply(c,shared.nullbulk);
4196 } else {
4197 if (o->type != REDIS_STRING) {
4198 addReply(c,shared.nullbulk);
4199 } else {
4200 addReplyBulk(c,o);
4201 }
4202 }
4203 }
4204 }
4205
4206 static void msetGenericCommand(redisClient *c, int nx) {
4207 int j, busykeys = 0;
4208
4209 if ((c->argc % 2) == 0) {
4210 addReplySds(c,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
4211 return;
4212 }
4213 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
4214 * set nothing at all if at least one already key exists. */
4215 if (nx) {
4216 for (j = 1; j < c->argc; j += 2) {
4217 if (lookupKeyWrite(c->db,c->argv[j]) != NULL) {
4218 busykeys++;
4219 }
4220 }
4221 }
4222 if (busykeys) {
4223 addReply(c, shared.czero);
4224 return;
4225 }
4226
4227 for (j = 1; j < c->argc; j += 2) {
4228 int retval;
4229
4230 c->argv[j+1] = tryObjectEncoding(c->argv[j+1]);
4231 retval = dictAdd(c->db->dict,c->argv[j],c->argv[j+1]);
4232 if (retval == DICT_ERR) {
4233 dictReplace(c->db->dict,c->argv[j],c->argv[j+1]);
4234 incrRefCount(c->argv[j+1]);
4235 } else {
4236 incrRefCount(c->argv[j]);
4237 incrRefCount(c->argv[j+1]);
4238 }
4239 removeExpire(c->db,c->argv[j]);
4240 }
4241 server.dirty += (c->argc-1)/2;
4242 addReply(c, nx ? shared.cone : shared.ok);
4243 }
4244
4245 static void msetCommand(redisClient *c) {
4246 msetGenericCommand(c,0);
4247 }
4248
4249 static void msetnxCommand(redisClient *c) {
4250 msetGenericCommand(c,1);
4251 }
4252
4253 static void incrDecrCommand(redisClient *c, long long incr) {
4254 long long value;
4255 int retval;
4256 robj *o;
4257
4258 o = lookupKeyWrite(c->db,c->argv[1]);
4259
4260 if (getLongLongFromObjectOrReply(c, o, &value, NULL) != REDIS_OK) return;
4261
4262 value += incr;
4263 o = createObject(REDIS_STRING,sdscatprintf(sdsempty(),"%lld",value));
4264 o = tryObjectEncoding(o);
4265 retval = dictAdd(c->db->dict,c->argv[1],o);
4266 if (retval == DICT_ERR) {
4267 dictReplace(c->db->dict,c->argv[1],o);
4268 removeExpire(c->db,c->argv[1]);
4269 } else {
4270 incrRefCount(c->argv[1]);
4271 }
4272 server.dirty++;
4273 addReply(c,shared.colon);
4274 addReply(c,o);
4275 addReply(c,shared.crlf);
4276 }
4277
4278 static void incrCommand(redisClient *c) {
4279 incrDecrCommand(c,1);
4280 }
4281
4282 static void decrCommand(redisClient *c) {
4283 incrDecrCommand(c,-1);
4284 }
4285
4286 static void incrbyCommand(redisClient *c) {
4287 long long incr;
4288
4289 if (getLongLongFromObjectOrReply(c, c->argv[2], &incr, NULL) != REDIS_OK) return;
4290 incrDecrCommand(c,incr);
4291 }
4292
4293 static void decrbyCommand(redisClient *c) {
4294 long long incr;
4295
4296 if (getLongLongFromObjectOrReply(c, c->argv[2], &incr, NULL) != REDIS_OK) return;
4297 incrDecrCommand(c,-incr);
4298 }
4299
4300 static void appendCommand(redisClient *c) {
4301 int retval;
4302 size_t totlen;
4303 robj *o;
4304
4305 o = lookupKeyWrite(c->db,c->argv[1]);
4306 if (o == NULL) {
4307 /* Create the key */
4308 retval = dictAdd(c->db->dict,c->argv[1],c->argv[2]);
4309 incrRefCount(c->argv[1]);
4310 incrRefCount(c->argv[2]);
4311 totlen = stringObjectLen(c->argv[2]);
4312 } else {
4313 dictEntry *de;
4314
4315 de = dictFind(c->db->dict,c->argv[1]);
4316 assert(de != NULL);
4317
4318 o = dictGetEntryVal(de);
4319 if (o->type != REDIS_STRING) {
4320 addReply(c,shared.wrongtypeerr);
4321 return;
4322 }
4323 /* If the object is specially encoded or shared we have to make
4324 * a copy */
4325 if (o->refcount != 1 || o->encoding != REDIS_ENCODING_RAW) {
4326 robj *decoded = getDecodedObject(o);
4327
4328 o = createStringObject(decoded->ptr, sdslen(decoded->ptr));
4329 decrRefCount(decoded);
4330 dictReplace(c->db->dict,c->argv[1],o);
4331 }
4332 /* APPEND! */
4333 if (c->argv[2]->encoding == REDIS_ENCODING_RAW) {
4334 o->ptr = sdscatlen(o->ptr,
4335 c->argv[2]->ptr, sdslen(c->argv[2]->ptr));
4336 } else {
4337 o->ptr = sdscatprintf(o->ptr, "%ld",
4338 (unsigned long) c->argv[2]->ptr);
4339 }
4340 totlen = sdslen(o->ptr);
4341 }
4342 server.dirty++;
4343 addReplySds(c,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen));
4344 }
4345
4346 static void substrCommand(redisClient *c) {
4347 robj *o;
4348 long start = atoi(c->argv[2]->ptr);
4349 long end = atoi(c->argv[3]->ptr);
4350 size_t rangelen, strlen;
4351 sds range;
4352
4353 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
4354 checkType(c,o,REDIS_STRING)) return;
4355
4356 o = getDecodedObject(o);
4357 strlen = sdslen(o->ptr);
4358
4359 /* convert negative indexes */
4360 if (start < 0) start = strlen+start;
4361 if (end < 0) end = strlen+end;
4362 if (start < 0) start = 0;
4363 if (end < 0) end = 0;
4364
4365 /* indexes sanity checks */
4366 if (start > end || (size_t)start >= strlen) {
4367 /* Out of range start or start > end result in null reply */
4368 addReply(c,shared.nullbulk);
4369 decrRefCount(o);
4370 return;
4371 }
4372 if ((size_t)end >= strlen) end = strlen-1;
4373 rangelen = (end-start)+1;
4374
4375 /* Return the result */
4376 addReplySds(c,sdscatprintf(sdsempty(),"$%zu\r\n",rangelen));
4377 range = sdsnewlen((char*)o->ptr+start,rangelen);
4378 addReplySds(c,range);
4379 addReply(c,shared.crlf);
4380 decrRefCount(o);
4381 }
4382
4383 /* ========================= Type agnostic commands ========================= */
4384
4385 static void delCommand(redisClient *c) {
4386 int deleted = 0, j;
4387
4388 for (j = 1; j < c->argc; j++) {
4389 if (deleteKey(c->db,c->argv[j])) {
4390 server.dirty++;
4391 deleted++;
4392 }
4393 }
4394 addReplyLong(c,deleted);
4395 }
4396
4397 static void existsCommand(redisClient *c) {
4398 addReply(c,lookupKeyRead(c->db,c->argv[1]) ? shared.cone : shared.czero);
4399 }
4400
4401 static void selectCommand(redisClient *c) {
4402 int id = atoi(c->argv[1]->ptr);
4403
4404 if (selectDb(c,id) == REDIS_ERR) {
4405 addReplySds(c,sdsnew("-ERR invalid DB index\r\n"));
4406 } else {
4407 addReply(c,shared.ok);
4408 }
4409 }
4410
4411 static void randomkeyCommand(redisClient *c) {
4412 dictEntry *de;
4413 robj *key;
4414
4415 while(1) {
4416 de = dictGetRandomKey(c->db->dict);
4417 if (!de || expireIfNeeded(c->db,dictGetEntryKey(de)) == 0) break;
4418 }
4419
4420 if (de == NULL) {
4421 addReply(c,shared.nullbulk);
4422 return;
4423 }
4424
4425 key = dictGetEntryKey(de);
4426 if (server.vm_enabled) {
4427 key = dupStringObject(key);
4428 addReplyBulk(c,key);
4429 decrRefCount(key);
4430 } else {
4431 addReplyBulk(c,key);
4432 }
4433 }
4434
4435 static void keysCommand(redisClient *c) {
4436 dictIterator *di;
4437 dictEntry *de;
4438 sds pattern = c->argv[1]->ptr;
4439 int plen = sdslen(pattern);
4440 unsigned long numkeys = 0;
4441 robj *lenobj = createObject(REDIS_STRING,NULL);
4442
4443 di = dictGetIterator(c->db->dict);
4444 addReply(c,lenobj);
4445 decrRefCount(lenobj);
4446 while((de = dictNext(di)) != NULL) {
4447 robj *keyobj = dictGetEntryKey(de);
4448
4449 sds key = keyobj->ptr;
4450 if ((pattern[0] == '*' && pattern[1] == '\0') ||
4451 stringmatchlen(pattern,plen,key,sdslen(key),0)) {
4452 if (expireIfNeeded(c->db,keyobj) == 0) {
4453 addReplyBulk(c,keyobj);
4454 numkeys++;
4455 }
4456 }
4457 }
4458 dictReleaseIterator(di);
4459 lenobj->ptr = sdscatprintf(sdsempty(),"*%lu\r\n",numkeys);
4460 }
4461
4462 static void dbsizeCommand(redisClient *c) {
4463 addReplySds(c,
4464 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c->db->dict)));
4465 }
4466
4467 static void lastsaveCommand(redisClient *c) {
4468 addReplySds(c,
4469 sdscatprintf(sdsempty(),":%lu\r\n",server.lastsave));
4470 }
4471
4472 static void typeCommand(redisClient *c) {
4473 robj *o;
4474 char *type;
4475
4476 o = lookupKeyRead(c->db,c->argv[1]);
4477 if (o == NULL) {
4478 type = "+none";
4479 } else {
4480 switch(o->type) {
4481 case REDIS_STRING: type = "+string"; break;
4482 case REDIS_LIST: type = "+list"; break;
4483 case REDIS_SET: type = "+set"; break;
4484 case REDIS_ZSET: type = "+zset"; break;
4485 case REDIS_HASH: type = "+hash"; break;
4486 default: type = "+unknown"; break;
4487 }
4488 }
4489 addReplySds(c,sdsnew(type));
4490 addReply(c,shared.crlf);
4491 }
4492
4493 static void saveCommand(redisClient *c) {
4494 if (server.bgsavechildpid != -1) {
4495 addReplySds(c,sdsnew("-ERR background save in progress\r\n"));
4496 return;
4497 }
4498 if (rdbSave(server.dbfilename) == REDIS_OK) {
4499 addReply(c,shared.ok);
4500 } else {
4501 addReply(c,shared.err);
4502 }
4503 }
4504
4505 static void bgsaveCommand(redisClient *c) {
4506 if (server.bgsavechildpid != -1) {
4507 addReplySds(c,sdsnew("-ERR background save already in progress\r\n"));
4508 return;
4509 }
4510 if (rdbSaveBackground(server.dbfilename) == REDIS_OK) {
4511 char *status = "+Background saving started\r\n";
4512 addReplySds(c,sdsnew(status));
4513 } else {
4514 addReply(c,shared.err);
4515 }
4516 }
4517
4518 static void shutdownCommand(redisClient *c) {
4519 redisLog(REDIS_WARNING,"User requested shutdown, saving DB...");
4520 /* Kill the saving child if there is a background saving in progress.
4521 We want to avoid race conditions, for instance our saving child may
4522 overwrite the synchronous saving did by SHUTDOWN. */
4523 if (server.bgsavechildpid != -1) {
4524 redisLog(REDIS_WARNING,"There is a live saving child. Killing it!");
4525 kill(server.bgsavechildpid,SIGKILL);
4526 rdbRemoveTempFile(server.bgsavechildpid);
4527 }
4528 if (server.appendonly) {
4529 /* Append only file: fsync() the AOF and exit */
4530 fsync(server.appendfd);
4531 if (server.vm_enabled) unlink(server.vm_swap_file);
4532 exit(0);
4533 } else {
4534 /* Snapshotting. Perform a SYNC SAVE and exit */
4535 if (rdbSave(server.dbfilename) == REDIS_OK) {
4536 if (server.daemonize)
4537 unlink(server.pidfile);
4538 redisLog(REDIS_WARNING,"%zu bytes used at exit",zmalloc_used_memory());
4539 redisLog(REDIS_WARNING,"Server exit now, bye bye...");
4540 exit(0);
4541 } else {
4542 /* Ooops.. error saving! The best we can do is to continue
4543 * operating. Note that if there was a background saving process,
4544 * in the next cron() Redis will be notified that the background
4545 * saving aborted, handling special stuff like slaves pending for
4546 * synchronization... */
4547 redisLog(REDIS_WARNING,"Error trying to save the DB, can't exit");
4548 addReplySds(c,
4549 sdsnew("-ERR can't quit, problems saving the DB\r\n"));
4550 }
4551 }
4552 }
4553
4554 static void renameGenericCommand(redisClient *c, int nx) {
4555 robj *o;
4556
4557 /* To use the same key as src and dst is probably an error */
4558 if (sdscmp(c->argv[1]->ptr,c->argv[2]->ptr) == 0) {
4559 addReply(c,shared.sameobjecterr);
4560 return;
4561 }
4562
4563 if ((o = lookupKeyWriteOrReply(c,c->argv[1],shared.nokeyerr)) == NULL)
4564 return;
4565
4566 incrRefCount(o);
4567 deleteIfVolatile(c->db,c->argv[2]);
4568 if (dictAdd(c->db->dict,c->argv[2],o) == DICT_ERR) {
4569 if (nx) {
4570 decrRefCount(o);
4571 addReply(c,shared.czero);
4572 return;
4573 }
4574 dictReplace(c->db->dict,c->argv[2],o);
4575 } else {
4576 incrRefCount(c->argv[2]);
4577 }
4578 deleteKey(c->db,c->argv[1]);
4579 server.dirty++;
4580 addReply(c,nx ? shared.cone : shared.ok);
4581 }
4582
4583 static void renameCommand(redisClient *c) {
4584 renameGenericCommand(c,0);
4585 }
4586
4587 static void renamenxCommand(redisClient *c) {
4588 renameGenericCommand(c,1);
4589 }
4590
4591 static void moveCommand(redisClient *c) {
4592 robj *o;
4593 redisDb *src, *dst;
4594 int srcid;
4595
4596 /* Obtain source and target DB pointers */
4597 src = c->db;
4598 srcid = c->db->id;
4599 if (selectDb(c,atoi(c->argv[2]->ptr)) == REDIS_ERR) {
4600 addReply(c,shared.outofrangeerr);
4601 return;
4602 }
4603 dst = c->db;
4604 selectDb(c,srcid); /* Back to the source DB */
4605
4606 /* If the user is moving using as target the same
4607 * DB as the source DB it is probably an error. */
4608 if (src == dst) {
4609 addReply(c,shared.sameobjecterr);
4610 return;
4611 }
4612
4613 /* Check if the element exists and get a reference */
4614 o = lookupKeyWrite(c->db,c->argv[1]);
4615 if (!o) {
4616 addReply(c,shared.czero);
4617 return;
4618 }
4619
4620 /* Try to add the element to the target DB */
4621 deleteIfVolatile(dst,c->argv[1]);
4622 if (dictAdd(dst->dict,c->argv[1],o) == DICT_ERR) {
4623 addReply(c,shared.czero);
4624 return;
4625 }
4626 incrRefCount(c->argv[1]);
4627 incrRefCount(o);
4628
4629 /* OK! key moved, free the entry in the source DB */
4630 deleteKey(src,c->argv[1]);
4631 server.dirty++;
4632 addReply(c,shared.cone);
4633 }
4634
4635 /* =================================== Lists ================================ */
4636 static void pushGenericCommand(redisClient *c, int where) {
4637 robj *lobj;
4638 list *list;
4639
4640 lobj = lookupKeyWrite(c->db,c->argv[1]);
4641 if (lobj == NULL) {
4642 if (handleClientsWaitingListPush(c,c->argv[1],c->argv[2])) {
4643 addReply(c,shared.cone);
4644 return;
4645 }
4646 lobj = createListObject();
4647 list = lobj->ptr;
4648 if (where == REDIS_HEAD) {
4649 listAddNodeHead(list,c->argv[2]);
4650 } else {
4651 listAddNodeTail(list,c->argv[2]);
4652 }
4653 dictAdd(c->db->dict,c->argv[1],lobj);
4654 incrRefCount(c->argv[1]);
4655 incrRefCount(c->argv[2]);
4656 } else {
4657 if (lobj->type != REDIS_LIST) {
4658 addReply(c,shared.wrongtypeerr);
4659 return;
4660 }
4661 if (handleClientsWaitingListPush(c,c->argv[1],c->argv[2])) {
4662 addReply(c,shared.cone);
4663 return;
4664 }
4665 list = lobj->ptr;
4666 if (where == REDIS_HEAD) {
4667 listAddNodeHead(list,c->argv[2]);
4668 } else {
4669 listAddNodeTail(list,c->argv[2]);
4670 }
4671 incrRefCount(c->argv[2]);
4672 }
4673 server.dirty++;
4674 addReplySds(c,sdscatprintf(sdsempty(),":%d\r\n",listLength(list)));
4675 }
4676
4677 static void lpushCommand(redisClient *c) {
4678 pushGenericCommand(c,REDIS_HEAD);
4679 }
4680
4681 static void rpushCommand(redisClient *c) {
4682 pushGenericCommand(c,REDIS_TAIL);
4683 }
4684
4685 static void llenCommand(redisClient *c) {
4686 robj *o;
4687 list *l;
4688
4689 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
4690 checkType(c,o,REDIS_LIST)) return;
4691
4692 l = o->ptr;
4693 addReplyUlong(c,listLength(l));
4694 }
4695
4696 static void lindexCommand(redisClient *c) {
4697 robj *o;
4698 int index = atoi(c->argv[2]->ptr);
4699 list *list;
4700 listNode *ln;
4701
4702 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
4703 checkType(c,o,REDIS_LIST)) return;
4704 list = o->ptr;
4705
4706 ln = listIndex(list, index);
4707 if (ln == NULL) {
4708 addReply(c,shared.nullbulk);
4709 } else {
4710 robj *ele = listNodeValue(ln);
4711 addReplyBulk(c,ele);
4712 }
4713 }
4714
4715 static void lsetCommand(redisClient *c) {
4716 robj *o;
4717 int index = atoi(c->argv[2]->ptr);
4718 list *list;
4719 listNode *ln;
4720
4721 if ((o = lookupKeyWriteOrReply(c,c->argv[1],shared.nokeyerr)) == NULL ||
4722 checkType(c,o,REDIS_LIST)) return;
4723 list = o->ptr;
4724
4725 ln = listIndex(list, index);
4726 if (ln == NULL) {
4727 addReply(c,shared.outofrangeerr);
4728 } else {
4729 robj *ele = listNodeValue(ln);
4730
4731 decrRefCount(ele);
4732 listNodeValue(ln) = c->argv[3];
4733 incrRefCount(c->argv[3]);
4734 addReply(c,shared.ok);
4735 server.dirty++;
4736 }
4737 }
4738
4739 static void popGenericCommand(redisClient *c, int where) {
4740 robj *o;
4741 list *list;
4742 listNode *ln;
4743
4744 if ((o = lookupKeyWriteOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
4745 checkType(c,o,REDIS_LIST)) return;
4746 list = o->ptr;
4747
4748 if (where == REDIS_HEAD)
4749 ln = listFirst(list);
4750 else
4751 ln = listLast(list);
4752
4753 if (ln == NULL) {
4754 addReply(c,shared.nullbulk);
4755 } else {
4756 robj *ele = listNodeValue(ln);
4757 addReplyBulk(c,ele);
4758 listDelNode(list,ln);
4759 if (listLength(list) == 0) deleteKey(c->db,c->argv[1]);
4760 server.dirty++;
4761 }
4762 }
4763
4764 static void lpopCommand(redisClient *c) {
4765 popGenericCommand(c,REDIS_HEAD);
4766 }
4767
4768 static void rpopCommand(redisClient *c) {
4769 popGenericCommand(c,REDIS_TAIL);
4770 }
4771
4772 static void lrangeCommand(redisClient *c) {
4773 robj *o;
4774 int start = atoi(c->argv[2]->ptr);
4775 int end = atoi(c->argv[3]->ptr);
4776 int llen;
4777 int rangelen, j;
4778 list *list;
4779 listNode *ln;
4780 robj *ele;
4781
4782 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.emptymultibulk)) == NULL
4783 || checkType(c,o,REDIS_LIST)) return;
4784 list = o->ptr;
4785 llen = listLength(list);
4786
4787 /* convert negative indexes */
4788 if (start < 0) start = llen+start;
4789 if (end < 0) end = llen+end;
4790 if (start < 0) start = 0;
4791 if (end < 0) end = 0;
4792
4793 /* indexes sanity checks */
4794 if (start > end || start >= llen) {
4795 /* Out of range start or start > end result in empty list */
4796 addReply(c,shared.emptymultibulk);
4797 return;
4798 }
4799 if (end >= llen) end = llen-1;
4800 rangelen = (end-start)+1;
4801
4802 /* Return the result in form of a multi-bulk reply */
4803 ln = listIndex(list, start);
4804 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",rangelen));
4805 for (j = 0; j < rangelen; j++) {
4806 ele = listNodeValue(ln);
4807 addReplyBulk(c,ele);
4808 ln = ln->next;
4809 }
4810 }
4811
4812 static void ltrimCommand(redisClient *c) {
4813 robj *o;
4814 int start = atoi(c->argv[2]->ptr);
4815 int end = atoi(c->argv[3]->ptr);
4816 int llen;
4817 int j, ltrim, rtrim;
4818 list *list;
4819 listNode *ln;
4820
4821 if ((o = lookupKeyWriteOrReply(c,c->argv[1],shared.ok)) == NULL ||
4822 checkType(c,o,REDIS_LIST)) return;
4823 list = o->ptr;
4824 llen = listLength(list);
4825
4826 /* convert negative indexes */
4827 if (start < 0) start = llen+start;
4828 if (end < 0) end = llen+end;
4829 if (start < 0) start = 0;
4830 if (end < 0) end = 0;
4831
4832 /* indexes sanity checks */
4833 if (start > end || start >= llen) {
4834 /* Out of range start or start > end result in empty list */
4835 ltrim = llen;
4836 rtrim = 0;
4837 } else {
4838 if (end >= llen) end = llen-1;
4839 ltrim = start;
4840 rtrim = llen-end-1;
4841 }
4842
4843 /* Remove list elements to perform the trim */
4844 for (j = 0; j < ltrim; j++) {
4845 ln = listFirst(list);
4846 listDelNode(list,ln);
4847 }
4848 for (j = 0; j < rtrim; j++) {
4849 ln = listLast(list);
4850 listDelNode(list,ln);
4851 }
4852 if (listLength(list) == 0) deleteKey(c->db,c->argv[1]);
4853 server.dirty++;
4854 addReply(c,shared.ok);
4855 }
4856
4857 static void lremCommand(redisClient *c) {
4858 robj *o;
4859 list *list;
4860 listNode *ln, *next;
4861 int toremove = atoi(c->argv[2]->ptr);
4862 int removed = 0;
4863 int fromtail = 0;
4864
4865 if ((o = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
4866 checkType(c,o,REDIS_LIST)) return;
4867 list = o->ptr;
4868
4869 if (toremove < 0) {
4870 toremove = -toremove;
4871 fromtail = 1;
4872 }
4873 ln = fromtail ? list->tail : list->head;
4874 while (ln) {
4875 robj *ele = listNodeValue(ln);
4876
4877 next = fromtail ? ln->prev : ln->next;
4878 if (equalStringObjects(ele,c->argv[3])) {
4879 listDelNode(list,ln);
4880 server.dirty++;
4881 removed++;
4882 if (toremove && removed == toremove) break;
4883 }
4884 ln = next;
4885 }
4886 if (listLength(list) == 0) deleteKey(c->db,c->argv[1]);
4887 addReplySds(c,sdscatprintf(sdsempty(),":%d\r\n",removed));
4888 }
4889
4890 /* This is the semantic of this command:
4891 * RPOPLPUSH srclist dstlist:
4892 * IF LLEN(srclist) > 0
4893 * element = RPOP srclist
4894 * LPUSH dstlist element
4895 * RETURN element
4896 * ELSE
4897 * RETURN nil
4898 * END
4899 * END
4900 *
4901 * The idea is to be able to get an element from a list in a reliable way
4902 * since the element is not just returned but pushed against another list
4903 * as well. This command was originally proposed by Ezra Zygmuntowicz.
4904 */
4905 static void rpoplpushcommand(redisClient *c) {
4906 robj *sobj;
4907 list *srclist;
4908 listNode *ln;
4909
4910 if ((sobj = lookupKeyWriteOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
4911 checkType(c,sobj,REDIS_LIST)) return;
4912 srclist = sobj->ptr;
4913 ln = listLast(srclist);
4914
4915 if (ln == NULL) {
4916 addReply(c,shared.nullbulk);
4917 } else {
4918 robj *dobj = lookupKeyWrite(c->db,c->argv[2]);
4919 robj *ele = listNodeValue(ln);
4920 list *dstlist;
4921
4922 if (dobj && dobj->type != REDIS_LIST) {
4923 addReply(c,shared.wrongtypeerr);
4924 return;
4925 }
4926
4927 /* Add the element to the target list (unless it's directly
4928 * passed to some BLPOP-ing client */
4929 if (!handleClientsWaitingListPush(c,c->argv[2],ele)) {
4930 if (dobj == NULL) {
4931 /* Create the list if the key does not exist */
4932 dobj = createListObject();
4933 dictAdd(c->db->dict,c->argv[2],dobj);
4934 incrRefCount(c->argv[2]);
4935 }
4936 dstlist = dobj->ptr;
4937 listAddNodeHead(dstlist,ele);
4938 incrRefCount(ele);
4939 }
4940
4941 /* Send the element to the client as reply as well */
4942 addReplyBulk(c,ele);
4943
4944 /* Finally remove the element from the source list */
4945 listDelNode(srclist,ln);
4946 if (listLength(srclist) == 0) deleteKey(c->db,c->argv[1]);
4947 server.dirty++;
4948 }
4949 }
4950
4951 /* ==================================== Sets ================================ */
4952
4953 static void saddCommand(redisClient *c) {
4954 robj *set;
4955
4956 set = lookupKeyWrite(c->db,c->argv[1]);
4957 if (set == NULL) {
4958 set = createSetObject();
4959 dictAdd(c->db->dict,c->argv[1],set);
4960 incrRefCount(c->argv[1]);
4961 } else {
4962 if (set->type != REDIS_SET) {
4963 addReply(c,shared.wrongtypeerr);
4964 return;
4965 }
4966 }
4967 if (dictAdd(set->ptr,c->argv[2],NULL) == DICT_OK) {
4968 incrRefCount(c->argv[2]);
4969 server.dirty++;
4970 addReply(c,shared.cone);
4971 } else {
4972 addReply(c,shared.czero);
4973 }
4974 }
4975
4976 static void sremCommand(redisClient *c) {
4977 robj *set;
4978
4979 if ((set = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
4980 checkType(c,set,REDIS_SET)) return;
4981
4982 if (dictDelete(set->ptr,c->argv[2]) == DICT_OK) {
4983 server.dirty++;
4984 if (htNeedsResize(set->ptr)) dictResize(set->ptr);
4985 if (dictSize((dict*)set->ptr) == 0) deleteKey(c->db,c->argv[1]);
4986 addReply(c,shared.cone);
4987 } else {
4988 addReply(c,shared.czero);
4989 }
4990 }
4991
4992 static void smoveCommand(redisClient *c) {
4993 robj *srcset, *dstset;
4994
4995 srcset = lookupKeyWrite(c->db,c->argv[1]);
4996 dstset = lookupKeyWrite(c->db,c->argv[2]);
4997
4998 /* If the source key does not exist return 0, if it's of the wrong type
4999 * raise an error */
5000 if (srcset == NULL || srcset->type != REDIS_SET) {
5001 addReply(c, srcset ? shared.wrongtypeerr : shared.czero);
5002 return;
5003 }
5004 /* Error if the destination key is not a set as well */
5005 if (dstset && dstset->type != REDIS_SET) {
5006 addReply(c,shared.wrongtypeerr);
5007 return;
5008 }
5009 /* Remove the element from the source set */
5010 if (dictDelete(srcset->ptr,c->argv[3]) == DICT_ERR) {
5011 /* Key not found in the src set! return zero */
5012 addReply(c,shared.czero);
5013 return;
5014 }
5015 if (dictSize((dict*)srcset->ptr) == 0 && srcset != dstset)
5016 deleteKey(c->db,c->argv[1]);
5017 server.dirty++;
5018 /* Add the element to the destination set */
5019 if (!dstset) {
5020 dstset = createSetObject();
5021 dictAdd(c->db->dict,c->argv[2],dstset);
5022 incrRefCount(c->argv[2]);
5023 }
5024 if (dictAdd(dstset->ptr,c->argv[3],NULL) == DICT_OK)
5025 incrRefCount(c->argv[3]);
5026 addReply(c,shared.cone);
5027 }
5028
5029 static void sismemberCommand(redisClient *c) {
5030 robj *set;
5031
5032 if ((set = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
5033 checkType(c,set,REDIS_SET)) return;
5034
5035 if (dictFind(set->ptr,c->argv[2]))
5036 addReply(c,shared.cone);
5037 else
5038 addReply(c,shared.czero);
5039 }
5040
5041 static void scardCommand(redisClient *c) {
5042 robj *o;
5043 dict *s;
5044
5045 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
5046 checkType(c,o,REDIS_SET)) return;
5047
5048 s = o->ptr;
5049 addReplyUlong(c,dictSize(s));
5050 }
5051
5052 static void spopCommand(redisClient *c) {
5053 robj *set;
5054 dictEntry *de;
5055
5056 if ((set = lookupKeyWriteOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
5057 checkType(c,set,REDIS_SET)) return;
5058
5059 de = dictGetRandomKey(set->ptr);
5060 if (de == NULL) {
5061 addReply(c,shared.nullbulk);
5062 } else {
5063 robj *ele = dictGetEntryKey(de);
5064
5065 addReplyBulk(c,ele);
5066 dictDelete(set->ptr,ele);
5067 if (htNeedsResize(set->ptr)) dictResize(set->ptr);
5068 if (dictSize((dict*)set->ptr) == 0) deleteKey(c->db,c->argv[1]);
5069 server.dirty++;
5070 }
5071 }
5072
5073 static void srandmemberCommand(redisClient *c) {
5074 robj *set;
5075 dictEntry *de;
5076
5077 if ((set = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
5078 checkType(c,set,REDIS_SET)) return;
5079
5080 de = dictGetRandomKey(set->ptr);
5081 if (de == NULL) {
5082 addReply(c,shared.nullbulk);
5083 } else {
5084 robj *ele = dictGetEntryKey(de);
5085
5086 addReplyBulk(c,ele);
5087 }
5088 }
5089
5090 static int qsortCompareSetsByCardinality(const void *s1, const void *s2) {
5091 dict **d1 = (void*) s1, **d2 = (void*) s2;
5092
5093 return dictSize(*d1)-dictSize(*d2);
5094 }
5095
5096 static void sinterGenericCommand(redisClient *c, robj **setskeys, unsigned long setsnum, robj *dstkey) {
5097 dict **dv = zmalloc(sizeof(dict*)*setsnum);
5098 dictIterator *di;
5099 dictEntry *de;
5100 robj *lenobj = NULL, *dstset = NULL;
5101 unsigned long j, cardinality = 0;
5102
5103 for (j = 0; j < setsnum; j++) {
5104 robj *setobj;
5105
5106 setobj = dstkey ?
5107 lookupKeyWrite(c->db,setskeys[j]) :
5108 lookupKeyRead(c->db,setskeys[j]);
5109 if (!setobj) {
5110 zfree(dv);
5111 if (dstkey) {
5112 if (deleteKey(c->db,dstkey))
5113 server.dirty++;
5114 addReply(c,shared.czero);
5115 } else {
5116 addReply(c,shared.emptymultibulk);
5117 }
5118 return;
5119 }
5120 if (setobj->type != REDIS_SET) {
5121 zfree(dv);
5122 addReply(c,shared.wrongtypeerr);
5123 return;
5124 }
5125 dv[j] = setobj->ptr;
5126 }
5127 /* Sort sets from the smallest to largest, this will improve our
5128 * algorithm's performace */
5129 qsort(dv,setsnum,sizeof(dict*),qsortCompareSetsByCardinality);
5130
5131 /* The first thing we should output is the total number of elements...
5132 * since this is a multi-bulk write, but at this stage we don't know
5133 * the intersection set size, so we use a trick, append an empty object
5134 * to the output list and save the pointer to later modify it with the
5135 * right length */
5136 if (!dstkey) {
5137 lenobj = createObject(REDIS_STRING,NULL);
5138 addReply(c,lenobj);
5139 decrRefCount(lenobj);
5140 } else {
5141 /* If we have a target key where to store the resulting set
5142 * create this key with an empty set inside */
5143 dstset = createSetObject();
5144 }
5145
5146 /* Iterate all the elements of the first (smallest) set, and test
5147 * the element against all the other sets, if at least one set does
5148 * not include the element it is discarded */
5149 di = dictGetIterator(dv[0]);
5150
5151 while((de = dictNext(di)) != NULL) {
5152 robj *ele;
5153
5154 for (j = 1; j < setsnum; j++)
5155 if (dictFind(dv[j],dictGetEntryKey(de)) == NULL) break;
5156 if (j != setsnum)
5157 continue; /* at least one set does not contain the member */
5158 ele = dictGetEntryKey(de);
5159 if (!dstkey) {
5160 addReplyBulk(c,ele);
5161 cardinality++;
5162 } else {
5163 dictAdd(dstset->ptr,ele,NULL);
5164 incrRefCount(ele);
5165 }
5166 }
5167 dictReleaseIterator(di);
5168
5169 if (dstkey) {
5170 /* Store the resulting set into the target, if the intersection
5171 * is not an empty set. */
5172 deleteKey(c->db,dstkey);
5173 if (dictSize((dict*)dstset->ptr) > 0) {
5174 dictAdd(c->db->dict,dstkey,dstset);
5175 incrRefCount(dstkey);
5176 addReplyLong(c,dictSize((dict*)dstset->ptr));
5177 } else {
5178 decrRefCount(dstset);
5179 addReply(c,shared.czero);
5180 }
5181 server.dirty++;
5182 } else {
5183 lenobj->ptr = sdscatprintf(sdsempty(),"*%lu\r\n",cardinality);
5184 }
5185 zfree(dv);
5186 }
5187
5188 static void sinterCommand(redisClient *c) {
5189 sinterGenericCommand(c,c->argv+1,c->argc-1,NULL);
5190 }
5191
5192 static void sinterstoreCommand(redisClient *c) {
5193 sinterGenericCommand(c,c->argv+2,c->argc-2,c->argv[1]);
5194 }
5195
5196 #define REDIS_OP_UNION 0
5197 #define REDIS_OP_DIFF 1
5198 #define REDIS_OP_INTER 2
5199
5200 static void sunionDiffGenericCommand(redisClient *c, robj **setskeys, int setsnum, robj *dstkey, int op) {
5201 dict **dv = zmalloc(sizeof(dict*)*setsnum);
5202 dictIterator *di;
5203 dictEntry *de;
5204 robj *dstset = NULL;
5205 int j, cardinality = 0;
5206
5207 for (j = 0; j < setsnum; j++) {
5208 robj *setobj;
5209
5210 setobj = dstkey ?
5211 lookupKeyWrite(c->db,setskeys[j]) :
5212 lookupKeyRead(c->db,setskeys[j]);
5213 if (!setobj) {
5214 dv[j] = NULL;
5215 continue;
5216 }
5217 if (setobj->type != REDIS_SET) {
5218 zfree(dv);
5219 addReply(c,shared.wrongtypeerr);
5220 return;
5221 }
5222 dv[j] = setobj->ptr;
5223 }
5224
5225 /* We need a temp set object to store our union. If the dstkey
5226 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
5227 * this set object will be the resulting object to set into the target key*/
5228 dstset = createSetObject();
5229
5230 /* Iterate all the elements of all the sets, add every element a single
5231 * time to the result set */
5232 for (j = 0; j < setsnum; j++) {
5233 if (op == REDIS_OP_DIFF && j == 0 && !dv[j]) break; /* result set is empty */
5234 if (!dv[j]) continue; /* non existing keys are like empty sets */
5235
5236 di = dictGetIterator(dv[j]);
5237
5238 while((de = dictNext(di)) != NULL) {
5239 robj *ele;
5240
5241 /* dictAdd will not add the same element multiple times */
5242 ele = dictGetEntryKey(de);
5243 if (op == REDIS_OP_UNION || j == 0) {
5244 if (dictAdd(dstset->ptr,ele,NULL) == DICT_OK) {
5245 incrRefCount(ele);
5246 cardinality++;
5247 }
5248 } else if (op == REDIS_OP_DIFF) {
5249 if (dictDelete(dstset->ptr,ele) == DICT_OK) {
5250 cardinality--;
5251 }
5252 }
5253 }
5254 dictReleaseIterator(di);
5255
5256 /* result set is empty? Exit asap. */
5257 if (op == REDIS_OP_DIFF && cardinality == 0) break;
5258 }
5259
5260 /* Output the content of the resulting set, if not in STORE mode */
5261 if (!dstkey) {
5262 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",cardinality));
5263 di = dictGetIterator(dstset->ptr);
5264 while((de = dictNext(di)) != NULL) {
5265 robj *ele;
5266
5267 ele = dictGetEntryKey(de);
5268 addReplyBulk(c,ele);
5269 }
5270 dictReleaseIterator(di);
5271 decrRefCount(dstset);
5272 } else {
5273 /* If we have a target key where to store the resulting set
5274 * create this key with the result set inside */
5275 deleteKey(c->db,dstkey);
5276 if (dictSize((dict*)dstset->ptr) > 0) {
5277 dictAdd(c->db->dict,dstkey,dstset);
5278 incrRefCount(dstkey);
5279 addReplyLong(c,dictSize((dict*)dstset->ptr));
5280 } else {
5281 decrRefCount(dstset);
5282 addReply(c,shared.czero);
5283 }
5284 server.dirty++;
5285 }
5286 zfree(dv);
5287 }
5288
5289 static void sunionCommand(redisClient *c) {
5290 sunionDiffGenericCommand(c,c->argv+1,c->argc-1,NULL,REDIS_OP_UNION);
5291 }
5292
5293 static void sunionstoreCommand(redisClient *c) {
5294 sunionDiffGenericCommand(c,c->argv+2,c->argc-2,c->argv[1],REDIS_OP_UNION);
5295 }
5296
5297 static void sdiffCommand(redisClient *c) {
5298 sunionDiffGenericCommand(c,c->argv+1,c->argc-1,NULL,REDIS_OP_DIFF);
5299 }
5300
5301 static void sdiffstoreCommand(redisClient *c) {
5302 sunionDiffGenericCommand(c,c->argv+2,c->argc-2,c->argv[1],REDIS_OP_DIFF);
5303 }
5304
5305 /* ==================================== ZSets =============================== */
5306
5307 /* ZSETs are ordered sets using two data structures to hold the same elements
5308 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
5309 * data structure.
5310 *
5311 * The elements are added to an hash table mapping Redis objects to scores.
5312 * At the same time the elements are added to a skip list mapping scores
5313 * to Redis objects (so objects are sorted by scores in this "view"). */
5314
5315 /* This skiplist implementation is almost a C translation of the original
5316 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
5317 * Alternative to Balanced Trees", modified in three ways:
5318 * a) this implementation allows for repeated values.
5319 * b) the comparison is not just by key (our 'score') but by satellite data.
5320 * c) there is a back pointer, so it's a doubly linked list with the back
5321 * pointers being only at "level 1". This allows to traverse the list
5322 * from tail to head, useful for ZREVRANGE. */
5323
5324 static zskiplistNode *zslCreateNode(int level, double score, robj *obj) {
5325 zskiplistNode *zn = zmalloc(sizeof(*zn));
5326
5327 zn->forward = zmalloc(sizeof(zskiplistNode*) * level);
5328 if (level > 0)
5329 zn->span = zmalloc(sizeof(unsigned int) * (level - 1));
5330 zn->score = score;
5331 zn->obj = obj;
5332 return zn;
5333 }
5334
5335 static zskiplist *zslCreate(void) {
5336 int j;
5337 zskiplist *zsl;
5338
5339 zsl = zmalloc(sizeof(*zsl));
5340 zsl->level = 1;
5341 zsl->length = 0;
5342 zsl->header = zslCreateNode(ZSKIPLIST_MAXLEVEL,0,NULL);
5343 for (j = 0; j < ZSKIPLIST_MAXLEVEL; j++) {
5344 zsl->header->forward[j] = NULL;
5345
5346 /* span has space for ZSKIPLIST_MAXLEVEL-1 elements */
5347 if (j < ZSKIPLIST_MAXLEVEL-1)
5348 zsl->header->span[j] = 0;
5349 }
5350 zsl->header->backward = NULL;
5351 zsl->tail = NULL;
5352 return zsl;
5353 }
5354
5355 static void zslFreeNode(zskiplistNode *node) {
5356 decrRefCount(node->obj);
5357 zfree(node->forward);
5358 zfree(node->span);
5359 zfree(node);
5360 }
5361
5362 static void zslFree(zskiplist *zsl) {
5363 zskiplistNode *node = zsl->header->forward[0], *next;
5364
5365 zfree(zsl->header->forward);
5366 zfree(zsl->header->span);
5367 zfree(zsl->header);
5368 while(node) {
5369 next = node->forward[0];
5370 zslFreeNode(node);
5371 node = next;
5372 }
5373 zfree(zsl);
5374 }
5375
5376 static int zslRandomLevel(void) {
5377 int level = 1;
5378 while ((random()&0xFFFF) < (ZSKIPLIST_P * 0xFFFF))
5379 level += 1;
5380 return (level<ZSKIPLIST_MAXLEVEL) ? level : ZSKIPLIST_MAXLEVEL;
5381 }
5382
5383 static void zslInsert(zskiplist *zsl, double score, robj *obj) {
5384 zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;
5385 unsigned int rank[ZSKIPLIST_MAXLEVEL];
5386 int i, level;
5387
5388 x = zsl->header;
5389 for (i = zsl->level-1; i >= 0; i--) {
5390 /* store rank that is crossed to reach the insert position */
5391 rank[i] = i == (zsl->level-1) ? 0 : rank[i+1];
5392
5393 while (x->forward[i] &&
5394 (x->forward[i]->score < score ||
5395 (x->forward[i]->score == score &&
5396 compareStringObjects(x->forward[i]->obj,obj) < 0))) {
5397 rank[i] += i > 0 ? x->span[i-1] : 1;
5398 x = x->forward[i];
5399 }
5400 update[i] = x;
5401 }
5402 /* we assume the key is not already inside, since we allow duplicated
5403 * scores, and the re-insertion of score and redis object should never
5404 * happpen since the caller of zslInsert() should test in the hash table
5405 * if the element is already inside or not. */
5406 level = zslRandomLevel();
5407 if (level > zsl->level) {
5408 for (i = zsl->level; i < level; i++) {
5409 rank[i] = 0;
5410 update[i] = zsl->header;
5411 update[i]->span[i-1] = zsl->length;
5412 }
5413 zsl->level = level;
5414 }
5415 x = zslCreateNode(level,score,obj);
5416 for (i = 0; i < level; i++) {
5417 x->forward[i] = update[i]->forward[i];
5418 update[i]->forward[i] = x;
5419
5420 /* update span covered by update[i] as x is inserted here */
5421 if (i > 0) {
5422 x->span[i-1] = update[i]->span[i-1] - (rank[0] - rank[i]);
5423 update[i]->span[i-1] = (rank[0] - rank[i]) + 1;
5424 }
5425 }
5426
5427 /* increment span for untouched levels */
5428 for (i = level; i < zsl->level; i++) {
5429 update[i]->span[i-1]++;
5430 }
5431
5432 x->backward = (update[0] == zsl->header) ? NULL : update[0];
5433 if (x->forward[0])
5434 x->forward[0]->backward = x;
5435 else
5436 zsl->tail = x;
5437 zsl->length++;
5438 }
5439
5440 /* Internal function used by zslDelete, zslDeleteByScore and zslDeleteByRank */
5441 void zslDeleteNode(zskiplist *zsl, zskiplistNode *x, zskiplistNode **update) {
5442 int i;
5443 for (i = 0; i < zsl->level; i++) {
5444 if (update[i]->forward[i] == x) {
5445 if (i > 0) {
5446 update[i]->span[i-1] += x->span[i-1] - 1;
5447 }
5448 update[i]->forward[i] = x->forward[i];
5449 } else {
5450 /* invariant: i > 0, because update[0]->forward[0]
5451 * is always equal to x */
5452 update[i]->span[i-1] -= 1;
5453 }
5454 }
5455 if (x->forward[0]) {
5456 x->forward[0]->backward = x->backward;
5457 } else {
5458 zsl->tail = x->backward;
5459 }
5460 while(zsl->level > 1 && zsl->header->forward[zsl->level-1] == NULL)
5461 zsl->level--;
5462 zsl->length--;
5463 }
5464
5465 /* Delete an element with matching score/object from the skiplist. */
5466 static int zslDelete(zskiplist *zsl, double score, robj *obj) {
5467 zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;
5468 int i;
5469
5470 x = zsl->header;
5471 for (i = zsl->level-1; i >= 0; i--) {
5472 while (x->forward[i] &&
5473 (x->forward[i]->score < score ||
5474 (x->forward[i]->score == score &&
5475 compareStringObjects(x->forward[i]->obj,obj) < 0)))
5476 x = x->forward[i];
5477 update[i] = x;
5478 }
5479 /* We may have multiple elements with the same score, what we need
5480 * is to find the element with both the right score and object. */
5481 x = x->forward[0];
5482 if (x && score == x->score && equalStringObjects(x->obj,obj)) {
5483 zslDeleteNode(zsl, x, update);
5484 zslFreeNode(x);
5485 return 1;
5486 } else {
5487 return 0; /* not found */
5488 }
5489 return 0; /* not found */
5490 }
5491
5492 /* Delete all the elements with score between min and max from the skiplist.
5493 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
5494 * Note that this function takes the reference to the hash table view of the
5495 * sorted set, in order to remove the elements from the hash table too. */
5496 static unsigned long zslDeleteRangeByScore(zskiplist *zsl, double min, double max, dict *dict) {
5497 zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;
5498 unsigned long removed = 0;
5499 int i;
5500
5501 x = zsl->header;
5502 for (i = zsl->level-1; i >= 0; i--) {
5503 while (x->forward[i] && x->forward[i]->score < min)
5504 x = x->forward[i];
5505 update[i] = x;
5506 }
5507 /* We may have multiple elements with the same score, what we need
5508 * is to find the element with both the right score and object. */
5509 x = x->forward[0];
5510 while (x && x->score <= max) {
5511 zskiplistNode *next = x->forward[0];
5512 zslDeleteNode(zsl, x, update);
5513 dictDelete(dict,x->obj);
5514 zslFreeNode(x);
5515 removed++;
5516 x = next;
5517 }
5518 return removed; /* not found */
5519 }
5520
5521 /* Delete all the elements with rank between start and end from the skiplist.
5522 * Start and end are inclusive. Note that start and end need to be 1-based */
5523 static unsigned long zslDeleteRangeByRank(zskiplist *zsl, unsigned int start, unsigned int end, dict *dict) {
5524 zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;
5525 unsigned long traversed = 0, removed = 0;
5526 int i;
5527
5528 x = zsl->header;
5529 for (i = zsl->level-1; i >= 0; i--) {
5530 while (x->forward[i] && (traversed + (i > 0 ? x->span[i-1] : 1)) < start) {
5531 traversed += i > 0 ? x->span[i-1] : 1;
5532 x = x->forward[i];
5533 }
5534 update[i] = x;
5535 }
5536
5537 traversed++;
5538 x = x->forward[0];
5539 while (x && traversed <= end) {
5540 zskiplistNode *next = x->forward[0];
5541 zslDeleteNode(zsl, x, update);
5542 dictDelete(dict,x->obj);
5543 zslFreeNode(x);
5544 removed++;
5545 traversed++;
5546 x = next;
5547 }
5548 return removed;
5549 }
5550
5551 /* Find the first node having a score equal or greater than the specified one.
5552 * Returns NULL if there is no match. */
5553 static zskiplistNode *zslFirstWithScore(zskiplist *zsl, double score) {
5554 zskiplistNode *x;
5555 int i;
5556
5557 x = zsl->header;
5558 for (i = zsl->level-1; i >= 0; i--) {
5559 while (x->forward[i] && x->forward[i]->score < score)
5560 x = x->forward[i];
5561 }
5562 /* We may have multiple elements with the same score, what we need
5563 * is to find the element with both the right score and object. */
5564 return x->forward[0];
5565 }
5566
5567 /* Find the rank for an element by both score and key.
5568 * Returns 0 when the element cannot be found, rank otherwise.
5569 * Note that the rank is 1-based due to the span of zsl->header to the
5570 * first element. */
5571 static unsigned long zslGetRank(zskiplist *zsl, double score, robj *o) {
5572 zskiplistNode *x;
5573 unsigned long rank = 0;
5574 int i;
5575
5576 x = zsl->header;
5577 for (i = zsl->level-1; i >= 0; i--) {
5578 while (x->forward[i] &&
5579 (x->forward[i]->score < score ||
5580 (x->forward[i]->score == score &&
5581 compareStringObjects(x->forward[i]->obj,o) <= 0))) {
5582 rank += i > 0 ? x->span[i-1] : 1;
5583 x = x->forward[i];
5584 }
5585
5586 /* x might be equal to zsl->header, so test if obj is non-NULL */
5587 if (x->obj && equalStringObjects(x->obj,o)) {
5588 return rank;
5589 }
5590 }
5591 return 0;
5592 }
5593
5594 /* Finds an element by its rank. The rank argument needs to be 1-based. */
5595 zskiplistNode* zslGetElementByRank(zskiplist *zsl, unsigned long rank) {
5596 zskiplistNode *x;
5597 unsigned long traversed = 0;
5598 int i;
5599
5600 x = zsl->header;
5601 for (i = zsl->level-1; i >= 0; i--) {
5602 while (x->forward[i] && (traversed + (i>0 ? x->span[i-1] : 1)) <= rank)
5603 {
5604 traversed += i > 0 ? x->span[i-1] : 1;
5605 x = x->forward[i];
5606 }
5607 if (traversed == rank) {
5608 return x;
5609 }
5610 }
5611 return NULL;
5612 }
5613
5614 /* The actual Z-commands implementations */
5615
5616 /* This generic command implements both ZADD and ZINCRBY.
5617 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
5618 * the increment if the operation is a ZINCRBY (doincrement == 1). */
5619 static void zaddGenericCommand(redisClient *c, robj *key, robj *ele, double scoreval, int doincrement) {
5620 robj *zsetobj;
5621 zset *zs;
5622 double *score;
5623
5624 zsetobj = lookupKeyWrite(c->db,key);
5625 if (zsetobj == NULL) {
5626 zsetobj = createZsetObject();
5627 dictAdd(c->db->dict,key,zsetobj);
5628 incrRefCount(key);
5629 } else {
5630 if (zsetobj->type != REDIS_ZSET) {
5631 addReply(c,shared.wrongtypeerr);
5632 return;
5633 }
5634 }
5635 zs = zsetobj->ptr;
5636
5637 /* Ok now since we implement both ZADD and ZINCRBY here the code
5638 * needs to handle the two different conditions. It's all about setting
5639 * '*score', that is, the new score to set, to the right value. */
5640 score = zmalloc(sizeof(double));
5641 if (doincrement) {
5642 dictEntry *de;
5643
5644 /* Read the old score. If the element was not present starts from 0 */
5645 de = dictFind(zs->dict,ele);
5646 if (de) {
5647 double *oldscore = dictGetEntryVal(de);
5648 *score = *oldscore + scoreval;
5649 } else {
5650 *score = scoreval;
5651 }
5652 } else {
5653 *score = scoreval;
5654 }
5655
5656 /* What follows is a simple remove and re-insert operation that is common
5657 * to both ZADD and ZINCRBY... */
5658 if (dictAdd(zs->dict,ele,score) == DICT_OK) {
5659 /* case 1: New element */
5660 incrRefCount(ele); /* added to hash */
5661 zslInsert(zs->zsl,*score,ele);
5662 incrRefCount(ele); /* added to skiplist */
5663 server.dirty++;
5664 if (doincrement)
5665 addReplyDouble(c,*score);
5666 else
5667 addReply(c,shared.cone);
5668 } else {
5669 dictEntry *de;
5670 double *oldscore;
5671
5672 /* case 2: Score update operation */
5673 de = dictFind(zs->dict,ele);
5674 redisAssert(de != NULL);
5675 oldscore = dictGetEntryVal(de);
5676 if (*score != *oldscore) {
5677 int deleted;
5678
5679 /* Remove and insert the element in the skip list with new score */
5680 deleted = zslDelete(zs->zsl,*oldscore,ele);
5681 redisAssert(deleted != 0);
5682 zslInsert(zs->zsl,*score,ele);
5683 incrRefCount(ele);
5684 /* Update the score in the hash table */
5685 dictReplace(zs->dict,ele,score);
5686 server.dirty++;
5687 } else {
5688 zfree(score);
5689 }
5690 if (doincrement)
5691 addReplyDouble(c,*score);
5692 else
5693 addReply(c,shared.czero);
5694 }
5695 }
5696
5697 static void zaddCommand(redisClient *c) {
5698 double scoreval;
5699
5700 if (getDoubleFromObjectOrReply(c, c->argv[2], &scoreval, NULL) != REDIS_OK) return;
5701 zaddGenericCommand(c,c->argv[1],c->argv[3],scoreval,0);
5702 }
5703
5704 static void zincrbyCommand(redisClient *c) {
5705 double scoreval;
5706
5707 if (getDoubleFromObjectOrReply(c, c->argv[2], &scoreval, NULL) != REDIS_OK) return;
5708 zaddGenericCommand(c,c->argv[1],c->argv[3],scoreval,1);
5709 }
5710
5711 static void zremCommand(redisClient *c) {
5712 robj *zsetobj;
5713 zset *zs;
5714 dictEntry *de;
5715 double *oldscore;
5716 int deleted;
5717
5718 if ((zsetobj = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
5719 checkType(c,zsetobj,REDIS_ZSET)) return;
5720
5721 zs = zsetobj->ptr;
5722 de = dictFind(zs->dict,c->argv[2]);
5723 if (de == NULL) {
5724 addReply(c,shared.czero);
5725 return;
5726 }
5727 /* Delete from the skiplist */
5728 oldscore = dictGetEntryVal(de);
5729 deleted = zslDelete(zs->zsl,*oldscore,c->argv[2]);
5730 redisAssert(deleted != 0);
5731
5732 /* Delete from the hash table */
5733 dictDelete(zs->dict,c->argv[2]);
5734 if (htNeedsResize(zs->dict)) dictResize(zs->dict);
5735 if (dictSize(zs->dict) == 0) deleteKey(c->db,c->argv[1]);
5736 server.dirty++;
5737 addReply(c,shared.cone);
5738 }
5739
5740 static void zremrangebyscoreCommand(redisClient *c) {
5741 double min;
5742 double max;
5743 long deleted;
5744 robj *zsetobj;
5745 zset *zs;
5746
5747 if ((getDoubleFromObjectOrReply(c, c->argv[2], &min, NULL) != REDIS_OK) ||
5748 (getDoubleFromObjectOrReply(c, c->argv[3], &max, NULL) != REDIS_OK)) return;
5749
5750 if ((zsetobj = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
5751 checkType(c,zsetobj,REDIS_ZSET)) return;
5752
5753 zs = zsetobj->ptr;
5754 deleted = zslDeleteRangeByScore(zs->zsl,min,max,zs->dict);
5755 if (htNeedsResize(zs->dict)) dictResize(zs->dict);
5756 if (dictSize(zs->dict) == 0) deleteKey(c->db,c->argv[1]);
5757 server.dirty += deleted;
5758 addReplyLong(c,deleted);
5759 }
5760
5761 static void zremrangebyrankCommand(redisClient *c) {
5762 long start;
5763 long end;
5764 int llen;
5765 long deleted;
5766 robj *zsetobj;
5767 zset *zs;
5768
5769 if ((getLongFromObjectOrReply(c, c->argv[2], &start, NULL) != REDIS_OK) ||
5770 (getLongFromObjectOrReply(c, c->argv[3], &end, NULL) != REDIS_OK)) return;
5771
5772 if ((zsetobj = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
5773 checkType(c,zsetobj,REDIS_ZSET)) return;
5774 zs = zsetobj->ptr;
5775 llen = zs->zsl->length;
5776
5777 /* convert negative indexes */
5778 if (start < 0) start = llen+start;
5779 if (end < 0) end = llen+end;
5780 if (start < 0) start = 0;
5781 if (end < 0) end = 0;
5782
5783 /* indexes sanity checks */
5784 if (start > end || start >= llen) {
5785 addReply(c,shared.czero);
5786 return;
5787 }
5788 if (end >= llen) end = llen-1;
5789
5790 /* increment start and end because zsl*Rank functions
5791 * use 1-based rank */
5792 deleted = zslDeleteRangeByRank(zs->zsl,start+1,end+1,zs->dict);
5793 if (htNeedsResize(zs->dict)) dictResize(zs->dict);
5794 if (dictSize(zs->dict) == 0) deleteKey(c->db,c->argv[1]);
5795 server.dirty += deleted;
5796 addReplyLong(c, deleted);
5797 }
5798
5799 typedef struct {
5800 dict *dict;
5801 double weight;
5802 } zsetopsrc;
5803
5804 static int qsortCompareZsetopsrcByCardinality(const void *s1, const void *s2) {
5805 zsetopsrc *d1 = (void*) s1, *d2 = (void*) s2;
5806 unsigned long size1, size2;
5807 size1 = d1->dict ? dictSize(d1->dict) : 0;
5808 size2 = d2->dict ? dictSize(d2->dict) : 0;
5809 return size1 - size2;
5810 }
5811
5812 #define REDIS_AGGR_SUM 1
5813 #define REDIS_AGGR_MIN 2
5814 #define REDIS_AGGR_MAX 3
5815
5816 inline static void zunionInterAggregate(double *target, double val, int aggregate) {
5817 if (aggregate == REDIS_AGGR_SUM) {
5818 *target = *target + val;
5819 } else if (aggregate == REDIS_AGGR_MIN) {
5820 *target = val < *target ? val : *target;
5821 } else if (aggregate == REDIS_AGGR_MAX) {
5822 *target = val > *target ? val : *target;
5823 } else {
5824 /* safety net */
5825 redisPanic("Unknown ZUNION/INTER aggregate type");
5826 }
5827 }
5828
5829 static void zunionInterGenericCommand(redisClient *c, robj *dstkey, int op) {
5830 int i, j, zsetnum;
5831 int aggregate = REDIS_AGGR_SUM;
5832 zsetopsrc *src;
5833 robj *dstobj;
5834 zset *dstzset;
5835 dictIterator *di;
5836 dictEntry *de;
5837
5838 /* expect zsetnum input keys to be given */
5839 zsetnum = atoi(c->argv[2]->ptr);
5840 if (zsetnum < 1) {
5841 addReplySds(c,sdsnew("-ERR at least 1 input key is needed for ZUNION/ZINTER\r\n"));
5842 return;
5843 }
5844
5845 /* test if the expected number of keys would overflow */
5846 if (3+zsetnum > c->argc) {
5847 addReply(c,shared.syntaxerr);
5848 return;
5849 }
5850
5851 /* read keys to be used for input */
5852 src = zmalloc(sizeof(zsetopsrc) * zsetnum);
5853 for (i = 0, j = 3; i < zsetnum; i++, j++) {
5854 robj *zsetobj = lookupKeyWrite(c->db,c->argv[j]);
5855 if (!zsetobj) {
5856 src[i].dict = NULL;
5857 } else {
5858 if (zsetobj->type != REDIS_ZSET) {
5859 zfree(src);
5860 addReply(c,shared.wrongtypeerr);
5861 return;
5862 }
5863 src[i].dict = ((zset*)zsetobj->ptr)->dict;
5864 }
5865
5866 /* default all weights to 1 */
5867 src[i].weight = 1.0;
5868 }
5869
5870 /* parse optional extra arguments */
5871 if (j < c->argc) {
5872 int remaining = c->argc - j;
5873
5874 while (remaining) {
5875 if (remaining >= (zsetnum + 1) && !strcasecmp(c->argv[j]->ptr,"weights")) {
5876 j++; remaining--;
5877 for (i = 0; i < zsetnum; i++, j++, remaining--) {
5878 if (getDoubleFromObjectOrReply(c, c->argv[j], &src[i].weight, NULL) != REDIS_OK)
5879 return;
5880 }
5881 } else if (remaining >= 2 && !strcasecmp(c->argv[j]->ptr,"aggregate")) {
5882 j++; remaining--;
5883 if (!strcasecmp(c->argv[j]->ptr,"sum")) {
5884 aggregate = REDIS_AGGR_SUM;
5885 } else if (!strcasecmp(c->argv[j]->ptr,"min")) {
5886 aggregate = REDIS_AGGR_MIN;
5887 } else if (!strcasecmp(c->argv[j]->ptr,"max")) {
5888 aggregate = REDIS_AGGR_MAX;
5889 } else {
5890 zfree(src);
5891 addReply(c,shared.syntaxerr);
5892 return;
5893 }
5894 j++; remaining--;
5895 } else {
5896 zfree(src);
5897 addReply(c,shared.syntaxerr);
5898 return;
5899 }
5900 }
5901 }
5902
5903 /* sort sets from the smallest to largest, this will improve our
5904 * algorithm's performance */
5905 qsort(src,zsetnum,sizeof(zsetopsrc), qsortCompareZsetopsrcByCardinality);
5906
5907 dstobj = createZsetObject();
5908 dstzset = dstobj->ptr;
5909
5910 if (op == REDIS_OP_INTER) {
5911 /* skip going over all entries if the smallest zset is NULL or empty */
5912 if (src[0].dict && dictSize(src[0].dict) > 0) {
5913 /* precondition: as src[0].dict is non-empty and the zsets are ordered
5914 * from small to large, all src[i > 0].dict are non-empty too */
5915 di = dictGetIterator(src[0].dict);
5916 while((de = dictNext(di)) != NULL) {
5917 double *score = zmalloc(sizeof(double)), value;
5918 *score = src[0].weight * (*(double*)dictGetEntryVal(de));
5919
5920 for (j = 1; j < zsetnum; j++) {
5921 dictEntry *other = dictFind(src[j].dict,dictGetEntryKey(de));
5922 if (other) {
5923 value = src[j].weight * (*(double*)dictGetEntryVal(other));
5924 zunionInterAggregate(score, value, aggregate);
5925 } else {
5926 break;
5927 }
5928 }
5929
5930 /* skip entry when not present in every source dict */
5931 if (j != zsetnum) {
5932 zfree(score);
5933 } else {
5934 robj *o = dictGetEntryKey(de);
5935 dictAdd(dstzset->dict,o,score);
5936 incrRefCount(o); /* added to dictionary */
5937 zslInsert(dstzset->zsl,*score,o);
5938 incrRefCount(o); /* added to skiplist */
5939 }
5940 }
5941 dictReleaseIterator(di);
5942 }
5943 } else if (op == REDIS_OP_UNION) {
5944 for (i = 0; i < zsetnum; i++) {
5945 if (!src[i].dict) continue;
5946
5947 di = dictGetIterator(src[i].dict);
5948 while((de = dictNext(di)) != NULL) {
5949 /* skip key when already processed */
5950 if (dictFind(dstzset->dict,dictGetEntryKey(de)) != NULL) continue;
5951
5952 double *score = zmalloc(sizeof(double)), value;
5953 *score = src[i].weight * (*(double*)dictGetEntryVal(de));
5954
5955 /* because the zsets are sorted by size, its only possible
5956 * for sets at larger indices to hold this entry */
5957 for (j = (i+1); j < zsetnum; j++) {
5958 dictEntry *other = dictFind(src[j].dict,dictGetEntryKey(de));
5959 if (other) {
5960 value = src[j].weight * (*(double*)dictGetEntryVal(other));
5961 zunionInterAggregate(score, value, aggregate);
5962 }
5963 }
5964
5965 robj *o = dictGetEntryKey(de);
5966 dictAdd(dstzset->dict,o,score);
5967 incrRefCount(o); /* added to dictionary */
5968 zslInsert(dstzset->zsl,*score,o);
5969 incrRefCount(o); /* added to skiplist */
5970 }
5971 dictReleaseIterator(di);
5972 }
5973 } else {
5974 /* unknown operator */
5975 redisAssert(op == REDIS_OP_INTER || op == REDIS_OP_UNION);
5976 }
5977
5978 deleteKey(c->db,dstkey);
5979 if (dstzset->zsl->length) {
5980 dictAdd(c->db->dict,dstkey,dstobj);
5981 incrRefCount(dstkey);
5982 addReplyLong(c, dstzset->zsl->length);
5983 server.dirty++;
5984 } else {
5985 decrRefCount(dstobj);
5986 addReply(c, shared.czero);
5987 }
5988 zfree(src);
5989 }
5990
5991 static void zunionCommand(redisClient *c) {
5992 zunionInterGenericCommand(c,c->argv[1], REDIS_OP_UNION);
5993 }
5994
5995 static void zinterCommand(redisClient *c) {
5996 zunionInterGenericCommand(c,c->argv[1], REDIS_OP_INTER);
5997 }
5998
5999 static void zrangeGenericCommand(redisClient *c, int reverse) {
6000 robj *o;
6001 long start;
6002 long end;
6003 int withscores = 0;
6004 int llen;
6005 int rangelen, j;
6006 zset *zsetobj;
6007 zskiplist *zsl;
6008 zskiplistNode *ln;
6009 robj *ele;
6010
6011 if ((getLongFromObjectOrReply(c, c->argv[2], &start, NULL) != REDIS_OK) ||
6012 (getLongFromObjectOrReply(c, c->argv[3], &end, NULL) != REDIS_OK)) return;
6013
6014 if (c->argc == 5 && !strcasecmp(c->argv[4]->ptr,"withscores")) {
6015 withscores = 1;
6016 } else if (c->argc >= 5) {
6017 addReply(c,shared.syntaxerr);
6018 return;
6019 }
6020
6021 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.emptymultibulk)) == NULL
6022 || checkType(c,o,REDIS_ZSET)) return;
6023 zsetobj = o->ptr;
6024 zsl = zsetobj->zsl;
6025 llen = zsl->length;
6026
6027 /* convert negative indexes */
6028 if (start < 0) start = llen+start;
6029 if (end < 0) end = llen+end;
6030 if (start < 0) start = 0;
6031 if (end < 0) end = 0;
6032
6033 /* indexes sanity checks */
6034 if (start > end || start >= llen) {
6035 /* Out of range start or start > end result in empty list */
6036 addReply(c,shared.emptymultibulk);
6037 return;
6038 }
6039 if (end >= llen) end = llen-1;
6040 rangelen = (end-start)+1;
6041
6042 /* check if starting point is trivial, before searching
6043 * the element in log(N) time */
6044 if (reverse) {
6045 ln = start == 0 ? zsl->tail : zslGetElementByRank(zsl, llen-start);
6046 } else {
6047 ln = start == 0 ?
6048 zsl->header->forward[0] : zslGetElementByRank(zsl, start+1);
6049 }
6050
6051 /* Return the result in form of a multi-bulk reply */
6052 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",
6053 withscores ? (rangelen*2) : rangelen));
6054 for (j = 0; j < rangelen; j++) {
6055 ele = ln->obj;
6056 addReplyBulk(c,ele);
6057 if (withscores)
6058 addReplyDouble(c,ln->score);
6059 ln = reverse ? ln->backward : ln->forward[0];
6060 }
6061 }
6062
6063 static void zrangeCommand(redisClient *c) {
6064 zrangeGenericCommand(c,0);
6065 }
6066
6067 static void zrevrangeCommand(redisClient *c) {
6068 zrangeGenericCommand(c,1);
6069 }
6070
6071 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
6072 * If justcount is non-zero, just the count is returned. */
6073 static void genericZrangebyscoreCommand(redisClient *c, int justcount) {
6074 robj *o;
6075 double min, max;
6076 int minex = 0, maxex = 0; /* are min or max exclusive? */
6077 int offset = 0, limit = -1;
6078 int withscores = 0;
6079 int badsyntax = 0;
6080
6081 /* Parse the min-max interval. If one of the values is prefixed
6082 * by the "(" character, it's considered "open". For instance
6083 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
6084 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
6085 if (((char*)c->argv[2]->ptr)[0] == '(') {
6086 min = strtod((char*)c->argv[2]->ptr+1,NULL);
6087 minex = 1;
6088 } else {
6089 min = strtod(c->argv[2]->ptr,NULL);
6090 }
6091 if (((char*)c->argv[3]->ptr)[0] == '(') {
6092 max = strtod((char*)c->argv[3]->ptr+1,NULL);
6093 maxex = 1;
6094 } else {
6095 max = strtod(c->argv[3]->ptr,NULL);
6096 }
6097
6098 /* Parse "WITHSCORES": note that if the command was called with
6099 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
6100 * enter the following paths to parse WITHSCORES and LIMIT. */
6101 if (c->argc == 5 || c->argc == 8) {
6102 if (strcasecmp(c->argv[c->argc-1]->ptr,"withscores") == 0)
6103 withscores = 1;
6104 else
6105 badsyntax = 1;
6106 }
6107 if (c->argc != (4 + withscores) && c->argc != (7 + withscores))
6108 badsyntax = 1;
6109 if (badsyntax) {
6110 addReplySds(c,
6111 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
6112 return;
6113 }
6114
6115 /* Parse "LIMIT" */
6116 if (c->argc == (7 + withscores) && strcasecmp(c->argv[4]->ptr,"limit")) {
6117 addReply(c,shared.syntaxerr);
6118 return;
6119 } else if (c->argc == (7 + withscores)) {
6120 offset = atoi(c->argv[5]->ptr);
6121 limit = atoi(c->argv[6]->ptr);
6122 if (offset < 0) offset = 0;
6123 }
6124
6125 /* Ok, lookup the key and get the range */
6126 o = lookupKeyRead(c->db,c->argv[1]);
6127 if (o == NULL) {
6128 addReply(c,justcount ? shared.czero : shared.emptymultibulk);
6129 } else {
6130 if (o->type != REDIS_ZSET) {
6131 addReply(c,shared.wrongtypeerr);
6132 } else {
6133 zset *zsetobj = o->ptr;
6134 zskiplist *zsl = zsetobj->zsl;
6135 zskiplistNode *ln;
6136 robj *ele, *lenobj = NULL;
6137 unsigned long rangelen = 0;
6138
6139 /* Get the first node with the score >= min, or with
6140 * score > min if 'minex' is true. */
6141 ln = zslFirstWithScore(zsl,min);
6142 while (minex && ln && ln->score == min) ln = ln->forward[0];
6143
6144 if (ln == NULL) {
6145 /* No element matching the speciifed interval */
6146 addReply(c,justcount ? shared.czero : shared.emptymultibulk);
6147 return;
6148 }
6149
6150 /* We don't know in advance how many matching elements there
6151 * are in the list, so we push this object that will represent
6152 * the multi-bulk length in the output buffer, and will "fix"
6153 * it later */
6154 if (!justcount) {
6155 lenobj = createObject(REDIS_STRING,NULL);
6156 addReply(c,lenobj);
6157 decrRefCount(lenobj);
6158 }
6159
6160 while(ln && (maxex ? (ln->score < max) : (ln->score <= max))) {
6161 if (offset) {
6162 offset--;
6163 ln = ln->forward[0];
6164 continue;
6165 }
6166 if (limit == 0) break;
6167 if (!justcount) {
6168 ele = ln->obj;
6169 addReplyBulk(c,ele);
6170 if (withscores)
6171 addReplyDouble(c,ln->score);
6172 }
6173 ln = ln->forward[0];
6174 rangelen++;
6175 if (limit > 0) limit--;
6176 }
6177 if (justcount) {
6178 addReplyLong(c,(long)rangelen);
6179 } else {
6180 lenobj->ptr = sdscatprintf(sdsempty(),"*%lu\r\n",
6181 withscores ? (rangelen*2) : rangelen);
6182 }
6183 }
6184 }
6185 }
6186
6187 static void zrangebyscoreCommand(redisClient *c) {
6188 genericZrangebyscoreCommand(c,0);
6189 }
6190
6191 static void zcountCommand(redisClient *c) {
6192 genericZrangebyscoreCommand(c,1);
6193 }
6194
6195 static void zcardCommand(redisClient *c) {
6196 robj *o;
6197 zset *zs;
6198
6199 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
6200 checkType(c,o,REDIS_ZSET)) return;
6201
6202 zs = o->ptr;
6203 addReplyUlong(c,zs->zsl->length);
6204 }
6205
6206 static void zscoreCommand(redisClient *c) {
6207 robj *o;
6208 zset *zs;
6209 dictEntry *de;
6210
6211 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
6212 checkType(c,o,REDIS_ZSET)) return;
6213
6214 zs = o->ptr;
6215 de = dictFind(zs->dict,c->argv[2]);
6216 if (!de) {
6217 addReply(c,shared.nullbulk);
6218 } else {
6219 double *score = dictGetEntryVal(de);
6220
6221 addReplyDouble(c,*score);
6222 }
6223 }
6224
6225 static void zrankGenericCommand(redisClient *c, int reverse) {
6226 robj *o;
6227 zset *zs;
6228 zskiplist *zsl;
6229 dictEntry *de;
6230 unsigned long rank;
6231 double *score;
6232
6233 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
6234 checkType(c,o,REDIS_ZSET)) return;
6235
6236 zs = o->ptr;
6237 zsl = zs->zsl;
6238 de = dictFind(zs->dict,c->argv[2]);
6239 if (!de) {
6240 addReply(c,shared.nullbulk);
6241 return;
6242 }
6243
6244 score = dictGetEntryVal(de);
6245 rank = zslGetRank(zsl, *score, c->argv[2]);
6246 if (rank) {
6247 if (reverse) {
6248 addReplyLong(c, zsl->length - rank);
6249 } else {
6250 addReplyLong(c, rank-1);
6251 }
6252 } else {
6253 addReply(c,shared.nullbulk);
6254 }
6255 }
6256
6257 static void zrankCommand(redisClient *c) {
6258 zrankGenericCommand(c, 0);
6259 }
6260
6261 static void zrevrankCommand(redisClient *c) {
6262 zrankGenericCommand(c, 1);
6263 }
6264
6265 /* ========================= Hashes utility functions ======================= */
6266 #define REDIS_HASH_KEY 1
6267 #define REDIS_HASH_VALUE 2
6268
6269 /* Check the length of a number of objects to see if we need to convert a
6270 * zipmap to a real hash. Note that we only check string encoded objects
6271 * as their string length can be queried in constant time. */
6272 static void hashTryConversion(robj *subject, robj **argv, int start, int end) {
6273 int i;
6274 if (subject->encoding != REDIS_ENCODING_ZIPMAP) return;
6275
6276 for (i = start; i <= end; i++) {
6277 if (argv[i]->encoding == REDIS_ENCODING_RAW &&
6278 sdslen(argv[i]->ptr) > server.hash_max_zipmap_value)
6279 {
6280 convertToRealHash(subject);
6281 return;
6282 }
6283 }
6284 }
6285
6286 /* Encode given objects in-place when the hash uses a dict. */
6287 static void hashTryObjectEncoding(robj *subject, robj **o1, robj **o2) {
6288 if (subject->encoding == REDIS_ENCODING_HT) {
6289 if (o1) *o1 = tryObjectEncoding(*o1);
6290 if (o2) *o2 = tryObjectEncoding(*o2);
6291 }
6292 }
6293
6294 /* Get the value from a hash identified by key. Returns either a string
6295 * object or NULL if the value cannot be found. The refcount of the object
6296 * is always increased by 1 when the value was found. */
6297 static robj *hashGet(robj *o, robj *key) {
6298 robj *value = NULL;
6299 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
6300 unsigned char *v;
6301 unsigned int vlen;
6302 key = getDecodedObject(key);
6303 if (zipmapGet(o->ptr,key->ptr,sdslen(key->ptr),&v,&vlen)) {
6304 value = createStringObject((char*)v,vlen);
6305 }
6306 decrRefCount(key);
6307 } else {
6308 dictEntry *de = dictFind(o->ptr,key);
6309 if (de != NULL) {
6310 value = dictGetEntryVal(de);
6311 incrRefCount(value);
6312 }
6313 }
6314 return value;
6315 }
6316
6317 /* Test if the key exists in the given hash. Returns 1 if the key
6318 * exists and 0 when it doesn't. */
6319 static int hashExists(robj *o, robj *key) {
6320 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
6321 key = getDecodedObject(key);
6322 if (zipmapExists(o->ptr,key->ptr,sdslen(key->ptr))) {
6323 decrRefCount(key);
6324 return 1;
6325 }
6326 decrRefCount(key);
6327 } else {
6328 if (dictFind(o->ptr,key) != NULL) {
6329 return 1;
6330 }
6331 }
6332 return 0;
6333 }
6334
6335 /* Add an element, discard the old if the key already exists.
6336 * Return 0 on insert and 1 on update. */
6337 static int hashSet(robj *o, robj *key, robj *value) {
6338 int update = 0;
6339 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
6340 key = getDecodedObject(key);
6341 value = getDecodedObject(value);
6342 o->ptr = zipmapSet(o->ptr,
6343 key->ptr,sdslen(key->ptr),
6344 value->ptr,sdslen(value->ptr), &update);
6345 decrRefCount(key);
6346 decrRefCount(value);
6347
6348 /* Check if the zipmap needs to be upgraded to a real hash table */
6349 if (zipmapLen(o->ptr) > server.hash_max_zipmap_entries)
6350 convertToRealHash(o);
6351 } else {
6352 if (dictReplace(o->ptr,key,value)) {
6353 /* Insert */
6354 incrRefCount(key);
6355 } else {
6356 /* Update */
6357 update = 1;
6358 }
6359 incrRefCount(value);
6360 }
6361 return update;
6362 }
6363
6364 /* Delete an element from a hash.
6365 * Return 1 on deleted and 0 on not found. */
6366 static int hashDelete(robj *o, robj *key) {
6367 int deleted = 0;
6368 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
6369 key = getDecodedObject(key);
6370 o->ptr = zipmapDel(o->ptr,key->ptr,sdslen(key->ptr), &deleted);
6371 decrRefCount(key);
6372 } else {
6373 deleted = dictDelete((dict*)o->ptr,key) == DICT_OK;
6374 /* Always check if the dictionary needs a resize after a delete. */
6375 if (deleted && htNeedsResize(o->ptr)) dictResize(o->ptr);
6376 }
6377 return deleted;
6378 }
6379
6380 /* Return the number of elements in a hash. */
6381 static unsigned long hashLength(robj *o) {
6382 return (o->encoding == REDIS_ENCODING_ZIPMAP) ?
6383 zipmapLen((unsigned char*)o->ptr) : dictSize((dict*)o->ptr);
6384 }
6385
6386 /* Structure to hold hash iteration abstration. Note that iteration over
6387 * hashes involves both fields and values. Because it is possible that
6388 * not both are required, store pointers in the iterator to avoid
6389 * unnecessary memory allocation for fields/values. */
6390 typedef struct {
6391 int encoding;
6392 unsigned char *zi;
6393 unsigned char *zk, *zv;
6394 unsigned int zklen, zvlen;
6395
6396 dictIterator *di;
6397 dictEntry *de;
6398 } hashIterator;
6399
6400 static hashIterator *hashInitIterator(robj *subject) {
6401 hashIterator *hi = zmalloc(sizeof(hashIterator));
6402 hi->encoding = subject->encoding;
6403 if (hi->encoding == REDIS_ENCODING_ZIPMAP) {
6404 hi->zi = zipmapRewind(subject->ptr);
6405 } else if (hi->encoding == REDIS_ENCODING_HT) {
6406 hi->di = dictGetIterator(subject->ptr);
6407 } else {
6408 redisAssert(NULL);
6409 }
6410 return hi;
6411 }
6412
6413 static void hashReleaseIterator(hashIterator *hi) {
6414 if (hi->encoding == REDIS_ENCODING_HT) {
6415 dictReleaseIterator(hi->di);
6416 }
6417 zfree(hi);
6418 }
6419
6420 /* Move to the next entry in the hash. Return REDIS_OK when the next entry
6421 * could be found and REDIS_ERR when the iterator reaches the end. */
6422 static int hashNext(hashIterator *hi) {
6423 if (hi->encoding == REDIS_ENCODING_ZIPMAP) {
6424 if ((hi->zi = zipmapNext(hi->zi, &hi->zk, &hi->zklen,
6425 &hi->zv, &hi->zvlen)) == NULL) return REDIS_ERR;
6426 } else {
6427 if ((hi->de = dictNext(hi->di)) == NULL) return REDIS_ERR;
6428 }
6429 return REDIS_OK;
6430 }
6431
6432 /* Get key or value object at current iteration position.
6433 * This increases the refcount of the field object by 1. */
6434 static robj *hashCurrent(hashIterator *hi, int what) {
6435 robj *o;
6436 if (hi->encoding == REDIS_ENCODING_ZIPMAP) {
6437 if (what & REDIS_HASH_KEY) {
6438 o = createStringObject((char*)hi->zk,hi->zklen);
6439 } else {
6440 o = createStringObject((char*)hi->zv,hi->zvlen);
6441 }
6442 } else {
6443 if (what & REDIS_HASH_KEY) {
6444 o = dictGetEntryKey(hi->de);
6445 } else {
6446 o = dictGetEntryVal(hi->de);
6447 }
6448 incrRefCount(o);
6449 }
6450 return o;
6451 }
6452
6453 static robj *hashLookupWriteOrCreate(redisClient *c, robj *key) {
6454 robj *o = lookupKeyWrite(c->db,key);
6455 if (o == NULL) {
6456 o = createHashObject();
6457 dictAdd(c->db->dict,key,o);
6458 incrRefCount(key);
6459 } else {
6460 if (o->type != REDIS_HASH) {
6461 addReply(c,shared.wrongtypeerr);
6462 return NULL;
6463 }
6464 }
6465 return o;
6466 }
6467
6468 /* ============================= Hash commands ============================== */
6469 static void hsetCommand(redisClient *c) {
6470 int update;
6471 robj *o;
6472
6473 if ((o = hashLookupWriteOrCreate(c,c->argv[1])) == NULL) return;
6474 hashTryConversion(o,c->argv,2,3);
6475 hashTryObjectEncoding(o,&c->argv[2], &c->argv[3]);
6476 update = hashSet(o,c->argv[2],c->argv[3]);
6477 addReply(c, update ? shared.czero : shared.cone);
6478 server.dirty++;
6479 }
6480
6481 static void hsetnxCommand(redisClient *c) {
6482 robj *o;
6483 if ((o = hashLookupWriteOrCreate(c,c->argv[1])) == NULL) return;
6484 hashTryConversion(o,c->argv,2,3);
6485
6486 if (hashExists(o, c->argv[2])) {
6487 addReply(c, shared.czero);
6488 } else {
6489 hashTryObjectEncoding(o,&c->argv[2], &c->argv[3]);
6490 hashSet(o,c->argv[2],c->argv[3]);
6491 addReply(c, shared.cone);
6492 server.dirty++;
6493 }
6494 }
6495
6496 static void hmsetCommand(redisClient *c) {
6497 int i;
6498 robj *o;
6499
6500 if ((c->argc % 2) == 1) {
6501 addReplySds(c,sdsnew("-ERR wrong number of arguments for HMSET\r\n"));
6502 return;
6503 }
6504
6505 if ((o = hashLookupWriteOrCreate(c,c->argv[1])) == NULL) return;
6506 hashTryConversion(o,c->argv,2,c->argc-1);
6507 for (i = 2; i < c->argc; i += 2) {
6508 hashTryObjectEncoding(o,&c->argv[i], &c->argv[i+1]);
6509 hashSet(o,c->argv[i],c->argv[i+1]);
6510 }
6511 addReply(c, shared.ok);
6512 server.dirty++;
6513 }
6514
6515 static void hincrbyCommand(redisClient *c) {
6516 long long value, incr;
6517 robj *o, *current, *new;
6518
6519 if (getLongLongFromObjectOrReply(c,c->argv[3],&incr,NULL) != REDIS_OK) return;
6520 if ((o = hashLookupWriteOrCreate(c,c->argv[1])) == NULL) return;
6521 if ((current = hashGet(o,c->argv[2])) != NULL) {
6522 if (getLongLongFromObjectOrReply(c,current,&value,
6523 "hash value is not an integer") != REDIS_OK) {
6524 decrRefCount(current);
6525 return;
6526 }
6527 decrRefCount(current);
6528 } else {
6529 value = 0;
6530 }
6531
6532 value += incr;
6533 new = createStringObjectFromLongLong(value);
6534 hashTryObjectEncoding(o,&c->argv[2],NULL);
6535 hashSet(o,c->argv[2],new);
6536 decrRefCount(new);
6537 addReplyLongLong(c,value);
6538 server.dirty++;
6539 }
6540
6541 static void hgetCommand(redisClient *c) {
6542 robj *o, *value;
6543 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
6544 checkType(c,o,REDIS_HASH)) return;
6545
6546 if ((value = hashGet(o,c->argv[2])) != NULL) {
6547 addReplyBulk(c,value);
6548 decrRefCount(value);
6549 } else {
6550 addReply(c,shared.nullbulk);
6551 }
6552 }
6553
6554 static void hmgetCommand(redisClient *c) {
6555 int i;
6556 robj *o, *value;
6557 o = lookupKeyRead(c->db,c->argv[1]);
6558 if (o != NULL && o->type != REDIS_HASH) {
6559 addReply(c,shared.wrongtypeerr);
6560 }
6561
6562 /* Note the check for o != NULL happens inside the loop. This is
6563 * done because objects that cannot be found are considered to be
6564 * an empty hash. The reply should then be a series of NULLs. */
6565 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",c->argc-2));
6566 for (i = 2; i < c->argc; i++) {
6567 if (o != NULL && (value = hashGet(o,c->argv[i])) != NULL) {
6568 addReplyBulk(c,value);
6569 decrRefCount(value);
6570 } else {
6571 addReply(c,shared.nullbulk);
6572 }
6573 }
6574 }
6575
6576 static void hdelCommand(redisClient *c) {
6577 robj *o;
6578 if ((o = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
6579 checkType(c,o,REDIS_HASH)) return;
6580
6581 if (hashDelete(o,c->argv[2])) {
6582 if (hashLength(o) == 0) deleteKey(c->db,c->argv[1]);
6583 addReply(c,shared.cone);
6584 server.dirty++;
6585 } else {
6586 addReply(c,shared.czero);
6587 }
6588 }
6589
6590 static void hlenCommand(redisClient *c) {
6591 robj *o;
6592 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
6593 checkType(c,o,REDIS_HASH)) return;
6594
6595 addReplyUlong(c,hashLength(o));
6596 }
6597
6598 static void genericHgetallCommand(redisClient *c, int flags) {
6599 robj *o, *lenobj, *obj;
6600 unsigned long count = 0;
6601 hashIterator *hi;
6602
6603 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.emptymultibulk)) == NULL
6604 || checkType(c,o,REDIS_HASH)) return;
6605
6606 lenobj = createObject(REDIS_STRING,NULL);
6607 addReply(c,lenobj);
6608 decrRefCount(lenobj);
6609
6610 hi = hashInitIterator(o);
6611 while (hashNext(hi) != REDIS_ERR) {
6612 if (flags & REDIS_HASH_KEY) {
6613 obj = hashCurrent(hi,REDIS_HASH_KEY);
6614 addReplyBulk(c,obj);
6615 decrRefCount(obj);
6616 count++;
6617 }
6618 if (flags & REDIS_HASH_VALUE) {
6619 obj = hashCurrent(hi,REDIS_HASH_VALUE);
6620 addReplyBulk(c,obj);
6621 decrRefCount(obj);
6622 count++;
6623 }
6624 }
6625 hashReleaseIterator(hi);
6626
6627 lenobj->ptr = sdscatprintf(sdsempty(),"*%lu\r\n",count);
6628 }
6629
6630 static void hkeysCommand(redisClient *c) {
6631 genericHgetallCommand(c,REDIS_HASH_KEY);
6632 }
6633
6634 static void hvalsCommand(redisClient *c) {
6635 genericHgetallCommand(c,REDIS_HASH_VALUE);
6636 }
6637
6638 static void hgetallCommand(redisClient *c) {
6639 genericHgetallCommand(c,REDIS_HASH_KEY|REDIS_HASH_VALUE);
6640 }
6641
6642 static void hexistsCommand(redisClient *c) {
6643 robj *o;
6644 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
6645 checkType(c,o,REDIS_HASH)) return;
6646
6647 addReply(c, hashExists(o,c->argv[2]) ? shared.cone : shared.czero);
6648 }
6649
6650 static void convertToRealHash(robj *o) {
6651 unsigned char *key, *val, *p, *zm = o->ptr;
6652 unsigned int klen, vlen;
6653 dict *dict = dictCreate(&hashDictType,NULL);
6654
6655 assert(o->type == REDIS_HASH && o->encoding != REDIS_ENCODING_HT);
6656 p = zipmapRewind(zm);
6657 while((p = zipmapNext(p,&key,&klen,&val,&vlen)) != NULL) {
6658 robj *keyobj, *valobj;
6659
6660 keyobj = createStringObject((char*)key,klen);
6661 valobj = createStringObject((char*)val,vlen);
6662 keyobj = tryObjectEncoding(keyobj);
6663 valobj = tryObjectEncoding(valobj);
6664 dictAdd(dict,keyobj,valobj);
6665 }
6666 o->encoding = REDIS_ENCODING_HT;
6667 o->ptr = dict;
6668 zfree(zm);
6669 }
6670
6671 /* ========================= Non type-specific commands ==================== */
6672
6673 static void flushdbCommand(redisClient *c) {
6674 server.dirty += dictSize(c->db->dict);
6675 dictEmpty(c->db->dict);
6676 dictEmpty(c->db->expires);
6677 addReply(c,shared.ok);
6678 }
6679
6680 static void flushallCommand(redisClient *c) {
6681 server.dirty += emptyDb();
6682 addReply(c,shared.ok);
6683 if (server.bgsavechildpid != -1) {
6684 kill(server.bgsavechildpid,SIGKILL);
6685 rdbRemoveTempFile(server.bgsavechildpid);
6686 }
6687 rdbSave(server.dbfilename);
6688 server.dirty++;
6689 }
6690
6691 static redisSortOperation *createSortOperation(int type, robj *pattern) {
6692 redisSortOperation *so = zmalloc(sizeof(*so));
6693 so->type = type;
6694 so->pattern = pattern;
6695 return so;
6696 }
6697
6698 /* Return the value associated to the key with a name obtained
6699 * substituting the first occurence of '*' in 'pattern' with 'subst'.
6700 * The returned object will always have its refcount increased by 1
6701 * when it is non-NULL. */
6702 static robj *lookupKeyByPattern(redisDb *db, robj *pattern, robj *subst) {
6703 char *p, *f;
6704 sds spat, ssub;
6705 robj keyobj, fieldobj, *o;
6706 int prefixlen, sublen, postfixlen, fieldlen;
6707 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
6708 struct {
6709 long len;
6710 long free;
6711 char buf[REDIS_SORTKEY_MAX+1];
6712 } keyname, fieldname;
6713
6714 /* If the pattern is "#" return the substitution object itself in order
6715 * to implement the "SORT ... GET #" feature. */
6716 spat = pattern->ptr;
6717 if (spat[0] == '#' && spat[1] == '\0') {
6718 incrRefCount(subst);
6719 return subst;
6720 }
6721
6722 /* The substitution object may be specially encoded. If so we create
6723 * a decoded object on the fly. Otherwise getDecodedObject will just
6724 * increment the ref count, that we'll decrement later. */
6725 subst = getDecodedObject(subst);
6726
6727 ssub = subst->ptr;
6728 if (sdslen(spat)+sdslen(ssub)-1 > REDIS_SORTKEY_MAX) return NULL;
6729 p = strchr(spat,'*');
6730 if (!p) {
6731 decrRefCount(subst);
6732 return NULL;
6733 }
6734
6735 /* Find out if we're dealing with a hash dereference. */
6736 if ((f = strstr(p+1, "->")) != NULL) {
6737 fieldlen = sdslen(spat)-(f-spat);
6738 /* this also copies \0 character */
6739 memcpy(fieldname.buf,f+2,fieldlen-1);
6740 fieldname.len = fieldlen-2;
6741 } else {
6742 fieldlen = 0;
6743 }
6744
6745 prefixlen = p-spat;
6746 sublen = sdslen(ssub);
6747 postfixlen = sdslen(spat)-(prefixlen+1)-fieldlen;
6748 memcpy(keyname.buf,spat,prefixlen);
6749 memcpy(keyname.buf+prefixlen,ssub,sublen);
6750 memcpy(keyname.buf+prefixlen+sublen,p+1,postfixlen);
6751 keyname.buf[prefixlen+sublen+postfixlen] = '\0';
6752 keyname.len = prefixlen+sublen+postfixlen;
6753 decrRefCount(subst);
6754
6755 /* Lookup substituted key */
6756 initStaticStringObject(keyobj,((char*)&keyname)+(sizeof(long)*2));
6757 o = lookupKeyRead(db,&keyobj);
6758 if (o == NULL) return NULL;
6759
6760 if (fieldlen > 0) {
6761 if (o->type != REDIS_HASH || fieldname.len < 1) return NULL;
6762
6763 /* Retrieve value from hash by the field name. This operation
6764 * already increases the refcount of the returned object. */
6765 initStaticStringObject(fieldobj,((char*)&fieldname)+(sizeof(long)*2));
6766 o = hashGet(o, &fieldobj);
6767 } else {
6768 if (o->type != REDIS_STRING) return NULL;
6769
6770 /* Every object that this function returns needs to have its refcount
6771 * increased. sortCommand decreases it again. */
6772 incrRefCount(o);
6773 }
6774
6775 return o;
6776 }
6777
6778 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
6779 * the additional parameter is not standard but a BSD-specific we have to
6780 * pass sorting parameters via the global 'server' structure */
6781 static int sortCompare(const void *s1, const void *s2) {
6782 const redisSortObject *so1 = s1, *so2 = s2;
6783 int cmp;
6784
6785 if (!server.sort_alpha) {
6786 /* Numeric sorting. Here it's trivial as we precomputed scores */
6787 if (so1->u.score > so2->u.score) {
6788 cmp = 1;
6789 } else if (so1->u.score < so2->u.score) {
6790 cmp = -1;
6791 } else {
6792 cmp = 0;
6793 }
6794 } else {
6795 /* Alphanumeric sorting */
6796 if (server.sort_bypattern) {
6797 if (!so1->u.cmpobj || !so2->u.cmpobj) {
6798 /* At least one compare object is NULL */
6799 if (so1->u.cmpobj == so2->u.cmpobj)
6800 cmp = 0;
6801 else if (so1->u.cmpobj == NULL)
6802 cmp = -1;
6803 else
6804 cmp = 1;
6805 } else {
6806 /* We have both the objects, use strcoll */
6807 cmp = strcoll(so1->u.cmpobj->ptr,so2->u.cmpobj->ptr);
6808 }
6809 } else {
6810 /* Compare elements directly. */
6811 cmp = compareStringObjects(so1->obj,so2->obj);
6812 }
6813 }
6814 return server.sort_desc ? -cmp : cmp;
6815 }
6816
6817 /* The SORT command is the most complex command in Redis. Warning: this code
6818 * is optimized for speed and a bit less for readability */
6819 static void sortCommand(redisClient *c) {
6820 list *operations;
6821 int outputlen = 0;
6822 int desc = 0, alpha = 0;
6823 int limit_start = 0, limit_count = -1, start, end;
6824 int j, dontsort = 0, vectorlen;
6825 int getop = 0; /* GET operation counter */
6826 robj *sortval, *sortby = NULL, *storekey = NULL;
6827 redisSortObject *vector; /* Resulting vector to sort */
6828
6829 /* Lookup the key to sort. It must be of the right types */
6830 sortval = lookupKeyRead(c->db,c->argv[1]);
6831 if (sortval == NULL) {
6832 addReply(c,shared.emptymultibulk);
6833 return;
6834 }
6835 if (sortval->type != REDIS_SET && sortval->type != REDIS_LIST &&
6836 sortval->type != REDIS_ZSET)
6837 {
6838 addReply(c,shared.wrongtypeerr);
6839 return;
6840 }
6841
6842 /* Create a list of operations to perform for every sorted element.
6843 * Operations can be GET/DEL/INCR/DECR */
6844 operations = listCreate();
6845 listSetFreeMethod(operations,zfree);
6846 j = 2;
6847
6848 /* Now we need to protect sortval incrementing its count, in the future
6849 * SORT may have options able to overwrite/delete keys during the sorting
6850 * and the sorted key itself may get destroied */
6851 incrRefCount(sortval);
6852
6853 /* The SORT command has an SQL-alike syntax, parse it */
6854 while(j < c->argc) {
6855 int leftargs = c->argc-j-1;
6856 if (!strcasecmp(c->argv[j]->ptr,"asc")) {
6857 desc = 0;
6858 } else if (!strcasecmp(c->argv[j]->ptr,"desc")) {
6859 desc = 1;
6860 } else if (!strcasecmp(c->argv[j]->ptr,"alpha")) {
6861 alpha = 1;
6862 } else if (!strcasecmp(c->argv[j]->ptr,"limit") && leftargs >= 2) {
6863 limit_start = atoi(c->argv[j+1]->ptr);
6864 limit_count = atoi(c->argv[j+2]->ptr);
6865 j+=2;
6866 } else if (!strcasecmp(c->argv[j]->ptr,"store") && leftargs >= 1) {
6867 storekey = c->argv[j+1];
6868 j++;
6869 } else if (!strcasecmp(c->argv[j]->ptr,"by") && leftargs >= 1) {
6870 sortby = c->argv[j+1];
6871 /* If the BY pattern does not contain '*', i.e. it is constant,
6872 * we don't need to sort nor to lookup the weight keys. */
6873 if (strchr(c->argv[j+1]->ptr,'*') == NULL) dontsort = 1;
6874 j++;
6875 } else if (!strcasecmp(c->argv[j]->ptr,"get") && leftargs >= 1) {
6876 listAddNodeTail(operations,createSortOperation(
6877 REDIS_SORT_GET,c->argv[j+1]));
6878 getop++;
6879 j++;
6880 } else {
6881 decrRefCount(sortval);
6882 listRelease(operations);
6883 addReply(c,shared.syntaxerr);
6884 return;
6885 }
6886 j++;
6887 }
6888
6889 /* Load the sorting vector with all the objects to sort */
6890 switch(sortval->type) {
6891 case REDIS_LIST: vectorlen = listLength((list*)sortval->ptr); break;
6892 case REDIS_SET: vectorlen = dictSize((dict*)sortval->ptr); break;
6893 case REDIS_ZSET: vectorlen = dictSize(((zset*)sortval->ptr)->dict); break;
6894 default: vectorlen = 0; redisPanic("Bad SORT type"); /* Avoid GCC warning */
6895 }
6896 vector = zmalloc(sizeof(redisSortObject)*vectorlen);
6897 j = 0;
6898
6899 if (sortval->type == REDIS_LIST) {
6900 list *list = sortval->ptr;
6901 listNode *ln;
6902 listIter li;
6903
6904 listRewind(list,&li);
6905 while((ln = listNext(&li))) {
6906 robj *ele = ln->value;
6907 vector[j].obj = ele;
6908 vector[j].u.score = 0;
6909 vector[j].u.cmpobj = NULL;
6910 j++;
6911 }
6912 } else {
6913 dict *set;
6914 dictIterator *di;
6915 dictEntry *setele;
6916
6917 if (sortval->type == REDIS_SET) {
6918 set = sortval->ptr;
6919 } else {
6920 zset *zs = sortval->ptr;
6921 set = zs->dict;
6922 }
6923
6924 di = dictGetIterator(set);
6925 while((setele = dictNext(di)) != NULL) {
6926 vector[j].obj = dictGetEntryKey(setele);
6927 vector[j].u.score = 0;
6928 vector[j].u.cmpobj = NULL;
6929 j++;
6930 }
6931 dictReleaseIterator(di);
6932 }
6933 redisAssert(j == vectorlen);
6934
6935 /* Now it's time to load the right scores in the sorting vector */
6936 if (dontsort == 0) {
6937 for (j = 0; j < vectorlen; j++) {
6938 robj *byval;
6939 if (sortby) {
6940 /* lookup value to sort by */
6941 byval = lookupKeyByPattern(c->db,sortby,vector[j].obj);
6942 if (!byval) continue;
6943 } else {
6944 /* use object itself to sort by */
6945 byval = vector[j].obj;
6946 }
6947
6948 if (alpha) {
6949 if (sortby) vector[j].u.cmpobj = getDecodedObject(byval);
6950 } else {
6951 if (byval->encoding == REDIS_ENCODING_RAW) {
6952 vector[j].u.score = strtod(byval->ptr,NULL);
6953 } else if (byval->encoding == REDIS_ENCODING_INT) {
6954 /* Don't need to decode the object if it's
6955 * integer-encoded (the only encoding supported) so
6956 * far. We can just cast it */
6957 vector[j].u.score = (long)byval->ptr;
6958 } else {
6959 redisAssert(1 != 1);
6960 }
6961 }
6962
6963 /* when the object was retrieved using lookupKeyByPattern,
6964 * its refcount needs to be decreased. */
6965 if (sortby) {
6966 decrRefCount(byval);
6967 }
6968 }
6969 }
6970
6971 /* We are ready to sort the vector... perform a bit of sanity check
6972 * on the LIMIT option too. We'll use a partial version of quicksort. */
6973 start = (limit_start < 0) ? 0 : limit_start;
6974 end = (limit_count < 0) ? vectorlen-1 : start+limit_count-1;
6975 if (start >= vectorlen) {
6976 start = vectorlen-1;
6977 end = vectorlen-2;
6978 }
6979 if (end >= vectorlen) end = vectorlen-1;
6980
6981 if (dontsort == 0) {
6982 server.sort_desc = desc;
6983 server.sort_alpha = alpha;
6984 server.sort_bypattern = sortby ? 1 : 0;
6985 if (sortby && (start != 0 || end != vectorlen-1))
6986 pqsort(vector,vectorlen,sizeof(redisSortObject),sortCompare, start,end);
6987 else
6988 qsort(vector,vectorlen,sizeof(redisSortObject),sortCompare);
6989 }
6990
6991 /* Send command output to the output buffer, performing the specified
6992 * GET/DEL/INCR/DECR operations if any. */
6993 outputlen = getop ? getop*(end-start+1) : end-start+1;
6994 if (storekey == NULL) {
6995 /* STORE option not specified, sent the sorting result to client */
6996 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",outputlen));
6997 for (j = start; j <= end; j++) {
6998 listNode *ln;
6999 listIter li;
7000
7001 if (!getop) addReplyBulk(c,vector[j].obj);
7002 listRewind(operations,&li);
7003 while((ln = listNext(&li))) {
7004 redisSortOperation *sop = ln->value;
7005 robj *val = lookupKeyByPattern(c->db,sop->pattern,
7006 vector[j].obj);
7007
7008 if (sop->type == REDIS_SORT_GET) {
7009 if (!val) {
7010 addReply(c,shared.nullbulk);
7011 } else {
7012 addReplyBulk(c,val);
7013 decrRefCount(val);
7014 }
7015 } else {
7016 redisAssert(sop->type == REDIS_SORT_GET); /* always fails */
7017 }
7018 }
7019 }
7020 } else {
7021 robj *listObject = createListObject();
7022 list *listPtr = (list*) listObject->ptr;
7023
7024 /* STORE option specified, set the sorting result as a List object */
7025 for (j = start; j <= end; j++) {
7026 listNode *ln;
7027 listIter li;
7028
7029 if (!getop) {
7030 listAddNodeTail(listPtr,vector[j].obj);
7031 incrRefCount(vector[j].obj);
7032 }
7033 listRewind(operations,&li);
7034 while((ln = listNext(&li))) {
7035 redisSortOperation *sop = ln->value;
7036 robj *val = lookupKeyByPattern(c->db,sop->pattern,
7037 vector[j].obj);
7038
7039 if (sop->type == REDIS_SORT_GET) {
7040 if (!val) {
7041 listAddNodeTail(listPtr,createStringObject("",0));
7042 } else {
7043 /* We should do a incrRefCount on val because it is
7044 * added to the list, but also a decrRefCount because
7045 * it is returned by lookupKeyByPattern. This results
7046 * in doing nothing at all. */
7047 listAddNodeTail(listPtr,val);
7048 }
7049 } else {
7050 redisAssert(sop->type == REDIS_SORT_GET); /* always fails */
7051 }
7052 }
7053 }
7054 if (dictReplace(c->db->dict,storekey,listObject)) {
7055 incrRefCount(storekey);
7056 }
7057 /* Note: we add 1 because the DB is dirty anyway since even if the
7058 * SORT result is empty a new key is set and maybe the old content
7059 * replaced. */
7060 server.dirty += 1+outputlen;
7061 addReplySds(c,sdscatprintf(sdsempty(),":%d\r\n",outputlen));
7062 }
7063
7064 /* Cleanup */
7065 decrRefCount(sortval);
7066 listRelease(operations);
7067 for (j = 0; j < vectorlen; j++) {
7068 if (alpha && vector[j].u.cmpobj)
7069 decrRefCount(vector[j].u.cmpobj);
7070 }
7071 zfree(vector);
7072 }
7073
7074 /* Convert an amount of bytes into a human readable string in the form
7075 * of 100B, 2G, 100M, 4K, and so forth. */
7076 static void bytesToHuman(char *s, unsigned long long n) {
7077 double d;
7078
7079 if (n < 1024) {
7080 /* Bytes */
7081 sprintf(s,"%lluB",n);
7082 return;
7083 } else if (n < (1024*1024)) {
7084 d = (double)n/(1024);
7085 sprintf(s,"%.2fK",d);
7086 } else if (n < (1024LL*1024*1024)) {
7087 d = (double)n/(1024*1024);
7088 sprintf(s,"%.2fM",d);
7089 } else if (n < (1024LL*1024*1024*1024)) {
7090 d = (double)n/(1024LL*1024*1024);
7091 sprintf(s,"%.2fG",d);
7092 }
7093 }
7094
7095 /* Create the string returned by the INFO command. This is decoupled
7096 * by the INFO command itself as we need to report the same information
7097 * on memory corruption problems. */
7098 static sds genRedisInfoString(void) {
7099 sds info;
7100 time_t uptime = time(NULL)-server.stat_starttime;
7101 int j;
7102 char hmem[64];
7103
7104 bytesToHuman(hmem,zmalloc_used_memory());
7105 info = sdscatprintf(sdsempty(),
7106 "redis_version:%s\r\n"
7107 "arch_bits:%s\r\n"
7108 "multiplexing_api:%s\r\n"
7109 "process_id:%ld\r\n"
7110 "uptime_in_seconds:%ld\r\n"
7111 "uptime_in_days:%ld\r\n"
7112 "connected_clients:%d\r\n"
7113 "connected_slaves:%d\r\n"
7114 "blocked_clients:%d\r\n"
7115 "used_memory:%zu\r\n"
7116 "used_memory_human:%s\r\n"
7117 "changes_since_last_save:%lld\r\n"
7118 "bgsave_in_progress:%d\r\n"
7119 "last_save_time:%ld\r\n"
7120 "bgrewriteaof_in_progress:%d\r\n"
7121 "total_connections_received:%lld\r\n"
7122 "total_commands_processed:%lld\r\n"
7123 "expired_keys:%lld\r\n"
7124 "hash_max_zipmap_entries:%ld\r\n"
7125 "hash_max_zipmap_value:%ld\r\n"
7126 "pubsub_channels:%ld\r\n"
7127 "pubsub_patterns:%u\r\n"
7128 "vm_enabled:%d\r\n"
7129 "role:%s\r\n"
7130 ,REDIS_VERSION,
7131 (sizeof(long) == 8) ? "64" : "32",
7132 aeGetApiName(),
7133 (long) getpid(),
7134 uptime,
7135 uptime/(3600*24),
7136 listLength(server.clients)-listLength(server.slaves),
7137 listLength(server.slaves),
7138 server.blpop_blocked_clients,
7139 zmalloc_used_memory(),
7140 hmem,
7141 server.dirty,
7142 server.bgsavechildpid != -1,
7143 server.lastsave,
7144 server.bgrewritechildpid != -1,
7145 server.stat_numconnections,
7146 server.stat_numcommands,
7147 server.stat_expiredkeys,
7148 server.hash_max_zipmap_entries,
7149 server.hash_max_zipmap_value,
7150 dictSize(server.pubsub_channels),
7151 listLength(server.pubsub_patterns),
7152 server.vm_enabled != 0,
7153 server.masterhost == NULL ? "master" : "slave"
7154 );
7155 if (server.masterhost) {
7156 info = sdscatprintf(info,
7157 "master_host:%s\r\n"
7158 "master_port:%d\r\n"
7159 "master_link_status:%s\r\n"
7160 "master_last_io_seconds_ago:%d\r\n"
7161 ,server.masterhost,
7162 server.masterport,
7163 (server.replstate == REDIS_REPL_CONNECTED) ?
7164 "up" : "down",
7165 server.master ? ((int)(time(NULL)-server.master->lastinteraction)) : -1
7166 );
7167 }
7168 if (server.vm_enabled) {
7169 lockThreadedIO();
7170 info = sdscatprintf(info,
7171 "vm_conf_max_memory:%llu\r\n"
7172 "vm_conf_page_size:%llu\r\n"
7173 "vm_conf_pages:%llu\r\n"
7174 "vm_stats_used_pages:%llu\r\n"
7175 "vm_stats_swapped_objects:%llu\r\n"
7176 "vm_stats_swappin_count:%llu\r\n"
7177 "vm_stats_swappout_count:%llu\r\n"
7178 "vm_stats_io_newjobs_len:%lu\r\n"
7179 "vm_stats_io_processing_len:%lu\r\n"
7180 "vm_stats_io_processed_len:%lu\r\n"
7181 "vm_stats_io_active_threads:%lu\r\n"
7182 "vm_stats_blocked_clients:%lu\r\n"
7183 ,(unsigned long long) server.vm_max_memory,
7184 (unsigned long long) server.vm_page_size,
7185 (unsigned long long) server.vm_pages,
7186 (unsigned long long) server.vm_stats_used_pages,
7187 (unsigned long long) server.vm_stats_swapped_objects,
7188 (unsigned long long) server.vm_stats_swapins,
7189 (unsigned long long) server.vm_stats_swapouts,
7190 (unsigned long) listLength(server.io_newjobs),
7191 (unsigned long) listLength(server.io_processing),
7192 (unsigned long) listLength(server.io_processed),
7193 (unsigned long) server.io_active_threads,
7194 (unsigned long) server.vm_blocked_clients
7195 );
7196 unlockThreadedIO();
7197 }
7198 for (j = 0; j < server.dbnum; j++) {
7199 long long keys, vkeys;
7200
7201 keys = dictSize(server.db[j].dict);
7202 vkeys = dictSize(server.db[j].expires);
7203 if (keys || vkeys) {
7204 info = sdscatprintf(info, "db%d:keys=%lld,expires=%lld\r\n",
7205 j, keys, vkeys);
7206 }
7207 }
7208 return info;
7209 }
7210
7211 static void infoCommand(redisClient *c) {
7212 sds info = genRedisInfoString();
7213 addReplySds(c,sdscatprintf(sdsempty(),"$%lu\r\n",
7214 (unsigned long)sdslen(info)));
7215 addReplySds(c,info);
7216 addReply(c,shared.crlf);
7217 }
7218
7219 static void monitorCommand(redisClient *c) {
7220 /* ignore MONITOR if aleady slave or in monitor mode */
7221 if (c->flags & REDIS_SLAVE) return;
7222
7223 c->flags |= (REDIS_SLAVE|REDIS_MONITOR);
7224 c->slaveseldb = 0;
7225 listAddNodeTail(server.monitors,c);
7226 addReply(c,shared.ok);
7227 }
7228
7229 /* ================================= Expire ================================= */
7230 static int removeExpire(redisDb *db, robj *key) {
7231 if (dictDelete(db->expires,key) == DICT_OK) {
7232 return 1;
7233 } else {
7234 return 0;
7235 }
7236 }
7237
7238 static int setExpire(redisDb *db, robj *key, time_t when) {
7239 if (dictAdd(db->expires,key,(void*)when) == DICT_ERR) {
7240 return 0;
7241 } else {
7242 incrRefCount(key);
7243 return 1;
7244 }
7245 }
7246
7247 /* Return the expire time of the specified key, or -1 if no expire
7248 * is associated with this key (i.e. the key is non volatile) */
7249 static time_t getExpire(redisDb *db, robj *key) {
7250 dictEntry *de;
7251
7252 /* No expire? return ASAP */
7253 if (dictSize(db->expires) == 0 ||
7254 (de = dictFind(db->expires,key)) == NULL) return -1;
7255
7256 return (time_t) dictGetEntryVal(de);
7257 }
7258
7259 static int expireIfNeeded(redisDb *db, robj *key) {
7260 time_t when;
7261 dictEntry *de;
7262
7263 /* No expire? return ASAP */
7264 if (dictSize(db->expires) == 0 ||
7265 (de = dictFind(db->expires,key)) == NULL) return 0;
7266
7267 /* Lookup the expire */
7268 when = (time_t) dictGetEntryVal(de);
7269 if (time(NULL) <= when) return 0;
7270
7271 /* Delete the key */
7272 dictDelete(db->expires,key);
7273 server.stat_expiredkeys++;
7274 return dictDelete(db->dict,key) == DICT_OK;
7275 }
7276
7277 static int deleteIfVolatile(redisDb *db, robj *key) {
7278 dictEntry *de;
7279
7280 /* No expire? return ASAP */
7281 if (dictSize(db->expires) == 0 ||
7282 (de = dictFind(db->expires,key)) == NULL) return 0;
7283
7284 /* Delete the key */
7285 server.dirty++;
7286 server.stat_expiredkeys++;
7287 dictDelete(db->expires,key);
7288 return dictDelete(db->dict,key) == DICT_OK;
7289 }
7290
7291 static void expireGenericCommand(redisClient *c, robj *key, robj *param, long offset) {
7292 dictEntry *de;
7293 time_t seconds;
7294
7295 if (getLongFromObjectOrReply(c, param, &seconds, NULL) != REDIS_OK) return;
7296
7297 seconds -= offset;
7298
7299 de = dictFind(c->db->dict,key);
7300 if (de == NULL) {
7301 addReply(c,shared.czero);
7302 return;
7303 }
7304 if (seconds <= 0) {
7305 if (deleteKey(c->db,key)) server.dirty++;
7306 addReply(c, shared.cone);
7307 return;
7308 } else {
7309 time_t when = time(NULL)+seconds;
7310 if (setExpire(c->db,key,when)) {
7311 addReply(c,shared.cone);
7312 server.dirty++;
7313 } else {
7314 addReply(c,shared.czero);
7315 }
7316 return;
7317 }
7318 }
7319
7320 static void expireCommand(redisClient *c) {
7321 expireGenericCommand(c,c->argv[1],c->argv[2],0);
7322 }
7323
7324 static void expireatCommand(redisClient *c) {
7325 expireGenericCommand(c,c->argv[1],c->argv[2],time(NULL));
7326 }
7327
7328 static void ttlCommand(redisClient *c) {
7329 time_t expire;
7330 int ttl = -1;
7331
7332 expire = getExpire(c->db,c->argv[1]);
7333 if (expire != -1) {
7334 ttl = (int) (expire-time(NULL));
7335 if (ttl < 0) ttl = -1;
7336 }
7337 addReplySds(c,sdscatprintf(sdsempty(),":%d\r\n",ttl));
7338 }
7339
7340 /* ================================ MULTI/EXEC ============================== */
7341
7342 /* Client state initialization for MULTI/EXEC */
7343 static void initClientMultiState(redisClient *c) {
7344 c->mstate.commands = NULL;
7345 c->mstate.count = 0;
7346 }
7347
7348 /* Release all the resources associated with MULTI/EXEC state */
7349 static void freeClientMultiState(redisClient *c) {
7350 int j;
7351
7352 for (j = 0; j < c->mstate.count; j++) {
7353 int i;
7354 multiCmd *mc = c->mstate.commands+j;
7355
7356 for (i = 0; i < mc->argc; i++)
7357 decrRefCount(mc->argv[i]);
7358 zfree(mc->argv);
7359 }
7360 zfree(c->mstate.commands);
7361 }
7362
7363 /* Add a new command into the MULTI commands queue */
7364 static void queueMultiCommand(redisClient *c, struct redisCommand *cmd) {
7365 multiCmd *mc;
7366 int j;
7367
7368 c->mstate.commands = zrealloc(c->mstate.commands,
7369 sizeof(multiCmd)*(c->mstate.count+1));
7370 mc = c->mstate.commands+c->mstate.count;
7371 mc->cmd = cmd;
7372 mc->argc = c->argc;
7373 mc->argv = zmalloc(sizeof(robj*)*c->argc);
7374 memcpy(mc->argv,c->argv,sizeof(robj*)*c->argc);
7375 for (j = 0; j < c->argc; j++)
7376 incrRefCount(mc->argv[j]);
7377 c->mstate.count++;
7378 }
7379
7380 static void multiCommand(redisClient *c) {
7381 c->flags |= REDIS_MULTI;
7382 addReply(c,shared.ok);
7383 }
7384
7385 static void discardCommand(redisClient *c) {
7386 if (!(c->flags & REDIS_MULTI)) {
7387 addReplySds(c,sdsnew("-ERR DISCARD without MULTI\r\n"));
7388 return;
7389 }
7390
7391 freeClientMultiState(c);
7392 initClientMultiState(c);
7393 c->flags &= (~REDIS_MULTI);
7394 addReply(c,shared.ok);
7395 }
7396
7397 /* Send a MULTI command to all the slaves and AOF file. Check the execCommand
7398 * implememntation for more information. */
7399 static void execCommandReplicateMulti(redisClient *c) {
7400 struct redisCommand *cmd;
7401 robj *multistring = createStringObject("MULTI",5);
7402
7403 cmd = lookupCommand("multi");
7404 if (server.appendonly)
7405 feedAppendOnlyFile(cmd,c->db->id,&multistring,1);
7406 if (listLength(server.slaves))
7407 replicationFeedSlaves(server.slaves,c->db->id,&multistring,1);
7408 decrRefCount(multistring);
7409 }
7410
7411 static void execCommand(redisClient *c) {
7412 int j;
7413 robj **orig_argv;
7414 int orig_argc;
7415
7416 if (!(c->flags & REDIS_MULTI)) {
7417 addReplySds(c,sdsnew("-ERR EXEC without MULTI\r\n"));
7418 return;
7419 }
7420
7421 /* Replicate a MULTI request now that we are sure the block is executed.
7422 * This way we'll deliver the MULTI/..../EXEC block as a whole and
7423 * both the AOF and the replication link will have the same consistency
7424 * and atomicity guarantees. */
7425 execCommandReplicateMulti(c);
7426
7427 /* Exec all the queued commands */
7428 orig_argv = c->argv;
7429 orig_argc = c->argc;
7430 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",c->mstate.count));
7431 for (j = 0; j < c->mstate.count; j++) {
7432 c->argc = c->mstate.commands[j].argc;
7433 c->argv = c->mstate.commands[j].argv;
7434 call(c,c->mstate.commands[j].cmd);
7435 }
7436 c->argv = orig_argv;
7437 c->argc = orig_argc;
7438 freeClientMultiState(c);
7439 initClientMultiState(c);
7440 c->flags &= (~REDIS_MULTI);
7441 /* Make sure the EXEC command is always replicated / AOF, since we
7442 * always send the MULTI command (we can't know beforehand if the
7443 * next operations will contain at least a modification to the DB). */
7444 server.dirty++;
7445 }
7446
7447 /* =========================== Blocking Operations ========================= */
7448
7449 /* Currently Redis blocking operations support is limited to list POP ops,
7450 * so the current implementation is not fully generic, but it is also not
7451 * completely specific so it will not require a rewrite to support new
7452 * kind of blocking operations in the future.
7453 *
7454 * Still it's important to note that list blocking operations can be already
7455 * used as a notification mechanism in order to implement other blocking
7456 * operations at application level, so there must be a very strong evidence
7457 * of usefulness and generality before new blocking operations are implemented.
7458 *
7459 * This is how the current blocking POP works, we use BLPOP as example:
7460 * - If the user calls BLPOP and the key exists and contains a non empty list
7461 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
7462 * if there is not to block.
7463 * - If instead BLPOP is called and the key does not exists or the list is
7464 * empty we need to block. In order to do so we remove the notification for
7465 * new data to read in the client socket (so that we'll not serve new
7466 * requests if the blocking request is not served). Also we put the client
7467 * in a dictionary (db->blockingkeys) mapping keys to a list of clients
7468 * blocking for this keys.
7469 * - If a PUSH operation against a key with blocked clients waiting is
7470 * performed, we serve the first in the list: basically instead to push
7471 * the new element inside the list we return it to the (first / oldest)
7472 * blocking client, unblock the client, and remove it form the list.
7473 *
7474 * The above comment and the source code should be enough in order to understand
7475 * the implementation and modify / fix it later.
7476 */
7477
7478 /* Set a client in blocking mode for the specified key, with the specified
7479 * timeout */
7480 static void blockForKeys(redisClient *c, robj **keys, int numkeys, time_t timeout) {
7481 dictEntry *de;
7482 list *l;
7483 int j;
7484
7485 c->blockingkeys = zmalloc(sizeof(robj*)*numkeys);
7486 c->blockingkeysnum = numkeys;
7487 c->blockingto = timeout;
7488 for (j = 0; j < numkeys; j++) {
7489 /* Add the key in the client structure, to map clients -> keys */
7490 c->blockingkeys[j] = keys[j];
7491 incrRefCount(keys[j]);
7492
7493 /* And in the other "side", to map keys -> clients */
7494 de = dictFind(c->db->blockingkeys,keys[j]);
7495 if (de == NULL) {
7496 int retval;
7497
7498 /* For every key we take a list of clients blocked for it */
7499 l = listCreate();
7500 retval = dictAdd(c->db->blockingkeys,keys[j],l);
7501 incrRefCount(keys[j]);
7502 assert(retval == DICT_OK);
7503 } else {
7504 l = dictGetEntryVal(de);
7505 }
7506 listAddNodeTail(l,c);
7507 }
7508 /* Mark the client as a blocked client */
7509 c->flags |= REDIS_BLOCKED;
7510 server.blpop_blocked_clients++;
7511 }
7512
7513 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
7514 static void unblockClientWaitingData(redisClient *c) {
7515 dictEntry *de;
7516 list *l;
7517 int j;
7518
7519 assert(c->blockingkeys != NULL);
7520 /* The client may wait for multiple keys, so unblock it for every key. */
7521 for (j = 0; j < c->blockingkeysnum; j++) {
7522 /* Remove this client from the list of clients waiting for this key. */
7523 de = dictFind(c->db->blockingkeys,c->blockingkeys[j]);
7524 assert(de != NULL);
7525 l = dictGetEntryVal(de);
7526 listDelNode(l,listSearchKey(l,c));
7527 /* If the list is empty we need to remove it to avoid wasting memory */
7528 if (listLength(l) == 0)
7529 dictDelete(c->db->blockingkeys,c->blockingkeys[j]);
7530 decrRefCount(c->blockingkeys[j]);
7531 }
7532 /* Cleanup the client structure */
7533 zfree(c->blockingkeys);
7534 c->blockingkeys = NULL;
7535 c->flags &= (~REDIS_BLOCKED);
7536 server.blpop_blocked_clients--;
7537 /* We want to process data if there is some command waiting
7538 * in the input buffer. Note that this is safe even if
7539 * unblockClientWaitingData() gets called from freeClient() because
7540 * freeClient() will be smart enough to call this function
7541 * *after* c->querybuf was set to NULL. */
7542 if (c->querybuf && sdslen(c->querybuf) > 0) processInputBuffer(c);
7543 }
7544
7545 /* This should be called from any function PUSHing into lists.
7546 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
7547 * 'ele' is the element pushed.
7548 *
7549 * If the function returns 0 there was no client waiting for a list push
7550 * against this key.
7551 *
7552 * If the function returns 1 there was a client waiting for a list push
7553 * against this key, the element was passed to this client thus it's not
7554 * needed to actually add it to the list and the caller should return asap. */
7555 static int handleClientsWaitingListPush(redisClient *c, robj *key, robj *ele) {
7556 struct dictEntry *de;
7557 redisClient *receiver;
7558 list *l;
7559 listNode *ln;
7560
7561 de = dictFind(c->db->blockingkeys,key);
7562 if (de == NULL) return 0;
7563 l = dictGetEntryVal(de);
7564 ln = listFirst(l);
7565 assert(ln != NULL);
7566 receiver = ln->value;
7567
7568 addReplySds(receiver,sdsnew("*2\r\n"));
7569 addReplyBulk(receiver,key);
7570 addReplyBulk(receiver,ele);
7571 unblockClientWaitingData(receiver);
7572 return 1;
7573 }
7574
7575 /* Blocking RPOP/LPOP */
7576 static void blockingPopGenericCommand(redisClient *c, int where) {
7577 robj *o;
7578 time_t timeout;
7579 int j;
7580
7581 for (j = 1; j < c->argc-1; j++) {
7582 o = lookupKeyWrite(c->db,c->argv[j]);
7583 if (o != NULL) {
7584 if (o->type != REDIS_LIST) {
7585 addReply(c,shared.wrongtypeerr);
7586 return;
7587 } else {
7588 list *list = o->ptr;
7589 if (listLength(list) != 0) {
7590 /* If the list contains elements fall back to the usual
7591 * non-blocking POP operation */
7592 robj *argv[2], **orig_argv;
7593 int orig_argc;
7594
7595 /* We need to alter the command arguments before to call
7596 * popGenericCommand() as the command takes a single key. */
7597 orig_argv = c->argv;
7598 orig_argc = c->argc;
7599 argv[1] = c->argv[j];
7600 c->argv = argv;
7601 c->argc = 2;
7602
7603 /* Also the return value is different, we need to output
7604 * the multi bulk reply header and the key name. The
7605 * "real" command will add the last element (the value)
7606 * for us. If this souds like an hack to you it's just
7607 * because it is... */
7608 addReplySds(c,sdsnew("*2\r\n"));
7609 addReplyBulk(c,argv[1]);
7610 popGenericCommand(c,where);
7611
7612 /* Fix the client structure with the original stuff */
7613 c->argv = orig_argv;
7614 c->argc = orig_argc;
7615 return;
7616 }
7617 }
7618 }
7619 }
7620 /* If the list is empty or the key does not exists we must block */
7621 timeout = strtol(c->argv[c->argc-1]->ptr,NULL,10);
7622 if (timeout > 0) timeout += time(NULL);
7623 blockForKeys(c,c->argv+1,c->argc-2,timeout);
7624 }
7625
7626 static void blpopCommand(redisClient *c) {
7627 blockingPopGenericCommand(c,REDIS_HEAD);
7628 }
7629
7630 static void brpopCommand(redisClient *c) {
7631 blockingPopGenericCommand(c,REDIS_TAIL);
7632 }
7633
7634 /* =============================== Replication ============================= */
7635
7636 static int syncWrite(int fd, char *ptr, ssize_t size, int timeout) {
7637 ssize_t nwritten, ret = size;
7638 time_t start = time(NULL);
7639
7640 timeout++;
7641 while(size) {
7642 if (aeWait(fd,AE_WRITABLE,1000) & AE_WRITABLE) {
7643 nwritten = write(fd,ptr,size);
7644 if (nwritten == -1) return -1;
7645 ptr += nwritten;
7646 size -= nwritten;
7647 }
7648 if ((time(NULL)-start) > timeout) {
7649 errno = ETIMEDOUT;
7650 return -1;
7651 }
7652 }
7653 return ret;
7654 }
7655
7656 static int syncRead(int fd, char *ptr, ssize_t size, int timeout) {
7657 ssize_t nread, totread = 0;
7658 time_t start = time(NULL);
7659
7660 timeout++;
7661 while(size) {
7662 if (aeWait(fd,AE_READABLE,1000) & AE_READABLE) {
7663 nread = read(fd,ptr,size);
7664 if (nread == -1) return -1;
7665 ptr += nread;
7666 size -= nread;
7667 totread += nread;
7668 }
7669 if ((time(NULL)-start) > timeout) {
7670 errno = ETIMEDOUT;
7671 return -1;
7672 }
7673 }
7674 return totread;
7675 }
7676
7677 static int syncReadLine(int fd, char *ptr, ssize_t size, int timeout) {
7678 ssize_t nread = 0;
7679
7680 size--;
7681 while(size) {
7682 char c;
7683
7684 if (syncRead(fd,&c,1,timeout) == -1) return -1;
7685 if (c == '\n') {
7686 *ptr = '\0';
7687 if (nread && *(ptr-1) == '\r') *(ptr-1) = '\0';
7688 return nread;
7689 } else {
7690 *ptr++ = c;
7691 *ptr = '\0';
7692 nread++;
7693 }
7694 }
7695 return nread;
7696 }
7697
7698 static void syncCommand(redisClient *c) {
7699 /* ignore SYNC if aleady slave or in monitor mode */
7700 if (c->flags & REDIS_SLAVE) return;
7701
7702 /* SYNC can't be issued when the server has pending data to send to
7703 * the client about already issued commands. We need a fresh reply
7704 * buffer registering the differences between the BGSAVE and the current
7705 * dataset, so that we can copy to other slaves if needed. */
7706 if (listLength(c->reply) != 0) {
7707 addReplySds(c,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
7708 return;
7709 }
7710
7711 redisLog(REDIS_NOTICE,"Slave ask for synchronization");
7712 /* Here we need to check if there is a background saving operation
7713 * in progress, or if it is required to start one */
7714 if (server.bgsavechildpid != -1) {
7715 /* Ok a background save is in progress. Let's check if it is a good
7716 * one for replication, i.e. if there is another slave that is
7717 * registering differences since the server forked to save */
7718 redisClient *slave;
7719 listNode *ln;
7720 listIter li;
7721
7722 listRewind(server.slaves,&li);
7723 while((ln = listNext(&li))) {
7724 slave = ln->value;
7725 if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_END) break;
7726 }
7727 if (ln) {
7728 /* Perfect, the server is already registering differences for
7729 * another slave. Set the right state, and copy the buffer. */
7730 listRelease(c->reply);
7731 c->reply = listDup(slave->reply);
7732 c->replstate = REDIS_REPL_WAIT_BGSAVE_END;
7733 redisLog(REDIS_NOTICE,"Waiting for end of BGSAVE for SYNC");
7734 } else {
7735 /* No way, we need to wait for the next BGSAVE in order to
7736 * register differences */
7737 c->replstate = REDIS_REPL_WAIT_BGSAVE_START;
7738 redisLog(REDIS_NOTICE,"Waiting for next BGSAVE for SYNC");
7739 }
7740 } else {
7741 /* Ok we don't have a BGSAVE in progress, let's start one */
7742 redisLog(REDIS_NOTICE,"Starting BGSAVE for SYNC");
7743 if (rdbSaveBackground(server.dbfilename) != REDIS_OK) {
7744 redisLog(REDIS_NOTICE,"Replication failed, can't BGSAVE");
7745 addReplySds(c,sdsnew("-ERR Unalbe to perform background save\r\n"));
7746 return;
7747 }
7748 c->replstate = REDIS_REPL_WAIT_BGSAVE_END;
7749 }
7750 c->repldbfd = -1;
7751 c->flags |= REDIS_SLAVE;
7752 c->slaveseldb = 0;
7753 listAddNodeTail(server.slaves,c);
7754 return;
7755 }
7756
7757 static void sendBulkToSlave(aeEventLoop *el, int fd, void *privdata, int mask) {
7758 redisClient *slave = privdata;
7759 REDIS_NOTUSED(el);
7760 REDIS_NOTUSED(mask);
7761 char buf[REDIS_IOBUF_LEN];
7762 ssize_t nwritten, buflen;
7763
7764 if (slave->repldboff == 0) {
7765 /* Write the bulk write count before to transfer the DB. In theory here
7766 * we don't know how much room there is in the output buffer of the
7767 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
7768 * operations) will never be smaller than the few bytes we need. */
7769 sds bulkcount;
7770
7771 bulkcount = sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
7772 slave->repldbsize);
7773 if (write(fd,bulkcount,sdslen(bulkcount)) != (signed)sdslen(bulkcount))
7774 {
7775 sdsfree(bulkcount);
7776 freeClient(slave);
7777 return;
7778 }
7779 sdsfree(bulkcount);
7780 }
7781 lseek(slave->repldbfd,slave->repldboff,SEEK_SET);
7782 buflen = read(slave->repldbfd,buf,REDIS_IOBUF_LEN);
7783 if (buflen <= 0) {
7784 redisLog(REDIS_WARNING,"Read error sending DB to slave: %s",
7785 (buflen == 0) ? "premature EOF" : strerror(errno));
7786 freeClient(slave);
7787 return;
7788 }
7789 if ((nwritten = write(fd,buf,buflen)) == -1) {
7790 redisLog(REDIS_VERBOSE,"Write error sending DB to slave: %s",
7791 strerror(errno));
7792 freeClient(slave);
7793 return;
7794 }
7795 slave->repldboff += nwritten;
7796 if (slave->repldboff == slave->repldbsize) {
7797 close(slave->repldbfd);
7798 slave->repldbfd = -1;
7799 aeDeleteFileEvent(server.el,slave->fd,AE_WRITABLE);
7800 slave->replstate = REDIS_REPL_ONLINE;
7801 if (aeCreateFileEvent(server.el, slave->fd, AE_WRITABLE,
7802 sendReplyToClient, slave) == AE_ERR) {
7803 freeClient(slave);
7804 return;
7805 }
7806 addReplySds(slave,sdsempty());
7807 redisLog(REDIS_NOTICE,"Synchronization with slave succeeded");
7808 }
7809 }
7810
7811 /* This function is called at the end of every backgrond saving.
7812 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
7813 * otherwise REDIS_ERR is passed to the function.
7814 *
7815 * The goal of this function is to handle slaves waiting for a successful
7816 * background saving in order to perform non-blocking synchronization. */
7817 static void updateSlavesWaitingBgsave(int bgsaveerr) {
7818 listNode *ln;
7819 int startbgsave = 0;
7820 listIter li;
7821
7822 listRewind(server.slaves,&li);
7823 while((ln = listNext(&li))) {
7824 redisClient *slave = ln->value;
7825
7826 if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_START) {
7827 startbgsave = 1;
7828 slave->replstate = REDIS_REPL_WAIT_BGSAVE_END;
7829 } else if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_END) {
7830 struct redis_stat buf;
7831
7832 if (bgsaveerr != REDIS_OK) {
7833 freeClient(slave);
7834 redisLog(REDIS_WARNING,"SYNC failed. BGSAVE child returned an error");
7835 continue;
7836 }
7837 if ((slave->repldbfd = open(server.dbfilename,O_RDONLY)) == -1 ||
7838 redis_fstat(slave->repldbfd,&buf) == -1) {
7839 freeClient(slave);
7840 redisLog(REDIS_WARNING,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno));
7841 continue;
7842 }
7843 slave->repldboff = 0;
7844 slave->repldbsize = buf.st_size;
7845 slave->replstate = REDIS_REPL_SEND_BULK;
7846 aeDeleteFileEvent(server.el,slave->fd,AE_WRITABLE);
7847 if (aeCreateFileEvent(server.el, slave->fd, AE_WRITABLE, sendBulkToSlave, slave) == AE_ERR) {
7848 freeClient(slave);
7849 continue;
7850 }
7851 }
7852 }
7853 if (startbgsave) {
7854 if (rdbSaveBackground(server.dbfilename) != REDIS_OK) {
7855 listIter li;
7856
7857 listRewind(server.slaves,&li);
7858 redisLog(REDIS_WARNING,"SYNC failed. BGSAVE failed");
7859 while((ln = listNext(&li))) {
7860 redisClient *slave = ln->value;
7861
7862 if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_START)
7863 freeClient(slave);
7864 }
7865 }
7866 }
7867 }
7868
7869 static int syncWithMaster(void) {
7870 char buf[1024], tmpfile[256], authcmd[1024];
7871 long dumpsize;
7872 int fd = anetTcpConnect(NULL,server.masterhost,server.masterport);
7873 int dfd, maxtries = 5;
7874
7875 if (fd == -1) {
7876 redisLog(REDIS_WARNING,"Unable to connect to MASTER: %s",
7877 strerror(errno));
7878 return REDIS_ERR;
7879 }
7880
7881 /* AUTH with the master if required. */
7882 if(server.masterauth) {
7883 snprintf(authcmd, 1024, "AUTH %s\r\n", server.masterauth);
7884 if (syncWrite(fd, authcmd, strlen(server.masterauth)+7, 5) == -1) {
7885 close(fd);
7886 redisLog(REDIS_WARNING,"Unable to AUTH to MASTER: %s",
7887 strerror(errno));
7888 return REDIS_ERR;
7889 }
7890 /* Read the AUTH result. */
7891 if (syncReadLine(fd,buf,1024,3600) == -1) {
7892 close(fd);
7893 redisLog(REDIS_WARNING,"I/O error reading auth result from MASTER: %s",
7894 strerror(errno));
7895 return REDIS_ERR;
7896 }
7897 if (buf[0] != '+') {
7898 close(fd);
7899 redisLog(REDIS_WARNING,"Cannot AUTH to MASTER, is the masterauth password correct?");
7900 return REDIS_ERR;
7901 }
7902 }
7903
7904 /* Issue the SYNC command */
7905 if (syncWrite(fd,"SYNC \r\n",7,5) == -1) {
7906 close(fd);
7907 redisLog(REDIS_WARNING,"I/O error writing to MASTER: %s",
7908 strerror(errno));
7909 return REDIS_ERR;
7910 }
7911 /* Read the bulk write count */
7912 if (syncReadLine(fd,buf,1024,3600) == -1) {
7913 close(fd);
7914 redisLog(REDIS_WARNING,"I/O error reading bulk count from MASTER: %s",
7915 strerror(errno));
7916 return REDIS_ERR;
7917 }
7918 if (buf[0] != '$') {
7919 close(fd);
7920 redisLog(REDIS_WARNING,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
7921 return REDIS_ERR;
7922 }
7923 dumpsize = strtol(buf+1,NULL,10);
7924 redisLog(REDIS_NOTICE,"Receiving %ld bytes data dump from MASTER",dumpsize);
7925 /* Read the bulk write data on a temp file */
7926 while(maxtries--) {
7927 snprintf(tmpfile,256,
7928 "temp-%d.%ld.rdb",(int)time(NULL),(long int)getpid());
7929 dfd = open(tmpfile,O_CREAT|O_WRONLY|O_EXCL,0644);
7930 if (dfd != -1) break;
7931 sleep(1);
7932 }
7933 if (dfd == -1) {
7934 close(fd);
7935 redisLog(REDIS_WARNING,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno));
7936 return REDIS_ERR;
7937 }
7938 while(dumpsize) {
7939 int nread, nwritten;
7940
7941 nread = read(fd,buf,(dumpsize < 1024)?dumpsize:1024);
7942 if (nread == -1) {
7943 redisLog(REDIS_WARNING,"I/O error trying to sync with MASTER: %s",
7944 strerror(errno));
7945 close(fd);
7946 close(dfd);
7947 return REDIS_ERR;
7948 }
7949 nwritten = write(dfd,buf,nread);
7950 if (nwritten == -1) {
7951 redisLog(REDIS_WARNING,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno));
7952 close(fd);
7953 close(dfd);
7954 return REDIS_ERR;
7955 }
7956 dumpsize -= nread;
7957 }
7958 close(dfd);
7959 if (rename(tmpfile,server.dbfilename) == -1) {
7960 redisLog(REDIS_WARNING,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno));
7961 unlink(tmpfile);
7962 close(fd);
7963 return REDIS_ERR;
7964 }
7965 emptyDb();
7966 if (rdbLoad(server.dbfilename) != REDIS_OK) {
7967 redisLog(REDIS_WARNING,"Failed trying to load the MASTER synchronization DB from disk");
7968 close(fd);
7969 return REDIS_ERR;
7970 }
7971 server.master = createClient(fd);
7972 server.master->flags |= REDIS_MASTER;
7973 server.master->authenticated = 1;
7974 server.replstate = REDIS_REPL_CONNECTED;
7975 return REDIS_OK;
7976 }
7977
7978 static void slaveofCommand(redisClient *c) {
7979 if (!strcasecmp(c->argv[1]->ptr,"no") &&
7980 !strcasecmp(c->argv[2]->ptr,"one")) {
7981 if (server.masterhost) {
7982 sdsfree(server.masterhost);
7983 server.masterhost = NULL;
7984 if (server.master) freeClient(server.master);
7985 server.replstate = REDIS_REPL_NONE;
7986 redisLog(REDIS_NOTICE,"MASTER MODE enabled (user request)");
7987 }
7988 } else {
7989 sdsfree(server.masterhost);
7990 server.masterhost = sdsdup(c->argv[1]->ptr);
7991 server.masterport = atoi(c->argv[2]->ptr);
7992 if (server.master) freeClient(server.master);
7993 server.replstate = REDIS_REPL_CONNECT;
7994 redisLog(REDIS_NOTICE,"SLAVE OF %s:%d enabled (user request)",
7995 server.masterhost, server.masterport);
7996 }
7997 addReply(c,shared.ok);
7998 }
7999
8000 /* ============================ Maxmemory directive ======================== */
8001
8002 /* Try to free one object form the pre-allocated objects free list.
8003 * This is useful under low mem conditions as by default we take 1 million
8004 * free objects allocated. On success REDIS_OK is returned, otherwise
8005 * REDIS_ERR. */
8006 static int tryFreeOneObjectFromFreelist(void) {
8007 robj *o;
8008
8009 if (server.vm_enabled) pthread_mutex_lock(&server.obj_freelist_mutex);
8010 if (listLength(server.objfreelist)) {
8011 listNode *head = listFirst(server.objfreelist);
8012 o = listNodeValue(head);
8013 listDelNode(server.objfreelist,head);
8014 if (server.vm_enabled) pthread_mutex_unlock(&server.obj_freelist_mutex);
8015 zfree(o);
8016 return REDIS_OK;
8017 } else {
8018 if (server.vm_enabled) pthread_mutex_unlock(&server.obj_freelist_mutex);
8019 return REDIS_ERR;
8020 }
8021 }
8022
8023 /* This function gets called when 'maxmemory' is set on the config file to limit
8024 * the max memory used by the server, and we are out of memory.
8025 * This function will try to, in order:
8026 *
8027 * - Free objects from the free list
8028 * - Try to remove keys with an EXPIRE set
8029 *
8030 * It is not possible to free enough memory to reach used-memory < maxmemory
8031 * the server will start refusing commands that will enlarge even more the
8032 * memory usage.
8033 */
8034 static void freeMemoryIfNeeded(void) {
8035 while (server.maxmemory && zmalloc_used_memory() > server.maxmemory) {
8036 int j, k, freed = 0;
8037
8038 if (tryFreeOneObjectFromFreelist() == REDIS_OK) continue;
8039 for (j = 0; j < server.dbnum; j++) {
8040 int minttl = -1;
8041 robj *minkey = NULL;
8042 struct dictEntry *de;
8043
8044 if (dictSize(server.db[j].expires)) {
8045 freed = 1;
8046 /* From a sample of three keys drop the one nearest to
8047 * the natural expire */
8048 for (k = 0; k < 3; k++) {
8049 time_t t;
8050
8051 de = dictGetRandomKey(server.db[j].expires);
8052 t = (time_t) dictGetEntryVal(de);
8053 if (minttl == -1 || t < minttl) {
8054 minkey = dictGetEntryKey(de);
8055 minttl = t;
8056 }
8057 }
8058 deleteKey(server.db+j,minkey);
8059 }
8060 }
8061 if (!freed) return; /* nothing to free... */
8062 }
8063 }
8064
8065 /* ============================== Append Only file ========================== */
8066
8067 /* Write the append only file buffer on disk.
8068 *
8069 * Since we are required to write the AOF before replying to the client,
8070 * and the only way the client socket can get a write is entering when the
8071 * the event loop, we accumulate all the AOF writes in a memory
8072 * buffer and write it on disk using this function just before entering
8073 * the event loop again. */
8074 static void flushAppendOnlyFile(void) {
8075 time_t now;
8076 ssize_t nwritten;
8077
8078 if (sdslen(server.aofbuf) == 0) return;
8079
8080 /* We want to perform a single write. This should be guaranteed atomic
8081 * at least if the filesystem we are writing is a real physical one.
8082 * While this will save us against the server being killed I don't think
8083 * there is much to do about the whole server stopping for power problems
8084 * or alike */
8085 nwritten = write(server.appendfd,server.aofbuf,sdslen(server.aofbuf));
8086 if (nwritten != (signed)sdslen(server.aofbuf)) {
8087 /* Ooops, we are in troubles. The best thing to do for now is
8088 * aborting instead of giving the illusion that everything is
8089 * working as expected. */
8090 if (nwritten == -1) {
8091 redisLog(REDIS_WARNING,"Exiting on error writing to the append-only file: %s",strerror(errno));
8092 } else {
8093 redisLog(REDIS_WARNING,"Exiting on short write while writing to the append-only file: %s",strerror(errno));
8094 }
8095 exit(1);
8096 }
8097 sdsfree(server.aofbuf);
8098 server.aofbuf = sdsempty();
8099
8100 /* Fsync if needed */
8101 now = time(NULL);
8102 if (server.appendfsync == APPENDFSYNC_ALWAYS ||
8103 (server.appendfsync == APPENDFSYNC_EVERYSEC &&
8104 now-server.lastfsync > 1))
8105 {
8106 /* aof_fsync is defined as fdatasync() for Linux in order to avoid
8107 * flushing metadata. */
8108 aof_fsync(server.appendfd); /* Let's try to get this data on the disk */
8109 server.lastfsync = now;
8110 }
8111 }
8112
8113 static void feedAppendOnlyFile(struct redisCommand *cmd, int dictid, robj **argv, int argc) {
8114 sds buf = sdsempty();
8115 int j;
8116 robj *tmpargv[3];
8117
8118 /* The DB this command was targetting is not the same as the last command
8119 * we appendend. To issue a SELECT command is needed. */
8120 if (dictid != server.appendseldb) {
8121 char seldb[64];
8122
8123 snprintf(seldb,sizeof(seldb),"%d",dictid);
8124 buf = sdscatprintf(buf,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
8125 (unsigned long)strlen(seldb),seldb);
8126 server.appendseldb = dictid;
8127 }
8128
8129 /* "Fix" the argv vector if the command is EXPIRE. We want to translate
8130 * EXPIREs into EXPIREATs calls */
8131 if (cmd->proc == expireCommand) {
8132 long when;
8133
8134 tmpargv[0] = createStringObject("EXPIREAT",8);
8135 tmpargv[1] = argv[1];
8136 incrRefCount(argv[1]);
8137 when = time(NULL)+strtol(argv[2]->ptr,NULL,10);
8138 tmpargv[2] = createObject(REDIS_STRING,
8139 sdscatprintf(sdsempty(),"%ld",when));
8140 argv = tmpargv;
8141 }
8142
8143 /* Append the actual command */
8144 buf = sdscatprintf(buf,"*%d\r\n",argc);
8145 for (j = 0; j < argc; j++) {
8146 robj *o = argv[j];
8147
8148 o = getDecodedObject(o);
8149 buf = sdscatprintf(buf,"$%lu\r\n",(unsigned long)sdslen(o->ptr));
8150 buf = sdscatlen(buf,o->ptr,sdslen(o->ptr));
8151 buf = sdscatlen(buf,"\r\n",2);
8152 decrRefCount(o);
8153 }
8154
8155 /* Free the objects from the modified argv for EXPIREAT */
8156 if (cmd->proc == expireCommand) {
8157 for (j = 0; j < 3; j++)
8158 decrRefCount(argv[j]);
8159 }
8160
8161 /* Append to the AOF buffer. This will be flushed on disk just before
8162 * of re-entering the event loop, so before the client will get a
8163 * positive reply about the operation performed. */
8164 server.aofbuf = sdscatlen(server.aofbuf,buf,sdslen(buf));
8165
8166 /* If a background append only file rewriting is in progress we want to
8167 * accumulate the differences between the child DB and the current one
8168 * in a buffer, so that when the child process will do its work we
8169 * can append the differences to the new append only file. */
8170 if (server.bgrewritechildpid != -1)
8171 server.bgrewritebuf = sdscatlen(server.bgrewritebuf,buf,sdslen(buf));
8172
8173 sdsfree(buf);
8174 }
8175
8176 /* In Redis commands are always executed in the context of a client, so in
8177 * order to load the append only file we need to create a fake client. */
8178 static struct redisClient *createFakeClient(void) {
8179 struct redisClient *c = zmalloc(sizeof(*c));
8180
8181 selectDb(c,0);
8182 c->fd = -1;
8183 c->querybuf = sdsempty();
8184 c->argc = 0;
8185 c->argv = NULL;
8186 c->flags = 0;
8187 /* We set the fake client as a slave waiting for the synchronization
8188 * so that Redis will not try to send replies to this client. */
8189 c->replstate = REDIS_REPL_WAIT_BGSAVE_START;
8190 c->reply = listCreate();
8191 listSetFreeMethod(c->reply,decrRefCount);
8192 listSetDupMethod(c->reply,dupClientReplyValue);
8193 initClientMultiState(c);
8194 return c;
8195 }
8196
8197 static void freeFakeClient(struct redisClient *c) {
8198 sdsfree(c->querybuf);
8199 listRelease(c->reply);
8200 freeClientMultiState(c);
8201 zfree(c);
8202 }
8203
8204 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
8205 * error (the append only file is zero-length) REDIS_ERR is returned. On
8206 * fatal error an error message is logged and the program exists. */
8207 int loadAppendOnlyFile(char *filename) {
8208 struct redisClient *fakeClient;
8209 FILE *fp = fopen(filename,"r");
8210 struct redis_stat sb;
8211 unsigned long long loadedkeys = 0;
8212 int appendonly = server.appendonly;
8213
8214 if (redis_fstat(fileno(fp),&sb) != -1 && sb.st_size == 0)
8215 return REDIS_ERR;
8216
8217 if (fp == NULL) {
8218 redisLog(REDIS_WARNING,"Fatal error: can't open the append log file for reading: %s",strerror(errno));
8219 exit(1);
8220 }
8221
8222 /* Temporarily disable AOF, to prevent EXEC from feeding a MULTI
8223 * to the same file we're about to read. */
8224 server.appendonly = 0;
8225
8226 fakeClient = createFakeClient();
8227 while(1) {
8228 int argc, j;
8229 unsigned long len;
8230 robj **argv;
8231 char buf[128];
8232 sds argsds;
8233 struct redisCommand *cmd;
8234
8235 if (fgets(buf,sizeof(buf),fp) == NULL) {
8236 if (feof(fp))
8237 break;
8238 else
8239 goto readerr;
8240 }
8241 if (buf[0] != '*') goto fmterr;
8242 argc = atoi(buf+1);
8243 argv = zmalloc(sizeof(robj*)*argc);
8244 for (j = 0; j < argc; j++) {
8245 if (fgets(buf,sizeof(buf),fp) == NULL) goto readerr;
8246 if (buf[0] != '$') goto fmterr;
8247 len = strtol(buf+1,NULL,10);
8248 argsds = sdsnewlen(NULL,len);
8249 if (len && fread(argsds,len,1,fp) == 0) goto fmterr;
8250 argv[j] = createObject(REDIS_STRING,argsds);
8251 if (fread(buf,2,1,fp) == 0) goto fmterr; /* discard CRLF */
8252 }
8253
8254 /* Command lookup */
8255 cmd = lookupCommand(argv[0]->ptr);
8256 if (!cmd) {
8257 redisLog(REDIS_WARNING,"Unknown command '%s' reading the append only file", argv[0]->ptr);
8258 exit(1);
8259 }
8260 /* Try object encoding */
8261 if (cmd->flags & REDIS_CMD_BULK)
8262 argv[argc-1] = tryObjectEncoding(argv[argc-1]);
8263 /* Run the command in the context of a fake client */
8264 fakeClient->argc = argc;
8265 fakeClient->argv = argv;
8266 cmd->proc(fakeClient);
8267 /* Discard the reply objects list from the fake client */
8268 while(listLength(fakeClient->reply))
8269 listDelNode(fakeClient->reply,listFirst(fakeClient->reply));
8270 /* Clean up, ready for the next command */
8271 for (j = 0; j < argc; j++) decrRefCount(argv[j]);
8272 zfree(argv);
8273 /* Handle swapping while loading big datasets when VM is on */
8274 loadedkeys++;
8275 if (server.vm_enabled && (loadedkeys % 5000) == 0) {
8276 while (zmalloc_used_memory() > server.vm_max_memory) {
8277 if (vmSwapOneObjectBlocking() == REDIS_ERR) break;
8278 }
8279 }
8280 }
8281
8282 /* This point can only be reached when EOF is reached without errors.
8283 * If the client is in the middle of a MULTI/EXEC, log error and quit. */
8284 if (fakeClient->flags & REDIS_MULTI) goto readerr;
8285
8286 fclose(fp);
8287 freeFakeClient(fakeClient);
8288 server.appendonly = appendonly;
8289 return REDIS_OK;
8290
8291 readerr:
8292 if (feof(fp)) {
8293 redisLog(REDIS_WARNING,"Unexpected end of file reading the append only file");
8294 } else {
8295 redisLog(REDIS_WARNING,"Unrecoverable error reading the append only file: %s", strerror(errno));
8296 }
8297 exit(1);
8298 fmterr:
8299 redisLog(REDIS_WARNING,"Bad file format reading the append only file");
8300 exit(1);
8301 }
8302
8303 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
8304 static int fwriteBulkObject(FILE *fp, robj *obj) {
8305 char buf[128];
8306 int decrrc = 0;
8307
8308 /* Avoid the incr/decr ref count business if possible to help
8309 * copy-on-write (we are often in a child process when this function
8310 * is called).
8311 * Also makes sure that key objects don't get incrRefCount-ed when VM
8312 * is enabled */
8313 if (obj->encoding != REDIS_ENCODING_RAW) {
8314 obj = getDecodedObject(obj);
8315 decrrc = 1;
8316 }
8317 snprintf(buf,sizeof(buf),"$%ld\r\n",(long)sdslen(obj->ptr));
8318 if (fwrite(buf,strlen(buf),1,fp) == 0) goto err;
8319 if (sdslen(obj->ptr) && fwrite(obj->ptr,sdslen(obj->ptr),1,fp) == 0)
8320 goto err;
8321 if (fwrite("\r\n",2,1,fp) == 0) goto err;
8322 if (decrrc) decrRefCount(obj);
8323 return 1;
8324 err:
8325 if (decrrc) decrRefCount(obj);
8326 return 0;
8327 }
8328
8329 /* Write binary-safe string into a file in the bulkformat
8330 * $<count>\r\n<payload>\r\n */
8331 static int fwriteBulkString(FILE *fp, char *s, unsigned long len) {
8332 char buf[128];
8333
8334 snprintf(buf,sizeof(buf),"$%ld\r\n",(unsigned long)len);
8335 if (fwrite(buf,strlen(buf),1,fp) == 0) return 0;
8336 if (len && fwrite(s,len,1,fp) == 0) return 0;
8337 if (fwrite("\r\n",2,1,fp) == 0) return 0;
8338 return 1;
8339 }
8340
8341 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
8342 static int fwriteBulkDouble(FILE *fp, double d) {
8343 char buf[128], dbuf[128];
8344
8345 snprintf(dbuf,sizeof(dbuf),"%.17g\r\n",d);
8346 snprintf(buf,sizeof(buf),"$%lu\r\n",(unsigned long)strlen(dbuf)-2);
8347 if (fwrite(buf,strlen(buf),1,fp) == 0) return 0;
8348 if (fwrite(dbuf,strlen(dbuf),1,fp) == 0) return 0;
8349 return 1;
8350 }
8351
8352 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
8353 static int fwriteBulkLong(FILE *fp, long l) {
8354 char buf[128], lbuf[128];
8355
8356 snprintf(lbuf,sizeof(lbuf),"%ld\r\n",l);
8357 snprintf(buf,sizeof(buf),"$%lu\r\n",(unsigned long)strlen(lbuf)-2);
8358 if (fwrite(buf,strlen(buf),1,fp) == 0) return 0;
8359 if (fwrite(lbuf,strlen(lbuf),1,fp) == 0) return 0;
8360 return 1;
8361 }
8362
8363 /* Write a sequence of commands able to fully rebuild the dataset into
8364 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
8365 static int rewriteAppendOnlyFile(char *filename) {
8366 dictIterator *di = NULL;
8367 dictEntry *de;
8368 FILE *fp;
8369 char tmpfile[256];
8370 int j;
8371 time_t now = time(NULL);
8372
8373 /* Note that we have to use a different temp name here compared to the
8374 * one used by rewriteAppendOnlyFileBackground() function. */
8375 snprintf(tmpfile,256,"temp-rewriteaof-%d.aof", (int) getpid());
8376 fp = fopen(tmpfile,"w");
8377 if (!fp) {
8378 redisLog(REDIS_WARNING, "Failed rewriting the append only file: %s", strerror(errno));
8379 return REDIS_ERR;
8380 }
8381 for (j = 0; j < server.dbnum; j++) {
8382 char selectcmd[] = "*2\r\n$6\r\nSELECT\r\n";
8383 redisDb *db = server.db+j;
8384 dict *d = db->dict;
8385 if (dictSize(d) == 0) continue;
8386 di = dictGetIterator(d);
8387 if (!di) {
8388 fclose(fp);
8389 return REDIS_ERR;
8390 }
8391
8392 /* SELECT the new DB */
8393 if (fwrite(selectcmd,sizeof(selectcmd)-1,1,fp) == 0) goto werr;
8394 if (fwriteBulkLong(fp,j) == 0) goto werr;
8395
8396 /* Iterate this DB writing every entry */
8397 while((de = dictNext(di)) != NULL) {
8398 robj *key, *o;
8399 time_t expiretime;
8400 int swapped;
8401
8402 key = dictGetEntryKey(de);
8403 /* If the value for this key is swapped, load a preview in memory.
8404 * We use a "swapped" flag to remember if we need to free the
8405 * value object instead to just increment the ref count anyway
8406 * in order to avoid copy-on-write of pages if we are forked() */
8407 if (!server.vm_enabled || key->storage == REDIS_VM_MEMORY ||
8408 key->storage == REDIS_VM_SWAPPING) {
8409 o = dictGetEntryVal(de);
8410 swapped = 0;
8411 } else {
8412 o = vmPreviewObject(key);
8413 swapped = 1;
8414 }
8415 expiretime = getExpire(db,key);
8416
8417 /* Save the key and associated value */
8418 if (o->type == REDIS_STRING) {
8419 /* Emit a SET command */
8420 char cmd[]="*3\r\n$3\r\nSET\r\n";
8421 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
8422 /* Key and value */
8423 if (fwriteBulkObject(fp,key) == 0) goto werr;
8424 if (fwriteBulkObject(fp,o) == 0) goto werr;
8425 } else if (o->type == REDIS_LIST) {
8426 /* Emit the RPUSHes needed to rebuild the list */
8427 list *list = o->ptr;
8428 listNode *ln;
8429 listIter li;
8430
8431 listRewind(list,&li);
8432 while((ln = listNext(&li))) {
8433 char cmd[]="*3\r\n$5\r\nRPUSH\r\n";
8434 robj *eleobj = listNodeValue(ln);
8435
8436 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
8437 if (fwriteBulkObject(fp,key) == 0) goto werr;
8438 if (fwriteBulkObject(fp,eleobj) == 0) goto werr;
8439 }
8440 } else if (o->type == REDIS_SET) {
8441 /* Emit the SADDs needed to rebuild the set */
8442 dict *set = o->ptr;
8443 dictIterator *di = dictGetIterator(set);
8444 dictEntry *de;
8445
8446 while((de = dictNext(di)) != NULL) {
8447 char cmd[]="*3\r\n$4\r\nSADD\r\n";
8448 robj *eleobj = dictGetEntryKey(de);
8449
8450 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
8451 if (fwriteBulkObject(fp,key) == 0) goto werr;
8452 if (fwriteBulkObject(fp,eleobj) == 0) goto werr;
8453 }
8454 dictReleaseIterator(di);
8455 } else if (o->type == REDIS_ZSET) {
8456 /* Emit the ZADDs needed to rebuild the sorted set */
8457 zset *zs = o->ptr;
8458 dictIterator *di = dictGetIterator(zs->dict);
8459 dictEntry *de;
8460
8461 while((de = dictNext(di)) != NULL) {
8462 char cmd[]="*4\r\n$4\r\nZADD\r\n";
8463 robj *eleobj = dictGetEntryKey(de);
8464 double *score = dictGetEntryVal(de);
8465
8466 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
8467 if (fwriteBulkObject(fp,key) == 0) goto werr;
8468 if (fwriteBulkDouble(fp,*score) == 0) goto werr;
8469 if (fwriteBulkObject(fp,eleobj) == 0) goto werr;
8470 }
8471 dictReleaseIterator(di);
8472 } else if (o->type == REDIS_HASH) {
8473 char cmd[]="*4\r\n$4\r\nHSET\r\n";
8474
8475 /* Emit the HSETs needed to rebuild the hash */
8476 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
8477 unsigned char *p = zipmapRewind(o->ptr);
8478 unsigned char *field, *val;
8479 unsigned int flen, vlen;
8480
8481 while((p = zipmapNext(p,&field,&flen,&val,&vlen)) != NULL) {
8482 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
8483 if (fwriteBulkObject(fp,key) == 0) goto werr;
8484 if (fwriteBulkString(fp,(char*)field,flen) == -1)
8485 return -1;
8486 if (fwriteBulkString(fp,(char*)val,vlen) == -1)
8487 return -1;
8488 }
8489 } else {
8490 dictIterator *di = dictGetIterator(o->ptr);
8491 dictEntry *de;
8492
8493 while((de = dictNext(di)) != NULL) {
8494 robj *field = dictGetEntryKey(de);
8495 robj *val = dictGetEntryVal(de);
8496
8497 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
8498 if (fwriteBulkObject(fp,key) == 0) goto werr;
8499 if (fwriteBulkObject(fp,field) == -1) return -1;
8500 if (fwriteBulkObject(fp,val) == -1) return -1;
8501 }
8502 dictReleaseIterator(di);
8503 }
8504 } else {
8505 redisPanic("Unknown object type");
8506 }
8507 /* Save the expire time */
8508 if (expiretime != -1) {
8509 char cmd[]="*3\r\n$8\r\nEXPIREAT\r\n";
8510 /* If this key is already expired skip it */
8511 if (expiretime < now) continue;
8512 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
8513 if (fwriteBulkObject(fp,key) == 0) goto werr;
8514 if (fwriteBulkLong(fp,expiretime) == 0) goto werr;
8515 }
8516 if (swapped) decrRefCount(o);
8517 }
8518 dictReleaseIterator(di);
8519 }
8520
8521 /* Make sure data will not remain on the OS's output buffers */
8522 fflush(fp);
8523 fsync(fileno(fp));
8524 fclose(fp);
8525
8526 /* Use RENAME to make sure the DB file is changed atomically only
8527 * if the generate DB file is ok. */
8528 if (rename(tmpfile,filename) == -1) {
8529 redisLog(REDIS_WARNING,"Error moving temp append only file on the final destination: %s", strerror(errno));
8530 unlink(tmpfile);
8531 return REDIS_ERR;
8532 }
8533 redisLog(REDIS_NOTICE,"SYNC append only file rewrite performed");
8534 return REDIS_OK;
8535
8536 werr:
8537 fclose(fp);
8538 unlink(tmpfile);
8539 redisLog(REDIS_WARNING,"Write error writing append only file on disk: %s", strerror(errno));
8540 if (di) dictReleaseIterator(di);
8541 return REDIS_ERR;
8542 }
8543
8544 /* This is how rewriting of the append only file in background works:
8545 *
8546 * 1) The user calls BGREWRITEAOF
8547 * 2) Redis calls this function, that forks():
8548 * 2a) the child rewrite the append only file in a temp file.
8549 * 2b) the parent accumulates differences in server.bgrewritebuf.
8550 * 3) When the child finished '2a' exists.
8551 * 4) The parent will trap the exit code, if it's OK, will append the
8552 * data accumulated into server.bgrewritebuf into the temp file, and
8553 * finally will rename(2) the temp file in the actual file name.
8554 * The the new file is reopened as the new append only file. Profit!
8555 */
8556 static int rewriteAppendOnlyFileBackground(void) {
8557 pid_t childpid;
8558
8559 if (server.bgrewritechildpid != -1) return REDIS_ERR;
8560 if (server.vm_enabled) waitEmptyIOJobsQueue();
8561 if ((childpid = fork()) == 0) {
8562 /* Child */
8563 char tmpfile[256];
8564
8565 if (server.vm_enabled) vmReopenSwapFile();
8566 close(server.fd);
8567 snprintf(tmpfile,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
8568 if (rewriteAppendOnlyFile(tmpfile) == REDIS_OK) {
8569 _exit(0);
8570 } else {
8571 _exit(1);
8572 }
8573 } else {
8574 /* Parent */
8575 if (childpid == -1) {
8576 redisLog(REDIS_WARNING,
8577 "Can't rewrite append only file in background: fork: %s",
8578 strerror(errno));
8579 return REDIS_ERR;
8580 }
8581 redisLog(REDIS_NOTICE,
8582 "Background append only file rewriting started by pid %d",childpid);
8583 server.bgrewritechildpid = childpid;
8584 updateDictResizePolicy();
8585 /* We set appendseldb to -1 in order to force the next call to the
8586 * feedAppendOnlyFile() to issue a SELECT command, so the differences
8587 * accumulated by the parent into server.bgrewritebuf will start
8588 * with a SELECT statement and it will be safe to merge. */
8589 server.appendseldb = -1;
8590 return REDIS_OK;
8591 }
8592 return REDIS_OK; /* unreached */
8593 }
8594
8595 static void bgrewriteaofCommand(redisClient *c) {
8596 if (server.bgrewritechildpid != -1) {
8597 addReplySds(c,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
8598 return;
8599 }
8600 if (rewriteAppendOnlyFileBackground() == REDIS_OK) {
8601 char *status = "+Background append only file rewriting started\r\n";
8602 addReplySds(c,sdsnew(status));
8603 } else {
8604 addReply(c,shared.err);
8605 }
8606 }
8607
8608 static void aofRemoveTempFile(pid_t childpid) {
8609 char tmpfile[256];
8610
8611 snprintf(tmpfile,256,"temp-rewriteaof-bg-%d.aof", (int) childpid);
8612 unlink(tmpfile);
8613 }
8614
8615 /* Virtual Memory is composed mainly of two subsystems:
8616 * - Blocking Virutal Memory
8617 * - Threaded Virtual Memory I/O
8618 * The two parts are not fully decoupled, but functions are split among two
8619 * different sections of the source code (delimited by comments) in order to
8620 * make more clear what functionality is about the blocking VM and what about
8621 * the threaded (not blocking) VM.
8622 *
8623 * Redis VM design:
8624 *
8625 * Redis VM is a blocking VM (one that blocks reading swapped values from
8626 * disk into memory when a value swapped out is needed in memory) that is made
8627 * unblocking by trying to examine the command argument vector in order to
8628 * load in background values that will likely be needed in order to exec
8629 * the command. The command is executed only once all the relevant keys
8630 * are loaded into memory.
8631 *
8632 * This basically is almost as simple of a blocking VM, but almost as parallel
8633 * as a fully non-blocking VM.
8634 */
8635
8636 /* =================== Virtual Memory - Blocking Side ====================== */
8637
8638 static void vmInit(void) {
8639 off_t totsize;
8640 int pipefds[2];
8641 size_t stacksize;
8642 struct flock fl;
8643
8644 if (server.vm_max_threads != 0)
8645 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
8646
8647 redisLog(REDIS_NOTICE,"Using '%s' as swap file",server.vm_swap_file);
8648 /* Try to open the old swap file, otherwise create it */
8649 if ((server.vm_fp = fopen(server.vm_swap_file,"r+b")) == NULL) {
8650 server.vm_fp = fopen(server.vm_swap_file,"w+b");
8651 }
8652 if (server.vm_fp == NULL) {
8653 redisLog(REDIS_WARNING,
8654 "Can't open the swap file: %s. Exiting.",
8655 strerror(errno));
8656 exit(1);
8657 }
8658 server.vm_fd = fileno(server.vm_fp);
8659 /* Lock the swap file for writing, this is useful in order to avoid
8660 * another instance to use the same swap file for a config error. */
8661 fl.l_type = F_WRLCK;
8662 fl.l_whence = SEEK_SET;
8663 fl.l_start = fl.l_len = 0;
8664 if (fcntl(server.vm_fd,F_SETLK,&fl) == -1) {
8665 redisLog(REDIS_WARNING,
8666 "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));
8667 exit(1);
8668 }
8669 /* Initialize */
8670 server.vm_next_page = 0;
8671 server.vm_near_pages = 0;
8672 server.vm_stats_used_pages = 0;
8673 server.vm_stats_swapped_objects = 0;
8674 server.vm_stats_swapouts = 0;
8675 server.vm_stats_swapins = 0;
8676 totsize = server.vm_pages*server.vm_page_size;
8677 redisLog(REDIS_NOTICE,"Allocating %lld bytes of swap file",totsize);
8678 if (ftruncate(server.vm_fd,totsize) == -1) {
8679 redisLog(REDIS_WARNING,"Can't ftruncate swap file: %s. Exiting.",
8680 strerror(errno));
8681 exit(1);
8682 } else {
8683 redisLog(REDIS_NOTICE,"Swap file allocated with success");
8684 }
8685 server.vm_bitmap = zmalloc((server.vm_pages+7)/8);
8686 redisLog(REDIS_VERBOSE,"Allocated %lld bytes page table for %lld pages",
8687 (long long) (server.vm_pages+7)/8, server.vm_pages);
8688 memset(server.vm_bitmap,0,(server.vm_pages+7)/8);
8689
8690 /* Initialize threaded I/O (used by Virtual Memory) */
8691 server.io_newjobs = listCreate();
8692 server.io_processing = listCreate();
8693 server.io_processed = listCreate();
8694 server.io_ready_clients = listCreate();
8695 pthread_mutex_init(&server.io_mutex,NULL);
8696 pthread_mutex_init(&server.obj_freelist_mutex,NULL);
8697 pthread_mutex_init(&server.io_swapfile_mutex,NULL);
8698 server.io_active_threads = 0;
8699 if (pipe(pipefds) == -1) {
8700 redisLog(REDIS_WARNING,"Unable to intialized VM: pipe(2): %s. Exiting."
8701 ,strerror(errno));
8702 exit(1);
8703 }
8704 server.io_ready_pipe_read = pipefds[0];
8705 server.io_ready_pipe_write = pipefds[1];
8706 redisAssert(anetNonBlock(NULL,server.io_ready_pipe_read) != ANET_ERR);
8707 /* LZF requires a lot of stack */
8708 pthread_attr_init(&server.io_threads_attr);
8709 pthread_attr_getstacksize(&server.io_threads_attr, &stacksize);
8710 while (stacksize < REDIS_THREAD_STACK_SIZE) stacksize *= 2;
8711 pthread_attr_setstacksize(&server.io_threads_attr, stacksize);
8712 /* Listen for events in the threaded I/O pipe */
8713 if (aeCreateFileEvent(server.el, server.io_ready_pipe_read, AE_READABLE,
8714 vmThreadedIOCompletedJob, NULL) == AE_ERR)
8715 oom("creating file event");
8716 }
8717
8718 /* Mark the page as used */
8719 static void vmMarkPageUsed(off_t page) {
8720 off_t byte = page/8;
8721 int bit = page&7;
8722 redisAssert(vmFreePage(page) == 1);
8723 server.vm_bitmap[byte] |= 1<<bit;
8724 }
8725
8726 /* Mark N contiguous pages as used, with 'page' being the first. */
8727 static void vmMarkPagesUsed(off_t page, off_t count) {
8728 off_t j;
8729
8730 for (j = 0; j < count; j++)
8731 vmMarkPageUsed(page+j);
8732 server.vm_stats_used_pages += count;
8733 redisLog(REDIS_DEBUG,"Mark USED pages: %lld pages at %lld\n",
8734 (long long)count, (long long)page);
8735 }
8736
8737 /* Mark the page as free */
8738 static void vmMarkPageFree(off_t page) {
8739 off_t byte = page/8;
8740 int bit = page&7;
8741 redisAssert(vmFreePage(page) == 0);
8742 server.vm_bitmap[byte] &= ~(1<<bit);
8743 }
8744
8745 /* Mark N contiguous pages as free, with 'page' being the first. */
8746 static void vmMarkPagesFree(off_t page, off_t count) {
8747 off_t j;
8748
8749 for (j = 0; j < count; j++)
8750 vmMarkPageFree(page+j);
8751 server.vm_stats_used_pages -= count;
8752 redisLog(REDIS_DEBUG,"Mark FREE pages: %lld pages at %lld\n",
8753 (long long)count, (long long)page);
8754 }
8755
8756 /* Test if the page is free */
8757 static int vmFreePage(off_t page) {
8758 off_t byte = page/8;
8759 int bit = page&7;
8760 return (server.vm_bitmap[byte] & (1<<bit)) == 0;
8761 }
8762
8763 /* Find N contiguous free pages storing the first page of the cluster in *first.
8764 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
8765 * REDIS_ERR is returned.
8766 *
8767 * This function uses a simple algorithm: we try to allocate
8768 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
8769 * again from the start of the swap file searching for free spaces.
8770 *
8771 * If it looks pretty clear that there are no free pages near our offset
8772 * we try to find less populated places doing a forward jump of
8773 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
8774 * without hurry, and then we jump again and so forth...
8775 *
8776 * This function can be improved using a free list to avoid to guess
8777 * too much, since we could collect data about freed pages.
8778 *
8779 * note: I implemented this function just after watching an episode of
8780 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
8781 */
8782 static int vmFindContiguousPages(off_t *first, off_t n) {
8783 off_t base, offset = 0, since_jump = 0, numfree = 0;
8784
8785 if (server.vm_near_pages == REDIS_VM_MAX_NEAR_PAGES) {
8786 server.vm_near_pages = 0;
8787 server.vm_next_page = 0;
8788 }
8789 server.vm_near_pages++; /* Yet another try for pages near to the old ones */
8790 base = server.vm_next_page;
8791
8792 while(offset < server.vm_pages) {
8793 off_t this = base+offset;
8794
8795 /* If we overflow, restart from page zero */
8796 if (this >= server.vm_pages) {
8797 this -= server.vm_pages;
8798 if (this == 0) {
8799 /* Just overflowed, what we found on tail is no longer
8800 * interesting, as it's no longer contiguous. */
8801 numfree = 0;
8802 }
8803 }
8804 if (vmFreePage(this)) {
8805 /* This is a free page */
8806 numfree++;
8807 /* Already got N free pages? Return to the caller, with success */
8808 if (numfree == n) {
8809 *first = this-(n-1);
8810 server.vm_next_page = this+1;
8811 redisLog(REDIS_DEBUG, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n, (long long) *first);
8812 return REDIS_OK;
8813 }
8814 } else {
8815 /* The current one is not a free page */
8816 numfree = 0;
8817 }
8818
8819 /* Fast-forward if the current page is not free and we already
8820 * searched enough near this place. */
8821 since_jump++;
8822 if (!numfree && since_jump >= REDIS_VM_MAX_RANDOM_JUMP/4) {
8823 offset += random() % REDIS_VM_MAX_RANDOM_JUMP;
8824 since_jump = 0;
8825 /* Note that even if we rewind after the jump, we are don't need
8826 * to make sure numfree is set to zero as we only jump *if* it
8827 * is set to zero. */
8828 } else {
8829 /* Otherwise just check the next page */
8830 offset++;
8831 }
8832 }
8833 return REDIS_ERR;
8834 }
8835
8836 /* Write the specified object at the specified page of the swap file */
8837 static int vmWriteObjectOnSwap(robj *o, off_t page) {
8838 if (server.vm_enabled) pthread_mutex_lock(&server.io_swapfile_mutex);
8839 if (fseeko(server.vm_fp,page*server.vm_page_size,SEEK_SET) == -1) {
8840 if (server.vm_enabled) pthread_mutex_unlock(&server.io_swapfile_mutex);
8841 redisLog(REDIS_WARNING,
8842 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
8843 strerror(errno));
8844 return REDIS_ERR;
8845 }
8846 rdbSaveObject(server.vm_fp,o);
8847 fflush(server.vm_fp);
8848 if (server.vm_enabled) pthread_mutex_unlock(&server.io_swapfile_mutex);
8849 return REDIS_OK;
8850 }
8851
8852 /* Swap the 'val' object relative to 'key' into disk. Store all the information
8853 * needed to later retrieve the object into the key object.
8854 * If we can't find enough contiguous empty pages to swap the object on disk
8855 * REDIS_ERR is returned. */
8856 static int vmSwapObjectBlocking(robj *key, robj *val) {
8857 off_t pages = rdbSavedObjectPages(val,NULL);
8858 off_t page;
8859
8860 assert(key->storage == REDIS_VM_MEMORY);
8861 assert(key->refcount == 1);
8862 if (vmFindContiguousPages(&page,pages) == REDIS_ERR) return REDIS_ERR;
8863 if (vmWriteObjectOnSwap(val,page) == REDIS_ERR) return REDIS_ERR;
8864 key->vm.page = page;
8865 key->vm.usedpages = pages;
8866 key->storage = REDIS_VM_SWAPPED;
8867 key->vtype = val->type;
8868 decrRefCount(val); /* Deallocate the object from memory. */
8869 vmMarkPagesUsed(page,pages);
8870 redisLog(REDIS_DEBUG,"VM: object %s swapped out at %lld (%lld pages)",
8871 (unsigned char*) key->ptr,
8872 (unsigned long long) page, (unsigned long long) pages);
8873 server.vm_stats_swapped_objects++;
8874 server.vm_stats_swapouts++;
8875 return REDIS_OK;
8876 }
8877
8878 static robj *vmReadObjectFromSwap(off_t page, int type) {
8879 robj *o;
8880
8881 if (server.vm_enabled) pthread_mutex_lock(&server.io_swapfile_mutex);
8882 if (fseeko(server.vm_fp,page*server.vm_page_size,SEEK_SET) == -1) {
8883 redisLog(REDIS_WARNING,
8884 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
8885 strerror(errno));
8886 _exit(1);
8887 }
8888 o = rdbLoadObject(type,server.vm_fp);
8889 if (o == NULL) {
8890 redisLog(REDIS_WARNING, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno));
8891 _exit(1);
8892 }
8893 if (server.vm_enabled) pthread_mutex_unlock(&server.io_swapfile_mutex);
8894 return o;
8895 }
8896
8897 /* Load the value object relative to the 'key' object from swap to memory.
8898 * The newly allocated object is returned.
8899 *
8900 * If preview is true the unserialized object is returned to the caller but
8901 * no changes are made to the key object, nor the pages are marked as freed */
8902 static robj *vmGenericLoadObject(robj *key, int preview) {
8903 robj *val;
8904
8905 redisAssert(key->storage == REDIS_VM_SWAPPED || key->storage == REDIS_VM_LOADING);
8906 val = vmReadObjectFromSwap(key->vm.page,key->vtype);
8907 if (!preview) {
8908 key->storage = REDIS_VM_MEMORY;
8909 key->vm.atime = server.unixtime;
8910 vmMarkPagesFree(key->vm.page,key->vm.usedpages);
8911 redisLog(REDIS_DEBUG, "VM: object %s loaded from disk",
8912 (unsigned char*) key->ptr);
8913 server.vm_stats_swapped_objects--;
8914 } else {
8915 redisLog(REDIS_DEBUG, "VM: object %s previewed from disk",
8916 (unsigned char*) key->ptr);
8917 }
8918 server.vm_stats_swapins++;
8919 return val;
8920 }
8921
8922 /* Plain object loading, from swap to memory */
8923 static robj *vmLoadObject(robj *key) {
8924 /* If we are loading the object in background, stop it, we
8925 * need to load this object synchronously ASAP. */
8926 if (key->storage == REDIS_VM_LOADING)
8927 vmCancelThreadedIOJob(key);
8928 return vmGenericLoadObject(key,0);
8929 }
8930
8931 /* Just load the value on disk, without to modify the key.
8932 * This is useful when we want to perform some operation on the value
8933 * without to really bring it from swap to memory, like while saving the
8934 * dataset or rewriting the append only log. */
8935 static robj *vmPreviewObject(robj *key) {
8936 return vmGenericLoadObject(key,1);
8937 }
8938
8939 /* How a good candidate is this object for swapping?
8940 * The better candidate it is, the greater the returned value.
8941 *
8942 * Currently we try to perform a fast estimation of the object size in
8943 * memory, and combine it with aging informations.
8944 *
8945 * Basically swappability = idle-time * log(estimated size)
8946 *
8947 * Bigger objects are preferred over smaller objects, but not
8948 * proportionally, this is why we use the logarithm. This algorithm is
8949 * just a first try and will probably be tuned later. */
8950 static double computeObjectSwappability(robj *o) {
8951 time_t age = server.unixtime - o->vm.atime;
8952 long asize = 0;
8953 list *l;
8954 dict *d;
8955 struct dictEntry *de;
8956 int z;
8957
8958 if (age <= 0) return 0;
8959 switch(o->type) {
8960 case REDIS_STRING:
8961 if (o->encoding != REDIS_ENCODING_RAW) {
8962 asize = sizeof(*o);
8963 } else {
8964 asize = sdslen(o->ptr)+sizeof(*o)+sizeof(long)*2;
8965 }
8966 break;
8967 case REDIS_LIST:
8968 l = o->ptr;
8969 listNode *ln = listFirst(l);
8970
8971 asize = sizeof(list);
8972 if (ln) {
8973 robj *ele = ln->value;
8974 long elesize;
8975
8976 elesize = (ele->encoding == REDIS_ENCODING_RAW) ?
8977 (sizeof(*o)+sdslen(ele->ptr)) :
8978 sizeof(*o);
8979 asize += (sizeof(listNode)+elesize)*listLength(l);
8980 }
8981 break;
8982 case REDIS_SET:
8983 case REDIS_ZSET:
8984 z = (o->type == REDIS_ZSET);
8985 d = z ? ((zset*)o->ptr)->dict : o->ptr;
8986
8987 asize = sizeof(dict)+(sizeof(struct dictEntry*)*dictSlots(d));
8988 if (z) asize += sizeof(zset)-sizeof(dict);
8989 if (dictSize(d)) {
8990 long elesize;
8991 robj *ele;
8992
8993 de = dictGetRandomKey(d);
8994 ele = dictGetEntryKey(de);
8995 elesize = (ele->encoding == REDIS_ENCODING_RAW) ?
8996 (sizeof(*o)+sdslen(ele->ptr)) :
8997 sizeof(*o);
8998 asize += (sizeof(struct dictEntry)+elesize)*dictSize(d);
8999 if (z) asize += sizeof(zskiplistNode)*dictSize(d);
9000 }
9001 break;
9002 case REDIS_HASH:
9003 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
9004 unsigned char *p = zipmapRewind((unsigned char*)o->ptr);
9005 unsigned int len = zipmapLen((unsigned char*)o->ptr);
9006 unsigned int klen, vlen;
9007 unsigned char *key, *val;
9008
9009 if ((p = zipmapNext(p,&key,&klen,&val,&vlen)) == NULL) {
9010 klen = 0;
9011 vlen = 0;
9012 }
9013 asize = len*(klen+vlen+3);
9014 } else if (o->encoding == REDIS_ENCODING_HT) {
9015 d = o->ptr;
9016 asize = sizeof(dict)+(sizeof(struct dictEntry*)*dictSlots(d));
9017 if (dictSize(d)) {
9018 long elesize;
9019 robj *ele;
9020
9021 de = dictGetRandomKey(d);
9022 ele = dictGetEntryKey(de);
9023 elesize = (ele->encoding == REDIS_ENCODING_RAW) ?
9024 (sizeof(*o)+sdslen(ele->ptr)) :
9025 sizeof(*o);
9026 ele = dictGetEntryVal(de);
9027 elesize = (ele->encoding == REDIS_ENCODING_RAW) ?
9028 (sizeof(*o)+sdslen(ele->ptr)) :
9029 sizeof(*o);
9030 asize += (sizeof(struct dictEntry)+elesize)*dictSize(d);
9031 }
9032 }
9033 break;
9034 }
9035 return (double)age*log(1+asize);
9036 }
9037
9038 /* Try to swap an object that's a good candidate for swapping.
9039 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
9040 * to swap any object at all.
9041 *
9042 * If 'usethreaded' is true, Redis will try to swap the object in background
9043 * using I/O threads. */
9044 static int vmSwapOneObject(int usethreads) {
9045 int j, i;
9046 struct dictEntry *best = NULL;
9047 double best_swappability = 0;
9048 redisDb *best_db = NULL;
9049 robj *key, *val;
9050
9051 for (j = 0; j < server.dbnum; j++) {
9052 redisDb *db = server.db+j;
9053 /* Why maxtries is set to 100?
9054 * Because this way (usually) we'll find 1 object even if just 1% - 2%
9055 * are swappable objects */
9056 int maxtries = 100;
9057
9058 if (dictSize(db->dict) == 0) continue;
9059 for (i = 0; i < 5; i++) {
9060 dictEntry *de;
9061 double swappability;
9062
9063 if (maxtries) maxtries--;
9064 de = dictGetRandomKey(db->dict);
9065 key = dictGetEntryKey(de);
9066 val = dictGetEntryVal(de);
9067 /* Only swap objects that are currently in memory.
9068 *
9069 * Also don't swap shared objects if threaded VM is on, as we
9070 * try to ensure that the main thread does not touch the
9071 * object while the I/O thread is using it, but we can't
9072 * control other keys without adding additional mutex. */
9073 if (key->storage != REDIS_VM_MEMORY ||
9074 (server.vm_max_threads != 0 && val->refcount != 1)) {
9075 if (maxtries) i--; /* don't count this try */
9076 continue;
9077 }
9078 swappability = computeObjectSwappability(val);
9079 if (!best || swappability > best_swappability) {
9080 best = de;
9081 best_swappability = swappability;
9082 best_db = db;
9083 }
9084 }
9085 }
9086 if (best == NULL) return REDIS_ERR;
9087 key = dictGetEntryKey(best);
9088 val = dictGetEntryVal(best);
9089
9090 redisLog(REDIS_DEBUG,"Key with best swappability: %s, %f",
9091 key->ptr, best_swappability);
9092
9093 /* Unshare the key if needed */
9094 if (key->refcount > 1) {
9095 robj *newkey = dupStringObject(key);
9096 decrRefCount(key);
9097 key = dictGetEntryKey(best) = newkey;
9098 }
9099 /* Swap it */
9100 if (usethreads) {
9101 vmSwapObjectThreaded(key,val,best_db);
9102 return REDIS_OK;
9103 } else {
9104 if (vmSwapObjectBlocking(key,val) == REDIS_OK) {
9105 dictGetEntryVal(best) = NULL;
9106 return REDIS_OK;
9107 } else {
9108 return REDIS_ERR;
9109 }
9110 }
9111 }
9112
9113 static int vmSwapOneObjectBlocking() {
9114 return vmSwapOneObject(0);
9115 }
9116
9117 static int vmSwapOneObjectThreaded() {
9118 return vmSwapOneObject(1);
9119 }
9120
9121 /* Return true if it's safe to swap out objects in a given moment.
9122 * Basically we don't want to swap objects out while there is a BGSAVE
9123 * or a BGAEOREWRITE running in backgroud. */
9124 static int vmCanSwapOut(void) {
9125 return (server.bgsavechildpid == -1 && server.bgrewritechildpid == -1);
9126 }
9127
9128 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
9129 * and was deleted. Otherwise 0 is returned. */
9130 static int deleteIfSwapped(redisDb *db, robj *key) {
9131 dictEntry *de;
9132 robj *foundkey;
9133
9134 if ((de = dictFind(db->dict,key)) == NULL) return 0;
9135 foundkey = dictGetEntryKey(de);
9136 if (foundkey->storage == REDIS_VM_MEMORY) return 0;
9137 deleteKey(db,key);
9138 return 1;
9139 }
9140
9141 /* =================== Virtual Memory - Threaded I/O ======================= */
9142
9143 static void freeIOJob(iojob *j) {
9144 if ((j->type == REDIS_IOJOB_PREPARE_SWAP ||
9145 j->type == REDIS_IOJOB_DO_SWAP ||
9146 j->type == REDIS_IOJOB_LOAD) && j->val != NULL)
9147 decrRefCount(j->val);
9148 /* We don't decrRefCount the j->key field as we did't incremented
9149 * the count creating IO Jobs. This is because the key field here is
9150 * just used as an indentifier and if a key is removed the Job should
9151 * never be touched again. */
9152 zfree(j);
9153 }
9154
9155 /* Every time a thread finished a Job, it writes a byte into the write side
9156 * of an unix pipe in order to "awake" the main thread, and this function
9157 * is called. */
9158 static void vmThreadedIOCompletedJob(aeEventLoop *el, int fd, void *privdata,
9159 int mask)
9160 {
9161 char buf[1];
9162 int retval, processed = 0, toprocess = -1, trytoswap = 1;
9163 REDIS_NOTUSED(el);
9164 REDIS_NOTUSED(mask);
9165 REDIS_NOTUSED(privdata);
9166
9167 /* For every byte we read in the read side of the pipe, there is one
9168 * I/O job completed to process. */
9169 while((retval = read(fd,buf,1)) == 1) {
9170 iojob *j;
9171 listNode *ln;
9172 robj *key;
9173 struct dictEntry *de;
9174
9175 redisLog(REDIS_DEBUG,"Processing I/O completed job");
9176
9177 /* Get the processed element (the oldest one) */
9178 lockThreadedIO();
9179 assert(listLength(server.io_processed) != 0);
9180 if (toprocess == -1) {
9181 toprocess = (listLength(server.io_processed)*REDIS_MAX_COMPLETED_JOBS_PROCESSED)/100;
9182 if (toprocess <= 0) toprocess = 1;
9183 }
9184 ln = listFirst(server.io_processed);
9185 j = ln->value;
9186 listDelNode(server.io_processed,ln);
9187 unlockThreadedIO();
9188 /* If this job is marked as canceled, just ignore it */
9189 if (j->canceled) {
9190 freeIOJob(j);
9191 continue;
9192 }
9193 /* Post process it in the main thread, as there are things we
9194 * can do just here to avoid race conditions and/or invasive locks */
9195 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);
9196 de = dictFind(j->db->dict,j->key);
9197 assert(de != NULL);
9198 key = dictGetEntryKey(de);
9199 if (j->type == REDIS_IOJOB_LOAD) {
9200 redisDb *db;
9201
9202 /* Key loaded, bring it at home */
9203 key->storage = REDIS_VM_MEMORY;
9204 key->vm.atime = server.unixtime;
9205 vmMarkPagesFree(key->vm.page,key->vm.usedpages);
9206 redisLog(REDIS_DEBUG, "VM: object %s loaded from disk (threaded)",
9207 (unsigned char*) key->ptr);
9208 server.vm_stats_swapped_objects--;
9209 server.vm_stats_swapins++;
9210 dictGetEntryVal(de) = j->val;
9211 incrRefCount(j->val);
9212 db = j->db;
9213 freeIOJob(j);
9214 /* Handle clients waiting for this key to be loaded. */
9215 handleClientsBlockedOnSwappedKey(db,key);
9216 } else if (j->type == REDIS_IOJOB_PREPARE_SWAP) {
9217 /* Now we know the amount of pages required to swap this object.
9218 * Let's find some space for it, and queue this task again
9219 * rebranded as REDIS_IOJOB_DO_SWAP. */
9220 if (!vmCanSwapOut() ||
9221 vmFindContiguousPages(&j->page,j->pages) == REDIS_ERR)
9222 {
9223 /* Ooops... no space or we can't swap as there is
9224 * a fork()ed Redis trying to save stuff on disk. */
9225 freeIOJob(j);
9226 key->storage = REDIS_VM_MEMORY; /* undo operation */
9227 } else {
9228 /* Note that we need to mark this pages as used now,
9229 * if the job will be canceled, we'll mark them as freed
9230 * again. */
9231 vmMarkPagesUsed(j->page,j->pages);
9232 j->type = REDIS_IOJOB_DO_SWAP;
9233 lockThreadedIO();
9234 queueIOJob(j);
9235 unlockThreadedIO();
9236 }
9237 } else if (j->type == REDIS_IOJOB_DO_SWAP) {
9238 robj *val;
9239
9240 /* Key swapped. We can finally free some memory. */
9241 if (key->storage != REDIS_VM_SWAPPING) {
9242 printf("key->storage: %d\n",key->storage);
9243 printf("key->name: %s\n",(char*)key->ptr);
9244 printf("key->refcount: %d\n",key->refcount);
9245 printf("val: %p\n",(void*)j->val);
9246 printf("val->type: %d\n",j->val->type);
9247 printf("val->ptr: %s\n",(char*)j->val->ptr);
9248 }
9249 redisAssert(key->storage == REDIS_VM_SWAPPING);
9250 val = dictGetEntryVal(de);
9251 key->vm.page = j->page;
9252 key->vm.usedpages = j->pages;
9253 key->storage = REDIS_VM_SWAPPED;
9254 key->vtype = j->val->type;
9255 decrRefCount(val); /* Deallocate the object from memory. */
9256 dictGetEntryVal(de) = NULL;
9257 redisLog(REDIS_DEBUG,
9258 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
9259 (unsigned char*) key->ptr,
9260 (unsigned long long) j->page, (unsigned long long) j->pages);
9261 server.vm_stats_swapped_objects++;
9262 server.vm_stats_swapouts++;
9263 freeIOJob(j);
9264 /* Put a few more swap requests in queue if we are still
9265 * out of memory */
9266 if (trytoswap && vmCanSwapOut() &&
9267 zmalloc_used_memory() > server.vm_max_memory)
9268 {
9269 int more = 1;
9270 while(more) {
9271 lockThreadedIO();
9272 more = listLength(server.io_newjobs) <
9273 (unsigned) server.vm_max_threads;
9274 unlockThreadedIO();
9275 /* Don't waste CPU time if swappable objects are rare. */
9276 if (vmSwapOneObjectThreaded() == REDIS_ERR) {
9277 trytoswap = 0;
9278 break;
9279 }
9280 }
9281 }
9282 }
9283 processed++;
9284 if (processed == toprocess) return;
9285 }
9286 if (retval < 0 && errno != EAGAIN) {
9287 redisLog(REDIS_WARNING,
9288 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
9289 strerror(errno));
9290 }
9291 }
9292
9293 static void lockThreadedIO(void) {
9294 pthread_mutex_lock(&server.io_mutex);
9295 }
9296
9297 static void unlockThreadedIO(void) {
9298 pthread_mutex_unlock(&server.io_mutex);
9299 }
9300
9301 /* Remove the specified object from the threaded I/O queue if still not
9302 * processed, otherwise make sure to flag it as canceled. */
9303 static void vmCancelThreadedIOJob(robj *o) {
9304 list *lists[3] = {
9305 server.io_newjobs, /* 0 */
9306 server.io_processing, /* 1 */
9307 server.io_processed /* 2 */
9308 };
9309 int i;
9310
9311 assert(o->storage == REDIS_VM_LOADING || o->storage == REDIS_VM_SWAPPING);
9312 again:
9313 lockThreadedIO();
9314 /* Search for a matching key in one of the queues */
9315 for (i = 0; i < 3; i++) {
9316 listNode *ln;
9317 listIter li;
9318
9319 listRewind(lists[i],&li);
9320 while ((ln = listNext(&li)) != NULL) {
9321 iojob *job = ln->value;
9322
9323 if (job->canceled) continue; /* Skip this, already canceled. */
9324 if (job->key == o) {
9325 redisLog(REDIS_DEBUG,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
9326 (void*)job, (char*)o->ptr, job->type, i);
9327 /* Mark the pages as free since the swap didn't happened
9328 * or happened but is now discarded. */
9329 if (i != 1 && job->type == REDIS_IOJOB_DO_SWAP)
9330 vmMarkPagesFree(job->page,job->pages);
9331 /* Cancel the job. It depends on the list the job is
9332 * living in. */
9333 switch(i) {
9334 case 0: /* io_newjobs */
9335 /* If the job was yet not processed the best thing to do
9336 * is to remove it from the queue at all */
9337 freeIOJob(job);
9338 listDelNode(lists[i],ln);
9339 break;
9340 case 1: /* io_processing */
9341 /* Oh Shi- the thread is messing with the Job:
9342 *
9343 * Probably it's accessing the object if this is a
9344 * PREPARE_SWAP or DO_SWAP job.
9345 * If it's a LOAD job it may be reading from disk and
9346 * if we don't wait for the job to terminate before to
9347 * cancel it, maybe in a few microseconds data can be
9348 * corrupted in this pages. So the short story is:
9349 *
9350 * Better to wait for the job to move into the
9351 * next queue (processed)... */
9352
9353 /* We try again and again until the job is completed. */
9354 unlockThreadedIO();
9355 /* But let's wait some time for the I/O thread
9356 * to finish with this job. After all this condition
9357 * should be very rare. */
9358 usleep(1);
9359 goto again;
9360 case 2: /* io_processed */
9361 /* The job was already processed, that's easy...
9362 * just mark it as canceled so that we'll ignore it
9363 * when processing completed jobs. */
9364 job->canceled = 1;
9365 break;
9366 }
9367 /* Finally we have to adjust the storage type of the object
9368 * in order to "UNDO" the operaiton. */
9369 if (o->storage == REDIS_VM_LOADING)
9370 o->storage = REDIS_VM_SWAPPED;
9371 else if (o->storage == REDIS_VM_SWAPPING)
9372 o->storage = REDIS_VM_MEMORY;
9373 unlockThreadedIO();
9374 return;
9375 }
9376 }
9377 }
9378 unlockThreadedIO();
9379 assert(1 != 1); /* We should never reach this */
9380 }
9381
9382 static void *IOThreadEntryPoint(void *arg) {
9383 iojob *j;
9384 listNode *ln;
9385 REDIS_NOTUSED(arg);
9386
9387 pthread_detach(pthread_self());
9388 while(1) {
9389 /* Get a new job to process */
9390 lockThreadedIO();
9391 if (listLength(server.io_newjobs) == 0) {
9392 /* No new jobs in queue, exit. */
9393 redisLog(REDIS_DEBUG,"Thread %ld exiting, nothing to do",
9394 (long) pthread_self());
9395 server.io_active_threads--;
9396 unlockThreadedIO();
9397 return NULL;
9398 }
9399 ln = listFirst(server.io_newjobs);
9400 j = ln->value;
9401 listDelNode(server.io_newjobs,ln);
9402 /* Add the job in the processing queue */
9403 j->thread = pthread_self();
9404 listAddNodeTail(server.io_processing,j);
9405 ln = listLast(server.io_processing); /* We use ln later to remove it */
9406 unlockThreadedIO();
9407 redisLog(REDIS_DEBUG,"Thread %ld got a new job (type %d): %p about key '%s'",
9408 (long) pthread_self(), j->type, (void*)j, (char*)j->key->ptr);
9409
9410 /* Process the Job */
9411 if (j->type == REDIS_IOJOB_LOAD) {
9412 j->val = vmReadObjectFromSwap(j->page,j->key->vtype);
9413 } else if (j->type == REDIS_IOJOB_PREPARE_SWAP) {
9414 FILE *fp = fopen("/dev/null","w+");
9415 j->pages = rdbSavedObjectPages(j->val,fp);
9416 fclose(fp);
9417 } else if (j->type == REDIS_IOJOB_DO_SWAP) {
9418 if (vmWriteObjectOnSwap(j->val,j->page) == REDIS_ERR)
9419 j->canceled = 1;
9420 }
9421
9422 /* Done: insert the job into the processed queue */
9423 redisLog(REDIS_DEBUG,"Thread %ld completed the job: %p (key %s)",
9424 (long) pthread_self(), (void*)j, (char*)j->key->ptr);
9425 lockThreadedIO();
9426 listDelNode(server.io_processing,ln);
9427 listAddNodeTail(server.io_processed,j);
9428 unlockThreadedIO();
9429
9430 /* Signal the main thread there is new stuff to process */
9431 assert(write(server.io_ready_pipe_write,"x",1) == 1);
9432 }
9433 return NULL; /* never reached */
9434 }
9435
9436 static void spawnIOThread(void) {
9437 pthread_t thread;
9438 sigset_t mask, omask;
9439 int err;
9440
9441 sigemptyset(&mask);
9442 sigaddset(&mask,SIGCHLD);
9443 sigaddset(&mask,SIGHUP);
9444 sigaddset(&mask,SIGPIPE);
9445 pthread_sigmask(SIG_SETMASK, &mask, &omask);
9446 while ((err = pthread_create(&thread,&server.io_threads_attr,IOThreadEntryPoint,NULL)) != 0) {
9447 redisLog(REDIS_WARNING,"Unable to spawn an I/O thread: %s",
9448 strerror(err));
9449 usleep(1000000);
9450 }
9451 pthread_sigmask(SIG_SETMASK, &omask, NULL);
9452 server.io_active_threads++;
9453 }
9454
9455 /* We need to wait for the last thread to exit before we are able to
9456 * fork() in order to BGSAVE or BGREWRITEAOF. */
9457 static void waitEmptyIOJobsQueue(void) {
9458 while(1) {
9459 int io_processed_len;
9460
9461 lockThreadedIO();
9462 if (listLength(server.io_newjobs) == 0 &&
9463 listLength(server.io_processing) == 0 &&
9464 server.io_active_threads == 0)
9465 {
9466 unlockThreadedIO();
9467 return;
9468 }
9469 /* While waiting for empty jobs queue condition we post-process some
9470 * finshed job, as I/O threads may be hanging trying to write against
9471 * the io_ready_pipe_write FD but there are so much pending jobs that
9472 * it's blocking. */
9473 io_processed_len = listLength(server.io_processed);
9474 unlockThreadedIO();
9475 if (io_processed_len) {
9476 vmThreadedIOCompletedJob(NULL,server.io_ready_pipe_read,NULL,0);
9477 usleep(1000); /* 1 millisecond */
9478 } else {
9479 usleep(10000); /* 10 milliseconds */
9480 }
9481 }
9482 }
9483
9484 static void vmReopenSwapFile(void) {
9485 /* Note: we don't close the old one as we are in the child process
9486 * and don't want to mess at all with the original file object. */
9487 server.vm_fp = fopen(server.vm_swap_file,"r+b");
9488 if (server.vm_fp == NULL) {
9489 redisLog(REDIS_WARNING,"Can't re-open the VM swap file: %s. Exiting.",
9490 server.vm_swap_file);
9491 _exit(1);
9492 }
9493 server.vm_fd = fileno(server.vm_fp);
9494 }
9495
9496 /* This function must be called while with threaded IO locked */
9497 static void queueIOJob(iojob *j) {
9498 redisLog(REDIS_DEBUG,"Queued IO Job %p type %d about key '%s'\n",
9499 (void*)j, j->type, (char*)j->key->ptr);
9500 listAddNodeTail(server.io_newjobs,j);
9501 if (server.io_active_threads < server.vm_max_threads)
9502 spawnIOThread();
9503 }
9504
9505 static int vmSwapObjectThreaded(robj *key, robj *val, redisDb *db) {
9506 iojob *j;
9507
9508 assert(key->storage == REDIS_VM_MEMORY);
9509 assert(key->refcount == 1);
9510
9511 j = zmalloc(sizeof(*j));
9512 j->type = REDIS_IOJOB_PREPARE_SWAP;
9513 j->db = db;
9514 j->key = key;
9515 j->val = val;
9516 incrRefCount(val);
9517 j->canceled = 0;
9518 j->thread = (pthread_t) -1;
9519 key->storage = REDIS_VM_SWAPPING;
9520
9521 lockThreadedIO();
9522 queueIOJob(j);
9523 unlockThreadedIO();
9524 return REDIS_OK;
9525 }
9526
9527 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
9528
9529 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
9530 * If there is not already a job loading the key, it is craeted.
9531 * The key is added to the io_keys list in the client structure, and also
9532 * in the hash table mapping swapped keys to waiting clients, that is,
9533 * server.io_waited_keys. */
9534 static int waitForSwappedKey(redisClient *c, robj *key) {
9535 struct dictEntry *de;
9536 robj *o;
9537 list *l;
9538
9539 /* If the key does not exist or is already in RAM we don't need to
9540 * block the client at all. */
9541 de = dictFind(c->db->dict,key);
9542 if (de == NULL) return 0;
9543 o = dictGetEntryKey(de);
9544 if (o->storage == REDIS_VM_MEMORY) {
9545 return 0;
9546 } else if (o->storage == REDIS_VM_SWAPPING) {
9547 /* We were swapping the key, undo it! */
9548 vmCancelThreadedIOJob(o);
9549 return 0;
9550 }
9551
9552 /* OK: the key is either swapped, or being loaded just now. */
9553
9554 /* Add the key to the list of keys this client is waiting for.
9555 * This maps clients to keys they are waiting for. */
9556 listAddNodeTail(c->io_keys,key);
9557 incrRefCount(key);
9558
9559 /* Add the client to the swapped keys => clients waiting map. */
9560 de = dictFind(c->db->io_keys,key);
9561 if (de == NULL) {
9562 int retval;
9563
9564 /* For every key we take a list of clients blocked for it */
9565 l = listCreate();
9566 retval = dictAdd(c->db->io_keys,key,l);
9567 incrRefCount(key);
9568 assert(retval == DICT_OK);
9569 } else {
9570 l = dictGetEntryVal(de);
9571 }
9572 listAddNodeTail(l,c);
9573
9574 /* Are we already loading the key from disk? If not create a job */
9575 if (o->storage == REDIS_VM_SWAPPED) {
9576 iojob *j;
9577
9578 o->storage = REDIS_VM_LOADING;
9579 j = zmalloc(sizeof(*j));
9580 j->type = REDIS_IOJOB_LOAD;
9581 j->db = c->db;
9582 j->key = o;
9583 j->key->vtype = o->vtype;
9584 j->page = o->vm.page;
9585 j->val = NULL;
9586 j->canceled = 0;
9587 j->thread = (pthread_t) -1;
9588 lockThreadedIO();
9589 queueIOJob(j);
9590 unlockThreadedIO();
9591 }
9592 return 1;
9593 }
9594
9595 /* Preload keys needed for the ZUNION and ZINTER commands. */
9596 static void zunionInterBlockClientOnSwappedKeys(redisClient *c) {
9597 int i, num;
9598 num = atoi(c->argv[2]->ptr);
9599 for (i = 0; i < num; i++) {
9600 waitForSwappedKey(c,c->argv[3+i]);
9601 }
9602 }
9603
9604 /* Is this client attempting to run a command against swapped keys?
9605 * If so, block it ASAP, load the keys in background, then resume it.
9606 *
9607 * The important idea about this function is that it can fail! If keys will
9608 * still be swapped when the client is resumed, this key lookups will
9609 * just block loading keys from disk. In practical terms this should only
9610 * happen with SORT BY command or if there is a bug in this function.
9611 *
9612 * Return 1 if the client is marked as blocked, 0 if the client can
9613 * continue as the keys it is going to access appear to be in memory. */
9614 static int blockClientOnSwappedKeys(struct redisCommand *cmd, redisClient *c) {
9615 int j, last;
9616
9617 if (cmd->vm_preload_proc != NULL) {
9618 cmd->vm_preload_proc(c);
9619 } else {
9620 if (cmd->vm_firstkey == 0) return 0;
9621 last = cmd->vm_lastkey;
9622 if (last < 0) last = c->argc+last;
9623 for (j = cmd->vm_firstkey; j <= last; j += cmd->vm_keystep)
9624 waitForSwappedKey(c,c->argv[j]);
9625 }
9626
9627 /* If the client was blocked for at least one key, mark it as blocked. */
9628 if (listLength(c->io_keys)) {
9629 c->flags |= REDIS_IO_WAIT;
9630 aeDeleteFileEvent(server.el,c->fd,AE_READABLE);
9631 server.vm_blocked_clients++;
9632 return 1;
9633 } else {
9634 return 0;
9635 }
9636 }
9637
9638 /* Remove the 'key' from the list of blocked keys for a given client.
9639 *
9640 * The function returns 1 when there are no longer blocking keys after
9641 * the current one was removed (and the client can be unblocked). */
9642 static int dontWaitForSwappedKey(redisClient *c, robj *key) {
9643 list *l;
9644 listNode *ln;
9645 listIter li;
9646 struct dictEntry *de;
9647
9648 /* Remove the key from the list of keys this client is waiting for. */
9649 listRewind(c->io_keys,&li);
9650 while ((ln = listNext(&li)) != NULL) {
9651 if (equalStringObjects(ln->value,key)) {
9652 listDelNode(c->io_keys,ln);
9653 break;
9654 }
9655 }
9656 assert(ln != NULL);
9657
9658 /* Remove the client form the key => waiting clients map. */
9659 de = dictFind(c->db->io_keys,key);
9660 assert(de != NULL);
9661 l = dictGetEntryVal(de);
9662 ln = listSearchKey(l,c);
9663 assert(ln != NULL);
9664 listDelNode(l,ln);
9665 if (listLength(l) == 0)
9666 dictDelete(c->db->io_keys,key);
9667
9668 return listLength(c->io_keys) == 0;
9669 }
9670
9671 static void handleClientsBlockedOnSwappedKey(redisDb *db, robj *key) {
9672 struct dictEntry *de;
9673 list *l;
9674 listNode *ln;
9675 int len;
9676
9677 de = dictFind(db->io_keys,key);
9678 if (!de) return;
9679
9680 l = dictGetEntryVal(de);
9681 len = listLength(l);
9682 /* Note: we can't use something like while(listLength(l)) as the list
9683 * can be freed by the calling function when we remove the last element. */
9684 while (len--) {
9685 ln = listFirst(l);
9686 redisClient *c = ln->value;
9687
9688 if (dontWaitForSwappedKey(c,key)) {
9689 /* Put the client in the list of clients ready to go as we
9690 * loaded all the keys about it. */
9691 listAddNodeTail(server.io_ready_clients,c);
9692 }
9693 }
9694 }
9695
9696 /* =========================== Remote Configuration ========================= */
9697
9698 static void configSetCommand(redisClient *c) {
9699 robj *o = getDecodedObject(c->argv[3]);
9700 if (!strcasecmp(c->argv[2]->ptr,"dbfilename")) {
9701 zfree(server.dbfilename);
9702 server.dbfilename = zstrdup(o->ptr);
9703 } else if (!strcasecmp(c->argv[2]->ptr,"requirepass")) {
9704 zfree(server.requirepass);
9705 server.requirepass = zstrdup(o->ptr);
9706 } else if (!strcasecmp(c->argv[2]->ptr,"masterauth")) {
9707 zfree(server.masterauth);
9708 server.masterauth = zstrdup(o->ptr);
9709 } else if (!strcasecmp(c->argv[2]->ptr,"maxmemory")) {
9710 server.maxmemory = strtoll(o->ptr, NULL, 10);
9711 } else if (!strcasecmp(c->argv[2]->ptr,"appendfsync")) {
9712 if (!strcasecmp(o->ptr,"no")) {
9713 server.appendfsync = APPENDFSYNC_NO;
9714 } else if (!strcasecmp(o->ptr,"everysec")) {
9715 server.appendfsync = APPENDFSYNC_EVERYSEC;
9716 } else if (!strcasecmp(o->ptr,"always")) {
9717 server.appendfsync = APPENDFSYNC_ALWAYS;
9718 } else {
9719 goto badfmt;
9720 }
9721 } else if (!strcasecmp(c->argv[2]->ptr,"save")) {
9722 int vlen, j;
9723 sds *v = sdssplitlen(o->ptr,sdslen(o->ptr)," ",1,&vlen);
9724
9725 /* Perform sanity check before setting the new config:
9726 * - Even number of args
9727 * - Seconds >= 1, changes >= 0 */
9728 if (vlen & 1) {
9729 sdsfreesplitres(v,vlen);
9730 goto badfmt;
9731 }
9732 for (j = 0; j < vlen; j++) {
9733 char *eptr;
9734 long val;
9735
9736 val = strtoll(v[j], &eptr, 10);
9737 if (eptr[0] != '\0' ||
9738 ((j & 1) == 0 && val < 1) ||
9739 ((j & 1) == 1 && val < 0)) {
9740 sdsfreesplitres(v,vlen);
9741 goto badfmt;
9742 }
9743 }
9744 /* Finally set the new config */
9745 resetServerSaveParams();
9746 for (j = 0; j < vlen; j += 2) {
9747 time_t seconds;
9748 int changes;
9749
9750 seconds = strtoll(v[j],NULL,10);
9751 changes = strtoll(v[j+1],NULL,10);
9752 appendServerSaveParams(seconds, changes);
9753 }
9754 sdsfreesplitres(v,vlen);
9755 } else {
9756 addReplySds(c,sdscatprintf(sdsempty(),
9757 "-ERR not supported CONFIG parameter %s\r\n",
9758 (char*)c->argv[2]->ptr));
9759 decrRefCount(o);
9760 return;
9761 }
9762 decrRefCount(o);
9763 addReply(c,shared.ok);
9764 return;
9765
9766 badfmt: /* Bad format errors */
9767 addReplySds(c,sdscatprintf(sdsempty(),
9768 "-ERR invalid argument '%s' for CONFIG SET '%s'\r\n",
9769 (char*)o->ptr,
9770 (char*)c->argv[2]->ptr));
9771 decrRefCount(o);
9772 }
9773
9774 static void configGetCommand(redisClient *c) {
9775 robj *o = getDecodedObject(c->argv[2]);
9776 robj *lenobj = createObject(REDIS_STRING,NULL);
9777 char *pattern = o->ptr;
9778 int matches = 0;
9779
9780 addReply(c,lenobj);
9781 decrRefCount(lenobj);
9782
9783 if (stringmatch(pattern,"dbfilename",0)) {
9784 addReplyBulkCString(c,"dbfilename");
9785 addReplyBulkCString(c,server.dbfilename);
9786 matches++;
9787 }
9788 if (stringmatch(pattern,"requirepass",0)) {
9789 addReplyBulkCString(c,"requirepass");
9790 addReplyBulkCString(c,server.requirepass);
9791 matches++;
9792 }
9793 if (stringmatch(pattern,"masterauth",0)) {
9794 addReplyBulkCString(c,"masterauth");
9795 addReplyBulkCString(c,server.masterauth);
9796 matches++;
9797 }
9798 if (stringmatch(pattern,"maxmemory",0)) {
9799 char buf[128];
9800
9801 snprintf(buf,128,"%llu\n",server.maxmemory);
9802 addReplyBulkCString(c,"maxmemory");
9803 addReplyBulkCString(c,buf);
9804 matches++;
9805 }
9806 if (stringmatch(pattern,"appendfsync",0)) {
9807 char *policy;
9808
9809 switch(server.appendfsync) {
9810 case APPENDFSYNC_NO: policy = "no"; break;
9811 case APPENDFSYNC_EVERYSEC: policy = "everysec"; break;
9812 case APPENDFSYNC_ALWAYS: policy = "always"; break;
9813 default: policy = "unknown"; break; /* too harmless to panic */
9814 }
9815 addReplyBulkCString(c,"appendfsync");
9816 addReplyBulkCString(c,policy);
9817 matches++;
9818 }
9819 if (stringmatch(pattern,"save",0)) {
9820 sds buf = sdsempty();
9821 int j;
9822
9823 for (j = 0; j < server.saveparamslen; j++) {
9824 buf = sdscatprintf(buf,"%ld %d",
9825 server.saveparams[j].seconds,
9826 server.saveparams[j].changes);
9827 if (j != server.saveparamslen-1)
9828 buf = sdscatlen(buf," ",1);
9829 }
9830 addReplyBulkCString(c,"save");
9831 addReplyBulkCString(c,buf);
9832 sdsfree(buf);
9833 matches++;
9834 }
9835 decrRefCount(o);
9836 lenobj->ptr = sdscatprintf(sdsempty(),"*%d\r\n",matches*2);
9837 }
9838
9839 static void configCommand(redisClient *c) {
9840 if (!strcasecmp(c->argv[1]->ptr,"set")) {
9841 if (c->argc != 4) goto badarity;
9842 configSetCommand(c);
9843 } else if (!strcasecmp(c->argv[1]->ptr,"get")) {
9844 if (c->argc != 3) goto badarity;
9845 configGetCommand(c);
9846 } else if (!strcasecmp(c->argv[1]->ptr,"resetstat")) {
9847 if (c->argc != 2) goto badarity;
9848 server.stat_numcommands = 0;
9849 server.stat_numconnections = 0;
9850 server.stat_expiredkeys = 0;
9851 server.stat_starttime = time(NULL);
9852 addReply(c,shared.ok);
9853 } else {
9854 addReplySds(c,sdscatprintf(sdsempty(),
9855 "-ERR CONFIG subcommand must be one of GET, SET, RESETSTAT\r\n"));
9856 }
9857 return;
9858
9859 badarity:
9860 addReplySds(c,sdscatprintf(sdsempty(),
9861 "-ERR Wrong number of arguments for CONFIG %s\r\n",
9862 (char*) c->argv[1]->ptr));
9863 }
9864
9865 /* =========================== Pubsub implementation ======================== */
9866
9867 static void freePubsubPattern(void *p) {
9868 pubsubPattern *pat = p;
9869
9870 decrRefCount(pat->pattern);
9871 zfree(pat);
9872 }
9873
9874 static int listMatchPubsubPattern(void *a, void *b) {
9875 pubsubPattern *pa = a, *pb = b;
9876
9877 return (pa->client == pb->client) &&
9878 (equalStringObjects(pa->pattern,pb->pattern));
9879 }
9880
9881 /* Subscribe a client to a channel. Returns 1 if the operation succeeded, or
9882 * 0 if the client was already subscribed to that channel. */
9883 static int pubsubSubscribeChannel(redisClient *c, robj *channel) {
9884 struct dictEntry *de;
9885 list *clients = NULL;
9886 int retval = 0;
9887
9888 /* Add the channel to the client -> channels hash table */
9889 if (dictAdd(c->pubsub_channels,channel,NULL) == DICT_OK) {
9890 retval = 1;
9891 incrRefCount(channel);
9892 /* Add the client to the channel -> list of clients hash table */
9893 de = dictFind(server.pubsub_channels,channel);
9894 if (de == NULL) {
9895 clients = listCreate();
9896 dictAdd(server.pubsub_channels,channel,clients);
9897 incrRefCount(channel);
9898 } else {
9899 clients = dictGetEntryVal(de);
9900 }
9901 listAddNodeTail(clients,c);
9902 }
9903 /* Notify the client */
9904 addReply(c,shared.mbulk3);
9905 addReply(c,shared.subscribebulk);
9906 addReplyBulk(c,channel);
9907 addReplyLong(c,dictSize(c->pubsub_channels)+listLength(c->pubsub_patterns));
9908 return retval;
9909 }
9910
9911 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
9912 * 0 if the client was not subscribed to the specified channel. */
9913 static int pubsubUnsubscribeChannel(redisClient *c, robj *channel, int notify) {
9914 struct dictEntry *de;
9915 list *clients;
9916 listNode *ln;
9917 int retval = 0;
9918
9919 /* Remove the channel from the client -> channels hash table */
9920 incrRefCount(channel); /* channel may be just a pointer to the same object
9921 we have in the hash tables. Protect it... */
9922 if (dictDelete(c->pubsub_channels,channel) == DICT_OK) {
9923 retval = 1;
9924 /* Remove the client from the channel -> clients list hash table */
9925 de = dictFind(server.pubsub_channels,channel);
9926 assert(de != NULL);
9927 clients = dictGetEntryVal(de);
9928 ln = listSearchKey(clients,c);
9929 assert(ln != NULL);
9930 listDelNode(clients,ln);
9931 if (listLength(clients) == 0) {
9932 /* Free the list and associated hash entry at all if this was
9933 * the latest client, so that it will be possible to abuse
9934 * Redis PUBSUB creating millions of channels. */
9935 dictDelete(server.pubsub_channels,channel);
9936 }
9937 }
9938 /* Notify the client */
9939 if (notify) {
9940 addReply(c,shared.mbulk3);
9941 addReply(c,shared.unsubscribebulk);
9942 addReplyBulk(c,channel);
9943 addReplyLong(c,dictSize(c->pubsub_channels)+
9944 listLength(c->pubsub_patterns));
9945
9946 }
9947 decrRefCount(channel); /* it is finally safe to release it */
9948 return retval;
9949 }
9950
9951 /* Subscribe a client to a pattern. Returns 1 if the operation succeeded, or 0 if the clinet was already subscribed to that pattern. */
9952 static int pubsubSubscribePattern(redisClient *c, robj *pattern) {
9953 int retval = 0;
9954
9955 if (listSearchKey(c->pubsub_patterns,pattern) == NULL) {
9956 retval = 1;
9957 pubsubPattern *pat;
9958 listAddNodeTail(c->pubsub_patterns,pattern);
9959 incrRefCount(pattern);
9960 pat = zmalloc(sizeof(*pat));
9961 pat->pattern = getDecodedObject(pattern);
9962 pat->client = c;
9963 listAddNodeTail(server.pubsub_patterns,pat);
9964 }
9965 /* Notify the client */
9966 addReply(c,shared.mbulk3);
9967 addReply(c,shared.psubscribebulk);
9968 addReplyBulk(c,pattern);
9969 addReplyLong(c,dictSize(c->pubsub_channels)+listLength(c->pubsub_patterns));
9970 return retval;
9971 }
9972
9973 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
9974 * 0 if the client was not subscribed to the specified channel. */
9975 static int pubsubUnsubscribePattern(redisClient *c, robj *pattern, int notify) {
9976 listNode *ln;
9977 pubsubPattern pat;
9978 int retval = 0;
9979
9980 incrRefCount(pattern); /* Protect the object. May be the same we remove */
9981 if ((ln = listSearchKey(c->pubsub_patterns,pattern)) != NULL) {
9982 retval = 1;
9983 listDelNode(c->pubsub_patterns,ln);
9984 pat.client = c;
9985 pat.pattern = pattern;
9986 ln = listSearchKey(server.pubsub_patterns,&pat);
9987 listDelNode(server.pubsub_patterns,ln);
9988 }
9989 /* Notify the client */
9990 if (notify) {
9991 addReply(c,shared.mbulk3);
9992 addReply(c,shared.punsubscribebulk);
9993 addReplyBulk(c,pattern);
9994 addReplyLong(c,dictSize(c->pubsub_channels)+
9995 listLength(c->pubsub_patterns));
9996 }
9997 decrRefCount(pattern);
9998 return retval;
9999 }
10000
10001 /* Unsubscribe from all the channels. Return the number of channels the
10002 * client was subscribed from. */
10003 static int pubsubUnsubscribeAllChannels(redisClient *c, int notify) {
10004 dictIterator *di = dictGetIterator(c->pubsub_channels);
10005 dictEntry *de;
10006 int count = 0;
10007
10008 while((de = dictNext(di)) != NULL) {
10009 robj *channel = dictGetEntryKey(de);
10010
10011 count += pubsubUnsubscribeChannel(c,channel,notify);
10012 }
10013 dictReleaseIterator(di);
10014 return count;
10015 }
10016
10017 /* Unsubscribe from all the patterns. Return the number of patterns the
10018 * client was subscribed from. */
10019 static int pubsubUnsubscribeAllPatterns(redisClient *c, int notify) {
10020 listNode *ln;
10021 listIter li;
10022 int count = 0;
10023
10024 listRewind(c->pubsub_patterns,&li);
10025 while ((ln = listNext(&li)) != NULL) {
10026 robj *pattern = ln->value;
10027
10028 count += pubsubUnsubscribePattern(c,pattern,notify);
10029 }
10030 return count;
10031 }
10032
10033 /* Publish a message */
10034 static int pubsubPublishMessage(robj *channel, robj *message) {
10035 int receivers = 0;
10036 struct dictEntry *de;
10037 listNode *ln;
10038 listIter li;
10039
10040 /* Send to clients listening for that channel */
10041 de = dictFind(server.pubsub_channels,channel);
10042 if (de) {
10043 list *list = dictGetEntryVal(de);
10044 listNode *ln;
10045 listIter li;
10046
10047 listRewind(list,&li);
10048 while ((ln = listNext(&li)) != NULL) {
10049 redisClient *c = ln->value;
10050
10051 addReply(c,shared.mbulk3);
10052 addReply(c,shared.messagebulk);
10053 addReplyBulk(c,channel);
10054 addReplyBulk(c,message);
10055 receivers++;
10056 }
10057 }
10058 /* Send to clients listening to matching channels */
10059 if (listLength(server.pubsub_patterns)) {
10060 listRewind(server.pubsub_patterns,&li);
10061 channel = getDecodedObject(channel);
10062 while ((ln = listNext(&li)) != NULL) {
10063 pubsubPattern *pat = ln->value;
10064
10065 if (stringmatchlen((char*)pat->pattern->ptr,
10066 sdslen(pat->pattern->ptr),
10067 (char*)channel->ptr,
10068 sdslen(channel->ptr),0)) {
10069 addReply(pat->client,shared.mbulk4);
10070 addReply(pat->client,shared.pmessagebulk);
10071 addReplyBulk(pat->client,pat->pattern);
10072 addReplyBulk(pat->client,channel);
10073 addReplyBulk(pat->client,message);
10074 receivers++;
10075 }
10076 }
10077 decrRefCount(channel);
10078 }
10079 return receivers;
10080 }
10081
10082 static void subscribeCommand(redisClient *c) {
10083 int j;
10084
10085 for (j = 1; j < c->argc; j++)
10086 pubsubSubscribeChannel(c,c->argv[j]);
10087 }
10088
10089 static void unsubscribeCommand(redisClient *c) {
10090 if (c->argc == 1) {
10091 pubsubUnsubscribeAllChannels(c,1);
10092 return;
10093 } else {
10094 int j;
10095
10096 for (j = 1; j < c->argc; j++)
10097 pubsubUnsubscribeChannel(c,c->argv[j],1);
10098 }
10099 }
10100
10101 static void psubscribeCommand(redisClient *c) {
10102 int j;
10103
10104 for (j = 1; j < c->argc; j++)
10105 pubsubSubscribePattern(c,c->argv[j]);
10106 }
10107
10108 static void punsubscribeCommand(redisClient *c) {
10109 if (c->argc == 1) {
10110 pubsubUnsubscribeAllPatterns(c,1);
10111 return;
10112 } else {
10113 int j;
10114
10115 for (j = 1; j < c->argc; j++)
10116 pubsubUnsubscribePattern(c,c->argv[j],1);
10117 }
10118 }
10119
10120 static void publishCommand(redisClient *c) {
10121 int receivers = pubsubPublishMessage(c->argv[1],c->argv[2]);
10122 addReplyLong(c,receivers);
10123 }
10124
10125 /* ================================= Debugging ============================== */
10126
10127 static void debugCommand(redisClient *c) {
10128 if (!strcasecmp(c->argv[1]->ptr,"segfault")) {
10129 *((char*)-1) = 'x';
10130 } else if (!strcasecmp(c->argv[1]->ptr,"reload")) {
10131 if (rdbSave(server.dbfilename) != REDIS_OK) {
10132 addReply(c,shared.err);
10133 return;
10134 }
10135 emptyDb();
10136 if (rdbLoad(server.dbfilename) != REDIS_OK) {
10137 addReply(c,shared.err);
10138 return;
10139 }
10140 redisLog(REDIS_WARNING,"DB reloaded by DEBUG RELOAD");
10141 addReply(c,shared.ok);
10142 } else if (!strcasecmp(c->argv[1]->ptr,"loadaof")) {
10143 emptyDb();
10144 if (loadAppendOnlyFile(server.appendfilename) != REDIS_OK) {
10145 addReply(c,shared.err);
10146 return;
10147 }
10148 redisLog(REDIS_WARNING,"Append Only File loaded by DEBUG LOADAOF");
10149 addReply(c,shared.ok);
10150 } else if (!strcasecmp(c->argv[1]->ptr,"object") && c->argc == 3) {
10151 dictEntry *de = dictFind(c->db->dict,c->argv[2]);
10152 robj *key, *val;
10153
10154 if (!de) {
10155 addReply(c,shared.nokeyerr);
10156 return;
10157 }
10158 key = dictGetEntryKey(de);
10159 val = dictGetEntryVal(de);
10160 if (!server.vm_enabled || (key->storage == REDIS_VM_MEMORY ||
10161 key->storage == REDIS_VM_SWAPPING)) {
10162 char *strenc;
10163 char buf[128];
10164
10165 if (val->encoding < (sizeof(strencoding)/sizeof(char*))) {
10166 strenc = strencoding[val->encoding];
10167 } else {
10168 snprintf(buf,64,"unknown encoding %d\n", val->encoding);
10169 strenc = buf;
10170 }
10171 addReplySds(c,sdscatprintf(sdsempty(),
10172 "+Key at:%p refcount:%d, value at:%p refcount:%d "
10173 "encoding:%s serializedlength:%lld\r\n",
10174 (void*)key, key->refcount, (void*)val, val->refcount,
10175 strenc, (long long) rdbSavedObjectLen(val,NULL)));
10176 } else {
10177 addReplySds(c,sdscatprintf(sdsempty(),
10178 "+Key at:%p refcount:%d, value swapped at: page %llu "
10179 "using %llu pages\r\n",
10180 (void*)key, key->refcount, (unsigned long long) key->vm.page,
10181 (unsigned long long) key->vm.usedpages));
10182 }
10183 } else if (!strcasecmp(c->argv[1]->ptr,"swapin") && c->argc == 3) {
10184 lookupKeyRead(c->db,c->argv[2]);
10185 addReply(c,shared.ok);
10186 } else if (!strcasecmp(c->argv[1]->ptr,"swapout") && c->argc == 3) {
10187 dictEntry *de = dictFind(c->db->dict,c->argv[2]);
10188 robj *key, *val;
10189
10190 if (!server.vm_enabled) {
10191 addReplySds(c,sdsnew("-ERR Virtual Memory is disabled\r\n"));
10192 return;
10193 }
10194 if (!de) {
10195 addReply(c,shared.nokeyerr);
10196 return;
10197 }
10198 key = dictGetEntryKey(de);
10199 val = dictGetEntryVal(de);
10200 /* If the key is shared we want to create a copy */
10201 if (key->refcount > 1) {
10202 robj *newkey = dupStringObject(key);
10203 decrRefCount(key);
10204 key = dictGetEntryKey(de) = newkey;
10205 }
10206 /* Swap it */
10207 if (key->storage != REDIS_VM_MEMORY) {
10208 addReplySds(c,sdsnew("-ERR This key is not in memory\r\n"));
10209 } else if (vmSwapObjectBlocking(key,val) == REDIS_OK) {
10210 dictGetEntryVal(de) = NULL;
10211 addReply(c,shared.ok);
10212 } else {
10213 addReply(c,shared.err);
10214 }
10215 } else if (!strcasecmp(c->argv[1]->ptr,"populate") && c->argc == 3) {
10216 long keys, j;
10217 robj *key, *val;
10218 char buf[128];
10219
10220 if (getLongFromObjectOrReply(c, c->argv[2], &keys, NULL) != REDIS_OK)
10221 return;
10222 for (j = 0; j < keys; j++) {
10223 snprintf(buf,sizeof(buf),"key:%lu",j);
10224 key = createStringObject(buf,strlen(buf));
10225 if (lookupKeyRead(c->db,key) != NULL) {
10226 decrRefCount(key);
10227 continue;
10228 }
10229 snprintf(buf,sizeof(buf),"value:%lu",j);
10230 val = createStringObject(buf,strlen(buf));
10231 dictAdd(c->db->dict,key,val);
10232 }
10233 addReply(c,shared.ok);
10234 } else {
10235 addReplySds(c,sdsnew(
10236 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPIN <key>|SWAPOUT <key>|RELOAD]\r\n"));
10237 }
10238 }
10239
10240 static void _redisAssert(char *estr, char *file, int line) {
10241 redisLog(REDIS_WARNING,"=== ASSERTION FAILED ===");
10242 redisLog(REDIS_WARNING,"==> %s:%d '%s' is not true\n",file,line,estr);
10243 #ifdef HAVE_BACKTRACE
10244 redisLog(REDIS_WARNING,"(forcing SIGSEGV in order to print the stack trace)");
10245 *((char*)-1) = 'x';
10246 #endif
10247 }
10248
10249 static void _redisPanic(char *msg, char *file, int line) {
10250 redisLog(REDIS_WARNING,"!!! Software Failure. Press left mouse button to continue");
10251 redisLog(REDIS_WARNING,"Guru Meditation: %s #%s:%d",msg,file,line);
10252 #ifdef HAVE_BACKTRACE
10253 redisLog(REDIS_WARNING,"(forcing SIGSEGV in order to print the stack trace)");
10254 *((char*)-1) = 'x';
10255 #endif
10256 }
10257
10258 /* =================================== Main! ================================ */
10259
10260 #ifdef __linux__
10261 int linuxOvercommitMemoryValue(void) {
10262 FILE *fp = fopen("/proc/sys/vm/overcommit_memory","r");
10263 char buf[64];
10264
10265 if (!fp) return -1;
10266 if (fgets(buf,64,fp) == NULL) {
10267 fclose(fp);
10268 return -1;
10269 }
10270 fclose(fp);
10271
10272 return atoi(buf);
10273 }
10274
10275 void linuxOvercommitMemoryWarning(void) {
10276 if (linuxOvercommitMemoryValue() == 0) {
10277 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.");
10278 }
10279 }
10280 #endif /* __linux__ */
10281
10282 static void daemonize(void) {
10283 int fd;
10284 FILE *fp;
10285
10286 if (fork() != 0) exit(0); /* parent exits */
10287 setsid(); /* create a new session */
10288
10289 /* Every output goes to /dev/null. If Redis is daemonized but
10290 * the 'logfile' is set to 'stdout' in the configuration file
10291 * it will not log at all. */
10292 if ((fd = open("/dev/null", O_RDWR, 0)) != -1) {
10293 dup2(fd, STDIN_FILENO);
10294 dup2(fd, STDOUT_FILENO);
10295 dup2(fd, STDERR_FILENO);
10296 if (fd > STDERR_FILENO) close(fd);
10297 }
10298 /* Try to write the pid file */
10299 fp = fopen(server.pidfile,"w");
10300 if (fp) {
10301 fprintf(fp,"%d\n",getpid());
10302 fclose(fp);
10303 }
10304 }
10305
10306 static void version() {
10307 printf("Redis server version %s\n", REDIS_VERSION);
10308 exit(0);
10309 }
10310
10311 static void usage() {
10312 fprintf(stderr,"Usage: ./redis-server [/path/to/redis.conf]\n");
10313 fprintf(stderr," ./redis-server - (read config from stdin)\n");
10314 exit(1);
10315 }
10316
10317 int main(int argc, char **argv) {
10318 time_t start;
10319
10320 initServerConfig();
10321 if (argc == 2) {
10322 if (strcmp(argv[1], "-v") == 0 ||
10323 strcmp(argv[1], "--version") == 0) version();
10324 if (strcmp(argv[1], "--help") == 0) usage();
10325 resetServerSaveParams();
10326 loadServerConfig(argv[1]);
10327 } else if ((argc > 2)) {
10328 usage();
10329 } else {
10330 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'");
10331 }
10332 if (server.daemonize) daemonize();
10333 initServer();
10334 redisLog(REDIS_NOTICE,"Server started, Redis version " REDIS_VERSION);
10335 #ifdef __linux__
10336 linuxOvercommitMemoryWarning();
10337 #endif
10338 start = time(NULL);
10339 if (server.appendonly) {
10340 if (loadAppendOnlyFile(server.appendfilename) == REDIS_OK)
10341 redisLog(REDIS_NOTICE,"DB loaded from append only file: %ld seconds",time(NULL)-start);
10342 } else {
10343 if (rdbLoad(server.dbfilename) == REDIS_OK)
10344 redisLog(REDIS_NOTICE,"DB loaded from disk: %ld seconds",time(NULL)-start);
10345 }
10346 redisLog(REDIS_NOTICE,"The server is now ready to accept connections on port %d", server.port);
10347 aeSetBeforeSleepProc(server.el,beforeSleep);
10348 aeMain(server.el);
10349 aeDeleteEventLoop(server.el);
10350 return 0;
10351 }
10352
10353 /* ============================= Backtrace support ========================= */
10354
10355 #ifdef HAVE_BACKTRACE
10356 static char *findFuncName(void *pointer, unsigned long *offset);
10357
10358 static void *getMcontextEip(ucontext_t *uc) {
10359 #if defined(__FreeBSD__)
10360 return (void*) uc->uc_mcontext.mc_eip;
10361 #elif defined(__dietlibc__)
10362 return (void*) uc->uc_mcontext.eip;
10363 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
10364 #if __x86_64__
10365 return (void*) uc->uc_mcontext->__ss.__rip;
10366 #else
10367 return (void*) uc->uc_mcontext->__ss.__eip;
10368 #endif
10369 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
10370 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
10371 return (void*) uc->uc_mcontext->__ss.__rip;
10372 #else
10373 return (void*) uc->uc_mcontext->__ss.__eip;
10374 #endif
10375 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
10376 return (void*) uc->uc_mcontext.gregs[REG_EIP]; /* Linux 32/64 bit */
10377 #elif defined(__ia64__) /* Linux IA64 */
10378 return (void*) uc->uc_mcontext.sc_ip;
10379 #else
10380 return NULL;
10381 #endif
10382 }
10383
10384 static void segvHandler(int sig, siginfo_t *info, void *secret) {
10385 void *trace[100];
10386 char **messages = NULL;
10387 int i, trace_size = 0;
10388 unsigned long offset=0;
10389 ucontext_t *uc = (ucontext_t*) secret;
10390 sds infostring;
10391 REDIS_NOTUSED(info);
10392
10393 redisLog(REDIS_WARNING,
10394 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION, sig);
10395 infostring = genRedisInfoString();
10396 redisLog(REDIS_WARNING, "%s",infostring);
10397 /* It's not safe to sdsfree() the returned string under memory
10398 * corruption conditions. Let it leak as we are going to abort */
10399
10400 trace_size = backtrace(trace, 100);
10401 /* overwrite sigaction with caller's address */
10402 if (getMcontextEip(uc) != NULL) {
10403 trace[1] = getMcontextEip(uc);
10404 }
10405 messages = backtrace_symbols(trace, trace_size);
10406
10407 for (i=1; i<trace_size; ++i) {
10408 char *fn = findFuncName(trace[i], &offset), *p;
10409
10410 p = strchr(messages[i],'+');
10411 if (!fn || (p && ((unsigned long)strtol(p+1,NULL,10)) < offset)) {
10412 redisLog(REDIS_WARNING,"%s", messages[i]);
10413 } else {
10414 redisLog(REDIS_WARNING,"%d redis-server %p %s + %d", i, trace[i], fn, (unsigned int)offset);
10415 }
10416 }
10417 /* free(messages); Don't call free() with possibly corrupted memory. */
10418 _exit(0);
10419 }
10420
10421 static void setupSigSegvAction(void) {
10422 struct sigaction act;
10423
10424 sigemptyset (&act.sa_mask);
10425 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
10426 * is used. Otherwise, sa_handler is used */
10427 act.sa_flags = SA_NODEFER | SA_ONSTACK | SA_RESETHAND | SA_SIGINFO;
10428 act.sa_sigaction = segvHandler;
10429 sigaction (SIGSEGV, &act, NULL);
10430 sigaction (SIGBUS, &act, NULL);
10431 sigaction (SIGFPE, &act, NULL);
10432 sigaction (SIGILL, &act, NULL);
10433 sigaction (SIGBUS, &act, NULL);
10434 return;
10435 }
10436
10437 #include "staticsymbols.h"
10438 /* This function try to convert a pointer into a function name. It's used in
10439 * oreder to provide a backtrace under segmentation fault that's able to
10440 * display functions declared as static (otherwise the backtrace is useless). */
10441 static char *findFuncName(void *pointer, unsigned long *offset){
10442 int i, ret = -1;
10443 unsigned long off, minoff = 0;
10444
10445 /* Try to match against the Symbol with the smallest offset */
10446 for (i=0; symsTable[i].pointer; i++) {
10447 unsigned long lp = (unsigned long) pointer;
10448
10449 if (lp != (unsigned long)-1 && lp >= symsTable[i].pointer) {
10450 off=lp-symsTable[i].pointer;
10451 if (ret < 0 || off < minoff) {
10452 minoff=off;
10453 ret=i;
10454 }
10455 }
10456 }
10457 if (ret == -1) return NULL;
10458 *offset = minoff;
10459 return symsTable[ret].name;
10460 }
10461 #else /* HAVE_BACKTRACE */
10462 static void setupSigSegvAction(void) {
10463 }
10464 #endif /* HAVE_BACKTRACE */
10465
10466
10467
10468 /* The End */
10469
10470
10471