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 */
82 /* Static server configuration */
83 #define REDIS_SERVERPORT 6379 /* TCP port */
84 #define REDIS_MAXIDLETIME (60*5) /* default client timeout */
85 #define REDIS_IOBUF_LEN 1024
86 #define REDIS_LOADBUF_LEN 1024
87 #define REDIS_STATIC_ARGS 4
88 #define REDIS_DEFAULT_DBNUM 16
89 #define REDIS_CONFIGLINE_MAX 1024
90 #define REDIS_OBJFREELIST_MAX 1000000 /* Max number of objects to cache */
91 #define REDIS_MAX_SYNC_TIME 60 /* Slave can't take more to sync */
92 #define REDIS_EXPIRELOOKUPS_PER_CRON 100 /* try to expire 100 keys/second */
93 #define REDIS_MAX_WRITE_PER_EVENT (1024*64)
94 #define REDIS_REQUEST_MAX_SIZE (1024*1024*256) /* max bytes in inline command */
96 /* If more then REDIS_WRITEV_THRESHOLD write packets are pending use writev */
97 #define REDIS_WRITEV_THRESHOLD 3
98 /* Max number of iovecs used for each writev call */
99 #define REDIS_WRITEV_IOVEC_COUNT 256
101 /* Hash table parameters */
102 #define REDIS_HT_MINFILL 10 /* Minimal hash table fill 10% */
105 #define REDIS_CMD_BULK 1 /* Bulk write command */
106 #define REDIS_CMD_INLINE 2 /* Inline command */
107 /* REDIS_CMD_DENYOOM reserves a longer comment: all the commands marked with
108 this flags will return an error when the 'maxmemory' option is set in the
109 config file and the server is using more than maxmemory bytes of memory.
110 In short this commands are denied on low memory conditions. */
111 #define REDIS_CMD_DENYOOM 4
114 #define REDIS_STRING 0
120 /* Objects encoding */
121 #define REDIS_ENCODING_RAW 0 /* Raw representation */
122 #define REDIS_ENCODING_INT 1 /* Encoded as integer */
124 /* Object types only used for dumping to disk */
125 #define REDIS_EXPIRETIME 253
126 #define REDIS_SELECTDB 254
127 #define REDIS_EOF 255
129 /* Defines related to the dump file format. To store 32 bits lengths for short
130 * keys requires a lot of space, so we check the most significant 2 bits of
131 * the first byte to interpreter the length:
133 * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
134 * 01|000000 00000000 => 01, the len is 14 byes, 6 bits + 8 bits of next byte
135 * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
136 * 11|000000 this means: specially encoded object will follow. The six bits
137 * number specify the kind of object that follows.
138 * See the REDIS_RDB_ENC_* defines.
140 * Lenghts up to 63 are stored using a single byte, most DB keys, and may
141 * values, will fit inside. */
142 #define REDIS_RDB_6BITLEN 0
143 #define REDIS_RDB_14BITLEN 1
144 #define REDIS_RDB_32BITLEN 2
145 #define REDIS_RDB_ENCVAL 3
146 #define REDIS_RDB_LENERR UINT_MAX
148 /* When a length of a string object stored on disk has the first two bits
149 * set, the remaining two bits specify a special encoding for the object
150 * accordingly to the following defines: */
151 #define REDIS_RDB_ENC_INT8 0 /* 8 bit signed integer */
152 #define REDIS_RDB_ENC_INT16 1 /* 16 bit signed integer */
153 #define REDIS_RDB_ENC_INT32 2 /* 32 bit signed integer */
154 #define REDIS_RDB_ENC_LZF 3 /* string compressed with FASTLZ */
156 /* Virtual memory object->where field. */
157 #define REDIS_VM_MEMORY 0 /* The object is on memory */
158 #define REDIS_VM_SWAPPED 1 /* The object is on disk */
159 #define REDIS_VM_SWAPPING 2 /* Redis is swapping this object on disk */
160 #define REDIS_VM_LOADING 3 /* Redis is loading this object from disk */
162 /* Virtual memory static configuration stuff.
163 * Check vmFindContiguousPages() to know more about this magic numbers. */
164 #define REDIS_VM_MAX_NEAR_PAGES 65536
165 #define REDIS_VM_MAX_RANDOM_JUMP 4096
166 #define REDIS_VM_MAX_THREADS 32
167 /* The following is the number of completed I/O jobs to process when the
168 * handelr is called. 1 is the minimum, and also the default, as it allows
169 * to block as little as possible other accessing clients. While Virtual
170 * Memory I/O operations are performed by threads, this operations must
171 * be processed by the main thread when completed to take effect. */
172 #define REDIS_MAX_COMPLETED_JOBS_PROCESSED 1
175 #define REDIS_CLOSE 1 /* This client connection should be closed ASAP */
176 #define REDIS_SLAVE 2 /* This client is a slave server */
177 #define REDIS_MASTER 4 /* This client is a master server */
178 #define REDIS_MONITOR 8 /* This client is a slave monitor, see MONITOR */
179 #define REDIS_MULTI 16 /* This client is in a MULTI context */
180 #define REDIS_BLOCKED 32 /* The client is waiting in a blocking operation */
181 #define REDIS_IO_WAIT 64 /* The client is waiting for Virtual Memory I/O */
183 /* Slave replication state - slave side */
184 #define REDIS_REPL_NONE 0 /* No active replication */
185 #define REDIS_REPL_CONNECT 1 /* Must connect to master */
186 #define REDIS_REPL_CONNECTED 2 /* Connected to master */
188 /* Slave replication state - from the point of view of master
189 * Note that in SEND_BULK and ONLINE state the slave receives new updates
190 * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
191 * to start the next background saving in order to send updates to it. */
192 #define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
193 #define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
194 #define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
195 #define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */
197 /* List related stuff */
201 /* Sort operations */
202 #define REDIS_SORT_GET 0
203 #define REDIS_SORT_ASC 1
204 #define REDIS_SORT_DESC 2
205 #define REDIS_SORTKEY_MAX 1024
208 #define REDIS_DEBUG 0
209 #define REDIS_VERBOSE 1
210 #define REDIS_NOTICE 2
211 #define REDIS_WARNING 3
213 /* Anti-warning macro... */
214 #define REDIS_NOTUSED(V) ((void) V)
216 #define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
217 #define ZSKIPLIST_P 0.25 /* Skiplist P = 1/4 */
219 /* Append only defines */
220 #define APPENDFSYNC_NO 0
221 #define APPENDFSYNC_ALWAYS 1
222 #define APPENDFSYNC_EVERYSEC 2
224 /* We can print the stacktrace, so our assert is defined this way: */
225 #define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),exit(1)))
226 static void _redisAssert(char *estr
, char *file
, int line
);
228 /*================================= Data types ============================== */
230 /* A redis object, that is a type able to hold a string / list / set */
232 /* The VM object structure */
233 struct redisObjectVM
{
234 off_t page
; /* the page at witch the object is stored on disk */
235 off_t usedpages
; /* number of pages used on disk */
236 time_t atime
; /* Last access time */
239 /* The actual Redis Object */
240 typedef struct redisObject
{
243 unsigned char encoding
;
244 unsigned char storage
; /* If this object is a key, where is the value?
245 * REDIS_VM_MEMORY, REDIS_VM_SWAPPED, ... */
246 unsigned char vtype
; /* If this object is a key, and value is swapped out,
247 * this is the type of the swapped out object. */
249 /* VM fields, this are only allocated if VM is active, otherwise the
250 * object allocation function will just allocate
251 * sizeof(redisObjct) minus sizeof(redisObjectVM), so using
252 * Redis without VM active will not have any overhead. */
253 struct redisObjectVM vm
;
256 /* Macro used to initalize a Redis object allocated on the stack.
257 * Note that this macro is taken near the structure definition to make sure
258 * we'll update it when the structure is changed, to avoid bugs like
259 * bug #85 introduced exactly in this way. */
260 #define initStaticStringObject(_var,_ptr) do { \
262 _var.type = REDIS_STRING; \
263 _var.encoding = REDIS_ENCODING_RAW; \
265 if (server.vm_enabled) _var.storage = REDIS_VM_MEMORY; \
268 typedef struct redisDb
{
269 dict
*dict
; /* The keyspace for this DB */
270 dict
*expires
; /* Timeout of keys with a timeout set */
271 dict
*blockingkeys
; /* Keys with clients waiting for data (BLPOP) */
275 /* Client MULTI/EXEC state */
276 typedef struct multiCmd
{
279 struct redisCommand
*cmd
;
282 typedef struct multiState
{
283 multiCmd
*commands
; /* Array of MULTI commands */
284 int count
; /* Total number of MULTI commands */
287 /* With multiplexing we need to take per-clinet state.
288 * Clients are taken in a liked list. */
289 typedef struct redisClient
{
294 robj
**argv
, **mbargv
;
296 int bulklen
; /* bulk read len. -1 if not in bulk read mode */
297 int multibulk
; /* multi bulk command format active */
300 time_t lastinteraction
; /* time of the last interaction, used for timeout */
301 int flags
; /* REDIS_CLOSE | REDIS_SLAVE | REDIS_MONITOR */
303 int slaveseldb
; /* slave selected db, if this client is a slave */
304 int authenticated
; /* when requirepass is non-NULL */
305 int replstate
; /* replication state if this is a slave */
306 int repldbfd
; /* replication DB file descriptor */
307 long repldboff
; /* replication DB file offset */
308 off_t repldbsize
; /* replication DB file size */
309 multiState mstate
; /* MULTI/EXEC state */
310 robj
**blockingkeys
; /* The key we waiting to terminate a blocking
311 * operation such as BLPOP. Otherwise NULL. */
312 int blockingkeysnum
; /* Number of blocking keys */
313 time_t blockingto
; /* Blocking operation timeout. If UNIX current time
314 * is >= blockingto then the operation timed out. */
315 list
*io_keys
; /* Keys this client is waiting to be loaded from the
316 * swap file in order to continue. */
324 /* Global server state structure */
329 dict
*sharingpool
; /* Poll used for object sharing */
330 unsigned int sharingpoolsize
;
331 long long dirty
; /* changes to DB from the last save */
333 list
*slaves
, *monitors
;
334 char neterr
[ANET_ERR_LEN
];
336 int cronloops
; /* number of times the cron function run */
337 list
*objfreelist
; /* A list of freed objects to avoid malloc() */
338 time_t lastsave
; /* Unix time of last save succeeede */
339 size_t usedmemory
; /* Used memory in megabytes */
340 /* Fields used only for stats */
341 time_t stat_starttime
; /* server start time */
342 long long stat_numcommands
; /* number of processed commands */
343 long long stat_numconnections
; /* number of connections received */
356 pid_t bgsavechildpid
;
357 pid_t bgrewritechildpid
;
358 sds bgrewritebuf
; /* buffer taken by parent during oppend only rewrite */
359 struct saveparam
*saveparams
;
364 char *appendfilename
;
368 /* Replication related */
373 redisClient
*master
; /* client that is master for this slave */
375 unsigned int maxclients
;
376 unsigned long long maxmemory
;
377 unsigned int blockedclients
;
378 /* Sort parameters - qsort_r() is only available under BSD so we
379 * have to take this state global, in order to pass it to sortCompare() */
383 /* Virtual memory configuration */
387 unsigned long long vm_max_memory
;
388 /* Virtual memory state */
391 off_t vm_next_page
; /* Next probably empty page */
392 off_t vm_near_pages
; /* Number of pages allocated sequentially */
393 unsigned char *vm_bitmap
; /* Bitmap of free/used pages */
394 time_t unixtime
; /* Unix time sampled every second. */
395 /* Virtual memory I/O threads stuff */
396 /* An I/O thread process an element taken from the io_jobs queue and
397 * put the result of the operation in the io_done list. While the
398 * job is being processed, it's put on io_processing queue. */
399 list
*io_newjobs
; /* List of VM I/O jobs yet to be processed */
400 list
*io_processing
; /* List of VM I/O jobs being processed */
401 list
*io_processed
; /* List of VM I/O jobs already processed */
402 list
*io_clients
; /* All the clients waiting for SWAP I/O operations */
403 pthread_mutex_t io_mutex
; /* lock to access io_jobs/io_done/io_thread_job */
404 pthread_mutex_t obj_freelist_mutex
; /* safe redis objects creation/free */
405 pthread_mutex_t io_swapfile_mutex
; /* So we can lseek + write */
406 int io_active_threads
; /* Number of running I/O threads */
407 int vm_max_threads
; /* Max number of I/O threads running at the same time */
408 /* Our main thread is blocked on the event loop, locking for sockets ready
409 * to be read or written, so when a threaded I/O operation is ready to be
410 * processed by the main thread, the I/O thread will use a unix pipe to
411 * awake the main thread. The followings are the two pipe FDs. */
412 int io_ready_pipe_read
;
413 int io_ready_pipe_write
;
414 /* Virtual memory stats */
415 unsigned long long vm_stats_used_pages
;
416 unsigned long long vm_stats_swapped_objects
;
417 unsigned long long vm_stats_swapouts
;
418 unsigned long long vm_stats_swapins
;
422 typedef void redisCommandProc(redisClient
*c
);
423 struct redisCommand
{
425 redisCommandProc
*proc
;
430 struct redisFunctionSym
{
432 unsigned long pointer
;
435 typedef struct _redisSortObject
{
443 typedef struct _redisSortOperation
{
446 } redisSortOperation
;
448 /* ZSETs use a specialized version of Skiplists */
450 typedef struct zskiplistNode
{
451 struct zskiplistNode
**forward
;
452 struct zskiplistNode
*backward
;
457 typedef struct zskiplist
{
458 struct zskiplistNode
*header
, *tail
;
459 unsigned long length
;
463 typedef struct zset
{
468 /* Our shared "common" objects */
470 struct sharedObjectsStruct
{
471 robj
*crlf
, *ok
, *err
, *emptybulk
, *czero
, *cone
, *pong
, *space
,
472 *colon
, *nullbulk
, *nullmultibulk
, *queued
,
473 *emptymultibulk
, *wrongtypeerr
, *nokeyerr
, *syntaxerr
, *sameobjecterr
,
474 *outofrangeerr
, *plus
,
475 *select0
, *select1
, *select2
, *select3
, *select4
,
476 *select5
, *select6
, *select7
, *select8
, *select9
;
479 /* Global vars that are actally used as constants. The following double
480 * values are used for double on-disk serialization, and are initialized
481 * at runtime to avoid strange compiler optimizations. */
483 static double R_Zero
, R_PosInf
, R_NegInf
, R_Nan
;
485 /* VM threaded I/O request message */
486 #define REDIS_IOJOB_LOAD 0 /* Load from disk to memory */
487 #define REDIS_IOJOB_PREPARE_SWAP 1 /* Compute needed pages */
488 #define REDIS_IOJOB_DO_SWAP 2 /* Swap from memory to disk */
489 typedef struct iojon
{
490 int type
; /* Request type, REDIS_IOJOB_* */
491 redisDb
*db
;/* Redis database */
492 robj
*key
; /* This I/O request is about swapping this key */
493 robj
*val
; /* the value to swap for REDIS_IOREQ_*_SWAP, otherwise this
494 * field is populated by the I/O thread for REDIS_IOREQ_LOAD. */
495 off_t page
; /* Swap page where to read/write the object */
496 off_t pages
; /* Swap pages needed to safe object. PREPARE_SWAP return val */
497 int canceled
; /* True if this command was canceled by blocking side of VM */
498 pthread_t thread
; /* ID of the thread processing this entry */
501 /*================================ Prototypes =============================== */
503 static void freeStringObject(robj
*o
);
504 static void freeListObject(robj
*o
);
505 static void freeSetObject(robj
*o
);
506 static void decrRefCount(void *o
);
507 static robj
*createObject(int type
, void *ptr
);
508 static void freeClient(redisClient
*c
);
509 static int rdbLoad(char *filename
);
510 static void addReply(redisClient
*c
, robj
*obj
);
511 static void addReplySds(redisClient
*c
, sds s
);
512 static void incrRefCount(robj
*o
);
513 static int rdbSaveBackground(char *filename
);
514 static robj
*createStringObject(char *ptr
, size_t len
);
515 static robj
*dupStringObject(robj
*o
);
516 static void replicationFeedSlaves(list
*slaves
, struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
517 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
518 static int syncWithMaster(void);
519 static robj
*tryObjectSharing(robj
*o
);
520 static int tryObjectEncoding(robj
*o
);
521 static robj
*getDecodedObject(robj
*o
);
522 static int removeExpire(redisDb
*db
, robj
*key
);
523 static int expireIfNeeded(redisDb
*db
, robj
*key
);
524 static int deleteIfVolatile(redisDb
*db
, robj
*key
);
525 static int deleteIfSwapped(redisDb
*db
, robj
*key
);
526 static int deleteKey(redisDb
*db
, robj
*key
);
527 static time_t getExpire(redisDb
*db
, robj
*key
);
528 static int setExpire(redisDb
*db
, robj
*key
, time_t when
);
529 static void updateSlavesWaitingBgsave(int bgsaveerr
);
530 static void freeMemoryIfNeeded(void);
531 static int processCommand(redisClient
*c
);
532 static void setupSigSegvAction(void);
533 static void rdbRemoveTempFile(pid_t childpid
);
534 static void aofRemoveTempFile(pid_t childpid
);
535 static size_t stringObjectLen(robj
*o
);
536 static void processInputBuffer(redisClient
*c
);
537 static zskiplist
*zslCreate(void);
538 static void zslFree(zskiplist
*zsl
);
539 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
);
540 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
541 static void initClientMultiState(redisClient
*c
);
542 static void freeClientMultiState(redisClient
*c
);
543 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
);
544 static void unblockClient(redisClient
*c
);
545 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
);
546 static void vmInit(void);
547 static void vmMarkPagesFree(off_t page
, off_t count
);
548 static robj
*vmLoadObject(robj
*key
);
549 static robj
*vmPreviewObject(robj
*key
);
550 static int vmSwapOneObjectBlocking(void);
551 static int vmSwapOneObjectThreaded(void);
552 static int vmCanSwapOut(void);
553 static int tryFreeOneObjectFromFreelist(void);
554 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
555 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
556 static void vmCancelThreadedIOJob(robj
*o
);
557 static void lockThreadedIO(void);
558 static void unlockThreadedIO(void);
559 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
);
560 static void freeIOJob(iojob
*j
);
561 static void queueIOJob(iojob
*j
);
562 static int vmWriteObjectOnSwap(robj
*o
, off_t page
);
563 static robj
*vmReadObjectFromSwap(off_t page
, int type
);
564 static void waitZeroActiveThreads(void);
566 static void authCommand(redisClient
*c
);
567 static void pingCommand(redisClient
*c
);
568 static void echoCommand(redisClient
*c
);
569 static void setCommand(redisClient
*c
);
570 static void setnxCommand(redisClient
*c
);
571 static void getCommand(redisClient
*c
);
572 static void delCommand(redisClient
*c
);
573 static void existsCommand(redisClient
*c
);
574 static void incrCommand(redisClient
*c
);
575 static void decrCommand(redisClient
*c
);
576 static void incrbyCommand(redisClient
*c
);
577 static void decrbyCommand(redisClient
*c
);
578 static void selectCommand(redisClient
*c
);
579 static void randomkeyCommand(redisClient
*c
);
580 static void keysCommand(redisClient
*c
);
581 static void dbsizeCommand(redisClient
*c
);
582 static void lastsaveCommand(redisClient
*c
);
583 static void saveCommand(redisClient
*c
);
584 static void bgsaveCommand(redisClient
*c
);
585 static void bgrewriteaofCommand(redisClient
*c
);
586 static void shutdownCommand(redisClient
*c
);
587 static void moveCommand(redisClient
*c
);
588 static void renameCommand(redisClient
*c
);
589 static void renamenxCommand(redisClient
*c
);
590 static void lpushCommand(redisClient
*c
);
591 static void rpushCommand(redisClient
*c
);
592 static void lpopCommand(redisClient
*c
);
593 static void rpopCommand(redisClient
*c
);
594 static void llenCommand(redisClient
*c
);
595 static void lindexCommand(redisClient
*c
);
596 static void lrangeCommand(redisClient
*c
);
597 static void ltrimCommand(redisClient
*c
);
598 static void typeCommand(redisClient
*c
);
599 static void lsetCommand(redisClient
*c
);
600 static void saddCommand(redisClient
*c
);
601 static void sremCommand(redisClient
*c
);
602 static void smoveCommand(redisClient
*c
);
603 static void sismemberCommand(redisClient
*c
);
604 static void scardCommand(redisClient
*c
);
605 static void spopCommand(redisClient
*c
);
606 static void srandmemberCommand(redisClient
*c
);
607 static void sinterCommand(redisClient
*c
);
608 static void sinterstoreCommand(redisClient
*c
);
609 static void sunionCommand(redisClient
*c
);
610 static void sunionstoreCommand(redisClient
*c
);
611 static void sdiffCommand(redisClient
*c
);
612 static void sdiffstoreCommand(redisClient
*c
);
613 static void syncCommand(redisClient
*c
);
614 static void flushdbCommand(redisClient
*c
);
615 static void flushallCommand(redisClient
*c
);
616 static void sortCommand(redisClient
*c
);
617 static void lremCommand(redisClient
*c
);
618 static void rpoplpushcommand(redisClient
*c
);
619 static void infoCommand(redisClient
*c
);
620 static void mgetCommand(redisClient
*c
);
621 static void monitorCommand(redisClient
*c
);
622 static void expireCommand(redisClient
*c
);
623 static void expireatCommand(redisClient
*c
);
624 static void getsetCommand(redisClient
*c
);
625 static void ttlCommand(redisClient
*c
);
626 static void slaveofCommand(redisClient
*c
);
627 static void debugCommand(redisClient
*c
);
628 static void msetCommand(redisClient
*c
);
629 static void msetnxCommand(redisClient
*c
);
630 static void zaddCommand(redisClient
*c
);
631 static void zincrbyCommand(redisClient
*c
);
632 static void zrangeCommand(redisClient
*c
);
633 static void zrangebyscoreCommand(redisClient
*c
);
634 static void zrevrangeCommand(redisClient
*c
);
635 static void zcardCommand(redisClient
*c
);
636 static void zremCommand(redisClient
*c
);
637 static void zscoreCommand(redisClient
*c
);
638 static void zremrangebyscoreCommand(redisClient
*c
);
639 static void multiCommand(redisClient
*c
);
640 static void execCommand(redisClient
*c
);
641 static void blpopCommand(redisClient
*c
);
642 static void brpopCommand(redisClient
*c
);
644 /*================================= Globals ================================= */
647 static struct redisServer server
; /* server global state */
648 static struct redisCommand cmdTable
[] = {
649 {"get",getCommand
,2,REDIS_CMD_INLINE
},
650 {"set",setCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
651 {"setnx",setnxCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
652 {"del",delCommand
,-2,REDIS_CMD_INLINE
},
653 {"exists",existsCommand
,2,REDIS_CMD_INLINE
},
654 {"incr",incrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
655 {"decr",decrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
656 {"mget",mgetCommand
,-2,REDIS_CMD_INLINE
},
657 {"rpush",rpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
658 {"lpush",lpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
659 {"rpop",rpopCommand
,2,REDIS_CMD_INLINE
},
660 {"lpop",lpopCommand
,2,REDIS_CMD_INLINE
},
661 {"brpop",brpopCommand
,-3,REDIS_CMD_INLINE
},
662 {"blpop",blpopCommand
,-3,REDIS_CMD_INLINE
},
663 {"llen",llenCommand
,2,REDIS_CMD_INLINE
},
664 {"lindex",lindexCommand
,3,REDIS_CMD_INLINE
},
665 {"lset",lsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
666 {"lrange",lrangeCommand
,4,REDIS_CMD_INLINE
},
667 {"ltrim",ltrimCommand
,4,REDIS_CMD_INLINE
},
668 {"lrem",lremCommand
,4,REDIS_CMD_BULK
},
669 {"rpoplpush",rpoplpushcommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
670 {"sadd",saddCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
671 {"srem",sremCommand
,3,REDIS_CMD_BULK
},
672 {"smove",smoveCommand
,4,REDIS_CMD_BULK
},
673 {"sismember",sismemberCommand
,3,REDIS_CMD_BULK
},
674 {"scard",scardCommand
,2,REDIS_CMD_INLINE
},
675 {"spop",spopCommand
,2,REDIS_CMD_INLINE
},
676 {"srandmember",srandmemberCommand
,2,REDIS_CMD_INLINE
},
677 {"sinter",sinterCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
678 {"sinterstore",sinterstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
679 {"sunion",sunionCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
680 {"sunionstore",sunionstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
681 {"sdiff",sdiffCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
682 {"sdiffstore",sdiffstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
683 {"smembers",sinterCommand
,2,REDIS_CMD_INLINE
},
684 {"zadd",zaddCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
685 {"zincrby",zincrbyCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
686 {"zrem",zremCommand
,3,REDIS_CMD_BULK
},
687 {"zremrangebyscore",zremrangebyscoreCommand
,4,REDIS_CMD_INLINE
},
688 {"zrange",zrangeCommand
,-4,REDIS_CMD_INLINE
},
689 {"zrangebyscore",zrangebyscoreCommand
,-4,REDIS_CMD_INLINE
},
690 {"zrevrange",zrevrangeCommand
,-4,REDIS_CMD_INLINE
},
691 {"zcard",zcardCommand
,2,REDIS_CMD_INLINE
},
692 {"zscore",zscoreCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
693 {"incrby",incrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
694 {"decrby",decrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
695 {"getset",getsetCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
696 {"mset",msetCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
697 {"msetnx",msetnxCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
698 {"randomkey",randomkeyCommand
,1,REDIS_CMD_INLINE
},
699 {"select",selectCommand
,2,REDIS_CMD_INLINE
},
700 {"move",moveCommand
,3,REDIS_CMD_INLINE
},
701 {"rename",renameCommand
,3,REDIS_CMD_INLINE
},
702 {"renamenx",renamenxCommand
,3,REDIS_CMD_INLINE
},
703 {"expire",expireCommand
,3,REDIS_CMD_INLINE
},
704 {"expireat",expireatCommand
,3,REDIS_CMD_INLINE
},
705 {"keys",keysCommand
,2,REDIS_CMD_INLINE
},
706 {"dbsize",dbsizeCommand
,1,REDIS_CMD_INLINE
},
707 {"auth",authCommand
,2,REDIS_CMD_INLINE
},
708 {"ping",pingCommand
,1,REDIS_CMD_INLINE
},
709 {"echo",echoCommand
,2,REDIS_CMD_BULK
},
710 {"save",saveCommand
,1,REDIS_CMD_INLINE
},
711 {"bgsave",bgsaveCommand
,1,REDIS_CMD_INLINE
},
712 {"bgrewriteaof",bgrewriteaofCommand
,1,REDIS_CMD_INLINE
},
713 {"shutdown",shutdownCommand
,1,REDIS_CMD_INLINE
},
714 {"lastsave",lastsaveCommand
,1,REDIS_CMD_INLINE
},
715 {"type",typeCommand
,2,REDIS_CMD_INLINE
},
716 {"multi",multiCommand
,1,REDIS_CMD_INLINE
},
717 {"exec",execCommand
,1,REDIS_CMD_INLINE
},
718 {"sync",syncCommand
,1,REDIS_CMD_INLINE
},
719 {"flushdb",flushdbCommand
,1,REDIS_CMD_INLINE
},
720 {"flushall",flushallCommand
,1,REDIS_CMD_INLINE
},
721 {"sort",sortCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
722 {"info",infoCommand
,1,REDIS_CMD_INLINE
},
723 {"monitor",monitorCommand
,1,REDIS_CMD_INLINE
},
724 {"ttl",ttlCommand
,2,REDIS_CMD_INLINE
},
725 {"slaveof",slaveofCommand
,3,REDIS_CMD_INLINE
},
726 {"debug",debugCommand
,-2,REDIS_CMD_INLINE
},
730 /*============================ Utility functions ============================ */
732 /* Glob-style pattern matching. */
733 int stringmatchlen(const char *pattern
, int patternLen
,
734 const char *string
, int stringLen
, int nocase
)
739 while (pattern
[1] == '*') {
744 return 1; /* match */
746 if (stringmatchlen(pattern
+1, patternLen
-1,
747 string
, stringLen
, nocase
))
748 return 1; /* match */
752 return 0; /* no match */
756 return 0; /* no match */
766 not = pattern
[0] == '^';
773 if (pattern
[0] == '\\') {
776 if (pattern
[0] == string
[0])
778 } else if (pattern
[0] == ']') {
780 } else if (patternLen
== 0) {
784 } else if (pattern
[1] == '-' && patternLen
>= 3) {
785 int start
= pattern
[0];
786 int end
= pattern
[2];
794 start
= tolower(start
);
800 if (c
>= start
&& c
<= end
)
804 if (pattern
[0] == string
[0])
807 if (tolower((int)pattern
[0]) == tolower((int)string
[0]))
817 return 0; /* no match */
823 if (patternLen
>= 2) {
830 if (pattern
[0] != string
[0])
831 return 0; /* no match */
833 if (tolower((int)pattern
[0]) != tolower((int)string
[0]))
834 return 0; /* no match */
842 if (stringLen
== 0) {
843 while(*pattern
== '*') {
850 if (patternLen
== 0 && stringLen
== 0)
855 static void redisLog(int level
, const char *fmt
, ...) {
859 fp
= (server
.logfile
== NULL
) ? stdout
: fopen(server
.logfile
,"a");
863 if (level
>= server
.verbosity
) {
869 strftime(buf
,64,"%d %b %H:%M:%S",localtime(&now
));
870 fprintf(fp
,"%s %c ",buf
,c
[level
]);
871 vfprintf(fp
, fmt
, ap
);
877 if (server
.logfile
) fclose(fp
);
880 /*====================== Hash table type implementation ==================== */
882 /* This is an hash table type that uses the SDS dynamic strings libary as
883 * keys and radis objects as values (objects can hold SDS strings,
886 static void dictVanillaFree(void *privdata
, void *val
)
888 DICT_NOTUSED(privdata
);
892 static void dictListDestructor(void *privdata
, void *val
)
894 DICT_NOTUSED(privdata
);
895 listRelease((list
*)val
);
898 static int sdsDictKeyCompare(void *privdata
, const void *key1
,
902 DICT_NOTUSED(privdata
);
904 l1
= sdslen((sds
)key1
);
905 l2
= sdslen((sds
)key2
);
906 if (l1
!= l2
) return 0;
907 return memcmp(key1
, key2
, l1
) == 0;
910 static void dictRedisObjectDestructor(void *privdata
, void *val
)
912 DICT_NOTUSED(privdata
);
914 if (val
== NULL
) return; /* Values of swapped out keys as set to NULL */
918 static int dictObjKeyCompare(void *privdata
, const void *key1
,
921 const robj
*o1
= key1
, *o2
= key2
;
922 return sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
925 static unsigned int dictObjHash(const void *key
) {
927 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
930 static int dictEncObjKeyCompare(void *privdata
, const void *key1
,
933 robj
*o1
= (robj
*) key1
, *o2
= (robj
*) key2
;
936 o1
= getDecodedObject(o1
);
937 o2
= getDecodedObject(o2
);
938 cmp
= sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
944 static unsigned int dictEncObjHash(const void *key
) {
945 robj
*o
= (robj
*) key
;
947 o
= getDecodedObject(o
);
948 unsigned int hash
= dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
953 /* Sets type and expires */
954 static dictType setDictType
= {
955 dictEncObjHash
, /* hash function */
958 dictEncObjKeyCompare
, /* key compare */
959 dictRedisObjectDestructor
, /* key destructor */
960 NULL
/* val destructor */
963 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
964 static dictType zsetDictType
= {
965 dictEncObjHash
, /* hash function */
968 dictEncObjKeyCompare
, /* key compare */
969 dictRedisObjectDestructor
, /* key destructor */
970 dictVanillaFree
/* val destructor of malloc(sizeof(double)) */
974 static dictType hashDictType
= {
975 dictObjHash
, /* hash function */
978 dictObjKeyCompare
, /* key compare */
979 dictRedisObjectDestructor
, /* key destructor */
980 dictRedisObjectDestructor
/* val destructor */
984 static dictType keyptrDictType
= {
985 dictObjHash
, /* hash function */
988 dictObjKeyCompare
, /* key compare */
989 dictRedisObjectDestructor
, /* key destructor */
990 NULL
/* val destructor */
993 /* Keylist hash table type has unencoded redis objects as keys and
994 * lists as values. It's used for blocking operations (BLPOP) */
995 static dictType keylistDictType
= {
996 dictObjHash
, /* hash function */
999 dictObjKeyCompare
, /* key compare */
1000 dictRedisObjectDestructor
, /* key destructor */
1001 dictListDestructor
/* val destructor */
1004 /* ========================= Random utility functions ======================= */
1006 /* Redis generally does not try to recover from out of memory conditions
1007 * when allocating objects or strings, it is not clear if it will be possible
1008 * to report this condition to the client since the networking layer itself
1009 * is based on heap allocation for send buffers, so we simply abort.
1010 * At least the code will be simpler to read... */
1011 static void oom(const char *msg
) {
1012 redisLog(REDIS_WARNING
, "%s: Out of memory\n",msg
);
1017 /* ====================== Redis server networking stuff ===================== */
1018 static void closeTimedoutClients(void) {
1021 time_t now
= time(NULL
);
1024 listRewind(server
.clients
,&li
);
1025 while ((ln
= listNext(&li
)) != NULL
) {
1026 c
= listNodeValue(ln
);
1027 if (server
.maxidletime
&&
1028 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
1029 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
1030 (now
- c
->lastinteraction
> server
.maxidletime
))
1032 redisLog(REDIS_VERBOSE
,"Closing idle client");
1034 } else if (c
->flags
& REDIS_BLOCKED
) {
1035 if (c
->blockingto
!= 0 && c
->blockingto
< now
) {
1036 addReply(c
,shared
.nullmultibulk
);
1043 static int htNeedsResize(dict
*dict
) {
1044 long long size
, used
;
1046 size
= dictSlots(dict
);
1047 used
= dictSize(dict
);
1048 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
1049 (used
*100/size
< REDIS_HT_MINFILL
));
1052 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
1053 * we resize the hash table to save memory */
1054 static void tryResizeHashTables(void) {
1057 for (j
= 0; j
< server
.dbnum
; j
++) {
1058 if (htNeedsResize(server
.db
[j
].dict
)) {
1059 redisLog(REDIS_VERBOSE
,"The hash table %d is too sparse, resize it...",j
);
1060 dictResize(server
.db
[j
].dict
);
1061 redisLog(REDIS_VERBOSE
,"Hash table %d resized.",j
);
1063 if (htNeedsResize(server
.db
[j
].expires
))
1064 dictResize(server
.db
[j
].expires
);
1068 /* A background saving child (BGSAVE) terminated its work. Handle this. */
1069 void backgroundSaveDoneHandler(int statloc
) {
1070 int exitcode
= WEXITSTATUS(statloc
);
1071 int bysignal
= WIFSIGNALED(statloc
);
1073 if (!bysignal
&& exitcode
== 0) {
1074 redisLog(REDIS_NOTICE
,
1075 "Background saving terminated with success");
1077 server
.lastsave
= time(NULL
);
1078 } else if (!bysignal
&& exitcode
!= 0) {
1079 redisLog(REDIS_WARNING
, "Background saving error");
1081 redisLog(REDIS_WARNING
,
1082 "Background saving terminated by signal");
1083 rdbRemoveTempFile(server
.bgsavechildpid
);
1085 server
.bgsavechildpid
= -1;
1086 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1087 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1088 updateSlavesWaitingBgsave(exitcode
== 0 ? REDIS_OK
: REDIS_ERR
);
1091 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1093 void backgroundRewriteDoneHandler(int statloc
) {
1094 int exitcode
= WEXITSTATUS(statloc
);
1095 int bysignal
= WIFSIGNALED(statloc
);
1097 if (!bysignal
&& exitcode
== 0) {
1101 redisLog(REDIS_NOTICE
,
1102 "Background append only file rewriting terminated with success");
1103 /* Now it's time to flush the differences accumulated by the parent */
1104 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) server
.bgrewritechildpid
);
1105 fd
= open(tmpfile
,O_WRONLY
|O_APPEND
);
1107 redisLog(REDIS_WARNING
, "Not able to open the temp append only file produced by the child: %s", strerror(errno
));
1110 /* Flush our data... */
1111 if (write(fd
,server
.bgrewritebuf
,sdslen(server
.bgrewritebuf
)) !=
1112 (signed) sdslen(server
.bgrewritebuf
)) {
1113 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
));
1117 redisLog(REDIS_NOTICE
,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server
.bgrewritebuf
));
1118 /* Now our work is to rename the temp file into the stable file. And
1119 * switch the file descriptor used by the server for append only. */
1120 if (rename(tmpfile
,server
.appendfilename
) == -1) {
1121 redisLog(REDIS_WARNING
,"Can't rename the temp append only file into the stable one: %s", strerror(errno
));
1125 /* Mission completed... almost */
1126 redisLog(REDIS_NOTICE
,"Append only file successfully rewritten.");
1127 if (server
.appendfd
!= -1) {
1128 /* If append only is actually enabled... */
1129 close(server
.appendfd
);
1130 server
.appendfd
= fd
;
1132 server
.appendseldb
= -1; /* Make sure it will issue SELECT */
1133 redisLog(REDIS_NOTICE
,"The new append only file was selected for future appends.");
1135 /* If append only is disabled we just generate a dump in this
1136 * format. Why not? */
1139 } else if (!bysignal
&& exitcode
!= 0) {
1140 redisLog(REDIS_WARNING
, "Background append only file rewriting error");
1142 redisLog(REDIS_WARNING
,
1143 "Background append only file rewriting terminated by signal");
1146 sdsfree(server
.bgrewritebuf
);
1147 server
.bgrewritebuf
= sdsempty();
1148 aofRemoveTempFile(server
.bgrewritechildpid
);
1149 server
.bgrewritechildpid
= -1;
1152 static int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
1153 int j
, loops
= server
.cronloops
++;
1154 REDIS_NOTUSED(eventLoop
);
1156 REDIS_NOTUSED(clientData
);
1158 /* We take a cached value of the unix time in the global state because
1159 * with virtual memory and aging there is to store the current time
1160 * in objects at every object access, and accuracy is not needed.
1161 * To access a global var is faster than calling time(NULL) */
1162 server
.unixtime
= time(NULL
);
1164 /* Update the global state with the amount of used memory */
1165 server
.usedmemory
= zmalloc_used_memory();
1167 /* Show some info about non-empty databases */
1168 for (j
= 0; j
< server
.dbnum
; j
++) {
1169 long long size
, used
, vkeys
;
1171 size
= dictSlots(server
.db
[j
].dict
);
1172 used
= dictSize(server
.db
[j
].dict
);
1173 vkeys
= dictSize(server
.db
[j
].expires
);
1174 if (!(loops
% 5) && (used
|| vkeys
)) {
1175 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
1176 /* dictPrintStats(server.dict); */
1180 /* We don't want to resize the hash tables while a bacground saving
1181 * is in progress: the saving child is created using fork() that is
1182 * implemented with a copy-on-write semantic in most modern systems, so
1183 * if we resize the HT while there is the saving child at work actually
1184 * a lot of memory movements in the parent will cause a lot of pages
1186 if (server
.bgsavechildpid
== -1) tryResizeHashTables();
1188 /* Show information about connected clients */
1190 redisLog(REDIS_VERBOSE
,"%d clients connected (%d slaves), %zu bytes in use, %d shared objects",
1191 listLength(server
.clients
)-listLength(server
.slaves
),
1192 listLength(server
.slaves
),
1194 dictSize(server
.sharingpool
));
1197 /* Close connections of timedout clients */
1198 if ((server
.maxidletime
&& !(loops
% 10)) || server
.blockedclients
)
1199 closeTimedoutClients();
1201 /* Check if a background saving or AOF rewrite in progress terminated */
1202 if (server
.bgsavechildpid
!= -1 || server
.bgrewritechildpid
!= -1) {
1206 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
1207 if (pid
== server
.bgsavechildpid
) {
1208 backgroundSaveDoneHandler(statloc
);
1210 backgroundRewriteDoneHandler(statloc
);
1214 /* If there is not a background saving in progress check if
1215 * we have to save now */
1216 time_t now
= time(NULL
);
1217 for (j
= 0; j
< server
.saveparamslen
; j
++) {
1218 struct saveparam
*sp
= server
.saveparams
+j
;
1220 if (server
.dirty
>= sp
->changes
&&
1221 now
-server
.lastsave
> sp
->seconds
) {
1222 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
1223 sp
->changes
, sp
->seconds
);
1224 rdbSaveBackground(server
.dbfilename
);
1230 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1231 * will use few CPU cycles if there are few expiring keys, otherwise
1232 * it will get more aggressive to avoid that too much memory is used by
1233 * keys that can be removed from the keyspace. */
1234 for (j
= 0; j
< server
.dbnum
; j
++) {
1236 redisDb
*db
= server
.db
+j
;
1238 /* Continue to expire if at the end of the cycle more than 25%
1239 * of the keys were expired. */
1241 long num
= dictSize(db
->expires
);
1242 time_t now
= time(NULL
);
1245 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
1246 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
1251 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
1252 t
= (time_t) dictGetEntryVal(de
);
1254 deleteKey(db
,dictGetEntryKey(de
));
1258 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
1261 /* Swap a few keys on disk if we are over the memory limit and VM
1262 * is enbled. Try to free objects from the free list first. */
1263 if (vmCanSwapOut()) {
1264 while (server
.vm_enabled
&& zmalloc_used_memory() >
1265 server
.vm_max_memory
)
1269 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
1270 retval
= (server
.vm_max_threads
== 0) ?
1271 vmSwapOneObjectBlocking() :
1272 vmSwapOneObjectThreaded();
1273 if (retval
== REDIS_ERR
&& (loops
% 30) == 0 &&
1274 zmalloc_used_memory() >
1275 (server
.vm_max_memory
+server
.vm_max_memory
/10))
1277 redisLog(REDIS_WARNING
,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1279 /* Note that when using threade I/O we free just one object,
1280 * because anyway when the I/O thread in charge to swap this
1281 * object out will finish, the handler of completed jobs
1282 * will try to swap more objects if we are still out of memory. */
1283 if (retval
== REDIS_ERR
|| server
.vm_max_threads
> 0) break;
1287 /* Check if we should connect to a MASTER */
1288 if (server
.replstate
== REDIS_REPL_CONNECT
) {
1289 redisLog(REDIS_NOTICE
,"Connecting to MASTER...");
1290 if (syncWithMaster() == REDIS_OK
) {
1291 redisLog(REDIS_NOTICE
,"MASTER <-> SLAVE sync succeeded");
1297 static void createSharedObjects(void) {
1298 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1299 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1300 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1301 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1302 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1303 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1304 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1305 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1306 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1307 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1308 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1309 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1310 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1311 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1312 "-ERR no such key\r\n"));
1313 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1314 "-ERR syntax error\r\n"));
1315 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1316 "-ERR source and destination objects are the same\r\n"));
1317 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1318 "-ERR index out of range\r\n"));
1319 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1320 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1321 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1322 shared
.select0
= createStringObject("select 0\r\n",10);
1323 shared
.select1
= createStringObject("select 1\r\n",10);
1324 shared
.select2
= createStringObject("select 2\r\n",10);
1325 shared
.select3
= createStringObject("select 3\r\n",10);
1326 shared
.select4
= createStringObject("select 4\r\n",10);
1327 shared
.select5
= createStringObject("select 5\r\n",10);
1328 shared
.select6
= createStringObject("select 6\r\n",10);
1329 shared
.select7
= createStringObject("select 7\r\n",10);
1330 shared
.select8
= createStringObject("select 8\r\n",10);
1331 shared
.select9
= createStringObject("select 9\r\n",10);
1334 static void appendServerSaveParams(time_t seconds
, int changes
) {
1335 server
.saveparams
= zrealloc(server
.saveparams
,sizeof(struct saveparam
)*(server
.saveparamslen
+1));
1336 server
.saveparams
[server
.saveparamslen
].seconds
= seconds
;
1337 server
.saveparams
[server
.saveparamslen
].changes
= changes
;
1338 server
.saveparamslen
++;
1341 static void resetServerSaveParams() {
1342 zfree(server
.saveparams
);
1343 server
.saveparams
= NULL
;
1344 server
.saveparamslen
= 0;
1347 static void initServerConfig() {
1348 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1349 server
.port
= REDIS_SERVERPORT
;
1350 server
.verbosity
= REDIS_VERBOSE
;
1351 server
.maxidletime
= REDIS_MAXIDLETIME
;
1352 server
.saveparams
= NULL
;
1353 server
.logfile
= NULL
; /* NULL = log on standard output */
1354 server
.bindaddr
= NULL
;
1355 server
.glueoutputbuf
= 1;
1356 server
.daemonize
= 0;
1357 server
.appendonly
= 0;
1358 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1359 server
.lastfsync
= time(NULL
);
1360 server
.appendfd
= -1;
1361 server
.appendseldb
= -1; /* Make sure the first time will not match */
1362 server
.pidfile
= "/var/run/redis.pid";
1363 server
.dbfilename
= "dump.rdb";
1364 server
.appendfilename
= "appendonly.aof";
1365 server
.requirepass
= NULL
;
1366 server
.shareobjects
= 0;
1367 server
.rdbcompression
= 1;
1368 server
.sharingpoolsize
= 1024;
1369 server
.maxclients
= 0;
1370 server
.blockedclients
= 0;
1371 server
.maxmemory
= 0;
1372 server
.vm_enabled
= 0;
1373 server
.vm_page_size
= 256; /* 256 bytes per page */
1374 server
.vm_pages
= 1024*1024*100; /* 104 millions of pages */
1375 server
.vm_max_memory
= 1024LL*1024*1024*1; /* 1 GB of RAM */
1376 server
.vm_max_threads
= 4;
1378 resetServerSaveParams();
1380 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1381 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1382 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1383 /* Replication related */
1385 server
.masterauth
= NULL
;
1386 server
.masterhost
= NULL
;
1387 server
.masterport
= 6379;
1388 server
.master
= NULL
;
1389 server
.replstate
= REDIS_REPL_NONE
;
1391 /* Double constants initialization */
1393 R_PosInf
= 1.0/R_Zero
;
1394 R_NegInf
= -1.0/R_Zero
;
1395 R_Nan
= R_Zero
/R_Zero
;
1398 static void initServer() {
1401 signal(SIGHUP
, SIG_IGN
);
1402 signal(SIGPIPE
, SIG_IGN
);
1403 setupSigSegvAction();
1405 server
.devnull
= fopen("/dev/null","w");
1406 if (server
.devnull
== NULL
) {
1407 redisLog(REDIS_WARNING
, "Can't open /dev/null: %s", server
.neterr
);
1410 server
.clients
= listCreate();
1411 server
.slaves
= listCreate();
1412 server
.monitors
= listCreate();
1413 server
.objfreelist
= listCreate();
1414 createSharedObjects();
1415 server
.el
= aeCreateEventLoop();
1416 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1417 server
.sharingpool
= dictCreate(&setDictType
,NULL
);
1418 server
.fd
= anetTcpServer(server
.neterr
, server
.port
, server
.bindaddr
);
1419 if (server
.fd
== -1) {
1420 redisLog(REDIS_WARNING
, "Opening TCP port: %s", server
.neterr
);
1423 for (j
= 0; j
< server
.dbnum
; j
++) {
1424 server
.db
[j
].dict
= dictCreate(&hashDictType
,NULL
);
1425 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1426 server
.db
[j
].blockingkeys
= dictCreate(&keylistDictType
,NULL
);
1427 server
.db
[j
].id
= j
;
1429 server
.cronloops
= 0;
1430 server
.bgsavechildpid
= -1;
1431 server
.bgrewritechildpid
= -1;
1432 server
.bgrewritebuf
= sdsempty();
1433 server
.lastsave
= time(NULL
);
1435 server
.usedmemory
= 0;
1436 server
.stat_numcommands
= 0;
1437 server
.stat_numconnections
= 0;
1438 server
.stat_starttime
= time(NULL
);
1439 server
.unixtime
= time(NULL
);
1440 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1441 if (aeCreateFileEvent(server
.el
, server
.fd
, AE_READABLE
,
1442 acceptHandler
, NULL
) == AE_ERR
) oom("creating file event");
1444 if (server
.appendonly
) {
1445 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1446 if (server
.appendfd
== -1) {
1447 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1453 if (server
.vm_enabled
) vmInit();
1456 /* Empty the whole database */
1457 static long long emptyDb() {
1459 long long removed
= 0;
1461 for (j
= 0; j
< server
.dbnum
; j
++) {
1462 removed
+= dictSize(server
.db
[j
].dict
);
1463 dictEmpty(server
.db
[j
].dict
);
1464 dictEmpty(server
.db
[j
].expires
);
1469 static int yesnotoi(char *s
) {
1470 if (!strcasecmp(s
,"yes")) return 1;
1471 else if (!strcasecmp(s
,"no")) return 0;
1475 /* I agree, this is a very rudimental way to load a configuration...
1476 will improve later if the config gets more complex */
1477 static void loadServerConfig(char *filename
) {
1479 char buf
[REDIS_CONFIGLINE_MAX
+1], *err
= NULL
;
1483 if (filename
[0] == '-' && filename
[1] == '\0')
1486 if ((fp
= fopen(filename
,"r")) == NULL
) {
1487 redisLog(REDIS_WARNING
,"Fatal error, can't open config file");
1492 while(fgets(buf
,REDIS_CONFIGLINE_MAX
+1,fp
) != NULL
) {
1498 line
= sdstrim(line
," \t\r\n");
1500 /* Skip comments and blank lines*/
1501 if (line
[0] == '#' || line
[0] == '\0') {
1506 /* Split into arguments */
1507 argv
= sdssplitlen(line
,sdslen(line
)," ",1,&argc
);
1508 sdstolower(argv
[0]);
1510 /* Execute config directives */
1511 if (!strcasecmp(argv
[0],"timeout") && argc
== 2) {
1512 server
.maxidletime
= atoi(argv
[1]);
1513 if (server
.maxidletime
< 0) {
1514 err
= "Invalid timeout value"; goto loaderr
;
1516 } else if (!strcasecmp(argv
[0],"port") && argc
== 2) {
1517 server
.port
= atoi(argv
[1]);
1518 if (server
.port
< 1 || server
.port
> 65535) {
1519 err
= "Invalid port"; goto loaderr
;
1521 } else if (!strcasecmp(argv
[0],"bind") && argc
== 2) {
1522 server
.bindaddr
= zstrdup(argv
[1]);
1523 } else if (!strcasecmp(argv
[0],"save") && argc
== 3) {
1524 int seconds
= atoi(argv
[1]);
1525 int changes
= atoi(argv
[2]);
1526 if (seconds
< 1 || changes
< 0) {
1527 err
= "Invalid save parameters"; goto loaderr
;
1529 appendServerSaveParams(seconds
,changes
);
1530 } else if (!strcasecmp(argv
[0],"dir") && argc
== 2) {
1531 if (chdir(argv
[1]) == -1) {
1532 redisLog(REDIS_WARNING
,"Can't chdir to '%s': %s",
1533 argv
[1], strerror(errno
));
1536 } else if (!strcasecmp(argv
[0],"loglevel") && argc
== 2) {
1537 if (!strcasecmp(argv
[1],"debug")) server
.verbosity
= REDIS_DEBUG
;
1538 else if (!strcasecmp(argv
[1],"verbose")) server
.verbosity
= REDIS_VERBOSE
;
1539 else if (!strcasecmp(argv
[1],"notice")) server
.verbosity
= REDIS_NOTICE
;
1540 else if (!strcasecmp(argv
[1],"warning")) server
.verbosity
= REDIS_WARNING
;
1542 err
= "Invalid log level. Must be one of debug, notice, warning";
1545 } else if (!strcasecmp(argv
[0],"logfile") && argc
== 2) {
1548 server
.logfile
= zstrdup(argv
[1]);
1549 if (!strcasecmp(server
.logfile
,"stdout")) {
1550 zfree(server
.logfile
);
1551 server
.logfile
= NULL
;
1553 if (server
.logfile
) {
1554 /* Test if we are able to open the file. The server will not
1555 * be able to abort just for this problem later... */
1556 logfp
= fopen(server
.logfile
,"a");
1557 if (logfp
== NULL
) {
1558 err
= sdscatprintf(sdsempty(),
1559 "Can't open the log file: %s", strerror(errno
));
1564 } else if (!strcasecmp(argv
[0],"databases") && argc
== 2) {
1565 server
.dbnum
= atoi(argv
[1]);
1566 if (server
.dbnum
< 1) {
1567 err
= "Invalid number of databases"; goto loaderr
;
1569 } else if (!strcasecmp(argv
[0],"maxclients") && argc
== 2) {
1570 server
.maxclients
= atoi(argv
[1]);
1571 } else if (!strcasecmp(argv
[0],"maxmemory") && argc
== 2) {
1572 server
.maxmemory
= strtoll(argv
[1], NULL
, 10);
1573 } else if (!strcasecmp(argv
[0],"slaveof") && argc
== 3) {
1574 server
.masterhost
= sdsnew(argv
[1]);
1575 server
.masterport
= atoi(argv
[2]);
1576 server
.replstate
= REDIS_REPL_CONNECT
;
1577 } else if (!strcasecmp(argv
[0],"masterauth") && argc
== 2) {
1578 server
.masterauth
= zstrdup(argv
[1]);
1579 } else if (!strcasecmp(argv
[0],"glueoutputbuf") && argc
== 2) {
1580 if ((server
.glueoutputbuf
= yesnotoi(argv
[1])) == -1) {
1581 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1583 } else if (!strcasecmp(argv
[0],"shareobjects") && argc
== 2) {
1584 if ((server
.shareobjects
= yesnotoi(argv
[1])) == -1) {
1585 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1587 } else if (!strcasecmp(argv
[0],"rdbcompression") && argc
== 2) {
1588 if ((server
.rdbcompression
= yesnotoi(argv
[1])) == -1) {
1589 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1591 } else if (!strcasecmp(argv
[0],"shareobjectspoolsize") && argc
== 2) {
1592 server
.sharingpoolsize
= atoi(argv
[1]);
1593 if (server
.sharingpoolsize
< 1) {
1594 err
= "invalid object sharing pool size"; goto loaderr
;
1596 } else if (!strcasecmp(argv
[0],"daemonize") && argc
== 2) {
1597 if ((server
.daemonize
= yesnotoi(argv
[1])) == -1) {
1598 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1600 } else if (!strcasecmp(argv
[0],"appendonly") && argc
== 2) {
1601 if ((server
.appendonly
= yesnotoi(argv
[1])) == -1) {
1602 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1604 } else if (!strcasecmp(argv
[0],"appendfsync") && argc
== 2) {
1605 if (!strcasecmp(argv
[1],"no")) {
1606 server
.appendfsync
= APPENDFSYNC_NO
;
1607 } else if (!strcasecmp(argv
[1],"always")) {
1608 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1609 } else if (!strcasecmp(argv
[1],"everysec")) {
1610 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1612 err
= "argument must be 'no', 'always' or 'everysec'";
1615 } else if (!strcasecmp(argv
[0],"requirepass") && argc
== 2) {
1616 server
.requirepass
= zstrdup(argv
[1]);
1617 } else if (!strcasecmp(argv
[0],"pidfile") && argc
== 2) {
1618 server
.pidfile
= zstrdup(argv
[1]);
1619 } else if (!strcasecmp(argv
[0],"dbfilename") && argc
== 2) {
1620 server
.dbfilename
= zstrdup(argv
[1]);
1621 } else if (!strcasecmp(argv
[0],"vm-enabled") && argc
== 2) {
1622 if ((server
.vm_enabled
= yesnotoi(argv
[1])) == -1) {
1623 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1625 } else if (!strcasecmp(argv
[0],"vm-max-memory") && argc
== 2) {
1626 server
.vm_max_memory
= strtoll(argv
[1], NULL
, 10);
1627 } else if (!strcasecmp(argv
[0],"vm-page-size") && argc
== 2) {
1628 server
.vm_page_size
= strtoll(argv
[1], NULL
, 10);
1629 } else if (!strcasecmp(argv
[0],"vm-pages") && argc
== 2) {
1630 server
.vm_pages
= strtoll(argv
[1], NULL
, 10);
1631 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1632 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1634 err
= "Bad directive or wrong number of arguments"; goto loaderr
;
1636 for (j
= 0; j
< argc
; j
++)
1641 if (fp
!= stdin
) fclose(fp
);
1645 fprintf(stderr
, "\n*** FATAL CONFIG FILE ERROR ***\n");
1646 fprintf(stderr
, "Reading the configuration file, at line %d\n", linenum
);
1647 fprintf(stderr
, ">>> '%s'\n", line
);
1648 fprintf(stderr
, "%s\n", err
);
1652 static void freeClientArgv(redisClient
*c
) {
1655 for (j
= 0; j
< c
->argc
; j
++)
1656 decrRefCount(c
->argv
[j
]);
1657 for (j
= 0; j
< c
->mbargc
; j
++)
1658 decrRefCount(c
->mbargv
[j
]);
1663 static void freeClient(redisClient
*c
) {
1666 /* Note that if the client we are freeing is blocked into a blocking
1667 * call, we have to set querybuf to NULL *before* to call unblockClient()
1668 * to avoid processInputBuffer() will get called. Also it is important
1669 * to remove the file events after this, because this call adds
1670 * the READABLE event. */
1671 sdsfree(c
->querybuf
);
1673 if (c
->flags
& REDIS_BLOCKED
)
1676 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
1677 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1678 listRelease(c
->reply
);
1681 /* Remove from the list of clients */
1682 ln
= listSearchKey(server
.clients
,c
);
1683 redisAssert(ln
!= NULL
);
1684 listDelNode(server
.clients
,ln
);
1685 /* Remove from the list of clients waiting for VM operations */
1686 if (server
.vm_enabled
&& listLength(c
->io_keys
)) {
1687 ln
= listSearchKey(server
.io_clients
,c
);
1688 if (ln
) listDelNode(server
.io_clients
,ln
);
1689 listRelease(c
->io_keys
);
1691 listRelease(c
->io_keys
);
1693 if (c
->flags
& REDIS_SLAVE
) {
1694 if (c
->replstate
== REDIS_REPL_SEND_BULK
&& c
->repldbfd
!= -1)
1696 list
*l
= (c
->flags
& REDIS_MONITOR
) ? server
.monitors
: server
.slaves
;
1697 ln
= listSearchKey(l
,c
);
1698 redisAssert(ln
!= NULL
);
1701 if (c
->flags
& REDIS_MASTER
) {
1702 server
.master
= NULL
;
1703 server
.replstate
= REDIS_REPL_CONNECT
;
1707 freeClientMultiState(c
);
1711 #define GLUEREPLY_UP_TO (1024)
1712 static void glueReplyBuffersIfNeeded(redisClient
*c
) {
1714 char buf
[GLUEREPLY_UP_TO
];
1719 listRewind(c
->reply
,&li
);
1720 while((ln
= listNext(&li
))) {
1724 objlen
= sdslen(o
->ptr
);
1725 if (copylen
+ objlen
<= GLUEREPLY_UP_TO
) {
1726 memcpy(buf
+copylen
,o
->ptr
,objlen
);
1728 listDelNode(c
->reply
,ln
);
1730 if (copylen
== 0) return;
1734 /* Now the output buffer is empty, add the new single element */
1735 o
= createObject(REDIS_STRING
,sdsnewlen(buf
,copylen
));
1736 listAddNodeHead(c
->reply
,o
);
1739 static void sendReplyToClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
1740 redisClient
*c
= privdata
;
1741 int nwritten
= 0, totwritten
= 0, objlen
;
1744 REDIS_NOTUSED(mask
);
1746 /* Use writev() if we have enough buffers to send */
1747 if (!server
.glueoutputbuf
&&
1748 listLength(c
->reply
) > REDIS_WRITEV_THRESHOLD
&&
1749 !(c
->flags
& REDIS_MASTER
))
1751 sendReplyToClientWritev(el
, fd
, privdata
, mask
);
1755 while(listLength(c
->reply
)) {
1756 if (server
.glueoutputbuf
&& listLength(c
->reply
) > 1)
1757 glueReplyBuffersIfNeeded(c
);
1759 o
= listNodeValue(listFirst(c
->reply
));
1760 objlen
= sdslen(o
->ptr
);
1763 listDelNode(c
->reply
,listFirst(c
->reply
));
1767 if (c
->flags
& REDIS_MASTER
) {
1768 /* Don't reply to a master */
1769 nwritten
= objlen
- c
->sentlen
;
1771 nwritten
= write(fd
, ((char*)o
->ptr
)+c
->sentlen
, objlen
- c
->sentlen
);
1772 if (nwritten
<= 0) break;
1774 c
->sentlen
+= nwritten
;
1775 totwritten
+= nwritten
;
1776 /* If we fully sent the object on head go to the next one */
1777 if (c
->sentlen
== objlen
) {
1778 listDelNode(c
->reply
,listFirst(c
->reply
));
1781 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
1782 * bytes, in a single threaded server it's a good idea to serve
1783 * other clients as well, even if a very large request comes from
1784 * super fast link that is always able to accept data (in real world
1785 * scenario think about 'KEYS *' against the loopback interfae) */
1786 if (totwritten
> REDIS_MAX_WRITE_PER_EVENT
) break;
1788 if (nwritten
== -1) {
1789 if (errno
== EAGAIN
) {
1792 redisLog(REDIS_VERBOSE
,
1793 "Error writing to client: %s", strerror(errno
));
1798 if (totwritten
> 0) c
->lastinteraction
= time(NULL
);
1799 if (listLength(c
->reply
) == 0) {
1801 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1805 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
)
1807 redisClient
*c
= privdata
;
1808 int nwritten
= 0, totwritten
= 0, objlen
, willwrite
;
1810 struct iovec iov
[REDIS_WRITEV_IOVEC_COUNT
];
1811 int offset
, ion
= 0;
1813 REDIS_NOTUSED(mask
);
1816 while (listLength(c
->reply
)) {
1817 offset
= c
->sentlen
;
1821 /* fill-in the iov[] array */
1822 for(node
= listFirst(c
->reply
); node
; node
= listNextNode(node
)) {
1823 o
= listNodeValue(node
);
1824 objlen
= sdslen(o
->ptr
);
1826 if (totwritten
+ objlen
- offset
> REDIS_MAX_WRITE_PER_EVENT
)
1829 if(ion
== REDIS_WRITEV_IOVEC_COUNT
)
1830 break; /* no more iovecs */
1832 iov
[ion
].iov_base
= ((char*)o
->ptr
) + offset
;
1833 iov
[ion
].iov_len
= objlen
- offset
;
1834 willwrite
+= objlen
- offset
;
1835 offset
= 0; /* just for the first item */
1842 /* write all collected blocks at once */
1843 if((nwritten
= writev(fd
, iov
, ion
)) < 0) {
1844 if (errno
!= EAGAIN
) {
1845 redisLog(REDIS_VERBOSE
,
1846 "Error writing to client: %s", strerror(errno
));
1853 totwritten
+= nwritten
;
1854 offset
= c
->sentlen
;
1856 /* remove written robjs from c->reply */
1857 while (nwritten
&& listLength(c
->reply
)) {
1858 o
= listNodeValue(listFirst(c
->reply
));
1859 objlen
= sdslen(o
->ptr
);
1861 if(nwritten
>= objlen
- offset
) {
1862 listDelNode(c
->reply
, listFirst(c
->reply
));
1863 nwritten
-= objlen
- offset
;
1867 c
->sentlen
+= nwritten
;
1875 c
->lastinteraction
= time(NULL
);
1877 if (listLength(c
->reply
) == 0) {
1879 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1883 static struct redisCommand
*lookupCommand(char *name
) {
1885 while(cmdTable
[j
].name
!= NULL
) {
1886 if (!strcasecmp(name
,cmdTable
[j
].name
)) return &cmdTable
[j
];
1892 /* resetClient prepare the client to process the next command */
1893 static void resetClient(redisClient
*c
) {
1899 /* Call() is the core of Redis execution of a command */
1900 static void call(redisClient
*c
, struct redisCommand
*cmd
) {
1903 dirty
= server
.dirty
;
1905 if (server
.appendonly
&& server
.dirty
-dirty
)
1906 feedAppendOnlyFile(cmd
,c
->db
->id
,c
->argv
,c
->argc
);
1907 if (server
.dirty
-dirty
&& listLength(server
.slaves
))
1908 replicationFeedSlaves(server
.slaves
,cmd
,c
->db
->id
,c
->argv
,c
->argc
);
1909 if (listLength(server
.monitors
))
1910 replicationFeedSlaves(server
.monitors
,cmd
,c
->db
->id
,c
->argv
,c
->argc
);
1911 server
.stat_numcommands
++;
1914 /* If this function gets called we already read a whole
1915 * command, argments are in the client argv/argc fields.
1916 * processCommand() execute the command or prepare the
1917 * server for a bulk read from the client.
1919 * If 1 is returned the client is still alive and valid and
1920 * and other operations can be performed by the caller. Otherwise
1921 * if 0 is returned the client was destroied (i.e. after QUIT). */
1922 static int processCommand(redisClient
*c
) {
1923 struct redisCommand
*cmd
;
1925 /* Free some memory if needed (maxmemory setting) */
1926 if (server
.maxmemory
) freeMemoryIfNeeded();
1928 /* Handle the multi bulk command type. This is an alternative protocol
1929 * supported by Redis in order to receive commands that are composed of
1930 * multiple binary-safe "bulk" arguments. The latency of processing is
1931 * a bit higher but this allows things like multi-sets, so if this
1932 * protocol is used only for MSET and similar commands this is a big win. */
1933 if (c
->multibulk
== 0 && c
->argc
== 1 && ((char*)(c
->argv
[0]->ptr
))[0] == '*') {
1934 c
->multibulk
= atoi(((char*)c
->argv
[0]->ptr
)+1);
1935 if (c
->multibulk
<= 0) {
1939 decrRefCount(c
->argv
[c
->argc
-1]);
1943 } else if (c
->multibulk
) {
1944 if (c
->bulklen
== -1) {
1945 if (((char*)c
->argv
[0]->ptr
)[0] != '$') {
1946 addReplySds(c
,sdsnew("-ERR multi bulk protocol error\r\n"));
1950 int bulklen
= atoi(((char*)c
->argv
[0]->ptr
)+1);
1951 decrRefCount(c
->argv
[0]);
1952 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
1954 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
1959 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
1963 c
->mbargv
= zrealloc(c
->mbargv
,(sizeof(robj
*))*(c
->mbargc
+1));
1964 c
->mbargv
[c
->mbargc
] = c
->argv
[0];
1968 if (c
->multibulk
== 0) {
1972 /* Here we need to swap the multi-bulk argc/argv with the
1973 * normal argc/argv of the client structure. */
1975 c
->argv
= c
->mbargv
;
1976 c
->mbargv
= auxargv
;
1979 c
->argc
= c
->mbargc
;
1980 c
->mbargc
= auxargc
;
1982 /* We need to set bulklen to something different than -1
1983 * in order for the code below to process the command without
1984 * to try to read the last argument of a bulk command as
1985 * a special argument. */
1987 /* continue below and process the command */
1994 /* -- end of multi bulk commands processing -- */
1996 /* The QUIT command is handled as a special case. Normal command
1997 * procs are unable to close the client connection safely */
1998 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
2002 cmd
= lookupCommand(c
->argv
[0]->ptr
);
2005 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2006 (char*)c
->argv
[0]->ptr
));
2009 } else if ((cmd
->arity
> 0 && cmd
->arity
!= c
->argc
) ||
2010 (c
->argc
< -cmd
->arity
)) {
2012 sdscatprintf(sdsempty(),
2013 "-ERR wrong number of arguments for '%s' command\r\n",
2017 } else if (server
.maxmemory
&& cmd
->flags
& REDIS_CMD_DENYOOM
&& zmalloc_used_memory() > server
.maxmemory
) {
2018 addReplySds(c
,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2021 } else if (cmd
->flags
& REDIS_CMD_BULK
&& c
->bulklen
== -1) {
2022 int bulklen
= atoi(c
->argv
[c
->argc
-1]->ptr
);
2024 decrRefCount(c
->argv
[c
->argc
-1]);
2025 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2027 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2032 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2033 /* It is possible that the bulk read is already in the
2034 * buffer. Check this condition and handle it accordingly.
2035 * This is just a fast path, alternative to call processInputBuffer().
2036 * It's a good idea since the code is small and this condition
2037 * happens most of the times. */
2038 if ((signed)sdslen(c
->querybuf
) >= c
->bulklen
) {
2039 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2041 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2046 /* Let's try to share objects on the command arguments vector */
2047 if (server
.shareobjects
) {
2049 for(j
= 1; j
< c
->argc
; j
++)
2050 c
->argv
[j
] = tryObjectSharing(c
->argv
[j
]);
2052 /* Let's try to encode the bulk object to save space. */
2053 if (cmd
->flags
& REDIS_CMD_BULK
)
2054 tryObjectEncoding(c
->argv
[c
->argc
-1]);
2056 /* Check if the user is authenticated */
2057 if (server
.requirepass
&& !c
->authenticated
&& cmd
->proc
!= authCommand
) {
2058 addReplySds(c
,sdsnew("-ERR operation not permitted\r\n"));
2063 /* Exec the command */
2064 if (c
->flags
& REDIS_MULTI
&& cmd
->proc
!= execCommand
) {
2065 queueMultiCommand(c
,cmd
);
2066 addReply(c
,shared
.queued
);
2071 /* Prepare the client for the next command */
2072 if (c
->flags
& REDIS_CLOSE
) {
2080 static void replicationFeedSlaves(list
*slaves
, struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
2085 /* (args*2)+1 is enough room for args, spaces, newlines */
2086 robj
*static_outv
[REDIS_STATIC_ARGS
*2+1];
2088 if (argc
<= REDIS_STATIC_ARGS
) {
2091 outv
= zmalloc(sizeof(robj
*)*(argc
*2+1));
2094 for (j
= 0; j
< argc
; j
++) {
2095 if (j
!= 0) outv
[outc
++] = shared
.space
;
2096 if ((cmd
->flags
& REDIS_CMD_BULK
) && j
== argc
-1) {
2099 lenobj
= createObject(REDIS_STRING
,
2100 sdscatprintf(sdsempty(),"%lu\r\n",
2101 (unsigned long) stringObjectLen(argv
[j
])));
2102 lenobj
->refcount
= 0;
2103 outv
[outc
++] = lenobj
;
2105 outv
[outc
++] = argv
[j
];
2107 outv
[outc
++] = shared
.crlf
;
2109 /* Increment all the refcounts at start and decrement at end in order to
2110 * be sure to free objects if there is no slave in a replication state
2111 * able to be feed with commands */
2112 for (j
= 0; j
< outc
; j
++) incrRefCount(outv
[j
]);
2113 listRewind(slaves
,&li
);
2114 while((ln
= listNext(&li
))) {
2115 redisClient
*slave
= ln
->value
;
2117 /* Don't feed slaves that are still waiting for BGSAVE to start */
2118 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) continue;
2120 /* Feed all the other slaves, MONITORs and so on */
2121 if (slave
->slaveseldb
!= dictid
) {
2125 case 0: selectcmd
= shared
.select0
; break;
2126 case 1: selectcmd
= shared
.select1
; break;
2127 case 2: selectcmd
= shared
.select2
; break;
2128 case 3: selectcmd
= shared
.select3
; break;
2129 case 4: selectcmd
= shared
.select4
; break;
2130 case 5: selectcmd
= shared
.select5
; break;
2131 case 6: selectcmd
= shared
.select6
; break;
2132 case 7: selectcmd
= shared
.select7
; break;
2133 case 8: selectcmd
= shared
.select8
; break;
2134 case 9: selectcmd
= shared
.select9
; break;
2136 selectcmd
= createObject(REDIS_STRING
,
2137 sdscatprintf(sdsempty(),"select %d\r\n",dictid
));
2138 selectcmd
->refcount
= 0;
2141 addReply(slave
,selectcmd
);
2142 slave
->slaveseldb
= dictid
;
2144 for (j
= 0; j
< outc
; j
++) addReply(slave
,outv
[j
]);
2146 for (j
= 0; j
< outc
; j
++) decrRefCount(outv
[j
]);
2147 if (outv
!= static_outv
) zfree(outv
);
2150 static void processInputBuffer(redisClient
*c
) {
2152 /* Before to process the input buffer, make sure the client is not
2153 * waitig for a blocking operation such as BLPOP. Note that the first
2154 * iteration the client is never blocked, otherwise the processInputBuffer
2155 * would not be called at all, but after the execution of the first commands
2156 * in the input buffer the client may be blocked, and the "goto again"
2157 * will try to reiterate. The following line will make it return asap. */
2158 if (c
->flags
& REDIS_BLOCKED
|| c
->flags
& REDIS_IO_WAIT
) return;
2159 if (c
->bulklen
== -1) {
2160 /* Read the first line of the query */
2161 char *p
= strchr(c
->querybuf
,'\n');
2168 query
= c
->querybuf
;
2169 c
->querybuf
= sdsempty();
2170 querylen
= 1+(p
-(query
));
2171 if (sdslen(query
) > querylen
) {
2172 /* leave data after the first line of the query in the buffer */
2173 c
->querybuf
= sdscatlen(c
->querybuf
,query
+querylen
,sdslen(query
)-querylen
);
2175 *p
= '\0'; /* remove "\n" */
2176 if (*(p
-1) == '\r') *(p
-1) = '\0'; /* and "\r" if any */
2177 sdsupdatelen(query
);
2179 /* Now we can split the query in arguments */
2180 argv
= sdssplitlen(query
,sdslen(query
)," ",1,&argc
);
2183 if (c
->argv
) zfree(c
->argv
);
2184 c
->argv
= zmalloc(sizeof(robj
*)*argc
);
2186 for (j
= 0; j
< argc
; j
++) {
2187 if (sdslen(argv
[j
])) {
2188 c
->argv
[c
->argc
] = createObject(REDIS_STRING
,argv
[j
]);
2196 /* Execute the command. If the client is still valid
2197 * after processCommand() return and there is something
2198 * on the query buffer try to process the next command. */
2199 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2201 /* Nothing to process, argc == 0. Just process the query
2202 * buffer if it's not empty or return to the caller */
2203 if (sdslen(c
->querybuf
)) goto again
;
2206 } else if (sdslen(c
->querybuf
) >= REDIS_REQUEST_MAX_SIZE
) {
2207 redisLog(REDIS_VERBOSE
, "Client protocol error");
2212 /* Bulk read handling. Note that if we are at this point
2213 the client already sent a command terminated with a newline,
2214 we are reading the bulk data that is actually the last
2215 argument of the command. */
2216 int qbl
= sdslen(c
->querybuf
);
2218 if (c
->bulklen
<= qbl
) {
2219 /* Copy everything but the final CRLF as final argument */
2220 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2222 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2223 /* Process the command. If the client is still valid after
2224 * the processing and there is more data in the buffer
2225 * try to parse it. */
2226 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2232 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2233 redisClient
*c
= (redisClient
*) privdata
;
2234 char buf
[REDIS_IOBUF_LEN
];
2237 REDIS_NOTUSED(mask
);
2239 nread
= read(fd
, buf
, REDIS_IOBUF_LEN
);
2241 if (errno
== EAGAIN
) {
2244 redisLog(REDIS_VERBOSE
, "Reading from client: %s",strerror(errno
));
2248 } else if (nread
== 0) {
2249 redisLog(REDIS_VERBOSE
, "Client closed connection");
2254 c
->querybuf
= sdscatlen(c
->querybuf
, buf
, nread
);
2255 c
->lastinteraction
= time(NULL
);
2259 processInputBuffer(c
);
2262 static int selectDb(redisClient
*c
, int id
) {
2263 if (id
< 0 || id
>= server
.dbnum
)
2265 c
->db
= &server
.db
[id
];
2269 static void *dupClientReplyValue(void *o
) {
2270 incrRefCount((robj
*)o
);
2274 static redisClient
*createClient(int fd
) {
2275 redisClient
*c
= zmalloc(sizeof(*c
));
2277 anetNonBlock(NULL
,fd
);
2278 anetTcpNoDelay(NULL
,fd
);
2279 if (!c
) return NULL
;
2282 c
->querybuf
= sdsempty();
2291 c
->lastinteraction
= time(NULL
);
2292 c
->authenticated
= 0;
2293 c
->replstate
= REDIS_REPL_NONE
;
2294 c
->reply
= listCreate();
2295 listSetFreeMethod(c
->reply
,decrRefCount
);
2296 listSetDupMethod(c
->reply
,dupClientReplyValue
);
2297 c
->blockingkeys
= NULL
;
2298 c
->blockingkeysnum
= 0;
2299 c
->io_keys
= listCreate();
2300 listSetFreeMethod(c
->io_keys
,decrRefCount
);
2301 if (aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
2302 readQueryFromClient
, c
) == AE_ERR
) {
2306 listAddNodeTail(server
.clients
,c
);
2307 initClientMultiState(c
);
2311 static void addReply(redisClient
*c
, robj
*obj
) {
2312 if (listLength(c
->reply
) == 0 &&
2313 (c
->replstate
== REDIS_REPL_NONE
||
2314 c
->replstate
== REDIS_REPL_ONLINE
) &&
2315 aeCreateFileEvent(server
.el
, c
->fd
, AE_WRITABLE
,
2316 sendReplyToClient
, c
) == AE_ERR
) return;
2318 if (server
.vm_enabled
&& obj
->storage
!= REDIS_VM_MEMORY
) {
2319 obj
= dupStringObject(obj
);
2320 obj
->refcount
= 0; /* getDecodedObject() will increment the refcount */
2322 listAddNodeTail(c
->reply
,getDecodedObject(obj
));
2325 static void addReplySds(redisClient
*c
, sds s
) {
2326 robj
*o
= createObject(REDIS_STRING
,s
);
2331 static void addReplyDouble(redisClient
*c
, double d
) {
2334 snprintf(buf
,sizeof(buf
),"%.17g",d
);
2335 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2336 (unsigned long) strlen(buf
),buf
));
2339 static void addReplyBulkLen(redisClient
*c
, robj
*obj
) {
2342 if (obj
->encoding
== REDIS_ENCODING_RAW
) {
2343 len
= sdslen(obj
->ptr
);
2345 long n
= (long)obj
->ptr
;
2347 /* Compute how many bytes will take this integer as a radix 10 string */
2353 while((n
= n
/10) != 0) {
2357 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",(unsigned long)len
));
2360 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2365 REDIS_NOTUSED(mask
);
2366 REDIS_NOTUSED(privdata
);
2368 cfd
= anetAccept(server
.neterr
, fd
, cip
, &cport
);
2369 if (cfd
== AE_ERR
) {
2370 redisLog(REDIS_VERBOSE
,"Accepting client connection: %s", server
.neterr
);
2373 redisLog(REDIS_VERBOSE
,"Accepted %s:%d", cip
, cport
);
2374 if ((c
= createClient(cfd
)) == NULL
) {
2375 redisLog(REDIS_WARNING
,"Error allocating resoures for the client");
2376 close(cfd
); /* May be already closed, just ingore errors */
2379 /* If maxclient directive is set and this is one client more... close the
2380 * connection. Note that we create the client instead to check before
2381 * for this condition, since now the socket is already set in nonblocking
2382 * mode and we can send an error for free using the Kernel I/O */
2383 if (server
.maxclients
&& listLength(server
.clients
) > server
.maxclients
) {
2384 char *err
= "-ERR max number of clients reached\r\n";
2386 /* That's a best effort error message, don't check write errors */
2387 if (write(c
->fd
,err
,strlen(err
)) == -1) {
2388 /* Nothing to do, Just to avoid the warning... */
2393 server
.stat_numconnections
++;
2396 /* ======================= Redis objects implementation ===================== */
2398 static robj
*createObject(int type
, void *ptr
) {
2401 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2402 if (listLength(server
.objfreelist
)) {
2403 listNode
*head
= listFirst(server
.objfreelist
);
2404 o
= listNodeValue(head
);
2405 listDelNode(server
.objfreelist
,head
);
2406 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2408 if (server
.vm_enabled
) {
2409 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2410 o
= zmalloc(sizeof(*o
));
2412 o
= zmalloc(sizeof(*o
)-sizeof(struct redisObjectVM
));
2416 o
->encoding
= REDIS_ENCODING_RAW
;
2419 if (server
.vm_enabled
) {
2420 o
->vm
.atime
= server
.unixtime
;
2421 o
->storage
= REDIS_VM_MEMORY
;
2426 static robj
*createStringObject(char *ptr
, size_t len
) {
2427 return createObject(REDIS_STRING
,sdsnewlen(ptr
,len
));
2430 static robj
*dupStringObject(robj
*o
) {
2431 assert(o
->encoding
== REDIS_ENCODING_RAW
);
2432 return createStringObject(o
->ptr
,sdslen(o
->ptr
));
2435 static robj
*createListObject(void) {
2436 list
*l
= listCreate();
2438 listSetFreeMethod(l
,decrRefCount
);
2439 return createObject(REDIS_LIST
,l
);
2442 static robj
*createSetObject(void) {
2443 dict
*d
= dictCreate(&setDictType
,NULL
);
2444 return createObject(REDIS_SET
,d
);
2447 static robj
*createZsetObject(void) {
2448 zset
*zs
= zmalloc(sizeof(*zs
));
2450 zs
->dict
= dictCreate(&zsetDictType
,NULL
);
2451 zs
->zsl
= zslCreate();
2452 return createObject(REDIS_ZSET
,zs
);
2455 static void freeStringObject(robj
*o
) {
2456 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2461 static void freeListObject(robj
*o
) {
2462 listRelease((list
*) o
->ptr
);
2465 static void freeSetObject(robj
*o
) {
2466 dictRelease((dict
*) o
->ptr
);
2469 static void freeZsetObject(robj
*o
) {
2472 dictRelease(zs
->dict
);
2477 static void freeHashObject(robj
*o
) {
2478 dictRelease((dict
*) o
->ptr
);
2481 static void incrRefCount(robj
*o
) {
2482 redisAssert(!server
.vm_enabled
|| o
->storage
== REDIS_VM_MEMORY
);
2486 static void decrRefCount(void *obj
) {
2489 /* Object is swapped out, or in the process of being loaded. */
2490 if (server
.vm_enabled
&&
2491 (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
))
2493 if (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
) {
2494 redisAssert(o
->refcount
== 1);
2496 if (o
->storage
== REDIS_VM_LOADING
) vmCancelThreadedIOJob(obj
);
2497 redisAssert(o
->type
== REDIS_STRING
);
2498 freeStringObject(o
);
2499 vmMarkPagesFree(o
->vm
.page
,o
->vm
.usedpages
);
2500 pthread_mutex_lock(&server
.obj_freelist_mutex
);
2501 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2502 !listAddNodeHead(server
.objfreelist
,o
))
2504 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2505 server
.vm_stats_swapped_objects
--;
2508 /* Object is in memory, or in the process of being swapped out. */
2509 if (--(o
->refcount
) == 0) {
2510 if (server
.vm_enabled
&& o
->storage
== REDIS_VM_SWAPPING
)
2511 vmCancelThreadedIOJob(obj
);
2513 case REDIS_STRING
: freeStringObject(o
); break;
2514 case REDIS_LIST
: freeListObject(o
); break;
2515 case REDIS_SET
: freeSetObject(o
); break;
2516 case REDIS_ZSET
: freeZsetObject(o
); break;
2517 case REDIS_HASH
: freeHashObject(o
); break;
2518 default: redisAssert(0 != 0); break;
2520 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2521 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2522 !listAddNodeHead(server
.objfreelist
,o
))
2524 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2528 static robj
*lookupKey(redisDb
*db
, robj
*key
) {
2529 dictEntry
*de
= dictFind(db
->dict
,key
);
2531 robj
*key
= dictGetEntryKey(de
);
2532 robj
*val
= dictGetEntryVal(de
);
2534 if (server
.vm_enabled
) {
2535 if (key
->storage
== REDIS_VM_MEMORY
||
2536 key
->storage
== REDIS_VM_SWAPPING
)
2538 /* If we were swapping the object out, stop it, this key
2540 if (key
->storage
== REDIS_VM_SWAPPING
)
2541 vmCancelThreadedIOJob(key
);
2542 /* Update the access time of the key for the aging algorithm. */
2543 key
->vm
.atime
= server
.unixtime
;
2545 /* Our value was swapped on disk. Bring it at home. */
2546 redisAssert(val
== NULL
);
2547 val
= vmLoadObject(key
);
2548 dictGetEntryVal(de
) = val
;
2557 static robj
*lookupKeyRead(redisDb
*db
, robj
*key
) {
2558 expireIfNeeded(db
,key
);
2559 return lookupKey(db
,key
);
2562 static robj
*lookupKeyWrite(redisDb
*db
, robj
*key
) {
2563 deleteIfVolatile(db
,key
);
2564 return lookupKey(db
,key
);
2567 static int deleteKey(redisDb
*db
, robj
*key
) {
2570 /* We need to protect key from destruction: after the first dictDelete()
2571 * it may happen that 'key' is no longer valid if we don't increment
2572 * it's count. This may happen when we get the object reference directly
2573 * from the hash table with dictRandomKey() or dict iterators */
2575 if (dictSize(db
->expires
)) dictDelete(db
->expires
,key
);
2576 retval
= dictDelete(db
->dict
,key
);
2579 return retval
== DICT_OK
;
2582 /* Try to share an object against the shared objects pool */
2583 static robj
*tryObjectSharing(robj
*o
) {
2584 struct dictEntry
*de
;
2587 if (o
== NULL
|| server
.shareobjects
== 0) return o
;
2589 redisAssert(o
->type
== REDIS_STRING
);
2590 de
= dictFind(server
.sharingpool
,o
);
2592 robj
*shared
= dictGetEntryKey(de
);
2594 c
= ((unsigned long) dictGetEntryVal(de
))+1;
2595 dictGetEntryVal(de
) = (void*) c
;
2596 incrRefCount(shared
);
2600 /* Here we are using a stream algorihtm: Every time an object is
2601 * shared we increment its count, everytime there is a miss we
2602 * recrement the counter of a random object. If this object reaches
2603 * zero we remove the object and put the current object instead. */
2604 if (dictSize(server
.sharingpool
) >=
2605 server
.sharingpoolsize
) {
2606 de
= dictGetRandomKey(server
.sharingpool
);
2607 redisAssert(de
!= NULL
);
2608 c
= ((unsigned long) dictGetEntryVal(de
))-1;
2609 dictGetEntryVal(de
) = (void*) c
;
2611 dictDelete(server
.sharingpool
,de
->key
);
2614 c
= 0; /* If the pool is empty we want to add this object */
2619 retval
= dictAdd(server
.sharingpool
,o
,(void*)1);
2620 redisAssert(retval
== DICT_OK
);
2627 /* Check if the nul-terminated string 's' can be represented by a long
2628 * (that is, is a number that fits into long without any other space or
2629 * character before or after the digits).
2631 * If so, the function returns REDIS_OK and *longval is set to the value
2632 * of the number. Otherwise REDIS_ERR is returned */
2633 static int isStringRepresentableAsLong(sds s
, long *longval
) {
2634 char buf
[32], *endptr
;
2638 value
= strtol(s
, &endptr
, 10);
2639 if (endptr
[0] != '\0') return REDIS_ERR
;
2640 slen
= snprintf(buf
,32,"%ld",value
);
2642 /* If the number converted back into a string is not identical
2643 * then it's not possible to encode the string as integer */
2644 if (sdslen(s
) != (unsigned)slen
|| memcmp(buf
,s
,slen
)) return REDIS_ERR
;
2645 if (longval
) *longval
= value
;
2649 /* Try to encode a string object in order to save space */
2650 static int tryObjectEncoding(robj
*o
) {
2654 if (o
->encoding
!= REDIS_ENCODING_RAW
)
2655 return REDIS_ERR
; /* Already encoded */
2657 /* It's not save to encode shared objects: shared objects can be shared
2658 * everywhere in the "object space" of Redis. Encoded objects can only
2659 * appear as "values" (and not, for instance, as keys) */
2660 if (o
->refcount
> 1) return REDIS_ERR
;
2662 /* Currently we try to encode only strings */
2663 redisAssert(o
->type
== REDIS_STRING
);
2665 /* Check if we can represent this string as a long integer */
2666 if (isStringRepresentableAsLong(s
,&value
) == REDIS_ERR
) return REDIS_ERR
;
2668 /* Ok, this object can be encoded */
2669 o
->encoding
= REDIS_ENCODING_INT
;
2671 o
->ptr
= (void*) value
;
2675 /* Get a decoded version of an encoded object (returned as a new object).
2676 * If the object is already raw-encoded just increment the ref count. */
2677 static robj
*getDecodedObject(robj
*o
) {
2680 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2684 if (o
->type
== REDIS_STRING
&& o
->encoding
== REDIS_ENCODING_INT
) {
2687 snprintf(buf
,32,"%ld",(long)o
->ptr
);
2688 dec
= createStringObject(buf
,strlen(buf
));
2691 redisAssert(1 != 1);
2695 /* Compare two string objects via strcmp() or alike.
2696 * Note that the objects may be integer-encoded. In such a case we
2697 * use snprintf() to get a string representation of the numbers on the stack
2698 * and compare the strings, it's much faster than calling getDecodedObject().
2700 * Important note: if objects are not integer encoded, but binary-safe strings,
2701 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
2703 static int compareStringObjects(robj
*a
, robj
*b
) {
2704 redisAssert(a
->type
== REDIS_STRING
&& b
->type
== REDIS_STRING
);
2705 char bufa
[128], bufb
[128], *astr
, *bstr
;
2708 if (a
== b
) return 0;
2709 if (a
->encoding
!= REDIS_ENCODING_RAW
) {
2710 snprintf(bufa
,sizeof(bufa
),"%ld",(long) a
->ptr
);
2716 if (b
->encoding
!= REDIS_ENCODING_RAW
) {
2717 snprintf(bufb
,sizeof(bufb
),"%ld",(long) b
->ptr
);
2723 return bothsds
? sdscmp(astr
,bstr
) : strcmp(astr
,bstr
);
2726 static size_t stringObjectLen(robj
*o
) {
2727 redisAssert(o
->type
== REDIS_STRING
);
2728 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2729 return sdslen(o
->ptr
);
2733 return snprintf(buf
,32,"%ld",(long)o
->ptr
);
2737 /*============================ RDB saving/loading =========================== */
2739 static int rdbSaveType(FILE *fp
, unsigned char type
) {
2740 if (fwrite(&type
,1,1,fp
) == 0) return -1;
2744 static int rdbSaveTime(FILE *fp
, time_t t
) {
2745 int32_t t32
= (int32_t) t
;
2746 if (fwrite(&t32
,4,1,fp
) == 0) return -1;
2750 /* check rdbLoadLen() comments for more info */
2751 static int rdbSaveLen(FILE *fp
, uint32_t len
) {
2752 unsigned char buf
[2];
2755 /* Save a 6 bit len */
2756 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
2757 if (fwrite(buf
,1,1,fp
) == 0) return -1;
2758 } else if (len
< (1<<14)) {
2759 /* Save a 14 bit len */
2760 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
2762 if (fwrite(buf
,2,1,fp
) == 0) return -1;
2764 /* Save a 32 bit len */
2765 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
2766 if (fwrite(buf
,1,1,fp
) == 0) return -1;
2768 if (fwrite(&len
,4,1,fp
) == 0) return -1;
2773 /* String objects in the form "2391" "-100" without any space and with a
2774 * range of values that can fit in an 8, 16 or 32 bit signed value can be
2775 * encoded as integers to save space */
2776 static int rdbTryIntegerEncoding(sds s
, unsigned char *enc
) {
2778 char *endptr
, buf
[32];
2780 /* Check if it's possible to encode this value as a number */
2781 value
= strtoll(s
, &endptr
, 10);
2782 if (endptr
[0] != '\0') return 0;
2783 snprintf(buf
,32,"%lld",value
);
2785 /* If the number converted back into a string is not identical
2786 * then it's not possible to encode the string as integer */
2787 if (strlen(buf
) != sdslen(s
) || memcmp(buf
,s
,sdslen(s
))) return 0;
2789 /* Finally check if it fits in our ranges */
2790 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
2791 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
2792 enc
[1] = value
&0xFF;
2794 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
2795 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
2796 enc
[1] = value
&0xFF;
2797 enc
[2] = (value
>>8)&0xFF;
2799 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
2800 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
2801 enc
[1] = value
&0xFF;
2802 enc
[2] = (value
>>8)&0xFF;
2803 enc
[3] = (value
>>16)&0xFF;
2804 enc
[4] = (value
>>24)&0xFF;
2811 static int rdbSaveLzfStringObject(FILE *fp
, robj
*obj
) {
2812 unsigned int comprlen
, outlen
;
2816 /* We require at least four bytes compression for this to be worth it */
2817 outlen
= sdslen(obj
->ptr
)-4;
2818 if (outlen
<= 0) return 0;
2819 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
2820 printf("Calling LZF with ptr: %p\n", (void*)obj
->ptr
);
2822 comprlen
= lzf_compress(obj
->ptr
, sdslen(obj
->ptr
), out
, outlen
);
2823 if (comprlen
== 0) {
2827 /* Data compressed! Let's save it on disk */
2828 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
2829 if (fwrite(&byte
,1,1,fp
) == 0) goto writeerr
;
2830 if (rdbSaveLen(fp
,comprlen
) == -1) goto writeerr
;
2831 if (rdbSaveLen(fp
,sdslen(obj
->ptr
)) == -1) goto writeerr
;
2832 if (fwrite(out
,comprlen
,1,fp
) == 0) goto writeerr
;
2841 /* Save a string objet as [len][data] on disk. If the object is a string
2842 * representation of an integer value we try to safe it in a special form */
2843 static int rdbSaveStringObjectRaw(FILE *fp
, robj
*obj
) {
2847 len
= sdslen(obj
->ptr
);
2849 /* Try integer encoding */
2851 unsigned char buf
[5];
2852 if ((enclen
= rdbTryIntegerEncoding(obj
->ptr
,buf
)) > 0) {
2853 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
2858 /* Try LZF compression - under 20 bytes it's unable to compress even
2859 * aaaaaaaaaaaaaaaaaa so skip it */
2860 if (server
.rdbcompression
&& len
> 20) {
2863 retval
= rdbSaveLzfStringObject(fp
,obj
);
2864 if (retval
== -1) return -1;
2865 if (retval
> 0) return 0;
2866 /* retval == 0 means data can't be compressed, save the old way */
2869 /* Store verbatim */
2870 if (rdbSaveLen(fp
,len
) == -1) return -1;
2871 if (len
&& fwrite(obj
->ptr
,len
,1,fp
) == 0) return -1;
2875 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
2876 static int rdbSaveStringObject(FILE *fp
, robj
*obj
) {
2879 /* Avoid incr/decr ref count business when possible.
2880 * This plays well with copy-on-write given that we are probably
2881 * in a child process (BGSAVE). Also this makes sure key objects
2882 * of swapped objects are not incRefCount-ed (an assert does not allow
2883 * this in order to avoid bugs) */
2884 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
2885 obj
= getDecodedObject(obj
);
2886 retval
= rdbSaveStringObjectRaw(fp
,obj
);
2889 retval
= rdbSaveStringObjectRaw(fp
,obj
);
2894 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
2895 * 8 bit integer specifing the length of the representation.
2896 * This 8 bit integer has special values in order to specify the following
2902 static int rdbSaveDoubleValue(FILE *fp
, double val
) {
2903 unsigned char buf
[128];
2909 } else if (!isfinite(val
)) {
2911 buf
[0] = (val
< 0) ? 255 : 254;
2913 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
2914 buf
[0] = strlen((char*)buf
+1);
2917 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
2921 /* Save a Redis object. */
2922 static int rdbSaveObject(FILE *fp
, robj
*o
) {
2923 if (o
->type
== REDIS_STRING
) {
2924 /* Save a string value */
2925 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
2926 } else if (o
->type
== REDIS_LIST
) {
2927 /* Save a list value */
2928 list
*list
= o
->ptr
;
2932 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
2933 listRewind(list
,&li
);
2934 while((ln
= listNext(&li
))) {
2935 robj
*eleobj
= listNodeValue(ln
);
2937 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
2939 } else if (o
->type
== REDIS_SET
) {
2940 /* Save a set value */
2942 dictIterator
*di
= dictGetIterator(set
);
2945 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
2946 while((de
= dictNext(di
)) != NULL
) {
2947 robj
*eleobj
= dictGetEntryKey(de
);
2949 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
2951 dictReleaseIterator(di
);
2952 } else if (o
->type
== REDIS_ZSET
) {
2953 /* Save a set value */
2955 dictIterator
*di
= dictGetIterator(zs
->dict
);
2958 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
2959 while((de
= dictNext(di
)) != NULL
) {
2960 robj
*eleobj
= dictGetEntryKey(de
);
2961 double *score
= dictGetEntryVal(de
);
2963 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
2964 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
2966 dictReleaseIterator(di
);
2968 redisAssert(0 != 0);
2973 /* Return the length the object will have on disk if saved with
2974 * the rdbSaveObject() function. Currently we use a trick to get
2975 * this length with very little changes to the code. In the future
2976 * we could switch to a faster solution. */
2977 static off_t
rdbSavedObjectLen(robj
*o
, FILE *fp
) {
2978 if (fp
== NULL
) fp
= server
.devnull
;
2980 assert(rdbSaveObject(fp
,o
) != 1);
2984 /* Return the number of pages required to save this object in the swap file */
2985 static off_t
rdbSavedObjectPages(robj
*o
, FILE *fp
) {
2986 off_t bytes
= rdbSavedObjectLen(o
,fp
);
2988 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
2991 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
2992 static int rdbSave(char *filename
) {
2993 dictIterator
*di
= NULL
;
2998 time_t now
= time(NULL
);
3000 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
3001 fp
= fopen(tmpfile
,"w");
3003 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
3006 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
3007 for (j
= 0; j
< server
.dbnum
; j
++) {
3008 redisDb
*db
= server
.db
+j
;
3010 if (dictSize(d
) == 0) continue;
3011 di
= dictGetIterator(d
);
3017 /* Write the SELECT DB opcode */
3018 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
3019 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
3021 /* Iterate this DB writing every entry */
3022 while((de
= dictNext(di
)) != NULL
) {
3023 robj
*key
= dictGetEntryKey(de
);
3024 robj
*o
= dictGetEntryVal(de
);
3025 time_t expiretime
= getExpire(db
,key
);
3027 /* Save the expire time */
3028 if (expiretime
!= -1) {
3029 /* If this key is already expired skip it */
3030 if (expiretime
< now
) continue;
3031 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
3032 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
3034 /* Save the key and associated value. This requires special
3035 * handling if the value is swapped out. */
3036 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
3037 key
->storage
== REDIS_VM_SWAPPING
) {
3038 /* Save type, key, value */
3039 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
3040 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3041 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
3043 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3045 /* Get a preview of the object in memory */
3046 po
= vmPreviewObject(key
);
3047 /* Save type, key, value */
3048 if (rdbSaveType(fp
,key
->vtype
) == -1) goto werr
;
3049 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3050 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
3051 /* Remove the loaded object from memory */
3055 dictReleaseIterator(di
);
3058 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
3060 /* Make sure data will not remain on the OS's output buffers */
3065 /* Use RENAME to make sure the DB file is changed atomically only
3066 * if the generate DB file is ok. */
3067 if (rename(tmpfile
,filename
) == -1) {
3068 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
3072 redisLog(REDIS_NOTICE
,"DB saved on disk");
3074 server
.lastsave
= time(NULL
);
3080 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
3081 if (di
) dictReleaseIterator(di
);
3085 static int rdbSaveBackground(char *filename
) {
3088 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
3089 if (server
.vm_enabled
) waitZeroActiveThreads();
3090 if ((childpid
= fork()) == 0) {
3093 if (rdbSave(filename
) == REDIS_OK
) {
3100 if (childpid
== -1) {
3101 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
3105 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
3106 server
.bgsavechildpid
= childpid
;
3109 return REDIS_OK
; /* unreached */
3112 static void rdbRemoveTempFile(pid_t childpid
) {
3115 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
3119 static int rdbLoadType(FILE *fp
) {
3121 if (fread(&type
,1,1,fp
) == 0) return -1;
3125 static time_t rdbLoadTime(FILE *fp
) {
3127 if (fread(&t32
,4,1,fp
) == 0) return -1;
3128 return (time_t) t32
;
3131 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3132 * of this file for a description of how this are stored on disk.
3134 * isencoded is set to 1 if the readed length is not actually a length but
3135 * an "encoding type", check the above comments for more info */
3136 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
3137 unsigned char buf
[2];
3141 if (isencoded
) *isencoded
= 0;
3142 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3143 type
= (buf
[0]&0xC0)>>6;
3144 if (type
== REDIS_RDB_6BITLEN
) {
3145 /* Read a 6 bit len */
3147 } else if (type
== REDIS_RDB_ENCVAL
) {
3148 /* Read a 6 bit len encoding type */
3149 if (isencoded
) *isencoded
= 1;
3151 } else if (type
== REDIS_RDB_14BITLEN
) {
3152 /* Read a 14 bit len */
3153 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3154 return ((buf
[0]&0x3F)<<8)|buf
[1];
3156 /* Read a 32 bit len */
3157 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
3162 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
) {
3163 unsigned char enc
[4];
3166 if (enctype
== REDIS_RDB_ENC_INT8
) {
3167 if (fread(enc
,1,1,fp
) == 0) return NULL
;
3168 val
= (signed char)enc
[0];
3169 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
3171 if (fread(enc
,2,1,fp
) == 0) return NULL
;
3172 v
= enc
[0]|(enc
[1]<<8);
3174 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
3176 if (fread(enc
,4,1,fp
) == 0) return NULL
;
3177 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
3180 val
= 0; /* anti-warning */
3183 return createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",val
));
3186 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
3187 unsigned int len
, clen
;
3188 unsigned char *c
= NULL
;
3191 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3192 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3193 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
3194 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
3195 if (fread(c
,clen
,1,fp
) == 0) goto err
;
3196 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
3198 return createObject(REDIS_STRING
,val
);
3205 static robj
*rdbLoadStringObject(FILE*fp
) {
3210 len
= rdbLoadLen(fp
,&isencoded
);
3213 case REDIS_RDB_ENC_INT8
:
3214 case REDIS_RDB_ENC_INT16
:
3215 case REDIS_RDB_ENC_INT32
:
3216 return tryObjectSharing(rdbLoadIntegerObject(fp
,len
));
3217 case REDIS_RDB_ENC_LZF
:
3218 return tryObjectSharing(rdbLoadLzfStringObject(fp
));
3224 if (len
== REDIS_RDB_LENERR
) return NULL
;
3225 val
= sdsnewlen(NULL
,len
);
3226 if (len
&& fread(val
,len
,1,fp
) == 0) {
3230 return tryObjectSharing(createObject(REDIS_STRING
,val
));
3233 /* For information about double serialization check rdbSaveDoubleValue() */
3234 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
3238 if (fread(&len
,1,1,fp
) == 0) return -1;
3240 case 255: *val
= R_NegInf
; return 0;
3241 case 254: *val
= R_PosInf
; return 0;
3242 case 253: *val
= R_Nan
; return 0;
3244 if (fread(buf
,len
,1,fp
) == 0) return -1;
3246 sscanf(buf
, "%lg", val
);
3251 /* Load a Redis object of the specified type from the specified file.
3252 * On success a newly allocated object is returned, otherwise NULL. */
3253 static robj
*rdbLoadObject(int type
, FILE *fp
) {
3256 if (type
== REDIS_STRING
) {
3257 /* Read string value */
3258 if ((o
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3259 tryObjectEncoding(o
);
3260 } else if (type
== REDIS_LIST
|| type
== REDIS_SET
) {
3261 /* Read list/set value */
3264 if ((listlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3265 o
= (type
== REDIS_LIST
) ? createListObject() : createSetObject();
3266 /* Load every single element of the list/set */
3270 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3271 tryObjectEncoding(ele
);
3272 if (type
== REDIS_LIST
) {
3273 listAddNodeTail((list
*)o
->ptr
,ele
);
3275 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
3278 } else if (type
== REDIS_ZSET
) {
3279 /* Read list/set value */
3283 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3284 o
= createZsetObject();
3286 /* Load every single element of the list/set */
3289 double *score
= zmalloc(sizeof(double));
3291 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3292 tryObjectEncoding(ele
);
3293 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
3294 dictAdd(zs
->dict
,ele
,score
);
3295 zslInsert(zs
->zsl
,*score
,ele
);
3296 incrRefCount(ele
); /* added to skiplist */
3299 redisAssert(0 != 0);
3304 static int rdbLoad(char *filename
) {
3306 robj
*keyobj
= NULL
;
3308 int type
, retval
, rdbver
;
3309 dict
*d
= server
.db
[0].dict
;
3310 redisDb
*db
= server
.db
+0;
3312 time_t expiretime
= -1, now
= time(NULL
);
3313 long long loadedkeys
= 0;
3315 fp
= fopen(filename
,"r");
3316 if (!fp
) return REDIS_ERR
;
3317 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
3319 if (memcmp(buf
,"REDIS",5) != 0) {
3321 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
3324 rdbver
= atoi(buf
+5);
3327 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
3334 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3335 if (type
== REDIS_EXPIRETIME
) {
3336 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
3337 /* We read the time so we need to read the object type again */
3338 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3340 if (type
== REDIS_EOF
) break;
3341 /* Handle SELECT DB opcode as a special case */
3342 if (type
== REDIS_SELECTDB
) {
3343 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
3345 if (dbid
>= (unsigned)server
.dbnum
) {
3346 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
3349 db
= server
.db
+dbid
;
3354 if ((keyobj
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
3356 if ((o
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
3357 /* Add the new object in the hash table */
3358 retval
= dictAdd(d
,keyobj
,o
);
3359 if (retval
== DICT_ERR
) {
3360 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", keyobj
->ptr
);
3363 /* Set the expire time if needed */
3364 if (expiretime
!= -1) {
3365 setExpire(db
,keyobj
,expiretime
);
3366 /* Delete this key if already expired */
3367 if (expiretime
< now
) deleteKey(db
,keyobj
);
3371 /* Handle swapping while loading big datasets when VM is on */
3373 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
3374 while (zmalloc_used_memory() > server
.vm_max_memory
) {
3375 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
3382 eoferr
: /* unexpected end of file is handled here with a fatal exit */
3383 if (keyobj
) decrRefCount(keyobj
);
3384 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
3386 return REDIS_ERR
; /* Just to avoid warning */
3389 /*================================== Commands =============================== */
3391 static void authCommand(redisClient
*c
) {
3392 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
3393 c
->authenticated
= 1;
3394 addReply(c
,shared
.ok
);
3396 c
->authenticated
= 0;
3397 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
3401 static void pingCommand(redisClient
*c
) {
3402 addReply(c
,shared
.pong
);
3405 static void echoCommand(redisClient
*c
) {
3406 addReplyBulkLen(c
,c
->argv
[1]);
3407 addReply(c
,c
->argv
[1]);
3408 addReply(c
,shared
.crlf
);
3411 /*=================================== Strings =============================== */
3413 static void setGenericCommand(redisClient
*c
, int nx
) {
3416 if (nx
) deleteIfVolatile(c
->db
,c
->argv
[1]);
3417 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3418 if (retval
== DICT_ERR
) {
3420 /* If the key is about a swapped value, we want a new key object
3421 * to overwrite the old. So we delete the old key in the database.
3422 * This will also make sure that swap pages about the old object
3423 * will be marked as free. */
3424 if (deleteIfSwapped(c
->db
,c
->argv
[1]))
3425 incrRefCount(c
->argv
[1]);
3426 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3427 incrRefCount(c
->argv
[2]);
3429 addReply(c
,shared
.czero
);
3433 incrRefCount(c
->argv
[1]);
3434 incrRefCount(c
->argv
[2]);
3437 removeExpire(c
->db
,c
->argv
[1]);
3438 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3441 static void setCommand(redisClient
*c
) {
3442 setGenericCommand(c
,0);
3445 static void setnxCommand(redisClient
*c
) {
3446 setGenericCommand(c
,1);
3449 static int getGenericCommand(redisClient
*c
) {
3450 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[1]);
3453 addReply(c
,shared
.nullbulk
);
3456 if (o
->type
!= REDIS_STRING
) {
3457 addReply(c
,shared
.wrongtypeerr
);
3460 addReplyBulkLen(c
,o
);
3462 addReply(c
,shared
.crlf
);
3468 static void getCommand(redisClient
*c
) {
3469 getGenericCommand(c
);
3472 static void getsetCommand(redisClient
*c
) {
3473 if (getGenericCommand(c
) == REDIS_ERR
) return;
3474 if (dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]) == DICT_ERR
) {
3475 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3477 incrRefCount(c
->argv
[1]);
3479 incrRefCount(c
->argv
[2]);
3481 removeExpire(c
->db
,c
->argv
[1]);
3484 static void mgetCommand(redisClient
*c
) {
3487 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
3488 for (j
= 1; j
< c
->argc
; j
++) {
3489 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
3491 addReply(c
,shared
.nullbulk
);
3493 if (o
->type
!= REDIS_STRING
) {
3494 addReply(c
,shared
.nullbulk
);
3496 addReplyBulkLen(c
,o
);
3498 addReply(c
,shared
.crlf
);
3504 static void msetGenericCommand(redisClient
*c
, int nx
) {
3505 int j
, busykeys
= 0;
3507 if ((c
->argc
% 2) == 0) {
3508 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
3511 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
3512 * set nothing at all if at least one already key exists. */
3514 for (j
= 1; j
< c
->argc
; j
+= 2) {
3515 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
3521 addReply(c
, shared
.czero
);
3525 for (j
= 1; j
< c
->argc
; j
+= 2) {
3528 tryObjectEncoding(c
->argv
[j
+1]);
3529 retval
= dictAdd(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
3530 if (retval
== DICT_ERR
) {
3531 dictReplace(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
3532 incrRefCount(c
->argv
[j
+1]);
3534 incrRefCount(c
->argv
[j
]);
3535 incrRefCount(c
->argv
[j
+1]);
3537 removeExpire(c
->db
,c
->argv
[j
]);
3539 server
.dirty
+= (c
->argc
-1)/2;
3540 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3543 static void msetCommand(redisClient
*c
) {
3544 msetGenericCommand(c
,0);
3547 static void msetnxCommand(redisClient
*c
) {
3548 msetGenericCommand(c
,1);
3551 static void incrDecrCommand(redisClient
*c
, long long incr
) {
3556 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3560 if (o
->type
!= REDIS_STRING
) {
3565 if (o
->encoding
== REDIS_ENCODING_RAW
)
3566 value
= strtoll(o
->ptr
, &eptr
, 10);
3567 else if (o
->encoding
== REDIS_ENCODING_INT
)
3568 value
= (long)o
->ptr
;
3570 redisAssert(1 != 1);
3575 o
= createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
3576 tryObjectEncoding(o
);
3577 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],o
);
3578 if (retval
== DICT_ERR
) {
3579 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
3580 removeExpire(c
->db
,c
->argv
[1]);
3582 incrRefCount(c
->argv
[1]);
3585 addReply(c
,shared
.colon
);
3587 addReply(c
,shared
.crlf
);
3590 static void incrCommand(redisClient
*c
) {
3591 incrDecrCommand(c
,1);
3594 static void decrCommand(redisClient
*c
) {
3595 incrDecrCommand(c
,-1);
3598 static void incrbyCommand(redisClient
*c
) {
3599 long long incr
= strtoll(c
->argv
[2]->ptr
, NULL
, 10);
3600 incrDecrCommand(c
,incr
);
3603 static void decrbyCommand(redisClient
*c
) {
3604 long long incr
= strtoll(c
->argv
[2]->ptr
, NULL
, 10);
3605 incrDecrCommand(c
,-incr
);
3608 /* ========================= Type agnostic commands ========================= */
3610 static void delCommand(redisClient
*c
) {
3613 for (j
= 1; j
< c
->argc
; j
++) {
3614 if (deleteKey(c
->db
,c
->argv
[j
])) {
3621 addReply(c
,shared
.czero
);
3624 addReply(c
,shared
.cone
);
3627 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",deleted
));
3632 static void existsCommand(redisClient
*c
) {
3633 addReply(c
,lookupKeyRead(c
->db
,c
->argv
[1]) ? shared
.cone
: shared
.czero
);
3636 static void selectCommand(redisClient
*c
) {
3637 int id
= atoi(c
->argv
[1]->ptr
);
3639 if (selectDb(c
,id
) == REDIS_ERR
) {
3640 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
3642 addReply(c
,shared
.ok
);
3646 static void randomkeyCommand(redisClient
*c
) {
3650 de
= dictGetRandomKey(c
->db
->dict
);
3651 if (!de
|| expireIfNeeded(c
->db
,dictGetEntryKey(de
)) == 0) break;
3654 addReply(c
,shared
.plus
);
3655 addReply(c
,shared
.crlf
);
3657 addReply(c
,shared
.plus
);
3658 addReply(c
,dictGetEntryKey(de
));
3659 addReply(c
,shared
.crlf
);
3663 static void keysCommand(redisClient
*c
) {
3666 sds pattern
= c
->argv
[1]->ptr
;
3667 int plen
= sdslen(pattern
);
3668 unsigned long numkeys
= 0, keyslen
= 0;
3669 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
3671 di
= dictGetIterator(c
->db
->dict
);
3673 decrRefCount(lenobj
);
3674 while((de
= dictNext(di
)) != NULL
) {
3675 robj
*keyobj
= dictGetEntryKey(de
);
3677 sds key
= keyobj
->ptr
;
3678 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
3679 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
3680 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
3682 addReply(c
,shared
.space
);
3685 keyslen
+= sdslen(key
);
3689 dictReleaseIterator(di
);
3690 lenobj
->ptr
= sdscatprintf(sdsempty(),"$%lu\r\n",keyslen
+(numkeys
? (numkeys
-1) : 0));
3691 addReply(c
,shared
.crlf
);
3694 static void dbsizeCommand(redisClient
*c
) {
3696 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
3699 static void lastsaveCommand(redisClient
*c
) {
3701 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
3704 static void typeCommand(redisClient
*c
) {
3708 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
3713 case REDIS_STRING
: type
= "+string"; break;
3714 case REDIS_LIST
: type
= "+list"; break;
3715 case REDIS_SET
: type
= "+set"; break;
3716 case REDIS_ZSET
: type
= "+zset"; break;
3717 default: type
= "unknown"; break;
3720 addReplySds(c
,sdsnew(type
));
3721 addReply(c
,shared
.crlf
);
3724 static void saveCommand(redisClient
*c
) {
3725 if (server
.bgsavechildpid
!= -1) {
3726 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
3729 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
3730 addReply(c
,shared
.ok
);
3732 addReply(c
,shared
.err
);
3736 static void bgsaveCommand(redisClient
*c
) {
3737 if (server
.bgsavechildpid
!= -1) {
3738 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
3741 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
3742 char *status
= "+Background saving started\r\n";
3743 addReplySds(c
,sdsnew(status
));
3745 addReply(c
,shared
.err
);
3749 static void shutdownCommand(redisClient
*c
) {
3750 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
3751 /* Kill the saving child if there is a background saving in progress.
3752 We want to avoid race conditions, for instance our saving child may
3753 overwrite the synchronous saving did by SHUTDOWN. */
3754 if (server
.bgsavechildpid
!= -1) {
3755 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
3756 kill(server
.bgsavechildpid
,SIGKILL
);
3757 rdbRemoveTempFile(server
.bgsavechildpid
);
3759 if (server
.appendonly
) {
3760 /* Append only file: fsync() the AOF and exit */
3761 fsync(server
.appendfd
);
3764 /* Snapshotting. Perform a SYNC SAVE and exit */
3765 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
3766 if (server
.daemonize
)
3767 unlink(server
.pidfile
);
3768 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
3769 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
3772 /* Ooops.. error saving! The best we can do is to continue operating.
3773 * Note that if there was a background saving process, in the next
3774 * cron() Redis will be notified that the background saving aborted,
3775 * handling special stuff like slaves pending for synchronization... */
3776 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
3777 addReplySds(c
,sdsnew("-ERR can't quit, problems saving the DB\r\n"));
3782 static void renameGenericCommand(redisClient
*c
, int nx
) {
3785 /* To use the same key as src and dst is probably an error */
3786 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
3787 addReply(c
,shared
.sameobjecterr
);
3791 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3793 addReply(c
,shared
.nokeyerr
);
3797 deleteIfVolatile(c
->db
,c
->argv
[2]);
3798 if (dictAdd(c
->db
->dict
,c
->argv
[2],o
) == DICT_ERR
) {
3801 addReply(c
,shared
.czero
);
3804 dictReplace(c
->db
->dict
,c
->argv
[2],o
);
3806 incrRefCount(c
->argv
[2]);
3808 deleteKey(c
->db
,c
->argv
[1]);
3810 addReply(c
,nx
? shared
.cone
: shared
.ok
);
3813 static void renameCommand(redisClient
*c
) {
3814 renameGenericCommand(c
,0);
3817 static void renamenxCommand(redisClient
*c
) {
3818 renameGenericCommand(c
,1);
3821 static void moveCommand(redisClient
*c
) {
3826 /* Obtain source and target DB pointers */
3829 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
3830 addReply(c
,shared
.outofrangeerr
);
3834 selectDb(c
,srcid
); /* Back to the source DB */
3836 /* If the user is moving using as target the same
3837 * DB as the source DB it is probably an error. */
3839 addReply(c
,shared
.sameobjecterr
);
3843 /* Check if the element exists and get a reference */
3844 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3846 addReply(c
,shared
.czero
);
3850 /* Try to add the element to the target DB */
3851 deleteIfVolatile(dst
,c
->argv
[1]);
3852 if (dictAdd(dst
->dict
,c
->argv
[1],o
) == DICT_ERR
) {
3853 addReply(c
,shared
.czero
);
3856 incrRefCount(c
->argv
[1]);
3859 /* OK! key moved, free the entry in the source DB */
3860 deleteKey(src
,c
->argv
[1]);
3862 addReply(c
,shared
.cone
);
3865 /* =================================== Lists ================================ */
3866 static void pushGenericCommand(redisClient
*c
, int where
) {
3870 lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3872 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
3873 addReply(c
,shared
.ok
);
3876 lobj
= createListObject();
3878 if (where
== REDIS_HEAD
) {
3879 listAddNodeHead(list
,c
->argv
[2]);
3881 listAddNodeTail(list
,c
->argv
[2]);
3883 dictAdd(c
->db
->dict
,c
->argv
[1],lobj
);
3884 incrRefCount(c
->argv
[1]);
3885 incrRefCount(c
->argv
[2]);
3887 if (lobj
->type
!= REDIS_LIST
) {
3888 addReply(c
,shared
.wrongtypeerr
);
3891 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
3892 addReply(c
,shared
.ok
);
3896 if (where
== REDIS_HEAD
) {
3897 listAddNodeHead(list
,c
->argv
[2]);
3899 listAddNodeTail(list
,c
->argv
[2]);
3901 incrRefCount(c
->argv
[2]);
3904 addReply(c
,shared
.ok
);
3907 static void lpushCommand(redisClient
*c
) {
3908 pushGenericCommand(c
,REDIS_HEAD
);
3911 static void rpushCommand(redisClient
*c
) {
3912 pushGenericCommand(c
,REDIS_TAIL
);
3915 static void llenCommand(redisClient
*c
) {
3919 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
3921 addReply(c
,shared
.czero
);
3924 if (o
->type
!= REDIS_LIST
) {
3925 addReply(c
,shared
.wrongtypeerr
);
3928 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",listLength(l
)));
3933 static void lindexCommand(redisClient
*c
) {
3935 int index
= atoi(c
->argv
[2]->ptr
);
3937 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
3939 addReply(c
,shared
.nullbulk
);
3941 if (o
->type
!= REDIS_LIST
) {
3942 addReply(c
,shared
.wrongtypeerr
);
3944 list
*list
= o
->ptr
;
3947 ln
= listIndex(list
, index
);
3949 addReply(c
,shared
.nullbulk
);
3951 robj
*ele
= listNodeValue(ln
);
3952 addReplyBulkLen(c
,ele
);
3954 addReply(c
,shared
.crlf
);
3960 static void lsetCommand(redisClient
*c
) {
3962 int index
= atoi(c
->argv
[2]->ptr
);
3964 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3966 addReply(c
,shared
.nokeyerr
);
3968 if (o
->type
!= REDIS_LIST
) {
3969 addReply(c
,shared
.wrongtypeerr
);
3971 list
*list
= o
->ptr
;
3974 ln
= listIndex(list
, index
);
3976 addReply(c
,shared
.outofrangeerr
);
3978 robj
*ele
= listNodeValue(ln
);
3981 listNodeValue(ln
) = c
->argv
[3];
3982 incrRefCount(c
->argv
[3]);
3983 addReply(c
,shared
.ok
);
3990 static void popGenericCommand(redisClient
*c
, int where
) {
3993 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3995 addReply(c
,shared
.nullbulk
);
3997 if (o
->type
!= REDIS_LIST
) {
3998 addReply(c
,shared
.wrongtypeerr
);
4000 list
*list
= o
->ptr
;
4003 if (where
== REDIS_HEAD
)
4004 ln
= listFirst(list
);
4006 ln
= listLast(list
);
4009 addReply(c
,shared
.nullbulk
);
4011 robj
*ele
= listNodeValue(ln
);
4012 addReplyBulkLen(c
,ele
);
4014 addReply(c
,shared
.crlf
);
4015 listDelNode(list
,ln
);
4022 static void lpopCommand(redisClient
*c
) {
4023 popGenericCommand(c
,REDIS_HEAD
);
4026 static void rpopCommand(redisClient
*c
) {
4027 popGenericCommand(c
,REDIS_TAIL
);
4030 static void lrangeCommand(redisClient
*c
) {
4032 int start
= atoi(c
->argv
[2]->ptr
);
4033 int end
= atoi(c
->argv
[3]->ptr
);
4035 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4037 addReply(c
,shared
.nullmultibulk
);
4039 if (o
->type
!= REDIS_LIST
) {
4040 addReply(c
,shared
.wrongtypeerr
);
4042 list
*list
= o
->ptr
;
4044 int llen
= listLength(list
);
4048 /* convert negative indexes */
4049 if (start
< 0) start
= llen
+start
;
4050 if (end
< 0) end
= llen
+end
;
4051 if (start
< 0) start
= 0;
4052 if (end
< 0) end
= 0;
4054 /* indexes sanity checks */
4055 if (start
> end
|| start
>= llen
) {
4056 /* Out of range start or start > end result in empty list */
4057 addReply(c
,shared
.emptymultibulk
);
4060 if (end
>= llen
) end
= llen
-1;
4061 rangelen
= (end
-start
)+1;
4063 /* Return the result in form of a multi-bulk reply */
4064 ln
= listIndex(list
, start
);
4065 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
4066 for (j
= 0; j
< rangelen
; j
++) {
4067 ele
= listNodeValue(ln
);
4068 addReplyBulkLen(c
,ele
);
4070 addReply(c
,shared
.crlf
);
4077 static void ltrimCommand(redisClient
*c
) {
4079 int start
= atoi(c
->argv
[2]->ptr
);
4080 int end
= atoi(c
->argv
[3]->ptr
);
4082 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4084 addReply(c
,shared
.ok
);
4086 if (o
->type
!= REDIS_LIST
) {
4087 addReply(c
,shared
.wrongtypeerr
);
4089 list
*list
= o
->ptr
;
4091 int llen
= listLength(list
);
4092 int j
, ltrim
, rtrim
;
4094 /* convert negative indexes */
4095 if (start
< 0) start
= llen
+start
;
4096 if (end
< 0) end
= llen
+end
;
4097 if (start
< 0) start
= 0;
4098 if (end
< 0) end
= 0;
4100 /* indexes sanity checks */
4101 if (start
> end
|| start
>= llen
) {
4102 /* Out of range start or start > end result in empty list */
4106 if (end
>= llen
) end
= llen
-1;
4111 /* Remove list elements to perform the trim */
4112 for (j
= 0; j
< ltrim
; j
++) {
4113 ln
= listFirst(list
);
4114 listDelNode(list
,ln
);
4116 for (j
= 0; j
< rtrim
; j
++) {
4117 ln
= listLast(list
);
4118 listDelNode(list
,ln
);
4121 addReply(c
,shared
.ok
);
4126 static void lremCommand(redisClient
*c
) {
4129 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4131 addReply(c
,shared
.czero
);
4133 if (o
->type
!= REDIS_LIST
) {
4134 addReply(c
,shared
.wrongtypeerr
);
4136 list
*list
= o
->ptr
;
4137 listNode
*ln
, *next
;
4138 int toremove
= atoi(c
->argv
[2]->ptr
);
4143 toremove
= -toremove
;
4146 ln
= fromtail
? list
->tail
: list
->head
;
4148 robj
*ele
= listNodeValue(ln
);
4150 next
= fromtail
? ln
->prev
: ln
->next
;
4151 if (compareStringObjects(ele
,c
->argv
[3]) == 0) {
4152 listDelNode(list
,ln
);
4155 if (toremove
&& removed
== toremove
) break;
4159 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
4164 /* This is the semantic of this command:
4165 * RPOPLPUSH srclist dstlist:
4166 * IF LLEN(srclist) > 0
4167 * element = RPOP srclist
4168 * LPUSH dstlist element
4175 * The idea is to be able to get an element from a list in a reliable way
4176 * since the element is not just returned but pushed against another list
4177 * as well. This command was originally proposed by Ezra Zygmuntowicz.
4179 static void rpoplpushcommand(redisClient
*c
) {
4182 sobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4184 addReply(c
,shared
.nullbulk
);
4186 if (sobj
->type
!= REDIS_LIST
) {
4187 addReply(c
,shared
.wrongtypeerr
);
4189 list
*srclist
= sobj
->ptr
;
4190 listNode
*ln
= listLast(srclist
);
4193 addReply(c
,shared
.nullbulk
);
4195 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4196 robj
*ele
= listNodeValue(ln
);
4199 if (dobj
&& dobj
->type
!= REDIS_LIST
) {
4200 addReply(c
,shared
.wrongtypeerr
);
4204 /* Add the element to the target list (unless it's directly
4205 * passed to some BLPOP-ing client */
4206 if (!handleClientsWaitingListPush(c
,c
->argv
[2],ele
)) {
4208 /* Create the list if the key does not exist */
4209 dobj
= createListObject();
4210 dictAdd(c
->db
->dict
,c
->argv
[2],dobj
);
4211 incrRefCount(c
->argv
[2]);
4213 dstlist
= dobj
->ptr
;
4214 listAddNodeHead(dstlist
,ele
);
4218 /* Send the element to the client as reply as well */
4219 addReplyBulkLen(c
,ele
);
4221 addReply(c
,shared
.crlf
);
4223 /* Finally remove the element from the source list */
4224 listDelNode(srclist
,ln
);
4232 /* ==================================== Sets ================================ */
4234 static void saddCommand(redisClient
*c
) {
4237 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4239 set
= createSetObject();
4240 dictAdd(c
->db
->dict
,c
->argv
[1],set
);
4241 incrRefCount(c
->argv
[1]);
4243 if (set
->type
!= REDIS_SET
) {
4244 addReply(c
,shared
.wrongtypeerr
);
4248 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
4249 incrRefCount(c
->argv
[2]);
4251 addReply(c
,shared
.cone
);
4253 addReply(c
,shared
.czero
);
4257 static void sremCommand(redisClient
*c
) {
4260 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4262 addReply(c
,shared
.czero
);
4264 if (set
->type
!= REDIS_SET
) {
4265 addReply(c
,shared
.wrongtypeerr
);
4268 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
4270 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4271 addReply(c
,shared
.cone
);
4273 addReply(c
,shared
.czero
);
4278 static void smoveCommand(redisClient
*c
) {
4279 robj
*srcset
, *dstset
;
4281 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4282 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4284 /* If the source key does not exist return 0, if it's of the wrong type
4286 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
4287 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
4290 /* Error if the destination key is not a set as well */
4291 if (dstset
&& dstset
->type
!= REDIS_SET
) {
4292 addReply(c
,shared
.wrongtypeerr
);
4295 /* Remove the element from the source set */
4296 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
4297 /* Key not found in the src set! return zero */
4298 addReply(c
,shared
.czero
);
4302 /* Add the element to the destination set */
4304 dstset
= createSetObject();
4305 dictAdd(c
->db
->dict
,c
->argv
[2],dstset
);
4306 incrRefCount(c
->argv
[2]);
4308 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
4309 incrRefCount(c
->argv
[3]);
4310 addReply(c
,shared
.cone
);
4313 static void sismemberCommand(redisClient
*c
) {
4316 set
= lookupKeyRead(c
->db
,c
->argv
[1]);
4318 addReply(c
,shared
.czero
);
4320 if (set
->type
!= REDIS_SET
) {
4321 addReply(c
,shared
.wrongtypeerr
);
4324 if (dictFind(set
->ptr
,c
->argv
[2]))
4325 addReply(c
,shared
.cone
);
4327 addReply(c
,shared
.czero
);
4331 static void scardCommand(redisClient
*c
) {
4335 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4337 addReply(c
,shared
.czero
);
4340 if (o
->type
!= REDIS_SET
) {
4341 addReply(c
,shared
.wrongtypeerr
);
4344 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4350 static void spopCommand(redisClient
*c
) {
4354 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4356 addReply(c
,shared
.nullbulk
);
4358 if (set
->type
!= REDIS_SET
) {
4359 addReply(c
,shared
.wrongtypeerr
);
4362 de
= dictGetRandomKey(set
->ptr
);
4364 addReply(c
,shared
.nullbulk
);
4366 robj
*ele
= dictGetEntryKey(de
);
4368 addReplyBulkLen(c
,ele
);
4370 addReply(c
,shared
.crlf
);
4371 dictDelete(set
->ptr
,ele
);
4372 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4378 static void srandmemberCommand(redisClient
*c
) {
4382 set
= lookupKeyRead(c
->db
,c
->argv
[1]);
4384 addReply(c
,shared
.nullbulk
);
4386 if (set
->type
!= REDIS_SET
) {
4387 addReply(c
,shared
.wrongtypeerr
);
4390 de
= dictGetRandomKey(set
->ptr
);
4392 addReply(c
,shared
.nullbulk
);
4394 robj
*ele
= dictGetEntryKey(de
);
4396 addReplyBulkLen(c
,ele
);
4398 addReply(c
,shared
.crlf
);
4403 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
4404 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
4406 return dictSize(*d1
)-dictSize(*d2
);
4409 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
4410 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4413 robj
*lenobj
= NULL
, *dstset
= NULL
;
4414 unsigned long j
, cardinality
= 0;
4416 for (j
= 0; j
< setsnum
; j
++) {
4420 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4421 lookupKeyRead(c
->db
,setskeys
[j
]);
4425 if (deleteKey(c
->db
,dstkey
))
4427 addReply(c
,shared
.czero
);
4429 addReply(c
,shared
.nullmultibulk
);
4433 if (setobj
->type
!= REDIS_SET
) {
4435 addReply(c
,shared
.wrongtypeerr
);
4438 dv
[j
] = setobj
->ptr
;
4440 /* Sort sets from the smallest to largest, this will improve our
4441 * algorithm's performace */
4442 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
4444 /* The first thing we should output is the total number of elements...
4445 * since this is a multi-bulk write, but at this stage we don't know
4446 * the intersection set size, so we use a trick, append an empty object
4447 * to the output list and save the pointer to later modify it with the
4450 lenobj
= createObject(REDIS_STRING
,NULL
);
4452 decrRefCount(lenobj
);
4454 /* If we have a target key where to store the resulting set
4455 * create this key with an empty set inside */
4456 dstset
= createSetObject();
4459 /* Iterate all the elements of the first (smallest) set, and test
4460 * the element against all the other sets, if at least one set does
4461 * not include the element it is discarded */
4462 di
= dictGetIterator(dv
[0]);
4464 while((de
= dictNext(di
)) != NULL
) {
4467 for (j
= 1; j
< setsnum
; j
++)
4468 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
4470 continue; /* at least one set does not contain the member */
4471 ele
= dictGetEntryKey(de
);
4473 addReplyBulkLen(c
,ele
);
4475 addReply(c
,shared
.crlf
);
4478 dictAdd(dstset
->ptr
,ele
,NULL
);
4482 dictReleaseIterator(di
);
4485 /* Store the resulting set into the target */
4486 deleteKey(c
->db
,dstkey
);
4487 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4488 incrRefCount(dstkey
);
4492 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
4494 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4495 dictSize((dict
*)dstset
->ptr
)));
4501 static void sinterCommand(redisClient
*c
) {
4502 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
4505 static void sinterstoreCommand(redisClient
*c
) {
4506 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
4509 #define REDIS_OP_UNION 0
4510 #define REDIS_OP_DIFF 1
4512 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
4513 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4516 robj
*dstset
= NULL
;
4517 int j
, cardinality
= 0;
4519 for (j
= 0; j
< setsnum
; j
++) {
4523 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4524 lookupKeyRead(c
->db
,setskeys
[j
]);
4529 if (setobj
->type
!= REDIS_SET
) {
4531 addReply(c
,shared
.wrongtypeerr
);
4534 dv
[j
] = setobj
->ptr
;
4537 /* We need a temp set object to store our union. If the dstkey
4538 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
4539 * this set object will be the resulting object to set into the target key*/
4540 dstset
= createSetObject();
4542 /* Iterate all the elements of all the sets, add every element a single
4543 * time to the result set */
4544 for (j
= 0; j
< setsnum
; j
++) {
4545 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
4546 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
4548 di
= dictGetIterator(dv
[j
]);
4550 while((de
= dictNext(di
)) != NULL
) {
4553 /* dictAdd will not add the same element multiple times */
4554 ele
= dictGetEntryKey(de
);
4555 if (op
== REDIS_OP_UNION
|| j
== 0) {
4556 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
4560 } else if (op
== REDIS_OP_DIFF
) {
4561 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
4566 dictReleaseIterator(di
);
4568 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break; /* result set is empty */
4571 /* Output the content of the resulting set, if not in STORE mode */
4573 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
4574 di
= dictGetIterator(dstset
->ptr
);
4575 while((de
= dictNext(di
)) != NULL
) {
4578 ele
= dictGetEntryKey(de
);
4579 addReplyBulkLen(c
,ele
);
4581 addReply(c
,shared
.crlf
);
4583 dictReleaseIterator(di
);
4585 /* If we have a target key where to store the resulting set
4586 * create this key with the result set inside */
4587 deleteKey(c
->db
,dstkey
);
4588 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4589 incrRefCount(dstkey
);
4594 decrRefCount(dstset
);
4596 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4597 dictSize((dict
*)dstset
->ptr
)));
4603 static void sunionCommand(redisClient
*c
) {
4604 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
4607 static void sunionstoreCommand(redisClient
*c
) {
4608 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
4611 static void sdiffCommand(redisClient
*c
) {
4612 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
4615 static void sdiffstoreCommand(redisClient
*c
) {
4616 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
4619 /* ==================================== ZSets =============================== */
4621 /* ZSETs are ordered sets using two data structures to hold the same elements
4622 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
4625 * The elements are added to an hash table mapping Redis objects to scores.
4626 * At the same time the elements are added to a skip list mapping scores
4627 * to Redis objects (so objects are sorted by scores in this "view"). */
4629 /* This skiplist implementation is almost a C translation of the original
4630 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
4631 * Alternative to Balanced Trees", modified in three ways:
4632 * a) this implementation allows for repeated values.
4633 * b) the comparison is not just by key (our 'score') but by satellite data.
4634 * c) there is a back pointer, so it's a doubly linked list with the back
4635 * pointers being only at "level 1". This allows to traverse the list
4636 * from tail to head, useful for ZREVRANGE. */
4638 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
4639 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
4641 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
4647 static zskiplist
*zslCreate(void) {
4651 zsl
= zmalloc(sizeof(*zsl
));
4654 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
4655 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++)
4656 zsl
->header
->forward
[j
] = NULL
;
4657 zsl
->header
->backward
= NULL
;
4662 static void zslFreeNode(zskiplistNode
*node
) {
4663 decrRefCount(node
->obj
);
4664 zfree(node
->forward
);
4668 static void zslFree(zskiplist
*zsl
) {
4669 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
4671 zfree(zsl
->header
->forward
);
4674 next
= node
->forward
[0];
4681 static int zslRandomLevel(void) {
4683 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
4688 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
4689 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
4693 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4694 while (x
->forward
[i
] &&
4695 (x
->forward
[i
]->score
< score
||
4696 (x
->forward
[i
]->score
== score
&&
4697 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
4701 /* we assume the key is not already inside, since we allow duplicated
4702 * scores, and the re-insertion of score and redis object should never
4703 * happpen since the caller of zslInsert() should test in the hash table
4704 * if the element is already inside or not. */
4705 level
= zslRandomLevel();
4706 if (level
> zsl
->level
) {
4707 for (i
= zsl
->level
; i
< level
; i
++)
4708 update
[i
] = zsl
->header
;
4711 x
= zslCreateNode(level
,score
,obj
);
4712 for (i
= 0; i
< level
; i
++) {
4713 x
->forward
[i
] = update
[i
]->forward
[i
];
4714 update
[i
]->forward
[i
] = x
;
4716 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
4718 x
->forward
[0]->backward
= x
;
4724 /* Delete an element with matching score/object from the skiplist. */
4725 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
4726 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
4730 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4731 while (x
->forward
[i
] &&
4732 (x
->forward
[i
]->score
< score
||
4733 (x
->forward
[i
]->score
== score
&&
4734 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
4738 /* We may have multiple elements with the same score, what we need
4739 * is to find the element with both the right score and object. */
4741 if (x
&& score
== x
->score
&& compareStringObjects(x
->obj
,obj
) == 0) {
4742 for (i
= 0; i
< zsl
->level
; i
++) {
4743 if (update
[i
]->forward
[i
] != x
) break;
4744 update
[i
]->forward
[i
] = x
->forward
[i
];
4746 if (x
->forward
[0]) {
4747 x
->forward
[0]->backward
= (x
->backward
== zsl
->header
) ?
4750 zsl
->tail
= x
->backward
;
4753 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
4758 return 0; /* not found */
4760 return 0; /* not found */
4763 /* Delete all the elements with score between min and max from the skiplist.
4764 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
4765 * Note that this function takes the reference to the hash table view of the
4766 * sorted set, in order to remove the elements from the hash table too. */
4767 static unsigned long zslDeleteRange(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
4768 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
4769 unsigned long removed
= 0;
4773 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4774 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
4778 /* We may have multiple elements with the same score, what we need
4779 * is to find the element with both the right score and object. */
4781 while (x
&& x
->score
<= max
) {
4782 zskiplistNode
*next
;
4784 for (i
= 0; i
< zsl
->level
; i
++) {
4785 if (update
[i
]->forward
[i
] != x
) break;
4786 update
[i
]->forward
[i
] = x
->forward
[i
];
4788 if (x
->forward
[0]) {
4789 x
->forward
[0]->backward
= (x
->backward
== zsl
->header
) ?
4792 zsl
->tail
= x
->backward
;
4794 next
= x
->forward
[0];
4795 dictDelete(dict
,x
->obj
);
4797 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
4803 return removed
; /* not found */
4806 /* Find the first node having a score equal or greater than the specified one.
4807 * Returns NULL if there is no match. */
4808 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
4813 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4814 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
4817 /* We may have multiple elements with the same score, what we need
4818 * is to find the element with both the right score and object. */
4819 return x
->forward
[0];
4822 /* The actual Z-commands implementations */
4824 /* This generic command implements both ZADD and ZINCRBY.
4825 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
4826 * the increment if the operation is a ZINCRBY (doincrement == 1). */
4827 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
4832 zsetobj
= lookupKeyWrite(c
->db
,key
);
4833 if (zsetobj
== NULL
) {
4834 zsetobj
= createZsetObject();
4835 dictAdd(c
->db
->dict
,key
,zsetobj
);
4838 if (zsetobj
->type
!= REDIS_ZSET
) {
4839 addReply(c
,shared
.wrongtypeerr
);
4845 /* Ok now since we implement both ZADD and ZINCRBY here the code
4846 * needs to handle the two different conditions. It's all about setting
4847 * '*score', that is, the new score to set, to the right value. */
4848 score
= zmalloc(sizeof(double));
4852 /* Read the old score. If the element was not present starts from 0 */
4853 de
= dictFind(zs
->dict
,ele
);
4855 double *oldscore
= dictGetEntryVal(de
);
4856 *score
= *oldscore
+ scoreval
;
4864 /* What follows is a simple remove and re-insert operation that is common
4865 * to both ZADD and ZINCRBY... */
4866 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
4867 /* case 1: New element */
4868 incrRefCount(ele
); /* added to hash */
4869 zslInsert(zs
->zsl
,*score
,ele
);
4870 incrRefCount(ele
); /* added to skiplist */
4873 addReplyDouble(c
,*score
);
4875 addReply(c
,shared
.cone
);
4880 /* case 2: Score update operation */
4881 de
= dictFind(zs
->dict
,ele
);
4882 redisAssert(de
!= NULL
);
4883 oldscore
= dictGetEntryVal(de
);
4884 if (*score
!= *oldscore
) {
4887 /* Remove and insert the element in the skip list with new score */
4888 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
4889 redisAssert(deleted
!= 0);
4890 zslInsert(zs
->zsl
,*score
,ele
);
4892 /* Update the score in the hash table */
4893 dictReplace(zs
->dict
,ele
,score
);
4899 addReplyDouble(c
,*score
);
4901 addReply(c
,shared
.czero
);
4905 static void zaddCommand(redisClient
*c
) {
4908 scoreval
= strtod(c
->argv
[2]->ptr
,NULL
);
4909 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
4912 static void zincrbyCommand(redisClient
*c
) {
4915 scoreval
= strtod(c
->argv
[2]->ptr
,NULL
);
4916 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
4919 static void zremCommand(redisClient
*c
) {
4923 zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4924 if (zsetobj
== NULL
) {
4925 addReply(c
,shared
.czero
);
4931 if (zsetobj
->type
!= REDIS_ZSET
) {
4932 addReply(c
,shared
.wrongtypeerr
);
4936 de
= dictFind(zs
->dict
,c
->argv
[2]);
4938 addReply(c
,shared
.czero
);
4941 /* Delete from the skiplist */
4942 oldscore
= dictGetEntryVal(de
);
4943 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
4944 redisAssert(deleted
!= 0);
4946 /* Delete from the hash table */
4947 dictDelete(zs
->dict
,c
->argv
[2]);
4948 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
4950 addReply(c
,shared
.cone
);
4954 static void zremrangebyscoreCommand(redisClient
*c
) {
4955 double min
= strtod(c
->argv
[2]->ptr
,NULL
);
4956 double max
= strtod(c
->argv
[3]->ptr
,NULL
);
4960 zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4961 if (zsetobj
== NULL
) {
4962 addReply(c
,shared
.czero
);
4966 if (zsetobj
->type
!= REDIS_ZSET
) {
4967 addReply(c
,shared
.wrongtypeerr
);
4971 deleted
= zslDeleteRange(zs
->zsl
,min
,max
,zs
->dict
);
4972 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
4973 server
.dirty
+= deleted
;
4974 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",deleted
));
4978 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
4980 int start
= atoi(c
->argv
[2]->ptr
);
4981 int end
= atoi(c
->argv
[3]->ptr
);
4984 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
4986 } else if (c
->argc
>= 5) {
4987 addReply(c
,shared
.syntaxerr
);
4991 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4993 addReply(c
,shared
.nullmultibulk
);
4995 if (o
->type
!= REDIS_ZSET
) {
4996 addReply(c
,shared
.wrongtypeerr
);
4998 zset
*zsetobj
= o
->ptr
;
4999 zskiplist
*zsl
= zsetobj
->zsl
;
5002 int llen
= zsl
->length
;
5006 /* convert negative indexes */
5007 if (start
< 0) start
= llen
+start
;
5008 if (end
< 0) end
= llen
+end
;
5009 if (start
< 0) start
= 0;
5010 if (end
< 0) end
= 0;
5012 /* indexes sanity checks */
5013 if (start
> end
|| start
>= llen
) {
5014 /* Out of range start or start > end result in empty list */
5015 addReply(c
,shared
.emptymultibulk
);
5018 if (end
>= llen
) end
= llen
-1;
5019 rangelen
= (end
-start
)+1;
5021 /* Return the result in form of a multi-bulk reply */
5027 ln
= zsl
->header
->forward
[0];
5029 ln
= ln
->forward
[0];
5032 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
5033 withscores
? (rangelen
*2) : rangelen
));
5034 for (j
= 0; j
< rangelen
; j
++) {
5036 addReplyBulkLen(c
,ele
);
5038 addReply(c
,shared
.crlf
);
5040 addReplyDouble(c
,ln
->score
);
5041 ln
= reverse
? ln
->backward
: ln
->forward
[0];
5047 static void zrangeCommand(redisClient
*c
) {
5048 zrangeGenericCommand(c
,0);
5051 static void zrevrangeCommand(redisClient
*c
) {
5052 zrangeGenericCommand(c
,1);
5055 static void zrangebyscoreCommand(redisClient
*c
) {
5057 double min
= strtod(c
->argv
[2]->ptr
,NULL
);
5058 double max
= strtod(c
->argv
[3]->ptr
,NULL
);
5059 int offset
= 0, limit
= -1;
5061 if (c
->argc
!= 4 && c
->argc
!= 7) {
5063 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
5065 } else if (c
->argc
== 7 && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
5066 addReply(c
,shared
.syntaxerr
);
5068 } else if (c
->argc
== 7) {
5069 offset
= atoi(c
->argv
[5]->ptr
);
5070 limit
= atoi(c
->argv
[6]->ptr
);
5071 if (offset
< 0) offset
= 0;
5074 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5076 addReply(c
,shared
.nullmultibulk
);
5078 if (o
->type
!= REDIS_ZSET
) {
5079 addReply(c
,shared
.wrongtypeerr
);
5081 zset
*zsetobj
= o
->ptr
;
5082 zskiplist
*zsl
= zsetobj
->zsl
;
5085 unsigned int rangelen
= 0;
5087 /* Get the first node with the score >= min */
5088 ln
= zslFirstWithScore(zsl
,min
);
5090 /* No element matching the speciifed interval */
5091 addReply(c
,shared
.emptymultibulk
);
5095 /* We don't know in advance how many matching elements there
5096 * are in the list, so we push this object that will represent
5097 * the multi-bulk length in the output buffer, and will "fix"
5099 lenobj
= createObject(REDIS_STRING
,NULL
);
5101 decrRefCount(lenobj
);
5103 while(ln
&& ln
->score
<= max
) {
5106 ln
= ln
->forward
[0];
5109 if (limit
== 0) break;
5111 addReplyBulkLen(c
,ele
);
5113 addReply(c
,shared
.crlf
);
5114 ln
= ln
->forward
[0];
5116 if (limit
> 0) limit
--;
5118 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%d\r\n",rangelen
);
5123 static void zcardCommand(redisClient
*c
) {
5127 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5129 addReply(c
,shared
.czero
);
5132 if (o
->type
!= REDIS_ZSET
) {
5133 addReply(c
,shared
.wrongtypeerr
);
5136 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",zs
->zsl
->length
));
5141 static void zscoreCommand(redisClient
*c
) {
5145 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5147 addReply(c
,shared
.nullbulk
);
5150 if (o
->type
!= REDIS_ZSET
) {
5151 addReply(c
,shared
.wrongtypeerr
);
5156 de
= dictFind(zs
->dict
,c
->argv
[2]);
5158 addReply(c
,shared
.nullbulk
);
5160 double *score
= dictGetEntryVal(de
);
5162 addReplyDouble(c
,*score
);
5168 /* ========================= Non type-specific commands ==================== */
5170 static void flushdbCommand(redisClient
*c
) {
5171 server
.dirty
+= dictSize(c
->db
->dict
);
5172 dictEmpty(c
->db
->dict
);
5173 dictEmpty(c
->db
->expires
);
5174 addReply(c
,shared
.ok
);
5177 static void flushallCommand(redisClient
*c
) {
5178 server
.dirty
+= emptyDb();
5179 addReply(c
,shared
.ok
);
5180 rdbSave(server
.dbfilename
);
5184 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
5185 redisSortOperation
*so
= zmalloc(sizeof(*so
));
5187 so
->pattern
= pattern
;
5191 /* Return the value associated to the key with a name obtained
5192 * substituting the first occurence of '*' in 'pattern' with 'subst' */
5193 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
5197 int prefixlen
, sublen
, postfixlen
;
5198 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
5202 char buf
[REDIS_SORTKEY_MAX
+1];
5205 /* If the pattern is "#" return the substitution object itself in order
5206 * to implement the "SORT ... GET #" feature. */
5207 spat
= pattern
->ptr
;
5208 if (spat
[0] == '#' && spat
[1] == '\0') {
5212 /* The substitution object may be specially encoded. If so we create
5213 * a decoded object on the fly. Otherwise getDecodedObject will just
5214 * increment the ref count, that we'll decrement later. */
5215 subst
= getDecodedObject(subst
);
5218 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
5219 p
= strchr(spat
,'*');
5221 decrRefCount(subst
);
5226 sublen
= sdslen(ssub
);
5227 postfixlen
= sdslen(spat
)-(prefixlen
+1);
5228 memcpy(keyname
.buf
,spat
,prefixlen
);
5229 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
5230 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
5231 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
5232 keyname
.len
= prefixlen
+sublen
+postfixlen
;
5234 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2))
5235 decrRefCount(subst
);
5237 /* printf("lookup '%s' => %p\n", keyname.buf,de); */
5238 return lookupKeyRead(db
,&keyobj
);
5241 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
5242 * the additional parameter is not standard but a BSD-specific we have to
5243 * pass sorting parameters via the global 'server' structure */
5244 static int sortCompare(const void *s1
, const void *s2
) {
5245 const redisSortObject
*so1
= s1
, *so2
= s2
;
5248 if (!server
.sort_alpha
) {
5249 /* Numeric sorting. Here it's trivial as we precomputed scores */
5250 if (so1
->u
.score
> so2
->u
.score
) {
5252 } else if (so1
->u
.score
< so2
->u
.score
) {
5258 /* Alphanumeric sorting */
5259 if (server
.sort_bypattern
) {
5260 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
5261 /* At least one compare object is NULL */
5262 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
5264 else if (so1
->u
.cmpobj
== NULL
)
5269 /* We have both the objects, use strcoll */
5270 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
5273 /* Compare elements directly */
5276 dec1
= getDecodedObject(so1
->obj
);
5277 dec2
= getDecodedObject(so2
->obj
);
5278 cmp
= strcoll(dec1
->ptr
,dec2
->ptr
);
5283 return server
.sort_desc
? -cmp
: cmp
;
5286 /* The SORT command is the most complex command in Redis. Warning: this code
5287 * is optimized for speed and a bit less for readability */
5288 static void sortCommand(redisClient
*c
) {
5291 int desc
= 0, alpha
= 0;
5292 int limit_start
= 0, limit_count
= -1, start
, end
;
5293 int j
, dontsort
= 0, vectorlen
;
5294 int getop
= 0; /* GET operation counter */
5295 robj
*sortval
, *sortby
= NULL
, *storekey
= NULL
;
5296 redisSortObject
*vector
; /* Resulting vector to sort */
5298 /* Lookup the key to sort. It must be of the right types */
5299 sortval
= lookupKeyRead(c
->db
,c
->argv
[1]);
5300 if (sortval
== NULL
) {
5301 addReply(c
,shared
.nullmultibulk
);
5304 if (sortval
->type
!= REDIS_SET
&& sortval
->type
!= REDIS_LIST
&&
5305 sortval
->type
!= REDIS_ZSET
)
5307 addReply(c
,shared
.wrongtypeerr
);
5311 /* Create a list of operations to perform for every sorted element.
5312 * Operations can be GET/DEL/INCR/DECR */
5313 operations
= listCreate();
5314 listSetFreeMethod(operations
,zfree
);
5317 /* Now we need to protect sortval incrementing its count, in the future
5318 * SORT may have options able to overwrite/delete keys during the sorting
5319 * and the sorted key itself may get destroied */
5320 incrRefCount(sortval
);
5322 /* The SORT command has an SQL-alike syntax, parse it */
5323 while(j
< c
->argc
) {
5324 int leftargs
= c
->argc
-j
-1;
5325 if (!strcasecmp(c
->argv
[j
]->ptr
,"asc")) {
5327 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"desc")) {
5329 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"alpha")) {
5331 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"limit") && leftargs
>= 2) {
5332 limit_start
= atoi(c
->argv
[j
+1]->ptr
);
5333 limit_count
= atoi(c
->argv
[j
+2]->ptr
);
5335 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"store") && leftargs
>= 1) {
5336 storekey
= c
->argv
[j
+1];
5338 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"by") && leftargs
>= 1) {
5339 sortby
= c
->argv
[j
+1];
5340 /* If the BY pattern does not contain '*', i.e. it is constant,
5341 * we don't need to sort nor to lookup the weight keys. */
5342 if (strchr(c
->argv
[j
+1]->ptr
,'*') == NULL
) dontsort
= 1;
5344 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"get") && leftargs
>= 1) {
5345 listAddNodeTail(operations
,createSortOperation(
5346 REDIS_SORT_GET
,c
->argv
[j
+1]));
5350 decrRefCount(sortval
);
5351 listRelease(operations
);
5352 addReply(c
,shared
.syntaxerr
);
5358 /* Load the sorting vector with all the objects to sort */
5359 switch(sortval
->type
) {
5360 case REDIS_LIST
: vectorlen
= listLength((list
*)sortval
->ptr
); break;
5361 case REDIS_SET
: vectorlen
= dictSize((dict
*)sortval
->ptr
); break;
5362 case REDIS_ZSET
: vectorlen
= dictSize(((zset
*)sortval
->ptr
)->dict
); break;
5363 default: vectorlen
= 0; redisAssert(0); /* Avoid GCC warning */
5365 vector
= zmalloc(sizeof(redisSortObject
)*vectorlen
);
5368 if (sortval
->type
== REDIS_LIST
) {
5369 list
*list
= sortval
->ptr
;
5373 listRewind(list
,&li
);
5374 while((ln
= listNext(&li
))) {
5375 robj
*ele
= ln
->value
;
5376 vector
[j
].obj
= ele
;
5377 vector
[j
].u
.score
= 0;
5378 vector
[j
].u
.cmpobj
= NULL
;
5386 if (sortval
->type
== REDIS_SET
) {
5389 zset
*zs
= sortval
->ptr
;
5393 di
= dictGetIterator(set
);
5394 while((setele
= dictNext(di
)) != NULL
) {
5395 vector
[j
].obj
= dictGetEntryKey(setele
);
5396 vector
[j
].u
.score
= 0;
5397 vector
[j
].u
.cmpobj
= NULL
;
5400 dictReleaseIterator(di
);
5402 redisAssert(j
== vectorlen
);
5404 /* Now it's time to load the right scores in the sorting vector */
5405 if (dontsort
== 0) {
5406 for (j
= 0; j
< vectorlen
; j
++) {
5410 byval
= lookupKeyByPattern(c
->db
,sortby
,vector
[j
].obj
);
5411 if (!byval
|| byval
->type
!= REDIS_STRING
) continue;
5413 vector
[j
].u
.cmpobj
= getDecodedObject(byval
);
5415 if (byval
->encoding
== REDIS_ENCODING_RAW
) {
5416 vector
[j
].u
.score
= strtod(byval
->ptr
,NULL
);
5418 /* Don't need to decode the object if it's
5419 * integer-encoded (the only encoding supported) so
5420 * far. We can just cast it */
5421 if (byval
->encoding
== REDIS_ENCODING_INT
) {
5422 vector
[j
].u
.score
= (long)byval
->ptr
;
5424 redisAssert(1 != 1);
5429 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_RAW
)
5430 vector
[j
].u
.score
= strtod(vector
[j
].obj
->ptr
,NULL
);
5432 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_INT
)
5433 vector
[j
].u
.score
= (long) vector
[j
].obj
->ptr
;
5435 redisAssert(1 != 1);
5442 /* We are ready to sort the vector... perform a bit of sanity check
5443 * on the LIMIT option too. We'll use a partial version of quicksort. */
5444 start
= (limit_start
< 0) ? 0 : limit_start
;
5445 end
= (limit_count
< 0) ? vectorlen
-1 : start
+limit_count
-1;
5446 if (start
>= vectorlen
) {
5447 start
= vectorlen
-1;
5450 if (end
>= vectorlen
) end
= vectorlen
-1;
5452 if (dontsort
== 0) {
5453 server
.sort_desc
= desc
;
5454 server
.sort_alpha
= alpha
;
5455 server
.sort_bypattern
= sortby
? 1 : 0;
5456 if (sortby
&& (start
!= 0 || end
!= vectorlen
-1))
5457 pqsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
, start
,end
);
5459 qsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
);
5462 /* Send command output to the output buffer, performing the specified
5463 * GET/DEL/INCR/DECR operations if any. */
5464 outputlen
= getop
? getop
*(end
-start
+1) : end
-start
+1;
5465 if (storekey
== NULL
) {
5466 /* STORE option not specified, sent the sorting result to client */
5467 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",outputlen
));
5468 for (j
= start
; j
<= end
; j
++) {
5473 addReplyBulkLen(c
,vector
[j
].obj
);
5474 addReply(c
,vector
[j
].obj
);
5475 addReply(c
,shared
.crlf
);
5477 listRewind(operations
,&li
);
5478 while((ln
= listNext(&li
))) {
5479 redisSortOperation
*sop
= ln
->value
;
5480 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
5483 if (sop
->type
== REDIS_SORT_GET
) {
5484 if (!val
|| val
->type
!= REDIS_STRING
) {
5485 addReply(c
,shared
.nullbulk
);
5487 addReplyBulkLen(c
,val
);
5489 addReply(c
,shared
.crlf
);
5492 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
5497 robj
*listObject
= createListObject();
5498 list
*listPtr
= (list
*) listObject
->ptr
;
5500 /* STORE option specified, set the sorting result as a List object */
5501 for (j
= start
; j
<= end
; j
++) {
5506 listAddNodeTail(listPtr
,vector
[j
].obj
);
5507 incrRefCount(vector
[j
].obj
);
5509 listRewind(operations
,&li
);
5510 while((ln
= listNext(&li
))) {
5511 redisSortOperation
*sop
= ln
->value
;
5512 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
5515 if (sop
->type
== REDIS_SORT_GET
) {
5516 if (!val
|| val
->type
!= REDIS_STRING
) {
5517 listAddNodeTail(listPtr
,createStringObject("",0));
5519 listAddNodeTail(listPtr
,val
);
5523 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
5527 if (dictReplace(c
->db
->dict
,storekey
,listObject
)) {
5528 incrRefCount(storekey
);
5530 /* Note: we add 1 because the DB is dirty anyway since even if the
5531 * SORT result is empty a new key is set and maybe the old content
5533 server
.dirty
+= 1+outputlen
;
5534 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",outputlen
));
5538 decrRefCount(sortval
);
5539 listRelease(operations
);
5540 for (j
= 0; j
< vectorlen
; j
++) {
5541 if (sortby
&& alpha
&& vector
[j
].u
.cmpobj
)
5542 decrRefCount(vector
[j
].u
.cmpobj
);
5547 /* Convert an amount of bytes into a human readable string in the form
5548 * of 100B, 2G, 100M, 4K, and so forth. */
5549 static void bytesToHuman(char *s
, unsigned long long n
) {
5554 sprintf(s
,"%lluB",n
);
5556 } else if (n
< (1024*1024)) {
5557 d
= (double)n
/(1024);
5558 sprintf(s
,"%.2fK",d
);
5559 } else if (n
< (1024LL*1024*1024)) {
5560 d
= (double)n
/(1024*1024);
5561 sprintf(s
,"%.2fM",d
);
5562 } else if (n
< (1024LL*1024*1024*1024)) {
5563 d
= (double)n
/(1024LL*1024*1024);
5564 sprintf(s
,"%.2fM",d
);
5568 /* Create the string returned by the INFO command. This is decoupled
5569 * by the INFO command itself as we need to report the same information
5570 * on memory corruption problems. */
5571 static sds
genRedisInfoString(void) {
5573 time_t uptime
= time(NULL
)-server
.stat_starttime
;
5577 bytesToHuman(hmem
,server
.usedmemory
);
5578 info
= sdscatprintf(sdsempty(),
5579 "redis_version:%s\r\n"
5581 "multiplexing_api:%s\r\n"
5582 "process_id:%ld\r\n"
5583 "uptime_in_seconds:%ld\r\n"
5584 "uptime_in_days:%ld\r\n"
5585 "connected_clients:%d\r\n"
5586 "connected_slaves:%d\r\n"
5587 "blocked_clients:%d\r\n"
5588 "used_memory:%zu\r\n"
5589 "used_memory_human:%s\r\n"
5590 "changes_since_last_save:%lld\r\n"
5591 "bgsave_in_progress:%d\r\n"
5592 "last_save_time:%ld\r\n"
5593 "bgrewriteaof_in_progress:%d\r\n"
5594 "total_connections_received:%lld\r\n"
5595 "total_commands_processed:%lld\r\n"
5599 (sizeof(long) == 8) ? "64" : "32",
5604 listLength(server
.clients
)-listLength(server
.slaves
),
5605 listLength(server
.slaves
),
5606 server
.blockedclients
,
5610 server
.bgsavechildpid
!= -1,
5612 server
.bgrewritechildpid
!= -1,
5613 server
.stat_numconnections
,
5614 server
.stat_numcommands
,
5615 server
.vm_enabled
!= 0,
5616 server
.masterhost
== NULL
? "master" : "slave"
5618 if (server
.masterhost
) {
5619 info
= sdscatprintf(info
,
5620 "master_host:%s\r\n"
5621 "master_port:%d\r\n"
5622 "master_link_status:%s\r\n"
5623 "master_last_io_seconds_ago:%d\r\n"
5626 (server
.replstate
== REDIS_REPL_CONNECTED
) ?
5628 server
.master
? ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1
5631 if (server
.vm_enabled
) {
5632 info
= sdscatprintf(info
,
5633 "vm_conf_max_memory:%llu\r\n"
5634 "vm_conf_page_size:%llu\r\n"
5635 "vm_conf_pages:%llu\r\n"
5636 "vm_stats_used_pages:%llu\r\n"
5637 "vm_stats_swapped_objects:%llu\r\n"
5638 "vm_stats_swappin_count:%llu\r\n"
5639 "vm_stats_swappout_count:%llu\r\n"
5640 "vm_stats_io_newjobs_len:%lu\r\n"
5641 "vm_stats_io_processing_len:%lu\r\n"
5642 "vm_stats_io_processed_len:%lu\r\n"
5643 "vm_stats_io_waiting_clients:%lu\r\n"
5644 "vm_stats_io_active_threads:%lu\r\n"
5645 ,(unsigned long long) server
.vm_max_memory
,
5646 (unsigned long long) server
.vm_page_size
,
5647 (unsigned long long) server
.vm_pages
,
5648 (unsigned long long) server
.vm_stats_used_pages
,
5649 (unsigned long long) server
.vm_stats_swapped_objects
,
5650 (unsigned long long) server
.vm_stats_swapins
,
5651 (unsigned long long) server
.vm_stats_swapouts
,
5652 (unsigned long) listLength(server
.io_newjobs
),
5653 (unsigned long) listLength(server
.io_processing
),
5654 (unsigned long) listLength(server
.io_processed
),
5655 (unsigned long) listLength(server
.io_clients
),
5656 (unsigned long) server
.io_active_threads
5659 for (j
= 0; j
< server
.dbnum
; j
++) {
5660 long long keys
, vkeys
;
5662 keys
= dictSize(server
.db
[j
].dict
);
5663 vkeys
= dictSize(server
.db
[j
].expires
);
5664 if (keys
|| vkeys
) {
5665 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
5672 static void infoCommand(redisClient
*c
) {
5673 sds info
= genRedisInfoString();
5674 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
5675 (unsigned long)sdslen(info
)));
5676 addReplySds(c
,info
);
5677 addReply(c
,shared
.crlf
);
5680 static void monitorCommand(redisClient
*c
) {
5681 /* ignore MONITOR if aleady slave or in monitor mode */
5682 if (c
->flags
& REDIS_SLAVE
) return;
5684 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
5686 listAddNodeTail(server
.monitors
,c
);
5687 addReply(c
,shared
.ok
);
5690 /* ================================= Expire ================================= */
5691 static int removeExpire(redisDb
*db
, robj
*key
) {
5692 if (dictDelete(db
->expires
,key
) == DICT_OK
) {
5699 static int setExpire(redisDb
*db
, robj
*key
, time_t when
) {
5700 if (dictAdd(db
->expires
,key
,(void*)when
) == DICT_ERR
) {
5708 /* Return the expire time of the specified key, or -1 if no expire
5709 * is associated with this key (i.e. the key is non volatile) */
5710 static time_t getExpire(redisDb
*db
, robj
*key
) {
5713 /* No expire? return ASAP */
5714 if (dictSize(db
->expires
) == 0 ||
5715 (de
= dictFind(db
->expires
,key
)) == NULL
) return -1;
5717 return (time_t) dictGetEntryVal(de
);
5720 static int expireIfNeeded(redisDb
*db
, robj
*key
) {
5724 /* No expire? return ASAP */
5725 if (dictSize(db
->expires
) == 0 ||
5726 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
5728 /* Lookup the expire */
5729 when
= (time_t) dictGetEntryVal(de
);
5730 if (time(NULL
) <= when
) return 0;
5732 /* Delete the key */
5733 dictDelete(db
->expires
,key
);
5734 return dictDelete(db
->dict
,key
) == DICT_OK
;
5737 static int deleteIfVolatile(redisDb
*db
, robj
*key
) {
5740 /* No expire? return ASAP */
5741 if (dictSize(db
->expires
) == 0 ||
5742 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
5744 /* Delete the key */
5746 dictDelete(db
->expires
,key
);
5747 return dictDelete(db
->dict
,key
) == DICT_OK
;
5750 static void expireGenericCommand(redisClient
*c
, robj
*key
, time_t seconds
) {
5753 de
= dictFind(c
->db
->dict
,key
);
5755 addReply(c
,shared
.czero
);
5759 if (deleteKey(c
->db
,key
)) server
.dirty
++;
5760 addReply(c
, shared
.cone
);
5763 time_t when
= time(NULL
)+seconds
;
5764 if (setExpire(c
->db
,key
,when
)) {
5765 addReply(c
,shared
.cone
);
5768 addReply(c
,shared
.czero
);
5774 static void expireCommand(redisClient
*c
) {
5775 expireGenericCommand(c
,c
->argv
[1],strtol(c
->argv
[2]->ptr
,NULL
,10));
5778 static void expireatCommand(redisClient
*c
) {
5779 expireGenericCommand(c
,c
->argv
[1],strtol(c
->argv
[2]->ptr
,NULL
,10)-time(NULL
));
5782 static void ttlCommand(redisClient
*c
) {
5786 expire
= getExpire(c
->db
,c
->argv
[1]);
5788 ttl
= (int) (expire
-time(NULL
));
5789 if (ttl
< 0) ttl
= -1;
5791 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",ttl
));
5794 /* ================================ MULTI/EXEC ============================== */
5796 /* Client state initialization for MULTI/EXEC */
5797 static void initClientMultiState(redisClient
*c
) {
5798 c
->mstate
.commands
= NULL
;
5799 c
->mstate
.count
= 0;
5802 /* Release all the resources associated with MULTI/EXEC state */
5803 static void freeClientMultiState(redisClient
*c
) {
5806 for (j
= 0; j
< c
->mstate
.count
; j
++) {
5808 multiCmd
*mc
= c
->mstate
.commands
+j
;
5810 for (i
= 0; i
< mc
->argc
; i
++)
5811 decrRefCount(mc
->argv
[i
]);
5814 zfree(c
->mstate
.commands
);
5817 /* Add a new command into the MULTI commands queue */
5818 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
) {
5822 c
->mstate
.commands
= zrealloc(c
->mstate
.commands
,
5823 sizeof(multiCmd
)*(c
->mstate
.count
+1));
5824 mc
= c
->mstate
.commands
+c
->mstate
.count
;
5827 mc
->argv
= zmalloc(sizeof(robj
*)*c
->argc
);
5828 memcpy(mc
->argv
,c
->argv
,sizeof(robj
*)*c
->argc
);
5829 for (j
= 0; j
< c
->argc
; j
++)
5830 incrRefCount(mc
->argv
[j
]);
5834 static void multiCommand(redisClient
*c
) {
5835 c
->flags
|= REDIS_MULTI
;
5836 addReply(c
,shared
.ok
);
5839 static void execCommand(redisClient
*c
) {
5844 if (!(c
->flags
& REDIS_MULTI
)) {
5845 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
5849 orig_argv
= c
->argv
;
5850 orig_argc
= c
->argc
;
5851 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
5852 for (j
= 0; j
< c
->mstate
.count
; j
++) {
5853 c
->argc
= c
->mstate
.commands
[j
].argc
;
5854 c
->argv
= c
->mstate
.commands
[j
].argv
;
5855 call(c
,c
->mstate
.commands
[j
].cmd
);
5857 c
->argv
= orig_argv
;
5858 c
->argc
= orig_argc
;
5859 freeClientMultiState(c
);
5860 initClientMultiState(c
);
5861 c
->flags
&= (~REDIS_MULTI
);
5864 /* =========================== Blocking Operations ========================= */
5866 /* Currently Redis blocking operations support is limited to list POP ops,
5867 * so the current implementation is not fully generic, but it is also not
5868 * completely specific so it will not require a rewrite to support new
5869 * kind of blocking operations in the future.
5871 * Still it's important to note that list blocking operations can be already
5872 * used as a notification mechanism in order to implement other blocking
5873 * operations at application level, so there must be a very strong evidence
5874 * of usefulness and generality before new blocking operations are implemented.
5876 * This is how the current blocking POP works, we use BLPOP as example:
5877 * - If the user calls BLPOP and the key exists and contains a non empty list
5878 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
5879 * if there is not to block.
5880 * - If instead BLPOP is called and the key does not exists or the list is
5881 * empty we need to block. In order to do so we remove the notification for
5882 * new data to read in the client socket (so that we'll not serve new
5883 * requests if the blocking request is not served). Also we put the client
5884 * in a dictionary (db->blockingkeys) mapping keys to a list of clients
5885 * blocking for this keys.
5886 * - If a PUSH operation against a key with blocked clients waiting is
5887 * performed, we serve the first in the list: basically instead to push
5888 * the new element inside the list we return it to the (first / oldest)
5889 * blocking client, unblock the client, and remove it form the list.
5891 * The above comment and the source code should be enough in order to understand
5892 * the implementation and modify / fix it later.
5895 /* Set a client in blocking mode for the specified key, with the specified
5897 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
5902 c
->blockingkeys
= zmalloc(sizeof(robj
*)*numkeys
);
5903 c
->blockingkeysnum
= numkeys
;
5904 c
->blockingto
= timeout
;
5905 for (j
= 0; j
< numkeys
; j
++) {
5906 /* Add the key in the client structure, to map clients -> keys */
5907 c
->blockingkeys
[j
] = keys
[j
];
5908 incrRefCount(keys
[j
]);
5910 /* And in the other "side", to map keys -> clients */
5911 de
= dictFind(c
->db
->blockingkeys
,keys
[j
]);
5915 /* For every key we take a list of clients blocked for it */
5917 retval
= dictAdd(c
->db
->blockingkeys
,keys
[j
],l
);
5918 incrRefCount(keys
[j
]);
5919 assert(retval
== DICT_OK
);
5921 l
= dictGetEntryVal(de
);
5923 listAddNodeTail(l
,c
);
5925 /* Mark the client as a blocked client */
5926 c
->flags
|= REDIS_BLOCKED
;
5927 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
5928 server
.blockedclients
++;
5931 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
5932 static void unblockClient(redisClient
*c
) {
5937 assert(c
->blockingkeys
!= NULL
);
5938 /* The client may wait for multiple keys, so unblock it for every key. */
5939 for (j
= 0; j
< c
->blockingkeysnum
; j
++) {
5940 /* Remove this client from the list of clients waiting for this key. */
5941 de
= dictFind(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
5943 l
= dictGetEntryVal(de
);
5944 listDelNode(l
,listSearchKey(l
,c
));
5945 /* If the list is empty we need to remove it to avoid wasting memory */
5946 if (listLength(l
) == 0)
5947 dictDelete(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
5948 decrRefCount(c
->blockingkeys
[j
]);
5950 /* Cleanup the client structure */
5951 zfree(c
->blockingkeys
);
5952 c
->blockingkeys
= NULL
;
5953 c
->flags
&= (~REDIS_BLOCKED
);
5954 server
.blockedclients
--;
5955 /* Ok now we are ready to get read events from socket, note that we
5956 * can't trap errors here as it's possible that unblockClients() is
5957 * called from freeClient() itself, and the only thing we can do
5958 * if we failed to register the READABLE event is to kill the client.
5959 * Still the following function should never fail in the real world as
5960 * we are sure the file descriptor is sane, and we exit on out of mem. */
5961 aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
, readQueryFromClient
, c
);
5962 /* As a final step we want to process data if there is some command waiting
5963 * in the input buffer. Note that this is safe even if unblockClient()
5964 * gets called from freeClient() because freeClient() will be smart
5965 * enough to call this function *after* c->querybuf was set to NULL. */
5966 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
5969 /* This should be called from any function PUSHing into lists.
5970 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
5971 * 'ele' is the element pushed.
5973 * If the function returns 0 there was no client waiting for a list push
5976 * If the function returns 1 there was a client waiting for a list push
5977 * against this key, the element was passed to this client thus it's not
5978 * needed to actually add it to the list and the caller should return asap. */
5979 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
5980 struct dictEntry
*de
;
5981 redisClient
*receiver
;
5985 de
= dictFind(c
->db
->blockingkeys
,key
);
5986 if (de
== NULL
) return 0;
5987 l
= dictGetEntryVal(de
);
5990 receiver
= ln
->value
;
5992 addReplySds(receiver
,sdsnew("*2\r\n"));
5993 addReplyBulkLen(receiver
,key
);
5994 addReply(receiver
,key
);
5995 addReply(receiver
,shared
.crlf
);
5996 addReplyBulkLen(receiver
,ele
);
5997 addReply(receiver
,ele
);
5998 addReply(receiver
,shared
.crlf
);
5999 unblockClient(receiver
);
6003 /* Blocking RPOP/LPOP */
6004 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
6009 for (j
= 1; j
< c
->argc
-1; j
++) {
6010 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
6012 if (o
->type
!= REDIS_LIST
) {
6013 addReply(c
,shared
.wrongtypeerr
);
6016 list
*list
= o
->ptr
;
6017 if (listLength(list
) != 0) {
6018 /* If the list contains elements fall back to the usual
6019 * non-blocking POP operation */
6020 robj
*argv
[2], **orig_argv
;
6023 /* We need to alter the command arguments before to call
6024 * popGenericCommand() as the command takes a single key. */
6025 orig_argv
= c
->argv
;
6026 orig_argc
= c
->argc
;
6027 argv
[1] = c
->argv
[j
];
6031 /* Also the return value is different, we need to output
6032 * the multi bulk reply header and the key name. The
6033 * "real" command will add the last element (the value)
6034 * for us. If this souds like an hack to you it's just
6035 * because it is... */
6036 addReplySds(c
,sdsnew("*2\r\n"));
6037 addReplyBulkLen(c
,argv
[1]);
6038 addReply(c
,argv
[1]);
6039 addReply(c
,shared
.crlf
);
6040 popGenericCommand(c
,where
);
6042 /* Fix the client structure with the original stuff */
6043 c
->argv
= orig_argv
;
6044 c
->argc
= orig_argc
;
6050 /* If the list is empty or the key does not exists we must block */
6051 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
6052 if (timeout
> 0) timeout
+= time(NULL
);
6053 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
6056 static void blpopCommand(redisClient
*c
) {
6057 blockingPopGenericCommand(c
,REDIS_HEAD
);
6060 static void brpopCommand(redisClient
*c
) {
6061 blockingPopGenericCommand(c
,REDIS_TAIL
);
6064 /* =============================== Replication ============================= */
6066 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
6067 ssize_t nwritten
, ret
= size
;
6068 time_t start
= time(NULL
);
6072 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
6073 nwritten
= write(fd
,ptr
,size
);
6074 if (nwritten
== -1) return -1;
6078 if ((time(NULL
)-start
) > timeout
) {
6086 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
6087 ssize_t nread
, totread
= 0;
6088 time_t start
= time(NULL
);
6092 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
6093 nread
= read(fd
,ptr
,size
);
6094 if (nread
== -1) return -1;
6099 if ((time(NULL
)-start
) > timeout
) {
6107 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
6114 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
6117 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
6128 static void syncCommand(redisClient
*c
) {
6129 /* ignore SYNC if aleady slave or in monitor mode */
6130 if (c
->flags
& REDIS_SLAVE
) return;
6132 /* SYNC can't be issued when the server has pending data to send to
6133 * the client about already issued commands. We need a fresh reply
6134 * buffer registering the differences between the BGSAVE and the current
6135 * dataset, so that we can copy to other slaves if needed. */
6136 if (listLength(c
->reply
) != 0) {
6137 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
6141 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
6142 /* Here we need to check if there is a background saving operation
6143 * in progress, or if it is required to start one */
6144 if (server
.bgsavechildpid
!= -1) {
6145 /* Ok a background save is in progress. Let's check if it is a good
6146 * one for replication, i.e. if there is another slave that is
6147 * registering differences since the server forked to save */
6152 listRewind(server
.slaves
,&li
);
6153 while((ln
= listNext(&li
))) {
6155 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
6158 /* Perfect, the server is already registering differences for
6159 * another slave. Set the right state, and copy the buffer. */
6160 listRelease(c
->reply
);
6161 c
->reply
= listDup(slave
->reply
);
6162 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
6163 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
6165 /* No way, we need to wait for the next BGSAVE in order to
6166 * register differences */
6167 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
6168 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
6171 /* Ok we don't have a BGSAVE in progress, let's start one */
6172 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
6173 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
6174 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
6175 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
6178 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
6181 c
->flags
|= REDIS_SLAVE
;
6183 listAddNodeTail(server
.slaves
,c
);
6187 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
6188 redisClient
*slave
= privdata
;
6190 REDIS_NOTUSED(mask
);
6191 char buf
[REDIS_IOBUF_LEN
];
6192 ssize_t nwritten
, buflen
;
6194 if (slave
->repldboff
== 0) {
6195 /* Write the bulk write count before to transfer the DB. In theory here
6196 * we don't know how much room there is in the output buffer of the
6197 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
6198 * operations) will never be smaller than the few bytes we need. */
6201 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
6203 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
6211 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
6212 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
6214 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
6215 (buflen
== 0) ? "premature EOF" : strerror(errno
));
6219 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
6220 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
6225 slave
->repldboff
+= nwritten
;
6226 if (slave
->repldboff
== slave
->repldbsize
) {
6227 close(slave
->repldbfd
);
6228 slave
->repldbfd
= -1;
6229 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
6230 slave
->replstate
= REDIS_REPL_ONLINE
;
6231 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
6232 sendReplyToClient
, slave
) == AE_ERR
) {
6236 addReplySds(slave
,sdsempty());
6237 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
6241 /* This function is called at the end of every backgrond saving.
6242 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
6243 * otherwise REDIS_ERR is passed to the function.
6245 * The goal of this function is to handle slaves waiting for a successful
6246 * background saving in order to perform non-blocking synchronization. */
6247 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
6249 int startbgsave
= 0;
6252 listRewind(server
.slaves
,&li
);
6253 while((ln
= listNext(&li
))) {
6254 redisClient
*slave
= ln
->value
;
6256 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
6258 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
6259 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
6260 struct redis_stat buf
;
6262 if (bgsaveerr
!= REDIS_OK
) {
6264 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
6267 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
6268 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
6270 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
6273 slave
->repldboff
= 0;
6274 slave
->repldbsize
= buf
.st_size
;
6275 slave
->replstate
= REDIS_REPL_SEND_BULK
;
6276 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
6277 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
6284 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
6287 listRewind(server
.slaves
,&li
);
6288 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
6289 while((ln
= listNext(&li
))) {
6290 redisClient
*slave
= ln
->value
;
6292 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
6299 static int syncWithMaster(void) {
6300 char buf
[1024], tmpfile
[256], authcmd
[1024];
6302 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
6306 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
6311 /* AUTH with the master if required. */
6312 if(server
.masterauth
) {
6313 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
6314 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
6316 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
6320 /* Read the AUTH result. */
6321 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
6323 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
6327 if (buf
[0] != '+') {
6329 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
6334 /* Issue the SYNC command */
6335 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
6337 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
6341 /* Read the bulk write count */
6342 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
6344 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
6348 if (buf
[0] != '$') {
6350 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
6353 dumpsize
= atoi(buf
+1);
6354 redisLog(REDIS_NOTICE
,"Receiving %d bytes data dump from MASTER",dumpsize
);
6355 /* Read the bulk write data on a temp file */
6356 snprintf(tmpfile
,256,"temp-%d.%ld.rdb",(int)time(NULL
),(long int)random());
6357 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
,0644);
6360 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
6364 int nread
, nwritten
;
6366 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
6368 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
6374 nwritten
= write(dfd
,buf
,nread
);
6375 if (nwritten
== -1) {
6376 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
6384 if (rename(tmpfile
,server
.dbfilename
) == -1) {
6385 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
6391 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
6392 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
6396 server
.master
= createClient(fd
);
6397 server
.master
->flags
|= REDIS_MASTER
;
6398 server
.master
->authenticated
= 1;
6399 server
.replstate
= REDIS_REPL_CONNECTED
;
6403 static void slaveofCommand(redisClient
*c
) {
6404 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
6405 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
6406 if (server
.masterhost
) {
6407 sdsfree(server
.masterhost
);
6408 server
.masterhost
= NULL
;
6409 if (server
.master
) freeClient(server
.master
);
6410 server
.replstate
= REDIS_REPL_NONE
;
6411 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
6414 sdsfree(server
.masterhost
);
6415 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
6416 server
.masterport
= atoi(c
->argv
[2]->ptr
);
6417 if (server
.master
) freeClient(server
.master
);
6418 server
.replstate
= REDIS_REPL_CONNECT
;
6419 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
6420 server
.masterhost
, server
.masterport
);
6422 addReply(c
,shared
.ok
);
6425 /* ============================ Maxmemory directive ======================== */
6427 /* Try to free one object form the pre-allocated objects free list.
6428 * This is useful under low mem conditions as by default we take 1 million
6429 * free objects allocated. On success REDIS_OK is returned, otherwise
6431 static int tryFreeOneObjectFromFreelist(void) {
6434 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
6435 if (listLength(server
.objfreelist
)) {
6436 listNode
*head
= listFirst(server
.objfreelist
);
6437 o
= listNodeValue(head
);
6438 listDelNode(server
.objfreelist
,head
);
6439 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
6443 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
6448 /* This function gets called when 'maxmemory' is set on the config file to limit
6449 * the max memory used by the server, and we are out of memory.
6450 * This function will try to, in order:
6452 * - Free objects from the free list
6453 * - Try to remove keys with an EXPIRE set
6455 * It is not possible to free enough memory to reach used-memory < maxmemory
6456 * the server will start refusing commands that will enlarge even more the
6459 static void freeMemoryIfNeeded(void) {
6460 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
6461 int j
, k
, freed
= 0;
6463 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
6464 for (j
= 0; j
< server
.dbnum
; j
++) {
6466 robj
*minkey
= NULL
;
6467 struct dictEntry
*de
;
6469 if (dictSize(server
.db
[j
].expires
)) {
6471 /* From a sample of three keys drop the one nearest to
6472 * the natural expire */
6473 for (k
= 0; k
< 3; k
++) {
6476 de
= dictGetRandomKey(server
.db
[j
].expires
);
6477 t
= (time_t) dictGetEntryVal(de
);
6478 if (minttl
== -1 || t
< minttl
) {
6479 minkey
= dictGetEntryKey(de
);
6483 deleteKey(server
.db
+j
,minkey
);
6486 if (!freed
) return; /* nothing to free... */
6490 /* ============================== Append Only file ========================== */
6492 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
6493 sds buf
= sdsempty();
6499 /* The DB this command was targetting is not the same as the last command
6500 * we appendend. To issue a SELECT command is needed. */
6501 if (dictid
!= server
.appendseldb
) {
6504 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
6505 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
6506 (unsigned long)strlen(seldb
),seldb
);
6507 server
.appendseldb
= dictid
;
6510 /* "Fix" the argv vector if the command is EXPIRE. We want to translate
6511 * EXPIREs into EXPIREATs calls */
6512 if (cmd
->proc
== expireCommand
) {
6515 tmpargv
[0] = createStringObject("EXPIREAT",8);
6516 tmpargv
[1] = argv
[1];
6517 incrRefCount(argv
[1]);
6518 when
= time(NULL
)+strtol(argv
[2]->ptr
,NULL
,10);
6519 tmpargv
[2] = createObject(REDIS_STRING
,
6520 sdscatprintf(sdsempty(),"%ld",when
));
6524 /* Append the actual command */
6525 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
6526 for (j
= 0; j
< argc
; j
++) {
6529 o
= getDecodedObject(o
);
6530 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
6531 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
6532 buf
= sdscatlen(buf
,"\r\n",2);
6536 /* Free the objects from the modified argv for EXPIREAT */
6537 if (cmd
->proc
== expireCommand
) {
6538 for (j
= 0; j
< 3; j
++)
6539 decrRefCount(argv
[j
]);
6542 /* We want to perform a single write. This should be guaranteed atomic
6543 * at least if the filesystem we are writing is a real physical one.
6544 * While this will save us against the server being killed I don't think
6545 * there is much to do about the whole server stopping for power problems
6547 nwritten
= write(server
.appendfd
,buf
,sdslen(buf
));
6548 if (nwritten
!= (signed)sdslen(buf
)) {
6549 /* Ooops, we are in troubles. The best thing to do for now is
6550 * to simply exit instead to give the illusion that everything is
6551 * working as expected. */
6552 if (nwritten
== -1) {
6553 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
6555 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
6559 /* If a background append only file rewriting is in progress we want to
6560 * accumulate the differences between the child DB and the current one
6561 * in a buffer, so that when the child process will do its work we
6562 * can append the differences to the new append only file. */
6563 if (server
.bgrewritechildpid
!= -1)
6564 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
6568 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
6569 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
6570 now
-server
.lastfsync
> 1))
6572 fsync(server
.appendfd
); /* Let's try to get this data on the disk */
6573 server
.lastfsync
= now
;
6577 /* In Redis commands are always executed in the context of a client, so in
6578 * order to load the append only file we need to create a fake client. */
6579 static struct redisClient
*createFakeClient(void) {
6580 struct redisClient
*c
= zmalloc(sizeof(*c
));
6584 c
->querybuf
= sdsempty();
6588 /* We set the fake client as a slave waiting for the synchronization
6589 * so that Redis will not try to send replies to this client. */
6590 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
6591 c
->reply
= listCreate();
6592 listSetFreeMethod(c
->reply
,decrRefCount
);
6593 listSetDupMethod(c
->reply
,dupClientReplyValue
);
6597 static void freeFakeClient(struct redisClient
*c
) {
6598 sdsfree(c
->querybuf
);
6599 listRelease(c
->reply
);
6603 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
6604 * error (the append only file is zero-length) REDIS_ERR is returned. On
6605 * fatal error an error message is logged and the program exists. */
6606 int loadAppendOnlyFile(char *filename
) {
6607 struct redisClient
*fakeClient
;
6608 FILE *fp
= fopen(filename
,"r");
6609 struct redis_stat sb
;
6610 unsigned long long loadedkeys
= 0;
6612 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
6616 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
6620 fakeClient
= createFakeClient();
6627 struct redisCommand
*cmd
;
6629 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
6635 if (buf
[0] != '*') goto fmterr
;
6637 argv
= zmalloc(sizeof(robj
*)*argc
);
6638 for (j
= 0; j
< argc
; j
++) {
6639 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
6640 if (buf
[0] != '$') goto fmterr
;
6641 len
= strtol(buf
+1,NULL
,10);
6642 argsds
= sdsnewlen(NULL
,len
);
6643 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
6644 argv
[j
] = createObject(REDIS_STRING
,argsds
);
6645 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
6648 /* Command lookup */
6649 cmd
= lookupCommand(argv
[0]->ptr
);
6651 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
6654 /* Try object sharing and encoding */
6655 if (server
.shareobjects
) {
6657 for(j
= 1; j
< argc
; j
++)
6658 argv
[j
] = tryObjectSharing(argv
[j
]);
6660 if (cmd
->flags
& REDIS_CMD_BULK
)
6661 tryObjectEncoding(argv
[argc
-1]);
6662 /* Run the command in the context of a fake client */
6663 fakeClient
->argc
= argc
;
6664 fakeClient
->argv
= argv
;
6665 cmd
->proc(fakeClient
);
6666 /* Discard the reply objects list from the fake client */
6667 while(listLength(fakeClient
->reply
))
6668 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
6669 /* Clean up, ready for the next command */
6670 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
6672 /* Handle swapping while loading big datasets when VM is on */
6674 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
6675 while (zmalloc_used_memory() > server
.vm_max_memory
) {
6676 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
6681 freeFakeClient(fakeClient
);
6686 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
6688 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
6692 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
6696 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
6697 static int fwriteBulk(FILE *fp
, robj
*obj
) {
6701 /* Avoid the incr/decr ref count business if possible to help
6702 * copy-on-write (we are often in a child process when this function
6704 * Also makes sure that key objects don't get incrRefCount-ed when VM
6706 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
6707 obj
= getDecodedObject(obj
);
6710 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(long)sdslen(obj
->ptr
));
6711 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) goto err
;
6712 if (sdslen(obj
->ptr
) && fwrite(obj
->ptr
,sdslen(obj
->ptr
),1,fp
) == 0)
6714 if (fwrite("\r\n",2,1,fp
) == 0) goto err
;
6715 if (decrrc
) decrRefCount(obj
);
6718 if (decrrc
) decrRefCount(obj
);
6722 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
6723 static int fwriteBulkDouble(FILE *fp
, double d
) {
6724 char buf
[128], dbuf
[128];
6726 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
6727 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
6728 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
6729 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
6733 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
6734 static int fwriteBulkLong(FILE *fp
, long l
) {
6735 char buf
[128], lbuf
[128];
6737 snprintf(lbuf
,sizeof(lbuf
),"%ld\r\n",l
);
6738 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(lbuf
)-2);
6739 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
6740 if (fwrite(lbuf
,strlen(lbuf
),1,fp
) == 0) return 0;
6744 /* Write a sequence of commands able to fully rebuild the dataset into
6745 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
6746 static int rewriteAppendOnlyFile(char *filename
) {
6747 dictIterator
*di
= NULL
;
6752 time_t now
= time(NULL
);
6754 /* Note that we have to use a different temp name here compared to the
6755 * one used by rewriteAppendOnlyFileBackground() function. */
6756 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
6757 fp
= fopen(tmpfile
,"w");
6759 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
6762 for (j
= 0; j
< server
.dbnum
; j
++) {
6763 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
6764 redisDb
*db
= server
.db
+j
;
6766 if (dictSize(d
) == 0) continue;
6767 di
= dictGetIterator(d
);
6773 /* SELECT the new DB */
6774 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
6775 if (fwriteBulkLong(fp
,j
) == 0) goto werr
;
6777 /* Iterate this DB writing every entry */
6778 while((de
= dictNext(di
)) != NULL
) {
6783 key
= dictGetEntryKey(de
);
6784 /* If the value for this key is swapped, load a preview in memory.
6785 * We use a "swapped" flag to remember if we need to free the
6786 * value object instead to just increment the ref count anyway
6787 * in order to avoid copy-on-write of pages if we are forked() */
6788 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
6789 key
->storage
== REDIS_VM_SWAPPING
) {
6790 o
= dictGetEntryVal(de
);
6793 o
= vmPreviewObject(key
);
6796 expiretime
= getExpire(db
,key
);
6798 /* Save the key and associated value */
6799 if (o
->type
== REDIS_STRING
) {
6800 /* Emit a SET command */
6801 char cmd
[]="*3\r\n$3\r\nSET\r\n";
6802 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
6804 if (fwriteBulk(fp
,key
) == 0) goto werr
;
6805 if (fwriteBulk(fp
,o
) == 0) goto werr
;
6806 } else if (o
->type
== REDIS_LIST
) {
6807 /* Emit the RPUSHes needed to rebuild the list */
6808 list
*list
= o
->ptr
;
6812 listRewind(list
,&li
);
6813 while((ln
= listNext(&li
))) {
6814 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
6815 robj
*eleobj
= listNodeValue(ln
);
6817 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
6818 if (fwriteBulk(fp
,key
) == 0) goto werr
;
6819 if (fwriteBulk(fp
,eleobj
) == 0) goto werr
;
6821 } else if (o
->type
== REDIS_SET
) {
6822 /* Emit the SADDs needed to rebuild the set */
6824 dictIterator
*di
= dictGetIterator(set
);
6827 while((de
= dictNext(di
)) != NULL
) {
6828 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
6829 robj
*eleobj
= dictGetEntryKey(de
);
6831 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
6832 if (fwriteBulk(fp
,key
) == 0) goto werr
;
6833 if (fwriteBulk(fp
,eleobj
) == 0) goto werr
;
6835 dictReleaseIterator(di
);
6836 } else if (o
->type
== REDIS_ZSET
) {
6837 /* Emit the ZADDs needed to rebuild the sorted set */
6839 dictIterator
*di
= dictGetIterator(zs
->dict
);
6842 while((de
= dictNext(di
)) != NULL
) {
6843 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
6844 robj
*eleobj
= dictGetEntryKey(de
);
6845 double *score
= dictGetEntryVal(de
);
6847 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
6848 if (fwriteBulk(fp
,key
) == 0) goto werr
;
6849 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
6850 if (fwriteBulk(fp
,eleobj
) == 0) goto werr
;
6852 dictReleaseIterator(di
);
6854 redisAssert(0 != 0);
6856 /* Save the expire time */
6857 if (expiretime
!= -1) {
6858 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
6859 /* If this key is already expired skip it */
6860 if (expiretime
< now
) continue;
6861 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
6862 if (fwriteBulk(fp
,key
) == 0) goto werr
;
6863 if (fwriteBulkLong(fp
,expiretime
) == 0) goto werr
;
6865 if (swapped
) decrRefCount(o
);
6867 dictReleaseIterator(di
);
6870 /* Make sure data will not remain on the OS's output buffers */
6875 /* Use RENAME to make sure the DB file is changed atomically only
6876 * if the generate DB file is ok. */
6877 if (rename(tmpfile
,filename
) == -1) {
6878 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
6882 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
6888 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
6889 if (di
) dictReleaseIterator(di
);
6893 /* This is how rewriting of the append only file in background works:
6895 * 1) The user calls BGREWRITEAOF
6896 * 2) Redis calls this function, that forks():
6897 * 2a) the child rewrite the append only file in a temp file.
6898 * 2b) the parent accumulates differences in server.bgrewritebuf.
6899 * 3) When the child finished '2a' exists.
6900 * 4) The parent will trap the exit code, if it's OK, will append the
6901 * data accumulated into server.bgrewritebuf into the temp file, and
6902 * finally will rename(2) the temp file in the actual file name.
6903 * The the new file is reopened as the new append only file. Profit!
6905 static int rewriteAppendOnlyFileBackground(void) {
6908 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
6909 if (server
.vm_enabled
) waitZeroActiveThreads();
6910 if ((childpid
= fork()) == 0) {
6915 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
6916 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
6923 if (childpid
== -1) {
6924 redisLog(REDIS_WARNING
,
6925 "Can't rewrite append only file in background: fork: %s",
6929 redisLog(REDIS_NOTICE
,
6930 "Background append only file rewriting started by pid %d",childpid
);
6931 server
.bgrewritechildpid
= childpid
;
6932 /* We set appendseldb to -1 in order to force the next call to the
6933 * feedAppendOnlyFile() to issue a SELECT command, so the differences
6934 * accumulated by the parent into server.bgrewritebuf will start
6935 * with a SELECT statement and it will be safe to merge. */
6936 server
.appendseldb
= -1;
6939 return REDIS_OK
; /* unreached */
6942 static void bgrewriteaofCommand(redisClient
*c
) {
6943 if (server
.bgrewritechildpid
!= -1) {
6944 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
6947 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
6948 char *status
= "+Background append only file rewriting started\r\n";
6949 addReplySds(c
,sdsnew(status
));
6951 addReply(c
,shared
.err
);
6955 static void aofRemoveTempFile(pid_t childpid
) {
6958 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
6962 /* Virtual Memory is composed mainly of two subsystems:
6963 * - Blocking Virutal Memory
6964 * - Threaded Virtual Memory I/O
6965 * The two parts are not fully decoupled, but functions are split among two
6966 * different sections of the source code (delimited by comments) in order to
6967 * make more clear what functionality is about the blocking VM and what about
6968 * the threaded (not blocking) VM.
6972 * Redis VM is a blocking VM (one that blocks reading swapped values from
6973 * disk into memory when a value swapped out is needed in memory) that is made
6974 * unblocking by trying to examine the command argument vector in order to
6975 * load in background values that will likely be needed in order to exec
6976 * the command. The command is executed only once all the relevant keys
6977 * are loaded into memory.
6979 * This basically is almost as simple of a blocking VM, but almost as parallel
6980 * as a fully non-blocking VM.
6983 /* =================== Virtual Memory - Blocking Side ====================== */
6984 static void vmInit(void) {
6988 server
.vm_fp
= fopen("/tmp/redisvm","w+b");
6989 if (server
.vm_fp
== NULL
) {
6990 redisLog(REDIS_WARNING
,"Impossible to open the swap file. Exiting.");
6993 server
.vm_fd
= fileno(server
.vm_fp
);
6994 server
.vm_next_page
= 0;
6995 server
.vm_near_pages
= 0;
6996 server
.vm_stats_used_pages
= 0;
6997 server
.vm_stats_swapped_objects
= 0;
6998 server
.vm_stats_swapouts
= 0;
6999 server
.vm_stats_swapins
= 0;
7000 totsize
= server
.vm_pages
*server
.vm_page_size
;
7001 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
7002 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
7003 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
7007 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
7009 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
7010 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
7011 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
7012 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
7013 /* Try to remove the swap file, so the OS will really delete it from the
7014 * file system when Redis exists. */
7015 unlink("/tmp/redisvm");
7017 /* Initialize threaded I/O (used by Virtual Memory) */
7018 server
.io_newjobs
= listCreate();
7019 server
.io_processing
= listCreate();
7020 server
.io_processed
= listCreate();
7021 server
.io_clients
= listCreate();
7022 pthread_mutex_init(&server
.io_mutex
,NULL
);
7023 pthread_mutex_init(&server
.obj_freelist_mutex
,NULL
);
7024 pthread_mutex_init(&server
.io_swapfile_mutex
,NULL
);
7025 server
.io_active_threads
= 0;
7026 if (pipe(pipefds
) == -1) {
7027 redisLog(REDIS_WARNING
,"Unable to intialized VM: pipe(2): %s. Exiting."
7031 server
.io_ready_pipe_read
= pipefds
[0];
7032 server
.io_ready_pipe_write
= pipefds
[1];
7033 redisAssert(anetNonBlock(NULL
,server
.io_ready_pipe_read
) != ANET_ERR
);
7034 /* Listen for events in the threaded I/O pipe */
7035 if (aeCreateFileEvent(server
.el
, server
.io_ready_pipe_read
, AE_READABLE
,
7036 vmThreadedIOCompletedJob
, NULL
) == AE_ERR
)
7037 oom("creating file event");
7040 /* Mark the page as used */
7041 static void vmMarkPageUsed(off_t page
) {
7042 off_t byte
= page
/8;
7044 server
.vm_bitmap
[byte
] |= 1<<bit
;
7045 redisLog(REDIS_DEBUG
,"Mark used: %lld (byte:%lld bit:%d)\n",
7046 (long long)page
, (long long)byte
, bit
);
7049 /* Mark N contiguous pages as used, with 'page' being the first. */
7050 static void vmMarkPagesUsed(off_t page
, off_t count
) {
7053 for (j
= 0; j
< count
; j
++)
7054 vmMarkPageUsed(page
+j
);
7055 server
.vm_stats_used_pages
+= count
;
7058 /* Mark the page as free */
7059 static void vmMarkPageFree(off_t page
) {
7060 off_t byte
= page
/8;
7062 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
7065 /* Mark N contiguous pages as free, with 'page' being the first. */
7066 static void vmMarkPagesFree(off_t page
, off_t count
) {
7069 for (j
= 0; j
< count
; j
++)
7070 vmMarkPageFree(page
+j
);
7071 server
.vm_stats_used_pages
-= count
;
7074 /* Test if the page is free */
7075 static int vmFreePage(off_t page
) {
7076 off_t byte
= page
/8;
7078 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
7081 /* Find N contiguous free pages storing the first page of the cluster in *first.
7082 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
7083 * REDIS_ERR is returned.
7085 * This function uses a simple algorithm: we try to allocate
7086 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
7087 * again from the start of the swap file searching for free spaces.
7089 * If it looks pretty clear that there are no free pages near our offset
7090 * we try to find less populated places doing a forward jump of
7091 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
7092 * without hurry, and then we jump again and so forth...
7094 * This function can be improved using a free list to avoid to guess
7095 * too much, since we could collect data about freed pages.
7097 * note: I implemented this function just after watching an episode of
7098 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
7100 static int vmFindContiguousPages(off_t
*first
, off_t n
) {
7101 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
7103 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
7104 server
.vm_near_pages
= 0;
7105 server
.vm_next_page
= 0;
7107 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
7108 base
= server
.vm_next_page
;
7110 while(offset
< server
.vm_pages
) {
7111 off_t
this = base
+offset
;
7113 redisLog(REDIS_DEBUG
, "THIS: %lld (%c)\n", (long long) this, vmFreePage(this) ? 'F' : 'X');
7114 /* If we overflow, restart from page zero */
7115 if (this >= server
.vm_pages
) {
7116 this -= server
.vm_pages
;
7118 /* Just overflowed, what we found on tail is no longer
7119 * interesting, as it's no longer contiguous. */
7123 if (vmFreePage(this)) {
7124 /* This is a free page */
7126 /* Already got N free pages? Return to the caller, with success */
7128 *first
= this-(n
-1);
7129 server
.vm_next_page
= this+1;
7133 /* The current one is not a free page */
7137 /* Fast-forward if the current page is not free and we already
7138 * searched enough near this place. */
7140 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
7141 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
7143 /* Note that even if we rewind after the jump, we are don't need
7144 * to make sure numfree is set to zero as we only jump *if* it
7145 * is set to zero. */
7147 /* Otherwise just check the next page */
7154 /* Write the specified object at the specified page of the swap file */
7155 static int vmWriteObjectOnSwap(robj
*o
, off_t page
) {
7156 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
7157 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
7158 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
7159 redisLog(REDIS_WARNING
,
7160 "Critical VM problem in vmSwapObjectBlocking(): can't seek: %s",
7164 rdbSaveObject(server
.vm_fp
,o
);
7165 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
7169 /* Swap the 'val' object relative to 'key' into disk. Store all the information
7170 * needed to later retrieve the object into the key object.
7171 * If we can't find enough contiguous empty pages to swap the object on disk
7172 * REDIS_ERR is returned. */
7173 static int vmSwapObjectBlocking(robj
*key
, robj
*val
) {
7174 off_t pages
= rdbSavedObjectPages(val
,NULL
);
7177 assert(key
->storage
== REDIS_VM_MEMORY
);
7178 assert(key
->refcount
== 1);
7179 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return REDIS_ERR
;
7180 if (vmWriteObjectOnSwap(val
,page
) == REDIS_ERR
) return REDIS_ERR
;
7181 key
->vm
.page
= page
;
7182 key
->vm
.usedpages
= pages
;
7183 key
->storage
= REDIS_VM_SWAPPED
;
7184 key
->vtype
= val
->type
;
7185 decrRefCount(val
); /* Deallocate the object from memory. */
7186 vmMarkPagesUsed(page
,pages
);
7187 redisLog(REDIS_DEBUG
,"VM: object %s swapped out at %lld (%lld pages)",
7188 (unsigned char*) key
->ptr
,
7189 (unsigned long long) page
, (unsigned long long) pages
);
7190 server
.vm_stats_swapped_objects
++;
7191 server
.vm_stats_swapouts
++;
7192 fflush(server
.vm_fp
);
7196 static robj
*vmReadObjectFromSwap(off_t page
, int type
) {
7199 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
7200 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
7201 redisLog(REDIS_WARNING
,
7202 "Unrecoverable VM problem in vmLoadObject(): can't seek: %s",
7206 o
= rdbLoadObject(type
,server
.vm_fp
);
7208 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmLoadObject(): can't load object from swap file: %s", strerror(errno
));
7211 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
7215 /* Load the value object relative to the 'key' object from swap to memory.
7216 * The newly allocated object is returned.
7218 * If preview is true the unserialized object is returned to the caller but
7219 * no changes are made to the key object, nor the pages are marked as freed */
7220 static robj
*vmGenericLoadObject(robj
*key
, int preview
) {
7223 redisAssert(key
->storage
== REDIS_VM_SWAPPED
);
7224 val
= vmReadObjectFromSwap(key
->vm
.page
,key
->vtype
);
7226 key
->storage
= REDIS_VM_MEMORY
;
7227 key
->vm
.atime
= server
.unixtime
;
7228 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
7229 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk",
7230 (unsigned char*) key
->ptr
);
7231 server
.vm_stats_swapped_objects
--;
7233 redisLog(REDIS_DEBUG
, "VM: object %s previewed from disk",
7234 (unsigned char*) key
->ptr
);
7236 server
.vm_stats_swapins
++;
7240 /* Plain object loading, from swap to memory */
7241 static robj
*vmLoadObject(robj
*key
) {
7242 /* If we are loading the object in background, stop it, we
7243 * need to load this object synchronously ASAP. */
7244 if (key
->storage
== REDIS_VM_LOADING
)
7245 vmCancelThreadedIOJob(key
);
7246 return vmGenericLoadObject(key
,0);
7249 /* Just load the value on disk, without to modify the key.
7250 * This is useful when we want to perform some operation on the value
7251 * without to really bring it from swap to memory, like while saving the
7252 * dataset or rewriting the append only log. */
7253 static robj
*vmPreviewObject(robj
*key
) {
7254 return vmGenericLoadObject(key
,1);
7257 /* How a good candidate is this object for swapping?
7258 * The better candidate it is, the greater the returned value.
7260 * Currently we try to perform a fast estimation of the object size in
7261 * memory, and combine it with aging informations.
7263 * Basically swappability = idle-time * log(estimated size)
7265 * Bigger objects are preferred over smaller objects, but not
7266 * proportionally, this is why we use the logarithm. This algorithm is
7267 * just a first try and will probably be tuned later. */
7268 static double computeObjectSwappability(robj
*o
) {
7269 time_t age
= server
.unixtime
- o
->vm
.atime
;
7273 struct dictEntry
*de
;
7276 if (age
<= 0) return 0;
7279 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
7282 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
7287 listNode
*ln
= listFirst(l
);
7289 asize
= sizeof(list
);
7291 robj
*ele
= ln
->value
;
7294 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
7295 (sizeof(*o
)+sdslen(ele
->ptr
)) :
7297 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
7302 z
= (o
->type
== REDIS_ZSET
);
7303 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
7305 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
7306 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
7311 de
= dictGetRandomKey(d
);
7312 ele
= dictGetEntryKey(de
);
7313 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
7314 (sizeof(*o
)+sdslen(ele
->ptr
)) :
7316 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
7317 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
7321 return (double)asize
*log(1+asize
);
7324 /* Try to swap an object that's a good candidate for swapping.
7325 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
7326 * to swap any object at all.
7328 * If 'usethreaded' is true, Redis will try to swap the object in background
7329 * using I/O threads. */
7330 static int vmSwapOneObject(int usethreads
) {
7332 struct dictEntry
*best
= NULL
;
7333 double best_swappability
= 0;
7334 redisDb
*best_db
= NULL
;
7337 for (j
= 0; j
< server
.dbnum
; j
++) {
7338 redisDb
*db
= server
.db
+j
;
7339 int maxtries
= 1000;
7341 if (dictSize(db
->dict
) == 0) continue;
7342 for (i
= 0; i
< 5; i
++) {
7344 double swappability
;
7346 if (maxtries
) maxtries
--;
7347 de
= dictGetRandomKey(db
->dict
);
7348 key
= dictGetEntryKey(de
);
7349 val
= dictGetEntryVal(de
);
7350 if (key
->storage
!= REDIS_VM_MEMORY
) {
7351 if (maxtries
) i
--; /* don't count this try */
7354 swappability
= computeObjectSwappability(val
);
7355 if (!best
|| swappability
> best_swappability
) {
7357 best_swappability
= swappability
;
7363 redisLog(REDIS_DEBUG
,"No swappable key found!");
7366 key
= dictGetEntryKey(best
);
7367 val
= dictGetEntryVal(best
);
7369 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
7370 key
->ptr
, best_swappability
);
7372 /* Unshare the key if needed */
7373 if (key
->refcount
> 1) {
7374 robj
*newkey
= dupStringObject(key
);
7376 key
= dictGetEntryKey(best
) = newkey
;
7380 vmSwapObjectThreaded(key
,val
,best_db
);
7383 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
7384 dictGetEntryVal(best
) = NULL
;
7392 static int vmSwapOneObjectBlocking() {
7393 return vmSwapOneObject(0);
7396 static int vmSwapOneObjectThreaded() {
7397 return vmSwapOneObject(1);
7400 /* Return true if it's safe to swap out objects in a given moment.
7401 * Basically we don't want to swap objects out while there is a BGSAVE
7402 * or a BGAEOREWRITE running in backgroud. */
7403 static int vmCanSwapOut(void) {
7404 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
7407 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
7408 * and was deleted. Otherwise 0 is returned. */
7409 static int deleteIfSwapped(redisDb
*db
, robj
*key
) {
7413 if ((de
= dictFind(db
->dict
,key
)) == NULL
) return 0;
7414 foundkey
= dictGetEntryKey(de
);
7415 if (foundkey
->storage
== REDIS_VM_MEMORY
) return 0;
7420 /* =================== Virtual Memory - Threaded I/O ======================= */
7422 static void freeIOJob(iojob
*j
) {
7423 if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
||
7424 j
->type
== REDIS_IOJOB_DO_SWAP
)
7425 decrRefCount(j
->val
);
7426 decrRefCount(j
->key
);
7430 /* Every time a thread finished a Job, it writes a byte into the write side
7431 * of an unix pipe in order to "awake" the main thread, and this function
7433 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
,
7440 REDIS_NOTUSED(mask
);
7441 REDIS_NOTUSED(privdata
);
7443 /* For every byte we read in the read side of the pipe, there is one
7444 * I/O job completed to process. */
7445 while((retval
= read(fd
,buf
,1)) == 1) {
7449 struct dictEntry
*de
;
7451 redisLog(REDIS_DEBUG
,"Processing I/O completed job");
7452 assert(listLength(server
.io_processed
) != 0);
7454 /* Get the processed element (the oldest one) */
7456 ln
= listFirst(server
.io_processed
);
7458 listDelNode(server
.io_processed
,ln
);
7460 /* If this job is marked as canceled, just ignore it */
7465 /* Post process it in the main thread, as there are things we
7466 * can do just here to avoid race conditions and/or invasive locks */
7467 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
);
7468 de
= dictFind(j
->db
->dict
,j
->key
);
7470 key
= dictGetEntryKey(de
);
7471 if (j
->type
== REDIS_IOJOB_LOAD
) {
7472 /* Key loaded, bring it at home */
7473 key
->storage
= REDIS_VM_MEMORY
;
7474 key
->vm
.atime
= server
.unixtime
;
7475 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
7476 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk (threaded)",
7477 (unsigned char*) key
->ptr
);
7478 server
.vm_stats_swapped_objects
--;
7479 server
.vm_stats_swapins
++;
7481 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
7482 /* Now we know the amount of pages required to swap this object.
7483 * Let's find some space for it, and queue this task again
7484 * rebranded as REDIS_IOJOB_DO_SWAP. */
7485 if (vmFindContiguousPages(&j
->page
,j
->pages
) == REDIS_ERR
) {
7486 /* Ooops... no space! */
7489 /* Note that we need to mark this pages as used now,
7490 * if the job will be canceled, we'll mark them as freed
7492 vmMarkPagesUsed(j
->page
,j
->pages
);
7493 j
->type
= REDIS_IOJOB_DO_SWAP
;
7498 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
7501 /* Key swapped. We can finally free some memory. */
7502 if (key
->storage
!= REDIS_VM_SWAPPING
) {
7503 printf("key->storage: %d\n",key
->storage
);
7504 printf("key->name: %s\n",(char*)key
->ptr
);
7505 printf("key->refcount: %d\n",key
->refcount
);
7506 printf("val: %p\n",(void*)j
->val
);
7507 printf("val->type: %d\n",j
->val
->type
);
7508 printf("val->ptr: %s\n",(char*)j
->val
->ptr
);
7510 redisAssert(key
->storage
== REDIS_VM_SWAPPING
);
7511 val
= dictGetEntryVal(de
);
7512 key
->vm
.page
= j
->page
;
7513 key
->vm
.usedpages
= j
->pages
;
7514 key
->storage
= REDIS_VM_SWAPPED
;
7515 key
->vtype
= j
->val
->type
;
7516 decrRefCount(val
); /* Deallocate the object from memory. */
7517 dictGetEntryVal(de
) = NULL
;
7518 redisLog(REDIS_DEBUG
,
7519 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
7520 (unsigned char*) key
->ptr
,
7521 (unsigned long long) j
->page
, (unsigned long long) j
->pages
);
7522 server
.vm_stats_swapped_objects
++;
7523 server
.vm_stats_swapouts
++;
7525 /* Put a few more swap requests in queue if we are still
7527 if (zmalloc_used_memory() > server
.vm_max_memory
) {
7531 more
= listLength(server
.io_newjobs
) <
7532 (unsigned) server
.vm_max_threads
;
7534 /* Don't waste CPU time if swappable objects are rare. */
7535 if (vmSwapOneObjectThreaded() == REDIS_ERR
) break;
7540 if (processed
== REDIS_MAX_COMPLETED_JOBS_PROCESSED
) return;
7542 if (retval
< 0 && errno
!= EAGAIN
) {
7543 redisLog(REDIS_WARNING
,
7544 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
7549 static void lockThreadedIO(void) {
7550 pthread_mutex_lock(&server
.io_mutex
);
7553 static void unlockThreadedIO(void) {
7554 pthread_mutex_unlock(&server
.io_mutex
);
7557 /* Remove the specified object from the threaded I/O queue if still not
7558 * processed, otherwise make sure to flag it as canceled. */
7559 static void vmCancelThreadedIOJob(robj
*o
) {
7561 server
.io_newjobs
, /* 0 */
7562 server
.io_processing
, /* 1 */
7563 server
.io_processed
/* 2 */
7567 assert(o
->storage
== REDIS_VM_LOADING
|| o
->storage
== REDIS_VM_SWAPPING
);
7569 /* Search for a matching key in one of the queues */
7570 for (i
= 0; i
< 3; i
++) {
7574 listRewind(lists
[i
],&li
);
7575 while ((ln
= listNext(&li
)) != NULL
) {
7576 iojob
*job
= ln
->value
;
7578 if (job
->canceled
) continue; /* Skip this, already canceled. */
7579 if (compareStringObjects(job
->key
,o
) == 0) {
7580 redisLog(REDIS_DEBUG
,"*** CANCELED %p (%s)\n",
7581 (void*)job
, (char*)o
->ptr
);
7582 /* Mark the pages as free since the swap didn't happened
7583 * or happened but is now discarded. */
7584 if (job
->type
== REDIS_IOJOB_DO_SWAP
)
7585 vmMarkPagesFree(job
->page
,job
->pages
);
7586 /* Cancel the job. It depends on the list the job is
7589 case 0: /* io_newjobs */
7590 /* If the job was yet not processed the best thing to do
7591 * is to remove it from the queue at all */
7593 listDelNode(lists
[i
],ln
);
7595 case 1: /* io_processing */
7596 case 2: /* io_processed */
7600 /* Finally we have to adjust the storage type of the object
7601 * in order to "UNDO" the operaiton. */
7602 if (o
->storage
== REDIS_VM_LOADING
)
7603 o
->storage
= REDIS_VM_SWAPPED
;
7604 else if (o
->storage
== REDIS_VM_SWAPPING
)
7605 o
->storage
= REDIS_VM_MEMORY
;
7612 assert(1 != 1); /* We should never reach this */
7615 static void *IOThreadEntryPoint(void *arg
) {
7620 pthread_detach(pthread_self());
7622 /* Get a new job to process */
7624 if (listLength(server
.io_newjobs
) == 0) {
7625 /* No new jobs in queue, exit. */
7626 redisLog(REDIS_DEBUG
,"Thread %lld exiting, nothing to do",
7627 (long long) pthread_self());
7628 server
.io_active_threads
--;
7632 ln
= listFirst(server
.io_newjobs
);
7634 listDelNode(server
.io_newjobs
,ln
);
7635 /* Add the job in the processing queue */
7636 j
->thread
= pthread_self();
7637 listAddNodeTail(server
.io_processing
,j
);
7638 ln
= listLast(server
.io_processing
); /* We use ln later to remove it */
7640 redisLog(REDIS_DEBUG
,"Thread %lld got a new job (type %d): %p about key '%s'",
7641 (long long) pthread_self(), j
->type
, (void*)j
, (char*)j
->key
->ptr
);
7643 /* Process the Job */
7644 if (j
->type
== REDIS_IOJOB_LOAD
) {
7645 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
7646 FILE *fp
= fopen("/dev/null","w+");
7647 j
->pages
= rdbSavedObjectPages(j
->val
,fp
);
7649 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
7650 if (vmWriteObjectOnSwap(j
->val
,j
->page
) == REDIS_ERR
)
7654 /* Done: insert the job into the processed queue */
7655 redisLog(REDIS_DEBUG
,"Thread %lld completed the job: %p (key %s)",
7656 (long long) pthread_self(), (void*)j
, (char*)j
->key
->ptr
);
7658 listDelNode(server
.io_processing
,ln
);
7659 listAddNodeTail(server
.io_processed
,j
);
7662 /* Signal the main thread there is new stuff to process */
7663 assert(write(server
.io_ready_pipe_write
,"x",1) == 1);
7665 return NULL
; /* never reached */
7668 static void spawnIOThread(void) {
7671 pthread_create(&thread
,NULL
,IOThreadEntryPoint
,NULL
);
7672 server
.io_active_threads
++;
7675 /* We need to wait for the last thread to exit before we are able to
7676 * fork() in order to BGSAVE or BGREWRITEAOF. */
7677 static void waitZeroActiveThreads(void) {
7680 if (server
.io_active_threads
== 0) {
7685 usleep(10000); /* 10 milliseconds */
7689 /* This function must be called while with threaded IO locked */
7690 static void queueIOJob(iojob
*j
) {
7691 redisLog(REDIS_DEBUG
,"Queued IO Job %p type %d about key '%s'\n",
7692 (void*)j
, j
->type
, (char*)j
->key
->ptr
);
7693 listAddNodeTail(server
.io_newjobs
,j
);
7694 if (server
.io_active_threads
< server
.vm_max_threads
)
7698 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
) {
7701 assert(key
->storage
== REDIS_VM_MEMORY
);
7702 assert(key
->refcount
== 1);
7704 j
= zmalloc(sizeof(*j
));
7705 j
->type
= REDIS_IOJOB_PREPARE_SWAP
;
7707 j
->key
= dupStringObject(key
);
7711 j
->thread
= (pthread_t
) -1;
7712 key
->storage
= REDIS_VM_SWAPPING
;
7720 /* ================================= Debugging ============================== */
7722 static void debugCommand(redisClient
*c
) {
7723 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
7725 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
7726 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
7727 addReply(c
,shared
.err
);
7731 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
7732 addReply(c
,shared
.err
);
7735 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
7736 addReply(c
,shared
.ok
);
7737 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
7739 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
7740 addReply(c
,shared
.err
);
7743 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
7744 addReply(c
,shared
.ok
);
7745 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
7746 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
7750 addReply(c
,shared
.nokeyerr
);
7753 key
= dictGetEntryKey(de
);
7754 val
= dictGetEntryVal(de
);
7755 if (server
.vm_enabled
&& (key
->storage
== REDIS_VM_MEMORY
||
7756 key
->storage
== REDIS_VM_SWAPPING
)) {
7757 addReplySds(c
,sdscatprintf(sdsempty(),
7758 "+Key at:%p refcount:%d, value at:%p refcount:%d "
7759 "encoding:%d serializedlength:%lld\r\n",
7760 (void*)key
, key
->refcount
, (void*)val
, val
->refcount
,
7761 val
->encoding
, rdbSavedObjectLen(val
,NULL
)));
7763 addReplySds(c
,sdscatprintf(sdsempty(),
7764 "+Key at:%p refcount:%d, value swapped at: page %llu "
7765 "using %llu pages\r\n",
7766 (void*)key
, key
->refcount
, (unsigned long long) key
->vm
.page
,
7767 (unsigned long long) key
->vm
.usedpages
));
7769 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
7770 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
7773 if (!server
.vm_enabled
) {
7774 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
7778 addReply(c
,shared
.nokeyerr
);
7781 key
= dictGetEntryKey(de
);
7782 val
= dictGetEntryVal(de
);
7783 /* If the key is shared we want to create a copy */
7784 if (key
->refcount
> 1) {
7785 robj
*newkey
= dupStringObject(key
);
7787 key
= dictGetEntryKey(de
) = newkey
;
7790 if (key
->storage
!= REDIS_VM_MEMORY
) {
7791 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
7792 } else if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
7793 dictGetEntryVal(de
) = NULL
;
7794 addReply(c
,shared
.ok
);
7796 addReply(c
,shared
.err
);
7799 addReplySds(c
,sdsnew(
7800 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPOUT <key>|RELOAD]\r\n"));
7804 static void _redisAssert(char *estr
, char *file
, int line
) {
7805 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
7806 redisLog(REDIS_WARNING
,"==> %s:%d '%s' is not true\n",file
,line
,estr
);
7807 #ifdef HAVE_BACKTRACE
7808 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
7813 /* =================================== Main! ================================ */
7816 int linuxOvercommitMemoryValue(void) {
7817 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
7821 if (fgets(buf
,64,fp
) == NULL
) {
7830 void linuxOvercommitMemoryWarning(void) {
7831 if (linuxOvercommitMemoryValue() == 0) {
7832 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.");
7835 #endif /* __linux__ */
7837 static void daemonize(void) {
7841 if (fork() != 0) exit(0); /* parent exits */
7842 setsid(); /* create a new session */
7844 /* Every output goes to /dev/null. If Redis is daemonized but
7845 * the 'logfile' is set to 'stdout' in the configuration file
7846 * it will not log at all. */
7847 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
7848 dup2(fd
, STDIN_FILENO
);
7849 dup2(fd
, STDOUT_FILENO
);
7850 dup2(fd
, STDERR_FILENO
);
7851 if (fd
> STDERR_FILENO
) close(fd
);
7853 /* Try to write the pid file */
7854 fp
= fopen(server
.pidfile
,"w");
7856 fprintf(fp
,"%d\n",getpid());
7861 int main(int argc
, char **argv
) {
7864 resetServerSaveParams();
7865 loadServerConfig(argv
[1]);
7866 } else if (argc
> 2) {
7867 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
7870 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'");
7872 if (server
.daemonize
) daemonize();
7874 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
7876 linuxOvercommitMemoryWarning();
7878 if (server
.appendonly
) {
7879 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
7880 redisLog(REDIS_NOTICE
,"DB loaded from append only file");
7882 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
7883 redisLog(REDIS_NOTICE
,"DB loaded from disk");
7885 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
7887 aeDeleteEventLoop(server
.el
);
7891 /* ============================= Backtrace support ========================= */
7893 #ifdef HAVE_BACKTRACE
7894 static char *findFuncName(void *pointer
, unsigned long *offset
);
7896 static void *getMcontextEip(ucontext_t
*uc
) {
7897 #if defined(__FreeBSD__)
7898 return (void*) uc
->uc_mcontext
.mc_eip
;
7899 #elif defined(__dietlibc__)
7900 return (void*) uc
->uc_mcontext
.eip
;
7901 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
7903 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
7905 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
7907 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
7908 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
7909 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
7911 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
7913 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
7914 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
7915 #elif defined(__ia64__) /* Linux IA64 */
7916 return (void*) uc
->uc_mcontext
.sc_ip
;
7922 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
7924 char **messages
= NULL
;
7925 int i
, trace_size
= 0;
7926 unsigned long offset
=0;
7927 ucontext_t
*uc
= (ucontext_t
*) secret
;
7929 REDIS_NOTUSED(info
);
7931 redisLog(REDIS_WARNING
,
7932 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
7933 infostring
= genRedisInfoString();
7934 redisLog(REDIS_WARNING
, "%s",infostring
);
7935 /* It's not safe to sdsfree() the returned string under memory
7936 * corruption conditions. Let it leak as we are going to abort */
7938 trace_size
= backtrace(trace
, 100);
7939 /* overwrite sigaction with caller's address */
7940 if (getMcontextEip(uc
) != NULL
) {
7941 trace
[1] = getMcontextEip(uc
);
7943 messages
= backtrace_symbols(trace
, trace_size
);
7945 for (i
=1; i
<trace_size
; ++i
) {
7946 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
7948 p
= strchr(messages
[i
],'+');
7949 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
7950 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
7952 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
7955 /* free(messages); Don't call free() with possibly corrupted memory. */
7959 static void setupSigSegvAction(void) {
7960 struct sigaction act
;
7962 sigemptyset (&act
.sa_mask
);
7963 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
7964 * is used. Otherwise, sa_handler is used */
7965 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
7966 act
.sa_sigaction
= segvHandler
;
7967 sigaction (SIGSEGV
, &act
, NULL
);
7968 sigaction (SIGBUS
, &act
, NULL
);
7969 sigaction (SIGFPE
, &act
, NULL
);
7970 sigaction (SIGILL
, &act
, NULL
);
7971 sigaction (SIGBUS
, &act
, NULL
);
7975 #include "staticsymbols.h"
7976 /* This function try to convert a pointer into a function name. It's used in
7977 * oreder to provide a backtrace under segmentation fault that's able to
7978 * display functions declared as static (otherwise the backtrace is useless). */
7979 static char *findFuncName(void *pointer
, unsigned long *offset
){
7981 unsigned long off
, minoff
= 0;
7983 /* Try to match against the Symbol with the smallest offset */
7984 for (i
=0; symsTable
[i
].pointer
; i
++) {
7985 unsigned long lp
= (unsigned long) pointer
;
7987 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
7988 off
=lp
-symsTable
[i
].pointer
;
7989 if (ret
< 0 || off
< minoff
) {
7995 if (ret
== -1) return NULL
;
7997 return symsTable
[ret
].name
;
7999 #else /* HAVE_BACKTRACE */
8000 static void setupSigSegvAction(void) {
8002 #endif /* HAVE_BACKTRACE */