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