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