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