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