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