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
);
565 static void authCommand(redisClient
*c
);
566 static void pingCommand(redisClient
*c
);
567 static void echoCommand(redisClient
*c
);
568 static void setCommand(redisClient
*c
);
569 static void setnxCommand(redisClient
*c
);
570 static void getCommand(redisClient
*c
);
571 static void delCommand(redisClient
*c
);
572 static void existsCommand(redisClient
*c
);
573 static void incrCommand(redisClient
*c
);
574 static void decrCommand(redisClient
*c
);
575 static void incrbyCommand(redisClient
*c
);
576 static void decrbyCommand(redisClient
*c
);
577 static void selectCommand(redisClient
*c
);
578 static void randomkeyCommand(redisClient
*c
);
579 static void keysCommand(redisClient
*c
);
580 static void dbsizeCommand(redisClient
*c
);
581 static void lastsaveCommand(redisClient
*c
);
582 static void saveCommand(redisClient
*c
);
583 static void bgsaveCommand(redisClient
*c
);
584 static void bgrewriteaofCommand(redisClient
*c
);
585 static void shutdownCommand(redisClient
*c
);
586 static void moveCommand(redisClient
*c
);
587 static void renameCommand(redisClient
*c
);
588 static void renamenxCommand(redisClient
*c
);
589 static void lpushCommand(redisClient
*c
);
590 static void rpushCommand(redisClient
*c
);
591 static void lpopCommand(redisClient
*c
);
592 static void rpopCommand(redisClient
*c
);
593 static void llenCommand(redisClient
*c
);
594 static void lindexCommand(redisClient
*c
);
595 static void lrangeCommand(redisClient
*c
);
596 static void ltrimCommand(redisClient
*c
);
597 static void typeCommand(redisClient
*c
);
598 static void lsetCommand(redisClient
*c
);
599 static void saddCommand(redisClient
*c
);
600 static void sremCommand(redisClient
*c
);
601 static void smoveCommand(redisClient
*c
);
602 static void sismemberCommand(redisClient
*c
);
603 static void scardCommand(redisClient
*c
);
604 static void spopCommand(redisClient
*c
);
605 static void srandmemberCommand(redisClient
*c
);
606 static void sinterCommand(redisClient
*c
);
607 static void sinterstoreCommand(redisClient
*c
);
608 static void sunionCommand(redisClient
*c
);
609 static void sunionstoreCommand(redisClient
*c
);
610 static void sdiffCommand(redisClient
*c
);
611 static void sdiffstoreCommand(redisClient
*c
);
612 static void syncCommand(redisClient
*c
);
613 static void flushdbCommand(redisClient
*c
);
614 static void flushallCommand(redisClient
*c
);
615 static void sortCommand(redisClient
*c
);
616 static void lremCommand(redisClient
*c
);
617 static void rpoplpushcommand(redisClient
*c
);
618 static void infoCommand(redisClient
*c
);
619 static void mgetCommand(redisClient
*c
);
620 static void monitorCommand(redisClient
*c
);
621 static void expireCommand(redisClient
*c
);
622 static void expireatCommand(redisClient
*c
);
623 static void getsetCommand(redisClient
*c
);
624 static void ttlCommand(redisClient
*c
);
625 static void slaveofCommand(redisClient
*c
);
626 static void debugCommand(redisClient
*c
);
627 static void msetCommand(redisClient
*c
);
628 static void msetnxCommand(redisClient
*c
);
629 static void zaddCommand(redisClient
*c
);
630 static void zincrbyCommand(redisClient
*c
);
631 static void zrangeCommand(redisClient
*c
);
632 static void zrangebyscoreCommand(redisClient
*c
);
633 static void zrevrangeCommand(redisClient
*c
);
634 static void zcardCommand(redisClient
*c
);
635 static void zremCommand(redisClient
*c
);
636 static void zscoreCommand(redisClient
*c
);
637 static void zremrangebyscoreCommand(redisClient
*c
);
638 static void multiCommand(redisClient
*c
);
639 static void execCommand(redisClient
*c
);
640 static void blpopCommand(redisClient
*c
);
641 static void brpopCommand(redisClient
*c
);
643 /*================================= Globals ================================= */
646 static struct redisServer server
; /* server global state */
647 static struct redisCommand cmdTable
[] = {
648 {"get",getCommand
,2,REDIS_CMD_INLINE
},
649 {"set",setCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
650 {"setnx",setnxCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
651 {"del",delCommand
,-2,REDIS_CMD_INLINE
},
652 {"exists",existsCommand
,2,REDIS_CMD_INLINE
},
653 {"incr",incrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
654 {"decr",decrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
655 {"mget",mgetCommand
,-2,REDIS_CMD_INLINE
},
656 {"rpush",rpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
657 {"lpush",lpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
658 {"rpop",rpopCommand
,2,REDIS_CMD_INLINE
},
659 {"lpop",lpopCommand
,2,REDIS_CMD_INLINE
},
660 {"brpop",brpopCommand
,-3,REDIS_CMD_INLINE
},
661 {"blpop",blpopCommand
,-3,REDIS_CMD_INLINE
},
662 {"llen",llenCommand
,2,REDIS_CMD_INLINE
},
663 {"lindex",lindexCommand
,3,REDIS_CMD_INLINE
},
664 {"lset",lsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
665 {"lrange",lrangeCommand
,4,REDIS_CMD_INLINE
},
666 {"ltrim",ltrimCommand
,4,REDIS_CMD_INLINE
},
667 {"lrem",lremCommand
,4,REDIS_CMD_BULK
},
668 {"rpoplpush",rpoplpushcommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
669 {"sadd",saddCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
670 {"srem",sremCommand
,3,REDIS_CMD_BULK
},
671 {"smove",smoveCommand
,4,REDIS_CMD_BULK
},
672 {"sismember",sismemberCommand
,3,REDIS_CMD_BULK
},
673 {"scard",scardCommand
,2,REDIS_CMD_INLINE
},
674 {"spop",spopCommand
,2,REDIS_CMD_INLINE
},
675 {"srandmember",srandmemberCommand
,2,REDIS_CMD_INLINE
},
676 {"sinter",sinterCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
677 {"sinterstore",sinterstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
678 {"sunion",sunionCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
679 {"sunionstore",sunionstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
680 {"sdiff",sdiffCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
681 {"sdiffstore",sdiffstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
682 {"smembers",sinterCommand
,2,REDIS_CMD_INLINE
},
683 {"zadd",zaddCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
684 {"zincrby",zincrbyCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
685 {"zrem",zremCommand
,3,REDIS_CMD_BULK
},
686 {"zremrangebyscore",zremrangebyscoreCommand
,4,REDIS_CMD_INLINE
},
687 {"zrange",zrangeCommand
,-4,REDIS_CMD_INLINE
},
688 {"zrangebyscore",zrangebyscoreCommand
,-4,REDIS_CMD_INLINE
},
689 {"zrevrange",zrevrangeCommand
,-4,REDIS_CMD_INLINE
},
690 {"zcard",zcardCommand
,2,REDIS_CMD_INLINE
},
691 {"zscore",zscoreCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
692 {"incrby",incrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
693 {"decrby",decrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
694 {"getset",getsetCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
695 {"mset",msetCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
696 {"msetnx",msetnxCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
697 {"randomkey",randomkeyCommand
,1,REDIS_CMD_INLINE
},
698 {"select",selectCommand
,2,REDIS_CMD_INLINE
},
699 {"move",moveCommand
,3,REDIS_CMD_INLINE
},
700 {"rename",renameCommand
,3,REDIS_CMD_INLINE
},
701 {"renamenx",renamenxCommand
,3,REDIS_CMD_INLINE
},
702 {"expire",expireCommand
,3,REDIS_CMD_INLINE
},
703 {"expireat",expireatCommand
,3,REDIS_CMD_INLINE
},
704 {"keys",keysCommand
,2,REDIS_CMD_INLINE
},
705 {"dbsize",dbsizeCommand
,1,REDIS_CMD_INLINE
},
706 {"auth",authCommand
,2,REDIS_CMD_INLINE
},
707 {"ping",pingCommand
,1,REDIS_CMD_INLINE
},
708 {"echo",echoCommand
,2,REDIS_CMD_BULK
},
709 {"save",saveCommand
,1,REDIS_CMD_INLINE
},
710 {"bgsave",bgsaveCommand
,1,REDIS_CMD_INLINE
},
711 {"bgrewriteaof",bgrewriteaofCommand
,1,REDIS_CMD_INLINE
},
712 {"shutdown",shutdownCommand
,1,REDIS_CMD_INLINE
},
713 {"lastsave",lastsaveCommand
,1,REDIS_CMD_INLINE
},
714 {"type",typeCommand
,2,REDIS_CMD_INLINE
},
715 {"multi",multiCommand
,1,REDIS_CMD_INLINE
},
716 {"exec",execCommand
,1,REDIS_CMD_INLINE
},
717 {"sync",syncCommand
,1,REDIS_CMD_INLINE
},
718 {"flushdb",flushdbCommand
,1,REDIS_CMD_INLINE
},
719 {"flushall",flushallCommand
,1,REDIS_CMD_INLINE
},
720 {"sort",sortCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
721 {"info",infoCommand
,1,REDIS_CMD_INLINE
},
722 {"monitor",monitorCommand
,1,REDIS_CMD_INLINE
},
723 {"ttl",ttlCommand
,2,REDIS_CMD_INLINE
},
724 {"slaveof",slaveofCommand
,3,REDIS_CMD_INLINE
},
725 {"debug",debugCommand
,-2,REDIS_CMD_INLINE
},
729 /*============================ Utility functions ============================ */
731 /* Glob-style pattern matching. */
732 int stringmatchlen(const char *pattern
, int patternLen
,
733 const char *string
, int stringLen
, int nocase
)
738 while (pattern
[1] == '*') {
743 return 1; /* match */
745 if (stringmatchlen(pattern
+1, patternLen
-1,
746 string
, stringLen
, nocase
))
747 return 1; /* match */
751 return 0; /* no match */
755 return 0; /* no match */
765 not = pattern
[0] == '^';
772 if (pattern
[0] == '\\') {
775 if (pattern
[0] == string
[0])
777 } else if (pattern
[0] == ']') {
779 } else if (patternLen
== 0) {
783 } else if (pattern
[1] == '-' && patternLen
>= 3) {
784 int start
= pattern
[0];
785 int end
= pattern
[2];
793 start
= tolower(start
);
799 if (c
>= start
&& c
<= end
)
803 if (pattern
[0] == string
[0])
806 if (tolower((int)pattern
[0]) == tolower((int)string
[0]))
816 return 0; /* no match */
822 if (patternLen
>= 2) {
829 if (pattern
[0] != string
[0])
830 return 0; /* no match */
832 if (tolower((int)pattern
[0]) != tolower((int)string
[0]))
833 return 0; /* no match */
841 if (stringLen
== 0) {
842 while(*pattern
== '*') {
849 if (patternLen
== 0 && stringLen
== 0)
854 static void redisLog(int level
, const char *fmt
, ...) {
858 fp
= (server
.logfile
== NULL
) ? stdout
: fopen(server
.logfile
,"a");
862 if (level
>= server
.verbosity
) {
868 strftime(buf
,64,"%d %b %H:%M:%S",localtime(&now
));
869 fprintf(fp
,"%s %c ",buf
,c
[level
]);
870 vfprintf(fp
, fmt
, ap
);
876 if (server
.logfile
) fclose(fp
);
879 /*====================== Hash table type implementation ==================== */
881 /* This is an hash table type that uses the SDS dynamic strings libary as
882 * keys and radis objects as values (objects can hold SDS strings,
885 static void dictVanillaFree(void *privdata
, void *val
)
887 DICT_NOTUSED(privdata
);
891 static void dictListDestructor(void *privdata
, void *val
)
893 DICT_NOTUSED(privdata
);
894 listRelease((list
*)val
);
897 static int sdsDictKeyCompare(void *privdata
, const void *key1
,
901 DICT_NOTUSED(privdata
);
903 l1
= sdslen((sds
)key1
);
904 l2
= sdslen((sds
)key2
);
905 if (l1
!= l2
) return 0;
906 return memcmp(key1
, key2
, l1
) == 0;
909 static void dictRedisObjectDestructor(void *privdata
, void *val
)
911 DICT_NOTUSED(privdata
);
913 if (val
== NULL
) return; /* Values of swapped out keys as set to NULL */
917 static int dictObjKeyCompare(void *privdata
, const void *key1
,
920 const robj
*o1
= key1
, *o2
= key2
;
921 return sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
924 static unsigned int dictObjHash(const void *key
) {
926 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
929 static int dictEncObjKeyCompare(void *privdata
, const void *key1
,
932 robj
*o1
= (robj
*) key1
, *o2
= (robj
*) key2
;
935 o1
= getDecodedObject(o1
);
936 o2
= getDecodedObject(o2
);
937 cmp
= sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
943 static unsigned int dictEncObjHash(const void *key
) {
944 robj
*o
= (robj
*) key
;
946 o
= getDecodedObject(o
);
947 unsigned int hash
= dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
952 /* Sets type and expires */
953 static dictType setDictType
= {
954 dictEncObjHash
, /* hash function */
957 dictEncObjKeyCompare
, /* key compare */
958 dictRedisObjectDestructor
, /* key destructor */
959 NULL
/* val destructor */
962 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
963 static dictType zsetDictType
= {
964 dictEncObjHash
, /* hash function */
967 dictEncObjKeyCompare
, /* key compare */
968 dictRedisObjectDestructor
, /* key destructor */
969 dictVanillaFree
/* val destructor of malloc(sizeof(double)) */
973 static dictType hashDictType
= {
974 dictObjHash
, /* hash function */
977 dictObjKeyCompare
, /* key compare */
978 dictRedisObjectDestructor
, /* key destructor */
979 dictRedisObjectDestructor
/* val destructor */
983 static dictType keyptrDictType
= {
984 dictObjHash
, /* hash function */
987 dictObjKeyCompare
, /* key compare */
988 dictRedisObjectDestructor
, /* key destructor */
989 NULL
/* val destructor */
992 /* Keylist hash table type has unencoded redis objects as keys and
993 * lists as values. It's used for blocking operations (BLPOP) */
994 static dictType keylistDictType
= {
995 dictObjHash
, /* hash function */
998 dictObjKeyCompare
, /* key compare */
999 dictRedisObjectDestructor
, /* key destructor */
1000 dictListDestructor
/* val destructor */
1003 /* ========================= Random utility functions ======================= */
1005 /* Redis generally does not try to recover from out of memory conditions
1006 * when allocating objects or strings, it is not clear if it will be possible
1007 * to report this condition to the client since the networking layer itself
1008 * is based on heap allocation for send buffers, so we simply abort.
1009 * At least the code will be simpler to read... */
1010 static void oom(const char *msg
) {
1011 redisLog(REDIS_WARNING
, "%s: Out of memory\n",msg
);
1016 /* ====================== Redis server networking stuff ===================== */
1017 static void closeTimedoutClients(void) {
1020 time_t now
= time(NULL
);
1022 listRewind(server
.clients
);
1023 while ((ln
= listYield(server
.clients
)) != NULL
) {
1024 c
= listNodeValue(ln
);
1025 if (server
.maxidletime
&&
1026 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
1027 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
1028 (now
- c
->lastinteraction
> server
.maxidletime
))
1030 redisLog(REDIS_VERBOSE
,"Closing idle client");
1032 } else if (c
->flags
& REDIS_BLOCKED
) {
1033 if (c
->blockingto
!= 0 && c
->blockingto
< now
) {
1034 addReply(c
,shared
.nullmultibulk
);
1041 static int htNeedsResize(dict
*dict
) {
1042 long long size
, used
;
1044 size
= dictSlots(dict
);
1045 used
= dictSize(dict
);
1046 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
1047 (used
*100/size
< REDIS_HT_MINFILL
));
1050 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
1051 * we resize the hash table to save memory */
1052 static void tryResizeHashTables(void) {
1055 for (j
= 0; j
< server
.dbnum
; j
++) {
1056 if (htNeedsResize(server
.db
[j
].dict
)) {
1057 redisLog(REDIS_VERBOSE
,"The hash table %d is too sparse, resize it...",j
);
1058 dictResize(server
.db
[j
].dict
);
1059 redisLog(REDIS_VERBOSE
,"Hash table %d resized.",j
);
1061 if (htNeedsResize(server
.db
[j
].expires
))
1062 dictResize(server
.db
[j
].expires
);
1066 /* A background saving child (BGSAVE) terminated its work. Handle this. */
1067 void backgroundSaveDoneHandler(int statloc
) {
1068 int exitcode
= WEXITSTATUS(statloc
);
1069 int bysignal
= WIFSIGNALED(statloc
);
1071 if (!bysignal
&& exitcode
== 0) {
1072 redisLog(REDIS_NOTICE
,
1073 "Background saving terminated with success");
1075 server
.lastsave
= time(NULL
);
1076 } else if (!bysignal
&& exitcode
!= 0) {
1077 redisLog(REDIS_WARNING
, "Background saving error");
1079 redisLog(REDIS_WARNING
,
1080 "Background saving terminated by signal");
1081 rdbRemoveTempFile(server
.bgsavechildpid
);
1083 server
.bgsavechildpid
= -1;
1084 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1085 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1086 updateSlavesWaitingBgsave(exitcode
== 0 ? REDIS_OK
: REDIS_ERR
);
1089 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1091 void backgroundRewriteDoneHandler(int statloc
) {
1092 int exitcode
= WEXITSTATUS(statloc
);
1093 int bysignal
= WIFSIGNALED(statloc
);
1095 if (!bysignal
&& exitcode
== 0) {
1099 redisLog(REDIS_NOTICE
,
1100 "Background append only file rewriting terminated with success");
1101 /* Now it's time to flush the differences accumulated by the parent */
1102 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) server
.bgrewritechildpid
);
1103 fd
= open(tmpfile
,O_WRONLY
|O_APPEND
);
1105 redisLog(REDIS_WARNING
, "Not able to open the temp append only file produced by the child: %s", strerror(errno
));
1108 /* Flush our data... */
1109 if (write(fd
,server
.bgrewritebuf
,sdslen(server
.bgrewritebuf
)) !=
1110 (signed) sdslen(server
.bgrewritebuf
)) {
1111 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
));
1115 redisLog(REDIS_NOTICE
,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server
.bgrewritebuf
));
1116 /* Now our work is to rename the temp file into the stable file. And
1117 * switch the file descriptor used by the server for append only. */
1118 if (rename(tmpfile
,server
.appendfilename
) == -1) {
1119 redisLog(REDIS_WARNING
,"Can't rename the temp append only file into the stable one: %s", strerror(errno
));
1123 /* Mission completed... almost */
1124 redisLog(REDIS_NOTICE
,"Append only file successfully rewritten.");
1125 if (server
.appendfd
!= -1) {
1126 /* If append only is actually enabled... */
1127 close(server
.appendfd
);
1128 server
.appendfd
= fd
;
1130 server
.appendseldb
= -1; /* Make sure it will issue SELECT */
1131 redisLog(REDIS_NOTICE
,"The new append only file was selected for future appends.");
1133 /* If append only is disabled we just generate a dump in this
1134 * format. Why not? */
1137 } else if (!bysignal
&& exitcode
!= 0) {
1138 redisLog(REDIS_WARNING
, "Background append only file rewriting error");
1140 redisLog(REDIS_WARNING
,
1141 "Background append only file rewriting terminated by signal");
1144 sdsfree(server
.bgrewritebuf
);
1145 server
.bgrewritebuf
= sdsempty();
1146 aofRemoveTempFile(server
.bgrewritechildpid
);
1147 server
.bgrewritechildpid
= -1;
1150 static int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
1151 int j
, loops
= server
.cronloops
++;
1152 REDIS_NOTUSED(eventLoop
);
1154 REDIS_NOTUSED(clientData
);
1156 /* We take a cached value of the unix time in the global state because
1157 * with virtual memory and aging there is to store the current time
1158 * in objects at every object access, and accuracy is not needed.
1159 * To access a global var is faster than calling time(NULL) */
1160 server
.unixtime
= time(NULL
);
1162 /* Update the global state with the amount of used memory */
1163 server
.usedmemory
= zmalloc_used_memory();
1165 /* Show some info about non-empty databases */
1166 for (j
= 0; j
< server
.dbnum
; j
++) {
1167 long long size
, used
, vkeys
;
1169 size
= dictSlots(server
.db
[j
].dict
);
1170 used
= dictSize(server
.db
[j
].dict
);
1171 vkeys
= dictSize(server
.db
[j
].expires
);
1172 if (!(loops
% 5) && (used
|| vkeys
)) {
1173 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
1174 /* dictPrintStats(server.dict); */
1178 /* We don't want to resize the hash tables while a bacground saving
1179 * is in progress: the saving child is created using fork() that is
1180 * implemented with a copy-on-write semantic in most modern systems, so
1181 * if we resize the HT while there is the saving child at work actually
1182 * a lot of memory movements in the parent will cause a lot of pages
1184 if (server
.bgsavechildpid
== -1) tryResizeHashTables();
1186 /* Show information about connected clients */
1188 redisLog(REDIS_VERBOSE
,"%d clients connected (%d slaves), %zu bytes in use, %d shared objects",
1189 listLength(server
.clients
)-listLength(server
.slaves
),
1190 listLength(server
.slaves
),
1192 dictSize(server
.sharingpool
));
1195 /* Close connections of timedout clients */
1196 if ((server
.maxidletime
&& !(loops
% 10)) || server
.blockedclients
)
1197 closeTimedoutClients();
1199 /* Check if a background saving or AOF rewrite in progress terminated */
1200 if (server
.bgsavechildpid
!= -1 || server
.bgrewritechildpid
!= -1) {
1204 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
1205 if (pid
== server
.bgsavechildpid
) {
1206 backgroundSaveDoneHandler(statloc
);
1208 backgroundRewriteDoneHandler(statloc
);
1212 /* If there is not a background saving in progress check if
1213 * we have to save now */
1214 time_t now
= time(NULL
);
1215 for (j
= 0; j
< server
.saveparamslen
; j
++) {
1216 struct saveparam
*sp
= server
.saveparams
+j
;
1218 if (server
.dirty
>= sp
->changes
&&
1219 now
-server
.lastsave
> sp
->seconds
) {
1220 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
1221 sp
->changes
, sp
->seconds
);
1222 rdbSaveBackground(server
.dbfilename
);
1228 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1229 * will use few CPU cycles if there are few expiring keys, otherwise
1230 * it will get more aggressive to avoid that too much memory is used by
1231 * keys that can be removed from the keyspace. */
1232 for (j
= 0; j
< server
.dbnum
; j
++) {
1234 redisDb
*db
= server
.db
+j
;
1236 /* Continue to expire if at the end of the cycle more than 25%
1237 * of the keys were expired. */
1239 long num
= dictSize(db
->expires
);
1240 time_t now
= time(NULL
);
1243 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
1244 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
1249 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
1250 t
= (time_t) dictGetEntryVal(de
);
1252 deleteKey(db
,dictGetEntryKey(de
));
1256 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
1259 /* Swap a few keys on disk if we are over the memory limit and VM
1260 * is enbled. Try to free objects from the free list first. */
1261 if (vmCanSwapOut()) {
1262 while (server
.vm_enabled
&& zmalloc_used_memory() >
1263 server
.vm_max_memory
)
1267 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
1268 retval
= (server
.vm_max_threads
== 0) ?
1269 vmSwapOneObjectBlocking() :
1270 vmSwapOneObjectThreaded();
1271 if (retval
== REDIS_ERR
&& (loops
% 30) == 0 &&
1272 zmalloc_used_memory() >
1273 (server
.vm_max_memory
+server
.vm_max_memory
/10))
1275 redisLog(REDIS_WARNING
,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1277 /* Note that when using threade I/O we free just one object,
1278 * because anyway when the I/O thread in charge to swap this
1279 * object out will finish, the handler of completed jobs
1280 * will try to swap more objects if we are still out of memory. */
1281 if (retval
== REDIS_ERR
|| server
.vm_max_threads
> 0) break;
1285 /* Check if we should connect to a MASTER */
1286 if (server
.replstate
== REDIS_REPL_CONNECT
) {
1287 redisLog(REDIS_NOTICE
,"Connecting to MASTER...");
1288 if (syncWithMaster() == REDIS_OK
) {
1289 redisLog(REDIS_NOTICE
,"MASTER <-> SLAVE sync succeeded");
1295 static void createSharedObjects(void) {
1296 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1297 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1298 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1299 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1300 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1301 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1302 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1303 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1304 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1305 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1306 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1307 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1308 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1309 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1310 "-ERR no such key\r\n"));
1311 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1312 "-ERR syntax error\r\n"));
1313 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1314 "-ERR source and destination objects are the same\r\n"));
1315 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1316 "-ERR index out of range\r\n"));
1317 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1318 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1319 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1320 shared
.select0
= createStringObject("select 0\r\n",10);
1321 shared
.select1
= createStringObject("select 1\r\n",10);
1322 shared
.select2
= createStringObject("select 2\r\n",10);
1323 shared
.select3
= createStringObject("select 3\r\n",10);
1324 shared
.select4
= createStringObject("select 4\r\n",10);
1325 shared
.select5
= createStringObject("select 5\r\n",10);
1326 shared
.select6
= createStringObject("select 6\r\n",10);
1327 shared
.select7
= createStringObject("select 7\r\n",10);
1328 shared
.select8
= createStringObject("select 8\r\n",10);
1329 shared
.select9
= createStringObject("select 9\r\n",10);
1332 static void appendServerSaveParams(time_t seconds
, int changes
) {
1333 server
.saveparams
= zrealloc(server
.saveparams
,sizeof(struct saveparam
)*(server
.saveparamslen
+1));
1334 server
.saveparams
[server
.saveparamslen
].seconds
= seconds
;
1335 server
.saveparams
[server
.saveparamslen
].changes
= changes
;
1336 server
.saveparamslen
++;
1339 static void resetServerSaveParams() {
1340 zfree(server
.saveparams
);
1341 server
.saveparams
= NULL
;
1342 server
.saveparamslen
= 0;
1345 static void initServerConfig() {
1346 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1347 server
.port
= REDIS_SERVERPORT
;
1348 server
.verbosity
= REDIS_VERBOSE
;
1349 server
.maxidletime
= REDIS_MAXIDLETIME
;
1350 server
.saveparams
= NULL
;
1351 server
.logfile
= NULL
; /* NULL = log on standard output */
1352 server
.bindaddr
= NULL
;
1353 server
.glueoutputbuf
= 1;
1354 server
.daemonize
= 0;
1355 server
.appendonly
= 0;
1356 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1357 server
.lastfsync
= time(NULL
);
1358 server
.appendfd
= -1;
1359 server
.appendseldb
= -1; /* Make sure the first time will not match */
1360 server
.pidfile
= "/var/run/redis.pid";
1361 server
.dbfilename
= "dump.rdb";
1362 server
.appendfilename
= "appendonly.aof";
1363 server
.requirepass
= NULL
;
1364 server
.shareobjects
= 0;
1365 server
.rdbcompression
= 1;
1366 server
.sharingpoolsize
= 1024;
1367 server
.maxclients
= 0;
1368 server
.blockedclients
= 0;
1369 server
.maxmemory
= 0;
1370 server
.vm_enabled
= 0;
1371 server
.vm_page_size
= 256; /* 256 bytes per page */
1372 server
.vm_pages
= 1024*1024*100; /* 104 millions of pages */
1373 server
.vm_max_memory
= 1024LL*1024*1024*1; /* 1 GB of RAM */
1374 server
.vm_max_threads
= 4;
1376 resetServerSaveParams();
1378 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1379 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1380 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1381 /* Replication related */
1383 server
.masterauth
= NULL
;
1384 server
.masterhost
= NULL
;
1385 server
.masterport
= 6379;
1386 server
.master
= NULL
;
1387 server
.replstate
= REDIS_REPL_NONE
;
1389 /* Double constants initialization */
1391 R_PosInf
= 1.0/R_Zero
;
1392 R_NegInf
= -1.0/R_Zero
;
1393 R_Nan
= R_Zero
/R_Zero
;
1396 static void initServer() {
1399 signal(SIGHUP
, SIG_IGN
);
1400 signal(SIGPIPE
, SIG_IGN
);
1401 setupSigSegvAction();
1403 server
.devnull
= fopen("/dev/null","w");
1404 if (server
.devnull
== NULL
) {
1405 redisLog(REDIS_WARNING
, "Can't open /dev/null: %s", server
.neterr
);
1408 server
.clients
= listCreate();
1409 server
.slaves
= listCreate();
1410 server
.monitors
= listCreate();
1411 server
.objfreelist
= listCreate();
1412 createSharedObjects();
1413 server
.el
= aeCreateEventLoop();
1414 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1415 server
.sharingpool
= dictCreate(&setDictType
,NULL
);
1416 server
.fd
= anetTcpServer(server
.neterr
, server
.port
, server
.bindaddr
);
1417 if (server
.fd
== -1) {
1418 redisLog(REDIS_WARNING
, "Opening TCP port: %s", server
.neterr
);
1421 for (j
= 0; j
< server
.dbnum
; j
++) {
1422 server
.db
[j
].dict
= dictCreate(&hashDictType
,NULL
);
1423 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1424 server
.db
[j
].blockingkeys
= dictCreate(&keylistDictType
,NULL
);
1425 server
.db
[j
].id
= j
;
1427 server
.cronloops
= 0;
1428 server
.bgsavechildpid
= -1;
1429 server
.bgrewritechildpid
= -1;
1430 server
.bgrewritebuf
= sdsempty();
1431 server
.lastsave
= time(NULL
);
1433 server
.usedmemory
= 0;
1434 server
.stat_numcommands
= 0;
1435 server
.stat_numconnections
= 0;
1436 server
.stat_starttime
= time(NULL
);
1437 server
.unixtime
= time(NULL
);
1438 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1439 if (aeCreateFileEvent(server
.el
, server
.fd
, AE_READABLE
,
1440 acceptHandler
, NULL
) == AE_ERR
) oom("creating file event");
1442 if (server
.appendonly
) {
1443 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1444 if (server
.appendfd
== -1) {
1445 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1451 if (server
.vm_enabled
) vmInit();
1454 /* Empty the whole database */
1455 static long long emptyDb() {
1457 long long removed
= 0;
1459 for (j
= 0; j
< server
.dbnum
; j
++) {
1460 removed
+= dictSize(server
.db
[j
].dict
);
1461 dictEmpty(server
.db
[j
].dict
);
1462 dictEmpty(server
.db
[j
].expires
);
1467 static int yesnotoi(char *s
) {
1468 if (!strcasecmp(s
,"yes")) return 1;
1469 else if (!strcasecmp(s
,"no")) return 0;
1473 /* I agree, this is a very rudimental way to load a configuration...
1474 will improve later if the config gets more complex */
1475 static void loadServerConfig(char *filename
) {
1477 char buf
[REDIS_CONFIGLINE_MAX
+1], *err
= NULL
;
1481 if (filename
[0] == '-' && filename
[1] == '\0')
1484 if ((fp
= fopen(filename
,"r")) == NULL
) {
1485 redisLog(REDIS_WARNING
,"Fatal error, can't open config file");
1490 while(fgets(buf
,REDIS_CONFIGLINE_MAX
+1,fp
) != NULL
) {
1496 line
= sdstrim(line
," \t\r\n");
1498 /* Skip comments and blank lines*/
1499 if (line
[0] == '#' || line
[0] == '\0') {
1504 /* Split into arguments */
1505 argv
= sdssplitlen(line
,sdslen(line
)," ",1,&argc
);
1506 sdstolower(argv
[0]);
1508 /* Execute config directives */
1509 if (!strcasecmp(argv
[0],"timeout") && argc
== 2) {
1510 server
.maxidletime
= atoi(argv
[1]);
1511 if (server
.maxidletime
< 0) {
1512 err
= "Invalid timeout value"; goto loaderr
;
1514 } else if (!strcasecmp(argv
[0],"port") && argc
== 2) {
1515 server
.port
= atoi(argv
[1]);
1516 if (server
.port
< 1 || server
.port
> 65535) {
1517 err
= "Invalid port"; goto loaderr
;
1519 } else if (!strcasecmp(argv
[0],"bind") && argc
== 2) {
1520 server
.bindaddr
= zstrdup(argv
[1]);
1521 } else if (!strcasecmp(argv
[0],"save") && argc
== 3) {
1522 int seconds
= atoi(argv
[1]);
1523 int changes
= atoi(argv
[2]);
1524 if (seconds
< 1 || changes
< 0) {
1525 err
= "Invalid save parameters"; goto loaderr
;
1527 appendServerSaveParams(seconds
,changes
);
1528 } else if (!strcasecmp(argv
[0],"dir") && argc
== 2) {
1529 if (chdir(argv
[1]) == -1) {
1530 redisLog(REDIS_WARNING
,"Can't chdir to '%s': %s",
1531 argv
[1], strerror(errno
));
1534 } else if (!strcasecmp(argv
[0],"loglevel") && argc
== 2) {
1535 if (!strcasecmp(argv
[1],"debug")) server
.verbosity
= REDIS_DEBUG
;
1536 else if (!strcasecmp(argv
[1],"verbose")) server
.verbosity
= REDIS_VERBOSE
;
1537 else if (!strcasecmp(argv
[1],"notice")) server
.verbosity
= REDIS_NOTICE
;
1538 else if (!strcasecmp(argv
[1],"warning")) server
.verbosity
= REDIS_WARNING
;
1540 err
= "Invalid log level. Must be one of debug, notice, warning";
1543 } else if (!strcasecmp(argv
[0],"logfile") && argc
== 2) {
1546 server
.logfile
= zstrdup(argv
[1]);
1547 if (!strcasecmp(server
.logfile
,"stdout")) {
1548 zfree(server
.logfile
);
1549 server
.logfile
= NULL
;
1551 if (server
.logfile
) {
1552 /* Test if we are able to open the file. The server will not
1553 * be able to abort just for this problem later... */
1554 logfp
= fopen(server
.logfile
,"a");
1555 if (logfp
== NULL
) {
1556 err
= sdscatprintf(sdsempty(),
1557 "Can't open the log file: %s", strerror(errno
));
1562 } else if (!strcasecmp(argv
[0],"databases") && argc
== 2) {
1563 server
.dbnum
= atoi(argv
[1]);
1564 if (server
.dbnum
< 1) {
1565 err
= "Invalid number of databases"; goto loaderr
;
1567 } else if (!strcasecmp(argv
[0],"maxclients") && argc
== 2) {
1568 server
.maxclients
= atoi(argv
[1]);
1569 } else if (!strcasecmp(argv
[0],"maxmemory") && argc
== 2) {
1570 server
.maxmemory
= strtoll(argv
[1], NULL
, 10);
1571 } else if (!strcasecmp(argv
[0],"slaveof") && argc
== 3) {
1572 server
.masterhost
= sdsnew(argv
[1]);
1573 server
.masterport
= atoi(argv
[2]);
1574 server
.replstate
= REDIS_REPL_CONNECT
;
1575 } else if (!strcasecmp(argv
[0],"masterauth") && argc
== 2) {
1576 server
.masterauth
= zstrdup(argv
[1]);
1577 } else if (!strcasecmp(argv
[0],"glueoutputbuf") && argc
== 2) {
1578 if ((server
.glueoutputbuf
= yesnotoi(argv
[1])) == -1) {
1579 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1581 } else if (!strcasecmp(argv
[0],"shareobjects") && argc
== 2) {
1582 if ((server
.shareobjects
= yesnotoi(argv
[1])) == -1) {
1583 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1585 } else if (!strcasecmp(argv
[0],"rdbcompression") && argc
== 2) {
1586 if ((server
.rdbcompression
= yesnotoi(argv
[1])) == -1) {
1587 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1589 } else if (!strcasecmp(argv
[0],"shareobjectspoolsize") && argc
== 2) {
1590 server
.sharingpoolsize
= atoi(argv
[1]);
1591 if (server
.sharingpoolsize
< 1) {
1592 err
= "invalid object sharing pool size"; goto loaderr
;
1594 } else if (!strcasecmp(argv
[0],"daemonize") && argc
== 2) {
1595 if ((server
.daemonize
= yesnotoi(argv
[1])) == -1) {
1596 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1598 } else if (!strcasecmp(argv
[0],"appendonly") && argc
== 2) {
1599 if ((server
.appendonly
= yesnotoi(argv
[1])) == -1) {
1600 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1602 } else if (!strcasecmp(argv
[0],"appendfsync") && argc
== 2) {
1603 if (!strcasecmp(argv
[1],"no")) {
1604 server
.appendfsync
= APPENDFSYNC_NO
;
1605 } else if (!strcasecmp(argv
[1],"always")) {
1606 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1607 } else if (!strcasecmp(argv
[1],"everysec")) {
1608 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1610 err
= "argument must be 'no', 'always' or 'everysec'";
1613 } else if (!strcasecmp(argv
[0],"requirepass") && argc
== 2) {
1614 server
.requirepass
= zstrdup(argv
[1]);
1615 } else if (!strcasecmp(argv
[0],"pidfile") && argc
== 2) {
1616 server
.pidfile
= zstrdup(argv
[1]);
1617 } else if (!strcasecmp(argv
[0],"dbfilename") && argc
== 2) {
1618 server
.dbfilename
= zstrdup(argv
[1]);
1619 } else if (!strcasecmp(argv
[0],"vm-enabled") && argc
== 2) {
1620 if ((server
.vm_enabled
= yesnotoi(argv
[1])) == -1) {
1621 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1623 } else if (!strcasecmp(argv
[0],"vm-max-memory") && argc
== 2) {
1624 server
.vm_max_memory
= strtoll(argv
[1], NULL
, 10);
1625 } else if (!strcasecmp(argv
[0],"vm-page-size") && argc
== 2) {
1626 server
.vm_page_size
= strtoll(argv
[1], NULL
, 10);
1627 } else if (!strcasecmp(argv
[0],"vm-pages") && argc
== 2) {
1628 server
.vm_pages
= strtoll(argv
[1], NULL
, 10);
1629 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1630 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1632 err
= "Bad directive or wrong number of arguments"; goto loaderr
;
1634 for (j
= 0; j
< argc
; j
++)
1639 if (fp
!= stdin
) fclose(fp
);
1643 fprintf(stderr
, "\n*** FATAL CONFIG FILE ERROR ***\n");
1644 fprintf(stderr
, "Reading the configuration file, at line %d\n", linenum
);
1645 fprintf(stderr
, ">>> '%s'\n", line
);
1646 fprintf(stderr
, "%s\n", err
);
1650 static void freeClientArgv(redisClient
*c
) {
1653 for (j
= 0; j
< c
->argc
; j
++)
1654 decrRefCount(c
->argv
[j
]);
1655 for (j
= 0; j
< c
->mbargc
; j
++)
1656 decrRefCount(c
->mbargv
[j
]);
1661 static void freeClient(redisClient
*c
) {
1664 /* Note that if the client we are freeing is blocked into a blocking
1665 * call, we have to set querybuf to NULL *before* to call unblockClient()
1666 * to avoid processInputBuffer() will get called. Also it is important
1667 * to remove the file events after this, because this call adds
1668 * the READABLE event. */
1669 sdsfree(c
->querybuf
);
1671 if (c
->flags
& REDIS_BLOCKED
)
1674 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
1675 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1676 listRelease(c
->reply
);
1679 /* Remove from the list of clients */
1680 ln
= listSearchKey(server
.clients
,c
);
1681 redisAssert(ln
!= NULL
);
1682 listDelNode(server
.clients
,ln
);
1683 /* Remove from the list of clients waiting for VM operations */
1684 if (server
.vm_enabled
&& listLength(c
->io_keys
)) {
1685 ln
= listSearchKey(server
.io_clients
,c
);
1686 if (ln
) listDelNode(server
.io_clients
,ln
);
1687 listRelease(c
->io_keys
);
1689 listRelease(c
->io_keys
);
1691 if (c
->flags
& REDIS_SLAVE
) {
1692 if (c
->replstate
== REDIS_REPL_SEND_BULK
&& c
->repldbfd
!= -1)
1694 list
*l
= (c
->flags
& REDIS_MONITOR
) ? server
.monitors
: server
.slaves
;
1695 ln
= listSearchKey(l
,c
);
1696 redisAssert(ln
!= NULL
);
1699 if (c
->flags
& REDIS_MASTER
) {
1700 server
.master
= NULL
;
1701 server
.replstate
= REDIS_REPL_CONNECT
;
1705 freeClientMultiState(c
);
1709 #define GLUEREPLY_UP_TO (1024)
1710 static void glueReplyBuffersIfNeeded(redisClient
*c
) {
1712 char buf
[GLUEREPLY_UP_TO
];
1716 listRewind(c
->reply
);
1717 while((ln
= listYield(c
->reply
))) {
1721 objlen
= sdslen(o
->ptr
);
1722 if (copylen
+ objlen
<= GLUEREPLY_UP_TO
) {
1723 memcpy(buf
+copylen
,o
->ptr
,objlen
);
1725 listDelNode(c
->reply
,ln
);
1727 if (copylen
== 0) return;
1731 /* Now the output buffer is empty, add the new single element */
1732 o
= createObject(REDIS_STRING
,sdsnewlen(buf
,copylen
));
1733 listAddNodeHead(c
->reply
,o
);
1736 static void sendReplyToClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
1737 redisClient
*c
= privdata
;
1738 int nwritten
= 0, totwritten
= 0, objlen
;
1741 REDIS_NOTUSED(mask
);
1743 /* Use writev() if we have enough buffers to send */
1744 if (!server
.glueoutputbuf
&&
1745 listLength(c
->reply
) > REDIS_WRITEV_THRESHOLD
&&
1746 !(c
->flags
& REDIS_MASTER
))
1748 sendReplyToClientWritev(el
, fd
, privdata
, mask
);
1752 while(listLength(c
->reply
)) {
1753 if (server
.glueoutputbuf
&& listLength(c
->reply
) > 1)
1754 glueReplyBuffersIfNeeded(c
);
1756 o
= listNodeValue(listFirst(c
->reply
));
1757 objlen
= sdslen(o
->ptr
);
1760 listDelNode(c
->reply
,listFirst(c
->reply
));
1764 if (c
->flags
& REDIS_MASTER
) {
1765 /* Don't reply to a master */
1766 nwritten
= objlen
- c
->sentlen
;
1768 nwritten
= write(fd
, ((char*)o
->ptr
)+c
->sentlen
, objlen
- c
->sentlen
);
1769 if (nwritten
<= 0) break;
1771 c
->sentlen
+= nwritten
;
1772 totwritten
+= nwritten
;
1773 /* If we fully sent the object on head go to the next one */
1774 if (c
->sentlen
== objlen
) {
1775 listDelNode(c
->reply
,listFirst(c
->reply
));
1778 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
1779 * bytes, in a single threaded server it's a good idea to serve
1780 * other clients as well, even if a very large request comes from
1781 * super fast link that is always able to accept data (in real world
1782 * scenario think about 'KEYS *' against the loopback interfae) */
1783 if (totwritten
> REDIS_MAX_WRITE_PER_EVENT
) break;
1785 if (nwritten
== -1) {
1786 if (errno
== EAGAIN
) {
1789 redisLog(REDIS_VERBOSE
,
1790 "Error writing to client: %s", strerror(errno
));
1795 if (totwritten
> 0) c
->lastinteraction
= time(NULL
);
1796 if (listLength(c
->reply
) == 0) {
1798 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1802 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
)
1804 redisClient
*c
= privdata
;
1805 int nwritten
= 0, totwritten
= 0, objlen
, willwrite
;
1807 struct iovec iov
[REDIS_WRITEV_IOVEC_COUNT
];
1808 int offset
, ion
= 0;
1810 REDIS_NOTUSED(mask
);
1813 while (listLength(c
->reply
)) {
1814 offset
= c
->sentlen
;
1818 /* fill-in the iov[] array */
1819 for(node
= listFirst(c
->reply
); node
; node
= listNextNode(node
)) {
1820 o
= listNodeValue(node
);
1821 objlen
= sdslen(o
->ptr
);
1823 if (totwritten
+ objlen
- offset
> REDIS_MAX_WRITE_PER_EVENT
)
1826 if(ion
== REDIS_WRITEV_IOVEC_COUNT
)
1827 break; /* no more iovecs */
1829 iov
[ion
].iov_base
= ((char*)o
->ptr
) + offset
;
1830 iov
[ion
].iov_len
= objlen
- offset
;
1831 willwrite
+= objlen
- offset
;
1832 offset
= 0; /* just for the first item */
1839 /* write all collected blocks at once */
1840 if((nwritten
= writev(fd
, iov
, ion
)) < 0) {
1841 if (errno
!= EAGAIN
) {
1842 redisLog(REDIS_VERBOSE
,
1843 "Error writing to client: %s", strerror(errno
));
1850 totwritten
+= nwritten
;
1851 offset
= c
->sentlen
;
1853 /* remove written robjs from c->reply */
1854 while (nwritten
&& listLength(c
->reply
)) {
1855 o
= listNodeValue(listFirst(c
->reply
));
1856 objlen
= sdslen(o
->ptr
);
1858 if(nwritten
>= objlen
- offset
) {
1859 listDelNode(c
->reply
, listFirst(c
->reply
));
1860 nwritten
-= objlen
- offset
;
1864 c
->sentlen
+= nwritten
;
1872 c
->lastinteraction
= time(NULL
);
1874 if (listLength(c
->reply
) == 0) {
1876 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1880 static struct redisCommand
*lookupCommand(char *name
) {
1882 while(cmdTable
[j
].name
!= NULL
) {
1883 if (!strcasecmp(name
,cmdTable
[j
].name
)) return &cmdTable
[j
];
1889 /* resetClient prepare the client to process the next command */
1890 static void resetClient(redisClient
*c
) {
1896 /* Call() is the core of Redis execution of a command */
1897 static void call(redisClient
*c
, struct redisCommand
*cmd
) {
1900 dirty
= server
.dirty
;
1902 if (server
.appendonly
&& server
.dirty
-dirty
)
1903 feedAppendOnlyFile(cmd
,c
->db
->id
,c
->argv
,c
->argc
);
1904 if (server
.dirty
-dirty
&& listLength(server
.slaves
))
1905 replicationFeedSlaves(server
.slaves
,cmd
,c
->db
->id
,c
->argv
,c
->argc
);
1906 if (listLength(server
.monitors
))
1907 replicationFeedSlaves(server
.monitors
,cmd
,c
->db
->id
,c
->argv
,c
->argc
);
1908 server
.stat_numcommands
++;
1911 /* If this function gets called we already read a whole
1912 * command, argments are in the client argv/argc fields.
1913 * processCommand() execute the command or prepare the
1914 * server for a bulk read from the client.
1916 * If 1 is returned the client is still alive and valid and
1917 * and other operations can be performed by the caller. Otherwise
1918 * if 0 is returned the client was destroied (i.e. after QUIT). */
1919 static int processCommand(redisClient
*c
) {
1920 struct redisCommand
*cmd
;
1922 /* Free some memory if needed (maxmemory setting) */
1923 if (server
.maxmemory
) freeMemoryIfNeeded();
1925 /* Handle the multi bulk command type. This is an alternative protocol
1926 * supported by Redis in order to receive commands that are composed of
1927 * multiple binary-safe "bulk" arguments. The latency of processing is
1928 * a bit higher but this allows things like multi-sets, so if this
1929 * protocol is used only for MSET and similar commands this is a big win. */
1930 if (c
->multibulk
== 0 && c
->argc
== 1 && ((char*)(c
->argv
[0]->ptr
))[0] == '*') {
1931 c
->multibulk
= atoi(((char*)c
->argv
[0]->ptr
)+1);
1932 if (c
->multibulk
<= 0) {
1936 decrRefCount(c
->argv
[c
->argc
-1]);
1940 } else if (c
->multibulk
) {
1941 if (c
->bulklen
== -1) {
1942 if (((char*)c
->argv
[0]->ptr
)[0] != '$') {
1943 addReplySds(c
,sdsnew("-ERR multi bulk protocol error\r\n"));
1947 int bulklen
= atoi(((char*)c
->argv
[0]->ptr
)+1);
1948 decrRefCount(c
->argv
[0]);
1949 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
1951 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
1956 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
1960 c
->mbargv
= zrealloc(c
->mbargv
,(sizeof(robj
*))*(c
->mbargc
+1));
1961 c
->mbargv
[c
->mbargc
] = c
->argv
[0];
1965 if (c
->multibulk
== 0) {
1969 /* Here we need to swap the multi-bulk argc/argv with the
1970 * normal argc/argv of the client structure. */
1972 c
->argv
= c
->mbargv
;
1973 c
->mbargv
= auxargv
;
1976 c
->argc
= c
->mbargc
;
1977 c
->mbargc
= auxargc
;
1979 /* We need to set bulklen to something different than -1
1980 * in order for the code below to process the command without
1981 * to try to read the last argument of a bulk command as
1982 * a special argument. */
1984 /* continue below and process the command */
1991 /* -- end of multi bulk commands processing -- */
1993 /* The QUIT command is handled as a special case. Normal command
1994 * procs are unable to close the client connection safely */
1995 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
1999 cmd
= lookupCommand(c
->argv
[0]->ptr
);
2002 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2003 (char*)c
->argv
[0]->ptr
));
2006 } else if ((cmd
->arity
> 0 && cmd
->arity
!= c
->argc
) ||
2007 (c
->argc
< -cmd
->arity
)) {
2009 sdscatprintf(sdsempty(),
2010 "-ERR wrong number of arguments for '%s' command\r\n",
2014 } else if (server
.maxmemory
&& cmd
->flags
& REDIS_CMD_DENYOOM
&& zmalloc_used_memory() > server
.maxmemory
) {
2015 addReplySds(c
,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2018 } else if (cmd
->flags
& REDIS_CMD_BULK
&& c
->bulklen
== -1) {
2019 int bulklen
= atoi(c
->argv
[c
->argc
-1]->ptr
);
2021 decrRefCount(c
->argv
[c
->argc
-1]);
2022 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2024 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2029 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2030 /* It is possible that the bulk read is already in the
2031 * buffer. Check this condition and handle it accordingly.
2032 * This is just a fast path, alternative to call processInputBuffer().
2033 * It's a good idea since the code is small and this condition
2034 * happens most of the times. */
2035 if ((signed)sdslen(c
->querybuf
) >= c
->bulklen
) {
2036 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2038 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2043 /* Let's try to share objects on the command arguments vector */
2044 if (server
.shareobjects
) {
2046 for(j
= 1; j
< c
->argc
; j
++)
2047 c
->argv
[j
] = tryObjectSharing(c
->argv
[j
]);
2049 /* Let's try to encode the bulk object to save space. */
2050 if (cmd
->flags
& REDIS_CMD_BULK
)
2051 tryObjectEncoding(c
->argv
[c
->argc
-1]);
2053 /* Check if the user is authenticated */
2054 if (server
.requirepass
&& !c
->authenticated
&& cmd
->proc
!= authCommand
) {
2055 addReplySds(c
,sdsnew("-ERR operation not permitted\r\n"));
2060 /* Exec the command */
2061 if (c
->flags
& REDIS_MULTI
&& cmd
->proc
!= execCommand
) {
2062 queueMultiCommand(c
,cmd
);
2063 addReply(c
,shared
.queued
);
2068 /* Prepare the client for the next command */
2069 if (c
->flags
& REDIS_CLOSE
) {
2077 static void replicationFeedSlaves(list
*slaves
, struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
2081 /* (args*2)+1 is enough room for args, spaces, newlines */
2082 robj
*static_outv
[REDIS_STATIC_ARGS
*2+1];
2084 if (argc
<= REDIS_STATIC_ARGS
) {
2087 outv
= zmalloc(sizeof(robj
*)*(argc
*2+1));
2090 for (j
= 0; j
< argc
; j
++) {
2091 if (j
!= 0) outv
[outc
++] = shared
.space
;
2092 if ((cmd
->flags
& REDIS_CMD_BULK
) && j
== argc
-1) {
2095 lenobj
= createObject(REDIS_STRING
,
2096 sdscatprintf(sdsempty(),"%lu\r\n",
2097 (unsigned long) stringObjectLen(argv
[j
])));
2098 lenobj
->refcount
= 0;
2099 outv
[outc
++] = lenobj
;
2101 outv
[outc
++] = argv
[j
];
2103 outv
[outc
++] = shared
.crlf
;
2105 /* Increment all the refcounts at start and decrement at end in order to
2106 * be sure to free objects if there is no slave in a replication state
2107 * able to be feed with commands */
2108 for (j
= 0; j
< outc
; j
++) incrRefCount(outv
[j
]);
2110 while((ln
= listYield(slaves
))) {
2111 redisClient
*slave
= ln
->value
;
2113 /* Don't feed slaves that are still waiting for BGSAVE to start */
2114 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) continue;
2116 /* Feed all the other slaves, MONITORs and so on */
2117 if (slave
->slaveseldb
!= dictid
) {
2121 case 0: selectcmd
= shared
.select0
; break;
2122 case 1: selectcmd
= shared
.select1
; break;
2123 case 2: selectcmd
= shared
.select2
; break;
2124 case 3: selectcmd
= shared
.select3
; break;
2125 case 4: selectcmd
= shared
.select4
; break;
2126 case 5: selectcmd
= shared
.select5
; break;
2127 case 6: selectcmd
= shared
.select6
; break;
2128 case 7: selectcmd
= shared
.select7
; break;
2129 case 8: selectcmd
= shared
.select8
; break;
2130 case 9: selectcmd
= shared
.select9
; break;
2132 selectcmd
= createObject(REDIS_STRING
,
2133 sdscatprintf(sdsempty(),"select %d\r\n",dictid
));
2134 selectcmd
->refcount
= 0;
2137 addReply(slave
,selectcmd
);
2138 slave
->slaveseldb
= dictid
;
2140 for (j
= 0; j
< outc
; j
++) addReply(slave
,outv
[j
]);
2142 for (j
= 0; j
< outc
; j
++) decrRefCount(outv
[j
]);
2143 if (outv
!= static_outv
) zfree(outv
);
2146 static void processInputBuffer(redisClient
*c
) {
2148 /* Before to process the input buffer, make sure the client is not
2149 * waitig for a blocking operation such as BLPOP. Note that the first
2150 * iteration the client is never blocked, otherwise the processInputBuffer
2151 * would not be called at all, but after the execution of the first commands
2152 * in the input buffer the client may be blocked, and the "goto again"
2153 * will try to reiterate. The following line will make it return asap. */
2154 if (c
->flags
& REDIS_BLOCKED
|| c
->flags
& REDIS_IO_WAIT
) return;
2155 if (c
->bulklen
== -1) {
2156 /* Read the first line of the query */
2157 char *p
= strchr(c
->querybuf
,'\n');
2164 query
= c
->querybuf
;
2165 c
->querybuf
= sdsempty();
2166 querylen
= 1+(p
-(query
));
2167 if (sdslen(query
) > querylen
) {
2168 /* leave data after the first line of the query in the buffer */
2169 c
->querybuf
= sdscatlen(c
->querybuf
,query
+querylen
,sdslen(query
)-querylen
);
2171 *p
= '\0'; /* remove "\n" */
2172 if (*(p
-1) == '\r') *(p
-1) = '\0'; /* and "\r" if any */
2173 sdsupdatelen(query
);
2175 /* Now we can split the query in arguments */
2176 argv
= sdssplitlen(query
,sdslen(query
)," ",1,&argc
);
2179 if (c
->argv
) zfree(c
->argv
);
2180 c
->argv
= zmalloc(sizeof(robj
*)*argc
);
2182 for (j
= 0; j
< argc
; j
++) {
2183 if (sdslen(argv
[j
])) {
2184 c
->argv
[c
->argc
] = createObject(REDIS_STRING
,argv
[j
]);
2192 /* Execute the command. If the client is still valid
2193 * after processCommand() return and there is something
2194 * on the query buffer try to process the next command. */
2195 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2197 /* Nothing to process, argc == 0. Just process the query
2198 * buffer if it's not empty or return to the caller */
2199 if (sdslen(c
->querybuf
)) goto again
;
2202 } else if (sdslen(c
->querybuf
) >= REDIS_REQUEST_MAX_SIZE
) {
2203 redisLog(REDIS_VERBOSE
, "Client protocol error");
2208 /* Bulk read handling. Note that if we are at this point
2209 the client already sent a command terminated with a newline,
2210 we are reading the bulk data that is actually the last
2211 argument of the command. */
2212 int qbl
= sdslen(c
->querybuf
);
2214 if (c
->bulklen
<= qbl
) {
2215 /* Copy everything but the final CRLF as final argument */
2216 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2218 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2219 /* Process the command. If the client is still valid after
2220 * the processing and there is more data in the buffer
2221 * try to parse it. */
2222 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2228 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2229 redisClient
*c
= (redisClient
*) privdata
;
2230 char buf
[REDIS_IOBUF_LEN
];
2233 REDIS_NOTUSED(mask
);
2235 nread
= read(fd
, buf
, REDIS_IOBUF_LEN
);
2237 if (errno
== EAGAIN
) {
2240 redisLog(REDIS_VERBOSE
, "Reading from client: %s",strerror(errno
));
2244 } else if (nread
== 0) {
2245 redisLog(REDIS_VERBOSE
, "Client closed connection");
2250 c
->querybuf
= sdscatlen(c
->querybuf
, buf
, nread
);
2251 c
->lastinteraction
= time(NULL
);
2255 processInputBuffer(c
);
2258 static int selectDb(redisClient
*c
, int id
) {
2259 if (id
< 0 || id
>= server
.dbnum
)
2261 c
->db
= &server
.db
[id
];
2265 static void *dupClientReplyValue(void *o
) {
2266 incrRefCount((robj
*)o
);
2270 static redisClient
*createClient(int fd
) {
2271 redisClient
*c
= zmalloc(sizeof(*c
));
2273 anetNonBlock(NULL
,fd
);
2274 anetTcpNoDelay(NULL
,fd
);
2275 if (!c
) return NULL
;
2278 c
->querybuf
= sdsempty();
2287 c
->lastinteraction
= time(NULL
);
2288 c
->authenticated
= 0;
2289 c
->replstate
= REDIS_REPL_NONE
;
2290 c
->reply
= listCreate();
2291 listSetFreeMethod(c
->reply
,decrRefCount
);
2292 listSetDupMethod(c
->reply
,dupClientReplyValue
);
2293 c
->blockingkeys
= NULL
;
2294 c
->blockingkeysnum
= 0;
2295 c
->io_keys
= listCreate();
2296 listSetFreeMethod(c
->io_keys
,decrRefCount
);
2297 if (aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
2298 readQueryFromClient
, c
) == AE_ERR
) {
2302 listAddNodeTail(server
.clients
,c
);
2303 initClientMultiState(c
);
2307 static void addReply(redisClient
*c
, robj
*obj
) {
2308 if (listLength(c
->reply
) == 0 &&
2309 (c
->replstate
== REDIS_REPL_NONE
||
2310 c
->replstate
== REDIS_REPL_ONLINE
) &&
2311 aeCreateFileEvent(server
.el
, c
->fd
, AE_WRITABLE
,
2312 sendReplyToClient
, c
) == AE_ERR
) return;
2314 if (server
.vm_enabled
&& obj
->storage
!= REDIS_VM_MEMORY
) {
2315 obj
= dupStringObject(obj
);
2316 obj
->refcount
= 0; /* getDecodedObject() will increment the refcount */
2318 listAddNodeTail(c
->reply
,getDecodedObject(obj
));
2321 static void addReplySds(redisClient
*c
, sds s
) {
2322 robj
*o
= createObject(REDIS_STRING
,s
);
2327 static void addReplyDouble(redisClient
*c
, double d
) {
2330 snprintf(buf
,sizeof(buf
),"%.17g",d
);
2331 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2332 (unsigned long) strlen(buf
),buf
));
2335 static void addReplyBulkLen(redisClient
*c
, robj
*obj
) {
2338 if (obj
->encoding
== REDIS_ENCODING_RAW
) {
2339 len
= sdslen(obj
->ptr
);
2341 long n
= (long)obj
->ptr
;
2343 /* Compute how many bytes will take this integer as a radix 10 string */
2349 while((n
= n
/10) != 0) {
2353 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",(unsigned long)len
));
2356 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2361 REDIS_NOTUSED(mask
);
2362 REDIS_NOTUSED(privdata
);
2364 cfd
= anetAccept(server
.neterr
, fd
, cip
, &cport
);
2365 if (cfd
== AE_ERR
) {
2366 redisLog(REDIS_VERBOSE
,"Accepting client connection: %s", server
.neterr
);
2369 redisLog(REDIS_VERBOSE
,"Accepted %s:%d", cip
, cport
);
2370 if ((c
= createClient(cfd
)) == NULL
) {
2371 redisLog(REDIS_WARNING
,"Error allocating resoures for the client");
2372 close(cfd
); /* May be already closed, just ingore errors */
2375 /* If maxclient directive is set and this is one client more... close the
2376 * connection. Note that we create the client instead to check before
2377 * for this condition, since now the socket is already set in nonblocking
2378 * mode and we can send an error for free using the Kernel I/O */
2379 if (server
.maxclients
&& listLength(server
.clients
) > server
.maxclients
) {
2380 char *err
= "-ERR max number of clients reached\r\n";
2382 /* That's a best effort error message, don't check write errors */
2383 if (write(c
->fd
,err
,strlen(err
)) == -1) {
2384 /* Nothing to do, Just to avoid the warning... */
2389 server
.stat_numconnections
++;
2392 /* ======================= Redis objects implementation ===================== */
2394 static robj
*createObject(int type
, void *ptr
) {
2397 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2398 if (listLength(server
.objfreelist
)) {
2399 listNode
*head
= listFirst(server
.objfreelist
);
2400 o
= listNodeValue(head
);
2401 listDelNode(server
.objfreelist
,head
);
2402 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2404 if (server
.vm_enabled
) {
2405 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2406 o
= zmalloc(sizeof(*o
));
2408 o
= zmalloc(sizeof(*o
)-sizeof(struct redisObjectVM
));
2412 o
->encoding
= REDIS_ENCODING_RAW
;
2415 if (server
.vm_enabled
) {
2416 o
->vm
.atime
= server
.unixtime
;
2417 o
->storage
= REDIS_VM_MEMORY
;
2422 static robj
*createStringObject(char *ptr
, size_t len
) {
2423 return createObject(REDIS_STRING
,sdsnewlen(ptr
,len
));
2426 static robj
*dupStringObject(robj
*o
) {
2427 assert(o
->encoding
== REDIS_ENCODING_RAW
);
2428 return createStringObject(o
->ptr
,sdslen(o
->ptr
));
2431 static robj
*createListObject(void) {
2432 list
*l
= listCreate();
2434 listSetFreeMethod(l
,decrRefCount
);
2435 return createObject(REDIS_LIST
,l
);
2438 static robj
*createSetObject(void) {
2439 dict
*d
= dictCreate(&setDictType
,NULL
);
2440 return createObject(REDIS_SET
,d
);
2443 static robj
*createZsetObject(void) {
2444 zset
*zs
= zmalloc(sizeof(*zs
));
2446 zs
->dict
= dictCreate(&zsetDictType
,NULL
);
2447 zs
->zsl
= zslCreate();
2448 return createObject(REDIS_ZSET
,zs
);
2451 static void freeStringObject(robj
*o
) {
2452 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2457 static void freeListObject(robj
*o
) {
2458 listRelease((list
*) o
->ptr
);
2461 static void freeSetObject(robj
*o
) {
2462 dictRelease((dict
*) o
->ptr
);
2465 static void freeZsetObject(robj
*o
) {
2468 dictRelease(zs
->dict
);
2473 static void freeHashObject(robj
*o
) {
2474 dictRelease((dict
*) o
->ptr
);
2477 static void incrRefCount(robj
*o
) {
2478 redisAssert(!server
.vm_enabled
|| o
->storage
== REDIS_VM_MEMORY
);
2482 static void decrRefCount(void *obj
) {
2485 /* Object is swapped out, or in the process of being loaded. */
2486 if (server
.vm_enabled
&&
2487 (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
))
2489 if (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
) {
2490 redisAssert(o
->refcount
== 1);
2492 if (o
->storage
== REDIS_VM_LOADING
) vmCancelThreadedIOJob(obj
);
2493 redisAssert(o
->type
== REDIS_STRING
);
2494 freeStringObject(o
);
2495 vmMarkPagesFree(o
->vm
.page
,o
->vm
.usedpages
);
2496 pthread_mutex_lock(&server
.obj_freelist_mutex
);
2497 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2498 !listAddNodeHead(server
.objfreelist
,o
))
2500 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2501 server
.vm_stats_swapped_objects
--;
2504 /* Object is in memory, or in the process of being swapped out. */
2505 if (--(o
->refcount
) == 0) {
2506 if (server
.vm_enabled
&& o
->storage
== REDIS_VM_SWAPPING
)
2507 vmCancelThreadedIOJob(obj
);
2509 case REDIS_STRING
: freeStringObject(o
); break;
2510 case REDIS_LIST
: freeListObject(o
); break;
2511 case REDIS_SET
: freeSetObject(o
); break;
2512 case REDIS_ZSET
: freeZsetObject(o
); break;
2513 case REDIS_HASH
: freeHashObject(o
); break;
2514 default: redisAssert(0 != 0); break;
2516 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2517 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2518 !listAddNodeHead(server
.objfreelist
,o
))
2520 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2524 static robj
*lookupKey(redisDb
*db
, robj
*key
) {
2525 dictEntry
*de
= dictFind(db
->dict
,key
);
2527 robj
*key
= dictGetEntryKey(de
);
2528 robj
*val
= dictGetEntryVal(de
);
2530 if (server
.vm_enabled
) {
2531 if (key
->storage
== REDIS_VM_MEMORY
||
2532 key
->storage
== REDIS_VM_SWAPPING
)
2534 /* If we were swapping the object out, stop it, this key
2536 if (key
->storage
== REDIS_VM_SWAPPING
)
2537 vmCancelThreadedIOJob(key
);
2538 /* Update the access time of the key for the aging algorithm. */
2539 key
->vm
.atime
= server
.unixtime
;
2541 /* Our value was swapped on disk. Bring it at home. */
2542 redisAssert(val
== NULL
);
2543 val
= vmLoadObject(key
);
2544 dictGetEntryVal(de
) = val
;
2553 static robj
*lookupKeyRead(redisDb
*db
, robj
*key
) {
2554 expireIfNeeded(db
,key
);
2555 return lookupKey(db
,key
);
2558 static robj
*lookupKeyWrite(redisDb
*db
, robj
*key
) {
2559 deleteIfVolatile(db
,key
);
2560 return lookupKey(db
,key
);
2563 static int deleteKey(redisDb
*db
, robj
*key
) {
2566 /* We need to protect key from destruction: after the first dictDelete()
2567 * it may happen that 'key' is no longer valid if we don't increment
2568 * it's count. This may happen when we get the object reference directly
2569 * from the hash table with dictRandomKey() or dict iterators */
2571 if (dictSize(db
->expires
)) dictDelete(db
->expires
,key
);
2572 retval
= dictDelete(db
->dict
,key
);
2575 return retval
== DICT_OK
;
2578 /* Try to share an object against the shared objects pool */
2579 static robj
*tryObjectSharing(robj
*o
) {
2580 struct dictEntry
*de
;
2583 if (o
== NULL
|| server
.shareobjects
== 0) return o
;
2585 redisAssert(o
->type
== REDIS_STRING
);
2586 de
= dictFind(server
.sharingpool
,o
);
2588 robj
*shared
= dictGetEntryKey(de
);
2590 c
= ((unsigned long) dictGetEntryVal(de
))+1;
2591 dictGetEntryVal(de
) = (void*) c
;
2592 incrRefCount(shared
);
2596 /* Here we are using a stream algorihtm: Every time an object is
2597 * shared we increment its count, everytime there is a miss we
2598 * recrement the counter of a random object. If this object reaches
2599 * zero we remove the object and put the current object instead. */
2600 if (dictSize(server
.sharingpool
) >=
2601 server
.sharingpoolsize
) {
2602 de
= dictGetRandomKey(server
.sharingpool
);
2603 redisAssert(de
!= NULL
);
2604 c
= ((unsigned long) dictGetEntryVal(de
))-1;
2605 dictGetEntryVal(de
) = (void*) c
;
2607 dictDelete(server
.sharingpool
,de
->key
);
2610 c
= 0; /* If the pool is empty we want to add this object */
2615 retval
= dictAdd(server
.sharingpool
,o
,(void*)1);
2616 redisAssert(retval
== DICT_OK
);
2623 /* Check if the nul-terminated string 's' can be represented by a long
2624 * (that is, is a number that fits into long without any other space or
2625 * character before or after the digits).
2627 * If so, the function returns REDIS_OK and *longval is set to the value
2628 * of the number. Otherwise REDIS_ERR is returned */
2629 static int isStringRepresentableAsLong(sds s
, long *longval
) {
2630 char buf
[32], *endptr
;
2634 value
= strtol(s
, &endptr
, 10);
2635 if (endptr
[0] != '\0') return REDIS_ERR
;
2636 slen
= snprintf(buf
,32,"%ld",value
);
2638 /* If the number converted back into a string is not identical
2639 * then it's not possible to encode the string as integer */
2640 if (sdslen(s
) != (unsigned)slen
|| memcmp(buf
,s
,slen
)) return REDIS_ERR
;
2641 if (longval
) *longval
= value
;
2645 /* Try to encode a string object in order to save space */
2646 static int tryObjectEncoding(robj
*o
) {
2650 if (o
->encoding
!= REDIS_ENCODING_RAW
)
2651 return REDIS_ERR
; /* Already encoded */
2653 /* It's not save to encode shared objects: shared objects can be shared
2654 * everywhere in the "object space" of Redis. Encoded objects can only
2655 * appear as "values" (and not, for instance, as keys) */
2656 if (o
->refcount
> 1) return REDIS_ERR
;
2658 /* Currently we try to encode only strings */
2659 redisAssert(o
->type
== REDIS_STRING
);
2661 /* Check if we can represent this string as a long integer */
2662 if (isStringRepresentableAsLong(s
,&value
) == REDIS_ERR
) return REDIS_ERR
;
2664 /* Ok, this object can be encoded */
2665 o
->encoding
= REDIS_ENCODING_INT
;
2667 o
->ptr
= (void*) value
;
2671 /* Get a decoded version of an encoded object (returned as a new object).
2672 * If the object is already raw-encoded just increment the ref count. */
2673 static robj
*getDecodedObject(robj
*o
) {
2676 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2680 if (o
->type
== REDIS_STRING
&& o
->encoding
== REDIS_ENCODING_INT
) {
2683 snprintf(buf
,32,"%ld",(long)o
->ptr
);
2684 dec
= createStringObject(buf
,strlen(buf
));
2687 redisAssert(1 != 1);
2691 /* Compare two string objects via strcmp() or alike.
2692 * Note that the objects may be integer-encoded. In such a case we
2693 * use snprintf() to get a string representation of the numbers on the stack
2694 * and compare the strings, it's much faster than calling getDecodedObject().
2696 * Important note: if objects are not integer encoded, but binary-safe strings,
2697 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
2699 static int compareStringObjects(robj
*a
, robj
*b
) {
2700 redisAssert(a
->type
== REDIS_STRING
&& b
->type
== REDIS_STRING
);
2701 char bufa
[128], bufb
[128], *astr
, *bstr
;
2704 if (a
== b
) return 0;
2705 if (a
->encoding
!= REDIS_ENCODING_RAW
) {
2706 snprintf(bufa
,sizeof(bufa
),"%ld",(long) a
->ptr
);
2712 if (b
->encoding
!= REDIS_ENCODING_RAW
) {
2713 snprintf(bufb
,sizeof(bufb
),"%ld",(long) b
->ptr
);
2719 return bothsds
? sdscmp(astr
,bstr
) : strcmp(astr
,bstr
);
2722 static size_t stringObjectLen(robj
*o
) {
2723 redisAssert(o
->type
== REDIS_STRING
);
2724 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2725 return sdslen(o
->ptr
);
2729 return snprintf(buf
,32,"%ld",(long)o
->ptr
);
2733 /*============================ RDB saving/loading =========================== */
2735 static int rdbSaveType(FILE *fp
, unsigned char type
) {
2736 if (fwrite(&type
,1,1,fp
) == 0) return -1;
2740 static int rdbSaveTime(FILE *fp
, time_t t
) {
2741 int32_t t32
= (int32_t) t
;
2742 if (fwrite(&t32
,4,1,fp
) == 0) return -1;
2746 /* check rdbLoadLen() comments for more info */
2747 static int rdbSaveLen(FILE *fp
, uint32_t len
) {
2748 unsigned char buf
[2];
2751 /* Save a 6 bit len */
2752 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
2753 if (fwrite(buf
,1,1,fp
) == 0) return -1;
2754 } else if (len
< (1<<14)) {
2755 /* Save a 14 bit len */
2756 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
2758 if (fwrite(buf
,2,1,fp
) == 0) return -1;
2760 /* Save a 32 bit len */
2761 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
2762 if (fwrite(buf
,1,1,fp
) == 0) return -1;
2764 if (fwrite(&len
,4,1,fp
) == 0) return -1;
2769 /* String objects in the form "2391" "-100" without any space and with a
2770 * range of values that can fit in an 8, 16 or 32 bit signed value can be
2771 * encoded as integers to save space */
2772 static int rdbTryIntegerEncoding(sds s
, unsigned char *enc
) {
2774 char *endptr
, buf
[32];
2776 /* Check if it's possible to encode this value as a number */
2777 value
= strtoll(s
, &endptr
, 10);
2778 if (endptr
[0] != '\0') return 0;
2779 snprintf(buf
,32,"%lld",value
);
2781 /* If the number converted back into a string is not identical
2782 * then it's not possible to encode the string as integer */
2783 if (strlen(buf
) != sdslen(s
) || memcmp(buf
,s
,sdslen(s
))) return 0;
2785 /* Finally check if it fits in our ranges */
2786 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
2787 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
2788 enc
[1] = value
&0xFF;
2790 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
2791 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
2792 enc
[1] = value
&0xFF;
2793 enc
[2] = (value
>>8)&0xFF;
2795 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
2796 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
2797 enc
[1] = value
&0xFF;
2798 enc
[2] = (value
>>8)&0xFF;
2799 enc
[3] = (value
>>16)&0xFF;
2800 enc
[4] = (value
>>24)&0xFF;
2807 static int rdbSaveLzfStringObject(FILE *fp
, robj
*obj
) {
2808 unsigned int comprlen
, outlen
;
2812 /* We require at least four bytes compression for this to be worth it */
2813 outlen
= sdslen(obj
->ptr
)-4;
2814 if (outlen
<= 0) return 0;
2815 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
2816 printf("Calling LZF with ptr: %p\n", (void*)obj
->ptr
);
2818 comprlen
= lzf_compress(obj
->ptr
, sdslen(obj
->ptr
), out
, outlen
);
2819 if (comprlen
== 0) {
2823 /* Data compressed! Let's save it on disk */
2824 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
2825 if (fwrite(&byte
,1,1,fp
) == 0) goto writeerr
;
2826 if (rdbSaveLen(fp
,comprlen
) == -1) goto writeerr
;
2827 if (rdbSaveLen(fp
,sdslen(obj
->ptr
)) == -1) goto writeerr
;
2828 if (fwrite(out
,comprlen
,1,fp
) == 0) goto writeerr
;
2837 /* Save a string objet as [len][data] on disk. If the object is a string
2838 * representation of an integer value we try to safe it in a special form */
2839 static int rdbSaveStringObjectRaw(FILE *fp
, robj
*obj
) {
2843 len
= sdslen(obj
->ptr
);
2845 /* Try integer encoding */
2847 unsigned char buf
[5];
2848 if ((enclen
= rdbTryIntegerEncoding(obj
->ptr
,buf
)) > 0) {
2849 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
2854 /* Try LZF compression - under 20 bytes it's unable to compress even
2855 * aaaaaaaaaaaaaaaaaa so skip it */
2856 if (server
.rdbcompression
&& len
> 20) {
2859 retval
= rdbSaveLzfStringObject(fp
,obj
);
2860 if (retval
== -1) return -1;
2861 if (retval
> 0) return 0;
2862 /* retval == 0 means data can't be compressed, save the old way */
2865 /* Store verbatim */
2866 if (rdbSaveLen(fp
,len
) == -1) return -1;
2867 if (len
&& fwrite(obj
->ptr
,len
,1,fp
) == 0) return -1;
2871 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
2872 static int rdbSaveStringObject(FILE *fp
, robj
*obj
) {
2875 /* Avoid incr/decr ref count business when possible.
2876 * This plays well with copy-on-write given that we are probably
2877 * in a child process (BGSAVE). Also this makes sure key objects
2878 * of swapped objects are not incRefCount-ed (an assert does not allow
2879 * this in order to avoid bugs) */
2880 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
2881 obj
= getDecodedObject(obj
);
2882 retval
= rdbSaveStringObjectRaw(fp
,obj
);
2885 retval
= rdbSaveStringObjectRaw(fp
,obj
);
2890 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
2891 * 8 bit integer specifing the length of the representation.
2892 * This 8 bit integer has special values in order to specify the following
2898 static int rdbSaveDoubleValue(FILE *fp
, double val
) {
2899 unsigned char buf
[128];
2905 } else if (!isfinite(val
)) {
2907 buf
[0] = (val
< 0) ? 255 : 254;
2909 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
2910 buf
[0] = strlen((char*)buf
+1);
2913 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
2917 /* Save a Redis object. */
2918 static int rdbSaveObject(FILE *fp
, robj
*o
) {
2919 if (o
->type
== REDIS_STRING
) {
2920 /* Save a string value */
2921 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
2922 } else if (o
->type
== REDIS_LIST
) {
2923 /* Save a list value */
2924 list
*list
= o
->ptr
;
2928 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
2929 while((ln
= listYield(list
))) {
2930 robj
*eleobj
= listNodeValue(ln
);
2932 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
2934 } else if (o
->type
== REDIS_SET
) {
2935 /* Save a set value */
2937 dictIterator
*di
= dictGetIterator(set
);
2940 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
2941 while((de
= dictNext(di
)) != NULL
) {
2942 robj
*eleobj
= dictGetEntryKey(de
);
2944 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
2946 dictReleaseIterator(di
);
2947 } else if (o
->type
== REDIS_ZSET
) {
2948 /* Save a set value */
2950 dictIterator
*di
= dictGetIterator(zs
->dict
);
2953 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
2954 while((de
= dictNext(di
)) != NULL
) {
2955 robj
*eleobj
= dictGetEntryKey(de
);
2956 double *score
= dictGetEntryVal(de
);
2958 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
2959 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
2961 dictReleaseIterator(di
);
2963 redisAssert(0 != 0);
2968 /* Return the length the object will have on disk if saved with
2969 * the rdbSaveObject() function. Currently we use a trick to get
2970 * this length with very little changes to the code. In the future
2971 * we could switch to a faster solution. */
2972 static off_t
rdbSavedObjectLen(robj
*o
, FILE *fp
) {
2973 if (fp
== NULL
) fp
= server
.devnull
;
2975 assert(rdbSaveObject(fp
,o
) != 1);
2979 /* Return the number of pages required to save this object in the swap file */
2980 static off_t
rdbSavedObjectPages(robj
*o
, FILE *fp
) {
2981 off_t bytes
= rdbSavedObjectLen(o
,fp
);
2983 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
2986 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
2987 static int rdbSave(char *filename
) {
2988 dictIterator
*di
= NULL
;
2993 time_t now
= time(NULL
);
2995 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
2996 fp
= fopen(tmpfile
,"w");
2998 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
3001 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
3002 for (j
= 0; j
< server
.dbnum
; j
++) {
3003 redisDb
*db
= server
.db
+j
;
3005 if (dictSize(d
) == 0) continue;
3006 di
= dictGetIterator(d
);
3012 /* Write the SELECT DB opcode */
3013 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
3014 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
3016 /* Iterate this DB writing every entry */
3017 while((de
= dictNext(di
)) != NULL
) {
3018 robj
*key
= dictGetEntryKey(de
);
3019 robj
*o
= dictGetEntryVal(de
);
3020 time_t expiretime
= getExpire(db
,key
);
3022 /* Save the expire time */
3023 if (expiretime
!= -1) {
3024 /* If this key is already expired skip it */
3025 if (expiretime
< now
) continue;
3026 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
3027 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
3029 /* Save the key and associated value. This requires special
3030 * handling if the value is swapped out. */
3031 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
3032 key
->storage
== REDIS_VM_SWAPPING
) {
3033 /* Save type, key, value */
3034 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
3035 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3036 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
3038 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3040 /* Get a preview of the object in memory */
3041 po
= vmPreviewObject(key
);
3042 /* Save type, key, value */
3043 if (rdbSaveType(fp
,key
->vtype
) == -1) goto werr
;
3044 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3045 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
3046 /* Remove the loaded object from memory */
3050 dictReleaseIterator(di
);
3053 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
3055 /* Make sure data will not remain on the OS's output buffers */
3060 /* Use RENAME to make sure the DB file is changed atomically only
3061 * if the generate DB file is ok. */
3062 if (rename(tmpfile
,filename
) == -1) {
3063 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
3067 redisLog(REDIS_NOTICE
,"DB saved on disk");
3069 server
.lastsave
= time(NULL
);
3075 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
3076 if (di
) dictReleaseIterator(di
);
3080 static int rdbSaveBackground(char *filename
) {
3083 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
3084 if ((childpid
= fork()) == 0) {
3087 if (rdbSave(filename
) == REDIS_OK
) {
3094 if (childpid
== -1) {
3095 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
3099 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
3100 server
.bgsavechildpid
= childpid
;
3103 return REDIS_OK
; /* unreached */
3106 static void rdbRemoveTempFile(pid_t childpid
) {
3109 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
3113 static int rdbLoadType(FILE *fp
) {
3115 if (fread(&type
,1,1,fp
) == 0) return -1;
3119 static time_t rdbLoadTime(FILE *fp
) {
3121 if (fread(&t32
,4,1,fp
) == 0) return -1;
3122 return (time_t) t32
;
3125 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3126 * of this file for a description of how this are stored on disk.
3128 * isencoded is set to 1 if the readed length is not actually a length but
3129 * an "encoding type", check the above comments for more info */
3130 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
3131 unsigned char buf
[2];
3135 if (isencoded
) *isencoded
= 0;
3136 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3137 type
= (buf
[0]&0xC0)>>6;
3138 if (type
== REDIS_RDB_6BITLEN
) {
3139 /* Read a 6 bit len */
3141 } else if (type
== REDIS_RDB_ENCVAL
) {
3142 /* Read a 6 bit len encoding type */
3143 if (isencoded
) *isencoded
= 1;
3145 } else if (type
== REDIS_RDB_14BITLEN
) {
3146 /* Read a 14 bit len */
3147 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3148 return ((buf
[0]&0x3F)<<8)|buf
[1];
3150 /* Read a 32 bit len */
3151 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
3156 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
) {
3157 unsigned char enc
[4];
3160 if (enctype
== REDIS_RDB_ENC_INT8
) {
3161 if (fread(enc
,1,1,fp
) == 0) return NULL
;
3162 val
= (signed char)enc
[0];
3163 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
3165 if (fread(enc
,2,1,fp
) == 0) return NULL
;
3166 v
= enc
[0]|(enc
[1]<<8);
3168 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
3170 if (fread(enc
,4,1,fp
) == 0) return NULL
;
3171 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
3174 val
= 0; /* anti-warning */
3177 return createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",val
));
3180 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
3181 unsigned int len
, clen
;
3182 unsigned char *c
= NULL
;
3185 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3186 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3187 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
3188 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
3189 if (fread(c
,clen
,1,fp
) == 0) goto err
;
3190 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
3192 return createObject(REDIS_STRING
,val
);
3199 static robj
*rdbLoadStringObject(FILE*fp
) {
3204 len
= rdbLoadLen(fp
,&isencoded
);
3207 case REDIS_RDB_ENC_INT8
:
3208 case REDIS_RDB_ENC_INT16
:
3209 case REDIS_RDB_ENC_INT32
:
3210 return tryObjectSharing(rdbLoadIntegerObject(fp
,len
));
3211 case REDIS_RDB_ENC_LZF
:
3212 return tryObjectSharing(rdbLoadLzfStringObject(fp
));
3218 if (len
== REDIS_RDB_LENERR
) return NULL
;
3219 val
= sdsnewlen(NULL
,len
);
3220 if (len
&& fread(val
,len
,1,fp
) == 0) {
3224 return tryObjectSharing(createObject(REDIS_STRING
,val
));
3227 /* For information about double serialization check rdbSaveDoubleValue() */
3228 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
3232 if (fread(&len
,1,1,fp
) == 0) return -1;
3234 case 255: *val
= R_NegInf
; return 0;
3235 case 254: *val
= R_PosInf
; return 0;
3236 case 253: *val
= R_Nan
; return 0;
3238 if (fread(buf
,len
,1,fp
) == 0) return -1;
3240 sscanf(buf
, "%lg", val
);
3245 /* Load a Redis object of the specified type from the specified file.
3246 * On success a newly allocated object is returned, otherwise NULL. */
3247 static robj
*rdbLoadObject(int type
, FILE *fp
) {
3250 if (type
== REDIS_STRING
) {
3251 /* Read string value */
3252 if ((o
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3253 tryObjectEncoding(o
);
3254 } else if (type
== REDIS_LIST
|| type
== REDIS_SET
) {
3255 /* Read list/set value */
3258 if ((listlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3259 o
= (type
== REDIS_LIST
) ? createListObject() : createSetObject();
3260 /* Load every single element of the list/set */
3264 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3265 tryObjectEncoding(ele
);
3266 if (type
== REDIS_LIST
) {
3267 listAddNodeTail((list
*)o
->ptr
,ele
);
3269 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
3272 } else if (type
== REDIS_ZSET
) {
3273 /* Read list/set value */
3277 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3278 o
= createZsetObject();
3280 /* Load every single element of the list/set */
3283 double *score
= zmalloc(sizeof(double));
3285 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3286 tryObjectEncoding(ele
);
3287 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
3288 dictAdd(zs
->dict
,ele
,score
);
3289 zslInsert(zs
->zsl
,*score
,ele
);
3290 incrRefCount(ele
); /* added to skiplist */
3293 redisAssert(0 != 0);
3298 static int rdbLoad(char *filename
) {
3300 robj
*keyobj
= NULL
;
3302 int type
, retval
, rdbver
;
3303 dict
*d
= server
.db
[0].dict
;
3304 redisDb
*db
= server
.db
+0;
3306 time_t expiretime
= -1, now
= time(NULL
);
3307 long long loadedkeys
= 0;
3309 fp
= fopen(filename
,"r");
3310 if (!fp
) return REDIS_ERR
;
3311 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
3313 if (memcmp(buf
,"REDIS",5) != 0) {
3315 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
3318 rdbver
= atoi(buf
+5);
3321 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
3328 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3329 if (type
== REDIS_EXPIRETIME
) {
3330 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
3331 /* We read the time so we need to read the object type again */
3332 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3334 if (type
== REDIS_EOF
) break;
3335 /* Handle SELECT DB opcode as a special case */
3336 if (type
== REDIS_SELECTDB
) {
3337 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
3339 if (dbid
>= (unsigned)server
.dbnum
) {
3340 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
3343 db
= server
.db
+dbid
;
3348 if ((keyobj
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
3350 if ((o
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
3351 /* Add the new object in the hash table */
3352 retval
= dictAdd(d
,keyobj
,o
);
3353 if (retval
== DICT_ERR
) {
3354 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", keyobj
->ptr
);
3357 /* Set the expire time if needed */
3358 if (expiretime
!= -1) {
3359 setExpire(db
,keyobj
,expiretime
);
3360 /* Delete this key if already expired */
3361 if (expiretime
< now
) deleteKey(db
,keyobj
);
3365 /* Handle swapping while loading big datasets when VM is on */
3367 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
3368 while (zmalloc_used_memory() > server
.vm_max_memory
) {
3369 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
3376 eoferr
: /* unexpected end of file is handled here with a fatal exit */
3377 if (keyobj
) decrRefCount(keyobj
);
3378 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
3380 return REDIS_ERR
; /* Just to avoid warning */
3383 /*================================== Commands =============================== */
3385 static void authCommand(redisClient
*c
) {
3386 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
3387 c
->authenticated
= 1;
3388 addReply(c
,shared
.ok
);
3390 c
->authenticated
= 0;
3391 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
3395 static void pingCommand(redisClient
*c
) {
3396 addReply(c
,shared
.pong
);
3399 static void echoCommand(redisClient
*c
) {
3400 addReplyBulkLen(c
,c
->argv
[1]);
3401 addReply(c
,c
->argv
[1]);
3402 addReply(c
,shared
.crlf
);
3405 /*=================================== Strings =============================== */
3407 static void setGenericCommand(redisClient
*c
, int nx
) {
3410 if (nx
) deleteIfVolatile(c
->db
,c
->argv
[1]);
3411 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3412 if (retval
== DICT_ERR
) {
3414 /* If the key is about a swapped value, we want a new key object
3415 * to overwrite the old. So we delete the old key in the database.
3416 * This will also make sure that swap pages about the old object
3417 * will be marked as free. */
3418 if (deleteIfSwapped(c
->db
,c
->argv
[1]))
3419 incrRefCount(c
->argv
[1]);
3420 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3421 incrRefCount(c
->argv
[2]);
3423 addReply(c
,shared
.czero
);
3427 incrRefCount(c
->argv
[1]);
3428 incrRefCount(c
->argv
[2]);
3431 removeExpire(c
->db
,c
->argv
[1]);
3432 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3435 static void setCommand(redisClient
*c
) {
3436 setGenericCommand(c
,0);
3439 static void setnxCommand(redisClient
*c
) {
3440 setGenericCommand(c
,1);
3443 static int getGenericCommand(redisClient
*c
) {
3444 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[1]);
3447 addReply(c
,shared
.nullbulk
);
3450 if (o
->type
!= REDIS_STRING
) {
3451 addReply(c
,shared
.wrongtypeerr
);
3454 addReplyBulkLen(c
,o
);
3456 addReply(c
,shared
.crlf
);
3462 static void getCommand(redisClient
*c
) {
3463 getGenericCommand(c
);
3466 static void getsetCommand(redisClient
*c
) {
3467 if (getGenericCommand(c
) == REDIS_ERR
) return;
3468 if (dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]) == DICT_ERR
) {
3469 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3471 incrRefCount(c
->argv
[1]);
3473 incrRefCount(c
->argv
[2]);
3475 removeExpire(c
->db
,c
->argv
[1]);
3478 static void mgetCommand(redisClient
*c
) {
3481 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
3482 for (j
= 1; j
< c
->argc
; j
++) {
3483 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
3485 addReply(c
,shared
.nullbulk
);
3487 if (o
->type
!= REDIS_STRING
) {
3488 addReply(c
,shared
.nullbulk
);
3490 addReplyBulkLen(c
,o
);
3492 addReply(c
,shared
.crlf
);
3498 static void msetGenericCommand(redisClient
*c
, int nx
) {
3499 int j
, busykeys
= 0;
3501 if ((c
->argc
% 2) == 0) {
3502 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
3505 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
3506 * set nothing at all if at least one already key exists. */
3508 for (j
= 1; j
< c
->argc
; j
+= 2) {
3509 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
3515 addReply(c
, shared
.czero
);
3519 for (j
= 1; j
< c
->argc
; j
+= 2) {
3522 tryObjectEncoding(c
->argv
[j
+1]);
3523 retval
= dictAdd(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
3524 if (retval
== DICT_ERR
) {
3525 dictReplace(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
3526 incrRefCount(c
->argv
[j
+1]);
3528 incrRefCount(c
->argv
[j
]);
3529 incrRefCount(c
->argv
[j
+1]);
3531 removeExpire(c
->db
,c
->argv
[j
]);
3533 server
.dirty
+= (c
->argc
-1)/2;
3534 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3537 static void msetCommand(redisClient
*c
) {
3538 msetGenericCommand(c
,0);
3541 static void msetnxCommand(redisClient
*c
) {
3542 msetGenericCommand(c
,1);
3545 static void incrDecrCommand(redisClient
*c
, long long incr
) {
3550 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3554 if (o
->type
!= REDIS_STRING
) {
3559 if (o
->encoding
== REDIS_ENCODING_RAW
)
3560 value
= strtoll(o
->ptr
, &eptr
, 10);
3561 else if (o
->encoding
== REDIS_ENCODING_INT
)
3562 value
= (long)o
->ptr
;
3564 redisAssert(1 != 1);
3569 o
= createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
3570 tryObjectEncoding(o
);
3571 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],o
);
3572 if (retval
== DICT_ERR
) {
3573 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
3574 removeExpire(c
->db
,c
->argv
[1]);
3576 incrRefCount(c
->argv
[1]);
3579 addReply(c
,shared
.colon
);
3581 addReply(c
,shared
.crlf
);
3584 static void incrCommand(redisClient
*c
) {
3585 incrDecrCommand(c
,1);
3588 static void decrCommand(redisClient
*c
) {
3589 incrDecrCommand(c
,-1);
3592 static void incrbyCommand(redisClient
*c
) {
3593 long long incr
= strtoll(c
->argv
[2]->ptr
, NULL
, 10);
3594 incrDecrCommand(c
,incr
);
3597 static void decrbyCommand(redisClient
*c
) {
3598 long long incr
= strtoll(c
->argv
[2]->ptr
, NULL
, 10);
3599 incrDecrCommand(c
,-incr
);
3602 /* ========================= Type agnostic commands ========================= */
3604 static void delCommand(redisClient
*c
) {
3607 for (j
= 1; j
< c
->argc
; j
++) {
3608 if (deleteKey(c
->db
,c
->argv
[j
])) {
3615 addReply(c
,shared
.czero
);
3618 addReply(c
,shared
.cone
);
3621 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",deleted
));
3626 static void existsCommand(redisClient
*c
) {
3627 addReply(c
,lookupKeyRead(c
->db
,c
->argv
[1]) ? shared
.cone
: shared
.czero
);
3630 static void selectCommand(redisClient
*c
) {
3631 int id
= atoi(c
->argv
[1]->ptr
);
3633 if (selectDb(c
,id
) == REDIS_ERR
) {
3634 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
3636 addReply(c
,shared
.ok
);
3640 static void randomkeyCommand(redisClient
*c
) {
3644 de
= dictGetRandomKey(c
->db
->dict
);
3645 if (!de
|| expireIfNeeded(c
->db
,dictGetEntryKey(de
)) == 0) break;
3648 addReply(c
,shared
.plus
);
3649 addReply(c
,shared
.crlf
);
3651 addReply(c
,shared
.plus
);
3652 addReply(c
,dictGetEntryKey(de
));
3653 addReply(c
,shared
.crlf
);
3657 static void keysCommand(redisClient
*c
) {
3660 sds pattern
= c
->argv
[1]->ptr
;
3661 int plen
= sdslen(pattern
);
3662 unsigned long numkeys
= 0, keyslen
= 0;
3663 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
3665 di
= dictGetIterator(c
->db
->dict
);
3667 decrRefCount(lenobj
);
3668 while((de
= dictNext(di
)) != NULL
) {
3669 robj
*keyobj
= dictGetEntryKey(de
);
3671 sds key
= keyobj
->ptr
;
3672 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
3673 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
3674 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
3676 addReply(c
,shared
.space
);
3679 keyslen
+= sdslen(key
);
3683 dictReleaseIterator(di
);
3684 lenobj
->ptr
= sdscatprintf(sdsempty(),"$%lu\r\n",keyslen
+(numkeys
? (numkeys
-1) : 0));
3685 addReply(c
,shared
.crlf
);
3688 static void dbsizeCommand(redisClient
*c
) {
3690 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
3693 static void lastsaveCommand(redisClient
*c
) {
3695 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
3698 static void typeCommand(redisClient
*c
) {
3702 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
3707 case REDIS_STRING
: type
= "+string"; break;
3708 case REDIS_LIST
: type
= "+list"; break;
3709 case REDIS_SET
: type
= "+set"; break;
3710 case REDIS_ZSET
: type
= "+zset"; break;
3711 default: type
= "unknown"; break;
3714 addReplySds(c
,sdsnew(type
));
3715 addReply(c
,shared
.crlf
);
3718 static void saveCommand(redisClient
*c
) {
3719 if (server
.bgsavechildpid
!= -1) {
3720 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
3723 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
3724 addReply(c
,shared
.ok
);
3726 addReply(c
,shared
.err
);
3730 static void bgsaveCommand(redisClient
*c
) {
3731 if (server
.bgsavechildpid
!= -1) {
3732 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
3735 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
3736 char *status
= "+Background saving started\r\n";
3737 addReplySds(c
,sdsnew(status
));
3739 addReply(c
,shared
.err
);
3743 static void shutdownCommand(redisClient
*c
) {
3744 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
3745 /* Kill the saving child if there is a background saving in progress.
3746 We want to avoid race conditions, for instance our saving child may
3747 overwrite the synchronous saving did by SHUTDOWN. */
3748 if (server
.bgsavechildpid
!= -1) {
3749 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
3750 kill(server
.bgsavechildpid
,SIGKILL
);
3751 rdbRemoveTempFile(server
.bgsavechildpid
);
3753 if (server
.appendonly
) {
3754 /* Append only file: fsync() the AOF and exit */
3755 fsync(server
.appendfd
);
3758 /* Snapshotting. Perform a SYNC SAVE and exit */
3759 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
3760 if (server
.daemonize
)
3761 unlink(server
.pidfile
);
3762 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
3763 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
3766 /* Ooops.. error saving! The best we can do is to continue operating.
3767 * Note that if there was a background saving process, in the next
3768 * cron() Redis will be notified that the background saving aborted,
3769 * handling special stuff like slaves pending for synchronization... */
3770 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
3771 addReplySds(c
,sdsnew("-ERR can't quit, problems saving the DB\r\n"));
3776 static void renameGenericCommand(redisClient
*c
, int nx
) {
3779 /* To use the same key as src and dst is probably an error */
3780 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
3781 addReply(c
,shared
.sameobjecterr
);
3785 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3787 addReply(c
,shared
.nokeyerr
);
3791 deleteIfVolatile(c
->db
,c
->argv
[2]);
3792 if (dictAdd(c
->db
->dict
,c
->argv
[2],o
) == DICT_ERR
) {
3795 addReply(c
,shared
.czero
);
3798 dictReplace(c
->db
->dict
,c
->argv
[2],o
);
3800 incrRefCount(c
->argv
[2]);
3802 deleteKey(c
->db
,c
->argv
[1]);
3804 addReply(c
,nx
? shared
.cone
: shared
.ok
);
3807 static void renameCommand(redisClient
*c
) {
3808 renameGenericCommand(c
,0);
3811 static void renamenxCommand(redisClient
*c
) {
3812 renameGenericCommand(c
,1);
3815 static void moveCommand(redisClient
*c
) {
3820 /* Obtain source and target DB pointers */
3823 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
3824 addReply(c
,shared
.outofrangeerr
);
3828 selectDb(c
,srcid
); /* Back to the source DB */
3830 /* If the user is moving using as target the same
3831 * DB as the source DB it is probably an error. */
3833 addReply(c
,shared
.sameobjecterr
);
3837 /* Check if the element exists and get a reference */
3838 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3840 addReply(c
,shared
.czero
);
3844 /* Try to add the element to the target DB */
3845 deleteIfVolatile(dst
,c
->argv
[1]);
3846 if (dictAdd(dst
->dict
,c
->argv
[1],o
) == DICT_ERR
) {
3847 addReply(c
,shared
.czero
);
3850 incrRefCount(c
->argv
[1]);
3853 /* OK! key moved, free the entry in the source DB */
3854 deleteKey(src
,c
->argv
[1]);
3856 addReply(c
,shared
.cone
);
3859 /* =================================== Lists ================================ */
3860 static void pushGenericCommand(redisClient
*c
, int where
) {
3864 lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3866 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
3867 addReply(c
,shared
.ok
);
3870 lobj
= createListObject();
3872 if (where
== REDIS_HEAD
) {
3873 listAddNodeHead(list
,c
->argv
[2]);
3875 listAddNodeTail(list
,c
->argv
[2]);
3877 dictAdd(c
->db
->dict
,c
->argv
[1],lobj
);
3878 incrRefCount(c
->argv
[1]);
3879 incrRefCount(c
->argv
[2]);
3881 if (lobj
->type
!= REDIS_LIST
) {
3882 addReply(c
,shared
.wrongtypeerr
);
3885 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
3886 addReply(c
,shared
.ok
);
3890 if (where
== REDIS_HEAD
) {
3891 listAddNodeHead(list
,c
->argv
[2]);
3893 listAddNodeTail(list
,c
->argv
[2]);
3895 incrRefCount(c
->argv
[2]);
3898 addReply(c
,shared
.ok
);
3901 static void lpushCommand(redisClient
*c
) {
3902 pushGenericCommand(c
,REDIS_HEAD
);
3905 static void rpushCommand(redisClient
*c
) {
3906 pushGenericCommand(c
,REDIS_TAIL
);
3909 static void llenCommand(redisClient
*c
) {
3913 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
3915 addReply(c
,shared
.czero
);
3918 if (o
->type
!= REDIS_LIST
) {
3919 addReply(c
,shared
.wrongtypeerr
);
3922 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",listLength(l
)));
3927 static void lindexCommand(redisClient
*c
) {
3929 int index
= atoi(c
->argv
[2]->ptr
);
3931 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
3933 addReply(c
,shared
.nullbulk
);
3935 if (o
->type
!= REDIS_LIST
) {
3936 addReply(c
,shared
.wrongtypeerr
);
3938 list
*list
= o
->ptr
;
3941 ln
= listIndex(list
, index
);
3943 addReply(c
,shared
.nullbulk
);
3945 robj
*ele
= listNodeValue(ln
);
3946 addReplyBulkLen(c
,ele
);
3948 addReply(c
,shared
.crlf
);
3954 static void lsetCommand(redisClient
*c
) {
3956 int index
= atoi(c
->argv
[2]->ptr
);
3958 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3960 addReply(c
,shared
.nokeyerr
);
3962 if (o
->type
!= REDIS_LIST
) {
3963 addReply(c
,shared
.wrongtypeerr
);
3965 list
*list
= o
->ptr
;
3968 ln
= listIndex(list
, index
);
3970 addReply(c
,shared
.outofrangeerr
);
3972 robj
*ele
= listNodeValue(ln
);
3975 listNodeValue(ln
) = c
->argv
[3];
3976 incrRefCount(c
->argv
[3]);
3977 addReply(c
,shared
.ok
);
3984 static void popGenericCommand(redisClient
*c
, int where
) {
3987 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3989 addReply(c
,shared
.nullbulk
);
3991 if (o
->type
!= REDIS_LIST
) {
3992 addReply(c
,shared
.wrongtypeerr
);
3994 list
*list
= o
->ptr
;
3997 if (where
== REDIS_HEAD
)
3998 ln
= listFirst(list
);
4000 ln
= listLast(list
);
4003 addReply(c
,shared
.nullbulk
);
4005 robj
*ele
= listNodeValue(ln
);
4006 addReplyBulkLen(c
,ele
);
4008 addReply(c
,shared
.crlf
);
4009 listDelNode(list
,ln
);
4016 static void lpopCommand(redisClient
*c
) {
4017 popGenericCommand(c
,REDIS_HEAD
);
4020 static void rpopCommand(redisClient
*c
) {
4021 popGenericCommand(c
,REDIS_TAIL
);
4024 static void lrangeCommand(redisClient
*c
) {
4026 int start
= atoi(c
->argv
[2]->ptr
);
4027 int end
= atoi(c
->argv
[3]->ptr
);
4029 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4031 addReply(c
,shared
.nullmultibulk
);
4033 if (o
->type
!= REDIS_LIST
) {
4034 addReply(c
,shared
.wrongtypeerr
);
4036 list
*list
= o
->ptr
;
4038 int llen
= listLength(list
);
4042 /* convert negative indexes */
4043 if (start
< 0) start
= llen
+start
;
4044 if (end
< 0) end
= llen
+end
;
4045 if (start
< 0) start
= 0;
4046 if (end
< 0) end
= 0;
4048 /* indexes sanity checks */
4049 if (start
> end
|| start
>= llen
) {
4050 /* Out of range start or start > end result in empty list */
4051 addReply(c
,shared
.emptymultibulk
);
4054 if (end
>= llen
) end
= llen
-1;
4055 rangelen
= (end
-start
)+1;
4057 /* Return the result in form of a multi-bulk reply */
4058 ln
= listIndex(list
, start
);
4059 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
4060 for (j
= 0; j
< rangelen
; j
++) {
4061 ele
= listNodeValue(ln
);
4062 addReplyBulkLen(c
,ele
);
4064 addReply(c
,shared
.crlf
);
4071 static void ltrimCommand(redisClient
*c
) {
4073 int start
= atoi(c
->argv
[2]->ptr
);
4074 int end
= atoi(c
->argv
[3]->ptr
);
4076 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4078 addReply(c
,shared
.ok
);
4080 if (o
->type
!= REDIS_LIST
) {
4081 addReply(c
,shared
.wrongtypeerr
);
4083 list
*list
= o
->ptr
;
4085 int llen
= listLength(list
);
4086 int j
, ltrim
, rtrim
;
4088 /* convert negative indexes */
4089 if (start
< 0) start
= llen
+start
;
4090 if (end
< 0) end
= llen
+end
;
4091 if (start
< 0) start
= 0;
4092 if (end
< 0) end
= 0;
4094 /* indexes sanity checks */
4095 if (start
> end
|| start
>= llen
) {
4096 /* Out of range start or start > end result in empty list */
4100 if (end
>= llen
) end
= llen
-1;
4105 /* Remove list elements to perform the trim */
4106 for (j
= 0; j
< ltrim
; j
++) {
4107 ln
= listFirst(list
);
4108 listDelNode(list
,ln
);
4110 for (j
= 0; j
< rtrim
; j
++) {
4111 ln
= listLast(list
);
4112 listDelNode(list
,ln
);
4115 addReply(c
,shared
.ok
);
4120 static void lremCommand(redisClient
*c
) {
4123 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4125 addReply(c
,shared
.czero
);
4127 if (o
->type
!= REDIS_LIST
) {
4128 addReply(c
,shared
.wrongtypeerr
);
4130 list
*list
= o
->ptr
;
4131 listNode
*ln
, *next
;
4132 int toremove
= atoi(c
->argv
[2]->ptr
);
4137 toremove
= -toremove
;
4140 ln
= fromtail
? list
->tail
: list
->head
;
4142 robj
*ele
= listNodeValue(ln
);
4144 next
= fromtail
? ln
->prev
: ln
->next
;
4145 if (compareStringObjects(ele
,c
->argv
[3]) == 0) {
4146 listDelNode(list
,ln
);
4149 if (toremove
&& removed
== toremove
) break;
4153 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
4158 /* This is the semantic of this command:
4159 * RPOPLPUSH srclist dstlist:
4160 * IF LLEN(srclist) > 0
4161 * element = RPOP srclist
4162 * LPUSH dstlist element
4169 * The idea is to be able to get an element from a list in a reliable way
4170 * since the element is not just returned but pushed against another list
4171 * as well. This command was originally proposed by Ezra Zygmuntowicz.
4173 static void rpoplpushcommand(redisClient
*c
) {
4176 sobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4178 addReply(c
,shared
.nullbulk
);
4180 if (sobj
->type
!= REDIS_LIST
) {
4181 addReply(c
,shared
.wrongtypeerr
);
4183 list
*srclist
= sobj
->ptr
;
4184 listNode
*ln
= listLast(srclist
);
4187 addReply(c
,shared
.nullbulk
);
4189 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4190 robj
*ele
= listNodeValue(ln
);
4193 if (dobj
&& dobj
->type
!= REDIS_LIST
) {
4194 addReply(c
,shared
.wrongtypeerr
);
4198 /* Add the element to the target list (unless it's directly
4199 * passed to some BLPOP-ing client */
4200 if (!handleClientsWaitingListPush(c
,c
->argv
[2],ele
)) {
4202 /* Create the list if the key does not exist */
4203 dobj
= createListObject();
4204 dictAdd(c
->db
->dict
,c
->argv
[2],dobj
);
4205 incrRefCount(c
->argv
[2]);
4207 dstlist
= dobj
->ptr
;
4208 listAddNodeHead(dstlist
,ele
);
4212 /* Send the element to the client as reply as well */
4213 addReplyBulkLen(c
,ele
);
4215 addReply(c
,shared
.crlf
);
4217 /* Finally remove the element from the source list */
4218 listDelNode(srclist
,ln
);
4226 /* ==================================== Sets ================================ */
4228 static void saddCommand(redisClient
*c
) {
4231 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4233 set
= createSetObject();
4234 dictAdd(c
->db
->dict
,c
->argv
[1],set
);
4235 incrRefCount(c
->argv
[1]);
4237 if (set
->type
!= REDIS_SET
) {
4238 addReply(c
,shared
.wrongtypeerr
);
4242 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
4243 incrRefCount(c
->argv
[2]);
4245 addReply(c
,shared
.cone
);
4247 addReply(c
,shared
.czero
);
4251 static void sremCommand(redisClient
*c
) {
4254 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4256 addReply(c
,shared
.czero
);
4258 if (set
->type
!= REDIS_SET
) {
4259 addReply(c
,shared
.wrongtypeerr
);
4262 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
4264 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4265 addReply(c
,shared
.cone
);
4267 addReply(c
,shared
.czero
);
4272 static void smoveCommand(redisClient
*c
) {
4273 robj
*srcset
, *dstset
;
4275 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4276 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4278 /* If the source key does not exist return 0, if it's of the wrong type
4280 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
4281 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
4284 /* Error if the destination key is not a set as well */
4285 if (dstset
&& dstset
->type
!= REDIS_SET
) {
4286 addReply(c
,shared
.wrongtypeerr
);
4289 /* Remove the element from the source set */
4290 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
4291 /* Key not found in the src set! return zero */
4292 addReply(c
,shared
.czero
);
4296 /* Add the element to the destination set */
4298 dstset
= createSetObject();
4299 dictAdd(c
->db
->dict
,c
->argv
[2],dstset
);
4300 incrRefCount(c
->argv
[2]);
4302 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
4303 incrRefCount(c
->argv
[3]);
4304 addReply(c
,shared
.cone
);
4307 static void sismemberCommand(redisClient
*c
) {
4310 set
= lookupKeyRead(c
->db
,c
->argv
[1]);
4312 addReply(c
,shared
.czero
);
4314 if (set
->type
!= REDIS_SET
) {
4315 addReply(c
,shared
.wrongtypeerr
);
4318 if (dictFind(set
->ptr
,c
->argv
[2]))
4319 addReply(c
,shared
.cone
);
4321 addReply(c
,shared
.czero
);
4325 static void scardCommand(redisClient
*c
) {
4329 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4331 addReply(c
,shared
.czero
);
4334 if (o
->type
!= REDIS_SET
) {
4335 addReply(c
,shared
.wrongtypeerr
);
4338 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4344 static void spopCommand(redisClient
*c
) {
4348 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4350 addReply(c
,shared
.nullbulk
);
4352 if (set
->type
!= REDIS_SET
) {
4353 addReply(c
,shared
.wrongtypeerr
);
4356 de
= dictGetRandomKey(set
->ptr
);
4358 addReply(c
,shared
.nullbulk
);
4360 robj
*ele
= dictGetEntryKey(de
);
4362 addReplyBulkLen(c
,ele
);
4364 addReply(c
,shared
.crlf
);
4365 dictDelete(set
->ptr
,ele
);
4366 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4372 static void srandmemberCommand(redisClient
*c
) {
4376 set
= lookupKeyRead(c
->db
,c
->argv
[1]);
4378 addReply(c
,shared
.nullbulk
);
4380 if (set
->type
!= REDIS_SET
) {
4381 addReply(c
,shared
.wrongtypeerr
);
4384 de
= dictGetRandomKey(set
->ptr
);
4386 addReply(c
,shared
.nullbulk
);
4388 robj
*ele
= dictGetEntryKey(de
);
4390 addReplyBulkLen(c
,ele
);
4392 addReply(c
,shared
.crlf
);
4397 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
4398 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
4400 return dictSize(*d1
)-dictSize(*d2
);
4403 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
4404 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4407 robj
*lenobj
= NULL
, *dstset
= NULL
;
4408 unsigned long j
, cardinality
= 0;
4410 for (j
= 0; j
< setsnum
; j
++) {
4414 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4415 lookupKeyRead(c
->db
,setskeys
[j
]);
4419 if (deleteKey(c
->db
,dstkey
))
4421 addReply(c
,shared
.czero
);
4423 addReply(c
,shared
.nullmultibulk
);
4427 if (setobj
->type
!= REDIS_SET
) {
4429 addReply(c
,shared
.wrongtypeerr
);
4432 dv
[j
] = setobj
->ptr
;
4434 /* Sort sets from the smallest to largest, this will improve our
4435 * algorithm's performace */
4436 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
4438 /* The first thing we should output is the total number of elements...
4439 * since this is a multi-bulk write, but at this stage we don't know
4440 * the intersection set size, so we use a trick, append an empty object
4441 * to the output list and save the pointer to later modify it with the
4444 lenobj
= createObject(REDIS_STRING
,NULL
);
4446 decrRefCount(lenobj
);
4448 /* If we have a target key where to store the resulting set
4449 * create this key with an empty set inside */
4450 dstset
= createSetObject();
4453 /* Iterate all the elements of the first (smallest) set, and test
4454 * the element against all the other sets, if at least one set does
4455 * not include the element it is discarded */
4456 di
= dictGetIterator(dv
[0]);
4458 while((de
= dictNext(di
)) != NULL
) {
4461 for (j
= 1; j
< setsnum
; j
++)
4462 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
4464 continue; /* at least one set does not contain the member */
4465 ele
= dictGetEntryKey(de
);
4467 addReplyBulkLen(c
,ele
);
4469 addReply(c
,shared
.crlf
);
4472 dictAdd(dstset
->ptr
,ele
,NULL
);
4476 dictReleaseIterator(di
);
4479 /* Store the resulting set into the target */
4480 deleteKey(c
->db
,dstkey
);
4481 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4482 incrRefCount(dstkey
);
4486 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
4488 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4489 dictSize((dict
*)dstset
->ptr
)));
4495 static void sinterCommand(redisClient
*c
) {
4496 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
4499 static void sinterstoreCommand(redisClient
*c
) {
4500 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
4503 #define REDIS_OP_UNION 0
4504 #define REDIS_OP_DIFF 1
4506 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
4507 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4510 robj
*dstset
= NULL
;
4511 int j
, cardinality
= 0;
4513 for (j
= 0; j
< setsnum
; j
++) {
4517 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4518 lookupKeyRead(c
->db
,setskeys
[j
]);
4523 if (setobj
->type
!= REDIS_SET
) {
4525 addReply(c
,shared
.wrongtypeerr
);
4528 dv
[j
] = setobj
->ptr
;
4531 /* We need a temp set object to store our union. If the dstkey
4532 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
4533 * this set object will be the resulting object to set into the target key*/
4534 dstset
= createSetObject();
4536 /* Iterate all the elements of all the sets, add every element a single
4537 * time to the result set */
4538 for (j
= 0; j
< setsnum
; j
++) {
4539 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
4540 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
4542 di
= dictGetIterator(dv
[j
]);
4544 while((de
= dictNext(di
)) != NULL
) {
4547 /* dictAdd will not add the same element multiple times */
4548 ele
= dictGetEntryKey(de
);
4549 if (op
== REDIS_OP_UNION
|| j
== 0) {
4550 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
4554 } else if (op
== REDIS_OP_DIFF
) {
4555 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
4560 dictReleaseIterator(di
);
4562 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break; /* result set is empty */
4565 /* Output the content of the resulting set, if not in STORE mode */
4567 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
4568 di
= dictGetIterator(dstset
->ptr
);
4569 while((de
= dictNext(di
)) != NULL
) {
4572 ele
= dictGetEntryKey(de
);
4573 addReplyBulkLen(c
,ele
);
4575 addReply(c
,shared
.crlf
);
4577 dictReleaseIterator(di
);
4579 /* If we have a target key where to store the resulting set
4580 * create this key with the result set inside */
4581 deleteKey(c
->db
,dstkey
);
4582 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4583 incrRefCount(dstkey
);
4588 decrRefCount(dstset
);
4590 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4591 dictSize((dict
*)dstset
->ptr
)));
4597 static void sunionCommand(redisClient
*c
) {
4598 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
4601 static void sunionstoreCommand(redisClient
*c
) {
4602 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
4605 static void sdiffCommand(redisClient
*c
) {
4606 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
4609 static void sdiffstoreCommand(redisClient
*c
) {
4610 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
4613 /* ==================================== ZSets =============================== */
4615 /* ZSETs are ordered sets using two data structures to hold the same elements
4616 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
4619 * The elements are added to an hash table mapping Redis objects to scores.
4620 * At the same time the elements are added to a skip list mapping scores
4621 * to Redis objects (so objects are sorted by scores in this "view"). */
4623 /* This skiplist implementation is almost a C translation of the original
4624 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
4625 * Alternative to Balanced Trees", modified in three ways:
4626 * a) this implementation allows for repeated values.
4627 * b) the comparison is not just by key (our 'score') but by satellite data.
4628 * c) there is a back pointer, so it's a doubly linked list with the back
4629 * pointers being only at "level 1". This allows to traverse the list
4630 * from tail to head, useful for ZREVRANGE. */
4632 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
4633 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
4635 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
4641 static zskiplist
*zslCreate(void) {
4645 zsl
= zmalloc(sizeof(*zsl
));
4648 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
4649 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++)
4650 zsl
->header
->forward
[j
] = NULL
;
4651 zsl
->header
->backward
= NULL
;
4656 static void zslFreeNode(zskiplistNode
*node
) {
4657 decrRefCount(node
->obj
);
4658 zfree(node
->forward
);
4662 static void zslFree(zskiplist
*zsl
) {
4663 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
4665 zfree(zsl
->header
->forward
);
4668 next
= node
->forward
[0];
4675 static int zslRandomLevel(void) {
4677 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
4682 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
4683 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
4687 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4688 while (x
->forward
[i
] &&
4689 (x
->forward
[i
]->score
< score
||
4690 (x
->forward
[i
]->score
== score
&&
4691 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
4695 /* we assume the key is not already inside, since we allow duplicated
4696 * scores, and the re-insertion of score and redis object should never
4697 * happpen since the caller of zslInsert() should test in the hash table
4698 * if the element is already inside or not. */
4699 level
= zslRandomLevel();
4700 if (level
> zsl
->level
) {
4701 for (i
= zsl
->level
; i
< level
; i
++)
4702 update
[i
] = zsl
->header
;
4705 x
= zslCreateNode(level
,score
,obj
);
4706 for (i
= 0; i
< level
; i
++) {
4707 x
->forward
[i
] = update
[i
]->forward
[i
];
4708 update
[i
]->forward
[i
] = x
;
4710 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
4712 x
->forward
[0]->backward
= x
;
4718 /* Delete an element with matching score/object from the skiplist. */
4719 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
4720 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
4724 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4725 while (x
->forward
[i
] &&
4726 (x
->forward
[i
]->score
< score
||
4727 (x
->forward
[i
]->score
== score
&&
4728 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
4732 /* We may have multiple elements with the same score, what we need
4733 * is to find the element with both the right score and object. */
4735 if (x
&& score
== x
->score
&& compareStringObjects(x
->obj
,obj
) == 0) {
4736 for (i
= 0; i
< zsl
->level
; i
++) {
4737 if (update
[i
]->forward
[i
] != x
) break;
4738 update
[i
]->forward
[i
] = x
->forward
[i
];
4740 if (x
->forward
[0]) {
4741 x
->forward
[0]->backward
= (x
->backward
== zsl
->header
) ?
4744 zsl
->tail
= x
->backward
;
4747 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
4752 return 0; /* not found */
4754 return 0; /* not found */
4757 /* Delete all the elements with score between min and max from the skiplist.
4758 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
4759 * Note that this function takes the reference to the hash table view of the
4760 * sorted set, in order to remove the elements from the hash table too. */
4761 static unsigned long zslDeleteRange(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
4762 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
4763 unsigned long removed
= 0;
4767 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4768 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
4772 /* We may have multiple elements with the same score, what we need
4773 * is to find the element with both the right score and object. */
4775 while (x
&& x
->score
<= max
) {
4776 zskiplistNode
*next
;
4778 for (i
= 0; i
< zsl
->level
; i
++) {
4779 if (update
[i
]->forward
[i
] != x
) break;
4780 update
[i
]->forward
[i
] = x
->forward
[i
];
4782 if (x
->forward
[0]) {
4783 x
->forward
[0]->backward
= (x
->backward
== zsl
->header
) ?
4786 zsl
->tail
= x
->backward
;
4788 next
= x
->forward
[0];
4789 dictDelete(dict
,x
->obj
);
4791 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
4797 return removed
; /* not found */
4800 /* Find the first node having a score equal or greater than the specified one.
4801 * Returns NULL if there is no match. */
4802 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
4807 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4808 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
4811 /* We may have multiple elements with the same score, what we need
4812 * is to find the element with both the right score and object. */
4813 return x
->forward
[0];
4816 /* The actual Z-commands implementations */
4818 /* This generic command implements both ZADD and ZINCRBY.
4819 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
4820 * the increment if the operation is a ZINCRBY (doincrement == 1). */
4821 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
4826 zsetobj
= lookupKeyWrite(c
->db
,key
);
4827 if (zsetobj
== NULL
) {
4828 zsetobj
= createZsetObject();
4829 dictAdd(c
->db
->dict
,key
,zsetobj
);
4832 if (zsetobj
->type
!= REDIS_ZSET
) {
4833 addReply(c
,shared
.wrongtypeerr
);
4839 /* Ok now since we implement both ZADD and ZINCRBY here the code
4840 * needs to handle the two different conditions. It's all about setting
4841 * '*score', that is, the new score to set, to the right value. */
4842 score
= zmalloc(sizeof(double));
4846 /* Read the old score. If the element was not present starts from 0 */
4847 de
= dictFind(zs
->dict
,ele
);
4849 double *oldscore
= dictGetEntryVal(de
);
4850 *score
= *oldscore
+ scoreval
;
4858 /* What follows is a simple remove and re-insert operation that is common
4859 * to both ZADD and ZINCRBY... */
4860 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
4861 /* case 1: New element */
4862 incrRefCount(ele
); /* added to hash */
4863 zslInsert(zs
->zsl
,*score
,ele
);
4864 incrRefCount(ele
); /* added to skiplist */
4867 addReplyDouble(c
,*score
);
4869 addReply(c
,shared
.cone
);
4874 /* case 2: Score update operation */
4875 de
= dictFind(zs
->dict
,ele
);
4876 redisAssert(de
!= NULL
);
4877 oldscore
= dictGetEntryVal(de
);
4878 if (*score
!= *oldscore
) {
4881 /* Remove and insert the element in the skip list with new score */
4882 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
4883 redisAssert(deleted
!= 0);
4884 zslInsert(zs
->zsl
,*score
,ele
);
4886 /* Update the score in the hash table */
4887 dictReplace(zs
->dict
,ele
,score
);
4893 addReplyDouble(c
,*score
);
4895 addReply(c
,shared
.czero
);
4899 static void zaddCommand(redisClient
*c
) {
4902 scoreval
= strtod(c
->argv
[2]->ptr
,NULL
);
4903 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
4906 static void zincrbyCommand(redisClient
*c
) {
4909 scoreval
= strtod(c
->argv
[2]->ptr
,NULL
);
4910 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
4913 static void zremCommand(redisClient
*c
) {
4917 zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4918 if (zsetobj
== NULL
) {
4919 addReply(c
,shared
.czero
);
4925 if (zsetobj
->type
!= REDIS_ZSET
) {
4926 addReply(c
,shared
.wrongtypeerr
);
4930 de
= dictFind(zs
->dict
,c
->argv
[2]);
4932 addReply(c
,shared
.czero
);
4935 /* Delete from the skiplist */
4936 oldscore
= dictGetEntryVal(de
);
4937 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
4938 redisAssert(deleted
!= 0);
4940 /* Delete from the hash table */
4941 dictDelete(zs
->dict
,c
->argv
[2]);
4942 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
4944 addReply(c
,shared
.cone
);
4948 static void zremrangebyscoreCommand(redisClient
*c
) {
4949 double min
= strtod(c
->argv
[2]->ptr
,NULL
);
4950 double max
= strtod(c
->argv
[3]->ptr
,NULL
);
4954 zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4955 if (zsetobj
== NULL
) {
4956 addReply(c
,shared
.czero
);
4960 if (zsetobj
->type
!= REDIS_ZSET
) {
4961 addReply(c
,shared
.wrongtypeerr
);
4965 deleted
= zslDeleteRange(zs
->zsl
,min
,max
,zs
->dict
);
4966 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
4967 server
.dirty
+= deleted
;
4968 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",deleted
));
4972 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
4974 int start
= atoi(c
->argv
[2]->ptr
);
4975 int end
= atoi(c
->argv
[3]->ptr
);
4978 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
4980 } else if (c
->argc
>= 5) {
4981 addReply(c
,shared
.syntaxerr
);
4985 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4987 addReply(c
,shared
.nullmultibulk
);
4989 if (o
->type
!= REDIS_ZSET
) {
4990 addReply(c
,shared
.wrongtypeerr
);
4992 zset
*zsetobj
= o
->ptr
;
4993 zskiplist
*zsl
= zsetobj
->zsl
;
4996 int llen
= zsl
->length
;
5000 /* convert negative indexes */
5001 if (start
< 0) start
= llen
+start
;
5002 if (end
< 0) end
= llen
+end
;
5003 if (start
< 0) start
= 0;
5004 if (end
< 0) end
= 0;
5006 /* indexes sanity checks */
5007 if (start
> end
|| start
>= llen
) {
5008 /* Out of range start or start > end result in empty list */
5009 addReply(c
,shared
.emptymultibulk
);
5012 if (end
>= llen
) end
= llen
-1;
5013 rangelen
= (end
-start
)+1;
5015 /* Return the result in form of a multi-bulk reply */
5021 ln
= zsl
->header
->forward
[0];
5023 ln
= ln
->forward
[0];
5026 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
5027 withscores
? (rangelen
*2) : rangelen
));
5028 for (j
= 0; j
< rangelen
; j
++) {
5030 addReplyBulkLen(c
,ele
);
5032 addReply(c
,shared
.crlf
);
5034 addReplyDouble(c
,ln
->score
);
5035 ln
= reverse
? ln
->backward
: ln
->forward
[0];
5041 static void zrangeCommand(redisClient
*c
) {
5042 zrangeGenericCommand(c
,0);
5045 static void zrevrangeCommand(redisClient
*c
) {
5046 zrangeGenericCommand(c
,1);
5049 static void zrangebyscoreCommand(redisClient
*c
) {
5051 double min
= strtod(c
->argv
[2]->ptr
,NULL
);
5052 double max
= strtod(c
->argv
[3]->ptr
,NULL
);
5053 int offset
= 0, limit
= -1;
5055 if (c
->argc
!= 4 && c
->argc
!= 7) {
5057 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
5059 } else if (c
->argc
== 7 && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
5060 addReply(c
,shared
.syntaxerr
);
5062 } else if (c
->argc
== 7) {
5063 offset
= atoi(c
->argv
[5]->ptr
);
5064 limit
= atoi(c
->argv
[6]->ptr
);
5065 if (offset
< 0) offset
= 0;
5068 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5070 addReply(c
,shared
.nullmultibulk
);
5072 if (o
->type
!= REDIS_ZSET
) {
5073 addReply(c
,shared
.wrongtypeerr
);
5075 zset
*zsetobj
= o
->ptr
;
5076 zskiplist
*zsl
= zsetobj
->zsl
;
5079 unsigned int rangelen
= 0;
5081 /* Get the first node with the score >= min */
5082 ln
= zslFirstWithScore(zsl
,min
);
5084 /* No element matching the speciifed interval */
5085 addReply(c
,shared
.emptymultibulk
);
5089 /* We don't know in advance how many matching elements there
5090 * are in the list, so we push this object that will represent
5091 * the multi-bulk length in the output buffer, and will "fix"
5093 lenobj
= createObject(REDIS_STRING
,NULL
);
5095 decrRefCount(lenobj
);
5097 while(ln
&& ln
->score
<= max
) {
5100 ln
= ln
->forward
[0];
5103 if (limit
== 0) break;
5105 addReplyBulkLen(c
,ele
);
5107 addReply(c
,shared
.crlf
);
5108 ln
= ln
->forward
[0];
5110 if (limit
> 0) limit
--;
5112 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%d\r\n",rangelen
);
5117 static void zcardCommand(redisClient
*c
) {
5121 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5123 addReply(c
,shared
.czero
);
5126 if (o
->type
!= REDIS_ZSET
) {
5127 addReply(c
,shared
.wrongtypeerr
);
5130 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",zs
->zsl
->length
));
5135 static void zscoreCommand(redisClient
*c
) {
5139 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5141 addReply(c
,shared
.nullbulk
);
5144 if (o
->type
!= REDIS_ZSET
) {
5145 addReply(c
,shared
.wrongtypeerr
);
5150 de
= dictFind(zs
->dict
,c
->argv
[2]);
5152 addReply(c
,shared
.nullbulk
);
5154 double *score
= dictGetEntryVal(de
);
5156 addReplyDouble(c
,*score
);
5162 /* ========================= Non type-specific commands ==================== */
5164 static void flushdbCommand(redisClient
*c
) {
5165 server
.dirty
+= dictSize(c
->db
->dict
);
5166 dictEmpty(c
->db
->dict
);
5167 dictEmpty(c
->db
->expires
);
5168 addReply(c
,shared
.ok
);
5171 static void flushallCommand(redisClient
*c
) {
5172 server
.dirty
+= emptyDb();
5173 addReply(c
,shared
.ok
);
5174 rdbSave(server
.dbfilename
);
5178 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
5179 redisSortOperation
*so
= zmalloc(sizeof(*so
));
5181 so
->pattern
= pattern
;
5185 /* Return the value associated to the key with a name obtained
5186 * substituting the first occurence of '*' in 'pattern' with 'subst' */
5187 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
5191 int prefixlen
, sublen
, postfixlen
;
5192 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
5196 char buf
[REDIS_SORTKEY_MAX
+1];
5199 /* If the pattern is "#" return the substitution object itself in order
5200 * to implement the "SORT ... GET #" feature. */
5201 spat
= pattern
->ptr
;
5202 if (spat
[0] == '#' && spat
[1] == '\0') {
5206 /* The substitution object may be specially encoded. If so we create
5207 * a decoded object on the fly. Otherwise getDecodedObject will just
5208 * increment the ref count, that we'll decrement later. */
5209 subst
= getDecodedObject(subst
);
5212 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
5213 p
= strchr(spat
,'*');
5215 decrRefCount(subst
);
5220 sublen
= sdslen(ssub
);
5221 postfixlen
= sdslen(spat
)-(prefixlen
+1);
5222 memcpy(keyname
.buf
,spat
,prefixlen
);
5223 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
5224 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
5225 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
5226 keyname
.len
= prefixlen
+sublen
+postfixlen
;
5228 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2))
5229 decrRefCount(subst
);
5231 /* printf("lookup '%s' => %p\n", keyname.buf,de); */
5232 return lookupKeyRead(db
,&keyobj
);
5235 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
5236 * the additional parameter is not standard but a BSD-specific we have to
5237 * pass sorting parameters via the global 'server' structure */
5238 static int sortCompare(const void *s1
, const void *s2
) {
5239 const redisSortObject
*so1
= s1
, *so2
= s2
;
5242 if (!server
.sort_alpha
) {
5243 /* Numeric sorting. Here it's trivial as we precomputed scores */
5244 if (so1
->u
.score
> so2
->u
.score
) {
5246 } else if (so1
->u
.score
< so2
->u
.score
) {
5252 /* Alphanumeric sorting */
5253 if (server
.sort_bypattern
) {
5254 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
5255 /* At least one compare object is NULL */
5256 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
5258 else if (so1
->u
.cmpobj
== NULL
)
5263 /* We have both the objects, use strcoll */
5264 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
5267 /* Compare elements directly */
5270 dec1
= getDecodedObject(so1
->obj
);
5271 dec2
= getDecodedObject(so2
->obj
);
5272 cmp
= strcoll(dec1
->ptr
,dec2
->ptr
);
5277 return server
.sort_desc
? -cmp
: cmp
;
5280 /* The SORT command is the most complex command in Redis. Warning: this code
5281 * is optimized for speed and a bit less for readability */
5282 static void sortCommand(redisClient
*c
) {
5285 int desc
= 0, alpha
= 0;
5286 int limit_start
= 0, limit_count
= -1, start
, end
;
5287 int j
, dontsort
= 0, vectorlen
;
5288 int getop
= 0; /* GET operation counter */
5289 robj
*sortval
, *sortby
= NULL
, *storekey
= NULL
;
5290 redisSortObject
*vector
; /* Resulting vector to sort */
5292 /* Lookup the key to sort. It must be of the right types */
5293 sortval
= lookupKeyRead(c
->db
,c
->argv
[1]);
5294 if (sortval
== NULL
) {
5295 addReply(c
,shared
.nullmultibulk
);
5298 if (sortval
->type
!= REDIS_SET
&& sortval
->type
!= REDIS_LIST
&&
5299 sortval
->type
!= REDIS_ZSET
)
5301 addReply(c
,shared
.wrongtypeerr
);
5305 /* Create a list of operations to perform for every sorted element.
5306 * Operations can be GET/DEL/INCR/DECR */
5307 operations
= listCreate();
5308 listSetFreeMethod(operations
,zfree
);
5311 /* Now we need to protect sortval incrementing its count, in the future
5312 * SORT may have options able to overwrite/delete keys during the sorting
5313 * and the sorted key itself may get destroied */
5314 incrRefCount(sortval
);
5316 /* The SORT command has an SQL-alike syntax, parse it */
5317 while(j
< c
->argc
) {
5318 int leftargs
= c
->argc
-j
-1;
5319 if (!strcasecmp(c
->argv
[j
]->ptr
,"asc")) {
5321 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"desc")) {
5323 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"alpha")) {
5325 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"limit") && leftargs
>= 2) {
5326 limit_start
= atoi(c
->argv
[j
+1]->ptr
);
5327 limit_count
= atoi(c
->argv
[j
+2]->ptr
);
5329 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"store") && leftargs
>= 1) {
5330 storekey
= c
->argv
[j
+1];
5332 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"by") && leftargs
>= 1) {
5333 sortby
= c
->argv
[j
+1];
5334 /* If the BY pattern does not contain '*', i.e. it is constant,
5335 * we don't need to sort nor to lookup the weight keys. */
5336 if (strchr(c
->argv
[j
+1]->ptr
,'*') == NULL
) dontsort
= 1;
5338 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"get") && leftargs
>= 1) {
5339 listAddNodeTail(operations
,createSortOperation(
5340 REDIS_SORT_GET
,c
->argv
[j
+1]));
5344 decrRefCount(sortval
);
5345 listRelease(operations
);
5346 addReply(c
,shared
.syntaxerr
);
5352 /* Load the sorting vector with all the objects to sort */
5353 switch(sortval
->type
) {
5354 case REDIS_LIST
: vectorlen
= listLength((list
*)sortval
->ptr
); break;
5355 case REDIS_SET
: vectorlen
= dictSize((dict
*)sortval
->ptr
); break;
5356 case REDIS_ZSET
: vectorlen
= dictSize(((zset
*)sortval
->ptr
)->dict
); break;
5357 default: vectorlen
= 0; redisAssert(0); /* Avoid GCC warning */
5359 vector
= zmalloc(sizeof(redisSortObject
)*vectorlen
);
5362 if (sortval
->type
== REDIS_LIST
) {
5363 list
*list
= sortval
->ptr
;
5367 while((ln
= listYield(list
))) {
5368 robj
*ele
= ln
->value
;
5369 vector
[j
].obj
= ele
;
5370 vector
[j
].u
.score
= 0;
5371 vector
[j
].u
.cmpobj
= NULL
;
5379 if (sortval
->type
== REDIS_SET
) {
5382 zset
*zs
= sortval
->ptr
;
5386 di
= dictGetIterator(set
);
5387 while((setele
= dictNext(di
)) != NULL
) {
5388 vector
[j
].obj
= dictGetEntryKey(setele
);
5389 vector
[j
].u
.score
= 0;
5390 vector
[j
].u
.cmpobj
= NULL
;
5393 dictReleaseIterator(di
);
5395 redisAssert(j
== vectorlen
);
5397 /* Now it's time to load the right scores in the sorting vector */
5398 if (dontsort
== 0) {
5399 for (j
= 0; j
< vectorlen
; j
++) {
5403 byval
= lookupKeyByPattern(c
->db
,sortby
,vector
[j
].obj
);
5404 if (!byval
|| byval
->type
!= REDIS_STRING
) continue;
5406 vector
[j
].u
.cmpobj
= getDecodedObject(byval
);
5408 if (byval
->encoding
== REDIS_ENCODING_RAW
) {
5409 vector
[j
].u
.score
= strtod(byval
->ptr
,NULL
);
5411 /* Don't need to decode the object if it's
5412 * integer-encoded (the only encoding supported) so
5413 * far. We can just cast it */
5414 if (byval
->encoding
== REDIS_ENCODING_INT
) {
5415 vector
[j
].u
.score
= (long)byval
->ptr
;
5417 redisAssert(1 != 1);
5422 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_RAW
)
5423 vector
[j
].u
.score
= strtod(vector
[j
].obj
->ptr
,NULL
);
5425 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_INT
)
5426 vector
[j
].u
.score
= (long) vector
[j
].obj
->ptr
;
5428 redisAssert(1 != 1);
5435 /* We are ready to sort the vector... perform a bit of sanity check
5436 * on the LIMIT option too. We'll use a partial version of quicksort. */
5437 start
= (limit_start
< 0) ? 0 : limit_start
;
5438 end
= (limit_count
< 0) ? vectorlen
-1 : start
+limit_count
-1;
5439 if (start
>= vectorlen
) {
5440 start
= vectorlen
-1;
5443 if (end
>= vectorlen
) end
= vectorlen
-1;
5445 if (dontsort
== 0) {
5446 server
.sort_desc
= desc
;
5447 server
.sort_alpha
= alpha
;
5448 server
.sort_bypattern
= sortby
? 1 : 0;
5449 if (sortby
&& (start
!= 0 || end
!= vectorlen
-1))
5450 pqsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
, start
,end
);
5452 qsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
);
5455 /* Send command output to the output buffer, performing the specified
5456 * GET/DEL/INCR/DECR operations if any. */
5457 outputlen
= getop
? getop
*(end
-start
+1) : end
-start
+1;
5458 if (storekey
== NULL
) {
5459 /* STORE option not specified, sent the sorting result to client */
5460 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",outputlen
));
5461 for (j
= start
; j
<= end
; j
++) {
5464 addReplyBulkLen(c
,vector
[j
].obj
);
5465 addReply(c
,vector
[j
].obj
);
5466 addReply(c
,shared
.crlf
);
5468 listRewind(operations
);
5469 while((ln
= listYield(operations
))) {
5470 redisSortOperation
*sop
= ln
->value
;
5471 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
5474 if (sop
->type
== REDIS_SORT_GET
) {
5475 if (!val
|| val
->type
!= REDIS_STRING
) {
5476 addReply(c
,shared
.nullbulk
);
5478 addReplyBulkLen(c
,val
);
5480 addReply(c
,shared
.crlf
);
5483 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
5488 robj
*listObject
= createListObject();
5489 list
*listPtr
= (list
*) listObject
->ptr
;
5491 /* STORE option specified, set the sorting result as a List object */
5492 for (j
= start
; j
<= end
; j
++) {
5495 listAddNodeTail(listPtr
,vector
[j
].obj
);
5496 incrRefCount(vector
[j
].obj
);
5498 listRewind(operations
);
5499 while((ln
= listYield(operations
))) {
5500 redisSortOperation
*sop
= ln
->value
;
5501 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
5504 if (sop
->type
== REDIS_SORT_GET
) {
5505 if (!val
|| val
->type
!= REDIS_STRING
) {
5506 listAddNodeTail(listPtr
,createStringObject("",0));
5508 listAddNodeTail(listPtr
,val
);
5512 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
5516 if (dictReplace(c
->db
->dict
,storekey
,listObject
)) {
5517 incrRefCount(storekey
);
5519 /* Note: we add 1 because the DB is dirty anyway since even if the
5520 * SORT result is empty a new key is set and maybe the old content
5522 server
.dirty
+= 1+outputlen
;
5523 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",outputlen
));
5527 decrRefCount(sortval
);
5528 listRelease(operations
);
5529 for (j
= 0; j
< vectorlen
; j
++) {
5530 if (sortby
&& alpha
&& vector
[j
].u
.cmpobj
)
5531 decrRefCount(vector
[j
].u
.cmpobj
);
5536 /* Convert an amount of bytes into a human readable string in the form
5537 * of 100B, 2G, 100M, 4K, and so forth. */
5538 static void bytesToHuman(char *s
, unsigned long long n
) {
5543 sprintf(s
,"%lluB",n
);
5545 } else if (n
< (1024*1024)) {
5546 d
= (double)n
/(1024);
5547 sprintf(s
,"%.2fK",d
);
5548 } else if (n
< (1024LL*1024*1024)) {
5549 d
= (double)n
/(1024*1024);
5550 sprintf(s
,"%.2fM",d
);
5551 } else if (n
< (1024LL*1024*1024*1024)) {
5552 d
= (double)n
/(1024LL*1024*1024);
5553 sprintf(s
,"%.2fM",d
);
5557 /* Create the string returned by the INFO command. This is decoupled
5558 * by the INFO command itself as we need to report the same information
5559 * on memory corruption problems. */
5560 static sds
genRedisInfoString(void) {
5562 time_t uptime
= time(NULL
)-server
.stat_starttime
;
5566 bytesToHuman(hmem
,server
.usedmemory
);
5567 info
= sdscatprintf(sdsempty(),
5568 "redis_version:%s\r\n"
5570 "multiplexing_api:%s\r\n"
5571 "process_id:%ld\r\n"
5572 "uptime_in_seconds:%ld\r\n"
5573 "uptime_in_days:%ld\r\n"
5574 "connected_clients:%d\r\n"
5575 "connected_slaves:%d\r\n"
5576 "blocked_clients:%d\r\n"
5577 "used_memory:%zu\r\n"
5578 "used_memory_human:%s\r\n"
5579 "changes_since_last_save:%lld\r\n"
5580 "bgsave_in_progress:%d\r\n"
5581 "last_save_time:%ld\r\n"
5582 "bgrewriteaof_in_progress:%d\r\n"
5583 "total_connections_received:%lld\r\n"
5584 "total_commands_processed:%lld\r\n"
5588 (sizeof(long) == 8) ? "64" : "32",
5593 listLength(server
.clients
)-listLength(server
.slaves
),
5594 listLength(server
.slaves
),
5595 server
.blockedclients
,
5599 server
.bgsavechildpid
!= -1,
5601 server
.bgrewritechildpid
!= -1,
5602 server
.stat_numconnections
,
5603 server
.stat_numcommands
,
5604 server
.vm_enabled
!= 0,
5605 server
.masterhost
== NULL
? "master" : "slave"
5607 if (server
.masterhost
) {
5608 info
= sdscatprintf(info
,
5609 "master_host:%s\r\n"
5610 "master_port:%d\r\n"
5611 "master_link_status:%s\r\n"
5612 "master_last_io_seconds_ago:%d\r\n"
5615 (server
.replstate
== REDIS_REPL_CONNECTED
) ?
5617 server
.master
? ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1
5620 if (server
.vm_enabled
) {
5621 info
= sdscatprintf(info
,
5622 "vm_conf_max_memory:%llu\r\n"
5623 "vm_conf_page_size:%llu\r\n"
5624 "vm_conf_pages:%llu\r\n"
5625 "vm_stats_used_pages:%llu\r\n"
5626 "vm_stats_swapped_objects:%llu\r\n"
5627 "vm_stats_swappin_count:%llu\r\n"
5628 "vm_stats_swappout_count:%llu\r\n"
5629 "vm_stats_io_newjobs_len:%lu\r\n"
5630 "vm_stats_io_processing_len:%lu\r\n"
5631 "vm_stats_io_processed_len:%lu\r\n"
5632 "vm_stats_io_waiting_clients:%lu\r\n"
5633 "vm_stats_io_active_threads:%lu\r\n"
5634 ,(unsigned long long) server
.vm_max_memory
,
5635 (unsigned long long) server
.vm_page_size
,
5636 (unsigned long long) server
.vm_pages
,
5637 (unsigned long long) server
.vm_stats_used_pages
,
5638 (unsigned long long) server
.vm_stats_swapped_objects
,
5639 (unsigned long long) server
.vm_stats_swapins
,
5640 (unsigned long long) server
.vm_stats_swapouts
,
5641 (unsigned long) listLength(server
.io_newjobs
),
5642 (unsigned long) listLength(server
.io_processing
),
5643 (unsigned long) listLength(server
.io_processed
),
5644 (unsigned long) listLength(server
.io_clients
),
5645 (unsigned long) server
.io_active_threads
5648 for (j
= 0; j
< server
.dbnum
; j
++) {
5649 long long keys
, vkeys
;
5651 keys
= dictSize(server
.db
[j
].dict
);
5652 vkeys
= dictSize(server
.db
[j
].expires
);
5653 if (keys
|| vkeys
) {
5654 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
5661 static void infoCommand(redisClient
*c
) {
5662 sds info
= genRedisInfoString();
5663 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
5664 (unsigned long)sdslen(info
)));
5665 addReplySds(c
,info
);
5666 addReply(c
,shared
.crlf
);
5669 static void monitorCommand(redisClient
*c
) {
5670 /* ignore MONITOR if aleady slave or in monitor mode */
5671 if (c
->flags
& REDIS_SLAVE
) return;
5673 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
5675 listAddNodeTail(server
.monitors
,c
);
5676 addReply(c
,shared
.ok
);
5679 /* ================================= Expire ================================= */
5680 static int removeExpire(redisDb
*db
, robj
*key
) {
5681 if (dictDelete(db
->expires
,key
) == DICT_OK
) {
5688 static int setExpire(redisDb
*db
, robj
*key
, time_t when
) {
5689 if (dictAdd(db
->expires
,key
,(void*)when
) == DICT_ERR
) {
5697 /* Return the expire time of the specified key, or -1 if no expire
5698 * is associated with this key (i.e. the key is non volatile) */
5699 static time_t getExpire(redisDb
*db
, robj
*key
) {
5702 /* No expire? return ASAP */
5703 if (dictSize(db
->expires
) == 0 ||
5704 (de
= dictFind(db
->expires
,key
)) == NULL
) return -1;
5706 return (time_t) dictGetEntryVal(de
);
5709 static int expireIfNeeded(redisDb
*db
, robj
*key
) {
5713 /* No expire? return ASAP */
5714 if (dictSize(db
->expires
) == 0 ||
5715 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
5717 /* Lookup the expire */
5718 when
= (time_t) dictGetEntryVal(de
);
5719 if (time(NULL
) <= when
) return 0;
5721 /* Delete the key */
5722 dictDelete(db
->expires
,key
);
5723 return dictDelete(db
->dict
,key
) == DICT_OK
;
5726 static int deleteIfVolatile(redisDb
*db
, robj
*key
) {
5729 /* No expire? return ASAP */
5730 if (dictSize(db
->expires
) == 0 ||
5731 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
5733 /* Delete the key */
5735 dictDelete(db
->expires
,key
);
5736 return dictDelete(db
->dict
,key
) == DICT_OK
;
5739 static void expireGenericCommand(redisClient
*c
, robj
*key
, time_t seconds
) {
5742 de
= dictFind(c
->db
->dict
,key
);
5744 addReply(c
,shared
.czero
);
5748 if (deleteKey(c
->db
,key
)) server
.dirty
++;
5749 addReply(c
, shared
.cone
);
5752 time_t when
= time(NULL
)+seconds
;
5753 if (setExpire(c
->db
,key
,when
)) {
5754 addReply(c
,shared
.cone
);
5757 addReply(c
,shared
.czero
);
5763 static void expireCommand(redisClient
*c
) {
5764 expireGenericCommand(c
,c
->argv
[1],strtol(c
->argv
[2]->ptr
,NULL
,10));
5767 static void expireatCommand(redisClient
*c
) {
5768 expireGenericCommand(c
,c
->argv
[1],strtol(c
->argv
[2]->ptr
,NULL
,10)-time(NULL
));
5771 static void ttlCommand(redisClient
*c
) {
5775 expire
= getExpire(c
->db
,c
->argv
[1]);
5777 ttl
= (int) (expire
-time(NULL
));
5778 if (ttl
< 0) ttl
= -1;
5780 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",ttl
));
5783 /* ================================ MULTI/EXEC ============================== */
5785 /* Client state initialization for MULTI/EXEC */
5786 static void initClientMultiState(redisClient
*c
) {
5787 c
->mstate
.commands
= NULL
;
5788 c
->mstate
.count
= 0;
5791 /* Release all the resources associated with MULTI/EXEC state */
5792 static void freeClientMultiState(redisClient
*c
) {
5795 for (j
= 0; j
< c
->mstate
.count
; j
++) {
5797 multiCmd
*mc
= c
->mstate
.commands
+j
;
5799 for (i
= 0; i
< mc
->argc
; i
++)
5800 decrRefCount(mc
->argv
[i
]);
5803 zfree(c
->mstate
.commands
);
5806 /* Add a new command into the MULTI commands queue */
5807 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
) {
5811 c
->mstate
.commands
= zrealloc(c
->mstate
.commands
,
5812 sizeof(multiCmd
)*(c
->mstate
.count
+1));
5813 mc
= c
->mstate
.commands
+c
->mstate
.count
;
5816 mc
->argv
= zmalloc(sizeof(robj
*)*c
->argc
);
5817 memcpy(mc
->argv
,c
->argv
,sizeof(robj
*)*c
->argc
);
5818 for (j
= 0; j
< c
->argc
; j
++)
5819 incrRefCount(mc
->argv
[j
]);
5823 static void multiCommand(redisClient
*c
) {
5824 c
->flags
|= REDIS_MULTI
;
5825 addReply(c
,shared
.ok
);
5828 static void execCommand(redisClient
*c
) {
5833 if (!(c
->flags
& REDIS_MULTI
)) {
5834 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
5838 orig_argv
= c
->argv
;
5839 orig_argc
= c
->argc
;
5840 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
5841 for (j
= 0; j
< c
->mstate
.count
; j
++) {
5842 c
->argc
= c
->mstate
.commands
[j
].argc
;
5843 c
->argv
= c
->mstate
.commands
[j
].argv
;
5844 call(c
,c
->mstate
.commands
[j
].cmd
);
5846 c
->argv
= orig_argv
;
5847 c
->argc
= orig_argc
;
5848 freeClientMultiState(c
);
5849 initClientMultiState(c
);
5850 c
->flags
&= (~REDIS_MULTI
);
5853 /* =========================== Blocking Operations ========================= */
5855 /* Currently Redis blocking operations support is limited to list POP ops,
5856 * so the current implementation is not fully generic, but it is also not
5857 * completely specific so it will not require a rewrite to support new
5858 * kind of blocking operations in the future.
5860 * Still it's important to note that list blocking operations can be already
5861 * used as a notification mechanism in order to implement other blocking
5862 * operations at application level, so there must be a very strong evidence
5863 * of usefulness and generality before new blocking operations are implemented.
5865 * This is how the current blocking POP works, we use BLPOP as example:
5866 * - If the user calls BLPOP and the key exists and contains a non empty list
5867 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
5868 * if there is not to block.
5869 * - If instead BLPOP is called and the key does not exists or the list is
5870 * empty we need to block. In order to do so we remove the notification for
5871 * new data to read in the client socket (so that we'll not serve new
5872 * requests if the blocking request is not served). Also we put the client
5873 * in a dictionary (db->blockingkeys) mapping keys to a list of clients
5874 * blocking for this keys.
5875 * - If a PUSH operation against a key with blocked clients waiting is
5876 * performed, we serve the first in the list: basically instead to push
5877 * the new element inside the list we return it to the (first / oldest)
5878 * blocking client, unblock the client, and remove it form the list.
5880 * The above comment and the source code should be enough in order to understand
5881 * the implementation and modify / fix it later.
5884 /* Set a client in blocking mode for the specified key, with the specified
5886 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
5891 c
->blockingkeys
= zmalloc(sizeof(robj
*)*numkeys
);
5892 c
->blockingkeysnum
= numkeys
;
5893 c
->blockingto
= timeout
;
5894 for (j
= 0; j
< numkeys
; j
++) {
5895 /* Add the key in the client structure, to map clients -> keys */
5896 c
->blockingkeys
[j
] = keys
[j
];
5897 incrRefCount(keys
[j
]);
5899 /* And in the other "side", to map keys -> clients */
5900 de
= dictFind(c
->db
->blockingkeys
,keys
[j
]);
5904 /* For every key we take a list of clients blocked for it */
5906 retval
= dictAdd(c
->db
->blockingkeys
,keys
[j
],l
);
5907 incrRefCount(keys
[j
]);
5908 assert(retval
== DICT_OK
);
5910 l
= dictGetEntryVal(de
);
5912 listAddNodeTail(l
,c
);
5914 /* Mark the client as a blocked client */
5915 c
->flags
|= REDIS_BLOCKED
;
5916 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
5917 server
.blockedclients
++;
5920 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
5921 static void unblockClient(redisClient
*c
) {
5926 assert(c
->blockingkeys
!= NULL
);
5927 /* The client may wait for multiple keys, so unblock it for every key. */
5928 for (j
= 0; j
< c
->blockingkeysnum
; j
++) {
5929 /* Remove this client from the list of clients waiting for this key. */
5930 de
= dictFind(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
5932 l
= dictGetEntryVal(de
);
5933 listDelNode(l
,listSearchKey(l
,c
));
5934 /* If the list is empty we need to remove it to avoid wasting memory */
5935 if (listLength(l
) == 0)
5936 dictDelete(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
5937 decrRefCount(c
->blockingkeys
[j
]);
5939 /* Cleanup the client structure */
5940 zfree(c
->blockingkeys
);
5941 c
->blockingkeys
= NULL
;
5942 c
->flags
&= (~REDIS_BLOCKED
);
5943 server
.blockedclients
--;
5944 /* Ok now we are ready to get read events from socket, note that we
5945 * can't trap errors here as it's possible that unblockClients() is
5946 * called from freeClient() itself, and the only thing we can do
5947 * if we failed to register the READABLE event is to kill the client.
5948 * Still the following function should never fail in the real world as
5949 * we are sure the file descriptor is sane, and we exit on out of mem. */
5950 aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
, readQueryFromClient
, c
);
5951 /* As a final step we want to process data if there is some command waiting
5952 * in the input buffer. Note that this is safe even if unblockClient()
5953 * gets called from freeClient() because freeClient() will be smart
5954 * enough to call this function *after* c->querybuf was set to NULL. */
5955 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
5958 /* This should be called from any function PUSHing into lists.
5959 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
5960 * 'ele' is the element pushed.
5962 * If the function returns 0 there was no client waiting for a list push
5965 * If the function returns 1 there was a client waiting for a list push
5966 * against this key, the element was passed to this client thus it's not
5967 * needed to actually add it to the list and the caller should return asap. */
5968 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
5969 struct dictEntry
*de
;
5970 redisClient
*receiver
;
5974 de
= dictFind(c
->db
->blockingkeys
,key
);
5975 if (de
== NULL
) return 0;
5976 l
= dictGetEntryVal(de
);
5979 receiver
= ln
->value
;
5981 addReplySds(receiver
,sdsnew("*2\r\n"));
5982 addReplyBulkLen(receiver
,key
);
5983 addReply(receiver
,key
);
5984 addReply(receiver
,shared
.crlf
);
5985 addReplyBulkLen(receiver
,ele
);
5986 addReply(receiver
,ele
);
5987 addReply(receiver
,shared
.crlf
);
5988 unblockClient(receiver
);
5992 /* Blocking RPOP/LPOP */
5993 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
5998 for (j
= 1; j
< c
->argc
-1; j
++) {
5999 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
6001 if (o
->type
!= REDIS_LIST
) {
6002 addReply(c
,shared
.wrongtypeerr
);
6005 list
*list
= o
->ptr
;
6006 if (listLength(list
) != 0) {
6007 /* If the list contains elements fall back to the usual
6008 * non-blocking POP operation */
6009 robj
*argv
[2], **orig_argv
;
6012 /* We need to alter the command arguments before to call
6013 * popGenericCommand() as the command takes a single key. */
6014 orig_argv
= c
->argv
;
6015 orig_argc
= c
->argc
;
6016 argv
[1] = c
->argv
[j
];
6020 /* Also the return value is different, we need to output
6021 * the multi bulk reply header and the key name. The
6022 * "real" command will add the last element (the value)
6023 * for us. If this souds like an hack to you it's just
6024 * because it is... */
6025 addReplySds(c
,sdsnew("*2\r\n"));
6026 addReplyBulkLen(c
,argv
[1]);
6027 addReply(c
,argv
[1]);
6028 addReply(c
,shared
.crlf
);
6029 popGenericCommand(c
,where
);
6031 /* Fix the client structure with the original stuff */
6032 c
->argv
= orig_argv
;
6033 c
->argc
= orig_argc
;
6039 /* If the list is empty or the key does not exists we must block */
6040 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
6041 if (timeout
> 0) timeout
+= time(NULL
);
6042 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
6045 static void blpopCommand(redisClient
*c
) {
6046 blockingPopGenericCommand(c
,REDIS_HEAD
);
6049 static void brpopCommand(redisClient
*c
) {
6050 blockingPopGenericCommand(c
,REDIS_TAIL
);
6053 /* =============================== Replication ============================= */
6055 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
6056 ssize_t nwritten
, ret
= size
;
6057 time_t start
= time(NULL
);
6061 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
6062 nwritten
= write(fd
,ptr
,size
);
6063 if (nwritten
== -1) return -1;
6067 if ((time(NULL
)-start
) > timeout
) {
6075 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
6076 ssize_t nread
, totread
= 0;
6077 time_t start
= time(NULL
);
6081 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
6082 nread
= read(fd
,ptr
,size
);
6083 if (nread
== -1) return -1;
6088 if ((time(NULL
)-start
) > timeout
) {
6096 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
6103 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
6106 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
6117 static void syncCommand(redisClient
*c
) {
6118 /* ignore SYNC if aleady slave or in monitor mode */
6119 if (c
->flags
& REDIS_SLAVE
) return;
6121 /* SYNC can't be issued when the server has pending data to send to
6122 * the client about already issued commands. We need a fresh reply
6123 * buffer registering the differences between the BGSAVE and the current
6124 * dataset, so that we can copy to other slaves if needed. */
6125 if (listLength(c
->reply
) != 0) {
6126 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
6130 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
6131 /* Here we need to check if there is a background saving operation
6132 * in progress, or if it is required to start one */
6133 if (server
.bgsavechildpid
!= -1) {
6134 /* Ok a background save is in progress. Let's check if it is a good
6135 * one for replication, i.e. if there is another slave that is
6136 * registering differences since the server forked to save */
6140 listRewind(server
.slaves
);
6141 while((ln
= listYield(server
.slaves
))) {
6143 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
6146 /* Perfect, the server is already registering differences for
6147 * another slave. Set the right state, and copy the buffer. */
6148 listRelease(c
->reply
);
6149 c
->reply
= listDup(slave
->reply
);
6150 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
6151 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
6153 /* No way, we need to wait for the next BGSAVE in order to
6154 * register differences */
6155 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
6156 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
6159 /* Ok we don't have a BGSAVE in progress, let's start one */
6160 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
6161 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
6162 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
6163 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
6166 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
6169 c
->flags
|= REDIS_SLAVE
;
6171 listAddNodeTail(server
.slaves
,c
);
6175 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
6176 redisClient
*slave
= privdata
;
6178 REDIS_NOTUSED(mask
);
6179 char buf
[REDIS_IOBUF_LEN
];
6180 ssize_t nwritten
, buflen
;
6182 if (slave
->repldboff
== 0) {
6183 /* Write the bulk write count before to transfer the DB. In theory here
6184 * we don't know how much room there is in the output buffer of the
6185 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
6186 * operations) will never be smaller than the few bytes we need. */
6189 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
6191 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
6199 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
6200 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
6202 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
6203 (buflen
== 0) ? "premature EOF" : strerror(errno
));
6207 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
6208 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
6213 slave
->repldboff
+= nwritten
;
6214 if (slave
->repldboff
== slave
->repldbsize
) {
6215 close(slave
->repldbfd
);
6216 slave
->repldbfd
= -1;
6217 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
6218 slave
->replstate
= REDIS_REPL_ONLINE
;
6219 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
6220 sendReplyToClient
, slave
) == AE_ERR
) {
6224 addReplySds(slave
,sdsempty());
6225 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
6229 /* This function is called at the end of every backgrond saving.
6230 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
6231 * otherwise REDIS_ERR is passed to the function.
6233 * The goal of this function is to handle slaves waiting for a successful
6234 * background saving in order to perform non-blocking synchronization. */
6235 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
6237 int startbgsave
= 0;
6239 listRewind(server
.slaves
);
6240 while((ln
= listYield(server
.slaves
))) {
6241 redisClient
*slave
= ln
->value
;
6243 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
6245 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
6246 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
6247 struct redis_stat buf
;
6249 if (bgsaveerr
!= REDIS_OK
) {
6251 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
6254 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
6255 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
6257 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
6260 slave
->repldboff
= 0;
6261 slave
->repldbsize
= buf
.st_size
;
6262 slave
->replstate
= REDIS_REPL_SEND_BULK
;
6263 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
6264 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
6271 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
6272 listRewind(server
.slaves
);
6273 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
6274 while((ln
= listYield(server
.slaves
))) {
6275 redisClient
*slave
= ln
->value
;
6277 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
6284 static int syncWithMaster(void) {
6285 char buf
[1024], tmpfile
[256], authcmd
[1024];
6287 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
6291 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
6296 /* AUTH with the master if required. */
6297 if(server
.masterauth
) {
6298 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
6299 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
6301 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
6305 /* Read the AUTH result. */
6306 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
6308 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
6312 if (buf
[0] != '+') {
6314 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
6319 /* Issue the SYNC command */
6320 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
6322 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
6326 /* Read the bulk write count */
6327 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
6329 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
6333 if (buf
[0] != '$') {
6335 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
6338 dumpsize
= atoi(buf
+1);
6339 redisLog(REDIS_NOTICE
,"Receiving %d bytes data dump from MASTER",dumpsize
);
6340 /* Read the bulk write data on a temp file */
6341 snprintf(tmpfile
,256,"temp-%d.%ld.rdb",(int)time(NULL
),(long int)random());
6342 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
,0644);
6345 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
6349 int nread
, nwritten
;
6351 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
6353 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
6359 nwritten
= write(dfd
,buf
,nread
);
6360 if (nwritten
== -1) {
6361 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
6369 if (rename(tmpfile
,server
.dbfilename
) == -1) {
6370 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
6376 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
6377 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
6381 server
.master
= createClient(fd
);
6382 server
.master
->flags
|= REDIS_MASTER
;
6383 server
.master
->authenticated
= 1;
6384 server
.replstate
= REDIS_REPL_CONNECTED
;
6388 static void slaveofCommand(redisClient
*c
) {
6389 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
6390 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
6391 if (server
.masterhost
) {
6392 sdsfree(server
.masterhost
);
6393 server
.masterhost
= NULL
;
6394 if (server
.master
) freeClient(server
.master
);
6395 server
.replstate
= REDIS_REPL_NONE
;
6396 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
6399 sdsfree(server
.masterhost
);
6400 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
6401 server
.masterport
= atoi(c
->argv
[2]->ptr
);
6402 if (server
.master
) freeClient(server
.master
);
6403 server
.replstate
= REDIS_REPL_CONNECT
;
6404 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
6405 server
.masterhost
, server
.masterport
);
6407 addReply(c
,shared
.ok
);
6410 /* ============================ Maxmemory directive ======================== */
6412 /* Try to free one object form the pre-allocated objects free list.
6413 * This is useful under low mem conditions as by default we take 1 million
6414 * free objects allocated. On success REDIS_OK is returned, otherwise
6416 static int tryFreeOneObjectFromFreelist(void) {
6419 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
6420 if (listLength(server
.objfreelist
)) {
6421 listNode
*head
= listFirst(server
.objfreelist
);
6422 o
= listNodeValue(head
);
6423 listDelNode(server
.objfreelist
,head
);
6424 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
6428 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
6433 /* This function gets called when 'maxmemory' is set on the config file to limit
6434 * the max memory used by the server, and we are out of memory.
6435 * This function will try to, in order:
6437 * - Free objects from the free list
6438 * - Try to remove keys with an EXPIRE set
6440 * It is not possible to free enough memory to reach used-memory < maxmemory
6441 * the server will start refusing commands that will enlarge even more the
6444 static void freeMemoryIfNeeded(void) {
6445 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
6446 int j
, k
, freed
= 0;
6448 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
6449 for (j
= 0; j
< server
.dbnum
; j
++) {
6451 robj
*minkey
= NULL
;
6452 struct dictEntry
*de
;
6454 if (dictSize(server
.db
[j
].expires
)) {
6456 /* From a sample of three keys drop the one nearest to
6457 * the natural expire */
6458 for (k
= 0; k
< 3; k
++) {
6461 de
= dictGetRandomKey(server
.db
[j
].expires
);
6462 t
= (time_t) dictGetEntryVal(de
);
6463 if (minttl
== -1 || t
< minttl
) {
6464 minkey
= dictGetEntryKey(de
);
6468 deleteKey(server
.db
+j
,minkey
);
6471 if (!freed
) return; /* nothing to free... */
6475 /* ============================== Append Only file ========================== */
6477 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
6478 sds buf
= sdsempty();
6484 /* The DB this command was targetting is not the same as the last command
6485 * we appendend. To issue a SELECT command is needed. */
6486 if (dictid
!= server
.appendseldb
) {
6489 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
6490 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
6491 (unsigned long)strlen(seldb
),seldb
);
6492 server
.appendseldb
= dictid
;
6495 /* "Fix" the argv vector if the command is EXPIRE. We want to translate
6496 * EXPIREs into EXPIREATs calls */
6497 if (cmd
->proc
== expireCommand
) {
6500 tmpargv
[0] = createStringObject("EXPIREAT",8);
6501 tmpargv
[1] = argv
[1];
6502 incrRefCount(argv
[1]);
6503 when
= time(NULL
)+strtol(argv
[2]->ptr
,NULL
,10);
6504 tmpargv
[2] = createObject(REDIS_STRING
,
6505 sdscatprintf(sdsempty(),"%ld",when
));
6509 /* Append the actual command */
6510 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
6511 for (j
= 0; j
< argc
; j
++) {
6514 o
= getDecodedObject(o
);
6515 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
6516 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
6517 buf
= sdscatlen(buf
,"\r\n",2);
6521 /* Free the objects from the modified argv for EXPIREAT */
6522 if (cmd
->proc
== expireCommand
) {
6523 for (j
= 0; j
< 3; j
++)
6524 decrRefCount(argv
[j
]);
6527 /* We want to perform a single write. This should be guaranteed atomic
6528 * at least if the filesystem we are writing is a real physical one.
6529 * While this will save us against the server being killed I don't think
6530 * there is much to do about the whole server stopping for power problems
6532 nwritten
= write(server
.appendfd
,buf
,sdslen(buf
));
6533 if (nwritten
!= (signed)sdslen(buf
)) {
6534 /* Ooops, we are in troubles. The best thing to do for now is
6535 * to simply exit instead to give the illusion that everything is
6536 * working as expected. */
6537 if (nwritten
== -1) {
6538 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
6540 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
6544 /* If a background append only file rewriting is in progress we want to
6545 * accumulate the differences between the child DB and the current one
6546 * in a buffer, so that when the child process will do its work we
6547 * can append the differences to the new append only file. */
6548 if (server
.bgrewritechildpid
!= -1)
6549 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
6553 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
6554 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
6555 now
-server
.lastfsync
> 1))
6557 fsync(server
.appendfd
); /* Let's try to get this data on the disk */
6558 server
.lastfsync
= now
;
6562 /* In Redis commands are always executed in the context of a client, so in
6563 * order to load the append only file we need to create a fake client. */
6564 static struct redisClient
*createFakeClient(void) {
6565 struct redisClient
*c
= zmalloc(sizeof(*c
));
6569 c
->querybuf
= sdsempty();
6573 /* We set the fake client as a slave waiting for the synchronization
6574 * so that Redis will not try to send replies to this client. */
6575 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
6576 c
->reply
= listCreate();
6577 listSetFreeMethod(c
->reply
,decrRefCount
);
6578 listSetDupMethod(c
->reply
,dupClientReplyValue
);
6582 static void freeFakeClient(struct redisClient
*c
) {
6583 sdsfree(c
->querybuf
);
6584 listRelease(c
->reply
);
6588 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
6589 * error (the append only file is zero-length) REDIS_ERR is returned. On
6590 * fatal error an error message is logged and the program exists. */
6591 int loadAppendOnlyFile(char *filename
) {
6592 struct redisClient
*fakeClient
;
6593 FILE *fp
= fopen(filename
,"r");
6594 struct redis_stat sb
;
6595 unsigned long long loadedkeys
= 0;
6597 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
6601 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
6605 fakeClient
= createFakeClient();
6612 struct redisCommand
*cmd
;
6614 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
6620 if (buf
[0] != '*') goto fmterr
;
6622 argv
= zmalloc(sizeof(robj
*)*argc
);
6623 for (j
= 0; j
< argc
; j
++) {
6624 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
6625 if (buf
[0] != '$') goto fmterr
;
6626 len
= strtol(buf
+1,NULL
,10);
6627 argsds
= sdsnewlen(NULL
,len
);
6628 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
6629 argv
[j
] = createObject(REDIS_STRING
,argsds
);
6630 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
6633 /* Command lookup */
6634 cmd
= lookupCommand(argv
[0]->ptr
);
6636 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
6639 /* Try object sharing and encoding */
6640 if (server
.shareobjects
) {
6642 for(j
= 1; j
< argc
; j
++)
6643 argv
[j
] = tryObjectSharing(argv
[j
]);
6645 if (cmd
->flags
& REDIS_CMD_BULK
)
6646 tryObjectEncoding(argv
[argc
-1]);
6647 /* Run the command in the context of a fake client */
6648 fakeClient
->argc
= argc
;
6649 fakeClient
->argv
= argv
;
6650 cmd
->proc(fakeClient
);
6651 /* Discard the reply objects list from the fake client */
6652 while(listLength(fakeClient
->reply
))
6653 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
6654 /* Clean up, ready for the next command */
6655 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
6657 /* Handle swapping while loading big datasets when VM is on */
6659 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
6660 while (zmalloc_used_memory() > server
.vm_max_memory
) {
6661 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
6666 freeFakeClient(fakeClient
);
6671 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
6673 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
6677 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
6681 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
6682 static int fwriteBulk(FILE *fp
, robj
*obj
) {
6686 /* Avoid the incr/decr ref count business if possible to help
6687 * copy-on-write (we are often in a child process when this function
6689 * Also makes sure that key objects don't get incrRefCount-ed when VM
6691 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
6692 obj
= getDecodedObject(obj
);
6695 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(long)sdslen(obj
->ptr
));
6696 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) goto err
;
6697 if (sdslen(obj
->ptr
) && fwrite(obj
->ptr
,sdslen(obj
->ptr
),1,fp
) == 0)
6699 if (fwrite("\r\n",2,1,fp
) == 0) goto err
;
6700 if (decrrc
) decrRefCount(obj
);
6703 if (decrrc
) decrRefCount(obj
);
6707 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
6708 static int fwriteBulkDouble(FILE *fp
, double d
) {
6709 char buf
[128], dbuf
[128];
6711 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
6712 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
6713 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
6714 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
6718 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
6719 static int fwriteBulkLong(FILE *fp
, long l
) {
6720 char buf
[128], lbuf
[128];
6722 snprintf(lbuf
,sizeof(lbuf
),"%ld\r\n",l
);
6723 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(lbuf
)-2);
6724 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
6725 if (fwrite(lbuf
,strlen(lbuf
),1,fp
) == 0) return 0;
6729 /* Write a sequence of commands able to fully rebuild the dataset into
6730 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
6731 static int rewriteAppendOnlyFile(char *filename
) {
6732 dictIterator
*di
= NULL
;
6737 time_t now
= time(NULL
);
6739 /* Note that we have to use a different temp name here compared to the
6740 * one used by rewriteAppendOnlyFileBackground() function. */
6741 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
6742 fp
= fopen(tmpfile
,"w");
6744 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
6747 for (j
= 0; j
< server
.dbnum
; j
++) {
6748 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
6749 redisDb
*db
= server
.db
+j
;
6751 if (dictSize(d
) == 0) continue;
6752 di
= dictGetIterator(d
);
6758 /* SELECT the new DB */
6759 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
6760 if (fwriteBulkLong(fp
,j
) == 0) goto werr
;
6762 /* Iterate this DB writing every entry */
6763 while((de
= dictNext(di
)) != NULL
) {
6768 key
= dictGetEntryKey(de
);
6769 /* If the value for this key is swapped, load a preview in memory.
6770 * We use a "swapped" flag to remember if we need to free the
6771 * value object instead to just increment the ref count anyway
6772 * in order to avoid copy-on-write of pages if we are forked() */
6773 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
6774 key
->storage
== REDIS_VM_SWAPPING
) {
6775 o
= dictGetEntryVal(de
);
6778 o
= vmPreviewObject(key
);
6781 expiretime
= getExpire(db
,key
);
6783 /* Save the key and associated value */
6784 if (o
->type
== REDIS_STRING
) {
6785 /* Emit a SET command */
6786 char cmd
[]="*3\r\n$3\r\nSET\r\n";
6787 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
6789 if (fwriteBulk(fp
,key
) == 0) goto werr
;
6790 if (fwriteBulk(fp
,o
) == 0) goto werr
;
6791 } else if (o
->type
== REDIS_LIST
) {
6792 /* Emit the RPUSHes needed to rebuild the list */
6793 list
*list
= o
->ptr
;
6797 while((ln
= listYield(list
))) {
6798 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
6799 robj
*eleobj
= listNodeValue(ln
);
6801 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
6802 if (fwriteBulk(fp
,key
) == 0) goto werr
;
6803 if (fwriteBulk(fp
,eleobj
) == 0) goto werr
;
6805 } else if (o
->type
== REDIS_SET
) {
6806 /* Emit the SADDs needed to rebuild the set */
6808 dictIterator
*di
= dictGetIterator(set
);
6811 while((de
= dictNext(di
)) != NULL
) {
6812 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
6813 robj
*eleobj
= dictGetEntryKey(de
);
6815 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
6816 if (fwriteBulk(fp
,key
) == 0) goto werr
;
6817 if (fwriteBulk(fp
,eleobj
) == 0) goto werr
;
6819 dictReleaseIterator(di
);
6820 } else if (o
->type
== REDIS_ZSET
) {
6821 /* Emit the ZADDs needed to rebuild the sorted set */
6823 dictIterator
*di
= dictGetIterator(zs
->dict
);
6826 while((de
= dictNext(di
)) != NULL
) {
6827 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
6828 robj
*eleobj
= dictGetEntryKey(de
);
6829 double *score
= dictGetEntryVal(de
);
6831 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
6832 if (fwriteBulk(fp
,key
) == 0) goto werr
;
6833 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
6834 if (fwriteBulk(fp
,eleobj
) == 0) goto werr
;
6836 dictReleaseIterator(di
);
6838 redisAssert(0 != 0);
6840 /* Save the expire time */
6841 if (expiretime
!= -1) {
6842 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
6843 /* If this key is already expired skip it */
6844 if (expiretime
< now
) continue;
6845 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
6846 if (fwriteBulk(fp
,key
) == 0) goto werr
;
6847 if (fwriteBulkLong(fp
,expiretime
) == 0) goto werr
;
6849 if (swapped
) decrRefCount(o
);
6851 dictReleaseIterator(di
);
6854 /* Make sure data will not remain on the OS's output buffers */
6859 /* Use RENAME to make sure the DB file is changed atomically only
6860 * if the generate DB file is ok. */
6861 if (rename(tmpfile
,filename
) == -1) {
6862 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
6866 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
6872 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
6873 if (di
) dictReleaseIterator(di
);
6877 /* This is how rewriting of the append only file in background works:
6879 * 1) The user calls BGREWRITEAOF
6880 * 2) Redis calls this function, that forks():
6881 * 2a) the child rewrite the append only file in a temp file.
6882 * 2b) the parent accumulates differences in server.bgrewritebuf.
6883 * 3) When the child finished '2a' exists.
6884 * 4) The parent will trap the exit code, if it's OK, will append the
6885 * data accumulated into server.bgrewritebuf into the temp file, and
6886 * finally will rename(2) the temp file in the actual file name.
6887 * The the new file is reopened as the new append only file. Profit!
6889 static int rewriteAppendOnlyFileBackground(void) {
6892 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
6893 if ((childpid
= fork()) == 0) {
6898 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
6899 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
6906 if (childpid
== -1) {
6907 redisLog(REDIS_WARNING
,
6908 "Can't rewrite append only file in background: fork: %s",
6912 redisLog(REDIS_NOTICE
,
6913 "Background append only file rewriting started by pid %d",childpid
);
6914 server
.bgrewritechildpid
= childpid
;
6915 /* We set appendseldb to -1 in order to force the next call to the
6916 * feedAppendOnlyFile() to issue a SELECT command, so the differences
6917 * accumulated by the parent into server.bgrewritebuf will start
6918 * with a SELECT statement and it will be safe to merge. */
6919 server
.appendseldb
= -1;
6922 return REDIS_OK
; /* unreached */
6925 static void bgrewriteaofCommand(redisClient
*c
) {
6926 if (server
.bgrewritechildpid
!= -1) {
6927 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
6930 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
6931 char *status
= "+Background append only file rewriting started\r\n";
6932 addReplySds(c
,sdsnew(status
));
6934 addReply(c
,shared
.err
);
6938 static void aofRemoveTempFile(pid_t childpid
) {
6941 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
6945 /* Virtual Memory is composed mainly of two subsystems:
6946 * - Blocking Virutal Memory
6947 * - Threaded Virtual Memory I/O
6948 * The two parts are not fully decoupled, but functions are split among two
6949 * different sections of the source code (delimited by comments) in order to
6950 * make more clear what functionality is about the blocking VM and what about
6951 * the threaded (not blocking) VM.
6955 * Redis VM is a blocking VM (one that blocks reading swapped values from
6956 * disk into memory when a value swapped out is needed in memory) that is made
6957 * unblocking by trying to examine the command argument vector in order to
6958 * load in background values that will likely be needed in order to exec
6959 * the command. The command is executed only once all the relevant keys
6960 * are loaded into memory.
6962 * This basically is almost as simple of a blocking VM, but almost as parallel
6963 * as a fully non-blocking VM.
6966 /* =================== Virtual Memory - Blocking Side ====================== */
6967 static void vmInit(void) {
6971 server
.vm_fp
= fopen("/tmp/redisvm","w+b");
6972 if (server
.vm_fp
== NULL
) {
6973 redisLog(REDIS_WARNING
,"Impossible to open the swap file. Exiting.");
6976 server
.vm_fd
= fileno(server
.vm_fp
);
6977 server
.vm_next_page
= 0;
6978 server
.vm_near_pages
= 0;
6979 server
.vm_stats_used_pages
= 0;
6980 server
.vm_stats_swapped_objects
= 0;
6981 server
.vm_stats_swapouts
= 0;
6982 server
.vm_stats_swapins
= 0;
6983 totsize
= server
.vm_pages
*server
.vm_page_size
;
6984 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
6985 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
6986 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
6990 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
6992 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
6993 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
6994 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
6995 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
6996 /* Try to remove the swap file, so the OS will really delete it from the
6997 * file system when Redis exists. */
6998 unlink("/tmp/redisvm");
7000 /* Initialize threaded I/O (used by Virtual Memory) */
7001 server
.io_newjobs
= listCreate();
7002 server
.io_processing
= listCreate();
7003 server
.io_processed
= listCreate();
7004 server
.io_clients
= listCreate();
7005 pthread_mutex_init(&server
.io_mutex
,NULL
);
7006 pthread_mutex_init(&server
.obj_freelist_mutex
,NULL
);
7007 pthread_mutex_init(&server
.io_swapfile_mutex
,NULL
);
7008 server
.io_active_threads
= 0;
7009 if (pipe(pipefds
) == -1) {
7010 redisLog(REDIS_WARNING
,"Unable to intialized VM: pipe(2): %s. Exiting."
7014 server
.io_ready_pipe_read
= pipefds
[0];
7015 server
.io_ready_pipe_write
= pipefds
[1];
7016 redisAssert(anetNonBlock(NULL
,server
.io_ready_pipe_read
) != ANET_ERR
);
7017 /* Listen for events in the threaded I/O pipe */
7018 if (aeCreateFileEvent(server
.el
, server
.io_ready_pipe_read
, AE_READABLE
,
7019 vmThreadedIOCompletedJob
, NULL
) == AE_ERR
)
7020 oom("creating file event");
7023 /* Mark the page as used */
7024 static void vmMarkPageUsed(off_t page
) {
7025 off_t byte
= page
/8;
7027 server
.vm_bitmap
[byte
] |= 1<<bit
;
7028 redisLog(REDIS_DEBUG
,"Mark used: %lld (byte:%lld bit:%d)\n",
7029 (long long)page
, (long long)byte
, bit
);
7032 /* Mark N contiguous pages as used, with 'page' being the first. */
7033 static void vmMarkPagesUsed(off_t page
, off_t count
) {
7036 for (j
= 0; j
< count
; j
++)
7037 vmMarkPageUsed(page
+j
);
7038 server
.vm_stats_used_pages
+= count
;
7041 /* Mark the page as free */
7042 static void vmMarkPageFree(off_t page
) {
7043 off_t byte
= page
/8;
7045 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
7048 /* Mark N contiguous pages as free, with 'page' being the first. */
7049 static void vmMarkPagesFree(off_t page
, off_t count
) {
7052 for (j
= 0; j
< count
; j
++)
7053 vmMarkPageFree(page
+j
);
7054 server
.vm_stats_used_pages
-= count
;
7057 /* Test if the page is free */
7058 static int vmFreePage(off_t page
) {
7059 off_t byte
= page
/8;
7061 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
7064 /* Find N contiguous free pages storing the first page of the cluster in *first.
7065 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
7066 * REDIS_ERR is returned.
7068 * This function uses a simple algorithm: we try to allocate
7069 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
7070 * again from the start of the swap file searching for free spaces.
7072 * If it looks pretty clear that there are no free pages near our offset
7073 * we try to find less populated places doing a forward jump of
7074 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
7075 * without hurry, and then we jump again and so forth...
7077 * This function can be improved using a free list to avoid to guess
7078 * too much, since we could collect data about freed pages.
7080 * note: I implemented this function just after watching an episode of
7081 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
7083 static int vmFindContiguousPages(off_t
*first
, int n
) {
7084 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
7086 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
7087 server
.vm_near_pages
= 0;
7088 server
.vm_next_page
= 0;
7090 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
7091 base
= server
.vm_next_page
;
7093 while(offset
< server
.vm_pages
) {
7094 off_t
this = base
+offset
;
7096 redisLog(REDIS_DEBUG
, "THIS: %lld (%c)\n", (long long) this, vmFreePage(this) ? 'F' : 'X');
7097 /* If we overflow, restart from page zero */
7098 if (this >= server
.vm_pages
) {
7099 this -= server
.vm_pages
;
7101 /* Just overflowed, what we found on tail is no longer
7102 * interesting, as it's no longer contiguous. */
7106 if (vmFreePage(this)) {
7107 /* This is a free page */
7109 /* Already got N free pages? Return to the caller, with success */
7111 *first
= this-(n
-1);
7112 server
.vm_next_page
= this+1;
7116 /* The current one is not a free page */
7120 /* Fast-forward if the current page is not free and we already
7121 * searched enough near this place. */
7123 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
7124 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
7126 /* Note that even if we rewind after the jump, we are don't need
7127 * to make sure numfree is set to zero as we only jump *if* it
7128 * is set to zero. */
7130 /* Otherwise just check the next page */
7137 /* Write the specified object at the specified page of the swap file */
7138 static int vmWriteObjectOnSwap(robj
*o
, off_t page
) {
7139 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
7140 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
7141 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
7142 redisLog(REDIS_WARNING
,
7143 "Critical VM problem in vmSwapObjectBlocking(): can't seek: %s",
7147 rdbSaveObject(server
.vm_fp
,o
);
7148 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
7152 /* Swap the 'val' object relative to 'key' into disk. Store all the information
7153 * needed to later retrieve the object into the key object.
7154 * If we can't find enough contiguous empty pages to swap the object on disk
7155 * REDIS_ERR is returned. */
7156 static int vmSwapObjectBlocking(robj
*key
, robj
*val
) {
7157 off_t pages
= rdbSavedObjectPages(val
,NULL
);
7160 assert(key
->storage
== REDIS_VM_MEMORY
);
7161 assert(key
->refcount
== 1);
7162 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return REDIS_ERR
;
7163 if (vmWriteObjectOnSwap(val
,page
) == REDIS_ERR
) return REDIS_ERR
;
7164 key
->vm
.page
= page
;
7165 key
->vm
.usedpages
= pages
;
7166 key
->storage
= REDIS_VM_SWAPPED
;
7167 key
->vtype
= val
->type
;
7168 decrRefCount(val
); /* Deallocate the object from memory. */
7169 vmMarkPagesUsed(page
,pages
);
7170 redisLog(REDIS_DEBUG
,"VM: object %s swapped out at %lld (%lld pages)",
7171 (unsigned char*) key
->ptr
,
7172 (unsigned long long) page
, (unsigned long long) pages
);
7173 server
.vm_stats_swapped_objects
++;
7174 server
.vm_stats_swapouts
++;
7175 fflush(server
.vm_fp
);
7179 static robj
*vmReadObjectFromSwap(off_t page
, int type
) {
7182 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
7183 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
7184 redisLog(REDIS_WARNING
,
7185 "Unrecoverable VM problem in vmLoadObject(): can't seek: %s",
7189 o
= rdbLoadObject(type
,server
.vm_fp
);
7191 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmLoadObject(): can't load object from swap file: %s", strerror(errno
));
7194 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
7198 /* Load the value object relative to the 'key' object from swap to memory.
7199 * The newly allocated object is returned.
7201 * If preview is true the unserialized object is returned to the caller but
7202 * no changes are made to the key object, nor the pages are marked as freed */
7203 static robj
*vmGenericLoadObject(robj
*key
, int preview
) {
7206 redisAssert(key
->storage
== REDIS_VM_SWAPPED
);
7207 val
= vmReadObjectFromSwap(key
->vm
.page
,key
->vtype
);
7209 key
->storage
= REDIS_VM_MEMORY
;
7210 key
->vm
.atime
= server
.unixtime
;
7211 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
7212 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk",
7213 (unsigned char*) key
->ptr
);
7214 server
.vm_stats_swapped_objects
--;
7216 redisLog(REDIS_DEBUG
, "VM: object %s previewed from disk",
7217 (unsigned char*) key
->ptr
);
7219 server
.vm_stats_swapins
++;
7223 /* Plain object loading, from swap to memory */
7224 static robj
*vmLoadObject(robj
*key
) {
7225 /* If we are loading the object in background, stop it, we
7226 * need to load this object synchronously ASAP. */
7227 if (key
->storage
== REDIS_VM_LOADING
)
7228 vmCancelThreadedIOJob(key
);
7229 return vmGenericLoadObject(key
,0);
7232 /* Just load the value on disk, without to modify the key.
7233 * This is useful when we want to perform some operation on the value
7234 * without to really bring it from swap to memory, like while saving the
7235 * dataset or rewriting the append only log. */
7236 static robj
*vmPreviewObject(robj
*key
) {
7237 return vmGenericLoadObject(key
,1);
7240 /* How a good candidate is this object for swapping?
7241 * The better candidate it is, the greater the returned value.
7243 * Currently we try to perform a fast estimation of the object size in
7244 * memory, and combine it with aging informations.
7246 * Basically swappability = idle-time * log(estimated size)
7248 * Bigger objects are preferred over smaller objects, but not
7249 * proportionally, this is why we use the logarithm. This algorithm is
7250 * just a first try and will probably be tuned later. */
7251 static double computeObjectSwappability(robj
*o
) {
7252 time_t age
= server
.unixtime
- o
->vm
.atime
;
7256 struct dictEntry
*de
;
7259 if (age
<= 0) return 0;
7262 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
7265 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
7270 listNode
*ln
= listFirst(l
);
7272 asize
= sizeof(list
);
7274 robj
*ele
= ln
->value
;
7277 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
7278 (sizeof(*o
)+sdslen(ele
->ptr
)) :
7280 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
7285 z
= (o
->type
== REDIS_ZSET
);
7286 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
7288 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
7289 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
7294 de
= dictGetRandomKey(d
);
7295 ele
= dictGetEntryKey(de
);
7296 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
7297 (sizeof(*o
)+sdslen(ele
->ptr
)) :
7299 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
7300 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
7304 return (double)asize
*log(1+asize
);
7307 /* Try to swap an object that's a good candidate for swapping.
7308 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
7309 * to swap any object at all.
7311 * If 'usethreaded' is true, Redis will try to swap the object in background
7312 * using I/O threads. */
7313 static int vmSwapOneObject(int usethreads
) {
7315 struct dictEntry
*best
= NULL
;
7316 double best_swappability
= 0;
7317 redisDb
*best_db
= NULL
;
7320 for (j
= 0; j
< server
.dbnum
; j
++) {
7321 redisDb
*db
= server
.db
+j
;
7322 int maxtries
= 1000;
7324 if (dictSize(db
->dict
) == 0) continue;
7325 for (i
= 0; i
< 5; i
++) {
7327 double swappability
;
7329 if (maxtries
) maxtries
--;
7330 de
= dictGetRandomKey(db
->dict
);
7331 key
= dictGetEntryKey(de
);
7332 val
= dictGetEntryVal(de
);
7333 if (key
->storage
!= REDIS_VM_MEMORY
) {
7334 if (maxtries
) i
--; /* don't count this try */
7337 swappability
= computeObjectSwappability(val
);
7338 if (!best
|| swappability
> best_swappability
) {
7340 best_swappability
= swappability
;
7346 redisLog(REDIS_DEBUG
,"No swappable key found!");
7349 key
= dictGetEntryKey(best
);
7350 val
= dictGetEntryVal(best
);
7352 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
7353 key
->ptr
, best_swappability
);
7355 /* Unshare the key if needed */
7356 if (key
->refcount
> 1) {
7357 robj
*newkey
= dupStringObject(key
);
7359 key
= dictGetEntryKey(best
) = newkey
;
7363 vmSwapObjectThreaded(key
,val
,best_db
);
7366 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
7367 dictGetEntryVal(best
) = NULL
;
7375 static int vmSwapOneObjectBlocking() {
7376 return vmSwapOneObject(0);
7379 static int vmSwapOneObjectThreaded() {
7380 return vmSwapOneObject(1);
7383 /* Return true if it's safe to swap out objects in a given moment.
7384 * Basically we don't want to swap objects out while there is a BGSAVE
7385 * or a BGAEOREWRITE running in backgroud. */
7386 static int vmCanSwapOut(void) {
7387 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
7390 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
7391 * and was deleted. Otherwise 0 is returned. */
7392 static int deleteIfSwapped(redisDb
*db
, robj
*key
) {
7396 if ((de
= dictFind(db
->dict
,key
)) == NULL
) return 0;
7397 foundkey
= dictGetEntryKey(de
);
7398 if (foundkey
->storage
== REDIS_VM_MEMORY
) return 0;
7403 /* =================== Virtual Memory - Threaded I/O ======================= */
7405 static void freeIOJob(iojob
*j
) {
7406 if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
||
7407 j
->type
== REDIS_IOJOB_DO_SWAP
)
7408 decrRefCount(j
->val
);
7409 decrRefCount(j
->key
);
7413 /* Every time a thread finished a Job, it writes a byte into the write side
7414 * of an unix pipe in order to "awake" the main thread, and this function
7416 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
,
7423 REDIS_NOTUSED(mask
);
7424 REDIS_NOTUSED(privdata
);
7426 /* For every byte we read in the read side of the pipe, there is one
7427 * I/O job completed to process. */
7428 while((retval
= read(fd
,buf
,1)) == 1) {
7432 struct dictEntry
*de
;
7434 redisLog(REDIS_DEBUG
,"Processing I/O completed job");
7435 assert(listLength(server
.io_processed
) != 0);
7437 /* Get the processed element (the oldest one) */
7439 ln
= listFirst(server
.io_processed
);
7441 listDelNode(server
.io_processed
,ln
);
7443 /* If this job is marked as canceled, just ignore it */
7448 /* Post process it in the main thread, as there are things we
7449 * can do just here to avoid race conditions and/or invasive locks */
7450 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
);
7451 de
= dictFind(j
->db
->dict
,j
->key
);
7453 key
= dictGetEntryKey(de
);
7454 if (j
->type
== REDIS_IOJOB_LOAD
) {
7455 /* Key loaded, bring it at home */
7456 key
->storage
= REDIS_VM_MEMORY
;
7457 key
->vm
.atime
= server
.unixtime
;
7458 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
7459 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk (threaded)",
7460 (unsigned char*) key
->ptr
);
7461 server
.vm_stats_swapped_objects
--;
7462 server
.vm_stats_swapins
++;
7464 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
7465 /* Now we know the amount of pages required to swap this object.
7466 * Let's find some space for it, and queue this task again
7467 * rebranded as REDIS_IOJOB_DO_SWAP. */
7468 if (vmFindContiguousPages(&j
->page
,j
->pages
) == REDIS_ERR
) {
7469 /* Ooops... no space! */
7472 j
->type
= REDIS_IOJOB_DO_SWAP
;
7477 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
7480 /* Key swapped. We can finally free some memory. */
7481 if (key
->storage
!= REDIS_VM_SWAPPING
) {
7482 printf("key->storage: %d\n",key
->storage
);
7483 printf("key->name: %s\n",(char*)key
->ptr
);
7484 printf("key->refcount: %d\n",key
->refcount
);
7485 printf("val: %p\n",(void*)j
->val
);
7486 printf("val->type: %d\n",j
->val
->type
);
7487 printf("val->ptr: %s\n",(char*)j
->val
->ptr
);
7489 redisAssert(key
->storage
== REDIS_VM_SWAPPING
);
7490 val
= dictGetEntryVal(de
);
7491 key
->vm
.page
= j
->page
;
7492 key
->vm
.usedpages
= j
->pages
;
7493 key
->storage
= REDIS_VM_SWAPPED
;
7494 key
->vtype
= j
->val
->type
;
7495 decrRefCount(val
); /* Deallocate the object from memory. */
7496 dictGetEntryVal(de
) = NULL
;
7497 vmMarkPagesUsed(j
->page
,j
->pages
);
7498 redisLog(REDIS_DEBUG
,
7499 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
7500 (unsigned char*) key
->ptr
,
7501 (unsigned long long) j
->page
, (unsigned long long) j
->pages
);
7502 server
.vm_stats_swapped_objects
++;
7503 server
.vm_stats_swapouts
++;
7505 /* Put a few more swap requests in queue if we are still
7507 if (zmalloc_used_memory() > server
.vm_max_memory
) {
7511 more
= listLength(server
.io_newjobs
) <
7512 (unsigned) server
.vm_max_threads
;
7514 /* Don't waste CPU time if swappable objects are rare. */
7515 if (vmSwapOneObjectThreaded() == REDIS_ERR
) break;
7520 if (processed
== REDIS_MAX_COMPLETED_JOBS_PROCESSED
) return;
7522 if (retval
< 0 && errno
!= EAGAIN
) {
7523 redisLog(REDIS_WARNING
,
7524 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
7529 static void lockThreadedIO(void) {
7530 pthread_mutex_lock(&server
.io_mutex
);
7533 static void unlockThreadedIO(void) {
7534 pthread_mutex_unlock(&server
.io_mutex
);
7537 /* Remove the specified object from the threaded I/O queue if still not
7538 * processed, otherwise make sure to flag it as canceled. */
7539 static void vmCancelThreadedIOJob(robj
*o
) {
7541 server
.io_newjobs
, /* 0 */
7542 server
.io_processing
, /* 1 */
7543 server
.io_processed
/* 2 */
7547 assert(o
->storage
== REDIS_VM_LOADING
|| o
->storage
== REDIS_VM_SWAPPING
);
7549 /* Search for a matching key in one of the queues */
7550 for (i
= 0; i
< 3; i
++) {
7553 listRewind(lists
[i
]);
7554 while ((ln
= listYield(lists
[i
])) != NULL
) {
7555 iojob
*job
= ln
->value
;
7557 if (job
->canceled
) continue; /* Skip this, already canceled. */
7558 if (compareStringObjects(job
->key
,o
) == 0) {
7559 redisLog(REDIS_DEBUG
,"*** CANCELED %p (%s)\n",
7560 (void*)job
, (char*)o
->ptr
);
7562 case 0: /* io_newjobs */
7563 /* If the job was yet not processed the best thing to do
7564 * is to remove it from the queue at all */
7566 listDelNode(lists
[i
],ln
);
7568 case 1: /* io_processing */
7569 case 2: /* io_processed */
7573 if (o
->storage
== REDIS_VM_LOADING
)
7574 o
->storage
= REDIS_VM_SWAPPED
;
7575 else if (o
->storage
== REDIS_VM_SWAPPING
)
7576 o
->storage
= REDIS_VM_MEMORY
;
7583 assert(1 != 1); /* We should never reach this */
7586 static void *IOThreadEntryPoint(void *arg
) {
7591 pthread_detach(pthread_self());
7593 /* Get a new job to process */
7595 if (listLength(server
.io_newjobs
) == 0) {
7596 /* No new jobs in queue, exit. */
7597 redisLog(REDIS_DEBUG
,"Thread %lld exiting, nothing to do\n",
7598 (long long) pthread_self());
7599 server
.io_active_threads
--;
7603 ln
= listFirst(server
.io_newjobs
);
7605 listDelNode(server
.io_newjobs
,ln
);
7606 /* Add the job in the processing queue */
7607 j
->thread
= pthread_self();
7608 listAddNodeTail(server
.io_processing
,j
);
7609 ln
= listLast(server
.io_processing
); /* We use ln later to remove it */
7611 redisLog(REDIS_DEBUG
,"Thread %lld got a new job (type %d): %p about key '%s'\n",
7612 (long long) pthread_self(), j
->type
, (void*)j
, (char*)j
->key
->ptr
);
7614 /* Process the Job */
7615 if (j
->type
== REDIS_IOJOB_LOAD
) {
7616 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
7617 FILE *fp
= fopen("/dev/null","w+");
7618 j
->pages
= rdbSavedObjectPages(j
->val
,fp
);
7620 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
7621 if (vmWriteObjectOnSwap(j
->val
,j
->page
) == REDIS_ERR
)
7625 /* Done: insert the job into the processed queue */
7626 redisLog(REDIS_DEBUG
,"Thread %lld completed the job: %p (key %s)\n",
7627 (long long) pthread_self(), (void*)j
, (char*)j
->key
->ptr
);
7629 listDelNode(server
.io_processing
,ln
);
7630 listAddNodeTail(server
.io_processed
,j
);
7633 /* Signal the main thread there is new stuff to process */
7634 assert(write(server
.io_ready_pipe_write
,"x",1) == 1);
7636 return NULL
; /* never reached */
7639 static void spawnIOThread(void) {
7642 pthread_create(&thread
,NULL
,IOThreadEntryPoint
,NULL
);
7643 server
.io_active_threads
++;
7646 /* This function must be called while with threaded IO locked */
7647 static void queueIOJob(iojob
*j
) {
7648 redisLog(REDIS_DEBUG
,"Queued IO Job %p type %d about key '%s'\n",
7649 (void*)j
, j
->type
, (char*)j
->key
->ptr
);
7650 listAddNodeTail(server
.io_newjobs
,j
);
7651 if (server
.io_active_threads
< server
.vm_max_threads
)
7655 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
) {
7658 assert(key
->storage
== REDIS_VM_MEMORY
);
7659 assert(key
->refcount
== 1);
7661 j
= zmalloc(sizeof(*j
));
7662 j
->type
= REDIS_IOJOB_PREPARE_SWAP
;
7664 j
->key
= dupStringObject(key
);
7668 j
->thread
= (pthread_t
) -1;
7669 key
->storage
= REDIS_VM_SWAPPING
;
7677 /* ================================= Debugging ============================== */
7679 static void debugCommand(redisClient
*c
) {
7680 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
7682 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
7683 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
7684 addReply(c
,shared
.err
);
7688 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
7689 addReply(c
,shared
.err
);
7692 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
7693 addReply(c
,shared
.ok
);
7694 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
7696 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
7697 addReply(c
,shared
.err
);
7700 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
7701 addReply(c
,shared
.ok
);
7702 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
7703 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
7707 addReply(c
,shared
.nokeyerr
);
7710 key
= dictGetEntryKey(de
);
7711 val
= dictGetEntryVal(de
);
7712 if (server
.vm_enabled
&& (key
->storage
== REDIS_VM_MEMORY
||
7713 key
->storage
== REDIS_VM_SWAPPING
)) {
7714 addReplySds(c
,sdscatprintf(sdsempty(),
7715 "+Key at:%p refcount:%d, value at:%p refcount:%d "
7716 "encoding:%d serializedlength:%lld\r\n",
7717 (void*)key
, key
->refcount
, (void*)val
, val
->refcount
,
7718 val
->encoding
, rdbSavedObjectLen(val
,NULL
)));
7720 addReplySds(c
,sdscatprintf(sdsempty(),
7721 "+Key at:%p refcount:%d, value swapped at: page %llu "
7722 "using %llu pages\r\n",
7723 (void*)key
, key
->refcount
, (unsigned long long) key
->vm
.page
,
7724 (unsigned long long) key
->vm
.usedpages
));
7726 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
7727 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
7730 if (!server
.vm_enabled
) {
7731 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
7735 addReply(c
,shared
.nokeyerr
);
7738 key
= dictGetEntryKey(de
);
7739 val
= dictGetEntryVal(de
);
7740 /* If the key is shared we want to create a copy */
7741 if (key
->refcount
> 1) {
7742 robj
*newkey
= dupStringObject(key
);
7744 key
= dictGetEntryKey(de
) = newkey
;
7747 if (key
->storage
!= REDIS_VM_MEMORY
) {
7748 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
7749 } else if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
7750 dictGetEntryVal(de
) = NULL
;
7751 addReply(c
,shared
.ok
);
7753 addReply(c
,shared
.err
);
7756 addReplySds(c
,sdsnew(
7757 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPOUT <key>|RELOAD]\r\n"));
7761 static void _redisAssert(char *estr
, char *file
, int line
) {
7762 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
7763 redisLog(REDIS_WARNING
,"==> %s:%d '%s' is not true\n",file
,line
,estr
);
7764 #ifdef HAVE_BACKTRACE
7765 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
7770 /* =================================== Main! ================================ */
7773 int linuxOvercommitMemoryValue(void) {
7774 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
7778 if (fgets(buf
,64,fp
) == NULL
) {
7787 void linuxOvercommitMemoryWarning(void) {
7788 if (linuxOvercommitMemoryValue() == 0) {
7789 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.");
7792 #endif /* __linux__ */
7794 static void daemonize(void) {
7798 if (fork() != 0) exit(0); /* parent exits */
7799 setsid(); /* create a new session */
7801 /* Every output goes to /dev/null. If Redis is daemonized but
7802 * the 'logfile' is set to 'stdout' in the configuration file
7803 * it will not log at all. */
7804 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
7805 dup2(fd
, STDIN_FILENO
);
7806 dup2(fd
, STDOUT_FILENO
);
7807 dup2(fd
, STDERR_FILENO
);
7808 if (fd
> STDERR_FILENO
) close(fd
);
7810 /* Try to write the pid file */
7811 fp
= fopen(server
.pidfile
,"w");
7813 fprintf(fp
,"%d\n",getpid());
7818 int main(int argc
, char **argv
) {
7821 resetServerSaveParams();
7822 loadServerConfig(argv
[1]);
7823 } else if (argc
> 2) {
7824 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
7827 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'");
7829 if (server
.daemonize
) daemonize();
7831 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
7833 linuxOvercommitMemoryWarning();
7835 if (server
.appendonly
) {
7836 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
7837 redisLog(REDIS_NOTICE
,"DB loaded from append only file");
7839 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
7840 redisLog(REDIS_NOTICE
,"DB loaded from disk");
7842 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
7844 aeDeleteEventLoop(server
.el
);
7848 /* ============================= Backtrace support ========================= */
7850 #ifdef HAVE_BACKTRACE
7851 static char *findFuncName(void *pointer
, unsigned long *offset
);
7853 static void *getMcontextEip(ucontext_t
*uc
) {
7854 #if defined(__FreeBSD__)
7855 return (void*) uc
->uc_mcontext
.mc_eip
;
7856 #elif defined(__dietlibc__)
7857 return (void*) uc
->uc_mcontext
.eip
;
7858 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
7860 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
7862 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
7864 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
7865 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
7866 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
7868 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
7870 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
7871 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
7872 #elif defined(__ia64__) /* Linux IA64 */
7873 return (void*) uc
->uc_mcontext
.sc_ip
;
7879 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
7881 char **messages
= NULL
;
7882 int i
, trace_size
= 0;
7883 unsigned long offset
=0;
7884 ucontext_t
*uc
= (ucontext_t
*) secret
;
7886 REDIS_NOTUSED(info
);
7888 redisLog(REDIS_WARNING
,
7889 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
7890 infostring
= genRedisInfoString();
7891 redisLog(REDIS_WARNING
, "%s",infostring
);
7892 /* It's not safe to sdsfree() the returned string under memory
7893 * corruption conditions. Let it leak as we are going to abort */
7895 trace_size
= backtrace(trace
, 100);
7896 /* overwrite sigaction with caller's address */
7897 if (getMcontextEip(uc
) != NULL
) {
7898 trace
[1] = getMcontextEip(uc
);
7900 messages
= backtrace_symbols(trace
, trace_size
);
7902 for (i
=1; i
<trace_size
; ++i
) {
7903 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
7905 p
= strchr(messages
[i
],'+');
7906 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
7907 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
7909 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
7912 /* free(messages); Don't call free() with possibly corrupted memory. */
7916 static void setupSigSegvAction(void) {
7917 struct sigaction act
;
7919 sigemptyset (&act
.sa_mask
);
7920 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
7921 * is used. Otherwise, sa_handler is used */
7922 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
7923 act
.sa_sigaction
= segvHandler
;
7924 sigaction (SIGSEGV
, &act
, NULL
);
7925 sigaction (SIGBUS
, &act
, NULL
);
7926 sigaction (SIGFPE
, &act
, NULL
);
7927 sigaction (SIGILL
, &act
, NULL
);
7928 sigaction (SIGBUS
, &act
, NULL
);
7932 #include "staticsymbols.h"
7933 /* This function try to convert a pointer into a function name. It's used in
7934 * oreder to provide a backtrace under segmentation fault that's able to
7935 * display functions declared as static (otherwise the backtrace is useless). */
7936 static char *findFuncName(void *pointer
, unsigned long *offset
){
7938 unsigned long off
, minoff
= 0;
7940 /* Try to match against the Symbol with the smallest offset */
7941 for (i
=0; symsTable
[i
].pointer
; i
++) {
7942 unsigned long lp
= (unsigned long) pointer
;
7944 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
7945 off
=lp
-symsTable
[i
].pointer
;
7946 if (ret
< 0 || off
< minoff
) {
7952 if (ret
== -1) return NULL
;
7954 return symsTable
[ret
].name
;
7956 #else /* HAVE_BACKTRACE */
7957 static void setupSigSegvAction(void) {
7959 #endif /* HAVE_BACKTRACE */