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