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