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