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