]> git.saurik.com Git - redis.git/blame - redis.c
fix LREM to remove *all* occurances when a zero argument is given
[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
9005896c 30#define REDIS_VERSION "2.1.1"
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>
40#include <signal.h>
fbf9bcdb 41
42#ifdef HAVE_BACKTRACE
c9468bcf 43#include <execinfo.h>
44#include <ucontext.h>
fbf9bcdb 45#endif /* HAVE_BACKTRACE */
46
ed9b544e 47#include <sys/wait.h>
48#include <errno.h>
49#include <assert.h>
50#include <ctype.h>
51#include <stdarg.h>
52#include <inttypes.h>
53#include <arpa/inet.h>
54#include <sys/stat.h>
55#include <fcntl.h>
56#include <sys/time.h>
57#include <sys/resource.h>
2895e862 58#include <sys/uio.h>
f78fd11b 59#include <limits.h>
fb82e75c 60#include <float.h>
a7866db6 61#include <math.h>
92f8e882 62#include <pthread.h>
0bc1b2f6 63
64#if defined(__sun)
5043dff3 65#include "solarisfixes.h"
66#endif
ed9b544e 67
c9468bcf 68#include "redis.h"
ed9b544e 69#include "ae.h" /* Event driven programming library */
70#include "sds.h" /* Dynamic safe strings */
71#include "anet.h" /* Networking the easy way */
72#include "dict.h" /* Hash tables */
73#include "adlist.h" /* Linked lists */
74#include "zmalloc.h" /* total memory usage aware version of malloc/free */
5f5b9840 75#include "lzf.h" /* LZF compression library */
76#include "pqsort.h" /* Partial qsort for SORT+LIMIT */
ba798261 77#include "zipmap.h" /* Compact dictionary-alike data structure */
c7d9d662 78#include "ziplist.h" /* Compact list data structure */
ba798261 79#include "sha1.h" /* SHA1 is used for DEBUG DIGEST */
5436146c 80#include "release.h" /* Release and/or git repository information */
ed9b544e 81
82/* Error codes */
83#define REDIS_OK 0
84#define REDIS_ERR -1
85
86/* Static server configuration */
87#define REDIS_SERVERPORT 6379 /* TCP port */
88#define REDIS_MAXIDLETIME (60*5) /* default client timeout */
6208b3a7 89#define REDIS_IOBUF_LEN 1024
ed9b544e 90#define REDIS_LOADBUF_LEN 1024
248ea310 91#define REDIS_STATIC_ARGS 8
ed9b544e 92#define REDIS_DEFAULT_DBNUM 16
93#define REDIS_CONFIGLINE_MAX 1024
94#define REDIS_OBJFREELIST_MAX 1000000 /* Max number of objects to cache */
95#define REDIS_MAX_SYNC_TIME 60 /* Slave can't take more to sync */
8ca3e9d1 96#define REDIS_EXPIRELOOKUPS_PER_CRON 10 /* lookup 10 expires per loop */
6f376729 97#define REDIS_MAX_WRITE_PER_EVENT (1024*64)
2895e862 98#define REDIS_REQUEST_MAX_SIZE (1024*1024*256) /* max bytes in inline command */
99
100/* If more then REDIS_WRITEV_THRESHOLD write packets are pending use writev */
101#define REDIS_WRITEV_THRESHOLD 3
102/* Max number of iovecs used for each writev call */
103#define REDIS_WRITEV_IOVEC_COUNT 256
ed9b544e 104
105/* Hash table parameters */
106#define REDIS_HT_MINFILL 10 /* Minimal hash table fill 10% */
ed9b544e 107
108/* Command flags */
3fd78bcd 109#define REDIS_CMD_BULK 1 /* Bulk write command */
110#define REDIS_CMD_INLINE 2 /* Inline command */
111/* REDIS_CMD_DENYOOM reserves a longer comment: all the commands marked with
112 this flags will return an error when the 'maxmemory' option is set in the
113 config file and the server is using more than maxmemory bytes of memory.
114 In short this commands are denied on low memory conditions. */
115#define REDIS_CMD_DENYOOM 4
4005fef1 116#define REDIS_CMD_FORCE_REPLICATION 8 /* Force replication even if dirty is 0 */
ed9b544e 117
118/* Object types */
119#define REDIS_STRING 0
120#define REDIS_LIST 1
121#define REDIS_SET 2
1812e024 122#define REDIS_ZSET 3
123#define REDIS_HASH 4
f78fd11b 124
5234952b 125/* Objects encoding. Some kind of objects like Strings and Hashes can be
126 * internally represented in multiple ways. The 'encoding' field of the object
127 * is set to one of this fields for this object. */
c7d9d662
PN
128#define REDIS_ENCODING_RAW 0 /* Raw representation */
129#define REDIS_ENCODING_INT 1 /* Encoded as integer */
130#define REDIS_ENCODING_HT 2 /* Encoded as hash table */
131#define REDIS_ENCODING_ZIPMAP 3 /* Encoded as zipmap */
132#define REDIS_ENCODING_LIST 4 /* Encoded as zipmap */
133#define REDIS_ENCODING_ZIPLIST 5 /* Encoded as ziplist */
942a3961 134
07efaf74 135static char* strencoding[] = {
136 "raw", "int", "zipmap", "hashtable"
137};
138
f78fd11b 139/* Object types only used for dumping to disk */
bb32ede5 140#define REDIS_EXPIRETIME 253
ed9b544e 141#define REDIS_SELECTDB 254
142#define REDIS_EOF 255
143
f78fd11b 144/* Defines related to the dump file format. To store 32 bits lengths for short
145 * keys requires a lot of space, so we check the most significant 2 bits of
146 * the first byte to interpreter the length:
147 *
148 * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
149 * 01|000000 00000000 => 01, the len is 14 byes, 6 bits + 8 bits of next byte
150 * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
a4d1ba9a 151 * 11|000000 this means: specially encoded object will follow. The six bits
152 * number specify the kind of object that follows.
153 * See the REDIS_RDB_ENC_* defines.
f78fd11b 154 *
10c43610 155 * Lenghts up to 63 are stored using a single byte, most DB keys, and may
156 * values, will fit inside. */
f78fd11b 157#define REDIS_RDB_6BITLEN 0
158#define REDIS_RDB_14BITLEN 1
159#define REDIS_RDB_32BITLEN 2
17be1a4a 160#define REDIS_RDB_ENCVAL 3
f78fd11b 161#define REDIS_RDB_LENERR UINT_MAX
162
a4d1ba9a 163/* When a length of a string object stored on disk has the first two bits
164 * set, the remaining two bits specify a special encoding for the object
165 * accordingly to the following defines: */
166#define REDIS_RDB_ENC_INT8 0 /* 8 bit signed integer */
167#define REDIS_RDB_ENC_INT16 1 /* 16 bit signed integer */
168#define REDIS_RDB_ENC_INT32 2 /* 32 bit signed integer */
774e3047 169#define REDIS_RDB_ENC_LZF 3 /* string compressed with FASTLZ */
a4d1ba9a 170
75680a3c 171/* Virtual memory object->where field. */
172#define REDIS_VM_MEMORY 0 /* The object is on memory */
173#define REDIS_VM_SWAPPED 1 /* The object is on disk */
174#define REDIS_VM_SWAPPING 2 /* Redis is swapping this object on disk */
175#define REDIS_VM_LOADING 3 /* Redis is loading this object from disk */
176
06224fec 177/* Virtual memory static configuration stuff.
178 * Check vmFindContiguousPages() to know more about this magic numbers. */
179#define REDIS_VM_MAX_NEAR_PAGES 65536
180#define REDIS_VM_MAX_RANDOM_JUMP 4096
92f8e882 181#define REDIS_VM_MAX_THREADS 32
bcaa7a4f 182#define REDIS_THREAD_STACK_SIZE (1024*1024*4)
f6c0bba8 183/* The following is the *percentage* of completed I/O jobs to process when the
184 * handelr is called. While Virtual Memory I/O operations are performed by
185 * threads, this operations must be processed by the main thread when completed
186 * in order to take effect. */
c953f24b 187#define REDIS_MAX_COMPLETED_JOBS_PROCESSED 1
06224fec 188
ed9b544e 189/* Client flags */
d5d55fc3 190#define REDIS_SLAVE 1 /* This client is a slave server */
191#define REDIS_MASTER 2 /* This client is a master server */
192#define REDIS_MONITOR 4 /* This client is a slave monitor, see MONITOR */
193#define REDIS_MULTI 8 /* This client is in a MULTI context */
194#define REDIS_BLOCKED 16 /* The client is waiting in a blocking operation */
195#define REDIS_IO_WAIT 32 /* The client is waiting for Virtual Memory I/O */
37ab76c9 196#define REDIS_DIRTY_CAS 64 /* Watched keys modified. EXEC will fail. */
ed9b544e 197
40d224a9 198/* Slave replication state - slave side */
ed9b544e 199#define REDIS_REPL_NONE 0 /* No active replication */
200#define REDIS_REPL_CONNECT 1 /* Must connect to master */
201#define REDIS_REPL_CONNECTED 2 /* Connected to master */
202
40d224a9 203/* Slave replication state - from the point of view of master
204 * Note that in SEND_BULK and ONLINE state the slave receives new updates
205 * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
206 * to start the next background saving in order to send updates to it. */
207#define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
208#define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
209#define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
210#define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */
211
ed9b544e 212/* List related stuff */
213#define REDIS_HEAD 0
214#define REDIS_TAIL 1
215
216/* Sort operations */
217#define REDIS_SORT_GET 0
443c6409 218#define REDIS_SORT_ASC 1
219#define REDIS_SORT_DESC 2
ed9b544e 220#define REDIS_SORTKEY_MAX 1024
221
222/* Log levels */
223#define REDIS_DEBUG 0
f870935d 224#define REDIS_VERBOSE 1
225#define REDIS_NOTICE 2
226#define REDIS_WARNING 3
ed9b544e 227
228/* Anti-warning macro... */
229#define REDIS_NOTUSED(V) ((void) V)
230
6b47e12e 231#define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
232#define ZSKIPLIST_P 0.25 /* Skiplist P = 1/4 */
ed9b544e 233
48f0308a 234/* Append only defines */
235#define APPENDFSYNC_NO 0
236#define APPENDFSYNC_ALWAYS 1
237#define APPENDFSYNC_EVERYSEC 2
238
cbba7dd7 239/* Hashes related defaults */
240#define REDIS_HASH_MAX_ZIPMAP_ENTRIES 64
241#define REDIS_HASH_MAX_ZIPMAP_VALUE 512
242
dfc5e96c 243/* We can print the stacktrace, so our assert is defined this way: */
478c2c6f 244#define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1)))
c651fd9e 245#define redisPanic(_e) _redisPanic(#_e,__FILE__,__LINE__),_exit(1)
6c96ba7d 246static void _redisAssert(char *estr, char *file, int line);
c651fd9e 247static void _redisPanic(char *msg, char *file, int line);
dfc5e96c 248
ed9b544e 249/*================================= Data types ============================== */
250
251/* A redis object, that is a type able to hold a string / list / set */
75680a3c 252
253/* The VM object structure */
254struct redisObjectVM {
3a66edc7 255 off_t page; /* the page at witch the object is stored on disk */
256 off_t usedpages; /* number of pages used on disk */
257 time_t atime; /* Last access time */
75680a3c 258} vm;
259
260/* The actual Redis Object */
ed9b544e 261typedef struct redisObject {
ed9b544e 262 void *ptr;
942a3961 263 unsigned char type;
264 unsigned char encoding;
d894161b 265 unsigned char storage; /* If this object is a key, where is the value?
266 * REDIS_VM_MEMORY, REDIS_VM_SWAPPED, ... */
267 unsigned char vtype; /* If this object is a key, and value is swapped out,
268 * this is the type of the swapped out object. */
ed9b544e 269 int refcount;
75680a3c 270 /* VM fields, this are only allocated if VM is active, otherwise the
271 * object allocation function will just allocate
272 * sizeof(redisObjct) minus sizeof(redisObjectVM), so using
273 * Redis without VM active will not have any overhead. */
274 struct redisObjectVM vm;
ed9b544e 275} robj;
276
dfc5e96c 277/* Macro used to initalize a Redis object allocated on the stack.
278 * Note that this macro is taken near the structure definition to make sure
279 * we'll update it when the structure is changed, to avoid bugs like
280 * bug #85 introduced exactly in this way. */
281#define initStaticStringObject(_var,_ptr) do { \
282 _var.refcount = 1; \
283 _var.type = REDIS_STRING; \
284 _var.encoding = REDIS_ENCODING_RAW; \
285 _var.ptr = _ptr; \
3a66edc7 286 if (server.vm_enabled) _var.storage = REDIS_VM_MEMORY; \
dfc5e96c 287} while(0);
288
3305306f 289typedef struct redisDb {
4409877e 290 dict *dict; /* The keyspace for this DB */
291 dict *expires; /* Timeout of keys with a timeout set */
37ab76c9 292 dict *blocking_keys; /* Keys with clients waiting for data (BLPOP) */
d5d55fc3 293 dict *io_keys; /* Keys with clients waiting for VM I/O */
37ab76c9 294 dict *watched_keys; /* WATCHED keys for MULTI/EXEC CAS */
3305306f 295 int id;
296} redisDb;
297
6e469882 298/* Client MULTI/EXEC state */
299typedef struct multiCmd {
300 robj **argv;
301 int argc;
302 struct redisCommand *cmd;
303} multiCmd;
304
305typedef struct multiState {
306 multiCmd *commands; /* Array of MULTI commands */
307 int count; /* Total number of MULTI commands */
308} multiState;
309
ed9b544e 310/* With multiplexing we need to take per-clinet state.
311 * Clients are taken in a liked list. */
312typedef struct redisClient {
313 int fd;
3305306f 314 redisDb *db;
ed9b544e 315 int dictid;
316 sds querybuf;
e8a74421 317 robj **argv, **mbargv;
318 int argc, mbargc;
40d224a9 319 int bulklen; /* bulk read len. -1 if not in bulk read mode */
e8a74421 320 int multibulk; /* multi bulk command format active */
ed9b544e 321 list *reply;
322 int sentlen;
323 time_t lastinteraction; /* time of the last interaction, used for timeout */
d5d55fc3 324 int flags; /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
40d224a9 325 int slaveseldb; /* slave selected db, if this client is a slave */
326 int authenticated; /* when requirepass is non-NULL */
327 int replstate; /* replication state if this is a slave */
328 int repldbfd; /* replication DB file descriptor */
6e469882 329 long repldboff; /* replication DB file offset */
40d224a9 330 off_t repldbsize; /* replication DB file size */
6e469882 331 multiState mstate; /* MULTI/EXEC state */
37ab76c9 332 robj **blocking_keys; /* The key we are waiting to terminate a blocking
4409877e 333 * operation such as BLPOP. Otherwise NULL. */
37ab76c9 334 int blocking_keys_num; /* Number of blocking keys */
4409877e 335 time_t blockingto; /* Blocking operation timeout. If UNIX current time
336 * is >= blockingto then the operation timed out. */
92f8e882 337 list *io_keys; /* Keys this client is waiting to be loaded from the
338 * swap file in order to continue. */
37ab76c9 339 list *watched_keys; /* Keys WATCHED for MULTI/EXEC CAS */
ffc6b7f8 340 dict *pubsub_channels; /* channels a client is interested in (SUBSCRIBE) */
341 list *pubsub_patterns; /* patterns a client is interested in (SUBSCRIBE) */
ed9b544e 342} redisClient;
343
344struct saveparam {
345 time_t seconds;
346 int changes;
347};
348
349/* Global server state structure */
350struct redisServer {
351 int port;
352 int fd;
3305306f 353 redisDb *db;
ed9b544e 354 long long dirty; /* changes to DB from the last save */
355 list *clients;
87eca727 356 list *slaves, *monitors;
ed9b544e 357 char neterr[ANET_ERR_LEN];
358 aeEventLoop *el;
359 int cronloops; /* number of times the cron function run */
360 list *objfreelist; /* A list of freed objects to avoid malloc() */
361 time_t lastsave; /* Unix time of last save succeeede */
ed9b544e 362 /* Fields used only for stats */
363 time_t stat_starttime; /* server start time */
364 long long stat_numcommands; /* number of processed commands */
365 long long stat_numconnections; /* number of connections received */
2a6a2ed1 366 long long stat_expiredkeys; /* number of expired keys */
ed9b544e 367 /* Configuration */
368 int verbosity;
369 int glueoutputbuf;
370 int maxidletime;
371 int dbnum;
372 int daemonize;
44b38ef4 373 int appendonly;
48f0308a 374 int appendfsync;
fab43727 375 int shutdown_asap;
48f0308a 376 time_t lastfsync;
44b38ef4 377 int appendfd;
378 int appendseldb;
ed329fcf 379 char *pidfile;
9f3c422c 380 pid_t bgsavechildpid;
9d65a1bb 381 pid_t bgrewritechildpid;
382 sds bgrewritebuf; /* buffer taken by parent during oppend only rewrite */
28ed1f33 383 sds aofbuf; /* AOF buffer, written before entering the event loop */
ed9b544e 384 struct saveparam *saveparams;
385 int saveparamslen;
386 char *logfile;
387 char *bindaddr;
388 char *dbfilename;
44b38ef4 389 char *appendfilename;
abcb223e 390 char *requirepass;
121f70cf 391 int rdbcompression;
8ca3e9d1 392 int activerehashing;
ed9b544e 393 /* Replication related */
394 int isslave;
d0ccebcf 395 char *masterauth;
ed9b544e 396 char *masterhost;
397 int masterport;
40d224a9 398 redisClient *master; /* client that is master for this slave */
ed9b544e 399 int replstate;
285add55 400 unsigned int maxclients;
4ef8de8a 401 unsigned long long maxmemory;
d5d55fc3 402 unsigned int blpop_blocked_clients;
403 unsigned int vm_blocked_clients;
ed9b544e 404 /* Sort parameters - qsort_r() is only available under BSD so we
405 * have to take this state global, in order to pass it to sortCompare() */
406 int sort_desc;
407 int sort_alpha;
408 int sort_bypattern;
75680a3c 409 /* Virtual memory configuration */
410 int vm_enabled;
054e426d 411 char *vm_swap_file;
75680a3c 412 off_t vm_page_size;
413 off_t vm_pages;
4ef8de8a 414 unsigned long long vm_max_memory;
cbba7dd7 415 /* Hashes config */
416 size_t hash_max_zipmap_entries;
417 size_t hash_max_zipmap_value;
75680a3c 418 /* Virtual memory state */
419 FILE *vm_fp;
420 int vm_fd;
421 off_t vm_next_page; /* Next probably empty page */
422 off_t vm_near_pages; /* Number of pages allocated sequentially */
06224fec 423 unsigned char *vm_bitmap; /* Bitmap of free/used pages */
3a66edc7 424 time_t unixtime; /* Unix time sampled every second. */
92f8e882 425 /* Virtual memory I/O threads stuff */
92f8e882 426 /* An I/O thread process an element taken from the io_jobs queue and
996cb5f7 427 * put the result of the operation in the io_done list. While the
428 * job is being processed, it's put on io_processing queue. */
429 list *io_newjobs; /* List of VM I/O jobs yet to be processed */
430 list *io_processing; /* List of VM I/O jobs being processed */
431 list *io_processed; /* List of VM I/O jobs already processed */
d5d55fc3 432 list *io_ready_clients; /* Clients ready to be unblocked. All keys loaded */
996cb5f7 433 pthread_mutex_t io_mutex; /* lock to access io_jobs/io_done/io_thread_job */
a5819310 434 pthread_mutex_t obj_freelist_mutex; /* safe redis objects creation/free */
435 pthread_mutex_t io_swapfile_mutex; /* So we can lseek + write */
bcaa7a4f 436 pthread_attr_t io_threads_attr; /* attributes for threads creation */
92f8e882 437 int io_active_threads; /* Number of running I/O threads */
438 int vm_max_threads; /* Max number of I/O threads running at the same time */
996cb5f7 439 /* Our main thread is blocked on the event loop, locking for sockets ready
440 * to be read or written, so when a threaded I/O operation is ready to be
441 * processed by the main thread, the I/O thread will use a unix pipe to
442 * awake the main thread. The followings are the two pipe FDs. */
443 int io_ready_pipe_read;
444 int io_ready_pipe_write;
7d98e08c 445 /* Virtual memory stats */
446 unsigned long long vm_stats_used_pages;
447 unsigned long long vm_stats_swapped_objects;
448 unsigned long long vm_stats_swapouts;
449 unsigned long long vm_stats_swapins;
befec3cd 450 /* Pubsub */
ffc6b7f8 451 dict *pubsub_channels; /* Map channels to list of subscribed clients */
452 list *pubsub_patterns; /* A list of pubsub_patterns */
befec3cd 453 /* Misc */
b9bc0eef 454 FILE *devnull;
ed9b544e 455};
456
ffc6b7f8 457typedef struct pubsubPattern {
458 redisClient *client;
459 robj *pattern;
460} pubsubPattern;
461
ed9b544e 462typedef void redisCommandProc(redisClient *c);
ca1788b5 463typedef void redisVmPreloadProc(redisClient *c, struct redisCommand *cmd, int argc, robj **argv);
ed9b544e 464struct redisCommand {
465 char *name;
466 redisCommandProc *proc;
467 int arity;
468 int flags;
76583ea4
PN
469 /* Use a function to determine which keys need to be loaded
470 * in the background prior to executing this command. Takes precedence
471 * over vm_firstkey and others, ignored when NULL */
ca1788b5 472 redisVmPreloadProc *vm_preload_proc;
7c775e09 473 /* What keys should be loaded in background when calling this command? */
474 int vm_firstkey; /* The first argument that's a key (0 = no keys) */
475 int vm_lastkey; /* THe last argument that's a key */
476 int vm_keystep; /* The step between first and last key */
ed9b544e 477};
478
de96dbfe 479struct redisFunctionSym {
480 char *name;
56906eef 481 unsigned long pointer;
de96dbfe 482};
483
ed9b544e 484typedef struct _redisSortObject {
485 robj *obj;
486 union {
487 double score;
488 robj *cmpobj;
489 } u;
490} redisSortObject;
491
492typedef struct _redisSortOperation {
493 int type;
494 robj *pattern;
495} redisSortOperation;
496
6b47e12e 497/* ZSETs use a specialized version of Skiplists */
498
499typedef struct zskiplistNode {
500 struct zskiplistNode **forward;
e3870fab 501 struct zskiplistNode *backward;
912b9165 502 unsigned int *span;
6b47e12e 503 double score;
504 robj *obj;
505} zskiplistNode;
506
507typedef struct zskiplist {
e3870fab 508 struct zskiplistNode *header, *tail;
d13f767c 509 unsigned long length;
6b47e12e 510 int level;
511} zskiplist;
512
1812e024 513typedef struct zset {
514 dict *dict;
6b47e12e 515 zskiplist *zsl;
1812e024 516} zset;
517
6b47e12e 518/* Our shared "common" objects */
519
05df7621 520#define REDIS_SHARED_INTEGERS 10000
ed9b544e 521struct sharedObjectsStruct {
c937aa89 522 robj *crlf, *ok, *err, *emptybulk, *czero, *cone, *pong, *space,
6e469882 523 *colon, *nullbulk, *nullmultibulk, *queued,
c937aa89 524 *emptymultibulk, *wrongtypeerr, *nokeyerr, *syntaxerr, *sameobjecterr,
525 *outofrangeerr, *plus,
ed9b544e 526 *select0, *select1, *select2, *select3, *select4,
befec3cd 527 *select5, *select6, *select7, *select8, *select9,
c8d0ea0e 528 *messagebulk, *pmessagebulk, *subscribebulk, *unsubscribebulk, *mbulk3,
529 *mbulk4, *psubscribebulk, *punsubscribebulk,
530 *integers[REDIS_SHARED_INTEGERS];
ed9b544e 531} shared;
532
a7866db6 533/* Global vars that are actally used as constants. The following double
534 * values are used for double on-disk serialization, and are initialized
535 * at runtime to avoid strange compiler optimizations. */
536
537static double R_Zero, R_PosInf, R_NegInf, R_Nan;
538
92f8e882 539/* VM threaded I/O request message */
b9bc0eef 540#define REDIS_IOJOB_LOAD 0 /* Load from disk to memory */
541#define REDIS_IOJOB_PREPARE_SWAP 1 /* Compute needed pages */
542#define REDIS_IOJOB_DO_SWAP 2 /* Swap from memory to disk */
d5d55fc3 543typedef struct iojob {
996cb5f7 544 int type; /* Request type, REDIS_IOJOB_* */
b9bc0eef 545 redisDb *db;/* Redis database */
92f8e882 546 robj *key; /* This I/O request is about swapping this key */
b9bc0eef 547 robj *val; /* the value to swap for REDIS_IOREQ_*_SWAP, otherwise this
92f8e882 548 * field is populated by the I/O thread for REDIS_IOREQ_LOAD. */
549 off_t page; /* Swap page where to read/write the object */
248ea310 550 off_t pages; /* Swap pages needed to save object. PREPARE_SWAP return val */
996cb5f7 551 int canceled; /* True if this command was canceled by blocking side of VM */
552 pthread_t thread; /* ID of the thread processing this entry */
553} iojob;
92f8e882 554
ed9b544e 555/*================================ Prototypes =============================== */
556
557static void freeStringObject(robj *o);
558static void freeListObject(robj *o);
559static void freeSetObject(robj *o);
560static void decrRefCount(void *o);
561static robj *createObject(int type, void *ptr);
562static void freeClient(redisClient *c);
f78fd11b 563static int rdbLoad(char *filename);
ed9b544e 564static void addReply(redisClient *c, robj *obj);
565static void addReplySds(redisClient *c, sds s);
566static void incrRefCount(robj *o);
f78fd11b 567static int rdbSaveBackground(char *filename);
ed9b544e 568static robj *createStringObject(char *ptr, size_t len);
4ef8de8a 569static robj *dupStringObject(robj *o);
248ea310 570static void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc);
dd142b9c 571static void replicationFeedMonitors(list *monitors, int dictid, robj **argv, int argc);
28ed1f33 572static void flushAppendOnlyFile(void);
44b38ef4 573static void feedAppendOnlyFile(struct redisCommand *cmd, int dictid, robj **argv, int argc);
ed9b544e 574static int syncWithMaster(void);
05df7621 575static robj *tryObjectEncoding(robj *o);
9d65a1bb 576static robj *getDecodedObject(robj *o);
3305306f 577static int removeExpire(redisDb *db, robj *key);
578static int expireIfNeeded(redisDb *db, robj *key);
579static int deleteIfVolatile(redisDb *db, robj *key);
1b03836c 580static int deleteIfSwapped(redisDb *db, robj *key);
94754ccc 581static int deleteKey(redisDb *db, robj *key);
bb32ede5 582static time_t getExpire(redisDb *db, robj *key);
583static int setExpire(redisDb *db, robj *key, time_t when);
a3b21203 584static void updateSlavesWaitingBgsave(int bgsaveerr);
3fd78bcd 585static void freeMemoryIfNeeded(void);
de96dbfe 586static int processCommand(redisClient *c);
56906eef 587static void setupSigSegvAction(void);
a3b21203 588static void rdbRemoveTempFile(pid_t childpid);
9d65a1bb 589static void aofRemoveTempFile(pid_t childpid);
0ea663ea 590static size_t stringObjectLen(robj *o);
638e42ac 591static void processInputBuffer(redisClient *c);
6b47e12e 592static zskiplist *zslCreate(void);
fd8ccf44 593static void zslFree(zskiplist *zsl);
2b59cfdf 594static void zslInsert(zskiplist *zsl, double score, robj *obj);
2895e862 595static void sendReplyToClientWritev(aeEventLoop *el, int fd, void *privdata, int mask);
6e469882 596static void initClientMultiState(redisClient *c);
597static void freeClientMultiState(redisClient *c);
598static void queueMultiCommand(redisClient *c, struct redisCommand *cmd);
b0d8747d 599static void unblockClientWaitingData(redisClient *c);
4409877e 600static int handleClientsWaitingListPush(redisClient *c, robj *key, robj *ele);
75680a3c 601static void vmInit(void);
a35ddf12 602static void vmMarkPagesFree(off_t page, off_t count);
55cf8433 603static robj *vmLoadObject(robj *key);
7e69548d 604static robj *vmPreviewObject(robj *key);
a69a0c9c 605static int vmSwapOneObjectBlocking(void);
606static int vmSwapOneObjectThreaded(void);
7e69548d 607static int vmCanSwapOut(void);
a5819310 608static int tryFreeOneObjectFromFreelist(void);
996cb5f7 609static void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask);
610static void vmThreadedIOCompletedJob(aeEventLoop *el, int fd, void *privdata, int mask);
611static void vmCancelThreadedIOJob(robj *o);
b9bc0eef 612static void lockThreadedIO(void);
613static void unlockThreadedIO(void);
614static int vmSwapObjectThreaded(robj *key, robj *val, redisDb *db);
615static void freeIOJob(iojob *j);
616static void queueIOJob(iojob *j);
a5819310 617static int vmWriteObjectOnSwap(robj *o, off_t page);
618static robj *vmReadObjectFromSwap(off_t page, int type);
054e426d 619static void waitEmptyIOJobsQueue(void);
620static void vmReopenSwapFile(void);
970e10bb 621static int vmFreePage(off_t page);
ca1788b5 622static void zunionInterBlockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd, int argc, robj **argv);
3805e04f 623static void execBlockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd, int argc, robj **argv);
0a6f3f0f 624static int blockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd);
d5d55fc3 625static int dontWaitForSwappedKey(redisClient *c, robj *key);
626static void handleClientsBlockedOnSwappedKey(redisDb *db, robj *key);
627static void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask);
628static struct redisCommand *lookupCommand(char *name);
629static void call(redisClient *c, struct redisCommand *cmd);
630static void resetClient(redisClient *c);
ada386b2 631static void convertToRealHash(robj *o);
ffc6b7f8 632static int pubsubUnsubscribeAllChannels(redisClient *c, int notify);
633static int pubsubUnsubscribeAllPatterns(redisClient *c, int notify);
634static void freePubsubPattern(void *p);
635static int listMatchPubsubPattern(void *a, void *b);
636static int compareStringObjects(robj *a, robj *b);
bf028098 637static int equalStringObjects(robj *a, robj *b);
befec3cd 638static void usage();
8f63ddca 639static int rewriteAppendOnlyFileBackground(void);
242a64f3 640static int vmSwapObjectBlocking(robj *key, robj *val);
fab43727 641static int prepareForShutdown();
37ab76c9 642static void touchWatchedKey(redisDb *db, robj *key);
9b30e1a2 643static void touchWatchedKeysOnFlush(int dbid);
37ab76c9 644static void unwatchAllKeys(redisClient *c);
ed9b544e 645
abcb223e 646static void authCommand(redisClient *c);
ed9b544e 647static void pingCommand(redisClient *c);
648static void echoCommand(redisClient *c);
649static void setCommand(redisClient *c);
650static void setnxCommand(redisClient *c);
526d00a5 651static void setexCommand(redisClient *c);
ed9b544e 652static void getCommand(redisClient *c);
653static void delCommand(redisClient *c);
654static void existsCommand(redisClient *c);
655static void incrCommand(redisClient *c);
656static void decrCommand(redisClient *c);
657static void incrbyCommand(redisClient *c);
658static void decrbyCommand(redisClient *c);
659static void selectCommand(redisClient *c);
660static void randomkeyCommand(redisClient *c);
661static void keysCommand(redisClient *c);
662static void dbsizeCommand(redisClient *c);
663static void lastsaveCommand(redisClient *c);
664static void saveCommand(redisClient *c);
665static void bgsaveCommand(redisClient *c);
9d65a1bb 666static void bgrewriteaofCommand(redisClient *c);
ed9b544e 667static void shutdownCommand(redisClient *c);
668static void moveCommand(redisClient *c);
669static void renameCommand(redisClient *c);
670static void renamenxCommand(redisClient *c);
671static void lpushCommand(redisClient *c);
672static void rpushCommand(redisClient *c);
673static void lpopCommand(redisClient *c);
674static void rpopCommand(redisClient *c);
675static void llenCommand(redisClient *c);
676static void lindexCommand(redisClient *c);
677static void lrangeCommand(redisClient *c);
678static void ltrimCommand(redisClient *c);
679static void typeCommand(redisClient *c);
680static void lsetCommand(redisClient *c);
681static void saddCommand(redisClient *c);
682static void sremCommand(redisClient *c);
a4460ef4 683static void smoveCommand(redisClient *c);
ed9b544e 684static void sismemberCommand(redisClient *c);
685static void scardCommand(redisClient *c);
12fea928 686static void spopCommand(redisClient *c);
2abb95a9 687static void srandmemberCommand(redisClient *c);
ed9b544e 688static void sinterCommand(redisClient *c);
689static void sinterstoreCommand(redisClient *c);
40d224a9 690static void sunionCommand(redisClient *c);
691static void sunionstoreCommand(redisClient *c);
f4f56e1d 692static void sdiffCommand(redisClient *c);
693static void sdiffstoreCommand(redisClient *c);
ed9b544e 694static void syncCommand(redisClient *c);
695static void flushdbCommand(redisClient *c);
696static void flushallCommand(redisClient *c);
697static void sortCommand(redisClient *c);
698static void lremCommand(redisClient *c);
0f5f7e9a 699static void rpoplpushcommand(redisClient *c);
ed9b544e 700static void infoCommand(redisClient *c);
70003d28 701static void mgetCommand(redisClient *c);
87eca727 702static void monitorCommand(redisClient *c);
3305306f 703static void expireCommand(redisClient *c);
802e8373 704static void expireatCommand(redisClient *c);
f6b141c5 705static void getsetCommand(redisClient *c);
fd88489a 706static void ttlCommand(redisClient *c);
321b0e13 707static void slaveofCommand(redisClient *c);
7f957c92 708static void debugCommand(redisClient *c);
f6b141c5 709static void msetCommand(redisClient *c);
710static void msetnxCommand(redisClient *c);
fd8ccf44 711static void zaddCommand(redisClient *c);
7db723ad 712static void zincrbyCommand(redisClient *c);
cc812361 713static void zrangeCommand(redisClient *c);
50c55df5 714static void zrangebyscoreCommand(redisClient *c);
f44dd428 715static void zcountCommand(redisClient *c);
e3870fab 716static void zrevrangeCommand(redisClient *c);
3c41331e 717static void zcardCommand(redisClient *c);
1b7106e7 718static void zremCommand(redisClient *c);
6e333bbe 719static void zscoreCommand(redisClient *c);
1807985b 720static void zremrangebyscoreCommand(redisClient *c);
6e469882 721static void multiCommand(redisClient *c);
722static void execCommand(redisClient *c);
18b6cb76 723static void discardCommand(redisClient *c);
4409877e 724static void blpopCommand(redisClient *c);
725static void brpopCommand(redisClient *c);
4b00bebd 726static void appendCommand(redisClient *c);
39191553 727static void substrCommand(redisClient *c);
69d95c3e 728static void zrankCommand(redisClient *c);
798d9e55 729static void zrevrankCommand(redisClient *c);
978c2c94 730static void hsetCommand(redisClient *c);
1f1c7695 731static void hsetnxCommand(redisClient *c);
978c2c94 732static void hgetCommand(redisClient *c);
09aeb579
PN
733static void hmsetCommand(redisClient *c);
734static void hmgetCommand(redisClient *c);
07efaf74 735static void hdelCommand(redisClient *c);
92b27fe9 736static void hlenCommand(redisClient *c);
9212eafd 737static void zremrangebyrankCommand(redisClient *c);
5d373da9 738static void zunionstoreCommand(redisClient *c);
739static void zinterstoreCommand(redisClient *c);
78409a0f 740static void hkeysCommand(redisClient *c);
741static void hvalsCommand(redisClient *c);
742static void hgetallCommand(redisClient *c);
a86f14b1 743static void hexistsCommand(redisClient *c);
500ece7c 744static void configCommand(redisClient *c);
01426b05 745static void hincrbyCommand(redisClient *c);
befec3cd 746static void subscribeCommand(redisClient *c);
747static void unsubscribeCommand(redisClient *c);
ffc6b7f8 748static void psubscribeCommand(redisClient *c);
749static void punsubscribeCommand(redisClient *c);
befec3cd 750static void publishCommand(redisClient *c);
37ab76c9 751static void watchCommand(redisClient *c);
752static void unwatchCommand(redisClient *c);
f6b141c5 753
ed9b544e 754/*================================= Globals ================================= */
755
756/* Global vars */
757static struct redisServer server; /* server global state */
1a132bbc 758static struct redisCommand *commandTable;
1a132bbc 759static struct redisCommand readonlyCommandTable[] = {
76583ea4
PN
760 {"get",getCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
761 {"set",setCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,0,0,0},
762 {"setnx",setnxCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,0,0,0},
526d00a5 763 {"setex",setexCommand,4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,0,0,0},
76583ea4
PN
764 {"append",appendCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
765 {"substr",substrCommand,4,REDIS_CMD_INLINE,NULL,1,1,1},
766 {"del",delCommand,-2,REDIS_CMD_INLINE,NULL,0,0,0},
767 {"exists",existsCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
768 {"incr",incrCommand,2,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,1,1},
769 {"decr",decrCommand,2,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,1,1},
770 {"mget",mgetCommand,-2,REDIS_CMD_INLINE,NULL,1,-1,1},
771 {"rpush",rpushCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
772 {"lpush",lpushCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
773 {"rpop",rpopCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
774 {"lpop",lpopCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
775 {"brpop",brpopCommand,-3,REDIS_CMD_INLINE,NULL,1,1,1},
776 {"blpop",blpopCommand,-3,REDIS_CMD_INLINE,NULL,1,1,1},
777 {"llen",llenCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
778 {"lindex",lindexCommand,3,REDIS_CMD_INLINE,NULL,1,1,1},
779 {"lset",lsetCommand,4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
780 {"lrange",lrangeCommand,4,REDIS_CMD_INLINE,NULL,1,1,1},
781 {"ltrim",ltrimCommand,4,REDIS_CMD_INLINE,NULL,1,1,1},
782 {"lrem",lremCommand,4,REDIS_CMD_BULK,NULL,1,1,1},
783 {"rpoplpush",rpoplpushcommand,3,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,2,1},
784 {"sadd",saddCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
785 {"srem",sremCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
786 {"smove",smoveCommand,4,REDIS_CMD_BULK,NULL,1,2,1},
787 {"sismember",sismemberCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
788 {"scard",scardCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
789 {"spop",spopCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
790 {"srandmember",srandmemberCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
791 {"sinter",sinterCommand,-2,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,-1,1},
792 {"sinterstore",sinterstoreCommand,-3,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,2,-1,1},
793 {"sunion",sunionCommand,-2,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,-1,1},
794 {"sunionstore",sunionstoreCommand,-3,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,2,-1,1},
795 {"sdiff",sdiffCommand,-2,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,-1,1},
796 {"sdiffstore",sdiffstoreCommand,-3,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,2,-1,1},
797 {"smembers",sinterCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
798 {"zadd",zaddCommand,4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
799 {"zincrby",zincrbyCommand,4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
800 {"zrem",zremCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
801 {"zremrangebyscore",zremrangebyscoreCommand,4,REDIS_CMD_INLINE,NULL,1,1,1},
802 {"zremrangebyrank",zremrangebyrankCommand,4,REDIS_CMD_INLINE,NULL,1,1,1},
5d373da9 803 {"zunionstore",zunionstoreCommand,-4,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,zunionInterBlockClientOnSwappedKeys,0,0,0},
804 {"zinterstore",zinterstoreCommand,-4,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,zunionInterBlockClientOnSwappedKeys,0,0,0},
76583ea4
PN
805 {"zrange",zrangeCommand,-4,REDIS_CMD_INLINE,NULL,1,1,1},
806 {"zrangebyscore",zrangebyscoreCommand,-4,REDIS_CMD_INLINE,NULL,1,1,1},
807 {"zcount",zcountCommand,4,REDIS_CMD_INLINE,NULL,1,1,1},
808 {"zrevrange",zrevrangeCommand,-4,REDIS_CMD_INLINE,NULL,1,1,1},
809 {"zcard",zcardCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
810 {"zscore",zscoreCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
811 {"zrank",zrankCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
812 {"zrevrank",zrevrankCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
813 {"hset",hsetCommand,4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
1f1c7695 814 {"hsetnx",hsetnxCommand,4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
09aeb579 815 {"hget",hgetCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
d33278d1 816 {"hmset",hmsetCommand,-4,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
09aeb579 817 {"hmget",hmgetCommand,-3,REDIS_CMD_BULK,NULL,1,1,1},
01426b05 818 {"hincrby",hincrbyCommand,4,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,1,1},
76583ea4
PN
819 {"hdel",hdelCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
820 {"hlen",hlenCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
821 {"hkeys",hkeysCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
822 {"hvals",hvalsCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
823 {"hgetall",hgetallCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
4583c4f0 824 {"hexists",hexistsCommand,3,REDIS_CMD_BULK,NULL,1,1,1},
76583ea4
PN
825 {"incrby",incrbyCommand,3,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,1,1},
826 {"decrby",decrbyCommand,3,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,1,1},
827 {"getset",getsetCommand,3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,1,1},
828 {"mset",msetCommand,-3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,-1,2},
829 {"msetnx",msetnxCommand,-3,REDIS_CMD_BULK|REDIS_CMD_DENYOOM,NULL,1,-1,2},
830 {"randomkey",randomkeyCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
831 {"select",selectCommand,2,REDIS_CMD_INLINE,NULL,0,0,0},
832 {"move",moveCommand,3,REDIS_CMD_INLINE,NULL,1,1,1},
833 {"rename",renameCommand,3,REDIS_CMD_INLINE,NULL,1,1,1},
834 {"renamenx",renamenxCommand,3,REDIS_CMD_INLINE,NULL,1,1,1},
835 {"expire",expireCommand,3,REDIS_CMD_INLINE,NULL,0,0,0},
836 {"expireat",expireatCommand,3,REDIS_CMD_INLINE,NULL,0,0,0},
837 {"keys",keysCommand,2,REDIS_CMD_INLINE,NULL,0,0,0},
838 {"dbsize",dbsizeCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
839 {"auth",authCommand,2,REDIS_CMD_INLINE,NULL,0,0,0},
840 {"ping",pingCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
841 {"echo",echoCommand,2,REDIS_CMD_BULK,NULL,0,0,0},
842 {"save",saveCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
843 {"bgsave",bgsaveCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
844 {"bgrewriteaof",bgrewriteaofCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
845 {"shutdown",shutdownCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
846 {"lastsave",lastsaveCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
847 {"type",typeCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
848 {"multi",multiCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
3805e04f 849 {"exec",execCommand,1,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,execBlockClientOnSwappedKeys,0,0,0},
76583ea4
PN
850 {"discard",discardCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
851 {"sync",syncCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
852 {"flushdb",flushdbCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
853 {"flushall",flushallCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
854 {"sort",sortCommand,-2,REDIS_CMD_INLINE|REDIS_CMD_DENYOOM,NULL,1,1,1},
855 {"info",infoCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
856 {"monitor",monitorCommand,1,REDIS_CMD_INLINE,NULL,0,0,0},
857 {"ttl",ttlCommand,2,REDIS_CMD_INLINE,NULL,1,1,1},
858 {"slaveof",slaveofCommand,3,REDIS_CMD_INLINE,NULL,0,0,0},
859 {"debug",debugCommand,-2,REDIS_CMD_INLINE,NULL,0,0,0},
500ece7c 860 {"config",configCommand,-2,REDIS_CMD_BULK,NULL,0,0,0},
befec3cd 861 {"subscribe",subscribeCommand,-2,REDIS_CMD_INLINE,NULL,0,0,0},
862 {"unsubscribe",unsubscribeCommand,-1,REDIS_CMD_INLINE,NULL,0,0,0},
ffc6b7f8 863 {"psubscribe",psubscribeCommand,-2,REDIS_CMD_INLINE,NULL,0,0,0},
864 {"punsubscribe",punsubscribeCommand,-1,REDIS_CMD_INLINE,NULL,0,0,0},
4005fef1 865 {"publish",publishCommand,3,REDIS_CMD_BULK|REDIS_CMD_FORCE_REPLICATION,NULL,0,0,0},
37ab76c9 866 {"watch",watchCommand,-2,REDIS_CMD_INLINE,NULL,0,0,0},
d55d5c5d 867 {"unwatch",unwatchCommand,1,REDIS_CMD_INLINE,NULL,0,0,0}
ed9b544e 868};
bcfc686d 869
ed9b544e 870/*============================ Utility functions ============================ */
871
872/* Glob-style pattern matching. */
500ece7c 873static int stringmatchlen(const char *pattern, int patternLen,
ed9b544e 874 const char *string, int stringLen, int nocase)
875{
876 while(patternLen) {
877 switch(pattern[0]) {
878 case '*':
879 while (pattern[1] == '*') {
880 pattern++;
881 patternLen--;
882 }
883 if (patternLen == 1)
884 return 1; /* match */
885 while(stringLen) {
886 if (stringmatchlen(pattern+1, patternLen-1,
887 string, stringLen, nocase))
888 return 1; /* match */
889 string++;
890 stringLen--;
891 }
892 return 0; /* no match */
893 break;
894 case '?':
895 if (stringLen == 0)
896 return 0; /* no match */
897 string++;
898 stringLen--;
899 break;
900 case '[':
901 {
902 int not, match;
903
904 pattern++;
905 patternLen--;
906 not = pattern[0] == '^';
907 if (not) {
908 pattern++;
909 patternLen--;
910 }
911 match = 0;
912 while(1) {
913 if (pattern[0] == '\\') {
914 pattern++;
915 patternLen--;
916 if (pattern[0] == string[0])
917 match = 1;
918 } else if (pattern[0] == ']') {
919 break;
920 } else if (patternLen == 0) {
921 pattern--;
922 patternLen++;
923 break;
924 } else if (pattern[1] == '-' && patternLen >= 3) {
925 int start = pattern[0];
926 int end = pattern[2];
927 int c = string[0];
928 if (start > end) {
929 int t = start;
930 start = end;
931 end = t;
932 }
933 if (nocase) {
934 start = tolower(start);
935 end = tolower(end);
936 c = tolower(c);
937 }
938 pattern += 2;
939 patternLen -= 2;
940 if (c >= start && c <= end)
941 match = 1;
942 } else {
943 if (!nocase) {
944 if (pattern[0] == string[0])
945 match = 1;
946 } else {
947 if (tolower((int)pattern[0]) == tolower((int)string[0]))
948 match = 1;
949 }
950 }
951 pattern++;
952 patternLen--;
953 }
954 if (not)
955 match = !match;
956 if (!match)
957 return 0; /* no match */
958 string++;
959 stringLen--;
960 break;
961 }
962 case '\\':
963 if (patternLen >= 2) {
964 pattern++;
965 patternLen--;
966 }
967 /* fall through */
968 default:
969 if (!nocase) {
970 if (pattern[0] != string[0])
971 return 0; /* no match */
972 } else {
973 if (tolower((int)pattern[0]) != tolower((int)string[0]))
974 return 0; /* no match */
975 }
976 string++;
977 stringLen--;
978 break;
979 }
980 pattern++;
981 patternLen--;
982 if (stringLen == 0) {
983 while(*pattern == '*') {
984 pattern++;
985 patternLen--;
986 }
987 break;
988 }
989 }
990 if (patternLen == 0 && stringLen == 0)
991 return 1;
992 return 0;
993}
994
500ece7c 995static int stringmatch(const char *pattern, const char *string, int nocase) {
996 return stringmatchlen(pattern,strlen(pattern),string,strlen(string),nocase);
997}
998
2b619329 999/* Convert a string representing an amount of memory into the number of
1000 * bytes, so for instance memtoll("1Gi") will return 1073741824 that is
1001 * (1024*1024*1024).
1002 *
1003 * On parsing error, if *err is not NULL, it's set to 1, otherwise it's
1004 * set to 0 */
1005static long long memtoll(const char *p, int *err) {
1006 const char *u;
1007 char buf[128];
1008 long mul; /* unit multiplier */
1009 long long val;
1010 unsigned int digits;
1011
1012 if (err) *err = 0;
1013 /* Search the first non digit character. */
1014 u = p;
1015 if (*u == '-') u++;
1016 while(*u && isdigit(*u)) u++;
1017 if (*u == '\0' || !strcasecmp(u,"b")) {
1018 mul = 1;
72324005 1019 } else if (!strcasecmp(u,"k")) {
2b619329 1020 mul = 1000;
72324005 1021 } else if (!strcasecmp(u,"kb")) {
2b619329 1022 mul = 1024;
72324005 1023 } else if (!strcasecmp(u,"m")) {
2b619329 1024 mul = 1000*1000;
72324005 1025 } else if (!strcasecmp(u,"mb")) {
2b619329 1026 mul = 1024*1024;
72324005 1027 } else if (!strcasecmp(u,"g")) {
2b619329 1028 mul = 1000L*1000*1000;
72324005 1029 } else if (!strcasecmp(u,"gb")) {
2b619329 1030 mul = 1024L*1024*1024;
1031 } else {
1032 if (err) *err = 1;
1033 mul = 1;
1034 }
1035 digits = u-p;
1036 if (digits >= sizeof(buf)) {
1037 if (err) *err = 1;
1038 return LLONG_MAX;
1039 }
1040 memcpy(buf,p,digits);
1041 buf[digits] = '\0';
1042 val = strtoll(buf,NULL,10);
1043 return val*mul;
1044}
1045
ee14da56 1046/* Convert a long long into a string. Returns the number of
1047 * characters needed to represent the number, that can be shorter if passed
1048 * buffer length is not enough to store the whole number. */
1049static int ll2string(char *s, size_t len, long long value) {
1050 char buf[32], *p;
1051 unsigned long long v;
1052 size_t l;
1053
1054 if (len == 0) return 0;
1055 v = (value < 0) ? -value : value;
1056 p = buf+31; /* point to the last character */
1057 do {
1058 *p-- = '0'+(v%10);
1059 v /= 10;
1060 } while(v);
1061 if (value < 0) *p-- = '-';
1062 p++;
1063 l = 32-(p-buf);
1064 if (l+1 > len) l = len-1; /* Make sure it fits, including the nul term */
1065 memcpy(s,p,l);
1066 s[l] = '\0';
1067 return l;
1068}
1069
56906eef 1070static void redisLog(int level, const char *fmt, ...) {
ed9b544e 1071 va_list ap;
1072 FILE *fp;
1073
1074 fp = (server.logfile == NULL) ? stdout : fopen(server.logfile,"a");
1075 if (!fp) return;
1076
1077 va_start(ap, fmt);
1078 if (level >= server.verbosity) {
6766f45e 1079 char *c = ".-*#";
1904ecc1 1080 char buf[64];
1081 time_t now;
1082
1083 now = time(NULL);
6c9385e0 1084 strftime(buf,64,"%d %b %H:%M:%S",localtime(&now));
054e426d 1085 fprintf(fp,"[%d] %s %c ",(int)getpid(),buf,c[level]);
ed9b544e 1086 vfprintf(fp, fmt, ap);
1087 fprintf(fp,"\n");
1088 fflush(fp);
1089 }
1090 va_end(ap);
1091
1092 if (server.logfile) fclose(fp);
1093}
1094
1095/*====================== Hash table type implementation ==================== */
1096
1097/* This is an hash table type that uses the SDS dynamic strings libary as
1098 * keys and radis objects as values (objects can hold SDS strings,
1099 * lists, sets). */
1100
1812e024 1101static void dictVanillaFree(void *privdata, void *val)
1102{
1103 DICT_NOTUSED(privdata);
1104 zfree(val);
1105}
1106
4409877e 1107static void dictListDestructor(void *privdata, void *val)
1108{
1109 DICT_NOTUSED(privdata);
1110 listRelease((list*)val);
1111}
1112
ed9b544e 1113static int sdsDictKeyCompare(void *privdata, const void *key1,
1114 const void *key2)
1115{
1116 int l1,l2;
1117 DICT_NOTUSED(privdata);
1118
1119 l1 = sdslen((sds)key1);
1120 l2 = sdslen((sds)key2);
1121 if (l1 != l2) return 0;
1122 return memcmp(key1, key2, l1) == 0;
1123}
1124
1125static void dictRedisObjectDestructor(void *privdata, void *val)
1126{
1127 DICT_NOTUSED(privdata);
1128
a35ddf12 1129 if (val == NULL) return; /* Values of swapped out keys as set to NULL */
ed9b544e 1130 decrRefCount(val);
1131}
1132
942a3961 1133static int dictObjKeyCompare(void *privdata, const void *key1,
ed9b544e 1134 const void *key2)
1135{
1136 const robj *o1 = key1, *o2 = key2;
1137 return sdsDictKeyCompare(privdata,o1->ptr,o2->ptr);
1138}
1139
942a3961 1140static unsigned int dictObjHash(const void *key) {
ed9b544e 1141 const robj *o = key;
1142 return dictGenHashFunction(o->ptr, sdslen((sds)o->ptr));
1143}
1144
942a3961 1145static int dictEncObjKeyCompare(void *privdata, const void *key1,
1146 const void *key2)
1147{
9d65a1bb 1148 robj *o1 = (robj*) key1, *o2 = (robj*) key2;
1149 int cmp;
942a3961 1150
2a1198b4 1151 if (o1->encoding == REDIS_ENCODING_INT &&
dc05abde 1152 o2->encoding == REDIS_ENCODING_INT)
1153 return o1->ptr == o2->ptr;
2a1198b4 1154
9d65a1bb 1155 o1 = getDecodedObject(o1);
1156 o2 = getDecodedObject(o2);
1157 cmp = sdsDictKeyCompare(privdata,o1->ptr,o2->ptr);
1158 decrRefCount(o1);
1159 decrRefCount(o2);
1160 return cmp;
942a3961 1161}
1162
1163static unsigned int dictEncObjHash(const void *key) {
9d65a1bb 1164 robj *o = (robj*) key;
942a3961 1165
ed9e4966 1166 if (o->encoding == REDIS_ENCODING_RAW) {
1167 return dictGenHashFunction(o->ptr, sdslen((sds)o->ptr));
1168 } else {
1169 if (o->encoding == REDIS_ENCODING_INT) {
1170 char buf[32];
1171 int len;
1172
ee14da56 1173 len = ll2string(buf,32,(long)o->ptr);
ed9e4966 1174 return dictGenHashFunction((unsigned char*)buf, len);
1175 } else {
1176 unsigned int hash;
1177
1178 o = getDecodedObject(o);
1179 hash = dictGenHashFunction(o->ptr, sdslen((sds)o->ptr));
1180 decrRefCount(o);
1181 return hash;
1182 }
1183 }
942a3961 1184}
1185
f2d9f50f 1186/* Sets type and expires */
ed9b544e 1187static dictType setDictType = {
942a3961 1188 dictEncObjHash, /* hash function */
ed9b544e 1189 NULL, /* key dup */
1190 NULL, /* val dup */
942a3961 1191 dictEncObjKeyCompare, /* key compare */
ed9b544e 1192 dictRedisObjectDestructor, /* key destructor */
1193 NULL /* val destructor */
1194};
1195
f2d9f50f 1196/* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
1812e024 1197static dictType zsetDictType = {
1198 dictEncObjHash, /* hash function */
1199 NULL, /* key dup */
1200 NULL, /* val dup */
1201 dictEncObjKeyCompare, /* key compare */
1202 dictRedisObjectDestructor, /* key destructor */
da0a1620 1203 dictVanillaFree /* val destructor of malloc(sizeof(double)) */
1812e024 1204};
1205
f2d9f50f 1206/* Db->dict */
5234952b 1207static dictType dbDictType = {
942a3961 1208 dictObjHash, /* hash function */
ed9b544e 1209 NULL, /* key dup */
1210 NULL, /* val dup */
942a3961 1211 dictObjKeyCompare, /* key compare */
ed9b544e 1212 dictRedisObjectDestructor, /* key destructor */
1213 dictRedisObjectDestructor /* val destructor */
1214};
1215
f2d9f50f 1216/* Db->expires */
1217static dictType keyptrDictType = {
1218 dictObjHash, /* hash function */
1219 NULL, /* key dup */
1220 NULL, /* val dup */
1221 dictObjKeyCompare, /* key compare */
1222 dictRedisObjectDestructor, /* key destructor */
1223 NULL /* val destructor */
1224};
1225
5234952b 1226/* Hash type hash table (note that small hashes are represented with zimpaps) */
1227static dictType hashDictType = {
1228 dictEncObjHash, /* hash function */
1229 NULL, /* key dup */
1230 NULL, /* val dup */
1231 dictEncObjKeyCompare, /* key compare */
1232 dictRedisObjectDestructor, /* key destructor */
1233 dictRedisObjectDestructor /* val destructor */
1234};
1235
4409877e 1236/* Keylist hash table type has unencoded redis objects as keys and
d5d55fc3 1237 * lists as values. It's used for blocking operations (BLPOP) and to
1238 * map swapped keys to a list of clients waiting for this keys to be loaded. */
4409877e 1239static dictType keylistDictType = {
1240 dictObjHash, /* hash function */
1241 NULL, /* key dup */
1242 NULL, /* val dup */
1243 dictObjKeyCompare, /* key compare */
1244 dictRedisObjectDestructor, /* key destructor */
1245 dictListDestructor /* val destructor */
1246};
1247
42ab0172
AO
1248static void version();
1249
ed9b544e 1250/* ========================= Random utility functions ======================= */
1251
1252/* Redis generally does not try to recover from out of memory conditions
1253 * when allocating objects or strings, it is not clear if it will be possible
1254 * to report this condition to the client since the networking layer itself
1255 * is based on heap allocation for send buffers, so we simply abort.
1256 * At least the code will be simpler to read... */
1257static void oom(const char *msg) {
71c54b21 1258 redisLog(REDIS_WARNING, "%s: Out of memory\n",msg);
ed9b544e 1259 sleep(1);
1260 abort();
1261}
1262
1263/* ====================== Redis server networking stuff ===================== */
56906eef 1264static void closeTimedoutClients(void) {
ed9b544e 1265 redisClient *c;
ed9b544e 1266 listNode *ln;
1267 time_t now = time(NULL);
c7df85a4 1268 listIter li;
ed9b544e 1269
c7df85a4 1270 listRewind(server.clients,&li);
1271 while ((ln = listNext(&li)) != NULL) {
ed9b544e 1272 c = listNodeValue(ln);
f86a74e9 1273 if (server.maxidletime &&
1274 !(c->flags & REDIS_SLAVE) && /* no timeout for slaves */
c7cf2ec9 1275 !(c->flags & REDIS_MASTER) && /* no timeout for masters */
ffc6b7f8 1276 dictSize(c->pubsub_channels) == 0 && /* no timeout for pubsub */
1277 listLength(c->pubsub_patterns) == 0 &&
d6cc8867 1278 (now - c->lastinteraction > server.maxidletime))
f86a74e9 1279 {
f870935d 1280 redisLog(REDIS_VERBOSE,"Closing idle client");
ed9b544e 1281 freeClient(c);
f86a74e9 1282 } else if (c->flags & REDIS_BLOCKED) {
58d976b8 1283 if (c->blockingto != 0 && c->blockingto < now) {
b177fd30 1284 addReply(c,shared.nullmultibulk);
b0d8747d 1285 unblockClientWaitingData(c);
f86a74e9 1286 }
ed9b544e 1287 }
1288 }
ed9b544e 1289}
1290
12fea928 1291static int htNeedsResize(dict *dict) {
1292 long long size, used;
1293
1294 size = dictSlots(dict);
1295 used = dictSize(dict);
1296 return (size && used && size > DICT_HT_INITIAL_SIZE &&
1297 (used*100/size < REDIS_HT_MINFILL));
1298}
1299
0bc03378 1300/* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
1301 * we resize the hash table to save memory */
56906eef 1302static void tryResizeHashTables(void) {
0bc03378 1303 int j;
1304
1305 for (j = 0; j < server.dbnum; j++) {
5413c40d 1306 if (htNeedsResize(server.db[j].dict))
0bc03378 1307 dictResize(server.db[j].dict);
12fea928 1308 if (htNeedsResize(server.db[j].expires))
1309 dictResize(server.db[j].expires);
0bc03378 1310 }
1311}
1312
8ca3e9d1 1313/* Our hash table implementation performs rehashing incrementally while
1314 * we write/read from the hash table. Still if the server is idle, the hash
1315 * table will use two tables for a long time. So we try to use 1 millisecond
1316 * of CPU time at every serverCron() loop in order to rehash some key. */
1317static void incrementallyRehash(void) {
1318 int j;
1319
1320 for (j = 0; j < server.dbnum; j++) {
1321 if (dictIsRehashing(server.db[j].dict)) {
1322 dictRehashMilliseconds(server.db[j].dict,1);
1323 break; /* already used our millisecond for this loop... */
1324 }
1325 }
1326}
1327
9d65a1bb 1328/* A background saving child (BGSAVE) terminated its work. Handle this. */
1329void backgroundSaveDoneHandler(int statloc) {
1330 int exitcode = WEXITSTATUS(statloc);
1331 int bysignal = WIFSIGNALED(statloc);
1332
1333 if (!bysignal && exitcode == 0) {
1334 redisLog(REDIS_NOTICE,
1335 "Background saving terminated with success");
1336 server.dirty = 0;
1337 server.lastsave = time(NULL);
1338 } else if (!bysignal && exitcode != 0) {
1339 redisLog(REDIS_WARNING, "Background saving error");
1340 } else {
1341 redisLog(REDIS_WARNING,
454eea7c 1342 "Background saving terminated by signal %d", WTERMSIG(statloc));
9d65a1bb 1343 rdbRemoveTempFile(server.bgsavechildpid);
1344 }
1345 server.bgsavechildpid = -1;
1346 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1347 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1348 updateSlavesWaitingBgsave(exitcode == 0 ? REDIS_OK : REDIS_ERR);
1349}
1350
1351/* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1352 * Handle this. */
1353void backgroundRewriteDoneHandler(int statloc) {
1354 int exitcode = WEXITSTATUS(statloc);
1355 int bysignal = WIFSIGNALED(statloc);
1356
1357 if (!bysignal && exitcode == 0) {
1358 int fd;
1359 char tmpfile[256];
1360
1361 redisLog(REDIS_NOTICE,
1362 "Background append only file rewriting terminated with success");
1363 /* Now it's time to flush the differences accumulated by the parent */
1364 snprintf(tmpfile,256,"temp-rewriteaof-bg-%d.aof", (int) server.bgrewritechildpid);
1365 fd = open(tmpfile,O_WRONLY|O_APPEND);
1366 if (fd == -1) {
1367 redisLog(REDIS_WARNING, "Not able to open the temp append only file produced by the child: %s", strerror(errno));
1368 goto cleanup;
1369 }
1370 /* Flush our data... */
1371 if (write(fd,server.bgrewritebuf,sdslen(server.bgrewritebuf)) !=
1372 (signed) sdslen(server.bgrewritebuf)) {
1373 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));
1374 close(fd);
1375 goto cleanup;
1376 }
b32627cd 1377 redisLog(REDIS_NOTICE,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server.bgrewritebuf));
9d65a1bb 1378 /* Now our work is to rename the temp file into the stable file. And
1379 * switch the file descriptor used by the server for append only. */
1380 if (rename(tmpfile,server.appendfilename) == -1) {
1381 redisLog(REDIS_WARNING,"Can't rename the temp append only file into the stable one: %s", strerror(errno));
1382 close(fd);
1383 goto cleanup;
1384 }
1385 /* Mission completed... almost */
1386 redisLog(REDIS_NOTICE,"Append only file successfully rewritten.");
1387 if (server.appendfd != -1) {
1388 /* If append only is actually enabled... */
1389 close(server.appendfd);
1390 server.appendfd = fd;
1391 fsync(fd);
85a83172 1392 server.appendseldb = -1; /* Make sure it will issue SELECT */
9d65a1bb 1393 redisLog(REDIS_NOTICE,"The new append only file was selected for future appends.");
1394 } else {
1395 /* If append only is disabled we just generate a dump in this
1396 * format. Why not? */
1397 close(fd);
1398 }
1399 } else if (!bysignal && exitcode != 0) {
1400 redisLog(REDIS_WARNING, "Background append only file rewriting error");
1401 } else {
1402 redisLog(REDIS_WARNING,
454eea7c 1403 "Background append only file rewriting terminated by signal %d",
1404 WTERMSIG(statloc));
9d65a1bb 1405 }
1406cleanup:
1407 sdsfree(server.bgrewritebuf);
1408 server.bgrewritebuf = sdsempty();
1409 aofRemoveTempFile(server.bgrewritechildpid);
1410 server.bgrewritechildpid = -1;
1411}
1412
884d4b39 1413/* This function is called once a background process of some kind terminates,
1414 * as we want to avoid resizing the hash tables when there is a child in order
1415 * to play well with copy-on-write (otherwise when a resize happens lots of
1416 * memory pages are copied). The goal of this function is to update the ability
1417 * for dict.c to resize the hash tables accordingly to the fact we have o not
1418 * running childs. */
1419static void updateDictResizePolicy(void) {
1420 if (server.bgsavechildpid == -1 && server.bgrewritechildpid == -1)
1421 dictEnableResize();
1422 else
1423 dictDisableResize();
1424}
1425
56906eef 1426static int serverCron(struct aeEventLoop *eventLoop, long long id, void *clientData) {
94754ccc 1427 int j, loops = server.cronloops++;
ed9b544e 1428 REDIS_NOTUSED(eventLoop);
1429 REDIS_NOTUSED(id);
1430 REDIS_NOTUSED(clientData);
1431
3a66edc7 1432 /* We take a cached value of the unix time in the global state because
1433 * with virtual memory and aging there is to store the current time
1434 * in objects at every object access, and accuracy is not needed.
1435 * To access a global var is faster than calling time(NULL) */
1436 server.unixtime = time(NULL);
1437
fab43727 1438 /* We received a SIGTERM, shutting down here in a safe way, as it is
1439 * not ok doing so inside the signal handler. */
1440 if (server.shutdown_asap) {
1441 if (prepareForShutdown() == REDIS_OK) exit(0);
1442 redisLog(REDIS_WARNING,"SIGTERM received but errors trying to shut down the server, check the logs for more information");
1443 }
1444
0bc03378 1445 /* Show some info about non-empty databases */
ed9b544e 1446 for (j = 0; j < server.dbnum; j++) {
dec423d9 1447 long long size, used, vkeys;
94754ccc 1448
3305306f 1449 size = dictSlots(server.db[j].dict);
1450 used = dictSize(server.db[j].dict);
94754ccc 1451 vkeys = dictSize(server.db[j].expires);
1763929f 1452 if (!(loops % 50) && (used || vkeys)) {
f870935d 1453 redisLog(REDIS_VERBOSE,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j,used,vkeys,size);
a4d1ba9a 1454 /* dictPrintStats(server.dict); */
ed9b544e 1455 }
ed9b544e 1456 }
1457
0bc03378 1458 /* We don't want to resize the hash tables while a bacground saving
1459 * is in progress: the saving child is created using fork() that is
1460 * implemented with a copy-on-write semantic in most modern systems, so
1461 * if we resize the HT while there is the saving child at work actually
1462 * a lot of memory movements in the parent will cause a lot of pages
1463 * copied. */
8ca3e9d1 1464 if (server.bgsavechildpid == -1 && server.bgrewritechildpid == -1) {
1465 if (!(loops % 10)) tryResizeHashTables();
1466 if (server.activerehashing) incrementallyRehash();
884d4b39 1467 }
0bc03378 1468
ed9b544e 1469 /* Show information about connected clients */
1763929f 1470 if (!(loops % 50)) {
bdcb92f2 1471 redisLog(REDIS_VERBOSE,"%d clients connected (%d slaves), %zu bytes in use",
ed9b544e 1472 listLength(server.clients)-listLength(server.slaves),
1473 listLength(server.slaves),
bdcb92f2 1474 zmalloc_used_memory());
ed9b544e 1475 }
1476
1477 /* Close connections of timedout clients */
1763929f 1478 if ((server.maxidletime && !(loops % 100)) || server.blpop_blocked_clients)
ed9b544e 1479 closeTimedoutClients();
1480
9d65a1bb 1481 /* Check if a background saving or AOF rewrite in progress terminated */
1482 if (server.bgsavechildpid != -1 || server.bgrewritechildpid != -1) {
ed9b544e 1483 int statloc;
9d65a1bb 1484 pid_t pid;
1485
1486 if ((pid = wait3(&statloc,WNOHANG,NULL)) != 0) {
1487 if (pid == server.bgsavechildpid) {
1488 backgroundSaveDoneHandler(statloc);
ed9b544e 1489 } else {
9d65a1bb 1490 backgroundRewriteDoneHandler(statloc);
ed9b544e 1491 }
884d4b39 1492 updateDictResizePolicy();
ed9b544e 1493 }
1494 } else {
1495 /* If there is not a background saving in progress check if
1496 * we have to save now */
1497 time_t now = time(NULL);
1498 for (j = 0; j < server.saveparamslen; j++) {
1499 struct saveparam *sp = server.saveparams+j;
1500
1501 if (server.dirty >= sp->changes &&
1502 now-server.lastsave > sp->seconds) {
1503 redisLog(REDIS_NOTICE,"%d changes in %d seconds. Saving...",
1504 sp->changes, sp->seconds);
f78fd11b 1505 rdbSaveBackground(server.dbfilename);
ed9b544e 1506 break;
1507 }
1508 }
1509 }
94754ccc 1510
f2324293 1511 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1512 * will use few CPU cycles if there are few expiring keys, otherwise
1513 * it will get more aggressive to avoid that too much memory is used by
1514 * keys that can be removed from the keyspace. */
94754ccc 1515 for (j = 0; j < server.dbnum; j++) {
f2324293 1516 int expired;
94754ccc 1517 redisDb *db = server.db+j;
94754ccc 1518
f2324293 1519 /* Continue to expire if at the end of the cycle more than 25%
1520 * of the keys were expired. */
1521 do {
4ef8de8a 1522 long num = dictSize(db->expires);
94754ccc 1523 time_t now = time(NULL);
1524
f2324293 1525 expired = 0;
94754ccc 1526 if (num > REDIS_EXPIRELOOKUPS_PER_CRON)
1527 num = REDIS_EXPIRELOOKUPS_PER_CRON;
1528 while (num--) {
1529 dictEntry *de;
1530 time_t t;
1531
1532 if ((de = dictGetRandomKey(db->expires)) == NULL) break;
1533 t = (time_t) dictGetEntryVal(de);
1534 if (now > t) {
1535 deleteKey(db,dictGetEntryKey(de));
f2324293 1536 expired++;
2a6a2ed1 1537 server.stat_expiredkeys++;
94754ccc 1538 }
1539 }
f2324293 1540 } while (expired > REDIS_EXPIRELOOKUPS_PER_CRON/4);
94754ccc 1541 }
1542
4ef8de8a 1543 /* Swap a few keys on disk if we are over the memory limit and VM
f870935d 1544 * is enbled. Try to free objects from the free list first. */
7e69548d 1545 if (vmCanSwapOut()) {
1546 while (server.vm_enabled && zmalloc_used_memory() >
f870935d 1547 server.vm_max_memory)
1548 {
72e9fd40 1549 int retval;
1550
a5819310 1551 if (tryFreeOneObjectFromFreelist() == REDIS_OK) continue;
72e9fd40 1552 retval = (server.vm_max_threads == 0) ?
1553 vmSwapOneObjectBlocking() :
1554 vmSwapOneObjectThreaded();
1763929f 1555 if (retval == REDIS_ERR && !(loops % 300) &&
72e9fd40 1556 zmalloc_used_memory() >
1557 (server.vm_max_memory+server.vm_max_memory/10))
1558 {
1559 redisLog(REDIS_WARNING,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
7e69548d 1560 }
72e9fd40 1561 /* Note that when using threade I/O we free just one object,
1562 * because anyway when the I/O thread in charge to swap this
1563 * object out will finish, the handler of completed jobs
1564 * will try to swap more objects if we are still out of memory. */
1565 if (retval == REDIS_ERR || server.vm_max_threads > 0) break;
4ef8de8a 1566 }
1567 }
1568
ed9b544e 1569 /* Check if we should connect to a MASTER */
1763929f 1570 if (server.replstate == REDIS_REPL_CONNECT && !(loops % 10)) {
ed9b544e 1571 redisLog(REDIS_NOTICE,"Connecting to MASTER...");
1572 if (syncWithMaster() == REDIS_OK) {
1573 redisLog(REDIS_NOTICE,"MASTER <-> SLAVE sync succeeded");
8f63ddca 1574 if (server.appendonly) rewriteAppendOnlyFileBackground();
ed9b544e 1575 }
1576 }
1763929f 1577 return 100;
ed9b544e 1578}
1579
d5d55fc3 1580/* This function gets called every time Redis is entering the
1581 * main loop of the event driven library, that is, before to sleep
1582 * for ready file descriptors. */
1583static void beforeSleep(struct aeEventLoop *eventLoop) {
1584 REDIS_NOTUSED(eventLoop);
1585
28ed1f33 1586 /* Awake clients that got all the swapped keys they requested */
d5d55fc3 1587 if (server.vm_enabled && listLength(server.io_ready_clients)) {
1588 listIter li;
1589 listNode *ln;
1590
1591 listRewind(server.io_ready_clients,&li);
1592 while((ln = listNext(&li))) {
1593 redisClient *c = ln->value;
1594 struct redisCommand *cmd;
1595
1596 /* Resume the client. */
1597 listDelNode(server.io_ready_clients,ln);
1598 c->flags &= (~REDIS_IO_WAIT);
1599 server.vm_blocked_clients--;
1600 aeCreateFileEvent(server.el, c->fd, AE_READABLE,
1601 readQueryFromClient, c);
1602 cmd = lookupCommand(c->argv[0]->ptr);
1603 assert(cmd != NULL);
1604 call(c,cmd);
1605 resetClient(c);
1606 /* There may be more data to process in the input buffer. */
1607 if (c->querybuf && sdslen(c->querybuf) > 0)
1608 processInputBuffer(c);
1609 }
1610 }
28ed1f33 1611 /* Write the AOF buffer on disk */
1612 flushAppendOnlyFile();
d5d55fc3 1613}
1614
ed9b544e 1615static void createSharedObjects(void) {
05df7621 1616 int j;
1617
ed9b544e 1618 shared.crlf = createObject(REDIS_STRING,sdsnew("\r\n"));
1619 shared.ok = createObject(REDIS_STRING,sdsnew("+OK\r\n"));
1620 shared.err = createObject(REDIS_STRING,sdsnew("-ERR\r\n"));
c937aa89 1621 shared.emptybulk = createObject(REDIS_STRING,sdsnew("$0\r\n\r\n"));
1622 shared.czero = createObject(REDIS_STRING,sdsnew(":0\r\n"));
1623 shared.cone = createObject(REDIS_STRING,sdsnew(":1\r\n"));
1624 shared.nullbulk = createObject(REDIS_STRING,sdsnew("$-1\r\n"));
1625 shared.nullmultibulk = createObject(REDIS_STRING,sdsnew("*-1\r\n"));
1626 shared.emptymultibulk = createObject(REDIS_STRING,sdsnew("*0\r\n"));
ed9b544e 1627 shared.pong = createObject(REDIS_STRING,sdsnew("+PONG\r\n"));
6e469882 1628 shared.queued = createObject(REDIS_STRING,sdsnew("+QUEUED\r\n"));
ed9b544e 1629 shared.wrongtypeerr = createObject(REDIS_STRING,sdsnew(
1630 "-ERR Operation against a key holding the wrong kind of value\r\n"));
ed9b544e 1631 shared.nokeyerr = createObject(REDIS_STRING,sdsnew(
1632 "-ERR no such key\r\n"));
ed9b544e 1633 shared.syntaxerr = createObject(REDIS_STRING,sdsnew(
1634 "-ERR syntax error\r\n"));
c937aa89 1635 shared.sameobjecterr = createObject(REDIS_STRING,sdsnew(
1636 "-ERR source and destination objects are the same\r\n"));
1637 shared.outofrangeerr = createObject(REDIS_STRING,sdsnew(
1638 "-ERR index out of range\r\n"));
ed9b544e 1639 shared.space = createObject(REDIS_STRING,sdsnew(" "));
c937aa89 1640 shared.colon = createObject(REDIS_STRING,sdsnew(":"));
1641 shared.plus = createObject(REDIS_STRING,sdsnew("+"));
ed9b544e 1642 shared.select0 = createStringObject("select 0\r\n",10);
1643 shared.select1 = createStringObject("select 1\r\n",10);
1644 shared.select2 = createStringObject("select 2\r\n",10);
1645 shared.select3 = createStringObject("select 3\r\n",10);
1646 shared.select4 = createStringObject("select 4\r\n",10);
1647 shared.select5 = createStringObject("select 5\r\n",10);
1648 shared.select6 = createStringObject("select 6\r\n",10);
1649 shared.select7 = createStringObject("select 7\r\n",10);
1650 shared.select8 = createStringObject("select 8\r\n",10);
1651 shared.select9 = createStringObject("select 9\r\n",10);
befec3cd 1652 shared.messagebulk = createStringObject("$7\r\nmessage\r\n",13);
c8d0ea0e 1653 shared.pmessagebulk = createStringObject("$8\r\npmessage\r\n",14);
befec3cd 1654 shared.subscribebulk = createStringObject("$9\r\nsubscribe\r\n",15);
fc46bb71 1655 shared.unsubscribebulk = createStringObject("$11\r\nunsubscribe\r\n",18);
ffc6b7f8 1656 shared.psubscribebulk = createStringObject("$10\r\npsubscribe\r\n",17);
1657 shared.punsubscribebulk = createStringObject("$12\r\npunsubscribe\r\n",19);
befec3cd 1658 shared.mbulk3 = createStringObject("*3\r\n",4);
c8d0ea0e 1659 shared.mbulk4 = createStringObject("*4\r\n",4);
05df7621 1660 for (j = 0; j < REDIS_SHARED_INTEGERS; j++) {
1661 shared.integers[j] = createObject(REDIS_STRING,(void*)(long)j);
1662 shared.integers[j]->encoding = REDIS_ENCODING_INT;
1663 }
ed9b544e 1664}
1665
1666static void appendServerSaveParams(time_t seconds, int changes) {
1667 server.saveparams = zrealloc(server.saveparams,sizeof(struct saveparam)*(server.saveparamslen+1));
ed9b544e 1668 server.saveparams[server.saveparamslen].seconds = seconds;
1669 server.saveparams[server.saveparamslen].changes = changes;
1670 server.saveparamslen++;
1671}
1672
bcfc686d 1673static void resetServerSaveParams() {
ed9b544e 1674 zfree(server.saveparams);
1675 server.saveparams = NULL;
1676 server.saveparamslen = 0;
1677}
1678
1679static void initServerConfig() {
1680 server.dbnum = REDIS_DEFAULT_DBNUM;
1681 server.port = REDIS_SERVERPORT;
f870935d 1682 server.verbosity = REDIS_VERBOSE;
ed9b544e 1683 server.maxidletime = REDIS_MAXIDLETIME;
1684 server.saveparams = NULL;
1685 server.logfile = NULL; /* NULL = log on standard output */
1686 server.bindaddr = NULL;
1687 server.glueoutputbuf = 1;
1688 server.daemonize = 0;
44b38ef4 1689 server.appendonly = 0;
1b677732 1690 server.appendfsync = APPENDFSYNC_EVERYSEC;
48f0308a 1691 server.lastfsync = time(NULL);
44b38ef4 1692 server.appendfd = -1;
1693 server.appendseldb = -1; /* Make sure the first time will not match */
500ece7c 1694 server.pidfile = zstrdup("/var/run/redis.pid");
1695 server.dbfilename = zstrdup("dump.rdb");
1696 server.appendfilename = zstrdup("appendonly.aof");
abcb223e 1697 server.requirepass = NULL;
b0553789 1698 server.rdbcompression = 1;
8ca3e9d1 1699 server.activerehashing = 1;
285add55 1700 server.maxclients = 0;
d5d55fc3 1701 server.blpop_blocked_clients = 0;
3fd78bcd 1702 server.maxmemory = 0;
75680a3c 1703 server.vm_enabled = 0;
054e426d 1704 server.vm_swap_file = zstrdup("/tmp/redis-%p.vm");
75680a3c 1705 server.vm_page_size = 256; /* 256 bytes per page */
1706 server.vm_pages = 1024*1024*100; /* 104 millions of pages */
1707 server.vm_max_memory = 1024LL*1024*1024*1; /* 1 GB of RAM */
92f8e882 1708 server.vm_max_threads = 4;
d5d55fc3 1709 server.vm_blocked_clients = 0;
cbba7dd7 1710 server.hash_max_zipmap_entries = REDIS_HASH_MAX_ZIPMAP_ENTRIES;
1711 server.hash_max_zipmap_value = REDIS_HASH_MAX_ZIPMAP_VALUE;
fab43727 1712 server.shutdown_asap = 0;
75680a3c 1713
bcfc686d 1714 resetServerSaveParams();
ed9b544e 1715
1716 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1717 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1718 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1719 /* Replication related */
1720 server.isslave = 0;
d0ccebcf 1721 server.masterauth = NULL;
ed9b544e 1722 server.masterhost = NULL;
1723 server.masterport = 6379;
1724 server.master = NULL;
1725 server.replstate = REDIS_REPL_NONE;
a7866db6 1726
1727 /* Double constants initialization */
1728 R_Zero = 0.0;
1729 R_PosInf = 1.0/R_Zero;
1730 R_NegInf = -1.0/R_Zero;
1731 R_Nan = R_Zero/R_Zero;
ed9b544e 1732}
1733
1734static void initServer() {
1735 int j;
1736
1737 signal(SIGHUP, SIG_IGN);
1738 signal(SIGPIPE, SIG_IGN);
fe3bbfbe 1739 setupSigSegvAction();
ed9b544e 1740
b9bc0eef 1741 server.devnull = fopen("/dev/null","w");
1742 if (server.devnull == NULL) {
1743 redisLog(REDIS_WARNING, "Can't open /dev/null: %s", server.neterr);
1744 exit(1);
1745 }
ed9b544e 1746 server.clients = listCreate();
1747 server.slaves = listCreate();
87eca727 1748 server.monitors = listCreate();
ed9b544e 1749 server.objfreelist = listCreate();
1750 createSharedObjects();
1751 server.el = aeCreateEventLoop();
3305306f 1752 server.db = zmalloc(sizeof(redisDb)*server.dbnum);
ed9b544e 1753 server.fd = anetTcpServer(server.neterr, server.port, server.bindaddr);
1754 if (server.fd == -1) {
1755 redisLog(REDIS_WARNING, "Opening TCP port: %s", server.neterr);
1756 exit(1);
1757 }
3305306f 1758 for (j = 0; j < server.dbnum; j++) {
5234952b 1759 server.db[j].dict = dictCreate(&dbDictType,NULL);
f2d9f50f 1760 server.db[j].expires = dictCreate(&keyptrDictType,NULL);
37ab76c9 1761 server.db[j].blocking_keys = dictCreate(&keylistDictType,NULL);
1762 server.db[j].watched_keys = dictCreate(&keylistDictType,NULL);
d5d55fc3 1763 if (server.vm_enabled)
1764 server.db[j].io_keys = dictCreate(&keylistDictType,NULL);
3305306f 1765 server.db[j].id = j;
1766 }
ffc6b7f8 1767 server.pubsub_channels = dictCreate(&keylistDictType,NULL);
1768 server.pubsub_patterns = listCreate();
1769 listSetFreeMethod(server.pubsub_patterns,freePubsubPattern);
1770 listSetMatchMethod(server.pubsub_patterns,listMatchPubsubPattern);
ed9b544e 1771 server.cronloops = 0;
9f3c422c 1772 server.bgsavechildpid = -1;
9d65a1bb 1773 server.bgrewritechildpid = -1;
1774 server.bgrewritebuf = sdsempty();
28ed1f33 1775 server.aofbuf = sdsempty();
ed9b544e 1776 server.lastsave = time(NULL);
1777 server.dirty = 0;
ed9b544e 1778 server.stat_numcommands = 0;
1779 server.stat_numconnections = 0;
2a6a2ed1 1780 server.stat_expiredkeys = 0;
ed9b544e 1781 server.stat_starttime = time(NULL);
3a66edc7 1782 server.unixtime = time(NULL);
d8f8b666 1783 aeCreateTimeEvent(server.el, 1, serverCron, NULL, NULL);
996cb5f7 1784 if (aeCreateFileEvent(server.el, server.fd, AE_READABLE,
1785 acceptHandler, NULL) == AE_ERR) oom("creating file event");
44b38ef4 1786
1787 if (server.appendonly) {
3bb225d6 1788 server.appendfd = open(server.appendfilename,O_WRONLY|O_APPEND|O_CREAT,0644);
44b38ef4 1789 if (server.appendfd == -1) {
1790 redisLog(REDIS_WARNING, "Can't open the append-only file: %s",
1791 strerror(errno));
1792 exit(1);
1793 }
1794 }
75680a3c 1795
1796 if (server.vm_enabled) vmInit();
ed9b544e 1797}
1798
1799/* Empty the whole database */
ca37e9cd 1800static long long emptyDb() {
ed9b544e 1801 int j;
ca37e9cd 1802 long long removed = 0;
ed9b544e 1803
3305306f 1804 for (j = 0; j < server.dbnum; j++) {
ca37e9cd 1805 removed += dictSize(server.db[j].dict);
3305306f 1806 dictEmpty(server.db[j].dict);
1807 dictEmpty(server.db[j].expires);
1808 }
ca37e9cd 1809 return removed;
ed9b544e 1810}
1811
85dd2f3a 1812static int yesnotoi(char *s) {
1813 if (!strcasecmp(s,"yes")) return 1;
1814 else if (!strcasecmp(s,"no")) return 0;
1815 else return -1;
1816}
1817
ed9b544e 1818/* I agree, this is a very rudimental way to load a configuration...
1819 will improve later if the config gets more complex */
1820static void loadServerConfig(char *filename) {
c9a111ac 1821 FILE *fp;
ed9b544e 1822 char buf[REDIS_CONFIGLINE_MAX+1], *err = NULL;
1823 int linenum = 0;
1824 sds line = NULL;
c9a111ac 1825
1826 if (filename[0] == '-' && filename[1] == '\0')
1827 fp = stdin;
1828 else {
1829 if ((fp = fopen(filename,"r")) == NULL) {
9a22de82 1830 redisLog(REDIS_WARNING, "Fatal error, can't open config file '%s'", filename);
c9a111ac 1831 exit(1);
1832 }
ed9b544e 1833 }
c9a111ac 1834
ed9b544e 1835 while(fgets(buf,REDIS_CONFIGLINE_MAX+1,fp) != NULL) {
1836 sds *argv;
1837 int argc, j;
1838
1839 linenum++;
1840 line = sdsnew(buf);
1841 line = sdstrim(line," \t\r\n");
1842
1843 /* Skip comments and blank lines*/
1844 if (line[0] == '#' || line[0] == '\0') {
1845 sdsfree(line);
1846 continue;
1847 }
1848
1849 /* Split into arguments */
1850 argv = sdssplitlen(line,sdslen(line)," ",1,&argc);
1851 sdstolower(argv[0]);
1852
1853 /* Execute config directives */
bb0b03a3 1854 if (!strcasecmp(argv[0],"timeout") && argc == 2) {
ed9b544e 1855 server.maxidletime = atoi(argv[1]);
0150db36 1856 if (server.maxidletime < 0) {
ed9b544e 1857 err = "Invalid timeout value"; goto loaderr;
1858 }
bb0b03a3 1859 } else if (!strcasecmp(argv[0],"port") && argc == 2) {
ed9b544e 1860 server.port = atoi(argv[1]);
1861 if (server.port < 1 || server.port > 65535) {
1862 err = "Invalid port"; goto loaderr;
1863 }
bb0b03a3 1864 } else if (!strcasecmp(argv[0],"bind") && argc == 2) {
ed9b544e 1865 server.bindaddr = zstrdup(argv[1]);
bb0b03a3 1866 } else if (!strcasecmp(argv[0],"save") && argc == 3) {
ed9b544e 1867 int seconds = atoi(argv[1]);
1868 int changes = atoi(argv[2]);
1869 if (seconds < 1 || changes < 0) {
1870 err = "Invalid save parameters"; goto loaderr;
1871 }
1872 appendServerSaveParams(seconds,changes);
bb0b03a3 1873 } else if (!strcasecmp(argv[0],"dir") && argc == 2) {
ed9b544e 1874 if (chdir(argv[1]) == -1) {
1875 redisLog(REDIS_WARNING,"Can't chdir to '%s': %s",
1876 argv[1], strerror(errno));
1877 exit(1);
1878 }
bb0b03a3 1879 } else if (!strcasecmp(argv[0],"loglevel") && argc == 2) {
1880 if (!strcasecmp(argv[1],"debug")) server.verbosity = REDIS_DEBUG;
f870935d 1881 else if (!strcasecmp(argv[1],"verbose")) server.verbosity = REDIS_VERBOSE;
bb0b03a3 1882 else if (!strcasecmp(argv[1],"notice")) server.verbosity = REDIS_NOTICE;
1883 else if (!strcasecmp(argv[1],"warning")) server.verbosity = REDIS_WARNING;
ed9b544e 1884 else {
1885 err = "Invalid log level. Must be one of debug, notice, warning";
1886 goto loaderr;
1887 }
bb0b03a3 1888 } else if (!strcasecmp(argv[0],"logfile") && argc == 2) {
c9a111ac 1889 FILE *logfp;
ed9b544e 1890
1891 server.logfile = zstrdup(argv[1]);
bb0b03a3 1892 if (!strcasecmp(server.logfile,"stdout")) {
ed9b544e 1893 zfree(server.logfile);
1894 server.logfile = NULL;
1895 }
1896 if (server.logfile) {
1897 /* Test if we are able to open the file. The server will not
1898 * be able to abort just for this problem later... */
c9a111ac 1899 logfp = fopen(server.logfile,"a");
1900 if (logfp == NULL) {
ed9b544e 1901 err = sdscatprintf(sdsempty(),
1902 "Can't open the log file: %s", strerror(errno));
1903 goto loaderr;
1904 }
c9a111ac 1905 fclose(logfp);
ed9b544e 1906 }
bb0b03a3 1907 } else if (!strcasecmp(argv[0],"databases") && argc == 2) {
ed9b544e 1908 server.dbnum = atoi(argv[1]);
1909 if (server.dbnum < 1) {
1910 err = "Invalid number of databases"; goto loaderr;
1911 }
b3f83f12
JZ
1912 } else if (!strcasecmp(argv[0],"include") && argc == 2) {
1913 loadServerConfig(argv[1]);
285add55 1914 } else if (!strcasecmp(argv[0],"maxclients") && argc == 2) {
1915 server.maxclients = atoi(argv[1]);
3fd78bcd 1916 } else if (!strcasecmp(argv[0],"maxmemory") && argc == 2) {
2b619329 1917 server.maxmemory = memtoll(argv[1],NULL);
bb0b03a3 1918 } else if (!strcasecmp(argv[0],"slaveof") && argc == 3) {
ed9b544e 1919 server.masterhost = sdsnew(argv[1]);
1920 server.masterport = atoi(argv[2]);
1921 server.replstate = REDIS_REPL_CONNECT;
d0ccebcf 1922 } else if (!strcasecmp(argv[0],"masterauth") && argc == 2) {
1923 server.masterauth = zstrdup(argv[1]);
bb0b03a3 1924 } else if (!strcasecmp(argv[0],"glueoutputbuf") && argc == 2) {
85dd2f3a 1925 if ((server.glueoutputbuf = yesnotoi(argv[1])) == -1) {
ed9b544e 1926 err = "argument must be 'yes' or 'no'"; goto loaderr;
1927 }
121f70cf 1928 } else if (!strcasecmp(argv[0],"rdbcompression") && argc == 2) {
1929 if ((server.rdbcompression = yesnotoi(argv[1])) == -1) {
8ca3e9d1 1930 err = "argument must be 'yes' or 'no'"; goto loaderr;
1931 }
1932 } else if (!strcasecmp(argv[0],"activerehashing") && argc == 2) {
1933 if ((server.activerehashing = yesnotoi(argv[1])) == -1) {
121f70cf 1934 err = "argument must be 'yes' or 'no'"; goto loaderr;
1935 }
bb0b03a3 1936 } else if (!strcasecmp(argv[0],"daemonize") && argc == 2) {
85dd2f3a 1937 if ((server.daemonize = yesnotoi(argv[1])) == -1) {
ed9b544e 1938 err = "argument must be 'yes' or 'no'"; goto loaderr;
1939 }
44b38ef4 1940 } else if (!strcasecmp(argv[0],"appendonly") && argc == 2) {
1941 if ((server.appendonly = yesnotoi(argv[1])) == -1) {
1942 err = "argument must be 'yes' or 'no'"; goto loaderr;
1943 }
f3b52411
PN
1944 } else if (!strcasecmp(argv[0],"appendfilename") && argc == 2) {
1945 zfree(server.appendfilename);
1946 server.appendfilename = zstrdup(argv[1]);
48f0308a 1947 } else if (!strcasecmp(argv[0],"appendfsync") && argc == 2) {
1766c6da 1948 if (!strcasecmp(argv[1],"no")) {
48f0308a 1949 server.appendfsync = APPENDFSYNC_NO;
1766c6da 1950 } else if (!strcasecmp(argv[1],"always")) {
48f0308a 1951 server.appendfsync = APPENDFSYNC_ALWAYS;
1766c6da 1952 } else if (!strcasecmp(argv[1],"everysec")) {
48f0308a 1953 server.appendfsync = APPENDFSYNC_EVERYSEC;
1954 } else {
1955 err = "argument must be 'no', 'always' or 'everysec'";
1956 goto loaderr;
1957 }
bb0b03a3 1958 } else if (!strcasecmp(argv[0],"requirepass") && argc == 2) {
054e426d 1959 server.requirepass = zstrdup(argv[1]);
bb0b03a3 1960 } else if (!strcasecmp(argv[0],"pidfile") && argc == 2) {
500ece7c 1961 zfree(server.pidfile);
054e426d 1962 server.pidfile = zstrdup(argv[1]);
bb0b03a3 1963 } else if (!strcasecmp(argv[0],"dbfilename") && argc == 2) {
500ece7c 1964 zfree(server.dbfilename);
054e426d 1965 server.dbfilename = zstrdup(argv[1]);
75680a3c 1966 } else if (!strcasecmp(argv[0],"vm-enabled") && argc == 2) {
1967 if ((server.vm_enabled = yesnotoi(argv[1])) == -1) {
1968 err = "argument must be 'yes' or 'no'"; goto loaderr;
1969 }
054e426d 1970 } else if (!strcasecmp(argv[0],"vm-swap-file") && argc == 2) {
fefed597 1971 zfree(server.vm_swap_file);
054e426d 1972 server.vm_swap_file = zstrdup(argv[1]);
4ef8de8a 1973 } else if (!strcasecmp(argv[0],"vm-max-memory") && argc == 2) {
2b619329 1974 server.vm_max_memory = memtoll(argv[1],NULL);
4ef8de8a 1975 } else if (!strcasecmp(argv[0],"vm-page-size") && argc == 2) {
2b619329 1976 server.vm_page_size = memtoll(argv[1], NULL);
4ef8de8a 1977 } else if (!strcasecmp(argv[0],"vm-pages") && argc == 2) {
2b619329 1978 server.vm_pages = memtoll(argv[1], NULL);
92f8e882 1979 } else if (!strcasecmp(argv[0],"vm-max-threads") && argc == 2) {
1980 server.vm_max_threads = strtoll(argv[1], NULL, 10);
cbba7dd7 1981 } else if (!strcasecmp(argv[0],"hash-max-zipmap-entries") && argc == 2){
2b619329 1982 server.hash_max_zipmap_entries = memtoll(argv[1], NULL);
cbba7dd7 1983 } else if (!strcasecmp(argv[0],"hash-max-zipmap-value") && argc == 2){
2b619329 1984 server.hash_max_zipmap_value = memtoll(argv[1], NULL);
ed9b544e 1985 } else {
1986 err = "Bad directive or wrong number of arguments"; goto loaderr;
1987 }
1988 for (j = 0; j < argc; j++)
1989 sdsfree(argv[j]);
1990 zfree(argv);
1991 sdsfree(line);
1992 }
c9a111ac 1993 if (fp != stdin) fclose(fp);
ed9b544e 1994 return;
1995
1996loaderr:
1997 fprintf(stderr, "\n*** FATAL CONFIG FILE ERROR ***\n");
1998 fprintf(stderr, "Reading the configuration file, at line %d\n", linenum);
1999 fprintf(stderr, ">>> '%s'\n", line);
2000 fprintf(stderr, "%s\n", err);
2001 exit(1);
2002}
2003
2004static void freeClientArgv(redisClient *c) {
2005 int j;
2006
2007 for (j = 0; j < c->argc; j++)
2008 decrRefCount(c->argv[j]);
e8a74421 2009 for (j = 0; j < c->mbargc; j++)
2010 decrRefCount(c->mbargv[j]);
ed9b544e 2011 c->argc = 0;
e8a74421 2012 c->mbargc = 0;
ed9b544e 2013}
2014
2015static void freeClient(redisClient *c) {
2016 listNode *ln;
2017
4409877e 2018 /* Note that if the client we are freeing is blocked into a blocking
b0d8747d 2019 * call, we have to set querybuf to NULL *before* to call
2020 * unblockClientWaitingData() to avoid processInputBuffer() will get
2021 * called. Also it is important to remove the file events after
2022 * this, because this call adds the READABLE event. */
4409877e 2023 sdsfree(c->querybuf);
2024 c->querybuf = NULL;
2025 if (c->flags & REDIS_BLOCKED)
b0d8747d 2026 unblockClientWaitingData(c);
4409877e 2027
37ab76c9 2028 /* UNWATCH all the keys */
2029 unwatchAllKeys(c);
2030 listRelease(c->watched_keys);
ffc6b7f8 2031 /* Unsubscribe from all the pubsub channels */
2032 pubsubUnsubscribeAllChannels(c,0);
2033 pubsubUnsubscribeAllPatterns(c,0);
2034 dictRelease(c->pubsub_channels);
2035 listRelease(c->pubsub_patterns);
befec3cd 2036 /* Obvious cleanup */
ed9b544e 2037 aeDeleteFileEvent(server.el,c->fd,AE_READABLE);
2038 aeDeleteFileEvent(server.el,c->fd,AE_WRITABLE);
ed9b544e 2039 listRelease(c->reply);
2040 freeClientArgv(c);
2041 close(c->fd);
92f8e882 2042 /* Remove from the list of clients */
ed9b544e 2043 ln = listSearchKey(server.clients,c);
dfc5e96c 2044 redisAssert(ln != NULL);
ed9b544e 2045 listDelNode(server.clients,ln);
37ab76c9 2046 /* Remove from the list of clients that are now ready to be restarted
2047 * after waiting for swapped keys */
d5d55fc3 2048 if (c->flags & REDIS_IO_WAIT && listLength(c->io_keys) == 0) {
2049 ln = listSearchKey(server.io_ready_clients,c);
2050 if (ln) {
2051 listDelNode(server.io_ready_clients,ln);
2052 server.vm_blocked_clients--;
2053 }
2054 }
37ab76c9 2055 /* Remove from the list of clients waiting for swapped keys */
d5d55fc3 2056 while (server.vm_enabled && listLength(c->io_keys)) {
2057 ln = listFirst(c->io_keys);
2058 dontWaitForSwappedKey(c,ln->value);
92f8e882 2059 }
b3e3d0d7 2060 listRelease(c->io_keys);
befec3cd 2061 /* Master/slave cleanup */
ed9b544e 2062 if (c->flags & REDIS_SLAVE) {
6208b3a7 2063 if (c->replstate == REDIS_REPL_SEND_BULK && c->repldbfd != -1)
2064 close(c->repldbfd);
87eca727 2065 list *l = (c->flags & REDIS_MONITOR) ? server.monitors : server.slaves;
2066 ln = listSearchKey(l,c);
dfc5e96c 2067 redisAssert(ln != NULL);
87eca727 2068 listDelNode(l,ln);
ed9b544e 2069 }
2070 if (c->flags & REDIS_MASTER) {
2071 server.master = NULL;
2072 server.replstate = REDIS_REPL_CONNECT;
2073 }
befec3cd 2074 /* Release memory */
93ea3759 2075 zfree(c->argv);
e8a74421 2076 zfree(c->mbargv);
6e469882 2077 freeClientMultiState(c);
ed9b544e 2078 zfree(c);
2079}
2080
cc30e368 2081#define GLUEREPLY_UP_TO (1024)
ed9b544e 2082static void glueReplyBuffersIfNeeded(redisClient *c) {
c28b42ac 2083 int copylen = 0;
2084 char buf[GLUEREPLY_UP_TO];
6208b3a7 2085 listNode *ln;
c7df85a4 2086 listIter li;
ed9b544e 2087 robj *o;
2088
c7df85a4 2089 listRewind(c->reply,&li);
2090 while((ln = listNext(&li))) {
c28b42ac 2091 int objlen;
2092
ed9b544e 2093 o = ln->value;
c28b42ac 2094 objlen = sdslen(o->ptr);
2095 if (copylen + objlen <= GLUEREPLY_UP_TO) {
2096 memcpy(buf+copylen,o->ptr,objlen);
2097 copylen += objlen;
ed9b544e 2098 listDelNode(c->reply,ln);
c28b42ac 2099 } else {
2100 if (copylen == 0) return;
2101 break;
ed9b544e 2102 }
ed9b544e 2103 }
c28b42ac 2104 /* Now the output buffer is empty, add the new single element */
2105 o = createObject(REDIS_STRING,sdsnewlen(buf,copylen));
2106 listAddNodeHead(c->reply,o);
ed9b544e 2107}
2108
2109static void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask) {
2110 redisClient *c = privdata;
2111 int nwritten = 0, totwritten = 0, objlen;
2112 robj *o;
2113 REDIS_NOTUSED(el);
2114 REDIS_NOTUSED(mask);
2115
2895e862 2116 /* Use writev() if we have enough buffers to send */
7ea870c0 2117 if (!server.glueoutputbuf &&
e0a62c7f 2118 listLength(c->reply) > REDIS_WRITEV_THRESHOLD &&
7ea870c0 2119 !(c->flags & REDIS_MASTER))
2895e862 2120 {
2121 sendReplyToClientWritev(el, fd, privdata, mask);
2122 return;
2123 }
2895e862 2124
ed9b544e 2125 while(listLength(c->reply)) {
c28b42ac 2126 if (server.glueoutputbuf && listLength(c->reply) > 1)
2127 glueReplyBuffersIfNeeded(c);
2128
ed9b544e 2129 o = listNodeValue(listFirst(c->reply));
2130 objlen = sdslen(o->ptr);
2131
2132 if (objlen == 0) {
2133 listDelNode(c->reply,listFirst(c->reply));
2134 continue;
2135 }
2136
2137 if (c->flags & REDIS_MASTER) {
6f376729 2138 /* Don't reply to a master */
ed9b544e 2139 nwritten = objlen - c->sentlen;
2140 } else {
a4d1ba9a 2141 nwritten = write(fd, ((char*)o->ptr)+c->sentlen, objlen - c->sentlen);
ed9b544e 2142 if (nwritten <= 0) break;
2143 }
2144 c->sentlen += nwritten;
2145 totwritten += nwritten;
2146 /* If we fully sent the object on head go to the next one */
2147 if (c->sentlen == objlen) {
2148 listDelNode(c->reply,listFirst(c->reply));
2149 c->sentlen = 0;
2150 }
6f376729 2151 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
12f9d551 2152 * bytes, in a single threaded server it's a good idea to serve
6f376729 2153 * other clients as well, even if a very large request comes from
2154 * super fast link that is always able to accept data (in real world
12f9d551 2155 * scenario think about 'KEYS *' against the loopback interfae) */
6f376729 2156 if (totwritten > REDIS_MAX_WRITE_PER_EVENT) break;
ed9b544e 2157 }
2158 if (nwritten == -1) {
2159 if (errno == EAGAIN) {
2160 nwritten = 0;
2161 } else {
f870935d 2162 redisLog(REDIS_VERBOSE,
ed9b544e 2163 "Error writing to client: %s", strerror(errno));
2164 freeClient(c);
2165 return;
2166 }
2167 }
2168 if (totwritten > 0) c->lastinteraction = time(NULL);
2169 if (listLength(c->reply) == 0) {
2170 c->sentlen = 0;
2171 aeDeleteFileEvent(server.el,c->fd,AE_WRITABLE);
2172 }
2173}
2174
2895e862 2175static void sendReplyToClientWritev(aeEventLoop *el, int fd, void *privdata, int mask)
2176{
2177 redisClient *c = privdata;
2178 int nwritten = 0, totwritten = 0, objlen, willwrite;
2179 robj *o;
2180 struct iovec iov[REDIS_WRITEV_IOVEC_COUNT];
2181 int offset, ion = 0;
2182 REDIS_NOTUSED(el);
2183 REDIS_NOTUSED(mask);
2184
2185 listNode *node;
2186 while (listLength(c->reply)) {
2187 offset = c->sentlen;
2188 ion = 0;
2189 willwrite = 0;
2190
2191 /* fill-in the iov[] array */
2192 for(node = listFirst(c->reply); node; node = listNextNode(node)) {
2193 o = listNodeValue(node);
2194 objlen = sdslen(o->ptr);
2195
e0a62c7f 2196 if (totwritten + objlen - offset > REDIS_MAX_WRITE_PER_EVENT)
2895e862 2197 break;
2198
2199 if(ion == REDIS_WRITEV_IOVEC_COUNT)
2200 break; /* no more iovecs */
2201
2202 iov[ion].iov_base = ((char*)o->ptr) + offset;
2203 iov[ion].iov_len = objlen - offset;
2204 willwrite += objlen - offset;
2205 offset = 0; /* just for the first item */
2206 ion++;
2207 }
2208
2209 if(willwrite == 0)
2210 break;
2211
2212 /* write all collected blocks at once */
2213 if((nwritten = writev(fd, iov, ion)) < 0) {
2214 if (errno != EAGAIN) {
f870935d 2215 redisLog(REDIS_VERBOSE,
2895e862 2216 "Error writing to client: %s", strerror(errno));
2217 freeClient(c);
2218 return;
2219 }
2220 break;
2221 }
2222
2223 totwritten += nwritten;
2224 offset = c->sentlen;
2225
2226 /* remove written robjs from c->reply */
2227 while (nwritten && listLength(c->reply)) {
2228 o = listNodeValue(listFirst(c->reply));
2229 objlen = sdslen(o->ptr);
2230
2231 if(nwritten >= objlen - offset) {
2232 listDelNode(c->reply, listFirst(c->reply));
2233 nwritten -= objlen - offset;
2234 c->sentlen = 0;
2235 } else {
2236 /* partial write */
2237 c->sentlen += nwritten;
2238 break;
2239 }
2240 offset = 0;
2241 }
2242 }
2243
e0a62c7f 2244 if (totwritten > 0)
2895e862 2245 c->lastinteraction = time(NULL);
2246
2247 if (listLength(c->reply) == 0) {
2248 c->sentlen = 0;
2249 aeDeleteFileEvent(server.el,c->fd,AE_WRITABLE);
2250 }
2251}
2252
1a132bbc
PN
2253static int qsortRedisCommands(const void *r1, const void *r2) {
2254 return strcasecmp(
2255 ((struct redisCommand*)r1)->name,
2256 ((struct redisCommand*)r2)->name);
2257}
2258
2259static void sortCommandTable() {
1a132bbc
PN
2260 /* Copy and sort the read-only version of the command table */
2261 commandTable = (struct redisCommand*)malloc(sizeof(readonlyCommandTable));
2262 memcpy(commandTable,readonlyCommandTable,sizeof(readonlyCommandTable));
d55d5c5d 2263 qsort(commandTable,
2264 sizeof(readonlyCommandTable)/sizeof(struct redisCommand),
2265 sizeof(struct redisCommand),qsortRedisCommands);
1a132bbc
PN
2266}
2267
ed9b544e 2268static struct redisCommand *lookupCommand(char *name) {
1a132bbc
PN
2269 struct redisCommand tmp = {name,NULL,0,0,NULL,0,0,0};
2270 return bsearch(
2271 &tmp,
2272 commandTable,
d55d5c5d 2273 sizeof(readonlyCommandTable)/sizeof(struct redisCommand),
1a132bbc
PN
2274 sizeof(struct redisCommand),
2275 qsortRedisCommands);
ed9b544e 2276}
2277
2278/* resetClient prepare the client to process the next command */
2279static void resetClient(redisClient *c) {
2280 freeClientArgv(c);
2281 c->bulklen = -1;
e8a74421 2282 c->multibulk = 0;
ed9b544e 2283}
2284
6e469882 2285/* Call() is the core of Redis execution of a command */
2286static void call(redisClient *c, struct redisCommand *cmd) {
2287 long long dirty;
2288
2289 dirty = server.dirty;
2290 cmd->proc(c);
4005fef1 2291 dirty = server.dirty-dirty;
2292
2293 if (server.appendonly && dirty)
6e469882 2294 feedAppendOnlyFile(cmd,c->db->id,c->argv,c->argc);
4005fef1 2295 if ((dirty || cmd->flags & REDIS_CMD_FORCE_REPLICATION) &&
2296 listLength(server.slaves))
248ea310 2297 replicationFeedSlaves(server.slaves,c->db->id,c->argv,c->argc);
6e469882 2298 if (listLength(server.monitors))
dd142b9c 2299 replicationFeedMonitors(server.monitors,c->db->id,c->argv,c->argc);
6e469882 2300 server.stat_numcommands++;
2301}
2302
ed9b544e 2303/* If this function gets called we already read a whole
2304 * command, argments are in the client argv/argc fields.
2305 * processCommand() execute the command or prepare the
2306 * server for a bulk read from the client.
2307 *
2308 * If 1 is returned the client is still alive and valid and
2309 * and other operations can be performed by the caller. Otherwise
2310 * if 0 is returned the client was destroied (i.e. after QUIT). */
2311static int processCommand(redisClient *c) {
2312 struct redisCommand *cmd;
ed9b544e 2313
3fd78bcd 2314 /* Free some memory if needed (maxmemory setting) */
2315 if (server.maxmemory) freeMemoryIfNeeded();
2316
e8a74421 2317 /* Handle the multi bulk command type. This is an alternative protocol
2318 * supported by Redis in order to receive commands that are composed of
2319 * multiple binary-safe "bulk" arguments. The latency of processing is
2320 * a bit higher but this allows things like multi-sets, so if this
2321 * protocol is used only for MSET and similar commands this is a big win. */
2322 if (c->multibulk == 0 && c->argc == 1 && ((char*)(c->argv[0]->ptr))[0] == '*') {
2323 c->multibulk = atoi(((char*)c->argv[0]->ptr)+1);
2324 if (c->multibulk <= 0) {
2325 resetClient(c);
2326 return 1;
2327 } else {
2328 decrRefCount(c->argv[c->argc-1]);
2329 c->argc--;
2330 return 1;
2331 }
2332 } else if (c->multibulk) {
2333 if (c->bulklen == -1) {
2334 if (((char*)c->argv[0]->ptr)[0] != '$') {
2335 addReplySds(c,sdsnew("-ERR multi bulk protocol error\r\n"));
2336 resetClient(c);
2337 return 1;
2338 } else {
2339 int bulklen = atoi(((char*)c->argv[0]->ptr)+1);
2340 decrRefCount(c->argv[0]);
2341 if (bulklen < 0 || bulklen > 1024*1024*1024) {
2342 c->argc--;
2343 addReplySds(c,sdsnew("-ERR invalid bulk write count\r\n"));
2344 resetClient(c);
2345 return 1;
2346 }
2347 c->argc--;
2348 c->bulklen = bulklen+2; /* add two bytes for CR+LF */
2349 return 1;
2350 }
2351 } else {
2352 c->mbargv = zrealloc(c->mbargv,(sizeof(robj*))*(c->mbargc+1));
2353 c->mbargv[c->mbargc] = c->argv[0];
2354 c->mbargc++;
2355 c->argc--;
2356 c->multibulk--;
2357 if (c->multibulk == 0) {
2358 robj **auxargv;
2359 int auxargc;
2360
2361 /* Here we need to swap the multi-bulk argc/argv with the
2362 * normal argc/argv of the client structure. */
2363 auxargv = c->argv;
2364 c->argv = c->mbargv;
2365 c->mbargv = auxargv;
2366
2367 auxargc = c->argc;
2368 c->argc = c->mbargc;
2369 c->mbargc = auxargc;
2370
2371 /* We need to set bulklen to something different than -1
2372 * in order for the code below to process the command without
2373 * to try to read the last argument of a bulk command as
2374 * a special argument. */
2375 c->bulklen = 0;
2376 /* continue below and process the command */
2377 } else {
2378 c->bulklen = -1;
2379 return 1;
2380 }
2381 }
2382 }
2383 /* -- end of multi bulk commands processing -- */
2384
ed9b544e 2385 /* The QUIT command is handled as a special case. Normal command
2386 * procs are unable to close the client connection safely */
bb0b03a3 2387 if (!strcasecmp(c->argv[0]->ptr,"quit")) {
ed9b544e 2388 freeClient(c);
2389 return 0;
2390 }
d5d55fc3 2391
2392 /* Now lookup the command and check ASAP about trivial error conditions
2393 * such wrong arity, bad command name and so forth. */
ed9b544e 2394 cmd = lookupCommand(c->argv[0]->ptr);
2395 if (!cmd) {
2c14807b 2396 addReplySds(c,
2397 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2398 (char*)c->argv[0]->ptr));
ed9b544e 2399 resetClient(c);
2400 return 1;
2401 } else if ((cmd->arity > 0 && cmd->arity != c->argc) ||
2402 (c->argc < -cmd->arity)) {
454d4e43 2403 addReplySds(c,
2404 sdscatprintf(sdsempty(),
2405 "-ERR wrong number of arguments for '%s' command\r\n",
2406 cmd->name));
ed9b544e 2407 resetClient(c);
2408 return 1;
2409 } else if (cmd->flags & REDIS_CMD_BULK && c->bulklen == -1) {
d5d55fc3 2410 /* This is a bulk command, we have to read the last argument yet. */
ed9b544e 2411 int bulklen = atoi(c->argv[c->argc-1]->ptr);
2412
2413 decrRefCount(c->argv[c->argc-1]);
2414 if (bulklen < 0 || bulklen > 1024*1024*1024) {
2415 c->argc--;
2416 addReplySds(c,sdsnew("-ERR invalid bulk write count\r\n"));
2417 resetClient(c);
2418 return 1;
2419 }
2420 c->argc--;
2421 c->bulklen = bulklen+2; /* add two bytes for CR+LF */
2422 /* It is possible that the bulk read is already in the
8d0490e7 2423 * buffer. Check this condition and handle it accordingly.
2424 * This is just a fast path, alternative to call processInputBuffer().
2425 * It's a good idea since the code is small and this condition
2426 * happens most of the times. */
ed9b544e 2427 if ((signed)sdslen(c->querybuf) >= c->bulklen) {
2428 c->argv[c->argc] = createStringObject(c->querybuf,c->bulklen-2);
2429 c->argc++;
2430 c->querybuf = sdsrange(c->querybuf,c->bulklen,-1);
2431 } else {
d5d55fc3 2432 /* Otherwise return... there is to read the last argument
2433 * from the socket. */
ed9b544e 2434 return 1;
2435 }
2436 }
942a3961 2437 /* Let's try to encode the bulk object to save space. */
2438 if (cmd->flags & REDIS_CMD_BULK)
05df7621 2439 c->argv[c->argc-1] = tryObjectEncoding(c->argv[c->argc-1]);
942a3961 2440
e63943a4 2441 /* Check if the user is authenticated */
2442 if (server.requirepass && !c->authenticated && cmd->proc != authCommand) {
2443 addReplySds(c,sdsnew("-ERR operation not permitted\r\n"));
2444 resetClient(c);
2445 return 1;
2446 }
2447
b61a28fe 2448 /* Handle the maxmemory directive */
2449 if (server.maxmemory && (cmd->flags & REDIS_CMD_DENYOOM) &&
2450 zmalloc_used_memory() > server.maxmemory)
2451 {
2452 addReplySds(c,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2453 resetClient(c);
2454 return 1;
2455 }
2456
d6cc8867 2457 /* Only allow SUBSCRIBE and UNSUBSCRIBE in the context of Pub/Sub */
e6cca5db 2458 if ((dictSize(c->pubsub_channels) > 0 || listLength(c->pubsub_patterns) > 0)
2459 &&
ffc6b7f8 2460 cmd->proc != subscribeCommand && cmd->proc != unsubscribeCommand &&
2461 cmd->proc != psubscribeCommand && cmd->proc != punsubscribeCommand) {
2462 addReplySds(c,sdsnew("-ERR only (P)SUBSCRIBE / (P)UNSUBSCRIBE / QUIT allowed in this context\r\n"));
d6cc8867 2463 resetClient(c);
2464 return 1;
2465 }
2466
ed9b544e 2467 /* Exec the command */
6531c94d 2468 if (c->flags & REDIS_MULTI &&
2469 cmd->proc != execCommand && cmd->proc != discardCommand &&
2470 cmd->proc != multiCommand && cmd->proc != watchCommand)
2471 {
6e469882 2472 queueMultiCommand(c,cmd);
2473 addReply(c,shared.queued);
2474 } else {
d5d55fc3 2475 if (server.vm_enabled && server.vm_max_threads > 0 &&
0a6f3f0f 2476 blockClientOnSwappedKeys(c,cmd)) return 1;
6e469882 2477 call(c,cmd);
2478 }
ed9b544e 2479
2480 /* Prepare the client for the next command */
ed9b544e 2481 resetClient(c);
2482 return 1;
2483}
2484
248ea310 2485static void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc) {
6208b3a7 2486 listNode *ln;
c7df85a4 2487 listIter li;
ed9b544e 2488 int outc = 0, j;
93ea3759 2489 robj **outv;
248ea310 2490 /* We need 1+(ARGS*3) objects since commands are using the new protocol
2491 * and we one 1 object for the first "*<count>\r\n" multibulk count, then
2492 * for every additional object we have "$<count>\r\n" + object + "\r\n". */
2493 robj *static_outv[REDIS_STATIC_ARGS*3+1];
2494 robj *lenobj;
93ea3759 2495
2496 if (argc <= REDIS_STATIC_ARGS) {
2497 outv = static_outv;
2498 } else {
248ea310 2499 outv = zmalloc(sizeof(robj*)*(argc*3+1));
93ea3759 2500 }
248ea310 2501
2502 lenobj = createObject(REDIS_STRING,
2503 sdscatprintf(sdsempty(), "*%d\r\n", argc));
2504 lenobj->refcount = 0;
2505 outv[outc++] = lenobj;
ed9b544e 2506 for (j = 0; j < argc; j++) {
248ea310 2507 lenobj = createObject(REDIS_STRING,
2508 sdscatprintf(sdsempty(),"$%lu\r\n",
2509 (unsigned long) stringObjectLen(argv[j])));
2510 lenobj->refcount = 0;
2511 outv[outc++] = lenobj;
ed9b544e 2512 outv[outc++] = argv[j];
248ea310 2513 outv[outc++] = shared.crlf;
ed9b544e 2514 }
ed9b544e 2515
40d224a9 2516 /* Increment all the refcounts at start and decrement at end in order to
2517 * be sure to free objects if there is no slave in a replication state
2518 * able to be feed with commands */
2519 for (j = 0; j < outc; j++) incrRefCount(outv[j]);
c7df85a4 2520 listRewind(slaves,&li);
2521 while((ln = listNext(&li))) {
ed9b544e 2522 redisClient *slave = ln->value;
40d224a9 2523
2524 /* Don't feed slaves that are still waiting for BGSAVE to start */
6208b3a7 2525 if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_START) continue;
40d224a9 2526
2527 /* Feed all the other slaves, MONITORs and so on */
ed9b544e 2528 if (slave->slaveseldb != dictid) {
2529 robj *selectcmd;
2530
2531 switch(dictid) {
2532 case 0: selectcmd = shared.select0; break;
2533 case 1: selectcmd = shared.select1; break;
2534 case 2: selectcmd = shared.select2; break;
2535 case 3: selectcmd = shared.select3; break;
2536 case 4: selectcmd = shared.select4; break;
2537 case 5: selectcmd = shared.select5; break;
2538 case 6: selectcmd = shared.select6; break;
2539 case 7: selectcmd = shared.select7; break;
2540 case 8: selectcmd = shared.select8; break;
2541 case 9: selectcmd = shared.select9; break;
2542 default:
2543 selectcmd = createObject(REDIS_STRING,
2544 sdscatprintf(sdsempty(),"select %d\r\n",dictid));
2545 selectcmd->refcount = 0;
2546 break;
2547 }
2548 addReply(slave,selectcmd);
2549 slave->slaveseldb = dictid;
2550 }
2551 for (j = 0; j < outc; j++) addReply(slave,outv[j]);
ed9b544e 2552 }
40d224a9 2553 for (j = 0; j < outc; j++) decrRefCount(outv[j]);
93ea3759 2554 if (outv != static_outv) zfree(outv);
ed9b544e 2555}
2556
dd142b9c 2557static sds sdscatrepr(sds s, char *p, size_t len) {
2558 s = sdscatlen(s,"\"",1);
2559 while(len--) {
2560 switch(*p) {
2561 case '\\':
2562 case '"':
2563 s = sdscatprintf(s,"\\%c",*p);
2564 break;
2565 case '\n': s = sdscatlen(s,"\\n",1); break;
2566 case '\r': s = sdscatlen(s,"\\r",1); break;
2567 case '\t': s = sdscatlen(s,"\\t",1); break;
2568 case '\a': s = sdscatlen(s,"\\a",1); break;
2569 case '\b': s = sdscatlen(s,"\\b",1); break;
2570 default:
2571 if (isprint(*p))
2572 s = sdscatprintf(s,"%c",*p);
2573 else
2574 s = sdscatprintf(s,"\\x%02x",(unsigned char)*p);
2575 break;
2576 }
2577 p++;
2578 }
2579 return sdscatlen(s,"\"",1);
2580}
2581
2582static void replicationFeedMonitors(list *monitors, int dictid, robj **argv, int argc) {
2583 listNode *ln;
2584 listIter li;
2585 int j;
2586 sds cmdrepr = sdsnew("+");
2587 robj *cmdobj;
2588 struct timeval tv;
2589
2590 gettimeofday(&tv,NULL);
2591 cmdrepr = sdscatprintf(cmdrepr,"%ld.%ld ",(long)tv.tv_sec,(long)tv.tv_usec);
2592 if (dictid != 0) cmdrepr = sdscatprintf(cmdrepr,"(db %d) ", dictid);
2593
2594 for (j = 0; j < argc; j++) {
2595 if (argv[j]->encoding == REDIS_ENCODING_INT) {
2596 cmdrepr = sdscatprintf(cmdrepr, "%ld", (long)argv[j]->ptr);
2597 } else {
2598 cmdrepr = sdscatrepr(cmdrepr,(char*)argv[j]->ptr,
2599 sdslen(argv[j]->ptr));
2600 }
2601 if (j != argc-1)
2602 cmdrepr = sdscatlen(cmdrepr," ",1);
2603 }
2604 cmdrepr = sdscatlen(cmdrepr,"\r\n",2);
2605 cmdobj = createObject(REDIS_STRING,cmdrepr);
2606
2607 listRewind(monitors,&li);
2608 while((ln = listNext(&li))) {
2609 redisClient *monitor = ln->value;
2610 addReply(monitor,cmdobj);
2611 }
2612 decrRefCount(cmdobj);
2613}
2614
638e42ac 2615static void processInputBuffer(redisClient *c) {
ed9b544e 2616again:
4409877e 2617 /* Before to process the input buffer, make sure the client is not
2618 * waitig for a blocking operation such as BLPOP. Note that the first
2619 * iteration the client is never blocked, otherwise the processInputBuffer
2620 * would not be called at all, but after the execution of the first commands
2621 * in the input buffer the client may be blocked, and the "goto again"
2622 * will try to reiterate. The following line will make it return asap. */
92f8e882 2623 if (c->flags & REDIS_BLOCKED || c->flags & REDIS_IO_WAIT) return;
ed9b544e 2624 if (c->bulklen == -1) {
2625 /* Read the first line of the query */
2626 char *p = strchr(c->querybuf,'\n');
2627 size_t querylen;
644fafa3 2628
ed9b544e 2629 if (p) {
2630 sds query, *argv;
2631 int argc, j;
e0a62c7f 2632
ed9b544e 2633 query = c->querybuf;
2634 c->querybuf = sdsempty();
2635 querylen = 1+(p-(query));
2636 if (sdslen(query) > querylen) {
2637 /* leave data after the first line of the query in the buffer */
2638 c->querybuf = sdscatlen(c->querybuf,query+querylen,sdslen(query)-querylen);
2639 }
2640 *p = '\0'; /* remove "\n" */
2641 if (*(p-1) == '\r') *(p-1) = '\0'; /* and "\r" if any */
2642 sdsupdatelen(query);
2643
2644 /* Now we can split the query in arguments */
ed9b544e 2645 argv = sdssplitlen(query,sdslen(query)," ",1,&argc);
93ea3759 2646 sdsfree(query);
2647
2648 if (c->argv) zfree(c->argv);
2649 c->argv = zmalloc(sizeof(robj*)*argc);
93ea3759 2650
2651 for (j = 0; j < argc; j++) {
ed9b544e 2652 if (sdslen(argv[j])) {
2653 c->argv[c->argc] = createObject(REDIS_STRING,argv[j]);
2654 c->argc++;
2655 } else {
2656 sdsfree(argv[j]);
2657 }
2658 }
2659 zfree(argv);
7c49733c 2660 if (c->argc) {
2661 /* Execute the command. If the client is still valid
2662 * after processCommand() return and there is something
2663 * on the query buffer try to process the next command. */
2664 if (processCommand(c) && sdslen(c->querybuf)) goto again;
2665 } else {
2666 /* Nothing to process, argc == 0. Just process the query
2667 * buffer if it's not empty or return to the caller */
2668 if (sdslen(c->querybuf)) goto again;
2669 }
ed9b544e 2670 return;
644fafa3 2671 } else if (sdslen(c->querybuf) >= REDIS_REQUEST_MAX_SIZE) {
f870935d 2672 redisLog(REDIS_VERBOSE, "Client protocol error");
ed9b544e 2673 freeClient(c);
2674 return;
2675 }
2676 } else {
2677 /* Bulk read handling. Note that if we are at this point
2678 the client already sent a command terminated with a newline,
2679 we are reading the bulk data that is actually the last
2680 argument of the command. */
2681 int qbl = sdslen(c->querybuf);
2682
2683 if (c->bulklen <= qbl) {
2684 /* Copy everything but the final CRLF as final argument */
2685 c->argv[c->argc] = createStringObject(c->querybuf,c->bulklen-2);
2686 c->argc++;
2687 c->querybuf = sdsrange(c->querybuf,c->bulklen,-1);
638e42ac 2688 /* Process the command. If the client is still valid after
2689 * the processing and there is more data in the buffer
2690 * try to parse it. */
2691 if (processCommand(c) && sdslen(c->querybuf)) goto again;
ed9b544e 2692 return;
2693 }
2694 }
2695}
2696
638e42ac 2697static void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask) {
2698 redisClient *c = (redisClient*) privdata;
2699 char buf[REDIS_IOBUF_LEN];
2700 int nread;
2701 REDIS_NOTUSED(el);
2702 REDIS_NOTUSED(mask);
2703
2704 nread = read(fd, buf, REDIS_IOBUF_LEN);
2705 if (nread == -1) {
2706 if (errno == EAGAIN) {
2707 nread = 0;
2708 } else {
f870935d 2709 redisLog(REDIS_VERBOSE, "Reading from client: %s",strerror(errno));
638e42ac 2710 freeClient(c);
2711 return;
2712 }
2713 } else if (nread == 0) {
f870935d 2714 redisLog(REDIS_VERBOSE, "Client closed connection");
638e42ac 2715 freeClient(c);
2716 return;
2717 }
2718 if (nread) {
2719 c->querybuf = sdscatlen(c->querybuf, buf, nread);
2720 c->lastinteraction = time(NULL);
2721 } else {
2722 return;
2723 }
168ac5c6 2724 processInputBuffer(c);
638e42ac 2725}
2726
ed9b544e 2727static int selectDb(redisClient *c, int id) {
2728 if (id < 0 || id >= server.dbnum)
2729 return REDIS_ERR;
3305306f 2730 c->db = &server.db[id];
ed9b544e 2731 return REDIS_OK;
2732}
2733
40d224a9 2734static void *dupClientReplyValue(void *o) {
2735 incrRefCount((robj*)o);
12d090d2 2736 return o;
40d224a9 2737}
2738
ffc6b7f8 2739static int listMatchObjects(void *a, void *b) {
bf028098 2740 return equalStringObjects(a,b);
ffc6b7f8 2741}
2742
ed9b544e 2743static redisClient *createClient(int fd) {
2744 redisClient *c = zmalloc(sizeof(*c));
2745
2746 anetNonBlock(NULL,fd);
2747 anetTcpNoDelay(NULL,fd);
2748 if (!c) return NULL;
2749 selectDb(c,0);
2750 c->fd = fd;
2751 c->querybuf = sdsempty();
2752 c->argc = 0;
93ea3759 2753 c->argv = NULL;
ed9b544e 2754 c->bulklen = -1;
e8a74421 2755 c->multibulk = 0;
2756 c->mbargc = 0;
2757 c->mbargv = NULL;
ed9b544e 2758 c->sentlen = 0;
2759 c->flags = 0;
2760 c->lastinteraction = time(NULL);
abcb223e 2761 c->authenticated = 0;
40d224a9 2762 c->replstate = REDIS_REPL_NONE;
6b47e12e 2763 c->reply = listCreate();
ed9b544e 2764 listSetFreeMethod(c->reply,decrRefCount);
40d224a9 2765 listSetDupMethod(c->reply,dupClientReplyValue);
37ab76c9 2766 c->blocking_keys = NULL;
2767 c->blocking_keys_num = 0;
92f8e882 2768 c->io_keys = listCreate();
87c68815 2769 c->watched_keys = listCreate();
92f8e882 2770 listSetFreeMethod(c->io_keys,decrRefCount);
ffc6b7f8 2771 c->pubsub_channels = dictCreate(&setDictType,NULL);
2772 c->pubsub_patterns = listCreate();
2773 listSetFreeMethod(c->pubsub_patterns,decrRefCount);
2774 listSetMatchMethod(c->pubsub_patterns,listMatchObjects);
ed9b544e 2775 if (aeCreateFileEvent(server.el, c->fd, AE_READABLE,
266373b2 2776 readQueryFromClient, c) == AE_ERR) {
ed9b544e 2777 freeClient(c);
2778 return NULL;
2779 }
6b47e12e 2780 listAddNodeTail(server.clients,c);
6e469882 2781 initClientMultiState(c);
ed9b544e 2782 return c;
2783}
2784
2785static void addReply(redisClient *c, robj *obj) {
2786 if (listLength(c->reply) == 0 &&
6208b3a7 2787 (c->replstate == REDIS_REPL_NONE ||
2788 c->replstate == REDIS_REPL_ONLINE) &&
ed9b544e 2789 aeCreateFileEvent(server.el, c->fd, AE_WRITABLE,
266373b2 2790 sendReplyToClient, c) == AE_ERR) return;
e3cadb8a 2791
2792 if (server.vm_enabled && obj->storage != REDIS_VM_MEMORY) {
2793 obj = dupStringObject(obj);
2794 obj->refcount = 0; /* getDecodedObject() will increment the refcount */
2795 }
9d65a1bb 2796 listAddNodeTail(c->reply,getDecodedObject(obj));
ed9b544e 2797}
2798
2799static void addReplySds(redisClient *c, sds s) {
2800 robj *o = createObject(REDIS_STRING,s);
2801 addReply(c,o);
2802 decrRefCount(o);
2803}
2804
e2665397 2805static void addReplyDouble(redisClient *c, double d) {
2806 char buf[128];
2807
2808 snprintf(buf,sizeof(buf),"%.17g",d);
682ac724 2809 addReplySds(c,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
83c6a618 2810 (unsigned long) strlen(buf),buf));
e2665397 2811}
2812
aa7c2934
PN
2813static void addReplyLongLong(redisClient *c, long long ll) {
2814 char buf[128];
2815 size_t len;
2816
2817 if (ll == 0) {
2818 addReply(c,shared.czero);
2819 return;
2820 } else if (ll == 1) {
2821 addReply(c,shared.cone);
2822 return;
2823 }
482b672d 2824 buf[0] = ':';
2825 len = ll2string(buf+1,sizeof(buf)-1,ll);
2826 buf[len+1] = '\r';
2827 buf[len+2] = '\n';
2828 addReplySds(c,sdsnewlen(buf,len+3));
aa7c2934
PN
2829}
2830
92b27fe9 2831static void addReplyUlong(redisClient *c, unsigned long ul) {
2832 char buf[128];
2833 size_t len;
2834
dd88747b 2835 if (ul == 0) {
2836 addReply(c,shared.czero);
2837 return;
2838 } else if (ul == 1) {
2839 addReply(c,shared.cone);
2840 return;
2841 }
92b27fe9 2842 len = snprintf(buf,sizeof(buf),":%lu\r\n",ul);
2843 addReplySds(c,sdsnewlen(buf,len));
2844}
2845
942a3961 2846static void addReplyBulkLen(redisClient *c, robj *obj) {
482b672d 2847 size_t len, intlen;
2848 char buf[128];
942a3961 2849
2850 if (obj->encoding == REDIS_ENCODING_RAW) {
2851 len = sdslen(obj->ptr);
2852 } else {
2853 long n = (long)obj->ptr;
2854
e054afda 2855 /* Compute how many bytes will take this integer as a radix 10 string */
942a3961 2856 len = 1;
2857 if (n < 0) {
2858 len++;
2859 n = -n;
2860 }
2861 while((n = n/10) != 0) {
2862 len++;
2863 }
2864 }
482b672d 2865 buf[0] = '$';
2866 intlen = ll2string(buf+1,sizeof(buf)-1,(long long)len);
2867 buf[intlen+1] = '\r';
2868 buf[intlen+2] = '\n';
2869 addReplySds(c,sdsnewlen(buf,intlen+3));
942a3961 2870}
2871
dd88747b 2872static void addReplyBulk(redisClient *c, robj *obj) {
2873 addReplyBulkLen(c,obj);
2874 addReply(c,obj);
2875 addReply(c,shared.crlf);
2876}
2877
500ece7c 2878/* In the CONFIG command we need to add vanilla C string as bulk replies */
2879static void addReplyBulkCString(redisClient *c, char *s) {
2880 if (s == NULL) {
2881 addReply(c,shared.nullbulk);
2882 } else {
2883 robj *o = createStringObject(s,strlen(s));
2884 addReplyBulk(c,o);
2885 decrRefCount(o);
2886 }
2887}
2888
ed9b544e 2889static void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask) {
2890 int cport, cfd;
2891 char cip[128];
285add55 2892 redisClient *c;
ed9b544e 2893 REDIS_NOTUSED(el);
2894 REDIS_NOTUSED(mask);
2895 REDIS_NOTUSED(privdata);
2896
2897 cfd = anetAccept(server.neterr, fd, cip, &cport);
2898 if (cfd == AE_ERR) {
f870935d 2899 redisLog(REDIS_VERBOSE,"Accepting client connection: %s", server.neterr);
ed9b544e 2900 return;
2901 }
f870935d 2902 redisLog(REDIS_VERBOSE,"Accepted %s:%d", cip, cport);
285add55 2903 if ((c = createClient(cfd)) == NULL) {
ed9b544e 2904 redisLog(REDIS_WARNING,"Error allocating resoures for the client");
2905 close(cfd); /* May be already closed, just ingore errors */
2906 return;
2907 }
285add55 2908 /* If maxclient directive is set and this is one client more... close the
2909 * connection. Note that we create the client instead to check before
2910 * for this condition, since now the socket is already set in nonblocking
2911 * mode and we can send an error for free using the Kernel I/O */
2912 if (server.maxclients && listLength(server.clients) > server.maxclients) {
2913 char *err = "-ERR max number of clients reached\r\n";
2914
2915 /* That's a best effort error message, don't check write errors */
fee803ba 2916 if (write(c->fd,err,strlen(err)) == -1) {
2917 /* Nothing to do, Just to avoid the warning... */
2918 }
285add55 2919 freeClient(c);
2920 return;
2921 }
ed9b544e 2922 server.stat_numconnections++;
2923}
2924
2925/* ======================= Redis objects implementation ===================== */
2926
2927static robj *createObject(int type, void *ptr) {
2928 robj *o;
2929
a5819310 2930 if (server.vm_enabled) pthread_mutex_lock(&server.obj_freelist_mutex);
ed9b544e 2931 if (listLength(server.objfreelist)) {
2932 listNode *head = listFirst(server.objfreelist);
2933 o = listNodeValue(head);
2934 listDelNode(server.objfreelist,head);
a5819310 2935 if (server.vm_enabled) pthread_mutex_unlock(&server.obj_freelist_mutex);
ed9b544e 2936 } else {
75680a3c 2937 if (server.vm_enabled) {
a5819310 2938 pthread_mutex_unlock(&server.obj_freelist_mutex);
75680a3c 2939 o = zmalloc(sizeof(*o));
2940 } else {
2941 o = zmalloc(sizeof(*o)-sizeof(struct redisObjectVM));
2942 }
ed9b544e 2943 }
ed9b544e 2944 o->type = type;
942a3961 2945 o->encoding = REDIS_ENCODING_RAW;
ed9b544e 2946 o->ptr = ptr;
2947 o->refcount = 1;
3a66edc7 2948 if (server.vm_enabled) {
1064ef87 2949 /* Note that this code may run in the context of an I/O thread
2950 * and accessing to server.unixtime in theory is an error
2951 * (no locks). But in practice this is safe, and even if we read
2952 * garbage Redis will not fail, as it's just a statistical info */
3a66edc7 2953 o->vm.atime = server.unixtime;
2954 o->storage = REDIS_VM_MEMORY;
2955 }
ed9b544e 2956 return o;
2957}
2958
2959static robj *createStringObject(char *ptr, size_t len) {
2960 return createObject(REDIS_STRING,sdsnewlen(ptr,len));
2961}
2962
3f973463
PN
2963static robj *createStringObjectFromLongLong(long long value) {
2964 robj *o;
2965 if (value >= 0 && value < REDIS_SHARED_INTEGERS) {
2966 incrRefCount(shared.integers[value]);
2967 o = shared.integers[value];
2968 } else {
3f973463 2969 if (value >= LONG_MIN && value <= LONG_MAX) {
10dea8dc 2970 o = createObject(REDIS_STRING, NULL);
3f973463
PN
2971 o->encoding = REDIS_ENCODING_INT;
2972 o->ptr = (void*)((long)value);
2973 } else {
ee14da56 2974 o = createObject(REDIS_STRING,sdsfromlonglong(value));
3f973463
PN
2975 }
2976 }
2977 return o;
2978}
2979
4ef8de8a 2980static robj *dupStringObject(robj *o) {
b9bc0eef 2981 assert(o->encoding == REDIS_ENCODING_RAW);
4ef8de8a 2982 return createStringObject(o->ptr,sdslen(o->ptr));
2983}
2984
ed9b544e 2985static robj *createListObject(void) {
2986 list *l = listCreate();
2987
ed9b544e 2988 listSetFreeMethod(l,decrRefCount);
2989 return createObject(REDIS_LIST,l);
2990}
2991
2992static robj *createSetObject(void) {
2993 dict *d = dictCreate(&setDictType,NULL);
ed9b544e 2994 return createObject(REDIS_SET,d);
2995}
2996
5234952b 2997static robj *createHashObject(void) {
2998 /* All the Hashes start as zipmaps. Will be automatically converted
2999 * into hash tables if there are enough elements or big elements
3000 * inside. */
3001 unsigned char *zm = zipmapNew();
3002 robj *o = createObject(REDIS_HASH,zm);
3003 o->encoding = REDIS_ENCODING_ZIPMAP;
3004 return o;
3005}
3006
1812e024 3007static robj *createZsetObject(void) {
6b47e12e 3008 zset *zs = zmalloc(sizeof(*zs));
3009
3010 zs->dict = dictCreate(&zsetDictType,NULL);
3011 zs->zsl = zslCreate();
3012 return createObject(REDIS_ZSET,zs);
1812e024 3013}
3014
ed9b544e 3015static void freeStringObject(robj *o) {
942a3961 3016 if (o->encoding == REDIS_ENCODING_RAW) {
3017 sdsfree(o->ptr);
3018 }
ed9b544e 3019}
3020
3021static void freeListObject(robj *o) {
c7d9d662
PN
3022 switch (o->encoding) {
3023 case REDIS_ENCODING_LIST:
3024 listRelease((list*) o->ptr);
3025 break;
3026 case REDIS_ENCODING_ZIPLIST:
3027 zfree(o->ptr);
3028 break;
3029 default:
3030 redisPanic("Unknown list encoding type");
3031 }
ed9b544e 3032}
3033
3034static void freeSetObject(robj *o) {
3035 dictRelease((dict*) o->ptr);
3036}
3037
fd8ccf44 3038static void freeZsetObject(robj *o) {
3039 zset *zs = o->ptr;
3040
3041 dictRelease(zs->dict);
3042 zslFree(zs->zsl);
3043 zfree(zs);
3044}
3045
ed9b544e 3046static void freeHashObject(robj *o) {
cbba7dd7 3047 switch (o->encoding) {
3048 case REDIS_ENCODING_HT:
3049 dictRelease((dict*) o->ptr);
3050 break;
3051 case REDIS_ENCODING_ZIPMAP:
3052 zfree(o->ptr);
3053 break;
3054 default:
f83c6cb5 3055 redisPanic("Unknown hash encoding type");
cbba7dd7 3056 break;
3057 }
ed9b544e 3058}
3059
3060static void incrRefCount(robj *o) {
3061 o->refcount++;
3062}
3063
3064static void decrRefCount(void *obj) {
3065 robj *o = obj;
94754ccc 3066
c651fd9e 3067 if (o->refcount <= 0) redisPanic("decrRefCount against refcount <= 0");
970e10bb 3068 /* Object is a key of a swapped out value, or in the process of being
3069 * loaded. */
996cb5f7 3070 if (server.vm_enabled &&
3071 (o->storage == REDIS_VM_SWAPPED || o->storage == REDIS_VM_LOADING))
3072 {
996cb5f7 3073 if (o->storage == REDIS_VM_LOADING) vmCancelThreadedIOJob(obj);
f2b8ab34 3074 redisAssert(o->type == REDIS_STRING);
a35ddf12 3075 freeStringObject(o);
3076 vmMarkPagesFree(o->vm.page,o->vm.usedpages);
a5819310 3077 pthread_mutex_lock(&server.obj_freelist_mutex);
a35ddf12 3078 if (listLength(server.objfreelist) > REDIS_OBJFREELIST_MAX ||
3079 !listAddNodeHead(server.objfreelist,o))
3080 zfree(o);
a5819310 3081 pthread_mutex_unlock(&server.obj_freelist_mutex);
7d98e08c 3082 server.vm_stats_swapped_objects--;
a35ddf12 3083 return;
3084 }
996cb5f7 3085 /* Object is in memory, or in the process of being swapped out. */
ed9b544e 3086 if (--(o->refcount) == 0) {
996cb5f7 3087 if (server.vm_enabled && o->storage == REDIS_VM_SWAPPING)
3088 vmCancelThreadedIOJob(obj);
ed9b544e 3089 switch(o->type) {
3090 case REDIS_STRING: freeStringObject(o); break;
3091 case REDIS_LIST: freeListObject(o); break;
3092 case REDIS_SET: freeSetObject(o); break;
fd8ccf44 3093 case REDIS_ZSET: freeZsetObject(o); break;
ed9b544e 3094 case REDIS_HASH: freeHashObject(o); break;
f83c6cb5 3095 default: redisPanic("Unknown object type"); break;
ed9b544e 3096 }
a5819310 3097 if (server.vm_enabled) pthread_mutex_lock(&server.obj_freelist_mutex);
ed9b544e 3098 if (listLength(server.objfreelist) > REDIS_OBJFREELIST_MAX ||
3099 !listAddNodeHead(server.objfreelist,o))
3100 zfree(o);
a5819310 3101 if (server.vm_enabled) pthread_mutex_unlock(&server.obj_freelist_mutex);
ed9b544e 3102 }
3103}
3104
942a3961 3105static robj *lookupKey(redisDb *db, robj *key) {
3106 dictEntry *de = dictFind(db->dict,key);
3a66edc7 3107 if (de) {
55cf8433 3108 robj *key = dictGetEntryKey(de);
3109 robj *val = dictGetEntryVal(de);
3a66edc7 3110
55cf8433 3111 if (server.vm_enabled) {
996cb5f7 3112 if (key->storage == REDIS_VM_MEMORY ||
3113 key->storage == REDIS_VM_SWAPPING)
3114 {
3115 /* If we were swapping the object out, stop it, this key
3116 * was requested. */
3117 if (key->storage == REDIS_VM_SWAPPING)
3118 vmCancelThreadedIOJob(key);
55cf8433 3119 /* Update the access time of the key for the aging algorithm. */
3120 key->vm.atime = server.unixtime;
3121 } else {
d5d55fc3 3122 int notify = (key->storage == REDIS_VM_LOADING);
3123
55cf8433 3124 /* Our value was swapped on disk. Bring it at home. */
f2b8ab34 3125 redisAssert(val == NULL);
55cf8433 3126 val = vmLoadObject(key);
3127 dictGetEntryVal(de) = val;
d5d55fc3 3128
3129 /* Clients blocked by the VM subsystem may be waiting for
3130 * this key... */
3131 if (notify) handleClientsBlockedOnSwappedKey(db,key);
55cf8433 3132 }
3133 }
3134 return val;
3a66edc7 3135 } else {
3136 return NULL;
3137 }
942a3961 3138}
3139
3140static robj *lookupKeyRead(redisDb *db, robj *key) {
3141 expireIfNeeded(db,key);
3142 return lookupKey(db,key);
3143}
3144
3145static robj *lookupKeyWrite(redisDb *db, robj *key) {
3146 deleteIfVolatile(db,key);
37ab76c9 3147 touchWatchedKey(db,key);
942a3961 3148 return lookupKey(db,key);
3149}
3150
92b27fe9 3151static robj *lookupKeyReadOrReply(redisClient *c, robj *key, robj *reply) {
3152 robj *o = lookupKeyRead(c->db, key);
3153 if (!o) addReply(c,reply);
3154 return o;
3155}
3156
3157static robj *lookupKeyWriteOrReply(redisClient *c, robj *key, robj *reply) {
3158 robj *o = lookupKeyWrite(c->db, key);
3159 if (!o) addReply(c,reply);
3160 return o;
3161}
3162
3163static int checkType(redisClient *c, robj *o, int type) {
3164 if (o->type != type) {
3165 addReply(c,shared.wrongtypeerr);
3166 return 1;
3167 }
3168 return 0;
3169}
3170
942a3961 3171static int deleteKey(redisDb *db, robj *key) {
3172 int retval;
3173
3174 /* We need to protect key from destruction: after the first dictDelete()
3175 * it may happen that 'key' is no longer valid if we don't increment
3176 * it's count. This may happen when we get the object reference directly
3177 * from the hash table with dictRandomKey() or dict iterators */
3178 incrRefCount(key);
3179 if (dictSize(db->expires)) dictDelete(db->expires,key);
3180 retval = dictDelete(db->dict,key);
3181 decrRefCount(key);
3182
3183 return retval == DICT_OK;
3184}
3185
724a51b1 3186/* Check if the nul-terminated string 's' can be represented by a long
3187 * (that is, is a number that fits into long without any other space or
3188 * character before or after the digits).
3189 *
3190 * If so, the function returns REDIS_OK and *longval is set to the value
3191 * of the number. Otherwise REDIS_ERR is returned */
f69f2cba 3192static int isStringRepresentableAsLong(sds s, long *longval) {
724a51b1 3193 char buf[32], *endptr;
3194 long value;
3195 int slen;
e0a62c7f 3196
724a51b1 3197 value = strtol(s, &endptr, 10);
3198 if (endptr[0] != '\0') return REDIS_ERR;
ee14da56 3199 slen = ll2string(buf,32,value);
724a51b1 3200
3201 /* If the number converted back into a string is not identical
3202 * then it's not possible to encode the string as integer */
f69f2cba 3203 if (sdslen(s) != (unsigned)slen || memcmp(buf,s,slen)) return REDIS_ERR;
724a51b1 3204 if (longval) *longval = value;
3205 return REDIS_OK;
3206}
3207
942a3961 3208/* Try to encode a string object in order to save space */
05df7621 3209static robj *tryObjectEncoding(robj *o) {
942a3961 3210 long value;
942a3961 3211 sds s = o->ptr;
3305306f 3212
942a3961 3213 if (o->encoding != REDIS_ENCODING_RAW)
05df7621 3214 return o; /* Already encoded */
3305306f 3215
05df7621 3216 /* It's not safe to encode shared objects: shared objects can be shared
942a3961 3217 * everywhere in the "object space" of Redis. Encoded objects can only
3218 * appear as "values" (and not, for instance, as keys) */
05df7621 3219 if (o->refcount > 1) return o;
3305306f 3220
942a3961 3221 /* Currently we try to encode only strings */
dfc5e96c 3222 redisAssert(o->type == REDIS_STRING);
94754ccc 3223
724a51b1 3224 /* Check if we can represent this string as a long integer */
05df7621 3225 if (isStringRepresentableAsLong(s,&value) == REDIS_ERR) return o;
942a3961 3226
3227 /* Ok, this object can be encoded */
05df7621 3228 if (value >= 0 && value < REDIS_SHARED_INTEGERS) {
3229 decrRefCount(o);
3230 incrRefCount(shared.integers[value]);
3231 return shared.integers[value];
3232 } else {
3233 o->encoding = REDIS_ENCODING_INT;
3234 sdsfree(o->ptr);
3235 o->ptr = (void*) value;
3236 return o;
3237 }
942a3961 3238}
3239
9d65a1bb 3240/* Get a decoded version of an encoded object (returned as a new object).
3241 * If the object is already raw-encoded just increment the ref count. */
3242static robj *getDecodedObject(robj *o) {
942a3961 3243 robj *dec;
e0a62c7f 3244
9d65a1bb 3245 if (o->encoding == REDIS_ENCODING_RAW) {
3246 incrRefCount(o);
3247 return o;
3248 }
942a3961 3249 if (o->type == REDIS_STRING && o->encoding == REDIS_ENCODING_INT) {
3250 char buf[32];
3251
ee14da56 3252 ll2string(buf,32,(long)o->ptr);
942a3961 3253 dec = createStringObject(buf,strlen(buf));
3254 return dec;
3255 } else {
08ee9b57 3256 redisPanic("Unknown encoding type");
942a3961 3257 }
3305306f 3258}
3259
d7f43c08 3260/* Compare two string objects via strcmp() or alike.
3261 * Note that the objects may be integer-encoded. In such a case we
ee14da56 3262 * use ll2string() to get a string representation of the numbers on the stack
1fd9bc8a 3263 * and compare the strings, it's much faster than calling getDecodedObject().
3264 *
3265 * Important note: if objects are not integer encoded, but binary-safe strings,
3266 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
3267 * binary safe. */
724a51b1 3268static int compareStringObjects(robj *a, robj *b) {
dfc5e96c 3269 redisAssert(a->type == REDIS_STRING && b->type == REDIS_STRING);
d7f43c08 3270 char bufa[128], bufb[128], *astr, *bstr;
3271 int bothsds = 1;
724a51b1 3272
e197b441 3273 if (a == b) return 0;
d7f43c08 3274 if (a->encoding != REDIS_ENCODING_RAW) {
ee14da56 3275 ll2string(bufa,sizeof(bufa),(long) a->ptr);
d7f43c08 3276 astr = bufa;
3277 bothsds = 0;
724a51b1 3278 } else {
d7f43c08 3279 astr = a->ptr;
724a51b1 3280 }
d7f43c08 3281 if (b->encoding != REDIS_ENCODING_RAW) {
ee14da56 3282 ll2string(bufb,sizeof(bufb),(long) b->ptr);
d7f43c08 3283 bstr = bufb;
3284 bothsds = 0;
3285 } else {
3286 bstr = b->ptr;
3287 }
3288 return bothsds ? sdscmp(astr,bstr) : strcmp(astr,bstr);
724a51b1 3289}
3290
bf028098 3291/* Equal string objects return 1 if the two objects are the same from the
3292 * point of view of a string comparison, otherwise 0 is returned. Note that
3293 * this function is faster then checking for (compareStringObject(a,b) == 0)
3294 * because it can perform some more optimization. */
3295static int equalStringObjects(robj *a, robj *b) {
3296 if (a->encoding != REDIS_ENCODING_RAW && b->encoding != REDIS_ENCODING_RAW){
3297 return a->ptr == b->ptr;
3298 } else {
3299 return compareStringObjects(a,b) == 0;
3300 }
3301}
3302
0ea663ea 3303static size_t stringObjectLen(robj *o) {
dfc5e96c 3304 redisAssert(o->type == REDIS_STRING);
0ea663ea 3305 if (o->encoding == REDIS_ENCODING_RAW) {
3306 return sdslen(o->ptr);
3307 } else {
3308 char buf[32];
3309
ee14da56 3310 return ll2string(buf,32,(long)o->ptr);
0ea663ea 3311 }
3312}
3313
bd79a6bd
PN
3314static int getDoubleFromObject(robj *o, double *target) {
3315 double value;
682c73e8 3316 char *eptr;
bbe025e0 3317
bd79a6bd
PN
3318 if (o == NULL) {
3319 value = 0;
3320 } else {
3321 redisAssert(o->type == REDIS_STRING);
3322 if (o->encoding == REDIS_ENCODING_RAW) {
3323 value = strtod(o->ptr, &eptr);
682c73e8 3324 if (eptr[0] != '\0') return REDIS_ERR;
bd79a6bd
PN
3325 } else if (o->encoding == REDIS_ENCODING_INT) {
3326 value = (long)o->ptr;
3327 } else {
946342c1 3328 redisPanic("Unknown string encoding");
bd79a6bd
PN
3329 }
3330 }
3331
bd79a6bd
PN
3332 *target = value;
3333 return REDIS_OK;
3334}
bbe025e0 3335
bd79a6bd
PN
3336static int getDoubleFromObjectOrReply(redisClient *c, robj *o, double *target, const char *msg) {
3337 double value;
3338 if (getDoubleFromObject(o, &value) != REDIS_OK) {
3339 if (msg != NULL) {
3340 addReplySds(c, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg));
3341 } else {
3342 addReplySds(c, sdsnew("-ERR value is not a double\r\n"));
3343 }
bbe025e0
AM
3344 return REDIS_ERR;
3345 }
3346
bd79a6bd 3347 *target = value;
bbe025e0
AM
3348 return REDIS_OK;
3349}
3350
bd79a6bd
PN
3351static int getLongLongFromObject(robj *o, long long *target) {
3352 long long value;
682c73e8 3353 char *eptr;
bbe025e0 3354
bd79a6bd
PN
3355 if (o == NULL) {
3356 value = 0;
3357 } else {
3358 redisAssert(o->type == REDIS_STRING);
3359 if (o->encoding == REDIS_ENCODING_RAW) {
3360 value = strtoll(o->ptr, &eptr, 10);
682c73e8 3361 if (eptr[0] != '\0') return REDIS_ERR;
bd79a6bd
PN
3362 } else if (o->encoding == REDIS_ENCODING_INT) {
3363 value = (long)o->ptr;
3364 } else {
946342c1 3365 redisPanic("Unknown string encoding");
bd79a6bd
PN
3366 }
3367 }
3368
bd79a6bd
PN
3369 *target = value;
3370 return REDIS_OK;
3371}
bbe025e0 3372
bd79a6bd
PN
3373static int getLongLongFromObjectOrReply(redisClient *c, robj *o, long long *target, const char *msg) {
3374 long long value;
3375 if (getLongLongFromObject(o, &value) != REDIS_OK) {
3376 if (msg != NULL) {
3377 addReplySds(c, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg));
3378 } else {
3379 addReplySds(c, sdsnew("-ERR value is not an integer\r\n"));
3380 }
bbe025e0
AM
3381 return REDIS_ERR;
3382 }
3383
bd79a6bd 3384 *target = value;
bbe025e0
AM
3385 return REDIS_OK;
3386}
3387
bd79a6bd
PN
3388static int getLongFromObjectOrReply(redisClient *c, robj *o, long *target, const char *msg) {
3389 long long value;
bbe025e0 3390
bd79a6bd
PN
3391 if (getLongLongFromObjectOrReply(c, o, &value, msg) != REDIS_OK) return REDIS_ERR;
3392 if (value < LONG_MIN || value > LONG_MAX) {
3393 if (msg != NULL) {
3394 addReplySds(c, sdscatprintf(sdsempty(), "-ERR %s\r\n", msg));
3395 } else {
3396 addReplySds(c, sdsnew("-ERR value is out of range\r\n"));
3397 }
bbe025e0
AM
3398 return REDIS_ERR;
3399 }
3400
bd79a6bd 3401 *target = value;
bbe025e0
AM
3402 return REDIS_OK;
3403}
3404
06233c45 3405/*============================ RDB saving/loading =========================== */
ed9b544e 3406
f78fd11b 3407static int rdbSaveType(FILE *fp, unsigned char type) {
3408 if (fwrite(&type,1,1,fp) == 0) return -1;
3409 return 0;
3410}
3411
bb32ede5 3412static int rdbSaveTime(FILE *fp, time_t t) {
3413 int32_t t32 = (int32_t) t;
3414 if (fwrite(&t32,4,1,fp) == 0) return -1;
3415 return 0;
3416}
3417
e3566d4b 3418/* check rdbLoadLen() comments for more info */
f78fd11b 3419static int rdbSaveLen(FILE *fp, uint32_t len) {
3420 unsigned char buf[2];
3421
3422 if (len < (1<<6)) {
3423 /* Save a 6 bit len */
10c43610 3424 buf[0] = (len&0xFF)|(REDIS_RDB_6BITLEN<<6);
f78fd11b 3425 if (fwrite(buf,1,1,fp) == 0) return -1;
3426 } else if (len < (1<<14)) {
3427 /* Save a 14 bit len */
10c43610 3428 buf[0] = ((len>>8)&0xFF)|(REDIS_RDB_14BITLEN<<6);
f78fd11b 3429 buf[1] = len&0xFF;
17be1a4a 3430 if (fwrite(buf,2,1,fp) == 0) return -1;
f78fd11b 3431 } else {
3432 /* Save a 32 bit len */
10c43610 3433 buf[0] = (REDIS_RDB_32BITLEN<<6);
f78fd11b 3434 if (fwrite(buf,1,1,fp) == 0) return -1;
3435 len = htonl(len);
3436 if (fwrite(&len,4,1,fp) == 0) return -1;
3437 }
3438 return 0;
3439}
3440
32a66513 3441/* Encode 'value' as an integer if possible (if integer will fit the
3442 * supported range). If the function sucessful encoded the integer
3443 * then the (up to 5 bytes) encoded representation is written in the
3444 * string pointed by 'enc' and the length is returned. Otherwise
3445 * 0 is returned. */
3446static int rdbEncodeInteger(long long value, unsigned char *enc) {
e3566d4b 3447 /* Finally check if it fits in our ranges */
3448 if (value >= -(1<<7) && value <= (1<<7)-1) {
3449 enc[0] = (REDIS_RDB_ENCVAL<<6)|REDIS_RDB_ENC_INT8;
3450 enc[1] = value&0xFF;
3451 return 2;
3452 } else if (value >= -(1<<15) && value <= (1<<15)-1) {
3453 enc[0] = (REDIS_RDB_ENCVAL<<6)|REDIS_RDB_ENC_INT16;
3454 enc[1] = value&0xFF;
3455 enc[2] = (value>>8)&0xFF;
3456 return 3;
3457 } else if (value >= -((long long)1<<31) && value <= ((long long)1<<31)-1) {
3458 enc[0] = (REDIS_RDB_ENCVAL<<6)|REDIS_RDB_ENC_INT32;
3459 enc[1] = value&0xFF;
3460 enc[2] = (value>>8)&0xFF;
3461 enc[3] = (value>>16)&0xFF;
3462 enc[4] = (value>>24)&0xFF;
3463 return 5;
3464 } else {
3465 return 0;
3466 }
3467}
3468
32a66513 3469/* String objects in the form "2391" "-100" without any space and with a
3470 * range of values that can fit in an 8, 16 or 32 bit signed value can be
3471 * encoded as integers to save space */
3472static int rdbTryIntegerEncoding(char *s, size_t len, unsigned char *enc) {
3473 long long value;
3474 char *endptr, buf[32];
3475
3476 /* Check if it's possible to encode this value as a number */
3477 value = strtoll(s, &endptr, 10);
3478 if (endptr[0] != '\0') return 0;
3479 ll2string(buf,32,value);
3480
3481 /* If the number converted back into a string is not identical
3482 * then it's not possible to encode the string as integer */
3483 if (strlen(buf) != len || memcmp(buf,s,len)) return 0;
3484
3485 return rdbEncodeInteger(value,enc);
3486}
3487
b1befe6a 3488static int rdbSaveLzfStringObject(FILE *fp, unsigned char *s, size_t len) {
3489 size_t comprlen, outlen;
774e3047 3490 unsigned char byte;
3491 void *out;
3492
3493 /* We require at least four bytes compression for this to be worth it */
b1befe6a 3494 if (len <= 4) return 0;
3495 outlen = len-4;
3a2694c4 3496 if ((out = zmalloc(outlen+1)) == NULL) return 0;
b1befe6a 3497 comprlen = lzf_compress(s, len, out, outlen);
774e3047 3498 if (comprlen == 0) {
88e85998 3499 zfree(out);
774e3047 3500 return 0;
3501 }
3502 /* Data compressed! Let's save it on disk */
3503 byte = (REDIS_RDB_ENCVAL<<6)|REDIS_RDB_ENC_LZF;
3504 if (fwrite(&byte,1,1,fp) == 0) goto writeerr;
3505 if (rdbSaveLen(fp,comprlen) == -1) goto writeerr;
b1befe6a 3506 if (rdbSaveLen(fp,len) == -1) goto writeerr;
774e3047 3507 if (fwrite(out,comprlen,1,fp) == 0) goto writeerr;
88e85998 3508 zfree(out);
774e3047 3509 return comprlen;
3510
3511writeerr:
88e85998 3512 zfree(out);
774e3047 3513 return -1;
3514}
3515
e3566d4b 3516/* Save a string objet as [len][data] on disk. If the object is a string
3517 * representation of an integer value we try to safe it in a special form */
b1befe6a 3518static int rdbSaveRawString(FILE *fp, unsigned char *s, size_t len) {
e3566d4b 3519 int enclen;
10c43610 3520
774e3047 3521 /* Try integer encoding */
e3566d4b 3522 if (len <= 11) {
3523 unsigned char buf[5];
b1befe6a 3524 if ((enclen = rdbTryIntegerEncoding((char*)s,len,buf)) > 0) {
e3566d4b 3525 if (fwrite(buf,enclen,1,fp) == 0) return -1;
3526 return 0;
3527 }
3528 }
774e3047 3529
3530 /* Try LZF compression - under 20 bytes it's unable to compress even
88e85998 3531 * aaaaaaaaaaaaaaaaaa so skip it */
121f70cf 3532 if (server.rdbcompression && len > 20) {
774e3047 3533 int retval;
3534
b1befe6a 3535 retval = rdbSaveLzfStringObject(fp,s,len);
774e3047 3536 if (retval == -1) return -1;
3537 if (retval > 0) return 0;
3538 /* retval == 0 means data can't be compressed, save the old way */
3539 }
3540
3541 /* Store verbatim */
10c43610 3542 if (rdbSaveLen(fp,len) == -1) return -1;
b1befe6a 3543 if (len && fwrite(s,len,1,fp) == 0) return -1;
10c43610 3544 return 0;
3545}
3546
942a3961 3547/* Like rdbSaveStringObjectRaw() but handle encoded objects */
3548static int rdbSaveStringObject(FILE *fp, robj *obj) {
3549 int retval;
942a3961 3550
32a66513 3551 /* Avoid to decode the object, then encode it again, if the
3552 * object is alrady integer encoded. */
3553 if (obj->encoding == REDIS_ENCODING_INT) {
3554 long val = (long) obj->ptr;
3555 unsigned char buf[5];
3556 int enclen;
3557
3558 if ((enclen = rdbEncodeInteger(val,buf)) > 0) {
3559 if (fwrite(buf,enclen,1,fp) == 0) return -1;
3560 return 0;
3561 }
3562 /* otherwise... fall throught and continue with the usual
3563 * code path. */
3564 }
3565
f2d9f50f 3566 /* Avoid incr/decr ref count business when possible.
3567 * This plays well with copy-on-write given that we are probably
3568 * in a child process (BGSAVE). Also this makes sure key objects
3569 * of swapped objects are not incRefCount-ed (an assert does not allow
3570 * this in order to avoid bugs) */
3571 if (obj->encoding != REDIS_ENCODING_RAW) {
996cb5f7 3572 obj = getDecodedObject(obj);
b1befe6a 3573 retval = rdbSaveRawString(fp,obj->ptr,sdslen(obj->ptr));
996cb5f7 3574 decrRefCount(obj);
3575 } else {
b1befe6a 3576 retval = rdbSaveRawString(fp,obj->ptr,sdslen(obj->ptr));
996cb5f7 3577 }
9d65a1bb 3578 return retval;
942a3961 3579}
3580
a7866db6 3581/* Save a double value. Doubles are saved as strings prefixed by an unsigned
3582 * 8 bit integer specifing the length of the representation.
3583 * This 8 bit integer has special values in order to specify the following
3584 * conditions:
3585 * 253: not a number
3586 * 254: + inf
3587 * 255: - inf
3588 */
3589static int rdbSaveDoubleValue(FILE *fp, double val) {
3590 unsigned char buf[128];
3591 int len;
3592
3593 if (isnan(val)) {
3594 buf[0] = 253;
3595 len = 1;
3596 } else if (!isfinite(val)) {
3597 len = 1;
3598 buf[0] = (val < 0) ? 255 : 254;
3599 } else {
88e8d89f 3600#if (DBL_MANT_DIG >= 52) && (LLONG_MAX == 0x7fffffffffffffffLL)
fe244589 3601 /* Check if the float is in a safe range to be casted into a
3602 * long long. We are assuming that long long is 64 bit here.
3603 * Also we are assuming that there are no implementations around where
3604 * double has precision < 52 bit.
3605 *
3606 * Under this assumptions we test if a double is inside an interval
3607 * where casting to long long is safe. Then using two castings we
3608 * make sure the decimal part is zero. If all this is true we use
3609 * integer printing function that is much faster. */
fb82e75c 3610 double min = -4503599627370495; /* (2^52)-1 */
3611 double max = 4503599627370496; /* -(2^52) */
fe244589 3612 if (val > min && val < max && val == ((double)((long long)val)))
8c096b16 3613 ll2string((char*)buf+1,sizeof(buf),(long long)val);
3614 else
88e8d89f 3615#endif
8c096b16 3616 snprintf((char*)buf+1,sizeof(buf)-1,"%.17g",val);
6c446631 3617 buf[0] = strlen((char*)buf+1);
a7866db6 3618 len = buf[0]+1;
3619 }
3620 if (fwrite(buf,len,1,fp) == 0) return -1;
3621 return 0;
3622}
3623
06233c45 3624/* Save a Redis object. */
3625static int rdbSaveObject(FILE *fp, robj *o) {
3626 if (o->type == REDIS_STRING) {
3627 /* Save a string value */
3628 if (rdbSaveStringObject(fp,o) == -1) return -1;
3629 } else if (o->type == REDIS_LIST) {
3630 /* Save a list value */
3631 list *list = o->ptr;
c7df85a4 3632 listIter li;
06233c45 3633 listNode *ln;
3634
06233c45 3635 if (rdbSaveLen(fp,listLength(list)) == -1) return -1;
c7df85a4 3636 listRewind(list,&li);
3637 while((ln = listNext(&li))) {
06233c45 3638 robj *eleobj = listNodeValue(ln);
3639
3640 if (rdbSaveStringObject(fp,eleobj) == -1) return -1;
3641 }
3642 } else if (o->type == REDIS_SET) {
3643 /* Save a set value */
3644 dict *set = o->ptr;
3645 dictIterator *di = dictGetIterator(set);
3646 dictEntry *de;
3647
3648 if (rdbSaveLen(fp,dictSize(set)) == -1) return -1;
3649 while((de = dictNext(di)) != NULL) {
3650 robj *eleobj = dictGetEntryKey(de);
3651
3652 if (rdbSaveStringObject(fp,eleobj) == -1) return -1;
3653 }
3654 dictReleaseIterator(di);
3655 } else if (o->type == REDIS_ZSET) {
3656 /* Save a set value */
3657 zset *zs = o->ptr;
3658 dictIterator *di = dictGetIterator(zs->dict);
3659 dictEntry *de;
3660
3661 if (rdbSaveLen(fp,dictSize(zs->dict)) == -1) return -1;
3662 while((de = dictNext(di)) != NULL) {
3663 robj *eleobj = dictGetEntryKey(de);
3664 double *score = dictGetEntryVal(de);
3665
3666 if (rdbSaveStringObject(fp,eleobj) == -1) return -1;
3667 if (rdbSaveDoubleValue(fp,*score) == -1) return -1;
3668 }
3669 dictReleaseIterator(di);
b1befe6a 3670 } else if (o->type == REDIS_HASH) {
3671 /* Save a hash value */
3672 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
3673 unsigned char *p = zipmapRewind(o->ptr);
3674 unsigned int count = zipmapLen(o->ptr);
3675 unsigned char *key, *val;
3676 unsigned int klen, vlen;
3677
3678 if (rdbSaveLen(fp,count) == -1) return -1;
3679 while((p = zipmapNext(p,&key,&klen,&val,&vlen)) != NULL) {
3680 if (rdbSaveRawString(fp,key,klen) == -1) return -1;
3681 if (rdbSaveRawString(fp,val,vlen) == -1) return -1;
3682 }
3683 } else {
3684 dictIterator *di = dictGetIterator(o->ptr);
3685 dictEntry *de;
3686
3687 if (rdbSaveLen(fp,dictSize((dict*)o->ptr)) == -1) return -1;
3688 while((de = dictNext(di)) != NULL) {
3689 robj *key = dictGetEntryKey(de);
3690 robj *val = dictGetEntryVal(de);
3691
3692 if (rdbSaveStringObject(fp,key) == -1) return -1;
3693 if (rdbSaveStringObject(fp,val) == -1) return -1;
3694 }
3695 dictReleaseIterator(di);
3696 }
06233c45 3697 } else {
f83c6cb5 3698 redisPanic("Unknown object type");
06233c45 3699 }
3700 return 0;
3701}
3702
3703/* Return the length the object will have on disk if saved with
3704 * the rdbSaveObject() function. Currently we use a trick to get
3705 * this length with very little changes to the code. In the future
3706 * we could switch to a faster solution. */
b9bc0eef 3707static off_t rdbSavedObjectLen(robj *o, FILE *fp) {
3708 if (fp == NULL) fp = server.devnull;
06233c45 3709 rewind(fp);
3710 assert(rdbSaveObject(fp,o) != 1);
3711 return ftello(fp);
3712}
3713
06224fec 3714/* Return the number of pages required to save this object in the swap file */
b9bc0eef 3715static off_t rdbSavedObjectPages(robj *o, FILE *fp) {
3716 off_t bytes = rdbSavedObjectLen(o,fp);
e0a62c7f 3717
06224fec 3718 return (bytes+(server.vm_page_size-1))/server.vm_page_size;
3719}
3720
ed9b544e 3721/* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
f78fd11b 3722static int rdbSave(char *filename) {
ed9b544e 3723 dictIterator *di = NULL;
3724 dictEntry *de;
ed9b544e 3725 FILE *fp;
3726 char tmpfile[256];
3727 int j;
bb32ede5 3728 time_t now = time(NULL);
ed9b544e 3729
2316bb3b 3730 /* Wait for I/O therads to terminate, just in case this is a
3731 * foreground-saving, to avoid seeking the swap file descriptor at the
3732 * same time. */
3733 if (server.vm_enabled)
3734 waitEmptyIOJobsQueue();
3735
a3b21203 3736 snprintf(tmpfile,256,"temp-%d.rdb", (int) getpid());
ed9b544e 3737 fp = fopen(tmpfile,"w");
3738 if (!fp) {
3739 redisLog(REDIS_WARNING, "Failed saving the DB: %s", strerror(errno));
3740 return REDIS_ERR;
3741 }
f78fd11b 3742 if (fwrite("REDIS0001",9,1,fp) == 0) goto werr;
ed9b544e 3743 for (j = 0; j < server.dbnum; j++) {
bb32ede5 3744 redisDb *db = server.db+j;
3745 dict *d = db->dict;
3305306f 3746 if (dictSize(d) == 0) continue;
ed9b544e 3747 di = dictGetIterator(d);
3748 if (!di) {
3749 fclose(fp);
3750 return REDIS_ERR;
3751 }
3752
3753 /* Write the SELECT DB opcode */
f78fd11b 3754 if (rdbSaveType(fp,REDIS_SELECTDB) == -1) goto werr;
3755 if (rdbSaveLen(fp,j) == -1) goto werr;
ed9b544e 3756
3757 /* Iterate this DB writing every entry */
3758 while((de = dictNext(di)) != NULL) {
3759 robj *key = dictGetEntryKey(de);
3760 robj *o = dictGetEntryVal(de);
bb32ede5 3761 time_t expiretime = getExpire(db,key);
3762
3763 /* Save the expire time */
3764 if (expiretime != -1) {
3765 /* If this key is already expired skip it */
3766 if (expiretime < now) continue;
3767 if (rdbSaveType(fp,REDIS_EXPIRETIME) == -1) goto werr;
3768 if (rdbSaveTime(fp,expiretime) == -1) goto werr;
3769 }
7e69548d 3770 /* Save the key and associated value. This requires special
3771 * handling if the value is swapped out. */
996cb5f7 3772 if (!server.vm_enabled || key->storage == REDIS_VM_MEMORY ||
3773 key->storage == REDIS_VM_SWAPPING) {
7e69548d 3774 /* Save type, key, value */
3775 if (rdbSaveType(fp,o->type) == -1) goto werr;
3776 if (rdbSaveStringObject(fp,key) == -1) goto werr;
3777 if (rdbSaveObject(fp,o) == -1) goto werr;
3778 } else {
996cb5f7 3779 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
b9bc0eef 3780 robj *po;
7e69548d 3781 /* Get a preview of the object in memory */
3782 po = vmPreviewObject(key);
7e69548d 3783 /* Save type, key, value */
3784 if (rdbSaveType(fp,key->vtype) == -1) goto werr;
b9bc0eef 3785 if (rdbSaveStringObject(fp,key) == -1) goto werr;
7e69548d 3786 if (rdbSaveObject(fp,po) == -1) goto werr;
3787 /* Remove the loaded object from memory */
3788 decrRefCount(po);
7e69548d 3789 }
ed9b544e 3790 }
3791 dictReleaseIterator(di);
3792 }
3793 /* EOF opcode */
f78fd11b 3794 if (rdbSaveType(fp,REDIS_EOF) == -1) goto werr;
3795
3796 /* Make sure data will not remain on the OS's output buffers */
ed9b544e 3797 fflush(fp);
3798 fsync(fileno(fp));
3799 fclose(fp);
e0a62c7f 3800
ed9b544e 3801 /* Use RENAME to make sure the DB file is changed atomically only
3802 * if the generate DB file is ok. */
3803 if (rename(tmpfile,filename) == -1) {
325d1eb4 3804 redisLog(REDIS_WARNING,"Error moving temp DB file on the final destination: %s", strerror(errno));
ed9b544e 3805 unlink(tmpfile);
3806 return REDIS_ERR;
3807 }
3808 redisLog(REDIS_NOTICE,"DB saved on disk");
3809 server.dirty = 0;
3810 server.lastsave = time(NULL);
3811 return REDIS_OK;
3812
3813werr:
3814 fclose(fp);
3815 unlink(tmpfile);
3816 redisLog(REDIS_WARNING,"Write error saving DB on disk: %s", strerror(errno));
3817 if (di) dictReleaseIterator(di);
3818 return REDIS_ERR;
3819}
3820
f78fd11b 3821static int rdbSaveBackground(char *filename) {
ed9b544e 3822 pid_t childpid;
3823
9d65a1bb 3824 if (server.bgsavechildpid != -1) return REDIS_ERR;
054e426d 3825 if (server.vm_enabled) waitEmptyIOJobsQueue();
ed9b544e 3826 if ((childpid = fork()) == 0) {
3827 /* Child */
054e426d 3828 if (server.vm_enabled) vmReopenSwapFile();
ed9b544e 3829 close(server.fd);
f78fd11b 3830 if (rdbSave(filename) == REDIS_OK) {
478c2c6f 3831 _exit(0);
ed9b544e 3832 } else {
478c2c6f 3833 _exit(1);
ed9b544e 3834 }
3835 } else {
3836 /* Parent */
5a7c647e 3837 if (childpid == -1) {
3838 redisLog(REDIS_WARNING,"Can't save in background: fork: %s",
3839 strerror(errno));
3840 return REDIS_ERR;
3841 }
ed9b544e 3842 redisLog(REDIS_NOTICE,"Background saving started by pid %d",childpid);
9f3c422c 3843 server.bgsavechildpid = childpid;
884d4b39 3844 updateDictResizePolicy();
ed9b544e 3845 return REDIS_OK;
3846 }
3847 return REDIS_OK; /* unreached */
3848}
3849
a3b21203 3850static void rdbRemoveTempFile(pid_t childpid) {
3851 char tmpfile[256];
3852
3853 snprintf(tmpfile,256,"temp-%d.rdb", (int) childpid);
3854 unlink(tmpfile);
3855}
3856
f78fd11b 3857static int rdbLoadType(FILE *fp) {
3858 unsigned char type;
7b45bfb2 3859 if (fread(&type,1,1,fp) == 0) return -1;
3860 return type;
3861}
3862
bb32ede5 3863static time_t rdbLoadTime(FILE *fp) {
3864 int32_t t32;
3865 if (fread(&t32,4,1,fp) == 0) return -1;
3866 return (time_t) t32;
3867}
3868
e3566d4b 3869/* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3870 * of this file for a description of how this are stored on disk.
3871 *
3872 * isencoded is set to 1 if the readed length is not actually a length but
3873 * an "encoding type", check the above comments for more info */
c78a8ccc 3874static uint32_t rdbLoadLen(FILE *fp, int *isencoded) {
f78fd11b 3875 unsigned char buf[2];
3876 uint32_t len;
c78a8ccc 3877 int type;
f78fd11b 3878
e3566d4b 3879 if (isencoded) *isencoded = 0;
c78a8ccc 3880 if (fread(buf,1,1,fp) == 0) return REDIS_RDB_LENERR;
3881 type = (buf[0]&0xC0)>>6;
3882 if (type == REDIS_RDB_6BITLEN) {
3883 /* Read a 6 bit len */
3884 return buf[0]&0x3F;
3885 } else if (type == REDIS_RDB_ENCVAL) {
3886 /* Read a 6 bit len encoding type */
3887 if (isencoded) *isencoded = 1;
3888 return buf[0]&0x3F;
3889 } else if (type == REDIS_RDB_14BITLEN) {
3890 /* Read a 14 bit len */
3891 if (fread(buf+1,1,1,fp) == 0) return REDIS_RDB_LENERR;
3892 return ((buf[0]&0x3F)<<8)|buf[1];
3893 } else {
3894 /* Read a 32 bit len */
f78fd11b 3895 if (fread(&len,4,1,fp) == 0) return REDIS_RDB_LENERR;
3896 return ntohl(len);
f78fd11b 3897 }
f78fd11b 3898}
3899
ad30aa60 3900/* Load an integer-encoded object from file 'fp', with the specified
3901 * encoding type 'enctype'. If encode is true the function may return
3902 * an integer-encoded object as reply, otherwise the returned object
3903 * will always be encoded as a raw string. */
3904static robj *rdbLoadIntegerObject(FILE *fp, int enctype, int encode) {
e3566d4b 3905 unsigned char enc[4];
3906 long long val;
3907
3908 if (enctype == REDIS_RDB_ENC_INT8) {
3909 if (fread(enc,1,1,fp) == 0) return NULL;
3910 val = (signed char)enc[0];
3911 } else if (enctype == REDIS_RDB_ENC_INT16) {
3912 uint16_t v;
3913 if (fread(enc,2,1,fp) == 0) return NULL;
3914 v = enc[0]|(enc[1]<<8);
3915 val = (int16_t)v;
3916 } else if (enctype == REDIS_RDB_ENC_INT32) {
3917 uint32_t v;
3918 if (fread(enc,4,1,fp) == 0) return NULL;
3919 v = enc[0]|(enc[1]<<8)|(enc[2]<<16)|(enc[3]<<24);
3920 val = (int32_t)v;
3921 } else {
3922 val = 0; /* anti-warning */
f83c6cb5 3923 redisPanic("Unknown RDB integer encoding type");
e3566d4b 3924 }
ad30aa60 3925 if (encode)
3926 return createStringObjectFromLongLong(val);
3927 else
3928 return createObject(REDIS_STRING,sdsfromlonglong(val));
e3566d4b 3929}
3930
c78a8ccc 3931static robj *rdbLoadLzfStringObject(FILE*fp) {
88e85998 3932 unsigned int len, clen;
3933 unsigned char *c = NULL;
3934 sds val = NULL;
3935
c78a8ccc 3936 if ((clen = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
3937 if ((len = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
88e85998 3938 if ((c = zmalloc(clen)) == NULL) goto err;
3939 if ((val = sdsnewlen(NULL,len)) == NULL) goto err;
3940 if (fread(c,clen,1,fp) == 0) goto err;
3941 if (lzf_decompress(c,clen,val,len) == 0) goto err;
5109cdff 3942 zfree(c);
88e85998 3943 return createObject(REDIS_STRING,val);
3944err:
3945 zfree(c);
3946 sdsfree(val);
3947 return NULL;
3948}
3949
ad30aa60 3950static robj *rdbGenericLoadStringObject(FILE*fp, int encode) {
e3566d4b 3951 int isencoded;
3952 uint32_t len;
f78fd11b 3953 sds val;
3954
c78a8ccc 3955 len = rdbLoadLen(fp,&isencoded);
e3566d4b 3956 if (isencoded) {
3957 switch(len) {
3958 case REDIS_RDB_ENC_INT8:
3959 case REDIS_RDB_ENC_INT16:
3960 case REDIS_RDB_ENC_INT32:
ad30aa60 3961 return rdbLoadIntegerObject(fp,len,encode);
88e85998 3962 case REDIS_RDB_ENC_LZF:
bdcb92f2 3963 return rdbLoadLzfStringObject(fp);
e3566d4b 3964 default:
f83c6cb5 3965 redisPanic("Unknown RDB encoding type");
e3566d4b 3966 }
3967 }
3968
f78fd11b 3969 if (len == REDIS_RDB_LENERR) return NULL;
3970 val = sdsnewlen(NULL,len);
3971 if (len && fread(val,len,1,fp) == 0) {
3972 sdsfree(val);
3973 return NULL;
3974 }
bdcb92f2 3975 return createObject(REDIS_STRING,val);
f78fd11b 3976}
3977
ad30aa60 3978static robj *rdbLoadStringObject(FILE *fp) {
3979 return rdbGenericLoadStringObject(fp,0);
3980}
3981
3982static robj *rdbLoadEncodedStringObject(FILE *fp) {
3983 return rdbGenericLoadStringObject(fp,1);
3984}
3985
a7866db6 3986/* For information about double serialization check rdbSaveDoubleValue() */
3987static int rdbLoadDoubleValue(FILE *fp, double *val) {
3988 char buf[128];
3989 unsigned char len;
3990
3991 if (fread(&len,1,1,fp) == 0) return -1;
3992 switch(len) {
3993 case 255: *val = R_NegInf; return 0;
3994 case 254: *val = R_PosInf; return 0;
3995 case 253: *val = R_Nan; return 0;
3996 default:
3997 if (fread(buf,len,1,fp) == 0) return -1;
231d758e 3998 buf[len] = '\0';
a7866db6 3999 sscanf(buf, "%lg", val);
4000 return 0;
4001 }
4002}
4003
c78a8ccc 4004/* Load a Redis object of the specified type from the specified file.
4005 * On success a newly allocated object is returned, otherwise NULL. */
4006static robj *rdbLoadObject(int type, FILE *fp) {
4007 robj *o;
4008
bcd11906 4009 redisLog(REDIS_DEBUG,"LOADING OBJECT %d (at %d)\n",type,ftell(fp));
c78a8ccc 4010 if (type == REDIS_STRING) {
4011 /* Read string value */
ad30aa60 4012 if ((o = rdbLoadEncodedStringObject(fp)) == NULL) return NULL;
05df7621 4013 o = tryObjectEncoding(o);
c78a8ccc 4014 } else if (type == REDIS_LIST || type == REDIS_SET) {
4015 /* Read list/set value */
4016 uint32_t listlen;
4017
4018 if ((listlen = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
4019 o = (type == REDIS_LIST) ? createListObject() : createSetObject();
3c68de9b 4020 /* It's faster to expand the dict to the right size asap in order
4021 * to avoid rehashing */
4022 if (type == REDIS_SET && listlen > DICT_HT_INITIAL_SIZE)
4023 dictExpand(o->ptr,listlen);
c78a8ccc 4024 /* Load every single element of the list/set */
4025 while(listlen--) {
4026 robj *ele;
4027
ad30aa60 4028 if ((ele = rdbLoadEncodedStringObject(fp)) == NULL) return NULL;
05df7621 4029 ele = tryObjectEncoding(ele);
c78a8ccc 4030 if (type == REDIS_LIST) {
4031 listAddNodeTail((list*)o->ptr,ele);
4032 } else {
4033 dictAdd((dict*)o->ptr,ele,NULL);
4034 }
4035 }
4036 } else if (type == REDIS_ZSET) {
4037 /* Read list/set value */
ada386b2 4038 size_t zsetlen;
c78a8ccc 4039 zset *zs;
4040
4041 if ((zsetlen = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
4042 o = createZsetObject();
4043 zs = o->ptr;
4044 /* Load every single element of the list/set */
4045 while(zsetlen--) {
4046 robj *ele;
4047 double *score = zmalloc(sizeof(double));
4048
ad30aa60 4049 if ((ele = rdbLoadEncodedStringObject(fp)) == NULL) return NULL;
05df7621 4050 ele = tryObjectEncoding(ele);
c78a8ccc 4051 if (rdbLoadDoubleValue(fp,score) == -1) return NULL;
4052 dictAdd(zs->dict,ele,score);
4053 zslInsert(zs->zsl,*score,ele);
4054 incrRefCount(ele); /* added to skiplist */
4055 }
ada386b2 4056 } else if (type == REDIS_HASH) {
4057 size_t hashlen;
4058
4059 if ((hashlen = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR) return NULL;
4060 o = createHashObject();
4061 /* Too many entries? Use an hash table. */
4062 if (hashlen > server.hash_max_zipmap_entries)
4063 convertToRealHash(o);
4064 /* Load every key/value, then set it into the zipmap or hash
4065 * table, as needed. */
4066 while(hashlen--) {
4067 robj *key, *val;
4068
4069 if ((key = rdbLoadStringObject(fp)) == NULL) return NULL;
4070 if ((val = rdbLoadStringObject(fp)) == NULL) return NULL;
4071 /* If we are using a zipmap and there are too big values
4072 * the object is converted to real hash table encoding. */
4073 if (o->encoding != REDIS_ENCODING_HT &&
4074 (sdslen(key->ptr) > server.hash_max_zipmap_value ||
4075 sdslen(val->ptr) > server.hash_max_zipmap_value))
4076 {
4077 convertToRealHash(o);
4078 }
4079
4080 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
4081 unsigned char *zm = o->ptr;
4082
4083 zm = zipmapSet(zm,key->ptr,sdslen(key->ptr),
4084 val->ptr,sdslen(val->ptr),NULL);
4085 o->ptr = zm;
4086 decrRefCount(key);
4087 decrRefCount(val);
4088 } else {
05df7621 4089 key = tryObjectEncoding(key);
4090 val = tryObjectEncoding(val);
ada386b2 4091 dictAdd((dict*)o->ptr,key,val);
ada386b2 4092 }
4093 }
c78a8ccc 4094 } else {
f83c6cb5 4095 redisPanic("Unknown object type");
c78a8ccc 4096 }
4097 return o;
4098}
4099
f78fd11b 4100static int rdbLoad(char *filename) {
ed9b544e 4101 FILE *fp;
f78fd11b 4102 uint32_t dbid;
bb32ede5 4103 int type, retval, rdbver;
585af7e2 4104 int swap_all_values = 0;
3305306f 4105 dict *d = server.db[0].dict;
bb32ede5 4106 redisDb *db = server.db+0;
f78fd11b 4107 char buf[1024];
242a64f3 4108 time_t expiretime, now = time(NULL);
b492cf00 4109 long long loadedkeys = 0;
bb32ede5 4110
ed9b544e 4111 fp = fopen(filename,"r");
4112 if (!fp) return REDIS_ERR;
4113 if (fread(buf,9,1,fp) == 0) goto eoferr;
f78fd11b 4114 buf[9] = '\0';
4115 if (memcmp(buf,"REDIS",5) != 0) {
ed9b544e 4116 fclose(fp);
4117 redisLog(REDIS_WARNING,"Wrong signature trying to load DB from file");
4118 return REDIS_ERR;
4119 }
f78fd11b 4120 rdbver = atoi(buf+5);
c78a8ccc 4121 if (rdbver != 1) {
f78fd11b 4122 fclose(fp);
4123 redisLog(REDIS_WARNING,"Can't handle RDB format version %d",rdbver);
4124 return REDIS_ERR;
4125 }
ed9b544e 4126 while(1) {
585af7e2 4127 robj *key, *val;
ed9b544e 4128
585af7e2 4129 expiretime = -1;
ed9b544e 4130 /* Read type. */
f78fd11b 4131 if ((type = rdbLoadType(fp)) == -1) goto eoferr;
bb32ede5 4132 if (type == REDIS_EXPIRETIME) {
4133 if ((expiretime = rdbLoadTime(fp)) == -1) goto eoferr;
4134 /* We read the time so we need to read the object type again */
4135 if ((type = rdbLoadType(fp)) == -1) goto eoferr;
4136 }
ed9b544e 4137 if (type == REDIS_EOF) break;
4138 /* Handle SELECT DB opcode as a special case */
4139 if (type == REDIS_SELECTDB) {
c78a8ccc 4140 if ((dbid = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR)
e3566d4b 4141 goto eoferr;
ed9b544e 4142 if (dbid >= (unsigned)server.dbnum) {
f78fd11b 4143 redisLog(REDIS_WARNING,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server.dbnum);
ed9b544e 4144 exit(1);
4145 }
bb32ede5 4146 db = server.db+dbid;
4147 d = db->dict;
ed9b544e 4148 continue;
4149 }
4150 /* Read key */
585af7e2 4151 if ((key = rdbLoadStringObject(fp)) == NULL) goto eoferr;
c78a8ccc 4152 /* Read value */
585af7e2 4153 if ((val = rdbLoadObject(type,fp)) == NULL) goto eoferr;
89e689c5 4154 /* Check if the key already expired */
4155 if (expiretime != -1 && expiretime < now) {
4156 decrRefCount(key);
4157 decrRefCount(val);
4158 continue;
4159 }
ed9b544e 4160 /* Add the new object in the hash table */
585af7e2 4161 retval = dictAdd(d,key,val);
ed9b544e 4162 if (retval == DICT_ERR) {
585af7e2 4163 redisLog(REDIS_WARNING,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", key->ptr);
ed9b544e 4164 exit(1);
4165 }
242a64f3 4166 loadedkeys++;
bb32ede5 4167 /* Set the expire time if needed */
89e689c5 4168 if (expiretime != -1) setExpire(db,key,expiretime);
242a64f3 4169
b492cf00 4170 /* Handle swapping while loading big datasets when VM is on */
242a64f3 4171
4172 /* If we detecter we are hopeless about fitting something in memory
4173 * we just swap every new key on disk. Directly...
4174 * Note that's important to check for this condition before resorting
4175 * to random sampling, otherwise we may try to swap already
4176 * swapped keys. */
585af7e2 4177 if (swap_all_values) {
4178 dictEntry *de = dictFind(d,key);
242a64f3 4179
4180 /* de may be NULL since the key already expired */
4181 if (de) {
585af7e2 4182 key = dictGetEntryKey(de);
4183 val = dictGetEntryVal(de);
242a64f3 4184
585af7e2 4185 if (vmSwapObjectBlocking(key,val) == REDIS_OK) {
242a64f3 4186 dictGetEntryVal(de) = NULL;
4187 }
4188 }
4189 continue;
4190 }
4191
4192 /* If we have still some hope of having some value fitting memory
4193 * then we try random sampling. */
585af7e2 4194 if (!swap_all_values && server.vm_enabled && (loadedkeys % 5000) == 0) {
b492cf00 4195 while (zmalloc_used_memory() > server.vm_max_memory) {
a69a0c9c 4196 if (vmSwapOneObjectBlocking() == REDIS_ERR) break;
b492cf00 4197 }
242a64f3 4198 if (zmalloc_used_memory() > server.vm_max_memory)
585af7e2 4199 swap_all_values = 1; /* We are already using too much mem */
b492cf00 4200 }
ed9b544e 4201 }
4202 fclose(fp);
4203 return REDIS_OK;
4204
4205eoferr: /* unexpected end of file is handled here with a fatal exit */
f80dff62 4206 redisLog(REDIS_WARNING,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
ed9b544e 4207 exit(1);
4208 return REDIS_ERR; /* Just to avoid warning */
4209}
4210
b58ba105 4211/*================================== Shutdown =============================== */
fab43727 4212static int prepareForShutdown() {
b58ba105
AM
4213 redisLog(REDIS_WARNING,"User requested shutdown, saving DB...");
4214 /* Kill the saving child if there is a background saving in progress.
4215 We want to avoid race conditions, for instance our saving child may
4216 overwrite the synchronous saving did by SHUTDOWN. */
4217 if (server.bgsavechildpid != -1) {
4218 redisLog(REDIS_WARNING,"There is a live saving child. Killing it!");
4219 kill(server.bgsavechildpid,SIGKILL);
4220 rdbRemoveTempFile(server.bgsavechildpid);
4221 }
4222 if (server.appendonly) {
4223 /* Append only file: fsync() the AOF and exit */
4224 fsync(server.appendfd);
4225 if (server.vm_enabled) unlink(server.vm_swap_file);
b58ba105
AM
4226 } else {
4227 /* Snapshotting. Perform a SYNC SAVE and exit */
4228 if (rdbSave(server.dbfilename) == REDIS_OK) {
4229 if (server.daemonize)
4230 unlink(server.pidfile);
4231 redisLog(REDIS_WARNING,"%zu bytes used at exit",zmalloc_used_memory());
b58ba105
AM
4232 } else {
4233 /* Ooops.. error saving! The best we can do is to continue
4234 * operating. Note that if there was a background saving process,
4235 * in the next cron() Redis will be notified that the background
4236 * saving aborted, handling special stuff like slaves pending for
4237 * synchronization... */
4238 redisLog(REDIS_WARNING,"Error trying to save the DB, can't exit");
fab43727 4239 return REDIS_ERR;
b58ba105
AM
4240 }
4241 }
8513a757 4242 redisLog(REDIS_WARNING,"Server exit now, bye bye...");
fab43727 4243 return REDIS_OK;
b58ba105
AM
4244}
4245
ed9b544e 4246/*================================== Commands =============================== */
4247
abcb223e 4248static void authCommand(redisClient *c) {
2e77c2ee 4249 if (!server.requirepass || !strcmp(c->argv[1]->ptr, server.requirepass)) {
abcb223e
BH
4250 c->authenticated = 1;
4251 addReply(c,shared.ok);
4252 } else {
4253 c->authenticated = 0;
fa4c0aba 4254 addReplySds(c,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
abcb223e
BH
4255 }
4256}
4257
ed9b544e 4258static void pingCommand(redisClient *c) {
4259 addReply(c,shared.pong);
4260}
4261
4262static void echoCommand(redisClient *c) {
dd88747b 4263 addReplyBulk(c,c->argv[1]);
ed9b544e 4264}
4265
4266/*=================================== Strings =============================== */
4267
526d00a5 4268static void setGenericCommand(redisClient *c, int nx, robj *key, robj *val, robj *expire) {
ed9b544e 4269 int retval;
10ce1276 4270 long seconds = 0; /* initialized to avoid an harmness warning */
ed9b544e 4271
526d00a5 4272 if (expire) {
4273 if (getLongFromObjectOrReply(c, expire, &seconds, NULL) != REDIS_OK)
4274 return;
4275 if (seconds <= 0) {
4276 addReplySds(c,sdsnew("-ERR invalid expire time in SETEX\r\n"));
4277 return;
4278 }
4279 }
4280
37ab76c9 4281 touchWatchedKey(c->db,key);
526d00a5 4282 if (nx) deleteIfVolatile(c->db,key);
4283 retval = dictAdd(c->db->dict,key,val);
ed9b544e 4284 if (retval == DICT_ERR) {
4285 if (!nx) {
1b03836c 4286 /* If the key is about a swapped value, we want a new key object
4287 * to overwrite the old. So we delete the old key in the database.
4288 * This will also make sure that swap pages about the old object
4289 * will be marked as free. */
526d00a5 4290 if (server.vm_enabled && deleteIfSwapped(c->db,key))
4291 incrRefCount(key);
4292 dictReplace(c->db->dict,key,val);
4293 incrRefCount(val);
ed9b544e 4294 } else {
c937aa89 4295 addReply(c,shared.czero);
ed9b544e 4296 return;
4297 }
4298 } else {
526d00a5 4299 incrRefCount(key);
4300 incrRefCount(val);
ed9b544e 4301 }
4302 server.dirty++;
526d00a5 4303 removeExpire(c->db,key);
4304 if (expire) setExpire(c->db,key,time(NULL)+seconds);
c937aa89 4305 addReply(c, nx ? shared.cone : shared.ok);
ed9b544e 4306}
4307
4308static void setCommand(redisClient *c) {
526d00a5 4309 setGenericCommand(c,0,c->argv[1],c->argv[2],NULL);
ed9b544e 4310}
4311
4312static void setnxCommand(redisClient *c) {
526d00a5 4313 setGenericCommand(c,1,c->argv[1],c->argv[2],NULL);
4314}
4315
4316static void setexCommand(redisClient *c) {
4317 setGenericCommand(c,0,c->argv[1],c->argv[3],c->argv[2]);
ed9b544e 4318}
4319
322fc7d8 4320static int getGenericCommand(redisClient *c) {
dd88747b 4321 robj *o;
e0a62c7f 4322
dd88747b 4323 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL)
322fc7d8 4324 return REDIS_OK;
dd88747b 4325
4326 if (o->type != REDIS_STRING) {
4327 addReply(c,shared.wrongtypeerr);
4328 return REDIS_ERR;
ed9b544e 4329 } else {
dd88747b 4330 addReplyBulk(c,o);
4331 return REDIS_OK;
ed9b544e 4332 }
4333}
4334
322fc7d8 4335static void getCommand(redisClient *c) {
4336 getGenericCommand(c);
4337}
4338
f6b141c5 4339static void getsetCommand(redisClient *c) {
322fc7d8 4340 if (getGenericCommand(c) == REDIS_ERR) return;
a431eb74 4341 if (dictAdd(c->db->dict,c->argv[1],c->argv[2]) == DICT_ERR) {
4342 dictReplace(c->db->dict,c->argv[1],c->argv[2]);
4343 } else {
4344 incrRefCount(c->argv[1]);
4345 }
4346 incrRefCount(c->argv[2]);
4347 server.dirty++;
4348 removeExpire(c->db,c->argv[1]);
4349}
4350
70003d28 4351static void mgetCommand(redisClient *c) {
70003d28 4352 int j;
e0a62c7f 4353
c937aa89 4354 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",c->argc-1));
70003d28 4355 for (j = 1; j < c->argc; j++) {
3305306f 4356 robj *o = lookupKeyRead(c->db,c->argv[j]);
4357 if (o == NULL) {
c937aa89 4358 addReply(c,shared.nullbulk);
70003d28 4359 } else {
70003d28 4360 if (o->type != REDIS_STRING) {
c937aa89 4361 addReply(c,shared.nullbulk);
70003d28 4362 } else {
dd88747b 4363 addReplyBulk(c,o);
70003d28 4364 }
4365 }
4366 }
4367}
4368
6c446631 4369static void msetGenericCommand(redisClient *c, int nx) {
906573e7 4370 int j, busykeys = 0;
6c446631 4371
4372 if ((c->argc % 2) == 0) {
454d4e43 4373 addReplySds(c,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
6c446631 4374 return;
4375 }
4376 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
4377 * set nothing at all if at least one already key exists. */
4378 if (nx) {
4379 for (j = 1; j < c->argc; j += 2) {
906573e7 4380 if (lookupKeyWrite(c->db,c->argv[j]) != NULL) {
4381 busykeys++;
6c446631 4382 }
4383 }
4384 }
906573e7 4385 if (busykeys) {
4386 addReply(c, shared.czero);
4387 return;
4388 }
6c446631 4389
4390 for (j = 1; j < c->argc; j += 2) {
4391 int retval;
4392
05df7621 4393 c->argv[j+1] = tryObjectEncoding(c->argv[j+1]);
6c446631 4394 retval = dictAdd(c->db->dict,c->argv[j],c->argv[j+1]);
4395 if (retval == DICT_ERR) {
4396 dictReplace(c->db->dict,c->argv[j],c->argv[j+1]);
4397 incrRefCount(c->argv[j+1]);
4398 } else {
4399 incrRefCount(c->argv[j]);
4400 incrRefCount(c->argv[j+1]);
4401 }
4402 removeExpire(c->db,c->argv[j]);
4403 }
4404 server.dirty += (c->argc-1)/2;
4405 addReply(c, nx ? shared.cone : shared.ok);
4406}
4407
4408static void msetCommand(redisClient *c) {
4409 msetGenericCommand(c,0);
4410}
4411
4412static void msetnxCommand(redisClient *c) {
4413 msetGenericCommand(c,1);
4414}
4415
d68ed120 4416static void incrDecrCommand(redisClient *c, long long incr) {
ed9b544e 4417 long long value;
4418 int retval;
4419 robj *o;
e0a62c7f 4420
3305306f 4421 o = lookupKeyWrite(c->db,c->argv[1]);
6485f293
PN
4422 if (o != NULL && checkType(c,o,REDIS_STRING)) return;
4423 if (getLongLongFromObjectOrReply(c,o,&value,NULL) != REDIS_OK) return;
ed9b544e 4424
4425 value += incr;
d6f4c262 4426 o = createStringObjectFromLongLong(value);
3305306f 4427 retval = dictAdd(c->db->dict,c->argv[1],o);
ed9b544e 4428 if (retval == DICT_ERR) {
3305306f 4429 dictReplace(c->db->dict,c->argv[1],o);
4430 removeExpire(c->db,c->argv[1]);
ed9b544e 4431 } else {
4432 incrRefCount(c->argv[1]);
4433 }
4434 server.dirty++;
c937aa89 4435 addReply(c,shared.colon);
ed9b544e 4436 addReply(c,o);
4437 addReply(c,shared.crlf);
4438}
4439
4440static void incrCommand(redisClient *c) {
a4d1ba9a 4441 incrDecrCommand(c,1);
ed9b544e 4442}
4443
4444static void decrCommand(redisClient *c) {
a4d1ba9a 4445 incrDecrCommand(c,-1);
ed9b544e 4446}
4447
4448static void incrbyCommand(redisClient *c) {
bbe025e0
AM
4449 long long incr;
4450
bd79a6bd 4451 if (getLongLongFromObjectOrReply(c, c->argv[2], &incr, NULL) != REDIS_OK) return;
a4d1ba9a 4452 incrDecrCommand(c,incr);
ed9b544e 4453}
4454
4455static void decrbyCommand(redisClient *c) {
bbe025e0
AM
4456 long long incr;
4457
bd79a6bd 4458 if (getLongLongFromObjectOrReply(c, c->argv[2], &incr, NULL) != REDIS_OK) return;
a4d1ba9a 4459 incrDecrCommand(c,-incr);
ed9b544e 4460}
4461
4b00bebd 4462static void appendCommand(redisClient *c) {
4463 int retval;
4464 size_t totlen;
4465 robj *o;
4466
4467 o = lookupKeyWrite(c->db,c->argv[1]);
4468 if (o == NULL) {
4469 /* Create the key */
4470 retval = dictAdd(c->db->dict,c->argv[1],c->argv[2]);
4471 incrRefCount(c->argv[1]);
4472 incrRefCount(c->argv[2]);
4473 totlen = stringObjectLen(c->argv[2]);
4474 } else {
4475 dictEntry *de;
e0a62c7f 4476
4b00bebd 4477 de = dictFind(c->db->dict,c->argv[1]);
4478 assert(de != NULL);
4479
4480 o = dictGetEntryVal(de);
4481 if (o->type != REDIS_STRING) {
4482 addReply(c,shared.wrongtypeerr);
4483 return;
4484 }
4485 /* If the object is specially encoded or shared we have to make
4486 * a copy */
4487 if (o->refcount != 1 || o->encoding != REDIS_ENCODING_RAW) {
4488 robj *decoded = getDecodedObject(o);
4489
4490 o = createStringObject(decoded->ptr, sdslen(decoded->ptr));
4491 decrRefCount(decoded);
4492 dictReplace(c->db->dict,c->argv[1],o);
4493 }
4494 /* APPEND! */
4495 if (c->argv[2]->encoding == REDIS_ENCODING_RAW) {
4496 o->ptr = sdscatlen(o->ptr,
4497 c->argv[2]->ptr, sdslen(c->argv[2]->ptr));
4498 } else {
4499 o->ptr = sdscatprintf(o->ptr, "%ld",
4500 (unsigned long) c->argv[2]->ptr);
4501 }
4502 totlen = sdslen(o->ptr);
4503 }
4504 server.dirty++;
4505 addReplySds(c,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen));
4506}
4507
39191553 4508static void substrCommand(redisClient *c) {
4509 robj *o;
4510 long start = atoi(c->argv[2]->ptr);
4511 long end = atoi(c->argv[3]->ptr);
dd88747b 4512 size_t rangelen, strlen;
4513 sds range;
39191553 4514
dd88747b 4515 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
4516 checkType(c,o,REDIS_STRING)) return;
39191553 4517
dd88747b 4518 o = getDecodedObject(o);
4519 strlen = sdslen(o->ptr);
8fe7fad7 4520
dd88747b 4521 /* convert negative indexes */
4522 if (start < 0) start = strlen+start;
4523 if (end < 0) end = strlen+end;
4524 if (start < 0) start = 0;
4525 if (end < 0) end = 0;
39191553 4526
dd88747b 4527 /* indexes sanity checks */
4528 if (start > end || (size_t)start >= strlen) {
4529 /* Out of range start or start > end result in null reply */
4530 addReply(c,shared.nullbulk);
4531 decrRefCount(o);
4532 return;
39191553 4533 }
dd88747b 4534 if ((size_t)end >= strlen) end = strlen-1;
4535 rangelen = (end-start)+1;
4536
4537 /* Return the result */
4538 addReplySds(c,sdscatprintf(sdsempty(),"$%zu\r\n",rangelen));
4539 range = sdsnewlen((char*)o->ptr+start,rangelen);
4540 addReplySds(c,range);
4541 addReply(c,shared.crlf);
4542 decrRefCount(o);
39191553 4543}
4544
ed9b544e 4545/* ========================= Type agnostic commands ========================= */
4546
4547static void delCommand(redisClient *c) {
5109cdff 4548 int deleted = 0, j;
4549
4550 for (j = 1; j < c->argc; j++) {
4551 if (deleteKey(c->db,c->argv[j])) {
37ab76c9 4552 touchWatchedKey(c->db,c->argv[j]);
5109cdff 4553 server.dirty++;
4554 deleted++;
4555 }
4556 }
482b672d 4557 addReplyLongLong(c,deleted);
ed9b544e 4558}
4559
4560static void existsCommand(redisClient *c) {
f4f06efc
PN
4561 expireIfNeeded(c->db,c->argv[1]);
4562 if (dictFind(c->db->dict,c->argv[1])) {
4563 addReply(c, shared.cone);
4564 } else {
4565 addReply(c, shared.czero);
4566 }
ed9b544e 4567}
4568
4569static void selectCommand(redisClient *c) {
4570 int id = atoi(c->argv[1]->ptr);
e0a62c7f 4571
ed9b544e 4572 if (selectDb(c,id) == REDIS_ERR) {
774e3047 4573 addReplySds(c,sdsnew("-ERR invalid DB index\r\n"));
ed9b544e 4574 } else {
4575 addReply(c,shared.ok);
4576 }
4577}
4578
4579static void randomkeyCommand(redisClient *c) {
4580 dictEntry *de;
dc4be23e 4581 robj *key;
e0a62c7f 4582
3305306f 4583 while(1) {
4584 de = dictGetRandomKey(c->db->dict);
ce7bef07 4585 if (!de || expireIfNeeded(c->db,dictGetEntryKey(de)) == 0) break;
3305306f 4586 }
2b619329 4587
ed9b544e 4588 if (de == NULL) {
dc4be23e 4589 addReply(c,shared.nullbulk);
4590 return;
4591 }
4592
4593 key = dictGetEntryKey(de);
4594 if (server.vm_enabled) {
4595 key = dupStringObject(key);
4596 addReplyBulk(c,key);
4597 decrRefCount(key);
ed9b544e 4598 } else {
dc4be23e 4599 addReplyBulk(c,key);
ed9b544e 4600 }
4601}
4602
4603static void keysCommand(redisClient *c) {
4604 dictIterator *di;
4605 dictEntry *de;
4606 sds pattern = c->argv[1]->ptr;
4607 int plen = sdslen(pattern);
a3f9eec2 4608 unsigned long numkeys = 0;
ed9b544e 4609 robj *lenobj = createObject(REDIS_STRING,NULL);
4610
3305306f 4611 di = dictGetIterator(c->db->dict);
ed9b544e 4612 addReply(c,lenobj);
4613 decrRefCount(lenobj);
4614 while((de = dictNext(di)) != NULL) {
4615 robj *keyobj = dictGetEntryKey(de);
3305306f 4616
ed9b544e 4617 sds key = keyobj->ptr;
4618 if ((pattern[0] == '*' && pattern[1] == '\0') ||
4619 stringmatchlen(pattern,plen,key,sdslen(key),0)) {
3305306f 4620 if (expireIfNeeded(c->db,keyobj) == 0) {
dd88747b 4621 addReplyBulk(c,keyobj);
3305306f 4622 numkeys++;
3305306f 4623 }
ed9b544e 4624 }
4625 }
4626 dictReleaseIterator(di);
a3f9eec2 4627 lenobj->ptr = sdscatprintf(sdsempty(),"*%lu\r\n",numkeys);
ed9b544e 4628}
4629
4630static void dbsizeCommand(redisClient *c) {
4631 addReplySds(c,
3305306f 4632 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c->db->dict)));
ed9b544e 4633}
4634
4635static void lastsaveCommand(redisClient *c) {
4636 addReplySds(c,
c937aa89 4637 sdscatprintf(sdsempty(),":%lu\r\n",server.lastsave));
ed9b544e 4638}
4639
4640static void typeCommand(redisClient *c) {
3305306f 4641 robj *o;
ed9b544e 4642 char *type;
3305306f 4643
4644 o = lookupKeyRead(c->db,c->argv[1]);
4645 if (o == NULL) {
c937aa89 4646 type = "+none";
ed9b544e 4647 } else {
ed9b544e 4648 switch(o->type) {
c937aa89 4649 case REDIS_STRING: type = "+string"; break;
4650 case REDIS_LIST: type = "+list"; break;
4651 case REDIS_SET: type = "+set"; break;
412a8bce 4652 case REDIS_ZSET: type = "+zset"; break;
ada386b2 4653 case REDIS_HASH: type = "+hash"; break;
4654 default: type = "+unknown"; break;
ed9b544e 4655 }
4656 }
4657 addReplySds(c,sdsnew(type));
4658 addReply(c,shared.crlf);
4659}
4660
4661static void saveCommand(redisClient *c) {
9d65a1bb 4662 if (server.bgsavechildpid != -1) {
05557f6d 4663 addReplySds(c,sdsnew("-ERR background save in progress\r\n"));
4664 return;
4665 }
f78fd11b 4666 if (rdbSave(server.dbfilename) == REDIS_OK) {
ed9b544e 4667 addReply(c,shared.ok);
4668 } else {
4669 addReply(c,shared.err);
4670 }
4671}
4672
4673static void bgsaveCommand(redisClient *c) {
9d65a1bb 4674 if (server.bgsavechildpid != -1) {
ed9b544e 4675 addReplySds(c,sdsnew("-ERR background save already in progress\r\n"));
4676 return;
4677 }
f78fd11b 4678 if (rdbSaveBackground(server.dbfilename) == REDIS_OK) {
49b99ab4 4679 char *status = "+Background saving started\r\n";
4680 addReplySds(c,sdsnew(status));
ed9b544e 4681 } else {
4682 addReply(c,shared.err);
4683 }
4684}
4685
4686static void shutdownCommand(redisClient *c) {
fab43727 4687 if (prepareForShutdown() == REDIS_OK)
4688 exit(0);
4689 addReplySds(c, sdsnew("-ERR Errors trying to SHUTDOWN. Check logs.\r\n"));
ed9b544e 4690}
4691
4692static void renameGenericCommand(redisClient *c, int nx) {
ed9b544e 4693 robj *o;
4694
4695 /* To use the same key as src and dst is probably an error */
4696 if (sdscmp(c->argv[1]->ptr,c->argv[2]->ptr) == 0) {
c937aa89 4697 addReply(c,shared.sameobjecterr);
ed9b544e 4698 return;
4699 }
4700
dd88747b 4701 if ((o = lookupKeyWriteOrReply(c,c->argv[1],shared.nokeyerr)) == NULL)
ed9b544e 4702 return;
dd88747b 4703
ed9b544e 4704 incrRefCount(o);
3305306f 4705 deleteIfVolatile(c->db,c->argv[2]);
4706 if (dictAdd(c->db->dict,c->argv[2],o) == DICT_ERR) {
ed9b544e 4707 if (nx) {
4708 decrRefCount(o);
c937aa89 4709 addReply(c,shared.czero);
ed9b544e 4710 return;
4711 }
3305306f 4712 dictReplace(c->db->dict,c->argv[2],o);
ed9b544e 4713 } else {
4714 incrRefCount(c->argv[2]);
4715 }
3305306f 4716 deleteKey(c->db,c->argv[1]);
b167f877 4717 touchWatchedKey(c->db,c->argv[2]);
ed9b544e 4718 server.dirty++;
c937aa89 4719 addReply(c,nx ? shared.cone : shared.ok);
ed9b544e 4720}
4721
4722static void renameCommand(redisClient *c) {
4723 renameGenericCommand(c,0);
4724}
4725
4726static void renamenxCommand(redisClient *c) {
4727 renameGenericCommand(c,1);
4728}
4729
4730static void moveCommand(redisClient *c) {
3305306f 4731 robj *o;
4732 redisDb *src, *dst;
ed9b544e 4733 int srcid;
4734
4735 /* Obtain source and target DB pointers */
3305306f 4736 src = c->db;
4737 srcid = c->db->id;
ed9b544e 4738 if (selectDb(c,atoi(c->argv[2]->ptr)) == REDIS_ERR) {
c937aa89 4739 addReply(c,shared.outofrangeerr);
ed9b544e 4740 return;
4741 }
3305306f 4742 dst = c->db;
4743 selectDb(c,srcid); /* Back to the source DB */
ed9b544e 4744
4745 /* If the user is moving using as target the same
4746 * DB as the source DB it is probably an error. */
4747 if (src == dst) {
c937aa89 4748 addReply(c,shared.sameobjecterr);
ed9b544e 4749 return;
4750 }
4751
4752 /* Check if the element exists and get a reference */
3305306f 4753 o = lookupKeyWrite(c->db,c->argv[1]);
4754 if (!o) {
c937aa89 4755 addReply(c,shared.czero);
ed9b544e 4756 return;
4757 }
4758
4759 /* Try to add the element to the target DB */
3305306f 4760 deleteIfVolatile(dst,c->argv[1]);
4761 if (dictAdd(dst->dict,c->argv[1],o) == DICT_ERR) {
c937aa89 4762 addReply(c,shared.czero);
ed9b544e 4763 return;
4764 }
3305306f 4765 incrRefCount(c->argv[1]);
ed9b544e 4766 incrRefCount(o);
4767
4768 /* OK! key moved, free the entry in the source DB */
3305306f 4769 deleteKey(src,c->argv[1]);
ed9b544e 4770 server.dirty++;
c937aa89 4771 addReply(c,shared.cone);
ed9b544e 4772}
4773
4774/* =================================== Lists ================================ */
c7d9d662
PN
4775static void lPush(robj *subject, robj *value, int where) {
4776 if (subject->encoding == REDIS_ENCODING_ZIPLIST) {
4777 int pos = (where == REDIS_HEAD) ? ZIPLIST_HEAD : ZIPLIST_TAIL;
4778 value = getDecodedObject(value);
4779 subject->ptr = ziplistPush(subject->ptr,value->ptr,sdslen(value->ptr),pos);
4780 decrRefCount(value);
4781 } else if (subject->encoding == REDIS_ENCODING_LIST) {
4782 if (where == REDIS_HEAD) {
4783 listAddNodeHead(subject->ptr,value);
4784 } else {
4785 listAddNodeTail(subject->ptr,value);
4786 }
4787 incrRefCount(value);
4788 } else {
4789 redisPanic("Unknown list encoding");
4790 }
4791}
4792
d72562f7
PN
4793static robj *lPop(robj *subject, int where) {
4794 robj *value = NULL;
4795 if (subject->encoding == REDIS_ENCODING_ZIPLIST) {
4796 unsigned char *p;
4797 char *v;
4798 unsigned int vlen;
4799 long long vval;
4800 int pos = (where == REDIS_HEAD) ? 0 : -1;
4801 p = ziplistIndex(subject->ptr,pos);
4802 if (ziplistGet(p,&v,&vlen,&vval)) {
4803 if (v) {
4804 value = createStringObject(v,vlen);
4805 } else {
4806 value = createStringObjectFromLongLong(vval);
4807 }
4808 }
4809 subject->ptr = ziplistDelete(subject->ptr,&p,ZIPLIST_TAIL);
4810 } else if (subject->encoding == REDIS_ENCODING_LIST) {
4811 list *list = subject->ptr;
4812 listNode *ln;
4813 if (where == REDIS_HEAD) {
4814 ln = listFirst(list);
4815 } else {
4816 ln = listLast(list);
4817 }
4818 if (ln != NULL) {
4819 value = listNodeValue(ln);
4820 incrRefCount(value);
4821 listDelNode(list,ln);
4822 }
4823 } else {
4824 redisPanic("Unknown list encoding");
4825 }
4826 return value;
4827}
4828
4829static unsigned long lLength(robj *subject) {
4830 if (subject->encoding == REDIS_ENCODING_ZIPLIST) {
4831 return ziplistLen(subject->ptr);
4832 } else if (subject->encoding == REDIS_ENCODING_LIST) {
4833 return listLength((list*)subject->ptr);
4834 } else {
4835 redisPanic("Unknown list encoding");
4836 }
4837}
4838
a6dd455b
PN
4839/* Structure to hold set iteration abstraction. */
4840typedef struct {
4841 robj *subject;
4842 unsigned char encoding;
4843 unsigned char *zi;
4844 listNode *ln;
4845} lIterator;
4846
4847/* Initialize an iterator at the specified index. */
4848static lIterator *lInitIterator(robj *subject, int index) {
4849 lIterator *li = zmalloc(sizeof(lIterator));
4850 li->subject = subject;
4851 li->encoding = subject->encoding;
4852 if (li->encoding == REDIS_ENCODING_ZIPLIST) {
4853 li->zi = ziplistIndex(subject->ptr,index);
4854 } else if (li->encoding == REDIS_ENCODING_LIST) {
4855 li->ln = listIndex(subject->ptr,index);
4856 } else {
4857 redisPanic("Unknown list encoding");
4858 }
4859 return li;
4860}
4861
4862/* Clean up the iterator. */
4863static void lReleaseIterator(lIterator *li) {
4864 zfree(li);
4865}
4866
d2ee16ab
PN
4867/* Whether the entry pointed at is a valid entry. */
4868static int lIsEntry(lIterator *li) {
4869 if (li->encoding == REDIS_ENCODING_ZIPLIST) {
4870 return li->zi != NULL;
4871 } else if (li->encoding == REDIS_ENCODING_LIST) {
4872 return li->ln != NULL;
4873 } else {
4874 redisPanic("Unknown list encoding");
4875 }
4876}
4877
a6dd455b
PN
4878/* Return entry or NULL at the current position of the iterator. */
4879static robj *lGet(lIterator *li) {
4880 robj *value = NULL;
4881 if (li->encoding == REDIS_ENCODING_ZIPLIST) {
4882 char *v;
4883 unsigned int vlen;
4884 long long vval;
4885 redisAssert(li->zi != NULL);
4886 if (ziplistGet(li->zi,&v,&vlen,&vval)) {
4887 if (v) {
4888 value = createStringObject(v,vlen);
4889 } else {
4890 value = createStringObjectFromLongLong(vval);
4891 }
4892 }
4893 } else if (li->encoding == REDIS_ENCODING_LIST) {
4894 redisAssert(li->ln != NULL);
4895 value = listNodeValue(li->ln);
4896 incrRefCount(value);
4897 } else {
4898 redisPanic("Unknown list encoding");
4899 }
4900 return value;
4901}
4902
d2ee16ab
PN
4903/* Delete the element pointed to. */
4904static void lDelete(lIterator *li, int direction) {
4905 if (li->encoding == REDIS_ENCODING_ZIPLIST) {
4906 direction = (direction == REDIS_HEAD) ? ZIPLIST_HEAD : ZIPLIST_TAIL;
4907 li->subject->ptr = ziplistDelete(li->subject->ptr,&li->zi,direction);
4908 } else if (li->encoding == REDIS_ENCODING_LIST) {
4909 listNode *next;
4910 if (direction == REDIS_HEAD)
4911 next = li->ln->prev;
4912 else
4913 next = li->ln->next;
4914 listDelNode(li->subject->ptr,li->ln);
4915 li->ln = next;
4916 } else {
4917 redisPanic("Unknown list encoding");
4918 }
4919}
4920
4921/* Compare the given object with the entry at the current position. */
4922static int lEqualTo(lIterator *li, robj *o) {
4923 if (li->encoding == REDIS_ENCODING_ZIPLIST) {
4924 redisAssert(o->encoding == REDIS_ENCODING_RAW);
4925 return ziplistCompare(li->zi,o->ptr,sdslen(o->ptr));
4926 } else if (li->encoding == REDIS_ENCODING_LIST) {
4927 return equalStringObjects(o,listNodeValue(li->ln));
4928 } else {
4929 redisPanic("Unknown list encoding");
4930 }
4931}
4932
a6dd455b
PN
4933/* Move to the next or previous entry in the list. */
4934static void lMove(lIterator *li, int where) {
4935 if (li->encoding == REDIS_ENCODING_ZIPLIST) {
4936 redisAssert(li->zi != NULL);
4937 if (where == REDIS_HEAD)
4938 li->zi = ziplistPrev(li->zi);
4939 else
4940 li->zi = ziplistNext(li->zi);
4941 } else if (li->encoding == REDIS_ENCODING_LIST) {
4942 redisAssert(li->ln != NULL);
4943 if (where == REDIS_HEAD)
4944 li->ln = li->ln->prev;
4945 else
4946 li->ln = li->ln->next;
4947 } else {
4948 redisPanic("Unknown list encoding");
4949 }
4950}
3305306f 4951
c7d9d662
PN
4952static void pushGenericCommand(redisClient *c, int where) {
4953 robj *lobj = lookupKeyWrite(c->db,c->argv[1]);
3305306f 4954 if (lobj == NULL) {
95242ab5 4955 if (handleClientsWaitingListPush(c,c->argv[1],c->argv[2])) {
520b5a33 4956 addReply(c,shared.cone);
95242ab5 4957 return;
4958 }
c7d9d662
PN
4959 lobj = createObject(REDIS_LIST,ziplistNew());
4960 lobj->encoding = REDIS_ENCODING_ZIPLIST;
3305306f 4961 dictAdd(c->db->dict,c->argv[1],lobj);
ed9b544e 4962 incrRefCount(c->argv[1]);
ed9b544e 4963 } else {
ed9b544e 4964 if (lobj->type != REDIS_LIST) {
4965 addReply(c,shared.wrongtypeerr);
4966 return;
4967 }
95242ab5 4968 if (handleClientsWaitingListPush(c,c->argv[1],c->argv[2])) {
520b5a33 4969 addReply(c,shared.cone);
95242ab5 4970 return;
4971 }
ed9b544e 4972 }
c7d9d662
PN
4973 lPush(lobj,c->argv[2],where);
4974 addReplyLongLong(c,lLength(lobj));
ed9b544e 4975 server.dirty++;
ed9b544e 4976}
4977
4978static void lpushCommand(redisClient *c) {
4979 pushGenericCommand(c,REDIS_HEAD);
4980}
4981
4982static void rpushCommand(redisClient *c) {
4983 pushGenericCommand(c,REDIS_TAIL);
4984}
4985
4986static void llenCommand(redisClient *c) {
d72562f7
PN
4987 robj *o = lookupKeyReadOrReply(c,c->argv[1],shared.czero);
4988 if (o == NULL || checkType(c,o,REDIS_LIST)) return;
4989 addReplyUlong(c,lLength(o));
ed9b544e 4990}
4991
4992static void lindexCommand(redisClient *c) {
697bd567
PN
4993 robj *o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk);
4994 if (o == NULL || checkType(c,o,REDIS_LIST)) return;
ed9b544e 4995 int index = atoi(c->argv[2]->ptr);
bd8db0ad 4996 robj *value = NULL;
dd88747b 4997
697bd567
PN
4998 if (o->encoding == REDIS_ENCODING_ZIPLIST) {
4999 unsigned char *p;
5000 char *v;
5001 unsigned int vlen;
5002 long long vval;
5003 p = ziplistIndex(o->ptr,index);
5004 if (ziplistGet(p,&v,&vlen,&vval)) {
5005 if (v) {
bd8db0ad 5006 value = createStringObject(v,vlen);
697bd567 5007 } else {
bd8db0ad 5008 value = createStringObjectFromLongLong(vval);
697bd567 5009 }
bd8db0ad
PN
5010 addReplyBulk(c,value);
5011 decrRefCount(value);
697bd567
PN
5012 } else {
5013 addReply(c,shared.nullbulk);
5014 }
5015 } else if (o->encoding == REDIS_ENCODING_LIST) {
5016 listNode *ln = listIndex(o->ptr,index);
5017 if (ln != NULL) {
bd8db0ad
PN
5018 value = listNodeValue(ln);
5019 addReplyBulk(c,value);
697bd567
PN
5020 } else {
5021 addReply(c,shared.nullbulk);
5022 }
ed9b544e 5023 } else {
697bd567 5024 redisPanic("Unknown list encoding");
ed9b544e 5025 }
5026}
5027
5028static void lsetCommand(redisClient *c) {
697bd567
PN
5029 robj *o = lookupKeyWriteOrReply(c,c->argv[1],shared.nokeyerr);
5030 if (o == NULL || checkType(c,o,REDIS_LIST)) return;
ed9b544e 5031 int index = atoi(c->argv[2]->ptr);
697bd567 5032 robj *value = c->argv[3];
dd88747b 5033
697bd567
PN
5034 if (o->encoding == REDIS_ENCODING_ZIPLIST) {
5035 unsigned char *p, *zl = o->ptr;
5036 p = ziplistIndex(zl,index);
5037 if (p == NULL) {
5038 addReply(c,shared.outofrangeerr);
5039 } else {
5040 o->ptr = ziplistDelete(o->ptr,&p,ZIPLIST_TAIL);
5041 value = getDecodedObject(value);
5042 o->ptr = ziplistInsert(o->ptr,p,value->ptr,sdslen(value->ptr));
5043 decrRefCount(value);
5044 addReply(c,shared.ok);
5045 server.dirty++;
5046 }
5047 } else if (o->encoding == REDIS_ENCODING_LIST) {
5048 listNode *ln = listIndex(o->ptr,index);
5049 if (ln == NULL) {
5050 addReply(c,shared.outofrangeerr);
5051 } else {
5052 decrRefCount((robj*)listNodeValue(ln));
5053 listNodeValue(ln) = value;
5054 incrRefCount(value);
5055 addReply(c,shared.ok);
5056 server.dirty++;
5057 }
ed9b544e 5058 } else {
697bd567 5059 redisPanic("Unknown list encoding");
ed9b544e 5060 }
5061}
5062
5063static void popGenericCommand(redisClient *c, int where) {
d72562f7
PN
5064 robj *o = lookupKeyWriteOrReply(c,c->argv[1],shared.nullbulk);
5065 if (o == NULL || checkType(c,o,REDIS_LIST)) return;
3305306f 5066
d72562f7
PN
5067 robj *value = lPop(o,where);
5068 if (value == NULL) {
dd88747b 5069 addReply(c,shared.nullbulk);
5070 } else {
d72562f7
PN
5071 addReplyBulk(c,value);
5072 decrRefCount(value);
5073 if (lLength(o) == 0) deleteKey(c->db,c->argv[1]);
dd88747b 5074 server.dirty++;
ed9b544e 5075 }
5076}
5077
5078static void lpopCommand(redisClient *c) {
5079 popGenericCommand(c,REDIS_HEAD);
5080}
5081
5082static void rpopCommand(redisClient *c) {
5083 popGenericCommand(c,REDIS_TAIL);
5084}
5085
5086static void lrangeCommand(redisClient *c) {
a6dd455b 5087 robj *o, *value;
ed9b544e 5088 int start = atoi(c->argv[2]->ptr);
5089 int end = atoi(c->argv[3]->ptr);
dd88747b 5090 int llen;
5091 int rangelen, j;
dd88747b 5092
4e27f268 5093 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.emptymultibulk)) == NULL
5094 || checkType(c,o,REDIS_LIST)) return;
a6dd455b 5095 llen = lLength(o);
dd88747b 5096
5097 /* convert negative indexes */
5098 if (start < 0) start = llen+start;
5099 if (end < 0) end = llen+end;
5100 if (start < 0) start = 0;
5101 if (end < 0) end = 0;
5102
5103 /* indexes sanity checks */
5104 if (start > end || start >= llen) {
5105 /* Out of range start or start > end result in empty list */
5106 addReply(c,shared.emptymultibulk);
5107 return;
5108 }
5109 if (end >= llen) end = llen-1;
5110 rangelen = (end-start)+1;
3305306f 5111
dd88747b 5112 /* Return the result in form of a multi-bulk reply */
dd88747b 5113 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",rangelen));
a6dd455b 5114 lIterator *li = lInitIterator(o,start);
dd88747b 5115 for (j = 0; j < rangelen; j++) {
a6dd455b
PN
5116 value = lGet(li);
5117 redisAssert(value != NULL);
5118 addReplyBulk(c,value);
5119 lMove(li,REDIS_TAIL);
ed9b544e 5120 }
a6dd455b 5121 lReleaseIterator(li);
ed9b544e 5122}
5123
5124static void ltrimCommand(redisClient *c) {
3305306f 5125 robj *o;
ed9b544e 5126 int start = atoi(c->argv[2]->ptr);
5127 int end = atoi(c->argv[3]->ptr);
dd88747b 5128 int llen;
5129 int j, ltrim, rtrim;
5130 list *list;
5131 listNode *ln;
5132
5133 if ((o = lookupKeyWriteOrReply(c,c->argv[1],shared.ok)) == NULL ||
5134 checkType(c,o,REDIS_LIST)) return;
9ae6b0be 5135 llen = lLength(o);
dd88747b 5136
5137 /* convert negative indexes */
5138 if (start < 0) start = llen+start;
5139 if (end < 0) end = llen+end;
5140 if (start < 0) start = 0;
5141 if (end < 0) end = 0;
5142
5143 /* indexes sanity checks */
5144 if (start > end || start >= llen) {
5145 /* Out of range start or start > end result in empty list */
5146 ltrim = llen;
5147 rtrim = 0;
ed9b544e 5148 } else {
dd88747b 5149 if (end >= llen) end = llen-1;
5150 ltrim = start;
5151 rtrim = llen-end-1;
5152 }
ed9b544e 5153
dd88747b 5154 /* Remove list elements to perform the trim */
9ae6b0be
PN
5155 if (o->encoding == REDIS_ENCODING_ZIPLIST) {
5156 o->ptr = ziplistDeleteRange(o->ptr,0,ltrim);
5157 o->ptr = ziplistDeleteRange(o->ptr,-rtrim,rtrim);
5158 } else if (o->encoding == REDIS_ENCODING_LIST) {
5159 list = o->ptr;
5160 for (j = 0; j < ltrim; j++) {
5161 ln = listFirst(list);
5162 listDelNode(list,ln);
5163 }
5164 for (j = 0; j < rtrim; j++) {
5165 ln = listLast(list);
5166 listDelNode(list,ln);
5167 }
5168 } else {
5169 redisPanic("Unknown list encoding");
ed9b544e 5170 }
9ae6b0be 5171 if (lLength(o) == 0) deleteKey(c->db,c->argv[1]);
dd88747b 5172 server.dirty++;
5173 addReply(c,shared.ok);
ed9b544e 5174}
5175
5176static void lremCommand(redisClient *c) {
d2ee16ab 5177 robj *subject, *obj = c->argv[3];
dd88747b 5178 int toremove = atoi(c->argv[2]->ptr);
5179 int removed = 0;
d2ee16ab 5180 int direction;
a4d1ba9a 5181
d2ee16ab
PN
5182 subject = lookupKeyWriteOrReply(c,c->argv[1],shared.czero);
5183 if (subject == NULL || checkType(c,subject,REDIS_LIST)) return;
dd88747b 5184
d2ee16ab
PN
5185 /* Make sure obj is raw when we're dealing with a ziplist */
5186 if (subject->encoding == REDIS_ENCODING_ZIPLIST)
5187 obj = getDecodedObject(obj);
5188
5189 lIterator *li;
dd88747b 5190 if (toremove < 0) {
5191 toremove = -toremove;
d2ee16ab
PN
5192 direction = REDIS_HEAD;
5193 li = lInitIterator(subject,-1);
5194 } else {
5195 direction = REDIS_TAIL;
5196 li = lInitIterator(subject,0);
dd88747b 5197 }
dd88747b 5198
3fbf9001 5199 while (lIsEntry(li)) {
d2ee16ab
PN
5200 if (lEqualTo(li,obj)) {
5201 lDelete(li,direction);
dd88747b 5202 server.dirty++;
5203 removed++;
3fbf9001 5204 if (toremove && removed == toremove) break;
d2ee16ab
PN
5205 } else {
5206 lMove(li,direction);
ed9b544e 5207 }
5208 }
d2ee16ab
PN
5209 lReleaseIterator(li);
5210
5211 /* Clean up raw encoded object */
5212 if (subject->encoding == REDIS_ENCODING_ZIPLIST)
5213 decrRefCount(obj);
5214
5215 if (lLength(subject) == 0) deleteKey(c->db,c->argv[1]);
dd88747b 5216 addReplySds(c,sdscatprintf(sdsempty(),":%d\r\n",removed));
ed9b544e 5217}
5218
12f9d551 5219/* This is the semantic of this command:
0f5f7e9a 5220 * RPOPLPUSH srclist dstlist:
12f9d551 5221 * IF LLEN(srclist) > 0
5222 * element = RPOP srclist
5223 * LPUSH dstlist element
5224 * RETURN element
5225 * ELSE
5226 * RETURN nil
5227 * END
5228 * END
5229 *
5230 * The idea is to be able to get an element from a list in a reliable way
5231 * since the element is not just returned but pushed against another list
5232 * as well. This command was originally proposed by Ezra Zygmuntowicz.
5233 */
0f5f7e9a 5234static void rpoplpushcommand(redisClient *c) {
12f9d551 5235 robj *sobj;
dd88747b 5236 list *srclist;
5237 listNode *ln;
5238
5239 if ((sobj = lookupKeyWriteOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
5240 checkType(c,sobj,REDIS_LIST)) return;
5241 srclist = sobj->ptr;
5242 ln = listLast(srclist);
12f9d551 5243
dd88747b 5244 if (ln == NULL) {
12f9d551 5245 addReply(c,shared.nullbulk);
5246 } else {
dd88747b 5247 robj *dobj = lookupKeyWrite(c->db,c->argv[2]);
5248 robj *ele = listNodeValue(ln);
5249 list *dstlist;
e20fb74f 5250
dd88747b 5251 if (dobj && dobj->type != REDIS_LIST) {
5252 addReply(c,shared.wrongtypeerr);
5253 return;
5254 }
12f9d551 5255
dd88747b 5256 /* Add the element to the target list (unless it's directly
5257 * passed to some BLPOP-ing client */
5258 if (!handleClientsWaitingListPush(c,c->argv[2],ele)) {
5259 if (dobj == NULL) {
5260 /* Create the list if the key does not exist */
5261 dobj = createListObject();
5262 dictAdd(c->db->dict,c->argv[2],dobj);
5263 incrRefCount(c->argv[2]);
12f9d551 5264 }
dd88747b 5265 dstlist = dobj->ptr;
5266 listAddNodeHead(dstlist,ele);
5267 incrRefCount(ele);
12f9d551 5268 }
dd88747b 5269
5270 /* Send the element to the client as reply as well */
5271 addReplyBulk(c,ele);
5272
5273 /* Finally remove the element from the source list */
5274 listDelNode(srclist,ln);
3ea27d37 5275 if (listLength(srclist) == 0) deleteKey(c->db,c->argv[1]);
dd88747b 5276 server.dirty++;
12f9d551 5277 }
5278}
5279
ed9b544e 5280/* ==================================== Sets ================================ */
5281
5282static void saddCommand(redisClient *c) {
ed9b544e 5283 robj *set;
5284
3305306f 5285 set = lookupKeyWrite(c->db,c->argv[1]);
5286 if (set == NULL) {
ed9b544e 5287 set = createSetObject();
3305306f 5288 dictAdd(c->db->dict,c->argv[1],set);
ed9b544e 5289 incrRefCount(c->argv[1]);
5290 } else {
ed9b544e 5291 if (set->type != REDIS_SET) {
c937aa89 5292 addReply(c,shared.wrongtypeerr);
ed9b544e 5293 return;
5294 }
5295 }
5296 if (dictAdd(set->ptr,c->argv[2],NULL) == DICT_OK) {
5297 incrRefCount(c->argv[2]);
5298 server.dirty++;
c937aa89 5299 addReply(c,shared.cone);
ed9b544e 5300 } else {
c937aa89 5301 addReply(c,shared.czero);
ed9b544e 5302 }
5303}
5304
5305static void sremCommand(redisClient *c) {
3305306f 5306 robj *set;
ed9b544e 5307
dd88747b 5308 if ((set = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
5309 checkType(c,set,REDIS_SET)) return;
5310
5311 if (dictDelete(set->ptr,c->argv[2]) == DICT_OK) {
5312 server.dirty++;
5313 if (htNeedsResize(set->ptr)) dictResize(set->ptr);
3ea27d37 5314 if (dictSize((dict*)set->ptr) == 0) deleteKey(c->db,c->argv[1]);
dd88747b 5315 addReply(c,shared.cone);
ed9b544e 5316 } else {
dd88747b 5317 addReply(c,shared.czero);
ed9b544e 5318 }
5319}
5320
a4460ef4 5321static void smoveCommand(redisClient *c) {
5322 robj *srcset, *dstset;
5323
5324 srcset = lookupKeyWrite(c->db,c->argv[1]);
5325 dstset = lookupKeyWrite(c->db,c->argv[2]);
5326
5327 /* If the source key does not exist return 0, if it's of the wrong type
5328 * raise an error */
5329 if (srcset == NULL || srcset->type != REDIS_SET) {
5330 addReply(c, srcset ? shared.wrongtypeerr : shared.czero);
5331 return;
5332 }
5333 /* Error if the destination key is not a set as well */
5334 if (dstset && dstset->type != REDIS_SET) {
5335 addReply(c,shared.wrongtypeerr);
5336 return;
5337 }
5338 /* Remove the element from the source set */
5339 if (dictDelete(srcset->ptr,c->argv[3]) == DICT_ERR) {
5340 /* Key not found in the src set! return zero */
5341 addReply(c,shared.czero);
5342 return;
5343 }
3ea27d37 5344 if (dictSize((dict*)srcset->ptr) == 0 && srcset != dstset)
5345 deleteKey(c->db,c->argv[1]);
a4460ef4 5346 server.dirty++;
5347 /* Add the element to the destination set */
5348 if (!dstset) {
5349 dstset = createSetObject();
5350 dictAdd(c->db->dict,c->argv[2],dstset);
5351 incrRefCount(c->argv[2]);
5352 }
5353 if (dictAdd(dstset->ptr,c->argv[3],NULL) == DICT_OK)
5354 incrRefCount(c->argv[3]);
5355 addReply(c,shared.cone);
5356}
5357
ed9b544e 5358static void sismemberCommand(redisClient *c) {
3305306f 5359 robj *set;
ed9b544e 5360
dd88747b 5361 if ((set = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
5362 checkType(c,set,REDIS_SET)) return;
5363
5364 if (dictFind(set->ptr,c->argv[2]))
5365 addReply(c,shared.cone);
5366 else
c937aa89 5367 addReply(c,shared.czero);
ed9b544e 5368}
5369
5370static void scardCommand(redisClient *c) {
3305306f 5371 robj *o;
ed9b544e 5372 dict *s;
dd88747b 5373
5374 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
5375 checkType(c,o,REDIS_SET)) return;
e0a62c7f 5376
dd88747b 5377 s = o->ptr;
5378 addReplyUlong(c,dictSize(s));
ed9b544e 5379}
5380
12fea928 5381static void spopCommand(redisClient *c) {
5382 robj *set;
5383 dictEntry *de;
5384
dd88747b 5385 if ((set = lookupKeyWriteOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
5386 checkType(c,set,REDIS_SET)) return;
5387
5388 de = dictGetRandomKey(set->ptr);
5389 if (de == NULL) {
12fea928 5390 addReply(c,shared.nullbulk);
5391 } else {
dd88747b 5392 robj *ele = dictGetEntryKey(de);
12fea928 5393
dd88747b 5394 addReplyBulk(c,ele);
5395 dictDelete(set->ptr,ele);
5396 if (htNeedsResize(set->ptr)) dictResize(set->ptr);
3ea27d37 5397 if (dictSize((dict*)set->ptr) == 0) deleteKey(c->db,c->argv[1]);
dd88747b 5398 server.dirty++;
12fea928 5399 }
5400}
5401
2abb95a9 5402static void srandmemberCommand(redisClient *c) {
5403 robj *set;
5404 dictEntry *de;
5405
dd88747b 5406 if ((set = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
5407 checkType(c,set,REDIS_SET)) return;
5408
5409 de = dictGetRandomKey(set->ptr);
5410 if (de == NULL) {
2abb95a9 5411 addReply(c,shared.nullbulk);
5412 } else {
dd88747b 5413 robj *ele = dictGetEntryKey(de);
2abb95a9 5414
dd88747b 5415 addReplyBulk(c,ele);
2abb95a9 5416 }
5417}
5418
ed9b544e 5419static int qsortCompareSetsByCardinality(const void *s1, const void *s2) {
5420 dict **d1 = (void*) s1, **d2 = (void*) s2;
5421
3305306f 5422 return dictSize(*d1)-dictSize(*d2);
ed9b544e 5423}
5424
682ac724 5425static void sinterGenericCommand(redisClient *c, robj **setskeys, unsigned long setsnum, robj *dstkey) {
ed9b544e 5426 dict **dv = zmalloc(sizeof(dict*)*setsnum);
5427 dictIterator *di;
5428 dictEntry *de;
5429 robj *lenobj = NULL, *dstset = NULL;
682ac724 5430 unsigned long j, cardinality = 0;
ed9b544e 5431
ed9b544e 5432 for (j = 0; j < setsnum; j++) {
5433 robj *setobj;
3305306f 5434
5435 setobj = dstkey ?
5436 lookupKeyWrite(c->db,setskeys[j]) :
5437 lookupKeyRead(c->db,setskeys[j]);
5438 if (!setobj) {
ed9b544e 5439 zfree(dv);
5faa6025 5440 if (dstkey) {
fdcaae84 5441 if (deleteKey(c->db,dstkey))
5442 server.dirty++;
0d36ded0 5443 addReply(c,shared.czero);
5faa6025 5444 } else {
4e27f268 5445 addReply(c,shared.emptymultibulk);
5faa6025 5446 }
ed9b544e 5447 return;
5448 }
ed9b544e 5449 if (setobj->type != REDIS_SET) {
5450 zfree(dv);
c937aa89 5451 addReply(c,shared.wrongtypeerr);
ed9b544e 5452 return;
5453 }
5454 dv[j] = setobj->ptr;
5455 }
5456 /* Sort sets from the smallest to largest, this will improve our
5457 * algorithm's performace */
5458 qsort(dv,setsnum,sizeof(dict*),qsortCompareSetsByCardinality);
5459
5460 /* The first thing we should output is the total number of elements...
5461 * since this is a multi-bulk write, but at this stage we don't know
5462 * the intersection set size, so we use a trick, append an empty object
5463 * to the output list and save the pointer to later modify it with the
5464 * right length */
5465 if (!dstkey) {
5466 lenobj = createObject(REDIS_STRING,NULL);
5467 addReply(c,lenobj);
5468 decrRefCount(lenobj);
5469 } else {
5470 /* If we have a target key where to store the resulting set
5471 * create this key with an empty set inside */
5472 dstset = createSetObject();
ed9b544e 5473 }
5474
5475 /* Iterate all the elements of the first (smallest) set, and test
5476 * the element against all the other sets, if at least one set does
5477 * not include the element it is discarded */
5478 di = dictGetIterator(dv[0]);
ed9b544e 5479
5480 while((de = dictNext(di)) != NULL) {
5481 robj *ele;
5482
5483 for (j = 1; j < setsnum; j++)
5484 if (dictFind(dv[j],dictGetEntryKey(de)) == NULL) break;
5485 if (j != setsnum)
5486 continue; /* at least one set does not contain the member */
5487 ele = dictGetEntryKey(de);
5488 if (!dstkey) {
dd88747b 5489 addReplyBulk(c,ele);
ed9b544e 5490 cardinality++;
5491 } else {
5492 dictAdd(dstset->ptr,ele,NULL);
5493 incrRefCount(ele);
5494 }
5495 }
5496 dictReleaseIterator(di);
5497
83cdfe18 5498 if (dstkey) {
3ea27d37 5499 /* Store the resulting set into the target, if the intersection
5500 * is not an empty set. */
83cdfe18 5501 deleteKey(c->db,dstkey);
3ea27d37 5502 if (dictSize((dict*)dstset->ptr) > 0) {
5503 dictAdd(c->db->dict,dstkey,dstset);
5504 incrRefCount(dstkey);
482b672d 5505 addReplyLongLong(c,dictSize((dict*)dstset->ptr));
3ea27d37 5506 } else {
5507 decrRefCount(dstset);
d36c4e97 5508 addReply(c,shared.czero);
3ea27d37 5509 }
40d224a9 5510 server.dirty++;
d36c4e97 5511 } else {
5512 lenobj->ptr = sdscatprintf(sdsempty(),"*%lu\r\n",cardinality);
40d224a9 5513 }
ed9b544e 5514 zfree(dv);
5515}
5516
5517static void sinterCommand(redisClient *c) {
5518 sinterGenericCommand(c,c->argv+1,c->argc-1,NULL);
5519}
5520
5521static void sinterstoreCommand(redisClient *c) {
5522 sinterGenericCommand(c,c->argv+2,c->argc-2,c->argv[1]);
5523}
5524
f4f56e1d 5525#define REDIS_OP_UNION 0
5526#define REDIS_OP_DIFF 1
2830ca53 5527#define REDIS_OP_INTER 2
f4f56e1d 5528
5529static void sunionDiffGenericCommand(redisClient *c, robj **setskeys, int setsnum, robj *dstkey, int op) {
40d224a9 5530 dict **dv = zmalloc(sizeof(dict*)*setsnum);
5531 dictIterator *di;
5532 dictEntry *de;
f4f56e1d 5533 robj *dstset = NULL;
40d224a9 5534 int j, cardinality = 0;
5535
40d224a9 5536 for (j = 0; j < setsnum; j++) {
5537 robj *setobj;
5538
5539 setobj = dstkey ?
5540 lookupKeyWrite(c->db,setskeys[j]) :
5541 lookupKeyRead(c->db,setskeys[j]);
5542 if (!setobj) {
5543 dv[j] = NULL;
5544 continue;
5545 }
5546 if (setobj->type != REDIS_SET) {
5547 zfree(dv);
5548 addReply(c,shared.wrongtypeerr);
5549 return;
5550 }
5551 dv[j] = setobj->ptr;
5552 }
5553
5554 /* We need a temp set object to store our union. If the dstkey
5555 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
5556 * this set object will be the resulting object to set into the target key*/
5557 dstset = createSetObject();
5558
40d224a9 5559 /* Iterate all the elements of all the sets, add every element a single
5560 * time to the result set */
5561 for (j = 0; j < setsnum; j++) {
51829ed3 5562 if (op == REDIS_OP_DIFF && j == 0 && !dv[j]) break; /* result set is empty */
40d224a9 5563 if (!dv[j]) continue; /* non existing keys are like empty sets */
5564
5565 di = dictGetIterator(dv[j]);
40d224a9 5566
5567 while((de = dictNext(di)) != NULL) {
5568 robj *ele;
5569
5570 /* dictAdd will not add the same element multiple times */
5571 ele = dictGetEntryKey(de);
f4f56e1d 5572 if (op == REDIS_OP_UNION || j == 0) {
5573 if (dictAdd(dstset->ptr,ele,NULL) == DICT_OK) {
5574 incrRefCount(ele);
40d224a9 5575 cardinality++;
5576 }
f4f56e1d 5577 } else if (op == REDIS_OP_DIFF) {
5578 if (dictDelete(dstset->ptr,ele) == DICT_OK) {
5579 cardinality--;
5580 }
40d224a9 5581 }
5582 }
5583 dictReleaseIterator(di);
51829ed3 5584
d36c4e97 5585 /* result set is empty? Exit asap. */
5586 if (op == REDIS_OP_DIFF && cardinality == 0) break;
40d224a9 5587 }
5588
f4f56e1d 5589 /* Output the content of the resulting set, if not in STORE mode */
5590 if (!dstkey) {
5591 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",cardinality));
5592 di = dictGetIterator(dstset->ptr);
f4f56e1d 5593 while((de = dictNext(di)) != NULL) {
5594 robj *ele;
5595
5596 ele = dictGetEntryKey(de);
dd88747b 5597 addReplyBulk(c,ele);
f4f56e1d 5598 }
5599 dictReleaseIterator(di);
d36c4e97 5600 decrRefCount(dstset);
83cdfe18
AG
5601 } else {
5602 /* If we have a target key where to store the resulting set
5603 * create this key with the result set inside */
5604 deleteKey(c->db,dstkey);
3ea27d37 5605 if (dictSize((dict*)dstset->ptr) > 0) {
5606 dictAdd(c->db->dict,dstkey,dstset);
5607 incrRefCount(dstkey);
482b672d 5608 addReplyLongLong(c,dictSize((dict*)dstset->ptr));
3ea27d37 5609 } else {
5610 decrRefCount(dstset);
d36c4e97 5611 addReply(c,shared.czero);
3ea27d37 5612 }
40d224a9 5613 server.dirty++;
5614 }
5615 zfree(dv);
5616}
5617
5618static void sunionCommand(redisClient *c) {
f4f56e1d 5619 sunionDiffGenericCommand(c,c->argv+1,c->argc-1,NULL,REDIS_OP_UNION);
40d224a9 5620}
5621
5622static void sunionstoreCommand(redisClient *c) {
f4f56e1d 5623 sunionDiffGenericCommand(c,c->argv+2,c->argc-2,c->argv[1],REDIS_OP_UNION);
5624}
5625
5626static void sdiffCommand(redisClient *c) {
5627 sunionDiffGenericCommand(c,c->argv+1,c->argc-1,NULL,REDIS_OP_DIFF);
5628}
5629
5630static void sdiffstoreCommand(redisClient *c) {
5631 sunionDiffGenericCommand(c,c->argv+2,c->argc-2,c->argv[1],REDIS_OP_DIFF);
40d224a9 5632}
5633
6b47e12e 5634/* ==================================== ZSets =============================== */
5635
5636/* ZSETs are ordered sets using two data structures to hold the same elements
5637 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
5638 * data structure.
5639 *
5640 * The elements are added to an hash table mapping Redis objects to scores.
5641 * At the same time the elements are added to a skip list mapping scores
5642 * to Redis objects (so objects are sorted by scores in this "view"). */
5643
5644/* This skiplist implementation is almost a C translation of the original
5645 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
5646 * Alternative to Balanced Trees", modified in three ways:
5647 * a) this implementation allows for repeated values.
5648 * b) the comparison is not just by key (our 'score') but by satellite data.
5649 * c) there is a back pointer, so it's a doubly linked list with the back
5650 * pointers being only at "level 1". This allows to traverse the list
5651 * from tail to head, useful for ZREVRANGE. */
5652
5653static zskiplistNode *zslCreateNode(int level, double score, robj *obj) {
5654 zskiplistNode *zn = zmalloc(sizeof(*zn));
5655
5656 zn->forward = zmalloc(sizeof(zskiplistNode*) * level);
2f4dd7e0 5657 if (level > 1)
2b37892e 5658 zn->span = zmalloc(sizeof(unsigned int) * (level - 1));
2f4dd7e0 5659 else
5660 zn->span = NULL;
6b47e12e 5661 zn->score = score;
5662 zn->obj = obj;
5663 return zn;
5664}
5665
5666static zskiplist *zslCreate(void) {
5667 int j;
5668 zskiplist *zsl;
e0a62c7f 5669
6b47e12e 5670 zsl = zmalloc(sizeof(*zsl));
5671 zsl->level = 1;
cc812361 5672 zsl->length = 0;
6b47e12e 5673 zsl->header = zslCreateNode(ZSKIPLIST_MAXLEVEL,0,NULL);
69d95c3e 5674 for (j = 0; j < ZSKIPLIST_MAXLEVEL; j++) {
6b47e12e 5675 zsl->header->forward[j] = NULL;
94e543b5 5676
5677 /* span has space for ZSKIPLIST_MAXLEVEL-1 elements */
5678 if (j < ZSKIPLIST_MAXLEVEL-1)
5679 zsl->header->span[j] = 0;
69d95c3e 5680 }
e3870fab 5681 zsl->header->backward = NULL;
5682 zsl->tail = NULL;
6b47e12e 5683 return zsl;
5684}
5685
fd8ccf44 5686static void zslFreeNode(zskiplistNode *node) {
5687 decrRefCount(node->obj);
ad807e6f 5688 zfree(node->forward);
69d95c3e 5689 zfree(node->span);
fd8ccf44 5690 zfree(node);
5691}
5692
5693static void zslFree(zskiplist *zsl) {
ad807e6f 5694 zskiplistNode *node = zsl->header->forward[0], *next;
fd8ccf44 5695
ad807e6f 5696 zfree(zsl->header->forward);
69d95c3e 5697 zfree(zsl->header->span);
ad807e6f 5698 zfree(zsl->header);
fd8ccf44 5699 while(node) {
599379dd 5700 next = node->forward[0];
fd8ccf44 5701 zslFreeNode(node);
5702 node = next;
5703 }
ad807e6f 5704 zfree(zsl);
fd8ccf44 5705}
5706
6b47e12e 5707static int zslRandomLevel(void) {
5708 int level = 1;
5709 while ((random()&0xFFFF) < (ZSKIPLIST_P * 0xFFFF))
5710 level += 1;
10c2baa5 5711 return (level<ZSKIPLIST_MAXLEVEL) ? level : ZSKIPLIST_MAXLEVEL;
6b47e12e 5712}
5713
5714static void zslInsert(zskiplist *zsl, double score, robj *obj) {
5715 zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;
2b37892e 5716 unsigned int rank[ZSKIPLIST_MAXLEVEL];
6b47e12e 5717 int i, level;
5718
5719 x = zsl->header;
5720 for (i = zsl->level-1; i >= 0; i--) {
2b37892e
PN
5721 /* store rank that is crossed to reach the insert position */
5722 rank[i] = i == (zsl->level-1) ? 0 : rank[i+1];
69d95c3e 5723
9d60e6e4 5724 while (x->forward[i] &&
5725 (x->forward[i]->score < score ||
5726 (x->forward[i]->score == score &&
69d95c3e 5727 compareStringObjects(x->forward[i]->obj,obj) < 0))) {
a50ea45c 5728 rank[i] += i > 0 ? x->span[i-1] : 1;
6b47e12e 5729 x = x->forward[i];
69d95c3e 5730 }
6b47e12e 5731 update[i] = x;
5732 }
6b47e12e 5733 /* we assume the key is not already inside, since we allow duplicated
5734 * scores, and the re-insertion of score and redis object should never
5735 * happpen since the caller of zslInsert() should test in the hash table
5736 * if the element is already inside or not. */
5737 level = zslRandomLevel();
5738 if (level > zsl->level) {
69d95c3e 5739 for (i = zsl->level; i < level; i++) {
2b37892e 5740 rank[i] = 0;
6b47e12e 5741 update[i] = zsl->header;
2b37892e 5742 update[i]->span[i-1] = zsl->length;
69d95c3e 5743 }
6b47e12e 5744 zsl->level = level;
5745 }
5746 x = zslCreateNode(level,score,obj);
5747 for (i = 0; i < level; i++) {
5748 x->forward[i] = update[i]->forward[i];
5749 update[i]->forward[i] = x;
69d95c3e
PN
5750
5751 /* update span covered by update[i] as x is inserted here */
2b37892e
PN
5752 if (i > 0) {
5753 x->span[i-1] = update[i]->span[i-1] - (rank[0] - rank[i]);
5754 update[i]->span[i-1] = (rank[0] - rank[i]) + 1;
5755 }
6b47e12e 5756 }
69d95c3e
PN
5757
5758 /* increment span for untouched levels */
5759 for (i = level; i < zsl->level; i++) {
2b37892e 5760 update[i]->span[i-1]++;
69d95c3e
PN
5761 }
5762
bb975144 5763 x->backward = (update[0] == zsl->header) ? NULL : update[0];
e3870fab 5764 if (x->forward[0])
5765 x->forward[0]->backward = x;
5766 else
5767 zsl->tail = x;
cc812361 5768 zsl->length++;
6b47e12e 5769}
5770
84105336
PN
5771/* Internal function used by zslDelete, zslDeleteByScore and zslDeleteByRank */
5772void zslDeleteNode(zskiplist *zsl, zskiplistNode *x, zskiplistNode **update) {
5773 int i;
5774 for (i = 0; i < zsl->level; i++) {
5775 if (update[i]->forward[i] == x) {
5776 if (i > 0) {
5777 update[i]->span[i-1] += x->span[i-1] - 1;
5778 }
5779 update[i]->forward[i] = x->forward[i];
5780 } else {
5781 /* invariant: i > 0, because update[0]->forward[0]
5782 * is always equal to x */
5783 update[i]->span[i-1] -= 1;
5784 }
5785 }
5786 if (x->forward[0]) {
5787 x->forward[0]->backward = x->backward;
5788 } else {
5789 zsl->tail = x->backward;
5790 }
5791 while(zsl->level > 1 && zsl->header->forward[zsl->level-1] == NULL)
5792 zsl->level--;
5793 zsl->length--;
5794}
5795
50c55df5 5796/* Delete an element with matching score/object from the skiplist. */
fd8ccf44 5797static int zslDelete(zskiplist *zsl, double score, robj *obj) {
e197b441 5798 zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;
5799 int i;
5800
5801 x = zsl->header;
5802 for (i = zsl->level-1; i >= 0; i--) {
9d60e6e4 5803 while (x->forward[i] &&
5804 (x->forward[i]->score < score ||
5805 (x->forward[i]->score == score &&
5806 compareStringObjects(x->forward[i]->obj,obj) < 0)))
e197b441 5807 x = x->forward[i];
5808 update[i] = x;
5809 }
5810 /* We may have multiple elements with the same score, what we need
5811 * is to find the element with both the right score and object. */
5812 x = x->forward[0];
bf028098 5813 if (x && score == x->score && equalStringObjects(x->obj,obj)) {
84105336 5814 zslDeleteNode(zsl, x, update);
9d60e6e4 5815 zslFreeNode(x);
9d60e6e4 5816 return 1;
5817 } else {
5818 return 0; /* not found */
e197b441 5819 }
5820 return 0; /* not found */
fd8ccf44 5821}
5822
1807985b 5823/* Delete all the elements with score between min and max from the skiplist.
5824 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
5825 * Note that this function takes the reference to the hash table view of the
5826 * sorted set, in order to remove the elements from the hash table too. */
f84d3933 5827static unsigned long zslDeleteRangeByScore(zskiplist *zsl, double min, double max, dict *dict) {
1807985b 5828 zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;
5829 unsigned long removed = 0;
5830 int i;
5831
5832 x = zsl->header;
5833 for (i = zsl->level-1; i >= 0; i--) {
5834 while (x->forward[i] && x->forward[i]->score < min)
5835 x = x->forward[i];
5836 update[i] = x;
5837 }
5838 /* We may have multiple elements with the same score, what we need
5839 * is to find the element with both the right score and object. */
5840 x = x->forward[0];
5841 while (x && x->score <= max) {
84105336
PN
5842 zskiplistNode *next = x->forward[0];
5843 zslDeleteNode(zsl, x, update);
1807985b 5844 dictDelete(dict,x->obj);
5845 zslFreeNode(x);
1807985b 5846 removed++;
5847 x = next;
5848 }
5849 return removed; /* not found */
5850}
1807985b 5851
9212eafd 5852/* Delete all the elements with rank between start and end from the skiplist.
2424490f 5853 * Start and end are inclusive. Note that start and end need to be 1-based */
9212eafd
PN
5854static unsigned long zslDeleteRangeByRank(zskiplist *zsl, unsigned int start, unsigned int end, dict *dict) {
5855 zskiplistNode *update[ZSKIPLIST_MAXLEVEL], *x;
5856 unsigned long traversed = 0, removed = 0;
5857 int i;
5858
9212eafd
PN
5859 x = zsl->header;
5860 for (i = zsl->level-1; i >= 0; i--) {
5861 while (x->forward[i] && (traversed + (i > 0 ? x->span[i-1] : 1)) < start) {
5862 traversed += i > 0 ? x->span[i-1] : 1;
5863 x = x->forward[i];
1807985b 5864 }
9212eafd
PN
5865 update[i] = x;
5866 }
5867
5868 traversed++;
5869 x = x->forward[0];
5870 while (x && traversed <= end) {
84105336
PN
5871 zskiplistNode *next = x->forward[0];
5872 zslDeleteNode(zsl, x, update);
1807985b 5873 dictDelete(dict,x->obj);
5874 zslFreeNode(x);
1807985b 5875 removed++;
9212eafd 5876 traversed++;
1807985b 5877 x = next;
5878 }
9212eafd 5879 return removed;
1807985b 5880}
5881
50c55df5 5882/* Find the first node having a score equal or greater than the specified one.
5883 * Returns NULL if there is no match. */
5884static zskiplistNode *zslFirstWithScore(zskiplist *zsl, double score) {
5885 zskiplistNode *x;
5886 int i;
5887
5888 x = zsl->header;
5889 for (i = zsl->level-1; i >= 0; i--) {
5890 while (x->forward[i] && x->forward[i]->score < score)
5891 x = x->forward[i];
5892 }
5893 /* We may have multiple elements with the same score, what we need
5894 * is to find the element with both the right score and object. */
5895 return x->forward[0];
5896}
5897
27b0ccca
PN
5898/* Find the rank for an element by both score and key.
5899 * Returns 0 when the element cannot be found, rank otherwise.
5900 * Note that the rank is 1-based due to the span of zsl->header to the
5901 * first element. */
5902static unsigned long zslGetRank(zskiplist *zsl, double score, robj *o) {
5903 zskiplistNode *x;
5904 unsigned long rank = 0;
5905 int i;
5906
5907 x = zsl->header;
5908 for (i = zsl->level-1; i >= 0; i--) {
5909 while (x->forward[i] &&
5910 (x->forward[i]->score < score ||
5911 (x->forward[i]->score == score &&
5912 compareStringObjects(x->forward[i]->obj,o) <= 0))) {
a50ea45c 5913 rank += i > 0 ? x->span[i-1] : 1;
27b0ccca
PN
5914 x = x->forward[i];
5915 }
5916
5917 /* x might be equal to zsl->header, so test if obj is non-NULL */
bf028098 5918 if (x->obj && equalStringObjects(x->obj,o)) {
27b0ccca
PN
5919 return rank;
5920 }
5921 }
5922 return 0;
5923}
5924
e74825c2
PN
5925/* Finds an element by its rank. The rank argument needs to be 1-based. */
5926zskiplistNode* zslGetElementByRank(zskiplist *zsl, unsigned long rank) {
5927 zskiplistNode *x;
5928 unsigned long traversed = 0;
5929 int i;
5930
5931 x = zsl->header;
5932 for (i = zsl->level-1; i >= 0; i--) {
dd88747b 5933 while (x->forward[i] && (traversed + (i>0 ? x->span[i-1] : 1)) <= rank)
5934 {
a50ea45c 5935 traversed += i > 0 ? x->span[i-1] : 1;
e74825c2
PN
5936 x = x->forward[i];
5937 }
e74825c2
PN
5938 if (traversed == rank) {
5939 return x;
5940 }
5941 }
5942 return NULL;
5943}
5944
fd8ccf44 5945/* The actual Z-commands implementations */
5946
7db723ad 5947/* This generic command implements both ZADD and ZINCRBY.
e2665397 5948 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
7db723ad 5949 * the increment if the operation is a ZINCRBY (doincrement == 1). */
e2665397 5950static void zaddGenericCommand(redisClient *c, robj *key, robj *ele, double scoreval, int doincrement) {
fd8ccf44 5951 robj *zsetobj;
5952 zset *zs;
5953 double *score;
5954
5fc9229c 5955 if (isnan(scoreval)) {
5956 addReplySds(c,sdsnew("-ERR provide score is Not A Number (nan)\r\n"));
5957 return;
5958 }
5959
e2665397 5960 zsetobj = lookupKeyWrite(c->db,key);
fd8ccf44 5961 if (zsetobj == NULL) {
5962 zsetobj = createZsetObject();
e2665397 5963 dictAdd(c->db->dict,key,zsetobj);
5964 incrRefCount(key);
fd8ccf44 5965 } else {
5966 if (zsetobj->type != REDIS_ZSET) {
5967 addReply(c,shared.wrongtypeerr);
5968 return;
5969 }
5970 }
fd8ccf44 5971 zs = zsetobj->ptr;
e2665397 5972
7db723ad 5973 /* Ok now since we implement both ZADD and ZINCRBY here the code
e2665397 5974 * needs to handle the two different conditions. It's all about setting
5975 * '*score', that is, the new score to set, to the right value. */
5976 score = zmalloc(sizeof(double));
5977 if (doincrement) {
5978 dictEntry *de;
5979
5980 /* Read the old score. If the element was not present starts from 0 */
5981 de = dictFind(zs->dict,ele);
5982 if (de) {
5983 double *oldscore = dictGetEntryVal(de);
5984 *score = *oldscore + scoreval;
5985 } else {
5986 *score = scoreval;
5987 }
5fc9229c 5988 if (isnan(*score)) {
5989 addReplySds(c,
5990 sdsnew("-ERR resulting score is Not A Number (nan)\r\n"));
5991 zfree(score);
5992 /* Note that we don't need to check if the zset may be empty and
5993 * should be removed here, as we can only obtain Nan as score if
5994 * there was already an element in the sorted set. */
5995 return;
5996 }
e2665397 5997 } else {
5998 *score = scoreval;
5999 }
6000
6001 /* What follows is a simple remove and re-insert operation that is common
7db723ad 6002 * to both ZADD and ZINCRBY... */
e2665397 6003 if (dictAdd(zs->dict,ele,score) == DICT_OK) {
fd8ccf44 6004 /* case 1: New element */
e2665397 6005 incrRefCount(ele); /* added to hash */
6006 zslInsert(zs->zsl,*score,ele);
6007 incrRefCount(ele); /* added to skiplist */
fd8ccf44 6008 server.dirty++;
e2665397 6009 if (doincrement)
e2665397 6010 addReplyDouble(c,*score);
91d71bfc 6011 else
6012 addReply(c,shared.cone);
fd8ccf44 6013 } else {
6014 dictEntry *de;
6015 double *oldscore;
e0a62c7f 6016
fd8ccf44 6017 /* case 2: Score update operation */
e2665397 6018 de = dictFind(zs->dict,ele);
dfc5e96c 6019 redisAssert(de != NULL);
fd8ccf44 6020 oldscore = dictGetEntryVal(de);
6021 if (*score != *oldscore) {
6022 int deleted;
6023
e2665397 6024 /* Remove and insert the element in the skip list with new score */
6025 deleted = zslDelete(zs->zsl,*oldscore,ele);
dfc5e96c 6026 redisAssert(deleted != 0);
e2665397 6027 zslInsert(zs->zsl,*score,ele);
6028 incrRefCount(ele);
6029 /* Update the score in the hash table */
6030 dictReplace(zs->dict,ele,score);
fd8ccf44 6031 server.dirty++;
2161a965 6032 } else {
6033 zfree(score);
fd8ccf44 6034 }
e2665397 6035 if (doincrement)
6036 addReplyDouble(c,*score);
6037 else
6038 addReply(c,shared.czero);
fd8ccf44 6039 }
6040}
6041
e2665397 6042static void zaddCommand(redisClient *c) {
6043 double scoreval;
6044
bd79a6bd 6045 if (getDoubleFromObjectOrReply(c, c->argv[2], &scoreval, NULL) != REDIS_OK) return;
e2665397 6046 zaddGenericCommand(c,c->argv[1],c->argv[3],scoreval,0);
6047}
6048
7db723ad 6049static void zincrbyCommand(redisClient *c) {
e2665397 6050 double scoreval;
6051
bd79a6bd 6052 if (getDoubleFromObjectOrReply(c, c->argv[2], &scoreval, NULL) != REDIS_OK) return;
e2665397 6053 zaddGenericCommand(c,c->argv[1],c->argv[3],scoreval,1);
6054}
6055
1b7106e7 6056static void zremCommand(redisClient *c) {
6057 robj *zsetobj;
6058 zset *zs;
dd88747b 6059 dictEntry *de;
6060 double *oldscore;
6061 int deleted;
1b7106e7 6062
dd88747b 6063 if ((zsetobj = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
6064 checkType(c,zsetobj,REDIS_ZSET)) return;
1b7106e7 6065
dd88747b 6066 zs = zsetobj->ptr;
6067 de = dictFind(zs->dict,c->argv[2]);
6068 if (de == NULL) {
6069 addReply(c,shared.czero);
6070 return;
1b7106e7 6071 }
dd88747b 6072 /* Delete from the skiplist */
6073 oldscore = dictGetEntryVal(de);
6074 deleted = zslDelete(zs->zsl,*oldscore,c->argv[2]);
6075 redisAssert(deleted != 0);
6076
6077 /* Delete from the hash table */
6078 dictDelete(zs->dict,c->argv[2]);
6079 if (htNeedsResize(zs->dict)) dictResize(zs->dict);
3ea27d37 6080 if (dictSize(zs->dict) == 0) deleteKey(c->db,c->argv[1]);
dd88747b 6081 server.dirty++;
6082 addReply(c,shared.cone);
1b7106e7 6083}
6084
1807985b 6085static void zremrangebyscoreCommand(redisClient *c) {
bbe025e0
AM
6086 double min;
6087 double max;
dd88747b 6088 long deleted;
1807985b 6089 robj *zsetobj;
6090 zset *zs;
6091
bd79a6bd
PN
6092 if ((getDoubleFromObjectOrReply(c, c->argv[2], &min, NULL) != REDIS_OK) ||
6093 (getDoubleFromObjectOrReply(c, c->argv[3], &max, NULL) != REDIS_OK)) return;
bbe025e0 6094
dd88747b 6095 if ((zsetobj = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
6096 checkType(c,zsetobj,REDIS_ZSET)) return;
1807985b 6097
dd88747b 6098 zs = zsetobj->ptr;
6099 deleted = zslDeleteRangeByScore(zs->zsl,min,max,zs->dict);
6100 if (htNeedsResize(zs->dict)) dictResize(zs->dict);
3ea27d37 6101 if (dictSize(zs->dict) == 0) deleteKey(c->db,c->argv[1]);
dd88747b 6102 server.dirty += deleted;
482b672d 6103 addReplyLongLong(c,deleted);
1807985b 6104}
6105
9212eafd 6106static void zremrangebyrankCommand(redisClient *c) {
bbe025e0
AM
6107 long start;
6108 long end;
dd88747b 6109 int llen;
6110 long deleted;
9212eafd
PN
6111 robj *zsetobj;
6112 zset *zs;
6113
bd79a6bd
PN
6114 if ((getLongFromObjectOrReply(c, c->argv[2], &start, NULL) != REDIS_OK) ||
6115 (getLongFromObjectOrReply(c, c->argv[3], &end, NULL) != REDIS_OK)) return;
bbe025e0 6116
dd88747b 6117 if ((zsetobj = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
6118 checkType(c,zsetobj,REDIS_ZSET)) return;
6119 zs = zsetobj->ptr;
6120 llen = zs->zsl->length;
9212eafd 6121
dd88747b 6122 /* convert negative indexes */
6123 if (start < 0) start = llen+start;
6124 if (end < 0) end = llen+end;
6125 if (start < 0) start = 0;
6126 if (end < 0) end = 0;
9212eafd 6127
dd88747b 6128 /* indexes sanity checks */
6129 if (start > end || start >= llen) {
6130 addReply(c,shared.czero);
6131 return;
9212eafd 6132 }
dd88747b 6133 if (end >= llen) end = llen-1;
6134
6135 /* increment start and end because zsl*Rank functions
6136 * use 1-based rank */
6137 deleted = zslDeleteRangeByRank(zs->zsl,start+1,end+1,zs->dict);
6138 if (htNeedsResize(zs->dict)) dictResize(zs->dict);
3ea27d37 6139 if (dictSize(zs->dict) == 0) deleteKey(c->db,c->argv[1]);
dd88747b 6140 server.dirty += deleted;
482b672d 6141 addReplyLongLong(c, deleted);
9212eafd
PN
6142}
6143
8f92e768
PN
6144typedef struct {
6145 dict *dict;
6146 double weight;
6147} zsetopsrc;
6148
6149static int qsortCompareZsetopsrcByCardinality(const void *s1, const void *s2) {
6150 zsetopsrc *d1 = (void*) s1, *d2 = (void*) s2;
6151 unsigned long size1, size2;
6152 size1 = d1->dict ? dictSize(d1->dict) : 0;
6153 size2 = d2->dict ? dictSize(d2->dict) : 0;
6154 return size1 - size2;
6155}
6156
d2764cd6
PN
6157#define REDIS_AGGR_SUM 1
6158#define REDIS_AGGR_MIN 2
6159#define REDIS_AGGR_MAX 3
bc000c1d 6160#define zunionInterDictValue(_e) (dictGetEntryVal(_e) == NULL ? 1.0 : *(double*)dictGetEntryVal(_e))
d2764cd6
PN
6161
6162inline static void zunionInterAggregate(double *target, double val, int aggregate) {
6163 if (aggregate == REDIS_AGGR_SUM) {
6164 *target = *target + val;
6165 } else if (aggregate == REDIS_AGGR_MIN) {
6166 *target = val < *target ? val : *target;
6167 } else if (aggregate == REDIS_AGGR_MAX) {
6168 *target = val > *target ? val : *target;
6169 } else {
6170 /* safety net */
f83c6cb5 6171 redisPanic("Unknown ZUNION/INTER aggregate type");
d2764cd6
PN
6172 }
6173}
6174
2830ca53 6175static void zunionInterGenericCommand(redisClient *c, robj *dstkey, int op) {
bc000c1d 6176 int i, j, setnum;
d2764cd6 6177 int aggregate = REDIS_AGGR_SUM;
8f92e768 6178 zsetopsrc *src;
2830ca53
PN
6179 robj *dstobj;
6180 zset *dstzset;
b287c9bb
PN
6181 dictIterator *di;
6182 dictEntry *de;
6183
bc000c1d
JC
6184 /* expect setnum input keys to be given */
6185 setnum = atoi(c->argv[2]->ptr);
6186 if (setnum < 1) {
5d373da9 6187 addReplySds(c,sdsnew("-ERR at least 1 input key is needed for ZUNIONSTORE/ZINTERSTORE\r\n"));
2830ca53 6188 return;
b287c9bb 6189 }
2830ca53
PN
6190
6191 /* test if the expected number of keys would overflow */
bc000c1d 6192 if (3+setnum > c->argc) {
b287c9bb
PN
6193 addReply(c,shared.syntaxerr);
6194 return;
6195 }
6196
2830ca53 6197 /* read keys to be used for input */
bc000c1d
JC
6198 src = zmalloc(sizeof(zsetopsrc) * setnum);
6199 for (i = 0, j = 3; i < setnum; i++, j++) {
6200 robj *obj = lookupKeyWrite(c->db,c->argv[j]);
6201 if (!obj) {
8f92e768 6202 src[i].dict = NULL;
b287c9bb 6203 } else {
bc000c1d
JC
6204 if (obj->type == REDIS_ZSET) {
6205 src[i].dict = ((zset*)obj->ptr)->dict;
6206 } else if (obj->type == REDIS_SET) {
6207 src[i].dict = (obj->ptr);
6208 } else {
8f92e768 6209 zfree(src);
b287c9bb
PN
6210 addReply(c,shared.wrongtypeerr);
6211 return;
6212 }
b287c9bb 6213 }
2830ca53
PN
6214
6215 /* default all weights to 1 */
8f92e768 6216 src[i].weight = 1.0;
b287c9bb
PN
6217 }
6218
2830ca53
PN
6219 /* parse optional extra arguments */
6220 if (j < c->argc) {
d2764cd6 6221 int remaining = c->argc - j;
b287c9bb 6222
2830ca53 6223 while (remaining) {
bc000c1d 6224 if (remaining >= (setnum + 1) && !strcasecmp(c->argv[j]->ptr,"weights")) {
2830ca53 6225 j++; remaining--;
bc000c1d 6226 for (i = 0; i < setnum; i++, j++, remaining--) {
bd79a6bd 6227 if (getDoubleFromObjectOrReply(c, c->argv[j], &src[i].weight, NULL) != REDIS_OK)
bbe025e0 6228 return;
2830ca53 6229 }
d2764cd6
PN
6230 } else if (remaining >= 2 && !strcasecmp(c->argv[j]->ptr,"aggregate")) {
6231 j++; remaining--;
6232 if (!strcasecmp(c->argv[j]->ptr,"sum")) {
6233 aggregate = REDIS_AGGR_SUM;
6234 } else if (!strcasecmp(c->argv[j]->ptr,"min")) {
6235 aggregate = REDIS_AGGR_MIN;
6236 } else if (!strcasecmp(c->argv[j]->ptr,"max")) {
6237 aggregate = REDIS_AGGR_MAX;
6238 } else {
6239 zfree(src);
6240 addReply(c,shared.syntaxerr);
6241 return;
6242 }
6243 j++; remaining--;
2830ca53 6244 } else {
8f92e768 6245 zfree(src);
2830ca53
PN
6246 addReply(c,shared.syntaxerr);
6247 return;
6248 }
6249 }
6250 }
b287c9bb 6251
d2764cd6
PN
6252 /* sort sets from the smallest to largest, this will improve our
6253 * algorithm's performance */
bc000c1d 6254 qsort(src,setnum,sizeof(zsetopsrc),qsortCompareZsetopsrcByCardinality);
d2764cd6 6255
2830ca53
PN
6256 dstobj = createZsetObject();
6257 dstzset = dstobj->ptr;
6258
6259 if (op == REDIS_OP_INTER) {
8f92e768
PN
6260 /* skip going over all entries if the smallest zset is NULL or empty */
6261 if (src[0].dict && dictSize(src[0].dict) > 0) {
6262 /* precondition: as src[0].dict is non-empty and the zsets are ordered
6263 * from small to large, all src[i > 0].dict are non-empty too */
6264 di = dictGetIterator(src[0].dict);
2830ca53 6265 while((de = dictNext(di)) != NULL) {
d2764cd6 6266 double *score = zmalloc(sizeof(double)), value;
bc000c1d 6267 *score = src[0].weight * zunionInterDictValue(de);
2830ca53 6268
bc000c1d 6269 for (j = 1; j < setnum; j++) {
d2764cd6 6270 dictEntry *other = dictFind(src[j].dict,dictGetEntryKey(de));
2830ca53 6271 if (other) {
bc000c1d 6272 value = src[j].weight * zunionInterDictValue(other);
d2764cd6 6273 zunionInterAggregate(score, value, aggregate);
2830ca53
PN
6274 } else {
6275 break;
6276 }
6277 }
b287c9bb 6278
2830ca53 6279 /* skip entry when not present in every source dict */
bc000c1d 6280 if (j != setnum) {
2830ca53
PN
6281 zfree(score);
6282 } else {
6283 robj *o = dictGetEntryKey(de);
6284 dictAdd(dstzset->dict,o,score);
6285 incrRefCount(o); /* added to dictionary */
6286 zslInsert(dstzset->zsl,*score,o);
6287 incrRefCount(o); /* added to skiplist */
b287c9bb
PN
6288 }
6289 }
2830ca53
PN
6290 dictReleaseIterator(di);
6291 }
6292 } else if (op == REDIS_OP_UNION) {
bc000c1d 6293 for (i = 0; i < setnum; i++) {
8f92e768 6294 if (!src[i].dict) continue;
2830ca53 6295
8f92e768 6296 di = dictGetIterator(src[i].dict);
2830ca53
PN
6297 while((de = dictNext(di)) != NULL) {
6298 /* skip key when already processed */
6299 if (dictFind(dstzset->dict,dictGetEntryKey(de)) != NULL) continue;
6300
d2764cd6 6301 double *score = zmalloc(sizeof(double)), value;
bc000c1d 6302 *score = src[i].weight * zunionInterDictValue(de);
2830ca53 6303
d2764cd6
PN
6304 /* because the zsets are sorted by size, its only possible
6305 * for sets at larger indices to hold this entry */
bc000c1d 6306 for (j = (i+1); j < setnum; j++) {
d2764cd6 6307 dictEntry *other = dictFind(src[j].dict,dictGetEntryKey(de));
2830ca53 6308 if (other) {
bc000c1d 6309 value = src[j].weight * zunionInterDictValue(other);
d2764cd6 6310 zunionInterAggregate(score, value, aggregate);
2830ca53
PN
6311 }
6312 }
b287c9bb 6313
2830ca53
PN
6314 robj *o = dictGetEntryKey(de);
6315 dictAdd(dstzset->dict,o,score);
6316 incrRefCount(o); /* added to dictionary */
6317 zslInsert(dstzset->zsl,*score,o);
6318 incrRefCount(o); /* added to skiplist */
6319 }
6320 dictReleaseIterator(di);
b287c9bb 6321 }
2830ca53
PN
6322 } else {
6323 /* unknown operator */
6324 redisAssert(op == REDIS_OP_INTER || op == REDIS_OP_UNION);
b287c9bb
PN
6325 }
6326
6327 deleteKey(c->db,dstkey);
3ea27d37 6328 if (dstzset->zsl->length) {
6329 dictAdd(c->db->dict,dstkey,dstobj);
6330 incrRefCount(dstkey);
482b672d 6331 addReplyLongLong(c, dstzset->zsl->length);
3ea27d37 6332 server.dirty++;
6333 } else {
8bca8773 6334 decrRefCount(dstobj);
3ea27d37 6335 addReply(c, shared.czero);
6336 }
8f92e768 6337 zfree(src);
b287c9bb
PN
6338}
6339
5d373da9 6340static void zunionstoreCommand(redisClient *c) {
2830ca53 6341 zunionInterGenericCommand(c,c->argv[1], REDIS_OP_UNION);
b287c9bb
PN
6342}
6343
5d373da9 6344static void zinterstoreCommand(redisClient *c) {
2830ca53 6345 zunionInterGenericCommand(c,c->argv[1], REDIS_OP_INTER);
b287c9bb
PN
6346}
6347
e3870fab 6348static void zrangeGenericCommand(redisClient *c, int reverse) {
cc812361 6349 robj *o;
bbe025e0
AM
6350 long start;
6351 long end;
752da584 6352 int withscores = 0;
dd88747b 6353 int llen;
6354 int rangelen, j;
6355 zset *zsetobj;
6356 zskiplist *zsl;
6357 zskiplistNode *ln;
6358 robj *ele;
752da584 6359
bd79a6bd
PN
6360 if ((getLongFromObjectOrReply(c, c->argv[2], &start, NULL) != REDIS_OK) ||
6361 (getLongFromObjectOrReply(c, c->argv[3], &end, NULL) != REDIS_OK)) return;
bbe025e0 6362
752da584 6363 if (c->argc == 5 && !strcasecmp(c->argv[4]->ptr,"withscores")) {
6364 withscores = 1;
6365 } else if (c->argc >= 5) {
6366 addReply(c,shared.syntaxerr);
6367 return;
6368 }
cc812361 6369
4e27f268 6370 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.emptymultibulk)) == NULL
6371 || checkType(c,o,REDIS_ZSET)) return;
dd88747b 6372 zsetobj = o->ptr;
6373 zsl = zsetobj->zsl;
6374 llen = zsl->length;
cc812361 6375
dd88747b 6376 /* convert negative indexes */
6377 if (start < 0) start = llen+start;
6378 if (end < 0) end = llen+end;
6379 if (start < 0) start = 0;
6380 if (end < 0) end = 0;
cc812361 6381
dd88747b 6382 /* indexes sanity checks */
6383 if (start > end || start >= llen) {
6384 /* Out of range start or start > end result in empty list */
6385 addReply(c,shared.emptymultibulk);
6386 return;
6387 }
6388 if (end >= llen) end = llen-1;
6389 rangelen = (end-start)+1;
cc812361 6390
dd88747b 6391 /* check if starting point is trivial, before searching
6392 * the element in log(N) time */
6393 if (reverse) {
6394 ln = start == 0 ? zsl->tail : zslGetElementByRank(zsl, llen-start);
6395 } else {
6396 ln = start == 0 ?
6397 zsl->header->forward[0] : zslGetElementByRank(zsl, start+1);
6398 }
cc812361 6399
dd88747b 6400 /* Return the result in form of a multi-bulk reply */
6401 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",
6402 withscores ? (rangelen*2) : rangelen));
6403 for (j = 0; j < rangelen; j++) {
6404 ele = ln->obj;
6405 addReplyBulk(c,ele);
6406 if (withscores)
6407 addReplyDouble(c,ln->score);
6408 ln = reverse ? ln->backward : ln->forward[0];
cc812361 6409 }
6410}
6411
e3870fab 6412static void zrangeCommand(redisClient *c) {
6413 zrangeGenericCommand(c,0);
6414}
6415
6416static void zrevrangeCommand(redisClient *c) {
6417 zrangeGenericCommand(c,1);
6418}
6419
f44dd428 6420/* This command implements both ZRANGEBYSCORE and ZCOUNT.
6421 * If justcount is non-zero, just the count is returned. */
6422static void genericZrangebyscoreCommand(redisClient *c, int justcount) {
50c55df5 6423 robj *o;
f44dd428 6424 double min, max;
6425 int minex = 0, maxex = 0; /* are min or max exclusive? */
80181f78 6426 int offset = 0, limit = -1;
0500ef27
SH
6427 int withscores = 0;
6428 int badsyntax = 0;
6429
f44dd428 6430 /* Parse the min-max interval. If one of the values is prefixed
6431 * by the "(" character, it's considered "open". For instance
6432 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
6433 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
6434 if (((char*)c->argv[2]->ptr)[0] == '(') {
6435 min = strtod((char*)c->argv[2]->ptr+1,NULL);
6436 minex = 1;
6437 } else {
6438 min = strtod(c->argv[2]->ptr,NULL);
6439 }
6440 if (((char*)c->argv[3]->ptr)[0] == '(') {
6441 max = strtod((char*)c->argv[3]->ptr+1,NULL);
6442 maxex = 1;
6443 } else {
6444 max = strtod(c->argv[3]->ptr,NULL);
6445 }
6446
6447 /* Parse "WITHSCORES": note that if the command was called with
6448 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
6449 * enter the following paths to parse WITHSCORES and LIMIT. */
0500ef27 6450 if (c->argc == 5 || c->argc == 8) {
3a3978b1 6451 if (strcasecmp(c->argv[c->argc-1]->ptr,"withscores") == 0)
6452 withscores = 1;
6453 else
6454 badsyntax = 1;
0500ef27 6455 }
3a3978b1 6456 if (c->argc != (4 + withscores) && c->argc != (7 + withscores))
0500ef27 6457 badsyntax = 1;
0500ef27 6458 if (badsyntax) {
454d4e43 6459 addReplySds(c,
6460 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
80181f78 6461 return;
0500ef27
SH
6462 }
6463
f44dd428 6464 /* Parse "LIMIT" */
0500ef27 6465 if (c->argc == (7 + withscores) && strcasecmp(c->argv[4]->ptr,"limit")) {
80181f78 6466 addReply(c,shared.syntaxerr);
6467 return;
0500ef27 6468 } else if (c->argc == (7 + withscores)) {
80181f78 6469 offset = atoi(c->argv[5]->ptr);
6470 limit = atoi(c->argv[6]->ptr);
0b13687c 6471 if (offset < 0) offset = 0;
80181f78 6472 }
50c55df5 6473
f44dd428 6474 /* Ok, lookup the key and get the range */
50c55df5 6475 o = lookupKeyRead(c->db,c->argv[1]);
6476 if (o == NULL) {
4e27f268 6477 addReply(c,justcount ? shared.czero : shared.emptymultibulk);
50c55df5 6478 } else {
6479 if (o->type != REDIS_ZSET) {
6480 addReply(c,shared.wrongtypeerr);
6481 } else {
6482 zset *zsetobj = o->ptr;
6483 zskiplist *zsl = zsetobj->zsl;
6484 zskiplistNode *ln;
f44dd428 6485 robj *ele, *lenobj = NULL;
6486 unsigned long rangelen = 0;
50c55df5 6487
f44dd428 6488 /* Get the first node with the score >= min, or with
6489 * score > min if 'minex' is true. */
50c55df5 6490 ln = zslFirstWithScore(zsl,min);
f44dd428 6491 while (minex && ln && ln->score == min) ln = ln->forward[0];
6492
50c55df5 6493 if (ln == NULL) {
6494 /* No element matching the speciifed interval */
f44dd428 6495 addReply(c,justcount ? shared.czero : shared.emptymultibulk);
50c55df5 6496 return;
6497 }
6498
6499 /* We don't know in advance how many matching elements there
6500 * are in the list, so we push this object that will represent
6501 * the multi-bulk length in the output buffer, and will "fix"
6502 * it later */
f44dd428 6503 if (!justcount) {
6504 lenobj = createObject(REDIS_STRING,NULL);
6505 addReply(c,lenobj);
6506 decrRefCount(lenobj);
6507 }
50c55df5 6508
f44dd428 6509 while(ln && (maxex ? (ln->score < max) : (ln->score <= max))) {
80181f78 6510 if (offset) {
6511 offset--;
6512 ln = ln->forward[0];
6513 continue;
6514 }
6515 if (limit == 0) break;
f44dd428 6516 if (!justcount) {
6517 ele = ln->obj;
dd88747b 6518 addReplyBulk(c,ele);
f44dd428 6519 if (withscores)
6520 addReplyDouble(c,ln->score);
6521 }
50c55df5 6522 ln = ln->forward[0];
6523 rangelen++;
80181f78 6524 if (limit > 0) limit--;
50c55df5 6525 }
f44dd428 6526 if (justcount) {
482b672d 6527 addReplyLongLong(c,(long)rangelen);
f44dd428 6528 } else {
6529 lenobj->ptr = sdscatprintf(sdsempty(),"*%lu\r\n",
6530 withscores ? (rangelen*2) : rangelen);
6531 }
50c55df5 6532 }
6533 }
6534}
6535
f44dd428 6536static void zrangebyscoreCommand(redisClient *c) {
6537 genericZrangebyscoreCommand(c,0);
6538}
6539
6540static void zcountCommand(redisClient *c) {
6541 genericZrangebyscoreCommand(c,1);
6542}
6543
3c41331e 6544static void zcardCommand(redisClient *c) {
e197b441 6545 robj *o;
6546 zset *zs;
dd88747b 6547
6548 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
6549 checkType(c,o,REDIS_ZSET)) return;
6550
6551 zs = o->ptr;
6552 addReplyUlong(c,zs->zsl->length);
e197b441 6553}
6554
6e333bbe 6555static void zscoreCommand(redisClient *c) {
6556 robj *o;
6557 zset *zs;
dd88747b 6558 dictEntry *de;
6559
6560 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
6561 checkType(c,o,REDIS_ZSET)) return;
6562
6563 zs = o->ptr;
6564 de = dictFind(zs->dict,c->argv[2]);
6565 if (!de) {
96d8b4ee 6566 addReply(c,shared.nullbulk);
6e333bbe 6567 } else {
dd88747b 6568 double *score = dictGetEntryVal(de);
6e333bbe 6569
dd88747b 6570 addReplyDouble(c,*score);
6e333bbe 6571 }
6572}
6573
798d9e55 6574static void zrankGenericCommand(redisClient *c, int reverse) {
69d95c3e 6575 robj *o;
dd88747b 6576 zset *zs;
6577 zskiplist *zsl;
6578 dictEntry *de;
6579 unsigned long rank;
6580 double *score;
6581
6582 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
6583 checkType(c,o,REDIS_ZSET)) return;
6584
6585 zs = o->ptr;
6586 zsl = zs->zsl;
6587 de = dictFind(zs->dict,c->argv[2]);
6588 if (!de) {
69d95c3e
PN
6589 addReply(c,shared.nullbulk);
6590 return;
6591 }
69d95c3e 6592
dd88747b 6593 score = dictGetEntryVal(de);
6594 rank = zslGetRank(zsl, *score, c->argv[2]);
6595 if (rank) {
6596 if (reverse) {
482b672d 6597 addReplyLongLong(c, zsl->length - rank);
27b0ccca 6598 } else {
482b672d 6599 addReplyLongLong(c, rank-1);
69d95c3e 6600 }
dd88747b 6601 } else {
6602 addReply(c,shared.nullbulk);
978c2c94 6603 }
6604}
6605
798d9e55
PN
6606static void zrankCommand(redisClient *c) {
6607 zrankGenericCommand(c, 0);
6608}
6609
6610static void zrevrankCommand(redisClient *c) {
6611 zrankGenericCommand(c, 1);
6612}
6613
7fb16bac
PN
6614/* ========================= Hashes utility functions ======================= */
6615#define REDIS_HASH_KEY 1
6616#define REDIS_HASH_VALUE 2
978c2c94 6617
7fb16bac
PN
6618/* Check the length of a number of objects to see if we need to convert a
6619 * zipmap to a real hash. Note that we only check string encoded objects
6620 * as their string length can be queried in constant time. */
6621static void hashTryConversion(robj *subject, robj **argv, int start, int end) {
6622 int i;
6623 if (subject->encoding != REDIS_ENCODING_ZIPMAP) return;
978c2c94 6624
7fb16bac
PN
6625 for (i = start; i <= end; i++) {
6626 if (argv[i]->encoding == REDIS_ENCODING_RAW &&
6627 sdslen(argv[i]->ptr) > server.hash_max_zipmap_value)
6628 {
6629 convertToRealHash(subject);
978c2c94 6630 return;
6631 }
6632 }
7fb16bac 6633}
bae2c7ec 6634
97224de7
PN
6635/* Encode given objects in-place when the hash uses a dict. */
6636static void hashTryObjectEncoding(robj *subject, robj **o1, robj **o2) {
6637 if (subject->encoding == REDIS_ENCODING_HT) {
3f973463
PN
6638 if (o1) *o1 = tryObjectEncoding(*o1);
6639 if (o2) *o2 = tryObjectEncoding(*o2);
97224de7
PN
6640 }
6641}
6642
7fb16bac 6643/* Get the value from a hash identified by key. Returns either a string
a3f3af86
PN
6644 * object or NULL if the value cannot be found. The refcount of the object
6645 * is always increased by 1 when the value was found. */
7fb16bac
PN
6646static robj *hashGet(robj *o, robj *key) {
6647 robj *value = NULL;
978c2c94 6648 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
7fb16bac
PN
6649 unsigned char *v;
6650 unsigned int vlen;
6651 key = getDecodedObject(key);
6652 if (zipmapGet(o->ptr,key->ptr,sdslen(key->ptr),&v,&vlen)) {
6653 value = createStringObject((char*)v,vlen);
6654 }
6655 decrRefCount(key);
6656 } else {
6657 dictEntry *de = dictFind(o->ptr,key);
6658 if (de != NULL) {
6659 value = dictGetEntryVal(de);
a3f3af86 6660 incrRefCount(value);
7fb16bac
PN
6661 }
6662 }
6663 return value;
6664}
978c2c94 6665
7fb16bac
PN
6666/* Test if the key exists in the given hash. Returns 1 if the key
6667 * exists and 0 when it doesn't. */
6668static int hashExists(robj *o, robj *key) {
6669 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
6670 key = getDecodedObject(key);
6671 if (zipmapExists(o->ptr,key->ptr,sdslen(key->ptr))) {
6672 decrRefCount(key);
6673 return 1;
6674 }
6675 decrRefCount(key);
6676 } else {
6677 if (dictFind(o->ptr,key) != NULL) {
6678 return 1;
6679 }
6680 }
6681 return 0;
6682}
bae2c7ec 6683
7fb16bac
PN
6684/* Add an element, discard the old if the key already exists.
6685 * Return 0 on insert and 1 on update. */
feb8d7e6 6686static int hashSet(robj *o, robj *key, robj *value) {
7fb16bac
PN
6687 int update = 0;
6688 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
6689 key = getDecodedObject(key);
6690 value = getDecodedObject(value);
6691 o->ptr = zipmapSet(o->ptr,
6692 key->ptr,sdslen(key->ptr),
6693 value->ptr,sdslen(value->ptr), &update);
6694 decrRefCount(key);
6695 decrRefCount(value);
6696
6697 /* Check if the zipmap needs to be upgraded to a real hash table */
6698 if (zipmapLen(o->ptr) > server.hash_max_zipmap_entries)
bae2c7ec 6699 convertToRealHash(o);
978c2c94 6700 } else {
7fb16bac
PN
6701 if (dictReplace(o->ptr,key,value)) {
6702 /* Insert */
6703 incrRefCount(key);
978c2c94 6704 } else {
7fb16bac 6705 /* Update */
978c2c94 6706 update = 1;
6707 }
7fb16bac 6708 incrRefCount(value);
978c2c94 6709 }
7fb16bac 6710 return update;
978c2c94 6711}
6712
7fb16bac
PN
6713/* Delete an element from a hash.
6714 * Return 1 on deleted and 0 on not found. */
6715static int hashDelete(robj *o, robj *key) {
6716 int deleted = 0;
6717 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
6718 key = getDecodedObject(key);
6719 o->ptr = zipmapDel(o->ptr,key->ptr,sdslen(key->ptr), &deleted);
6720 decrRefCount(key);
6721 } else {
6722 deleted = dictDelete((dict*)o->ptr,key) == DICT_OK;
6723 /* Always check if the dictionary needs a resize after a delete. */
6724 if (deleted && htNeedsResize(o->ptr)) dictResize(o->ptr);
d33278d1 6725 }
7fb16bac
PN
6726 return deleted;
6727}
d33278d1 6728
7fb16bac 6729/* Return the number of elements in a hash. */
c811bb38 6730static unsigned long hashLength(robj *o) {
7fb16bac
PN
6731 return (o->encoding == REDIS_ENCODING_ZIPMAP) ?
6732 zipmapLen((unsigned char*)o->ptr) : dictSize((dict*)o->ptr);
6733}
6734
6735/* Structure to hold hash iteration abstration. Note that iteration over
6736 * hashes involves both fields and values. Because it is possible that
6737 * not both are required, store pointers in the iterator to avoid
6738 * unnecessary memory allocation for fields/values. */
6739typedef struct {
6740 int encoding;
6741 unsigned char *zi;
6742 unsigned char *zk, *zv;
6743 unsigned int zklen, zvlen;
6744
6745 dictIterator *di;
6746 dictEntry *de;
6747} hashIterator;
6748
c44d3b56
PN
6749static hashIterator *hashInitIterator(robj *subject) {
6750 hashIterator *hi = zmalloc(sizeof(hashIterator));
7fb16bac
PN
6751 hi->encoding = subject->encoding;
6752 if (hi->encoding == REDIS_ENCODING_ZIPMAP) {
6753 hi->zi = zipmapRewind(subject->ptr);
6754 } else if (hi->encoding == REDIS_ENCODING_HT) {
6755 hi->di = dictGetIterator(subject->ptr);
d33278d1 6756 } else {
7fb16bac 6757 redisAssert(NULL);
d33278d1 6758 }
c44d3b56 6759 return hi;
7fb16bac 6760}
d33278d1 6761
7fb16bac
PN
6762static void hashReleaseIterator(hashIterator *hi) {
6763 if (hi->encoding == REDIS_ENCODING_HT) {
6764 dictReleaseIterator(hi->di);
d33278d1 6765 }
c44d3b56 6766 zfree(hi);
7fb16bac 6767}
d33278d1 6768
7fb16bac
PN
6769/* Move to the next entry in the hash. Return REDIS_OK when the next entry
6770 * could be found and REDIS_ERR when the iterator reaches the end. */
c811bb38 6771static int hashNext(hashIterator *hi) {
7fb16bac
PN
6772 if (hi->encoding == REDIS_ENCODING_ZIPMAP) {
6773 if ((hi->zi = zipmapNext(hi->zi, &hi->zk, &hi->zklen,
6774 &hi->zv, &hi->zvlen)) == NULL) return REDIS_ERR;
6775 } else {
6776 if ((hi->de = dictNext(hi->di)) == NULL) return REDIS_ERR;
6777 }
6778 return REDIS_OK;
6779}
d33278d1 6780
0c390abc 6781/* Get key or value object at current iteration position.
a3f3af86 6782 * This increases the refcount of the field object by 1. */
c811bb38 6783static robj *hashCurrent(hashIterator *hi, int what) {
7fb16bac
PN
6784 robj *o;
6785 if (hi->encoding == REDIS_ENCODING_ZIPMAP) {
6786 if (what & REDIS_HASH_KEY) {
6787 o = createStringObject((char*)hi->zk,hi->zklen);
6788 } else {
6789 o = createStringObject((char*)hi->zv,hi->zvlen);
d33278d1 6790 }
d33278d1 6791 } else {
7fb16bac
PN
6792 if (what & REDIS_HASH_KEY) {
6793 o = dictGetEntryKey(hi->de);
6794 } else {
6795 o = dictGetEntryVal(hi->de);
d33278d1 6796 }
a3f3af86 6797 incrRefCount(o);
d33278d1 6798 }
7fb16bac 6799 return o;
d33278d1
PN
6800}
6801
7fb16bac
PN
6802static robj *hashLookupWriteOrCreate(redisClient *c, robj *key) {
6803 robj *o = lookupKeyWrite(c->db,key);
01426b05
PN
6804 if (o == NULL) {
6805 o = createHashObject();
7fb16bac
PN
6806 dictAdd(c->db->dict,key,o);
6807 incrRefCount(key);
01426b05
PN
6808 } else {
6809 if (o->type != REDIS_HASH) {
6810 addReply(c,shared.wrongtypeerr);
7fb16bac 6811 return NULL;
01426b05
PN
6812 }
6813 }
7fb16bac
PN
6814 return o;
6815}
01426b05 6816
7fb16bac
PN
6817/* ============================= Hash commands ============================== */
6818static void hsetCommand(redisClient *c) {
6e9e463f 6819 int update;
7fb16bac 6820 robj *o;
bbe025e0 6821
7fb16bac
PN
6822 if ((o = hashLookupWriteOrCreate(c,c->argv[1])) == NULL) return;
6823 hashTryConversion(o,c->argv,2,3);
97224de7 6824 hashTryObjectEncoding(o,&c->argv[2], &c->argv[3]);
feb8d7e6 6825 update = hashSet(o,c->argv[2],c->argv[3]);
6e9e463f 6826 addReply(c, update ? shared.czero : shared.cone);
7fb16bac
PN
6827 server.dirty++;
6828}
01426b05 6829
1f1c7695
PN
6830static void hsetnxCommand(redisClient *c) {
6831 robj *o;
6832 if ((o = hashLookupWriteOrCreate(c,c->argv[1])) == NULL) return;
6833 hashTryConversion(o,c->argv,2,3);
6834
6835 if (hashExists(o, c->argv[2])) {
6836 addReply(c, shared.czero);
01426b05 6837 } else {
97224de7 6838 hashTryObjectEncoding(o,&c->argv[2], &c->argv[3]);
feb8d7e6 6839 hashSet(o,c->argv[2],c->argv[3]);
1f1c7695
PN
6840 addReply(c, shared.cone);
6841 server.dirty++;
6842 }
6843}
01426b05 6844
7fb16bac
PN
6845static void hmsetCommand(redisClient *c) {
6846 int i;
6847 robj *o;
01426b05 6848
7fb16bac
PN
6849 if ((c->argc % 2) == 1) {
6850 addReplySds(c,sdsnew("-ERR wrong number of arguments for HMSET\r\n"));
6851 return;
6852 }
01426b05 6853
7fb16bac
PN
6854 if ((o = hashLookupWriteOrCreate(c,c->argv[1])) == NULL) return;
6855 hashTryConversion(o,c->argv,2,c->argc-1);
6856 for (i = 2; i < c->argc; i += 2) {
97224de7 6857 hashTryObjectEncoding(o,&c->argv[i], &c->argv[i+1]);
feb8d7e6 6858 hashSet(o,c->argv[i],c->argv[i+1]);
7fb16bac
PN
6859 }
6860 addReply(c, shared.ok);
edc2f63a 6861 server.dirty++;
7fb16bac
PN
6862}
6863
6864static void hincrbyCommand(redisClient *c) {
6865 long long value, incr;
6866 robj *o, *current, *new;
6867
bd79a6bd 6868 if (getLongLongFromObjectOrReply(c,c->argv[3],&incr,NULL) != REDIS_OK) return;
7fb16bac
PN
6869 if ((o = hashLookupWriteOrCreate(c,c->argv[1])) == NULL) return;
6870 if ((current = hashGet(o,c->argv[2])) != NULL) {
946342c1
PN
6871 if (getLongLongFromObjectOrReply(c,current,&value,
6872 "hash value is not an integer") != REDIS_OK) {
6873 decrRefCount(current);
6874 return;
6875 }
a3f3af86 6876 decrRefCount(current);
7fb16bac
PN
6877 } else {
6878 value = 0;
01426b05
PN
6879 }
6880
7fb16bac 6881 value += incr;
3f973463
PN
6882 new = createStringObjectFromLongLong(value);
6883 hashTryObjectEncoding(o,&c->argv[2],NULL);
feb8d7e6 6884 hashSet(o,c->argv[2],new);
7fb16bac
PN
6885 decrRefCount(new);
6886 addReplyLongLong(c,value);
01426b05 6887 server.dirty++;
01426b05
PN
6888}
6889
978c2c94 6890static void hgetCommand(redisClient *c) {
7fb16bac 6891 robj *o, *value;
dd88747b 6892 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL ||
6893 checkType(c,o,REDIS_HASH)) return;
6894
7fb16bac
PN
6895 if ((value = hashGet(o,c->argv[2])) != NULL) {
6896 addReplyBulk(c,value);
a3f3af86 6897 decrRefCount(value);
dd88747b 6898 } else {
7fb16bac 6899 addReply(c,shared.nullbulk);
69d95c3e 6900 }
69d95c3e
PN
6901}
6902
09aeb579
PN
6903static void hmgetCommand(redisClient *c) {
6904 int i;
7fb16bac
PN
6905 robj *o, *value;
6906 o = lookupKeyRead(c->db,c->argv[1]);
6907 if (o != NULL && o->type != REDIS_HASH) {
6908 addReply(c,shared.wrongtypeerr);
09aeb579
PN
6909 }
6910
7fb16bac
PN
6911 /* Note the check for o != NULL happens inside the loop. This is
6912 * done because objects that cannot be found are considered to be
6913 * an empty hash. The reply should then be a series of NULLs. */
09aeb579 6914 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",c->argc-2));
7fb16bac
PN
6915 for (i = 2; i < c->argc; i++) {
6916 if (o != NULL && (value = hashGet(o,c->argv[i])) != NULL) {
6917 addReplyBulk(c,value);
a3f3af86 6918 decrRefCount(value);
7fb16bac
PN
6919 } else {
6920 addReply(c,shared.nullbulk);
09aeb579
PN
6921 }
6922 }
6923}
6924
07efaf74 6925static void hdelCommand(redisClient *c) {
dd88747b 6926 robj *o;
dd88747b 6927 if ((o = lookupKeyWriteOrReply(c,c->argv[1],shared.czero)) == NULL ||
6928 checkType(c,o,REDIS_HASH)) return;
07efaf74 6929
7fb16bac
PN
6930 if (hashDelete(o,c->argv[2])) {
6931 if (hashLength(o) == 0) deleteKey(c->db,c->argv[1]);
6932 addReply(c,shared.cone);
6933 server.dirty++;
dd88747b 6934 } else {
7fb16bac 6935 addReply(c,shared.czero);
07efaf74 6936 }
6937}
6938
92b27fe9 6939static void hlenCommand(redisClient *c) {
6940 robj *o;
dd88747b 6941 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
92b27fe9 6942 checkType(c,o,REDIS_HASH)) return;
6943
7fb16bac 6944 addReplyUlong(c,hashLength(o));
92b27fe9 6945}
6946
78409a0f 6947static void genericHgetallCommand(redisClient *c, int flags) {
7fb16bac 6948 robj *o, *lenobj, *obj;
78409a0f 6949 unsigned long count = 0;
c44d3b56 6950 hashIterator *hi;
78409a0f 6951
4e27f268 6952 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.emptymultibulk)) == NULL
78409a0f 6953 || checkType(c,o,REDIS_HASH)) return;
6954
6955 lenobj = createObject(REDIS_STRING,NULL);
6956 addReply(c,lenobj);
6957 decrRefCount(lenobj);
6958
c44d3b56
PN
6959 hi = hashInitIterator(o);
6960 while (hashNext(hi) != REDIS_ERR) {
7fb16bac 6961 if (flags & REDIS_HASH_KEY) {
c44d3b56 6962 obj = hashCurrent(hi,REDIS_HASH_KEY);
7fb16bac 6963 addReplyBulk(c,obj);
a3f3af86 6964 decrRefCount(obj);
7fb16bac 6965 count++;
78409a0f 6966 }
7fb16bac 6967 if (flags & REDIS_HASH_VALUE) {
c44d3b56 6968 obj = hashCurrent(hi,REDIS_HASH_VALUE);
7fb16bac 6969 addReplyBulk(c,obj);
a3f3af86 6970 decrRefCount(obj);
7fb16bac 6971 count++;
78409a0f 6972 }
78409a0f 6973 }
c44d3b56 6974 hashReleaseIterator(hi);
7fb16bac 6975
78409a0f 6976 lenobj->ptr = sdscatprintf(sdsempty(),"*%lu\r\n",count);
6977}
6978
6979static void hkeysCommand(redisClient *c) {
7fb16bac 6980 genericHgetallCommand(c,REDIS_HASH_KEY);
78409a0f 6981}
6982
6983static void hvalsCommand(redisClient *c) {
7fb16bac 6984 genericHgetallCommand(c,REDIS_HASH_VALUE);
78409a0f 6985}
6986
6987static void hgetallCommand(redisClient *c) {
7fb16bac 6988 genericHgetallCommand(c,REDIS_HASH_KEY|REDIS_HASH_VALUE);
78409a0f 6989}
6990
a86f14b1 6991static void hexistsCommand(redisClient *c) {
6992 robj *o;
a86f14b1 6993 if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.czero)) == NULL ||
6994 checkType(c,o,REDIS_HASH)) return;
6995
7fb16bac 6996 addReply(c, hashExists(o,c->argv[2]) ? shared.cone : shared.czero);
a86f14b1 6997}
6998
ada386b2 6999static void convertToRealHash(robj *o) {
7000 unsigned char *key, *val, *p, *zm = o->ptr;
7001 unsigned int klen, vlen;
7002 dict *dict = dictCreate(&hashDictType,NULL);
7003
7004 assert(o->type == REDIS_HASH && o->encoding != REDIS_ENCODING_HT);
7005 p = zipmapRewind(zm);
7006 while((p = zipmapNext(p,&key,&klen,&val,&vlen)) != NULL) {
7007 robj *keyobj, *valobj;
7008
7009 keyobj = createStringObject((char*)key,klen);
7010 valobj = createStringObject((char*)val,vlen);
05df7621 7011 keyobj = tryObjectEncoding(keyobj);
7012 valobj = tryObjectEncoding(valobj);
ada386b2 7013 dictAdd(dict,keyobj,valobj);
7014 }
7015 o->encoding = REDIS_ENCODING_HT;
7016 o->ptr = dict;
7017 zfree(zm);
7018}
7019
6b47e12e 7020/* ========================= Non type-specific commands ==================== */
7021
ed9b544e 7022static void flushdbCommand(redisClient *c) {
ca37e9cd 7023 server.dirty += dictSize(c->db->dict);
9b30e1a2 7024 touchWatchedKeysOnFlush(c->db->id);
3305306f 7025 dictEmpty(c->db->dict);
7026 dictEmpty(c->db->expires);
ed9b544e 7027 addReply(c,shared.ok);
ed9b544e 7028}
7029
7030static void flushallCommand(redisClient *c) {
9b30e1a2 7031 touchWatchedKeysOnFlush(-1);
ca37e9cd 7032 server.dirty += emptyDb();
ed9b544e 7033 addReply(c,shared.ok);
500ece7c 7034 if (server.bgsavechildpid != -1) {
7035 kill(server.bgsavechildpid,SIGKILL);
7036 rdbRemoveTempFile(server.bgsavechildpid);
7037 }
f78fd11b 7038 rdbSave(server.dbfilename);
ca37e9cd 7039 server.dirty++;
ed9b544e 7040}
7041
56906eef 7042static redisSortOperation *createSortOperation(int type, robj *pattern) {
ed9b544e 7043 redisSortOperation *so = zmalloc(sizeof(*so));
ed9b544e 7044 so->type = type;
7045 so->pattern = pattern;
7046 return so;
7047}
7048
7049/* Return the value associated to the key with a name obtained
55017f9d
PN
7050 * substituting the first occurence of '*' in 'pattern' with 'subst'.
7051 * The returned object will always have its refcount increased by 1
7052 * when it is non-NULL. */
56906eef 7053static robj *lookupKeyByPattern(redisDb *db, robj *pattern, robj *subst) {
6d7d1370 7054 char *p, *f;
ed9b544e 7055 sds spat, ssub;
6d7d1370
PN
7056 robj keyobj, fieldobj, *o;
7057 int prefixlen, sublen, postfixlen, fieldlen;
ed9b544e 7058 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
7059 struct {
f1017b3f 7060 long len;
7061 long free;
ed9b544e 7062 char buf[REDIS_SORTKEY_MAX+1];
6d7d1370 7063 } keyname, fieldname;
ed9b544e 7064
28173a49 7065 /* If the pattern is "#" return the substitution object itself in order
7066 * to implement the "SORT ... GET #" feature. */
7067 spat = pattern->ptr;
7068 if (spat[0] == '#' && spat[1] == '\0') {
55017f9d 7069 incrRefCount(subst);
28173a49 7070 return subst;
7071 }
7072
7073 /* The substitution object may be specially encoded. If so we create
9d65a1bb 7074 * a decoded object on the fly. Otherwise getDecodedObject will just
7075 * increment the ref count, that we'll decrement later. */
7076 subst = getDecodedObject(subst);
942a3961 7077
ed9b544e 7078 ssub = subst->ptr;
7079 if (sdslen(spat)+sdslen(ssub)-1 > REDIS_SORTKEY_MAX) return NULL;
7080 p = strchr(spat,'*');
ed5a857a 7081 if (!p) {
7082 decrRefCount(subst);
7083 return NULL;
7084 }
ed9b544e 7085
6d7d1370
PN
7086 /* Find out if we're dealing with a hash dereference. */
7087 if ((f = strstr(p+1, "->")) != NULL) {
7088 fieldlen = sdslen(spat)-(f-spat);
7089 /* this also copies \0 character */
7090 memcpy(fieldname.buf,f+2,fieldlen-1);
7091 fieldname.len = fieldlen-2;
7092 } else {
7093 fieldlen = 0;
7094 }
7095
ed9b544e 7096 prefixlen = p-spat;
7097 sublen = sdslen(ssub);
6d7d1370 7098 postfixlen = sdslen(spat)-(prefixlen+1)-fieldlen;
ed9b544e 7099 memcpy(keyname.buf,spat,prefixlen);
7100 memcpy(keyname.buf+prefixlen,ssub,sublen);
7101 memcpy(keyname.buf+prefixlen+sublen,p+1,postfixlen);
7102 keyname.buf[prefixlen+sublen+postfixlen] = '\0';
7103 keyname.len = prefixlen+sublen+postfixlen;
942a3961 7104 decrRefCount(subst);
7105
6d7d1370
PN
7106 /* Lookup substituted key */
7107 initStaticStringObject(keyobj,((char*)&keyname)+(sizeof(long)*2));
7108 o = lookupKeyRead(db,&keyobj);
55017f9d
PN
7109 if (o == NULL) return NULL;
7110
7111 if (fieldlen > 0) {
7112 if (o->type != REDIS_HASH || fieldname.len < 1) return NULL;
6d7d1370 7113
705dad38
PN
7114 /* Retrieve value from hash by the field name. This operation
7115 * already increases the refcount of the returned object. */
6d7d1370
PN
7116 initStaticStringObject(fieldobj,((char*)&fieldname)+(sizeof(long)*2));
7117 o = hashGet(o, &fieldobj);
705dad38 7118 } else {
55017f9d 7119 if (o->type != REDIS_STRING) return NULL;
b6f07345 7120
705dad38
PN
7121 /* Every object that this function returns needs to have its refcount
7122 * increased. sortCommand decreases it again. */
7123 incrRefCount(o);
6d7d1370
PN
7124 }
7125
7126 return o;
ed9b544e 7127}
7128
7129/* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
7130 * the additional parameter is not standard but a BSD-specific we have to
7131 * pass sorting parameters via the global 'server' structure */
7132static int sortCompare(const void *s1, const void *s2) {
7133 const redisSortObject *so1 = s1, *so2 = s2;
7134 int cmp;
7135
7136 if (!server.sort_alpha) {
7137 /* Numeric sorting. Here it's trivial as we precomputed scores */
7138 if (so1->u.score > so2->u.score) {
7139 cmp = 1;
7140 } else if (so1->u.score < so2->u.score) {
7141 cmp = -1;
7142 } else {
7143 cmp = 0;
7144 }
7145 } else {
7146 /* Alphanumeric sorting */
7147 if (server.sort_bypattern) {
7148 if (!so1->u.cmpobj || !so2->u.cmpobj) {
7149 /* At least one compare object is NULL */
7150 if (so1->u.cmpobj == so2->u.cmpobj)
7151 cmp = 0;
7152 else if (so1->u.cmpobj == NULL)
7153 cmp = -1;
7154 else
7155 cmp = 1;
7156 } else {
7157 /* We have both the objects, use strcoll */
7158 cmp = strcoll(so1->u.cmpobj->ptr,so2->u.cmpobj->ptr);
7159 }
7160 } else {
08ee9b57 7161 /* Compare elements directly. */
7162 cmp = compareStringObjects(so1->obj,so2->obj);
ed9b544e 7163 }
7164 }
7165 return server.sort_desc ? -cmp : cmp;
7166}
7167
7168/* The SORT command is the most complex command in Redis. Warning: this code
7169 * is optimized for speed and a bit less for readability */
7170static void sortCommand(redisClient *c) {
ed9b544e 7171 list *operations;
7172 int outputlen = 0;
7173 int desc = 0, alpha = 0;
7174 int limit_start = 0, limit_count = -1, start, end;
7175 int j, dontsort = 0, vectorlen;
7176 int getop = 0; /* GET operation counter */
443c6409 7177 robj *sortval, *sortby = NULL, *storekey = NULL;
ed9b544e 7178 redisSortObject *vector; /* Resulting vector to sort */
7179
7180 /* Lookup the key to sort. It must be of the right types */
3305306f 7181 sortval = lookupKeyRead(c->db,c->argv[1]);
7182 if (sortval == NULL) {
4e27f268 7183 addReply(c,shared.emptymultibulk);
ed9b544e 7184 return;
7185 }
a5eb649b 7186 if (sortval->type != REDIS_SET && sortval->type != REDIS_LIST &&
7187 sortval->type != REDIS_ZSET)
7188 {
c937aa89 7189 addReply(c,shared.wrongtypeerr);
ed9b544e 7190 return;
7191 }
7192
7193 /* Create a list of operations to perform for every sorted element.
7194 * Operations can be GET/DEL/INCR/DECR */
7195 operations = listCreate();
092dac2a 7196 listSetFreeMethod(operations,zfree);
ed9b544e 7197 j = 2;
7198
7199 /* Now we need to protect sortval incrementing its count, in the future
7200 * SORT may have options able to overwrite/delete keys during the sorting
7201 * and the sorted key itself may get destroied */
7202 incrRefCount(sortval);
7203
7204 /* The SORT command has an SQL-alike syntax, parse it */
7205 while(j < c->argc) {
7206 int leftargs = c->argc-j-1;
7207 if (!strcasecmp(c->argv[j]->ptr,"asc")) {
7208 desc = 0;
7209 } else if (!strcasecmp(c->argv[j]->ptr,"desc")) {
7210 desc = 1;
7211 } else if (!strcasecmp(c->argv[j]->ptr,"alpha")) {
7212 alpha = 1;
7213 } else if (!strcasecmp(c->argv[j]->ptr,"limit") && leftargs >= 2) {
7214 limit_start = atoi(c->argv[j+1]->ptr);
7215 limit_count = atoi(c->argv[j+2]->ptr);
7216 j+=2;
443c6409 7217 } else if (!strcasecmp(c->argv[j]->ptr,"store") && leftargs >= 1) {
7218 storekey = c->argv[j+1];
7219 j++;
ed9b544e 7220 } else if (!strcasecmp(c->argv[j]->ptr,"by") && leftargs >= 1) {
7221 sortby = c->argv[j+1];
7222 /* If the BY pattern does not contain '*', i.e. it is constant,
7223 * we don't need to sort nor to lookup the weight keys. */
7224 if (strchr(c->argv[j+1]->ptr,'*') == NULL) dontsort = 1;
7225 j++;
7226 } else if (!strcasecmp(c->argv[j]->ptr,"get") && leftargs >= 1) {
7227 listAddNodeTail(operations,createSortOperation(
7228 REDIS_SORT_GET,c->argv[j+1]));
7229 getop++;
7230 j++;
ed9b544e 7231 } else {
7232 decrRefCount(sortval);
7233 listRelease(operations);
c937aa89 7234 addReply(c,shared.syntaxerr);
ed9b544e 7235 return;
7236 }
7237 j++;
7238 }
7239
7240 /* Load the sorting vector with all the objects to sort */
a5eb649b 7241 switch(sortval->type) {
7242 case REDIS_LIST: vectorlen = listLength((list*)sortval->ptr); break;
7243 case REDIS_SET: vectorlen = dictSize((dict*)sortval->ptr); break;
7244 case REDIS_ZSET: vectorlen = dictSize(((zset*)sortval->ptr)->dict); break;
f83c6cb5 7245 default: vectorlen = 0; redisPanic("Bad SORT type"); /* Avoid GCC warning */
a5eb649b 7246 }
ed9b544e 7247 vector = zmalloc(sizeof(redisSortObject)*vectorlen);
ed9b544e 7248 j = 0;
a5eb649b 7249
ed9b544e 7250 if (sortval->type == REDIS_LIST) {
7251 list *list = sortval->ptr;
6208b3a7 7252 listNode *ln;
c7df85a4 7253 listIter li;
6208b3a7 7254
c7df85a4 7255 listRewind(list,&li);
7256 while((ln = listNext(&li))) {
ed9b544e 7257 robj *ele = ln->value;
7258 vector[j].obj = ele;
7259 vector[j].u.score = 0;
7260 vector[j].u.cmpobj = NULL;
ed9b544e 7261 j++;
7262 }
7263 } else {
a5eb649b 7264 dict *set;
ed9b544e 7265 dictIterator *di;
7266 dictEntry *setele;
7267
a5eb649b 7268 if (sortval->type == REDIS_SET) {
7269 set = sortval->ptr;
7270 } else {
7271 zset *zs = sortval->ptr;
7272 set = zs->dict;
7273 }
7274
ed9b544e 7275 di = dictGetIterator(set);
ed9b544e 7276 while((setele = dictNext(di)) != NULL) {
7277 vector[j].obj = dictGetEntryKey(setele);
7278 vector[j].u.score = 0;
7279 vector[j].u.cmpobj = NULL;
7280 j++;
7281 }
7282 dictReleaseIterator(di);
7283 }
dfc5e96c 7284 redisAssert(j == vectorlen);
ed9b544e 7285
7286 /* Now it's time to load the right scores in the sorting vector */
7287 if (dontsort == 0) {
7288 for (j = 0; j < vectorlen; j++) {
6d7d1370 7289 robj *byval;
ed9b544e 7290 if (sortby) {
6d7d1370 7291 /* lookup value to sort by */
3305306f 7292 byval = lookupKeyByPattern(c->db,sortby,vector[j].obj);
705dad38 7293 if (!byval) continue;
ed9b544e 7294 } else {
6d7d1370
PN
7295 /* use object itself to sort by */
7296 byval = vector[j].obj;
7297 }
7298
7299 if (alpha) {
08ee9b57 7300 if (sortby) vector[j].u.cmpobj = getDecodedObject(byval);
6d7d1370
PN
7301 } else {
7302 if (byval->encoding == REDIS_ENCODING_RAW) {
7303 vector[j].u.score = strtod(byval->ptr,NULL);
16fa22f1 7304 } else if (byval->encoding == REDIS_ENCODING_INT) {
6d7d1370
PN
7305 /* Don't need to decode the object if it's
7306 * integer-encoded (the only encoding supported) so
7307 * far. We can just cast it */
16fa22f1
PN
7308 vector[j].u.score = (long)byval->ptr;
7309 } else {
7310 redisAssert(1 != 1);
942a3961 7311 }
ed9b544e 7312 }
6d7d1370 7313
705dad38
PN
7314 /* when the object was retrieved using lookupKeyByPattern,
7315 * its refcount needs to be decreased. */
7316 if (sortby) {
7317 decrRefCount(byval);
ed9b544e 7318 }
7319 }
7320 }
7321
7322 /* We are ready to sort the vector... perform a bit of sanity check
7323 * on the LIMIT option too. We'll use a partial version of quicksort. */
7324 start = (limit_start < 0) ? 0 : limit_start;
7325 end = (limit_count < 0) ? vectorlen-1 : start+limit_count-1;
7326 if (start >= vectorlen) {
7327 start = vectorlen-1;
7328 end = vectorlen-2;
7329 }
7330 if (end >= vectorlen) end = vectorlen-1;
7331
7332 if (dontsort == 0) {
7333 server.sort_desc = desc;
7334 server.sort_alpha = alpha;
7335 server.sort_bypattern = sortby ? 1 : 0;
5f5b9840 7336 if (sortby && (start != 0 || end != vectorlen-1))
7337 pqsort(vector,vectorlen,sizeof(redisSortObject),sortCompare, start,end);
7338 else
7339 qsort(vector,vectorlen,sizeof(redisSortObject),sortCompare);
ed9b544e 7340 }
7341
7342 /* Send command output to the output buffer, performing the specified
7343 * GET/DEL/INCR/DECR operations if any. */
7344 outputlen = getop ? getop*(end-start+1) : end-start+1;
443c6409 7345 if (storekey == NULL) {
7346 /* STORE option not specified, sent the sorting result to client */
7347 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",outputlen));
7348 for (j = start; j <= end; j++) {
7349 listNode *ln;
c7df85a4 7350 listIter li;
7351
dd88747b 7352 if (!getop) addReplyBulk(c,vector[j].obj);
c7df85a4 7353 listRewind(operations,&li);
7354 while((ln = listNext(&li))) {
443c6409 7355 redisSortOperation *sop = ln->value;
7356 robj *val = lookupKeyByPattern(c->db,sop->pattern,
7357 vector[j].obj);
7358
7359 if (sop->type == REDIS_SORT_GET) {
55017f9d 7360 if (!val) {
443c6409 7361 addReply(c,shared.nullbulk);
7362 } else {
dd88747b 7363 addReplyBulk(c,val);
55017f9d 7364 decrRefCount(val);
443c6409 7365 }
7366 } else {
dfc5e96c 7367 redisAssert(sop->type == REDIS_SORT_GET); /* always fails */
443c6409 7368 }
7369 }
ed9b544e 7370 }
443c6409 7371 } else {
7372 robj *listObject = createListObject();
7373 list *listPtr = (list*) listObject->ptr;
7374
7375 /* STORE option specified, set the sorting result as a List object */
7376 for (j = start; j <= end; j++) {
7377 listNode *ln;
c7df85a4 7378 listIter li;
7379
443c6409 7380 if (!getop) {
7381 listAddNodeTail(listPtr,vector[j].obj);
7382 incrRefCount(vector[j].obj);
7383 }
c7df85a4 7384 listRewind(operations,&li);
7385 while((ln = listNext(&li))) {
443c6409 7386 redisSortOperation *sop = ln->value;
7387 robj *val = lookupKeyByPattern(c->db,sop->pattern,
7388 vector[j].obj);
7389
7390 if (sop->type == REDIS_SORT_GET) {
55017f9d 7391 if (!val) {
443c6409 7392 listAddNodeTail(listPtr,createStringObject("",0));
7393 } else {
55017f9d
PN
7394 /* We should do a incrRefCount on val because it is
7395 * added to the list, but also a decrRefCount because
7396 * it is returned by lookupKeyByPattern. This results
7397 * in doing nothing at all. */
443c6409 7398 listAddNodeTail(listPtr,val);
443c6409 7399 }
ed9b544e 7400 } else {
dfc5e96c 7401 redisAssert(sop->type == REDIS_SORT_GET); /* always fails */
ed9b544e 7402 }
ed9b544e 7403 }
ed9b544e 7404 }
121796f7 7405 if (dictReplace(c->db->dict,storekey,listObject)) {
7406 incrRefCount(storekey);
7407 }
443c6409 7408 /* Note: we add 1 because the DB is dirty anyway since even if the
7409 * SORT result is empty a new key is set and maybe the old content
7410 * replaced. */
7411 server.dirty += 1+outputlen;
7412 addReplySds(c,sdscatprintf(sdsempty(),":%d\r\n",outputlen));
ed9b544e 7413 }
7414
7415 /* Cleanup */
7416 decrRefCount(sortval);
7417 listRelease(operations);
7418 for (j = 0; j < vectorlen; j++) {
16fa22f1 7419 if (alpha && vector[j].u.cmpobj)
ed9b544e 7420 decrRefCount(vector[j].u.cmpobj);
7421 }
7422 zfree(vector);
7423}
7424
ec6c7a1d 7425/* Convert an amount of bytes into a human readable string in the form
7426 * of 100B, 2G, 100M, 4K, and so forth. */
7427static void bytesToHuman(char *s, unsigned long long n) {
7428 double d;
7429
7430 if (n < 1024) {
7431 /* Bytes */
7432 sprintf(s,"%lluB",n);
7433 return;
7434 } else if (n < (1024*1024)) {
7435 d = (double)n/(1024);
7436 sprintf(s,"%.2fK",d);
7437 } else if (n < (1024LL*1024*1024)) {
7438 d = (double)n/(1024*1024);
7439 sprintf(s,"%.2fM",d);
7440 } else if (n < (1024LL*1024*1024*1024)) {
7441 d = (double)n/(1024LL*1024*1024);
b72f6a4b 7442 sprintf(s,"%.2fG",d);
ec6c7a1d 7443 }
7444}
7445
1c85b79f 7446/* Create the string returned by the INFO command. This is decoupled
7447 * by the INFO command itself as we need to report the same information
7448 * on memory corruption problems. */
7449static sds genRedisInfoString(void) {
ed9b544e 7450 sds info;
7451 time_t uptime = time(NULL)-server.stat_starttime;
c3cb078d 7452 int j;
ec6c7a1d 7453 char hmem[64];
55a8298f 7454
b72f6a4b 7455 bytesToHuman(hmem,zmalloc_used_memory());
ed9b544e 7456 info = sdscatprintf(sdsempty(),
7457 "redis_version:%s\r\n"
5436146c
PN
7458 "redis_git_sha1:%s\r\n"
7459 "redis_git_dirty:%d\r\n"
f1017b3f 7460 "arch_bits:%s\r\n"
7a932b74 7461 "multiplexing_api:%s\r\n"
0d7170a4 7462 "process_id:%ld\r\n"
682ac724 7463 "uptime_in_seconds:%ld\r\n"
7464 "uptime_in_days:%ld\r\n"
ed9b544e 7465 "connected_clients:%d\r\n"
7466 "connected_slaves:%d\r\n"
f86a74e9 7467 "blocked_clients:%d\r\n"
5fba9f71 7468 "used_memory:%zu\r\n"
ec6c7a1d 7469 "used_memory_human:%s\r\n"
ed9b544e 7470 "changes_since_last_save:%lld\r\n"
be2bb6b0 7471 "bgsave_in_progress:%d\r\n"
682ac724 7472 "last_save_time:%ld\r\n"
b3fad521 7473 "bgrewriteaof_in_progress:%d\r\n"
ed9b544e 7474 "total_connections_received:%lld\r\n"
7475 "total_commands_processed:%lld\r\n"
2a6a2ed1 7476 "expired_keys:%lld\r\n"
3be2c9d7 7477 "hash_max_zipmap_entries:%zu\r\n"
7478 "hash_max_zipmap_value:%zu\r\n"
ffc6b7f8 7479 "pubsub_channels:%ld\r\n"
7480 "pubsub_patterns:%u\r\n"
7d98e08c 7481 "vm_enabled:%d\r\n"
a0f643ea 7482 "role:%s\r\n"
ed9b544e 7483 ,REDIS_VERSION,
5436146c 7484 REDIS_GIT_SHA1,
274e45e3 7485 strtol(REDIS_GIT_DIRTY,NULL,10) > 0,
f1017b3f 7486 (sizeof(long) == 8) ? "64" : "32",
7a932b74 7487 aeGetApiName(),
0d7170a4 7488 (long) getpid(),
a0f643ea 7489 uptime,
7490 uptime/(3600*24),
ed9b544e 7491 listLength(server.clients)-listLength(server.slaves),
7492 listLength(server.slaves),
d5d55fc3 7493 server.blpop_blocked_clients,
b72f6a4b 7494 zmalloc_used_memory(),
ec6c7a1d 7495 hmem,
ed9b544e 7496 server.dirty,
9d65a1bb 7497 server.bgsavechildpid != -1,
ed9b544e 7498 server.lastsave,
b3fad521 7499 server.bgrewritechildpid != -1,
ed9b544e 7500 server.stat_numconnections,
7501 server.stat_numcommands,
2a6a2ed1 7502 server.stat_expiredkeys,
55a8298f 7503 server.hash_max_zipmap_entries,
7504 server.hash_max_zipmap_value,
ffc6b7f8 7505 dictSize(server.pubsub_channels),
7506 listLength(server.pubsub_patterns),
7d98e08c 7507 server.vm_enabled != 0,
a0f643ea 7508 server.masterhost == NULL ? "master" : "slave"
ed9b544e 7509 );
a0f643ea 7510 if (server.masterhost) {
7511 info = sdscatprintf(info,
7512 "master_host:%s\r\n"
7513 "master_port:%d\r\n"
7514 "master_link_status:%s\r\n"
7515 "master_last_io_seconds_ago:%d\r\n"
7516 ,server.masterhost,
7517 server.masterport,
7518 (server.replstate == REDIS_REPL_CONNECTED) ?
7519 "up" : "down",
f72b934d 7520 server.master ? ((int)(time(NULL)-server.master->lastinteraction)) : -1
a0f643ea 7521 );
7522 }
7d98e08c 7523 if (server.vm_enabled) {
1064ef87 7524 lockThreadedIO();
7d98e08c 7525 info = sdscatprintf(info,
7526 "vm_conf_max_memory:%llu\r\n"
7527 "vm_conf_page_size:%llu\r\n"
7528 "vm_conf_pages:%llu\r\n"
7529 "vm_stats_used_pages:%llu\r\n"
7530 "vm_stats_swapped_objects:%llu\r\n"
7531 "vm_stats_swappin_count:%llu\r\n"
7532 "vm_stats_swappout_count:%llu\r\n"
b9bc0eef 7533 "vm_stats_io_newjobs_len:%lu\r\n"
7534 "vm_stats_io_processing_len:%lu\r\n"
7535 "vm_stats_io_processed_len:%lu\r\n"
25fd2cb2 7536 "vm_stats_io_active_threads:%lu\r\n"
d5d55fc3 7537 "vm_stats_blocked_clients:%lu\r\n"
7d98e08c 7538 ,(unsigned long long) server.vm_max_memory,
7539 (unsigned long long) server.vm_page_size,
7540 (unsigned long long) server.vm_pages,
7541 (unsigned long long) server.vm_stats_used_pages,
7542 (unsigned long long) server.vm_stats_swapped_objects,
7543 (unsigned long long) server.vm_stats_swapins,
b9bc0eef 7544 (unsigned long long) server.vm_stats_swapouts,
7545 (unsigned long) listLength(server.io_newjobs),
7546 (unsigned long) listLength(server.io_processing),
7547 (unsigned long) listLength(server.io_processed),
d5d55fc3 7548 (unsigned long) server.io_active_threads,
7549 (unsigned long) server.vm_blocked_clients
7d98e08c 7550 );
1064ef87 7551 unlockThreadedIO();
7d98e08c 7552 }
c3cb078d 7553 for (j = 0; j < server.dbnum; j++) {
7554 long long keys, vkeys;
7555
7556 keys = dictSize(server.db[j].dict);
7557 vkeys = dictSize(server.db[j].expires);
7558 if (keys || vkeys) {
9d65a1bb 7559 info = sdscatprintf(info, "db%d:keys=%lld,expires=%lld\r\n",
c3cb078d 7560 j, keys, vkeys);
7561 }
7562 }
1c85b79f 7563 return info;
7564}
7565
7566static void infoCommand(redisClient *c) {
7567 sds info = genRedisInfoString();
83c6a618 7568 addReplySds(c,sdscatprintf(sdsempty(),"$%lu\r\n",
7569 (unsigned long)sdslen(info)));
ed9b544e 7570 addReplySds(c,info);
70003d28 7571 addReply(c,shared.crlf);
ed9b544e 7572}
7573
3305306f 7574static void monitorCommand(redisClient *c) {
7575 /* ignore MONITOR if aleady slave or in monitor mode */
7576 if (c->flags & REDIS_SLAVE) return;
7577
7578 c->flags |= (REDIS_SLAVE|REDIS_MONITOR);
7579 c->slaveseldb = 0;
6b47e12e 7580 listAddNodeTail(server.monitors,c);
3305306f 7581 addReply(c,shared.ok);
7582}
7583
7584/* ================================= Expire ================================= */
7585static int removeExpire(redisDb *db, robj *key) {
7586 if (dictDelete(db->expires,key) == DICT_OK) {
7587 return 1;
7588 } else {
7589 return 0;
7590 }
7591}
7592
7593static int setExpire(redisDb *db, robj *key, time_t when) {
7594 if (dictAdd(db->expires,key,(void*)when) == DICT_ERR) {
7595 return 0;
7596 } else {
7597 incrRefCount(key);
7598 return 1;
7599 }
7600}
7601
bb32ede5 7602/* Return the expire time of the specified key, or -1 if no expire
7603 * is associated with this key (i.e. the key is non volatile) */
7604static time_t getExpire(redisDb *db, robj *key) {
7605 dictEntry *de;
7606
7607 /* No expire? return ASAP */
7608 if (dictSize(db->expires) == 0 ||
7609 (de = dictFind(db->expires,key)) == NULL) return -1;
7610
7611 return (time_t) dictGetEntryVal(de);
7612}
7613
3305306f 7614static int expireIfNeeded(redisDb *db, robj *key) {
7615 time_t when;
7616 dictEntry *de;
7617
7618 /* No expire? return ASAP */
7619 if (dictSize(db->expires) == 0 ||
7620 (de = dictFind(db->expires,key)) == NULL) return 0;
7621
7622 /* Lookup the expire */
7623 when = (time_t) dictGetEntryVal(de);
7624 if (time(NULL) <= when) return 0;
7625
7626 /* Delete the key */
7627 dictDelete(db->expires,key);
2a6a2ed1 7628 server.stat_expiredkeys++;
3305306f 7629 return dictDelete(db->dict,key) == DICT_OK;
7630}
7631
7632static int deleteIfVolatile(redisDb *db, robj *key) {
7633 dictEntry *de;
7634
7635 /* No expire? return ASAP */
7636 if (dictSize(db->expires) == 0 ||
7637 (de = dictFind(db->expires,key)) == NULL) return 0;
7638
7639 /* Delete the key */
0c66a471 7640 server.dirty++;
2a6a2ed1 7641 server.stat_expiredkeys++;
3305306f 7642 dictDelete(db->expires,key);
7643 return dictDelete(db->dict,key) == DICT_OK;
7644}
7645
bbe025e0 7646static void expireGenericCommand(redisClient *c, robj *key, robj *param, long offset) {
3305306f 7647 dictEntry *de;
bbe025e0
AM
7648 time_t seconds;
7649
bd79a6bd 7650 if (getLongFromObjectOrReply(c, param, &seconds, NULL) != REDIS_OK) return;
bbe025e0
AM
7651
7652 seconds -= offset;
3305306f 7653
802e8373 7654 de = dictFind(c->db->dict,key);
3305306f 7655 if (de == NULL) {
7656 addReply(c,shared.czero);
7657 return;
7658 }
d4dd6556 7659 if (seconds <= 0) {
43e5ccdf 7660 if (deleteKey(c->db,key)) server.dirty++;
7661 addReply(c, shared.cone);
3305306f 7662 return;
7663 } else {
7664 time_t when = time(NULL)+seconds;
802e8373 7665 if (setExpire(c->db,key,when)) {
3305306f 7666 addReply(c,shared.cone);
77423026 7667 server.dirty++;
7668 } else {
3305306f 7669 addReply(c,shared.czero);
77423026 7670 }
3305306f 7671 return;
7672 }
7673}
7674
802e8373 7675static void expireCommand(redisClient *c) {
bbe025e0 7676 expireGenericCommand(c,c->argv[1],c->argv[2],0);
802e8373 7677}
7678
7679static void expireatCommand(redisClient *c) {
bbe025e0 7680 expireGenericCommand(c,c->argv[1],c->argv[2],time(NULL));
802e8373 7681}
7682
fd88489a 7683static void ttlCommand(redisClient *c) {
7684 time_t expire;
7685 int ttl = -1;
7686
7687 expire = getExpire(c->db,c->argv[1]);
7688 if (expire != -1) {
7689 ttl = (int) (expire-time(NULL));
7690 if (ttl < 0) ttl = -1;
7691 }
7692 addReplySds(c,sdscatprintf(sdsempty(),":%d\r\n",ttl));
7693}
7694
6e469882 7695/* ================================ MULTI/EXEC ============================== */
7696
7697/* Client state initialization for MULTI/EXEC */
7698static void initClientMultiState(redisClient *c) {
7699 c->mstate.commands = NULL;
7700 c->mstate.count = 0;
7701}
7702
7703/* Release all the resources associated with MULTI/EXEC state */
7704static void freeClientMultiState(redisClient *c) {
7705 int j;
7706
7707 for (j = 0; j < c->mstate.count; j++) {
7708 int i;
7709 multiCmd *mc = c->mstate.commands+j;
7710
7711 for (i = 0; i < mc->argc; i++)
7712 decrRefCount(mc->argv[i]);
7713 zfree(mc->argv);
7714 }
7715 zfree(c->mstate.commands);
7716}
7717
7718/* Add a new command into the MULTI commands queue */
7719static void queueMultiCommand(redisClient *c, struct redisCommand *cmd) {
7720 multiCmd *mc;
7721 int j;
7722
7723 c->mstate.commands = zrealloc(c->mstate.commands,
7724 sizeof(multiCmd)*(c->mstate.count+1));
7725 mc = c->mstate.commands+c->mstate.count;
7726 mc->cmd = cmd;
7727 mc->argc = c->argc;
7728 mc->argv = zmalloc(sizeof(robj*)*c->argc);
7729 memcpy(mc->argv,c->argv,sizeof(robj*)*c->argc);
7730 for (j = 0; j < c->argc; j++)
7731 incrRefCount(mc->argv[j]);
7732 c->mstate.count++;
7733}
7734
7735static void multiCommand(redisClient *c) {
6531c94d 7736 if (c->flags & REDIS_MULTI) {
7737 addReplySds(c,sdsnew("-ERR MULTI calls can not be nested\r\n"));
7738 return;
7739 }
6e469882 7740 c->flags |= REDIS_MULTI;
36c548f0 7741 addReply(c,shared.ok);
6e469882 7742}
7743
18b6cb76
DJ
7744static void discardCommand(redisClient *c) {
7745 if (!(c->flags & REDIS_MULTI)) {
7746 addReplySds(c,sdsnew("-ERR DISCARD without MULTI\r\n"));
7747 return;
7748 }
7749
7750 freeClientMultiState(c);
7751 initClientMultiState(c);
7752 c->flags &= (~REDIS_MULTI);
7753 addReply(c,shared.ok);
7754}
7755
66c8853f 7756/* Send a MULTI command to all the slaves and AOF file. Check the execCommand
7757 * implememntation for more information. */
7758static void execCommandReplicateMulti(redisClient *c) {
7759 struct redisCommand *cmd;
7760 robj *multistring = createStringObject("MULTI",5);
7761
7762 cmd = lookupCommand("multi");
7763 if (server.appendonly)
7764 feedAppendOnlyFile(cmd,c->db->id,&multistring,1);
7765 if (listLength(server.slaves))
7766 replicationFeedSlaves(server.slaves,c->db->id,&multistring,1);
7767 decrRefCount(multistring);
7768}
7769
6e469882 7770static void execCommand(redisClient *c) {
7771 int j;
7772 robj **orig_argv;
7773 int orig_argc;
7774
7775 if (!(c->flags & REDIS_MULTI)) {
7776 addReplySds(c,sdsnew("-ERR EXEC without MULTI\r\n"));
7777 return;
7778 }
7779
37ab76c9 7780 /* Check if we need to abort the EXEC if some WATCHed key was touched.
7781 * A failed EXEC will return a multi bulk nil object. */
7782 if (c->flags & REDIS_DIRTY_CAS) {
7783 freeClientMultiState(c);
7784 initClientMultiState(c);
7785 c->flags &= ~(REDIS_MULTI|REDIS_DIRTY_CAS);
7786 unwatchAllKeys(c);
7787 addReply(c,shared.nullmultibulk);
7788 return;
7789 }
7790
66c8853f 7791 /* Replicate a MULTI request now that we are sure the block is executed.
7792 * This way we'll deliver the MULTI/..../EXEC block as a whole and
7793 * both the AOF and the replication link will have the same consistency
7794 * and atomicity guarantees. */
7795 execCommandReplicateMulti(c);
7796
7797 /* Exec all the queued commands */
1ad4d316 7798 unwatchAllKeys(c); /* Unwatch ASAP otherwise we'll waste CPU cycles */
6e469882 7799 orig_argv = c->argv;
7800 orig_argc = c->argc;
7801 addReplySds(c,sdscatprintf(sdsempty(),"*%d\r\n",c->mstate.count));
7802 for (j = 0; j < c->mstate.count; j++) {
7803 c->argc = c->mstate.commands[j].argc;
7804 c->argv = c->mstate.commands[j].argv;
7805 call(c,c->mstate.commands[j].cmd);
7806 }
7807 c->argv = orig_argv;
7808 c->argc = orig_argc;
7809 freeClientMultiState(c);
7810 initClientMultiState(c);
1ad4d316 7811 c->flags &= ~(REDIS_MULTI|REDIS_DIRTY_CAS);
66c8853f 7812 /* Make sure the EXEC command is always replicated / AOF, since we
7813 * always send the MULTI command (we can't know beforehand if the
7814 * next operations will contain at least a modification to the DB). */
7815 server.dirty++;
6e469882 7816}
7817
4409877e 7818/* =========================== Blocking Operations ========================= */
7819
7820/* Currently Redis blocking operations support is limited to list POP ops,
7821 * so the current implementation is not fully generic, but it is also not
7822 * completely specific so it will not require a rewrite to support new
7823 * kind of blocking operations in the future.
7824 *
7825 * Still it's important to note that list blocking operations can be already
7826 * used as a notification mechanism in order to implement other blocking
7827 * operations at application level, so there must be a very strong evidence
7828 * of usefulness and generality before new blocking operations are implemented.
7829 *
7830 * This is how the current blocking POP works, we use BLPOP as example:
7831 * - If the user calls BLPOP and the key exists and contains a non empty list
7832 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
7833 * if there is not to block.
7834 * - If instead BLPOP is called and the key does not exists or the list is
7835 * empty we need to block. In order to do so we remove the notification for
7836 * new data to read in the client socket (so that we'll not serve new
7837 * requests if the blocking request is not served). Also we put the client
37ab76c9 7838 * in a dictionary (db->blocking_keys) mapping keys to a list of clients
4409877e 7839 * blocking for this keys.
7840 * - If a PUSH operation against a key with blocked clients waiting is
7841 * performed, we serve the first in the list: basically instead to push
7842 * the new element inside the list we return it to the (first / oldest)
7843 * blocking client, unblock the client, and remove it form the list.
7844 *
7845 * The above comment and the source code should be enough in order to understand
7846 * the implementation and modify / fix it later.
7847 */
7848
7849/* Set a client in blocking mode for the specified key, with the specified
7850 * timeout */
b177fd30 7851static void blockForKeys(redisClient *c, robj **keys, int numkeys, time_t timeout) {
4409877e 7852 dictEntry *de;
7853 list *l;
b177fd30 7854 int j;
4409877e 7855
37ab76c9 7856 c->blocking_keys = zmalloc(sizeof(robj*)*numkeys);
7857 c->blocking_keys_num = numkeys;
4409877e 7858 c->blockingto = timeout;
b177fd30 7859 for (j = 0; j < numkeys; j++) {
7860 /* Add the key in the client structure, to map clients -> keys */
37ab76c9 7861 c->blocking_keys[j] = keys[j];
b177fd30 7862 incrRefCount(keys[j]);
4409877e 7863
b177fd30 7864 /* And in the other "side", to map keys -> clients */
37ab76c9 7865 de = dictFind(c->db->blocking_keys,keys[j]);
b177fd30 7866 if (de == NULL) {
7867 int retval;
7868
7869 /* For every key we take a list of clients blocked for it */
7870 l = listCreate();
37ab76c9 7871 retval = dictAdd(c->db->blocking_keys,keys[j],l);
b177fd30 7872 incrRefCount(keys[j]);
7873 assert(retval == DICT_OK);
7874 } else {
7875 l = dictGetEntryVal(de);
7876 }
7877 listAddNodeTail(l,c);
4409877e 7878 }
b177fd30 7879 /* Mark the client as a blocked client */
4409877e 7880 c->flags |= REDIS_BLOCKED;
d5d55fc3 7881 server.blpop_blocked_clients++;
4409877e 7882}
7883
7884/* Unblock a client that's waiting in a blocking operation such as BLPOP */
b0d8747d 7885static void unblockClientWaitingData(redisClient *c) {
4409877e 7886 dictEntry *de;
7887 list *l;
b177fd30 7888 int j;
4409877e 7889
37ab76c9 7890 assert(c->blocking_keys != NULL);
b177fd30 7891 /* The client may wait for multiple keys, so unblock it for every key. */
37ab76c9 7892 for (j = 0; j < c->blocking_keys_num; j++) {
b177fd30 7893 /* Remove this client from the list of clients waiting for this key. */
37ab76c9 7894 de = dictFind(c->db->blocking_keys,c->blocking_keys[j]);
b177fd30 7895 assert(de != NULL);
7896 l = dictGetEntryVal(de);
7897 listDelNode(l,listSearchKey(l,c));
7898 /* If the list is empty we need to remove it to avoid wasting memory */
7899 if (listLength(l) == 0)
37ab76c9 7900 dictDelete(c->db->blocking_keys,c->blocking_keys[j]);
7901 decrRefCount(c->blocking_keys[j]);
b177fd30 7902 }
7903 /* Cleanup the client structure */
37ab76c9 7904 zfree(c->blocking_keys);
7905 c->blocking_keys = NULL;
4409877e 7906 c->flags &= (~REDIS_BLOCKED);
d5d55fc3 7907 server.blpop_blocked_clients--;
5921aa36 7908 /* We want to process data if there is some command waiting
b0d8747d 7909 * in the input buffer. Note that this is safe even if
7910 * unblockClientWaitingData() gets called from freeClient() because
7911 * freeClient() will be smart enough to call this function
7912 * *after* c->querybuf was set to NULL. */
4409877e 7913 if (c->querybuf && sdslen(c->querybuf) > 0) processInputBuffer(c);
7914}
7915
7916/* This should be called from any function PUSHing into lists.
7917 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
7918 * 'ele' is the element pushed.
7919 *
7920 * If the function returns 0 there was no client waiting for a list push
7921 * against this key.
7922 *
7923 * If the function returns 1 there was a client waiting for a list push
7924 * against this key, the element was passed to this client thus it's not
7925 * needed to actually add it to the list and the caller should return asap. */
7926static int handleClientsWaitingListPush(redisClient *c, robj *key, robj *ele) {
7927 struct dictEntry *de;
7928 redisClient *receiver;
7929 list *l;
7930 listNode *ln;
7931
37ab76c9 7932 de = dictFind(c->db->blocking_keys,key);
4409877e 7933 if (de == NULL) return 0;
7934 l = dictGetEntryVal(de);
7935 ln = listFirst(l);
7936 assert(ln != NULL);
7937 receiver = ln->value;
4409877e 7938
b177fd30 7939 addReplySds(receiver,sdsnew("*2\r\n"));
dd88747b 7940 addReplyBulk(receiver,key);
7941 addReplyBulk(receiver,ele);
b0d8747d 7942 unblockClientWaitingData(receiver);
4409877e 7943 return 1;
7944}
7945
7946/* Blocking RPOP/LPOP */
7947static void blockingPopGenericCommand(redisClient *c, int where) {
7948 robj *o;
7949 time_t timeout;
b177fd30 7950 int j;
4409877e 7951
b177fd30 7952 for (j = 1; j < c->argc-1; j++) {
7953 o = lookupKeyWrite(c->db,c->argv[j]);
7954 if (o != NULL) {
7955 if (o->type != REDIS_LIST) {
7956 addReply(c,shared.wrongtypeerr);
4409877e 7957 return;
b177fd30 7958 } else {
7959 list *list = o->ptr;
7960 if (listLength(list) != 0) {
7961 /* If the list contains elements fall back to the usual
7962 * non-blocking POP operation */
7963 robj *argv[2], **orig_argv;
7964 int orig_argc;
e0a62c7f 7965
b177fd30 7966 /* We need to alter the command arguments before to call
7967 * popGenericCommand() as the command takes a single key. */
7968 orig_argv = c->argv;
7969 orig_argc = c->argc;
7970 argv[1] = c->argv[j];
7971 c->argv = argv;
7972 c->argc = 2;
7973
7974 /* Also the return value is different, we need to output
7975 * the multi bulk reply header and the key name. The
7976 * "real" command will add the last element (the value)
7977 * for us. If this souds like an hack to you it's just
7978 * because it is... */
7979 addReplySds(c,sdsnew("*2\r\n"));
dd88747b 7980 addReplyBulk(c,argv[1]);
b177fd30 7981 popGenericCommand(c,where);
7982
7983 /* Fix the client structure with the original stuff */
7984 c->argv = orig_argv;
7985 c->argc = orig_argc;
7986 return;
7987 }
4409877e 7988 }
7989 }
7990 }
7991 /* If the list is empty or the key does not exists we must block */
b177fd30 7992 timeout = strtol(c->argv[c->argc-1]->ptr,NULL,10);
4409877e 7993 if (timeout > 0) timeout += time(NULL);
b177fd30 7994 blockForKeys(c,c->argv+1,c->argc-2,timeout);
4409877e 7995}
7996
7997static void blpopCommand(redisClient *c) {
7998 blockingPopGenericCommand(c,REDIS_HEAD);
7999}
8000
8001static void brpopCommand(redisClient *c) {
8002 blockingPopGenericCommand(c,REDIS_TAIL);
8003}
8004
ed9b544e 8005/* =============================== Replication ============================= */
8006
a4d1ba9a 8007static int syncWrite(int fd, char *ptr, ssize_t size, int timeout) {
ed9b544e 8008 ssize_t nwritten, ret = size;
8009 time_t start = time(NULL);
8010
8011 timeout++;
8012 while(size) {
8013 if (aeWait(fd,AE_WRITABLE,1000) & AE_WRITABLE) {
8014 nwritten = write(fd,ptr,size);
8015 if (nwritten == -1) return -1;
8016 ptr += nwritten;
8017 size -= nwritten;
8018 }
8019 if ((time(NULL)-start) > timeout) {
8020 errno = ETIMEDOUT;
8021 return -1;
8022 }
8023 }
8024 return ret;
8025}
8026
a4d1ba9a 8027static int syncRead(int fd, char *ptr, ssize_t size, int timeout) {
ed9b544e 8028 ssize_t nread, totread = 0;
8029 time_t start = time(NULL);
8030
8031 timeout++;
8032 while(size) {
8033 if (aeWait(fd,AE_READABLE,1000) & AE_READABLE) {
8034 nread = read(fd,ptr,size);
8035 if (nread == -1) return -1;
8036 ptr += nread;
8037 size -= nread;
8038 totread += nread;
8039 }
8040 if ((time(NULL)-start) > timeout) {
8041 errno = ETIMEDOUT;
8042 return -1;
8043 }
8044 }
8045 return totread;
8046}
8047
8048static int syncReadLine(int fd, char *ptr, ssize_t size, int timeout) {
8049 ssize_t nread = 0;
8050
8051 size--;
8052 while(size) {
8053 char c;
8054
8055 if (syncRead(fd,&c,1,timeout) == -1) return -1;
8056 if (c == '\n') {
8057 *ptr = '\0';
8058 if (nread && *(ptr-1) == '\r') *(ptr-1) = '\0';
8059 return nread;
8060 } else {
8061 *ptr++ = c;
8062 *ptr = '\0';
8063 nread++;
8064 }
8065 }
8066 return nread;
8067}
8068
8069static void syncCommand(redisClient *c) {
40d224a9 8070 /* ignore SYNC if aleady slave or in monitor mode */
8071 if (c->flags & REDIS_SLAVE) return;
8072
8073 /* SYNC can't be issued when the server has pending data to send to
8074 * the client about already issued commands. We need a fresh reply
8075 * buffer registering the differences between the BGSAVE and the current
8076 * dataset, so that we can copy to other slaves if needed. */
8077 if (listLength(c->reply) != 0) {
8078 addReplySds(c,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
8079 return;
8080 }
8081
8082 redisLog(REDIS_NOTICE,"Slave ask for synchronization");
8083 /* Here we need to check if there is a background saving operation
8084 * in progress, or if it is required to start one */
9d65a1bb 8085 if (server.bgsavechildpid != -1) {
40d224a9 8086 /* Ok a background save is in progress. Let's check if it is a good
8087 * one for replication, i.e. if there is another slave that is
8088 * registering differences since the server forked to save */
8089 redisClient *slave;
8090 listNode *ln;
c7df85a4 8091 listIter li;
40d224a9 8092
c7df85a4 8093 listRewind(server.slaves,&li);
8094 while((ln = listNext(&li))) {
40d224a9 8095 slave = ln->value;
8096 if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_END) break;
40d224a9 8097 }
8098 if (ln) {
8099 /* Perfect, the server is already registering differences for
8100 * another slave. Set the right state, and copy the buffer. */
8101 listRelease(c->reply);
8102 c->reply = listDup(slave->reply);
40d224a9 8103 c->replstate = REDIS_REPL_WAIT_BGSAVE_END;
8104 redisLog(REDIS_NOTICE,"Waiting for end of BGSAVE for SYNC");
8105 } else {
8106 /* No way, we need to wait for the next BGSAVE in order to
8107 * register differences */
8108 c->replstate = REDIS_REPL_WAIT_BGSAVE_START;
8109 redisLog(REDIS_NOTICE,"Waiting for next BGSAVE for SYNC");
8110 }
8111 } else {
8112 /* Ok we don't have a BGSAVE in progress, let's start one */
8113 redisLog(REDIS_NOTICE,"Starting BGSAVE for SYNC");
8114 if (rdbSaveBackground(server.dbfilename) != REDIS_OK) {
8115 redisLog(REDIS_NOTICE,"Replication failed, can't BGSAVE");
8116 addReplySds(c,sdsnew("-ERR Unalbe to perform background save\r\n"));
8117 return;
8118 }
8119 c->replstate = REDIS_REPL_WAIT_BGSAVE_END;
8120 }
6208b3a7 8121 c->repldbfd = -1;
40d224a9 8122 c->flags |= REDIS_SLAVE;
8123 c->slaveseldb = 0;
6b47e12e 8124 listAddNodeTail(server.slaves,c);
40d224a9 8125 return;
8126}
8127
6208b3a7 8128static void sendBulkToSlave(aeEventLoop *el, int fd, void *privdata, int mask) {
8129 redisClient *slave = privdata;
8130 REDIS_NOTUSED(el);
8131 REDIS_NOTUSED(mask);
8132 char buf[REDIS_IOBUF_LEN];
8133 ssize_t nwritten, buflen;
8134
8135 if (slave->repldboff == 0) {
8136 /* Write the bulk write count before to transfer the DB. In theory here
8137 * we don't know how much room there is in the output buffer of the
8138 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
8139 * operations) will never be smaller than the few bytes we need. */
8140 sds bulkcount;
8141
8142 bulkcount = sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
8143 slave->repldbsize);
8144 if (write(fd,bulkcount,sdslen(bulkcount)) != (signed)sdslen(bulkcount))
8145 {
8146 sdsfree(bulkcount);
8147 freeClient(slave);
8148 return;
8149 }
8150 sdsfree(bulkcount);
8151 }
8152 lseek(slave->repldbfd,slave->repldboff,SEEK_SET);
8153 buflen = read(slave->repldbfd,buf,REDIS_IOBUF_LEN);
8154 if (buflen <= 0) {
8155 redisLog(REDIS_WARNING,"Read error sending DB to slave: %s",
8156 (buflen == 0) ? "premature EOF" : strerror(errno));
8157 freeClient(slave);
8158 return;
8159 }
8160 if ((nwritten = write(fd,buf,buflen)) == -1) {
f870935d 8161 redisLog(REDIS_VERBOSE,"Write error sending DB to slave: %s",
6208b3a7 8162 strerror(errno));
8163 freeClient(slave);
8164 return;
8165 }
8166 slave->repldboff += nwritten;
8167 if (slave->repldboff == slave->repldbsize) {
8168 close(slave->repldbfd);
8169 slave->repldbfd = -1;
8170 aeDeleteFileEvent(server.el,slave->fd,AE_WRITABLE);
8171 slave->replstate = REDIS_REPL_ONLINE;
8172 if (aeCreateFileEvent(server.el, slave->fd, AE_WRITABLE,
266373b2 8173 sendReplyToClient, slave) == AE_ERR) {
6208b3a7 8174 freeClient(slave);
8175 return;
8176 }
8177 addReplySds(slave,sdsempty());
8178 redisLog(REDIS_NOTICE,"Synchronization with slave succeeded");
8179 }
8180}
ed9b544e 8181
a3b21203 8182/* This function is called at the end of every backgrond saving.
8183 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
8184 * otherwise REDIS_ERR is passed to the function.
8185 *
8186 * The goal of this function is to handle slaves waiting for a successful
8187 * background saving in order to perform non-blocking synchronization. */
8188static void updateSlavesWaitingBgsave(int bgsaveerr) {
6208b3a7 8189 listNode *ln;
8190 int startbgsave = 0;
c7df85a4 8191 listIter li;
ed9b544e 8192
c7df85a4 8193 listRewind(server.slaves,&li);
8194 while((ln = listNext(&li))) {
6208b3a7 8195 redisClient *slave = ln->value;
ed9b544e 8196
6208b3a7 8197 if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_START) {
8198 startbgsave = 1;
8199 slave->replstate = REDIS_REPL_WAIT_BGSAVE_END;
8200 } else if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_END) {
dde65f3f 8201 struct redis_stat buf;
e0a62c7f 8202
6208b3a7 8203 if (bgsaveerr != REDIS_OK) {
8204 freeClient(slave);
8205 redisLog(REDIS_WARNING,"SYNC failed. BGSAVE child returned an error");
8206 continue;
8207 }
8208 if ((slave->repldbfd = open(server.dbfilename,O_RDONLY)) == -1 ||
dde65f3f 8209 redis_fstat(slave->repldbfd,&buf) == -1) {
6208b3a7 8210 freeClient(slave);
8211 redisLog(REDIS_WARNING,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno));
8212 continue;
8213 }
8214 slave->repldboff = 0;
8215 slave->repldbsize = buf.st_size;
8216 slave->replstate = REDIS_REPL_SEND_BULK;
8217 aeDeleteFileEvent(server.el,slave->fd,AE_WRITABLE);
266373b2 8218 if (aeCreateFileEvent(server.el, slave->fd, AE_WRITABLE, sendBulkToSlave, slave) == AE_ERR) {
6208b3a7 8219 freeClient(slave);
8220 continue;
8221 }
8222 }
ed9b544e 8223 }
6208b3a7 8224 if (startbgsave) {
8225 if (rdbSaveBackground(server.dbfilename) != REDIS_OK) {
c7df85a4 8226 listIter li;
8227
8228 listRewind(server.slaves,&li);
6208b3a7 8229 redisLog(REDIS_WARNING,"SYNC failed. BGSAVE failed");
c7df85a4 8230 while((ln = listNext(&li))) {
6208b3a7 8231 redisClient *slave = ln->value;
ed9b544e 8232
6208b3a7 8233 if (slave->replstate == REDIS_REPL_WAIT_BGSAVE_START)
8234 freeClient(slave);
8235 }
8236 }
8237 }
ed9b544e 8238}
8239
8240static int syncWithMaster(void) {
d0ccebcf 8241 char buf[1024], tmpfile[256], authcmd[1024];
18e61fa2 8242 long dumpsize;
ed9b544e 8243 int fd = anetTcpConnect(NULL,server.masterhost,server.masterport);
8c5abee8 8244 int dfd, maxtries = 5;
ed9b544e 8245
8246 if (fd == -1) {
8247 redisLog(REDIS_WARNING,"Unable to connect to MASTER: %s",
8248 strerror(errno));
8249 return REDIS_ERR;
8250 }
d0ccebcf 8251
8252 /* AUTH with the master if required. */
8253 if(server.masterauth) {
8254 snprintf(authcmd, 1024, "AUTH %s\r\n", server.masterauth);
8255 if (syncWrite(fd, authcmd, strlen(server.masterauth)+7, 5) == -1) {
8256 close(fd);
8257 redisLog(REDIS_WARNING,"Unable to AUTH to MASTER: %s",
8258 strerror(errno));
8259 return REDIS_ERR;
8260 }
8261 /* Read the AUTH result. */
8262 if (syncReadLine(fd,buf,1024,3600) == -1) {
8263 close(fd);
8264 redisLog(REDIS_WARNING,"I/O error reading auth result from MASTER: %s",
8265 strerror(errno));
8266 return REDIS_ERR;
8267 }
8268 if (buf[0] != '+') {
8269 close(fd);
8270 redisLog(REDIS_WARNING,"Cannot AUTH to MASTER, is the masterauth password correct?");
8271 return REDIS_ERR;
8272 }
8273 }
8274
ed9b544e 8275 /* Issue the SYNC command */
8276 if (syncWrite(fd,"SYNC \r\n",7,5) == -1) {
8277 close(fd);
8278 redisLog(REDIS_WARNING,"I/O error writing to MASTER: %s",
8279 strerror(errno));
8280 return REDIS_ERR;
8281 }
8282 /* Read the bulk write count */
8c4d91fc 8283 if (syncReadLine(fd,buf,1024,3600) == -1) {
ed9b544e 8284 close(fd);
8285 redisLog(REDIS_WARNING,"I/O error reading bulk count from MASTER: %s",
8286 strerror(errno));
8287 return REDIS_ERR;
8288 }
4aa701c1 8289 if (buf[0] != '$') {
8290 close(fd);
8291 redisLog(REDIS_WARNING,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
8292 return REDIS_ERR;
8293 }
18e61fa2 8294 dumpsize = strtol(buf+1,NULL,10);
8295 redisLog(REDIS_NOTICE,"Receiving %ld bytes data dump from MASTER",dumpsize);
ed9b544e 8296 /* Read the bulk write data on a temp file */
8c5abee8 8297 while(maxtries--) {
8298 snprintf(tmpfile,256,
8299 "temp-%d.%ld.rdb",(int)time(NULL),(long int)getpid());
8300 dfd = open(tmpfile,O_CREAT|O_WRONLY|O_EXCL,0644);
8301 if (dfd != -1) break;
5de9ad7c 8302 sleep(1);
8c5abee8 8303 }
ed9b544e 8304 if (dfd == -1) {
8305 close(fd);
8306 redisLog(REDIS_WARNING,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno));
8307 return REDIS_ERR;
8308 }
8309 while(dumpsize) {
8310 int nread, nwritten;
8311
8312 nread = read(fd,buf,(dumpsize < 1024)?dumpsize:1024);
8313 if (nread == -1) {
8314 redisLog(REDIS_WARNING,"I/O error trying to sync with MASTER: %s",
8315 strerror(errno));
8316 close(fd);
8317 close(dfd);
8318 return REDIS_ERR;
8319 }
8320 nwritten = write(dfd,buf,nread);
8321 if (nwritten == -1) {
8322 redisLog(REDIS_WARNING,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno));
8323 close(fd);
8324 close(dfd);
8325 return REDIS_ERR;
8326 }
8327 dumpsize -= nread;
8328 }
8329 close(dfd);
8330 if (rename(tmpfile,server.dbfilename) == -1) {
8331 redisLog(REDIS_WARNING,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno));
8332 unlink(tmpfile);
8333 close(fd);
8334 return REDIS_ERR;
8335 }
8336 emptyDb();
f78fd11b 8337 if (rdbLoad(server.dbfilename) != REDIS_OK) {
ed9b544e 8338 redisLog(REDIS_WARNING,"Failed trying to load the MASTER synchronization DB from disk");
8339 close(fd);
8340 return REDIS_ERR;
8341 }
8342 server.master = createClient(fd);
8343 server.master->flags |= REDIS_MASTER;
179b3952 8344 server.master->authenticated = 1;
ed9b544e 8345 server.replstate = REDIS_REPL_CONNECTED;
8346 return REDIS_OK;
8347}
8348
321b0e13 8349static void slaveofCommand(redisClient *c) {
8350 if (!strcasecmp(c->argv[1]->ptr,"no") &&
8351 !strcasecmp(c->argv[2]->ptr,"one")) {
8352 if (server.masterhost) {
8353 sdsfree(server.masterhost);
8354 server.masterhost = NULL;
8355 if (server.master) freeClient(server.master);
8356 server.replstate = REDIS_REPL_NONE;
8357 redisLog(REDIS_NOTICE,"MASTER MODE enabled (user request)");
8358 }
8359 } else {
8360 sdsfree(server.masterhost);
8361 server.masterhost = sdsdup(c->argv[1]->ptr);
8362 server.masterport = atoi(c->argv[2]->ptr);
8363 if (server.master) freeClient(server.master);
8364 server.replstate = REDIS_REPL_CONNECT;
8365 redisLog(REDIS_NOTICE,"SLAVE OF %s:%d enabled (user request)",
8366 server.masterhost, server.masterport);
8367 }
8368 addReply(c,shared.ok);
8369}
8370
3fd78bcd 8371/* ============================ Maxmemory directive ======================== */
8372
a5819310 8373/* Try to free one object form the pre-allocated objects free list.
8374 * This is useful under low mem conditions as by default we take 1 million
8375 * free objects allocated. On success REDIS_OK is returned, otherwise
8376 * REDIS_ERR. */
8377static int tryFreeOneObjectFromFreelist(void) {
f870935d 8378 robj *o;
8379
a5819310 8380 if (server.vm_enabled) pthread_mutex_lock(&server.obj_freelist_mutex);
8381 if (listLength(server.objfreelist)) {
8382 listNode *head = listFirst(server.objfreelist);
8383 o = listNodeValue(head);
8384 listDelNode(server.objfreelist,head);
8385 if (server.vm_enabled) pthread_mutex_unlock(&server.obj_freelist_mutex);
8386 zfree(o);
8387 return REDIS_OK;
8388 } else {
8389 if (server.vm_enabled) pthread_mutex_unlock(&server.obj_freelist_mutex);
8390 return REDIS_ERR;
8391 }
f870935d 8392}
8393
3fd78bcd 8394/* This function gets called when 'maxmemory' is set on the config file to limit
8395 * the max memory used by the server, and we are out of memory.
8396 * This function will try to, in order:
8397 *
8398 * - Free objects from the free list
8399 * - Try to remove keys with an EXPIRE set
8400 *
8401 * It is not possible to free enough memory to reach used-memory < maxmemory
8402 * the server will start refusing commands that will enlarge even more the
8403 * memory usage.
8404 */
8405static void freeMemoryIfNeeded(void) {
8406 while (server.maxmemory && zmalloc_used_memory() > server.maxmemory) {
a5819310 8407 int j, k, freed = 0;
8408
8409 if (tryFreeOneObjectFromFreelist() == REDIS_OK) continue;
8410 for (j = 0; j < server.dbnum; j++) {
8411 int minttl = -1;
8412 robj *minkey = NULL;
8413 struct dictEntry *de;
8414
8415 if (dictSize(server.db[j].expires)) {
8416 freed = 1;
8417 /* From a sample of three keys drop the one nearest to
8418 * the natural expire */
8419 for (k = 0; k < 3; k++) {
8420 time_t t;
8421
8422 de = dictGetRandomKey(server.db[j].expires);
8423 t = (time_t) dictGetEntryVal(de);
8424 if (minttl == -1 || t < minttl) {
8425 minkey = dictGetEntryKey(de);
8426 minttl = t;
3fd78bcd 8427 }
3fd78bcd 8428 }
a5819310 8429 deleteKey(server.db+j,minkey);
3fd78bcd 8430 }
3fd78bcd 8431 }
a5819310 8432 if (!freed) return; /* nothing to free... */
3fd78bcd 8433 }
8434}
8435
f80dff62 8436/* ============================== Append Only file ========================== */
8437
28ed1f33 8438/* Write the append only file buffer on disk.
8439 *
8440 * Since we are required to write the AOF before replying to the client,
8441 * and the only way the client socket can get a write is entering when the
8442 * the event loop, we accumulate all the AOF writes in a memory
8443 * buffer and write it on disk using this function just before entering
8444 * the event loop again. */
8445static void flushAppendOnlyFile(void) {
8446 time_t now;
8447 ssize_t nwritten;
8448
8449 if (sdslen(server.aofbuf) == 0) return;
8450
8451 /* We want to perform a single write. This should be guaranteed atomic
8452 * at least if the filesystem we are writing is a real physical one.
8453 * While this will save us against the server being killed I don't think
8454 * there is much to do about the whole server stopping for power problems
8455 * or alike */
8456 nwritten = write(server.appendfd,server.aofbuf,sdslen(server.aofbuf));
8457 if (nwritten != (signed)sdslen(server.aofbuf)) {
8458 /* Ooops, we are in troubles. The best thing to do for now is
8459 * aborting instead of giving the illusion that everything is
8460 * working as expected. */
8461 if (nwritten == -1) {
8462 redisLog(REDIS_WARNING,"Exiting on error writing to the append-only file: %s",strerror(errno));
8463 } else {
8464 redisLog(REDIS_WARNING,"Exiting on short write while writing to the append-only file: %s",strerror(errno));
8465 }
8466 exit(1);
8467 }
8468 sdsfree(server.aofbuf);
8469 server.aofbuf = sdsempty();
8470
8471 /* Fsync if needed */
8472 now = time(NULL);
8473 if (server.appendfsync == APPENDFSYNC_ALWAYS ||
8474 (server.appendfsync == APPENDFSYNC_EVERYSEC &&
8475 now-server.lastfsync > 1))
8476 {
8477 /* aof_fsync is defined as fdatasync() for Linux in order to avoid
8478 * flushing metadata. */
8479 aof_fsync(server.appendfd); /* Let's try to get this data on the disk */
8480 server.lastfsync = now;
8481 }
8482}
8483
9376e434
PN
8484static sds catAppendOnlyGenericCommand(sds buf, int argc, robj **argv) {
8485 int j;
8486 buf = sdscatprintf(buf,"*%d\r\n",argc);
8487 for (j = 0; j < argc; j++) {
8488 robj *o = getDecodedObject(argv[j]);
8489 buf = sdscatprintf(buf,"$%lu\r\n",(unsigned long)sdslen(o->ptr));
8490 buf = sdscatlen(buf,o->ptr,sdslen(o->ptr));
8491 buf = sdscatlen(buf,"\r\n",2);
8492 decrRefCount(o);
8493 }
8494 return buf;
8495}
8496
8497static sds catAppendOnlyExpireAtCommand(sds buf, robj *key, robj *seconds) {
8498 int argc = 3;
8499 long when;
8500 robj *argv[3];
8501
8502 /* Make sure we can use strtol */
8503 seconds = getDecodedObject(seconds);
8504 when = time(NULL)+strtol(seconds->ptr,NULL,10);
8505 decrRefCount(seconds);
8506
8507 argv[0] = createStringObject("EXPIREAT",8);
8508 argv[1] = key;
8509 argv[2] = createObject(REDIS_STRING,
8510 sdscatprintf(sdsempty(),"%ld",when));
8511 buf = catAppendOnlyGenericCommand(buf, argc, argv);
8512 decrRefCount(argv[0]);
8513 decrRefCount(argv[2]);
8514 return buf;
8515}
8516
f80dff62 8517static void feedAppendOnlyFile(struct redisCommand *cmd, int dictid, robj **argv, int argc) {
8518 sds buf = sdsempty();
f80dff62 8519 robj *tmpargv[3];
8520
8521 /* The DB this command was targetting is not the same as the last command
8522 * we appendend. To issue a SELECT command is needed. */
8523 if (dictid != server.appendseldb) {
8524 char seldb[64];
8525
8526 snprintf(seldb,sizeof(seldb),"%d",dictid);
682ac724 8527 buf = sdscatprintf(buf,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
83c6a618 8528 (unsigned long)strlen(seldb),seldb);
f80dff62 8529 server.appendseldb = dictid;
8530 }
8531
f80dff62 8532 if (cmd->proc == expireCommand) {
9376e434
PN
8533 /* Translate EXPIRE into EXPIREAT */
8534 buf = catAppendOnlyExpireAtCommand(buf,argv[1],argv[2]);
8535 } else if (cmd->proc == setexCommand) {
8536 /* Translate SETEX to SET and EXPIREAT */
8537 tmpargv[0] = createStringObject("SET",3);
f80dff62 8538 tmpargv[1] = argv[1];
9376e434
PN
8539 tmpargv[2] = argv[3];
8540 buf = catAppendOnlyGenericCommand(buf,3,tmpargv);
8541 decrRefCount(tmpargv[0]);
8542 buf = catAppendOnlyExpireAtCommand(buf,argv[1],argv[2]);
8543 } else {
8544 buf = catAppendOnlyGenericCommand(buf,argc,argv);
f80dff62 8545 }
8546
28ed1f33 8547 /* Append to the AOF buffer. This will be flushed on disk just before
8548 * of re-entering the event loop, so before the client will get a
8549 * positive reply about the operation performed. */
8550 server.aofbuf = sdscatlen(server.aofbuf,buf,sdslen(buf));
8551
85a83172 8552 /* If a background append only file rewriting is in progress we want to
8553 * accumulate the differences between the child DB and the current one
8554 * in a buffer, so that when the child process will do its work we
8555 * can append the differences to the new append only file. */
8556 if (server.bgrewritechildpid != -1)
8557 server.bgrewritebuf = sdscatlen(server.bgrewritebuf,buf,sdslen(buf));
8558
8559 sdsfree(buf);
f80dff62 8560}
8561
8562/* In Redis commands are always executed in the context of a client, so in
8563 * order to load the append only file we need to create a fake client. */
8564static struct redisClient *createFakeClient(void) {
8565 struct redisClient *c = zmalloc(sizeof(*c));
8566
8567 selectDb(c,0);
8568 c->fd = -1;
8569 c->querybuf = sdsempty();
8570 c->argc = 0;
8571 c->argv = NULL;
8572 c->flags = 0;
9387d17d 8573 /* We set the fake client as a slave waiting for the synchronization
8574 * so that Redis will not try to send replies to this client. */
8575 c->replstate = REDIS_REPL_WAIT_BGSAVE_START;
f80dff62 8576 c->reply = listCreate();
8577 listSetFreeMethod(c->reply,decrRefCount);
8578 listSetDupMethod(c->reply,dupClientReplyValue);
4132ad8d 8579 initClientMultiState(c);
f80dff62 8580 return c;
8581}
8582
8583static void freeFakeClient(struct redisClient *c) {
8584 sdsfree(c->querybuf);
8585 listRelease(c->reply);
4132ad8d 8586 freeClientMultiState(c);
f80dff62 8587 zfree(c);
8588}
8589
8590/* Replay the append log file. On error REDIS_OK is returned. On non fatal
8591 * error (the append only file is zero-length) REDIS_ERR is returned. On
8592 * fatal error an error message is logged and the program exists. */
8593int loadAppendOnlyFile(char *filename) {
8594 struct redisClient *fakeClient;
8595 FILE *fp = fopen(filename,"r");
8596 struct redis_stat sb;
b492cf00 8597 unsigned long long loadedkeys = 0;
4132ad8d 8598 int appendonly = server.appendonly;
f80dff62 8599
8600 if (redis_fstat(fileno(fp),&sb) != -1 && sb.st_size == 0)
8601 return REDIS_ERR;
8602
8603 if (fp == NULL) {
8604 redisLog(REDIS_WARNING,"Fatal error: can't open the append log file for reading: %s",strerror(errno));
8605 exit(1);
8606 }
8607
4132ad8d
PN
8608 /* Temporarily disable AOF, to prevent EXEC from feeding a MULTI
8609 * to the same file we're about to read. */
8610 server.appendonly = 0;
8611
f80dff62 8612 fakeClient = createFakeClient();
8613 while(1) {
8614 int argc, j;
8615 unsigned long len;
8616 robj **argv;
8617 char buf[128];
8618 sds argsds;
8619 struct redisCommand *cmd;
8620
8621 if (fgets(buf,sizeof(buf),fp) == NULL) {
8622 if (feof(fp))
8623 break;
8624 else
8625 goto readerr;
8626 }
8627 if (buf[0] != '*') goto fmterr;
8628 argc = atoi(buf+1);
8629 argv = zmalloc(sizeof(robj*)*argc);
8630 for (j = 0; j < argc; j++) {
8631 if (fgets(buf,sizeof(buf),fp) == NULL) goto readerr;
8632 if (buf[0] != '$') goto fmterr;
8633 len = strtol(buf+1,NULL,10);
8634 argsds = sdsnewlen(NULL,len);
0f151ef1 8635 if (len && fread(argsds,len,1,fp) == 0) goto fmterr;
f80dff62 8636 argv[j] = createObject(REDIS_STRING,argsds);
8637 if (fread(buf,2,1,fp) == 0) goto fmterr; /* discard CRLF */
8638 }
8639
8640 /* Command lookup */
8641 cmd = lookupCommand(argv[0]->ptr);
8642 if (!cmd) {
8643 redisLog(REDIS_WARNING,"Unknown command '%s' reading the append only file", argv[0]->ptr);
8644 exit(1);
8645 }
bdcb92f2 8646 /* Try object encoding */
f80dff62 8647 if (cmd->flags & REDIS_CMD_BULK)
05df7621 8648 argv[argc-1] = tryObjectEncoding(argv[argc-1]);
f80dff62 8649 /* Run the command in the context of a fake client */
8650 fakeClient->argc = argc;
8651 fakeClient->argv = argv;
8652 cmd->proc(fakeClient);
8653 /* Discard the reply objects list from the fake client */
8654 while(listLength(fakeClient->reply))
8655 listDelNode(fakeClient->reply,listFirst(fakeClient->reply));
8656 /* Clean up, ready for the next command */
8657 for (j = 0; j < argc; j++) decrRefCount(argv[j]);
8658 zfree(argv);
b492cf00 8659 /* Handle swapping while loading big datasets when VM is on */
8660 loadedkeys++;
8661 if (server.vm_enabled && (loadedkeys % 5000) == 0) {
8662 while (zmalloc_used_memory() > server.vm_max_memory) {
a69a0c9c 8663 if (vmSwapOneObjectBlocking() == REDIS_ERR) break;
b492cf00 8664 }
8665 }
f80dff62 8666 }
4132ad8d
PN
8667
8668 /* This point can only be reached when EOF is reached without errors.
8669 * If the client is in the middle of a MULTI/EXEC, log error and quit. */
8670 if (fakeClient->flags & REDIS_MULTI) goto readerr;
8671
f80dff62 8672 fclose(fp);
8673 freeFakeClient(fakeClient);
4132ad8d 8674 server.appendonly = appendonly;
f80dff62 8675 return REDIS_OK;
8676
8677readerr:
8678 if (feof(fp)) {
8679 redisLog(REDIS_WARNING,"Unexpected end of file reading the append only file");
8680 } else {
8681 redisLog(REDIS_WARNING,"Unrecoverable error reading the append only file: %s", strerror(errno));
8682 }
8683 exit(1);
8684fmterr:
8685 redisLog(REDIS_WARNING,"Bad file format reading the append only file");
8686 exit(1);
8687}
8688
9d65a1bb 8689/* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
9c8e3cee 8690static int fwriteBulkObject(FILE *fp, robj *obj) {
9d65a1bb 8691 char buf[128];
b9bc0eef 8692 int decrrc = 0;
8693
f2d9f50f 8694 /* Avoid the incr/decr ref count business if possible to help
8695 * copy-on-write (we are often in a child process when this function
8696 * is called).
8697 * Also makes sure that key objects don't get incrRefCount-ed when VM
8698 * is enabled */
8699 if (obj->encoding != REDIS_ENCODING_RAW) {
b9bc0eef 8700 obj = getDecodedObject(obj);
8701 decrrc = 1;
8702 }
9d65a1bb 8703 snprintf(buf,sizeof(buf),"$%ld\r\n",(long)sdslen(obj->ptr));
8704 if (fwrite(buf,strlen(buf),1,fp) == 0) goto err;
e96e4fbf 8705 if (sdslen(obj->ptr) && fwrite(obj->ptr,sdslen(obj->ptr),1,fp) == 0)
8706 goto err;
9d65a1bb 8707 if (fwrite("\r\n",2,1,fp) == 0) goto err;
b9bc0eef 8708 if (decrrc) decrRefCount(obj);
9d65a1bb 8709 return 1;
8710err:
b9bc0eef 8711 if (decrrc) decrRefCount(obj);
9d65a1bb 8712 return 0;
8713}
8714
9c8e3cee 8715/* Write binary-safe string into a file in the bulkformat
8716 * $<count>\r\n<payload>\r\n */
8717static int fwriteBulkString(FILE *fp, char *s, unsigned long len) {
8718 char buf[128];
8719
8720 snprintf(buf,sizeof(buf),"$%ld\r\n",(unsigned long)len);
8721 if (fwrite(buf,strlen(buf),1,fp) == 0) return 0;
8722 if (len && fwrite(s,len,1,fp) == 0) return 0;
8723 if (fwrite("\r\n",2,1,fp) == 0) return 0;
8724 return 1;
8725}
8726
9d65a1bb 8727/* Write a double value in bulk format $<count>\r\n<payload>\r\n */
8728static int fwriteBulkDouble(FILE *fp, double d) {
8729 char buf[128], dbuf[128];
8730
8731 snprintf(dbuf,sizeof(dbuf),"%.17g\r\n",d);
8732 snprintf(buf,sizeof(buf),"$%lu\r\n",(unsigned long)strlen(dbuf)-2);
8733 if (fwrite(buf,strlen(buf),1,fp) == 0) return 0;
8734 if (fwrite(dbuf,strlen(dbuf),1,fp) == 0) return 0;
8735 return 1;
8736}
8737
8738/* Write a long value in bulk format $<count>\r\n<payload>\r\n */
8739static int fwriteBulkLong(FILE *fp, long l) {
8740 char buf[128], lbuf[128];
8741
8742 snprintf(lbuf,sizeof(lbuf),"%ld\r\n",l);
8743 snprintf(buf,sizeof(buf),"$%lu\r\n",(unsigned long)strlen(lbuf)-2);
8744 if (fwrite(buf,strlen(buf),1,fp) == 0) return 0;
8745 if (fwrite(lbuf,strlen(lbuf),1,fp) == 0) return 0;
8746 return 1;
8747}
8748
8749/* Write a sequence of commands able to fully rebuild the dataset into
8750 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
8751static int rewriteAppendOnlyFile(char *filename) {
8752 dictIterator *di = NULL;
8753 dictEntry *de;
8754 FILE *fp;
8755 char tmpfile[256];
8756 int j;
8757 time_t now = time(NULL);
8758
8759 /* Note that we have to use a different temp name here compared to the
8760 * one used by rewriteAppendOnlyFileBackground() function. */
8761 snprintf(tmpfile,256,"temp-rewriteaof-%d.aof", (int) getpid());
8762 fp = fopen(tmpfile,"w");
8763 if (!fp) {
8764 redisLog(REDIS_WARNING, "Failed rewriting the append only file: %s", strerror(errno));
8765 return REDIS_ERR;
8766 }
8767 for (j = 0; j < server.dbnum; j++) {
8768 char selectcmd[] = "*2\r\n$6\r\nSELECT\r\n";
8769 redisDb *db = server.db+j;
8770 dict *d = db->dict;
8771 if (dictSize(d) == 0) continue;
8772 di = dictGetIterator(d);
8773 if (!di) {
8774 fclose(fp);
8775 return REDIS_ERR;
8776 }
8777
8778 /* SELECT the new DB */
8779 if (fwrite(selectcmd,sizeof(selectcmd)-1,1,fp) == 0) goto werr;
85a83172 8780 if (fwriteBulkLong(fp,j) == 0) goto werr;
9d65a1bb 8781
8782 /* Iterate this DB writing every entry */
8783 while((de = dictNext(di)) != NULL) {
e7546c63 8784 robj *key, *o;
8785 time_t expiretime;
8786 int swapped;
8787
8788 key = dictGetEntryKey(de);
b9bc0eef 8789 /* If the value for this key is swapped, load a preview in memory.
8790 * We use a "swapped" flag to remember if we need to free the
8791 * value object instead to just increment the ref count anyway
8792 * in order to avoid copy-on-write of pages if we are forked() */
996cb5f7 8793 if (!server.vm_enabled || key->storage == REDIS_VM_MEMORY ||
8794 key->storage == REDIS_VM_SWAPPING) {
e7546c63 8795 o = dictGetEntryVal(de);
8796 swapped = 0;
8797 } else {
8798 o = vmPreviewObject(key);
e7546c63 8799 swapped = 1;
8800 }
8801 expiretime = getExpire(db,key);
9d65a1bb 8802
8803 /* Save the key and associated value */
9d65a1bb 8804 if (o->type == REDIS_STRING) {
8805 /* Emit a SET command */
8806 char cmd[]="*3\r\n$3\r\nSET\r\n";
8807 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
8808 /* Key and value */
9c8e3cee 8809 if (fwriteBulkObject(fp,key) == 0) goto werr;
8810 if (fwriteBulkObject(fp,o) == 0) goto werr;
9d65a1bb 8811 } else if (o->type == REDIS_LIST) {
8812 /* Emit the RPUSHes needed to rebuild the list */
8813 list *list = o->ptr;
8814 listNode *ln;
c7df85a4 8815 listIter li;
9d65a1bb 8816
c7df85a4 8817 listRewind(list,&li);
8818 while((ln = listNext(&li))) {
9d65a1bb 8819 char cmd[]="*3\r\n$5\r\nRPUSH\r\n";
8820 robj *eleobj = listNodeValue(ln);
8821
8822 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
9c8e3cee 8823 if (fwriteBulkObject(fp,key) == 0) goto werr;
8824 if (fwriteBulkObject(fp,eleobj) == 0) goto werr;
9d65a1bb 8825 }
8826 } else if (o->type == REDIS_SET) {
8827 /* Emit the SADDs needed to rebuild the set */
8828 dict *set = o->ptr;
8829 dictIterator *di = dictGetIterator(set);
8830 dictEntry *de;
8831
8832 while((de = dictNext(di)) != NULL) {
8833 char cmd[]="*3\r\n$4\r\nSADD\r\n";
8834 robj *eleobj = dictGetEntryKey(de);
8835
8836 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
9c8e3cee 8837 if (fwriteBulkObject(fp,key) == 0) goto werr;
8838 if (fwriteBulkObject(fp,eleobj) == 0) goto werr;
9d65a1bb 8839 }
8840 dictReleaseIterator(di);
8841 } else if (o->type == REDIS_ZSET) {
8842 /* Emit the ZADDs needed to rebuild the sorted set */
8843 zset *zs = o->ptr;
8844 dictIterator *di = dictGetIterator(zs->dict);
8845 dictEntry *de;
8846
8847 while((de = dictNext(di)) != NULL) {
8848 char cmd[]="*4\r\n$4\r\nZADD\r\n";
8849 robj *eleobj = dictGetEntryKey(de);
8850 double *score = dictGetEntryVal(de);
8851
8852 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
9c8e3cee 8853 if (fwriteBulkObject(fp,key) == 0) goto werr;
9d65a1bb 8854 if (fwriteBulkDouble(fp,*score) == 0) goto werr;
9c8e3cee 8855 if (fwriteBulkObject(fp,eleobj) == 0) goto werr;
9d65a1bb 8856 }
8857 dictReleaseIterator(di);
9c8e3cee 8858 } else if (o->type == REDIS_HASH) {
8859 char cmd[]="*4\r\n$4\r\nHSET\r\n";
8860
8861 /* Emit the HSETs needed to rebuild the hash */
8862 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
8863 unsigned char *p = zipmapRewind(o->ptr);
8864 unsigned char *field, *val;
8865 unsigned int flen, vlen;
8866
8867 while((p = zipmapNext(p,&field,&flen,&val,&vlen)) != NULL) {
8868 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
8869 if (fwriteBulkObject(fp,key) == 0) goto werr;
8870 if (fwriteBulkString(fp,(char*)field,flen) == -1)
8871 return -1;
8872 if (fwriteBulkString(fp,(char*)val,vlen) == -1)
8873 return -1;
8874 }
8875 } else {
8876 dictIterator *di = dictGetIterator(o->ptr);
8877 dictEntry *de;
8878
8879 while((de = dictNext(di)) != NULL) {
8880 robj *field = dictGetEntryKey(de);
8881 robj *val = dictGetEntryVal(de);
8882
8883 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
8884 if (fwriteBulkObject(fp,key) == 0) goto werr;
8885 if (fwriteBulkObject(fp,field) == -1) return -1;
8886 if (fwriteBulkObject(fp,val) == -1) return -1;
8887 }
8888 dictReleaseIterator(di);
8889 }
9d65a1bb 8890 } else {
f83c6cb5 8891 redisPanic("Unknown object type");
9d65a1bb 8892 }
8893 /* Save the expire time */
8894 if (expiretime != -1) {
e96e4fbf 8895 char cmd[]="*3\r\n$8\r\nEXPIREAT\r\n";
9d65a1bb 8896 /* If this key is already expired skip it */
8897 if (expiretime < now) continue;
8898 if (fwrite(cmd,sizeof(cmd)-1,1,fp) == 0) goto werr;
9c8e3cee 8899 if (fwriteBulkObject(fp,key) == 0) goto werr;
9d65a1bb 8900 if (fwriteBulkLong(fp,expiretime) == 0) goto werr;
8901 }
b9bc0eef 8902 if (swapped) decrRefCount(o);
9d65a1bb 8903 }
8904 dictReleaseIterator(di);
8905 }
8906
8907 /* Make sure data will not remain on the OS's output buffers */
8908 fflush(fp);
8909 fsync(fileno(fp));
8910 fclose(fp);
e0a62c7f 8911
9d65a1bb 8912 /* Use RENAME to make sure the DB file is changed atomically only
8913 * if the generate DB file is ok. */
8914 if (rename(tmpfile,filename) == -1) {
8915 redisLog(REDIS_WARNING,"Error moving temp append only file on the final destination: %s", strerror(errno));
8916 unlink(tmpfile);
8917 return REDIS_ERR;
8918 }
8919 redisLog(REDIS_NOTICE,"SYNC append only file rewrite performed");
8920 return REDIS_OK;
8921
8922werr:
8923 fclose(fp);
8924 unlink(tmpfile);
e96e4fbf 8925 redisLog(REDIS_WARNING,"Write error writing append only file on disk: %s", strerror(errno));
9d65a1bb 8926 if (di) dictReleaseIterator(di);
8927 return REDIS_ERR;
8928}
8929
8930/* This is how rewriting of the append only file in background works:
8931 *
8932 * 1) The user calls BGREWRITEAOF
8933 * 2) Redis calls this function, that forks():
8934 * 2a) the child rewrite the append only file in a temp file.
8935 * 2b) the parent accumulates differences in server.bgrewritebuf.
8936 * 3) When the child finished '2a' exists.
8937 * 4) The parent will trap the exit code, if it's OK, will append the
8938 * data accumulated into server.bgrewritebuf into the temp file, and
8939 * finally will rename(2) the temp file in the actual file name.
8940 * The the new file is reopened as the new append only file. Profit!
8941 */
8942static int rewriteAppendOnlyFileBackground(void) {
8943 pid_t childpid;
8944
8945 if (server.bgrewritechildpid != -1) return REDIS_ERR;
054e426d 8946 if (server.vm_enabled) waitEmptyIOJobsQueue();
9d65a1bb 8947 if ((childpid = fork()) == 0) {
8948 /* Child */
8949 char tmpfile[256];
9d65a1bb 8950
054e426d 8951 if (server.vm_enabled) vmReopenSwapFile();
8952 close(server.fd);
9d65a1bb 8953 snprintf(tmpfile,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
8954 if (rewriteAppendOnlyFile(tmpfile) == REDIS_OK) {
478c2c6f 8955 _exit(0);
9d65a1bb 8956 } else {
478c2c6f 8957 _exit(1);
9d65a1bb 8958 }
8959 } else {
8960 /* Parent */
8961 if (childpid == -1) {
8962 redisLog(REDIS_WARNING,
8963 "Can't rewrite append only file in background: fork: %s",
8964 strerror(errno));
8965 return REDIS_ERR;
8966 }
8967 redisLog(REDIS_NOTICE,
8968 "Background append only file rewriting started by pid %d",childpid);
8969 server.bgrewritechildpid = childpid;
884d4b39 8970 updateDictResizePolicy();
85a83172 8971 /* We set appendseldb to -1 in order to force the next call to the
8972 * feedAppendOnlyFile() to issue a SELECT command, so the differences
8973 * accumulated by the parent into server.bgrewritebuf will start
8974 * with a SELECT statement and it will be safe to merge. */
8975 server.appendseldb = -1;
9d65a1bb 8976 return REDIS_OK;
8977 }
8978 return REDIS_OK; /* unreached */
8979}
8980
8981static void bgrewriteaofCommand(redisClient *c) {
8982 if (server.bgrewritechildpid != -1) {
8983 addReplySds(c,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
8984 return;
8985 }
8986 if (rewriteAppendOnlyFileBackground() == REDIS_OK) {
49b99ab4 8987 char *status = "+Background append only file rewriting started\r\n";
8988 addReplySds(c,sdsnew(status));
9d65a1bb 8989 } else {
8990 addReply(c,shared.err);
8991 }
8992}
8993
8994static void aofRemoveTempFile(pid_t childpid) {
8995 char tmpfile[256];
8996
8997 snprintf(tmpfile,256,"temp-rewriteaof-bg-%d.aof", (int) childpid);
8998 unlink(tmpfile);
8999}
9000
996cb5f7 9001/* Virtual Memory is composed mainly of two subsystems:
9002 * - Blocking Virutal Memory
9003 * - Threaded Virtual Memory I/O
9004 * The two parts are not fully decoupled, but functions are split among two
9005 * different sections of the source code (delimited by comments) in order to
9006 * make more clear what functionality is about the blocking VM and what about
9007 * the threaded (not blocking) VM.
9008 *
9009 * Redis VM design:
9010 *
9011 * Redis VM is a blocking VM (one that blocks reading swapped values from
9012 * disk into memory when a value swapped out is needed in memory) that is made
9013 * unblocking by trying to examine the command argument vector in order to
9014 * load in background values that will likely be needed in order to exec
9015 * the command. The command is executed only once all the relevant keys
9016 * are loaded into memory.
9017 *
9018 * This basically is almost as simple of a blocking VM, but almost as parallel
9019 * as a fully non-blocking VM.
9020 */
9021
2e5eb04e 9022/* Called when the user switches from "appendonly yes" to "appendonly no"
9023 * at runtime using the CONFIG command. */
9024static void stopAppendOnly(void) {
9025 flushAppendOnlyFile();
9026 fsync(server.appendfd);
9027 close(server.appendfd);
9028
9029 server.appendfd = -1;
9030 server.appendseldb = -1;
9031 server.appendonly = 0;
9032 /* rewrite operation in progress? kill it, wait child exit */
9033 if (server.bgsavechildpid != -1) {
9034 int statloc;
9035
30dd89b6 9036 if (kill(server.bgsavechildpid,SIGKILL) != -1)
9037 wait3(&statloc,0,NULL);
2e5eb04e 9038 /* reset the buffer accumulating changes while the child saves */
9039 sdsfree(server.bgrewritebuf);
9040 server.bgrewritebuf = sdsempty();
30dd89b6 9041 server.bgsavechildpid = -1;
2e5eb04e 9042 }
9043}
9044
9045/* Called when the user switches from "appendonly no" to "appendonly yes"
9046 * at runtime using the CONFIG command. */
9047static int startAppendOnly(void) {
9048 server.appendonly = 1;
9049 server.lastfsync = time(NULL);
9050 server.appendfd = open(server.appendfilename,O_WRONLY|O_APPEND|O_CREAT,0644);
9051 if (server.appendfd == -1) {
9052 redisLog(REDIS_WARNING,"Used tried to switch on AOF via CONFIG, but I can't open the AOF file: %s",strerror(errno));
9053 return REDIS_ERR;
9054 }
9055 if (rewriteAppendOnlyFileBackground() == REDIS_ERR) {
9056 server.appendonly = 0;
9057 close(server.appendfd);
9058 redisLog(REDIS_WARNING,"Used tried to switch on AOF via CONFIG, I can't trigger a background AOF rewrite operation. Check the above logs for more info about the error.",strerror(errno));
9059 return REDIS_ERR;
9060 }
9061 return REDIS_OK;
9062}
9063
996cb5f7 9064/* =================== Virtual Memory - Blocking Side ====================== */
054e426d 9065
75680a3c 9066static void vmInit(void) {
9067 off_t totsize;
996cb5f7 9068 int pipefds[2];
bcaa7a4f 9069 size_t stacksize;
8b5bb414 9070 struct flock fl;
75680a3c 9071
4ad37480 9072 if (server.vm_max_threads != 0)
9073 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
9074
054e426d 9075 redisLog(REDIS_NOTICE,"Using '%s' as swap file",server.vm_swap_file);
8b5bb414 9076 /* Try to open the old swap file, otherwise create it */
6fa987e3 9077 if ((server.vm_fp = fopen(server.vm_swap_file,"r+b")) == NULL) {
9078 server.vm_fp = fopen(server.vm_swap_file,"w+b");
9079 }
75680a3c 9080 if (server.vm_fp == NULL) {
6fa987e3 9081 redisLog(REDIS_WARNING,
8b5bb414 9082 "Can't open the swap file: %s. Exiting.",
6fa987e3 9083 strerror(errno));
75680a3c 9084 exit(1);
9085 }
9086 server.vm_fd = fileno(server.vm_fp);
8b5bb414 9087 /* Lock the swap file for writing, this is useful in order to avoid
9088 * another instance to use the same swap file for a config error. */
9089 fl.l_type = F_WRLCK;
9090 fl.l_whence = SEEK_SET;
9091 fl.l_start = fl.l_len = 0;
9092 if (fcntl(server.vm_fd,F_SETLK,&fl) == -1) {
9093 redisLog(REDIS_WARNING,
9094 "Can't lock the swap file at '%s': %s. Make sure it is not used by another Redis instance.", server.vm_swap_file, strerror(errno));
9095 exit(1);
9096 }
9097 /* Initialize */
75680a3c 9098 server.vm_next_page = 0;
9099 server.vm_near_pages = 0;
7d98e08c 9100 server.vm_stats_used_pages = 0;
9101 server.vm_stats_swapped_objects = 0;
9102 server.vm_stats_swapouts = 0;
9103 server.vm_stats_swapins = 0;
75680a3c 9104 totsize = server.vm_pages*server.vm_page_size;
9105 redisLog(REDIS_NOTICE,"Allocating %lld bytes of swap file",totsize);
9106 if (ftruncate(server.vm_fd,totsize) == -1) {
9107 redisLog(REDIS_WARNING,"Can't ftruncate swap file: %s. Exiting.",
9108 strerror(errno));
9109 exit(1);
9110 } else {
9111 redisLog(REDIS_NOTICE,"Swap file allocated with success");
9112 }
7d30035d 9113 server.vm_bitmap = zmalloc((server.vm_pages+7)/8);
f870935d 9114 redisLog(REDIS_VERBOSE,"Allocated %lld bytes page table for %lld pages",
4ef8de8a 9115 (long long) (server.vm_pages+7)/8, server.vm_pages);
7d30035d 9116 memset(server.vm_bitmap,0,(server.vm_pages+7)/8);
92f8e882 9117
996cb5f7 9118 /* Initialize threaded I/O (used by Virtual Memory) */
9119 server.io_newjobs = listCreate();
9120 server.io_processing = listCreate();
9121 server.io_processed = listCreate();
d5d55fc3 9122 server.io_ready_clients = listCreate();
92f8e882 9123 pthread_mutex_init(&server.io_mutex,NULL);
a5819310 9124 pthread_mutex_init(&server.obj_freelist_mutex,NULL);
9125 pthread_mutex_init(&server.io_swapfile_mutex,NULL);
92f8e882 9126 server.io_active_threads = 0;
996cb5f7 9127 if (pipe(pipefds) == -1) {
9128 redisLog(REDIS_WARNING,"Unable to intialized VM: pipe(2): %s. Exiting."
9129 ,strerror(errno));
9130 exit(1);
9131 }
9132 server.io_ready_pipe_read = pipefds[0];
9133 server.io_ready_pipe_write = pipefds[1];
9134 redisAssert(anetNonBlock(NULL,server.io_ready_pipe_read) != ANET_ERR);
bcaa7a4f 9135 /* LZF requires a lot of stack */
9136 pthread_attr_init(&server.io_threads_attr);
9137 pthread_attr_getstacksize(&server.io_threads_attr, &stacksize);
9138 while (stacksize < REDIS_THREAD_STACK_SIZE) stacksize *= 2;
9139 pthread_attr_setstacksize(&server.io_threads_attr, stacksize);
b9bc0eef 9140 /* Listen for events in the threaded I/O pipe */
9141 if (aeCreateFileEvent(server.el, server.io_ready_pipe_read, AE_READABLE,
9142 vmThreadedIOCompletedJob, NULL) == AE_ERR)
9143 oom("creating file event");
75680a3c 9144}
9145
06224fec 9146/* Mark the page as used */
9147static void vmMarkPageUsed(off_t page) {
9148 off_t byte = page/8;
9149 int bit = page&7;
970e10bb 9150 redisAssert(vmFreePage(page) == 1);
06224fec 9151 server.vm_bitmap[byte] |= 1<<bit;
9152}
9153
9154/* Mark N contiguous pages as used, with 'page' being the first. */
9155static void vmMarkPagesUsed(off_t page, off_t count) {
9156 off_t j;
9157
9158 for (j = 0; j < count; j++)
7d30035d 9159 vmMarkPageUsed(page+j);
7d98e08c 9160 server.vm_stats_used_pages += count;
7c775e09 9161 redisLog(REDIS_DEBUG,"Mark USED pages: %lld pages at %lld\n",
9162 (long long)count, (long long)page);
06224fec 9163}
9164
9165/* Mark the page as free */
9166static void vmMarkPageFree(off_t page) {
9167 off_t byte = page/8;
9168 int bit = page&7;
970e10bb 9169 redisAssert(vmFreePage(page) == 0);
06224fec 9170 server.vm_bitmap[byte] &= ~(1<<bit);
9171}
9172
9173/* Mark N contiguous pages as free, with 'page' being the first. */
9174static void vmMarkPagesFree(off_t page, off_t count) {
9175 off_t j;
9176
9177 for (j = 0; j < count; j++)
7d30035d 9178 vmMarkPageFree(page+j);
7d98e08c 9179 server.vm_stats_used_pages -= count;
7c775e09 9180 redisLog(REDIS_DEBUG,"Mark FREE pages: %lld pages at %lld\n",
9181 (long long)count, (long long)page);
06224fec 9182}
9183
9184/* Test if the page is free */
9185static int vmFreePage(off_t page) {
9186 off_t byte = page/8;
9187 int bit = page&7;
7d30035d 9188 return (server.vm_bitmap[byte] & (1<<bit)) == 0;
06224fec 9189}
9190
9191/* Find N contiguous free pages storing the first page of the cluster in *first.
e0a62c7f 9192 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
3a66edc7 9193 * REDIS_ERR is returned.
06224fec 9194 *
9195 * This function uses a simple algorithm: we try to allocate
9196 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
9197 * again from the start of the swap file searching for free spaces.
9198 *
9199 * If it looks pretty clear that there are no free pages near our offset
9200 * we try to find less populated places doing a forward jump of
9201 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
9202 * without hurry, and then we jump again and so forth...
e0a62c7f 9203 *
06224fec 9204 * This function can be improved using a free list to avoid to guess
9205 * too much, since we could collect data about freed pages.
9206 *
9207 * note: I implemented this function just after watching an episode of
9208 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
9209 */
c7df85a4 9210static int vmFindContiguousPages(off_t *first, off_t n) {
06224fec 9211 off_t base, offset = 0, since_jump = 0, numfree = 0;
9212
9213 if (server.vm_near_pages == REDIS_VM_MAX_NEAR_PAGES) {
9214 server.vm_near_pages = 0;
9215 server.vm_next_page = 0;
9216 }
9217 server.vm_near_pages++; /* Yet another try for pages near to the old ones */
9218 base = server.vm_next_page;
9219
9220 while(offset < server.vm_pages) {
9221 off_t this = base+offset;
9222
9223 /* If we overflow, restart from page zero */
9224 if (this >= server.vm_pages) {
9225 this -= server.vm_pages;
9226 if (this == 0) {
9227 /* Just overflowed, what we found on tail is no longer
9228 * interesting, as it's no longer contiguous. */
9229 numfree = 0;
9230 }
9231 }
9232 if (vmFreePage(this)) {
9233 /* This is a free page */
9234 numfree++;
9235 /* Already got N free pages? Return to the caller, with success */
9236 if (numfree == n) {
7d30035d 9237 *first = this-(n-1);
9238 server.vm_next_page = this+1;
7c775e09 9239 redisLog(REDIS_DEBUG, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n, (long long) *first);
3a66edc7 9240 return REDIS_OK;
06224fec 9241 }
9242 } else {
9243 /* The current one is not a free page */
9244 numfree = 0;
9245 }
9246
9247 /* Fast-forward if the current page is not free and we already
9248 * searched enough near this place. */
9249 since_jump++;
9250 if (!numfree && since_jump >= REDIS_VM_MAX_RANDOM_JUMP/4) {
9251 offset += random() % REDIS_VM_MAX_RANDOM_JUMP;
9252 since_jump = 0;
9253 /* Note that even if we rewind after the jump, we are don't need
9254 * to make sure numfree is set to zero as we only jump *if* it
9255 * is set to zero. */
9256 } else {
9257 /* Otherwise just check the next page */
9258 offset++;
9259 }
9260 }
3a66edc7 9261 return REDIS_ERR;
9262}
9263
a5819310 9264/* Write the specified object at the specified page of the swap file */
9265static int vmWriteObjectOnSwap(robj *o, off_t page) {
9266 if (server.vm_enabled) pthread_mutex_lock(&server.io_swapfile_mutex);
9267 if (fseeko(server.vm_fp,page*server.vm_page_size,SEEK_SET) == -1) {
9268 if (server.vm_enabled) pthread_mutex_unlock(&server.io_swapfile_mutex);
9269 redisLog(REDIS_WARNING,
9ebed7cf 9270 "Critical VM problem in vmWriteObjectOnSwap(): can't seek: %s",
a5819310 9271 strerror(errno));
9272 return REDIS_ERR;
9273 }
9274 rdbSaveObject(server.vm_fp,o);
ba76a8f9 9275 fflush(server.vm_fp);
a5819310 9276 if (server.vm_enabled) pthread_mutex_unlock(&server.io_swapfile_mutex);
9277 return REDIS_OK;
9278}
9279
3a66edc7 9280/* Swap the 'val' object relative to 'key' into disk. Store all the information
9281 * needed to later retrieve the object into the key object.
9282 * If we can't find enough contiguous empty pages to swap the object on disk
9283 * REDIS_ERR is returned. */
a69a0c9c 9284static int vmSwapObjectBlocking(robj *key, robj *val) {
b9bc0eef 9285 off_t pages = rdbSavedObjectPages(val,NULL);
3a66edc7 9286 off_t page;
9287
9288 assert(key->storage == REDIS_VM_MEMORY);
4ef8de8a 9289 assert(key->refcount == 1);
3a66edc7 9290 if (vmFindContiguousPages(&page,pages) == REDIS_ERR) return REDIS_ERR;
a5819310 9291 if (vmWriteObjectOnSwap(val,page) == REDIS_ERR) return REDIS_ERR;
3a66edc7 9292 key->vm.page = page;
9293 key->vm.usedpages = pages;
9294 key->storage = REDIS_VM_SWAPPED;
d894161b 9295 key->vtype = val->type;
3a66edc7 9296 decrRefCount(val); /* Deallocate the object from memory. */
9297 vmMarkPagesUsed(page,pages);
7d30035d 9298 redisLog(REDIS_DEBUG,"VM: object %s swapped out at %lld (%lld pages)",
9299 (unsigned char*) key->ptr,
9300 (unsigned long long) page, (unsigned long long) pages);
7d98e08c 9301 server.vm_stats_swapped_objects++;
9302 server.vm_stats_swapouts++;
3a66edc7 9303 return REDIS_OK;
9304}
9305
a5819310 9306static robj *vmReadObjectFromSwap(off_t page, int type) {
9307 robj *o;
3a66edc7 9308
a5819310 9309 if (server.vm_enabled) pthread_mutex_lock(&server.io_swapfile_mutex);
9310 if (fseeko(server.vm_fp,page*server.vm_page_size,SEEK_SET) == -1) {
3a66edc7 9311 redisLog(REDIS_WARNING,
d5d55fc3 9312 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
3a66edc7 9313 strerror(errno));
478c2c6f 9314 _exit(1);
3a66edc7 9315 }
a5819310 9316 o = rdbLoadObject(type,server.vm_fp);
9317 if (o == NULL) {
d5d55fc3 9318 redisLog(REDIS_WARNING, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno));
478c2c6f 9319 _exit(1);
3a66edc7 9320 }
a5819310 9321 if (server.vm_enabled) pthread_mutex_unlock(&server.io_swapfile_mutex);
9322 return o;
9323}
9324
9325/* Load the value object relative to the 'key' object from swap to memory.
9326 * The newly allocated object is returned.
9327 *
9328 * If preview is true the unserialized object is returned to the caller but
9329 * no changes are made to the key object, nor the pages are marked as freed */
9330static robj *vmGenericLoadObject(robj *key, int preview) {
9331 robj *val;
9332
d5d55fc3 9333 redisAssert(key->storage == REDIS_VM_SWAPPED || key->storage == REDIS_VM_LOADING);
a5819310 9334 val = vmReadObjectFromSwap(key->vm.page,key->vtype);
7e69548d 9335 if (!preview) {
9336 key->storage = REDIS_VM_MEMORY;
9337 key->vm.atime = server.unixtime;
9338 vmMarkPagesFree(key->vm.page,key->vm.usedpages);
9339 redisLog(REDIS_DEBUG, "VM: object %s loaded from disk",
9340 (unsigned char*) key->ptr);
7d98e08c 9341 server.vm_stats_swapped_objects--;
38aba9a1 9342 } else {
9343 redisLog(REDIS_DEBUG, "VM: object %s previewed from disk",
9344 (unsigned char*) key->ptr);
7e69548d 9345 }
7d98e08c 9346 server.vm_stats_swapins++;
3a66edc7 9347 return val;
06224fec 9348}
9349
7e69548d 9350/* Plain object loading, from swap to memory */
9351static robj *vmLoadObject(robj *key) {
996cb5f7 9352 /* If we are loading the object in background, stop it, we
9353 * need to load this object synchronously ASAP. */
9354 if (key->storage == REDIS_VM_LOADING)
9355 vmCancelThreadedIOJob(key);
7e69548d 9356 return vmGenericLoadObject(key,0);
9357}
9358
9359/* Just load the value on disk, without to modify the key.
9360 * This is useful when we want to perform some operation on the value
9361 * without to really bring it from swap to memory, like while saving the
9362 * dataset or rewriting the append only log. */
9363static robj *vmPreviewObject(robj *key) {
9364 return vmGenericLoadObject(key,1);
9365}
9366
4ef8de8a 9367/* How a good candidate is this object for swapping?
9368 * The better candidate it is, the greater the returned value.
9369 *
9370 * Currently we try to perform a fast estimation of the object size in
9371 * memory, and combine it with aging informations.
9372 *
9373 * Basically swappability = idle-time * log(estimated size)
9374 *
9375 * Bigger objects are preferred over smaller objects, but not
9376 * proportionally, this is why we use the logarithm. This algorithm is
9377 * just a first try and will probably be tuned later. */
9378static double computeObjectSwappability(robj *o) {
9379 time_t age = server.unixtime - o->vm.atime;
9380 long asize = 0;
9381 list *l;
9382 dict *d;
9383 struct dictEntry *de;
9384 int z;
9385
9386 if (age <= 0) return 0;
9387 switch(o->type) {
9388 case REDIS_STRING:
9389 if (o->encoding != REDIS_ENCODING_RAW) {
9390 asize = sizeof(*o);
9391 } else {
9392 asize = sdslen(o->ptr)+sizeof(*o)+sizeof(long)*2;
9393 }
9394 break;
9395 case REDIS_LIST:
9396 l = o->ptr;
9397 listNode *ln = listFirst(l);
9398
9399 asize = sizeof(list);
9400 if (ln) {
9401 robj *ele = ln->value;
9402 long elesize;
9403
9404 elesize = (ele->encoding == REDIS_ENCODING_RAW) ?
9405 (sizeof(*o)+sdslen(ele->ptr)) :
9406 sizeof(*o);
9407 asize += (sizeof(listNode)+elesize)*listLength(l);
9408 }
9409 break;
9410 case REDIS_SET:
9411 case REDIS_ZSET:
9412 z = (o->type == REDIS_ZSET);
9413 d = z ? ((zset*)o->ptr)->dict : o->ptr;
9414
9415 asize = sizeof(dict)+(sizeof(struct dictEntry*)*dictSlots(d));
9416 if (z) asize += sizeof(zset)-sizeof(dict);
9417 if (dictSize(d)) {
9418 long elesize;
9419 robj *ele;
9420
9421 de = dictGetRandomKey(d);
9422 ele = dictGetEntryKey(de);
9423 elesize = (ele->encoding == REDIS_ENCODING_RAW) ?
9424 (sizeof(*o)+sdslen(ele->ptr)) :
9425 sizeof(*o);
9426 asize += (sizeof(struct dictEntry)+elesize)*dictSize(d);
9427 if (z) asize += sizeof(zskiplistNode)*dictSize(d);
9428 }
9429 break;
a97b9060 9430 case REDIS_HASH:
9431 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
9432 unsigned char *p = zipmapRewind((unsigned char*)o->ptr);
9433 unsigned int len = zipmapLen((unsigned char*)o->ptr);
9434 unsigned int klen, vlen;
9435 unsigned char *key, *val;
9436
9437 if ((p = zipmapNext(p,&key,&klen,&val,&vlen)) == NULL) {
9438 klen = 0;
9439 vlen = 0;
9440 }
9441 asize = len*(klen+vlen+3);
9442 } else if (o->encoding == REDIS_ENCODING_HT) {
9443 d = o->ptr;
9444 asize = sizeof(dict)+(sizeof(struct dictEntry*)*dictSlots(d));
9445 if (dictSize(d)) {
9446 long elesize;
9447 robj *ele;
9448
9449 de = dictGetRandomKey(d);
9450 ele = dictGetEntryKey(de);
9451 elesize = (ele->encoding == REDIS_ENCODING_RAW) ?
9452 (sizeof(*o)+sdslen(ele->ptr)) :
9453 sizeof(*o);
9454 ele = dictGetEntryVal(de);
9455 elesize = (ele->encoding == REDIS_ENCODING_RAW) ?
9456 (sizeof(*o)+sdslen(ele->ptr)) :
9457 sizeof(*o);
9458 asize += (sizeof(struct dictEntry)+elesize)*dictSize(d);
9459 }
9460 }
9461 break;
4ef8de8a 9462 }
c8c72447 9463 return (double)age*log(1+asize);
4ef8de8a 9464}
9465
9466/* Try to swap an object that's a good candidate for swapping.
9467 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
a69a0c9c 9468 * to swap any object at all.
9469 *
9470 * If 'usethreaded' is true, Redis will try to swap the object in background
9471 * using I/O threads. */
9472static int vmSwapOneObject(int usethreads) {
4ef8de8a 9473 int j, i;
9474 struct dictEntry *best = NULL;
9475 double best_swappability = 0;
b9bc0eef 9476 redisDb *best_db = NULL;
4ef8de8a 9477 robj *key, *val;
9478
9479 for (j = 0; j < server.dbnum; j++) {
9480 redisDb *db = server.db+j;
b72f6a4b 9481 /* Why maxtries is set to 100?
9482 * Because this way (usually) we'll find 1 object even if just 1% - 2%
9483 * are swappable objects */
b0d8747d 9484 int maxtries = 100;
4ef8de8a 9485
9486 if (dictSize(db->dict) == 0) continue;
9487 for (i = 0; i < 5; i++) {
9488 dictEntry *de;
9489 double swappability;
9490
e3cadb8a 9491 if (maxtries) maxtries--;
4ef8de8a 9492 de = dictGetRandomKey(db->dict);
9493 key = dictGetEntryKey(de);
9494 val = dictGetEntryVal(de);
1064ef87 9495 /* Only swap objects that are currently in memory.
9496 *
9497 * Also don't swap shared objects if threaded VM is on, as we
9498 * try to ensure that the main thread does not touch the
9499 * object while the I/O thread is using it, but we can't
9500 * control other keys without adding additional mutex. */
9501 if (key->storage != REDIS_VM_MEMORY ||
9502 (server.vm_max_threads != 0 && val->refcount != 1)) {
e3cadb8a 9503 if (maxtries) i--; /* don't count this try */
9504 continue;
9505 }
4ef8de8a 9506 swappability = computeObjectSwappability(val);
9507 if (!best || swappability > best_swappability) {
9508 best = de;
9509 best_swappability = swappability;
b9bc0eef 9510 best_db = db;
4ef8de8a 9511 }
9512 }
9513 }
7c775e09 9514 if (best == NULL) return REDIS_ERR;
4ef8de8a 9515 key = dictGetEntryKey(best);
9516 val = dictGetEntryVal(best);
9517
e3cadb8a 9518 redisLog(REDIS_DEBUG,"Key with best swappability: %s, %f",
4ef8de8a 9519 key->ptr, best_swappability);
9520
9521 /* Unshare the key if needed */
9522 if (key->refcount > 1) {
9523 robj *newkey = dupStringObject(key);
9524 decrRefCount(key);
9525 key = dictGetEntryKey(best) = newkey;
9526 }
9527 /* Swap it */
a69a0c9c 9528 if (usethreads) {
b9bc0eef 9529 vmSwapObjectThreaded(key,val,best_db);
4ef8de8a 9530 return REDIS_OK;
9531 } else {
a69a0c9c 9532 if (vmSwapObjectBlocking(key,val) == REDIS_OK) {
9533 dictGetEntryVal(best) = NULL;
9534 return REDIS_OK;
9535 } else {
9536 return REDIS_ERR;
9537 }
4ef8de8a 9538 }
9539}
9540
a69a0c9c 9541static int vmSwapOneObjectBlocking() {
9542 return vmSwapOneObject(0);
9543}
9544
9545static int vmSwapOneObjectThreaded() {
9546 return vmSwapOneObject(1);
9547}
9548
7e69548d 9549/* Return true if it's safe to swap out objects in a given moment.
9550 * Basically we don't want to swap objects out while there is a BGSAVE
9551 * or a BGAEOREWRITE running in backgroud. */
9552static int vmCanSwapOut(void) {
9553 return (server.bgsavechildpid == -1 && server.bgrewritechildpid == -1);
9554}
9555
1b03836c 9556/* Delete a key if swapped. Returns 1 if the key was found, was swapped
9557 * and was deleted. Otherwise 0 is returned. */
9558static int deleteIfSwapped(redisDb *db, robj *key) {
9559 dictEntry *de;
9560 robj *foundkey;
9561
9562 if ((de = dictFind(db->dict,key)) == NULL) return 0;
9563 foundkey = dictGetEntryKey(de);
9564 if (foundkey->storage == REDIS_VM_MEMORY) return 0;
9565 deleteKey(db,key);
9566 return 1;
9567}
9568
996cb5f7 9569/* =================== Virtual Memory - Threaded I/O ======================= */
9570
b9bc0eef 9571static void freeIOJob(iojob *j) {
d5d55fc3 9572 if ((j->type == REDIS_IOJOB_PREPARE_SWAP ||
9573 j->type == REDIS_IOJOB_DO_SWAP ||
9574 j->type == REDIS_IOJOB_LOAD) && j->val != NULL)
b9bc0eef 9575 decrRefCount(j->val);
78ebe4c8 9576 /* We don't decrRefCount the j->key field as we did't incremented
9577 * the count creating IO Jobs. This is because the key field here is
9578 * just used as an indentifier and if a key is removed the Job should
9579 * never be touched again. */
b9bc0eef 9580 zfree(j);
9581}
9582
996cb5f7 9583/* Every time a thread finished a Job, it writes a byte into the write side
9584 * of an unix pipe in order to "awake" the main thread, and this function
9585 * is called. */
9586static void vmThreadedIOCompletedJob(aeEventLoop *el, int fd, void *privdata,
9587 int mask)
9588{
9589 char buf[1];
b0d8747d 9590 int retval, processed = 0, toprocess = -1, trytoswap = 1;
996cb5f7 9591 REDIS_NOTUSED(el);
9592 REDIS_NOTUSED(mask);
9593 REDIS_NOTUSED(privdata);
9594
9595 /* For every byte we read in the read side of the pipe, there is one
9596 * I/O job completed to process. */
9597 while((retval = read(fd,buf,1)) == 1) {
b9bc0eef 9598 iojob *j;
9599 listNode *ln;
9600 robj *key;
9601 struct dictEntry *de;
9602
996cb5f7 9603 redisLog(REDIS_DEBUG,"Processing I/O completed job");
b9bc0eef 9604
9605 /* Get the processed element (the oldest one) */
9606 lockThreadedIO();
1064ef87 9607 assert(listLength(server.io_processed) != 0);
f6c0bba8 9608 if (toprocess == -1) {
9609 toprocess = (listLength(server.io_processed)*REDIS_MAX_COMPLETED_JOBS_PROCESSED)/100;
9610 if (toprocess <= 0) toprocess = 1;
9611 }
b9bc0eef 9612 ln = listFirst(server.io_processed);
9613 j = ln->value;
9614 listDelNode(server.io_processed,ln);
9615 unlockThreadedIO();
9616 /* If this job is marked as canceled, just ignore it */
9617 if (j->canceled) {
9618 freeIOJob(j);
9619 continue;
9620 }
9621 /* Post process it in the main thread, as there are things we
9622 * can do just here to avoid race conditions and/or invasive locks */
6c96ba7d 9623 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 9624 de = dictFind(j->db->dict,j->key);
9625 assert(de != NULL);
9626 key = dictGetEntryKey(de);
9627 if (j->type == REDIS_IOJOB_LOAD) {
d5d55fc3 9628 redisDb *db;
9629
b9bc0eef 9630 /* Key loaded, bring it at home */
9631 key->storage = REDIS_VM_MEMORY;
9632 key->vm.atime = server.unixtime;
9633 vmMarkPagesFree(key->vm.page,key->vm.usedpages);
9634 redisLog(REDIS_DEBUG, "VM: object %s loaded from disk (threaded)",
9635 (unsigned char*) key->ptr);
9636 server.vm_stats_swapped_objects--;
9637 server.vm_stats_swapins++;
d5d55fc3 9638 dictGetEntryVal(de) = j->val;
9639 incrRefCount(j->val);
9640 db = j->db;
b9bc0eef 9641 freeIOJob(j);
d5d55fc3 9642 /* Handle clients waiting for this key to be loaded. */
9643 handleClientsBlockedOnSwappedKey(db,key);
b9bc0eef 9644 } else if (j->type == REDIS_IOJOB_PREPARE_SWAP) {
9645 /* Now we know the amount of pages required to swap this object.
9646 * Let's find some space for it, and queue this task again
9647 * rebranded as REDIS_IOJOB_DO_SWAP. */
054e426d 9648 if (!vmCanSwapOut() ||
9649 vmFindContiguousPages(&j->page,j->pages) == REDIS_ERR)
9650 {
9651 /* Ooops... no space or we can't swap as there is
9652 * a fork()ed Redis trying to save stuff on disk. */
b9bc0eef 9653 freeIOJob(j);
054e426d 9654 key->storage = REDIS_VM_MEMORY; /* undo operation */
b9bc0eef 9655 } else {
c7df85a4 9656 /* Note that we need to mark this pages as used now,
9657 * if the job will be canceled, we'll mark them as freed
9658 * again. */
9659 vmMarkPagesUsed(j->page,j->pages);
b9bc0eef 9660 j->type = REDIS_IOJOB_DO_SWAP;
9661 lockThreadedIO();
9662 queueIOJob(j);
9663 unlockThreadedIO();
9664 }
9665 } else if (j->type == REDIS_IOJOB_DO_SWAP) {
9666 robj *val;
9667
9668 /* Key swapped. We can finally free some memory. */
6c96ba7d 9669 if (key->storage != REDIS_VM_SWAPPING) {
9670 printf("key->storage: %d\n",key->storage);
9671 printf("key->name: %s\n",(char*)key->ptr);
9672 printf("key->refcount: %d\n",key->refcount);
9673 printf("val: %p\n",(void*)j->val);
9674 printf("val->type: %d\n",j->val->type);
9675 printf("val->ptr: %s\n",(char*)j->val->ptr);
9676 }
9677 redisAssert(key->storage == REDIS_VM_SWAPPING);
b9bc0eef 9678 val = dictGetEntryVal(de);
9679 key->vm.page = j->page;
9680 key->vm.usedpages = j->pages;
9681 key->storage = REDIS_VM_SWAPPED;
9682 key->vtype = j->val->type;
9683 decrRefCount(val); /* Deallocate the object from memory. */
f11b8647 9684 dictGetEntryVal(de) = NULL;
b9bc0eef 9685 redisLog(REDIS_DEBUG,
9686 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
9687 (unsigned char*) key->ptr,
9688 (unsigned long long) j->page, (unsigned long long) j->pages);
9689 server.vm_stats_swapped_objects++;
9690 server.vm_stats_swapouts++;
9691 freeIOJob(j);
f11b8647 9692 /* Put a few more swap requests in queue if we are still
9693 * out of memory */
b0d8747d 9694 if (trytoswap && vmCanSwapOut() &&
9695 zmalloc_used_memory() > server.vm_max_memory)
9696 {
f11b8647 9697 int more = 1;
9698 while(more) {
9699 lockThreadedIO();
9700 more = listLength(server.io_newjobs) <
9701 (unsigned) server.vm_max_threads;
9702 unlockThreadedIO();
9703 /* Don't waste CPU time if swappable objects are rare. */
b0d8747d 9704 if (vmSwapOneObjectThreaded() == REDIS_ERR) {
9705 trytoswap = 0;
9706 break;
9707 }
f11b8647 9708 }
9709 }
b9bc0eef 9710 }
c953f24b 9711 processed++;
f6c0bba8 9712 if (processed == toprocess) return;
996cb5f7 9713 }
9714 if (retval < 0 && errno != EAGAIN) {
9715 redisLog(REDIS_WARNING,
9716 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
9717 strerror(errno));
9718 }
9719}
9720
9721static void lockThreadedIO(void) {
9722 pthread_mutex_lock(&server.io_mutex);
9723}
9724
9725static void unlockThreadedIO(void) {
9726 pthread_mutex_unlock(&server.io_mutex);
9727}
9728
9729/* Remove the specified object from the threaded I/O queue if still not
9730 * processed, otherwise make sure to flag it as canceled. */
9731static void vmCancelThreadedIOJob(robj *o) {
9732 list *lists[3] = {
6c96ba7d 9733 server.io_newjobs, /* 0 */
9734 server.io_processing, /* 1 */
9735 server.io_processed /* 2 */
996cb5f7 9736 };
9737 int i;
9738
9739 assert(o->storage == REDIS_VM_LOADING || o->storage == REDIS_VM_SWAPPING);
2e111efe 9740again:
996cb5f7 9741 lockThreadedIO();
9742 /* Search for a matching key in one of the queues */
9743 for (i = 0; i < 3; i++) {
9744 listNode *ln;
c7df85a4 9745 listIter li;
996cb5f7 9746
c7df85a4 9747 listRewind(lists[i],&li);
9748 while ((ln = listNext(&li)) != NULL) {
996cb5f7 9749 iojob *job = ln->value;
9750
6c96ba7d 9751 if (job->canceled) continue; /* Skip this, already canceled. */
78ebe4c8 9752 if (job->key == o) {
970e10bb 9753 redisLog(REDIS_DEBUG,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
9754 (void*)job, (char*)o->ptr, job->type, i);
427a2153 9755 /* Mark the pages as free since the swap didn't happened
9756 * or happened but is now discarded. */
970e10bb 9757 if (i != 1 && job->type == REDIS_IOJOB_DO_SWAP)
427a2153 9758 vmMarkPagesFree(job->page,job->pages);
9759 /* Cancel the job. It depends on the list the job is
9760 * living in. */
996cb5f7 9761 switch(i) {
9762 case 0: /* io_newjobs */
6c96ba7d 9763 /* If the job was yet not processed the best thing to do
996cb5f7 9764 * is to remove it from the queue at all */
6c96ba7d 9765 freeIOJob(job);
996cb5f7 9766 listDelNode(lists[i],ln);
9767 break;
9768 case 1: /* io_processing */
d5d55fc3 9769 /* Oh Shi- the thread is messing with the Job:
9770 *
9771 * Probably it's accessing the object if this is a
9772 * PREPARE_SWAP or DO_SWAP job.
9773 * If it's a LOAD job it may be reading from disk and
9774 * if we don't wait for the job to terminate before to
9775 * cancel it, maybe in a few microseconds data can be
9776 * corrupted in this pages. So the short story is:
9777 *
9778 * Better to wait for the job to move into the
9779 * next queue (processed)... */
9780
9781 /* We try again and again until the job is completed. */
9782 unlockThreadedIO();
9783 /* But let's wait some time for the I/O thread
9784 * to finish with this job. After all this condition
9785 * should be very rare. */
9786 usleep(1);
9787 goto again;
996cb5f7 9788 case 2: /* io_processed */
2e111efe 9789 /* The job was already processed, that's easy...
9790 * just mark it as canceled so that we'll ignore it
9791 * when processing completed jobs. */
996cb5f7 9792 job->canceled = 1;
9793 break;
9794 }
c7df85a4 9795 /* Finally we have to adjust the storage type of the object
9796 * in order to "UNDO" the operaiton. */
996cb5f7 9797 if (o->storage == REDIS_VM_LOADING)
9798 o->storage = REDIS_VM_SWAPPED;
9799 else if (o->storage == REDIS_VM_SWAPPING)
9800 o->storage = REDIS_VM_MEMORY;
9801 unlockThreadedIO();
9802 return;
9803 }
9804 }
9805 }
9806 unlockThreadedIO();
9807 assert(1 != 1); /* We should never reach this */
9808}
9809
b9bc0eef 9810static void *IOThreadEntryPoint(void *arg) {
9811 iojob *j;
9812 listNode *ln;
9813 REDIS_NOTUSED(arg);
9814
9815 pthread_detach(pthread_self());
9816 while(1) {
9817 /* Get a new job to process */
9818 lockThreadedIO();
9819 if (listLength(server.io_newjobs) == 0) {
9820 /* No new jobs in queue, exit. */
9ebed7cf 9821 redisLog(REDIS_DEBUG,"Thread %ld exiting, nothing to do",
9822 (long) pthread_self());
b9bc0eef 9823 server.io_active_threads--;
9824 unlockThreadedIO();
9825 return NULL;
9826 }
9827 ln = listFirst(server.io_newjobs);
9828 j = ln->value;
9829 listDelNode(server.io_newjobs,ln);
9830 /* Add the job in the processing queue */
9831 j->thread = pthread_self();
9832 listAddNodeTail(server.io_processing,j);
9833 ln = listLast(server.io_processing); /* We use ln later to remove it */
9834 unlockThreadedIO();
9ebed7cf 9835 redisLog(REDIS_DEBUG,"Thread %ld got a new job (type %d): %p about key '%s'",
9836 (long) pthread_self(), j->type, (void*)j, (char*)j->key->ptr);
b9bc0eef 9837
9838 /* Process the Job */
9839 if (j->type == REDIS_IOJOB_LOAD) {
d5d55fc3 9840 j->val = vmReadObjectFromSwap(j->page,j->key->vtype);
b9bc0eef 9841 } else if (j->type == REDIS_IOJOB_PREPARE_SWAP) {
9842 FILE *fp = fopen("/dev/null","w+");
9843 j->pages = rdbSavedObjectPages(j->val,fp);
9844 fclose(fp);
9845 } else if (j->type == REDIS_IOJOB_DO_SWAP) {
a5819310 9846 if (vmWriteObjectOnSwap(j->val,j->page) == REDIS_ERR)
9847 j->canceled = 1;
b9bc0eef 9848 }
9849
9850 /* Done: insert the job into the processed queue */
9ebed7cf 9851 redisLog(REDIS_DEBUG,"Thread %ld completed the job: %p (key %s)",
9852 (long) pthread_self(), (void*)j, (char*)j->key->ptr);
b9bc0eef 9853 lockThreadedIO();
9854 listDelNode(server.io_processing,ln);
9855 listAddNodeTail(server.io_processed,j);
9856 unlockThreadedIO();
e0a62c7f 9857
b9bc0eef 9858 /* Signal the main thread there is new stuff to process */
9859 assert(write(server.io_ready_pipe_write,"x",1) == 1);
9860 }
9861 return NULL; /* never reached */
9862}
9863
9864static void spawnIOThread(void) {
9865 pthread_t thread;
478c2c6f 9866 sigset_t mask, omask;
a97b9060 9867 int err;
b9bc0eef 9868
478c2c6f 9869 sigemptyset(&mask);
9870 sigaddset(&mask,SIGCHLD);
9871 sigaddset(&mask,SIGHUP);
9872 sigaddset(&mask,SIGPIPE);
9873 pthread_sigmask(SIG_SETMASK, &mask, &omask);
a97b9060 9874 while ((err = pthread_create(&thread,&server.io_threads_attr,IOThreadEntryPoint,NULL)) != 0) {
9875 redisLog(REDIS_WARNING,"Unable to spawn an I/O thread: %s",
9876 strerror(err));
9877 usleep(1000000);
9878 }
478c2c6f 9879 pthread_sigmask(SIG_SETMASK, &omask, NULL);
b9bc0eef 9880 server.io_active_threads++;
9881}
9882
4ee9488d 9883/* We need to wait for the last thread to exit before we are able to
9884 * fork() in order to BGSAVE or BGREWRITEAOF. */
054e426d 9885static void waitEmptyIOJobsQueue(void) {
4ee9488d 9886 while(1) {
76b7233a 9887 int io_processed_len;
9888
4ee9488d 9889 lockThreadedIO();
054e426d 9890 if (listLength(server.io_newjobs) == 0 &&
9891 listLength(server.io_processing) == 0 &&
9892 server.io_active_threads == 0)
9893 {
4ee9488d 9894 unlockThreadedIO();
9895 return;
9896 }
76b7233a 9897 /* While waiting for empty jobs queue condition we post-process some
9898 * finshed job, as I/O threads may be hanging trying to write against
9899 * the io_ready_pipe_write FD but there are so much pending jobs that
9900 * it's blocking. */
9901 io_processed_len = listLength(server.io_processed);
4ee9488d 9902 unlockThreadedIO();
76b7233a 9903 if (io_processed_len) {
9904 vmThreadedIOCompletedJob(NULL,server.io_ready_pipe_read,NULL,0);
9905 usleep(1000); /* 1 millisecond */
9906 } else {
9907 usleep(10000); /* 10 milliseconds */
9908 }
4ee9488d 9909 }
9910}
9911
054e426d 9912static void vmReopenSwapFile(void) {
478c2c6f 9913 /* Note: we don't close the old one as we are in the child process
9914 * and don't want to mess at all with the original file object. */
054e426d 9915 server.vm_fp = fopen(server.vm_swap_file,"r+b");
9916 if (server.vm_fp == NULL) {
9917 redisLog(REDIS_WARNING,"Can't re-open the VM swap file: %s. Exiting.",
9918 server.vm_swap_file);
478c2c6f 9919 _exit(1);
054e426d 9920 }
9921 server.vm_fd = fileno(server.vm_fp);
9922}
9923
b9bc0eef 9924/* This function must be called while with threaded IO locked */
9925static void queueIOJob(iojob *j) {
6c96ba7d 9926 redisLog(REDIS_DEBUG,"Queued IO Job %p type %d about key '%s'\n",
9927 (void*)j, j->type, (char*)j->key->ptr);
b9bc0eef 9928 listAddNodeTail(server.io_newjobs,j);
9929 if (server.io_active_threads < server.vm_max_threads)
9930 spawnIOThread();
9931}
9932
9933static int vmSwapObjectThreaded(robj *key, robj *val, redisDb *db) {
9934 iojob *j;
e0a62c7f 9935
b9bc0eef 9936 assert(key->storage == REDIS_VM_MEMORY);
9937 assert(key->refcount == 1);
9938
9939 j = zmalloc(sizeof(*j));
9940 j->type = REDIS_IOJOB_PREPARE_SWAP;
9941 j->db = db;
78ebe4c8 9942 j->key = key;
b9bc0eef 9943 j->val = val;
9944 incrRefCount(val);
9945 j->canceled = 0;
9946 j->thread = (pthread_t) -1;
f11b8647 9947 key->storage = REDIS_VM_SWAPPING;
b9bc0eef 9948
9949 lockThreadedIO();
9950 queueIOJob(j);
9951 unlockThreadedIO();
9952 return REDIS_OK;
9953}
9954
b0d8747d 9955/* ============ Virtual Memory - Blocking clients on missing keys =========== */
9956
d5d55fc3 9957/* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
9958 * If there is not already a job loading the key, it is craeted.
9959 * The key is added to the io_keys list in the client structure, and also
9960 * in the hash table mapping swapped keys to waiting clients, that is,
9961 * server.io_waited_keys. */
9962static int waitForSwappedKey(redisClient *c, robj *key) {
9963 struct dictEntry *de;
9964 robj *o;
9965 list *l;
9966
9967 /* If the key does not exist or is already in RAM we don't need to
9968 * block the client at all. */
9969 de = dictFind(c->db->dict,key);
9970 if (de == NULL) return 0;
9971 o = dictGetEntryKey(de);
9972 if (o->storage == REDIS_VM_MEMORY) {
9973 return 0;
9974 } else if (o->storage == REDIS_VM_SWAPPING) {
9975 /* We were swapping the key, undo it! */
9976 vmCancelThreadedIOJob(o);
9977 return 0;
9978 }
e0a62c7f 9979
d5d55fc3 9980 /* OK: the key is either swapped, or being loaded just now. */
9981
9982 /* Add the key to the list of keys this client is waiting for.
9983 * This maps clients to keys they are waiting for. */
9984 listAddNodeTail(c->io_keys,key);
9985 incrRefCount(key);
9986
9987 /* Add the client to the swapped keys => clients waiting map. */
9988 de = dictFind(c->db->io_keys,key);
9989 if (de == NULL) {
9990 int retval;
9991
9992 /* For every key we take a list of clients blocked for it */
9993 l = listCreate();
9994 retval = dictAdd(c->db->io_keys,key,l);
9995 incrRefCount(key);
9996 assert(retval == DICT_OK);
9997 } else {
9998 l = dictGetEntryVal(de);
9999 }
10000 listAddNodeTail(l,c);
10001
10002 /* Are we already loading the key from disk? If not create a job */
10003 if (o->storage == REDIS_VM_SWAPPED) {
10004 iojob *j;
10005
10006 o->storage = REDIS_VM_LOADING;
10007 j = zmalloc(sizeof(*j));
10008 j->type = REDIS_IOJOB_LOAD;
10009 j->db = c->db;
78ebe4c8 10010 j->key = o;
d5d55fc3 10011 j->key->vtype = o->vtype;
10012 j->page = o->vm.page;
10013 j->val = NULL;
10014 j->canceled = 0;
10015 j->thread = (pthread_t) -1;
10016 lockThreadedIO();
10017 queueIOJob(j);
10018 unlockThreadedIO();
10019 }
10020 return 1;
10021}
10022
6f078746
PN
10023/* Preload keys for any command with first, last and step values for
10024 * the command keys prototype, as defined in the command table. */
10025static void waitForMultipleSwappedKeys(redisClient *c, struct redisCommand *cmd, int argc, robj **argv) {
10026 int j, last;
10027 if (cmd->vm_firstkey == 0) return;
10028 last = cmd->vm_lastkey;
10029 if (last < 0) last = argc+last;
10030 for (j = cmd->vm_firstkey; j <= last; j += cmd->vm_keystep) {
10031 redisAssert(j < argc);
10032 waitForSwappedKey(c,argv[j]);
10033 }
10034}
10035
5d373da9 10036/* Preload keys needed for the ZUNIONSTORE and ZINTERSTORE commands.
739ba0d2
PN
10037 * Note that the number of keys to preload is user-defined, so we need to
10038 * apply a sanity check against argc. */
ca1788b5 10039static void zunionInterBlockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd, int argc, robj **argv) {
76583ea4 10040 int i, num;
ca1788b5 10041 REDIS_NOTUSED(cmd);
ca1788b5
PN
10042
10043 num = atoi(argv[2]->ptr);
739ba0d2 10044 if (num > (argc-3)) return;
76583ea4 10045 for (i = 0; i < num; i++) {
ca1788b5 10046 waitForSwappedKey(c,argv[3+i]);
76583ea4
PN
10047 }
10048}
10049
3805e04f
PN
10050/* Preload keys needed to execute the entire MULTI/EXEC block.
10051 *
10052 * This function is called by blockClientOnSwappedKeys when EXEC is issued,
10053 * and will block the client when any command requires a swapped out value. */
10054static void execBlockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd, int argc, robj **argv) {
10055 int i, margc;
10056 struct redisCommand *mcmd;
10057 robj **margv;
10058 REDIS_NOTUSED(cmd);
10059 REDIS_NOTUSED(argc);
10060 REDIS_NOTUSED(argv);
10061
10062 if (!(c->flags & REDIS_MULTI)) return;
10063 for (i = 0; i < c->mstate.count; i++) {
10064 mcmd = c->mstate.commands[i].cmd;
10065 margc = c->mstate.commands[i].argc;
10066 margv = c->mstate.commands[i].argv;
10067
10068 if (mcmd->vm_preload_proc != NULL) {
10069 mcmd->vm_preload_proc(c,mcmd,margc,margv);
10070 } else {
10071 waitForMultipleSwappedKeys(c,mcmd,margc,margv);
10072 }
76583ea4
PN
10073 }
10074}
10075
b0d8747d 10076/* Is this client attempting to run a command against swapped keys?
d5d55fc3 10077 * If so, block it ASAP, load the keys in background, then resume it.
b0d8747d 10078 *
d5d55fc3 10079 * The important idea about this function is that it can fail! If keys will
10080 * still be swapped when the client is resumed, this key lookups will
10081 * just block loading keys from disk. In practical terms this should only
10082 * happen with SORT BY command or if there is a bug in this function.
10083 *
10084 * Return 1 if the client is marked as blocked, 0 if the client can
10085 * continue as the keys it is going to access appear to be in memory. */
0a6f3f0f 10086static int blockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd) {
76583ea4 10087 if (cmd->vm_preload_proc != NULL) {
ca1788b5 10088 cmd->vm_preload_proc(c,cmd,c->argc,c->argv);
76583ea4 10089 } else {
6f078746 10090 waitForMultipleSwappedKeys(c,cmd,c->argc,c->argv);
76583ea4
PN
10091 }
10092
d5d55fc3 10093 /* If the client was blocked for at least one key, mark it as blocked. */
10094 if (listLength(c->io_keys)) {
10095 c->flags |= REDIS_IO_WAIT;
10096 aeDeleteFileEvent(server.el,c->fd,AE_READABLE);
10097 server.vm_blocked_clients++;
10098 return 1;
10099 } else {
10100 return 0;
10101 }
10102}
10103
10104/* Remove the 'key' from the list of blocked keys for a given client.
10105 *
10106 * The function returns 1 when there are no longer blocking keys after
10107 * the current one was removed (and the client can be unblocked). */
10108static int dontWaitForSwappedKey(redisClient *c, robj *key) {
10109 list *l;
10110 listNode *ln;
10111 listIter li;
10112 struct dictEntry *de;
10113
10114 /* Remove the key from the list of keys this client is waiting for. */
10115 listRewind(c->io_keys,&li);
10116 while ((ln = listNext(&li)) != NULL) {
bf028098 10117 if (equalStringObjects(ln->value,key)) {
d5d55fc3 10118 listDelNode(c->io_keys,ln);
10119 break;
10120 }
10121 }
10122 assert(ln != NULL);
10123
10124 /* Remove the client form the key => waiting clients map. */
10125 de = dictFind(c->db->io_keys,key);
10126 assert(de != NULL);
10127 l = dictGetEntryVal(de);
10128 ln = listSearchKey(l,c);
10129 assert(ln != NULL);
10130 listDelNode(l,ln);
10131 if (listLength(l) == 0)
10132 dictDelete(c->db->io_keys,key);
10133
10134 return listLength(c->io_keys) == 0;
10135}
10136
10137static void handleClientsBlockedOnSwappedKey(redisDb *db, robj *key) {
10138 struct dictEntry *de;
10139 list *l;
10140 listNode *ln;
10141 int len;
10142
10143 de = dictFind(db->io_keys,key);
10144 if (!de) return;
10145
10146 l = dictGetEntryVal(de);
10147 len = listLength(l);
10148 /* Note: we can't use something like while(listLength(l)) as the list
10149 * can be freed by the calling function when we remove the last element. */
10150 while (len--) {
10151 ln = listFirst(l);
10152 redisClient *c = ln->value;
10153
10154 if (dontWaitForSwappedKey(c,key)) {
10155 /* Put the client in the list of clients ready to go as we
10156 * loaded all the keys about it. */
10157 listAddNodeTail(server.io_ready_clients,c);
10158 }
10159 }
b0d8747d 10160}
b0d8747d 10161
500ece7c 10162/* =========================== Remote Configuration ========================= */
10163
10164static void configSetCommand(redisClient *c) {
10165 robj *o = getDecodedObject(c->argv[3]);
2e5eb04e 10166 long long ll;
10167
500ece7c 10168 if (!strcasecmp(c->argv[2]->ptr,"dbfilename")) {
10169 zfree(server.dbfilename);
10170 server.dbfilename = zstrdup(o->ptr);
10171 } else if (!strcasecmp(c->argv[2]->ptr,"requirepass")) {
10172 zfree(server.requirepass);
10173 server.requirepass = zstrdup(o->ptr);
10174 } else if (!strcasecmp(c->argv[2]->ptr,"masterauth")) {
10175 zfree(server.masterauth);
10176 server.masterauth = zstrdup(o->ptr);
10177 } else if (!strcasecmp(c->argv[2]->ptr,"maxmemory")) {
2e5eb04e 10178 if (getLongLongFromObject(o,&ll) == REDIS_ERR ||
10179 ll < 0) goto badfmt;
10180 server.maxmemory = ll;
10181 } else if (!strcasecmp(c->argv[2]->ptr,"timeout")) {
10182 if (getLongLongFromObject(o,&ll) == REDIS_ERR ||
10183 ll < 0 || ll > LONG_MAX) goto badfmt;
10184 server.maxidletime = ll;
1b677732 10185 } else if (!strcasecmp(c->argv[2]->ptr,"appendfsync")) {
10186 if (!strcasecmp(o->ptr,"no")) {
10187 server.appendfsync = APPENDFSYNC_NO;
10188 } else if (!strcasecmp(o->ptr,"everysec")) {
10189 server.appendfsync = APPENDFSYNC_EVERYSEC;
10190 } else if (!strcasecmp(o->ptr,"always")) {
10191 server.appendfsync = APPENDFSYNC_ALWAYS;
10192 } else {
10193 goto badfmt;
10194 }
2e5eb04e 10195 } else if (!strcasecmp(c->argv[2]->ptr,"appendonly")) {
10196 int old = server.appendonly;
10197 int new = yesnotoi(o->ptr);
10198
10199 if (new == -1) goto badfmt;
10200 if (old != new) {
10201 if (new == 0) {
10202 stopAppendOnly();
10203 } else {
10204 if (startAppendOnly() == REDIS_ERR) {
10205 addReplySds(c,sdscatprintf(sdsempty(),
10206 "-ERR Unable to turn on AOF. Check server logs.\r\n"));
10207 decrRefCount(o);
10208 return;
10209 }
10210 }
10211 }
a34e0a25 10212 } else if (!strcasecmp(c->argv[2]->ptr,"save")) {
10213 int vlen, j;
10214 sds *v = sdssplitlen(o->ptr,sdslen(o->ptr)," ",1,&vlen);
10215
10216 /* Perform sanity check before setting the new config:
10217 * - Even number of args
10218 * - Seconds >= 1, changes >= 0 */
10219 if (vlen & 1) {
10220 sdsfreesplitres(v,vlen);
10221 goto badfmt;
10222 }
10223 for (j = 0; j < vlen; j++) {
10224 char *eptr;
10225 long val;
10226
10227 val = strtoll(v[j], &eptr, 10);
10228 if (eptr[0] != '\0' ||
10229 ((j & 1) == 0 && val < 1) ||
10230 ((j & 1) == 1 && val < 0)) {
10231 sdsfreesplitres(v,vlen);
10232 goto badfmt;
10233 }
10234 }
10235 /* Finally set the new config */
10236 resetServerSaveParams();
10237 for (j = 0; j < vlen; j += 2) {
10238 time_t seconds;
10239 int changes;
10240
10241 seconds = strtoll(v[j],NULL,10);
10242 changes = strtoll(v[j+1],NULL,10);
10243 appendServerSaveParams(seconds, changes);
10244 }
10245 sdsfreesplitres(v,vlen);
500ece7c 10246 } else {
10247 addReplySds(c,sdscatprintf(sdsempty(),
10248 "-ERR not supported CONFIG parameter %s\r\n",
10249 (char*)c->argv[2]->ptr));
10250 decrRefCount(o);
10251 return;
10252 }
10253 decrRefCount(o);
10254 addReply(c,shared.ok);
a34e0a25 10255 return;
10256
10257badfmt: /* Bad format errors */
10258 addReplySds(c,sdscatprintf(sdsempty(),
10259 "-ERR invalid argument '%s' for CONFIG SET '%s'\r\n",
10260 (char*)o->ptr,
10261 (char*)c->argv[2]->ptr));
10262 decrRefCount(o);
500ece7c 10263}
10264
10265static void configGetCommand(redisClient *c) {
10266 robj *o = getDecodedObject(c->argv[2]);
10267 robj *lenobj = createObject(REDIS_STRING,NULL);
10268 char *pattern = o->ptr;
10269 int matches = 0;
10270
10271 addReply(c,lenobj);
10272 decrRefCount(lenobj);
10273
10274 if (stringmatch(pattern,"dbfilename",0)) {
10275 addReplyBulkCString(c,"dbfilename");
10276 addReplyBulkCString(c,server.dbfilename);
10277 matches++;
10278 }
10279 if (stringmatch(pattern,"requirepass",0)) {
10280 addReplyBulkCString(c,"requirepass");
10281 addReplyBulkCString(c,server.requirepass);
10282 matches++;
10283 }
10284 if (stringmatch(pattern,"masterauth",0)) {
10285 addReplyBulkCString(c,"masterauth");
10286 addReplyBulkCString(c,server.masterauth);
10287 matches++;
10288 }
10289 if (stringmatch(pattern,"maxmemory",0)) {
10290 char buf[128];
10291
2e5eb04e 10292 ll2string(buf,128,server.maxmemory);
500ece7c 10293 addReplyBulkCString(c,"maxmemory");
10294 addReplyBulkCString(c,buf);
10295 matches++;
10296 }
2e5eb04e 10297 if (stringmatch(pattern,"timeout",0)) {
10298 char buf[128];
10299
10300 ll2string(buf,128,server.maxidletime);
10301 addReplyBulkCString(c,"timeout");
10302 addReplyBulkCString(c,buf);
10303 matches++;
10304 }
10305 if (stringmatch(pattern,"appendonly",0)) {
10306 addReplyBulkCString(c,"appendonly");
10307 addReplyBulkCString(c,server.appendonly ? "yes" : "no");
10308 matches++;
10309 }
1b677732 10310 if (stringmatch(pattern,"appendfsync",0)) {
10311 char *policy;
10312
10313 switch(server.appendfsync) {
10314 case APPENDFSYNC_NO: policy = "no"; break;
10315 case APPENDFSYNC_EVERYSEC: policy = "everysec"; break;
10316 case APPENDFSYNC_ALWAYS: policy = "always"; break;
10317 default: policy = "unknown"; break; /* too harmless to panic */
10318 }
10319 addReplyBulkCString(c,"appendfsync");
10320 addReplyBulkCString(c,policy);
10321 matches++;
10322 }
a34e0a25 10323 if (stringmatch(pattern,"save",0)) {
10324 sds buf = sdsempty();
10325 int j;
10326
10327 for (j = 0; j < server.saveparamslen; j++) {
10328 buf = sdscatprintf(buf,"%ld %d",
10329 server.saveparams[j].seconds,
10330 server.saveparams[j].changes);
10331 if (j != server.saveparamslen-1)
10332 buf = sdscatlen(buf," ",1);
10333 }
10334 addReplyBulkCString(c,"save");
10335 addReplyBulkCString(c,buf);
10336 sdsfree(buf);
10337 matches++;
10338 }
500ece7c 10339 decrRefCount(o);
10340 lenobj->ptr = sdscatprintf(sdsempty(),"*%d\r\n",matches*2);
10341}
10342
10343static void configCommand(redisClient *c) {
10344 if (!strcasecmp(c->argv[1]->ptr,"set")) {
10345 if (c->argc != 4) goto badarity;
10346 configSetCommand(c);
10347 } else if (!strcasecmp(c->argv[1]->ptr,"get")) {
10348 if (c->argc != 3) goto badarity;
10349 configGetCommand(c);
10350 } else if (!strcasecmp(c->argv[1]->ptr,"resetstat")) {
10351 if (c->argc != 2) goto badarity;
10352 server.stat_numcommands = 0;
10353 server.stat_numconnections = 0;
10354 server.stat_expiredkeys = 0;
10355 server.stat_starttime = time(NULL);
10356 addReply(c,shared.ok);
10357 } else {
10358 addReplySds(c,sdscatprintf(sdsempty(),
10359 "-ERR CONFIG subcommand must be one of GET, SET, RESETSTAT\r\n"));
10360 }
10361 return;
10362
10363badarity:
10364 addReplySds(c,sdscatprintf(sdsempty(),
10365 "-ERR Wrong number of arguments for CONFIG %s\r\n",
10366 (char*) c->argv[1]->ptr));
10367}
10368
befec3cd 10369/* =========================== Pubsub implementation ======================== */
10370
ffc6b7f8 10371static void freePubsubPattern(void *p) {
10372 pubsubPattern *pat = p;
10373
10374 decrRefCount(pat->pattern);
10375 zfree(pat);
10376}
10377
10378static int listMatchPubsubPattern(void *a, void *b) {
10379 pubsubPattern *pa = a, *pb = b;
10380
10381 return (pa->client == pb->client) &&
bf028098 10382 (equalStringObjects(pa->pattern,pb->pattern));
ffc6b7f8 10383}
10384
10385/* Subscribe a client to a channel. Returns 1 if the operation succeeded, or
10386 * 0 if the client was already subscribed to that channel. */
10387static int pubsubSubscribeChannel(redisClient *c, robj *channel) {
befec3cd 10388 struct dictEntry *de;
10389 list *clients = NULL;
10390 int retval = 0;
10391
ffc6b7f8 10392 /* Add the channel to the client -> channels hash table */
10393 if (dictAdd(c->pubsub_channels,channel,NULL) == DICT_OK) {
befec3cd 10394 retval = 1;
ffc6b7f8 10395 incrRefCount(channel);
10396 /* Add the client to the channel -> list of clients hash table */
10397 de = dictFind(server.pubsub_channels,channel);
befec3cd 10398 if (de == NULL) {
10399 clients = listCreate();
ffc6b7f8 10400 dictAdd(server.pubsub_channels,channel,clients);
10401 incrRefCount(channel);
befec3cd 10402 } else {
10403 clients = dictGetEntryVal(de);
10404 }
10405 listAddNodeTail(clients,c);
10406 }
10407 /* Notify the client */
10408 addReply(c,shared.mbulk3);
10409 addReply(c,shared.subscribebulk);
ffc6b7f8 10410 addReplyBulk(c,channel);
482b672d 10411 addReplyLongLong(c,dictSize(c->pubsub_channels)+listLength(c->pubsub_patterns));
befec3cd 10412 return retval;
10413}
10414
ffc6b7f8 10415/* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
10416 * 0 if the client was not subscribed to the specified channel. */
10417static int pubsubUnsubscribeChannel(redisClient *c, robj *channel, int notify) {
befec3cd 10418 struct dictEntry *de;
10419 list *clients;
10420 listNode *ln;
10421 int retval = 0;
10422
ffc6b7f8 10423 /* Remove the channel from the client -> channels hash table */
10424 incrRefCount(channel); /* channel may be just a pointer to the same object
201037f5 10425 we have in the hash tables. Protect it... */
ffc6b7f8 10426 if (dictDelete(c->pubsub_channels,channel) == DICT_OK) {
befec3cd 10427 retval = 1;
ffc6b7f8 10428 /* Remove the client from the channel -> clients list hash table */
10429 de = dictFind(server.pubsub_channels,channel);
befec3cd 10430 assert(de != NULL);
10431 clients = dictGetEntryVal(de);
10432 ln = listSearchKey(clients,c);
10433 assert(ln != NULL);
10434 listDelNode(clients,ln);
ff767a75 10435 if (listLength(clients) == 0) {
10436 /* Free the list and associated hash entry at all if this was
10437 * the latest client, so that it will be possible to abuse
ffc6b7f8 10438 * Redis PUBSUB creating millions of channels. */
10439 dictDelete(server.pubsub_channels,channel);
ff767a75 10440 }
befec3cd 10441 }
10442 /* Notify the client */
10443 if (notify) {
10444 addReply(c,shared.mbulk3);
10445 addReply(c,shared.unsubscribebulk);
ffc6b7f8 10446 addReplyBulk(c,channel);
482b672d 10447 addReplyLongLong(c,dictSize(c->pubsub_channels)+
ffc6b7f8 10448 listLength(c->pubsub_patterns));
10449
10450 }
10451 decrRefCount(channel); /* it is finally safe to release it */
10452 return retval;
10453}
10454
10455/* Subscribe a client to a pattern. Returns 1 if the operation succeeded, or 0 if the clinet was already subscribed to that pattern. */
10456static int pubsubSubscribePattern(redisClient *c, robj *pattern) {
10457 int retval = 0;
10458
10459 if (listSearchKey(c->pubsub_patterns,pattern) == NULL) {
10460 retval = 1;
10461 pubsubPattern *pat;
10462 listAddNodeTail(c->pubsub_patterns,pattern);
10463 incrRefCount(pattern);
10464 pat = zmalloc(sizeof(*pat));
10465 pat->pattern = getDecodedObject(pattern);
10466 pat->client = c;
10467 listAddNodeTail(server.pubsub_patterns,pat);
10468 }
10469 /* Notify the client */
10470 addReply(c,shared.mbulk3);
10471 addReply(c,shared.psubscribebulk);
10472 addReplyBulk(c,pattern);
482b672d 10473 addReplyLongLong(c,dictSize(c->pubsub_channels)+listLength(c->pubsub_patterns));
ffc6b7f8 10474 return retval;
10475}
10476
10477/* Unsubscribe a client from a channel. Returns 1 if the operation succeeded, or
10478 * 0 if the client was not subscribed to the specified channel. */
10479static int pubsubUnsubscribePattern(redisClient *c, robj *pattern, int notify) {
10480 listNode *ln;
10481 pubsubPattern pat;
10482 int retval = 0;
10483
10484 incrRefCount(pattern); /* Protect the object. May be the same we remove */
10485 if ((ln = listSearchKey(c->pubsub_patterns,pattern)) != NULL) {
10486 retval = 1;
10487 listDelNode(c->pubsub_patterns,ln);
10488 pat.client = c;
10489 pat.pattern = pattern;
10490 ln = listSearchKey(server.pubsub_patterns,&pat);
10491 listDelNode(server.pubsub_patterns,ln);
10492 }
10493 /* Notify the client */
10494 if (notify) {
10495 addReply(c,shared.mbulk3);
10496 addReply(c,shared.punsubscribebulk);
10497 addReplyBulk(c,pattern);
482b672d 10498 addReplyLongLong(c,dictSize(c->pubsub_channels)+
ffc6b7f8 10499 listLength(c->pubsub_patterns));
befec3cd 10500 }
ffc6b7f8 10501 decrRefCount(pattern);
befec3cd 10502 return retval;
10503}
10504
ffc6b7f8 10505/* Unsubscribe from all the channels. Return the number of channels the
10506 * client was subscribed from. */
10507static int pubsubUnsubscribeAllChannels(redisClient *c, int notify) {
10508 dictIterator *di = dictGetIterator(c->pubsub_channels);
befec3cd 10509 dictEntry *de;
10510 int count = 0;
10511
10512 while((de = dictNext(di)) != NULL) {
ffc6b7f8 10513 robj *channel = dictGetEntryKey(de);
befec3cd 10514
ffc6b7f8 10515 count += pubsubUnsubscribeChannel(c,channel,notify);
befec3cd 10516 }
10517 dictReleaseIterator(di);
10518 return count;
10519}
10520
ffc6b7f8 10521/* Unsubscribe from all the patterns. Return the number of patterns the
10522 * client was subscribed from. */
10523static int pubsubUnsubscribeAllPatterns(redisClient *c, int notify) {
10524 listNode *ln;
10525 listIter li;
10526 int count = 0;
10527
10528 listRewind(c->pubsub_patterns,&li);
10529 while ((ln = listNext(&li)) != NULL) {
10530 robj *pattern = ln->value;
10531
10532 count += pubsubUnsubscribePattern(c,pattern,notify);
10533 }
10534 return count;
10535}
10536
befec3cd 10537/* Publish a message */
ffc6b7f8 10538static int pubsubPublishMessage(robj *channel, robj *message) {
befec3cd 10539 int receivers = 0;
10540 struct dictEntry *de;
ffc6b7f8 10541 listNode *ln;
10542 listIter li;
befec3cd 10543
ffc6b7f8 10544 /* Send to clients listening for that channel */
10545 de = dictFind(server.pubsub_channels,channel);
befec3cd 10546 if (de) {
10547 list *list = dictGetEntryVal(de);
10548 listNode *ln;
10549 listIter li;
10550
10551 listRewind(list,&li);
10552 while ((ln = listNext(&li)) != NULL) {
10553 redisClient *c = ln->value;
10554
10555 addReply(c,shared.mbulk3);
10556 addReply(c,shared.messagebulk);
ffc6b7f8 10557 addReplyBulk(c,channel);
befec3cd 10558 addReplyBulk(c,message);
10559 receivers++;
10560 }
10561 }
ffc6b7f8 10562 /* Send to clients listening to matching channels */
10563 if (listLength(server.pubsub_patterns)) {
10564 listRewind(server.pubsub_patterns,&li);
10565 channel = getDecodedObject(channel);
10566 while ((ln = listNext(&li)) != NULL) {
10567 pubsubPattern *pat = ln->value;
10568
10569 if (stringmatchlen((char*)pat->pattern->ptr,
10570 sdslen(pat->pattern->ptr),
10571 (char*)channel->ptr,
10572 sdslen(channel->ptr),0)) {
c8d0ea0e 10573 addReply(pat->client,shared.mbulk4);
10574 addReply(pat->client,shared.pmessagebulk);
10575 addReplyBulk(pat->client,pat->pattern);
ffc6b7f8 10576 addReplyBulk(pat->client,channel);
10577 addReplyBulk(pat->client,message);
10578 receivers++;
10579 }
10580 }
10581 decrRefCount(channel);
10582 }
befec3cd 10583 return receivers;
10584}
10585
10586static void subscribeCommand(redisClient *c) {
10587 int j;
10588
10589 for (j = 1; j < c->argc; j++)
ffc6b7f8 10590 pubsubSubscribeChannel(c,c->argv[j]);
befec3cd 10591}
10592
10593static void unsubscribeCommand(redisClient *c) {
10594 if (c->argc == 1) {
ffc6b7f8 10595 pubsubUnsubscribeAllChannels(c,1);
10596 return;
10597 } else {
10598 int j;
10599
10600 for (j = 1; j < c->argc; j++)
10601 pubsubUnsubscribeChannel(c,c->argv[j],1);
10602 }
10603}
10604
10605static void psubscribeCommand(redisClient *c) {
10606 int j;
10607
10608 for (j = 1; j < c->argc; j++)
10609 pubsubSubscribePattern(c,c->argv[j]);
10610}
10611
10612static void punsubscribeCommand(redisClient *c) {
10613 if (c->argc == 1) {
10614 pubsubUnsubscribeAllPatterns(c,1);
befec3cd 10615 return;
10616 } else {
10617 int j;
10618
10619 for (j = 1; j < c->argc; j++)
ffc6b7f8 10620 pubsubUnsubscribePattern(c,c->argv[j],1);
befec3cd 10621 }
10622}
10623
10624static void publishCommand(redisClient *c) {
10625 int receivers = pubsubPublishMessage(c->argv[1],c->argv[2]);
482b672d 10626 addReplyLongLong(c,receivers);
befec3cd 10627}
10628
37ab76c9 10629/* ===================== WATCH (CAS alike for MULTI/EXEC) ===================
10630 *
10631 * The implementation uses a per-DB hash table mapping keys to list of clients
10632 * WATCHing those keys, so that given a key that is going to be modified
10633 * we can mark all the associated clients as dirty.
10634 *
10635 * Also every client contains a list of WATCHed keys so that's possible to
10636 * un-watch such keys when the client is freed or when UNWATCH is called. */
10637
10638/* In the client->watched_keys list we need to use watchedKey structures
10639 * as in order to identify a key in Redis we need both the key name and the
10640 * DB */
10641typedef struct watchedKey {
10642 robj *key;
10643 redisDb *db;
10644} watchedKey;
10645
10646/* Watch for the specified key */
10647static void watchForKey(redisClient *c, robj *key) {
10648 list *clients = NULL;
10649 listIter li;
10650 listNode *ln;
10651 watchedKey *wk;
10652
10653 /* Check if we are already watching for this key */
10654 listRewind(c->watched_keys,&li);
10655 while((ln = listNext(&li))) {
10656 wk = listNodeValue(ln);
10657 if (wk->db == c->db && equalStringObjects(key,wk->key))
10658 return; /* Key already watched */
10659 }
10660 /* This key is not already watched in this DB. Let's add it */
10661 clients = dictFetchValue(c->db->watched_keys,key);
10662 if (!clients) {
10663 clients = listCreate();
10664 dictAdd(c->db->watched_keys,key,clients);
10665 incrRefCount(key);
10666 }
10667 listAddNodeTail(clients,c);
10668 /* Add the new key to the lits of keys watched by this client */
10669 wk = zmalloc(sizeof(*wk));
10670 wk->key = key;
10671 wk->db = c->db;
10672 incrRefCount(key);
10673 listAddNodeTail(c->watched_keys,wk);
10674}
10675
10676/* Unwatch all the keys watched by this client. To clean the EXEC dirty
10677 * flag is up to the caller. */
10678static void unwatchAllKeys(redisClient *c) {
10679 listIter li;
10680 listNode *ln;
10681
10682 if (listLength(c->watched_keys) == 0) return;
10683 listRewind(c->watched_keys,&li);
10684 while((ln = listNext(&li))) {
10685 list *clients;
10686 watchedKey *wk;
10687
10688 /* Lookup the watched key -> clients list and remove the client
10689 * from the list */
10690 wk = listNodeValue(ln);
10691 clients = dictFetchValue(wk->db->watched_keys, wk->key);
10692 assert(clients != NULL);
10693 listDelNode(clients,listSearchKey(clients,c));
10694 /* Kill the entry at all if this was the only client */
10695 if (listLength(clients) == 0)
10696 dictDelete(wk->db->watched_keys, wk->key);
10697 /* Remove this watched key from the client->watched list */
10698 listDelNode(c->watched_keys,ln);
10699 decrRefCount(wk->key);
10700 zfree(wk);
10701 }
10702}
10703
ca3f830b 10704/* "Touch" a key, so that if this key is being WATCHed by some client the
37ab76c9 10705 * next EXEC will fail. */
10706static void touchWatchedKey(redisDb *db, robj *key) {
10707 list *clients;
10708 listIter li;
10709 listNode *ln;
10710
10711 if (dictSize(db->watched_keys) == 0) return;
10712 clients = dictFetchValue(db->watched_keys, key);
10713 if (!clients) return;
10714
10715 /* Mark all the clients watching this key as REDIS_DIRTY_CAS */
10716 /* Check if we are already watching for this key */
10717 listRewind(clients,&li);
10718 while((ln = listNext(&li))) {
10719 redisClient *c = listNodeValue(ln);
10720
10721 c->flags |= REDIS_DIRTY_CAS;
10722 }
10723}
10724
9b30e1a2 10725/* On FLUSHDB or FLUSHALL all the watched keys that are present before the
10726 * flush but will be deleted as effect of the flushing operation should
10727 * be touched. "dbid" is the DB that's getting the flush. -1 if it is
10728 * a FLUSHALL operation (all the DBs flushed). */
10729static void touchWatchedKeysOnFlush(int dbid) {
10730 listIter li1, li2;
10731 listNode *ln;
10732
10733 /* For every client, check all the waited keys */
10734 listRewind(server.clients,&li1);
10735 while((ln = listNext(&li1))) {
10736 redisClient *c = listNodeValue(ln);
10737 listRewind(c->watched_keys,&li2);
10738 while((ln = listNext(&li2))) {
10739 watchedKey *wk = listNodeValue(ln);
10740
10741 /* For every watched key matching the specified DB, if the
10742 * key exists, mark the client as dirty, as the key will be
10743 * removed. */
10744 if (dbid == -1 || wk->db->id == dbid) {
10745 if (dictFind(wk->db->dict, wk->key) != NULL)
10746 c->flags |= REDIS_DIRTY_CAS;
10747 }
10748 }
10749 }
10750}
10751
37ab76c9 10752static void watchCommand(redisClient *c) {
10753 int j;
10754
6531c94d 10755 if (c->flags & REDIS_MULTI) {
10756 addReplySds(c,sdsnew("-ERR WATCH inside MULTI is not allowed\r\n"));
10757 return;
10758 }
37ab76c9 10759 for (j = 1; j < c->argc; j++)
10760 watchForKey(c,c->argv[j]);
10761 addReply(c,shared.ok);
10762}
10763
10764static void unwatchCommand(redisClient *c) {
10765 unwatchAllKeys(c);
10766 c->flags &= (~REDIS_DIRTY_CAS);
10767 addReply(c,shared.ok);
10768}
10769
7f957c92 10770/* ================================= Debugging ============================== */
10771
ba798261 10772/* Compute the sha1 of string at 's' with 'len' bytes long.
10773 * The SHA1 is then xored againt the string pointed by digest.
10774 * Since xor is commutative, this operation is used in order to
10775 * "add" digests relative to unordered elements.
10776 *
10777 * So digest(a,b,c,d) will be the same of digest(b,a,c,d) */
10778static void xorDigest(unsigned char *digest, void *ptr, size_t len) {
10779 SHA1_CTX ctx;
10780 unsigned char hash[20], *s = ptr;
10781 int j;
10782
10783 SHA1Init(&ctx);
10784 SHA1Update(&ctx,s,len);
10785 SHA1Final(hash,&ctx);
10786
10787 for (j = 0; j < 20; j++)
10788 digest[j] ^= hash[j];
10789}
10790
10791static void xorObjectDigest(unsigned char *digest, robj *o) {
10792 o = getDecodedObject(o);
10793 xorDigest(digest,o->ptr,sdslen(o->ptr));
10794 decrRefCount(o);
10795}
10796
10797/* This function instead of just computing the SHA1 and xoring it
10798 * against diget, also perform the digest of "digest" itself and
10799 * replace the old value with the new one.
10800 *
10801 * So the final digest will be:
10802 *
10803 * digest = SHA1(digest xor SHA1(data))
10804 *
10805 * This function is used every time we want to preserve the order so
10806 * that digest(a,b,c,d) will be different than digest(b,c,d,a)
10807 *
10808 * Also note that mixdigest("foo") followed by mixdigest("bar")
10809 * will lead to a different digest compared to "fo", "obar".
10810 */
10811static void mixDigest(unsigned char *digest, void *ptr, size_t len) {
10812 SHA1_CTX ctx;
10813 char *s = ptr;
10814
10815 xorDigest(digest,s,len);
10816 SHA1Init(&ctx);
10817 SHA1Update(&ctx,digest,20);
10818 SHA1Final(digest,&ctx);
10819}
10820
10821static void mixObjectDigest(unsigned char *digest, robj *o) {
10822 o = getDecodedObject(o);
10823 mixDigest(digest,o->ptr,sdslen(o->ptr));
10824 decrRefCount(o);
10825}
10826
10827/* Compute the dataset digest. Since keys, sets elements, hashes elements
10828 * are not ordered, we use a trick: every aggregate digest is the xor
10829 * of the digests of their elements. This way the order will not change
10830 * the result. For list instead we use a feedback entering the output digest
10831 * as input in order to ensure that a different ordered list will result in
10832 * a different digest. */
10833static void computeDatasetDigest(unsigned char *final) {
10834 unsigned char digest[20];
10835 char buf[128];
10836 dictIterator *di = NULL;
10837 dictEntry *de;
10838 int j;
10839 uint32_t aux;
10840
10841 memset(final,0,20); /* Start with a clean result */
10842
10843 for (j = 0; j < server.dbnum; j++) {
10844 redisDb *db = server.db+j;
10845
10846 if (dictSize(db->dict) == 0) continue;
10847 di = dictGetIterator(db->dict);
10848
10849 /* hash the DB id, so the same dataset moved in a different
10850 * DB will lead to a different digest */
10851 aux = htonl(j);
10852 mixDigest(final,&aux,sizeof(aux));
10853
10854 /* Iterate this DB writing every entry */
10855 while((de = dictNext(di)) != NULL) {
cbae1d34 10856 robj *key, *o, *kcopy;
ba798261 10857 time_t expiretime;
10858
10859 memset(digest,0,20); /* This key-val digest */
10860 key = dictGetEntryKey(de);
cbae1d34 10861
10862 if (!server.vm_enabled) {
10863 mixObjectDigest(digest,key);
ba798261 10864 o = dictGetEntryVal(de);
ba798261 10865 } else {
cbae1d34 10866 /* Don't work with the key directly as when VM is active
10867 * this is unsafe: TODO: fix decrRefCount to check if the
10868 * count really reached 0 to avoid this mess */
10869 kcopy = dupStringObject(key);
10870 mixObjectDigest(digest,kcopy);
10871 o = lookupKeyRead(db,kcopy);
10872 decrRefCount(kcopy);
ba798261 10873 }
10874 aux = htonl(o->type);
10875 mixDigest(digest,&aux,sizeof(aux));
10876 expiretime = getExpire(db,key);
10877
10878 /* Save the key and associated value */
10879 if (o->type == REDIS_STRING) {
10880 mixObjectDigest(digest,o);
10881 } else if (o->type == REDIS_LIST) {
10882 list *list = o->ptr;
10883 listNode *ln;
10884 listIter li;
10885
10886 listRewind(list,&li);
10887 while((ln = listNext(&li))) {
10888 robj *eleobj = listNodeValue(ln);
10889
10890 mixObjectDigest(digest,eleobj);
10891 }
10892 } else if (o->type == REDIS_SET) {
10893 dict *set = o->ptr;
10894 dictIterator *di = dictGetIterator(set);
10895 dictEntry *de;
10896
10897 while((de = dictNext(di)) != NULL) {
10898 robj *eleobj = dictGetEntryKey(de);
10899
10900 xorObjectDigest(digest,eleobj);
10901 }
10902 dictReleaseIterator(di);
10903 } else if (o->type == REDIS_ZSET) {
10904 zset *zs = o->ptr;
10905 dictIterator *di = dictGetIterator(zs->dict);
10906 dictEntry *de;
10907
10908 while((de = dictNext(di)) != NULL) {
10909 robj *eleobj = dictGetEntryKey(de);
10910 double *score = dictGetEntryVal(de);
10911 unsigned char eledigest[20];
10912
10913 snprintf(buf,sizeof(buf),"%.17g",*score);
10914 memset(eledigest,0,20);
10915 mixObjectDigest(eledigest,eleobj);
10916 mixDigest(eledigest,buf,strlen(buf));
10917 xorDigest(digest,eledigest,20);
10918 }
10919 dictReleaseIterator(di);
10920 } else if (o->type == REDIS_HASH) {
10921 hashIterator *hi;
10922 robj *obj;
10923
10924 hi = hashInitIterator(o);
10925 while (hashNext(hi) != REDIS_ERR) {
10926 unsigned char eledigest[20];
10927
10928 memset(eledigest,0,20);
10929 obj = hashCurrent(hi,REDIS_HASH_KEY);
10930 mixObjectDigest(eledigest,obj);
10931 decrRefCount(obj);
10932 obj = hashCurrent(hi,REDIS_HASH_VALUE);
10933 mixObjectDigest(eledigest,obj);
10934 decrRefCount(obj);
10935 xorDigest(digest,eledigest,20);
10936 }
10937 hashReleaseIterator(hi);
10938 } else {
10939 redisPanic("Unknown object type");
10940 }
ba798261 10941 /* If the key has an expire, add it to the mix */
10942 if (expiretime != -1) xorDigest(digest,"!!expire!!",10);
10943 /* We can finally xor the key-val digest to the final digest */
10944 xorDigest(final,digest,20);
10945 }
10946 dictReleaseIterator(di);
10947 }
10948}
10949
7f957c92 10950static void debugCommand(redisClient *c) {
10951 if (!strcasecmp(c->argv[1]->ptr,"segfault")) {
10952 *((char*)-1) = 'x';
210e29f7 10953 } else if (!strcasecmp(c->argv[1]->ptr,"reload")) {
10954 if (rdbSave(server.dbfilename) != REDIS_OK) {
10955 addReply(c,shared.err);
10956 return;
10957 }
10958 emptyDb();
10959 if (rdbLoad(server.dbfilename) != REDIS_OK) {
10960 addReply(c,shared.err);
10961 return;
10962 }
10963 redisLog(REDIS_WARNING,"DB reloaded by DEBUG RELOAD");
10964 addReply(c,shared.ok);
71c2b467 10965 } else if (!strcasecmp(c->argv[1]->ptr,"loadaof")) {
10966 emptyDb();
10967 if (loadAppendOnlyFile(server.appendfilename) != REDIS_OK) {
10968 addReply(c,shared.err);
10969 return;
10970 }
10971 redisLog(REDIS_WARNING,"Append Only File loaded by DEBUG LOADAOF");
10972 addReply(c,shared.ok);
333298da 10973 } else if (!strcasecmp(c->argv[1]->ptr,"object") && c->argc == 3) {
10974 dictEntry *de = dictFind(c->db->dict,c->argv[2]);
10975 robj *key, *val;
10976
10977 if (!de) {
10978 addReply(c,shared.nokeyerr);
10979 return;
10980 }
10981 key = dictGetEntryKey(de);
10982 val = dictGetEntryVal(de);
59146ef3 10983 if (!server.vm_enabled || (key->storage == REDIS_VM_MEMORY ||
10984 key->storage == REDIS_VM_SWAPPING)) {
07efaf74 10985 char *strenc;
10986 char buf[128];
10987
10988 if (val->encoding < (sizeof(strencoding)/sizeof(char*))) {
10989 strenc = strencoding[val->encoding];
10990 } else {
10991 snprintf(buf,64,"unknown encoding %d\n", val->encoding);
10992 strenc = buf;
10993 }
ace06542 10994 addReplySds(c,sdscatprintf(sdsempty(),
10995 "+Key at:%p refcount:%d, value at:%p refcount:%d "
07efaf74 10996 "encoding:%s serializedlength:%lld\r\n",
682ac724 10997 (void*)key, key->refcount, (void*)val, val->refcount,
07efaf74 10998 strenc, (long long) rdbSavedObjectLen(val,NULL)));
ace06542 10999 } else {
11000 addReplySds(c,sdscatprintf(sdsempty(),
11001 "+Key at:%p refcount:%d, value swapped at: page %llu "
11002 "using %llu pages\r\n",
11003 (void*)key, key->refcount, (unsigned long long) key->vm.page,
11004 (unsigned long long) key->vm.usedpages));
11005 }
78ebe4c8 11006 } else if (!strcasecmp(c->argv[1]->ptr,"swapin") && c->argc == 3) {
11007 lookupKeyRead(c->db,c->argv[2]);
11008 addReply(c,shared.ok);
7d30035d 11009 } else if (!strcasecmp(c->argv[1]->ptr,"swapout") && c->argc == 3) {
11010 dictEntry *de = dictFind(c->db->dict,c->argv[2]);
11011 robj *key, *val;
11012
11013 if (!server.vm_enabled) {
11014 addReplySds(c,sdsnew("-ERR Virtual Memory is disabled\r\n"));
11015 return;
11016 }
11017 if (!de) {
11018 addReply(c,shared.nokeyerr);
11019 return;
11020 }
11021 key = dictGetEntryKey(de);
11022 val = dictGetEntryVal(de);
4ef8de8a 11023 /* If the key is shared we want to create a copy */
11024 if (key->refcount > 1) {
11025 robj *newkey = dupStringObject(key);
11026 decrRefCount(key);
11027 key = dictGetEntryKey(de) = newkey;
11028 }
11029 /* Swap it */
7d30035d 11030 if (key->storage != REDIS_VM_MEMORY) {
11031 addReplySds(c,sdsnew("-ERR This key is not in memory\r\n"));
a69a0c9c 11032 } else if (vmSwapObjectBlocking(key,val) == REDIS_OK) {
7d30035d 11033 dictGetEntryVal(de) = NULL;
11034 addReply(c,shared.ok);
11035 } else {
11036 addReply(c,shared.err);
11037 }
59305dc7 11038 } else if (!strcasecmp(c->argv[1]->ptr,"populate") && c->argc == 3) {
11039 long keys, j;
11040 robj *key, *val;
11041 char buf[128];
11042
11043 if (getLongFromObjectOrReply(c, c->argv[2], &keys, NULL) != REDIS_OK)
11044 return;
11045 for (j = 0; j < keys; j++) {
11046 snprintf(buf,sizeof(buf),"key:%lu",j);
11047 key = createStringObject(buf,strlen(buf));
11048 if (lookupKeyRead(c->db,key) != NULL) {
11049 decrRefCount(key);
11050 continue;
11051 }
11052 snprintf(buf,sizeof(buf),"value:%lu",j);
11053 val = createStringObject(buf,strlen(buf));
11054 dictAdd(c->db->dict,key,val);
11055 }
11056 addReply(c,shared.ok);
ba798261 11057 } else if (!strcasecmp(c->argv[1]->ptr,"digest") && c->argc == 2) {
11058 unsigned char digest[20];
11059 sds d = sdsnew("+");
11060 int j;
11061
11062 computeDatasetDigest(digest);
11063 for (j = 0; j < 20; j++)
11064 d = sdscatprintf(d, "%02x",digest[j]);
11065
11066 d = sdscatlen(d,"\r\n",2);
11067 addReplySds(c,d);
7f957c92 11068 } else {
333298da 11069 addReplySds(c,sdsnew(
bdcb92f2 11070 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPIN <key>|SWAPOUT <key>|RELOAD]\r\n"));
7f957c92 11071 }
11072}
56906eef 11073
6c96ba7d 11074static void _redisAssert(char *estr, char *file, int line) {
dfc5e96c 11075 redisLog(REDIS_WARNING,"=== ASSERTION FAILED ===");
fdfb02e7 11076 redisLog(REDIS_WARNING,"==> %s:%d '%s' is not true",file,line,estr);
dfc5e96c 11077#ifdef HAVE_BACKTRACE
11078 redisLog(REDIS_WARNING,"(forcing SIGSEGV in order to print the stack trace)");
11079 *((char*)-1) = 'x';
11080#endif
11081}
11082
c651fd9e 11083static void _redisPanic(char *msg, char *file, int line) {
11084 redisLog(REDIS_WARNING,"!!! Software Failure. Press left mouse button to continue");
17772754 11085 redisLog(REDIS_WARNING,"Guru Meditation: %s #%s:%d",msg,file,line);
c651fd9e 11086#ifdef HAVE_BACKTRACE
11087 redisLog(REDIS_WARNING,"(forcing SIGSEGV in order to print the stack trace)");
11088 *((char*)-1) = 'x';
11089#endif
11090}
11091
bcfc686d 11092/* =================================== Main! ================================ */
56906eef 11093
bcfc686d 11094#ifdef __linux__
11095int linuxOvercommitMemoryValue(void) {
11096 FILE *fp = fopen("/proc/sys/vm/overcommit_memory","r");
11097 char buf[64];
56906eef 11098
bcfc686d 11099 if (!fp) return -1;
11100 if (fgets(buf,64,fp) == NULL) {
11101 fclose(fp);
11102 return -1;
11103 }
11104 fclose(fp);
56906eef 11105
bcfc686d 11106 return atoi(buf);
11107}
11108
11109void linuxOvercommitMemoryWarning(void) {
11110 if (linuxOvercommitMemoryValue() == 0) {
7ccd2d0a 11111 redisLog(REDIS_WARNING,"WARNING overcommit_memory is set to 0! Background save may fail under low memory condition. To fix this issue add 'vm.overcommit_memory = 1' to /etc/sysctl.conf and then reboot or run the command 'sysctl vm.overcommit_memory=1' for this to take effect.");
bcfc686d 11112 }
11113}
11114#endif /* __linux__ */
11115
11116static void daemonize(void) {
11117 int fd;
11118 FILE *fp;
11119
11120 if (fork() != 0) exit(0); /* parent exits */
11121 setsid(); /* create a new session */
11122
11123 /* Every output goes to /dev/null. If Redis is daemonized but
11124 * the 'logfile' is set to 'stdout' in the configuration file
11125 * it will not log at all. */
11126 if ((fd = open("/dev/null", O_RDWR, 0)) != -1) {
11127 dup2(fd, STDIN_FILENO);
11128 dup2(fd, STDOUT_FILENO);
11129 dup2(fd, STDERR_FILENO);
11130 if (fd > STDERR_FILENO) close(fd);
11131 }
11132 /* Try to write the pid file */
11133 fp = fopen(server.pidfile,"w");
11134 if (fp) {
11135 fprintf(fp,"%d\n",getpid());
11136 fclose(fp);
56906eef 11137 }
56906eef 11138}
11139
42ab0172 11140static void version() {
8a3b0d2d 11141 printf("Redis server version %s (%s:%d)\n", REDIS_VERSION,
11142 REDIS_GIT_SHA1, atoi(REDIS_GIT_DIRTY) > 0);
42ab0172
AO
11143 exit(0);
11144}
11145
723fb69b
AO
11146static void usage() {
11147 fprintf(stderr,"Usage: ./redis-server [/path/to/redis.conf]\n");
e9409273 11148 fprintf(stderr," ./redis-server - (read config from stdin)\n");
723fb69b
AO
11149 exit(1);
11150}
11151
bcfc686d 11152int main(int argc, char **argv) {
9651a787 11153 time_t start;
11154
bcfc686d 11155 initServerConfig();
1a132bbc 11156 sortCommandTable();
bcfc686d 11157 if (argc == 2) {
44efe66e 11158 if (strcmp(argv[1], "-v") == 0 ||
11159 strcmp(argv[1], "--version") == 0) version();
11160 if (strcmp(argv[1], "--help") == 0) usage();
bcfc686d 11161 resetServerSaveParams();
11162 loadServerConfig(argv[1]);
723fb69b
AO
11163 } else if ((argc > 2)) {
11164 usage();
bcfc686d 11165 } else {
11166 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'");
11167 }
bcfc686d 11168 if (server.daemonize) daemonize();
71c54b21 11169 initServer();
bcfc686d 11170 redisLog(REDIS_NOTICE,"Server started, Redis version " REDIS_VERSION);
11171#ifdef __linux__
11172 linuxOvercommitMemoryWarning();
11173#endif
9651a787 11174 start = time(NULL);
bcfc686d 11175 if (server.appendonly) {
11176 if (loadAppendOnlyFile(server.appendfilename) == REDIS_OK)
9651a787 11177 redisLog(REDIS_NOTICE,"DB loaded from append only file: %ld seconds",time(NULL)-start);
bcfc686d 11178 } else {
11179 if (rdbLoad(server.dbfilename) == REDIS_OK)
9651a787 11180 redisLog(REDIS_NOTICE,"DB loaded from disk: %ld seconds",time(NULL)-start);
bcfc686d 11181 }
bcfc686d 11182 redisLog(REDIS_NOTICE,"The server is now ready to accept connections on port %d", server.port);
d5d55fc3 11183 aeSetBeforeSleepProc(server.el,beforeSleep);
bcfc686d 11184 aeMain(server.el);
11185 aeDeleteEventLoop(server.el);
11186 return 0;
11187}
11188
11189/* ============================= Backtrace support ========================= */
11190
11191#ifdef HAVE_BACKTRACE
11192static char *findFuncName(void *pointer, unsigned long *offset);
11193
56906eef 11194static void *getMcontextEip(ucontext_t *uc) {
11195#if defined(__FreeBSD__)
11196 return (void*) uc->uc_mcontext.mc_eip;
11197#elif defined(__dietlibc__)
11198 return (void*) uc->uc_mcontext.eip;
06db1f50 11199#elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
da0a1620 11200 #if __x86_64__
11201 return (void*) uc->uc_mcontext->__ss.__rip;
11202 #else
56906eef 11203 return (void*) uc->uc_mcontext->__ss.__eip;
da0a1620 11204 #endif
06db1f50 11205#elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
cb7e07cc 11206 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
06db1f50 11207 return (void*) uc->uc_mcontext->__ss.__rip;
cbc59b38 11208 #else
11209 return (void*) uc->uc_mcontext->__ss.__eip;
e0a62c7f 11210 #endif
54bac49d 11211#elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
c04c9ac9 11212 return (void*) uc->uc_mcontext.gregs[REG_EIP]; /* Linux 32/64 bit */
b91cf5ef 11213#elif defined(__ia64__) /* Linux IA64 */
11214 return (void*) uc->uc_mcontext.sc_ip;
11215#else
11216 return NULL;
56906eef 11217#endif
11218}
11219
11220static void segvHandler(int sig, siginfo_t *info, void *secret) {
11221 void *trace[100];
11222 char **messages = NULL;
11223 int i, trace_size = 0;
11224 unsigned long offset=0;
56906eef 11225 ucontext_t *uc = (ucontext_t*) secret;
1c85b79f 11226 sds infostring;
56906eef 11227 REDIS_NOTUSED(info);
11228
11229 redisLog(REDIS_WARNING,
11230 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION, sig);
1c85b79f 11231 infostring = genRedisInfoString();
11232 redisLog(REDIS_WARNING, "%s",infostring);
11233 /* It's not safe to sdsfree() the returned string under memory
11234 * corruption conditions. Let it leak as we are going to abort */
e0a62c7f 11235
56906eef 11236 trace_size = backtrace(trace, 100);
de96dbfe 11237 /* overwrite sigaction with caller's address */
b91cf5ef 11238 if (getMcontextEip(uc) != NULL) {
11239 trace[1] = getMcontextEip(uc);
11240 }
56906eef 11241 messages = backtrace_symbols(trace, trace_size);
fe3bbfbe 11242
d76412d1 11243 for (i=1; i<trace_size; ++i) {
56906eef 11244 char *fn = findFuncName(trace[i], &offset), *p;
11245
11246 p = strchr(messages[i],'+');
11247 if (!fn || (p && ((unsigned long)strtol(p+1,NULL,10)) < offset)) {
11248 redisLog(REDIS_WARNING,"%s", messages[i]);
11249 } else {
11250 redisLog(REDIS_WARNING,"%d redis-server %p %s + %d", i, trace[i], fn, (unsigned int)offset);
11251 }
11252 }
b177fd30 11253 /* free(messages); Don't call free() with possibly corrupted memory. */
478c2c6f 11254 _exit(0);
fe3bbfbe 11255}
56906eef 11256
fab43727 11257static void sigtermHandler(int sig) {
11258 REDIS_NOTUSED(sig);
b58ba105 11259
fab43727 11260 redisLog(REDIS_WARNING,"SIGTERM received, scheduling shutting down...");
11261 server.shutdown_asap = 1;
b58ba105
AM
11262}
11263
56906eef 11264static void setupSigSegvAction(void) {
11265 struct sigaction act;
11266
11267 sigemptyset (&act.sa_mask);
11268 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
11269 * is used. Otherwise, sa_handler is used */
11270 act.sa_flags = SA_NODEFER | SA_ONSTACK | SA_RESETHAND | SA_SIGINFO;
11271 act.sa_sigaction = segvHandler;
11272 sigaction (SIGSEGV, &act, NULL);
11273 sigaction (SIGBUS, &act, NULL);
12fea928 11274 sigaction (SIGFPE, &act, NULL);
11275 sigaction (SIGILL, &act, NULL);
11276 sigaction (SIGBUS, &act, NULL);
b58ba105
AM
11277
11278 act.sa_flags = SA_NODEFER | SA_ONSTACK | SA_RESETHAND;
fab43727 11279 act.sa_handler = sigtermHandler;
b58ba105 11280 sigaction (SIGTERM, &act, NULL);
e65fdc78 11281 return;
56906eef 11282}
e65fdc78 11283
bcfc686d 11284#include "staticsymbols.h"
11285/* This function try to convert a pointer into a function name. It's used in
11286 * oreder to provide a backtrace under segmentation fault that's able to
11287 * display functions declared as static (otherwise the backtrace is useless). */
11288static char *findFuncName(void *pointer, unsigned long *offset){
11289 int i, ret = -1;
11290 unsigned long off, minoff = 0;
ed9b544e 11291
bcfc686d 11292 /* Try to match against the Symbol with the smallest offset */
11293 for (i=0; symsTable[i].pointer; i++) {
11294 unsigned long lp = (unsigned long) pointer;
0bc03378 11295
bcfc686d 11296 if (lp != (unsigned long)-1 && lp >= symsTable[i].pointer) {
11297 off=lp-symsTable[i].pointer;
11298 if (ret < 0 || off < minoff) {
11299 minoff=off;
11300 ret=i;
11301 }
11302 }
0bc03378 11303 }
bcfc686d 11304 if (ret == -1) return NULL;
11305 *offset = minoff;
11306 return symsTable[ret].name;
0bc03378 11307}
bcfc686d 11308#else /* HAVE_BACKTRACE */
11309static void setupSigSegvAction(void) {
0bc03378 11310}
bcfc686d 11311#endif /* HAVE_BACKTRACE */
0bc03378 11312
ed9b544e 11313
ed9b544e 11314
bcfc686d 11315/* The End */
11316
11317
ed9b544e 11318