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