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