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