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