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