]> git.saurik.com Git - redis.git/blob - redis.c
refactor code that retrieves value from object or replies to client
[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 *createStringObjectFromLongLong(long long value) {
2779 robj *o;
2780 if (value >= 0 && value < REDIS_SHARED_INTEGERS) {
2781 incrRefCount(shared.integers[value]);
2782 o = shared.integers[value];
2783 } else {
2784 o = createObject(REDIS_STRING, NULL);
2785 if (value >= LONG_MIN && value <= LONG_MAX) {
2786 o->encoding = REDIS_ENCODING_INT;
2787 o->ptr = (void*)((long)value);
2788 } else {
2789 o->ptr = sdscatprintf(sdsempty(),"%lld",value);
2790 }
2791 }
2792 return o;
2793 }
2794
2795 static robj *dupStringObject(robj *o) {
2796 assert(o->encoding == REDIS_ENCODING_RAW);
2797 return createStringObject(o->ptr,sdslen(o->ptr));
2798 }
2799
2800 static robj *createListObject(void) {
2801 list *l = listCreate();
2802
2803 listSetFreeMethod(l,decrRefCount);
2804 return createObject(REDIS_LIST,l);
2805 }
2806
2807 static robj *createSetObject(void) {
2808 dict *d = dictCreate(&setDictType,NULL);
2809 return createObject(REDIS_SET,d);
2810 }
2811
2812 static robj *createHashObject(void) {
2813 /* All the Hashes start as zipmaps. Will be automatically converted
2814 * into hash tables if there are enough elements or big elements
2815 * inside. */
2816 unsigned char *zm = zipmapNew();
2817 robj *o = createObject(REDIS_HASH,zm);
2818 o->encoding = REDIS_ENCODING_ZIPMAP;
2819 return o;
2820 }
2821
2822 static robj *createZsetObject(void) {
2823 zset *zs = zmalloc(sizeof(*zs));
2824
2825 zs->dict = dictCreate(&zsetDictType,NULL);
2826 zs->zsl = zslCreate();
2827 return createObject(REDIS_ZSET,zs);
2828 }
2829
2830 static void freeStringObject(robj *o) {
2831 if (o->encoding == REDIS_ENCODING_RAW) {
2832 sdsfree(o->ptr);
2833 }
2834 }
2835
2836 static void freeListObject(robj *o) {
2837 listRelease((list*) o->ptr);
2838 }
2839
2840 static void freeSetObject(robj *o) {
2841 dictRelease((dict*) o->ptr);
2842 }
2843
2844 static void freeZsetObject(robj *o) {
2845 zset *zs = o->ptr;
2846
2847 dictRelease(zs->dict);
2848 zslFree(zs->zsl);
2849 zfree(zs);
2850 }
2851
2852 static void freeHashObject(robj *o) {
2853 switch (o->encoding) {
2854 case REDIS_ENCODING_HT:
2855 dictRelease((dict*) o->ptr);
2856 break;
2857 case REDIS_ENCODING_ZIPMAP:
2858 zfree(o->ptr);
2859 break;
2860 default:
2861 redisPanic("Unknown hash encoding type");
2862 break;
2863 }
2864 }
2865
2866 static void incrRefCount(robj *o) {
2867 o->refcount++;
2868 }
2869
2870 static void decrRefCount(void *obj) {
2871 robj *o = obj;
2872
2873 if (o->refcount <= 0) redisPanic("decrRefCount against refcount <= 0");
2874 /* Object is a key of a swapped out value, or in the process of being
2875 * loaded. */
2876 if (server.vm_enabled &&
2877 (o->storage == REDIS_VM_SWAPPED || o->storage == REDIS_VM_LOADING))
2878 {
2879 if (o->storage == REDIS_VM_LOADING) vmCancelThreadedIOJob(obj);
2880 redisAssert(o->type == REDIS_STRING);
2881 freeStringObject(o);
2882 vmMarkPagesFree(o->vm.page,o->vm.usedpages);
2883 pthread_mutex_lock(&server.obj_freelist_mutex);
2884 if (listLength(server.objfreelist) > REDIS_OBJFREELIST_MAX ||
2885 !listAddNodeHead(server.objfreelist,o))
2886 zfree(o);
2887 pthread_mutex_unlock(&server.obj_freelist_mutex);
2888 server.vm_stats_swapped_objects--;
2889 return;
2890 }
2891 /* Object is in memory, or in the process of being swapped out. */
2892 if (--(o->refcount) == 0) {
2893 if (server.vm_enabled && o->storage == REDIS_VM_SWAPPING)
2894 vmCancelThreadedIOJob(obj);
2895 switch(o->type) {
2896 case REDIS_STRING: freeStringObject(o); break;
2897 case REDIS_LIST: freeListObject(o); break;
2898 case REDIS_SET: freeSetObject(o); break;
2899 case REDIS_ZSET: freeZsetObject(o); break;
2900 case REDIS_HASH: freeHashObject(o); break;
2901 default: redisPanic("Unknown object type"); break;
2902 }
2903 if (server.vm_enabled) pthread_mutex_lock(&server.obj_freelist_mutex);
2904 if (listLength(server.objfreelist) > REDIS_OBJFREELIST_MAX ||
2905 !listAddNodeHead(server.objfreelist,o))
2906 zfree(o);
2907 if (server.vm_enabled) pthread_mutex_unlock(&server.obj_freelist_mutex);
2908 }
2909 }
2910
2911 static robj *lookupKey(redisDb *db, robj *key) {
2912 dictEntry *de = dictFind(db->dict,key);
2913 if (de) {
2914 robj *key = dictGetEntryKey(de);
2915 robj *val = dictGetEntryVal(de);
2916
2917 if (server.vm_enabled) {
2918 if (key->storage == REDIS_VM_MEMORY ||
2919 key->storage == REDIS_VM_SWAPPING)
2920 {
2921 /* If we were swapping the object out, stop it, this key
2922 * was requested. */
2923 if (key->storage == REDIS_VM_SWAPPING)
2924 vmCancelThreadedIOJob(key);
2925 /* Update the access time of the key for the aging algorithm. */
2926 key->vm.atime = server.unixtime;
2927 } else {
2928 int notify = (key->storage == REDIS_VM_LOADING);
2929
2930 /* Our value was swapped on disk. Bring it at home. */
2931 redisAssert(val == NULL);
2932 val = vmLoadObject(key);
2933 dictGetEntryVal(de) = val;
2934
2935 /* Clients blocked by the VM subsystem may be waiting for
2936 * this key... */
2937 if (notify) handleClientsBlockedOnSwappedKey(db,key);
2938 }
2939 }
2940 return val;
2941 } else {
2942 return NULL;
2943 }
2944 }
2945
2946 static robj *lookupKeyRead(redisDb *db, robj *key) {
2947 expireIfNeeded(db,key);
2948 return lookupKey(db,key);
2949 }
2950
2951 static robj *lookupKeyWrite(redisDb *db, robj *key) {
2952 deleteIfVolatile(db,key);
2953 return lookupKey(db,key);
2954 }
2955
2956 static robj *lookupKeyReadOrReply(redisClient *c, robj *key, robj *reply) {
2957 robj *o = lookupKeyRead(c->db, key);
2958 if (!o) addReply(c,reply);
2959 return o;
2960 }
2961
2962 static robj *lookupKeyWriteOrReply(redisClient *c, robj *key, robj *reply) {
2963 robj *o = lookupKeyWrite(c->db, key);
2964 if (!o) addReply(c,reply);
2965 return o;
2966 }
2967
2968 static int checkType(redisClient *c, robj *o, int type) {
2969 if (o->type != type) {
2970 addReply(c,shared.wrongtypeerr);
2971 return 1;
2972 }
2973 return 0;
2974 }
2975
2976 static int deleteKey(redisDb *db, robj *key) {
2977 int retval;
2978
2979 /* We need to protect key from destruction: after the first dictDelete()
2980 * it may happen that 'key' is no longer valid if we don't increment
2981 * it's count. This may happen when we get the object reference directly
2982 * from the hash table with dictRandomKey() or dict iterators */
2983 incrRefCount(key);
2984 if (dictSize(db->expires)) dictDelete(db->expires,key);
2985 retval = dictDelete(db->dict,key);
2986 decrRefCount(key);
2987
2988 return retval == DICT_OK;
2989 }
2990
2991 /* Check if the nul-terminated string 's' can be represented by a long
2992 * (that is, is a number that fits into long without any other space or
2993 * character before or after the digits).
2994 *
2995 * If so, the function returns REDIS_OK and *longval is set to the value
2996 * of the number. Otherwise REDIS_ERR is returned */
2997 static int isStringRepresentableAsLong(sds s, long *longval) {
2998 char buf[32], *endptr;
2999 long value;
3000 int slen;
3001
3002 value = strtol(s, &endptr, 10);
3003 if (endptr[0] != '\0') return REDIS_ERR;
3004 slen = snprintf(buf,32,"%ld",value);
3005
3006 /* If the number converted back into a string is not identical
3007 * then it's not possible to encode the string as integer */
3008 if (sdslen(s) != (unsigned)slen || memcmp(buf,s,slen)) return REDIS_ERR;
3009 if (longval) *longval = value;
3010 return REDIS_OK;
3011 }
3012
3013 /* Try to encode a string object in order to save space */
3014 static robj *tryObjectEncoding(robj *o) {
3015 long value;
3016 sds s = o->ptr;
3017
3018 if (o->encoding != REDIS_ENCODING_RAW)
3019 return o; /* Already encoded */
3020
3021 /* It's not safe to encode shared objects: shared objects can be shared
3022 * everywhere in the "object space" of Redis. Encoded objects can only
3023 * appear as "values" (and not, for instance, as keys) */
3024 if (o->refcount > 1) return o;
3025
3026 /* Currently we try to encode only strings */
3027 redisAssert(o->type == REDIS_STRING);
3028
3029 /* Check if we can represent this string as a long integer */
3030 if (isStringRepresentableAsLong(s,&value) == REDIS_ERR) return o;
3031
3032 /* Ok, this object can be encoded */
3033 if (value >= 0 && value < REDIS_SHARED_INTEGERS) {
3034 decrRefCount(o);
3035 incrRefCount(shared.integers[value]);
3036 return shared.integers[value];
3037 } else {
3038 o->encoding = REDIS_ENCODING_INT;
3039 sdsfree(o->ptr);
3040 o->ptr = (void*) value;
3041 return o;
3042 }
3043 }
3044
3045 /* Get a decoded version of an encoded object (returned as a new object).
3046 * If the object is already raw-encoded just increment the ref count. */
3047 static robj *getDecodedObject(robj *o) {
3048 robj *dec;
3049
3050 if (o->encoding == REDIS_ENCODING_RAW) {
3051 incrRefCount(o);
3052 return o;
3053 }
3054 if (o->type == REDIS_STRING && o->encoding == REDIS_ENCODING_INT) {
3055 char buf[32];
3056
3057 snprintf(buf,32,"%ld",(long)o->ptr);
3058 dec = createStringObject(buf,strlen(buf));
3059 return dec;
3060 } else {
3061 redisAssert(1 != 1);
3062 }
3063 }
3064
3065 /* Compare two string objects via strcmp() or alike.
3066 * Note that the objects may be integer-encoded. In such a case we
3067 * use snprintf() to get a string representation of the numbers on the stack
3068 * and compare the strings, it's much faster than calling getDecodedObject().
3069 *
3070 * Important note: if objects are not integer encoded, but binary-safe strings,
3071 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
3072 * binary safe. */
3073 static int compareStringObjects(robj *a, robj *b) {
3074 redisAssert(a->type == REDIS_STRING && b->type == REDIS_STRING);
3075 char bufa[128], bufb[128], *astr, *bstr;
3076 int bothsds = 1;
3077
3078 if (a == b) return 0;
3079 if (a->encoding != REDIS_ENCODING_RAW) {
3080 snprintf(bufa,sizeof(bufa),"%ld",(long) a->ptr);
3081 astr = bufa;
3082 bothsds = 0;
3083 } else {
3084 astr = a->ptr;
3085 }
3086 if (b->encoding != REDIS_ENCODING_RAW) {
3087 snprintf(bufb,sizeof(bufb),"%ld",(long) b->ptr);
3088 bstr = bufb;
3089 bothsds = 0;
3090 } else {
3091 bstr = b->ptr;
3092 }
3093 return bothsds ? sdscmp(astr,bstr) : strcmp(astr,bstr);
3094 }
3095
3096 static size_t stringObjectLen(robj *o) {
3097 redisAssert(o->type == REDIS_STRING);
3098 if (o->encoding == REDIS_ENCODING_RAW) {
3099 return sdslen(o->ptr);
3100 } else {
3101 char buf[32];
3102
3103 return snprintf(buf,32,"%ld",(long)o->ptr);
3104 }
3105 }
3106
3107 static int getDoubleFromObject(robj *o, double *target) {
3108 double value;
3109 char *eptr = NULL;
3110
3111 if (o == NULL) {
3112 value = 0;
3113 } else {
3114 redisAssert(o->type == REDIS_STRING);
3115 if (o->encoding == REDIS_ENCODING_RAW) {
3116 value = strtod(o->ptr, &eptr);
3117 } else if (o->encoding == REDIS_ENCODING_INT) {
3118 value = (long)o->ptr;
3119 } else {
3120 redisAssert(1 != 1);
3121 }
3122 }
3123
3124 if (eptr != NULL && eptr[0] != '\0') {
3125 return REDIS_ERR;
3126 }
3127
3128 *target = value;
3129 return REDIS_OK;
3130 }
3131
3132 static int getDoubleFromObjectOrReply(redisClient *c, robj *o, double *target, const char *msg) {
3133 double value;
3134 if (getDoubleFromObject(o, &value) != REDIS_OK) {
3135 if (msg != NULL) {
3136 addReplySds(c, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg));
3137 } else {
3138 addReplySds(c, sdsnew("-ERR value is not a double\r\n"));
3139 }
3140 return REDIS_ERR;
3141 }
3142
3143 *target = value;
3144 return REDIS_OK;
3145 }
3146
3147 static int getLongLongFromObject(robj *o, long long *target) {
3148 long long value;
3149 char *eptr = NULL;
3150
3151 if (o == NULL) {
3152 value = 0;
3153 } else {
3154 redisAssert(o->type == REDIS_STRING);
3155 if (o->encoding == REDIS_ENCODING_RAW) {
3156 value = strtoll(o->ptr, &eptr, 10);
3157 } else if (o->encoding == REDIS_ENCODING_INT) {
3158 value = (long)o->ptr;
3159 } else {
3160 redisAssert(1 != 1);
3161 }
3162 }
3163
3164 if (eptr != NULL && eptr[0] != '\0') {
3165 return REDIS_ERR;
3166 }
3167
3168 *target = value;
3169 return REDIS_OK;
3170 }
3171
3172 static int getLongLongFromObjectOrReply(redisClient *c, robj *o, long long *target, const char *msg) {
3173 long long value;
3174 if (getLongLongFromObject(o, &value) != REDIS_OK) {
3175 if (msg != NULL) {
3176 addReplySds(c, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg));
3177 } else {
3178 addReplySds(c, sdsnew("-ERR value is not an integer\r\n"));
3179 }
3180 return REDIS_ERR;
3181 }
3182
3183 *target = value;
3184 return REDIS_OK;
3185 }
3186
3187 static int getLongFromObjectOrReply(redisClient *c, robj *o, long *target, const char *msg) {
3188 long long value;
3189
3190 if (getLongLongFromObjectOrReply(c, o, &value, msg) != REDIS_OK) return REDIS_ERR;
3191 if (value < LONG_MIN || value > LONG_MAX) {
3192 if (msg != NULL) {
3193 addReplySds(c, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg));
3194 } else {
3195 addReplySds(c, sdsnew("-ERR value is out of range\r\n"));
3196 }
3197 return REDIS_ERR;
3198 }
3199
3200 *target = value;
3201 return REDIS_OK;
3202 }
3203
3204 /*============================ RDB saving/loading =========================== */
3205
3206 static int rdbSaveType(FILE *fp, unsigned char type) {
3207 if (fwrite(&type,1,1,fp) == 0) return -1;
3208 return 0;
3209 }
3210
3211 static int rdbSaveTime(FILE *fp, time_t t) {
3212 int32_t t32 = (int32_t) t;
3213 if (fwrite(&t32,4,1,fp) == 0) return -1;
3214 return 0;
3215 }
3216
3217 /* check rdbLoadLen() comments for more info */
3218 static int rdbSaveLen(FILE *fp, uint32_t len) {
3219 unsigned char buf[2];
3220
3221 if (len < (1<<6)) {
3222 /* Save a 6 bit len */
3223 buf[0] = (len&0xFF)|(REDIS_RDB_6BITLEN<<6);
3224 if (fwrite(buf,1,1,fp) == 0) return -1;
3225 } else if (len < (1<<14)) {
3226 /* Save a 14 bit len */
3227 buf[0] = ((len>>8)&0xFF)|(REDIS_RDB_14BITLEN<<6);
3228 buf[1] = len&0xFF;
3229 if (fwrite(buf,2,1,fp) == 0) return -1;
3230 } else {
3231 /* Save a 32 bit len */
3232 buf[0] = (REDIS_RDB_32BITLEN<<6);
3233 if (fwrite(buf,1,1,fp) == 0) return -1;
3234 len = htonl(len);
3235 if (fwrite(&len,4,1,fp) == 0) return -1;
3236 }
3237 return 0;
3238 }
3239
3240 /* String objects in the form "2391" "-100" without any space and with a
3241 * range of values that can fit in an 8, 16 or 32 bit signed value can be
3242 * encoded as integers to save space */
3243 static int rdbTryIntegerEncoding(char *s, size_t len, unsigned char *enc) {
3244 long long value;
3245 char *endptr, buf[32];
3246
3247 /* Check if it's possible to encode this value as a number */
3248 value = strtoll(s, &endptr, 10);
3249 if (endptr[0] != '\0') return 0;
3250 snprintf(buf,32,"%lld",value);
3251
3252 /* If the number converted back into a string is not identical
3253 * then it's not possible to encode the string as integer */
3254 if (strlen(buf) != len || memcmp(buf,s,len)) return 0;
3255
3256 /* Finally check if it fits in our ranges */
3257 if (value >= -(1<<7) && value <= (1<<7)-1) {
3258 enc[0] = (REDIS_RDB_ENCVAL<<6)|REDIS_RDB_ENC_INT8;
3259 enc[1] = value&0xFF;
3260 return 2;
3261 } else if (value >= -(1<<15) && value <= (1<<15)-1) {
3262 enc[0] = (REDIS_RDB_ENCVAL<<6)|REDIS_RDB_ENC_INT16;
3263 enc[1] = value&0xFF;
3264 enc[2] = (value>>8)&0xFF;
3265 return 3;
3266 } else if (value >= -((long long)1<<31) && value <= ((long long)1<<31)-1) {
3267 enc[0] = (REDIS_RDB_ENCVAL<<6)|REDIS_RDB_ENC_INT32;
3268 enc[1] = value&0xFF;
3269 enc[2] = (value>>8)&0xFF;
3270 enc[3] = (value>>16)&0xFF;
3271 enc[4] = (value>>24)&0xFF;
3272 return 5;
3273 } else {
3274 return 0;
3275 }
3276 }
3277
3278 static int rdbSaveLzfStringObject(FILE *fp, unsigned char *s, size_t len) {
3279 size_t comprlen, outlen;
3280 unsigned char byte;
3281 void *out;
3282
3283 /* We require at least four bytes compression for this to be worth it */
3284 if (len <= 4) return 0;
3285 outlen = len-4;
3286 if ((out = zmalloc(outlen+1)) == NULL) return 0;
3287 comprlen = lzf_compress(s, len, out, outlen);
3288 if (comprlen == 0) {
3289 zfree(out);
3290 return 0;
3291 }
3292 /* Data compressed! Let's save it on disk */
3293 byte = (REDIS_RDB_ENCVAL<<6)|REDIS_RDB_ENC_LZF;
3294 if (fwrite(&byte,1,1,fp) == 0) goto writeerr;
3295 if (rdbSaveLen(fp,comprlen) == -1) goto writeerr;
3296 if (rdbSaveLen(fp,len) == -1) goto writeerr;
3297 if (fwrite(out,comprlen,1,fp) == 0) goto writeerr;
3298 zfree(out);
3299 return comprlen;
3300
3301 writeerr:
3302 zfree(out);
3303 return -1;
3304 }
3305
3306 /* Save a string objet as [len][data] on disk. If the object is a string
3307 * representation of an integer value we try to safe it in a special form */
3308 static int rdbSaveRawString(FILE *fp, unsigned char *s, size_t len) {
3309 int enclen;
3310
3311 /* Try integer encoding */
3312 if (len <= 11) {
3313 unsigned char buf[5];
3314 if ((enclen = rdbTryIntegerEncoding((char*)s,len,buf)) > 0) {
3315 if (fwrite(buf,enclen,1,fp) == 0) return -1;
3316 return 0;
3317 }
3318 }
3319
3320 /* Try LZF compression - under 20 bytes it's unable to compress even
3321 * aaaaaaaaaaaaaaaaaa so skip it */
3322 if (server.rdbcompression && len > 20) {
3323 int retval;
3324
3325 retval = rdbSaveLzfStringObject(fp,s,len);
3326 if (retval == -1) return -1;
3327 if (retval > 0) return 0;
3328 /* retval == 0 means data can't be compressed, save the old way */
3329 }
3330
3331 /* Store verbatim */
3332 if (rdbSaveLen(fp,len) == -1) return -1;
3333 if (len && fwrite(s,len,1,fp) == 0) return -1;
3334 return 0;
3335 }
3336
3337 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
3338 static int rdbSaveStringObject(FILE *fp, robj *obj) {
3339 int retval;
3340
3341 /* Avoid incr/decr ref count business when possible.
3342 * This plays well with copy-on-write given that we are probably
3343 * in a child process (BGSAVE). Also this makes sure key objects
3344 * of swapped objects are not incRefCount-ed (an assert does not allow
3345 * this in order to avoid bugs) */
3346 if (obj->encoding != REDIS_ENCODING_RAW) {
3347 obj = getDecodedObject(obj);
3348 retval = rdbSaveRawString(fp,obj->ptr,sdslen(obj->ptr));
3349 decrRefCount(obj);
3350 } else {
3351 retval = rdbSaveRawString(fp,obj->ptr,sdslen(obj->ptr));
3352 }
3353 return retval;
3354 }
3355
3356 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
3357 * 8 bit integer specifing the length of the representation.
3358 * This 8 bit integer has special values in order to specify the following
3359 * conditions:
3360 * 253: not a number
3361 * 254: + inf
3362 * 255: - inf
3363 */
3364 static int rdbSaveDoubleValue(FILE *fp, double val) {
3365 unsigned char buf[128];
3366 int len;
3367
3368 if (isnan(val)) {
3369 buf[0] = 253;
3370 len = 1;
3371 } else if (!isfinite(val)) {
3372 len = 1;
3373 buf[0] = (val < 0) ? 255 : 254;
3374 } else {
3375 snprintf((char*)buf+1,sizeof(buf)-1,"%.17g",val);
3376 buf[0] = strlen((char*)buf+1);
3377 len = buf[0]+1;
3378 }
3379 if (fwrite(buf,len,1,fp) == 0) return -1;
3380 return 0;
3381 }
3382
3383 /* Save a Redis object. */
3384 static int rdbSaveObject(FILE *fp, robj *o) {
3385 if (o->type == REDIS_STRING) {
3386 /* Save a string value */
3387 if (rdbSaveStringObject(fp,o) == -1) return -1;
3388 } else if (o->type == REDIS_LIST) {
3389 /* Save a list value */
3390 list *list = o->ptr;
3391 listIter li;
3392 listNode *ln;
3393
3394 if (rdbSaveLen(fp,listLength(list)) == -1) return -1;
3395 listRewind(list,&li);
3396 while((ln = listNext(&li))) {
3397 robj *eleobj = listNodeValue(ln);
3398
3399 if (rdbSaveStringObject(fp,eleobj) == -1) return -1;
3400 }
3401 } else if (o->type == REDIS_SET) {
3402 /* Save a set value */
3403 dict *set = o->ptr;
3404 dictIterator *di = dictGetIterator(set);
3405 dictEntry *de;
3406
3407 if (rdbSaveLen(fp,dictSize(set)) == -1) return -1;
3408 while((de = dictNext(di)) != NULL) {
3409 robj *eleobj = dictGetEntryKey(de);
3410
3411 if (rdbSaveStringObject(fp,eleobj) == -1) return -1;
3412 }
3413 dictReleaseIterator(di);
3414 } else if (o->type == REDIS_ZSET) {
3415 /* Save a set value */
3416 zset *zs = o->ptr;
3417 dictIterator *di = dictGetIterator(zs->dict);
3418 dictEntry *de;
3419
3420 if (rdbSaveLen(fp,dictSize(zs->dict)) == -1) return -1;
3421 while((de = dictNext(di)) != NULL) {
3422 robj *eleobj = dictGetEntryKey(de);
3423 double *score = dictGetEntryVal(de);
3424
3425 if (rdbSaveStringObject(fp,eleobj) == -1) return -1;
3426 if (rdbSaveDoubleValue(fp,*score) == -1) return -1;
3427 }
3428 dictReleaseIterator(di);
3429 } else if (o->type == REDIS_HASH) {
3430 /* Save a hash value */
3431 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
3432 unsigned char *p = zipmapRewind(o->ptr);
3433 unsigned int count = zipmapLen(o->ptr);
3434 unsigned char *key, *val;
3435 unsigned int klen, vlen;
3436
3437 if (rdbSaveLen(fp,count) == -1) return -1;
3438 while((p = zipmapNext(p,&key,&klen,&val,&vlen)) != NULL) {
3439 if (rdbSaveRawString(fp,key,klen) == -1) return -1;
3440 if (rdbSaveRawString(fp,val,vlen) == -1) return -1;
3441 }
3442 } else {
3443 dictIterator *di = dictGetIterator(o->ptr);
3444 dictEntry *de;
3445
3446 if (rdbSaveLen(fp,dictSize((dict*)o->ptr)) == -1) return -1;
3447 while((de = dictNext(di)) != NULL) {
3448 robj *key = dictGetEntryKey(de);
3449 robj *val = dictGetEntryVal(de);
3450
3451 if (rdbSaveStringObject(fp,key) == -1) return -1;
3452 if (rdbSaveStringObject(fp,val) == -1) return -1;
3453 }
3454 dictReleaseIterator(di);
3455 }
3456 } else {
3457 redisPanic("Unknown object type");
3458 }
3459 return 0;
3460 }
3461
3462 /* Return the length the object will have on disk if saved with
3463 * the rdbSaveObject() function. Currently we use a trick to get
3464 * this length with very little changes to the code. In the future
3465 * we could switch to a faster solution. */
3466 static off_t rdbSavedObjectLen(robj *o, FILE *fp) {
3467 if (fp == NULL) fp = server.devnull;
3468 rewind(fp);
3469 assert(rdbSaveObject(fp,o) != 1);
3470 return ftello(fp);
3471 }
3472
3473 /* Return the number of pages required to save this object in the swap file */
3474 static off_t rdbSavedObjectPages(robj *o, FILE *fp) {
3475 off_t bytes = rdbSavedObjectLen(o,fp);
3476
3477 return (bytes+(server.vm_page_size-1))/server.vm_page_size;
3478 }
3479
3480 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3481 static int rdbSave(char *filename) {
3482 dictIterator *di = NULL;
3483 dictEntry *de;
3484 FILE *fp;
3485 char tmpfile[256];
3486 int j;
3487 time_t now = time(NULL);
3488
3489 /* Wait for I/O therads to terminate, just in case this is a
3490 * foreground-saving, to avoid seeking the swap file descriptor at the
3491 * same time. */
3492 if (server.vm_enabled)
3493 waitEmptyIOJobsQueue();
3494
3495 snprintf(tmpfile,256,"temp-%d.rdb", (int) getpid());
3496 fp = fopen(tmpfile,"w");
3497 if (!fp) {
3498 redisLog(REDIS_WARNING, "Failed saving the DB: %s", strerror(errno));
3499 return REDIS_ERR;
3500 }
3501 if (fwrite("REDIS0001",9,1,fp) == 0) goto werr;
3502 for (j = 0; j < server.dbnum; j++) {
3503 redisDb *db = server.db+j;
3504 dict *d = db->dict;
3505 if (dictSize(d) == 0) continue;
3506 di = dictGetIterator(d);
3507 if (!di) {
3508 fclose(fp);
3509 return REDIS_ERR;
3510 }
3511
3512 /* Write the SELECT DB opcode */
3513 if (rdbSaveType(fp,REDIS_SELECTDB) == -1) goto werr;
3514 if (rdbSaveLen(fp,j) == -1) goto werr;
3515
3516 /* Iterate this DB writing every entry */
3517 while((de = dictNext(di)) != NULL) {
3518 robj *key = dictGetEntryKey(de);
3519 robj *o = dictGetEntryVal(de);
3520 time_t expiretime = getExpire(db,key);
3521
3522 /* Save the expire time */
3523 if (expiretime != -1) {
3524 /* If this key is already expired skip it */
3525 if (expiretime < now) continue;
3526 if (rdbSaveType(fp,REDIS_EXPIRETIME) == -1) goto werr;
3527 if (rdbSaveTime(fp,expiretime) == -1) goto werr;
3528 }
3529 /* Save the key and associated value. This requires special
3530 * handling if the value is swapped out. */
3531 if (!server.vm_enabled || key->storage == REDIS_VM_MEMORY ||
3532 key->storage == REDIS_VM_SWAPPING) {
3533 /* Save type, key, value */
3534 if (rdbSaveType(fp,o->type) == -1) goto werr;
3535 if (rdbSaveStringObject(fp,key) == -1) goto werr;
3536 if (rdbSaveObject(fp,o) == -1) goto werr;
3537 } else {
3538 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3539 robj *po;
3540 /* Get a preview of the object in memory */
3541 po = vmPreviewObject(key);
3542 /* Save type, key, value */
3543 if (rdbSaveType(fp,key->vtype) == -1) goto werr;
3544 if (rdbSaveStringObject(fp,key) == -1) goto werr;
3545 if (rdbSaveObject(fp,po) == -1) goto werr;
3546 /* Remove the loaded object from memory */
3547 decrRefCount(po);
3548 }
3549 }
3550 dictReleaseIterator(di);
3551 }
3552 /* EOF opcode */
3553 if (rdbSaveType(fp,REDIS_EOF) == -1) goto werr;
3554
3555 /* Make sure data will not remain on the OS's output buffers */
3556 fflush(fp);
3557 fsync(fileno(fp));
3558 fclose(fp);
3559
3560 /* Use RENAME to make sure the DB file is changed atomically only
3561 * if the generate DB file is ok. */
3562 if (rename(tmpfile,filename) == -1) {
3563 redisLog(REDIS_WARNING,"Error moving temp DB file on the final destination: %s", strerror(errno));
3564 unlink(tmpfile);
3565 return REDIS_ERR;
3566 }
3567 redisLog(REDIS_NOTICE,"DB saved on disk");
3568 server.dirty = 0;
3569 server.lastsave = time(NULL);
3570 return REDIS_OK;
3571
3572 werr:
3573 fclose(fp);
3574 unlink(tmpfile);
3575 redisLog(REDIS_WARNING,"Write error saving DB on disk: %s", strerror(errno));
3576 if (di) dictReleaseIterator(di);
3577 return REDIS_ERR;
3578 }
3579
3580 static int rdbSaveBackground(char *filename) {
3581 pid_t childpid;
3582
3583 if (server.bgsavechildpid != -1) return REDIS_ERR;
3584 if (server.vm_enabled) waitEmptyIOJobsQueue();
3585 if ((childpid = fork()) == 0) {
3586 /* Child */
3587 if (server.vm_enabled) vmReopenSwapFile();
3588 close(server.fd);
3589 if (rdbSave(filename) == REDIS_OK) {
3590 _exit(0);
3591 } else {
3592 _exit(1);
3593 }
3594 } else {
3595 /* Parent */
3596 if (childpid == -1) {
3597 redisLog(REDIS_WARNING,"Can't save in background: fork: %s",
3598 strerror(errno));
3599 return REDIS_ERR;
3600 }
3601 redisLog(REDIS_NOTICE,"Background saving started by pid %d",childpid);
3602 server.bgsavechildpid = childpid;
3603 updateDictResizePolicy();
3604 return REDIS_OK;
3605 }
3606 return REDIS_OK; /* unreached */
3607 }
3608
3609 static void rdbRemoveTempFile(pid_t childpid) {
3610 char tmpfile[256];
3611
3612 snprintf(tmpfile,256,"temp-%d.rdb", (int) childpid);
3613 unlink(tmpfile);
3614 }
3615
3616 static int rdbLoadType(FILE *fp) {
3617 unsigned char type;
3618 if (fread(&type,1,1,fp) == 0) return -1;
3619 return type;
3620 }
3621
3622 static time_t rdbLoadTime(FILE *fp) {
3623 int32_t t32;
3624 if (fread(&t32,4,1,fp) == 0) return -1;
3625 return (time_t) t32;
3626 }
3627
3628 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3629 * of this file for a description of how this are stored on disk.
3630 *
3631 * isencoded is set to 1 if the readed length is not actually a length but
3632 * an "encoding type", check the above comments for more info */
3633 static uint32_t rdbLoadLen(FILE *fp, int *isencoded) {
3634 unsigned char buf[2];
3635 uint32_t len;
3636 int type;
3637
3638 if (isencoded) *isencoded = 0;
3639 if (fread(buf,1,1,fp) == 0) return REDIS_RDB_LENERR;
3640 type = (buf[0]&0xC0)>>6;
3641 if (type == REDIS_RDB_6BITLEN) {
3642 /* Read a 6 bit len */
3643 return buf[0]&0x3F;
3644 } else if (type == REDIS_RDB_ENCVAL) {
3645 /* Read a 6 bit len encoding type */
3646 if (isencoded) *isencoded = 1;
3647 return buf[0]&0x3F;
3648 } else if (type == REDIS_RDB_14BITLEN) {
3649 /* Read a 14 bit len */
3650 if (fread(buf+1,1,1,fp) == 0) return REDIS_RDB_LENERR;
3651 return ((buf[0]&0x3F)<<8)|buf[1];
3652 } else {
3653 /* Read a 32 bit len */
3654 if (fread(&len,4,1,fp) == 0) return REDIS_RDB_LENERR;
3655 return ntohl(len);
3656 }
3657 }
3658
3659 static robj *rdbLoadIntegerObject(FILE *fp, int enctype) {
3660 unsigned char enc[4];
3661 long long val;
3662
3663 if (enctype == REDIS_RDB_ENC_INT8) {
3664 if (fread(enc,1,1,fp) == 0) return NULL;
3665 val = (signed char)enc[0];
3666 } else if (enctype == REDIS_RDB_ENC_INT16) {
3667 uint16_t v;
3668 if (fread(enc,2,1,fp) == 0) return NULL;
3669 v = enc[0]|(enc[1]<<8);
3670 val = (int16_t)v;
3671 } else if (enctype == REDIS_RDB_ENC_INT32) {
3672 uint32_t v;
3673 if (fread(enc,4,1,fp) == 0) return NULL;
3674 v = enc[0]|(enc[1]<<8)|(enc[2]<<16)|(enc[3]<<24);
3675 val = (int32_t)v;
3676 } else {
3677 val = 0; /* anti-warning */
3678 redisPanic("Unknown RDB integer encoding type");
3679 }
3680 return createObject(REDIS_STRING,sdscatprintf(sdsempty(),"%lld",val));
3681 }
3682
3683 static robj *rdbLoadLzfStringObject(FILE*fp) {
3684 unsigned int len, clen;
3685 unsigned char *c = NULL;
3686 sds val = NULL;
3687
3688 if ((clen = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
3689 if ((len = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
3690 if ((c = zmalloc(clen)) == NULL) goto err;
3691 if ((val = sdsnewlen(NULL,len)) == NULL) goto err;
3692 if (fread(c,clen,1,fp) == 0) goto err;
3693 if (lzf_decompress(c,clen,val,len) == 0) goto err;
3694 zfree(c);
3695 return createObject(REDIS_STRING,val);
3696 err:
3697 zfree(c);
3698 sdsfree(val);
3699 return NULL;
3700 }
3701
3702 static robj *rdbLoadStringObject(FILE*fp) {
3703 int isencoded;
3704 uint32_t len;
3705 sds val;
3706
3707 len = rdbLoadLen(fp,&isencoded);
3708 if (isencoded) {
3709 switch(len) {
3710 case REDIS_RDB_ENC_INT8:
3711 case REDIS_RDB_ENC_INT16:
3712 case REDIS_RDB_ENC_INT32:
3713 return rdbLoadIntegerObject(fp,len);
3714 case REDIS_RDB_ENC_LZF:
3715 return rdbLoadLzfStringObject(fp);
3716 default:
3717 redisPanic("Unknown RDB encoding type");
3718 }
3719 }
3720
3721 if (len == REDIS_RDB_LENERR) return NULL;
3722 val = sdsnewlen(NULL,len);
3723 if (len && fread(val,len,1,fp) == 0) {
3724 sdsfree(val);
3725 return NULL;
3726 }
3727 return createObject(REDIS_STRING,val);
3728 }
3729
3730 /* For information about double serialization check rdbSaveDoubleValue() */
3731 static int rdbLoadDoubleValue(FILE *fp, double *val) {
3732 char buf[128];
3733 unsigned char len;
3734
3735 if (fread(&len,1,1,fp) == 0) return -1;
3736 switch(len) {
3737 case 255: *val = R_NegInf; return 0;
3738 case 254: *val = R_PosInf; return 0;
3739 case 253: *val = R_Nan; return 0;
3740 default:
3741 if (fread(buf,len,1,fp) == 0) return -1;
3742 buf[len] = '\0';
3743 sscanf(buf, "%lg", val);
3744 return 0;
3745 }
3746 }
3747
3748 /* Load a Redis object of the specified type from the specified file.
3749 * On success a newly allocated object is returned, otherwise NULL. */
3750 static robj *rdbLoadObject(int type, FILE *fp) {
3751 robj *o;
3752
3753 redisLog(REDIS_DEBUG,"LOADING OBJECT %d (at %d)\n",type,ftell(fp));
3754 if (type == REDIS_STRING) {
3755 /* Read string value */
3756 if ((o = rdbLoadStringObject(fp)) == NULL) return NULL;
3757 o = tryObjectEncoding(o);
3758 } else if (type == REDIS_LIST || type == REDIS_SET) {
3759 /* Read list/set value */
3760 uint32_t listlen;
3761
3762 if ((listlen = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
3763 o = (type == REDIS_LIST) ? createListObject() : createSetObject();
3764 /* It's faster to expand the dict to the right size asap in order
3765 * to avoid rehashing */
3766 if (type == REDIS_SET && listlen > DICT_HT_INITIAL_SIZE)
3767 dictExpand(o->ptr,listlen);
3768 /* Load every single element of the list/set */
3769 while(listlen--) {
3770 robj *ele;
3771
3772 if ((ele = rdbLoadStringObject(fp)) == NULL) return NULL;
3773 ele = tryObjectEncoding(ele);
3774 if (type == REDIS_LIST) {
3775 listAddNodeTail((list*)o->ptr,ele);
3776 } else {
3777 dictAdd((dict*)o->ptr,ele,NULL);
3778 }
3779 }
3780 } else if (type == REDIS_ZSET) {
3781 /* Read list/set value */
3782 size_t zsetlen;
3783 zset *zs;
3784
3785 if ((zsetlen = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
3786 o = createZsetObject();
3787 zs = o->ptr;
3788 /* Load every single element of the list/set */
3789 while(zsetlen--) {
3790 robj *ele;
3791 double *score = zmalloc(sizeof(double));
3792
3793 if ((ele = rdbLoadStringObject(fp)) == NULL) return NULL;
3794 ele = tryObjectEncoding(ele);
3795 if (rdbLoadDoubleValue(fp,score) == -1) return NULL;
3796 dictAdd(zs->dict,ele,score);
3797 zslInsert(zs->zsl,*score,ele);
3798 incrRefCount(ele); /* added to skiplist */
3799 }
3800 } else if (type == REDIS_HASH) {
3801 size_t hashlen;
3802
3803 if ((hashlen = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
3804 o = createHashObject();
3805 /* Too many entries? Use an hash table. */
3806 if (hashlen > server.hash_max_zipmap_entries)
3807 convertToRealHash(o);
3808 /* Load every key/value, then set it into the zipmap or hash
3809 * table, as needed. */
3810 while(hashlen--) {
3811 robj *key, *val;
3812
3813 if ((key = rdbLoadStringObject(fp)) == NULL) return NULL;
3814 if ((val = rdbLoadStringObject(fp)) == NULL) return NULL;
3815 /* If we are using a zipmap and there are too big values
3816 * the object is converted to real hash table encoding. */
3817 if (o->encoding != REDIS_ENCODING_HT &&
3818 (sdslen(key->ptr) > server.hash_max_zipmap_value ||
3819 sdslen(val->ptr) > server.hash_max_zipmap_value))
3820 {
3821 convertToRealHash(o);
3822 }
3823
3824 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
3825 unsigned char *zm = o->ptr;
3826
3827 zm = zipmapSet(zm,key->ptr,sdslen(key->ptr),
3828 val->ptr,sdslen(val->ptr),NULL);
3829 o->ptr = zm;
3830 decrRefCount(key);
3831 decrRefCount(val);
3832 } else {
3833 key = tryObjectEncoding(key);
3834 val = tryObjectEncoding(val);
3835 dictAdd((dict*)o->ptr,key,val);
3836 }
3837 }
3838 } else {
3839 redisPanic("Unknown object type");
3840 }
3841 return o;
3842 }
3843
3844 static int rdbLoad(char *filename) {
3845 FILE *fp;
3846 robj *keyobj = NULL;
3847 uint32_t dbid;
3848 int type, retval, rdbver;
3849 dict *d = server.db[0].dict;
3850 redisDb *db = server.db+0;
3851 char buf[1024];
3852 time_t expiretime = -1, now = time(NULL);
3853 long long loadedkeys = 0;
3854
3855 fp = fopen(filename,"r");
3856 if (!fp) return REDIS_ERR;
3857 if (fread(buf,9,1,fp) == 0) goto eoferr;
3858 buf[9] = '\0';
3859 if (memcmp(buf,"REDIS",5) != 0) {
3860 fclose(fp);
3861 redisLog(REDIS_WARNING,"Wrong signature trying to load DB from file");
3862 return REDIS_ERR;
3863 }
3864 rdbver = atoi(buf+5);
3865 if (rdbver != 1) {
3866 fclose(fp);
3867 redisLog(REDIS_WARNING,"Can't handle RDB format version %d",rdbver);
3868 return REDIS_ERR;
3869 }
3870 while(1) {
3871 robj *o;
3872
3873 /* Read type. */
3874 if ((type = rdbLoadType(fp)) == -1) goto eoferr;
3875 if (type == REDIS_EXPIRETIME) {
3876 if ((expiretime = rdbLoadTime(fp)) == -1) goto eoferr;
3877 /* We read the time so we need to read the object type again */
3878 if ((type = rdbLoadType(fp)) == -1) goto eoferr;
3879 }
3880 if (type == REDIS_EOF) break;
3881 /* Handle SELECT DB opcode as a special case */
3882 if (type == REDIS_SELECTDB) {
3883 if ((dbid = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR)
3884 goto eoferr;
3885 if (dbid >= (unsigned)server.dbnum) {
3886 redisLog(REDIS_WARNING,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server.dbnum);
3887 exit(1);
3888 }
3889 db = server.db+dbid;
3890 d = db->dict;
3891 continue;
3892 }
3893 /* Read key */
3894 if ((keyobj = rdbLoadStringObject(fp)) == NULL) goto eoferr;
3895 /* Read value */
3896 if ((o = rdbLoadObject(type,fp)) == NULL) goto eoferr;
3897 /* Add the new object in the hash table */
3898 retval = dictAdd(d,keyobj,o);
3899 if (retval == DICT_ERR) {
3900 redisLog(REDIS_WARNING,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", keyobj->ptr);
3901 exit(1);
3902 }
3903 /* Set the expire time if needed */
3904 if (expiretime != -1) {
3905 setExpire(db,keyobj,expiretime);
3906 /* Delete this key if already expired */
3907 if (expiretime < now) deleteKey(db,keyobj);
3908 expiretime = -1;
3909 }
3910 keyobj = o = NULL;
3911 /* Handle swapping while loading big datasets when VM is on */
3912 loadedkeys++;
3913 if (server.vm_enabled && (loadedkeys % 5000) == 0) {
3914 while (zmalloc_used_memory() > server.vm_max_memory) {
3915 if (vmSwapOneObjectBlocking() == REDIS_ERR) break;
3916 }
3917 }
3918 }
3919 fclose(fp);
3920 return REDIS_OK;
3921
3922 eoferr: /* unexpected end of file is handled here with a fatal exit */
3923 if (keyobj) decrRefCount(keyobj);
3924 redisLog(REDIS_WARNING,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
3925 exit(1);
3926 return REDIS_ERR; /* Just to avoid warning */
3927 }
3928
3929 /*================================== Commands =============================== */
3930
3931 static void authCommand(redisClient *c) {
3932 if (!server.requirepass || !strcmp(c->argv[1]->ptr, server.requirepass)) {
3933 c->authenticated = 1;
3934 addReply(c,shared.ok);
3935 } else {
3936 c->authenticated = 0;
3937 addReplySds(c,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
3938 }
3939 }
3940
3941 static void pingCommand(redisClient *c) {
3942 addReply(c,shared.pong);
3943 }
3944
3945 static void echoCommand(redisClient *c) {
3946 addReplyBulk(c,c->argv[1]);
3947 }
3948
3949 /*=================================== Strings =============================== */
3950
3951 static void setGenericCommand(redisClient *c, int nx) {
3952 int retval;
3953
3954 if (nx) deleteIfVolatile(c->db,c->argv[1]);
3955 retval = dictAdd(c->db->dict,c->argv[1],c->argv[2]);
3956 if (retval == DICT_ERR) {
3957 if (!nx) {
3958 /* If the key is about a swapped value, we want a new key object
3959 * to overwrite the old. So we delete the old key in the database.
3960 * This will also make sure that swap pages about the old object
3961 * will be marked as free. */
3962 if (server.vm_enabled && deleteIfSwapped(c->db,c->argv[1]))
3963 incrRefCount(c->argv[1]);
3964 dictReplace(c->db->dict,c->argv[1],c->argv[2]);
3965 incrRefCount(c->argv[2]);
3966 } else {
3967 addReply(c,shared.czero);
3968 return;
3969 }
3970 } else {
3971 incrRefCount(c->argv[1]);
3972 incrRefCount(c->argv[2]);
3973 }
3974 server.dirty++;
3975 removeExpire(c->db,c->argv[1]);
3976 addReply(c, nx ? shared.cone : shared.ok);
3977 }
3978
3979 static void setCommand(redisClient *c) {
3980 setGenericCommand(c,0);
3981 }
3982
3983 static void setnxCommand(redisClient *c) {
3984 setGenericCommand(c,1);
3985 }
3986
3987 static int getGenericCommand(redisClient *c) {
3988 robj *o;
3989
3990 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL)
3991 return REDIS_OK;
3992
3993 if (o->type != REDIS_STRING) {
3994 addReply(c,shared.wrongtypeerr);
3995 return REDIS_ERR;
3996 } else {
3997 addReplyBulk(c,o);
3998 return REDIS_OK;
3999 }
4000 }
4001
4002 static void getCommand(redisClient *c) {
4003 getGenericCommand(c);
4004 }
4005
4006 static void getsetCommand(redisClient *c) {
4007 if (getGenericCommand(c) == REDIS_ERR) return;
4008 if (dictAdd(c->db->dict,c->argv[1],c->argv[2]) == DICT_ERR) {
4009 dictReplace(c->db->dict,c->argv[1],c->argv[2]);
4010 } else {
4011 incrRefCount(c->argv[1]);
4012 }
4013 incrRefCount(c->argv[2]);
4014 server.dirty++;
4015 removeExpire(c->db,c->argv[1]);
4016 }
4017
4018 static void mgetCommand(redisClient *c) {
4019 int j;
4020
4021 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",c->argc-1));
4022 for (j = 1; j < c->argc; j++) {
4023 robj *o = lookupKeyRead(c->db,c->argv[j]);
4024 if (o == NULL) {
4025 addReply(c,shared.nullbulk);
4026 } else {
4027 if (o->type != REDIS_STRING) {
4028 addReply(c,shared.nullbulk);
4029 } else {
4030 addReplyBulk(c,o);
4031 }
4032 }
4033 }
4034 }
4035
4036 static void msetGenericCommand(redisClient *c, int nx) {
4037 int j, busykeys = 0;
4038
4039 if ((c->argc % 2) == 0) {
4040 addReplySds(c,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
4041 return;
4042 }
4043 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
4044 * set nothing at all if at least one already key exists. */
4045 if (nx) {
4046 for (j = 1; j < c->argc; j += 2) {
4047 if (lookupKeyWrite(c->db,c->argv[j]) != NULL) {
4048 busykeys++;
4049 }
4050 }
4051 }
4052 if (busykeys) {
4053 addReply(c, shared.czero);
4054 return;
4055 }
4056
4057 for (j = 1; j < c->argc; j += 2) {
4058 int retval;
4059
4060 c->argv[j+1] = tryObjectEncoding(c->argv[j+1]);
4061 retval = dictAdd(c->db->dict,c->argv[j],c->argv[j+1]);
4062 if (retval == DICT_ERR) {
4063 dictReplace(c->db->dict,c->argv[j],c->argv[j+1]);
4064 incrRefCount(c->argv[j+1]);
4065 } else {
4066 incrRefCount(c->argv[j]);
4067 incrRefCount(c->argv[j+1]);
4068 }
4069 removeExpire(c->db,c->argv[j]);
4070 }
4071 server.dirty += (c->argc-1)/2;
4072 addReply(c, nx ? shared.cone : shared.ok);
4073 }
4074
4075 static void msetCommand(redisClient *c) {
4076 msetGenericCommand(c,0);
4077 }
4078
4079 static void msetnxCommand(redisClient *c) {
4080 msetGenericCommand(c,1);
4081 }
4082
4083 static void incrDecrCommand(redisClient *c, long long incr) {
4084 long long value;
4085 int retval;
4086 robj *o;
4087
4088 o = lookupKeyWrite(c->db,c->argv[1]);
4089
4090 if (getLongLongFromObjectOrReply(c, o, &value, NULL) != REDIS_OK) return;
4091
4092 value += incr;
4093 o = createObject(REDIS_STRING,sdscatprintf(sdsempty(),"%lld",value));
4094 o = tryObjectEncoding(o);
4095 retval = dictAdd(c->db->dict,c->argv[1],o);
4096 if (retval == DICT_ERR) {
4097 dictReplace(c->db->dict,c->argv[1],o);
4098 removeExpire(c->db,c->argv[1]);
4099 } else {
4100 incrRefCount(c->argv[1]);
4101 }
4102 server.dirty++;
4103 addReply(c,shared.colon);
4104 addReply(c,o);
4105 addReply(c,shared.crlf);
4106 }
4107
4108 static void incrCommand(redisClient *c) {
4109 incrDecrCommand(c,1);
4110 }
4111
4112 static void decrCommand(redisClient *c) {
4113 incrDecrCommand(c,-1);
4114 }
4115
4116 static void incrbyCommand(redisClient *c) {
4117 long long incr;
4118
4119 if (getLongLongFromObjectOrReply(c, c->argv[2], &incr, NULL) != REDIS_OK) return;
4120 incrDecrCommand(c,incr);
4121 }
4122
4123 static void decrbyCommand(redisClient *c) {
4124 long long incr;
4125
4126 if (getLongLongFromObjectOrReply(c, c->argv[2], &incr, NULL) != REDIS_OK) return;
4127 incrDecrCommand(c,-incr);
4128 }
4129
4130 static void appendCommand(redisClient *c) {
4131 int retval;
4132 size_t totlen;
4133 robj *o;
4134
4135 o = lookupKeyWrite(c->db,c->argv[1]);
4136 if (o == NULL) {
4137 /* Create the key */
4138 retval = dictAdd(c->db->dict,c->argv[1],c->argv[2]);
4139 incrRefCount(c->argv[1]);
4140 incrRefCount(c->argv[2]);
4141 totlen = stringObjectLen(c->argv[2]);
4142 } else {
4143 dictEntry *de;
4144
4145 de = dictFind(c->db->dict,c->argv[1]);
4146 assert(de != NULL);
4147
4148 o = dictGetEntryVal(de);
4149 if (o->type != REDIS_STRING) {
4150 addReply(c,shared.wrongtypeerr);
4151 return;
4152 }
4153 /* If the object is specially encoded or shared we have to make
4154 * a copy */
4155 if (o->refcount != 1 || o->encoding != REDIS_ENCODING_RAW) {
4156 robj *decoded = getDecodedObject(o);
4157
4158 o = createStringObject(decoded->ptr, sdslen(decoded->ptr));
4159 decrRefCount(decoded);
4160 dictReplace(c->db->dict,c->argv[1],o);
4161 }
4162 /* APPEND! */
4163 if (c->argv[2]->encoding == REDIS_ENCODING_RAW) {
4164 o->ptr = sdscatlen(o->ptr,
4165 c->argv[2]->ptr, sdslen(c->argv[2]->ptr));
4166 } else {
4167 o->ptr = sdscatprintf(o->ptr, "%ld",
4168 (unsigned long) c->argv[2]->ptr);
4169 }
4170 totlen = sdslen(o->ptr);
4171 }
4172 server.dirty++;
4173 addReplySds(c,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen));
4174 }
4175
4176 static void substrCommand(redisClient *c) {
4177 robj *o;
4178 long start = atoi(c->argv[2]->ptr);
4179 long end = atoi(c->argv[3]->ptr);
4180 size_t rangelen, strlen;
4181 sds range;
4182
4183 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
4184 checkType(c,o,REDIS_STRING)) return;
4185
4186 o = getDecodedObject(o);
4187 strlen = sdslen(o->ptr);
4188
4189 /* convert negative indexes */
4190 if (start < 0) start = strlen+start;
4191 if (end < 0) end = strlen+end;
4192 if (start < 0) start = 0;
4193 if (end < 0) end = 0;
4194
4195 /* indexes sanity checks */
4196 if (start > end || (size_t)start >= strlen) {
4197 /* Out of range start or start > end result in null reply */
4198 addReply(c,shared.nullbulk);
4199 decrRefCount(o);
4200 return;
4201 }
4202 if ((size_t)end >= strlen) end = strlen-1;
4203 rangelen = (end-start)+1;
4204
4205 /* Return the result */
4206 addReplySds(c,sdscatprintf(sdsempty(),"$%zu\r\n",rangelen));
4207 range = sdsnewlen((char*)o->ptr+start,rangelen);
4208 addReplySds(c,range);
4209 addReply(c,shared.crlf);
4210 decrRefCount(o);
4211 }
4212
4213 /* ========================= Type agnostic commands ========================= */
4214
4215 static void delCommand(redisClient *c) {
4216 int deleted = 0, j;
4217
4218 for (j = 1; j < c->argc; j++) {
4219 if (deleteKey(c->db,c->argv[j])) {
4220 server.dirty++;
4221 deleted++;
4222 }
4223 }
4224 addReplyLong(c,deleted);
4225 }
4226
4227 static void existsCommand(redisClient *c) {
4228 addReply(c,lookupKeyRead(c->db,c->argv[1]) ? shared.cone : shared.czero);
4229 }
4230
4231 static void selectCommand(redisClient *c) {
4232 int id = atoi(c->argv[1]->ptr);
4233
4234 if (selectDb(c,id) == REDIS_ERR) {
4235 addReplySds(c,sdsnew("-ERR invalid DB index\r\n"));
4236 } else {
4237 addReply(c,shared.ok);
4238 }
4239 }
4240
4241 static void randomkeyCommand(redisClient *c) {
4242 dictEntry *de;
4243
4244 while(1) {
4245 de = dictGetRandomKey(c->db->dict);
4246 if (!de || expireIfNeeded(c->db,dictGetEntryKey(de)) == 0) break;
4247 }
4248 if (de == NULL) {
4249 addReply(c,shared.plus);
4250 addReply(c,shared.crlf);
4251 } else {
4252 addReply(c,shared.plus);
4253 addReply(c,dictGetEntryKey(de));
4254 addReply(c,shared.crlf);
4255 }
4256 }
4257
4258 static void keysCommand(redisClient *c) {
4259 dictIterator *di;
4260 dictEntry *de;
4261 sds pattern = c->argv[1]->ptr;
4262 int plen = sdslen(pattern);
4263 unsigned long numkeys = 0;
4264 robj *lenobj = createObject(REDIS_STRING,NULL);
4265
4266 di = dictGetIterator(c->db->dict);
4267 addReply(c,lenobj);
4268 decrRefCount(lenobj);
4269 while((de = dictNext(di)) != NULL) {
4270 robj *keyobj = dictGetEntryKey(de);
4271
4272 sds key = keyobj->ptr;
4273 if ((pattern[0] == '*' && pattern[1] == '\0') ||
4274 stringmatchlen(pattern,plen,key,sdslen(key),0)) {
4275 if (expireIfNeeded(c->db,keyobj) == 0) {
4276 addReplyBulk(c,keyobj);
4277 numkeys++;
4278 }
4279 }
4280 }
4281 dictReleaseIterator(di);
4282 lenobj->ptr = sdscatprintf(sdsempty(),"*%lu\r\n",numkeys);
4283 }
4284
4285 static void dbsizeCommand(redisClient *c) {
4286 addReplySds(c,
4287 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c->db->dict)));
4288 }
4289
4290 static void lastsaveCommand(redisClient *c) {
4291 addReplySds(c,
4292 sdscatprintf(sdsempty(),":%lu\r\n",server.lastsave));
4293 }
4294
4295 static void typeCommand(redisClient *c) {
4296 robj *o;
4297 char *type;
4298
4299 o = lookupKeyRead(c->db,c->argv[1]);
4300 if (o == NULL) {
4301 type = "+none";
4302 } else {
4303 switch(o->type) {
4304 case REDIS_STRING: type = "+string"; break;
4305 case REDIS_LIST: type = "+list"; break;
4306 case REDIS_SET: type = "+set"; break;
4307 case REDIS_ZSET: type = "+zset"; break;
4308 case REDIS_HASH: type = "+hash"; break;
4309 default: type = "+unknown"; break;
4310 }
4311 }
4312 addReplySds(c,sdsnew(type));
4313 addReply(c,shared.crlf);
4314 }
4315
4316 static void saveCommand(redisClient *c) {
4317 if (server.bgsavechildpid != -1) {
4318 addReplySds(c,sdsnew("-ERR background save in progress\r\n"));
4319 return;
4320 }
4321 if (rdbSave(server.dbfilename) == REDIS_OK) {
4322 addReply(c,shared.ok);
4323 } else {
4324 addReply(c,shared.err);
4325 }
4326 }
4327
4328 static void bgsaveCommand(redisClient *c) {
4329 if (server.bgsavechildpid != -1) {
4330 addReplySds(c,sdsnew("-ERR background save already in progress\r\n"));
4331 return;
4332 }
4333 if (rdbSaveBackground(server.dbfilename) == REDIS_OK) {
4334 char *status = "+Background saving started\r\n";
4335 addReplySds(c,sdsnew(status));
4336 } else {
4337 addReply(c,shared.err);
4338 }
4339 }
4340
4341 static void shutdownCommand(redisClient *c) {
4342 redisLog(REDIS_WARNING,"User requested shutdown, saving DB...");
4343 /* Kill the saving child if there is a background saving in progress.
4344 We want to avoid race conditions, for instance our saving child may
4345 overwrite the synchronous saving did by SHUTDOWN. */
4346 if (server.bgsavechildpid != -1) {
4347 redisLog(REDIS_WARNING,"There is a live saving child. Killing it!");
4348 kill(server.bgsavechildpid,SIGKILL);
4349 rdbRemoveTempFile(server.bgsavechildpid);
4350 }
4351 if (server.appendonly) {
4352 /* Append only file: fsync() the AOF and exit */
4353 fsync(server.appendfd);
4354 if (server.vm_enabled) unlink(server.vm_swap_file);
4355 exit(0);
4356 } else {
4357 /* Snapshotting. Perform a SYNC SAVE and exit */
4358 if (rdbSave(server.dbfilename) == REDIS_OK) {
4359 if (server.daemonize)
4360 unlink(server.pidfile);
4361 redisLog(REDIS_WARNING,"%zu bytes used at exit",zmalloc_used_memory());
4362 redisLog(REDIS_WARNING,"Server exit now, bye bye...");
4363 if (server.vm_enabled) unlink(server.vm_swap_file);
4364 exit(0);
4365 } else {
4366 /* Ooops.. error saving! The best we can do is to continue
4367 * operating. Note that if there was a background saving process,
4368 * in the next cron() Redis will be notified that the background
4369 * saving aborted, handling special stuff like slaves pending for
4370 * synchronization... */
4371 redisLog(REDIS_WARNING,"Error trying to save the DB, can't exit");
4372 addReplySds(c,
4373 sdsnew("-ERR can't quit, problems saving the DB\r\n"));
4374 }
4375 }
4376 }
4377
4378 static void renameGenericCommand(redisClient *c, int nx) {
4379 robj *o;
4380
4381 /* To use the same key as src and dst is probably an error */
4382 if (sdscmp(c->argv[1]->ptr,c->argv[2]->ptr) == 0) {
4383 addReply(c,shared.sameobjecterr);
4384 return;
4385 }
4386
4387 if ((o = lookupKeyWriteOrReply(c,c->argv[1],shared.nokeyerr)) == NULL)
4388 return;
4389
4390 incrRefCount(o);
4391 deleteIfVolatile(c->db,c->argv[2]);
4392 if (dictAdd(c->db->dict,c->argv[2],o) == DICT_ERR) {
4393 if (nx) {
4394 decrRefCount(o);
4395 addReply(c,shared.czero);
4396 return;
4397 }
4398 dictReplace(c->db->dict,c->argv[2],o);
4399 } else {
4400 incrRefCount(c->argv[2]);
4401 }
4402 deleteKey(c->db,c->argv[1]);
4403 server.dirty++;
4404 addReply(c,nx ? shared.cone : shared.ok);
4405 }
4406
4407 static void renameCommand(redisClient *c) {
4408 renameGenericCommand(c,0);
4409 }
4410
4411 static void renamenxCommand(redisClient *c) {
4412 renameGenericCommand(c,1);
4413 }
4414
4415 static void moveCommand(redisClient *c) {
4416 robj *o;
4417 redisDb *src, *dst;
4418 int srcid;
4419
4420 /* Obtain source and target DB pointers */
4421 src = c->db;
4422 srcid = c->db->id;
4423 if (selectDb(c,atoi(c->argv[2]->ptr)) == REDIS_ERR) {
4424 addReply(c,shared.outofrangeerr);
4425 return;
4426 }
4427 dst = c->db;
4428 selectDb(c,srcid); /* Back to the source DB */
4429
4430 /* If the user is moving using as target the same
4431 * DB as the source DB it is probably an error. */
4432 if (src == dst) {
4433 addReply(c,shared.sameobjecterr);
4434 return;
4435 }
4436
4437 /* Check if the element exists and get a reference */
4438 o = lookupKeyWrite(c->db,c->argv[1]);
4439 if (!o) {
4440 addReply(c,shared.czero);
4441 return;
4442 }
4443
4444 /* Try to add the element to the target DB */
4445 deleteIfVolatile(dst,c->argv[1]);
4446 if (dictAdd(dst->dict,c->argv[1],o) == DICT_ERR) {
4447 addReply(c,shared.czero);
4448 return;
4449 }
4450 incrRefCount(c->argv[1]);
4451 incrRefCount(o);
4452
4453 /* OK! key moved, free the entry in the source DB */
4454 deleteKey(src,c->argv[1]);
4455 server.dirty++;
4456 addReply(c,shared.cone);
4457 }
4458
4459 /* =================================== Lists ================================ */
4460 static void pushGenericCommand(redisClient *c, int where) {
4461 robj *lobj;
4462 list *list;
4463
4464 lobj = lookupKeyWrite(c->db,c->argv[1]);
4465 if (lobj == NULL) {
4466 if (handleClientsWaitingListPush(c,c->argv[1],c->argv[2])) {
4467 addReply(c,shared.cone);
4468 return;
4469 }
4470 lobj = createListObject();
4471 list = lobj->ptr;
4472 if (where == REDIS_HEAD) {
4473 listAddNodeHead(list,c->argv[2]);
4474 } else {
4475 listAddNodeTail(list,c->argv[2]);
4476 }
4477 dictAdd(c->db->dict,c->argv[1],lobj);
4478 incrRefCount(c->argv[1]);
4479 incrRefCount(c->argv[2]);
4480 } else {
4481 if (lobj->type != REDIS_LIST) {
4482 addReply(c,shared.wrongtypeerr);
4483 return;
4484 }
4485 if (handleClientsWaitingListPush(c,c->argv[1],c->argv[2])) {
4486 addReply(c,shared.cone);
4487 return;
4488 }
4489 list = lobj->ptr;
4490 if (where == REDIS_HEAD) {
4491 listAddNodeHead(list,c->argv[2]);
4492 } else {
4493 listAddNodeTail(list,c->argv[2]);
4494 }
4495 incrRefCount(c->argv[2]);
4496 }
4497 server.dirty++;
4498 addReplySds(c,sdscatprintf(sdsempty(),":%d\r\n",listLength(list)));
4499 }
4500
4501 static void lpushCommand(redisClient *c) {
4502 pushGenericCommand(c,REDIS_HEAD);
4503 }
4504
4505 static void rpushCommand(redisClient *c) {
4506 pushGenericCommand(c,REDIS_TAIL);
4507 }
4508
4509 static void llenCommand(redisClient *c) {
4510 robj *o;
4511 list *l;
4512
4513 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
4514 checkType(c,o,REDIS_LIST)) return;
4515
4516 l = o->ptr;
4517 addReplyUlong(c,listLength(l));
4518 }
4519
4520 static void lindexCommand(redisClient *c) {
4521 robj *o;
4522 int index = atoi(c->argv[2]->ptr);
4523 list *list;
4524 listNode *ln;
4525
4526 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
4527 checkType(c,o,REDIS_LIST)) return;
4528 list = o->ptr;
4529
4530 ln = listIndex(list, index);
4531 if (ln == NULL) {
4532 addReply(c,shared.nullbulk);
4533 } else {
4534 robj *ele = listNodeValue(ln);
4535 addReplyBulk(c,ele);
4536 }
4537 }
4538
4539 static void lsetCommand(redisClient *c) {
4540 robj *o;
4541 int index = atoi(c->argv[2]->ptr);
4542 list *list;
4543 listNode *ln;
4544
4545 if ((o = lookupKeyWriteOrReply(c,c->argv[1],shared.nokeyerr)) == NULL ||
4546 checkType(c,o,REDIS_LIST)) return;
4547 list = o->ptr;
4548
4549 ln = listIndex(list, index);
4550 if (ln == NULL) {
4551 addReply(c,shared.outofrangeerr);
4552 } else {
4553 robj *ele = listNodeValue(ln);
4554
4555 decrRefCount(ele);
4556 listNodeValue(ln) = c->argv[3];
4557 incrRefCount(c->argv[3]);
4558 addReply(c,shared.ok);
4559 server.dirty++;
4560 }
4561 }
4562
4563 static void popGenericCommand(redisClient *c, int where) {
4564 robj *o;
4565 list *list;
4566 listNode *ln;
4567
4568 if ((o = lookupKeyWriteOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
4569 checkType(c,o,REDIS_LIST)) return;
4570 list = o->ptr;
4571
4572 if (where == REDIS_HEAD)
4573 ln = listFirst(list);
4574 else
4575 ln = listLast(list);
4576
4577 if (ln == NULL) {
4578 addReply(c,shared.nullbulk);
4579 } else {
4580 robj *ele = listNodeValue(ln);
4581 addReplyBulk(c,ele);
4582 listDelNode(list,ln);
4583 if (listLength(list) == 0) deleteKey(c->db,c->argv[1]);
4584 server.dirty++;
4585 }
4586 }
4587
4588 static void lpopCommand(redisClient *c) {
4589 popGenericCommand(c,REDIS_HEAD);
4590 }
4591
4592 static void rpopCommand(redisClient *c) {
4593 popGenericCommand(c,REDIS_TAIL);
4594 }
4595
4596 static void lrangeCommand(redisClient *c) {
4597 robj *o;
4598 int start = atoi(c->argv[2]->ptr);
4599 int end = atoi(c->argv[3]->ptr);
4600 int llen;
4601 int rangelen, j;
4602 list *list;
4603 listNode *ln;
4604 robj *ele;
4605
4606 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.emptymultibulk)) == NULL
4607 || checkType(c,o,REDIS_LIST)) return;
4608 list = o->ptr;
4609 llen = listLength(list);
4610
4611 /* convert negative indexes */
4612 if (start < 0) start = llen+start;
4613 if (end < 0) end = llen+end;
4614 if (start < 0) start = 0;
4615 if (end < 0) end = 0;
4616
4617 /* indexes sanity checks */
4618 if (start > end || start >= llen) {
4619 /* Out of range start or start > end result in empty list */
4620 addReply(c,shared.emptymultibulk);
4621 return;
4622 }
4623 if (end >= llen) end = llen-1;
4624 rangelen = (end-start)+1;
4625
4626 /* Return the result in form of a multi-bulk reply */
4627 ln = listIndex(list, start);
4628 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",rangelen));
4629 for (j = 0; j < rangelen; j++) {
4630 ele = listNodeValue(ln);
4631 addReplyBulk(c,ele);
4632 ln = ln->next;
4633 }
4634 }
4635
4636 static void ltrimCommand(redisClient *c) {
4637 robj *o;
4638 int start = atoi(c->argv[2]->ptr);
4639 int end = atoi(c->argv[3]->ptr);
4640 int llen;
4641 int j, ltrim, rtrim;
4642 list *list;
4643 listNode *ln;
4644
4645 if ((o = lookupKeyWriteOrReply(c,c->argv[1],shared.ok)) == NULL ||
4646 checkType(c,o,REDIS_LIST)) return;
4647 list = o->ptr;
4648 llen = listLength(list);
4649
4650 /* convert negative indexes */
4651 if (start < 0) start = llen+start;
4652 if (end < 0) end = llen+end;
4653 if (start < 0) start = 0;
4654 if (end < 0) end = 0;
4655
4656 /* indexes sanity checks */
4657 if (start > end || start >= llen) {
4658 /* Out of range start or start > end result in empty list */
4659 ltrim = llen;
4660 rtrim = 0;
4661 } else {
4662 if (end >= llen) end = llen-1;
4663 ltrim = start;
4664 rtrim = llen-end-1;
4665 }
4666
4667 /* Remove list elements to perform the trim */
4668 for (j = 0; j < ltrim; j++) {
4669 ln = listFirst(list);
4670 listDelNode(list,ln);
4671 }
4672 for (j = 0; j < rtrim; j++) {
4673 ln = listLast(list);
4674 listDelNode(list,ln);
4675 }
4676 if (listLength(list) == 0) deleteKey(c->db,c->argv[1]);
4677 server.dirty++;
4678 addReply(c,shared.ok);
4679 }
4680
4681 static void lremCommand(redisClient *c) {
4682 robj *o;
4683 list *list;
4684 listNode *ln, *next;
4685 int toremove = atoi(c->argv[2]->ptr);
4686 int removed = 0;
4687 int fromtail = 0;
4688
4689 if ((o = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
4690 checkType(c,o,REDIS_LIST)) return;
4691 list = o->ptr;
4692
4693 if (toremove < 0) {
4694 toremove = -toremove;
4695 fromtail = 1;
4696 }
4697 ln = fromtail ? list->tail : list->head;
4698 while (ln) {
4699 robj *ele = listNodeValue(ln);
4700
4701 next = fromtail ? ln->prev : ln->next;
4702 if (compareStringObjects(ele,c->argv[3]) == 0) {
4703 listDelNode(list,ln);
4704 server.dirty++;
4705 removed++;
4706 if (toremove && removed == toremove) break;
4707 }
4708 ln = next;
4709 }
4710 if (listLength(list) == 0) deleteKey(c->db,c->argv[1]);
4711 addReplySds(c,sdscatprintf(sdsempty(),":%d\r\n",removed));
4712 }
4713
4714 /* This is the semantic of this command:
4715 * RPOPLPUSH srclist dstlist:
4716 * IF LLEN(srclist) > 0
4717 * element = RPOP srclist
4718 * LPUSH dstlist element
4719 * RETURN element
4720 * ELSE
4721 * RETURN nil
4722 * END
4723 * END
4724 *
4725 * The idea is to be able to get an element from a list in a reliable way
4726 * since the element is not just returned but pushed against another list
4727 * as well. This command was originally proposed by Ezra Zygmuntowicz.
4728 */
4729 static void rpoplpushcommand(redisClient *c) {
4730 robj *sobj;
4731 list *srclist;
4732 listNode *ln;
4733
4734 if ((sobj = lookupKeyWriteOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
4735 checkType(c,sobj,REDIS_LIST)) return;
4736 srclist = sobj->ptr;
4737 ln = listLast(srclist);
4738
4739 if (ln == NULL) {
4740 addReply(c,shared.nullbulk);
4741 } else {
4742 robj *dobj = lookupKeyWrite(c->db,c->argv[2]);
4743 robj *ele = listNodeValue(ln);
4744 list *dstlist;
4745
4746 if (dobj && dobj->type != REDIS_LIST) {
4747 addReply(c,shared.wrongtypeerr);
4748 return;
4749 }
4750
4751 /* Add the element to the target list (unless it's directly
4752 * passed to some BLPOP-ing client */
4753 if (!handleClientsWaitingListPush(c,c->argv[2],ele)) {
4754 if (dobj == NULL) {
4755 /* Create the list if the key does not exist */
4756 dobj = createListObject();
4757 dictAdd(c->db->dict,c->argv[2],dobj);
4758 incrRefCount(c->argv[2]);
4759 }
4760 dstlist = dobj->ptr;
4761 listAddNodeHead(dstlist,ele);
4762 incrRefCount(ele);
4763 }
4764
4765 /* Send the element to the client as reply as well */
4766 addReplyBulk(c,ele);
4767
4768 /* Finally remove the element from the source list */
4769 listDelNode(srclist,ln);
4770 if (listLength(srclist) == 0) deleteKey(c->db,c->argv[1]);
4771 server.dirty++;
4772 }
4773 }
4774
4775 /* ==================================== Sets ================================ */
4776
4777 static void saddCommand(redisClient *c) {
4778 robj *set;
4779
4780 set = lookupKeyWrite(c->db,c->argv[1]);
4781 if (set == NULL) {
4782 set = createSetObject();
4783 dictAdd(c->db->dict,c->argv[1],set);
4784 incrRefCount(c->argv[1]);
4785 } else {
4786 if (set->type != REDIS_SET) {
4787 addReply(c,shared.wrongtypeerr);
4788 return;
4789 }
4790 }
4791 if (dictAdd(set->ptr,c->argv[2],NULL) == DICT_OK) {
4792 incrRefCount(c->argv[2]);
4793 server.dirty++;
4794 addReply(c,shared.cone);
4795 } else {
4796 addReply(c,shared.czero);
4797 }
4798 }
4799
4800 static void sremCommand(redisClient *c) {
4801 robj *set;
4802
4803 if ((set = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
4804 checkType(c,set,REDIS_SET)) return;
4805
4806 if (dictDelete(set->ptr,c->argv[2]) == DICT_OK) {
4807 server.dirty++;
4808 if (htNeedsResize(set->ptr)) dictResize(set->ptr);
4809 if (dictSize((dict*)set->ptr) == 0) deleteKey(c->db,c->argv[1]);
4810 addReply(c,shared.cone);
4811 } else {
4812 addReply(c,shared.czero);
4813 }
4814 }
4815
4816 static void smoveCommand(redisClient *c) {
4817 robj *srcset, *dstset;
4818
4819 srcset = lookupKeyWrite(c->db,c->argv[1]);
4820 dstset = lookupKeyWrite(c->db,c->argv[2]);
4821
4822 /* If the source key does not exist return 0, if it's of the wrong type
4823 * raise an error */
4824 if (srcset == NULL || srcset->type != REDIS_SET) {
4825 addReply(c, srcset ? shared.wrongtypeerr : shared.czero);
4826 return;
4827 }
4828 /* Error if the destination key is not a set as well */
4829 if (dstset && dstset->type != REDIS_SET) {
4830 addReply(c,shared.wrongtypeerr);
4831 return;
4832 }
4833 /* Remove the element from the source set */
4834 if (dictDelete(srcset->ptr,c->argv[3]) == DICT_ERR) {
4835 /* Key not found in the src set! return zero */
4836 addReply(c,shared.czero);
4837 return;
4838 }
4839 if (dictSize((dict*)srcset->ptr) == 0 && srcset != dstset)
4840 deleteKey(c->db,c->argv[1]);
4841 server.dirty++;
4842 /* Add the element to the destination set */
4843 if (!dstset) {
4844 dstset = createSetObject();
4845 dictAdd(c->db->dict,c->argv[2],dstset);
4846 incrRefCount(c->argv[2]);
4847 }
4848 if (dictAdd(dstset->ptr,c->argv[3],NULL) == DICT_OK)
4849 incrRefCount(c->argv[3]);
4850 addReply(c,shared.cone);
4851 }
4852
4853 static void sismemberCommand(redisClient *c) {
4854 robj *set;
4855
4856 if ((set = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
4857 checkType(c,set,REDIS_SET)) return;
4858
4859 if (dictFind(set->ptr,c->argv[2]))
4860 addReply(c,shared.cone);
4861 else
4862 addReply(c,shared.czero);
4863 }
4864
4865 static void scardCommand(redisClient *c) {
4866 robj *o;
4867 dict *s;
4868
4869 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
4870 checkType(c,o,REDIS_SET)) return;
4871
4872 s = o->ptr;
4873 addReplyUlong(c,dictSize(s));
4874 }
4875
4876 static void spopCommand(redisClient *c) {
4877 robj *set;
4878 dictEntry *de;
4879
4880 if ((set = lookupKeyWriteOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
4881 checkType(c,set,REDIS_SET)) return;
4882
4883 de = dictGetRandomKey(set->ptr);
4884 if (de == NULL) {
4885 addReply(c,shared.nullbulk);
4886 } else {
4887 robj *ele = dictGetEntryKey(de);
4888
4889 addReplyBulk(c,ele);
4890 dictDelete(set->ptr,ele);
4891 if (htNeedsResize(set->ptr)) dictResize(set->ptr);
4892 if (dictSize((dict*)set->ptr) == 0) deleteKey(c->db,c->argv[1]);
4893 server.dirty++;
4894 }
4895 }
4896
4897 static void srandmemberCommand(redisClient *c) {
4898 robj *set;
4899 dictEntry *de;
4900
4901 if ((set = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
4902 checkType(c,set,REDIS_SET)) return;
4903
4904 de = dictGetRandomKey(set->ptr);
4905 if (de == NULL) {
4906 addReply(c,shared.nullbulk);
4907 } else {
4908 robj *ele = dictGetEntryKey(de);
4909
4910 addReplyBulk(c,ele);
4911 }
4912 }
4913
4914 static int qsortCompareSetsByCardinality(const void *s1, const void *s2) {
4915 dict **d1 = (void*) s1, **d2 = (void*) s2;
4916
4917 return dictSize(*d1)-dictSize(*d2);
4918 }
4919
4920 static void sinterGenericCommand(redisClient *c, robj **setskeys, unsigned long setsnum, robj *dstkey) {
4921 dict **dv = zmalloc(sizeof(dict*)*setsnum);
4922 dictIterator *di;
4923 dictEntry *de;
4924 robj *lenobj = NULL, *dstset = NULL;
4925 unsigned long j, cardinality = 0;
4926
4927 for (j = 0; j < setsnum; j++) {
4928 robj *setobj;
4929
4930 setobj = dstkey ?
4931 lookupKeyWrite(c->db,setskeys[j]) :
4932 lookupKeyRead(c->db,setskeys[j]);
4933 if (!setobj) {
4934 zfree(dv);
4935 if (dstkey) {
4936 if (deleteKey(c->db,dstkey))
4937 server.dirty++;
4938 addReply(c,shared.czero);
4939 } else {
4940 addReply(c,shared.emptymultibulk);
4941 }
4942 return;
4943 }
4944 if (setobj->type != REDIS_SET) {
4945 zfree(dv);
4946 addReply(c,shared.wrongtypeerr);
4947 return;
4948 }
4949 dv[j] = setobj->ptr;
4950 }
4951 /* Sort sets from the smallest to largest, this will improve our
4952 * algorithm's performace */
4953 qsort(dv,setsnum,sizeof(dict*),qsortCompareSetsByCardinality);
4954
4955 /* The first thing we should output is the total number of elements...
4956 * since this is a multi-bulk write, but at this stage we don't know
4957 * the intersection set size, so we use a trick, append an empty object
4958 * to the output list and save the pointer to later modify it with the
4959 * right length */
4960 if (!dstkey) {
4961 lenobj = createObject(REDIS_STRING,NULL);
4962 addReply(c,lenobj);
4963 decrRefCount(lenobj);
4964 } else {
4965 /* If we have a target key where to store the resulting set
4966 * create this key with an empty set inside */
4967 dstset = createSetObject();
4968 }
4969
4970 /* Iterate all the elements of the first (smallest) set, and test
4971 * the element against all the other sets, if at least one set does
4972 * not include the element it is discarded */
4973 di = dictGetIterator(dv[0]);
4974
4975 while((de = dictNext(di)) != NULL) {
4976 robj *ele;
4977
4978 for (j = 1; j < setsnum; j++)
4979 if (dictFind(dv[j],dictGetEntryKey(de)) == NULL) break;
4980 if (j != setsnum)
4981 continue; /* at least one set does not contain the member */
4982 ele = dictGetEntryKey(de);
4983 if (!dstkey) {
4984 addReplyBulk(c,ele);
4985 cardinality++;
4986 } else {
4987 dictAdd(dstset->ptr,ele,NULL);
4988 incrRefCount(ele);
4989 }
4990 }
4991 dictReleaseIterator(di);
4992
4993 if (dstkey) {
4994 /* Store the resulting set into the target, if the intersection
4995 * is not an empty set. */
4996 deleteKey(c->db,dstkey);
4997 if (dictSize((dict*)dstset->ptr) > 0) {
4998 dictAdd(c->db->dict,dstkey,dstset);
4999 incrRefCount(dstkey);
5000 addReplyLong(c,dictSize((dict*)dstset->ptr));
5001 } else {
5002 decrRefCount(dstset);
5003 addReply(c,shared.czero);
5004 }
5005 server.dirty++;
5006 } else {
5007 lenobj->ptr = sdscatprintf(sdsempty(),"*%lu\r\n",cardinality);
5008 }
5009 zfree(dv);
5010 }
5011
5012 static void sinterCommand(redisClient *c) {
5013 sinterGenericCommand(c,c->argv+1,c->argc-1,NULL);
5014 }
5015
5016 static void sinterstoreCommand(redisClient *c) {
5017 sinterGenericCommand(c,c->argv+2,c->argc-2,c->argv[1]);
5018 }
5019
5020 #define REDIS_OP_UNION 0
5021 #define REDIS_OP_DIFF 1
5022 #define REDIS_OP_INTER 2
5023
5024 static void sunionDiffGenericCommand(redisClient *c, robj **setskeys, int setsnum, robj *dstkey, int op) {
5025 dict **dv = zmalloc(sizeof(dict*)*setsnum);
5026 dictIterator *di;
5027 dictEntry *de;
5028 robj *dstset = NULL;
5029 int j, cardinality = 0;
5030
5031 for (j = 0; j < setsnum; j++) {
5032 robj *setobj;
5033
5034 setobj = dstkey ?
5035 lookupKeyWrite(c->db,setskeys[j]) :
5036 lookupKeyRead(c->db,setskeys[j]);
5037 if (!setobj) {
5038 dv[j] = NULL;
5039 continue;
5040 }
5041 if (setobj->type != REDIS_SET) {
5042 zfree(dv);
5043 addReply(c,shared.wrongtypeerr);
5044 return;
5045 }
5046 dv[j] = setobj->ptr;
5047 }
5048
5049 /* We need a temp set object to store our union. If the dstkey
5050 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
5051 * this set object will be the resulting object to set into the target key*/
5052 dstset = createSetObject();
5053
5054 /* Iterate all the elements of all the sets, add every element a single
5055 * time to the result set */
5056 for (j = 0; j < setsnum; j++) {
5057 if (op == REDIS_OP_DIFF && j == 0 && !dv[j]) break; /* result set is empty */
5058 if (!dv[j]) continue; /* non existing keys are like empty sets */
5059
5060 di = dictGetIterator(dv[j]);
5061
5062 while((de = dictNext(di)) != NULL) {
5063 robj *ele;
5064
5065 /* dictAdd will not add the same element multiple times */
5066 ele = dictGetEntryKey(de);
5067 if (op == REDIS_OP_UNION || j == 0) {
5068 if (dictAdd(dstset->ptr,ele,NULL) == DICT_OK) {
5069 incrRefCount(ele);
5070 cardinality++;
5071 }
5072 } else if (op == REDIS_OP_DIFF) {
5073 if (dictDelete(dstset->ptr,ele) == DICT_OK) {
5074 cardinality--;
5075 }
5076 }
5077 }
5078 dictReleaseIterator(di);
5079
5080 /* result set is empty? Exit asap. */
5081 if (op == REDIS_OP_DIFF && cardinality == 0) break;
5082 }
5083
5084 /* Output the content of the resulting set, if not in STORE mode */
5085 if (!dstkey) {
5086 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",cardinality));
5087 di = dictGetIterator(dstset->ptr);
5088 while((de = dictNext(di)) != NULL) {
5089 robj *ele;
5090
5091 ele = dictGetEntryKey(de);
5092 addReplyBulk(c,ele);
5093 }
5094 dictReleaseIterator(di);
5095 decrRefCount(dstset);
5096 } else {
5097 /* If we have a target key where to store the resulting set
5098 * create this key with the result set inside */
5099 deleteKey(c->db,dstkey);
5100 if (dictSize((dict*)dstset->ptr) > 0) {
5101 dictAdd(c->db->dict,dstkey,dstset);
5102 incrRefCount(dstkey);
5103 addReplyLong(c,dictSize((dict*)dstset->ptr));
5104 } else {
5105 decrRefCount(dstset);
5106 addReply(c,shared.czero);
5107 }
5108 server.dirty++;
5109 }
5110 zfree(dv);
5111 }
5112
5113 static void sunionCommand(redisClient *c) {
5114 sunionDiffGenericCommand(c,c->argv+1,c->argc-1,NULL,REDIS_OP_UNION);
5115 }
5116
5117 static void sunionstoreCommand(redisClient *c) {
5118 sunionDiffGenericCommand(c,c->argv+2,c->argc-2,c->argv[1],REDIS_OP_UNION);
5119 }
5120
5121 static void sdiffCommand(redisClient *c) {
5122 sunionDiffGenericCommand(c,c->argv+1,c->argc-1,NULL,REDIS_OP_DIFF);
5123 }
5124
5125 static void sdiffstoreCommand(redisClient *c) {
5126 sunionDiffGenericCommand(c,c->argv+2,c->argc-2,c->argv[1],REDIS_OP_DIFF);
5127 }
5128
5129 /* ==================================== ZSets =============================== */
5130
5131 /* ZSETs are ordered sets using two data structures to hold the same elements
5132 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
5133 * data structure.
5134 *
5135 * The elements are added to an hash table mapping Redis objects to scores.
5136 * At the same time the elements are added to a skip list mapping scores
5137 * to Redis objects (so objects are sorted by scores in this "view"). */
5138
5139 /* This skiplist implementation is almost a C translation of the original
5140 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
5141 * Alternative to Balanced Trees", modified in three ways:
5142 * a) this implementation allows for repeated values.
5143 * b) the comparison is not just by key (our 'score') but by satellite data.
5144 * c) there is a back pointer, so it's a doubly linked list with the back
5145 * pointers being only at "level 1". This allows to traverse the list
5146 * from tail to head, useful for ZREVRANGE. */
5147
5148 static zskiplistNode *zslCreateNode(int level, double score, robj *obj) {
5149 zskiplistNode *zn = zmalloc(sizeof(*zn));
5150
5151 zn->forward = zmalloc(sizeof(zskiplistNode*) * level);
5152 if (level > 0)
5153 zn->span = zmalloc(sizeof(unsigned int) * (level - 1));
5154 zn->score = score;
5155 zn->obj = obj;
5156 return zn;
5157 }
5158
5159 static zskiplist *zslCreate(void) {
5160 int j;
5161 zskiplist *zsl;
5162
5163 zsl = zmalloc(sizeof(*zsl));
5164 zsl->level = 1;
5165 zsl->length = 0;
5166 zsl->header = zslCreateNode(ZSKIPLIST_MAXLEVEL,0,NULL);
5167 for (j = 0; j < ZSKIPLIST_MAXLEVEL; j++) {
5168 zsl->header->forward[j] = NULL;
5169
5170 /* span has space for ZSKIPLIST_MAXLEVEL-1 elements */
5171 if (j < ZSKIPLIST_MAXLEVEL-1)
5172 zsl->header->span[j] = 0;
5173 }
5174 zsl->header->backward = NULL;
5175 zsl->tail = NULL;
5176 return zsl;
5177 }
5178
5179 static void zslFreeNode(zskiplistNode *node) {
5180 decrRefCount(node->obj);
5181 zfree(node->forward);
5182 zfree(node->span);
5183 zfree(node);
5184 }
5185
5186 static void zslFree(zskiplist *zsl) {
5187 zskiplistNode *node = zsl->header->forward[0], *next;
5188
5189 zfree(zsl->header->forward);
5190 zfree(zsl->header->span);
5191 zfree(zsl->header);
5192 while(node) {
5193 next = node->forward[0];
5194 zslFreeNode(node);
5195 node = next;
5196 }
5197 zfree(zsl);
5198 }
5199
5200 static int zslRandomLevel(void) {
5201 int level = 1;
5202 while ((random()&0xFFFF) < (ZSKIPLIST_P * 0xFFFF))
5203 level += 1;
5204 return (level<ZSKIPLIST_MAXLEVEL) ? level : ZSKIPLIST_MAXLEVEL;
5205 }
5206
5207 static void zslInsert(zskiplist *zsl, double score, robj *obj) {
5208 zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;
5209 unsigned int rank[ZSKIPLIST_MAXLEVEL];
5210 int i, level;
5211
5212 x = zsl->header;
5213 for (i = zsl->level-1; i >= 0; i--) {
5214 /* store rank that is crossed to reach the insert position */
5215 rank[i] = i == (zsl->level-1) ? 0 : rank[i+1];
5216
5217 while (x->forward[i] &&
5218 (x->forward[i]->score < score ||
5219 (x->forward[i]->score == score &&
5220 compareStringObjects(x->forward[i]->obj,obj) < 0))) {
5221 rank[i] += i > 0 ? x->span[i-1] : 1;
5222 x = x->forward[i];
5223 }
5224 update[i] = x;
5225 }
5226 /* we assume the key is not already inside, since we allow duplicated
5227 * scores, and the re-insertion of score and redis object should never
5228 * happpen since the caller of zslInsert() should test in the hash table
5229 * if the element is already inside or not. */
5230 level = zslRandomLevel();
5231 if (level > zsl->level) {
5232 for (i = zsl->level; i < level; i++) {
5233 rank[i] = 0;
5234 update[i] = zsl->header;
5235 update[i]->span[i-1] = zsl->length;
5236 }
5237 zsl->level = level;
5238 }
5239 x = zslCreateNode(level,score,obj);
5240 for (i = 0; i < level; i++) {
5241 x->forward[i] = update[i]->forward[i];
5242 update[i]->forward[i] = x;
5243
5244 /* update span covered by update[i] as x is inserted here */
5245 if (i > 0) {
5246 x->span[i-1] = update[i]->span[i-1] - (rank[0] - rank[i]);
5247 update[i]->span[i-1] = (rank[0] - rank[i]) + 1;
5248 }
5249 }
5250
5251 /* increment span for untouched levels */
5252 for (i = level; i < zsl->level; i++) {
5253 update[i]->span[i-1]++;
5254 }
5255
5256 x->backward = (update[0] == zsl->header) ? NULL : update[0];
5257 if (x->forward[0])
5258 x->forward[0]->backward = x;
5259 else
5260 zsl->tail = x;
5261 zsl->length++;
5262 }
5263
5264 /* Internal function used by zslDelete, zslDeleteByScore and zslDeleteByRank */
5265 void zslDeleteNode(zskiplist *zsl, zskiplistNode *x, zskiplistNode **update) {
5266 int i;
5267 for (i = 0; i < zsl->level; i++) {
5268 if (update[i]->forward[i] == x) {
5269 if (i > 0) {
5270 update[i]->span[i-1] += x->span[i-1] - 1;
5271 }
5272 update[i]->forward[i] = x->forward[i];
5273 } else {
5274 /* invariant: i > 0, because update[0]->forward[0]
5275 * is always equal to x */
5276 update[i]->span[i-1] -= 1;
5277 }
5278 }
5279 if (x->forward[0]) {
5280 x->forward[0]->backward = x->backward;
5281 } else {
5282 zsl->tail = x->backward;
5283 }
5284 while(zsl->level > 1 && zsl->header->forward[zsl->level-1] == NULL)
5285 zsl->level--;
5286 zsl->length--;
5287 }
5288
5289 /* Delete an element with matching score/object from the skiplist. */
5290 static int zslDelete(zskiplist *zsl, double score, robj *obj) {
5291 zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;
5292 int i;
5293
5294 x = zsl->header;
5295 for (i = zsl->level-1; i >= 0; i--) {
5296 while (x->forward[i] &&
5297 (x->forward[i]->score < score ||
5298 (x->forward[i]->score == score &&
5299 compareStringObjects(x->forward[i]->obj,obj) < 0)))
5300 x = x->forward[i];
5301 update[i] = x;
5302 }
5303 /* We may have multiple elements with the same score, what we need
5304 * is to find the element with both the right score and object. */
5305 x = x->forward[0];
5306 if (x && score == x->score && compareStringObjects(x->obj,obj) == 0) {
5307 zslDeleteNode(zsl, x, update);
5308 zslFreeNode(x);
5309 return 1;
5310 } else {
5311 return 0; /* not found */
5312 }
5313 return 0; /* not found */
5314 }
5315
5316 /* Delete all the elements with score between min and max from the skiplist.
5317 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
5318 * Note that this function takes the reference to the hash table view of the
5319 * sorted set, in order to remove the elements from the hash table too. */
5320 static unsigned long zslDeleteRangeByScore(zskiplist *zsl, double min, double max, dict *dict) {
5321 zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;
5322 unsigned long removed = 0;
5323 int i;
5324
5325 x = zsl->header;
5326 for (i = zsl->level-1; i >= 0; i--) {
5327 while (x->forward[i] && x->forward[i]->score < min)
5328 x = x->forward[i];
5329 update[i] = x;
5330 }
5331 /* We may have multiple elements with the same score, what we need
5332 * is to find the element with both the right score and object. */
5333 x = x->forward[0];
5334 while (x && x->score <= max) {
5335 zskiplistNode *next = x->forward[0];
5336 zslDeleteNode(zsl, x, update);
5337 dictDelete(dict,x->obj);
5338 zslFreeNode(x);
5339 removed++;
5340 x = next;
5341 }
5342 return removed; /* not found */
5343 }
5344
5345 /* Delete all the elements with rank between start and end from the skiplist.
5346 * Start and end are inclusive. Note that start and end need to be 1-based */
5347 static unsigned long zslDeleteRangeByRank(zskiplist *zsl, unsigned int start, unsigned int end, dict *dict) {
5348 zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;
5349 unsigned long traversed = 0, removed = 0;
5350 int i;
5351
5352 x = zsl->header;
5353 for (i = zsl->level-1; i >= 0; i--) {
5354 while (x->forward[i] && (traversed + (i > 0 ? x->span[i-1] : 1)) < start) {
5355 traversed += i > 0 ? x->span[i-1] : 1;
5356 x = x->forward[i];
5357 }
5358 update[i] = x;
5359 }
5360
5361 traversed++;
5362 x = x->forward[0];
5363 while (x && traversed <= end) {
5364 zskiplistNode *next = x->forward[0];
5365 zslDeleteNode(zsl, x, update);
5366 dictDelete(dict,x->obj);
5367 zslFreeNode(x);
5368 removed++;
5369 traversed++;
5370 x = next;
5371 }
5372 return removed;
5373 }
5374
5375 /* Find the first node having a score equal or greater than the specified one.
5376 * Returns NULL if there is no match. */
5377 static zskiplistNode *zslFirstWithScore(zskiplist *zsl, double score) {
5378 zskiplistNode *x;
5379 int i;
5380
5381 x = zsl->header;
5382 for (i = zsl->level-1; i >= 0; i--) {
5383 while (x->forward[i] && x->forward[i]->score < score)
5384 x = x->forward[i];
5385 }
5386 /* We may have multiple elements with the same score, what we need
5387 * is to find the element with both the right score and object. */
5388 return x->forward[0];
5389 }
5390
5391 /* Find the rank for an element by both score and key.
5392 * Returns 0 when the element cannot be found, rank otherwise.
5393 * Note that the rank is 1-based due to the span of zsl->header to the
5394 * first element. */
5395 static unsigned long zslGetRank(zskiplist *zsl, double score, robj *o) {
5396 zskiplistNode *x;
5397 unsigned long rank = 0;
5398 int i;
5399
5400 x = zsl->header;
5401 for (i = zsl->level-1; i >= 0; i--) {
5402 while (x->forward[i] &&
5403 (x->forward[i]->score < score ||
5404 (x->forward[i]->score == score &&
5405 compareStringObjects(x->forward[i]->obj,o) <= 0))) {
5406 rank += i > 0 ? x->span[i-1] : 1;
5407 x = x->forward[i];
5408 }
5409
5410 /* x might be equal to zsl->header, so test if obj is non-NULL */
5411 if (x->obj && compareStringObjects(x->obj,o) == 0) {
5412 return rank;
5413 }
5414 }
5415 return 0;
5416 }
5417
5418 /* Finds an element by its rank. The rank argument needs to be 1-based. */
5419 zskiplistNode* zslGetElementByRank(zskiplist *zsl, unsigned long rank) {
5420 zskiplistNode *x;
5421 unsigned long traversed = 0;
5422 int i;
5423
5424 x = zsl->header;
5425 for (i = zsl->level-1; i >= 0; i--) {
5426 while (x->forward[i] && (traversed + (i>0 ? x->span[i-1] : 1)) <= rank)
5427 {
5428 traversed += i > 0 ? x->span[i-1] : 1;
5429 x = x->forward[i];
5430 }
5431 if (traversed == rank) {
5432 return x;
5433 }
5434 }
5435 return NULL;
5436 }
5437
5438 /* The actual Z-commands implementations */
5439
5440 /* This generic command implements both ZADD and ZINCRBY.
5441 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
5442 * the increment if the operation is a ZINCRBY (doincrement == 1). */
5443 static void zaddGenericCommand(redisClient *c, robj *key, robj *ele, double scoreval, int doincrement) {
5444 robj *zsetobj;
5445 zset *zs;
5446 double *score;
5447
5448 zsetobj = lookupKeyWrite(c->db,key);
5449 if (zsetobj == NULL) {
5450 zsetobj = createZsetObject();
5451 dictAdd(c->db->dict,key,zsetobj);
5452 incrRefCount(key);
5453 } else {
5454 if (zsetobj->type != REDIS_ZSET) {
5455 addReply(c,shared.wrongtypeerr);
5456 return;
5457 }
5458 }
5459 zs = zsetobj->ptr;
5460
5461 /* Ok now since we implement both ZADD and ZINCRBY here the code
5462 * needs to handle the two different conditions. It's all about setting
5463 * '*score', that is, the new score to set, to the right value. */
5464 score = zmalloc(sizeof(double));
5465 if (doincrement) {
5466 dictEntry *de;
5467
5468 /* Read the old score. If the element was not present starts from 0 */
5469 de = dictFind(zs->dict,ele);
5470 if (de) {
5471 double *oldscore = dictGetEntryVal(de);
5472 *score = *oldscore + scoreval;
5473 } else {
5474 *score = scoreval;
5475 }
5476 } else {
5477 *score = scoreval;
5478 }
5479
5480 /* What follows is a simple remove and re-insert operation that is common
5481 * to both ZADD and ZINCRBY... */
5482 if (dictAdd(zs->dict,ele,score) == DICT_OK) {
5483 /* case 1: New element */
5484 incrRefCount(ele); /* added to hash */
5485 zslInsert(zs->zsl,*score,ele);
5486 incrRefCount(ele); /* added to skiplist */
5487 server.dirty++;
5488 if (doincrement)
5489 addReplyDouble(c,*score);
5490 else
5491 addReply(c,shared.cone);
5492 } else {
5493 dictEntry *de;
5494 double *oldscore;
5495
5496 /* case 2: Score update operation */
5497 de = dictFind(zs->dict,ele);
5498 redisAssert(de != NULL);
5499 oldscore = dictGetEntryVal(de);
5500 if (*score != *oldscore) {
5501 int deleted;
5502
5503 /* Remove and insert the element in the skip list with new score */
5504 deleted = zslDelete(zs->zsl,*oldscore,ele);
5505 redisAssert(deleted != 0);
5506 zslInsert(zs->zsl,*score,ele);
5507 incrRefCount(ele);
5508 /* Update the score in the hash table */
5509 dictReplace(zs->dict,ele,score);
5510 server.dirty++;
5511 } else {
5512 zfree(score);
5513 }
5514 if (doincrement)
5515 addReplyDouble(c,*score);
5516 else
5517 addReply(c,shared.czero);
5518 }
5519 }
5520
5521 static void zaddCommand(redisClient *c) {
5522 double scoreval;
5523
5524 if (getDoubleFromObjectOrReply(c, c->argv[2], &scoreval, NULL) != REDIS_OK) return;
5525 zaddGenericCommand(c,c->argv[1],c->argv[3],scoreval,0);
5526 }
5527
5528 static void zincrbyCommand(redisClient *c) {
5529 double scoreval;
5530
5531 if (getDoubleFromObjectOrReply(c, c->argv[2], &scoreval, NULL) != REDIS_OK) return;
5532 zaddGenericCommand(c,c->argv[1],c->argv[3],scoreval,1);
5533 }
5534
5535 static void zremCommand(redisClient *c) {
5536 robj *zsetobj;
5537 zset *zs;
5538 dictEntry *de;
5539 double *oldscore;
5540 int deleted;
5541
5542 if ((zsetobj = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
5543 checkType(c,zsetobj,REDIS_ZSET)) return;
5544
5545 zs = zsetobj->ptr;
5546 de = dictFind(zs->dict,c->argv[2]);
5547 if (de == NULL) {
5548 addReply(c,shared.czero);
5549 return;
5550 }
5551 /* Delete from the skiplist */
5552 oldscore = dictGetEntryVal(de);
5553 deleted = zslDelete(zs->zsl,*oldscore,c->argv[2]);
5554 redisAssert(deleted != 0);
5555
5556 /* Delete from the hash table */
5557 dictDelete(zs->dict,c->argv[2]);
5558 if (htNeedsResize(zs->dict)) dictResize(zs->dict);
5559 if (dictSize(zs->dict) == 0) deleteKey(c->db,c->argv[1]);
5560 server.dirty++;
5561 addReply(c,shared.cone);
5562 }
5563
5564 static void zremrangebyscoreCommand(redisClient *c) {
5565 double min;
5566 double max;
5567 long deleted;
5568 robj *zsetobj;
5569 zset *zs;
5570
5571 if ((getDoubleFromObjectOrReply(c, c->argv[2], &min, NULL) != REDIS_OK) ||
5572 (getDoubleFromObjectOrReply(c, c->argv[3], &max, NULL) != REDIS_OK)) return;
5573
5574 if ((zsetobj = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
5575 checkType(c,zsetobj,REDIS_ZSET)) return;
5576
5577 zs = zsetobj->ptr;
5578 deleted = zslDeleteRangeByScore(zs->zsl,min,max,zs->dict);
5579 if (htNeedsResize(zs->dict)) dictResize(zs->dict);
5580 if (dictSize(zs->dict) == 0) deleteKey(c->db,c->argv[1]);
5581 server.dirty += deleted;
5582 addReplyLong(c,deleted);
5583 }
5584
5585 static void zremrangebyrankCommand(redisClient *c) {
5586 long start;
5587 long end;
5588 int llen;
5589 long deleted;
5590 robj *zsetobj;
5591 zset *zs;
5592
5593 if ((getLongFromObjectOrReply(c, c->argv[2], &start, NULL) != REDIS_OK) ||
5594 (getLongFromObjectOrReply(c, c->argv[3], &end, NULL) != REDIS_OK)) return;
5595
5596 if ((zsetobj = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
5597 checkType(c,zsetobj,REDIS_ZSET)) return;
5598 zs = zsetobj->ptr;
5599 llen = zs->zsl->length;
5600
5601 /* convert negative indexes */
5602 if (start < 0) start = llen+start;
5603 if (end < 0) end = llen+end;
5604 if (start < 0) start = 0;
5605 if (end < 0) end = 0;
5606
5607 /* indexes sanity checks */
5608 if (start > end || start >= llen) {
5609 addReply(c,shared.czero);
5610 return;
5611 }
5612 if (end >= llen) end = llen-1;
5613
5614 /* increment start and end because zsl*Rank functions
5615 * use 1-based rank */
5616 deleted = zslDeleteRangeByRank(zs->zsl,start+1,end+1,zs->dict);
5617 if (htNeedsResize(zs->dict)) dictResize(zs->dict);
5618 if (dictSize(zs->dict) == 0) deleteKey(c->db,c->argv[1]);
5619 server.dirty += deleted;
5620 addReplyLong(c, deleted);
5621 }
5622
5623 typedef struct {
5624 dict *dict;
5625 double weight;
5626 } zsetopsrc;
5627
5628 static int qsortCompareZsetopsrcByCardinality(const void *s1, const void *s2) {
5629 zsetopsrc *d1 = (void*) s1, *d2 = (void*) s2;
5630 unsigned long size1, size2;
5631 size1 = d1->dict ? dictSize(d1->dict) : 0;
5632 size2 = d2->dict ? dictSize(d2->dict) : 0;
5633 return size1 - size2;
5634 }
5635
5636 #define REDIS_AGGR_SUM 1
5637 #define REDIS_AGGR_MIN 2
5638 #define REDIS_AGGR_MAX 3
5639
5640 inline static void zunionInterAggregate(double *target, double val, int aggregate) {
5641 if (aggregate == REDIS_AGGR_SUM) {
5642 *target = *target + val;
5643 } else if (aggregate == REDIS_AGGR_MIN) {
5644 *target = val < *target ? val : *target;
5645 } else if (aggregate == REDIS_AGGR_MAX) {
5646 *target = val > *target ? val : *target;
5647 } else {
5648 /* safety net */
5649 redisPanic("Unknown ZUNION/INTER aggregate type");
5650 }
5651 }
5652
5653 static void zunionInterGenericCommand(redisClient *c, robj *dstkey, int op) {
5654 int i, j, zsetnum;
5655 int aggregate = REDIS_AGGR_SUM;
5656 zsetopsrc *src;
5657 robj *dstobj;
5658 zset *dstzset;
5659 dictIterator *di;
5660 dictEntry *de;
5661
5662 /* expect zsetnum input keys to be given */
5663 zsetnum = atoi(c->argv[2]->ptr);
5664 if (zsetnum < 1) {
5665 addReplySds(c,sdsnew("-ERR at least 1 input key is needed for ZUNION/ZINTER\r\n"));
5666 return;
5667 }
5668
5669 /* test if the expected number of keys would overflow */
5670 if (3+zsetnum > c->argc) {
5671 addReply(c,shared.syntaxerr);
5672 return;
5673 }
5674
5675 /* read keys to be used for input */
5676 src = zmalloc(sizeof(zsetopsrc) * zsetnum);
5677 for (i = 0, j = 3; i < zsetnum; i++, j++) {
5678 robj *zsetobj = lookupKeyWrite(c->db,c->argv[j]);
5679 if (!zsetobj) {
5680 src[i].dict = NULL;
5681 } else {
5682 if (zsetobj->type != REDIS_ZSET) {
5683 zfree(src);
5684 addReply(c,shared.wrongtypeerr);
5685 return;
5686 }
5687 src[i].dict = ((zset*)zsetobj->ptr)->dict;
5688 }
5689
5690 /* default all weights to 1 */
5691 src[i].weight = 1.0;
5692 }
5693
5694 /* parse optional extra arguments */
5695 if (j < c->argc) {
5696 int remaining = c->argc - j;
5697
5698 while (remaining) {
5699 if (remaining >= (zsetnum + 1) && !strcasecmp(c->argv[j]->ptr,"weights")) {
5700 j++; remaining--;
5701 for (i = 0; i < zsetnum; i++, j++, remaining--) {
5702 if (getDoubleFromObjectOrReply(c, c->argv[j], &src[i].weight, NULL) != REDIS_OK)
5703 return;
5704 }
5705 } else if (remaining >= 2 && !strcasecmp(c->argv[j]->ptr,"aggregate")) {
5706 j++; remaining--;
5707 if (!strcasecmp(c->argv[j]->ptr,"sum")) {
5708 aggregate = REDIS_AGGR_SUM;
5709 } else if (!strcasecmp(c->argv[j]->ptr,"min")) {
5710 aggregate = REDIS_AGGR_MIN;
5711 } else if (!strcasecmp(c->argv[j]->ptr,"max")) {
5712 aggregate = REDIS_AGGR_MAX;
5713 } else {
5714 zfree(src);
5715 addReply(c,shared.syntaxerr);
5716 return;
5717 }
5718 j++; remaining--;
5719 } else {
5720 zfree(src);
5721 addReply(c,shared.syntaxerr);
5722 return;
5723 }
5724 }
5725 }
5726
5727 /* sort sets from the smallest to largest, this will improve our
5728 * algorithm's performance */
5729 qsort(src,zsetnum,sizeof(zsetopsrc), qsortCompareZsetopsrcByCardinality);
5730
5731 dstobj = createZsetObject();
5732 dstzset = dstobj->ptr;
5733
5734 if (op == REDIS_OP_INTER) {
5735 /* skip going over all entries if the smallest zset is NULL or empty */
5736 if (src[0].dict && dictSize(src[0].dict) > 0) {
5737 /* precondition: as src[0].dict is non-empty and the zsets are ordered
5738 * from small to large, all src[i > 0].dict are non-empty too */
5739 di = dictGetIterator(src[0].dict);
5740 while((de = dictNext(di)) != NULL) {
5741 double *score = zmalloc(sizeof(double)), value;
5742 *score = src[0].weight * (*(double*)dictGetEntryVal(de));
5743
5744 for (j = 1; j < zsetnum; j++) {
5745 dictEntry *other = dictFind(src[j].dict,dictGetEntryKey(de));
5746 if (other) {
5747 value = src[j].weight * (*(double*)dictGetEntryVal(other));
5748 zunionInterAggregate(score, value, aggregate);
5749 } else {
5750 break;
5751 }
5752 }
5753
5754 /* skip entry when not present in every source dict */
5755 if (j != zsetnum) {
5756 zfree(score);
5757 } else {
5758 robj *o = dictGetEntryKey(de);
5759 dictAdd(dstzset->dict,o,score);
5760 incrRefCount(o); /* added to dictionary */
5761 zslInsert(dstzset->zsl,*score,o);
5762 incrRefCount(o); /* added to skiplist */
5763 }
5764 }
5765 dictReleaseIterator(di);
5766 }
5767 } else if (op == REDIS_OP_UNION) {
5768 for (i = 0; i < zsetnum; i++) {
5769 if (!src[i].dict) continue;
5770
5771 di = dictGetIterator(src[i].dict);
5772 while((de = dictNext(di)) != NULL) {
5773 /* skip key when already processed */
5774 if (dictFind(dstzset->dict,dictGetEntryKey(de)) != NULL) continue;
5775
5776 double *score = zmalloc(sizeof(double)), value;
5777 *score = src[i].weight * (*(double*)dictGetEntryVal(de));
5778
5779 /* because the zsets are sorted by size, its only possible
5780 * for sets at larger indices to hold this entry */
5781 for (j = (i+1); j < zsetnum; j++) {
5782 dictEntry *other = dictFind(src[j].dict,dictGetEntryKey(de));
5783 if (other) {
5784 value = src[j].weight * (*(double*)dictGetEntryVal(other));
5785 zunionInterAggregate(score, value, aggregate);
5786 }
5787 }
5788
5789 robj *o = dictGetEntryKey(de);
5790 dictAdd(dstzset->dict,o,score);
5791 incrRefCount(o); /* added to dictionary */
5792 zslInsert(dstzset->zsl,*score,o);
5793 incrRefCount(o); /* added to skiplist */
5794 }
5795 dictReleaseIterator(di);
5796 }
5797 } else {
5798 /* unknown operator */
5799 redisAssert(op == REDIS_OP_INTER || op == REDIS_OP_UNION);
5800 }
5801
5802 deleteKey(c->db,dstkey);
5803 if (dstzset->zsl->length) {
5804 dictAdd(c->db->dict,dstkey,dstobj);
5805 incrRefCount(dstkey);
5806 addReplyLong(c, dstzset->zsl->length);
5807 server.dirty++;
5808 } else {
5809 decrRefCount(dstobj);
5810 addReply(c, shared.czero);
5811 }
5812 zfree(src);
5813 }
5814
5815 static void zunionCommand(redisClient *c) {
5816 zunionInterGenericCommand(c,c->argv[1], REDIS_OP_UNION);
5817 }
5818
5819 static void zinterCommand(redisClient *c) {
5820 zunionInterGenericCommand(c,c->argv[1], REDIS_OP_INTER);
5821 }
5822
5823 static void zrangeGenericCommand(redisClient *c, int reverse) {
5824 robj *o;
5825 long start;
5826 long end;
5827 int withscores = 0;
5828 int llen;
5829 int rangelen, j;
5830 zset *zsetobj;
5831 zskiplist *zsl;
5832 zskiplistNode *ln;
5833 robj *ele;
5834
5835 if ((getLongFromObjectOrReply(c, c->argv[2], &start, NULL) != REDIS_OK) ||
5836 (getLongFromObjectOrReply(c, c->argv[3], &end, NULL) != REDIS_OK)) return;
5837
5838 if (c->argc == 5 && !strcasecmp(c->argv[4]->ptr,"withscores")) {
5839 withscores = 1;
5840 } else if (c->argc >= 5) {
5841 addReply(c,shared.syntaxerr);
5842 return;
5843 }
5844
5845 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.emptymultibulk)) == NULL
5846 || checkType(c,o,REDIS_ZSET)) return;
5847 zsetobj = o->ptr;
5848 zsl = zsetobj->zsl;
5849 llen = zsl->length;
5850
5851 /* convert negative indexes */
5852 if (start < 0) start = llen+start;
5853 if (end < 0) end = llen+end;
5854 if (start < 0) start = 0;
5855 if (end < 0) end = 0;
5856
5857 /* indexes sanity checks */
5858 if (start > end || start >= llen) {
5859 /* Out of range start or start > end result in empty list */
5860 addReply(c,shared.emptymultibulk);
5861 return;
5862 }
5863 if (end >= llen) end = llen-1;
5864 rangelen = (end-start)+1;
5865
5866 /* check if starting point is trivial, before searching
5867 * the element in log(N) time */
5868 if (reverse) {
5869 ln = start == 0 ? zsl->tail : zslGetElementByRank(zsl, llen-start);
5870 } else {
5871 ln = start == 0 ?
5872 zsl->header->forward[0] : zslGetElementByRank(zsl, start+1);
5873 }
5874
5875 /* Return the result in form of a multi-bulk reply */
5876 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",
5877 withscores ? (rangelen*2) : rangelen));
5878 for (j = 0; j < rangelen; j++) {
5879 ele = ln->obj;
5880 addReplyBulk(c,ele);
5881 if (withscores)
5882 addReplyDouble(c,ln->score);
5883 ln = reverse ? ln->backward : ln->forward[0];
5884 }
5885 }
5886
5887 static void zrangeCommand(redisClient *c) {
5888 zrangeGenericCommand(c,0);
5889 }
5890
5891 static void zrevrangeCommand(redisClient *c) {
5892 zrangeGenericCommand(c,1);
5893 }
5894
5895 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
5896 * If justcount is non-zero, just the count is returned. */
5897 static void genericZrangebyscoreCommand(redisClient *c, int justcount) {
5898 robj *o;
5899 double min, max;
5900 int minex = 0, maxex = 0; /* are min or max exclusive? */
5901 int offset = 0, limit = -1;
5902 int withscores = 0;
5903 int badsyntax = 0;
5904
5905 /* Parse the min-max interval. If one of the values is prefixed
5906 * by the "(" character, it's considered "open". For instance
5907 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
5908 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
5909 if (((char*)c->argv[2]->ptr)[0] == '(') {
5910 min = strtod((char*)c->argv[2]->ptr+1,NULL);
5911 minex = 1;
5912 } else {
5913 min = strtod(c->argv[2]->ptr,NULL);
5914 }
5915 if (((char*)c->argv[3]->ptr)[0] == '(') {
5916 max = strtod((char*)c->argv[3]->ptr+1,NULL);
5917 maxex = 1;
5918 } else {
5919 max = strtod(c->argv[3]->ptr,NULL);
5920 }
5921
5922 /* Parse "WITHSCORES": note that if the command was called with
5923 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
5924 * enter the following paths to parse WITHSCORES and LIMIT. */
5925 if (c->argc == 5 || c->argc == 8) {
5926 if (strcasecmp(c->argv[c->argc-1]->ptr,"withscores") == 0)
5927 withscores = 1;
5928 else
5929 badsyntax = 1;
5930 }
5931 if (c->argc != (4 + withscores) && c->argc != (7 + withscores))
5932 badsyntax = 1;
5933 if (badsyntax) {
5934 addReplySds(c,
5935 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
5936 return;
5937 }
5938
5939 /* Parse "LIMIT" */
5940 if (c->argc == (7 + withscores) && strcasecmp(c->argv[4]->ptr,"limit")) {
5941 addReply(c,shared.syntaxerr);
5942 return;
5943 } else if (c->argc == (7 + withscores)) {
5944 offset = atoi(c->argv[5]->ptr);
5945 limit = atoi(c->argv[6]->ptr);
5946 if (offset < 0) offset = 0;
5947 }
5948
5949 /* Ok, lookup the key and get the range */
5950 o = lookupKeyRead(c->db,c->argv[1]);
5951 if (o == NULL) {
5952 addReply(c,justcount ? shared.czero : shared.emptymultibulk);
5953 } else {
5954 if (o->type != REDIS_ZSET) {
5955 addReply(c,shared.wrongtypeerr);
5956 } else {
5957 zset *zsetobj = o->ptr;
5958 zskiplist *zsl = zsetobj->zsl;
5959 zskiplistNode *ln;
5960 robj *ele, *lenobj = NULL;
5961 unsigned long rangelen = 0;
5962
5963 /* Get the first node with the score >= min, or with
5964 * score > min if 'minex' is true. */
5965 ln = zslFirstWithScore(zsl,min);
5966 while (minex && ln && ln->score == min) ln = ln->forward[0];
5967
5968 if (ln == NULL) {
5969 /* No element matching the speciifed interval */
5970 addReply(c,justcount ? shared.czero : shared.emptymultibulk);
5971 return;
5972 }
5973
5974 /* We don't know in advance how many matching elements there
5975 * are in the list, so we push this object that will represent
5976 * the multi-bulk length in the output buffer, and will "fix"
5977 * it later */
5978 if (!justcount) {
5979 lenobj = createObject(REDIS_STRING,NULL);
5980 addReply(c,lenobj);
5981 decrRefCount(lenobj);
5982 }
5983
5984 while(ln && (maxex ? (ln->score < max) : (ln->score <= max))) {
5985 if (offset) {
5986 offset--;
5987 ln = ln->forward[0];
5988 continue;
5989 }
5990 if (limit == 0) break;
5991 if (!justcount) {
5992 ele = ln->obj;
5993 addReplyBulk(c,ele);
5994 if (withscores)
5995 addReplyDouble(c,ln->score);
5996 }
5997 ln = ln->forward[0];
5998 rangelen++;
5999 if (limit > 0) limit--;
6000 }
6001 if (justcount) {
6002 addReplyLong(c,(long)rangelen);
6003 } else {
6004 lenobj->ptr = sdscatprintf(sdsempty(),"*%lu\r\n",
6005 withscores ? (rangelen*2) : rangelen);
6006 }
6007 }
6008 }
6009 }
6010
6011 static void zrangebyscoreCommand(redisClient *c) {
6012 genericZrangebyscoreCommand(c,0);
6013 }
6014
6015 static void zcountCommand(redisClient *c) {
6016 genericZrangebyscoreCommand(c,1);
6017 }
6018
6019 static void zcardCommand(redisClient *c) {
6020 robj *o;
6021 zset *zs;
6022
6023 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
6024 checkType(c,o,REDIS_ZSET)) return;
6025
6026 zs = o->ptr;
6027 addReplyUlong(c,zs->zsl->length);
6028 }
6029
6030 static void zscoreCommand(redisClient *c) {
6031 robj *o;
6032 zset *zs;
6033 dictEntry *de;
6034
6035 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
6036 checkType(c,o,REDIS_ZSET)) return;
6037
6038 zs = o->ptr;
6039 de = dictFind(zs->dict,c->argv[2]);
6040 if (!de) {
6041 addReply(c,shared.nullbulk);
6042 } else {
6043 double *score = dictGetEntryVal(de);
6044
6045 addReplyDouble(c,*score);
6046 }
6047 }
6048
6049 static void zrankGenericCommand(redisClient *c, int reverse) {
6050 robj *o;
6051 zset *zs;
6052 zskiplist *zsl;
6053 dictEntry *de;
6054 unsigned long rank;
6055 double *score;
6056
6057 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
6058 checkType(c,o,REDIS_ZSET)) return;
6059
6060 zs = o->ptr;
6061 zsl = zs->zsl;
6062 de = dictFind(zs->dict,c->argv[2]);
6063 if (!de) {
6064 addReply(c,shared.nullbulk);
6065 return;
6066 }
6067
6068 score = dictGetEntryVal(de);
6069 rank = zslGetRank(zsl, *score, c->argv[2]);
6070 if (rank) {
6071 if (reverse) {
6072 addReplyLong(c, zsl->length - rank);
6073 } else {
6074 addReplyLong(c, rank-1);
6075 }
6076 } else {
6077 addReply(c,shared.nullbulk);
6078 }
6079 }
6080
6081 static void zrankCommand(redisClient *c) {
6082 zrankGenericCommand(c, 0);
6083 }
6084
6085 static void zrevrankCommand(redisClient *c) {
6086 zrankGenericCommand(c, 1);
6087 }
6088
6089 /* ========================= Hashes utility functions ======================= */
6090 #define REDIS_HASH_KEY 1
6091 #define REDIS_HASH_VALUE 2
6092
6093 /* Check the length of a number of objects to see if we need to convert a
6094 * zipmap to a real hash. Note that we only check string encoded objects
6095 * as their string length can be queried in constant time. */
6096 static void hashTryConversion(robj *subject, robj **argv, int start, int end) {
6097 int i;
6098 if (subject->encoding != REDIS_ENCODING_ZIPMAP) return;
6099
6100 for (i = start; i <= end; i++) {
6101 if (argv[i]->encoding == REDIS_ENCODING_RAW &&
6102 sdslen(argv[i]->ptr) > server.hash_max_zipmap_value)
6103 {
6104 convertToRealHash(subject);
6105 return;
6106 }
6107 }
6108 }
6109
6110 /* Encode given objects in-place when the hash uses a dict. */
6111 static void hashTryObjectEncoding(robj *subject, robj **o1, robj **o2) {
6112 if (subject->encoding == REDIS_ENCODING_HT) {
6113 if (o1) *o1 = tryObjectEncoding(*o1);
6114 if (o2) *o2 = tryObjectEncoding(*o2);
6115 }
6116 }
6117
6118 /* Get the value from a hash identified by key. Returns either a string
6119 * object or NULL if the value cannot be found. The refcount of the object
6120 * is always increased by 1 when the value was found. */
6121 static robj *hashGet(robj *o, robj *key) {
6122 robj *value = NULL;
6123 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
6124 unsigned char *v;
6125 unsigned int vlen;
6126 key = getDecodedObject(key);
6127 if (zipmapGet(o->ptr,key->ptr,sdslen(key->ptr),&v,&vlen)) {
6128 value = createStringObject((char*)v,vlen);
6129 }
6130 decrRefCount(key);
6131 } else {
6132 dictEntry *de = dictFind(o->ptr,key);
6133 if (de != NULL) {
6134 value = dictGetEntryVal(de);
6135 incrRefCount(value);
6136 }
6137 }
6138 return value;
6139 }
6140
6141 /* Test if the key exists in the given hash. Returns 1 if the key
6142 * exists and 0 when it doesn't. */
6143 static int hashExists(robj *o, robj *key) {
6144 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
6145 key = getDecodedObject(key);
6146 if (zipmapExists(o->ptr,key->ptr,sdslen(key->ptr))) {
6147 decrRefCount(key);
6148 return 1;
6149 }
6150 decrRefCount(key);
6151 } else {
6152 if (dictFind(o->ptr,key) != NULL) {
6153 return 1;
6154 }
6155 }
6156 return 0;
6157 }
6158
6159 /* Add an element, discard the old if the key already exists.
6160 * Return 0 on insert and 1 on update. */
6161 static int hashSet(robj *o, robj *key, robj *value) {
6162 int update = 0;
6163 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
6164 key = getDecodedObject(key);
6165 value = getDecodedObject(value);
6166 o->ptr = zipmapSet(o->ptr,
6167 key->ptr,sdslen(key->ptr),
6168 value->ptr,sdslen(value->ptr), &update);
6169 decrRefCount(key);
6170 decrRefCount(value);
6171
6172 /* Check if the zipmap needs to be upgraded to a real hash table */
6173 if (zipmapLen(o->ptr) > server.hash_max_zipmap_entries)
6174 convertToRealHash(o);
6175 } else {
6176 if (dictReplace(o->ptr,key,value)) {
6177 /* Insert */
6178 incrRefCount(key);
6179 } else {
6180 /* Update */
6181 update = 1;
6182 }
6183 incrRefCount(value);
6184 }
6185 return update;
6186 }
6187
6188 /* Delete an element from a hash.
6189 * Return 1 on deleted and 0 on not found. */
6190 static int hashDelete(robj *o, robj *key) {
6191 int deleted = 0;
6192 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
6193 key = getDecodedObject(key);
6194 o->ptr = zipmapDel(o->ptr,key->ptr,sdslen(key->ptr), &deleted);
6195 decrRefCount(key);
6196 } else {
6197 deleted = dictDelete((dict*)o->ptr,key) == DICT_OK;
6198 /* Always check if the dictionary needs a resize after a delete. */
6199 if (deleted && htNeedsResize(o->ptr)) dictResize(o->ptr);
6200 }
6201 return deleted;
6202 }
6203
6204 /* Return the number of elements in a hash. */
6205 static unsigned long hashLength(robj *o) {
6206 return (o->encoding == REDIS_ENCODING_ZIPMAP) ?
6207 zipmapLen((unsigned char*)o->ptr) : dictSize((dict*)o->ptr);
6208 }
6209
6210 /* Structure to hold hash iteration abstration. Note that iteration over
6211 * hashes involves both fields and values. Because it is possible that
6212 * not both are required, store pointers in the iterator to avoid
6213 * unnecessary memory allocation for fields/values. */
6214 typedef struct {
6215 int encoding;
6216 unsigned char *zi;
6217 unsigned char *zk, *zv;
6218 unsigned int zklen, zvlen;
6219
6220 dictIterator *di;
6221 dictEntry *de;
6222 } hashIterator;
6223
6224 static hashIterator *hashInitIterator(robj *subject) {
6225 hashIterator *hi = zmalloc(sizeof(hashIterator));
6226 hi->encoding = subject->encoding;
6227 if (hi->encoding == REDIS_ENCODING_ZIPMAP) {
6228 hi->zi = zipmapRewind(subject->ptr);
6229 } else if (hi->encoding == REDIS_ENCODING_HT) {
6230 hi->di = dictGetIterator(subject->ptr);
6231 } else {
6232 redisAssert(NULL);
6233 }
6234 return hi;
6235 }
6236
6237 static void hashReleaseIterator(hashIterator *hi) {
6238 if (hi->encoding == REDIS_ENCODING_HT) {
6239 dictReleaseIterator(hi->di);
6240 }
6241 zfree(hi);
6242 }
6243
6244 /* Move to the next entry in the hash. Return REDIS_OK when the next entry
6245 * could be found and REDIS_ERR when the iterator reaches the end. */
6246 static int hashNext(hashIterator *hi) {
6247 if (hi->encoding == REDIS_ENCODING_ZIPMAP) {
6248 if ((hi->zi = zipmapNext(hi->zi, &hi->zk, &hi->zklen,
6249 &hi->zv, &hi->zvlen)) == NULL) return REDIS_ERR;
6250 } else {
6251 if ((hi->de = dictNext(hi->di)) == NULL) return REDIS_ERR;
6252 }
6253 return REDIS_OK;
6254 }
6255
6256 /* Get key or value object at current iteration position.
6257 * This increases the refcount of the field object by 1. */
6258 static robj *hashCurrent(hashIterator *hi, int what) {
6259 robj *o;
6260 if (hi->encoding == REDIS_ENCODING_ZIPMAP) {
6261 if (what & REDIS_HASH_KEY) {
6262 o = createStringObject((char*)hi->zk,hi->zklen);
6263 } else {
6264 o = createStringObject((char*)hi->zv,hi->zvlen);
6265 }
6266 } else {
6267 if (what & REDIS_HASH_KEY) {
6268 o = dictGetEntryKey(hi->de);
6269 } else {
6270 o = dictGetEntryVal(hi->de);
6271 }
6272 incrRefCount(o);
6273 }
6274 return o;
6275 }
6276
6277 static robj *hashLookupWriteOrCreate(redisClient *c, robj *key) {
6278 robj *o = lookupKeyWrite(c->db,key);
6279 if (o == NULL) {
6280 o = createHashObject();
6281 dictAdd(c->db->dict,key,o);
6282 incrRefCount(key);
6283 } else {
6284 if (o->type != REDIS_HASH) {
6285 addReply(c,shared.wrongtypeerr);
6286 return NULL;
6287 }
6288 }
6289 return o;
6290 }
6291
6292 /* ============================= Hash commands ============================== */
6293 static void hsetCommand(redisClient *c) {
6294 int update;
6295 robj *o;
6296
6297 if ((o = hashLookupWriteOrCreate(c,c->argv[1])) == NULL) return;
6298 hashTryConversion(o,c->argv,2,3);
6299 hashTryObjectEncoding(o,&c->argv[2], &c->argv[3]);
6300 update = hashSet(o,c->argv[2],c->argv[3]);
6301 addReply(c, update ? shared.czero : shared.cone);
6302 server.dirty++;
6303 }
6304
6305 static void hsetnxCommand(redisClient *c) {
6306 robj *o;
6307 if ((o = hashLookupWriteOrCreate(c,c->argv[1])) == NULL) return;
6308 hashTryConversion(o,c->argv,2,3);
6309
6310 if (hashExists(o, c->argv[2])) {
6311 addReply(c, shared.czero);
6312 } else {
6313 hashTryObjectEncoding(o,&c->argv[2], &c->argv[3]);
6314 hashSet(o,c->argv[2],c->argv[3]);
6315 addReply(c, shared.cone);
6316 server.dirty++;
6317 }
6318 }
6319
6320 static void hmsetCommand(redisClient *c) {
6321 int i;
6322 robj *o;
6323
6324 if ((c->argc % 2) == 1) {
6325 addReplySds(c,sdsnew("-ERR wrong number of arguments for HMSET\r\n"));
6326 return;
6327 }
6328
6329 if ((o = hashLookupWriteOrCreate(c,c->argv[1])) == NULL) return;
6330 hashTryConversion(o,c->argv,2,c->argc-1);
6331 for (i = 2; i < c->argc; i += 2) {
6332 hashTryObjectEncoding(o,&c->argv[i], &c->argv[i+1]);
6333 hashSet(o,c->argv[i],c->argv[i+1]);
6334 }
6335 addReply(c, shared.ok);
6336 server.dirty++;
6337 }
6338
6339 static void hincrbyCommand(redisClient *c) {
6340 long long value, incr;
6341 robj *o, *current, *new;
6342
6343 if (getLongLongFromObjectOrReply(c,c->argv[3],&incr,NULL) != REDIS_OK) return;
6344 if ((o = hashLookupWriteOrCreate(c,c->argv[1])) == NULL) return;
6345 if ((current = hashGet(o,c->argv[2])) != NULL) {
6346 if (current->encoding == REDIS_ENCODING_RAW)
6347 value = strtoll(current->ptr,NULL,10);
6348 else if (current->encoding == REDIS_ENCODING_INT)
6349 value = (long)current->ptr;
6350 else
6351 redisAssert(1 != 1);
6352 decrRefCount(current);
6353 } else {
6354 value = 0;
6355 }
6356
6357 value += incr;
6358 new = createStringObjectFromLongLong(value);
6359 hashTryObjectEncoding(o,&c->argv[2],NULL);
6360 hashSet(o,c->argv[2],new);
6361 decrRefCount(new);
6362 addReplyLongLong(c,value);
6363 server.dirty++;
6364 }
6365
6366 static void hgetCommand(redisClient *c) {
6367 robj *o, *value;
6368 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
6369 checkType(c,o,REDIS_HASH)) return;
6370
6371 if ((value = hashGet(o,c->argv[2])) != NULL) {
6372 addReplyBulk(c,value);
6373 decrRefCount(value);
6374 } else {
6375 addReply(c,shared.nullbulk);
6376 }
6377 }
6378
6379 static void hmgetCommand(redisClient *c) {
6380 int i;
6381 robj *o, *value;
6382 o = lookupKeyRead(c->db,c->argv[1]);
6383 if (o != NULL && o->type != REDIS_HASH) {
6384 addReply(c,shared.wrongtypeerr);
6385 }
6386
6387 /* Note the check for o != NULL happens inside the loop. This is
6388 * done because objects that cannot be found are considered to be
6389 * an empty hash. The reply should then be a series of NULLs. */
6390 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",c->argc-2));
6391 for (i = 2; i < c->argc; i++) {
6392 if (o != NULL && (value = hashGet(o,c->argv[i])) != NULL) {
6393 addReplyBulk(c,value);
6394 decrRefCount(value);
6395 } else {
6396 addReply(c,shared.nullbulk);
6397 }
6398 }
6399 }
6400
6401 static void hdelCommand(redisClient *c) {
6402 robj *o;
6403 if ((o = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
6404 checkType(c,o,REDIS_HASH)) return;
6405
6406 if (hashDelete(o,c->argv[2])) {
6407 if (hashLength(o) == 0) deleteKey(c->db,c->argv[1]);
6408 addReply(c,shared.cone);
6409 server.dirty++;
6410 } else {
6411 addReply(c,shared.czero);
6412 }
6413 }
6414
6415 static void hlenCommand(redisClient *c) {
6416 robj *o;
6417 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
6418 checkType(c,o,REDIS_HASH)) return;
6419
6420 addReplyUlong(c,hashLength(o));
6421 }
6422
6423 static void genericHgetallCommand(redisClient *c, int flags) {
6424 robj *o, *lenobj, *obj;
6425 unsigned long count = 0;
6426 hashIterator *hi;
6427
6428 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.emptymultibulk)) == NULL
6429 || checkType(c,o,REDIS_HASH)) return;
6430
6431 lenobj = createObject(REDIS_STRING,NULL);
6432 addReply(c,lenobj);
6433 decrRefCount(lenobj);
6434
6435 hi = hashInitIterator(o);
6436 while (hashNext(hi) != REDIS_ERR) {
6437 if (flags & REDIS_HASH_KEY) {
6438 obj = hashCurrent(hi,REDIS_HASH_KEY);
6439 addReplyBulk(c,obj);
6440 decrRefCount(obj);
6441 count++;
6442 }
6443 if (flags & REDIS_HASH_VALUE) {
6444 obj = hashCurrent(hi,REDIS_HASH_VALUE);
6445 addReplyBulk(c,obj);
6446 decrRefCount(obj);
6447 count++;
6448 }
6449 }
6450 hashReleaseIterator(hi);
6451
6452 lenobj->ptr = sdscatprintf(sdsempty(),"*%lu\r\n",count);
6453 }
6454
6455 static void hkeysCommand(redisClient *c) {
6456 genericHgetallCommand(c,REDIS_HASH_KEY);
6457 }
6458
6459 static void hvalsCommand(redisClient *c) {
6460 genericHgetallCommand(c,REDIS_HASH_VALUE);
6461 }
6462
6463 static void hgetallCommand(redisClient *c) {
6464 genericHgetallCommand(c,REDIS_HASH_KEY|REDIS_HASH_VALUE);
6465 }
6466
6467 static void hexistsCommand(redisClient *c) {
6468 robj *o;
6469 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
6470 checkType(c,o,REDIS_HASH)) return;
6471
6472 addReply(c, hashExists(o,c->argv[2]) ? shared.cone : shared.czero);
6473 }
6474
6475 static void convertToRealHash(robj *o) {
6476 unsigned char *key, *val, *p, *zm = o->ptr;
6477 unsigned int klen, vlen;
6478 dict *dict = dictCreate(&hashDictType,NULL);
6479
6480 assert(o->type == REDIS_HASH && o->encoding != REDIS_ENCODING_HT);
6481 p = zipmapRewind(zm);
6482 while((p = zipmapNext(p,&key,&klen,&val,&vlen)) != NULL) {
6483 robj *keyobj, *valobj;
6484
6485 keyobj = createStringObject((char*)key,klen);
6486 valobj = createStringObject((char*)val,vlen);
6487 keyobj = tryObjectEncoding(keyobj);
6488 valobj = tryObjectEncoding(valobj);
6489 dictAdd(dict,keyobj,valobj);
6490 }
6491 o->encoding = REDIS_ENCODING_HT;
6492 o->ptr = dict;
6493 zfree(zm);
6494 }
6495
6496 /* ========================= Non type-specific commands ==================== */
6497
6498 static void flushdbCommand(redisClient *c) {
6499 server.dirty += dictSize(c->db->dict);
6500 dictEmpty(c->db->dict);
6501 dictEmpty(c->db->expires);
6502 addReply(c,shared.ok);
6503 }
6504
6505 static void flushallCommand(redisClient *c) {
6506 server.dirty += emptyDb();
6507 addReply(c,shared.ok);
6508 if (server.bgsavechildpid != -1) {
6509 kill(server.bgsavechildpid,SIGKILL);
6510 rdbRemoveTempFile(server.bgsavechildpid);
6511 }
6512 rdbSave(server.dbfilename);
6513 server.dirty++;
6514 }
6515
6516 static redisSortOperation *createSortOperation(int type, robj *pattern) {
6517 redisSortOperation *so = zmalloc(sizeof(*so));
6518 so->type = type;
6519 so->pattern = pattern;
6520 return so;
6521 }
6522
6523 /* Return the value associated to the key with a name obtained
6524 * substituting the first occurence of '*' in 'pattern' with 'subst'.
6525 * The returned object will always have its refcount increased by 1
6526 * when it is non-NULL. */
6527 static robj *lookupKeyByPattern(redisDb *db, robj *pattern, robj *subst) {
6528 char *p, *f;
6529 sds spat, ssub;
6530 robj keyobj, fieldobj, *o;
6531 int prefixlen, sublen, postfixlen, fieldlen;
6532 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
6533 struct {
6534 long len;
6535 long free;
6536 char buf[REDIS_SORTKEY_MAX+1];
6537 } keyname, fieldname;
6538
6539 /* If the pattern is "#" return the substitution object itself in order
6540 * to implement the "SORT ... GET #" feature. */
6541 spat = pattern->ptr;
6542 if (spat[0] == '#' && spat[1] == '\0') {
6543 incrRefCount(subst);
6544 return subst;
6545 }
6546
6547 /* The substitution object may be specially encoded. If so we create
6548 * a decoded object on the fly. Otherwise getDecodedObject will just
6549 * increment the ref count, that we'll decrement later. */
6550 subst = getDecodedObject(subst);
6551
6552 ssub = subst->ptr;
6553 if (sdslen(spat)+sdslen(ssub)-1 > REDIS_SORTKEY_MAX) return NULL;
6554 p = strchr(spat,'*');
6555 if (!p) {
6556 decrRefCount(subst);
6557 return NULL;
6558 }
6559
6560 /* Find out if we're dealing with a hash dereference. */
6561 if ((f = strstr(p+1, "->")) != NULL) {
6562 fieldlen = sdslen(spat)-(f-spat);
6563 /* this also copies \0 character */
6564 memcpy(fieldname.buf,f+2,fieldlen-1);
6565 fieldname.len = fieldlen-2;
6566 } else {
6567 fieldlen = 0;
6568 }
6569
6570 prefixlen = p-spat;
6571 sublen = sdslen(ssub);
6572 postfixlen = sdslen(spat)-(prefixlen+1)-fieldlen;
6573 memcpy(keyname.buf,spat,prefixlen);
6574 memcpy(keyname.buf+prefixlen,ssub,sublen);
6575 memcpy(keyname.buf+prefixlen+sublen,p+1,postfixlen);
6576 keyname.buf[prefixlen+sublen+postfixlen] = '\0';
6577 keyname.len = prefixlen+sublen+postfixlen;
6578 decrRefCount(subst);
6579
6580 /* Lookup substituted key */
6581 initStaticStringObject(keyobj,((char*)&keyname)+(sizeof(long)*2));
6582 o = lookupKeyRead(db,&keyobj);
6583 if (o == NULL) return NULL;
6584
6585 if (fieldlen > 0) {
6586 if (o->type != REDIS_HASH || fieldname.len < 1) return NULL;
6587
6588 /* Retrieve value from hash by the field name. This operation
6589 * already increases the refcount of the returned object. */
6590 initStaticStringObject(fieldobj,((char*)&fieldname)+(sizeof(long)*2));
6591 o = hashGet(o, &fieldobj);
6592 } else {
6593 if (o->type != REDIS_STRING) return NULL;
6594
6595 /* Every object that this function returns needs to have its refcount
6596 * increased. sortCommand decreases it again. */
6597 incrRefCount(o);
6598 }
6599
6600 return o;
6601 }
6602
6603 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
6604 * the additional parameter is not standard but a BSD-specific we have to
6605 * pass sorting parameters via the global 'server' structure */
6606 static int sortCompare(const void *s1, const void *s2) {
6607 const redisSortObject *so1 = s1, *so2 = s2;
6608 int cmp;
6609
6610 if (!server.sort_alpha) {
6611 /* Numeric sorting. Here it's trivial as we precomputed scores */
6612 if (so1->u.score > so2->u.score) {
6613 cmp = 1;
6614 } else if (so1->u.score < so2->u.score) {
6615 cmp = -1;
6616 } else {
6617 cmp = 0;
6618 }
6619 } else {
6620 /* Alphanumeric sorting */
6621 if (server.sort_bypattern) {
6622 if (!so1->u.cmpobj || !so2->u.cmpobj) {
6623 /* At least one compare object is NULL */
6624 if (so1->u.cmpobj == so2->u.cmpobj)
6625 cmp = 0;
6626 else if (so1->u.cmpobj == NULL)
6627 cmp = -1;
6628 else
6629 cmp = 1;
6630 } else {
6631 /* We have both the objects, use strcoll */
6632 cmp = strcoll(so1->u.cmpobj->ptr,so2->u.cmpobj->ptr);
6633 }
6634 } else {
6635 /* Compare elements directly. Note that these objects already
6636 * need to be non-encoded (see sortCommand). */
6637 cmp = strcoll(so1->obj->ptr,so2->obj->ptr);
6638 }
6639 }
6640 return server.sort_desc ? -cmp : cmp;
6641 }
6642
6643 /* The SORT command is the most complex command in Redis. Warning: this code
6644 * is optimized for speed and a bit less for readability */
6645 static void sortCommand(redisClient *c) {
6646 list *operations;
6647 int outputlen = 0;
6648 int desc = 0, alpha = 0;
6649 int limit_start = 0, limit_count = -1, start, end;
6650 int j, dontsort = 0, vectorlen;
6651 int getop = 0; /* GET operation counter */
6652 robj *sortval, *sortby = NULL, *storekey = NULL;
6653 redisSortObject *vector; /* Resulting vector to sort */
6654
6655 /* Lookup the key to sort. It must be of the right types */
6656 sortval = lookupKeyRead(c->db,c->argv[1]);
6657 if (sortval == NULL) {
6658 addReply(c,shared.emptymultibulk);
6659 return;
6660 }
6661 if (sortval->type != REDIS_SET && sortval->type != REDIS_LIST &&
6662 sortval->type != REDIS_ZSET)
6663 {
6664 addReply(c,shared.wrongtypeerr);
6665 return;
6666 }
6667
6668 /* Create a list of operations to perform for every sorted element.
6669 * Operations can be GET/DEL/INCR/DECR */
6670 operations = listCreate();
6671 listSetFreeMethod(operations,zfree);
6672 j = 2;
6673
6674 /* Now we need to protect sortval incrementing its count, in the future
6675 * SORT may have options able to overwrite/delete keys during the sorting
6676 * and the sorted key itself may get destroied */
6677 incrRefCount(sortval);
6678
6679 /* The SORT command has an SQL-alike syntax, parse it */
6680 while(j < c->argc) {
6681 int leftargs = c->argc-j-1;
6682 if (!strcasecmp(c->argv[j]->ptr,"asc")) {
6683 desc = 0;
6684 } else if (!strcasecmp(c->argv[j]->ptr,"desc")) {
6685 desc = 1;
6686 } else if (!strcasecmp(c->argv[j]->ptr,"alpha")) {
6687 alpha = 1;
6688 } else if (!strcasecmp(c->argv[j]->ptr,"limit") && leftargs >= 2) {
6689 limit_start = atoi(c->argv[j+1]->ptr);
6690 limit_count = atoi(c->argv[j+2]->ptr);
6691 j+=2;
6692 } else if (!strcasecmp(c->argv[j]->ptr,"store") && leftargs >= 1) {
6693 storekey = c->argv[j+1];
6694 j++;
6695 } else if (!strcasecmp(c->argv[j]->ptr,"by") && leftargs >= 1) {
6696 sortby = c->argv[j+1];
6697 /* If the BY pattern does not contain '*', i.e. it is constant,
6698 * we don't need to sort nor to lookup the weight keys. */
6699 if (strchr(c->argv[j+1]->ptr,'*') == NULL) dontsort = 1;
6700 j++;
6701 } else if (!strcasecmp(c->argv[j]->ptr,"get") && leftargs >= 1) {
6702 listAddNodeTail(operations,createSortOperation(
6703 REDIS_SORT_GET,c->argv[j+1]));
6704 getop++;
6705 j++;
6706 } else {
6707 decrRefCount(sortval);
6708 listRelease(operations);
6709 addReply(c,shared.syntaxerr);
6710 return;
6711 }
6712 j++;
6713 }
6714
6715 /* Load the sorting vector with all the objects to sort */
6716 switch(sortval->type) {
6717 case REDIS_LIST: vectorlen = listLength((list*)sortval->ptr); break;
6718 case REDIS_SET: vectorlen = dictSize((dict*)sortval->ptr); break;
6719 case REDIS_ZSET: vectorlen = dictSize(((zset*)sortval->ptr)->dict); break;
6720 default: vectorlen = 0; redisPanic("Bad SORT type"); /* Avoid GCC warning */
6721 }
6722 vector = zmalloc(sizeof(redisSortObject)*vectorlen);
6723 j = 0;
6724
6725 if (sortval->type == REDIS_LIST) {
6726 list *list = sortval->ptr;
6727 listNode *ln;
6728 listIter li;
6729
6730 listRewind(list,&li);
6731 while((ln = listNext(&li))) {
6732 robj *ele = ln->value;
6733 vector[j].obj = ele;
6734 vector[j].u.score = 0;
6735 vector[j].u.cmpobj = NULL;
6736 j++;
6737 }
6738 } else {
6739 dict *set;
6740 dictIterator *di;
6741 dictEntry *setele;
6742
6743 if (sortval->type == REDIS_SET) {
6744 set = sortval->ptr;
6745 } else {
6746 zset *zs = sortval->ptr;
6747 set = zs->dict;
6748 }
6749
6750 di = dictGetIterator(set);
6751 while((setele = dictNext(di)) != NULL) {
6752 vector[j].obj = dictGetEntryKey(setele);
6753 vector[j].u.score = 0;
6754 vector[j].u.cmpobj = NULL;
6755 j++;
6756 }
6757 dictReleaseIterator(di);
6758 }
6759 redisAssert(j == vectorlen);
6760
6761 /* Now it's time to load the right scores in the sorting vector */
6762 if (dontsort == 0) {
6763 for (j = 0; j < vectorlen; j++) {
6764 robj *byval;
6765 if (sortby) {
6766 /* lookup value to sort by */
6767 byval = lookupKeyByPattern(c->db,sortby,vector[j].obj);
6768 if (!byval) continue;
6769 } else {
6770 /* use object itself to sort by */
6771 byval = vector[j].obj;
6772 }
6773
6774 if (alpha) {
6775 vector[j].u.cmpobj = getDecodedObject(byval);
6776 } else {
6777 if (byval->encoding == REDIS_ENCODING_RAW) {
6778 vector[j].u.score = strtod(byval->ptr,NULL);
6779 } else if (byval->encoding == REDIS_ENCODING_INT) {
6780 /* Don't need to decode the object if it's
6781 * integer-encoded (the only encoding supported) so
6782 * far. We can just cast it */
6783 vector[j].u.score = (long)byval->ptr;
6784 } else {
6785 redisAssert(1 != 1);
6786 }
6787 }
6788
6789 /* when the object was retrieved using lookupKeyByPattern,
6790 * its refcount needs to be decreased. */
6791 if (sortby) {
6792 decrRefCount(byval);
6793 }
6794 }
6795 }
6796
6797 /* We are ready to sort the vector... perform a bit of sanity check
6798 * on the LIMIT option too. We'll use a partial version of quicksort. */
6799 start = (limit_start < 0) ? 0 : limit_start;
6800 end = (limit_count < 0) ? vectorlen-1 : start+limit_count-1;
6801 if (start >= vectorlen) {
6802 start = vectorlen-1;
6803 end = vectorlen-2;
6804 }
6805 if (end >= vectorlen) end = vectorlen-1;
6806
6807 if (dontsort == 0) {
6808 server.sort_desc = desc;
6809 server.sort_alpha = alpha;
6810 server.sort_bypattern = sortby ? 1 : 0;
6811 if (sortby && (start != 0 || end != vectorlen-1))
6812 pqsort(vector,vectorlen,sizeof(redisSortObject),sortCompare, start,end);
6813 else
6814 qsort(vector,vectorlen,sizeof(redisSortObject),sortCompare);
6815 }
6816
6817 /* Send command output to the output buffer, performing the specified
6818 * GET/DEL/INCR/DECR operations if any. */
6819 outputlen = getop ? getop*(end-start+1) : end-start+1;
6820 if (storekey == NULL) {
6821 /* STORE option not specified, sent the sorting result to client */
6822 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",outputlen));
6823 for (j = start; j <= end; j++) {
6824 listNode *ln;
6825 listIter li;
6826
6827 if (!getop) addReplyBulk(c,vector[j].obj);
6828 listRewind(operations,&li);
6829 while((ln = listNext(&li))) {
6830 redisSortOperation *sop = ln->value;
6831 robj *val = lookupKeyByPattern(c->db,sop->pattern,
6832 vector[j].obj);
6833
6834 if (sop->type == REDIS_SORT_GET) {
6835 if (!val) {
6836 addReply(c,shared.nullbulk);
6837 } else {
6838 addReplyBulk(c,val);
6839 decrRefCount(val);
6840 }
6841 } else {
6842 redisAssert(sop->type == REDIS_SORT_GET); /* always fails */
6843 }
6844 }
6845 }
6846 } else {
6847 robj *listObject = createListObject();
6848 list *listPtr = (list*) listObject->ptr;
6849
6850 /* STORE option specified, set the sorting result as a List object */
6851 for (j = start; j <= end; j++) {
6852 listNode *ln;
6853 listIter li;
6854
6855 if (!getop) {
6856 listAddNodeTail(listPtr,vector[j].obj);
6857 incrRefCount(vector[j].obj);
6858 }
6859 listRewind(operations,&li);
6860 while((ln = listNext(&li))) {
6861 redisSortOperation *sop = ln->value;
6862 robj *val = lookupKeyByPattern(c->db,sop->pattern,
6863 vector[j].obj);
6864
6865 if (sop->type == REDIS_SORT_GET) {
6866 if (!val) {
6867 listAddNodeTail(listPtr,createStringObject("",0));
6868 } else {
6869 /* We should do a incrRefCount on val because it is
6870 * added to the list, but also a decrRefCount because
6871 * it is returned by lookupKeyByPattern. This results
6872 * in doing nothing at all. */
6873 listAddNodeTail(listPtr,val);
6874 }
6875 } else {
6876 redisAssert(sop->type == REDIS_SORT_GET); /* always fails */
6877 }
6878 }
6879 }
6880 if (dictReplace(c->db->dict,storekey,listObject)) {
6881 incrRefCount(storekey);
6882 }
6883 /* Note: we add 1 because the DB is dirty anyway since even if the
6884 * SORT result is empty a new key is set and maybe the old content
6885 * replaced. */
6886 server.dirty += 1+outputlen;
6887 addReplySds(c,sdscatprintf(sdsempty(),":%d\r\n",outputlen));
6888 }
6889
6890 /* Cleanup */
6891 decrRefCount(sortval);
6892 listRelease(operations);
6893 for (j = 0; j < vectorlen; j++) {
6894 if (alpha && vector[j].u.cmpobj)
6895 decrRefCount(vector[j].u.cmpobj);
6896 }
6897 zfree(vector);
6898 }
6899
6900 /* Convert an amount of bytes into a human readable string in the form
6901 * of 100B, 2G, 100M, 4K, and so forth. */
6902 static void bytesToHuman(char *s, unsigned long long n) {
6903 double d;
6904
6905 if (n < 1024) {
6906 /* Bytes */
6907 sprintf(s,"%lluB",n);
6908 return;
6909 } else if (n < (1024*1024)) {
6910 d = (double)n/(1024);
6911 sprintf(s,"%.2fK",d);
6912 } else if (n < (1024LL*1024*1024)) {
6913 d = (double)n/(1024*1024);
6914 sprintf(s,"%.2fM",d);
6915 } else if (n < (1024LL*1024*1024*1024)) {
6916 d = (double)n/(1024LL*1024*1024);
6917 sprintf(s,"%.2fG",d);
6918 }
6919 }
6920
6921 /* Create the string returned by the INFO command. This is decoupled
6922 * by the INFO command itself as we need to report the same information
6923 * on memory corruption problems. */
6924 static sds genRedisInfoString(void) {
6925 sds info;
6926 time_t uptime = time(NULL)-server.stat_starttime;
6927 int j;
6928 char hmem[64];
6929
6930 bytesToHuman(hmem,zmalloc_used_memory());
6931 info = sdscatprintf(sdsempty(),
6932 "redis_version:%s\r\n"
6933 "arch_bits:%s\r\n"
6934 "multiplexing_api:%s\r\n"
6935 "process_id:%ld\r\n"
6936 "uptime_in_seconds:%ld\r\n"
6937 "uptime_in_days:%ld\r\n"
6938 "connected_clients:%d\r\n"
6939 "connected_slaves:%d\r\n"
6940 "blocked_clients:%d\r\n"
6941 "used_memory:%zu\r\n"
6942 "used_memory_human:%s\r\n"
6943 "changes_since_last_save:%lld\r\n"
6944 "bgsave_in_progress:%d\r\n"
6945 "last_save_time:%ld\r\n"
6946 "bgrewriteaof_in_progress:%d\r\n"
6947 "total_connections_received:%lld\r\n"
6948 "total_commands_processed:%lld\r\n"
6949 "expired_keys:%lld\r\n"
6950 "hash_max_zipmap_entries:%ld\r\n"
6951 "hash_max_zipmap_value:%ld\r\n"
6952 "pubsub_channels:%ld\r\n"
6953 "pubsub_patterns:%u\r\n"
6954 "vm_enabled:%d\r\n"
6955 "role:%s\r\n"
6956 ,REDIS_VERSION,
6957 (sizeof(long) == 8) ? "64" : "32",
6958 aeGetApiName(),
6959 (long) getpid(),
6960 uptime,
6961 uptime/(3600*24),
6962 listLength(server.clients)-listLength(server.slaves),
6963 listLength(server.slaves),
6964 server.blpop_blocked_clients,
6965 zmalloc_used_memory(),
6966 hmem,
6967 server.dirty,
6968 server.bgsavechildpid != -1,
6969 server.lastsave,
6970 server.bgrewritechildpid != -1,
6971 server.stat_numconnections,
6972 server.stat_numcommands,
6973 server.stat_expiredkeys,
6974 server.hash_max_zipmap_entries,
6975 server.hash_max_zipmap_value,
6976 dictSize(server.pubsub_channels),
6977 listLength(server.pubsub_patterns),
6978 server.vm_enabled != 0,
6979 server.masterhost == NULL ? "master" : "slave"
6980 );
6981 if (server.masterhost) {
6982 info = sdscatprintf(info,
6983 "master_host:%s\r\n"
6984 "master_port:%d\r\n"
6985 "master_link_status:%s\r\n"
6986 "master_last_io_seconds_ago:%d\r\n"
6987 ,server.masterhost,
6988 server.masterport,
6989 (server.replstate == REDIS_REPL_CONNECTED) ?
6990 "up" : "down",
6991 server.master ? ((int)(time(NULL)-server.master->lastinteraction)) : -1
6992 );
6993 }
6994 if (server.vm_enabled) {
6995 lockThreadedIO();
6996 info = sdscatprintf(info,
6997 "vm_conf_max_memory:%llu\r\n"
6998 "vm_conf_page_size:%llu\r\n"
6999 "vm_conf_pages:%llu\r\n"
7000 "vm_stats_used_pages:%llu\r\n"
7001 "vm_stats_swapped_objects:%llu\r\n"
7002 "vm_stats_swappin_count:%llu\r\n"
7003 "vm_stats_swappout_count:%llu\r\n"
7004 "vm_stats_io_newjobs_len:%lu\r\n"
7005 "vm_stats_io_processing_len:%lu\r\n"
7006 "vm_stats_io_processed_len:%lu\r\n"
7007 "vm_stats_io_active_threads:%lu\r\n"
7008 "vm_stats_blocked_clients:%lu\r\n"
7009 ,(unsigned long long) server.vm_max_memory,
7010 (unsigned long long) server.vm_page_size,
7011 (unsigned long long) server.vm_pages,
7012 (unsigned long long) server.vm_stats_used_pages,
7013 (unsigned long long) server.vm_stats_swapped_objects,
7014 (unsigned long long) server.vm_stats_swapins,
7015 (unsigned long long) server.vm_stats_swapouts,
7016 (unsigned long) listLength(server.io_newjobs),
7017 (unsigned long) listLength(server.io_processing),
7018 (unsigned long) listLength(server.io_processed),
7019 (unsigned long) server.io_active_threads,
7020 (unsigned long) server.vm_blocked_clients
7021 );
7022 unlockThreadedIO();
7023 }
7024 for (j = 0; j < server.dbnum; j++) {
7025 long long keys, vkeys;
7026
7027 keys = dictSize(server.db[j].dict);
7028 vkeys = dictSize(server.db[j].expires);
7029 if (keys || vkeys) {
7030 info = sdscatprintf(info, "db%d:keys=%lld,expires=%lld\r\n",
7031 j, keys, vkeys);
7032 }
7033 }
7034 return info;
7035 }
7036
7037 static void infoCommand(redisClient *c) {
7038 sds info = genRedisInfoString();
7039 addReplySds(c,sdscatprintf(sdsempty(),"$%lu\r\n",
7040 (unsigned long)sdslen(info)));
7041 addReplySds(c,info);
7042 addReply(c,shared.crlf);
7043 }
7044
7045 static void monitorCommand(redisClient *c) {
7046 /* ignore MONITOR if aleady slave or in monitor mode */
7047 if (c->flags & REDIS_SLAVE) return;
7048
7049 c->flags |= (REDIS_SLAVE|REDIS_MONITOR);
7050 c->slaveseldb = 0;
7051 listAddNodeTail(server.monitors,c);
7052 addReply(c,shared.ok);
7053 }
7054
7055 /* ================================= Expire ================================= */
7056 static int removeExpire(redisDb *db, robj *key) {
7057 if (dictDelete(db->expires,key) == DICT_OK) {
7058 return 1;
7059 } else {
7060 return 0;
7061 }
7062 }
7063
7064 static int setExpire(redisDb *db, robj *key, time_t when) {
7065 if (dictAdd(db->expires,key,(void*)when) == DICT_ERR) {
7066 return 0;
7067 } else {
7068 incrRefCount(key);
7069 return 1;
7070 }
7071 }
7072
7073 /* Return the expire time of the specified key, or -1 if no expire
7074 * is associated with this key (i.e. the key is non volatile) */
7075 static time_t getExpire(redisDb *db, robj *key) {
7076 dictEntry *de;
7077
7078 /* No expire? return ASAP */
7079 if (dictSize(db->expires) == 0 ||
7080 (de = dictFind(db->expires,key)) == NULL) return -1;
7081
7082 return (time_t) dictGetEntryVal(de);
7083 }
7084
7085 static int expireIfNeeded(redisDb *db, robj *key) {
7086 time_t when;
7087 dictEntry *de;
7088
7089 /* No expire? return ASAP */
7090 if (dictSize(db->expires) == 0 ||
7091 (de = dictFind(db->expires,key)) == NULL) return 0;
7092
7093 /* Lookup the expire */
7094 when = (time_t) dictGetEntryVal(de);
7095 if (time(NULL) <= when) return 0;
7096
7097 /* Delete the key */
7098 dictDelete(db->expires,key);
7099 server.stat_expiredkeys++;
7100 return dictDelete(db->dict,key) == DICT_OK;
7101 }
7102
7103 static int deleteIfVolatile(redisDb *db, robj *key) {
7104 dictEntry *de;
7105
7106 /* No expire? return ASAP */
7107 if (dictSize(db->expires) == 0 ||
7108 (de = dictFind(db->expires,key)) == NULL) return 0;
7109
7110 /* Delete the key */
7111 server.dirty++;
7112 server.stat_expiredkeys++;
7113 dictDelete(db->expires,key);
7114 return dictDelete(db->dict,key) == DICT_OK;
7115 }
7116
7117 static void expireGenericCommand(redisClient *c, robj *key, robj *param, long offset) {
7118 dictEntry *de;
7119 time_t seconds;
7120
7121 if (getLongFromObjectOrReply(c, param, &seconds, NULL) != REDIS_OK) return;
7122
7123 seconds -= offset;
7124
7125 de = dictFind(c->db->dict,key);
7126 if (de == NULL) {
7127 addReply(c,shared.czero);
7128 return;
7129 }
7130 if (seconds <= 0) {
7131 if (deleteKey(c->db,key)) server.dirty++;
7132 addReply(c, shared.cone);
7133 return;
7134 } else {
7135 time_t when = time(NULL)+seconds;
7136 if (setExpire(c->db,key,when)) {
7137 addReply(c,shared.cone);
7138 server.dirty++;
7139 } else {
7140 addReply(c,shared.czero);
7141 }
7142 return;
7143 }
7144 }
7145
7146 static void expireCommand(redisClient *c) {
7147 expireGenericCommand(c,c->argv[1],c->argv[2],0);
7148 }
7149
7150 static void expireatCommand(redisClient *c) {
7151 expireGenericCommand(c,c->argv[1],c->argv[2],time(NULL));
7152 }
7153
7154 static void ttlCommand(redisClient *c) {
7155 time_t expire;
7156 int ttl = -1;
7157
7158 expire = getExpire(c->db,c->argv[1]);
7159 if (expire != -1) {
7160 ttl = (int) (expire-time(NULL));
7161 if (ttl < 0) ttl = -1;
7162 }
7163 addReplySds(c,sdscatprintf(sdsempty(),":%d\r\n",ttl));
7164 }
7165
7166 /* ================================ MULTI/EXEC ============================== */
7167
7168 /* Client state initialization for MULTI/EXEC */
7169 static void initClientMultiState(redisClient *c) {
7170 c->mstate.commands = NULL;
7171 c->mstate.count = 0;
7172 }
7173
7174 /* Release all the resources associated with MULTI/EXEC state */
7175 static void freeClientMultiState(redisClient *c) {
7176 int j;
7177
7178 for (j = 0; j < c->mstate.count; j++) {
7179 int i;
7180 multiCmd *mc = c->mstate.commands+j;
7181
7182 for (i = 0; i < mc->argc; i++)
7183 decrRefCount(mc->argv[i]);
7184 zfree(mc->argv);
7185 }
7186 zfree(c->mstate.commands);
7187 }
7188
7189 /* Add a new command into the MULTI commands queue */
7190 static void queueMultiCommand(redisClient *c, struct redisCommand *cmd) {
7191 multiCmd *mc;
7192 int j;
7193
7194 c->mstate.commands = zrealloc(c->mstate.commands,
7195 sizeof(multiCmd)*(c->mstate.count+1));
7196 mc = c->mstate.commands+c->mstate.count;
7197 mc->cmd = cmd;
7198 mc->argc = c->argc;
7199 mc->argv = zmalloc(sizeof(robj*)*c->argc);
7200 memcpy(mc->argv,c->argv,sizeof(robj*)*c->argc);
7201 for (j = 0; j < c->argc; j++)
7202 incrRefCount(mc->argv[j]);
7203 c->mstate.count++;
7204 }
7205
7206 static void multiCommand(redisClient *c) {
7207 c->flags |= REDIS_MULTI;
7208 addReply(c,shared.ok);
7209 }
7210
7211 static void discardCommand(redisClient *c) {
7212 if (!(c->flags & REDIS_MULTI)) {
7213 addReplySds(c,sdsnew("-ERR DISCARD without MULTI\r\n"));
7214 return;
7215 }
7216
7217 freeClientMultiState(c);
7218 initClientMultiState(c);
7219 c->flags &= (~REDIS_MULTI);
7220 addReply(c,shared.ok);
7221 }
7222
7223 static void execCommand(redisClient *c) {
7224 int j;
7225 robj **orig_argv;
7226 int orig_argc;
7227
7228 if (!(c->flags & REDIS_MULTI)) {
7229 addReplySds(c,sdsnew("-ERR EXEC without MULTI\r\n"));
7230 return;
7231 }
7232
7233 orig_argv = c->argv;
7234 orig_argc = c->argc;
7235 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",c->mstate.count));
7236 for (j = 0; j < c->mstate.count; j++) {
7237 c->argc = c->mstate.commands[j].argc;
7238 c->argv = c->mstate.commands[j].argv;
7239 call(c,c->mstate.commands[j].cmd);
7240 }
7241 c->argv = orig_argv;
7242 c->argc = orig_argc;
7243 freeClientMultiState(c);
7244 initClientMultiState(c);
7245 c->flags &= (~REDIS_MULTI);
7246 }
7247
7248 /* =========================== Blocking Operations ========================= */
7249
7250 /* Currently Redis blocking operations support is limited to list POP ops,
7251 * so the current implementation is not fully generic, but it is also not
7252 * completely specific so it will not require a rewrite to support new
7253 * kind of blocking operations in the future.
7254 *
7255 * Still it's important to note that list blocking operations can be already
7256 * used as a notification mechanism in order to implement other blocking
7257 * operations at application level, so there must be a very strong evidence
7258 * of usefulness and generality before new blocking operations are implemented.
7259 *
7260 * This is how the current blocking POP works, we use BLPOP as example:
7261 * - If the user calls BLPOP and the key exists and contains a non empty list
7262 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
7263 * if there is not to block.
7264 * - If instead BLPOP is called and the key does not exists or the list is
7265 * empty we need to block. In order to do so we remove the notification for
7266 * new data to read in the client socket (so that we'll not serve new
7267 * requests if the blocking request is not served). Also we put the client
7268 * in a dictionary (db->blockingkeys) mapping keys to a list of clients
7269 * blocking for this keys.
7270 * - If a PUSH operation against a key with blocked clients waiting is
7271 * performed, we serve the first in the list: basically instead to push
7272 * the new element inside the list we return it to the (first / oldest)
7273 * blocking client, unblock the client, and remove it form the list.
7274 *
7275 * The above comment and the source code should be enough in order to understand
7276 * the implementation and modify / fix it later.
7277 */
7278
7279 /* Set a client in blocking mode for the specified key, with the specified
7280 * timeout */
7281 static void blockForKeys(redisClient *c, robj **keys, int numkeys, time_t timeout) {
7282 dictEntry *de;
7283 list *l;
7284 int j;
7285
7286 c->blockingkeys = zmalloc(sizeof(robj*)*numkeys);
7287 c->blockingkeysnum = numkeys;
7288 c->blockingto = timeout;
7289 for (j = 0; j < numkeys; j++) {
7290 /* Add the key in the client structure, to map clients -> keys */
7291 c->blockingkeys[j] = keys[j];
7292 incrRefCount(keys[j]);
7293
7294 /* And in the other "side", to map keys -> clients */
7295 de = dictFind(c->db->blockingkeys,keys[j]);
7296 if (de == NULL) {
7297 int retval;
7298
7299 /* For every key we take a list of clients blocked for it */
7300 l = listCreate();
7301 retval = dictAdd(c->db->blockingkeys,keys[j],l);
7302 incrRefCount(keys[j]);
7303 assert(retval == DICT_OK);
7304 } else {
7305 l = dictGetEntryVal(de);
7306 }
7307 listAddNodeTail(l,c);
7308 }
7309 /* Mark the client as a blocked client */
7310 c->flags |= REDIS_BLOCKED;
7311 server.blpop_blocked_clients++;
7312 }
7313
7314 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
7315 static void unblockClientWaitingData(redisClient *c) {
7316 dictEntry *de;
7317 list *l;
7318 int j;
7319
7320 assert(c->blockingkeys != NULL);
7321 /* The client may wait for multiple keys, so unblock it for every key. */
7322 for (j = 0; j < c->blockingkeysnum; j++) {
7323 /* Remove this client from the list of clients waiting for this key. */
7324 de = dictFind(c->db->blockingkeys,c->blockingkeys[j]);
7325 assert(de != NULL);
7326 l = dictGetEntryVal(de);
7327 listDelNode(l,listSearchKey(l,c));
7328 /* If the list is empty we need to remove it to avoid wasting memory */
7329 if (listLength(l) == 0)
7330 dictDelete(c->db->blockingkeys,c->blockingkeys[j]);
7331 decrRefCount(c->blockingkeys[j]);
7332 }
7333 /* Cleanup the client structure */
7334 zfree(c->blockingkeys);
7335 c->blockingkeys = NULL;
7336 c->flags &= (~REDIS_BLOCKED);
7337 server.blpop_blocked_clients--;
7338 /* We want to process data if there is some command waiting
7339 * in the input buffer. Note that this is safe even if
7340 * unblockClientWaitingData() gets called from freeClient() because
7341 * freeClient() will be smart enough to call this function
7342 * *after* c->querybuf was set to NULL. */
7343 if (c->querybuf && sdslen(c->querybuf) > 0) processInputBuffer(c);
7344 }
7345
7346 /* This should be called from any function PUSHing into lists.
7347 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
7348 * 'ele' is the element pushed.
7349 *
7350 * If the function returns 0 there was no client waiting for a list push
7351 * against this key.
7352 *
7353 * If the function returns 1 there was a client waiting for a list push
7354 * against this key, the element was passed to this client thus it's not
7355 * needed to actually add it to the list and the caller should return asap. */
7356 static int handleClientsWaitingListPush(redisClient *c, robj *key, robj *ele) {
7357 struct dictEntry *de;
7358 redisClient *receiver;
7359 list *l;
7360 listNode *ln;
7361
7362 de = dictFind(c->db->blockingkeys,key);
7363 if (de == NULL) return 0;
7364 l = dictGetEntryVal(de);
7365 ln = listFirst(l);
7366 assert(ln != NULL);
7367 receiver = ln->value;
7368
7369 addReplySds(receiver,sdsnew("*2\r\n"));
7370 addReplyBulk(receiver,key);
7371 addReplyBulk(receiver,ele);
7372 unblockClientWaitingData(receiver);
7373 return 1;
7374 }
7375
7376 /* Blocking RPOP/LPOP */
7377 static void blockingPopGenericCommand(redisClient *c, int where) {
7378 robj *o;
7379 time_t timeout;
7380 int j;
7381
7382 for (j = 1; j < c->argc-1; j++) {
7383 o = lookupKeyWrite(c->db,c->argv[j]);
7384 if (o != NULL) {
7385 if (o->type != REDIS_LIST) {
7386 addReply(c,shared.wrongtypeerr);
7387 return;
7388 } else {
7389 list *list = o->ptr;
7390 if (listLength(list) != 0) {
7391 /* If the list contains elements fall back to the usual
7392 * non-blocking POP operation */
7393 robj *argv[2], **orig_argv;
7394 int orig_argc;
7395
7396 /* We need to alter the command arguments before to call
7397 * popGenericCommand() as the command takes a single key. */
7398 orig_argv = c->argv;
7399 orig_argc = c->argc;
7400 argv[1] = c->argv[j];
7401 c->argv = argv;
7402 c->argc = 2;
7403
7404 /* Also the return value is different, we need to output
7405 * the multi bulk reply header and the key name. The
7406 * "real" command will add the last element (the value)
7407 * for us. If this souds like an hack to you it's just
7408 * because it is... */
7409 addReplySds(c,sdsnew("*2\r\n"));
7410 addReplyBulk(c,argv[1]);
7411 popGenericCommand(c,where);
7412
7413 /* Fix the client structure with the original stuff */
7414 c->argv = orig_argv;
7415 c->argc = orig_argc;
7416 return;
7417 }
7418 }
7419 }
7420 }
7421 /* If the list is empty or the key does not exists we must block */
7422 timeout = strtol(c->argv[c->argc-1]->ptr,NULL,10);
7423 if (timeout > 0) timeout += time(NULL);
7424 blockForKeys(c,c->argv+1,c->argc-2,timeout);
7425 }
7426
7427 static void blpopCommand(redisClient *c) {
7428 blockingPopGenericCommand(c,REDIS_HEAD);
7429 }
7430
7431 static void brpopCommand(redisClient *c) {
7432 blockingPopGenericCommand(c,REDIS_TAIL);
7433 }
7434
7435 /* =============================== Replication ============================= */
7436
7437 static int syncWrite(int fd, char *ptr, ssize_t size, int timeout) {
7438 ssize_t nwritten, ret = size;
7439 time_t start = time(NULL);
7440
7441 timeout++;
7442 while(size) {
7443 if (aeWait(fd,AE_WRITABLE,1000) & AE_WRITABLE) {
7444 nwritten = write(fd,ptr,size);
7445 if (nwritten == -1) return -1;
7446 ptr += nwritten;
7447 size -= nwritten;
7448 }
7449 if ((time(NULL)-start) > timeout) {
7450 errno = ETIMEDOUT;
7451 return -1;
7452 }
7453 }
7454 return ret;
7455 }
7456
7457 static int syncRead(int fd, char *ptr, ssize_t size, int timeout) {
7458 ssize_t nread, totread = 0;
7459 time_t start = time(NULL);
7460
7461 timeout++;
7462 while(size) {
7463 if (aeWait(fd,AE_READABLE,1000) & AE_READABLE) {
7464 nread = read(fd,ptr,size);
7465 if (nread == -1) return -1;
7466 ptr += nread;
7467 size -= nread;
7468 totread += nread;
7469 }
7470 if ((time(NULL)-start) > timeout) {
7471 errno = ETIMEDOUT;
7472 return -1;
7473 }
7474 }
7475 return totread;
7476 }
7477
7478 static int syncReadLine(int fd, char *ptr, ssize_t size, int timeout) {
7479 ssize_t nread = 0;
7480
7481 size--;
7482 while(size) {
7483 char c;
7484
7485 if (syncRead(fd,&c,1,timeout) == -1) return -1;
7486 if (c == '\n') {
7487 *ptr = '\0';
7488 if (nread && *(ptr-1) == '\r') *(ptr-1) = '\0';
7489 return nread;
7490 } else {
7491 *ptr++ = c;
7492 *ptr = '\0';
7493 nread++;
7494 }
7495 }
7496 return nread;
7497 }
7498
7499 static void syncCommand(redisClient *c) {
7500 /* ignore SYNC if aleady slave or in monitor mode */
7501 if (c->flags & REDIS_SLAVE) return;
7502
7503 /* SYNC can't be issued when the server has pending data to send to
7504 * the client about already issued commands. We need a fresh reply
7505 * buffer registering the differences between the BGSAVE and the current
7506 * dataset, so that we can copy to other slaves if needed. */
7507 if (listLength(c->reply) != 0) {
7508 addReplySds(c,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
7509 return;
7510 }
7511
7512 redisLog(REDIS_NOTICE,"Slave ask for synchronization");
7513 /* Here we need to check if there is a background saving operation
7514 * in progress, or if it is required to start one */
7515 if (server.bgsavechildpid != -1) {
7516 /* Ok a background save is in progress. Let's check if it is a good
7517 * one for replication, i.e. if there is another slave that is
7518 * registering differences since the server forked to save */
7519 redisClient *slave;
7520 listNode *ln;
7521 listIter li;
7522
7523 listRewind(server.slaves,&li);
7524 while((ln = listNext(&li))) {
7525 slave = ln->value;
7526 if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_END) break;
7527 }
7528 if (ln) {
7529 /* Perfect, the server is already registering differences for
7530 * another slave. Set the right state, and copy the buffer. */
7531 listRelease(c->reply);
7532 c->reply = listDup(slave->reply);
7533 c->replstate = REDIS_REPL_WAIT_BGSAVE_END;
7534 redisLog(REDIS_NOTICE,"Waiting for end of BGSAVE for SYNC");
7535 } else {
7536 /* No way, we need to wait for the next BGSAVE in order to
7537 * register differences */
7538 c->replstate = REDIS_REPL_WAIT_BGSAVE_START;
7539 redisLog(REDIS_NOTICE,"Waiting for next BGSAVE for SYNC");
7540 }
7541 } else {
7542 /* Ok we don't have a BGSAVE in progress, let's start one */
7543 redisLog(REDIS_NOTICE,"Starting BGSAVE for SYNC");
7544 if (rdbSaveBackground(server.dbfilename) != REDIS_OK) {
7545 redisLog(REDIS_NOTICE,"Replication failed, can't BGSAVE");
7546 addReplySds(c,sdsnew("-ERR Unalbe to perform background save\r\n"));
7547 return;
7548 }
7549 c->replstate = REDIS_REPL_WAIT_BGSAVE_END;
7550 }
7551 c->repldbfd = -1;
7552 c->flags |= REDIS_SLAVE;
7553 c->slaveseldb = 0;
7554 listAddNodeTail(server.slaves,c);
7555 return;
7556 }
7557
7558 static void sendBulkToSlave(aeEventLoop *el, int fd, void *privdata, int mask) {
7559 redisClient *slave = privdata;
7560 REDIS_NOTUSED(el);
7561 REDIS_NOTUSED(mask);
7562 char buf[REDIS_IOBUF_LEN];
7563 ssize_t nwritten, buflen;
7564
7565 if (slave->repldboff == 0) {
7566 /* Write the bulk write count before to transfer the DB. In theory here
7567 * we don't know how much room there is in the output buffer of the
7568 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
7569 * operations) will never be smaller than the few bytes we need. */
7570 sds bulkcount;
7571
7572 bulkcount = sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
7573 slave->repldbsize);
7574 if (write(fd,bulkcount,sdslen(bulkcount)) != (signed)sdslen(bulkcount))
7575 {
7576 sdsfree(bulkcount);
7577 freeClient(slave);
7578 return;
7579 }
7580 sdsfree(bulkcount);
7581 }
7582 lseek(slave->repldbfd,slave->repldboff,SEEK_SET);
7583 buflen = read(slave->repldbfd,buf,REDIS_IOBUF_LEN);
7584 if (buflen <= 0) {
7585 redisLog(REDIS_WARNING,"Read error sending DB to slave: %s",
7586 (buflen == 0) ? "premature EOF" : strerror(errno));
7587 freeClient(slave);
7588 return;
7589 }
7590 if ((nwritten = write(fd,buf,buflen)) == -1) {
7591 redisLog(REDIS_VERBOSE,"Write error sending DB to slave: %s",
7592 strerror(errno));
7593 freeClient(slave);
7594 return;
7595 }
7596 slave->repldboff += nwritten;
7597 if (slave->repldboff == slave->repldbsize) {
7598 close(slave->repldbfd);
7599 slave->repldbfd = -1;
7600 aeDeleteFileEvent(server.el,slave->fd,AE_WRITABLE);
7601 slave->replstate = REDIS_REPL_ONLINE;
7602 if (aeCreateFileEvent(server.el, slave->fd, AE_WRITABLE,
7603 sendReplyToClient, slave) == AE_ERR) {
7604 freeClient(slave);
7605 return;
7606 }
7607 addReplySds(slave,sdsempty());
7608 redisLog(REDIS_NOTICE,"Synchronization with slave succeeded");
7609 }
7610 }
7611
7612 /* This function is called at the end of every backgrond saving.
7613 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
7614 * otherwise REDIS_ERR is passed to the function.
7615 *
7616 * The goal of this function is to handle slaves waiting for a successful
7617 * background saving in order to perform non-blocking synchronization. */
7618 static void updateSlavesWaitingBgsave(int bgsaveerr) {
7619 listNode *ln;
7620 int startbgsave = 0;
7621 listIter li;
7622
7623 listRewind(server.slaves,&li);
7624 while((ln = listNext(&li))) {
7625 redisClient *slave = ln->value;
7626
7627 if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_START) {
7628 startbgsave = 1;
7629 slave->replstate = REDIS_REPL_WAIT_BGSAVE_END;
7630 } else if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_END) {
7631 struct redis_stat buf;
7632
7633 if (bgsaveerr != REDIS_OK) {
7634 freeClient(slave);
7635 redisLog(REDIS_WARNING,"SYNC failed. BGSAVE child returned an error");
7636 continue;
7637 }
7638 if ((slave->repldbfd = open(server.dbfilename,O_RDONLY)) == -1 ||
7639 redis_fstat(slave->repldbfd,&buf) == -1) {
7640 freeClient(slave);
7641 redisLog(REDIS_WARNING,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno));
7642 continue;
7643 }
7644 slave->repldboff = 0;
7645 slave->repldbsize = buf.st_size;
7646 slave->replstate = REDIS_REPL_SEND_BULK;
7647 aeDeleteFileEvent(server.el,slave->fd,AE_WRITABLE);
7648 if (aeCreateFileEvent(server.el, slave->fd, AE_WRITABLE, sendBulkToSlave, slave) == AE_ERR) {
7649 freeClient(slave);
7650 continue;
7651 }
7652 }
7653 }
7654 if (startbgsave) {
7655 if (rdbSaveBackground(server.dbfilename) != REDIS_OK) {
7656 listIter li;
7657
7658 listRewind(server.slaves,&li);
7659 redisLog(REDIS_WARNING,"SYNC failed. BGSAVE failed");
7660 while((ln = listNext(&li))) {
7661 redisClient *slave = ln->value;
7662
7663 if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_START)
7664 freeClient(slave);
7665 }
7666 }
7667 }
7668 }
7669
7670 static int syncWithMaster(void) {
7671 char buf[1024], tmpfile[256], authcmd[1024];
7672 long dumpsize;
7673 int fd = anetTcpConnect(NULL,server.masterhost,server.masterport);
7674 int dfd, maxtries = 5;
7675
7676 if (fd == -1) {
7677 redisLog(REDIS_WARNING,"Unable to connect to MASTER: %s",
7678 strerror(errno));
7679 return REDIS_ERR;
7680 }
7681
7682 /* AUTH with the master if required. */
7683 if(server.masterauth) {
7684 snprintf(authcmd, 1024, "AUTH %s\r\n", server.masterauth);
7685 if (syncWrite(fd, authcmd, strlen(server.masterauth)+7, 5) == -1) {
7686 close(fd);
7687 redisLog(REDIS_WARNING,"Unable to AUTH to MASTER: %s",
7688 strerror(errno));
7689 return REDIS_ERR;
7690 }
7691 /* Read the AUTH result. */
7692 if (syncReadLine(fd,buf,1024,3600) == -1) {
7693 close(fd);
7694 redisLog(REDIS_WARNING,"I/O error reading auth result from MASTER: %s",
7695 strerror(errno));
7696 return REDIS_ERR;
7697 }
7698 if (buf[0] != '+') {
7699 close(fd);
7700 redisLog(REDIS_WARNING,"Cannot AUTH to MASTER, is the masterauth password correct?");
7701 return REDIS_ERR;
7702 }
7703 }
7704
7705 /* Issue the SYNC command */
7706 if (syncWrite(fd,"SYNC \r\n",7,5) == -1) {
7707 close(fd);
7708 redisLog(REDIS_WARNING,"I/O error writing to MASTER: %s",
7709 strerror(errno));
7710 return REDIS_ERR;
7711 }
7712 /* Read the bulk write count */
7713 if (syncReadLine(fd,buf,1024,3600) == -1) {
7714 close(fd);
7715 redisLog(REDIS_WARNING,"I/O error reading bulk count from MASTER: %s",
7716 strerror(errno));
7717 return REDIS_ERR;
7718 }
7719 if (buf[0] != '$') {
7720 close(fd);
7721 redisLog(REDIS_WARNING,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
7722 return REDIS_ERR;
7723 }
7724 dumpsize = strtol(buf+1,NULL,10);
7725 redisLog(REDIS_NOTICE,"Receiving %ld bytes data dump from MASTER",dumpsize);
7726 /* Read the bulk write data on a temp file */
7727 while(maxtries--) {
7728 snprintf(tmpfile,256,
7729 "temp-%d.%ld.rdb",(int)time(NULL),(long int)getpid());
7730 dfd = open(tmpfile,O_CREAT|O_WRONLY|O_EXCL,0644);
7731 if (dfd != -1) break;
7732 sleep(1);
7733 }
7734 if (dfd == -1) {
7735 close(fd);
7736 redisLog(REDIS_WARNING,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno));
7737 return REDIS_ERR;
7738 }
7739 while(dumpsize) {
7740 int nread, nwritten;
7741
7742 nread = read(fd,buf,(dumpsize < 1024)?dumpsize:1024);
7743 if (nread == -1) {
7744 redisLog(REDIS_WARNING,"I/O error trying to sync with MASTER: %s",
7745 strerror(errno));
7746 close(fd);
7747 close(dfd);
7748 return REDIS_ERR;
7749 }
7750 nwritten = write(dfd,buf,nread);
7751 if (nwritten == -1) {
7752 redisLog(REDIS_WARNING,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno));
7753 close(fd);
7754 close(dfd);
7755 return REDIS_ERR;
7756 }
7757 dumpsize -= nread;
7758 }
7759 close(dfd);
7760 if (rename(tmpfile,server.dbfilename) == -1) {
7761 redisLog(REDIS_WARNING,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno));
7762 unlink(tmpfile);
7763 close(fd);
7764 return REDIS_ERR;
7765 }
7766 emptyDb();
7767 if (rdbLoad(server.dbfilename) != REDIS_OK) {
7768 redisLog(REDIS_WARNING,"Failed trying to load the MASTER synchronization DB from disk");
7769 close(fd);
7770 return REDIS_ERR;
7771 }
7772 server.master = createClient(fd);
7773 server.master->flags |= REDIS_MASTER;
7774 server.master->authenticated = 1;
7775 server.replstate = REDIS_REPL_CONNECTED;
7776 return REDIS_OK;
7777 }
7778
7779 static void slaveofCommand(redisClient *c) {
7780 if (!strcasecmp(c->argv[1]->ptr,"no") &&
7781 !strcasecmp(c->argv[2]->ptr,"one")) {
7782 if (server.masterhost) {
7783 sdsfree(server.masterhost);
7784 server.masterhost = NULL;
7785 if (server.master) freeClient(server.master);
7786 server.replstate = REDIS_REPL_NONE;
7787 redisLog(REDIS_NOTICE,"MASTER MODE enabled (user request)");
7788 }
7789 } else {
7790 sdsfree(server.masterhost);
7791 server.masterhost = sdsdup(c->argv[1]->ptr);
7792 server.masterport = atoi(c->argv[2]->ptr);
7793 if (server.master) freeClient(server.master);
7794 server.replstate = REDIS_REPL_CONNECT;
7795 redisLog(REDIS_NOTICE,"SLAVE OF %s:%d enabled (user request)",
7796 server.masterhost, server.masterport);
7797 }
7798 addReply(c,shared.ok);
7799 }
7800
7801 /* ============================ Maxmemory directive ======================== */
7802
7803 /* Try to free one object form the pre-allocated objects free list.
7804 * This is useful under low mem conditions as by default we take 1 million
7805 * free objects allocated. On success REDIS_OK is returned, otherwise
7806 * REDIS_ERR. */
7807 static int tryFreeOneObjectFromFreelist(void) {
7808 robj *o;
7809
7810 if (server.vm_enabled) pthread_mutex_lock(&server.obj_freelist_mutex);
7811 if (listLength(server.objfreelist)) {
7812 listNode *head = listFirst(server.objfreelist);
7813 o = listNodeValue(head);
7814 listDelNode(server.objfreelist,head);
7815 if (server.vm_enabled) pthread_mutex_unlock(&server.obj_freelist_mutex);
7816 zfree(o);
7817 return REDIS_OK;
7818 } else {
7819 if (server.vm_enabled) pthread_mutex_unlock(&server.obj_freelist_mutex);
7820 return REDIS_ERR;
7821 }
7822 }
7823
7824 /* This function gets called when 'maxmemory' is set on the config file to limit
7825 * the max memory used by the server, and we are out of memory.
7826 * This function will try to, in order:
7827 *
7828 * - Free objects from the free list
7829 * - Try to remove keys with an EXPIRE set
7830 *
7831 * It is not possible to free enough memory to reach used-memory < maxmemory
7832 * the server will start refusing commands that will enlarge even more the
7833 * memory usage.
7834 */
7835 static void freeMemoryIfNeeded(void) {
7836 while (server.maxmemory && zmalloc_used_memory() > server.maxmemory) {
7837 int j, k, freed = 0;
7838
7839 if (tryFreeOneObjectFromFreelist() == REDIS_OK) continue;
7840 for (j = 0; j < server.dbnum; j++) {
7841 int minttl = -1;
7842 robj *minkey = NULL;
7843 struct dictEntry *de;
7844
7845 if (dictSize(server.db[j].expires)) {
7846 freed = 1;
7847 /* From a sample of three keys drop the one nearest to
7848 * the natural expire */
7849 for (k = 0; k < 3; k++) {
7850 time_t t;
7851
7852 de = dictGetRandomKey(server.db[j].expires);
7853 t = (time_t) dictGetEntryVal(de);
7854 if (minttl == -1 || t < minttl) {
7855 minkey = dictGetEntryKey(de);
7856 minttl = t;
7857 }
7858 }
7859 deleteKey(server.db+j,minkey);
7860 }
7861 }
7862 if (!freed) return; /* nothing to free... */
7863 }
7864 }
7865
7866 /* ============================== Append Only file ========================== */
7867
7868 static void feedAppendOnlyFile(struct redisCommand *cmd, int dictid, robj **argv, int argc) {
7869 sds buf = sdsempty();
7870 int j;
7871 ssize_t nwritten;
7872 time_t now;
7873 robj *tmpargv[3];
7874
7875 /* The DB this command was targetting is not the same as the last command
7876 * we appendend. To issue a SELECT command is needed. */
7877 if (dictid != server.appendseldb) {
7878 char seldb[64];
7879
7880 snprintf(seldb,sizeof(seldb),"%d",dictid);
7881 buf = sdscatprintf(buf,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
7882 (unsigned long)strlen(seldb),seldb);
7883 server.appendseldb = dictid;
7884 }
7885
7886 /* "Fix" the argv vector if the command is EXPIRE. We want to translate
7887 * EXPIREs into EXPIREATs calls */
7888 if (cmd->proc == expireCommand) {
7889 long when;
7890
7891 tmpargv[0] = createStringObject("EXPIREAT",8);
7892 tmpargv[1] = argv[1];
7893 incrRefCount(argv[1]);
7894 when = time(NULL)+strtol(argv[2]->ptr,NULL,10);
7895 tmpargv[2] = createObject(REDIS_STRING,
7896 sdscatprintf(sdsempty(),"%ld",when));
7897 argv = tmpargv;
7898 }
7899
7900 /* Append the actual command */
7901 buf = sdscatprintf(buf,"*%d\r\n",argc);
7902 for (j = 0; j < argc; j++) {
7903 robj *o = argv[j];
7904
7905 o = getDecodedObject(o);
7906 buf = sdscatprintf(buf,"$%lu\r\n",(unsigned long)sdslen(o->ptr));
7907 buf = sdscatlen(buf,o->ptr,sdslen(o->ptr));
7908 buf = sdscatlen(buf,"\r\n",2);
7909 decrRefCount(o);
7910 }
7911
7912 /* Free the objects from the modified argv for EXPIREAT */
7913 if (cmd->proc == expireCommand) {
7914 for (j = 0; j < 3; j++)
7915 decrRefCount(argv[j]);
7916 }
7917
7918 /* We want to perform a single write. This should be guaranteed atomic
7919 * at least if the filesystem we are writing is a real physical one.
7920 * While this will save us against the server being killed I don't think
7921 * there is much to do about the whole server stopping for power problems
7922 * or alike */
7923 nwritten = write(server.appendfd,buf,sdslen(buf));
7924 if (nwritten != (signed)sdslen(buf)) {
7925 /* Ooops, we are in troubles. The best thing to do for now is
7926 * to simply exit instead to give the illusion that everything is
7927 * working as expected. */
7928 if (nwritten == -1) {
7929 redisLog(REDIS_WARNING,"Exiting on error writing to the append-only file: %s",strerror(errno));
7930 } else {
7931 redisLog(REDIS_WARNING,"Exiting on short write while writing to the append-only file: %s",strerror(errno));
7932 }
7933 exit(1);
7934 }
7935 /* If a background append only file rewriting is in progress we want to
7936 * accumulate the differences between the child DB and the current one
7937 * in a buffer, so that when the child process will do its work we
7938 * can append the differences to the new append only file. */
7939 if (server.bgrewritechildpid != -1)
7940 server.bgrewritebuf = sdscatlen(server.bgrewritebuf,buf,sdslen(buf));
7941
7942 sdsfree(buf);
7943 now = time(NULL);
7944 if (server.appendfsync == APPENDFSYNC_ALWAYS ||
7945 (server.appendfsync == APPENDFSYNC_EVERYSEC &&
7946 now-server.lastfsync > 1))
7947 {
7948 fsync(server.appendfd); /* Let's try to get this data on the disk */
7949 server.lastfsync = now;
7950 }
7951 }
7952
7953 /* In Redis commands are always executed in the context of a client, so in
7954 * order to load the append only file we need to create a fake client. */
7955 static struct redisClient *createFakeClient(void) {
7956 struct redisClient *c = zmalloc(sizeof(*c));
7957
7958 selectDb(c,0);
7959 c->fd = -1;
7960 c->querybuf = sdsempty();
7961 c->argc = 0;
7962 c->argv = NULL;
7963 c->flags = 0;
7964 /* We set the fake client as a slave waiting for the synchronization
7965 * so that Redis will not try to send replies to this client. */
7966 c->replstate = REDIS_REPL_WAIT_BGSAVE_START;
7967 c->reply = listCreate();
7968 listSetFreeMethod(c->reply,decrRefCount);
7969 listSetDupMethod(c->reply,dupClientReplyValue);
7970 return c;
7971 }
7972
7973 static void freeFakeClient(struct redisClient *c) {
7974 sdsfree(c->querybuf);
7975 listRelease(c->reply);
7976 zfree(c);
7977 }
7978
7979 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
7980 * error (the append only file is zero-length) REDIS_ERR is returned. On
7981 * fatal error an error message is logged and the program exists. */
7982 int loadAppendOnlyFile(char *filename) {
7983 struct redisClient *fakeClient;
7984 FILE *fp = fopen(filename,"r");
7985 struct redis_stat sb;
7986 unsigned long long loadedkeys = 0;
7987
7988 if (redis_fstat(fileno(fp),&sb) != -1 && sb.st_size == 0)
7989 return REDIS_ERR;
7990
7991 if (fp == NULL) {
7992 redisLog(REDIS_WARNING,"Fatal error: can't open the append log file for reading: %s",strerror(errno));
7993 exit(1);
7994 }
7995
7996 fakeClient = createFakeClient();
7997 while(1) {
7998 int argc, j;
7999 unsigned long len;
8000 robj **argv;
8001 char buf[128];
8002 sds argsds;
8003 struct redisCommand *cmd;
8004
8005 if (fgets(buf,sizeof(buf),fp) == NULL) {
8006 if (feof(fp))
8007 break;
8008 else
8009 goto readerr;
8010 }
8011 if (buf[0] != '*') goto fmterr;
8012 argc = atoi(buf+1);
8013 argv = zmalloc(sizeof(robj*)*argc);
8014 for (j = 0; j < argc; j++) {
8015 if (fgets(buf,sizeof(buf),fp) == NULL) goto readerr;
8016 if (buf[0] != '$') goto fmterr;
8017 len = strtol(buf+1,NULL,10);
8018 argsds = sdsnewlen(NULL,len);
8019 if (len && fread(argsds,len,1,fp) == 0) goto fmterr;
8020 argv[j] = createObject(REDIS_STRING,argsds);
8021 if (fread(buf,2,1,fp) == 0) goto fmterr; /* discard CRLF */
8022 }
8023
8024 /* Command lookup */
8025 cmd = lookupCommand(argv[0]->ptr);
8026 if (!cmd) {
8027 redisLog(REDIS_WARNING,"Unknown command '%s' reading the append only file", argv[0]->ptr);
8028 exit(1);
8029 }
8030 /* Try object encoding */
8031 if (cmd->flags & REDIS_CMD_BULK)
8032 argv[argc-1] = tryObjectEncoding(argv[argc-1]);
8033 /* Run the command in the context of a fake client */
8034 fakeClient->argc = argc;
8035 fakeClient->argv = argv;
8036 cmd->proc(fakeClient);
8037 /* Discard the reply objects list from the fake client */
8038 while(listLength(fakeClient->reply))
8039 listDelNode(fakeClient->reply,listFirst(fakeClient->reply));
8040 /* Clean up, ready for the next command */
8041 for (j = 0; j < argc; j++) decrRefCount(argv[j]);
8042 zfree(argv);
8043 /* Handle swapping while loading big datasets when VM is on */
8044 loadedkeys++;
8045 if (server.vm_enabled && (loadedkeys % 5000) == 0) {
8046 while (zmalloc_used_memory() > server.vm_max_memory) {
8047 if (vmSwapOneObjectBlocking() == REDIS_ERR) break;
8048 }
8049 }
8050 }
8051 fclose(fp);
8052 freeFakeClient(fakeClient);
8053 return REDIS_OK;
8054
8055 readerr:
8056 if (feof(fp)) {
8057 redisLog(REDIS_WARNING,"Unexpected end of file reading the append only file");
8058 } else {
8059 redisLog(REDIS_WARNING,"Unrecoverable error reading the append only file: %s", strerror(errno));
8060 }
8061 exit(1);
8062 fmterr:
8063 redisLog(REDIS_WARNING,"Bad file format reading the append only file");
8064 exit(1);
8065 }
8066
8067 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
8068 static int fwriteBulkObject(FILE *fp, robj *obj) {
8069 char buf[128];
8070 int decrrc = 0;
8071
8072 /* Avoid the incr/decr ref count business if possible to help
8073 * copy-on-write (we are often in a child process when this function
8074 * is called).
8075 * Also makes sure that key objects don't get incrRefCount-ed when VM
8076 * is enabled */
8077 if (obj->encoding != REDIS_ENCODING_RAW) {
8078 obj = getDecodedObject(obj);
8079 decrrc = 1;
8080 }
8081 snprintf(buf,sizeof(buf),"$%ld\r\n",(long)sdslen(obj->ptr));
8082 if (fwrite(buf,strlen(buf),1,fp) == 0) goto err;
8083 if (sdslen(obj->ptr) && fwrite(obj->ptr,sdslen(obj->ptr),1,fp) == 0)
8084 goto err;
8085 if (fwrite("\r\n",2,1,fp) == 0) goto err;
8086 if (decrrc) decrRefCount(obj);
8087 return 1;
8088 err:
8089 if (decrrc) decrRefCount(obj);
8090 return 0;
8091 }
8092
8093 /* Write binary-safe string into a file in the bulkformat
8094 * $<count>\r\n<payload>\r\n */
8095 static int fwriteBulkString(FILE *fp, char *s, unsigned long len) {
8096 char buf[128];
8097
8098 snprintf(buf,sizeof(buf),"$%ld\r\n",(unsigned long)len);
8099 if (fwrite(buf,strlen(buf),1,fp) == 0) return 0;
8100 if (len && fwrite(s,len,1,fp) == 0) return 0;
8101 if (fwrite("\r\n",2,1,fp) == 0) return 0;
8102 return 1;
8103 }
8104
8105 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
8106 static int fwriteBulkDouble(FILE *fp, double d) {
8107 char buf[128], dbuf[128];
8108
8109 snprintf(dbuf,sizeof(dbuf),"%.17g\r\n",d);
8110 snprintf(buf,sizeof(buf),"$%lu\r\n",(unsigned long)strlen(dbuf)-2);
8111 if (fwrite(buf,strlen(buf),1,fp) == 0) return 0;
8112 if (fwrite(dbuf,strlen(dbuf),1,fp) == 0) return 0;
8113 return 1;
8114 }
8115
8116 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
8117 static int fwriteBulkLong(FILE *fp, long l) {
8118 char buf[128], lbuf[128];
8119
8120 snprintf(lbuf,sizeof(lbuf),"%ld\r\n",l);
8121 snprintf(buf,sizeof(buf),"$%lu\r\n",(unsigned long)strlen(lbuf)-2);
8122 if (fwrite(buf,strlen(buf),1,fp) == 0) return 0;
8123 if (fwrite(lbuf,strlen(lbuf),1,fp) == 0) return 0;
8124 return 1;
8125 }
8126
8127 /* Write a sequence of commands able to fully rebuild the dataset into
8128 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
8129 static int rewriteAppendOnlyFile(char *filename) {
8130 dictIterator *di = NULL;
8131 dictEntry *de;
8132 FILE *fp;
8133 char tmpfile[256];
8134 int j;
8135 time_t now = time(NULL);
8136
8137 /* Note that we have to use a different temp name here compared to the
8138 * one used by rewriteAppendOnlyFileBackground() function. */
8139 snprintf(tmpfile,256,"temp-rewriteaof-%d.aof", (int) getpid());
8140 fp = fopen(tmpfile,"w");
8141 if (!fp) {
8142 redisLog(REDIS_WARNING, "Failed rewriting the append only file: %s", strerror(errno));
8143 return REDIS_ERR;
8144 }
8145 for (j = 0; j < server.dbnum; j++) {
8146 char selectcmd[] = "*2\r\n$6\r\nSELECT\r\n";
8147 redisDb *db = server.db+j;
8148 dict *d = db->dict;
8149 if (dictSize(d) == 0) continue;
8150 di = dictGetIterator(d);
8151 if (!di) {
8152 fclose(fp);
8153 return REDIS_ERR;
8154 }
8155
8156 /* SELECT the new DB */
8157 if (fwrite(selectcmd,sizeof(selectcmd)-1,1,fp) == 0) goto werr;
8158 if (fwriteBulkLong(fp,j) == 0) goto werr;
8159
8160 /* Iterate this DB writing every entry */
8161 while((de = dictNext(di)) != NULL) {
8162 robj *key, *o;
8163 time_t expiretime;
8164 int swapped;
8165
8166 key = dictGetEntryKey(de);
8167 /* If the value for this key is swapped, load a preview in memory.
8168 * We use a "swapped" flag to remember if we need to free the
8169 * value object instead to just increment the ref count anyway
8170 * in order to avoid copy-on-write of pages if we are forked() */
8171 if (!server.vm_enabled || key->storage == REDIS_VM_MEMORY ||
8172 key->storage == REDIS_VM_SWAPPING) {
8173 o = dictGetEntryVal(de);
8174 swapped = 0;
8175 } else {
8176 o = vmPreviewObject(key);
8177 swapped = 1;
8178 }
8179 expiretime = getExpire(db,key);
8180
8181 /* Save the key and associated value */
8182 if (o->type == REDIS_STRING) {
8183 /* Emit a SET command */
8184 char cmd[]="*3\r\n$3\r\nSET\r\n";
8185 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
8186 /* Key and value */
8187 if (fwriteBulkObject(fp,key) == 0) goto werr;
8188 if (fwriteBulkObject(fp,o) == 0) goto werr;
8189 } else if (o->type == REDIS_LIST) {
8190 /* Emit the RPUSHes needed to rebuild the list */
8191 list *list = o->ptr;
8192 listNode *ln;
8193 listIter li;
8194
8195 listRewind(list,&li);
8196 while((ln = listNext(&li))) {
8197 char cmd[]="*3\r\n$5\r\nRPUSH\r\n";
8198 robj *eleobj = listNodeValue(ln);
8199
8200 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
8201 if (fwriteBulkObject(fp,key) == 0) goto werr;
8202 if (fwriteBulkObject(fp,eleobj) == 0) goto werr;
8203 }
8204 } else if (o->type == REDIS_SET) {
8205 /* Emit the SADDs needed to rebuild the set */
8206 dict *set = o->ptr;
8207 dictIterator *di = dictGetIterator(set);
8208 dictEntry *de;
8209
8210 while((de = dictNext(di)) != NULL) {
8211 char cmd[]="*3\r\n$4\r\nSADD\r\n";
8212 robj *eleobj = dictGetEntryKey(de);
8213
8214 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
8215 if (fwriteBulkObject(fp,key) == 0) goto werr;
8216 if (fwriteBulkObject(fp,eleobj) == 0) goto werr;
8217 }
8218 dictReleaseIterator(di);
8219 } else if (o->type == REDIS_ZSET) {
8220 /* Emit the ZADDs needed to rebuild the sorted set */
8221 zset *zs = o->ptr;
8222 dictIterator *di = dictGetIterator(zs->dict);
8223 dictEntry *de;
8224
8225 while((de = dictNext(di)) != NULL) {
8226 char cmd[]="*4\r\n$4\r\nZADD\r\n";
8227 robj *eleobj = dictGetEntryKey(de);
8228 double *score = dictGetEntryVal(de);
8229
8230 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
8231 if (fwriteBulkObject(fp,key) == 0) goto werr;
8232 if (fwriteBulkDouble(fp,*score) == 0) goto werr;
8233 if (fwriteBulkObject(fp,eleobj) == 0) goto werr;
8234 }
8235 dictReleaseIterator(di);
8236 } else if (o->type == REDIS_HASH) {
8237 char cmd[]="*4\r\n$4\r\nHSET\r\n";
8238
8239 /* Emit the HSETs needed to rebuild the hash */
8240 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
8241 unsigned char *p = zipmapRewind(o->ptr);
8242 unsigned char *field, *val;
8243 unsigned int flen, vlen;
8244
8245 while((p = zipmapNext(p,&field,&flen,&val,&vlen)) != NULL) {
8246 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
8247 if (fwriteBulkObject(fp,key) == 0) goto werr;
8248 if (fwriteBulkString(fp,(char*)field,flen) == -1)
8249 return -1;
8250 if (fwriteBulkString(fp,(char*)val,vlen) == -1)
8251 return -1;
8252 }
8253 } else {
8254 dictIterator *di = dictGetIterator(o->ptr);
8255 dictEntry *de;
8256
8257 while((de = dictNext(di)) != NULL) {
8258 robj *field = dictGetEntryKey(de);
8259 robj *val = dictGetEntryVal(de);
8260
8261 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
8262 if (fwriteBulkObject(fp,key) == 0) goto werr;
8263 if (fwriteBulkObject(fp,field) == -1) return -1;
8264 if (fwriteBulkObject(fp,val) == -1) return -1;
8265 }
8266 dictReleaseIterator(di);
8267 }
8268 } else {
8269 redisPanic("Unknown object type");
8270 }
8271 /* Save the expire time */
8272 if (expiretime != -1) {
8273 char cmd[]="*3\r\n$8\r\nEXPIREAT\r\n";
8274 /* If this key is already expired skip it */
8275 if (expiretime < now) continue;
8276 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
8277 if (fwriteBulkObject(fp,key) == 0) goto werr;
8278 if (fwriteBulkLong(fp,expiretime) == 0) goto werr;
8279 }
8280 if (swapped) decrRefCount(o);
8281 }
8282 dictReleaseIterator(di);
8283 }
8284
8285 /* Make sure data will not remain on the OS's output buffers */
8286 fflush(fp);
8287 fsync(fileno(fp));
8288 fclose(fp);
8289
8290 /* Use RENAME to make sure the DB file is changed atomically only
8291 * if the generate DB file is ok. */
8292 if (rename(tmpfile,filename) == -1) {
8293 redisLog(REDIS_WARNING,"Error moving temp append only file on the final destination: %s", strerror(errno));
8294 unlink(tmpfile);
8295 return REDIS_ERR;
8296 }
8297 redisLog(REDIS_NOTICE,"SYNC append only file rewrite performed");
8298 return REDIS_OK;
8299
8300 werr:
8301 fclose(fp);
8302 unlink(tmpfile);
8303 redisLog(REDIS_WARNING,"Write error writing append only file on disk: %s", strerror(errno));
8304 if (di) dictReleaseIterator(di);
8305 return REDIS_ERR;
8306 }
8307
8308 /* This is how rewriting of the append only file in background works:
8309 *
8310 * 1) The user calls BGREWRITEAOF
8311 * 2) Redis calls this function, that forks():
8312 * 2a) the child rewrite the append only file in a temp file.
8313 * 2b) the parent accumulates differences in server.bgrewritebuf.
8314 * 3) When the child finished '2a' exists.
8315 * 4) The parent will trap the exit code, if it's OK, will append the
8316 * data accumulated into server.bgrewritebuf into the temp file, and
8317 * finally will rename(2) the temp file in the actual file name.
8318 * The the new file is reopened as the new append only file. Profit!
8319 */
8320 static int rewriteAppendOnlyFileBackground(void) {
8321 pid_t childpid;
8322
8323 if (server.bgrewritechildpid != -1) return REDIS_ERR;
8324 if (server.vm_enabled) waitEmptyIOJobsQueue();
8325 if ((childpid = fork()) == 0) {
8326 /* Child */
8327 char tmpfile[256];
8328
8329 if (server.vm_enabled) vmReopenSwapFile();
8330 close(server.fd);
8331 snprintf(tmpfile,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
8332 if (rewriteAppendOnlyFile(tmpfile) == REDIS_OK) {
8333 _exit(0);
8334 } else {
8335 _exit(1);
8336 }
8337 } else {
8338 /* Parent */
8339 if (childpid == -1) {
8340 redisLog(REDIS_WARNING,
8341 "Can't rewrite append only file in background: fork: %s",
8342 strerror(errno));
8343 return REDIS_ERR;
8344 }
8345 redisLog(REDIS_NOTICE,
8346 "Background append only file rewriting started by pid %d",childpid);
8347 server.bgrewritechildpid = childpid;
8348 updateDictResizePolicy();
8349 /* We set appendseldb to -1 in order to force the next call to the
8350 * feedAppendOnlyFile() to issue a SELECT command, so the differences
8351 * accumulated by the parent into server.bgrewritebuf will start
8352 * with a SELECT statement and it will be safe to merge. */
8353 server.appendseldb = -1;
8354 return REDIS_OK;
8355 }
8356 return REDIS_OK; /* unreached */
8357 }
8358
8359 static void bgrewriteaofCommand(redisClient *c) {
8360 if (server.bgrewritechildpid != -1) {
8361 addReplySds(c,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
8362 return;
8363 }
8364 if (rewriteAppendOnlyFileBackground() == REDIS_OK) {
8365 char *status = "+Background append only file rewriting started\r\n";
8366 addReplySds(c,sdsnew(status));
8367 } else {
8368 addReply(c,shared.err);
8369 }
8370 }
8371
8372 static void aofRemoveTempFile(pid_t childpid) {
8373 char tmpfile[256];
8374
8375 snprintf(tmpfile,256,"temp-rewriteaof-bg-%d.aof", (int) childpid);
8376 unlink(tmpfile);
8377 }
8378
8379 /* Virtual Memory is composed mainly of two subsystems:
8380 * - Blocking Virutal Memory
8381 * - Threaded Virtual Memory I/O
8382 * The two parts are not fully decoupled, but functions are split among two
8383 * different sections of the source code (delimited by comments) in order to
8384 * make more clear what functionality is about the blocking VM and what about
8385 * the threaded (not blocking) VM.
8386 *
8387 * Redis VM design:
8388 *
8389 * Redis VM is a blocking VM (one that blocks reading swapped values from
8390 * disk into memory when a value swapped out is needed in memory) that is made
8391 * unblocking by trying to examine the command argument vector in order to
8392 * load in background values that will likely be needed in order to exec
8393 * the command. The command is executed only once all the relevant keys
8394 * are loaded into memory.
8395 *
8396 * This basically is almost as simple of a blocking VM, but almost as parallel
8397 * as a fully non-blocking VM.
8398 */
8399
8400 /* =================== Virtual Memory - Blocking Side ====================== */
8401
8402 /* substitute the first occurrence of '%p' with the process pid in the
8403 * swap file name. */
8404 static void expandVmSwapFilename(void) {
8405 char *p = strstr(server.vm_swap_file,"%p");
8406 sds new;
8407
8408 if (!p) return;
8409 new = sdsempty();
8410 *p = '\0';
8411 new = sdscat(new,server.vm_swap_file);
8412 new = sdscatprintf(new,"%ld",(long) getpid());
8413 new = sdscat(new,p+2);
8414 zfree(server.vm_swap_file);
8415 server.vm_swap_file = new;
8416 }
8417
8418 static void vmInit(void) {
8419 off_t totsize;
8420 int pipefds[2];
8421 size_t stacksize;
8422
8423 if (server.vm_max_threads != 0)
8424 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
8425
8426 expandVmSwapFilename();
8427 redisLog(REDIS_NOTICE,"Using '%s' as swap file",server.vm_swap_file);
8428 if ((server.vm_fp = fopen(server.vm_swap_file,"r+b")) == NULL) {
8429 server.vm_fp = fopen(server.vm_swap_file,"w+b");
8430 }
8431 if (server.vm_fp == NULL) {
8432 redisLog(REDIS_WARNING,
8433 "Impossible to open the swap file: %s. Exiting.",
8434 strerror(errno));
8435 exit(1);
8436 }
8437 server.vm_fd = fileno(server.vm_fp);
8438 server.vm_next_page = 0;
8439 server.vm_near_pages = 0;
8440 server.vm_stats_used_pages = 0;
8441 server.vm_stats_swapped_objects = 0;
8442 server.vm_stats_swapouts = 0;
8443 server.vm_stats_swapins = 0;
8444 totsize = server.vm_pages*server.vm_page_size;
8445 redisLog(REDIS_NOTICE,"Allocating %lld bytes of swap file",totsize);
8446 if (ftruncate(server.vm_fd,totsize) == -1) {
8447 redisLog(REDIS_WARNING,"Can't ftruncate swap file: %s. Exiting.",
8448 strerror(errno));
8449 exit(1);
8450 } else {
8451 redisLog(REDIS_NOTICE,"Swap file allocated with success");
8452 }
8453 server.vm_bitmap = zmalloc((server.vm_pages+7)/8);
8454 redisLog(REDIS_VERBOSE,"Allocated %lld bytes page table for %lld pages",
8455 (long long) (server.vm_pages+7)/8, server.vm_pages);
8456 memset(server.vm_bitmap,0,(server.vm_pages+7)/8);
8457
8458 /* Initialize threaded I/O (used by Virtual Memory) */
8459 server.io_newjobs = listCreate();
8460 server.io_processing = listCreate();
8461 server.io_processed = listCreate();
8462 server.io_ready_clients = listCreate();
8463 pthread_mutex_init(&server.io_mutex,NULL);
8464 pthread_mutex_init(&server.obj_freelist_mutex,NULL);
8465 pthread_mutex_init(&server.io_swapfile_mutex,NULL);
8466 server.io_active_threads = 0;
8467 if (pipe(pipefds) == -1) {
8468 redisLog(REDIS_WARNING,"Unable to intialized VM: pipe(2): %s. Exiting."
8469 ,strerror(errno));
8470 exit(1);
8471 }
8472 server.io_ready_pipe_read = pipefds[0];
8473 server.io_ready_pipe_write = pipefds[1];
8474 redisAssert(anetNonBlock(NULL,server.io_ready_pipe_read) != ANET_ERR);
8475 /* LZF requires a lot of stack */
8476 pthread_attr_init(&server.io_threads_attr);
8477 pthread_attr_getstacksize(&server.io_threads_attr, &stacksize);
8478 while (stacksize < REDIS_THREAD_STACK_SIZE) stacksize *= 2;
8479 pthread_attr_setstacksize(&server.io_threads_attr, stacksize);
8480 /* Listen for events in the threaded I/O pipe */
8481 if (aeCreateFileEvent(server.el, server.io_ready_pipe_read, AE_READABLE,
8482 vmThreadedIOCompletedJob, NULL) == AE_ERR)
8483 oom("creating file event");
8484 }
8485
8486 /* Mark the page as used */
8487 static void vmMarkPageUsed(off_t page) {
8488 off_t byte = page/8;
8489 int bit = page&7;
8490 redisAssert(vmFreePage(page) == 1);
8491 server.vm_bitmap[byte] |= 1<<bit;
8492 }
8493
8494 /* Mark N contiguous pages as used, with 'page' being the first. */
8495 static void vmMarkPagesUsed(off_t page, off_t count) {
8496 off_t j;
8497
8498 for (j = 0; j < count; j++)
8499 vmMarkPageUsed(page+j);
8500 server.vm_stats_used_pages += count;
8501 redisLog(REDIS_DEBUG,"Mark USED pages: %lld pages at %lld\n",
8502 (long long)count, (long long)page);
8503 }
8504
8505 /* Mark the page as free */
8506 static void vmMarkPageFree(off_t page) {
8507 off_t byte = page/8;
8508 int bit = page&7;
8509 redisAssert(vmFreePage(page) == 0);
8510 server.vm_bitmap[byte] &= ~(1<<bit);
8511 }
8512
8513 /* Mark N contiguous pages as free, with 'page' being the first. */
8514 static void vmMarkPagesFree(off_t page, off_t count) {
8515 off_t j;
8516
8517 for (j = 0; j < count; j++)
8518 vmMarkPageFree(page+j);
8519 server.vm_stats_used_pages -= count;
8520 redisLog(REDIS_DEBUG,"Mark FREE pages: %lld pages at %lld\n",
8521 (long long)count, (long long)page);
8522 }
8523
8524 /* Test if the page is free */
8525 static int vmFreePage(off_t page) {
8526 off_t byte = page/8;
8527 int bit = page&7;
8528 return (server.vm_bitmap[byte] & (1<<bit)) == 0;
8529 }
8530
8531 /* Find N contiguous free pages storing the first page of the cluster in *first.
8532 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
8533 * REDIS_ERR is returned.
8534 *
8535 * This function uses a simple algorithm: we try to allocate
8536 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
8537 * again from the start of the swap file searching for free spaces.
8538 *
8539 * If it looks pretty clear that there are no free pages near our offset
8540 * we try to find less populated places doing a forward jump of
8541 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
8542 * without hurry, and then we jump again and so forth...
8543 *
8544 * This function can be improved using a free list to avoid to guess
8545 * too much, since we could collect data about freed pages.
8546 *
8547 * note: I implemented this function just after watching an episode of
8548 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
8549 */
8550 static int vmFindContiguousPages(off_t *first, off_t n) {
8551 off_t base, offset = 0, since_jump = 0, numfree = 0;
8552
8553 if (server.vm_near_pages == REDIS_VM_MAX_NEAR_PAGES) {
8554 server.vm_near_pages = 0;
8555 server.vm_next_page = 0;
8556 }
8557 server.vm_near_pages++; /* Yet another try for pages near to the old ones */
8558 base = server.vm_next_page;
8559
8560 while(offset < server.vm_pages) {
8561 off_t this = base+offset;
8562
8563 /* If we overflow, restart from page zero */
8564 if (this >= server.vm_pages) {
8565 this -= server.vm_pages;
8566 if (this == 0) {
8567 /* Just overflowed, what we found on tail is no longer
8568 * interesting, as it's no longer contiguous. */
8569 numfree = 0;
8570 }
8571 }
8572 if (vmFreePage(this)) {
8573 /* This is a free page */
8574 numfree++;
8575 /* Already got N free pages? Return to the caller, with success */
8576 if (numfree == n) {
8577 *first = this-(n-1);
8578 server.vm_next_page = this+1;
8579 redisLog(REDIS_DEBUG, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n, (long long) *first);
8580 return REDIS_OK;
8581 }
8582 } else {
8583 /* The current one is not a free page */
8584 numfree = 0;
8585 }
8586
8587 /* Fast-forward if the current page is not free and we already
8588 * searched enough near this place. */
8589 since_jump++;
8590 if (!numfree && since_jump >= REDIS_VM_MAX_RANDOM_JUMP/4) {
8591 offset += random() % REDIS_VM_MAX_RANDOM_JUMP;
8592 since_jump = 0;
8593 /* Note that even if we rewind after the jump, we are don't need
8594 * to make sure numfree is set to zero as we only jump *if* it
8595 * is set to zero. */
8596 } else {
8597 /* Otherwise just check the next page */
8598 offset++;
8599 }
8600 }
8601 return REDIS_ERR;
8602 }
8603
8604 /* Write the specified object at the specified page of the swap file */
8605 static int vmWriteObjectOnSwap(robj *o, off_t page) {
8606 if (server.vm_enabled) pthread_mutex_lock(&server.io_swapfile_mutex);
8607 if (fseeko(server.vm_fp,page*server.vm_page_size,SEEK_SET) == -1) {
8608 if (server.vm_enabled) pthread_mutex_unlock(&server.io_swapfile_mutex);
8609 redisLog(REDIS_WARNING,
8610 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
8611 strerror(errno));
8612 return REDIS_ERR;
8613 }
8614 rdbSaveObject(server.vm_fp,o);
8615 fflush(server.vm_fp);
8616 if (server.vm_enabled) pthread_mutex_unlock(&server.io_swapfile_mutex);
8617 return REDIS_OK;
8618 }
8619
8620 /* Swap the 'val' object relative to 'key' into disk. Store all the information
8621 * needed to later retrieve the object into the key object.
8622 * If we can't find enough contiguous empty pages to swap the object on disk
8623 * REDIS_ERR is returned. */
8624 static int vmSwapObjectBlocking(robj *key, robj *val) {
8625 off_t pages = rdbSavedObjectPages(val,NULL);
8626 off_t page;
8627
8628 assert(key->storage == REDIS_VM_MEMORY);
8629 assert(key->refcount == 1);
8630 if (vmFindContiguousPages(&page,pages) == REDIS_ERR) return REDIS_ERR;
8631 if (vmWriteObjectOnSwap(val,page) == REDIS_ERR) return REDIS_ERR;
8632 key->vm.page = page;
8633 key->vm.usedpages = pages;
8634 key->storage = REDIS_VM_SWAPPED;
8635 key->vtype = val->type;
8636 decrRefCount(val); /* Deallocate the object from memory. */
8637 vmMarkPagesUsed(page,pages);
8638 redisLog(REDIS_DEBUG,"VM: object %s swapped out at %lld (%lld pages)",
8639 (unsigned char*) key->ptr,
8640 (unsigned long long) page, (unsigned long long) pages);
8641 server.vm_stats_swapped_objects++;
8642 server.vm_stats_swapouts++;
8643 return REDIS_OK;
8644 }
8645
8646 static robj *vmReadObjectFromSwap(off_t page, int type) {
8647 robj *o;
8648
8649 if (server.vm_enabled) pthread_mutex_lock(&server.io_swapfile_mutex);
8650 if (fseeko(server.vm_fp,page*server.vm_page_size,SEEK_SET) == -1) {
8651 redisLog(REDIS_WARNING,
8652 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
8653 strerror(errno));
8654 _exit(1);
8655 }
8656 o = rdbLoadObject(type,server.vm_fp);
8657 if (o == NULL) {
8658 redisLog(REDIS_WARNING, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno));
8659 _exit(1);
8660 }
8661 if (server.vm_enabled) pthread_mutex_unlock(&server.io_swapfile_mutex);
8662 return o;
8663 }
8664
8665 /* Load the value object relative to the 'key' object from swap to memory.
8666 * The newly allocated object is returned.
8667 *
8668 * If preview is true the unserialized object is returned to the caller but
8669 * no changes are made to the key object, nor the pages are marked as freed */
8670 static robj *vmGenericLoadObject(robj *key, int preview) {
8671 robj *val;
8672
8673 redisAssert(key->storage == REDIS_VM_SWAPPED || key->storage == REDIS_VM_LOADING);
8674 val = vmReadObjectFromSwap(key->vm.page,key->vtype);
8675 if (!preview) {
8676 key->storage = REDIS_VM_MEMORY;
8677 key->vm.atime = server.unixtime;
8678 vmMarkPagesFree(key->vm.page,key->vm.usedpages);
8679 redisLog(REDIS_DEBUG, "VM: object %s loaded from disk",
8680 (unsigned char*) key->ptr);
8681 server.vm_stats_swapped_objects--;
8682 } else {
8683 redisLog(REDIS_DEBUG, "VM: object %s previewed from disk",
8684 (unsigned char*) key->ptr);
8685 }
8686 server.vm_stats_swapins++;
8687 return val;
8688 }
8689
8690 /* Plain object loading, from swap to memory */
8691 static robj *vmLoadObject(robj *key) {
8692 /* If we are loading the object in background, stop it, we
8693 * need to load this object synchronously ASAP. */
8694 if (key->storage == REDIS_VM_LOADING)
8695 vmCancelThreadedIOJob(key);
8696 return vmGenericLoadObject(key,0);
8697 }
8698
8699 /* Just load the value on disk, without to modify the key.
8700 * This is useful when we want to perform some operation on the value
8701 * without to really bring it from swap to memory, like while saving the
8702 * dataset or rewriting the append only log. */
8703 static robj *vmPreviewObject(robj *key) {
8704 return vmGenericLoadObject(key,1);
8705 }
8706
8707 /* How a good candidate is this object for swapping?
8708 * The better candidate it is, the greater the returned value.
8709 *
8710 * Currently we try to perform a fast estimation of the object size in
8711 * memory, and combine it with aging informations.
8712 *
8713 * Basically swappability = idle-time * log(estimated size)
8714 *
8715 * Bigger objects are preferred over smaller objects, but not
8716 * proportionally, this is why we use the logarithm. This algorithm is
8717 * just a first try and will probably be tuned later. */
8718 static double computeObjectSwappability(robj *o) {
8719 time_t age = server.unixtime - o->vm.atime;
8720 long asize = 0;
8721 list *l;
8722 dict *d;
8723 struct dictEntry *de;
8724 int z;
8725
8726 if (age <= 0) return 0;
8727 switch(o->type) {
8728 case REDIS_STRING:
8729 if (o->encoding != REDIS_ENCODING_RAW) {
8730 asize = sizeof(*o);
8731 } else {
8732 asize = sdslen(o->ptr)+sizeof(*o)+sizeof(long)*2;
8733 }
8734 break;
8735 case REDIS_LIST:
8736 l = o->ptr;
8737 listNode *ln = listFirst(l);
8738
8739 asize = sizeof(list);
8740 if (ln) {
8741 robj *ele = ln->value;
8742 long elesize;
8743
8744 elesize = (ele->encoding == REDIS_ENCODING_RAW) ?
8745 (sizeof(*o)+sdslen(ele->ptr)) :
8746 sizeof(*o);
8747 asize += (sizeof(listNode)+elesize)*listLength(l);
8748 }
8749 break;
8750 case REDIS_SET:
8751 case REDIS_ZSET:
8752 z = (o->type == REDIS_ZSET);
8753 d = z ? ((zset*)o->ptr)->dict : o->ptr;
8754
8755 asize = sizeof(dict)+(sizeof(struct dictEntry*)*dictSlots(d));
8756 if (z) asize += sizeof(zset)-sizeof(dict);
8757 if (dictSize(d)) {
8758 long elesize;
8759 robj *ele;
8760
8761 de = dictGetRandomKey(d);
8762 ele = dictGetEntryKey(de);
8763 elesize = (ele->encoding == REDIS_ENCODING_RAW) ?
8764 (sizeof(*o)+sdslen(ele->ptr)) :
8765 sizeof(*o);
8766 asize += (sizeof(struct dictEntry)+elesize)*dictSize(d);
8767 if (z) asize += sizeof(zskiplistNode)*dictSize(d);
8768 }
8769 break;
8770 case REDIS_HASH:
8771 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
8772 unsigned char *p = zipmapRewind((unsigned char*)o->ptr);
8773 unsigned int len = zipmapLen((unsigned char*)o->ptr);
8774 unsigned int klen, vlen;
8775 unsigned char *key, *val;
8776
8777 if ((p = zipmapNext(p,&key,&klen,&val,&vlen)) == NULL) {
8778 klen = 0;
8779 vlen = 0;
8780 }
8781 asize = len*(klen+vlen+3);
8782 } else if (o->encoding == REDIS_ENCODING_HT) {
8783 d = o->ptr;
8784 asize = sizeof(dict)+(sizeof(struct dictEntry*)*dictSlots(d));
8785 if (dictSize(d)) {
8786 long elesize;
8787 robj *ele;
8788
8789 de = dictGetRandomKey(d);
8790 ele = dictGetEntryKey(de);
8791 elesize = (ele->encoding == REDIS_ENCODING_RAW) ?
8792 (sizeof(*o)+sdslen(ele->ptr)) :
8793 sizeof(*o);
8794 ele = dictGetEntryVal(de);
8795 elesize = (ele->encoding == REDIS_ENCODING_RAW) ?
8796 (sizeof(*o)+sdslen(ele->ptr)) :
8797 sizeof(*o);
8798 asize += (sizeof(struct dictEntry)+elesize)*dictSize(d);
8799 }
8800 }
8801 break;
8802 }
8803 return (double)age*log(1+asize);
8804 }
8805
8806 /* Try to swap an object that's a good candidate for swapping.
8807 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
8808 * to swap any object at all.
8809 *
8810 * If 'usethreaded' is true, Redis will try to swap the object in background
8811 * using I/O threads. */
8812 static int vmSwapOneObject(int usethreads) {
8813 int j, i;
8814 struct dictEntry *best = NULL;
8815 double best_swappability = 0;
8816 redisDb *best_db = NULL;
8817 robj *key, *val;
8818
8819 for (j = 0; j < server.dbnum; j++) {
8820 redisDb *db = server.db+j;
8821 /* Why maxtries is set to 100?
8822 * Because this way (usually) we'll find 1 object even if just 1% - 2%
8823 * are swappable objects */
8824 int maxtries = 100;
8825
8826 if (dictSize(db->dict) == 0) continue;
8827 for (i = 0; i < 5; i++) {
8828 dictEntry *de;
8829 double swappability;
8830
8831 if (maxtries) maxtries--;
8832 de = dictGetRandomKey(db->dict);
8833 key = dictGetEntryKey(de);
8834 val = dictGetEntryVal(de);
8835 /* Only swap objects that are currently in memory.
8836 *
8837 * Also don't swap shared objects if threaded VM is on, as we
8838 * try to ensure that the main thread does not touch the
8839 * object while the I/O thread is using it, but we can't
8840 * control other keys without adding additional mutex. */
8841 if (key->storage != REDIS_VM_MEMORY ||
8842 (server.vm_max_threads != 0 && val->refcount != 1)) {
8843 if (maxtries) i--; /* don't count this try */
8844 continue;
8845 }
8846 swappability = computeObjectSwappability(val);
8847 if (!best || swappability > best_swappability) {
8848 best = de;
8849 best_swappability = swappability;
8850 best_db = db;
8851 }
8852 }
8853 }
8854 if (best == NULL) return REDIS_ERR;
8855 key = dictGetEntryKey(best);
8856 val = dictGetEntryVal(best);
8857
8858 redisLog(REDIS_DEBUG,"Key with best swappability: %s, %f",
8859 key->ptr, best_swappability);
8860
8861 /* Unshare the key if needed */
8862 if (key->refcount > 1) {
8863 robj *newkey = dupStringObject(key);
8864 decrRefCount(key);
8865 key = dictGetEntryKey(best) = newkey;
8866 }
8867 /* Swap it */
8868 if (usethreads) {
8869 vmSwapObjectThreaded(key,val,best_db);
8870 return REDIS_OK;
8871 } else {
8872 if (vmSwapObjectBlocking(key,val) == REDIS_OK) {
8873 dictGetEntryVal(best) = NULL;
8874 return REDIS_OK;
8875 } else {
8876 return REDIS_ERR;
8877 }
8878 }
8879 }
8880
8881 static int vmSwapOneObjectBlocking() {
8882 return vmSwapOneObject(0);
8883 }
8884
8885 static int vmSwapOneObjectThreaded() {
8886 return vmSwapOneObject(1);
8887 }
8888
8889 /* Return true if it's safe to swap out objects in a given moment.
8890 * Basically we don't want to swap objects out while there is a BGSAVE
8891 * or a BGAEOREWRITE running in backgroud. */
8892 static int vmCanSwapOut(void) {
8893 return (server.bgsavechildpid == -1 && server.bgrewritechildpid == -1);
8894 }
8895
8896 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
8897 * and was deleted. Otherwise 0 is returned. */
8898 static int deleteIfSwapped(redisDb *db, robj *key) {
8899 dictEntry *de;
8900 robj *foundkey;
8901
8902 if ((de = dictFind(db->dict,key)) == NULL) return 0;
8903 foundkey = dictGetEntryKey(de);
8904 if (foundkey->storage == REDIS_VM_MEMORY) return 0;
8905 deleteKey(db,key);
8906 return 1;
8907 }
8908
8909 /* =================== Virtual Memory - Threaded I/O ======================= */
8910
8911 static void freeIOJob(iojob *j) {
8912 if ((j->type == REDIS_IOJOB_PREPARE_SWAP ||
8913 j->type == REDIS_IOJOB_DO_SWAP ||
8914 j->type == REDIS_IOJOB_LOAD) && j->val != NULL)
8915 decrRefCount(j->val);
8916 /* We don't decrRefCount the j->key field as we did't incremented
8917 * the count creating IO Jobs. This is because the key field here is
8918 * just used as an indentifier and if a key is removed the Job should
8919 * never be touched again. */
8920 zfree(j);
8921 }
8922
8923 /* Every time a thread finished a Job, it writes a byte into the write side
8924 * of an unix pipe in order to "awake" the main thread, and this function
8925 * is called. */
8926 static void vmThreadedIOCompletedJob(aeEventLoop *el, int fd, void *privdata,
8927 int mask)
8928 {
8929 char buf[1];
8930 int retval, processed = 0, toprocess = -1, trytoswap = 1;
8931 REDIS_NOTUSED(el);
8932 REDIS_NOTUSED(mask);
8933 REDIS_NOTUSED(privdata);
8934
8935 /* For every byte we read in the read side of the pipe, there is one
8936 * I/O job completed to process. */
8937 while((retval = read(fd,buf,1)) == 1) {
8938 iojob *j;
8939 listNode *ln;
8940 robj *key;
8941 struct dictEntry *de;
8942
8943 redisLog(REDIS_DEBUG,"Processing I/O completed job");
8944
8945 /* Get the processed element (the oldest one) */
8946 lockThreadedIO();
8947 assert(listLength(server.io_processed) != 0);
8948 if (toprocess == -1) {
8949 toprocess = (listLength(server.io_processed)*REDIS_MAX_COMPLETED_JOBS_PROCESSED)/100;
8950 if (toprocess <= 0) toprocess = 1;
8951 }
8952 ln = listFirst(server.io_processed);
8953 j = ln->value;
8954 listDelNode(server.io_processed,ln);
8955 unlockThreadedIO();
8956 /* If this job is marked as canceled, just ignore it */
8957 if (j->canceled) {
8958 freeIOJob(j);
8959 continue;
8960 }
8961 /* Post process it in the main thread, as there are things we
8962 * can do just here to avoid race conditions and/or invasive locks */
8963 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);
8964 de = dictFind(j->db->dict,j->key);
8965 assert(de != NULL);
8966 key = dictGetEntryKey(de);
8967 if (j->type == REDIS_IOJOB_LOAD) {
8968 redisDb *db;
8969
8970 /* Key loaded, bring it at home */
8971 key->storage = REDIS_VM_MEMORY;
8972 key->vm.atime = server.unixtime;
8973 vmMarkPagesFree(key->vm.page,key->vm.usedpages);
8974 redisLog(REDIS_DEBUG, "VM: object %s loaded from disk (threaded)",
8975 (unsigned char*) key->ptr);
8976 server.vm_stats_swapped_objects--;
8977 server.vm_stats_swapins++;
8978 dictGetEntryVal(de) = j->val;
8979 incrRefCount(j->val);
8980 db = j->db;
8981 freeIOJob(j);
8982 /* Handle clients waiting for this key to be loaded. */
8983 handleClientsBlockedOnSwappedKey(db,key);
8984 } else if (j->type == REDIS_IOJOB_PREPARE_SWAP) {
8985 /* Now we know the amount of pages required to swap this object.
8986 * Let's find some space for it, and queue this task again
8987 * rebranded as REDIS_IOJOB_DO_SWAP. */
8988 if (!vmCanSwapOut() ||
8989 vmFindContiguousPages(&j->page,j->pages) == REDIS_ERR)
8990 {
8991 /* Ooops... no space or we can't swap as there is
8992 * a fork()ed Redis trying to save stuff on disk. */
8993 freeIOJob(j);
8994 key->storage = REDIS_VM_MEMORY; /* undo operation */
8995 } else {
8996 /* Note that we need to mark this pages as used now,
8997 * if the job will be canceled, we'll mark them as freed
8998 * again. */
8999 vmMarkPagesUsed(j->page,j->pages);
9000 j->type = REDIS_IOJOB_DO_SWAP;
9001 lockThreadedIO();
9002 queueIOJob(j);
9003 unlockThreadedIO();
9004 }
9005 } else if (j->type == REDIS_IOJOB_DO_SWAP) {
9006 robj *val;
9007
9008 /* Key swapped. We can finally free some memory. */
9009 if (key->storage != REDIS_VM_SWAPPING) {
9010 printf("key->storage: %d\n",key->storage);
9011 printf("key->name: %s\n",(char*)key->ptr);
9012 printf("key->refcount: %d\n",key->refcount);
9013 printf("val: %p\n",(void*)j->val);
9014 printf("val->type: %d\n",j->val->type);
9015 printf("val->ptr: %s\n",(char*)j->val->ptr);
9016 }
9017 redisAssert(key->storage == REDIS_VM_SWAPPING);
9018 val = dictGetEntryVal(de);
9019 key->vm.page = j->page;
9020 key->vm.usedpages = j->pages;
9021 key->storage = REDIS_VM_SWAPPED;
9022 key->vtype = j->val->type;
9023 decrRefCount(val); /* Deallocate the object from memory. */
9024 dictGetEntryVal(de) = NULL;
9025 redisLog(REDIS_DEBUG,
9026 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
9027 (unsigned char*) key->ptr,
9028 (unsigned long long) j->page, (unsigned long long) j->pages);
9029 server.vm_stats_swapped_objects++;
9030 server.vm_stats_swapouts++;
9031 freeIOJob(j);
9032 /* Put a few more swap requests in queue if we are still
9033 * out of memory */
9034 if (trytoswap && vmCanSwapOut() &&
9035 zmalloc_used_memory() > server.vm_max_memory)
9036 {
9037 int more = 1;
9038 while(more) {
9039 lockThreadedIO();
9040 more = listLength(server.io_newjobs) <
9041 (unsigned) server.vm_max_threads;
9042 unlockThreadedIO();
9043 /* Don't waste CPU time if swappable objects are rare. */
9044 if (vmSwapOneObjectThreaded() == REDIS_ERR) {
9045 trytoswap = 0;
9046 break;
9047 }
9048 }
9049 }
9050 }
9051 processed++;
9052 if (processed == toprocess) return;
9053 }
9054 if (retval < 0 && errno != EAGAIN) {
9055 redisLog(REDIS_WARNING,
9056 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
9057 strerror(errno));
9058 }
9059 }
9060
9061 static void lockThreadedIO(void) {
9062 pthread_mutex_lock(&server.io_mutex);
9063 }
9064
9065 static void unlockThreadedIO(void) {
9066 pthread_mutex_unlock(&server.io_mutex);
9067 }
9068
9069 /* Remove the specified object from the threaded I/O queue if still not
9070 * processed, otherwise make sure to flag it as canceled. */
9071 static void vmCancelThreadedIOJob(robj *o) {
9072 list *lists[3] = {
9073 server.io_newjobs, /* 0 */
9074 server.io_processing, /* 1 */
9075 server.io_processed /* 2 */
9076 };
9077 int i;
9078
9079 assert(o->storage == REDIS_VM_LOADING || o->storage == REDIS_VM_SWAPPING);
9080 again:
9081 lockThreadedIO();
9082 /* Search for a matching key in one of the queues */
9083 for (i = 0; i < 3; i++) {
9084 listNode *ln;
9085 listIter li;
9086
9087 listRewind(lists[i],&li);
9088 while ((ln = listNext(&li)) != NULL) {
9089 iojob *job = ln->value;
9090
9091 if (job->canceled) continue; /* Skip this, already canceled. */
9092 if (job->key == o) {
9093 redisLog(REDIS_DEBUG,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
9094 (void*)job, (char*)o->ptr, job->type, i);
9095 /* Mark the pages as free since the swap didn't happened
9096 * or happened but is now discarded. */
9097 if (i != 1 && job->type == REDIS_IOJOB_DO_SWAP)
9098 vmMarkPagesFree(job->page,job->pages);
9099 /* Cancel the job. It depends on the list the job is
9100 * living in. */
9101 switch(i) {
9102 case 0: /* io_newjobs */
9103 /* If the job was yet not processed the best thing to do
9104 * is to remove it from the queue at all */
9105 freeIOJob(job);
9106 listDelNode(lists[i],ln);
9107 break;
9108 case 1: /* io_processing */
9109 /* Oh Shi- the thread is messing with the Job:
9110 *
9111 * Probably it's accessing the object if this is a
9112 * PREPARE_SWAP or DO_SWAP job.
9113 * If it's a LOAD job it may be reading from disk and
9114 * if we don't wait for the job to terminate before to
9115 * cancel it, maybe in a few microseconds data can be
9116 * corrupted in this pages. So the short story is:
9117 *
9118 * Better to wait for the job to move into the
9119 * next queue (processed)... */
9120
9121 /* We try again and again until the job is completed. */
9122 unlockThreadedIO();
9123 /* But let's wait some time for the I/O thread
9124 * to finish with this job. After all this condition
9125 * should be very rare. */
9126 usleep(1);
9127 goto again;
9128 case 2: /* io_processed */
9129 /* The job was already processed, that's easy...
9130 * just mark it as canceled so that we'll ignore it
9131 * when processing completed jobs. */
9132 job->canceled = 1;
9133 break;
9134 }
9135 /* Finally we have to adjust the storage type of the object
9136 * in order to "UNDO" the operaiton. */
9137 if (o->storage == REDIS_VM_LOADING)
9138 o->storage = REDIS_VM_SWAPPED;
9139 else if (o->storage == REDIS_VM_SWAPPING)
9140 o->storage = REDIS_VM_MEMORY;
9141 unlockThreadedIO();
9142 return;
9143 }
9144 }
9145 }
9146 unlockThreadedIO();
9147 assert(1 != 1); /* We should never reach this */
9148 }
9149
9150 static void *IOThreadEntryPoint(void *arg) {
9151 iojob *j;
9152 listNode *ln;
9153 REDIS_NOTUSED(arg);
9154
9155 pthread_detach(pthread_self());
9156 while(1) {
9157 /* Get a new job to process */
9158 lockThreadedIO();
9159 if (listLength(server.io_newjobs) == 0) {
9160 /* No new jobs in queue, exit. */
9161 redisLog(REDIS_DEBUG,"Thread %ld exiting, nothing to do",
9162 (long) pthread_self());
9163 server.io_active_threads--;
9164 unlockThreadedIO();
9165 return NULL;
9166 }
9167 ln = listFirst(server.io_newjobs);
9168 j = ln->value;
9169 listDelNode(server.io_newjobs,ln);
9170 /* Add the job in the processing queue */
9171 j->thread = pthread_self();
9172 listAddNodeTail(server.io_processing,j);
9173 ln = listLast(server.io_processing); /* We use ln later to remove it */
9174 unlockThreadedIO();
9175 redisLog(REDIS_DEBUG,"Thread %ld got a new job (type %d): %p about key '%s'",
9176 (long) pthread_self(), j->type, (void*)j, (char*)j->key->ptr);
9177
9178 /* Process the Job */
9179 if (j->type == REDIS_IOJOB_LOAD) {
9180 j->val = vmReadObjectFromSwap(j->page,j->key->vtype);
9181 } else if (j->type == REDIS_IOJOB_PREPARE_SWAP) {
9182 FILE *fp = fopen("/dev/null","w+");
9183 j->pages = rdbSavedObjectPages(j->val,fp);
9184 fclose(fp);
9185 } else if (j->type == REDIS_IOJOB_DO_SWAP) {
9186 if (vmWriteObjectOnSwap(j->val,j->page) == REDIS_ERR)
9187 j->canceled = 1;
9188 }
9189
9190 /* Done: insert the job into the processed queue */
9191 redisLog(REDIS_DEBUG,"Thread %ld completed the job: %p (key %s)",
9192 (long) pthread_self(), (void*)j, (char*)j->key->ptr);
9193 lockThreadedIO();
9194 listDelNode(server.io_processing,ln);
9195 listAddNodeTail(server.io_processed,j);
9196 unlockThreadedIO();
9197
9198 /* Signal the main thread there is new stuff to process */
9199 assert(write(server.io_ready_pipe_write,"x",1) == 1);
9200 }
9201 return NULL; /* never reached */
9202 }
9203
9204 static void spawnIOThread(void) {
9205 pthread_t thread;
9206 sigset_t mask, omask;
9207 int err;
9208
9209 sigemptyset(&mask);
9210 sigaddset(&mask,SIGCHLD);
9211 sigaddset(&mask,SIGHUP);
9212 sigaddset(&mask,SIGPIPE);
9213 pthread_sigmask(SIG_SETMASK, &mask, &omask);
9214 while ((err = pthread_create(&thread,&server.io_threads_attr,IOThreadEntryPoint,NULL)) != 0) {
9215 redisLog(REDIS_WARNING,"Unable to spawn an I/O thread: %s",
9216 strerror(err));
9217 usleep(1000000);
9218 }
9219 pthread_sigmask(SIG_SETMASK, &omask, NULL);
9220 server.io_active_threads++;
9221 }
9222
9223 /* We need to wait for the last thread to exit before we are able to
9224 * fork() in order to BGSAVE or BGREWRITEAOF. */
9225 static void waitEmptyIOJobsQueue(void) {
9226 while(1) {
9227 int io_processed_len;
9228
9229 lockThreadedIO();
9230 if (listLength(server.io_newjobs) == 0 &&
9231 listLength(server.io_processing) == 0 &&
9232 server.io_active_threads == 0)
9233 {
9234 unlockThreadedIO();
9235 return;
9236 }
9237 /* While waiting for empty jobs queue condition we post-process some
9238 * finshed job, as I/O threads may be hanging trying to write against
9239 * the io_ready_pipe_write FD but there are so much pending jobs that
9240 * it's blocking. */
9241 io_processed_len = listLength(server.io_processed);
9242 unlockThreadedIO();
9243 if (io_processed_len) {
9244 vmThreadedIOCompletedJob(NULL,server.io_ready_pipe_read,NULL,0);
9245 usleep(1000); /* 1 millisecond */
9246 } else {
9247 usleep(10000); /* 10 milliseconds */
9248 }
9249 }
9250 }
9251
9252 static void vmReopenSwapFile(void) {
9253 /* Note: we don't close the old one as we are in the child process
9254 * and don't want to mess at all with the original file object. */
9255 server.vm_fp = fopen(server.vm_swap_file,"r+b");
9256 if (server.vm_fp == NULL) {
9257 redisLog(REDIS_WARNING,"Can't re-open the VM swap file: %s. Exiting.",
9258 server.vm_swap_file);
9259 _exit(1);
9260 }
9261 server.vm_fd = fileno(server.vm_fp);
9262 }
9263
9264 /* This function must be called while with threaded IO locked */
9265 static void queueIOJob(iojob *j) {
9266 redisLog(REDIS_DEBUG,"Queued IO Job %p type %d about key '%s'\n",
9267 (void*)j, j->type, (char*)j->key->ptr);
9268 listAddNodeTail(server.io_newjobs,j);
9269 if (server.io_active_threads < server.vm_max_threads)
9270 spawnIOThread();
9271 }
9272
9273 static int vmSwapObjectThreaded(robj *key, robj *val, redisDb *db) {
9274 iojob *j;
9275
9276 assert(key->storage == REDIS_VM_MEMORY);
9277 assert(key->refcount == 1);
9278
9279 j = zmalloc(sizeof(*j));
9280 j->type = REDIS_IOJOB_PREPARE_SWAP;
9281 j->db = db;
9282 j->key = key;
9283 j->val = val;
9284 incrRefCount(val);
9285 j->canceled = 0;
9286 j->thread = (pthread_t) -1;
9287 key->storage = REDIS_VM_SWAPPING;
9288
9289 lockThreadedIO();
9290 queueIOJob(j);
9291 unlockThreadedIO();
9292 return REDIS_OK;
9293 }
9294
9295 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
9296
9297 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
9298 * If there is not already a job loading the key, it is craeted.
9299 * The key is added to the io_keys list in the client structure, and also
9300 * in the hash table mapping swapped keys to waiting clients, that is,
9301 * server.io_waited_keys. */
9302 static int waitForSwappedKey(redisClient *c, robj *key) {
9303 struct dictEntry *de;
9304 robj *o;
9305 list *l;
9306
9307 /* If the key does not exist or is already in RAM we don't need to
9308 * block the client at all. */
9309 de = dictFind(c->db->dict,key);
9310 if (de == NULL) return 0;
9311 o = dictGetEntryKey(de);
9312 if (o->storage == REDIS_VM_MEMORY) {
9313 return 0;
9314 } else if (o->storage == REDIS_VM_SWAPPING) {
9315 /* We were swapping the key, undo it! */
9316 vmCancelThreadedIOJob(o);
9317 return 0;
9318 }
9319
9320 /* OK: the key is either swapped, or being loaded just now. */
9321
9322 /* Add the key to the list of keys this client is waiting for.
9323 * This maps clients to keys they are waiting for. */
9324 listAddNodeTail(c->io_keys,key);
9325 incrRefCount(key);
9326
9327 /* Add the client to the swapped keys => clients waiting map. */
9328 de = dictFind(c->db->io_keys,key);
9329 if (de == NULL) {
9330 int retval;
9331
9332 /* For every key we take a list of clients blocked for it */
9333 l = listCreate();
9334 retval = dictAdd(c->db->io_keys,key,l);
9335 incrRefCount(key);
9336 assert(retval == DICT_OK);
9337 } else {
9338 l = dictGetEntryVal(de);
9339 }
9340 listAddNodeTail(l,c);
9341
9342 /* Are we already loading the key from disk? If not create a job */
9343 if (o->storage == REDIS_VM_SWAPPED) {
9344 iojob *j;
9345
9346 o->storage = REDIS_VM_LOADING;
9347 j = zmalloc(sizeof(*j));
9348 j->type = REDIS_IOJOB_LOAD;
9349 j->db = c->db;
9350 j->key = o;
9351 j->key->vtype = o->vtype;
9352 j->page = o->vm.page;
9353 j->val = NULL;
9354 j->canceled = 0;
9355 j->thread = (pthread_t) -1;
9356 lockThreadedIO();
9357 queueIOJob(j);
9358 unlockThreadedIO();
9359 }
9360 return 1;
9361 }
9362
9363 /* Preload keys needed for the ZUNION and ZINTER commands. */
9364 static void zunionInterBlockClientOnSwappedKeys(redisClient *c) {
9365 int i, num;
9366 num = atoi(c->argv[2]->ptr);
9367 for (i = 0; i < num; i++) {
9368 waitForSwappedKey(c,c->argv[3+i]);
9369 }
9370 }
9371
9372 /* Is this client attempting to run a command against swapped keys?
9373 * If so, block it ASAP, load the keys in background, then resume it.
9374 *
9375 * The important idea about this function is that it can fail! If keys will
9376 * still be swapped when the client is resumed, this key lookups will
9377 * just block loading keys from disk. In practical terms this should only
9378 * happen with SORT BY command or if there is a bug in this function.
9379 *
9380 * Return 1 if the client is marked as blocked, 0 if the client can
9381 * continue as the keys it is going to access appear to be in memory. */
9382 static int blockClientOnSwappedKeys(struct redisCommand *cmd, redisClient *c) {
9383 int j, last;
9384
9385 if (cmd->vm_preload_proc != NULL) {
9386 cmd->vm_preload_proc(c);
9387 } else {
9388 if (cmd->vm_firstkey == 0) return 0;
9389 last = cmd->vm_lastkey;
9390 if (last < 0) last = c->argc+last;
9391 for (j = cmd->vm_firstkey; j <= last; j += cmd->vm_keystep)
9392 waitForSwappedKey(c,c->argv[j]);
9393 }
9394
9395 /* If the client was blocked for at least one key, mark it as blocked. */
9396 if (listLength(c->io_keys)) {
9397 c->flags |= REDIS_IO_WAIT;
9398 aeDeleteFileEvent(server.el,c->fd,AE_READABLE);
9399 server.vm_blocked_clients++;
9400 return 1;
9401 } else {
9402 return 0;
9403 }
9404 }
9405
9406 /* Remove the 'key' from the list of blocked keys for a given client.
9407 *
9408 * The function returns 1 when there are no longer blocking keys after
9409 * the current one was removed (and the client can be unblocked). */
9410 static int dontWaitForSwappedKey(redisClient *c, robj *key) {
9411 list *l;
9412 listNode *ln;
9413 listIter li;
9414 struct dictEntry *de;
9415
9416 /* Remove the key from the list of keys this client is waiting for. */
9417 listRewind(c->io_keys,&li);
9418 while ((ln = listNext(&li)) != NULL) {
9419 if (compareStringObjects(ln->value,key) == 0) {
9420 listDelNode(c->io_keys,ln);
9421 break;
9422 }
9423 }
9424 assert(ln != NULL);
9425
9426 /* Remove the client form the key => waiting clients map. */
9427 de = dictFind(c->db->io_keys,key);
9428 assert(de != NULL);
9429 l = dictGetEntryVal(de);
9430 ln = listSearchKey(l,c);
9431 assert(ln != NULL);
9432 listDelNode(l,ln);
9433 if (listLength(l) == 0)
9434 dictDelete(c->db->io_keys,key);
9435
9436 return listLength(c->io_keys) == 0;
9437 }
9438
9439 static void handleClientsBlockedOnSwappedKey(redisDb *db, robj *key) {
9440 struct dictEntry *de;
9441 list *l;
9442 listNode *ln;
9443 int len;
9444
9445 de = dictFind(db->io_keys,key);
9446 if (!de) return;
9447
9448 l = dictGetEntryVal(de);
9449 len = listLength(l);
9450 /* Note: we can't use something like while(listLength(l)) as the list
9451 * can be freed by the calling function when we remove the last element. */
9452 while (len--) {
9453 ln = listFirst(l);
9454 redisClient *c = ln->value;
9455
9456 if (dontWaitForSwappedKey(c,key)) {
9457 /* Put the client in the list of clients ready to go as we
9458 * loaded all the keys about it. */
9459 listAddNodeTail(server.io_ready_clients,c);
9460 }
9461 }
9462 }
9463
9464 /* =========================== Remote Configuration ========================= */
9465
9466 static void configSetCommand(redisClient *c) {
9467 robj *o = getDecodedObject(c->argv[3]);
9468 if (!strcasecmp(c->argv[2]->ptr,"dbfilename")) {
9469 zfree(server.dbfilename);
9470 server.dbfilename = zstrdup(o->ptr);
9471 } else if (!strcasecmp(c->argv[2]->ptr,"requirepass")) {
9472 zfree(server.requirepass);
9473 server.requirepass = zstrdup(o->ptr);
9474 } else if (!strcasecmp(c->argv[2]->ptr,"masterauth")) {
9475 zfree(server.masterauth);
9476 server.masterauth = zstrdup(o->ptr);
9477 } else if (!strcasecmp(c->argv[2]->ptr,"maxmemory")) {
9478 server.maxmemory = strtoll(o->ptr, NULL, 10);
9479 } else {
9480 addReplySds(c,sdscatprintf(sdsempty(),
9481 "-ERR not supported CONFIG parameter %s\r\n",
9482 (char*)c->argv[2]->ptr));
9483 decrRefCount(o);
9484 return;
9485 }
9486 decrRefCount(o);
9487 addReply(c,shared.ok);
9488 }
9489
9490 static void configGetCommand(redisClient *c) {
9491 robj *o = getDecodedObject(c->argv[2]);
9492 robj *lenobj = createObject(REDIS_STRING,NULL);
9493 char *pattern = o->ptr;
9494 int matches = 0;
9495
9496 addReply(c,lenobj);
9497 decrRefCount(lenobj);
9498
9499 if (stringmatch(pattern,"dbfilename",0)) {
9500 addReplyBulkCString(c,"dbfilename");
9501 addReplyBulkCString(c,server.dbfilename);
9502 matches++;
9503 }
9504 if (stringmatch(pattern,"requirepass",0)) {
9505 addReplyBulkCString(c,"requirepass");
9506 addReplyBulkCString(c,server.requirepass);
9507 matches++;
9508 }
9509 if (stringmatch(pattern,"masterauth",0)) {
9510 addReplyBulkCString(c,"masterauth");
9511 addReplyBulkCString(c,server.masterauth);
9512 matches++;
9513 }
9514 if (stringmatch(pattern,"maxmemory",0)) {
9515 char buf[128];
9516
9517 snprintf(buf,128,"%llu\n",server.maxmemory);
9518 addReplyBulkCString(c,"maxmemory");
9519 addReplyBulkCString(c,buf);
9520 matches++;
9521 }
9522 decrRefCount(o);
9523 lenobj->ptr = sdscatprintf(sdsempty(),"*%d\r\n",matches*2);
9524 }
9525
9526 static void configCommand(redisClient *c) {
9527 if (!strcasecmp(c->argv[1]->ptr,"set")) {
9528 if (c->argc != 4) goto badarity;
9529 configSetCommand(c);
9530 } else if (!strcasecmp(c->argv[1]->ptr,"get")) {
9531 if (c->argc != 3) goto badarity;
9532 configGetCommand(c);
9533 } else if (!strcasecmp(c->argv[1]->ptr,"resetstat")) {
9534 if (c->argc != 2) goto badarity;
9535 server.stat_numcommands = 0;
9536 server.stat_numconnections = 0;
9537 server.stat_expiredkeys = 0;
9538 server.stat_starttime = time(NULL);
9539 addReply(c,shared.ok);
9540 } else {
9541 addReplySds(c,sdscatprintf(sdsempty(),
9542 "-ERR CONFIG subcommand must be one of GET, SET, RESETSTAT\r\n"));
9543 }
9544 return;
9545
9546 badarity:
9547 addReplySds(c,sdscatprintf(sdsempty(),
9548 "-ERR Wrong number of arguments for CONFIG %s\r\n",
9549 (char*) c->argv[1]->ptr));
9550 }
9551
9552 /* =========================== Pubsub implementation ======================== */
9553
9554 static void freePubsubPattern(void *p) {
9555 pubsubPattern *pat = p;
9556
9557 decrRefCount(pat->pattern);
9558 zfree(pat);
9559 }
9560
9561 static int listMatchPubsubPattern(void *a, void *b) {
9562 pubsubPattern *pa = a, *pb = b;
9563
9564 return (pa->client == pb->client) &&
9565 (compareStringObjects(pa->pattern,pb->pattern) == 0);
9566 }
9567
9568 /* Subscribe a client to a channel. Returns 1 if the operation succeeded, or
9569 * 0 if the client was already subscribed to that channel. */
9570 static int pubsubSubscribeChannel(redisClient *c, robj *channel) {
9571 struct dictEntry *de;
9572 list *clients = NULL;
9573 int retval = 0;
9574
9575 /* Add the channel to the client -> channels hash table */
9576 if (dictAdd(c->pubsub_channels,channel,NULL) == DICT_OK) {
9577 retval = 1;
9578 incrRefCount(channel);
9579 /* Add the client to the channel -> list of clients hash table */
9580 de = dictFind(server.pubsub_channels,channel);
9581 if (de == NULL) {
9582 clients = listCreate();
9583 dictAdd(server.pubsub_channels,channel,clients);
9584 incrRefCount(channel);
9585 } else {
9586 clients = dictGetEntryVal(de);
9587 }
9588 listAddNodeTail(clients,c);
9589 }
9590 /* Notify the client */
9591 addReply(c,shared.mbulk3);
9592 addReply(c,shared.subscribebulk);
9593 addReplyBulk(c,channel);
9594 addReplyLong(c,dictSize(c->pubsub_channels)+listLength(c->pubsub_patterns));
9595 return retval;
9596 }
9597
9598 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
9599 * 0 if the client was not subscribed to the specified channel. */
9600 static int pubsubUnsubscribeChannel(redisClient *c, robj *channel, int notify) {
9601 struct dictEntry *de;
9602 list *clients;
9603 listNode *ln;
9604 int retval = 0;
9605
9606 /* Remove the channel from the client -> channels hash table */
9607 incrRefCount(channel); /* channel may be just a pointer to the same object
9608 we have in the hash tables. Protect it... */
9609 if (dictDelete(c->pubsub_channels,channel) == DICT_OK) {
9610 retval = 1;
9611 /* Remove the client from the channel -> clients list hash table */
9612 de = dictFind(server.pubsub_channels,channel);
9613 assert(de != NULL);
9614 clients = dictGetEntryVal(de);
9615 ln = listSearchKey(clients,c);
9616 assert(ln != NULL);
9617 listDelNode(clients,ln);
9618 if (listLength(clients) == 0) {
9619 /* Free the list and associated hash entry at all if this was
9620 * the latest client, so that it will be possible to abuse
9621 * Redis PUBSUB creating millions of channels. */
9622 dictDelete(server.pubsub_channels,channel);
9623 }
9624 }
9625 /* Notify the client */
9626 if (notify) {
9627 addReply(c,shared.mbulk3);
9628 addReply(c,shared.unsubscribebulk);
9629 addReplyBulk(c,channel);
9630 addReplyLong(c,dictSize(c->pubsub_channels)+
9631 listLength(c->pubsub_patterns));
9632
9633 }
9634 decrRefCount(channel); /* it is finally safe to release it */
9635 return retval;
9636 }
9637
9638 /* Subscribe a client to a pattern. Returns 1 if the operation succeeded, or 0 if the clinet was already subscribed to that pattern. */
9639 static int pubsubSubscribePattern(redisClient *c, robj *pattern) {
9640 int retval = 0;
9641
9642 if (listSearchKey(c->pubsub_patterns,pattern) == NULL) {
9643 retval = 1;
9644 pubsubPattern *pat;
9645 listAddNodeTail(c->pubsub_patterns,pattern);
9646 incrRefCount(pattern);
9647 pat = zmalloc(sizeof(*pat));
9648 pat->pattern = getDecodedObject(pattern);
9649 pat->client = c;
9650 listAddNodeTail(server.pubsub_patterns,pat);
9651 }
9652 /* Notify the client */
9653 addReply(c,shared.mbulk3);
9654 addReply(c,shared.psubscribebulk);
9655 addReplyBulk(c,pattern);
9656 addReplyLong(c,dictSize(c->pubsub_channels)+listLength(c->pubsub_patterns));
9657 return retval;
9658 }
9659
9660 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
9661 * 0 if the client was not subscribed to the specified channel. */
9662 static int pubsubUnsubscribePattern(redisClient *c, robj *pattern, int notify) {
9663 listNode *ln;
9664 pubsubPattern pat;
9665 int retval = 0;
9666
9667 incrRefCount(pattern); /* Protect the object. May be the same we remove */
9668 if ((ln = listSearchKey(c->pubsub_patterns,pattern)) != NULL) {
9669 retval = 1;
9670 listDelNode(c->pubsub_patterns,ln);
9671 pat.client = c;
9672 pat.pattern = pattern;
9673 ln = listSearchKey(server.pubsub_patterns,&pat);
9674 listDelNode(server.pubsub_patterns,ln);
9675 }
9676 /* Notify the client */
9677 if (notify) {
9678 addReply(c,shared.mbulk3);
9679 addReply(c,shared.punsubscribebulk);
9680 addReplyBulk(c,pattern);
9681 addReplyLong(c,dictSize(c->pubsub_channels)+
9682 listLength(c->pubsub_patterns));
9683 }
9684 decrRefCount(pattern);
9685 return retval;
9686 }
9687
9688 /* Unsubscribe from all the channels. Return the number of channels the
9689 * client was subscribed from. */
9690 static int pubsubUnsubscribeAllChannels(redisClient *c, int notify) {
9691 dictIterator *di = dictGetIterator(c->pubsub_channels);
9692 dictEntry *de;
9693 int count = 0;
9694
9695 while((de = dictNext(di)) != NULL) {
9696 robj *channel = dictGetEntryKey(de);
9697
9698 count += pubsubUnsubscribeChannel(c,channel,notify);
9699 }
9700 dictReleaseIterator(di);
9701 return count;
9702 }
9703
9704 /* Unsubscribe from all the patterns. Return the number of patterns the
9705 * client was subscribed from. */
9706 static int pubsubUnsubscribeAllPatterns(redisClient *c, int notify) {
9707 listNode *ln;
9708 listIter li;
9709 int count = 0;
9710
9711 listRewind(c->pubsub_patterns,&li);
9712 while ((ln = listNext(&li)) != NULL) {
9713 robj *pattern = ln->value;
9714
9715 count += pubsubUnsubscribePattern(c,pattern,notify);
9716 }
9717 return count;
9718 }
9719
9720 /* Publish a message */
9721 static int pubsubPublishMessage(robj *channel, robj *message) {
9722 int receivers = 0;
9723 struct dictEntry *de;
9724 listNode *ln;
9725 listIter li;
9726
9727 /* Send to clients listening for that channel */
9728 de = dictFind(server.pubsub_channels,channel);
9729 if (de) {
9730 list *list = dictGetEntryVal(de);
9731 listNode *ln;
9732 listIter li;
9733
9734 listRewind(list,&li);
9735 while ((ln = listNext(&li)) != NULL) {
9736 redisClient *c = ln->value;
9737
9738 addReply(c,shared.mbulk3);
9739 addReply(c,shared.messagebulk);
9740 addReplyBulk(c,channel);
9741 addReplyBulk(c,message);
9742 receivers++;
9743 }
9744 }
9745 /* Send to clients listening to matching channels */
9746 if (listLength(server.pubsub_patterns)) {
9747 listRewind(server.pubsub_patterns,&li);
9748 channel = getDecodedObject(channel);
9749 while ((ln = listNext(&li)) != NULL) {
9750 pubsubPattern *pat = ln->value;
9751
9752 if (stringmatchlen((char*)pat->pattern->ptr,
9753 sdslen(pat->pattern->ptr),
9754 (char*)channel->ptr,
9755 sdslen(channel->ptr),0)) {
9756 addReply(pat->client,shared.mbulk3);
9757 addReply(pat->client,shared.messagebulk);
9758 addReplyBulk(pat->client,channel);
9759 addReplyBulk(pat->client,message);
9760 receivers++;
9761 }
9762 }
9763 decrRefCount(channel);
9764 }
9765 return receivers;
9766 }
9767
9768 static void subscribeCommand(redisClient *c) {
9769 int j;
9770
9771 for (j = 1; j < c->argc; j++)
9772 pubsubSubscribeChannel(c,c->argv[j]);
9773 }
9774
9775 static void unsubscribeCommand(redisClient *c) {
9776 if (c->argc == 1) {
9777 pubsubUnsubscribeAllChannels(c,1);
9778 return;
9779 } else {
9780 int j;
9781
9782 for (j = 1; j < c->argc; j++)
9783 pubsubUnsubscribeChannel(c,c->argv[j],1);
9784 }
9785 }
9786
9787 static void psubscribeCommand(redisClient *c) {
9788 int j;
9789
9790 for (j = 1; j < c->argc; j++)
9791 pubsubSubscribePattern(c,c->argv[j]);
9792 }
9793
9794 static void punsubscribeCommand(redisClient *c) {
9795 if (c->argc == 1) {
9796 pubsubUnsubscribeAllPatterns(c,1);
9797 return;
9798 } else {
9799 int j;
9800
9801 for (j = 1; j < c->argc; j++)
9802 pubsubUnsubscribePattern(c,c->argv[j],1);
9803 }
9804 }
9805
9806 static void publishCommand(redisClient *c) {
9807 int receivers = pubsubPublishMessage(c->argv[1],c->argv[2]);
9808 addReplyLong(c,receivers);
9809 }
9810
9811 /* ================================= Debugging ============================== */
9812
9813 static void debugCommand(redisClient *c) {
9814 if (!strcasecmp(c->argv[1]->ptr,"segfault")) {
9815 *((char*)-1) = 'x';
9816 } else if (!strcasecmp(c->argv[1]->ptr,"reload")) {
9817 if (rdbSave(server.dbfilename) != REDIS_OK) {
9818 addReply(c,shared.err);
9819 return;
9820 }
9821 emptyDb();
9822 if (rdbLoad(server.dbfilename) != REDIS_OK) {
9823 addReply(c,shared.err);
9824 return;
9825 }
9826 redisLog(REDIS_WARNING,"DB reloaded by DEBUG RELOAD");
9827 addReply(c,shared.ok);
9828 } else if (!strcasecmp(c->argv[1]->ptr,"loadaof")) {
9829 emptyDb();
9830 if (loadAppendOnlyFile(server.appendfilename) != REDIS_OK) {
9831 addReply(c,shared.err);
9832 return;
9833 }
9834 redisLog(REDIS_WARNING,"Append Only File loaded by DEBUG LOADAOF");
9835 addReply(c,shared.ok);
9836 } else if (!strcasecmp(c->argv[1]->ptr,"object") && c->argc == 3) {
9837 dictEntry *de = dictFind(c->db->dict,c->argv[2]);
9838 robj *key, *val;
9839
9840 if (!de) {
9841 addReply(c,shared.nokeyerr);
9842 return;
9843 }
9844 key = dictGetEntryKey(de);
9845 val = dictGetEntryVal(de);
9846 if (!server.vm_enabled || (key->storage == REDIS_VM_MEMORY ||
9847 key->storage == REDIS_VM_SWAPPING)) {
9848 char *strenc;
9849 char buf[128];
9850
9851 if (val->encoding < (sizeof(strencoding)/sizeof(char*))) {
9852 strenc = strencoding[val->encoding];
9853 } else {
9854 snprintf(buf,64,"unknown encoding %d\n", val->encoding);
9855 strenc = buf;
9856 }
9857 addReplySds(c,sdscatprintf(sdsempty(),
9858 "+Key at:%p refcount:%d, value at:%p refcount:%d "
9859 "encoding:%s serializedlength:%lld\r\n",
9860 (void*)key, key->refcount, (void*)val, val->refcount,
9861 strenc, (long long) rdbSavedObjectLen(val,NULL)));
9862 } else {
9863 addReplySds(c,sdscatprintf(sdsempty(),
9864 "+Key at:%p refcount:%d, value swapped at: page %llu "
9865 "using %llu pages\r\n",
9866 (void*)key, key->refcount, (unsigned long long) key->vm.page,
9867 (unsigned long long) key->vm.usedpages));
9868 }
9869 } else if (!strcasecmp(c->argv[1]->ptr,"swapin") && c->argc == 3) {
9870 lookupKeyRead(c->db,c->argv[2]);
9871 addReply(c,shared.ok);
9872 } else if (!strcasecmp(c->argv[1]->ptr,"swapout") && c->argc == 3) {
9873 dictEntry *de = dictFind(c->db->dict,c->argv[2]);
9874 robj *key, *val;
9875
9876 if (!server.vm_enabled) {
9877 addReplySds(c,sdsnew("-ERR Virtual Memory is disabled\r\n"));
9878 return;
9879 }
9880 if (!de) {
9881 addReply(c,shared.nokeyerr);
9882 return;
9883 }
9884 key = dictGetEntryKey(de);
9885 val = dictGetEntryVal(de);
9886 /* If the key is shared we want to create a copy */
9887 if (key->refcount > 1) {
9888 robj *newkey = dupStringObject(key);
9889 decrRefCount(key);
9890 key = dictGetEntryKey(de) = newkey;
9891 }
9892 /* Swap it */
9893 if (key->storage != REDIS_VM_MEMORY) {
9894 addReplySds(c,sdsnew("-ERR This key is not in memory\r\n"));
9895 } else if (vmSwapObjectBlocking(key,val) == REDIS_OK) {
9896 dictGetEntryVal(de) = NULL;
9897 addReply(c,shared.ok);
9898 } else {
9899 addReply(c,shared.err);
9900 }
9901 } else {
9902 addReplySds(c,sdsnew(
9903 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPIN <key>|SWAPOUT <key>|RELOAD]\r\n"));
9904 }
9905 }
9906
9907 static void _redisAssert(char *estr, char *file, int line) {
9908 redisLog(REDIS_WARNING,"=== ASSERTION FAILED ===");
9909 redisLog(REDIS_WARNING,"==> %s:%d '%s' is not true\n",file,line,estr);
9910 #ifdef HAVE_BACKTRACE
9911 redisLog(REDIS_WARNING,"(forcing SIGSEGV in order to print the stack trace)");
9912 *((char*)-1) = 'x';
9913 #endif
9914 }
9915
9916 static void _redisPanic(char *msg, char *file, int line) {
9917 redisLog(REDIS_WARNING,"!!! Software Failure. Press left mouse button to continue");
9918 redisLog(REDIS_WARNING,"Guru Mediation: %s #%s:%d",msg,file,line);
9919 #ifdef HAVE_BACKTRACE
9920 redisLog(REDIS_WARNING,"(forcing SIGSEGV in order to print the stack trace)");
9921 *((char*)-1) = 'x';
9922 #endif
9923 }
9924
9925 /* =================================== Main! ================================ */
9926
9927 #ifdef __linux__
9928 int linuxOvercommitMemoryValue(void) {
9929 FILE *fp = fopen("/proc/sys/vm/overcommit_memory","r");
9930 char buf[64];
9931
9932 if (!fp) return -1;
9933 if (fgets(buf,64,fp) == NULL) {
9934 fclose(fp);
9935 return -1;
9936 }
9937 fclose(fp);
9938
9939 return atoi(buf);
9940 }
9941
9942 void linuxOvercommitMemoryWarning(void) {
9943 if (linuxOvercommitMemoryValue() == 0) {
9944 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.");
9945 }
9946 }
9947 #endif /* __linux__ */
9948
9949 static void daemonize(void) {
9950 int fd;
9951 FILE *fp;
9952
9953 if (fork() != 0) exit(0); /* parent exits */
9954 setsid(); /* create a new session */
9955
9956 /* Every output goes to /dev/null. If Redis is daemonized but
9957 * the 'logfile' is set to 'stdout' in the configuration file
9958 * it will not log at all. */
9959 if ((fd = open("/dev/null", O_RDWR, 0)) != -1) {
9960 dup2(fd, STDIN_FILENO);
9961 dup2(fd, STDOUT_FILENO);
9962 dup2(fd, STDERR_FILENO);
9963 if (fd > STDERR_FILENO) close(fd);
9964 }
9965 /* Try to write the pid file */
9966 fp = fopen(server.pidfile,"w");
9967 if (fp) {
9968 fprintf(fp,"%d\n",getpid());
9969 fclose(fp);
9970 }
9971 }
9972
9973 static void version() {
9974 printf("Redis server version %s\n", REDIS_VERSION);
9975 exit(0);
9976 }
9977
9978 static void usage() {
9979 fprintf(stderr,"Usage: ./redis-server [/path/to/redis.conf]\n");
9980 fprintf(stderr," ./redis-server - (read config from stdin)\n");
9981 exit(1);
9982 }
9983
9984 int main(int argc, char **argv) {
9985 time_t start;
9986
9987 initServerConfig();
9988 if (argc == 2) {
9989 if (strcmp(argv[1], "-v") == 0 ||
9990 strcmp(argv[1], "--version") == 0) version();
9991 if (strcmp(argv[1], "--help") == 0) usage();
9992 resetServerSaveParams();
9993 loadServerConfig(argv[1]);
9994 } else if ((argc > 2)) {
9995 usage();
9996 } else {
9997 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'");
9998 }
9999 if (server.daemonize) daemonize();
10000 initServer();
10001 redisLog(REDIS_NOTICE,"Server started, Redis version " REDIS_VERSION);
10002 #ifdef __linux__
10003 linuxOvercommitMemoryWarning();
10004 #endif
10005 start = time(NULL);
10006 if (server.appendonly) {
10007 if (loadAppendOnlyFile(server.appendfilename) == REDIS_OK)
10008 redisLog(REDIS_NOTICE,"DB loaded from append only file: %ld seconds",time(NULL)-start);
10009 } else {
10010 if (rdbLoad(server.dbfilename) == REDIS_OK)
10011 redisLog(REDIS_NOTICE,"DB loaded from disk: %ld seconds",time(NULL)-start);
10012 }
10013 redisLog(REDIS_NOTICE,"The server is now ready to accept connections on port %d", server.port);
10014 aeSetBeforeSleepProc(server.el,beforeSleep);
10015 aeMain(server.el);
10016 aeDeleteEventLoop(server.el);
10017 return 0;
10018 }
10019
10020 /* ============================= Backtrace support ========================= */
10021
10022 #ifdef HAVE_BACKTRACE
10023 static char *findFuncName(void *pointer, unsigned long *offset);
10024
10025 static void *getMcontextEip(ucontext_t *uc) {
10026 #if defined(__FreeBSD__)
10027 return (void*) uc->uc_mcontext.mc_eip;
10028 #elif defined(__dietlibc__)
10029 return (void*) uc->uc_mcontext.eip;
10030 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
10031 #if __x86_64__
10032 return (void*) uc->uc_mcontext->__ss.__rip;
10033 #else
10034 return (void*) uc->uc_mcontext->__ss.__eip;
10035 #endif
10036 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
10037 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
10038 return (void*) uc->uc_mcontext->__ss.__rip;
10039 #else
10040 return (void*) uc->uc_mcontext->__ss.__eip;
10041 #endif
10042 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
10043 return (void*) uc->uc_mcontext.gregs[REG_EIP]; /* Linux 32/64 bit */
10044 #elif defined(__ia64__) /* Linux IA64 */
10045 return (void*) uc->uc_mcontext.sc_ip;
10046 #else
10047 return NULL;
10048 #endif
10049 }
10050
10051 static void segvHandler(int sig, siginfo_t *info, void *secret) {
10052 void *trace[100];
10053 char **messages = NULL;
10054 int i, trace_size = 0;
10055 unsigned long offset=0;
10056 ucontext_t *uc = (ucontext_t*) secret;
10057 sds infostring;
10058 REDIS_NOTUSED(info);
10059
10060 redisLog(REDIS_WARNING,
10061 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION, sig);
10062 infostring = genRedisInfoString();
10063 redisLog(REDIS_WARNING, "%s",infostring);
10064 /* It's not safe to sdsfree() the returned string under memory
10065 * corruption conditions. Let it leak as we are going to abort */
10066
10067 trace_size = backtrace(trace, 100);
10068 /* overwrite sigaction with caller's address */
10069 if (getMcontextEip(uc) != NULL) {
10070 trace[1] = getMcontextEip(uc);
10071 }
10072 messages = backtrace_symbols(trace, trace_size);
10073
10074 for (i=1; i<trace_size; ++i) {
10075 char *fn = findFuncName(trace[i], &offset), *p;
10076
10077 p = strchr(messages[i],'+');
10078 if (!fn || (p && ((unsigned long)strtol(p+1,NULL,10)) < offset)) {
10079 redisLog(REDIS_WARNING,"%s", messages[i]);
10080 } else {
10081 redisLog(REDIS_WARNING,"%d redis-server %p %s + %d", i, trace[i], fn, (unsigned int)offset);
10082 }
10083 }
10084 /* free(messages); Don't call free() with possibly corrupted memory. */
10085 _exit(0);
10086 }
10087
10088 static void setupSigSegvAction(void) {
10089 struct sigaction act;
10090
10091 sigemptyset (&act.sa_mask);
10092 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
10093 * is used. Otherwise, sa_handler is used */
10094 act.sa_flags = SA_NODEFER | SA_ONSTACK | SA_RESETHAND | SA_SIGINFO;
10095 act.sa_sigaction = segvHandler;
10096 sigaction (SIGSEGV, &act, NULL);
10097 sigaction (SIGBUS, &act, NULL);
10098 sigaction (SIGFPE, &act, NULL);
10099 sigaction (SIGILL, &act, NULL);
10100 sigaction (SIGBUS, &act, NULL);
10101 return;
10102 }
10103
10104 #include "staticsymbols.h"
10105 /* This function try to convert a pointer into a function name. It's used in
10106 * oreder to provide a backtrace under segmentation fault that's able to
10107 * display functions declared as static (otherwise the backtrace is useless). */
10108 static char *findFuncName(void *pointer, unsigned long *offset){
10109 int i, ret = -1;
10110 unsigned long off, minoff = 0;
10111
10112 /* Try to match against the Symbol with the smallest offset */
10113 for (i=0; symsTable[i].pointer; i++) {
10114 unsigned long lp = (unsigned long) pointer;
10115
10116 if (lp != (unsigned long)-1 && lp >= symsTable[i].pointer) {
10117 off=lp-symsTable[i].pointer;
10118 if (ret < 0 || off < minoff) {
10119 minoff=off;
10120 ret=i;
10121 }
10122 }
10123 }
10124 if (ret == -1) return NULL;
10125 *offset = minoff;
10126 return symsTable[ret].name;
10127 }
10128 #else /* HAVE_BACKTRACE */
10129 static void setupSigSegvAction(void) {
10130 }
10131 #endif /* HAVE_BACKTRACE */
10132
10133
10134
10135 /* The End */
10136
10137
10138