]> git.saurik.com Git - redis.git/blame - redis.c
Bug #169 fixed (BLOP/BRPOP interrupted connections are not cleared from the queue)
[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 }
5921aa36 2337 if (!(c->flags & REDIS_BLOCKED))
2338 processInputBuffer(c);
638e42ac 2339}
2340
ed9b544e 2341static int selectDb(redisClient *c, int id) {
2342 if (id < 0 || id >= server.dbnum)
2343 return REDIS_ERR;
3305306f 2344 c->db = &server.db[id];
ed9b544e 2345 return REDIS_OK;
2346}
2347
40d224a9 2348static void *dupClientReplyValue(void *o) {
2349 incrRefCount((robj*)o);
12d090d2 2350 return o;
40d224a9 2351}
2352
ed9b544e 2353static redisClient *createClient(int fd) {
2354 redisClient *c = zmalloc(sizeof(*c));
2355
2356 anetNonBlock(NULL,fd);
2357 anetTcpNoDelay(NULL,fd);
2358 if (!c) return NULL;
2359 selectDb(c,0);
2360 c->fd = fd;
2361 c->querybuf = sdsempty();
2362 c->argc = 0;
93ea3759 2363 c->argv = NULL;
ed9b544e 2364 c->bulklen = -1;
e8a74421 2365 c->multibulk = 0;
2366 c->mbargc = 0;
2367 c->mbargv = NULL;
ed9b544e 2368 c->sentlen = 0;
2369 c->flags = 0;
2370 c->lastinteraction = time(NULL);
abcb223e 2371 c->authenticated = 0;
40d224a9 2372 c->replstate = REDIS_REPL_NONE;
6b47e12e 2373 c->reply = listCreate();
ed9b544e 2374 listSetFreeMethod(c->reply,decrRefCount);
40d224a9 2375 listSetDupMethod(c->reply,dupClientReplyValue);
92f8e882 2376 c->blockingkeys = NULL;
2377 c->blockingkeysnum = 0;
2378 c->io_keys = listCreate();
2379 listSetFreeMethod(c->io_keys,decrRefCount);
ed9b544e 2380 if (aeCreateFileEvent(server.el, c->fd, AE_READABLE,
266373b2 2381 readQueryFromClient, c) == AE_ERR) {
ed9b544e 2382 freeClient(c);
2383 return NULL;
2384 }
6b47e12e 2385 listAddNodeTail(server.clients,c);
6e469882 2386 initClientMultiState(c);
ed9b544e 2387 return c;
2388}
2389
2390static void addReply(redisClient *c, robj *obj) {
2391 if (listLength(c->reply) == 0 &&
6208b3a7 2392 (c->replstate == REDIS_REPL_NONE ||
2393 c->replstate == REDIS_REPL_ONLINE) &&
ed9b544e 2394 aeCreateFileEvent(server.el, c->fd, AE_WRITABLE,
266373b2 2395 sendReplyToClient, c) == AE_ERR) return;
e3cadb8a 2396
2397 if (server.vm_enabled && obj->storage != REDIS_VM_MEMORY) {
2398 obj = dupStringObject(obj);
2399 obj->refcount = 0; /* getDecodedObject() will increment the refcount */
2400 }
9d65a1bb 2401 listAddNodeTail(c->reply,getDecodedObject(obj));
ed9b544e 2402}
2403
2404static void addReplySds(redisClient *c, sds s) {
2405 robj *o = createObject(REDIS_STRING,s);
2406 addReply(c,o);
2407 decrRefCount(o);
2408}
2409
e2665397 2410static void addReplyDouble(redisClient *c, double d) {
2411 char buf[128];
2412
2413 snprintf(buf,sizeof(buf),"%.17g",d);
682ac724 2414 addReplySds(c,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
83c6a618 2415 (unsigned long) strlen(buf),buf));
e2665397 2416}
2417
f44dd428 2418static void addReplyLong(redisClient *c, long l) {
2419 char buf[128];
2420 size_t len;
2421
2422 len = snprintf(buf,sizeof(buf),":%ld\r\n",l);
2423 addReplySds(c,sdsnewlen(buf,len));
2424}
2425
942a3961 2426static void addReplyBulkLen(redisClient *c, robj *obj) {
2427 size_t len;
2428
2429 if (obj->encoding == REDIS_ENCODING_RAW) {
2430 len = sdslen(obj->ptr);
2431 } else {
2432 long n = (long)obj->ptr;
2433
e054afda 2434 /* Compute how many bytes will take this integer as a radix 10 string */
942a3961 2435 len = 1;
2436 if (n < 0) {
2437 len++;
2438 n = -n;
2439 }
2440 while((n = n/10) != 0) {
2441 len++;
2442 }
2443 }
83c6a618 2444 addReplySds(c,sdscatprintf(sdsempty(),"$%lu\r\n",(unsigned long)len));
942a3961 2445}
2446
ed9b544e 2447static void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask) {
2448 int cport, cfd;
2449 char cip[128];
285add55 2450 redisClient *c;
ed9b544e 2451 REDIS_NOTUSED(el);
2452 REDIS_NOTUSED(mask);
2453 REDIS_NOTUSED(privdata);
2454
2455 cfd = anetAccept(server.neterr, fd, cip, &cport);
2456 if (cfd == AE_ERR) {
f870935d 2457 redisLog(REDIS_VERBOSE,"Accepting client connection: %s", server.neterr);
ed9b544e 2458 return;
2459 }
f870935d 2460 redisLog(REDIS_VERBOSE,"Accepted %s:%d", cip, cport);
285add55 2461 if ((c = createClient(cfd)) == NULL) {
ed9b544e 2462 redisLog(REDIS_WARNING,"Error allocating resoures for the client");
2463 close(cfd); /* May be already closed, just ingore errors */
2464 return;
2465 }
285add55 2466 /* If maxclient directive is set and this is one client more... close the
2467 * connection. Note that we create the client instead to check before
2468 * for this condition, since now the socket is already set in nonblocking
2469 * mode and we can send an error for free using the Kernel I/O */
2470 if (server.maxclients && listLength(server.clients) > server.maxclients) {
2471 char *err = "-ERR max number of clients reached\r\n";
2472
2473 /* That's a best effort error message, don't check write errors */
fee803ba 2474 if (write(c->fd,err,strlen(err)) == -1) {
2475 /* Nothing to do, Just to avoid the warning... */
2476 }
285add55 2477 freeClient(c);
2478 return;
2479 }
ed9b544e 2480 server.stat_numconnections++;
2481}
2482
2483/* ======================= Redis objects implementation ===================== */
2484
2485static robj *createObject(int type, void *ptr) {
2486 robj *o;
2487
a5819310 2488 if (server.vm_enabled) pthread_mutex_lock(&server.obj_freelist_mutex);
ed9b544e 2489 if (listLength(server.objfreelist)) {
2490 listNode *head = listFirst(server.objfreelist);
2491 o = listNodeValue(head);
2492 listDelNode(server.objfreelist,head);
a5819310 2493 if (server.vm_enabled) pthread_mutex_unlock(&server.obj_freelist_mutex);
ed9b544e 2494 } else {
75680a3c 2495 if (server.vm_enabled) {
a5819310 2496 pthread_mutex_unlock(&server.obj_freelist_mutex);
75680a3c 2497 o = zmalloc(sizeof(*o));
2498 } else {
2499 o = zmalloc(sizeof(*o)-sizeof(struct redisObjectVM));
2500 }
ed9b544e 2501 }
ed9b544e 2502 o->type = type;
942a3961 2503 o->encoding = REDIS_ENCODING_RAW;
ed9b544e 2504 o->ptr = ptr;
2505 o->refcount = 1;
3a66edc7 2506 if (server.vm_enabled) {
1064ef87 2507 /* Note that this code may run in the context of an I/O thread
2508 * and accessing to server.unixtime in theory is an error
2509 * (no locks). But in practice this is safe, and even if we read
2510 * garbage Redis will not fail, as it's just a statistical info */
3a66edc7 2511 o->vm.atime = server.unixtime;
2512 o->storage = REDIS_VM_MEMORY;
2513 }
ed9b544e 2514 return o;
2515}
2516
2517static robj *createStringObject(char *ptr, size_t len) {
2518 return createObject(REDIS_STRING,sdsnewlen(ptr,len));
2519}
2520
4ef8de8a 2521static robj *dupStringObject(robj *o) {
b9bc0eef 2522 assert(o->encoding == REDIS_ENCODING_RAW);
4ef8de8a 2523 return createStringObject(o->ptr,sdslen(o->ptr));
2524}
2525
ed9b544e 2526static robj *createListObject(void) {
2527 list *l = listCreate();
2528
ed9b544e 2529 listSetFreeMethod(l,decrRefCount);
2530 return createObject(REDIS_LIST,l);
2531}
2532
2533static robj *createSetObject(void) {
2534 dict *d = dictCreate(&setDictType,NULL);
ed9b544e 2535 return createObject(REDIS_SET,d);
2536}
2537
1812e024 2538static robj *createZsetObject(void) {
6b47e12e 2539 zset *zs = zmalloc(sizeof(*zs));
2540
2541 zs->dict = dictCreate(&zsetDictType,NULL);
2542 zs->zsl = zslCreate();
2543 return createObject(REDIS_ZSET,zs);
1812e024 2544}
2545
ed9b544e 2546static void freeStringObject(robj *o) {
942a3961 2547 if (o->encoding == REDIS_ENCODING_RAW) {
2548 sdsfree(o->ptr);
2549 }
ed9b544e 2550}
2551
2552static void freeListObject(robj *o) {
2553 listRelease((list*) o->ptr);
2554}
2555
2556static void freeSetObject(robj *o) {
2557 dictRelease((dict*) o->ptr);
2558}
2559
fd8ccf44 2560static void freeZsetObject(robj *o) {
2561 zset *zs = o->ptr;
2562
2563 dictRelease(zs->dict);
2564 zslFree(zs->zsl);
2565 zfree(zs);
2566}
2567
ed9b544e 2568static void freeHashObject(robj *o) {
2569 dictRelease((dict*) o->ptr);
2570}
2571
2572static void incrRefCount(robj *o) {
f2b8ab34 2573 redisAssert(!server.vm_enabled || o->storage == REDIS_VM_MEMORY);
ed9b544e 2574 o->refcount++;
2575}
2576
2577static void decrRefCount(void *obj) {
2578 robj *o = obj;
94754ccc 2579
970e10bb 2580 /* Object is a key of a swapped out value, or in the process of being
2581 * loaded. */
996cb5f7 2582 if (server.vm_enabled &&
2583 (o->storage == REDIS_VM_SWAPPED || o->storage == REDIS_VM_LOADING))
2584 {
2585 if (o->storage == REDIS_VM_SWAPPED || o->storage == REDIS_VM_LOADING) {
2586 redisAssert(o->refcount == 1);
2587 }
2588 if (o->storage == REDIS_VM_LOADING) vmCancelThreadedIOJob(obj);
f2b8ab34 2589 redisAssert(o->type == REDIS_STRING);
a35ddf12 2590 freeStringObject(o);
2591 vmMarkPagesFree(o->vm.page,o->vm.usedpages);
a5819310 2592 pthread_mutex_lock(&server.obj_freelist_mutex);
a35ddf12 2593 if (listLength(server.objfreelist) > REDIS_OBJFREELIST_MAX ||
2594 !listAddNodeHead(server.objfreelist,o))
2595 zfree(o);
a5819310 2596 pthread_mutex_unlock(&server.obj_freelist_mutex);
7d98e08c 2597 server.vm_stats_swapped_objects--;
a35ddf12 2598 return;
2599 }
996cb5f7 2600 /* Object is in memory, or in the process of being swapped out. */
ed9b544e 2601 if (--(o->refcount) == 0) {
996cb5f7 2602 if (server.vm_enabled && o->storage == REDIS_VM_SWAPPING)
2603 vmCancelThreadedIOJob(obj);
ed9b544e 2604 switch(o->type) {
2605 case REDIS_STRING: freeStringObject(o); break;
2606 case REDIS_LIST: freeListObject(o); break;
2607 case REDIS_SET: freeSetObject(o); break;
fd8ccf44 2608 case REDIS_ZSET: freeZsetObject(o); break;
ed9b544e 2609 case REDIS_HASH: freeHashObject(o); break;
dfc5e96c 2610 default: redisAssert(0 != 0); break;
ed9b544e 2611 }
a5819310 2612 if (server.vm_enabled) pthread_mutex_lock(&server.obj_freelist_mutex);
ed9b544e 2613 if (listLength(server.objfreelist) > REDIS_OBJFREELIST_MAX ||
2614 !listAddNodeHead(server.objfreelist,o))
2615 zfree(o);
a5819310 2616 if (server.vm_enabled) pthread_mutex_unlock(&server.obj_freelist_mutex);
ed9b544e 2617 }
2618}
2619
942a3961 2620static robj *lookupKey(redisDb *db, robj *key) {
2621 dictEntry *de = dictFind(db->dict,key);
3a66edc7 2622 if (de) {
55cf8433 2623 robj *key = dictGetEntryKey(de);
2624 robj *val = dictGetEntryVal(de);
3a66edc7 2625
55cf8433 2626 if (server.vm_enabled) {
996cb5f7 2627 if (key->storage == REDIS_VM_MEMORY ||
2628 key->storage == REDIS_VM_SWAPPING)
2629 {
2630 /* If we were swapping the object out, stop it, this key
2631 * was requested. */
2632 if (key->storage == REDIS_VM_SWAPPING)
2633 vmCancelThreadedIOJob(key);
55cf8433 2634 /* Update the access time of the key for the aging algorithm. */
2635 key->vm.atime = server.unixtime;
2636 } else {
d5d55fc3 2637 int notify = (key->storage == REDIS_VM_LOADING);
2638
55cf8433 2639 /* Our value was swapped on disk. Bring it at home. */
f2b8ab34 2640 redisAssert(val == NULL);
55cf8433 2641 val = vmLoadObject(key);
2642 dictGetEntryVal(de) = val;
d5d55fc3 2643
2644 /* Clients blocked by the VM subsystem may be waiting for
2645 * this key... */
2646 if (notify) handleClientsBlockedOnSwappedKey(db,key);
55cf8433 2647 }
2648 }
2649 return val;
3a66edc7 2650 } else {
2651 return NULL;
2652 }
942a3961 2653}
2654
2655static robj *lookupKeyRead(redisDb *db, robj *key) {
2656 expireIfNeeded(db,key);
2657 return lookupKey(db,key);
2658}
2659
2660static robj *lookupKeyWrite(redisDb *db, robj *key) {
2661 deleteIfVolatile(db,key);
2662 return lookupKey(db,key);
2663}
2664
2665static int deleteKey(redisDb *db, robj *key) {
2666 int retval;
2667
2668 /* We need to protect key from destruction: after the first dictDelete()
2669 * it may happen that 'key' is no longer valid if we don't increment
2670 * it's count. This may happen when we get the object reference directly
2671 * from the hash table with dictRandomKey() or dict iterators */
2672 incrRefCount(key);
2673 if (dictSize(db->expires)) dictDelete(db->expires,key);
2674 retval = dictDelete(db->dict,key);
2675 decrRefCount(key);
2676
2677 return retval == DICT_OK;
2678}
2679
10c43610 2680/* Try to share an object against the shared objects pool */
2681static robj *tryObjectSharing(robj *o) {
2682 struct dictEntry *de;
2683 unsigned long c;
2684
3305306f 2685 if (o == NULL || server.shareobjects == 0) return o;
10c43610 2686
dfc5e96c 2687 redisAssert(o->type == REDIS_STRING);
10c43610 2688 de = dictFind(server.sharingpool,o);
2689 if (de) {
2690 robj *shared = dictGetEntryKey(de);
2691
2692 c = ((unsigned long) dictGetEntryVal(de))+1;
2693 dictGetEntryVal(de) = (void*) c;
2694 incrRefCount(shared);
2695 decrRefCount(o);
2696 return shared;
2697 } else {
2698 /* Here we are using a stream algorihtm: Every time an object is
2699 * shared we increment its count, everytime there is a miss we
2700 * recrement the counter of a random object. If this object reaches
2701 * zero we remove the object and put the current object instead. */
3305306f 2702 if (dictSize(server.sharingpool) >=
10c43610 2703 server.sharingpoolsize) {
2704 de = dictGetRandomKey(server.sharingpool);
dfc5e96c 2705 redisAssert(de != NULL);
10c43610 2706 c = ((unsigned long) dictGetEntryVal(de))-1;
2707 dictGetEntryVal(de) = (void*) c;
2708 if (c == 0) {
2709 dictDelete(server.sharingpool,de->key);
2710 }
2711 } else {
2712 c = 0; /* If the pool is empty we want to add this object */
2713 }
2714 if (c == 0) {
2715 int retval;
2716
2717 retval = dictAdd(server.sharingpool,o,(void*)1);
dfc5e96c 2718 redisAssert(retval == DICT_OK);
10c43610 2719 incrRefCount(o);
2720 }
2721 return o;
2722 }
2723}
2724
724a51b1 2725/* Check if the nul-terminated string 's' can be represented by a long
2726 * (that is, is a number that fits into long without any other space or
2727 * character before or after the digits).
2728 *
2729 * If so, the function returns REDIS_OK and *longval is set to the value
2730 * of the number. Otherwise REDIS_ERR is returned */
f69f2cba 2731static int isStringRepresentableAsLong(sds s, long *longval) {
724a51b1 2732 char buf[32], *endptr;
2733 long value;
2734 int slen;
2735
2736 value = strtol(s, &endptr, 10);
2737 if (endptr[0] != '\0') return REDIS_ERR;
2738 slen = snprintf(buf,32,"%ld",value);
2739
2740 /* If the number converted back into a string is not identical
2741 * then it's not possible to encode the string as integer */
f69f2cba 2742 if (sdslen(s) != (unsigned)slen || memcmp(buf,s,slen)) return REDIS_ERR;
724a51b1 2743 if (longval) *longval = value;
2744 return REDIS_OK;
2745}
2746
942a3961 2747/* Try to encode a string object in order to save space */
2748static int tryObjectEncoding(robj *o) {
2749 long value;
942a3961 2750 sds s = o->ptr;
3305306f 2751
942a3961 2752 if (o->encoding != REDIS_ENCODING_RAW)
2753 return REDIS_ERR; /* Already encoded */
3305306f 2754
942a3961 2755 /* It's not save to encode shared objects: shared objects can be shared
2756 * everywhere in the "object space" of Redis. Encoded objects can only
2757 * appear as "values" (and not, for instance, as keys) */
2758 if (o->refcount > 1) return REDIS_ERR;
3305306f 2759
942a3961 2760 /* Currently we try to encode only strings */
dfc5e96c 2761 redisAssert(o->type == REDIS_STRING);
94754ccc 2762
724a51b1 2763 /* Check if we can represent this string as a long integer */
2764 if (isStringRepresentableAsLong(s,&value) == REDIS_ERR) return REDIS_ERR;
942a3961 2765
2766 /* Ok, this object can be encoded */
2767 o->encoding = REDIS_ENCODING_INT;
2768 sdsfree(o->ptr);
2769 o->ptr = (void*) value;
2770 return REDIS_OK;
2771}
2772
9d65a1bb 2773/* Get a decoded version of an encoded object (returned as a new object).
2774 * If the object is already raw-encoded just increment the ref count. */
2775static robj *getDecodedObject(robj *o) {
942a3961 2776 robj *dec;
2777
9d65a1bb 2778 if (o->encoding == REDIS_ENCODING_RAW) {
2779 incrRefCount(o);
2780 return o;
2781 }
942a3961 2782 if (o->type == REDIS_STRING && o->encoding == REDIS_ENCODING_INT) {
2783 char buf[32];
2784
2785 snprintf(buf,32,"%ld",(long)o->ptr);
2786 dec = createStringObject(buf,strlen(buf));
2787 return dec;
2788 } else {
dfc5e96c 2789 redisAssert(1 != 1);
942a3961 2790 }
3305306f 2791}
2792
d7f43c08 2793/* Compare two string objects via strcmp() or alike.
2794 * Note that the objects may be integer-encoded. In such a case we
2795 * use snprintf() to get a string representation of the numbers on the stack
1fd9bc8a 2796 * and compare the strings, it's much faster than calling getDecodedObject().
2797 *
2798 * Important note: if objects are not integer encoded, but binary-safe strings,
2799 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
2800 * binary safe. */
724a51b1 2801static int compareStringObjects(robj *a, robj *b) {
dfc5e96c 2802 redisAssert(a->type == REDIS_STRING && b->type == REDIS_STRING);
d7f43c08 2803 char bufa[128], bufb[128], *astr, *bstr;
2804 int bothsds = 1;
724a51b1 2805
e197b441 2806 if (a == b) return 0;
d7f43c08 2807 if (a->encoding != REDIS_ENCODING_RAW) {
2808 snprintf(bufa,sizeof(bufa),"%ld",(long) a->ptr);
2809 astr = bufa;
2810 bothsds = 0;
724a51b1 2811 } else {
d7f43c08 2812 astr = a->ptr;
724a51b1 2813 }
d7f43c08 2814 if (b->encoding != REDIS_ENCODING_RAW) {
2815 snprintf(bufb,sizeof(bufb),"%ld",(long) b->ptr);
2816 bstr = bufb;
2817 bothsds = 0;
2818 } else {
2819 bstr = b->ptr;
2820 }
2821 return bothsds ? sdscmp(astr,bstr) : strcmp(astr,bstr);
724a51b1 2822}
2823
0ea663ea 2824static size_t stringObjectLen(robj *o) {
dfc5e96c 2825 redisAssert(o->type == REDIS_STRING);
0ea663ea 2826 if (o->encoding == REDIS_ENCODING_RAW) {
2827 return sdslen(o->ptr);
2828 } else {
2829 char buf[32];
2830
2831 return snprintf(buf,32,"%ld",(long)o->ptr);
2832 }
2833}
2834
06233c45 2835/*============================ RDB saving/loading =========================== */
ed9b544e 2836
f78fd11b 2837static int rdbSaveType(FILE *fp, unsigned char type) {
2838 if (fwrite(&type,1,1,fp) == 0) return -1;
2839 return 0;
2840}
2841
bb32ede5 2842static int rdbSaveTime(FILE *fp, time_t t) {
2843 int32_t t32 = (int32_t) t;
2844 if (fwrite(&t32,4,1,fp) == 0) return -1;
2845 return 0;
2846}
2847
e3566d4b 2848/* check rdbLoadLen() comments for more info */
f78fd11b 2849static int rdbSaveLen(FILE *fp, uint32_t len) {
2850 unsigned char buf[2];
2851
2852 if (len < (1<<6)) {
2853 /* Save a 6 bit len */
10c43610 2854 buf[0] = (len&0xFF)|(REDIS_RDB_6BITLEN<<6);
f78fd11b 2855 if (fwrite(buf,1,1,fp) == 0) return -1;
2856 } else if (len < (1<<14)) {
2857 /* Save a 14 bit len */
10c43610 2858 buf[0] = ((len>>8)&0xFF)|(REDIS_RDB_14BITLEN<<6);
f78fd11b 2859 buf[1] = len&0xFF;
17be1a4a 2860 if (fwrite(buf,2,1,fp) == 0) return -1;
f78fd11b 2861 } else {
2862 /* Save a 32 bit len */
10c43610 2863 buf[0] = (REDIS_RDB_32BITLEN<<6);
f78fd11b 2864 if (fwrite(buf,1,1,fp) == 0) return -1;
2865 len = htonl(len);
2866 if (fwrite(&len,4,1,fp) == 0) return -1;
2867 }
2868 return 0;
2869}
2870
e3566d4b 2871/* String objects in the form "2391" "-100" without any space and with a
2872 * range of values that can fit in an 8, 16 or 32 bit signed value can be
2873 * encoded as integers to save space */
56906eef 2874static int rdbTryIntegerEncoding(sds s, unsigned char *enc) {
e3566d4b 2875 long long value;
2876 char *endptr, buf[32];
2877
2878 /* Check if it's possible to encode this value as a number */
2879 value = strtoll(s, &endptr, 10);
2880 if (endptr[0] != '\0') return 0;
2881 snprintf(buf,32,"%lld",value);
2882
2883 /* If the number converted back into a string is not identical
2884 * then it's not possible to encode the string as integer */
2885 if (strlen(buf) != sdslen(s) || memcmp(buf,s,sdslen(s))) return 0;
2886
2887 /* Finally check if it fits in our ranges */
2888 if (value >= -(1<<7) && value <= (1<<7)-1) {
2889 enc[0] = (REDIS_RDB_ENCVAL<<6)|REDIS_RDB_ENC_INT8;
2890 enc[1] = value&0xFF;
2891 return 2;
2892 } else if (value >= -(1<<15) && value <= (1<<15)-1) {
2893 enc[0] = (REDIS_RDB_ENCVAL<<6)|REDIS_RDB_ENC_INT16;
2894 enc[1] = value&0xFF;
2895 enc[2] = (value>>8)&0xFF;
2896 return 3;
2897 } else if (value >= -((long long)1<<31) && value <= ((long long)1<<31)-1) {
2898 enc[0] = (REDIS_RDB_ENCVAL<<6)|REDIS_RDB_ENC_INT32;
2899 enc[1] = value&0xFF;
2900 enc[2] = (value>>8)&0xFF;
2901 enc[3] = (value>>16)&0xFF;
2902 enc[4] = (value>>24)&0xFF;
2903 return 5;
2904 } else {
2905 return 0;
2906 }
2907}
2908
774e3047 2909static int rdbSaveLzfStringObject(FILE *fp, robj *obj) {
2910 unsigned int comprlen, outlen;
2911 unsigned char byte;
2912 void *out;
2913
2914 /* We require at least four bytes compression for this to be worth it */
2915 outlen = sdslen(obj->ptr)-4;
2916 if (outlen <= 0) return 0;
3a2694c4 2917 if ((out = zmalloc(outlen+1)) == NULL) return 0;
774e3047 2918 comprlen = lzf_compress(obj->ptr, sdslen(obj->ptr), out, outlen);
2919 if (comprlen == 0) {
88e85998 2920 zfree(out);
774e3047 2921 return 0;
2922 }
2923 /* Data compressed! Let's save it on disk */
2924 byte = (REDIS_RDB_ENCVAL<<6)|REDIS_RDB_ENC_LZF;
2925 if (fwrite(&byte,1,1,fp) == 0) goto writeerr;
2926 if (rdbSaveLen(fp,comprlen) == -1) goto writeerr;
2927 if (rdbSaveLen(fp,sdslen(obj->ptr)) == -1) goto writeerr;
2928 if (fwrite(out,comprlen,1,fp) == 0) goto writeerr;
88e85998 2929 zfree(out);
774e3047 2930 return comprlen;
2931
2932writeerr:
88e85998 2933 zfree(out);
774e3047 2934 return -1;
2935}
2936
e3566d4b 2937/* Save a string objet as [len][data] on disk. If the object is a string
2938 * representation of an integer value we try to safe it in a special form */
942a3961 2939static int rdbSaveStringObjectRaw(FILE *fp, robj *obj) {
2940 size_t len;
e3566d4b 2941 int enclen;
10c43610 2942
942a3961 2943 len = sdslen(obj->ptr);
2944
774e3047 2945 /* Try integer encoding */
e3566d4b 2946 if (len <= 11) {
2947 unsigned char buf[5];
2948 if ((enclen = rdbTryIntegerEncoding(obj->ptr,buf)) > 0) {
2949 if (fwrite(buf,enclen,1,fp) == 0) return -1;
2950 return 0;
2951 }
2952 }
774e3047 2953
2954 /* Try LZF compression - under 20 bytes it's unable to compress even
88e85998 2955 * aaaaaaaaaaaaaaaaaa so skip it */
121f70cf 2956 if (server.rdbcompression && len > 20) {
774e3047 2957 int retval;
2958
2959 retval = rdbSaveLzfStringObject(fp,obj);
2960 if (retval == -1) return -1;
2961 if (retval > 0) return 0;
2962 /* retval == 0 means data can't be compressed, save the old way */
2963 }
2964
2965 /* Store verbatim */
10c43610 2966 if (rdbSaveLen(fp,len) == -1) return -1;
2967 if (len && fwrite(obj->ptr,len,1,fp) == 0) return -1;
2968 return 0;
2969}
2970
942a3961 2971/* Like rdbSaveStringObjectRaw() but handle encoded objects */
2972static int rdbSaveStringObject(FILE *fp, robj *obj) {
2973 int retval;
942a3961 2974
f2d9f50f 2975 /* Avoid incr/decr ref count business when possible.
2976 * This plays well with copy-on-write given that we are probably
2977 * in a child process (BGSAVE). Also this makes sure key objects
2978 * of swapped objects are not incRefCount-ed (an assert does not allow
2979 * this in order to avoid bugs) */
2980 if (obj->encoding != REDIS_ENCODING_RAW) {
996cb5f7 2981 obj = getDecodedObject(obj);
2982 retval = rdbSaveStringObjectRaw(fp,obj);
2983 decrRefCount(obj);
2984 } else {
996cb5f7 2985 retval = rdbSaveStringObjectRaw(fp,obj);
2986 }
9d65a1bb 2987 return retval;
942a3961 2988}
2989
a7866db6 2990/* Save a double value. Doubles are saved as strings prefixed by an unsigned
2991 * 8 bit integer specifing the length of the representation.
2992 * This 8 bit integer has special values in order to specify the following
2993 * conditions:
2994 * 253: not a number
2995 * 254: + inf
2996 * 255: - inf
2997 */
2998static int rdbSaveDoubleValue(FILE *fp, double val) {
2999 unsigned char buf[128];
3000 int len;
3001
3002 if (isnan(val)) {
3003 buf[0] = 253;
3004 len = 1;
3005 } else if (!isfinite(val)) {
3006 len = 1;
3007 buf[0] = (val < 0) ? 255 : 254;
3008 } else {
eaa256ad 3009 snprintf((char*)buf+1,sizeof(buf)-1,"%.17g",val);
6c446631 3010 buf[0] = strlen((char*)buf+1);
a7866db6 3011 len = buf[0]+1;
3012 }
3013 if (fwrite(buf,len,1,fp) == 0) return -1;
3014 return 0;
3015}
3016
06233c45 3017/* Save a Redis object. */
3018static int rdbSaveObject(FILE *fp, robj *o) {
3019 if (o->type == REDIS_STRING) {
3020 /* Save a string value */
3021 if (rdbSaveStringObject(fp,o) == -1) return -1;
3022 } else if (o->type == REDIS_LIST) {
3023 /* Save a list value */
3024 list *list = o->ptr;
c7df85a4 3025 listIter li;
06233c45 3026 listNode *ln;
3027
06233c45 3028 if (rdbSaveLen(fp,listLength(list)) == -1) return -1;
c7df85a4 3029 listRewind(list,&li);
3030 while((ln = listNext(&li))) {
06233c45 3031 robj *eleobj = listNodeValue(ln);
3032
3033 if (rdbSaveStringObject(fp,eleobj) == -1) return -1;
3034 }
3035 } else if (o->type == REDIS_SET) {
3036 /* Save a set value */
3037 dict *set = o->ptr;
3038 dictIterator *di = dictGetIterator(set);
3039 dictEntry *de;
3040
3041 if (rdbSaveLen(fp,dictSize(set)) == -1) return -1;
3042 while((de = dictNext(di)) != NULL) {
3043 robj *eleobj = dictGetEntryKey(de);
3044
3045 if (rdbSaveStringObject(fp,eleobj) == -1) return -1;
3046 }
3047 dictReleaseIterator(di);
3048 } else if (o->type == REDIS_ZSET) {
3049 /* Save a set value */
3050 zset *zs = o->ptr;
3051 dictIterator *di = dictGetIterator(zs->dict);
3052 dictEntry *de;
3053
3054 if (rdbSaveLen(fp,dictSize(zs->dict)) == -1) return -1;
3055 while((de = dictNext(di)) != NULL) {
3056 robj *eleobj = dictGetEntryKey(de);
3057 double *score = dictGetEntryVal(de);
3058
3059 if (rdbSaveStringObject(fp,eleobj) == -1) return -1;
3060 if (rdbSaveDoubleValue(fp,*score) == -1) return -1;
3061 }
3062 dictReleaseIterator(di);
3063 } else {
3064 redisAssert(0 != 0);
3065 }
3066 return 0;
3067}
3068
3069/* Return the length the object will have on disk if saved with
3070 * the rdbSaveObject() function. Currently we use a trick to get
3071 * this length with very little changes to the code. In the future
3072 * we could switch to a faster solution. */
b9bc0eef 3073static off_t rdbSavedObjectLen(robj *o, FILE *fp) {
3074 if (fp == NULL) fp = server.devnull;
06233c45 3075 rewind(fp);
3076 assert(rdbSaveObject(fp,o) != 1);
3077 return ftello(fp);
3078}
3079
06224fec 3080/* Return the number of pages required to save this object in the swap file */
b9bc0eef 3081static off_t rdbSavedObjectPages(robj *o, FILE *fp) {
3082 off_t bytes = rdbSavedObjectLen(o,fp);
06224fec 3083
3084 return (bytes+(server.vm_page_size-1))/server.vm_page_size;
3085}
3086
ed9b544e 3087/* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
f78fd11b 3088static int rdbSave(char *filename) {
ed9b544e 3089 dictIterator *di = NULL;
3090 dictEntry *de;
ed9b544e 3091 FILE *fp;
3092 char tmpfile[256];
3093 int j;
bb32ede5 3094 time_t now = time(NULL);
ed9b544e 3095
2316bb3b 3096 /* Wait for I/O therads to terminate, just in case this is a
3097 * foreground-saving, to avoid seeking the swap file descriptor at the
3098 * same time. */
3099 if (server.vm_enabled)
3100 waitEmptyIOJobsQueue();
3101
a3b21203 3102 snprintf(tmpfile,256,"temp-%d.rdb", (int) getpid());
ed9b544e 3103 fp = fopen(tmpfile,"w");
3104 if (!fp) {
3105 redisLog(REDIS_WARNING, "Failed saving the DB: %s", strerror(errno));
3106 return REDIS_ERR;
3107 }
f78fd11b 3108 if (fwrite("REDIS0001",9,1,fp) == 0) goto werr;
ed9b544e 3109 for (j = 0; j < server.dbnum; j++) {
bb32ede5 3110 redisDb *db = server.db+j;
3111 dict *d = db->dict;
3305306f 3112 if (dictSize(d) == 0) continue;
ed9b544e 3113 di = dictGetIterator(d);
3114 if (!di) {
3115 fclose(fp);
3116 return REDIS_ERR;
3117 }
3118
3119 /* Write the SELECT DB opcode */
f78fd11b 3120 if (rdbSaveType(fp,REDIS_SELECTDB) == -1) goto werr;
3121 if (rdbSaveLen(fp,j) == -1) goto werr;
ed9b544e 3122
3123 /* Iterate this DB writing every entry */
3124 while((de = dictNext(di)) != NULL) {
3125 robj *key = dictGetEntryKey(de);
3126 robj *o = dictGetEntryVal(de);
bb32ede5 3127 time_t expiretime = getExpire(db,key);
3128
3129 /* Save the expire time */
3130 if (expiretime != -1) {
3131 /* If this key is already expired skip it */
3132 if (expiretime < now) continue;
3133 if (rdbSaveType(fp,REDIS_EXPIRETIME) == -1) goto werr;
3134 if (rdbSaveTime(fp,expiretime) == -1) goto werr;
3135 }
7e69548d 3136 /* Save the key and associated value. This requires special
3137 * handling if the value is swapped out. */
996cb5f7 3138 if (!server.vm_enabled || key->storage == REDIS_VM_MEMORY ||
3139 key->storage == REDIS_VM_SWAPPING) {
7e69548d 3140 /* Save type, key, value */
3141 if (rdbSaveType(fp,o->type) == -1) goto werr;
3142 if (rdbSaveStringObject(fp,key) == -1) goto werr;
3143 if (rdbSaveObject(fp,o) == -1) goto werr;
3144 } else {
996cb5f7 3145 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
b9bc0eef 3146 robj *po;
7e69548d 3147 /* Get a preview of the object in memory */
3148 po = vmPreviewObject(key);
7e69548d 3149 /* Save type, key, value */
3150 if (rdbSaveType(fp,key->vtype) == -1) goto werr;
b9bc0eef 3151 if (rdbSaveStringObject(fp,key) == -1) goto werr;
7e69548d 3152 if (rdbSaveObject(fp,po) == -1) goto werr;
3153 /* Remove the loaded object from memory */
3154 decrRefCount(po);
7e69548d 3155 }
ed9b544e 3156 }
3157 dictReleaseIterator(di);
3158 }
3159 /* EOF opcode */
f78fd11b 3160 if (rdbSaveType(fp,REDIS_EOF) == -1) goto werr;
3161
3162 /* Make sure data will not remain on the OS's output buffers */
ed9b544e 3163 fflush(fp);
3164 fsync(fileno(fp));
3165 fclose(fp);
3166
3167 /* Use RENAME to make sure the DB file is changed atomically only
3168 * if the generate DB file is ok. */
3169 if (rename(tmpfile,filename) == -1) {
325d1eb4 3170 redisLog(REDIS_WARNING,"Error moving temp DB file on the final destination: %s", strerror(errno));
ed9b544e 3171 unlink(tmpfile);
3172 return REDIS_ERR;
3173 }
3174 redisLog(REDIS_NOTICE,"DB saved on disk");
3175 server.dirty = 0;
3176 server.lastsave = time(NULL);
3177 return REDIS_OK;
3178
3179werr:
3180 fclose(fp);
3181 unlink(tmpfile);
3182 redisLog(REDIS_WARNING,"Write error saving DB on disk: %s", strerror(errno));
3183 if (di) dictReleaseIterator(di);
3184 return REDIS_ERR;
3185}
3186
f78fd11b 3187static int rdbSaveBackground(char *filename) {
ed9b544e 3188 pid_t childpid;
3189
9d65a1bb 3190 if (server.bgsavechildpid != -1) return REDIS_ERR;
054e426d 3191 if (server.vm_enabled) waitEmptyIOJobsQueue();
ed9b544e 3192 if ((childpid = fork()) == 0) {
3193 /* Child */
054e426d 3194 if (server.vm_enabled) vmReopenSwapFile();
ed9b544e 3195 close(server.fd);
f78fd11b 3196 if (rdbSave(filename) == REDIS_OK) {
478c2c6f 3197 _exit(0);
ed9b544e 3198 } else {
478c2c6f 3199 _exit(1);
ed9b544e 3200 }
3201 } else {
3202 /* Parent */
5a7c647e 3203 if (childpid == -1) {
3204 redisLog(REDIS_WARNING,"Can't save in background: fork: %s",
3205 strerror(errno));
3206 return REDIS_ERR;
3207 }
ed9b544e 3208 redisLog(REDIS_NOTICE,"Background saving started by pid %d",childpid);
9f3c422c 3209 server.bgsavechildpid = childpid;
ed9b544e 3210 return REDIS_OK;
3211 }
3212 return REDIS_OK; /* unreached */
3213}
3214
a3b21203 3215static void rdbRemoveTempFile(pid_t childpid) {
3216 char tmpfile[256];
3217
3218 snprintf(tmpfile,256,"temp-%d.rdb", (int) childpid);
3219 unlink(tmpfile);
3220}
3221
f78fd11b 3222static int rdbLoadType(FILE *fp) {
3223 unsigned char type;
7b45bfb2 3224 if (fread(&type,1,1,fp) == 0) return -1;
3225 return type;
3226}
3227
bb32ede5 3228static time_t rdbLoadTime(FILE *fp) {
3229 int32_t t32;
3230 if (fread(&t32,4,1,fp) == 0) return -1;
3231 return (time_t) t32;
3232}
3233
e3566d4b 3234/* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3235 * of this file for a description of how this are stored on disk.
3236 *
3237 * isencoded is set to 1 if the readed length is not actually a length but
3238 * an "encoding type", check the above comments for more info */
c78a8ccc 3239static uint32_t rdbLoadLen(FILE *fp, int *isencoded) {
f78fd11b 3240 unsigned char buf[2];
3241 uint32_t len;
c78a8ccc 3242 int type;
f78fd11b 3243
e3566d4b 3244 if (isencoded) *isencoded = 0;
c78a8ccc 3245 if (fread(buf,1,1,fp) == 0) return REDIS_RDB_LENERR;
3246 type = (buf[0]&0xC0)>>6;
3247 if (type == REDIS_RDB_6BITLEN) {
3248 /* Read a 6 bit len */
3249 return buf[0]&0x3F;
3250 } else if (type == REDIS_RDB_ENCVAL) {
3251 /* Read a 6 bit len encoding type */
3252 if (isencoded) *isencoded = 1;
3253 return buf[0]&0x3F;
3254 } else if (type == REDIS_RDB_14BITLEN) {
3255 /* Read a 14 bit len */
3256 if (fread(buf+1,1,1,fp) == 0) return REDIS_RDB_LENERR;
3257 return ((buf[0]&0x3F)<<8)|buf[1];
3258 } else {
3259 /* Read a 32 bit len */
f78fd11b 3260 if (fread(&len,4,1,fp) == 0) return REDIS_RDB_LENERR;
3261 return ntohl(len);
f78fd11b 3262 }
f78fd11b 3263}
3264
e3566d4b 3265static robj *rdbLoadIntegerObject(FILE *fp, int enctype) {
3266 unsigned char enc[4];
3267 long long val;
3268
3269 if (enctype == REDIS_RDB_ENC_INT8) {
3270 if (fread(enc,1,1,fp) == 0) return NULL;
3271 val = (signed char)enc[0];
3272 } else if (enctype == REDIS_RDB_ENC_INT16) {
3273 uint16_t v;
3274 if (fread(enc,2,1,fp) == 0) return NULL;
3275 v = enc[0]|(enc[1]<<8);
3276 val = (int16_t)v;
3277 } else if (enctype == REDIS_RDB_ENC_INT32) {
3278 uint32_t v;
3279 if (fread(enc,4,1,fp) == 0) return NULL;
3280 v = enc[0]|(enc[1]<<8)|(enc[2]<<16)|(enc[3]<<24);
3281 val = (int32_t)v;
3282 } else {
3283 val = 0; /* anti-warning */
dfc5e96c 3284 redisAssert(0!=0);
e3566d4b 3285 }
3286 return createObject(REDIS_STRING,sdscatprintf(sdsempty(),"%lld",val));
3287}
3288
c78a8ccc 3289static robj *rdbLoadLzfStringObject(FILE*fp) {
88e85998 3290 unsigned int len, clen;
3291 unsigned char *c = NULL;
3292 sds val = NULL;
3293
c78a8ccc 3294 if ((clen = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
3295 if ((len = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
88e85998 3296 if ((c = zmalloc(clen)) == NULL) goto err;
3297 if ((val = sdsnewlen(NULL,len)) == NULL) goto err;
3298 if (fread(c,clen,1,fp) == 0) goto err;
3299 if (lzf_decompress(c,clen,val,len) == 0) goto err;
5109cdff 3300 zfree(c);
88e85998 3301 return createObject(REDIS_STRING,val);
3302err:
3303 zfree(c);
3304 sdsfree(val);
3305 return NULL;
3306}
3307
c78a8ccc 3308static robj *rdbLoadStringObject(FILE*fp) {
e3566d4b 3309 int isencoded;
3310 uint32_t len;
f78fd11b 3311 sds val;
3312
c78a8ccc 3313 len = rdbLoadLen(fp,&isencoded);
e3566d4b 3314 if (isencoded) {
3315 switch(len) {
3316 case REDIS_RDB_ENC_INT8:
3317 case REDIS_RDB_ENC_INT16:
3318 case REDIS_RDB_ENC_INT32:
3305306f 3319 return tryObjectSharing(rdbLoadIntegerObject(fp,len));
88e85998 3320 case REDIS_RDB_ENC_LZF:
c78a8ccc 3321 return tryObjectSharing(rdbLoadLzfStringObject(fp));
e3566d4b 3322 default:
dfc5e96c 3323 redisAssert(0!=0);
e3566d4b 3324 }
3325 }
3326
f78fd11b 3327 if (len == REDIS_RDB_LENERR) return NULL;
3328 val = sdsnewlen(NULL,len);
3329 if (len && fread(val,len,1,fp) == 0) {
3330 sdsfree(val);
3331 return NULL;
3332 }
10c43610 3333 return tryObjectSharing(createObject(REDIS_STRING,val));
f78fd11b 3334}
3335
a7866db6 3336/* For information about double serialization check rdbSaveDoubleValue() */
3337static int rdbLoadDoubleValue(FILE *fp, double *val) {
3338 char buf[128];
3339 unsigned char len;
3340
3341 if (fread(&len,1,1,fp) == 0) return -1;
3342 switch(len) {
3343 case 255: *val = R_NegInf; return 0;
3344 case 254: *val = R_PosInf; return 0;
3345 case 253: *val = R_Nan; return 0;
3346 default:
3347 if (fread(buf,len,1,fp) == 0) return -1;
231d758e 3348 buf[len] = '\0';
a7866db6 3349 sscanf(buf, "%lg", val);
3350 return 0;
3351 }
3352}
3353
c78a8ccc 3354/* Load a Redis object of the specified type from the specified file.
3355 * On success a newly allocated object is returned, otherwise NULL. */
3356static robj *rdbLoadObject(int type, FILE *fp) {
3357 robj *o;
3358
3359 if (type == REDIS_STRING) {
3360 /* Read string value */
3361 if ((o = rdbLoadStringObject(fp)) == NULL) return NULL;
3362 tryObjectEncoding(o);
3363 } else if (type == REDIS_LIST || type == REDIS_SET) {
3364 /* Read list/set value */
3365 uint32_t listlen;
3366
3367 if ((listlen = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
3368 o = (type == REDIS_LIST) ? createListObject() : createSetObject();
3c68de9b 3369 /* It's faster to expand the dict to the right size asap in order
3370 * to avoid rehashing */
3371 if (type == REDIS_SET && listlen > DICT_HT_INITIAL_SIZE)
3372 dictExpand(o->ptr,listlen);
c78a8ccc 3373 /* Load every single element of the list/set */
3374 while(listlen--) {
3375 robj *ele;
3376
3377 if ((ele = rdbLoadStringObject(fp)) == NULL) return NULL;
3378 tryObjectEncoding(ele);
3379 if (type == REDIS_LIST) {
3380 listAddNodeTail((list*)o->ptr,ele);
3381 } else {
3382 dictAdd((dict*)o->ptr,ele,NULL);
3383 }
3384 }
3385 } else if (type == REDIS_ZSET) {
3386 /* Read list/set value */
3387 uint32_t zsetlen;
3388 zset *zs;
3389
3390 if ((zsetlen = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
3391 o = createZsetObject();
3392 zs = o->ptr;
3393 /* Load every single element of the list/set */
3394 while(zsetlen--) {
3395 robj *ele;
3396 double *score = zmalloc(sizeof(double));
3397
3398 if ((ele = rdbLoadStringObject(fp)) == NULL) return NULL;
3399 tryObjectEncoding(ele);
3400 if (rdbLoadDoubleValue(fp,score) == -1) return NULL;
3401 dictAdd(zs->dict,ele,score);
3402 zslInsert(zs->zsl,*score,ele);
3403 incrRefCount(ele); /* added to skiplist */
3404 }
3405 } else {
3406 redisAssert(0 != 0);
3407 }
3408 return o;
3409}
3410
f78fd11b 3411static int rdbLoad(char *filename) {
ed9b544e 3412 FILE *fp;
f78fd11b 3413 robj *keyobj = NULL;
3414 uint32_t dbid;
bb32ede5 3415 int type, retval, rdbver;
3305306f 3416 dict *d = server.db[0].dict;
bb32ede5 3417 redisDb *db = server.db+0;
f78fd11b 3418 char buf[1024];
bb32ede5 3419 time_t expiretime = -1, now = time(NULL);
b492cf00 3420 long long loadedkeys = 0;
bb32ede5 3421
ed9b544e 3422 fp = fopen(filename,"r");
3423 if (!fp) return REDIS_ERR;
3424 if (fread(buf,9,1,fp) == 0) goto eoferr;
f78fd11b 3425 buf[9] = '\0';
3426 if (memcmp(buf,"REDIS",5) != 0) {
ed9b544e 3427 fclose(fp);
3428 redisLog(REDIS_WARNING,"Wrong signature trying to load DB from file");
3429 return REDIS_ERR;
3430 }
f78fd11b 3431 rdbver = atoi(buf+5);
c78a8ccc 3432 if (rdbver != 1) {
f78fd11b 3433 fclose(fp);
3434 redisLog(REDIS_WARNING,"Can't handle RDB format version %d",rdbver);
3435 return REDIS_ERR;
3436 }
ed9b544e 3437 while(1) {
3438 robj *o;
3439
3440 /* Read type. */
f78fd11b 3441 if ((type = rdbLoadType(fp)) == -1) goto eoferr;
bb32ede5 3442 if (type == REDIS_EXPIRETIME) {
3443 if ((expiretime = rdbLoadTime(fp)) == -1) goto eoferr;
3444 /* We read the time so we need to read the object type again */
3445 if ((type = rdbLoadType(fp)) == -1) goto eoferr;
3446 }
ed9b544e 3447 if (type == REDIS_EOF) break;
3448 /* Handle SELECT DB opcode as a special case */
3449 if (type == REDIS_SELECTDB) {
c78a8ccc 3450 if ((dbid = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR)
e3566d4b 3451 goto eoferr;
ed9b544e 3452 if (dbid >= (unsigned)server.dbnum) {
f78fd11b 3453 redisLog(REDIS_WARNING,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server.dbnum);
ed9b544e 3454 exit(1);
3455 }
bb32ede5 3456 db = server.db+dbid;
3457 d = db->dict;
ed9b544e 3458 continue;
3459 }
3460 /* Read key */
c78a8ccc 3461 if ((keyobj = rdbLoadStringObject(fp)) == NULL) goto eoferr;
3462 /* Read value */
3463 if ((o = rdbLoadObject(type,fp)) == NULL) goto eoferr;
ed9b544e 3464 /* Add the new object in the hash table */
f78fd11b 3465 retval = dictAdd(d,keyobj,o);
ed9b544e 3466 if (retval == DICT_ERR) {
f78fd11b 3467 redisLog(REDIS_WARNING,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", keyobj->ptr);
ed9b544e 3468 exit(1);
3469 }
bb32ede5 3470 /* Set the expire time if needed */
3471 if (expiretime != -1) {
3472 setExpire(db,keyobj,expiretime);
3473 /* Delete this key if already expired */
3474 if (expiretime < now) deleteKey(db,keyobj);
3475 expiretime = -1;
3476 }
f78fd11b 3477 keyobj = o = NULL;
b492cf00 3478 /* Handle swapping while loading big datasets when VM is on */
3479 loadedkeys++;
3480 if (server.vm_enabled && (loadedkeys % 5000) == 0) {
3481 while (zmalloc_used_memory() > server.vm_max_memory) {
a69a0c9c 3482 if (vmSwapOneObjectBlocking() == REDIS_ERR) break;
b492cf00 3483 }
3484 }
ed9b544e 3485 }
3486 fclose(fp);
3487 return REDIS_OK;
3488
3489eoferr: /* unexpected end of file is handled here with a fatal exit */
e3566d4b 3490 if (keyobj) decrRefCount(keyobj);
f80dff62 3491 redisLog(REDIS_WARNING,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
ed9b544e 3492 exit(1);
3493 return REDIS_ERR; /* Just to avoid warning */
3494}
3495
3496/*================================== Commands =============================== */
3497
abcb223e 3498static void authCommand(redisClient *c) {
2e77c2ee 3499 if (!server.requirepass || !strcmp(c->argv[1]->ptr, server.requirepass)) {
abcb223e
BH
3500 c->authenticated = 1;
3501 addReply(c,shared.ok);
3502 } else {
3503 c->authenticated = 0;
fa4c0aba 3504 addReplySds(c,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
abcb223e
BH
3505 }
3506}
3507
ed9b544e 3508static void pingCommand(redisClient *c) {
3509 addReply(c,shared.pong);
3510}
3511
3512static void echoCommand(redisClient *c) {
942a3961 3513 addReplyBulkLen(c,c->argv[1]);
ed9b544e 3514 addReply(c,c->argv[1]);
3515 addReply(c,shared.crlf);
3516}
3517
3518/*=================================== Strings =============================== */
3519
3520static void setGenericCommand(redisClient *c, int nx) {
3521 int retval;
3522
333fd216 3523 if (nx) deleteIfVolatile(c->db,c->argv[1]);
3305306f 3524 retval = dictAdd(c->db->dict,c->argv[1],c->argv[2]);
ed9b544e 3525 if (retval == DICT_ERR) {
3526 if (!nx) {
1b03836c 3527 /* If the key is about a swapped value, we want a new key object
3528 * to overwrite the old. So we delete the old key in the database.
3529 * This will also make sure that swap pages about the old object
3530 * will be marked as free. */
3531 if (deleteIfSwapped(c->db,c->argv[1]))
3532 incrRefCount(c->argv[1]);
3305306f 3533 dictReplace(c->db->dict,c->argv[1],c->argv[2]);
ed9b544e 3534 incrRefCount(c->argv[2]);
3535 } else {
c937aa89 3536 addReply(c,shared.czero);
ed9b544e 3537 return;
3538 }
3539 } else {
3540 incrRefCount(c->argv[1]);
3541 incrRefCount(c->argv[2]);
3542 }
3543 server.dirty++;
3305306f 3544 removeExpire(c->db,c->argv[1]);
c937aa89 3545 addReply(c, nx ? shared.cone : shared.ok);
ed9b544e 3546}
3547
3548static void setCommand(redisClient *c) {
a4d1ba9a 3549 setGenericCommand(c,0);
ed9b544e 3550}
3551
3552static void setnxCommand(redisClient *c) {
a4d1ba9a 3553 setGenericCommand(c,1);
ed9b544e 3554}
3555
322fc7d8 3556static int getGenericCommand(redisClient *c) {
3305306f 3557 robj *o = lookupKeyRead(c->db,c->argv[1]);
3558
3559 if (o == NULL) {
c937aa89 3560 addReply(c,shared.nullbulk);
322fc7d8 3561 return REDIS_OK;
ed9b544e 3562 } else {
ed9b544e 3563 if (o->type != REDIS_STRING) {
c937aa89 3564 addReply(c,shared.wrongtypeerr);
322fc7d8 3565 return REDIS_ERR;
ed9b544e 3566 } else {
942a3961 3567 addReplyBulkLen(c,o);
ed9b544e 3568 addReply(c,o);
3569 addReply(c,shared.crlf);
322fc7d8 3570 return REDIS_OK;
ed9b544e 3571 }
3572 }
3573}
3574
322fc7d8 3575static void getCommand(redisClient *c) {
3576 getGenericCommand(c);
3577}
3578
f6b141c5 3579static void getsetCommand(redisClient *c) {
322fc7d8 3580 if (getGenericCommand(c) == REDIS_ERR) return;
a431eb74 3581 if (dictAdd(c->db->dict,c->argv[1],c->argv[2]) == DICT_ERR) {
3582 dictReplace(c->db->dict,c->argv[1],c->argv[2]);
3583 } else {
3584 incrRefCount(c->argv[1]);
3585 }
3586 incrRefCount(c->argv[2]);
3587 server.dirty++;
3588 removeExpire(c->db,c->argv[1]);
3589}
3590
70003d28 3591static void mgetCommand(redisClient *c) {
70003d28 3592 int j;
3593
c937aa89 3594 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",c->argc-1));
70003d28 3595 for (j = 1; j < c->argc; j++) {
3305306f 3596 robj *o = lookupKeyRead(c->db,c->argv[j]);
3597 if (o == NULL) {
c937aa89 3598 addReply(c,shared.nullbulk);
70003d28 3599 } else {
70003d28 3600 if (o->type != REDIS_STRING) {
c937aa89 3601 addReply(c,shared.nullbulk);
70003d28 3602 } else {
942a3961 3603 addReplyBulkLen(c,o);
70003d28 3604 addReply(c,o);
3605 addReply(c,shared.crlf);
3606 }
3607 }
3608 }
3609}
3610
6c446631 3611static void msetGenericCommand(redisClient *c, int nx) {
906573e7 3612 int j, busykeys = 0;
6c446631 3613
3614 if ((c->argc % 2) == 0) {
454d4e43 3615 addReplySds(c,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
6c446631 3616 return;
3617 }
3618 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
3619 * set nothing at all if at least one already key exists. */
3620 if (nx) {
3621 for (j = 1; j < c->argc; j += 2) {
906573e7 3622 if (lookupKeyWrite(c->db,c->argv[j]) != NULL) {
3623 busykeys++;
6c446631 3624 }
3625 }
3626 }
906573e7 3627 if (busykeys) {
3628 addReply(c, shared.czero);
3629 return;
3630 }
6c446631 3631
3632 for (j = 1; j < c->argc; j += 2) {
3633 int retval;
3634
17511391 3635 tryObjectEncoding(c->argv[j+1]);
6c446631 3636 retval = dictAdd(c->db->dict,c->argv[j],c->argv[j+1]);
3637 if (retval == DICT_ERR) {
3638 dictReplace(c->db->dict,c->argv[j],c->argv[j+1]);
3639 incrRefCount(c->argv[j+1]);
3640 } else {
3641 incrRefCount(c->argv[j]);
3642 incrRefCount(c->argv[j+1]);
3643 }
3644 removeExpire(c->db,c->argv[j]);
3645 }
3646 server.dirty += (c->argc-1)/2;
3647 addReply(c, nx ? shared.cone : shared.ok);
3648}
3649
3650static void msetCommand(redisClient *c) {
3651 msetGenericCommand(c,0);
3652}
3653
3654static void msetnxCommand(redisClient *c) {
3655 msetGenericCommand(c,1);
3656}
3657
d68ed120 3658static void incrDecrCommand(redisClient *c, long long incr) {
ed9b544e 3659 long long value;
3660 int retval;
3661 robj *o;
3662
3305306f 3663 o = lookupKeyWrite(c->db,c->argv[1]);
3664 if (o == NULL) {
ed9b544e 3665 value = 0;
3666 } else {
ed9b544e 3667 if (o->type != REDIS_STRING) {
3668 value = 0;
3669 } else {
3670 char *eptr;
3671
942a3961 3672 if (o->encoding == REDIS_ENCODING_RAW)
3673 value = strtoll(o->ptr, &eptr, 10);
3674 else if (o->encoding == REDIS_ENCODING_INT)
3675 value = (long)o->ptr;
3676 else
dfc5e96c 3677 redisAssert(1 != 1);
ed9b544e 3678 }
3679 }
3680
3681 value += incr;
3682 o = createObject(REDIS_STRING,sdscatprintf(sdsempty(),"%lld",value));
942a3961 3683 tryObjectEncoding(o);
3305306f 3684 retval = dictAdd(c->db->dict,c->argv[1],o);
ed9b544e 3685 if (retval == DICT_ERR) {
3305306f 3686 dictReplace(c->db->dict,c->argv[1],o);
3687 removeExpire(c->db,c->argv[1]);
ed9b544e 3688 } else {
3689 incrRefCount(c->argv[1]);
3690 }
3691 server.dirty++;
c937aa89 3692 addReply(c,shared.colon);
ed9b544e 3693 addReply(c,o);
3694 addReply(c,shared.crlf);
3695}
3696
3697static void incrCommand(redisClient *c) {
a4d1ba9a 3698 incrDecrCommand(c,1);
ed9b544e 3699}
3700
3701static void decrCommand(redisClient *c) {
a4d1ba9a 3702 incrDecrCommand(c,-1);
ed9b544e 3703}
3704
3705static void incrbyCommand(redisClient *c) {
d68ed120 3706 long long incr = strtoll(c->argv[2]->ptr, NULL, 10);
a4d1ba9a 3707 incrDecrCommand(c,incr);
ed9b544e 3708}
3709
3710static void decrbyCommand(redisClient *c) {
d68ed120 3711 long long incr = strtoll(c->argv[2]->ptr, NULL, 10);
a4d1ba9a 3712 incrDecrCommand(c,-incr);
ed9b544e 3713}
3714
4b00bebd 3715static void appendCommand(redisClient *c) {
3716 int retval;
3717 size_t totlen;
3718 robj *o;
3719
3720 o = lookupKeyWrite(c->db,c->argv[1]);
3721 if (o == NULL) {
3722 /* Create the key */
3723 retval = dictAdd(c->db->dict,c->argv[1],c->argv[2]);
3724 incrRefCount(c->argv[1]);
3725 incrRefCount(c->argv[2]);
3726 totlen = stringObjectLen(c->argv[2]);
3727 } else {
3728 dictEntry *de;
3729
3730 de = dictFind(c->db->dict,c->argv[1]);
3731 assert(de != NULL);
3732
3733 o = dictGetEntryVal(de);
3734 if (o->type != REDIS_STRING) {
3735 addReply(c,shared.wrongtypeerr);
3736 return;
3737 }
3738 /* If the object is specially encoded or shared we have to make
3739 * a copy */
3740 if (o->refcount != 1 || o->encoding != REDIS_ENCODING_RAW) {
3741 robj *decoded = getDecodedObject(o);
3742
3743 o = createStringObject(decoded->ptr, sdslen(decoded->ptr));
3744 decrRefCount(decoded);
3745 dictReplace(c->db->dict,c->argv[1],o);
3746 }
3747 /* APPEND! */
3748 if (c->argv[2]->encoding == REDIS_ENCODING_RAW) {
3749 o->ptr = sdscatlen(o->ptr,
3750 c->argv[2]->ptr, sdslen(c->argv[2]->ptr));
3751 } else {
3752 o->ptr = sdscatprintf(o->ptr, "%ld",
3753 (unsigned long) c->argv[2]->ptr);
3754 }
3755 totlen = sdslen(o->ptr);
3756 }
3757 server.dirty++;
3758 addReplySds(c,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen));
3759}
3760
ed9b544e 3761/* ========================= Type agnostic commands ========================= */
3762
3763static void delCommand(redisClient *c) {
5109cdff 3764 int deleted = 0, j;
3765
3766 for (j = 1; j < c->argc; j++) {
3767 if (deleteKey(c->db,c->argv[j])) {
3768 server.dirty++;
3769 deleted++;
3770 }
3771 }
3772 switch(deleted) {
3773 case 0:
c937aa89 3774 addReply(c,shared.czero);
5109cdff 3775 break;
3776 case 1:
3777 addReply(c,shared.cone);
3778 break;
3779 default:
3780 addReplySds(c,sdscatprintf(sdsempty(),":%d\r\n",deleted));
3781 break;
ed9b544e 3782 }
3783}
3784
3785static void existsCommand(redisClient *c) {
3305306f 3786 addReply(c,lookupKeyRead(c->db,c->argv[1]) ? shared.cone : shared.czero);
ed9b544e 3787}
3788
3789static void selectCommand(redisClient *c) {
3790 int id = atoi(c->argv[1]->ptr);
3791
3792 if (selectDb(c,id) == REDIS_ERR) {
774e3047 3793 addReplySds(c,sdsnew("-ERR invalid DB index\r\n"));
ed9b544e 3794 } else {
3795 addReply(c,shared.ok);
3796 }
3797}
3798
3799static void randomkeyCommand(redisClient *c) {
3800 dictEntry *de;
3305306f 3801
3802 while(1) {
3803 de = dictGetRandomKey(c->db->dict);
ce7bef07 3804 if (!de || expireIfNeeded(c->db,dictGetEntryKey(de)) == 0) break;
3305306f 3805 }
ed9b544e 3806 if (de == NULL) {
ce7bef07 3807 addReply(c,shared.plus);
ed9b544e 3808 addReply(c,shared.crlf);
3809 } else {
c937aa89 3810 addReply(c,shared.plus);
ed9b544e 3811 addReply(c,dictGetEntryKey(de));
3812 addReply(c,shared.crlf);
3813 }
3814}
3815
3816static void keysCommand(redisClient *c) {
3817 dictIterator *di;
3818 dictEntry *de;
3819 sds pattern = c->argv[1]->ptr;
3820 int plen = sdslen(pattern);
682ac724 3821 unsigned long numkeys = 0, keyslen = 0;
ed9b544e 3822 robj *lenobj = createObject(REDIS_STRING,NULL);
3823
3305306f 3824 di = dictGetIterator(c->db->dict);
ed9b544e 3825 addReply(c,lenobj);
3826 decrRefCount(lenobj);
3827 while((de = dictNext(di)) != NULL) {
3828 robj *keyobj = dictGetEntryKey(de);
3305306f 3829
ed9b544e 3830 sds key = keyobj->ptr;
3831 if ((pattern[0] == '*' && pattern[1] == '\0') ||
3832 stringmatchlen(pattern,plen,key,sdslen(key),0)) {
3305306f 3833 if (expireIfNeeded(c->db,keyobj) == 0) {
3834 if (numkeys != 0)
3835 addReply(c,shared.space);
3836 addReply(c,keyobj);
3837 numkeys++;
3838 keyslen += sdslen(key);
3839 }
ed9b544e 3840 }
3841 }
3842 dictReleaseIterator(di);
c937aa89 3843 lenobj->ptr = sdscatprintf(sdsempty(),"$%lu\r\n",keyslen+(numkeys ? (numkeys-1) : 0));
ed9b544e 3844 addReply(c,shared.crlf);
3845}
3846
3847static void dbsizeCommand(redisClient *c) {
3848 addReplySds(c,
3305306f 3849 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c->db->dict)));
ed9b544e 3850}
3851
3852static void lastsaveCommand(redisClient *c) {
3853 addReplySds(c,
c937aa89 3854 sdscatprintf(sdsempty(),":%lu\r\n",server.lastsave));
ed9b544e 3855}
3856
3857static void typeCommand(redisClient *c) {
3305306f 3858 robj *o;
ed9b544e 3859 char *type;
3305306f 3860
3861 o = lookupKeyRead(c->db,c->argv[1]);
3862 if (o == NULL) {
c937aa89 3863 type = "+none";
ed9b544e 3864 } else {
ed9b544e 3865 switch(o->type) {
c937aa89 3866 case REDIS_STRING: type = "+string"; break;
3867 case REDIS_LIST: type = "+list"; break;
3868 case REDIS_SET: type = "+set"; break;
412a8bce 3869 case REDIS_ZSET: type = "+zset"; break;
ed9b544e 3870 default: type = "unknown"; break;
3871 }
3872 }
3873 addReplySds(c,sdsnew(type));
3874 addReply(c,shared.crlf);
3875}
3876
3877static void saveCommand(redisClient *c) {
9d65a1bb 3878 if (server.bgsavechildpid != -1) {
05557f6d 3879 addReplySds(c,sdsnew("-ERR background save in progress\r\n"));
3880 return;
3881 }
f78fd11b 3882 if (rdbSave(server.dbfilename) == REDIS_OK) {
ed9b544e 3883 addReply(c,shared.ok);
3884 } else {
3885 addReply(c,shared.err);
3886 }
3887}
3888
3889static void bgsaveCommand(redisClient *c) {
9d65a1bb 3890 if (server.bgsavechildpid != -1) {
ed9b544e 3891 addReplySds(c,sdsnew("-ERR background save already in progress\r\n"));
3892 return;
3893 }
f78fd11b 3894 if (rdbSaveBackground(server.dbfilename) == REDIS_OK) {
49b99ab4 3895 char *status = "+Background saving started\r\n";
3896 addReplySds(c,sdsnew(status));
ed9b544e 3897 } else {
3898 addReply(c,shared.err);
3899 }
3900}
3901
3902static void shutdownCommand(redisClient *c) {
3903 redisLog(REDIS_WARNING,"User requested shutdown, saving DB...");
a3b21203 3904 /* Kill the saving child if there is a background saving in progress.
3905 We want to avoid race conditions, for instance our saving child may
3906 overwrite the synchronous saving did by SHUTDOWN. */
9d65a1bb 3907 if (server.bgsavechildpid != -1) {
9f3c422c 3908 redisLog(REDIS_WARNING,"There is a live saving child. Killing it!");
3909 kill(server.bgsavechildpid,SIGKILL);
a3b21203 3910 rdbRemoveTempFile(server.bgsavechildpid);
9f3c422c 3911 }
ac945e2d 3912 if (server.appendonly) {
3913 /* Append only file: fsync() the AOF and exit */
3914 fsync(server.appendfd);
054e426d 3915 if (server.vm_enabled) unlink(server.vm_swap_file);
ac945e2d 3916 exit(0);
ed9b544e 3917 } else {
ac945e2d 3918 /* Snapshotting. Perform a SYNC SAVE and exit */
3919 if (rdbSave(server.dbfilename) == REDIS_OK) {
3920 if (server.daemonize)
3921 unlink(server.pidfile);
3922 redisLog(REDIS_WARNING,"%zu bytes used at exit",zmalloc_used_memory());
3923 redisLog(REDIS_WARNING,"Server exit now, bye bye...");
054e426d 3924 if (server.vm_enabled) unlink(server.vm_swap_file);
ac945e2d 3925 exit(0);
3926 } else {
3927 /* Ooops.. error saving! The best we can do is to continue operating.
3928 * Note that if there was a background saving process, in the next
3929 * cron() Redis will be notified that the background saving aborted,
3930 * handling special stuff like slaves pending for synchronization... */
3931 redisLog(REDIS_WARNING,"Error trying to save the DB, can't exit");
3932 addReplySds(c,sdsnew("-ERR can't quit, problems saving the DB\r\n"));
3933 }
ed9b544e 3934 }
3935}
3936
3937static void renameGenericCommand(redisClient *c, int nx) {
ed9b544e 3938 robj *o;
3939
3940 /* To use the same key as src and dst is probably an error */
3941 if (sdscmp(c->argv[1]->ptr,c->argv[2]->ptr) == 0) {
c937aa89 3942 addReply(c,shared.sameobjecterr);
ed9b544e 3943 return;
3944 }
3945
3305306f 3946 o = lookupKeyWrite(c->db,c->argv[1]);
3947 if (o == NULL) {
c937aa89 3948 addReply(c,shared.nokeyerr);
ed9b544e 3949 return;
3950 }
ed9b544e 3951 incrRefCount(o);
3305306f 3952 deleteIfVolatile(c->db,c->argv[2]);
3953 if (dictAdd(c->db->dict,c->argv[2],o) == DICT_ERR) {
ed9b544e 3954 if (nx) {
3955 decrRefCount(o);
c937aa89 3956 addReply(c,shared.czero);
ed9b544e 3957 return;
3958 }
3305306f 3959 dictReplace(c->db->dict,c->argv[2],o);
ed9b544e 3960 } else {
3961 incrRefCount(c->argv[2]);
3962 }
3305306f 3963 deleteKey(c->db,c->argv[1]);
ed9b544e 3964 server.dirty++;
c937aa89 3965 addReply(c,nx ? shared.cone : shared.ok);
ed9b544e 3966}
3967
3968static void renameCommand(redisClient *c) {
3969 renameGenericCommand(c,0);
3970}
3971
3972static void renamenxCommand(redisClient *c) {
3973 renameGenericCommand(c,1);
3974}
3975
3976static void moveCommand(redisClient *c) {
3305306f 3977 robj *o;
3978 redisDb *src, *dst;
ed9b544e 3979 int srcid;
3980
3981 /* Obtain source and target DB pointers */
3305306f 3982 src = c->db;
3983 srcid = c->db->id;
ed9b544e 3984 if (selectDb(c,atoi(c->argv[2]->ptr)) == REDIS_ERR) {
c937aa89 3985 addReply(c,shared.outofrangeerr);
ed9b544e 3986 return;
3987 }
3305306f 3988 dst = c->db;
3989 selectDb(c,srcid); /* Back to the source DB */
ed9b544e 3990
3991 /* If the user is moving using as target the same
3992 * DB as the source DB it is probably an error. */
3993 if (src == dst) {
c937aa89 3994 addReply(c,shared.sameobjecterr);
ed9b544e 3995 return;
3996 }
3997
3998 /* Check if the element exists and get a reference */
3305306f 3999 o = lookupKeyWrite(c->db,c->argv[1]);
4000 if (!o) {
c937aa89 4001 addReply(c,shared.czero);
ed9b544e 4002 return;
4003 }
4004
4005 /* Try to add the element to the target DB */
3305306f 4006 deleteIfVolatile(dst,c->argv[1]);
4007 if (dictAdd(dst->dict,c->argv[1],o) == DICT_ERR) {
c937aa89 4008 addReply(c,shared.czero);
ed9b544e 4009 return;
4010 }
3305306f 4011 incrRefCount(c->argv[1]);
ed9b544e 4012 incrRefCount(o);
4013
4014 /* OK! key moved, free the entry in the source DB */
3305306f 4015 deleteKey(src,c->argv[1]);
ed9b544e 4016 server.dirty++;
c937aa89 4017 addReply(c,shared.cone);
ed9b544e 4018}
4019
4020/* =================================== Lists ================================ */
4021static void pushGenericCommand(redisClient *c, int where) {
4022 robj *lobj;
ed9b544e 4023 list *list;
3305306f 4024
4025 lobj = lookupKeyWrite(c->db,c->argv[1]);
4026 if (lobj == NULL) {
95242ab5 4027 if (handleClientsWaitingListPush(c,c->argv[1],c->argv[2])) {
4028 addReply(c,shared.ok);
4029 return;
4030 }
ed9b544e 4031 lobj = createListObject();
4032 list = lobj->ptr;
4033 if (where == REDIS_HEAD) {
6b47e12e 4034 listAddNodeHead(list,c->argv[2]);
ed9b544e 4035 } else {
6b47e12e 4036 listAddNodeTail(list,c->argv[2]);
ed9b544e 4037 }
3305306f 4038 dictAdd(c->db->dict,c->argv[1],lobj);
ed9b544e 4039 incrRefCount(c->argv[1]);
4040 incrRefCount(c->argv[2]);
4041 } else {
ed9b544e 4042 if (lobj->type != REDIS_LIST) {
4043 addReply(c,shared.wrongtypeerr);
4044 return;
4045 }
95242ab5 4046 if (handleClientsWaitingListPush(c,c->argv[1],c->argv[2])) {
4047 addReply(c,shared.ok);
4048 return;
4049 }
ed9b544e 4050 list = lobj->ptr;
4051 if (where == REDIS_HEAD) {
6b47e12e 4052 listAddNodeHead(list,c->argv[2]);
ed9b544e 4053 } else {
6b47e12e 4054 listAddNodeTail(list,c->argv[2]);
ed9b544e 4055 }
4056 incrRefCount(c->argv[2]);
4057 }
4058 server.dirty++;
4059 addReply(c,shared.ok);
4060}
4061
4062static void lpushCommand(redisClient *c) {
4063 pushGenericCommand(c,REDIS_HEAD);
4064}
4065
4066static void rpushCommand(redisClient *c) {
4067 pushGenericCommand(c,REDIS_TAIL);
4068}
4069
4070static void llenCommand(redisClient *c) {
3305306f 4071 robj *o;
ed9b544e 4072 list *l;
4073
3305306f 4074 o = lookupKeyRead(c->db,c->argv[1]);
4075 if (o == NULL) {
c937aa89 4076 addReply(c,shared.czero);
ed9b544e 4077 return;
4078 } else {
ed9b544e 4079 if (o->type != REDIS_LIST) {
c937aa89 4080 addReply(c,shared.wrongtypeerr);
ed9b544e 4081 } else {
4082 l = o->ptr;
c937aa89 4083 addReplySds(c,sdscatprintf(sdsempty(),":%d\r\n",listLength(l)));
ed9b544e 4084 }
4085 }
4086}
4087
4088static void lindexCommand(redisClient *c) {
3305306f 4089 robj *o;
ed9b544e 4090 int index = atoi(c->argv[2]->ptr);
4091
3305306f 4092 o = lookupKeyRead(c->db,c->argv[1]);
4093 if (o == NULL) {
c937aa89 4094 addReply(c,shared.nullbulk);
ed9b544e 4095 } else {
ed9b544e 4096 if (o->type != REDIS_LIST) {
c937aa89 4097 addReply(c,shared.wrongtypeerr);
ed9b544e 4098 } else {
4099 list *list = o->ptr;
4100 listNode *ln;
4101
4102 ln = listIndex(list, index);
4103 if (ln == NULL) {
c937aa89 4104 addReply(c,shared.nullbulk);
ed9b544e 4105 } else {
4106 robj *ele = listNodeValue(ln);
942a3961 4107 addReplyBulkLen(c,ele);
ed9b544e 4108 addReply(c,ele);
4109 addReply(c,shared.crlf);
4110 }
4111 }
4112 }
4113}
4114
4115static void lsetCommand(redisClient *c) {
3305306f 4116 robj *o;
ed9b544e 4117 int index = atoi(c->argv[2]->ptr);
4118
3305306f 4119 o = lookupKeyWrite(c->db,c->argv[1]);
4120 if (o == NULL) {
ed9b544e 4121 addReply(c,shared.nokeyerr);
4122 } else {
ed9b544e 4123 if (o->type != REDIS_LIST) {
4124 addReply(c,shared.wrongtypeerr);
4125 } else {
4126 list *list = o->ptr;
4127 listNode *ln;
4128
4129 ln = listIndex(list, index);
4130 if (ln == NULL) {
c937aa89 4131 addReply(c,shared.outofrangeerr);
ed9b544e 4132 } else {
4133 robj *ele = listNodeValue(ln);
4134
4135 decrRefCount(ele);
4136 listNodeValue(ln) = c->argv[3];
4137 incrRefCount(c->argv[3]);
4138 addReply(c,shared.ok);
4139 server.dirty++;
4140 }
4141 }
4142 }
4143}
4144
4145static void popGenericCommand(redisClient *c, int where) {
3305306f 4146 robj *o;
4147
4148 o = lookupKeyWrite(c->db,c->argv[1]);
4149 if (o == NULL) {
c937aa89 4150 addReply(c,shared.nullbulk);
ed9b544e 4151 } else {
ed9b544e 4152 if (o->type != REDIS_LIST) {
c937aa89 4153 addReply(c,shared.wrongtypeerr);
ed9b544e 4154 } else {
4155 list *list = o->ptr;
4156 listNode *ln;
4157
4158 if (where == REDIS_HEAD)
4159 ln = listFirst(list);
4160 else
4161 ln = listLast(list);
4162
4163 if (ln == NULL) {
c937aa89 4164 addReply(c,shared.nullbulk);
ed9b544e 4165 } else {
4166 robj *ele = listNodeValue(ln);
942a3961 4167 addReplyBulkLen(c,ele);
ed9b544e 4168 addReply(c,ele);
4169 addReply(c,shared.crlf);
4170 listDelNode(list,ln);
4171 server.dirty++;
4172 }
4173 }
4174 }
4175}
4176
4177static void lpopCommand(redisClient *c) {
4178 popGenericCommand(c,REDIS_HEAD);
4179}
4180
4181static void rpopCommand(redisClient *c) {
4182 popGenericCommand(c,REDIS_TAIL);
4183}
4184
4185static void lrangeCommand(redisClient *c) {
3305306f 4186 robj *o;
ed9b544e 4187 int start = atoi(c->argv[2]->ptr);
4188 int end = atoi(c->argv[3]->ptr);
3305306f 4189
4190 o = lookupKeyRead(c->db,c->argv[1]);
4191 if (o == NULL) {
c937aa89 4192 addReply(c,shared.nullmultibulk);
ed9b544e 4193 } else {
ed9b544e 4194 if (o->type != REDIS_LIST) {
c937aa89 4195 addReply(c,shared.wrongtypeerr);
ed9b544e 4196 } else {
4197 list *list = o->ptr;
4198 listNode *ln;
4199 int llen = listLength(list);
4200 int rangelen, j;
4201 robj *ele;
4202
4203 /* convert negative indexes */
4204 if (start < 0) start = llen+start;
4205 if (end < 0) end = llen+end;
4206 if (start < 0) start = 0;
4207 if (end < 0) end = 0;
4208
4209 /* indexes sanity checks */
4210 if (start > end || start >= llen) {
4211 /* Out of range start or start > end result in empty list */
c937aa89 4212 addReply(c,shared.emptymultibulk);
ed9b544e 4213 return;
4214 }
4215 if (end >= llen) end = llen-1;
4216 rangelen = (end-start)+1;
4217
4218 /* Return the result in form of a multi-bulk reply */
4219 ln = listIndex(list, start);
c937aa89 4220 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",rangelen));
ed9b544e 4221 for (j = 0; j < rangelen; j++) {
4222 ele = listNodeValue(ln);
942a3961 4223 addReplyBulkLen(c,ele);
ed9b544e 4224 addReply(c,ele);
4225 addReply(c,shared.crlf);
4226 ln = ln->next;
4227 }
4228 }
4229 }
4230}
4231
4232static void ltrimCommand(redisClient *c) {
3305306f 4233 robj *o;
ed9b544e 4234 int start = atoi(c->argv[2]->ptr);
4235 int end = atoi(c->argv[3]->ptr);
4236
3305306f 4237 o = lookupKeyWrite(c->db,c->argv[1]);
4238 if (o == NULL) {
ab9d4cb1 4239 addReply(c,shared.ok);
ed9b544e 4240 } else {
ed9b544e 4241 if (o->type != REDIS_LIST) {
4242 addReply(c,shared.wrongtypeerr);
4243 } else {
4244 list *list = o->ptr;
4245 listNode *ln;
4246 int llen = listLength(list);
4247 int j, ltrim, rtrim;
4248
4249 /* convert negative indexes */
4250 if (start < 0) start = llen+start;
4251 if (end < 0) end = llen+end;
4252 if (start < 0) start = 0;
4253 if (end < 0) end = 0;
4254
4255 /* indexes sanity checks */
4256 if (start > end || start >= llen) {
4257 /* Out of range start or start > end result in empty list */
4258 ltrim = llen;
4259 rtrim = 0;
4260 } else {
4261 if (end >= llen) end = llen-1;
4262 ltrim = start;
4263 rtrim = llen-end-1;
4264 }
4265
4266 /* Remove list elements to perform the trim */
4267 for (j = 0; j < ltrim; j++) {
4268 ln = listFirst(list);
4269 listDelNode(list,ln);
4270 }
4271 for (j = 0; j < rtrim; j++) {
4272 ln = listLast(list);
4273 listDelNode(list,ln);
4274 }
ed9b544e 4275 server.dirty++;
e59229a2 4276 addReply(c,shared.ok);
ed9b544e 4277 }
4278 }
4279}
4280
4281static void lremCommand(redisClient *c) {
3305306f 4282 robj *o;
ed9b544e 4283
3305306f 4284 o = lookupKeyWrite(c->db,c->argv[1]);
4285 if (o == NULL) {
33c08b39 4286 addReply(c,shared.czero);
ed9b544e 4287 } else {
ed9b544e 4288 if (o->type != REDIS_LIST) {
c937aa89 4289 addReply(c,shared.wrongtypeerr);
ed9b544e 4290 } else {
4291 list *list = o->ptr;
4292 listNode *ln, *next;
4293 int toremove = atoi(c->argv[2]->ptr);
4294 int removed = 0;
4295 int fromtail = 0;
4296
4297 if (toremove < 0) {
4298 toremove = -toremove;
4299 fromtail = 1;
4300 }
4301 ln = fromtail ? list->tail : list->head;
4302 while (ln) {
ed9b544e 4303 robj *ele = listNodeValue(ln);
a4d1ba9a 4304
4305 next = fromtail ? ln->prev : ln->next;
724a51b1 4306 if (compareStringObjects(ele,c->argv[3]) == 0) {
ed9b544e 4307 listDelNode(list,ln);
4308 server.dirty++;
4309 removed++;
4310 if (toremove && removed == toremove) break;
4311 }
4312 ln = next;
4313 }
c937aa89 4314 addReplySds(c,sdscatprintf(sdsempty(),":%d\r\n",removed));
ed9b544e 4315 }
4316 }
4317}
4318
12f9d551 4319/* This is the semantic of this command:
0f5f7e9a 4320 * RPOPLPUSH srclist dstlist:
12f9d551 4321 * IF LLEN(srclist) > 0
4322 * element = RPOP srclist
4323 * LPUSH dstlist element
4324 * RETURN element
4325 * ELSE
4326 * RETURN nil
4327 * END
4328 * END
4329 *
4330 * The idea is to be able to get an element from a list in a reliable way
4331 * since the element is not just returned but pushed against another list
4332 * as well. This command was originally proposed by Ezra Zygmuntowicz.
4333 */
0f5f7e9a 4334static void rpoplpushcommand(redisClient *c) {
12f9d551 4335 robj *sobj;
4336
4337 sobj = lookupKeyWrite(c->db,c->argv[1]);
4338 if (sobj == NULL) {
4339 addReply(c,shared.nullbulk);
4340 } else {
4341 if (sobj->type != REDIS_LIST) {
4342 addReply(c,shared.wrongtypeerr);
4343 } else {
4344 list *srclist = sobj->ptr;
4345 listNode *ln = listLast(srclist);
4346
4347 if (ln == NULL) {
4348 addReply(c,shared.nullbulk);
4349 } else {
4350 robj *dobj = lookupKeyWrite(c->db,c->argv[2]);
4351 robj *ele = listNodeValue(ln);
4352 list *dstlist;
4353
e20fb74f 4354 if (dobj && dobj->type != REDIS_LIST) {
12f9d551 4355 addReply(c,shared.wrongtypeerr);
4356 return;
4357 }
e20fb74f 4358
4359 /* Add the element to the target list (unless it's directly
4360 * passed to some BLPOP-ing client */
4361 if (!handleClientsWaitingListPush(c,c->argv[2],ele)) {
4362 if (dobj == NULL) {
4363 /* Create the list if the key does not exist */
4364 dobj = createListObject();
4365 dictAdd(c->db->dict,c->argv[2],dobj);
4366 incrRefCount(c->argv[2]);
4367 }
4368 dstlist = dobj->ptr;
4369 listAddNodeHead(dstlist,ele);
4370 incrRefCount(ele);
4371 }
12f9d551 4372
4373 /* Send the element to the client as reply as well */
4374 addReplyBulkLen(c,ele);
4375 addReply(c,ele);
4376 addReply(c,shared.crlf);
4377
4378 /* Finally remove the element from the source list */
4379 listDelNode(srclist,ln);
4380 server.dirty++;
4381 }
4382 }
4383 }
4384}
4385
4386
ed9b544e 4387/* ==================================== Sets ================================ */
4388
4389static void saddCommand(redisClient *c) {
ed9b544e 4390 robj *set;
4391
3305306f 4392 set = lookupKeyWrite(c->db,c->argv[1]);
4393 if (set == NULL) {
ed9b544e 4394 set = createSetObject();
3305306f 4395 dictAdd(c->db->dict,c->argv[1],set);
ed9b544e 4396 incrRefCount(c->argv[1]);
4397 } else {
ed9b544e 4398 if (set->type != REDIS_SET) {
c937aa89 4399 addReply(c,shared.wrongtypeerr);
ed9b544e 4400 return;
4401 }
4402 }
4403 if (dictAdd(set->ptr,c->argv[2],NULL) == DICT_OK) {
4404 incrRefCount(c->argv[2]);
4405 server.dirty++;
c937aa89 4406 addReply(c,shared.cone);
ed9b544e 4407 } else {
c937aa89 4408 addReply(c,shared.czero);
ed9b544e 4409 }
4410}
4411
4412static void sremCommand(redisClient *c) {
3305306f 4413 robj *set;
ed9b544e 4414
3305306f 4415 set = lookupKeyWrite(c->db,c->argv[1]);
4416 if (set == NULL) {
c937aa89 4417 addReply(c,shared.czero);
ed9b544e 4418 } else {
ed9b544e 4419 if (set->type != REDIS_SET) {
c937aa89 4420 addReply(c,shared.wrongtypeerr);
ed9b544e 4421 return;
4422 }
4423 if (dictDelete(set->ptr,c->argv[2]) == DICT_OK) {
4424 server.dirty++;
12fea928 4425 if (htNeedsResize(set->ptr)) dictResize(set->ptr);
c937aa89 4426 addReply(c,shared.cone);
ed9b544e 4427 } else {
c937aa89 4428 addReply(c,shared.czero);
ed9b544e 4429 }
4430 }
4431}
4432
a4460ef4 4433static void smoveCommand(redisClient *c) {
4434 robj *srcset, *dstset;
4435
4436 srcset = lookupKeyWrite(c->db,c->argv[1]);
4437 dstset = lookupKeyWrite(c->db,c->argv[2]);
4438
4439 /* If the source key does not exist return 0, if it's of the wrong type
4440 * raise an error */
4441 if (srcset == NULL || srcset->type != REDIS_SET) {
4442 addReply(c, srcset ? shared.wrongtypeerr : shared.czero);
4443 return;
4444 }
4445 /* Error if the destination key is not a set as well */
4446 if (dstset && dstset->type != REDIS_SET) {
4447 addReply(c,shared.wrongtypeerr);
4448 return;
4449 }
4450 /* Remove the element from the source set */
4451 if (dictDelete(srcset->ptr,c->argv[3]) == DICT_ERR) {
4452 /* Key not found in the src set! return zero */
4453 addReply(c,shared.czero);
4454 return;
4455 }
4456 server.dirty++;
4457 /* Add the element to the destination set */
4458 if (!dstset) {
4459 dstset = createSetObject();
4460 dictAdd(c->db->dict,c->argv[2],dstset);
4461 incrRefCount(c->argv[2]);
4462 }
4463 if (dictAdd(dstset->ptr,c->argv[3],NULL) == DICT_OK)
4464 incrRefCount(c->argv[3]);
4465 addReply(c,shared.cone);
4466}
4467
ed9b544e 4468static void sismemberCommand(redisClient *c) {
3305306f 4469 robj *set;
ed9b544e 4470
3305306f 4471 set = lookupKeyRead(c->db,c->argv[1]);
4472 if (set == NULL) {
c937aa89 4473 addReply(c,shared.czero);
ed9b544e 4474 } else {
ed9b544e 4475 if (set->type != REDIS_SET) {
c937aa89 4476 addReply(c,shared.wrongtypeerr);
ed9b544e 4477 return;
4478 }
4479 if (dictFind(set->ptr,c->argv[2]))
c937aa89 4480 addReply(c,shared.cone);
ed9b544e 4481 else
c937aa89 4482 addReply(c,shared.czero);
ed9b544e 4483 }
4484}
4485
4486static void scardCommand(redisClient *c) {
3305306f 4487 robj *o;
ed9b544e 4488 dict *s;
4489
3305306f 4490 o = lookupKeyRead(c->db,c->argv[1]);
4491 if (o == NULL) {
c937aa89 4492 addReply(c,shared.czero);
ed9b544e 4493 return;
4494 } else {
ed9b544e 4495 if (o->type != REDIS_SET) {
c937aa89 4496 addReply(c,shared.wrongtypeerr);
ed9b544e 4497 } else {
4498 s = o->ptr;
682ac724 4499 addReplySds(c,sdscatprintf(sdsempty(),":%lu\r\n",
3305306f 4500 dictSize(s)));
ed9b544e 4501 }
4502 }
4503}
4504
12fea928 4505static void spopCommand(redisClient *c) {
4506 robj *set;
4507 dictEntry *de;
4508
4509 set = lookupKeyWrite(c->db,c->argv[1]);
4510 if (set == NULL) {
4511 addReply(c,shared.nullbulk);
4512 } else {
4513 if (set->type != REDIS_SET) {
4514 addReply(c,shared.wrongtypeerr);
4515 return;
4516 }
4517 de = dictGetRandomKey(set->ptr);
4518 if (de == NULL) {
4519 addReply(c,shared.nullbulk);
4520 } else {
4521 robj *ele = dictGetEntryKey(de);
4522
942a3961 4523 addReplyBulkLen(c,ele);
12fea928 4524 addReply(c,ele);
4525 addReply(c,shared.crlf);
4526 dictDelete(set->ptr,ele);
4527 if (htNeedsResize(set->ptr)) dictResize(set->ptr);
4528 server.dirty++;
4529 }
4530 }
4531}
4532
2abb95a9 4533static void srandmemberCommand(redisClient *c) {
4534 robj *set;
4535 dictEntry *de;
4536
4537 set = lookupKeyRead(c->db,c->argv[1]);
4538 if (set == NULL) {
4539 addReply(c,shared.nullbulk);
4540 } else {
4541 if (set->type != REDIS_SET) {
4542 addReply(c,shared.wrongtypeerr);
4543 return;
4544 }
4545 de = dictGetRandomKey(set->ptr);
4546 if (de == NULL) {
4547 addReply(c,shared.nullbulk);
4548 } else {
4549 robj *ele = dictGetEntryKey(de);
4550
4551 addReplyBulkLen(c,ele);
4552 addReply(c,ele);
4553 addReply(c,shared.crlf);
4554 }
4555 }
4556}
4557
ed9b544e 4558static int qsortCompareSetsByCardinality(const void *s1, const void *s2) {
4559 dict **d1 = (void*) s1, **d2 = (void*) s2;
4560
3305306f 4561 return dictSize(*d1)-dictSize(*d2);
ed9b544e 4562}
4563
682ac724 4564static void sinterGenericCommand(redisClient *c, robj **setskeys, unsigned long setsnum, robj *dstkey) {
ed9b544e 4565 dict **dv = zmalloc(sizeof(dict*)*setsnum);
4566 dictIterator *di;
4567 dictEntry *de;
4568 robj *lenobj = NULL, *dstset = NULL;
682ac724 4569 unsigned long j, cardinality = 0;
ed9b544e 4570
ed9b544e 4571 for (j = 0; j < setsnum; j++) {
4572 robj *setobj;
3305306f 4573
4574 setobj = dstkey ?
4575 lookupKeyWrite(c->db,setskeys[j]) :
4576 lookupKeyRead(c->db,setskeys[j]);
4577 if (!setobj) {
ed9b544e 4578 zfree(dv);
5faa6025 4579 if (dstkey) {
fdcaae84 4580 if (deleteKey(c->db,dstkey))
4581 server.dirty++;
0d36ded0 4582 addReply(c,shared.czero);
5faa6025 4583 } else {
4584 addReply(c,shared.nullmultibulk);
4585 }
ed9b544e 4586 return;
4587 }
ed9b544e 4588 if (setobj->type != REDIS_SET) {
4589 zfree(dv);
c937aa89 4590 addReply(c,shared.wrongtypeerr);
ed9b544e 4591 return;
4592 }
4593 dv[j] = setobj->ptr;
4594 }
4595 /* Sort sets from the smallest to largest, this will improve our
4596 * algorithm's performace */
4597 qsort(dv,setsnum,sizeof(dict*),qsortCompareSetsByCardinality);
4598
4599 /* The first thing we should output is the total number of elements...
4600 * since this is a multi-bulk write, but at this stage we don't know
4601 * the intersection set size, so we use a trick, append an empty object
4602 * to the output list and save the pointer to later modify it with the
4603 * right length */
4604 if (!dstkey) {
4605 lenobj = createObject(REDIS_STRING,NULL);
4606 addReply(c,lenobj);
4607 decrRefCount(lenobj);
4608 } else {
4609 /* If we have a target key where to store the resulting set
4610 * create this key with an empty set inside */
4611 dstset = createSetObject();
ed9b544e 4612 }
4613
4614 /* Iterate all the elements of the first (smallest) set, and test
4615 * the element against all the other sets, if at least one set does
4616 * not include the element it is discarded */
4617 di = dictGetIterator(dv[0]);
ed9b544e 4618
4619 while((de = dictNext(di)) != NULL) {
4620 robj *ele;
4621
4622 for (j = 1; j < setsnum; j++)
4623 if (dictFind(dv[j],dictGetEntryKey(de)) == NULL) break;
4624 if (j != setsnum)
4625 continue; /* at least one set does not contain the member */
4626 ele = dictGetEntryKey(de);
4627 if (!dstkey) {
942a3961 4628 addReplyBulkLen(c,ele);
ed9b544e 4629 addReply(c,ele);
4630 addReply(c,shared.crlf);
4631 cardinality++;
4632 } else {
4633 dictAdd(dstset->ptr,ele,NULL);
4634 incrRefCount(ele);
4635 }
4636 }
4637 dictReleaseIterator(di);
4638
83cdfe18
AG
4639 if (dstkey) {
4640 /* Store the resulting set into the target */
4641 deleteKey(c->db,dstkey);
4642 dictAdd(c->db->dict,dstkey,dstset);
4643 incrRefCount(dstkey);
4644 }
4645
40d224a9 4646 if (!dstkey) {
682ac724 4647 lenobj->ptr = sdscatprintf(sdsempty(),"*%lu\r\n",cardinality);
40d224a9 4648 } else {
682ac724 4649 addReplySds(c,sdscatprintf(sdsempty(),":%lu\r\n",
03fd01c7 4650 dictSize((dict*)dstset->ptr)));
40d224a9 4651 server.dirty++;
4652 }
ed9b544e 4653 zfree(dv);
4654}
4655
4656static void sinterCommand(redisClient *c) {
4657 sinterGenericCommand(c,c->argv+1,c->argc-1,NULL);
4658}
4659
4660static void sinterstoreCommand(redisClient *c) {
4661 sinterGenericCommand(c,c->argv+2,c->argc-2,c->argv[1]);
4662}
4663
f4f56e1d 4664#define REDIS_OP_UNION 0
4665#define REDIS_OP_DIFF 1
4666
4667static void sunionDiffGenericCommand(redisClient *c, robj **setskeys, int setsnum, robj *dstkey, int op) {
40d224a9 4668 dict **dv = zmalloc(sizeof(dict*)*setsnum);
4669 dictIterator *di;
4670 dictEntry *de;
f4f56e1d 4671 robj *dstset = NULL;
40d224a9 4672 int j, cardinality = 0;
4673
40d224a9 4674 for (j = 0; j < setsnum; j++) {
4675 robj *setobj;
4676
4677 setobj = dstkey ?
4678 lookupKeyWrite(c->db,setskeys[j]) :
4679 lookupKeyRead(c->db,setskeys[j]);
4680 if (!setobj) {
4681 dv[j] = NULL;
4682 continue;
4683 }
4684 if (setobj->type != REDIS_SET) {
4685 zfree(dv);
4686 addReply(c,shared.wrongtypeerr);
4687 return;
4688 }
4689 dv[j] = setobj->ptr;
4690 }
4691
4692 /* We need a temp set object to store our union. If the dstkey
4693 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
4694 * this set object will be the resulting object to set into the target key*/
4695 dstset = createSetObject();
4696
40d224a9 4697 /* Iterate all the elements of all the sets, add every element a single
4698 * time to the result set */
4699 for (j = 0; j < setsnum; j++) {
51829ed3 4700 if (op == REDIS_OP_DIFF && j == 0 && !dv[j]) break; /* result set is empty */
40d224a9 4701 if (!dv[j]) continue; /* non existing keys are like empty sets */
4702
4703 di = dictGetIterator(dv[j]);
40d224a9 4704
4705 while((de = dictNext(di)) != NULL) {
4706 robj *ele;
4707
4708 /* dictAdd will not add the same element multiple times */
4709 ele = dictGetEntryKey(de);
f4f56e1d 4710 if (op == REDIS_OP_UNION || j == 0) {
4711 if (dictAdd(dstset->ptr,ele,NULL) == DICT_OK) {
4712 incrRefCount(ele);
40d224a9 4713 cardinality++;
4714 }
f4f56e1d 4715 } else if (op == REDIS_OP_DIFF) {
4716 if (dictDelete(dstset->ptr,ele) == DICT_OK) {
4717 cardinality--;
4718 }
40d224a9 4719 }
4720 }
4721 dictReleaseIterator(di);
51829ed3
AG
4722
4723 if (op == REDIS_OP_DIFF && cardinality == 0) break; /* result set is empty */
40d224a9 4724 }
4725
f4f56e1d 4726 /* Output the content of the resulting set, if not in STORE mode */
4727 if (!dstkey) {
4728 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",cardinality));
4729 di = dictGetIterator(dstset->ptr);
f4f56e1d 4730 while((de = dictNext(di)) != NULL) {
4731 robj *ele;
4732
4733 ele = dictGetEntryKey(de);
942a3961 4734 addReplyBulkLen(c,ele);
f4f56e1d 4735 addReply(c,ele);
4736 addReply(c,shared.crlf);
4737 }
4738 dictReleaseIterator(di);
83cdfe18
AG
4739 } else {
4740 /* If we have a target key where to store the resulting set
4741 * create this key with the result set inside */
4742 deleteKey(c->db,dstkey);
4743 dictAdd(c->db->dict,dstkey,dstset);
4744 incrRefCount(dstkey);
f4f56e1d 4745 }
4746
4747 /* Cleanup */
40d224a9 4748 if (!dstkey) {
40d224a9 4749 decrRefCount(dstset);
4750 } else {
682ac724 4751 addReplySds(c,sdscatprintf(sdsempty(),":%lu\r\n",
03fd01c7 4752 dictSize((dict*)dstset->ptr)));
40d224a9 4753 server.dirty++;
4754 }
4755 zfree(dv);
4756}
4757
4758static void sunionCommand(redisClient *c) {
f4f56e1d 4759 sunionDiffGenericCommand(c,c->argv+1,c->argc-1,NULL,REDIS_OP_UNION);
40d224a9 4760}
4761
4762static void sunionstoreCommand(redisClient *c) {
f4f56e1d 4763 sunionDiffGenericCommand(c,c->argv+2,c->argc-2,c->argv[1],REDIS_OP_UNION);
4764}
4765
4766static void sdiffCommand(redisClient *c) {
4767 sunionDiffGenericCommand(c,c->argv+1,c->argc-1,NULL,REDIS_OP_DIFF);
4768}
4769
4770static void sdiffstoreCommand(redisClient *c) {
4771 sunionDiffGenericCommand(c,c->argv+2,c->argc-2,c->argv[1],REDIS_OP_DIFF);
40d224a9 4772}
4773
6b47e12e 4774/* ==================================== ZSets =============================== */
4775
4776/* ZSETs are ordered sets using two data structures to hold the same elements
4777 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
4778 * data structure.
4779 *
4780 * The elements are added to an hash table mapping Redis objects to scores.
4781 * At the same time the elements are added to a skip list mapping scores
4782 * to Redis objects (so objects are sorted by scores in this "view"). */
4783
4784/* This skiplist implementation is almost a C translation of the original
4785 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
4786 * Alternative to Balanced Trees", modified in three ways:
4787 * a) this implementation allows for repeated values.
4788 * b) the comparison is not just by key (our 'score') but by satellite data.
4789 * c) there is a back pointer, so it's a doubly linked list with the back
4790 * pointers being only at "level 1". This allows to traverse the list
4791 * from tail to head, useful for ZREVRANGE. */
4792
4793static zskiplistNode *zslCreateNode(int level, double score, robj *obj) {
4794 zskiplistNode *zn = zmalloc(sizeof(*zn));
4795
4796 zn->forward = zmalloc(sizeof(zskiplistNode*) * level);
4797 zn->score = score;
4798 zn->obj = obj;
4799 return zn;
4800}
4801
4802static zskiplist *zslCreate(void) {
4803 int j;
4804 zskiplist *zsl;
4805
4806 zsl = zmalloc(sizeof(*zsl));
4807 zsl->level = 1;
cc812361 4808 zsl->length = 0;
6b47e12e 4809 zsl->header = zslCreateNode(ZSKIPLIST_MAXLEVEL,0,NULL);
4810 for (j = 0; j < ZSKIPLIST_MAXLEVEL; j++)
4811 zsl->header->forward[j] = NULL;
e3870fab 4812 zsl->header->backward = NULL;
4813 zsl->tail = NULL;
6b47e12e 4814 return zsl;
4815}
4816
fd8ccf44 4817static void zslFreeNode(zskiplistNode *node) {
4818 decrRefCount(node->obj);
ad807e6f 4819 zfree(node->forward);
fd8ccf44 4820 zfree(node);
4821}
4822
4823static void zslFree(zskiplist *zsl) {
ad807e6f 4824 zskiplistNode *node = zsl->header->forward[0], *next;
fd8ccf44 4825
ad807e6f 4826 zfree(zsl->header->forward);
4827 zfree(zsl->header);
fd8ccf44 4828 while(node) {
599379dd 4829 next = node->forward[0];
fd8ccf44 4830 zslFreeNode(node);
4831 node = next;
4832 }
ad807e6f 4833 zfree(zsl);
fd8ccf44 4834}
4835
6b47e12e 4836static int zslRandomLevel(void) {
4837 int level = 1;
4838 while ((random()&0xFFFF) < (ZSKIPLIST_P * 0xFFFF))
4839 level += 1;
4840 return level;
4841}
4842
4843static void zslInsert(zskiplist *zsl, double score, robj *obj) {
4844 zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;
4845 int i, level;
4846
4847 x = zsl->header;
4848 for (i = zsl->level-1; i >= 0; i--) {
9d60e6e4 4849 while (x->forward[i] &&
4850 (x->forward[i]->score < score ||
4851 (x->forward[i]->score == score &&
4852 compareStringObjects(x->forward[i]->obj,obj) < 0)))
6b47e12e 4853 x = x->forward[i];
4854 update[i] = x;
4855 }
6b47e12e 4856 /* we assume the key is not already inside, since we allow duplicated
4857 * scores, and the re-insertion of score and redis object should never
4858 * happpen since the caller of zslInsert() should test in the hash table
4859 * if the element is already inside or not. */
4860 level = zslRandomLevel();
4861 if (level > zsl->level) {
4862 for (i = zsl->level; i < level; i++)
4863 update[i] = zsl->header;
4864 zsl->level = level;
4865 }
4866 x = zslCreateNode(level,score,obj);
4867 for (i = 0; i < level; i++) {
4868 x->forward[i] = update[i]->forward[i];
4869 update[i]->forward[i] = x;
4870 }
bb975144 4871 x->backward = (update[0] == zsl->header) ? NULL : update[0];
e3870fab 4872 if (x->forward[0])
4873 x->forward[0]->backward = x;
4874 else
4875 zsl->tail = x;
cc812361 4876 zsl->length++;
6b47e12e 4877}
4878
50c55df5 4879/* Delete an element with matching score/object from the skiplist. */
fd8ccf44 4880static int zslDelete(zskiplist *zsl, double score, robj *obj) {
e197b441 4881 zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;
4882 int i;
4883
4884 x = zsl->header;
4885 for (i = zsl->level-1; i >= 0; i--) {
9d60e6e4 4886 while (x->forward[i] &&
4887 (x->forward[i]->score < score ||
4888 (x->forward[i]->score == score &&
4889 compareStringObjects(x->forward[i]->obj,obj) < 0)))
e197b441 4890 x = x->forward[i];
4891 update[i] = x;
4892 }
4893 /* We may have multiple elements with the same score, what we need
4894 * is to find the element with both the right score and object. */
4895 x = x->forward[0];
50c55df5 4896 if (x && score == x->score && compareStringObjects(x->obj,obj) == 0) {
9d60e6e4 4897 for (i = 0; i < zsl->level; i++) {
4898 if (update[i]->forward[i] != x) break;
4899 update[i]->forward[i] = x->forward[i];
4900 }
4901 if (x->forward[0]) {
4902 x->forward[0]->backward = (x->backward == zsl->header) ?
4903 NULL : x->backward;
e197b441 4904 } else {
9d60e6e4 4905 zsl->tail = x->backward;
e197b441 4906 }
9d60e6e4 4907 zslFreeNode(x);
4908 while(zsl->level > 1 && zsl->header->forward[zsl->level-1] == NULL)
4909 zsl->level--;
4910 zsl->length--;
4911 return 1;
4912 } else {
4913 return 0; /* not found */
e197b441 4914 }
4915 return 0; /* not found */
fd8ccf44 4916}
4917
1807985b 4918/* Delete all the elements with score between min and max from the skiplist.
4919 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
4920 * Note that this function takes the reference to the hash table view of the
4921 * sorted set, in order to remove the elements from the hash table too. */
4922static unsigned long zslDeleteRange(zskiplist *zsl, double min, double max, dict *dict) {
4923 zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;
4924 unsigned long removed = 0;
4925 int i;
4926
4927 x = zsl->header;
4928 for (i = zsl->level-1; i >= 0; i--) {
4929 while (x->forward[i] && x->forward[i]->score < min)
4930 x = x->forward[i];
4931 update[i] = x;
4932 }
4933 /* We may have multiple elements with the same score, what we need
4934 * is to find the element with both the right score and object. */
4935 x = x->forward[0];
4936 while (x && x->score <= max) {
4937 zskiplistNode *next;
4938
4939 for (i = 0; i < zsl->level; i++) {
4940 if (update[i]->forward[i] != x) break;
4941 update[i]->forward[i] = x->forward[i];
4942 }
4943 if (x->forward[0]) {
4944 x->forward[0]->backward = (x->backward == zsl->header) ?
4945 NULL : x->backward;
4946 } else {
4947 zsl->tail = x->backward;
4948 }
4949 next = x->forward[0];
4950 dictDelete(dict,x->obj);
4951 zslFreeNode(x);
4952 while(zsl->level > 1 && zsl->header->forward[zsl->level-1] == NULL)
4953 zsl->level--;
4954 zsl->length--;
4955 removed++;
4956 x = next;
4957 }
4958 return removed; /* not found */
4959}
4960
50c55df5 4961/* Find the first node having a score equal or greater than the specified one.
4962 * Returns NULL if there is no match. */
4963static zskiplistNode *zslFirstWithScore(zskiplist *zsl, double score) {
4964 zskiplistNode *x;
4965 int i;
4966
4967 x = zsl->header;
4968 for (i = zsl->level-1; i >= 0; i--) {
4969 while (x->forward[i] && x->forward[i]->score < score)
4970 x = x->forward[i];
4971 }
4972 /* We may have multiple elements with the same score, what we need
4973 * is to find the element with both the right score and object. */
4974 return x->forward[0];
4975}
4976
fd8ccf44 4977/* The actual Z-commands implementations */
4978
7db723ad 4979/* This generic command implements both ZADD and ZINCRBY.
e2665397 4980 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
7db723ad 4981 * the increment if the operation is a ZINCRBY (doincrement == 1). */
e2665397 4982static void zaddGenericCommand(redisClient *c, robj *key, robj *ele, double scoreval, int doincrement) {
fd8ccf44 4983 robj *zsetobj;
4984 zset *zs;
4985 double *score;
4986
e2665397 4987 zsetobj = lookupKeyWrite(c->db,key);
fd8ccf44 4988 if (zsetobj == NULL) {
4989 zsetobj = createZsetObject();
e2665397 4990 dictAdd(c->db->dict,key,zsetobj);
4991 incrRefCount(key);
fd8ccf44 4992 } else {
4993 if (zsetobj->type != REDIS_ZSET) {
4994 addReply(c,shared.wrongtypeerr);
4995 return;
4996 }
4997 }
fd8ccf44 4998 zs = zsetobj->ptr;
e2665397 4999
7db723ad 5000 /* Ok now since we implement both ZADD and ZINCRBY here the code
e2665397 5001 * needs to handle the two different conditions. It's all about setting
5002 * '*score', that is, the new score to set, to the right value. */
5003 score = zmalloc(sizeof(double));
5004 if (doincrement) {
5005 dictEntry *de;
5006
5007 /* Read the old score. If the element was not present starts from 0 */
5008 de = dictFind(zs->dict,ele);
5009 if (de) {
5010 double *oldscore = dictGetEntryVal(de);
5011 *score = *oldscore + scoreval;
5012 } else {
5013 *score = scoreval;
5014 }
5015 } else {
5016 *score = scoreval;
5017 }
5018
5019 /* What follows is a simple remove and re-insert operation that is common
7db723ad 5020 * to both ZADD and ZINCRBY... */
e2665397 5021 if (dictAdd(zs->dict,ele,score) == DICT_OK) {
fd8ccf44 5022 /* case 1: New element */
e2665397 5023 incrRefCount(ele); /* added to hash */
5024 zslInsert(zs->zsl,*score,ele);
5025 incrRefCount(ele); /* added to skiplist */
fd8ccf44 5026 server.dirty++;
e2665397 5027 if (doincrement)
e2665397 5028 addReplyDouble(c,*score);
91d71bfc 5029 else
5030 addReply(c,shared.cone);
fd8ccf44 5031 } else {
5032 dictEntry *de;
5033 double *oldscore;
5034
5035 /* case 2: Score update operation */
e2665397 5036 de = dictFind(zs->dict,ele);
dfc5e96c 5037 redisAssert(de != NULL);
fd8ccf44 5038 oldscore = dictGetEntryVal(de);
5039 if (*score != *oldscore) {
5040 int deleted;
5041
e2665397 5042 /* Remove and insert the element in the skip list with new score */
5043 deleted = zslDelete(zs->zsl,*oldscore,ele);
dfc5e96c 5044 redisAssert(deleted != 0);
e2665397 5045 zslInsert(zs->zsl,*score,ele);
5046 incrRefCount(ele);
5047 /* Update the score in the hash table */
5048 dictReplace(zs->dict,ele,score);
fd8ccf44 5049 server.dirty++;
2161a965 5050 } else {
5051 zfree(score);
fd8ccf44 5052 }
e2665397 5053 if (doincrement)
5054 addReplyDouble(c,*score);
5055 else
5056 addReply(c,shared.czero);
fd8ccf44 5057 }
5058}
5059
e2665397 5060static void zaddCommand(redisClient *c) {
5061 double scoreval;
5062
5063 scoreval = strtod(c->argv[2]->ptr,NULL);
5064 zaddGenericCommand(c,c->argv[1],c->argv[3],scoreval,0);
5065}
5066
7db723ad 5067static void zincrbyCommand(redisClient *c) {
e2665397 5068 double scoreval;
5069
5070 scoreval = strtod(c->argv[2]->ptr,NULL);
5071 zaddGenericCommand(c,c->argv[1],c->argv[3],scoreval,1);
5072}
5073
1b7106e7 5074static void zremCommand(redisClient *c) {
5075 robj *zsetobj;
5076 zset *zs;
5077
5078 zsetobj = lookupKeyWrite(c->db,c->argv[1]);
5079 if (zsetobj == NULL) {
5080 addReply(c,shared.czero);
5081 } else {
5082 dictEntry *de;
5083 double *oldscore;
5084 int deleted;
5085
5086 if (zsetobj->type != REDIS_ZSET) {
5087 addReply(c,shared.wrongtypeerr);
5088 return;
5089 }
5090 zs = zsetobj->ptr;
5091 de = dictFind(zs->dict,c->argv[2]);
5092 if (de == NULL) {
5093 addReply(c,shared.czero);
5094 return;
5095 }
5096 /* Delete from the skiplist */
5097 oldscore = dictGetEntryVal(de);
5098 deleted = zslDelete(zs->zsl,*oldscore,c->argv[2]);
dfc5e96c 5099 redisAssert(deleted != 0);
1b7106e7 5100
5101 /* Delete from the hash table */
5102 dictDelete(zs->dict,c->argv[2]);
5103 if (htNeedsResize(zs->dict)) dictResize(zs->dict);
5104 server.dirty++;
5105 addReply(c,shared.cone);
5106 }
5107}
5108
1807985b 5109static void zremrangebyscoreCommand(redisClient *c) {
5110 double min = strtod(c->argv[2]->ptr,NULL);
5111 double max = strtod(c->argv[3]->ptr,NULL);
5112 robj *zsetobj;
5113 zset *zs;
5114
5115 zsetobj = lookupKeyWrite(c->db,c->argv[1]);
5116 if (zsetobj == NULL) {
5117 addReply(c,shared.czero);
5118 } else {
5119 long deleted;
5120
5121 if (zsetobj->type != REDIS_ZSET) {
5122 addReply(c,shared.wrongtypeerr);
5123 return;
5124 }
5125 zs = zsetobj->ptr;
5126 deleted = zslDeleteRange(zs->zsl,min,max,zs->dict);
5127 if (htNeedsResize(zs->dict)) dictResize(zs->dict);
5128 server.dirty += deleted;
5129 addReplySds(c,sdscatprintf(sdsempty(),":%lu\r\n",deleted));
5130 }
5131}
5132
e3870fab 5133static void zrangeGenericCommand(redisClient *c, int reverse) {
cc812361 5134 robj *o;
5135 int start = atoi(c->argv[2]->ptr);
5136 int end = atoi(c->argv[3]->ptr);
752da584 5137 int withscores = 0;
5138
5139 if (c->argc == 5 && !strcasecmp(c->argv[4]->ptr,"withscores")) {
5140 withscores = 1;
5141 } else if (c->argc >= 5) {
5142 addReply(c,shared.syntaxerr);
5143 return;
5144 }
cc812361 5145
5146 o = lookupKeyRead(c->db,c->argv[1]);
5147 if (o == NULL) {
5148 addReply(c,shared.nullmultibulk);
5149 } else {
5150 if (o->type != REDIS_ZSET) {
5151 addReply(c,shared.wrongtypeerr);
5152 } else {
5153 zset *zsetobj = o->ptr;
5154 zskiplist *zsl = zsetobj->zsl;
5155 zskiplistNode *ln;
5156
5157 int llen = zsl->length;
5158 int rangelen, j;
5159 robj *ele;
5160
5161 /* convert negative indexes */
5162 if (start < 0) start = llen+start;
5163 if (end < 0) end = llen+end;
5164 if (start < 0) start = 0;
5165 if (end < 0) end = 0;
5166
5167 /* indexes sanity checks */
5168 if (start > end || start >= llen) {
5169 /* Out of range start or start > end result in empty list */
5170 addReply(c,shared.emptymultibulk);
5171 return;
5172 }
5173 if (end >= llen) end = llen-1;
5174 rangelen = (end-start)+1;
5175
5176 /* Return the result in form of a multi-bulk reply */
e3870fab 5177 if (reverse) {
5178 ln = zsl->tail;
5179 while (start--)
5180 ln = ln->backward;
5181 } else {
5182 ln = zsl->header->forward[0];
5183 while (start--)
5184 ln = ln->forward[0];
5185 }
cc812361 5186
752da584 5187 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",
5188 withscores ? (rangelen*2) : rangelen));
cc812361 5189 for (j = 0; j < rangelen; j++) {
0aad7a19 5190 ele = ln->obj;
cc812361 5191 addReplyBulkLen(c,ele);
5192 addReply(c,ele);
5193 addReply(c,shared.crlf);
752da584 5194 if (withscores)
5195 addReplyDouble(c,ln->score);
e3870fab 5196 ln = reverse ? ln->backward : ln->forward[0];
cc812361 5197 }
5198 }
5199 }
5200}
5201
e3870fab 5202static void zrangeCommand(redisClient *c) {
5203 zrangeGenericCommand(c,0);
5204}
5205
5206static void zrevrangeCommand(redisClient *c) {
5207 zrangeGenericCommand(c,1);
5208}
5209
f44dd428 5210/* This command implements both ZRANGEBYSCORE and ZCOUNT.
5211 * If justcount is non-zero, just the count is returned. */
5212static void genericZrangebyscoreCommand(redisClient *c, int justcount) {
50c55df5 5213 robj *o;
f44dd428 5214 double min, max;
5215 int minex = 0, maxex = 0; /* are min or max exclusive? */
80181f78 5216 int offset = 0, limit = -1;
0500ef27
SH
5217 int withscores = 0;
5218 int badsyntax = 0;
5219
f44dd428 5220 /* Parse the min-max interval. If one of the values is prefixed
5221 * by the "(" character, it's considered "open". For instance
5222 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
5223 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
5224 if (((char*)c->argv[2]->ptr)[0] == '(') {
5225 min = strtod((char*)c->argv[2]->ptr+1,NULL);
5226 minex = 1;
5227 } else {
5228 min = strtod(c->argv[2]->ptr,NULL);
5229 }
5230 if (((char*)c->argv[3]->ptr)[0] == '(') {
5231 max = strtod((char*)c->argv[3]->ptr+1,NULL);
5232 maxex = 1;
5233 } else {
5234 max = strtod(c->argv[3]->ptr,NULL);
5235 }
5236
5237 /* Parse "WITHSCORES": note that if the command was called with
5238 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
5239 * enter the following paths to parse WITHSCORES and LIMIT. */
0500ef27 5240 if (c->argc == 5 || c->argc == 8) {
3a3978b1 5241 if (strcasecmp(c->argv[c->argc-1]->ptr,"withscores") == 0)
5242 withscores = 1;
5243 else
5244 badsyntax = 1;
0500ef27 5245 }
3a3978b1 5246 if (c->argc != (4 + withscores) && c->argc != (7 + withscores))
0500ef27 5247 badsyntax = 1;
0500ef27 5248 if (badsyntax) {
454d4e43 5249 addReplySds(c,
5250 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
80181f78 5251 return;
0500ef27
SH
5252 }
5253
f44dd428 5254 /* Parse "LIMIT" */
0500ef27 5255 if (c->argc == (7 + withscores) && strcasecmp(c->argv[4]->ptr,"limit")) {
80181f78 5256 addReply(c,shared.syntaxerr);
5257 return;
0500ef27 5258 } else if (c->argc == (7 + withscores)) {
80181f78 5259 offset = atoi(c->argv[5]->ptr);
5260 limit = atoi(c->argv[6]->ptr);
0b13687c 5261 if (offset < 0) offset = 0;
80181f78 5262 }
50c55df5 5263
f44dd428 5264 /* Ok, lookup the key and get the range */
50c55df5 5265 o = lookupKeyRead(c->db,c->argv[1]);
5266 if (o == NULL) {
f44dd428 5267 addReply(c,justcount ? shared.czero : shared.nullmultibulk);
50c55df5 5268 } else {
5269 if (o->type != REDIS_ZSET) {
5270 addReply(c,shared.wrongtypeerr);
5271 } else {
5272 zset *zsetobj = o->ptr;
5273 zskiplist *zsl = zsetobj->zsl;
5274 zskiplistNode *ln;
f44dd428 5275 robj *ele, *lenobj = NULL;
5276 unsigned long rangelen = 0;
50c55df5 5277
f44dd428 5278 /* Get the first node with the score >= min, or with
5279 * score > min if 'minex' is true. */
50c55df5 5280 ln = zslFirstWithScore(zsl,min);
f44dd428 5281 while (minex && ln && ln->score == min) ln = ln->forward[0];
5282
50c55df5 5283 if (ln == NULL) {
5284 /* No element matching the speciifed interval */
f44dd428 5285 addReply(c,justcount ? shared.czero : shared.emptymultibulk);
50c55df5 5286 return;
5287 }
5288
5289 /* We don't know in advance how many matching elements there
5290 * are in the list, so we push this object that will represent
5291 * the multi-bulk length in the output buffer, and will "fix"
5292 * it later */
f44dd428 5293 if (!justcount) {
5294 lenobj = createObject(REDIS_STRING,NULL);
5295 addReply(c,lenobj);
5296 decrRefCount(lenobj);
5297 }
50c55df5 5298
f44dd428 5299 while(ln && (maxex ? (ln->score < max) : (ln->score <= max))) {
80181f78 5300 if (offset) {
5301 offset--;
5302 ln = ln->forward[0];
5303 continue;
5304 }
5305 if (limit == 0) break;
f44dd428 5306 if (!justcount) {
5307 ele = ln->obj;
5308 addReplyBulkLen(c,ele);
5309 addReply(c,ele);
5310 addReply(c,shared.crlf);
5311 if (withscores)
5312 addReplyDouble(c,ln->score);
5313 }
50c55df5 5314 ln = ln->forward[0];
5315 rangelen++;
80181f78 5316 if (limit > 0) limit--;
50c55df5 5317 }
f44dd428 5318 if (justcount) {
5319 addReplyLong(c,(long)rangelen);
5320 } else {
5321 lenobj->ptr = sdscatprintf(sdsempty(),"*%lu\r\n",
5322 withscores ? (rangelen*2) : rangelen);
5323 }
50c55df5 5324 }
5325 }
5326}
5327
f44dd428 5328static void zrangebyscoreCommand(redisClient *c) {
5329 genericZrangebyscoreCommand(c,0);
5330}
5331
5332static void zcountCommand(redisClient *c) {
5333 genericZrangebyscoreCommand(c,1);
5334}
5335
3c41331e 5336static void zcardCommand(redisClient *c) {
e197b441 5337 robj *o;
5338 zset *zs;
5339
5340 o = lookupKeyRead(c->db,c->argv[1]);
5341 if (o == NULL) {
5342 addReply(c,shared.czero);
5343 return;
5344 } else {
5345 if (o->type != REDIS_ZSET) {
5346 addReply(c,shared.wrongtypeerr);
5347 } else {
5348 zs = o->ptr;
682ac724 5349 addReplySds(c,sdscatprintf(sdsempty(),":%lu\r\n",zs->zsl->length));
e197b441 5350 }
5351 }
5352}
5353
6e333bbe 5354static void zscoreCommand(redisClient *c) {
5355 robj *o;
5356 zset *zs;
5357
5358 o = lookupKeyRead(c->db,c->argv[1]);
5359 if (o == NULL) {
96d8b4ee 5360 addReply(c,shared.nullbulk);
6e333bbe 5361 return;
5362 } else {
5363 if (o->type != REDIS_ZSET) {
5364 addReply(c,shared.wrongtypeerr);
5365 } else {
5366 dictEntry *de;
5367
5368 zs = o->ptr;
5369 de = dictFind(zs->dict,c->argv[2]);
5370 if (!de) {
5371 addReply(c,shared.nullbulk);
5372 } else {
6e333bbe 5373 double *score = dictGetEntryVal(de);
5374
e2665397 5375 addReplyDouble(c,*score);
6e333bbe 5376 }
5377 }
5378 }
5379}
5380
6b47e12e 5381/* ========================= Non type-specific commands ==================== */
5382
ed9b544e 5383static void flushdbCommand(redisClient *c) {
ca37e9cd 5384 server.dirty += dictSize(c->db->dict);
3305306f 5385 dictEmpty(c->db->dict);
5386 dictEmpty(c->db->expires);
ed9b544e 5387 addReply(c,shared.ok);
ed9b544e 5388}
5389
5390static void flushallCommand(redisClient *c) {
ca37e9cd 5391 server.dirty += emptyDb();
ed9b544e 5392 addReply(c,shared.ok);
f78fd11b 5393 rdbSave(server.dbfilename);
ca37e9cd 5394 server.dirty++;
ed9b544e 5395}
5396
56906eef 5397static redisSortOperation *createSortOperation(int type, robj *pattern) {
ed9b544e 5398 redisSortOperation *so = zmalloc(sizeof(*so));
ed9b544e 5399 so->type = type;
5400 so->pattern = pattern;
5401 return so;
5402}
5403
5404/* Return the value associated to the key with a name obtained
5405 * substituting the first occurence of '*' in 'pattern' with 'subst' */
56906eef 5406static robj *lookupKeyByPattern(redisDb *db, robj *pattern, robj *subst) {
ed9b544e 5407 char *p;
5408 sds spat, ssub;
5409 robj keyobj;
5410 int prefixlen, sublen, postfixlen;
ed9b544e 5411 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
5412 struct {
f1017b3f 5413 long len;
5414 long free;
ed9b544e 5415 char buf[REDIS_SORTKEY_MAX+1];
5416 } keyname;
5417
28173a49 5418 /* If the pattern is "#" return the substitution object itself in order
5419 * to implement the "SORT ... GET #" feature. */
5420 spat = pattern->ptr;
5421 if (spat[0] == '#' && spat[1] == '\0') {
5422 return subst;
5423 }
5424
5425 /* The substitution object may be specially encoded. If so we create
9d65a1bb 5426 * a decoded object on the fly. Otherwise getDecodedObject will just
5427 * increment the ref count, that we'll decrement later. */
5428 subst = getDecodedObject(subst);
942a3961 5429
ed9b544e 5430 ssub = subst->ptr;
5431 if (sdslen(spat)+sdslen(ssub)-1 > REDIS_SORTKEY_MAX) return NULL;
5432 p = strchr(spat,'*');
ed5a857a 5433 if (!p) {
5434 decrRefCount(subst);
5435 return NULL;
5436 }
ed9b544e 5437
5438 prefixlen = p-spat;
5439 sublen = sdslen(ssub);
5440 postfixlen = sdslen(spat)-(prefixlen+1);
5441 memcpy(keyname.buf,spat,prefixlen);
5442 memcpy(keyname.buf+prefixlen,ssub,sublen);
5443 memcpy(keyname.buf+prefixlen+sublen,p+1,postfixlen);
5444 keyname.buf[prefixlen+sublen+postfixlen] = '\0';
5445 keyname.len = prefixlen+sublen+postfixlen;
5446
dfc5e96c 5447 initStaticStringObject(keyobj,((char*)&keyname)+(sizeof(long)*2))
942a3961 5448 decrRefCount(subst);
5449
a4d1ba9a 5450 /* printf("lookup '%s' => %p\n", keyname.buf,de); */
3305306f 5451 return lookupKeyRead(db,&keyobj);
ed9b544e 5452}
5453
5454/* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
5455 * the additional parameter is not standard but a BSD-specific we have to
5456 * pass sorting parameters via the global 'server' structure */
5457static int sortCompare(const void *s1, const void *s2) {
5458 const redisSortObject *so1 = s1, *so2 = s2;
5459 int cmp;
5460
5461 if (!server.sort_alpha) {
5462 /* Numeric sorting. Here it's trivial as we precomputed scores */
5463 if (so1->u.score > so2->u.score) {
5464 cmp = 1;
5465 } else if (so1->u.score < so2->u.score) {
5466 cmp = -1;
5467 } else {
5468 cmp = 0;
5469 }
5470 } else {
5471 /* Alphanumeric sorting */
5472 if (server.sort_bypattern) {
5473 if (!so1->u.cmpobj || !so2->u.cmpobj) {
5474 /* At least one compare object is NULL */
5475 if (so1->u.cmpobj == so2->u.cmpobj)
5476 cmp = 0;
5477 else if (so1->u.cmpobj == NULL)
5478 cmp = -1;
5479 else
5480 cmp = 1;
5481 } else {
5482 /* We have both the objects, use strcoll */
5483 cmp = strcoll(so1->u.cmpobj->ptr,so2->u.cmpobj->ptr);
5484 }
5485 } else {
5486 /* Compare elements directly */
9d65a1bb 5487 robj *dec1, *dec2;
5488
5489 dec1 = getDecodedObject(so1->obj);
5490 dec2 = getDecodedObject(so2->obj);
5491 cmp = strcoll(dec1->ptr,dec2->ptr);
5492 decrRefCount(dec1);
5493 decrRefCount(dec2);
ed9b544e 5494 }
5495 }
5496 return server.sort_desc ? -cmp : cmp;
5497}
5498
5499/* The SORT command is the most complex command in Redis. Warning: this code
5500 * is optimized for speed and a bit less for readability */
5501static void sortCommand(redisClient *c) {
ed9b544e 5502 list *operations;
5503 int outputlen = 0;
5504 int desc = 0, alpha = 0;
5505 int limit_start = 0, limit_count = -1, start, end;
5506 int j, dontsort = 0, vectorlen;
5507 int getop = 0; /* GET operation counter */
443c6409 5508 robj *sortval, *sortby = NULL, *storekey = NULL;
ed9b544e 5509 redisSortObject *vector; /* Resulting vector to sort */
5510
5511 /* Lookup the key to sort. It must be of the right types */
3305306f 5512 sortval = lookupKeyRead(c->db,c->argv[1]);
5513 if (sortval == NULL) {
d922ae65 5514 addReply(c,shared.nullmultibulk);
ed9b544e 5515 return;
5516 }
a5eb649b 5517 if (sortval->type != REDIS_SET && sortval->type != REDIS_LIST &&
5518 sortval->type != REDIS_ZSET)
5519 {
c937aa89 5520 addReply(c,shared.wrongtypeerr);
ed9b544e 5521 return;
5522 }
5523
5524 /* Create a list of operations to perform for every sorted element.
5525 * Operations can be GET/DEL/INCR/DECR */
5526 operations = listCreate();
092dac2a 5527 listSetFreeMethod(operations,zfree);
ed9b544e 5528 j = 2;
5529
5530 /* Now we need to protect sortval incrementing its count, in the future
5531 * SORT may have options able to overwrite/delete keys during the sorting
5532 * and the sorted key itself may get destroied */
5533 incrRefCount(sortval);
5534
5535 /* The SORT command has an SQL-alike syntax, parse it */
5536 while(j < c->argc) {
5537 int leftargs = c->argc-j-1;
5538 if (!strcasecmp(c->argv[j]->ptr,"asc")) {
5539 desc = 0;
5540 } else if (!strcasecmp(c->argv[j]->ptr,"desc")) {
5541 desc = 1;
5542 } else if (!strcasecmp(c->argv[j]->ptr,"alpha")) {
5543 alpha = 1;
5544 } else if (!strcasecmp(c->argv[j]->ptr,"limit") && leftargs >= 2) {
5545 limit_start = atoi(c->argv[j+1]->ptr);
5546 limit_count = atoi(c->argv[j+2]->ptr);
5547 j+=2;
443c6409 5548 } else if (!strcasecmp(c->argv[j]->ptr,"store") && leftargs >= 1) {
5549 storekey = c->argv[j+1];
5550 j++;
ed9b544e 5551 } else if (!strcasecmp(c->argv[j]->ptr,"by") && leftargs >= 1) {
5552 sortby = c->argv[j+1];
5553 /* If the BY pattern does not contain '*', i.e. it is constant,
5554 * we don't need to sort nor to lookup the weight keys. */
5555 if (strchr(c->argv[j+1]->ptr,'*') == NULL) dontsort = 1;
5556 j++;
5557 } else if (!strcasecmp(c->argv[j]->ptr,"get") && leftargs >= 1) {
5558 listAddNodeTail(operations,createSortOperation(
5559 REDIS_SORT_GET,c->argv[j+1]));
5560 getop++;
5561 j++;
ed9b544e 5562 } else {
5563 decrRefCount(sortval);
5564 listRelease(operations);
c937aa89 5565 addReply(c,shared.syntaxerr);
ed9b544e 5566 return;
5567 }
5568 j++;
5569 }
5570
5571 /* Load the sorting vector with all the objects to sort */
a5eb649b 5572 switch(sortval->type) {
5573 case REDIS_LIST: vectorlen = listLength((list*)sortval->ptr); break;
5574 case REDIS_SET: vectorlen = dictSize((dict*)sortval->ptr); break;
5575 case REDIS_ZSET: vectorlen = dictSize(((zset*)sortval->ptr)->dict); break;
dfc5e96c 5576 default: vectorlen = 0; redisAssert(0); /* Avoid GCC warning */
a5eb649b 5577 }
ed9b544e 5578 vector = zmalloc(sizeof(redisSortObject)*vectorlen);
ed9b544e 5579 j = 0;
a5eb649b 5580
ed9b544e 5581 if (sortval->type == REDIS_LIST) {
5582 list *list = sortval->ptr;
6208b3a7 5583 listNode *ln;
c7df85a4 5584 listIter li;
6208b3a7 5585
c7df85a4 5586 listRewind(list,&li);
5587 while((ln = listNext(&li))) {
ed9b544e 5588 robj *ele = ln->value;
5589 vector[j].obj = ele;
5590 vector[j].u.score = 0;
5591 vector[j].u.cmpobj = NULL;
ed9b544e 5592 j++;
5593 }
5594 } else {
a5eb649b 5595 dict *set;
ed9b544e 5596 dictIterator *di;
5597 dictEntry *setele;
5598
a5eb649b 5599 if (sortval->type == REDIS_SET) {
5600 set = sortval->ptr;
5601 } else {
5602 zset *zs = sortval->ptr;
5603 set = zs->dict;
5604 }
5605
ed9b544e 5606 di = dictGetIterator(set);
ed9b544e 5607 while((setele = dictNext(di)) != NULL) {
5608 vector[j].obj = dictGetEntryKey(setele);
5609 vector[j].u.score = 0;
5610 vector[j].u.cmpobj = NULL;
5611 j++;
5612 }
5613 dictReleaseIterator(di);
5614 }
dfc5e96c 5615 redisAssert(j == vectorlen);
ed9b544e 5616
5617 /* Now it's time to load the right scores in the sorting vector */
5618 if (dontsort == 0) {
5619 for (j = 0; j < vectorlen; j++) {
5620 if (sortby) {
5621 robj *byval;
5622
3305306f 5623 byval = lookupKeyByPattern(c->db,sortby,vector[j].obj);
ed9b544e 5624 if (!byval || byval->type != REDIS_STRING) continue;
5625 if (alpha) {
9d65a1bb 5626 vector[j].u.cmpobj = getDecodedObject(byval);
ed9b544e 5627 } else {
942a3961 5628 if (byval->encoding == REDIS_ENCODING_RAW) {
5629 vector[j].u.score = strtod(byval->ptr,NULL);
5630 } else {
9d65a1bb 5631 /* Don't need to decode the object if it's
5632 * integer-encoded (the only encoding supported) so
5633 * far. We can just cast it */
f1017b3f 5634 if (byval->encoding == REDIS_ENCODING_INT) {
942a3961 5635 vector[j].u.score = (long)byval->ptr;
f1017b3f 5636 } else
dfc5e96c 5637 redisAssert(1 != 1);
942a3961 5638 }
ed9b544e 5639 }
5640 } else {
942a3961 5641 if (!alpha) {
5642 if (vector[j].obj->encoding == REDIS_ENCODING_RAW)
5643 vector[j].u.score = strtod(vector[j].obj->ptr,NULL);
5644 else {
5645 if (vector[j].obj->encoding == REDIS_ENCODING_INT)
5646 vector[j].u.score = (long) vector[j].obj->ptr;
5647 else
dfc5e96c 5648 redisAssert(1 != 1);
942a3961 5649 }
5650 }
ed9b544e 5651 }
5652 }
5653 }
5654
5655 /* We are ready to sort the vector... perform a bit of sanity check
5656 * on the LIMIT option too. We'll use a partial version of quicksort. */
5657 start = (limit_start < 0) ? 0 : limit_start;
5658 end = (limit_count < 0) ? vectorlen-1 : start+limit_count-1;
5659 if (start >= vectorlen) {
5660 start = vectorlen-1;
5661 end = vectorlen-2;
5662 }
5663 if (end >= vectorlen) end = vectorlen-1;
5664
5665 if (dontsort == 0) {
5666 server.sort_desc = desc;
5667 server.sort_alpha = alpha;
5668 server.sort_bypattern = sortby ? 1 : 0;
5f5b9840 5669 if (sortby && (start != 0 || end != vectorlen-1))
5670 pqsort(vector,vectorlen,sizeof(redisSortObject),sortCompare, start,end);
5671 else
5672 qsort(vector,vectorlen,sizeof(redisSortObject),sortCompare);
ed9b544e 5673 }
5674
5675 /* Send command output to the output buffer, performing the specified
5676 * GET/DEL/INCR/DECR operations if any. */
5677 outputlen = getop ? getop*(end-start+1) : end-start+1;
443c6409 5678 if (storekey == NULL) {
5679 /* STORE option not specified, sent the sorting result to client */
5680 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",outputlen));
5681 for (j = start; j <= end; j++) {
5682 listNode *ln;
c7df85a4 5683 listIter li;
5684
443c6409 5685 if (!getop) {
5686 addReplyBulkLen(c,vector[j].obj);
5687 addReply(c,vector[j].obj);
5688 addReply(c,shared.crlf);
5689 }
c7df85a4 5690 listRewind(operations,&li);
5691 while((ln = listNext(&li))) {
443c6409 5692 redisSortOperation *sop = ln->value;
5693 robj *val = lookupKeyByPattern(c->db,sop->pattern,
5694 vector[j].obj);
5695
5696 if (sop->type == REDIS_SORT_GET) {
5697 if (!val || val->type != REDIS_STRING) {
5698 addReply(c,shared.nullbulk);
5699 } else {
5700 addReplyBulkLen(c,val);
5701 addReply(c,val);
5702 addReply(c,shared.crlf);
5703 }
5704 } else {
dfc5e96c 5705 redisAssert(sop->type == REDIS_SORT_GET); /* always fails */
443c6409 5706 }
5707 }
ed9b544e 5708 }
443c6409 5709 } else {
5710 robj *listObject = createListObject();
5711 list *listPtr = (list*) listObject->ptr;
5712
5713 /* STORE option specified, set the sorting result as a List object */
5714 for (j = start; j <= end; j++) {
5715 listNode *ln;
c7df85a4 5716 listIter li;
5717
443c6409 5718 if (!getop) {
5719 listAddNodeTail(listPtr,vector[j].obj);
5720 incrRefCount(vector[j].obj);
5721 }
c7df85a4 5722 listRewind(operations,&li);
5723 while((ln = listNext(&li))) {
443c6409 5724 redisSortOperation *sop = ln->value;
5725 robj *val = lookupKeyByPattern(c->db,sop->pattern,
5726 vector[j].obj);
5727
5728 if (sop->type == REDIS_SORT_GET) {
5729 if (!val || val->type != REDIS_STRING) {
5730 listAddNodeTail(listPtr,createStringObject("",0));
5731 } else {
5732 listAddNodeTail(listPtr,val);
5733 incrRefCount(val);
5734 }
ed9b544e 5735 } else {
dfc5e96c 5736 redisAssert(sop->type == REDIS_SORT_GET); /* always fails */
ed9b544e 5737 }
ed9b544e 5738 }
ed9b544e 5739 }
121796f7 5740 if (dictReplace(c->db->dict,storekey,listObject)) {
5741 incrRefCount(storekey);
5742 }
443c6409 5743 /* Note: we add 1 because the DB is dirty anyway since even if the
5744 * SORT result is empty a new key is set and maybe the old content
5745 * replaced. */
5746 server.dirty += 1+outputlen;
5747 addReplySds(c,sdscatprintf(sdsempty(),":%d\r\n",outputlen));
ed9b544e 5748 }
5749
5750 /* Cleanup */
5751 decrRefCount(sortval);
5752 listRelease(operations);
5753 for (j = 0; j < vectorlen; j++) {
5754 if (sortby && alpha && vector[j].u.cmpobj)
5755 decrRefCount(vector[j].u.cmpobj);
5756 }
5757 zfree(vector);
5758}
5759
ec6c7a1d 5760/* Convert an amount of bytes into a human readable string in the form
5761 * of 100B, 2G, 100M, 4K, and so forth. */
5762static void bytesToHuman(char *s, unsigned long long n) {
5763 double d;
5764
5765 if (n < 1024) {
5766 /* Bytes */
5767 sprintf(s,"%lluB",n);
5768 return;
5769 } else if (n < (1024*1024)) {
5770 d = (double)n/(1024);
5771 sprintf(s,"%.2fK",d);
5772 } else if (n < (1024LL*1024*1024)) {
5773 d = (double)n/(1024*1024);
5774 sprintf(s,"%.2fM",d);
5775 } else if (n < (1024LL*1024*1024*1024)) {
5776 d = (double)n/(1024LL*1024*1024);
b72f6a4b 5777 sprintf(s,"%.2fG",d);
ec6c7a1d 5778 }
5779}
5780
1c85b79f 5781/* Create the string returned by the INFO command. This is decoupled
5782 * by the INFO command itself as we need to report the same information
5783 * on memory corruption problems. */
5784static sds genRedisInfoString(void) {
ed9b544e 5785 sds info;
5786 time_t uptime = time(NULL)-server.stat_starttime;
c3cb078d 5787 int j;
ec6c7a1d 5788 char hmem[64];
5789
b72f6a4b 5790 bytesToHuman(hmem,zmalloc_used_memory());
ed9b544e 5791 info = sdscatprintf(sdsempty(),
5792 "redis_version:%s\r\n"
f1017b3f 5793 "arch_bits:%s\r\n"
7a932b74 5794 "multiplexing_api:%s\r\n"
0d7170a4 5795 "process_id:%ld\r\n"
682ac724 5796 "uptime_in_seconds:%ld\r\n"
5797 "uptime_in_days:%ld\r\n"
ed9b544e 5798 "connected_clients:%d\r\n"
5799 "connected_slaves:%d\r\n"
f86a74e9 5800 "blocked_clients:%d\r\n"
5fba9f71 5801 "used_memory:%zu\r\n"
ec6c7a1d 5802 "used_memory_human:%s\r\n"
ed9b544e 5803 "changes_since_last_save:%lld\r\n"
be2bb6b0 5804 "bgsave_in_progress:%d\r\n"
682ac724 5805 "last_save_time:%ld\r\n"
b3fad521 5806 "bgrewriteaof_in_progress:%d\r\n"
ed9b544e 5807 "total_connections_received:%lld\r\n"
5808 "total_commands_processed:%lld\r\n"
7d98e08c 5809 "vm_enabled:%d\r\n"
a0f643ea 5810 "role:%s\r\n"
ed9b544e 5811 ,REDIS_VERSION,
f1017b3f 5812 (sizeof(long) == 8) ? "64" : "32",
7a932b74 5813 aeGetApiName(),
0d7170a4 5814 (long) getpid(),
a0f643ea 5815 uptime,
5816 uptime/(3600*24),
ed9b544e 5817 listLength(server.clients)-listLength(server.slaves),
5818 listLength(server.slaves),
d5d55fc3 5819 server.blpop_blocked_clients,
b72f6a4b 5820 zmalloc_used_memory(),
ec6c7a1d 5821 hmem,
ed9b544e 5822 server.dirty,
9d65a1bb 5823 server.bgsavechildpid != -1,
ed9b544e 5824 server.lastsave,
b3fad521 5825 server.bgrewritechildpid != -1,
ed9b544e 5826 server.stat_numconnections,
5827 server.stat_numcommands,
7d98e08c 5828 server.vm_enabled != 0,
a0f643ea 5829 server.masterhost == NULL ? "master" : "slave"
ed9b544e 5830 );
a0f643ea 5831 if (server.masterhost) {
5832 info = sdscatprintf(info,
5833 "master_host:%s\r\n"
5834 "master_port:%d\r\n"
5835 "master_link_status:%s\r\n"
5836 "master_last_io_seconds_ago:%d\r\n"
5837 ,server.masterhost,
5838 server.masterport,
5839 (server.replstate == REDIS_REPL_CONNECTED) ?
5840 "up" : "down",
f72b934d 5841 server.master ? ((int)(time(NULL)-server.master->lastinteraction)) : -1
a0f643ea 5842 );
5843 }
7d98e08c 5844 if (server.vm_enabled) {
1064ef87 5845 lockThreadedIO();
7d98e08c 5846 info = sdscatprintf(info,
5847 "vm_conf_max_memory:%llu\r\n"
5848 "vm_conf_page_size:%llu\r\n"
5849 "vm_conf_pages:%llu\r\n"
5850 "vm_stats_used_pages:%llu\r\n"
5851 "vm_stats_swapped_objects:%llu\r\n"
5852 "vm_stats_swappin_count:%llu\r\n"
5853 "vm_stats_swappout_count:%llu\r\n"
b9bc0eef 5854 "vm_stats_io_newjobs_len:%lu\r\n"
5855 "vm_stats_io_processing_len:%lu\r\n"
5856 "vm_stats_io_processed_len:%lu\r\n"
25fd2cb2 5857 "vm_stats_io_active_threads:%lu\r\n"
d5d55fc3 5858 "vm_stats_blocked_clients:%lu\r\n"
7d98e08c 5859 ,(unsigned long long) server.vm_max_memory,
5860 (unsigned long long) server.vm_page_size,
5861 (unsigned long long) server.vm_pages,
5862 (unsigned long long) server.vm_stats_used_pages,
5863 (unsigned long long) server.vm_stats_swapped_objects,
5864 (unsigned long long) server.vm_stats_swapins,
b9bc0eef 5865 (unsigned long long) server.vm_stats_swapouts,
5866 (unsigned long) listLength(server.io_newjobs),
5867 (unsigned long) listLength(server.io_processing),
5868 (unsigned long) listLength(server.io_processed),
d5d55fc3 5869 (unsigned long) server.io_active_threads,
5870 (unsigned long) server.vm_blocked_clients
7d98e08c 5871 );
1064ef87 5872 unlockThreadedIO();
7d98e08c 5873 }
c3cb078d 5874 for (j = 0; j < server.dbnum; j++) {
5875 long long keys, vkeys;
5876
5877 keys = dictSize(server.db[j].dict);
5878 vkeys = dictSize(server.db[j].expires);
5879 if (keys || vkeys) {
9d65a1bb 5880 info = sdscatprintf(info, "db%d:keys=%lld,expires=%lld\r\n",
c3cb078d 5881 j, keys, vkeys);
5882 }
5883 }
1c85b79f 5884 return info;
5885}
5886
5887static void infoCommand(redisClient *c) {
5888 sds info = genRedisInfoString();
83c6a618 5889 addReplySds(c,sdscatprintf(sdsempty(),"$%lu\r\n",
5890 (unsigned long)sdslen(info)));
ed9b544e 5891 addReplySds(c,info);
70003d28 5892 addReply(c,shared.crlf);
ed9b544e 5893}
5894
3305306f 5895static void monitorCommand(redisClient *c) {
5896 /* ignore MONITOR if aleady slave or in monitor mode */
5897 if (c->flags & REDIS_SLAVE) return;
5898
5899 c->flags |= (REDIS_SLAVE|REDIS_MONITOR);
5900 c->slaveseldb = 0;
6b47e12e 5901 listAddNodeTail(server.monitors,c);
3305306f 5902 addReply(c,shared.ok);
5903}
5904
5905/* ================================= Expire ================================= */
5906static int removeExpire(redisDb *db, robj *key) {
5907 if (dictDelete(db->expires,key) == DICT_OK) {
5908 return 1;
5909 } else {
5910 return 0;
5911 }
5912}
5913
5914static int setExpire(redisDb *db, robj *key, time_t when) {
5915 if (dictAdd(db->expires,key,(void*)when) == DICT_ERR) {
5916 return 0;
5917 } else {
5918 incrRefCount(key);
5919 return 1;
5920 }
5921}
5922
bb32ede5 5923/* Return the expire time of the specified key, or -1 if no expire
5924 * is associated with this key (i.e. the key is non volatile) */
5925static time_t getExpire(redisDb *db, robj *key) {
5926 dictEntry *de;
5927
5928 /* No expire? return ASAP */
5929 if (dictSize(db->expires) == 0 ||
5930 (de = dictFind(db->expires,key)) == NULL) return -1;
5931
5932 return (time_t) dictGetEntryVal(de);
5933}
5934
3305306f 5935static int expireIfNeeded(redisDb *db, robj *key) {
5936 time_t when;
5937 dictEntry *de;
5938
5939 /* No expire? return ASAP */
5940 if (dictSize(db->expires) == 0 ||
5941 (de = dictFind(db->expires,key)) == NULL) return 0;
5942
5943 /* Lookup the expire */
5944 when = (time_t) dictGetEntryVal(de);
5945 if (time(NULL) <= when) return 0;
5946
5947 /* Delete the key */
5948 dictDelete(db->expires,key);
5949 return dictDelete(db->dict,key) == DICT_OK;
5950}
5951
5952static int deleteIfVolatile(redisDb *db, robj *key) {
5953 dictEntry *de;
5954
5955 /* No expire? return ASAP */
5956 if (dictSize(db->expires) == 0 ||
5957 (de = dictFind(db->expires,key)) == NULL) return 0;
5958
5959 /* Delete the key */
0c66a471 5960 server.dirty++;
3305306f 5961 dictDelete(db->expires,key);
5962 return dictDelete(db->dict,key) == DICT_OK;
5963}
5964
802e8373 5965static void expireGenericCommand(redisClient *c, robj *key, time_t seconds) {
3305306f 5966 dictEntry *de;
3305306f 5967
802e8373 5968 de = dictFind(c->db->dict,key);
3305306f 5969 if (de == NULL) {
5970 addReply(c,shared.czero);
5971 return;
5972 }
43e5ccdf 5973 if (seconds < 0) {
5974 if (deleteKey(c->db,key)) server.dirty++;
5975 addReply(c, shared.cone);
3305306f 5976 return;
5977 } else {
5978 time_t when = time(NULL)+seconds;
802e8373 5979 if (setExpire(c->db,key,when)) {
3305306f 5980 addReply(c,shared.cone);
77423026 5981 server.dirty++;
5982 } else {
3305306f 5983 addReply(c,shared.czero);
77423026 5984 }
3305306f 5985 return;
5986 }
5987}
5988
802e8373 5989static void expireCommand(redisClient *c) {
5990 expireGenericCommand(c,c->argv[1],strtol(c->argv[2]->ptr,NULL,10));
5991}
5992
5993static void expireatCommand(redisClient *c) {
5994 expireGenericCommand(c,c->argv[1],strtol(c->argv[2]->ptr,NULL,10)-time(NULL));
5995}
5996
fd88489a 5997static void ttlCommand(redisClient *c) {
5998 time_t expire;
5999 int ttl = -1;
6000
6001 expire = getExpire(c->db,c->argv[1]);
6002 if (expire != -1) {
6003 ttl = (int) (expire-time(NULL));
6004 if (ttl < 0) ttl = -1;
6005 }
6006 addReplySds(c,sdscatprintf(sdsempty(),":%d\r\n",ttl));
6007}
6008
6e469882 6009/* ================================ MULTI/EXEC ============================== */
6010
6011/* Client state initialization for MULTI/EXEC */
6012static void initClientMultiState(redisClient *c) {
6013 c->mstate.commands = NULL;
6014 c->mstate.count = 0;
6015}
6016
6017/* Release all the resources associated with MULTI/EXEC state */
6018static void freeClientMultiState(redisClient *c) {
6019 int j;
6020
6021 for (j = 0; j < c->mstate.count; j++) {
6022 int i;
6023 multiCmd *mc = c->mstate.commands+j;
6024
6025 for (i = 0; i < mc->argc; i++)
6026 decrRefCount(mc->argv[i]);
6027 zfree(mc->argv);
6028 }
6029 zfree(c->mstate.commands);
6030}
6031
6032/* Add a new command into the MULTI commands queue */
6033static void queueMultiCommand(redisClient *c, struct redisCommand *cmd) {
6034 multiCmd *mc;
6035 int j;
6036
6037 c->mstate.commands = zrealloc(c->mstate.commands,
6038 sizeof(multiCmd)*(c->mstate.count+1));
6039 mc = c->mstate.commands+c->mstate.count;
6040 mc->cmd = cmd;
6041 mc->argc = c->argc;
6042 mc->argv = zmalloc(sizeof(robj*)*c->argc);
6043 memcpy(mc->argv,c->argv,sizeof(robj*)*c->argc);
6044 for (j = 0; j < c->argc; j++)
6045 incrRefCount(mc->argv[j]);
6046 c->mstate.count++;
6047}
6048
6049static void multiCommand(redisClient *c) {
6050 c->flags |= REDIS_MULTI;
36c548f0 6051 addReply(c,shared.ok);
6e469882 6052}
6053
6054static void execCommand(redisClient *c) {
6055 int j;
6056 robj **orig_argv;
6057 int orig_argc;
6058
6059 if (!(c->flags & REDIS_MULTI)) {
6060 addReplySds(c,sdsnew("-ERR EXEC without MULTI\r\n"));
6061 return;
6062 }
6063
6064 orig_argv = c->argv;
6065 orig_argc = c->argc;
6066 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",c->mstate.count));
6067 for (j = 0; j < c->mstate.count; j++) {
6068 c->argc = c->mstate.commands[j].argc;
6069 c->argv = c->mstate.commands[j].argv;
6070 call(c,c->mstate.commands[j].cmd);
6071 }
6072 c->argv = orig_argv;
6073 c->argc = orig_argc;
6074 freeClientMultiState(c);
6075 initClientMultiState(c);
6076 c->flags &= (~REDIS_MULTI);
6077}
6078
4409877e 6079/* =========================== Blocking Operations ========================= */
6080
6081/* Currently Redis blocking operations support is limited to list POP ops,
6082 * so the current implementation is not fully generic, but it is also not
6083 * completely specific so it will not require a rewrite to support new
6084 * kind of blocking operations in the future.
6085 *
6086 * Still it's important to note that list blocking operations can be already
6087 * used as a notification mechanism in order to implement other blocking
6088 * operations at application level, so there must be a very strong evidence
6089 * of usefulness and generality before new blocking operations are implemented.
6090 *
6091 * This is how the current blocking POP works, we use BLPOP as example:
6092 * - If the user calls BLPOP and the key exists and contains a non empty list
6093 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
6094 * if there is not to block.
6095 * - If instead BLPOP is called and the key does not exists or the list is
6096 * empty we need to block. In order to do so we remove the notification for
6097 * new data to read in the client socket (so that we'll not serve new
6098 * requests if the blocking request is not served). Also we put the client
95242ab5 6099 * in a dictionary (db->blockingkeys) mapping keys to a list of clients
4409877e 6100 * blocking for this keys.
6101 * - If a PUSH operation against a key with blocked clients waiting is
6102 * performed, we serve the first in the list: basically instead to push
6103 * the new element inside the list we return it to the (first / oldest)
6104 * blocking client, unblock the client, and remove it form the list.
6105 *
6106 * The above comment and the source code should be enough in order to understand
6107 * the implementation and modify / fix it later.
6108 */
6109
6110/* Set a client in blocking mode for the specified key, with the specified
6111 * timeout */
b177fd30 6112static void blockForKeys(redisClient *c, robj **keys, int numkeys, time_t timeout) {
4409877e 6113 dictEntry *de;
6114 list *l;
b177fd30 6115 int j;
4409877e 6116
b177fd30 6117 c->blockingkeys = zmalloc(sizeof(robj*)*numkeys);
6118 c->blockingkeysnum = numkeys;
4409877e 6119 c->blockingto = timeout;
b177fd30 6120 for (j = 0; j < numkeys; j++) {
6121 /* Add the key in the client structure, to map clients -> keys */
6122 c->blockingkeys[j] = keys[j];
6123 incrRefCount(keys[j]);
4409877e 6124
b177fd30 6125 /* And in the other "side", to map keys -> clients */
6126 de = dictFind(c->db->blockingkeys,keys[j]);
6127 if (de == NULL) {
6128 int retval;
6129
6130 /* For every key we take a list of clients blocked for it */
6131 l = listCreate();
6132 retval = dictAdd(c->db->blockingkeys,keys[j],l);
6133 incrRefCount(keys[j]);
6134 assert(retval == DICT_OK);
6135 } else {
6136 l = dictGetEntryVal(de);
6137 }
6138 listAddNodeTail(l,c);
4409877e 6139 }
b177fd30 6140 /* Mark the client as a blocked client */
4409877e 6141 c->flags |= REDIS_BLOCKED;
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--;
5921aa36 6169 /* We want to process data if there is some command waiting
b0d8747d 6170 * in the input buffer. Note that this is safe even if
6171 * unblockClientWaitingData() gets called from freeClient() because
6172 * freeClient() will be smart enough to call this function
6173 * *after* c->querybuf was set to NULL. */
4409877e 6174 if (c->querybuf && sdslen(c->querybuf) > 0) processInputBuffer(c);
6175}
6176
6177/* This should be called from any function PUSHing into lists.
6178 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
6179 * 'ele' is the element pushed.
6180 *
6181 * If the function returns 0 there was no client waiting for a list push
6182 * against this key.
6183 *
6184 * If the function returns 1 there was a client waiting for a list push
6185 * against this key, the element was passed to this client thus it's not
6186 * needed to actually add it to the list and the caller should return asap. */
6187static int handleClientsWaitingListPush(redisClient *c, robj *key, robj *ele) {
6188 struct dictEntry *de;
6189 redisClient *receiver;
6190 list *l;
6191 listNode *ln;
6192
6193 de = dictFind(c->db->blockingkeys,key);
6194 if (de == NULL) return 0;
6195 l = dictGetEntryVal(de);
6196 ln = listFirst(l);
6197 assert(ln != NULL);
6198 receiver = ln->value;
4409877e 6199
b177fd30 6200 addReplySds(receiver,sdsnew("*2\r\n"));
6201 addReplyBulkLen(receiver,key);
6202 addReply(receiver,key);
6203 addReply(receiver,shared.crlf);
4409877e 6204 addReplyBulkLen(receiver,ele);
6205 addReply(receiver,ele);
6206 addReply(receiver,shared.crlf);
b0d8747d 6207 unblockClientWaitingData(receiver);
4409877e 6208 return 1;
6209}
6210
6211/* Blocking RPOP/LPOP */
6212static void blockingPopGenericCommand(redisClient *c, int where) {
6213 robj *o;
6214 time_t timeout;
b177fd30 6215 int j;
4409877e 6216
b177fd30 6217 for (j = 1; j < c->argc-1; j++) {
6218 o = lookupKeyWrite(c->db,c->argv[j]);
6219 if (o != NULL) {
6220 if (o->type != REDIS_LIST) {
6221 addReply(c,shared.wrongtypeerr);
4409877e 6222 return;
b177fd30 6223 } else {
6224 list *list = o->ptr;
6225 if (listLength(list) != 0) {
6226 /* If the list contains elements fall back to the usual
6227 * non-blocking POP operation */
6228 robj *argv[2], **orig_argv;
6229 int orig_argc;
6230
6231 /* We need to alter the command arguments before to call
6232 * popGenericCommand() as the command takes a single key. */
6233 orig_argv = c->argv;
6234 orig_argc = c->argc;
6235 argv[1] = c->argv[j];
6236 c->argv = argv;
6237 c->argc = 2;
6238
6239 /* Also the return value is different, we need to output
6240 * the multi bulk reply header and the key name. The
6241 * "real" command will add the last element (the value)
6242 * for us. If this souds like an hack to you it's just
6243 * because it is... */
6244 addReplySds(c,sdsnew("*2\r\n"));
6245 addReplyBulkLen(c,argv[1]);
6246 addReply(c,argv[1]);
6247 addReply(c,shared.crlf);
6248 popGenericCommand(c,where);
6249
6250 /* Fix the client structure with the original stuff */
6251 c->argv = orig_argv;
6252 c->argc = orig_argc;
6253 return;
6254 }
4409877e 6255 }
6256 }
6257 }
6258 /* If the list is empty or the key does not exists we must block */
b177fd30 6259 timeout = strtol(c->argv[c->argc-1]->ptr,NULL,10);
4409877e 6260 if (timeout > 0) timeout += time(NULL);
b177fd30 6261 blockForKeys(c,c->argv+1,c->argc-2,timeout);
4409877e 6262}
6263
6264static void blpopCommand(redisClient *c) {
6265 blockingPopGenericCommand(c,REDIS_HEAD);
6266}
6267
6268static void brpopCommand(redisClient *c) {
6269 blockingPopGenericCommand(c,REDIS_TAIL);
6270}
6271
ed9b544e 6272/* =============================== Replication ============================= */
6273
a4d1ba9a 6274static int syncWrite(int fd, char *ptr, ssize_t size, int timeout) {
ed9b544e 6275 ssize_t nwritten, ret = size;
6276 time_t start = time(NULL);
6277
6278 timeout++;
6279 while(size) {
6280 if (aeWait(fd,AE_WRITABLE,1000) & AE_WRITABLE) {
6281 nwritten = write(fd,ptr,size);
6282 if (nwritten == -1) return -1;
6283 ptr += nwritten;
6284 size -= nwritten;
6285 }
6286 if ((time(NULL)-start) > timeout) {
6287 errno = ETIMEDOUT;
6288 return -1;
6289 }
6290 }
6291 return ret;
6292}
6293
a4d1ba9a 6294static int syncRead(int fd, char *ptr, ssize_t size, int timeout) {
ed9b544e 6295 ssize_t nread, totread = 0;
6296 time_t start = time(NULL);
6297
6298 timeout++;
6299 while(size) {
6300 if (aeWait(fd,AE_READABLE,1000) & AE_READABLE) {
6301 nread = read(fd,ptr,size);
6302 if (nread == -1) return -1;
6303 ptr += nread;
6304 size -= nread;
6305 totread += nread;
6306 }
6307 if ((time(NULL)-start) > timeout) {
6308 errno = ETIMEDOUT;
6309 return -1;
6310 }
6311 }
6312 return totread;
6313}
6314
6315static int syncReadLine(int fd, char *ptr, ssize_t size, int timeout) {
6316 ssize_t nread = 0;
6317
6318 size--;
6319 while(size) {
6320 char c;
6321
6322 if (syncRead(fd,&c,1,timeout) == -1) return -1;
6323 if (c == '\n') {
6324 *ptr = '\0';
6325 if (nread && *(ptr-1) == '\r') *(ptr-1) = '\0';
6326 return nread;
6327 } else {
6328 *ptr++ = c;
6329 *ptr = '\0';
6330 nread++;
6331 }
6332 }
6333 return nread;
6334}
6335
6336static void syncCommand(redisClient *c) {
40d224a9 6337 /* ignore SYNC if aleady slave or in monitor mode */
6338 if (c->flags & REDIS_SLAVE) return;
6339
6340 /* SYNC can't be issued when the server has pending data to send to
6341 * the client about already issued commands. We need a fresh reply
6342 * buffer registering the differences between the BGSAVE and the current
6343 * dataset, so that we can copy to other slaves if needed. */
6344 if (listLength(c->reply) != 0) {
6345 addReplySds(c,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
6346 return;
6347 }
6348
6349 redisLog(REDIS_NOTICE,"Slave ask for synchronization");
6350 /* Here we need to check if there is a background saving operation
6351 * in progress, or if it is required to start one */
9d65a1bb 6352 if (server.bgsavechildpid != -1) {
40d224a9 6353 /* Ok a background save is in progress. Let's check if it is a good
6354 * one for replication, i.e. if there is another slave that is
6355 * registering differences since the server forked to save */
6356 redisClient *slave;
6357 listNode *ln;
c7df85a4 6358 listIter li;
40d224a9 6359
c7df85a4 6360 listRewind(server.slaves,&li);
6361 while((ln = listNext(&li))) {
40d224a9 6362 slave = ln->value;
6363 if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_END) break;
40d224a9 6364 }
6365 if (ln) {
6366 /* Perfect, the server is already registering differences for
6367 * another slave. Set the right state, and copy the buffer. */
6368 listRelease(c->reply);
6369 c->reply = listDup(slave->reply);
40d224a9 6370 c->replstate = REDIS_REPL_WAIT_BGSAVE_END;
6371 redisLog(REDIS_NOTICE,"Waiting for end of BGSAVE for SYNC");
6372 } else {
6373 /* No way, we need to wait for the next BGSAVE in order to
6374 * register differences */
6375 c->replstate = REDIS_REPL_WAIT_BGSAVE_START;
6376 redisLog(REDIS_NOTICE,"Waiting for next BGSAVE for SYNC");
6377 }
6378 } else {
6379 /* Ok we don't have a BGSAVE in progress, let's start one */
6380 redisLog(REDIS_NOTICE,"Starting BGSAVE for SYNC");
6381 if (rdbSaveBackground(server.dbfilename) != REDIS_OK) {
6382 redisLog(REDIS_NOTICE,"Replication failed, can't BGSAVE");
6383 addReplySds(c,sdsnew("-ERR Unalbe to perform background save\r\n"));
6384 return;
6385 }
6386 c->replstate = REDIS_REPL_WAIT_BGSAVE_END;
6387 }
6208b3a7 6388 c->repldbfd = -1;
40d224a9 6389 c->flags |= REDIS_SLAVE;
6390 c->slaveseldb = 0;
6b47e12e 6391 listAddNodeTail(server.slaves,c);
40d224a9 6392 return;
6393}
6394
6208b3a7 6395static void sendBulkToSlave(aeEventLoop *el, int fd, void *privdata, int mask) {
6396 redisClient *slave = privdata;
6397 REDIS_NOTUSED(el);
6398 REDIS_NOTUSED(mask);
6399 char buf[REDIS_IOBUF_LEN];
6400 ssize_t nwritten, buflen;
6401
6402 if (slave->repldboff == 0) {
6403 /* Write the bulk write count before to transfer the DB. In theory here
6404 * we don't know how much room there is in the output buffer of the
6405 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
6406 * operations) will never be smaller than the few bytes we need. */
6407 sds bulkcount;
6408
6409 bulkcount = sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
6410 slave->repldbsize);
6411 if (write(fd,bulkcount,sdslen(bulkcount)) != (signed)sdslen(bulkcount))
6412 {
6413 sdsfree(bulkcount);
6414 freeClient(slave);
6415 return;
6416 }
6417 sdsfree(bulkcount);
6418 }
6419 lseek(slave->repldbfd,slave->repldboff,SEEK_SET);
6420 buflen = read(slave->repldbfd,buf,REDIS_IOBUF_LEN);
6421 if (buflen <= 0) {
6422 redisLog(REDIS_WARNING,"Read error sending DB to slave: %s",
6423 (buflen == 0) ? "premature EOF" : strerror(errno));
6424 freeClient(slave);
6425 return;
6426 }
6427 if ((nwritten = write(fd,buf,buflen)) == -1) {
f870935d 6428 redisLog(REDIS_VERBOSE,"Write error sending DB to slave: %s",
6208b3a7 6429 strerror(errno));
6430 freeClient(slave);
6431 return;
6432 }
6433 slave->repldboff += nwritten;
6434 if (slave->repldboff == slave->repldbsize) {
6435 close(slave->repldbfd);
6436 slave->repldbfd = -1;
6437 aeDeleteFileEvent(server.el,slave->fd,AE_WRITABLE);
6438 slave->replstate = REDIS_REPL_ONLINE;
6439 if (aeCreateFileEvent(server.el, slave->fd, AE_WRITABLE,
266373b2 6440 sendReplyToClient, slave) == AE_ERR) {
6208b3a7 6441 freeClient(slave);
6442 return;
6443 }
6444 addReplySds(slave,sdsempty());
6445 redisLog(REDIS_NOTICE,"Synchronization with slave succeeded");
6446 }
6447}
ed9b544e 6448
a3b21203 6449/* This function is called at the end of every backgrond saving.
6450 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
6451 * otherwise REDIS_ERR is passed to the function.
6452 *
6453 * The goal of this function is to handle slaves waiting for a successful
6454 * background saving in order to perform non-blocking synchronization. */
6455static void updateSlavesWaitingBgsave(int bgsaveerr) {
6208b3a7 6456 listNode *ln;
6457 int startbgsave = 0;
c7df85a4 6458 listIter li;
ed9b544e 6459
c7df85a4 6460 listRewind(server.slaves,&li);
6461 while((ln = listNext(&li))) {
6208b3a7 6462 redisClient *slave = ln->value;
ed9b544e 6463
6208b3a7 6464 if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_START) {
6465 startbgsave = 1;
6466 slave->replstate = REDIS_REPL_WAIT_BGSAVE_END;
6467 } else if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_END) {
dde65f3f 6468 struct redis_stat buf;
6208b3a7 6469
6470 if (bgsaveerr != REDIS_OK) {
6471 freeClient(slave);
6472 redisLog(REDIS_WARNING,"SYNC failed. BGSAVE child returned an error");
6473 continue;
6474 }
6475 if ((slave->repldbfd = open(server.dbfilename,O_RDONLY)) == -1 ||
dde65f3f 6476 redis_fstat(slave->repldbfd,&buf) == -1) {
6208b3a7 6477 freeClient(slave);
6478 redisLog(REDIS_WARNING,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno));
6479 continue;
6480 }
6481 slave->repldboff = 0;
6482 slave->repldbsize = buf.st_size;
6483 slave->replstate = REDIS_REPL_SEND_BULK;
6484 aeDeleteFileEvent(server.el,slave->fd,AE_WRITABLE);
266373b2 6485 if (aeCreateFileEvent(server.el, slave->fd, AE_WRITABLE, sendBulkToSlave, slave) == AE_ERR) {
6208b3a7 6486 freeClient(slave);
6487 continue;
6488 }
6489 }
ed9b544e 6490 }
6208b3a7 6491 if (startbgsave) {
6492 if (rdbSaveBackground(server.dbfilename) != REDIS_OK) {
c7df85a4 6493 listIter li;
6494
6495 listRewind(server.slaves,&li);
6208b3a7 6496 redisLog(REDIS_WARNING,"SYNC failed. BGSAVE failed");
c7df85a4 6497 while((ln = listNext(&li))) {
6208b3a7 6498 redisClient *slave = ln->value;
ed9b544e 6499
6208b3a7 6500 if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_START)
6501 freeClient(slave);
6502 }
6503 }
6504 }
ed9b544e 6505}
6506
6507static int syncWithMaster(void) {
d0ccebcf 6508 char buf[1024], tmpfile[256], authcmd[1024];
ed9b544e 6509 int dumpsize;
6510 int fd = anetTcpConnect(NULL,server.masterhost,server.masterport);
6511 int dfd;
6512
6513 if (fd == -1) {
6514 redisLog(REDIS_WARNING,"Unable to connect to MASTER: %s",
6515 strerror(errno));
6516 return REDIS_ERR;
6517 }
d0ccebcf 6518
6519 /* AUTH with the master if required. */
6520 if(server.masterauth) {
6521 snprintf(authcmd, 1024, "AUTH %s\r\n", server.masterauth);
6522 if (syncWrite(fd, authcmd, strlen(server.masterauth)+7, 5) == -1) {
6523 close(fd);
6524 redisLog(REDIS_WARNING,"Unable to AUTH to MASTER: %s",
6525 strerror(errno));
6526 return REDIS_ERR;
6527 }
6528 /* Read the AUTH result. */
6529 if (syncReadLine(fd,buf,1024,3600) == -1) {
6530 close(fd);
6531 redisLog(REDIS_WARNING,"I/O error reading auth result from MASTER: %s",
6532 strerror(errno));
6533 return REDIS_ERR;
6534 }
6535 if (buf[0] != '+') {
6536 close(fd);
6537 redisLog(REDIS_WARNING,"Cannot AUTH to MASTER, is the masterauth password correct?");
6538 return REDIS_ERR;
6539 }
6540 }
6541
ed9b544e 6542 /* Issue the SYNC command */
6543 if (syncWrite(fd,"SYNC \r\n",7,5) == -1) {
6544 close(fd);
6545 redisLog(REDIS_WARNING,"I/O error writing to MASTER: %s",
6546 strerror(errno));
6547 return REDIS_ERR;
6548 }
6549 /* Read the bulk write count */
8c4d91fc 6550 if (syncReadLine(fd,buf,1024,3600) == -1) {
ed9b544e 6551 close(fd);
6552 redisLog(REDIS_WARNING,"I/O error reading bulk count from MASTER: %s",
6553 strerror(errno));
6554 return REDIS_ERR;
6555 }
4aa701c1 6556 if (buf[0] != '$') {
6557 close(fd);
6558 redisLog(REDIS_WARNING,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
6559 return REDIS_ERR;
6560 }
c937aa89 6561 dumpsize = atoi(buf+1);
ed9b544e 6562 redisLog(REDIS_NOTICE,"Receiving %d bytes data dump from MASTER",dumpsize);
6563 /* Read the bulk write data on a temp file */
6564 snprintf(tmpfile,256,"temp-%d.%ld.rdb",(int)time(NULL),(long int)random());
6565 dfd = open(tmpfile,O_CREAT|O_WRONLY,0644);
6566 if (dfd == -1) {
6567 close(fd);
6568 redisLog(REDIS_WARNING,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno));
6569 return REDIS_ERR;
6570 }
6571 while(dumpsize) {
6572 int nread, nwritten;
6573
6574 nread = read(fd,buf,(dumpsize < 1024)?dumpsize:1024);
6575 if (nread == -1) {
6576 redisLog(REDIS_WARNING,"I/O error trying to sync with MASTER: %s",
6577 strerror(errno));
6578 close(fd);
6579 close(dfd);
6580 return REDIS_ERR;
6581 }
6582 nwritten = write(dfd,buf,nread);
6583 if (nwritten == -1) {
6584 redisLog(REDIS_WARNING,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno));
6585 close(fd);
6586 close(dfd);
6587 return REDIS_ERR;
6588 }
6589 dumpsize -= nread;
6590 }
6591 close(dfd);
6592 if (rename(tmpfile,server.dbfilename) == -1) {
6593 redisLog(REDIS_WARNING,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno));
6594 unlink(tmpfile);
6595 close(fd);
6596 return REDIS_ERR;
6597 }
6598 emptyDb();
f78fd11b 6599 if (rdbLoad(server.dbfilename) != REDIS_OK) {
ed9b544e 6600 redisLog(REDIS_WARNING,"Failed trying to load the MASTER synchronization DB from disk");
6601 close(fd);
6602 return REDIS_ERR;
6603 }
6604 server.master = createClient(fd);
6605 server.master->flags |= REDIS_MASTER;
179b3952 6606 server.master->authenticated = 1;
ed9b544e 6607 server.replstate = REDIS_REPL_CONNECTED;
6608 return REDIS_OK;
6609}
6610
321b0e13 6611static void slaveofCommand(redisClient *c) {
6612 if (!strcasecmp(c->argv[1]->ptr,"no") &&
6613 !strcasecmp(c->argv[2]->ptr,"one")) {
6614 if (server.masterhost) {
6615 sdsfree(server.masterhost);
6616 server.masterhost = NULL;
6617 if (server.master) freeClient(server.master);
6618 server.replstate = REDIS_REPL_NONE;
6619 redisLog(REDIS_NOTICE,"MASTER MODE enabled (user request)");
6620 }
6621 } else {
6622 sdsfree(server.masterhost);
6623 server.masterhost = sdsdup(c->argv[1]->ptr);
6624 server.masterport = atoi(c->argv[2]->ptr);
6625 if (server.master) freeClient(server.master);
6626 server.replstate = REDIS_REPL_CONNECT;
6627 redisLog(REDIS_NOTICE,"SLAVE OF %s:%d enabled (user request)",
6628 server.masterhost, server.masterport);
6629 }
6630 addReply(c,shared.ok);
6631}
6632
3fd78bcd 6633/* ============================ Maxmemory directive ======================== */
6634
a5819310 6635/* Try to free one object form the pre-allocated objects free list.
6636 * This is useful under low mem conditions as by default we take 1 million
6637 * free objects allocated. On success REDIS_OK is returned, otherwise
6638 * REDIS_ERR. */
6639static int tryFreeOneObjectFromFreelist(void) {
f870935d 6640 robj *o;
6641
a5819310 6642 if (server.vm_enabled) pthread_mutex_lock(&server.obj_freelist_mutex);
6643 if (listLength(server.objfreelist)) {
6644 listNode *head = listFirst(server.objfreelist);
6645 o = listNodeValue(head);
6646 listDelNode(server.objfreelist,head);
6647 if (server.vm_enabled) pthread_mutex_unlock(&server.obj_freelist_mutex);
6648 zfree(o);
6649 return REDIS_OK;
6650 } else {
6651 if (server.vm_enabled) pthread_mutex_unlock(&server.obj_freelist_mutex);
6652 return REDIS_ERR;
6653 }
f870935d 6654}
6655
3fd78bcd 6656/* This function gets called when 'maxmemory' is set on the config file to limit
6657 * the max memory used by the server, and we are out of memory.
6658 * This function will try to, in order:
6659 *
6660 * - Free objects from the free list
6661 * - Try to remove keys with an EXPIRE set
6662 *
6663 * It is not possible to free enough memory to reach used-memory < maxmemory
6664 * the server will start refusing commands that will enlarge even more the
6665 * memory usage.
6666 */
6667static void freeMemoryIfNeeded(void) {
6668 while (server.maxmemory && zmalloc_used_memory() > server.maxmemory) {
a5819310 6669 int j, k, freed = 0;
6670
6671 if (tryFreeOneObjectFromFreelist() == REDIS_OK) continue;
6672 for (j = 0; j < server.dbnum; j++) {
6673 int minttl = -1;
6674 robj *minkey = NULL;
6675 struct dictEntry *de;
6676
6677 if (dictSize(server.db[j].expires)) {
6678 freed = 1;
6679 /* From a sample of three keys drop the one nearest to
6680 * the natural expire */
6681 for (k = 0; k < 3; k++) {
6682 time_t t;
6683
6684 de = dictGetRandomKey(server.db[j].expires);
6685 t = (time_t) dictGetEntryVal(de);
6686 if (minttl == -1 || t < minttl) {
6687 minkey = dictGetEntryKey(de);
6688 minttl = t;
3fd78bcd 6689 }
3fd78bcd 6690 }
a5819310 6691 deleteKey(server.db+j,minkey);
3fd78bcd 6692 }
3fd78bcd 6693 }
a5819310 6694 if (!freed) return; /* nothing to free... */
3fd78bcd 6695 }
6696}
6697
f80dff62 6698/* ============================== Append Only file ========================== */
6699
6700static void feedAppendOnlyFile(struct redisCommand *cmd, int dictid, robj **argv, int argc) {
6701 sds buf = sdsempty();
6702 int j;
6703 ssize_t nwritten;
6704 time_t now;
6705 robj *tmpargv[3];
6706
6707 /* The DB this command was targetting is not the same as the last command
6708 * we appendend. To issue a SELECT command is needed. */
6709 if (dictid != server.appendseldb) {
6710 char seldb[64];
6711
6712 snprintf(seldb,sizeof(seldb),"%d",dictid);
682ac724 6713 buf = sdscatprintf(buf,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
83c6a618 6714 (unsigned long)strlen(seldb),seldb);
f80dff62 6715 server.appendseldb = dictid;
6716 }
6717
6718 /* "Fix" the argv vector if the command is EXPIRE. We want to translate
6719 * EXPIREs into EXPIREATs calls */
6720 if (cmd->proc == expireCommand) {
6721 long when;
6722
6723 tmpargv[0] = createStringObject("EXPIREAT",8);
6724 tmpargv[1] = argv[1];
6725 incrRefCount(argv[1]);
6726 when = time(NULL)+strtol(argv[2]->ptr,NULL,10);
6727 tmpargv[2] = createObject(REDIS_STRING,
6728 sdscatprintf(sdsempty(),"%ld",when));
6729 argv = tmpargv;
6730 }
6731
6732 /* Append the actual command */
6733 buf = sdscatprintf(buf,"*%d\r\n",argc);
6734 for (j = 0; j < argc; j++) {
6735 robj *o = argv[j];
6736
9d65a1bb 6737 o = getDecodedObject(o);
83c6a618 6738 buf = sdscatprintf(buf,"$%lu\r\n",(unsigned long)sdslen(o->ptr));
f80dff62 6739 buf = sdscatlen(buf,o->ptr,sdslen(o->ptr));
6740 buf = sdscatlen(buf,"\r\n",2);
9d65a1bb 6741 decrRefCount(o);
f80dff62 6742 }
6743
6744 /* Free the objects from the modified argv for EXPIREAT */
6745 if (cmd->proc == expireCommand) {
6746 for (j = 0; j < 3; j++)
6747 decrRefCount(argv[j]);
6748 }
6749
6750 /* We want to perform a single write. This should be guaranteed atomic
6751 * at least if the filesystem we are writing is a real physical one.
6752 * While this will save us against the server being killed I don't think
6753 * there is much to do about the whole server stopping for power problems
6754 * or alike */
6755 nwritten = write(server.appendfd,buf,sdslen(buf));
6756 if (nwritten != (signed)sdslen(buf)) {
6757 /* Ooops, we are in troubles. The best thing to do for now is
6758 * to simply exit instead to give the illusion that everything is
6759 * working as expected. */
6760 if (nwritten == -1) {
6761 redisLog(REDIS_WARNING,"Exiting on error writing to the append-only file: %s",strerror(errno));
6762 } else {
6763 redisLog(REDIS_WARNING,"Exiting on short write while writing to the append-only file: %s",strerror(errno));
6764 }
6765 exit(1);
6766 }
85a83172 6767 /* If a background append only file rewriting is in progress we want to
6768 * accumulate the differences between the child DB and the current one
6769 * in a buffer, so that when the child process will do its work we
6770 * can append the differences to the new append only file. */
6771 if (server.bgrewritechildpid != -1)
6772 server.bgrewritebuf = sdscatlen(server.bgrewritebuf,buf,sdslen(buf));
6773
6774 sdsfree(buf);
f80dff62 6775 now = time(NULL);
6776 if (server.appendfsync == APPENDFSYNC_ALWAYS ||
6777 (server.appendfsync == APPENDFSYNC_EVERYSEC &&
6778 now-server.lastfsync > 1))
6779 {
6780 fsync(server.appendfd); /* Let's try to get this data on the disk */
6781 server.lastfsync = now;
6782 }
6783}
6784
6785/* In Redis commands are always executed in the context of a client, so in
6786 * order to load the append only file we need to create a fake client. */
6787static struct redisClient *createFakeClient(void) {
6788 struct redisClient *c = zmalloc(sizeof(*c));
6789
6790 selectDb(c,0);
6791 c->fd = -1;
6792 c->querybuf = sdsempty();
6793 c->argc = 0;
6794 c->argv = NULL;
6795 c->flags = 0;
9387d17d 6796 /* We set the fake client as a slave waiting for the synchronization
6797 * so that Redis will not try to send replies to this client. */
6798 c->replstate = REDIS_REPL_WAIT_BGSAVE_START;
f80dff62 6799 c->reply = listCreate();
6800 listSetFreeMethod(c->reply,decrRefCount);
6801 listSetDupMethod(c->reply,dupClientReplyValue);
6802 return c;
6803}
6804
6805static void freeFakeClient(struct redisClient *c) {
6806 sdsfree(c->querybuf);
6807 listRelease(c->reply);
6808 zfree(c);
6809}
6810
6811/* Replay the append log file. On error REDIS_OK is returned. On non fatal
6812 * error (the append only file is zero-length) REDIS_ERR is returned. On
6813 * fatal error an error message is logged and the program exists. */
6814int loadAppendOnlyFile(char *filename) {
6815 struct redisClient *fakeClient;
6816 FILE *fp = fopen(filename,"r");
6817 struct redis_stat sb;
b492cf00 6818 unsigned long long loadedkeys = 0;
f80dff62 6819
6820 if (redis_fstat(fileno(fp),&sb) != -1 && sb.st_size == 0)
6821 return REDIS_ERR;
6822
6823 if (fp == NULL) {
6824 redisLog(REDIS_WARNING,"Fatal error: can't open the append log file for reading: %s",strerror(errno));
6825 exit(1);
6826 }
6827
6828 fakeClient = createFakeClient();
6829 while(1) {
6830 int argc, j;
6831 unsigned long len;
6832 robj **argv;
6833 char buf[128];
6834 sds argsds;
6835 struct redisCommand *cmd;
6836
6837 if (fgets(buf,sizeof(buf),fp) == NULL) {
6838 if (feof(fp))
6839 break;
6840 else
6841 goto readerr;
6842 }
6843 if (buf[0] != '*') goto fmterr;
6844 argc = atoi(buf+1);
6845 argv = zmalloc(sizeof(robj*)*argc);
6846 for (j = 0; j < argc; j++) {
6847 if (fgets(buf,sizeof(buf),fp) == NULL) goto readerr;
6848 if (buf[0] != '$') goto fmterr;
6849 len = strtol(buf+1,NULL,10);
6850 argsds = sdsnewlen(NULL,len);
0f151ef1 6851 if (len && fread(argsds,len,1,fp) == 0) goto fmterr;
f80dff62 6852 argv[j] = createObject(REDIS_STRING,argsds);
6853 if (fread(buf,2,1,fp) == 0) goto fmterr; /* discard CRLF */
6854 }
6855
6856 /* Command lookup */
6857 cmd = lookupCommand(argv[0]->ptr);
6858 if (!cmd) {
6859 redisLog(REDIS_WARNING,"Unknown command '%s' reading the append only file", argv[0]->ptr);
6860 exit(1);
6861 }
6862 /* Try object sharing and encoding */
6863 if (server.shareobjects) {
6864 int j;
6865 for(j = 1; j < argc; j++)
6866 argv[j] = tryObjectSharing(argv[j]);
6867 }
6868 if (cmd->flags & REDIS_CMD_BULK)
6869 tryObjectEncoding(argv[argc-1]);
6870 /* Run the command in the context of a fake client */
6871 fakeClient->argc = argc;
6872 fakeClient->argv = argv;
6873 cmd->proc(fakeClient);
6874 /* Discard the reply objects list from the fake client */
6875 while(listLength(fakeClient->reply))
6876 listDelNode(fakeClient->reply,listFirst(fakeClient->reply));
6877 /* Clean up, ready for the next command */
6878 for (j = 0; j < argc; j++) decrRefCount(argv[j]);
6879 zfree(argv);
b492cf00 6880 /* Handle swapping while loading big datasets when VM is on */
6881 loadedkeys++;
6882 if (server.vm_enabled && (loadedkeys % 5000) == 0) {
6883 while (zmalloc_used_memory() > server.vm_max_memory) {
a69a0c9c 6884 if (vmSwapOneObjectBlocking() == REDIS_ERR) break;
b492cf00 6885 }
6886 }
f80dff62 6887 }
6888 fclose(fp);
6889 freeFakeClient(fakeClient);
6890 return REDIS_OK;
6891
6892readerr:
6893 if (feof(fp)) {
6894 redisLog(REDIS_WARNING,"Unexpected end of file reading the append only file");
6895 } else {
6896 redisLog(REDIS_WARNING,"Unrecoverable error reading the append only file: %s", strerror(errno));
6897 }
6898 exit(1);
6899fmterr:
6900 redisLog(REDIS_WARNING,"Bad file format reading the append only file");
6901 exit(1);
6902}
6903
9d65a1bb 6904/* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
6905static int fwriteBulk(FILE *fp, robj *obj) {
6906 char buf[128];
b9bc0eef 6907 int decrrc = 0;
6908
f2d9f50f 6909 /* Avoid the incr/decr ref count business if possible to help
6910 * copy-on-write (we are often in a child process when this function
6911 * is called).
6912 * Also makes sure that key objects don't get incrRefCount-ed when VM
6913 * is enabled */
6914 if (obj->encoding != REDIS_ENCODING_RAW) {
b9bc0eef 6915 obj = getDecodedObject(obj);
6916 decrrc = 1;
6917 }
9d65a1bb 6918 snprintf(buf,sizeof(buf),"$%ld\r\n",(long)sdslen(obj->ptr));
6919 if (fwrite(buf,strlen(buf),1,fp) == 0) goto err;
e96e4fbf 6920 if (sdslen(obj->ptr) && fwrite(obj->ptr,sdslen(obj->ptr),1,fp) == 0)
6921 goto err;
9d65a1bb 6922 if (fwrite("\r\n",2,1,fp) == 0) goto err;
b9bc0eef 6923 if (decrrc) decrRefCount(obj);
9d65a1bb 6924 return 1;
6925err:
b9bc0eef 6926 if (decrrc) decrRefCount(obj);
9d65a1bb 6927 return 0;
6928}
6929
6930/* Write a double value in bulk format $<count>\r\n<payload>\r\n */
6931static int fwriteBulkDouble(FILE *fp, double d) {
6932 char buf[128], dbuf[128];
6933
6934 snprintf(dbuf,sizeof(dbuf),"%.17g\r\n",d);
6935 snprintf(buf,sizeof(buf),"$%lu\r\n",(unsigned long)strlen(dbuf)-2);
6936 if (fwrite(buf,strlen(buf),1,fp) == 0) return 0;
6937 if (fwrite(dbuf,strlen(dbuf),1,fp) == 0) return 0;
6938 return 1;
6939}
6940
6941/* Write a long value in bulk format $<count>\r\n<payload>\r\n */
6942static int fwriteBulkLong(FILE *fp, long l) {
6943 char buf[128], lbuf[128];
6944
6945 snprintf(lbuf,sizeof(lbuf),"%ld\r\n",l);
6946 snprintf(buf,sizeof(buf),"$%lu\r\n",(unsigned long)strlen(lbuf)-2);
6947 if (fwrite(buf,strlen(buf),1,fp) == 0) return 0;
6948 if (fwrite(lbuf,strlen(lbuf),1,fp) == 0) return 0;
6949 return 1;
6950}
6951
6952/* Write a sequence of commands able to fully rebuild the dataset into
6953 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
6954static int rewriteAppendOnlyFile(char *filename) {
6955 dictIterator *di = NULL;
6956 dictEntry *de;
6957 FILE *fp;
6958 char tmpfile[256];
6959 int j;
6960 time_t now = time(NULL);
6961
6962 /* Note that we have to use a different temp name here compared to the
6963 * one used by rewriteAppendOnlyFileBackground() function. */
6964 snprintf(tmpfile,256,"temp-rewriteaof-%d.aof", (int) getpid());
6965 fp = fopen(tmpfile,"w");
6966 if (!fp) {
6967 redisLog(REDIS_WARNING, "Failed rewriting the append only file: %s", strerror(errno));
6968 return REDIS_ERR;
6969 }
6970 for (j = 0; j < server.dbnum; j++) {
6971 char selectcmd[] = "*2\r\n$6\r\nSELECT\r\n";
6972 redisDb *db = server.db+j;
6973 dict *d = db->dict;
6974 if (dictSize(d) == 0) continue;
6975 di = dictGetIterator(d);
6976 if (!di) {
6977 fclose(fp);
6978 return REDIS_ERR;
6979 }
6980
6981 /* SELECT the new DB */
6982 if (fwrite(selectcmd,sizeof(selectcmd)-1,1,fp) == 0) goto werr;
85a83172 6983 if (fwriteBulkLong(fp,j) == 0) goto werr;
9d65a1bb 6984
6985 /* Iterate this DB writing every entry */
6986 while((de = dictNext(di)) != NULL) {
e7546c63 6987 robj *key, *o;
6988 time_t expiretime;
6989 int swapped;
6990
6991 key = dictGetEntryKey(de);
b9bc0eef 6992 /* If the value for this key is swapped, load a preview in memory.
6993 * We use a "swapped" flag to remember if we need to free the
6994 * value object instead to just increment the ref count anyway
6995 * in order to avoid copy-on-write of pages if we are forked() */
996cb5f7 6996 if (!server.vm_enabled || key->storage == REDIS_VM_MEMORY ||
6997 key->storage == REDIS_VM_SWAPPING) {
e7546c63 6998 o = dictGetEntryVal(de);
6999 swapped = 0;
7000 } else {
7001 o = vmPreviewObject(key);
e7546c63 7002 swapped = 1;
7003 }
7004 expiretime = getExpire(db,key);
9d65a1bb 7005
7006 /* Save the key and associated value */
9d65a1bb 7007 if (o->type == REDIS_STRING) {
7008 /* Emit a SET command */
7009 char cmd[]="*3\r\n$3\r\nSET\r\n";
7010 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
7011 /* Key and value */
7012 if (fwriteBulk(fp,key) == 0) goto werr;
7013 if (fwriteBulk(fp,o) == 0) goto werr;
7014 } else if (o->type == REDIS_LIST) {
7015 /* Emit the RPUSHes needed to rebuild the list */
7016 list *list = o->ptr;
7017 listNode *ln;
c7df85a4 7018 listIter li;
9d65a1bb 7019
c7df85a4 7020 listRewind(list,&li);
7021 while((ln = listNext(&li))) {
9d65a1bb 7022 char cmd[]="*3\r\n$5\r\nRPUSH\r\n";
7023 robj *eleobj = listNodeValue(ln);
7024
7025 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
7026 if (fwriteBulk(fp,key) == 0) goto werr;
7027 if (fwriteBulk(fp,eleobj) == 0) goto werr;
7028 }
7029 } else if (o->type == REDIS_SET) {
7030 /* Emit the SADDs needed to rebuild the set */
7031 dict *set = o->ptr;
7032 dictIterator *di = dictGetIterator(set);
7033 dictEntry *de;
7034
7035 while((de = dictNext(di)) != NULL) {
7036 char cmd[]="*3\r\n$4\r\nSADD\r\n";
7037 robj *eleobj = dictGetEntryKey(de);
7038
7039 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
7040 if (fwriteBulk(fp,key) == 0) goto werr;
7041 if (fwriteBulk(fp,eleobj) == 0) goto werr;
7042 }
7043 dictReleaseIterator(di);
7044 } else if (o->type == REDIS_ZSET) {
7045 /* Emit the ZADDs needed to rebuild the sorted set */
7046 zset *zs = o->ptr;
7047 dictIterator *di = dictGetIterator(zs->dict);
7048 dictEntry *de;
7049
7050 while((de = dictNext(di)) != NULL) {
7051 char cmd[]="*4\r\n$4\r\nZADD\r\n";
7052 robj *eleobj = dictGetEntryKey(de);
7053 double *score = dictGetEntryVal(de);
7054
7055 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
7056 if (fwriteBulk(fp,key) == 0) goto werr;
7057 if (fwriteBulkDouble(fp,*score) == 0) goto werr;
7058 if (fwriteBulk(fp,eleobj) == 0) goto werr;
7059 }
7060 dictReleaseIterator(di);
7061 } else {
dfc5e96c 7062 redisAssert(0 != 0);
9d65a1bb 7063 }
7064 /* Save the expire time */
7065 if (expiretime != -1) {
e96e4fbf 7066 char cmd[]="*3\r\n$8\r\nEXPIREAT\r\n";
9d65a1bb 7067 /* If this key is already expired skip it */
7068 if (expiretime < now) continue;
7069 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
7070 if (fwriteBulk(fp,key) == 0) goto werr;
7071 if (fwriteBulkLong(fp,expiretime) == 0) goto werr;
7072 }
b9bc0eef 7073 if (swapped) decrRefCount(o);
9d65a1bb 7074 }
7075 dictReleaseIterator(di);
7076 }
7077
7078 /* Make sure data will not remain on the OS's output buffers */
7079 fflush(fp);
7080 fsync(fileno(fp));
7081 fclose(fp);
7082
7083 /* Use RENAME to make sure the DB file is changed atomically only
7084 * if the generate DB file is ok. */
7085 if (rename(tmpfile,filename) == -1) {
7086 redisLog(REDIS_WARNING,"Error moving temp append only file on the final destination: %s", strerror(errno));
7087 unlink(tmpfile);
7088 return REDIS_ERR;
7089 }
7090 redisLog(REDIS_NOTICE,"SYNC append only file rewrite performed");
7091 return REDIS_OK;
7092
7093werr:
7094 fclose(fp);
7095 unlink(tmpfile);
e96e4fbf 7096 redisLog(REDIS_WARNING,"Write error writing append only file on disk: %s", strerror(errno));
9d65a1bb 7097 if (di) dictReleaseIterator(di);
7098 return REDIS_ERR;
7099}
7100
7101/* This is how rewriting of the append only file in background works:
7102 *
7103 * 1) The user calls BGREWRITEAOF
7104 * 2) Redis calls this function, that forks():
7105 * 2a) the child rewrite the append only file in a temp file.
7106 * 2b) the parent accumulates differences in server.bgrewritebuf.
7107 * 3) When the child finished '2a' exists.
7108 * 4) The parent will trap the exit code, if it's OK, will append the
7109 * data accumulated into server.bgrewritebuf into the temp file, and
7110 * finally will rename(2) the temp file in the actual file name.
7111 * The the new file is reopened as the new append only file. Profit!
7112 */
7113static int rewriteAppendOnlyFileBackground(void) {
7114 pid_t childpid;
7115
7116 if (server.bgrewritechildpid != -1) return REDIS_ERR;
054e426d 7117 if (server.vm_enabled) waitEmptyIOJobsQueue();
9d65a1bb 7118 if ((childpid = fork()) == 0) {
7119 /* Child */
7120 char tmpfile[256];
9d65a1bb 7121
054e426d 7122 if (server.vm_enabled) vmReopenSwapFile();
7123 close(server.fd);
9d65a1bb 7124 snprintf(tmpfile,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
7125 if (rewriteAppendOnlyFile(tmpfile) == REDIS_OK) {
478c2c6f 7126 _exit(0);
9d65a1bb 7127 } else {
478c2c6f 7128 _exit(1);
9d65a1bb 7129 }
7130 } else {
7131 /* Parent */
7132 if (childpid == -1) {
7133 redisLog(REDIS_WARNING,
7134 "Can't rewrite append only file in background: fork: %s",
7135 strerror(errno));
7136 return REDIS_ERR;
7137 }
7138 redisLog(REDIS_NOTICE,
7139 "Background append only file rewriting started by pid %d",childpid);
7140 server.bgrewritechildpid = childpid;
85a83172 7141 /* We set appendseldb to -1 in order to force the next call to the
7142 * feedAppendOnlyFile() to issue a SELECT command, so the differences
7143 * accumulated by the parent into server.bgrewritebuf will start
7144 * with a SELECT statement and it will be safe to merge. */
7145 server.appendseldb = -1;
9d65a1bb 7146 return REDIS_OK;
7147 }
7148 return REDIS_OK; /* unreached */
7149}
7150
7151static void bgrewriteaofCommand(redisClient *c) {
7152 if (server.bgrewritechildpid != -1) {
7153 addReplySds(c,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
7154 return;
7155 }
7156 if (rewriteAppendOnlyFileBackground() == REDIS_OK) {
49b99ab4 7157 char *status = "+Background append only file rewriting started\r\n";
7158 addReplySds(c,sdsnew(status));
9d65a1bb 7159 } else {
7160 addReply(c,shared.err);
7161 }
7162}
7163
7164static void aofRemoveTempFile(pid_t childpid) {
7165 char tmpfile[256];
7166
7167 snprintf(tmpfile,256,"temp-rewriteaof-bg-%d.aof", (int) childpid);
7168 unlink(tmpfile);
7169}
7170
996cb5f7 7171/* Virtual Memory is composed mainly of two subsystems:
7172 * - Blocking Virutal Memory
7173 * - Threaded Virtual Memory I/O
7174 * The two parts are not fully decoupled, but functions are split among two
7175 * different sections of the source code (delimited by comments) in order to
7176 * make more clear what functionality is about the blocking VM and what about
7177 * the threaded (not blocking) VM.
7178 *
7179 * Redis VM design:
7180 *
7181 * Redis VM is a blocking VM (one that blocks reading swapped values from
7182 * disk into memory when a value swapped out is needed in memory) that is made
7183 * unblocking by trying to examine the command argument vector in order to
7184 * load in background values that will likely be needed in order to exec
7185 * the command. The command is executed only once all the relevant keys
7186 * are loaded into memory.
7187 *
7188 * This basically is almost as simple of a blocking VM, but almost as parallel
7189 * as a fully non-blocking VM.
7190 */
7191
7192/* =================== Virtual Memory - Blocking Side ====================== */
054e426d 7193
7194/* substitute the first occurrence of '%p' with the process pid in the
7195 * swap file name. */
7196static void expandVmSwapFilename(void) {
7197 char *p = strstr(server.vm_swap_file,"%p");
7198 sds new;
7199
7200 if (!p) return;
7201 new = sdsempty();
7202 *p = '\0';
7203 new = sdscat(new,server.vm_swap_file);
7204 new = sdscatprintf(new,"%ld",(long) getpid());
7205 new = sdscat(new,p+2);
7206 zfree(server.vm_swap_file);
7207 server.vm_swap_file = new;
7208}
7209
75680a3c 7210static void vmInit(void) {
7211 off_t totsize;
996cb5f7 7212 int pipefds[2];
bcaa7a4f 7213 size_t stacksize;
75680a3c 7214
4ad37480 7215 if (server.vm_max_threads != 0)
7216 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
7217
054e426d 7218 expandVmSwapFilename();
7219 redisLog(REDIS_NOTICE,"Using '%s' as swap file",server.vm_swap_file);
6fa987e3 7220 if ((server.vm_fp = fopen(server.vm_swap_file,"r+b")) == NULL) {
7221 server.vm_fp = fopen(server.vm_swap_file,"w+b");
7222 }
75680a3c 7223 if (server.vm_fp == NULL) {
6fa987e3 7224 redisLog(REDIS_WARNING,
7225 "Impossible to open the swap file: %s. Exiting.",
7226 strerror(errno));
75680a3c 7227 exit(1);
7228 }
7229 server.vm_fd = fileno(server.vm_fp);
7230 server.vm_next_page = 0;
7231 server.vm_near_pages = 0;
7d98e08c 7232 server.vm_stats_used_pages = 0;
7233 server.vm_stats_swapped_objects = 0;
7234 server.vm_stats_swapouts = 0;
7235 server.vm_stats_swapins = 0;
75680a3c 7236 totsize = server.vm_pages*server.vm_page_size;
7237 redisLog(REDIS_NOTICE,"Allocating %lld bytes of swap file",totsize);
7238 if (ftruncate(server.vm_fd,totsize) == -1) {
7239 redisLog(REDIS_WARNING,"Can't ftruncate swap file: %s. Exiting.",
7240 strerror(errno));
7241 exit(1);
7242 } else {
7243 redisLog(REDIS_NOTICE,"Swap file allocated with success");
7244 }
7d30035d 7245 server.vm_bitmap = zmalloc((server.vm_pages+7)/8);
f870935d 7246 redisLog(REDIS_VERBOSE,"Allocated %lld bytes page table for %lld pages",
4ef8de8a 7247 (long long) (server.vm_pages+7)/8, server.vm_pages);
7d30035d 7248 memset(server.vm_bitmap,0,(server.vm_pages+7)/8);
92f8e882 7249
996cb5f7 7250 /* Initialize threaded I/O (used by Virtual Memory) */
7251 server.io_newjobs = listCreate();
7252 server.io_processing = listCreate();
7253 server.io_processed = listCreate();
d5d55fc3 7254 server.io_ready_clients = listCreate();
92f8e882 7255 pthread_mutex_init(&server.io_mutex,NULL);
a5819310 7256 pthread_mutex_init(&server.obj_freelist_mutex,NULL);
7257 pthread_mutex_init(&server.io_swapfile_mutex,NULL);
92f8e882 7258 server.io_active_threads = 0;
996cb5f7 7259 if (pipe(pipefds) == -1) {
7260 redisLog(REDIS_WARNING,"Unable to intialized VM: pipe(2): %s. Exiting."
7261 ,strerror(errno));
7262 exit(1);
7263 }
7264 server.io_ready_pipe_read = pipefds[0];
7265 server.io_ready_pipe_write = pipefds[1];
7266 redisAssert(anetNonBlock(NULL,server.io_ready_pipe_read) != ANET_ERR);
bcaa7a4f 7267 /* LZF requires a lot of stack */
7268 pthread_attr_init(&server.io_threads_attr);
7269 pthread_attr_getstacksize(&server.io_threads_attr, &stacksize);
7270 while (stacksize < REDIS_THREAD_STACK_SIZE) stacksize *= 2;
7271 pthread_attr_setstacksize(&server.io_threads_attr, stacksize);
b9bc0eef 7272 /* Listen for events in the threaded I/O pipe */
7273 if (aeCreateFileEvent(server.el, server.io_ready_pipe_read, AE_READABLE,
7274 vmThreadedIOCompletedJob, NULL) == AE_ERR)
7275 oom("creating file event");
75680a3c 7276}
7277
06224fec 7278/* Mark the page as used */
7279static void vmMarkPageUsed(off_t page) {
7280 off_t byte = page/8;
7281 int bit = page&7;
970e10bb 7282 redisAssert(vmFreePage(page) == 1);
06224fec 7283 server.vm_bitmap[byte] |= 1<<bit;
7284}
7285
7286/* Mark N contiguous pages as used, with 'page' being the first. */
7287static void vmMarkPagesUsed(off_t page, off_t count) {
7288 off_t j;
7289
7290 for (j = 0; j < count; j++)
7d30035d 7291 vmMarkPageUsed(page+j);
7d98e08c 7292 server.vm_stats_used_pages += count;
7c775e09 7293 redisLog(REDIS_DEBUG,"Mark USED pages: %lld pages at %lld\n",
7294 (long long)count, (long long)page);
06224fec 7295}
7296
7297/* Mark the page as free */
7298static void vmMarkPageFree(off_t page) {
7299 off_t byte = page/8;
7300 int bit = page&7;
970e10bb 7301 redisAssert(vmFreePage(page) == 0);
06224fec 7302 server.vm_bitmap[byte] &= ~(1<<bit);
7303}
7304
7305/* Mark N contiguous pages as free, with 'page' being the first. */
7306static void vmMarkPagesFree(off_t page, off_t count) {
7307 off_t j;
7308
7309 for (j = 0; j < count; j++)
7d30035d 7310 vmMarkPageFree(page+j);
7d98e08c 7311 server.vm_stats_used_pages -= count;
7c775e09 7312 redisLog(REDIS_DEBUG,"Mark FREE pages: %lld pages at %lld\n",
7313 (long long)count, (long long)page);
06224fec 7314}
7315
7316/* Test if the page is free */
7317static int vmFreePage(off_t page) {
7318 off_t byte = page/8;
7319 int bit = page&7;
7d30035d 7320 return (server.vm_bitmap[byte] & (1<<bit)) == 0;
06224fec 7321}
7322
7323/* Find N contiguous free pages storing the first page of the cluster in *first.
3a66edc7 7324 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
7325 * REDIS_ERR is returned.
06224fec 7326 *
7327 * This function uses a simple algorithm: we try to allocate
7328 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
7329 * again from the start of the swap file searching for free spaces.
7330 *
7331 * If it looks pretty clear that there are no free pages near our offset
7332 * we try to find less populated places doing a forward jump of
7333 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
7334 * without hurry, and then we jump again and so forth...
7335 *
7336 * This function can be improved using a free list to avoid to guess
7337 * too much, since we could collect data about freed pages.
7338 *
7339 * note: I implemented this function just after watching an episode of
7340 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
7341 */
c7df85a4 7342static int vmFindContiguousPages(off_t *first, off_t n) {
06224fec 7343 off_t base, offset = 0, since_jump = 0, numfree = 0;
7344
7345 if (server.vm_near_pages == REDIS_VM_MAX_NEAR_PAGES) {
7346 server.vm_near_pages = 0;
7347 server.vm_next_page = 0;
7348 }
7349 server.vm_near_pages++; /* Yet another try for pages near to the old ones */
7350 base = server.vm_next_page;
7351
7352 while(offset < server.vm_pages) {
7353 off_t this = base+offset;
7354
7355 /* If we overflow, restart from page zero */
7356 if (this >= server.vm_pages) {
7357 this -= server.vm_pages;
7358 if (this == 0) {
7359 /* Just overflowed, what we found on tail is no longer
7360 * interesting, as it's no longer contiguous. */
7361 numfree = 0;
7362 }
7363 }
7364 if (vmFreePage(this)) {
7365 /* This is a free page */
7366 numfree++;
7367 /* Already got N free pages? Return to the caller, with success */
7368 if (numfree == n) {
7d30035d 7369 *first = this-(n-1);
7370 server.vm_next_page = this+1;
7c775e09 7371 redisLog(REDIS_DEBUG, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n, (long long) *first);
3a66edc7 7372 return REDIS_OK;
06224fec 7373 }
7374 } else {
7375 /* The current one is not a free page */
7376 numfree = 0;
7377 }
7378
7379 /* Fast-forward if the current page is not free and we already
7380 * searched enough near this place. */
7381 since_jump++;
7382 if (!numfree && since_jump >= REDIS_VM_MAX_RANDOM_JUMP/4) {
7383 offset += random() % REDIS_VM_MAX_RANDOM_JUMP;
7384 since_jump = 0;
7385 /* Note that even if we rewind after the jump, we are don't need
7386 * to make sure numfree is set to zero as we only jump *if* it
7387 * is set to zero. */
7388 } else {
7389 /* Otherwise just check the next page */
7390 offset++;
7391 }
7392 }
3a66edc7 7393 return REDIS_ERR;
7394}
7395
a5819310 7396/* Write the specified object at the specified page of the swap file */
7397static int vmWriteObjectOnSwap(robj *o, off_t page) {
7398 if (server.vm_enabled) pthread_mutex_lock(&server.io_swapfile_mutex);
7399 if (fseeko(server.vm_fp,page*server.vm_page_size,SEEK_SET) == -1) {
7400 if (server.vm_enabled) pthread_mutex_unlock(&server.io_swapfile_mutex);
7401 redisLog(REDIS_WARNING,
9ebed7cf 7402 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
a5819310 7403 strerror(errno));
7404 return REDIS_ERR;
7405 }
7406 rdbSaveObject(server.vm_fp,o);
7407 if (server.vm_enabled) pthread_mutex_unlock(&server.io_swapfile_mutex);
7408 return REDIS_OK;
7409}
7410
3a66edc7 7411/* Swap the 'val' object relative to 'key' into disk. Store all the information
7412 * needed to later retrieve the object into the key object.
7413 * If we can't find enough contiguous empty pages to swap the object on disk
7414 * REDIS_ERR is returned. */
a69a0c9c 7415static int vmSwapObjectBlocking(robj *key, robj *val) {
b9bc0eef 7416 off_t pages = rdbSavedObjectPages(val,NULL);
3a66edc7 7417 off_t page;
7418
7419 assert(key->storage == REDIS_VM_MEMORY);
4ef8de8a 7420 assert(key->refcount == 1);
3a66edc7 7421 if (vmFindContiguousPages(&page,pages) == REDIS_ERR) return REDIS_ERR;
a5819310 7422 if (vmWriteObjectOnSwap(val,page) == REDIS_ERR) return REDIS_ERR;
3a66edc7 7423 key->vm.page = page;
7424 key->vm.usedpages = pages;
7425 key->storage = REDIS_VM_SWAPPED;
d894161b 7426 key->vtype = val->type;
3a66edc7 7427 decrRefCount(val); /* Deallocate the object from memory. */
7428 vmMarkPagesUsed(page,pages);
7d30035d 7429 redisLog(REDIS_DEBUG,"VM: object %s swapped out at %lld (%lld pages)",
7430 (unsigned char*) key->ptr,
7431 (unsigned long long) page, (unsigned long long) pages);
7d98e08c 7432 server.vm_stats_swapped_objects++;
7433 server.vm_stats_swapouts++;
0841cc92 7434 fflush(server.vm_fp);
3a66edc7 7435 return REDIS_OK;
7436}
7437
a5819310 7438static robj *vmReadObjectFromSwap(off_t page, int type) {
7439 robj *o;
3a66edc7 7440
a5819310 7441 if (server.vm_enabled) pthread_mutex_lock(&server.io_swapfile_mutex);
7442 if (fseeko(server.vm_fp,page*server.vm_page_size,SEEK_SET) == -1) {
3a66edc7 7443 redisLog(REDIS_WARNING,
d5d55fc3 7444 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
3a66edc7 7445 strerror(errno));
478c2c6f 7446 _exit(1);
3a66edc7 7447 }
a5819310 7448 o = rdbLoadObject(type,server.vm_fp);
7449 if (o == NULL) {
d5d55fc3 7450 redisLog(REDIS_WARNING, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno));
478c2c6f 7451 _exit(1);
3a66edc7 7452 }
a5819310 7453 if (server.vm_enabled) pthread_mutex_unlock(&server.io_swapfile_mutex);
7454 return o;
7455}
7456
7457/* Load the value object relative to the 'key' object from swap to memory.
7458 * The newly allocated object is returned.
7459 *
7460 * If preview is true the unserialized object is returned to the caller but
7461 * no changes are made to the key object, nor the pages are marked as freed */
7462static robj *vmGenericLoadObject(robj *key, int preview) {
7463 robj *val;
7464
d5d55fc3 7465 redisAssert(key->storage == REDIS_VM_SWAPPED || key->storage == REDIS_VM_LOADING);
a5819310 7466 val = vmReadObjectFromSwap(key->vm.page,key->vtype);
7e69548d 7467 if (!preview) {
7468 key->storage = REDIS_VM_MEMORY;
7469 key->vm.atime = server.unixtime;
7470 vmMarkPagesFree(key->vm.page,key->vm.usedpages);
7471 redisLog(REDIS_DEBUG, "VM: object %s loaded from disk",
7472 (unsigned char*) key->ptr);
7d98e08c 7473 server.vm_stats_swapped_objects--;
38aba9a1 7474 } else {
7475 redisLog(REDIS_DEBUG, "VM: object %s previewed from disk",
7476 (unsigned char*) key->ptr);
7e69548d 7477 }
7d98e08c 7478 server.vm_stats_swapins++;
3a66edc7 7479 return val;
06224fec 7480}
7481
7e69548d 7482/* Plain object loading, from swap to memory */
7483static robj *vmLoadObject(robj *key) {
996cb5f7 7484 /* If we are loading the object in background, stop it, we
7485 * need to load this object synchronously ASAP. */
7486 if (key->storage == REDIS_VM_LOADING)
7487 vmCancelThreadedIOJob(key);
7e69548d 7488 return vmGenericLoadObject(key,0);
7489}
7490
7491/* Just load the value on disk, without to modify the key.
7492 * This is useful when we want to perform some operation on the value
7493 * without to really bring it from swap to memory, like while saving the
7494 * dataset or rewriting the append only log. */
7495static robj *vmPreviewObject(robj *key) {
7496 return vmGenericLoadObject(key,1);
7497}
7498
4ef8de8a 7499/* How a good candidate is this object for swapping?
7500 * The better candidate it is, the greater the returned value.
7501 *
7502 * Currently we try to perform a fast estimation of the object size in
7503 * memory, and combine it with aging informations.
7504 *
7505 * Basically swappability = idle-time * log(estimated size)
7506 *
7507 * Bigger objects are preferred over smaller objects, but not
7508 * proportionally, this is why we use the logarithm. This algorithm is
7509 * just a first try and will probably be tuned later. */
7510static double computeObjectSwappability(robj *o) {
7511 time_t age = server.unixtime - o->vm.atime;
7512 long asize = 0;
7513 list *l;
7514 dict *d;
7515 struct dictEntry *de;
7516 int z;
7517
7518 if (age <= 0) return 0;
7519 switch(o->type) {
7520 case REDIS_STRING:
7521 if (o->encoding != REDIS_ENCODING_RAW) {
7522 asize = sizeof(*o);
7523 } else {
7524 asize = sdslen(o->ptr)+sizeof(*o)+sizeof(long)*2;
7525 }
7526 break;
7527 case REDIS_LIST:
7528 l = o->ptr;
7529 listNode *ln = listFirst(l);
7530
7531 asize = sizeof(list);
7532 if (ln) {
7533 robj *ele = ln->value;
7534 long elesize;
7535
7536 elesize = (ele->encoding == REDIS_ENCODING_RAW) ?
7537 (sizeof(*o)+sdslen(ele->ptr)) :
7538 sizeof(*o);
7539 asize += (sizeof(listNode)+elesize)*listLength(l);
7540 }
7541 break;
7542 case REDIS_SET:
7543 case REDIS_ZSET:
7544 z = (o->type == REDIS_ZSET);
7545 d = z ? ((zset*)o->ptr)->dict : o->ptr;
7546
7547 asize = sizeof(dict)+(sizeof(struct dictEntry*)*dictSlots(d));
7548 if (z) asize += sizeof(zset)-sizeof(dict);
7549 if (dictSize(d)) {
7550 long elesize;
7551 robj *ele;
7552
7553 de = dictGetRandomKey(d);
7554 ele = dictGetEntryKey(de);
7555 elesize = (ele->encoding == REDIS_ENCODING_RAW) ?
7556 (sizeof(*o)+sdslen(ele->ptr)) :
7557 sizeof(*o);
7558 asize += (sizeof(struct dictEntry)+elesize)*dictSize(d);
7559 if (z) asize += sizeof(zskiplistNode)*dictSize(d);
7560 }
7561 break;
7562 }
7563 return (double)asize*log(1+asize);
7564}
7565
7566/* Try to swap an object that's a good candidate for swapping.
7567 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
a69a0c9c 7568 * to swap any object at all.
7569 *
7570 * If 'usethreaded' is true, Redis will try to swap the object in background
7571 * using I/O threads. */
7572static int vmSwapOneObject(int usethreads) {
4ef8de8a 7573 int j, i;
7574 struct dictEntry *best = NULL;
7575 double best_swappability = 0;
b9bc0eef 7576 redisDb *best_db = NULL;
4ef8de8a 7577 robj *key, *val;
7578
7579 for (j = 0; j < server.dbnum; j++) {
7580 redisDb *db = server.db+j;
b72f6a4b 7581 /* Why maxtries is set to 100?
7582 * Because this way (usually) we'll find 1 object even if just 1% - 2%
7583 * are swappable objects */
b0d8747d 7584 int maxtries = 100;
4ef8de8a 7585
7586 if (dictSize(db->dict) == 0) continue;
7587 for (i = 0; i < 5; i++) {
7588 dictEntry *de;
7589 double swappability;
7590
e3cadb8a 7591 if (maxtries) maxtries--;
4ef8de8a 7592 de = dictGetRandomKey(db->dict);
7593 key = dictGetEntryKey(de);
7594 val = dictGetEntryVal(de);
1064ef87 7595 /* Only swap objects that are currently in memory.
7596 *
7597 * Also don't swap shared objects if threaded VM is on, as we
7598 * try to ensure that the main thread does not touch the
7599 * object while the I/O thread is using it, but we can't
7600 * control other keys without adding additional mutex. */
7601 if (key->storage != REDIS_VM_MEMORY ||
7602 (server.vm_max_threads != 0 && val->refcount != 1)) {
e3cadb8a 7603 if (maxtries) i--; /* don't count this try */
7604 continue;
7605 }
4ef8de8a 7606 swappability = computeObjectSwappability(val);
7607 if (!best || swappability > best_swappability) {
7608 best = de;
7609 best_swappability = swappability;
b9bc0eef 7610 best_db = db;
4ef8de8a 7611 }
7612 }
7613 }
7c775e09 7614 if (best == NULL) return REDIS_ERR;
4ef8de8a 7615 key = dictGetEntryKey(best);
7616 val = dictGetEntryVal(best);
7617
e3cadb8a 7618 redisLog(REDIS_DEBUG,"Key with best swappability: %s, %f",
4ef8de8a 7619 key->ptr, best_swappability);
7620
7621 /* Unshare the key if needed */
7622 if (key->refcount > 1) {
7623 robj *newkey = dupStringObject(key);
7624 decrRefCount(key);
7625 key = dictGetEntryKey(best) = newkey;
7626 }
7627 /* Swap it */
a69a0c9c 7628 if (usethreads) {
b9bc0eef 7629 vmSwapObjectThreaded(key,val,best_db);
4ef8de8a 7630 return REDIS_OK;
7631 } else {
a69a0c9c 7632 if (vmSwapObjectBlocking(key,val) == REDIS_OK) {
7633 dictGetEntryVal(best) = NULL;
7634 return REDIS_OK;
7635 } else {
7636 return REDIS_ERR;
7637 }
4ef8de8a 7638 }
7639}
7640
a69a0c9c 7641static int vmSwapOneObjectBlocking() {
7642 return vmSwapOneObject(0);
7643}
7644
7645static int vmSwapOneObjectThreaded() {
7646 return vmSwapOneObject(1);
7647}
7648
7e69548d 7649/* Return true if it's safe to swap out objects in a given moment.
7650 * Basically we don't want to swap objects out while there is a BGSAVE
7651 * or a BGAEOREWRITE running in backgroud. */
7652static int vmCanSwapOut(void) {
7653 return (server.bgsavechildpid == -1 && server.bgrewritechildpid == -1);
7654}
7655
1b03836c 7656/* Delete a key if swapped. Returns 1 if the key was found, was swapped
7657 * and was deleted. Otherwise 0 is returned. */
7658static int deleteIfSwapped(redisDb *db, robj *key) {
7659 dictEntry *de;
7660 robj *foundkey;
7661
7662 if ((de = dictFind(db->dict,key)) == NULL) return 0;
7663 foundkey = dictGetEntryKey(de);
7664 if (foundkey->storage == REDIS_VM_MEMORY) return 0;
7665 deleteKey(db,key);
7666 return 1;
7667}
7668
996cb5f7 7669/* =================== Virtual Memory - Threaded I/O ======================= */
7670
b9bc0eef 7671static void freeIOJob(iojob *j) {
d5d55fc3 7672 if ((j->type == REDIS_IOJOB_PREPARE_SWAP ||
7673 j->type == REDIS_IOJOB_DO_SWAP ||
7674 j->type == REDIS_IOJOB_LOAD) && j->val != NULL)
b9bc0eef 7675 decrRefCount(j->val);
7676 decrRefCount(j->key);
7677 zfree(j);
7678}
7679
996cb5f7 7680/* Every time a thread finished a Job, it writes a byte into the write side
7681 * of an unix pipe in order to "awake" the main thread, and this function
7682 * is called. */
7683static void vmThreadedIOCompletedJob(aeEventLoop *el, int fd, void *privdata,
7684 int mask)
7685{
7686 char buf[1];
b0d8747d 7687 int retval, processed = 0, toprocess = -1, trytoswap = 1;
996cb5f7 7688 REDIS_NOTUSED(el);
7689 REDIS_NOTUSED(mask);
7690 REDIS_NOTUSED(privdata);
7691
7692 /* For every byte we read in the read side of the pipe, there is one
7693 * I/O job completed to process. */
7694 while((retval = read(fd,buf,1)) == 1) {
b9bc0eef 7695 iojob *j;
7696 listNode *ln;
7697 robj *key;
7698 struct dictEntry *de;
7699
996cb5f7 7700 redisLog(REDIS_DEBUG,"Processing I/O completed job");
b9bc0eef 7701
7702 /* Get the processed element (the oldest one) */
7703 lockThreadedIO();
1064ef87 7704 assert(listLength(server.io_processed) != 0);
f6c0bba8 7705 if (toprocess == -1) {
7706 toprocess = (listLength(server.io_processed)*REDIS_MAX_COMPLETED_JOBS_PROCESSED)/100;
7707 if (toprocess <= 0) toprocess = 1;
7708 }
b9bc0eef 7709 ln = listFirst(server.io_processed);
7710 j = ln->value;
7711 listDelNode(server.io_processed,ln);
7712 unlockThreadedIO();
7713 /* If this job is marked as canceled, just ignore it */
7714 if (j->canceled) {
7715 freeIOJob(j);
7716 continue;
7717 }
7718 /* Post process it in the main thread, as there are things we
7719 * can do just here to avoid race conditions and/or invasive locks */
6c96ba7d 7720 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 7721 de = dictFind(j->db->dict,j->key);
7722 assert(de != NULL);
7723 key = dictGetEntryKey(de);
7724 if (j->type == REDIS_IOJOB_LOAD) {
d5d55fc3 7725 redisDb *db;
7726
b9bc0eef 7727 /* Key loaded, bring it at home */
7728 key->storage = REDIS_VM_MEMORY;
7729 key->vm.atime = server.unixtime;
7730 vmMarkPagesFree(key->vm.page,key->vm.usedpages);
7731 redisLog(REDIS_DEBUG, "VM: object %s loaded from disk (threaded)",
7732 (unsigned char*) key->ptr);
7733 server.vm_stats_swapped_objects--;
7734 server.vm_stats_swapins++;
d5d55fc3 7735 dictGetEntryVal(de) = j->val;
7736 incrRefCount(j->val);
7737 db = j->db;
b9bc0eef 7738 freeIOJob(j);
d5d55fc3 7739 /* Handle clients waiting for this key to be loaded. */
7740 handleClientsBlockedOnSwappedKey(db,key);
b9bc0eef 7741 } else if (j->type == REDIS_IOJOB_PREPARE_SWAP) {
7742 /* Now we know the amount of pages required to swap this object.
7743 * Let's find some space for it, and queue this task again
7744 * rebranded as REDIS_IOJOB_DO_SWAP. */
054e426d 7745 if (!vmCanSwapOut() ||
7746 vmFindContiguousPages(&j->page,j->pages) == REDIS_ERR)
7747 {
7748 /* Ooops... no space or we can't swap as there is
7749 * a fork()ed Redis trying to save stuff on disk. */
b9bc0eef 7750 freeIOJob(j);
054e426d 7751 key->storage = REDIS_VM_MEMORY; /* undo operation */
b9bc0eef 7752 } else {
c7df85a4 7753 /* Note that we need to mark this pages as used now,
7754 * if the job will be canceled, we'll mark them as freed
7755 * again. */
7756 vmMarkPagesUsed(j->page,j->pages);
b9bc0eef 7757 j->type = REDIS_IOJOB_DO_SWAP;
7758 lockThreadedIO();
7759 queueIOJob(j);
7760 unlockThreadedIO();
7761 }
7762 } else if (j->type == REDIS_IOJOB_DO_SWAP) {
7763 robj *val;
7764
7765 /* Key swapped. We can finally free some memory. */
6c96ba7d 7766 if (key->storage != REDIS_VM_SWAPPING) {
7767 printf("key->storage: %d\n",key->storage);
7768 printf("key->name: %s\n",(char*)key->ptr);
7769 printf("key->refcount: %d\n",key->refcount);
7770 printf("val: %p\n",(void*)j->val);
7771 printf("val->type: %d\n",j->val->type);
7772 printf("val->ptr: %s\n",(char*)j->val->ptr);
7773 }
7774 redisAssert(key->storage == REDIS_VM_SWAPPING);
b9bc0eef 7775 val = dictGetEntryVal(de);
7776 key->vm.page = j->page;
7777 key->vm.usedpages = j->pages;
7778 key->storage = REDIS_VM_SWAPPED;
7779 key->vtype = j->val->type;
7780 decrRefCount(val); /* Deallocate the object from memory. */
f11b8647 7781 dictGetEntryVal(de) = NULL;
b9bc0eef 7782 redisLog(REDIS_DEBUG,
7783 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
7784 (unsigned char*) key->ptr,
7785 (unsigned long long) j->page, (unsigned long long) j->pages);
7786 server.vm_stats_swapped_objects++;
7787 server.vm_stats_swapouts++;
7788 freeIOJob(j);
f11b8647 7789 /* Put a few more swap requests in queue if we are still
7790 * out of memory */
b0d8747d 7791 if (trytoswap && vmCanSwapOut() &&
7792 zmalloc_used_memory() > server.vm_max_memory)
7793 {
f11b8647 7794 int more = 1;
7795 while(more) {
7796 lockThreadedIO();
7797 more = listLength(server.io_newjobs) <
7798 (unsigned) server.vm_max_threads;
7799 unlockThreadedIO();
7800 /* Don't waste CPU time if swappable objects are rare. */
b0d8747d 7801 if (vmSwapOneObjectThreaded() == REDIS_ERR) {
7802 trytoswap = 0;
7803 break;
7804 }
f11b8647 7805 }
7806 }
b9bc0eef 7807 }
c953f24b 7808 processed++;
f6c0bba8 7809 if (processed == toprocess) return;
996cb5f7 7810 }
7811 if (retval < 0 && errno != EAGAIN) {
7812 redisLog(REDIS_WARNING,
7813 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
7814 strerror(errno));
7815 }
7816}
7817
7818static void lockThreadedIO(void) {
7819 pthread_mutex_lock(&server.io_mutex);
7820}
7821
7822static void unlockThreadedIO(void) {
7823 pthread_mutex_unlock(&server.io_mutex);
7824}
7825
7826/* Remove the specified object from the threaded I/O queue if still not
7827 * processed, otherwise make sure to flag it as canceled. */
7828static void vmCancelThreadedIOJob(robj *o) {
7829 list *lists[3] = {
6c96ba7d 7830 server.io_newjobs, /* 0 */
7831 server.io_processing, /* 1 */
7832 server.io_processed /* 2 */
996cb5f7 7833 };
7834 int i;
7835
7836 assert(o->storage == REDIS_VM_LOADING || o->storage == REDIS_VM_SWAPPING);
2e111efe 7837again:
996cb5f7 7838 lockThreadedIO();
7839 /* Search for a matching key in one of the queues */
7840 for (i = 0; i < 3; i++) {
7841 listNode *ln;
c7df85a4 7842 listIter li;
996cb5f7 7843
c7df85a4 7844 listRewind(lists[i],&li);
7845 while ((ln = listNext(&li)) != NULL) {
996cb5f7 7846 iojob *job = ln->value;
7847
6c96ba7d 7848 if (job->canceled) continue; /* Skip this, already canceled. */
996cb5f7 7849 if (compareStringObjects(job->key,o) == 0) {
970e10bb 7850 redisLog(REDIS_DEBUG,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
7851 (void*)job, (char*)o->ptr, job->type, i);
427a2153 7852 /* Mark the pages as free since the swap didn't happened
7853 * or happened but is now discarded. */
970e10bb 7854 if (i != 1 && job->type == REDIS_IOJOB_DO_SWAP)
427a2153 7855 vmMarkPagesFree(job->page,job->pages);
7856 /* Cancel the job. It depends on the list the job is
7857 * living in. */
996cb5f7 7858 switch(i) {
7859 case 0: /* io_newjobs */
6c96ba7d 7860 /* If the job was yet not processed the best thing to do
996cb5f7 7861 * is to remove it from the queue at all */
6c96ba7d 7862 freeIOJob(job);
996cb5f7 7863 listDelNode(lists[i],ln);
7864 break;
7865 case 1: /* io_processing */
d5d55fc3 7866 /* Oh Shi- the thread is messing with the Job:
7867 *
7868 * Probably it's accessing the object if this is a
7869 * PREPARE_SWAP or DO_SWAP job.
7870 * If it's a LOAD job it may be reading from disk and
7871 * if we don't wait for the job to terminate before to
7872 * cancel it, maybe in a few microseconds data can be
7873 * corrupted in this pages. So the short story is:
7874 *
7875 * Better to wait for the job to move into the
7876 * next queue (processed)... */
7877
7878 /* We try again and again until the job is completed. */
7879 unlockThreadedIO();
7880 /* But let's wait some time for the I/O thread
7881 * to finish with this job. After all this condition
7882 * should be very rare. */
7883 usleep(1);
7884 goto again;
996cb5f7 7885 case 2: /* io_processed */
2e111efe 7886 /* The job was already processed, that's easy...
7887 * just mark it as canceled so that we'll ignore it
7888 * when processing completed jobs. */
996cb5f7 7889 job->canceled = 1;
7890 break;
7891 }
c7df85a4 7892 /* Finally we have to adjust the storage type of the object
7893 * in order to "UNDO" the operaiton. */
996cb5f7 7894 if (o->storage == REDIS_VM_LOADING)
7895 o->storage = REDIS_VM_SWAPPED;
7896 else if (o->storage == REDIS_VM_SWAPPING)
7897 o->storage = REDIS_VM_MEMORY;
7898 unlockThreadedIO();
7899 return;
7900 }
7901 }
7902 }
7903 unlockThreadedIO();
7904 assert(1 != 1); /* We should never reach this */
7905}
7906
b9bc0eef 7907static void *IOThreadEntryPoint(void *arg) {
7908 iojob *j;
7909 listNode *ln;
7910 REDIS_NOTUSED(arg);
7911
7912 pthread_detach(pthread_self());
7913 while(1) {
7914 /* Get a new job to process */
7915 lockThreadedIO();
7916 if (listLength(server.io_newjobs) == 0) {
7917 /* No new jobs in queue, exit. */
9ebed7cf 7918 redisLog(REDIS_DEBUG,"Thread %ld exiting, nothing to do",
7919 (long) pthread_self());
b9bc0eef 7920 server.io_active_threads--;
7921 unlockThreadedIO();
7922 return NULL;
7923 }
7924 ln = listFirst(server.io_newjobs);
7925 j = ln->value;
7926 listDelNode(server.io_newjobs,ln);
7927 /* Add the job in the processing queue */
7928 j->thread = pthread_self();
7929 listAddNodeTail(server.io_processing,j);
7930 ln = listLast(server.io_processing); /* We use ln later to remove it */
7931 unlockThreadedIO();
9ebed7cf 7932 redisLog(REDIS_DEBUG,"Thread %ld got a new job (type %d): %p about key '%s'",
7933 (long) pthread_self(), j->type, (void*)j, (char*)j->key->ptr);
b9bc0eef 7934
7935 /* Process the Job */
7936 if (j->type == REDIS_IOJOB_LOAD) {
d5d55fc3 7937 j->val = vmReadObjectFromSwap(j->page,j->key->vtype);
b9bc0eef 7938 } else if (j->type == REDIS_IOJOB_PREPARE_SWAP) {
7939 FILE *fp = fopen("/dev/null","w+");
7940 j->pages = rdbSavedObjectPages(j->val,fp);
7941 fclose(fp);
7942 } else if (j->type == REDIS_IOJOB_DO_SWAP) {
a5819310 7943 if (vmWriteObjectOnSwap(j->val,j->page) == REDIS_ERR)
7944 j->canceled = 1;
b9bc0eef 7945 }
7946
7947 /* Done: insert the job into the processed queue */
9ebed7cf 7948 redisLog(REDIS_DEBUG,"Thread %ld completed the job: %p (key %s)",
7949 (long) pthread_self(), (void*)j, (char*)j->key->ptr);
b9bc0eef 7950 lockThreadedIO();
7951 listDelNode(server.io_processing,ln);
7952 listAddNodeTail(server.io_processed,j);
7953 unlockThreadedIO();
7954
7955 /* Signal the main thread there is new stuff to process */
7956 assert(write(server.io_ready_pipe_write,"x",1) == 1);
7957 }
7958 return NULL; /* never reached */
7959}
7960
7961static void spawnIOThread(void) {
7962 pthread_t thread;
478c2c6f 7963 sigset_t mask, omask;
b9bc0eef 7964
478c2c6f 7965 sigemptyset(&mask);
7966 sigaddset(&mask,SIGCHLD);
7967 sigaddset(&mask,SIGHUP);
7968 sigaddset(&mask,SIGPIPE);
7969 pthread_sigmask(SIG_SETMASK, &mask, &omask);
bcaa7a4f 7970 pthread_create(&thread,&server.io_threads_attr,IOThreadEntryPoint,NULL);
478c2c6f 7971 pthread_sigmask(SIG_SETMASK, &omask, NULL);
b9bc0eef 7972 server.io_active_threads++;
7973}
7974
4ee9488d 7975/* We need to wait for the last thread to exit before we are able to
7976 * fork() in order to BGSAVE or BGREWRITEAOF. */
054e426d 7977static void waitEmptyIOJobsQueue(void) {
4ee9488d 7978 while(1) {
76b7233a 7979 int io_processed_len;
7980
4ee9488d 7981 lockThreadedIO();
054e426d 7982 if (listLength(server.io_newjobs) == 0 &&
7983 listLength(server.io_processing) == 0 &&
7984 server.io_active_threads == 0)
7985 {
4ee9488d 7986 unlockThreadedIO();
7987 return;
7988 }
76b7233a 7989 /* While waiting for empty jobs queue condition we post-process some
7990 * finshed job, as I/O threads may be hanging trying to write against
7991 * the io_ready_pipe_write FD but there are so much pending jobs that
7992 * it's blocking. */
7993 io_processed_len = listLength(server.io_processed);
4ee9488d 7994 unlockThreadedIO();
76b7233a 7995 if (io_processed_len) {
7996 vmThreadedIOCompletedJob(NULL,server.io_ready_pipe_read,NULL,0);
7997 usleep(1000); /* 1 millisecond */
7998 } else {
7999 usleep(10000); /* 10 milliseconds */
8000 }
4ee9488d 8001 }
8002}
8003
054e426d 8004static void vmReopenSwapFile(void) {
478c2c6f 8005 /* Note: we don't close the old one as we are in the child process
8006 * and don't want to mess at all with the original file object. */
054e426d 8007 server.vm_fp = fopen(server.vm_swap_file,"r+b");
8008 if (server.vm_fp == NULL) {
8009 redisLog(REDIS_WARNING,"Can't re-open the VM swap file: %s. Exiting.",
8010 server.vm_swap_file);
478c2c6f 8011 _exit(1);
054e426d 8012 }
8013 server.vm_fd = fileno(server.vm_fp);
8014}
8015
b9bc0eef 8016/* This function must be called while with threaded IO locked */
8017static void queueIOJob(iojob *j) {
6c96ba7d 8018 redisLog(REDIS_DEBUG,"Queued IO Job %p type %d about key '%s'\n",
8019 (void*)j, j->type, (char*)j->key->ptr);
b9bc0eef 8020 listAddNodeTail(server.io_newjobs,j);
8021 if (server.io_active_threads < server.vm_max_threads)
8022 spawnIOThread();
8023}
8024
8025static int vmSwapObjectThreaded(robj *key, robj *val, redisDb *db) {
8026 iojob *j;
8027
8028 assert(key->storage == REDIS_VM_MEMORY);
8029 assert(key->refcount == 1);
8030
8031 j = zmalloc(sizeof(*j));
8032 j->type = REDIS_IOJOB_PREPARE_SWAP;
8033 j->db = db;
8034 j->key = dupStringObject(key);
8035 j->val = val;
8036 incrRefCount(val);
8037 j->canceled = 0;
8038 j->thread = (pthread_t) -1;
f11b8647 8039 key->storage = REDIS_VM_SWAPPING;
b9bc0eef 8040
8041 lockThreadedIO();
8042 queueIOJob(j);
8043 unlockThreadedIO();
8044 return REDIS_OK;
8045}
8046
b0d8747d 8047/* ============ Virtual Memory - Blocking clients on missing keys =========== */
8048
d5d55fc3 8049/* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
8050 * If there is not already a job loading the key, it is craeted.
8051 * The key is added to the io_keys list in the client structure, and also
8052 * in the hash table mapping swapped keys to waiting clients, that is,
8053 * server.io_waited_keys. */
8054static int waitForSwappedKey(redisClient *c, robj *key) {
8055 struct dictEntry *de;
8056 robj *o;
8057 list *l;
8058
8059 /* If the key does not exist or is already in RAM we don't need to
8060 * block the client at all. */
8061 de = dictFind(c->db->dict,key);
8062 if (de == NULL) return 0;
8063 o = dictGetEntryKey(de);
8064 if (o->storage == REDIS_VM_MEMORY) {
8065 return 0;
8066 } else if (o->storage == REDIS_VM_SWAPPING) {
8067 /* We were swapping the key, undo it! */
8068 vmCancelThreadedIOJob(o);
8069 return 0;
8070 }
8071
8072 /* OK: the key is either swapped, or being loaded just now. */
8073
8074 /* Add the key to the list of keys this client is waiting for.
8075 * This maps clients to keys they are waiting for. */
8076 listAddNodeTail(c->io_keys,key);
8077 incrRefCount(key);
8078
8079 /* Add the client to the swapped keys => clients waiting map. */
8080 de = dictFind(c->db->io_keys,key);
8081 if (de == NULL) {
8082 int retval;
8083
8084 /* For every key we take a list of clients blocked for it */
8085 l = listCreate();
8086 retval = dictAdd(c->db->io_keys,key,l);
8087 incrRefCount(key);
8088 assert(retval == DICT_OK);
8089 } else {
8090 l = dictGetEntryVal(de);
8091 }
8092 listAddNodeTail(l,c);
8093
8094 /* Are we already loading the key from disk? If not create a job */
8095 if (o->storage == REDIS_VM_SWAPPED) {
8096 iojob *j;
8097
8098 o->storage = REDIS_VM_LOADING;
8099 j = zmalloc(sizeof(*j));
8100 j->type = REDIS_IOJOB_LOAD;
8101 j->db = c->db;
8102 j->key = dupStringObject(key);
8103 j->key->vtype = o->vtype;
8104 j->page = o->vm.page;
8105 j->val = NULL;
8106 j->canceled = 0;
8107 j->thread = (pthread_t) -1;
8108 lockThreadedIO();
8109 queueIOJob(j);
8110 unlockThreadedIO();
8111 }
8112 return 1;
8113}
8114
b0d8747d 8115/* Is this client attempting to run a command against swapped keys?
d5d55fc3 8116 * If so, block it ASAP, load the keys in background, then resume it.
b0d8747d 8117 *
d5d55fc3 8118 * The important idea about this function is that it can fail! If keys will
8119 * still be swapped when the client is resumed, this key lookups will
8120 * just block loading keys from disk. In practical terms this should only
8121 * happen with SORT BY command or if there is a bug in this function.
8122 *
8123 * Return 1 if the client is marked as blocked, 0 if the client can
8124 * continue as the keys it is going to access appear to be in memory. */
8125static int blockClientOnSwappedKeys(struct redisCommand *cmd, redisClient *c) {
7c775e09 8126 int j, last;
8127
8128 if (cmd->vm_firstkey == 0) return 0;
8129 last = cmd->vm_lastkey;
8130 if (last < 0) last = c->argc+last;
8131 for (j = cmd->vm_firstkey; j <= last; j += cmd->vm_keystep)
8132 waitForSwappedKey(c,c->argv[j]);
d5d55fc3 8133 /* If the client was blocked for at least one key, mark it as blocked. */
8134 if (listLength(c->io_keys)) {
8135 c->flags |= REDIS_IO_WAIT;
8136 aeDeleteFileEvent(server.el,c->fd,AE_READABLE);
8137 server.vm_blocked_clients++;
8138 return 1;
8139 } else {
8140 return 0;
8141 }
8142}
8143
8144/* Remove the 'key' from the list of blocked keys for a given client.
8145 *
8146 * The function returns 1 when there are no longer blocking keys after
8147 * the current one was removed (and the client can be unblocked). */
8148static int dontWaitForSwappedKey(redisClient *c, robj *key) {
8149 list *l;
8150 listNode *ln;
8151 listIter li;
8152 struct dictEntry *de;
8153
8154 /* Remove the key from the list of keys this client is waiting for. */
8155 listRewind(c->io_keys,&li);
8156 while ((ln = listNext(&li)) != NULL) {
8157 if (compareStringObjects(ln->value,key) == 0) {
8158 listDelNode(c->io_keys,ln);
8159 break;
8160 }
8161 }
8162 assert(ln != NULL);
8163
8164 /* Remove the client form the key => waiting clients map. */
8165 de = dictFind(c->db->io_keys,key);
8166 assert(de != NULL);
8167 l = dictGetEntryVal(de);
8168 ln = listSearchKey(l,c);
8169 assert(ln != NULL);
8170 listDelNode(l,ln);
8171 if (listLength(l) == 0)
8172 dictDelete(c->db->io_keys,key);
8173
8174 return listLength(c->io_keys) == 0;
8175}
8176
8177static void handleClientsBlockedOnSwappedKey(redisDb *db, robj *key) {
8178 struct dictEntry *de;
8179 list *l;
8180 listNode *ln;
8181 int len;
8182
8183 de = dictFind(db->io_keys,key);
8184 if (!de) return;
8185
8186 l = dictGetEntryVal(de);
8187 len = listLength(l);
8188 /* Note: we can't use something like while(listLength(l)) as the list
8189 * can be freed by the calling function when we remove the last element. */
8190 while (len--) {
8191 ln = listFirst(l);
8192 redisClient *c = ln->value;
8193
8194 if (dontWaitForSwappedKey(c,key)) {
8195 /* Put the client in the list of clients ready to go as we
8196 * loaded all the keys about it. */
8197 listAddNodeTail(server.io_ready_clients,c);
8198 }
8199 }
b0d8747d 8200}
b0d8747d 8201
7f957c92 8202/* ================================= Debugging ============================== */
8203
8204static void debugCommand(redisClient *c) {
8205 if (!strcasecmp(c->argv[1]->ptr,"segfault")) {
8206 *((char*)-1) = 'x';
210e29f7 8207 } else if (!strcasecmp(c->argv[1]->ptr,"reload")) {
8208 if (rdbSave(server.dbfilename) != REDIS_OK) {
8209 addReply(c,shared.err);
8210 return;
8211 }
8212 emptyDb();
8213 if (rdbLoad(server.dbfilename) != REDIS_OK) {
8214 addReply(c,shared.err);
8215 return;
8216 }
8217 redisLog(REDIS_WARNING,"DB reloaded by DEBUG RELOAD");
8218 addReply(c,shared.ok);
71c2b467 8219 } else if (!strcasecmp(c->argv[1]->ptr,"loadaof")) {
8220 emptyDb();
8221 if (loadAppendOnlyFile(server.appendfilename) != REDIS_OK) {
8222 addReply(c,shared.err);
8223 return;
8224 }
8225 redisLog(REDIS_WARNING,"Append Only File loaded by DEBUG LOADAOF");
8226 addReply(c,shared.ok);
333298da 8227 } else if (!strcasecmp(c->argv[1]->ptr,"object") && c->argc == 3) {
8228 dictEntry *de = dictFind(c->db->dict,c->argv[2]);
8229 robj *key, *val;
8230
8231 if (!de) {
8232 addReply(c,shared.nokeyerr);
8233 return;
8234 }
8235 key = dictGetEntryKey(de);
8236 val = dictGetEntryVal(de);
59146ef3 8237 if (!server.vm_enabled || (key->storage == REDIS_VM_MEMORY ||
8238 key->storage == REDIS_VM_SWAPPING)) {
ace06542 8239 addReplySds(c,sdscatprintf(sdsempty(),
8240 "+Key at:%p refcount:%d, value at:%p refcount:%d "
8241 "encoding:%d serializedlength:%lld\r\n",
682ac724 8242 (void*)key, key->refcount, (void*)val, val->refcount,
459f52a8 8243 val->encoding, (long long) rdbSavedObjectLen(val,NULL)));
ace06542 8244 } else {
8245 addReplySds(c,sdscatprintf(sdsempty(),
8246 "+Key at:%p refcount:%d, value swapped at: page %llu "
8247 "using %llu pages\r\n",
8248 (void*)key, key->refcount, (unsigned long long) key->vm.page,
8249 (unsigned long long) key->vm.usedpages));
8250 }
7d30035d 8251 } else if (!strcasecmp(c->argv[1]->ptr,"swapout") && c->argc == 3) {
8252 dictEntry *de = dictFind(c->db->dict,c->argv[2]);
8253 robj *key, *val;
8254
8255 if (!server.vm_enabled) {
8256 addReplySds(c,sdsnew("-ERR Virtual Memory is disabled\r\n"));
8257 return;
8258 }
8259 if (!de) {
8260 addReply(c,shared.nokeyerr);
8261 return;
8262 }
8263 key = dictGetEntryKey(de);
8264 val = dictGetEntryVal(de);
4ef8de8a 8265 /* If the key is shared we want to create a copy */
8266 if (key->refcount > 1) {
8267 robj *newkey = dupStringObject(key);
8268 decrRefCount(key);
8269 key = dictGetEntryKey(de) = newkey;
8270 }
8271 /* Swap it */
7d30035d 8272 if (key->storage != REDIS_VM_MEMORY) {
8273 addReplySds(c,sdsnew("-ERR This key is not in memory\r\n"));
a69a0c9c 8274 } else if (vmSwapObjectBlocking(key,val) == REDIS_OK) {
7d30035d 8275 dictGetEntryVal(de) = NULL;
8276 addReply(c,shared.ok);
8277 } else {
8278 addReply(c,shared.err);
8279 }
7f957c92 8280 } else {
333298da 8281 addReplySds(c,sdsnew(
7d30035d 8282 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPOUT <key>|RELOAD]\r\n"));
7f957c92 8283 }
8284}
56906eef 8285
6c96ba7d 8286static void _redisAssert(char *estr, char *file, int line) {
dfc5e96c 8287 redisLog(REDIS_WARNING,"=== ASSERTION FAILED ===");
6c96ba7d 8288 redisLog(REDIS_WARNING,"==> %s:%d '%s' is not true\n",file,line,estr);
dfc5e96c 8289#ifdef HAVE_BACKTRACE
8290 redisLog(REDIS_WARNING,"(forcing SIGSEGV in order to print the stack trace)");
8291 *((char*)-1) = 'x';
8292#endif
8293}
8294
bcfc686d 8295/* =================================== Main! ================================ */
56906eef 8296
bcfc686d 8297#ifdef __linux__
8298int linuxOvercommitMemoryValue(void) {
8299 FILE *fp = fopen("/proc/sys/vm/overcommit_memory","r");
8300 char buf[64];
56906eef 8301
bcfc686d 8302 if (!fp) return -1;
8303 if (fgets(buf,64,fp) == NULL) {
8304 fclose(fp);
8305 return -1;
8306 }
8307 fclose(fp);
56906eef 8308
bcfc686d 8309 return atoi(buf);
8310}
8311
8312void linuxOvercommitMemoryWarning(void) {
8313 if (linuxOvercommitMemoryValue() == 0) {
8314 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.");
8315 }
8316}
8317#endif /* __linux__ */
8318
8319static void daemonize(void) {
8320 int fd;
8321 FILE *fp;
8322
8323 if (fork() != 0) exit(0); /* parent exits */
8324 setsid(); /* create a new session */
8325
8326 /* Every output goes to /dev/null. If Redis is daemonized but
8327 * the 'logfile' is set to 'stdout' in the configuration file
8328 * it will not log at all. */
8329 if ((fd = open("/dev/null", O_RDWR, 0)) != -1) {
8330 dup2(fd, STDIN_FILENO);
8331 dup2(fd, STDOUT_FILENO);
8332 dup2(fd, STDERR_FILENO);
8333 if (fd > STDERR_FILENO) close(fd);
8334 }
8335 /* Try to write the pid file */
8336 fp = fopen(server.pidfile,"w");
8337 if (fp) {
8338 fprintf(fp,"%d\n",getpid());
8339 fclose(fp);
56906eef 8340 }
56906eef 8341}
8342
bcfc686d 8343int main(int argc, char **argv) {
9651a787 8344 time_t start;
8345
bcfc686d 8346 initServerConfig();
8347 if (argc == 2) {
8348 resetServerSaveParams();
8349 loadServerConfig(argv[1]);
8350 } else if (argc > 2) {
8351 fprintf(stderr,"Usage: ./redis-server [/path/to/redis.conf]\n");
8352 exit(1);
8353 } else {
8354 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'");
8355 }
bcfc686d 8356 if (server.daemonize) daemonize();
71c54b21 8357 initServer();
bcfc686d 8358 redisLog(REDIS_NOTICE,"Server started, Redis version " REDIS_VERSION);
8359#ifdef __linux__
8360 linuxOvercommitMemoryWarning();
8361#endif
9651a787 8362 start = time(NULL);
bcfc686d 8363 if (server.appendonly) {
8364 if (loadAppendOnlyFile(server.appendfilename) == REDIS_OK)
9651a787 8365 redisLog(REDIS_NOTICE,"DB loaded from append only file: %ld seconds",time(NULL)-start);
bcfc686d 8366 } else {
8367 if (rdbLoad(server.dbfilename) == REDIS_OK)
9651a787 8368 redisLog(REDIS_NOTICE,"DB loaded from disk: %ld seconds",time(NULL)-start);
bcfc686d 8369 }
bcfc686d 8370 redisLog(REDIS_NOTICE,"The server is now ready to accept connections on port %d", server.port);
d5d55fc3 8371 aeSetBeforeSleepProc(server.el,beforeSleep);
bcfc686d 8372 aeMain(server.el);
8373 aeDeleteEventLoop(server.el);
8374 return 0;
8375}
8376
8377/* ============================= Backtrace support ========================= */
8378
8379#ifdef HAVE_BACKTRACE
8380static char *findFuncName(void *pointer, unsigned long *offset);
8381
56906eef 8382static void *getMcontextEip(ucontext_t *uc) {
8383#if defined(__FreeBSD__)
8384 return (void*) uc->uc_mcontext.mc_eip;
8385#elif defined(__dietlibc__)
8386 return (void*) uc->uc_mcontext.eip;
06db1f50 8387#elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
da0a1620 8388 #if __x86_64__
8389 return (void*) uc->uc_mcontext->__ss.__rip;
8390 #else
56906eef 8391 return (void*) uc->uc_mcontext->__ss.__eip;
da0a1620 8392 #endif
06db1f50 8393#elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
cb7e07cc 8394 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
06db1f50 8395 return (void*) uc->uc_mcontext->__ss.__rip;
cbc59b38 8396 #else
8397 return (void*) uc->uc_mcontext->__ss.__eip;
8398 #endif
c04c9ac9 8399#elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
8400 return (void*) uc->uc_mcontext.gregs[REG_EIP]; /* Linux 32/64 bit */
b91cf5ef 8401#elif defined(__ia64__) /* Linux IA64 */
8402 return (void*) uc->uc_mcontext.sc_ip;
8403#else
8404 return NULL;
56906eef 8405#endif
8406}
8407
8408static void segvHandler(int sig, siginfo_t *info, void *secret) {
8409 void *trace[100];
8410 char **messages = NULL;
8411 int i, trace_size = 0;
8412 unsigned long offset=0;
56906eef 8413 ucontext_t *uc = (ucontext_t*) secret;
1c85b79f 8414 sds infostring;
56906eef 8415 REDIS_NOTUSED(info);
8416
8417 redisLog(REDIS_WARNING,
8418 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION, sig);
1c85b79f 8419 infostring = genRedisInfoString();
8420 redisLog(REDIS_WARNING, "%s",infostring);
8421 /* It's not safe to sdsfree() the returned string under memory
8422 * corruption conditions. Let it leak as we are going to abort */
56906eef 8423
8424 trace_size = backtrace(trace, 100);
de96dbfe 8425 /* overwrite sigaction with caller's address */
b91cf5ef 8426 if (getMcontextEip(uc) != NULL) {
8427 trace[1] = getMcontextEip(uc);
8428 }
56906eef 8429 messages = backtrace_symbols(trace, trace_size);
fe3bbfbe 8430
d76412d1 8431 for (i=1; i<trace_size; ++i) {
56906eef 8432 char *fn = findFuncName(trace[i], &offset), *p;
8433
8434 p = strchr(messages[i],'+');
8435 if (!fn || (p && ((unsigned long)strtol(p+1,NULL,10)) < offset)) {
8436 redisLog(REDIS_WARNING,"%s", messages[i]);
8437 } else {
8438 redisLog(REDIS_WARNING,"%d redis-server %p %s + %d", i, trace[i], fn, (unsigned int)offset);
8439 }
8440 }
b177fd30 8441 /* free(messages); Don't call free() with possibly corrupted memory. */
478c2c6f 8442 _exit(0);
fe3bbfbe 8443}
56906eef 8444
8445static void setupSigSegvAction(void) {
8446 struct sigaction act;
8447
8448 sigemptyset (&act.sa_mask);
8449 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
8450 * is used. Otherwise, sa_handler is used */
8451 act.sa_flags = SA_NODEFER | SA_ONSTACK | SA_RESETHAND | SA_SIGINFO;
8452 act.sa_sigaction = segvHandler;
8453 sigaction (SIGSEGV, &act, NULL);
8454 sigaction (SIGBUS, &act, NULL);
12fea928 8455 sigaction (SIGFPE, &act, NULL);
8456 sigaction (SIGILL, &act, NULL);
8457 sigaction (SIGBUS, &act, NULL);
e65fdc78 8458 return;
56906eef 8459}
e65fdc78 8460
bcfc686d 8461#include "staticsymbols.h"
8462/* This function try to convert a pointer into a function name. It's used in
8463 * oreder to provide a backtrace under segmentation fault that's able to
8464 * display functions declared as static (otherwise the backtrace is useless). */
8465static char *findFuncName(void *pointer, unsigned long *offset){
8466 int i, ret = -1;
8467 unsigned long off, minoff = 0;
ed9b544e 8468
bcfc686d 8469 /* Try to match against the Symbol with the smallest offset */
8470 for (i=0; symsTable[i].pointer; i++) {
8471 unsigned long lp = (unsigned long) pointer;
0bc03378 8472
bcfc686d 8473 if (lp != (unsigned long)-1 && lp >= symsTable[i].pointer) {
8474 off=lp-symsTable[i].pointer;
8475 if (ret < 0 || off < minoff) {
8476 minoff=off;
8477 ret=i;
8478 }
8479 }
0bc03378 8480 }
bcfc686d 8481 if (ret == -1) return NULL;
8482 *offset = minoff;
8483 return symsTable[ret].name;
0bc03378 8484}
bcfc686d 8485#else /* HAVE_BACKTRACE */
8486static void setupSigSegvAction(void) {
0bc03378 8487}
bcfc686d 8488#endif /* HAVE_BACKTRACE */
0bc03378 8489
ed9b544e 8490
ed9b544e 8491
bcfc686d 8492/* The End */
8493
8494
ed9b544e 8495