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