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