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