]> git.saurik.com Git - redis.git/blob - redis.c
c39f5846fae2e15ee4ab5347d3025a955e54b17c
[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 "2.1.1"
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 #include <signal.h>
41
42 #ifdef HAVE_BACKTRACE
43 #include <execinfo.h>
44 #include <ucontext.h>
45 #endif /* HAVE_BACKTRACE */
46
47 #include <sys/wait.h>
48 #include <errno.h>
49 #include <assert.h>
50 #include <ctype.h>
51 #include <stdarg.h>
52 #include <inttypes.h>
53 #include <arpa/inet.h>
54 #include <sys/stat.h>
55 #include <fcntl.h>
56 #include <sys/time.h>
57 #include <sys/resource.h>
58 #include <sys/uio.h>
59 #include <limits.h>
60 #include <float.h>
61 #include <math.h>
62 #include <pthread.h>
63
64 #if defined(__sun)
65 #include "solarisfixes.h"
66 #endif
67
68 #include "redis.h"
69 #include "ae.h" /* Event driven programming library */
70 #include "sds.h" /* Dynamic safe strings */
71 #include "anet.h" /* Networking the easy way */
72 #include "dict.h" /* Hash tables */
73 #include "adlist.h" /* Linked lists */
74 #include "zmalloc.h" /* total memory usage aware version of malloc/free */
75 #include "lzf.h" /* LZF compression library */
76 #include "pqsort.h" /* Partial qsort for SORT+LIMIT */
77 #include "zipmap.h" /* Compact dictionary-alike data structure */
78 #include "ziplist.h" /* Compact list data structure */
79 #include "sha1.h" /* SHA1 is used for DEBUG DIGEST */
80 #include "release.h" /* Release and/or git repository information */
81
82 /* Error codes */
83 #define REDIS_OK 0
84 #define REDIS_ERR -1
85
86 /* Static server configuration */
87 #define REDIS_SERVERPORT 6379 /* TCP port */
88 #define REDIS_MAXIDLETIME (60*5) /* default client timeout */
89 #define REDIS_IOBUF_LEN 1024
90 #define REDIS_LOADBUF_LEN 1024
91 #define REDIS_STATIC_ARGS 8
92 #define REDIS_DEFAULT_DBNUM 16
93 #define REDIS_CONFIGLINE_MAX 1024
94 #define REDIS_OBJFREELIST_MAX 1000000 /* Max number of objects to cache */
95 #define REDIS_MAX_SYNC_TIME 60 /* Slave can't take more to sync */
96 #define REDIS_EXPIRELOOKUPS_PER_CRON 10 /* lookup 10 expires per loop */
97 #define REDIS_MAX_WRITE_PER_EVENT (1024*64)
98 #define REDIS_REQUEST_MAX_SIZE (1024*1024*256) /* max bytes in inline command */
99
100 /* If more then REDIS_WRITEV_THRESHOLD write packets are pending use writev */
101 #define REDIS_WRITEV_THRESHOLD 3
102 /* Max number of iovecs used for each writev call */
103 #define REDIS_WRITEV_IOVEC_COUNT 256
104
105 /* Hash table parameters */
106 #define REDIS_HT_MINFILL 10 /* Minimal hash table fill 10% */
107
108 /* Command flags */
109 #define REDIS_CMD_BULK 1 /* Bulk write command */
110 #define REDIS_CMD_INLINE 2 /* Inline command */
111 /* REDIS_CMD_DENYOOM reserves a longer comment: all the commands marked with
112 this flags will return an error when the 'maxmemory' option is set in the
113 config file and the server is using more than maxmemory bytes of memory.
114 In short this commands are denied on low memory conditions. */
115 #define REDIS_CMD_DENYOOM 4
116 #define REDIS_CMD_FORCE_REPLICATION 8 /* Force replication even if dirty is 0 */
117
118 /* Object types */
119 #define REDIS_STRING 0
120 #define REDIS_LIST 1
121 #define REDIS_SET 2
122 #define REDIS_ZSET 3
123 #define REDIS_HASH 4
124 #define REDIS_VMPOINTER 8
125
126 /* Objects encoding. Some kind of objects like Strings and Hashes can be
127 * internally represented in multiple ways. The 'encoding' field of the object
128 * is set to one of this fields for this object. */
129 #define REDIS_ENCODING_RAW 0 /* Raw representation */
130 #define REDIS_ENCODING_INT 1 /* Encoded as integer */
131 #define REDIS_ENCODING_HT 2 /* Encoded as hash table */
132 #define REDIS_ENCODING_ZIPMAP 3 /* Encoded as zipmap */
133 #define REDIS_ENCODING_LIST 4 /* Encoded as zipmap */
134 #define REDIS_ENCODING_ZIPLIST 5 /* Encoded as ziplist */
135
136 static char* strencoding[] = {
137 "raw", "int", "hashtable", "zipmap", "list", "ziplist"
138 };
139
140 /* Object types only used for dumping to disk */
141 #define REDIS_EXPIRETIME 253
142 #define REDIS_SELECTDB 254
143 #define REDIS_EOF 255
144
145 /* Defines related to the dump file format. To store 32 bits lengths for short
146 * keys requires a lot of space, so we check the most significant 2 bits of
147 * the first byte to interpreter the length:
148 *
149 * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
150 * 01|000000 00000000 => 01, the len is 14 byes, 6 bits + 8 bits of next byte
151 * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
152 * 11|000000 this means: specially encoded object will follow. The six bits
153 * number specify the kind of object that follows.
154 * See the REDIS_RDB_ENC_* defines.
155 *
156 * Lenghts up to 63 are stored using a single byte, most DB keys, and may
157 * values, will fit inside. */
158 #define REDIS_RDB_6BITLEN 0
159 #define REDIS_RDB_14BITLEN 1
160 #define REDIS_RDB_32BITLEN 2
161 #define REDIS_RDB_ENCVAL 3
162 #define REDIS_RDB_LENERR UINT_MAX
163
164 /* When a length of a string object stored on disk has the first two bits
165 * set, the remaining two bits specify a special encoding for the object
166 * accordingly to the following defines: */
167 #define REDIS_RDB_ENC_INT8 0 /* 8 bit signed integer */
168 #define REDIS_RDB_ENC_INT16 1 /* 16 bit signed integer */
169 #define REDIS_RDB_ENC_INT32 2 /* 32 bit signed integer */
170 #define REDIS_RDB_ENC_LZF 3 /* string compressed with FASTLZ */
171
172 /* Virtual memory object->where field. */
173 #define REDIS_VM_MEMORY 0 /* The object is on memory */
174 #define REDIS_VM_SWAPPED 1 /* The object is on disk */
175 #define REDIS_VM_SWAPPING 2 /* Redis is swapping this object on disk */
176 #define REDIS_VM_LOADING 3 /* Redis is loading this object from disk */
177
178 /* Virtual memory static configuration stuff.
179 * Check vmFindContiguousPages() to know more about this magic numbers. */
180 #define REDIS_VM_MAX_NEAR_PAGES 65536
181 #define REDIS_VM_MAX_RANDOM_JUMP 4096
182 #define REDIS_VM_MAX_THREADS 32
183 #define REDIS_THREAD_STACK_SIZE (1024*1024*4)
184 /* The following is the *percentage* of completed I/O jobs to process when the
185 * handelr is called. While Virtual Memory I/O operations are performed by
186 * threads, this operations must be processed by the main thread when completed
187 * in order to take effect. */
188 #define REDIS_MAX_COMPLETED_JOBS_PROCESSED 1
189
190 /* Client flags */
191 #define REDIS_SLAVE 1 /* This client is a slave server */
192 #define REDIS_MASTER 2 /* This client is a master server */
193 #define REDIS_MONITOR 4 /* This client is a slave monitor, see MONITOR */
194 #define REDIS_MULTI 8 /* This client is in a MULTI context */
195 #define REDIS_BLOCKED 16 /* The client is waiting in a blocking operation */
196 #define REDIS_IO_WAIT 32 /* The client is waiting for Virtual Memory I/O */
197 #define REDIS_DIRTY_CAS 64 /* Watched keys modified. EXEC will fail. */
198
199 /* Slave replication state - slave side */
200 #define REDIS_REPL_NONE 0 /* No active replication */
201 #define REDIS_REPL_CONNECT 1 /* Must connect to master */
202 #define REDIS_REPL_CONNECTED 2 /* Connected to master */
203
204 /* Slave replication state - from the point of view of master
205 * Note that in SEND_BULK and ONLINE state the slave receives new updates
206 * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
207 * to start the next background saving in order to send updates to it. */
208 #define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
209 #define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
210 #define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
211 #define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */
212
213 /* List related stuff */
214 #define REDIS_HEAD 0
215 #define REDIS_TAIL 1
216
217 /* Sort operations */
218 #define REDIS_SORT_GET 0
219 #define REDIS_SORT_ASC 1
220 #define REDIS_SORT_DESC 2
221 #define REDIS_SORTKEY_MAX 1024
222
223 /* Log levels */
224 #define REDIS_DEBUG 0
225 #define REDIS_VERBOSE 1
226 #define REDIS_NOTICE 2
227 #define REDIS_WARNING 3
228
229 /* Anti-warning macro... */
230 #define REDIS_NOTUSED(V) ((void) V)
231
232 #define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
233 #define ZSKIPLIST_P 0.25 /* Skiplist P = 1/4 */
234
235 /* Append only defines */
236 #define APPENDFSYNC_NO 0
237 #define APPENDFSYNC_ALWAYS 1
238 #define APPENDFSYNC_EVERYSEC 2
239
240 /* Zip structure related defaults */
241 #define REDIS_HASH_MAX_ZIPMAP_ENTRIES 64
242 #define REDIS_HASH_MAX_ZIPMAP_VALUE 512
243 #define REDIS_LIST_MAX_ZIPLIST_ENTRIES 1024
244 #define REDIS_LIST_MAX_ZIPLIST_VALUE 32
245
246 /* We can print the stacktrace, so our assert is defined this way: */
247 #define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1)))
248 #define redisPanic(_e) _redisPanic(#_e,__FILE__,__LINE__),_exit(1)
249 static void _redisAssert(char *estr, char *file, int line);
250 static void _redisPanic(char *msg, char *file, int line);
251
252 /*================================= Data types ============================== */
253
254 /* A redis object, that is a type able to hold a string / list / set */
255
256 /* The actual Redis Object */
257 typedef struct redisObject {
258 unsigned type:4;
259 unsigned storage:2; /* REDIS_VM_MEMORY or REDIS_VM_SWAPPING */
260 unsigned encoding:4;
261 unsigned lru:22; /* lru time (relative to server.lruclock) */
262 int refcount;
263 void *ptr;
264 /* VM fields are only allocated if VM is active, otherwise the
265 * object allocation function will just allocate
266 * sizeof(redisObjct) minus sizeof(redisObjectVM), so using
267 * Redis without VM active will not have any overhead. */
268 } robj;
269
270 /* The VM pointer structure - identifies an object in the swap file.
271 *
272 * This object is stored in place of the value
273 * object in the main key->value hash table representing a database.
274 * Note that the first fields (type, storage) are the same as the redisObject
275 * structure so that vmPointer strucuters can be accessed even when casted
276 * as redisObject structures.
277 *
278 * This is useful as we don't know if a value object is or not on disk, but we
279 * are always able to read obj->storage to check this. For vmPointer
280 * structures "type" is set to REDIS_VMPOINTER (even if without this field
281 * is still possible to check the kind of object from the value of 'storage').*/
282 typedef struct vmPointer {
283 unsigned type:4;
284 unsigned storage:2; /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
285 unsigned notused:26;
286 unsigned int vtype; /* type of the object stored in the swap file */
287 off_t page; /* the page at witch the object is stored on disk */
288 off_t usedpages; /* number of pages used on disk */
289 } vmpointer;
290
291 /* Macro used to initalize a Redis object allocated on the stack.
292 * Note that this macro is taken near the structure definition to make sure
293 * we'll update it when the structure is changed, to avoid bugs like
294 * bug #85 introduced exactly in this way. */
295 #define initStaticStringObject(_var,_ptr) do { \
296 _var.refcount = 1; \
297 _var.type = REDIS_STRING; \
298 _var.encoding = REDIS_ENCODING_RAW; \
299 _var.ptr = _ptr; \
300 _var.storage = REDIS_VM_MEMORY; \
301 } while(0);
302
303 typedef struct redisDb {
304 dict *dict; /* The keyspace for this DB */
305 dict *expires; /* Timeout of keys with a timeout set */
306 dict *blocking_keys; /* Keys with clients waiting for data (BLPOP) */
307 dict *io_keys; /* Keys with clients waiting for VM I/O */
308 dict *watched_keys; /* WATCHED keys for MULTI/EXEC CAS */
309 int id;
310 } redisDb;
311
312 /* Client MULTI/EXEC state */
313 typedef struct multiCmd {
314 robj **argv;
315 int argc;
316 struct redisCommand *cmd;
317 } multiCmd;
318
319 typedef struct multiState {
320 multiCmd *commands; /* Array of MULTI commands */
321 int count; /* Total number of MULTI commands */
322 } multiState;
323
324 /* With multiplexing we need to take per-clinet state.
325 * Clients are taken in a liked list. */
326 typedef struct redisClient {
327 int fd;
328 redisDb *db;
329 int dictid;
330 sds querybuf;
331 robj **argv, **mbargv;
332 int argc, mbargc;
333 int bulklen; /* bulk read len. -1 if not in bulk read mode */
334 int multibulk; /* multi bulk command format active */
335 list *reply;
336 int sentlen;
337 time_t lastinteraction; /* time of the last interaction, used for timeout */
338 int flags; /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
339 int slaveseldb; /* slave selected db, if this client is a slave */
340 int authenticated; /* when requirepass is non-NULL */
341 int replstate; /* replication state if this is a slave */
342 int repldbfd; /* replication DB file descriptor */
343 long repldboff; /* replication DB file offset */
344 off_t repldbsize; /* replication DB file size */
345 multiState mstate; /* MULTI/EXEC state */
346 robj **blocking_keys; /* The key we are waiting to terminate a blocking
347 * operation such as BLPOP. Otherwise NULL. */
348 int blocking_keys_num; /* Number of blocking keys */
349 time_t blockingto; /* Blocking operation timeout. If UNIX current time
350 * is >= blockingto then the operation timed out. */
351 list *io_keys; /* Keys this client is waiting to be loaded from the
352 * swap file in order to continue. */
353 list *watched_keys; /* Keys WATCHED for MULTI/EXEC CAS */
354 dict *pubsub_channels; /* channels a client is interested in (SUBSCRIBE) */
355 list *pubsub_patterns; /* patterns a client is interested in (SUBSCRIBE) */
356 } redisClient;
357
358 struct saveparam {
359 time_t seconds;
360 int changes;
361 };
362
363 /* Global server state structure */
364 struct redisServer {
365 int port;
366 int fd;
367 redisDb *db;
368 long long dirty; /* changes to DB from the last save */
369 list *clients;
370 list *slaves, *monitors;
371 char neterr[ANET_ERR_LEN];
372 aeEventLoop *el;
373 int cronloops; /* number of times the cron function run */
374 list *objfreelist; /* A list of freed objects to avoid malloc() */
375 time_t lastsave; /* Unix time of last save succeeede */
376 /* Fields used only for stats */
377 time_t stat_starttime; /* server start time */
378 long long stat_numcommands; /* number of processed commands */
379 long long stat_numconnections; /* number of connections received */
380 long long stat_expiredkeys; /* number of expired keys */
381 /* Configuration */
382 int verbosity;
383 int glueoutputbuf;
384 int maxidletime;
385 int dbnum;
386 int daemonize;
387 int appendonly;
388 int appendfsync;
389 int no_appendfsync_on_rewrite;
390 int shutdown_asap;
391 time_t lastfsync;
392 int appendfd;
393 int appendseldb;
394 char *pidfile;
395 pid_t bgsavechildpid;
396 pid_t bgrewritechildpid;
397 sds bgrewritebuf; /* buffer taken by parent during oppend only rewrite */
398 sds aofbuf; /* AOF buffer, written before entering the event loop */
399 struct saveparam *saveparams;
400 int saveparamslen;
401 char *logfile;
402 char *bindaddr;
403 char *dbfilename;
404 char *appendfilename;
405 char *requirepass;
406 int rdbcompression;
407 int activerehashing;
408 /* Replication related */
409 int isslave;
410 char *masterauth;
411 char *masterhost;
412 int masterport;
413 redisClient *master; /* client that is master for this slave */
414 int replstate;
415 unsigned int maxclients;
416 unsigned long long maxmemory;
417 unsigned int blpop_blocked_clients;
418 unsigned int vm_blocked_clients;
419 /* Sort parameters - qsort_r() is only available under BSD so we
420 * have to take this state global, in order to pass it to sortCompare() */
421 int sort_desc;
422 int sort_alpha;
423 int sort_bypattern;
424 /* Virtual memory configuration */
425 int vm_enabled;
426 char *vm_swap_file;
427 off_t vm_page_size;
428 off_t vm_pages;
429 unsigned long long vm_max_memory;
430 /* Zip structure config */
431 size_t hash_max_zipmap_entries;
432 size_t hash_max_zipmap_value;
433 size_t list_max_ziplist_entries;
434 size_t list_max_ziplist_value;
435 /* Virtual memory state */
436 FILE *vm_fp;
437 int vm_fd;
438 off_t vm_next_page; /* Next probably empty page */
439 off_t vm_near_pages; /* Number of pages allocated sequentially */
440 unsigned char *vm_bitmap; /* Bitmap of free/used pages */
441 time_t unixtime; /* Unix time sampled every second. */
442 /* Virtual memory I/O threads stuff */
443 /* An I/O thread process an element taken from the io_jobs queue and
444 * put the result of the operation in the io_done list. While the
445 * job is being processed, it's put on io_processing queue. */
446 list *io_newjobs; /* List of VM I/O jobs yet to be processed */
447 list *io_processing; /* List of VM I/O jobs being processed */
448 list *io_processed; /* List of VM I/O jobs already processed */
449 list *io_ready_clients; /* Clients ready to be unblocked. All keys loaded */
450 pthread_mutex_t io_mutex; /* lock to access io_jobs/io_done/io_thread_job */
451 pthread_mutex_t obj_freelist_mutex; /* safe redis objects creation/free */
452 pthread_mutex_t io_swapfile_mutex; /* So we can lseek + write */
453 pthread_attr_t io_threads_attr; /* attributes for threads creation */
454 int io_active_threads; /* Number of running I/O threads */
455 int vm_max_threads; /* Max number of I/O threads running at the same time */
456 /* Our main thread is blocked on the event loop, locking for sockets ready
457 * to be read or written, so when a threaded I/O operation is ready to be
458 * processed by the main thread, the I/O thread will use a unix pipe to
459 * awake the main thread. The followings are the two pipe FDs. */
460 int io_ready_pipe_read;
461 int io_ready_pipe_write;
462 /* Virtual memory stats */
463 unsigned long long vm_stats_used_pages;
464 unsigned long long vm_stats_swapped_objects;
465 unsigned long long vm_stats_swapouts;
466 unsigned long long vm_stats_swapins;
467 /* Pubsub */
468 dict *pubsub_channels; /* Map channels to list of subscribed clients */
469 list *pubsub_patterns; /* A list of pubsub_patterns */
470 /* Misc */
471 FILE *devnull;
472 unsigned lruclock:22; /* clock incrementing every minute, for LRU */
473 unsigned lruclock_padding:10;
474 };
475
476 typedef struct pubsubPattern {
477 redisClient *client;
478 robj *pattern;
479 } pubsubPattern;
480
481 typedef void redisCommandProc(redisClient *c);
482 typedef void redisVmPreloadProc(redisClient *c, struct redisCommand *cmd, int argc, robj **argv);
483 struct redisCommand {
484 char *name;
485 redisCommandProc *proc;
486 int arity;
487 int flags;
488 /* Use a function to determine which keys need to be loaded
489 * in the background prior to executing this command. Takes precedence
490 * over vm_firstkey and others, ignored when NULL */
491 redisVmPreloadProc *vm_preload_proc;
492 /* What keys should be loaded in background when calling this command? */
493 int vm_firstkey; /* The first argument that's a key (0 = no keys) */
494 int vm_lastkey; /* THe last argument that's a key */
495 int vm_keystep; /* The step between first and last key */
496 };
497
498 struct redisFunctionSym {
499 char *name;
500 unsigned long pointer;
501 };
502
503 typedef struct _redisSortObject {
504 robj *obj;
505 union {
506 double score;
507 robj *cmpobj;
508 } u;
509 } redisSortObject;
510
511 typedef struct _redisSortOperation {
512 int type;
513 robj *pattern;
514 } redisSortOperation;
515
516 /* ZSETs use a specialized version of Skiplists */
517
518 typedef struct zskiplistNode {
519 struct zskiplistNode **forward;
520 struct zskiplistNode *backward;
521 unsigned int *span;
522 double score;
523 robj *obj;
524 } zskiplistNode;
525
526 typedef struct zskiplist {
527 struct zskiplistNode *header, *tail;
528 unsigned long length;
529 int level;
530 } zskiplist;
531
532 typedef struct zset {
533 dict *dict;
534 zskiplist *zsl;
535 } zset;
536
537 /* Our shared "common" objects */
538
539 #define REDIS_SHARED_INTEGERS 10000
540 struct sharedObjectsStruct {
541 robj *crlf, *ok, *err, *emptybulk, *czero, *cone, *pong, *space,
542 *colon, *nullbulk, *nullmultibulk, *queued,
543 *emptymultibulk, *wrongtypeerr, *nokeyerr, *syntaxerr, *sameobjecterr,
544 *outofrangeerr, *plus,
545 *select0, *select1, *select2, *select3, *select4,
546 *select5, *select6, *select7, *select8, *select9,
547 *messagebulk, *pmessagebulk, *subscribebulk, *unsubscribebulk, *mbulk3,
548 *mbulk4, *psubscribebulk, *punsubscribebulk,
549 *integers[REDIS_SHARED_INTEGERS];
550 } shared;
551
552 /* Global vars that are actally used as constants. The following double
553 * values are used for double on-disk serialization, and are initialized
554 * at runtime to avoid strange compiler optimizations. */
555
556 static double R_Zero, R_PosInf, R_NegInf, R_Nan;
557
558 /* VM threaded I/O request message */
559 #define REDIS_IOJOB_LOAD 0 /* Load from disk to memory */
560 #define REDIS_IOJOB_PREPARE_SWAP 1 /* Compute needed pages */
561 #define REDIS_IOJOB_DO_SWAP 2 /* Swap from memory to disk */
562 typedef struct iojob {
563 int type; /* Request type, REDIS_IOJOB_* */
564 redisDb *db;/* Redis database */
565 robj *key; /* This I/O request is about swapping this key */
566 robj *id; /* Unique identifier of this job:
567 this is the object to swap for REDIS_IOREQ_*_SWAP, or the
568 vmpointer objct for REDIS_IOREQ_LOAD. */
569 robj *val; /* the value to swap for REDIS_IOREQ_*_SWAP, otherwise this
570 * field is populated by the I/O thread for REDIS_IOREQ_LOAD. */
571 off_t page; /* Swap page where to read/write the object */
572 off_t pages; /* Swap pages needed to save object. PREPARE_SWAP return val */
573 int canceled; /* True if this command was canceled by blocking side of VM */
574 pthread_t thread; /* ID of the thread processing this entry */
575 } iojob;
576
577 /*================================ Prototypes =============================== */
578
579 static void freeStringObject(robj *o);
580 static void freeListObject(robj *o);
581 static void freeSetObject(robj *o);
582 static void decrRefCount(void *o);
583 static robj *createObject(int type, void *ptr);
584 static void freeClient(redisClient *c);
585 static int rdbLoad(char *filename);
586 static void addReply(redisClient *c, robj *obj);
587 static void addReplySds(redisClient *c, sds s);
588 static void incrRefCount(robj *o);
589 static int rdbSaveBackground(char *filename);
590 static robj *createStringObject(char *ptr, size_t len);
591 static robj *dupStringObject(robj *o);
592 static void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc);
593 static void replicationFeedMonitors(list *monitors, int dictid, robj **argv, int argc);
594 static void flushAppendOnlyFile(void);
595 static void feedAppendOnlyFile(struct redisCommand *cmd, int dictid, robj **argv, int argc);
596 static int syncWithMaster(void);
597 static robj *tryObjectEncoding(robj *o);
598 static robj *getDecodedObject(robj *o);
599 static int removeExpire(redisDb *db, robj *key);
600 static int expireIfNeeded(redisDb *db, robj *key);
601 static int deleteIfVolatile(redisDb *db, robj *key);
602 static int dbDelete(redisDb *db, robj *key);
603 static time_t getExpire(redisDb *db, robj *key);
604 static int setExpire(redisDb *db, robj *key, time_t when);
605 static void updateSlavesWaitingBgsave(int bgsaveerr);
606 static void freeMemoryIfNeeded(void);
607 static int processCommand(redisClient *c);
608 static void setupSigSegvAction(void);
609 static void rdbRemoveTempFile(pid_t childpid);
610 static void aofRemoveTempFile(pid_t childpid);
611 static size_t stringObjectLen(robj *o);
612 static void processInputBuffer(redisClient *c);
613 static zskiplist *zslCreate(void);
614 static void zslFree(zskiplist *zsl);
615 static void zslInsert(zskiplist *zsl, double score, robj *obj);
616 static void sendReplyToClientWritev(aeEventLoop *el, int fd, void *privdata, int mask);
617 static void initClientMultiState(redisClient *c);
618 static void freeClientMultiState(redisClient *c);
619 static void queueMultiCommand(redisClient *c, struct redisCommand *cmd);
620 static void unblockClientWaitingData(redisClient *c);
621 static int handleClientsWaitingListPush(redisClient *c, robj *key, robj *ele);
622 static void vmInit(void);
623 static void vmMarkPagesFree(off_t page, off_t count);
624 static robj *vmLoadObject(robj *o);
625 static robj *vmPreviewObject(robj *o);
626 static int vmSwapOneObjectBlocking(void);
627 static int vmSwapOneObjectThreaded(void);
628 static int vmCanSwapOut(void);
629 static int tryFreeOneObjectFromFreelist(void);
630 static void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask);
631 static void vmThreadedIOCompletedJob(aeEventLoop *el, int fd, void *privdata, int mask);
632 static void vmCancelThreadedIOJob(robj *o);
633 static void lockThreadedIO(void);
634 static void unlockThreadedIO(void);
635 static int vmSwapObjectThreaded(robj *key, robj *val, redisDb *db);
636 static void freeIOJob(iojob *j);
637 static void queueIOJob(iojob *j);
638 static int vmWriteObjectOnSwap(robj *o, off_t page);
639 static robj *vmReadObjectFromSwap(off_t page, int type);
640 static void waitEmptyIOJobsQueue(void);
641 static void vmReopenSwapFile(void);
642 static int vmFreePage(off_t page);
643 static void zunionInterBlockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd, int argc, robj **argv);
644 static void execBlockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd, int argc, robj **argv);
645 static int blockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd);
646 static int dontWaitForSwappedKey(redisClient *c, robj *key);
647 static void handleClientsBlockedOnSwappedKey(redisDb *db, robj *key);
648 static void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask);
649 static struct redisCommand *lookupCommand(char *name);
650 static void call(redisClient *c, struct redisCommand *cmd);
651 static void resetClient(redisClient *c);
652 static void convertToRealHash(robj *o);
653 static void listTypeConvert(robj *o, int enc);
654 static int pubsubUnsubscribeAllChannels(redisClient *c, int notify);
655 static int pubsubUnsubscribeAllPatterns(redisClient *c, int notify);
656 static void freePubsubPattern(void *p);
657 static int listMatchPubsubPattern(void *a, void *b);
658 static int compareStringObjects(robj *a, robj *b);
659 static int equalStringObjects(robj *a, robj *b);
660 static void usage();
661 static int rewriteAppendOnlyFileBackground(void);
662 static vmpointer *vmSwapObjectBlocking(robj *val);
663 static int prepareForShutdown();
664 static void touchWatchedKey(redisDb *db, robj *key);
665 static void touchWatchedKeysOnFlush(int dbid);
666 static void unwatchAllKeys(redisClient *c);
667
668 static void authCommand(redisClient *c);
669 static void pingCommand(redisClient *c);
670 static void echoCommand(redisClient *c);
671 static void setCommand(redisClient *c);
672 static void setnxCommand(redisClient *c);
673 static void setexCommand(redisClient *c);
674 static void getCommand(redisClient *c);
675 static void delCommand(redisClient *c);
676 static void existsCommand(redisClient *c);
677 static void incrCommand(redisClient *c);
678 static void decrCommand(redisClient *c);
679 static void incrbyCommand(redisClient *c);
680 static void decrbyCommand(redisClient *c);
681 static void selectCommand(redisClient *c);
682 static void randomkeyCommand(redisClient *c);
683 static void keysCommand(redisClient *c);
684 static void dbsizeCommand(redisClient *c);
685 static void lastsaveCommand(redisClient *c);
686 static void saveCommand(redisClient *c);
687 static void bgsaveCommand(redisClient *c);
688 static void bgrewriteaofCommand(redisClient *c);
689 static void shutdownCommand(redisClient *c);
690 static void moveCommand(redisClient *c);
691 static void renameCommand(redisClient *c);
692 static void renamenxCommand(redisClient *c);
693 static void lpushCommand(redisClient *c);
694 static void rpushCommand(redisClient *c);
695 static void lpushxCommand(redisClient *c);
696 static void rpushxCommand(redisClient *c);
697 static void linsertCommand(redisClient *c);
698 static void lpopCommand(redisClient *c);
699 static void rpopCommand(redisClient *c);
700 static void llenCommand(redisClient *c);
701 static void lindexCommand(redisClient *c);
702 static void lrangeCommand(redisClient *c);
703 static void ltrimCommand(redisClient *c);
704 static void typeCommand(redisClient *c);
705 static void lsetCommand(redisClient *c);
706 static void saddCommand(redisClient *c);
707 static void sremCommand(redisClient *c);
708 static void smoveCommand(redisClient *c);
709 static void sismemberCommand(redisClient *c);
710 static void scardCommand(redisClient *c);
711 static void spopCommand(redisClient *c);
712 static void srandmemberCommand(redisClient *c);
713 static void sinterCommand(redisClient *c);
714 static void sinterstoreCommand(redisClient *c);
715 static void sunionCommand(redisClient *c);
716 static void sunionstoreCommand(redisClient *c);
717 static void sdiffCommand(redisClient *c);
718 static void sdiffstoreCommand(redisClient *c);
719 static void syncCommand(redisClient *c);
720 static void flushdbCommand(redisClient *c);
721 static void flushallCommand(redisClient *c);
722 static void sortCommand(redisClient *c);
723 static void lremCommand(redisClient *c);
724 static void rpoplpushcommand(redisClient *c);
725 static void infoCommand(redisClient *c);
726 static void mgetCommand(redisClient *c);
727 static void monitorCommand(redisClient *c);
728 static void expireCommand(redisClient *c);
729 static void expireatCommand(redisClient *c);
730 static void getsetCommand(redisClient *c);
731 static void ttlCommand(redisClient *c);
732 static void slaveofCommand(redisClient *c);
733 static void debugCommand(redisClient *c);
734 static void msetCommand(redisClient *c);
735 static void msetnxCommand(redisClient *c);
736 static void zaddCommand(redisClient *c);
737 static void zincrbyCommand(redisClient *c);
738 static void zrangeCommand(redisClient *c);
739 static void zrangebyscoreCommand(redisClient *c);
740 static void zcountCommand(redisClient *c);
741 static void zrevrangeCommand(redisClient *c);
742 static void zcardCommand(redisClient *c);
743 static void zremCommand(redisClient *c);
744 static void zscoreCommand(redisClient *c);
745 static void zremrangebyscoreCommand(redisClient *c);
746 static void multiCommand(redisClient *c);
747 static void execCommand(redisClient *c);
748 static void discardCommand(redisClient *c);
749 static void blpopCommand(redisClient *c);
750 static void brpopCommand(redisClient *c);
751 static void appendCommand(redisClient *c);
752 static void substrCommand(redisClient *c);
753 static void zrankCommand(redisClient *c);
754 static void zrevrankCommand(redisClient *c);
755 static void hsetCommand(redisClient *c);
756 static void hsetnxCommand(redisClient *c);
757 static void hgetCommand(redisClient *c);
758 static void hmsetCommand(redisClient *c);
759 static void hmgetCommand(redisClient *c);
760 static void hdelCommand(redisClient *c);
761 static void hlenCommand(redisClient *c);
762 static void zremrangebyrankCommand(redisClient *c);
763 static void zunionstoreCommand(redisClient *c);
764 static void zinterstoreCommand(redisClient *c);
765 static void hkeysCommand(redisClient *c);
766 static void hvalsCommand(redisClient *c);
767 static void hgetallCommand(redisClient *c);
768 static void hexistsCommand(redisClient *c);
769 static void configCommand(redisClient *c);
770 static void hincrbyCommand(redisClient *c);
771 static void subscribeCommand(redisClient *c);
772 static void unsubscribeCommand(redisClient *c);
773 static void psubscribeCommand(redisClient *c);
774 static void punsubscribeCommand(redisClient *c);
775 static void publishCommand(redisClient *c);
776 static void watchCommand(redisClient *c);
777 static void unwatchCommand(redisClient *c);
778
779 /*================================= Globals ================================= */
780
781 /* Global vars */
782 static struct redisServer server; /* server global state */
783 static struct redisCommand *commandTable;
784 static struct redisCommand readonlyCommandTable[] = {
785 {"get",getCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
786 {"set",setCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,0,0,0},
787 {"setnx",setnxCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,0,0,0},
788 {"setex",setexCommand,4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,0,0,0},
789 {"append",appendCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
790 {"substr",substrCommand,4,REDIS_CMD_INLINE,NULL,1,1,1},
791 {"del",delCommand,-2,REDIS_CMD_INLINE,NULL,0,0,0},
792 {"exists",existsCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
793 {"incr",incrCommand,2,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,1,1},
794 {"decr",decrCommand,2,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,1,1},
795 {"mget",mgetCommand,-2,REDIS_CMD_INLINE,NULL,1,-1,1},
796 {"rpush",rpushCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
797 {"lpush",lpushCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
798 {"rpushx",rpushxCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
799 {"lpushx",lpushxCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
800 {"linsert",linsertCommand,5,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
801 {"rpop",rpopCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
802 {"lpop",lpopCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
803 {"brpop",brpopCommand,-3,REDIS_CMD_INLINE,NULL,1,1,1},
804 {"blpop",blpopCommand,-3,REDIS_CMD_INLINE,NULL,1,1,1},
805 {"llen",llenCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
806 {"lindex",lindexCommand,3,REDIS_CMD_INLINE,NULL,1,1,1},
807 {"lset",lsetCommand,4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
808 {"lrange",lrangeCommand,4,REDIS_CMD_INLINE,NULL,1,1,1},
809 {"ltrim",ltrimCommand,4,REDIS_CMD_INLINE,NULL,1,1,1},
810 {"lrem",lremCommand,4,REDIS_CMD_BULK,NULL,1,1,1},
811 {"rpoplpush",rpoplpushcommand,3,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,2,1},
812 {"sadd",saddCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
813 {"srem",sremCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
814 {"smove",smoveCommand,4,REDIS_CMD_BULK,NULL,1,2,1},
815 {"sismember",sismemberCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
816 {"scard",scardCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
817 {"spop",spopCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
818 {"srandmember",srandmemberCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
819 {"sinter",sinterCommand,-2,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,-1,1},
820 {"sinterstore",sinterstoreCommand,-3,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,2,-1,1},
821 {"sunion",sunionCommand,-2,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,-1,1},
822 {"sunionstore",sunionstoreCommand,-3,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,2,-1,1},
823 {"sdiff",sdiffCommand,-2,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,-1,1},
824 {"sdiffstore",sdiffstoreCommand,-3,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,2,-1,1},
825 {"smembers",sinterCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
826 {"zadd",zaddCommand,4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
827 {"zincrby",zincrbyCommand,4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
828 {"zrem",zremCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
829 {"zremrangebyscore",zremrangebyscoreCommand,4,REDIS_CMD_INLINE,NULL,1,1,1},
830 {"zremrangebyrank",zremrangebyrankCommand,4,REDIS_CMD_INLINE,NULL,1,1,1},
831 {"zunionstore",zunionstoreCommand,-4,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,zunionInterBlockClientOnSwappedKeys,0,0,0},
832 {"zinterstore",zinterstoreCommand,-4,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,zunionInterBlockClientOnSwappedKeys,0,0,0},
833 {"zrange",zrangeCommand,-4,REDIS_CMD_INLINE,NULL,1,1,1},
834 {"zrangebyscore",zrangebyscoreCommand,-4,REDIS_CMD_INLINE,NULL,1,1,1},
835 {"zcount",zcountCommand,4,REDIS_CMD_INLINE,NULL,1,1,1},
836 {"zrevrange",zrevrangeCommand,-4,REDIS_CMD_INLINE,NULL,1,1,1},
837 {"zcard",zcardCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
838 {"zscore",zscoreCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
839 {"zrank",zrankCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
840 {"zrevrank",zrevrankCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
841 {"hset",hsetCommand,4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
842 {"hsetnx",hsetnxCommand,4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
843 {"hget",hgetCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
844 {"hmset",hmsetCommand,-4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
845 {"hmget",hmgetCommand,-3,REDIS_CMD_BULK,NULL,1,1,1},
846 {"hincrby",hincrbyCommand,4,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,1,1},
847 {"hdel",hdelCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
848 {"hlen",hlenCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
849 {"hkeys",hkeysCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
850 {"hvals",hvalsCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
851 {"hgetall",hgetallCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
852 {"hexists",hexistsCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
853 {"incrby",incrbyCommand,3,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,1,1},
854 {"decrby",decrbyCommand,3,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,1,1},
855 {"getset",getsetCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
856 {"mset",msetCommand,-3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,-1,2},
857 {"msetnx",msetnxCommand,-3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,-1,2},
858 {"randomkey",randomkeyCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
859 {"select",selectCommand,2,REDIS_CMD_INLINE,NULL,0,0,0},
860 {"move",moveCommand,3,REDIS_CMD_INLINE,NULL,1,1,1},
861 {"rename",renameCommand,3,REDIS_CMD_INLINE,NULL,1,1,1},
862 {"renamenx",renamenxCommand,3,REDIS_CMD_INLINE,NULL,1,1,1},
863 {"expire",expireCommand,3,REDIS_CMD_INLINE,NULL,0,0,0},
864 {"expireat",expireatCommand,3,REDIS_CMD_INLINE,NULL,0,0,0},
865 {"keys",keysCommand,2,REDIS_CMD_INLINE,NULL,0,0,0},
866 {"dbsize",dbsizeCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
867 {"auth",authCommand,2,REDIS_CMD_INLINE,NULL,0,0,0},
868 {"ping",pingCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
869 {"echo",echoCommand,2,REDIS_CMD_BULK,NULL,0,0,0},
870 {"save",saveCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
871 {"bgsave",bgsaveCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
872 {"bgrewriteaof",bgrewriteaofCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
873 {"shutdown",shutdownCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
874 {"lastsave",lastsaveCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
875 {"type",typeCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
876 {"multi",multiCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
877 {"exec",execCommand,1,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,execBlockClientOnSwappedKeys,0,0,0},
878 {"discard",discardCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
879 {"sync",syncCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
880 {"flushdb",flushdbCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
881 {"flushall",flushallCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
882 {"sort",sortCommand,-2,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,1,1},
883 {"info",infoCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
884 {"monitor",monitorCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
885 {"ttl",ttlCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
886 {"slaveof",slaveofCommand,3,REDIS_CMD_INLINE,NULL,0,0,0},
887 {"debug",debugCommand,-2,REDIS_CMD_INLINE,NULL,0,0,0},
888 {"config",configCommand,-2,REDIS_CMD_BULK,NULL,0,0,0},
889 {"subscribe",subscribeCommand,-2,REDIS_CMD_INLINE,NULL,0,0,0},
890 {"unsubscribe",unsubscribeCommand,-1,REDIS_CMD_INLINE,NULL,0,0,0},
891 {"psubscribe",psubscribeCommand,-2,REDIS_CMD_INLINE,NULL,0,0,0},
892 {"punsubscribe",punsubscribeCommand,-1,REDIS_CMD_INLINE,NULL,0,0,0},
893 {"publish",publishCommand,3,REDIS_CMD_BULK|REDIS_CMD_FORCE_REPLICATION,NULL,0,0,0},
894 {"watch",watchCommand,-2,REDIS_CMD_INLINE,NULL,0,0,0},
895 {"unwatch",unwatchCommand,1,REDIS_CMD_INLINE,NULL,0,0,0}
896 };
897
898 /*============================ Utility functions ============================ */
899
900 /* Glob-style pattern matching. */
901 static int stringmatchlen(const char *pattern, int patternLen,
902 const char *string, int stringLen, int nocase)
903 {
904 while(patternLen) {
905 switch(pattern[0]) {
906 case '*':
907 while (pattern[1] == '*') {
908 pattern++;
909 patternLen--;
910 }
911 if (patternLen == 1)
912 return 1; /* match */
913 while(stringLen) {
914 if (stringmatchlen(pattern+1, patternLen-1,
915 string, stringLen, nocase))
916 return 1; /* match */
917 string++;
918 stringLen--;
919 }
920 return 0; /* no match */
921 break;
922 case '?':
923 if (stringLen == 0)
924 return 0; /* no match */
925 string++;
926 stringLen--;
927 break;
928 case '[':
929 {
930 int not, match;
931
932 pattern++;
933 patternLen--;
934 not = pattern[0] == '^';
935 if (not) {
936 pattern++;
937 patternLen--;
938 }
939 match = 0;
940 while(1) {
941 if (pattern[0] == '\\') {
942 pattern++;
943 patternLen--;
944 if (pattern[0] == string[0])
945 match = 1;
946 } else if (pattern[0] == ']') {
947 break;
948 } else if (patternLen == 0) {
949 pattern--;
950 patternLen++;
951 break;
952 } else if (pattern[1] == '-' && patternLen >= 3) {
953 int start = pattern[0];
954 int end = pattern[2];
955 int c = string[0];
956 if (start > end) {
957 int t = start;
958 start = end;
959 end = t;
960 }
961 if (nocase) {
962 start = tolower(start);
963 end = tolower(end);
964 c = tolower(c);
965 }
966 pattern += 2;
967 patternLen -= 2;
968 if (c >= start && c <= end)
969 match = 1;
970 } else {
971 if (!nocase) {
972 if (pattern[0] == string[0])
973 match = 1;
974 } else {
975 if (tolower((int)pattern[0]) == tolower((int)string[0]))
976 match = 1;
977 }
978 }
979 pattern++;
980 patternLen--;
981 }
982 if (not)
983 match = !match;
984 if (!match)
985 return 0; /* no match */
986 string++;
987 stringLen--;
988 break;
989 }
990 case '\\':
991 if (patternLen >= 2) {
992 pattern++;
993 patternLen--;
994 }
995 /* fall through */
996 default:
997 if (!nocase) {
998 if (pattern[0] != string[0])
999 return 0; /* no match */
1000 } else {
1001 if (tolower((int)pattern[0]) != tolower((int)string[0]))
1002 return 0; /* no match */
1003 }
1004 string++;
1005 stringLen--;
1006 break;
1007 }
1008 pattern++;
1009 patternLen--;
1010 if (stringLen == 0) {
1011 while(*pattern == '*') {
1012 pattern++;
1013 patternLen--;
1014 }
1015 break;
1016 }
1017 }
1018 if (patternLen == 0 && stringLen == 0)
1019 return 1;
1020 return 0;
1021 }
1022
1023 static int stringmatch(const char *pattern, const char *string, int nocase) {
1024 return stringmatchlen(pattern,strlen(pattern),string,strlen(string),nocase);
1025 }
1026
1027 /* Convert a string representing an amount of memory into the number of
1028 * bytes, so for instance memtoll("1Gi") will return 1073741824 that is
1029 * (1024*1024*1024).
1030 *
1031 * On parsing error, if *err is not NULL, it's set to 1, otherwise it's
1032 * set to 0 */
1033 static long long memtoll(const char *p, int *err) {
1034 const char *u;
1035 char buf[128];
1036 long mul; /* unit multiplier */
1037 long long val;
1038 unsigned int digits;
1039
1040 if (err) *err = 0;
1041 /* Search the first non digit character. */
1042 u = p;
1043 if (*u == '-') u++;
1044 while(*u && isdigit(*u)) u++;
1045 if (*u == '\0' || !strcasecmp(u,"b")) {
1046 mul = 1;
1047 } else if (!strcasecmp(u,"k")) {
1048 mul = 1000;
1049 } else if (!strcasecmp(u,"kb")) {
1050 mul = 1024;
1051 } else if (!strcasecmp(u,"m")) {
1052 mul = 1000*1000;
1053 } else if (!strcasecmp(u,"mb")) {
1054 mul = 1024*1024;
1055 } else if (!strcasecmp(u,"g")) {
1056 mul = 1000L*1000*1000;
1057 } else if (!strcasecmp(u,"gb")) {
1058 mul = 1024L*1024*1024;
1059 } else {
1060 if (err) *err = 1;
1061 mul = 1;
1062 }
1063 digits = u-p;
1064 if (digits >= sizeof(buf)) {
1065 if (err) *err = 1;
1066 return LLONG_MAX;
1067 }
1068 memcpy(buf,p,digits);
1069 buf[digits] = '\0';
1070 val = strtoll(buf,NULL,10);
1071 return val*mul;
1072 }
1073
1074 /* Convert a long long into a string. Returns the number of
1075 * characters needed to represent the number, that can be shorter if passed
1076 * buffer length is not enough to store the whole number. */
1077 static int ll2string(char *s, size_t len, long long value) {
1078 char buf[32], *p;
1079 unsigned long long v;
1080 size_t l;
1081
1082 if (len == 0) return 0;
1083 v = (value < 0) ? -value : value;
1084 p = buf+31; /* point to the last character */
1085 do {
1086 *p-- = '0'+(v%10);
1087 v /= 10;
1088 } while(v);
1089 if (value < 0) *p-- = '-';
1090 p++;
1091 l = 32-(p-buf);
1092 if (l+1 > len) l = len-1; /* Make sure it fits, including the nul term */
1093 memcpy(s,p,l);
1094 s[l] = '\0';
1095 return l;
1096 }
1097
1098 static void redisLog(int level, const char *fmt, ...) {
1099 va_list ap;
1100 FILE *fp;
1101
1102 fp = (server.logfile == NULL) ? stdout : fopen(server.logfile,"a");
1103 if (!fp) return;
1104
1105 va_start(ap, fmt);
1106 if (level >= server.verbosity) {
1107 char *c = ".-*#";
1108 char buf[64];
1109 time_t now;
1110
1111 now = time(NULL);
1112 strftime(buf,64,"%d %b %H:%M:%S",localtime(&now));
1113 fprintf(fp,"[%d] %s %c ",(int)getpid(),buf,c[level]);
1114 vfprintf(fp, fmt, ap);
1115 fprintf(fp,"\n");
1116 fflush(fp);
1117 }
1118 va_end(ap);
1119
1120 if (server.logfile) fclose(fp);
1121 }
1122
1123 /*====================== Hash table type implementation ==================== */
1124
1125 /* This is an hash table type that uses the SDS dynamic strings libary as
1126 * keys and radis objects as values (objects can hold SDS strings,
1127 * lists, sets). */
1128
1129 static void dictVanillaFree(void *privdata, void *val)
1130 {
1131 DICT_NOTUSED(privdata);
1132 zfree(val);
1133 }
1134
1135 static void dictListDestructor(void *privdata, void *val)
1136 {
1137 DICT_NOTUSED(privdata);
1138 listRelease((list*)val);
1139 }
1140
1141 static int dictSdsKeyCompare(void *privdata, const void *key1,
1142 const void *key2)
1143 {
1144 int l1,l2;
1145 DICT_NOTUSED(privdata);
1146
1147 l1 = sdslen((sds)key1);
1148 l2 = sdslen((sds)key2);
1149 if (l1 != l2) return 0;
1150 return memcmp(key1, key2, l1) == 0;
1151 }
1152
1153 static void dictRedisObjectDestructor(void *privdata, void *val)
1154 {
1155 DICT_NOTUSED(privdata);
1156
1157 if (val == NULL) return; /* Values of swapped out keys as set to NULL */
1158 decrRefCount(val);
1159 }
1160
1161 static void dictSdsDestructor(void *privdata, void *val)
1162 {
1163 DICT_NOTUSED(privdata);
1164
1165 sdsfree(val);
1166 }
1167
1168 static int dictObjKeyCompare(void *privdata, const void *key1,
1169 const void *key2)
1170 {
1171 const robj *o1 = key1, *o2 = key2;
1172 return dictSdsKeyCompare(privdata,o1->ptr,o2->ptr);
1173 }
1174
1175 static unsigned int dictObjHash(const void *key) {
1176 const robj *o = key;
1177 return dictGenHashFunction(o->ptr, sdslen((sds)o->ptr));
1178 }
1179
1180 static unsigned int dictSdsHash(const void *key) {
1181 return dictGenHashFunction((unsigned char*)key, sdslen((char*)key));
1182 }
1183
1184 static int dictEncObjKeyCompare(void *privdata, const void *key1,
1185 const void *key2)
1186 {
1187 robj *o1 = (robj*) key1, *o2 = (robj*) key2;
1188 int cmp;
1189
1190 if (o1->encoding == REDIS_ENCODING_INT &&
1191 o2->encoding == REDIS_ENCODING_INT)
1192 return o1->ptr == o2->ptr;
1193
1194 o1 = getDecodedObject(o1);
1195 o2 = getDecodedObject(o2);
1196 cmp = dictSdsKeyCompare(privdata,o1->ptr,o2->ptr);
1197 decrRefCount(o1);
1198 decrRefCount(o2);
1199 return cmp;
1200 }
1201
1202 static unsigned int dictEncObjHash(const void *key) {
1203 robj *o = (robj*) key;
1204
1205 if (o->encoding == REDIS_ENCODING_RAW) {
1206 return dictGenHashFunction(o->ptr, sdslen((sds)o->ptr));
1207 } else {
1208 if (o->encoding == REDIS_ENCODING_INT) {
1209 char buf[32];
1210 int len;
1211
1212 len = ll2string(buf,32,(long)o->ptr);
1213 return dictGenHashFunction((unsigned char*)buf, len);
1214 } else {
1215 unsigned int hash;
1216
1217 o = getDecodedObject(o);
1218 hash = dictGenHashFunction(o->ptr, sdslen((sds)o->ptr));
1219 decrRefCount(o);
1220 return hash;
1221 }
1222 }
1223 }
1224
1225 /* Sets type */
1226 static dictType setDictType = {
1227 dictEncObjHash, /* hash function */
1228 NULL, /* key dup */
1229 NULL, /* val dup */
1230 dictEncObjKeyCompare, /* key compare */
1231 dictRedisObjectDestructor, /* key destructor */
1232 NULL /* val destructor */
1233 };
1234
1235 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
1236 static dictType zsetDictType = {
1237 dictEncObjHash, /* hash function */
1238 NULL, /* key dup */
1239 NULL, /* val dup */
1240 dictEncObjKeyCompare, /* key compare */
1241 dictRedisObjectDestructor, /* key destructor */
1242 dictVanillaFree /* val destructor of malloc(sizeof(double)) */
1243 };
1244
1245 /* Db->dict, keys are sds strings, vals are Redis objects. */
1246 static dictType dbDictType = {
1247 dictSdsHash, /* hash function */
1248 NULL, /* key dup */
1249 NULL, /* val dup */
1250 dictSdsKeyCompare, /* key compare */
1251 dictSdsDestructor, /* key destructor */
1252 dictRedisObjectDestructor /* val destructor */
1253 };
1254
1255 /* Db->expires */
1256 static dictType keyptrDictType = {
1257 dictSdsHash, /* hash function */
1258 NULL, /* key dup */
1259 NULL, /* val dup */
1260 dictSdsKeyCompare, /* key compare */
1261 dictSdsDestructor, /* key destructor */
1262 NULL /* val destructor */
1263 };
1264
1265 /* Hash type hash table (note that small hashes are represented with zimpaps) */
1266 static dictType hashDictType = {
1267 dictEncObjHash, /* hash function */
1268 NULL, /* key dup */
1269 NULL, /* val dup */
1270 dictEncObjKeyCompare, /* key compare */
1271 dictRedisObjectDestructor, /* key destructor */
1272 dictRedisObjectDestructor /* val destructor */
1273 };
1274
1275 /* Keylist hash table type has unencoded redis objects as keys and
1276 * lists as values. It's used for blocking operations (BLPOP) and to
1277 * map swapped keys to a list of clients waiting for this keys to be loaded. */
1278 static dictType keylistDictType = {
1279 dictObjHash, /* hash function */
1280 NULL, /* key dup */
1281 NULL, /* val dup */
1282 dictObjKeyCompare, /* key compare */
1283 dictRedisObjectDestructor, /* key destructor */
1284 dictListDestructor /* val destructor */
1285 };
1286
1287 static void version();
1288
1289 /* ========================= Random utility functions ======================= */
1290
1291 /* Redis generally does not try to recover from out of memory conditions
1292 * when allocating objects or strings, it is not clear if it will be possible
1293 * to report this condition to the client since the networking layer itself
1294 * is based on heap allocation for send buffers, so we simply abort.
1295 * At least the code will be simpler to read... */
1296 static void oom(const char *msg) {
1297 redisLog(REDIS_WARNING, "%s: Out of memory\n",msg);
1298 sleep(1);
1299 abort();
1300 }
1301
1302 /* ====================== Redis server networking stuff ===================== */
1303 static void closeTimedoutClients(void) {
1304 redisClient *c;
1305 listNode *ln;
1306 time_t now = time(NULL);
1307 listIter li;
1308
1309 listRewind(server.clients,&li);
1310 while ((ln = listNext(&li)) != NULL) {
1311 c = listNodeValue(ln);
1312 if (server.maxidletime &&
1313 !(c->flags & REDIS_SLAVE) && /* no timeout for slaves */
1314 !(c->flags & REDIS_MASTER) && /* no timeout for masters */
1315 dictSize(c->pubsub_channels) == 0 && /* no timeout for pubsub */
1316 listLength(c->pubsub_patterns) == 0 &&
1317 (now - c->lastinteraction > server.maxidletime))
1318 {
1319 redisLog(REDIS_VERBOSE,"Closing idle client");
1320 freeClient(c);
1321 } else if (c->flags & REDIS_BLOCKED) {
1322 if (c->blockingto != 0 && c->blockingto < now) {
1323 addReply(c,shared.nullmultibulk);
1324 unblockClientWaitingData(c);
1325 }
1326 }
1327 }
1328 }
1329
1330 static int htNeedsResize(dict *dict) {
1331 long long size, used;
1332
1333 size = dictSlots(dict);
1334 used = dictSize(dict);
1335 return (size && used && size > DICT_HT_INITIAL_SIZE &&
1336 (used*100/size < REDIS_HT_MINFILL));
1337 }
1338
1339 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
1340 * we resize the hash table to save memory */
1341 static void tryResizeHashTables(void) {
1342 int j;
1343
1344 for (j = 0; j < server.dbnum; j++) {
1345 if (htNeedsResize(server.db[j].dict))
1346 dictResize(server.db[j].dict);
1347 if (htNeedsResize(server.db[j].expires))
1348 dictResize(server.db[j].expires);
1349 }
1350 }
1351
1352 /* Our hash table implementation performs rehashing incrementally while
1353 * we write/read from the hash table. Still if the server is idle, the hash
1354 * table will use two tables for a long time. So we try to use 1 millisecond
1355 * of CPU time at every serverCron() loop in order to rehash some key. */
1356 static void incrementallyRehash(void) {
1357 int j;
1358
1359 for (j = 0; j < server.dbnum; j++) {
1360 if (dictIsRehashing(server.db[j].dict)) {
1361 dictRehashMilliseconds(server.db[j].dict,1);
1362 break; /* already used our millisecond for this loop... */
1363 }
1364 }
1365 }
1366
1367 /* A background saving child (BGSAVE) terminated its work. Handle this. */
1368 void backgroundSaveDoneHandler(int statloc) {
1369 int exitcode = WEXITSTATUS(statloc);
1370 int bysignal = WIFSIGNALED(statloc);
1371
1372 if (!bysignal && exitcode == 0) {
1373 redisLog(REDIS_NOTICE,
1374 "Background saving terminated with success");
1375 server.dirty = 0;
1376 server.lastsave = time(NULL);
1377 } else if (!bysignal && exitcode != 0) {
1378 redisLog(REDIS_WARNING, "Background saving error");
1379 } else {
1380 redisLog(REDIS_WARNING,
1381 "Background saving terminated by signal %d", WTERMSIG(statloc));
1382 rdbRemoveTempFile(server.bgsavechildpid);
1383 }
1384 server.bgsavechildpid = -1;
1385 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1386 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1387 updateSlavesWaitingBgsave(exitcode == 0 ? REDIS_OK : REDIS_ERR);
1388 }
1389
1390 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1391 * Handle this. */
1392 void backgroundRewriteDoneHandler(int statloc) {
1393 int exitcode = WEXITSTATUS(statloc);
1394 int bysignal = WIFSIGNALED(statloc);
1395
1396 if (!bysignal && exitcode == 0) {
1397 int fd;
1398 char tmpfile[256];
1399
1400 redisLog(REDIS_NOTICE,
1401 "Background append only file rewriting terminated with success");
1402 /* Now it's time to flush the differences accumulated by the parent */
1403 snprintf(tmpfile,256,"temp-rewriteaof-bg-%d.aof", (int) server.bgrewritechildpid);
1404 fd = open(tmpfile,O_WRONLY|O_APPEND);
1405 if (fd == -1) {
1406 redisLog(REDIS_WARNING, "Not able to open the temp append only file produced by the child: %s", strerror(errno));
1407 goto cleanup;
1408 }
1409 /* Flush our data... */
1410 if (write(fd,server.bgrewritebuf,sdslen(server.bgrewritebuf)) !=
1411 (signed) sdslen(server.bgrewritebuf)) {
1412 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));
1413 close(fd);
1414 goto cleanup;
1415 }
1416 redisLog(REDIS_NOTICE,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server.bgrewritebuf));
1417 /* Now our work is to rename the temp file into the stable file. And
1418 * switch the file descriptor used by the server for append only. */
1419 if (rename(tmpfile,server.appendfilename) == -1) {
1420 redisLog(REDIS_WARNING,"Can't rename the temp append only file into the stable one: %s", strerror(errno));
1421 close(fd);
1422 goto cleanup;
1423 }
1424 /* Mission completed... almost */
1425 redisLog(REDIS_NOTICE,"Append only file successfully rewritten.");
1426 if (server.appendfd != -1) {
1427 /* If append only is actually enabled... */
1428 close(server.appendfd);
1429 server.appendfd = fd;
1430 if (server.appendfsync != APPENDFSYNC_NO) aof_fsync(fd);
1431 server.appendseldb = -1; /* Make sure it will issue SELECT */
1432 redisLog(REDIS_NOTICE,"The new append only file was selected for future appends.");
1433 } else {
1434 /* If append only is disabled we just generate a dump in this
1435 * format. Why not? */
1436 close(fd);
1437 }
1438 } else if (!bysignal && exitcode != 0) {
1439 redisLog(REDIS_WARNING, "Background append only file rewriting error");
1440 } else {
1441 redisLog(REDIS_WARNING,
1442 "Background append only file rewriting terminated by signal %d",
1443 WTERMSIG(statloc));
1444 }
1445 cleanup:
1446 sdsfree(server.bgrewritebuf);
1447 server.bgrewritebuf = sdsempty();
1448 aofRemoveTempFile(server.bgrewritechildpid);
1449 server.bgrewritechildpid = -1;
1450 }
1451
1452 /* This function is called once a background process of some kind terminates,
1453 * as we want to avoid resizing the hash tables when there is a child in order
1454 * to play well with copy-on-write (otherwise when a resize happens lots of
1455 * memory pages are copied). The goal of this function is to update the ability
1456 * for dict.c to resize the hash tables accordingly to the fact we have o not
1457 * running childs. */
1458 static void updateDictResizePolicy(void) {
1459 if (server.bgsavechildpid == -1 && server.bgrewritechildpid == -1)
1460 dictEnableResize();
1461 else
1462 dictDisableResize();
1463 }
1464
1465 static int serverCron(struct aeEventLoop *eventLoop, long long id, void *clientData) {
1466 int j, loops = server.cronloops++;
1467 REDIS_NOTUSED(eventLoop);
1468 REDIS_NOTUSED(id);
1469 REDIS_NOTUSED(clientData);
1470
1471 /* We take a cached value of the unix time in the global state because
1472 * with virtual memory and aging there is to store the current time
1473 * in objects at every object access, and accuracy is not needed.
1474 * To access a global var is faster than calling time(NULL) */
1475 server.unixtime = time(NULL);
1476 /* We have just 21 bits per object for LRU information.
1477 * So we use an (eventually wrapping) LRU clock with minutes resolution.
1478 *
1479 * When we need to select what object to swap, we compute the minimum
1480 * time distance between the current lruclock and the object last access
1481 * lruclock info. Even if clocks will wrap on overflow, there is
1482 * the interesting property that we are sure that at least
1483 * ABS(A-B) minutes passed between current time and timestamp B.
1484 *
1485 * This is not precise but we don't need at all precision, but just
1486 * something statistically reasonable.
1487 */
1488 server.lruclock = (time(NULL)/60)&((1<<21)-1);
1489
1490 /* We received a SIGTERM, shutting down here in a safe way, as it is
1491 * not ok doing so inside the signal handler. */
1492 if (server.shutdown_asap) {
1493 if (prepareForShutdown() == REDIS_OK) exit(0);
1494 redisLog(REDIS_WARNING,"SIGTERM received but errors trying to shut down the server, check the logs for more information");
1495 }
1496
1497 /* Show some info about non-empty databases */
1498 for (j = 0; j < server.dbnum; j++) {
1499 long long size, used, vkeys;
1500
1501 size = dictSlots(server.db[j].dict);
1502 used = dictSize(server.db[j].dict);
1503 vkeys = dictSize(server.db[j].expires);
1504 if (!(loops % 50) && (used || vkeys)) {
1505 redisLog(REDIS_VERBOSE,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j,used,vkeys,size);
1506 /* dictPrintStats(server.dict); */
1507 }
1508 }
1509
1510 /* We don't want to resize the hash tables while a bacground saving
1511 * is in progress: the saving child is created using fork() that is
1512 * implemented with a copy-on-write semantic in most modern systems, so
1513 * if we resize the HT while there is the saving child at work actually
1514 * a lot of memory movements in the parent will cause a lot of pages
1515 * copied. */
1516 if (server.bgsavechildpid == -1 && server.bgrewritechildpid == -1) {
1517 if (!(loops % 10)) tryResizeHashTables();
1518 if (server.activerehashing) incrementallyRehash();
1519 }
1520
1521 /* Show information about connected clients */
1522 if (!(loops % 50)) {
1523 redisLog(REDIS_VERBOSE,"%d clients connected (%d slaves), %zu bytes in use",
1524 listLength(server.clients)-listLength(server.slaves),
1525 listLength(server.slaves),
1526 zmalloc_used_memory());
1527 }
1528
1529 /* Close connections of timedout clients */
1530 if ((server.maxidletime && !(loops % 100)) || server.blpop_blocked_clients)
1531 closeTimedoutClients();
1532
1533 /* Check if a background saving or AOF rewrite in progress terminated */
1534 if (server.bgsavechildpid != -1 || server.bgrewritechildpid != -1) {
1535 int statloc;
1536 pid_t pid;
1537
1538 if ((pid = wait3(&statloc,WNOHANG,NULL)) != 0) {
1539 if (pid == server.bgsavechildpid) {
1540 backgroundSaveDoneHandler(statloc);
1541 } else {
1542 backgroundRewriteDoneHandler(statloc);
1543 }
1544 updateDictResizePolicy();
1545 }
1546 } else {
1547 /* If there is not a background saving in progress check if
1548 * we have to save now */
1549 time_t now = time(NULL);
1550 for (j = 0; j < server.saveparamslen; j++) {
1551 struct saveparam *sp = server.saveparams+j;
1552
1553 if (server.dirty >= sp->changes &&
1554 now-server.lastsave > sp->seconds) {
1555 redisLog(REDIS_NOTICE,"%d changes in %d seconds. Saving...",
1556 sp->changes, sp->seconds);
1557 rdbSaveBackground(server.dbfilename);
1558 break;
1559 }
1560 }
1561 }
1562
1563 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1564 * will use few CPU cycles if there are few expiring keys, otherwise
1565 * it will get more aggressive to avoid that too much memory is used by
1566 * keys that can be removed from the keyspace. */
1567 for (j = 0; j < server.dbnum; j++) {
1568 int expired;
1569 redisDb *db = server.db+j;
1570
1571 /* Continue to expire if at the end of the cycle more than 25%
1572 * of the keys were expired. */
1573 do {
1574 long num = dictSize(db->expires);
1575 time_t now = time(NULL);
1576
1577 expired = 0;
1578 if (num > REDIS_EXPIRELOOKUPS_PER_CRON)
1579 num = REDIS_EXPIRELOOKUPS_PER_CRON;
1580 while (num--) {
1581 dictEntry *de;
1582 time_t t;
1583
1584 if ((de = dictGetRandomKey(db->expires)) == NULL) break;
1585 t = (time_t) dictGetEntryVal(de);
1586 if (now > t) {
1587 sds key = dictGetEntryKey(de);
1588 robj *keyobj = createStringObject(key,sdslen(key));
1589
1590 dbDelete(db,keyobj);
1591 decrRefCount(keyobj);
1592 expired++;
1593 server.stat_expiredkeys++;
1594 }
1595 }
1596 } while (expired > REDIS_EXPIRELOOKUPS_PER_CRON/4);
1597 }
1598
1599 /* Swap a few keys on disk if we are over the memory limit and VM
1600 * is enbled. Try to free objects from the free list first. */
1601 if (vmCanSwapOut()) {
1602 while (server.vm_enabled && zmalloc_used_memory() >
1603 server.vm_max_memory)
1604 {
1605 int retval;
1606
1607 if (tryFreeOneObjectFromFreelist() == REDIS_OK) continue;
1608 retval = (server.vm_max_threads == 0) ?
1609 vmSwapOneObjectBlocking() :
1610 vmSwapOneObjectThreaded();
1611 if (retval == REDIS_ERR && !(loops % 300) &&
1612 zmalloc_used_memory() >
1613 (server.vm_max_memory+server.vm_max_memory/10))
1614 {
1615 redisLog(REDIS_WARNING,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1616 }
1617 /* Note that when using threade I/O we free just one object,
1618 * because anyway when the I/O thread in charge to swap this
1619 * object out will finish, the handler of completed jobs
1620 * will try to swap more objects if we are still out of memory. */
1621 if (retval == REDIS_ERR || server.vm_max_threads > 0) break;
1622 }
1623 }
1624
1625 /* Check if we should connect to a MASTER */
1626 if (server.replstate == REDIS_REPL_CONNECT && !(loops % 10)) {
1627 redisLog(REDIS_NOTICE,"Connecting to MASTER...");
1628 if (syncWithMaster() == REDIS_OK) {
1629 redisLog(REDIS_NOTICE,"MASTER <-> SLAVE sync succeeded");
1630 if (server.appendonly) rewriteAppendOnlyFileBackground();
1631 }
1632 }
1633 return 100;
1634 }
1635
1636 /* This function gets called every time Redis is entering the
1637 * main loop of the event driven library, that is, before to sleep
1638 * for ready file descriptors. */
1639 static void beforeSleep(struct aeEventLoop *eventLoop) {
1640 REDIS_NOTUSED(eventLoop);
1641
1642 /* Awake clients that got all the swapped keys they requested */
1643 if (server.vm_enabled && listLength(server.io_ready_clients)) {
1644 listIter li;
1645 listNode *ln;
1646
1647 listRewind(server.io_ready_clients,&li);
1648 while((ln = listNext(&li))) {
1649 redisClient *c = ln->value;
1650 struct redisCommand *cmd;
1651
1652 /* Resume the client. */
1653 listDelNode(server.io_ready_clients,ln);
1654 c->flags &= (~REDIS_IO_WAIT);
1655 server.vm_blocked_clients--;
1656 aeCreateFileEvent(server.el, c->fd, AE_READABLE,
1657 readQueryFromClient, c);
1658 cmd = lookupCommand(c->argv[0]->ptr);
1659 assert(cmd != NULL);
1660 call(c,cmd);
1661 resetClient(c);
1662 /* There may be more data to process in the input buffer. */
1663 if (c->querybuf && sdslen(c->querybuf) > 0)
1664 processInputBuffer(c);
1665 }
1666 }
1667 /* Write the AOF buffer on disk */
1668 flushAppendOnlyFile();
1669 }
1670
1671 static void createSharedObjects(void) {
1672 int j;
1673
1674 shared.crlf = createObject(REDIS_STRING,sdsnew("\r\n"));
1675 shared.ok = createObject(REDIS_STRING,sdsnew("+OK\r\n"));
1676 shared.err = createObject(REDIS_STRING,sdsnew("-ERR\r\n"));
1677 shared.emptybulk = createObject(REDIS_STRING,sdsnew("$0\r\n\r\n"));
1678 shared.czero = createObject(REDIS_STRING,sdsnew(":0\r\n"));
1679 shared.cone = createObject(REDIS_STRING,sdsnew(":1\r\n"));
1680 shared.nullbulk = createObject(REDIS_STRING,sdsnew("$-1\r\n"));
1681 shared.nullmultibulk = createObject(REDIS_STRING,sdsnew("*-1\r\n"));
1682 shared.emptymultibulk = createObject(REDIS_STRING,sdsnew("*0\r\n"));
1683 shared.pong = createObject(REDIS_STRING,sdsnew("+PONG\r\n"));
1684 shared.queued = createObject(REDIS_STRING,sdsnew("+QUEUED\r\n"));
1685 shared.wrongtypeerr = createObject(REDIS_STRING,sdsnew(
1686 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1687 shared.nokeyerr = createObject(REDIS_STRING,sdsnew(
1688 "-ERR no such key\r\n"));
1689 shared.syntaxerr = createObject(REDIS_STRING,sdsnew(
1690 "-ERR syntax error\r\n"));
1691 shared.sameobjecterr = createObject(REDIS_STRING,sdsnew(
1692 "-ERR source and destination objects are the same\r\n"));
1693 shared.outofrangeerr = createObject(REDIS_STRING,sdsnew(
1694 "-ERR index out of range\r\n"));
1695 shared.space = createObject(REDIS_STRING,sdsnew(" "));
1696 shared.colon = createObject(REDIS_STRING,sdsnew(":"));
1697 shared.plus = createObject(REDIS_STRING,sdsnew("+"));
1698 shared.select0 = createStringObject("select 0\r\n",10);
1699 shared.select1 = createStringObject("select 1\r\n",10);
1700 shared.select2 = createStringObject("select 2\r\n",10);
1701 shared.select3 = createStringObject("select 3\r\n",10);
1702 shared.select4 = createStringObject("select 4\r\n",10);
1703 shared.select5 = createStringObject("select 5\r\n",10);
1704 shared.select6 = createStringObject("select 6\r\n",10);
1705 shared.select7 = createStringObject("select 7\r\n",10);
1706 shared.select8 = createStringObject("select 8\r\n",10);
1707 shared.select9 = createStringObject("select 9\r\n",10);
1708 shared.messagebulk = createStringObject("$7\r\nmessage\r\n",13);
1709 shared.pmessagebulk = createStringObject("$8\r\npmessage\r\n",14);
1710 shared.subscribebulk = createStringObject("$9\r\nsubscribe\r\n",15);
1711 shared.unsubscribebulk = createStringObject("$11\r\nunsubscribe\r\n",18);
1712 shared.psubscribebulk = createStringObject("$10\r\npsubscribe\r\n",17);
1713 shared.punsubscribebulk = createStringObject("$12\r\npunsubscribe\r\n",19);
1714 shared.mbulk3 = createStringObject("*3\r\n",4);
1715 shared.mbulk4 = createStringObject("*4\r\n",4);
1716 for (j = 0; j < REDIS_SHARED_INTEGERS; j++) {
1717 shared.integers[j] = createObject(REDIS_STRING,(void*)(long)j);
1718 shared.integers[j]->encoding = REDIS_ENCODING_INT;
1719 }
1720 }
1721
1722 static void appendServerSaveParams(time_t seconds, int changes) {
1723 server.saveparams = zrealloc(server.saveparams,sizeof(struct saveparam)*(server.saveparamslen+1));
1724 server.saveparams[server.saveparamslen].seconds = seconds;
1725 server.saveparams[server.saveparamslen].changes = changes;
1726 server.saveparamslen++;
1727 }
1728
1729 static void resetServerSaveParams() {
1730 zfree(server.saveparams);
1731 server.saveparams = NULL;
1732 server.saveparamslen = 0;
1733 }
1734
1735 static void initServerConfig() {
1736 server.dbnum = REDIS_DEFAULT_DBNUM;
1737 server.port = REDIS_SERVERPORT;
1738 server.verbosity = REDIS_VERBOSE;
1739 server.maxidletime = REDIS_MAXIDLETIME;
1740 server.saveparams = NULL;
1741 server.logfile = NULL; /* NULL = log on standard output */
1742 server.bindaddr = NULL;
1743 server.glueoutputbuf = 1;
1744 server.daemonize = 0;
1745 server.appendonly = 0;
1746 server.appendfsync = APPENDFSYNC_EVERYSEC;
1747 server.no_appendfsync_on_rewrite = 0;
1748 server.lastfsync = time(NULL);
1749 server.appendfd = -1;
1750 server.appendseldb = -1; /* Make sure the first time will not match */
1751 server.pidfile = zstrdup("/var/run/redis.pid");
1752 server.dbfilename = zstrdup("dump.rdb");
1753 server.appendfilename = zstrdup("appendonly.aof");
1754 server.requirepass = NULL;
1755 server.rdbcompression = 1;
1756 server.activerehashing = 1;
1757 server.maxclients = 0;
1758 server.blpop_blocked_clients = 0;
1759 server.maxmemory = 0;
1760 server.vm_enabled = 0;
1761 server.vm_swap_file = zstrdup("/tmp/redis-%p.vm");
1762 server.vm_page_size = 256; /* 256 bytes per page */
1763 server.vm_pages = 1024*1024*100; /* 104 millions of pages */
1764 server.vm_max_memory = 1024LL*1024*1024*1; /* 1 GB of RAM */
1765 server.vm_max_threads = 4;
1766 server.vm_blocked_clients = 0;
1767 server.hash_max_zipmap_entries = REDIS_HASH_MAX_ZIPMAP_ENTRIES;
1768 server.hash_max_zipmap_value = REDIS_HASH_MAX_ZIPMAP_VALUE;
1769 server.list_max_ziplist_entries = REDIS_LIST_MAX_ZIPLIST_ENTRIES;
1770 server.list_max_ziplist_value = REDIS_LIST_MAX_ZIPLIST_VALUE;
1771 server.shutdown_asap = 0;
1772
1773 resetServerSaveParams();
1774
1775 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1776 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1777 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1778 /* Replication related */
1779 server.isslave = 0;
1780 server.masterauth = NULL;
1781 server.masterhost = NULL;
1782 server.masterport = 6379;
1783 server.master = NULL;
1784 server.replstate = REDIS_REPL_NONE;
1785
1786 /* Double constants initialization */
1787 R_Zero = 0.0;
1788 R_PosInf = 1.0/R_Zero;
1789 R_NegInf = -1.0/R_Zero;
1790 R_Nan = R_Zero/R_Zero;
1791 }
1792
1793 static void initServer() {
1794 int j;
1795
1796 signal(SIGHUP, SIG_IGN);
1797 signal(SIGPIPE, SIG_IGN);
1798 setupSigSegvAction();
1799
1800 server.devnull = fopen("/dev/null","w");
1801 if (server.devnull == NULL) {
1802 redisLog(REDIS_WARNING, "Can't open /dev/null: %s", server.neterr);
1803 exit(1);
1804 }
1805 server.clients = listCreate();
1806 server.slaves = listCreate();
1807 server.monitors = listCreate();
1808 server.objfreelist = listCreate();
1809 createSharedObjects();
1810 server.el = aeCreateEventLoop();
1811 server.db = zmalloc(sizeof(redisDb)*server.dbnum);
1812 server.fd = anetTcpServer(server.neterr, server.port, server.bindaddr);
1813 if (server.fd == -1) {
1814 redisLog(REDIS_WARNING, "Opening TCP port: %s", server.neterr);
1815 exit(1);
1816 }
1817 for (j = 0; j < server.dbnum; j++) {
1818 server.db[j].dict = dictCreate(&dbDictType,NULL);
1819 server.db[j].expires = dictCreate(&keyptrDictType,NULL);
1820 server.db[j].blocking_keys = dictCreate(&keylistDictType,NULL);
1821 server.db[j].watched_keys = dictCreate(&keylistDictType,NULL);
1822 if (server.vm_enabled)
1823 server.db[j].io_keys = dictCreate(&keylistDictType,NULL);
1824 server.db[j].id = j;
1825 }
1826 server.pubsub_channels = dictCreate(&keylistDictType,NULL);
1827 server.pubsub_patterns = listCreate();
1828 listSetFreeMethod(server.pubsub_patterns,freePubsubPattern);
1829 listSetMatchMethod(server.pubsub_patterns,listMatchPubsubPattern);
1830 server.cronloops = 0;
1831 server.bgsavechildpid = -1;
1832 server.bgrewritechildpid = -1;
1833 server.bgrewritebuf = sdsempty();
1834 server.aofbuf = sdsempty();
1835 server.lastsave = time(NULL);
1836 server.dirty = 0;
1837 server.stat_numcommands = 0;
1838 server.stat_numconnections = 0;
1839 server.stat_expiredkeys = 0;
1840 server.stat_starttime = time(NULL);
1841 server.unixtime = time(NULL);
1842 aeCreateTimeEvent(server.el, 1, serverCron, NULL, NULL);
1843 if (aeCreateFileEvent(server.el, server.fd, AE_READABLE,
1844 acceptHandler, NULL) == AE_ERR) oom("creating file event");
1845
1846 if (server.appendonly) {
1847 server.appendfd = open(server.appendfilename,O_WRONLY|O_APPEND|O_CREAT,0644);
1848 if (server.appendfd == -1) {
1849 redisLog(REDIS_WARNING, "Can't open the append-only file: %s",
1850 strerror(errno));
1851 exit(1);
1852 }
1853 }
1854
1855 if (server.vm_enabled) vmInit();
1856 }
1857
1858 /* Empty the whole database */
1859 static long long emptyDb() {
1860 int j;
1861 long long removed = 0;
1862
1863 for (j = 0; j < server.dbnum; j++) {
1864 removed += dictSize(server.db[j].dict);
1865 dictEmpty(server.db[j].dict);
1866 dictEmpty(server.db[j].expires);
1867 }
1868 return removed;
1869 }
1870
1871 static int yesnotoi(char *s) {
1872 if (!strcasecmp(s,"yes")) return 1;
1873 else if (!strcasecmp(s,"no")) return 0;
1874 else return -1;
1875 }
1876
1877 /* I agree, this is a very rudimental way to load a configuration...
1878 will improve later if the config gets more complex */
1879 static void loadServerConfig(char *filename) {
1880 FILE *fp;
1881 char buf[REDIS_CONFIGLINE_MAX+1], *err = NULL;
1882 int linenum = 0;
1883 sds line = NULL;
1884
1885 if (filename[0] == '-' && filename[1] == '\0')
1886 fp = stdin;
1887 else {
1888 if ((fp = fopen(filename,"r")) == NULL) {
1889 redisLog(REDIS_WARNING, "Fatal error, can't open config file '%s'", filename);
1890 exit(1);
1891 }
1892 }
1893
1894 while(fgets(buf,REDIS_CONFIGLINE_MAX+1,fp) != NULL) {
1895 sds *argv;
1896 int argc, j;
1897
1898 linenum++;
1899 line = sdsnew(buf);
1900 line = sdstrim(line," \t\r\n");
1901
1902 /* Skip comments and blank lines*/
1903 if (line[0] == '#' || line[0] == '\0') {
1904 sdsfree(line);
1905 continue;
1906 }
1907
1908 /* Split into arguments */
1909 argv = sdssplitlen(line,sdslen(line)," ",1,&argc);
1910 sdstolower(argv[0]);
1911
1912 /* Execute config directives */
1913 if (!strcasecmp(argv[0],"timeout") && argc == 2) {
1914 server.maxidletime = atoi(argv[1]);
1915 if (server.maxidletime < 0) {
1916 err = "Invalid timeout value"; goto loaderr;
1917 }
1918 } else if (!strcasecmp(argv[0],"port") && argc == 2) {
1919 server.port = atoi(argv[1]);
1920 if (server.port < 1 || server.port > 65535) {
1921 err = "Invalid port"; goto loaderr;
1922 }
1923 } else if (!strcasecmp(argv[0],"bind") && argc == 2) {
1924 server.bindaddr = zstrdup(argv[1]);
1925 } else if (!strcasecmp(argv[0],"save") && argc == 3) {
1926 int seconds = atoi(argv[1]);
1927 int changes = atoi(argv[2]);
1928 if (seconds < 1 || changes < 0) {
1929 err = "Invalid save parameters"; goto loaderr;
1930 }
1931 appendServerSaveParams(seconds,changes);
1932 } else if (!strcasecmp(argv[0],"dir") && argc == 2) {
1933 if (chdir(argv[1]) == -1) {
1934 redisLog(REDIS_WARNING,"Can't chdir to '%s': %s",
1935 argv[1], strerror(errno));
1936 exit(1);
1937 }
1938 } else if (!strcasecmp(argv[0],"loglevel") && argc == 2) {
1939 if (!strcasecmp(argv[1],"debug")) server.verbosity = REDIS_DEBUG;
1940 else if (!strcasecmp(argv[1],"verbose")) server.verbosity = REDIS_VERBOSE;
1941 else if (!strcasecmp(argv[1],"notice")) server.verbosity = REDIS_NOTICE;
1942 else if (!strcasecmp(argv[1],"warning")) server.verbosity = REDIS_WARNING;
1943 else {
1944 err = "Invalid log level. Must be one of debug, notice, warning";
1945 goto loaderr;
1946 }
1947 } else if (!strcasecmp(argv[0],"logfile") && argc == 2) {
1948 FILE *logfp;
1949
1950 server.logfile = zstrdup(argv[1]);
1951 if (!strcasecmp(server.logfile,"stdout")) {
1952 zfree(server.logfile);
1953 server.logfile = NULL;
1954 }
1955 if (server.logfile) {
1956 /* Test if we are able to open the file. The server will not
1957 * be able to abort just for this problem later... */
1958 logfp = fopen(server.logfile,"a");
1959 if (logfp == NULL) {
1960 err = sdscatprintf(sdsempty(),
1961 "Can't open the log file: %s", strerror(errno));
1962 goto loaderr;
1963 }
1964 fclose(logfp);
1965 }
1966 } else if (!strcasecmp(argv[0],"databases") && argc == 2) {
1967 server.dbnum = atoi(argv[1]);
1968 if (server.dbnum < 1) {
1969 err = "Invalid number of databases"; goto loaderr;
1970 }
1971 } else if (!strcasecmp(argv[0],"include") && argc == 2) {
1972 loadServerConfig(argv[1]);
1973 } else if (!strcasecmp(argv[0],"maxclients") && argc == 2) {
1974 server.maxclients = atoi(argv[1]);
1975 } else if (!strcasecmp(argv[0],"maxmemory") && argc == 2) {
1976 server.maxmemory = memtoll(argv[1],NULL);
1977 } else if (!strcasecmp(argv[0],"slaveof") && argc == 3) {
1978 server.masterhost = sdsnew(argv[1]);
1979 server.masterport = atoi(argv[2]);
1980 server.replstate = REDIS_REPL_CONNECT;
1981 } else if (!strcasecmp(argv[0],"masterauth") && argc == 2) {
1982 server.masterauth = zstrdup(argv[1]);
1983 } else if (!strcasecmp(argv[0],"glueoutputbuf") && argc == 2) {
1984 if ((server.glueoutputbuf = yesnotoi(argv[1])) == -1) {
1985 err = "argument must be 'yes' or 'no'"; goto loaderr;
1986 }
1987 } else if (!strcasecmp(argv[0],"rdbcompression") && argc == 2) {
1988 if ((server.rdbcompression = yesnotoi(argv[1])) == -1) {
1989 err = "argument must be 'yes' or 'no'"; goto loaderr;
1990 }
1991 } else if (!strcasecmp(argv[0],"activerehashing") && argc == 2) {
1992 if ((server.activerehashing = yesnotoi(argv[1])) == -1) {
1993 err = "argument must be 'yes' or 'no'"; goto loaderr;
1994 }
1995 } else if (!strcasecmp(argv[0],"daemonize") && argc == 2) {
1996 if ((server.daemonize = yesnotoi(argv[1])) == -1) {
1997 err = "argument must be 'yes' or 'no'"; goto loaderr;
1998 }
1999 } else if (!strcasecmp(argv[0],"appendonly") && argc == 2) {
2000 if ((server.appendonly = yesnotoi(argv[1])) == -1) {
2001 err = "argument must be 'yes' or 'no'"; goto loaderr;
2002 }
2003 } else if (!strcasecmp(argv[0],"appendfilename") && argc == 2) {
2004 zfree(server.appendfilename);
2005 server.appendfilename = zstrdup(argv[1]);
2006 } else if (!strcasecmp(argv[0],"no-appendfsync-on-rewrite")
2007 && argc == 2) {
2008 if ((server.no_appendfsync_on_rewrite= yesnotoi(argv[1])) == -1) {
2009 err = "argument must be 'yes' or 'no'"; goto loaderr;
2010 }
2011 } else if (!strcasecmp(argv[0],"appendfsync") && argc == 2) {
2012 if (!strcasecmp(argv[1],"no")) {
2013 server.appendfsync = APPENDFSYNC_NO;
2014 } else if (!strcasecmp(argv[1],"always")) {
2015 server.appendfsync = APPENDFSYNC_ALWAYS;
2016 } else if (!strcasecmp(argv[1],"everysec")) {
2017 server.appendfsync = APPENDFSYNC_EVERYSEC;
2018 } else {
2019 err = "argument must be 'no', 'always' or 'everysec'";
2020 goto loaderr;
2021 }
2022 } else if (!strcasecmp(argv[0],"requirepass") && argc == 2) {
2023 server.requirepass = zstrdup(argv[1]);
2024 } else if (!strcasecmp(argv[0],"pidfile") && argc == 2) {
2025 zfree(server.pidfile);
2026 server.pidfile = zstrdup(argv[1]);
2027 } else if (!strcasecmp(argv[0],"dbfilename") && argc == 2) {
2028 zfree(server.dbfilename);
2029 server.dbfilename = zstrdup(argv[1]);
2030 } else if (!strcasecmp(argv[0],"vm-enabled") && argc == 2) {
2031 if ((server.vm_enabled = yesnotoi(argv[1])) == -1) {
2032 err = "argument must be 'yes' or 'no'"; goto loaderr;
2033 }
2034 } else if (!strcasecmp(argv[0],"vm-swap-file") && argc == 2) {
2035 zfree(server.vm_swap_file);
2036 server.vm_swap_file = zstrdup(argv[1]);
2037 } else if (!strcasecmp(argv[0],"vm-max-memory") && argc == 2) {
2038 server.vm_max_memory = memtoll(argv[1],NULL);
2039 } else if (!strcasecmp(argv[0],"vm-page-size") && argc == 2) {
2040 server.vm_page_size = memtoll(argv[1], NULL);
2041 } else if (!strcasecmp(argv[0],"vm-pages") && argc == 2) {
2042 server.vm_pages = memtoll(argv[1], NULL);
2043 } else if (!strcasecmp(argv[0],"vm-max-threads") && argc == 2) {
2044 server.vm_max_threads = strtoll(argv[1], NULL, 10);
2045 } else if (!strcasecmp(argv[0],"hash-max-zipmap-entries") && argc == 2){
2046 server.hash_max_zipmap_entries = memtoll(argv[1], NULL);
2047 } else if (!strcasecmp(argv[0],"hash-max-zipmap-value") && argc == 2){
2048 server.hash_max_zipmap_value = memtoll(argv[1], NULL);
2049 } else if (!strcasecmp(argv[0],"list-max-ziplist-entries") && argc == 2){
2050 server.list_max_ziplist_entries = memtoll(argv[1], NULL);
2051 } else if (!strcasecmp(argv[0],"list-max-ziplist-value") && argc == 2){
2052 server.list_max_ziplist_value = memtoll(argv[1], NULL);
2053 } else {
2054 err = "Bad directive or wrong number of arguments"; goto loaderr;
2055 }
2056 for (j = 0; j < argc; j++)
2057 sdsfree(argv[j]);
2058 zfree(argv);
2059 sdsfree(line);
2060 }
2061 if (fp != stdin) fclose(fp);
2062 return;
2063
2064 loaderr:
2065 fprintf(stderr, "\n*** FATAL CONFIG FILE ERROR ***\n");
2066 fprintf(stderr, "Reading the configuration file, at line %d\n", linenum);
2067 fprintf(stderr, ">>> '%s'\n", line);
2068 fprintf(stderr, "%s\n", err);
2069 exit(1);
2070 }
2071
2072 static void freeClientArgv(redisClient *c) {
2073 int j;
2074
2075 for (j = 0; j < c->argc; j++)
2076 decrRefCount(c->argv[j]);
2077 for (j = 0; j < c->mbargc; j++)
2078 decrRefCount(c->mbargv[j]);
2079 c->argc = 0;
2080 c->mbargc = 0;
2081 }
2082
2083 static void freeClient(redisClient *c) {
2084 listNode *ln;
2085
2086 /* Note that if the client we are freeing is blocked into a blocking
2087 * call, we have to set querybuf to NULL *before* to call
2088 * unblockClientWaitingData() to avoid processInputBuffer() will get
2089 * called. Also it is important to remove the file events after
2090 * this, because this call adds the READABLE event. */
2091 sdsfree(c->querybuf);
2092 c->querybuf = NULL;
2093 if (c->flags & REDIS_BLOCKED)
2094 unblockClientWaitingData(c);
2095
2096 /* UNWATCH all the keys */
2097 unwatchAllKeys(c);
2098 listRelease(c->watched_keys);
2099 /* Unsubscribe from all the pubsub channels */
2100 pubsubUnsubscribeAllChannels(c,0);
2101 pubsubUnsubscribeAllPatterns(c,0);
2102 dictRelease(c->pubsub_channels);
2103 listRelease(c->pubsub_patterns);
2104 /* Obvious cleanup */
2105 aeDeleteFileEvent(server.el,c->fd,AE_READABLE);
2106 aeDeleteFileEvent(server.el,c->fd,AE_WRITABLE);
2107 listRelease(c->reply);
2108 freeClientArgv(c);
2109 close(c->fd);
2110 /* Remove from the list of clients */
2111 ln = listSearchKey(server.clients,c);
2112 redisAssert(ln != NULL);
2113 listDelNode(server.clients,ln);
2114 /* Remove from the list of clients that are now ready to be restarted
2115 * after waiting for swapped keys */
2116 if (c->flags & REDIS_IO_WAIT && listLength(c->io_keys) == 0) {
2117 ln = listSearchKey(server.io_ready_clients,c);
2118 if (ln) {
2119 listDelNode(server.io_ready_clients,ln);
2120 server.vm_blocked_clients--;
2121 }
2122 }
2123 /* Remove from the list of clients waiting for swapped keys */
2124 while (server.vm_enabled && listLength(c->io_keys)) {
2125 ln = listFirst(c->io_keys);
2126 dontWaitForSwappedKey(c,ln->value);
2127 }
2128 listRelease(c->io_keys);
2129 /* Master/slave cleanup */
2130 if (c->flags & REDIS_SLAVE) {
2131 if (c->replstate == REDIS_REPL_SEND_BULK && c->repldbfd != -1)
2132 close(c->repldbfd);
2133 list *l = (c->flags & REDIS_MONITOR) ? server.monitors : server.slaves;
2134 ln = listSearchKey(l,c);
2135 redisAssert(ln != NULL);
2136 listDelNode(l,ln);
2137 }
2138 if (c->flags & REDIS_MASTER) {
2139 server.master = NULL;
2140 server.replstate = REDIS_REPL_CONNECT;
2141 }
2142 /* Release memory */
2143 zfree(c->argv);
2144 zfree(c->mbargv);
2145 freeClientMultiState(c);
2146 zfree(c);
2147 }
2148
2149 #define GLUEREPLY_UP_TO (1024)
2150 static void glueReplyBuffersIfNeeded(redisClient *c) {
2151 int copylen = 0;
2152 char buf[GLUEREPLY_UP_TO];
2153 listNode *ln;
2154 listIter li;
2155 robj *o;
2156
2157 listRewind(c->reply,&li);
2158 while((ln = listNext(&li))) {
2159 int objlen;
2160
2161 o = ln->value;
2162 objlen = sdslen(o->ptr);
2163 if (copylen + objlen <= GLUEREPLY_UP_TO) {
2164 memcpy(buf+copylen,o->ptr,objlen);
2165 copylen += objlen;
2166 listDelNode(c->reply,ln);
2167 } else {
2168 if (copylen == 0) return;
2169 break;
2170 }
2171 }
2172 /* Now the output buffer is empty, add the new single element */
2173 o = createObject(REDIS_STRING,sdsnewlen(buf,copylen));
2174 listAddNodeHead(c->reply,o);
2175 }
2176
2177 static void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask) {
2178 redisClient *c = privdata;
2179 int nwritten = 0, totwritten = 0, objlen;
2180 robj *o;
2181 REDIS_NOTUSED(el);
2182 REDIS_NOTUSED(mask);
2183
2184 /* Use writev() if we have enough buffers to send */
2185 if (!server.glueoutputbuf &&
2186 listLength(c->reply) > REDIS_WRITEV_THRESHOLD &&
2187 !(c->flags & REDIS_MASTER))
2188 {
2189 sendReplyToClientWritev(el, fd, privdata, mask);
2190 return;
2191 }
2192
2193 while(listLength(c->reply)) {
2194 if (server.glueoutputbuf && listLength(c->reply) > 1)
2195 glueReplyBuffersIfNeeded(c);
2196
2197 o = listNodeValue(listFirst(c->reply));
2198 objlen = sdslen(o->ptr);
2199
2200 if (objlen == 0) {
2201 listDelNode(c->reply,listFirst(c->reply));
2202 continue;
2203 }
2204
2205 if (c->flags & REDIS_MASTER) {
2206 /* Don't reply to a master */
2207 nwritten = objlen - c->sentlen;
2208 } else {
2209 nwritten = write(fd, ((char*)o->ptr)+c->sentlen, objlen - c->sentlen);
2210 if (nwritten <= 0) break;
2211 }
2212 c->sentlen += nwritten;
2213 totwritten += nwritten;
2214 /* If we fully sent the object on head go to the next one */
2215 if (c->sentlen == objlen) {
2216 listDelNode(c->reply,listFirst(c->reply));
2217 c->sentlen = 0;
2218 }
2219 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
2220 * bytes, in a single threaded server it's a good idea to serve
2221 * other clients as well, even if a very large request comes from
2222 * super fast link that is always able to accept data (in real world
2223 * scenario think about 'KEYS *' against the loopback interfae) */
2224 if (totwritten > REDIS_MAX_WRITE_PER_EVENT) break;
2225 }
2226 if (nwritten == -1) {
2227 if (errno == EAGAIN) {
2228 nwritten = 0;
2229 } else {
2230 redisLog(REDIS_VERBOSE,
2231 "Error writing to client: %s", strerror(errno));
2232 freeClient(c);
2233 return;
2234 }
2235 }
2236 if (totwritten > 0) c->lastinteraction = time(NULL);
2237 if (listLength(c->reply) == 0) {
2238 c->sentlen = 0;
2239 aeDeleteFileEvent(server.el,c->fd,AE_WRITABLE);
2240 }
2241 }
2242
2243 static void sendReplyToClientWritev(aeEventLoop *el, int fd, void *privdata, int mask)
2244 {
2245 redisClient *c = privdata;
2246 int nwritten = 0, totwritten = 0, objlen, willwrite;
2247 robj *o;
2248 struct iovec iov[REDIS_WRITEV_IOVEC_COUNT];
2249 int offset, ion = 0;
2250 REDIS_NOTUSED(el);
2251 REDIS_NOTUSED(mask);
2252
2253 listNode *node;
2254 while (listLength(c->reply)) {
2255 offset = c->sentlen;
2256 ion = 0;
2257 willwrite = 0;
2258
2259 /* fill-in the iov[] array */
2260 for(node = listFirst(c->reply); node; node = listNextNode(node)) {
2261 o = listNodeValue(node);
2262 objlen = sdslen(o->ptr);
2263
2264 if (totwritten + objlen - offset > REDIS_MAX_WRITE_PER_EVENT)
2265 break;
2266
2267 if(ion == REDIS_WRITEV_IOVEC_COUNT)
2268 break; /* no more iovecs */
2269
2270 iov[ion].iov_base = ((char*)o->ptr) + offset;
2271 iov[ion].iov_len = objlen - offset;
2272 willwrite += objlen - offset;
2273 offset = 0; /* just for the first item */
2274 ion++;
2275 }
2276
2277 if(willwrite == 0)
2278 break;
2279
2280 /* write all collected blocks at once */
2281 if((nwritten = writev(fd, iov, ion)) < 0) {
2282 if (errno != EAGAIN) {
2283 redisLog(REDIS_VERBOSE,
2284 "Error writing to client: %s", strerror(errno));
2285 freeClient(c);
2286 return;
2287 }
2288 break;
2289 }
2290
2291 totwritten += nwritten;
2292 offset = c->sentlen;
2293
2294 /* remove written robjs from c->reply */
2295 while (nwritten && listLength(c->reply)) {
2296 o = listNodeValue(listFirst(c->reply));
2297 objlen = sdslen(o->ptr);
2298
2299 if(nwritten >= objlen - offset) {
2300 listDelNode(c->reply, listFirst(c->reply));
2301 nwritten -= objlen - offset;
2302 c->sentlen = 0;
2303 } else {
2304 /* partial write */
2305 c->sentlen += nwritten;
2306 break;
2307 }
2308 offset = 0;
2309 }
2310 }
2311
2312 if (totwritten > 0)
2313 c->lastinteraction = time(NULL);
2314
2315 if (listLength(c->reply) == 0) {
2316 c->sentlen = 0;
2317 aeDeleteFileEvent(server.el,c->fd,AE_WRITABLE);
2318 }
2319 }
2320
2321 static int qsortRedisCommands(const void *r1, const void *r2) {
2322 return strcasecmp(
2323 ((struct redisCommand*)r1)->name,
2324 ((struct redisCommand*)r2)->name);
2325 }
2326
2327 static void sortCommandTable() {
2328 /* Copy and sort the read-only version of the command table */
2329 commandTable = (struct redisCommand*)malloc(sizeof(readonlyCommandTable));
2330 memcpy(commandTable,readonlyCommandTable,sizeof(readonlyCommandTable));
2331 qsort(commandTable,
2332 sizeof(readonlyCommandTable)/sizeof(struct redisCommand),
2333 sizeof(struct redisCommand),qsortRedisCommands);
2334 }
2335
2336 static struct redisCommand *lookupCommand(char *name) {
2337 struct redisCommand tmp = {name,NULL,0,0,NULL,0,0,0};
2338 return bsearch(
2339 &tmp,
2340 commandTable,
2341 sizeof(readonlyCommandTable)/sizeof(struct redisCommand),
2342 sizeof(struct redisCommand),
2343 qsortRedisCommands);
2344 }
2345
2346 /* resetClient prepare the client to process the next command */
2347 static void resetClient(redisClient *c) {
2348 freeClientArgv(c);
2349 c->bulklen = -1;
2350 c->multibulk = 0;
2351 }
2352
2353 /* Call() is the core of Redis execution of a command */
2354 static void call(redisClient *c, struct redisCommand *cmd) {
2355 long long dirty;
2356
2357 dirty = server.dirty;
2358 cmd->proc(c);
2359 dirty = server.dirty-dirty;
2360
2361 if (server.appendonly && dirty)
2362 feedAppendOnlyFile(cmd,c->db->id,c->argv,c->argc);
2363 if ((dirty || cmd->flags & REDIS_CMD_FORCE_REPLICATION) &&
2364 listLength(server.slaves))
2365 replicationFeedSlaves(server.slaves,c->db->id,c->argv,c->argc);
2366 if (listLength(server.monitors))
2367 replicationFeedMonitors(server.monitors,c->db->id,c->argv,c->argc);
2368 server.stat_numcommands++;
2369 }
2370
2371 /* If this function gets called we already read a whole
2372 * command, argments are in the client argv/argc fields.
2373 * processCommand() execute the command or prepare the
2374 * server for a bulk read from the client.
2375 *
2376 * If 1 is returned the client is still alive and valid and
2377 * and other operations can be performed by the caller. Otherwise
2378 * if 0 is returned the client was destroied (i.e. after QUIT). */
2379 static int processCommand(redisClient *c) {
2380 struct redisCommand *cmd;
2381
2382 /* Free some memory if needed (maxmemory setting) */
2383 if (server.maxmemory) freeMemoryIfNeeded();
2384
2385 /* Handle the multi bulk command type. This is an alternative protocol
2386 * supported by Redis in order to receive commands that are composed of
2387 * multiple binary-safe "bulk" arguments. The latency of processing is
2388 * a bit higher but this allows things like multi-sets, so if this
2389 * protocol is used only for MSET and similar commands this is a big win. */
2390 if (c->multibulk == 0 && c->argc == 1 && ((char*)(c->argv[0]->ptr))[0] == '*') {
2391 c->multibulk = atoi(((char*)c->argv[0]->ptr)+1);
2392 if (c->multibulk <= 0) {
2393 resetClient(c);
2394 return 1;
2395 } else {
2396 decrRefCount(c->argv[c->argc-1]);
2397 c->argc--;
2398 return 1;
2399 }
2400 } else if (c->multibulk) {
2401 if (c->bulklen == -1) {
2402 if (((char*)c->argv[0]->ptr)[0] != '$') {
2403 addReplySds(c,sdsnew("-ERR multi bulk protocol error\r\n"));
2404 resetClient(c);
2405 return 1;
2406 } else {
2407 int bulklen = atoi(((char*)c->argv[0]->ptr)+1);
2408 decrRefCount(c->argv[0]);
2409 if (bulklen < 0 || bulklen > 1024*1024*1024) {
2410 c->argc--;
2411 addReplySds(c,sdsnew("-ERR invalid bulk write count\r\n"));
2412 resetClient(c);
2413 return 1;
2414 }
2415 c->argc--;
2416 c->bulklen = bulklen+2; /* add two bytes for CR+LF */
2417 return 1;
2418 }
2419 } else {
2420 c->mbargv = zrealloc(c->mbargv,(sizeof(robj*))*(c->mbargc+1));
2421 c->mbargv[c->mbargc] = c->argv[0];
2422 c->mbargc++;
2423 c->argc--;
2424 c->multibulk--;
2425 if (c->multibulk == 0) {
2426 robj **auxargv;
2427 int auxargc;
2428
2429 /* Here we need to swap the multi-bulk argc/argv with the
2430 * normal argc/argv of the client structure. */
2431 auxargv = c->argv;
2432 c->argv = c->mbargv;
2433 c->mbargv = auxargv;
2434
2435 auxargc = c->argc;
2436 c->argc = c->mbargc;
2437 c->mbargc = auxargc;
2438
2439 /* We need to set bulklen to something different than -1
2440 * in order for the code below to process the command without
2441 * to try to read the last argument of a bulk command as
2442 * a special argument. */
2443 c->bulklen = 0;
2444 /* continue below and process the command */
2445 } else {
2446 c->bulklen = -1;
2447 return 1;
2448 }
2449 }
2450 }
2451 /* -- end of multi bulk commands processing -- */
2452
2453 /* The QUIT command is handled as a special case. Normal command
2454 * procs are unable to close the client connection safely */
2455 if (!strcasecmp(c->argv[0]->ptr,"quit")) {
2456 freeClient(c);
2457 return 0;
2458 }
2459
2460 /* Now lookup the command and check ASAP about trivial error conditions
2461 * such wrong arity, bad command name and so forth. */
2462 cmd = lookupCommand(c->argv[0]->ptr);
2463 if (!cmd) {
2464 addReplySds(c,
2465 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2466 (char*)c->argv[0]->ptr));
2467 resetClient(c);
2468 return 1;
2469 } else if ((cmd->arity > 0 && cmd->arity != c->argc) ||
2470 (c->argc < -cmd->arity)) {
2471 addReplySds(c,
2472 sdscatprintf(sdsempty(),
2473 "-ERR wrong number of arguments for '%s' command\r\n",
2474 cmd->name));
2475 resetClient(c);
2476 return 1;
2477 } else if (cmd->flags & REDIS_CMD_BULK && c->bulklen == -1) {
2478 /* This is a bulk command, we have to read the last argument yet. */
2479 int bulklen = atoi(c->argv[c->argc-1]->ptr);
2480
2481 decrRefCount(c->argv[c->argc-1]);
2482 if (bulklen < 0 || bulklen > 1024*1024*1024) {
2483 c->argc--;
2484 addReplySds(c,sdsnew("-ERR invalid bulk write count\r\n"));
2485 resetClient(c);
2486 return 1;
2487 }
2488 c->argc--;
2489 c->bulklen = bulklen+2; /* add two bytes for CR+LF */
2490 /* It is possible that the bulk read is already in the
2491 * buffer. Check this condition and handle it accordingly.
2492 * This is just a fast path, alternative to call processInputBuffer().
2493 * It's a good idea since the code is small and this condition
2494 * happens most of the times. */
2495 if ((signed)sdslen(c->querybuf) >= c->bulklen) {
2496 c->argv[c->argc] = createStringObject(c->querybuf,c->bulklen-2);
2497 c->argc++;
2498 c->querybuf = sdsrange(c->querybuf,c->bulklen,-1);
2499 } else {
2500 /* Otherwise return... there is to read the last argument
2501 * from the socket. */
2502 return 1;
2503 }
2504 }
2505 /* Let's try to encode the bulk object to save space. */
2506 if (cmd->flags & REDIS_CMD_BULK)
2507 c->argv[c->argc-1] = tryObjectEncoding(c->argv[c->argc-1]);
2508
2509 /* Check if the user is authenticated */
2510 if (server.requirepass && !c->authenticated && cmd->proc != authCommand) {
2511 addReplySds(c,sdsnew("-ERR operation not permitted\r\n"));
2512 resetClient(c);
2513 return 1;
2514 }
2515
2516 /* Handle the maxmemory directive */
2517 if (server.maxmemory && (cmd->flags & REDIS_CMD_DENYOOM) &&
2518 zmalloc_used_memory() > server.maxmemory)
2519 {
2520 addReplySds(c,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2521 resetClient(c);
2522 return 1;
2523 }
2524
2525 /* Only allow SUBSCRIBE and UNSUBSCRIBE in the context of Pub/Sub */
2526 if ((dictSize(c->pubsub_channels) > 0 || listLength(c->pubsub_patterns) > 0)
2527 &&
2528 cmd->proc != subscribeCommand && cmd->proc != unsubscribeCommand &&
2529 cmd->proc != psubscribeCommand && cmd->proc != punsubscribeCommand) {
2530 addReplySds(c,sdsnew("-ERR only (P)SUBSCRIBE / (P)UNSUBSCRIBE / QUIT allowed in this context\r\n"));
2531 resetClient(c);
2532 return 1;
2533 }
2534
2535 /* Exec the command */
2536 if (c->flags & REDIS_MULTI &&
2537 cmd->proc != execCommand && cmd->proc != discardCommand &&
2538 cmd->proc != multiCommand && cmd->proc != watchCommand)
2539 {
2540 queueMultiCommand(c,cmd);
2541 addReply(c,shared.queued);
2542 } else {
2543 if (server.vm_enabled && server.vm_max_threads > 0 &&
2544 blockClientOnSwappedKeys(c,cmd)) return 1;
2545 call(c,cmd);
2546 }
2547
2548 /* Prepare the client for the next command */
2549 resetClient(c);
2550 return 1;
2551 }
2552
2553 static void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc) {
2554 listNode *ln;
2555 listIter li;
2556 int outc = 0, j;
2557 robj **outv;
2558 /* We need 1+(ARGS*3) objects since commands are using the new protocol
2559 * and we one 1 object for the first "*<count>\r\n" multibulk count, then
2560 * for every additional object we have "$<count>\r\n" + object + "\r\n". */
2561 robj *static_outv[REDIS_STATIC_ARGS*3+1];
2562 robj *lenobj;
2563
2564 if (argc <= REDIS_STATIC_ARGS) {
2565 outv = static_outv;
2566 } else {
2567 outv = zmalloc(sizeof(robj*)*(argc*3+1));
2568 }
2569
2570 lenobj = createObject(REDIS_STRING,
2571 sdscatprintf(sdsempty(), "*%d\r\n", argc));
2572 lenobj->refcount = 0;
2573 outv[outc++] = lenobj;
2574 for (j = 0; j < argc; j++) {
2575 lenobj = createObject(REDIS_STRING,
2576 sdscatprintf(sdsempty(),"$%lu\r\n",
2577 (unsigned long) stringObjectLen(argv[j])));
2578 lenobj->refcount = 0;
2579 outv[outc++] = lenobj;
2580 outv[outc++] = argv[j];
2581 outv[outc++] = shared.crlf;
2582 }
2583
2584 /* Increment all the refcounts at start and decrement at end in order to
2585 * be sure to free objects if there is no slave in a replication state
2586 * able to be feed with commands */
2587 for (j = 0; j < outc; j++) incrRefCount(outv[j]);
2588 listRewind(slaves,&li);
2589 while((ln = listNext(&li))) {
2590 redisClient *slave = ln->value;
2591
2592 /* Don't feed slaves that are still waiting for BGSAVE to start */
2593 if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_START) continue;
2594
2595 /* Feed all the other slaves, MONITORs and so on */
2596 if (slave->slaveseldb != dictid) {
2597 robj *selectcmd;
2598
2599 switch(dictid) {
2600 case 0: selectcmd = shared.select0; break;
2601 case 1: selectcmd = shared.select1; break;
2602 case 2: selectcmd = shared.select2; break;
2603 case 3: selectcmd = shared.select3; break;
2604 case 4: selectcmd = shared.select4; break;
2605 case 5: selectcmd = shared.select5; break;
2606 case 6: selectcmd = shared.select6; break;
2607 case 7: selectcmd = shared.select7; break;
2608 case 8: selectcmd = shared.select8; break;
2609 case 9: selectcmd = shared.select9; break;
2610 default:
2611 selectcmd = createObject(REDIS_STRING,
2612 sdscatprintf(sdsempty(),"select %d\r\n",dictid));
2613 selectcmd->refcount = 0;
2614 break;
2615 }
2616 addReply(slave,selectcmd);
2617 slave->slaveseldb = dictid;
2618 }
2619 for (j = 0; j < outc; j++) addReply(slave,outv[j]);
2620 }
2621 for (j = 0; j < outc; j++) decrRefCount(outv[j]);
2622 if (outv != static_outv) zfree(outv);
2623 }
2624
2625 static sds sdscatrepr(sds s, char *p, size_t len) {
2626 s = sdscatlen(s,"\"",1);
2627 while(len--) {
2628 switch(*p) {
2629 case '\\':
2630 case '"':
2631 s = sdscatprintf(s,"\\%c",*p);
2632 break;
2633 case '\n': s = sdscatlen(s,"\\n",1); break;
2634 case '\r': s = sdscatlen(s,"\\r",1); break;
2635 case '\t': s = sdscatlen(s,"\\t",1); break;
2636 case '\a': s = sdscatlen(s,"\\a",1); break;
2637 case '\b': s = sdscatlen(s,"\\b",1); break;
2638 default:
2639 if (isprint(*p))
2640 s = sdscatprintf(s,"%c",*p);
2641 else
2642 s = sdscatprintf(s,"\\x%02x",(unsigned char)*p);
2643 break;
2644 }
2645 p++;
2646 }
2647 return sdscatlen(s,"\"",1);
2648 }
2649
2650 static void replicationFeedMonitors(list *monitors, int dictid, robj **argv, int argc) {
2651 listNode *ln;
2652 listIter li;
2653 int j;
2654 sds cmdrepr = sdsnew("+");
2655 robj *cmdobj;
2656 struct timeval tv;
2657
2658 gettimeofday(&tv,NULL);
2659 cmdrepr = sdscatprintf(cmdrepr,"%ld.%ld ",(long)tv.tv_sec,(long)tv.tv_usec);
2660 if (dictid != 0) cmdrepr = sdscatprintf(cmdrepr,"(db %d) ", dictid);
2661
2662 for (j = 0; j < argc; j++) {
2663 if (argv[j]->encoding == REDIS_ENCODING_INT) {
2664 cmdrepr = sdscatprintf(cmdrepr, "%ld", (long)argv[j]->ptr);
2665 } else {
2666 cmdrepr = sdscatrepr(cmdrepr,(char*)argv[j]->ptr,
2667 sdslen(argv[j]->ptr));
2668 }
2669 if (j != argc-1)
2670 cmdrepr = sdscatlen(cmdrepr," ",1);
2671 }
2672 cmdrepr = sdscatlen(cmdrepr,"\r\n",2);
2673 cmdobj = createObject(REDIS_STRING,cmdrepr);
2674
2675 listRewind(monitors,&li);
2676 while((ln = listNext(&li))) {
2677 redisClient *monitor = ln->value;
2678 addReply(monitor,cmdobj);
2679 }
2680 decrRefCount(cmdobj);
2681 }
2682
2683 static void processInputBuffer(redisClient *c) {
2684 again:
2685 /* Before to process the input buffer, make sure the client is not
2686 * waitig for a blocking operation such as BLPOP. Note that the first
2687 * iteration the client is never blocked, otherwise the processInputBuffer
2688 * would not be called at all, but after the execution of the first commands
2689 * in the input buffer the client may be blocked, and the "goto again"
2690 * will try to reiterate. The following line will make it return asap. */
2691 if (c->flags & REDIS_BLOCKED || c->flags & REDIS_IO_WAIT) return;
2692 if (c->bulklen == -1) {
2693 /* Read the first line of the query */
2694 char *p = strchr(c->querybuf,'\n');
2695 size_t querylen;
2696
2697 if (p) {
2698 sds query, *argv;
2699 int argc, j;
2700
2701 query = c->querybuf;
2702 c->querybuf = sdsempty();
2703 querylen = 1+(p-(query));
2704 if (sdslen(query) > querylen) {
2705 /* leave data after the first line of the query in the buffer */
2706 c->querybuf = sdscatlen(c->querybuf,query+querylen,sdslen(query)-querylen);
2707 }
2708 *p = '\0'; /* remove "\n" */
2709 if (*(p-1) == '\r') *(p-1) = '\0'; /* and "\r" if any */
2710 sdsupdatelen(query);
2711
2712 /* Now we can split the query in arguments */
2713 argv = sdssplitlen(query,sdslen(query)," ",1,&argc);
2714 sdsfree(query);
2715
2716 if (c->argv) zfree(c->argv);
2717 c->argv = zmalloc(sizeof(robj*)*argc);
2718
2719 for (j = 0; j < argc; j++) {
2720 if (sdslen(argv[j])) {
2721 c->argv[c->argc] = createObject(REDIS_STRING,argv[j]);
2722 c->argc++;
2723 } else {
2724 sdsfree(argv[j]);
2725 }
2726 }
2727 zfree(argv);
2728 if (c->argc) {
2729 /* Execute the command. If the client is still valid
2730 * after processCommand() return and there is something
2731 * on the query buffer try to process the next command. */
2732 if (processCommand(c) && sdslen(c->querybuf)) goto again;
2733 } else {
2734 /* Nothing to process, argc == 0. Just process the query
2735 * buffer if it's not empty or return to the caller */
2736 if (sdslen(c->querybuf)) goto again;
2737 }
2738 return;
2739 } else if (sdslen(c->querybuf) >= REDIS_REQUEST_MAX_SIZE) {
2740 redisLog(REDIS_VERBOSE, "Client protocol error");
2741 freeClient(c);
2742 return;
2743 }
2744 } else {
2745 /* Bulk read handling. Note that if we are at this point
2746 the client already sent a command terminated with a newline,
2747 we are reading the bulk data that is actually the last
2748 argument of the command. */
2749 int qbl = sdslen(c->querybuf);
2750
2751 if (c->bulklen <= qbl) {
2752 /* Copy everything but the final CRLF as final argument */
2753 c->argv[c->argc] = createStringObject(c->querybuf,c->bulklen-2);
2754 c->argc++;
2755 c->querybuf = sdsrange(c->querybuf,c->bulklen,-1);
2756 /* Process the command. If the client is still valid after
2757 * the processing and there is more data in the buffer
2758 * try to parse it. */
2759 if (processCommand(c) && sdslen(c->querybuf)) goto again;
2760 return;
2761 }
2762 }
2763 }
2764
2765 static void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask) {
2766 redisClient *c = (redisClient*) privdata;
2767 char buf[REDIS_IOBUF_LEN];
2768 int nread;
2769 REDIS_NOTUSED(el);
2770 REDIS_NOTUSED(mask);
2771
2772 nread = read(fd, buf, REDIS_IOBUF_LEN);
2773 if (nread == -1) {
2774 if (errno == EAGAIN) {
2775 nread = 0;
2776 } else {
2777 redisLog(REDIS_VERBOSE, "Reading from client: %s",strerror(errno));
2778 freeClient(c);
2779 return;
2780 }
2781 } else if (nread == 0) {
2782 redisLog(REDIS_VERBOSE, "Client closed connection");
2783 freeClient(c);
2784 return;
2785 }
2786 if (nread) {
2787 c->querybuf = sdscatlen(c->querybuf, buf, nread);
2788 c->lastinteraction = time(NULL);
2789 } else {
2790 return;
2791 }
2792 processInputBuffer(c);
2793 }
2794
2795 static int selectDb(redisClient *c, int id) {
2796 if (id < 0 || id >= server.dbnum)
2797 return REDIS_ERR;
2798 c->db = &server.db[id];
2799 return REDIS_OK;
2800 }
2801
2802 static void *dupClientReplyValue(void *o) {
2803 incrRefCount((robj*)o);
2804 return o;
2805 }
2806
2807 static int listMatchObjects(void *a, void *b) {
2808 return equalStringObjects(a,b);
2809 }
2810
2811 static redisClient *createClient(int fd) {
2812 redisClient *c = zmalloc(sizeof(*c));
2813
2814 anetNonBlock(NULL,fd);
2815 anetTcpNoDelay(NULL,fd);
2816 if (!c) return NULL;
2817 selectDb(c,0);
2818 c->fd = fd;
2819 c->querybuf = sdsempty();
2820 c->argc = 0;
2821 c->argv = NULL;
2822 c->bulklen = -1;
2823 c->multibulk = 0;
2824 c->mbargc = 0;
2825 c->mbargv = NULL;
2826 c->sentlen = 0;
2827 c->flags = 0;
2828 c->lastinteraction = time(NULL);
2829 c->authenticated = 0;
2830 c->replstate = REDIS_REPL_NONE;
2831 c->reply = listCreate();
2832 listSetFreeMethod(c->reply,decrRefCount);
2833 listSetDupMethod(c->reply,dupClientReplyValue);
2834 c->blocking_keys = NULL;
2835 c->blocking_keys_num = 0;
2836 c->io_keys = listCreate();
2837 c->watched_keys = listCreate();
2838 listSetFreeMethod(c->io_keys,decrRefCount);
2839 c->pubsub_channels = dictCreate(&setDictType,NULL);
2840 c->pubsub_patterns = listCreate();
2841 listSetFreeMethod(c->pubsub_patterns,decrRefCount);
2842 listSetMatchMethod(c->pubsub_patterns,listMatchObjects);
2843 if (aeCreateFileEvent(server.el, c->fd, AE_READABLE,
2844 readQueryFromClient, c) == AE_ERR) {
2845 freeClient(c);
2846 return NULL;
2847 }
2848 listAddNodeTail(server.clients,c);
2849 initClientMultiState(c);
2850 return c;
2851 }
2852
2853 static void addReply(redisClient *c, robj *obj) {
2854 if (listLength(c->reply) == 0 &&
2855 (c->replstate == REDIS_REPL_NONE ||
2856 c->replstate == REDIS_REPL_ONLINE) &&
2857 aeCreateFileEvent(server.el, c->fd, AE_WRITABLE,
2858 sendReplyToClient, c) == AE_ERR) return;
2859
2860 if (server.vm_enabled && obj->storage != REDIS_VM_MEMORY) {
2861 obj = dupStringObject(obj);
2862 obj->refcount = 0; /* getDecodedObject() will increment the refcount */
2863 }
2864 listAddNodeTail(c->reply,getDecodedObject(obj));
2865 }
2866
2867 static void addReplySds(redisClient *c, sds s) {
2868 robj *o = createObject(REDIS_STRING,s);
2869 addReply(c,o);
2870 decrRefCount(o);
2871 }
2872
2873 static void addReplyDouble(redisClient *c, double d) {
2874 char buf[128];
2875
2876 snprintf(buf,sizeof(buf),"%.17g",d);
2877 addReplySds(c,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2878 (unsigned long) strlen(buf),buf));
2879 }
2880
2881 static void addReplyLongLong(redisClient *c, long long ll) {
2882 char buf[128];
2883 size_t len;
2884
2885 if (ll == 0) {
2886 addReply(c,shared.czero);
2887 return;
2888 } else if (ll == 1) {
2889 addReply(c,shared.cone);
2890 return;
2891 }
2892 buf[0] = ':';
2893 len = ll2string(buf+1,sizeof(buf)-1,ll);
2894 buf[len+1] = '\r';
2895 buf[len+2] = '\n';
2896 addReplySds(c,sdsnewlen(buf,len+3));
2897 }
2898
2899 static void addReplyUlong(redisClient *c, unsigned long ul) {
2900 char buf[128];
2901 size_t len;
2902
2903 if (ul == 0) {
2904 addReply(c,shared.czero);
2905 return;
2906 } else if (ul == 1) {
2907 addReply(c,shared.cone);
2908 return;
2909 }
2910 len = snprintf(buf,sizeof(buf),":%lu\r\n",ul);
2911 addReplySds(c,sdsnewlen(buf,len));
2912 }
2913
2914 static void addReplyBulkLen(redisClient *c, robj *obj) {
2915 size_t len, intlen;
2916 char buf[128];
2917
2918 if (obj->encoding == REDIS_ENCODING_RAW) {
2919 len = sdslen(obj->ptr);
2920 } else {
2921 long n = (long)obj->ptr;
2922
2923 /* Compute how many bytes will take this integer as a radix 10 string */
2924 len = 1;
2925 if (n < 0) {
2926 len++;
2927 n = -n;
2928 }
2929 while((n = n/10) != 0) {
2930 len++;
2931 }
2932 }
2933 buf[0] = '$';
2934 intlen = ll2string(buf+1,sizeof(buf)-1,(long long)len);
2935 buf[intlen+1] = '\r';
2936 buf[intlen+2] = '\n';
2937 addReplySds(c,sdsnewlen(buf,intlen+3));
2938 }
2939
2940 static void addReplyBulk(redisClient *c, robj *obj) {
2941 addReplyBulkLen(c,obj);
2942 addReply(c,obj);
2943 addReply(c,shared.crlf);
2944 }
2945
2946 static void addReplyBulkSds(redisClient *c, sds s) {
2947 robj *o = createStringObject(s, sdslen(s));
2948 addReplyBulk(c,o);
2949 decrRefCount(o);
2950 }
2951
2952 /* In the CONFIG command we need to add vanilla C string as bulk replies */
2953 static void addReplyBulkCString(redisClient *c, char *s) {
2954 if (s == NULL) {
2955 addReply(c,shared.nullbulk);
2956 } else {
2957 robj *o = createStringObject(s,strlen(s));
2958 addReplyBulk(c,o);
2959 decrRefCount(o);
2960 }
2961 }
2962
2963 static void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask) {
2964 int cport, cfd;
2965 char cip[128];
2966 redisClient *c;
2967 REDIS_NOTUSED(el);
2968 REDIS_NOTUSED(mask);
2969 REDIS_NOTUSED(privdata);
2970
2971 cfd = anetAccept(server.neterr, fd, cip, &cport);
2972 if (cfd == AE_ERR) {
2973 redisLog(REDIS_VERBOSE,"Accepting client connection: %s", server.neterr);
2974 return;
2975 }
2976 redisLog(REDIS_VERBOSE,"Accepted %s:%d", cip, cport);
2977 if ((c = createClient(cfd)) == NULL) {
2978 redisLog(REDIS_WARNING,"Error allocating resoures for the client");
2979 close(cfd); /* May be already closed, just ingore errors */
2980 return;
2981 }
2982 /* If maxclient directive is set and this is one client more... close the
2983 * connection. Note that we create the client instead to check before
2984 * for this condition, since now the socket is already set in nonblocking
2985 * mode and we can send an error for free using the Kernel I/O */
2986 if (server.maxclients && listLength(server.clients) > server.maxclients) {
2987 char *err = "-ERR max number of clients reached\r\n";
2988
2989 /* That's a best effort error message, don't check write errors */
2990 if (write(c->fd,err,strlen(err)) == -1) {
2991 /* Nothing to do, Just to avoid the warning... */
2992 }
2993 freeClient(c);
2994 return;
2995 }
2996 server.stat_numconnections++;
2997 }
2998
2999 /* ======================= Redis objects implementation ===================== */
3000
3001 static robj *createObject(int type, void *ptr) {
3002 robj *o;
3003
3004 if (server.vm_enabled) pthread_mutex_lock(&server.obj_freelist_mutex);
3005 if (listLength(server.objfreelist)) {
3006 listNode *head = listFirst(server.objfreelist);
3007 o = listNodeValue(head);
3008 listDelNode(server.objfreelist,head);
3009 if (server.vm_enabled) pthread_mutex_unlock(&server.obj_freelist_mutex);
3010 } else {
3011 if (server.vm_enabled)
3012 pthread_mutex_unlock(&server.obj_freelist_mutex);
3013 o = zmalloc(sizeof(*o));
3014 }
3015 o->type = type;
3016 o->encoding = REDIS_ENCODING_RAW;
3017 o->ptr = ptr;
3018 o->refcount = 1;
3019 if (server.vm_enabled) {
3020 /* Note that this code may run in the context of an I/O thread
3021 * and accessing server.lruclock in theory is an error
3022 * (no locks). But in practice this is safe, and even if we read
3023 * garbage Redis will not fail. */
3024 o->lru = server.lruclock;
3025 o->storage = REDIS_VM_MEMORY;
3026 }
3027 return o;
3028 }
3029
3030 static robj *createStringObject(char *ptr, size_t len) {
3031 return createObject(REDIS_STRING,sdsnewlen(ptr,len));
3032 }
3033
3034 static robj *createStringObjectFromLongLong(long long value) {
3035 robj *o;
3036 if (value >= 0 && value < REDIS_SHARED_INTEGERS) {
3037 incrRefCount(shared.integers[value]);
3038 o = shared.integers[value];
3039 } else {
3040 if (value >= LONG_MIN && value <= LONG_MAX) {
3041 o = createObject(REDIS_STRING, NULL);
3042 o->encoding = REDIS_ENCODING_INT;
3043 o->ptr = (void*)((long)value);
3044 } else {
3045 o = createObject(REDIS_STRING,sdsfromlonglong(value));
3046 }
3047 }
3048 return o;
3049 }
3050
3051 static robj *dupStringObject(robj *o) {
3052 assert(o->encoding == REDIS_ENCODING_RAW);
3053 return createStringObject(o->ptr,sdslen(o->ptr));
3054 }
3055
3056 static robj *createListObject(void) {
3057 list *l = listCreate();
3058 robj *o = createObject(REDIS_LIST,l);
3059 listSetFreeMethod(l,decrRefCount);
3060 o->encoding = REDIS_ENCODING_LIST;
3061 return o;
3062 }
3063
3064 static robj *createZiplistObject(void) {
3065 unsigned char *zl = ziplistNew();
3066 robj *o = createObject(REDIS_LIST,zl);
3067 o->encoding = REDIS_ENCODING_ZIPLIST;
3068 return o;
3069 }
3070
3071 static robj *createSetObject(void) {
3072 dict *d = dictCreate(&setDictType,NULL);
3073 return createObject(REDIS_SET,d);
3074 }
3075
3076 static robj *createHashObject(void) {
3077 /* All the Hashes start as zipmaps. Will be automatically converted
3078 * into hash tables if there are enough elements or big elements
3079 * inside. */
3080 unsigned char *zm = zipmapNew();
3081 robj *o = createObject(REDIS_HASH,zm);
3082 o->encoding = REDIS_ENCODING_ZIPMAP;
3083 return o;
3084 }
3085
3086 static robj *createZsetObject(void) {
3087 zset *zs = zmalloc(sizeof(*zs));
3088
3089 zs->dict = dictCreate(&zsetDictType,NULL);
3090 zs->zsl = zslCreate();
3091 return createObject(REDIS_ZSET,zs);
3092 }
3093
3094 static void freeStringObject(robj *o) {
3095 if (o->encoding == REDIS_ENCODING_RAW) {
3096 sdsfree(o->ptr);
3097 }
3098 }
3099
3100 static void freeListObject(robj *o) {
3101 switch (o->encoding) {
3102 case REDIS_ENCODING_LIST:
3103 listRelease((list*) o->ptr);
3104 break;
3105 case REDIS_ENCODING_ZIPLIST:
3106 zfree(o->ptr);
3107 break;
3108 default:
3109 redisPanic("Unknown list encoding type");
3110 }
3111 }
3112
3113 static void freeSetObject(robj *o) {
3114 dictRelease((dict*) o->ptr);
3115 }
3116
3117 static void freeZsetObject(robj *o) {
3118 zset *zs = o->ptr;
3119
3120 dictRelease(zs->dict);
3121 zslFree(zs->zsl);
3122 zfree(zs);
3123 }
3124
3125 static void freeHashObject(robj *o) {
3126 switch (o->encoding) {
3127 case REDIS_ENCODING_HT:
3128 dictRelease((dict*) o->ptr);
3129 break;
3130 case REDIS_ENCODING_ZIPMAP:
3131 zfree(o->ptr);
3132 break;
3133 default:
3134 redisPanic("Unknown hash encoding type");
3135 break;
3136 }
3137 }
3138
3139 static void incrRefCount(robj *o) {
3140 o->refcount++;
3141 }
3142
3143 static void decrRefCount(void *obj) {
3144 robj *o = obj;
3145
3146 /* Object is a swapped out value, or in the process of being loaded. */
3147 if (server.vm_enabled &&
3148 (o->storage == REDIS_VM_SWAPPED || o->storage == REDIS_VM_LOADING))
3149 {
3150 vmpointer *vp = obj;
3151 if (o->storage == REDIS_VM_LOADING) vmCancelThreadedIOJob(o);
3152 vmMarkPagesFree(vp->page,vp->usedpages);
3153 server.vm_stats_swapped_objects--;
3154 zfree(vp);
3155 return;
3156 }
3157
3158 if (o->refcount <= 0) redisPanic("decrRefCount against refcount <= 0");
3159 /* Object is in memory, or in the process of being swapped out.
3160 *
3161 * If the object is being swapped out, abort the operation on
3162 * decrRefCount even if the refcount does not drop to 0: the object
3163 * is referenced at least two times, as value of the key AND as
3164 * job->val in the iojob. So if we don't invalidate the iojob, when it is
3165 * done but the relevant key was removed in the meantime, the
3166 * complete jobs handler will not find the key about the job and the
3167 * assert will fail. */
3168 if (server.vm_enabled && o->storage == REDIS_VM_SWAPPING)
3169 vmCancelThreadedIOJob(o);
3170 if (--(o->refcount) == 0) {
3171 switch(o->type) {
3172 case REDIS_STRING: freeStringObject(o); break;
3173 case REDIS_LIST: freeListObject(o); break;
3174 case REDIS_SET: freeSetObject(o); break;
3175 case REDIS_ZSET: freeZsetObject(o); break;
3176 case REDIS_HASH: freeHashObject(o); break;
3177 default: redisPanic("Unknown object type"); break;
3178 }
3179 if (server.vm_enabled) pthread_mutex_lock(&server.obj_freelist_mutex);
3180 if (listLength(server.objfreelist) > REDIS_OBJFREELIST_MAX ||
3181 !listAddNodeHead(server.objfreelist,o))
3182 zfree(o);
3183 if (server.vm_enabled) pthread_mutex_unlock(&server.obj_freelist_mutex);
3184 }
3185 }
3186
3187 static int checkType(redisClient *c, robj *o, int type) {
3188 if (o->type != type) {
3189 addReply(c,shared.wrongtypeerr);
3190 return 1;
3191 }
3192 return 0;
3193 }
3194
3195 /* Check if the nul-terminated string 's' can be represented by a long
3196 * (that is, is a number that fits into long without any other space or
3197 * character before or after the digits).
3198 *
3199 * If so, the function returns REDIS_OK and *longval is set to the value
3200 * of the number. Otherwise REDIS_ERR is returned */
3201 static int isStringRepresentableAsLong(sds s, long *longval) {
3202 char buf[32], *endptr;
3203 long value;
3204 int slen;
3205
3206 value = strtol(s, &endptr, 10);
3207 if (endptr[0] != '\0') return REDIS_ERR;
3208 slen = ll2string(buf,32,value);
3209
3210 /* If the number converted back into a string is not identical
3211 * then it's not possible to encode the string as integer */
3212 if (sdslen(s) != (unsigned)slen || memcmp(buf,s,slen)) return REDIS_ERR;
3213 if (longval) *longval = value;
3214 return REDIS_OK;
3215 }
3216
3217 /* Try to encode a string object in order to save space */
3218 static robj *tryObjectEncoding(robj *o) {
3219 long value;
3220 sds s = o->ptr;
3221
3222 if (o->encoding != REDIS_ENCODING_RAW)
3223 return o; /* Already encoded */
3224
3225 /* It's not safe to encode shared objects: shared objects can be shared
3226 * everywhere in the "object space" of Redis. Encoded objects can only
3227 * appear as "values" (and not, for instance, as keys) */
3228 if (o->refcount > 1) return o;
3229
3230 /* Currently we try to encode only strings */
3231 redisAssert(o->type == REDIS_STRING);
3232
3233 /* Check if we can represent this string as a long integer */
3234 if (isStringRepresentableAsLong(s,&value) == REDIS_ERR) return o;
3235
3236 /* Ok, this object can be encoded */
3237 if (value >= 0 && value < REDIS_SHARED_INTEGERS) {
3238 decrRefCount(o);
3239 incrRefCount(shared.integers[value]);
3240 return shared.integers[value];
3241 } else {
3242 o->encoding = REDIS_ENCODING_INT;
3243 sdsfree(o->ptr);
3244 o->ptr = (void*) value;
3245 return o;
3246 }
3247 }
3248
3249 /* Get a decoded version of an encoded object (returned as a new object).
3250 * If the object is already raw-encoded just increment the ref count. */
3251 static robj *getDecodedObject(robj *o) {
3252 robj *dec;
3253
3254 if (o->encoding == REDIS_ENCODING_RAW) {
3255 incrRefCount(o);
3256 return o;
3257 }
3258 if (o->type == REDIS_STRING && o->encoding == REDIS_ENCODING_INT) {
3259 char buf[32];
3260
3261 ll2string(buf,32,(long)o->ptr);
3262 dec = createStringObject(buf,strlen(buf));
3263 return dec;
3264 } else {
3265 redisPanic("Unknown encoding type");
3266 }
3267 }
3268
3269 /* Compare two string objects via strcmp() or alike.
3270 * Note that the objects may be integer-encoded. In such a case we
3271 * use ll2string() to get a string representation of the numbers on the stack
3272 * and compare the strings, it's much faster than calling getDecodedObject().
3273 *
3274 * Important note: if objects are not integer encoded, but binary-safe strings,
3275 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
3276 * binary safe. */
3277 static int compareStringObjects(robj *a, robj *b) {
3278 redisAssert(a->type == REDIS_STRING && b->type == REDIS_STRING);
3279 char bufa[128], bufb[128], *astr, *bstr;
3280 int bothsds = 1;
3281
3282 if (a == b) return 0;
3283 if (a->encoding != REDIS_ENCODING_RAW) {
3284 ll2string(bufa,sizeof(bufa),(long) a->ptr);
3285 astr = bufa;
3286 bothsds = 0;
3287 } else {
3288 astr = a->ptr;
3289 }
3290 if (b->encoding != REDIS_ENCODING_RAW) {
3291 ll2string(bufb,sizeof(bufb),(long) b->ptr);
3292 bstr = bufb;
3293 bothsds = 0;
3294 } else {
3295 bstr = b->ptr;
3296 }
3297 return bothsds ? sdscmp(astr,bstr) : strcmp(astr,bstr);
3298 }
3299
3300 /* Equal string objects return 1 if the two objects are the same from the
3301 * point of view of a string comparison, otherwise 0 is returned. Note that
3302 * this function is faster then checking for (compareStringObject(a,b) == 0)
3303 * because it can perform some more optimization. */
3304 static int equalStringObjects(robj *a, robj *b) {
3305 if (a->encoding != REDIS_ENCODING_RAW && b->encoding != REDIS_ENCODING_RAW){
3306 return a->ptr == b->ptr;
3307 } else {
3308 return compareStringObjects(a,b) == 0;
3309 }
3310 }
3311
3312 static size_t stringObjectLen(robj *o) {
3313 redisAssert(o->type == REDIS_STRING);
3314 if (o->encoding == REDIS_ENCODING_RAW) {
3315 return sdslen(o->ptr);
3316 } else {
3317 char buf[32];
3318
3319 return ll2string(buf,32,(long)o->ptr);
3320 }
3321 }
3322
3323 static int getDoubleFromObject(robj *o, double *target) {
3324 double value;
3325 char *eptr;
3326
3327 if (o == NULL) {
3328 value = 0;
3329 } else {
3330 redisAssert(o->type == REDIS_STRING);
3331 if (o->encoding == REDIS_ENCODING_RAW) {
3332 value = strtod(o->ptr, &eptr);
3333 if (eptr[0] != '\0') return REDIS_ERR;
3334 } else if (o->encoding == REDIS_ENCODING_INT) {
3335 value = (long)o->ptr;
3336 } else {
3337 redisPanic("Unknown string encoding");
3338 }
3339 }
3340
3341 *target = value;
3342 return REDIS_OK;
3343 }
3344
3345 static int getDoubleFromObjectOrReply(redisClient *c, robj *o, double *target, const char *msg) {
3346 double value;
3347 if (getDoubleFromObject(o, &value) != REDIS_OK) {
3348 if (msg != NULL) {
3349 addReplySds(c, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg));
3350 } else {
3351 addReplySds(c, sdsnew("-ERR value is not a double\r\n"));
3352 }
3353 return REDIS_ERR;
3354 }
3355
3356 *target = value;
3357 return REDIS_OK;
3358 }
3359
3360 static int getLongLongFromObject(robj *o, long long *target) {
3361 long long value;
3362 char *eptr;
3363
3364 if (o == NULL) {
3365 value = 0;
3366 } else {
3367 redisAssert(o->type == REDIS_STRING);
3368 if (o->encoding == REDIS_ENCODING_RAW) {
3369 value = strtoll(o->ptr, &eptr, 10);
3370 if (eptr[0] != '\0') return REDIS_ERR;
3371 } else if (o->encoding == REDIS_ENCODING_INT) {
3372 value = (long)o->ptr;
3373 } else {
3374 redisPanic("Unknown string encoding");
3375 }
3376 }
3377
3378 *target = value;
3379 return REDIS_OK;
3380 }
3381
3382 static int getLongLongFromObjectOrReply(redisClient *c, robj *o, long long *target, const char *msg) {
3383 long long value;
3384 if (getLongLongFromObject(o, &value) != REDIS_OK) {
3385 if (msg != NULL) {
3386 addReplySds(c, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg));
3387 } else {
3388 addReplySds(c, sdsnew("-ERR value is not an integer\r\n"));
3389 }
3390 return REDIS_ERR;
3391 }
3392
3393 *target = value;
3394 return REDIS_OK;
3395 }
3396
3397 static int getLongFromObjectOrReply(redisClient *c, robj *o, long *target, const char *msg) {
3398 long long value;
3399
3400 if (getLongLongFromObjectOrReply(c, o, &value, msg) != REDIS_OK) return REDIS_ERR;
3401 if (value < LONG_MIN || value > LONG_MAX) {
3402 if (msg != NULL) {
3403 addReplySds(c, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg));
3404 } else {
3405 addReplySds(c, sdsnew("-ERR value is out of range\r\n"));
3406 }
3407 return REDIS_ERR;
3408 }
3409
3410 *target = value;
3411 return REDIS_OK;
3412 }
3413
3414 /* =========================== Keyspace access API ========================== */
3415
3416 static robj *lookupKey(redisDb *db, robj *key) {
3417 dictEntry *de = dictFind(db->dict,key->ptr);
3418 if (de) {
3419 robj *val = dictGetEntryVal(de);
3420
3421 if (server.vm_enabled) {
3422 if (val->storage == REDIS_VM_MEMORY ||
3423 val->storage == REDIS_VM_SWAPPING)
3424 {
3425 /* If we were swapping the object out, cancel the operation */
3426 if (val->storage == REDIS_VM_SWAPPING)
3427 vmCancelThreadedIOJob(val);
3428 /* Update the access time for the aging algorithm. */
3429 val->lru = server.lruclock;
3430 } else {
3431 int notify = (val->storage == REDIS_VM_LOADING);
3432
3433 /* Our value was swapped on disk. Bring it at home. */
3434 redisAssert(val->type == REDIS_VMPOINTER);
3435 val = vmLoadObject(val);
3436 dictGetEntryVal(de) = val;
3437
3438 /* Clients blocked by the VM subsystem may be waiting for
3439 * this key... */
3440 if (notify) handleClientsBlockedOnSwappedKey(db,key);
3441 }
3442 }
3443 return val;
3444 } else {
3445 return NULL;
3446 }
3447 }
3448
3449 static robj *lookupKeyRead(redisDb *db, robj *key) {
3450 expireIfNeeded(db,key);
3451 return lookupKey(db,key);
3452 }
3453
3454 static robj *lookupKeyWrite(redisDb *db, robj *key) {
3455 deleteIfVolatile(db,key);
3456 touchWatchedKey(db,key);
3457 return lookupKey(db,key);
3458 }
3459
3460 static robj *lookupKeyReadOrReply(redisClient *c, robj *key, robj *reply) {
3461 robj *o = lookupKeyRead(c->db, key);
3462 if (!o) addReply(c,reply);
3463 return o;
3464 }
3465
3466 static robj *lookupKeyWriteOrReply(redisClient *c, robj *key, robj *reply) {
3467 robj *o = lookupKeyWrite(c->db, key);
3468 if (!o) addReply(c,reply);
3469 return o;
3470 }
3471
3472 /* Add the key to the DB. If the key already exists REDIS_ERR is returned,
3473 * otherwise REDIS_OK is returned, and the caller should increment the
3474 * refcount of 'val'. */
3475 static int dbAdd(redisDb *db, robj *key, robj *val) {
3476 /* Perform a lookup before adding the key, as we need to copy the
3477 * key value. */
3478 if (dictFind(db->dict, key->ptr) != NULL) {
3479 return REDIS_ERR;
3480 } else {
3481 sds copy = sdsdup(key->ptr);
3482 dictAdd(db->dict, copy, val);
3483 return REDIS_OK;
3484 }
3485 }
3486
3487 /* If the key does not exist, this is just like dbAdd(). Otherwise
3488 * the value associated to the key is replaced with the new one.
3489 *
3490 * On update (key already existed) 0 is returned. Otherwise 1. */
3491 static int dbReplace(redisDb *db, robj *key, robj *val) {
3492 if (dictFind(db->dict,key->ptr) == NULL) {
3493 sds copy = sdsdup(key->ptr);
3494 dictAdd(db->dict, copy, val);
3495 return 1;
3496 } else {
3497 dictReplace(db->dict, key->ptr, val);
3498 return 0;
3499 }
3500 }
3501
3502 static int dbExists(redisDb *db, robj *key) {
3503 return dictFind(db->dict,key->ptr) != NULL;
3504 }
3505
3506 /* Return a random key, in form of a Redis object.
3507 * If there are no keys, NULL is returned.
3508 *
3509 * The function makes sure to return keys not already expired. */
3510 static robj *dbRandomKey(redisDb *db) {
3511 struct dictEntry *de;
3512
3513 while(1) {
3514 sds key;
3515 robj *keyobj;
3516
3517 de = dictGetRandomKey(db->dict);
3518 if (de == NULL) return NULL;
3519
3520 key = dictGetEntryKey(de);
3521 keyobj = createStringObject(key,sdslen(key));
3522 if (dictFind(db->expires,key)) {
3523 if (expireIfNeeded(db,keyobj)) {
3524 decrRefCount(keyobj);
3525 continue; /* search for another key. This expired. */
3526 }
3527 }
3528 return keyobj;
3529 }
3530 }
3531
3532 /* Delete a key, value, and associated expiration entry if any, from the DB */
3533 static int dbDelete(redisDb *db, robj *key) {
3534 int retval;
3535
3536 if (dictSize(db->expires)) dictDelete(db->expires,key->ptr);
3537 retval = dictDelete(db->dict,key->ptr);
3538
3539 return retval == DICT_OK;
3540 }
3541
3542 /*============================ RDB saving/loading =========================== */
3543
3544 static int rdbSaveType(FILE *fp, unsigned char type) {
3545 if (fwrite(&type,1,1,fp) == 0) return -1;
3546 return 0;
3547 }
3548
3549 static int rdbSaveTime(FILE *fp, time_t t) {
3550 int32_t t32 = (int32_t) t;
3551 if (fwrite(&t32,4,1,fp) == 0) return -1;
3552 return 0;
3553 }
3554
3555 /* check rdbLoadLen() comments for more info */
3556 static int rdbSaveLen(FILE *fp, uint32_t len) {
3557 unsigned char buf[2];
3558
3559 if (len < (1<<6)) {
3560 /* Save a 6 bit len */
3561 buf[0] = (len&0xFF)|(REDIS_RDB_6BITLEN<<6);
3562 if (fwrite(buf,1,1,fp) == 0) return -1;
3563 } else if (len < (1<<14)) {
3564 /* Save a 14 bit len */
3565 buf[0] = ((len>>8)&0xFF)|(REDIS_RDB_14BITLEN<<6);
3566 buf[1] = len&0xFF;
3567 if (fwrite(buf,2,1,fp) == 0) return -1;
3568 } else {
3569 /* Save a 32 bit len */
3570 buf[0] = (REDIS_RDB_32BITLEN<<6);
3571 if (fwrite(buf,1,1,fp) == 0) return -1;
3572 len = htonl(len);
3573 if (fwrite(&len,4,1,fp) == 0) return -1;
3574 }
3575 return 0;
3576 }
3577
3578 /* Encode 'value' as an integer if possible (if integer will fit the
3579 * supported range). If the function sucessful encoded the integer
3580 * then the (up to 5 bytes) encoded representation is written in the
3581 * string pointed by 'enc' and the length is returned. Otherwise
3582 * 0 is returned. */
3583 static int rdbEncodeInteger(long long value, unsigned char *enc) {
3584 /* Finally check if it fits in our ranges */
3585 if (value >= -(1<<7) && value <= (1<<7)-1) {
3586 enc[0] = (REDIS_RDB_ENCVAL<<6)|REDIS_RDB_ENC_INT8;
3587 enc[1] = value&0xFF;
3588 return 2;
3589 } else if (value >= -(1<<15) && value <= (1<<15)-1) {
3590 enc[0] = (REDIS_RDB_ENCVAL<<6)|REDIS_RDB_ENC_INT16;
3591 enc[1] = value&0xFF;
3592 enc[2] = (value>>8)&0xFF;
3593 return 3;
3594 } else if (value >= -((long long)1<<31) && value <= ((long long)1<<31)-1) {
3595 enc[0] = (REDIS_RDB_ENCVAL<<6)|REDIS_RDB_ENC_INT32;
3596 enc[1] = value&0xFF;
3597 enc[2] = (value>>8)&0xFF;
3598 enc[3] = (value>>16)&0xFF;
3599 enc[4] = (value>>24)&0xFF;
3600 return 5;
3601 } else {
3602 return 0;
3603 }
3604 }
3605
3606 /* String objects in the form "2391" "-100" without any space and with a
3607 * range of values that can fit in an 8, 16 or 32 bit signed value can be
3608 * encoded as integers to save space */
3609 static int rdbTryIntegerEncoding(char *s, size_t len, unsigned char *enc) {
3610 long long value;
3611 char *endptr, buf[32];
3612
3613 /* Check if it's possible to encode this value as a number */
3614 value = strtoll(s, &endptr, 10);
3615 if (endptr[0] != '\0') return 0;
3616 ll2string(buf,32,value);
3617
3618 /* If the number converted back into a string is not identical
3619 * then it's not possible to encode the string as integer */
3620 if (strlen(buf) != len || memcmp(buf,s,len)) return 0;
3621
3622 return rdbEncodeInteger(value,enc);
3623 }
3624
3625 static int rdbSaveLzfStringObject(FILE *fp, unsigned char *s, size_t len) {
3626 size_t comprlen, outlen;
3627 unsigned char byte;
3628 void *out;
3629
3630 /* We require at least four bytes compression for this to be worth it */
3631 if (len <= 4) return 0;
3632 outlen = len-4;
3633 if ((out = zmalloc(outlen+1)) == NULL) return 0;
3634 comprlen = lzf_compress(s, len, out, outlen);
3635 if (comprlen == 0) {
3636 zfree(out);
3637 return 0;
3638 }
3639 /* Data compressed! Let's save it on disk */
3640 byte = (REDIS_RDB_ENCVAL<<6)|REDIS_RDB_ENC_LZF;
3641 if (fwrite(&byte,1,1,fp) == 0) goto writeerr;
3642 if (rdbSaveLen(fp,comprlen) == -1) goto writeerr;
3643 if (rdbSaveLen(fp,len) == -1) goto writeerr;
3644 if (fwrite(out,comprlen,1,fp) == 0) goto writeerr;
3645 zfree(out);
3646 return comprlen;
3647
3648 writeerr:
3649 zfree(out);
3650 return -1;
3651 }
3652
3653 /* Save a string objet as [len][data] on disk. If the object is a string
3654 * representation of an integer value we try to safe it in a special form */
3655 static int rdbSaveRawString(FILE *fp, unsigned char *s, size_t len) {
3656 int enclen;
3657
3658 /* Try integer encoding */
3659 if (len <= 11) {
3660 unsigned char buf[5];
3661 if ((enclen = rdbTryIntegerEncoding((char*)s,len,buf)) > 0) {
3662 if (fwrite(buf,enclen,1,fp) == 0) return -1;
3663 return 0;
3664 }
3665 }
3666
3667 /* Try LZF compression - under 20 bytes it's unable to compress even
3668 * aaaaaaaaaaaaaaaaaa so skip it */
3669 if (server.rdbcompression && len > 20) {
3670 int retval;
3671
3672 retval = rdbSaveLzfStringObject(fp,s,len);
3673 if (retval == -1) return -1;
3674 if (retval > 0) return 0;
3675 /* retval == 0 means data can't be compressed, save the old way */
3676 }
3677
3678 /* Store verbatim */
3679 if (rdbSaveLen(fp,len) == -1) return -1;
3680 if (len && fwrite(s,len,1,fp) == 0) return -1;
3681 return 0;
3682 }
3683
3684 /* Save a long long value as either an encoded string or a string. */
3685 static int rdbSaveLongLongAsStringObject(FILE *fp, long long value) {
3686 unsigned char buf[32];
3687 int enclen = rdbEncodeInteger(value,buf);
3688 if (enclen > 0) {
3689 if (fwrite(buf,enclen,1,fp) == 0) return -1;
3690 } else {
3691 /* Encode as string */
3692 enclen = ll2string((char*)buf,32,value);
3693 redisAssert(enclen < 32);
3694 if (rdbSaveLen(fp,enclen) == -1) return -1;
3695 if (fwrite(buf,enclen,1,fp) == 0) return -1;
3696 }
3697 return 0;
3698 }
3699
3700 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
3701 static int rdbSaveStringObject(FILE *fp, robj *obj) {
3702 /* Avoid to decode the object, then encode it again, if the
3703 * object is alrady integer encoded. */
3704 if (obj->encoding == REDIS_ENCODING_INT) {
3705 return rdbSaveLongLongAsStringObject(fp,(long)obj->ptr);
3706 } else {
3707 redisAssert(obj->encoding == REDIS_ENCODING_RAW);
3708 return rdbSaveRawString(fp,obj->ptr,sdslen(obj->ptr));
3709 }
3710 }
3711
3712 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
3713 * 8 bit integer specifing the length of the representation.
3714 * This 8 bit integer has special values in order to specify the following
3715 * conditions:
3716 * 253: not a number
3717 * 254: + inf
3718 * 255: - inf
3719 */
3720 static int rdbSaveDoubleValue(FILE *fp, double val) {
3721 unsigned char buf[128];
3722 int len;
3723
3724 if (isnan(val)) {
3725 buf[0] = 253;
3726 len = 1;
3727 } else if (!isfinite(val)) {
3728 len = 1;
3729 buf[0] = (val < 0) ? 255 : 254;
3730 } else {
3731 #if (DBL_MANT_DIG >= 52) && (LLONG_MAX == 0x7fffffffffffffffLL)
3732 /* Check if the float is in a safe range to be casted into a
3733 * long long. We are assuming that long long is 64 bit here.
3734 * Also we are assuming that there are no implementations around where
3735 * double has precision < 52 bit.
3736 *
3737 * Under this assumptions we test if a double is inside an interval
3738 * where casting to long long is safe. Then using two castings we
3739 * make sure the decimal part is zero. If all this is true we use
3740 * integer printing function that is much faster. */
3741 double min = -4503599627370495; /* (2^52)-1 */
3742 double max = 4503599627370496; /* -(2^52) */
3743 if (val > min && val < max && val == ((double)((long long)val)))
3744 ll2string((char*)buf+1,sizeof(buf),(long long)val);
3745 else
3746 #endif
3747 snprintf((char*)buf+1,sizeof(buf)-1,"%.17g",val);
3748 buf[0] = strlen((char*)buf+1);
3749 len = buf[0]+1;
3750 }
3751 if (fwrite(buf,len,1,fp) == 0) return -1;
3752 return 0;
3753 }
3754
3755 /* Save a Redis object. */
3756 static int rdbSaveObject(FILE *fp, robj *o) {
3757 if (o->type == REDIS_STRING) {
3758 /* Save a string value */
3759 if (rdbSaveStringObject(fp,o) == -1) return -1;
3760 } else if (o->type == REDIS_LIST) {
3761 /* Save a list value */
3762 if (o->encoding == REDIS_ENCODING_ZIPLIST) {
3763 unsigned char *p;
3764 unsigned char *vstr;
3765 unsigned int vlen;
3766 long long vlong;
3767
3768 if (rdbSaveLen(fp,ziplistLen(o->ptr)) == -1) return -1;
3769 p = ziplistIndex(o->ptr,0);
3770 while(ziplistGet(p,&vstr,&vlen,&vlong)) {
3771 if (vstr) {
3772 if (rdbSaveRawString(fp,vstr,vlen) == -1)
3773 return -1;
3774 } else {
3775 if (rdbSaveLongLongAsStringObject(fp,vlong) == -1)
3776 return -1;
3777 }
3778 p = ziplistNext(o->ptr,p);
3779 }
3780 } else if (o->encoding == REDIS_ENCODING_LIST) {
3781 list *list = o->ptr;
3782 listIter li;
3783 listNode *ln;
3784
3785 if (rdbSaveLen(fp,listLength(list)) == -1) return -1;
3786 listRewind(list,&li);
3787 while((ln = listNext(&li))) {
3788 robj *eleobj = listNodeValue(ln);
3789 if (rdbSaveStringObject(fp,eleobj) == -1) return -1;
3790 }
3791 } else {
3792 redisPanic("Unknown list encoding");
3793 }
3794 } else if (o->type == REDIS_SET) {
3795 /* Save a set value */
3796 dict *set = o->ptr;
3797 dictIterator *di = dictGetIterator(set);
3798 dictEntry *de;
3799
3800 if (rdbSaveLen(fp,dictSize(set)) == -1) return -1;
3801 while((de = dictNext(di)) != NULL) {
3802 robj *eleobj = dictGetEntryKey(de);
3803
3804 if (rdbSaveStringObject(fp,eleobj) == -1) return -1;
3805 }
3806 dictReleaseIterator(di);
3807 } else if (o->type == REDIS_ZSET) {
3808 /* Save a set value */
3809 zset *zs = o->ptr;
3810 dictIterator *di = dictGetIterator(zs->dict);
3811 dictEntry *de;
3812
3813 if (rdbSaveLen(fp,dictSize(zs->dict)) == -1) return -1;
3814 while((de = dictNext(di)) != NULL) {
3815 robj *eleobj = dictGetEntryKey(de);
3816 double *score = dictGetEntryVal(de);
3817
3818 if (rdbSaveStringObject(fp,eleobj) == -1) return -1;
3819 if (rdbSaveDoubleValue(fp,*score) == -1) return -1;
3820 }
3821 dictReleaseIterator(di);
3822 } else if (o->type == REDIS_HASH) {
3823 /* Save a hash value */
3824 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
3825 unsigned char *p = zipmapRewind(o->ptr);
3826 unsigned int count = zipmapLen(o->ptr);
3827 unsigned char *key, *val;
3828 unsigned int klen, vlen;
3829
3830 if (rdbSaveLen(fp,count) == -1) return -1;
3831 while((p = zipmapNext(p,&key,&klen,&val,&vlen)) != NULL) {
3832 if (rdbSaveRawString(fp,key,klen) == -1) return -1;
3833 if (rdbSaveRawString(fp,val,vlen) == -1) return -1;
3834 }
3835 } else {
3836 dictIterator *di = dictGetIterator(o->ptr);
3837 dictEntry *de;
3838
3839 if (rdbSaveLen(fp,dictSize((dict*)o->ptr)) == -1) return -1;
3840 while((de = dictNext(di)) != NULL) {
3841 robj *key = dictGetEntryKey(de);
3842 robj *val = dictGetEntryVal(de);
3843
3844 if (rdbSaveStringObject(fp,key) == -1) return -1;
3845 if (rdbSaveStringObject(fp,val) == -1) return -1;
3846 }
3847 dictReleaseIterator(di);
3848 }
3849 } else {
3850 redisPanic("Unknown object type");
3851 }
3852 return 0;
3853 }
3854
3855 /* Return the length the object will have on disk if saved with
3856 * the rdbSaveObject() function. Currently we use a trick to get
3857 * this length with very little changes to the code. In the future
3858 * we could switch to a faster solution. */
3859 static off_t rdbSavedObjectLen(robj *o, FILE *fp) {
3860 if (fp == NULL) fp = server.devnull;
3861 rewind(fp);
3862 assert(rdbSaveObject(fp,o) != 1);
3863 return ftello(fp);
3864 }
3865
3866 /* Return the number of pages required to save this object in the swap file */
3867 static off_t rdbSavedObjectPages(robj *o, FILE *fp) {
3868 off_t bytes = rdbSavedObjectLen(o,fp);
3869
3870 return (bytes+(server.vm_page_size-1))/server.vm_page_size;
3871 }
3872
3873 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3874 static int rdbSave(char *filename) {
3875 dictIterator *di = NULL;
3876 dictEntry *de;
3877 FILE *fp;
3878 char tmpfile[256];
3879 int j;
3880 time_t now = time(NULL);
3881
3882 /* Wait for I/O therads to terminate, just in case this is a
3883 * foreground-saving, to avoid seeking the swap file descriptor at the
3884 * same time. */
3885 if (server.vm_enabled)
3886 waitEmptyIOJobsQueue();
3887
3888 snprintf(tmpfile,256,"temp-%d.rdb", (int) getpid());
3889 fp = fopen(tmpfile,"w");
3890 if (!fp) {
3891 redisLog(REDIS_WARNING, "Failed saving the DB: %s", strerror(errno));
3892 return REDIS_ERR;
3893 }
3894 if (fwrite("REDIS0001",9,1,fp) == 0) goto werr;
3895 for (j = 0; j < server.dbnum; j++) {
3896 redisDb *db = server.db+j;
3897 dict *d = db->dict;
3898 if (dictSize(d) == 0) continue;
3899 di = dictGetIterator(d);
3900 if (!di) {
3901 fclose(fp);
3902 return REDIS_ERR;
3903 }
3904
3905 /* Write the SELECT DB opcode */
3906 if (rdbSaveType(fp,REDIS_SELECTDB) == -1) goto werr;
3907 if (rdbSaveLen(fp,j) == -1) goto werr;
3908
3909 /* Iterate this DB writing every entry */
3910 while((de = dictNext(di)) != NULL) {
3911 sds keystr = dictGetEntryKey(de);
3912 robj key, *o = dictGetEntryVal(de);
3913 time_t expiretime;
3914
3915 initStaticStringObject(key,keystr);
3916 expiretime = getExpire(db,&key);
3917
3918 /* Save the expire time */
3919 if (expiretime != -1) {
3920 /* If this key is already expired skip it */
3921 if (expiretime < now) continue;
3922 if (rdbSaveType(fp,REDIS_EXPIRETIME) == -1) goto werr;
3923 if (rdbSaveTime(fp,expiretime) == -1) goto werr;
3924 }
3925 /* Save the key and associated value. This requires special
3926 * handling if the value is swapped out. */
3927 if (!server.vm_enabled || o->storage == REDIS_VM_MEMORY ||
3928 o->storage == REDIS_VM_SWAPPING) {
3929 /* Save type, key, value */
3930 if (rdbSaveType(fp,o->type) == -1) goto werr;
3931 if (rdbSaveStringObject(fp,&key) == -1) goto werr;
3932 if (rdbSaveObject(fp,o) == -1) goto werr;
3933 } else {
3934 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3935 robj *po;
3936 /* Get a preview of the object in memory */
3937 po = vmPreviewObject(o);
3938 /* Save type, key, value */
3939 if (rdbSaveType(fp,po->type) == -1) goto werr;
3940 if (rdbSaveStringObject(fp,&key) == -1) goto werr;
3941 if (rdbSaveObject(fp,po) == -1) goto werr;
3942 /* Remove the loaded object from memory */
3943 decrRefCount(po);
3944 }
3945 }
3946 dictReleaseIterator(di);
3947 }
3948 /* EOF opcode */
3949 if (rdbSaveType(fp,REDIS_EOF) == -1) goto werr;
3950
3951 /* Make sure data will not remain on the OS's output buffers */
3952 fflush(fp);
3953 fsync(fileno(fp));
3954 fclose(fp);
3955
3956 /* Use RENAME to make sure the DB file is changed atomically only
3957 * if the generate DB file is ok. */
3958 if (rename(tmpfile,filename) == -1) {
3959 redisLog(REDIS_WARNING,"Error moving temp DB file on the final destination: %s", strerror(errno));
3960 unlink(tmpfile);
3961 return REDIS_ERR;
3962 }
3963 redisLog(REDIS_NOTICE,"DB saved on disk");
3964 server.dirty = 0;
3965 server.lastsave = time(NULL);
3966 return REDIS_OK;
3967
3968 werr:
3969 fclose(fp);
3970 unlink(tmpfile);
3971 redisLog(REDIS_WARNING,"Write error saving DB on disk: %s", strerror(errno));
3972 if (di) dictReleaseIterator(di);
3973 return REDIS_ERR;
3974 }
3975
3976 static int rdbSaveBackground(char *filename) {
3977 pid_t childpid;
3978
3979 if (server.bgsavechildpid != -1) return REDIS_ERR;
3980 if (server.vm_enabled) waitEmptyIOJobsQueue();
3981 if ((childpid = fork()) == 0) {
3982 /* Child */
3983 if (server.vm_enabled) vmReopenSwapFile();
3984 close(server.fd);
3985 if (rdbSave(filename) == REDIS_OK) {
3986 _exit(0);
3987 } else {
3988 _exit(1);
3989 }
3990 } else {
3991 /* Parent */
3992 if (childpid == -1) {
3993 redisLog(REDIS_WARNING,"Can't save in background: fork: %s",
3994 strerror(errno));
3995 return REDIS_ERR;
3996 }
3997 redisLog(REDIS_NOTICE,"Background saving started by pid %d",childpid);
3998 server.bgsavechildpid = childpid;
3999 updateDictResizePolicy();
4000 return REDIS_OK;
4001 }
4002 return REDIS_OK; /* unreached */
4003 }
4004
4005 static void rdbRemoveTempFile(pid_t childpid) {
4006 char tmpfile[256];
4007
4008 snprintf(tmpfile,256,"temp-%d.rdb", (int) childpid);
4009 unlink(tmpfile);
4010 }
4011
4012 static int rdbLoadType(FILE *fp) {
4013 unsigned char type;
4014 if (fread(&type,1,1,fp) == 0) return -1;
4015 return type;
4016 }
4017
4018 static time_t rdbLoadTime(FILE *fp) {
4019 int32_t t32;
4020 if (fread(&t32,4,1,fp) == 0) return -1;
4021 return (time_t) t32;
4022 }
4023
4024 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
4025 * of this file for a description of how this are stored on disk.
4026 *
4027 * isencoded is set to 1 if the readed length is not actually a length but
4028 * an "encoding type", check the above comments for more info */
4029 static uint32_t rdbLoadLen(FILE *fp, int *isencoded) {
4030 unsigned char buf[2];
4031 uint32_t len;
4032 int type;
4033
4034 if (isencoded) *isencoded = 0;
4035 if (fread(buf,1,1,fp) == 0) return REDIS_RDB_LENERR;
4036 type = (buf[0]&0xC0)>>6;
4037 if (type == REDIS_RDB_6BITLEN) {
4038 /* Read a 6 bit len */
4039 return buf[0]&0x3F;
4040 } else if (type == REDIS_RDB_ENCVAL) {
4041 /* Read a 6 bit len encoding type */
4042 if (isencoded) *isencoded = 1;
4043 return buf[0]&0x3F;
4044 } else if (type == REDIS_RDB_14BITLEN) {
4045 /* Read a 14 bit len */
4046 if (fread(buf+1,1,1,fp) == 0) return REDIS_RDB_LENERR;
4047 return ((buf[0]&0x3F)<<8)|buf[1];
4048 } else {
4049 /* Read a 32 bit len */
4050 if (fread(&len,4,1,fp) == 0) return REDIS_RDB_LENERR;
4051 return ntohl(len);
4052 }
4053 }
4054
4055 /* Load an integer-encoded object from file 'fp', with the specified
4056 * encoding type 'enctype'. If encode is true the function may return
4057 * an integer-encoded object as reply, otherwise the returned object
4058 * will always be encoded as a raw string. */
4059 static robj *rdbLoadIntegerObject(FILE *fp, int enctype, int encode) {
4060 unsigned char enc[4];
4061 long long val;
4062
4063 if (enctype == REDIS_RDB_ENC_INT8) {
4064 if (fread(enc,1,1,fp) == 0) return NULL;
4065 val = (signed char)enc[0];
4066 } else if (enctype == REDIS_RDB_ENC_INT16) {
4067 uint16_t v;
4068 if (fread(enc,2,1,fp) == 0) return NULL;
4069 v = enc[0]|(enc[1]<<8);
4070 val = (int16_t)v;
4071 } else if (enctype == REDIS_RDB_ENC_INT32) {
4072 uint32_t v;
4073 if (fread(enc,4,1,fp) == 0) return NULL;
4074 v = enc[0]|(enc[1]<<8)|(enc[2]<<16)|(enc[3]<<24);
4075 val = (int32_t)v;
4076 } else {
4077 val = 0; /* anti-warning */
4078 redisPanic("Unknown RDB integer encoding type");
4079 }
4080 if (encode)
4081 return createStringObjectFromLongLong(val);
4082 else
4083 return createObject(REDIS_STRING,sdsfromlonglong(val));
4084 }
4085
4086 static robj *rdbLoadLzfStringObject(FILE*fp) {
4087 unsigned int len, clen;
4088 unsigned char *c = NULL;
4089 sds val = NULL;
4090
4091 if ((clen = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
4092 if ((len = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
4093 if ((c = zmalloc(clen)) == NULL) goto err;
4094 if ((val = sdsnewlen(NULL,len)) == NULL) goto err;
4095 if (fread(c,clen,1,fp) == 0) goto err;
4096 if (lzf_decompress(c,clen,val,len) == 0) goto err;
4097 zfree(c);
4098 return createObject(REDIS_STRING,val);
4099 err:
4100 zfree(c);
4101 sdsfree(val);
4102 return NULL;
4103 }
4104
4105 static robj *rdbGenericLoadStringObject(FILE*fp, int encode) {
4106 int isencoded;
4107 uint32_t len;
4108 sds val;
4109
4110 len = rdbLoadLen(fp,&isencoded);
4111 if (isencoded) {
4112 switch(len) {
4113 case REDIS_RDB_ENC_INT8:
4114 case REDIS_RDB_ENC_INT16:
4115 case REDIS_RDB_ENC_INT32:
4116 return rdbLoadIntegerObject(fp,len,encode);
4117 case REDIS_RDB_ENC_LZF:
4118 return rdbLoadLzfStringObject(fp);
4119 default:
4120 redisPanic("Unknown RDB encoding type");
4121 }
4122 }
4123
4124 if (len == REDIS_RDB_LENERR) return NULL;
4125 val = sdsnewlen(NULL,len);
4126 if (len && fread(val,len,1,fp) == 0) {
4127 sdsfree(val);
4128 return NULL;
4129 }
4130 return createObject(REDIS_STRING,val);
4131 }
4132
4133 static robj *rdbLoadStringObject(FILE *fp) {
4134 return rdbGenericLoadStringObject(fp,0);
4135 }
4136
4137 static robj *rdbLoadEncodedStringObject(FILE *fp) {
4138 return rdbGenericLoadStringObject(fp,1);
4139 }
4140
4141 /* For information about double serialization check rdbSaveDoubleValue() */
4142 static int rdbLoadDoubleValue(FILE *fp, double *val) {
4143 char buf[128];
4144 unsigned char len;
4145
4146 if (fread(&len,1,1,fp) == 0) return -1;
4147 switch(len) {
4148 case 255: *val = R_NegInf; return 0;
4149 case 254: *val = R_PosInf; return 0;
4150 case 253: *val = R_Nan; return 0;
4151 default:
4152 if (fread(buf,len,1,fp) == 0) return -1;
4153 buf[len] = '\0';
4154 sscanf(buf, "%lg", val);
4155 return 0;
4156 }
4157 }
4158
4159 /* Load a Redis object of the specified type from the specified file.
4160 * On success a newly allocated object is returned, otherwise NULL. */
4161 static robj *rdbLoadObject(int type, FILE *fp) {
4162 robj *o, *ele, *dec;
4163 size_t len;
4164
4165 redisLog(REDIS_DEBUG,"LOADING OBJECT %d (at %d)\n",type,ftell(fp));
4166 if (type == REDIS_STRING) {
4167 /* Read string value */
4168 if ((o = rdbLoadEncodedStringObject(fp)) == NULL) return NULL;
4169 o = tryObjectEncoding(o);
4170 } else if (type == REDIS_LIST) {
4171 /* Read list value */
4172 if ((len = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
4173
4174 /* Use a real list when there are too many entries */
4175 if (len > server.list_max_ziplist_entries) {
4176 o = createListObject();
4177 } else {
4178 o = createZiplistObject();
4179 }
4180
4181 /* Load every single element of the list */
4182 while(len--) {
4183 if ((ele = rdbLoadEncodedStringObject(fp)) == NULL) return NULL;
4184
4185 /* If we are using a ziplist and the value is too big, convert
4186 * the object to a real list. */
4187 if (o->encoding == REDIS_ENCODING_ZIPLIST &&
4188 ele->encoding == REDIS_ENCODING_RAW &&
4189 sdslen(ele->ptr) > server.list_max_ziplist_value)
4190 listTypeConvert(o,REDIS_ENCODING_LIST);
4191
4192 if (o->encoding == REDIS_ENCODING_ZIPLIST) {
4193 dec = getDecodedObject(ele);
4194 o->ptr = ziplistPush(o->ptr,dec->ptr,sdslen(dec->ptr),REDIS_TAIL);
4195 decrRefCount(dec);
4196 decrRefCount(ele);
4197 } else {
4198 ele = tryObjectEncoding(ele);
4199 listAddNodeTail(o->ptr,ele);
4200 }
4201 }
4202 } else if (type == REDIS_SET) {
4203 /* Read list/set value */
4204 if ((len = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
4205 o = createSetObject();
4206 /* It's faster to expand the dict to the right size asap in order
4207 * to avoid rehashing */
4208 if (len > DICT_HT_INITIAL_SIZE)
4209 dictExpand(o->ptr,len);
4210 /* Load every single element of the list/set */
4211 while(len--) {
4212 if ((ele = rdbLoadEncodedStringObject(fp)) == NULL) return NULL;
4213 ele = tryObjectEncoding(ele);
4214 dictAdd((dict*)o->ptr,ele,NULL);
4215 }
4216 } else if (type == REDIS_ZSET) {
4217 /* Read list/set value */
4218 size_t zsetlen;
4219 zset *zs;
4220
4221 if ((zsetlen = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
4222 o = createZsetObject();
4223 zs = o->ptr;
4224 /* Load every single element of the list/set */
4225 while(zsetlen--) {
4226 robj *ele;
4227 double *score = zmalloc(sizeof(double));
4228
4229 if ((ele = rdbLoadEncodedStringObject(fp)) == NULL) return NULL;
4230 ele = tryObjectEncoding(ele);
4231 if (rdbLoadDoubleValue(fp,score) == -1) return NULL;
4232 dictAdd(zs->dict,ele,score);
4233 zslInsert(zs->zsl,*score,ele);
4234 incrRefCount(ele); /* added to skiplist */
4235 }
4236 } else if (type == REDIS_HASH) {
4237 size_t hashlen;
4238
4239 if ((hashlen = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
4240 o = createHashObject();
4241 /* Too many entries? Use an hash table. */
4242 if (hashlen > server.hash_max_zipmap_entries)
4243 convertToRealHash(o);
4244 /* Load every key/value, then set it into the zipmap or hash
4245 * table, as needed. */
4246 while(hashlen--) {
4247 robj *key, *val;
4248
4249 if ((key = rdbLoadStringObject(fp)) == NULL) return NULL;
4250 if ((val = rdbLoadStringObject(fp)) == NULL) return NULL;
4251 /* If we are using a zipmap and there are too big values
4252 * the object is converted to real hash table encoding. */
4253 if (o->encoding != REDIS_ENCODING_HT &&
4254 (sdslen(key->ptr) > server.hash_max_zipmap_value ||
4255 sdslen(val->ptr) > server.hash_max_zipmap_value))
4256 {
4257 convertToRealHash(o);
4258 }
4259
4260 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
4261 unsigned char *zm = o->ptr;
4262
4263 zm = zipmapSet(zm,key->ptr,sdslen(key->ptr),
4264 val->ptr,sdslen(val->ptr),NULL);
4265 o->ptr = zm;
4266 decrRefCount(key);
4267 decrRefCount(val);
4268 } else {
4269 key = tryObjectEncoding(key);
4270 val = tryObjectEncoding(val);
4271 dictAdd((dict*)o->ptr,key,val);
4272 }
4273 }
4274 } else {
4275 redisPanic("Unknown object type");
4276 }
4277 return o;
4278 }
4279
4280 static int rdbLoad(char *filename) {
4281 FILE *fp;
4282 uint32_t dbid;
4283 int type, retval, rdbver;
4284 int swap_all_values = 0;
4285 redisDb *db = server.db+0;
4286 char buf[1024];
4287 time_t expiretime, now = time(NULL);
4288
4289 fp = fopen(filename,"r");
4290 if (!fp) return REDIS_ERR;
4291 if (fread(buf,9,1,fp) == 0) goto eoferr;
4292 buf[9] = '\0';
4293 if (memcmp(buf,"REDIS",5) != 0) {
4294 fclose(fp);
4295 redisLog(REDIS_WARNING,"Wrong signature trying to load DB from file");
4296 return REDIS_ERR;
4297 }
4298 rdbver = atoi(buf+5);
4299 if (rdbver != 1) {
4300 fclose(fp);
4301 redisLog(REDIS_WARNING,"Can't handle RDB format version %d",rdbver);
4302 return REDIS_ERR;
4303 }
4304 while(1) {
4305 robj *key, *val;
4306 int force_swapout;
4307
4308 expiretime = -1;
4309 /* Read type. */
4310 if ((type = rdbLoadType(fp)) == -1) goto eoferr;
4311 if (type == REDIS_EXPIRETIME) {
4312 if ((expiretime = rdbLoadTime(fp)) == -1) goto eoferr;
4313 /* We read the time so we need to read the object type again */
4314 if ((type = rdbLoadType(fp)) == -1) goto eoferr;
4315 }
4316 if (type == REDIS_EOF) break;
4317 /* Handle SELECT DB opcode as a special case */
4318 if (type == REDIS_SELECTDB) {
4319 if ((dbid = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR)
4320 goto eoferr;
4321 if (dbid >= (unsigned)server.dbnum) {
4322 redisLog(REDIS_WARNING,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server.dbnum);
4323 exit(1);
4324 }
4325 db = server.db+dbid;
4326 continue;
4327 }
4328 /* Read key */
4329 if ((key = rdbLoadStringObject(fp)) == NULL) goto eoferr;
4330 /* Read value */
4331 if ((val = rdbLoadObject(type,fp)) == NULL) goto eoferr;
4332 /* Check if the key already expired */
4333 if (expiretime != -1 && expiretime < now) {
4334 decrRefCount(key);
4335 decrRefCount(val);
4336 continue;
4337 }
4338 /* Add the new object in the hash table */
4339 retval = dbAdd(db,key,val);
4340 if (retval == REDIS_ERR) {
4341 redisLog(REDIS_WARNING,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", key->ptr);
4342 exit(1);
4343 }
4344 /* Set the expire time if needed */
4345 if (expiretime != -1) setExpire(db,key,expiretime);
4346
4347 /* Handle swapping while loading big datasets when VM is on */
4348
4349 /* If we detecter we are hopeless about fitting something in memory
4350 * we just swap every new key on disk. Directly...
4351 * Note that's important to check for this condition before resorting
4352 * to random sampling, otherwise we may try to swap already
4353 * swapped keys. */
4354 if (swap_all_values) {
4355 dictEntry *de = dictFind(db->dict,key->ptr);
4356
4357 /* de may be NULL since the key already expired */
4358 if (de) {
4359 vmpointer *vp;
4360 val = dictGetEntryVal(de);
4361
4362 if (val->refcount == 1 &&
4363 (vp = vmSwapObjectBlocking(val)) != NULL)
4364 dictGetEntryVal(de) = vp;
4365 }
4366 decrRefCount(key);
4367 continue;
4368 }
4369 decrRefCount(key);
4370
4371 /* Flush data on disk once 32 MB of additional RAM are used... */
4372 force_swapout = 0;
4373 if ((zmalloc_used_memory() - server.vm_max_memory) > 1024*1024*32)
4374 force_swapout = 1;
4375
4376 /* If we have still some hope of having some value fitting memory
4377 * then we try random sampling. */
4378 if (!swap_all_values && server.vm_enabled && force_swapout) {
4379 while (zmalloc_used_memory() > server.vm_max_memory) {
4380 if (vmSwapOneObjectBlocking() == REDIS_ERR) break;
4381 }
4382 if (zmalloc_used_memory() > server.vm_max_memory)
4383 swap_all_values = 1; /* We are already using too much mem */
4384 }
4385 }
4386 fclose(fp);
4387 return REDIS_OK;
4388
4389 eoferr: /* unexpected end of file is handled here with a fatal exit */
4390 redisLog(REDIS_WARNING,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
4391 exit(1);
4392 return REDIS_ERR; /* Just to avoid warning */
4393 }
4394
4395 /*================================== Shutdown =============================== */
4396 static int prepareForShutdown() {
4397 redisLog(REDIS_WARNING,"User requested shutdown, saving DB...");
4398 /* Kill the saving child if there is a background saving in progress.
4399 We want to avoid race conditions, for instance our saving child may
4400 overwrite the synchronous saving did by SHUTDOWN. */
4401 if (server.bgsavechildpid != -1) {
4402 redisLog(REDIS_WARNING,"There is a live saving child. Killing it!");
4403 kill(server.bgsavechildpid,SIGKILL);
4404 rdbRemoveTempFile(server.bgsavechildpid);
4405 }
4406 if (server.appendonly) {
4407 /* Append only file: fsync() the AOF and exit */
4408 aof_fsync(server.appendfd);
4409 if (server.vm_enabled) unlink(server.vm_swap_file);
4410 } else {
4411 /* Snapshotting. Perform a SYNC SAVE and exit */
4412 if (rdbSave(server.dbfilename) == REDIS_OK) {
4413 if (server.daemonize)
4414 unlink(server.pidfile);
4415 redisLog(REDIS_WARNING,"%zu bytes used at exit",zmalloc_used_memory());
4416 } else {
4417 /* Ooops.. error saving! The best we can do is to continue
4418 * operating. Note that if there was a background saving process,
4419 * in the next cron() Redis will be notified that the background
4420 * saving aborted, handling special stuff like slaves pending for
4421 * synchronization... */
4422 redisLog(REDIS_WARNING,"Error trying to save the DB, can't exit");
4423 return REDIS_ERR;
4424 }
4425 }
4426 redisLog(REDIS_WARNING,"Server exit now, bye bye...");
4427 return REDIS_OK;
4428 }
4429
4430 /*================================== Commands =============================== */
4431
4432 static void authCommand(redisClient *c) {
4433 if (!server.requirepass || !strcmp(c->argv[1]->ptr, server.requirepass)) {
4434 c->authenticated = 1;
4435 addReply(c,shared.ok);
4436 } else {
4437 c->authenticated = 0;
4438 addReplySds(c,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
4439 }
4440 }
4441
4442 static void pingCommand(redisClient *c) {
4443 addReply(c,shared.pong);
4444 }
4445
4446 static void echoCommand(redisClient *c) {
4447 addReplyBulk(c,c->argv[1]);
4448 }
4449
4450 /*=================================== Strings =============================== */
4451
4452 static void setGenericCommand(redisClient *c, int nx, robj *key, robj *val, robj *expire) {
4453 int retval;
4454 long seconds = 0; /* initialized to avoid an harmness warning */
4455
4456 if (expire) {
4457 if (getLongFromObjectOrReply(c, expire, &seconds, NULL) != REDIS_OK)
4458 return;
4459 if (seconds <= 0) {
4460 addReplySds(c,sdsnew("-ERR invalid expire time in SETEX\r\n"));
4461 return;
4462 }
4463 }
4464
4465 touchWatchedKey(c->db,key);
4466 if (nx) deleteIfVolatile(c->db,key);
4467 retval = dbAdd(c->db,key,val);
4468 if (retval == REDIS_ERR) {
4469 if (!nx) {
4470 dbReplace(c->db,key,val);
4471 incrRefCount(val);
4472 } else {
4473 addReply(c,shared.czero);
4474 return;
4475 }
4476 } else {
4477 incrRefCount(val);
4478 }
4479 server.dirty++;
4480 removeExpire(c->db,key);
4481 if (expire) setExpire(c->db,key,time(NULL)+seconds);
4482 addReply(c, nx ? shared.cone : shared.ok);
4483 }
4484
4485 static void setCommand(redisClient *c) {
4486 setGenericCommand(c,0,c->argv[1],c->argv[2],NULL);
4487 }
4488
4489 static void setnxCommand(redisClient *c) {
4490 setGenericCommand(c,1,c->argv[1],c->argv[2],NULL);
4491 }
4492
4493 static void setexCommand(redisClient *c) {
4494 setGenericCommand(c,0,c->argv[1],c->argv[3],c->argv[2]);
4495 }
4496
4497 static int getGenericCommand(redisClient *c) {
4498 robj *o;
4499
4500 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL)
4501 return REDIS_OK;
4502
4503 if (o->type != REDIS_STRING) {
4504 addReply(c,shared.wrongtypeerr);
4505 return REDIS_ERR;
4506 } else {
4507 addReplyBulk(c,o);
4508 return REDIS_OK;
4509 }
4510 }
4511
4512 static void getCommand(redisClient *c) {
4513 getGenericCommand(c);
4514 }
4515
4516 static void getsetCommand(redisClient *c) {
4517 if (getGenericCommand(c) == REDIS_ERR) return;
4518 dbReplace(c->db,c->argv[1],c->argv[2]);
4519 incrRefCount(c->argv[2]);
4520 server.dirty++;
4521 removeExpire(c->db,c->argv[1]);
4522 }
4523
4524 static void mgetCommand(redisClient *c) {
4525 int j;
4526
4527 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",c->argc-1));
4528 for (j = 1; j < c->argc; j++) {
4529 robj *o = lookupKeyRead(c->db,c->argv[j]);
4530 if (o == NULL) {
4531 addReply(c,shared.nullbulk);
4532 } else {
4533 if (o->type != REDIS_STRING) {
4534 addReply(c,shared.nullbulk);
4535 } else {
4536 addReplyBulk(c,o);
4537 }
4538 }
4539 }
4540 }
4541
4542 static void msetGenericCommand(redisClient *c, int nx) {
4543 int j, busykeys = 0;
4544
4545 if ((c->argc % 2) == 0) {
4546 addReplySds(c,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
4547 return;
4548 }
4549 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
4550 * set nothing at all if at least one already key exists. */
4551 if (nx) {
4552 for (j = 1; j < c->argc; j += 2) {
4553 if (lookupKeyWrite(c->db,c->argv[j]) != NULL) {
4554 busykeys++;
4555 }
4556 }
4557 }
4558 if (busykeys) {
4559 addReply(c, shared.czero);
4560 return;
4561 }
4562
4563 for (j = 1; j < c->argc; j += 2) {
4564 c->argv[j+1] = tryObjectEncoding(c->argv[j+1]);
4565 dbReplace(c->db,c->argv[j],c->argv[j+1]);
4566 incrRefCount(c->argv[j+1]);
4567 removeExpire(c->db,c->argv[j]);
4568 }
4569 server.dirty += (c->argc-1)/2;
4570 addReply(c, nx ? shared.cone : shared.ok);
4571 }
4572
4573 static void msetCommand(redisClient *c) {
4574 msetGenericCommand(c,0);
4575 }
4576
4577 static void msetnxCommand(redisClient *c) {
4578 msetGenericCommand(c,1);
4579 }
4580
4581 static void incrDecrCommand(redisClient *c, long long incr) {
4582 long long value;
4583 robj *o;
4584
4585 o = lookupKeyWrite(c->db,c->argv[1]);
4586 if (o != NULL && checkType(c,o,REDIS_STRING)) return;
4587 if (getLongLongFromObjectOrReply(c,o,&value,NULL) != REDIS_OK) return;
4588
4589 value += incr;
4590 o = createStringObjectFromLongLong(value);
4591 dbReplace(c->db,c->argv[1],o);
4592 server.dirty++;
4593 addReply(c,shared.colon);
4594 addReply(c,o);
4595 addReply(c,shared.crlf);
4596 }
4597
4598 static void incrCommand(redisClient *c) {
4599 incrDecrCommand(c,1);
4600 }
4601
4602 static void decrCommand(redisClient *c) {
4603 incrDecrCommand(c,-1);
4604 }
4605
4606 static void incrbyCommand(redisClient *c) {
4607 long long incr;
4608
4609 if (getLongLongFromObjectOrReply(c, c->argv[2], &incr, NULL) != REDIS_OK) return;
4610 incrDecrCommand(c,incr);
4611 }
4612
4613 static void decrbyCommand(redisClient *c) {
4614 long long incr;
4615
4616 if (getLongLongFromObjectOrReply(c, c->argv[2], &incr, NULL) != REDIS_OK) return;
4617 incrDecrCommand(c,-incr);
4618 }
4619
4620 static void appendCommand(redisClient *c) {
4621 int retval;
4622 size_t totlen;
4623 robj *o;
4624
4625 o = lookupKeyWrite(c->db,c->argv[1]);
4626 if (o == NULL) {
4627 /* Create the key */
4628 retval = dbAdd(c->db,c->argv[1],c->argv[2]);
4629 incrRefCount(c->argv[2]);
4630 totlen = stringObjectLen(c->argv[2]);
4631 } else {
4632 if (o->type != REDIS_STRING) {
4633 addReply(c,shared.wrongtypeerr);
4634 return;
4635 }
4636 /* If the object is specially encoded or shared we have to make
4637 * a copy */
4638 if (o->refcount != 1 || o->encoding != REDIS_ENCODING_RAW) {
4639 robj *decoded = getDecodedObject(o);
4640
4641 o = createStringObject(decoded->ptr, sdslen(decoded->ptr));
4642 decrRefCount(decoded);
4643 dbReplace(c->db,c->argv[1],o);
4644 }
4645 /* APPEND! */
4646 if (c->argv[2]->encoding == REDIS_ENCODING_RAW) {
4647 o->ptr = sdscatlen(o->ptr,
4648 c->argv[2]->ptr, sdslen(c->argv[2]->ptr));
4649 } else {
4650 o->ptr = sdscatprintf(o->ptr, "%ld",
4651 (unsigned long) c->argv[2]->ptr);
4652 }
4653 totlen = sdslen(o->ptr);
4654 }
4655 server.dirty++;
4656 addReplySds(c,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen));
4657 }
4658
4659 static void substrCommand(redisClient *c) {
4660 robj *o;
4661 long start = atoi(c->argv[2]->ptr);
4662 long end = atoi(c->argv[3]->ptr);
4663 size_t rangelen, strlen;
4664 sds range;
4665
4666 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
4667 checkType(c,o,REDIS_STRING)) return;
4668
4669 o = getDecodedObject(o);
4670 strlen = sdslen(o->ptr);
4671
4672 /* convert negative indexes */
4673 if (start < 0) start = strlen+start;
4674 if (end < 0) end = strlen+end;
4675 if (start < 0) start = 0;
4676 if (end < 0) end = 0;
4677
4678 /* indexes sanity checks */
4679 if (start > end || (size_t)start >= strlen) {
4680 /* Out of range start or start > end result in null reply */
4681 addReply(c,shared.nullbulk);
4682 decrRefCount(o);
4683 return;
4684 }
4685 if ((size_t)end >= strlen) end = strlen-1;
4686 rangelen = (end-start)+1;
4687
4688 /* Return the result */
4689 addReplySds(c,sdscatprintf(sdsempty(),"$%zu\r\n",rangelen));
4690 range = sdsnewlen((char*)o->ptr+start,rangelen);
4691 addReplySds(c,range);
4692 addReply(c,shared.crlf);
4693 decrRefCount(o);
4694 }
4695
4696 /* ========================= Type agnostic commands ========================= */
4697
4698 static void delCommand(redisClient *c) {
4699 int deleted = 0, j;
4700
4701 for (j = 1; j < c->argc; j++) {
4702 if (dbDelete(c->db,c->argv[j])) {
4703 touchWatchedKey(c->db,c->argv[j]);
4704 server.dirty++;
4705 deleted++;
4706 }
4707 }
4708 addReplyLongLong(c,deleted);
4709 }
4710
4711 static void existsCommand(redisClient *c) {
4712 expireIfNeeded(c->db,c->argv[1]);
4713 if (dbExists(c->db,c->argv[1])) {
4714 addReply(c, shared.cone);
4715 } else {
4716 addReply(c, shared.czero);
4717 }
4718 }
4719
4720 static void selectCommand(redisClient *c) {
4721 int id = atoi(c->argv[1]->ptr);
4722
4723 if (selectDb(c,id) == REDIS_ERR) {
4724 addReplySds(c,sdsnew("-ERR invalid DB index\r\n"));
4725 } else {
4726 addReply(c,shared.ok);
4727 }
4728 }
4729
4730 static void randomkeyCommand(redisClient *c) {
4731 robj *key;
4732
4733 if ((key = dbRandomKey(c->db)) == NULL) {
4734 addReply(c,shared.nullbulk);
4735 return;
4736 }
4737
4738 addReplyBulk(c,key);
4739 decrRefCount(key);
4740 }
4741
4742 static void keysCommand(redisClient *c) {
4743 dictIterator *di;
4744 dictEntry *de;
4745 sds pattern = c->argv[1]->ptr;
4746 int plen = sdslen(pattern);
4747 unsigned long numkeys = 0;
4748 robj *lenobj = createObject(REDIS_STRING,NULL);
4749
4750 di = dictGetIterator(c->db->dict);
4751 addReply(c,lenobj);
4752 decrRefCount(lenobj);
4753 while((de = dictNext(di)) != NULL) {
4754 sds key = dictGetEntryKey(de);
4755 robj *keyobj;
4756
4757 if ((pattern[0] == '*' && pattern[1] == '\0') ||
4758 stringmatchlen(pattern,plen,key,sdslen(key),0)) {
4759 keyobj = createStringObject(key,sdslen(key));
4760 if (expireIfNeeded(c->db,keyobj) == 0) {
4761 addReplyBulk(c,keyobj);
4762 numkeys++;
4763 }
4764 decrRefCount(keyobj);
4765 }
4766 }
4767 dictReleaseIterator(di);
4768 lenobj->ptr = sdscatprintf(sdsempty(),"*%lu\r\n",numkeys);
4769 }
4770
4771 static void dbsizeCommand(redisClient *c) {
4772 addReplySds(c,
4773 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c->db->dict)));
4774 }
4775
4776 static void lastsaveCommand(redisClient *c) {
4777 addReplySds(c,
4778 sdscatprintf(sdsempty(),":%lu\r\n",server.lastsave));
4779 }
4780
4781 static void typeCommand(redisClient *c) {
4782 robj *o;
4783 char *type;
4784
4785 o = lookupKeyRead(c->db,c->argv[1]);
4786 if (o == NULL) {
4787 type = "+none";
4788 } else {
4789 switch(o->type) {
4790 case REDIS_STRING: type = "+string"; break;
4791 case REDIS_LIST: type = "+list"; break;
4792 case REDIS_SET: type = "+set"; break;
4793 case REDIS_ZSET: type = "+zset"; break;
4794 case REDIS_HASH: type = "+hash"; break;
4795 default: type = "+unknown"; break;
4796 }
4797 }
4798 addReplySds(c,sdsnew(type));
4799 addReply(c,shared.crlf);
4800 }
4801
4802 static void saveCommand(redisClient *c) {
4803 if (server.bgsavechildpid != -1) {
4804 addReplySds(c,sdsnew("-ERR background save in progress\r\n"));
4805 return;
4806 }
4807 if (rdbSave(server.dbfilename) == REDIS_OK) {
4808 addReply(c,shared.ok);
4809 } else {
4810 addReply(c,shared.err);
4811 }
4812 }
4813
4814 static void bgsaveCommand(redisClient *c) {
4815 if (server.bgsavechildpid != -1) {
4816 addReplySds(c,sdsnew("-ERR background save already in progress\r\n"));
4817 return;
4818 }
4819 if (rdbSaveBackground(server.dbfilename) == REDIS_OK) {
4820 char *status = "+Background saving started\r\n";
4821 addReplySds(c,sdsnew(status));
4822 } else {
4823 addReply(c,shared.err);
4824 }
4825 }
4826
4827 static void shutdownCommand(redisClient *c) {
4828 if (prepareForShutdown() == REDIS_OK)
4829 exit(0);
4830 addReplySds(c, sdsnew("-ERR Errors trying to SHUTDOWN. Check logs.\r\n"));
4831 }
4832
4833 static void renameGenericCommand(redisClient *c, int nx) {
4834 robj *o;
4835
4836 /* To use the same key as src and dst is probably an error */
4837 if (sdscmp(c->argv[1]->ptr,c->argv[2]->ptr) == 0) {
4838 addReply(c,shared.sameobjecterr);
4839 return;
4840 }
4841
4842 if ((o = lookupKeyWriteOrReply(c,c->argv[1],shared.nokeyerr)) == NULL)
4843 return;
4844
4845 incrRefCount(o);
4846 deleteIfVolatile(c->db,c->argv[2]);
4847 if (dbAdd(c->db,c->argv[2],o) == REDIS_ERR) {
4848 if (nx) {
4849 decrRefCount(o);
4850 addReply(c,shared.czero);
4851 return;
4852 }
4853 dbReplace(c->db,c->argv[2],o);
4854 }
4855 dbDelete(c->db,c->argv[1]);
4856 touchWatchedKey(c->db,c->argv[2]);
4857 server.dirty++;
4858 addReply(c,nx ? shared.cone : shared.ok);
4859 }
4860
4861 static void renameCommand(redisClient *c) {
4862 renameGenericCommand(c,0);
4863 }
4864
4865 static void renamenxCommand(redisClient *c) {
4866 renameGenericCommand(c,1);
4867 }
4868
4869 static void moveCommand(redisClient *c) {
4870 robj *o;
4871 redisDb *src, *dst;
4872 int srcid;
4873
4874 /* Obtain source and target DB pointers */
4875 src = c->db;
4876 srcid = c->db->id;
4877 if (selectDb(c,atoi(c->argv[2]->ptr)) == REDIS_ERR) {
4878 addReply(c,shared.outofrangeerr);
4879 return;
4880 }
4881 dst = c->db;
4882 selectDb(c,srcid); /* Back to the source DB */
4883
4884 /* If the user is moving using as target the same
4885 * DB as the source DB it is probably an error. */
4886 if (src == dst) {
4887 addReply(c,shared.sameobjecterr);
4888 return;
4889 }
4890
4891 /* Check if the element exists and get a reference */
4892 o = lookupKeyWrite(c->db,c->argv[1]);
4893 if (!o) {
4894 addReply(c,shared.czero);
4895 return;
4896 }
4897
4898 /* Try to add the element to the target DB */
4899 deleteIfVolatile(dst,c->argv[1]);
4900 if (dbAdd(dst,c->argv[1],o) == REDIS_ERR) {
4901 addReply(c,shared.czero);
4902 return;
4903 }
4904 incrRefCount(o);
4905
4906 /* OK! key moved, free the entry in the source DB */
4907 dbDelete(src,c->argv[1]);
4908 server.dirty++;
4909 addReply(c,shared.cone);
4910 }
4911
4912 /* =================================== Lists ================================ */
4913
4914
4915 /* Check the argument length to see if it requires us to convert the ziplist
4916 * to a real list. Only check raw-encoded objects because integer encoded
4917 * objects are never too long. */
4918 static void listTypeTryConversion(robj *subject, robj *value) {
4919 if (subject->encoding != REDIS_ENCODING_ZIPLIST) return;
4920 if (value->encoding == REDIS_ENCODING_RAW &&
4921 sdslen(value->ptr) > server.list_max_ziplist_value)
4922 listTypeConvert(subject,REDIS_ENCODING_LIST);
4923 }
4924
4925 static void listTypePush(robj *subject, robj *value, int where) {
4926 /* Check if we need to convert the ziplist */
4927 listTypeTryConversion(subject,value);
4928 if (subject->encoding == REDIS_ENCODING_ZIPLIST &&
4929 ziplistLen(subject->ptr) > server.list_max_ziplist_entries)
4930 listTypeConvert(subject,REDIS_ENCODING_LIST);
4931
4932 if (subject->encoding == REDIS_ENCODING_ZIPLIST) {
4933 int pos = (where == REDIS_HEAD) ? ZIPLIST_HEAD : ZIPLIST_TAIL;
4934 value = getDecodedObject(value);
4935 subject->ptr = ziplistPush(subject->ptr,value->ptr,sdslen(value->ptr),pos);
4936 decrRefCount(value);
4937 } else if (subject->encoding == REDIS_ENCODING_LIST) {
4938 if (where == REDIS_HEAD) {
4939 listAddNodeHead(subject->ptr,value);
4940 } else {
4941 listAddNodeTail(subject->ptr,value);
4942 }
4943 incrRefCount(value);
4944 } else {
4945 redisPanic("Unknown list encoding");
4946 }
4947 }
4948
4949 static robj *listTypePop(robj *subject, int where) {
4950 robj *value = NULL;
4951 if (subject->encoding == REDIS_ENCODING_ZIPLIST) {
4952 unsigned char *p;
4953 unsigned char *vstr;
4954 unsigned int vlen;
4955 long long vlong;
4956 int pos = (where == REDIS_HEAD) ? 0 : -1;
4957 p = ziplistIndex(subject->ptr,pos);
4958 if (ziplistGet(p,&vstr,&vlen,&vlong)) {
4959 if (vstr) {
4960 value = createStringObject((char*)vstr,vlen);
4961 } else {
4962 value = createStringObjectFromLongLong(vlong);
4963 }
4964 /* We only need to delete an element when it exists */
4965 subject->ptr = ziplistDelete(subject->ptr,&p);
4966 }
4967 } else if (subject->encoding == REDIS_ENCODING_LIST) {
4968 list *list = subject->ptr;
4969 listNode *ln;
4970 if (where == REDIS_HEAD) {
4971 ln = listFirst(list);
4972 } else {
4973 ln = listLast(list);
4974 }
4975 if (ln != NULL) {
4976 value = listNodeValue(ln);
4977 incrRefCount(value);
4978 listDelNode(list,ln);
4979 }
4980 } else {
4981 redisPanic("Unknown list encoding");
4982 }
4983 return value;
4984 }
4985
4986 static unsigned long listTypeLength(robj *subject) {
4987 if (subject->encoding == REDIS_ENCODING_ZIPLIST) {
4988 return ziplistLen(subject->ptr);
4989 } else if (subject->encoding == REDIS_ENCODING_LIST) {
4990 return listLength((list*)subject->ptr);
4991 } else {
4992 redisPanic("Unknown list encoding");
4993 }
4994 }
4995
4996 /* Structure to hold set iteration abstraction. */
4997 typedef struct {
4998 robj *subject;
4999 unsigned char encoding;
5000 unsigned char direction; /* Iteration direction */
5001 unsigned char *zi;
5002 listNode *ln;
5003 } listTypeIterator;
5004
5005 /* Structure for an entry while iterating over a list. */
5006 typedef struct {
5007 listTypeIterator *li;
5008 unsigned char *zi; /* Entry in ziplist */
5009 listNode *ln; /* Entry in linked list */
5010 } listTypeEntry;
5011
5012 /* Initialize an iterator at the specified index. */
5013 static listTypeIterator *listTypeInitIterator(robj *subject, int index, unsigned char direction) {
5014 listTypeIterator *li = zmalloc(sizeof(listTypeIterator));
5015 li->subject = subject;
5016 li->encoding = subject->encoding;
5017 li->direction = direction;
5018 if (li->encoding == REDIS_ENCODING_ZIPLIST) {
5019 li->zi = ziplistIndex(subject->ptr,index);
5020 } else if (li->encoding == REDIS_ENCODING_LIST) {
5021 li->ln = listIndex(subject->ptr,index);
5022 } else {
5023 redisPanic("Unknown list encoding");
5024 }
5025 return li;
5026 }
5027
5028 /* Clean up the iterator. */
5029 static void listTypeReleaseIterator(listTypeIterator *li) {
5030 zfree(li);
5031 }
5032
5033 /* Stores pointer to current the entry in the provided entry structure
5034 * and advances the position of the iterator. Returns 1 when the current
5035 * entry is in fact an entry, 0 otherwise. */
5036 static int listTypeNext(listTypeIterator *li, listTypeEntry *entry) {
5037 /* Protect from converting when iterating */
5038 redisAssert(li->subject->encoding == li->encoding);
5039
5040 entry->li = li;
5041 if (li->encoding == REDIS_ENCODING_ZIPLIST) {
5042 entry->zi = li->zi;
5043 if (entry->zi != NULL) {
5044 if (li->direction == REDIS_TAIL)
5045 li->zi = ziplistNext(li->subject->ptr,li->zi);
5046 else
5047 li->zi = ziplistPrev(li->subject->ptr,li->zi);
5048 return 1;
5049 }
5050 } else if (li->encoding == REDIS_ENCODING_LIST) {
5051 entry->ln = li->ln;
5052 if (entry->ln != NULL) {
5053 if (li->direction == REDIS_TAIL)
5054 li->ln = li->ln->next;
5055 else
5056 li->ln = li->ln->prev;
5057 return 1;
5058 }
5059 } else {
5060 redisPanic("Unknown list encoding");
5061 }
5062 return 0;
5063 }
5064
5065 /* Return entry or NULL at the current position of the iterator. */
5066 static robj *listTypeGet(listTypeEntry *entry) {
5067 listTypeIterator *li = entry->li;
5068 robj *value = NULL;
5069 if (li->encoding == REDIS_ENCODING_ZIPLIST) {
5070 unsigned char *vstr;
5071 unsigned int vlen;
5072 long long vlong;
5073 redisAssert(entry->zi != NULL);
5074 if (ziplistGet(entry->zi,&vstr,&vlen,&vlong)) {
5075 if (vstr) {
5076 value = createStringObject((char*)vstr,vlen);
5077 } else {
5078 value = createStringObjectFromLongLong(vlong);
5079 }
5080 }
5081 } else if (li->encoding == REDIS_ENCODING_LIST) {
5082 redisAssert(entry->ln != NULL);
5083 value = listNodeValue(entry->ln);
5084 incrRefCount(value);
5085 } else {
5086 redisPanic("Unknown list encoding");
5087 }
5088 return value;
5089 }
5090
5091 static void listTypeInsert(listTypeEntry *entry, robj *value, int where) {
5092 robj *subject = entry->li->subject;
5093 if (entry->li->encoding == REDIS_ENCODING_ZIPLIST) {
5094 if (where == REDIS_TAIL) {
5095 unsigned char *next = ziplistNext(subject->ptr,entry->zi);
5096
5097 /* When we insert after the current element, but the current element
5098 * is the tail of the list, we need to do a push. */
5099 if (next == NULL) {
5100 subject->ptr = ziplistPush(subject->ptr,value->ptr,sdslen(value->ptr),REDIS_TAIL);
5101 } else {
5102 subject->ptr = ziplistInsert(subject->ptr,next,value->ptr,sdslen(value->ptr));
5103 }
5104 } else {
5105 subject->ptr = ziplistInsert(subject->ptr,entry->zi,value->ptr,sdslen(value->ptr));
5106 }
5107 } else if (entry->li->encoding == REDIS_ENCODING_LIST) {
5108 if (where == REDIS_TAIL) {
5109 listInsertNode(subject->ptr,entry->ln,value,AL_START_TAIL);
5110 } else {
5111 listInsertNode(subject->ptr,entry->ln,value,AL_START_HEAD);
5112 }
5113 incrRefCount(value);
5114 } else {
5115 redisPanic("Unknown list encoding");
5116 }
5117 }
5118
5119 /* Compare the given object with the entry at the current position. */
5120 static int listTypeEqual(listTypeEntry *entry, robj *o) {
5121 listTypeIterator *li = entry->li;
5122 if (li->encoding == REDIS_ENCODING_ZIPLIST) {
5123 redisAssert(o->encoding == REDIS_ENCODING_RAW);
5124 return ziplistCompare(entry->zi,o->ptr,sdslen(o->ptr));
5125 } else if (li->encoding == REDIS_ENCODING_LIST) {
5126 return equalStringObjects(o,listNodeValue(entry->ln));
5127 } else {
5128 redisPanic("Unknown list encoding");
5129 }
5130 }
5131
5132 /* Delete the element pointed to. */
5133 static void listTypeDelete(listTypeEntry *entry) {
5134 listTypeIterator *li = entry->li;
5135 if (li->encoding == REDIS_ENCODING_ZIPLIST) {
5136 unsigned char *p = entry->zi;
5137 li->subject->ptr = ziplistDelete(li->subject->ptr,&p);
5138
5139 /* Update position of the iterator depending on the direction */
5140 if (li->direction == REDIS_TAIL)
5141 li->zi = p;
5142 else
5143 li->zi = ziplistPrev(li->subject->ptr,p);
5144 } else if (entry->li->encoding == REDIS_ENCODING_LIST) {
5145 listNode *next;
5146 if (li->direction == REDIS_TAIL)
5147 next = entry->ln->next;
5148 else
5149 next = entry->ln->prev;
5150 listDelNode(li->subject->ptr,entry->ln);
5151 li->ln = next;
5152 } else {
5153 redisPanic("Unknown list encoding");
5154 }
5155 }
5156
5157 static void listTypeConvert(robj *subject, int enc) {
5158 listTypeIterator *li;
5159 listTypeEntry entry;
5160 redisAssert(subject->type == REDIS_LIST);
5161
5162 if (enc == REDIS_ENCODING_LIST) {
5163 list *l = listCreate();
5164 listSetFreeMethod(l,decrRefCount);
5165
5166 /* listTypeGet returns a robj with incremented refcount */
5167 li = listTypeInitIterator(subject,0,REDIS_TAIL);
5168 while (listTypeNext(li,&entry)) listAddNodeTail(l,listTypeGet(&entry));
5169 listTypeReleaseIterator(li);
5170
5171 subject->encoding = REDIS_ENCODING_LIST;
5172 zfree(subject->ptr);
5173 subject->ptr = l;
5174 } else {
5175 redisPanic("Unsupported list conversion");
5176 }
5177 }
5178
5179 static void pushGenericCommand(redisClient *c, int where) {
5180 robj *lobj = lookupKeyWrite(c->db,c->argv[1]);
5181 if (lobj == NULL) {
5182 if (handleClientsWaitingListPush(c,c->argv[1],c->argv[2])) {
5183 addReply(c,shared.cone);
5184 return;
5185 }
5186 lobj = createZiplistObject();
5187 dbAdd(c->db,c->argv[1],lobj);
5188 } else {
5189 if (lobj->type != REDIS_LIST) {
5190 addReply(c,shared.wrongtypeerr);
5191 return;
5192 }
5193 if (handleClientsWaitingListPush(c,c->argv[1],c->argv[2])) {
5194 addReply(c,shared.cone);
5195 return;
5196 }
5197 }
5198 listTypePush(lobj,c->argv[2],where);
5199 addReplyLongLong(c,listTypeLength(lobj));
5200 server.dirty++;
5201 }
5202
5203 static void lpushCommand(redisClient *c) {
5204 pushGenericCommand(c,REDIS_HEAD);
5205 }
5206
5207 static void rpushCommand(redisClient *c) {
5208 pushGenericCommand(c,REDIS_TAIL);
5209 }
5210
5211 static void pushxGenericCommand(redisClient *c, robj *refval, robj *val, int where) {
5212 robj *subject;
5213 listTypeIterator *iter;
5214 listTypeEntry entry;
5215
5216 if ((subject = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
5217 checkType(c,subject,REDIS_LIST)) return;
5218 if (handleClientsWaitingListPush(c,c->argv[1],val)) {
5219 addReply(c,shared.cone);
5220 return;
5221 }
5222
5223 if (refval != NULL) {
5224 /* Note: we expect refval to be string-encoded because it is *not* the
5225 * last argument of the multi-bulk LINSERT. */
5226 redisAssert(refval->encoding == REDIS_ENCODING_RAW);
5227
5228 /* Seek refval from head to tail */
5229 iter = listTypeInitIterator(subject,0,REDIS_TAIL);
5230 while (listTypeNext(iter,&entry)) {
5231 if (listTypeEqual(&entry,refval)) {
5232 listTypeInsert(&entry,val,where);
5233 break;
5234 }
5235 }
5236 listTypeReleaseIterator(iter);
5237 } else {
5238 listTypePush(subject,val,where);
5239 }
5240
5241 server.dirty++;
5242 addReplyUlong(c,listTypeLength(subject));
5243 }
5244
5245 static void lpushxCommand(redisClient *c) {
5246 pushxGenericCommand(c,NULL,c->argv[2],REDIS_HEAD);
5247 }
5248
5249 static void rpushxCommand(redisClient *c) {
5250 pushxGenericCommand(c,NULL,c->argv[2],REDIS_TAIL);
5251 }
5252
5253 static void linsertCommand(redisClient *c) {
5254 if (strcasecmp(c->argv[2]->ptr,"after") == 0) {
5255 pushxGenericCommand(c,c->argv[3],c->argv[4],REDIS_TAIL);
5256 } else if (strcasecmp(c->argv[2]->ptr,"before") == 0) {
5257 pushxGenericCommand(c,c->argv[3],c->argv[4],REDIS_HEAD);
5258 } else {
5259 addReply(c,shared.syntaxerr);
5260 }
5261 }
5262
5263 static void llenCommand(redisClient *c) {
5264 robj *o = lookupKeyReadOrReply(c,c->argv[1],shared.czero);
5265 if (o == NULL || checkType(c,o,REDIS_LIST)) return;
5266 addReplyUlong(c,listTypeLength(o));
5267 }
5268
5269 static void lindexCommand(redisClient *c) {
5270 robj *o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk);
5271 if (o == NULL || checkType(c,o,REDIS_LIST)) return;
5272 int index = atoi(c->argv[2]->ptr);
5273 robj *value = NULL;
5274
5275 if (o->encoding == REDIS_ENCODING_ZIPLIST) {
5276 unsigned char *p;
5277 unsigned char *vstr;
5278 unsigned int vlen;
5279 long long vlong;
5280 p = ziplistIndex(o->ptr,index);
5281 if (ziplistGet(p,&vstr,&vlen,&vlong)) {
5282 if (vstr) {
5283 value = createStringObject((char*)vstr,vlen);
5284 } else {
5285 value = createStringObjectFromLongLong(vlong);
5286 }
5287 addReplyBulk(c,value);
5288 decrRefCount(value);
5289 } else {
5290 addReply(c,shared.nullbulk);
5291 }
5292 } else if (o->encoding == REDIS_ENCODING_LIST) {
5293 listNode *ln = listIndex(o->ptr,index);
5294 if (ln != NULL) {
5295 value = listNodeValue(ln);
5296 addReplyBulk(c,value);
5297 } else {
5298 addReply(c,shared.nullbulk);
5299 }
5300 } else {
5301 redisPanic("Unknown list encoding");
5302 }
5303 }
5304
5305 static void lsetCommand(redisClient *c) {
5306 robj *o = lookupKeyWriteOrReply(c,c->argv[1],shared.nokeyerr);
5307 if (o == NULL || checkType(c,o,REDIS_LIST)) return;
5308 int index = atoi(c->argv[2]->ptr);
5309 robj *value = c->argv[3];
5310
5311 listTypeTryConversion(o,value);
5312 if (o->encoding == REDIS_ENCODING_ZIPLIST) {
5313 unsigned char *p, *zl = o->ptr;
5314 p = ziplistIndex(zl,index);
5315 if (p == NULL) {
5316 addReply(c,shared.outofrangeerr);
5317 } else {
5318 o->ptr = ziplistDelete(o->ptr,&p);
5319 value = getDecodedObject(value);
5320 o->ptr = ziplistInsert(o->ptr,p,value->ptr,sdslen(value->ptr));
5321 decrRefCount(value);
5322 addReply(c,shared.ok);
5323 server.dirty++;
5324 }
5325 } else if (o->encoding == REDIS_ENCODING_LIST) {
5326 listNode *ln = listIndex(o->ptr,index);
5327 if (ln == NULL) {
5328 addReply(c,shared.outofrangeerr);
5329 } else {
5330 decrRefCount((robj*)listNodeValue(ln));
5331 listNodeValue(ln) = value;
5332 incrRefCount(value);
5333 addReply(c,shared.ok);
5334 server.dirty++;
5335 }
5336 } else {
5337 redisPanic("Unknown list encoding");
5338 }
5339 }
5340
5341 static void popGenericCommand(redisClient *c, int where) {
5342 robj *o = lookupKeyWriteOrReply(c,c->argv[1],shared.nullbulk);
5343 if (o == NULL || checkType(c,o,REDIS_LIST)) return;
5344
5345 robj *value = listTypePop(o,where);
5346 if (value == NULL) {
5347 addReply(c,shared.nullbulk);
5348 } else {
5349 addReplyBulk(c,value);
5350 decrRefCount(value);
5351 if (listTypeLength(o) == 0) dbDelete(c->db,c->argv[1]);
5352 server.dirty++;
5353 }
5354 }
5355
5356 static void lpopCommand(redisClient *c) {
5357 popGenericCommand(c,REDIS_HEAD);
5358 }
5359
5360 static void rpopCommand(redisClient *c) {
5361 popGenericCommand(c,REDIS_TAIL);
5362 }
5363
5364 static void lrangeCommand(redisClient *c) {
5365 robj *o, *value;
5366 int start = atoi(c->argv[2]->ptr);
5367 int end = atoi(c->argv[3]->ptr);
5368 int llen;
5369 int rangelen, j;
5370 listTypeEntry entry;
5371
5372 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.emptymultibulk)) == NULL
5373 || checkType(c,o,REDIS_LIST)) return;
5374 llen = listTypeLength(o);
5375
5376 /* convert negative indexes */
5377 if (start < 0) start = llen+start;
5378 if (end < 0) end = llen+end;
5379 if (start < 0) start = 0;
5380 if (end < 0) end = 0;
5381
5382 /* indexes sanity checks */
5383 if (start > end || start >= llen) {
5384 /* Out of range start or start > end result in empty list */
5385 addReply(c,shared.emptymultibulk);
5386 return;
5387 }
5388 if (end >= llen) end = llen-1;
5389 rangelen = (end-start)+1;
5390
5391 /* Return the result in form of a multi-bulk reply */
5392 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",rangelen));
5393 listTypeIterator *li = listTypeInitIterator(o,start,REDIS_TAIL);
5394 for (j = 0; j < rangelen; j++) {
5395 redisAssert(listTypeNext(li,&entry));
5396 value = listTypeGet(&entry);
5397 addReplyBulk(c,value);
5398 decrRefCount(value);
5399 }
5400 listTypeReleaseIterator(li);
5401 }
5402
5403 static void ltrimCommand(redisClient *c) {
5404 robj *o;
5405 int start = atoi(c->argv[2]->ptr);
5406 int end = atoi(c->argv[3]->ptr);
5407 int llen;
5408 int j, ltrim, rtrim;
5409 list *list;
5410 listNode *ln;
5411
5412 if ((o = lookupKeyWriteOrReply(c,c->argv[1],shared.ok)) == NULL ||
5413 checkType(c,o,REDIS_LIST)) return;
5414 llen = listTypeLength(o);
5415
5416 /* convert negative indexes */
5417 if (start < 0) start = llen+start;
5418 if (end < 0) end = llen+end;
5419 if (start < 0) start = 0;
5420 if (end < 0) end = 0;
5421
5422 /* indexes sanity checks */
5423 if (start > end || start >= llen) {
5424 /* Out of range start or start > end result in empty list */
5425 ltrim = llen;
5426 rtrim = 0;
5427 } else {
5428 if (end >= llen) end = llen-1;
5429 ltrim = start;
5430 rtrim = llen-end-1;
5431 }
5432
5433 /* Remove list elements to perform the trim */
5434 if (o->encoding == REDIS_ENCODING_ZIPLIST) {
5435 o->ptr = ziplistDeleteRange(o->ptr,0,ltrim);
5436 o->ptr = ziplistDeleteRange(o->ptr,-rtrim,rtrim);
5437 } else if (o->encoding == REDIS_ENCODING_LIST) {
5438 list = o->ptr;
5439 for (j = 0; j < ltrim; j++) {
5440 ln = listFirst(list);
5441 listDelNode(list,ln);
5442 }
5443 for (j = 0; j < rtrim; j++) {
5444 ln = listLast(list);
5445 listDelNode(list,ln);
5446 }
5447 } else {
5448 redisPanic("Unknown list encoding");
5449 }
5450 if (listTypeLength(o) == 0) dbDelete(c->db,c->argv[1]);
5451 server.dirty++;
5452 addReply(c,shared.ok);
5453 }
5454
5455 static void lremCommand(redisClient *c) {
5456 robj *subject, *obj = c->argv[3];
5457 int toremove = atoi(c->argv[2]->ptr);
5458 int removed = 0;
5459 listTypeEntry entry;
5460
5461 subject = lookupKeyWriteOrReply(c,c->argv[1],shared.czero);
5462 if (subject == NULL || checkType(c,subject,REDIS_LIST)) return;
5463
5464 /* Make sure obj is raw when we're dealing with a ziplist */
5465 if (subject->encoding == REDIS_ENCODING_ZIPLIST)
5466 obj = getDecodedObject(obj);
5467
5468 listTypeIterator *li;
5469 if (toremove < 0) {
5470 toremove = -toremove;
5471 li = listTypeInitIterator(subject,-1,REDIS_HEAD);
5472 } else {
5473 li = listTypeInitIterator(subject,0,REDIS_TAIL);
5474 }
5475
5476 while (listTypeNext(li,&entry)) {
5477 if (listTypeEqual(&entry,obj)) {
5478 listTypeDelete(&entry);
5479 server.dirty++;
5480 removed++;
5481 if (toremove && removed == toremove) break;
5482 }
5483 }
5484 listTypeReleaseIterator(li);
5485
5486 /* Clean up raw encoded object */
5487 if (subject->encoding == REDIS_ENCODING_ZIPLIST)
5488 decrRefCount(obj);
5489
5490 if (listTypeLength(subject) == 0) dbDelete(c->db,c->argv[1]);
5491 addReplySds(c,sdscatprintf(sdsempty(),":%d\r\n",removed));
5492 }
5493
5494 /* This is the semantic of this command:
5495 * RPOPLPUSH srclist dstlist:
5496 * IF LLEN(srclist) > 0
5497 * element = RPOP srclist
5498 * LPUSH dstlist element
5499 * RETURN element
5500 * ELSE
5501 * RETURN nil
5502 * END
5503 * END
5504 *
5505 * The idea is to be able to get an element from a list in a reliable way
5506 * since the element is not just returned but pushed against another list
5507 * as well. This command was originally proposed by Ezra Zygmuntowicz.
5508 */
5509 static void rpoplpushcommand(redisClient *c) {
5510 robj *sobj, *value;
5511 if ((sobj = lookupKeyWriteOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
5512 checkType(c,sobj,REDIS_LIST)) return;
5513
5514 if (listTypeLength(sobj) == 0) {
5515 addReply(c,shared.nullbulk);
5516 } else {
5517 robj *dobj = lookupKeyWrite(c->db,c->argv[2]);
5518 if (dobj && checkType(c,dobj,REDIS_LIST)) return;
5519 value = listTypePop(sobj,REDIS_TAIL);
5520
5521 /* Add the element to the target list (unless it's directly
5522 * passed to some BLPOP-ing client */
5523 if (!handleClientsWaitingListPush(c,c->argv[2],value)) {
5524 /* Create the list if the key does not exist */
5525 if (!dobj) {
5526 dobj = createZiplistObject();
5527 dbAdd(c->db,c->argv[2],dobj);
5528 }
5529 listTypePush(dobj,value,REDIS_HEAD);
5530 }
5531
5532 /* Send the element to the client as reply as well */
5533 addReplyBulk(c,value);
5534
5535 /* listTypePop returns an object with its refcount incremented */
5536 decrRefCount(value);
5537
5538 /* Delete the source list when it is empty */
5539 if (listTypeLength(sobj) == 0) dbDelete(c->db,c->argv[1]);
5540 server.dirty++;
5541 }
5542 }
5543
5544 /* ==================================== Sets ================================ */
5545
5546 static void saddCommand(redisClient *c) {
5547 robj *set;
5548
5549 set = lookupKeyWrite(c->db,c->argv[1]);
5550 if (set == NULL) {
5551 set = createSetObject();
5552 dbAdd(c->db,c->argv[1],set);
5553 } else {
5554 if (set->type != REDIS_SET) {
5555 addReply(c,shared.wrongtypeerr);
5556 return;
5557 }
5558 }
5559 if (dictAdd(set->ptr,c->argv[2],NULL) == DICT_OK) {
5560 incrRefCount(c->argv[2]);
5561 server.dirty++;
5562 addReply(c,shared.cone);
5563 } else {
5564 addReply(c,shared.czero);
5565 }
5566 }
5567
5568 static void sremCommand(redisClient *c) {
5569 robj *set;
5570
5571 if ((set = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
5572 checkType(c,set,REDIS_SET)) return;
5573
5574 if (dictDelete(set->ptr,c->argv[2]) == DICT_OK) {
5575 server.dirty++;
5576 if (htNeedsResize(set->ptr)) dictResize(set->ptr);
5577 if (dictSize((dict*)set->ptr) == 0) dbDelete(c->db,c->argv[1]);
5578 addReply(c,shared.cone);
5579 } else {
5580 addReply(c,shared.czero);
5581 }
5582 }
5583
5584 static void smoveCommand(redisClient *c) {
5585 robj *srcset, *dstset;
5586
5587 srcset = lookupKeyWrite(c->db,c->argv[1]);
5588 dstset = lookupKeyWrite(c->db,c->argv[2]);
5589
5590 /* If the source key does not exist return 0, if it's of the wrong type
5591 * raise an error */
5592 if (srcset == NULL || srcset->type != REDIS_SET) {
5593 addReply(c, srcset ? shared.wrongtypeerr : shared.czero);
5594 return;
5595 }
5596 /* Error if the destination key is not a set as well */
5597 if (dstset && dstset->type != REDIS_SET) {
5598 addReply(c,shared.wrongtypeerr);
5599 return;
5600 }
5601 /* Remove the element from the source set */
5602 if (dictDelete(srcset->ptr,c->argv[3]) == DICT_ERR) {
5603 /* Key not found in the src set! return zero */
5604 addReply(c,shared.czero);
5605 return;
5606 }
5607 if (dictSize((dict*)srcset->ptr) == 0 && srcset != dstset)
5608 dbDelete(c->db,c->argv[1]);
5609 server.dirty++;
5610 /* Add the element to the destination set */
5611 if (!dstset) {
5612 dstset = createSetObject();
5613 dbAdd(c->db,c->argv[2],dstset);
5614 }
5615 if (dictAdd(dstset->ptr,c->argv[3],NULL) == DICT_OK)
5616 incrRefCount(c->argv[3]);
5617 addReply(c,shared.cone);
5618 }
5619
5620 static void sismemberCommand(redisClient *c) {
5621 robj *set;
5622
5623 if ((set = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
5624 checkType(c,set,REDIS_SET)) return;
5625
5626 if (dictFind(set->ptr,c->argv[2]))
5627 addReply(c,shared.cone);
5628 else
5629 addReply(c,shared.czero);
5630 }
5631
5632 static void scardCommand(redisClient *c) {
5633 robj *o;
5634 dict *s;
5635
5636 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
5637 checkType(c,o,REDIS_SET)) return;
5638
5639 s = o->ptr;
5640 addReplyUlong(c,dictSize(s));
5641 }
5642
5643 static void spopCommand(redisClient *c) {
5644 robj *set;
5645 dictEntry *de;
5646
5647 if ((set = lookupKeyWriteOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
5648 checkType(c,set,REDIS_SET)) return;
5649
5650 de = dictGetRandomKey(set->ptr);
5651 if (de == NULL) {
5652 addReply(c,shared.nullbulk);
5653 } else {
5654 robj *ele = dictGetEntryKey(de);
5655
5656 addReplyBulk(c,ele);
5657 dictDelete(set->ptr,ele);
5658 if (htNeedsResize(set->ptr)) dictResize(set->ptr);
5659 if (dictSize((dict*)set->ptr) == 0) dbDelete(c->db,c->argv[1]);
5660 server.dirty++;
5661 }
5662 }
5663
5664 static void srandmemberCommand(redisClient *c) {
5665 robj *set;
5666 dictEntry *de;
5667
5668 if ((set = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
5669 checkType(c,set,REDIS_SET)) return;
5670
5671 de = dictGetRandomKey(set->ptr);
5672 if (de == NULL) {
5673 addReply(c,shared.nullbulk);
5674 } else {
5675 robj *ele = dictGetEntryKey(de);
5676
5677 addReplyBulk(c,ele);
5678 }
5679 }
5680
5681 static int qsortCompareSetsByCardinality(const void *s1, const void *s2) {
5682 dict **d1 = (void*) s1, **d2 = (void*) s2;
5683
5684 return dictSize(*d1)-dictSize(*d2);
5685 }
5686
5687 static void sinterGenericCommand(redisClient *c, robj **setskeys, unsigned long setsnum, robj *dstkey) {
5688 dict **dv = zmalloc(sizeof(dict*)*setsnum);
5689 dictIterator *di;
5690 dictEntry *de;
5691 robj *lenobj = NULL, *dstset = NULL;
5692 unsigned long j, cardinality = 0;
5693
5694 for (j = 0; j < setsnum; j++) {
5695 robj *setobj;
5696
5697 setobj = dstkey ?
5698 lookupKeyWrite(c->db,setskeys[j]) :
5699 lookupKeyRead(c->db,setskeys[j]);
5700 if (!setobj) {
5701 zfree(dv);
5702 if (dstkey) {
5703 if (dbDelete(c->db,dstkey))
5704 server.dirty++;
5705 addReply(c,shared.czero);
5706 } else {
5707 addReply(c,shared.emptymultibulk);
5708 }
5709 return;
5710 }
5711 if (setobj->type != REDIS_SET) {
5712 zfree(dv);
5713 addReply(c,shared.wrongtypeerr);
5714 return;
5715 }
5716 dv[j] = setobj->ptr;
5717 }
5718 /* Sort sets from the smallest to largest, this will improve our
5719 * algorithm's performace */
5720 qsort(dv,setsnum,sizeof(dict*),qsortCompareSetsByCardinality);
5721
5722 /* The first thing we should output is the total number of elements...
5723 * since this is a multi-bulk write, but at this stage we don't know
5724 * the intersection set size, so we use a trick, append an empty object
5725 * to the output list and save the pointer to later modify it with the
5726 * right length */
5727 if (!dstkey) {
5728 lenobj = createObject(REDIS_STRING,NULL);
5729 addReply(c,lenobj);
5730 decrRefCount(lenobj);
5731 } else {
5732 /* If we have a target key where to store the resulting set
5733 * create this key with an empty set inside */
5734 dstset = createSetObject();
5735 }
5736
5737 /* Iterate all the elements of the first (smallest) set, and test
5738 * the element against all the other sets, if at least one set does
5739 * not include the element it is discarded */
5740 di = dictGetIterator(dv[0]);
5741
5742 while((de = dictNext(di)) != NULL) {
5743 robj *ele;
5744
5745 for (j = 1; j < setsnum; j++)
5746 if (dictFind(dv[j],dictGetEntryKey(de)) == NULL) break;
5747 if (j != setsnum)
5748 continue; /* at least one set does not contain the member */
5749 ele = dictGetEntryKey(de);
5750 if (!dstkey) {
5751 addReplyBulk(c,ele);
5752 cardinality++;
5753 } else {
5754 dictAdd(dstset->ptr,ele,NULL);
5755 incrRefCount(ele);
5756 }
5757 }
5758 dictReleaseIterator(di);
5759
5760 if (dstkey) {
5761 /* Store the resulting set into the target, if the intersection
5762 * is not an empty set. */
5763 dbDelete(c->db,dstkey);
5764 if (dictSize((dict*)dstset->ptr) > 0) {
5765 dbAdd(c->db,dstkey,dstset);
5766 addReplyLongLong(c,dictSize((dict*)dstset->ptr));
5767 } else {
5768 decrRefCount(dstset);
5769 addReply(c,shared.czero);
5770 }
5771 server.dirty++;
5772 } else {
5773 lenobj->ptr = sdscatprintf(sdsempty(),"*%lu\r\n",cardinality);
5774 }
5775 zfree(dv);
5776 }
5777
5778 static void sinterCommand(redisClient *c) {
5779 sinterGenericCommand(c,c->argv+1,c->argc-1,NULL);
5780 }
5781
5782 static void sinterstoreCommand(redisClient *c) {
5783 sinterGenericCommand(c,c->argv+2,c->argc-2,c->argv[1]);
5784 }
5785
5786 #define REDIS_OP_UNION 0
5787 #define REDIS_OP_DIFF 1
5788 #define REDIS_OP_INTER 2
5789
5790 static void sunionDiffGenericCommand(redisClient *c, robj **setskeys, int setsnum, robj *dstkey, int op) {
5791 dict **dv = zmalloc(sizeof(dict*)*setsnum);
5792 dictIterator *di;
5793 dictEntry *de;
5794 robj *dstset = NULL;
5795 int j, cardinality = 0;
5796
5797 for (j = 0; j < setsnum; j++) {
5798 robj *setobj;
5799
5800 setobj = dstkey ?
5801 lookupKeyWrite(c->db,setskeys[j]) :
5802 lookupKeyRead(c->db,setskeys[j]);
5803 if (!setobj) {
5804 dv[j] = NULL;
5805 continue;
5806 }
5807 if (setobj->type != REDIS_SET) {
5808 zfree(dv);
5809 addReply(c,shared.wrongtypeerr);
5810 return;
5811 }
5812 dv[j] = setobj->ptr;
5813 }
5814
5815 /* We need a temp set object to store our union. If the dstkey
5816 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
5817 * this set object will be the resulting object to set into the target key*/
5818 dstset = createSetObject();
5819
5820 /* Iterate all the elements of all the sets, add every element a single
5821 * time to the result set */
5822 for (j = 0; j < setsnum; j++) {
5823 if (op == REDIS_OP_DIFF && j == 0 && !dv[j]) break; /* result set is empty */
5824 if (!dv[j]) continue; /* non existing keys are like empty sets */
5825
5826 di = dictGetIterator(dv[j]);
5827
5828 while((de = dictNext(di)) != NULL) {
5829 robj *ele;
5830
5831 /* dictAdd will not add the same element multiple times */
5832 ele = dictGetEntryKey(de);
5833 if (op == REDIS_OP_UNION || j == 0) {
5834 if (dictAdd(dstset->ptr,ele,NULL) == DICT_OK) {
5835 incrRefCount(ele);
5836 cardinality++;
5837 }
5838 } else if (op == REDIS_OP_DIFF) {
5839 if (dictDelete(dstset->ptr,ele) == DICT_OK) {
5840 cardinality--;
5841 }
5842 }
5843 }
5844 dictReleaseIterator(di);
5845
5846 /* result set is empty? Exit asap. */
5847 if (op == REDIS_OP_DIFF && cardinality == 0) break;
5848 }
5849
5850 /* Output the content of the resulting set, if not in STORE mode */
5851 if (!dstkey) {
5852 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",cardinality));
5853 di = dictGetIterator(dstset->ptr);
5854 while((de = dictNext(di)) != NULL) {
5855 robj *ele;
5856
5857 ele = dictGetEntryKey(de);
5858 addReplyBulk(c,ele);
5859 }
5860 dictReleaseIterator(di);
5861 decrRefCount(dstset);
5862 } else {
5863 /* If we have a target key where to store the resulting set
5864 * create this key with the result set inside */
5865 dbDelete(c->db,dstkey);
5866 if (dictSize((dict*)dstset->ptr) > 0) {
5867 dbAdd(c->db,dstkey,dstset);
5868 addReplyLongLong(c,dictSize((dict*)dstset->ptr));
5869 } else {
5870 decrRefCount(dstset);
5871 addReply(c,shared.czero);
5872 }
5873 server.dirty++;
5874 }
5875 zfree(dv);
5876 }
5877
5878 static void sunionCommand(redisClient *c) {
5879 sunionDiffGenericCommand(c,c->argv+1,c->argc-1,NULL,REDIS_OP_UNION);
5880 }
5881
5882 static void sunionstoreCommand(redisClient *c) {
5883 sunionDiffGenericCommand(c,c->argv+2,c->argc-2,c->argv[1],REDIS_OP_UNION);
5884 }
5885
5886 static void sdiffCommand(redisClient *c) {
5887 sunionDiffGenericCommand(c,c->argv+1,c->argc-1,NULL,REDIS_OP_DIFF);
5888 }
5889
5890 static void sdiffstoreCommand(redisClient *c) {
5891 sunionDiffGenericCommand(c,c->argv+2,c->argc-2,c->argv[1],REDIS_OP_DIFF);
5892 }
5893
5894 /* ==================================== ZSets =============================== */
5895
5896 /* ZSETs are ordered sets using two data structures to hold the same elements
5897 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
5898 * data structure.
5899 *
5900 * The elements are added to an hash table mapping Redis objects to scores.
5901 * At the same time the elements are added to a skip list mapping scores
5902 * to Redis objects (so objects are sorted by scores in this "view"). */
5903
5904 /* This skiplist implementation is almost a C translation of the original
5905 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
5906 * Alternative to Balanced Trees", modified in three ways:
5907 * a) this implementation allows for repeated values.
5908 * b) the comparison is not just by key (our 'score') but by satellite data.
5909 * c) there is a back pointer, so it's a doubly linked list with the back
5910 * pointers being only at "level 1". This allows to traverse the list
5911 * from tail to head, useful for ZREVRANGE. */
5912
5913 static zskiplistNode *zslCreateNode(int level, double score, robj *obj) {
5914 zskiplistNode *zn = zmalloc(sizeof(*zn));
5915
5916 zn->forward = zmalloc(sizeof(zskiplistNode*) * level);
5917 if (level > 1)
5918 zn->span = zmalloc(sizeof(unsigned int) * (level - 1));
5919 else
5920 zn->span = NULL;
5921 zn->score = score;
5922 zn->obj = obj;
5923 return zn;
5924 }
5925
5926 static zskiplist *zslCreate(void) {
5927 int j;
5928 zskiplist *zsl;
5929
5930 zsl = zmalloc(sizeof(*zsl));
5931 zsl->level = 1;
5932 zsl->length = 0;
5933 zsl->header = zslCreateNode(ZSKIPLIST_MAXLEVEL,0,NULL);
5934 for (j = 0; j < ZSKIPLIST_MAXLEVEL; j++) {
5935 zsl->header->forward[j] = NULL;
5936
5937 /* span has space for ZSKIPLIST_MAXLEVEL-1 elements */
5938 if (j < ZSKIPLIST_MAXLEVEL-1)
5939 zsl->header->span[j] = 0;
5940 }
5941 zsl->header->backward = NULL;
5942 zsl->tail = NULL;
5943 return zsl;
5944 }
5945
5946 static void zslFreeNode(zskiplistNode *node) {
5947 decrRefCount(node->obj);
5948 zfree(node->forward);
5949 zfree(node->span);
5950 zfree(node);
5951 }
5952
5953 static void zslFree(zskiplist *zsl) {
5954 zskiplistNode *node = zsl->header->forward[0], *next;
5955
5956 zfree(zsl->header->forward);
5957 zfree(zsl->header->span);
5958 zfree(zsl->header);
5959 while(node) {
5960 next = node->forward[0];
5961 zslFreeNode(node);
5962 node = next;
5963 }
5964 zfree(zsl);
5965 }
5966
5967 static int zslRandomLevel(void) {
5968 int level = 1;
5969 while ((random()&0xFFFF) < (ZSKIPLIST_P * 0xFFFF))
5970 level += 1;
5971 return (level<ZSKIPLIST_MAXLEVEL) ? level : ZSKIPLIST_MAXLEVEL;
5972 }
5973
5974 static void zslInsert(zskiplist *zsl, double score, robj *obj) {
5975 zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;
5976 unsigned int rank[ZSKIPLIST_MAXLEVEL];
5977 int i, level;
5978
5979 x = zsl->header;
5980 for (i = zsl->level-1; i >= 0; i--) {
5981 /* store rank that is crossed to reach the insert position */
5982 rank[i] = i == (zsl->level-1) ? 0 : rank[i+1];
5983
5984 while (x->forward[i] &&
5985 (x->forward[i]->score < score ||
5986 (x->forward[i]->score == score &&
5987 compareStringObjects(x->forward[i]->obj,obj) < 0))) {
5988 rank[i] += i > 0 ? x->span[i-1] : 1;
5989 x = x->forward[i];
5990 }
5991 update[i] = x;
5992 }
5993 /* we assume the key is not already inside, since we allow duplicated
5994 * scores, and the re-insertion of score and redis object should never
5995 * happpen since the caller of zslInsert() should test in the hash table
5996 * if the element is already inside or not. */
5997 level = zslRandomLevel();
5998 if (level > zsl->level) {
5999 for (i = zsl->level; i < level; i++) {
6000 rank[i] = 0;
6001 update[i] = zsl->header;
6002 update[i]->span[i-1] = zsl->length;
6003 }
6004 zsl->level = level;
6005 }
6006 x = zslCreateNode(level,score,obj);
6007 for (i = 0; i < level; i++) {
6008 x->forward[i] = update[i]->forward[i];
6009 update[i]->forward[i] = x;
6010
6011 /* update span covered by update[i] as x is inserted here */
6012 if (i > 0) {
6013 x->span[i-1] = update[i]->span[i-1] - (rank[0] - rank[i]);
6014 update[i]->span[i-1] = (rank[0] - rank[i]) + 1;
6015 }
6016 }
6017
6018 /* increment span for untouched levels */
6019 for (i = level; i < zsl->level; i++) {
6020 update[i]->span[i-1]++;
6021 }
6022
6023 x->backward = (update[0] == zsl->header) ? NULL : update[0];
6024 if (x->forward[0])
6025 x->forward[0]->backward = x;
6026 else
6027 zsl->tail = x;
6028 zsl->length++;
6029 }
6030
6031 /* Internal function used by zslDelete, zslDeleteByScore and zslDeleteByRank */
6032 void zslDeleteNode(zskiplist *zsl, zskiplistNode *x, zskiplistNode **update) {
6033 int i;
6034 for (i = 0; i < zsl->level; i++) {
6035 if (update[i]->forward[i] == x) {
6036 if (i > 0) {
6037 update[i]->span[i-1] += x->span[i-1] - 1;
6038 }
6039 update[i]->forward[i] = x->forward[i];
6040 } else {
6041 /* invariant: i > 0, because update[0]->forward[0]
6042 * is always equal to x */
6043 update[i]->span[i-1] -= 1;
6044 }
6045 }
6046 if (x->forward[0]) {
6047 x->forward[0]->backward = x->backward;
6048 } else {
6049 zsl->tail = x->backward;
6050 }
6051 while(zsl->level > 1 && zsl->header->forward[zsl->level-1] == NULL)
6052 zsl->level--;
6053 zsl->length--;
6054 }
6055
6056 /* Delete an element with matching score/object from the skiplist. */
6057 static int zslDelete(zskiplist *zsl, double score, robj *obj) {
6058 zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;
6059 int i;
6060
6061 x = zsl->header;
6062 for (i = zsl->level-1; i >= 0; i--) {
6063 while (x->forward[i] &&
6064 (x->forward[i]->score < score ||
6065 (x->forward[i]->score == score &&
6066 compareStringObjects(x->forward[i]->obj,obj) < 0)))
6067 x = x->forward[i];
6068 update[i] = x;
6069 }
6070 /* We may have multiple elements with the same score, what we need
6071 * is to find the element with both the right score and object. */
6072 x = x->forward[0];
6073 if (x && score == x->score && equalStringObjects(x->obj,obj)) {
6074 zslDeleteNode(zsl, x, update);
6075 zslFreeNode(x);
6076 return 1;
6077 } else {
6078 return 0; /* not found */
6079 }
6080 return 0; /* not found */
6081 }
6082
6083 /* Delete all the elements with score between min and max from the skiplist.
6084 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
6085 * Note that this function takes the reference to the hash table view of the
6086 * sorted set, in order to remove the elements from the hash table too. */
6087 static unsigned long zslDeleteRangeByScore(zskiplist *zsl, double min, double max, dict *dict) {
6088 zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;
6089 unsigned long removed = 0;
6090 int i;
6091
6092 x = zsl->header;
6093 for (i = zsl->level-1; i >= 0; i--) {
6094 while (x->forward[i] && x->forward[i]->score < min)
6095 x = x->forward[i];
6096 update[i] = x;
6097 }
6098 /* We may have multiple elements with the same score, what we need
6099 * is to find the element with both the right score and object. */
6100 x = x->forward[0];
6101 while (x && x->score <= max) {
6102 zskiplistNode *next = x->forward[0];
6103 zslDeleteNode(zsl, x, update);
6104 dictDelete(dict,x->obj);
6105 zslFreeNode(x);
6106 removed++;
6107 x = next;
6108 }
6109 return removed; /* not found */
6110 }
6111
6112 /* Delete all the elements with rank between start and end from the skiplist.
6113 * Start and end are inclusive. Note that start and end need to be 1-based */
6114 static unsigned long zslDeleteRangeByRank(zskiplist *zsl, unsigned int start, unsigned int end, dict *dict) {
6115 zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;
6116 unsigned long traversed = 0, removed = 0;
6117 int i;
6118
6119 x = zsl->header;
6120 for (i = zsl->level-1; i >= 0; i--) {
6121 while (x->forward[i] && (traversed + (i > 0 ? x->span[i-1] : 1)) < start) {
6122 traversed += i > 0 ? x->span[i-1] : 1;
6123 x = x->forward[i];
6124 }
6125 update[i] = x;
6126 }
6127
6128 traversed++;
6129 x = x->forward[0];
6130 while (x && traversed <= end) {
6131 zskiplistNode *next = x->forward[0];
6132 zslDeleteNode(zsl, x, update);
6133 dictDelete(dict,x->obj);
6134 zslFreeNode(x);
6135 removed++;
6136 traversed++;
6137 x = next;
6138 }
6139 return removed;
6140 }
6141
6142 /* Find the first node having a score equal or greater than the specified one.
6143 * Returns NULL if there is no match. */
6144 static zskiplistNode *zslFirstWithScore(zskiplist *zsl, double score) {
6145 zskiplistNode *x;
6146 int i;
6147
6148 x = zsl->header;
6149 for (i = zsl->level-1; i >= 0; i--) {
6150 while (x->forward[i] && x->forward[i]->score < score)
6151 x = x->forward[i];
6152 }
6153 /* We may have multiple elements with the same score, what we need
6154 * is to find the element with both the right score and object. */
6155 return x->forward[0];
6156 }
6157
6158 /* Find the rank for an element by both score and key.
6159 * Returns 0 when the element cannot be found, rank otherwise.
6160 * Note that the rank is 1-based due to the span of zsl->header to the
6161 * first element. */
6162 static unsigned long zslistTypeGetRank(zskiplist *zsl, double score, robj *o) {
6163 zskiplistNode *x;
6164 unsigned long rank = 0;
6165 int i;
6166
6167 x = zsl->header;
6168 for (i = zsl->level-1; i >= 0; i--) {
6169 while (x->forward[i] &&
6170 (x->forward[i]->score < score ||
6171 (x->forward[i]->score == score &&
6172 compareStringObjects(x->forward[i]->obj,o) <= 0))) {
6173 rank += i > 0 ? x->span[i-1] : 1;
6174 x = x->forward[i];
6175 }
6176
6177 /* x might be equal to zsl->header, so test if obj is non-NULL */
6178 if (x->obj && equalStringObjects(x->obj,o)) {
6179 return rank;
6180 }
6181 }
6182 return 0;
6183 }
6184
6185 /* Finds an element by its rank. The rank argument needs to be 1-based. */
6186 zskiplistNode* zslistTypeGetElementByRank(zskiplist *zsl, unsigned long rank) {
6187 zskiplistNode *x;
6188 unsigned long traversed = 0;
6189 int i;
6190
6191 x = zsl->header;
6192 for (i = zsl->level-1; i >= 0; i--) {
6193 while (x->forward[i] && (traversed + (i>0 ? x->span[i-1] : 1)) <= rank)
6194 {
6195 traversed += i > 0 ? x->span[i-1] : 1;
6196 x = x->forward[i];
6197 }
6198 if (traversed == rank) {
6199 return x;
6200 }
6201 }
6202 return NULL;
6203 }
6204
6205 /* The actual Z-commands implementations */
6206
6207 /* This generic command implements both ZADD and ZINCRBY.
6208 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
6209 * the increment if the operation is a ZINCRBY (doincrement == 1). */
6210 static void zaddGenericCommand(redisClient *c, robj *key, robj *ele, double scoreval, int doincrement) {
6211 robj *zsetobj;
6212 zset *zs;
6213 double *score;
6214
6215 if (isnan(scoreval)) {
6216 addReplySds(c,sdsnew("-ERR provide score is Not A Number (nan)\r\n"));
6217 return;
6218 }
6219
6220 zsetobj = lookupKeyWrite(c->db,key);
6221 if (zsetobj == NULL) {
6222 zsetobj = createZsetObject();
6223 dbAdd(c->db,key,zsetobj);
6224 } else {
6225 if (zsetobj->type != REDIS_ZSET) {
6226 addReply(c,shared.wrongtypeerr);
6227 return;
6228 }
6229 }
6230 zs = zsetobj->ptr;
6231
6232 /* Ok now since we implement both ZADD and ZINCRBY here the code
6233 * needs to handle the two different conditions. It's all about setting
6234 * '*score', that is, the new score to set, to the right value. */
6235 score = zmalloc(sizeof(double));
6236 if (doincrement) {
6237 dictEntry *de;
6238
6239 /* Read the old score. If the element was not present starts from 0 */
6240 de = dictFind(zs->dict,ele);
6241 if (de) {
6242 double *oldscore = dictGetEntryVal(de);
6243 *score = *oldscore + scoreval;
6244 } else {
6245 *score = scoreval;
6246 }
6247 if (isnan(*score)) {
6248 addReplySds(c,
6249 sdsnew("-ERR resulting score is Not A Number (nan)\r\n"));
6250 zfree(score);
6251 /* Note that we don't need to check if the zset may be empty and
6252 * should be removed here, as we can only obtain Nan as score if
6253 * there was already an element in the sorted set. */
6254 return;
6255 }
6256 } else {
6257 *score = scoreval;
6258 }
6259
6260 /* What follows is a simple remove and re-insert operation that is common
6261 * to both ZADD and ZINCRBY... */
6262 if (dictAdd(zs->dict,ele,score) == DICT_OK) {
6263 /* case 1: New element */
6264 incrRefCount(ele); /* added to hash */
6265 zslInsert(zs->zsl,*score,ele);
6266 incrRefCount(ele); /* added to skiplist */
6267 server.dirty++;
6268 if (doincrement)
6269 addReplyDouble(c,*score);
6270 else
6271 addReply(c,shared.cone);
6272 } else {
6273 dictEntry *de;
6274 double *oldscore;
6275
6276 /* case 2: Score update operation */
6277 de = dictFind(zs->dict,ele);
6278 redisAssert(de != NULL);
6279 oldscore = dictGetEntryVal(de);
6280 if (*score != *oldscore) {
6281 int deleted;
6282
6283 /* Remove and insert the element in the skip list with new score */
6284 deleted = zslDelete(zs->zsl,*oldscore,ele);
6285 redisAssert(deleted != 0);
6286 zslInsert(zs->zsl,*score,ele);
6287 incrRefCount(ele);
6288 /* Update the score in the hash table */
6289 dictReplace(zs->dict,ele,score);
6290 server.dirty++;
6291 } else {
6292 zfree(score);
6293 }
6294 if (doincrement)
6295 addReplyDouble(c,*score);
6296 else
6297 addReply(c,shared.czero);
6298 }
6299 }
6300
6301 static void zaddCommand(redisClient *c) {
6302 double scoreval;
6303
6304 if (getDoubleFromObjectOrReply(c, c->argv[2], &scoreval, NULL) != REDIS_OK) return;
6305 zaddGenericCommand(c,c->argv[1],c->argv[3],scoreval,0);
6306 }
6307
6308 static void zincrbyCommand(redisClient *c) {
6309 double scoreval;
6310
6311 if (getDoubleFromObjectOrReply(c, c->argv[2], &scoreval, NULL) != REDIS_OK) return;
6312 zaddGenericCommand(c,c->argv[1],c->argv[3],scoreval,1);
6313 }
6314
6315 static void zremCommand(redisClient *c) {
6316 robj *zsetobj;
6317 zset *zs;
6318 dictEntry *de;
6319 double *oldscore;
6320 int deleted;
6321
6322 if ((zsetobj = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
6323 checkType(c,zsetobj,REDIS_ZSET)) return;
6324
6325 zs = zsetobj->ptr;
6326 de = dictFind(zs->dict,c->argv[2]);
6327 if (de == NULL) {
6328 addReply(c,shared.czero);
6329 return;
6330 }
6331 /* Delete from the skiplist */
6332 oldscore = dictGetEntryVal(de);
6333 deleted = zslDelete(zs->zsl,*oldscore,c->argv[2]);
6334 redisAssert(deleted != 0);
6335
6336 /* Delete from the hash table */
6337 dictDelete(zs->dict,c->argv[2]);
6338 if (htNeedsResize(zs->dict)) dictResize(zs->dict);
6339 if (dictSize(zs->dict) == 0) dbDelete(c->db,c->argv[1]);
6340 server.dirty++;
6341 addReply(c,shared.cone);
6342 }
6343
6344 static void zremrangebyscoreCommand(redisClient *c) {
6345 double min;
6346 double max;
6347 long deleted;
6348 robj *zsetobj;
6349 zset *zs;
6350
6351 if ((getDoubleFromObjectOrReply(c, c->argv[2], &min, NULL) != REDIS_OK) ||
6352 (getDoubleFromObjectOrReply(c, c->argv[3], &max, NULL) != REDIS_OK)) return;
6353
6354 if ((zsetobj = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
6355 checkType(c,zsetobj,REDIS_ZSET)) return;
6356
6357 zs = zsetobj->ptr;
6358 deleted = zslDeleteRangeByScore(zs->zsl,min,max,zs->dict);
6359 if (htNeedsResize(zs->dict)) dictResize(zs->dict);
6360 if (dictSize(zs->dict) == 0) dbDelete(c->db,c->argv[1]);
6361 server.dirty += deleted;
6362 addReplyLongLong(c,deleted);
6363 }
6364
6365 static void zremrangebyrankCommand(redisClient *c) {
6366 long start;
6367 long end;
6368 int llen;
6369 long deleted;
6370 robj *zsetobj;
6371 zset *zs;
6372
6373 if ((getLongFromObjectOrReply(c, c->argv[2], &start, NULL) != REDIS_OK) ||
6374 (getLongFromObjectOrReply(c, c->argv[3], &end, NULL) != REDIS_OK)) return;
6375
6376 if ((zsetobj = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
6377 checkType(c,zsetobj,REDIS_ZSET)) return;
6378 zs = zsetobj->ptr;
6379 llen = zs->zsl->length;
6380
6381 /* convert negative indexes */
6382 if (start < 0) start = llen+start;
6383 if (end < 0) end = llen+end;
6384 if (start < 0) start = 0;
6385 if (end < 0) end = 0;
6386
6387 /* indexes sanity checks */
6388 if (start > end || start >= llen) {
6389 addReply(c,shared.czero);
6390 return;
6391 }
6392 if (end >= llen) end = llen-1;
6393
6394 /* increment start and end because zsl*Rank functions
6395 * use 1-based rank */
6396 deleted = zslDeleteRangeByRank(zs->zsl,start+1,end+1,zs->dict);
6397 if (htNeedsResize(zs->dict)) dictResize(zs->dict);
6398 if (dictSize(zs->dict) == 0) dbDelete(c->db,c->argv[1]);
6399 server.dirty += deleted;
6400 addReplyLongLong(c, deleted);
6401 }
6402
6403 typedef struct {
6404 dict *dict;
6405 double weight;
6406 } zsetopsrc;
6407
6408 static int qsortCompareZsetopsrcByCardinality(const void *s1, const void *s2) {
6409 zsetopsrc *d1 = (void*) s1, *d2 = (void*) s2;
6410 unsigned long size1, size2;
6411 size1 = d1->dict ? dictSize(d1->dict) : 0;
6412 size2 = d2->dict ? dictSize(d2->dict) : 0;
6413 return size1 - size2;
6414 }
6415
6416 #define REDIS_AGGR_SUM 1
6417 #define REDIS_AGGR_MIN 2
6418 #define REDIS_AGGR_MAX 3
6419 #define zunionInterDictValue(_e) (dictGetEntryVal(_e) == NULL ? 1.0 : *(double*)dictGetEntryVal(_e))
6420
6421 inline static void zunionInterAggregate(double *target, double val, int aggregate) {
6422 if (aggregate == REDIS_AGGR_SUM) {
6423 *target = *target + val;
6424 } else if (aggregate == REDIS_AGGR_MIN) {
6425 *target = val < *target ? val : *target;
6426 } else if (aggregate == REDIS_AGGR_MAX) {
6427 *target = val > *target ? val : *target;
6428 } else {
6429 /* safety net */
6430 redisPanic("Unknown ZUNION/INTER aggregate type");
6431 }
6432 }
6433
6434 static void zunionInterGenericCommand(redisClient *c, robj *dstkey, int op) {
6435 int i, j, setnum;
6436 int aggregate = REDIS_AGGR_SUM;
6437 zsetopsrc *src;
6438 robj *dstobj;
6439 zset *dstzset;
6440 dictIterator *di;
6441 dictEntry *de;
6442
6443 /* expect setnum input keys to be given */
6444 setnum = atoi(c->argv[2]->ptr);
6445 if (setnum < 1) {
6446 addReplySds(c,sdsnew("-ERR at least 1 input key is needed for ZUNIONSTORE/ZINTERSTORE\r\n"));
6447 return;
6448 }
6449
6450 /* test if the expected number of keys would overflow */
6451 if (3+setnum > c->argc) {
6452 addReply(c,shared.syntaxerr);
6453 return;
6454 }
6455
6456 /* read keys to be used for input */
6457 src = zmalloc(sizeof(zsetopsrc) * setnum);
6458 for (i = 0, j = 3; i < setnum; i++, j++) {
6459 robj *obj = lookupKeyWrite(c->db,c->argv[j]);
6460 if (!obj) {
6461 src[i].dict = NULL;
6462 } else {
6463 if (obj->type == REDIS_ZSET) {
6464 src[i].dict = ((zset*)obj->ptr)->dict;
6465 } else if (obj->type == REDIS_SET) {
6466 src[i].dict = (obj->ptr);
6467 } else {
6468 zfree(src);
6469 addReply(c,shared.wrongtypeerr);
6470 return;
6471 }
6472 }
6473
6474 /* default all weights to 1 */
6475 src[i].weight = 1.0;
6476 }
6477
6478 /* parse optional extra arguments */
6479 if (j < c->argc) {
6480 int remaining = c->argc - j;
6481
6482 while (remaining) {
6483 if (remaining >= (setnum + 1) && !strcasecmp(c->argv[j]->ptr,"weights")) {
6484 j++; remaining--;
6485 for (i = 0; i < setnum; i++, j++, remaining--) {
6486 if (getDoubleFromObjectOrReply(c, c->argv[j], &src[i].weight, NULL) != REDIS_OK)
6487 return;
6488 }
6489 } else if (remaining >= 2 && !strcasecmp(c->argv[j]->ptr,"aggregate")) {
6490 j++; remaining--;
6491 if (!strcasecmp(c->argv[j]->ptr,"sum")) {
6492 aggregate = REDIS_AGGR_SUM;
6493 } else if (!strcasecmp(c->argv[j]->ptr,"min")) {
6494 aggregate = REDIS_AGGR_MIN;
6495 } else if (!strcasecmp(c->argv[j]->ptr,"max")) {
6496 aggregate = REDIS_AGGR_MAX;
6497 } else {
6498 zfree(src);
6499 addReply(c,shared.syntaxerr);
6500 return;
6501 }
6502 j++; remaining--;
6503 } else {
6504 zfree(src);
6505 addReply(c,shared.syntaxerr);
6506 return;
6507 }
6508 }
6509 }
6510
6511 /* sort sets from the smallest to largest, this will improve our
6512 * algorithm's performance */
6513 qsort(src,setnum,sizeof(zsetopsrc),qsortCompareZsetopsrcByCardinality);
6514
6515 dstobj = createZsetObject();
6516 dstzset = dstobj->ptr;
6517
6518 if (op == REDIS_OP_INTER) {
6519 /* skip going over all entries if the smallest zset is NULL or empty */
6520 if (src[0].dict && dictSize(src[0].dict) > 0) {
6521 /* precondition: as src[0].dict is non-empty and the zsets are ordered
6522 * from small to large, all src[i > 0].dict are non-empty too */
6523 di = dictGetIterator(src[0].dict);
6524 while((de = dictNext(di)) != NULL) {
6525 double *score = zmalloc(sizeof(double)), value;
6526 *score = src[0].weight * zunionInterDictValue(de);
6527
6528 for (j = 1; j < setnum; j++) {
6529 dictEntry *other = dictFind(src[j].dict,dictGetEntryKey(de));
6530 if (other) {
6531 value = src[j].weight * zunionInterDictValue(other);
6532 zunionInterAggregate(score, value, aggregate);
6533 } else {
6534 break;
6535 }
6536 }
6537
6538 /* skip entry when not present in every source dict */
6539 if (j != setnum) {
6540 zfree(score);
6541 } else {
6542 robj *o = dictGetEntryKey(de);
6543 dictAdd(dstzset->dict,o,score);
6544 incrRefCount(o); /* added to dictionary */
6545 zslInsert(dstzset->zsl,*score,o);
6546 incrRefCount(o); /* added to skiplist */
6547 }
6548 }
6549 dictReleaseIterator(di);
6550 }
6551 } else if (op == REDIS_OP_UNION) {
6552 for (i = 0; i < setnum; i++) {
6553 if (!src[i].dict) continue;
6554
6555 di = dictGetIterator(src[i].dict);
6556 while((de = dictNext(di)) != NULL) {
6557 /* skip key when already processed */
6558 if (dictFind(dstzset->dict,dictGetEntryKey(de)) != NULL) continue;
6559
6560 double *score = zmalloc(sizeof(double)), value;
6561 *score = src[i].weight * zunionInterDictValue(de);
6562
6563 /* because the zsets are sorted by size, its only possible
6564 * for sets at larger indices to hold this entry */
6565 for (j = (i+1); j < setnum; j++) {
6566 dictEntry *other = dictFind(src[j].dict,dictGetEntryKey(de));
6567 if (other) {
6568 value = src[j].weight * zunionInterDictValue(other);
6569 zunionInterAggregate(score, value, aggregate);
6570 }
6571 }
6572
6573 robj *o = dictGetEntryKey(de);
6574 dictAdd(dstzset->dict,o,score);
6575 incrRefCount(o); /* added to dictionary */
6576 zslInsert(dstzset->zsl,*score,o);
6577 incrRefCount(o); /* added to skiplist */
6578 }
6579 dictReleaseIterator(di);
6580 }
6581 } else {
6582 /* unknown operator */
6583 redisAssert(op == REDIS_OP_INTER || op == REDIS_OP_UNION);
6584 }
6585
6586 dbDelete(c->db,dstkey);
6587 if (dstzset->zsl->length) {
6588 dbAdd(c->db,dstkey,dstobj);
6589 addReplyLongLong(c, dstzset->zsl->length);
6590 server.dirty++;
6591 } else {
6592 decrRefCount(dstobj);
6593 addReply(c, shared.czero);
6594 }
6595 zfree(src);
6596 }
6597
6598 static void zunionstoreCommand(redisClient *c) {
6599 zunionInterGenericCommand(c,c->argv[1], REDIS_OP_UNION);
6600 }
6601
6602 static void zinterstoreCommand(redisClient *c) {
6603 zunionInterGenericCommand(c,c->argv[1], REDIS_OP_INTER);
6604 }
6605
6606 static void zrangeGenericCommand(redisClient *c, int reverse) {
6607 robj *o;
6608 long start;
6609 long end;
6610 int withscores = 0;
6611 int llen;
6612 int rangelen, j;
6613 zset *zsetobj;
6614 zskiplist *zsl;
6615 zskiplistNode *ln;
6616 robj *ele;
6617
6618 if ((getLongFromObjectOrReply(c, c->argv[2], &start, NULL) != REDIS_OK) ||
6619 (getLongFromObjectOrReply(c, c->argv[3], &end, NULL) != REDIS_OK)) return;
6620
6621 if (c->argc == 5 && !strcasecmp(c->argv[4]->ptr,"withscores")) {
6622 withscores = 1;
6623 } else if (c->argc >= 5) {
6624 addReply(c,shared.syntaxerr);
6625 return;
6626 }
6627
6628 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.emptymultibulk)) == NULL
6629 || checkType(c,o,REDIS_ZSET)) return;
6630 zsetobj = o->ptr;
6631 zsl = zsetobj->zsl;
6632 llen = zsl->length;
6633
6634 /* convert negative indexes */
6635 if (start < 0) start = llen+start;
6636 if (end < 0) end = llen+end;
6637 if (start < 0) start = 0;
6638 if (end < 0) end = 0;
6639
6640 /* indexes sanity checks */
6641 if (start > end || start >= llen) {
6642 /* Out of range start or start > end result in empty list */
6643 addReply(c,shared.emptymultibulk);
6644 return;
6645 }
6646 if (end >= llen) end = llen-1;
6647 rangelen = (end-start)+1;
6648
6649 /* check if starting point is trivial, before searching
6650 * the element in log(N) time */
6651 if (reverse) {
6652 ln = start == 0 ? zsl->tail : zslistTypeGetElementByRank(zsl, llen-start);
6653 } else {
6654 ln = start == 0 ?
6655 zsl->header->forward[0] : zslistTypeGetElementByRank(zsl, start+1);
6656 }
6657
6658 /* Return the result in form of a multi-bulk reply */
6659 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",
6660 withscores ? (rangelen*2) : rangelen));
6661 for (j = 0; j < rangelen; j++) {
6662 ele = ln->obj;
6663 addReplyBulk(c,ele);
6664 if (withscores)
6665 addReplyDouble(c,ln->score);
6666 ln = reverse ? ln->backward : ln->forward[0];
6667 }
6668 }
6669
6670 static void zrangeCommand(redisClient *c) {
6671 zrangeGenericCommand(c,0);
6672 }
6673
6674 static void zrevrangeCommand(redisClient *c) {
6675 zrangeGenericCommand(c,1);
6676 }
6677
6678 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
6679 * If justcount is non-zero, just the count is returned. */
6680 static void genericZrangebyscoreCommand(redisClient *c, int justcount) {
6681 robj *o;
6682 double min, max;
6683 int minex = 0, maxex = 0; /* are min or max exclusive? */
6684 int offset = 0, limit = -1;
6685 int withscores = 0;
6686 int badsyntax = 0;
6687
6688 /* Parse the min-max interval. If one of the values is prefixed
6689 * by the "(" character, it's considered "open". For instance
6690 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
6691 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
6692 if (((char*)c->argv[2]->ptr)[0] == '(') {
6693 min = strtod((char*)c->argv[2]->ptr+1,NULL);
6694 minex = 1;
6695 } else {
6696 min = strtod(c->argv[2]->ptr,NULL);
6697 }
6698 if (((char*)c->argv[3]->ptr)[0] == '(') {
6699 max = strtod((char*)c->argv[3]->ptr+1,NULL);
6700 maxex = 1;
6701 } else {
6702 max = strtod(c->argv[3]->ptr,NULL);
6703 }
6704
6705 /* Parse "WITHSCORES": note that if the command was called with
6706 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
6707 * enter the following paths to parse WITHSCORES and LIMIT. */
6708 if (c->argc == 5 || c->argc == 8) {
6709 if (strcasecmp(c->argv[c->argc-1]->ptr,"withscores") == 0)
6710 withscores = 1;
6711 else
6712 badsyntax = 1;
6713 }
6714 if (c->argc != (4 + withscores) && c->argc != (7 + withscores))
6715 badsyntax = 1;
6716 if (badsyntax) {
6717 addReplySds(c,
6718 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
6719 return;
6720 }
6721
6722 /* Parse "LIMIT" */
6723 if (c->argc == (7 + withscores) && strcasecmp(c->argv[4]->ptr,"limit")) {
6724 addReply(c,shared.syntaxerr);
6725 return;
6726 } else if (c->argc == (7 + withscores)) {
6727 offset = atoi(c->argv[5]->ptr);
6728 limit = atoi(c->argv[6]->ptr);
6729 if (offset < 0) offset = 0;
6730 }
6731
6732 /* Ok, lookup the key and get the range */
6733 o = lookupKeyRead(c->db,c->argv[1]);
6734 if (o == NULL) {
6735 addReply(c,justcount ? shared.czero : shared.emptymultibulk);
6736 } else {
6737 if (o->type != REDIS_ZSET) {
6738 addReply(c,shared.wrongtypeerr);
6739 } else {
6740 zset *zsetobj = o->ptr;
6741 zskiplist *zsl = zsetobj->zsl;
6742 zskiplistNode *ln;
6743 robj *ele, *lenobj = NULL;
6744 unsigned long rangelen = 0;
6745
6746 /* Get the first node with the score >= min, or with
6747 * score > min if 'minex' is true. */
6748 ln = zslFirstWithScore(zsl,min);
6749 while (minex && ln && ln->score == min) ln = ln->forward[0];
6750
6751 if (ln == NULL) {
6752 /* No element matching the speciifed interval */
6753 addReply(c,justcount ? shared.czero : shared.emptymultibulk);
6754 return;
6755 }
6756
6757 /* We don't know in advance how many matching elements there
6758 * are in the list, so we push this object that will represent
6759 * the multi-bulk length in the output buffer, and will "fix"
6760 * it later */
6761 if (!justcount) {
6762 lenobj = createObject(REDIS_STRING,NULL);
6763 addReply(c,lenobj);
6764 decrRefCount(lenobj);
6765 }
6766
6767 while(ln && (maxex ? (ln->score < max) : (ln->score <= max))) {
6768 if (offset) {
6769 offset--;
6770 ln = ln->forward[0];
6771 continue;
6772 }
6773 if (limit == 0) break;
6774 if (!justcount) {
6775 ele = ln->obj;
6776 addReplyBulk(c,ele);
6777 if (withscores)
6778 addReplyDouble(c,ln->score);
6779 }
6780 ln = ln->forward[0];
6781 rangelen++;
6782 if (limit > 0) limit--;
6783 }
6784 if (justcount) {
6785 addReplyLongLong(c,(long)rangelen);
6786 } else {
6787 lenobj->ptr = sdscatprintf(sdsempty(),"*%lu\r\n",
6788 withscores ? (rangelen*2) : rangelen);
6789 }
6790 }
6791 }
6792 }
6793
6794 static void zrangebyscoreCommand(redisClient *c) {
6795 genericZrangebyscoreCommand(c,0);
6796 }
6797
6798 static void zcountCommand(redisClient *c) {
6799 genericZrangebyscoreCommand(c,1);
6800 }
6801
6802 static void zcardCommand(redisClient *c) {
6803 robj *o;
6804 zset *zs;
6805
6806 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
6807 checkType(c,o,REDIS_ZSET)) return;
6808
6809 zs = o->ptr;
6810 addReplyUlong(c,zs->zsl->length);
6811 }
6812
6813 static void zscoreCommand(redisClient *c) {
6814 robj *o;
6815 zset *zs;
6816 dictEntry *de;
6817
6818 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
6819 checkType(c,o,REDIS_ZSET)) return;
6820
6821 zs = o->ptr;
6822 de = dictFind(zs->dict,c->argv[2]);
6823 if (!de) {
6824 addReply(c,shared.nullbulk);
6825 } else {
6826 double *score = dictGetEntryVal(de);
6827
6828 addReplyDouble(c,*score);
6829 }
6830 }
6831
6832 static void zrankGenericCommand(redisClient *c, int reverse) {
6833 robj *o;
6834 zset *zs;
6835 zskiplist *zsl;
6836 dictEntry *de;
6837 unsigned long rank;
6838 double *score;
6839
6840 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
6841 checkType(c,o,REDIS_ZSET)) return;
6842
6843 zs = o->ptr;
6844 zsl = zs->zsl;
6845 de = dictFind(zs->dict,c->argv[2]);
6846 if (!de) {
6847 addReply(c,shared.nullbulk);
6848 return;
6849 }
6850
6851 score = dictGetEntryVal(de);
6852 rank = zslistTypeGetRank(zsl, *score, c->argv[2]);
6853 if (rank) {
6854 if (reverse) {
6855 addReplyLongLong(c, zsl->length - rank);
6856 } else {
6857 addReplyLongLong(c, rank-1);
6858 }
6859 } else {
6860 addReply(c,shared.nullbulk);
6861 }
6862 }
6863
6864 static void zrankCommand(redisClient *c) {
6865 zrankGenericCommand(c, 0);
6866 }
6867
6868 static void zrevrankCommand(redisClient *c) {
6869 zrankGenericCommand(c, 1);
6870 }
6871
6872 /* ========================= Hashes utility functions ======================= */
6873 #define REDIS_HASH_KEY 1
6874 #define REDIS_HASH_VALUE 2
6875
6876 /* Check the length of a number of objects to see if we need to convert a
6877 * zipmap to a real hash. Note that we only check string encoded objects
6878 * as their string length can be queried in constant time. */
6879 static void hashTypeTryConversion(robj *subject, robj **argv, int start, int end) {
6880 int i;
6881 if (subject->encoding != REDIS_ENCODING_ZIPMAP) return;
6882
6883 for (i = start; i <= end; i++) {
6884 if (argv[i]->encoding == REDIS_ENCODING_RAW &&
6885 sdslen(argv[i]->ptr) > server.hash_max_zipmap_value)
6886 {
6887 convertToRealHash(subject);
6888 return;
6889 }
6890 }
6891 }
6892
6893 /* Encode given objects in-place when the hash uses a dict. */
6894 static void hashTypeTryObjectEncoding(robj *subject, robj **o1, robj **o2) {
6895 if (subject->encoding == REDIS_ENCODING_HT) {
6896 if (o1) *o1 = tryObjectEncoding(*o1);
6897 if (o2) *o2 = tryObjectEncoding(*o2);
6898 }
6899 }
6900
6901 /* Get the value from a hash identified by key. Returns either a string
6902 * object or NULL if the value cannot be found. The refcount of the object
6903 * is always increased by 1 when the value was found. */
6904 static robj *hashTypeGet(robj *o, robj *key) {
6905 robj *value = NULL;
6906 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
6907 unsigned char *v;
6908 unsigned int vlen;
6909 key = getDecodedObject(key);
6910 if (zipmapGet(o->ptr,key->ptr,sdslen(key->ptr),&v,&vlen)) {
6911 value = createStringObject((char*)v,vlen);
6912 }
6913 decrRefCount(key);
6914 } else {
6915 dictEntry *de = dictFind(o->ptr,key);
6916 if (de != NULL) {
6917 value = dictGetEntryVal(de);
6918 incrRefCount(value);
6919 }
6920 }
6921 return value;
6922 }
6923
6924 /* Test if the key exists in the given hash. Returns 1 if the key
6925 * exists and 0 when it doesn't. */
6926 static int hashTypeExists(robj *o, robj *key) {
6927 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
6928 key = getDecodedObject(key);
6929 if (zipmapExists(o->ptr,key->ptr,sdslen(key->ptr))) {
6930 decrRefCount(key);
6931 return 1;
6932 }
6933 decrRefCount(key);
6934 } else {
6935 if (dictFind(o->ptr,key) != NULL) {
6936 return 1;
6937 }
6938 }
6939 return 0;
6940 }
6941
6942 /* Add an element, discard the old if the key already exists.
6943 * Return 0 on insert and 1 on update. */
6944 static int hashTypeSet(robj *o, robj *key, robj *value) {
6945 int update = 0;
6946 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
6947 key = getDecodedObject(key);
6948 value = getDecodedObject(value);
6949 o->ptr = zipmapSet(o->ptr,
6950 key->ptr,sdslen(key->ptr),
6951 value->ptr,sdslen(value->ptr), &update);
6952 decrRefCount(key);
6953 decrRefCount(value);
6954
6955 /* Check if the zipmap needs to be upgraded to a real hash table */
6956 if (zipmapLen(o->ptr) > server.hash_max_zipmap_entries)
6957 convertToRealHash(o);
6958 } else {
6959 if (dictReplace(o->ptr,key,value)) {
6960 /* Insert */
6961 incrRefCount(key);
6962 } else {
6963 /* Update */
6964 update = 1;
6965 }
6966 incrRefCount(value);
6967 }
6968 return update;
6969 }
6970
6971 /* Delete an element from a hash.
6972 * Return 1 on deleted and 0 on not found. */
6973 static int hashTypeDelete(robj *o, robj *key) {
6974 int deleted = 0;
6975 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
6976 key = getDecodedObject(key);
6977 o->ptr = zipmapDel(o->ptr,key->ptr,sdslen(key->ptr), &deleted);
6978 decrRefCount(key);
6979 } else {
6980 deleted = dictDelete((dict*)o->ptr,key) == DICT_OK;
6981 /* Always check if the dictionary needs a resize after a delete. */
6982 if (deleted && htNeedsResize(o->ptr)) dictResize(o->ptr);
6983 }
6984 return deleted;
6985 }
6986
6987 /* Return the number of elements in a hash. */
6988 static unsigned long hashTypeLength(robj *o) {
6989 return (o->encoding == REDIS_ENCODING_ZIPMAP) ?
6990 zipmapLen((unsigned char*)o->ptr) : dictSize((dict*)o->ptr);
6991 }
6992
6993 /* Structure to hold hash iteration abstration. Note that iteration over
6994 * hashes involves both fields and values. Because it is possible that
6995 * not both are required, store pointers in the iterator to avoid
6996 * unnecessary memory allocation for fields/values. */
6997 typedef struct {
6998 int encoding;
6999 unsigned char *zi;
7000 unsigned char *zk, *zv;
7001 unsigned int zklen, zvlen;
7002
7003 dictIterator *di;
7004 dictEntry *de;
7005 } hashTypeIterator;
7006
7007 static hashTypeIterator *hashTypeInitIterator(robj *subject) {
7008 hashTypeIterator *hi = zmalloc(sizeof(hashTypeIterator));
7009 hi->encoding = subject->encoding;
7010 if (hi->encoding == REDIS_ENCODING_ZIPMAP) {
7011 hi->zi = zipmapRewind(subject->ptr);
7012 } else if (hi->encoding == REDIS_ENCODING_HT) {
7013 hi->di = dictGetIterator(subject->ptr);
7014 } else {
7015 redisAssert(NULL);
7016 }
7017 return hi;
7018 }
7019
7020 static void hashTypeReleaseIterator(hashTypeIterator *hi) {
7021 if (hi->encoding == REDIS_ENCODING_HT) {
7022 dictReleaseIterator(hi->di);
7023 }
7024 zfree(hi);
7025 }
7026
7027 /* Move to the next entry in the hash. Return REDIS_OK when the next entry
7028 * could be found and REDIS_ERR when the iterator reaches the end. */
7029 static int hashTypeNext(hashTypeIterator *hi) {
7030 if (hi->encoding == REDIS_ENCODING_ZIPMAP) {
7031 if ((hi->zi = zipmapNext(hi->zi, &hi->zk, &hi->zklen,
7032 &hi->zv, &hi->zvlen)) == NULL) return REDIS_ERR;
7033 } else {
7034 if ((hi->de = dictNext(hi->di)) == NULL) return REDIS_ERR;
7035 }
7036 return REDIS_OK;
7037 }
7038
7039 /* Get key or value object at current iteration position.
7040 * This increases the refcount of the field object by 1. */
7041 static robj *hashTypeCurrent(hashTypeIterator *hi, int what) {
7042 robj *o;
7043 if (hi->encoding == REDIS_ENCODING_ZIPMAP) {
7044 if (what & REDIS_HASH_KEY) {
7045 o = createStringObject((char*)hi->zk,hi->zklen);
7046 } else {
7047 o = createStringObject((char*)hi->zv,hi->zvlen);
7048 }
7049 } else {
7050 if (what & REDIS_HASH_KEY) {
7051 o = dictGetEntryKey(hi->de);
7052 } else {
7053 o = dictGetEntryVal(hi->de);
7054 }
7055 incrRefCount(o);
7056 }
7057 return o;
7058 }
7059
7060 static robj *hashTypeLookupWriteOrCreate(redisClient *c, robj *key) {
7061 robj *o = lookupKeyWrite(c->db,key);
7062 if (o == NULL) {
7063 o = createHashObject();
7064 dbAdd(c->db,key,o);
7065 } else {
7066 if (o->type != REDIS_HASH) {
7067 addReply(c,shared.wrongtypeerr);
7068 return NULL;
7069 }
7070 }
7071 return o;
7072 }
7073
7074 /* ============================= Hash commands ============================== */
7075 static void hsetCommand(redisClient *c) {
7076 int update;
7077 robj *o;
7078
7079 if ((o = hashTypeLookupWriteOrCreate(c,c->argv[1])) == NULL) return;
7080 hashTypeTryConversion(o,c->argv,2,3);
7081 hashTypeTryObjectEncoding(o,&c->argv[2], &c->argv[3]);
7082 update = hashTypeSet(o,c->argv[2],c->argv[3]);
7083 addReply(c, update ? shared.czero : shared.cone);
7084 server.dirty++;
7085 }
7086
7087 static void hsetnxCommand(redisClient *c) {
7088 robj *o;
7089 if ((o = hashTypeLookupWriteOrCreate(c,c->argv[1])) == NULL) return;
7090 hashTypeTryConversion(o,c->argv,2,3);
7091
7092 if (hashTypeExists(o, c->argv[2])) {
7093 addReply(c, shared.czero);
7094 } else {
7095 hashTypeTryObjectEncoding(o,&c->argv[2], &c->argv[3]);
7096 hashTypeSet(o,c->argv[2],c->argv[3]);
7097 addReply(c, shared.cone);
7098 server.dirty++;
7099 }
7100 }
7101
7102 static void hmsetCommand(redisClient *c) {
7103 int i;
7104 robj *o;
7105
7106 if ((c->argc % 2) == 1) {
7107 addReplySds(c,sdsnew("-ERR wrong number of arguments for HMSET\r\n"));
7108 return;
7109 }
7110
7111 if ((o = hashTypeLookupWriteOrCreate(c,c->argv[1])) == NULL) return;
7112 hashTypeTryConversion(o,c->argv,2,c->argc-1);
7113 for (i = 2; i < c->argc; i += 2) {
7114 hashTypeTryObjectEncoding(o,&c->argv[i], &c->argv[i+1]);
7115 hashTypeSet(o,c->argv[i],c->argv[i+1]);
7116 }
7117 addReply(c, shared.ok);
7118 server.dirty++;
7119 }
7120
7121 static void hincrbyCommand(redisClient *c) {
7122 long long value, incr;
7123 robj *o, *current, *new;
7124
7125 if (getLongLongFromObjectOrReply(c,c->argv[3],&incr,NULL) != REDIS_OK) return;
7126 if ((o = hashTypeLookupWriteOrCreate(c,c->argv[1])) == NULL) return;
7127 if ((current = hashTypeGet(o,c->argv[2])) != NULL) {
7128 if (getLongLongFromObjectOrReply(c,current,&value,
7129 "hash value is not an integer") != REDIS_OK) {
7130 decrRefCount(current);
7131 return;
7132 }
7133 decrRefCount(current);
7134 } else {
7135 value = 0;
7136 }
7137
7138 value += incr;
7139 new = createStringObjectFromLongLong(value);
7140 hashTypeTryObjectEncoding(o,&c->argv[2],NULL);
7141 hashTypeSet(o,c->argv[2],new);
7142 decrRefCount(new);
7143 addReplyLongLong(c,value);
7144 server.dirty++;
7145 }
7146
7147 static void hgetCommand(redisClient *c) {
7148 robj *o, *value;
7149 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
7150 checkType(c,o,REDIS_HASH)) return;
7151
7152 if ((value = hashTypeGet(o,c->argv[2])) != NULL) {
7153 addReplyBulk(c,value);
7154 decrRefCount(value);
7155 } else {
7156 addReply(c,shared.nullbulk);
7157 }
7158 }
7159
7160 static void hmgetCommand(redisClient *c) {
7161 int i;
7162 robj *o, *value;
7163 o = lookupKeyRead(c->db,c->argv[1]);
7164 if (o != NULL && o->type != REDIS_HASH) {
7165 addReply(c,shared.wrongtypeerr);
7166 }
7167
7168 /* Note the check for o != NULL happens inside the loop. This is
7169 * done because objects that cannot be found are considered to be
7170 * an empty hash. The reply should then be a series of NULLs. */
7171 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",c->argc-2));
7172 for (i = 2; i < c->argc; i++) {
7173 if (o != NULL && (value = hashTypeGet(o,c->argv[i])) != NULL) {
7174 addReplyBulk(c,value);
7175 decrRefCount(value);
7176 } else {
7177 addReply(c,shared.nullbulk);
7178 }
7179 }
7180 }
7181
7182 static void hdelCommand(redisClient *c) {
7183 robj *o;
7184 if ((o = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
7185 checkType(c,o,REDIS_HASH)) return;
7186
7187 if (hashTypeDelete(o,c->argv[2])) {
7188 if (hashTypeLength(o) == 0) dbDelete(c->db,c->argv[1]);
7189 addReply(c,shared.cone);
7190 server.dirty++;
7191 } else {
7192 addReply(c,shared.czero);
7193 }
7194 }
7195
7196 static void hlenCommand(redisClient *c) {
7197 robj *o;
7198 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
7199 checkType(c,o,REDIS_HASH)) return;
7200
7201 addReplyUlong(c,hashTypeLength(o));
7202 }
7203
7204 static void genericHgetallCommand(redisClient *c, int flags) {
7205 robj *o, *lenobj, *obj;
7206 unsigned long count = 0;
7207 hashTypeIterator *hi;
7208
7209 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.emptymultibulk)) == NULL
7210 || checkType(c,o,REDIS_HASH)) return;
7211
7212 lenobj = createObject(REDIS_STRING,NULL);
7213 addReply(c,lenobj);
7214 decrRefCount(lenobj);
7215
7216 hi = hashTypeInitIterator(o);
7217 while (hashTypeNext(hi) != REDIS_ERR) {
7218 if (flags & REDIS_HASH_KEY) {
7219 obj = hashTypeCurrent(hi,REDIS_HASH_KEY);
7220 addReplyBulk(c,obj);
7221 decrRefCount(obj);
7222 count++;
7223 }
7224 if (flags & REDIS_HASH_VALUE) {
7225 obj = hashTypeCurrent(hi,REDIS_HASH_VALUE);
7226 addReplyBulk(c,obj);
7227 decrRefCount(obj);
7228 count++;
7229 }
7230 }
7231 hashTypeReleaseIterator(hi);
7232
7233 lenobj->ptr = sdscatprintf(sdsempty(),"*%lu\r\n",count);
7234 }
7235
7236 static void hkeysCommand(redisClient *c) {
7237 genericHgetallCommand(c,REDIS_HASH_KEY);
7238 }
7239
7240 static void hvalsCommand(redisClient *c) {
7241 genericHgetallCommand(c,REDIS_HASH_VALUE);
7242 }
7243
7244 static void hgetallCommand(redisClient *c) {
7245 genericHgetallCommand(c,REDIS_HASH_KEY|REDIS_HASH_VALUE);
7246 }
7247
7248 static void hexistsCommand(redisClient *c) {
7249 robj *o;
7250 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
7251 checkType(c,o,REDIS_HASH)) return;
7252
7253 addReply(c, hashTypeExists(o,c->argv[2]) ? shared.cone : shared.czero);
7254 }
7255
7256 static void convertToRealHash(robj *o) {
7257 unsigned char *key, *val, *p, *zm = o->ptr;
7258 unsigned int klen, vlen;
7259 dict *dict = dictCreate(&hashDictType,NULL);
7260
7261 assert(o->type == REDIS_HASH && o->encoding != REDIS_ENCODING_HT);
7262 p = zipmapRewind(zm);
7263 while((p = zipmapNext(p,&key,&klen,&val,&vlen)) != NULL) {
7264 robj *keyobj, *valobj;
7265
7266 keyobj = createStringObject((char*)key,klen);
7267 valobj = createStringObject((char*)val,vlen);
7268 keyobj = tryObjectEncoding(keyobj);
7269 valobj = tryObjectEncoding(valobj);
7270 dictAdd(dict,keyobj,valobj);
7271 }
7272 o->encoding = REDIS_ENCODING_HT;
7273 o->ptr = dict;
7274 zfree(zm);
7275 }
7276
7277 /* ========================= Non type-specific commands ==================== */
7278
7279 static void flushdbCommand(redisClient *c) {
7280 server.dirty += dictSize(c->db->dict);
7281 touchWatchedKeysOnFlush(c->db->id);
7282 dictEmpty(c->db->dict);
7283 dictEmpty(c->db->expires);
7284 addReply(c,shared.ok);
7285 }
7286
7287 static void flushallCommand(redisClient *c) {
7288 touchWatchedKeysOnFlush(-1);
7289 server.dirty += emptyDb();
7290 addReply(c,shared.ok);
7291 if (server.bgsavechildpid != -1) {
7292 kill(server.bgsavechildpid,SIGKILL);
7293 rdbRemoveTempFile(server.bgsavechildpid);
7294 }
7295 rdbSave(server.dbfilename);
7296 server.dirty++;
7297 }
7298
7299 static redisSortOperation *createSortOperation(int type, robj *pattern) {
7300 redisSortOperation *so = zmalloc(sizeof(*so));
7301 so->type = type;
7302 so->pattern = pattern;
7303 return so;
7304 }
7305
7306 /* Return the value associated to the key with a name obtained
7307 * substituting the first occurence of '*' in 'pattern' with 'subst'.
7308 * The returned object will always have its refcount increased by 1
7309 * when it is non-NULL. */
7310 static robj *lookupKeyByPattern(redisDb *db, robj *pattern, robj *subst) {
7311 char *p, *f;
7312 sds spat, ssub;
7313 robj keyobj, fieldobj, *o;
7314 int prefixlen, sublen, postfixlen, fieldlen;
7315 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
7316 struct {
7317 long len;
7318 long free;
7319 char buf[REDIS_SORTKEY_MAX+1];
7320 } keyname, fieldname;
7321
7322 /* If the pattern is "#" return the substitution object itself in order
7323 * to implement the "SORT ... GET #" feature. */
7324 spat = pattern->ptr;
7325 if (spat[0] == '#' && spat[1] == '\0') {
7326 incrRefCount(subst);
7327 return subst;
7328 }
7329
7330 /* The substitution object may be specially encoded. If so we create
7331 * a decoded object on the fly. Otherwise getDecodedObject will just
7332 * increment the ref count, that we'll decrement later. */
7333 subst = getDecodedObject(subst);
7334
7335 ssub = subst->ptr;
7336 if (sdslen(spat)+sdslen(ssub)-1 > REDIS_SORTKEY_MAX) return NULL;
7337 p = strchr(spat,'*');
7338 if (!p) {
7339 decrRefCount(subst);
7340 return NULL;
7341 }
7342
7343 /* Find out if we're dealing with a hash dereference. */
7344 if ((f = strstr(p+1, "->")) != NULL) {
7345 fieldlen = sdslen(spat)-(f-spat);
7346 /* this also copies \0 character */
7347 memcpy(fieldname.buf,f+2,fieldlen-1);
7348 fieldname.len = fieldlen-2;
7349 } else {
7350 fieldlen = 0;
7351 }
7352
7353 prefixlen = p-spat;
7354 sublen = sdslen(ssub);
7355 postfixlen = sdslen(spat)-(prefixlen+1)-fieldlen;
7356 memcpy(keyname.buf,spat,prefixlen);
7357 memcpy(keyname.buf+prefixlen,ssub,sublen);
7358 memcpy(keyname.buf+prefixlen+sublen,p+1,postfixlen);
7359 keyname.buf[prefixlen+sublen+postfixlen] = '\0';
7360 keyname.len = prefixlen+sublen+postfixlen;
7361 decrRefCount(subst);
7362
7363 /* Lookup substituted key */
7364 initStaticStringObject(keyobj,((char*)&keyname)+(sizeof(long)*2));
7365 o = lookupKeyRead(db,&keyobj);
7366 if (o == NULL) return NULL;
7367
7368 if (fieldlen > 0) {
7369 if (o->type != REDIS_HASH || fieldname.len < 1) return NULL;
7370
7371 /* Retrieve value from hash by the field name. This operation
7372 * already increases the refcount of the returned object. */
7373 initStaticStringObject(fieldobj,((char*)&fieldname)+(sizeof(long)*2));
7374 o = hashTypeGet(o, &fieldobj);
7375 } else {
7376 if (o->type != REDIS_STRING) return NULL;
7377
7378 /* Every object that this function returns needs to have its refcount
7379 * increased. sortCommand decreases it again. */
7380 incrRefCount(o);
7381 }
7382
7383 return o;
7384 }
7385
7386 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
7387 * the additional parameter is not standard but a BSD-specific we have to
7388 * pass sorting parameters via the global 'server' structure */
7389 static int sortCompare(const void *s1, const void *s2) {
7390 const redisSortObject *so1 = s1, *so2 = s2;
7391 int cmp;
7392
7393 if (!server.sort_alpha) {
7394 /* Numeric sorting. Here it's trivial as we precomputed scores */
7395 if (so1->u.score > so2->u.score) {
7396 cmp = 1;
7397 } else if (so1->u.score < so2->u.score) {
7398 cmp = -1;
7399 } else {
7400 cmp = 0;
7401 }
7402 } else {
7403 /* Alphanumeric sorting */
7404 if (server.sort_bypattern) {
7405 if (!so1->u.cmpobj || !so2->u.cmpobj) {
7406 /* At least one compare object is NULL */
7407 if (so1->u.cmpobj == so2->u.cmpobj)
7408 cmp = 0;
7409 else if (so1->u.cmpobj == NULL)
7410 cmp = -1;
7411 else
7412 cmp = 1;
7413 } else {
7414 /* We have both the objects, use strcoll */
7415 cmp = strcoll(so1->u.cmpobj->ptr,so2->u.cmpobj->ptr);
7416 }
7417 } else {
7418 /* Compare elements directly. */
7419 cmp = compareStringObjects(so1->obj,so2->obj);
7420 }
7421 }
7422 return server.sort_desc ? -cmp : cmp;
7423 }
7424
7425 /* The SORT command is the most complex command in Redis. Warning: this code
7426 * is optimized for speed and a bit less for readability */
7427 static void sortCommand(redisClient *c) {
7428 list *operations;
7429 unsigned int outputlen = 0;
7430 int desc = 0, alpha = 0;
7431 int limit_start = 0, limit_count = -1, start, end;
7432 int j, dontsort = 0, vectorlen;
7433 int getop = 0; /* GET operation counter */
7434 robj *sortval, *sortby = NULL, *storekey = NULL;
7435 redisSortObject *vector; /* Resulting vector to sort */
7436
7437 /* Lookup the key to sort. It must be of the right types */
7438 sortval = lookupKeyRead(c->db,c->argv[1]);
7439 if (sortval == NULL) {
7440 addReply(c,shared.emptymultibulk);
7441 return;
7442 }
7443 if (sortval->type != REDIS_SET && sortval->type != REDIS_LIST &&
7444 sortval->type != REDIS_ZSET)
7445 {
7446 addReply(c,shared.wrongtypeerr);
7447 return;
7448 }
7449
7450 /* Create a list of operations to perform for every sorted element.
7451 * Operations can be GET/DEL/INCR/DECR */
7452 operations = listCreate();
7453 listSetFreeMethod(operations,zfree);
7454 j = 2;
7455
7456 /* Now we need to protect sortval incrementing its count, in the future
7457 * SORT may have options able to overwrite/delete keys during the sorting
7458 * and the sorted key itself may get destroied */
7459 incrRefCount(sortval);
7460
7461 /* The SORT command has an SQL-alike syntax, parse it */
7462 while(j < c->argc) {
7463 int leftargs = c->argc-j-1;
7464 if (!strcasecmp(c->argv[j]->ptr,"asc")) {
7465 desc = 0;
7466 } else if (!strcasecmp(c->argv[j]->ptr,"desc")) {
7467 desc = 1;
7468 } else if (!strcasecmp(c->argv[j]->ptr,"alpha")) {
7469 alpha = 1;
7470 } else if (!strcasecmp(c->argv[j]->ptr,"limit") && leftargs >= 2) {
7471 limit_start = atoi(c->argv[j+1]->ptr);
7472 limit_count = atoi(c->argv[j+2]->ptr);
7473 j+=2;
7474 } else if (!strcasecmp(c->argv[j]->ptr,"store") && leftargs >= 1) {
7475 storekey = c->argv[j+1];
7476 j++;
7477 } else if (!strcasecmp(c->argv[j]->ptr,"by") && leftargs >= 1) {
7478 sortby = c->argv[j+1];
7479 /* If the BY pattern does not contain '*', i.e. it is constant,
7480 * we don't need to sort nor to lookup the weight keys. */
7481 if (strchr(c->argv[j+1]->ptr,'*') == NULL) dontsort = 1;
7482 j++;
7483 } else if (!strcasecmp(c->argv[j]->ptr,"get") && leftargs >= 1) {
7484 listAddNodeTail(operations,createSortOperation(
7485 REDIS_SORT_GET,c->argv[j+1]));
7486 getop++;
7487 j++;
7488 } else {
7489 decrRefCount(sortval);
7490 listRelease(operations);
7491 addReply(c,shared.syntaxerr);
7492 return;
7493 }
7494 j++;
7495 }
7496
7497 /* Load the sorting vector with all the objects to sort */
7498 switch(sortval->type) {
7499 case REDIS_LIST: vectorlen = listTypeLength(sortval); break;
7500 case REDIS_SET: vectorlen = dictSize((dict*)sortval->ptr); break;
7501 case REDIS_ZSET: vectorlen = dictSize(((zset*)sortval->ptr)->dict); break;
7502 default: vectorlen = 0; redisPanic("Bad SORT type"); /* Avoid GCC warning */
7503 }
7504 vector = zmalloc(sizeof(redisSortObject)*vectorlen);
7505 j = 0;
7506
7507 if (sortval->type == REDIS_LIST) {
7508 listTypeIterator *li = listTypeInitIterator(sortval,0,REDIS_TAIL);
7509 listTypeEntry entry;
7510 while(listTypeNext(li,&entry)) {
7511 vector[j].obj = listTypeGet(&entry);
7512 vector[j].u.score = 0;
7513 vector[j].u.cmpobj = NULL;
7514 j++;
7515 }
7516 listTypeReleaseIterator(li);
7517 } else {
7518 dict *set;
7519 dictIterator *di;
7520 dictEntry *setele;
7521
7522 if (sortval->type == REDIS_SET) {
7523 set = sortval->ptr;
7524 } else {
7525 zset *zs = sortval->ptr;
7526 set = zs->dict;
7527 }
7528
7529 di = dictGetIterator(set);
7530 while((setele = dictNext(di)) != NULL) {
7531 vector[j].obj = dictGetEntryKey(setele);
7532 vector[j].u.score = 0;
7533 vector[j].u.cmpobj = NULL;
7534 j++;
7535 }
7536 dictReleaseIterator(di);
7537 }
7538 redisAssert(j == vectorlen);
7539
7540 /* Now it's time to load the right scores in the sorting vector */
7541 if (dontsort == 0) {
7542 for (j = 0; j < vectorlen; j++) {
7543 robj *byval;
7544 if (sortby) {
7545 /* lookup value to sort by */
7546 byval = lookupKeyByPattern(c->db,sortby,vector[j].obj);
7547 if (!byval) continue;
7548 } else {
7549 /* use object itself to sort by */
7550 byval = vector[j].obj;
7551 }
7552
7553 if (alpha) {
7554 if (sortby) vector[j].u.cmpobj = getDecodedObject(byval);
7555 } else {
7556 if (byval->encoding == REDIS_ENCODING_RAW) {
7557 vector[j].u.score = strtod(byval->ptr,NULL);
7558 } else if (byval->encoding == REDIS_ENCODING_INT) {
7559 /* Don't need to decode the object if it's
7560 * integer-encoded (the only encoding supported) so
7561 * far. We can just cast it */
7562 vector[j].u.score = (long)byval->ptr;
7563 } else {
7564 redisAssert(1 != 1);
7565 }
7566 }
7567
7568 /* when the object was retrieved using lookupKeyByPattern,
7569 * its refcount needs to be decreased. */
7570 if (sortby) {
7571 decrRefCount(byval);
7572 }
7573 }
7574 }
7575
7576 /* We are ready to sort the vector... perform a bit of sanity check
7577 * on the LIMIT option too. We'll use a partial version of quicksort. */
7578 start = (limit_start < 0) ? 0 : limit_start;
7579 end = (limit_count < 0) ? vectorlen-1 : start+limit_count-1;
7580 if (start >= vectorlen) {
7581 start = vectorlen-1;
7582 end = vectorlen-2;
7583 }
7584 if (end >= vectorlen) end = vectorlen-1;
7585
7586 if (dontsort == 0) {
7587 server.sort_desc = desc;
7588 server.sort_alpha = alpha;
7589 server.sort_bypattern = sortby ? 1 : 0;
7590 if (sortby && (start != 0 || end != vectorlen-1))
7591 pqsort(vector,vectorlen,sizeof(redisSortObject),sortCompare, start,end);
7592 else
7593 qsort(vector,vectorlen,sizeof(redisSortObject),sortCompare);
7594 }
7595
7596 /* Send command output to the output buffer, performing the specified
7597 * GET/DEL/INCR/DECR operations if any. */
7598 outputlen = getop ? getop*(end-start+1) : end-start+1;
7599 if (storekey == NULL) {
7600 /* STORE option not specified, sent the sorting result to client */
7601 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",outputlen));
7602 for (j = start; j <= end; j++) {
7603 listNode *ln;
7604 listIter li;
7605
7606 if (!getop) addReplyBulk(c,vector[j].obj);
7607 listRewind(operations,&li);
7608 while((ln = listNext(&li))) {
7609 redisSortOperation *sop = ln->value;
7610 robj *val = lookupKeyByPattern(c->db,sop->pattern,
7611 vector[j].obj);
7612
7613 if (sop->type == REDIS_SORT_GET) {
7614 if (!val) {
7615 addReply(c,shared.nullbulk);
7616 } else {
7617 addReplyBulk(c,val);
7618 decrRefCount(val);
7619 }
7620 } else {
7621 redisAssert(sop->type == REDIS_SORT_GET); /* always fails */
7622 }
7623 }
7624 }
7625 } else {
7626 robj *sobj = createZiplistObject();
7627
7628 /* STORE option specified, set the sorting result as a List object */
7629 for (j = start; j <= end; j++) {
7630 listNode *ln;
7631 listIter li;
7632
7633 if (!getop) {
7634 listTypePush(sobj,vector[j].obj,REDIS_TAIL);
7635 } else {
7636 listRewind(operations,&li);
7637 while((ln = listNext(&li))) {
7638 redisSortOperation *sop = ln->value;
7639 robj *val = lookupKeyByPattern(c->db,sop->pattern,
7640 vector[j].obj);
7641
7642 if (sop->type == REDIS_SORT_GET) {
7643 if (!val) val = createStringObject("",0);
7644
7645 /* listTypePush does an incrRefCount, so we should take care
7646 * care of the incremented refcount caused by either
7647 * lookupKeyByPattern or createStringObject("",0) */
7648 listTypePush(sobj,val,REDIS_TAIL);
7649 decrRefCount(val);
7650 } else {
7651 /* always fails */
7652 redisAssert(sop->type == REDIS_SORT_GET);
7653 }
7654 }
7655 }
7656 }
7657 dbReplace(c->db,storekey,sobj);
7658 /* Note: we add 1 because the DB is dirty anyway since even if the
7659 * SORT result is empty a new key is set and maybe the old content
7660 * replaced. */
7661 server.dirty += 1+outputlen;
7662 addReplySds(c,sdscatprintf(sdsempty(),":%d\r\n",outputlen));
7663 }
7664
7665 /* Cleanup */
7666 if (sortval->type == REDIS_LIST)
7667 for (j = 0; j < vectorlen; j++)
7668 decrRefCount(vector[j].obj);
7669 decrRefCount(sortval);
7670 listRelease(operations);
7671 for (j = 0; j < vectorlen; j++) {
7672 if (alpha && vector[j].u.cmpobj)
7673 decrRefCount(vector[j].u.cmpobj);
7674 }
7675 zfree(vector);
7676 }
7677
7678 /* Convert an amount of bytes into a human readable string in the form
7679 * of 100B, 2G, 100M, 4K, and so forth. */
7680 static void bytesToHuman(char *s, unsigned long long n) {
7681 double d;
7682
7683 if (n < 1024) {
7684 /* Bytes */
7685 sprintf(s,"%lluB",n);
7686 return;
7687 } else if (n < (1024*1024)) {
7688 d = (double)n/(1024);
7689 sprintf(s,"%.2fK",d);
7690 } else if (n < (1024LL*1024*1024)) {
7691 d = (double)n/(1024*1024);
7692 sprintf(s,"%.2fM",d);
7693 } else if (n < (1024LL*1024*1024*1024)) {
7694 d = (double)n/(1024LL*1024*1024);
7695 sprintf(s,"%.2fG",d);
7696 }
7697 }
7698
7699 /* Create the string returned by the INFO command. This is decoupled
7700 * by the INFO command itself as we need to report the same information
7701 * on memory corruption problems. */
7702 static sds genRedisInfoString(void) {
7703 sds info;
7704 time_t uptime = time(NULL)-server.stat_starttime;
7705 int j;
7706 char hmem[64];
7707
7708 bytesToHuman(hmem,zmalloc_used_memory());
7709 info = sdscatprintf(sdsempty(),
7710 "redis_version:%s\r\n"
7711 "redis_git_sha1:%s\r\n"
7712 "redis_git_dirty:%d\r\n"
7713 "arch_bits:%s\r\n"
7714 "multiplexing_api:%s\r\n"
7715 "process_id:%ld\r\n"
7716 "uptime_in_seconds:%ld\r\n"
7717 "uptime_in_days:%ld\r\n"
7718 "connected_clients:%d\r\n"
7719 "connected_slaves:%d\r\n"
7720 "blocked_clients:%d\r\n"
7721 "used_memory:%zu\r\n"
7722 "used_memory_human:%s\r\n"
7723 "changes_since_last_save:%lld\r\n"
7724 "bgsave_in_progress:%d\r\n"
7725 "last_save_time:%ld\r\n"
7726 "bgrewriteaof_in_progress:%d\r\n"
7727 "total_connections_received:%lld\r\n"
7728 "total_commands_processed:%lld\r\n"
7729 "expired_keys:%lld\r\n"
7730 "hash_max_zipmap_entries:%zu\r\n"
7731 "hash_max_zipmap_value:%zu\r\n"
7732 "pubsub_channels:%ld\r\n"
7733 "pubsub_patterns:%u\r\n"
7734 "vm_enabled:%d\r\n"
7735 "role:%s\r\n"
7736 ,REDIS_VERSION,
7737 REDIS_GIT_SHA1,
7738 strtol(REDIS_GIT_DIRTY,NULL,10) > 0,
7739 (sizeof(long) == 8) ? "64" : "32",
7740 aeGetApiName(),
7741 (long) getpid(),
7742 uptime,
7743 uptime/(3600*24),
7744 listLength(server.clients)-listLength(server.slaves),
7745 listLength(server.slaves),
7746 server.blpop_blocked_clients,
7747 zmalloc_used_memory(),
7748 hmem,
7749 server.dirty,
7750 server.bgsavechildpid != -1,
7751 server.lastsave,
7752 server.bgrewritechildpid != -1,
7753 server.stat_numconnections,
7754 server.stat_numcommands,
7755 server.stat_expiredkeys,
7756 server.hash_max_zipmap_entries,
7757 server.hash_max_zipmap_value,
7758 dictSize(server.pubsub_channels),
7759 listLength(server.pubsub_patterns),
7760 server.vm_enabled != 0,
7761 server.masterhost == NULL ? "master" : "slave"
7762 );
7763 if (server.masterhost) {
7764 info = sdscatprintf(info,
7765 "master_host:%s\r\n"
7766 "master_port:%d\r\n"
7767 "master_link_status:%s\r\n"
7768 "master_last_io_seconds_ago:%d\r\n"
7769 ,server.masterhost,
7770 server.masterport,
7771 (server.replstate == REDIS_REPL_CONNECTED) ?
7772 "up" : "down",
7773 server.master ? ((int)(time(NULL)-server.master->lastinteraction)) : -1
7774 );
7775 }
7776 if (server.vm_enabled) {
7777 lockThreadedIO();
7778 info = sdscatprintf(info,
7779 "vm_conf_max_memory:%llu\r\n"
7780 "vm_conf_page_size:%llu\r\n"
7781 "vm_conf_pages:%llu\r\n"
7782 "vm_stats_used_pages:%llu\r\n"
7783 "vm_stats_swapped_objects:%llu\r\n"
7784 "vm_stats_swappin_count:%llu\r\n"
7785 "vm_stats_swappout_count:%llu\r\n"
7786 "vm_stats_io_newjobs_len:%lu\r\n"
7787 "vm_stats_io_processing_len:%lu\r\n"
7788 "vm_stats_io_processed_len:%lu\r\n"
7789 "vm_stats_io_active_threads:%lu\r\n"
7790 "vm_stats_blocked_clients:%lu\r\n"
7791 ,(unsigned long long) server.vm_max_memory,
7792 (unsigned long long) server.vm_page_size,
7793 (unsigned long long) server.vm_pages,
7794 (unsigned long long) server.vm_stats_used_pages,
7795 (unsigned long long) server.vm_stats_swapped_objects,
7796 (unsigned long long) server.vm_stats_swapins,
7797 (unsigned long long) server.vm_stats_swapouts,
7798 (unsigned long) listLength(server.io_newjobs),
7799 (unsigned long) listLength(server.io_processing),
7800 (unsigned long) listLength(server.io_processed),
7801 (unsigned long) server.io_active_threads,
7802 (unsigned long) server.vm_blocked_clients
7803 );
7804 unlockThreadedIO();
7805 }
7806 for (j = 0; j < server.dbnum; j++) {
7807 long long keys, vkeys;
7808
7809 keys = dictSize(server.db[j].dict);
7810 vkeys = dictSize(server.db[j].expires);
7811 if (keys || vkeys) {
7812 info = sdscatprintf(info, "db%d:keys=%lld,expires=%lld\r\n",
7813 j, keys, vkeys);
7814 }
7815 }
7816 return info;
7817 }
7818
7819 static void infoCommand(redisClient *c) {
7820 sds info = genRedisInfoString();
7821 addReplySds(c,sdscatprintf(sdsempty(),"$%lu\r\n",
7822 (unsigned long)sdslen(info)));
7823 addReplySds(c,info);
7824 addReply(c,shared.crlf);
7825 }
7826
7827 static void monitorCommand(redisClient *c) {
7828 /* ignore MONITOR if aleady slave or in monitor mode */
7829 if (c->flags & REDIS_SLAVE) return;
7830
7831 c->flags |= (REDIS_SLAVE|REDIS_MONITOR);
7832 c->slaveseldb = 0;
7833 listAddNodeTail(server.monitors,c);
7834 addReply(c,shared.ok);
7835 }
7836
7837 /* ================================= Expire ================================= */
7838 static int removeExpire(redisDb *db, robj *key) {
7839 if (dictDelete(db->expires,key->ptr) == DICT_OK) {
7840 return 1;
7841 } else {
7842 return 0;
7843 }
7844 }
7845
7846 static int setExpire(redisDb *db, robj *key, time_t when) {
7847 sds copy = sdsdup(key->ptr);
7848 if (dictAdd(db->expires,copy,(void*)when) == DICT_ERR) {
7849 sdsfree(copy);
7850 return 0;
7851 } else {
7852 return 1;
7853 }
7854 }
7855
7856 /* Return the expire time of the specified key, or -1 if no expire
7857 * is associated with this key (i.e. the key is non volatile) */
7858 static time_t getExpire(redisDb *db, robj *key) {
7859 dictEntry *de;
7860
7861 /* No expire? return ASAP */
7862 if (dictSize(db->expires) == 0 ||
7863 (de = dictFind(db->expires,key->ptr)) == NULL) return -1;
7864
7865 return (time_t) dictGetEntryVal(de);
7866 }
7867
7868 static int expireIfNeeded(redisDb *db, robj *key) {
7869 time_t when;
7870 dictEntry *de;
7871
7872 /* No expire? return ASAP */
7873 if (dictSize(db->expires) == 0 ||
7874 (de = dictFind(db->expires,key->ptr)) == NULL) return 0;
7875
7876 /* Lookup the expire */
7877 when = (time_t) dictGetEntryVal(de);
7878 if (time(NULL) <= when) return 0;
7879
7880 /* Delete the key */
7881 dbDelete(db,key);
7882 server.stat_expiredkeys++;
7883 return 1;
7884 }
7885
7886 static int deleteIfVolatile(redisDb *db, robj *key) {
7887 dictEntry *de;
7888
7889 /* No expire? return ASAP */
7890 if (dictSize(db->expires) == 0 ||
7891 (de = dictFind(db->expires,key->ptr)) == NULL) return 0;
7892
7893 /* Delete the key */
7894 server.dirty++;
7895 server.stat_expiredkeys++;
7896 dictDelete(db->expires,key->ptr);
7897 return dictDelete(db->dict,key->ptr) == DICT_OK;
7898 }
7899
7900 static void expireGenericCommand(redisClient *c, robj *key, robj *param, long offset) {
7901 dictEntry *de;
7902 time_t seconds;
7903
7904 if (getLongFromObjectOrReply(c, param, &seconds, NULL) != REDIS_OK) return;
7905
7906 seconds -= offset;
7907
7908 de = dictFind(c->db->dict,key->ptr);
7909 if (de == NULL) {
7910 addReply(c,shared.czero);
7911 return;
7912 }
7913 if (seconds <= 0) {
7914 if (dbDelete(c->db,key)) server.dirty++;
7915 addReply(c, shared.cone);
7916 return;
7917 } else {
7918 time_t when = time(NULL)+seconds;
7919 if (setExpire(c->db,key,when)) {
7920 addReply(c,shared.cone);
7921 server.dirty++;
7922 } else {
7923 addReply(c,shared.czero);
7924 }
7925 return;
7926 }
7927 }
7928
7929 static void expireCommand(redisClient *c) {
7930 expireGenericCommand(c,c->argv[1],c->argv[2],0);
7931 }
7932
7933 static void expireatCommand(redisClient *c) {
7934 expireGenericCommand(c,c->argv[1],c->argv[2],time(NULL));
7935 }
7936
7937 static void ttlCommand(redisClient *c) {
7938 time_t expire;
7939 int ttl = -1;
7940
7941 expire = getExpire(c->db,c->argv[1]);
7942 if (expire != -1) {
7943 ttl = (int) (expire-time(NULL));
7944 if (ttl < 0) ttl = -1;
7945 }
7946 addReplySds(c,sdscatprintf(sdsempty(),":%d\r\n",ttl));
7947 }
7948
7949 /* ================================ MULTI/EXEC ============================== */
7950
7951 /* Client state initialization for MULTI/EXEC */
7952 static void initClientMultiState(redisClient *c) {
7953 c->mstate.commands = NULL;
7954 c->mstate.count = 0;
7955 }
7956
7957 /* Release all the resources associated with MULTI/EXEC state */
7958 static void freeClientMultiState(redisClient *c) {
7959 int j;
7960
7961 for (j = 0; j < c->mstate.count; j++) {
7962 int i;
7963 multiCmd *mc = c->mstate.commands+j;
7964
7965 for (i = 0; i < mc->argc; i++)
7966 decrRefCount(mc->argv[i]);
7967 zfree(mc->argv);
7968 }
7969 zfree(c->mstate.commands);
7970 }
7971
7972 /* Add a new command into the MULTI commands queue */
7973 static void queueMultiCommand(redisClient *c, struct redisCommand *cmd) {
7974 multiCmd *mc;
7975 int j;
7976
7977 c->mstate.commands = zrealloc(c->mstate.commands,
7978 sizeof(multiCmd)*(c->mstate.count+1));
7979 mc = c->mstate.commands+c->mstate.count;
7980 mc->cmd = cmd;
7981 mc->argc = c->argc;
7982 mc->argv = zmalloc(sizeof(robj*)*c->argc);
7983 memcpy(mc->argv,c->argv,sizeof(robj*)*c->argc);
7984 for (j = 0; j < c->argc; j++)
7985 incrRefCount(mc->argv[j]);
7986 c->mstate.count++;
7987 }
7988
7989 static void multiCommand(redisClient *c) {
7990 if (c->flags & REDIS_MULTI) {
7991 addReplySds(c,sdsnew("-ERR MULTI calls can not be nested\r\n"));
7992 return;
7993 }
7994 c->flags |= REDIS_MULTI;
7995 addReply(c,shared.ok);
7996 }
7997
7998 static void discardCommand(redisClient *c) {
7999 if (!(c->flags & REDIS_MULTI)) {
8000 addReplySds(c,sdsnew("-ERR DISCARD without MULTI\r\n"));
8001 return;
8002 }
8003
8004 freeClientMultiState(c);
8005 initClientMultiState(c);
8006 c->flags &= (~REDIS_MULTI);
8007 addReply(c,shared.ok);
8008 }
8009
8010 /* Send a MULTI command to all the slaves and AOF file. Check the execCommand
8011 * implememntation for more information. */
8012 static void execCommandReplicateMulti(redisClient *c) {
8013 struct redisCommand *cmd;
8014 robj *multistring = createStringObject("MULTI",5);
8015
8016 cmd = lookupCommand("multi");
8017 if (server.appendonly)
8018 feedAppendOnlyFile(cmd,c->db->id,&multistring,1);
8019 if (listLength(server.slaves))
8020 replicationFeedSlaves(server.slaves,c->db->id,&multistring,1);
8021 decrRefCount(multistring);
8022 }
8023
8024 static void execCommand(redisClient *c) {
8025 int j;
8026 robj **orig_argv;
8027 int orig_argc;
8028
8029 if (!(c->flags & REDIS_MULTI)) {
8030 addReplySds(c,sdsnew("-ERR EXEC without MULTI\r\n"));
8031 return;
8032 }
8033
8034 /* Check if we need to abort the EXEC if some WATCHed key was touched.
8035 * A failed EXEC will return a multi bulk nil object. */
8036 if (c->flags & REDIS_DIRTY_CAS) {
8037 freeClientMultiState(c);
8038 initClientMultiState(c);
8039 c->flags &= ~(REDIS_MULTI|REDIS_DIRTY_CAS);
8040 unwatchAllKeys(c);
8041 addReply(c,shared.nullmultibulk);
8042 return;
8043 }
8044
8045 /* Replicate a MULTI request now that we are sure the block is executed.
8046 * This way we'll deliver the MULTI/..../EXEC block as a whole and
8047 * both the AOF and the replication link will have the same consistency
8048 * and atomicity guarantees. */
8049 execCommandReplicateMulti(c);
8050
8051 /* Exec all the queued commands */
8052 unwatchAllKeys(c); /* Unwatch ASAP otherwise we'll waste CPU cycles */
8053 orig_argv = c->argv;
8054 orig_argc = c->argc;
8055 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",c->mstate.count));
8056 for (j = 0; j < c->mstate.count; j++) {
8057 c->argc = c->mstate.commands[j].argc;
8058 c->argv = c->mstate.commands[j].argv;
8059 call(c,c->mstate.commands[j].cmd);
8060 }
8061 c->argv = orig_argv;
8062 c->argc = orig_argc;
8063 freeClientMultiState(c);
8064 initClientMultiState(c);
8065 c->flags &= ~(REDIS_MULTI|REDIS_DIRTY_CAS);
8066 /* Make sure the EXEC command is always replicated / AOF, since we
8067 * always send the MULTI command (we can't know beforehand if the
8068 * next operations will contain at least a modification to the DB). */
8069 server.dirty++;
8070 }
8071
8072 /* =========================== Blocking Operations ========================= */
8073
8074 /* Currently Redis blocking operations support is limited to list POP ops,
8075 * so the current implementation is not fully generic, but it is also not
8076 * completely specific so it will not require a rewrite to support new
8077 * kind of blocking operations in the future.
8078 *
8079 * Still it's important to note that list blocking operations can be already
8080 * used as a notification mechanism in order to implement other blocking
8081 * operations at application level, so there must be a very strong evidence
8082 * of usefulness and generality before new blocking operations are implemented.
8083 *
8084 * This is how the current blocking POP works, we use BLPOP as example:
8085 * - If the user calls BLPOP and the key exists and contains a non empty list
8086 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
8087 * if there is not to block.
8088 * - If instead BLPOP is called and the key does not exists or the list is
8089 * empty we need to block. In order to do so we remove the notification for
8090 * new data to read in the client socket (so that we'll not serve new
8091 * requests if the blocking request is not served). Also we put the client
8092 * in a dictionary (db->blocking_keys) mapping keys to a list of clients
8093 * blocking for this keys.
8094 * - If a PUSH operation against a key with blocked clients waiting is
8095 * performed, we serve the first in the list: basically instead to push
8096 * the new element inside the list we return it to the (first / oldest)
8097 * blocking client, unblock the client, and remove it form the list.
8098 *
8099 * The above comment and the source code should be enough in order to understand
8100 * the implementation and modify / fix it later.
8101 */
8102
8103 /* Set a client in blocking mode for the specified key, with the specified
8104 * timeout */
8105 static void blockForKeys(redisClient *c, robj **keys, int numkeys, time_t timeout) {
8106 dictEntry *de;
8107 list *l;
8108 int j;
8109
8110 c->blocking_keys = zmalloc(sizeof(robj*)*numkeys);
8111 c->blocking_keys_num = numkeys;
8112 c->blockingto = timeout;
8113 for (j = 0; j < numkeys; j++) {
8114 /* Add the key in the client structure, to map clients -> keys */
8115 c->blocking_keys[j] = keys[j];
8116 incrRefCount(keys[j]);
8117
8118 /* And in the other "side", to map keys -> clients */
8119 de = dictFind(c->db->blocking_keys,keys[j]);
8120 if (de == NULL) {
8121 int retval;
8122
8123 /* For every key we take a list of clients blocked for it */
8124 l = listCreate();
8125 retval = dictAdd(c->db->blocking_keys,keys[j],l);
8126 incrRefCount(keys[j]);
8127 assert(retval == DICT_OK);
8128 } else {
8129 l = dictGetEntryVal(de);
8130 }
8131 listAddNodeTail(l,c);
8132 }
8133 /* Mark the client as a blocked client */
8134 c->flags |= REDIS_BLOCKED;
8135 server.blpop_blocked_clients++;
8136 }
8137
8138 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
8139 static void unblockClientWaitingData(redisClient *c) {
8140 dictEntry *de;
8141 list *l;
8142 int j;
8143
8144 assert(c->blocking_keys != NULL);
8145 /* The client may wait for multiple keys, so unblock it for every key. */
8146 for (j = 0; j < c->blocking_keys_num; j++) {
8147 /* Remove this client from the list of clients waiting for this key. */
8148 de = dictFind(c->db->blocking_keys,c->blocking_keys[j]);
8149 assert(de != NULL);
8150 l = dictGetEntryVal(de);
8151 listDelNode(l,listSearchKey(l,c));
8152 /* If the list is empty we need to remove it to avoid wasting memory */
8153 if (listLength(l) == 0)
8154 dictDelete(c->db->blocking_keys,c->blocking_keys[j]);
8155 decrRefCount(c->blocking_keys[j]);
8156 }
8157 /* Cleanup the client structure */
8158 zfree(c->blocking_keys);
8159 c->blocking_keys = NULL;
8160 c->flags &= (~REDIS_BLOCKED);
8161 server.blpop_blocked_clients--;
8162 /* We want to process data if there is some command waiting
8163 * in the input buffer. Note that this is safe even if
8164 * unblockClientWaitingData() gets called from freeClient() because
8165 * freeClient() will be smart enough to call this function
8166 * *after* c->querybuf was set to NULL. */
8167 if (c->querybuf && sdslen(c->querybuf) > 0) processInputBuffer(c);
8168 }
8169
8170 /* This should be called from any function PUSHing into lists.
8171 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
8172 * 'ele' is the element pushed.
8173 *
8174 * If the function returns 0 there was no client waiting for a list push
8175 * against this key.
8176 *
8177 * If the function returns 1 there was a client waiting for a list push
8178 * against this key, the element was passed to this client thus it's not
8179 * needed to actually add it to the list and the caller should return asap. */
8180 static int handleClientsWaitingListPush(redisClient *c, robj *key, robj *ele) {
8181 struct dictEntry *de;
8182 redisClient *receiver;
8183 list *l;
8184 listNode *ln;
8185
8186 de = dictFind(c->db->blocking_keys,key);
8187 if (de == NULL) return 0;
8188 l = dictGetEntryVal(de);
8189 ln = listFirst(l);
8190 assert(ln != NULL);
8191 receiver = ln->value;
8192
8193 addReplySds(receiver,sdsnew("*2\r\n"));
8194 addReplyBulk(receiver,key);
8195 addReplyBulk(receiver,ele);
8196 unblockClientWaitingData(receiver);
8197 return 1;
8198 }
8199
8200 /* Blocking RPOP/LPOP */
8201 static void blockingPopGenericCommand(redisClient *c, int where) {
8202 robj *o;
8203 time_t timeout;
8204 int j;
8205
8206 for (j = 1; j < c->argc-1; j++) {
8207 o = lookupKeyWrite(c->db,c->argv[j]);
8208 if (o != NULL) {
8209 if (o->type != REDIS_LIST) {
8210 addReply(c,shared.wrongtypeerr);
8211 return;
8212 } else {
8213 list *list = o->ptr;
8214 if (listLength(list) != 0) {
8215 /* If the list contains elements fall back to the usual
8216 * non-blocking POP operation */
8217 robj *argv[2], **orig_argv;
8218 int orig_argc;
8219
8220 /* We need to alter the command arguments before to call
8221 * popGenericCommand() as the command takes a single key. */
8222 orig_argv = c->argv;
8223 orig_argc = c->argc;
8224 argv[1] = c->argv[j];
8225 c->argv = argv;
8226 c->argc = 2;
8227
8228 /* Also the return value is different, we need to output
8229 * the multi bulk reply header and the key name. The
8230 * "real" command will add the last element (the value)
8231 * for us. If this souds like an hack to you it's just
8232 * because it is... */
8233 addReplySds(c,sdsnew("*2\r\n"));
8234 addReplyBulk(c,argv[1]);
8235 popGenericCommand(c,where);
8236
8237 /* Fix the client structure with the original stuff */
8238 c->argv = orig_argv;
8239 c->argc = orig_argc;
8240 return;
8241 }
8242 }
8243 }
8244 }
8245 /* If the list is empty or the key does not exists we must block */
8246 timeout = strtol(c->argv[c->argc-1]->ptr,NULL,10);
8247 if (timeout > 0) timeout += time(NULL);
8248 blockForKeys(c,c->argv+1,c->argc-2,timeout);
8249 }
8250
8251 static void blpopCommand(redisClient *c) {
8252 blockingPopGenericCommand(c,REDIS_HEAD);
8253 }
8254
8255 static void brpopCommand(redisClient *c) {
8256 blockingPopGenericCommand(c,REDIS_TAIL);
8257 }
8258
8259 /* =============================== Replication ============================= */
8260
8261 static int syncWrite(int fd, char *ptr, ssize_t size, int timeout) {
8262 ssize_t nwritten, ret = size;
8263 time_t start = time(NULL);
8264
8265 timeout++;
8266 while(size) {
8267 if (aeWait(fd,AE_WRITABLE,1000) & AE_WRITABLE) {
8268 nwritten = write(fd,ptr,size);
8269 if (nwritten == -1) return -1;
8270 ptr += nwritten;
8271 size -= nwritten;
8272 }
8273 if ((time(NULL)-start) > timeout) {
8274 errno = ETIMEDOUT;
8275 return -1;
8276 }
8277 }
8278 return ret;
8279 }
8280
8281 static int syncRead(int fd, char *ptr, ssize_t size, int timeout) {
8282 ssize_t nread, totread = 0;
8283 time_t start = time(NULL);
8284
8285 timeout++;
8286 while(size) {
8287 if (aeWait(fd,AE_READABLE,1000) & AE_READABLE) {
8288 nread = read(fd,ptr,size);
8289 if (nread == -1) return -1;
8290 ptr += nread;
8291 size -= nread;
8292 totread += nread;
8293 }
8294 if ((time(NULL)-start) > timeout) {
8295 errno = ETIMEDOUT;
8296 return -1;
8297 }
8298 }
8299 return totread;
8300 }
8301
8302 static int syncReadLine(int fd, char *ptr, ssize_t size, int timeout) {
8303 ssize_t nread = 0;
8304
8305 size--;
8306 while(size) {
8307 char c;
8308
8309 if (syncRead(fd,&c,1,timeout) == -1) return -1;
8310 if (c == '\n') {
8311 *ptr = '\0';
8312 if (nread && *(ptr-1) == '\r') *(ptr-1) = '\0';
8313 return nread;
8314 } else {
8315 *ptr++ = c;
8316 *ptr = '\0';
8317 nread++;
8318 }
8319 }
8320 return nread;
8321 }
8322
8323 static void syncCommand(redisClient *c) {
8324 /* ignore SYNC if aleady slave or in monitor mode */
8325 if (c->flags & REDIS_SLAVE) return;
8326
8327 /* SYNC can't be issued when the server has pending data to send to
8328 * the client about already issued commands. We need a fresh reply
8329 * buffer registering the differences between the BGSAVE and the current
8330 * dataset, so that we can copy to other slaves if needed. */
8331 if (listLength(c->reply) != 0) {
8332 addReplySds(c,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
8333 return;
8334 }
8335
8336 redisLog(REDIS_NOTICE,"Slave ask for synchronization");
8337 /* Here we need to check if there is a background saving operation
8338 * in progress, or if it is required to start one */
8339 if (server.bgsavechildpid != -1) {
8340 /* Ok a background save is in progress. Let's check if it is a good
8341 * one for replication, i.e. if there is another slave that is
8342 * registering differences since the server forked to save */
8343 redisClient *slave;
8344 listNode *ln;
8345 listIter li;
8346
8347 listRewind(server.slaves,&li);
8348 while((ln = listNext(&li))) {
8349 slave = ln->value;
8350 if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_END) break;
8351 }
8352 if (ln) {
8353 /* Perfect, the server is already registering differences for
8354 * another slave. Set the right state, and copy the buffer. */
8355 listRelease(c->reply);
8356 c->reply = listDup(slave->reply);
8357 c->replstate = REDIS_REPL_WAIT_BGSAVE_END;
8358 redisLog(REDIS_NOTICE,"Waiting for end of BGSAVE for SYNC");
8359 } else {
8360 /* No way, we need to wait for the next BGSAVE in order to
8361 * register differences */
8362 c->replstate = REDIS_REPL_WAIT_BGSAVE_START;
8363 redisLog(REDIS_NOTICE,"Waiting for next BGSAVE for SYNC");
8364 }
8365 } else {
8366 /* Ok we don't have a BGSAVE in progress, let's start one */
8367 redisLog(REDIS_NOTICE,"Starting BGSAVE for SYNC");
8368 if (rdbSaveBackground(server.dbfilename) != REDIS_OK) {
8369 redisLog(REDIS_NOTICE,"Replication failed, can't BGSAVE");
8370 addReplySds(c,sdsnew("-ERR Unalbe to perform background save\r\n"));
8371 return;
8372 }
8373 c->replstate = REDIS_REPL_WAIT_BGSAVE_END;
8374 }
8375 c->repldbfd = -1;
8376 c->flags |= REDIS_SLAVE;
8377 c->slaveseldb = 0;
8378 listAddNodeTail(server.slaves,c);
8379 return;
8380 }
8381
8382 static void sendBulkToSlave(aeEventLoop *el, int fd, void *privdata, int mask) {
8383 redisClient *slave = privdata;
8384 REDIS_NOTUSED(el);
8385 REDIS_NOTUSED(mask);
8386 char buf[REDIS_IOBUF_LEN];
8387 ssize_t nwritten, buflen;
8388
8389 if (slave->repldboff == 0) {
8390 /* Write the bulk write count before to transfer the DB. In theory here
8391 * we don't know how much room there is in the output buffer of the
8392 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
8393 * operations) will never be smaller than the few bytes we need. */
8394 sds bulkcount;
8395
8396 bulkcount = sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
8397 slave->repldbsize);
8398 if (write(fd,bulkcount,sdslen(bulkcount)) != (signed)sdslen(bulkcount))
8399 {
8400 sdsfree(bulkcount);
8401 freeClient(slave);
8402 return;
8403 }
8404 sdsfree(bulkcount);
8405 }
8406 lseek(slave->repldbfd,slave->repldboff,SEEK_SET);
8407 buflen = read(slave->repldbfd,buf,REDIS_IOBUF_LEN);
8408 if (buflen <= 0) {
8409 redisLog(REDIS_WARNING,"Read error sending DB to slave: %s",
8410 (buflen == 0) ? "premature EOF" : strerror(errno));
8411 freeClient(slave);
8412 return;
8413 }
8414 if ((nwritten = write(fd,buf,buflen)) == -1) {
8415 redisLog(REDIS_VERBOSE,"Write error sending DB to slave: %s",
8416 strerror(errno));
8417 freeClient(slave);
8418 return;
8419 }
8420 slave->repldboff += nwritten;
8421 if (slave->repldboff == slave->repldbsize) {
8422 close(slave->repldbfd);
8423 slave->repldbfd = -1;
8424 aeDeleteFileEvent(server.el,slave->fd,AE_WRITABLE);
8425 slave->replstate = REDIS_REPL_ONLINE;
8426 if (aeCreateFileEvent(server.el, slave->fd, AE_WRITABLE,
8427 sendReplyToClient, slave) == AE_ERR) {
8428 freeClient(slave);
8429 return;
8430 }
8431 addReplySds(slave,sdsempty());
8432 redisLog(REDIS_NOTICE,"Synchronization with slave succeeded");
8433 }
8434 }
8435
8436 /* This function is called at the end of every backgrond saving.
8437 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
8438 * otherwise REDIS_ERR is passed to the function.
8439 *
8440 * The goal of this function is to handle slaves waiting for a successful
8441 * background saving in order to perform non-blocking synchronization. */
8442 static void updateSlavesWaitingBgsave(int bgsaveerr) {
8443 listNode *ln;
8444 int startbgsave = 0;
8445 listIter li;
8446
8447 listRewind(server.slaves,&li);
8448 while((ln = listNext(&li))) {
8449 redisClient *slave = ln->value;
8450
8451 if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_START) {
8452 startbgsave = 1;
8453 slave->replstate = REDIS_REPL_WAIT_BGSAVE_END;
8454 } else if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_END) {
8455 struct redis_stat buf;
8456
8457 if (bgsaveerr != REDIS_OK) {
8458 freeClient(slave);
8459 redisLog(REDIS_WARNING,"SYNC failed. BGSAVE child returned an error");
8460 continue;
8461 }
8462 if ((slave->repldbfd = open(server.dbfilename,O_RDONLY)) == -1 ||
8463 redis_fstat(slave->repldbfd,&buf) == -1) {
8464 freeClient(slave);
8465 redisLog(REDIS_WARNING,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno));
8466 continue;
8467 }
8468 slave->repldboff = 0;
8469 slave->repldbsize = buf.st_size;
8470 slave->replstate = REDIS_REPL_SEND_BULK;
8471 aeDeleteFileEvent(server.el,slave->fd,AE_WRITABLE);
8472 if (aeCreateFileEvent(server.el, slave->fd, AE_WRITABLE, sendBulkToSlave, slave) == AE_ERR) {
8473 freeClient(slave);
8474 continue;
8475 }
8476 }
8477 }
8478 if (startbgsave) {
8479 if (rdbSaveBackground(server.dbfilename) != REDIS_OK) {
8480 listIter li;
8481
8482 listRewind(server.slaves,&li);
8483 redisLog(REDIS_WARNING,"SYNC failed. BGSAVE failed");
8484 while((ln = listNext(&li))) {
8485 redisClient *slave = ln->value;
8486
8487 if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_START)
8488 freeClient(slave);
8489 }
8490 }
8491 }
8492 }
8493
8494 static int syncWithMaster(void) {
8495 char buf[1024], tmpfile[256], authcmd[1024];
8496 long dumpsize;
8497 int fd = anetTcpConnect(NULL,server.masterhost,server.masterport);
8498 int dfd, maxtries = 5;
8499
8500 if (fd == -1) {
8501 redisLog(REDIS_WARNING,"Unable to connect to MASTER: %s",
8502 strerror(errno));
8503 return REDIS_ERR;
8504 }
8505
8506 /* AUTH with the master if required. */
8507 if(server.masterauth) {
8508 snprintf(authcmd, 1024, "AUTH %s\r\n", server.masterauth);
8509 if (syncWrite(fd, authcmd, strlen(server.masterauth)+7, 5) == -1) {
8510 close(fd);
8511 redisLog(REDIS_WARNING,"Unable to AUTH to MASTER: %s",
8512 strerror(errno));
8513 return REDIS_ERR;
8514 }
8515 /* Read the AUTH result. */
8516 if (syncReadLine(fd,buf,1024,3600) == -1) {
8517 close(fd);
8518 redisLog(REDIS_WARNING,"I/O error reading auth result from MASTER: %s",
8519 strerror(errno));
8520 return REDIS_ERR;
8521 }
8522 if (buf[0] != '+') {
8523 close(fd);
8524 redisLog(REDIS_WARNING,"Cannot AUTH to MASTER, is the masterauth password correct?");
8525 return REDIS_ERR;
8526 }
8527 }
8528
8529 /* Issue the SYNC command */
8530 if (syncWrite(fd,"SYNC \r\n",7,5) == -1) {
8531 close(fd);
8532 redisLog(REDIS_WARNING,"I/O error writing to MASTER: %s",
8533 strerror(errno));
8534 return REDIS_ERR;
8535 }
8536 /* Read the bulk write count */
8537 if (syncReadLine(fd,buf,1024,3600) == -1) {
8538 close(fd);
8539 redisLog(REDIS_WARNING,"I/O error reading bulk count from MASTER: %s",
8540 strerror(errno));
8541 return REDIS_ERR;
8542 }
8543 if (buf[0] != '$') {
8544 close(fd);
8545 redisLog(REDIS_WARNING,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
8546 return REDIS_ERR;
8547 }
8548 dumpsize = strtol(buf+1,NULL,10);
8549 redisLog(REDIS_NOTICE,"Receiving %ld bytes data dump from MASTER",dumpsize);
8550 /* Read the bulk write data on a temp file */
8551 while(maxtries--) {
8552 snprintf(tmpfile,256,
8553 "temp-%d.%ld.rdb",(int)time(NULL),(long int)getpid());
8554 dfd = open(tmpfile,O_CREAT|O_WRONLY|O_EXCL,0644);
8555 if (dfd != -1) break;
8556 sleep(1);
8557 }
8558 if (dfd == -1) {
8559 close(fd);
8560 redisLog(REDIS_WARNING,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno));
8561 return REDIS_ERR;
8562 }
8563 while(dumpsize) {
8564 int nread, nwritten;
8565
8566 nread = read(fd,buf,(dumpsize < 1024)?dumpsize:1024);
8567 if (nread == -1) {
8568 redisLog(REDIS_WARNING,"I/O error trying to sync with MASTER: %s",
8569 strerror(errno));
8570 close(fd);
8571 close(dfd);
8572 return REDIS_ERR;
8573 }
8574 nwritten = write(dfd,buf,nread);
8575 if (nwritten == -1) {
8576 redisLog(REDIS_WARNING,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno));
8577 close(fd);
8578 close(dfd);
8579 return REDIS_ERR;
8580 }
8581 dumpsize -= nread;
8582 }
8583 close(dfd);
8584 if (rename(tmpfile,server.dbfilename) == -1) {
8585 redisLog(REDIS_WARNING,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno));
8586 unlink(tmpfile);
8587 close(fd);
8588 return REDIS_ERR;
8589 }
8590 emptyDb();
8591 if (rdbLoad(server.dbfilename) != REDIS_OK) {
8592 redisLog(REDIS_WARNING,"Failed trying to load the MASTER synchronization DB from disk");
8593 close(fd);
8594 return REDIS_ERR;
8595 }
8596 server.master = createClient(fd);
8597 server.master->flags |= REDIS_MASTER;
8598 server.master->authenticated = 1;
8599 server.replstate = REDIS_REPL_CONNECTED;
8600 return REDIS_OK;
8601 }
8602
8603 static void slaveofCommand(redisClient *c) {
8604 if (!strcasecmp(c->argv[1]->ptr,"no") &&
8605 !strcasecmp(c->argv[2]->ptr,"one")) {
8606 if (server.masterhost) {
8607 sdsfree(server.masterhost);
8608 server.masterhost = NULL;
8609 if (server.master) freeClient(server.master);
8610 server.replstate = REDIS_REPL_NONE;
8611 redisLog(REDIS_NOTICE,"MASTER MODE enabled (user request)");
8612 }
8613 } else {
8614 sdsfree(server.masterhost);
8615 server.masterhost = sdsdup(c->argv[1]->ptr);
8616 server.masterport = atoi(c->argv[2]->ptr);
8617 if (server.master) freeClient(server.master);
8618 server.replstate = REDIS_REPL_CONNECT;
8619 redisLog(REDIS_NOTICE,"SLAVE OF %s:%d enabled (user request)",
8620 server.masterhost, server.masterport);
8621 }
8622 addReply(c,shared.ok);
8623 }
8624
8625 /* ============================ Maxmemory directive ======================== */
8626
8627 /* Try to free one object form the pre-allocated objects free list.
8628 * This is useful under low mem conditions as by default we take 1 million
8629 * free objects allocated. On success REDIS_OK is returned, otherwise
8630 * REDIS_ERR. */
8631 static int tryFreeOneObjectFromFreelist(void) {
8632 robj *o;
8633
8634 if (server.vm_enabled) pthread_mutex_lock(&server.obj_freelist_mutex);
8635 if (listLength(server.objfreelist)) {
8636 listNode *head = listFirst(server.objfreelist);
8637 o = listNodeValue(head);
8638 listDelNode(server.objfreelist,head);
8639 if (server.vm_enabled) pthread_mutex_unlock(&server.obj_freelist_mutex);
8640 zfree(o);
8641 return REDIS_OK;
8642 } else {
8643 if (server.vm_enabled) pthread_mutex_unlock(&server.obj_freelist_mutex);
8644 return REDIS_ERR;
8645 }
8646 }
8647
8648 /* This function gets called when 'maxmemory' is set on the config file to limit
8649 * the max memory used by the server, and we are out of memory.
8650 * This function will try to, in order:
8651 *
8652 * - Free objects from the free list
8653 * - Try to remove keys with an EXPIRE set
8654 *
8655 * It is not possible to free enough memory to reach used-memory < maxmemory
8656 * the server will start refusing commands that will enlarge even more the
8657 * memory usage.
8658 */
8659 static void freeMemoryIfNeeded(void) {
8660 while (server.maxmemory && zmalloc_used_memory() > server.maxmemory) {
8661 int j, k, freed = 0;
8662
8663 if (tryFreeOneObjectFromFreelist() == REDIS_OK) continue;
8664 for (j = 0; j < server.dbnum; j++) {
8665 int minttl = -1;
8666 robj *minkey = NULL;
8667 struct dictEntry *de;
8668
8669 if (dictSize(server.db[j].expires)) {
8670 freed = 1;
8671 /* From a sample of three keys drop the one nearest to
8672 * the natural expire */
8673 for (k = 0; k < 3; k++) {
8674 time_t t;
8675
8676 de = dictGetRandomKey(server.db[j].expires);
8677 t = (time_t) dictGetEntryVal(de);
8678 if (minttl == -1 || t < minttl) {
8679 minkey = dictGetEntryKey(de);
8680 minttl = t;
8681 }
8682 }
8683 dbDelete(server.db+j,minkey);
8684 }
8685 }
8686 if (!freed) return; /* nothing to free... */
8687 }
8688 }
8689
8690 /* ============================== Append Only file ========================== */
8691
8692 /* Called when the user switches from "appendonly yes" to "appendonly no"
8693 * at runtime using the CONFIG command. */
8694 static void stopAppendOnly(void) {
8695 flushAppendOnlyFile();
8696 aof_fsync(server.appendfd);
8697 close(server.appendfd);
8698
8699 server.appendfd = -1;
8700 server.appendseldb = -1;
8701 server.appendonly = 0;
8702 /* rewrite operation in progress? kill it, wait child exit */
8703 if (server.bgsavechildpid != -1) {
8704 int statloc;
8705
8706 if (kill(server.bgsavechildpid,SIGKILL) != -1)
8707 wait3(&statloc,0,NULL);
8708 /* reset the buffer accumulating changes while the child saves */
8709 sdsfree(server.bgrewritebuf);
8710 server.bgrewritebuf = sdsempty();
8711 server.bgsavechildpid = -1;
8712 }
8713 }
8714
8715 /* Called when the user switches from "appendonly no" to "appendonly yes"
8716 * at runtime using the CONFIG command. */
8717 static int startAppendOnly(void) {
8718 server.appendonly = 1;
8719 server.lastfsync = time(NULL);
8720 server.appendfd = open(server.appendfilename,O_WRONLY|O_APPEND|O_CREAT,0644);
8721 if (server.appendfd == -1) {
8722 redisLog(REDIS_WARNING,"Used tried to switch on AOF via CONFIG, but I can't open the AOF file: %s",strerror(errno));
8723 return REDIS_ERR;
8724 }
8725 if (rewriteAppendOnlyFileBackground() == REDIS_ERR) {
8726 server.appendonly = 0;
8727 close(server.appendfd);
8728 redisLog(REDIS_WARNING,"Used tried to switch on AOF via CONFIG, I can't trigger a background AOF rewrite operation. Check the above logs for more info about the error.",strerror(errno));
8729 return REDIS_ERR;
8730 }
8731 return REDIS_OK;
8732 }
8733
8734 /* Write the append only file buffer on disk.
8735 *
8736 * Since we are required to write the AOF before replying to the client,
8737 * and the only way the client socket can get a write is entering when the
8738 * the event loop, we accumulate all the AOF writes in a memory
8739 * buffer and write it on disk using this function just before entering
8740 * the event loop again. */
8741 static void flushAppendOnlyFile(void) {
8742 time_t now;
8743 ssize_t nwritten;
8744
8745 if (sdslen(server.aofbuf) == 0) return;
8746
8747 /* We want to perform a single write. This should be guaranteed atomic
8748 * at least if the filesystem we are writing is a real physical one.
8749 * While this will save us against the server being killed I don't think
8750 * there is much to do about the whole server stopping for power problems
8751 * or alike */
8752 nwritten = write(server.appendfd,server.aofbuf,sdslen(server.aofbuf));
8753 if (nwritten != (signed)sdslen(server.aofbuf)) {
8754 /* Ooops, we are in troubles. The best thing to do for now is
8755 * aborting instead of giving the illusion that everything is
8756 * working as expected. */
8757 if (nwritten == -1) {
8758 redisLog(REDIS_WARNING,"Exiting on error writing to the append-only file: %s",strerror(errno));
8759 } else {
8760 redisLog(REDIS_WARNING,"Exiting on short write while writing to the append-only file: %s",strerror(errno));
8761 }
8762 exit(1);
8763 }
8764 sdsfree(server.aofbuf);
8765 server.aofbuf = sdsempty();
8766
8767 /* Don't Fsync if no-appendfsync-on-rewrite is set to yes and we have
8768 * childs performing heavy I/O on disk. */
8769 if (server.no_appendfsync_on_rewrite &&
8770 (server.bgrewritechildpid != -1 || server.bgsavechildpid != -1))
8771 return;
8772 /* Fsync if needed */
8773 now = time(NULL);
8774 if (server.appendfsync == APPENDFSYNC_ALWAYS ||
8775 (server.appendfsync == APPENDFSYNC_EVERYSEC &&
8776 now-server.lastfsync > 1))
8777 {
8778 /* aof_fsync is defined as fdatasync() for Linux in order to avoid
8779 * flushing metadata. */
8780 aof_fsync(server.appendfd); /* Let's try to get this data on the disk */
8781 server.lastfsync = now;
8782 }
8783 }
8784
8785 static sds catAppendOnlyGenericCommand(sds buf, int argc, robj **argv) {
8786 int j;
8787 buf = sdscatprintf(buf,"*%d\r\n",argc);
8788 for (j = 0; j < argc; j++) {
8789 robj *o = getDecodedObject(argv[j]);
8790 buf = sdscatprintf(buf,"$%lu\r\n",(unsigned long)sdslen(o->ptr));
8791 buf = sdscatlen(buf,o->ptr,sdslen(o->ptr));
8792 buf = sdscatlen(buf,"\r\n",2);
8793 decrRefCount(o);
8794 }
8795 return buf;
8796 }
8797
8798 static sds catAppendOnlyExpireAtCommand(sds buf, robj *key, robj *seconds) {
8799 int argc = 3;
8800 long when;
8801 robj *argv[3];
8802
8803 /* Make sure we can use strtol */
8804 seconds = getDecodedObject(seconds);
8805 when = time(NULL)+strtol(seconds->ptr,NULL,10);
8806 decrRefCount(seconds);
8807
8808 argv[0] = createStringObject("EXPIREAT",8);
8809 argv[1] = key;
8810 argv[2] = createObject(REDIS_STRING,
8811 sdscatprintf(sdsempty(),"%ld",when));
8812 buf = catAppendOnlyGenericCommand(buf, argc, argv);
8813 decrRefCount(argv[0]);
8814 decrRefCount(argv[2]);
8815 return buf;
8816 }
8817
8818 static void feedAppendOnlyFile(struct redisCommand *cmd, int dictid, robj **argv, int argc) {
8819 sds buf = sdsempty();
8820 robj *tmpargv[3];
8821
8822 /* The DB this command was targetting is not the same as the last command
8823 * we appendend. To issue a SELECT command is needed. */
8824 if (dictid != server.appendseldb) {
8825 char seldb[64];
8826
8827 snprintf(seldb,sizeof(seldb),"%d",dictid);
8828 buf = sdscatprintf(buf,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
8829 (unsigned long)strlen(seldb),seldb);
8830 server.appendseldb = dictid;
8831 }
8832
8833 if (cmd->proc == expireCommand) {
8834 /* Translate EXPIRE into EXPIREAT */
8835 buf = catAppendOnlyExpireAtCommand(buf,argv[1],argv[2]);
8836 } else if (cmd->proc == setexCommand) {
8837 /* Translate SETEX to SET and EXPIREAT */
8838 tmpargv[0] = createStringObject("SET",3);
8839 tmpargv[1] = argv[1];
8840 tmpargv[2] = argv[3];
8841 buf = catAppendOnlyGenericCommand(buf,3,tmpargv);
8842 decrRefCount(tmpargv[0]);
8843 buf = catAppendOnlyExpireAtCommand(buf,argv[1],argv[2]);
8844 } else {
8845 buf = catAppendOnlyGenericCommand(buf,argc,argv);
8846 }
8847
8848 /* Append to the AOF buffer. This will be flushed on disk just before
8849 * of re-entering the event loop, so before the client will get a
8850 * positive reply about the operation performed. */
8851 server.aofbuf = sdscatlen(server.aofbuf,buf,sdslen(buf));
8852
8853 /* If a background append only file rewriting is in progress we want to
8854 * accumulate the differences between the child DB and the current one
8855 * in a buffer, so that when the child process will do its work we
8856 * can append the differences to the new append only file. */
8857 if (server.bgrewritechildpid != -1)
8858 server.bgrewritebuf = sdscatlen(server.bgrewritebuf,buf,sdslen(buf));
8859
8860 sdsfree(buf);
8861 }
8862
8863 /* In Redis commands are always executed in the context of a client, so in
8864 * order to load the append only file we need to create a fake client. */
8865 static struct redisClient *createFakeClient(void) {
8866 struct redisClient *c = zmalloc(sizeof(*c));
8867
8868 selectDb(c,0);
8869 c->fd = -1;
8870 c->querybuf = sdsempty();
8871 c->argc = 0;
8872 c->argv = NULL;
8873 c->flags = 0;
8874 /* We set the fake client as a slave waiting for the synchronization
8875 * so that Redis will not try to send replies to this client. */
8876 c->replstate = REDIS_REPL_WAIT_BGSAVE_START;
8877 c->reply = listCreate();
8878 listSetFreeMethod(c->reply,decrRefCount);
8879 listSetDupMethod(c->reply,dupClientReplyValue);
8880 initClientMultiState(c);
8881 return c;
8882 }
8883
8884 static void freeFakeClient(struct redisClient *c) {
8885 sdsfree(c->querybuf);
8886 listRelease(c->reply);
8887 freeClientMultiState(c);
8888 zfree(c);
8889 }
8890
8891 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
8892 * error (the append only file is zero-length) REDIS_ERR is returned. On
8893 * fatal error an error message is logged and the program exists. */
8894 int loadAppendOnlyFile(char *filename) {
8895 struct redisClient *fakeClient;
8896 FILE *fp = fopen(filename,"r");
8897 struct redis_stat sb;
8898 int appendonly = server.appendonly;
8899
8900 if (redis_fstat(fileno(fp),&sb) != -1 && sb.st_size == 0)
8901 return REDIS_ERR;
8902
8903 if (fp == NULL) {
8904 redisLog(REDIS_WARNING,"Fatal error: can't open the append log file for reading: %s",strerror(errno));
8905 exit(1);
8906 }
8907
8908 /* Temporarily disable AOF, to prevent EXEC from feeding a MULTI
8909 * to the same file we're about to read. */
8910 server.appendonly = 0;
8911
8912 fakeClient = createFakeClient();
8913 while(1) {
8914 int argc, j;
8915 unsigned long len;
8916 robj **argv;
8917 char buf[128];
8918 sds argsds;
8919 struct redisCommand *cmd;
8920 int force_swapout;
8921
8922 if (fgets(buf,sizeof(buf),fp) == NULL) {
8923 if (feof(fp))
8924 break;
8925 else
8926 goto readerr;
8927 }
8928 if (buf[0] != '*') goto fmterr;
8929 argc = atoi(buf+1);
8930 argv = zmalloc(sizeof(robj*)*argc);
8931 for (j = 0; j < argc; j++) {
8932 if (fgets(buf,sizeof(buf),fp) == NULL) goto readerr;
8933 if (buf[0] != '$') goto fmterr;
8934 len = strtol(buf+1,NULL,10);
8935 argsds = sdsnewlen(NULL,len);
8936 if (len && fread(argsds,len,1,fp) == 0) goto fmterr;
8937 argv[j] = createObject(REDIS_STRING,argsds);
8938 if (fread(buf,2,1,fp) == 0) goto fmterr; /* discard CRLF */
8939 }
8940
8941 /* Command lookup */
8942 cmd = lookupCommand(argv[0]->ptr);
8943 if (!cmd) {
8944 redisLog(REDIS_WARNING,"Unknown command '%s' reading the append only file", argv[0]->ptr);
8945 exit(1);
8946 }
8947 /* Try object encoding */
8948 if (cmd->flags & REDIS_CMD_BULK)
8949 argv[argc-1] = tryObjectEncoding(argv[argc-1]);
8950 /* Run the command in the context of a fake client */
8951 fakeClient->argc = argc;
8952 fakeClient->argv = argv;
8953 cmd->proc(fakeClient);
8954 /* Discard the reply objects list from the fake client */
8955 while(listLength(fakeClient->reply))
8956 listDelNode(fakeClient->reply,listFirst(fakeClient->reply));
8957 /* Clean up, ready for the next command */
8958 for (j = 0; j < argc; j++) decrRefCount(argv[j]);
8959 zfree(argv);
8960 /* Handle swapping while loading big datasets when VM is on */
8961 force_swapout = 0;
8962 if ((zmalloc_used_memory() - server.vm_max_memory) > 1024*1024*32)
8963 force_swapout = 1;
8964
8965 if (server.vm_enabled && force_swapout) {
8966 while (zmalloc_used_memory() > server.vm_max_memory) {
8967 if (vmSwapOneObjectBlocking() == REDIS_ERR) break;
8968 }
8969 }
8970 }
8971
8972 /* This point can only be reached when EOF is reached without errors.
8973 * If the client is in the middle of a MULTI/EXEC, log error and quit. */
8974 if (fakeClient->flags & REDIS_MULTI) goto readerr;
8975
8976 fclose(fp);
8977 freeFakeClient(fakeClient);
8978 server.appendonly = appendonly;
8979 return REDIS_OK;
8980
8981 readerr:
8982 if (feof(fp)) {
8983 redisLog(REDIS_WARNING,"Unexpected end of file reading the append only file");
8984 } else {
8985 redisLog(REDIS_WARNING,"Unrecoverable error reading the append only file: %s", strerror(errno));
8986 }
8987 exit(1);
8988 fmterr:
8989 redisLog(REDIS_WARNING,"Bad file format reading the append only file");
8990 exit(1);
8991 }
8992
8993 /* Write binary-safe string into a file in the bulkformat
8994 * $<count>\r\n<payload>\r\n */
8995 static int fwriteBulkString(FILE *fp, char *s, unsigned long len) {
8996 char cbuf[128];
8997 int clen;
8998 cbuf[0] = '$';
8999 clen = 1+ll2string(cbuf+1,sizeof(cbuf)-1,len);
9000 cbuf[clen++] = '\r';
9001 cbuf[clen++] = '\n';
9002 if (fwrite(cbuf,clen,1,fp) == 0) return 0;
9003 if (len > 0 && fwrite(s,len,1,fp) == 0) return 0;
9004 if (fwrite("\r\n",2,1,fp) == 0) return 0;
9005 return 1;
9006 }
9007
9008 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
9009 static int fwriteBulkDouble(FILE *fp, double d) {
9010 char buf[128], dbuf[128];
9011
9012 snprintf(dbuf,sizeof(dbuf),"%.17g\r\n",d);
9013 snprintf(buf,sizeof(buf),"$%lu\r\n",(unsigned long)strlen(dbuf)-2);
9014 if (fwrite(buf,strlen(buf),1,fp) == 0) return 0;
9015 if (fwrite(dbuf,strlen(dbuf),1,fp) == 0) return 0;
9016 return 1;
9017 }
9018
9019 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
9020 static int fwriteBulkLongLong(FILE *fp, long long l) {
9021 char bbuf[128], lbuf[128];
9022 unsigned int blen, llen;
9023 llen = ll2string(lbuf,32,l);
9024 blen = snprintf(bbuf,sizeof(bbuf),"$%u\r\n%s\r\n",llen,lbuf);
9025 if (fwrite(bbuf,blen,1,fp) == 0) return 0;
9026 return 1;
9027 }
9028
9029 /* Delegate writing an object to writing a bulk string or bulk long long. */
9030 static int fwriteBulkObject(FILE *fp, robj *obj) {
9031 /* Avoid using getDecodedObject to help copy-on-write (we are often
9032 * in a child process when this function is called). */
9033 if (obj->encoding == REDIS_ENCODING_INT) {
9034 return fwriteBulkLongLong(fp,(long)obj->ptr);
9035 } else if (obj->encoding == REDIS_ENCODING_RAW) {
9036 return fwriteBulkString(fp,obj->ptr,sdslen(obj->ptr));
9037 } else {
9038 redisPanic("Unknown string encoding");
9039 }
9040 }
9041
9042 /* Write a sequence of commands able to fully rebuild the dataset into
9043 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
9044 static int rewriteAppendOnlyFile(char *filename) {
9045 dictIterator *di = NULL;
9046 dictEntry *de;
9047 FILE *fp;
9048 char tmpfile[256];
9049 int j;
9050 time_t now = time(NULL);
9051
9052 /* Note that we have to use a different temp name here compared to the
9053 * one used by rewriteAppendOnlyFileBackground() function. */
9054 snprintf(tmpfile,256,"temp-rewriteaof-%d.aof", (int) getpid());
9055 fp = fopen(tmpfile,"w");
9056 if (!fp) {
9057 redisLog(REDIS_WARNING, "Failed rewriting the append only file: %s", strerror(errno));
9058 return REDIS_ERR;
9059 }
9060 for (j = 0; j < server.dbnum; j++) {
9061 char selectcmd[] = "*2\r\n$6\r\nSELECT\r\n";
9062 redisDb *db = server.db+j;
9063 dict *d = db->dict;
9064 if (dictSize(d) == 0) continue;
9065 di = dictGetIterator(d);
9066 if (!di) {
9067 fclose(fp);
9068 return REDIS_ERR;
9069 }
9070
9071 /* SELECT the new DB */
9072 if (fwrite(selectcmd,sizeof(selectcmd)-1,1,fp) == 0) goto werr;
9073 if (fwriteBulkLongLong(fp,j) == 0) goto werr;
9074
9075 /* Iterate this DB writing every entry */
9076 while((de = dictNext(di)) != NULL) {
9077 sds keystr = dictGetEntryKey(de);
9078 robj key, *o;
9079 time_t expiretime;
9080 int swapped;
9081
9082 keystr = dictGetEntryKey(de);
9083 o = dictGetEntryVal(de);
9084 initStaticStringObject(key,keystr);
9085 /* If the value for this key is swapped, load a preview in memory.
9086 * We use a "swapped" flag to remember if we need to free the
9087 * value object instead to just increment the ref count anyway
9088 * in order to avoid copy-on-write of pages if we are forked() */
9089 if (!server.vm_enabled || o->storage == REDIS_VM_MEMORY ||
9090 o->storage == REDIS_VM_SWAPPING) {
9091 swapped = 0;
9092 } else {
9093 o = vmPreviewObject(o);
9094 swapped = 1;
9095 }
9096 expiretime = getExpire(db,&key);
9097
9098 /* Save the key and associated value */
9099 if (o->type == REDIS_STRING) {
9100 /* Emit a SET command */
9101 char cmd[]="*3\r\n$3\r\nSET\r\n";
9102 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
9103 /* Key and value */
9104 if (fwriteBulkObject(fp,&key) == 0) goto werr;
9105 if (fwriteBulkObject(fp,o) == 0) goto werr;
9106 } else if (o->type == REDIS_LIST) {
9107 /* Emit the RPUSHes needed to rebuild the list */
9108 char cmd[]="*3\r\n$5\r\nRPUSH\r\n";
9109 if (o->encoding == REDIS_ENCODING_ZIPLIST) {
9110 unsigned char *zl = o->ptr;
9111 unsigned char *p = ziplistIndex(zl,0);
9112 unsigned char *vstr;
9113 unsigned int vlen;
9114 long long vlong;
9115
9116 while(ziplistGet(p,&vstr,&vlen,&vlong)) {
9117 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
9118 if (fwriteBulkObject(fp,&key) == 0) goto werr;
9119 if (vstr) {
9120 if (fwriteBulkString(fp,(char*)vstr,vlen) == 0)
9121 goto werr;
9122 } else {
9123 if (fwriteBulkLongLong(fp,vlong) == 0)
9124 goto werr;
9125 }
9126 p = ziplistNext(zl,p);
9127 }
9128 } else if (o->encoding == REDIS_ENCODING_LIST) {
9129 list *list = o->ptr;
9130 listNode *ln;
9131 listIter li;
9132
9133 listRewind(list,&li);
9134 while((ln = listNext(&li))) {
9135 robj *eleobj = listNodeValue(ln);
9136
9137 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
9138 if (fwriteBulkObject(fp,&key) == 0) goto werr;
9139 if (fwriteBulkObject(fp,eleobj) == 0) goto werr;
9140 }
9141 } else {
9142 redisPanic("Unknown list encoding");
9143 }
9144 } else if (o->type == REDIS_SET) {
9145 /* Emit the SADDs needed to rebuild the set */
9146 dict *set = o->ptr;
9147 dictIterator *di = dictGetIterator(set);
9148 dictEntry *de;
9149
9150 while((de = dictNext(di)) != NULL) {
9151 char cmd[]="*3\r\n$4\r\nSADD\r\n";
9152 robj *eleobj = dictGetEntryKey(de);
9153
9154 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
9155 if (fwriteBulkObject(fp,&key) == 0) goto werr;
9156 if (fwriteBulkObject(fp,eleobj) == 0) goto werr;
9157 }
9158 dictReleaseIterator(di);
9159 } else if (o->type == REDIS_ZSET) {
9160 /* Emit the ZADDs needed to rebuild the sorted set */
9161 zset *zs = o->ptr;
9162 dictIterator *di = dictGetIterator(zs->dict);
9163 dictEntry *de;
9164
9165 while((de = dictNext(di)) != NULL) {
9166 char cmd[]="*4\r\n$4\r\nZADD\r\n";
9167 robj *eleobj = dictGetEntryKey(de);
9168 double *score = dictGetEntryVal(de);
9169
9170 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
9171 if (fwriteBulkObject(fp,&key) == 0) goto werr;
9172 if (fwriteBulkDouble(fp,*score) == 0) goto werr;
9173 if (fwriteBulkObject(fp,eleobj) == 0) goto werr;
9174 }
9175 dictReleaseIterator(di);
9176 } else if (o->type == REDIS_HASH) {
9177 char cmd[]="*4\r\n$4\r\nHSET\r\n";
9178
9179 /* Emit the HSETs needed to rebuild the hash */
9180 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
9181 unsigned char *p = zipmapRewind(o->ptr);
9182 unsigned char *field, *val;
9183 unsigned int flen, vlen;
9184
9185 while((p = zipmapNext(p,&field,&flen,&val,&vlen)) != NULL) {
9186 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
9187 if (fwriteBulkObject(fp,&key) == 0) goto werr;
9188 if (fwriteBulkString(fp,(char*)field,flen) == -1)
9189 return -1;
9190 if (fwriteBulkString(fp,(char*)val,vlen) == -1)
9191 return -1;
9192 }
9193 } else {
9194 dictIterator *di = dictGetIterator(o->ptr);
9195 dictEntry *de;
9196
9197 while((de = dictNext(di)) != NULL) {
9198 robj *field = dictGetEntryKey(de);
9199 robj *val = dictGetEntryVal(de);
9200
9201 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
9202 if (fwriteBulkObject(fp,&key) == 0) goto werr;
9203 if (fwriteBulkObject(fp,field) == -1) return -1;
9204 if (fwriteBulkObject(fp,val) == -1) return -1;
9205 }
9206 dictReleaseIterator(di);
9207 }
9208 } else {
9209 redisPanic("Unknown object type");
9210 }
9211 /* Save the expire time */
9212 if (expiretime != -1) {
9213 char cmd[]="*3\r\n$8\r\nEXPIREAT\r\n";
9214 /* If this key is already expired skip it */
9215 if (expiretime < now) continue;
9216 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
9217 if (fwriteBulkObject(fp,&key) == 0) goto werr;
9218 if (fwriteBulkLongLong(fp,expiretime) == 0) goto werr;
9219 }
9220 if (swapped) decrRefCount(o);
9221 }
9222 dictReleaseIterator(di);
9223 }
9224
9225 /* Make sure data will not remain on the OS's output buffers */
9226 fflush(fp);
9227 aof_fsync(fileno(fp));
9228 fclose(fp);
9229
9230 /* Use RENAME to make sure the DB file is changed atomically only
9231 * if the generate DB file is ok. */
9232 if (rename(tmpfile,filename) == -1) {
9233 redisLog(REDIS_WARNING,"Error moving temp append only file on the final destination: %s", strerror(errno));
9234 unlink(tmpfile);
9235 return REDIS_ERR;
9236 }
9237 redisLog(REDIS_NOTICE,"SYNC append only file rewrite performed");
9238 return REDIS_OK;
9239
9240 werr:
9241 fclose(fp);
9242 unlink(tmpfile);
9243 redisLog(REDIS_WARNING,"Write error writing append only file on disk: %s", strerror(errno));
9244 if (di) dictReleaseIterator(di);
9245 return REDIS_ERR;
9246 }
9247
9248 /* This is how rewriting of the append only file in background works:
9249 *
9250 * 1) The user calls BGREWRITEAOF
9251 * 2) Redis calls this function, that forks():
9252 * 2a) the child rewrite the append only file in a temp file.
9253 * 2b) the parent accumulates differences in server.bgrewritebuf.
9254 * 3) When the child finished '2a' exists.
9255 * 4) The parent will trap the exit code, if it's OK, will append the
9256 * data accumulated into server.bgrewritebuf into the temp file, and
9257 * finally will rename(2) the temp file in the actual file name.
9258 * The the new file is reopened as the new append only file. Profit!
9259 */
9260 static int rewriteAppendOnlyFileBackground(void) {
9261 pid_t childpid;
9262
9263 if (server.bgrewritechildpid != -1) return REDIS_ERR;
9264 if (server.vm_enabled) waitEmptyIOJobsQueue();
9265 if ((childpid = fork()) == 0) {
9266 /* Child */
9267 char tmpfile[256];
9268
9269 if (server.vm_enabled) vmReopenSwapFile();
9270 close(server.fd);
9271 snprintf(tmpfile,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
9272 if (rewriteAppendOnlyFile(tmpfile) == REDIS_OK) {
9273 _exit(0);
9274 } else {
9275 _exit(1);
9276 }
9277 } else {
9278 /* Parent */
9279 if (childpid == -1) {
9280 redisLog(REDIS_WARNING,
9281 "Can't rewrite append only file in background: fork: %s",
9282 strerror(errno));
9283 return REDIS_ERR;
9284 }
9285 redisLog(REDIS_NOTICE,
9286 "Background append only file rewriting started by pid %d",childpid);
9287 server.bgrewritechildpid = childpid;
9288 updateDictResizePolicy();
9289 /* We set appendseldb to -1 in order to force the next call to the
9290 * feedAppendOnlyFile() to issue a SELECT command, so the differences
9291 * accumulated by the parent into server.bgrewritebuf will start
9292 * with a SELECT statement and it will be safe to merge. */
9293 server.appendseldb = -1;
9294 return REDIS_OK;
9295 }
9296 return REDIS_OK; /* unreached */
9297 }
9298
9299 static void bgrewriteaofCommand(redisClient *c) {
9300 if (server.bgrewritechildpid != -1) {
9301 addReplySds(c,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
9302 return;
9303 }
9304 if (rewriteAppendOnlyFileBackground() == REDIS_OK) {
9305 char *status = "+Background append only file rewriting started\r\n";
9306 addReplySds(c,sdsnew(status));
9307 } else {
9308 addReply(c,shared.err);
9309 }
9310 }
9311
9312 static void aofRemoveTempFile(pid_t childpid) {
9313 char tmpfile[256];
9314
9315 snprintf(tmpfile,256,"temp-rewriteaof-bg-%d.aof", (int) childpid);
9316 unlink(tmpfile);
9317 }
9318
9319 /* Virtual Memory is composed mainly of two subsystems:
9320 * - Blocking Virutal Memory
9321 * - Threaded Virtual Memory I/O
9322 * The two parts are not fully decoupled, but functions are split among two
9323 * different sections of the source code (delimited by comments) in order to
9324 * make more clear what functionality is about the blocking VM and what about
9325 * the threaded (not blocking) VM.
9326 *
9327 * Redis VM design:
9328 *
9329 * Redis VM is a blocking VM (one that blocks reading swapped values from
9330 * disk into memory when a value swapped out is needed in memory) that is made
9331 * unblocking by trying to examine the command argument vector in order to
9332 * load in background values that will likely be needed in order to exec
9333 * the command. The command is executed only once all the relevant keys
9334 * are loaded into memory.
9335 *
9336 * This basically is almost as simple of a blocking VM, but almost as parallel
9337 * as a fully non-blocking VM.
9338 */
9339
9340 /* =================== Virtual Memory - Blocking Side ====================== */
9341
9342 /* Create a VM pointer object. This kind of objects are used in place of
9343 * values in the key -> value hash table, for swapped out objects. */
9344 static vmpointer *createVmPointer(int vtype) {
9345 vmpointer *vp = zmalloc(sizeof(vmpointer));
9346
9347 vp->type = REDIS_VMPOINTER;
9348 vp->storage = REDIS_VM_SWAPPED;
9349 vp->vtype = vtype;
9350 return vp;
9351 }
9352
9353 static void vmInit(void) {
9354 off_t totsize;
9355 int pipefds[2];
9356 size_t stacksize;
9357 struct flock fl;
9358
9359 if (server.vm_max_threads != 0)
9360 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
9361
9362 redisLog(REDIS_NOTICE,"Using '%s' as swap file",server.vm_swap_file);
9363 /* Try to open the old swap file, otherwise create it */
9364 if ((server.vm_fp = fopen(server.vm_swap_file,"r+b")) == NULL) {
9365 server.vm_fp = fopen(server.vm_swap_file,"w+b");
9366 }
9367 if (server.vm_fp == NULL) {
9368 redisLog(REDIS_WARNING,
9369 "Can't open the swap file: %s. Exiting.",
9370 strerror(errno));
9371 exit(1);
9372 }
9373 server.vm_fd = fileno(server.vm_fp);
9374 /* Lock the swap file for writing, this is useful in order to avoid
9375 * another instance to use the same swap file for a config error. */
9376 fl.l_type = F_WRLCK;
9377 fl.l_whence = SEEK_SET;
9378 fl.l_start = fl.l_len = 0;
9379 if (fcntl(server.vm_fd,F_SETLK,&fl) == -1) {
9380 redisLog(REDIS_WARNING,
9381 "Can't lock the swap file at '%s': %s. Make sure it is not used by another Redis instance.", server.vm_swap_file, strerror(errno));
9382 exit(1);
9383 }
9384 /* Initialize */
9385 server.vm_next_page = 0;
9386 server.vm_near_pages = 0;
9387 server.vm_stats_used_pages = 0;
9388 server.vm_stats_swapped_objects = 0;
9389 server.vm_stats_swapouts = 0;
9390 server.vm_stats_swapins = 0;
9391 totsize = server.vm_pages*server.vm_page_size;
9392 redisLog(REDIS_NOTICE,"Allocating %lld bytes of swap file",totsize);
9393 if (ftruncate(server.vm_fd,totsize) == -1) {
9394 redisLog(REDIS_WARNING,"Can't ftruncate swap file: %s. Exiting.",
9395 strerror(errno));
9396 exit(1);
9397 } else {
9398 redisLog(REDIS_NOTICE,"Swap file allocated with success");
9399 }
9400 server.vm_bitmap = zmalloc((server.vm_pages+7)/8);
9401 redisLog(REDIS_VERBOSE,"Allocated %lld bytes page table for %lld pages",
9402 (long long) (server.vm_pages+7)/8, server.vm_pages);
9403 memset(server.vm_bitmap,0,(server.vm_pages+7)/8);
9404
9405 /* Initialize threaded I/O (used by Virtual Memory) */
9406 server.io_newjobs = listCreate();
9407 server.io_processing = listCreate();
9408 server.io_processed = listCreate();
9409 server.io_ready_clients = listCreate();
9410 pthread_mutex_init(&server.io_mutex,NULL);
9411 pthread_mutex_init(&server.obj_freelist_mutex,NULL);
9412 pthread_mutex_init(&server.io_swapfile_mutex,NULL);
9413 server.io_active_threads = 0;
9414 if (pipe(pipefds) == -1) {
9415 redisLog(REDIS_WARNING,"Unable to intialized VM: pipe(2): %s. Exiting."
9416 ,strerror(errno));
9417 exit(1);
9418 }
9419 server.io_ready_pipe_read = pipefds[0];
9420 server.io_ready_pipe_write = pipefds[1];
9421 redisAssert(anetNonBlock(NULL,server.io_ready_pipe_read) != ANET_ERR);
9422 /* LZF requires a lot of stack */
9423 pthread_attr_init(&server.io_threads_attr);
9424 pthread_attr_getstacksize(&server.io_threads_attr, &stacksize);
9425 while (stacksize < REDIS_THREAD_STACK_SIZE) stacksize *= 2;
9426 pthread_attr_setstacksize(&server.io_threads_attr, stacksize);
9427 /* Listen for events in the threaded I/O pipe */
9428 if (aeCreateFileEvent(server.el, server.io_ready_pipe_read, AE_READABLE,
9429 vmThreadedIOCompletedJob, NULL) == AE_ERR)
9430 oom("creating file event");
9431 }
9432
9433 /* Mark the page as used */
9434 static void vmMarkPageUsed(off_t page) {
9435 off_t byte = page/8;
9436 int bit = page&7;
9437 redisAssert(vmFreePage(page) == 1);
9438 server.vm_bitmap[byte] |= 1<<bit;
9439 }
9440
9441 /* Mark N contiguous pages as used, with 'page' being the first. */
9442 static void vmMarkPagesUsed(off_t page, off_t count) {
9443 off_t j;
9444
9445 for (j = 0; j < count; j++)
9446 vmMarkPageUsed(page+j);
9447 server.vm_stats_used_pages += count;
9448 redisLog(REDIS_DEBUG,"Mark USED pages: %lld pages at %lld\n",
9449 (long long)count, (long long)page);
9450 }
9451
9452 /* Mark the page as free */
9453 static void vmMarkPageFree(off_t page) {
9454 off_t byte = page/8;
9455 int bit = page&7;
9456 redisAssert(vmFreePage(page) == 0);
9457 server.vm_bitmap[byte] &= ~(1<<bit);
9458 }
9459
9460 /* Mark N contiguous pages as free, with 'page' being the first. */
9461 static void vmMarkPagesFree(off_t page, off_t count) {
9462 off_t j;
9463
9464 for (j = 0; j < count; j++)
9465 vmMarkPageFree(page+j);
9466 server.vm_stats_used_pages -= count;
9467 redisLog(REDIS_DEBUG,"Mark FREE pages: %lld pages at %lld\n",
9468 (long long)count, (long long)page);
9469 }
9470
9471 /* Test if the page is free */
9472 static int vmFreePage(off_t page) {
9473 off_t byte = page/8;
9474 int bit = page&7;
9475 return (server.vm_bitmap[byte] & (1<<bit)) == 0;
9476 }
9477
9478 /* Find N contiguous free pages storing the first page of the cluster in *first.
9479 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
9480 * REDIS_ERR is returned.
9481 *
9482 * This function uses a simple algorithm: we try to allocate
9483 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
9484 * again from the start of the swap file searching for free spaces.
9485 *
9486 * If it looks pretty clear that there are no free pages near our offset
9487 * we try to find less populated places doing a forward jump of
9488 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
9489 * without hurry, and then we jump again and so forth...
9490 *
9491 * This function can be improved using a free list to avoid to guess
9492 * too much, since we could collect data about freed pages.
9493 *
9494 * note: I implemented this function just after watching an episode of
9495 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
9496 */
9497 static int vmFindContiguousPages(off_t *first, off_t n) {
9498 off_t base, offset = 0, since_jump = 0, numfree = 0;
9499
9500 if (server.vm_near_pages == REDIS_VM_MAX_NEAR_PAGES) {
9501 server.vm_near_pages = 0;
9502 server.vm_next_page = 0;
9503 }
9504 server.vm_near_pages++; /* Yet another try for pages near to the old ones */
9505 base = server.vm_next_page;
9506
9507 while(offset < server.vm_pages) {
9508 off_t this = base+offset;
9509
9510 /* If we overflow, restart from page zero */
9511 if (this >= server.vm_pages) {
9512 this -= server.vm_pages;
9513 if (this == 0) {
9514 /* Just overflowed, what we found on tail is no longer
9515 * interesting, as it's no longer contiguous. */
9516 numfree = 0;
9517 }
9518 }
9519 if (vmFreePage(this)) {
9520 /* This is a free page */
9521 numfree++;
9522 /* Already got N free pages? Return to the caller, with success */
9523 if (numfree == n) {
9524 *first = this-(n-1);
9525 server.vm_next_page = this+1;
9526 redisLog(REDIS_DEBUG, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n, (long long) *first);
9527 return REDIS_OK;
9528 }
9529 } else {
9530 /* The current one is not a free page */
9531 numfree = 0;
9532 }
9533
9534 /* Fast-forward if the current page is not free and we already
9535 * searched enough near this place. */
9536 since_jump++;
9537 if (!numfree && since_jump >= REDIS_VM_MAX_RANDOM_JUMP/4) {
9538 offset += random() % REDIS_VM_MAX_RANDOM_JUMP;
9539 since_jump = 0;
9540 /* Note that even if we rewind after the jump, we are don't need
9541 * to make sure numfree is set to zero as we only jump *if* it
9542 * is set to zero. */
9543 } else {
9544 /* Otherwise just check the next page */
9545 offset++;
9546 }
9547 }
9548 return REDIS_ERR;
9549 }
9550
9551 /* Write the specified object at the specified page of the swap file */
9552 static int vmWriteObjectOnSwap(robj *o, off_t page) {
9553 if (server.vm_enabled) pthread_mutex_lock(&server.io_swapfile_mutex);
9554 if (fseeko(server.vm_fp,page*server.vm_page_size,SEEK_SET) == -1) {
9555 if (server.vm_enabled) pthread_mutex_unlock(&server.io_swapfile_mutex);
9556 redisLog(REDIS_WARNING,
9557 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
9558 strerror(errno));
9559 return REDIS_ERR;
9560 }
9561 rdbSaveObject(server.vm_fp,o);
9562 fflush(server.vm_fp);
9563 if (server.vm_enabled) pthread_mutex_unlock(&server.io_swapfile_mutex);
9564 return REDIS_OK;
9565 }
9566
9567 /* Transfers the 'val' object to disk. Store all the information
9568 * a 'vmpointer' object containing all the information needed to load the
9569 * object back later is returned.
9570 *
9571 * If we can't find enough contiguous empty pages to swap the object on disk
9572 * NULL is returned. */
9573 static vmpointer *vmSwapObjectBlocking(robj *val) {
9574 off_t pages = rdbSavedObjectPages(val,NULL);
9575 off_t page;
9576 vmpointer *vp;
9577
9578 assert(val->storage == REDIS_VM_MEMORY);
9579 assert(val->refcount == 1);
9580 if (vmFindContiguousPages(&page,pages) == REDIS_ERR) return NULL;
9581 if (vmWriteObjectOnSwap(val,page) == REDIS_ERR) return NULL;
9582
9583 vp = createVmPointer(val->type);
9584 vp->page = page;
9585 vp->usedpages = pages;
9586 decrRefCount(val); /* Deallocate the object from memory. */
9587 vmMarkPagesUsed(page,pages);
9588 redisLog(REDIS_DEBUG,"VM: object %p swapped out at %lld (%lld pages)",
9589 (void*) val,
9590 (unsigned long long) page, (unsigned long long) pages);
9591 server.vm_stats_swapped_objects++;
9592 server.vm_stats_swapouts++;
9593 return vp;
9594 }
9595
9596 static robj *vmReadObjectFromSwap(off_t page, int type) {
9597 robj *o;
9598
9599 if (server.vm_enabled) pthread_mutex_lock(&server.io_swapfile_mutex);
9600 if (fseeko(server.vm_fp,page*server.vm_page_size,SEEK_SET) == -1) {
9601 redisLog(REDIS_WARNING,
9602 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
9603 strerror(errno));
9604 _exit(1);
9605 }
9606 o = rdbLoadObject(type,server.vm_fp);
9607 if (o == NULL) {
9608 redisLog(REDIS_WARNING, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno));
9609 _exit(1);
9610 }
9611 if (server.vm_enabled) pthread_mutex_unlock(&server.io_swapfile_mutex);
9612 return o;
9613 }
9614
9615 /* Load the specified object from swap to memory.
9616 * The newly allocated object is returned.
9617 *
9618 * If preview is true the unserialized object is returned to the caller but
9619 * the pages are not marked as freed, nor the vp object is freed. */
9620 static robj *vmGenericLoadObject(vmpointer *vp, int preview) {
9621 robj *val;
9622
9623 redisAssert(vp->type == REDIS_VMPOINTER &&
9624 (vp->storage == REDIS_VM_SWAPPED || vp->storage == REDIS_VM_LOADING));
9625 val = vmReadObjectFromSwap(vp->page,vp->vtype);
9626 if (!preview) {
9627 redisLog(REDIS_DEBUG, "VM: object %p loaded from disk", (void*)vp);
9628 vmMarkPagesFree(vp->page,vp->usedpages);
9629 zfree(vp);
9630 server.vm_stats_swapped_objects--;
9631 } else {
9632 redisLog(REDIS_DEBUG, "VM: object %p previewed from disk", (void*)vp);
9633 }
9634 server.vm_stats_swapins++;
9635 return val;
9636 }
9637
9638 /* Plain object loading, from swap to memory.
9639 *
9640 * 'o' is actually a redisVmPointer structure that will be freed by the call.
9641 * The return value is the loaded object. */
9642 static robj *vmLoadObject(robj *o) {
9643 /* If we are loading the object in background, stop it, we
9644 * need to load this object synchronously ASAP. */
9645 if (o->storage == REDIS_VM_LOADING)
9646 vmCancelThreadedIOJob(o);
9647 return vmGenericLoadObject((vmpointer*)o,0);
9648 }
9649
9650 /* Just load the value on disk, without to modify the key.
9651 * This is useful when we want to perform some operation on the value
9652 * without to really bring it from swap to memory, like while saving the
9653 * dataset or rewriting the append only log. */
9654 static robj *vmPreviewObject(robj *o) {
9655 return vmGenericLoadObject((vmpointer*)o,1);
9656 }
9657
9658 /* How a good candidate is this object for swapping?
9659 * The better candidate it is, the greater the returned value.
9660 *
9661 * Currently we try to perform a fast estimation of the object size in
9662 * memory, and combine it with aging informations.
9663 *
9664 * Basically swappability = idle-time * log(estimated size)
9665 *
9666 * Bigger objects are preferred over smaller objects, but not
9667 * proportionally, this is why we use the logarithm. This algorithm is
9668 * just a first try and will probably be tuned later. */
9669 static double computeObjectSwappability(robj *o) {
9670 /* actual age can be >= minage, but not < minage. As we use wrapping
9671 * 21 bit clocks with minutes resolution for the LRU. */
9672 time_t minage = abs(server.lruclock - o->lru);
9673 long asize = 0, elesize;
9674 robj *ele;
9675 list *l;
9676 listNode *ln;
9677 dict *d;
9678 struct dictEntry *de;
9679 int z;
9680
9681 if (minage <= 0) return 0;
9682 switch(o->type) {
9683 case REDIS_STRING:
9684 if (o->encoding != REDIS_ENCODING_RAW) {
9685 asize = sizeof(*o);
9686 } else {
9687 asize = sdslen(o->ptr)+sizeof(*o)+sizeof(long)*2;
9688 }
9689 break;
9690 case REDIS_LIST:
9691 if (o->encoding == REDIS_ENCODING_ZIPLIST) {
9692 asize = sizeof(*o)+ziplistSize(o->ptr);
9693 } else {
9694 l = o->ptr;
9695 ln = listFirst(l);
9696 asize = sizeof(list);
9697 if (ln) {
9698 ele = ln->value;
9699 elesize = (ele->encoding == REDIS_ENCODING_RAW) ?
9700 (sizeof(*o)+sdslen(ele->ptr)) : sizeof(*o);
9701 asize += (sizeof(listNode)+elesize)*listLength(l);
9702 }
9703 }
9704 break;
9705 case REDIS_SET:
9706 case REDIS_ZSET:
9707 z = (o->type == REDIS_ZSET);
9708 d = z ? ((zset*)o->ptr)->dict : o->ptr;
9709
9710 asize = sizeof(dict)+(sizeof(struct dictEntry*)*dictSlots(d));
9711 if (z) asize += sizeof(zset)-sizeof(dict);
9712 if (dictSize(d)) {
9713 de = dictGetRandomKey(d);
9714 ele = dictGetEntryKey(de);
9715 elesize = (ele->encoding == REDIS_ENCODING_RAW) ?
9716 (sizeof(*o)+sdslen(ele->ptr)) : sizeof(*o);
9717 asize += (sizeof(struct dictEntry)+elesize)*dictSize(d);
9718 if (z) asize += sizeof(zskiplistNode)*dictSize(d);
9719 }
9720 break;
9721 case REDIS_HASH:
9722 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
9723 unsigned char *p = zipmapRewind((unsigned char*)o->ptr);
9724 unsigned int len = zipmapLen((unsigned char*)o->ptr);
9725 unsigned int klen, vlen;
9726 unsigned char *key, *val;
9727
9728 if ((p = zipmapNext(p,&key,&klen,&val,&vlen)) == NULL) {
9729 klen = 0;
9730 vlen = 0;
9731 }
9732 asize = len*(klen+vlen+3);
9733 } else if (o->encoding == REDIS_ENCODING_HT) {
9734 d = o->ptr;
9735 asize = sizeof(dict)+(sizeof(struct dictEntry*)*dictSlots(d));
9736 if (dictSize(d)) {
9737 de = dictGetRandomKey(d);
9738 ele = dictGetEntryKey(de);
9739 elesize = (ele->encoding == REDIS_ENCODING_RAW) ?
9740 (sizeof(*o)+sdslen(ele->ptr)) : sizeof(*o);
9741 ele = dictGetEntryVal(de);
9742 elesize = (ele->encoding == REDIS_ENCODING_RAW) ?
9743 (sizeof(*o)+sdslen(ele->ptr)) : sizeof(*o);
9744 asize += (sizeof(struct dictEntry)+elesize)*dictSize(d);
9745 }
9746 }
9747 break;
9748 }
9749 return (double)minage*log(1+asize);
9750 }
9751
9752 /* Try to swap an object that's a good candidate for swapping.
9753 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
9754 * to swap any object at all.
9755 *
9756 * If 'usethreaded' is true, Redis will try to swap the object in background
9757 * using I/O threads. */
9758 static int vmSwapOneObject(int usethreads) {
9759 int j, i;
9760 struct dictEntry *best = NULL;
9761 double best_swappability = 0;
9762 redisDb *best_db = NULL;
9763 robj *val;
9764 sds key;
9765
9766 for (j = 0; j < server.dbnum; j++) {
9767 redisDb *db = server.db+j;
9768 /* Why maxtries is set to 100?
9769 * Because this way (usually) we'll find 1 object even if just 1% - 2%
9770 * are swappable objects */
9771 int maxtries = 100;
9772
9773 if (dictSize(db->dict) == 0) continue;
9774 for (i = 0; i < 5; i++) {
9775 dictEntry *de;
9776 double swappability;
9777
9778 if (maxtries) maxtries--;
9779 de = dictGetRandomKey(db->dict);
9780 val = dictGetEntryVal(de);
9781 /* Only swap objects that are currently in memory.
9782 *
9783 * Also don't swap shared objects: not a good idea in general and
9784 * we need to ensure that the main thread does not touch the
9785 * object while the I/O thread is using it, but we can't
9786 * control other keys without adding additional mutex. */
9787 if (val->storage != REDIS_VM_MEMORY || val->refcount != 1) {
9788 if (maxtries) i--; /* don't count this try */
9789 continue;
9790 }
9791 swappability = computeObjectSwappability(val);
9792 if (!best || swappability > best_swappability) {
9793 best = de;
9794 best_swappability = swappability;
9795 best_db = db;
9796 }
9797 }
9798 }
9799 if (best == NULL) return REDIS_ERR;
9800 key = dictGetEntryKey(best);
9801 val = dictGetEntryVal(best);
9802
9803 redisLog(REDIS_DEBUG,"Key with best swappability: %s, %f",
9804 key, best_swappability);
9805
9806 /* Swap it */
9807 if (usethreads) {
9808 robj *keyobj = createStringObject(key,sdslen(key));
9809 vmSwapObjectThreaded(keyobj,val,best_db);
9810 decrRefCount(keyobj);
9811 return REDIS_OK;
9812 } else {
9813 vmpointer *vp;
9814
9815 if ((vp = vmSwapObjectBlocking(val)) != NULL) {
9816 dictGetEntryVal(best) = vp;
9817 return REDIS_OK;
9818 } else {
9819 return REDIS_ERR;
9820 }
9821 }
9822 }
9823
9824 static int vmSwapOneObjectBlocking() {
9825 return vmSwapOneObject(0);
9826 }
9827
9828 static int vmSwapOneObjectThreaded() {
9829 return vmSwapOneObject(1);
9830 }
9831
9832 /* Return true if it's safe to swap out objects in a given moment.
9833 * Basically we don't want to swap objects out while there is a BGSAVE
9834 * or a BGAEOREWRITE running in backgroud. */
9835 static int vmCanSwapOut(void) {
9836 return (server.bgsavechildpid == -1 && server.bgrewritechildpid == -1);
9837 }
9838
9839 /* =================== Virtual Memory - Threaded I/O ======================= */
9840
9841 static void freeIOJob(iojob *j) {
9842 if ((j->type == REDIS_IOJOB_PREPARE_SWAP ||
9843 j->type == REDIS_IOJOB_DO_SWAP ||
9844 j->type == REDIS_IOJOB_LOAD) && j->val != NULL)
9845 {
9846 /* we fix the storage type, otherwise decrRefCount() will try to
9847 * kill the I/O thread Job (that does no longer exists). */
9848 if (j->val->storage == REDIS_VM_SWAPPING)
9849 j->val->storage = REDIS_VM_MEMORY;
9850 decrRefCount(j->val);
9851 }
9852 decrRefCount(j->key);
9853 zfree(j);
9854 }
9855
9856 /* Every time a thread finished a Job, it writes a byte into the write side
9857 * of an unix pipe in order to "awake" the main thread, and this function
9858 * is called. */
9859 static void vmThreadedIOCompletedJob(aeEventLoop *el, int fd, void *privdata,
9860 int mask)
9861 {
9862 char buf[1];
9863 int retval, processed = 0, toprocess = -1, trytoswap = 1;
9864 REDIS_NOTUSED(el);
9865 REDIS_NOTUSED(mask);
9866 REDIS_NOTUSED(privdata);
9867
9868 /* For every byte we read in the read side of the pipe, there is one
9869 * I/O job completed to process. */
9870 while((retval = read(fd,buf,1)) == 1) {
9871 iojob *j;
9872 listNode *ln;
9873 struct dictEntry *de;
9874
9875 redisLog(REDIS_DEBUG,"Processing I/O completed job");
9876
9877 /* Get the processed element (the oldest one) */
9878 lockThreadedIO();
9879 assert(listLength(server.io_processed) != 0);
9880 if (toprocess == -1) {
9881 toprocess = (listLength(server.io_processed)*REDIS_MAX_COMPLETED_JOBS_PROCESSED)/100;
9882 if (toprocess <= 0) toprocess = 1;
9883 }
9884 ln = listFirst(server.io_processed);
9885 j = ln->value;
9886 listDelNode(server.io_processed,ln);
9887 unlockThreadedIO();
9888 /* If this job is marked as canceled, just ignore it */
9889 if (j->canceled) {
9890 freeIOJob(j);
9891 continue;
9892 }
9893 /* Post process it in the main thread, as there are things we
9894 * can do just here to avoid race conditions and/or invasive locks */
9895 redisLog(REDIS_DEBUG,"COMPLETED Job type: %d, ID %p, key: %s", j->type, (void*)j->id, (unsigned char*)j->key->ptr);
9896 de = dictFind(j->db->dict,j->key->ptr);
9897 redisAssert(de != NULL);
9898 if (j->type == REDIS_IOJOB_LOAD) {
9899 redisDb *db;
9900 vmpointer *vp = dictGetEntryVal(de);
9901
9902 /* Key loaded, bring it at home */
9903 vmMarkPagesFree(vp->page,vp->usedpages);
9904 redisLog(REDIS_DEBUG, "VM: object %s loaded from disk (threaded)",
9905 (unsigned char*) j->key->ptr);
9906 server.vm_stats_swapped_objects--;
9907 server.vm_stats_swapins++;
9908 dictGetEntryVal(de) = j->val;
9909 incrRefCount(j->val);
9910 db = j->db;
9911 /* Handle clients waiting for this key to be loaded. */
9912 handleClientsBlockedOnSwappedKey(db,j->key);
9913 freeIOJob(j);
9914 zfree(vp);
9915 } else if (j->type == REDIS_IOJOB_PREPARE_SWAP) {
9916 /* Now we know the amount of pages required to swap this object.
9917 * Let's find some space for it, and queue this task again
9918 * rebranded as REDIS_IOJOB_DO_SWAP. */
9919 if (!vmCanSwapOut() ||
9920 vmFindContiguousPages(&j->page,j->pages) == REDIS_ERR)
9921 {
9922 /* Ooops... no space or we can't swap as there is
9923 * a fork()ed Redis trying to save stuff on disk. */
9924 j->val->storage = REDIS_VM_MEMORY; /* undo operation */
9925 freeIOJob(j);
9926 } else {
9927 /* Note that we need to mark this pages as used now,
9928 * if the job will be canceled, we'll mark them as freed
9929 * again. */
9930 vmMarkPagesUsed(j->page,j->pages);
9931 j->type = REDIS_IOJOB_DO_SWAP;
9932 lockThreadedIO();
9933 queueIOJob(j);
9934 unlockThreadedIO();
9935 }
9936 } else if (j->type == REDIS_IOJOB_DO_SWAP) {
9937 vmpointer *vp;
9938
9939 /* Key swapped. We can finally free some memory. */
9940 if (j->val->storage != REDIS_VM_SWAPPING) {
9941 vmpointer *vp = (vmpointer*) j->id;
9942 printf("storage: %d\n",vp->storage);
9943 printf("key->name: %s\n",(char*)j->key->ptr);
9944 printf("val: %p\n",(void*)j->val);
9945 printf("val->type: %d\n",j->val->type);
9946 printf("val->ptr: %s\n",(char*)j->val->ptr);
9947 }
9948 redisAssert(j->val->storage == REDIS_VM_SWAPPING);
9949 vp = createVmPointer(j->val->type);
9950 vp->page = j->page;
9951 vp->usedpages = j->pages;
9952 dictGetEntryVal(de) = vp;
9953 /* Fix the storage otherwise decrRefCount will attempt to
9954 * remove the associated I/O job */
9955 j->val->storage = REDIS_VM_MEMORY;
9956 decrRefCount(j->val);
9957 redisLog(REDIS_DEBUG,
9958 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
9959 (unsigned char*) j->key->ptr,
9960 (unsigned long long) j->page, (unsigned long long) j->pages);
9961 server.vm_stats_swapped_objects++;
9962 server.vm_stats_swapouts++;
9963 freeIOJob(j);
9964 /* Put a few more swap requests in queue if we are still
9965 * out of memory */
9966 if (trytoswap && vmCanSwapOut() &&
9967 zmalloc_used_memory() > server.vm_max_memory)
9968 {
9969 int more = 1;
9970 while(more) {
9971 lockThreadedIO();
9972 more = listLength(server.io_newjobs) <
9973 (unsigned) server.vm_max_threads;
9974 unlockThreadedIO();
9975 /* Don't waste CPU time if swappable objects are rare. */
9976 if (vmSwapOneObjectThreaded() == REDIS_ERR) {
9977 trytoswap = 0;
9978 break;
9979 }
9980 }
9981 }
9982 }
9983 processed++;
9984 if (processed == toprocess) return;
9985 }
9986 if (retval < 0 && errno != EAGAIN) {
9987 redisLog(REDIS_WARNING,
9988 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
9989 strerror(errno));
9990 }
9991 }
9992
9993 static void lockThreadedIO(void) {
9994 pthread_mutex_lock(&server.io_mutex);
9995 }
9996
9997 static void unlockThreadedIO(void) {
9998 pthread_mutex_unlock(&server.io_mutex);
9999 }
10000
10001 /* Remove the specified object from the threaded I/O queue if still not
10002 * processed, otherwise make sure to flag it as canceled. */
10003 static void vmCancelThreadedIOJob(robj *o) {
10004 list *lists[3] = {
10005 server.io_newjobs, /* 0 */
10006 server.io_processing, /* 1 */
10007 server.io_processed /* 2 */
10008 };
10009 int i;
10010
10011 assert(o->storage == REDIS_VM_LOADING || o->storage == REDIS_VM_SWAPPING);
10012 again:
10013 lockThreadedIO();
10014 /* Search for a matching object in one of the queues */
10015 for (i = 0; i < 3; i++) {
10016 listNode *ln;
10017 listIter li;
10018
10019 listRewind(lists[i],&li);
10020 while ((ln = listNext(&li)) != NULL) {
10021 iojob *job = ln->value;
10022
10023 if (job->canceled) continue; /* Skip this, already canceled. */
10024 if (job->id == o) {
10025 redisLog(REDIS_DEBUG,"*** CANCELED %p (key %s) (type %d) (LIST ID %d)\n",
10026 (void*)job, (char*)job->key->ptr, job->type, i);
10027 /* Mark the pages as free since the swap didn't happened
10028 * or happened but is now discarded. */
10029 if (i != 1 && job->type == REDIS_IOJOB_DO_SWAP)
10030 vmMarkPagesFree(job->page,job->pages);
10031 /* Cancel the job. It depends on the list the job is
10032 * living in. */
10033 switch(i) {
10034 case 0: /* io_newjobs */
10035 /* If the job was yet not processed the best thing to do
10036 * is to remove it from the queue at all */
10037 freeIOJob(job);
10038 listDelNode(lists[i],ln);
10039 break;
10040 case 1: /* io_processing */
10041 /* Oh Shi- the thread is messing with the Job:
10042 *
10043 * Probably it's accessing the object if this is a
10044 * PREPARE_SWAP or DO_SWAP job.
10045 * If it's a LOAD job it may be reading from disk and
10046 * if we don't wait for the job to terminate before to
10047 * cancel it, maybe in a few microseconds data can be
10048 * corrupted in this pages. So the short story is:
10049 *
10050 * Better to wait for the job to move into the
10051 * next queue (processed)... */
10052
10053 /* We try again and again until the job is completed. */
10054 unlockThreadedIO();
10055 /* But let's wait some time for the I/O thread
10056 * to finish with this job. After all this condition
10057 * should be very rare. */
10058 usleep(1);
10059 goto again;
10060 case 2: /* io_processed */
10061 /* The job was already processed, that's easy...
10062 * just mark it as canceled so that we'll ignore it
10063 * when processing completed jobs. */
10064 job->canceled = 1;
10065 break;
10066 }
10067 /* Finally we have to adjust the storage type of the object
10068 * in order to "UNDO" the operaiton. */
10069 if (o->storage == REDIS_VM_LOADING)
10070 o->storage = REDIS_VM_SWAPPED;
10071 else if (o->storage == REDIS_VM_SWAPPING)
10072 o->storage = REDIS_VM_MEMORY;
10073 unlockThreadedIO();
10074 redisLog(REDIS_DEBUG,"*** DONE");
10075 return;
10076 }
10077 }
10078 }
10079 unlockThreadedIO();
10080 printf("Not found: %p\n", (void*)o);
10081 redisAssert(1 != 1); /* We should never reach this */
10082 }
10083
10084 static void *IOThreadEntryPoint(void *arg) {
10085 iojob *j;
10086 listNode *ln;
10087 REDIS_NOTUSED(arg);
10088
10089 pthread_detach(pthread_self());
10090 while(1) {
10091 /* Get a new job to process */
10092 lockThreadedIO();
10093 if (listLength(server.io_newjobs) == 0) {
10094 /* No new jobs in queue, exit. */
10095 redisLog(REDIS_DEBUG,"Thread %ld exiting, nothing to do",
10096 (long) pthread_self());
10097 server.io_active_threads--;
10098 unlockThreadedIO();
10099 return NULL;
10100 }
10101 ln = listFirst(server.io_newjobs);
10102 j = ln->value;
10103 listDelNode(server.io_newjobs,ln);
10104 /* Add the job in the processing queue */
10105 j->thread = pthread_self();
10106 listAddNodeTail(server.io_processing,j);
10107 ln = listLast(server.io_processing); /* We use ln later to remove it */
10108 unlockThreadedIO();
10109 redisLog(REDIS_DEBUG,"Thread %ld got a new job (type %d): %p about key '%s'",
10110 (long) pthread_self(), j->type, (void*)j, (char*)j->key->ptr);
10111
10112 /* Process the Job */
10113 if (j->type == REDIS_IOJOB_LOAD) {
10114 vmpointer *vp = (vmpointer*)j->id;
10115 j->val = vmReadObjectFromSwap(j->page,vp->vtype);
10116 } else if (j->type == REDIS_IOJOB_PREPARE_SWAP) {
10117 FILE *fp = fopen("/dev/null","w+");
10118 j->pages = rdbSavedObjectPages(j->val,fp);
10119 fclose(fp);
10120 } else if (j->type == REDIS_IOJOB_DO_SWAP) {
10121 if (vmWriteObjectOnSwap(j->val,j->page) == REDIS_ERR)
10122 j->canceled = 1;
10123 }
10124
10125 /* Done: insert the job into the processed queue */
10126 redisLog(REDIS_DEBUG,"Thread %ld completed the job: %p (key %s)",
10127 (long) pthread_self(), (void*)j, (char*)j->key->ptr);
10128 lockThreadedIO();
10129 listDelNode(server.io_processing,ln);
10130 listAddNodeTail(server.io_processed,j);
10131 unlockThreadedIO();
10132
10133 /* Signal the main thread there is new stuff to process */
10134 assert(write(server.io_ready_pipe_write,"x",1) == 1);
10135 }
10136 return NULL; /* never reached */
10137 }
10138
10139 static void spawnIOThread(void) {
10140 pthread_t thread;
10141 sigset_t mask, omask;
10142 int err;
10143
10144 sigemptyset(&mask);
10145 sigaddset(&mask,SIGCHLD);
10146 sigaddset(&mask,SIGHUP);
10147 sigaddset(&mask,SIGPIPE);
10148 pthread_sigmask(SIG_SETMASK, &mask, &omask);
10149 while ((err = pthread_create(&thread,&server.io_threads_attr,IOThreadEntryPoint,NULL)) != 0) {
10150 redisLog(REDIS_WARNING,"Unable to spawn an I/O thread: %s",
10151 strerror(err));
10152 usleep(1000000);
10153 }
10154 pthread_sigmask(SIG_SETMASK, &omask, NULL);
10155 server.io_active_threads++;
10156 }
10157
10158 /* We need to wait for the last thread to exit before we are able to
10159 * fork() in order to BGSAVE or BGREWRITEAOF. */
10160 static void waitEmptyIOJobsQueue(void) {
10161 while(1) {
10162 int io_processed_len;
10163
10164 lockThreadedIO();
10165 if (listLength(server.io_newjobs) == 0 &&
10166 listLength(server.io_processing) == 0 &&
10167 server.io_active_threads == 0)
10168 {
10169 unlockThreadedIO();
10170 return;
10171 }
10172 /* While waiting for empty jobs queue condition we post-process some
10173 * finshed job, as I/O threads may be hanging trying to write against
10174 * the io_ready_pipe_write FD but there are so much pending jobs that
10175 * it's blocking. */
10176 io_processed_len = listLength(server.io_processed);
10177 unlockThreadedIO();
10178 if (io_processed_len) {
10179 vmThreadedIOCompletedJob(NULL,server.io_ready_pipe_read,NULL,0);
10180 usleep(1000); /* 1 millisecond */
10181 } else {
10182 usleep(10000); /* 10 milliseconds */
10183 }
10184 }
10185 }
10186
10187 static void vmReopenSwapFile(void) {
10188 /* Note: we don't close the old one as we are in the child process
10189 * and don't want to mess at all with the original file object. */
10190 server.vm_fp = fopen(server.vm_swap_file,"r+b");
10191 if (server.vm_fp == NULL) {
10192 redisLog(REDIS_WARNING,"Can't re-open the VM swap file: %s. Exiting.",
10193 server.vm_swap_file);
10194 _exit(1);
10195 }
10196 server.vm_fd = fileno(server.vm_fp);
10197 }
10198
10199 /* This function must be called while with threaded IO locked */
10200 static void queueIOJob(iojob *j) {
10201 redisLog(REDIS_DEBUG,"Queued IO Job %p type %d about key '%s'\n",
10202 (void*)j, j->type, (char*)j->key->ptr);
10203 listAddNodeTail(server.io_newjobs,j);
10204 if (server.io_active_threads < server.vm_max_threads)
10205 spawnIOThread();
10206 }
10207
10208 static int vmSwapObjectThreaded(robj *key, robj *val, redisDb *db) {
10209 iojob *j;
10210
10211 j = zmalloc(sizeof(*j));
10212 j->type = REDIS_IOJOB_PREPARE_SWAP;
10213 j->db = db;
10214 j->key = key;
10215 incrRefCount(key);
10216 j->id = j->val = val;
10217 incrRefCount(val);
10218 j->canceled = 0;
10219 j->thread = (pthread_t) -1;
10220 val->storage = REDIS_VM_SWAPPING;
10221
10222 lockThreadedIO();
10223 queueIOJob(j);
10224 unlockThreadedIO();
10225 return REDIS_OK;
10226 }
10227
10228 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
10229
10230 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
10231 * If there is not already a job loading the key, it is craeted.
10232 * The key is added to the io_keys list in the client structure, and also
10233 * in the hash table mapping swapped keys to waiting clients, that is,
10234 * server.io_waited_keys. */
10235 static int waitForSwappedKey(redisClient *c, robj *key) {
10236 struct dictEntry *de;
10237 robj *o;
10238 list *l;
10239
10240 /* If the key does not exist or is already in RAM we don't need to
10241 * block the client at all. */
10242 de = dictFind(c->db->dict,key->ptr);
10243 if (de == NULL) return 0;
10244 o = dictGetEntryVal(de);
10245 if (o->storage == REDIS_VM_MEMORY) {
10246 return 0;
10247 } else if (o->storage == REDIS_VM_SWAPPING) {
10248 /* We were swapping the key, undo it! */
10249 vmCancelThreadedIOJob(o);
10250 return 0;
10251 }
10252
10253 /* OK: the key is either swapped, or being loaded just now. */
10254
10255 /* Add the key to the list of keys this client is waiting for.
10256 * This maps clients to keys they are waiting for. */
10257 listAddNodeTail(c->io_keys,key);
10258 incrRefCount(key);
10259
10260 /* Add the client to the swapped keys => clients waiting map. */
10261 de = dictFind(c->db->io_keys,key);
10262 if (de == NULL) {
10263 int retval;
10264
10265 /* For every key we take a list of clients blocked for it */
10266 l = listCreate();
10267 retval = dictAdd(c->db->io_keys,key,l);
10268 incrRefCount(key);
10269 assert(retval == DICT_OK);
10270 } else {
10271 l = dictGetEntryVal(de);
10272 }
10273 listAddNodeTail(l,c);
10274
10275 /* Are we already loading the key from disk? If not create a job */
10276 if (o->storage == REDIS_VM_SWAPPED) {
10277 iojob *j;
10278 vmpointer *vp = (vmpointer*)o;
10279
10280 o->storage = REDIS_VM_LOADING;
10281 j = zmalloc(sizeof(*j));
10282 j->type = REDIS_IOJOB_LOAD;
10283 j->db = c->db;
10284 j->id = (robj*)vp;
10285 j->key = key;
10286 incrRefCount(key);
10287 j->page = vp->page;
10288 j->val = NULL;
10289 j->canceled = 0;
10290 j->thread = (pthread_t) -1;
10291 lockThreadedIO();
10292 queueIOJob(j);
10293 unlockThreadedIO();
10294 }
10295 return 1;
10296 }
10297
10298 /* Preload keys for any command with first, last and step values for
10299 * the command keys prototype, as defined in the command table. */
10300 static void waitForMultipleSwappedKeys(redisClient *c, struct redisCommand *cmd, int argc, robj **argv) {
10301 int j, last;
10302 if (cmd->vm_firstkey == 0) return;
10303 last = cmd->vm_lastkey;
10304 if (last < 0) last = argc+last;
10305 for (j = cmd->vm_firstkey; j <= last; j += cmd->vm_keystep) {
10306 redisAssert(j < argc);
10307 waitForSwappedKey(c,argv[j]);
10308 }
10309 }
10310
10311 /* Preload keys needed for the ZUNIONSTORE and ZINTERSTORE commands.
10312 * Note that the number of keys to preload is user-defined, so we need to
10313 * apply a sanity check against argc. */
10314 static void zunionInterBlockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd, int argc, robj **argv) {
10315 int i, num;
10316 REDIS_NOTUSED(cmd);
10317
10318 num = atoi(argv[2]->ptr);
10319 if (num > (argc-3)) return;
10320 for (i = 0; i < num; i++) {
10321 waitForSwappedKey(c,argv[3+i]);
10322 }
10323 }
10324
10325 /* Preload keys needed to execute the entire MULTI/EXEC block.
10326 *
10327 * This function is called by blockClientOnSwappedKeys when EXEC is issued,
10328 * and will block the client when any command requires a swapped out value. */
10329 static void execBlockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd, int argc, robj **argv) {
10330 int i, margc;
10331 struct redisCommand *mcmd;
10332 robj **margv;
10333 REDIS_NOTUSED(cmd);
10334 REDIS_NOTUSED(argc);
10335 REDIS_NOTUSED(argv);
10336
10337 if (!(c->flags & REDIS_MULTI)) return;
10338 for (i = 0; i < c->mstate.count; i++) {
10339 mcmd = c->mstate.commands[i].cmd;
10340 margc = c->mstate.commands[i].argc;
10341 margv = c->mstate.commands[i].argv;
10342
10343 if (mcmd->vm_preload_proc != NULL) {
10344 mcmd->vm_preload_proc(c,mcmd,margc,margv);
10345 } else {
10346 waitForMultipleSwappedKeys(c,mcmd,margc,margv);
10347 }
10348 }
10349 }
10350
10351 /* Is this client attempting to run a command against swapped keys?
10352 * If so, block it ASAP, load the keys in background, then resume it.
10353 *
10354 * The important idea about this function is that it can fail! If keys will
10355 * still be swapped when the client is resumed, this key lookups will
10356 * just block loading keys from disk. In practical terms this should only
10357 * happen with SORT BY command or if there is a bug in this function.
10358 *
10359 * Return 1 if the client is marked as blocked, 0 if the client can
10360 * continue as the keys it is going to access appear to be in memory. */
10361 static int blockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd) {
10362 if (cmd->vm_preload_proc != NULL) {
10363 cmd->vm_preload_proc(c,cmd,c->argc,c->argv);
10364 } else {
10365 waitForMultipleSwappedKeys(c,cmd,c->argc,c->argv);
10366 }
10367
10368 /* If the client was blocked for at least one key, mark it as blocked. */
10369 if (listLength(c->io_keys)) {
10370 c->flags |= REDIS_IO_WAIT;
10371 aeDeleteFileEvent(server.el,c->fd,AE_READABLE);
10372 server.vm_blocked_clients++;
10373 return 1;
10374 } else {
10375 return 0;
10376 }
10377 }
10378
10379 /* Remove the 'key' from the list of blocked keys for a given client.
10380 *
10381 * The function returns 1 when there are no longer blocking keys after
10382 * the current one was removed (and the client can be unblocked). */
10383 static int dontWaitForSwappedKey(redisClient *c, robj *key) {
10384 list *l;
10385 listNode *ln;
10386 listIter li;
10387 struct dictEntry *de;
10388
10389 /* Remove the key from the list of keys this client is waiting for. */
10390 listRewind(c->io_keys,&li);
10391 while ((ln = listNext(&li)) != NULL) {
10392 if (equalStringObjects(ln->value,key)) {
10393 listDelNode(c->io_keys,ln);
10394 break;
10395 }
10396 }
10397 assert(ln != NULL);
10398
10399 /* Remove the client form the key => waiting clients map. */
10400 de = dictFind(c->db->io_keys,key);
10401 assert(de != NULL);
10402 l = dictGetEntryVal(de);
10403 ln = listSearchKey(l,c);
10404 assert(ln != NULL);
10405 listDelNode(l,ln);
10406 if (listLength(l) == 0)
10407 dictDelete(c->db->io_keys,key);
10408
10409 return listLength(c->io_keys) == 0;
10410 }
10411
10412 /* Every time we now a key was loaded back in memory, we handle clients
10413 * waiting for this key if any. */
10414 static void handleClientsBlockedOnSwappedKey(redisDb *db, robj *key) {
10415 struct dictEntry *de;
10416 list *l;
10417 listNode *ln;
10418 int len;
10419
10420 de = dictFind(db->io_keys,key);
10421 if (!de) return;
10422
10423 l = dictGetEntryVal(de);
10424 len = listLength(l);
10425 /* Note: we can't use something like while(listLength(l)) as the list
10426 * can be freed by the calling function when we remove the last element. */
10427 while (len--) {
10428 ln = listFirst(l);
10429 redisClient *c = ln->value;
10430
10431 if (dontWaitForSwappedKey(c,key)) {
10432 /* Put the client in the list of clients ready to go as we
10433 * loaded all the keys about it. */
10434 listAddNodeTail(server.io_ready_clients,c);
10435 }
10436 }
10437 }
10438
10439 /* =========================== Remote Configuration ========================= */
10440
10441 static void configSetCommand(redisClient *c) {
10442 robj *o = getDecodedObject(c->argv[3]);
10443 long long ll;
10444
10445 if (!strcasecmp(c->argv[2]->ptr,"dbfilename")) {
10446 zfree(server.dbfilename);
10447 server.dbfilename = zstrdup(o->ptr);
10448 } else if (!strcasecmp(c->argv[2]->ptr,"requirepass")) {
10449 zfree(server.requirepass);
10450 server.requirepass = zstrdup(o->ptr);
10451 } else if (!strcasecmp(c->argv[2]->ptr,"masterauth")) {
10452 zfree(server.masterauth);
10453 server.masterauth = zstrdup(o->ptr);
10454 } else if (!strcasecmp(c->argv[2]->ptr,"maxmemory")) {
10455 if (getLongLongFromObject(o,&ll) == REDIS_ERR ||
10456 ll < 0) goto badfmt;
10457 server.maxmemory = ll;
10458 } else if (!strcasecmp(c->argv[2]->ptr,"timeout")) {
10459 if (getLongLongFromObject(o,&ll) == REDIS_ERR ||
10460 ll < 0 || ll > LONG_MAX) goto badfmt;
10461 server.maxidletime = ll;
10462 } else if (!strcasecmp(c->argv[2]->ptr,"appendfsync")) {
10463 if (!strcasecmp(o->ptr,"no")) {
10464 server.appendfsync = APPENDFSYNC_NO;
10465 } else if (!strcasecmp(o->ptr,"everysec")) {
10466 server.appendfsync = APPENDFSYNC_EVERYSEC;
10467 } else if (!strcasecmp(o->ptr,"always")) {
10468 server.appendfsync = APPENDFSYNC_ALWAYS;
10469 } else {
10470 goto badfmt;
10471 }
10472 } else if (!strcasecmp(c->argv[2]->ptr,"no-appendfsync-on-rewrite")) {
10473 int yn = yesnotoi(o->ptr);
10474
10475 if (yn == -1) goto badfmt;
10476 server.no_appendfsync_on_rewrite = yn;
10477 } else if (!strcasecmp(c->argv[2]->ptr,"appendonly")) {
10478 int old = server.appendonly;
10479 int new = yesnotoi(o->ptr);
10480
10481 if (new == -1) goto badfmt;
10482 if (old != new) {
10483 if (new == 0) {
10484 stopAppendOnly();
10485 } else {
10486 if (startAppendOnly() == REDIS_ERR) {
10487 addReplySds(c,sdscatprintf(sdsempty(),
10488 "-ERR Unable to turn on AOF. Check server logs.\r\n"));
10489 decrRefCount(o);
10490 return;
10491 }
10492 }
10493 }
10494 } else if (!strcasecmp(c->argv[2]->ptr,"save")) {
10495 int vlen, j;
10496 sds *v = sdssplitlen(o->ptr,sdslen(o->ptr)," ",1,&vlen);
10497
10498 /* Perform sanity check before setting the new config:
10499 * - Even number of args
10500 * - Seconds >= 1, changes >= 0 */
10501 if (vlen & 1) {
10502 sdsfreesplitres(v,vlen);
10503 goto badfmt;
10504 }
10505 for (j = 0; j < vlen; j++) {
10506 char *eptr;
10507 long val;
10508
10509 val = strtoll(v[j], &eptr, 10);
10510 if (eptr[0] != '\0' ||
10511 ((j & 1) == 0 && val < 1) ||
10512 ((j & 1) == 1 && val < 0)) {
10513 sdsfreesplitres(v,vlen);
10514 goto badfmt;
10515 }
10516 }
10517 /* Finally set the new config */
10518 resetServerSaveParams();
10519 for (j = 0; j < vlen; j += 2) {
10520 time_t seconds;
10521 int changes;
10522
10523 seconds = strtoll(v[j],NULL,10);
10524 changes = strtoll(v[j+1],NULL,10);
10525 appendServerSaveParams(seconds, changes);
10526 }
10527 sdsfreesplitres(v,vlen);
10528 } else {
10529 addReplySds(c,sdscatprintf(sdsempty(),
10530 "-ERR not supported CONFIG parameter %s\r\n",
10531 (char*)c->argv[2]->ptr));
10532 decrRefCount(o);
10533 return;
10534 }
10535 decrRefCount(o);
10536 addReply(c,shared.ok);
10537 return;
10538
10539 badfmt: /* Bad format errors */
10540 addReplySds(c,sdscatprintf(sdsempty(),
10541 "-ERR invalid argument '%s' for CONFIG SET '%s'\r\n",
10542 (char*)o->ptr,
10543 (char*)c->argv[2]->ptr));
10544 decrRefCount(o);
10545 }
10546
10547 static void configGetCommand(redisClient *c) {
10548 robj *o = getDecodedObject(c->argv[2]);
10549 robj *lenobj = createObject(REDIS_STRING,NULL);
10550 char *pattern = o->ptr;
10551 int matches = 0;
10552
10553 addReply(c,lenobj);
10554 decrRefCount(lenobj);
10555
10556 if (stringmatch(pattern,"dbfilename",0)) {
10557 addReplyBulkCString(c,"dbfilename");
10558 addReplyBulkCString(c,server.dbfilename);
10559 matches++;
10560 }
10561 if (stringmatch(pattern,"requirepass",0)) {
10562 addReplyBulkCString(c,"requirepass");
10563 addReplyBulkCString(c,server.requirepass);
10564 matches++;
10565 }
10566 if (stringmatch(pattern,"masterauth",0)) {
10567 addReplyBulkCString(c,"masterauth");
10568 addReplyBulkCString(c,server.masterauth);
10569 matches++;
10570 }
10571 if (stringmatch(pattern,"maxmemory",0)) {
10572 char buf[128];
10573
10574 ll2string(buf,128,server.maxmemory);
10575 addReplyBulkCString(c,"maxmemory");
10576 addReplyBulkCString(c,buf);
10577 matches++;
10578 }
10579 if (stringmatch(pattern,"timeout",0)) {
10580 char buf[128];
10581
10582 ll2string(buf,128,server.maxidletime);
10583 addReplyBulkCString(c,"timeout");
10584 addReplyBulkCString(c,buf);
10585 matches++;
10586 }
10587 if (stringmatch(pattern,"appendonly",0)) {
10588 addReplyBulkCString(c,"appendonly");
10589 addReplyBulkCString(c,server.appendonly ? "yes" : "no");
10590 matches++;
10591 }
10592 if (stringmatch(pattern,"no-appendfsync-on-rewrite",0)) {
10593 addReplyBulkCString(c,"no-appendfsync-on-rewrite");
10594 addReplyBulkCString(c,server.no_appendfsync_on_rewrite ? "yes" : "no");
10595 matches++;
10596 }
10597 if (stringmatch(pattern,"appendfsync",0)) {
10598 char *policy;
10599
10600 switch(server.appendfsync) {
10601 case APPENDFSYNC_NO: policy = "no"; break;
10602 case APPENDFSYNC_EVERYSEC: policy = "everysec"; break;
10603 case APPENDFSYNC_ALWAYS: policy = "always"; break;
10604 default: policy = "unknown"; break; /* too harmless to panic */
10605 }
10606 addReplyBulkCString(c,"appendfsync");
10607 addReplyBulkCString(c,policy);
10608 matches++;
10609 }
10610 if (stringmatch(pattern,"save",0)) {
10611 sds buf = sdsempty();
10612 int j;
10613
10614 for (j = 0; j < server.saveparamslen; j++) {
10615 buf = sdscatprintf(buf,"%ld %d",
10616 server.saveparams[j].seconds,
10617 server.saveparams[j].changes);
10618 if (j != server.saveparamslen-1)
10619 buf = sdscatlen(buf," ",1);
10620 }
10621 addReplyBulkCString(c,"save");
10622 addReplyBulkCString(c,buf);
10623 sdsfree(buf);
10624 matches++;
10625 }
10626 decrRefCount(o);
10627 lenobj->ptr = sdscatprintf(sdsempty(),"*%d\r\n",matches*2);
10628 }
10629
10630 static void configCommand(redisClient *c) {
10631 if (!strcasecmp(c->argv[1]->ptr,"set")) {
10632 if (c->argc != 4) goto badarity;
10633 configSetCommand(c);
10634 } else if (!strcasecmp(c->argv[1]->ptr,"get")) {
10635 if (c->argc != 3) goto badarity;
10636 configGetCommand(c);
10637 } else if (!strcasecmp(c->argv[1]->ptr,"resetstat")) {
10638 if (c->argc != 2) goto badarity;
10639 server.stat_numcommands = 0;
10640 server.stat_numconnections = 0;
10641 server.stat_expiredkeys = 0;
10642 server.stat_starttime = time(NULL);
10643 addReply(c,shared.ok);
10644 } else {
10645 addReplySds(c,sdscatprintf(sdsempty(),
10646 "-ERR CONFIG subcommand must be one of GET, SET, RESETSTAT\r\n"));
10647 }
10648 return;
10649
10650 badarity:
10651 addReplySds(c,sdscatprintf(sdsempty(),
10652 "-ERR Wrong number of arguments for CONFIG %s\r\n",
10653 (char*) c->argv[1]->ptr));
10654 }
10655
10656 /* =========================== Pubsub implementation ======================== */
10657
10658 static void freePubsubPattern(void *p) {
10659 pubsubPattern *pat = p;
10660
10661 decrRefCount(pat->pattern);
10662 zfree(pat);
10663 }
10664
10665 static int listMatchPubsubPattern(void *a, void *b) {
10666 pubsubPattern *pa = a, *pb = b;
10667
10668 return (pa->client == pb->client) &&
10669 (equalStringObjects(pa->pattern,pb->pattern));
10670 }
10671
10672 /* Subscribe a client to a channel. Returns 1 if the operation succeeded, or
10673 * 0 if the client was already subscribed to that channel. */
10674 static int pubsubSubscribeChannel(redisClient *c, robj *channel) {
10675 struct dictEntry *de;
10676 list *clients = NULL;
10677 int retval = 0;
10678
10679 /* Add the channel to the client -> channels hash table */
10680 if (dictAdd(c->pubsub_channels,channel,NULL) == DICT_OK) {
10681 retval = 1;
10682 incrRefCount(channel);
10683 /* Add the client to the channel -> list of clients hash table */
10684 de = dictFind(server.pubsub_channels,channel);
10685 if (de == NULL) {
10686 clients = listCreate();
10687 dictAdd(server.pubsub_channels,channel,clients);
10688 incrRefCount(channel);
10689 } else {
10690 clients = dictGetEntryVal(de);
10691 }
10692 listAddNodeTail(clients,c);
10693 }
10694 /* Notify the client */
10695 addReply(c,shared.mbulk3);
10696 addReply(c,shared.subscribebulk);
10697 addReplyBulk(c,channel);
10698 addReplyLongLong(c,dictSize(c->pubsub_channels)+listLength(c->pubsub_patterns));
10699 return retval;
10700 }
10701
10702 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
10703 * 0 if the client was not subscribed to the specified channel. */
10704 static int pubsubUnsubscribeChannel(redisClient *c, robj *channel, int notify) {
10705 struct dictEntry *de;
10706 list *clients;
10707 listNode *ln;
10708 int retval = 0;
10709
10710 /* Remove the channel from the client -> channels hash table */
10711 incrRefCount(channel); /* channel may be just a pointer to the same object
10712 we have in the hash tables. Protect it... */
10713 if (dictDelete(c->pubsub_channels,channel) == DICT_OK) {
10714 retval = 1;
10715 /* Remove the client from the channel -> clients list hash table */
10716 de = dictFind(server.pubsub_channels,channel);
10717 assert(de != NULL);
10718 clients = dictGetEntryVal(de);
10719 ln = listSearchKey(clients,c);
10720 assert(ln != NULL);
10721 listDelNode(clients,ln);
10722 if (listLength(clients) == 0) {
10723 /* Free the list and associated hash entry at all if this was
10724 * the latest client, so that it will be possible to abuse
10725 * Redis PUBSUB creating millions of channels. */
10726 dictDelete(server.pubsub_channels,channel);
10727 }
10728 }
10729 /* Notify the client */
10730 if (notify) {
10731 addReply(c,shared.mbulk3);
10732 addReply(c,shared.unsubscribebulk);
10733 addReplyBulk(c,channel);
10734 addReplyLongLong(c,dictSize(c->pubsub_channels)+
10735 listLength(c->pubsub_patterns));
10736
10737 }
10738 decrRefCount(channel); /* it is finally safe to release it */
10739 return retval;
10740 }
10741
10742 /* Subscribe a client to a pattern. Returns 1 if the operation succeeded, or 0 if the clinet was already subscribed to that pattern. */
10743 static int pubsubSubscribePattern(redisClient *c, robj *pattern) {
10744 int retval = 0;
10745
10746 if (listSearchKey(c->pubsub_patterns,pattern) == NULL) {
10747 retval = 1;
10748 pubsubPattern *pat;
10749 listAddNodeTail(c->pubsub_patterns,pattern);
10750 incrRefCount(pattern);
10751 pat = zmalloc(sizeof(*pat));
10752 pat->pattern = getDecodedObject(pattern);
10753 pat->client = c;
10754 listAddNodeTail(server.pubsub_patterns,pat);
10755 }
10756 /* Notify the client */
10757 addReply(c,shared.mbulk3);
10758 addReply(c,shared.psubscribebulk);
10759 addReplyBulk(c,pattern);
10760 addReplyLongLong(c,dictSize(c->pubsub_channels)+listLength(c->pubsub_patterns));
10761 return retval;
10762 }
10763
10764 /* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
10765 * 0 if the client was not subscribed to the specified channel. */
10766 static int pubsubUnsubscribePattern(redisClient *c, robj *pattern, int notify) {
10767 listNode *ln;
10768 pubsubPattern pat;
10769 int retval = 0;
10770
10771 incrRefCount(pattern); /* Protect the object. May be the same we remove */
10772 if ((ln = listSearchKey(c->pubsub_patterns,pattern)) != NULL) {
10773 retval = 1;
10774 listDelNode(c->pubsub_patterns,ln);
10775 pat.client = c;
10776 pat.pattern = pattern;
10777 ln = listSearchKey(server.pubsub_patterns,&pat);
10778 listDelNode(server.pubsub_patterns,ln);
10779 }
10780 /* Notify the client */
10781 if (notify) {
10782 addReply(c,shared.mbulk3);
10783 addReply(c,shared.punsubscribebulk);
10784 addReplyBulk(c,pattern);
10785 addReplyLongLong(c,dictSize(c->pubsub_channels)+
10786 listLength(c->pubsub_patterns));
10787 }
10788 decrRefCount(pattern);
10789 return retval;
10790 }
10791
10792 /* Unsubscribe from all the channels. Return the number of channels the
10793 * client was subscribed from. */
10794 static int pubsubUnsubscribeAllChannels(redisClient *c, int notify) {
10795 dictIterator *di = dictGetIterator(c->pubsub_channels);
10796 dictEntry *de;
10797 int count = 0;
10798
10799 while((de = dictNext(di)) != NULL) {
10800 robj *channel = dictGetEntryKey(de);
10801
10802 count += pubsubUnsubscribeChannel(c,channel,notify);
10803 }
10804 dictReleaseIterator(di);
10805 return count;
10806 }
10807
10808 /* Unsubscribe from all the patterns. Return the number of patterns the
10809 * client was subscribed from. */
10810 static int pubsubUnsubscribeAllPatterns(redisClient *c, int notify) {
10811 listNode *ln;
10812 listIter li;
10813 int count = 0;
10814
10815 listRewind(c->pubsub_patterns,&li);
10816 while ((ln = listNext(&li)) != NULL) {
10817 robj *pattern = ln->value;
10818
10819 count += pubsubUnsubscribePattern(c,pattern,notify);
10820 }
10821 return count;
10822 }
10823
10824 /* Publish a message */
10825 static int pubsubPublishMessage(robj *channel, robj *message) {
10826 int receivers = 0;
10827 struct dictEntry *de;
10828 listNode *ln;
10829 listIter li;
10830
10831 /* Send to clients listening for that channel */
10832 de = dictFind(server.pubsub_channels,channel);
10833 if (de) {
10834 list *list = dictGetEntryVal(de);
10835 listNode *ln;
10836 listIter li;
10837
10838 listRewind(list,&li);
10839 while ((ln = listNext(&li)) != NULL) {
10840 redisClient *c = ln->value;
10841
10842 addReply(c,shared.mbulk3);
10843 addReply(c,shared.messagebulk);
10844 addReplyBulk(c,channel);
10845 addReplyBulk(c,message);
10846 receivers++;
10847 }
10848 }
10849 /* Send to clients listening to matching channels */
10850 if (listLength(server.pubsub_patterns)) {
10851 listRewind(server.pubsub_patterns,&li);
10852 channel = getDecodedObject(channel);
10853 while ((ln = listNext(&li)) != NULL) {
10854 pubsubPattern *pat = ln->value;
10855
10856 if (stringmatchlen((char*)pat->pattern->ptr,
10857 sdslen(pat->pattern->ptr),
10858 (char*)channel->ptr,
10859 sdslen(channel->ptr),0)) {
10860 addReply(pat->client,shared.mbulk4);
10861 addReply(pat->client,shared.pmessagebulk);
10862 addReplyBulk(pat->client,pat->pattern);
10863 addReplyBulk(pat->client,channel);
10864 addReplyBulk(pat->client,message);
10865 receivers++;
10866 }
10867 }
10868 decrRefCount(channel);
10869 }
10870 return receivers;
10871 }
10872
10873 static void subscribeCommand(redisClient *c) {
10874 int j;
10875
10876 for (j = 1; j < c->argc; j++)
10877 pubsubSubscribeChannel(c,c->argv[j]);
10878 }
10879
10880 static void unsubscribeCommand(redisClient *c) {
10881 if (c->argc == 1) {
10882 pubsubUnsubscribeAllChannels(c,1);
10883 return;
10884 } else {
10885 int j;
10886
10887 for (j = 1; j < c->argc; j++)
10888 pubsubUnsubscribeChannel(c,c->argv[j],1);
10889 }
10890 }
10891
10892 static void psubscribeCommand(redisClient *c) {
10893 int j;
10894
10895 for (j = 1; j < c->argc; j++)
10896 pubsubSubscribePattern(c,c->argv[j]);
10897 }
10898
10899 static void punsubscribeCommand(redisClient *c) {
10900 if (c->argc == 1) {
10901 pubsubUnsubscribeAllPatterns(c,1);
10902 return;
10903 } else {
10904 int j;
10905
10906 for (j = 1; j < c->argc; j++)
10907 pubsubUnsubscribePattern(c,c->argv[j],1);
10908 }
10909 }
10910
10911 static void publishCommand(redisClient *c) {
10912 int receivers = pubsubPublishMessage(c->argv[1],c->argv[2]);
10913 addReplyLongLong(c,receivers);
10914 }
10915
10916 /* ===================== WATCH (CAS alike for MULTI/EXEC) ===================
10917 *
10918 * The implementation uses a per-DB hash table mapping keys to list of clients
10919 * WATCHing those keys, so that given a key that is going to be modified
10920 * we can mark all the associated clients as dirty.
10921 *
10922 * Also every client contains a list of WATCHed keys so that's possible to
10923 * un-watch such keys when the client is freed or when UNWATCH is called. */
10924
10925 /* In the client->watched_keys list we need to use watchedKey structures
10926 * as in order to identify a key in Redis we need both the key name and the
10927 * DB */
10928 typedef struct watchedKey {
10929 robj *key;
10930 redisDb *db;
10931 } watchedKey;
10932
10933 /* Watch for the specified key */
10934 static void watchForKey(redisClient *c, robj *key) {
10935 list *clients = NULL;
10936 listIter li;
10937 listNode *ln;
10938 watchedKey *wk;
10939
10940 /* Check if we are already watching for this key */
10941 listRewind(c->watched_keys,&li);
10942 while((ln = listNext(&li))) {
10943 wk = listNodeValue(ln);
10944 if (wk->db == c->db && equalStringObjects(key,wk->key))
10945 return; /* Key already watched */
10946 }
10947 /* This key is not already watched in this DB. Let's add it */
10948 clients = dictFetchValue(c->db->watched_keys,key);
10949 if (!clients) {
10950 clients = listCreate();
10951 dictAdd(c->db->watched_keys,key,clients);
10952 incrRefCount(key);
10953 }
10954 listAddNodeTail(clients,c);
10955 /* Add the new key to the lits of keys watched by this client */
10956 wk = zmalloc(sizeof(*wk));
10957 wk->key = key;
10958 wk->db = c->db;
10959 incrRefCount(key);
10960 listAddNodeTail(c->watched_keys,wk);
10961 }
10962
10963 /* Unwatch all the keys watched by this client. To clean the EXEC dirty
10964 * flag is up to the caller. */
10965 static void unwatchAllKeys(redisClient *c) {
10966 listIter li;
10967 listNode *ln;
10968
10969 if (listLength(c->watched_keys) == 0) return;
10970 listRewind(c->watched_keys,&li);
10971 while((ln = listNext(&li))) {
10972 list *clients;
10973 watchedKey *wk;
10974
10975 /* Lookup the watched key -> clients list and remove the client
10976 * from the list */
10977 wk = listNodeValue(ln);
10978 clients = dictFetchValue(wk->db->watched_keys, wk->key);
10979 assert(clients != NULL);
10980 listDelNode(clients,listSearchKey(clients,c));
10981 /* Kill the entry at all if this was the only client */
10982 if (listLength(clients) == 0)
10983 dictDelete(wk->db->watched_keys, wk->key);
10984 /* Remove this watched key from the client->watched list */
10985 listDelNode(c->watched_keys,ln);
10986 decrRefCount(wk->key);
10987 zfree(wk);
10988 }
10989 }
10990
10991 /* "Touch" a key, so that if this key is being WATCHed by some client the
10992 * next EXEC will fail. */
10993 static void touchWatchedKey(redisDb *db, robj *key) {
10994 list *clients;
10995 listIter li;
10996 listNode *ln;
10997
10998 if (dictSize(db->watched_keys) == 0) return;
10999 clients = dictFetchValue(db->watched_keys, key);
11000 if (!clients) return;
11001
11002 /* Mark all the clients watching this key as REDIS_DIRTY_CAS */
11003 /* Check if we are already watching for this key */
11004 listRewind(clients,&li);
11005 while((ln = listNext(&li))) {
11006 redisClient *c = listNodeValue(ln);
11007
11008 c->flags |= REDIS_DIRTY_CAS;
11009 }
11010 }
11011
11012 /* On FLUSHDB or FLUSHALL all the watched keys that are present before the
11013 * flush but will be deleted as effect of the flushing operation should
11014 * be touched. "dbid" is the DB that's getting the flush. -1 if it is
11015 * a FLUSHALL operation (all the DBs flushed). */
11016 static void touchWatchedKeysOnFlush(int dbid) {
11017 listIter li1, li2;
11018 listNode *ln;
11019
11020 /* For every client, check all the waited keys */
11021 listRewind(server.clients,&li1);
11022 while((ln = listNext(&li1))) {
11023 redisClient *c = listNodeValue(ln);
11024 listRewind(c->watched_keys,&li2);
11025 while((ln = listNext(&li2))) {
11026 watchedKey *wk = listNodeValue(ln);
11027
11028 /* For every watched key matching the specified DB, if the
11029 * key exists, mark the client as dirty, as the key will be
11030 * removed. */
11031 if (dbid == -1 || wk->db->id == dbid) {
11032 if (dictFind(wk->db->dict, wk->key->ptr) != NULL)
11033 c->flags |= REDIS_DIRTY_CAS;
11034 }
11035 }
11036 }
11037 }
11038
11039 static void watchCommand(redisClient *c) {
11040 int j;
11041
11042 if (c->flags & REDIS_MULTI) {
11043 addReplySds(c,sdsnew("-ERR WATCH inside MULTI is not allowed\r\n"));
11044 return;
11045 }
11046 for (j = 1; j < c->argc; j++)
11047 watchForKey(c,c->argv[j]);
11048 addReply(c,shared.ok);
11049 }
11050
11051 static void unwatchCommand(redisClient *c) {
11052 unwatchAllKeys(c);
11053 c->flags &= (~REDIS_DIRTY_CAS);
11054 addReply(c,shared.ok);
11055 }
11056
11057 /* ================================= Debugging ============================== */
11058
11059 /* Compute the sha1 of string at 's' with 'len' bytes long.
11060 * The SHA1 is then xored againt the string pointed by digest.
11061 * Since xor is commutative, this operation is used in order to
11062 * "add" digests relative to unordered elements.
11063 *
11064 * So digest(a,b,c,d) will be the same of digest(b,a,c,d) */
11065 static void xorDigest(unsigned char *digest, void *ptr, size_t len) {
11066 SHA1_CTX ctx;
11067 unsigned char hash[20], *s = ptr;
11068 int j;
11069
11070 SHA1Init(&ctx);
11071 SHA1Update(&ctx,s,len);
11072 SHA1Final(hash,&ctx);
11073
11074 for (j = 0; j < 20; j++)
11075 digest[j] ^= hash[j];
11076 }
11077
11078 static void xorObjectDigest(unsigned char *digest, robj *o) {
11079 o = getDecodedObject(o);
11080 xorDigest(digest,o->ptr,sdslen(o->ptr));
11081 decrRefCount(o);
11082 }
11083
11084 /* This function instead of just computing the SHA1 and xoring it
11085 * against diget, also perform the digest of "digest" itself and
11086 * replace the old value with the new one.
11087 *
11088 * So the final digest will be:
11089 *
11090 * digest = SHA1(digest xor SHA1(data))
11091 *
11092 * This function is used every time we want to preserve the order so
11093 * that digest(a,b,c,d) will be different than digest(b,c,d,a)
11094 *
11095 * Also note that mixdigest("foo") followed by mixdigest("bar")
11096 * will lead to a different digest compared to "fo", "obar".
11097 */
11098 static void mixDigest(unsigned char *digest, void *ptr, size_t len) {
11099 SHA1_CTX ctx;
11100 char *s = ptr;
11101
11102 xorDigest(digest,s,len);
11103 SHA1Init(&ctx);
11104 SHA1Update(&ctx,digest,20);
11105 SHA1Final(digest,&ctx);
11106 }
11107
11108 static void mixObjectDigest(unsigned char *digest, robj *o) {
11109 o = getDecodedObject(o);
11110 mixDigest(digest,o->ptr,sdslen(o->ptr));
11111 decrRefCount(o);
11112 }
11113
11114 /* Compute the dataset digest. Since keys, sets elements, hashes elements
11115 * are not ordered, we use a trick: every aggregate digest is the xor
11116 * of the digests of their elements. This way the order will not change
11117 * the result. For list instead we use a feedback entering the output digest
11118 * as input in order to ensure that a different ordered list will result in
11119 * a different digest. */
11120 static void computeDatasetDigest(unsigned char *final) {
11121 unsigned char digest[20];
11122 char buf[128];
11123 dictIterator *di = NULL;
11124 dictEntry *de;
11125 int j;
11126 uint32_t aux;
11127
11128 memset(final,0,20); /* Start with a clean result */
11129
11130 for (j = 0; j < server.dbnum; j++) {
11131 redisDb *db = server.db+j;
11132
11133 if (dictSize(db->dict) == 0) continue;
11134 di = dictGetIterator(db->dict);
11135
11136 /* hash the DB id, so the same dataset moved in a different
11137 * DB will lead to a different digest */
11138 aux = htonl(j);
11139 mixDigest(final,&aux,sizeof(aux));
11140
11141 /* Iterate this DB writing every entry */
11142 while((de = dictNext(di)) != NULL) {
11143 sds key;
11144 robj *keyobj, *o;
11145 time_t expiretime;
11146
11147 memset(digest,0,20); /* This key-val digest */
11148 key = dictGetEntryKey(de);
11149 keyobj = createStringObject(key,sdslen(key));
11150
11151 mixDigest(digest,key,sdslen(key));
11152
11153 /* Make sure the key is loaded if VM is active */
11154 o = lookupKeyRead(db,keyobj);
11155
11156 aux = htonl(o->type);
11157 mixDigest(digest,&aux,sizeof(aux));
11158 expiretime = getExpire(db,keyobj);
11159
11160 /* Save the key and associated value */
11161 if (o->type == REDIS_STRING) {
11162 mixObjectDigest(digest,o);
11163 } else if (o->type == REDIS_LIST) {
11164 listTypeIterator *li = listTypeInitIterator(o,0,REDIS_TAIL);
11165 listTypeEntry entry;
11166 while(listTypeNext(li,&entry)) {
11167 robj *eleobj = listTypeGet(&entry);
11168 mixObjectDigest(digest,eleobj);
11169 decrRefCount(eleobj);
11170 }
11171 listTypeReleaseIterator(li);
11172 } else if (o->type == REDIS_SET) {
11173 dict *set = o->ptr;
11174 dictIterator *di = dictGetIterator(set);
11175 dictEntry *de;
11176
11177 while((de = dictNext(di)) != NULL) {
11178 robj *eleobj = dictGetEntryKey(de);
11179
11180 xorObjectDigest(digest,eleobj);
11181 }
11182 dictReleaseIterator(di);
11183 } else if (o->type == REDIS_ZSET) {
11184 zset *zs = o->ptr;
11185 dictIterator *di = dictGetIterator(zs->dict);
11186 dictEntry *de;
11187
11188 while((de = dictNext(di)) != NULL) {
11189 robj *eleobj = dictGetEntryKey(de);
11190 double *score = dictGetEntryVal(de);
11191 unsigned char eledigest[20];
11192
11193 snprintf(buf,sizeof(buf),"%.17g",*score);
11194 memset(eledigest,0,20);
11195 mixObjectDigest(eledigest,eleobj);
11196 mixDigest(eledigest,buf,strlen(buf));
11197 xorDigest(digest,eledigest,20);
11198 }
11199 dictReleaseIterator(di);
11200 } else if (o->type == REDIS_HASH) {
11201 hashTypeIterator *hi;
11202 robj *obj;
11203
11204 hi = hashTypeInitIterator(o);
11205 while (hashTypeNext(hi) != REDIS_ERR) {
11206 unsigned char eledigest[20];
11207
11208 memset(eledigest,0,20);
11209 obj = hashTypeCurrent(hi,REDIS_HASH_KEY);
11210 mixObjectDigest(eledigest,obj);
11211 decrRefCount(obj);
11212 obj = hashTypeCurrent(hi,REDIS_HASH_VALUE);
11213 mixObjectDigest(eledigest,obj);
11214 decrRefCount(obj);
11215 xorDigest(digest,eledigest,20);
11216 }
11217 hashTypeReleaseIterator(hi);
11218 } else {
11219 redisPanic("Unknown object type");
11220 }
11221 /* If the key has an expire, add it to the mix */
11222 if (expiretime != -1) xorDigest(digest,"!!expire!!",10);
11223 /* We can finally xor the key-val digest to the final digest */
11224 xorDigest(final,digest,20);
11225 decrRefCount(keyobj);
11226 }
11227 dictReleaseIterator(di);
11228 }
11229 }
11230
11231 static void debugCommand(redisClient *c) {
11232 if (!strcasecmp(c->argv[1]->ptr,"segfault")) {
11233 *((char*)-1) = 'x';
11234 } else if (!strcasecmp(c->argv[1]->ptr,"reload")) {
11235 if (rdbSave(server.dbfilename) != REDIS_OK) {
11236 addReply(c,shared.err);
11237 return;
11238 }
11239 emptyDb();
11240 if (rdbLoad(server.dbfilename) != REDIS_OK) {
11241 addReply(c,shared.err);
11242 return;
11243 }
11244 redisLog(REDIS_WARNING,"DB reloaded by DEBUG RELOAD");
11245 addReply(c,shared.ok);
11246 } else if (!strcasecmp(c->argv[1]->ptr,"loadaof")) {
11247 emptyDb();
11248 if (loadAppendOnlyFile(server.appendfilename) != REDIS_OK) {
11249 addReply(c,shared.err);
11250 return;
11251 }
11252 redisLog(REDIS_WARNING,"Append Only File loaded by DEBUG LOADAOF");
11253 addReply(c,shared.ok);
11254 } else if (!strcasecmp(c->argv[1]->ptr,"object") && c->argc == 3) {
11255 dictEntry *de = dictFind(c->db->dict,c->argv[2]->ptr);
11256 robj *val;
11257
11258 if (!de) {
11259 addReply(c,shared.nokeyerr);
11260 return;
11261 }
11262 val = dictGetEntryVal(de);
11263 if (!server.vm_enabled || (val->storage == REDIS_VM_MEMORY ||
11264 val->storage == REDIS_VM_SWAPPING)) {
11265 char *strenc;
11266 char buf[128];
11267
11268 if (val->encoding < (sizeof(strencoding)/sizeof(char*))) {
11269 strenc = strencoding[val->encoding];
11270 } else {
11271 snprintf(buf,64,"unknown encoding %d\n", val->encoding);
11272 strenc = buf;
11273 }
11274 addReplySds(c,sdscatprintf(sdsempty(),
11275 "+Value at:%p refcount:%d "
11276 "encoding:%s serializedlength:%lld\r\n",
11277 (void*)val, val->refcount,
11278 strenc, (long long) rdbSavedObjectLen(val,NULL)));
11279 } else {
11280 vmpointer *vp = (vmpointer*) val;
11281 addReplySds(c,sdscatprintf(sdsempty(),
11282 "+Value swapped at: page %llu "
11283 "using %llu pages\r\n",
11284 (unsigned long long) vp->page,
11285 (unsigned long long) vp->usedpages));
11286 }
11287 } else if (!strcasecmp(c->argv[1]->ptr,"swapin") && c->argc == 3) {
11288 lookupKeyRead(c->db,c->argv[2]);
11289 addReply(c,shared.ok);
11290 } else if (!strcasecmp(c->argv[1]->ptr,"swapout") && c->argc == 3) {
11291 dictEntry *de = dictFind(c->db->dict,c->argv[2]->ptr);
11292 robj *val;
11293 vmpointer *vp;
11294
11295 if (!server.vm_enabled) {
11296 addReplySds(c,sdsnew("-ERR Virtual Memory is disabled\r\n"));
11297 return;
11298 }
11299 if (!de) {
11300 addReply(c,shared.nokeyerr);
11301 return;
11302 }
11303 val = dictGetEntryVal(de);
11304 /* Swap it */
11305 if (val->storage != REDIS_VM_MEMORY) {
11306 addReplySds(c,sdsnew("-ERR This key is not in memory\r\n"));
11307 } else if (val->refcount != 1) {
11308 addReplySds(c,sdsnew("-ERR Object is shared\r\n"));
11309 } else if ((vp = vmSwapObjectBlocking(val)) != NULL) {
11310 dictGetEntryVal(de) = vp;
11311 addReply(c,shared.ok);
11312 } else {
11313 addReply(c,shared.err);
11314 }
11315 } else if (!strcasecmp(c->argv[1]->ptr,"populate") && c->argc == 3) {
11316 long keys, j;
11317 robj *key, *val;
11318 char buf[128];
11319
11320 if (getLongFromObjectOrReply(c, c->argv[2], &keys, NULL) != REDIS_OK)
11321 return;
11322 for (j = 0; j < keys; j++) {
11323 snprintf(buf,sizeof(buf),"key:%lu",j);
11324 key = createStringObject(buf,strlen(buf));
11325 if (lookupKeyRead(c->db,key) != NULL) {
11326 decrRefCount(key);
11327 continue;
11328 }
11329 snprintf(buf,sizeof(buf),"value:%lu",j);
11330 val = createStringObject(buf,strlen(buf));
11331 dbAdd(c->db,key,val);
11332 decrRefCount(key);
11333 }
11334 addReply(c,shared.ok);
11335 } else if (!strcasecmp(c->argv[1]->ptr,"digest") && c->argc == 2) {
11336 unsigned char digest[20];
11337 sds d = sdsnew("+");
11338 int j;
11339
11340 computeDatasetDigest(digest);
11341 for (j = 0; j < 20; j++)
11342 d = sdscatprintf(d, "%02x",digest[j]);
11343
11344 d = sdscatlen(d,"\r\n",2);
11345 addReplySds(c,d);
11346 } else {
11347 addReplySds(c,sdsnew(
11348 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPIN <key>|SWAPOUT <key>|RELOAD]\r\n"));
11349 }
11350 }
11351
11352 static void _redisAssert(char *estr, char *file, int line) {
11353 redisLog(REDIS_WARNING,"=== ASSERTION FAILED ===");
11354 redisLog(REDIS_WARNING,"==> %s:%d '%s' is not true",file,line,estr);
11355 #ifdef HAVE_BACKTRACE
11356 redisLog(REDIS_WARNING,"(forcing SIGSEGV in order to print the stack trace)");
11357 *((char*)-1) = 'x';
11358 #endif
11359 }
11360
11361 static void _redisPanic(char *msg, char *file, int line) {
11362 redisLog(REDIS_WARNING,"!!! Software Failure. Press left mouse button to continue");
11363 redisLog(REDIS_WARNING,"Guru Meditation: %s #%s:%d",msg,file,line);
11364 #ifdef HAVE_BACKTRACE
11365 redisLog(REDIS_WARNING,"(forcing SIGSEGV in order to print the stack trace)");
11366 *((char*)-1) = 'x';
11367 #endif
11368 }
11369
11370 /* =================================== Main! ================================ */
11371
11372 #ifdef __linux__
11373 int linuxOvercommitMemoryValue(void) {
11374 FILE *fp = fopen("/proc/sys/vm/overcommit_memory","r");
11375 char buf[64];
11376
11377 if (!fp) return -1;
11378 if (fgets(buf,64,fp) == NULL) {
11379 fclose(fp);
11380 return -1;
11381 }
11382 fclose(fp);
11383
11384 return atoi(buf);
11385 }
11386
11387 void linuxOvercommitMemoryWarning(void) {
11388 if (linuxOvercommitMemoryValue() == 0) {
11389 redisLog(REDIS_WARNING,"WARNING overcommit_memory is set to 0! Background save may fail under low memory condition. 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.");
11390 }
11391 }
11392 #endif /* __linux__ */
11393
11394 static void daemonize(void) {
11395 int fd;
11396 FILE *fp;
11397
11398 if (fork() != 0) exit(0); /* parent exits */
11399 setsid(); /* create a new session */
11400
11401 /* Every output goes to /dev/null. If Redis is daemonized but
11402 * the 'logfile' is set to 'stdout' in the configuration file
11403 * it will not log at all. */
11404 if ((fd = open("/dev/null", O_RDWR, 0)) != -1) {
11405 dup2(fd, STDIN_FILENO);
11406 dup2(fd, STDOUT_FILENO);
11407 dup2(fd, STDERR_FILENO);
11408 if (fd > STDERR_FILENO) close(fd);
11409 }
11410 /* Try to write the pid file */
11411 fp = fopen(server.pidfile,"w");
11412 if (fp) {
11413 fprintf(fp,"%d\n",getpid());
11414 fclose(fp);
11415 }
11416 }
11417
11418 static void version() {
11419 printf("Redis server version %s (%s:%d)\n", REDIS_VERSION,
11420 REDIS_GIT_SHA1, atoi(REDIS_GIT_DIRTY) > 0);
11421 exit(0);
11422 }
11423
11424 static void usage() {
11425 fprintf(stderr,"Usage: ./redis-server [/path/to/redis.conf]\n");
11426 fprintf(stderr," ./redis-server - (read config from stdin)\n");
11427 exit(1);
11428 }
11429
11430 int main(int argc, char **argv) {
11431 time_t start;
11432
11433 initServerConfig();
11434 sortCommandTable();
11435 if (argc == 2) {
11436 if (strcmp(argv[1], "-v") == 0 ||
11437 strcmp(argv[1], "--version") == 0) version();
11438 if (strcmp(argv[1], "--help") == 0) usage();
11439 resetServerSaveParams();
11440 loadServerConfig(argv[1]);
11441 } else if ((argc > 2)) {
11442 usage();
11443 } else {
11444 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'");
11445 }
11446 if (server.daemonize) daemonize();
11447 initServer();
11448 redisLog(REDIS_NOTICE,"Server started, Redis version " REDIS_VERSION);
11449 #ifdef __linux__
11450 linuxOvercommitMemoryWarning();
11451 #endif
11452 start = time(NULL);
11453 if (server.appendonly) {
11454 if (loadAppendOnlyFile(server.appendfilename) == REDIS_OK)
11455 redisLog(REDIS_NOTICE,"DB loaded from append only file: %ld seconds",time(NULL)-start);
11456 } else {
11457 if (rdbLoad(server.dbfilename) == REDIS_OK)
11458 redisLog(REDIS_NOTICE,"DB loaded from disk: %ld seconds",time(NULL)-start);
11459 }
11460 redisLog(REDIS_NOTICE,"The server is now ready to accept connections on port %d", server.port);
11461 aeSetBeforeSleepProc(server.el,beforeSleep);
11462 aeMain(server.el);
11463 aeDeleteEventLoop(server.el);
11464 return 0;
11465 }
11466
11467 /* ============================= Backtrace support ========================= */
11468
11469 #ifdef HAVE_BACKTRACE
11470 static char *findFuncName(void *pointer, unsigned long *offset);
11471
11472 static void *getMcontextEip(ucontext_t *uc) {
11473 #if defined(__FreeBSD__)
11474 return (void*) uc->uc_mcontext.mc_eip;
11475 #elif defined(__dietlibc__)
11476 return (void*) uc->uc_mcontext.eip;
11477 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
11478 #if __x86_64__
11479 return (void*) uc->uc_mcontext->__ss.__rip;
11480 #else
11481 return (void*) uc->uc_mcontext->__ss.__eip;
11482 #endif
11483 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
11484 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
11485 return (void*) uc->uc_mcontext->__ss.__rip;
11486 #else
11487 return (void*) uc->uc_mcontext->__ss.__eip;
11488 #endif
11489 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
11490 return (void*) uc->uc_mcontext.gregs[REG_EIP]; /* Linux 32/64 bit */
11491 #elif defined(__ia64__) /* Linux IA64 */
11492 return (void*) uc->uc_mcontext.sc_ip;
11493 #else
11494 return NULL;
11495 #endif
11496 }
11497
11498 static void segvHandler(int sig, siginfo_t *info, void *secret) {
11499 void *trace[100];
11500 char **messages = NULL;
11501 int i, trace_size = 0;
11502 unsigned long offset=0;
11503 ucontext_t *uc = (ucontext_t*) secret;
11504 sds infostring;
11505 REDIS_NOTUSED(info);
11506
11507 redisLog(REDIS_WARNING,
11508 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION, sig);
11509 infostring = genRedisInfoString();
11510 redisLog(REDIS_WARNING, "%s",infostring);
11511 /* It's not safe to sdsfree() the returned string under memory
11512 * corruption conditions. Let it leak as we are going to abort */
11513
11514 trace_size = backtrace(trace, 100);
11515 /* overwrite sigaction with caller's address */
11516 if (getMcontextEip(uc) != NULL) {
11517 trace[1] = getMcontextEip(uc);
11518 }
11519 messages = backtrace_symbols(trace, trace_size);
11520
11521 for (i=1; i<trace_size; ++i) {
11522 char *fn = findFuncName(trace[i], &offset), *p;
11523
11524 p = strchr(messages[i],'+');
11525 if (!fn || (p && ((unsigned long)strtol(p+1,NULL,10)) < offset)) {
11526 redisLog(REDIS_WARNING,"%s", messages[i]);
11527 } else {
11528 redisLog(REDIS_WARNING,"%d redis-server %p %s + %d", i, trace[i], fn, (unsigned int)offset);
11529 }
11530 }
11531 /* free(messages); Don't call free() with possibly corrupted memory. */
11532 _exit(0);
11533 }
11534
11535 static void sigtermHandler(int sig) {
11536 REDIS_NOTUSED(sig);
11537
11538 redisLog(REDIS_WARNING,"SIGTERM received, scheduling shutting down...");
11539 server.shutdown_asap = 1;
11540 }
11541
11542 static void setupSigSegvAction(void) {
11543 struct sigaction act;
11544
11545 sigemptyset (&act.sa_mask);
11546 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
11547 * is used. Otherwise, sa_handler is used */
11548 act.sa_flags = SA_NODEFER | SA_ONSTACK | SA_RESETHAND | SA_SIGINFO;
11549 act.sa_sigaction = segvHandler;
11550 sigaction (SIGSEGV, &act, NULL);
11551 sigaction (SIGBUS, &act, NULL);
11552 sigaction (SIGFPE, &act, NULL);
11553 sigaction (SIGILL, &act, NULL);
11554 sigaction (SIGBUS, &act, NULL);
11555
11556 act.sa_flags = SA_NODEFER | SA_ONSTACK | SA_RESETHAND;
11557 act.sa_handler = sigtermHandler;
11558 sigaction (SIGTERM, &act, NULL);
11559 return;
11560 }
11561
11562 #include "staticsymbols.h"
11563 /* This function try to convert a pointer into a function name. It's used in
11564 * oreder to provide a backtrace under segmentation fault that's able to
11565 * display functions declared as static (otherwise the backtrace is useless). */
11566 static char *findFuncName(void *pointer, unsigned long *offset){
11567 int i, ret = -1;
11568 unsigned long off, minoff = 0;
11569
11570 /* Try to match against the Symbol with the smallest offset */
11571 for (i=0; symsTable[i].pointer; i++) {
11572 unsigned long lp = (unsigned long) pointer;
11573
11574 if (lp != (unsigned long)-1 && lp >= symsTable[i].pointer) {
11575 off=lp-symsTable[i].pointer;
11576 if (ret < 0 || off < minoff) {
11577 minoff=off;
11578 ret=i;
11579 }
11580 }
11581 }
11582 if (ret == -1) return NULL;
11583 *offset = minoff;
11584 return symsTable[ret].name;
11585 }
11586 #else /* HAVE_BACKTRACE */
11587 static void setupSigSegvAction(void) {
11588 }
11589 #endif /* HAVE_BACKTRACE */
11590
11591
11592
11593 /* The End */
11594
11595
11596