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