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