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