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