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