]> git.saurik.com Git - redis.git/blob - redis.c
4f3773d06a245a42fcd7aa88dfad68534306d2e2
[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 void usage();
626 static int rewriteAppendOnlyFileBackground(void);
627 static int vmSwapObjectBlocking(robj *key, robj *val);
628
629 static void authCommand(redisClient *c);
630 static void pingCommand(redisClient *c);
631 static void echoCommand(redisClient *c);
632 static void setCommand(redisClient *c);
633 static void setnxCommand(redisClient *c);
634 static void setexCommand(redisClient *c);
635 static void getCommand(redisClient *c);
636 static void delCommand(redisClient *c);
637 static void existsCommand(redisClient *c);
638 static void incrCommand(redisClient *c);
639 static void decrCommand(redisClient *c);
640 static void incrbyCommand(redisClient *c);
641 static void decrbyCommand(redisClient *c);
642 static void selectCommand(redisClient *c);
643 static void randomkeyCommand(redisClient *c);
644 static void keysCommand(redisClient *c);
645 static void dbsizeCommand(redisClient *c);
646 static void lastsaveCommand(redisClient *c);
647 static void saveCommand(redisClient *c);
648 static void bgsaveCommand(redisClient *c);
649 static void bgrewriteaofCommand(redisClient *c);
650 static void shutdownCommand(redisClient *c);
651 static void moveCommand(redisClient *c);
652 static void renameCommand(redisClient *c);
653 static void renamenxCommand(redisClient *c);
654 static void lpushCommand(redisClient *c);
655 static void rpushCommand(redisClient *c);
656 static void lpopCommand(redisClient *c);
657 static void rpopCommand(redisClient *c);
658 static void llenCommand(redisClient *c);
659 static void lindexCommand(redisClient *c);
660 static void lrangeCommand(redisClient *c);
661 static void ltrimCommand(redisClient *c);
662 static void typeCommand(redisClient *c);
663 static void lsetCommand(redisClient *c);
664 static void saddCommand(redisClient *c);
665 static void sremCommand(redisClient *c);
666 static void smoveCommand(redisClient *c);
667 static void sismemberCommand(redisClient *c);
668 static void scardCommand(redisClient *c);
669 static void spopCommand(redisClient *c);
670 static void srandmemberCommand(redisClient *c);
671 static void sinterCommand(redisClient *c);
672 static void sinterstoreCommand(redisClient *c);
673 static void sunionCommand(redisClient *c);
674 static void sunionstoreCommand(redisClient *c);
675 static void sdiffCommand(redisClient *c);
676 static void sdiffstoreCommand(redisClient *c);
677 static void syncCommand(redisClient *c);
678 static void flushdbCommand(redisClient *c);
679 static void flushallCommand(redisClient *c);
680 static void sortCommand(redisClient *c);
681 static void lremCommand(redisClient *c);
682 static void rpoplpushcommand(redisClient *c);
683 static void infoCommand(redisClient *c);
684 static void mgetCommand(redisClient *c);
685 static void monitorCommand(redisClient *c);
686 static void expireCommand(redisClient *c);
687 static void expireatCommand(redisClient *c);
688 static void getsetCommand(redisClient *c);
689 static void ttlCommand(redisClient *c);
690 static void slaveofCommand(redisClient *c);
691 static void debugCommand(redisClient *c);
692 static void msetCommand(redisClient *c);
693 static void msetnxCommand(redisClient *c);
694 static void zaddCommand(redisClient *c);
695 static void zincrbyCommand(redisClient *c);
696 static void zrangeCommand(redisClient *c);
697 static void zrangebyscoreCommand(redisClient *c);
698 static void zcountCommand(redisClient *c);
699 static void zrevrangeCommand(redisClient *c);
700 static void zcardCommand(redisClient *c);
701 static void zremCommand(redisClient *c);
702 static void zscoreCommand(redisClient *c);
703 static void zremrangebyscoreCommand(redisClient *c);
704 static void multiCommand(redisClient *c);
705 static void execCommand(redisClient *c);
706 static void discardCommand(redisClient *c);
707 static void blpopCommand(redisClient *c);
708 static void brpopCommand(redisClient *c);
709 static void appendCommand(redisClient *c);
710 static void substrCommand(redisClient *c);
711 static void zrankCommand(redisClient *c);
712 static void zrevrankCommand(redisClient *c);
713 static void hsetCommand(redisClient *c);
714 static void hsetnxCommand(redisClient *c);
715 static void hgetCommand(redisClient *c);
716 static void hmsetCommand(redisClient *c);
717 static void hmgetCommand(redisClient *c);
718 static void hdelCommand(redisClient *c);
719 static void hlenCommand(redisClient *c);
720 static void zremrangebyrankCommand(redisClient *c);
721 static void zunionCommand(redisClient *c);
722 static void zinterCommand(redisClient *c);
723 static void hkeysCommand(redisClient *c);
724 static void hvalsCommand(redisClient *c);
725 static void hgetallCommand(redisClient *c);
726 static void hexistsCommand(redisClient *c);
727 static void configCommand(redisClient *c);
728 static void hincrbyCommand(redisClient *c);
729 static void subscribeCommand(redisClient *c);
730 static void unsubscribeCommand(redisClient *c);
731 static void psubscribeCommand(redisClient *c);
732 static void punsubscribeCommand(redisClient *c);
733 static void publishCommand(redisClient *c);
734
735 /*================================= Globals ================================= */
736
737 /* Global vars */
738 static struct redisServer server; /* server global state */
739 static struct redisCommand cmdTable[] = {
740 {"get",getCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
741 {"set",setCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,0,0,0},
742 {"setnx",setnxCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,0,0,0},
743 {"setex",setexCommand,4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,0,0,0},
744 {"append",appendCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
745 {"substr",substrCommand,4,REDIS_CMD_INLINE,NULL,1,1,1},
746 {"del",delCommand,-2,REDIS_CMD_INLINE,NULL,0,0,0},
747 {"exists",existsCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
748 {"incr",incrCommand,2,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,1,1},
749 {"decr",decrCommand,2,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,1,1},
750 {"mget",mgetCommand,-2,REDIS_CMD_INLINE,NULL,1,-1,1},
751 {"rpush",rpushCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
752 {"lpush",lpushCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
753 {"rpop",rpopCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
754 {"lpop",lpopCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
755 {"brpop",brpopCommand,-3,REDIS_CMD_INLINE,NULL,1,1,1},
756 {"blpop",blpopCommand,-3,REDIS_CMD_INLINE,NULL,1,1,1},
757 {"llen",llenCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
758 {"lindex",lindexCommand,3,REDIS_CMD_INLINE,NULL,1,1,1},
759 {"lset",lsetCommand,4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
760 {"lrange",lrangeCommand,4,REDIS_CMD_INLINE,NULL,1,1,1},
761 {"ltrim",ltrimCommand,4,REDIS_CMD_INLINE,NULL,1,1,1},
762 {"lrem",lremCommand,4,REDIS_CMD_BULK,NULL,1,1,1},
763 {"rpoplpush",rpoplpushcommand,3,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,2,1},
764 {"sadd",saddCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
765 {"srem",sremCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
766 {"smove",smoveCommand,4,REDIS_CMD_BULK,NULL,1,2,1},
767 {"sismember",sismemberCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
768 {"scard",scardCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
769 {"spop",spopCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
770 {"srandmember",srandmemberCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
771 {"sinter",sinterCommand,-2,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,-1,1},
772 {"sinterstore",sinterstoreCommand,-3,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,2,-1,1},
773 {"sunion",sunionCommand,-2,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,-1,1},
774 {"sunionstore",sunionstoreCommand,-3,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,2,-1,1},
775 {"sdiff",sdiffCommand,-2,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,-1,1},
776 {"sdiffstore",sdiffstoreCommand,-3,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,2,-1,1},
777 {"smembers",sinterCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
778 {"zadd",zaddCommand,4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
779 {"zincrby",zincrbyCommand,4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
780 {"zrem",zremCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
781 {"zremrangebyscore",zremrangebyscoreCommand,4,REDIS_CMD_INLINE,NULL,1,1,1},
782 {"zremrangebyrank",zremrangebyrankCommand,4,REDIS_CMD_INLINE,NULL,1,1,1},
783 {"zunion",zunionCommand,-4,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,zunionInterBlockClientOnSwappedKeys,0,0,0},
784 {"zinter",zinterCommand,-4,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,zunionInterBlockClientOnSwappedKeys,0,0,0},
785 {"zrange",zrangeCommand,-4,REDIS_CMD_INLINE,NULL,1,1,1},
786 {"zrangebyscore",zrangebyscoreCommand,-4,REDIS_CMD_INLINE,NULL,1,1,1},
787 {"zcount",zcountCommand,4,REDIS_CMD_INLINE,NULL,1,1,1},
788 {"zrevrange",zrevrangeCommand,-4,REDIS_CMD_INLINE,NULL,1,1,1},
789 {"zcard",zcardCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
790 {"zscore",zscoreCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
791 {"zrank",zrankCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
792 {"zrevrank",zrevrankCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
793 {"hset",hsetCommand,4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
794 {"hsetnx",hsetnxCommand,4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
795 {"hget",hgetCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
796 {"hmset",hmsetCommand,-4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
797 {"hmget",hmgetCommand,-3,REDIS_CMD_BULK,NULL,1,1,1},
798 {"hincrby",hincrbyCommand,4,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,1,1},
799 {"hdel",hdelCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
800 {"hlen",hlenCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
801 {"hkeys",hkeysCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
802 {"hvals",hvalsCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
803 {"hgetall",hgetallCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
804 {"hexists",hexistsCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
805 {"incrby",incrbyCommand,3,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,1,1},
806 {"decrby",decrbyCommand,3,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,1,1},
807 {"getset",getsetCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
808 {"mset",msetCommand,-3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,-1,2},
809 {"msetnx",msetnxCommand,-3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,-1,2},
810 {"randomkey",randomkeyCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
811 {"select",selectCommand,2,REDIS_CMD_INLINE,NULL,0,0,0},
812 {"move",moveCommand,3,REDIS_CMD_INLINE,NULL,1,1,1},
813 {"rename",renameCommand,3,REDIS_CMD_INLINE,NULL,1,1,1},
814 {"renamenx",renamenxCommand,3,REDIS_CMD_INLINE,NULL,1,1,1},
815 {"expire",expireCommand,3,REDIS_CMD_INLINE,NULL,0,0,0},
816 {"expireat",expireatCommand,3,REDIS_CMD_INLINE,NULL,0,0,0},
817 {"keys",keysCommand,2,REDIS_CMD_INLINE,NULL,0,0,0},
818 {"dbsize",dbsizeCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
819 {"auth",authCommand,2,REDIS_CMD_INLINE,NULL,0,0,0},
820 {"ping",pingCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
821 {"echo",echoCommand,2,REDIS_CMD_BULK,NULL,0,0,0},
822 {"save",saveCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
823 {"bgsave",bgsaveCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
824 {"bgrewriteaof",bgrewriteaofCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
825 {"shutdown",shutdownCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
826 {"lastsave",lastsaveCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
827 {"type",typeCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
828 {"multi",multiCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
829 {"exec",execCommand,1,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,0,0,0},
830 {"discard",discardCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
831 {"sync",syncCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
832 {"flushdb",flushdbCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
833 {"flushall",flushallCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
834 {"sort",sortCommand,-2,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,1,1},
835 {"info",infoCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
836 {"monitor",monitorCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
837 {"ttl",ttlCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
838 {"slaveof",slaveofCommand,3,REDIS_CMD_INLINE,NULL,0,0,0},
839 {"debug",debugCommand,-2,REDIS_CMD_INLINE,NULL,0,0,0},
840 {"config",configCommand,-2,REDIS_CMD_BULK,NULL,0,0,0},
841 {"subscribe",subscribeCommand,-2,REDIS_CMD_INLINE,NULL,0,0,0},
842 {"unsubscribe",unsubscribeCommand,-1,REDIS_CMD_INLINE,NULL,0,0,0},
843 {"psubscribe",psubscribeCommand,-2,REDIS_CMD_INLINE,NULL,0,0,0},
844 {"punsubscribe",punsubscribeCommand,-1,REDIS_CMD_INLINE,NULL,0,0,0},
845 {"publish",publishCommand,3,REDIS_CMD_BULK|REDIS_CMD_FORCE_REPLICATION,NULL,0,0,0},
846 {NULL,NULL,0,0,NULL,0,0,0}
847 };
848
849 /*============================ Utility functions ============================ */
850
851 /* Glob-style pattern matching. */
852 static int stringmatchlen(const char *pattern, int patternLen,
853 const char *string, int stringLen, int nocase)
854 {
855 while(patternLen) {
856 switch(pattern[0]) {
857 case '*':
858 while (pattern[1] == '*') {
859 pattern++;
860 patternLen--;
861 }
862 if (patternLen == 1)
863 return 1; /* match */
864 while(stringLen) {
865 if (stringmatchlen(pattern+1, patternLen-1,
866 string, stringLen, nocase))
867 return 1; /* match */
868 string++;
869 stringLen--;
870 }
871 return 0; /* no match */
872 break;
873 case '?':
874 if (stringLen == 0)
875 return 0; /* no match */
876 string++;
877 stringLen--;
878 break;
879 case '[':
880 {
881 int not, match;
882
883 pattern++;
884 patternLen--;
885 not = pattern[0] == '^';
886 if (not) {
887 pattern++;
888 patternLen--;
889 }
890 match = 0;
891 while(1) {
892 if (pattern[0] == '\\') {
893 pattern++;
894 patternLen--;
895 if (pattern[0] == string[0])
896 match = 1;
897 } else if (pattern[0] == ']') {
898 break;
899 } else if (patternLen == 0) {
900 pattern--;
901 patternLen++;
902 break;
903 } else if (pattern[1] == '-' && patternLen >= 3) {
904 int start = pattern[0];
905 int end = pattern[2];
906 int c = string[0];
907 if (start > end) {
908 int t = start;
909 start = end;
910 end = t;
911 }
912 if (nocase) {
913 start = tolower(start);
914 end = tolower(end);
915 c = tolower(c);
916 }
917 pattern += 2;
918 patternLen -= 2;
919 if (c >= start && c <= end)
920 match = 1;
921 } else {
922 if (!nocase) {
923 if (pattern[0] == string[0])
924 match = 1;
925 } else {
926 if (tolower((int)pattern[0]) == tolower((int)string[0]))
927 match = 1;
928 }
929 }
930 pattern++;
931 patternLen--;
932 }
933 if (not)
934 match = !match;
935 if (!match)
936 return 0; /* no match */
937 string++;
938 stringLen--;
939 break;
940 }
941 case '\\':
942 if (patternLen >= 2) {
943 pattern++;
944 patternLen--;
945 }
946 /* fall through */
947 default:
948 if (!nocase) {
949 if (pattern[0] != string[0])
950 return 0; /* no match */
951 } else {
952 if (tolower((int)pattern[0]) != tolower((int)string[0]))
953 return 0; /* no match */
954 }
955 string++;
956 stringLen--;
957 break;
958 }
959 pattern++;
960 patternLen--;
961 if (stringLen == 0) {
962 while(*pattern == '*') {
963 pattern++;
964 patternLen--;
965 }
966 break;
967 }
968 }
969 if (patternLen == 0 && stringLen == 0)
970 return 1;
971 return 0;
972 }
973
974 static int stringmatch(const char *pattern, const char *string, int nocase) {
975 return stringmatchlen(pattern,strlen(pattern),string,strlen(string),nocase);
976 }
977
978 /* Convert a string representing an amount of memory into the number of
979 * bytes, so for instance memtoll("1Gi") will return 1073741824 that is
980 * (1024*1024*1024).
981 *
982 * On parsing error, if *err is not NULL, it's set to 1, otherwise it's
983 * set to 0 */
984 static long long memtoll(const char *p, int *err) {
985 const char *u;
986 char buf[128];
987 long mul; /* unit multiplier */
988 long long val;
989 unsigned int digits;
990
991 if (err) *err = 0;
992 /* Search the first non digit character. */
993 u = p;
994 if (*u == '-') u++;
995 while(*u && isdigit(*u)) u++;
996 if (*u == '\0' || !strcasecmp(u,"b")) {
997 mul = 1;
998 } else if (!strcasecmp(u,"k")) {
999 mul = 1000;
1000 } else if (!strcasecmp(u,"kb")) {
1001 mul = 1024;
1002 } else if (!strcasecmp(u,"m")) {
1003 mul = 1000*1000;
1004 } else if (!strcasecmp(u,"mb")) {
1005 mul = 1024*1024;
1006 } else if (!strcasecmp(u,"g")) {
1007 mul = 1000L*1000*1000;
1008 } else if (!strcasecmp(u,"gb")) {
1009 mul = 1024L*1024*1024;
1010 } else {
1011 if (err) *err = 1;
1012 mul = 1;
1013 }
1014 digits = u-p;
1015 if (digits >= sizeof(buf)) {
1016 if (err) *err = 1;
1017 return LLONG_MAX;
1018 }
1019 memcpy(buf,p,digits);
1020 buf[digits] = '\0';
1021 val = strtoll(buf,NULL,10);
1022 return val*mul;
1023 }
1024
1025 static void redisLog(int level, const char *fmt, ...) {
1026 va_list ap;
1027 FILE *fp;
1028
1029 fp = (server.logfile == NULL) ? stdout : fopen(server.logfile,"a");
1030 if (!fp) return;
1031
1032 va_start(ap, fmt);
1033 if (level >= server.verbosity) {
1034 char *c = ".-*#";
1035 char buf[64];
1036 time_t now;
1037
1038 now = time(NULL);
1039 strftime(buf,64,"%d %b %H:%M:%S",localtime(&now));
1040 fprintf(fp,"[%d] %s %c ",(int)getpid(),buf,c[level]);
1041 vfprintf(fp, fmt, ap);
1042 fprintf(fp,"\n");
1043 fflush(fp);
1044 }
1045 va_end(ap);
1046
1047 if (server.logfile) fclose(fp);
1048 }
1049
1050 /*====================== Hash table type implementation ==================== */
1051
1052 /* This is an hash table type that uses the SDS dynamic strings libary as
1053 * keys and radis objects as values (objects can hold SDS strings,
1054 * lists, sets). */
1055
1056 static void dictVanillaFree(void *privdata, void *val)
1057 {
1058 DICT_NOTUSED(privdata);
1059 zfree(val);
1060 }
1061
1062 static void dictListDestructor(void *privdata, void *val)
1063 {
1064 DICT_NOTUSED(privdata);
1065 listRelease((list*)val);
1066 }
1067
1068 static int sdsDictKeyCompare(void *privdata, const void *key1,
1069 const void *key2)
1070 {
1071 int l1,l2;
1072 DICT_NOTUSED(privdata);
1073
1074 l1 = sdslen((sds)key1);
1075 l2 = sdslen((sds)key2);
1076 if (l1 != l2) return 0;
1077 return memcmp(key1, key2, l1) == 0;
1078 }
1079
1080 static void dictRedisObjectDestructor(void *privdata, void *val)
1081 {
1082 DICT_NOTUSED(privdata);
1083
1084 if (val == NULL) return; /* Values of swapped out keys as set to NULL */
1085 decrRefCount(val);
1086 }
1087
1088 static int dictObjKeyCompare(void *privdata, const void *key1,
1089 const void *key2)
1090 {
1091 const robj *o1 = key1, *o2 = key2;
1092 return sdsDictKeyCompare(privdata,o1->ptr,o2->ptr);
1093 }
1094
1095 static unsigned int dictObjHash(const void *key) {
1096 const robj *o = key;
1097 return dictGenHashFunction(o->ptr, sdslen((sds)o->ptr));
1098 }
1099
1100 static int dictEncObjKeyCompare(void *privdata, const void *key1,
1101 const void *key2)
1102 {
1103 robj *o1 = (robj*) key1, *o2 = (robj*) key2;
1104 int cmp;
1105
1106 if (o1->encoding == REDIS_ENCODING_INT &&
1107 o2->encoding == REDIS_ENCODING_INT &&
1108 o1->ptr == o2->ptr) return 1;
1109
1110 o1 = getDecodedObject(o1);
1111 o2 = getDecodedObject(o2);
1112 cmp = sdsDictKeyCompare(privdata,o1->ptr,o2->ptr);
1113 decrRefCount(o1);
1114 decrRefCount(o2);
1115 return cmp;
1116 }
1117
1118 static unsigned int dictEncObjHash(const void *key) {
1119 robj *o = (robj*) key;
1120
1121 if (o->encoding == REDIS_ENCODING_RAW) {
1122 return dictGenHashFunction(o->ptr, sdslen((sds)o->ptr));
1123 } else {
1124 if (o->encoding == REDIS_ENCODING_INT) {
1125 char buf[32];
1126 int len;
1127
1128 len = snprintf(buf,32,"%ld",(long)o->ptr);
1129 return dictGenHashFunction((unsigned char*)buf, len);
1130 } else {
1131 unsigned int hash;
1132
1133 o = getDecodedObject(o);
1134 hash = dictGenHashFunction(o->ptr, sdslen((sds)o->ptr));
1135 decrRefCount(o);
1136 return hash;
1137 }
1138 }
1139 }
1140
1141 /* Sets type and expires */
1142 static dictType setDictType = {
1143 dictEncObjHash, /* hash function */
1144 NULL, /* key dup */
1145 NULL, /* val dup */
1146 dictEncObjKeyCompare, /* key compare */
1147 dictRedisObjectDestructor, /* key destructor */
1148 NULL /* val destructor */
1149 };
1150
1151 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
1152 static dictType zsetDictType = {
1153 dictEncObjHash, /* hash function */
1154 NULL, /* key dup */
1155 NULL, /* val dup */
1156 dictEncObjKeyCompare, /* key compare */
1157 dictRedisObjectDestructor, /* key destructor */
1158 dictVanillaFree /* val destructor of malloc(sizeof(double)) */
1159 };
1160
1161 /* Db->dict */
1162 static dictType dbDictType = {
1163 dictObjHash, /* hash function */
1164 NULL, /* key dup */
1165 NULL, /* val dup */
1166 dictObjKeyCompare, /* key compare */
1167 dictRedisObjectDestructor, /* key destructor */
1168 dictRedisObjectDestructor /* val destructor */
1169 };
1170
1171 /* Db->expires */
1172 static dictType keyptrDictType = {
1173 dictObjHash, /* hash function */
1174 NULL, /* key dup */
1175 NULL, /* val dup */
1176 dictObjKeyCompare, /* key compare */
1177 dictRedisObjectDestructor, /* key destructor */
1178 NULL /* val destructor */
1179 };
1180
1181 /* Hash type hash table (note that small hashes are represented with zimpaps) */
1182 static dictType hashDictType = {
1183 dictEncObjHash, /* hash function */
1184 NULL, /* key dup */
1185 NULL, /* val dup */
1186 dictEncObjKeyCompare, /* key compare */
1187 dictRedisObjectDestructor, /* key destructor */
1188 dictRedisObjectDestructor /* val destructor */
1189 };
1190
1191 /* Keylist hash table type has unencoded redis objects as keys and
1192 * lists as values. It's used for blocking operations (BLPOP) and to
1193 * map swapped keys to a list of clients waiting for this keys to be loaded. */
1194 static dictType keylistDictType = {
1195 dictObjHash, /* hash function */
1196 NULL, /* key dup */
1197 NULL, /* val dup */
1198 dictObjKeyCompare, /* key compare */
1199 dictRedisObjectDestructor, /* key destructor */
1200 dictListDestructor /* val destructor */
1201 };
1202
1203 static void version();
1204
1205 /* ========================= Random utility functions ======================= */
1206
1207 /* Redis generally does not try to recover from out of memory conditions
1208 * when allocating objects or strings, it is not clear if it will be possible
1209 * to report this condition to the client since the networking layer itself
1210 * is based on heap allocation for send buffers, so we simply abort.
1211 * At least the code will be simpler to read... */
1212 static void oom(const char *msg) {
1213 redisLog(REDIS_WARNING, "%s: Out of memory\n",msg);
1214 sleep(1);
1215 abort();
1216 }
1217
1218 /* ====================== Redis server networking stuff ===================== */
1219 static void closeTimedoutClients(void) {
1220 redisClient *c;
1221 listNode *ln;
1222 time_t now = time(NULL);
1223 listIter li;
1224
1225 listRewind(server.clients,&li);
1226 while ((ln = listNext(&li)) != NULL) {
1227 c = listNodeValue(ln);
1228 if (server.maxidletime &&
1229 !(c->flags & REDIS_SLAVE) && /* no timeout for slaves */
1230 !(c->flags & REDIS_MASTER) && /* no timeout for masters */
1231 dictSize(c->pubsub_channels) == 0 && /* no timeout for pubsub */
1232 listLength(c->pubsub_patterns) == 0 &&
1233 (now - c->lastinteraction > server.maxidletime))
1234 {
1235 redisLog(REDIS_VERBOSE,"Closing idle client");
1236 freeClient(c);
1237 } else if (c->flags & REDIS_BLOCKED) {
1238 if (c->blockingto != 0 && c->blockingto < now) {
1239 addReply(c,shared.nullmultibulk);
1240 unblockClientWaitingData(c);
1241 }
1242 }
1243 }
1244 }
1245
1246 static int htNeedsResize(dict *dict) {
1247 long long size, used;
1248
1249 size = dictSlots(dict);
1250 used = dictSize(dict);
1251 return (size && used && size > DICT_HT_INITIAL_SIZE &&
1252 (used*100/size < REDIS_HT_MINFILL));
1253 }
1254
1255 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
1256 * we resize the hash table to save memory */
1257 static void tryResizeHashTables(void) {
1258 int j;
1259
1260 for (j = 0; j < server.dbnum; j++) {
1261 if (htNeedsResize(server.db[j].dict))
1262 dictResize(server.db[j].dict);
1263 if (htNeedsResize(server.db[j].expires))
1264 dictResize(server.db[j].expires);
1265 }
1266 }
1267
1268 /* Our hash table implementation performs rehashing incrementally while
1269 * we write/read from the hash table. Still if the server is idle, the hash
1270 * table will use two tables for a long time. So we try to use 1 millisecond
1271 * of CPU time at every serverCron() loop in order to rehash some key. */
1272 static void incrementallyRehash(void) {
1273 int j;
1274
1275 for (j = 0; j < server.dbnum; j++) {
1276 if (dictIsRehashing(server.db[j].dict)) {
1277 dictRehashMilliseconds(server.db[j].dict,1);
1278 break; /* already used our millisecond for this loop... */
1279 }
1280 }
1281 }
1282
1283 /* A background saving child (BGSAVE) terminated its work. Handle this. */
1284 void backgroundSaveDoneHandler(int statloc) {
1285 int exitcode = WEXITSTATUS(statloc);
1286 int bysignal = WIFSIGNALED(statloc);
1287
1288 if (!bysignal && exitcode == 0) {
1289 redisLog(REDIS_NOTICE,
1290 "Background saving terminated with success");
1291 server.dirty = 0;
1292 server.lastsave = time(NULL);
1293 } else if (!bysignal && exitcode != 0) {
1294 redisLog(REDIS_WARNING, "Background saving error");
1295 } else {
1296 redisLog(REDIS_WARNING,
1297 "Background saving terminated by signal %d", WTERMSIG(statloc));
1298 rdbRemoveTempFile(server.bgsavechildpid);
1299 }
1300 server.bgsavechildpid = -1;
1301 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1302 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1303 updateSlavesWaitingBgsave(exitcode == 0 ? REDIS_OK : REDIS_ERR);
1304 }
1305
1306 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1307 * Handle this. */
1308 void backgroundRewriteDoneHandler(int statloc) {
1309 int exitcode = WEXITSTATUS(statloc);
1310 int bysignal = WIFSIGNALED(statloc);
1311
1312 if (!bysignal && exitcode == 0) {
1313 int fd;
1314 char tmpfile[256];
1315
1316 redisLog(REDIS_NOTICE,
1317 "Background append only file rewriting terminated with success");
1318 /* Now it's time to flush the differences accumulated by the parent */
1319 snprintf(tmpfile,256,"temp-rewriteaof-bg-%d.aof", (int) server.bgrewritechildpid);
1320 fd = open(tmpfile,O_WRONLY|O_APPEND);
1321 if (fd == -1) {
1322 redisLog(REDIS_WARNING, "Not able to open the temp append only file produced by the child: %s", strerror(errno));
1323 goto cleanup;
1324 }
1325 /* Flush our data... */
1326 if (write(fd,server.bgrewritebuf,sdslen(server.bgrewritebuf)) !=
1327 (signed) sdslen(server.bgrewritebuf)) {
1328 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));
1329 close(fd);
1330 goto cleanup;
1331 }
1332 redisLog(REDIS_NOTICE,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server.bgrewritebuf));
1333 /* Now our work is to rename the temp file into the stable file. And
1334 * switch the file descriptor used by the server for append only. */
1335 if (rename(tmpfile,server.appendfilename) == -1) {
1336 redisLog(REDIS_WARNING,"Can't rename the temp append only file into the stable one: %s", strerror(errno));
1337 close(fd);
1338 goto cleanup;
1339 }
1340 /* Mission completed... almost */
1341 redisLog(REDIS_NOTICE,"Append only file successfully rewritten.");
1342 if (server.appendfd != -1) {
1343 /* If append only is actually enabled... */
1344 close(server.appendfd);
1345 server.appendfd = fd;
1346 fsync(fd);
1347 server.appendseldb = -1; /* Make sure it will issue SELECT */
1348 redisLog(REDIS_NOTICE,"The new append only file was selected for future appends.");
1349 } else {
1350 /* If append only is disabled we just generate a dump in this
1351 * format. Why not? */
1352 close(fd);
1353 }
1354 } else if (!bysignal && exitcode != 0) {
1355 redisLog(REDIS_WARNING, "Background append only file rewriting error");
1356 } else {
1357 redisLog(REDIS_WARNING,
1358 "Background append only file rewriting terminated by signal %d",
1359 WTERMSIG(statloc));
1360 }
1361 cleanup:
1362 sdsfree(server.bgrewritebuf);
1363 server.bgrewritebuf = sdsempty();
1364 aofRemoveTempFile(server.bgrewritechildpid);
1365 server.bgrewritechildpid = -1;
1366 }
1367
1368 /* This function is called once a background process of some kind terminates,
1369 * as we want to avoid resizing the hash tables when there is a child in order
1370 * to play well with copy-on-write (otherwise when a resize happens lots of
1371 * memory pages are copied). The goal of this function is to update the ability
1372 * for dict.c to resize the hash tables accordingly to the fact we have o not
1373 * running childs. */
1374 static void updateDictResizePolicy(void) {
1375 if (server.bgsavechildpid == -1 && server.bgrewritechildpid == -1)
1376 dictEnableResize();
1377 else
1378 dictDisableResize();
1379 }
1380
1381 static int serverCron(struct aeEventLoop *eventLoop, long long id, void *clientData) {
1382 int j, loops = server.cronloops++;
1383 REDIS_NOTUSED(eventLoop);
1384 REDIS_NOTUSED(id);
1385 REDIS_NOTUSED(clientData);
1386
1387 /* We take a cached value of the unix time in the global state because
1388 * with virtual memory and aging there is to store the current time
1389 * in objects at every object access, and accuracy is not needed.
1390 * To access a global var is faster than calling time(NULL) */
1391 server.unixtime = time(NULL);
1392
1393 /* Show some info about non-empty databases */
1394 for (j = 0; j < server.dbnum; j++) {
1395 long long size, used, vkeys;
1396
1397 size = dictSlots(server.db[j].dict);
1398 used = dictSize(server.db[j].dict);
1399 vkeys = dictSize(server.db[j].expires);
1400 if (!(loops % 50) && (used || vkeys)) {
1401 redisLog(REDIS_VERBOSE,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j,used,vkeys,size);
1402 /* dictPrintStats(server.dict); */
1403 }
1404 }
1405
1406 /* We don't want to resize the hash tables while a bacground saving
1407 * is in progress: the saving child is created using fork() that is
1408 * implemented with a copy-on-write semantic in most modern systems, so
1409 * if we resize the HT while there is the saving child at work actually
1410 * a lot of memory movements in the parent will cause a lot of pages
1411 * copied. */
1412 if (server.bgsavechildpid == -1 && server.bgrewritechildpid == -1) {
1413 if (!(loops % 10)) tryResizeHashTables();
1414 if (server.activerehashing) incrementallyRehash();
1415 }
1416
1417 /* Show information about connected clients */
1418 if (!(loops % 50)) {
1419 redisLog(REDIS_VERBOSE,"%d clients connected (%d slaves), %zu bytes in use",
1420 listLength(server.clients)-listLength(server.slaves),
1421 listLength(server.slaves),
1422 zmalloc_used_memory());
1423 }
1424
1425 /* Close connections of timedout clients */
1426 if ((server.maxidletime && !(loops % 100)) || server.blpop_blocked_clients)
1427 closeTimedoutClients();
1428
1429 /* Check if a background saving or AOF rewrite in progress terminated */
1430 if (server.bgsavechildpid != -1 || server.bgrewritechildpid != -1) {
1431 int statloc;
1432 pid_t pid;
1433
1434 if ((pid = wait3(&statloc,WNOHANG,NULL)) != 0) {
1435 if (pid == server.bgsavechildpid) {
1436 backgroundSaveDoneHandler(statloc);
1437 } else {
1438 backgroundRewriteDoneHandler(statloc);
1439 }
1440 updateDictResizePolicy();
1441 }
1442 } else {
1443 /* If there is not a background saving in progress check if
1444 * we have to save now */
1445 time_t now = time(NULL);
1446 for (j = 0; j < server.saveparamslen; j++) {
1447 struct saveparam *sp = server.saveparams+j;
1448
1449 if (server.dirty >= sp->changes &&
1450 now-server.lastsave > sp->seconds) {
1451 redisLog(REDIS_NOTICE,"%d changes in %d seconds. Saving...",
1452 sp->changes, sp->seconds);
1453 rdbSaveBackground(server.dbfilename);
1454 break;
1455 }
1456 }
1457 }
1458
1459 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1460 * will use few CPU cycles if there are few expiring keys, otherwise
1461 * it will get more aggressive to avoid that too much memory is used by
1462 * keys that can be removed from the keyspace. */
1463 for (j = 0; j < server.dbnum; j++) {
1464 int expired;
1465 redisDb *db = server.db+j;
1466
1467 /* Continue to expire if at the end of the cycle more than 25%
1468 * of the keys were expired. */
1469 do {
1470 long num = dictSize(db->expires);
1471 time_t now = time(NULL);
1472
1473 expired = 0;
1474 if (num > REDIS_EXPIRELOOKUPS_PER_CRON)
1475 num = REDIS_EXPIRELOOKUPS_PER_CRON;
1476 while (num--) {
1477 dictEntry *de;
1478 time_t t;
1479
1480 if ((de = dictGetRandomKey(db->expires)) == NULL) break;
1481 t = (time_t) dictGetEntryVal(de);
1482 if (now > t) {
1483 deleteKey(db,dictGetEntryKey(de));
1484 expired++;
1485 server.stat_expiredkeys++;
1486 }
1487 }
1488 } while (expired > REDIS_EXPIRELOOKUPS_PER_CRON/4);
1489 }
1490
1491 /* Swap a few keys on disk if we are over the memory limit and VM
1492 * is enbled. Try to free objects from the free list first. */
1493 if (vmCanSwapOut()) {
1494 while (server.vm_enabled && zmalloc_used_memory() >
1495 server.vm_max_memory)
1496 {
1497 int retval;
1498
1499 if (tryFreeOneObjectFromFreelist() == REDIS_OK) continue;
1500 retval = (server.vm_max_threads == 0) ?
1501 vmSwapOneObjectBlocking() :
1502 vmSwapOneObjectThreaded();
1503 if (retval == REDIS_ERR && !(loops % 300) &&
1504 zmalloc_used_memory() >
1505 (server.vm_max_memory+server.vm_max_memory/10))
1506 {
1507 redisLog(REDIS_WARNING,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1508 }
1509 /* Note that when using threade I/O we free just one object,
1510 * because anyway when the I/O thread in charge to swap this
1511 * object out will finish, the handler of completed jobs
1512 * will try to swap more objects if we are still out of memory. */
1513 if (retval == REDIS_ERR || server.vm_max_threads > 0) break;
1514 }
1515 }
1516
1517 /* Check if we should connect to a MASTER */
1518 if (server.replstate == REDIS_REPL_CONNECT && !(loops % 10)) {
1519 redisLog(REDIS_NOTICE,"Connecting to MASTER...");
1520 if (syncWithMaster() == REDIS_OK) {
1521 redisLog(REDIS_NOTICE,"MASTER <-> SLAVE sync succeeded");
1522 if (server.appendonly) rewriteAppendOnlyFileBackground();
1523 }
1524 }
1525 return 100;
1526 }
1527
1528 /* This function gets called every time Redis is entering the
1529 * main loop of the event driven library, that is, before to sleep
1530 * for ready file descriptors. */
1531 static void beforeSleep(struct aeEventLoop *eventLoop) {
1532 REDIS_NOTUSED(eventLoop);
1533
1534 /* Awake clients that got all the swapped keys they requested */
1535 if (server.vm_enabled && listLength(server.io_ready_clients)) {
1536 listIter li;
1537 listNode *ln;
1538
1539 listRewind(server.io_ready_clients,&li);
1540 while((ln = listNext(&li))) {
1541 redisClient *c = ln->value;
1542 struct redisCommand *cmd;
1543
1544 /* Resume the client. */
1545 listDelNode(server.io_ready_clients,ln);
1546 c->flags &= (~REDIS_IO_WAIT);
1547 server.vm_blocked_clients--;
1548 aeCreateFileEvent(server.el, c->fd, AE_READABLE,
1549 readQueryFromClient, c);
1550 cmd = lookupCommand(c->argv[0]->ptr);
1551 assert(cmd != NULL);
1552 call(c,cmd);
1553 resetClient(c);
1554 /* There may be more data to process in the input buffer. */
1555 if (c->querybuf && sdslen(c->querybuf) > 0)
1556 processInputBuffer(c);
1557 }
1558 }
1559 /* Write the AOF buffer on disk */
1560 flushAppendOnlyFile();
1561 }
1562
1563 static void createSharedObjects(void) {
1564 int j;
1565
1566 shared.crlf = createObject(REDIS_STRING,sdsnew("\r\n"));
1567 shared.ok = createObject(REDIS_STRING,sdsnew("+OK\r\n"));
1568 shared.err = createObject(REDIS_STRING,sdsnew("-ERR\r\n"));
1569 shared.emptybulk = createObject(REDIS_STRING,sdsnew("$0\r\n\r\n"));
1570 shared.czero = createObject(REDIS_STRING,sdsnew(":0\r\n"));
1571 shared.cone = createObject(REDIS_STRING,sdsnew(":1\r\n"));
1572 shared.nullbulk = createObject(REDIS_STRING,sdsnew("$-1\r\n"));
1573 shared.nullmultibulk = createObject(REDIS_STRING,sdsnew("*-1\r\n"));
1574 shared.emptymultibulk = createObject(REDIS_STRING,sdsnew("*0\r\n"));
1575 shared.pong = createObject(REDIS_STRING,sdsnew("+PONG\r\n"));
1576 shared.queued = createObject(REDIS_STRING,sdsnew("+QUEUED\r\n"));
1577 shared.wrongtypeerr = createObject(REDIS_STRING,sdsnew(
1578 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1579 shared.nokeyerr = createObject(REDIS_STRING,sdsnew(
1580 "-ERR no such key\r\n"));
1581 shared.syntaxerr = createObject(REDIS_STRING,sdsnew(
1582 "-ERR syntax error\r\n"));
1583 shared.sameobjecterr = createObject(REDIS_STRING,sdsnew(
1584 "-ERR source and destination objects are the same\r\n"));
1585 shared.outofrangeerr = createObject(REDIS_STRING,sdsnew(
1586 "-ERR index out of range\r\n"));
1587 shared.space = createObject(REDIS_STRING,sdsnew(" "));
1588 shared.colon = createObject(REDIS_STRING,sdsnew(":"));
1589 shared.plus = createObject(REDIS_STRING,sdsnew("+"));
1590 shared.select0 = createStringObject("select 0\r\n",10);
1591 shared.select1 = createStringObject("select 1\r\n",10);
1592 shared.select2 = createStringObject("select 2\r\n",10);
1593 shared.select3 = createStringObject("select 3\r\n",10);
1594 shared.select4 = createStringObject("select 4\r\n",10);
1595 shared.select5 = createStringObject("select 5\r\n",10);
1596 shared.select6 = createStringObject("select 6\r\n",10);
1597 shared.select7 = createStringObject("select 7\r\n",10);
1598 shared.select8 = createStringObject("select 8\r\n",10);
1599 shared.select9 = createStringObject("select 9\r\n",10);
1600 shared.messagebulk = createStringObject("$7\r\nmessage\r\n",13);
1601 shared.pmessagebulk = createStringObject("$8\r\npmessage\r\n",14);
1602 shared.subscribebulk = createStringObject("$9\r\nsubscribe\r\n",15);
1603 shared.unsubscribebulk = createStringObject("$11\r\nunsubscribe\r\n",18);
1604 shared.psubscribebulk = createStringObject("$10\r\npsubscribe\r\n",17);
1605 shared.punsubscribebulk = createStringObject("$12\r\npunsubscribe\r\n",19);
1606 shared.mbulk3 = createStringObject("*3\r\n",4);
1607 shared.mbulk4 = createStringObject("*4\r\n",4);
1608 for (j = 0; j < REDIS_SHARED_INTEGERS; j++) {
1609 shared.integers[j] = createObject(REDIS_STRING,(void*)(long)j);
1610 shared.integers[j]->encoding = REDIS_ENCODING_INT;
1611 }
1612 }
1613
1614 static void appendServerSaveParams(time_t seconds, int changes) {
1615 server.saveparams = zrealloc(server.saveparams,sizeof(struct saveparam)*(server.saveparamslen+1));
1616 server.saveparams[server.saveparamslen].seconds = seconds;
1617 server.saveparams[server.saveparamslen].changes = changes;
1618 server.saveparamslen++;
1619 }
1620
1621 static void resetServerSaveParams() {
1622 zfree(server.saveparams);
1623 server.saveparams = NULL;
1624 server.saveparamslen = 0;
1625 }
1626
1627 static void initServerConfig() {
1628 server.dbnum = REDIS_DEFAULT_DBNUM;
1629 server.port = REDIS_SERVERPORT;
1630 server.verbosity = REDIS_VERBOSE;
1631 server.maxidletime = REDIS_MAXIDLETIME;
1632 server.saveparams = NULL;
1633 server.logfile = NULL; /* NULL = log on standard output */
1634 server.bindaddr = NULL;
1635 server.glueoutputbuf = 1;
1636 server.daemonize = 0;
1637 server.appendonly = 0;
1638 server.appendfsync = APPENDFSYNC_EVERYSEC;
1639 server.lastfsync = time(NULL);
1640 server.appendfd = -1;
1641 server.appendseldb = -1; /* Make sure the first time will not match */
1642 server.pidfile = zstrdup("/var/run/redis.pid");
1643 server.dbfilename = zstrdup("dump.rdb");
1644 server.appendfilename = zstrdup("appendonly.aof");
1645 server.requirepass = NULL;
1646 server.rdbcompression = 1;
1647 server.activerehashing = 1;
1648 server.maxclients = 0;
1649 server.blpop_blocked_clients = 0;
1650 server.maxmemory = 0;
1651 server.vm_enabled = 0;
1652 server.vm_swap_file = zstrdup("/tmp/redis-%p.vm");
1653 server.vm_page_size = 256; /* 256 bytes per page */
1654 server.vm_pages = 1024*1024*100; /* 104 millions of pages */
1655 server.vm_max_memory = 1024LL*1024*1024*1; /* 1 GB of RAM */
1656 server.vm_max_threads = 4;
1657 server.vm_blocked_clients = 0;
1658 server.hash_max_zipmap_entries = REDIS_HASH_MAX_ZIPMAP_ENTRIES;
1659 server.hash_max_zipmap_value = REDIS_HASH_MAX_ZIPMAP_VALUE;
1660
1661 resetServerSaveParams();
1662
1663 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1664 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1665 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1666 /* Replication related */
1667 server.isslave = 0;
1668 server.masterauth = NULL;
1669 server.masterhost = NULL;
1670 server.masterport = 6379;
1671 server.master = NULL;
1672 server.replstate = REDIS_REPL_NONE;
1673
1674 /* Double constants initialization */
1675 R_Zero = 0.0;
1676 R_PosInf = 1.0/R_Zero;
1677 R_NegInf = -1.0/R_Zero;
1678 R_Nan = R_Zero/R_Zero;
1679 }
1680
1681 static void initServer() {
1682 int j;
1683
1684 signal(SIGHUP, SIG_IGN);
1685 signal(SIGPIPE, SIG_IGN);
1686 setupSigSegvAction();
1687
1688 server.devnull = fopen("/dev/null","w");
1689 if (server.devnull == NULL) {
1690 redisLog(REDIS_WARNING, "Can't open /dev/null: %s", server.neterr);
1691 exit(1);
1692 }
1693 server.clients = listCreate();
1694 server.slaves = listCreate();
1695 server.monitors = listCreate();
1696 server.objfreelist = listCreate();
1697 createSharedObjects();
1698 server.el = aeCreateEventLoop();
1699 server.db = zmalloc(sizeof(redisDb)*server.dbnum);
1700 server.fd = anetTcpServer(server.neterr, server.port, server.bindaddr);
1701 if (server.fd == -1) {
1702 redisLog(REDIS_WARNING, "Opening TCP port: %s", server.neterr);
1703 exit(1);
1704 }
1705 for (j = 0; j < server.dbnum; j++) {
1706 server.db[j].dict = dictCreate(&dbDictType,NULL);
1707 server.db[j].expires = dictCreate(&keyptrDictType,NULL);
1708 server.db[j].blockingkeys = dictCreate(&keylistDictType,NULL);
1709 if (server.vm_enabled)
1710 server.db[j].io_keys = dictCreate(&keylistDictType,NULL);
1711 server.db[j].id = j;
1712 }
1713 server.pubsub_channels = dictCreate(&keylistDictType,NULL);
1714 server.pubsub_patterns = listCreate();
1715 listSetFreeMethod(server.pubsub_patterns,freePubsubPattern);
1716 listSetMatchMethod(server.pubsub_patterns,listMatchPubsubPattern);
1717 server.cronloops = 0;
1718 server.bgsavechildpid = -1;
1719 server.bgrewritechildpid = -1;
1720 server.bgrewritebuf = sdsempty();
1721 server.aofbuf = sdsempty();
1722 server.lastsave = time(NULL);
1723 server.dirty = 0;
1724 server.stat_numcommands = 0;
1725 server.stat_numconnections = 0;
1726 server.stat_expiredkeys = 0;
1727 server.stat_starttime = time(NULL);
1728 server.unixtime = time(NULL);
1729 aeCreateTimeEvent(server.el, 1, serverCron, NULL, NULL);
1730 if (aeCreateFileEvent(server.el, server.fd, AE_READABLE,
1731 acceptHandler, NULL) == AE_ERR) oom("creating file event");
1732
1733 if (server.appendonly) {
1734 server.appendfd = open(server.appendfilename,O_WRONLY|O_APPEND|O_CREAT,0644);
1735 if (server.appendfd == -1) {
1736 redisLog(REDIS_WARNING, "Can't open the append-only file: %s",
1737 strerror(errno));
1738 exit(1);
1739 }
1740 }
1741
1742 if (server.vm_enabled) vmInit();
1743 }
1744
1745 /* Empty the whole database */
1746 static long long emptyDb() {
1747 int j;
1748 long long removed = 0;
1749
1750 for (j = 0; j < server.dbnum; j++) {
1751 removed += dictSize(server.db[j].dict);
1752 dictEmpty(server.db[j].dict);
1753 dictEmpty(server.db[j].expires);
1754 }
1755 return removed;
1756 }
1757
1758 static int yesnotoi(char *s) {
1759 if (!strcasecmp(s,"yes")) return 1;
1760 else if (!strcasecmp(s,"no")) return 0;
1761 else return -1;
1762 }
1763
1764 /* I agree, this is a very rudimental way to load a configuration...
1765 will improve later if the config gets more complex */
1766 static void loadServerConfig(char *filename) {
1767 FILE *fp;
1768 char buf[REDIS_CONFIGLINE_MAX+1], *err = NULL;
1769 int linenum = 0;
1770 sds line = NULL;
1771
1772 if (filename[0] == '-' && filename[1] == '\0')
1773 fp = stdin;
1774 else {
1775 if ((fp = fopen(filename,"r")) == NULL) {
1776 redisLog(REDIS_WARNING, "Fatal error, can't open config file '%s'", filename);
1777 exit(1);
1778 }
1779 }
1780
1781 while(fgets(buf,REDIS_CONFIGLINE_MAX+1,fp) != NULL) {
1782 sds *argv;
1783 int argc, j;
1784
1785 linenum++;
1786 line = sdsnew(buf);
1787 line = sdstrim(line," \t\r\n");
1788
1789 /* Skip comments and blank lines*/
1790 if (line[0] == '#' || line[0] == '\0') {
1791 sdsfree(line);
1792 continue;
1793 }
1794
1795 /* Split into arguments */
1796 argv = sdssplitlen(line,sdslen(line)," ",1,&argc);
1797 sdstolower(argv[0]);
1798
1799 /* Execute config directives */
1800 if (!strcasecmp(argv[0],"timeout") && argc == 2) {
1801 server.maxidletime = atoi(argv[1]);
1802 if (server.maxidletime < 0) {
1803 err = "Invalid timeout value"; goto loaderr;
1804 }
1805 } else if (!strcasecmp(argv[0],"port") && argc == 2) {
1806 server.port = atoi(argv[1]);
1807 if (server.port < 1 || server.port > 65535) {
1808 err = "Invalid port"; goto loaderr;
1809 }
1810 } else if (!strcasecmp(argv[0],"bind") && argc == 2) {
1811 server.bindaddr = zstrdup(argv[1]);
1812 } else if (!strcasecmp(argv[0],"save") && argc == 3) {
1813 int seconds = atoi(argv[1]);
1814 int changes = atoi(argv[2]);
1815 if (seconds < 1 || changes < 0) {
1816 err = "Invalid save parameters"; goto loaderr;
1817 }
1818 appendServerSaveParams(seconds,changes);
1819 } else if (!strcasecmp(argv[0],"dir") && argc == 2) {
1820 if (chdir(argv[1]) == -1) {
1821 redisLog(REDIS_WARNING,"Can't chdir to '%s': %s",
1822 argv[1], strerror(errno));
1823 exit(1);
1824 }
1825 } else if (!strcasecmp(argv[0],"loglevel") && argc == 2) {
1826 if (!strcasecmp(argv[1],"debug")) server.verbosity = REDIS_DEBUG;
1827 else if (!strcasecmp(argv[1],"verbose")) server.verbosity = REDIS_VERBOSE;
1828 else if (!strcasecmp(argv[1],"notice")) server.verbosity = REDIS_NOTICE;
1829 else if (!strcasecmp(argv[1],"warning")) server.verbosity = REDIS_WARNING;
1830 else {
1831 err = "Invalid log level. Must be one of debug, notice, warning";
1832 goto loaderr;
1833 }
1834 } else if (!strcasecmp(argv[0],"logfile") && argc == 2) {
1835 FILE *logfp;
1836
1837 server.logfile = zstrdup(argv[1]);
1838 if (!strcasecmp(server.logfile,"stdout")) {
1839 zfree(server.logfile);
1840 server.logfile = NULL;
1841 }
1842 if (server.logfile) {
1843 /* Test if we are able to open the file. The server will not
1844 * be able to abort just for this problem later... */
1845 logfp = fopen(server.logfile,"a");
1846 if (logfp == NULL) {
1847 err = sdscatprintf(sdsempty(),
1848 "Can't open the log file: %s", strerror(errno));
1849 goto loaderr;
1850 }
1851 fclose(logfp);
1852 }
1853 } else if (!strcasecmp(argv[0],"databases") && argc == 2) {
1854 server.dbnum = atoi(argv[1]);
1855 if (server.dbnum < 1) {
1856 err = "Invalid number of databases"; goto loaderr;
1857 }
1858 } else if (!strcasecmp(argv[0],"include") && argc == 2) {
1859 loadServerConfig(argv[1]);
1860 } else if (!strcasecmp(argv[0],"maxclients") && argc == 2) {
1861 server.maxclients = atoi(argv[1]);
1862 } else if (!strcasecmp(argv[0],"maxmemory") && argc == 2) {
1863 server.maxmemory = memtoll(argv[1],NULL);
1864 } else if (!strcasecmp(argv[0],"slaveof") && argc == 3) {
1865 server.masterhost = sdsnew(argv[1]);
1866 server.masterport = atoi(argv[2]);
1867 server.replstate = REDIS_REPL_CONNECT;
1868 } else if (!strcasecmp(argv[0],"masterauth") && argc == 2) {
1869 server.masterauth = zstrdup(argv[1]);
1870 } else if (!strcasecmp(argv[0],"glueoutputbuf") && argc == 2) {
1871 if ((server.glueoutputbuf = yesnotoi(argv[1])) == -1) {
1872 err = "argument must be 'yes' or 'no'"; goto loaderr;
1873 }
1874 } else if (!strcasecmp(argv[0],"rdbcompression") && argc == 2) {
1875 if ((server.rdbcompression = yesnotoi(argv[1])) == -1) {
1876 err = "argument must be 'yes' or 'no'"; goto loaderr;
1877 }
1878 } else if (!strcasecmp(argv[0],"activerehashing") && argc == 2) {
1879 if ((server.activerehashing = yesnotoi(argv[1])) == -1) {
1880 err = "argument must be 'yes' or 'no'"; goto loaderr;
1881 }
1882 } else if (!strcasecmp(argv[0],"daemonize") && argc == 2) {
1883 if ((server.daemonize = yesnotoi(argv[1])) == -1) {
1884 err = "argument must be 'yes' or 'no'"; goto loaderr;
1885 }
1886 } else if (!strcasecmp(argv[0],"appendonly") && argc == 2) {
1887 if ((server.appendonly = yesnotoi(argv[1])) == -1) {
1888 err = "argument must be 'yes' or 'no'"; goto loaderr;
1889 }
1890 } else if (!strcasecmp(argv[0],"appendfsync") && argc == 2) {
1891 if (!strcasecmp(argv[1],"no")) {
1892 server.appendfsync = APPENDFSYNC_NO;
1893 } else if (!strcasecmp(argv[1],"always")) {
1894 server.appendfsync = APPENDFSYNC_ALWAYS;
1895 } else if (!strcasecmp(argv[1],"everysec")) {
1896 server.appendfsync = APPENDFSYNC_EVERYSEC;
1897 } else {
1898 err = "argument must be 'no', 'always' or 'everysec'";
1899 goto loaderr;
1900 }
1901 } else if (!strcasecmp(argv[0],"requirepass") && argc == 2) {
1902 server.requirepass = zstrdup(argv[1]);
1903 } else if (!strcasecmp(argv[0],"pidfile") && argc == 2) {
1904 zfree(server.pidfile);
1905 server.pidfile = zstrdup(argv[1]);
1906 } else if (!strcasecmp(argv[0],"dbfilename") && argc == 2) {
1907 zfree(server.dbfilename);
1908 server.dbfilename = zstrdup(argv[1]);
1909 } else if (!strcasecmp(argv[0],"vm-enabled") && argc == 2) {
1910 if ((server.vm_enabled = yesnotoi(argv[1])) == -1) {
1911 err = "argument must be 'yes' or 'no'"; goto loaderr;
1912 }
1913 } else if (!strcasecmp(argv[0],"vm-swap-file") && argc == 2) {
1914 zfree(server.vm_swap_file);
1915 server.vm_swap_file = zstrdup(argv[1]);
1916 } else if (!strcasecmp(argv[0],"vm-max-memory") && argc == 2) {
1917 server.vm_max_memory = memtoll(argv[1],NULL);
1918 } else if (!strcasecmp(argv[0],"vm-page-size") && argc == 2) {
1919 server.vm_page_size = memtoll(argv[1], NULL);
1920 } else if (!strcasecmp(argv[0],"vm-pages") && argc == 2) {
1921 server.vm_pages = memtoll(argv[1], NULL);
1922 } else if (!strcasecmp(argv[0],"vm-max-threads") && argc == 2) {
1923 server.vm_max_threads = strtoll(argv[1], NULL, 10);
1924 } else if (!strcasecmp(argv[0],"hash-max-zipmap-entries") && argc == 2){
1925 server.hash_max_zipmap_entries = memtoll(argv[1], NULL);
1926 } else if (!strcasecmp(argv[0],"hash-max-zipmap-value") && argc == 2){
1927 server.hash_max_zipmap_value = memtoll(argv[1], NULL);
1928 } else {
1929 err = "Bad directive or wrong number of arguments"; goto loaderr;
1930 }
1931 for (j = 0; j < argc; j++)
1932 sdsfree(argv[j]);
1933 zfree(argv);
1934 sdsfree(line);
1935 }
1936 if (fp != stdin) fclose(fp);
1937 return;
1938
1939 loaderr:
1940 fprintf(stderr, "\n*** FATAL CONFIG FILE ERROR ***\n");
1941 fprintf(stderr, "Reading the configuration file, at line %d\n", linenum);
1942 fprintf(stderr, ">>> '%s'\n", line);
1943 fprintf(stderr, "%s\n", err);
1944 exit(1);
1945 }
1946
1947 static void freeClientArgv(redisClient *c) {
1948 int j;
1949
1950 for (j = 0; j < c->argc; j++)
1951 decrRefCount(c->argv[j]);
1952 for (j = 0; j < c->mbargc; j++)
1953 decrRefCount(c->mbargv[j]);
1954 c->argc = 0;
1955 c->mbargc = 0;
1956 }
1957
1958 static void freeClient(redisClient *c) {
1959 listNode *ln;
1960
1961 /* Note that if the client we are freeing is blocked into a blocking
1962 * call, we have to set querybuf to NULL *before* to call
1963 * unblockClientWaitingData() to avoid processInputBuffer() will get
1964 * called. Also it is important to remove the file events after
1965 * this, because this call adds the READABLE event. */
1966 sdsfree(c->querybuf);
1967 c->querybuf = NULL;
1968 if (c->flags & REDIS_BLOCKED)
1969 unblockClientWaitingData(c);
1970
1971 /* Unsubscribe from all the pubsub channels */
1972 pubsubUnsubscribeAllChannels(c,0);
1973 pubsubUnsubscribeAllPatterns(c,0);
1974 dictRelease(c->pubsub_channels);
1975 listRelease(c->pubsub_patterns);
1976 /* Obvious cleanup */
1977 aeDeleteFileEvent(server.el,c->fd,AE_READABLE);
1978 aeDeleteFileEvent(server.el,c->fd,AE_WRITABLE);
1979 listRelease(c->reply);
1980 freeClientArgv(c);
1981 close(c->fd);
1982 /* Remove from the list of clients */
1983 ln = listSearchKey(server.clients,c);
1984 redisAssert(ln != NULL);
1985 listDelNode(server.clients,ln);
1986 /* Remove from the list of clients waiting for swapped keys */
1987 if (c->flags & REDIS_IO_WAIT && listLength(c->io_keys) == 0) {
1988 ln = listSearchKey(server.io_ready_clients,c);
1989 if (ln) {
1990 listDelNode(server.io_ready_clients,ln);
1991 server.vm_blocked_clients--;
1992 }
1993 }
1994 while (server.vm_enabled && listLength(c->io_keys)) {
1995 ln = listFirst(c->io_keys);
1996 dontWaitForSwappedKey(c,ln->value);
1997 }
1998 listRelease(c->io_keys);
1999 /* Master/slave cleanup */
2000 if (c->flags & REDIS_SLAVE) {
2001 if (c->replstate == REDIS_REPL_SEND_BULK && c->repldbfd != -1)
2002 close(c->repldbfd);
2003 list *l = (c->flags & REDIS_MONITOR) ? server.monitors : server.slaves;
2004 ln = listSearchKey(l,c);
2005 redisAssert(ln != NULL);
2006 listDelNode(l,ln);
2007 }
2008 if (c->flags & REDIS_MASTER) {
2009 server.master = NULL;
2010 server.replstate = REDIS_REPL_CONNECT;
2011 }
2012 /* Release memory */
2013 zfree(c->argv);
2014 zfree(c->mbargv);
2015 freeClientMultiState(c);
2016 zfree(c);
2017 }
2018
2019 #define GLUEREPLY_UP_TO (1024)
2020 static void glueReplyBuffersIfNeeded(redisClient *c) {
2021 int copylen = 0;
2022 char buf[GLUEREPLY_UP_TO];
2023 listNode *ln;
2024 listIter li;
2025 robj *o;
2026
2027 listRewind(c->reply,&li);
2028 while((ln = listNext(&li))) {
2029 int objlen;
2030
2031 o = ln->value;
2032 objlen = sdslen(o->ptr);
2033 if (copylen + objlen <= GLUEREPLY_UP_TO) {
2034 memcpy(buf+copylen,o->ptr,objlen);
2035 copylen += objlen;
2036 listDelNode(c->reply,ln);
2037 } else {
2038 if (copylen == 0) return;
2039 break;
2040 }
2041 }
2042 /* Now the output buffer is empty, add the new single element */
2043 o = createObject(REDIS_STRING,sdsnewlen(buf,copylen));
2044 listAddNodeHead(c->reply,o);
2045 }
2046
2047 static void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask) {
2048 redisClient *c = privdata;
2049 int nwritten = 0, totwritten = 0, objlen;
2050 robj *o;
2051 REDIS_NOTUSED(el);
2052 REDIS_NOTUSED(mask);
2053
2054 /* Use writev() if we have enough buffers to send */
2055 if (!server.glueoutputbuf &&
2056 listLength(c->reply) > REDIS_WRITEV_THRESHOLD &&
2057 !(c->flags & REDIS_MASTER))
2058 {
2059 sendReplyToClientWritev(el, fd, privdata, mask);
2060 return;
2061 }
2062
2063 while(listLength(c->reply)) {
2064 if (server.glueoutputbuf && listLength(c->reply) > 1)
2065 glueReplyBuffersIfNeeded(c);
2066
2067 o = listNodeValue(listFirst(c->reply));
2068 objlen = sdslen(o->ptr);
2069
2070 if (objlen == 0) {
2071 listDelNode(c->reply,listFirst(c->reply));
2072 continue;
2073 }
2074
2075 if (c->flags & REDIS_MASTER) {
2076 /* Don't reply to a master */
2077 nwritten = objlen - c->sentlen;
2078 } else {
2079 nwritten = write(fd, ((char*)o->ptr)+c->sentlen, objlen - c->sentlen);
2080 if (nwritten <= 0) break;
2081 }
2082 c->sentlen += nwritten;
2083 totwritten += nwritten;
2084 /* If we fully sent the object on head go to the next one */
2085 if (c->sentlen == objlen) {
2086 listDelNode(c->reply,listFirst(c->reply));
2087 c->sentlen = 0;
2088 }
2089 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
2090 * bytes, in a single threaded server it's a good idea to serve
2091 * other clients as well, even if a very large request comes from
2092 * super fast link that is always able to accept data (in real world
2093 * scenario think about 'KEYS *' against the loopback interfae) */
2094 if (totwritten > REDIS_MAX_WRITE_PER_EVENT) break;
2095 }
2096 if (nwritten == -1) {
2097 if (errno == EAGAIN) {
2098 nwritten = 0;
2099 } else {
2100 redisLog(REDIS_VERBOSE,
2101 "Error writing to client: %s", strerror(errno));
2102 freeClient(c);
2103 return;
2104 }
2105 }
2106 if (totwritten > 0) c->lastinteraction = time(NULL);
2107 if (listLength(c->reply) == 0) {
2108 c->sentlen = 0;
2109 aeDeleteFileEvent(server.el,c->fd,AE_WRITABLE);
2110 }
2111 }
2112
2113 static void sendReplyToClientWritev(aeEventLoop *el, int fd, void *privdata, int mask)
2114 {
2115 redisClient *c = privdata;
2116 int nwritten = 0, totwritten = 0, objlen, willwrite;
2117 robj *o;
2118 struct iovec iov[REDIS_WRITEV_IOVEC_COUNT];
2119 int offset, ion = 0;
2120 REDIS_NOTUSED(el);
2121 REDIS_NOTUSED(mask);
2122
2123 listNode *node;
2124 while (listLength(c->reply)) {
2125 offset = c->sentlen;
2126 ion = 0;
2127 willwrite = 0;
2128
2129 /* fill-in the iov[] array */
2130 for(node = listFirst(c->reply); node; node = listNextNode(node)) {
2131 o = listNodeValue(node);
2132 objlen = sdslen(o->ptr);
2133
2134 if (totwritten + objlen - offset > REDIS_MAX_WRITE_PER_EVENT)
2135 break;
2136
2137 if(ion == REDIS_WRITEV_IOVEC_COUNT)
2138 break; /* no more iovecs */
2139
2140 iov[ion].iov_base = ((char*)o->ptr) + offset;
2141 iov[ion].iov_len = objlen - offset;
2142 willwrite += objlen - offset;
2143 offset = 0; /* just for the first item */
2144 ion++;
2145 }
2146
2147 if(willwrite == 0)
2148 break;
2149
2150 /* write all collected blocks at once */
2151 if((nwritten = writev(fd, iov, ion)) < 0) {
2152 if (errno != EAGAIN) {
2153 redisLog(REDIS_VERBOSE,
2154 "Error writing to client: %s", strerror(errno));
2155 freeClient(c);
2156 return;
2157 }
2158 break;
2159 }
2160
2161 totwritten += nwritten;
2162 offset = c->sentlen;
2163
2164 /* remove written robjs from c->reply */
2165 while (nwritten && listLength(c->reply)) {
2166 o = listNodeValue(listFirst(c->reply));
2167 objlen = sdslen(o->ptr);
2168
2169 if(nwritten >= objlen - offset) {
2170 listDelNode(c->reply, listFirst(c->reply));
2171 nwritten -= objlen - offset;
2172 c->sentlen = 0;
2173 } else {
2174 /* partial write */
2175 c->sentlen += nwritten;
2176 break;
2177 }
2178 offset = 0;
2179 }
2180 }
2181
2182 if (totwritten > 0)
2183 c->lastinteraction = time(NULL);
2184
2185 if (listLength(c->reply) == 0) {
2186 c->sentlen = 0;
2187 aeDeleteFileEvent(server.el,c->fd,AE_WRITABLE);
2188 }
2189 }
2190
2191 static struct redisCommand *lookupCommand(char *name) {
2192 int j = 0;
2193 while(cmdTable[j].name != NULL) {
2194 if (!strcasecmp(name,cmdTable[j].name)) return &cmdTable[j];
2195 j++;
2196 }
2197 return NULL;
2198 }
2199
2200 /* resetClient prepare the client to process the next command */
2201 static void resetClient(redisClient *c) {
2202 freeClientArgv(c);
2203 c->bulklen = -1;
2204 c->multibulk = 0;
2205 }
2206
2207 /* Call() is the core of Redis execution of a command */
2208 static void call(redisClient *c, struct redisCommand *cmd) {
2209 long long dirty;
2210
2211 dirty = server.dirty;
2212 cmd->proc(c);
2213 dirty = server.dirty-dirty;
2214
2215 if (server.appendonly && dirty)
2216 feedAppendOnlyFile(cmd,c->db->id,c->argv,c->argc);
2217 if ((dirty || cmd->flags & REDIS_CMD_FORCE_REPLICATION) &&
2218 listLength(server.slaves))
2219 replicationFeedSlaves(server.slaves,c->db->id,c->argv,c->argc);
2220 if (listLength(server.monitors))
2221 replicationFeedMonitors(server.monitors,c->db->id,c->argv,c->argc);
2222 server.stat_numcommands++;
2223 }
2224
2225 /* If this function gets called we already read a whole
2226 * command, argments are in the client argv/argc fields.
2227 * processCommand() execute the command or prepare the
2228 * server for a bulk read from the client.
2229 *
2230 * If 1 is returned the client is still alive and valid and
2231 * and other operations can be performed by the caller. Otherwise
2232 * if 0 is returned the client was destroied (i.e. after QUIT). */
2233 static int processCommand(redisClient *c) {
2234 struct redisCommand *cmd;
2235
2236 /* Free some memory if needed (maxmemory setting) */
2237 if (server.maxmemory) freeMemoryIfNeeded();
2238
2239 /* Handle the multi bulk command type. This is an alternative protocol
2240 * supported by Redis in order to receive commands that are composed of
2241 * multiple binary-safe "bulk" arguments. The latency of processing is
2242 * a bit higher but this allows things like multi-sets, so if this
2243 * protocol is used only for MSET and similar commands this is a big win. */
2244 if (c->multibulk == 0 && c->argc == 1 && ((char*)(c->argv[0]->ptr))[0] == '*') {
2245 c->multibulk = atoi(((char*)c->argv[0]->ptr)+1);
2246 if (c->multibulk <= 0) {
2247 resetClient(c);
2248 return 1;
2249 } else {
2250 decrRefCount(c->argv[c->argc-1]);
2251 c->argc--;
2252 return 1;
2253 }
2254 } else if (c->multibulk) {
2255 if (c->bulklen == -1) {
2256 if (((char*)c->argv[0]->ptr)[0] != '$') {
2257 addReplySds(c,sdsnew("-ERR multi bulk protocol error\r\n"));
2258 resetClient(c);
2259 return 1;
2260 } else {
2261 int bulklen = atoi(((char*)c->argv[0]->ptr)+1);
2262 decrRefCount(c->argv[0]);
2263 if (bulklen < 0 || bulklen > 1024*1024*1024) {
2264 c->argc--;
2265 addReplySds(c,sdsnew("-ERR invalid bulk write count\r\n"));
2266 resetClient(c);
2267 return 1;
2268 }
2269 c->argc--;
2270 c->bulklen = bulklen+2; /* add two bytes for CR+LF */
2271 return 1;
2272 }
2273 } else {
2274 c->mbargv = zrealloc(c->mbargv,(sizeof(robj*))*(c->mbargc+1));
2275 c->mbargv[c->mbargc] = c->argv[0];
2276 c->mbargc++;
2277 c->argc--;
2278 c->multibulk--;
2279 if (c->multibulk == 0) {
2280 robj **auxargv;
2281 int auxargc;
2282
2283 /* Here we need to swap the multi-bulk argc/argv with the
2284 * normal argc/argv of the client structure. */
2285 auxargv = c->argv;
2286 c->argv = c->mbargv;
2287 c->mbargv = auxargv;
2288
2289 auxargc = c->argc;
2290 c->argc = c->mbargc;
2291 c->mbargc = auxargc;
2292
2293 /* We need to set bulklen to something different than -1
2294 * in order for the code below to process the command without
2295 * to try to read the last argument of a bulk command as
2296 * a special argument. */
2297 c->bulklen = 0;
2298 /* continue below and process the command */
2299 } else {
2300 c->bulklen = -1;
2301 return 1;
2302 }
2303 }
2304 }
2305 /* -- end of multi bulk commands processing -- */
2306
2307 /* The QUIT command is handled as a special case. Normal command
2308 * procs are unable to close the client connection safely */
2309 if (!strcasecmp(c->argv[0]->ptr,"quit")) {
2310 freeClient(c);
2311 return 0;
2312 }
2313
2314 /* Now lookup the command and check ASAP about trivial error conditions
2315 * such wrong arity, bad command name and so forth. */
2316 cmd = lookupCommand(c->argv[0]->ptr);
2317 if (!cmd) {
2318 addReplySds(c,
2319 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2320 (char*)c->argv[0]->ptr));
2321 resetClient(c);
2322 return 1;
2323 } else if ((cmd->arity > 0 && cmd->arity != c->argc) ||
2324 (c->argc < -cmd->arity)) {
2325 addReplySds(c,
2326 sdscatprintf(sdsempty(),
2327 "-ERR wrong number of arguments for '%s' command\r\n",
2328 cmd->name));
2329 resetClient(c);
2330 return 1;
2331 } else if (cmd->flags & REDIS_CMD_BULK && c->bulklen == -1) {
2332 /* This is a bulk command, we have to read the last argument yet. */
2333 int bulklen = atoi(c->argv[c->argc-1]->ptr);
2334
2335 decrRefCount(c->argv[c->argc-1]);
2336 if (bulklen < 0 || bulklen > 1024*1024*1024) {
2337 c->argc--;
2338 addReplySds(c,sdsnew("-ERR invalid bulk write count\r\n"));
2339 resetClient(c);
2340 return 1;
2341 }
2342 c->argc--;
2343 c->bulklen = bulklen+2; /* add two bytes for CR+LF */
2344 /* It is possible that the bulk read is already in the
2345 * buffer. Check this condition and handle it accordingly.
2346 * This is just a fast path, alternative to call processInputBuffer().
2347 * It's a good idea since the code is small and this condition
2348 * happens most of the times. */
2349 if ((signed)sdslen(c->querybuf) >= c->bulklen) {
2350 c->argv[c->argc] = createStringObject(c->querybuf,c->bulklen-2);
2351 c->argc++;
2352 c->querybuf = sdsrange(c->querybuf,c->bulklen,-1);
2353 } else {
2354 /* Otherwise return... there is to read the last argument
2355 * from the socket. */
2356 return 1;
2357 }
2358 }
2359 /* Let's try to encode the bulk object to save space. */
2360 if (cmd->flags & REDIS_CMD_BULK)
2361 c->argv[c->argc-1] = tryObjectEncoding(c->argv[c->argc-1]);
2362
2363 /* Check if the user is authenticated */
2364 if (server.requirepass && !c->authenticated && cmd->proc != authCommand) {
2365 addReplySds(c,sdsnew("-ERR operation not permitted\r\n"));
2366 resetClient(c);
2367 return 1;
2368 }
2369
2370 /* Handle the maxmemory directive */
2371 if (server.maxmemory && (cmd->flags & REDIS_CMD_DENYOOM) &&
2372 zmalloc_used_memory() > server.maxmemory)
2373 {
2374 addReplySds(c,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2375 resetClient(c);
2376 return 1;
2377 }
2378
2379 /* Only allow SUBSCRIBE and UNSUBSCRIBE in the context of Pub/Sub */
2380 if ((dictSize(c->pubsub_channels) > 0 || listLength(c->pubsub_patterns) > 0)
2381 &&
2382 cmd->proc != subscribeCommand && cmd->proc != unsubscribeCommand &&
2383 cmd->proc != psubscribeCommand && cmd->proc != punsubscribeCommand) {
2384 addReplySds(c,sdsnew("-ERR only (P)SUBSCRIBE / (P)UNSUBSCRIBE / QUIT allowed in this context\r\n"));
2385 resetClient(c);
2386 return 1;
2387 }
2388
2389 /* Exec the command */
2390 if (c->flags & REDIS_MULTI && cmd->proc != execCommand && cmd->proc != discardCommand) {
2391 queueMultiCommand(c,cmd);
2392 addReply(c,shared.queued);
2393 } else {
2394 if (server.vm_enabled && server.vm_max_threads > 0 &&
2395 blockClientOnSwappedKeys(cmd,c)) return 1;
2396 call(c,cmd);
2397 }
2398
2399 /* Prepare the client for the next command */
2400 resetClient(c);
2401 return 1;
2402 }
2403
2404 static void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc) {
2405 listNode *ln;
2406 listIter li;
2407 int outc = 0, j;
2408 robj **outv;
2409 /* We need 1+(ARGS*3) objects since commands are using the new protocol
2410 * and we one 1 object for the first "*<count>\r\n" multibulk count, then
2411 * for every additional object we have "$<count>\r\n" + object + "\r\n". */
2412 robj *static_outv[REDIS_STATIC_ARGS*3+1];
2413 robj *lenobj;
2414
2415 if (argc <= REDIS_STATIC_ARGS) {
2416 outv = static_outv;
2417 } else {
2418 outv = zmalloc(sizeof(robj*)*(argc*3+1));
2419 }
2420
2421 lenobj = createObject(REDIS_STRING,
2422 sdscatprintf(sdsempty(), "*%d\r\n", argc));
2423 lenobj->refcount = 0;
2424 outv[outc++] = lenobj;
2425 for (j = 0; j < argc; j++) {
2426 lenobj = createObject(REDIS_STRING,
2427 sdscatprintf(sdsempty(),"$%lu\r\n",
2428 (unsigned long) stringObjectLen(argv[j])));
2429 lenobj->refcount = 0;
2430 outv[outc++] = lenobj;
2431 outv[outc++] = argv[j];
2432 outv[outc++] = shared.crlf;
2433 }
2434
2435 /* Increment all the refcounts at start and decrement at end in order to
2436 * be sure to free objects if there is no slave in a replication state
2437 * able to be feed with commands */
2438 for (j = 0; j < outc; j++) incrRefCount(outv[j]);
2439 listRewind(slaves,&li);
2440 while((ln = listNext(&li))) {
2441 redisClient *slave = ln->value;
2442
2443 /* Don't feed slaves that are still waiting for BGSAVE to start */
2444 if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_START) continue;
2445
2446 /* Feed all the other slaves, MONITORs and so on */
2447 if (slave->slaveseldb != dictid) {
2448 robj *selectcmd;
2449
2450 switch(dictid) {
2451 case 0: selectcmd = shared.select0; break;
2452 case 1: selectcmd = shared.select1; break;
2453 case 2: selectcmd = shared.select2; break;
2454 case 3: selectcmd = shared.select3; break;
2455 case 4: selectcmd = shared.select4; break;
2456 case 5: selectcmd = shared.select5; break;
2457 case 6: selectcmd = shared.select6; break;
2458 case 7: selectcmd = shared.select7; break;
2459 case 8: selectcmd = shared.select8; break;
2460 case 9: selectcmd = shared.select9; break;
2461 default:
2462 selectcmd = createObject(REDIS_STRING,
2463 sdscatprintf(sdsempty(),"select %d\r\n",dictid));
2464 selectcmd->refcount = 0;
2465 break;
2466 }
2467 addReply(slave,selectcmd);
2468 slave->slaveseldb = dictid;
2469 }
2470 for (j = 0; j < outc; j++) addReply(slave,outv[j]);
2471 }
2472 for (j = 0; j < outc; j++) decrRefCount(outv[j]);
2473 if (outv != static_outv) zfree(outv);
2474 }
2475
2476 static sds sdscatrepr(sds s, char *p, size_t len) {
2477 s = sdscatlen(s,"\"",1);
2478 while(len--) {
2479 switch(*p) {
2480 case '\\':
2481 case '"':
2482 s = sdscatprintf(s,"\\%c",*p);
2483 break;
2484 case '\n': s = sdscatlen(s,"\\n",1); break;
2485 case '\r': s = sdscatlen(s,"\\r",1); break;
2486 case '\t': s = sdscatlen(s,"\\t",1); break;
2487 case '\a': s = sdscatlen(s,"\\a",1); break;
2488 case '\b': s = sdscatlen(s,"\\b",1); break;
2489 default:
2490 if (isprint(*p))
2491 s = sdscatprintf(s,"%c",*p);
2492 else
2493 s = sdscatprintf(s,"\\x%02x",(unsigned char)*p);
2494 break;
2495 }
2496 p++;
2497 }
2498 return sdscatlen(s,"\"",1);
2499 }
2500
2501 static void replicationFeedMonitors(list *monitors, int dictid, robj **argv, int argc) {
2502 listNode *ln;
2503 listIter li;
2504 int j;
2505 sds cmdrepr = sdsnew("+");
2506 robj *cmdobj;
2507 struct timeval tv;
2508
2509 gettimeofday(&tv,NULL);
2510 cmdrepr = sdscatprintf(cmdrepr,"%ld.%ld ",(long)tv.tv_sec,(long)tv.tv_usec);
2511 if (dictid != 0) cmdrepr = sdscatprintf(cmdrepr,"(db %d) ", dictid);
2512
2513 for (j = 0; j < argc; j++) {
2514 if (argv[j]->encoding == REDIS_ENCODING_INT) {
2515 cmdrepr = sdscatprintf(cmdrepr, "%ld", (long)argv[j]->ptr);
2516 } else {
2517 cmdrepr = sdscatrepr(cmdrepr,(char*)argv[j]->ptr,
2518 sdslen(argv[j]->ptr));
2519 }
2520 if (j != argc-1)
2521 cmdrepr = sdscatlen(cmdrepr," ",1);
2522 }
2523 cmdrepr = sdscatlen(cmdrepr,"\r\n",2);
2524 cmdobj = createObject(REDIS_STRING,cmdrepr);
2525
2526 listRewind(monitors,&li);
2527 while((ln = listNext(&li))) {
2528 redisClient *monitor = ln->value;
2529 addReply(monitor,cmdobj);
2530 }
2531 decrRefCount(cmdobj);
2532 }
2533
2534 static void processInputBuffer(redisClient *c) {
2535 again:
2536 /* Before to process the input buffer, make sure the client is not
2537 * waitig for a blocking operation such as BLPOP. Note that the first
2538 * iteration the client is never blocked, otherwise the processInputBuffer
2539 * would not be called at all, but after the execution of the first commands
2540 * in the input buffer the client may be blocked, and the "goto again"
2541 * will try to reiterate. The following line will make it return asap. */
2542 if (c->flags & REDIS_BLOCKED || c->flags & REDIS_IO_WAIT) return;
2543 if (c->bulklen == -1) {
2544 /* Read the first line of the query */
2545 char *p = strchr(c->querybuf,'\n');
2546 size_t querylen;
2547
2548 if (p) {
2549 sds query, *argv;
2550 int argc, j;
2551
2552 query = c->querybuf;
2553 c->querybuf = sdsempty();
2554 querylen = 1+(p-(query));
2555 if (sdslen(query) > querylen) {
2556 /* leave data after the first line of the query in the buffer */
2557 c->querybuf = sdscatlen(c->querybuf,query+querylen,sdslen(query)-querylen);
2558 }
2559 *p = '\0'; /* remove "\n" */
2560 if (*(p-1) == '\r') *(p-1) = '\0'; /* and "\r" if any */
2561 sdsupdatelen(query);
2562
2563 /* Now we can split the query in arguments */
2564 argv = sdssplitlen(query,sdslen(query)," ",1,&argc);
2565 sdsfree(query);
2566
2567 if (c->argv) zfree(c->argv);
2568 c->argv = zmalloc(sizeof(robj*)*argc);
2569
2570 for (j = 0; j < argc; j++) {
2571 if (sdslen(argv[j])) {
2572 c->argv[c->argc] = createObject(REDIS_STRING,argv[j]);
2573 c->argc++;
2574 } else {
2575 sdsfree(argv[j]);
2576 }
2577 }
2578 zfree(argv);
2579 if (c->argc) {
2580 /* Execute the command. If the client is still valid
2581 * after processCommand() return and there is something
2582 * on the query buffer try to process the next command. */
2583 if (processCommand(c) && sdslen(c->querybuf)) goto again;
2584 } else {
2585 /* Nothing to process, argc == 0. Just process the query
2586 * buffer if it's not empty or return to the caller */
2587 if (sdslen(c->querybuf)) goto again;
2588 }
2589 return;
2590 } else if (sdslen(c->querybuf) >= REDIS_REQUEST_MAX_SIZE) {
2591 redisLog(REDIS_VERBOSE, "Client protocol error");
2592 freeClient(c);
2593 return;
2594 }
2595 } else {
2596 /* Bulk read handling. Note that if we are at this point
2597 the client already sent a command terminated with a newline,
2598 we are reading the bulk data that is actually the last
2599 argument of the command. */
2600 int qbl = sdslen(c->querybuf);
2601
2602 if (c->bulklen <= qbl) {
2603 /* Copy everything but the final CRLF as final argument */
2604 c->argv[c->argc] = createStringObject(c->querybuf,c->bulklen-2);
2605 c->argc++;
2606 c->querybuf = sdsrange(c->querybuf,c->bulklen,-1);
2607 /* Process the command. If the client is still valid after
2608 * the processing and there is more data in the buffer
2609 * try to parse it. */
2610 if (processCommand(c) && sdslen(c->querybuf)) goto again;
2611 return;
2612 }
2613 }
2614 }
2615
2616 static void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask) {
2617 redisClient *c = (redisClient*) privdata;
2618 char buf[REDIS_IOBUF_LEN];
2619 int nread;
2620 REDIS_NOTUSED(el);
2621 REDIS_NOTUSED(mask);
2622
2623 nread = read(fd, buf, REDIS_IOBUF_LEN);
2624 if (nread == -1) {
2625 if (errno == EAGAIN) {
2626 nread = 0;
2627 } else {
2628 redisLog(REDIS_VERBOSE, "Reading from client: %s",strerror(errno));
2629 freeClient(c);
2630 return;
2631 }
2632 } else if (nread == 0) {
2633 redisLog(REDIS_VERBOSE, "Client closed connection");
2634 freeClient(c);
2635 return;
2636 }
2637 if (nread) {
2638 c->querybuf = sdscatlen(c->querybuf, buf, nread);
2639 c->lastinteraction = time(NULL);
2640 } else {
2641 return;
2642 }
2643 processInputBuffer(c);
2644 }
2645
2646 static int selectDb(redisClient *c, int id) {
2647 if (id < 0 || id >= server.dbnum)
2648 return REDIS_ERR;
2649 c->db = &server.db[id];
2650 return REDIS_OK;
2651 }
2652
2653 static void *dupClientReplyValue(void *o) {
2654 incrRefCount((robj*)o);
2655 return o;
2656 }
2657
2658 static int listMatchObjects(void *a, void *b) {
2659 return compareStringObjects(a,b) == 0;
2660 }
2661
2662 static redisClient *createClient(int fd) {
2663 redisClient *c = zmalloc(sizeof(*c));
2664
2665 anetNonBlock(NULL,fd);
2666 anetTcpNoDelay(NULL,fd);
2667 if (!c) return NULL;
2668 selectDb(c,0);
2669 c->fd = fd;
2670 c->querybuf = sdsempty();
2671 c->argc = 0;
2672 c->argv = NULL;
2673 c->bulklen = -1;
2674 c->multibulk = 0;
2675 c->mbargc = 0;
2676 c->mbargv = NULL;
2677 c->sentlen = 0;
2678 c->flags = 0;
2679 c->lastinteraction = time(NULL);
2680 c->authenticated = 0;
2681 c->replstate = REDIS_REPL_NONE;
2682 c->reply = listCreate();
2683 listSetFreeMethod(c->reply,decrRefCount);
2684 listSetDupMethod(c->reply,dupClientReplyValue);
2685 c->blockingkeys = NULL;
2686 c->blockingkeysnum = 0;
2687 c->io_keys = listCreate();
2688 listSetFreeMethod(c->io_keys,decrRefCount);
2689 c->pubsub_channels = dictCreate(&setDictType,NULL);
2690 c->pubsub_patterns = listCreate();
2691 listSetFreeMethod(c->pubsub_patterns,decrRefCount);
2692 listSetMatchMethod(c->pubsub_patterns,listMatchObjects);
2693 if (aeCreateFileEvent(server.el, c->fd, AE_READABLE,
2694 readQueryFromClient, c) == AE_ERR) {
2695 freeClient(c);
2696 return NULL;
2697 }
2698 listAddNodeTail(server.clients,c);
2699 initClientMultiState(c);
2700 return c;
2701 }
2702
2703 static void addReply(redisClient *c, robj *obj) {
2704 if (listLength(c->reply) == 0 &&
2705 (c->replstate == REDIS_REPL_NONE ||
2706 c->replstate == REDIS_REPL_ONLINE) &&
2707 aeCreateFileEvent(server.el, c->fd, AE_WRITABLE,
2708 sendReplyToClient, c) == AE_ERR) return;
2709
2710 if (server.vm_enabled && obj->storage != REDIS_VM_MEMORY) {
2711 obj = dupStringObject(obj);
2712 obj->refcount = 0; /* getDecodedObject() will increment the refcount */
2713 }
2714 listAddNodeTail(c->reply,getDecodedObject(obj));
2715 }
2716
2717 static void addReplySds(redisClient *c, sds s) {
2718 robj *o = createObject(REDIS_STRING,s);
2719 addReply(c,o);
2720 decrRefCount(o);
2721 }
2722
2723 static void addReplyDouble(redisClient *c, double d) {
2724 char buf[128];
2725
2726 snprintf(buf,sizeof(buf),"%.17g",d);
2727 addReplySds(c,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2728 (unsigned long) strlen(buf),buf));
2729 }
2730
2731 static void addReplyLong(redisClient *c, long l) {
2732 char buf[128];
2733 size_t len;
2734
2735 if (l == 0) {
2736 addReply(c,shared.czero);
2737 return;
2738 } else if (l == 1) {
2739 addReply(c,shared.cone);
2740 return;
2741 }
2742 len = snprintf(buf,sizeof(buf),":%ld\r\n",l);
2743 addReplySds(c,sdsnewlen(buf,len));
2744 }
2745
2746 static void addReplyLongLong(redisClient *c, long long ll) {
2747 char buf[128];
2748 size_t len;
2749
2750 if (ll == 0) {
2751 addReply(c,shared.czero);
2752 return;
2753 } else if (ll == 1) {
2754 addReply(c,shared.cone);
2755 return;
2756 }
2757 len = snprintf(buf,sizeof(buf),":%lld\r\n",ll);
2758 addReplySds(c,sdsnewlen(buf,len));
2759 }
2760
2761 static void addReplyUlong(redisClient *c, unsigned long ul) {
2762 char buf[128];
2763 size_t len;
2764
2765 if (ul == 0) {
2766 addReply(c,shared.czero);
2767 return;
2768 } else if (ul == 1) {
2769 addReply(c,shared.cone);
2770 return;
2771 }
2772 len = snprintf(buf,sizeof(buf),":%lu\r\n",ul);
2773 addReplySds(c,sdsnewlen(buf,len));
2774 }
2775
2776 static void addReplyBulkLen(redisClient *c, robj *obj) {
2777 size_t len;
2778
2779 if (obj->encoding == REDIS_ENCODING_RAW) {
2780 len = sdslen(obj->ptr);
2781 } else {
2782 long n = (long)obj->ptr;
2783
2784 /* Compute how many bytes will take this integer as a radix 10 string */
2785 len = 1;
2786 if (n < 0) {
2787 len++;
2788 n = -n;
2789 }
2790 while((n = n/10) != 0) {
2791 len++;
2792 }
2793 }
2794 addReplySds(c,sdscatprintf(sdsempty(),"$%lu\r\n",(unsigned long)len));
2795 }
2796
2797 static void addReplyBulk(redisClient *c, robj *obj) {
2798 addReplyBulkLen(c,obj);
2799 addReply(c,obj);
2800 addReply(c,shared.crlf);
2801 }
2802
2803 /* In the CONFIG command we need to add vanilla C string as bulk replies */
2804 static void addReplyBulkCString(redisClient *c, char *s) {
2805 if (s == NULL) {
2806 addReply(c,shared.nullbulk);
2807 } else {
2808 robj *o = createStringObject(s,strlen(s));
2809 addReplyBulk(c,o);
2810 decrRefCount(o);
2811 }
2812 }
2813
2814 static void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask) {
2815 int cport, cfd;
2816 char cip[128];
2817 redisClient *c;
2818 REDIS_NOTUSED(el);
2819 REDIS_NOTUSED(mask);
2820 REDIS_NOTUSED(privdata);
2821
2822 cfd = anetAccept(server.neterr, fd, cip, &cport);
2823 if (cfd == AE_ERR) {
2824 redisLog(REDIS_VERBOSE,"Accepting client connection: %s", server.neterr);
2825 return;
2826 }
2827 redisLog(REDIS_VERBOSE,"Accepted %s:%d", cip, cport);
2828 if ((c = createClient(cfd)) == NULL) {
2829 redisLog(REDIS_WARNING,"Error allocating resoures for the client");
2830 close(cfd); /* May be already closed, just ingore errors */
2831 return;
2832 }
2833 /* If maxclient directive is set and this is one client more... close the
2834 * connection. Note that we create the client instead to check before
2835 * for this condition, since now the socket is already set in nonblocking
2836 * mode and we can send an error for free using the Kernel I/O */
2837 if (server.maxclients && listLength(server.clients) > server.maxclients) {
2838 char *err = "-ERR max number of clients reached\r\n";
2839
2840 /* That's a best effort error message, don't check write errors */
2841 if (write(c->fd,err,strlen(err)) == -1) {
2842 /* Nothing to do, Just to avoid the warning... */
2843 }
2844 freeClient(c);
2845 return;
2846 }
2847 server.stat_numconnections++;
2848 }
2849
2850 /* ======================= Redis objects implementation ===================== */
2851
2852 static robj *createObject(int type, void *ptr) {
2853 robj *o;
2854
2855 if (server.vm_enabled) pthread_mutex_lock(&server.obj_freelist_mutex);
2856 if (listLength(server.objfreelist)) {
2857 listNode *head = listFirst(server.objfreelist);
2858 o = listNodeValue(head);
2859 listDelNode(server.objfreelist,head);
2860 if (server.vm_enabled) pthread_mutex_unlock(&server.obj_freelist_mutex);
2861 } else {
2862 if (server.vm_enabled) {
2863 pthread_mutex_unlock(&server.obj_freelist_mutex);
2864 o = zmalloc(sizeof(*o));
2865 } else {
2866 o = zmalloc(sizeof(*o)-sizeof(struct redisObjectVM));
2867 }
2868 }
2869 o->type = type;
2870 o->encoding = REDIS_ENCODING_RAW;
2871 o->ptr = ptr;
2872 o->refcount = 1;
2873 if (server.vm_enabled) {
2874 /* Note that this code may run in the context of an I/O thread
2875 * and accessing to server.unixtime in theory is an error
2876 * (no locks). But in practice this is safe, and even if we read
2877 * garbage Redis will not fail, as it's just a statistical info */
2878 o->vm.atime = server.unixtime;
2879 o->storage = REDIS_VM_MEMORY;
2880 }
2881 return o;
2882 }
2883
2884 static robj *createStringObject(char *ptr, size_t len) {
2885 return createObject(REDIS_STRING,sdsnewlen(ptr,len));
2886 }
2887
2888 static robj *createStringObjectFromLongLong(long long value) {
2889 robj *o;
2890 if (value >= 0 && value < REDIS_SHARED_INTEGERS) {
2891 incrRefCount(shared.integers[value]);
2892 o = shared.integers[value];
2893 } else {
2894 o = createObject(REDIS_STRING, NULL);
2895 if (value >= LONG_MIN && value <= LONG_MAX) {
2896 o->encoding = REDIS_ENCODING_INT;
2897 o->ptr = (void*)((long)value);
2898 } else {
2899 o->ptr = sdscatprintf(sdsempty(),"%lld",value);
2900 }
2901 }
2902 return o;
2903 }
2904
2905 static robj *dupStringObject(robj *o) {
2906 assert(o->encoding == REDIS_ENCODING_RAW);
2907 return createStringObject(o->ptr,sdslen(o->ptr));
2908 }
2909
2910 static robj *createListObject(void) {
2911 list *l = listCreate();
2912
2913 listSetFreeMethod(l,decrRefCount);
2914 return createObject(REDIS_LIST,l);
2915 }
2916
2917 static robj *createSetObject(void) {
2918 dict *d = dictCreate(&setDictType,NULL);
2919 return createObject(REDIS_SET,d);
2920 }
2921
2922 static robj *createHashObject(void) {
2923 /* All the Hashes start as zipmaps. Will be automatically converted
2924 * into hash tables if there are enough elements or big elements
2925 * inside. */
2926 unsigned char *zm = zipmapNew();
2927 robj *o = createObject(REDIS_HASH,zm);
2928 o->encoding = REDIS_ENCODING_ZIPMAP;
2929 return o;
2930 }
2931
2932 static robj *createZsetObject(void) {
2933 zset *zs = zmalloc(sizeof(*zs));
2934
2935 zs->dict = dictCreate(&zsetDictType,NULL);
2936 zs->zsl = zslCreate();
2937 return createObject(REDIS_ZSET,zs);
2938 }
2939
2940 static void freeStringObject(robj *o) {
2941 if (o->encoding == REDIS_ENCODING_RAW) {
2942 sdsfree(o->ptr);
2943 }
2944 }
2945
2946 static void freeListObject(robj *o) {
2947 listRelease((list*) o->ptr);
2948 }
2949
2950 static void freeSetObject(robj *o) {
2951 dictRelease((dict*) o->ptr);
2952 }
2953
2954 static void freeZsetObject(robj *o) {
2955 zset *zs = o->ptr;
2956
2957 dictRelease(zs->dict);
2958 zslFree(zs->zsl);
2959 zfree(zs);
2960 }
2961
2962 static void freeHashObject(robj *o) {
2963 switch (o->encoding) {
2964 case REDIS_ENCODING_HT:
2965 dictRelease((dict*) o->ptr);
2966 break;
2967 case REDIS_ENCODING_ZIPMAP:
2968 zfree(o->ptr);
2969 break;
2970 default:
2971 redisPanic("Unknown hash encoding type");
2972 break;
2973 }
2974 }
2975
2976 static void incrRefCount(robj *o) {
2977 o->refcount++;
2978 }
2979
2980 static void decrRefCount(void *obj) {
2981 robj *o = obj;
2982
2983 if (o->refcount <= 0) redisPanic("decrRefCount against refcount <= 0");
2984 /* Object is a key of a swapped out value, or in the process of being
2985 * loaded. */
2986 if (server.vm_enabled &&
2987 (o->storage == REDIS_VM_SWAPPED || o->storage == REDIS_VM_LOADING))
2988 {
2989 if (o->storage == REDIS_VM_LOADING) vmCancelThreadedIOJob(obj);
2990 redisAssert(o->type == REDIS_STRING);
2991 freeStringObject(o);
2992 vmMarkPagesFree(o->vm.page,o->vm.usedpages);
2993 pthread_mutex_lock(&server.obj_freelist_mutex);
2994 if (listLength(server.objfreelist) > REDIS_OBJFREELIST_MAX ||
2995 !listAddNodeHead(server.objfreelist,o))
2996 zfree(o);
2997 pthread_mutex_unlock(&server.obj_freelist_mutex);
2998 server.vm_stats_swapped_objects--;
2999 return;
3000 }
3001 /* Object is in memory, or in the process of being swapped out. */
3002 if (--(o->refcount) == 0) {
3003 if (server.vm_enabled && o->storage == REDIS_VM_SWAPPING)
3004 vmCancelThreadedIOJob(obj);
3005 switch(o->type) {
3006 case REDIS_STRING: freeStringObject(o); break;
3007 case REDIS_LIST: freeListObject(o); break;
3008 case REDIS_SET: freeSetObject(o); break;
3009 case REDIS_ZSET: freeZsetObject(o); break;
3010 case REDIS_HASH: freeHashObject(o); break;
3011 default: redisPanic("Unknown object type"); break;
3012 }
3013 if (server.vm_enabled) pthread_mutex_lock(&server.obj_freelist_mutex);
3014 if (listLength(server.objfreelist) > REDIS_OBJFREELIST_MAX ||
3015 !listAddNodeHead(server.objfreelist,o))
3016 zfree(o);
3017 if (server.vm_enabled) pthread_mutex_unlock(&server.obj_freelist_mutex);
3018 }
3019 }
3020
3021 static robj *lookupKey(redisDb *db, robj *key) {
3022 dictEntry *de = dictFind(db->dict,key);
3023 if (de) {
3024 robj *key = dictGetEntryKey(de);
3025 robj *val = dictGetEntryVal(de);
3026
3027 if (server.vm_enabled) {
3028 if (key->storage == REDIS_VM_MEMORY ||
3029 key->storage == REDIS_VM_SWAPPING)
3030 {
3031 /* If we were swapping the object out, stop it, this key
3032 * was requested. */
3033 if (key->storage == REDIS_VM_SWAPPING)
3034 vmCancelThreadedIOJob(key);
3035 /* Update the access time of the key for the aging algorithm. */
3036 key->vm.atime = server.unixtime;
3037 } else {
3038 int notify = (key->storage == REDIS_VM_LOADING);
3039
3040 /* Our value was swapped on disk. Bring it at home. */
3041 redisAssert(val == NULL);
3042 val = vmLoadObject(key);
3043 dictGetEntryVal(de) = val;
3044
3045 /* Clients blocked by the VM subsystem may be waiting for
3046 * this key... */
3047 if (notify) handleClientsBlockedOnSwappedKey(db,key);
3048 }
3049 }
3050 return val;
3051 } else {
3052 return NULL;
3053 }
3054 }
3055
3056 static robj *lookupKeyRead(redisDb *db, robj *key) {
3057 expireIfNeeded(db,key);
3058 return lookupKey(db,key);
3059 }
3060
3061 static robj *lookupKeyWrite(redisDb *db, robj *key) {
3062 deleteIfVolatile(db,key);
3063 return lookupKey(db,key);
3064 }
3065
3066 static robj *lookupKeyReadOrReply(redisClient *c, robj *key, robj *reply) {
3067 robj *o = lookupKeyRead(c->db, key);
3068 if (!o) addReply(c,reply);
3069 return o;
3070 }
3071
3072 static robj *lookupKeyWriteOrReply(redisClient *c, robj *key, robj *reply) {
3073 robj *o = lookupKeyWrite(c->db, key);
3074 if (!o) addReply(c,reply);
3075 return o;
3076 }
3077
3078 static int checkType(redisClient *c, robj *o, int type) {
3079 if (o->type != type) {
3080 addReply(c,shared.wrongtypeerr);
3081 return 1;
3082 }
3083 return 0;
3084 }
3085
3086 static int deleteKey(redisDb *db, robj *key) {
3087 int retval;
3088
3089 /* We need to protect key from destruction: after the first dictDelete()
3090 * it may happen that 'key' is no longer valid if we don't increment
3091 * it's count. This may happen when we get the object reference directly
3092 * from the hash table with dictRandomKey() or dict iterators */
3093 incrRefCount(key);
3094 if (dictSize(db->expires)) dictDelete(db->expires,key);
3095 retval = dictDelete(db->dict,key);
3096 decrRefCount(key);
3097
3098 return retval == DICT_OK;
3099 }
3100
3101 /* Check if the nul-terminated string 's' can be represented by a long
3102 * (that is, is a number that fits into long without any other space or
3103 * character before or after the digits).
3104 *
3105 * If so, the function returns REDIS_OK and *longval is set to the value
3106 * of the number. Otherwise REDIS_ERR is returned */
3107 static int isStringRepresentableAsLong(sds s, long *longval) {
3108 char buf[32], *endptr;
3109 long value;
3110 int slen;
3111
3112 value = strtol(s, &endptr, 10);
3113 if (endptr[0] != '\0') return REDIS_ERR;
3114 slen = snprintf(buf,32,"%ld",value);
3115
3116 /* If the number converted back into a string is not identical
3117 * then it's not possible to encode the string as integer */
3118 if (sdslen(s) != (unsigned)slen || memcmp(buf,s,slen)) return REDIS_ERR;
3119 if (longval) *longval = value;
3120 return REDIS_OK;
3121 }
3122
3123 /* Try to encode a string object in order to save space */
3124 static robj *tryObjectEncoding(robj *o) {
3125 long value;
3126 sds s = o->ptr;
3127
3128 if (o->encoding != REDIS_ENCODING_RAW)
3129 return o; /* Already encoded */
3130
3131 /* It's not safe to encode shared objects: shared objects can be shared
3132 * everywhere in the "object space" of Redis. Encoded objects can only
3133 * appear as "values" (and not, for instance, as keys) */
3134 if (o->refcount > 1) return o;
3135
3136 /* Currently we try to encode only strings */
3137 redisAssert(o->type == REDIS_STRING);
3138
3139 /* Check if we can represent this string as a long integer */
3140 if (isStringRepresentableAsLong(s,&value) == REDIS_ERR) return o;
3141
3142 /* Ok, this object can be encoded */
3143 if (value >= 0 && value < REDIS_SHARED_INTEGERS) {
3144 decrRefCount(o);
3145 incrRefCount(shared.integers[value]);
3146 return shared.integers[value];
3147 } else {
3148 o->encoding = REDIS_ENCODING_INT;
3149 sdsfree(o->ptr);
3150 o->ptr = (void*) value;
3151 return o;
3152 }
3153 }
3154
3155 /* Get a decoded version of an encoded object (returned as a new object).
3156 * If the object is already raw-encoded just increment the ref count. */
3157 static robj *getDecodedObject(robj *o) {
3158 robj *dec;
3159
3160 if (o->encoding == REDIS_ENCODING_RAW) {
3161 incrRefCount(o);
3162 return o;
3163 }
3164 if (o->type == REDIS_STRING && o->encoding == REDIS_ENCODING_INT) {
3165 char buf[32];
3166
3167 snprintf(buf,32,"%ld",(long)o->ptr);
3168 dec = createStringObject(buf,strlen(buf));
3169 return dec;
3170 } else {
3171 redisPanic("Unknown encoding type");
3172 }
3173 }
3174
3175 /* Compare two string objects via strcmp() or alike.
3176 * Note that the objects may be integer-encoded. In such a case we
3177 * use snprintf() to get a string representation of the numbers on the stack
3178 * and compare the strings, it's much faster than calling getDecodedObject().
3179 *
3180 * Important note: if objects are not integer encoded, but binary-safe strings,
3181 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
3182 * binary safe. */
3183 static int compareStringObjects(robj *a, robj *b) {
3184 redisAssert(a->type == REDIS_STRING && b->type == REDIS_STRING);
3185 char bufa[128], bufb[128], *astr, *bstr;
3186 int bothsds = 1;
3187
3188 if (a == b) return 0;
3189 if (a->encoding != REDIS_ENCODING_RAW) {
3190 snprintf(bufa,sizeof(bufa),"%ld",(long) a->ptr);
3191 astr = bufa;
3192 bothsds = 0;
3193 } else {
3194 astr = a->ptr;
3195 }
3196 if (b->encoding != REDIS_ENCODING_RAW) {
3197 snprintf(bufb,sizeof(bufb),"%ld",(long) b->ptr);
3198 bstr = bufb;
3199 bothsds = 0;
3200 } else {
3201 bstr = b->ptr;
3202 }
3203 return bothsds ? sdscmp(astr,bstr) : strcmp(astr,bstr);
3204 }
3205
3206 static size_t stringObjectLen(robj *o) {
3207 redisAssert(o->type == REDIS_STRING);
3208 if (o->encoding == REDIS_ENCODING_RAW) {
3209 return sdslen(o->ptr);
3210 } else {
3211 char buf[32];
3212
3213 return snprintf(buf,32,"%ld",(long)o->ptr);
3214 }
3215 }
3216
3217 static int getDoubleFromObject(robj *o, double *target) {
3218 double value;
3219 char *eptr;
3220
3221 if (o == NULL) {
3222 value = 0;
3223 } else {
3224 redisAssert(o->type == REDIS_STRING);
3225 if (o->encoding == REDIS_ENCODING_RAW) {
3226 value = strtod(o->ptr, &eptr);
3227 if (eptr[0] != '\0') return REDIS_ERR;
3228 } else if (o->encoding == REDIS_ENCODING_INT) {
3229 value = (long)o->ptr;
3230 } else {
3231 redisPanic("Unknown string encoding");
3232 }
3233 }
3234
3235 *target = value;
3236 return REDIS_OK;
3237 }
3238
3239 static int getDoubleFromObjectOrReply(redisClient *c, robj *o, double *target, const char *msg) {
3240 double value;
3241 if (getDoubleFromObject(o, &value) != REDIS_OK) {
3242 if (msg != NULL) {
3243 addReplySds(c, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg));
3244 } else {
3245 addReplySds(c, sdsnew("-ERR value is not a double\r\n"));
3246 }
3247 return REDIS_ERR;
3248 }
3249
3250 *target = value;
3251 return REDIS_OK;
3252 }
3253
3254 static int getLongLongFromObject(robj *o, long long *target) {
3255 long long value;
3256 char *eptr;
3257
3258 if (o == NULL) {
3259 value = 0;
3260 } else {
3261 redisAssert(o->type == REDIS_STRING);
3262 if (o->encoding == REDIS_ENCODING_RAW) {
3263 value = strtoll(o->ptr, &eptr, 10);
3264 if (eptr[0] != '\0') return REDIS_ERR;
3265 } else if (o->encoding == REDIS_ENCODING_INT) {
3266 value = (long)o->ptr;
3267 } else {
3268 redisPanic("Unknown string encoding");
3269 }
3270 }
3271
3272 *target = value;
3273 return REDIS_OK;
3274 }
3275
3276 static int getLongLongFromObjectOrReply(redisClient *c, robj *o, long long *target, const char *msg) {
3277 long long value;
3278 if (getLongLongFromObject(o, &value) != REDIS_OK) {
3279 if (msg != NULL) {
3280 addReplySds(c, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg));
3281 } else {
3282 addReplySds(c, sdsnew("-ERR value is not an integer\r\n"));
3283 }
3284 return REDIS_ERR;
3285 }
3286
3287 *target = value;
3288 return REDIS_OK;
3289 }
3290
3291 static int getLongFromObjectOrReply(redisClient *c, robj *o, long *target, const char *msg) {
3292 long long value;
3293
3294 if (getLongLongFromObjectOrReply(c, o, &value, msg) != REDIS_OK) return REDIS_ERR;
3295 if (value < LONG_MIN || value > LONG_MAX) {
3296 if (msg != NULL) {
3297 addReplySds(c, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg));
3298 } else {
3299 addReplySds(c, sdsnew("-ERR value is out of range\r\n"));
3300 }
3301 return REDIS_ERR;
3302 }
3303
3304 *target = value;
3305 return REDIS_OK;
3306 }
3307
3308 /*============================ RDB saving/loading =========================== */
3309
3310 static int rdbSaveType(FILE *fp, unsigned char type) {
3311 if (fwrite(&type,1,1,fp) == 0) return -1;
3312 return 0;
3313 }
3314
3315 static int rdbSaveTime(FILE *fp, time_t t) {
3316 int32_t t32 = (int32_t) t;
3317 if (fwrite(&t32,4,1,fp) == 0) return -1;
3318 return 0;
3319 }
3320
3321 /* check rdbLoadLen() comments for more info */
3322 static int rdbSaveLen(FILE *fp, uint32_t len) {
3323 unsigned char buf[2];
3324
3325 if (len < (1<<6)) {
3326 /* Save a 6 bit len */
3327 buf[0] = (len&0xFF)|(REDIS_RDB_6BITLEN<<6);
3328 if (fwrite(buf,1,1,fp) == 0) return -1;
3329 } else if (len < (1<<14)) {
3330 /* Save a 14 bit len */
3331 buf[0] = ((len>>8)&0xFF)|(REDIS_RDB_14BITLEN<<6);
3332 buf[1] = len&0xFF;
3333 if (fwrite(buf,2,1,fp) == 0) return -1;
3334 } else {
3335 /* Save a 32 bit len */
3336 buf[0] = (REDIS_RDB_32BITLEN<<6);
3337 if (fwrite(buf,1,1,fp) == 0) return -1;
3338 len = htonl(len);
3339 if (fwrite(&len,4,1,fp) == 0) return -1;
3340 }
3341 return 0;
3342 }
3343
3344 /* String objects in the form "2391" "-100" without any space and with a
3345 * range of values that can fit in an 8, 16 or 32 bit signed value can be
3346 * encoded as integers to save space */
3347 static int rdbTryIntegerEncoding(char *s, size_t len, unsigned char *enc) {
3348 long long value;
3349 char *endptr, buf[32];
3350
3351 /* Check if it's possible to encode this value as a number */
3352 value = strtoll(s, &endptr, 10);
3353 if (endptr[0] != '\0') return 0;
3354 snprintf(buf,32,"%lld",value);
3355
3356 /* If the number converted back into a string is not identical
3357 * then it's not possible to encode the string as integer */
3358 if (strlen(buf) != len || memcmp(buf,s,len)) return 0;
3359
3360 /* Finally check if it fits in our ranges */
3361 if (value >= -(1<<7) && value <= (1<<7)-1) {
3362 enc[0] = (REDIS_RDB_ENCVAL<<6)|REDIS_RDB_ENC_INT8;
3363 enc[1] = value&0xFF;
3364 return 2;
3365 } else if (value >= -(1<<15) && value <= (1<<15)-1) {
3366 enc[0] = (REDIS_RDB_ENCVAL<<6)|REDIS_RDB_ENC_INT16;
3367 enc[1] = value&0xFF;
3368 enc[2] = (value>>8)&0xFF;
3369 return 3;
3370 } else if (value >= -((long long)1<<31) && value <= ((long long)1<<31)-1) {
3371 enc[0] = (REDIS_RDB_ENCVAL<<6)|REDIS_RDB_ENC_INT32;
3372 enc[1] = value&0xFF;
3373 enc[2] = (value>>8)&0xFF;
3374 enc[3] = (value>>16)&0xFF;
3375 enc[4] = (value>>24)&0xFF;
3376 return 5;
3377 } else {
3378 return 0;
3379 }
3380 }
3381
3382 static int rdbSaveLzfStringObject(FILE *fp, unsigned char *s, size_t len) {
3383 size_t comprlen, outlen;
3384 unsigned char byte;
3385 void *out;
3386
3387 /* We require at least four bytes compression for this to be worth it */
3388 if (len <= 4) return 0;
3389 outlen = len-4;
3390 if ((out = zmalloc(outlen+1)) == NULL) return 0;
3391 comprlen = lzf_compress(s, len, out, outlen);
3392 if (comprlen == 0) {
3393 zfree(out);
3394 return 0;
3395 }
3396 /* Data compressed! Let's save it on disk */
3397 byte = (REDIS_RDB_ENCVAL<<6)|REDIS_RDB_ENC_LZF;
3398 if (fwrite(&byte,1,1,fp) == 0) goto writeerr;
3399 if (rdbSaveLen(fp,comprlen) == -1) goto writeerr;
3400 if (rdbSaveLen(fp,len) == -1) goto writeerr;
3401 if (fwrite(out,comprlen,1,fp) == 0) goto writeerr;
3402 zfree(out);
3403 return comprlen;
3404
3405 writeerr:
3406 zfree(out);
3407 return -1;
3408 }
3409
3410 /* Save a string objet as [len][data] on disk. If the object is a string
3411 * representation of an integer value we try to safe it in a special form */
3412 static int rdbSaveRawString(FILE *fp, unsigned char *s, size_t len) {
3413 int enclen;
3414
3415 /* Try integer encoding */
3416 if (len <= 11) {
3417 unsigned char buf[5];
3418 if ((enclen = rdbTryIntegerEncoding((char*)s,len,buf)) > 0) {
3419 if (fwrite(buf,enclen,1,fp) == 0) return -1;
3420 return 0;
3421 }
3422 }
3423
3424 /* Try LZF compression - under 20 bytes it's unable to compress even
3425 * aaaaaaaaaaaaaaaaaa so skip it */
3426 if (server.rdbcompression && len > 20) {
3427 int retval;
3428
3429 retval = rdbSaveLzfStringObject(fp,s,len);
3430 if (retval == -1) return -1;
3431 if (retval > 0) return 0;
3432 /* retval == 0 means data can't be compressed, save the old way */
3433 }
3434
3435 /* Store verbatim */
3436 if (rdbSaveLen(fp,len) == -1) return -1;
3437 if (len && fwrite(s,len,1,fp) == 0) return -1;
3438 return 0;
3439 }
3440
3441 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
3442 static int rdbSaveStringObject(FILE *fp, robj *obj) {
3443 int retval;
3444
3445 /* Avoid incr/decr ref count business when possible.
3446 * This plays well with copy-on-write given that we are probably
3447 * in a child process (BGSAVE). Also this makes sure key objects
3448 * of swapped objects are not incRefCount-ed (an assert does not allow
3449 * this in order to avoid bugs) */
3450 if (obj->encoding != REDIS_ENCODING_RAW) {
3451 obj = getDecodedObject(obj);
3452 retval = rdbSaveRawString(fp,obj->ptr,sdslen(obj->ptr));
3453 decrRefCount(obj);
3454 } else {
3455 retval = rdbSaveRawString(fp,obj->ptr,sdslen(obj->ptr));
3456 }
3457 return retval;
3458 }
3459
3460 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
3461 * 8 bit integer specifing the length of the representation.
3462 * This 8 bit integer has special values in order to specify the following
3463 * conditions:
3464 * 253: not a number
3465 * 254: + inf
3466 * 255: - inf
3467 */
3468 static int rdbSaveDoubleValue(FILE *fp, double val) {
3469 unsigned char buf[128];
3470 int len;
3471
3472 if (isnan(val)) {
3473 buf[0] = 253;
3474 len = 1;
3475 } else if (!isfinite(val)) {
3476 len = 1;
3477 buf[0] = (val < 0) ? 255 : 254;
3478 } else {
3479 snprintf((char*)buf+1,sizeof(buf)-1,"%.17g",val);
3480 buf[0] = strlen((char*)buf+1);
3481 len = buf[0]+1;
3482 }
3483 if (fwrite(buf,len,1,fp) == 0) return -1;
3484 return 0;
3485 }
3486
3487 /* Save a Redis object. */
3488 static int rdbSaveObject(FILE *fp, robj *o) {
3489 if (o->type == REDIS_STRING) {
3490 /* Save a string value */
3491 if (rdbSaveStringObject(fp,o) == -1) return -1;
3492 } else if (o->type == REDIS_LIST) {
3493 /* Save a list value */
3494 list *list = o->ptr;
3495 listIter li;
3496 listNode *ln;
3497
3498 if (rdbSaveLen(fp,listLength(list)) == -1) return -1;
3499 listRewind(list,&li);
3500 while((ln = listNext(&li))) {
3501 robj *eleobj = listNodeValue(ln);
3502
3503 if (rdbSaveStringObject(fp,eleobj) == -1) return -1;
3504 }
3505 } else if (o->type == REDIS_SET) {
3506 /* Save a set value */
3507 dict *set = o->ptr;
3508 dictIterator *di = dictGetIterator(set);
3509 dictEntry *de;
3510
3511 if (rdbSaveLen(fp,dictSize(set)) == -1) return -1;
3512 while((de = dictNext(di)) != NULL) {
3513 robj *eleobj = dictGetEntryKey(de);
3514
3515 if (rdbSaveStringObject(fp,eleobj) == -1) return -1;
3516 }
3517 dictReleaseIterator(di);
3518 } else if (o->type == REDIS_ZSET) {
3519 /* Save a set value */
3520 zset *zs = o->ptr;
3521 dictIterator *di = dictGetIterator(zs->dict);
3522 dictEntry *de;
3523
3524 if (rdbSaveLen(fp,dictSize(zs->dict)) == -1) return -1;
3525 while((de = dictNext(di)) != NULL) {
3526 robj *eleobj = dictGetEntryKey(de);
3527 double *score = dictGetEntryVal(de);
3528
3529 if (rdbSaveStringObject(fp,eleobj) == -1) return -1;
3530 if (rdbSaveDoubleValue(fp,*score) == -1) return -1;
3531 }
3532 dictReleaseIterator(di);
3533 } else if (o->type == REDIS_HASH) {
3534 /* Save a hash value */
3535 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
3536 unsigned char *p = zipmapRewind(o->ptr);
3537 unsigned int count = zipmapLen(o->ptr);
3538 unsigned char *key, *val;
3539 unsigned int klen, vlen;
3540
3541 if (rdbSaveLen(fp,count) == -1) return -1;
3542 while((p = zipmapNext(p,&key,&klen,&val,&vlen)) != NULL) {
3543 if (rdbSaveRawString(fp,key,klen) == -1) return -1;
3544 if (rdbSaveRawString(fp,val,vlen) == -1) return -1;
3545 }
3546 } else {
3547 dictIterator *di = dictGetIterator(o->ptr);
3548 dictEntry *de;
3549
3550 if (rdbSaveLen(fp,dictSize((dict*)o->ptr)) == -1) return -1;
3551 while((de = dictNext(di)) != NULL) {
3552 robj *key = dictGetEntryKey(de);
3553 robj *val = dictGetEntryVal(de);
3554
3555 if (rdbSaveStringObject(fp,key) == -1) return -1;
3556 if (rdbSaveStringObject(fp,val) == -1) return -1;
3557 }
3558 dictReleaseIterator(di);
3559 }
3560 } else {
3561 redisPanic("Unknown object type");
3562 }
3563 return 0;
3564 }
3565
3566 /* Return the length the object will have on disk if saved with
3567 * the rdbSaveObject() function. Currently we use a trick to get
3568 * this length with very little changes to the code. In the future
3569 * we could switch to a faster solution. */
3570 static off_t rdbSavedObjectLen(robj *o, FILE *fp) {
3571 if (fp == NULL) fp = server.devnull;
3572 rewind(fp);
3573 assert(rdbSaveObject(fp,o) != 1);
3574 return ftello(fp);
3575 }
3576
3577 /* Return the number of pages required to save this object in the swap file */
3578 static off_t rdbSavedObjectPages(robj *o, FILE *fp) {
3579 off_t bytes = rdbSavedObjectLen(o,fp);
3580
3581 return (bytes+(server.vm_page_size-1))/server.vm_page_size;
3582 }
3583
3584 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3585 static int rdbSave(char *filename) {
3586 dictIterator *di = NULL;
3587 dictEntry *de;
3588 FILE *fp;
3589 char tmpfile[256];
3590 int j;
3591 time_t now = time(NULL);
3592
3593 /* Wait for I/O therads to terminate, just in case this is a
3594 * foreground-saving, to avoid seeking the swap file descriptor at the
3595 * same time. */
3596 if (server.vm_enabled)
3597 waitEmptyIOJobsQueue();
3598
3599 snprintf(tmpfile,256,"temp-%d.rdb", (int) getpid());
3600 fp = fopen(tmpfile,"w");
3601 if (!fp) {
3602 redisLog(REDIS_WARNING, "Failed saving the DB: %s", strerror(errno));
3603 return REDIS_ERR;
3604 }
3605 if (fwrite("REDIS0001",9,1,fp) == 0) goto werr;
3606 for (j = 0; j < server.dbnum; j++) {
3607 redisDb *db = server.db+j;
3608 dict *d = db->dict;
3609 if (dictSize(d) == 0) continue;
3610 di = dictGetIterator(d);
3611 if (!di) {
3612 fclose(fp);
3613 return REDIS_ERR;
3614 }
3615
3616 /* Write the SELECT DB opcode */
3617 if (rdbSaveType(fp,REDIS_SELECTDB) == -1) goto werr;
3618 if (rdbSaveLen(fp,j) == -1) goto werr;
3619
3620 /* Iterate this DB writing every entry */
3621 while((de = dictNext(di)) != NULL) {
3622 robj *key = dictGetEntryKey(de);
3623 robj *o = dictGetEntryVal(de);
3624 time_t expiretime = getExpire(db,key);
3625
3626 /* Save the expire time */
3627 if (expiretime != -1) {
3628 /* If this key is already expired skip it */
3629 if (expiretime < now) continue;
3630 if (rdbSaveType(fp,REDIS_EXPIRETIME) == -1) goto werr;
3631 if (rdbSaveTime(fp,expiretime) == -1) goto werr;
3632 }
3633 /* Save the key and associated value. This requires special
3634 * handling if the value is swapped out. */
3635 if (!server.vm_enabled || key->storage == REDIS_VM_MEMORY ||
3636 key->storage == REDIS_VM_SWAPPING) {
3637 /* Save type, key, value */
3638 if (rdbSaveType(fp,o->type) == -1) goto werr;
3639 if (rdbSaveStringObject(fp,key) == -1) goto werr;
3640 if (rdbSaveObject(fp,o) == -1) goto werr;
3641 } else {
3642 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3643 robj *po;
3644 /* Get a preview of the object in memory */
3645 po = vmPreviewObject(key);
3646 /* Save type, key, value */
3647 if (rdbSaveType(fp,key->vtype) == -1) goto werr;
3648 if (rdbSaveStringObject(fp,key) == -1) goto werr;
3649 if (rdbSaveObject(fp,po) == -1) goto werr;
3650 /* Remove the loaded object from memory */
3651 decrRefCount(po);
3652 }
3653 }
3654 dictReleaseIterator(di);
3655 }
3656 /* EOF opcode */
3657 if (rdbSaveType(fp,REDIS_EOF) == -1) goto werr;
3658
3659 /* Make sure data will not remain on the OS's output buffers */
3660 fflush(fp);
3661 fsync(fileno(fp));
3662 fclose(fp);
3663
3664 /* Use RENAME to make sure the DB file is changed atomically only
3665 * if the generate DB file is ok. */
3666 if (rename(tmpfile,filename) == -1) {
3667 redisLog(REDIS_WARNING,"Error moving temp DB file on the final destination: %s", strerror(errno));
3668 unlink(tmpfile);
3669 return REDIS_ERR;
3670 }
3671 redisLog(REDIS_NOTICE,"DB saved on disk");
3672 server.dirty = 0;
3673 server.lastsave = time(NULL);
3674 return REDIS_OK;
3675
3676 werr:
3677 fclose(fp);
3678 unlink(tmpfile);
3679 redisLog(REDIS_WARNING,"Write error saving DB on disk: %s", strerror(errno));
3680 if (di) dictReleaseIterator(di);
3681 return REDIS_ERR;
3682 }
3683
3684 static int rdbSaveBackground(char *filename) {
3685 pid_t childpid;
3686
3687 if (server.bgsavechildpid != -1) return REDIS_ERR;
3688 if (server.vm_enabled) waitEmptyIOJobsQueue();
3689 if ((childpid = fork()) == 0) {
3690 /* Child */
3691 if (server.vm_enabled) vmReopenSwapFile();
3692 close(server.fd);
3693 if (rdbSave(filename) == REDIS_OK) {
3694 _exit(0);
3695 } else {
3696 _exit(1);
3697 }
3698 } else {
3699 /* Parent */
3700 if (childpid == -1) {
3701 redisLog(REDIS_WARNING,"Can't save in background: fork: %s",
3702 strerror(errno));
3703 return REDIS_ERR;
3704 }
3705 redisLog(REDIS_NOTICE,"Background saving started by pid %d",childpid);
3706 server.bgsavechildpid = childpid;
3707 updateDictResizePolicy();
3708 return REDIS_OK;
3709 }
3710 return REDIS_OK; /* unreached */
3711 }
3712
3713 static void rdbRemoveTempFile(pid_t childpid) {
3714 char tmpfile[256];
3715
3716 snprintf(tmpfile,256,"temp-%d.rdb", (int) childpid);
3717 unlink(tmpfile);
3718 }
3719
3720 static int rdbLoadType(FILE *fp) {
3721 unsigned char type;
3722 if (fread(&type,1,1,fp) == 0) return -1;
3723 return type;
3724 }
3725
3726 static time_t rdbLoadTime(FILE *fp) {
3727 int32_t t32;
3728 if (fread(&t32,4,1,fp) == 0) return -1;
3729 return (time_t) t32;
3730 }
3731
3732 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3733 * of this file for a description of how this are stored on disk.
3734 *
3735 * isencoded is set to 1 if the readed length is not actually a length but
3736 * an "encoding type", check the above comments for more info */
3737 static uint32_t rdbLoadLen(FILE *fp, int *isencoded) {
3738 unsigned char buf[2];
3739 uint32_t len;
3740 int type;
3741
3742 if (isencoded) *isencoded = 0;
3743 if (fread(buf,1,1,fp) == 0) return REDIS_RDB_LENERR;
3744 type = (buf[0]&0xC0)>>6;
3745 if (type == REDIS_RDB_6BITLEN) {
3746 /* Read a 6 bit len */
3747 return buf[0]&0x3F;
3748 } else if (type == REDIS_RDB_ENCVAL) {
3749 /* Read a 6 bit len encoding type */
3750 if (isencoded) *isencoded = 1;
3751 return buf[0]&0x3F;
3752 } else if (type == REDIS_RDB_14BITLEN) {
3753 /* Read a 14 bit len */
3754 if (fread(buf+1,1,1,fp) == 0) return REDIS_RDB_LENERR;
3755 return ((buf[0]&0x3F)<<8)|buf[1];
3756 } else {
3757 /* Read a 32 bit len */
3758 if (fread(&len,4,1,fp) == 0) return REDIS_RDB_LENERR;
3759 return ntohl(len);
3760 }
3761 }
3762
3763 static robj *rdbLoadIntegerObject(FILE *fp, int enctype) {
3764 unsigned char enc[4];
3765 long long val;
3766
3767 if (enctype == REDIS_RDB_ENC_INT8) {
3768 if (fread(enc,1,1,fp) == 0) return NULL;
3769 val = (signed char)enc[0];
3770 } else if (enctype == REDIS_RDB_ENC_INT16) {
3771 uint16_t v;
3772 if (fread(enc,2,1,fp) == 0) return NULL;
3773 v = enc[0]|(enc[1]<<8);
3774 val = (int16_t)v;
3775 } else if (enctype == REDIS_RDB_ENC_INT32) {
3776 uint32_t v;
3777 if (fread(enc,4,1,fp) == 0) return NULL;
3778 v = enc[0]|(enc[1]<<8)|(enc[2]<<16)|(enc[3]<<24);
3779 val = (int32_t)v;
3780 } else {
3781 val = 0; /* anti-warning */
3782 redisPanic("Unknown RDB integer encoding type");
3783 }
3784 return createObject(REDIS_STRING,sdscatprintf(sdsempty(),"%lld",val));
3785 }
3786
3787 static robj *rdbLoadLzfStringObject(FILE*fp) {
3788 unsigned int len, clen;
3789 unsigned char *c = NULL;
3790 sds val = NULL;
3791
3792 if ((clen = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
3793 if ((len = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
3794 if ((c = zmalloc(clen)) == NULL) goto err;
3795 if ((val = sdsnewlen(NULL,len)) == NULL) goto err;
3796 if (fread(c,clen,1,fp) == 0) goto err;
3797 if (lzf_decompress(c,clen,val,len) == 0) goto err;
3798 zfree(c);
3799 return createObject(REDIS_STRING,val);
3800 err:
3801 zfree(c);
3802 sdsfree(val);
3803 return NULL;
3804 }
3805
3806 static robj *rdbLoadStringObject(FILE*fp) {
3807 int isencoded;
3808 uint32_t len;
3809 sds val;
3810
3811 len = rdbLoadLen(fp,&isencoded);
3812 if (isencoded) {
3813 switch(len) {
3814 case REDIS_RDB_ENC_INT8:
3815 case REDIS_RDB_ENC_INT16:
3816 case REDIS_RDB_ENC_INT32:
3817 return rdbLoadIntegerObject(fp,len);
3818 case REDIS_RDB_ENC_LZF:
3819 return rdbLoadLzfStringObject(fp);
3820 default:
3821 redisPanic("Unknown RDB encoding type");
3822 }
3823 }
3824
3825 if (len == REDIS_RDB_LENERR) return NULL;
3826 val = sdsnewlen(NULL,len);
3827 if (len && fread(val,len,1,fp) == 0) {
3828 sdsfree(val);
3829 return NULL;
3830 }
3831 return createObject(REDIS_STRING,val);
3832 }
3833
3834 /* For information about double serialization check rdbSaveDoubleValue() */
3835 static int rdbLoadDoubleValue(FILE *fp, double *val) {
3836 char buf[128];
3837 unsigned char len;
3838
3839 if (fread(&len,1,1,fp) == 0) return -1;
3840 switch(len) {
3841 case 255: *val = R_NegInf; return 0;
3842 case 254: *val = R_PosInf; return 0;
3843 case 253: *val = R_Nan; return 0;
3844 default:
3845 if (fread(buf,len,1,fp) == 0) return -1;
3846 buf[len] = '\0';
3847 sscanf(buf, "%lg", val);
3848 return 0;
3849 }
3850 }
3851
3852 /* Load a Redis object of the specified type from the specified file.
3853 * On success a newly allocated object is returned, otherwise NULL. */
3854 static robj *rdbLoadObject(int type, FILE *fp) {
3855 robj *o;
3856
3857 redisLog(REDIS_DEBUG,"LOADING OBJECT %d (at %d)\n",type,ftell(fp));
3858 if (type == REDIS_STRING) {
3859 /* Read string value */
3860 if ((o = rdbLoadStringObject(fp)) == NULL) return NULL;
3861 o = tryObjectEncoding(o);
3862 } else if (type == REDIS_LIST || type == REDIS_SET) {
3863 /* Read list/set value */
3864 uint32_t listlen;
3865
3866 if ((listlen = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
3867 o = (type == REDIS_LIST) ? createListObject() : createSetObject();
3868 /* It's faster to expand the dict to the right size asap in order
3869 * to avoid rehashing */
3870 if (type == REDIS_SET && listlen > DICT_HT_INITIAL_SIZE)
3871 dictExpand(o->ptr,listlen);
3872 /* Load every single element of the list/set */
3873 while(listlen--) {
3874 robj *ele;
3875
3876 if ((ele = rdbLoadStringObject(fp)) == NULL) return NULL;
3877 ele = tryObjectEncoding(ele);
3878 if (type == REDIS_LIST) {
3879 listAddNodeTail((list*)o->ptr,ele);
3880 } else {
3881 dictAdd((dict*)o->ptr,ele,NULL);
3882 }
3883 }
3884 } else if (type == REDIS_ZSET) {
3885 /* Read list/set value */
3886 size_t zsetlen;
3887 zset *zs;
3888
3889 if ((zsetlen = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
3890 o = createZsetObject();
3891 zs = o->ptr;
3892 /* Load every single element of the list/set */
3893 while(zsetlen--) {
3894 robj *ele;
3895 double *score = zmalloc(sizeof(double));
3896
3897 if ((ele = rdbLoadStringObject(fp)) == NULL) return NULL;
3898 ele = tryObjectEncoding(ele);
3899 if (rdbLoadDoubleValue(fp,score) == -1) return NULL;
3900 dictAdd(zs->dict,ele,score);
3901 zslInsert(zs->zsl,*score,ele);
3902 incrRefCount(ele); /* added to skiplist */
3903 }
3904 } else if (type == REDIS_HASH) {
3905 size_t hashlen;
3906
3907 if ((hashlen = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
3908 o = createHashObject();
3909 /* Too many entries? Use an hash table. */
3910 if (hashlen > server.hash_max_zipmap_entries)
3911 convertToRealHash(o);
3912 /* Load every key/value, then set it into the zipmap or hash
3913 * table, as needed. */
3914 while(hashlen--) {
3915 robj *key, *val;
3916
3917 if ((key = rdbLoadStringObject(fp)) == NULL) return NULL;
3918 if ((val = rdbLoadStringObject(fp)) == NULL) return NULL;
3919 /* If we are using a zipmap and there are too big values
3920 * the object is converted to real hash table encoding. */
3921 if (o->encoding != REDIS_ENCODING_HT &&
3922 (sdslen(key->ptr) > server.hash_max_zipmap_value ||
3923 sdslen(val->ptr) > server.hash_max_zipmap_value))
3924 {
3925 convertToRealHash(o);
3926 }
3927
3928 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
3929 unsigned char *zm = o->ptr;
3930
3931 zm = zipmapSet(zm,key->ptr,sdslen(key->ptr),
3932 val->ptr,sdslen(val->ptr),NULL);
3933 o->ptr = zm;
3934 decrRefCount(key);
3935 decrRefCount(val);
3936 } else {
3937 key = tryObjectEncoding(key);
3938 val = tryObjectEncoding(val);
3939 dictAdd((dict*)o->ptr,key,val);
3940 }
3941 }
3942 } else {
3943 redisPanic("Unknown object type");
3944 }
3945 return o;
3946 }
3947
3948 static int rdbLoad(char *filename) {
3949 FILE *fp;
3950 uint32_t dbid;
3951 int type, retval, rdbver;
3952 int swap_all_values = 0;
3953 dict *d = server.db[0].dict;
3954 redisDb *db = server.db+0;
3955 char buf[1024];
3956 time_t expiretime, now = time(NULL);
3957 long long loadedkeys = 0;
3958
3959 fp = fopen(filename,"r");
3960 if (!fp) return REDIS_ERR;
3961 if (fread(buf,9,1,fp) == 0) goto eoferr;
3962 buf[9] = '\0';
3963 if (memcmp(buf,"REDIS",5) != 0) {
3964 fclose(fp);
3965 redisLog(REDIS_WARNING,"Wrong signature trying to load DB from file");
3966 return REDIS_ERR;
3967 }
3968 rdbver = atoi(buf+5);
3969 if (rdbver != 1) {
3970 fclose(fp);
3971 redisLog(REDIS_WARNING,"Can't handle RDB format version %d",rdbver);
3972 return REDIS_ERR;
3973 }
3974 while(1) {
3975 robj *key, *val;
3976
3977 expiretime = -1;
3978 /* Read type. */
3979 if ((type = rdbLoadType(fp)) == -1) goto eoferr;
3980 if (type == REDIS_EXPIRETIME) {
3981 if ((expiretime = rdbLoadTime(fp)) == -1) goto eoferr;
3982 /* We read the time so we need to read the object type again */
3983 if ((type = rdbLoadType(fp)) == -1) goto eoferr;
3984 }
3985 if (type == REDIS_EOF) break;
3986 /* Handle SELECT DB opcode as a special case */
3987 if (type == REDIS_SELECTDB) {
3988 if ((dbid = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR)
3989 goto eoferr;
3990 if (dbid >= (unsigned)server.dbnum) {
3991 redisLog(REDIS_WARNING,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server.dbnum);
3992 exit(1);
3993 }
3994 db = server.db+dbid;
3995 d = db->dict;
3996 continue;
3997 }
3998 /* Read key */
3999 if ((key = rdbLoadStringObject(fp)) == NULL) goto eoferr;
4000 /* Read value */
4001 if ((val = rdbLoadObject(type,fp)) == NULL) goto eoferr;
4002 /* Check if the key already expired */
4003 if (expiretime != -1 && expiretime < now) {
4004 decrRefCount(key);
4005 decrRefCount(val);
4006 continue;
4007 }
4008 /* Add the new object in the hash table */
4009 retval = dictAdd(d,key,val);
4010 if (retval == DICT_ERR) {
4011 redisLog(REDIS_WARNING,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", key->ptr);
4012 exit(1);
4013 }
4014 loadedkeys++;
4015 /* Set the expire time if needed */
4016 if (expiretime != -1) setExpire(db,key,expiretime);
4017
4018 /* Handle swapping while loading big datasets when VM is on */
4019
4020 /* If we detecter we are hopeless about fitting something in memory
4021 * we just swap every new key on disk. Directly...
4022 * Note that's important to check for this condition before resorting
4023 * to random sampling, otherwise we may try to swap already
4024 * swapped keys. */
4025 if (swap_all_values) {
4026 dictEntry *de = dictFind(d,key);
4027
4028 /* de may be NULL since the key already expired */
4029 if (de) {
4030 key = dictGetEntryKey(de);
4031 val = dictGetEntryVal(de);
4032
4033 if (vmSwapObjectBlocking(key,val) == REDIS_OK) {
4034 dictGetEntryVal(de) = NULL;
4035 }
4036 }
4037 continue;
4038 }
4039
4040 /* If we have still some hope of having some value fitting memory
4041 * then we try random sampling. */
4042 if (!swap_all_values && server.vm_enabled && (loadedkeys % 5000) == 0) {
4043 while (zmalloc_used_memory() > server.vm_max_memory) {
4044 if (vmSwapOneObjectBlocking() == REDIS_ERR) break;
4045 }
4046 if (zmalloc_used_memory() > server.vm_max_memory)
4047 swap_all_values = 1; /* We are already using too much mem */
4048 }
4049 }
4050 fclose(fp);
4051 return REDIS_OK;
4052
4053 eoferr: /* unexpected end of file is handled here with a fatal exit */
4054 redisLog(REDIS_WARNING,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
4055 exit(1);
4056 return REDIS_ERR; /* Just to avoid warning */
4057 }
4058
4059 /*================================== Commands =============================== */
4060
4061 static void authCommand(redisClient *c) {
4062 if (!server.requirepass || !strcmp(c->argv[1]->ptr, server.requirepass)) {
4063 c->authenticated = 1;
4064 addReply(c,shared.ok);
4065 } else {
4066 c->authenticated = 0;
4067 addReplySds(c,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
4068 }
4069 }
4070
4071 static void pingCommand(redisClient *c) {
4072 addReply(c,shared.pong);
4073 }
4074
4075 static void echoCommand(redisClient *c) {
4076 addReplyBulk(c,c->argv[1]);
4077 }
4078
4079 /*=================================== Strings =============================== */
4080
4081 static void setGenericCommand(redisClient *c, int nx, robj *key, robj *val, robj *expire) {
4082 int retval;
4083 long seconds = 0; /* initialized to avoid an harmness warning */
4084
4085 if (expire) {
4086 if (getLongFromObjectOrReply(c, expire, &seconds, NULL) != REDIS_OK)
4087 return;
4088 if (seconds <= 0) {
4089 addReplySds(c,sdsnew("-ERR invalid expire time in SETEX\r\n"));
4090 return;
4091 }
4092 }
4093
4094 if (nx) deleteIfVolatile(c->db,key);
4095 retval = dictAdd(c->db->dict,key,val);
4096 if (retval == DICT_ERR) {
4097 if (!nx) {
4098 /* If the key is about a swapped value, we want a new key object
4099 * to overwrite the old. So we delete the old key in the database.
4100 * This will also make sure that swap pages about the old object
4101 * will be marked as free. */
4102 if (server.vm_enabled && deleteIfSwapped(c->db,key))
4103 incrRefCount(key);
4104 dictReplace(c->db->dict,key,val);
4105 incrRefCount(val);
4106 } else {
4107 addReply(c,shared.czero);
4108 return;
4109 }
4110 } else {
4111 incrRefCount(key);
4112 incrRefCount(val);
4113 }
4114 server.dirty++;
4115 removeExpire(c->db,key);
4116 if (expire) setExpire(c->db,key,time(NULL)+seconds);
4117 addReply(c, nx ? shared.cone : shared.ok);
4118 }
4119
4120 static void setCommand(redisClient *c) {
4121 setGenericCommand(c,0,c->argv[1],c->argv[2],NULL);
4122 }
4123
4124 static void setnxCommand(redisClient *c) {
4125 setGenericCommand(c,1,c->argv[1],c->argv[2],NULL);
4126 }
4127
4128 static void setexCommand(redisClient *c) {
4129 setGenericCommand(c,0,c->argv[1],c->argv[3],c->argv[2]);
4130 }
4131
4132 static int getGenericCommand(redisClient *c) {
4133 robj *o;
4134
4135 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL)
4136 return REDIS_OK;
4137
4138 if (o->type != REDIS_STRING) {
4139 addReply(c,shared.wrongtypeerr);
4140 return REDIS_ERR;
4141 } else {
4142 addReplyBulk(c,o);
4143 return REDIS_OK;
4144 }
4145 }
4146
4147 static void getCommand(redisClient *c) {
4148 getGenericCommand(c);
4149 }
4150
4151 static void getsetCommand(redisClient *c) {
4152 if (getGenericCommand(c) == REDIS_ERR) return;
4153 if (dictAdd(c->db->dict,c->argv[1],c->argv[2]) == DICT_ERR) {
4154 dictReplace(c->db->dict,c->argv[1],c->argv[2]);
4155 } else {
4156 incrRefCount(c->argv[1]);
4157 }
4158 incrRefCount(c->argv[2]);
4159 server.dirty++;
4160 removeExpire(c->db,c->argv[1]);
4161 }
4162
4163 static void mgetCommand(redisClient *c) {
4164 int j;
4165
4166 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",c->argc-1));
4167 for (j = 1; j < c->argc; j++) {
4168 robj *o = lookupKeyRead(c->db,c->argv[j]);
4169 if (o == NULL) {
4170 addReply(c,shared.nullbulk);
4171 } else {
4172 if (o->type != REDIS_STRING) {
4173 addReply(c,shared.nullbulk);
4174 } else {
4175 addReplyBulk(c,o);
4176 }
4177 }
4178 }
4179 }
4180
4181 static void msetGenericCommand(redisClient *c, int nx) {
4182 int j, busykeys = 0;
4183
4184 if ((c->argc % 2) == 0) {
4185 addReplySds(c,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
4186 return;
4187 }
4188 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
4189 * set nothing at all if at least one already key exists. */
4190 if (nx) {
4191 for (j = 1; j < c->argc; j += 2) {
4192 if (lookupKeyWrite(c->db,c->argv[j]) != NULL) {
4193 busykeys++;
4194 }
4195 }
4196 }
4197 if (busykeys) {
4198 addReply(c, shared.czero);
4199 return;
4200 }
4201
4202 for (j = 1; j < c->argc; j += 2) {
4203 int retval;
4204
4205 c->argv[j+1] = tryObjectEncoding(c->argv[j+1]);
4206 retval = dictAdd(c->db->dict,c->argv[j],c->argv[j+1]);
4207 if (retval == DICT_ERR) {
4208 dictReplace(c->db->dict,c->argv[j],c->argv[j+1]);
4209 incrRefCount(c->argv[j+1]);
4210 } else {
4211 incrRefCount(c->argv[j]);
4212 incrRefCount(c->argv[j+1]);
4213 }
4214 removeExpire(c->db,c->argv[j]);
4215 }
4216 server.dirty += (c->argc-1)/2;
4217 addReply(c, nx ? shared.cone : shared.ok);
4218 }
4219
4220 static void msetCommand(redisClient *c) {
4221 msetGenericCommand(c,0);
4222 }
4223
4224 static void msetnxCommand(redisClient *c) {
4225 msetGenericCommand(c,1);
4226 }
4227
4228 static void incrDecrCommand(redisClient *c, long long incr) {
4229 long long value;
4230 int retval;
4231 robj *o;
4232
4233 o = lookupKeyWrite(c->db,c->argv[1]);
4234
4235 if (getLongLongFromObjectOrReply(c, o, &value, NULL) != REDIS_OK) return;
4236
4237 value += incr;
4238 o = createObject(REDIS_STRING,sdscatprintf(sdsempty(),"%lld",value));
4239 o = tryObjectEncoding(o);
4240 retval = dictAdd(c->db->dict,c->argv[1],o);
4241 if (retval == DICT_ERR) {
4242 dictReplace(c->db->dict,c->argv[1],o);
4243 removeExpire(c->db,c->argv[1]);
4244 } else {
4245 incrRefCount(c->argv[1]);
4246 }
4247 server.dirty++;
4248 addReply(c,shared.colon);
4249 addReply(c,o);
4250 addReply(c,shared.crlf);
4251 }
4252
4253 static void incrCommand(redisClient *c) {
4254 incrDecrCommand(c,1);
4255 }
4256
4257 static void decrCommand(redisClient *c) {
4258 incrDecrCommand(c,-1);
4259 }
4260
4261 static void incrbyCommand(redisClient *c) {
4262 long long incr;
4263
4264 if (getLongLongFromObjectOrReply(c, c->argv[2], &incr, NULL) != REDIS_OK) return;
4265 incrDecrCommand(c,incr);
4266 }
4267
4268 static void decrbyCommand(redisClient *c) {
4269 long long incr;
4270
4271 if (getLongLongFromObjectOrReply(c, c->argv[2], &incr, NULL) != REDIS_OK) return;
4272 incrDecrCommand(c,-incr);
4273 }
4274
4275 static void appendCommand(redisClient *c) {
4276 int retval;
4277 size_t totlen;
4278 robj *o;
4279
4280 o = lookupKeyWrite(c->db,c->argv[1]);
4281 if (o == NULL) {
4282 /* Create the key */
4283 retval = dictAdd(c->db->dict,c->argv[1],c->argv[2]);
4284 incrRefCount(c->argv[1]);
4285 incrRefCount(c->argv[2]);
4286 totlen = stringObjectLen(c->argv[2]);
4287 } else {
4288 dictEntry *de;
4289
4290 de = dictFind(c->db->dict,c->argv[1]);
4291 assert(de != NULL);
4292
4293 o = dictGetEntryVal(de);
4294 if (o->type != REDIS_STRING) {
4295 addReply(c,shared.wrongtypeerr);
4296 return;
4297 }
4298 /* If the object is specially encoded or shared we have to make
4299 * a copy */
4300 if (o->refcount != 1 || o->encoding != REDIS_ENCODING_RAW) {
4301 robj *decoded = getDecodedObject(o);
4302
4303 o = createStringObject(decoded->ptr, sdslen(decoded->ptr));
4304 decrRefCount(decoded);
4305 dictReplace(c->db->dict,c->argv[1],o);
4306 }
4307 /* APPEND! */
4308 if (c->argv[2]->encoding == REDIS_ENCODING_RAW) {
4309 o->ptr = sdscatlen(o->ptr,
4310 c->argv[2]->ptr, sdslen(c->argv[2]->ptr));
4311 } else {
4312 o->ptr = sdscatprintf(o->ptr, "%ld",
4313 (unsigned long) c->argv[2]->ptr);
4314 }
4315 totlen = sdslen(o->ptr);
4316 }
4317 server.dirty++;
4318 addReplySds(c,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen));
4319 }
4320
4321 static void substrCommand(redisClient *c) {
4322 robj *o;
4323 long start = atoi(c->argv[2]->ptr);
4324 long end = atoi(c->argv[3]->ptr);
4325 size_t rangelen, strlen;
4326 sds range;
4327
4328 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
4329 checkType(c,o,REDIS_STRING)) return;
4330
4331 o = getDecodedObject(o);
4332 strlen = sdslen(o->ptr);
4333
4334 /* convert negative indexes */
4335 if (start < 0) start = strlen+start;
4336 if (end < 0) end = strlen+end;
4337 if (start < 0) start = 0;
4338 if (end < 0) end = 0;
4339
4340 /* indexes sanity checks */
4341 if (start > end || (size_t)start >= strlen) {
4342 /* Out of range start or start > end result in null reply */
4343 addReply(c,shared.nullbulk);
4344 decrRefCount(o);
4345 return;
4346 }
4347 if ((size_t)end >= strlen) end = strlen-1;
4348 rangelen = (end-start)+1;
4349
4350 /* Return the result */
4351 addReplySds(c,sdscatprintf(sdsempty(),"$%zu\r\n",rangelen));
4352 range = sdsnewlen((char*)o->ptr+start,rangelen);
4353 addReplySds(c,range);
4354 addReply(c,shared.crlf);
4355 decrRefCount(o);
4356 }
4357
4358 /* ========================= Type agnostic commands ========================= */
4359
4360 static void delCommand(redisClient *c) {
4361 int deleted = 0, j;
4362
4363 for (j = 1; j < c->argc; j++) {
4364 if (deleteKey(c->db,c->argv[j])) {
4365 server.dirty++;
4366 deleted++;
4367 }
4368 }
4369 addReplyLong(c,deleted);
4370 }
4371
4372 static void existsCommand(redisClient *c) {
4373 addReply(c,lookupKeyRead(c->db,c->argv[1]) ? shared.cone : shared.czero);
4374 }
4375
4376 static void selectCommand(redisClient *c) {
4377 int id = atoi(c->argv[1]->ptr);
4378
4379 if (selectDb(c,id) == REDIS_ERR) {
4380 addReplySds(c,sdsnew("-ERR invalid DB index\r\n"));
4381 } else {
4382 addReply(c,shared.ok);
4383 }
4384 }
4385
4386 static void randomkeyCommand(redisClient *c) {
4387 dictEntry *de;
4388 robj *key;
4389
4390 while(1) {
4391 de = dictGetRandomKey(c->db->dict);
4392 if (!de || expireIfNeeded(c->db,dictGetEntryKey(de)) == 0) break;
4393 }
4394
4395 if (de == NULL) {
4396 addReply(c,shared.nullbulk);
4397 return;
4398 }
4399
4400 key = dictGetEntryKey(de);
4401 if (server.vm_enabled) {
4402 key = dupStringObject(key);
4403 addReplyBulk(c,key);
4404 decrRefCount(key);
4405 } else {
4406 addReplyBulk(c,key);
4407 }
4408 }
4409
4410 static void keysCommand(redisClient *c) {
4411 dictIterator *di;
4412 dictEntry *de;
4413 sds pattern = c->argv[1]->ptr;
4414 int plen = sdslen(pattern);
4415 unsigned long numkeys = 0;
4416 robj *lenobj = createObject(REDIS_STRING,NULL);
4417
4418 di = dictGetIterator(c->db->dict);
4419 addReply(c,lenobj);
4420 decrRefCount(lenobj);
4421 while((de = dictNext(di)) != NULL) {
4422 robj *keyobj = dictGetEntryKey(de);
4423
4424 sds key = keyobj->ptr;
4425 if ((pattern[0] == '*' && pattern[1] == '\0') ||
4426 stringmatchlen(pattern,plen,key,sdslen(key),0)) {
4427 if (expireIfNeeded(c->db,keyobj) == 0) {
4428 addReplyBulk(c,keyobj);
4429 numkeys++;
4430 }
4431 }
4432 }
4433 dictReleaseIterator(di);
4434 lenobj->ptr = sdscatprintf(sdsempty(),"*%lu\r\n",numkeys);
4435 }
4436
4437 static void dbsizeCommand(redisClient *c) {
4438 addReplySds(c,
4439 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c->db->dict)));
4440 }
4441
4442 static void lastsaveCommand(redisClient *c) {
4443 addReplySds(c,
4444 sdscatprintf(sdsempty(),":%lu\r\n",server.lastsave));
4445 }
4446
4447 static void typeCommand(redisClient *c) {
4448 robj *o;
4449 char *type;
4450
4451 o = lookupKeyRead(c->db,c->argv[1]);
4452 if (o == NULL) {
4453 type = "+none";
4454 } else {
4455 switch(o->type) {
4456 case REDIS_STRING: type = "+string"; break;
4457 case REDIS_LIST: type = "+list"; break;
4458 case REDIS_SET: type = "+set"; break;
4459 case REDIS_ZSET: type = "+zset"; break;
4460 case REDIS_HASH: type = "+hash"; break;
4461 default: type = "+unknown"; break;
4462 }
4463 }
4464 addReplySds(c,sdsnew(type));
4465 addReply(c,shared.crlf);
4466 }
4467
4468 static void saveCommand(redisClient *c) {
4469 if (server.bgsavechildpid != -1) {
4470 addReplySds(c,sdsnew("-ERR background save in progress\r\n"));
4471 return;
4472 }
4473 if (rdbSave(server.dbfilename) == REDIS_OK) {
4474 addReply(c,shared.ok);
4475 } else {
4476 addReply(c,shared.err);
4477 }
4478 }
4479
4480 static void bgsaveCommand(redisClient *c) {
4481 if (server.bgsavechildpid != -1) {
4482 addReplySds(c,sdsnew("-ERR background save already in progress\r\n"));
4483 return;
4484 }
4485 if (rdbSaveBackground(server.dbfilename) == REDIS_OK) {
4486 char *status = "+Background saving started\r\n";
4487 addReplySds(c,sdsnew(status));
4488 } else {
4489 addReply(c,shared.err);
4490 }
4491 }
4492
4493 static void shutdownCommand(redisClient *c) {
4494 redisLog(REDIS_WARNING,"User requested shutdown, saving DB...");
4495 /* Kill the saving child if there is a background saving in progress.
4496 We want to avoid race conditions, for instance our saving child may
4497 overwrite the synchronous saving did by SHUTDOWN. */
4498 if (server.bgsavechildpid != -1) {
4499 redisLog(REDIS_WARNING,"There is a live saving child. Killing it!");
4500 kill(server.bgsavechildpid,SIGKILL);
4501 rdbRemoveTempFile(server.bgsavechildpid);
4502 }
4503 if (server.appendonly) {
4504 /* Append only file: fsync() the AOF and exit */
4505 fsync(server.appendfd);
4506 if (server.vm_enabled) unlink(server.vm_swap_file);
4507 exit(0);
4508 } else {
4509 /* Snapshotting. Perform a SYNC SAVE and exit */
4510 if (rdbSave(server.dbfilename) == REDIS_OK) {
4511 if (server.daemonize)
4512 unlink(server.pidfile);
4513 redisLog(REDIS_WARNING,"%zu bytes used at exit",zmalloc_used_memory());
4514 redisLog(REDIS_WARNING,"Server exit now, bye bye...");
4515 exit(0);
4516 } else {
4517 /* Ooops.. error saving! The best we can do is to continue
4518 * operating. Note that if there was a background saving process,
4519 * in the next cron() Redis will be notified that the background
4520 * saving aborted, handling special stuff like slaves pending for
4521 * synchronization... */
4522 redisLog(REDIS_WARNING,"Error trying to save the DB, can't exit");
4523 addReplySds(c,
4524 sdsnew("-ERR can't quit, problems saving the DB\r\n"));
4525 }
4526 }
4527 }
4528
4529 static void renameGenericCommand(redisClient *c, int nx) {
4530 robj *o;
4531
4532 /* To use the same key as src and dst is probably an error */
4533 if (sdscmp(c->argv[1]->ptr,c->argv[2]->ptr) == 0) {
4534 addReply(c,shared.sameobjecterr);
4535 return;
4536 }
4537
4538 if ((o = lookupKeyWriteOrReply(c,c->argv[1],shared.nokeyerr)) == NULL)
4539 return;
4540
4541 incrRefCount(o);
4542 deleteIfVolatile(c->db,c->argv[2]);
4543 if (dictAdd(c->db->dict,c->argv[2],o) == DICT_ERR) {
4544 if (nx) {
4545 decrRefCount(o);
4546 addReply(c,shared.czero);
4547 return;
4548 }
4549 dictReplace(c->db->dict,c->argv[2],o);
4550 } else {
4551 incrRefCount(c->argv[2]);
4552 }
4553 deleteKey(c->db,c->argv[1]);
4554 server.dirty++;
4555 addReply(c,nx ? shared.cone : shared.ok);
4556 }
4557
4558 static void renameCommand(redisClient *c) {
4559 renameGenericCommand(c,0);
4560 }
4561
4562 static void renamenxCommand(redisClient *c) {
4563 renameGenericCommand(c,1);
4564 }
4565
4566 static void moveCommand(redisClient *c) {
4567 robj *o;
4568 redisDb *src, *dst;
4569 int srcid;
4570
4571 /* Obtain source and target DB pointers */
4572 src = c->db;
4573 srcid = c->db->id;
4574 if (selectDb(c,atoi(c->argv[2]->ptr)) == REDIS_ERR) {
4575 addReply(c,shared.outofrangeerr);
4576 return;
4577 }
4578 dst = c->db;
4579 selectDb(c,srcid); /* Back to the source DB */
4580
4581 /* If the user is moving using as target the same
4582 * DB as the source DB it is probably an error. */
4583 if (src == dst) {
4584 addReply(c,shared.sameobjecterr);
4585 return;
4586 }
4587
4588 /* Check if the element exists and get a reference */
4589 o = lookupKeyWrite(c->db,c->argv[1]);
4590 if (!o) {
4591 addReply(c,shared.czero);
4592 return;
4593 }
4594
4595 /* Try to add the element to the target DB */
4596 deleteIfVolatile(dst,c->argv[1]);
4597 if (dictAdd(dst->dict,c->argv[1],o) == DICT_ERR) {
4598 addReply(c,shared.czero);
4599 return;
4600 }
4601 incrRefCount(c->argv[1]);
4602 incrRefCount(o);
4603
4604 /* OK! key moved, free the entry in the source DB */
4605 deleteKey(src,c->argv[1]);
4606 server.dirty++;
4607 addReply(c,shared.cone);
4608 }
4609
4610 /* =================================== Lists ================================ */
4611 static void pushGenericCommand(redisClient *c, int where) {
4612 robj *lobj;
4613 list *list;
4614
4615 lobj = lookupKeyWrite(c->db,c->argv[1]);
4616 if (lobj == NULL) {
4617 if (handleClientsWaitingListPush(c,c->argv[1],c->argv[2])) {
4618 addReply(c,shared.cone);
4619 return;
4620 }
4621 lobj = createListObject();
4622 list = lobj->ptr;
4623 if (where == REDIS_HEAD) {
4624 listAddNodeHead(list,c->argv[2]);
4625 } else {
4626 listAddNodeTail(list,c->argv[2]);
4627 }
4628 dictAdd(c->db->dict,c->argv[1],lobj);
4629 incrRefCount(c->argv[1]);
4630 incrRefCount(c->argv[2]);
4631 } else {
4632 if (lobj->type != REDIS_LIST) {
4633 addReply(c,shared.wrongtypeerr);
4634 return;
4635 }
4636 if (handleClientsWaitingListPush(c,c->argv[1],c->argv[2])) {
4637 addReply(c,shared.cone);
4638 return;
4639 }
4640 list = lobj->ptr;
4641 if (where == REDIS_HEAD) {
4642 listAddNodeHead(list,c->argv[2]);
4643 } else {
4644 listAddNodeTail(list,c->argv[2]);
4645 }
4646 incrRefCount(c->argv[2]);
4647 }
4648 server.dirty++;
4649 addReplySds(c,sdscatprintf(sdsempty(),":%d\r\n",listLength(list)));
4650 }
4651
4652 static void lpushCommand(redisClient *c) {
4653 pushGenericCommand(c,REDIS_HEAD);
4654 }
4655
4656 static void rpushCommand(redisClient *c) {
4657 pushGenericCommand(c,REDIS_TAIL);
4658 }
4659
4660 static void llenCommand(redisClient *c) {
4661 robj *o;
4662 list *l;
4663
4664 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
4665 checkType(c,o,REDIS_LIST)) return;
4666
4667 l = o->ptr;
4668 addReplyUlong(c,listLength(l));
4669 }
4670
4671 static void lindexCommand(redisClient *c) {
4672 robj *o;
4673 int index = atoi(c->argv[2]->ptr);
4674 list *list;
4675 listNode *ln;
4676
4677 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
4678 checkType(c,o,REDIS_LIST)) return;
4679 list = o->ptr;
4680
4681 ln = listIndex(list, index);
4682 if (ln == NULL) {
4683 addReply(c,shared.nullbulk);
4684 } else {
4685 robj *ele = listNodeValue(ln);
4686 addReplyBulk(c,ele);
4687 }
4688 }
4689
4690 static void lsetCommand(redisClient *c) {
4691 robj *o;
4692 int index = atoi(c->argv[2]->ptr);
4693 list *list;
4694 listNode *ln;
4695
4696 if ((o = lookupKeyWriteOrReply(c,c->argv[1],shared.nokeyerr)) == NULL ||
4697 checkType(c,o,REDIS_LIST)) return;
4698 list = o->ptr;
4699
4700 ln = listIndex(list, index);
4701 if (ln == NULL) {
4702 addReply(c,shared.outofrangeerr);
4703 } else {
4704 robj *ele = listNodeValue(ln);
4705
4706 decrRefCount(ele);
4707 listNodeValue(ln) = c->argv[3];
4708 incrRefCount(c->argv[3]);
4709 addReply(c,shared.ok);
4710 server.dirty++;
4711 }
4712 }
4713
4714 static void popGenericCommand(redisClient *c, int where) {
4715 robj *o;
4716 list *list;
4717 listNode *ln;
4718
4719 if ((o = lookupKeyWriteOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
4720 checkType(c,o,REDIS_LIST)) return;
4721 list = o->ptr;
4722
4723 if (where == REDIS_HEAD)
4724 ln = listFirst(list);
4725 else
4726 ln = listLast(list);
4727
4728 if (ln == NULL) {
4729 addReply(c,shared.nullbulk);
4730 } else {
4731 robj *ele = listNodeValue(ln);
4732 addReplyBulk(c,ele);
4733 listDelNode(list,ln);
4734 if (listLength(list) == 0) deleteKey(c->db,c->argv[1]);
4735 server.dirty++;
4736 }
4737 }
4738
4739 static void lpopCommand(redisClient *c) {
4740 popGenericCommand(c,REDIS_HEAD);
4741 }
4742
4743 static void rpopCommand(redisClient *c) {
4744 popGenericCommand(c,REDIS_TAIL);
4745 }
4746
4747 static void lrangeCommand(redisClient *c) {
4748 robj *o;
4749 int start = atoi(c->argv[2]->ptr);
4750 int end = atoi(c->argv[3]->ptr);
4751 int llen;
4752 int rangelen, j;
4753 list *list;
4754 listNode *ln;
4755 robj *ele;
4756
4757 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.emptymultibulk)) == NULL
4758 || checkType(c,o,REDIS_LIST)) return;
4759 list = o->ptr;
4760 llen = listLength(list);
4761
4762 /* convert negative indexes */
4763 if (start < 0) start = llen+start;
4764 if (end < 0) end = llen+end;
4765 if (start < 0) start = 0;
4766 if (end < 0) end = 0;
4767
4768 /* indexes sanity checks */
4769 if (start > end || start >= llen) {
4770 /* Out of range start or start > end result in empty list */
4771 addReply(c,shared.emptymultibulk);
4772 return;
4773 }
4774 if (end >= llen) end = llen-1;
4775 rangelen = (end-start)+1;
4776
4777 /* Return the result in form of a multi-bulk reply */
4778 ln = listIndex(list, start);
4779 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",rangelen));
4780 for (j = 0; j < rangelen; j++) {
4781 ele = listNodeValue(ln);
4782 addReplyBulk(c,ele);
4783 ln = ln->next;
4784 }
4785 }
4786
4787 static void ltrimCommand(redisClient *c) {
4788 robj *o;
4789 int start = atoi(c->argv[2]->ptr);
4790 int end = atoi(c->argv[3]->ptr);
4791 int llen;
4792 int j, ltrim, rtrim;
4793 list *list;
4794 listNode *ln;
4795
4796 if ((o = lookupKeyWriteOrReply(c,c->argv[1],shared.ok)) == NULL ||
4797 checkType(c,o,REDIS_LIST)) return;
4798 list = o->ptr;
4799 llen = listLength(list);
4800
4801 /* convert negative indexes */
4802 if (start < 0) start = llen+start;
4803 if (end < 0) end = llen+end;
4804 if (start < 0) start = 0;
4805 if (end < 0) end = 0;
4806
4807 /* indexes sanity checks */
4808 if (start > end || start >= llen) {
4809 /* Out of range start or start > end result in empty list */
4810 ltrim = llen;
4811 rtrim = 0;
4812 } else {
4813 if (end >= llen) end = llen-1;
4814 ltrim = start;
4815 rtrim = llen-end-1;
4816 }
4817
4818 /* Remove list elements to perform the trim */
4819 for (j = 0; j < ltrim; j++) {
4820 ln = listFirst(list);
4821 listDelNode(list,ln);
4822 }
4823 for (j = 0; j < rtrim; j++) {
4824 ln = listLast(list);
4825 listDelNode(list,ln);
4826 }
4827 if (listLength(list) == 0) deleteKey(c->db,c->argv[1]);
4828 server.dirty++;
4829 addReply(c,shared.ok);
4830 }
4831
4832 static void lremCommand(redisClient *c) {
4833 robj *o;
4834 list *list;
4835 listNode *ln, *next;
4836 int toremove = atoi(c->argv[2]->ptr);
4837 int removed = 0;
4838 int fromtail = 0;
4839
4840 if ((o = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
4841 checkType(c,o,REDIS_LIST)) return;
4842 list = o->ptr;
4843
4844 if (toremove < 0) {
4845 toremove = -toremove;
4846 fromtail = 1;
4847 }
4848 ln = fromtail ? list->tail : list->head;
4849 while (ln) {
4850 robj *ele = listNodeValue(ln);
4851
4852 next = fromtail ? ln->prev : ln->next;
4853 if (compareStringObjects(ele,c->argv[3]) == 0) {
4854 listDelNode(list,ln);
4855 server.dirty++;
4856 removed++;
4857 if (toremove && removed == toremove) break;
4858 }
4859 ln = next;
4860 }
4861 if (listLength(list) == 0) deleteKey(c->db,c->argv[1]);
4862 addReplySds(c,sdscatprintf(sdsempty(),":%d\r\n",removed));
4863 }
4864
4865 /* This is the semantic of this command:
4866 * RPOPLPUSH srclist dstlist:
4867 * IF LLEN(srclist) > 0
4868 * element = RPOP srclist
4869 * LPUSH dstlist element
4870 * RETURN element
4871 * ELSE
4872 * RETURN nil
4873 * END
4874 * END
4875 *
4876 * The idea is to be able to get an element from a list in a reliable way
4877 * since the element is not just returned but pushed against another list
4878 * as well. This command was originally proposed by Ezra Zygmuntowicz.
4879 */
4880 static void rpoplpushcommand(redisClient *c) {
4881 robj *sobj;
4882 list *srclist;
4883 listNode *ln;
4884
4885 if ((sobj = lookupKeyWriteOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
4886 checkType(c,sobj,REDIS_LIST)) return;
4887 srclist = sobj->ptr;
4888 ln = listLast(srclist);
4889
4890 if (ln == NULL) {
4891 addReply(c,shared.nullbulk);
4892 } else {
4893 robj *dobj = lookupKeyWrite(c->db,c->argv[2]);
4894 robj *ele = listNodeValue(ln);
4895 list *dstlist;
4896
4897 if (dobj && dobj->type != REDIS_LIST) {
4898 addReply(c,shared.wrongtypeerr);
4899 return;
4900 }
4901
4902 /* Add the element to the target list (unless it's directly
4903 * passed to some BLPOP-ing client */
4904 if (!handleClientsWaitingListPush(c,c->argv[2],ele)) {
4905 if (dobj == NULL) {
4906 /* Create the list if the key does not exist */
4907 dobj = createListObject();
4908 dictAdd(c->db->dict,c->argv[2],dobj);
4909 incrRefCount(c->argv[2]);
4910 }
4911 dstlist = dobj->ptr;
4912 listAddNodeHead(dstlist,ele);
4913 incrRefCount(ele);
4914 }
4915
4916 /* Send the element to the client as reply as well */
4917 addReplyBulk(c,ele);
4918
4919 /* Finally remove the element from the source list */
4920 listDelNode(srclist,ln);
4921 if (listLength(srclist) == 0) deleteKey(c->db,c->argv[1]);
4922 server.dirty++;
4923 }
4924 }
4925
4926 /* ==================================== Sets ================================ */
4927
4928 static void saddCommand(redisClient *c) {
4929 robj *set;
4930
4931 set = lookupKeyWrite(c->db,c->argv[1]);
4932 if (set == NULL) {
4933 set = createSetObject();
4934 dictAdd(c->db->dict,c->argv[1],set);
4935 incrRefCount(c->argv[1]);
4936 } else {
4937 if (set->type != REDIS_SET) {
4938 addReply(c,shared.wrongtypeerr);
4939 return;
4940 }
4941 }
4942 if (dictAdd(set->ptr,c->argv[2],NULL) == DICT_OK) {
4943 incrRefCount(c->argv[2]);
4944 server.dirty++;
4945 addReply(c,shared.cone);
4946 } else {
4947 addReply(c,shared.czero);
4948 }
4949 }
4950
4951 static void sremCommand(redisClient *c) {
4952 robj *set;
4953
4954 if ((set = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
4955 checkType(c,set,REDIS_SET)) return;
4956
4957 if (dictDelete(set->ptr,c->argv[2]) == DICT_OK) {
4958 server.dirty++;
4959 if (htNeedsResize(set->ptr)) dictResize(set->ptr);
4960 if (dictSize((dict*)set->ptr) == 0) deleteKey(c->db,c->argv[1]);
4961 addReply(c,shared.cone);
4962 } else {
4963 addReply(c,shared.czero);
4964 }
4965 }
4966
4967 static void smoveCommand(redisClient *c) {
4968 robj *srcset, *dstset;
4969
4970 srcset = lookupKeyWrite(c->db,c->argv[1]);
4971 dstset = lookupKeyWrite(c->db,c->argv[2]);
4972
4973 /* If the source key does not exist return 0, if it's of the wrong type
4974 * raise an error */
4975 if (srcset == NULL || srcset->type != REDIS_SET) {
4976 addReply(c, srcset ? shared.wrongtypeerr : shared.czero);
4977 return;
4978 }
4979 /* Error if the destination key is not a set as well */
4980 if (dstset && dstset->type != REDIS_SET) {
4981 addReply(c,shared.wrongtypeerr);
4982 return;
4983 }
4984 /* Remove the element from the source set */
4985 if (dictDelete(srcset->ptr,c->argv[3]) == DICT_ERR) {
4986 /* Key not found in the src set! return zero */
4987 addReply(c,shared.czero);
4988 return;
4989 }
4990 if (dictSize((dict*)srcset->ptr) == 0 && srcset != dstset)
4991 deleteKey(c->db,c->argv[1]);
4992 server.dirty++;
4993 /* Add the element to the destination set */
4994 if (!dstset) {
4995 dstset = createSetObject();
4996 dictAdd(c->db->dict,c->argv[2],dstset);
4997 incrRefCount(c->argv[2]);
4998 }
4999 if (dictAdd(dstset->ptr,c->argv[3],NULL) == DICT_OK)
5000 incrRefCount(c->argv[3]);
5001 addReply(c,shared.cone);
5002 }
5003
5004 static void sismemberCommand(redisClient *c) {
5005 robj *set;
5006
5007 if ((set = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
5008 checkType(c,set,REDIS_SET)) return;
5009
5010 if (dictFind(set->ptr,c->argv[2]))
5011 addReply(c,shared.cone);
5012 else
5013 addReply(c,shared.czero);
5014 }
5015
5016 static void scardCommand(redisClient *c) {
5017 robj *o;
5018 dict *s;
5019
5020 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
5021 checkType(c,o,REDIS_SET)) return;
5022
5023 s = o->ptr;
5024 addReplyUlong(c,dictSize(s));
5025 }
5026
5027 static void spopCommand(redisClient *c) {
5028 robj *set;
5029 dictEntry *de;
5030
5031 if ((set = lookupKeyWriteOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
5032 checkType(c,set,REDIS_SET)) return;
5033
5034 de = dictGetRandomKey(set->ptr);
5035 if (de == NULL) {
5036 addReply(c,shared.nullbulk);
5037 } else {
5038 robj *ele = dictGetEntryKey(de);
5039
5040 addReplyBulk(c,ele);
5041 dictDelete(set->ptr,ele);
5042 if (htNeedsResize(set->ptr)) dictResize(set->ptr);
5043 if (dictSize((dict*)set->ptr) == 0) deleteKey(c->db,c->argv[1]);
5044 server.dirty++;
5045 }
5046 }
5047
5048 static void srandmemberCommand(redisClient *c) {
5049 robj *set;
5050 dictEntry *de;
5051
5052 if ((set = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
5053 checkType(c,set,REDIS_SET)) return;
5054
5055 de = dictGetRandomKey(set->ptr);
5056 if (de == NULL) {
5057 addReply(c,shared.nullbulk);
5058 } else {
5059 robj *ele = dictGetEntryKey(de);
5060
5061 addReplyBulk(c,ele);
5062 }
5063 }
5064
5065 static int qsortCompareSetsByCardinality(const void *s1, const void *s2) {
5066 dict **d1 = (void*) s1, **d2 = (void*) s2;
5067
5068 return dictSize(*d1)-dictSize(*d2);
5069 }
5070
5071 static void sinterGenericCommand(redisClient *c, robj **setskeys, unsigned long setsnum, robj *dstkey) {
5072 dict **dv = zmalloc(sizeof(dict*)*setsnum);
5073 dictIterator *di;
5074 dictEntry *de;
5075 robj *lenobj = NULL, *dstset = NULL;
5076 unsigned long j, cardinality = 0;
5077
5078 for (j = 0; j < setsnum; j++) {
5079 robj *setobj;
5080
5081 setobj = dstkey ?
5082 lookupKeyWrite(c->db,setskeys[j]) :
5083 lookupKeyRead(c->db,setskeys[j]);
5084 if (!setobj) {
5085 zfree(dv);
5086 if (dstkey) {
5087 if (deleteKey(c->db,dstkey))
5088 server.dirty++;
5089 addReply(c,shared.czero);
5090 } else {
5091 addReply(c,shared.emptymultibulk);
5092 }
5093 return;
5094 }
5095 if (setobj->type != REDIS_SET) {
5096 zfree(dv);
5097 addReply(c,shared.wrongtypeerr);
5098 return;
5099 }
5100 dv[j] = setobj->ptr;
5101 }
5102 /* Sort sets from the smallest to largest, this will improve our
5103 * algorithm's performace */
5104 qsort(dv,setsnum,sizeof(dict*),qsortCompareSetsByCardinality);
5105
5106 /* The first thing we should output is the total number of elements...
5107 * since this is a multi-bulk write, but at this stage we don't know
5108 * the intersection set size, so we use a trick, append an empty object
5109 * to the output list and save the pointer to later modify it with the
5110 * right length */
5111 if (!dstkey) {
5112 lenobj = createObject(REDIS_STRING,NULL);
5113 addReply(c,lenobj);
5114 decrRefCount(lenobj);
5115 } else {
5116 /* If we have a target key where to store the resulting set
5117 * create this key with an empty set inside */
5118 dstset = createSetObject();
5119 }
5120
5121 /* Iterate all the elements of the first (smallest) set, and test
5122 * the element against all the other sets, if at least one set does
5123 * not include the element it is discarded */
5124 di = dictGetIterator(dv[0]);
5125
5126 while((de = dictNext(di)) != NULL) {
5127 robj *ele;
5128
5129 for (j = 1; j < setsnum; j++)
5130 if (dictFind(dv[j],dictGetEntryKey(de)) == NULL) break;
5131 if (j != setsnum)
5132 continue; /* at least one set does not contain the member */
5133 ele = dictGetEntryKey(de);
5134 if (!dstkey) {
5135 addReplyBulk(c,ele);
5136 cardinality++;
5137 } else {
5138 dictAdd(dstset->ptr,ele,NULL);
5139 incrRefCount(ele);
5140 }
5141 }
5142 dictReleaseIterator(di);
5143
5144 if (dstkey) {
5145 /* Store the resulting set into the target, if the intersection
5146 * is not an empty set. */
5147 deleteKey(c->db,dstkey);
5148 if (dictSize((dict*)dstset->ptr) > 0) {
5149 dictAdd(c->db->dict,dstkey,dstset);
5150 incrRefCount(dstkey);
5151 addReplyLong(c,dictSize((dict*)dstset->ptr));
5152 } else {
5153 decrRefCount(dstset);
5154 addReply(c,shared.czero);
5155 }
5156 server.dirty++;
5157 } else {
5158 lenobj->ptr = sdscatprintf(sdsempty(),"*%lu\r\n",cardinality);
5159 }
5160 zfree(dv);
5161 }
5162
5163 static void sinterCommand(redisClient *c) {
5164 sinterGenericCommand(c,c->argv+1,c->argc-1,NULL);
5165 }
5166
5167 static void sinterstoreCommand(redisClient *c) {
5168 sinterGenericCommand(c,c->argv+2,c->argc-2,c->argv[1]);
5169 }
5170
5171 #define REDIS_OP_UNION 0
5172 #define REDIS_OP_DIFF 1
5173 #define REDIS_OP_INTER 2
5174
5175 static void sunionDiffGenericCommand(redisClient *c, robj **setskeys, int setsnum, robj *dstkey, int op) {
5176 dict **dv = zmalloc(sizeof(dict*)*setsnum);
5177 dictIterator *di;
5178 dictEntry *de;
5179 robj *dstset = NULL;
5180 int j, cardinality = 0;
5181
5182 for (j = 0; j < setsnum; j++) {
5183 robj *setobj;
5184
5185 setobj = dstkey ?
5186 lookupKeyWrite(c->db,setskeys[j]) :
5187 lookupKeyRead(c->db,setskeys[j]);
5188 if (!setobj) {
5189 dv[j] = NULL;
5190 continue;
5191 }
5192 if (setobj->type != REDIS_SET) {
5193 zfree(dv);
5194 addReply(c,shared.wrongtypeerr);
5195 return;
5196 }
5197 dv[j] = setobj->ptr;
5198 }
5199
5200 /* We need a temp set object to store our union. If the dstkey
5201 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
5202 * this set object will be the resulting object to set into the target key*/
5203 dstset = createSetObject();
5204
5205 /* Iterate all the elements of all the sets, add every element a single
5206 * time to the result set */
5207 for (j = 0; j < setsnum; j++) {
5208 if (op == REDIS_OP_DIFF && j == 0 && !dv[j]) break; /* result set is empty */
5209 if (!dv[j]) continue; /* non existing keys are like empty sets */
5210
5211 di = dictGetIterator(dv[j]);
5212
5213 while((de = dictNext(di)) != NULL) {
5214 robj *ele;
5215
5216 /* dictAdd will not add the same element multiple times */
5217 ele = dictGetEntryKey(de);
5218 if (op == REDIS_OP_UNION || j == 0) {
5219 if (dictAdd(dstset->ptr,ele,NULL) == DICT_OK) {
5220 incrRefCount(ele);
5221 cardinality++;
5222 }
5223 } else if (op == REDIS_OP_DIFF) {
5224 if (dictDelete(dstset->ptr,ele) == DICT_OK) {
5225 cardinality--;
5226 }
5227 }
5228 }
5229 dictReleaseIterator(di);
5230
5231 /* result set is empty? Exit asap. */
5232 if (op == REDIS_OP_DIFF && cardinality == 0) break;
5233 }
5234
5235 /* Output the content of the resulting set, if not in STORE mode */
5236 if (!dstkey) {
5237 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",cardinality));
5238 di = dictGetIterator(dstset->ptr);
5239 while((de = dictNext(di)) != NULL) {
5240 robj *ele;
5241
5242 ele = dictGetEntryKey(de);
5243 addReplyBulk(c,ele);
5244 }
5245 dictReleaseIterator(di);
5246 decrRefCount(dstset);
5247 } else {
5248 /* If we have a target key where to store the resulting set
5249 * create this key with the result set inside */
5250 deleteKey(c->db,dstkey);
5251 if (dictSize((dict*)dstset->ptr) > 0) {
5252 dictAdd(c->db->dict,dstkey,dstset);
5253 incrRefCount(dstkey);
5254 addReplyLong(c,dictSize((dict*)dstset->ptr));
5255 } else {
5256 decrRefCount(dstset);
5257 addReply(c,shared.czero);
5258 }
5259 server.dirty++;
5260 }
5261 zfree(dv);
5262 }
5263
5264 static void sunionCommand(redisClient *c) {
5265 sunionDiffGenericCommand(c,c->argv+1,c->argc-1,NULL,REDIS_OP_UNION);
5266 }
5267
5268 static void sunionstoreCommand(redisClient *c) {
5269 sunionDiffGenericCommand(c,c->argv+2,c->argc-2,c->argv[1],REDIS_OP_UNION);
5270 }
5271
5272 static void sdiffCommand(redisClient *c) {
5273 sunionDiffGenericCommand(c,c->argv+1,c->argc-1,NULL,REDIS_OP_DIFF);
5274 }
5275
5276 static void sdiffstoreCommand(redisClient *c) {
5277 sunionDiffGenericCommand(c,c->argv+2,c->argc-2,c->argv[1],REDIS_OP_DIFF);
5278 }
5279
5280 /* ==================================== ZSets =============================== */
5281
5282 /* ZSETs are ordered sets using two data structures to hold the same elements
5283 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
5284 * data structure.
5285 *
5286 * The elements are added to an hash table mapping Redis objects to scores.
5287 * At the same time the elements are added to a skip list mapping scores
5288 * to Redis objects (so objects are sorted by scores in this "view"). */
5289
5290 /* This skiplist implementation is almost a C translation of the original
5291 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
5292 * Alternative to Balanced Trees", modified in three ways:
5293 * a) this implementation allows for repeated values.
5294 * b) the comparison is not just by key (our 'score') but by satellite data.
5295 * c) there is a back pointer, so it's a doubly linked list with the back
5296 * pointers being only at "level 1". This allows to traverse the list
5297 * from tail to head, useful for ZREVRANGE. */
5298
5299 static zskiplistNode *zslCreateNode(int level, double score, robj *obj) {
5300 zskiplistNode *zn = zmalloc(sizeof(*zn));
5301
5302 zn->forward = zmalloc(sizeof(zskiplistNode*) * level);
5303 if (level > 0)
5304 zn->span = zmalloc(sizeof(unsigned int) * (level - 1));
5305 zn->score = score;
5306 zn->obj = obj;
5307 return zn;
5308 }
5309
5310 static zskiplist *zslCreate(void) {
5311 int j;
5312 zskiplist *zsl;
5313
5314 zsl = zmalloc(sizeof(*zsl));
5315 zsl->level = 1;
5316 zsl->length = 0;
5317 zsl->header = zslCreateNode(ZSKIPLIST_MAXLEVEL,0,NULL);
5318 for (j = 0; j < ZSKIPLIST_MAXLEVEL; j++) {
5319 zsl->header->forward[j] = NULL;
5320
5321 /* span has space for ZSKIPLIST_MAXLEVEL-1 elements */
5322 if (j < ZSKIPLIST_MAXLEVEL-1)
5323 zsl->header->span[j] = 0;
5324 }
5325 zsl->header->backward = NULL;
5326 zsl->tail = NULL;
5327 return zsl;
5328 }
5329
5330 static void zslFreeNode(zskiplistNode *node) {
5331 decrRefCount(node->obj);
5332 zfree(node->forward);
5333 zfree(node->span);
5334 zfree(node);
5335 }
5336
5337 static void zslFree(zskiplist *zsl) {
5338 zskiplistNode *node = zsl->header->forward[0], *next;
5339
5340 zfree(zsl->header->forward);
5341 zfree(zsl->header->span);
5342 zfree(zsl->header);
5343 while(node) {
5344 next = node->forward[0];
5345 zslFreeNode(node);
5346 node = next;
5347 }
5348 zfree(zsl);
5349 }
5350
5351 static int zslRandomLevel(void) {
5352 int level = 1;
5353 while ((random()&0xFFFF) < (ZSKIPLIST_P * 0xFFFF))
5354 level += 1;
5355 return (level<ZSKIPLIST_MAXLEVEL) ? level : ZSKIPLIST_MAXLEVEL;
5356 }
5357
5358 static void zslInsert(zskiplist *zsl, double score, robj *obj) {
5359 zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;
5360 unsigned int rank[ZSKIPLIST_MAXLEVEL];
5361 int i, level;
5362
5363 x = zsl->header;
5364 for (i = zsl->level-1; i >= 0; i--) {
5365 /* store rank that is crossed to reach the insert position */
5366 rank[i] = i == (zsl->level-1) ? 0 : rank[i+1];
5367
5368 while (x->forward[i] &&
5369 (x->forward[i]->score < score ||
5370 (x->forward[i]->score == score &&
5371 compareStringObjects(x->forward[i]->obj,obj) < 0))) {
5372 rank[i] += i > 0 ? x->span[i-1] : 1;
5373 x = x->forward[i];
5374 }
5375 update[i] = x;
5376 }
5377 /* we assume the key is not already inside, since we allow duplicated
5378 * scores, and the re-insertion of score and redis object should never
5379 * happpen since the caller of zslInsert() should test in the hash table
5380 * if the element is already inside or not. */
5381 level = zslRandomLevel();
5382 if (level > zsl->level) {
5383 for (i = zsl->level; i < level; i++) {
5384 rank[i] = 0;
5385 update[i] = zsl->header;
5386 update[i]->span[i-1] = zsl->length;
5387 }
5388 zsl->level = level;
5389 }
5390 x = zslCreateNode(level,score,obj);
5391 for (i = 0; i < level; i++) {
5392 x->forward[i] = update[i]->forward[i];
5393 update[i]->forward[i] = x;
5394
5395 /* update span covered by update[i] as x is inserted here */
5396 if (i > 0) {
5397 x->span[i-1] = update[i]->span[i-1] - (rank[0] - rank[i]);
5398 update[i]->span[i-1] = (rank[0] - rank[i]) + 1;
5399 }
5400 }
5401
5402 /* increment span for untouched levels */
5403 for (i = level; i < zsl->level; i++) {
5404 update[i]->span[i-1]++;
5405 }
5406
5407 x->backward = (update[0] == zsl->header) ? NULL : update[0];
5408 if (x->forward[0])
5409 x->forward[0]->backward = x;
5410 else
5411 zsl->tail = x;
5412 zsl->length++;
5413 }
5414
5415 /* Internal function used by zslDelete, zslDeleteByScore and zslDeleteByRank */
5416 void zslDeleteNode(zskiplist *zsl, zskiplistNode *x, zskiplistNode **update) {
5417 int i;
5418 for (i = 0; i < zsl->level; i++) {
5419 if (update[i]->forward[i] == x) {
5420 if (i > 0) {
5421 update[i]->span[i-1] += x->span[i-1] - 1;
5422 }
5423 update[i]->forward[i] = x->forward[i];
5424 } else {
5425 /* invariant: i > 0, because update[0]->forward[0]
5426 * is always equal to x */
5427 update[i]->span[i-1] -= 1;
5428 }
5429 }
5430 if (x->forward[0]) {
5431 x->forward[0]->backward = x->backward;
5432 } else {
5433 zsl->tail = x->backward;
5434 }
5435 while(zsl->level > 1 && zsl->header->forward[zsl->level-1] == NULL)
5436 zsl->level--;
5437 zsl->length--;
5438 }
5439
5440 /* Delete an element with matching score/object from the skiplist. */
5441 static int zslDelete(zskiplist *zsl, double score, robj *obj) {
5442 zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;
5443 int i;
5444
5445 x = zsl->header;
5446 for (i = zsl->level-1; i >= 0; i--) {
5447 while (x->forward[i] &&
5448 (x->forward[i]->score < score ||
5449 (x->forward[i]->score == score &&
5450 compareStringObjects(x->forward[i]->obj,obj) < 0)))
5451 x = x->forward[i];
5452 update[i] = x;
5453 }
5454 /* We may have multiple elements with the same score, what we need
5455 * is to find the element with both the right score and object. */
5456 x = x->forward[0];
5457 if (x && score == x->score && compareStringObjects(x->obj,obj) == 0) {
5458 zslDeleteNode(zsl, x, update);
5459 zslFreeNode(x);
5460 return 1;
5461 } else {
5462 return 0; /* not found */
5463 }
5464 return 0; /* not found */
5465 }
5466
5467 /* Delete all the elements with score between min and max from the skiplist.
5468 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
5469 * Note that this function takes the reference to the hash table view of the
5470 * sorted set, in order to remove the elements from the hash table too. */
5471 static unsigned long zslDeleteRangeByScore(zskiplist *zsl, double min, double max, dict *dict) {
5472 zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;
5473 unsigned long removed = 0;
5474 int i;
5475
5476 x = zsl->header;
5477 for (i = zsl->level-1; i >= 0; i--) {
5478 while (x->forward[i] && x->forward[i]->score < min)
5479 x = x->forward[i];
5480 update[i] = x;
5481 }
5482 /* We may have multiple elements with the same score, what we need
5483 * is to find the element with both the right score and object. */
5484 x = x->forward[0];
5485 while (x && x->score <= max) {
5486 zskiplistNode *next = x->forward[0];
5487 zslDeleteNode(zsl, x, update);
5488 dictDelete(dict,x->obj);
5489 zslFreeNode(x);
5490 removed++;
5491 x = next;
5492 }
5493 return removed; /* not found */
5494 }
5495
5496 /* Delete all the elements with rank between start and end from the skiplist.
5497 * Start and end are inclusive. Note that start and end need to be 1-based */
5498 static unsigned long zslDeleteRangeByRank(zskiplist *zsl, unsigned int start, unsigned int end, dict *dict) {
5499 zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;
5500 unsigned long traversed = 0, removed = 0;
5501 int i;
5502
5503 x = zsl->header;
5504 for (i = zsl->level-1; i >= 0; i--) {
5505 while (x->forward[i] && (traversed + (i > 0 ? x->span[i-1] : 1)) < start) {
5506 traversed += i > 0 ? x->span[i-1] : 1;
5507 x = x->forward[i];
5508 }
5509 update[i] = x;
5510 }
5511
5512 traversed++;
5513 x = x->forward[0];
5514 while (x && traversed <= end) {
5515 zskiplistNode *next = x->forward[0];
5516 zslDeleteNode(zsl, x, update);
5517 dictDelete(dict,x->obj);
5518 zslFreeNode(x);
5519 removed++;
5520 traversed++;
5521 x = next;
5522 }
5523 return removed;
5524 }
5525
5526 /* Find the first node having a score equal or greater than the specified one.
5527 * Returns NULL if there is no match. */
5528 static zskiplistNode *zslFirstWithScore(zskiplist *zsl, double score) {
5529 zskiplistNode *x;
5530 int i;
5531
5532 x = zsl->header;
5533 for (i = zsl->level-1; i >= 0; i--) {
5534 while (x->forward[i] && x->forward[i]->score < score)
5535 x = x->forward[i];
5536 }
5537 /* We may have multiple elements with the same score, what we need
5538 * is to find the element with both the right score and object. */
5539 return x->forward[0];
5540 }
5541
5542 /* Find the rank for an element by both score and key.
5543 * Returns 0 when the element cannot be found, rank otherwise.
5544 * Note that the rank is 1-based due to the span of zsl->header to the
5545 * first element. */
5546 static unsigned long zslGetRank(zskiplist *zsl, double score, robj *o) {
5547 zskiplistNode *x;
5548 unsigned long rank = 0;
5549 int i;
5550
5551 x = zsl->header;
5552 for (i = zsl->level-1; i >= 0; i--) {
5553 while (x->forward[i] &&
5554 (x->forward[i]->score < score ||
5555 (x->forward[i]->score == score &&
5556 compareStringObjects(x->forward[i]->obj,o) <= 0))) {
5557 rank += i > 0 ? x->span[i-1] : 1;
5558 x = x->forward[i];
5559 }
5560
5561 /* x might be equal to zsl->header, so test if obj is non-NULL */
5562 if (x->obj && compareStringObjects(x->obj,o) == 0) {
5563 return rank;
5564 }
5565 }
5566 return 0;
5567 }
5568
5569 /* Finds an element by its rank. The rank argument needs to be 1-based. */
5570 zskiplistNode* zslGetElementByRank(zskiplist *zsl, unsigned long rank) {
5571 zskiplistNode *x;
5572 unsigned long traversed = 0;
5573 int i;
5574
5575 x = zsl->header;
5576 for (i = zsl->level-1; i >= 0; i--) {
5577 while (x->forward[i] && (traversed + (i>0 ? x->span[i-1] : 1)) <= rank)
5578 {
5579 traversed += i > 0 ? x->span[i-1] : 1;
5580 x = x->forward[i];
5581 }
5582 if (traversed == rank) {
5583 return x;
5584 }
5585 }
5586 return NULL;
5587 }
5588
5589 /* The actual Z-commands implementations */
5590
5591 /* This generic command implements both ZADD and ZINCRBY.
5592 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
5593 * the increment if the operation is a ZINCRBY (doincrement == 1). */
5594 static void zaddGenericCommand(redisClient *c, robj *key, robj *ele, double scoreval, int doincrement) {
5595 robj *zsetobj;
5596 zset *zs;
5597 double *score;
5598
5599 zsetobj = lookupKeyWrite(c->db,key);
5600 if (zsetobj == NULL) {
5601 zsetobj = createZsetObject();
5602 dictAdd(c->db->dict,key,zsetobj);
5603 incrRefCount(key);
5604 } else {
5605 if (zsetobj->type != REDIS_ZSET) {
5606 addReply(c,shared.wrongtypeerr);
5607 return;
5608 }
5609 }
5610 zs = zsetobj->ptr;
5611
5612 /* Ok now since we implement both ZADD and ZINCRBY here the code
5613 * needs to handle the two different conditions. It's all about setting
5614 * '*score', that is, the new score to set, to the right value. */
5615 score = zmalloc(sizeof(double));
5616 if (doincrement) {
5617 dictEntry *de;
5618
5619 /* Read the old score. If the element was not present starts from 0 */
5620 de = dictFind(zs->dict,ele);
5621 if (de) {
5622 double *oldscore = dictGetEntryVal(de);
5623 *score = *oldscore + scoreval;
5624 } else {
5625 *score = scoreval;
5626 }
5627 } else {
5628 *score = scoreval;
5629 }
5630
5631 /* What follows is a simple remove and re-insert operation that is common
5632 * to both ZADD and ZINCRBY... */
5633 if (dictAdd(zs->dict,ele,score) == DICT_OK) {
5634 /* case 1: New element */
5635 incrRefCount(ele); /* added to hash */
5636 zslInsert(zs->zsl,*score,ele);
5637 incrRefCount(ele); /* added to skiplist */
5638 server.dirty++;
5639 if (doincrement)
5640 addReplyDouble(c,*score);
5641 else
5642 addReply(c,shared.cone);
5643 } else {
5644 dictEntry *de;
5645 double *oldscore;
5646
5647 /* case 2: Score update operation */
5648 de = dictFind(zs->dict,ele);
5649 redisAssert(de != NULL);
5650 oldscore = dictGetEntryVal(de);
5651 if (*score != *oldscore) {
5652 int deleted;
5653
5654 /* Remove and insert the element in the skip list with new score */
5655 deleted = zslDelete(zs->zsl,*oldscore,ele);
5656 redisAssert(deleted != 0);
5657 zslInsert(zs->zsl,*score,ele);
5658 incrRefCount(ele);
5659 /* Update the score in the hash table */
5660 dictReplace(zs->dict,ele,score);
5661 server.dirty++;
5662 } else {
5663 zfree(score);
5664 }
5665 if (doincrement)
5666 addReplyDouble(c,*score);
5667 else
5668 addReply(c,shared.czero);
5669 }
5670 }
5671
5672 static void zaddCommand(redisClient *c) {
5673 double scoreval;
5674
5675 if (getDoubleFromObjectOrReply(c, c->argv[2], &scoreval, NULL) != REDIS_OK) return;
5676 zaddGenericCommand(c,c->argv[1],c->argv[3],scoreval,0);
5677 }
5678
5679 static void zincrbyCommand(redisClient *c) {
5680 double scoreval;
5681
5682 if (getDoubleFromObjectOrReply(c, c->argv[2], &scoreval, NULL) != REDIS_OK) return;
5683 zaddGenericCommand(c,c->argv[1],c->argv[3],scoreval,1);
5684 }
5685
5686 static void zremCommand(redisClient *c) {
5687 robj *zsetobj;
5688 zset *zs;
5689 dictEntry *de;
5690 double *oldscore;
5691 int deleted;
5692
5693 if ((zsetobj = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
5694 checkType(c,zsetobj,REDIS_ZSET)) return;
5695
5696 zs = zsetobj->ptr;
5697 de = dictFind(zs->dict,c->argv[2]);
5698 if (de == NULL) {
5699 addReply(c,shared.czero);
5700 return;
5701 }
5702 /* Delete from the skiplist */
5703 oldscore = dictGetEntryVal(de);
5704 deleted = zslDelete(zs->zsl,*oldscore,c->argv[2]);
5705 redisAssert(deleted != 0);
5706
5707 /* Delete from the hash table */
5708 dictDelete(zs->dict,c->argv[2]);
5709 if (htNeedsResize(zs->dict)) dictResize(zs->dict);
5710 if (dictSize(zs->dict) == 0) deleteKey(c->db,c->argv[1]);
5711 server.dirty++;
5712 addReply(c,shared.cone);
5713 }
5714
5715 static void zremrangebyscoreCommand(redisClient *c) {
5716 double min;
5717 double max;
5718 long deleted;
5719 robj *zsetobj;
5720 zset *zs;
5721
5722 if ((getDoubleFromObjectOrReply(c, c->argv[2], &min, NULL) != REDIS_OK) ||
5723 (getDoubleFromObjectOrReply(c, c->argv[3], &max, NULL) != REDIS_OK)) return;
5724
5725 if ((zsetobj = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
5726 checkType(c,zsetobj,REDIS_ZSET)) return;
5727
5728 zs = zsetobj->ptr;
5729 deleted = zslDeleteRangeByScore(zs->zsl,min,max,zs->dict);
5730 if (htNeedsResize(zs->dict)) dictResize(zs->dict);
5731 if (dictSize(zs->dict) == 0) deleteKey(c->db,c->argv[1]);
5732 server.dirty += deleted;
5733 addReplyLong(c,deleted);
5734 }
5735
5736 static void zremrangebyrankCommand(redisClient *c) {
5737 long start;
5738 long end;
5739 int llen;
5740 long deleted;
5741 robj *zsetobj;
5742 zset *zs;
5743
5744 if ((getLongFromObjectOrReply(c, c->argv[2], &start, NULL) != REDIS_OK) ||
5745 (getLongFromObjectOrReply(c, c->argv[3], &end, NULL) != REDIS_OK)) return;
5746
5747 if ((zsetobj = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
5748 checkType(c,zsetobj,REDIS_ZSET)) return;
5749 zs = zsetobj->ptr;
5750 llen = zs->zsl->length;
5751
5752 /* convert negative indexes */
5753 if (start < 0) start = llen+start;
5754 if (end < 0) end = llen+end;
5755 if (start < 0) start = 0;
5756 if (end < 0) end = 0;
5757
5758 /* indexes sanity checks */
5759 if (start > end || start >= llen) {
5760 addReply(c,shared.czero);
5761 return;
5762 }
5763 if (end >= llen) end = llen-1;
5764
5765 /* increment start and end because zsl*Rank functions
5766 * use 1-based rank */
5767 deleted = zslDeleteRangeByRank(zs->zsl,start+1,end+1,zs->dict);
5768 if (htNeedsResize(zs->dict)) dictResize(zs->dict);
5769 if (dictSize(zs->dict) == 0) deleteKey(c->db,c->argv[1]);
5770 server.dirty += deleted;
5771 addReplyLong(c, deleted);
5772 }
5773
5774 typedef struct {
5775 dict *dict;
5776 double weight;
5777 } zsetopsrc;
5778
5779 static int qsortCompareZsetopsrcByCardinality(const void *s1, const void *s2) {
5780 zsetopsrc *d1 = (void*) s1, *d2 = (void*) s2;
5781 unsigned long size1, size2;
5782 size1 = d1->dict ? dictSize(d1->dict) : 0;
5783 size2 = d2->dict ? dictSize(d2->dict) : 0;
5784 return size1 - size2;
5785 }
5786
5787 #define REDIS_AGGR_SUM 1
5788 #define REDIS_AGGR_MIN 2
5789 #define REDIS_AGGR_MAX 3
5790
5791 inline static void zunionInterAggregate(double *target, double val, int aggregate) {
5792 if (aggregate == REDIS_AGGR_SUM) {
5793 *target = *target + val;
5794 } else if (aggregate == REDIS_AGGR_MIN) {
5795 *target = val < *target ? val : *target;
5796 } else if (aggregate == REDIS_AGGR_MAX) {
5797 *target = val > *target ? val : *target;
5798 } else {
5799 /* safety net */
5800 redisPanic("Unknown ZUNION/INTER aggregate type");
5801 }
5802 }
5803
5804 static void zunionInterGenericCommand(redisClient *c, robj *dstkey, int op) {
5805 int i, j, zsetnum;
5806 int aggregate = REDIS_AGGR_SUM;
5807 zsetopsrc *src;
5808 robj *dstobj;
5809 zset *dstzset;
5810 dictIterator *di;
5811 dictEntry *de;
5812
5813 /* expect zsetnum input keys to be given */
5814 zsetnum = atoi(c->argv[2]->ptr);
5815 if (zsetnum < 1) {
5816 addReplySds(c,sdsnew("-ERR at least 1 input key is needed for ZUNION/ZINTER\r\n"));
5817 return;
5818 }
5819
5820 /* test if the expected number of keys would overflow */
5821 if (3+zsetnum > c->argc) {
5822 addReply(c,shared.syntaxerr);
5823 return;
5824 }
5825
5826 /* read keys to be used for input */
5827 src = zmalloc(sizeof(zsetopsrc) * zsetnum);
5828 for (i = 0, j = 3; i < zsetnum; i++, j++) {
5829 robj *zsetobj = lookupKeyWrite(c->db,c->argv[j]);
5830 if (!zsetobj) {
5831 src[i].dict = NULL;
5832 } else {
5833 if (zsetobj->type != REDIS_ZSET) {
5834 zfree(src);
5835 addReply(c,shared.wrongtypeerr);
5836 return;
5837 }
5838 src[i].dict = ((zset*)zsetobj->ptr)->dict;
5839 }
5840
5841 /* default all weights to 1 */
5842 src[i].weight = 1.0;
5843 }
5844
5845 /* parse optional extra arguments */
5846 if (j < c->argc) {
5847 int remaining = c->argc - j;
5848
5849 while (remaining) {
5850 if (remaining >= (zsetnum + 1) && !strcasecmp(c->argv[j]->ptr,"weights")) {
5851 j++; remaining--;
5852 for (i = 0; i < zsetnum; i++, j++, remaining--) {
5853 if (getDoubleFromObjectOrReply(c, c->argv[j], &src[i].weight, NULL) != REDIS_OK)
5854 return;
5855 }
5856 } else if (remaining >= 2 && !strcasecmp(c->argv[j]->ptr,"aggregate")) {
5857 j++; remaining--;
5858 if (!strcasecmp(c->argv[j]->ptr,"sum")) {
5859 aggregate = REDIS_AGGR_SUM;
5860 } else if (!strcasecmp(c->argv[j]->ptr,"min")) {
5861 aggregate = REDIS_AGGR_MIN;
5862 } else if (!strcasecmp(c->argv[j]->ptr,"max")) {
5863 aggregate = REDIS_AGGR_MAX;
5864 } else {
5865 zfree(src);
5866 addReply(c,shared.syntaxerr);
5867 return;
5868 }
5869 j++; remaining--;
5870 } else {
5871 zfree(src);
5872 addReply(c,shared.syntaxerr);
5873 return;
5874 }
5875 }
5876 }
5877
5878 /* sort sets from the smallest to largest, this will improve our
5879 * algorithm's performance */
5880 qsort(src,zsetnum,sizeof(zsetopsrc), qsortCompareZsetopsrcByCardinality);
5881
5882 dstobj = createZsetObject();
5883 dstzset = dstobj->ptr;
5884
5885 if (op == REDIS_OP_INTER) {
5886 /* skip going over all entries if the smallest zset is NULL or empty */
5887 if (src[0].dict && dictSize(src[0].dict) > 0) {
5888 /* precondition: as src[0].dict is non-empty and the zsets are ordered
5889 * from small to large, all src[i > 0].dict are non-empty too */
5890 di = dictGetIterator(src[0].dict);
5891 while((de = dictNext(di)) != NULL) {
5892 double *score = zmalloc(sizeof(double)), value;
5893 *score = src[0].weight * (*(double*)dictGetEntryVal(de));
5894
5895 for (j = 1; j < zsetnum; j++) {
5896 dictEntry *other = dictFind(src[j].dict,dictGetEntryKey(de));
5897 if (other) {
5898 value = src[j].weight * (*(double*)dictGetEntryVal(other));
5899 zunionInterAggregate(score, value, aggregate);
5900 } else {
5901 break;
5902 }
5903 }
5904
5905 /* skip entry when not present in every source dict */
5906 if (j != zsetnum) {
5907 zfree(score);
5908 } else {
5909 robj *o = dictGetEntryKey(de);
5910 dictAdd(dstzset->dict,o,score);
5911 incrRefCount(o); /* added to dictionary */
5912 zslInsert(dstzset->zsl,*score,o);
5913 incrRefCount(o); /* added to skiplist */
5914 }
5915 }
5916 dictReleaseIterator(di);
5917 }
5918 } else if (op == REDIS_OP_UNION) {
5919 for (i = 0; i < zsetnum; i++) {
5920 if (!src[i].dict) continue;
5921
5922 di = dictGetIterator(src[i].dict);
5923 while((de = dictNext(di)) != NULL) {
5924 /* skip key when already processed */
5925 if (dictFind(dstzset->dict,dictGetEntryKey(de)) != NULL) continue;
5926
5927 double *score = zmalloc(sizeof(double)), value;
5928 *score = src[i].weight * (*(double*)dictGetEntryVal(de));
5929
5930 /* because the zsets are sorted by size, its only possible
5931 * for sets at larger indices to hold this entry */
5932 for (j = (i+1); j < zsetnum; j++) {
5933 dictEntry *other = dictFind(src[j].dict,dictGetEntryKey(de));
5934 if (other) {
5935 value = src[j].weight * (*(double*)dictGetEntryVal(other));
5936 zunionInterAggregate(score, value, aggregate);
5937 }
5938 }
5939
5940 robj *o = dictGetEntryKey(de);
5941 dictAdd(dstzset->dict,o,score);
5942 incrRefCount(o); /* added to dictionary */
5943 zslInsert(dstzset->zsl,*score,o);
5944 incrRefCount(o); /* added to skiplist */
5945 }
5946 dictReleaseIterator(di);
5947 }
5948 } else {
5949 /* unknown operator */
5950 redisAssert(op == REDIS_OP_INTER || op == REDIS_OP_UNION);
5951 }
5952
5953 deleteKey(c->db,dstkey);
5954 if (dstzset->zsl->length) {
5955 dictAdd(c->db->dict,dstkey,dstobj);
5956 incrRefCount(dstkey);
5957 addReplyLong(c, dstzset->zsl->length);
5958 server.dirty++;
5959 } else {
5960 decrRefCount(dstobj);
5961 addReply(c, shared.czero);
5962 }
5963 zfree(src);
5964 }
5965
5966 static void zunionCommand(redisClient *c) {
5967 zunionInterGenericCommand(c,c->argv[1], REDIS_OP_UNION);
5968 }
5969
5970 static void zinterCommand(redisClient *c) {
5971 zunionInterGenericCommand(c,c->argv[1], REDIS_OP_INTER);
5972 }
5973
5974 static void zrangeGenericCommand(redisClient *c, int reverse) {
5975 robj *o;
5976 long start;
5977 long end;
5978 int withscores = 0;
5979 int llen;
5980 int rangelen, j;
5981 zset *zsetobj;
5982 zskiplist *zsl;
5983 zskiplistNode *ln;
5984 robj *ele;
5985
5986 if ((getLongFromObjectOrReply(c, c->argv[2], &start, NULL) != REDIS_OK) ||
5987 (getLongFromObjectOrReply(c, c->argv[3], &end, NULL) != REDIS_OK)) return;
5988
5989 if (c->argc == 5 && !strcasecmp(c->argv[4]->ptr,"withscores")) {
5990 withscores = 1;
5991 } else if (c->argc >= 5) {
5992 addReply(c,shared.syntaxerr);
5993 return;
5994 }
5995
5996 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.emptymultibulk)) == NULL
5997 || checkType(c,o,REDIS_ZSET)) return;
5998 zsetobj = o->ptr;
5999 zsl = zsetobj->zsl;
6000 llen = zsl->length;
6001
6002 /* convert negative indexes */
6003 if (start < 0) start = llen+start;
6004 if (end < 0) end = llen+end;
6005 if (start < 0) start = 0;
6006 if (end < 0) end = 0;
6007
6008 /* indexes sanity checks */
6009 if (start > end || start >= llen) {
6010 /* Out of range start or start > end result in empty list */
6011 addReply(c,shared.emptymultibulk);
6012 return;
6013 }
6014 if (end >= llen) end = llen-1;
6015 rangelen = (end-start)+1;
6016
6017 /* check if starting point is trivial, before searching
6018 * the element in log(N) time */
6019 if (reverse) {
6020 ln = start == 0 ? zsl->tail : zslGetElementByRank(zsl, llen-start);
6021 } else {
6022 ln = start == 0 ?
6023 zsl->header->forward[0] : zslGetElementByRank(zsl, start+1);
6024 }
6025
6026 /* Return the result in form of a multi-bulk reply */
6027 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",
6028 withscores ? (rangelen*2) : rangelen));
6029 for (j = 0; j < rangelen; j++) {
6030 ele = ln->obj;
6031 addReplyBulk(c,ele);
6032 if (withscores)
6033 addReplyDouble(c,ln->score);
6034 ln = reverse ? ln->backward : ln->forward[0];
6035 }
6036 }
6037
6038 static void zrangeCommand(redisClient *c) {
6039 zrangeGenericCommand(c,0);
6040 }
6041
6042 static void zrevrangeCommand(redisClient *c) {
6043 zrangeGenericCommand(c,1);
6044 }
6045
6046 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
6047 * If justcount is non-zero, just the count is returned. */
6048 static void genericZrangebyscoreCommand(redisClient *c, int justcount) {
6049 robj *o;
6050 double min, max;
6051 int minex = 0, maxex = 0; /* are min or max exclusive? */
6052 int offset = 0, limit = -1;
6053 int withscores = 0;
6054 int badsyntax = 0;
6055
6056 /* Parse the min-max interval. If one of the values is prefixed
6057 * by the "(" character, it's considered "open". For instance
6058 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
6059 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
6060 if (((char*)c->argv[2]->ptr)[0] == '(') {
6061 min = strtod((char*)c->argv[2]->ptr+1,NULL);
6062 minex = 1;
6063 } else {
6064 min = strtod(c->argv[2]->ptr,NULL);
6065 }
6066 if (((char*)c->argv[3]->ptr)[0] == '(') {
6067 max = strtod((char*)c->argv[3]->ptr+1,NULL);
6068 maxex = 1;
6069 } else {
6070 max = strtod(c->argv[3]->ptr,NULL);
6071 }
6072
6073 /* Parse "WITHSCORES": note that if the command was called with
6074 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
6075 * enter the following paths to parse WITHSCORES and LIMIT. */
6076 if (c->argc == 5 || c->argc == 8) {
6077 if (strcasecmp(c->argv[c->argc-1]->ptr,"withscores") == 0)
6078 withscores = 1;
6079 else
6080 badsyntax = 1;
6081 }
6082 if (c->argc != (4 + withscores) && c->argc != (7 + withscores))
6083 badsyntax = 1;
6084 if (badsyntax) {
6085 addReplySds(c,
6086 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
6087 return;
6088 }
6089
6090 /* Parse "LIMIT" */
6091 if (c->argc == (7 + withscores) && strcasecmp(c->argv[4]->ptr,"limit")) {
6092 addReply(c,shared.syntaxerr);
6093 return;
6094 } else if (c->argc == (7 + withscores)) {
6095 offset = atoi(c->argv[5]->ptr);
6096 limit = atoi(c->argv[6]->ptr);
6097 if (offset < 0) offset = 0;
6098 }
6099
6100 /* Ok, lookup the key and get the range */
6101 o = lookupKeyRead(c->db,c->argv[1]);
6102 if (o == NULL) {
6103 addReply(c,justcount ? shared.czero : shared.emptymultibulk);
6104 } else {
6105 if (o->type != REDIS_ZSET) {
6106 addReply(c,shared.wrongtypeerr);
6107 } else {
6108 zset *zsetobj = o->ptr;
6109 zskiplist *zsl = zsetobj->zsl;
6110 zskiplistNode *ln;
6111 robj *ele, *lenobj = NULL;
6112 unsigned long rangelen = 0;
6113
6114 /* Get the first node with the score >= min, or with
6115 * score > min if 'minex' is true. */
6116 ln = zslFirstWithScore(zsl,min);
6117 while (minex && ln && ln->score == min) ln = ln->forward[0];
6118
6119 if (ln == NULL) {
6120 /* No element matching the speciifed interval */
6121 addReply(c,justcount ? shared.czero : shared.emptymultibulk);
6122 return;
6123 }
6124
6125 /* We don't know in advance how many matching elements there
6126 * are in the list, so we push this object that will represent
6127 * the multi-bulk length in the output buffer, and will "fix"
6128 * it later */
6129 if (!justcount) {
6130 lenobj = createObject(REDIS_STRING,NULL);
6131 addReply(c,lenobj);
6132 decrRefCount(lenobj);
6133 }
6134
6135 while(ln && (maxex ? (ln->score < max) : (ln->score <= max))) {
6136 if (offset) {
6137 offset--;
6138 ln = ln->forward[0];
6139 continue;
6140 }
6141 if (limit == 0) break;
6142 if (!justcount) {
6143 ele = ln->obj;
6144 addReplyBulk(c,ele);
6145 if (withscores)
6146 addReplyDouble(c,ln->score);
6147 }
6148 ln = ln->forward[0];
6149 rangelen++;
6150 if (limit > 0) limit--;
6151 }
6152 if (justcount) {
6153 addReplyLong(c,(long)rangelen);
6154 } else {
6155 lenobj->ptr = sdscatprintf(sdsempty(),"*%lu\r\n",
6156 withscores ? (rangelen*2) : rangelen);
6157 }
6158 }
6159 }
6160 }
6161
6162 static void zrangebyscoreCommand(redisClient *c) {
6163 genericZrangebyscoreCommand(c,0);
6164 }
6165
6166 static void zcountCommand(redisClient *c) {
6167 genericZrangebyscoreCommand(c,1);
6168 }
6169
6170 static void zcardCommand(redisClient *c) {
6171 robj *o;
6172 zset *zs;
6173
6174 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
6175 checkType(c,o,REDIS_ZSET)) return;
6176
6177 zs = o->ptr;
6178 addReplyUlong(c,zs->zsl->length);
6179 }
6180
6181 static void zscoreCommand(redisClient *c) {
6182 robj *o;
6183 zset *zs;
6184 dictEntry *de;
6185
6186 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
6187 checkType(c,o,REDIS_ZSET)) return;
6188
6189 zs = o->ptr;
6190 de = dictFind(zs->dict,c->argv[2]);
6191 if (!de) {
6192 addReply(c,shared.nullbulk);
6193 } else {
6194 double *score = dictGetEntryVal(de);
6195
6196 addReplyDouble(c,*score);
6197 }
6198 }
6199
6200 static void zrankGenericCommand(redisClient *c, int reverse) {
6201 robj *o;
6202 zset *zs;
6203 zskiplist *zsl;
6204 dictEntry *de;
6205 unsigned long rank;
6206 double *score;
6207
6208 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
6209 checkType(c,o,REDIS_ZSET)) return;
6210
6211 zs = o->ptr;
6212 zsl = zs->zsl;
6213 de = dictFind(zs->dict,c->argv[2]);
6214 if (!de) {
6215 addReply(c,shared.nullbulk);
6216 return;
6217 }
6218
6219 score = dictGetEntryVal(de);
6220 rank = zslGetRank(zsl, *score, c->argv[2]);
6221 if (rank) {
6222 if (reverse) {
6223 addReplyLong(c, zsl->length - rank);
6224 } else {
6225 addReplyLong(c, rank-1);
6226 }
6227 } else {
6228 addReply(c,shared.nullbulk);
6229 }
6230 }
6231
6232 static void zrankCommand(redisClient *c) {
6233 zrankGenericCommand(c, 0);
6234 }
6235
6236 static void zrevrankCommand(redisClient *c) {
6237 zrankGenericCommand(c, 1);
6238 }
6239
6240 /* ========================= Hashes utility functions ======================= */
6241 #define REDIS_HASH_KEY 1
6242 #define REDIS_HASH_VALUE 2
6243
6244 /* Check the length of a number of objects to see if we need to convert a
6245 * zipmap to a real hash. Note that we only check string encoded objects
6246 * as their string length can be queried in constant time. */
6247 static void hashTryConversion(robj *subject, robj **argv, int start, int end) {
6248 int i;
6249 if (subject->encoding != REDIS_ENCODING_ZIPMAP) return;
6250
6251 for (i = start; i <= end; i++) {
6252 if (argv[i]->encoding == REDIS_ENCODING_RAW &&
6253 sdslen(argv[i]->ptr) > server.hash_max_zipmap_value)
6254 {
6255 convertToRealHash(subject);
6256 return;
6257 }
6258 }
6259 }
6260
6261 /* Encode given objects in-place when the hash uses a dict. */
6262 static void hashTryObjectEncoding(robj *subject, robj **o1, robj **o2) {
6263 if (subject->encoding == REDIS_ENCODING_HT) {
6264 if (o1) *o1 = tryObjectEncoding(*o1);
6265 if (o2) *o2 = tryObjectEncoding(*o2);
6266 }
6267 }
6268
6269 /* Get the value from a hash identified by key. Returns either a string
6270 * object or NULL if the value cannot be found. The refcount of the object
6271 * is always increased by 1 when the value was found. */
6272 static robj *hashGet(robj *o, robj *key) {
6273 robj *value = NULL;
6274 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
6275 unsigned char *v;
6276 unsigned int vlen;
6277 key = getDecodedObject(key);
6278 if (zipmapGet(o->ptr,key->ptr,sdslen(key->ptr),&v,&vlen)) {
6279 value = createStringObject((char*)v,vlen);
6280 }
6281 decrRefCount(key);
6282 } else {
6283 dictEntry *de = dictFind(o->ptr,key);
6284 if (de != NULL) {
6285 value = dictGetEntryVal(de);
6286 incrRefCount(value);
6287 }
6288 }
6289 return value;
6290 }
6291
6292 /* Test if the key exists in the given hash. Returns 1 if the key
6293 * exists and 0 when it doesn't. */
6294 static int hashExists(robj *o, robj *key) {
6295 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
6296 key = getDecodedObject(key);
6297 if (zipmapExists(o->ptr,key->ptr,sdslen(key->ptr))) {
6298 decrRefCount(key);
6299 return 1;
6300 }
6301 decrRefCount(key);
6302 } else {
6303 if (dictFind(o->ptr,key) != NULL) {
6304 return 1;
6305 }
6306 }
6307 return 0;
6308 }
6309
6310 /* Add an element, discard the old if the key already exists.
6311 * Return 0 on insert and 1 on update. */
6312 static int hashSet(robj *o, robj *key, robj *value) {
6313 int update = 0;
6314 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
6315 key = getDecodedObject(key);
6316 value = getDecodedObject(value);
6317 o->ptr = zipmapSet(o->ptr,
6318 key->ptr,sdslen(key->ptr),
6319 value->ptr,sdslen(value->ptr), &update);
6320 decrRefCount(key);
6321 decrRefCount(value);
6322
6323 /* Check if the zipmap needs to be upgraded to a real hash table */
6324 if (zipmapLen(o->ptr) > server.hash_max_zipmap_entries)
6325 convertToRealHash(o);
6326 } else {
6327 if (dictReplace(o->ptr,key,value)) {
6328 /* Insert */
6329 incrRefCount(key);
6330 } else {
6331 /* Update */
6332 update = 1;
6333 }
6334 incrRefCount(value);
6335 }
6336 return update;
6337 }
6338
6339 /* Delete an element from a hash.
6340 * Return 1 on deleted and 0 on not found. */
6341 static int hashDelete(robj *o, robj *key) {
6342 int deleted = 0;
6343 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
6344 key = getDecodedObject(key);
6345 o->ptr = zipmapDel(o->ptr,key->ptr,sdslen(key->ptr), &deleted);
6346 decrRefCount(key);
6347 } else {
6348 deleted = dictDelete((dict*)o->ptr,key) == DICT_OK;
6349 /* Always check if the dictionary needs a resize after a delete. */
6350 if (deleted && htNeedsResize(o->ptr)) dictResize(o->ptr);
6351 }
6352 return deleted;
6353 }
6354
6355 /* Return the number of elements in a hash. */
6356 static unsigned long hashLength(robj *o) {
6357 return (o->encoding == REDIS_ENCODING_ZIPMAP) ?
6358 zipmapLen((unsigned char*)o->ptr) : dictSize((dict*)o->ptr);
6359 }
6360
6361 /* Structure to hold hash iteration abstration. Note that iteration over
6362 * hashes involves both fields and values. Because it is possible that
6363 * not both are required, store pointers in the iterator to avoid
6364 * unnecessary memory allocation for fields/values. */
6365 typedef struct {
6366 int encoding;
6367 unsigned char *zi;
6368 unsigned char *zk, *zv;
6369 unsigned int zklen, zvlen;
6370
6371 dictIterator *di;
6372 dictEntry *de;
6373 } hashIterator;
6374
6375 static hashIterator *hashInitIterator(robj *subject) {
6376 hashIterator *hi = zmalloc(sizeof(hashIterator));
6377 hi->encoding = subject->encoding;
6378 if (hi->encoding == REDIS_ENCODING_ZIPMAP) {
6379 hi->zi = zipmapRewind(subject->ptr);
6380 } else if (hi->encoding == REDIS_ENCODING_HT) {
6381 hi->di = dictGetIterator(subject->ptr);
6382 } else {
6383 redisAssert(NULL);
6384 }
6385 return hi;
6386 }
6387
6388 static void hashReleaseIterator(hashIterator *hi) {
6389 if (hi->encoding == REDIS_ENCODING_HT) {
6390 dictReleaseIterator(hi->di);
6391 }
6392 zfree(hi);
6393 }
6394
6395 /* Move to the next entry in the hash. Return REDIS_OK when the next entry
6396 * could be found and REDIS_ERR when the iterator reaches the end. */
6397 static int hashNext(hashIterator *hi) {
6398 if (hi->encoding == REDIS_ENCODING_ZIPMAP) {
6399 if ((hi->zi = zipmapNext(hi->zi, &hi->zk, &hi->zklen,
6400 &hi->zv, &hi->zvlen)) == NULL) return REDIS_ERR;
6401 } else {
6402 if ((hi->de = dictNext(hi->di)) == NULL) return REDIS_ERR;
6403 }
6404 return REDIS_OK;
6405 }
6406
6407 /* Get key or value object at current iteration position.
6408 * This increases the refcount of the field object by 1. */
6409 static robj *hashCurrent(hashIterator *hi, int what) {
6410 robj *o;
6411 if (hi->encoding == REDIS_ENCODING_ZIPMAP) {
6412 if (what & REDIS_HASH_KEY) {
6413 o = createStringObject((char*)hi->zk,hi->zklen);
6414 } else {
6415 o = createStringObject((char*)hi->zv,hi->zvlen);
6416 }
6417 } else {
6418 if (what & REDIS_HASH_KEY) {
6419 o = dictGetEntryKey(hi->de);
6420 } else {
6421 o = dictGetEntryVal(hi->de);
6422 }
6423 incrRefCount(o);
6424 }
6425 return o;
6426 }
6427
6428 static robj *hashLookupWriteOrCreate(redisClient *c, robj *key) {
6429 robj *o = lookupKeyWrite(c->db,key);
6430 if (o == NULL) {
6431 o = createHashObject();
6432 dictAdd(c->db->dict,key,o);
6433 incrRefCount(key);
6434 } else {
6435 if (o->type != REDIS_HASH) {
6436 addReply(c,shared.wrongtypeerr);
6437 return NULL;
6438 }
6439 }
6440 return o;
6441 }
6442
6443 /* ============================= Hash commands ============================== */
6444 static void hsetCommand(redisClient *c) {
6445 int update;
6446 robj *o;
6447
6448 if ((o = hashLookupWriteOrCreate(c,c->argv[1])) == NULL) return;
6449 hashTryConversion(o,c->argv,2,3);
6450 hashTryObjectEncoding(o,&c->argv[2], &c->argv[3]);
6451 update = hashSet(o,c->argv[2],c->argv[3]);
6452 addReply(c, update ? shared.czero : shared.cone);
6453 server.dirty++;
6454 }
6455
6456 static void hsetnxCommand(redisClient *c) {
6457 robj *o;
6458 if ((o = hashLookupWriteOrCreate(c,c->argv[1])) == NULL) return;
6459 hashTryConversion(o,c->argv,2,3);
6460
6461 if (hashExists(o, c->argv[2])) {
6462 addReply(c, shared.czero);
6463 } else {
6464 hashTryObjectEncoding(o,&c->argv[2], &c->argv[3]);
6465 hashSet(o,c->argv[2],c->argv[3]);
6466 addReply(c, shared.cone);
6467 server.dirty++;
6468 }
6469 }
6470
6471 static void hmsetCommand(redisClient *c) {
6472 int i;
6473 robj *o;
6474
6475 if ((c->argc % 2) == 1) {
6476 addReplySds(c,sdsnew("-ERR wrong number of arguments for HMSET\r\n"));
6477 return;
6478 }
6479
6480 if ((o = hashLookupWriteOrCreate(c,c->argv[1])) == NULL) return;
6481 hashTryConversion(o,c->argv,2,c->argc-1);
6482 for (i = 2; i < c->argc; i += 2) {
6483 hashTryObjectEncoding(o,&c->argv[i], &c->argv[i+1]);
6484 hashSet(o,c->argv[i],c->argv[i+1]);
6485 }
6486 addReply(c, shared.ok);
6487 server.dirty++;
6488 }
6489
6490 static void hincrbyCommand(redisClient *c) {
6491 long long value, incr;
6492 robj *o, *current, *new;
6493
6494 if (getLongLongFromObjectOrReply(c,c->argv[3],&incr,NULL) != REDIS_OK) return;
6495 if ((o = hashLookupWriteOrCreate(c,c->argv[1])) == NULL) return;
6496 if ((current = hashGet(o,c->argv[2])) != NULL) {
6497 if (getLongLongFromObjectOrReply(c,current,&value,
6498 "hash value is not an integer") != REDIS_OK) {
6499 decrRefCount(current);
6500 return;
6501 }
6502 decrRefCount(current);
6503 } else {
6504 value = 0;
6505 }
6506
6507 value += incr;
6508 new = createStringObjectFromLongLong(value);
6509 hashTryObjectEncoding(o,&c->argv[2],NULL);
6510 hashSet(o,c->argv[2],new);
6511 decrRefCount(new);
6512 addReplyLongLong(c,value);
6513 server.dirty++;
6514 }
6515
6516 static void hgetCommand(redisClient *c) {
6517 robj *o, *value;
6518 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
6519 checkType(c,o,REDIS_HASH)) return;
6520
6521 if ((value = hashGet(o,c->argv[2])) != NULL) {
6522 addReplyBulk(c,value);
6523 decrRefCount(value);
6524 } else {
6525 addReply(c,shared.nullbulk);
6526 }
6527 }
6528
6529 static void hmgetCommand(redisClient *c) {
6530 int i;
6531 robj *o, *value;
6532 o = lookupKeyRead(c->db,c->argv[1]);
6533 if (o != NULL && o->type != REDIS_HASH) {
6534 addReply(c,shared.wrongtypeerr);
6535 }
6536
6537 /* Note the check for o != NULL happens inside the loop. This is
6538 * done because objects that cannot be found are considered to be
6539 * an empty hash. The reply should then be a series of NULLs. */
6540 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",c->argc-2));
6541 for (i = 2; i < c->argc; i++) {
6542 if (o != NULL && (value = hashGet(o,c->argv[i])) != NULL) {
6543 addReplyBulk(c,value);
6544 decrRefCount(value);
6545 } else {
6546 addReply(c,shared.nullbulk);
6547 }
6548 }
6549 }
6550
6551 static void hdelCommand(redisClient *c) {
6552 robj *o;
6553 if ((o = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
6554 checkType(c,o,REDIS_HASH)) return;
6555
6556 if (hashDelete(o,c->argv[2])) {
6557 if (hashLength(o) == 0) deleteKey(c->db,c->argv[1]);
6558 addReply(c,shared.cone);
6559 server.dirty++;
6560 } else {
6561 addReply(c,shared.czero);
6562 }
6563 }
6564
6565 static void hlenCommand(redisClient *c) {
6566 robj *o;
6567 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
6568 checkType(c,o,REDIS_HASH)) return;
6569
6570 addReplyUlong(c,hashLength(o));
6571 }
6572
6573 static void genericHgetallCommand(redisClient *c, int flags) {
6574 robj *o, *lenobj, *obj;
6575 unsigned long count = 0;
6576 hashIterator *hi;
6577
6578 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.emptymultibulk)) == NULL
6579 || checkType(c,o,REDIS_HASH)) return;
6580
6581 lenobj = createObject(REDIS_STRING,NULL);
6582 addReply(c,lenobj);
6583 decrRefCount(lenobj);
6584
6585 hi = hashInitIterator(o);
6586 while (hashNext(hi) != REDIS_ERR) {
6587 if (flags & REDIS_HASH_KEY) {
6588 obj = hashCurrent(hi,REDIS_HASH_KEY);
6589 addReplyBulk(c,obj);
6590 decrRefCount(obj);
6591 count++;
6592 }
6593 if (flags & REDIS_HASH_VALUE) {
6594 obj = hashCurrent(hi,REDIS_HASH_VALUE);
6595 addReplyBulk(c,obj);
6596 decrRefCount(obj);
6597 count++;
6598 }
6599 }
6600 hashReleaseIterator(hi);
6601
6602 lenobj->ptr = sdscatprintf(sdsempty(),"*%lu\r\n",count);
6603 }
6604
6605 static void hkeysCommand(redisClient *c) {
6606 genericHgetallCommand(c,REDIS_HASH_KEY);
6607 }
6608
6609 static void hvalsCommand(redisClient *c) {
6610 genericHgetallCommand(c,REDIS_HASH_VALUE);
6611 }
6612
6613 static void hgetallCommand(redisClient *c) {
6614 genericHgetallCommand(c,REDIS_HASH_KEY|REDIS_HASH_VALUE);
6615 }
6616
6617 static void hexistsCommand(redisClient *c) {
6618 robj *o;
6619 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
6620 checkType(c,o,REDIS_HASH)) return;
6621
6622 addReply(c, hashExists(o,c->argv[2]) ? shared.cone : shared.czero);
6623 }
6624
6625 static void convertToRealHash(robj *o) {
6626 unsigned char *key, *val, *p, *zm = o->ptr;
6627 unsigned int klen, vlen;
6628 dict *dict = dictCreate(&hashDictType,NULL);
6629
6630 assert(o->type == REDIS_HASH && o->encoding != REDIS_ENCODING_HT);
6631 p = zipmapRewind(zm);
6632 while((p = zipmapNext(p,&key,&klen,&val,&vlen)) != NULL) {
6633 robj *keyobj, *valobj;
6634
6635 keyobj = createStringObject((char*)key,klen);
6636 valobj = createStringObject((char*)val,vlen);
6637 keyobj = tryObjectEncoding(keyobj);
6638 valobj = tryObjectEncoding(valobj);
6639 dictAdd(dict,keyobj,valobj);
6640 }
6641 o->encoding = REDIS_ENCODING_HT;
6642 o->ptr = dict;
6643 zfree(zm);
6644 }
6645
6646 /* ========================= Non type-specific commands ==================== */
6647
6648 static void flushdbCommand(redisClient *c) {
6649 server.dirty += dictSize(c->db->dict);
6650 dictEmpty(c->db->dict);
6651 dictEmpty(c->db->expires);
6652 addReply(c,shared.ok);
6653 }
6654
6655 static void flushallCommand(redisClient *c) {
6656 server.dirty += emptyDb();
6657 addReply(c,shared.ok);
6658 if (server.bgsavechildpid != -1) {
6659 kill(server.bgsavechildpid,SIGKILL);
6660 rdbRemoveTempFile(server.bgsavechildpid);
6661 }
6662 rdbSave(server.dbfilename);
6663 server.dirty++;
6664 }
6665
6666 static redisSortOperation *createSortOperation(int type, robj *pattern) {
6667 redisSortOperation *so = zmalloc(sizeof(*so));
6668 so->type = type;
6669 so->pattern = pattern;
6670 return so;
6671 }
6672
6673 /* Return the value associated to the key with a name obtained
6674 * substituting the first occurence of '*' in 'pattern' with 'subst'.
6675 * The returned object will always have its refcount increased by 1
6676 * when it is non-NULL. */
6677 static robj *lookupKeyByPattern(redisDb *db, robj *pattern, robj *subst) {
6678 char *p, *f;
6679 sds spat, ssub;
6680 robj keyobj, fieldobj, *o;
6681 int prefixlen, sublen, postfixlen, fieldlen;
6682 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
6683 struct {
6684 long len;
6685 long free;
6686 char buf[REDIS_SORTKEY_MAX+1];
6687 } keyname, fieldname;
6688
6689 /* If the pattern is "#" return the substitution object itself in order
6690 * to implement the "SORT ... GET #" feature. */
6691 spat = pattern->ptr;
6692 if (spat[0] == '#' && spat[1] == '\0') {
6693 incrRefCount(subst);
6694 return subst;
6695 }
6696
6697 /* The substitution object may be specially encoded. If so we create
6698 * a decoded object on the fly. Otherwise getDecodedObject will just
6699 * increment the ref count, that we'll decrement later. */
6700 subst = getDecodedObject(subst);
6701
6702 ssub = subst->ptr;
6703 if (sdslen(spat)+sdslen(ssub)-1 > REDIS_SORTKEY_MAX) return NULL;
6704 p = strchr(spat,'*');
6705 if (!p) {
6706 decrRefCount(subst);
6707 return NULL;
6708 }
6709
6710 /* Find out if we're dealing with a hash dereference. */
6711 if ((f = strstr(p+1, "->")) != NULL) {
6712 fieldlen = sdslen(spat)-(f-spat);
6713 /* this also copies \0 character */
6714 memcpy(fieldname.buf,f+2,fieldlen-1);
6715 fieldname.len = fieldlen-2;
6716 } else {
6717 fieldlen = 0;
6718 }
6719
6720 prefixlen = p-spat;
6721 sublen = sdslen(ssub);
6722 postfixlen = sdslen(spat)-(prefixlen+1)-fieldlen;
6723 memcpy(keyname.buf,spat,prefixlen);
6724 memcpy(keyname.buf+prefixlen,ssub,sublen);
6725 memcpy(keyname.buf+prefixlen+sublen,p+1,postfixlen);
6726 keyname.buf[prefixlen+sublen+postfixlen] = '\0';
6727 keyname.len = prefixlen+sublen+postfixlen;
6728 decrRefCount(subst);
6729
6730 /* Lookup substituted key */
6731 initStaticStringObject(keyobj,((char*)&keyname)+(sizeof(long)*2));
6732 o = lookupKeyRead(db,&keyobj);
6733 if (o == NULL) return NULL;
6734
6735 if (fieldlen > 0) {
6736 if (o->type != REDIS_HASH || fieldname.len < 1) return NULL;
6737
6738 /* Retrieve value from hash by the field name. This operation
6739 * already increases the refcount of the returned object. */
6740 initStaticStringObject(fieldobj,((char*)&fieldname)+(sizeof(long)*2));
6741 o = hashGet(o, &fieldobj);
6742 } else {
6743 if (o->type != REDIS_STRING) return NULL;
6744
6745 /* Every object that this function returns needs to have its refcount
6746 * increased. sortCommand decreases it again. */
6747 incrRefCount(o);
6748 }
6749
6750 return o;
6751 }
6752
6753 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
6754 * the additional parameter is not standard but a BSD-specific we have to
6755 * pass sorting parameters via the global 'server' structure */
6756 static int sortCompare(const void *s1, const void *s2) {
6757 const redisSortObject *so1 = s1, *so2 = s2;
6758 int cmp;
6759
6760 if (!server.sort_alpha) {
6761 /* Numeric sorting. Here it's trivial as we precomputed scores */
6762 if (so1->u.score > so2->u.score) {
6763 cmp = 1;
6764 } else if (so1->u.score < so2->u.score) {
6765 cmp = -1;
6766 } else {
6767 cmp = 0;
6768 }
6769 } else {
6770 /* Alphanumeric sorting */
6771 if (server.sort_bypattern) {
6772 if (!so1->u.cmpobj || !so2->u.cmpobj) {
6773 /* At least one compare object is NULL */
6774 if (so1->u.cmpobj == so2->u.cmpobj)
6775 cmp = 0;
6776 else if (so1->u.cmpobj == NULL)
6777 cmp = -1;
6778 else
6779 cmp = 1;
6780 } else {
6781 /* We have both the objects, use strcoll */
6782 cmp = strcoll(so1->u.cmpobj->ptr,so2->u.cmpobj->ptr);
6783 }
6784 } else {
6785 /* Compare elements directly. */
6786 cmp = compareStringObjects(so1->obj,so2->obj);
6787 }
6788 }
6789 return server.sort_desc ? -cmp : cmp;
6790 }
6791
6792 /* The SORT command is the most complex command in Redis. Warning: this code
6793 * is optimized for speed and a bit less for readability */
6794 static void sortCommand(redisClient *c) {
6795 list *operations;
6796 int outputlen = 0;
6797 int desc = 0, alpha = 0;
6798 int limit_start = 0, limit_count = -1, start, end;
6799 int j, dontsort = 0, vectorlen;
6800 int getop = 0; /* GET operation counter */
6801 robj *sortval, *sortby = NULL, *storekey = NULL;
6802 redisSortObject *vector; /* Resulting vector to sort */
6803
6804 /* Lookup the key to sort. It must be of the right types */
6805 sortval = lookupKeyRead(c->db,c->argv[1]);
6806 if (sortval == NULL) {
6807 addReply(c,shared.emptymultibulk);
6808 return;
6809 }
6810 if (sortval->type != REDIS_SET && sortval->type != REDIS_LIST &&
6811 sortval->type != REDIS_ZSET)
6812 {
6813 addReply(c,shared.wrongtypeerr);
6814 return;
6815 }
6816
6817 /* Create a list of operations to perform for every sorted element.
6818 * Operations can be GET/DEL/INCR/DECR */
6819 operations = listCreate();
6820 listSetFreeMethod(operations,zfree);
6821 j = 2;
6822
6823 /* Now we need to protect sortval incrementing its count, in the future
6824 * SORT may have options able to overwrite/delete keys during the sorting
6825 * and the sorted key itself may get destroied */
6826 incrRefCount(sortval);
6827
6828 /* The SORT command has an SQL-alike syntax, parse it */
6829 while(j < c->argc) {
6830 int leftargs = c->argc-j-1;
6831 if (!strcasecmp(c->argv[j]->ptr,"asc")) {
6832 desc = 0;
6833 } else if (!strcasecmp(c->argv[j]->ptr,"desc")) {
6834 desc = 1;
6835 } else if (!strcasecmp(c->argv[j]->ptr,"alpha")) {
6836 alpha = 1;
6837 } else if (!strcasecmp(c->argv[j]->ptr,"limit") && leftargs >= 2) {
6838 limit_start = atoi(c->argv[j+1]->ptr);
6839 limit_count = atoi(c->argv[j+2]->ptr);
6840 j+=2;
6841 } else if (!strcasecmp(c->argv[j]->ptr,"store") && leftargs >= 1) {
6842 storekey = c->argv[j+1];
6843 j++;
6844 } else if (!strcasecmp(c->argv[j]->ptr,"by") && leftargs >= 1) {
6845 sortby = c->argv[j+1];
6846 /* If the BY pattern does not contain '*', i.e. it is constant,
6847 * we don't need to sort nor to lookup the weight keys. */
6848 if (strchr(c->argv[j+1]->ptr,'*') == NULL) dontsort = 1;
6849 j++;
6850 } else if (!strcasecmp(c->argv[j]->ptr,"get") && leftargs >= 1) {
6851 listAddNodeTail(operations,createSortOperation(
6852 REDIS_SORT_GET,c->argv[j+1]));
6853 getop++;
6854 j++;
6855 } else {
6856 decrRefCount(sortval);
6857 listRelease(operations);
6858 addReply(c,shared.syntaxerr);
6859 return;
6860 }
6861 j++;
6862 }
6863
6864 /* Load the sorting vector with all the objects to sort */
6865 switch(sortval->type) {
6866 case REDIS_LIST: vectorlen = listLength((list*)sortval->ptr); break;
6867 case REDIS_SET: vectorlen = dictSize((dict*)sortval->ptr); break;
6868 case REDIS_ZSET: vectorlen = dictSize(((zset*)sortval->ptr)->dict); break;
6869 default: vectorlen = 0; redisPanic("Bad SORT type"); /* Avoid GCC warning */
6870 }
6871 vector = zmalloc(sizeof(redisSortObject)*vectorlen);
6872 j = 0;
6873
6874 if (sortval->type == REDIS_LIST) {
6875 list *list = sortval->ptr;
6876 listNode *ln;
6877 listIter li;
6878
6879 listRewind(list,&li);
6880 while((ln = listNext(&li))) {
6881 robj *ele = ln->value;
6882 vector[j].obj = ele;
6883 vector[j].u.score = 0;
6884 vector[j].u.cmpobj = NULL;
6885 j++;
6886 }
6887 } else {
6888 dict *set;
6889 dictIterator *di;
6890 dictEntry *setele;
6891
6892 if (sortval->type == REDIS_SET) {
6893 set = sortval->ptr;
6894 } else {
6895 zset *zs = sortval->ptr;
6896 set = zs->dict;
6897 }
6898
6899 di = dictGetIterator(set);
6900 while((setele = dictNext(di)) != NULL) {
6901 vector[j].obj = dictGetEntryKey(setele);
6902 vector[j].u.score = 0;
6903 vector[j].u.cmpobj = NULL;
6904 j++;
6905 }
6906 dictReleaseIterator(di);
6907 }
6908 redisAssert(j == vectorlen);
6909
6910 /* Now it's time to load the right scores in the sorting vector */
6911 if (dontsort == 0) {
6912 for (j = 0; j < vectorlen; j++) {
6913 robj *byval;
6914 if (sortby) {
6915 /* lookup value to sort by */
6916 byval = lookupKeyByPattern(c->db,sortby,vector[j].obj);
6917 if (!byval) continue;
6918 } else {
6919 /* use object itself to sort by */
6920 byval = vector[j].obj;
6921 }
6922
6923 if (alpha) {
6924 if (sortby) vector[j].u.cmpobj = getDecodedObject(byval);
6925 } else {
6926 if (byval->encoding == REDIS_ENCODING_RAW) {
6927 vector[j].u.score = strtod(byval->ptr,NULL);
6928 } else if (byval->encoding == REDIS_ENCODING_INT) {
6929 /* Don't need to decode the object if it's
6930 * integer-encoded (the only encoding supported) so
6931 * far. We can just cast it */
6932 vector[j].u.score = (long)byval->ptr;
6933 } else {
6934 redisAssert(1 != 1);
6935 }
6936 }
6937
6938 /* when the object was retrieved using lookupKeyByPattern,
6939 * its refcount needs to be decreased. */
6940 if (sortby) {
6941 decrRefCount(byval);
6942 }
6943 }
6944 }
6945
6946 /* We are ready to sort the vector... perform a bit of sanity check
6947 * on the LIMIT option too. We'll use a partial version of quicksort. */
6948 start = (limit_start < 0) ? 0 : limit_start;
6949 end = (limit_count < 0) ? vectorlen-1 : start+limit_count-1;
6950 if (start >= vectorlen) {
6951 start = vectorlen-1;
6952 end = vectorlen-2;
6953 }
6954 if (end >= vectorlen) end = vectorlen-1;
6955
6956 if (dontsort == 0) {
6957 server.sort_desc = desc;
6958 server.sort_alpha = alpha;
6959 server.sort_bypattern = sortby ? 1 : 0;
6960 if (sortby && (start != 0 || end != vectorlen-1))
6961 pqsort(vector,vectorlen,sizeof(redisSortObject),sortCompare, start,end);
6962 else
6963 qsort(vector,vectorlen,sizeof(redisSortObject),sortCompare);
6964 }
6965
6966 /* Send command output to the output buffer, performing the specified
6967 * GET/DEL/INCR/DECR operations if any. */
6968 outputlen = getop ? getop*(end-start+1) : end-start+1;
6969 if (storekey == NULL) {
6970 /* STORE option not specified, sent the sorting result to client */
6971 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",outputlen));
6972 for (j = start; j <= end; j++) {
6973 listNode *ln;
6974 listIter li;
6975
6976 if (!getop) addReplyBulk(c,vector[j].obj);
6977 listRewind(operations,&li);
6978 while((ln = listNext(&li))) {
6979 redisSortOperation *sop = ln->value;
6980 robj *val = lookupKeyByPattern(c->db,sop->pattern,
6981 vector[j].obj);
6982
6983 if (sop->type == REDIS_SORT_GET) {
6984 if (!val) {
6985 addReply(c,shared.nullbulk);
6986 } else {
6987 addReplyBulk(c,val);
6988 decrRefCount(val);
6989 }
6990 } else {
6991 redisAssert(sop->type == REDIS_SORT_GET); /* always fails */
6992 }
6993 }
6994 }
6995 } else {
6996 robj *listObject = createListObject();
6997 list *listPtr = (list*) listObject->ptr;
6998
6999 /* STORE option specified, set the sorting result as a List object */
7000 for (j = start; j <= end; j++) {
7001 listNode *ln;
7002 listIter li;
7003
7004 if (!getop) {
7005 listAddNodeTail(listPtr,vector[j].obj);
7006 incrRefCount(vector[j].obj);
7007 }
7008 listRewind(operations,&li);
7009 while((ln = listNext(&li))) {
7010 redisSortOperation *sop = ln->value;
7011 robj *val = lookupKeyByPattern(c->db,sop->pattern,
7012 vector[j].obj);
7013
7014 if (sop->type == REDIS_SORT_GET) {
7015 if (!val) {
7016 listAddNodeTail(listPtr,createStringObject("",0));
7017 } else {
7018 /* We should do a incrRefCount on val because it is
7019 * added to the list, but also a decrRefCount because
7020 * it is returned by lookupKeyByPattern. This results
7021 * in doing nothing at all. */
7022 listAddNodeTail(listPtr,val);
7023 }
7024 } else {
7025 redisAssert(sop->type == REDIS_SORT_GET); /* always fails */
7026 }
7027 }
7028 }
7029 if (dictReplace(c->db->dict,storekey,listObject)) {
7030 incrRefCount(storekey);
7031 }
7032 /* Note: we add 1 because the DB is dirty anyway since even if the
7033 * SORT result is empty a new key is set and maybe the old content
7034 * replaced. */
7035 server.dirty += 1+outputlen;
7036 addReplySds(c,sdscatprintf(sdsempty(),":%d\r\n",outputlen));
7037 }
7038
7039 /* Cleanup */
7040 decrRefCount(sortval);
7041 listRelease(operations);
7042 for (j = 0; j < vectorlen; j++) {
7043 if (alpha && vector[j].u.cmpobj)
7044 decrRefCount(vector[j].u.cmpobj);
7045 }
7046 zfree(vector);
7047 }
7048
7049 /* Convert an amount of bytes into a human readable string in the form
7050 * of 100B, 2G, 100M, 4K, and so forth. */
7051 static void bytesToHuman(char *s, unsigned long long n) {
7052 double d;
7053
7054 if (n < 1024) {
7055 /* Bytes */
7056 sprintf(s,"%lluB",n);
7057 return;
7058 } else if (n < (1024*1024)) {
7059 d = (double)n/(1024);
7060 sprintf(s,"%.2fK",d);
7061 } else if (n < (1024LL*1024*1024)) {
7062 d = (double)n/(1024*1024);
7063 sprintf(s,"%.2fM",d);
7064 } else if (n < (1024LL*1024*1024*1024)) {
7065 d = (double)n/(1024LL*1024*1024);
7066 sprintf(s,"%.2fG",d);
7067 }
7068 }
7069
7070 /* Create the string returned by the INFO command. This is decoupled
7071 * by the INFO command itself as we need to report the same information
7072 * on memory corruption problems. */
7073 static sds genRedisInfoString(void) {
7074 sds info;
7075 time_t uptime = time(NULL)-server.stat_starttime;
7076 int j;
7077 char hmem[64];
7078
7079 bytesToHuman(hmem,zmalloc_used_memory());
7080 info = sdscatprintf(sdsempty(),
7081 "redis_version:%s\r\n"
7082 "arch_bits:%s\r\n"
7083 "multiplexing_api:%s\r\n"
7084 "process_id:%ld\r\n"
7085 "uptime_in_seconds:%ld\r\n"
7086 "uptime_in_days:%ld\r\n"
7087 "connected_clients:%d\r\n"
7088 "connected_slaves:%d\r\n"
7089 "blocked_clients:%d\r\n"
7090 "used_memory:%zu\r\n"
7091 "used_memory_human:%s\r\n"
7092 "changes_since_last_save:%lld\r\n"
7093 "bgsave_in_progress:%d\r\n"
7094 "last_save_time:%ld\r\n"
7095 "bgrewriteaof_in_progress:%d\r\n"
7096 "total_connections_received:%lld\r\n"
7097 "total_commands_processed:%lld\r\n"
7098 "expired_keys:%lld\r\n"
7099 "hash_max_zipmap_entries:%ld\r\n"
7100 "hash_max_zipmap_value:%ld\r\n"
7101 "pubsub_channels:%ld\r\n"
7102 "pubsub_patterns:%u\r\n"
7103 "vm_enabled:%d\r\n"
7104 "role:%s\r\n"
7105 ,REDIS_VERSION,
7106 (sizeof(long) == 8) ? "64" : "32",
7107 aeGetApiName(),
7108 (long) getpid(),
7109 uptime,
7110 uptime/(3600*24),
7111 listLength(server.clients)-listLength(server.slaves),
7112 listLength(server.slaves),
7113 server.blpop_blocked_clients,
7114 zmalloc_used_memory(),
7115 hmem,
7116 server.dirty,
7117 server.bgsavechildpid != -1,
7118 server.lastsave,
7119 server.bgrewritechildpid != -1,
7120 server.stat_numconnections,
7121 server.stat_numcommands,
7122 server.stat_expiredkeys,
7123 server.hash_max_zipmap_entries,
7124 server.hash_max_zipmap_value,
7125 dictSize(server.pubsub_channels),
7126 listLength(server.pubsub_patterns),
7127 server.vm_enabled != 0,
7128 server.masterhost == NULL ? "master" : "slave"
7129 );
7130 if (server.masterhost) {
7131 info = sdscatprintf(info,
7132 "master_host:%s\r\n"
7133 "master_port:%d\r\n"
7134 "master_link_status:%s\r\n"
7135 "master_last_io_seconds_ago:%d\r\n"
7136 ,server.masterhost,
7137 server.masterport,
7138 (server.replstate == REDIS_REPL_CONNECTED) ?
7139 "up" : "down",
7140 server.master ? ((int)(time(NULL)-server.master->lastinteraction)) : -1
7141 );
7142 }
7143 if (server.vm_enabled) {
7144 lockThreadedIO();
7145 info = sdscatprintf(info,
7146 "vm_conf_max_memory:%llu\r\n"
7147 "vm_conf_page_size:%llu\r\n"
7148 "vm_conf_pages:%llu\r\n"
7149 "vm_stats_used_pages:%llu\r\n"
7150 "vm_stats_swapped_objects:%llu\r\n"
7151 "vm_stats_swappin_count:%llu\r\n"
7152 "vm_stats_swappout_count:%llu\r\n"
7153 "vm_stats_io_newjobs_len:%lu\r\n"
7154 "vm_stats_io_processing_len:%lu\r\n"
7155 "vm_stats_io_processed_len:%lu\r\n"
7156 "vm_stats_io_active_threads:%lu\r\n"
7157 "vm_stats_blocked_clients:%lu\r\n"
7158 ,(unsigned long long) server.vm_max_memory,
7159 (unsigned long long) server.vm_page_size,
7160 (unsigned long long) server.vm_pages,
7161 (unsigned long long) server.vm_stats_used_pages,
7162 (unsigned long long) server.vm_stats_swapped_objects,
7163 (unsigned long long) server.vm_stats_swapins,
7164 (unsigned long long) server.vm_stats_swapouts,
7165 (unsigned long) listLength(server.io_newjobs),
7166 (unsigned long) listLength(server.io_processing),
7167 (unsigned long) listLength(server.io_processed),
7168 (unsigned long) server.io_active_threads,
7169 (unsigned long) server.vm_blocked_clients
7170 );
7171 unlockThreadedIO();
7172 }
7173 for (j = 0; j < server.dbnum; j++) {
7174 long long keys, vkeys;
7175
7176 keys = dictSize(server.db[j].dict);
7177 vkeys = dictSize(server.db[j].expires);
7178 if (keys || vkeys) {
7179 info = sdscatprintf(info, "db%d:keys=%lld,expires=%lld\r\n",
7180 j, keys, vkeys);
7181 }
7182 }
7183 return info;
7184 }
7185
7186 static void infoCommand(redisClient *c) {
7187 sds info = genRedisInfoString();
7188 addReplySds(c,sdscatprintf(sdsempty(),"$%lu\r\n",
7189 (unsigned long)sdslen(info)));
7190 addReplySds(c,info);
7191 addReply(c,shared.crlf);
7192 }
7193
7194 static void monitorCommand(redisClient *c) {
7195 /* ignore MONITOR if aleady slave or in monitor mode */
7196 if (c->flags & REDIS_SLAVE) return;
7197
7198 c->flags |= (REDIS_SLAVE|REDIS_MONITOR);
7199 c->slaveseldb = 0;
7200 listAddNodeTail(server.monitors,c);
7201 addReply(c,shared.ok);
7202 }
7203
7204 /* ================================= Expire ================================= */
7205 static int removeExpire(redisDb *db, robj *key) {
7206 if (dictDelete(db->expires,key) == DICT_OK) {
7207 return 1;
7208 } else {
7209 return 0;
7210 }
7211 }
7212
7213 static int setExpire(redisDb *db, robj *key, time_t when) {
7214 if (dictAdd(db->expires,key,(void*)when) == DICT_ERR) {
7215 return 0;
7216 } else {
7217 incrRefCount(key);
7218 return 1;
7219 }
7220 }
7221
7222 /* Return the expire time of the specified key, or -1 if no expire
7223 * is associated with this key (i.e. the key is non volatile) */
7224 static time_t getExpire(redisDb *db, robj *key) {
7225 dictEntry *de;
7226
7227 /* No expire? return ASAP */
7228 if (dictSize(db->expires) == 0 ||
7229 (de = dictFind(db->expires,key)) == NULL) return -1;
7230
7231 return (time_t) dictGetEntryVal(de);
7232 }
7233
7234 static int expireIfNeeded(redisDb *db, robj *key) {
7235 time_t when;
7236 dictEntry *de;
7237
7238 /* No expire? return ASAP */
7239 if (dictSize(db->expires) == 0 ||
7240 (de = dictFind(db->expires,key)) == NULL) return 0;
7241
7242 /* Lookup the expire */
7243 when = (time_t) dictGetEntryVal(de);
7244 if (time(NULL) <= when) return 0;
7245
7246 /* Delete the key */
7247 dictDelete(db->expires,key);
7248 server.stat_expiredkeys++;
7249 return dictDelete(db->dict,key) == DICT_OK;
7250 }
7251
7252 static int deleteIfVolatile(redisDb *db, robj *key) {
7253 dictEntry *de;
7254
7255 /* No expire? return ASAP */
7256 if (dictSize(db->expires) == 0 ||
7257 (de = dictFind(db->expires,key)) == NULL) return 0;
7258
7259 /* Delete the key */
7260 server.dirty++;
7261 server.stat_expiredkeys++;
7262 dictDelete(db->expires,key);
7263 return dictDelete(db->dict,key) == DICT_OK;
7264 }
7265
7266 static void expireGenericCommand(redisClient *c, robj *key, robj *param, long offset) {
7267 dictEntry *de;
7268 time_t seconds;
7269
7270 if (getLongFromObjectOrReply(c, param, &seconds, NULL) != REDIS_OK) return;
7271
7272 seconds -= offset;
7273
7274 de = dictFind(c->db->dict,key);
7275 if (de == NULL) {
7276 addReply(c,shared.czero);
7277 return;
7278 }
7279 if (seconds <= 0) {
7280 if (deleteKey(c->db,key)) server.dirty++;
7281 addReply(c, shared.cone);
7282 return;
7283 } else {
7284 time_t when = time(NULL)+seconds;
7285 if (setExpire(c->db,key,when)) {
7286 addReply(c,shared.cone);
7287 server.dirty++;
7288 } else {
7289 addReply(c,shared.czero);
7290 }
7291 return;
7292 }
7293 }
7294
7295 static void expireCommand(redisClient *c) {
7296 expireGenericCommand(c,c->argv[1],c->argv[2],0);
7297 }
7298
7299 static void expireatCommand(redisClient *c) {
7300 expireGenericCommand(c,c->argv[1],c->argv[2],time(NULL));
7301 }
7302
7303 static void ttlCommand(redisClient *c) {
7304 time_t expire;
7305 int ttl = -1;
7306
7307 expire = getExpire(c->db,c->argv[1]);
7308 if (expire != -1) {
7309 ttl = (int) (expire-time(NULL));
7310 if (ttl < 0) ttl = -1;
7311 }
7312 addReplySds(c,sdscatprintf(sdsempty(),":%d\r\n",ttl));
7313 }
7314
7315 /* ================================ MULTI/EXEC ============================== */
7316
7317 /* Client state initialization for MULTI/EXEC */
7318 static void initClientMultiState(redisClient *c) {
7319 c->mstate.commands = NULL;
7320 c->mstate.count = 0;
7321 }
7322
7323 /* Release all the resources associated with MULTI/EXEC state */
7324 static void freeClientMultiState(redisClient *c) {
7325 int j;
7326
7327 for (j = 0; j < c->mstate.count; j++) {
7328 int i;
7329 multiCmd *mc = c->mstate.commands+j;
7330
7331 for (i = 0; i < mc->argc; i++)
7332 decrRefCount(mc->argv[i]);
7333 zfree(mc->argv);
7334 }
7335 zfree(c->mstate.commands);
7336 }
7337
7338 /* Add a new command into the MULTI commands queue */
7339 static void queueMultiCommand(redisClient *c, struct redisCommand *cmd) {
7340 multiCmd *mc;
7341 int j;
7342
7343 c->mstate.commands = zrealloc(c->mstate.commands,
7344 sizeof(multiCmd)*(c->mstate.count+1));
7345 mc = c->mstate.commands+c->mstate.count;
7346 mc->cmd = cmd;
7347 mc->argc = c->argc;
7348 mc->argv = zmalloc(sizeof(robj*)*c->argc);
7349 memcpy(mc->argv,c->argv,sizeof(robj*)*c->argc);
7350 for (j = 0; j < c->argc; j++)
7351 incrRefCount(mc->argv[j]);
7352 c->mstate.count++;
7353 }
7354
7355 static void multiCommand(redisClient *c) {
7356 c->flags |= REDIS_MULTI;
7357 addReply(c,shared.ok);
7358 }
7359
7360 static void discardCommand(redisClient *c) {
7361 if (!(c->flags & REDIS_MULTI)) {
7362 addReplySds(c,sdsnew("-ERR DISCARD without MULTI\r\n"));
7363 return;
7364 }
7365
7366 freeClientMultiState(c);
7367 initClientMultiState(c);
7368 c->flags &= (~REDIS_MULTI);
7369 addReply(c,shared.ok);
7370 }
7371
7372 /* Send a MULTI command to all the slaves and AOF file. Check the execCommand
7373 * implememntation for more information. */
7374 static void execCommandReplicateMulti(redisClient *c) {
7375 struct redisCommand *cmd;
7376 robj *multistring = createStringObject("MULTI",5);
7377
7378 cmd = lookupCommand("multi");
7379 if (server.appendonly)
7380 feedAppendOnlyFile(cmd,c->db->id,&multistring,1);
7381 if (listLength(server.slaves))
7382 replicationFeedSlaves(server.slaves,c->db->id,&multistring,1);
7383 decrRefCount(multistring);
7384 }
7385
7386 static void execCommand(redisClient *c) {
7387 int j;
7388 robj **orig_argv;
7389 int orig_argc;
7390
7391 if (!(c->flags & REDIS_MULTI)) {
7392 addReplySds(c,sdsnew("-ERR EXEC without MULTI\r\n"));
7393 return;
7394 }
7395
7396 /* Replicate a MULTI request now that we are sure the block is executed.
7397 * This way we'll deliver the MULTI/..../EXEC block as a whole and
7398 * both the AOF and the replication link will have the same consistency
7399 * and atomicity guarantees. */
7400 execCommandReplicateMulti(c);
7401
7402 /* Exec all the queued commands */
7403 orig_argv = c->argv;
7404 orig_argc = c->argc;
7405 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",c->mstate.count));
7406 for (j = 0; j < c->mstate.count; j++) {
7407 c->argc = c->mstate.commands[j].argc;
7408 c->argv = c->mstate.commands[j].argv;
7409 call(c,c->mstate.commands[j].cmd);
7410 }
7411 c->argv = orig_argv;
7412 c->argc = orig_argc;
7413 freeClientMultiState(c);
7414 initClientMultiState(c);
7415 c->flags &= (~REDIS_MULTI);
7416 /* Make sure the EXEC command is always replicated / AOF, since we
7417 * always send the MULTI command (we can't know beforehand if the
7418 * next operations will contain at least a modification to the DB). */
7419 server.dirty++;
7420 }
7421
7422 /* =========================== Blocking Operations ========================= */
7423
7424 /* Currently Redis blocking operations support is limited to list POP ops,
7425 * so the current implementation is not fully generic, but it is also not
7426 * completely specific so it will not require a rewrite to support new
7427 * kind of blocking operations in the future.
7428 *
7429 * Still it's important to note that list blocking operations can be already
7430 * used as a notification mechanism in order to implement other blocking
7431 * operations at application level, so there must be a very strong evidence
7432 * of usefulness and generality before new blocking operations are implemented.
7433 *
7434 * This is how the current blocking POP works, we use BLPOP as example:
7435 * - If the user calls BLPOP and the key exists and contains a non empty list
7436 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
7437 * if there is not to block.
7438 * - If instead BLPOP is called and the key does not exists or the list is
7439 * empty we need to block. In order to do so we remove the notification for
7440 * new data to read in the client socket (so that we'll not serve new
7441 * requests if the blocking request is not served). Also we put the client
7442 * in a dictionary (db->blockingkeys) mapping keys to a list of clients
7443 * blocking for this keys.
7444 * - If a PUSH operation against a key with blocked clients waiting is
7445 * performed, we serve the first in the list: basically instead to push
7446 * the new element inside the list we return it to the (first / oldest)
7447 * blocking client, unblock the client, and remove it form the list.
7448 *
7449 * The above comment and the source code should be enough in order to understand
7450 * the implementation and modify / fix it later.
7451 */
7452
7453 /* Set a client in blocking mode for the specified key, with the specified
7454 * timeout */
7455 static void blockForKeys(redisClient *c, robj **keys, int numkeys, time_t timeout) {
7456 dictEntry *de;
7457 list *l;
7458 int j;
7459
7460 c->blockingkeys = zmalloc(sizeof(robj*)*numkeys);
7461 c->blockingkeysnum = numkeys;
7462 c->blockingto = timeout;
7463 for (j = 0; j < numkeys; j++) {
7464 /* Add the key in the client structure, to map clients -> keys */
7465 c->blockingkeys[j] = keys[j];
7466 incrRefCount(keys[j]);
7467
7468 /* And in the other "side", to map keys -> clients */
7469 de = dictFind(c->db->blockingkeys,keys[j]);
7470 if (de == NULL) {
7471 int retval;
7472
7473 /* For every key we take a list of clients blocked for it */
7474 l = listCreate();
7475 retval = dictAdd(c->db->blockingkeys,keys[j],l);
7476 incrRefCount(keys[j]);
7477 assert(retval == DICT_OK);
7478 } else {
7479 l = dictGetEntryVal(de);
7480 }
7481 listAddNodeTail(l,c);
7482 }
7483 /* Mark the client as a blocked client */
7484 c->flags |= REDIS_BLOCKED;
7485 server.blpop_blocked_clients++;
7486 }
7487
7488 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
7489 static void unblockClientWaitingData(redisClient *c) {
7490 dictEntry *de;
7491 list *l;
7492 int j;
7493
7494 assert(c->blockingkeys != NULL);
7495 /* The client may wait for multiple keys, so unblock it for every key. */
7496 for (j = 0; j < c->blockingkeysnum; j++) {
7497 /* Remove this client from the list of clients waiting for this key. */
7498 de = dictFind(c->db->blockingkeys,c->blockingkeys[j]);
7499 assert(de != NULL);
7500 l = dictGetEntryVal(de);
7501 listDelNode(l,listSearchKey(l,c));
7502 /* If the list is empty we need to remove it to avoid wasting memory */
7503 if (listLength(l) == 0)
7504 dictDelete(c->db->blockingkeys,c->blockingkeys[j]);
7505 decrRefCount(c->blockingkeys[j]);
7506 }
7507 /* Cleanup the client structure */
7508 zfree(c->blockingkeys);
7509 c->blockingkeys = NULL;
7510 c->flags &= (~REDIS_BLOCKED);
7511 server.blpop_blocked_clients--;
7512 /* We want to process data if there is some command waiting
7513 * in the input buffer. Note that this is safe even if
7514 * unblockClientWaitingData() gets called from freeClient() because
7515 * freeClient() will be smart enough to call this function
7516 * *after* c->querybuf was set to NULL. */
7517 if (c->querybuf && sdslen(c->querybuf) > 0) processInputBuffer(c);
7518 }
7519
7520 /* This should be called from any function PUSHing into lists.
7521 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
7522 * 'ele' is the element pushed.
7523 *
7524 * If the function returns 0 there was no client waiting for a list push
7525 * against this key.
7526 *
7527 * If the function returns 1 there was a client waiting for a list push
7528 * against this key, the element was passed to this client thus it's not
7529 * needed to actually add it to the list and the caller should return asap. */
7530 static int handleClientsWaitingListPush(redisClient *c, robj *key, robj *ele) {
7531 struct dictEntry *de;
7532 redisClient *receiver;
7533 list *l;
7534 listNode *ln;
7535
7536 de = dictFind(c->db->blockingkeys,key);
7537 if (de == NULL) return 0;
7538 l = dictGetEntryVal(de);
7539 ln = listFirst(l);
7540 assert(ln != NULL);
7541 receiver = ln->value;
7542
7543 addReplySds(receiver,sdsnew("*2\r\n"));
7544 addReplyBulk(receiver,key);
7545 addReplyBulk(receiver,ele);
7546 unblockClientWaitingData(receiver);
7547 return 1;
7548 }
7549
7550 /* Blocking RPOP/LPOP */
7551 static void blockingPopGenericCommand(redisClient *c, int where) {
7552 robj *o;
7553 time_t timeout;
7554 int j;
7555
7556 for (j = 1; j < c->argc-1; j++) {
7557 o = lookupKeyWrite(c->db,c->argv[j]);
7558 if (o != NULL) {
7559 if (o->type != REDIS_LIST) {
7560 addReply(c,shared.wrongtypeerr);
7561 return;
7562 } else {
7563 list *list = o->ptr;
7564 if (listLength(list) != 0) {
7565 /* If the list contains elements fall back to the usual
7566 * non-blocking POP operation */
7567 robj *argv[2], **orig_argv;
7568 int orig_argc;
7569
7570 /* We need to alter the command arguments before to call
7571 * popGenericCommand() as the command takes a single key. */
7572 orig_argv = c->argv;
7573 orig_argc = c->argc;
7574 argv[1] = c->argv[j];
7575 c->argv = argv;
7576 c->argc = 2;
7577
7578 /* Also the return value is different, we need to output
7579 * the multi bulk reply header and the key name. The
7580 * "real" command will add the last element (the value)
7581 * for us. If this souds like an hack to you it's just
7582 * because it is... */
7583 addReplySds(c,sdsnew("*2\r\n"));
7584 addReplyBulk(c,argv[1]);
7585 popGenericCommand(c,where);
7586
7587 /* Fix the client structure with the original stuff */
7588 c->argv = orig_argv;
7589 c->argc = orig_argc;
7590 return;
7591 }
7592 }
7593 }
7594 }
7595 /* If the list is empty or the key does not exists we must block */
7596 timeout = strtol(c->argv[c->argc-1]->ptr,NULL,10);
7597 if (timeout > 0) timeout += time(NULL);
7598 blockForKeys(c,c->argv+1,c->argc-2,timeout);
7599 }
7600
7601 static void blpopCommand(redisClient *c) {
7602 blockingPopGenericCommand(c,REDIS_HEAD);
7603 }
7604
7605 static void brpopCommand(redisClient *c) {
7606 blockingPopGenericCommand(c,REDIS_TAIL);
7607 }
7608
7609 /* =============================== Replication ============================= */
7610
7611 static int syncWrite(int fd, char *ptr, ssize_t size, int timeout) {
7612 ssize_t nwritten, ret = size;
7613 time_t start = time(NULL);
7614
7615 timeout++;
7616 while(size) {
7617 if (aeWait(fd,AE_WRITABLE,1000) & AE_WRITABLE) {
7618 nwritten = write(fd,ptr,size);
7619 if (nwritten == -1) return -1;
7620 ptr += nwritten;
7621 size -= nwritten;
7622 }
7623 if ((time(NULL)-start) > timeout) {
7624 errno = ETIMEDOUT;
7625 return -1;
7626 }
7627 }
7628 return ret;
7629 }
7630
7631 static int syncRead(int fd, char *ptr, ssize_t size, int timeout) {
7632 ssize_t nread, totread = 0;
7633 time_t start = time(NULL);
7634
7635 timeout++;
7636 while(size) {
7637 if (aeWait(fd,AE_READABLE,1000) & AE_READABLE) {
7638 nread = read(fd,ptr,size);
7639 if (nread == -1) return -1;
7640 ptr += nread;
7641 size -= nread;
7642 totread += nread;
7643 }
7644 if ((time(NULL)-start) > timeout) {
7645 errno = ETIMEDOUT;
7646 return -1;
7647 }
7648 }
7649 return totread;
7650 }
7651
7652 static int syncReadLine(int fd, char *ptr, ssize_t size, int timeout) {
7653 ssize_t nread = 0;
7654
7655 size--;
7656 while(size) {
7657 char c;
7658
7659 if (syncRead(fd,&c,1,timeout) == -1) return -1;
7660 if (c == '\n') {
7661 *ptr = '\0';
7662 if (nread && *(ptr-1) == '\r') *(ptr-1) = '\0';
7663 return nread;
7664 } else {
7665 *ptr++ = c;
7666 *ptr = '\0';
7667 nread++;
7668 }
7669 }
7670 return nread;
7671 }
7672
7673 static void syncCommand(redisClient *c) {
7674 /* ignore SYNC if aleady slave or in monitor mode */
7675 if (c->flags & REDIS_SLAVE) return;
7676
7677 /* SYNC can't be issued when the server has pending data to send to
7678 * the client about already issued commands. We need a fresh reply
7679 * buffer registering the differences between the BGSAVE and the current
7680 * dataset, so that we can copy to other slaves if needed. */
7681 if (listLength(c->reply) != 0) {
7682 addReplySds(c,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
7683 return;
7684 }
7685
7686 redisLog(REDIS_NOTICE,"Slave ask for synchronization");
7687 /* Here we need to check if there is a background saving operation
7688 * in progress, or if it is required to start one */
7689 if (server.bgsavechildpid != -1) {
7690 /* Ok a background save is in progress. Let's check if it is a good
7691 * one for replication, i.e. if there is another slave that is
7692 * registering differences since the server forked to save */
7693 redisClient *slave;
7694 listNode *ln;
7695 listIter li;
7696
7697 listRewind(server.slaves,&li);
7698 while((ln = listNext(&li))) {
7699 slave = ln->value;
7700 if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_END) break;
7701 }
7702 if (ln) {
7703 /* Perfect, the server is already registering differences for
7704 * another slave. Set the right state, and copy the buffer. */
7705 listRelease(c->reply);
7706 c->reply = listDup(slave->reply);
7707 c->replstate = REDIS_REPL_WAIT_BGSAVE_END;
7708 redisLog(REDIS_NOTICE,"Waiting for end of BGSAVE for SYNC");
7709 } else {
7710 /* No way, we need to wait for the next BGSAVE in order to
7711 * register differences */
7712 c->replstate = REDIS_REPL_WAIT_BGSAVE_START;
7713 redisLog(REDIS_NOTICE,"Waiting for next BGSAVE for SYNC");
7714 }
7715 } else {
7716 /* Ok we don't have a BGSAVE in progress, let's start one */
7717 redisLog(REDIS_NOTICE,"Starting BGSAVE for SYNC");
7718 if (rdbSaveBackground(server.dbfilename) != REDIS_OK) {
7719 redisLog(REDIS_NOTICE,"Replication failed, can't BGSAVE");
7720 addReplySds(c,sdsnew("-ERR Unalbe to perform background save\r\n"));
7721 return;
7722 }
7723 c->replstate = REDIS_REPL_WAIT_BGSAVE_END;
7724 }
7725 c->repldbfd = -1;
7726 c->flags |= REDIS_SLAVE;
7727 c->slaveseldb = 0;
7728 listAddNodeTail(server.slaves,c);
7729 return;
7730 }
7731
7732 static void sendBulkToSlave(aeEventLoop *el, int fd, void *privdata, int mask) {
7733 redisClient *slave = privdata;
7734 REDIS_NOTUSED(el);
7735 REDIS_NOTUSED(mask);
7736 char buf[REDIS_IOBUF_LEN];
7737 ssize_t nwritten, buflen;
7738
7739 if (slave->repldboff == 0) {
7740 /* Write the bulk write count before to transfer the DB. In theory here
7741 * we don't know how much room there is in the output buffer of the
7742 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
7743 * operations) will never be smaller than the few bytes we need. */
7744 sds bulkcount;
7745
7746 bulkcount = sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
7747 slave->repldbsize);
7748 if (write(fd,bulkcount,sdslen(bulkcount)) != (signed)sdslen(bulkcount))
7749 {
7750 sdsfree(bulkcount);
7751 freeClient(slave);
7752 return;
7753 }
7754 sdsfree(bulkcount);
7755 }
7756 lseek(slave->repldbfd,slave->repldboff,SEEK_SET);
7757 buflen = read(slave->repldbfd,buf,REDIS_IOBUF_LEN);
7758 if (buflen <= 0) {
7759 redisLog(REDIS_WARNING,"Read error sending DB to slave: %s",
7760 (buflen == 0) ? "premature EOF" : strerror(errno));
7761 freeClient(slave);
7762 return;
7763 }
7764 if ((nwritten = write(fd,buf,buflen)) == -1) {
7765 redisLog(REDIS_VERBOSE,"Write error sending DB to slave: %s",
7766 strerror(errno));
7767 freeClient(slave);
7768 return;
7769 }
7770 slave->repldboff += nwritten;
7771 if (slave->repldboff == slave->repldbsize) {
7772 close(slave->repldbfd);
7773 slave->repldbfd = -1;
7774 aeDeleteFileEvent(server.el,slave->fd,AE_WRITABLE);
7775 slave->replstate = REDIS_REPL_ONLINE;
7776 if (aeCreateFileEvent(server.el, slave->fd, AE_WRITABLE,
7777 sendReplyToClient, slave) == AE_ERR) {
7778 freeClient(slave);
7779 return;
7780 }
7781 addReplySds(slave,sdsempty());
7782 redisLog(REDIS_NOTICE,"Synchronization with slave succeeded");
7783 }
7784 }
7785
7786 /* This function is called at the end of every backgrond saving.
7787 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
7788 * otherwise REDIS_ERR is passed to the function.
7789 *
7790 * The goal of this function is to handle slaves waiting for a successful
7791 * background saving in order to perform non-blocking synchronization. */
7792 static void updateSlavesWaitingBgsave(int bgsaveerr) {
7793 listNode *ln;
7794 int startbgsave = 0;
7795 listIter li;
7796
7797 listRewind(server.slaves,&li);
7798 while((ln = listNext(&li))) {
7799 redisClient *slave = ln->value;
7800
7801 if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_START) {
7802 startbgsave = 1;
7803 slave->replstate = REDIS_REPL_WAIT_BGSAVE_END;
7804 } else if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_END) {
7805 struct redis_stat buf;
7806
7807 if (bgsaveerr != REDIS_OK) {
7808 freeClient(slave);
7809 redisLog(REDIS_WARNING,"SYNC failed. BGSAVE child returned an error");
7810 continue;
7811 }
7812 if ((slave->repldbfd = open(server.dbfilename,O_RDONLY)) == -1 ||
7813 redis_fstat(slave->repldbfd,&buf) == -1) {
7814 freeClient(slave);
7815 redisLog(REDIS_WARNING,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno));
7816 continue;
7817 }
7818 slave->repldboff = 0;
7819 slave->repldbsize = buf.st_size;
7820 slave->replstate = REDIS_REPL_SEND_BULK;
7821 aeDeleteFileEvent(server.el,slave->fd,AE_WRITABLE);
7822 if (aeCreateFileEvent(server.el, slave->fd, AE_WRITABLE, sendBulkToSlave, slave) == AE_ERR) {
7823 freeClient(slave);
7824 continue;
7825 }
7826 }
7827 }
7828 if (startbgsave) {
7829 if (rdbSaveBackground(server.dbfilename) != REDIS_OK) {
7830 listIter li;
7831
7832 listRewind(server.slaves,&li);
7833 redisLog(REDIS_WARNING,"SYNC failed. BGSAVE failed");
7834 while((ln = listNext(&li))) {
7835 redisClient *slave = ln->value;
7836
7837 if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_START)
7838 freeClient(slave);
7839 }
7840 }
7841 }
7842 }
7843
7844 static int syncWithMaster(void) {
7845 char buf[1024], tmpfile[256], authcmd[1024];
7846 long dumpsize;
7847 int fd = anetTcpConnect(NULL,server.masterhost,server.masterport);
7848 int dfd, maxtries = 5;
7849
7850 if (fd == -1) {
7851 redisLog(REDIS_WARNING,"Unable to connect to MASTER: %s",
7852 strerror(errno));
7853 return REDIS_ERR;
7854 }
7855
7856 /* AUTH with the master if required. */
7857 if(server.masterauth) {
7858 snprintf(authcmd, 1024, "AUTH %s\r\n", server.masterauth);
7859 if (syncWrite(fd, authcmd, strlen(server.masterauth)+7, 5) == -1) {
7860 close(fd);
7861 redisLog(REDIS_WARNING,"Unable to AUTH to MASTER: %s",
7862 strerror(errno));
7863 return REDIS_ERR;
7864 }
7865 /* Read the AUTH result. */
7866 if (syncReadLine(fd,buf,1024,3600) == -1) {
7867 close(fd);
7868 redisLog(REDIS_WARNING,"I/O error reading auth result from MASTER: %s",
7869 strerror(errno));
7870 return REDIS_ERR;
7871 }
7872 if (buf[0] != '+') {
7873 close(fd);
7874 redisLog(REDIS_WARNING,"Cannot AUTH to MASTER, is the masterauth password correct?");
7875 return REDIS_ERR;
7876 }
7877 }
7878
7879 /* Issue the SYNC command */
7880 if (syncWrite(fd,"SYNC \r\n",7,5) == -1) {
7881 close(fd);
7882 redisLog(REDIS_WARNING,"I/O error writing to MASTER: %s",
7883 strerror(errno));
7884 return REDIS_ERR;
7885 }
7886 /* Read the bulk write count */
7887 if (syncReadLine(fd,buf,1024,3600) == -1) {
7888 close(fd);
7889 redisLog(REDIS_WARNING,"I/O error reading bulk count from MASTER: %s",
7890 strerror(errno));
7891 return REDIS_ERR;
7892 }
7893 if (buf[0] != '$') {
7894 close(fd);
7895 redisLog(REDIS_WARNING,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
7896 return REDIS_ERR;
7897 }
7898 dumpsize = strtol(buf+1,NULL,10);
7899 redisLog(REDIS_NOTICE,"Receiving %ld bytes data dump from MASTER",dumpsize);
7900 /* Read the bulk write data on a temp file */
7901 while(maxtries--) {
7902 snprintf(tmpfile,256,
7903 "temp-%d.%ld.rdb",(int)time(NULL),(long int)getpid());
7904 dfd = open(tmpfile,O_CREAT|O_WRONLY|O_EXCL,0644);
7905 if (dfd != -1) break;
7906 sleep(1);
7907 }
7908 if (dfd == -1) {
7909 close(fd);
7910 redisLog(REDIS_WARNING,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno));
7911 return REDIS_ERR;
7912 }
7913 while(dumpsize) {
7914 int nread, nwritten;
7915
7916 nread = read(fd,buf,(dumpsize < 1024)?dumpsize:1024);
7917 if (nread == -1) {
7918 redisLog(REDIS_WARNING,"I/O error trying to sync with MASTER: %s",
7919 strerror(errno));
7920 close(fd);
7921 close(dfd);
7922 return REDIS_ERR;
7923 }
7924 nwritten = write(dfd,buf,nread);
7925 if (nwritten == -1) {
7926 redisLog(REDIS_WARNING,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno));
7927 close(fd);
7928 close(dfd);
7929 return REDIS_ERR;
7930 }
7931 dumpsize -= nread;
7932 }
7933 close(dfd);
7934 if (rename(tmpfile,server.dbfilename) == -1) {
7935 redisLog(REDIS_WARNING,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno));
7936 unlink(tmpfile);
7937 close(fd);
7938 return REDIS_ERR;
7939 }
7940 emptyDb();
7941 if (rdbLoad(server.dbfilename) != REDIS_OK) {
7942 redisLog(REDIS_WARNING,"Failed trying to load the MASTER synchronization DB from disk");
7943 close(fd);
7944 return REDIS_ERR;
7945 }
7946 server.master = createClient(fd);
7947 server.master->flags |= REDIS_MASTER;
7948 server.master->authenticated = 1;
7949 server.replstate = REDIS_REPL_CONNECTED;
7950 return REDIS_OK;
7951 }
7952
7953 static void slaveofCommand(redisClient *c) {
7954 if (!strcasecmp(c->argv[1]->ptr,"no") &&
7955 !strcasecmp(c->argv[2]->ptr,"one")) {
7956 if (server.masterhost) {
7957 sdsfree(server.masterhost);
7958 server.masterhost = NULL;
7959 if (server.master) freeClient(server.master);
7960 server.replstate = REDIS_REPL_NONE;
7961 redisLog(REDIS_NOTICE,"MASTER MODE enabled (user request)");
7962 }
7963 } else {
7964 sdsfree(server.masterhost);
7965 server.masterhost = sdsdup(c->argv[1]->ptr);
7966 server.masterport = atoi(c->argv[2]->ptr);
7967 if (server.master) freeClient(server.master);
7968 server.replstate = REDIS_REPL_CONNECT;
7969 redisLog(REDIS_NOTICE,"SLAVE OF %s:%d enabled (user request)",
7970 server.masterhost, server.masterport);
7971 }
7972 addReply(c,shared.ok);
7973 }
7974
7975 /* ============================ Maxmemory directive ======================== */
7976
7977 /* Try to free one object form the pre-allocated objects free list.
7978 * This is useful under low mem conditions as by default we take 1 million
7979 * free objects allocated. On success REDIS_OK is returned, otherwise
7980 * REDIS_ERR. */
7981 static int tryFreeOneObjectFromFreelist(void) {
7982 robj *o;
7983
7984 if (server.vm_enabled) pthread_mutex_lock(&server.obj_freelist_mutex);
7985 if (listLength(server.objfreelist)) {
7986 listNode *head = listFirst(server.objfreelist);
7987 o = listNodeValue(head);
7988 listDelNode(server.objfreelist,head);
7989 if (server.vm_enabled) pthread_mutex_unlock(&server.obj_freelist_mutex);
7990 zfree(o);
7991 return REDIS_OK;
7992 } else {
7993 if (server.vm_enabled) pthread_mutex_unlock(&server.obj_freelist_mutex);
7994 return REDIS_ERR;
7995 }
7996 }
7997
7998 /* This function gets called when 'maxmemory' is set on the config file to limit
7999 * the max memory used by the server, and we are out of memory.
8000 * This function will try to, in order:
8001 *
8002 * - Free objects from the free list
8003 * - Try to remove keys with an EXPIRE set
8004 *
8005 * It is not possible to free enough memory to reach used-memory < maxmemory
8006 * the server will start refusing commands that will enlarge even more the
8007 * memory usage.
8008 */
8009 static void freeMemoryIfNeeded(void) {
8010 while (server.maxmemory && zmalloc_used_memory() > server.maxmemory) {
8011 int j, k, freed = 0;
8012
8013 if (tryFreeOneObjectFromFreelist() == REDIS_OK) continue;
8014 for (j = 0; j < server.dbnum; j++) {
8015 int minttl = -1;
8016 robj *minkey = NULL;
8017 struct dictEntry *de;
8018
8019 if (dictSize(server.db[j].expires)) {
8020 freed = 1;
8021 /* From a sample of three keys drop the one nearest to
8022 * the natural expire */
8023 for (k = 0; k < 3; k++) {
8024 time_t t;
8025
8026 de = dictGetRandomKey(server.db[j].expires);
8027 t = (time_t) dictGetEntryVal(de);
8028 if (minttl == -1 || t < minttl) {
8029 minkey = dictGetEntryKey(de);
8030 minttl = t;
8031 }
8032 }
8033 deleteKey(server.db+j,minkey);
8034 }
8035 }
8036 if (!freed) return; /* nothing to free... */
8037 }
8038 }
8039
8040 /* ============================== Append Only file ========================== */
8041
8042 /* Write the append only file buffer on disk.
8043 *
8044 * Since we are required to write the AOF before replying to the client,
8045 * and the only way the client socket can get a write is entering when the
8046 * the event loop, we accumulate all the AOF writes in a memory
8047 * buffer and write it on disk using this function just before entering
8048 * the event loop again. */
8049 static void flushAppendOnlyFile(void) {
8050 time_t now;
8051 ssize_t nwritten;
8052
8053 if (sdslen(server.aofbuf) == 0) return;
8054
8055 /* We want to perform a single write. This should be guaranteed atomic
8056 * at least if the filesystem we are writing is a real physical one.
8057 * While this will save us against the server being killed I don't think
8058 * there is much to do about the whole server stopping for power problems
8059 * or alike */
8060 nwritten = write(server.appendfd,server.aofbuf,sdslen(server.aofbuf));
8061 if (nwritten != (signed)sdslen(server.aofbuf)) {
8062 /* Ooops, we are in troubles. The best thing to do for now is
8063 * aborting instead of giving the illusion that everything is
8064 * working as expected. */
8065 if (nwritten == -1) {
8066 redisLog(REDIS_WARNING,"Exiting on error writing to the append-only file: %s",strerror(errno));
8067 } else {
8068 redisLog(REDIS_WARNING,"Exiting on short write while writing to the append-only file: %s",strerror(errno));
8069 }
8070 exit(1);
8071 }
8072 sdsfree(server.aofbuf);
8073 server.aofbuf = sdsempty();
8074
8075 /* Fsync if needed */
8076 now = time(NULL);
8077 if (server.appendfsync == APPENDFSYNC_ALWAYS ||
8078 (server.appendfsync == APPENDFSYNC_EVERYSEC &&
8079 now-server.lastfsync > 1))
8080 {
8081 /* aof_fsync is defined as fdatasync() for Linux in order to avoid
8082 * flushing metadata. */
8083 aof_fsync(server.appendfd); /* Let's try to get this data on the disk */
8084 server.lastfsync = now;
8085 }
8086 }
8087
8088 static void feedAppendOnlyFile(struct redisCommand *cmd, int dictid, robj **argv, int argc) {
8089 sds buf = sdsempty();
8090 int j;
8091 robj *tmpargv[3];
8092
8093 /* The DB this command was targetting is not the same as the last command
8094 * we appendend. To issue a SELECT command is needed. */
8095 if (dictid != server.appendseldb) {
8096 char seldb[64];
8097
8098 snprintf(seldb,sizeof(seldb),"%d",dictid);
8099 buf = sdscatprintf(buf,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
8100 (unsigned long)strlen(seldb),seldb);
8101 server.appendseldb = dictid;
8102 }
8103
8104 /* "Fix" the argv vector if the command is EXPIRE. We want to translate
8105 * EXPIREs into EXPIREATs calls */
8106 if (cmd->proc == expireCommand) {
8107 long when;
8108
8109 tmpargv[0] = createStringObject("EXPIREAT",8);
8110 tmpargv[1] = argv[1];
8111 incrRefCount(argv[1]);
8112 when = time(NULL)+strtol(argv[2]->ptr,NULL,10);
8113 tmpargv[2] = createObject(REDIS_STRING,
8114 sdscatprintf(sdsempty(),"%ld",when));
8115 argv = tmpargv;
8116 }
8117
8118 /* Append the actual command */
8119 buf = sdscatprintf(buf,"*%d\r\n",argc);
8120 for (j = 0; j < argc; j++) {
8121 robj *o = argv[j];
8122
8123 o = getDecodedObject(o);
8124 buf = sdscatprintf(buf,"$%lu\r\n",(unsigned long)sdslen(o->ptr));
8125 buf = sdscatlen(buf,o->ptr,sdslen(o->ptr));
8126 buf = sdscatlen(buf,"\r\n",2);
8127 decrRefCount(o);
8128 }
8129
8130 /* Free the objects from the modified argv for EXPIREAT */
8131 if (cmd->proc == expireCommand) {
8132 for (j = 0; j < 3; j++)
8133 decrRefCount(argv[j]);
8134 }
8135
8136 /* Append to the AOF buffer. This will be flushed on disk just before
8137 * of re-entering the event loop, so before the client will get a
8138 * positive reply about the operation performed. */
8139 server.aofbuf = sdscatlen(server.aofbuf,buf,sdslen(buf));
8140
8141 /* If a background append only file rewriting is in progress we want to
8142 * accumulate the differences between the child DB and the current one
8143 * in a buffer, so that when the child process will do its work we
8144 * can append the differences to the new append only file. */
8145 if (server.bgrewritechildpid != -1)
8146 server.bgrewritebuf = sdscatlen(server.bgrewritebuf,buf,sdslen(buf));
8147
8148 sdsfree(buf);
8149 }
8150
8151 /* In Redis commands are always executed in the context of a client, so in
8152 * order to load the append only file we need to create a fake client. */
8153 static struct redisClient *createFakeClient(void) {
8154 struct redisClient *c = zmalloc(sizeof(*c));
8155
8156 selectDb(c,0);
8157 c->fd = -1;
8158 c->querybuf = sdsempty();
8159 c->argc = 0;
8160 c->argv = NULL;
8161 c->flags = 0;
8162 /* We set the fake client as a slave waiting for the synchronization
8163 * so that Redis will not try to send replies to this client. */
8164 c->replstate = REDIS_REPL_WAIT_BGSAVE_START;
8165 c->reply = listCreate();
8166 listSetFreeMethod(c->reply,decrRefCount);
8167 listSetDupMethod(c->reply,dupClientReplyValue);
8168 initClientMultiState(c);
8169 return c;
8170 }
8171
8172 static void freeFakeClient(struct redisClient *c) {
8173 sdsfree(c->querybuf);
8174 listRelease(c->reply);
8175 freeClientMultiState(c);
8176 zfree(c);
8177 }
8178
8179 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
8180 * error (the append only file is zero-length) REDIS_ERR is returned. On
8181 * fatal error an error message is logged and the program exists. */
8182 int loadAppendOnlyFile(char *filename) {
8183 struct redisClient *fakeClient;
8184 FILE *fp = fopen(filename,"r");
8185 struct redis_stat sb;
8186 unsigned long long loadedkeys = 0;
8187 int appendonly = server.appendonly;
8188
8189 if (redis_fstat(fileno(fp),&sb) != -1 && sb.st_size == 0)
8190 return REDIS_ERR;
8191
8192 if (fp == NULL) {
8193 redisLog(REDIS_WARNING,"Fatal error: can't open the append log file for reading: %s",strerror(errno));
8194 exit(1);
8195 }
8196
8197 /* Temporarily disable AOF, to prevent EXEC from feeding a MULTI
8198 * to the same file we're about to read. */
8199 server.appendonly = 0;
8200
8201 fakeClient = createFakeClient();
8202 while(1) {
8203 int argc, j;
8204 unsigned long len;
8205 robj **argv;
8206 char buf[128];
8207 sds argsds;
8208 struct redisCommand *cmd;
8209
8210 if (fgets(buf,sizeof(buf),fp) == NULL) {
8211 if (feof(fp))
8212 break;
8213 else
8214 goto readerr;
8215 }
8216 if (buf[0] != '*') goto fmterr;
8217 argc = atoi(buf+1);
8218 argv = zmalloc(sizeof(robj*)*argc);
8219 for (j = 0; j < argc; j++) {
8220 if (fgets(buf,sizeof(buf),fp) == NULL) goto readerr;
8221 if (buf[0] != '$') goto fmterr;
8222 len = strtol(buf+1,NULL,10);
8223 argsds = sdsnewlen(NULL,len);
8224 if (len && fread(argsds,len,1,fp) == 0) goto fmterr;
8225 argv[j] = createObject(REDIS_STRING,argsds);
8226 if (fread(buf,2,1,fp) == 0) goto fmterr; /* discard CRLF */
8227 }
8228
8229 /* Command lookup */
8230 cmd = lookupCommand(argv[0]->ptr);
8231 if (!cmd) {
8232 redisLog(REDIS_WARNING,"Unknown command '%s' reading the append only file", argv[0]->ptr);
8233 exit(1);
8234 }
8235 /* Try object encoding */
8236 if (cmd->flags & REDIS_CMD_BULK)
8237 argv[argc-1] = tryObjectEncoding(argv[argc-1]);
8238 /* Run the command in the context of a fake client */
8239 fakeClient->argc = argc;
8240 fakeClient->argv = argv;
8241 cmd->proc(fakeClient);
8242 /* Discard the reply objects list from the fake client */
8243 while(listLength(fakeClient->reply))
8244 listDelNode(fakeClient->reply,listFirst(fakeClient->reply));
8245 /* Clean up, ready for the next command */
8246 for (j = 0; j < argc; j++) decrRefCount(argv[j]);
8247 zfree(argv);
8248 /* Handle swapping while loading big datasets when VM is on */
8249 loadedkeys++;
8250 if (server.vm_enabled && (loadedkeys % 5000) == 0) {
8251 while (zmalloc_used_memory() > server.vm_max_memory) {
8252 if (vmSwapOneObjectBlocking() == REDIS_ERR) break;
8253 }
8254 }
8255 }
8256
8257 /* This point can only be reached when EOF is reached without errors.
8258 * If the client is in the middle of a MULTI/EXEC, log error and quit. */
8259 if (fakeClient->flags & REDIS_MULTI) goto readerr;
8260
8261 fclose(fp);
8262 freeFakeClient(fakeClient);
8263 server.appendonly = appendonly;
8264 return REDIS_OK;
8265
8266 readerr:
8267 if (feof(fp)) {
8268 redisLog(REDIS_WARNING,"Unexpected end of file reading the append only file");
8269 } else {
8270 redisLog(REDIS_WARNING,"Unrecoverable error reading the append only file: %s", strerror(errno));
8271 }
8272 exit(1);
8273 fmterr:
8274 redisLog(REDIS_WARNING,"Bad file format reading the append only file");
8275 exit(1);
8276 }
8277
8278 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
8279 static int fwriteBulkObject(FILE *fp, robj *obj) {
8280 char buf[128];
8281 int decrrc = 0;
8282
8283 /* Avoid the incr/decr ref count business if possible to help
8284 * copy-on-write (we are often in a child process when this function
8285 * is called).
8286 * Also makes sure that key objects don't get incrRefCount-ed when VM
8287 * is enabled */
8288 if (obj->encoding != REDIS_ENCODING_RAW) {
8289 obj = getDecodedObject(obj);
8290 decrrc = 1;
8291 }
8292 snprintf(buf,sizeof(buf),"$%ld\r\n",(long)sdslen(obj->ptr));
8293 if (fwrite(buf,strlen(buf),1,fp) == 0) goto err;
8294 if (sdslen(obj->ptr) && fwrite(obj->ptr,sdslen(obj->ptr),1,fp) == 0)
8295 goto err;
8296 if (fwrite("\r\n",2,1,fp) == 0) goto err;
8297 if (decrrc) decrRefCount(obj);
8298 return 1;
8299 err:
8300 if (decrrc) decrRefCount(obj);
8301 return 0;
8302 }
8303
8304 /* Write binary-safe string into a file in the bulkformat
8305 * $<count>\r\n<payload>\r\n */
8306 static int fwriteBulkString(FILE *fp, char *s, unsigned long len) {
8307 char buf[128];
8308
8309 snprintf(buf,sizeof(buf),"$%ld\r\n",(unsigned long)len);
8310 if (fwrite(buf,strlen(buf),1,fp) == 0) return 0;
8311 if (len && fwrite(s,len,1,fp) == 0) return 0;
8312 if (fwrite("\r\n",2,1,fp) == 0) return 0;
8313 return 1;
8314 }
8315
8316 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
8317 static int fwriteBulkDouble(FILE *fp, double d) {
8318 char buf[128], dbuf[128];
8319
8320 snprintf(dbuf,sizeof(dbuf),"%.17g\r\n",d);
8321 snprintf(buf,sizeof(buf),"$%lu\r\n",(unsigned long)strlen(dbuf)-2);
8322 if (fwrite(buf,strlen(buf),1,fp) == 0) return 0;
8323 if (fwrite(dbuf,strlen(dbuf),1,fp) == 0) return 0;
8324 return 1;
8325 }
8326
8327 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
8328 static int fwriteBulkLong(FILE *fp, long l) {
8329 char buf[128], lbuf[128];
8330
8331 snprintf(lbuf,sizeof(lbuf),"%ld\r\n",l);
8332 snprintf(buf,sizeof(buf),"$%lu\r\n",(unsigned long)strlen(lbuf)-2);
8333 if (fwrite(buf,strlen(buf),1,fp) == 0) return 0;
8334 if (fwrite(lbuf,strlen(lbuf),1,fp) == 0) return 0;
8335 return 1;
8336 }
8337
8338 /* Write a sequence of commands able to fully rebuild the dataset into
8339 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
8340 static int rewriteAppendOnlyFile(char *filename) {
8341 dictIterator *di = NULL;
8342 dictEntry *de;
8343 FILE *fp;
8344 char tmpfile[256];
8345 int j;
8346 time_t now = time(NULL);
8347
8348 /* Note that we have to use a different temp name here compared to the
8349 * one used by rewriteAppendOnlyFileBackground() function. */
8350 snprintf(tmpfile,256,"temp-rewriteaof-%d.aof", (int) getpid());
8351 fp = fopen(tmpfile,"w");
8352 if (!fp) {
8353 redisLog(REDIS_WARNING, "Failed rewriting the append only file: %s", strerror(errno));
8354 return REDIS_ERR;
8355 }
8356 for (j = 0; j < server.dbnum; j++) {
8357 char selectcmd[] = "*2\r\n$6\r\nSELECT\r\n";
8358 redisDb *db = server.db+j;
8359 dict *d = db->dict;
8360 if (dictSize(d) == 0) continue;
8361 di = dictGetIterator(d);
8362 if (!di) {
8363 fclose(fp);
8364 return REDIS_ERR;
8365 }
8366
8367 /* SELECT the new DB */
8368 if (fwrite(selectcmd,sizeof(selectcmd)-1,1,fp) == 0) goto werr;
8369 if (fwriteBulkLong(fp,j) == 0) goto werr;
8370
8371 /* Iterate this DB writing every entry */
8372 while((de = dictNext(di)) != NULL) {
8373 robj *key, *o;
8374 time_t expiretime;
8375 int swapped;
8376
8377 key = dictGetEntryKey(de);
8378 /* If the value for this key is swapped, load a preview in memory.
8379 * We use a "swapped" flag to remember if we need to free the
8380 * value object instead to just increment the ref count anyway
8381 * in order to avoid copy-on-write of pages if we are forked() */
8382 if (!server.vm_enabled || key->storage == REDIS_VM_MEMORY ||
8383 key->storage == REDIS_VM_SWAPPING) {
8384 o = dictGetEntryVal(de);
8385 swapped = 0;
8386 } else {
8387 o = vmPreviewObject(key);
8388 swapped = 1;
8389 }
8390 expiretime = getExpire(db,key);
8391
8392 /* Save the key and associated value */
8393 if (o->type == REDIS_STRING) {
8394 /* Emit a SET command */
8395 char cmd[]="*3\r\n$3\r\nSET\r\n";
8396 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
8397 /* Key and value */
8398 if (fwriteBulkObject(fp,key) == 0) goto werr;
8399 if (fwriteBulkObject(fp,o) == 0) goto werr;
8400 } else if (o->type == REDIS_LIST) {
8401 /* Emit the RPUSHes needed to rebuild the list */
8402 list *list = o->ptr;
8403 listNode *ln;
8404 listIter li;
8405
8406 listRewind(list,&li);
8407 while((ln = listNext(&li))) {
8408 char cmd[]="*3\r\n$5\r\nRPUSH\r\n";
8409 robj *eleobj = listNodeValue(ln);
8410
8411 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
8412 if (fwriteBulkObject(fp,key) == 0) goto werr;
8413 if (fwriteBulkObject(fp,eleobj) == 0) goto werr;
8414 }
8415 } else if (o->type == REDIS_SET) {
8416 /* Emit the SADDs needed to rebuild the set */
8417 dict *set = o->ptr;
8418 dictIterator *di = dictGetIterator(set);
8419 dictEntry *de;
8420
8421 while((de = dictNext(di)) != NULL) {
8422 char cmd[]="*3\r\n$4\r\nSADD\r\n";
8423 robj *eleobj = dictGetEntryKey(de);
8424
8425 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
8426 if (fwriteBulkObject(fp,key) == 0) goto werr;
8427 if (fwriteBulkObject(fp,eleobj) == 0) goto werr;
8428 }
8429 dictReleaseIterator(di);
8430 } else if (o->type == REDIS_ZSET) {
8431 /* Emit the ZADDs needed to rebuild the sorted set */
8432 zset *zs = o->ptr;
8433 dictIterator *di = dictGetIterator(zs->dict);
8434 dictEntry *de;
8435
8436 while((de = dictNext(di)) != NULL) {
8437 char cmd[]="*4\r\n$4\r\nZADD\r\n";
8438 robj *eleobj = dictGetEntryKey(de);
8439 double *score = dictGetEntryVal(de);
8440
8441 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
8442 if (fwriteBulkObject(fp,key) == 0) goto werr;
8443 if (fwriteBulkDouble(fp,*score) == 0) goto werr;
8444 if (fwriteBulkObject(fp,eleobj) == 0) goto werr;
8445 }
8446 dictReleaseIterator(di);
8447 } else if (o->type == REDIS_HASH) {
8448 char cmd[]="*4\r\n$4\r\nHSET\r\n";
8449
8450 /* Emit the HSETs needed to rebuild the hash */
8451 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
8452 unsigned char *p = zipmapRewind(o->ptr);
8453 unsigned char *field, *val;
8454 unsigned int flen, vlen;
8455
8456 while((p = zipmapNext(p,&field,&flen,&val,&vlen)) != NULL) {
8457 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
8458 if (fwriteBulkObject(fp,key) == 0) goto werr;
8459 if (fwriteBulkString(fp,(char*)field,flen) == -1)
8460 return -1;
8461 if (fwriteBulkString(fp,(char*)val,vlen) == -1)
8462 return -1;
8463 }
8464 } else {
8465 dictIterator *di = dictGetIterator(o->ptr);
8466 dictEntry *de;
8467
8468 while((de = dictNext(di)) != NULL) {
8469 robj *field = dictGetEntryKey(de);
8470 robj *val = dictGetEntryVal(de);
8471
8472 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
8473 if (fwriteBulkObject(fp,key) == 0) goto werr;
8474 if (fwriteBulkObject(fp,field) == -1) return -1;
8475 if (fwriteBulkObject(fp,val) == -1) return -1;
8476 }
8477 dictReleaseIterator(di);
8478 }
8479 } else {
8480 redisPanic("Unknown object type");
8481 }
8482 /* Save the expire time */
8483 if (expiretime != -1) {
8484 char cmd[]="*3\r\n$8\r\nEXPIREAT\r\n";
8485 /* If this key is already expired skip it */
8486 if (expiretime < now) continue;
8487 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
8488 if (fwriteBulkObject(fp,key) == 0) goto werr;
8489 if (fwriteBulkLong(fp,expiretime) == 0) goto werr;
8490 }
8491 if (swapped) decrRefCount(o);
8492 }
8493 dictReleaseIterator(di);
8494 }
8495
8496 /* Make sure data will not remain on the OS's output buffers */
8497 fflush(fp);
8498 fsync(fileno(fp));
8499 fclose(fp);
8500
8501 /* Use RENAME to make sure the DB file is changed atomically only
8502 * if the generate DB file is ok. */
8503 if (rename(tmpfile,filename) == -1) {
8504 redisLog(REDIS_WARNING,"Error moving temp append only file on the final destination: %s", strerror(errno));
8505 unlink(tmpfile);
8506 return REDIS_ERR;
8507 }
8508 redisLog(REDIS_NOTICE,"SYNC append only file rewrite performed");
8509 return REDIS_OK;
8510
8511 werr:
8512 fclose(fp);
8513 unlink(tmpfile);
8514 redisLog(REDIS_WARNING,"Write error writing append only file on disk: %s", strerror(errno));
8515 if (di) dictReleaseIterator(di);
8516 return REDIS_ERR;
8517 }
8518
8519 /* This is how rewriting of the append only file in background works:
8520 *
8521 * 1) The user calls BGREWRITEAOF
8522 * 2) Redis calls this function, that forks():
8523 * 2a) the child rewrite the append only file in a temp file.
8524 * 2b) the parent accumulates differences in server.bgrewritebuf.
8525 * 3) When the child finished '2a' exists.
8526 * 4) The parent will trap the exit code, if it's OK, will append the
8527 * data accumulated into server.bgrewritebuf into the temp file, and
8528 * finally will rename(2) the temp file in the actual file name.
8529 * The the new file is reopened as the new append only file. Profit!
8530 */
8531 static int rewriteAppendOnlyFileBackground(void) {
8532 pid_t childpid;
8533
8534 if (server.bgrewritechildpid != -1) return REDIS_ERR;
8535 if (server.vm_enabled) waitEmptyIOJobsQueue();
8536 if ((childpid = fork()) == 0) {
8537 /* Child */
8538 char tmpfile[256];
8539
8540 if (server.vm_enabled) vmReopenSwapFile();
8541 close(server.fd);
8542 snprintf(tmpfile,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
8543 if (rewriteAppendOnlyFile(tmpfile) == REDIS_OK) {
8544 _exit(0);
8545 } else {
8546 _exit(1);
8547 }
8548 } else {
8549 /* Parent */
8550 if (childpid == -1) {
8551 redisLog(REDIS_WARNING,
8552 "Can't rewrite append only file in background: fork: %s",
8553 strerror(errno));
8554 return REDIS_ERR;
8555 }
8556 redisLog(REDIS_NOTICE,
8557 "Background append only file rewriting started by pid %d",childpid);
8558 server.bgrewritechildpid = childpid;
8559 updateDictResizePolicy();
8560 /* We set appendseldb to -1 in order to force the next call to the
8561 * feedAppendOnlyFile() to issue a SELECT command, so the differences
8562 * accumulated by the parent into server.bgrewritebuf will start
8563 * with a SELECT statement and it will be safe to merge. */
8564 server.appendseldb = -1;
8565 return REDIS_OK;
8566 }
8567 return REDIS_OK; /* unreached */
8568 }
8569
8570 static void bgrewriteaofCommand(redisClient *c) {
8571 if (server.bgrewritechildpid != -1) {
8572 addReplySds(c,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
8573 return;
8574 }
8575 if (rewriteAppendOnlyFileBackground() == REDIS_OK) {
8576 char *status = "+Background append only file rewriting started\r\n";
8577 addReplySds(c,sdsnew(status));
8578 } else {
8579 addReply(c,shared.err);
8580 }
8581 }
8582
8583 static void aofRemoveTempFile(pid_t childpid) {
8584 char tmpfile[256];
8585
8586 snprintf(tmpfile,256,"temp-rewriteaof-bg-%d.aof", (int) childpid);
8587 unlink(tmpfile);
8588 }
8589
8590 /* Virtual Memory is composed mainly of two subsystems:
8591 * - Blocking Virutal Memory
8592 * - Threaded Virtual Memory I/O
8593 * The two parts are not fully decoupled, but functions are split among two
8594 * different sections of the source code (delimited by comments) in order to
8595 * make more clear what functionality is about the blocking VM and what about
8596 * the threaded (not blocking) VM.
8597 *
8598 * Redis VM design:
8599 *
8600 * Redis VM is a blocking VM (one that blocks reading swapped values from
8601 * disk into memory when a value swapped out is needed in memory) that is made
8602 * unblocking by trying to examine the command argument vector in order to
8603 * load in background values that will likely be needed in order to exec
8604 * the command. The command is executed only once all the relevant keys
8605 * are loaded into memory.
8606 *
8607 * This basically is almost as simple of a blocking VM, but almost as parallel
8608 * as a fully non-blocking VM.
8609 */
8610
8611 /* =================== Virtual Memory - Blocking Side ====================== */
8612
8613 static void vmInit(void) {
8614 off_t totsize;
8615 int pipefds[2];
8616 size_t stacksize;
8617 struct flock fl;
8618
8619 if (server.vm_max_threads != 0)
8620 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
8621
8622 redisLog(REDIS_NOTICE,"Using '%s' as swap file",server.vm_swap_file);
8623 /* Try to open the old swap file, otherwise create it */
8624 if ((server.vm_fp = fopen(server.vm_swap_file,"r+b")) == NULL) {
8625 server.vm_fp = fopen(server.vm_swap_file,"w+b");
8626 }
8627 if (server.vm_fp == NULL) {
8628 redisLog(REDIS_WARNING,
8629 "Can't open the swap file: %s. Exiting.",
8630 strerror(errno));
8631 exit(1);
8632 }
8633 server.vm_fd = fileno(server.vm_fp);
8634 /* Lock the swap file for writing, this is useful in order to avoid
8635 * another instance to use the same swap file for a config error. */
8636 fl.l_type = F_WRLCK;
8637 fl.l_whence = SEEK_SET;
8638 fl.l_start = fl.l_len = 0;
8639 if (fcntl(server.vm_fd,F_SETLK,&fl) == -1) {
8640 redisLog(REDIS_WARNING,
8641 "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));
8642 exit(1);
8643 }
8644 /* Initialize */
8645 server.vm_next_page = 0;
8646 server.vm_near_pages = 0;
8647 server.vm_stats_used_pages = 0;
8648 server.vm_stats_swapped_objects = 0;
8649 server.vm_stats_swapouts = 0;
8650 server.vm_stats_swapins = 0;
8651 totsize = server.vm_pages*server.vm_page_size;
8652 redisLog(REDIS_NOTICE,"Allocating %lld bytes of swap file",totsize);
8653 if (ftruncate(server.vm_fd,totsize) == -1) {
8654 redisLog(REDIS_WARNING,"Can't ftruncate swap file: %s. Exiting.",
8655 strerror(errno));
8656 exit(1);
8657 } else {
8658 redisLog(REDIS_NOTICE,"Swap file allocated with success");
8659 }
8660 server.vm_bitmap = zmalloc((server.vm_pages+7)/8);
8661 redisLog(REDIS_VERBOSE,"Allocated %lld bytes page table for %lld pages",
8662 (long long) (server.vm_pages+7)/8, server.vm_pages);
8663 memset(server.vm_bitmap,0,(server.vm_pages+7)/8);
8664
8665 /* Initialize threaded I/O (used by Virtual Memory) */
8666 server.io_newjobs = listCreate();
8667 server.io_processing = listCreate();
8668 server.io_processed = listCreate();
8669 server.io_ready_clients = listCreate();
8670 pthread_mutex_init(&server.io_mutex,NULL);
8671 pthread_mutex_init(&server.obj_freelist_mutex,NULL);
8672 pthread_mutex_init(&server.io_swapfile_mutex,NULL);
8673 server.io_active_threads = 0;
8674 if (pipe(pipefds) == -1) {
8675 redisLog(REDIS_WARNING,"Unable to intialized VM: pipe(2): %s. Exiting."
8676 ,strerror(errno));
8677 exit(1);
8678 }
8679 server.io_ready_pipe_read = pipefds[0];
8680 server.io_ready_pipe_write = pipefds[1];
8681 redisAssert(anetNonBlock(NULL,server.io_ready_pipe_read) != ANET_ERR);
8682 /* LZF requires a lot of stack */
8683 pthread_attr_init(&server.io_threads_attr);
8684 pthread_attr_getstacksize(&server.io_threads_attr, &stacksize);
8685 while (stacksize < REDIS_THREAD_STACK_SIZE) stacksize *= 2;
8686 pthread_attr_setstacksize(&server.io_threads_attr, stacksize);
8687 /* Listen for events in the threaded I/O pipe */
8688 if (aeCreateFileEvent(server.el, server.io_ready_pipe_read, AE_READABLE,
8689 vmThreadedIOCompletedJob, NULL) == AE_ERR)
8690 oom("creating file event");
8691 }
8692
8693 /* Mark the page as used */
8694 static void vmMarkPageUsed(off_t page) {
8695 off_t byte = page/8;
8696 int bit = page&7;
8697 redisAssert(vmFreePage(page) == 1);
8698 server.vm_bitmap[byte] |= 1<<bit;
8699 }
8700
8701 /* Mark N contiguous pages as used, with 'page' being the first. */
8702 static void vmMarkPagesUsed(off_t page, off_t count) {
8703 off_t j;
8704
8705 for (j = 0; j < count; j++)
8706 vmMarkPageUsed(page+j);
8707 server.vm_stats_used_pages += count;
8708 redisLog(REDIS_DEBUG,"Mark USED pages: %lld pages at %lld\n",
8709 (long long)count, (long long)page);
8710 }
8711
8712 /* Mark the page as free */
8713 static void vmMarkPageFree(off_t page) {
8714 off_t byte = page/8;
8715 int bit = page&7;
8716 redisAssert(vmFreePage(page) == 0);
8717 server.vm_bitmap[byte] &= ~(1<<bit);
8718 }
8719
8720 /* Mark N contiguous pages as free, with 'page' being the first. */
8721 static void vmMarkPagesFree(off_t page, off_t count) {
8722 off_t j;
8723
8724 for (j = 0; j < count; j++)
8725 vmMarkPageFree(page+j);
8726 server.vm_stats_used_pages -= count;
8727 redisLog(REDIS_DEBUG,"Mark FREE pages: %lld pages at %lld\n",
8728 (long long)count, (long long)page);
8729 }
8730
8731 /* Test if the page is free */
8732 static int vmFreePage(off_t page) {
8733 off_t byte = page/8;
8734 int bit = page&7;
8735 return (server.vm_bitmap[byte] & (1<<bit)) == 0;
8736 }
8737
8738 /* Find N contiguous free pages storing the first page of the cluster in *first.
8739 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
8740 * REDIS_ERR is returned.
8741 *
8742 * This function uses a simple algorithm: we try to allocate
8743 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
8744 * again from the start of the swap file searching for free spaces.
8745 *
8746 * If it looks pretty clear that there are no free pages near our offset
8747 * we try to find less populated places doing a forward jump of
8748 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
8749 * without hurry, and then we jump again and so forth...
8750 *
8751 * This function can be improved using a free list to avoid to guess
8752 * too much, since we could collect data about freed pages.
8753 *
8754 * note: I implemented this function just after watching an episode of
8755 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
8756 */
8757 static int vmFindContiguousPages(off_t *first, off_t n) {
8758 off_t base, offset = 0, since_jump = 0, numfree = 0;
8759
8760 if (server.vm_near_pages == REDIS_VM_MAX_NEAR_PAGES) {
8761 server.vm_near_pages = 0;
8762 server.vm_next_page = 0;
8763 }
8764 server.vm_near_pages++; /* Yet another try for pages near to the old ones */
8765 base = server.vm_next_page;
8766
8767 while(offset < server.vm_pages) {
8768 off_t this = base+offset;
8769
8770 /* If we overflow, restart from page zero */
8771 if (this >= server.vm_pages) {
8772 this -= server.vm_pages;
8773 if (this == 0) {
8774 /* Just overflowed, what we found on tail is no longer
8775 * interesting, as it's no longer contiguous. */
8776 numfree = 0;
8777 }
8778 }
8779 if (vmFreePage(this)) {
8780 /* This is a free page */
8781 numfree++;
8782 /* Already got N free pages? Return to the caller, with success */
8783 if (numfree == n) {
8784 *first = this-(n-1);
8785 server.vm_next_page = this+1;
8786 redisLog(REDIS_DEBUG, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n, (long long) *first);
8787 return REDIS_OK;
8788 }
8789 } else {
8790 /* The current one is not a free page */
8791 numfree = 0;
8792 }
8793
8794 /* Fast-forward if the current page is not free and we already
8795 * searched enough near this place. */
8796 since_jump++;
8797 if (!numfree && since_jump >= REDIS_VM_MAX_RANDOM_JUMP/4) {
8798 offset += random() % REDIS_VM_MAX_RANDOM_JUMP;
8799 since_jump = 0;
8800 /* Note that even if we rewind after the jump, we are don't need
8801 * to make sure numfree is set to zero as we only jump *if* it
8802 * is set to zero. */
8803 } else {
8804 /* Otherwise just check the next page */
8805 offset++;
8806 }
8807 }
8808 return REDIS_ERR;
8809 }
8810
8811 /* Write the specified object at the specified page of the swap file */
8812 static int vmWriteObjectOnSwap(robj *o, off_t page) {
8813 if (server.vm_enabled) pthread_mutex_lock(&server.io_swapfile_mutex);
8814 if (fseeko(server.vm_fp,page*server.vm_page_size,SEEK_SET) == -1) {
8815 if (server.vm_enabled) pthread_mutex_unlock(&server.io_swapfile_mutex);
8816 redisLog(REDIS_WARNING,
8817 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
8818 strerror(errno));
8819 return REDIS_ERR;
8820 }
8821 rdbSaveObject(server.vm_fp,o);
8822 fflush(server.vm_fp);
8823 if (server.vm_enabled) pthread_mutex_unlock(&server.io_swapfile_mutex);
8824 return REDIS_OK;
8825 }
8826
8827 /* Swap the 'val' object relative to 'key' into disk. Store all the information
8828 * needed to later retrieve the object into the key object.
8829 * If we can't find enough contiguous empty pages to swap the object on disk
8830 * REDIS_ERR is returned. */
8831 static int vmSwapObjectBlocking(robj *key, robj *val) {
8832 off_t pages = rdbSavedObjectPages(val,NULL);
8833 off_t page;
8834
8835 assert(key->storage == REDIS_VM_MEMORY);
8836 assert(key->refcount == 1);
8837 if (vmFindContiguousPages(&page,pages) == REDIS_ERR) return REDIS_ERR;
8838 if (vmWriteObjectOnSwap(val,page) == REDIS_ERR) return REDIS_ERR;
8839 key->vm.page = page;
8840 key->vm.usedpages = pages;
8841 key->storage = REDIS_VM_SWAPPED;
8842 key->vtype = val->type;
8843 decrRefCount(val); /* Deallocate the object from memory. */
8844 vmMarkPagesUsed(page,pages);
8845 redisLog(REDIS_DEBUG,"VM: object %s swapped out at %lld (%lld pages)",
8846 (unsigned char*) key->ptr,
8847 (unsigned long long) page, (unsigned long long) pages);
8848 server.vm_stats_swapped_objects++;
8849 server.vm_stats_swapouts++;
8850 return REDIS_OK;
8851 }
8852
8853 static robj *vmReadObjectFromSwap(off_t page, int type) {
8854 robj *o;
8855
8856 if (server.vm_enabled) pthread_mutex_lock(&server.io_swapfile_mutex);
8857 if (fseeko(server.vm_fp,page*server.vm_page_size,SEEK_SET) == -1) {
8858 redisLog(REDIS_WARNING,
8859 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
8860 strerror(errno));
8861 _exit(1);
8862 }
8863 o = rdbLoadObject(type,server.vm_fp);
8864 if (o == NULL) {
8865 redisLog(REDIS_WARNING, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno));
8866 _exit(1);
8867 }
8868 if (server.vm_enabled) pthread_mutex_unlock(&server.io_swapfile_mutex);
8869 return o;
8870 }
8871
8872 /* Load the value object relative to the 'key' object from swap to memory.
8873 * The newly allocated object is returned.
8874 *
8875 * If preview is true the unserialized object is returned to the caller but
8876 * no changes are made to the key object, nor the pages are marked as freed */
8877 static robj *vmGenericLoadObject(robj *key, int preview) {
8878 robj *val;
8879
8880 redisAssert(key->storage == REDIS_VM_SWAPPED || key->storage == REDIS_VM_LOADING);
8881 val = vmReadObjectFromSwap(key->vm.page,key->vtype);
8882 if (!preview) {
8883 key->storage = REDIS_VM_MEMORY;
8884 key->vm.atime = server.unixtime;
8885 vmMarkPagesFree(key->vm.page,key->vm.usedpages);
8886 redisLog(REDIS_DEBUG, "VM: object %s loaded from disk",
8887 (unsigned char*) key->ptr);
8888 server.vm_stats_swapped_objects--;
8889 } else {
8890 redisLog(REDIS_DEBUG, "VM: object %s previewed from disk",
8891 (unsigned char*) key->ptr);
8892 }
8893 server.vm_stats_swapins++;
8894 return val;
8895 }
8896
8897 /* Plain object loading, from swap to memory */
8898 static robj *vmLoadObject(robj *key) {
8899 /* If we are loading the object in background, stop it, we
8900 * need to load this object synchronously ASAP. */
8901 if (key->storage == REDIS_VM_LOADING)
8902 vmCancelThreadedIOJob(key);
8903 return vmGenericLoadObject(key,0);
8904 }
8905
8906 /* Just load the value on disk, without to modify the key.
8907 * This is useful when we want to perform some operation on the value
8908 * without to really bring it from swap to memory, like while saving the
8909 * dataset or rewriting the append only log. */
8910 static robj *vmPreviewObject(robj *key) {
8911 return vmGenericLoadObject(key,1);
8912 }
8913
8914 /* How a good candidate is this object for swapping?
8915 * The better candidate it is, the greater the returned value.
8916 *
8917 * Currently we try to perform a fast estimation of the object size in
8918 * memory, and combine it with aging informations.
8919 *
8920 * Basically swappability = idle-time * log(estimated size)
8921 *
8922 * Bigger objects are preferred over smaller objects, but not
8923 * proportionally, this is why we use the logarithm. This algorithm is
8924 * just a first try and will probably be tuned later. */
8925 static double computeObjectSwappability(robj *o) {
8926 time_t age = server.unixtime - o->vm.atime;
8927 long asize = 0;
8928 list *l;
8929 dict *d;
8930 struct dictEntry *de;
8931 int z;
8932
8933 if (age <= 0) return 0;
8934 switch(o->type) {
8935 case REDIS_STRING:
8936 if (o->encoding != REDIS_ENCODING_RAW) {
8937 asize = sizeof(*o);
8938 } else {
8939 asize = sdslen(o->ptr)+sizeof(*o)+sizeof(long)*2;
8940 }
8941 break;
8942 case REDIS_LIST:
8943 l = o->ptr;
8944 listNode *ln = listFirst(l);
8945
8946 asize = sizeof(list);
8947 if (ln) {
8948 robj *ele = ln->value;
8949 long elesize;
8950
8951 elesize = (ele->encoding == REDIS_ENCODING_RAW) ?
8952 (sizeof(*o)+sdslen(ele->ptr)) :
8953 sizeof(*o);
8954 asize += (sizeof(listNode)+elesize)*listLength(l);
8955 }
8956 break;
8957 case REDIS_SET:
8958 case REDIS_ZSET:
8959 z = (o->type == REDIS_ZSET);
8960 d = z ? ((zset*)o->ptr)->dict : o->ptr;
8961
8962 asize = sizeof(dict)+(sizeof(struct dictEntry*)*dictSlots(d));
8963 if (z) asize += sizeof(zset)-sizeof(dict);
8964 if (dictSize(d)) {
8965 long elesize;
8966 robj *ele;
8967
8968 de = dictGetRandomKey(d);
8969 ele = dictGetEntryKey(de);
8970 elesize = (ele->encoding == REDIS_ENCODING_RAW) ?
8971 (sizeof(*o)+sdslen(ele->ptr)) :
8972 sizeof(*o);
8973 asize += (sizeof(struct dictEntry)+elesize)*dictSize(d);
8974 if (z) asize += sizeof(zskiplistNode)*dictSize(d);
8975 }
8976 break;
8977 case REDIS_HASH:
8978 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
8979 unsigned char *p = zipmapRewind((unsigned char*)o->ptr);
8980 unsigned int len = zipmapLen((unsigned char*)o->ptr);
8981 unsigned int klen, vlen;
8982 unsigned char *key, *val;
8983
8984 if ((p = zipmapNext(p,&key,&klen,&val,&vlen)) == NULL) {
8985 klen = 0;
8986 vlen = 0;
8987 }
8988 asize = len*(klen+vlen+3);
8989 } else if (o->encoding == REDIS_ENCODING_HT) {
8990 d = o->ptr;
8991 asize = sizeof(dict)+(sizeof(struct dictEntry*)*dictSlots(d));
8992 if (dictSize(d)) {
8993 long elesize;
8994 robj *ele;
8995
8996 de = dictGetRandomKey(d);
8997 ele = dictGetEntryKey(de);
8998 elesize = (ele->encoding == REDIS_ENCODING_RAW) ?
8999 (sizeof(*o)+sdslen(ele->ptr)) :
9000 sizeof(*o);
9001 ele = dictGetEntryVal(de);
9002 elesize = (ele->encoding == REDIS_ENCODING_RAW) ?
9003 (sizeof(*o)+sdslen(ele->ptr)) :
9004 sizeof(*o);
9005 asize += (sizeof(struct dictEntry)+elesize)*dictSize(d);
9006 }
9007 }
9008 break;
9009 }
9010 return (double)age*log(1+asize);
9011 }
9012
9013 /* Try to swap an object that's a good candidate for swapping.
9014 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
9015 * to swap any object at all.
9016 *
9017 * If 'usethreaded' is true, Redis will try to swap the object in background
9018 * using I/O threads. */
9019 static int vmSwapOneObject(int usethreads) {
9020 int j, i;
9021 struct dictEntry *best = NULL;
9022 double best_swappability = 0;
9023 redisDb *best_db = NULL;
9024 robj *key, *val;
9025
9026 for (j = 0; j < server.dbnum; j++) {
9027 redisDb *db = server.db+j;
9028 /* Why maxtries is set to 100?
9029 * Because this way (usually) we'll find 1 object even if just 1% - 2%
9030 * are swappable objects */
9031 int maxtries = 100;
9032
9033 if (dictSize(db->dict) == 0) continue;
9034 for (i = 0; i < 5; i++) {
9035 dictEntry *de;
9036 double swappability;
9037
9038 if (maxtries) maxtries--;
9039 de = dictGetRandomKey(db->dict);
9040 key = dictGetEntryKey(de);
9041 val = dictGetEntryVal(de);
9042 /* Only swap objects that are currently in memory.
9043 *
9044 * Also don't swap shared objects if threaded VM is on, as we
9045 * try to ensure that the main thread does not touch the
9046 * object while the I/O thread is using it, but we can't
9047 * control other keys without adding additional mutex. */
9048 if (key->storage != REDIS_VM_MEMORY ||
9049 (server.vm_max_threads != 0 && val->refcount != 1)) {
9050 if (maxtries) i--; /* don't count this try */
9051 continue;
9052 }
9053 swappability = computeObjectSwappability(val);
9054 if (!best || swappability > best_swappability) {
9055 best = de;
9056 best_swappability = swappability;
9057 best_db = db;
9058 }
9059 }
9060 }
9061 if (best == NULL) return REDIS_ERR;
9062 key = dictGetEntryKey(best);
9063 val = dictGetEntryVal(best);
9064
9065 redisLog(REDIS_DEBUG,"Key with best swappability: %s, %f",
9066 key->ptr, best_swappability);
9067
9068 /* Unshare the key if needed */
9069 if (key->refcount > 1) {
9070 robj *newkey = dupStringObject(key);
9071 decrRefCount(key);
9072 key = dictGetEntryKey(best) = newkey;
9073 }
9074 /* Swap it */
9075 if (usethreads) {
9076 vmSwapObjectThreaded(key,val,best_db);
9077 return REDIS_OK;
9078 } else {
9079 if (vmSwapObjectBlocking(key,val) == REDIS_OK) {
9080 dictGetEntryVal(best) = NULL;
9081 return REDIS_OK;
9082 } else {
9083 return REDIS_ERR;
9084 }
9085 }
9086 }
9087
9088 static int vmSwapOneObjectBlocking() {
9089 return vmSwapOneObject(0);
9090 }
9091
9092 static int vmSwapOneObjectThreaded() {
9093 return vmSwapOneObject(1);
9094 }
9095
9096 /* Return true if it's safe to swap out objects in a given moment.
9097 * Basically we don't want to swap objects out while there is a BGSAVE
9098 * or a BGAEOREWRITE running in backgroud. */
9099 static int vmCanSwapOut(void) {
9100 return (server.bgsavechildpid == -1 && server.bgrewritechildpid == -1);
9101 }
9102
9103 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
9104 * and was deleted. Otherwise 0 is returned. */
9105 static int deleteIfSwapped(redisDb *db, robj *key) {
9106 dictEntry *de;
9107 robj *foundkey;
9108
9109 if ((de = dictFind(db->dict,key)) == NULL) return 0;
9110 foundkey = dictGetEntryKey(de);
9111 if (foundkey->storage == REDIS_VM_MEMORY) return 0;
9112 deleteKey(db,key);
9113 return 1;
9114 }
9115
9116 /* =================== Virtual Memory - Threaded I/O ======================= */
9117
9118 static void freeIOJob(iojob *j) {
9119 if ((j->type == REDIS_IOJOB_PREPARE_SWAP ||
9120 j->type == REDIS_IOJOB_DO_SWAP ||
9121 j->type == REDIS_IOJOB_LOAD) && j->val != NULL)
9122 decrRefCount(j->val);
9123 /* We don't decrRefCount the j->key field as we did't incremented
9124 * the count creating IO Jobs. This is because the key field here is
9125 * just used as an indentifier and if a key is removed the Job should
9126 * never be touched again. */
9127 zfree(j);
9128 }
9129
9130 /* Every time a thread finished a Job, it writes a byte into the write side
9131 * of an unix pipe in order to "awake" the main thread, and this function
9132 * is called. */
9133 static void vmThreadedIOCompletedJob(aeEventLoop *el, int fd, void *privdata,
9134 int mask)
9135 {
9136 char buf[1];
9137 int retval, processed = 0, toprocess = -1, trytoswap = 1;
9138 REDIS_NOTUSED(el);
9139 REDIS_NOTUSED(mask);
9140 REDIS_NOTUSED(privdata);
9141
9142 /* For every byte we read in the read side of the pipe, there is one
9143 * I/O job completed to process. */
9144 while((retval = read(fd,buf,1)) == 1) {
9145 iojob *j;
9146 listNode *ln;
9147 robj *key;
9148 struct dictEntry *de;
9149
9150 redisLog(REDIS_DEBUG,"Processing I/O completed job");
9151
9152 /* Get the processed element (the oldest one) */
9153 lockThreadedIO();
9154 assert(listLength(server.io_processed) != 0);
9155 if (toprocess == -1) {
9156 toprocess = (listLength(server.io_processed)*REDIS_MAX_COMPLETED_JOBS_PROCESSED)/100;
9157 if (toprocess <= 0) toprocess = 1;
9158 }
9159 ln = listFirst(server.io_processed);
9160 j = ln->value;
9161 listDelNode(server.io_processed,ln);
9162 unlockThreadedIO();
9163 /* If this job is marked as canceled, just ignore it */
9164 if (j->canceled) {
9165 freeIOJob(j);
9166 continue;
9167 }
9168 /* Post process it in the main thread, as there are things we
9169 * can do just here to avoid race conditions and/or invasive locks */
9170 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);
9171 de = dictFind(j->db->dict,j->key);
9172 assert(de != NULL);
9173 key = dictGetEntryKey(de);
9174 if (j->type == REDIS_IOJOB_LOAD) {
9175 redisDb *db;
9176
9177 /* Key loaded, bring it at home */
9178 key->storage = REDIS_VM_MEMORY;
9179 key->vm.atime = server.unixtime;
9180 vmMarkPagesFree(key->vm.page,key->vm.usedpages);
9181 redisLog(REDIS_DEBUG, "VM: object %s loaded from disk (threaded)",
9182 (unsigned char*) key->ptr);
9183 server.vm_stats_swapped_objects--;
9184 server.vm_stats_swapins++;
9185 dictGetEntryVal(de) = j->val;
9186 incrRefCount(j->val);
9187 db = j->db;
9188 freeIOJob(j);
9189 /* Handle clients waiting for this key to be loaded. */
9190 handleClientsBlockedOnSwappedKey(db,key);
9191 } else if (j->type == REDIS_IOJOB_PREPARE_SWAP) {
9192 /* Now we know the amount of pages required to swap this object.
9193 * Let's find some space for it, and queue this task again
9194 * rebranded as REDIS_IOJOB_DO_SWAP. */
9195 if (!vmCanSwapOut() ||
9196 vmFindContiguousPages(&j->page,j->pages) == REDIS_ERR)
9197 {
9198 /* Ooops... no space or we can't swap as there is
9199 * a fork()ed Redis trying to save stuff on disk. */
9200 freeIOJob(j);
9201 key->storage = REDIS_VM_MEMORY; /* undo operation */
9202 } else {
9203 /* Note that we need to mark this pages as used now,
9204 * if the job will be canceled, we'll mark them as freed
9205 * again. */
9206 vmMarkPagesUsed(j->page,j->pages);
9207 j->type = REDIS_IOJOB_DO_SWAP;
9208 lockThreadedIO();
9209 queueIOJob(j);
9210 unlockThreadedIO();
9211 }
9212 } else if (j->type == REDIS_IOJOB_DO_SWAP) {
9213 robj *val;
9214
9215 /* Key swapped. We can finally free some memory. */
9216 if (key->storage != REDIS_VM_SWAPPING) {
9217 printf("key->storage: %d\n",key->storage);
9218 printf("key->name: %s\n",(char*)key->ptr);
9219 printf("key->refcount: %d\n",key->refcount);
9220 printf("val: %p\n",(void*)j->val);
9221 printf("val->type: %d\n",j->val->type);
9222 printf("val->ptr: %s\n",(char*)j->val->ptr);
9223 }
9224 redisAssert(key->storage == REDIS_VM_SWAPPING);
9225 val = dictGetEntryVal(de);
9226 key->vm.page = j->page;
9227 key->vm.usedpages = j->pages;
9228 key->storage = REDIS_VM_SWAPPED;
9229 key->vtype = j->val->type;
9230 decrRefCount(val); /* Deallocate the object from memory. */
9231 dictGetEntryVal(de) = NULL;
9232 redisLog(REDIS_DEBUG,
9233 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
9234 (unsigned char*) key->ptr,
9235 (unsigned long long) j->page, (unsigned long long) j->pages);
9236 server.vm_stats_swapped_objects++;
9237 server.vm_stats_swapouts++;
9238 freeIOJob(j);
9239 /* Put a few more swap requests in queue if we are still
9240 * out of memory */
9241 if (trytoswap && vmCanSwapOut() &&
9242 zmalloc_used_memory() > server.vm_max_memory)
9243 {
9244 int more = 1;
9245 while(more) {
9246 lockThreadedIO();
9247 more = listLength(server.io_newjobs) <
9248 (unsigned) server.vm_max_threads;
9249 unlockThreadedIO();
9250 /* Don't waste CPU time if swappable objects are rare. */
9251 if (vmSwapOneObjectThreaded() == REDIS_ERR) {
9252 trytoswap = 0;
9253 break;
9254 }
9255 }
9256 }
9257 }
9258 processed++;
9259 if (processed == toprocess) return;
9260 }
9261 if (retval < 0 && errno != EAGAIN) {
9262 redisLog(REDIS_WARNING,
9263 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
9264 strerror(errno));
9265 }
9266 }
9267
9268 static void lockThreadedIO(void) {
9269 pthread_mutex_lock(&server.io_mutex);
9270 }
9271
9272 static void unlockThreadedIO(void) {
9273 pthread_mutex_unlock(&server.io_mutex);
9274 }
9275
9276 /* Remove the specified object from the threaded I/O queue if still not
9277 * processed, otherwise make sure to flag it as canceled. */
9278 static void vmCancelThreadedIOJob(robj *o) {
9279 list *lists[3] = {
9280 server.io_newjobs, /* 0 */
9281 server.io_processing, /* 1 */
9282 server.io_processed /* 2 */
9283 };
9284 int i;
9285
9286 assert(o->storage == REDIS_VM_LOADING || o->storage == REDIS_VM_SWAPPING);
9287 again:
9288 lockThreadedIO();
9289 /* Search for a matching key in one of the queues */
9290 for (i = 0; i < 3; i++) {
9291 listNode *ln;
9292 listIter li;
9293
9294 listRewind(lists[i],&li);
9295 while ((ln = listNext(&li)) != NULL) {
9296 iojob *job = ln->value;
9297
9298 if (job->canceled) continue; /* Skip this, already canceled. */
9299 if (job->key == o) {
9300 redisLog(REDIS_DEBUG,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
9301 (void*)job, (char*)o->ptr, job->type, i);
9302 /* Mark the pages as free since the swap didn't happened
9303 * or happened but is now discarded. */
9304 if (i != 1 && job->type == REDIS_IOJOB_DO_SWAP)
9305 vmMarkPagesFree(job->page,job->pages);
9306 /* Cancel the job. It depends on the list the job is
9307 * living in. */
9308 switch(i) {
9309 case 0: /* io_newjobs */
9310 /* If the job was yet not processed the best thing to do
9311 * is to remove it from the queue at all */
9312 freeIOJob(job);
9313 listDelNode(lists[i],ln);
9314 break;
9315 case 1: /* io_processing */
9316 /* Oh Shi- the thread is messing with the Job:
9317 *
9318 * Probably it's accessing the object if this is a
9319 * PREPARE_SWAP or DO_SWAP job.
9320 * If it's a LOAD job it may be reading from disk and
9321 * if we don't wait for the job to terminate before to
9322 * cancel it, maybe in a few microseconds data can be
9323 * corrupted in this pages. So the short story is:
9324 *
9325 * Better to wait for the job to move into the
9326 * next queue (processed)... */
9327
9328 /* We try again and again until the job is completed. */
9329 unlockThreadedIO();
9330 /* But let's wait some time for the I/O thread
9331 * to finish with this job. After all this condition
9332 * should be very rare. */
9333 usleep(1);
9334 goto again;
9335 case 2: /* io_processed */
9336 /* The job was already processed, that's easy...
9337 * just mark it as canceled so that we'll ignore it
9338 * when processing completed jobs. */
9339 job->canceled = 1;
9340 break;
9341 }
9342 /* Finally we have to adjust the storage type of the object
9343 * in order to "UNDO" the operaiton. */
9344 if (o->storage == REDIS_VM_LOADING)
9345 o->storage = REDIS_VM_SWAPPED;
9346 else if (o->storage == REDIS_VM_SWAPPING)
9347 o->storage = REDIS_VM_MEMORY;
9348 unlockThreadedIO();
9349 return;
9350 }
9351 }
9352 }
9353 unlockThreadedIO();
9354 assert(1 != 1); /* We should never reach this */
9355 }
9356
9357 static void *IOThreadEntryPoint(void *arg) {
9358 iojob *j;
9359 listNode *ln;
9360 REDIS_NOTUSED(arg);
9361
9362 pthread_detach(pthread_self());
9363 while(1) {
9364 /* Get a new job to process */
9365 lockThreadedIO();
9366 if (listLength(server.io_newjobs) == 0) {
9367 /* No new jobs in queue, exit. */
9368 redisLog(REDIS_DEBUG,"Thread %ld exiting, nothing to do",
9369 (long) pthread_self());
9370 server.io_active_threads--;
9371 unlockThreadedIO();
9372 return NULL;
9373 }
9374 ln = listFirst(server.io_newjobs);
9375 j = ln->value;
9376 listDelNode(server.io_newjobs,ln);
9377 /* Add the job in the processing queue */
9378 j->thread = pthread_self();
9379 listAddNodeTail(server.io_processing,j);
9380 ln = listLast(server.io_processing); /* We use ln later to remove it */
9381 unlockThreadedIO();
9382 redisLog(REDIS_DEBUG,"Thread %ld got a new job (type %d): %p about key '%s'",
9383 (long) pthread_self(), j->type, (void*)j, (char*)j->key->ptr);
9384
9385 /* Process the Job */
9386 if (j->type == REDIS_IOJOB_LOAD) {
9387 j->val = vmReadObjectFromSwap(j->page,j->key->vtype);
9388 } else if (j->type == REDIS_IOJOB_PREPARE_SWAP) {
9389 FILE *fp = fopen("/dev/null","w+");
9390 j->pages = rdbSavedObjectPages(j->val,fp);
9391 fclose(fp);
9392 } else if (j->type == REDIS_IOJOB_DO_SWAP) {
9393 if (vmWriteObjectOnSwap(j->val,j->page) == REDIS_ERR)
9394 j->canceled = 1;
9395 }
9396
9397 /* Done: insert the job into the processed queue */
9398 redisLog(REDIS_DEBUG,"Thread %ld completed the job: %p (key %s)",
9399 (long) pthread_self(), (void*)j, (char*)j->key->ptr);
9400 lockThreadedIO();
9401 listDelNode(server.io_processing,ln);
9402 listAddNodeTail(server.io_processed,j);
9403 unlockThreadedIO();
9404
9405 /* Signal the main thread there is new stuff to process */
9406 assert(write(server.io_ready_pipe_write,"x",1) == 1);
9407 }
9408 return NULL; /* never reached */
9409 }
9410
9411 static void spawnIOThread(void) {
9412 pthread_t thread;
9413 sigset_t mask, omask;
9414 int err;
9415
9416 sigemptyset(&mask);
9417 sigaddset(&mask,SIGCHLD);
9418 sigaddset(&mask,SIGHUP);
9419 sigaddset(&mask,SIGPIPE);
9420 pthread_sigmask(SIG_SETMASK, &mask, &omask);
9421 while ((err = pthread_create(&thread,&server.io_threads_attr,IOThreadEntryPoint,NULL)) != 0) {
9422 redisLog(REDIS_WARNING,"Unable to spawn an I/O thread: %s",
9423 strerror(err));
9424 usleep(1000000);
9425 }
9426 pthread_sigmask(SIG_SETMASK, &omask, NULL);
9427 server.io_active_threads++;
9428 }
9429
9430 /* We need to wait for the last thread to exit before we are able to
9431 * fork() in order to BGSAVE or BGREWRITEAOF. */
9432 static void waitEmptyIOJobsQueue(void) {
9433 while(1) {
9434 int io_processed_len;
9435
9436 lockThreadedIO();
9437 if (listLength(server.io_newjobs) == 0 &&
9438 listLength(server.io_processing) == 0 &&
9439 server.io_active_threads == 0)
9440 {
9441 unlockThreadedIO();
9442 return;
9443 }
9444 /* While waiting for empty jobs queue condition we post-process some
9445 * finshed job, as I/O threads may be hanging trying to write against
9446 * the io_ready_pipe_write FD but there are so much pending jobs that
9447 * it's blocking. */
9448 io_processed_len = listLength(server.io_processed);
9449 unlockThreadedIO();
9450 if (io_processed_len) {
9451 vmThreadedIOCompletedJob(NULL,server.io_ready_pipe_read,NULL,0);
9452 usleep(1000); /* 1 millisecond */
9453 } else {
9454 usleep(10000); /* 10 milliseconds */
9455 }
9456 }
9457 }
9458
9459 static void vmReopenSwapFile(void) {
9460 /* Note: we don't close the old one as we are in the child process
9461 * and don't want to mess at all with the original file object. */
9462 server.vm_fp = fopen(server.vm_swap_file,"r+b");
9463 if (server.vm_fp == NULL) {
9464 redisLog(REDIS_WARNING,"Can't re-open the VM swap file: %s. Exiting.",
9465 server.vm_swap_file);
9466 _exit(1);
9467 }
9468 server.vm_fd = fileno(server.vm_fp);
9469 }
9470
9471 /* This function must be called while with threaded IO locked */
9472 static void queueIOJob(iojob *j) {
9473 redisLog(REDIS_DEBUG,"Queued IO Job %p type %d about key '%s'\n",
9474 (void*)j, j->type, (char*)j->key->ptr);
9475 listAddNodeTail(server.io_newjobs,j);
9476 if (server.io_active_threads < server.vm_max_threads)
9477 spawnIOThread();
9478 }
9479
9480 static int vmSwapObjectThreaded(robj *key, robj *val, redisDb *db) {
9481 iojob *j;
9482
9483 assert(key->storage == REDIS_VM_MEMORY);
9484 assert(key->refcount == 1);
9485
9486 j = zmalloc(sizeof(*j));
9487 j->type = REDIS_IOJOB_PREPARE_SWAP;
9488 j->db = db;
9489 j->key = key;
9490 j->val = val;
9491 incrRefCount(val);
9492 j->canceled = 0;
9493 j->thread = (pthread_t) -1;
9494 key->storage = REDIS_VM_SWAPPING;
9495
9496 lockThreadedIO();
9497 queueIOJob(j);
9498 unlockThreadedIO();
9499 return REDIS_OK;
9500 }
9501
9502 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
9503
9504 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
9505 * If there is not already a job loading the key, it is craeted.
9506 * The key is added to the io_keys list in the client structure, and also
9507 * in the hash table mapping swapped keys to waiting clients, that is,
9508 * server.io_waited_keys. */
9509 static int waitForSwappedKey(redisClient *c, robj *key) {
9510 struct dictEntry *de;
9511 robj *o;
9512 list *l;
9513
9514 /* If the key does not exist or is already in RAM we don't need to
9515 * block the client at all. */
9516 de = dictFind(c->db->dict,key);
9517 if (de == NULL) return 0;
9518 o = dictGetEntryKey(de);
9519 if (o->storage == REDIS_VM_MEMORY) {
9520 return 0;
9521 } else if (o->storage == REDIS_VM_SWAPPING) {
9522 /* We were swapping the key, undo it! */
9523 vmCancelThreadedIOJob(o);
9524 return 0;
9525 }
9526
9527 /* OK: the key is either swapped, or being loaded just now. */
9528
9529 /* Add the key to the list of keys this client is waiting for.
9530 * This maps clients to keys they are waiting for. */
9531 listAddNodeTail(c->io_keys,key);
9532 incrRefCount(key);
9533
9534 /* Add the client to the swapped keys => clients waiting map. */
9535 de = dictFind(c->db->io_keys,key);
9536 if (de == NULL) {
9537 int retval;
9538
9539 /* For every key we take a list of clients blocked for it */
9540 l = listCreate();
9541 retval = dictAdd(c->db->io_keys,key,l);
9542 incrRefCount(key);
9543 assert(retval == DICT_OK);
9544 } else {
9545 l = dictGetEntryVal(de);
9546 }
9547 listAddNodeTail(l,c);
9548
9549 /* Are we already loading the key from disk? If not create a job */
9550 if (o->storage == REDIS_VM_SWAPPED) {
9551 iojob *j;
9552
9553 o->storage = REDIS_VM_LOADING;
9554 j = zmalloc(sizeof(*j));
9555 j->type = REDIS_IOJOB_LOAD;
9556 j->db = c->db;
9557 j->key = o;
9558 j->key->vtype = o->vtype;
9559 j->page = o->vm.page;
9560 j->val = NULL;
9561 j->canceled = 0;
9562 j->thread = (pthread_t) -1;
9563 lockThreadedIO();
9564 queueIOJob(j);
9565 unlockThreadedIO();
9566 }
9567 return 1;
9568 }
9569
9570 /* Preload keys needed for the ZUNION and ZINTER commands. */
9571 static void zunionInterBlockClientOnSwappedKeys(redisClient *c) {
9572 int i, num;
9573 num = atoi(c->argv[2]->ptr);
9574 for (i = 0; i < num; i++) {
9575 waitForSwappedKey(c,c->argv[3+i]);
9576 }
9577 }
9578
9579 /* Is this client attempting to run a command against swapped keys?
9580 * If so, block it ASAP, load the keys in background, then resume it.
9581 *
9582 * The important idea about this function is that it can fail! If keys will
9583 * still be swapped when the client is resumed, this key lookups will
9584 * just block loading keys from disk. In practical terms this should only
9585 * happen with SORT BY command or if there is a bug in this function.
9586 *
9587 * Return 1 if the client is marked as blocked, 0 if the client can
9588 * continue as the keys it is going to access appear to be in memory. */
9589 static int blockClientOnSwappedKeys(struct redisCommand *cmd, redisClient *c) {
9590 int j, last;
9591
9592 if (cmd->vm_preload_proc != NULL) {
9593 cmd->vm_preload_proc(c);
9594 } else {
9595 if (cmd->vm_firstkey == 0) return 0;
9596 last = cmd->vm_lastkey;
9597 if (last < 0) last = c->argc+last;
9598 for (j = cmd->vm_firstkey; j <= last; j += cmd->vm_keystep)
9599 waitForSwappedKey(c,c->argv[j]);
9600 }
9601
9602 /* If the client was blocked for at least one key, mark it as blocked. */
9603 if (listLength(c->io_keys)) {
9604 c->flags |= REDIS_IO_WAIT;
9605 aeDeleteFileEvent(server.el,c->fd,AE_READABLE);
9606 server.vm_blocked_clients++;
9607 return 1;
9608 } else {
9609 return 0;
9610 }
9611 }
9612
9613 /* Remove the 'key' from the list of blocked keys for a given client.
9614 *
9615 * The function returns 1 when there are no longer blocking keys after
9616 * the current one was removed (and the client can be unblocked). */
9617 static int dontWaitForSwappedKey(redisClient *c, robj *key) {
9618 list *l;
9619 listNode *ln;
9620 listIter li;
9621 struct dictEntry *de;
9622
9623 /* Remove the key from the list of keys this client is waiting for. */
9624 listRewind(c->io_keys,&li);
9625 while ((ln = listNext(&li)) != NULL) {
9626 if (compareStringObjects(ln->value,key) == 0) {
9627 listDelNode(c->io_keys,ln);
9628 break;
9629 }
9630 }
9631 assert(ln != NULL);
9632
9633 /* Remove the client form the key => waiting clients map. */
9634 de = dictFind(c->db->io_keys,key);
9635 assert(de != NULL);
9636 l = dictGetEntryVal(de);
9637 ln = listSearchKey(l,c);
9638 assert(ln != NULL);
9639 listDelNode(l,ln);
9640 if (listLength(l) == 0)
9641 dictDelete(c->db->io_keys,key);
9642
9643 return listLength(c->io_keys) == 0;
9644 }
9645
9646 static void handleClientsBlockedOnSwappedKey(redisDb *db, robj *key) {
9647 struct dictEntry *de;
9648 list *l;
9649 listNode *ln;
9650 int len;
9651
9652 de = dictFind(db->io_keys,key);
9653 if (!de) return;
9654
9655 l = dictGetEntryVal(de);
9656 len = listLength(l);
9657 /* Note: we can't use something like while(listLength(l)) as the list
9658 * can be freed by the calling function when we remove the last element. */
9659 while (len--) {
9660 ln = listFirst(l);
9661 redisClient *c = ln->value;
9662
9663 if (dontWaitForSwappedKey(c,key)) {
9664 /* Put the client in the list of clients ready to go as we
9665 * loaded all the keys about it. */
9666 listAddNodeTail(server.io_ready_clients,c);
9667 }
9668 }
9669 }
9670
9671 /* =========================== Remote Configuration ========================= */
9672
9673 static void configSetCommand(redisClient *c) {
9674 robj *o = getDecodedObject(c->argv[3]);
9675 if (!strcasecmp(c->argv[2]->ptr,"dbfilename")) {
9676 zfree(server.dbfilename);
9677 server.dbfilename = zstrdup(o->ptr);
9678 } else if (!strcasecmp(c->argv[2]->ptr,"requirepass")) {
9679 zfree(server.requirepass);
9680 server.requirepass = zstrdup(o->ptr);
9681 } else if (!strcasecmp(c->argv[2]->ptr,"masterauth")) {
9682 zfree(server.masterauth);
9683 server.masterauth = zstrdup(o->ptr);
9684 } else if (!strcasecmp(c->argv[2]->ptr,"maxmemory")) {
9685 server.maxmemory = strtoll(o->ptr, NULL, 10);
9686 } else if (!strcasecmp(c->argv[2]->ptr,"appendfsync")) {
9687 if (!strcasecmp(o->ptr,"no")) {
9688 server.appendfsync = APPENDFSYNC_NO;
9689 } else if (!strcasecmp(o->ptr,"everysec")) {
9690 server.appendfsync = APPENDFSYNC_EVERYSEC;
9691 } else if (!strcasecmp(o->ptr,"always")) {
9692 server.appendfsync = APPENDFSYNC_ALWAYS;
9693 } else {
9694 goto badfmt;
9695 }
9696 } else if (!strcasecmp(c->argv[2]->ptr,"save")) {
9697 int vlen, j;
9698 sds *v = sdssplitlen(o->ptr,sdslen(o->ptr)," ",1,&vlen);
9699
9700 /* Perform sanity check before setting the new config:
9701 * - Even number of args
9702 * - Seconds >= 1, changes >= 0 */
9703 if (vlen & 1) {
9704 sdsfreesplitres(v,vlen);
9705 goto badfmt;
9706 }
9707 for (j = 0; j < vlen; j++) {
9708 char *eptr;
9709 long val;
9710
9711 val = strtoll(v[j], &eptr, 10);
9712 if (eptr[0] != '\0' ||
9713 ((j & 1) == 0 && val < 1) ||
9714 ((j & 1) == 1 && val < 0)) {
9715 sdsfreesplitres(v,vlen);
9716 goto badfmt;
9717 }
9718 }
9719 /* Finally set the new config */
9720 resetServerSaveParams();
9721 for (j = 0; j < vlen; j += 2) {
9722 time_t seconds;
9723 int changes;
9724
9725 seconds = strtoll(v[j],NULL,10);
9726 changes = strtoll(v[j+1],NULL,10);
9727 appendServerSaveParams(seconds, changes);
9728 }
9729 sdsfreesplitres(v,vlen);
9730 } else {
9731 addReplySds(c,sdscatprintf(sdsempty(),
9732 "-ERR not supported CONFIG parameter %s\r\n",
9733 (char*)c->argv[2]->ptr));
9734 decrRefCount(o);
9735 return;
9736 }
9737 decrRefCount(o);
9738 addReply(c,shared.ok);
9739 return;
9740
9741 badfmt: /* Bad format errors */
9742 addReplySds(c,sdscatprintf(sdsempty(),
9743 "-ERR invalid argument '%s' for CONFIG SET '%s'\r\n",
9744 (char*)o->ptr,
9745 (char*)c->argv[2]->ptr));
9746 decrRefCount(o);
9747 }
9748
9749 static void configGetCommand(redisClient *c) {
9750 robj *o = getDecodedObject(c->argv[2]);
9751 robj *lenobj = createObject(REDIS_STRING,NULL);
9752 char *pattern = o->ptr;
9753 int matches = 0;
9754
9755 addReply(c,lenobj);
9756 decrRefCount(lenobj);
9757
9758 if (stringmatch(pattern,"dbfilename",0)) {
9759 addReplyBulkCString(c,"dbfilename");
9760 addReplyBulkCString(c,server.dbfilename);
9761 matches++;
9762 }
9763 if (stringmatch(pattern,"requirepass",0)) {
9764 addReplyBulkCString(c,"requirepass");
9765 addReplyBulkCString(c,server.requirepass);
9766 matches++;
9767 }
9768 if (stringmatch(pattern,"masterauth",0)) {
9769 addReplyBulkCString(c,"masterauth");
9770 addReplyBulkCString(c,server.masterauth);
9771 matches++;
9772 }
9773 if (stringmatch(pattern,"maxmemory",0)) {
9774 char buf[128];
9775
9776 snprintf(buf,128,"%llu\n",server.maxmemory);
9777 addReplyBulkCString(c,"maxmemory");
9778 addReplyBulkCString(c,buf);
9779 matches++;
9780 }
9781 if (stringmatch(pattern,"appendfsync",0)) {
9782 char *policy;
9783
9784 switch(server.appendfsync) {
9785 case APPENDFSYNC_NO: policy = "no"; break;
9786 case APPENDFSYNC_EVERYSEC: policy = "everysec"; break;
9787 case APPENDFSYNC_ALWAYS: policy = "always"; break;
9788 default: policy = "unknown"; break; /* too harmless to panic */
9789 }
9790 addReplyBulkCString(c,"appendfsync");
9791 addReplyBulkCString(c,policy);
9792 matches++;
9793 }
9794 if (stringmatch(pattern,"save",0)) {
9795 sds buf = sdsempty();
9796 int j;
9797
9798 for (j = 0; j < server.saveparamslen; j++) {
9799 buf = sdscatprintf(buf,"%ld %d",
9800 server.saveparams[j].seconds,
9801 server.saveparams[j].changes);
9802 if (j != server.saveparamslen-1)
9803 buf = sdscatlen(buf," ",1);
9804 }
9805 addReplyBulkCString(c,"save");
9806 addReplyBulkCString(c,buf);
9807 sdsfree(buf);
9808 matches++;
9809 }
9810 decrRefCount(o);
9811 lenobj->ptr = sdscatprintf(sdsempty(),"*%d\r\n",matches*2);
9812 }
9813
9814 static void configCommand(redisClient *c) {
9815 if (!strcasecmp(c->argv[1]->ptr,"set")) {
9816 if (c->argc != 4) goto badarity;
9817 configSetCommand(c);
9818 } else if (!strcasecmp(c->argv[1]->ptr,"get")) {
9819 if (c->argc != 3) goto badarity;
9820 configGetCommand(c);
9821 } else if (!strcasecmp(c->argv[1]->ptr,"resetstat")) {
9822 if (c->argc != 2) goto badarity;
9823 server.stat_numcommands = 0;
9824 server.stat_numconnections = 0;
9825 server.stat_expiredkeys = 0;
9826 server.stat_starttime = time(NULL);
9827 addReply(c,shared.ok);
9828 } else {
9829 addReplySds(c,sdscatprintf(sdsempty(),
9830 "-ERR CONFIG subcommand must be one of GET, SET, RESETSTAT\r\n"));
9831 }
9832 return;
9833
9834 badarity:
9835 addReplySds(c,sdscatprintf(sdsempty(),
9836 "-ERR Wrong number of arguments for CONFIG %s\r\n",
9837 (char*) c->argv[1]->ptr));
9838 }
9839
9840 /* =========================== Pubsub implementation ======================== */
9841
9842 static void freePubsubPattern(void *p) {
9843 pubsubPattern *pat = p;
9844
9845 decrRefCount(pat->pattern);
9846 zfree(pat);
9847 }
9848
9849 static int listMatchPubsubPattern(void *a, void *b) {
9850 pubsubPattern *pa = a, *pb = b;
9851
9852 return (pa->client == pb->client) &&
9853 (compareStringObjects(pa->pattern,pb->pattern) == 0);
9854 }
9855
9856 /* Subscribe a client to a channel. Returns 1 if the operation succeeded, or
9857 * 0 if the client was already subscribed to that channel. */
9858 static int pubsubSubscribeChannel(redisClient *c, robj *channel) {
9859 struct dictEntry *de;
9860 list *clients = NULL;
9861 int retval = 0;
9862
9863 /* Add the channel to the client -> channels hash table */
9864 if (dictAdd(c->pubsub_channels,channel,NULL) == DICT_OK) {
9865 retval = 1;
9866 incrRefCount(channel);
9867 /* Add the client to the channel -> list of clients hash table */
9868 de = dictFind(server.pubsub_channels,channel);
9869 if (de == NULL) {
9870 clients = listCreate();
9871 dictAdd(server.pubsub_channels,channel,clients);
9872 incrRefCount(channel);
9873 } else {
9874 clients = dictGetEntryVal(de);
9875 }
9876 listAddNodeTail(clients,c);
9877 }
9878 /* Notify the client */
9879 addReply(c,shared.mbulk3);
9880 addReply(c,shared.subscribebulk);
9881 addReplyBulk(c,channel);
9882 addReplyLong(c,dictSize(c->pubsub_channels)+listLength(c->pubsub_patterns));
9883 return retval;
9884 }
9885
9886 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
9887 * 0 if the client was not subscribed to the specified channel. */
9888 static int pubsubUnsubscribeChannel(redisClient *c, robj *channel, int notify) {
9889 struct dictEntry *de;
9890 list *clients;
9891 listNode *ln;
9892 int retval = 0;
9893
9894 /* Remove the channel from the client -> channels hash table */
9895 incrRefCount(channel); /* channel may be just a pointer to the same object
9896 we have in the hash tables. Protect it... */
9897 if (dictDelete(c->pubsub_channels,channel) == DICT_OK) {
9898 retval = 1;
9899 /* Remove the client from the channel -> clients list hash table */
9900 de = dictFind(server.pubsub_channels,channel);
9901 assert(de != NULL);
9902 clients = dictGetEntryVal(de);
9903 ln = listSearchKey(clients,c);
9904 assert(ln != NULL);
9905 listDelNode(clients,ln);
9906 if (listLength(clients) == 0) {
9907 /* Free the list and associated hash entry at all if this was
9908 * the latest client, so that it will be possible to abuse
9909 * Redis PUBSUB creating millions of channels. */
9910 dictDelete(server.pubsub_channels,channel);
9911 }
9912 }
9913 /* Notify the client */
9914 if (notify) {
9915 addReply(c,shared.mbulk3);
9916 addReply(c,shared.unsubscribebulk);
9917 addReplyBulk(c,channel);
9918 addReplyLong(c,dictSize(c->pubsub_channels)+
9919 listLength(c->pubsub_patterns));
9920
9921 }
9922 decrRefCount(channel); /* it is finally safe to release it */
9923 return retval;
9924 }
9925
9926 /* Subscribe a client to a pattern. Returns 1 if the operation succeeded, or 0 if the clinet was already subscribed to that pattern. */
9927 static int pubsubSubscribePattern(redisClient *c, robj *pattern) {
9928 int retval = 0;
9929
9930 if (listSearchKey(c->pubsub_patterns,pattern) == NULL) {
9931 retval = 1;
9932 pubsubPattern *pat;
9933 listAddNodeTail(c->pubsub_patterns,pattern);
9934 incrRefCount(pattern);
9935 pat = zmalloc(sizeof(*pat));
9936 pat->pattern = getDecodedObject(pattern);
9937 pat->client = c;
9938 listAddNodeTail(server.pubsub_patterns,pat);
9939 }
9940 /* Notify the client */
9941 addReply(c,shared.mbulk3);
9942 addReply(c,shared.psubscribebulk);
9943 addReplyBulk(c,pattern);
9944 addReplyLong(c,dictSize(c->pubsub_channels)+listLength(c->pubsub_patterns));
9945 return retval;
9946 }
9947
9948 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
9949 * 0 if the client was not subscribed to the specified channel. */
9950 static int pubsubUnsubscribePattern(redisClient *c, robj *pattern, int notify) {
9951 listNode *ln;
9952 pubsubPattern pat;
9953 int retval = 0;
9954
9955 incrRefCount(pattern); /* Protect the object. May be the same we remove */
9956 if ((ln = listSearchKey(c->pubsub_patterns,pattern)) != NULL) {
9957 retval = 1;
9958 listDelNode(c->pubsub_patterns,ln);
9959 pat.client = c;
9960 pat.pattern = pattern;
9961 ln = listSearchKey(server.pubsub_patterns,&pat);
9962 listDelNode(server.pubsub_patterns,ln);
9963 }
9964 /* Notify the client */
9965 if (notify) {
9966 addReply(c,shared.mbulk3);
9967 addReply(c,shared.punsubscribebulk);
9968 addReplyBulk(c,pattern);
9969 addReplyLong(c,dictSize(c->pubsub_channels)+
9970 listLength(c->pubsub_patterns));
9971 }
9972 decrRefCount(pattern);
9973 return retval;
9974 }
9975
9976 /* Unsubscribe from all the channels. Return the number of channels the
9977 * client was subscribed from. */
9978 static int pubsubUnsubscribeAllChannels(redisClient *c, int notify) {
9979 dictIterator *di = dictGetIterator(c->pubsub_channels);
9980 dictEntry *de;
9981 int count = 0;
9982
9983 while((de = dictNext(di)) != NULL) {
9984 robj *channel = dictGetEntryKey(de);
9985
9986 count += pubsubUnsubscribeChannel(c,channel,notify);
9987 }
9988 dictReleaseIterator(di);
9989 return count;
9990 }
9991
9992 /* Unsubscribe from all the patterns. Return the number of patterns the
9993 * client was subscribed from. */
9994 static int pubsubUnsubscribeAllPatterns(redisClient *c, int notify) {
9995 listNode *ln;
9996 listIter li;
9997 int count = 0;
9998
9999 listRewind(c->pubsub_patterns,&li);
10000 while ((ln = listNext(&li)) != NULL) {
10001 robj *pattern = ln->value;
10002
10003 count += pubsubUnsubscribePattern(c,pattern,notify);
10004 }
10005 return count;
10006 }
10007
10008 /* Publish a message */
10009 static int pubsubPublishMessage(robj *channel, robj *message) {
10010 int receivers = 0;
10011 struct dictEntry *de;
10012 listNode *ln;
10013 listIter li;
10014
10015 /* Send to clients listening for that channel */
10016 de = dictFind(server.pubsub_channels,channel);
10017 if (de) {
10018 list *list = dictGetEntryVal(de);
10019 listNode *ln;
10020 listIter li;
10021
10022 listRewind(list,&li);
10023 while ((ln = listNext(&li)) != NULL) {
10024 redisClient *c = ln->value;
10025
10026 addReply(c,shared.mbulk3);
10027 addReply(c,shared.messagebulk);
10028 addReplyBulk(c,channel);
10029 addReplyBulk(c,message);
10030 receivers++;
10031 }
10032 }
10033 /* Send to clients listening to matching channels */
10034 if (listLength(server.pubsub_patterns)) {
10035 listRewind(server.pubsub_patterns,&li);
10036 channel = getDecodedObject(channel);
10037 while ((ln = listNext(&li)) != NULL) {
10038 pubsubPattern *pat = ln->value;
10039
10040 if (stringmatchlen((char*)pat->pattern->ptr,
10041 sdslen(pat->pattern->ptr),
10042 (char*)channel->ptr,
10043 sdslen(channel->ptr),0)) {
10044 addReply(pat->client,shared.mbulk4);
10045 addReply(pat->client,shared.pmessagebulk);
10046 addReplyBulk(pat->client,pat->pattern);
10047 addReplyBulk(pat->client,channel);
10048 addReplyBulk(pat->client,message);
10049 receivers++;
10050 }
10051 }
10052 decrRefCount(channel);
10053 }
10054 return receivers;
10055 }
10056
10057 static void subscribeCommand(redisClient *c) {
10058 int j;
10059
10060 for (j = 1; j < c->argc; j++)
10061 pubsubSubscribeChannel(c,c->argv[j]);
10062 }
10063
10064 static void unsubscribeCommand(redisClient *c) {
10065 if (c->argc == 1) {
10066 pubsubUnsubscribeAllChannels(c,1);
10067 return;
10068 } else {
10069 int j;
10070
10071 for (j = 1; j < c->argc; j++)
10072 pubsubUnsubscribeChannel(c,c->argv[j],1);
10073 }
10074 }
10075
10076 static void psubscribeCommand(redisClient *c) {
10077 int j;
10078
10079 for (j = 1; j < c->argc; j++)
10080 pubsubSubscribePattern(c,c->argv[j]);
10081 }
10082
10083 static void punsubscribeCommand(redisClient *c) {
10084 if (c->argc == 1) {
10085 pubsubUnsubscribeAllPatterns(c,1);
10086 return;
10087 } else {
10088 int j;
10089
10090 for (j = 1; j < c->argc; j++)
10091 pubsubUnsubscribePattern(c,c->argv[j],1);
10092 }
10093 }
10094
10095 static void publishCommand(redisClient *c) {
10096 int receivers = pubsubPublishMessage(c->argv[1],c->argv[2]);
10097 addReplyLong(c,receivers);
10098 }
10099
10100 /* ================================= Debugging ============================== */
10101
10102 static void debugCommand(redisClient *c) {
10103 if (!strcasecmp(c->argv[1]->ptr,"segfault")) {
10104 *((char*)-1) = 'x';
10105 } else if (!strcasecmp(c->argv[1]->ptr,"reload")) {
10106 if (rdbSave(server.dbfilename) != REDIS_OK) {
10107 addReply(c,shared.err);
10108 return;
10109 }
10110 emptyDb();
10111 if (rdbLoad(server.dbfilename) != REDIS_OK) {
10112 addReply(c,shared.err);
10113 return;
10114 }
10115 redisLog(REDIS_WARNING,"DB reloaded by DEBUG RELOAD");
10116 addReply(c,shared.ok);
10117 } else if (!strcasecmp(c->argv[1]->ptr,"loadaof")) {
10118 emptyDb();
10119 if (loadAppendOnlyFile(server.appendfilename) != REDIS_OK) {
10120 addReply(c,shared.err);
10121 return;
10122 }
10123 redisLog(REDIS_WARNING,"Append Only File loaded by DEBUG LOADAOF");
10124 addReply(c,shared.ok);
10125 } else if (!strcasecmp(c->argv[1]->ptr,"object") && c->argc == 3) {
10126 dictEntry *de = dictFind(c->db->dict,c->argv[2]);
10127 robj *key, *val;
10128
10129 if (!de) {
10130 addReply(c,shared.nokeyerr);
10131 return;
10132 }
10133 key = dictGetEntryKey(de);
10134 val = dictGetEntryVal(de);
10135 if (!server.vm_enabled || (key->storage == REDIS_VM_MEMORY ||
10136 key->storage == REDIS_VM_SWAPPING)) {
10137 char *strenc;
10138 char buf[128];
10139
10140 if (val->encoding < (sizeof(strencoding)/sizeof(char*))) {
10141 strenc = strencoding[val->encoding];
10142 } else {
10143 snprintf(buf,64,"unknown encoding %d\n", val->encoding);
10144 strenc = buf;
10145 }
10146 addReplySds(c,sdscatprintf(sdsempty(),
10147 "+Key at:%p refcount:%d, value at:%p refcount:%d "
10148 "encoding:%s serializedlength:%lld\r\n",
10149 (void*)key, key->refcount, (void*)val, val->refcount,
10150 strenc, (long long) rdbSavedObjectLen(val,NULL)));
10151 } else {
10152 addReplySds(c,sdscatprintf(sdsempty(),
10153 "+Key at:%p refcount:%d, value swapped at: page %llu "
10154 "using %llu pages\r\n",
10155 (void*)key, key->refcount, (unsigned long long) key->vm.page,
10156 (unsigned long long) key->vm.usedpages));
10157 }
10158 } else if (!strcasecmp(c->argv[1]->ptr,"swapin") && c->argc == 3) {
10159 lookupKeyRead(c->db,c->argv[2]);
10160 addReply(c,shared.ok);
10161 } else if (!strcasecmp(c->argv[1]->ptr,"swapout") && c->argc == 3) {
10162 dictEntry *de = dictFind(c->db->dict,c->argv[2]);
10163 robj *key, *val;
10164
10165 if (!server.vm_enabled) {
10166 addReplySds(c,sdsnew("-ERR Virtual Memory is disabled\r\n"));
10167 return;
10168 }
10169 if (!de) {
10170 addReply(c,shared.nokeyerr);
10171 return;
10172 }
10173 key = dictGetEntryKey(de);
10174 val = dictGetEntryVal(de);
10175 /* If the key is shared we want to create a copy */
10176 if (key->refcount > 1) {
10177 robj *newkey = dupStringObject(key);
10178 decrRefCount(key);
10179 key = dictGetEntryKey(de) = newkey;
10180 }
10181 /* Swap it */
10182 if (key->storage != REDIS_VM_MEMORY) {
10183 addReplySds(c,sdsnew("-ERR This key is not in memory\r\n"));
10184 } else if (vmSwapObjectBlocking(key,val) == REDIS_OK) {
10185 dictGetEntryVal(de) = NULL;
10186 addReply(c,shared.ok);
10187 } else {
10188 addReply(c,shared.err);
10189 }
10190 } else if (!strcasecmp(c->argv[1]->ptr,"populate") && c->argc == 3) {
10191 long keys, j;
10192 robj *key, *val;
10193 char buf[128];
10194
10195 if (getLongFromObjectOrReply(c, c->argv[2], &keys, NULL) != REDIS_OK)
10196 return;
10197 for (j = 0; j < keys; j++) {
10198 snprintf(buf,sizeof(buf),"key:%lu",j);
10199 key = createStringObject(buf,strlen(buf));
10200 if (lookupKeyRead(c->db,key) != NULL) {
10201 decrRefCount(key);
10202 continue;
10203 }
10204 snprintf(buf,sizeof(buf),"value:%lu",j);
10205 val = createStringObject(buf,strlen(buf));
10206 dictAdd(c->db->dict,key,val);
10207 }
10208 addReply(c,shared.ok);
10209 } else {
10210 addReplySds(c,sdsnew(
10211 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPIN <key>|SWAPOUT <key>|RELOAD]\r\n"));
10212 }
10213 }
10214
10215 static void _redisAssert(char *estr, char *file, int line) {
10216 redisLog(REDIS_WARNING,"=== ASSERTION FAILED ===");
10217 redisLog(REDIS_WARNING,"==> %s:%d '%s' is not true\n",file,line,estr);
10218 #ifdef HAVE_BACKTRACE
10219 redisLog(REDIS_WARNING,"(forcing SIGSEGV in order to print the stack trace)");
10220 *((char*)-1) = 'x';
10221 #endif
10222 }
10223
10224 static void _redisPanic(char *msg, char *file, int line) {
10225 redisLog(REDIS_WARNING,"!!! Software Failure. Press left mouse button to continue");
10226 redisLog(REDIS_WARNING,"Guru Meditation: %s #%s:%d",msg,file,line);
10227 #ifdef HAVE_BACKTRACE
10228 redisLog(REDIS_WARNING,"(forcing SIGSEGV in order to print the stack trace)");
10229 *((char*)-1) = 'x';
10230 #endif
10231 }
10232
10233 /* =================================== Main! ================================ */
10234
10235 #ifdef __linux__
10236 int linuxOvercommitMemoryValue(void) {
10237 FILE *fp = fopen("/proc/sys/vm/overcommit_memory","r");
10238 char buf[64];
10239
10240 if (!fp) return -1;
10241 if (fgets(buf,64,fp) == NULL) {
10242 fclose(fp);
10243 return -1;
10244 }
10245 fclose(fp);
10246
10247 return atoi(buf);
10248 }
10249
10250 void linuxOvercommitMemoryWarning(void) {
10251 if (linuxOvercommitMemoryValue() == 0) {
10252 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.");
10253 }
10254 }
10255 #endif /* __linux__ */
10256
10257 static void daemonize(void) {
10258 int fd;
10259 FILE *fp;
10260
10261 if (fork() != 0) exit(0); /* parent exits */
10262 setsid(); /* create a new session */
10263
10264 /* Every output goes to /dev/null. If Redis is daemonized but
10265 * the 'logfile' is set to 'stdout' in the configuration file
10266 * it will not log at all. */
10267 if ((fd = open("/dev/null", O_RDWR, 0)) != -1) {
10268 dup2(fd, STDIN_FILENO);
10269 dup2(fd, STDOUT_FILENO);
10270 dup2(fd, STDERR_FILENO);
10271 if (fd > STDERR_FILENO) close(fd);
10272 }
10273 /* Try to write the pid file */
10274 fp = fopen(server.pidfile,"w");
10275 if (fp) {
10276 fprintf(fp,"%d\n",getpid());
10277 fclose(fp);
10278 }
10279 }
10280
10281 static void version() {
10282 printf("Redis server version %s\n", REDIS_VERSION);
10283 exit(0);
10284 }
10285
10286 static void usage() {
10287 fprintf(stderr,"Usage: ./redis-server [/path/to/redis.conf]\n");
10288 fprintf(stderr," ./redis-server - (read config from stdin)\n");
10289 exit(1);
10290 }
10291
10292 int main(int argc, char **argv) {
10293 time_t start;
10294
10295 initServerConfig();
10296 if (argc == 2) {
10297 if (strcmp(argv[1], "-v") == 0 ||
10298 strcmp(argv[1], "--version") == 0) version();
10299 if (strcmp(argv[1], "--help") == 0) usage();
10300 resetServerSaveParams();
10301 loadServerConfig(argv[1]);
10302 } else if ((argc > 2)) {
10303 usage();
10304 } else {
10305 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'");
10306 }
10307 if (server.daemonize) daemonize();
10308 initServer();
10309 redisLog(REDIS_NOTICE,"Server started, Redis version " REDIS_VERSION);
10310 #ifdef __linux__
10311 linuxOvercommitMemoryWarning();
10312 #endif
10313 start = time(NULL);
10314 if (server.appendonly) {
10315 if (loadAppendOnlyFile(server.appendfilename) == REDIS_OK)
10316 redisLog(REDIS_NOTICE,"DB loaded from append only file: %ld seconds",time(NULL)-start);
10317 } else {
10318 if (rdbLoad(server.dbfilename) == REDIS_OK)
10319 redisLog(REDIS_NOTICE,"DB loaded from disk: %ld seconds",time(NULL)-start);
10320 }
10321 redisLog(REDIS_NOTICE,"The server is now ready to accept connections on port %d", server.port);
10322 aeSetBeforeSleepProc(server.el,beforeSleep);
10323 aeMain(server.el);
10324 aeDeleteEventLoop(server.el);
10325 return 0;
10326 }
10327
10328 /* ============================= Backtrace support ========================= */
10329
10330 #ifdef HAVE_BACKTRACE
10331 static char *findFuncName(void *pointer, unsigned long *offset);
10332
10333 static void *getMcontextEip(ucontext_t *uc) {
10334 #if defined(__FreeBSD__)
10335 return (void*) uc->uc_mcontext.mc_eip;
10336 #elif defined(__dietlibc__)
10337 return (void*) uc->uc_mcontext.eip;
10338 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
10339 #if __x86_64__
10340 return (void*) uc->uc_mcontext->__ss.__rip;
10341 #else
10342 return (void*) uc->uc_mcontext->__ss.__eip;
10343 #endif
10344 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
10345 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
10346 return (void*) uc->uc_mcontext->__ss.__rip;
10347 #else
10348 return (void*) uc->uc_mcontext->__ss.__eip;
10349 #endif
10350 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
10351 return (void*) uc->uc_mcontext.gregs[REG_EIP]; /* Linux 32/64 bit */
10352 #elif defined(__ia64__) /* Linux IA64 */
10353 return (void*) uc->uc_mcontext.sc_ip;
10354 #else
10355 return NULL;
10356 #endif
10357 }
10358
10359 static void segvHandler(int sig, siginfo_t *info, void *secret) {
10360 void *trace[100];
10361 char **messages = NULL;
10362 int i, trace_size = 0;
10363 unsigned long offset=0;
10364 ucontext_t *uc = (ucontext_t*) secret;
10365 sds infostring;
10366 REDIS_NOTUSED(info);
10367
10368 redisLog(REDIS_WARNING,
10369 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION, sig);
10370 infostring = genRedisInfoString();
10371 redisLog(REDIS_WARNING, "%s",infostring);
10372 /* It's not safe to sdsfree() the returned string under memory
10373 * corruption conditions. Let it leak as we are going to abort */
10374
10375 trace_size = backtrace(trace, 100);
10376 /* overwrite sigaction with caller's address */
10377 if (getMcontextEip(uc) != NULL) {
10378 trace[1] = getMcontextEip(uc);
10379 }
10380 messages = backtrace_symbols(trace, trace_size);
10381
10382 for (i=1; i<trace_size; ++i) {
10383 char *fn = findFuncName(trace[i], &offset), *p;
10384
10385 p = strchr(messages[i],'+');
10386 if (!fn || (p && ((unsigned long)strtol(p+1,NULL,10)) < offset)) {
10387 redisLog(REDIS_WARNING,"%s", messages[i]);
10388 } else {
10389 redisLog(REDIS_WARNING,"%d redis-server %p %s + %d", i, trace[i], fn, (unsigned int)offset);
10390 }
10391 }
10392 /* free(messages); Don't call free() with possibly corrupted memory. */
10393 _exit(0);
10394 }
10395
10396 static void setupSigSegvAction(void) {
10397 struct sigaction act;
10398
10399 sigemptyset (&act.sa_mask);
10400 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
10401 * is used. Otherwise, sa_handler is used */
10402 act.sa_flags = SA_NODEFER | SA_ONSTACK | SA_RESETHAND | SA_SIGINFO;
10403 act.sa_sigaction = segvHandler;
10404 sigaction (SIGSEGV, &act, NULL);
10405 sigaction (SIGBUS, &act, NULL);
10406 sigaction (SIGFPE, &act, NULL);
10407 sigaction (SIGILL, &act, NULL);
10408 sigaction (SIGBUS, &act, NULL);
10409 return;
10410 }
10411
10412 #include "staticsymbols.h"
10413 /* This function try to convert a pointer into a function name. It's used in
10414 * oreder to provide a backtrace under segmentation fault that's able to
10415 * display functions declared as static (otherwise the backtrace is useless). */
10416 static char *findFuncName(void *pointer, unsigned long *offset){
10417 int i, ret = -1;
10418 unsigned long off, minoff = 0;
10419
10420 /* Try to match against the Symbol with the smallest offset */
10421 for (i=0; symsTable[i].pointer; i++) {
10422 unsigned long lp = (unsigned long) pointer;
10423
10424 if (lp != (unsigned long)-1 && lp >= symsTable[i].pointer) {
10425 off=lp-symsTable[i].pointer;
10426 if (ret < 0 || off < minoff) {
10427 minoff=off;
10428 ret=i;
10429 }
10430 }
10431 }
10432 if (ret == -1) return NULL;
10433 *offset = minoff;
10434 return symsTable[ret].name;
10435 }
10436 #else /* HAVE_BACKTRACE */
10437 static void setupSigSegvAction(void) {
10438 }
10439 #endif /* HAVE_BACKTRACE */
10440
10441
10442
10443 /* The End */
10444
10445
10446