2 * Copyright (c) 2006-2009, Salvatore Sanfilippo <antirez at gmail dot com>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
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.
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.
30 #define REDIS_VERSION "1.3.2"
40 #define __USE_POSIX199309
46 #endif /* HAVE_BACKTRACE */
54 #include <arpa/inet.h>
58 #include <sys/resource.h>
65 #include "solarisfixes.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 */
78 /* #define REDIS_HELGRIND_FRIENDLY */
79 #if defined(__GNUC__) && defined(REDIS_HELGRIND_FRIENDLY)
80 #warning "Remember to undef REDIS_HELGRIND_FRIENDLY before to commit"
87 /* Static server configuration */
88 #define REDIS_SERVERPORT 6379 /* TCP port */
89 #define REDIS_MAXIDLETIME (60*5) /* default client timeout */
90 #define REDIS_IOBUF_LEN 1024
91 #define REDIS_LOADBUF_LEN 1024
92 #define REDIS_STATIC_ARGS 4
93 #define REDIS_DEFAULT_DBNUM 16
94 #define REDIS_CONFIGLINE_MAX 1024
95 #define REDIS_OBJFREELIST_MAX 1000000 /* Max number of objects to cache */
96 #define REDIS_MAX_SYNC_TIME 60 /* Slave can't take more to sync */
97 #define REDIS_EXPIRELOOKUPS_PER_CRON 100 /* try to expire 100 keys/second */
98 #define REDIS_MAX_WRITE_PER_EVENT (1024*64)
99 #define REDIS_REQUEST_MAX_SIZE (1024*1024*256) /* max bytes in inline command */
101 /* If more then REDIS_WRITEV_THRESHOLD write packets are pending use writev */
102 #define REDIS_WRITEV_THRESHOLD 3
103 /* Max number of iovecs used for each writev call */
104 #define REDIS_WRITEV_IOVEC_COUNT 256
106 /* Hash table parameters */
107 #define REDIS_HT_MINFILL 10 /* Minimal hash table fill 10% */
110 #define REDIS_CMD_BULK 1 /* Bulk write command */
111 #define REDIS_CMD_INLINE 2 /* Inline command */
112 /* REDIS_CMD_DENYOOM reserves a longer comment: all the commands marked with
113 this flags will return an error when the 'maxmemory' option is set in the
114 config file and the server is using more than maxmemory bytes of memory.
115 In short this commands are denied on low memory conditions. */
116 #define REDIS_CMD_DENYOOM 4
119 #define REDIS_STRING 0
125 /* Objects encoding */
126 #define REDIS_ENCODING_RAW 0 /* Raw representation */
127 #define REDIS_ENCODING_INT 1 /* Encoded as integer */
129 /* Object types only used for dumping to disk */
130 #define REDIS_EXPIRETIME 253
131 #define REDIS_SELECTDB 254
132 #define REDIS_EOF 255
134 /* Defines related to the dump file format. To store 32 bits lengths for short
135 * keys requires a lot of space, so we check the most significant 2 bits of
136 * the first byte to interpreter the length:
138 * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
139 * 01|000000 00000000 => 01, the len is 14 byes, 6 bits + 8 bits of next byte
140 * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
141 * 11|000000 this means: specially encoded object will follow. The six bits
142 * number specify the kind of object that follows.
143 * See the REDIS_RDB_ENC_* defines.
145 * Lenghts up to 63 are stored using a single byte, most DB keys, and may
146 * values, will fit inside. */
147 #define REDIS_RDB_6BITLEN 0
148 #define REDIS_RDB_14BITLEN 1
149 #define REDIS_RDB_32BITLEN 2
150 #define REDIS_RDB_ENCVAL 3
151 #define REDIS_RDB_LENERR UINT_MAX
153 /* When a length of a string object stored on disk has the first two bits
154 * set, the remaining two bits specify a special encoding for the object
155 * accordingly to the following defines: */
156 #define REDIS_RDB_ENC_INT8 0 /* 8 bit signed integer */
157 #define REDIS_RDB_ENC_INT16 1 /* 16 bit signed integer */
158 #define REDIS_RDB_ENC_INT32 2 /* 32 bit signed integer */
159 #define REDIS_RDB_ENC_LZF 3 /* string compressed with FASTLZ */
161 /* Virtual memory object->where field. */
162 #define REDIS_VM_MEMORY 0 /* The object is on memory */
163 #define REDIS_VM_SWAPPED 1 /* The object is on disk */
164 #define REDIS_VM_SWAPPING 2 /* Redis is swapping this object on disk */
165 #define REDIS_VM_LOADING 3 /* Redis is loading this object from disk */
167 /* Virtual memory static configuration stuff.
168 * Check vmFindContiguousPages() to know more about this magic numbers. */
169 #define REDIS_VM_MAX_NEAR_PAGES 65536
170 #define REDIS_VM_MAX_RANDOM_JUMP 4096
171 #define REDIS_VM_MAX_THREADS 32
172 #define REDIS_THREAD_STACK_SIZE (1024*1024*4)
173 /* The following is the number of completed I/O jobs to process when the
174 * handelr is called. 1 is the minimum, and also the default, as it allows
175 * to block as little as possible other accessing clients. While Virtual
176 * Memory I/O operations are performed by threads, this operations must
177 * be processed by the main thread when completed to take effect. */
178 #define REDIS_MAX_COMPLETED_JOBS_PROCESSED 1
181 #define REDIS_CLOSE 1 /* This client connection should be closed ASAP */
182 #define REDIS_SLAVE 2 /* This client is a slave server */
183 #define REDIS_MASTER 4 /* This client is a master server */
184 #define REDIS_MONITOR 8 /* This client is a slave monitor, see MONITOR */
185 #define REDIS_MULTI 16 /* This client is in a MULTI context */
186 #define REDIS_BLOCKED 32 /* The client is waiting in a blocking operation */
187 #define REDIS_IO_WAIT 64 /* The client is waiting for Virtual Memory I/O */
189 /* Slave replication state - slave side */
190 #define REDIS_REPL_NONE 0 /* No active replication */
191 #define REDIS_REPL_CONNECT 1 /* Must connect to master */
192 #define REDIS_REPL_CONNECTED 2 /* Connected to master */
194 /* Slave replication state - from the point of view of master
195 * Note that in SEND_BULK and ONLINE state the slave receives new updates
196 * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
197 * to start the next background saving in order to send updates to it. */
198 #define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
199 #define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
200 #define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
201 #define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */
203 /* List related stuff */
207 /* Sort operations */
208 #define REDIS_SORT_GET 0
209 #define REDIS_SORT_ASC 1
210 #define REDIS_SORT_DESC 2
211 #define REDIS_SORTKEY_MAX 1024
214 #define REDIS_DEBUG 0
215 #define REDIS_VERBOSE 1
216 #define REDIS_NOTICE 2
217 #define REDIS_WARNING 3
219 /* Anti-warning macro... */
220 #define REDIS_NOTUSED(V) ((void) V)
222 #define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
223 #define ZSKIPLIST_P 0.25 /* Skiplist P = 1/4 */
225 /* Append only defines */
226 #define APPENDFSYNC_NO 0
227 #define APPENDFSYNC_ALWAYS 1
228 #define APPENDFSYNC_EVERYSEC 2
230 /* We can print the stacktrace, so our assert is defined this way: */
231 #define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),exit(1)))
232 static void _redisAssert(char *estr
, char *file
, int line
);
234 /*================================= Data types ============================== */
236 /* A redis object, that is a type able to hold a string / list / set */
238 /* The VM object structure */
239 struct redisObjectVM
{
240 off_t page
; /* the page at witch the object is stored on disk */
241 off_t usedpages
; /* number of pages used on disk */
242 time_t atime
; /* Last access time */
245 /* The actual Redis Object */
246 typedef struct redisObject
{
249 unsigned char encoding
;
250 unsigned char storage
; /* If this object is a key, where is the value?
251 * REDIS_VM_MEMORY, REDIS_VM_SWAPPED, ... */
252 unsigned char vtype
; /* If this object is a key, and value is swapped out,
253 * this is the type of the swapped out object. */
255 /* VM fields, this are only allocated if VM is active, otherwise the
256 * object allocation function will just allocate
257 * sizeof(redisObjct) minus sizeof(redisObjectVM), so using
258 * Redis without VM active will not have any overhead. */
259 struct redisObjectVM vm
;
262 /* Macro used to initalize a Redis object allocated on the stack.
263 * Note that this macro is taken near the structure definition to make sure
264 * we'll update it when the structure is changed, to avoid bugs like
265 * bug #85 introduced exactly in this way. */
266 #define initStaticStringObject(_var,_ptr) do { \
268 _var.type = REDIS_STRING; \
269 _var.encoding = REDIS_ENCODING_RAW; \
271 if (server.vm_enabled) _var.storage = REDIS_VM_MEMORY; \
274 typedef struct redisDb
{
275 dict
*dict
; /* The keyspace for this DB */
276 dict
*expires
; /* Timeout of keys with a timeout set */
277 dict
*blockingkeys
; /* Keys with clients waiting for data (BLPOP) */
281 /* Client MULTI/EXEC state */
282 typedef struct multiCmd
{
285 struct redisCommand
*cmd
;
288 typedef struct multiState
{
289 multiCmd
*commands
; /* Array of MULTI commands */
290 int count
; /* Total number of MULTI commands */
293 /* With multiplexing we need to take per-clinet state.
294 * Clients are taken in a liked list. */
295 typedef struct redisClient
{
300 robj
**argv
, **mbargv
;
302 int bulklen
; /* bulk read len. -1 if not in bulk read mode */
303 int multibulk
; /* multi bulk command format active */
306 time_t lastinteraction
; /* time of the last interaction, used for timeout */
307 int flags
; /* REDIS_CLOSE | REDIS_SLAVE | REDIS_MONITOR */
309 int slaveseldb
; /* slave selected db, if this client is a slave */
310 int authenticated
; /* when requirepass is non-NULL */
311 int replstate
; /* replication state if this is a slave */
312 int repldbfd
; /* replication DB file descriptor */
313 long repldboff
; /* replication DB file offset */
314 off_t repldbsize
; /* replication DB file size */
315 multiState mstate
; /* MULTI/EXEC state */
316 robj
**blockingkeys
; /* The key we waiting to terminate a blocking
317 * operation such as BLPOP. Otherwise NULL. */
318 int blockingkeysnum
; /* Number of blocking keys */
319 time_t blockingto
; /* Blocking operation timeout. If UNIX current time
320 * is >= blockingto then the operation timed out. */
321 list
*io_keys
; /* Keys this client is waiting to be loaded from the
322 * swap file in order to continue. */
330 /* Global server state structure */
335 dict
*sharingpool
; /* Poll used for object sharing */
336 unsigned int sharingpoolsize
;
337 long long dirty
; /* changes to DB from the last save */
339 list
*slaves
, *monitors
;
340 char neterr
[ANET_ERR_LEN
];
342 int cronloops
; /* number of times the cron function run */
343 list
*objfreelist
; /* A list of freed objects to avoid malloc() */
344 time_t lastsave
; /* Unix time of last save succeeede */
345 size_t usedmemory
; /* Used memory in megabytes */
346 /* Fields used only for stats */
347 time_t stat_starttime
; /* server start time */
348 long long stat_numcommands
; /* number of processed commands */
349 long long stat_numconnections
; /* number of connections received */
362 pid_t bgsavechildpid
;
363 pid_t bgrewritechildpid
;
364 sds bgrewritebuf
; /* buffer taken by parent during oppend only rewrite */
365 struct saveparam
*saveparams
;
370 char *appendfilename
;
374 /* Replication related */
379 redisClient
*master
; /* client that is master for this slave */
381 unsigned int maxclients
;
382 unsigned long long maxmemory
;
383 unsigned int blockedclients
;
384 /* Sort parameters - qsort_r() is only available under BSD so we
385 * have to take this state global, in order to pass it to sortCompare() */
389 /* Virtual memory configuration */
394 unsigned long long vm_max_memory
;
395 /* Virtual memory state */
398 off_t vm_next_page
; /* Next probably empty page */
399 off_t vm_near_pages
; /* Number of pages allocated sequentially */
400 unsigned char *vm_bitmap
; /* Bitmap of free/used pages */
401 time_t unixtime
; /* Unix time sampled every second. */
402 /* Virtual memory I/O threads stuff */
403 /* An I/O thread process an element taken from the io_jobs queue and
404 * put the result of the operation in the io_done list. While the
405 * job is being processed, it's put on io_processing queue. */
406 list
*io_newjobs
; /* List of VM I/O jobs yet to be processed */
407 list
*io_processing
; /* List of VM I/O jobs being processed */
408 list
*io_processed
; /* List of VM I/O jobs already processed */
409 list
*io_clients
; /* All the clients waiting for SWAP I/O operations */
410 pthread_mutex_t io_mutex
; /* lock to access io_jobs/io_done/io_thread_job */
411 pthread_mutex_t obj_freelist_mutex
; /* safe redis objects creation/free */
412 pthread_mutex_t io_swapfile_mutex
; /* So we can lseek + write */
413 pthread_attr_t io_threads_attr
; /* attributes for threads creation */
414 int io_active_threads
; /* Number of running I/O threads */
415 int vm_max_threads
; /* Max number of I/O threads running at the same time */
416 /* Our main thread is blocked on the event loop, locking for sockets ready
417 * to be read or written, so when a threaded I/O operation is ready to be
418 * processed by the main thread, the I/O thread will use a unix pipe to
419 * awake the main thread. The followings are the two pipe FDs. */
420 int io_ready_pipe_read
;
421 int io_ready_pipe_write
;
422 /* Virtual memory stats */
423 unsigned long long vm_stats_used_pages
;
424 unsigned long long vm_stats_swapped_objects
;
425 unsigned long long vm_stats_swapouts
;
426 unsigned long long vm_stats_swapins
;
430 typedef void redisCommandProc(redisClient
*c
);
431 struct redisCommand
{
433 redisCommandProc
*proc
;
438 struct redisFunctionSym
{
440 unsigned long pointer
;
443 typedef struct _redisSortObject
{
451 typedef struct _redisSortOperation
{
454 } redisSortOperation
;
456 /* ZSETs use a specialized version of Skiplists */
458 typedef struct zskiplistNode
{
459 struct zskiplistNode
**forward
;
460 struct zskiplistNode
*backward
;
465 typedef struct zskiplist
{
466 struct zskiplistNode
*header
, *tail
;
467 unsigned long length
;
471 typedef struct zset
{
476 /* Our shared "common" objects */
478 struct sharedObjectsStruct
{
479 robj
*crlf
, *ok
, *err
, *emptybulk
, *czero
, *cone
, *pong
, *space
,
480 *colon
, *nullbulk
, *nullmultibulk
, *queued
,
481 *emptymultibulk
, *wrongtypeerr
, *nokeyerr
, *syntaxerr
, *sameobjecterr
,
482 *outofrangeerr
, *plus
,
483 *select0
, *select1
, *select2
, *select3
, *select4
,
484 *select5
, *select6
, *select7
, *select8
, *select9
;
487 /* Global vars that are actally used as constants. The following double
488 * values are used for double on-disk serialization, and are initialized
489 * at runtime to avoid strange compiler optimizations. */
491 static double R_Zero
, R_PosInf
, R_NegInf
, R_Nan
;
493 /* VM threaded I/O request message */
494 #define REDIS_IOJOB_LOAD 0 /* Load from disk to memory */
495 #define REDIS_IOJOB_PREPARE_SWAP 1 /* Compute needed pages */
496 #define REDIS_IOJOB_DO_SWAP 2 /* Swap from memory to disk */
497 typedef struct iojon
{
498 int type
; /* Request type, REDIS_IOJOB_* */
499 redisDb
*db
;/* Redis database */
500 robj
*key
; /* This I/O request is about swapping this key */
501 robj
*val
; /* the value to swap for REDIS_IOREQ_*_SWAP, otherwise this
502 * field is populated by the I/O thread for REDIS_IOREQ_LOAD. */
503 off_t page
; /* Swap page where to read/write the object */
504 off_t pages
; /* Swap pages needed to safe object. PREPARE_SWAP return val */
505 int canceled
; /* True if this command was canceled by blocking side of VM */
506 pthread_t thread
; /* ID of the thread processing this entry */
509 /*================================ Prototypes =============================== */
511 static void freeStringObject(robj
*o
);
512 static void freeListObject(robj
*o
);
513 static void freeSetObject(robj
*o
);
514 static void decrRefCount(void *o
);
515 static robj
*createObject(int type
, void *ptr
);
516 static void freeClient(redisClient
*c
);
517 static int rdbLoad(char *filename
);
518 static void addReply(redisClient
*c
, robj
*obj
);
519 static void addReplySds(redisClient
*c
, sds s
);
520 static void incrRefCount(robj
*o
);
521 static int rdbSaveBackground(char *filename
);
522 static robj
*createStringObject(char *ptr
, size_t len
);
523 static robj
*dupStringObject(robj
*o
);
524 static void replicationFeedSlaves(list
*slaves
, struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
525 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
526 static int syncWithMaster(void);
527 static robj
*tryObjectSharing(robj
*o
);
528 static int tryObjectEncoding(robj
*o
);
529 static robj
*getDecodedObject(robj
*o
);
530 static int removeExpire(redisDb
*db
, robj
*key
);
531 static int expireIfNeeded(redisDb
*db
, robj
*key
);
532 static int deleteIfVolatile(redisDb
*db
, robj
*key
);
533 static int deleteIfSwapped(redisDb
*db
, robj
*key
);
534 static int deleteKey(redisDb
*db
, robj
*key
);
535 static time_t getExpire(redisDb
*db
, robj
*key
);
536 static int setExpire(redisDb
*db
, robj
*key
, time_t when
);
537 static void updateSlavesWaitingBgsave(int bgsaveerr
);
538 static void freeMemoryIfNeeded(void);
539 static int processCommand(redisClient
*c
);
540 static void setupSigSegvAction(void);
541 static void rdbRemoveTempFile(pid_t childpid
);
542 static void aofRemoveTempFile(pid_t childpid
);
543 static size_t stringObjectLen(robj
*o
);
544 static void processInputBuffer(redisClient
*c
);
545 static zskiplist
*zslCreate(void);
546 static void zslFree(zskiplist
*zsl
);
547 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
);
548 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
549 static void initClientMultiState(redisClient
*c
);
550 static void freeClientMultiState(redisClient
*c
);
551 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
);
552 static void unblockClient(redisClient
*c
);
553 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
);
554 static void vmInit(void);
555 static void vmMarkPagesFree(off_t page
, off_t count
);
556 static robj
*vmLoadObject(robj
*key
);
557 static robj
*vmPreviewObject(robj
*key
);
558 static int vmSwapOneObjectBlocking(void);
559 static int vmSwapOneObjectThreaded(void);
560 static int vmCanSwapOut(void);
561 static int tryFreeOneObjectFromFreelist(void);
562 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
563 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
564 static void vmCancelThreadedIOJob(robj
*o
);
565 static void lockThreadedIO(void);
566 static void unlockThreadedIO(void);
567 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
);
568 static void freeIOJob(iojob
*j
);
569 static void queueIOJob(iojob
*j
);
570 static int vmWriteObjectOnSwap(robj
*o
, off_t page
);
571 static robj
*vmReadObjectFromSwap(off_t page
, int type
);
572 static void waitEmptyIOJobsQueue(void);
573 static void vmReopenSwapFile(void);
575 static void authCommand(redisClient
*c
);
576 static void pingCommand(redisClient
*c
);
577 static void echoCommand(redisClient
*c
);
578 static void setCommand(redisClient
*c
);
579 static void setnxCommand(redisClient
*c
);
580 static void getCommand(redisClient
*c
);
581 static void delCommand(redisClient
*c
);
582 static void existsCommand(redisClient
*c
);
583 static void incrCommand(redisClient
*c
);
584 static void decrCommand(redisClient
*c
);
585 static void incrbyCommand(redisClient
*c
);
586 static void decrbyCommand(redisClient
*c
);
587 static void selectCommand(redisClient
*c
);
588 static void randomkeyCommand(redisClient
*c
);
589 static void keysCommand(redisClient
*c
);
590 static void dbsizeCommand(redisClient
*c
);
591 static void lastsaveCommand(redisClient
*c
);
592 static void saveCommand(redisClient
*c
);
593 static void bgsaveCommand(redisClient
*c
);
594 static void bgrewriteaofCommand(redisClient
*c
);
595 static void shutdownCommand(redisClient
*c
);
596 static void moveCommand(redisClient
*c
);
597 static void renameCommand(redisClient
*c
);
598 static void renamenxCommand(redisClient
*c
);
599 static void lpushCommand(redisClient
*c
);
600 static void rpushCommand(redisClient
*c
);
601 static void lpopCommand(redisClient
*c
);
602 static void rpopCommand(redisClient
*c
);
603 static void llenCommand(redisClient
*c
);
604 static void lindexCommand(redisClient
*c
);
605 static void lrangeCommand(redisClient
*c
);
606 static void ltrimCommand(redisClient
*c
);
607 static void typeCommand(redisClient
*c
);
608 static void lsetCommand(redisClient
*c
);
609 static void saddCommand(redisClient
*c
);
610 static void sremCommand(redisClient
*c
);
611 static void smoveCommand(redisClient
*c
);
612 static void sismemberCommand(redisClient
*c
);
613 static void scardCommand(redisClient
*c
);
614 static void spopCommand(redisClient
*c
);
615 static void srandmemberCommand(redisClient
*c
);
616 static void sinterCommand(redisClient
*c
);
617 static void sinterstoreCommand(redisClient
*c
);
618 static void sunionCommand(redisClient
*c
);
619 static void sunionstoreCommand(redisClient
*c
);
620 static void sdiffCommand(redisClient
*c
);
621 static void sdiffstoreCommand(redisClient
*c
);
622 static void syncCommand(redisClient
*c
);
623 static void flushdbCommand(redisClient
*c
);
624 static void flushallCommand(redisClient
*c
);
625 static void sortCommand(redisClient
*c
);
626 static void lremCommand(redisClient
*c
);
627 static void rpoplpushcommand(redisClient
*c
);
628 static void infoCommand(redisClient
*c
);
629 static void mgetCommand(redisClient
*c
);
630 static void monitorCommand(redisClient
*c
);
631 static void expireCommand(redisClient
*c
);
632 static void expireatCommand(redisClient
*c
);
633 static void getsetCommand(redisClient
*c
);
634 static void ttlCommand(redisClient
*c
);
635 static void slaveofCommand(redisClient
*c
);
636 static void debugCommand(redisClient
*c
);
637 static void msetCommand(redisClient
*c
);
638 static void msetnxCommand(redisClient
*c
);
639 static void zaddCommand(redisClient
*c
);
640 static void zincrbyCommand(redisClient
*c
);
641 static void zrangeCommand(redisClient
*c
);
642 static void zrangebyscoreCommand(redisClient
*c
);
643 static void zrevrangeCommand(redisClient
*c
);
644 static void zcardCommand(redisClient
*c
);
645 static void zremCommand(redisClient
*c
);
646 static void zscoreCommand(redisClient
*c
);
647 static void zremrangebyscoreCommand(redisClient
*c
);
648 static void multiCommand(redisClient
*c
);
649 static void execCommand(redisClient
*c
);
650 static void blpopCommand(redisClient
*c
);
651 static void brpopCommand(redisClient
*c
);
653 /*================================= Globals ================================= */
656 static struct redisServer server
; /* server global state */
657 static struct redisCommand cmdTable
[] = {
658 {"get",getCommand
,2,REDIS_CMD_INLINE
},
659 {"set",setCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
660 {"setnx",setnxCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
661 {"del",delCommand
,-2,REDIS_CMD_INLINE
},
662 {"exists",existsCommand
,2,REDIS_CMD_INLINE
},
663 {"incr",incrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
664 {"decr",decrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
665 {"mget",mgetCommand
,-2,REDIS_CMD_INLINE
},
666 {"rpush",rpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
667 {"lpush",lpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
668 {"rpop",rpopCommand
,2,REDIS_CMD_INLINE
},
669 {"lpop",lpopCommand
,2,REDIS_CMD_INLINE
},
670 {"brpop",brpopCommand
,-3,REDIS_CMD_INLINE
},
671 {"blpop",blpopCommand
,-3,REDIS_CMD_INLINE
},
672 {"llen",llenCommand
,2,REDIS_CMD_INLINE
},
673 {"lindex",lindexCommand
,3,REDIS_CMD_INLINE
},
674 {"lset",lsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
675 {"lrange",lrangeCommand
,4,REDIS_CMD_INLINE
},
676 {"ltrim",ltrimCommand
,4,REDIS_CMD_INLINE
},
677 {"lrem",lremCommand
,4,REDIS_CMD_BULK
},
678 {"rpoplpush",rpoplpushcommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
679 {"sadd",saddCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
680 {"srem",sremCommand
,3,REDIS_CMD_BULK
},
681 {"smove",smoveCommand
,4,REDIS_CMD_BULK
},
682 {"sismember",sismemberCommand
,3,REDIS_CMD_BULK
},
683 {"scard",scardCommand
,2,REDIS_CMD_INLINE
},
684 {"spop",spopCommand
,2,REDIS_CMD_INLINE
},
685 {"srandmember",srandmemberCommand
,2,REDIS_CMD_INLINE
},
686 {"sinter",sinterCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
687 {"sinterstore",sinterstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
688 {"sunion",sunionCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
689 {"sunionstore",sunionstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
690 {"sdiff",sdiffCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
691 {"sdiffstore",sdiffstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
692 {"smembers",sinterCommand
,2,REDIS_CMD_INLINE
},
693 {"zadd",zaddCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
694 {"zincrby",zincrbyCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
695 {"zrem",zremCommand
,3,REDIS_CMD_BULK
},
696 {"zremrangebyscore",zremrangebyscoreCommand
,4,REDIS_CMD_INLINE
},
697 {"zrange",zrangeCommand
,-4,REDIS_CMD_INLINE
},
698 {"zrangebyscore",zrangebyscoreCommand
,-4,REDIS_CMD_INLINE
},
699 {"zrevrange",zrevrangeCommand
,-4,REDIS_CMD_INLINE
},
700 {"zcard",zcardCommand
,2,REDIS_CMD_INLINE
},
701 {"zscore",zscoreCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
702 {"incrby",incrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
703 {"decrby",decrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
704 {"getset",getsetCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
705 {"mset",msetCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
706 {"msetnx",msetnxCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
707 {"randomkey",randomkeyCommand
,1,REDIS_CMD_INLINE
},
708 {"select",selectCommand
,2,REDIS_CMD_INLINE
},
709 {"move",moveCommand
,3,REDIS_CMD_INLINE
},
710 {"rename",renameCommand
,3,REDIS_CMD_INLINE
},
711 {"renamenx",renamenxCommand
,3,REDIS_CMD_INLINE
},
712 {"expire",expireCommand
,3,REDIS_CMD_INLINE
},
713 {"expireat",expireatCommand
,3,REDIS_CMD_INLINE
},
714 {"keys",keysCommand
,2,REDIS_CMD_INLINE
},
715 {"dbsize",dbsizeCommand
,1,REDIS_CMD_INLINE
},
716 {"auth",authCommand
,2,REDIS_CMD_INLINE
},
717 {"ping",pingCommand
,1,REDIS_CMD_INLINE
},
718 {"echo",echoCommand
,2,REDIS_CMD_BULK
},
719 {"save",saveCommand
,1,REDIS_CMD_INLINE
},
720 {"bgsave",bgsaveCommand
,1,REDIS_CMD_INLINE
},
721 {"bgrewriteaof",bgrewriteaofCommand
,1,REDIS_CMD_INLINE
},
722 {"shutdown",shutdownCommand
,1,REDIS_CMD_INLINE
},
723 {"lastsave",lastsaveCommand
,1,REDIS_CMD_INLINE
},
724 {"type",typeCommand
,2,REDIS_CMD_INLINE
},
725 {"multi",multiCommand
,1,REDIS_CMD_INLINE
},
726 {"exec",execCommand
,1,REDIS_CMD_INLINE
},
727 {"sync",syncCommand
,1,REDIS_CMD_INLINE
},
728 {"flushdb",flushdbCommand
,1,REDIS_CMD_INLINE
},
729 {"flushall",flushallCommand
,1,REDIS_CMD_INLINE
},
730 {"sort",sortCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
731 {"info",infoCommand
,1,REDIS_CMD_INLINE
},
732 {"monitor",monitorCommand
,1,REDIS_CMD_INLINE
},
733 {"ttl",ttlCommand
,2,REDIS_CMD_INLINE
},
734 {"slaveof",slaveofCommand
,3,REDIS_CMD_INLINE
},
735 {"debug",debugCommand
,-2,REDIS_CMD_INLINE
},
739 /*============================ Utility functions ============================ */
741 /* Glob-style pattern matching. */
742 int stringmatchlen(const char *pattern
, int patternLen
,
743 const char *string
, int stringLen
, int nocase
)
748 while (pattern
[1] == '*') {
753 return 1; /* match */
755 if (stringmatchlen(pattern
+1, patternLen
-1,
756 string
, stringLen
, nocase
))
757 return 1; /* match */
761 return 0; /* no match */
765 return 0; /* no match */
775 not = pattern
[0] == '^';
782 if (pattern
[0] == '\\') {
785 if (pattern
[0] == string
[0])
787 } else if (pattern
[0] == ']') {
789 } else if (patternLen
== 0) {
793 } else if (pattern
[1] == '-' && patternLen
>= 3) {
794 int start
= pattern
[0];
795 int end
= pattern
[2];
803 start
= tolower(start
);
809 if (c
>= start
&& c
<= end
)
813 if (pattern
[0] == string
[0])
816 if (tolower((int)pattern
[0]) == tolower((int)string
[0]))
826 return 0; /* no match */
832 if (patternLen
>= 2) {
839 if (pattern
[0] != string
[0])
840 return 0; /* no match */
842 if (tolower((int)pattern
[0]) != tolower((int)string
[0]))
843 return 0; /* no match */
851 if (stringLen
== 0) {
852 while(*pattern
== '*') {
859 if (patternLen
== 0 && stringLen
== 0)
864 static void redisLog(int level
, const char *fmt
, ...) {
868 fp
= (server
.logfile
== NULL
) ? stdout
: fopen(server
.logfile
,"a");
872 if (level
>= server
.verbosity
) {
878 strftime(buf
,64,"%d %b %H:%M:%S",localtime(&now
));
879 fprintf(fp
,"[%d] %s %c ",(int)getpid(),buf
,c
[level
]);
880 vfprintf(fp
, fmt
, ap
);
886 if (server
.logfile
) fclose(fp
);
889 /*====================== Hash table type implementation ==================== */
891 /* This is an hash table type that uses the SDS dynamic strings libary as
892 * keys and radis objects as values (objects can hold SDS strings,
895 static void dictVanillaFree(void *privdata
, void *val
)
897 DICT_NOTUSED(privdata
);
901 static void dictListDestructor(void *privdata
, void *val
)
903 DICT_NOTUSED(privdata
);
904 listRelease((list
*)val
);
907 static int sdsDictKeyCompare(void *privdata
, const void *key1
,
911 DICT_NOTUSED(privdata
);
913 l1
= sdslen((sds
)key1
);
914 l2
= sdslen((sds
)key2
);
915 if (l1
!= l2
) return 0;
916 return memcmp(key1
, key2
, l1
) == 0;
919 static void dictRedisObjectDestructor(void *privdata
, void *val
)
921 DICT_NOTUSED(privdata
);
923 if (val
== NULL
) return; /* Values of swapped out keys as set to NULL */
927 static int dictObjKeyCompare(void *privdata
, const void *key1
,
930 const robj
*o1
= key1
, *o2
= key2
;
931 return sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
934 static unsigned int dictObjHash(const void *key
) {
936 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
939 static int dictEncObjKeyCompare(void *privdata
, const void *key1
,
942 robj
*o1
= (robj
*) key1
, *o2
= (robj
*) key2
;
945 o1
= getDecodedObject(o1
);
946 o2
= getDecodedObject(o2
);
947 cmp
= sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
953 static unsigned int dictEncObjHash(const void *key
) {
954 robj
*o
= (robj
*) key
;
956 o
= getDecodedObject(o
);
957 unsigned int hash
= dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
962 /* Sets type and expires */
963 static dictType setDictType
= {
964 dictEncObjHash
, /* hash function */
967 dictEncObjKeyCompare
, /* key compare */
968 dictRedisObjectDestructor
, /* key destructor */
969 NULL
/* val destructor */
972 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
973 static dictType zsetDictType
= {
974 dictEncObjHash
, /* hash function */
977 dictEncObjKeyCompare
, /* key compare */
978 dictRedisObjectDestructor
, /* key destructor */
979 dictVanillaFree
/* val destructor of malloc(sizeof(double)) */
983 static dictType hashDictType
= {
984 dictObjHash
, /* hash function */
987 dictObjKeyCompare
, /* key compare */
988 dictRedisObjectDestructor
, /* key destructor */
989 dictRedisObjectDestructor
/* val destructor */
993 static dictType keyptrDictType
= {
994 dictObjHash
, /* hash function */
997 dictObjKeyCompare
, /* key compare */
998 dictRedisObjectDestructor
, /* key destructor */
999 NULL
/* val destructor */
1002 /* Keylist hash table type has unencoded redis objects as keys and
1003 * lists as values. It's used for blocking operations (BLPOP) */
1004 static dictType keylistDictType
= {
1005 dictObjHash
, /* hash function */
1008 dictObjKeyCompare
, /* key compare */
1009 dictRedisObjectDestructor
, /* key destructor */
1010 dictListDestructor
/* val destructor */
1013 /* ========================= Random utility functions ======================= */
1015 /* Redis generally does not try to recover from out of memory conditions
1016 * when allocating objects or strings, it is not clear if it will be possible
1017 * to report this condition to the client since the networking layer itself
1018 * is based on heap allocation for send buffers, so we simply abort.
1019 * At least the code will be simpler to read... */
1020 static void oom(const char *msg
) {
1021 redisLog(REDIS_WARNING
, "%s: Out of memory\n",msg
);
1026 /* ====================== Redis server networking stuff ===================== */
1027 static void closeTimedoutClients(void) {
1030 time_t now
= time(NULL
);
1033 listRewind(server
.clients
,&li
);
1034 while ((ln
= listNext(&li
)) != NULL
) {
1035 c
= listNodeValue(ln
);
1036 if (server
.maxidletime
&&
1037 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
1038 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
1039 (now
- c
->lastinteraction
> server
.maxidletime
))
1041 redisLog(REDIS_VERBOSE
,"Closing idle client");
1043 } else if (c
->flags
& REDIS_BLOCKED
) {
1044 if (c
->blockingto
!= 0 && c
->blockingto
< now
) {
1045 addReply(c
,shared
.nullmultibulk
);
1052 static int htNeedsResize(dict
*dict
) {
1053 long long size
, used
;
1055 size
= dictSlots(dict
);
1056 used
= dictSize(dict
);
1057 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
1058 (used
*100/size
< REDIS_HT_MINFILL
));
1061 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
1062 * we resize the hash table to save memory */
1063 static void tryResizeHashTables(void) {
1066 for (j
= 0; j
< server
.dbnum
; j
++) {
1067 if (htNeedsResize(server
.db
[j
].dict
)) {
1068 redisLog(REDIS_VERBOSE
,"The hash table %d is too sparse, resize it...",j
);
1069 dictResize(server
.db
[j
].dict
);
1070 redisLog(REDIS_VERBOSE
,"Hash table %d resized.",j
);
1072 if (htNeedsResize(server
.db
[j
].expires
))
1073 dictResize(server
.db
[j
].expires
);
1077 /* A background saving child (BGSAVE) terminated its work. Handle this. */
1078 void backgroundSaveDoneHandler(int statloc
) {
1079 int exitcode
= WEXITSTATUS(statloc
);
1080 int bysignal
= WIFSIGNALED(statloc
);
1082 if (!bysignal
&& exitcode
== 0) {
1083 redisLog(REDIS_NOTICE
,
1084 "Background saving terminated with success");
1086 server
.lastsave
= time(NULL
);
1087 } else if (!bysignal
&& exitcode
!= 0) {
1088 redisLog(REDIS_WARNING
, "Background saving error");
1090 redisLog(REDIS_WARNING
,
1091 "Background saving terminated by signal");
1092 rdbRemoveTempFile(server
.bgsavechildpid
);
1094 server
.bgsavechildpid
= -1;
1095 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1096 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1097 updateSlavesWaitingBgsave(exitcode
== 0 ? REDIS_OK
: REDIS_ERR
);
1100 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1102 void backgroundRewriteDoneHandler(int statloc
) {
1103 int exitcode
= WEXITSTATUS(statloc
);
1104 int bysignal
= WIFSIGNALED(statloc
);
1106 if (!bysignal
&& exitcode
== 0) {
1110 redisLog(REDIS_NOTICE
,
1111 "Background append only file rewriting terminated with success");
1112 /* Now it's time to flush the differences accumulated by the parent */
1113 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) server
.bgrewritechildpid
);
1114 fd
= open(tmpfile
,O_WRONLY
|O_APPEND
);
1116 redisLog(REDIS_WARNING
, "Not able to open the temp append only file produced by the child: %s", strerror(errno
));
1119 /* Flush our data... */
1120 if (write(fd
,server
.bgrewritebuf
,sdslen(server
.bgrewritebuf
)) !=
1121 (signed) sdslen(server
.bgrewritebuf
)) {
1122 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
));
1126 redisLog(REDIS_NOTICE
,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server
.bgrewritebuf
));
1127 /* Now our work is to rename the temp file into the stable file. And
1128 * switch the file descriptor used by the server for append only. */
1129 if (rename(tmpfile
,server
.appendfilename
) == -1) {
1130 redisLog(REDIS_WARNING
,"Can't rename the temp append only file into the stable one: %s", strerror(errno
));
1134 /* Mission completed... almost */
1135 redisLog(REDIS_NOTICE
,"Append only file successfully rewritten.");
1136 if (server
.appendfd
!= -1) {
1137 /* If append only is actually enabled... */
1138 close(server
.appendfd
);
1139 server
.appendfd
= fd
;
1141 server
.appendseldb
= -1; /* Make sure it will issue SELECT */
1142 redisLog(REDIS_NOTICE
,"The new append only file was selected for future appends.");
1144 /* If append only is disabled we just generate a dump in this
1145 * format. Why not? */
1148 } else if (!bysignal
&& exitcode
!= 0) {
1149 redisLog(REDIS_WARNING
, "Background append only file rewriting error");
1151 redisLog(REDIS_WARNING
,
1152 "Background append only file rewriting terminated by signal");
1155 sdsfree(server
.bgrewritebuf
);
1156 server
.bgrewritebuf
= sdsempty();
1157 aofRemoveTempFile(server
.bgrewritechildpid
);
1158 server
.bgrewritechildpid
= -1;
1161 static int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
1162 int j
, loops
= server
.cronloops
++;
1163 REDIS_NOTUSED(eventLoop
);
1165 REDIS_NOTUSED(clientData
);
1167 /* We take a cached value of the unix time in the global state because
1168 * with virtual memory and aging there is to store the current time
1169 * in objects at every object access, and accuracy is not needed.
1170 * To access a global var is faster than calling time(NULL) */
1171 server
.unixtime
= time(NULL
);
1173 /* Update the global state with the amount of used memory */
1174 server
.usedmemory
= zmalloc_used_memory();
1176 /* Show some info about non-empty databases */
1177 for (j
= 0; j
< server
.dbnum
; j
++) {
1178 long long size
, used
, vkeys
;
1180 size
= dictSlots(server
.db
[j
].dict
);
1181 used
= dictSize(server
.db
[j
].dict
);
1182 vkeys
= dictSize(server
.db
[j
].expires
);
1183 if (!(loops
% 5) && (used
|| vkeys
)) {
1184 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
1185 /* dictPrintStats(server.dict); */
1189 /* We don't want to resize the hash tables while a bacground saving
1190 * is in progress: the saving child is created using fork() that is
1191 * implemented with a copy-on-write semantic in most modern systems, so
1192 * if we resize the HT while there is the saving child at work actually
1193 * a lot of memory movements in the parent will cause a lot of pages
1195 if (server
.bgsavechildpid
== -1) tryResizeHashTables();
1197 /* Show information about connected clients */
1199 redisLog(REDIS_VERBOSE
,"%d clients connected (%d slaves), %zu bytes in use, %d shared objects",
1200 listLength(server
.clients
)-listLength(server
.slaves
),
1201 listLength(server
.slaves
),
1203 dictSize(server
.sharingpool
));
1206 /* Close connections of timedout clients */
1207 if ((server
.maxidletime
&& !(loops
% 10)) || server
.blockedclients
)
1208 closeTimedoutClients();
1210 /* Check if a background saving or AOF rewrite in progress terminated */
1211 if (server
.bgsavechildpid
!= -1 || server
.bgrewritechildpid
!= -1) {
1215 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
1216 if (pid
== server
.bgsavechildpid
) {
1217 backgroundSaveDoneHandler(statloc
);
1219 backgroundRewriteDoneHandler(statloc
);
1223 /* If there is not a background saving in progress check if
1224 * we have to save now */
1225 time_t now
= time(NULL
);
1226 for (j
= 0; j
< server
.saveparamslen
; j
++) {
1227 struct saveparam
*sp
= server
.saveparams
+j
;
1229 if (server
.dirty
>= sp
->changes
&&
1230 now
-server
.lastsave
> sp
->seconds
) {
1231 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
1232 sp
->changes
, sp
->seconds
);
1233 rdbSaveBackground(server
.dbfilename
);
1239 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1240 * will use few CPU cycles if there are few expiring keys, otherwise
1241 * it will get more aggressive to avoid that too much memory is used by
1242 * keys that can be removed from the keyspace. */
1243 for (j
= 0; j
< server
.dbnum
; j
++) {
1245 redisDb
*db
= server
.db
+j
;
1247 /* Continue to expire if at the end of the cycle more than 25%
1248 * of the keys were expired. */
1250 long num
= dictSize(db
->expires
);
1251 time_t now
= time(NULL
);
1254 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
1255 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
1260 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
1261 t
= (time_t) dictGetEntryVal(de
);
1263 deleteKey(db
,dictGetEntryKey(de
));
1267 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
1270 /* Swap a few keys on disk if we are over the memory limit and VM
1271 * is enbled. Try to free objects from the free list first. */
1272 if (vmCanSwapOut()) {
1273 while (server
.vm_enabled
&& zmalloc_used_memory() >
1274 server
.vm_max_memory
)
1278 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
1279 retval
= (server
.vm_max_threads
== 0) ?
1280 vmSwapOneObjectBlocking() :
1281 vmSwapOneObjectThreaded();
1282 if (retval
== REDIS_ERR
&& (loops
% 30) == 0 &&
1283 zmalloc_used_memory() >
1284 (server
.vm_max_memory
+server
.vm_max_memory
/10))
1286 redisLog(REDIS_WARNING
,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1288 /* Note that when using threade I/O we free just one object,
1289 * because anyway when the I/O thread in charge to swap this
1290 * object out will finish, the handler of completed jobs
1291 * will try to swap more objects if we are still out of memory. */
1292 if (retval
== REDIS_ERR
|| server
.vm_max_threads
> 0) break;
1296 /* Check if we should connect to a MASTER */
1297 if (server
.replstate
== REDIS_REPL_CONNECT
) {
1298 redisLog(REDIS_NOTICE
,"Connecting to MASTER...");
1299 if (syncWithMaster() == REDIS_OK
) {
1300 redisLog(REDIS_NOTICE
,"MASTER <-> SLAVE sync succeeded");
1306 static void createSharedObjects(void) {
1307 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1308 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1309 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1310 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1311 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1312 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1313 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1314 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1315 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1316 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1317 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1318 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1319 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1320 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1321 "-ERR no such key\r\n"));
1322 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1323 "-ERR syntax error\r\n"));
1324 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1325 "-ERR source and destination objects are the same\r\n"));
1326 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1327 "-ERR index out of range\r\n"));
1328 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1329 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1330 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1331 shared
.select0
= createStringObject("select 0\r\n",10);
1332 shared
.select1
= createStringObject("select 1\r\n",10);
1333 shared
.select2
= createStringObject("select 2\r\n",10);
1334 shared
.select3
= createStringObject("select 3\r\n",10);
1335 shared
.select4
= createStringObject("select 4\r\n",10);
1336 shared
.select5
= createStringObject("select 5\r\n",10);
1337 shared
.select6
= createStringObject("select 6\r\n",10);
1338 shared
.select7
= createStringObject("select 7\r\n",10);
1339 shared
.select8
= createStringObject("select 8\r\n",10);
1340 shared
.select9
= createStringObject("select 9\r\n",10);
1343 static void appendServerSaveParams(time_t seconds
, int changes
) {
1344 server
.saveparams
= zrealloc(server
.saveparams
,sizeof(struct saveparam
)*(server
.saveparamslen
+1));
1345 server
.saveparams
[server
.saveparamslen
].seconds
= seconds
;
1346 server
.saveparams
[server
.saveparamslen
].changes
= changes
;
1347 server
.saveparamslen
++;
1350 static void resetServerSaveParams() {
1351 zfree(server
.saveparams
);
1352 server
.saveparams
= NULL
;
1353 server
.saveparamslen
= 0;
1356 static void initServerConfig() {
1357 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1358 server
.port
= REDIS_SERVERPORT
;
1359 server
.verbosity
= REDIS_VERBOSE
;
1360 server
.maxidletime
= REDIS_MAXIDLETIME
;
1361 server
.saveparams
= NULL
;
1362 server
.logfile
= NULL
; /* NULL = log on standard output */
1363 server
.bindaddr
= NULL
;
1364 server
.glueoutputbuf
= 1;
1365 server
.daemonize
= 0;
1366 server
.appendonly
= 0;
1367 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1368 server
.lastfsync
= time(NULL
);
1369 server
.appendfd
= -1;
1370 server
.appendseldb
= -1; /* Make sure the first time will not match */
1371 server
.pidfile
= "/var/run/redis.pid";
1372 server
.dbfilename
= "dump.rdb";
1373 server
.appendfilename
= "appendonly.aof";
1374 server
.requirepass
= NULL
;
1375 server
.shareobjects
= 0;
1376 server
.rdbcompression
= 1;
1377 server
.sharingpoolsize
= 1024;
1378 server
.maxclients
= 0;
1379 server
.blockedclients
= 0;
1380 server
.maxmemory
= 0;
1381 server
.vm_enabled
= 0;
1382 server
.vm_swap_file
= zstrdup("/tmp/redis-%p.vm");
1383 server
.vm_page_size
= 256; /* 256 bytes per page */
1384 server
.vm_pages
= 1024*1024*100; /* 104 millions of pages */
1385 server
.vm_max_memory
= 1024LL*1024*1024*1; /* 1 GB of RAM */
1386 server
.vm_max_threads
= 4;
1388 resetServerSaveParams();
1390 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1391 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1392 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1393 /* Replication related */
1395 server
.masterauth
= NULL
;
1396 server
.masterhost
= NULL
;
1397 server
.masterport
= 6379;
1398 server
.master
= NULL
;
1399 server
.replstate
= REDIS_REPL_NONE
;
1401 /* Double constants initialization */
1403 R_PosInf
= 1.0/R_Zero
;
1404 R_NegInf
= -1.0/R_Zero
;
1405 R_Nan
= R_Zero
/R_Zero
;
1408 static void initServer() {
1411 signal(SIGHUP
, SIG_IGN
);
1412 signal(SIGPIPE
, SIG_IGN
);
1413 setupSigSegvAction();
1415 server
.devnull
= fopen("/dev/null","w");
1416 if (server
.devnull
== NULL
) {
1417 redisLog(REDIS_WARNING
, "Can't open /dev/null: %s", server
.neterr
);
1420 server
.clients
= listCreate();
1421 server
.slaves
= listCreate();
1422 server
.monitors
= listCreate();
1423 server
.objfreelist
= listCreate();
1424 createSharedObjects();
1425 server
.el
= aeCreateEventLoop();
1426 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1427 server
.sharingpool
= dictCreate(&setDictType
,NULL
);
1428 server
.fd
= anetTcpServer(server
.neterr
, server
.port
, server
.bindaddr
);
1429 if (server
.fd
== -1) {
1430 redisLog(REDIS_WARNING
, "Opening TCP port: %s", server
.neterr
);
1433 for (j
= 0; j
< server
.dbnum
; j
++) {
1434 server
.db
[j
].dict
= dictCreate(&hashDictType
,NULL
);
1435 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1436 server
.db
[j
].blockingkeys
= dictCreate(&keylistDictType
,NULL
);
1437 server
.db
[j
].id
= j
;
1439 server
.cronloops
= 0;
1440 server
.bgsavechildpid
= -1;
1441 server
.bgrewritechildpid
= -1;
1442 server
.bgrewritebuf
= sdsempty();
1443 server
.lastsave
= time(NULL
);
1445 server
.usedmemory
= 0;
1446 server
.stat_numcommands
= 0;
1447 server
.stat_numconnections
= 0;
1448 server
.stat_starttime
= time(NULL
);
1449 server
.unixtime
= time(NULL
);
1450 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1451 if (aeCreateFileEvent(server
.el
, server
.fd
, AE_READABLE
,
1452 acceptHandler
, NULL
) == AE_ERR
) oom("creating file event");
1454 if (server
.appendonly
) {
1455 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1456 if (server
.appendfd
== -1) {
1457 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1463 if (server
.vm_enabled
) vmInit();
1466 /* Empty the whole database */
1467 static long long emptyDb() {
1469 long long removed
= 0;
1471 for (j
= 0; j
< server
.dbnum
; j
++) {
1472 removed
+= dictSize(server
.db
[j
].dict
);
1473 dictEmpty(server
.db
[j
].dict
);
1474 dictEmpty(server
.db
[j
].expires
);
1479 static int yesnotoi(char *s
) {
1480 if (!strcasecmp(s
,"yes")) return 1;
1481 else if (!strcasecmp(s
,"no")) return 0;
1485 /* I agree, this is a very rudimental way to load a configuration...
1486 will improve later if the config gets more complex */
1487 static void loadServerConfig(char *filename
) {
1489 char buf
[REDIS_CONFIGLINE_MAX
+1], *err
= NULL
;
1493 if (filename
[0] == '-' && filename
[1] == '\0')
1496 if ((fp
= fopen(filename
,"r")) == NULL
) {
1497 redisLog(REDIS_WARNING
,"Fatal error, can't open config file");
1502 while(fgets(buf
,REDIS_CONFIGLINE_MAX
+1,fp
) != NULL
) {
1508 line
= sdstrim(line
," \t\r\n");
1510 /* Skip comments and blank lines*/
1511 if (line
[0] == '#' || line
[0] == '\0') {
1516 /* Split into arguments */
1517 argv
= sdssplitlen(line
,sdslen(line
)," ",1,&argc
);
1518 sdstolower(argv
[0]);
1520 /* Execute config directives */
1521 if (!strcasecmp(argv
[0],"timeout") && argc
== 2) {
1522 server
.maxidletime
= atoi(argv
[1]);
1523 if (server
.maxidletime
< 0) {
1524 err
= "Invalid timeout value"; goto loaderr
;
1526 } else if (!strcasecmp(argv
[0],"port") && argc
== 2) {
1527 server
.port
= atoi(argv
[1]);
1528 if (server
.port
< 1 || server
.port
> 65535) {
1529 err
= "Invalid port"; goto loaderr
;
1531 } else if (!strcasecmp(argv
[0],"bind") && argc
== 2) {
1532 server
.bindaddr
= zstrdup(argv
[1]);
1533 } else if (!strcasecmp(argv
[0],"save") && argc
== 3) {
1534 int seconds
= atoi(argv
[1]);
1535 int changes
= atoi(argv
[2]);
1536 if (seconds
< 1 || changes
< 0) {
1537 err
= "Invalid save parameters"; goto loaderr
;
1539 appendServerSaveParams(seconds
,changes
);
1540 } else if (!strcasecmp(argv
[0],"dir") && argc
== 2) {
1541 if (chdir(argv
[1]) == -1) {
1542 redisLog(REDIS_WARNING
,"Can't chdir to '%s': %s",
1543 argv
[1], strerror(errno
));
1546 } else if (!strcasecmp(argv
[0],"loglevel") && argc
== 2) {
1547 if (!strcasecmp(argv
[1],"debug")) server
.verbosity
= REDIS_DEBUG
;
1548 else if (!strcasecmp(argv
[1],"verbose")) server
.verbosity
= REDIS_VERBOSE
;
1549 else if (!strcasecmp(argv
[1],"notice")) server
.verbosity
= REDIS_NOTICE
;
1550 else if (!strcasecmp(argv
[1],"warning")) server
.verbosity
= REDIS_WARNING
;
1552 err
= "Invalid log level. Must be one of debug, notice, warning";
1555 } else if (!strcasecmp(argv
[0],"logfile") && argc
== 2) {
1558 server
.logfile
= zstrdup(argv
[1]);
1559 if (!strcasecmp(server
.logfile
,"stdout")) {
1560 zfree(server
.logfile
);
1561 server
.logfile
= NULL
;
1563 if (server
.logfile
) {
1564 /* Test if we are able to open the file. The server will not
1565 * be able to abort just for this problem later... */
1566 logfp
= fopen(server
.logfile
,"a");
1567 if (logfp
== NULL
) {
1568 err
= sdscatprintf(sdsempty(),
1569 "Can't open the log file: %s", strerror(errno
));
1574 } else if (!strcasecmp(argv
[0],"databases") && argc
== 2) {
1575 server
.dbnum
= atoi(argv
[1]);
1576 if (server
.dbnum
< 1) {
1577 err
= "Invalid number of databases"; goto loaderr
;
1579 } else if (!strcasecmp(argv
[0],"maxclients") && argc
== 2) {
1580 server
.maxclients
= atoi(argv
[1]);
1581 } else if (!strcasecmp(argv
[0],"maxmemory") && argc
== 2) {
1582 server
.maxmemory
= strtoll(argv
[1], NULL
, 10);
1583 } else if (!strcasecmp(argv
[0],"slaveof") && argc
== 3) {
1584 server
.masterhost
= sdsnew(argv
[1]);
1585 server
.masterport
= atoi(argv
[2]);
1586 server
.replstate
= REDIS_REPL_CONNECT
;
1587 } else if (!strcasecmp(argv
[0],"masterauth") && argc
== 2) {
1588 server
.masterauth
= zstrdup(argv
[1]);
1589 } else if (!strcasecmp(argv
[0],"glueoutputbuf") && argc
== 2) {
1590 if ((server
.glueoutputbuf
= yesnotoi(argv
[1])) == -1) {
1591 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1593 } else if (!strcasecmp(argv
[0],"shareobjects") && argc
== 2) {
1594 if ((server
.shareobjects
= yesnotoi(argv
[1])) == -1) {
1595 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1597 } else if (!strcasecmp(argv
[0],"rdbcompression") && argc
== 2) {
1598 if ((server
.rdbcompression
= yesnotoi(argv
[1])) == -1) {
1599 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1601 } else if (!strcasecmp(argv
[0],"shareobjectspoolsize") && argc
== 2) {
1602 server
.sharingpoolsize
= atoi(argv
[1]);
1603 if (server
.sharingpoolsize
< 1) {
1604 err
= "invalid object sharing pool size"; goto loaderr
;
1606 } else if (!strcasecmp(argv
[0],"daemonize") && argc
== 2) {
1607 if ((server
.daemonize
= yesnotoi(argv
[1])) == -1) {
1608 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1610 } else if (!strcasecmp(argv
[0],"appendonly") && argc
== 2) {
1611 if ((server
.appendonly
= yesnotoi(argv
[1])) == -1) {
1612 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1614 } else if (!strcasecmp(argv
[0],"appendfsync") && argc
== 2) {
1615 if (!strcasecmp(argv
[1],"no")) {
1616 server
.appendfsync
= APPENDFSYNC_NO
;
1617 } else if (!strcasecmp(argv
[1],"always")) {
1618 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1619 } else if (!strcasecmp(argv
[1],"everysec")) {
1620 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1622 err
= "argument must be 'no', 'always' or 'everysec'";
1625 } else if (!strcasecmp(argv
[0],"requirepass") && argc
== 2) {
1626 server
.requirepass
= zstrdup(argv
[1]);
1627 } else if (!strcasecmp(argv
[0],"pidfile") && argc
== 2) {
1628 server
.pidfile
= zstrdup(argv
[1]);
1629 } else if (!strcasecmp(argv
[0],"dbfilename") && argc
== 2) {
1630 server
.dbfilename
= zstrdup(argv
[1]);
1631 } else if (!strcasecmp(argv
[0],"vm-enabled") && argc
== 2) {
1632 if ((server
.vm_enabled
= yesnotoi(argv
[1])) == -1) {
1633 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1635 } else if (!strcasecmp(argv
[0],"vm-swap-file") && argc
== 2) {
1636 zfree(server
.vm_swap_file
);
1637 server
.vm_swap_file
= zstrdup(argv
[1]);
1638 } else if (!strcasecmp(argv
[0],"vm-max-memory") && argc
== 2) {
1639 server
.vm_max_memory
= strtoll(argv
[1], NULL
, 10);
1640 } else if (!strcasecmp(argv
[0],"vm-page-size") && argc
== 2) {
1641 server
.vm_page_size
= strtoll(argv
[1], NULL
, 10);
1642 } else if (!strcasecmp(argv
[0],"vm-pages") && argc
== 2) {
1643 server
.vm_pages
= strtoll(argv
[1], NULL
, 10);
1644 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1645 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1647 err
= "Bad directive or wrong number of arguments"; goto loaderr
;
1649 for (j
= 0; j
< argc
; j
++)
1654 if (fp
!= stdin
) fclose(fp
);
1658 fprintf(stderr
, "\n*** FATAL CONFIG FILE ERROR ***\n");
1659 fprintf(stderr
, "Reading the configuration file, at line %d\n", linenum
);
1660 fprintf(stderr
, ">>> '%s'\n", line
);
1661 fprintf(stderr
, "%s\n", err
);
1665 static void freeClientArgv(redisClient
*c
) {
1668 for (j
= 0; j
< c
->argc
; j
++)
1669 decrRefCount(c
->argv
[j
]);
1670 for (j
= 0; j
< c
->mbargc
; j
++)
1671 decrRefCount(c
->mbargv
[j
]);
1676 static void freeClient(redisClient
*c
) {
1679 /* Note that if the client we are freeing is blocked into a blocking
1680 * call, we have to set querybuf to NULL *before* to call unblockClient()
1681 * to avoid processInputBuffer() will get called. Also it is important
1682 * to remove the file events after this, because this call adds
1683 * the READABLE event. */
1684 sdsfree(c
->querybuf
);
1686 if (c
->flags
& REDIS_BLOCKED
)
1689 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
1690 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1691 listRelease(c
->reply
);
1694 /* Remove from the list of clients */
1695 ln
= listSearchKey(server
.clients
,c
);
1696 redisAssert(ln
!= NULL
);
1697 listDelNode(server
.clients
,ln
);
1698 /* Remove from the list of clients waiting for VM operations */
1699 if (server
.vm_enabled
&& listLength(c
->io_keys
)) {
1700 ln
= listSearchKey(server
.io_clients
,c
);
1701 if (ln
) listDelNode(server
.io_clients
,ln
);
1702 listRelease(c
->io_keys
);
1704 listRelease(c
->io_keys
);
1706 if (c
->flags
& REDIS_SLAVE
) {
1707 if (c
->replstate
== REDIS_REPL_SEND_BULK
&& c
->repldbfd
!= -1)
1709 list
*l
= (c
->flags
& REDIS_MONITOR
) ? server
.monitors
: server
.slaves
;
1710 ln
= listSearchKey(l
,c
);
1711 redisAssert(ln
!= NULL
);
1714 if (c
->flags
& REDIS_MASTER
) {
1715 server
.master
= NULL
;
1716 server
.replstate
= REDIS_REPL_CONNECT
;
1720 freeClientMultiState(c
);
1724 #define GLUEREPLY_UP_TO (1024)
1725 static void glueReplyBuffersIfNeeded(redisClient
*c
) {
1727 char buf
[GLUEREPLY_UP_TO
];
1732 listRewind(c
->reply
,&li
);
1733 while((ln
= listNext(&li
))) {
1737 objlen
= sdslen(o
->ptr
);
1738 if (copylen
+ objlen
<= GLUEREPLY_UP_TO
) {
1739 memcpy(buf
+copylen
,o
->ptr
,objlen
);
1741 listDelNode(c
->reply
,ln
);
1743 if (copylen
== 0) return;
1747 /* Now the output buffer is empty, add the new single element */
1748 o
= createObject(REDIS_STRING
,sdsnewlen(buf
,copylen
));
1749 listAddNodeHead(c
->reply
,o
);
1752 static void sendReplyToClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
1753 redisClient
*c
= privdata
;
1754 int nwritten
= 0, totwritten
= 0, objlen
;
1757 REDIS_NOTUSED(mask
);
1759 /* Use writev() if we have enough buffers to send */
1760 if (!server
.glueoutputbuf
&&
1761 listLength(c
->reply
) > REDIS_WRITEV_THRESHOLD
&&
1762 !(c
->flags
& REDIS_MASTER
))
1764 sendReplyToClientWritev(el
, fd
, privdata
, mask
);
1768 while(listLength(c
->reply
)) {
1769 if (server
.glueoutputbuf
&& listLength(c
->reply
) > 1)
1770 glueReplyBuffersIfNeeded(c
);
1772 o
= listNodeValue(listFirst(c
->reply
));
1773 objlen
= sdslen(o
->ptr
);
1776 listDelNode(c
->reply
,listFirst(c
->reply
));
1780 if (c
->flags
& REDIS_MASTER
) {
1781 /* Don't reply to a master */
1782 nwritten
= objlen
- c
->sentlen
;
1784 nwritten
= write(fd
, ((char*)o
->ptr
)+c
->sentlen
, objlen
- c
->sentlen
);
1785 if (nwritten
<= 0) break;
1787 c
->sentlen
+= nwritten
;
1788 totwritten
+= nwritten
;
1789 /* If we fully sent the object on head go to the next one */
1790 if (c
->sentlen
== objlen
) {
1791 listDelNode(c
->reply
,listFirst(c
->reply
));
1794 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
1795 * bytes, in a single threaded server it's a good idea to serve
1796 * other clients as well, even if a very large request comes from
1797 * super fast link that is always able to accept data (in real world
1798 * scenario think about 'KEYS *' against the loopback interfae) */
1799 if (totwritten
> REDIS_MAX_WRITE_PER_EVENT
) break;
1801 if (nwritten
== -1) {
1802 if (errno
== EAGAIN
) {
1805 redisLog(REDIS_VERBOSE
,
1806 "Error writing to client: %s", strerror(errno
));
1811 if (totwritten
> 0) c
->lastinteraction
= time(NULL
);
1812 if (listLength(c
->reply
) == 0) {
1814 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1818 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
)
1820 redisClient
*c
= privdata
;
1821 int nwritten
= 0, totwritten
= 0, objlen
, willwrite
;
1823 struct iovec iov
[REDIS_WRITEV_IOVEC_COUNT
];
1824 int offset
, ion
= 0;
1826 REDIS_NOTUSED(mask
);
1829 while (listLength(c
->reply
)) {
1830 offset
= c
->sentlen
;
1834 /* fill-in the iov[] array */
1835 for(node
= listFirst(c
->reply
); node
; node
= listNextNode(node
)) {
1836 o
= listNodeValue(node
);
1837 objlen
= sdslen(o
->ptr
);
1839 if (totwritten
+ objlen
- offset
> REDIS_MAX_WRITE_PER_EVENT
)
1842 if(ion
== REDIS_WRITEV_IOVEC_COUNT
)
1843 break; /* no more iovecs */
1845 iov
[ion
].iov_base
= ((char*)o
->ptr
) + offset
;
1846 iov
[ion
].iov_len
= objlen
- offset
;
1847 willwrite
+= objlen
- offset
;
1848 offset
= 0; /* just for the first item */
1855 /* write all collected blocks at once */
1856 if((nwritten
= writev(fd
, iov
, ion
)) < 0) {
1857 if (errno
!= EAGAIN
) {
1858 redisLog(REDIS_VERBOSE
,
1859 "Error writing to client: %s", strerror(errno
));
1866 totwritten
+= nwritten
;
1867 offset
= c
->sentlen
;
1869 /* remove written robjs from c->reply */
1870 while (nwritten
&& listLength(c
->reply
)) {
1871 o
= listNodeValue(listFirst(c
->reply
));
1872 objlen
= sdslen(o
->ptr
);
1874 if(nwritten
>= objlen
- offset
) {
1875 listDelNode(c
->reply
, listFirst(c
->reply
));
1876 nwritten
-= objlen
- offset
;
1880 c
->sentlen
+= nwritten
;
1888 c
->lastinteraction
= time(NULL
);
1890 if (listLength(c
->reply
) == 0) {
1892 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1896 static struct redisCommand
*lookupCommand(char *name
) {
1898 while(cmdTable
[j
].name
!= NULL
) {
1899 if (!strcasecmp(name
,cmdTable
[j
].name
)) return &cmdTable
[j
];
1905 /* resetClient prepare the client to process the next command */
1906 static void resetClient(redisClient
*c
) {
1912 /* Call() is the core of Redis execution of a command */
1913 static void call(redisClient
*c
, struct redisCommand
*cmd
) {
1916 dirty
= server
.dirty
;
1918 if (server
.appendonly
&& server
.dirty
-dirty
)
1919 feedAppendOnlyFile(cmd
,c
->db
->id
,c
->argv
,c
->argc
);
1920 if (server
.dirty
-dirty
&& listLength(server
.slaves
))
1921 replicationFeedSlaves(server
.slaves
,cmd
,c
->db
->id
,c
->argv
,c
->argc
);
1922 if (listLength(server
.monitors
))
1923 replicationFeedSlaves(server
.monitors
,cmd
,c
->db
->id
,c
->argv
,c
->argc
);
1924 server
.stat_numcommands
++;
1927 /* If this function gets called we already read a whole
1928 * command, argments are in the client argv/argc fields.
1929 * processCommand() execute the command or prepare the
1930 * server for a bulk read from the client.
1932 * If 1 is returned the client is still alive and valid and
1933 * and other operations can be performed by the caller. Otherwise
1934 * if 0 is returned the client was destroied (i.e. after QUIT). */
1935 static int processCommand(redisClient
*c
) {
1936 struct redisCommand
*cmd
;
1938 /* Free some memory if needed (maxmemory setting) */
1939 if (server
.maxmemory
) freeMemoryIfNeeded();
1941 /* Handle the multi bulk command type. This is an alternative protocol
1942 * supported by Redis in order to receive commands that are composed of
1943 * multiple binary-safe "bulk" arguments. The latency of processing is
1944 * a bit higher but this allows things like multi-sets, so if this
1945 * protocol is used only for MSET and similar commands this is a big win. */
1946 if (c
->multibulk
== 0 && c
->argc
== 1 && ((char*)(c
->argv
[0]->ptr
))[0] == '*') {
1947 c
->multibulk
= atoi(((char*)c
->argv
[0]->ptr
)+1);
1948 if (c
->multibulk
<= 0) {
1952 decrRefCount(c
->argv
[c
->argc
-1]);
1956 } else if (c
->multibulk
) {
1957 if (c
->bulklen
== -1) {
1958 if (((char*)c
->argv
[0]->ptr
)[0] != '$') {
1959 addReplySds(c
,sdsnew("-ERR multi bulk protocol error\r\n"));
1963 int bulklen
= atoi(((char*)c
->argv
[0]->ptr
)+1);
1964 decrRefCount(c
->argv
[0]);
1965 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
1967 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
1972 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
1976 c
->mbargv
= zrealloc(c
->mbargv
,(sizeof(robj
*))*(c
->mbargc
+1));
1977 c
->mbargv
[c
->mbargc
] = c
->argv
[0];
1981 if (c
->multibulk
== 0) {
1985 /* Here we need to swap the multi-bulk argc/argv with the
1986 * normal argc/argv of the client structure. */
1988 c
->argv
= c
->mbargv
;
1989 c
->mbargv
= auxargv
;
1992 c
->argc
= c
->mbargc
;
1993 c
->mbargc
= auxargc
;
1995 /* We need to set bulklen to something different than -1
1996 * in order for the code below to process the command without
1997 * to try to read the last argument of a bulk command as
1998 * a special argument. */
2000 /* continue below and process the command */
2007 /* -- end of multi bulk commands processing -- */
2009 /* The QUIT command is handled as a special case. Normal command
2010 * procs are unable to close the client connection safely */
2011 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
2015 cmd
= lookupCommand(c
->argv
[0]->ptr
);
2018 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2019 (char*)c
->argv
[0]->ptr
));
2022 } else if ((cmd
->arity
> 0 && cmd
->arity
!= c
->argc
) ||
2023 (c
->argc
< -cmd
->arity
)) {
2025 sdscatprintf(sdsempty(),
2026 "-ERR wrong number of arguments for '%s' command\r\n",
2030 } else if (server
.maxmemory
&& cmd
->flags
& REDIS_CMD_DENYOOM
&& zmalloc_used_memory() > server
.maxmemory
) {
2031 addReplySds(c
,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2034 } else if (cmd
->flags
& REDIS_CMD_BULK
&& c
->bulklen
== -1) {
2035 int bulklen
= atoi(c
->argv
[c
->argc
-1]->ptr
);
2037 decrRefCount(c
->argv
[c
->argc
-1]);
2038 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2040 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2045 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2046 /* It is possible that the bulk read is already in the
2047 * buffer. Check this condition and handle it accordingly.
2048 * This is just a fast path, alternative to call processInputBuffer().
2049 * It's a good idea since the code is small and this condition
2050 * happens most of the times. */
2051 if ((signed)sdslen(c
->querybuf
) >= c
->bulklen
) {
2052 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2054 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2059 /* Let's try to share objects on the command arguments vector */
2060 if (server
.shareobjects
) {
2062 for(j
= 1; j
< c
->argc
; j
++)
2063 c
->argv
[j
] = tryObjectSharing(c
->argv
[j
]);
2065 /* Let's try to encode the bulk object to save space. */
2066 if (cmd
->flags
& REDIS_CMD_BULK
)
2067 tryObjectEncoding(c
->argv
[c
->argc
-1]);
2069 /* Check if the user is authenticated */
2070 if (server
.requirepass
&& !c
->authenticated
&& cmd
->proc
!= authCommand
) {
2071 addReplySds(c
,sdsnew("-ERR operation not permitted\r\n"));
2076 /* Exec the command */
2077 if (c
->flags
& REDIS_MULTI
&& cmd
->proc
!= execCommand
) {
2078 queueMultiCommand(c
,cmd
);
2079 addReply(c
,shared
.queued
);
2084 /* Prepare the client for the next command */
2085 if (c
->flags
& REDIS_CLOSE
) {
2093 static void replicationFeedSlaves(list
*slaves
, struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
2098 /* (args*2)+1 is enough room for args, spaces, newlines */
2099 robj
*static_outv
[REDIS_STATIC_ARGS
*2+1];
2101 if (argc
<= REDIS_STATIC_ARGS
) {
2104 outv
= zmalloc(sizeof(robj
*)*(argc
*2+1));
2107 for (j
= 0; j
< argc
; j
++) {
2108 if (j
!= 0) outv
[outc
++] = shared
.space
;
2109 if ((cmd
->flags
& REDIS_CMD_BULK
) && j
== argc
-1) {
2112 lenobj
= createObject(REDIS_STRING
,
2113 sdscatprintf(sdsempty(),"%lu\r\n",
2114 (unsigned long) stringObjectLen(argv
[j
])));
2115 lenobj
->refcount
= 0;
2116 outv
[outc
++] = lenobj
;
2118 outv
[outc
++] = argv
[j
];
2120 outv
[outc
++] = shared
.crlf
;
2122 /* Increment all the refcounts at start and decrement at end in order to
2123 * be sure to free objects if there is no slave in a replication state
2124 * able to be feed with commands */
2125 for (j
= 0; j
< outc
; j
++) incrRefCount(outv
[j
]);
2126 listRewind(slaves
,&li
);
2127 while((ln
= listNext(&li
))) {
2128 redisClient
*slave
= ln
->value
;
2130 /* Don't feed slaves that are still waiting for BGSAVE to start */
2131 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) continue;
2133 /* Feed all the other slaves, MONITORs and so on */
2134 if (slave
->slaveseldb
!= dictid
) {
2138 case 0: selectcmd
= shared
.select0
; break;
2139 case 1: selectcmd
= shared
.select1
; break;
2140 case 2: selectcmd
= shared
.select2
; break;
2141 case 3: selectcmd
= shared
.select3
; break;
2142 case 4: selectcmd
= shared
.select4
; break;
2143 case 5: selectcmd
= shared
.select5
; break;
2144 case 6: selectcmd
= shared
.select6
; break;
2145 case 7: selectcmd
= shared
.select7
; break;
2146 case 8: selectcmd
= shared
.select8
; break;
2147 case 9: selectcmd
= shared
.select9
; break;
2149 selectcmd
= createObject(REDIS_STRING
,
2150 sdscatprintf(sdsempty(),"select %d\r\n",dictid
));
2151 selectcmd
->refcount
= 0;
2154 addReply(slave
,selectcmd
);
2155 slave
->slaveseldb
= dictid
;
2157 for (j
= 0; j
< outc
; j
++) addReply(slave
,outv
[j
]);
2159 for (j
= 0; j
< outc
; j
++) decrRefCount(outv
[j
]);
2160 if (outv
!= static_outv
) zfree(outv
);
2163 static void processInputBuffer(redisClient
*c
) {
2165 /* Before to process the input buffer, make sure the client is not
2166 * waitig for a blocking operation such as BLPOP. Note that the first
2167 * iteration the client is never blocked, otherwise the processInputBuffer
2168 * would not be called at all, but after the execution of the first commands
2169 * in the input buffer the client may be blocked, and the "goto again"
2170 * will try to reiterate. The following line will make it return asap. */
2171 if (c
->flags
& REDIS_BLOCKED
|| c
->flags
& REDIS_IO_WAIT
) return;
2172 if (c
->bulklen
== -1) {
2173 /* Read the first line of the query */
2174 char *p
= strchr(c
->querybuf
,'\n');
2181 query
= c
->querybuf
;
2182 c
->querybuf
= sdsempty();
2183 querylen
= 1+(p
-(query
));
2184 if (sdslen(query
) > querylen
) {
2185 /* leave data after the first line of the query in the buffer */
2186 c
->querybuf
= sdscatlen(c
->querybuf
,query
+querylen
,sdslen(query
)-querylen
);
2188 *p
= '\0'; /* remove "\n" */
2189 if (*(p
-1) == '\r') *(p
-1) = '\0'; /* and "\r" if any */
2190 sdsupdatelen(query
);
2192 /* Now we can split the query in arguments */
2193 argv
= sdssplitlen(query
,sdslen(query
)," ",1,&argc
);
2196 if (c
->argv
) zfree(c
->argv
);
2197 c
->argv
= zmalloc(sizeof(robj
*)*argc
);
2199 for (j
= 0; j
< argc
; j
++) {
2200 if (sdslen(argv
[j
])) {
2201 c
->argv
[c
->argc
] = createObject(REDIS_STRING
,argv
[j
]);
2209 /* Execute the command. If the client is still valid
2210 * after processCommand() return and there is something
2211 * on the query buffer try to process the next command. */
2212 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2214 /* Nothing to process, argc == 0. Just process the query
2215 * buffer if it's not empty or return to the caller */
2216 if (sdslen(c
->querybuf
)) goto again
;
2219 } else if (sdslen(c
->querybuf
) >= REDIS_REQUEST_MAX_SIZE
) {
2220 redisLog(REDIS_VERBOSE
, "Client protocol error");
2225 /* Bulk read handling. Note that if we are at this point
2226 the client already sent a command terminated with a newline,
2227 we are reading the bulk data that is actually the last
2228 argument of the command. */
2229 int qbl
= sdslen(c
->querybuf
);
2231 if (c
->bulklen
<= qbl
) {
2232 /* Copy everything but the final CRLF as final argument */
2233 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2235 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2236 /* Process the command. If the client is still valid after
2237 * the processing and there is more data in the buffer
2238 * try to parse it. */
2239 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2245 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2246 redisClient
*c
= (redisClient
*) privdata
;
2247 char buf
[REDIS_IOBUF_LEN
];
2250 REDIS_NOTUSED(mask
);
2252 nread
= read(fd
, buf
, REDIS_IOBUF_LEN
);
2254 if (errno
== EAGAIN
) {
2257 redisLog(REDIS_VERBOSE
, "Reading from client: %s",strerror(errno
));
2261 } else if (nread
== 0) {
2262 redisLog(REDIS_VERBOSE
, "Client closed connection");
2267 c
->querybuf
= sdscatlen(c
->querybuf
, buf
, nread
);
2268 c
->lastinteraction
= time(NULL
);
2272 processInputBuffer(c
);
2275 static int selectDb(redisClient
*c
, int id
) {
2276 if (id
< 0 || id
>= server
.dbnum
)
2278 c
->db
= &server
.db
[id
];
2282 static void *dupClientReplyValue(void *o
) {
2283 incrRefCount((robj
*)o
);
2287 static redisClient
*createClient(int fd
) {
2288 redisClient
*c
= zmalloc(sizeof(*c
));
2290 anetNonBlock(NULL
,fd
);
2291 anetTcpNoDelay(NULL
,fd
);
2292 if (!c
) return NULL
;
2295 c
->querybuf
= sdsempty();
2304 c
->lastinteraction
= time(NULL
);
2305 c
->authenticated
= 0;
2306 c
->replstate
= REDIS_REPL_NONE
;
2307 c
->reply
= listCreate();
2308 listSetFreeMethod(c
->reply
,decrRefCount
);
2309 listSetDupMethod(c
->reply
,dupClientReplyValue
);
2310 c
->blockingkeys
= NULL
;
2311 c
->blockingkeysnum
= 0;
2312 c
->io_keys
= listCreate();
2313 listSetFreeMethod(c
->io_keys
,decrRefCount
);
2314 if (aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
2315 readQueryFromClient
, c
) == AE_ERR
) {
2319 listAddNodeTail(server
.clients
,c
);
2320 initClientMultiState(c
);
2324 static void addReply(redisClient
*c
, robj
*obj
) {
2325 if (listLength(c
->reply
) == 0 &&
2326 (c
->replstate
== REDIS_REPL_NONE
||
2327 c
->replstate
== REDIS_REPL_ONLINE
) &&
2328 aeCreateFileEvent(server
.el
, c
->fd
, AE_WRITABLE
,
2329 sendReplyToClient
, c
) == AE_ERR
) return;
2331 if (server
.vm_enabled
&& obj
->storage
!= REDIS_VM_MEMORY
) {
2332 obj
= dupStringObject(obj
);
2333 obj
->refcount
= 0; /* getDecodedObject() will increment the refcount */
2335 listAddNodeTail(c
->reply
,getDecodedObject(obj
));
2338 static void addReplySds(redisClient
*c
, sds s
) {
2339 robj
*o
= createObject(REDIS_STRING
,s
);
2344 static void addReplyDouble(redisClient
*c
, double d
) {
2347 snprintf(buf
,sizeof(buf
),"%.17g",d
);
2348 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2349 (unsigned long) strlen(buf
),buf
));
2352 static void addReplyBulkLen(redisClient
*c
, robj
*obj
) {
2355 if (obj
->encoding
== REDIS_ENCODING_RAW
) {
2356 len
= sdslen(obj
->ptr
);
2358 long n
= (long)obj
->ptr
;
2360 /* Compute how many bytes will take this integer as a radix 10 string */
2366 while((n
= n
/10) != 0) {
2370 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",(unsigned long)len
));
2373 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2378 REDIS_NOTUSED(mask
);
2379 REDIS_NOTUSED(privdata
);
2381 cfd
= anetAccept(server
.neterr
, fd
, cip
, &cport
);
2382 if (cfd
== AE_ERR
) {
2383 redisLog(REDIS_VERBOSE
,"Accepting client connection: %s", server
.neterr
);
2386 redisLog(REDIS_VERBOSE
,"Accepted %s:%d", cip
, cport
);
2387 if ((c
= createClient(cfd
)) == NULL
) {
2388 redisLog(REDIS_WARNING
,"Error allocating resoures for the client");
2389 close(cfd
); /* May be already closed, just ingore errors */
2392 /* If maxclient directive is set and this is one client more... close the
2393 * connection. Note that we create the client instead to check before
2394 * for this condition, since now the socket is already set in nonblocking
2395 * mode and we can send an error for free using the Kernel I/O */
2396 if (server
.maxclients
&& listLength(server
.clients
) > server
.maxclients
) {
2397 char *err
= "-ERR max number of clients reached\r\n";
2399 /* That's a best effort error message, don't check write errors */
2400 if (write(c
->fd
,err
,strlen(err
)) == -1) {
2401 /* Nothing to do, Just to avoid the warning... */
2406 server
.stat_numconnections
++;
2409 /* ======================= Redis objects implementation ===================== */
2411 static robj
*createObject(int type
, void *ptr
) {
2414 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2415 if (listLength(server
.objfreelist
)) {
2416 listNode
*head
= listFirst(server
.objfreelist
);
2417 o
= listNodeValue(head
);
2418 listDelNode(server
.objfreelist
,head
);
2419 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2421 if (server
.vm_enabled
) {
2422 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2423 o
= zmalloc(sizeof(*o
));
2425 o
= zmalloc(sizeof(*o
)-sizeof(struct redisObjectVM
));
2429 o
->encoding
= REDIS_ENCODING_RAW
;
2432 if (server
.vm_enabled
) {
2433 /* Note that this code may run in the context of an I/O thread
2434 * and accessing to server.unixtime in theory is an error
2435 * (no locks). But in practice this is safe, and even if we read
2436 * garbage Redis will not fail, as it's just a statistical info */
2437 o
->vm
.atime
= server
.unixtime
;
2438 o
->storage
= REDIS_VM_MEMORY
;
2443 static robj
*createStringObject(char *ptr
, size_t len
) {
2444 return createObject(REDIS_STRING
,sdsnewlen(ptr
,len
));
2447 static robj
*dupStringObject(robj
*o
) {
2448 assert(o
->encoding
== REDIS_ENCODING_RAW
);
2449 return createStringObject(o
->ptr
,sdslen(o
->ptr
));
2452 static robj
*createListObject(void) {
2453 list
*l
= listCreate();
2455 listSetFreeMethod(l
,decrRefCount
);
2456 return createObject(REDIS_LIST
,l
);
2459 static robj
*createSetObject(void) {
2460 dict
*d
= dictCreate(&setDictType
,NULL
);
2461 return createObject(REDIS_SET
,d
);
2464 static robj
*createZsetObject(void) {
2465 zset
*zs
= zmalloc(sizeof(*zs
));
2467 zs
->dict
= dictCreate(&zsetDictType
,NULL
);
2468 zs
->zsl
= zslCreate();
2469 return createObject(REDIS_ZSET
,zs
);
2472 static void freeStringObject(robj
*o
) {
2473 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2478 static void freeListObject(robj
*o
) {
2479 listRelease((list
*) o
->ptr
);
2482 static void freeSetObject(robj
*o
) {
2483 dictRelease((dict
*) o
->ptr
);
2486 static void freeZsetObject(robj
*o
) {
2489 dictRelease(zs
->dict
);
2494 static void freeHashObject(robj
*o
) {
2495 dictRelease((dict
*) o
->ptr
);
2498 static void incrRefCount(robj
*o
) {
2499 redisAssert(!server
.vm_enabled
|| o
->storage
== REDIS_VM_MEMORY
);
2503 static void decrRefCount(void *obj
) {
2506 /* Object is swapped out, or in the process of being loaded. */
2507 if (server
.vm_enabled
&&
2508 (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
))
2510 if (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
) {
2511 redisAssert(o
->refcount
== 1);
2513 if (o
->storage
== REDIS_VM_LOADING
) vmCancelThreadedIOJob(obj
);
2514 redisAssert(o
->type
== REDIS_STRING
);
2515 freeStringObject(o
);
2516 vmMarkPagesFree(o
->vm
.page
,o
->vm
.usedpages
);
2517 pthread_mutex_lock(&server
.obj_freelist_mutex
);
2518 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2519 !listAddNodeHead(server
.objfreelist
,o
))
2521 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2522 server
.vm_stats_swapped_objects
--;
2525 /* Object is in memory, or in the process of being swapped out. */
2526 if (--(o
->refcount
) == 0) {
2527 if (server
.vm_enabled
&& o
->storage
== REDIS_VM_SWAPPING
)
2528 vmCancelThreadedIOJob(obj
);
2530 case REDIS_STRING
: freeStringObject(o
); break;
2531 case REDIS_LIST
: freeListObject(o
); break;
2532 case REDIS_SET
: freeSetObject(o
); break;
2533 case REDIS_ZSET
: freeZsetObject(o
); break;
2534 case REDIS_HASH
: freeHashObject(o
); break;
2535 default: redisAssert(0 != 0); break;
2537 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2538 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2539 !listAddNodeHead(server
.objfreelist
,o
))
2541 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2545 static robj
*lookupKey(redisDb
*db
, robj
*key
) {
2546 dictEntry
*de
= dictFind(db
->dict
,key
);
2548 robj
*key
= dictGetEntryKey(de
);
2549 robj
*val
= dictGetEntryVal(de
);
2551 if (server
.vm_enabled
) {
2552 if (key
->storage
== REDIS_VM_MEMORY
||
2553 key
->storage
== REDIS_VM_SWAPPING
)
2555 /* If we were swapping the object out, stop it, this key
2557 if (key
->storage
== REDIS_VM_SWAPPING
)
2558 vmCancelThreadedIOJob(key
);
2559 /* Update the access time of the key for the aging algorithm. */
2560 key
->vm
.atime
= server
.unixtime
;
2562 /* Our value was swapped on disk. Bring it at home. */
2563 redisAssert(val
== NULL
);
2564 val
= vmLoadObject(key
);
2565 dictGetEntryVal(de
) = val
;
2574 static robj
*lookupKeyRead(redisDb
*db
, robj
*key
) {
2575 expireIfNeeded(db
,key
);
2576 return lookupKey(db
,key
);
2579 static robj
*lookupKeyWrite(redisDb
*db
, robj
*key
) {
2580 deleteIfVolatile(db
,key
);
2581 return lookupKey(db
,key
);
2584 static int deleteKey(redisDb
*db
, robj
*key
) {
2587 /* We need to protect key from destruction: after the first dictDelete()
2588 * it may happen that 'key' is no longer valid if we don't increment
2589 * it's count. This may happen when we get the object reference directly
2590 * from the hash table with dictRandomKey() or dict iterators */
2592 if (dictSize(db
->expires
)) dictDelete(db
->expires
,key
);
2593 retval
= dictDelete(db
->dict
,key
);
2596 return retval
== DICT_OK
;
2599 /* Try to share an object against the shared objects pool */
2600 static robj
*tryObjectSharing(robj
*o
) {
2601 struct dictEntry
*de
;
2604 if (o
== NULL
|| server
.shareobjects
== 0) return o
;
2606 redisAssert(o
->type
== REDIS_STRING
);
2607 de
= dictFind(server
.sharingpool
,o
);
2609 robj
*shared
= dictGetEntryKey(de
);
2611 c
= ((unsigned long) dictGetEntryVal(de
))+1;
2612 dictGetEntryVal(de
) = (void*) c
;
2613 incrRefCount(shared
);
2617 /* Here we are using a stream algorihtm: Every time an object is
2618 * shared we increment its count, everytime there is a miss we
2619 * recrement the counter of a random object. If this object reaches
2620 * zero we remove the object and put the current object instead. */
2621 if (dictSize(server
.sharingpool
) >=
2622 server
.sharingpoolsize
) {
2623 de
= dictGetRandomKey(server
.sharingpool
);
2624 redisAssert(de
!= NULL
);
2625 c
= ((unsigned long) dictGetEntryVal(de
))-1;
2626 dictGetEntryVal(de
) = (void*) c
;
2628 dictDelete(server
.sharingpool
,de
->key
);
2631 c
= 0; /* If the pool is empty we want to add this object */
2636 retval
= dictAdd(server
.sharingpool
,o
,(void*)1);
2637 redisAssert(retval
== DICT_OK
);
2644 /* Check if the nul-terminated string 's' can be represented by a long
2645 * (that is, is a number that fits into long without any other space or
2646 * character before or after the digits).
2648 * If so, the function returns REDIS_OK and *longval is set to the value
2649 * of the number. Otherwise REDIS_ERR is returned */
2650 static int isStringRepresentableAsLong(sds s
, long *longval
) {
2651 char buf
[32], *endptr
;
2655 value
= strtol(s
, &endptr
, 10);
2656 if (endptr
[0] != '\0') return REDIS_ERR
;
2657 slen
= snprintf(buf
,32,"%ld",value
);
2659 /* If the number converted back into a string is not identical
2660 * then it's not possible to encode the string as integer */
2661 if (sdslen(s
) != (unsigned)slen
|| memcmp(buf
,s
,slen
)) return REDIS_ERR
;
2662 if (longval
) *longval
= value
;
2666 /* Try to encode a string object in order to save space */
2667 static int tryObjectEncoding(robj
*o
) {
2671 if (o
->encoding
!= REDIS_ENCODING_RAW
)
2672 return REDIS_ERR
; /* Already encoded */
2674 /* It's not save to encode shared objects: shared objects can be shared
2675 * everywhere in the "object space" of Redis. Encoded objects can only
2676 * appear as "values" (and not, for instance, as keys) */
2677 if (o
->refcount
> 1) return REDIS_ERR
;
2679 /* Currently we try to encode only strings */
2680 redisAssert(o
->type
== REDIS_STRING
);
2682 /* Check if we can represent this string as a long integer */
2683 if (isStringRepresentableAsLong(s
,&value
) == REDIS_ERR
) return REDIS_ERR
;
2685 /* Ok, this object can be encoded */
2686 o
->encoding
= REDIS_ENCODING_INT
;
2688 o
->ptr
= (void*) value
;
2692 /* Get a decoded version of an encoded object (returned as a new object).
2693 * If the object is already raw-encoded just increment the ref count. */
2694 static robj
*getDecodedObject(robj
*o
) {
2697 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2701 if (o
->type
== REDIS_STRING
&& o
->encoding
== REDIS_ENCODING_INT
) {
2704 snprintf(buf
,32,"%ld",(long)o
->ptr
);
2705 dec
= createStringObject(buf
,strlen(buf
));
2708 redisAssert(1 != 1);
2712 /* Compare two string objects via strcmp() or alike.
2713 * Note that the objects may be integer-encoded. In such a case we
2714 * use snprintf() to get a string representation of the numbers on the stack
2715 * and compare the strings, it's much faster than calling getDecodedObject().
2717 * Important note: if objects are not integer encoded, but binary-safe strings,
2718 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
2720 static int compareStringObjects(robj
*a
, robj
*b
) {
2721 redisAssert(a
->type
== REDIS_STRING
&& b
->type
== REDIS_STRING
);
2722 char bufa
[128], bufb
[128], *astr
, *bstr
;
2725 if (a
== b
) return 0;
2726 if (a
->encoding
!= REDIS_ENCODING_RAW
) {
2727 snprintf(bufa
,sizeof(bufa
),"%ld",(long) a
->ptr
);
2733 if (b
->encoding
!= REDIS_ENCODING_RAW
) {
2734 snprintf(bufb
,sizeof(bufb
),"%ld",(long) b
->ptr
);
2740 return bothsds
? sdscmp(astr
,bstr
) : strcmp(astr
,bstr
);
2743 static size_t stringObjectLen(robj
*o
) {
2744 redisAssert(o
->type
== REDIS_STRING
);
2745 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2746 return sdslen(o
->ptr
);
2750 return snprintf(buf
,32,"%ld",(long)o
->ptr
);
2754 /*============================ RDB saving/loading =========================== */
2756 static int rdbSaveType(FILE *fp
, unsigned char type
) {
2757 if (fwrite(&type
,1,1,fp
) == 0) return -1;
2761 static int rdbSaveTime(FILE *fp
, time_t t
) {
2762 int32_t t32
= (int32_t) t
;
2763 if (fwrite(&t32
,4,1,fp
) == 0) return -1;
2767 /* check rdbLoadLen() comments for more info */
2768 static int rdbSaveLen(FILE *fp
, uint32_t len
) {
2769 unsigned char buf
[2];
2772 /* Save a 6 bit len */
2773 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
2774 if (fwrite(buf
,1,1,fp
) == 0) return -1;
2775 } else if (len
< (1<<14)) {
2776 /* Save a 14 bit len */
2777 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
2779 if (fwrite(buf
,2,1,fp
) == 0) return -1;
2781 /* Save a 32 bit len */
2782 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
2783 if (fwrite(buf
,1,1,fp
) == 0) return -1;
2785 if (fwrite(&len
,4,1,fp
) == 0) return -1;
2790 /* String objects in the form "2391" "-100" without any space and with a
2791 * range of values that can fit in an 8, 16 or 32 bit signed value can be
2792 * encoded as integers to save space */
2793 static int rdbTryIntegerEncoding(sds s
, unsigned char *enc
) {
2795 char *endptr
, buf
[32];
2797 /* Check if it's possible to encode this value as a number */
2798 value
= strtoll(s
, &endptr
, 10);
2799 if (endptr
[0] != '\0') return 0;
2800 snprintf(buf
,32,"%lld",value
);
2802 /* If the number converted back into a string is not identical
2803 * then it's not possible to encode the string as integer */
2804 if (strlen(buf
) != sdslen(s
) || memcmp(buf
,s
,sdslen(s
))) return 0;
2806 /* Finally check if it fits in our ranges */
2807 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
2808 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
2809 enc
[1] = value
&0xFF;
2811 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
2812 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
2813 enc
[1] = value
&0xFF;
2814 enc
[2] = (value
>>8)&0xFF;
2816 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
2817 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
2818 enc
[1] = value
&0xFF;
2819 enc
[2] = (value
>>8)&0xFF;
2820 enc
[3] = (value
>>16)&0xFF;
2821 enc
[4] = (value
>>24)&0xFF;
2828 static int rdbSaveLzfStringObject(FILE *fp
, robj
*obj
) {
2829 unsigned int comprlen
, outlen
;
2833 /* We require at least four bytes compression for this to be worth it */
2834 outlen
= sdslen(obj
->ptr
)-4;
2835 if (outlen
<= 0) return 0;
2836 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
2837 comprlen
= lzf_compress(obj
->ptr
, sdslen(obj
->ptr
), out
, outlen
);
2838 if (comprlen
== 0) {
2842 /* Data compressed! Let's save it on disk */
2843 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
2844 if (fwrite(&byte
,1,1,fp
) == 0) goto writeerr
;
2845 if (rdbSaveLen(fp
,comprlen
) == -1) goto writeerr
;
2846 if (rdbSaveLen(fp
,sdslen(obj
->ptr
)) == -1) goto writeerr
;
2847 if (fwrite(out
,comprlen
,1,fp
) == 0) goto writeerr
;
2856 /* Save a string objet as [len][data] on disk. If the object is a string
2857 * representation of an integer value we try to safe it in a special form */
2858 static int rdbSaveStringObjectRaw(FILE *fp
, robj
*obj
) {
2862 len
= sdslen(obj
->ptr
);
2864 /* Try integer encoding */
2866 unsigned char buf
[5];
2867 if ((enclen
= rdbTryIntegerEncoding(obj
->ptr
,buf
)) > 0) {
2868 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
2873 /* Try LZF compression - under 20 bytes it's unable to compress even
2874 * aaaaaaaaaaaaaaaaaa so skip it */
2875 if (server
.rdbcompression
&& len
> 20) {
2878 retval
= rdbSaveLzfStringObject(fp
,obj
);
2879 if (retval
== -1) return -1;
2880 if (retval
> 0) return 0;
2881 /* retval == 0 means data can't be compressed, save the old way */
2884 /* Store verbatim */
2885 if (rdbSaveLen(fp
,len
) == -1) return -1;
2886 if (len
&& fwrite(obj
->ptr
,len
,1,fp
) == 0) return -1;
2890 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
2891 static int rdbSaveStringObject(FILE *fp
, robj
*obj
) {
2894 /* Avoid incr/decr ref count business when possible.
2895 * This plays well with copy-on-write given that we are probably
2896 * in a child process (BGSAVE). Also this makes sure key objects
2897 * of swapped objects are not incRefCount-ed (an assert does not allow
2898 * this in order to avoid bugs) */
2899 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
2900 obj
= getDecodedObject(obj
);
2901 retval
= rdbSaveStringObjectRaw(fp
,obj
);
2904 retval
= rdbSaveStringObjectRaw(fp
,obj
);
2909 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
2910 * 8 bit integer specifing the length of the representation.
2911 * This 8 bit integer has special values in order to specify the following
2917 static int rdbSaveDoubleValue(FILE *fp
, double val
) {
2918 unsigned char buf
[128];
2924 } else if (!isfinite(val
)) {
2926 buf
[0] = (val
< 0) ? 255 : 254;
2928 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
2929 buf
[0] = strlen((char*)buf
+1);
2932 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
2936 /* Save a Redis object. */
2937 static int rdbSaveObject(FILE *fp
, robj
*o
) {
2938 if (o
->type
== REDIS_STRING
) {
2939 /* Save a string value */
2940 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
2941 } else if (o
->type
== REDIS_LIST
) {
2942 /* Save a list value */
2943 list
*list
= o
->ptr
;
2947 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
2948 listRewind(list
,&li
);
2949 while((ln
= listNext(&li
))) {
2950 robj
*eleobj
= listNodeValue(ln
);
2952 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
2954 } else if (o
->type
== REDIS_SET
) {
2955 /* Save a set value */
2957 dictIterator
*di
= dictGetIterator(set
);
2960 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
2961 while((de
= dictNext(di
)) != NULL
) {
2962 robj
*eleobj
= dictGetEntryKey(de
);
2964 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
2966 dictReleaseIterator(di
);
2967 } else if (o
->type
== REDIS_ZSET
) {
2968 /* Save a set value */
2970 dictIterator
*di
= dictGetIterator(zs
->dict
);
2973 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
2974 while((de
= dictNext(di
)) != NULL
) {
2975 robj
*eleobj
= dictGetEntryKey(de
);
2976 double *score
= dictGetEntryVal(de
);
2978 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
2979 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
2981 dictReleaseIterator(di
);
2983 redisAssert(0 != 0);
2988 /* Return the length the object will have on disk if saved with
2989 * the rdbSaveObject() function. Currently we use a trick to get
2990 * this length with very little changes to the code. In the future
2991 * we could switch to a faster solution. */
2992 static off_t
rdbSavedObjectLen(robj
*o
, FILE *fp
) {
2993 if (fp
== NULL
) fp
= server
.devnull
;
2995 assert(rdbSaveObject(fp
,o
) != 1);
2999 /* Return the number of pages required to save this object in the swap file */
3000 static off_t
rdbSavedObjectPages(robj
*o
, FILE *fp
) {
3001 off_t bytes
= rdbSavedObjectLen(o
,fp
);
3003 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
3006 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3007 static int rdbSave(char *filename
) {
3008 dictIterator
*di
= NULL
;
3013 time_t now
= time(NULL
);
3015 /* Wait for I/O therads to terminate, just in case this is a
3016 * foreground-saving, to avoid seeking the swap file descriptor at the
3018 if (server
.vm_enabled
)
3019 waitEmptyIOJobsQueue();
3021 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
3022 fp
= fopen(tmpfile
,"w");
3024 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
3027 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
3028 for (j
= 0; j
< server
.dbnum
; j
++) {
3029 redisDb
*db
= server
.db
+j
;
3031 if (dictSize(d
) == 0) continue;
3032 di
= dictGetIterator(d
);
3038 /* Write the SELECT DB opcode */
3039 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
3040 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
3042 /* Iterate this DB writing every entry */
3043 while((de
= dictNext(di
)) != NULL
) {
3044 robj
*key
= dictGetEntryKey(de
);
3045 robj
*o
= dictGetEntryVal(de
);
3046 time_t expiretime
= getExpire(db
,key
);
3048 /* Save the expire time */
3049 if (expiretime
!= -1) {
3050 /* If this key is already expired skip it */
3051 if (expiretime
< now
) continue;
3052 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
3053 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
3055 /* Save the key and associated value. This requires special
3056 * handling if the value is swapped out. */
3057 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
3058 key
->storage
== REDIS_VM_SWAPPING
) {
3059 /* Save type, key, value */
3060 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
3061 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3062 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
3064 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3066 /* Get a preview of the object in memory */
3067 po
= vmPreviewObject(key
);
3068 /* Save type, key, value */
3069 if (rdbSaveType(fp
,key
->vtype
) == -1) goto werr
;
3070 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3071 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
3072 /* Remove the loaded object from memory */
3076 dictReleaseIterator(di
);
3079 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
3081 /* Make sure data will not remain on the OS's output buffers */
3086 /* Use RENAME to make sure the DB file is changed atomically only
3087 * if the generate DB file is ok. */
3088 if (rename(tmpfile
,filename
) == -1) {
3089 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
3093 redisLog(REDIS_NOTICE
,"DB saved on disk");
3095 server
.lastsave
= time(NULL
);
3101 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
3102 if (di
) dictReleaseIterator(di
);
3106 static int rdbSaveBackground(char *filename
) {
3109 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
3110 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
3111 if ((childpid
= fork()) == 0) {
3113 if (server
.vm_enabled
) vmReopenSwapFile();
3115 if (rdbSave(filename
) == REDIS_OK
) {
3122 if (childpid
== -1) {
3123 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
3127 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
3128 server
.bgsavechildpid
= childpid
;
3131 return REDIS_OK
; /* unreached */
3134 static void rdbRemoveTempFile(pid_t childpid
) {
3137 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
3141 static int rdbLoadType(FILE *fp
) {
3143 if (fread(&type
,1,1,fp
) == 0) return -1;
3147 static time_t rdbLoadTime(FILE *fp
) {
3149 if (fread(&t32
,4,1,fp
) == 0) return -1;
3150 return (time_t) t32
;
3153 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3154 * of this file for a description of how this are stored on disk.
3156 * isencoded is set to 1 if the readed length is not actually a length but
3157 * an "encoding type", check the above comments for more info */
3158 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
3159 unsigned char buf
[2];
3163 if (isencoded
) *isencoded
= 0;
3164 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3165 type
= (buf
[0]&0xC0)>>6;
3166 if (type
== REDIS_RDB_6BITLEN
) {
3167 /* Read a 6 bit len */
3169 } else if (type
== REDIS_RDB_ENCVAL
) {
3170 /* Read a 6 bit len encoding type */
3171 if (isencoded
) *isencoded
= 1;
3173 } else if (type
== REDIS_RDB_14BITLEN
) {
3174 /* Read a 14 bit len */
3175 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3176 return ((buf
[0]&0x3F)<<8)|buf
[1];
3178 /* Read a 32 bit len */
3179 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
3184 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
) {
3185 unsigned char enc
[4];
3188 if (enctype
== REDIS_RDB_ENC_INT8
) {
3189 if (fread(enc
,1,1,fp
) == 0) return NULL
;
3190 val
= (signed char)enc
[0];
3191 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
3193 if (fread(enc
,2,1,fp
) == 0) return NULL
;
3194 v
= enc
[0]|(enc
[1]<<8);
3196 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
3198 if (fread(enc
,4,1,fp
) == 0) return NULL
;
3199 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
3202 val
= 0; /* anti-warning */
3205 return createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",val
));
3208 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
3209 unsigned int len
, clen
;
3210 unsigned char *c
= NULL
;
3213 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3214 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3215 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
3216 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
3217 if (fread(c
,clen
,1,fp
) == 0) goto err
;
3218 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
3220 return createObject(REDIS_STRING
,val
);
3227 static robj
*rdbLoadStringObject(FILE*fp
) {
3232 len
= rdbLoadLen(fp
,&isencoded
);
3235 case REDIS_RDB_ENC_INT8
:
3236 case REDIS_RDB_ENC_INT16
:
3237 case REDIS_RDB_ENC_INT32
:
3238 return tryObjectSharing(rdbLoadIntegerObject(fp
,len
));
3239 case REDIS_RDB_ENC_LZF
:
3240 return tryObjectSharing(rdbLoadLzfStringObject(fp
));
3246 if (len
== REDIS_RDB_LENERR
) return NULL
;
3247 val
= sdsnewlen(NULL
,len
);
3248 if (len
&& fread(val
,len
,1,fp
) == 0) {
3252 return tryObjectSharing(createObject(REDIS_STRING
,val
));
3255 /* For information about double serialization check rdbSaveDoubleValue() */
3256 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
3260 if (fread(&len
,1,1,fp
) == 0) return -1;
3262 case 255: *val
= R_NegInf
; return 0;
3263 case 254: *val
= R_PosInf
; return 0;
3264 case 253: *val
= R_Nan
; return 0;
3266 if (fread(buf
,len
,1,fp
) == 0) return -1;
3268 sscanf(buf
, "%lg", val
);
3273 /* Load a Redis object of the specified type from the specified file.
3274 * On success a newly allocated object is returned, otherwise NULL. */
3275 static robj
*rdbLoadObject(int type
, FILE *fp
) {
3278 if (type
== REDIS_STRING
) {
3279 /* Read string value */
3280 if ((o
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3281 tryObjectEncoding(o
);
3282 } else if (type
== REDIS_LIST
|| type
== REDIS_SET
) {
3283 /* Read list/set value */
3286 if ((listlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3287 o
= (type
== REDIS_LIST
) ? createListObject() : createSetObject();
3288 /* Load every single element of the list/set */
3292 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3293 tryObjectEncoding(ele
);
3294 if (type
== REDIS_LIST
) {
3295 listAddNodeTail((list
*)o
->ptr
,ele
);
3297 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
3300 } else if (type
== REDIS_ZSET
) {
3301 /* Read list/set value */
3305 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3306 o
= createZsetObject();
3308 /* Load every single element of the list/set */
3311 double *score
= zmalloc(sizeof(double));
3313 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3314 tryObjectEncoding(ele
);
3315 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
3316 dictAdd(zs
->dict
,ele
,score
);
3317 zslInsert(zs
->zsl
,*score
,ele
);
3318 incrRefCount(ele
); /* added to skiplist */
3321 redisAssert(0 != 0);
3326 static int rdbLoad(char *filename
) {
3328 robj
*keyobj
= NULL
;
3330 int type
, retval
, rdbver
;
3331 dict
*d
= server
.db
[0].dict
;
3332 redisDb
*db
= server
.db
+0;
3334 time_t expiretime
= -1, now
= time(NULL
);
3335 long long loadedkeys
= 0;
3337 fp
= fopen(filename
,"r");
3338 if (!fp
) return REDIS_ERR
;
3339 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
3341 if (memcmp(buf
,"REDIS",5) != 0) {
3343 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
3346 rdbver
= atoi(buf
+5);
3349 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
3356 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3357 if (type
== REDIS_EXPIRETIME
) {
3358 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
3359 /* We read the time so we need to read the object type again */
3360 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3362 if (type
== REDIS_EOF
) break;
3363 /* Handle SELECT DB opcode as a special case */
3364 if (type
== REDIS_SELECTDB
) {
3365 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
3367 if (dbid
>= (unsigned)server
.dbnum
) {
3368 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
3371 db
= server
.db
+dbid
;
3376 if ((keyobj
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
3378 if ((o
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
3379 /* Add the new object in the hash table */
3380 retval
= dictAdd(d
,keyobj
,o
);
3381 if (retval
== DICT_ERR
) {
3382 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", keyobj
->ptr
);
3385 /* Set the expire time if needed */
3386 if (expiretime
!= -1) {
3387 setExpire(db
,keyobj
,expiretime
);
3388 /* Delete this key if already expired */
3389 if (expiretime
< now
) deleteKey(db
,keyobj
);
3393 /* Handle swapping while loading big datasets when VM is on */
3395 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
3396 while (zmalloc_used_memory() > server
.vm_max_memory
) {
3397 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
3404 eoferr
: /* unexpected end of file is handled here with a fatal exit */
3405 if (keyobj
) decrRefCount(keyobj
);
3406 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
3408 return REDIS_ERR
; /* Just to avoid warning */
3411 /*================================== Commands =============================== */
3413 static void authCommand(redisClient
*c
) {
3414 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
3415 c
->authenticated
= 1;
3416 addReply(c
,shared
.ok
);
3418 c
->authenticated
= 0;
3419 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
3423 static void pingCommand(redisClient
*c
) {
3424 addReply(c
,shared
.pong
);
3427 static void echoCommand(redisClient
*c
) {
3428 addReplyBulkLen(c
,c
->argv
[1]);
3429 addReply(c
,c
->argv
[1]);
3430 addReply(c
,shared
.crlf
);
3433 /*=================================== Strings =============================== */
3435 static void setGenericCommand(redisClient
*c
, int nx
) {
3438 if (nx
) deleteIfVolatile(c
->db
,c
->argv
[1]);
3439 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3440 if (retval
== DICT_ERR
) {
3442 /* If the key is about a swapped value, we want a new key object
3443 * to overwrite the old. So we delete the old key in the database.
3444 * This will also make sure that swap pages about the old object
3445 * will be marked as free. */
3446 if (deleteIfSwapped(c
->db
,c
->argv
[1]))
3447 incrRefCount(c
->argv
[1]);
3448 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3449 incrRefCount(c
->argv
[2]);
3451 addReply(c
,shared
.czero
);
3455 incrRefCount(c
->argv
[1]);
3456 incrRefCount(c
->argv
[2]);
3459 removeExpire(c
->db
,c
->argv
[1]);
3460 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3463 static void setCommand(redisClient
*c
) {
3464 setGenericCommand(c
,0);
3467 static void setnxCommand(redisClient
*c
) {
3468 setGenericCommand(c
,1);
3471 static int getGenericCommand(redisClient
*c
) {
3472 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[1]);
3475 addReply(c
,shared
.nullbulk
);
3478 if (o
->type
!= REDIS_STRING
) {
3479 addReply(c
,shared
.wrongtypeerr
);
3482 addReplyBulkLen(c
,o
);
3484 addReply(c
,shared
.crlf
);
3490 static void getCommand(redisClient
*c
) {
3491 getGenericCommand(c
);
3494 static void getsetCommand(redisClient
*c
) {
3495 if (getGenericCommand(c
) == REDIS_ERR
) return;
3496 if (dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]) == DICT_ERR
) {
3497 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3499 incrRefCount(c
->argv
[1]);
3501 incrRefCount(c
->argv
[2]);
3503 removeExpire(c
->db
,c
->argv
[1]);
3506 static void mgetCommand(redisClient
*c
) {
3509 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
3510 for (j
= 1; j
< c
->argc
; j
++) {
3511 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
3513 addReply(c
,shared
.nullbulk
);
3515 if (o
->type
!= REDIS_STRING
) {
3516 addReply(c
,shared
.nullbulk
);
3518 addReplyBulkLen(c
,o
);
3520 addReply(c
,shared
.crlf
);
3526 static void msetGenericCommand(redisClient
*c
, int nx
) {
3527 int j
, busykeys
= 0;
3529 if ((c
->argc
% 2) == 0) {
3530 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
3533 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
3534 * set nothing at all if at least one already key exists. */
3536 for (j
= 1; j
< c
->argc
; j
+= 2) {
3537 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
3543 addReply(c
, shared
.czero
);
3547 for (j
= 1; j
< c
->argc
; j
+= 2) {
3550 tryObjectEncoding(c
->argv
[j
+1]);
3551 retval
= dictAdd(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
3552 if (retval
== DICT_ERR
) {
3553 dictReplace(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
3554 incrRefCount(c
->argv
[j
+1]);
3556 incrRefCount(c
->argv
[j
]);
3557 incrRefCount(c
->argv
[j
+1]);
3559 removeExpire(c
->db
,c
->argv
[j
]);
3561 server
.dirty
+= (c
->argc
-1)/2;
3562 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3565 static void msetCommand(redisClient
*c
) {
3566 msetGenericCommand(c
,0);
3569 static void msetnxCommand(redisClient
*c
) {
3570 msetGenericCommand(c
,1);
3573 static void incrDecrCommand(redisClient
*c
, long long incr
) {
3578 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3582 if (o
->type
!= REDIS_STRING
) {
3587 if (o
->encoding
== REDIS_ENCODING_RAW
)
3588 value
= strtoll(o
->ptr
, &eptr
, 10);
3589 else if (o
->encoding
== REDIS_ENCODING_INT
)
3590 value
= (long)o
->ptr
;
3592 redisAssert(1 != 1);
3597 o
= createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
3598 tryObjectEncoding(o
);
3599 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],o
);
3600 if (retval
== DICT_ERR
) {
3601 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
3602 removeExpire(c
->db
,c
->argv
[1]);
3604 incrRefCount(c
->argv
[1]);
3607 addReply(c
,shared
.colon
);
3609 addReply(c
,shared
.crlf
);
3612 static void incrCommand(redisClient
*c
) {
3613 incrDecrCommand(c
,1);
3616 static void decrCommand(redisClient
*c
) {
3617 incrDecrCommand(c
,-1);
3620 static void incrbyCommand(redisClient
*c
) {
3621 long long incr
= strtoll(c
->argv
[2]->ptr
, NULL
, 10);
3622 incrDecrCommand(c
,incr
);
3625 static void decrbyCommand(redisClient
*c
) {
3626 long long incr
= strtoll(c
->argv
[2]->ptr
, NULL
, 10);
3627 incrDecrCommand(c
,-incr
);
3630 /* ========================= Type agnostic commands ========================= */
3632 static void delCommand(redisClient
*c
) {
3635 for (j
= 1; j
< c
->argc
; j
++) {
3636 if (deleteKey(c
->db
,c
->argv
[j
])) {
3643 addReply(c
,shared
.czero
);
3646 addReply(c
,shared
.cone
);
3649 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",deleted
));
3654 static void existsCommand(redisClient
*c
) {
3655 addReply(c
,lookupKeyRead(c
->db
,c
->argv
[1]) ? shared
.cone
: shared
.czero
);
3658 static void selectCommand(redisClient
*c
) {
3659 int id
= atoi(c
->argv
[1]->ptr
);
3661 if (selectDb(c
,id
) == REDIS_ERR
) {
3662 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
3664 addReply(c
,shared
.ok
);
3668 static void randomkeyCommand(redisClient
*c
) {
3672 de
= dictGetRandomKey(c
->db
->dict
);
3673 if (!de
|| expireIfNeeded(c
->db
,dictGetEntryKey(de
)) == 0) break;
3676 addReply(c
,shared
.plus
);
3677 addReply(c
,shared
.crlf
);
3679 addReply(c
,shared
.plus
);
3680 addReply(c
,dictGetEntryKey(de
));
3681 addReply(c
,shared
.crlf
);
3685 static void keysCommand(redisClient
*c
) {
3688 sds pattern
= c
->argv
[1]->ptr
;
3689 int plen
= sdslen(pattern
);
3690 unsigned long numkeys
= 0, keyslen
= 0;
3691 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
3693 di
= dictGetIterator(c
->db
->dict
);
3695 decrRefCount(lenobj
);
3696 while((de
= dictNext(di
)) != NULL
) {
3697 robj
*keyobj
= dictGetEntryKey(de
);
3699 sds key
= keyobj
->ptr
;
3700 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
3701 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
3702 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
3704 addReply(c
,shared
.space
);
3707 keyslen
+= sdslen(key
);
3711 dictReleaseIterator(di
);
3712 lenobj
->ptr
= sdscatprintf(sdsempty(),"$%lu\r\n",keyslen
+(numkeys
? (numkeys
-1) : 0));
3713 addReply(c
,shared
.crlf
);
3716 static void dbsizeCommand(redisClient
*c
) {
3718 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
3721 static void lastsaveCommand(redisClient
*c
) {
3723 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
3726 static void typeCommand(redisClient
*c
) {
3730 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
3735 case REDIS_STRING
: type
= "+string"; break;
3736 case REDIS_LIST
: type
= "+list"; break;
3737 case REDIS_SET
: type
= "+set"; break;
3738 case REDIS_ZSET
: type
= "+zset"; break;
3739 default: type
= "unknown"; break;
3742 addReplySds(c
,sdsnew(type
));
3743 addReply(c
,shared
.crlf
);
3746 static void saveCommand(redisClient
*c
) {
3747 if (server
.bgsavechildpid
!= -1) {
3748 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
3751 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
3752 addReply(c
,shared
.ok
);
3754 addReply(c
,shared
.err
);
3758 static void bgsaveCommand(redisClient
*c
) {
3759 if (server
.bgsavechildpid
!= -1) {
3760 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
3763 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
3764 char *status
= "+Background saving started\r\n";
3765 addReplySds(c
,sdsnew(status
));
3767 addReply(c
,shared
.err
);
3771 static void shutdownCommand(redisClient
*c
) {
3772 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
3773 /* Kill the saving child if there is a background saving in progress.
3774 We want to avoid race conditions, for instance our saving child may
3775 overwrite the synchronous saving did by SHUTDOWN. */
3776 if (server
.bgsavechildpid
!= -1) {
3777 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
3778 kill(server
.bgsavechildpid
,SIGKILL
);
3779 rdbRemoveTempFile(server
.bgsavechildpid
);
3781 if (server
.appendonly
) {
3782 /* Append only file: fsync() the AOF and exit */
3783 fsync(server
.appendfd
);
3784 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
3787 /* Snapshotting. Perform a SYNC SAVE and exit */
3788 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
3789 if (server
.daemonize
)
3790 unlink(server
.pidfile
);
3791 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
3792 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
3793 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
3796 /* Ooops.. error saving! The best we can do is to continue operating.
3797 * Note that if there was a background saving process, in the next
3798 * cron() Redis will be notified that the background saving aborted,
3799 * handling special stuff like slaves pending for synchronization... */
3800 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
3801 addReplySds(c
,sdsnew("-ERR can't quit, problems saving the DB\r\n"));
3806 static void renameGenericCommand(redisClient
*c
, int nx
) {
3809 /* To use the same key as src and dst is probably an error */
3810 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
3811 addReply(c
,shared
.sameobjecterr
);
3815 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3817 addReply(c
,shared
.nokeyerr
);
3821 deleteIfVolatile(c
->db
,c
->argv
[2]);
3822 if (dictAdd(c
->db
->dict
,c
->argv
[2],o
) == DICT_ERR
) {
3825 addReply(c
,shared
.czero
);
3828 dictReplace(c
->db
->dict
,c
->argv
[2],o
);
3830 incrRefCount(c
->argv
[2]);
3832 deleteKey(c
->db
,c
->argv
[1]);
3834 addReply(c
,nx
? shared
.cone
: shared
.ok
);
3837 static void renameCommand(redisClient
*c
) {
3838 renameGenericCommand(c
,0);
3841 static void renamenxCommand(redisClient
*c
) {
3842 renameGenericCommand(c
,1);
3845 static void moveCommand(redisClient
*c
) {
3850 /* Obtain source and target DB pointers */
3853 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
3854 addReply(c
,shared
.outofrangeerr
);
3858 selectDb(c
,srcid
); /* Back to the source DB */
3860 /* If the user is moving using as target the same
3861 * DB as the source DB it is probably an error. */
3863 addReply(c
,shared
.sameobjecterr
);
3867 /* Check if the element exists and get a reference */
3868 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3870 addReply(c
,shared
.czero
);
3874 /* Try to add the element to the target DB */
3875 deleteIfVolatile(dst
,c
->argv
[1]);
3876 if (dictAdd(dst
->dict
,c
->argv
[1],o
) == DICT_ERR
) {
3877 addReply(c
,shared
.czero
);
3880 incrRefCount(c
->argv
[1]);
3883 /* OK! key moved, free the entry in the source DB */
3884 deleteKey(src
,c
->argv
[1]);
3886 addReply(c
,shared
.cone
);
3889 /* =================================== Lists ================================ */
3890 static void pushGenericCommand(redisClient
*c
, int where
) {
3894 lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3896 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
3897 addReply(c
,shared
.ok
);
3900 lobj
= createListObject();
3902 if (where
== REDIS_HEAD
) {
3903 listAddNodeHead(list
,c
->argv
[2]);
3905 listAddNodeTail(list
,c
->argv
[2]);
3907 dictAdd(c
->db
->dict
,c
->argv
[1],lobj
);
3908 incrRefCount(c
->argv
[1]);
3909 incrRefCount(c
->argv
[2]);
3911 if (lobj
->type
!= REDIS_LIST
) {
3912 addReply(c
,shared
.wrongtypeerr
);
3915 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
3916 addReply(c
,shared
.ok
);
3920 if (where
== REDIS_HEAD
) {
3921 listAddNodeHead(list
,c
->argv
[2]);
3923 listAddNodeTail(list
,c
->argv
[2]);
3925 incrRefCount(c
->argv
[2]);
3928 addReply(c
,shared
.ok
);
3931 static void lpushCommand(redisClient
*c
) {
3932 pushGenericCommand(c
,REDIS_HEAD
);
3935 static void rpushCommand(redisClient
*c
) {
3936 pushGenericCommand(c
,REDIS_TAIL
);
3939 static void llenCommand(redisClient
*c
) {
3943 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
3945 addReply(c
,shared
.czero
);
3948 if (o
->type
!= REDIS_LIST
) {
3949 addReply(c
,shared
.wrongtypeerr
);
3952 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",listLength(l
)));
3957 static void lindexCommand(redisClient
*c
) {
3959 int index
= atoi(c
->argv
[2]->ptr
);
3961 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
3963 addReply(c
,shared
.nullbulk
);
3965 if (o
->type
!= REDIS_LIST
) {
3966 addReply(c
,shared
.wrongtypeerr
);
3968 list
*list
= o
->ptr
;
3971 ln
= listIndex(list
, index
);
3973 addReply(c
,shared
.nullbulk
);
3975 robj
*ele
= listNodeValue(ln
);
3976 addReplyBulkLen(c
,ele
);
3978 addReply(c
,shared
.crlf
);
3984 static void lsetCommand(redisClient
*c
) {
3986 int index
= atoi(c
->argv
[2]->ptr
);
3988 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3990 addReply(c
,shared
.nokeyerr
);
3992 if (o
->type
!= REDIS_LIST
) {
3993 addReply(c
,shared
.wrongtypeerr
);
3995 list
*list
= o
->ptr
;
3998 ln
= listIndex(list
, index
);
4000 addReply(c
,shared
.outofrangeerr
);
4002 robj
*ele
= listNodeValue(ln
);
4005 listNodeValue(ln
) = c
->argv
[3];
4006 incrRefCount(c
->argv
[3]);
4007 addReply(c
,shared
.ok
);
4014 static void popGenericCommand(redisClient
*c
, int where
) {
4017 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4019 addReply(c
,shared
.nullbulk
);
4021 if (o
->type
!= REDIS_LIST
) {
4022 addReply(c
,shared
.wrongtypeerr
);
4024 list
*list
= o
->ptr
;
4027 if (where
== REDIS_HEAD
)
4028 ln
= listFirst(list
);
4030 ln
= listLast(list
);
4033 addReply(c
,shared
.nullbulk
);
4035 robj
*ele
= listNodeValue(ln
);
4036 addReplyBulkLen(c
,ele
);
4038 addReply(c
,shared
.crlf
);
4039 listDelNode(list
,ln
);
4046 static void lpopCommand(redisClient
*c
) {
4047 popGenericCommand(c
,REDIS_HEAD
);
4050 static void rpopCommand(redisClient
*c
) {
4051 popGenericCommand(c
,REDIS_TAIL
);
4054 static void lrangeCommand(redisClient
*c
) {
4056 int start
= atoi(c
->argv
[2]->ptr
);
4057 int end
= atoi(c
->argv
[3]->ptr
);
4059 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4061 addReply(c
,shared
.nullmultibulk
);
4063 if (o
->type
!= REDIS_LIST
) {
4064 addReply(c
,shared
.wrongtypeerr
);
4066 list
*list
= o
->ptr
;
4068 int llen
= listLength(list
);
4072 /* convert negative indexes */
4073 if (start
< 0) start
= llen
+start
;
4074 if (end
< 0) end
= llen
+end
;
4075 if (start
< 0) start
= 0;
4076 if (end
< 0) end
= 0;
4078 /* indexes sanity checks */
4079 if (start
> end
|| start
>= llen
) {
4080 /* Out of range start or start > end result in empty list */
4081 addReply(c
,shared
.emptymultibulk
);
4084 if (end
>= llen
) end
= llen
-1;
4085 rangelen
= (end
-start
)+1;
4087 /* Return the result in form of a multi-bulk reply */
4088 ln
= listIndex(list
, start
);
4089 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
4090 for (j
= 0; j
< rangelen
; j
++) {
4091 ele
= listNodeValue(ln
);
4092 addReplyBulkLen(c
,ele
);
4094 addReply(c
,shared
.crlf
);
4101 static void ltrimCommand(redisClient
*c
) {
4103 int start
= atoi(c
->argv
[2]->ptr
);
4104 int end
= atoi(c
->argv
[3]->ptr
);
4106 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4108 addReply(c
,shared
.ok
);
4110 if (o
->type
!= REDIS_LIST
) {
4111 addReply(c
,shared
.wrongtypeerr
);
4113 list
*list
= o
->ptr
;
4115 int llen
= listLength(list
);
4116 int j
, ltrim
, rtrim
;
4118 /* convert negative indexes */
4119 if (start
< 0) start
= llen
+start
;
4120 if (end
< 0) end
= llen
+end
;
4121 if (start
< 0) start
= 0;
4122 if (end
< 0) end
= 0;
4124 /* indexes sanity checks */
4125 if (start
> end
|| start
>= llen
) {
4126 /* Out of range start or start > end result in empty list */
4130 if (end
>= llen
) end
= llen
-1;
4135 /* Remove list elements to perform the trim */
4136 for (j
= 0; j
< ltrim
; j
++) {
4137 ln
= listFirst(list
);
4138 listDelNode(list
,ln
);
4140 for (j
= 0; j
< rtrim
; j
++) {
4141 ln
= listLast(list
);
4142 listDelNode(list
,ln
);
4145 addReply(c
,shared
.ok
);
4150 static void lremCommand(redisClient
*c
) {
4153 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4155 addReply(c
,shared
.czero
);
4157 if (o
->type
!= REDIS_LIST
) {
4158 addReply(c
,shared
.wrongtypeerr
);
4160 list
*list
= o
->ptr
;
4161 listNode
*ln
, *next
;
4162 int toremove
= atoi(c
->argv
[2]->ptr
);
4167 toremove
= -toremove
;
4170 ln
= fromtail
? list
->tail
: list
->head
;
4172 robj
*ele
= listNodeValue(ln
);
4174 next
= fromtail
? ln
->prev
: ln
->next
;
4175 if (compareStringObjects(ele
,c
->argv
[3]) == 0) {
4176 listDelNode(list
,ln
);
4179 if (toremove
&& removed
== toremove
) break;
4183 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
4188 /* This is the semantic of this command:
4189 * RPOPLPUSH srclist dstlist:
4190 * IF LLEN(srclist) > 0
4191 * element = RPOP srclist
4192 * LPUSH dstlist element
4199 * The idea is to be able to get an element from a list in a reliable way
4200 * since the element is not just returned but pushed against another list
4201 * as well. This command was originally proposed by Ezra Zygmuntowicz.
4203 static void rpoplpushcommand(redisClient
*c
) {
4206 sobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4208 addReply(c
,shared
.nullbulk
);
4210 if (sobj
->type
!= REDIS_LIST
) {
4211 addReply(c
,shared
.wrongtypeerr
);
4213 list
*srclist
= sobj
->ptr
;
4214 listNode
*ln
= listLast(srclist
);
4217 addReply(c
,shared
.nullbulk
);
4219 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4220 robj
*ele
= listNodeValue(ln
);
4223 if (dobj
&& dobj
->type
!= REDIS_LIST
) {
4224 addReply(c
,shared
.wrongtypeerr
);
4228 /* Add the element to the target list (unless it's directly
4229 * passed to some BLPOP-ing client */
4230 if (!handleClientsWaitingListPush(c
,c
->argv
[2],ele
)) {
4232 /* Create the list if the key does not exist */
4233 dobj
= createListObject();
4234 dictAdd(c
->db
->dict
,c
->argv
[2],dobj
);
4235 incrRefCount(c
->argv
[2]);
4237 dstlist
= dobj
->ptr
;
4238 listAddNodeHead(dstlist
,ele
);
4242 /* Send the element to the client as reply as well */
4243 addReplyBulkLen(c
,ele
);
4245 addReply(c
,shared
.crlf
);
4247 /* Finally remove the element from the source list */
4248 listDelNode(srclist
,ln
);
4256 /* ==================================== Sets ================================ */
4258 static void saddCommand(redisClient
*c
) {
4261 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4263 set
= createSetObject();
4264 dictAdd(c
->db
->dict
,c
->argv
[1],set
);
4265 incrRefCount(c
->argv
[1]);
4267 if (set
->type
!= REDIS_SET
) {
4268 addReply(c
,shared
.wrongtypeerr
);
4272 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
4273 incrRefCount(c
->argv
[2]);
4275 addReply(c
,shared
.cone
);
4277 addReply(c
,shared
.czero
);
4281 static void sremCommand(redisClient
*c
) {
4284 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4286 addReply(c
,shared
.czero
);
4288 if (set
->type
!= REDIS_SET
) {
4289 addReply(c
,shared
.wrongtypeerr
);
4292 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
4294 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4295 addReply(c
,shared
.cone
);
4297 addReply(c
,shared
.czero
);
4302 static void smoveCommand(redisClient
*c
) {
4303 robj
*srcset
, *dstset
;
4305 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4306 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4308 /* If the source key does not exist return 0, if it's of the wrong type
4310 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
4311 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
4314 /* Error if the destination key is not a set as well */
4315 if (dstset
&& dstset
->type
!= REDIS_SET
) {
4316 addReply(c
,shared
.wrongtypeerr
);
4319 /* Remove the element from the source set */
4320 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
4321 /* Key not found in the src set! return zero */
4322 addReply(c
,shared
.czero
);
4326 /* Add the element to the destination set */
4328 dstset
= createSetObject();
4329 dictAdd(c
->db
->dict
,c
->argv
[2],dstset
);
4330 incrRefCount(c
->argv
[2]);
4332 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
4333 incrRefCount(c
->argv
[3]);
4334 addReply(c
,shared
.cone
);
4337 static void sismemberCommand(redisClient
*c
) {
4340 set
= lookupKeyRead(c
->db
,c
->argv
[1]);
4342 addReply(c
,shared
.czero
);
4344 if (set
->type
!= REDIS_SET
) {
4345 addReply(c
,shared
.wrongtypeerr
);
4348 if (dictFind(set
->ptr
,c
->argv
[2]))
4349 addReply(c
,shared
.cone
);
4351 addReply(c
,shared
.czero
);
4355 static void scardCommand(redisClient
*c
) {
4359 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4361 addReply(c
,shared
.czero
);
4364 if (o
->type
!= REDIS_SET
) {
4365 addReply(c
,shared
.wrongtypeerr
);
4368 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4374 static void spopCommand(redisClient
*c
) {
4378 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4380 addReply(c
,shared
.nullbulk
);
4382 if (set
->type
!= REDIS_SET
) {
4383 addReply(c
,shared
.wrongtypeerr
);
4386 de
= dictGetRandomKey(set
->ptr
);
4388 addReply(c
,shared
.nullbulk
);
4390 robj
*ele
= dictGetEntryKey(de
);
4392 addReplyBulkLen(c
,ele
);
4394 addReply(c
,shared
.crlf
);
4395 dictDelete(set
->ptr
,ele
);
4396 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4402 static void srandmemberCommand(redisClient
*c
) {
4406 set
= lookupKeyRead(c
->db
,c
->argv
[1]);
4408 addReply(c
,shared
.nullbulk
);
4410 if (set
->type
!= REDIS_SET
) {
4411 addReply(c
,shared
.wrongtypeerr
);
4414 de
= dictGetRandomKey(set
->ptr
);
4416 addReply(c
,shared
.nullbulk
);
4418 robj
*ele
= dictGetEntryKey(de
);
4420 addReplyBulkLen(c
,ele
);
4422 addReply(c
,shared
.crlf
);
4427 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
4428 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
4430 return dictSize(*d1
)-dictSize(*d2
);
4433 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
4434 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4437 robj
*lenobj
= NULL
, *dstset
= NULL
;
4438 unsigned long j
, cardinality
= 0;
4440 for (j
= 0; j
< setsnum
; j
++) {
4444 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4445 lookupKeyRead(c
->db
,setskeys
[j
]);
4449 if (deleteKey(c
->db
,dstkey
))
4451 addReply(c
,shared
.czero
);
4453 addReply(c
,shared
.nullmultibulk
);
4457 if (setobj
->type
!= REDIS_SET
) {
4459 addReply(c
,shared
.wrongtypeerr
);
4462 dv
[j
] = setobj
->ptr
;
4464 /* Sort sets from the smallest to largest, this will improve our
4465 * algorithm's performace */
4466 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
4468 /* The first thing we should output is the total number of elements...
4469 * since this is a multi-bulk write, but at this stage we don't know
4470 * the intersection set size, so we use a trick, append an empty object
4471 * to the output list and save the pointer to later modify it with the
4474 lenobj
= createObject(REDIS_STRING
,NULL
);
4476 decrRefCount(lenobj
);
4478 /* If we have a target key where to store the resulting set
4479 * create this key with an empty set inside */
4480 dstset
= createSetObject();
4483 /* Iterate all the elements of the first (smallest) set, and test
4484 * the element against all the other sets, if at least one set does
4485 * not include the element it is discarded */
4486 di
= dictGetIterator(dv
[0]);
4488 while((de
= dictNext(di
)) != NULL
) {
4491 for (j
= 1; j
< setsnum
; j
++)
4492 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
4494 continue; /* at least one set does not contain the member */
4495 ele
= dictGetEntryKey(de
);
4497 addReplyBulkLen(c
,ele
);
4499 addReply(c
,shared
.crlf
);
4502 dictAdd(dstset
->ptr
,ele
,NULL
);
4506 dictReleaseIterator(di
);
4509 /* Store the resulting set into the target */
4510 deleteKey(c
->db
,dstkey
);
4511 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4512 incrRefCount(dstkey
);
4516 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
4518 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4519 dictSize((dict
*)dstset
->ptr
)));
4525 static void sinterCommand(redisClient
*c
) {
4526 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
4529 static void sinterstoreCommand(redisClient
*c
) {
4530 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
4533 #define REDIS_OP_UNION 0
4534 #define REDIS_OP_DIFF 1
4536 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
4537 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4540 robj
*dstset
= NULL
;
4541 int j
, cardinality
= 0;
4543 for (j
= 0; j
< setsnum
; j
++) {
4547 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4548 lookupKeyRead(c
->db
,setskeys
[j
]);
4553 if (setobj
->type
!= REDIS_SET
) {
4555 addReply(c
,shared
.wrongtypeerr
);
4558 dv
[j
] = setobj
->ptr
;
4561 /* We need a temp set object to store our union. If the dstkey
4562 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
4563 * this set object will be the resulting object to set into the target key*/
4564 dstset
= createSetObject();
4566 /* Iterate all the elements of all the sets, add every element a single
4567 * time to the result set */
4568 for (j
= 0; j
< setsnum
; j
++) {
4569 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
4570 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
4572 di
= dictGetIterator(dv
[j
]);
4574 while((de
= dictNext(di
)) != NULL
) {
4577 /* dictAdd will not add the same element multiple times */
4578 ele
= dictGetEntryKey(de
);
4579 if (op
== REDIS_OP_UNION
|| j
== 0) {
4580 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
4584 } else if (op
== REDIS_OP_DIFF
) {
4585 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
4590 dictReleaseIterator(di
);
4592 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break; /* result set is empty */
4595 /* Output the content of the resulting set, if not in STORE mode */
4597 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
4598 di
= dictGetIterator(dstset
->ptr
);
4599 while((de
= dictNext(di
)) != NULL
) {
4602 ele
= dictGetEntryKey(de
);
4603 addReplyBulkLen(c
,ele
);
4605 addReply(c
,shared
.crlf
);
4607 dictReleaseIterator(di
);
4609 /* If we have a target key where to store the resulting set
4610 * create this key with the result set inside */
4611 deleteKey(c
->db
,dstkey
);
4612 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4613 incrRefCount(dstkey
);
4618 decrRefCount(dstset
);
4620 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4621 dictSize((dict
*)dstset
->ptr
)));
4627 static void sunionCommand(redisClient
*c
) {
4628 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
4631 static void sunionstoreCommand(redisClient
*c
) {
4632 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
4635 static void sdiffCommand(redisClient
*c
) {
4636 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
4639 static void sdiffstoreCommand(redisClient
*c
) {
4640 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
4643 /* ==================================== ZSets =============================== */
4645 /* ZSETs are ordered sets using two data structures to hold the same elements
4646 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
4649 * The elements are added to an hash table mapping Redis objects to scores.
4650 * At the same time the elements are added to a skip list mapping scores
4651 * to Redis objects (so objects are sorted by scores in this "view"). */
4653 /* This skiplist implementation is almost a C translation of the original
4654 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
4655 * Alternative to Balanced Trees", modified in three ways:
4656 * a) this implementation allows for repeated values.
4657 * b) the comparison is not just by key (our 'score') but by satellite data.
4658 * c) there is a back pointer, so it's a doubly linked list with the back
4659 * pointers being only at "level 1". This allows to traverse the list
4660 * from tail to head, useful for ZREVRANGE. */
4662 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
4663 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
4665 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
4671 static zskiplist
*zslCreate(void) {
4675 zsl
= zmalloc(sizeof(*zsl
));
4678 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
4679 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++)
4680 zsl
->header
->forward
[j
] = NULL
;
4681 zsl
->header
->backward
= NULL
;
4686 static void zslFreeNode(zskiplistNode
*node
) {
4687 decrRefCount(node
->obj
);
4688 zfree(node
->forward
);
4692 static void zslFree(zskiplist
*zsl
) {
4693 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
4695 zfree(zsl
->header
->forward
);
4698 next
= node
->forward
[0];
4705 static int zslRandomLevel(void) {
4707 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
4712 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
4713 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
4717 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4718 while (x
->forward
[i
] &&
4719 (x
->forward
[i
]->score
< score
||
4720 (x
->forward
[i
]->score
== score
&&
4721 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
4725 /* we assume the key is not already inside, since we allow duplicated
4726 * scores, and the re-insertion of score and redis object should never
4727 * happpen since the caller of zslInsert() should test in the hash table
4728 * if the element is already inside or not. */
4729 level
= zslRandomLevel();
4730 if (level
> zsl
->level
) {
4731 for (i
= zsl
->level
; i
< level
; i
++)
4732 update
[i
] = zsl
->header
;
4735 x
= zslCreateNode(level
,score
,obj
);
4736 for (i
= 0; i
< level
; i
++) {
4737 x
->forward
[i
] = update
[i
]->forward
[i
];
4738 update
[i
]->forward
[i
] = x
;
4740 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
4742 x
->forward
[0]->backward
= x
;
4748 /* Delete an element with matching score/object from the skiplist. */
4749 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
4750 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
4754 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4755 while (x
->forward
[i
] &&
4756 (x
->forward
[i
]->score
< score
||
4757 (x
->forward
[i
]->score
== score
&&
4758 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
4762 /* We may have multiple elements with the same score, what we need
4763 * is to find the element with both the right score and object. */
4765 if (x
&& score
== x
->score
&& compareStringObjects(x
->obj
,obj
) == 0) {
4766 for (i
= 0; i
< zsl
->level
; i
++) {
4767 if (update
[i
]->forward
[i
] != x
) break;
4768 update
[i
]->forward
[i
] = x
->forward
[i
];
4770 if (x
->forward
[0]) {
4771 x
->forward
[0]->backward
= (x
->backward
== zsl
->header
) ?
4774 zsl
->tail
= x
->backward
;
4777 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
4782 return 0; /* not found */
4784 return 0; /* not found */
4787 /* Delete all the elements with score between min and max from the skiplist.
4788 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
4789 * Note that this function takes the reference to the hash table view of the
4790 * sorted set, in order to remove the elements from the hash table too. */
4791 static unsigned long zslDeleteRange(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
4792 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
4793 unsigned long removed
= 0;
4797 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4798 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
4802 /* We may have multiple elements with the same score, what we need
4803 * is to find the element with both the right score and object. */
4805 while (x
&& x
->score
<= max
) {
4806 zskiplistNode
*next
;
4808 for (i
= 0; i
< zsl
->level
; i
++) {
4809 if (update
[i
]->forward
[i
] != x
) break;
4810 update
[i
]->forward
[i
] = x
->forward
[i
];
4812 if (x
->forward
[0]) {
4813 x
->forward
[0]->backward
= (x
->backward
== zsl
->header
) ?
4816 zsl
->tail
= x
->backward
;
4818 next
= x
->forward
[0];
4819 dictDelete(dict
,x
->obj
);
4821 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
4827 return removed
; /* not found */
4830 /* Find the first node having a score equal or greater than the specified one.
4831 * Returns NULL if there is no match. */
4832 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
4837 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4838 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
4841 /* We may have multiple elements with the same score, what we need
4842 * is to find the element with both the right score and object. */
4843 return x
->forward
[0];
4846 /* The actual Z-commands implementations */
4848 /* This generic command implements both ZADD and ZINCRBY.
4849 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
4850 * the increment if the operation is a ZINCRBY (doincrement == 1). */
4851 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
4856 zsetobj
= lookupKeyWrite(c
->db
,key
);
4857 if (zsetobj
== NULL
) {
4858 zsetobj
= createZsetObject();
4859 dictAdd(c
->db
->dict
,key
,zsetobj
);
4862 if (zsetobj
->type
!= REDIS_ZSET
) {
4863 addReply(c
,shared
.wrongtypeerr
);
4869 /* Ok now since we implement both ZADD and ZINCRBY here the code
4870 * needs to handle the two different conditions. It's all about setting
4871 * '*score', that is, the new score to set, to the right value. */
4872 score
= zmalloc(sizeof(double));
4876 /* Read the old score. If the element was not present starts from 0 */
4877 de
= dictFind(zs
->dict
,ele
);
4879 double *oldscore
= dictGetEntryVal(de
);
4880 *score
= *oldscore
+ scoreval
;
4888 /* What follows is a simple remove and re-insert operation that is common
4889 * to both ZADD and ZINCRBY... */
4890 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
4891 /* case 1: New element */
4892 incrRefCount(ele
); /* added to hash */
4893 zslInsert(zs
->zsl
,*score
,ele
);
4894 incrRefCount(ele
); /* added to skiplist */
4897 addReplyDouble(c
,*score
);
4899 addReply(c
,shared
.cone
);
4904 /* case 2: Score update operation */
4905 de
= dictFind(zs
->dict
,ele
);
4906 redisAssert(de
!= NULL
);
4907 oldscore
= dictGetEntryVal(de
);
4908 if (*score
!= *oldscore
) {
4911 /* Remove and insert the element in the skip list with new score */
4912 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
4913 redisAssert(deleted
!= 0);
4914 zslInsert(zs
->zsl
,*score
,ele
);
4916 /* Update the score in the hash table */
4917 dictReplace(zs
->dict
,ele
,score
);
4923 addReplyDouble(c
,*score
);
4925 addReply(c
,shared
.czero
);
4929 static void zaddCommand(redisClient
*c
) {
4932 scoreval
= strtod(c
->argv
[2]->ptr
,NULL
);
4933 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
4936 static void zincrbyCommand(redisClient
*c
) {
4939 scoreval
= strtod(c
->argv
[2]->ptr
,NULL
);
4940 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
4943 static void zremCommand(redisClient
*c
) {
4947 zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4948 if (zsetobj
== NULL
) {
4949 addReply(c
,shared
.czero
);
4955 if (zsetobj
->type
!= REDIS_ZSET
) {
4956 addReply(c
,shared
.wrongtypeerr
);
4960 de
= dictFind(zs
->dict
,c
->argv
[2]);
4962 addReply(c
,shared
.czero
);
4965 /* Delete from the skiplist */
4966 oldscore
= dictGetEntryVal(de
);
4967 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
4968 redisAssert(deleted
!= 0);
4970 /* Delete from the hash table */
4971 dictDelete(zs
->dict
,c
->argv
[2]);
4972 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
4974 addReply(c
,shared
.cone
);
4978 static void zremrangebyscoreCommand(redisClient
*c
) {
4979 double min
= strtod(c
->argv
[2]->ptr
,NULL
);
4980 double max
= strtod(c
->argv
[3]->ptr
,NULL
);
4984 zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4985 if (zsetobj
== NULL
) {
4986 addReply(c
,shared
.czero
);
4990 if (zsetobj
->type
!= REDIS_ZSET
) {
4991 addReply(c
,shared
.wrongtypeerr
);
4995 deleted
= zslDeleteRange(zs
->zsl
,min
,max
,zs
->dict
);
4996 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
4997 server
.dirty
+= deleted
;
4998 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",deleted
));
5002 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
5004 int start
= atoi(c
->argv
[2]->ptr
);
5005 int end
= atoi(c
->argv
[3]->ptr
);
5008 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
5010 } else if (c
->argc
>= 5) {
5011 addReply(c
,shared
.syntaxerr
);
5015 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5017 addReply(c
,shared
.nullmultibulk
);
5019 if (o
->type
!= REDIS_ZSET
) {
5020 addReply(c
,shared
.wrongtypeerr
);
5022 zset
*zsetobj
= o
->ptr
;
5023 zskiplist
*zsl
= zsetobj
->zsl
;
5026 int llen
= zsl
->length
;
5030 /* convert negative indexes */
5031 if (start
< 0) start
= llen
+start
;
5032 if (end
< 0) end
= llen
+end
;
5033 if (start
< 0) start
= 0;
5034 if (end
< 0) end
= 0;
5036 /* indexes sanity checks */
5037 if (start
> end
|| start
>= llen
) {
5038 /* Out of range start or start > end result in empty list */
5039 addReply(c
,shared
.emptymultibulk
);
5042 if (end
>= llen
) end
= llen
-1;
5043 rangelen
= (end
-start
)+1;
5045 /* Return the result in form of a multi-bulk reply */
5051 ln
= zsl
->header
->forward
[0];
5053 ln
= ln
->forward
[0];
5056 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
5057 withscores
? (rangelen
*2) : rangelen
));
5058 for (j
= 0; j
< rangelen
; j
++) {
5060 addReplyBulkLen(c
,ele
);
5062 addReply(c
,shared
.crlf
);
5064 addReplyDouble(c
,ln
->score
);
5065 ln
= reverse
? ln
->backward
: ln
->forward
[0];
5071 static void zrangeCommand(redisClient
*c
) {
5072 zrangeGenericCommand(c
,0);
5075 static void zrevrangeCommand(redisClient
*c
) {
5076 zrangeGenericCommand(c
,1);
5079 static void zrangebyscoreCommand(redisClient
*c
) {
5081 double min
= strtod(c
->argv
[2]->ptr
,NULL
);
5082 double max
= strtod(c
->argv
[3]->ptr
,NULL
);
5083 int offset
= 0, limit
= -1;
5085 if (c
->argc
!= 4 && c
->argc
!= 7) {
5087 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
5089 } else if (c
->argc
== 7 && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
5090 addReply(c
,shared
.syntaxerr
);
5092 } else if (c
->argc
== 7) {
5093 offset
= atoi(c
->argv
[5]->ptr
);
5094 limit
= atoi(c
->argv
[6]->ptr
);
5095 if (offset
< 0) offset
= 0;
5098 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5100 addReply(c
,shared
.nullmultibulk
);
5102 if (o
->type
!= REDIS_ZSET
) {
5103 addReply(c
,shared
.wrongtypeerr
);
5105 zset
*zsetobj
= o
->ptr
;
5106 zskiplist
*zsl
= zsetobj
->zsl
;
5109 unsigned int rangelen
= 0;
5111 /* Get the first node with the score >= min */
5112 ln
= zslFirstWithScore(zsl
,min
);
5114 /* No element matching the speciifed interval */
5115 addReply(c
,shared
.emptymultibulk
);
5119 /* We don't know in advance how many matching elements there
5120 * are in the list, so we push this object that will represent
5121 * the multi-bulk length in the output buffer, and will "fix"
5123 lenobj
= createObject(REDIS_STRING
,NULL
);
5125 decrRefCount(lenobj
);
5127 while(ln
&& ln
->score
<= max
) {
5130 ln
= ln
->forward
[0];
5133 if (limit
== 0) break;
5135 addReplyBulkLen(c
,ele
);
5137 addReply(c
,shared
.crlf
);
5138 ln
= ln
->forward
[0];
5140 if (limit
> 0) limit
--;
5142 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%d\r\n",rangelen
);
5147 static void zcardCommand(redisClient
*c
) {
5151 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5153 addReply(c
,shared
.czero
);
5156 if (o
->type
!= REDIS_ZSET
) {
5157 addReply(c
,shared
.wrongtypeerr
);
5160 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",zs
->zsl
->length
));
5165 static void zscoreCommand(redisClient
*c
) {
5169 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5171 addReply(c
,shared
.nullbulk
);
5174 if (o
->type
!= REDIS_ZSET
) {
5175 addReply(c
,shared
.wrongtypeerr
);
5180 de
= dictFind(zs
->dict
,c
->argv
[2]);
5182 addReply(c
,shared
.nullbulk
);
5184 double *score
= dictGetEntryVal(de
);
5186 addReplyDouble(c
,*score
);
5192 /* ========================= Non type-specific commands ==================== */
5194 static void flushdbCommand(redisClient
*c
) {
5195 server
.dirty
+= dictSize(c
->db
->dict
);
5196 dictEmpty(c
->db
->dict
);
5197 dictEmpty(c
->db
->expires
);
5198 addReply(c
,shared
.ok
);
5201 static void flushallCommand(redisClient
*c
) {
5202 server
.dirty
+= emptyDb();
5203 addReply(c
,shared
.ok
);
5204 rdbSave(server
.dbfilename
);
5208 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
5209 redisSortOperation
*so
= zmalloc(sizeof(*so
));
5211 so
->pattern
= pattern
;
5215 /* Return the value associated to the key with a name obtained
5216 * substituting the first occurence of '*' in 'pattern' with 'subst' */
5217 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
5221 int prefixlen
, sublen
, postfixlen
;
5222 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
5226 char buf
[REDIS_SORTKEY_MAX
+1];
5229 /* If the pattern is "#" return the substitution object itself in order
5230 * to implement the "SORT ... GET #" feature. */
5231 spat
= pattern
->ptr
;
5232 if (spat
[0] == '#' && spat
[1] == '\0') {
5236 /* The substitution object may be specially encoded. If so we create
5237 * a decoded object on the fly. Otherwise getDecodedObject will just
5238 * increment the ref count, that we'll decrement later. */
5239 subst
= getDecodedObject(subst
);
5242 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
5243 p
= strchr(spat
,'*');
5245 decrRefCount(subst
);
5250 sublen
= sdslen(ssub
);
5251 postfixlen
= sdslen(spat
)-(prefixlen
+1);
5252 memcpy(keyname
.buf
,spat
,prefixlen
);
5253 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
5254 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
5255 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
5256 keyname
.len
= prefixlen
+sublen
+postfixlen
;
5258 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2))
5259 decrRefCount(subst
);
5261 /* printf("lookup '%s' => %p\n", keyname.buf,de); */
5262 return lookupKeyRead(db
,&keyobj
);
5265 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
5266 * the additional parameter is not standard but a BSD-specific we have to
5267 * pass sorting parameters via the global 'server' structure */
5268 static int sortCompare(const void *s1
, const void *s2
) {
5269 const redisSortObject
*so1
= s1
, *so2
= s2
;
5272 if (!server
.sort_alpha
) {
5273 /* Numeric sorting. Here it's trivial as we precomputed scores */
5274 if (so1
->u
.score
> so2
->u
.score
) {
5276 } else if (so1
->u
.score
< so2
->u
.score
) {
5282 /* Alphanumeric sorting */
5283 if (server
.sort_bypattern
) {
5284 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
5285 /* At least one compare object is NULL */
5286 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
5288 else if (so1
->u
.cmpobj
== NULL
)
5293 /* We have both the objects, use strcoll */
5294 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
5297 /* Compare elements directly */
5300 dec1
= getDecodedObject(so1
->obj
);
5301 dec2
= getDecodedObject(so2
->obj
);
5302 cmp
= strcoll(dec1
->ptr
,dec2
->ptr
);
5307 return server
.sort_desc
? -cmp
: cmp
;
5310 /* The SORT command is the most complex command in Redis. Warning: this code
5311 * is optimized for speed and a bit less for readability */
5312 static void sortCommand(redisClient
*c
) {
5315 int desc
= 0, alpha
= 0;
5316 int limit_start
= 0, limit_count
= -1, start
, end
;
5317 int j
, dontsort
= 0, vectorlen
;
5318 int getop
= 0; /* GET operation counter */
5319 robj
*sortval
, *sortby
= NULL
, *storekey
= NULL
;
5320 redisSortObject
*vector
; /* Resulting vector to sort */
5322 /* Lookup the key to sort. It must be of the right types */
5323 sortval
= lookupKeyRead(c
->db
,c
->argv
[1]);
5324 if (sortval
== NULL
) {
5325 addReply(c
,shared
.nullmultibulk
);
5328 if (sortval
->type
!= REDIS_SET
&& sortval
->type
!= REDIS_LIST
&&
5329 sortval
->type
!= REDIS_ZSET
)
5331 addReply(c
,shared
.wrongtypeerr
);
5335 /* Create a list of operations to perform for every sorted element.
5336 * Operations can be GET/DEL/INCR/DECR */
5337 operations
= listCreate();
5338 listSetFreeMethod(operations
,zfree
);
5341 /* Now we need to protect sortval incrementing its count, in the future
5342 * SORT may have options able to overwrite/delete keys during the sorting
5343 * and the sorted key itself may get destroied */
5344 incrRefCount(sortval
);
5346 /* The SORT command has an SQL-alike syntax, parse it */
5347 while(j
< c
->argc
) {
5348 int leftargs
= c
->argc
-j
-1;
5349 if (!strcasecmp(c
->argv
[j
]->ptr
,"asc")) {
5351 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"desc")) {
5353 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"alpha")) {
5355 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"limit") && leftargs
>= 2) {
5356 limit_start
= atoi(c
->argv
[j
+1]->ptr
);
5357 limit_count
= atoi(c
->argv
[j
+2]->ptr
);
5359 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"store") && leftargs
>= 1) {
5360 storekey
= c
->argv
[j
+1];
5362 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"by") && leftargs
>= 1) {
5363 sortby
= c
->argv
[j
+1];
5364 /* If the BY pattern does not contain '*', i.e. it is constant,
5365 * we don't need to sort nor to lookup the weight keys. */
5366 if (strchr(c
->argv
[j
+1]->ptr
,'*') == NULL
) dontsort
= 1;
5368 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"get") && leftargs
>= 1) {
5369 listAddNodeTail(operations
,createSortOperation(
5370 REDIS_SORT_GET
,c
->argv
[j
+1]));
5374 decrRefCount(sortval
);
5375 listRelease(operations
);
5376 addReply(c
,shared
.syntaxerr
);
5382 /* Load the sorting vector with all the objects to sort */
5383 switch(sortval
->type
) {
5384 case REDIS_LIST
: vectorlen
= listLength((list
*)sortval
->ptr
); break;
5385 case REDIS_SET
: vectorlen
= dictSize((dict
*)sortval
->ptr
); break;
5386 case REDIS_ZSET
: vectorlen
= dictSize(((zset
*)sortval
->ptr
)->dict
); break;
5387 default: vectorlen
= 0; redisAssert(0); /* Avoid GCC warning */
5389 vector
= zmalloc(sizeof(redisSortObject
)*vectorlen
);
5392 if (sortval
->type
== REDIS_LIST
) {
5393 list
*list
= sortval
->ptr
;
5397 listRewind(list
,&li
);
5398 while((ln
= listNext(&li
))) {
5399 robj
*ele
= ln
->value
;
5400 vector
[j
].obj
= ele
;
5401 vector
[j
].u
.score
= 0;
5402 vector
[j
].u
.cmpobj
= NULL
;
5410 if (sortval
->type
== REDIS_SET
) {
5413 zset
*zs
= sortval
->ptr
;
5417 di
= dictGetIterator(set
);
5418 while((setele
= dictNext(di
)) != NULL
) {
5419 vector
[j
].obj
= dictGetEntryKey(setele
);
5420 vector
[j
].u
.score
= 0;
5421 vector
[j
].u
.cmpobj
= NULL
;
5424 dictReleaseIterator(di
);
5426 redisAssert(j
== vectorlen
);
5428 /* Now it's time to load the right scores in the sorting vector */
5429 if (dontsort
== 0) {
5430 for (j
= 0; j
< vectorlen
; j
++) {
5434 byval
= lookupKeyByPattern(c
->db
,sortby
,vector
[j
].obj
);
5435 if (!byval
|| byval
->type
!= REDIS_STRING
) continue;
5437 vector
[j
].u
.cmpobj
= getDecodedObject(byval
);
5439 if (byval
->encoding
== REDIS_ENCODING_RAW
) {
5440 vector
[j
].u
.score
= strtod(byval
->ptr
,NULL
);
5442 /* Don't need to decode the object if it's
5443 * integer-encoded (the only encoding supported) so
5444 * far. We can just cast it */
5445 if (byval
->encoding
== REDIS_ENCODING_INT
) {
5446 vector
[j
].u
.score
= (long)byval
->ptr
;
5448 redisAssert(1 != 1);
5453 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_RAW
)
5454 vector
[j
].u
.score
= strtod(vector
[j
].obj
->ptr
,NULL
);
5456 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_INT
)
5457 vector
[j
].u
.score
= (long) vector
[j
].obj
->ptr
;
5459 redisAssert(1 != 1);
5466 /* We are ready to sort the vector... perform a bit of sanity check
5467 * on the LIMIT option too. We'll use a partial version of quicksort. */
5468 start
= (limit_start
< 0) ? 0 : limit_start
;
5469 end
= (limit_count
< 0) ? vectorlen
-1 : start
+limit_count
-1;
5470 if (start
>= vectorlen
) {
5471 start
= vectorlen
-1;
5474 if (end
>= vectorlen
) end
= vectorlen
-1;
5476 if (dontsort
== 0) {
5477 server
.sort_desc
= desc
;
5478 server
.sort_alpha
= alpha
;
5479 server
.sort_bypattern
= sortby
? 1 : 0;
5480 if (sortby
&& (start
!= 0 || end
!= vectorlen
-1))
5481 pqsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
, start
,end
);
5483 qsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
);
5486 /* Send command output to the output buffer, performing the specified
5487 * GET/DEL/INCR/DECR operations if any. */
5488 outputlen
= getop
? getop
*(end
-start
+1) : end
-start
+1;
5489 if (storekey
== NULL
) {
5490 /* STORE option not specified, sent the sorting result to client */
5491 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",outputlen
));
5492 for (j
= start
; j
<= end
; j
++) {
5497 addReplyBulkLen(c
,vector
[j
].obj
);
5498 addReply(c
,vector
[j
].obj
);
5499 addReply(c
,shared
.crlf
);
5501 listRewind(operations
,&li
);
5502 while((ln
= listNext(&li
))) {
5503 redisSortOperation
*sop
= ln
->value
;
5504 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
5507 if (sop
->type
== REDIS_SORT_GET
) {
5508 if (!val
|| val
->type
!= REDIS_STRING
) {
5509 addReply(c
,shared
.nullbulk
);
5511 addReplyBulkLen(c
,val
);
5513 addReply(c
,shared
.crlf
);
5516 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
5521 robj
*listObject
= createListObject();
5522 list
*listPtr
= (list
*) listObject
->ptr
;
5524 /* STORE option specified, set the sorting result as a List object */
5525 for (j
= start
; j
<= end
; j
++) {
5530 listAddNodeTail(listPtr
,vector
[j
].obj
);
5531 incrRefCount(vector
[j
].obj
);
5533 listRewind(operations
,&li
);
5534 while((ln
= listNext(&li
))) {
5535 redisSortOperation
*sop
= ln
->value
;
5536 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
5539 if (sop
->type
== REDIS_SORT_GET
) {
5540 if (!val
|| val
->type
!= REDIS_STRING
) {
5541 listAddNodeTail(listPtr
,createStringObject("",0));
5543 listAddNodeTail(listPtr
,val
);
5547 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
5551 if (dictReplace(c
->db
->dict
,storekey
,listObject
)) {
5552 incrRefCount(storekey
);
5554 /* Note: we add 1 because the DB is dirty anyway since even if the
5555 * SORT result is empty a new key is set and maybe the old content
5557 server
.dirty
+= 1+outputlen
;
5558 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",outputlen
));
5562 decrRefCount(sortval
);
5563 listRelease(operations
);
5564 for (j
= 0; j
< vectorlen
; j
++) {
5565 if (sortby
&& alpha
&& vector
[j
].u
.cmpobj
)
5566 decrRefCount(vector
[j
].u
.cmpobj
);
5571 /* Convert an amount of bytes into a human readable string in the form
5572 * of 100B, 2G, 100M, 4K, and so forth. */
5573 static void bytesToHuman(char *s
, unsigned long long n
) {
5578 sprintf(s
,"%lluB",n
);
5580 } else if (n
< (1024*1024)) {
5581 d
= (double)n
/(1024);
5582 sprintf(s
,"%.2fK",d
);
5583 } else if (n
< (1024LL*1024*1024)) {
5584 d
= (double)n
/(1024*1024);
5585 sprintf(s
,"%.2fM",d
);
5586 } else if (n
< (1024LL*1024*1024*1024)) {
5587 d
= (double)n
/(1024LL*1024*1024);
5588 sprintf(s
,"%.2fM",d
);
5592 /* Create the string returned by the INFO command. This is decoupled
5593 * by the INFO command itself as we need to report the same information
5594 * on memory corruption problems. */
5595 static sds
genRedisInfoString(void) {
5597 time_t uptime
= time(NULL
)-server
.stat_starttime
;
5601 bytesToHuman(hmem
,server
.usedmemory
);
5602 info
= sdscatprintf(sdsempty(),
5603 "redis_version:%s\r\n"
5605 "multiplexing_api:%s\r\n"
5606 "process_id:%ld\r\n"
5607 "uptime_in_seconds:%ld\r\n"
5608 "uptime_in_days:%ld\r\n"
5609 "connected_clients:%d\r\n"
5610 "connected_slaves:%d\r\n"
5611 "blocked_clients:%d\r\n"
5612 "used_memory:%zu\r\n"
5613 "used_memory_human:%s\r\n"
5614 "changes_since_last_save:%lld\r\n"
5615 "bgsave_in_progress:%d\r\n"
5616 "last_save_time:%ld\r\n"
5617 "bgrewriteaof_in_progress:%d\r\n"
5618 "total_connections_received:%lld\r\n"
5619 "total_commands_processed:%lld\r\n"
5623 (sizeof(long) == 8) ? "64" : "32",
5628 listLength(server
.clients
)-listLength(server
.slaves
),
5629 listLength(server
.slaves
),
5630 server
.blockedclients
,
5634 server
.bgsavechildpid
!= -1,
5636 server
.bgrewritechildpid
!= -1,
5637 server
.stat_numconnections
,
5638 server
.stat_numcommands
,
5639 server
.vm_enabled
!= 0,
5640 server
.masterhost
== NULL
? "master" : "slave"
5642 if (server
.masterhost
) {
5643 info
= sdscatprintf(info
,
5644 "master_host:%s\r\n"
5645 "master_port:%d\r\n"
5646 "master_link_status:%s\r\n"
5647 "master_last_io_seconds_ago:%d\r\n"
5650 (server
.replstate
== REDIS_REPL_CONNECTED
) ?
5652 server
.master
? ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1
5655 if (server
.vm_enabled
) {
5657 info
= sdscatprintf(info
,
5658 "vm_conf_max_memory:%llu\r\n"
5659 "vm_conf_page_size:%llu\r\n"
5660 "vm_conf_pages:%llu\r\n"
5661 "vm_stats_used_pages:%llu\r\n"
5662 "vm_stats_swapped_objects:%llu\r\n"
5663 "vm_stats_swappin_count:%llu\r\n"
5664 "vm_stats_swappout_count:%llu\r\n"
5665 "vm_stats_io_newjobs_len:%lu\r\n"
5666 "vm_stats_io_processing_len:%lu\r\n"
5667 "vm_stats_io_processed_len:%lu\r\n"
5668 "vm_stats_io_waiting_clients:%lu\r\n"
5669 "vm_stats_io_active_threads:%lu\r\n"
5670 ,(unsigned long long) server
.vm_max_memory
,
5671 (unsigned long long) server
.vm_page_size
,
5672 (unsigned long long) server
.vm_pages
,
5673 (unsigned long long) server
.vm_stats_used_pages
,
5674 (unsigned long long) server
.vm_stats_swapped_objects
,
5675 (unsigned long long) server
.vm_stats_swapins
,
5676 (unsigned long long) server
.vm_stats_swapouts
,
5677 (unsigned long) listLength(server
.io_newjobs
),
5678 (unsigned long) listLength(server
.io_processing
),
5679 (unsigned long) listLength(server
.io_processed
),
5680 (unsigned long) listLength(server
.io_clients
),
5681 (unsigned long) server
.io_active_threads
5685 for (j
= 0; j
< server
.dbnum
; j
++) {
5686 long long keys
, vkeys
;
5688 keys
= dictSize(server
.db
[j
].dict
);
5689 vkeys
= dictSize(server
.db
[j
].expires
);
5690 if (keys
|| vkeys
) {
5691 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
5698 static void infoCommand(redisClient
*c
) {
5699 sds info
= genRedisInfoString();
5700 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
5701 (unsigned long)sdslen(info
)));
5702 addReplySds(c
,info
);
5703 addReply(c
,shared
.crlf
);
5706 static void monitorCommand(redisClient
*c
) {
5707 /* ignore MONITOR if aleady slave or in monitor mode */
5708 if (c
->flags
& REDIS_SLAVE
) return;
5710 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
5712 listAddNodeTail(server
.monitors
,c
);
5713 addReply(c
,shared
.ok
);
5716 /* ================================= Expire ================================= */
5717 static int removeExpire(redisDb
*db
, robj
*key
) {
5718 if (dictDelete(db
->expires
,key
) == DICT_OK
) {
5725 static int setExpire(redisDb
*db
, robj
*key
, time_t when
) {
5726 if (dictAdd(db
->expires
,key
,(void*)when
) == DICT_ERR
) {
5734 /* Return the expire time of the specified key, or -1 if no expire
5735 * is associated with this key (i.e. the key is non volatile) */
5736 static time_t getExpire(redisDb
*db
, robj
*key
) {
5739 /* No expire? return ASAP */
5740 if (dictSize(db
->expires
) == 0 ||
5741 (de
= dictFind(db
->expires
,key
)) == NULL
) return -1;
5743 return (time_t) dictGetEntryVal(de
);
5746 static int expireIfNeeded(redisDb
*db
, robj
*key
) {
5750 /* No expire? return ASAP */
5751 if (dictSize(db
->expires
) == 0 ||
5752 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
5754 /* Lookup the expire */
5755 when
= (time_t) dictGetEntryVal(de
);
5756 if (time(NULL
) <= when
) return 0;
5758 /* Delete the key */
5759 dictDelete(db
->expires
,key
);
5760 return dictDelete(db
->dict
,key
) == DICT_OK
;
5763 static int deleteIfVolatile(redisDb
*db
, robj
*key
) {
5766 /* No expire? return ASAP */
5767 if (dictSize(db
->expires
) == 0 ||
5768 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
5770 /* Delete the key */
5772 dictDelete(db
->expires
,key
);
5773 return dictDelete(db
->dict
,key
) == DICT_OK
;
5776 static void expireGenericCommand(redisClient
*c
, robj
*key
, time_t seconds
) {
5779 de
= dictFind(c
->db
->dict
,key
);
5781 addReply(c
,shared
.czero
);
5785 if (deleteKey(c
->db
,key
)) server
.dirty
++;
5786 addReply(c
, shared
.cone
);
5789 time_t when
= time(NULL
)+seconds
;
5790 if (setExpire(c
->db
,key
,when
)) {
5791 addReply(c
,shared
.cone
);
5794 addReply(c
,shared
.czero
);
5800 static void expireCommand(redisClient
*c
) {
5801 expireGenericCommand(c
,c
->argv
[1],strtol(c
->argv
[2]->ptr
,NULL
,10));
5804 static void expireatCommand(redisClient
*c
) {
5805 expireGenericCommand(c
,c
->argv
[1],strtol(c
->argv
[2]->ptr
,NULL
,10)-time(NULL
));
5808 static void ttlCommand(redisClient
*c
) {
5812 expire
= getExpire(c
->db
,c
->argv
[1]);
5814 ttl
= (int) (expire
-time(NULL
));
5815 if (ttl
< 0) ttl
= -1;
5817 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",ttl
));
5820 /* ================================ MULTI/EXEC ============================== */
5822 /* Client state initialization for MULTI/EXEC */
5823 static void initClientMultiState(redisClient
*c
) {
5824 c
->mstate
.commands
= NULL
;
5825 c
->mstate
.count
= 0;
5828 /* Release all the resources associated with MULTI/EXEC state */
5829 static void freeClientMultiState(redisClient
*c
) {
5832 for (j
= 0; j
< c
->mstate
.count
; j
++) {
5834 multiCmd
*mc
= c
->mstate
.commands
+j
;
5836 for (i
= 0; i
< mc
->argc
; i
++)
5837 decrRefCount(mc
->argv
[i
]);
5840 zfree(c
->mstate
.commands
);
5843 /* Add a new command into the MULTI commands queue */
5844 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
) {
5848 c
->mstate
.commands
= zrealloc(c
->mstate
.commands
,
5849 sizeof(multiCmd
)*(c
->mstate
.count
+1));
5850 mc
= c
->mstate
.commands
+c
->mstate
.count
;
5853 mc
->argv
= zmalloc(sizeof(robj
*)*c
->argc
);
5854 memcpy(mc
->argv
,c
->argv
,sizeof(robj
*)*c
->argc
);
5855 for (j
= 0; j
< c
->argc
; j
++)
5856 incrRefCount(mc
->argv
[j
]);
5860 static void multiCommand(redisClient
*c
) {
5861 c
->flags
|= REDIS_MULTI
;
5862 addReply(c
,shared
.ok
);
5865 static void execCommand(redisClient
*c
) {
5870 if (!(c
->flags
& REDIS_MULTI
)) {
5871 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
5875 orig_argv
= c
->argv
;
5876 orig_argc
= c
->argc
;
5877 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
5878 for (j
= 0; j
< c
->mstate
.count
; j
++) {
5879 c
->argc
= c
->mstate
.commands
[j
].argc
;
5880 c
->argv
= c
->mstate
.commands
[j
].argv
;
5881 call(c
,c
->mstate
.commands
[j
].cmd
);
5883 c
->argv
= orig_argv
;
5884 c
->argc
= orig_argc
;
5885 freeClientMultiState(c
);
5886 initClientMultiState(c
);
5887 c
->flags
&= (~REDIS_MULTI
);
5890 /* =========================== Blocking Operations ========================= */
5892 /* Currently Redis blocking operations support is limited to list POP ops,
5893 * so the current implementation is not fully generic, but it is also not
5894 * completely specific so it will not require a rewrite to support new
5895 * kind of blocking operations in the future.
5897 * Still it's important to note that list blocking operations can be already
5898 * used as a notification mechanism in order to implement other blocking
5899 * operations at application level, so there must be a very strong evidence
5900 * of usefulness and generality before new blocking operations are implemented.
5902 * This is how the current blocking POP works, we use BLPOP as example:
5903 * - If the user calls BLPOP and the key exists and contains a non empty list
5904 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
5905 * if there is not to block.
5906 * - If instead BLPOP is called and the key does not exists or the list is
5907 * empty we need to block. In order to do so we remove the notification for
5908 * new data to read in the client socket (so that we'll not serve new
5909 * requests if the blocking request is not served). Also we put the client
5910 * in a dictionary (db->blockingkeys) mapping keys to a list of clients
5911 * blocking for this keys.
5912 * - If a PUSH operation against a key with blocked clients waiting is
5913 * performed, we serve the first in the list: basically instead to push
5914 * the new element inside the list we return it to the (first / oldest)
5915 * blocking client, unblock the client, and remove it form the list.
5917 * The above comment and the source code should be enough in order to understand
5918 * the implementation and modify / fix it later.
5921 /* Set a client in blocking mode for the specified key, with the specified
5923 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
5928 c
->blockingkeys
= zmalloc(sizeof(robj
*)*numkeys
);
5929 c
->blockingkeysnum
= numkeys
;
5930 c
->blockingto
= timeout
;
5931 for (j
= 0; j
< numkeys
; j
++) {
5932 /* Add the key in the client structure, to map clients -> keys */
5933 c
->blockingkeys
[j
] = keys
[j
];
5934 incrRefCount(keys
[j
]);
5936 /* And in the other "side", to map keys -> clients */
5937 de
= dictFind(c
->db
->blockingkeys
,keys
[j
]);
5941 /* For every key we take a list of clients blocked for it */
5943 retval
= dictAdd(c
->db
->blockingkeys
,keys
[j
],l
);
5944 incrRefCount(keys
[j
]);
5945 assert(retval
== DICT_OK
);
5947 l
= dictGetEntryVal(de
);
5949 listAddNodeTail(l
,c
);
5951 /* Mark the client as a blocked client */
5952 c
->flags
|= REDIS_BLOCKED
;
5953 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
5954 server
.blockedclients
++;
5957 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
5958 static void unblockClient(redisClient
*c
) {
5963 assert(c
->blockingkeys
!= NULL
);
5964 /* The client may wait for multiple keys, so unblock it for every key. */
5965 for (j
= 0; j
< c
->blockingkeysnum
; j
++) {
5966 /* Remove this client from the list of clients waiting for this key. */
5967 de
= dictFind(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
5969 l
= dictGetEntryVal(de
);
5970 listDelNode(l
,listSearchKey(l
,c
));
5971 /* If the list is empty we need to remove it to avoid wasting memory */
5972 if (listLength(l
) == 0)
5973 dictDelete(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
5974 decrRefCount(c
->blockingkeys
[j
]);
5976 /* Cleanup the client structure */
5977 zfree(c
->blockingkeys
);
5978 c
->blockingkeys
= NULL
;
5979 c
->flags
&= (~REDIS_BLOCKED
);
5980 server
.blockedclients
--;
5981 /* Ok now we are ready to get read events from socket, note that we
5982 * can't trap errors here as it's possible that unblockClients() is
5983 * called from freeClient() itself, and the only thing we can do
5984 * if we failed to register the READABLE event is to kill the client.
5985 * Still the following function should never fail in the real world as
5986 * we are sure the file descriptor is sane, and we exit on out of mem. */
5987 aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
, readQueryFromClient
, c
);
5988 /* As a final step we want to process data if there is some command waiting
5989 * in the input buffer. Note that this is safe even if unblockClient()
5990 * gets called from freeClient() because freeClient() will be smart
5991 * enough to call this function *after* c->querybuf was set to NULL. */
5992 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
5995 /* This should be called from any function PUSHing into lists.
5996 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
5997 * 'ele' is the element pushed.
5999 * If the function returns 0 there was no client waiting for a list push
6002 * If the function returns 1 there was a client waiting for a list push
6003 * against this key, the element was passed to this client thus it's not
6004 * needed to actually add it to the list and the caller should return asap. */
6005 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
6006 struct dictEntry
*de
;
6007 redisClient
*receiver
;
6011 de
= dictFind(c
->db
->blockingkeys
,key
);
6012 if (de
== NULL
) return 0;
6013 l
= dictGetEntryVal(de
);
6016 receiver
= ln
->value
;
6018 addReplySds(receiver
,sdsnew("*2\r\n"));
6019 addReplyBulkLen(receiver
,key
);
6020 addReply(receiver
,key
);
6021 addReply(receiver
,shared
.crlf
);
6022 addReplyBulkLen(receiver
,ele
);
6023 addReply(receiver
,ele
);
6024 addReply(receiver
,shared
.crlf
);
6025 unblockClient(receiver
);
6029 /* Blocking RPOP/LPOP */
6030 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
6035 for (j
= 1; j
< c
->argc
-1; j
++) {
6036 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
6038 if (o
->type
!= REDIS_LIST
) {
6039 addReply(c
,shared
.wrongtypeerr
);
6042 list
*list
= o
->ptr
;
6043 if (listLength(list
) != 0) {
6044 /* If the list contains elements fall back to the usual
6045 * non-blocking POP operation */
6046 robj
*argv
[2], **orig_argv
;
6049 /* We need to alter the command arguments before to call
6050 * popGenericCommand() as the command takes a single key. */
6051 orig_argv
= c
->argv
;
6052 orig_argc
= c
->argc
;
6053 argv
[1] = c
->argv
[j
];
6057 /* Also the return value is different, we need to output
6058 * the multi bulk reply header and the key name. The
6059 * "real" command will add the last element (the value)
6060 * for us. If this souds like an hack to you it's just
6061 * because it is... */
6062 addReplySds(c
,sdsnew("*2\r\n"));
6063 addReplyBulkLen(c
,argv
[1]);
6064 addReply(c
,argv
[1]);
6065 addReply(c
,shared
.crlf
);
6066 popGenericCommand(c
,where
);
6068 /* Fix the client structure with the original stuff */
6069 c
->argv
= orig_argv
;
6070 c
->argc
= orig_argc
;
6076 /* If the list is empty or the key does not exists we must block */
6077 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
6078 if (timeout
> 0) timeout
+= time(NULL
);
6079 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
6082 static void blpopCommand(redisClient
*c
) {
6083 blockingPopGenericCommand(c
,REDIS_HEAD
);
6086 static void brpopCommand(redisClient
*c
) {
6087 blockingPopGenericCommand(c
,REDIS_TAIL
);
6090 /* =============================== Replication ============================= */
6092 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
6093 ssize_t nwritten
, ret
= size
;
6094 time_t start
= time(NULL
);
6098 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
6099 nwritten
= write(fd
,ptr
,size
);
6100 if (nwritten
== -1) return -1;
6104 if ((time(NULL
)-start
) > timeout
) {
6112 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
6113 ssize_t nread
, totread
= 0;
6114 time_t start
= time(NULL
);
6118 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
6119 nread
= read(fd
,ptr
,size
);
6120 if (nread
== -1) return -1;
6125 if ((time(NULL
)-start
) > timeout
) {
6133 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
6140 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
6143 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
6154 static void syncCommand(redisClient
*c
) {
6155 /* ignore SYNC if aleady slave or in monitor mode */
6156 if (c
->flags
& REDIS_SLAVE
) return;
6158 /* SYNC can't be issued when the server has pending data to send to
6159 * the client about already issued commands. We need a fresh reply
6160 * buffer registering the differences between the BGSAVE and the current
6161 * dataset, so that we can copy to other slaves if needed. */
6162 if (listLength(c
->reply
) != 0) {
6163 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
6167 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
6168 /* Here we need to check if there is a background saving operation
6169 * in progress, or if it is required to start one */
6170 if (server
.bgsavechildpid
!= -1) {
6171 /* Ok a background save is in progress. Let's check if it is a good
6172 * one for replication, i.e. if there is another slave that is
6173 * registering differences since the server forked to save */
6178 listRewind(server
.slaves
,&li
);
6179 while((ln
= listNext(&li
))) {
6181 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
6184 /* Perfect, the server is already registering differences for
6185 * another slave. Set the right state, and copy the buffer. */
6186 listRelease(c
->reply
);
6187 c
->reply
= listDup(slave
->reply
);
6188 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
6189 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
6191 /* No way, we need to wait for the next BGSAVE in order to
6192 * register differences */
6193 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
6194 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
6197 /* Ok we don't have a BGSAVE in progress, let's start one */
6198 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
6199 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
6200 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
6201 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
6204 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
6207 c
->flags
|= REDIS_SLAVE
;
6209 listAddNodeTail(server
.slaves
,c
);
6213 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
6214 redisClient
*slave
= privdata
;
6216 REDIS_NOTUSED(mask
);
6217 char buf
[REDIS_IOBUF_LEN
];
6218 ssize_t nwritten
, buflen
;
6220 if (slave
->repldboff
== 0) {
6221 /* Write the bulk write count before to transfer the DB. In theory here
6222 * we don't know how much room there is in the output buffer of the
6223 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
6224 * operations) will never be smaller than the few bytes we need. */
6227 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
6229 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
6237 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
6238 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
6240 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
6241 (buflen
== 0) ? "premature EOF" : strerror(errno
));
6245 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
6246 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
6251 slave
->repldboff
+= nwritten
;
6252 if (slave
->repldboff
== slave
->repldbsize
) {
6253 close(slave
->repldbfd
);
6254 slave
->repldbfd
= -1;
6255 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
6256 slave
->replstate
= REDIS_REPL_ONLINE
;
6257 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
6258 sendReplyToClient
, slave
) == AE_ERR
) {
6262 addReplySds(slave
,sdsempty());
6263 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
6267 /* This function is called at the end of every backgrond saving.
6268 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
6269 * otherwise REDIS_ERR is passed to the function.
6271 * The goal of this function is to handle slaves waiting for a successful
6272 * background saving in order to perform non-blocking synchronization. */
6273 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
6275 int startbgsave
= 0;
6278 listRewind(server
.slaves
,&li
);
6279 while((ln
= listNext(&li
))) {
6280 redisClient
*slave
= ln
->value
;
6282 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
6284 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
6285 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
6286 struct redis_stat buf
;
6288 if (bgsaveerr
!= REDIS_OK
) {
6290 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
6293 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
6294 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
6296 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
6299 slave
->repldboff
= 0;
6300 slave
->repldbsize
= buf
.st_size
;
6301 slave
->replstate
= REDIS_REPL_SEND_BULK
;
6302 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
6303 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
6310 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
6313 listRewind(server
.slaves
,&li
);
6314 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
6315 while((ln
= listNext(&li
))) {
6316 redisClient
*slave
= ln
->value
;
6318 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
6325 static int syncWithMaster(void) {
6326 char buf
[1024], tmpfile
[256], authcmd
[1024];
6328 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
6332 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
6337 /* AUTH with the master if required. */
6338 if(server
.masterauth
) {
6339 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
6340 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
6342 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
6346 /* Read the AUTH result. */
6347 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
6349 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
6353 if (buf
[0] != '+') {
6355 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
6360 /* Issue the SYNC command */
6361 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
6363 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
6367 /* Read the bulk write count */
6368 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
6370 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
6374 if (buf
[0] != '$') {
6376 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
6379 dumpsize
= atoi(buf
+1);
6380 redisLog(REDIS_NOTICE
,"Receiving %d bytes data dump from MASTER",dumpsize
);
6381 /* Read the bulk write data on a temp file */
6382 snprintf(tmpfile
,256,"temp-%d.%ld.rdb",(int)time(NULL
),(long int)random());
6383 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
,0644);
6386 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
6390 int nread
, nwritten
;
6392 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
6394 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
6400 nwritten
= write(dfd
,buf
,nread
);
6401 if (nwritten
== -1) {
6402 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
6410 if (rename(tmpfile
,server
.dbfilename
) == -1) {
6411 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
6417 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
6418 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
6422 server
.master
= createClient(fd
);
6423 server
.master
->flags
|= REDIS_MASTER
;
6424 server
.master
->authenticated
= 1;
6425 server
.replstate
= REDIS_REPL_CONNECTED
;
6429 static void slaveofCommand(redisClient
*c
) {
6430 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
6431 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
6432 if (server
.masterhost
) {
6433 sdsfree(server
.masterhost
);
6434 server
.masterhost
= NULL
;
6435 if (server
.master
) freeClient(server
.master
);
6436 server
.replstate
= REDIS_REPL_NONE
;
6437 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
6440 sdsfree(server
.masterhost
);
6441 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
6442 server
.masterport
= atoi(c
->argv
[2]->ptr
);
6443 if (server
.master
) freeClient(server
.master
);
6444 server
.replstate
= REDIS_REPL_CONNECT
;
6445 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
6446 server
.masterhost
, server
.masterport
);
6448 addReply(c
,shared
.ok
);
6451 /* ============================ Maxmemory directive ======================== */
6453 /* Try to free one object form the pre-allocated objects free list.
6454 * This is useful under low mem conditions as by default we take 1 million
6455 * free objects allocated. On success REDIS_OK is returned, otherwise
6457 static int tryFreeOneObjectFromFreelist(void) {
6460 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
6461 if (listLength(server
.objfreelist
)) {
6462 listNode
*head
= listFirst(server
.objfreelist
);
6463 o
= listNodeValue(head
);
6464 listDelNode(server
.objfreelist
,head
);
6465 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
6469 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
6474 /* This function gets called when 'maxmemory' is set on the config file to limit
6475 * the max memory used by the server, and we are out of memory.
6476 * This function will try to, in order:
6478 * - Free objects from the free list
6479 * - Try to remove keys with an EXPIRE set
6481 * It is not possible to free enough memory to reach used-memory < maxmemory
6482 * the server will start refusing commands that will enlarge even more the
6485 static void freeMemoryIfNeeded(void) {
6486 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
6487 int j
, k
, freed
= 0;
6489 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
6490 for (j
= 0; j
< server
.dbnum
; j
++) {
6492 robj
*minkey
= NULL
;
6493 struct dictEntry
*de
;
6495 if (dictSize(server
.db
[j
].expires
)) {
6497 /* From a sample of three keys drop the one nearest to
6498 * the natural expire */
6499 for (k
= 0; k
< 3; k
++) {
6502 de
= dictGetRandomKey(server
.db
[j
].expires
);
6503 t
= (time_t) dictGetEntryVal(de
);
6504 if (minttl
== -1 || t
< minttl
) {
6505 minkey
= dictGetEntryKey(de
);
6509 deleteKey(server
.db
+j
,minkey
);
6512 if (!freed
) return; /* nothing to free... */
6516 /* ============================== Append Only file ========================== */
6518 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
6519 sds buf
= sdsempty();
6525 /* The DB this command was targetting is not the same as the last command
6526 * we appendend. To issue a SELECT command is needed. */
6527 if (dictid
!= server
.appendseldb
) {
6530 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
6531 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
6532 (unsigned long)strlen(seldb
),seldb
);
6533 server
.appendseldb
= dictid
;
6536 /* "Fix" the argv vector if the command is EXPIRE. We want to translate
6537 * EXPIREs into EXPIREATs calls */
6538 if (cmd
->proc
== expireCommand
) {
6541 tmpargv
[0] = createStringObject("EXPIREAT",8);
6542 tmpargv
[1] = argv
[1];
6543 incrRefCount(argv
[1]);
6544 when
= time(NULL
)+strtol(argv
[2]->ptr
,NULL
,10);
6545 tmpargv
[2] = createObject(REDIS_STRING
,
6546 sdscatprintf(sdsempty(),"%ld",when
));
6550 /* Append the actual command */
6551 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
6552 for (j
= 0; j
< argc
; j
++) {
6555 o
= getDecodedObject(o
);
6556 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
6557 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
6558 buf
= sdscatlen(buf
,"\r\n",2);
6562 /* Free the objects from the modified argv for EXPIREAT */
6563 if (cmd
->proc
== expireCommand
) {
6564 for (j
= 0; j
< 3; j
++)
6565 decrRefCount(argv
[j
]);
6568 /* We want to perform a single write. This should be guaranteed atomic
6569 * at least if the filesystem we are writing is a real physical one.
6570 * While this will save us against the server being killed I don't think
6571 * there is much to do about the whole server stopping for power problems
6573 nwritten
= write(server
.appendfd
,buf
,sdslen(buf
));
6574 if (nwritten
!= (signed)sdslen(buf
)) {
6575 /* Ooops, we are in troubles. The best thing to do for now is
6576 * to simply exit instead to give the illusion that everything is
6577 * working as expected. */
6578 if (nwritten
== -1) {
6579 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
6581 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
6585 /* If a background append only file rewriting is in progress we want to
6586 * accumulate the differences between the child DB and the current one
6587 * in a buffer, so that when the child process will do its work we
6588 * can append the differences to the new append only file. */
6589 if (server
.bgrewritechildpid
!= -1)
6590 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
6594 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
6595 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
6596 now
-server
.lastfsync
> 1))
6598 fsync(server
.appendfd
); /* Let's try to get this data on the disk */
6599 server
.lastfsync
= now
;
6603 /* In Redis commands are always executed in the context of a client, so in
6604 * order to load the append only file we need to create a fake client. */
6605 static struct redisClient
*createFakeClient(void) {
6606 struct redisClient
*c
= zmalloc(sizeof(*c
));
6610 c
->querybuf
= sdsempty();
6614 /* We set the fake client as a slave waiting for the synchronization
6615 * so that Redis will not try to send replies to this client. */
6616 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
6617 c
->reply
= listCreate();
6618 listSetFreeMethod(c
->reply
,decrRefCount
);
6619 listSetDupMethod(c
->reply
,dupClientReplyValue
);
6623 static void freeFakeClient(struct redisClient
*c
) {
6624 sdsfree(c
->querybuf
);
6625 listRelease(c
->reply
);
6629 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
6630 * error (the append only file is zero-length) REDIS_ERR is returned. On
6631 * fatal error an error message is logged and the program exists. */
6632 int loadAppendOnlyFile(char *filename
) {
6633 struct redisClient
*fakeClient
;
6634 FILE *fp
= fopen(filename
,"r");
6635 struct redis_stat sb
;
6636 unsigned long long loadedkeys
= 0;
6638 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
6642 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
6646 fakeClient
= createFakeClient();
6653 struct redisCommand
*cmd
;
6655 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
6661 if (buf
[0] != '*') goto fmterr
;
6663 argv
= zmalloc(sizeof(robj
*)*argc
);
6664 for (j
= 0; j
< argc
; j
++) {
6665 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
6666 if (buf
[0] != '$') goto fmterr
;
6667 len
= strtol(buf
+1,NULL
,10);
6668 argsds
= sdsnewlen(NULL
,len
);
6669 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
6670 argv
[j
] = createObject(REDIS_STRING
,argsds
);
6671 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
6674 /* Command lookup */
6675 cmd
= lookupCommand(argv
[0]->ptr
);
6677 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
6680 /* Try object sharing and encoding */
6681 if (server
.shareobjects
) {
6683 for(j
= 1; j
< argc
; j
++)
6684 argv
[j
] = tryObjectSharing(argv
[j
]);
6686 if (cmd
->flags
& REDIS_CMD_BULK
)
6687 tryObjectEncoding(argv
[argc
-1]);
6688 /* Run the command in the context of a fake client */
6689 fakeClient
->argc
= argc
;
6690 fakeClient
->argv
= argv
;
6691 cmd
->proc(fakeClient
);
6692 /* Discard the reply objects list from the fake client */
6693 while(listLength(fakeClient
->reply
))
6694 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
6695 /* Clean up, ready for the next command */
6696 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
6698 /* Handle swapping while loading big datasets when VM is on */
6700 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
6701 while (zmalloc_used_memory() > server
.vm_max_memory
) {
6702 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
6707 freeFakeClient(fakeClient
);
6712 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
6714 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
6718 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
6722 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
6723 static int fwriteBulk(FILE *fp
, robj
*obj
) {
6727 /* Avoid the incr/decr ref count business if possible to help
6728 * copy-on-write (we are often in a child process when this function
6730 * Also makes sure that key objects don't get incrRefCount-ed when VM
6732 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
6733 obj
= getDecodedObject(obj
);
6736 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(long)sdslen(obj
->ptr
));
6737 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) goto err
;
6738 if (sdslen(obj
->ptr
) && fwrite(obj
->ptr
,sdslen(obj
->ptr
),1,fp
) == 0)
6740 if (fwrite("\r\n",2,1,fp
) == 0) goto err
;
6741 if (decrrc
) decrRefCount(obj
);
6744 if (decrrc
) decrRefCount(obj
);
6748 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
6749 static int fwriteBulkDouble(FILE *fp
, double d
) {
6750 char buf
[128], dbuf
[128];
6752 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
6753 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
6754 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
6755 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
6759 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
6760 static int fwriteBulkLong(FILE *fp
, long l
) {
6761 char buf
[128], lbuf
[128];
6763 snprintf(lbuf
,sizeof(lbuf
),"%ld\r\n",l
);
6764 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(lbuf
)-2);
6765 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
6766 if (fwrite(lbuf
,strlen(lbuf
),1,fp
) == 0) return 0;
6770 /* Write a sequence of commands able to fully rebuild the dataset into
6771 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
6772 static int rewriteAppendOnlyFile(char *filename
) {
6773 dictIterator
*di
= NULL
;
6778 time_t now
= time(NULL
);
6780 /* Note that we have to use a different temp name here compared to the
6781 * one used by rewriteAppendOnlyFileBackground() function. */
6782 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
6783 fp
= fopen(tmpfile
,"w");
6785 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
6788 for (j
= 0; j
< server
.dbnum
; j
++) {
6789 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
6790 redisDb
*db
= server
.db
+j
;
6792 if (dictSize(d
) == 0) continue;
6793 di
= dictGetIterator(d
);
6799 /* SELECT the new DB */
6800 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
6801 if (fwriteBulkLong(fp
,j
) == 0) goto werr
;
6803 /* Iterate this DB writing every entry */
6804 while((de
= dictNext(di
)) != NULL
) {
6809 key
= dictGetEntryKey(de
);
6810 /* If the value for this key is swapped, load a preview in memory.
6811 * We use a "swapped" flag to remember if we need to free the
6812 * value object instead to just increment the ref count anyway
6813 * in order to avoid copy-on-write of pages if we are forked() */
6814 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
6815 key
->storage
== REDIS_VM_SWAPPING
) {
6816 o
= dictGetEntryVal(de
);
6819 o
= vmPreviewObject(key
);
6822 expiretime
= getExpire(db
,key
);
6824 /* Save the key and associated value */
6825 if (o
->type
== REDIS_STRING
) {
6826 /* Emit a SET command */
6827 char cmd
[]="*3\r\n$3\r\nSET\r\n";
6828 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
6830 if (fwriteBulk(fp
,key
) == 0) goto werr
;
6831 if (fwriteBulk(fp
,o
) == 0) goto werr
;
6832 } else if (o
->type
== REDIS_LIST
) {
6833 /* Emit the RPUSHes needed to rebuild the list */
6834 list
*list
= o
->ptr
;
6838 listRewind(list
,&li
);
6839 while((ln
= listNext(&li
))) {
6840 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
6841 robj
*eleobj
= listNodeValue(ln
);
6843 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
6844 if (fwriteBulk(fp
,key
) == 0) goto werr
;
6845 if (fwriteBulk(fp
,eleobj
) == 0) goto werr
;
6847 } else if (o
->type
== REDIS_SET
) {
6848 /* Emit the SADDs needed to rebuild the set */
6850 dictIterator
*di
= dictGetIterator(set
);
6853 while((de
= dictNext(di
)) != NULL
) {
6854 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
6855 robj
*eleobj
= dictGetEntryKey(de
);
6857 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
6858 if (fwriteBulk(fp
,key
) == 0) goto werr
;
6859 if (fwriteBulk(fp
,eleobj
) == 0) goto werr
;
6861 dictReleaseIterator(di
);
6862 } else if (o
->type
== REDIS_ZSET
) {
6863 /* Emit the ZADDs needed to rebuild the sorted set */
6865 dictIterator
*di
= dictGetIterator(zs
->dict
);
6868 while((de
= dictNext(di
)) != NULL
) {
6869 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
6870 robj
*eleobj
= dictGetEntryKey(de
);
6871 double *score
= dictGetEntryVal(de
);
6873 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
6874 if (fwriteBulk(fp
,key
) == 0) goto werr
;
6875 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
6876 if (fwriteBulk(fp
,eleobj
) == 0) goto werr
;
6878 dictReleaseIterator(di
);
6880 redisAssert(0 != 0);
6882 /* Save the expire time */
6883 if (expiretime
!= -1) {
6884 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
6885 /* If this key is already expired skip it */
6886 if (expiretime
< now
) continue;
6887 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
6888 if (fwriteBulk(fp
,key
) == 0) goto werr
;
6889 if (fwriteBulkLong(fp
,expiretime
) == 0) goto werr
;
6891 if (swapped
) decrRefCount(o
);
6893 dictReleaseIterator(di
);
6896 /* Make sure data will not remain on the OS's output buffers */
6901 /* Use RENAME to make sure the DB file is changed atomically only
6902 * if the generate DB file is ok. */
6903 if (rename(tmpfile
,filename
) == -1) {
6904 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
6908 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
6914 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
6915 if (di
) dictReleaseIterator(di
);
6919 /* This is how rewriting of the append only file in background works:
6921 * 1) The user calls BGREWRITEAOF
6922 * 2) Redis calls this function, that forks():
6923 * 2a) the child rewrite the append only file in a temp file.
6924 * 2b) the parent accumulates differences in server.bgrewritebuf.
6925 * 3) When the child finished '2a' exists.
6926 * 4) The parent will trap the exit code, if it's OK, will append the
6927 * data accumulated into server.bgrewritebuf into the temp file, and
6928 * finally will rename(2) the temp file in the actual file name.
6929 * The the new file is reopened as the new append only file. Profit!
6931 static int rewriteAppendOnlyFileBackground(void) {
6934 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
6935 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
6936 if ((childpid
= fork()) == 0) {
6940 if (server
.vm_enabled
) vmReopenSwapFile();
6942 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
6943 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
6950 if (childpid
== -1) {
6951 redisLog(REDIS_WARNING
,
6952 "Can't rewrite append only file in background: fork: %s",
6956 redisLog(REDIS_NOTICE
,
6957 "Background append only file rewriting started by pid %d",childpid
);
6958 server
.bgrewritechildpid
= childpid
;
6959 /* We set appendseldb to -1 in order to force the next call to the
6960 * feedAppendOnlyFile() to issue a SELECT command, so the differences
6961 * accumulated by the parent into server.bgrewritebuf will start
6962 * with a SELECT statement and it will be safe to merge. */
6963 server
.appendseldb
= -1;
6966 return REDIS_OK
; /* unreached */
6969 static void bgrewriteaofCommand(redisClient
*c
) {
6970 if (server
.bgrewritechildpid
!= -1) {
6971 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
6974 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
6975 char *status
= "+Background append only file rewriting started\r\n";
6976 addReplySds(c
,sdsnew(status
));
6978 addReply(c
,shared
.err
);
6982 static void aofRemoveTempFile(pid_t childpid
) {
6985 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
6989 /* Virtual Memory is composed mainly of two subsystems:
6990 * - Blocking Virutal Memory
6991 * - Threaded Virtual Memory I/O
6992 * The two parts are not fully decoupled, but functions are split among two
6993 * different sections of the source code (delimited by comments) in order to
6994 * make more clear what functionality is about the blocking VM and what about
6995 * the threaded (not blocking) VM.
6999 * Redis VM is a blocking VM (one that blocks reading swapped values from
7000 * disk into memory when a value swapped out is needed in memory) that is made
7001 * unblocking by trying to examine the command argument vector in order to
7002 * load in background values that will likely be needed in order to exec
7003 * the command. The command is executed only once all the relevant keys
7004 * are loaded into memory.
7006 * This basically is almost as simple of a blocking VM, but almost as parallel
7007 * as a fully non-blocking VM.
7010 /* =================== Virtual Memory - Blocking Side ====================== */
7012 /* substitute the first occurrence of '%p' with the process pid in the
7013 * swap file name. */
7014 static void expandVmSwapFilename(void) {
7015 char *p
= strstr(server
.vm_swap_file
,"%p");
7021 new = sdscat(new,server
.vm_swap_file
);
7022 new = sdscatprintf(new,"%ld",(long) getpid());
7023 new = sdscat(new,p
+2);
7024 zfree(server
.vm_swap_file
);
7025 server
.vm_swap_file
= new;
7028 static void vmInit(void) {
7033 if (server
.vm_max_threads
!= 0)
7034 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
7036 expandVmSwapFilename();
7037 redisLog(REDIS_NOTICE
,"Using '%s' as swap file",server
.vm_swap_file
);
7038 server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b");
7039 if (server
.vm_fp
== NULL
) {
7040 redisLog(REDIS_WARNING
,"Impossible to open the swap file. Exiting.");
7043 server
.vm_fd
= fileno(server
.vm_fp
);
7044 server
.vm_next_page
= 0;
7045 server
.vm_near_pages
= 0;
7046 server
.vm_stats_used_pages
= 0;
7047 server
.vm_stats_swapped_objects
= 0;
7048 server
.vm_stats_swapouts
= 0;
7049 server
.vm_stats_swapins
= 0;
7050 totsize
= server
.vm_pages
*server
.vm_page_size
;
7051 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
7052 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
7053 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
7057 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
7059 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
7060 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
7061 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
7062 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
7064 /* Initialize threaded I/O (used by Virtual Memory) */
7065 server
.io_newjobs
= listCreate();
7066 server
.io_processing
= listCreate();
7067 server
.io_processed
= listCreate();
7068 server
.io_clients
= listCreate();
7069 pthread_mutex_init(&server
.io_mutex
,NULL
);
7070 pthread_mutex_init(&server
.obj_freelist_mutex
,NULL
);
7071 pthread_mutex_init(&server
.io_swapfile_mutex
,NULL
);
7072 server
.io_active_threads
= 0;
7073 if (pipe(pipefds
) == -1) {
7074 redisLog(REDIS_WARNING
,"Unable to intialized VM: pipe(2): %s. Exiting."
7078 server
.io_ready_pipe_read
= pipefds
[0];
7079 server
.io_ready_pipe_write
= pipefds
[1];
7080 redisAssert(anetNonBlock(NULL
,server
.io_ready_pipe_read
) != ANET_ERR
);
7081 /* LZF requires a lot of stack */
7082 pthread_attr_init(&server
.io_threads_attr
);
7083 pthread_attr_getstacksize(&server
.io_threads_attr
, &stacksize
);
7084 while (stacksize
< REDIS_THREAD_STACK_SIZE
) stacksize
*= 2;
7085 pthread_attr_setstacksize(&server
.io_threads_attr
, stacksize
);
7086 /* Listen for events in the threaded I/O pipe */
7087 if (aeCreateFileEvent(server
.el
, server
.io_ready_pipe_read
, AE_READABLE
,
7088 vmThreadedIOCompletedJob
, NULL
) == AE_ERR
)
7089 oom("creating file event");
7092 /* Mark the page as used */
7093 static void vmMarkPageUsed(off_t page
) {
7094 off_t byte
= page
/8;
7096 server
.vm_bitmap
[byte
] |= 1<<bit
;
7097 redisLog(REDIS_DEBUG
,"Mark used: %lld (byte:%lld bit:%d)\n",
7098 (long long)page
, (long long)byte
, bit
);
7101 /* Mark N contiguous pages as used, with 'page' being the first. */
7102 static void vmMarkPagesUsed(off_t page
, off_t count
) {
7105 for (j
= 0; j
< count
; j
++)
7106 vmMarkPageUsed(page
+j
);
7107 server
.vm_stats_used_pages
+= count
;
7110 /* Mark the page as free */
7111 static void vmMarkPageFree(off_t page
) {
7112 off_t byte
= page
/8;
7114 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
7117 /* Mark N contiguous pages as free, with 'page' being the first. */
7118 static void vmMarkPagesFree(off_t page
, off_t count
) {
7121 for (j
= 0; j
< count
; j
++)
7122 vmMarkPageFree(page
+j
);
7123 server
.vm_stats_used_pages
-= count
;
7126 /* Test if the page is free */
7127 static int vmFreePage(off_t page
) {
7128 off_t byte
= page
/8;
7130 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
7133 /* Find N contiguous free pages storing the first page of the cluster in *first.
7134 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
7135 * REDIS_ERR is returned.
7137 * This function uses a simple algorithm: we try to allocate
7138 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
7139 * again from the start of the swap file searching for free spaces.
7141 * If it looks pretty clear that there are no free pages near our offset
7142 * we try to find less populated places doing a forward jump of
7143 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
7144 * without hurry, and then we jump again and so forth...
7146 * This function can be improved using a free list to avoid to guess
7147 * too much, since we could collect data about freed pages.
7149 * note: I implemented this function just after watching an episode of
7150 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
7152 static int vmFindContiguousPages(off_t
*first
, off_t n
) {
7153 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
7155 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
7156 server
.vm_near_pages
= 0;
7157 server
.vm_next_page
= 0;
7159 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
7160 base
= server
.vm_next_page
;
7162 while(offset
< server
.vm_pages
) {
7163 off_t
this = base
+offset
;
7165 redisLog(REDIS_DEBUG
, "THIS: %lld (%c)\n", (long long) this, vmFreePage(this) ? 'F' : 'X');
7166 /* If we overflow, restart from page zero */
7167 if (this >= server
.vm_pages
) {
7168 this -= server
.vm_pages
;
7170 /* Just overflowed, what we found on tail is no longer
7171 * interesting, as it's no longer contiguous. */
7175 if (vmFreePage(this)) {
7176 /* This is a free page */
7178 /* Already got N free pages? Return to the caller, with success */
7180 *first
= this-(n
-1);
7181 server
.vm_next_page
= this+1;
7185 /* The current one is not a free page */
7189 /* Fast-forward if the current page is not free and we already
7190 * searched enough near this place. */
7192 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
7193 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
7195 /* Note that even if we rewind after the jump, we are don't need
7196 * to make sure numfree is set to zero as we only jump *if* it
7197 * is set to zero. */
7199 /* Otherwise just check the next page */
7206 /* Write the specified object at the specified page of the swap file */
7207 static int vmWriteObjectOnSwap(robj
*o
, off_t page
) {
7208 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
7209 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
7210 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
7211 redisLog(REDIS_WARNING
,
7212 "Critical VM problem in vmSwapObjectBlocking(): can't seek: %s",
7216 rdbSaveObject(server
.vm_fp
,o
);
7217 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
7221 /* Swap the 'val' object relative to 'key' into disk. Store all the information
7222 * needed to later retrieve the object into the key object.
7223 * If we can't find enough contiguous empty pages to swap the object on disk
7224 * REDIS_ERR is returned. */
7225 static int vmSwapObjectBlocking(robj
*key
, robj
*val
) {
7226 off_t pages
= rdbSavedObjectPages(val
,NULL
);
7229 assert(key
->storage
== REDIS_VM_MEMORY
);
7230 assert(key
->refcount
== 1);
7231 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return REDIS_ERR
;
7232 if (vmWriteObjectOnSwap(val
,page
) == REDIS_ERR
) return REDIS_ERR
;
7233 key
->vm
.page
= page
;
7234 key
->vm
.usedpages
= pages
;
7235 key
->storage
= REDIS_VM_SWAPPED
;
7236 key
->vtype
= val
->type
;
7237 decrRefCount(val
); /* Deallocate the object from memory. */
7238 vmMarkPagesUsed(page
,pages
);
7239 redisLog(REDIS_DEBUG
,"VM: object %s swapped out at %lld (%lld pages)",
7240 (unsigned char*) key
->ptr
,
7241 (unsigned long long) page
, (unsigned long long) pages
);
7242 server
.vm_stats_swapped_objects
++;
7243 server
.vm_stats_swapouts
++;
7244 fflush(server
.vm_fp
);
7248 static robj
*vmReadObjectFromSwap(off_t page
, int type
) {
7251 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
7252 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
7253 redisLog(REDIS_WARNING
,
7254 "Unrecoverable VM problem in vmLoadObject(): can't seek: %s",
7258 o
= rdbLoadObject(type
,server
.vm_fp
);
7260 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmLoadObject(): can't load object from swap file: %s", strerror(errno
));
7263 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
7267 /* Load the value object relative to the 'key' object from swap to memory.
7268 * The newly allocated object is returned.
7270 * If preview is true the unserialized object is returned to the caller but
7271 * no changes are made to the key object, nor the pages are marked as freed */
7272 static robj
*vmGenericLoadObject(robj
*key
, int preview
) {
7275 redisAssert(key
->storage
== REDIS_VM_SWAPPED
);
7276 val
= vmReadObjectFromSwap(key
->vm
.page
,key
->vtype
);
7278 key
->storage
= REDIS_VM_MEMORY
;
7279 key
->vm
.atime
= server
.unixtime
;
7280 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
7281 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk",
7282 (unsigned char*) key
->ptr
);
7283 server
.vm_stats_swapped_objects
--;
7285 redisLog(REDIS_DEBUG
, "VM: object %s previewed from disk",
7286 (unsigned char*) key
->ptr
);
7288 server
.vm_stats_swapins
++;
7292 /* Plain object loading, from swap to memory */
7293 static robj
*vmLoadObject(robj
*key
) {
7294 /* If we are loading the object in background, stop it, we
7295 * need to load this object synchronously ASAP. */
7296 if (key
->storage
== REDIS_VM_LOADING
)
7297 vmCancelThreadedIOJob(key
);
7298 return vmGenericLoadObject(key
,0);
7301 /* Just load the value on disk, without to modify the key.
7302 * This is useful when we want to perform some operation on the value
7303 * without to really bring it from swap to memory, like while saving the
7304 * dataset or rewriting the append only log. */
7305 static robj
*vmPreviewObject(robj
*key
) {
7306 return vmGenericLoadObject(key
,1);
7309 /* How a good candidate is this object for swapping?
7310 * The better candidate it is, the greater the returned value.
7312 * Currently we try to perform a fast estimation of the object size in
7313 * memory, and combine it with aging informations.
7315 * Basically swappability = idle-time * log(estimated size)
7317 * Bigger objects are preferred over smaller objects, but not
7318 * proportionally, this is why we use the logarithm. This algorithm is
7319 * just a first try and will probably be tuned later. */
7320 static double computeObjectSwappability(robj
*o
) {
7321 time_t age
= server
.unixtime
- o
->vm
.atime
;
7325 struct dictEntry
*de
;
7328 if (age
<= 0) return 0;
7331 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
7334 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
7339 listNode
*ln
= listFirst(l
);
7341 asize
= sizeof(list
);
7343 robj
*ele
= ln
->value
;
7346 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
7347 (sizeof(*o
)+sdslen(ele
->ptr
)) :
7349 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
7354 z
= (o
->type
== REDIS_ZSET
);
7355 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
7357 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
7358 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
7363 de
= dictGetRandomKey(d
);
7364 ele
= dictGetEntryKey(de
);
7365 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
7366 (sizeof(*o
)+sdslen(ele
->ptr
)) :
7368 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
7369 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
7373 return (double)asize
*log(1+asize
);
7376 /* Try to swap an object that's a good candidate for swapping.
7377 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
7378 * to swap any object at all.
7380 * If 'usethreaded' is true, Redis will try to swap the object in background
7381 * using I/O threads. */
7382 static int vmSwapOneObject(int usethreads
) {
7384 struct dictEntry
*best
= NULL
;
7385 double best_swappability
= 0;
7386 redisDb
*best_db
= NULL
;
7389 for (j
= 0; j
< server
.dbnum
; j
++) {
7390 redisDb
*db
= server
.db
+j
;
7391 int maxtries
= 1000;
7393 if (dictSize(db
->dict
) == 0) continue;
7394 for (i
= 0; i
< 5; i
++) {
7396 double swappability
;
7398 if (maxtries
) maxtries
--;
7399 de
= dictGetRandomKey(db
->dict
);
7400 key
= dictGetEntryKey(de
);
7401 val
= dictGetEntryVal(de
);
7402 /* Only swap objects that are currently in memory.
7404 * Also don't swap shared objects if threaded VM is on, as we
7405 * try to ensure that the main thread does not touch the
7406 * object while the I/O thread is using it, but we can't
7407 * control other keys without adding additional mutex. */
7408 if (key
->storage
!= REDIS_VM_MEMORY
||
7409 (server
.vm_max_threads
!= 0 && val
->refcount
!= 1)) {
7410 if (maxtries
) i
--; /* don't count this try */
7413 swappability
= computeObjectSwappability(val
);
7414 if (!best
|| swappability
> best_swappability
) {
7416 best_swappability
= swappability
;
7422 redisLog(REDIS_DEBUG
,"No swappable key found!");
7425 key
= dictGetEntryKey(best
);
7426 val
= dictGetEntryVal(best
);
7428 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
7429 key
->ptr
, best_swappability
);
7431 /* Unshare the key if needed */
7432 if (key
->refcount
> 1) {
7433 robj
*newkey
= dupStringObject(key
);
7435 key
= dictGetEntryKey(best
) = newkey
;
7439 vmSwapObjectThreaded(key
,val
,best_db
);
7442 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
7443 dictGetEntryVal(best
) = NULL
;
7451 static int vmSwapOneObjectBlocking() {
7452 return vmSwapOneObject(0);
7455 static int vmSwapOneObjectThreaded() {
7456 return vmSwapOneObject(1);
7459 /* Return true if it's safe to swap out objects in a given moment.
7460 * Basically we don't want to swap objects out while there is a BGSAVE
7461 * or a BGAEOREWRITE running in backgroud. */
7462 static int vmCanSwapOut(void) {
7463 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
7466 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
7467 * and was deleted. Otherwise 0 is returned. */
7468 static int deleteIfSwapped(redisDb
*db
, robj
*key
) {
7472 if ((de
= dictFind(db
->dict
,key
)) == NULL
) return 0;
7473 foundkey
= dictGetEntryKey(de
);
7474 if (foundkey
->storage
== REDIS_VM_MEMORY
) return 0;
7479 /* =================== Virtual Memory - Threaded I/O ======================= */
7481 static void freeIOJob(iojob
*j
) {
7482 if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
||
7483 j
->type
== REDIS_IOJOB_DO_SWAP
)
7484 decrRefCount(j
->val
);
7485 decrRefCount(j
->key
);
7489 /* Every time a thread finished a Job, it writes a byte into the write side
7490 * of an unix pipe in order to "awake" the main thread, and this function
7492 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
,
7499 REDIS_NOTUSED(mask
);
7500 REDIS_NOTUSED(privdata
);
7502 /* For every byte we read in the read side of the pipe, there is one
7503 * I/O job completed to process. */
7504 while((retval
= read(fd
,buf
,1)) == 1) {
7508 struct dictEntry
*de
;
7510 redisLog(REDIS_DEBUG
,"Processing I/O completed job");
7512 /* Get the processed element (the oldest one) */
7514 assert(listLength(server
.io_processed
) != 0);
7515 ln
= listFirst(server
.io_processed
);
7517 listDelNode(server
.io_processed
,ln
);
7519 /* If this job is marked as canceled, just ignore it */
7524 /* Post process it in the main thread, as there are things we
7525 * can do just here to avoid race conditions and/or invasive locks */
7526 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
);
7527 de
= dictFind(j
->db
->dict
,j
->key
);
7529 key
= dictGetEntryKey(de
);
7530 if (j
->type
== REDIS_IOJOB_LOAD
) {
7531 /* Key loaded, bring it at home */
7532 key
->storage
= REDIS_VM_MEMORY
;
7533 key
->vm
.atime
= server
.unixtime
;
7534 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
7535 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk (threaded)",
7536 (unsigned char*) key
->ptr
);
7537 server
.vm_stats_swapped_objects
--;
7538 server
.vm_stats_swapins
++;
7540 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
7541 /* Now we know the amount of pages required to swap this object.
7542 * Let's find some space for it, and queue this task again
7543 * rebranded as REDIS_IOJOB_DO_SWAP. */
7544 if (!vmCanSwapOut() ||
7545 vmFindContiguousPages(&j
->page
,j
->pages
) == REDIS_ERR
)
7547 /* Ooops... no space or we can't swap as there is
7548 * a fork()ed Redis trying to save stuff on disk. */
7550 key
->storage
= REDIS_VM_MEMORY
; /* undo operation */
7552 /* Note that we need to mark this pages as used now,
7553 * if the job will be canceled, we'll mark them as freed
7555 vmMarkPagesUsed(j
->page
,j
->pages
);
7556 j
->type
= REDIS_IOJOB_DO_SWAP
;
7561 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
7564 /* Key swapped. We can finally free some memory. */
7565 if (key
->storage
!= REDIS_VM_SWAPPING
) {
7566 printf("key->storage: %d\n",key
->storage
);
7567 printf("key->name: %s\n",(char*)key
->ptr
);
7568 printf("key->refcount: %d\n",key
->refcount
);
7569 printf("val: %p\n",(void*)j
->val
);
7570 printf("val->type: %d\n",j
->val
->type
);
7571 printf("val->ptr: %s\n",(char*)j
->val
->ptr
);
7573 redisAssert(key
->storage
== REDIS_VM_SWAPPING
);
7574 val
= dictGetEntryVal(de
);
7575 key
->vm
.page
= j
->page
;
7576 key
->vm
.usedpages
= j
->pages
;
7577 key
->storage
= REDIS_VM_SWAPPED
;
7578 key
->vtype
= j
->val
->type
;
7579 decrRefCount(val
); /* Deallocate the object from memory. */
7580 dictGetEntryVal(de
) = NULL
;
7581 redisLog(REDIS_DEBUG
,
7582 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
7583 (unsigned char*) key
->ptr
,
7584 (unsigned long long) j
->page
, (unsigned long long) j
->pages
);
7585 server
.vm_stats_swapped_objects
++;
7586 server
.vm_stats_swapouts
++;
7588 /* Put a few more swap requests in queue if we are still
7590 if (vmCanSwapOut() && zmalloc_used_memory() > server
.vm_max_memory
){
7594 more
= listLength(server
.io_newjobs
) <
7595 (unsigned) server
.vm_max_threads
;
7597 /* Don't waste CPU time if swappable objects are rare. */
7598 if (vmSwapOneObjectThreaded() == REDIS_ERR
) break;
7603 if (processed
== REDIS_MAX_COMPLETED_JOBS_PROCESSED
) return;
7605 if (retval
< 0 && errno
!= EAGAIN
) {
7606 redisLog(REDIS_WARNING
,
7607 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
7612 static void lockThreadedIO(void) {
7613 pthread_mutex_lock(&server
.io_mutex
);
7616 static void unlockThreadedIO(void) {
7617 pthread_mutex_unlock(&server
.io_mutex
);
7620 /* Remove the specified object from the threaded I/O queue if still not
7621 * processed, otherwise make sure to flag it as canceled. */
7622 static void vmCancelThreadedIOJob(robj
*o
) {
7624 server
.io_newjobs
, /* 0 */
7625 server
.io_processing
, /* 1 */
7626 server
.io_processed
/* 2 */
7630 assert(o
->storage
== REDIS_VM_LOADING
|| o
->storage
== REDIS_VM_SWAPPING
);
7633 /* Search for a matching key in one of the queues */
7634 for (i
= 0; i
< 3; i
++) {
7638 listRewind(lists
[i
],&li
);
7639 while ((ln
= listNext(&li
)) != NULL
) {
7640 iojob
*job
= ln
->value
;
7642 if (job
->canceled
) continue; /* Skip this, already canceled. */
7643 if (compareStringObjects(job
->key
,o
) == 0) {
7644 redisLog(REDIS_DEBUG
,"*** CANCELED %p (%s) (LIST ID %d)\n",
7645 (void*)job
, (char*)o
->ptr
, i
);
7646 /* Mark the pages as free since the swap didn't happened
7647 * or happened but is now discarded. */
7648 if (job
->type
== REDIS_IOJOB_DO_SWAP
)
7649 vmMarkPagesFree(job
->page
,job
->pages
);
7650 /* Cancel the job. It depends on the list the job is
7653 case 0: /* io_newjobs */
7654 /* If the job was yet not processed the best thing to do
7655 * is to remove it from the queue at all */
7657 listDelNode(lists
[i
],ln
);
7659 case 1: /* io_processing */
7660 /* Oh Shi- the thread is messing with the Job, and
7661 * probably with the object if this is a
7662 * PREPARE_SWAP or DO_SWAP job. Better to wait for the
7663 * job to move into the next queue... */
7664 if (job
->type
!= REDIS_IOJOB_LOAD
) {
7665 /* Yes, we try again and again until the job
7668 /* But let's wait some time for the I/O thread
7669 * to finish with this job. After all this condition
7670 * should be very rare. */
7677 case 2: /* io_processed */
7678 /* The job was already processed, that's easy...
7679 * just mark it as canceled so that we'll ignore it
7680 * when processing completed jobs. */
7684 /* Finally we have to adjust the storage type of the object
7685 * in order to "UNDO" the operaiton. */
7686 if (o
->storage
== REDIS_VM_LOADING
)
7687 o
->storage
= REDIS_VM_SWAPPED
;
7688 else if (o
->storage
== REDIS_VM_SWAPPING
)
7689 o
->storage
= REDIS_VM_MEMORY
;
7696 assert(1 != 1); /* We should never reach this */
7699 static void *IOThreadEntryPoint(void *arg
) {
7704 pthread_detach(pthread_self());
7706 /* Get a new job to process */
7708 if (listLength(server
.io_newjobs
) == 0) {
7709 #ifdef REDIS_HELGRIND_FRIENDLY
7710 /* No new jobs? Wait and retry, because to be Helgrind
7711 * (valgrind --tool=helgrind) what's needed is to take
7712 * the same threads running instead to create/destroy threads
7713 * as needed (otherwise valgrind will fail) */
7715 usleep(1); /* Give some time for the I/O thread to work. */
7718 /* No new jobs in queue, exit. */
7719 redisLog(REDIS_DEBUG
,"Thread %lld exiting, nothing to do",
7720 (long long) pthread_self());
7721 server
.io_active_threads
--;
7725 ln
= listFirst(server
.io_newjobs
);
7727 listDelNode(server
.io_newjobs
,ln
);
7728 /* Add the job in the processing queue */
7729 j
->thread
= pthread_self();
7730 listAddNodeTail(server
.io_processing
,j
);
7731 ln
= listLast(server
.io_processing
); /* We use ln later to remove it */
7733 redisLog(REDIS_DEBUG
,"Thread %lld got a new job (type %d): %p about key '%s'",
7734 (long long) pthread_self(), j
->type
, (void*)j
, (char*)j
->key
->ptr
);
7736 /* Process the Job */
7737 if (j
->type
== REDIS_IOJOB_LOAD
) {
7738 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
7739 FILE *fp
= fopen("/dev/null","w+");
7740 j
->pages
= rdbSavedObjectPages(j
->val
,fp
);
7742 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
7743 if (vmWriteObjectOnSwap(j
->val
,j
->page
) == REDIS_ERR
)
7747 /* Done: insert the job into the processed queue */
7748 redisLog(REDIS_DEBUG
,"Thread %lld completed the job: %p (key %s)",
7749 (long long) pthread_self(), (void*)j
, (char*)j
->key
->ptr
);
7751 listDelNode(server
.io_processing
,ln
);
7752 listAddNodeTail(server
.io_processed
,j
);
7755 /* Signal the main thread there is new stuff to process */
7756 assert(write(server
.io_ready_pipe_write
,"x",1) == 1);
7758 return NULL
; /* never reached */
7761 static void spawnIOThread(void) {
7764 pthread_create(&thread
,&server
.io_threads_attr
,IOThreadEntryPoint
,NULL
);
7765 server
.io_active_threads
++;
7768 /* We need to wait for the last thread to exit before we are able to
7769 * fork() in order to BGSAVE or BGREWRITEAOF. */
7770 static void waitEmptyIOJobsQueue(void) {
7773 if (listLength(server
.io_newjobs
) == 0 &&
7774 listLength(server
.io_processing
) == 0 &&
7775 server
.io_active_threads
== 0)
7781 usleep(10000); /* 10 milliseconds */
7785 static void vmReopenSwapFile(void) {
7786 fclose(server
.vm_fp
);
7787 server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b");
7788 if (server
.vm_fp
== NULL
) {
7789 redisLog(REDIS_WARNING
,"Can't re-open the VM swap file: %s. Exiting.",
7790 server
.vm_swap_file
);
7793 server
.vm_fd
= fileno(server
.vm_fp
);
7796 /* This function must be called while with threaded IO locked */
7797 static void queueIOJob(iojob
*j
) {
7798 redisLog(REDIS_DEBUG
,"Queued IO Job %p type %d about key '%s'\n",
7799 (void*)j
, j
->type
, (char*)j
->key
->ptr
);
7800 listAddNodeTail(server
.io_newjobs
,j
);
7801 if (server
.io_active_threads
< server
.vm_max_threads
)
7805 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
) {
7808 assert(key
->storage
== REDIS_VM_MEMORY
);
7809 assert(key
->refcount
== 1);
7811 j
= zmalloc(sizeof(*j
));
7812 j
->type
= REDIS_IOJOB_PREPARE_SWAP
;
7814 j
->key
= dupStringObject(key
);
7818 j
->thread
= (pthread_t
) -1;
7819 key
->storage
= REDIS_VM_SWAPPING
;
7827 /* ================================= Debugging ============================== */
7829 static void debugCommand(redisClient
*c
) {
7830 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
7832 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
7833 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
7834 addReply(c
,shared
.err
);
7838 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
7839 addReply(c
,shared
.err
);
7842 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
7843 addReply(c
,shared
.ok
);
7844 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
7846 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
7847 addReply(c
,shared
.err
);
7850 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
7851 addReply(c
,shared
.ok
);
7852 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
7853 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
7857 addReply(c
,shared
.nokeyerr
);
7860 key
= dictGetEntryKey(de
);
7861 val
= dictGetEntryVal(de
);
7862 if (server
.vm_enabled
&& (key
->storage
== REDIS_VM_MEMORY
||
7863 key
->storage
== REDIS_VM_SWAPPING
)) {
7864 addReplySds(c
,sdscatprintf(sdsempty(),
7865 "+Key at:%p refcount:%d, value at:%p refcount:%d "
7866 "encoding:%d serializedlength:%lld\r\n",
7867 (void*)key
, key
->refcount
, (void*)val
, val
->refcount
,
7868 val
->encoding
, rdbSavedObjectLen(val
,NULL
)));
7870 addReplySds(c
,sdscatprintf(sdsempty(),
7871 "+Key at:%p refcount:%d, value swapped at: page %llu "
7872 "using %llu pages\r\n",
7873 (void*)key
, key
->refcount
, (unsigned long long) key
->vm
.page
,
7874 (unsigned long long) key
->vm
.usedpages
));
7876 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
7877 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
7880 if (!server
.vm_enabled
) {
7881 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
7885 addReply(c
,shared
.nokeyerr
);
7888 key
= dictGetEntryKey(de
);
7889 val
= dictGetEntryVal(de
);
7890 /* If the key is shared we want to create a copy */
7891 if (key
->refcount
> 1) {
7892 robj
*newkey
= dupStringObject(key
);
7894 key
= dictGetEntryKey(de
) = newkey
;
7897 if (key
->storage
!= REDIS_VM_MEMORY
) {
7898 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
7899 } else if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
7900 dictGetEntryVal(de
) = NULL
;
7901 addReply(c
,shared
.ok
);
7903 addReply(c
,shared
.err
);
7906 addReplySds(c
,sdsnew(
7907 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPOUT <key>|RELOAD]\r\n"));
7911 static void _redisAssert(char *estr
, char *file
, int line
) {
7912 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
7913 redisLog(REDIS_WARNING
,"==> %s:%d '%s' is not true\n",file
,line
,estr
);
7914 #ifdef HAVE_BACKTRACE
7915 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
7920 /* =================================== Main! ================================ */
7923 int linuxOvercommitMemoryValue(void) {
7924 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
7928 if (fgets(buf
,64,fp
) == NULL
) {
7937 void linuxOvercommitMemoryWarning(void) {
7938 if (linuxOvercommitMemoryValue() == 0) {
7939 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.");
7942 #endif /* __linux__ */
7944 static void daemonize(void) {
7948 if (fork() != 0) exit(0); /* parent exits */
7949 setsid(); /* create a new session */
7951 /* Every output goes to /dev/null. If Redis is daemonized but
7952 * the 'logfile' is set to 'stdout' in the configuration file
7953 * it will not log at all. */
7954 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
7955 dup2(fd
, STDIN_FILENO
);
7956 dup2(fd
, STDOUT_FILENO
);
7957 dup2(fd
, STDERR_FILENO
);
7958 if (fd
> STDERR_FILENO
) close(fd
);
7960 /* Try to write the pid file */
7961 fp
= fopen(server
.pidfile
,"w");
7963 fprintf(fp
,"%d\n",getpid());
7968 int main(int argc
, char **argv
) {
7971 resetServerSaveParams();
7972 loadServerConfig(argv
[1]);
7973 } else if (argc
> 2) {
7974 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
7977 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'");
7979 if (server
.daemonize
) daemonize();
7981 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
7983 linuxOvercommitMemoryWarning();
7985 if (server
.appendonly
) {
7986 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
7987 redisLog(REDIS_NOTICE
,"DB loaded from append only file");
7989 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
7990 redisLog(REDIS_NOTICE
,"DB loaded from disk");
7992 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
7994 aeDeleteEventLoop(server
.el
);
7998 /* ============================= Backtrace support ========================= */
8000 #ifdef HAVE_BACKTRACE
8001 static char *findFuncName(void *pointer
, unsigned long *offset
);
8003 static void *getMcontextEip(ucontext_t
*uc
) {
8004 #if defined(__FreeBSD__)
8005 return (void*) uc
->uc_mcontext
.mc_eip
;
8006 #elif defined(__dietlibc__)
8007 return (void*) uc
->uc_mcontext
.eip
;
8008 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
8010 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
8012 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
8014 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
8015 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
8016 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
8018 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
8020 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
8021 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
8022 #elif defined(__ia64__) /* Linux IA64 */
8023 return (void*) uc
->uc_mcontext
.sc_ip
;
8029 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
8031 char **messages
= NULL
;
8032 int i
, trace_size
= 0;
8033 unsigned long offset
=0;
8034 ucontext_t
*uc
= (ucontext_t
*) secret
;
8036 REDIS_NOTUSED(info
);
8038 redisLog(REDIS_WARNING
,
8039 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
8040 infostring
= genRedisInfoString();
8041 redisLog(REDIS_WARNING
, "%s",infostring
);
8042 /* It's not safe to sdsfree() the returned string under memory
8043 * corruption conditions. Let it leak as we are going to abort */
8045 trace_size
= backtrace(trace
, 100);
8046 /* overwrite sigaction with caller's address */
8047 if (getMcontextEip(uc
) != NULL
) {
8048 trace
[1] = getMcontextEip(uc
);
8050 messages
= backtrace_symbols(trace
, trace_size
);
8052 for (i
=1; i
<trace_size
; ++i
) {
8053 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
8055 p
= strchr(messages
[i
],'+');
8056 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
8057 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
8059 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
8062 /* free(messages); Don't call free() with possibly corrupted memory. */
8066 static void setupSigSegvAction(void) {
8067 struct sigaction act
;
8069 sigemptyset (&act
.sa_mask
);
8070 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
8071 * is used. Otherwise, sa_handler is used */
8072 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
8073 act
.sa_sigaction
= segvHandler
;
8074 sigaction (SIGSEGV
, &act
, NULL
);
8075 sigaction (SIGBUS
, &act
, NULL
);
8076 sigaction (SIGFPE
, &act
, NULL
);
8077 sigaction (SIGILL
, &act
, NULL
);
8078 sigaction (SIGBUS
, &act
, NULL
);
8082 #include "staticsymbols.h"
8083 /* This function try to convert a pointer into a function name. It's used in
8084 * oreder to provide a backtrace under segmentation fault that's able to
8085 * display functions declared as static (otherwise the backtrace is useless). */
8086 static char *findFuncName(void *pointer
, unsigned long *offset
){
8088 unsigned long off
, minoff
= 0;
8090 /* Try to match against the Symbol with the smallest offset */
8091 for (i
=0; symsTable
[i
].pointer
; i
++) {
8092 unsigned long lp
= (unsigned long) pointer
;
8094 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
8095 off
=lp
-symsTable
[i
].pointer
;
8096 if (ret
< 0 || off
< minoff
) {
8102 if (ret
== -1) return NULL
;
8104 return symsTable
[ret
].name
;
8106 #else /* HAVE_BACKTRACE */
8107 static void setupSigSegvAction(void) {
8109 #endif /* HAVE_BACKTRACE */