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