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