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.3"
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 #define REDIS_THREAD_STACK_SIZE (1024*1024*4)
168 /* The following is the *percentage* of completed I/O jobs to process when the
169 * handelr is called. While Virtual Memory I/O operations are performed by
170 * threads, this operations must be processed by the main thread when completed
171 * in order to take effect. */
172 #define REDIS_MAX_COMPLETED_JOBS_PROCESSED 1
175 #define REDIS_SLAVE 1 /* This client is a slave server */
176 #define REDIS_MASTER 2 /* This client is a master server */
177 #define REDIS_MONITOR 4 /* This client is a slave monitor, see MONITOR */
178 #define REDIS_MULTI 8 /* This client is in a MULTI context */
179 #define REDIS_BLOCKED 16 /* The client is waiting in a blocking operation */
180 #define REDIS_IO_WAIT 32 /* The client is waiting for Virtual Memory I/O */
182 /* Slave replication state - slave side */
183 #define REDIS_REPL_NONE 0 /* No active replication */
184 #define REDIS_REPL_CONNECT 1 /* Must connect to master */
185 #define REDIS_REPL_CONNECTED 2 /* Connected to master */
187 /* Slave replication state - from the point of view of master
188 * Note that in SEND_BULK and ONLINE state the slave receives new updates
189 * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
190 * to start the next background saving in order to send updates to it. */
191 #define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
192 #define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
193 #define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
194 #define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */
196 /* List related stuff */
200 /* Sort operations */
201 #define REDIS_SORT_GET 0
202 #define REDIS_SORT_ASC 1
203 #define REDIS_SORT_DESC 2
204 #define REDIS_SORTKEY_MAX 1024
207 #define REDIS_DEBUG 0
208 #define REDIS_VERBOSE 1
209 #define REDIS_NOTICE 2
210 #define REDIS_WARNING 3
212 /* Anti-warning macro... */
213 #define REDIS_NOTUSED(V) ((void) V)
215 #define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
216 #define ZSKIPLIST_P 0.25 /* Skiplist P = 1/4 */
218 /* Append only defines */
219 #define APPENDFSYNC_NO 0
220 #define APPENDFSYNC_ALWAYS 1
221 #define APPENDFSYNC_EVERYSEC 2
223 /* We can print the stacktrace, so our assert is defined this way: */
224 #define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1)))
225 static void _redisAssert(char *estr
, char *file
, int line
);
227 /*================================= Data types ============================== */
229 /* A redis object, that is a type able to hold a string / list / set */
231 /* The VM object structure */
232 struct redisObjectVM
{
233 off_t page
; /* the page at witch the object is stored on disk */
234 off_t usedpages
; /* number of pages used on disk */
235 time_t atime
; /* Last access time */
238 /* The actual Redis Object */
239 typedef struct redisObject
{
242 unsigned char encoding
;
243 unsigned char storage
; /* If this object is a key, where is the value?
244 * REDIS_VM_MEMORY, REDIS_VM_SWAPPED, ... */
245 unsigned char vtype
; /* If this object is a key, and value is swapped out,
246 * this is the type of the swapped out object. */
248 /* VM fields, this are only allocated if VM is active, otherwise the
249 * object allocation function will just allocate
250 * sizeof(redisObjct) minus sizeof(redisObjectVM), so using
251 * Redis without VM active will not have any overhead. */
252 struct redisObjectVM vm
;
255 /* Macro used to initalize a Redis object allocated on the stack.
256 * Note that this macro is taken near the structure definition to make sure
257 * we'll update it when the structure is changed, to avoid bugs like
258 * bug #85 introduced exactly in this way. */
259 #define initStaticStringObject(_var,_ptr) do { \
261 _var.type = REDIS_STRING; \
262 _var.encoding = REDIS_ENCODING_RAW; \
264 if (server.vm_enabled) _var.storage = REDIS_VM_MEMORY; \
267 typedef struct redisDb
{
268 dict
*dict
; /* The keyspace for this DB */
269 dict
*expires
; /* Timeout of keys with a timeout set */
270 dict
*blockingkeys
; /* Keys with clients waiting for data (BLPOP) */
271 dict
*io_keys
; /* Keys with clients waiting for VM I/O */
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_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
302 int slaveseldb
; /* slave selected db, if this client is a slave */
303 int authenticated
; /* when requirepass is non-NULL */
304 int replstate
; /* replication state if this is a slave */
305 int repldbfd
; /* replication DB file descriptor */
306 long repldboff
; /* replication DB file offset */
307 off_t repldbsize
; /* replication DB file size */
308 multiState mstate
; /* MULTI/EXEC state */
309 robj
**blockingkeys
; /* The key we are waiting to terminate a blocking
310 * operation such as BLPOP. Otherwise NULL. */
311 int blockingkeysnum
; /* Number of blocking keys */
312 time_t blockingto
; /* Blocking operation timeout. If UNIX current time
313 * is >= blockingto then the operation timed out. */
314 list
*io_keys
; /* Keys this client is waiting to be loaded from the
315 * swap file in order to continue. */
323 /* Global server state structure */
328 dict
*sharingpool
; /* Poll used for object sharing */
329 unsigned int sharingpoolsize
;
330 long long dirty
; /* changes to DB from the last save */
332 list
*slaves
, *monitors
;
333 char neterr
[ANET_ERR_LEN
];
335 int cronloops
; /* number of times the cron function run */
336 list
*objfreelist
; /* A list of freed objects to avoid malloc() */
337 time_t lastsave
; /* Unix time of last save succeeede */
338 /* Fields used only for stats */
339 time_t stat_starttime
; /* server start time */
340 long long stat_numcommands
; /* number of processed commands */
341 long long stat_numconnections
; /* number of connections received */
354 pid_t bgsavechildpid
;
355 pid_t bgrewritechildpid
;
356 sds bgrewritebuf
; /* buffer taken by parent during oppend only rewrite */
357 struct saveparam
*saveparams
;
362 char *appendfilename
;
366 /* Replication related */
371 redisClient
*master
; /* client that is master for this slave */
373 unsigned int maxclients
;
374 unsigned long long maxmemory
;
375 unsigned int blpop_blocked_clients
;
376 unsigned int vm_blocked_clients
;
377 /* Sort parameters - qsort_r() is only available under BSD so we
378 * have to take this state global, in order to pass it to sortCompare() */
382 /* 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_ready_clients
; /* Clients ready to be unblocked. All keys loaded */
403 pthread_mutex_t io_mutex
; /* lock to access io_jobs/io_done/io_thread_job */
404 pthread_mutex_t obj_freelist_mutex
; /* safe redis objects creation/free */
405 pthread_mutex_t io_swapfile_mutex
; /* So we can lseek + write */
406 pthread_attr_t io_threads_attr
; /* attributes for threads creation */
407 int io_active_threads
; /* Number of running I/O threads */
408 int vm_max_threads
; /* Max number of I/O threads running at the same time */
409 /* Our main thread is blocked on the event loop, locking for sockets ready
410 * to be read or written, so when a threaded I/O operation is ready to be
411 * processed by the main thread, the I/O thread will use a unix pipe to
412 * awake the main thread. The followings are the two pipe FDs. */
413 int io_ready_pipe_read
;
414 int io_ready_pipe_write
;
415 /* Virtual memory stats */
416 unsigned long long vm_stats_used_pages
;
417 unsigned long long vm_stats_swapped_objects
;
418 unsigned long long vm_stats_swapouts
;
419 unsigned long long vm_stats_swapins
;
423 typedef void redisCommandProc(redisClient
*c
);
424 struct redisCommand
{
426 redisCommandProc
*proc
;
431 struct redisFunctionSym
{
433 unsigned long pointer
;
436 typedef struct _redisSortObject
{
444 typedef struct _redisSortOperation
{
447 } redisSortOperation
;
449 /* ZSETs use a specialized version of Skiplists */
451 typedef struct zskiplistNode
{
452 struct zskiplistNode
**forward
;
453 struct zskiplistNode
*backward
;
458 typedef struct zskiplist
{
459 struct zskiplistNode
*header
, *tail
;
460 unsigned long length
;
464 typedef struct zset
{
469 /* Our shared "common" objects */
471 struct sharedObjectsStruct
{
472 robj
*crlf
, *ok
, *err
, *emptybulk
, *czero
, *cone
, *pong
, *space
,
473 *colon
, *nullbulk
, *nullmultibulk
, *queued
,
474 *emptymultibulk
, *wrongtypeerr
, *nokeyerr
, *syntaxerr
, *sameobjecterr
,
475 *outofrangeerr
, *plus
,
476 *select0
, *select1
, *select2
, *select3
, *select4
,
477 *select5
, *select6
, *select7
, *select8
, *select9
;
480 /* Global vars that are actally used as constants. The following double
481 * values are used for double on-disk serialization, and are initialized
482 * at runtime to avoid strange compiler optimizations. */
484 static double R_Zero
, R_PosInf
, R_NegInf
, R_Nan
;
486 /* VM threaded I/O request message */
487 #define REDIS_IOJOB_LOAD 0 /* Load from disk to memory */
488 #define REDIS_IOJOB_PREPARE_SWAP 1 /* Compute needed pages */
489 #define REDIS_IOJOB_DO_SWAP 2 /* Swap from memory to disk */
490 typedef struct iojob
{
491 int type
; /* Request type, REDIS_IOJOB_* */
492 redisDb
*db
;/* Redis database */
493 robj
*key
; /* This I/O request is about swapping this key */
494 robj
*val
; /* the value to swap for REDIS_IOREQ_*_SWAP, otherwise this
495 * field is populated by the I/O thread for REDIS_IOREQ_LOAD. */
496 off_t page
; /* Swap page where to read/write the object */
497 off_t pages
; /* Swap pages needed to safe object. PREPARE_SWAP return val */
498 int canceled
; /* True if this command was canceled by blocking side of VM */
499 pthread_t thread
; /* ID of the thread processing this entry */
502 /*================================ Prototypes =============================== */
504 static void freeStringObject(robj
*o
);
505 static void freeListObject(robj
*o
);
506 static void freeSetObject(robj
*o
);
507 static void decrRefCount(void *o
);
508 static robj
*createObject(int type
, void *ptr
);
509 static void freeClient(redisClient
*c
);
510 static int rdbLoad(char *filename
);
511 static void addReply(redisClient
*c
, robj
*obj
);
512 static void addReplySds(redisClient
*c
, sds s
);
513 static void incrRefCount(robj
*o
);
514 static int rdbSaveBackground(char *filename
);
515 static robj
*createStringObject(char *ptr
, size_t len
);
516 static robj
*dupStringObject(robj
*o
);
517 static void replicationFeedSlaves(list
*slaves
, struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
518 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
519 static int syncWithMaster(void);
520 static robj
*tryObjectSharing(robj
*o
);
521 static int tryObjectEncoding(robj
*o
);
522 static robj
*getDecodedObject(robj
*o
);
523 static int removeExpire(redisDb
*db
, robj
*key
);
524 static int expireIfNeeded(redisDb
*db
, robj
*key
);
525 static int deleteIfVolatile(redisDb
*db
, robj
*key
);
526 static int deleteIfSwapped(redisDb
*db
, robj
*key
);
527 static int deleteKey(redisDb
*db
, robj
*key
);
528 static time_t getExpire(redisDb
*db
, robj
*key
);
529 static int setExpire(redisDb
*db
, robj
*key
, time_t when
);
530 static void updateSlavesWaitingBgsave(int bgsaveerr
);
531 static void freeMemoryIfNeeded(void);
532 static int processCommand(redisClient
*c
);
533 static void setupSigSegvAction(void);
534 static void rdbRemoveTempFile(pid_t childpid
);
535 static void aofRemoveTempFile(pid_t childpid
);
536 static size_t stringObjectLen(robj
*o
);
537 static void processInputBuffer(redisClient
*c
);
538 static zskiplist
*zslCreate(void);
539 static void zslFree(zskiplist
*zsl
);
540 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
);
541 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
542 static void initClientMultiState(redisClient
*c
);
543 static void freeClientMultiState(redisClient
*c
);
544 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
);
545 static void unblockClientWaitingData(redisClient
*c
);
546 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
);
547 static void vmInit(void);
548 static void vmMarkPagesFree(off_t page
, off_t count
);
549 static robj
*vmLoadObject(robj
*key
);
550 static robj
*vmPreviewObject(robj
*key
);
551 static int vmSwapOneObjectBlocking(void);
552 static int vmSwapOneObjectThreaded(void);
553 static int vmCanSwapOut(void);
554 static int tryFreeOneObjectFromFreelist(void);
555 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
556 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
557 static void vmCancelThreadedIOJob(robj
*o
);
558 static void lockThreadedIO(void);
559 static void unlockThreadedIO(void);
560 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
);
561 static void freeIOJob(iojob
*j
);
562 static void queueIOJob(iojob
*j
);
563 static int vmWriteObjectOnSwap(robj
*o
, off_t page
);
564 static robj
*vmReadObjectFromSwap(off_t page
, int type
);
565 static void waitEmptyIOJobsQueue(void);
566 static void vmReopenSwapFile(void);
567 static int vmFreePage(off_t page
);
568 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
);
569 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
);
570 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
);
571 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
572 static struct redisCommand
*lookupCommand(char *name
);
573 static void call(redisClient
*c
, struct redisCommand
*cmd
);
574 static void resetClient(redisClient
*c
);
576 static void authCommand(redisClient
*c
);
577 static void pingCommand(redisClient
*c
);
578 static void echoCommand(redisClient
*c
);
579 static void setCommand(redisClient
*c
);
580 static void setnxCommand(redisClient
*c
);
581 static void getCommand(redisClient
*c
);
582 static void delCommand(redisClient
*c
);
583 static void existsCommand(redisClient
*c
);
584 static void incrCommand(redisClient
*c
);
585 static void decrCommand(redisClient
*c
);
586 static void incrbyCommand(redisClient
*c
);
587 static void decrbyCommand(redisClient
*c
);
588 static void selectCommand(redisClient
*c
);
589 static void randomkeyCommand(redisClient
*c
);
590 static void keysCommand(redisClient
*c
);
591 static void dbsizeCommand(redisClient
*c
);
592 static void lastsaveCommand(redisClient
*c
);
593 static void saveCommand(redisClient
*c
);
594 static void bgsaveCommand(redisClient
*c
);
595 static void bgrewriteaofCommand(redisClient
*c
);
596 static void shutdownCommand(redisClient
*c
);
597 static void moveCommand(redisClient
*c
);
598 static void renameCommand(redisClient
*c
);
599 static void renamenxCommand(redisClient
*c
);
600 static void lpushCommand(redisClient
*c
);
601 static void rpushCommand(redisClient
*c
);
602 static void lpopCommand(redisClient
*c
);
603 static void rpopCommand(redisClient
*c
);
604 static void llenCommand(redisClient
*c
);
605 static void lindexCommand(redisClient
*c
);
606 static void lrangeCommand(redisClient
*c
);
607 static void ltrimCommand(redisClient
*c
);
608 static void typeCommand(redisClient
*c
);
609 static void lsetCommand(redisClient
*c
);
610 static void saddCommand(redisClient
*c
);
611 static void sremCommand(redisClient
*c
);
612 static void smoveCommand(redisClient
*c
);
613 static void sismemberCommand(redisClient
*c
);
614 static void scardCommand(redisClient
*c
);
615 static void spopCommand(redisClient
*c
);
616 static void srandmemberCommand(redisClient
*c
);
617 static void sinterCommand(redisClient
*c
);
618 static void sinterstoreCommand(redisClient
*c
);
619 static void sunionCommand(redisClient
*c
);
620 static void sunionstoreCommand(redisClient
*c
);
621 static void sdiffCommand(redisClient
*c
);
622 static void sdiffstoreCommand(redisClient
*c
);
623 static void syncCommand(redisClient
*c
);
624 static void flushdbCommand(redisClient
*c
);
625 static void flushallCommand(redisClient
*c
);
626 static void sortCommand(redisClient
*c
);
627 static void lremCommand(redisClient
*c
);
628 static void rpoplpushcommand(redisClient
*c
);
629 static void infoCommand(redisClient
*c
);
630 static void mgetCommand(redisClient
*c
);
631 static void monitorCommand(redisClient
*c
);
632 static void expireCommand(redisClient
*c
);
633 static void expireatCommand(redisClient
*c
);
634 static void getsetCommand(redisClient
*c
);
635 static void ttlCommand(redisClient
*c
);
636 static void slaveofCommand(redisClient
*c
);
637 static void debugCommand(redisClient
*c
);
638 static void msetCommand(redisClient
*c
);
639 static void msetnxCommand(redisClient
*c
);
640 static void zaddCommand(redisClient
*c
);
641 static void zincrbyCommand(redisClient
*c
);
642 static void zrangeCommand(redisClient
*c
);
643 static void zrangebyscoreCommand(redisClient
*c
);
644 static void zcountCommand(redisClient
*c
);
645 static void zrevrangeCommand(redisClient
*c
);
646 static void zcardCommand(redisClient
*c
);
647 static void zremCommand(redisClient
*c
);
648 static void zscoreCommand(redisClient
*c
);
649 static void zremrangebyscoreCommand(redisClient
*c
);
650 static void multiCommand(redisClient
*c
);
651 static void execCommand(redisClient
*c
);
652 static void blpopCommand(redisClient
*c
);
653 static void brpopCommand(redisClient
*c
);
654 static void appendCommand(redisClient
*c
);
656 /*================================= Globals ================================= */
659 static struct redisServer server
; /* server global state */
660 static struct redisCommand cmdTable
[] = {
661 {"get",getCommand
,2,REDIS_CMD_INLINE
},
662 {"set",setCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
663 {"setnx",setnxCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
664 {"append",appendCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
665 {"del",delCommand
,-2,REDIS_CMD_INLINE
},
666 {"exists",existsCommand
,2,REDIS_CMD_INLINE
},
667 {"incr",incrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
668 {"decr",decrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
669 {"mget",mgetCommand
,-2,REDIS_CMD_INLINE
},
670 {"rpush",rpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
671 {"lpush",lpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
672 {"rpop",rpopCommand
,2,REDIS_CMD_INLINE
},
673 {"lpop",lpopCommand
,2,REDIS_CMD_INLINE
},
674 {"brpop",brpopCommand
,-3,REDIS_CMD_INLINE
},
675 {"blpop",blpopCommand
,-3,REDIS_CMD_INLINE
},
676 {"llen",llenCommand
,2,REDIS_CMD_INLINE
},
677 {"lindex",lindexCommand
,3,REDIS_CMD_INLINE
},
678 {"lset",lsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
679 {"lrange",lrangeCommand
,4,REDIS_CMD_INLINE
},
680 {"ltrim",ltrimCommand
,4,REDIS_CMD_INLINE
},
681 {"lrem",lremCommand
,4,REDIS_CMD_BULK
},
682 {"rpoplpush",rpoplpushcommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
683 {"sadd",saddCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
684 {"srem",sremCommand
,3,REDIS_CMD_BULK
},
685 {"smove",smoveCommand
,4,REDIS_CMD_BULK
},
686 {"sismember",sismemberCommand
,3,REDIS_CMD_BULK
},
687 {"scard",scardCommand
,2,REDIS_CMD_INLINE
},
688 {"spop",spopCommand
,2,REDIS_CMD_INLINE
},
689 {"srandmember",srandmemberCommand
,2,REDIS_CMD_INLINE
},
690 {"sinter",sinterCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
691 {"sinterstore",sinterstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
692 {"sunion",sunionCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
693 {"sunionstore",sunionstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
694 {"sdiff",sdiffCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
695 {"sdiffstore",sdiffstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
696 {"smembers",sinterCommand
,2,REDIS_CMD_INLINE
},
697 {"zadd",zaddCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
698 {"zincrby",zincrbyCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
699 {"zrem",zremCommand
,3,REDIS_CMD_BULK
},
700 {"zremrangebyscore",zremrangebyscoreCommand
,4,REDIS_CMD_INLINE
},
701 {"zrange",zrangeCommand
,-4,REDIS_CMD_INLINE
},
702 {"zrangebyscore",zrangebyscoreCommand
,-4,REDIS_CMD_INLINE
},
703 {"zcount",zcountCommand
,4,REDIS_CMD_INLINE
},
704 {"zrevrange",zrevrangeCommand
,-4,REDIS_CMD_INLINE
},
705 {"zcard",zcardCommand
,2,REDIS_CMD_INLINE
},
706 {"zscore",zscoreCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
707 {"incrby",incrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
708 {"decrby",decrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
709 {"getset",getsetCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
710 {"mset",msetCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
711 {"msetnx",msetnxCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
},
712 {"randomkey",randomkeyCommand
,1,REDIS_CMD_INLINE
},
713 {"select",selectCommand
,2,REDIS_CMD_INLINE
},
714 {"move",moveCommand
,3,REDIS_CMD_INLINE
},
715 {"rename",renameCommand
,3,REDIS_CMD_INLINE
},
716 {"renamenx",renamenxCommand
,3,REDIS_CMD_INLINE
},
717 {"expire",expireCommand
,3,REDIS_CMD_INLINE
},
718 {"expireat",expireatCommand
,3,REDIS_CMD_INLINE
},
719 {"keys",keysCommand
,2,REDIS_CMD_INLINE
},
720 {"dbsize",dbsizeCommand
,1,REDIS_CMD_INLINE
},
721 {"auth",authCommand
,2,REDIS_CMD_INLINE
},
722 {"ping",pingCommand
,1,REDIS_CMD_INLINE
},
723 {"echo",echoCommand
,2,REDIS_CMD_BULK
},
724 {"save",saveCommand
,1,REDIS_CMD_INLINE
},
725 {"bgsave",bgsaveCommand
,1,REDIS_CMD_INLINE
},
726 {"bgrewriteaof",bgrewriteaofCommand
,1,REDIS_CMD_INLINE
},
727 {"shutdown",shutdownCommand
,1,REDIS_CMD_INLINE
},
728 {"lastsave",lastsaveCommand
,1,REDIS_CMD_INLINE
},
729 {"type",typeCommand
,2,REDIS_CMD_INLINE
},
730 {"multi",multiCommand
,1,REDIS_CMD_INLINE
},
731 {"exec",execCommand
,1,REDIS_CMD_INLINE
},
732 {"sync",syncCommand
,1,REDIS_CMD_INLINE
},
733 {"flushdb",flushdbCommand
,1,REDIS_CMD_INLINE
},
734 {"flushall",flushallCommand
,1,REDIS_CMD_INLINE
},
735 {"sort",sortCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
},
736 {"info",infoCommand
,1,REDIS_CMD_INLINE
},
737 {"monitor",monitorCommand
,1,REDIS_CMD_INLINE
},
738 {"ttl",ttlCommand
,2,REDIS_CMD_INLINE
},
739 {"slaveof",slaveofCommand
,3,REDIS_CMD_INLINE
},
740 {"debug",debugCommand
,-2,REDIS_CMD_INLINE
},
744 /*============================ Utility functions ============================ */
746 /* Glob-style pattern matching. */
747 int stringmatchlen(const char *pattern
, int patternLen
,
748 const char *string
, int stringLen
, int nocase
)
753 while (pattern
[1] == '*') {
758 return 1; /* match */
760 if (stringmatchlen(pattern
+1, patternLen
-1,
761 string
, stringLen
, nocase
))
762 return 1; /* match */
766 return 0; /* no match */
770 return 0; /* no match */
780 not = pattern
[0] == '^';
787 if (pattern
[0] == '\\') {
790 if (pattern
[0] == string
[0])
792 } else if (pattern
[0] == ']') {
794 } else if (patternLen
== 0) {
798 } else if (pattern
[1] == '-' && patternLen
>= 3) {
799 int start
= pattern
[0];
800 int end
= pattern
[2];
808 start
= tolower(start
);
814 if (c
>= start
&& c
<= end
)
818 if (pattern
[0] == string
[0])
821 if (tolower((int)pattern
[0]) == tolower((int)string
[0]))
831 return 0; /* no match */
837 if (patternLen
>= 2) {
844 if (pattern
[0] != string
[0])
845 return 0; /* no match */
847 if (tolower((int)pattern
[0]) != tolower((int)string
[0]))
848 return 0; /* no match */
856 if (stringLen
== 0) {
857 while(*pattern
== '*') {
864 if (patternLen
== 0 && stringLen
== 0)
869 static void redisLog(int level
, const char *fmt
, ...) {
873 fp
= (server
.logfile
== NULL
) ? stdout
: fopen(server
.logfile
,"a");
877 if (level
>= server
.verbosity
) {
883 strftime(buf
,64,"%d %b %H:%M:%S",localtime(&now
));
884 fprintf(fp
,"[%d] %s %c ",(int)getpid(),buf
,c
[level
]);
885 vfprintf(fp
, fmt
, ap
);
891 if (server
.logfile
) fclose(fp
);
894 /*====================== Hash table type implementation ==================== */
896 /* This is an hash table type that uses the SDS dynamic strings libary as
897 * keys and radis objects as values (objects can hold SDS strings,
900 static void dictVanillaFree(void *privdata
, void *val
)
902 DICT_NOTUSED(privdata
);
906 static void dictListDestructor(void *privdata
, void *val
)
908 DICT_NOTUSED(privdata
);
909 listRelease((list
*)val
);
912 static int sdsDictKeyCompare(void *privdata
, const void *key1
,
916 DICT_NOTUSED(privdata
);
918 l1
= sdslen((sds
)key1
);
919 l2
= sdslen((sds
)key2
);
920 if (l1
!= l2
) return 0;
921 return memcmp(key1
, key2
, l1
) == 0;
924 static void dictRedisObjectDestructor(void *privdata
, void *val
)
926 DICT_NOTUSED(privdata
);
928 if (val
== NULL
) return; /* Values of swapped out keys as set to NULL */
932 static int dictObjKeyCompare(void *privdata
, const void *key1
,
935 const robj
*o1
= key1
, *o2
= key2
;
936 return sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
939 static unsigned int dictObjHash(const void *key
) {
941 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
944 static int dictEncObjKeyCompare(void *privdata
, const void *key1
,
947 robj
*o1
= (robj
*) key1
, *o2
= (robj
*) key2
;
950 o1
= getDecodedObject(o1
);
951 o2
= getDecodedObject(o2
);
952 cmp
= sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
958 static unsigned int dictEncObjHash(const void *key
) {
959 robj
*o
= (robj
*) key
;
961 if (o
->encoding
== REDIS_ENCODING_RAW
) {
962 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
964 if (o
->encoding
== REDIS_ENCODING_INT
) {
968 len
= snprintf(buf
,32,"%ld",(long)o
->ptr
);
969 return dictGenHashFunction((unsigned char*)buf
, len
);
973 o
= getDecodedObject(o
);
974 hash
= dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
981 /* Sets type and expires */
982 static dictType setDictType
= {
983 dictEncObjHash
, /* hash function */
986 dictEncObjKeyCompare
, /* key compare */
987 dictRedisObjectDestructor
, /* key destructor */
988 NULL
/* val destructor */
991 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
992 static dictType zsetDictType
= {
993 dictEncObjHash
, /* hash function */
996 dictEncObjKeyCompare
, /* key compare */
997 dictRedisObjectDestructor
, /* key destructor */
998 dictVanillaFree
/* val destructor of malloc(sizeof(double)) */
1002 static dictType hashDictType
= {
1003 dictObjHash
, /* hash function */
1006 dictObjKeyCompare
, /* key compare */
1007 dictRedisObjectDestructor
, /* key destructor */
1008 dictRedisObjectDestructor
/* val destructor */
1012 static dictType keyptrDictType
= {
1013 dictObjHash
, /* hash function */
1016 dictObjKeyCompare
, /* key compare */
1017 dictRedisObjectDestructor
, /* key destructor */
1018 NULL
/* val destructor */
1021 /* Keylist hash table type has unencoded redis objects as keys and
1022 * lists as values. It's used for blocking operations (BLPOP) and to
1023 * map swapped keys to a list of clients waiting for this keys to be loaded. */
1024 static dictType keylistDictType
= {
1025 dictObjHash
, /* hash function */
1028 dictObjKeyCompare
, /* key compare */
1029 dictRedisObjectDestructor
, /* key destructor */
1030 dictListDestructor
/* val destructor */
1033 /* ========================= Random utility functions ======================= */
1035 /* Redis generally does not try to recover from out of memory conditions
1036 * when allocating objects or strings, it is not clear if it will be possible
1037 * to report this condition to the client since the networking layer itself
1038 * is based on heap allocation for send buffers, so we simply abort.
1039 * At least the code will be simpler to read... */
1040 static void oom(const char *msg
) {
1041 redisLog(REDIS_WARNING
, "%s: Out of memory\n",msg
);
1046 /* ====================== Redis server networking stuff ===================== */
1047 static void closeTimedoutClients(void) {
1050 time_t now
= time(NULL
);
1053 listRewind(server
.clients
,&li
);
1054 while ((ln
= listNext(&li
)) != NULL
) {
1055 c
= listNodeValue(ln
);
1056 if (server
.maxidletime
&&
1057 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
1058 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
1059 (now
- c
->lastinteraction
> server
.maxidletime
))
1061 redisLog(REDIS_VERBOSE
,"Closing idle client");
1063 } else if (c
->flags
& REDIS_BLOCKED
) {
1064 if (c
->blockingto
!= 0 && c
->blockingto
< now
) {
1065 addReply(c
,shared
.nullmultibulk
);
1066 unblockClientWaitingData(c
);
1072 static int htNeedsResize(dict
*dict
) {
1073 long long size
, used
;
1075 size
= dictSlots(dict
);
1076 used
= dictSize(dict
);
1077 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
1078 (used
*100/size
< REDIS_HT_MINFILL
));
1081 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
1082 * we resize the hash table to save memory */
1083 static void tryResizeHashTables(void) {
1086 for (j
= 0; j
< server
.dbnum
; j
++) {
1087 if (htNeedsResize(server
.db
[j
].dict
)) {
1088 redisLog(REDIS_VERBOSE
,"The hash table %d is too sparse, resize it...",j
);
1089 dictResize(server
.db
[j
].dict
);
1090 redisLog(REDIS_VERBOSE
,"Hash table %d resized.",j
);
1092 if (htNeedsResize(server
.db
[j
].expires
))
1093 dictResize(server
.db
[j
].expires
);
1097 /* A background saving child (BGSAVE) terminated its work. Handle this. */
1098 void backgroundSaveDoneHandler(int statloc
) {
1099 int exitcode
= WEXITSTATUS(statloc
);
1100 int bysignal
= WIFSIGNALED(statloc
);
1102 if (!bysignal
&& exitcode
== 0) {
1103 redisLog(REDIS_NOTICE
,
1104 "Background saving terminated with success");
1106 server
.lastsave
= time(NULL
);
1107 } else if (!bysignal
&& exitcode
!= 0) {
1108 redisLog(REDIS_WARNING
, "Background saving error");
1110 redisLog(REDIS_WARNING
,
1111 "Background saving terminated by signal");
1112 rdbRemoveTempFile(server
.bgsavechildpid
);
1114 server
.bgsavechildpid
= -1;
1115 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1116 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1117 updateSlavesWaitingBgsave(exitcode
== 0 ? REDIS_OK
: REDIS_ERR
);
1120 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1122 void backgroundRewriteDoneHandler(int statloc
) {
1123 int exitcode
= WEXITSTATUS(statloc
);
1124 int bysignal
= WIFSIGNALED(statloc
);
1126 if (!bysignal
&& exitcode
== 0) {
1130 redisLog(REDIS_NOTICE
,
1131 "Background append only file rewriting terminated with success");
1132 /* Now it's time to flush the differences accumulated by the parent */
1133 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) server
.bgrewritechildpid
);
1134 fd
= open(tmpfile
,O_WRONLY
|O_APPEND
);
1136 redisLog(REDIS_WARNING
, "Not able to open the temp append only file produced by the child: %s", strerror(errno
));
1139 /* Flush our data... */
1140 if (write(fd
,server
.bgrewritebuf
,sdslen(server
.bgrewritebuf
)) !=
1141 (signed) sdslen(server
.bgrewritebuf
)) {
1142 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
));
1146 redisLog(REDIS_NOTICE
,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server
.bgrewritebuf
));
1147 /* Now our work is to rename the temp file into the stable file. And
1148 * switch the file descriptor used by the server for append only. */
1149 if (rename(tmpfile
,server
.appendfilename
) == -1) {
1150 redisLog(REDIS_WARNING
,"Can't rename the temp append only file into the stable one: %s", strerror(errno
));
1154 /* Mission completed... almost */
1155 redisLog(REDIS_NOTICE
,"Append only file successfully rewritten.");
1156 if (server
.appendfd
!= -1) {
1157 /* If append only is actually enabled... */
1158 close(server
.appendfd
);
1159 server
.appendfd
= fd
;
1161 server
.appendseldb
= -1; /* Make sure it will issue SELECT */
1162 redisLog(REDIS_NOTICE
,"The new append only file was selected for future appends.");
1164 /* If append only is disabled we just generate a dump in this
1165 * format. Why not? */
1168 } else if (!bysignal
&& exitcode
!= 0) {
1169 redisLog(REDIS_WARNING
, "Background append only file rewriting error");
1171 redisLog(REDIS_WARNING
,
1172 "Background append only file rewriting terminated by signal");
1175 sdsfree(server
.bgrewritebuf
);
1176 server
.bgrewritebuf
= sdsempty();
1177 aofRemoveTempFile(server
.bgrewritechildpid
);
1178 server
.bgrewritechildpid
= -1;
1181 static int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
1182 int j
, loops
= server
.cronloops
++;
1183 REDIS_NOTUSED(eventLoop
);
1185 REDIS_NOTUSED(clientData
);
1187 /* We take a cached value of the unix time in the global state because
1188 * with virtual memory and aging there is to store the current time
1189 * in objects at every object access, and accuracy is not needed.
1190 * To access a global var is faster than calling time(NULL) */
1191 server
.unixtime
= time(NULL
);
1193 /* Show some info about non-empty databases */
1194 for (j
= 0; j
< server
.dbnum
; j
++) {
1195 long long size
, used
, vkeys
;
1197 size
= dictSlots(server
.db
[j
].dict
);
1198 used
= dictSize(server
.db
[j
].dict
);
1199 vkeys
= dictSize(server
.db
[j
].expires
);
1200 if (!(loops
% 5) && (used
|| vkeys
)) {
1201 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
1202 /* dictPrintStats(server.dict); */
1206 /* We don't want to resize the hash tables while a bacground saving
1207 * is in progress: the saving child is created using fork() that is
1208 * implemented with a copy-on-write semantic in most modern systems, so
1209 * if we resize the HT while there is the saving child at work actually
1210 * a lot of memory movements in the parent will cause a lot of pages
1212 if (server
.bgsavechildpid
== -1) tryResizeHashTables();
1214 /* Show information about connected clients */
1216 redisLog(REDIS_VERBOSE
,"%d clients connected (%d slaves), %zu bytes in use, %d shared objects",
1217 listLength(server
.clients
)-listLength(server
.slaves
),
1218 listLength(server
.slaves
),
1219 zmalloc_used_memory(),
1220 dictSize(server
.sharingpool
));
1223 /* Close connections of timedout clients */
1224 if ((server
.maxidletime
&& !(loops
% 10)) || server
.blpop_blocked_clients
)
1225 closeTimedoutClients();
1227 /* Check if a background saving or AOF rewrite in progress terminated */
1228 if (server
.bgsavechildpid
!= -1 || server
.bgrewritechildpid
!= -1) {
1232 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
1233 if (pid
== server
.bgsavechildpid
) {
1234 backgroundSaveDoneHandler(statloc
);
1236 backgroundRewriteDoneHandler(statloc
);
1240 /* If there is not a background saving in progress check if
1241 * we have to save now */
1242 time_t now
= time(NULL
);
1243 for (j
= 0; j
< server
.saveparamslen
; j
++) {
1244 struct saveparam
*sp
= server
.saveparams
+j
;
1246 if (server
.dirty
>= sp
->changes
&&
1247 now
-server
.lastsave
> sp
->seconds
) {
1248 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
1249 sp
->changes
, sp
->seconds
);
1250 rdbSaveBackground(server
.dbfilename
);
1256 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1257 * will use few CPU cycles if there are few expiring keys, otherwise
1258 * it will get more aggressive to avoid that too much memory is used by
1259 * keys that can be removed from the keyspace. */
1260 for (j
= 0; j
< server
.dbnum
; j
++) {
1262 redisDb
*db
= server
.db
+j
;
1264 /* Continue to expire if at the end of the cycle more than 25%
1265 * of the keys were expired. */
1267 long num
= dictSize(db
->expires
);
1268 time_t now
= time(NULL
);
1271 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
1272 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
1277 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
1278 t
= (time_t) dictGetEntryVal(de
);
1280 deleteKey(db
,dictGetEntryKey(de
));
1284 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
1287 /* Swap a few keys on disk if we are over the memory limit and VM
1288 * is enbled. Try to free objects from the free list first. */
1289 if (vmCanSwapOut()) {
1290 while (server
.vm_enabled
&& zmalloc_used_memory() >
1291 server
.vm_max_memory
)
1295 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
1296 retval
= (server
.vm_max_threads
== 0) ?
1297 vmSwapOneObjectBlocking() :
1298 vmSwapOneObjectThreaded();
1299 if (retval
== REDIS_ERR
&& (loops
% 30) == 0 &&
1300 zmalloc_used_memory() >
1301 (server
.vm_max_memory
+server
.vm_max_memory
/10))
1303 redisLog(REDIS_WARNING
,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1305 /* Note that when using threade I/O we free just one object,
1306 * because anyway when the I/O thread in charge to swap this
1307 * object out will finish, the handler of completed jobs
1308 * will try to swap more objects if we are still out of memory. */
1309 if (retval
== REDIS_ERR
|| server
.vm_max_threads
> 0) break;
1313 /* Check if we should connect to a MASTER */
1314 if (server
.replstate
== REDIS_REPL_CONNECT
) {
1315 redisLog(REDIS_NOTICE
,"Connecting to MASTER...");
1316 if (syncWithMaster() == REDIS_OK
) {
1317 redisLog(REDIS_NOTICE
,"MASTER <-> SLAVE sync succeeded");
1323 /* This function gets called every time Redis is entering the
1324 * main loop of the event driven library, that is, before to sleep
1325 * for ready file descriptors. */
1326 static void beforeSleep(struct aeEventLoop
*eventLoop
) {
1327 REDIS_NOTUSED(eventLoop
);
1329 if (server
.vm_enabled
&& listLength(server
.io_ready_clients
)) {
1333 listRewind(server
.io_ready_clients
,&li
);
1334 while((ln
= listNext(&li
))) {
1335 redisClient
*c
= ln
->value
;
1336 struct redisCommand
*cmd
;
1338 /* Resume the client. */
1339 listDelNode(server
.io_ready_clients
,ln
);
1340 c
->flags
&= (~REDIS_IO_WAIT
);
1341 server
.vm_blocked_clients
--;
1342 aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
1343 readQueryFromClient
, c
);
1344 cmd
= lookupCommand(c
->argv
[0]->ptr
);
1345 assert(cmd
!= NULL
);
1348 /* There may be more data to process in the input buffer. */
1349 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0)
1350 processInputBuffer(c
);
1355 static void createSharedObjects(void) {
1356 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1357 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1358 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1359 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1360 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1361 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1362 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1363 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1364 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1365 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1366 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1367 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1368 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1369 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1370 "-ERR no such key\r\n"));
1371 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1372 "-ERR syntax error\r\n"));
1373 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1374 "-ERR source and destination objects are the same\r\n"));
1375 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1376 "-ERR index out of range\r\n"));
1377 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1378 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1379 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1380 shared
.select0
= createStringObject("select 0\r\n",10);
1381 shared
.select1
= createStringObject("select 1\r\n",10);
1382 shared
.select2
= createStringObject("select 2\r\n",10);
1383 shared
.select3
= createStringObject("select 3\r\n",10);
1384 shared
.select4
= createStringObject("select 4\r\n",10);
1385 shared
.select5
= createStringObject("select 5\r\n",10);
1386 shared
.select6
= createStringObject("select 6\r\n",10);
1387 shared
.select7
= createStringObject("select 7\r\n",10);
1388 shared
.select8
= createStringObject("select 8\r\n",10);
1389 shared
.select9
= createStringObject("select 9\r\n",10);
1392 static void appendServerSaveParams(time_t seconds
, int changes
) {
1393 server
.saveparams
= zrealloc(server
.saveparams
,sizeof(struct saveparam
)*(server
.saveparamslen
+1));
1394 server
.saveparams
[server
.saveparamslen
].seconds
= seconds
;
1395 server
.saveparams
[server
.saveparamslen
].changes
= changes
;
1396 server
.saveparamslen
++;
1399 static void resetServerSaveParams() {
1400 zfree(server
.saveparams
);
1401 server
.saveparams
= NULL
;
1402 server
.saveparamslen
= 0;
1405 static void initServerConfig() {
1406 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1407 server
.port
= REDIS_SERVERPORT
;
1408 server
.verbosity
= REDIS_VERBOSE
;
1409 server
.maxidletime
= REDIS_MAXIDLETIME
;
1410 server
.saveparams
= NULL
;
1411 server
.logfile
= NULL
; /* NULL = log on standard output */
1412 server
.bindaddr
= NULL
;
1413 server
.glueoutputbuf
= 1;
1414 server
.daemonize
= 0;
1415 server
.appendonly
= 0;
1416 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1417 server
.lastfsync
= time(NULL
);
1418 server
.appendfd
= -1;
1419 server
.appendseldb
= -1; /* Make sure the first time will not match */
1420 server
.pidfile
= "/var/run/redis.pid";
1421 server
.dbfilename
= "dump.rdb";
1422 server
.appendfilename
= "appendonly.aof";
1423 server
.requirepass
= NULL
;
1424 server
.shareobjects
= 0;
1425 server
.rdbcompression
= 1;
1426 server
.sharingpoolsize
= 1024;
1427 server
.maxclients
= 0;
1428 server
.blpop_blocked_clients
= 0;
1429 server
.maxmemory
= 0;
1430 server
.vm_enabled
= 0;
1431 server
.vm_swap_file
= zstrdup("/tmp/redis-%p.vm");
1432 server
.vm_page_size
= 256; /* 256 bytes per page */
1433 server
.vm_pages
= 1024*1024*100; /* 104 millions of pages */
1434 server
.vm_max_memory
= 1024LL*1024*1024*1; /* 1 GB of RAM */
1435 server
.vm_max_threads
= 4;
1436 server
.vm_blocked_clients
= 0;
1438 resetServerSaveParams();
1440 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1441 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1442 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1443 /* Replication related */
1445 server
.masterauth
= NULL
;
1446 server
.masterhost
= NULL
;
1447 server
.masterport
= 6379;
1448 server
.master
= NULL
;
1449 server
.replstate
= REDIS_REPL_NONE
;
1451 /* Double constants initialization */
1453 R_PosInf
= 1.0/R_Zero
;
1454 R_NegInf
= -1.0/R_Zero
;
1455 R_Nan
= R_Zero
/R_Zero
;
1458 static void initServer() {
1461 signal(SIGHUP
, SIG_IGN
);
1462 signal(SIGPIPE
, SIG_IGN
);
1463 setupSigSegvAction();
1465 server
.devnull
= fopen("/dev/null","w");
1466 if (server
.devnull
== NULL
) {
1467 redisLog(REDIS_WARNING
, "Can't open /dev/null: %s", server
.neterr
);
1470 server
.clients
= listCreate();
1471 server
.slaves
= listCreate();
1472 server
.monitors
= listCreate();
1473 server
.objfreelist
= listCreate();
1474 createSharedObjects();
1475 server
.el
= aeCreateEventLoop();
1476 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1477 server
.sharingpool
= dictCreate(&setDictType
,NULL
);
1478 server
.fd
= anetTcpServer(server
.neterr
, server
.port
, server
.bindaddr
);
1479 if (server
.fd
== -1) {
1480 redisLog(REDIS_WARNING
, "Opening TCP port: %s", server
.neterr
);
1483 for (j
= 0; j
< server
.dbnum
; j
++) {
1484 server
.db
[j
].dict
= dictCreate(&hashDictType
,NULL
);
1485 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1486 server
.db
[j
].blockingkeys
= dictCreate(&keylistDictType
,NULL
);
1487 if (server
.vm_enabled
)
1488 server
.db
[j
].io_keys
= dictCreate(&keylistDictType
,NULL
);
1489 server
.db
[j
].id
= j
;
1491 server
.cronloops
= 0;
1492 server
.bgsavechildpid
= -1;
1493 server
.bgrewritechildpid
= -1;
1494 server
.bgrewritebuf
= sdsempty();
1495 server
.lastsave
= time(NULL
);
1497 server
.stat_numcommands
= 0;
1498 server
.stat_numconnections
= 0;
1499 server
.stat_starttime
= time(NULL
);
1500 server
.unixtime
= time(NULL
);
1501 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1502 if (aeCreateFileEvent(server
.el
, server
.fd
, AE_READABLE
,
1503 acceptHandler
, NULL
) == AE_ERR
) oom("creating file event");
1505 if (server
.appendonly
) {
1506 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1507 if (server
.appendfd
== -1) {
1508 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1514 if (server
.vm_enabled
) vmInit();
1517 /* Empty the whole database */
1518 static long long emptyDb() {
1520 long long removed
= 0;
1522 for (j
= 0; j
< server
.dbnum
; j
++) {
1523 removed
+= dictSize(server
.db
[j
].dict
);
1524 dictEmpty(server
.db
[j
].dict
);
1525 dictEmpty(server
.db
[j
].expires
);
1530 static int yesnotoi(char *s
) {
1531 if (!strcasecmp(s
,"yes")) return 1;
1532 else if (!strcasecmp(s
,"no")) return 0;
1536 /* I agree, this is a very rudimental way to load a configuration...
1537 will improve later if the config gets more complex */
1538 static void loadServerConfig(char *filename
) {
1540 char buf
[REDIS_CONFIGLINE_MAX
+1], *err
= NULL
;
1544 if (filename
[0] == '-' && filename
[1] == '\0')
1547 if ((fp
= fopen(filename
,"r")) == NULL
) {
1548 redisLog(REDIS_WARNING
,"Fatal error, can't open config file");
1553 while(fgets(buf
,REDIS_CONFIGLINE_MAX
+1,fp
) != NULL
) {
1559 line
= sdstrim(line
," \t\r\n");
1561 /* Skip comments and blank lines*/
1562 if (line
[0] == '#' || line
[0] == '\0') {
1567 /* Split into arguments */
1568 argv
= sdssplitlen(line
,sdslen(line
)," ",1,&argc
);
1569 sdstolower(argv
[0]);
1571 /* Execute config directives */
1572 if (!strcasecmp(argv
[0],"timeout") && argc
== 2) {
1573 server
.maxidletime
= atoi(argv
[1]);
1574 if (server
.maxidletime
< 0) {
1575 err
= "Invalid timeout value"; goto loaderr
;
1577 } else if (!strcasecmp(argv
[0],"port") && argc
== 2) {
1578 server
.port
= atoi(argv
[1]);
1579 if (server
.port
< 1 || server
.port
> 65535) {
1580 err
= "Invalid port"; goto loaderr
;
1582 } else if (!strcasecmp(argv
[0],"bind") && argc
== 2) {
1583 server
.bindaddr
= zstrdup(argv
[1]);
1584 } else if (!strcasecmp(argv
[0],"save") && argc
== 3) {
1585 int seconds
= atoi(argv
[1]);
1586 int changes
= atoi(argv
[2]);
1587 if (seconds
< 1 || changes
< 0) {
1588 err
= "Invalid save parameters"; goto loaderr
;
1590 appendServerSaveParams(seconds
,changes
);
1591 } else if (!strcasecmp(argv
[0],"dir") && argc
== 2) {
1592 if (chdir(argv
[1]) == -1) {
1593 redisLog(REDIS_WARNING
,"Can't chdir to '%s': %s",
1594 argv
[1], strerror(errno
));
1597 } else if (!strcasecmp(argv
[0],"loglevel") && argc
== 2) {
1598 if (!strcasecmp(argv
[1],"debug")) server
.verbosity
= REDIS_DEBUG
;
1599 else if (!strcasecmp(argv
[1],"verbose")) server
.verbosity
= REDIS_VERBOSE
;
1600 else if (!strcasecmp(argv
[1],"notice")) server
.verbosity
= REDIS_NOTICE
;
1601 else if (!strcasecmp(argv
[1],"warning")) server
.verbosity
= REDIS_WARNING
;
1603 err
= "Invalid log level. Must be one of debug, notice, warning";
1606 } else if (!strcasecmp(argv
[0],"logfile") && argc
== 2) {
1609 server
.logfile
= zstrdup(argv
[1]);
1610 if (!strcasecmp(server
.logfile
,"stdout")) {
1611 zfree(server
.logfile
);
1612 server
.logfile
= NULL
;
1614 if (server
.logfile
) {
1615 /* Test if we are able to open the file. The server will not
1616 * be able to abort just for this problem later... */
1617 logfp
= fopen(server
.logfile
,"a");
1618 if (logfp
== NULL
) {
1619 err
= sdscatprintf(sdsempty(),
1620 "Can't open the log file: %s", strerror(errno
));
1625 } else if (!strcasecmp(argv
[0],"databases") && argc
== 2) {
1626 server
.dbnum
= atoi(argv
[1]);
1627 if (server
.dbnum
< 1) {
1628 err
= "Invalid number of databases"; goto loaderr
;
1630 } else if (!strcasecmp(argv
[0],"maxclients") && argc
== 2) {
1631 server
.maxclients
= atoi(argv
[1]);
1632 } else if (!strcasecmp(argv
[0],"maxmemory") && argc
== 2) {
1633 server
.maxmemory
= strtoll(argv
[1], NULL
, 10);
1634 } else if (!strcasecmp(argv
[0],"slaveof") && argc
== 3) {
1635 server
.masterhost
= sdsnew(argv
[1]);
1636 server
.masterport
= atoi(argv
[2]);
1637 server
.replstate
= REDIS_REPL_CONNECT
;
1638 } else if (!strcasecmp(argv
[0],"masterauth") && argc
== 2) {
1639 server
.masterauth
= zstrdup(argv
[1]);
1640 } else if (!strcasecmp(argv
[0],"glueoutputbuf") && argc
== 2) {
1641 if ((server
.glueoutputbuf
= yesnotoi(argv
[1])) == -1) {
1642 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1644 } else if (!strcasecmp(argv
[0],"shareobjects") && argc
== 2) {
1645 if ((server
.shareobjects
= yesnotoi(argv
[1])) == -1) {
1646 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1648 } else if (!strcasecmp(argv
[0],"rdbcompression") && argc
== 2) {
1649 if ((server
.rdbcompression
= yesnotoi(argv
[1])) == -1) {
1650 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1652 } else if (!strcasecmp(argv
[0],"shareobjectspoolsize") && argc
== 2) {
1653 server
.sharingpoolsize
= atoi(argv
[1]);
1654 if (server
.sharingpoolsize
< 1) {
1655 err
= "invalid object sharing pool size"; goto loaderr
;
1657 } else if (!strcasecmp(argv
[0],"daemonize") && argc
== 2) {
1658 if ((server
.daemonize
= yesnotoi(argv
[1])) == -1) {
1659 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1661 } else if (!strcasecmp(argv
[0],"appendonly") && argc
== 2) {
1662 if ((server
.appendonly
= yesnotoi(argv
[1])) == -1) {
1663 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1665 } else if (!strcasecmp(argv
[0],"appendfsync") && argc
== 2) {
1666 if (!strcasecmp(argv
[1],"no")) {
1667 server
.appendfsync
= APPENDFSYNC_NO
;
1668 } else if (!strcasecmp(argv
[1],"always")) {
1669 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1670 } else if (!strcasecmp(argv
[1],"everysec")) {
1671 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1673 err
= "argument must be 'no', 'always' or 'everysec'";
1676 } else if (!strcasecmp(argv
[0],"requirepass") && argc
== 2) {
1677 server
.requirepass
= zstrdup(argv
[1]);
1678 } else if (!strcasecmp(argv
[0],"pidfile") && argc
== 2) {
1679 server
.pidfile
= zstrdup(argv
[1]);
1680 } else if (!strcasecmp(argv
[0],"dbfilename") && argc
== 2) {
1681 server
.dbfilename
= zstrdup(argv
[1]);
1682 } else if (!strcasecmp(argv
[0],"vm-enabled") && argc
== 2) {
1683 if ((server
.vm_enabled
= yesnotoi(argv
[1])) == -1) {
1684 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1686 } else if (!strcasecmp(argv
[0],"vm-swap-file") && argc
== 2) {
1687 zfree(server
.vm_swap_file
);
1688 server
.vm_swap_file
= zstrdup(argv
[1]);
1689 } else if (!strcasecmp(argv
[0],"vm-max-memory") && argc
== 2) {
1690 server
.vm_max_memory
= strtoll(argv
[1], NULL
, 10);
1691 } else if (!strcasecmp(argv
[0],"vm-page-size") && argc
== 2) {
1692 server
.vm_page_size
= strtoll(argv
[1], NULL
, 10);
1693 } else if (!strcasecmp(argv
[0],"vm-pages") && argc
== 2) {
1694 server
.vm_pages
= strtoll(argv
[1], NULL
, 10);
1695 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1696 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1698 err
= "Bad directive or wrong number of arguments"; goto loaderr
;
1700 for (j
= 0; j
< argc
; j
++)
1705 if (fp
!= stdin
) fclose(fp
);
1709 fprintf(stderr
, "\n*** FATAL CONFIG FILE ERROR ***\n");
1710 fprintf(stderr
, "Reading the configuration file, at line %d\n", linenum
);
1711 fprintf(stderr
, ">>> '%s'\n", line
);
1712 fprintf(stderr
, "%s\n", err
);
1716 static void freeClientArgv(redisClient
*c
) {
1719 for (j
= 0; j
< c
->argc
; j
++)
1720 decrRefCount(c
->argv
[j
]);
1721 for (j
= 0; j
< c
->mbargc
; j
++)
1722 decrRefCount(c
->mbargv
[j
]);
1727 static void freeClient(redisClient
*c
) {
1730 /* Note that if the client we are freeing is blocked into a blocking
1731 * call, we have to set querybuf to NULL *before* to call
1732 * unblockClientWaitingData() to avoid processInputBuffer() will get
1733 * called. Also it is important to remove the file events after
1734 * this, because this call adds the READABLE event. */
1735 sdsfree(c
->querybuf
);
1737 if (c
->flags
& REDIS_BLOCKED
)
1738 unblockClientWaitingData(c
);
1740 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
1741 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1742 listRelease(c
->reply
);
1745 /* Remove from the list of clients */
1746 ln
= listSearchKey(server
.clients
,c
);
1747 redisAssert(ln
!= NULL
);
1748 listDelNode(server
.clients
,ln
);
1749 /* Remove from the list of clients waiting for swapped keys */
1750 if (c
->flags
& REDIS_IO_WAIT
&& listLength(c
->io_keys
) == 0) {
1751 ln
= listSearchKey(server
.io_ready_clients
,c
);
1753 listDelNode(server
.io_ready_clients
,ln
);
1754 server
.vm_blocked_clients
--;
1757 while (server
.vm_enabled
&& listLength(c
->io_keys
)) {
1758 ln
= listFirst(c
->io_keys
);
1759 dontWaitForSwappedKey(c
,ln
->value
);
1761 listRelease(c
->io_keys
);
1763 if (c
->flags
& REDIS_SLAVE
) {
1764 if (c
->replstate
== REDIS_REPL_SEND_BULK
&& c
->repldbfd
!= -1)
1766 list
*l
= (c
->flags
& REDIS_MONITOR
) ? server
.monitors
: server
.slaves
;
1767 ln
= listSearchKey(l
,c
);
1768 redisAssert(ln
!= NULL
);
1771 if (c
->flags
& REDIS_MASTER
) {
1772 server
.master
= NULL
;
1773 server
.replstate
= REDIS_REPL_CONNECT
;
1777 freeClientMultiState(c
);
1781 #define GLUEREPLY_UP_TO (1024)
1782 static void glueReplyBuffersIfNeeded(redisClient
*c
) {
1784 char buf
[GLUEREPLY_UP_TO
];
1789 listRewind(c
->reply
,&li
);
1790 while((ln
= listNext(&li
))) {
1794 objlen
= sdslen(o
->ptr
);
1795 if (copylen
+ objlen
<= GLUEREPLY_UP_TO
) {
1796 memcpy(buf
+copylen
,o
->ptr
,objlen
);
1798 listDelNode(c
->reply
,ln
);
1800 if (copylen
== 0) return;
1804 /* Now the output buffer is empty, add the new single element */
1805 o
= createObject(REDIS_STRING
,sdsnewlen(buf
,copylen
));
1806 listAddNodeHead(c
->reply
,o
);
1809 static void sendReplyToClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
1810 redisClient
*c
= privdata
;
1811 int nwritten
= 0, totwritten
= 0, objlen
;
1814 REDIS_NOTUSED(mask
);
1816 /* Use writev() if we have enough buffers to send */
1817 if (!server
.glueoutputbuf
&&
1818 listLength(c
->reply
) > REDIS_WRITEV_THRESHOLD
&&
1819 !(c
->flags
& REDIS_MASTER
))
1821 sendReplyToClientWritev(el
, fd
, privdata
, mask
);
1825 while(listLength(c
->reply
)) {
1826 if (server
.glueoutputbuf
&& listLength(c
->reply
) > 1)
1827 glueReplyBuffersIfNeeded(c
);
1829 o
= listNodeValue(listFirst(c
->reply
));
1830 objlen
= sdslen(o
->ptr
);
1833 listDelNode(c
->reply
,listFirst(c
->reply
));
1837 if (c
->flags
& REDIS_MASTER
) {
1838 /* Don't reply to a master */
1839 nwritten
= objlen
- c
->sentlen
;
1841 nwritten
= write(fd
, ((char*)o
->ptr
)+c
->sentlen
, objlen
- c
->sentlen
);
1842 if (nwritten
<= 0) break;
1844 c
->sentlen
+= nwritten
;
1845 totwritten
+= nwritten
;
1846 /* If we fully sent the object on head go to the next one */
1847 if (c
->sentlen
== objlen
) {
1848 listDelNode(c
->reply
,listFirst(c
->reply
));
1851 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
1852 * bytes, in a single threaded server it's a good idea to serve
1853 * other clients as well, even if a very large request comes from
1854 * super fast link that is always able to accept data (in real world
1855 * scenario think about 'KEYS *' against the loopback interfae) */
1856 if (totwritten
> REDIS_MAX_WRITE_PER_EVENT
) break;
1858 if (nwritten
== -1) {
1859 if (errno
== EAGAIN
) {
1862 redisLog(REDIS_VERBOSE
,
1863 "Error writing to client: %s", strerror(errno
));
1868 if (totwritten
> 0) c
->lastinteraction
= time(NULL
);
1869 if (listLength(c
->reply
) == 0) {
1871 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1875 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
)
1877 redisClient
*c
= privdata
;
1878 int nwritten
= 0, totwritten
= 0, objlen
, willwrite
;
1880 struct iovec iov
[REDIS_WRITEV_IOVEC_COUNT
];
1881 int offset
, ion
= 0;
1883 REDIS_NOTUSED(mask
);
1886 while (listLength(c
->reply
)) {
1887 offset
= c
->sentlen
;
1891 /* fill-in the iov[] array */
1892 for(node
= listFirst(c
->reply
); node
; node
= listNextNode(node
)) {
1893 o
= listNodeValue(node
);
1894 objlen
= sdslen(o
->ptr
);
1896 if (totwritten
+ objlen
- offset
> REDIS_MAX_WRITE_PER_EVENT
)
1899 if(ion
== REDIS_WRITEV_IOVEC_COUNT
)
1900 break; /* no more iovecs */
1902 iov
[ion
].iov_base
= ((char*)o
->ptr
) + offset
;
1903 iov
[ion
].iov_len
= objlen
- offset
;
1904 willwrite
+= objlen
- offset
;
1905 offset
= 0; /* just for the first item */
1912 /* write all collected blocks at once */
1913 if((nwritten
= writev(fd
, iov
, ion
)) < 0) {
1914 if (errno
!= EAGAIN
) {
1915 redisLog(REDIS_VERBOSE
,
1916 "Error writing to client: %s", strerror(errno
));
1923 totwritten
+= nwritten
;
1924 offset
= c
->sentlen
;
1926 /* remove written robjs from c->reply */
1927 while (nwritten
&& listLength(c
->reply
)) {
1928 o
= listNodeValue(listFirst(c
->reply
));
1929 objlen
= sdslen(o
->ptr
);
1931 if(nwritten
>= objlen
- offset
) {
1932 listDelNode(c
->reply
, listFirst(c
->reply
));
1933 nwritten
-= objlen
- offset
;
1937 c
->sentlen
+= nwritten
;
1945 c
->lastinteraction
= time(NULL
);
1947 if (listLength(c
->reply
) == 0) {
1949 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1953 static struct redisCommand
*lookupCommand(char *name
) {
1955 while(cmdTable
[j
].name
!= NULL
) {
1956 if (!strcasecmp(name
,cmdTable
[j
].name
)) return &cmdTable
[j
];
1962 /* resetClient prepare the client to process the next command */
1963 static void resetClient(redisClient
*c
) {
1969 /* Call() is the core of Redis execution of a command */
1970 static void call(redisClient
*c
, struct redisCommand
*cmd
) {
1973 dirty
= server
.dirty
;
1975 if (server
.appendonly
&& server
.dirty
-dirty
)
1976 feedAppendOnlyFile(cmd
,c
->db
->id
,c
->argv
,c
->argc
);
1977 if (server
.dirty
-dirty
&& listLength(server
.slaves
))
1978 replicationFeedSlaves(server
.slaves
,cmd
,c
->db
->id
,c
->argv
,c
->argc
);
1979 if (listLength(server
.monitors
))
1980 replicationFeedSlaves(server
.monitors
,cmd
,c
->db
->id
,c
->argv
,c
->argc
);
1981 server
.stat_numcommands
++;
1984 /* If this function gets called we already read a whole
1985 * command, argments are in the client argv/argc fields.
1986 * processCommand() execute the command or prepare the
1987 * server for a bulk read from the client.
1989 * If 1 is returned the client is still alive and valid and
1990 * and other operations can be performed by the caller. Otherwise
1991 * if 0 is returned the client was destroied (i.e. after QUIT). */
1992 static int processCommand(redisClient
*c
) {
1993 struct redisCommand
*cmd
;
1995 /* Free some memory if needed (maxmemory setting) */
1996 if (server
.maxmemory
) freeMemoryIfNeeded();
1998 /* Handle the multi bulk command type. This is an alternative protocol
1999 * supported by Redis in order to receive commands that are composed of
2000 * multiple binary-safe "bulk" arguments. The latency of processing is
2001 * a bit higher but this allows things like multi-sets, so if this
2002 * protocol is used only for MSET and similar commands this is a big win. */
2003 if (c
->multibulk
== 0 && c
->argc
== 1 && ((char*)(c
->argv
[0]->ptr
))[0] == '*') {
2004 c
->multibulk
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2005 if (c
->multibulk
<= 0) {
2009 decrRefCount(c
->argv
[c
->argc
-1]);
2013 } else if (c
->multibulk
) {
2014 if (c
->bulklen
== -1) {
2015 if (((char*)c
->argv
[0]->ptr
)[0] != '$') {
2016 addReplySds(c
,sdsnew("-ERR multi bulk protocol error\r\n"));
2020 int bulklen
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2021 decrRefCount(c
->argv
[0]);
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 */
2033 c
->mbargv
= zrealloc(c
->mbargv
,(sizeof(robj
*))*(c
->mbargc
+1));
2034 c
->mbargv
[c
->mbargc
] = c
->argv
[0];
2038 if (c
->multibulk
== 0) {
2042 /* Here we need to swap the multi-bulk argc/argv with the
2043 * normal argc/argv of the client structure. */
2045 c
->argv
= c
->mbargv
;
2046 c
->mbargv
= auxargv
;
2049 c
->argc
= c
->mbargc
;
2050 c
->mbargc
= auxargc
;
2052 /* We need to set bulklen to something different than -1
2053 * in order for the code below to process the command without
2054 * to try to read the last argument of a bulk command as
2055 * a special argument. */
2057 /* continue below and process the command */
2064 /* -- end of multi bulk commands processing -- */
2066 /* The QUIT command is handled as a special case. Normal command
2067 * procs are unable to close the client connection safely */
2068 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
2073 /* Now lookup the command and check ASAP about trivial error conditions
2074 * such wrong arity, bad command name and so forth. */
2075 cmd
= lookupCommand(c
->argv
[0]->ptr
);
2078 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2079 (char*)c
->argv
[0]->ptr
));
2082 } else if ((cmd
->arity
> 0 && cmd
->arity
!= c
->argc
) ||
2083 (c
->argc
< -cmd
->arity
)) {
2085 sdscatprintf(sdsempty(),
2086 "-ERR wrong number of arguments for '%s' command\r\n",
2090 } else if (server
.maxmemory
&& cmd
->flags
& REDIS_CMD_DENYOOM
&& zmalloc_used_memory() > server
.maxmemory
) {
2091 addReplySds(c
,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2094 } else if (cmd
->flags
& REDIS_CMD_BULK
&& c
->bulklen
== -1) {
2095 /* This is a bulk command, we have to read the last argument yet. */
2096 int bulklen
= atoi(c
->argv
[c
->argc
-1]->ptr
);
2098 decrRefCount(c
->argv
[c
->argc
-1]);
2099 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2101 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2106 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2107 /* It is possible that the bulk read is already in the
2108 * buffer. Check this condition and handle it accordingly.
2109 * This is just a fast path, alternative to call processInputBuffer().
2110 * It's a good idea since the code is small and this condition
2111 * happens most of the times. */
2112 if ((signed)sdslen(c
->querybuf
) >= c
->bulklen
) {
2113 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2115 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2117 /* Otherwise return... there is to read the last argument
2118 * from the socket. */
2122 /* Let's try to share objects on the command arguments vector */
2123 if (server
.shareobjects
) {
2125 for(j
= 1; j
< c
->argc
; j
++)
2126 c
->argv
[j
] = tryObjectSharing(c
->argv
[j
]);
2128 /* Let's try to encode the bulk object to save space. */
2129 if (cmd
->flags
& REDIS_CMD_BULK
)
2130 tryObjectEncoding(c
->argv
[c
->argc
-1]);
2132 /* Check if the user is authenticated */
2133 if (server
.requirepass
&& !c
->authenticated
&& cmd
->proc
!= authCommand
) {
2134 addReplySds(c
,sdsnew("-ERR operation not permitted\r\n"));
2139 /* Exec the command */
2140 if (c
->flags
& REDIS_MULTI
&& cmd
->proc
!= execCommand
) {
2141 queueMultiCommand(c
,cmd
);
2142 addReply(c
,shared
.queued
);
2144 if (server
.vm_enabled
&& server
.vm_max_threads
> 0 &&
2145 blockClientOnSwappedKeys(cmd
,c
)) return 1;
2149 /* Prepare the client for the next command */
2154 static void replicationFeedSlaves(list
*slaves
, struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
2159 /* (args*2)+1 is enough room for args, spaces, newlines */
2160 robj
*static_outv
[REDIS_STATIC_ARGS
*2+1];
2162 if (argc
<= REDIS_STATIC_ARGS
) {
2165 outv
= zmalloc(sizeof(robj
*)*(argc
*2+1));
2168 for (j
= 0; j
< argc
; j
++) {
2169 if (j
!= 0) outv
[outc
++] = shared
.space
;
2170 if ((cmd
->flags
& REDIS_CMD_BULK
) && j
== argc
-1) {
2173 lenobj
= createObject(REDIS_STRING
,
2174 sdscatprintf(sdsempty(),"%lu\r\n",
2175 (unsigned long) stringObjectLen(argv
[j
])));
2176 lenobj
->refcount
= 0;
2177 outv
[outc
++] = lenobj
;
2179 outv
[outc
++] = argv
[j
];
2181 outv
[outc
++] = shared
.crlf
;
2183 /* Increment all the refcounts at start and decrement at end in order to
2184 * be sure to free objects if there is no slave in a replication state
2185 * able to be feed with commands */
2186 for (j
= 0; j
< outc
; j
++) incrRefCount(outv
[j
]);
2187 listRewind(slaves
,&li
);
2188 while((ln
= listNext(&li
))) {
2189 redisClient
*slave
= ln
->value
;
2191 /* Don't feed slaves that are still waiting for BGSAVE to start */
2192 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) continue;
2194 /* Feed all the other slaves, MONITORs and so on */
2195 if (slave
->slaveseldb
!= dictid
) {
2199 case 0: selectcmd
= shared
.select0
; break;
2200 case 1: selectcmd
= shared
.select1
; break;
2201 case 2: selectcmd
= shared
.select2
; break;
2202 case 3: selectcmd
= shared
.select3
; break;
2203 case 4: selectcmd
= shared
.select4
; break;
2204 case 5: selectcmd
= shared
.select5
; break;
2205 case 6: selectcmd
= shared
.select6
; break;
2206 case 7: selectcmd
= shared
.select7
; break;
2207 case 8: selectcmd
= shared
.select8
; break;
2208 case 9: selectcmd
= shared
.select9
; break;
2210 selectcmd
= createObject(REDIS_STRING
,
2211 sdscatprintf(sdsempty(),"select %d\r\n",dictid
));
2212 selectcmd
->refcount
= 0;
2215 addReply(slave
,selectcmd
);
2216 slave
->slaveseldb
= dictid
;
2218 for (j
= 0; j
< outc
; j
++) addReply(slave
,outv
[j
]);
2220 for (j
= 0; j
< outc
; j
++) decrRefCount(outv
[j
]);
2221 if (outv
!= static_outv
) zfree(outv
);
2224 static void processInputBuffer(redisClient
*c
) {
2226 /* Before to process the input buffer, make sure the client is not
2227 * waitig for a blocking operation such as BLPOP. Note that the first
2228 * iteration the client is never blocked, otherwise the processInputBuffer
2229 * would not be called at all, but after the execution of the first commands
2230 * in the input buffer the client may be blocked, and the "goto again"
2231 * will try to reiterate. The following line will make it return asap. */
2232 if (c
->flags
& REDIS_BLOCKED
|| c
->flags
& REDIS_IO_WAIT
) return;
2233 if (c
->bulklen
== -1) {
2234 /* Read the first line of the query */
2235 char *p
= strchr(c
->querybuf
,'\n');
2242 query
= c
->querybuf
;
2243 c
->querybuf
= sdsempty();
2244 querylen
= 1+(p
-(query
));
2245 if (sdslen(query
) > querylen
) {
2246 /* leave data after the first line of the query in the buffer */
2247 c
->querybuf
= sdscatlen(c
->querybuf
,query
+querylen
,sdslen(query
)-querylen
);
2249 *p
= '\0'; /* remove "\n" */
2250 if (*(p
-1) == '\r') *(p
-1) = '\0'; /* and "\r" if any */
2251 sdsupdatelen(query
);
2253 /* Now we can split the query in arguments */
2254 argv
= sdssplitlen(query
,sdslen(query
)," ",1,&argc
);
2257 if (c
->argv
) zfree(c
->argv
);
2258 c
->argv
= zmalloc(sizeof(robj
*)*argc
);
2260 for (j
= 0; j
< argc
; j
++) {
2261 if (sdslen(argv
[j
])) {
2262 c
->argv
[c
->argc
] = createObject(REDIS_STRING
,argv
[j
]);
2270 /* Execute the command. If the client is still valid
2271 * after processCommand() return and there is something
2272 * on the query buffer try to process the next command. */
2273 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2275 /* Nothing to process, argc == 0. Just process the query
2276 * buffer if it's not empty or return to the caller */
2277 if (sdslen(c
->querybuf
)) goto again
;
2280 } else if (sdslen(c
->querybuf
) >= REDIS_REQUEST_MAX_SIZE
) {
2281 redisLog(REDIS_VERBOSE
, "Client protocol error");
2286 /* Bulk read handling. Note that if we are at this point
2287 the client already sent a command terminated with a newline,
2288 we are reading the bulk data that is actually the last
2289 argument of the command. */
2290 int qbl
= sdslen(c
->querybuf
);
2292 if (c
->bulklen
<= qbl
) {
2293 /* Copy everything but the final CRLF as final argument */
2294 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2296 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2297 /* Process the command. If the client is still valid after
2298 * the processing and there is more data in the buffer
2299 * try to parse it. */
2300 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2306 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2307 redisClient
*c
= (redisClient
*) privdata
;
2308 char buf
[REDIS_IOBUF_LEN
];
2311 REDIS_NOTUSED(mask
);
2313 nread
= read(fd
, buf
, REDIS_IOBUF_LEN
);
2315 if (errno
== EAGAIN
) {
2318 redisLog(REDIS_VERBOSE
, "Reading from client: %s",strerror(errno
));
2322 } else if (nread
== 0) {
2323 redisLog(REDIS_VERBOSE
, "Client closed connection");
2328 c
->querybuf
= sdscatlen(c
->querybuf
, buf
, nread
);
2329 c
->lastinteraction
= time(NULL
);
2333 processInputBuffer(c
);
2336 static int selectDb(redisClient
*c
, int id
) {
2337 if (id
< 0 || id
>= server
.dbnum
)
2339 c
->db
= &server
.db
[id
];
2343 static void *dupClientReplyValue(void *o
) {
2344 incrRefCount((robj
*)o
);
2348 static redisClient
*createClient(int fd
) {
2349 redisClient
*c
= zmalloc(sizeof(*c
));
2351 anetNonBlock(NULL
,fd
);
2352 anetTcpNoDelay(NULL
,fd
);
2353 if (!c
) return NULL
;
2356 c
->querybuf
= sdsempty();
2365 c
->lastinteraction
= time(NULL
);
2366 c
->authenticated
= 0;
2367 c
->replstate
= REDIS_REPL_NONE
;
2368 c
->reply
= listCreate();
2369 listSetFreeMethod(c
->reply
,decrRefCount
);
2370 listSetDupMethod(c
->reply
,dupClientReplyValue
);
2371 c
->blockingkeys
= NULL
;
2372 c
->blockingkeysnum
= 0;
2373 c
->io_keys
= listCreate();
2374 listSetFreeMethod(c
->io_keys
,decrRefCount
);
2375 if (aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
2376 readQueryFromClient
, c
) == AE_ERR
) {
2380 listAddNodeTail(server
.clients
,c
);
2381 initClientMultiState(c
);
2385 static void addReply(redisClient
*c
, robj
*obj
) {
2386 if (listLength(c
->reply
) == 0 &&
2387 (c
->replstate
== REDIS_REPL_NONE
||
2388 c
->replstate
== REDIS_REPL_ONLINE
) &&
2389 aeCreateFileEvent(server
.el
, c
->fd
, AE_WRITABLE
,
2390 sendReplyToClient
, c
) == AE_ERR
) return;
2392 if (server
.vm_enabled
&& obj
->storage
!= REDIS_VM_MEMORY
) {
2393 obj
= dupStringObject(obj
);
2394 obj
->refcount
= 0; /* getDecodedObject() will increment the refcount */
2396 listAddNodeTail(c
->reply
,getDecodedObject(obj
));
2399 static void addReplySds(redisClient
*c
, sds s
) {
2400 robj
*o
= createObject(REDIS_STRING
,s
);
2405 static void addReplyDouble(redisClient
*c
, double d
) {
2408 snprintf(buf
,sizeof(buf
),"%.17g",d
);
2409 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2410 (unsigned long) strlen(buf
),buf
));
2413 static void addReplyLong(redisClient
*c
, long l
) {
2417 len
= snprintf(buf
,sizeof(buf
),":%ld\r\n",l
);
2418 addReplySds(c
,sdsnewlen(buf
,len
));
2421 static void addReplyBulkLen(redisClient
*c
, robj
*obj
) {
2424 if (obj
->encoding
== REDIS_ENCODING_RAW
) {
2425 len
= sdslen(obj
->ptr
);
2427 long n
= (long)obj
->ptr
;
2429 /* Compute how many bytes will take this integer as a radix 10 string */
2435 while((n
= n
/10) != 0) {
2439 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",(unsigned long)len
));
2442 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2447 REDIS_NOTUSED(mask
);
2448 REDIS_NOTUSED(privdata
);
2450 cfd
= anetAccept(server
.neterr
, fd
, cip
, &cport
);
2451 if (cfd
== AE_ERR
) {
2452 redisLog(REDIS_VERBOSE
,"Accepting client connection: %s", server
.neterr
);
2455 redisLog(REDIS_VERBOSE
,"Accepted %s:%d", cip
, cport
);
2456 if ((c
= createClient(cfd
)) == NULL
) {
2457 redisLog(REDIS_WARNING
,"Error allocating resoures for the client");
2458 close(cfd
); /* May be already closed, just ingore errors */
2461 /* If maxclient directive is set and this is one client more... close the
2462 * connection. Note that we create the client instead to check before
2463 * for this condition, since now the socket is already set in nonblocking
2464 * mode and we can send an error for free using the Kernel I/O */
2465 if (server
.maxclients
&& listLength(server
.clients
) > server
.maxclients
) {
2466 char *err
= "-ERR max number of clients reached\r\n";
2468 /* That's a best effort error message, don't check write errors */
2469 if (write(c
->fd
,err
,strlen(err
)) == -1) {
2470 /* Nothing to do, Just to avoid the warning... */
2475 server
.stat_numconnections
++;
2478 /* ======================= Redis objects implementation ===================== */
2480 static robj
*createObject(int type
, void *ptr
) {
2483 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2484 if (listLength(server
.objfreelist
)) {
2485 listNode
*head
= listFirst(server
.objfreelist
);
2486 o
= listNodeValue(head
);
2487 listDelNode(server
.objfreelist
,head
);
2488 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2490 if (server
.vm_enabled
) {
2491 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2492 o
= zmalloc(sizeof(*o
));
2494 o
= zmalloc(sizeof(*o
)-sizeof(struct redisObjectVM
));
2498 o
->encoding
= REDIS_ENCODING_RAW
;
2501 if (server
.vm_enabled
) {
2502 /* Note that this code may run in the context of an I/O thread
2503 * and accessing to server.unixtime in theory is an error
2504 * (no locks). But in practice this is safe, and even if we read
2505 * garbage Redis will not fail, as it's just a statistical info */
2506 o
->vm
.atime
= server
.unixtime
;
2507 o
->storage
= REDIS_VM_MEMORY
;
2512 static robj
*createStringObject(char *ptr
, size_t len
) {
2513 return createObject(REDIS_STRING
,sdsnewlen(ptr
,len
));
2516 static robj
*dupStringObject(robj
*o
) {
2517 assert(o
->encoding
== REDIS_ENCODING_RAW
);
2518 return createStringObject(o
->ptr
,sdslen(o
->ptr
));
2521 static robj
*createListObject(void) {
2522 list
*l
= listCreate();
2524 listSetFreeMethod(l
,decrRefCount
);
2525 return createObject(REDIS_LIST
,l
);
2528 static robj
*createSetObject(void) {
2529 dict
*d
= dictCreate(&setDictType
,NULL
);
2530 return createObject(REDIS_SET
,d
);
2533 static robj
*createZsetObject(void) {
2534 zset
*zs
= zmalloc(sizeof(*zs
));
2536 zs
->dict
= dictCreate(&zsetDictType
,NULL
);
2537 zs
->zsl
= zslCreate();
2538 return createObject(REDIS_ZSET
,zs
);
2541 static void freeStringObject(robj
*o
) {
2542 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2547 static void freeListObject(robj
*o
) {
2548 listRelease((list
*) o
->ptr
);
2551 static void freeSetObject(robj
*o
) {
2552 dictRelease((dict
*) o
->ptr
);
2555 static void freeZsetObject(robj
*o
) {
2558 dictRelease(zs
->dict
);
2563 static void freeHashObject(robj
*o
) {
2564 dictRelease((dict
*) o
->ptr
);
2567 static void incrRefCount(robj
*o
) {
2568 redisAssert(!server
.vm_enabled
|| o
->storage
== REDIS_VM_MEMORY
);
2572 static void decrRefCount(void *obj
) {
2575 /* Object is a key of a swapped out value, or in the process of being
2577 if (server
.vm_enabled
&&
2578 (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
))
2580 if (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
) {
2581 redisAssert(o
->refcount
== 1);
2583 if (o
->storage
== REDIS_VM_LOADING
) vmCancelThreadedIOJob(obj
);
2584 redisAssert(o
->type
== REDIS_STRING
);
2585 freeStringObject(o
);
2586 vmMarkPagesFree(o
->vm
.page
,o
->vm
.usedpages
);
2587 pthread_mutex_lock(&server
.obj_freelist_mutex
);
2588 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2589 !listAddNodeHead(server
.objfreelist
,o
))
2591 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2592 server
.vm_stats_swapped_objects
--;
2595 /* Object is in memory, or in the process of being swapped out. */
2596 if (--(o
->refcount
) == 0) {
2597 if (server
.vm_enabled
&& o
->storage
== REDIS_VM_SWAPPING
)
2598 vmCancelThreadedIOJob(obj
);
2600 case REDIS_STRING
: freeStringObject(o
); break;
2601 case REDIS_LIST
: freeListObject(o
); break;
2602 case REDIS_SET
: freeSetObject(o
); break;
2603 case REDIS_ZSET
: freeZsetObject(o
); break;
2604 case REDIS_HASH
: freeHashObject(o
); break;
2605 default: redisAssert(0 != 0); break;
2607 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2608 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2609 !listAddNodeHead(server
.objfreelist
,o
))
2611 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2615 static robj
*lookupKey(redisDb
*db
, robj
*key
) {
2616 dictEntry
*de
= dictFind(db
->dict
,key
);
2618 robj
*key
= dictGetEntryKey(de
);
2619 robj
*val
= dictGetEntryVal(de
);
2621 if (server
.vm_enabled
) {
2622 if (key
->storage
== REDIS_VM_MEMORY
||
2623 key
->storage
== REDIS_VM_SWAPPING
)
2625 /* If we were swapping the object out, stop it, this key
2627 if (key
->storage
== REDIS_VM_SWAPPING
)
2628 vmCancelThreadedIOJob(key
);
2629 /* Update the access time of the key for the aging algorithm. */
2630 key
->vm
.atime
= server
.unixtime
;
2632 int notify
= (key
->storage
== REDIS_VM_LOADING
);
2634 /* Our value was swapped on disk. Bring it at home. */
2635 redisAssert(val
== NULL
);
2636 val
= vmLoadObject(key
);
2637 dictGetEntryVal(de
) = val
;
2639 /* Clients blocked by the VM subsystem may be waiting for
2641 if (notify
) handleClientsBlockedOnSwappedKey(db
,key
);
2650 static robj
*lookupKeyRead(redisDb
*db
, robj
*key
) {
2651 expireIfNeeded(db
,key
);
2652 return lookupKey(db
,key
);
2655 static robj
*lookupKeyWrite(redisDb
*db
, robj
*key
) {
2656 deleteIfVolatile(db
,key
);
2657 return lookupKey(db
,key
);
2660 static int deleteKey(redisDb
*db
, robj
*key
) {
2663 /* We need to protect key from destruction: after the first dictDelete()
2664 * it may happen that 'key' is no longer valid if we don't increment
2665 * it's count. This may happen when we get the object reference directly
2666 * from the hash table with dictRandomKey() or dict iterators */
2668 if (dictSize(db
->expires
)) dictDelete(db
->expires
,key
);
2669 retval
= dictDelete(db
->dict
,key
);
2672 return retval
== DICT_OK
;
2675 /* Try to share an object against the shared objects pool */
2676 static robj
*tryObjectSharing(robj
*o
) {
2677 struct dictEntry
*de
;
2680 if (o
== NULL
|| server
.shareobjects
== 0) return o
;
2682 redisAssert(o
->type
== REDIS_STRING
);
2683 de
= dictFind(server
.sharingpool
,o
);
2685 robj
*shared
= dictGetEntryKey(de
);
2687 c
= ((unsigned long) dictGetEntryVal(de
))+1;
2688 dictGetEntryVal(de
) = (void*) c
;
2689 incrRefCount(shared
);
2693 /* Here we are using a stream algorihtm: Every time an object is
2694 * shared we increment its count, everytime there is a miss we
2695 * recrement the counter of a random object. If this object reaches
2696 * zero we remove the object and put the current object instead. */
2697 if (dictSize(server
.sharingpool
) >=
2698 server
.sharingpoolsize
) {
2699 de
= dictGetRandomKey(server
.sharingpool
);
2700 redisAssert(de
!= NULL
);
2701 c
= ((unsigned long) dictGetEntryVal(de
))-1;
2702 dictGetEntryVal(de
) = (void*) c
;
2704 dictDelete(server
.sharingpool
,de
->key
);
2707 c
= 0; /* If the pool is empty we want to add this object */
2712 retval
= dictAdd(server
.sharingpool
,o
,(void*)1);
2713 redisAssert(retval
== DICT_OK
);
2720 /* Check if the nul-terminated string 's' can be represented by a long
2721 * (that is, is a number that fits into long without any other space or
2722 * character before or after the digits).
2724 * If so, the function returns REDIS_OK and *longval is set to the value
2725 * of the number. Otherwise REDIS_ERR is returned */
2726 static int isStringRepresentableAsLong(sds s
, long *longval
) {
2727 char buf
[32], *endptr
;
2731 value
= strtol(s
, &endptr
, 10);
2732 if (endptr
[0] != '\0') return REDIS_ERR
;
2733 slen
= snprintf(buf
,32,"%ld",value
);
2735 /* If the number converted back into a string is not identical
2736 * then it's not possible to encode the string as integer */
2737 if (sdslen(s
) != (unsigned)slen
|| memcmp(buf
,s
,slen
)) return REDIS_ERR
;
2738 if (longval
) *longval
= value
;
2742 /* Try to encode a string object in order to save space */
2743 static int tryObjectEncoding(robj
*o
) {
2747 if (o
->encoding
!= REDIS_ENCODING_RAW
)
2748 return REDIS_ERR
; /* Already encoded */
2750 /* It's not save to encode shared objects: shared objects can be shared
2751 * everywhere in the "object space" of Redis. Encoded objects can only
2752 * appear as "values" (and not, for instance, as keys) */
2753 if (o
->refcount
> 1) return REDIS_ERR
;
2755 /* Currently we try to encode only strings */
2756 redisAssert(o
->type
== REDIS_STRING
);
2758 /* Check if we can represent this string as a long integer */
2759 if (isStringRepresentableAsLong(s
,&value
) == REDIS_ERR
) return REDIS_ERR
;
2761 /* Ok, this object can be encoded */
2762 o
->encoding
= REDIS_ENCODING_INT
;
2764 o
->ptr
= (void*) value
;
2768 /* Get a decoded version of an encoded object (returned as a new object).
2769 * If the object is already raw-encoded just increment the ref count. */
2770 static robj
*getDecodedObject(robj
*o
) {
2773 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2777 if (o
->type
== REDIS_STRING
&& o
->encoding
== REDIS_ENCODING_INT
) {
2780 snprintf(buf
,32,"%ld",(long)o
->ptr
);
2781 dec
= createStringObject(buf
,strlen(buf
));
2784 redisAssert(1 != 1);
2788 /* Compare two string objects via strcmp() or alike.
2789 * Note that the objects may be integer-encoded. In such a case we
2790 * use snprintf() to get a string representation of the numbers on the stack
2791 * and compare the strings, it's much faster than calling getDecodedObject().
2793 * Important note: if objects are not integer encoded, but binary-safe strings,
2794 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
2796 static int compareStringObjects(robj
*a
, robj
*b
) {
2797 redisAssert(a
->type
== REDIS_STRING
&& b
->type
== REDIS_STRING
);
2798 char bufa
[128], bufb
[128], *astr
, *bstr
;
2801 if (a
== b
) return 0;
2802 if (a
->encoding
!= REDIS_ENCODING_RAW
) {
2803 snprintf(bufa
,sizeof(bufa
),"%ld",(long) a
->ptr
);
2809 if (b
->encoding
!= REDIS_ENCODING_RAW
) {
2810 snprintf(bufb
,sizeof(bufb
),"%ld",(long) b
->ptr
);
2816 return bothsds
? sdscmp(astr
,bstr
) : strcmp(astr
,bstr
);
2819 static size_t stringObjectLen(robj
*o
) {
2820 redisAssert(o
->type
== REDIS_STRING
);
2821 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2822 return sdslen(o
->ptr
);
2826 return snprintf(buf
,32,"%ld",(long)o
->ptr
);
2830 /*============================ RDB saving/loading =========================== */
2832 static int rdbSaveType(FILE *fp
, unsigned char type
) {
2833 if (fwrite(&type
,1,1,fp
) == 0) return -1;
2837 static int rdbSaveTime(FILE *fp
, time_t t
) {
2838 int32_t t32
= (int32_t) t
;
2839 if (fwrite(&t32
,4,1,fp
) == 0) return -1;
2843 /* check rdbLoadLen() comments for more info */
2844 static int rdbSaveLen(FILE *fp
, uint32_t len
) {
2845 unsigned char buf
[2];
2848 /* Save a 6 bit len */
2849 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
2850 if (fwrite(buf
,1,1,fp
) == 0) return -1;
2851 } else if (len
< (1<<14)) {
2852 /* Save a 14 bit len */
2853 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
2855 if (fwrite(buf
,2,1,fp
) == 0) return -1;
2857 /* Save a 32 bit len */
2858 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
2859 if (fwrite(buf
,1,1,fp
) == 0) return -1;
2861 if (fwrite(&len
,4,1,fp
) == 0) return -1;
2866 /* String objects in the form "2391" "-100" without any space and with a
2867 * range of values that can fit in an 8, 16 or 32 bit signed value can be
2868 * encoded as integers to save space */
2869 static int rdbTryIntegerEncoding(sds s
, unsigned char *enc
) {
2871 char *endptr
, buf
[32];
2873 /* Check if it's possible to encode this value as a number */
2874 value
= strtoll(s
, &endptr
, 10);
2875 if (endptr
[0] != '\0') return 0;
2876 snprintf(buf
,32,"%lld",value
);
2878 /* If the number converted back into a string is not identical
2879 * then it's not possible to encode the string as integer */
2880 if (strlen(buf
) != sdslen(s
) || memcmp(buf
,s
,sdslen(s
))) return 0;
2882 /* Finally check if it fits in our ranges */
2883 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
2884 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
2885 enc
[1] = value
&0xFF;
2887 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
2888 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
2889 enc
[1] = value
&0xFF;
2890 enc
[2] = (value
>>8)&0xFF;
2892 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
2893 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
2894 enc
[1] = value
&0xFF;
2895 enc
[2] = (value
>>8)&0xFF;
2896 enc
[3] = (value
>>16)&0xFF;
2897 enc
[4] = (value
>>24)&0xFF;
2904 static int rdbSaveLzfStringObject(FILE *fp
, robj
*obj
) {
2905 unsigned int comprlen
, outlen
;
2909 /* We require at least four bytes compression for this to be worth it */
2910 outlen
= sdslen(obj
->ptr
)-4;
2911 if (outlen
<= 0) return 0;
2912 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
2913 comprlen
= lzf_compress(obj
->ptr
, sdslen(obj
->ptr
), out
, outlen
);
2914 if (comprlen
== 0) {
2918 /* Data compressed! Let's save it on disk */
2919 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
2920 if (fwrite(&byte
,1,1,fp
) == 0) goto writeerr
;
2921 if (rdbSaveLen(fp
,comprlen
) == -1) goto writeerr
;
2922 if (rdbSaveLen(fp
,sdslen(obj
->ptr
)) == -1) goto writeerr
;
2923 if (fwrite(out
,comprlen
,1,fp
) == 0) goto writeerr
;
2932 /* Save a string objet as [len][data] on disk. If the object is a string
2933 * representation of an integer value we try to safe it in a special form */
2934 static int rdbSaveStringObjectRaw(FILE *fp
, robj
*obj
) {
2938 len
= sdslen(obj
->ptr
);
2940 /* Try integer encoding */
2942 unsigned char buf
[5];
2943 if ((enclen
= rdbTryIntegerEncoding(obj
->ptr
,buf
)) > 0) {
2944 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
2949 /* Try LZF compression - under 20 bytes it's unable to compress even
2950 * aaaaaaaaaaaaaaaaaa so skip it */
2951 if (server
.rdbcompression
&& len
> 20) {
2954 retval
= rdbSaveLzfStringObject(fp
,obj
);
2955 if (retval
== -1) return -1;
2956 if (retval
> 0) return 0;
2957 /* retval == 0 means data can't be compressed, save the old way */
2960 /* Store verbatim */
2961 if (rdbSaveLen(fp
,len
) == -1) return -1;
2962 if (len
&& fwrite(obj
->ptr
,len
,1,fp
) == 0) return -1;
2966 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
2967 static int rdbSaveStringObject(FILE *fp
, robj
*obj
) {
2970 /* Avoid incr/decr ref count business when possible.
2971 * This plays well with copy-on-write given that we are probably
2972 * in a child process (BGSAVE). Also this makes sure key objects
2973 * of swapped objects are not incRefCount-ed (an assert does not allow
2974 * this in order to avoid bugs) */
2975 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
2976 obj
= getDecodedObject(obj
);
2977 retval
= rdbSaveStringObjectRaw(fp
,obj
);
2980 retval
= rdbSaveStringObjectRaw(fp
,obj
);
2985 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
2986 * 8 bit integer specifing the length of the representation.
2987 * This 8 bit integer has special values in order to specify the following
2993 static int rdbSaveDoubleValue(FILE *fp
, double val
) {
2994 unsigned char buf
[128];
3000 } else if (!isfinite(val
)) {
3002 buf
[0] = (val
< 0) ? 255 : 254;
3004 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
3005 buf
[0] = strlen((char*)buf
+1);
3008 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
3012 /* Save a Redis object. */
3013 static int rdbSaveObject(FILE *fp
, robj
*o
) {
3014 if (o
->type
== REDIS_STRING
) {
3015 /* Save a string value */
3016 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
3017 } else if (o
->type
== REDIS_LIST
) {
3018 /* Save a list value */
3019 list
*list
= o
->ptr
;
3023 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
3024 listRewind(list
,&li
);
3025 while((ln
= listNext(&li
))) {
3026 robj
*eleobj
= listNodeValue(ln
);
3028 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3030 } else if (o
->type
== REDIS_SET
) {
3031 /* Save a set value */
3033 dictIterator
*di
= dictGetIterator(set
);
3036 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
3037 while((de
= dictNext(di
)) != NULL
) {
3038 robj
*eleobj
= dictGetEntryKey(de
);
3040 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3042 dictReleaseIterator(di
);
3043 } else if (o
->type
== REDIS_ZSET
) {
3044 /* Save a set value */
3046 dictIterator
*di
= dictGetIterator(zs
->dict
);
3049 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
3050 while((de
= dictNext(di
)) != NULL
) {
3051 robj
*eleobj
= dictGetEntryKey(de
);
3052 double *score
= dictGetEntryVal(de
);
3054 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3055 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
3057 dictReleaseIterator(di
);
3059 redisAssert(0 != 0);
3064 /* Return the length the object will have on disk if saved with
3065 * the rdbSaveObject() function. Currently we use a trick to get
3066 * this length with very little changes to the code. In the future
3067 * we could switch to a faster solution. */
3068 static off_t
rdbSavedObjectLen(robj
*o
, FILE *fp
) {
3069 if (fp
== NULL
) fp
= server
.devnull
;
3071 assert(rdbSaveObject(fp
,o
) != 1);
3075 /* Return the number of pages required to save this object in the swap file */
3076 static off_t
rdbSavedObjectPages(robj
*o
, FILE *fp
) {
3077 off_t bytes
= rdbSavedObjectLen(o
,fp
);
3079 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
3082 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3083 static int rdbSave(char *filename
) {
3084 dictIterator
*di
= NULL
;
3089 time_t now
= time(NULL
);
3091 /* Wait for I/O therads to terminate, just in case this is a
3092 * foreground-saving, to avoid seeking the swap file descriptor at the
3094 if (server
.vm_enabled
)
3095 waitEmptyIOJobsQueue();
3097 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
3098 fp
= fopen(tmpfile
,"w");
3100 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
3103 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
3104 for (j
= 0; j
< server
.dbnum
; j
++) {
3105 redisDb
*db
= server
.db
+j
;
3107 if (dictSize(d
) == 0) continue;
3108 di
= dictGetIterator(d
);
3114 /* Write the SELECT DB opcode */
3115 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
3116 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
3118 /* Iterate this DB writing every entry */
3119 while((de
= dictNext(di
)) != NULL
) {
3120 robj
*key
= dictGetEntryKey(de
);
3121 robj
*o
= dictGetEntryVal(de
);
3122 time_t expiretime
= getExpire(db
,key
);
3124 /* Save the expire time */
3125 if (expiretime
!= -1) {
3126 /* If this key is already expired skip it */
3127 if (expiretime
< now
) continue;
3128 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
3129 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
3131 /* Save the key and associated value. This requires special
3132 * handling if the value is swapped out. */
3133 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
3134 key
->storage
== REDIS_VM_SWAPPING
) {
3135 /* Save type, key, value */
3136 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
3137 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3138 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
3140 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3142 /* Get a preview of the object in memory */
3143 po
= vmPreviewObject(key
);
3144 /* Save type, key, value */
3145 if (rdbSaveType(fp
,key
->vtype
) == -1) goto werr
;
3146 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3147 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
3148 /* Remove the loaded object from memory */
3152 dictReleaseIterator(di
);
3155 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
3157 /* Make sure data will not remain on the OS's output buffers */
3162 /* Use RENAME to make sure the DB file is changed atomically only
3163 * if the generate DB file is ok. */
3164 if (rename(tmpfile
,filename
) == -1) {
3165 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
3169 redisLog(REDIS_NOTICE
,"DB saved on disk");
3171 server
.lastsave
= time(NULL
);
3177 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
3178 if (di
) dictReleaseIterator(di
);
3182 static int rdbSaveBackground(char *filename
) {
3185 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
3186 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
3187 if ((childpid
= fork()) == 0) {
3189 if (server
.vm_enabled
) vmReopenSwapFile();
3191 if (rdbSave(filename
) == REDIS_OK
) {
3198 if (childpid
== -1) {
3199 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
3203 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
3204 server
.bgsavechildpid
= childpid
;
3207 return REDIS_OK
; /* unreached */
3210 static void rdbRemoveTempFile(pid_t childpid
) {
3213 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
3217 static int rdbLoadType(FILE *fp
) {
3219 if (fread(&type
,1,1,fp
) == 0) return -1;
3223 static time_t rdbLoadTime(FILE *fp
) {
3225 if (fread(&t32
,4,1,fp
) == 0) return -1;
3226 return (time_t) t32
;
3229 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3230 * of this file for a description of how this are stored on disk.
3232 * isencoded is set to 1 if the readed length is not actually a length but
3233 * an "encoding type", check the above comments for more info */
3234 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
3235 unsigned char buf
[2];
3239 if (isencoded
) *isencoded
= 0;
3240 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3241 type
= (buf
[0]&0xC0)>>6;
3242 if (type
== REDIS_RDB_6BITLEN
) {
3243 /* Read a 6 bit len */
3245 } else if (type
== REDIS_RDB_ENCVAL
) {
3246 /* Read a 6 bit len encoding type */
3247 if (isencoded
) *isencoded
= 1;
3249 } else if (type
== REDIS_RDB_14BITLEN
) {
3250 /* Read a 14 bit len */
3251 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3252 return ((buf
[0]&0x3F)<<8)|buf
[1];
3254 /* Read a 32 bit len */
3255 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
3260 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
) {
3261 unsigned char enc
[4];
3264 if (enctype
== REDIS_RDB_ENC_INT8
) {
3265 if (fread(enc
,1,1,fp
) == 0) return NULL
;
3266 val
= (signed char)enc
[0];
3267 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
3269 if (fread(enc
,2,1,fp
) == 0) return NULL
;
3270 v
= enc
[0]|(enc
[1]<<8);
3272 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
3274 if (fread(enc
,4,1,fp
) == 0) return NULL
;
3275 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
3278 val
= 0; /* anti-warning */
3281 return createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",val
));
3284 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
3285 unsigned int len
, clen
;
3286 unsigned char *c
= NULL
;
3289 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3290 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3291 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
3292 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
3293 if (fread(c
,clen
,1,fp
) == 0) goto err
;
3294 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
3296 return createObject(REDIS_STRING
,val
);
3303 static robj
*rdbLoadStringObject(FILE*fp
) {
3308 len
= rdbLoadLen(fp
,&isencoded
);
3311 case REDIS_RDB_ENC_INT8
:
3312 case REDIS_RDB_ENC_INT16
:
3313 case REDIS_RDB_ENC_INT32
:
3314 return tryObjectSharing(rdbLoadIntegerObject(fp
,len
));
3315 case REDIS_RDB_ENC_LZF
:
3316 return tryObjectSharing(rdbLoadLzfStringObject(fp
));
3322 if (len
== REDIS_RDB_LENERR
) return NULL
;
3323 val
= sdsnewlen(NULL
,len
);
3324 if (len
&& fread(val
,len
,1,fp
) == 0) {
3328 return tryObjectSharing(createObject(REDIS_STRING
,val
));
3331 /* For information about double serialization check rdbSaveDoubleValue() */
3332 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
3336 if (fread(&len
,1,1,fp
) == 0) return -1;
3338 case 255: *val
= R_NegInf
; return 0;
3339 case 254: *val
= R_PosInf
; return 0;
3340 case 253: *val
= R_Nan
; return 0;
3342 if (fread(buf
,len
,1,fp
) == 0) return -1;
3344 sscanf(buf
, "%lg", val
);
3349 /* Load a Redis object of the specified type from the specified file.
3350 * On success a newly allocated object is returned, otherwise NULL. */
3351 static robj
*rdbLoadObject(int type
, FILE *fp
) {
3354 if (type
== REDIS_STRING
) {
3355 /* Read string value */
3356 if ((o
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3357 tryObjectEncoding(o
);
3358 } else if (type
== REDIS_LIST
|| type
== REDIS_SET
) {
3359 /* Read list/set value */
3362 if ((listlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3363 o
= (type
== REDIS_LIST
) ? createListObject() : createSetObject();
3364 /* It's faster to expand the dict to the right size asap in order
3365 * to avoid rehashing */
3366 if (type
== REDIS_SET
&& listlen
> DICT_HT_INITIAL_SIZE
)
3367 dictExpand(o
->ptr
,listlen
);
3368 /* Load every single element of the list/set */
3372 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3373 tryObjectEncoding(ele
);
3374 if (type
== REDIS_LIST
) {
3375 listAddNodeTail((list
*)o
->ptr
,ele
);
3377 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
3380 } else if (type
== REDIS_ZSET
) {
3381 /* Read list/set value */
3385 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3386 o
= createZsetObject();
3388 /* Load every single element of the list/set */
3391 double *score
= zmalloc(sizeof(double));
3393 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3394 tryObjectEncoding(ele
);
3395 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
3396 dictAdd(zs
->dict
,ele
,score
);
3397 zslInsert(zs
->zsl
,*score
,ele
);
3398 incrRefCount(ele
); /* added to skiplist */
3401 redisAssert(0 != 0);
3406 static int rdbLoad(char *filename
) {
3408 robj
*keyobj
= NULL
;
3410 int type
, retval
, rdbver
;
3411 dict
*d
= server
.db
[0].dict
;
3412 redisDb
*db
= server
.db
+0;
3414 time_t expiretime
= -1, now
= time(NULL
);
3415 long long loadedkeys
= 0;
3417 fp
= fopen(filename
,"r");
3418 if (!fp
) return REDIS_ERR
;
3419 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
3421 if (memcmp(buf
,"REDIS",5) != 0) {
3423 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
3426 rdbver
= atoi(buf
+5);
3429 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
3436 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3437 if (type
== REDIS_EXPIRETIME
) {
3438 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
3439 /* We read the time so we need to read the object type again */
3440 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3442 if (type
== REDIS_EOF
) break;
3443 /* Handle SELECT DB opcode as a special case */
3444 if (type
== REDIS_SELECTDB
) {
3445 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
3447 if (dbid
>= (unsigned)server
.dbnum
) {
3448 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
3451 db
= server
.db
+dbid
;
3456 if ((keyobj
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
3458 if ((o
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
3459 /* Add the new object in the hash table */
3460 retval
= dictAdd(d
,keyobj
,o
);
3461 if (retval
== DICT_ERR
) {
3462 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", keyobj
->ptr
);
3465 /* Set the expire time if needed */
3466 if (expiretime
!= -1) {
3467 setExpire(db
,keyobj
,expiretime
);
3468 /* Delete this key if already expired */
3469 if (expiretime
< now
) deleteKey(db
,keyobj
);
3473 /* Handle swapping while loading big datasets when VM is on */
3475 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
3476 while (zmalloc_used_memory() > server
.vm_max_memory
) {
3477 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
3484 eoferr
: /* unexpected end of file is handled here with a fatal exit */
3485 if (keyobj
) decrRefCount(keyobj
);
3486 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
3488 return REDIS_ERR
; /* Just to avoid warning */
3491 /*================================== Commands =============================== */
3493 static void authCommand(redisClient
*c
) {
3494 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
3495 c
->authenticated
= 1;
3496 addReply(c
,shared
.ok
);
3498 c
->authenticated
= 0;
3499 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
3503 static void pingCommand(redisClient
*c
) {
3504 addReply(c
,shared
.pong
);
3507 static void echoCommand(redisClient
*c
) {
3508 addReplyBulkLen(c
,c
->argv
[1]);
3509 addReply(c
,c
->argv
[1]);
3510 addReply(c
,shared
.crlf
);
3513 /*=================================== Strings =============================== */
3515 static void setGenericCommand(redisClient
*c
, int nx
) {
3518 if (nx
) deleteIfVolatile(c
->db
,c
->argv
[1]);
3519 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3520 if (retval
== DICT_ERR
) {
3522 /* If the key is about a swapped value, we want a new key object
3523 * to overwrite the old. So we delete the old key in the database.
3524 * This will also make sure that swap pages about the old object
3525 * will be marked as free. */
3526 if (deleteIfSwapped(c
->db
,c
->argv
[1]))
3527 incrRefCount(c
->argv
[1]);
3528 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3529 incrRefCount(c
->argv
[2]);
3531 addReply(c
,shared
.czero
);
3535 incrRefCount(c
->argv
[1]);
3536 incrRefCount(c
->argv
[2]);
3539 removeExpire(c
->db
,c
->argv
[1]);
3540 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3543 static void setCommand(redisClient
*c
) {
3544 setGenericCommand(c
,0);
3547 static void setnxCommand(redisClient
*c
) {
3548 setGenericCommand(c
,1);
3551 static int getGenericCommand(redisClient
*c
) {
3552 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[1]);
3555 addReply(c
,shared
.nullbulk
);
3558 if (o
->type
!= REDIS_STRING
) {
3559 addReply(c
,shared
.wrongtypeerr
);
3562 addReplyBulkLen(c
,o
);
3564 addReply(c
,shared
.crlf
);
3570 static void getCommand(redisClient
*c
) {
3571 getGenericCommand(c
);
3574 static void getsetCommand(redisClient
*c
) {
3575 if (getGenericCommand(c
) == REDIS_ERR
) return;
3576 if (dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]) == DICT_ERR
) {
3577 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3579 incrRefCount(c
->argv
[1]);
3581 incrRefCount(c
->argv
[2]);
3583 removeExpire(c
->db
,c
->argv
[1]);
3586 static void mgetCommand(redisClient
*c
) {
3589 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
3590 for (j
= 1; j
< c
->argc
; j
++) {
3591 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
3593 addReply(c
,shared
.nullbulk
);
3595 if (o
->type
!= REDIS_STRING
) {
3596 addReply(c
,shared
.nullbulk
);
3598 addReplyBulkLen(c
,o
);
3600 addReply(c
,shared
.crlf
);
3606 static void msetGenericCommand(redisClient
*c
, int nx
) {
3607 int j
, busykeys
= 0;
3609 if ((c
->argc
% 2) == 0) {
3610 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
3613 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
3614 * set nothing at all if at least one already key exists. */
3616 for (j
= 1; j
< c
->argc
; j
+= 2) {
3617 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
3623 addReply(c
, shared
.czero
);
3627 for (j
= 1; j
< c
->argc
; j
+= 2) {
3630 tryObjectEncoding(c
->argv
[j
+1]);
3631 retval
= dictAdd(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
3632 if (retval
== DICT_ERR
) {
3633 dictReplace(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
3634 incrRefCount(c
->argv
[j
+1]);
3636 incrRefCount(c
->argv
[j
]);
3637 incrRefCount(c
->argv
[j
+1]);
3639 removeExpire(c
->db
,c
->argv
[j
]);
3641 server
.dirty
+= (c
->argc
-1)/2;
3642 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3645 static void msetCommand(redisClient
*c
) {
3646 msetGenericCommand(c
,0);
3649 static void msetnxCommand(redisClient
*c
) {
3650 msetGenericCommand(c
,1);
3653 static void incrDecrCommand(redisClient
*c
, long long incr
) {
3658 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3662 if (o
->type
!= REDIS_STRING
) {
3667 if (o
->encoding
== REDIS_ENCODING_RAW
)
3668 value
= strtoll(o
->ptr
, &eptr
, 10);
3669 else if (o
->encoding
== REDIS_ENCODING_INT
)
3670 value
= (long)o
->ptr
;
3672 redisAssert(1 != 1);
3677 o
= createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
3678 tryObjectEncoding(o
);
3679 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],o
);
3680 if (retval
== DICT_ERR
) {
3681 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
3682 removeExpire(c
->db
,c
->argv
[1]);
3684 incrRefCount(c
->argv
[1]);
3687 addReply(c
,shared
.colon
);
3689 addReply(c
,shared
.crlf
);
3692 static void incrCommand(redisClient
*c
) {
3693 incrDecrCommand(c
,1);
3696 static void decrCommand(redisClient
*c
) {
3697 incrDecrCommand(c
,-1);
3700 static void incrbyCommand(redisClient
*c
) {
3701 long long incr
= strtoll(c
->argv
[2]->ptr
, NULL
, 10);
3702 incrDecrCommand(c
,incr
);
3705 static void decrbyCommand(redisClient
*c
) {
3706 long long incr
= strtoll(c
->argv
[2]->ptr
, NULL
, 10);
3707 incrDecrCommand(c
,-incr
);
3710 static void appendCommand(redisClient
*c
) {
3715 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3717 /* Create the key */
3718 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3719 incrRefCount(c
->argv
[1]);
3720 incrRefCount(c
->argv
[2]);
3721 totlen
= stringObjectLen(c
->argv
[2]);
3725 de
= dictFind(c
->db
->dict
,c
->argv
[1]);
3728 o
= dictGetEntryVal(de
);
3729 if (o
->type
!= REDIS_STRING
) {
3730 addReply(c
,shared
.wrongtypeerr
);
3733 /* If the object is specially encoded or shared we have to make
3735 if (o
->refcount
!= 1 || o
->encoding
!= REDIS_ENCODING_RAW
) {
3736 robj
*decoded
= getDecodedObject(o
);
3738 o
= createStringObject(decoded
->ptr
, sdslen(decoded
->ptr
));
3739 decrRefCount(decoded
);
3740 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
3743 if (c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
) {
3744 o
->ptr
= sdscatlen(o
->ptr
,
3745 c
->argv
[2]->ptr
, sdslen(c
->argv
[2]->ptr
));
3747 o
->ptr
= sdscatprintf(o
->ptr
, "%ld",
3748 (unsigned long) c
->argv
[2]->ptr
);
3750 totlen
= sdslen(o
->ptr
);
3753 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen
));
3756 /* ========================= Type agnostic commands ========================= */
3758 static void delCommand(redisClient
*c
) {
3761 for (j
= 1; j
< c
->argc
; j
++) {
3762 if (deleteKey(c
->db
,c
->argv
[j
])) {
3769 addReply(c
,shared
.czero
);
3772 addReply(c
,shared
.cone
);
3775 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",deleted
));
3780 static void existsCommand(redisClient
*c
) {
3781 addReply(c
,lookupKeyRead(c
->db
,c
->argv
[1]) ? shared
.cone
: shared
.czero
);
3784 static void selectCommand(redisClient
*c
) {
3785 int id
= atoi(c
->argv
[1]->ptr
);
3787 if (selectDb(c
,id
) == REDIS_ERR
) {
3788 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
3790 addReply(c
,shared
.ok
);
3794 static void randomkeyCommand(redisClient
*c
) {
3798 de
= dictGetRandomKey(c
->db
->dict
);
3799 if (!de
|| expireIfNeeded(c
->db
,dictGetEntryKey(de
)) == 0) break;
3802 addReply(c
,shared
.plus
);
3803 addReply(c
,shared
.crlf
);
3805 addReply(c
,shared
.plus
);
3806 addReply(c
,dictGetEntryKey(de
));
3807 addReply(c
,shared
.crlf
);
3811 static void keysCommand(redisClient
*c
) {
3814 sds pattern
= c
->argv
[1]->ptr
;
3815 int plen
= sdslen(pattern
);
3816 unsigned long numkeys
= 0, keyslen
= 0;
3817 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
3819 di
= dictGetIterator(c
->db
->dict
);
3821 decrRefCount(lenobj
);
3822 while((de
= dictNext(di
)) != NULL
) {
3823 robj
*keyobj
= dictGetEntryKey(de
);
3825 sds key
= keyobj
->ptr
;
3826 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
3827 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
3828 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
3830 addReply(c
,shared
.space
);
3833 keyslen
+= sdslen(key
);
3837 dictReleaseIterator(di
);
3838 lenobj
->ptr
= sdscatprintf(sdsempty(),"$%lu\r\n",keyslen
+(numkeys
? (numkeys
-1) : 0));
3839 addReply(c
,shared
.crlf
);
3842 static void dbsizeCommand(redisClient
*c
) {
3844 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
3847 static void lastsaveCommand(redisClient
*c
) {
3849 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
3852 static void typeCommand(redisClient
*c
) {
3856 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
3861 case REDIS_STRING
: type
= "+string"; break;
3862 case REDIS_LIST
: type
= "+list"; break;
3863 case REDIS_SET
: type
= "+set"; break;
3864 case REDIS_ZSET
: type
= "+zset"; break;
3865 default: type
= "unknown"; break;
3868 addReplySds(c
,sdsnew(type
));
3869 addReply(c
,shared
.crlf
);
3872 static void saveCommand(redisClient
*c
) {
3873 if (server
.bgsavechildpid
!= -1) {
3874 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
3877 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
3878 addReply(c
,shared
.ok
);
3880 addReply(c
,shared
.err
);
3884 static void bgsaveCommand(redisClient
*c
) {
3885 if (server
.bgsavechildpid
!= -1) {
3886 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
3889 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
3890 char *status
= "+Background saving started\r\n";
3891 addReplySds(c
,sdsnew(status
));
3893 addReply(c
,shared
.err
);
3897 static void shutdownCommand(redisClient
*c
) {
3898 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
3899 /* Kill the saving child if there is a background saving in progress.
3900 We want to avoid race conditions, for instance our saving child may
3901 overwrite the synchronous saving did by SHUTDOWN. */
3902 if (server
.bgsavechildpid
!= -1) {
3903 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
3904 kill(server
.bgsavechildpid
,SIGKILL
);
3905 rdbRemoveTempFile(server
.bgsavechildpid
);
3907 if (server
.appendonly
) {
3908 /* Append only file: fsync() the AOF and exit */
3909 fsync(server
.appendfd
);
3910 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
3913 /* Snapshotting. Perform a SYNC SAVE and exit */
3914 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
3915 if (server
.daemonize
)
3916 unlink(server
.pidfile
);
3917 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
3918 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
3919 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
3922 /* Ooops.. error saving! The best we can do is to continue operating.
3923 * Note that if there was a background saving process, in the next
3924 * cron() Redis will be notified that the background saving aborted,
3925 * handling special stuff like slaves pending for synchronization... */
3926 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
3927 addReplySds(c
,sdsnew("-ERR can't quit, problems saving the DB\r\n"));
3932 static void renameGenericCommand(redisClient
*c
, int nx
) {
3935 /* To use the same key as src and dst is probably an error */
3936 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
3937 addReply(c
,shared
.sameobjecterr
);
3941 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3943 addReply(c
,shared
.nokeyerr
);
3947 deleteIfVolatile(c
->db
,c
->argv
[2]);
3948 if (dictAdd(c
->db
->dict
,c
->argv
[2],o
) == DICT_ERR
) {
3951 addReply(c
,shared
.czero
);
3954 dictReplace(c
->db
->dict
,c
->argv
[2],o
);
3956 incrRefCount(c
->argv
[2]);
3958 deleteKey(c
->db
,c
->argv
[1]);
3960 addReply(c
,nx
? shared
.cone
: shared
.ok
);
3963 static void renameCommand(redisClient
*c
) {
3964 renameGenericCommand(c
,0);
3967 static void renamenxCommand(redisClient
*c
) {
3968 renameGenericCommand(c
,1);
3971 static void moveCommand(redisClient
*c
) {
3976 /* Obtain source and target DB pointers */
3979 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
3980 addReply(c
,shared
.outofrangeerr
);
3984 selectDb(c
,srcid
); /* Back to the source DB */
3986 /* If the user is moving using as target the same
3987 * DB as the source DB it is probably an error. */
3989 addReply(c
,shared
.sameobjecterr
);
3993 /* Check if the element exists and get a reference */
3994 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3996 addReply(c
,shared
.czero
);
4000 /* Try to add the element to the target DB */
4001 deleteIfVolatile(dst
,c
->argv
[1]);
4002 if (dictAdd(dst
->dict
,c
->argv
[1],o
) == DICT_ERR
) {
4003 addReply(c
,shared
.czero
);
4006 incrRefCount(c
->argv
[1]);
4009 /* OK! key moved, free the entry in the source DB */
4010 deleteKey(src
,c
->argv
[1]);
4012 addReply(c
,shared
.cone
);
4015 /* =================================== Lists ================================ */
4016 static void pushGenericCommand(redisClient
*c
, int where
) {
4020 lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4022 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4023 addReply(c
,shared
.ok
);
4026 lobj
= createListObject();
4028 if (where
== REDIS_HEAD
) {
4029 listAddNodeHead(list
,c
->argv
[2]);
4031 listAddNodeTail(list
,c
->argv
[2]);
4033 dictAdd(c
->db
->dict
,c
->argv
[1],lobj
);
4034 incrRefCount(c
->argv
[1]);
4035 incrRefCount(c
->argv
[2]);
4037 if (lobj
->type
!= REDIS_LIST
) {
4038 addReply(c
,shared
.wrongtypeerr
);
4041 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4042 addReply(c
,shared
.ok
);
4046 if (where
== REDIS_HEAD
) {
4047 listAddNodeHead(list
,c
->argv
[2]);
4049 listAddNodeTail(list
,c
->argv
[2]);
4051 incrRefCount(c
->argv
[2]);
4054 addReply(c
,shared
.ok
);
4057 static void lpushCommand(redisClient
*c
) {
4058 pushGenericCommand(c
,REDIS_HEAD
);
4061 static void rpushCommand(redisClient
*c
) {
4062 pushGenericCommand(c
,REDIS_TAIL
);
4065 static void llenCommand(redisClient
*c
) {
4069 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4071 addReply(c
,shared
.czero
);
4074 if (o
->type
!= REDIS_LIST
) {
4075 addReply(c
,shared
.wrongtypeerr
);
4078 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",listLength(l
)));
4083 static void lindexCommand(redisClient
*c
) {
4085 int index
= atoi(c
->argv
[2]->ptr
);
4087 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4089 addReply(c
,shared
.nullbulk
);
4091 if (o
->type
!= REDIS_LIST
) {
4092 addReply(c
,shared
.wrongtypeerr
);
4094 list
*list
= o
->ptr
;
4097 ln
= listIndex(list
, index
);
4099 addReply(c
,shared
.nullbulk
);
4101 robj
*ele
= listNodeValue(ln
);
4102 addReplyBulkLen(c
,ele
);
4104 addReply(c
,shared
.crlf
);
4110 static void lsetCommand(redisClient
*c
) {
4112 int index
= atoi(c
->argv
[2]->ptr
);
4114 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4116 addReply(c
,shared
.nokeyerr
);
4118 if (o
->type
!= REDIS_LIST
) {
4119 addReply(c
,shared
.wrongtypeerr
);
4121 list
*list
= o
->ptr
;
4124 ln
= listIndex(list
, index
);
4126 addReply(c
,shared
.outofrangeerr
);
4128 robj
*ele
= listNodeValue(ln
);
4131 listNodeValue(ln
) = c
->argv
[3];
4132 incrRefCount(c
->argv
[3]);
4133 addReply(c
,shared
.ok
);
4140 static void popGenericCommand(redisClient
*c
, int where
) {
4143 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4145 addReply(c
,shared
.nullbulk
);
4147 if (o
->type
!= REDIS_LIST
) {
4148 addReply(c
,shared
.wrongtypeerr
);
4150 list
*list
= o
->ptr
;
4153 if (where
== REDIS_HEAD
)
4154 ln
= listFirst(list
);
4156 ln
= listLast(list
);
4159 addReply(c
,shared
.nullbulk
);
4161 robj
*ele
= listNodeValue(ln
);
4162 addReplyBulkLen(c
,ele
);
4164 addReply(c
,shared
.crlf
);
4165 listDelNode(list
,ln
);
4172 static void lpopCommand(redisClient
*c
) {
4173 popGenericCommand(c
,REDIS_HEAD
);
4176 static void rpopCommand(redisClient
*c
) {
4177 popGenericCommand(c
,REDIS_TAIL
);
4180 static void lrangeCommand(redisClient
*c
) {
4182 int start
= atoi(c
->argv
[2]->ptr
);
4183 int end
= atoi(c
->argv
[3]->ptr
);
4185 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4187 addReply(c
,shared
.nullmultibulk
);
4189 if (o
->type
!= REDIS_LIST
) {
4190 addReply(c
,shared
.wrongtypeerr
);
4192 list
*list
= o
->ptr
;
4194 int llen
= listLength(list
);
4198 /* convert negative indexes */
4199 if (start
< 0) start
= llen
+start
;
4200 if (end
< 0) end
= llen
+end
;
4201 if (start
< 0) start
= 0;
4202 if (end
< 0) end
= 0;
4204 /* indexes sanity checks */
4205 if (start
> end
|| start
>= llen
) {
4206 /* Out of range start or start > end result in empty list */
4207 addReply(c
,shared
.emptymultibulk
);
4210 if (end
>= llen
) end
= llen
-1;
4211 rangelen
= (end
-start
)+1;
4213 /* Return the result in form of a multi-bulk reply */
4214 ln
= listIndex(list
, start
);
4215 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
4216 for (j
= 0; j
< rangelen
; j
++) {
4217 ele
= listNodeValue(ln
);
4218 addReplyBulkLen(c
,ele
);
4220 addReply(c
,shared
.crlf
);
4227 static void ltrimCommand(redisClient
*c
) {
4229 int start
= atoi(c
->argv
[2]->ptr
);
4230 int end
= atoi(c
->argv
[3]->ptr
);
4232 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4234 addReply(c
,shared
.ok
);
4236 if (o
->type
!= REDIS_LIST
) {
4237 addReply(c
,shared
.wrongtypeerr
);
4239 list
*list
= o
->ptr
;
4241 int llen
= listLength(list
);
4242 int j
, ltrim
, rtrim
;
4244 /* convert negative indexes */
4245 if (start
< 0) start
= llen
+start
;
4246 if (end
< 0) end
= llen
+end
;
4247 if (start
< 0) start
= 0;
4248 if (end
< 0) end
= 0;
4250 /* indexes sanity checks */
4251 if (start
> end
|| start
>= llen
) {
4252 /* Out of range start or start > end result in empty list */
4256 if (end
>= llen
) end
= llen
-1;
4261 /* Remove list elements to perform the trim */
4262 for (j
= 0; j
< ltrim
; j
++) {
4263 ln
= listFirst(list
);
4264 listDelNode(list
,ln
);
4266 for (j
= 0; j
< rtrim
; j
++) {
4267 ln
= listLast(list
);
4268 listDelNode(list
,ln
);
4271 addReply(c
,shared
.ok
);
4276 static void lremCommand(redisClient
*c
) {
4279 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4281 addReply(c
,shared
.czero
);
4283 if (o
->type
!= REDIS_LIST
) {
4284 addReply(c
,shared
.wrongtypeerr
);
4286 list
*list
= o
->ptr
;
4287 listNode
*ln
, *next
;
4288 int toremove
= atoi(c
->argv
[2]->ptr
);
4293 toremove
= -toremove
;
4296 ln
= fromtail
? list
->tail
: list
->head
;
4298 robj
*ele
= listNodeValue(ln
);
4300 next
= fromtail
? ln
->prev
: ln
->next
;
4301 if (compareStringObjects(ele
,c
->argv
[3]) == 0) {
4302 listDelNode(list
,ln
);
4305 if (toremove
&& removed
== toremove
) break;
4309 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
4314 /* This is the semantic of this command:
4315 * RPOPLPUSH srclist dstlist:
4316 * IF LLEN(srclist) > 0
4317 * element = RPOP srclist
4318 * LPUSH dstlist element
4325 * The idea is to be able to get an element from a list in a reliable way
4326 * since the element is not just returned but pushed against another list
4327 * as well. This command was originally proposed by Ezra Zygmuntowicz.
4329 static void rpoplpushcommand(redisClient
*c
) {
4332 sobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4334 addReply(c
,shared
.nullbulk
);
4336 if (sobj
->type
!= REDIS_LIST
) {
4337 addReply(c
,shared
.wrongtypeerr
);
4339 list
*srclist
= sobj
->ptr
;
4340 listNode
*ln
= listLast(srclist
);
4343 addReply(c
,shared
.nullbulk
);
4345 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4346 robj
*ele
= listNodeValue(ln
);
4349 if (dobj
&& dobj
->type
!= REDIS_LIST
) {
4350 addReply(c
,shared
.wrongtypeerr
);
4354 /* Add the element to the target list (unless it's directly
4355 * passed to some BLPOP-ing client */
4356 if (!handleClientsWaitingListPush(c
,c
->argv
[2],ele
)) {
4358 /* Create the list if the key does not exist */
4359 dobj
= createListObject();
4360 dictAdd(c
->db
->dict
,c
->argv
[2],dobj
);
4361 incrRefCount(c
->argv
[2]);
4363 dstlist
= dobj
->ptr
;
4364 listAddNodeHead(dstlist
,ele
);
4368 /* Send the element to the client as reply as well */
4369 addReplyBulkLen(c
,ele
);
4371 addReply(c
,shared
.crlf
);
4373 /* Finally remove the element from the source list */
4374 listDelNode(srclist
,ln
);
4382 /* ==================================== Sets ================================ */
4384 static void saddCommand(redisClient
*c
) {
4387 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4389 set
= createSetObject();
4390 dictAdd(c
->db
->dict
,c
->argv
[1],set
);
4391 incrRefCount(c
->argv
[1]);
4393 if (set
->type
!= REDIS_SET
) {
4394 addReply(c
,shared
.wrongtypeerr
);
4398 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
4399 incrRefCount(c
->argv
[2]);
4401 addReply(c
,shared
.cone
);
4403 addReply(c
,shared
.czero
);
4407 static void sremCommand(redisClient
*c
) {
4410 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4412 addReply(c
,shared
.czero
);
4414 if (set
->type
!= REDIS_SET
) {
4415 addReply(c
,shared
.wrongtypeerr
);
4418 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
4420 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4421 addReply(c
,shared
.cone
);
4423 addReply(c
,shared
.czero
);
4428 static void smoveCommand(redisClient
*c
) {
4429 robj
*srcset
, *dstset
;
4431 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4432 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4434 /* If the source key does not exist return 0, if it's of the wrong type
4436 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
4437 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
4440 /* Error if the destination key is not a set as well */
4441 if (dstset
&& dstset
->type
!= REDIS_SET
) {
4442 addReply(c
,shared
.wrongtypeerr
);
4445 /* Remove the element from the source set */
4446 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
4447 /* Key not found in the src set! return zero */
4448 addReply(c
,shared
.czero
);
4452 /* Add the element to the destination set */
4454 dstset
= createSetObject();
4455 dictAdd(c
->db
->dict
,c
->argv
[2],dstset
);
4456 incrRefCount(c
->argv
[2]);
4458 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
4459 incrRefCount(c
->argv
[3]);
4460 addReply(c
,shared
.cone
);
4463 static void sismemberCommand(redisClient
*c
) {
4466 set
= lookupKeyRead(c
->db
,c
->argv
[1]);
4468 addReply(c
,shared
.czero
);
4470 if (set
->type
!= REDIS_SET
) {
4471 addReply(c
,shared
.wrongtypeerr
);
4474 if (dictFind(set
->ptr
,c
->argv
[2]))
4475 addReply(c
,shared
.cone
);
4477 addReply(c
,shared
.czero
);
4481 static void scardCommand(redisClient
*c
) {
4485 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4487 addReply(c
,shared
.czero
);
4490 if (o
->type
!= REDIS_SET
) {
4491 addReply(c
,shared
.wrongtypeerr
);
4494 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4500 static void spopCommand(redisClient
*c
) {
4504 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4506 addReply(c
,shared
.nullbulk
);
4508 if (set
->type
!= REDIS_SET
) {
4509 addReply(c
,shared
.wrongtypeerr
);
4512 de
= dictGetRandomKey(set
->ptr
);
4514 addReply(c
,shared
.nullbulk
);
4516 robj
*ele
= dictGetEntryKey(de
);
4518 addReplyBulkLen(c
,ele
);
4520 addReply(c
,shared
.crlf
);
4521 dictDelete(set
->ptr
,ele
);
4522 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4528 static void srandmemberCommand(redisClient
*c
) {
4532 set
= lookupKeyRead(c
->db
,c
->argv
[1]);
4534 addReply(c
,shared
.nullbulk
);
4536 if (set
->type
!= REDIS_SET
) {
4537 addReply(c
,shared
.wrongtypeerr
);
4540 de
= dictGetRandomKey(set
->ptr
);
4542 addReply(c
,shared
.nullbulk
);
4544 robj
*ele
= dictGetEntryKey(de
);
4546 addReplyBulkLen(c
,ele
);
4548 addReply(c
,shared
.crlf
);
4553 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
4554 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
4556 return dictSize(*d1
)-dictSize(*d2
);
4559 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
4560 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4563 robj
*lenobj
= NULL
, *dstset
= NULL
;
4564 unsigned long j
, cardinality
= 0;
4566 for (j
= 0; j
< setsnum
; j
++) {
4570 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4571 lookupKeyRead(c
->db
,setskeys
[j
]);
4575 if (deleteKey(c
->db
,dstkey
))
4577 addReply(c
,shared
.czero
);
4579 addReply(c
,shared
.nullmultibulk
);
4583 if (setobj
->type
!= REDIS_SET
) {
4585 addReply(c
,shared
.wrongtypeerr
);
4588 dv
[j
] = setobj
->ptr
;
4590 /* Sort sets from the smallest to largest, this will improve our
4591 * algorithm's performace */
4592 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
4594 /* The first thing we should output is the total number of elements...
4595 * since this is a multi-bulk write, but at this stage we don't know
4596 * the intersection set size, so we use a trick, append an empty object
4597 * to the output list and save the pointer to later modify it with the
4600 lenobj
= createObject(REDIS_STRING
,NULL
);
4602 decrRefCount(lenobj
);
4604 /* If we have a target key where to store the resulting set
4605 * create this key with an empty set inside */
4606 dstset
= createSetObject();
4609 /* Iterate all the elements of the first (smallest) set, and test
4610 * the element against all the other sets, if at least one set does
4611 * not include the element it is discarded */
4612 di
= dictGetIterator(dv
[0]);
4614 while((de
= dictNext(di
)) != NULL
) {
4617 for (j
= 1; j
< setsnum
; j
++)
4618 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
4620 continue; /* at least one set does not contain the member */
4621 ele
= dictGetEntryKey(de
);
4623 addReplyBulkLen(c
,ele
);
4625 addReply(c
,shared
.crlf
);
4628 dictAdd(dstset
->ptr
,ele
,NULL
);
4632 dictReleaseIterator(di
);
4635 /* Store the resulting set into the target */
4636 deleteKey(c
->db
,dstkey
);
4637 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4638 incrRefCount(dstkey
);
4642 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
4644 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4645 dictSize((dict
*)dstset
->ptr
)));
4651 static void sinterCommand(redisClient
*c
) {
4652 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
4655 static void sinterstoreCommand(redisClient
*c
) {
4656 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
4659 #define REDIS_OP_UNION 0
4660 #define REDIS_OP_DIFF 1
4662 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
4663 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4666 robj
*dstset
= NULL
;
4667 int j
, cardinality
= 0;
4669 for (j
= 0; j
< setsnum
; j
++) {
4673 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4674 lookupKeyRead(c
->db
,setskeys
[j
]);
4679 if (setobj
->type
!= REDIS_SET
) {
4681 addReply(c
,shared
.wrongtypeerr
);
4684 dv
[j
] = setobj
->ptr
;
4687 /* We need a temp set object to store our union. If the dstkey
4688 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
4689 * this set object will be the resulting object to set into the target key*/
4690 dstset
= createSetObject();
4692 /* Iterate all the elements of all the sets, add every element a single
4693 * time to the result set */
4694 for (j
= 0; j
< setsnum
; j
++) {
4695 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
4696 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
4698 di
= dictGetIterator(dv
[j
]);
4700 while((de
= dictNext(di
)) != NULL
) {
4703 /* dictAdd will not add the same element multiple times */
4704 ele
= dictGetEntryKey(de
);
4705 if (op
== REDIS_OP_UNION
|| j
== 0) {
4706 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
4710 } else if (op
== REDIS_OP_DIFF
) {
4711 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
4716 dictReleaseIterator(di
);
4718 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break; /* result set is empty */
4721 /* Output the content of the resulting set, if not in STORE mode */
4723 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
4724 di
= dictGetIterator(dstset
->ptr
);
4725 while((de
= dictNext(di
)) != NULL
) {
4728 ele
= dictGetEntryKey(de
);
4729 addReplyBulkLen(c
,ele
);
4731 addReply(c
,shared
.crlf
);
4733 dictReleaseIterator(di
);
4735 /* If we have a target key where to store the resulting set
4736 * create this key with the result set inside */
4737 deleteKey(c
->db
,dstkey
);
4738 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4739 incrRefCount(dstkey
);
4744 decrRefCount(dstset
);
4746 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4747 dictSize((dict
*)dstset
->ptr
)));
4753 static void sunionCommand(redisClient
*c
) {
4754 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
4757 static void sunionstoreCommand(redisClient
*c
) {
4758 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
4761 static void sdiffCommand(redisClient
*c
) {
4762 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
4765 static void sdiffstoreCommand(redisClient
*c
) {
4766 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
4769 /* ==================================== ZSets =============================== */
4771 /* ZSETs are ordered sets using two data structures to hold the same elements
4772 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
4775 * The elements are added to an hash table mapping Redis objects to scores.
4776 * At the same time the elements are added to a skip list mapping scores
4777 * to Redis objects (so objects are sorted by scores in this "view"). */
4779 /* This skiplist implementation is almost a C translation of the original
4780 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
4781 * Alternative to Balanced Trees", modified in three ways:
4782 * a) this implementation allows for repeated values.
4783 * b) the comparison is not just by key (our 'score') but by satellite data.
4784 * c) there is a back pointer, so it's a doubly linked list with the back
4785 * pointers being only at "level 1". This allows to traverse the list
4786 * from tail to head, useful for ZREVRANGE. */
4788 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
4789 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
4791 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
4797 static zskiplist
*zslCreate(void) {
4801 zsl
= zmalloc(sizeof(*zsl
));
4804 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
4805 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++)
4806 zsl
->header
->forward
[j
] = NULL
;
4807 zsl
->header
->backward
= NULL
;
4812 static void zslFreeNode(zskiplistNode
*node
) {
4813 decrRefCount(node
->obj
);
4814 zfree(node
->forward
);
4818 static void zslFree(zskiplist
*zsl
) {
4819 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
4821 zfree(zsl
->header
->forward
);
4824 next
= node
->forward
[0];
4831 static int zslRandomLevel(void) {
4833 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
4838 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
4839 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
4843 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4844 while (x
->forward
[i
] &&
4845 (x
->forward
[i
]->score
< score
||
4846 (x
->forward
[i
]->score
== score
&&
4847 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
4851 /* we assume the key is not already inside, since we allow duplicated
4852 * scores, and the re-insertion of score and redis object should never
4853 * happpen since the caller of zslInsert() should test in the hash table
4854 * if the element is already inside or not. */
4855 level
= zslRandomLevel();
4856 if (level
> zsl
->level
) {
4857 for (i
= zsl
->level
; i
< level
; i
++)
4858 update
[i
] = zsl
->header
;
4861 x
= zslCreateNode(level
,score
,obj
);
4862 for (i
= 0; i
< level
; i
++) {
4863 x
->forward
[i
] = update
[i
]->forward
[i
];
4864 update
[i
]->forward
[i
] = x
;
4866 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
4868 x
->forward
[0]->backward
= x
;
4874 /* Delete an element with matching score/object from the skiplist. */
4875 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
4876 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
4880 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4881 while (x
->forward
[i
] &&
4882 (x
->forward
[i
]->score
< score
||
4883 (x
->forward
[i
]->score
== score
&&
4884 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
4888 /* We may have multiple elements with the same score, what we need
4889 * is to find the element with both the right score and object. */
4891 if (x
&& score
== x
->score
&& compareStringObjects(x
->obj
,obj
) == 0) {
4892 for (i
= 0; i
< zsl
->level
; i
++) {
4893 if (update
[i
]->forward
[i
] != x
) break;
4894 update
[i
]->forward
[i
] = x
->forward
[i
];
4896 if (x
->forward
[0]) {
4897 x
->forward
[0]->backward
= (x
->backward
== zsl
->header
) ?
4900 zsl
->tail
= x
->backward
;
4903 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
4908 return 0; /* not found */
4910 return 0; /* not found */
4913 /* Delete all the elements with score between min and max from the skiplist.
4914 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
4915 * Note that this function takes the reference to the hash table view of the
4916 * sorted set, in order to remove the elements from the hash table too. */
4917 static unsigned long zslDeleteRange(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
4918 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
4919 unsigned long removed
= 0;
4923 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4924 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
4928 /* We may have multiple elements with the same score, what we need
4929 * is to find the element with both the right score and object. */
4931 while (x
&& x
->score
<= max
) {
4932 zskiplistNode
*next
;
4934 for (i
= 0; i
< zsl
->level
; i
++) {
4935 if (update
[i
]->forward
[i
] != x
) break;
4936 update
[i
]->forward
[i
] = x
->forward
[i
];
4938 if (x
->forward
[0]) {
4939 x
->forward
[0]->backward
= (x
->backward
== zsl
->header
) ?
4942 zsl
->tail
= x
->backward
;
4944 next
= x
->forward
[0];
4945 dictDelete(dict
,x
->obj
);
4947 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
4953 return removed
; /* not found */
4956 /* Find the first node having a score equal or greater than the specified one.
4957 * Returns NULL if there is no match. */
4958 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
4963 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4964 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
4967 /* We may have multiple elements with the same score, what we need
4968 * is to find the element with both the right score and object. */
4969 return x
->forward
[0];
4972 /* The actual Z-commands implementations */
4974 /* This generic command implements both ZADD and ZINCRBY.
4975 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
4976 * the increment if the operation is a ZINCRBY (doincrement == 1). */
4977 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
4982 zsetobj
= lookupKeyWrite(c
->db
,key
);
4983 if (zsetobj
== NULL
) {
4984 zsetobj
= createZsetObject();
4985 dictAdd(c
->db
->dict
,key
,zsetobj
);
4988 if (zsetobj
->type
!= REDIS_ZSET
) {
4989 addReply(c
,shared
.wrongtypeerr
);
4995 /* Ok now since we implement both ZADD and ZINCRBY here the code
4996 * needs to handle the two different conditions. It's all about setting
4997 * '*score', that is, the new score to set, to the right value. */
4998 score
= zmalloc(sizeof(double));
5002 /* Read the old score. If the element was not present starts from 0 */
5003 de
= dictFind(zs
->dict
,ele
);
5005 double *oldscore
= dictGetEntryVal(de
);
5006 *score
= *oldscore
+ scoreval
;
5014 /* What follows is a simple remove and re-insert operation that is common
5015 * to both ZADD and ZINCRBY... */
5016 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
5017 /* case 1: New element */
5018 incrRefCount(ele
); /* added to hash */
5019 zslInsert(zs
->zsl
,*score
,ele
);
5020 incrRefCount(ele
); /* added to skiplist */
5023 addReplyDouble(c
,*score
);
5025 addReply(c
,shared
.cone
);
5030 /* case 2: Score update operation */
5031 de
= dictFind(zs
->dict
,ele
);
5032 redisAssert(de
!= NULL
);
5033 oldscore
= dictGetEntryVal(de
);
5034 if (*score
!= *oldscore
) {
5037 /* Remove and insert the element in the skip list with new score */
5038 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
5039 redisAssert(deleted
!= 0);
5040 zslInsert(zs
->zsl
,*score
,ele
);
5042 /* Update the score in the hash table */
5043 dictReplace(zs
->dict
,ele
,score
);
5049 addReplyDouble(c
,*score
);
5051 addReply(c
,shared
.czero
);
5055 static void zaddCommand(redisClient
*c
) {
5058 scoreval
= strtod(c
->argv
[2]->ptr
,NULL
);
5059 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
5062 static void zincrbyCommand(redisClient
*c
) {
5065 scoreval
= strtod(c
->argv
[2]->ptr
,NULL
);
5066 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
5069 static void zremCommand(redisClient
*c
) {
5073 zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5074 if (zsetobj
== NULL
) {
5075 addReply(c
,shared
.czero
);
5081 if (zsetobj
->type
!= REDIS_ZSET
) {
5082 addReply(c
,shared
.wrongtypeerr
);
5086 de
= dictFind(zs
->dict
,c
->argv
[2]);
5088 addReply(c
,shared
.czero
);
5091 /* Delete from the skiplist */
5092 oldscore
= dictGetEntryVal(de
);
5093 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
5094 redisAssert(deleted
!= 0);
5096 /* Delete from the hash table */
5097 dictDelete(zs
->dict
,c
->argv
[2]);
5098 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5100 addReply(c
,shared
.cone
);
5104 static void zremrangebyscoreCommand(redisClient
*c
) {
5105 double min
= strtod(c
->argv
[2]->ptr
,NULL
);
5106 double max
= strtod(c
->argv
[3]->ptr
,NULL
);
5110 zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5111 if (zsetobj
== NULL
) {
5112 addReply(c
,shared
.czero
);
5116 if (zsetobj
->type
!= REDIS_ZSET
) {
5117 addReply(c
,shared
.wrongtypeerr
);
5121 deleted
= zslDeleteRange(zs
->zsl
,min
,max
,zs
->dict
);
5122 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5123 server
.dirty
+= deleted
;
5124 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",deleted
));
5128 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
5130 int start
= atoi(c
->argv
[2]->ptr
);
5131 int end
= atoi(c
->argv
[3]->ptr
);
5134 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
5136 } else if (c
->argc
>= 5) {
5137 addReply(c
,shared
.syntaxerr
);
5141 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5143 addReply(c
,shared
.nullmultibulk
);
5145 if (o
->type
!= REDIS_ZSET
) {
5146 addReply(c
,shared
.wrongtypeerr
);
5148 zset
*zsetobj
= o
->ptr
;
5149 zskiplist
*zsl
= zsetobj
->zsl
;
5152 int llen
= zsl
->length
;
5156 /* convert negative indexes */
5157 if (start
< 0) start
= llen
+start
;
5158 if (end
< 0) end
= llen
+end
;
5159 if (start
< 0) start
= 0;
5160 if (end
< 0) end
= 0;
5162 /* indexes sanity checks */
5163 if (start
> end
|| start
>= llen
) {
5164 /* Out of range start or start > end result in empty list */
5165 addReply(c
,shared
.emptymultibulk
);
5168 if (end
>= llen
) end
= llen
-1;
5169 rangelen
= (end
-start
)+1;
5171 /* Return the result in form of a multi-bulk reply */
5177 ln
= zsl
->header
->forward
[0];
5179 ln
= ln
->forward
[0];
5182 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
5183 withscores
? (rangelen
*2) : rangelen
));
5184 for (j
= 0; j
< rangelen
; j
++) {
5186 addReplyBulkLen(c
,ele
);
5188 addReply(c
,shared
.crlf
);
5190 addReplyDouble(c
,ln
->score
);
5191 ln
= reverse
? ln
->backward
: ln
->forward
[0];
5197 static void zrangeCommand(redisClient
*c
) {
5198 zrangeGenericCommand(c
,0);
5201 static void zrevrangeCommand(redisClient
*c
) {
5202 zrangeGenericCommand(c
,1);
5205 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
5206 * If justcount is non-zero, just the count is returned. */
5207 static void genericZrangebyscoreCommand(redisClient
*c
, int justcount
) {
5210 int minex
= 0, maxex
= 0; /* are min or max exclusive? */
5211 int offset
= 0, limit
= -1;
5215 /* Parse the min-max interval. If one of the values is prefixed
5216 * by the "(" character, it's considered "open". For instance
5217 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
5218 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
5219 if (((char*)c
->argv
[2]->ptr
)[0] == '(') {
5220 min
= strtod((char*)c
->argv
[2]->ptr
+1,NULL
);
5223 min
= strtod(c
->argv
[2]->ptr
,NULL
);
5225 if (((char*)c
->argv
[3]->ptr
)[0] == '(') {
5226 max
= strtod((char*)c
->argv
[3]->ptr
+1,NULL
);
5229 max
= strtod(c
->argv
[3]->ptr
,NULL
);
5232 /* Parse "WITHSCORES": note that if the command was called with
5233 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
5234 * enter the following paths to parse WITHSCORES and LIMIT. */
5235 if (c
->argc
== 5 || c
->argc
== 8) {
5236 if (strcasecmp(c
->argv
[c
->argc
-1]->ptr
,"withscores") == 0)
5241 if (c
->argc
!= (4 + withscores
) && c
->argc
!= (7 + withscores
))
5245 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
5250 if (c
->argc
== (7 + withscores
) && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
5251 addReply(c
,shared
.syntaxerr
);
5253 } else if (c
->argc
== (7 + withscores
)) {
5254 offset
= atoi(c
->argv
[5]->ptr
);
5255 limit
= atoi(c
->argv
[6]->ptr
);
5256 if (offset
< 0) offset
= 0;
5259 /* Ok, lookup the key and get the range */
5260 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5262 addReply(c
,justcount
? shared
.czero
: shared
.nullmultibulk
);
5264 if (o
->type
!= REDIS_ZSET
) {
5265 addReply(c
,shared
.wrongtypeerr
);
5267 zset
*zsetobj
= o
->ptr
;
5268 zskiplist
*zsl
= zsetobj
->zsl
;
5270 robj
*ele
, *lenobj
= NULL
;
5271 unsigned long rangelen
= 0;
5273 /* Get the first node with the score >= min, or with
5274 * score > min if 'minex' is true. */
5275 ln
= zslFirstWithScore(zsl
,min
);
5276 while (minex
&& ln
&& ln
->score
== min
) ln
= ln
->forward
[0];
5279 /* No element matching the speciifed interval */
5280 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
5284 /* We don't know in advance how many matching elements there
5285 * are in the list, so we push this object that will represent
5286 * the multi-bulk length in the output buffer, and will "fix"
5289 lenobj
= createObject(REDIS_STRING
,NULL
);
5291 decrRefCount(lenobj
);
5294 while(ln
&& (maxex
? (ln
->score
< max
) : (ln
->score
<= max
))) {
5297 ln
= ln
->forward
[0];
5300 if (limit
== 0) break;
5303 addReplyBulkLen(c
,ele
);
5305 addReply(c
,shared
.crlf
);
5307 addReplyDouble(c
,ln
->score
);
5309 ln
= ln
->forward
[0];
5311 if (limit
> 0) limit
--;
5314 addReplyLong(c
,(long)rangelen
);
5316 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",
5317 withscores
? (rangelen
*2) : rangelen
);
5323 static void zrangebyscoreCommand(redisClient
*c
) {
5324 genericZrangebyscoreCommand(c
,0);
5327 static void zcountCommand(redisClient
*c
) {
5328 genericZrangebyscoreCommand(c
,1);
5331 static void zcardCommand(redisClient
*c
) {
5335 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5337 addReply(c
,shared
.czero
);
5340 if (o
->type
!= REDIS_ZSET
) {
5341 addReply(c
,shared
.wrongtypeerr
);
5344 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",zs
->zsl
->length
));
5349 static void zscoreCommand(redisClient
*c
) {
5353 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5355 addReply(c
,shared
.nullbulk
);
5358 if (o
->type
!= REDIS_ZSET
) {
5359 addReply(c
,shared
.wrongtypeerr
);
5364 de
= dictFind(zs
->dict
,c
->argv
[2]);
5366 addReply(c
,shared
.nullbulk
);
5368 double *score
= dictGetEntryVal(de
);
5370 addReplyDouble(c
,*score
);
5376 /* ========================= Non type-specific commands ==================== */
5378 static void flushdbCommand(redisClient
*c
) {
5379 server
.dirty
+= dictSize(c
->db
->dict
);
5380 dictEmpty(c
->db
->dict
);
5381 dictEmpty(c
->db
->expires
);
5382 addReply(c
,shared
.ok
);
5385 static void flushallCommand(redisClient
*c
) {
5386 server
.dirty
+= emptyDb();
5387 addReply(c
,shared
.ok
);
5388 rdbSave(server
.dbfilename
);
5392 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
5393 redisSortOperation
*so
= zmalloc(sizeof(*so
));
5395 so
->pattern
= pattern
;
5399 /* Return the value associated to the key with a name obtained
5400 * substituting the first occurence of '*' in 'pattern' with 'subst' */
5401 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
5405 int prefixlen
, sublen
, postfixlen
;
5406 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
5410 char buf
[REDIS_SORTKEY_MAX
+1];
5413 /* If the pattern is "#" return the substitution object itself in order
5414 * to implement the "SORT ... GET #" feature. */
5415 spat
= pattern
->ptr
;
5416 if (spat
[0] == '#' && spat
[1] == '\0') {
5420 /* The substitution object may be specially encoded. If so we create
5421 * a decoded object on the fly. Otherwise getDecodedObject will just
5422 * increment the ref count, that we'll decrement later. */
5423 subst
= getDecodedObject(subst
);
5426 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
5427 p
= strchr(spat
,'*');
5429 decrRefCount(subst
);
5434 sublen
= sdslen(ssub
);
5435 postfixlen
= sdslen(spat
)-(prefixlen
+1);
5436 memcpy(keyname
.buf
,spat
,prefixlen
);
5437 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
5438 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
5439 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
5440 keyname
.len
= prefixlen
+sublen
+postfixlen
;
5442 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2))
5443 decrRefCount(subst
);
5445 /* printf("lookup '%s' => %p\n", keyname.buf,de); */
5446 return lookupKeyRead(db
,&keyobj
);
5449 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
5450 * the additional parameter is not standard but a BSD-specific we have to
5451 * pass sorting parameters via the global 'server' structure */
5452 static int sortCompare(const void *s1
, const void *s2
) {
5453 const redisSortObject
*so1
= s1
, *so2
= s2
;
5456 if (!server
.sort_alpha
) {
5457 /* Numeric sorting. Here it's trivial as we precomputed scores */
5458 if (so1
->u
.score
> so2
->u
.score
) {
5460 } else if (so1
->u
.score
< so2
->u
.score
) {
5466 /* Alphanumeric sorting */
5467 if (server
.sort_bypattern
) {
5468 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
5469 /* At least one compare object is NULL */
5470 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
5472 else if (so1
->u
.cmpobj
== NULL
)
5477 /* We have both the objects, use strcoll */
5478 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
5481 /* Compare elements directly */
5484 dec1
= getDecodedObject(so1
->obj
);
5485 dec2
= getDecodedObject(so2
->obj
);
5486 cmp
= strcoll(dec1
->ptr
,dec2
->ptr
);
5491 return server
.sort_desc
? -cmp
: cmp
;
5494 /* The SORT command is the most complex command in Redis. Warning: this code
5495 * is optimized for speed and a bit less for readability */
5496 static void sortCommand(redisClient
*c
) {
5499 int desc
= 0, alpha
= 0;
5500 int limit_start
= 0, limit_count
= -1, start
, end
;
5501 int j
, dontsort
= 0, vectorlen
;
5502 int getop
= 0; /* GET operation counter */
5503 robj
*sortval
, *sortby
= NULL
, *storekey
= NULL
;
5504 redisSortObject
*vector
; /* Resulting vector to sort */
5506 /* Lookup the key to sort. It must be of the right types */
5507 sortval
= lookupKeyRead(c
->db
,c
->argv
[1]);
5508 if (sortval
== NULL
) {
5509 addReply(c
,shared
.nullmultibulk
);
5512 if (sortval
->type
!= REDIS_SET
&& sortval
->type
!= REDIS_LIST
&&
5513 sortval
->type
!= REDIS_ZSET
)
5515 addReply(c
,shared
.wrongtypeerr
);
5519 /* Create a list of operations to perform for every sorted element.
5520 * Operations can be GET/DEL/INCR/DECR */
5521 operations
= listCreate();
5522 listSetFreeMethod(operations
,zfree
);
5525 /* Now we need to protect sortval incrementing its count, in the future
5526 * SORT may have options able to overwrite/delete keys during the sorting
5527 * and the sorted key itself may get destroied */
5528 incrRefCount(sortval
);
5530 /* The SORT command has an SQL-alike syntax, parse it */
5531 while(j
< c
->argc
) {
5532 int leftargs
= c
->argc
-j
-1;
5533 if (!strcasecmp(c
->argv
[j
]->ptr
,"asc")) {
5535 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"desc")) {
5537 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"alpha")) {
5539 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"limit") && leftargs
>= 2) {
5540 limit_start
= atoi(c
->argv
[j
+1]->ptr
);
5541 limit_count
= atoi(c
->argv
[j
+2]->ptr
);
5543 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"store") && leftargs
>= 1) {
5544 storekey
= c
->argv
[j
+1];
5546 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"by") && leftargs
>= 1) {
5547 sortby
= c
->argv
[j
+1];
5548 /* If the BY pattern does not contain '*', i.e. it is constant,
5549 * we don't need to sort nor to lookup the weight keys. */
5550 if (strchr(c
->argv
[j
+1]->ptr
,'*') == NULL
) dontsort
= 1;
5552 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"get") && leftargs
>= 1) {
5553 listAddNodeTail(operations
,createSortOperation(
5554 REDIS_SORT_GET
,c
->argv
[j
+1]));
5558 decrRefCount(sortval
);
5559 listRelease(operations
);
5560 addReply(c
,shared
.syntaxerr
);
5566 /* Load the sorting vector with all the objects to sort */
5567 switch(sortval
->type
) {
5568 case REDIS_LIST
: vectorlen
= listLength((list
*)sortval
->ptr
); break;
5569 case REDIS_SET
: vectorlen
= dictSize((dict
*)sortval
->ptr
); break;
5570 case REDIS_ZSET
: vectorlen
= dictSize(((zset
*)sortval
->ptr
)->dict
); break;
5571 default: vectorlen
= 0; redisAssert(0); /* Avoid GCC warning */
5573 vector
= zmalloc(sizeof(redisSortObject
)*vectorlen
);
5576 if (sortval
->type
== REDIS_LIST
) {
5577 list
*list
= sortval
->ptr
;
5581 listRewind(list
,&li
);
5582 while((ln
= listNext(&li
))) {
5583 robj
*ele
= ln
->value
;
5584 vector
[j
].obj
= ele
;
5585 vector
[j
].u
.score
= 0;
5586 vector
[j
].u
.cmpobj
= NULL
;
5594 if (sortval
->type
== REDIS_SET
) {
5597 zset
*zs
= sortval
->ptr
;
5601 di
= dictGetIterator(set
);
5602 while((setele
= dictNext(di
)) != NULL
) {
5603 vector
[j
].obj
= dictGetEntryKey(setele
);
5604 vector
[j
].u
.score
= 0;
5605 vector
[j
].u
.cmpobj
= NULL
;
5608 dictReleaseIterator(di
);
5610 redisAssert(j
== vectorlen
);
5612 /* Now it's time to load the right scores in the sorting vector */
5613 if (dontsort
== 0) {
5614 for (j
= 0; j
< vectorlen
; j
++) {
5618 byval
= lookupKeyByPattern(c
->db
,sortby
,vector
[j
].obj
);
5619 if (!byval
|| byval
->type
!= REDIS_STRING
) continue;
5621 vector
[j
].u
.cmpobj
= getDecodedObject(byval
);
5623 if (byval
->encoding
== REDIS_ENCODING_RAW
) {
5624 vector
[j
].u
.score
= strtod(byval
->ptr
,NULL
);
5626 /* Don't need to decode the object if it's
5627 * integer-encoded (the only encoding supported) so
5628 * far. We can just cast it */
5629 if (byval
->encoding
== REDIS_ENCODING_INT
) {
5630 vector
[j
].u
.score
= (long)byval
->ptr
;
5632 redisAssert(1 != 1);
5637 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_RAW
)
5638 vector
[j
].u
.score
= strtod(vector
[j
].obj
->ptr
,NULL
);
5640 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_INT
)
5641 vector
[j
].u
.score
= (long) vector
[j
].obj
->ptr
;
5643 redisAssert(1 != 1);
5650 /* We are ready to sort the vector... perform a bit of sanity check
5651 * on the LIMIT option too. We'll use a partial version of quicksort. */
5652 start
= (limit_start
< 0) ? 0 : limit_start
;
5653 end
= (limit_count
< 0) ? vectorlen
-1 : start
+limit_count
-1;
5654 if (start
>= vectorlen
) {
5655 start
= vectorlen
-1;
5658 if (end
>= vectorlen
) end
= vectorlen
-1;
5660 if (dontsort
== 0) {
5661 server
.sort_desc
= desc
;
5662 server
.sort_alpha
= alpha
;
5663 server
.sort_bypattern
= sortby
? 1 : 0;
5664 if (sortby
&& (start
!= 0 || end
!= vectorlen
-1))
5665 pqsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
, start
,end
);
5667 qsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
);
5670 /* Send command output to the output buffer, performing the specified
5671 * GET/DEL/INCR/DECR operations if any. */
5672 outputlen
= getop
? getop
*(end
-start
+1) : end
-start
+1;
5673 if (storekey
== NULL
) {
5674 /* STORE option not specified, sent the sorting result to client */
5675 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",outputlen
));
5676 for (j
= start
; j
<= end
; j
++) {
5681 addReplyBulkLen(c
,vector
[j
].obj
);
5682 addReply(c
,vector
[j
].obj
);
5683 addReply(c
,shared
.crlf
);
5685 listRewind(operations
,&li
);
5686 while((ln
= listNext(&li
))) {
5687 redisSortOperation
*sop
= ln
->value
;
5688 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
5691 if (sop
->type
== REDIS_SORT_GET
) {
5692 if (!val
|| val
->type
!= REDIS_STRING
) {
5693 addReply(c
,shared
.nullbulk
);
5695 addReplyBulkLen(c
,val
);
5697 addReply(c
,shared
.crlf
);
5700 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
5705 robj
*listObject
= createListObject();
5706 list
*listPtr
= (list
*) listObject
->ptr
;
5708 /* STORE option specified, set the sorting result as a List object */
5709 for (j
= start
; j
<= end
; j
++) {
5714 listAddNodeTail(listPtr
,vector
[j
].obj
);
5715 incrRefCount(vector
[j
].obj
);
5717 listRewind(operations
,&li
);
5718 while((ln
= listNext(&li
))) {
5719 redisSortOperation
*sop
= ln
->value
;
5720 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
5723 if (sop
->type
== REDIS_SORT_GET
) {
5724 if (!val
|| val
->type
!= REDIS_STRING
) {
5725 listAddNodeTail(listPtr
,createStringObject("",0));
5727 listAddNodeTail(listPtr
,val
);
5731 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
5735 if (dictReplace(c
->db
->dict
,storekey
,listObject
)) {
5736 incrRefCount(storekey
);
5738 /* Note: we add 1 because the DB is dirty anyway since even if the
5739 * SORT result is empty a new key is set and maybe the old content
5741 server
.dirty
+= 1+outputlen
;
5742 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",outputlen
));
5746 decrRefCount(sortval
);
5747 listRelease(operations
);
5748 for (j
= 0; j
< vectorlen
; j
++) {
5749 if (sortby
&& alpha
&& vector
[j
].u
.cmpobj
)
5750 decrRefCount(vector
[j
].u
.cmpobj
);
5755 /* Convert an amount of bytes into a human readable string in the form
5756 * of 100B, 2G, 100M, 4K, and so forth. */
5757 static void bytesToHuman(char *s
, unsigned long long n
) {
5762 sprintf(s
,"%lluB",n
);
5764 } else if (n
< (1024*1024)) {
5765 d
= (double)n
/(1024);
5766 sprintf(s
,"%.2fK",d
);
5767 } else if (n
< (1024LL*1024*1024)) {
5768 d
= (double)n
/(1024*1024);
5769 sprintf(s
,"%.2fM",d
);
5770 } else if (n
< (1024LL*1024*1024*1024)) {
5771 d
= (double)n
/(1024LL*1024*1024);
5772 sprintf(s
,"%.2fG",d
);
5776 /* Create the string returned by the INFO command. This is decoupled
5777 * by the INFO command itself as we need to report the same information
5778 * on memory corruption problems. */
5779 static sds
genRedisInfoString(void) {
5781 time_t uptime
= time(NULL
)-server
.stat_starttime
;
5785 bytesToHuman(hmem
,zmalloc_used_memory());
5786 info
= sdscatprintf(sdsempty(),
5787 "redis_version:%s\r\n"
5789 "multiplexing_api:%s\r\n"
5790 "process_id:%ld\r\n"
5791 "uptime_in_seconds:%ld\r\n"
5792 "uptime_in_days:%ld\r\n"
5793 "connected_clients:%d\r\n"
5794 "connected_slaves:%d\r\n"
5795 "blocked_clients:%d\r\n"
5796 "used_memory:%zu\r\n"
5797 "used_memory_human:%s\r\n"
5798 "changes_since_last_save:%lld\r\n"
5799 "bgsave_in_progress:%d\r\n"
5800 "last_save_time:%ld\r\n"
5801 "bgrewriteaof_in_progress:%d\r\n"
5802 "total_connections_received:%lld\r\n"
5803 "total_commands_processed:%lld\r\n"
5807 (sizeof(long) == 8) ? "64" : "32",
5812 listLength(server
.clients
)-listLength(server
.slaves
),
5813 listLength(server
.slaves
),
5814 server
.blpop_blocked_clients
,
5815 zmalloc_used_memory(),
5818 server
.bgsavechildpid
!= -1,
5820 server
.bgrewritechildpid
!= -1,
5821 server
.stat_numconnections
,
5822 server
.stat_numcommands
,
5823 server
.vm_enabled
!= 0,
5824 server
.masterhost
== NULL
? "master" : "slave"
5826 if (server
.masterhost
) {
5827 info
= sdscatprintf(info
,
5828 "master_host:%s\r\n"
5829 "master_port:%d\r\n"
5830 "master_link_status:%s\r\n"
5831 "master_last_io_seconds_ago:%d\r\n"
5834 (server
.replstate
== REDIS_REPL_CONNECTED
) ?
5836 server
.master
? ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1
5839 if (server
.vm_enabled
) {
5841 info
= sdscatprintf(info
,
5842 "vm_conf_max_memory:%llu\r\n"
5843 "vm_conf_page_size:%llu\r\n"
5844 "vm_conf_pages:%llu\r\n"
5845 "vm_stats_used_pages:%llu\r\n"
5846 "vm_stats_swapped_objects:%llu\r\n"
5847 "vm_stats_swappin_count:%llu\r\n"
5848 "vm_stats_swappout_count:%llu\r\n"
5849 "vm_stats_io_newjobs_len:%lu\r\n"
5850 "vm_stats_io_processing_len:%lu\r\n"
5851 "vm_stats_io_processed_len:%lu\r\n"
5852 "vm_stats_io_active_threads:%lu\r\n"
5853 "vm_stats_blocked_clients:%lu\r\n"
5854 ,(unsigned long long) server
.vm_max_memory
,
5855 (unsigned long long) server
.vm_page_size
,
5856 (unsigned long long) server
.vm_pages
,
5857 (unsigned long long) server
.vm_stats_used_pages
,
5858 (unsigned long long) server
.vm_stats_swapped_objects
,
5859 (unsigned long long) server
.vm_stats_swapins
,
5860 (unsigned long long) server
.vm_stats_swapouts
,
5861 (unsigned long) listLength(server
.io_newjobs
),
5862 (unsigned long) listLength(server
.io_processing
),
5863 (unsigned long) listLength(server
.io_processed
),
5864 (unsigned long) server
.io_active_threads
,
5865 (unsigned long) server
.vm_blocked_clients
5869 for (j
= 0; j
< server
.dbnum
; j
++) {
5870 long long keys
, vkeys
;
5872 keys
= dictSize(server
.db
[j
].dict
);
5873 vkeys
= dictSize(server
.db
[j
].expires
);
5874 if (keys
|| vkeys
) {
5875 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
5882 static void infoCommand(redisClient
*c
) {
5883 sds info
= genRedisInfoString();
5884 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
5885 (unsigned long)sdslen(info
)));
5886 addReplySds(c
,info
);
5887 addReply(c
,shared
.crlf
);
5890 static void monitorCommand(redisClient
*c
) {
5891 /* ignore MONITOR if aleady slave or in monitor mode */
5892 if (c
->flags
& REDIS_SLAVE
) return;
5894 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
5896 listAddNodeTail(server
.monitors
,c
);
5897 addReply(c
,shared
.ok
);
5900 /* ================================= Expire ================================= */
5901 static int removeExpire(redisDb
*db
, robj
*key
) {
5902 if (dictDelete(db
->expires
,key
) == DICT_OK
) {
5909 static int setExpire(redisDb
*db
, robj
*key
, time_t when
) {
5910 if (dictAdd(db
->expires
,key
,(void*)when
) == DICT_ERR
) {
5918 /* Return the expire time of the specified key, or -1 if no expire
5919 * is associated with this key (i.e. the key is non volatile) */
5920 static time_t getExpire(redisDb
*db
, robj
*key
) {
5923 /* No expire? return ASAP */
5924 if (dictSize(db
->expires
) == 0 ||
5925 (de
= dictFind(db
->expires
,key
)) == NULL
) return -1;
5927 return (time_t) dictGetEntryVal(de
);
5930 static int expireIfNeeded(redisDb
*db
, robj
*key
) {
5934 /* No expire? return ASAP */
5935 if (dictSize(db
->expires
) == 0 ||
5936 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
5938 /* Lookup the expire */
5939 when
= (time_t) dictGetEntryVal(de
);
5940 if (time(NULL
) <= when
) return 0;
5942 /* Delete the key */
5943 dictDelete(db
->expires
,key
);
5944 return dictDelete(db
->dict
,key
) == DICT_OK
;
5947 static int deleteIfVolatile(redisDb
*db
, robj
*key
) {
5950 /* No expire? return ASAP */
5951 if (dictSize(db
->expires
) == 0 ||
5952 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
5954 /* Delete the key */
5956 dictDelete(db
->expires
,key
);
5957 return dictDelete(db
->dict
,key
) == DICT_OK
;
5960 static void expireGenericCommand(redisClient
*c
, robj
*key
, time_t seconds
) {
5963 de
= dictFind(c
->db
->dict
,key
);
5965 addReply(c
,shared
.czero
);
5969 if (deleteKey(c
->db
,key
)) server
.dirty
++;
5970 addReply(c
, shared
.cone
);
5973 time_t when
= time(NULL
)+seconds
;
5974 if (setExpire(c
->db
,key
,when
)) {
5975 addReply(c
,shared
.cone
);
5978 addReply(c
,shared
.czero
);
5984 static void expireCommand(redisClient
*c
) {
5985 expireGenericCommand(c
,c
->argv
[1],strtol(c
->argv
[2]->ptr
,NULL
,10));
5988 static void expireatCommand(redisClient
*c
) {
5989 expireGenericCommand(c
,c
->argv
[1],strtol(c
->argv
[2]->ptr
,NULL
,10)-time(NULL
));
5992 static void ttlCommand(redisClient
*c
) {
5996 expire
= getExpire(c
->db
,c
->argv
[1]);
5998 ttl
= (int) (expire
-time(NULL
));
5999 if (ttl
< 0) ttl
= -1;
6001 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",ttl
));
6004 /* ================================ MULTI/EXEC ============================== */
6006 /* Client state initialization for MULTI/EXEC */
6007 static void initClientMultiState(redisClient
*c
) {
6008 c
->mstate
.commands
= NULL
;
6009 c
->mstate
.count
= 0;
6012 /* Release all the resources associated with MULTI/EXEC state */
6013 static void freeClientMultiState(redisClient
*c
) {
6016 for (j
= 0; j
< c
->mstate
.count
; j
++) {
6018 multiCmd
*mc
= c
->mstate
.commands
+j
;
6020 for (i
= 0; i
< mc
->argc
; i
++)
6021 decrRefCount(mc
->argv
[i
]);
6024 zfree(c
->mstate
.commands
);
6027 /* Add a new command into the MULTI commands queue */
6028 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
) {
6032 c
->mstate
.commands
= zrealloc(c
->mstate
.commands
,
6033 sizeof(multiCmd
)*(c
->mstate
.count
+1));
6034 mc
= c
->mstate
.commands
+c
->mstate
.count
;
6037 mc
->argv
= zmalloc(sizeof(robj
*)*c
->argc
);
6038 memcpy(mc
->argv
,c
->argv
,sizeof(robj
*)*c
->argc
);
6039 for (j
= 0; j
< c
->argc
; j
++)
6040 incrRefCount(mc
->argv
[j
]);
6044 static void multiCommand(redisClient
*c
) {
6045 c
->flags
|= REDIS_MULTI
;
6046 addReply(c
,shared
.ok
);
6049 static void execCommand(redisClient
*c
) {
6054 if (!(c
->flags
& REDIS_MULTI
)) {
6055 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
6059 orig_argv
= c
->argv
;
6060 orig_argc
= c
->argc
;
6061 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
6062 for (j
= 0; j
< c
->mstate
.count
; j
++) {
6063 c
->argc
= c
->mstate
.commands
[j
].argc
;
6064 c
->argv
= c
->mstate
.commands
[j
].argv
;
6065 call(c
,c
->mstate
.commands
[j
].cmd
);
6067 c
->argv
= orig_argv
;
6068 c
->argc
= orig_argc
;
6069 freeClientMultiState(c
);
6070 initClientMultiState(c
);
6071 c
->flags
&= (~REDIS_MULTI
);
6074 /* =========================== Blocking Operations ========================= */
6076 /* Currently Redis blocking operations support is limited to list POP ops,
6077 * so the current implementation is not fully generic, but it is also not
6078 * completely specific so it will not require a rewrite to support new
6079 * kind of blocking operations in the future.
6081 * Still it's important to note that list blocking operations can be already
6082 * used as a notification mechanism in order to implement other blocking
6083 * operations at application level, so there must be a very strong evidence
6084 * of usefulness and generality before new blocking operations are implemented.
6086 * This is how the current blocking POP works, we use BLPOP as example:
6087 * - If the user calls BLPOP and the key exists and contains a non empty list
6088 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
6089 * if there is not to block.
6090 * - If instead BLPOP is called and the key does not exists or the list is
6091 * empty we need to block. In order to do so we remove the notification for
6092 * new data to read in the client socket (so that we'll not serve new
6093 * requests if the blocking request is not served). Also we put the client
6094 * in a dictionary (db->blockingkeys) mapping keys to a list of clients
6095 * blocking for this keys.
6096 * - If a PUSH operation against a key with blocked clients waiting is
6097 * performed, we serve the first in the list: basically instead to push
6098 * the new element inside the list we return it to the (first / oldest)
6099 * blocking client, unblock the client, and remove it form the list.
6101 * The above comment and the source code should be enough in order to understand
6102 * the implementation and modify / fix it later.
6105 /* Set a client in blocking mode for the specified key, with the specified
6107 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
6112 c
->blockingkeys
= zmalloc(sizeof(robj
*)*numkeys
);
6113 c
->blockingkeysnum
= numkeys
;
6114 c
->blockingto
= timeout
;
6115 for (j
= 0; j
< numkeys
; j
++) {
6116 /* Add the key in the client structure, to map clients -> keys */
6117 c
->blockingkeys
[j
] = keys
[j
];
6118 incrRefCount(keys
[j
]);
6120 /* And in the other "side", to map keys -> clients */
6121 de
= dictFind(c
->db
->blockingkeys
,keys
[j
]);
6125 /* For every key we take a list of clients blocked for it */
6127 retval
= dictAdd(c
->db
->blockingkeys
,keys
[j
],l
);
6128 incrRefCount(keys
[j
]);
6129 assert(retval
== DICT_OK
);
6131 l
= dictGetEntryVal(de
);
6133 listAddNodeTail(l
,c
);
6135 /* Mark the client as a blocked client */
6136 c
->flags
|= REDIS_BLOCKED
;
6137 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
6138 server
.blpop_blocked_clients
++;
6141 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
6142 static void unblockClientWaitingData(redisClient
*c
) {
6147 assert(c
->blockingkeys
!= NULL
);
6148 /* The client may wait for multiple keys, so unblock it for every key. */
6149 for (j
= 0; j
< c
->blockingkeysnum
; j
++) {
6150 /* Remove this client from the list of clients waiting for this key. */
6151 de
= dictFind(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
6153 l
= dictGetEntryVal(de
);
6154 listDelNode(l
,listSearchKey(l
,c
));
6155 /* If the list is empty we need to remove it to avoid wasting memory */
6156 if (listLength(l
) == 0)
6157 dictDelete(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
6158 decrRefCount(c
->blockingkeys
[j
]);
6160 /* Cleanup the client structure */
6161 zfree(c
->blockingkeys
);
6162 c
->blockingkeys
= NULL
;
6163 c
->flags
&= (~REDIS_BLOCKED
);
6164 server
.blpop_blocked_clients
--;
6165 /* Ok now we are ready to get read events from socket, note that we
6166 * can't trap errors here as it's possible that unblockClientWaitingDatas() is
6167 * called from freeClient() itself, and the only thing we can do
6168 * if we failed to register the READABLE event is to kill the client.
6169 * Still the following function should never fail in the real world as
6170 * we are sure the file descriptor is sane, and we exit on out of mem. */
6171 aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
, readQueryFromClient
, c
);
6172 /* As a final step we want to process data if there is some command waiting
6173 * in the input buffer. Note that this is safe even if
6174 * unblockClientWaitingData() gets called from freeClient() because
6175 * freeClient() will be smart enough to call this function
6176 * *after* c->querybuf was set to NULL. */
6177 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
6180 /* This should be called from any function PUSHing into lists.
6181 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
6182 * 'ele' is the element pushed.
6184 * If the function returns 0 there was no client waiting for a list push
6187 * If the function returns 1 there was a client waiting for a list push
6188 * against this key, the element was passed to this client thus it's not
6189 * needed to actually add it to the list and the caller should return asap. */
6190 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
6191 struct dictEntry
*de
;
6192 redisClient
*receiver
;
6196 de
= dictFind(c
->db
->blockingkeys
,key
);
6197 if (de
== NULL
) return 0;
6198 l
= dictGetEntryVal(de
);
6201 receiver
= ln
->value
;
6203 addReplySds(receiver
,sdsnew("*2\r\n"));
6204 addReplyBulkLen(receiver
,key
);
6205 addReply(receiver
,key
);
6206 addReply(receiver
,shared
.crlf
);
6207 addReplyBulkLen(receiver
,ele
);
6208 addReply(receiver
,ele
);
6209 addReply(receiver
,shared
.crlf
);
6210 unblockClientWaitingData(receiver
);
6214 /* Blocking RPOP/LPOP */
6215 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
6220 for (j
= 1; j
< c
->argc
-1; j
++) {
6221 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
6223 if (o
->type
!= REDIS_LIST
) {
6224 addReply(c
,shared
.wrongtypeerr
);
6227 list
*list
= o
->ptr
;
6228 if (listLength(list
) != 0) {
6229 /* If the list contains elements fall back to the usual
6230 * non-blocking POP operation */
6231 robj
*argv
[2], **orig_argv
;
6234 /* We need to alter the command arguments before to call
6235 * popGenericCommand() as the command takes a single key. */
6236 orig_argv
= c
->argv
;
6237 orig_argc
= c
->argc
;
6238 argv
[1] = c
->argv
[j
];
6242 /* Also the return value is different, we need to output
6243 * the multi bulk reply header and the key name. The
6244 * "real" command will add the last element (the value)
6245 * for us. If this souds like an hack to you it's just
6246 * because it is... */
6247 addReplySds(c
,sdsnew("*2\r\n"));
6248 addReplyBulkLen(c
,argv
[1]);
6249 addReply(c
,argv
[1]);
6250 addReply(c
,shared
.crlf
);
6251 popGenericCommand(c
,where
);
6253 /* Fix the client structure with the original stuff */
6254 c
->argv
= orig_argv
;
6255 c
->argc
= orig_argc
;
6261 /* If the list is empty or the key does not exists we must block */
6262 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
6263 if (timeout
> 0) timeout
+= time(NULL
);
6264 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
6267 static void blpopCommand(redisClient
*c
) {
6268 blockingPopGenericCommand(c
,REDIS_HEAD
);
6271 static void brpopCommand(redisClient
*c
) {
6272 blockingPopGenericCommand(c
,REDIS_TAIL
);
6275 /* =============================== Replication ============================= */
6277 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
6278 ssize_t nwritten
, ret
= size
;
6279 time_t start
= time(NULL
);
6283 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
6284 nwritten
= write(fd
,ptr
,size
);
6285 if (nwritten
== -1) return -1;
6289 if ((time(NULL
)-start
) > timeout
) {
6297 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
6298 ssize_t nread
, totread
= 0;
6299 time_t start
= time(NULL
);
6303 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
6304 nread
= read(fd
,ptr
,size
);
6305 if (nread
== -1) return -1;
6310 if ((time(NULL
)-start
) > timeout
) {
6318 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
6325 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
6328 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
6339 static void syncCommand(redisClient
*c
) {
6340 /* ignore SYNC if aleady slave or in monitor mode */
6341 if (c
->flags
& REDIS_SLAVE
) return;
6343 /* SYNC can't be issued when the server has pending data to send to
6344 * the client about already issued commands. We need a fresh reply
6345 * buffer registering the differences between the BGSAVE and the current
6346 * dataset, so that we can copy to other slaves if needed. */
6347 if (listLength(c
->reply
) != 0) {
6348 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
6352 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
6353 /* Here we need to check if there is a background saving operation
6354 * in progress, or if it is required to start one */
6355 if (server
.bgsavechildpid
!= -1) {
6356 /* Ok a background save is in progress. Let's check if it is a good
6357 * one for replication, i.e. if there is another slave that is
6358 * registering differences since the server forked to save */
6363 listRewind(server
.slaves
,&li
);
6364 while((ln
= listNext(&li
))) {
6366 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
6369 /* Perfect, the server is already registering differences for
6370 * another slave. Set the right state, and copy the buffer. */
6371 listRelease(c
->reply
);
6372 c
->reply
= listDup(slave
->reply
);
6373 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
6374 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
6376 /* No way, we need to wait for the next BGSAVE in order to
6377 * register differences */
6378 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
6379 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
6382 /* Ok we don't have a BGSAVE in progress, let's start one */
6383 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
6384 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
6385 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
6386 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
6389 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
6392 c
->flags
|= REDIS_SLAVE
;
6394 listAddNodeTail(server
.slaves
,c
);
6398 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
6399 redisClient
*slave
= privdata
;
6401 REDIS_NOTUSED(mask
);
6402 char buf
[REDIS_IOBUF_LEN
];
6403 ssize_t nwritten
, buflen
;
6405 if (slave
->repldboff
== 0) {
6406 /* Write the bulk write count before to transfer the DB. In theory here
6407 * we don't know how much room there is in the output buffer of the
6408 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
6409 * operations) will never be smaller than the few bytes we need. */
6412 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
6414 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
6422 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
6423 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
6425 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
6426 (buflen
== 0) ? "premature EOF" : strerror(errno
));
6430 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
6431 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
6436 slave
->repldboff
+= nwritten
;
6437 if (slave
->repldboff
== slave
->repldbsize
) {
6438 close(slave
->repldbfd
);
6439 slave
->repldbfd
= -1;
6440 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
6441 slave
->replstate
= REDIS_REPL_ONLINE
;
6442 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
6443 sendReplyToClient
, slave
) == AE_ERR
) {
6447 addReplySds(slave
,sdsempty());
6448 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
6452 /* This function is called at the end of every backgrond saving.
6453 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
6454 * otherwise REDIS_ERR is passed to the function.
6456 * The goal of this function is to handle slaves waiting for a successful
6457 * background saving in order to perform non-blocking synchronization. */
6458 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
6460 int startbgsave
= 0;
6463 listRewind(server
.slaves
,&li
);
6464 while((ln
= listNext(&li
))) {
6465 redisClient
*slave
= ln
->value
;
6467 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
6469 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
6470 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
6471 struct redis_stat buf
;
6473 if (bgsaveerr
!= REDIS_OK
) {
6475 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
6478 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
6479 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
6481 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
6484 slave
->repldboff
= 0;
6485 slave
->repldbsize
= buf
.st_size
;
6486 slave
->replstate
= REDIS_REPL_SEND_BULK
;
6487 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
6488 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
6495 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
6498 listRewind(server
.slaves
,&li
);
6499 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
6500 while((ln
= listNext(&li
))) {
6501 redisClient
*slave
= ln
->value
;
6503 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
6510 static int syncWithMaster(void) {
6511 char buf
[1024], tmpfile
[256], authcmd
[1024];
6513 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
6517 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
6522 /* AUTH with the master if required. */
6523 if(server
.masterauth
) {
6524 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
6525 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
6527 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
6531 /* Read the AUTH result. */
6532 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
6534 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
6538 if (buf
[0] != '+') {
6540 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
6545 /* Issue the SYNC command */
6546 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
6548 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
6552 /* Read the bulk write count */
6553 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
6555 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
6559 if (buf
[0] != '$') {
6561 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
6564 dumpsize
= atoi(buf
+1);
6565 redisLog(REDIS_NOTICE
,"Receiving %d bytes data dump from MASTER",dumpsize
);
6566 /* Read the bulk write data on a temp file */
6567 snprintf(tmpfile
,256,"temp-%d.%ld.rdb",(int)time(NULL
),(long int)random());
6568 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
,0644);
6571 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
6575 int nread
, nwritten
;
6577 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
6579 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
6585 nwritten
= write(dfd
,buf
,nread
);
6586 if (nwritten
== -1) {
6587 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
6595 if (rename(tmpfile
,server
.dbfilename
) == -1) {
6596 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
6602 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
6603 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
6607 server
.master
= createClient(fd
);
6608 server
.master
->flags
|= REDIS_MASTER
;
6609 server
.master
->authenticated
= 1;
6610 server
.replstate
= REDIS_REPL_CONNECTED
;
6614 static void slaveofCommand(redisClient
*c
) {
6615 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
6616 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
6617 if (server
.masterhost
) {
6618 sdsfree(server
.masterhost
);
6619 server
.masterhost
= NULL
;
6620 if (server
.master
) freeClient(server
.master
);
6621 server
.replstate
= REDIS_REPL_NONE
;
6622 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
6625 sdsfree(server
.masterhost
);
6626 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
6627 server
.masterport
= atoi(c
->argv
[2]->ptr
);
6628 if (server
.master
) freeClient(server
.master
);
6629 server
.replstate
= REDIS_REPL_CONNECT
;
6630 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
6631 server
.masterhost
, server
.masterport
);
6633 addReply(c
,shared
.ok
);
6636 /* ============================ Maxmemory directive ======================== */
6638 /* Try to free one object form the pre-allocated objects free list.
6639 * This is useful under low mem conditions as by default we take 1 million
6640 * free objects allocated. On success REDIS_OK is returned, otherwise
6642 static int tryFreeOneObjectFromFreelist(void) {
6645 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
6646 if (listLength(server
.objfreelist
)) {
6647 listNode
*head
= listFirst(server
.objfreelist
);
6648 o
= listNodeValue(head
);
6649 listDelNode(server
.objfreelist
,head
);
6650 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
6654 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
6659 /* This function gets called when 'maxmemory' is set on the config file to limit
6660 * the max memory used by the server, and we are out of memory.
6661 * This function will try to, in order:
6663 * - Free objects from the free list
6664 * - Try to remove keys with an EXPIRE set
6666 * It is not possible to free enough memory to reach used-memory < maxmemory
6667 * the server will start refusing commands that will enlarge even more the
6670 static void freeMemoryIfNeeded(void) {
6671 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
6672 int j
, k
, freed
= 0;
6674 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
6675 for (j
= 0; j
< server
.dbnum
; j
++) {
6677 robj
*minkey
= NULL
;
6678 struct dictEntry
*de
;
6680 if (dictSize(server
.db
[j
].expires
)) {
6682 /* From a sample of three keys drop the one nearest to
6683 * the natural expire */
6684 for (k
= 0; k
< 3; k
++) {
6687 de
= dictGetRandomKey(server
.db
[j
].expires
);
6688 t
= (time_t) dictGetEntryVal(de
);
6689 if (minttl
== -1 || t
< minttl
) {
6690 minkey
= dictGetEntryKey(de
);
6694 deleteKey(server
.db
+j
,minkey
);
6697 if (!freed
) return; /* nothing to free... */
6701 /* ============================== Append Only file ========================== */
6703 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
6704 sds buf
= sdsempty();
6710 /* The DB this command was targetting is not the same as the last command
6711 * we appendend. To issue a SELECT command is needed. */
6712 if (dictid
!= server
.appendseldb
) {
6715 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
6716 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
6717 (unsigned long)strlen(seldb
),seldb
);
6718 server
.appendseldb
= dictid
;
6721 /* "Fix" the argv vector if the command is EXPIRE. We want to translate
6722 * EXPIREs into EXPIREATs calls */
6723 if (cmd
->proc
== expireCommand
) {
6726 tmpargv
[0] = createStringObject("EXPIREAT",8);
6727 tmpargv
[1] = argv
[1];
6728 incrRefCount(argv
[1]);
6729 when
= time(NULL
)+strtol(argv
[2]->ptr
,NULL
,10);
6730 tmpargv
[2] = createObject(REDIS_STRING
,
6731 sdscatprintf(sdsempty(),"%ld",when
));
6735 /* Append the actual command */
6736 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
6737 for (j
= 0; j
< argc
; j
++) {
6740 o
= getDecodedObject(o
);
6741 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
6742 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
6743 buf
= sdscatlen(buf
,"\r\n",2);
6747 /* Free the objects from the modified argv for EXPIREAT */
6748 if (cmd
->proc
== expireCommand
) {
6749 for (j
= 0; j
< 3; j
++)
6750 decrRefCount(argv
[j
]);
6753 /* We want to perform a single write. This should be guaranteed atomic
6754 * at least if the filesystem we are writing is a real physical one.
6755 * While this will save us against the server being killed I don't think
6756 * there is much to do about the whole server stopping for power problems
6758 nwritten
= write(server
.appendfd
,buf
,sdslen(buf
));
6759 if (nwritten
!= (signed)sdslen(buf
)) {
6760 /* Ooops, we are in troubles. The best thing to do for now is
6761 * to simply exit instead to give the illusion that everything is
6762 * working as expected. */
6763 if (nwritten
== -1) {
6764 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
6766 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
6770 /* If a background append only file rewriting is in progress we want to
6771 * accumulate the differences between the child DB and the current one
6772 * in a buffer, so that when the child process will do its work we
6773 * can append the differences to the new append only file. */
6774 if (server
.bgrewritechildpid
!= -1)
6775 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
6779 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
6780 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
6781 now
-server
.lastfsync
> 1))
6783 fsync(server
.appendfd
); /* Let's try to get this data on the disk */
6784 server
.lastfsync
= now
;
6788 /* In Redis commands are always executed in the context of a client, so in
6789 * order to load the append only file we need to create a fake client. */
6790 static struct redisClient
*createFakeClient(void) {
6791 struct redisClient
*c
= zmalloc(sizeof(*c
));
6795 c
->querybuf
= sdsempty();
6799 /* We set the fake client as a slave waiting for the synchronization
6800 * so that Redis will not try to send replies to this client. */
6801 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
6802 c
->reply
= listCreate();
6803 listSetFreeMethod(c
->reply
,decrRefCount
);
6804 listSetDupMethod(c
->reply
,dupClientReplyValue
);
6808 static void freeFakeClient(struct redisClient
*c
) {
6809 sdsfree(c
->querybuf
);
6810 listRelease(c
->reply
);
6814 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
6815 * error (the append only file is zero-length) REDIS_ERR is returned. On
6816 * fatal error an error message is logged and the program exists. */
6817 int loadAppendOnlyFile(char *filename
) {
6818 struct redisClient
*fakeClient
;
6819 FILE *fp
= fopen(filename
,"r");
6820 struct redis_stat sb
;
6821 unsigned long long loadedkeys
= 0;
6823 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
6827 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
6831 fakeClient
= createFakeClient();
6838 struct redisCommand
*cmd
;
6840 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
6846 if (buf
[0] != '*') goto fmterr
;
6848 argv
= zmalloc(sizeof(robj
*)*argc
);
6849 for (j
= 0; j
< argc
; j
++) {
6850 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
6851 if (buf
[0] != '$') goto fmterr
;
6852 len
= strtol(buf
+1,NULL
,10);
6853 argsds
= sdsnewlen(NULL
,len
);
6854 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
6855 argv
[j
] = createObject(REDIS_STRING
,argsds
);
6856 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
6859 /* Command lookup */
6860 cmd
= lookupCommand(argv
[0]->ptr
);
6862 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
6865 /* Try object sharing and encoding */
6866 if (server
.shareobjects
) {
6868 for(j
= 1; j
< argc
; j
++)
6869 argv
[j
] = tryObjectSharing(argv
[j
]);
6871 if (cmd
->flags
& REDIS_CMD_BULK
)
6872 tryObjectEncoding(argv
[argc
-1]);
6873 /* Run the command in the context of a fake client */
6874 fakeClient
->argc
= argc
;
6875 fakeClient
->argv
= argv
;
6876 cmd
->proc(fakeClient
);
6877 /* Discard the reply objects list from the fake client */
6878 while(listLength(fakeClient
->reply
))
6879 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
6880 /* Clean up, ready for the next command */
6881 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
6883 /* Handle swapping while loading big datasets when VM is on */
6885 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
6886 while (zmalloc_used_memory() > server
.vm_max_memory
) {
6887 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
6892 freeFakeClient(fakeClient
);
6897 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
6899 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
6903 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
6907 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
6908 static int fwriteBulk(FILE *fp
, robj
*obj
) {
6912 /* Avoid the incr/decr ref count business if possible to help
6913 * copy-on-write (we are often in a child process when this function
6915 * Also makes sure that key objects don't get incrRefCount-ed when VM
6917 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
6918 obj
= getDecodedObject(obj
);
6921 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(long)sdslen(obj
->ptr
));
6922 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) goto err
;
6923 if (sdslen(obj
->ptr
) && fwrite(obj
->ptr
,sdslen(obj
->ptr
),1,fp
) == 0)
6925 if (fwrite("\r\n",2,1,fp
) == 0) goto err
;
6926 if (decrrc
) decrRefCount(obj
);
6929 if (decrrc
) decrRefCount(obj
);
6933 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
6934 static int fwriteBulkDouble(FILE *fp
, double d
) {
6935 char buf
[128], dbuf
[128];
6937 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
6938 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
6939 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
6940 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
6944 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
6945 static int fwriteBulkLong(FILE *fp
, long l
) {
6946 char buf
[128], lbuf
[128];
6948 snprintf(lbuf
,sizeof(lbuf
),"%ld\r\n",l
);
6949 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(lbuf
)-2);
6950 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
6951 if (fwrite(lbuf
,strlen(lbuf
),1,fp
) == 0) return 0;
6955 /* Write a sequence of commands able to fully rebuild the dataset into
6956 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
6957 static int rewriteAppendOnlyFile(char *filename
) {
6958 dictIterator
*di
= NULL
;
6963 time_t now
= time(NULL
);
6965 /* Note that we have to use a different temp name here compared to the
6966 * one used by rewriteAppendOnlyFileBackground() function. */
6967 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
6968 fp
= fopen(tmpfile
,"w");
6970 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
6973 for (j
= 0; j
< server
.dbnum
; j
++) {
6974 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
6975 redisDb
*db
= server
.db
+j
;
6977 if (dictSize(d
) == 0) continue;
6978 di
= dictGetIterator(d
);
6984 /* SELECT the new DB */
6985 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
6986 if (fwriteBulkLong(fp
,j
) == 0) goto werr
;
6988 /* Iterate this DB writing every entry */
6989 while((de
= dictNext(di
)) != NULL
) {
6994 key
= dictGetEntryKey(de
);
6995 /* If the value for this key is swapped, load a preview in memory.
6996 * We use a "swapped" flag to remember if we need to free the
6997 * value object instead to just increment the ref count anyway
6998 * in order to avoid copy-on-write of pages if we are forked() */
6999 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
7000 key
->storage
== REDIS_VM_SWAPPING
) {
7001 o
= dictGetEntryVal(de
);
7004 o
= vmPreviewObject(key
);
7007 expiretime
= getExpire(db
,key
);
7009 /* Save the key and associated value */
7010 if (o
->type
== REDIS_STRING
) {
7011 /* Emit a SET command */
7012 char cmd
[]="*3\r\n$3\r\nSET\r\n";
7013 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7015 if (fwriteBulk(fp
,key
) == 0) goto werr
;
7016 if (fwriteBulk(fp
,o
) == 0) goto werr
;
7017 } else if (o
->type
== REDIS_LIST
) {
7018 /* Emit the RPUSHes needed to rebuild the list */
7019 list
*list
= o
->ptr
;
7023 listRewind(list
,&li
);
7024 while((ln
= listNext(&li
))) {
7025 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
7026 robj
*eleobj
= listNodeValue(ln
);
7028 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7029 if (fwriteBulk(fp
,key
) == 0) goto werr
;
7030 if (fwriteBulk(fp
,eleobj
) == 0) goto werr
;
7032 } else if (o
->type
== REDIS_SET
) {
7033 /* Emit the SADDs needed to rebuild the set */
7035 dictIterator
*di
= dictGetIterator(set
);
7038 while((de
= dictNext(di
)) != NULL
) {
7039 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
7040 robj
*eleobj
= dictGetEntryKey(de
);
7042 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7043 if (fwriteBulk(fp
,key
) == 0) goto werr
;
7044 if (fwriteBulk(fp
,eleobj
) == 0) goto werr
;
7046 dictReleaseIterator(di
);
7047 } else if (o
->type
== REDIS_ZSET
) {
7048 /* Emit the ZADDs needed to rebuild the sorted set */
7050 dictIterator
*di
= dictGetIterator(zs
->dict
);
7053 while((de
= dictNext(di
)) != NULL
) {
7054 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
7055 robj
*eleobj
= dictGetEntryKey(de
);
7056 double *score
= dictGetEntryVal(de
);
7058 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7059 if (fwriteBulk(fp
,key
) == 0) goto werr
;
7060 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
7061 if (fwriteBulk(fp
,eleobj
) == 0) goto werr
;
7063 dictReleaseIterator(di
);
7065 redisAssert(0 != 0);
7067 /* Save the expire time */
7068 if (expiretime
!= -1) {
7069 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
7070 /* If this key is already expired skip it */
7071 if (expiretime
< now
) continue;
7072 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7073 if (fwriteBulk(fp
,key
) == 0) goto werr
;
7074 if (fwriteBulkLong(fp
,expiretime
) == 0) goto werr
;
7076 if (swapped
) decrRefCount(o
);
7078 dictReleaseIterator(di
);
7081 /* Make sure data will not remain on the OS's output buffers */
7086 /* Use RENAME to make sure the DB file is changed atomically only
7087 * if the generate DB file is ok. */
7088 if (rename(tmpfile
,filename
) == -1) {
7089 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
7093 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
7099 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
7100 if (di
) dictReleaseIterator(di
);
7104 /* This is how rewriting of the append only file in background works:
7106 * 1) The user calls BGREWRITEAOF
7107 * 2) Redis calls this function, that forks():
7108 * 2a) the child rewrite the append only file in a temp file.
7109 * 2b) the parent accumulates differences in server.bgrewritebuf.
7110 * 3) When the child finished '2a' exists.
7111 * 4) The parent will trap the exit code, if it's OK, will append the
7112 * data accumulated into server.bgrewritebuf into the temp file, and
7113 * finally will rename(2) the temp file in the actual file name.
7114 * The the new file is reopened as the new append only file. Profit!
7116 static int rewriteAppendOnlyFileBackground(void) {
7119 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
7120 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
7121 if ((childpid
= fork()) == 0) {
7125 if (server
.vm_enabled
) vmReopenSwapFile();
7127 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
7128 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
7135 if (childpid
== -1) {
7136 redisLog(REDIS_WARNING
,
7137 "Can't rewrite append only file in background: fork: %s",
7141 redisLog(REDIS_NOTICE
,
7142 "Background append only file rewriting started by pid %d",childpid
);
7143 server
.bgrewritechildpid
= childpid
;
7144 /* We set appendseldb to -1 in order to force the next call to the
7145 * feedAppendOnlyFile() to issue a SELECT command, so the differences
7146 * accumulated by the parent into server.bgrewritebuf will start
7147 * with a SELECT statement and it will be safe to merge. */
7148 server
.appendseldb
= -1;
7151 return REDIS_OK
; /* unreached */
7154 static void bgrewriteaofCommand(redisClient
*c
) {
7155 if (server
.bgrewritechildpid
!= -1) {
7156 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
7159 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
7160 char *status
= "+Background append only file rewriting started\r\n";
7161 addReplySds(c
,sdsnew(status
));
7163 addReply(c
,shared
.err
);
7167 static void aofRemoveTempFile(pid_t childpid
) {
7170 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
7174 /* Virtual Memory is composed mainly of two subsystems:
7175 * - Blocking Virutal Memory
7176 * - Threaded Virtual Memory I/O
7177 * The two parts are not fully decoupled, but functions are split among two
7178 * different sections of the source code (delimited by comments) in order to
7179 * make more clear what functionality is about the blocking VM and what about
7180 * the threaded (not blocking) VM.
7184 * Redis VM is a blocking VM (one that blocks reading swapped values from
7185 * disk into memory when a value swapped out is needed in memory) that is made
7186 * unblocking by trying to examine the command argument vector in order to
7187 * load in background values that will likely be needed in order to exec
7188 * the command. The command is executed only once all the relevant keys
7189 * are loaded into memory.
7191 * This basically is almost as simple of a blocking VM, but almost as parallel
7192 * as a fully non-blocking VM.
7195 /* =================== Virtual Memory - Blocking Side ====================== */
7197 /* substitute the first occurrence of '%p' with the process pid in the
7198 * swap file name. */
7199 static void expandVmSwapFilename(void) {
7200 char *p
= strstr(server
.vm_swap_file
,"%p");
7206 new = sdscat(new,server
.vm_swap_file
);
7207 new = sdscatprintf(new,"%ld",(long) getpid());
7208 new = sdscat(new,p
+2);
7209 zfree(server
.vm_swap_file
);
7210 server
.vm_swap_file
= new;
7213 static void vmInit(void) {
7218 if (server
.vm_max_threads
!= 0)
7219 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
7221 expandVmSwapFilename();
7222 redisLog(REDIS_NOTICE
,"Using '%s' as swap file",server
.vm_swap_file
);
7223 if ((server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b")) == NULL
) {
7224 server
.vm_fp
= fopen(server
.vm_swap_file
,"w+b");
7226 if (server
.vm_fp
== NULL
) {
7227 redisLog(REDIS_WARNING
,
7228 "Impossible to open the swap file: %s. Exiting.",
7232 server
.vm_fd
= fileno(server
.vm_fp
);
7233 server
.vm_next_page
= 0;
7234 server
.vm_near_pages
= 0;
7235 server
.vm_stats_used_pages
= 0;
7236 server
.vm_stats_swapped_objects
= 0;
7237 server
.vm_stats_swapouts
= 0;
7238 server
.vm_stats_swapins
= 0;
7239 totsize
= server
.vm_pages
*server
.vm_page_size
;
7240 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
7241 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
7242 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
7246 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
7248 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
7249 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
7250 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
7251 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
7253 /* Initialize threaded I/O (used by Virtual Memory) */
7254 server
.io_newjobs
= listCreate();
7255 server
.io_processing
= listCreate();
7256 server
.io_processed
= listCreate();
7257 server
.io_ready_clients
= listCreate();
7258 pthread_mutex_init(&server
.io_mutex
,NULL
);
7259 pthread_mutex_init(&server
.obj_freelist_mutex
,NULL
);
7260 pthread_mutex_init(&server
.io_swapfile_mutex
,NULL
);
7261 server
.io_active_threads
= 0;
7262 if (pipe(pipefds
) == -1) {
7263 redisLog(REDIS_WARNING
,"Unable to intialized VM: pipe(2): %s. Exiting."
7267 server
.io_ready_pipe_read
= pipefds
[0];
7268 server
.io_ready_pipe_write
= pipefds
[1];
7269 redisAssert(anetNonBlock(NULL
,server
.io_ready_pipe_read
) != ANET_ERR
);
7270 /* LZF requires a lot of stack */
7271 pthread_attr_init(&server
.io_threads_attr
);
7272 pthread_attr_getstacksize(&server
.io_threads_attr
, &stacksize
);
7273 while (stacksize
< REDIS_THREAD_STACK_SIZE
) stacksize
*= 2;
7274 pthread_attr_setstacksize(&server
.io_threads_attr
, stacksize
);
7275 /* Listen for events in the threaded I/O pipe */
7276 if (aeCreateFileEvent(server
.el
, server
.io_ready_pipe_read
, AE_READABLE
,
7277 vmThreadedIOCompletedJob
, NULL
) == AE_ERR
)
7278 oom("creating file event");
7281 /* Mark the page as used */
7282 static void vmMarkPageUsed(off_t page
) {
7283 off_t byte
= page
/8;
7285 redisAssert(vmFreePage(page
) == 1);
7286 server
.vm_bitmap
[byte
] |= 1<<bit
;
7287 redisLog(REDIS_DEBUG
,"Mark used: %lld (byte:%lld bit:%d)\n",
7288 (long long)page
, (long long)byte
, bit
);
7291 /* Mark N contiguous pages as used, with 'page' being the first. */
7292 static void vmMarkPagesUsed(off_t page
, off_t count
) {
7295 for (j
= 0; j
< count
; j
++)
7296 vmMarkPageUsed(page
+j
);
7297 server
.vm_stats_used_pages
+= count
;
7300 /* Mark the page as free */
7301 static void vmMarkPageFree(off_t page
) {
7302 off_t byte
= page
/8;
7304 redisAssert(vmFreePage(page
) == 0);
7305 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
7306 redisLog(REDIS_DEBUG
,"Mark free: %lld (byte:%lld bit:%d)\n",
7307 (long long)page
, (long long)byte
, bit
);
7310 /* Mark N contiguous pages as free, with 'page' being the first. */
7311 static void vmMarkPagesFree(off_t page
, off_t count
) {
7314 for (j
= 0; j
< count
; j
++)
7315 vmMarkPageFree(page
+j
);
7316 server
.vm_stats_used_pages
-= count
;
7317 if (server
.vm_stats_used_pages
> 100000000) {
7322 /* Test if the page is free */
7323 static int vmFreePage(off_t page
) {
7324 off_t byte
= page
/8;
7326 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
7329 /* Find N contiguous free pages storing the first page of the cluster in *first.
7330 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
7331 * REDIS_ERR is returned.
7333 * This function uses a simple algorithm: we try to allocate
7334 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
7335 * again from the start of the swap file searching for free spaces.
7337 * If it looks pretty clear that there are no free pages near our offset
7338 * we try to find less populated places doing a forward jump of
7339 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
7340 * without hurry, and then we jump again and so forth...
7342 * This function can be improved using a free list to avoid to guess
7343 * too much, since we could collect data about freed pages.
7345 * note: I implemented this function just after watching an episode of
7346 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
7348 static int vmFindContiguousPages(off_t
*first
, off_t n
) {
7349 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
7351 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
7352 server
.vm_near_pages
= 0;
7353 server
.vm_next_page
= 0;
7355 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
7356 base
= server
.vm_next_page
;
7358 while(offset
< server
.vm_pages
) {
7359 off_t
this = base
+offset
;
7361 /* If we overflow, restart from page zero */
7362 if (this >= server
.vm_pages
) {
7363 this -= server
.vm_pages
;
7365 /* Just overflowed, what we found on tail is no longer
7366 * interesting, as it's no longer contiguous. */
7370 redisLog(REDIS_DEBUG
, "THIS: %lld (%c)\n", (long long) this, vmFreePage(this) ? 'F' : 'X');
7371 if (vmFreePage(this)) {
7372 /* This is a free page */
7374 /* Already got N free pages? Return to the caller, with success */
7376 *first
= this-(n
-1);
7377 server
.vm_next_page
= this+1;
7381 /* The current one is not a free page */
7385 /* Fast-forward if the current page is not free and we already
7386 * searched enough near this place. */
7388 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
7389 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
7391 /* Note that even if we rewind after the jump, we are don't need
7392 * to make sure numfree is set to zero as we only jump *if* it
7393 * is set to zero. */
7395 /* Otherwise just check the next page */
7402 /* Write the specified object at the specified page of the swap file */
7403 static int vmWriteObjectOnSwap(robj
*o
, off_t page
) {
7404 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
7405 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
7406 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
7407 redisLog(REDIS_WARNING
,
7408 "Critical VM problem in vmSwapObjectBlocking(): can't seek: %s",
7412 rdbSaveObject(server
.vm_fp
,o
);
7413 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
7417 /* Swap the 'val' object relative to 'key' into disk. Store all the information
7418 * needed to later retrieve the object into the key object.
7419 * If we can't find enough contiguous empty pages to swap the object on disk
7420 * REDIS_ERR is returned. */
7421 static int vmSwapObjectBlocking(robj
*key
, robj
*val
) {
7422 off_t pages
= rdbSavedObjectPages(val
,NULL
);
7425 assert(key
->storage
== REDIS_VM_MEMORY
);
7426 assert(key
->refcount
== 1);
7427 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return REDIS_ERR
;
7428 if (vmWriteObjectOnSwap(val
,page
) == REDIS_ERR
) return REDIS_ERR
;
7429 key
->vm
.page
= page
;
7430 key
->vm
.usedpages
= pages
;
7431 key
->storage
= REDIS_VM_SWAPPED
;
7432 key
->vtype
= val
->type
;
7433 decrRefCount(val
); /* Deallocate the object from memory. */
7434 vmMarkPagesUsed(page
,pages
);
7435 redisLog(REDIS_DEBUG
,"VM: object %s swapped out at %lld (%lld pages)",
7436 (unsigned char*) key
->ptr
,
7437 (unsigned long long) page
, (unsigned long long) pages
);
7438 server
.vm_stats_swapped_objects
++;
7439 server
.vm_stats_swapouts
++;
7440 fflush(server
.vm_fp
);
7444 static robj
*vmReadObjectFromSwap(off_t page
, int type
) {
7447 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
7448 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
7449 redisLog(REDIS_WARNING
,
7450 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
7454 o
= rdbLoadObject(type
,server
.vm_fp
);
7456 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno
));
7459 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
7463 /* Load the value object relative to the 'key' object from swap to memory.
7464 * The newly allocated object is returned.
7466 * If preview is true the unserialized object is returned to the caller but
7467 * no changes are made to the key object, nor the pages are marked as freed */
7468 static robj
*vmGenericLoadObject(robj
*key
, int preview
) {
7471 redisAssert(key
->storage
== REDIS_VM_SWAPPED
|| key
->storage
== REDIS_VM_LOADING
);
7472 val
= vmReadObjectFromSwap(key
->vm
.page
,key
->vtype
);
7474 key
->storage
= REDIS_VM_MEMORY
;
7475 key
->vm
.atime
= server
.unixtime
;
7476 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
7477 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk",
7478 (unsigned char*) key
->ptr
);
7479 server
.vm_stats_swapped_objects
--;
7481 redisLog(REDIS_DEBUG
, "VM: object %s previewed from disk",
7482 (unsigned char*) key
->ptr
);
7484 server
.vm_stats_swapins
++;
7488 /* Plain object loading, from swap to memory */
7489 static robj
*vmLoadObject(robj
*key
) {
7490 /* If we are loading the object in background, stop it, we
7491 * need to load this object synchronously ASAP. */
7492 if (key
->storage
== REDIS_VM_LOADING
)
7493 vmCancelThreadedIOJob(key
);
7494 return vmGenericLoadObject(key
,0);
7497 /* Just load the value on disk, without to modify the key.
7498 * This is useful when we want to perform some operation on the value
7499 * without to really bring it from swap to memory, like while saving the
7500 * dataset or rewriting the append only log. */
7501 static robj
*vmPreviewObject(robj
*key
) {
7502 return vmGenericLoadObject(key
,1);
7505 /* How a good candidate is this object for swapping?
7506 * The better candidate it is, the greater the returned value.
7508 * Currently we try to perform a fast estimation of the object size in
7509 * memory, and combine it with aging informations.
7511 * Basically swappability = idle-time * log(estimated size)
7513 * Bigger objects are preferred over smaller objects, but not
7514 * proportionally, this is why we use the logarithm. This algorithm is
7515 * just a first try and will probably be tuned later. */
7516 static double computeObjectSwappability(robj
*o
) {
7517 time_t age
= server
.unixtime
- o
->vm
.atime
;
7521 struct dictEntry
*de
;
7524 if (age
<= 0) return 0;
7527 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
7530 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
7535 listNode
*ln
= listFirst(l
);
7537 asize
= sizeof(list
);
7539 robj
*ele
= ln
->value
;
7542 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
7543 (sizeof(*o
)+sdslen(ele
->ptr
)) :
7545 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
7550 z
= (o
->type
== REDIS_ZSET
);
7551 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
7553 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
7554 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
7559 de
= dictGetRandomKey(d
);
7560 ele
= dictGetEntryKey(de
);
7561 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
7562 (sizeof(*o
)+sdslen(ele
->ptr
)) :
7564 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
7565 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
7569 return (double)asize
*log(1+asize
);
7572 /* Try to swap an object that's a good candidate for swapping.
7573 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
7574 * to swap any object at all.
7576 * If 'usethreaded' is true, Redis will try to swap the object in background
7577 * using I/O threads. */
7578 static int vmSwapOneObject(int usethreads
) {
7580 struct dictEntry
*best
= NULL
;
7581 double best_swappability
= 0;
7582 redisDb
*best_db
= NULL
;
7585 for (j
= 0; j
< server
.dbnum
; j
++) {
7586 redisDb
*db
= server
.db
+j
;
7587 /* Why maxtries is set to 100?
7588 * Because this way (usually) we'll find 1 object even if just 1% - 2%
7589 * are swappable objects */
7592 if (dictSize(db
->dict
) == 0) continue;
7593 for (i
= 0; i
< 5; i
++) {
7595 double swappability
;
7597 if (maxtries
) maxtries
--;
7598 de
= dictGetRandomKey(db
->dict
);
7599 key
= dictGetEntryKey(de
);
7600 val
= dictGetEntryVal(de
);
7601 /* Only swap objects that are currently in memory.
7603 * Also don't swap shared objects if threaded VM is on, as we
7604 * try to ensure that the main thread does not touch the
7605 * object while the I/O thread is using it, but we can't
7606 * control other keys without adding additional mutex. */
7607 if (key
->storage
!= REDIS_VM_MEMORY
||
7608 (server
.vm_max_threads
!= 0 && val
->refcount
!= 1)) {
7609 if (maxtries
) i
--; /* don't count this try */
7612 swappability
= computeObjectSwappability(val
);
7613 if (!best
|| swappability
> best_swappability
) {
7615 best_swappability
= swappability
;
7621 redisLog(REDIS_DEBUG
,"No swappable key found!");
7624 key
= dictGetEntryKey(best
);
7625 val
= dictGetEntryVal(best
);
7627 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
7628 key
->ptr
, best_swappability
);
7630 /* Unshare the key if needed */
7631 if (key
->refcount
> 1) {
7632 robj
*newkey
= dupStringObject(key
);
7634 key
= dictGetEntryKey(best
) = newkey
;
7638 vmSwapObjectThreaded(key
,val
,best_db
);
7641 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
7642 dictGetEntryVal(best
) = NULL
;
7650 static int vmSwapOneObjectBlocking() {
7651 return vmSwapOneObject(0);
7654 static int vmSwapOneObjectThreaded() {
7655 return vmSwapOneObject(1);
7658 /* Return true if it's safe to swap out objects in a given moment.
7659 * Basically we don't want to swap objects out while there is a BGSAVE
7660 * or a BGAEOREWRITE running in backgroud. */
7661 static int vmCanSwapOut(void) {
7662 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
7665 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
7666 * and was deleted. Otherwise 0 is returned. */
7667 static int deleteIfSwapped(redisDb
*db
, robj
*key
) {
7671 if ((de
= dictFind(db
->dict
,key
)) == NULL
) return 0;
7672 foundkey
= dictGetEntryKey(de
);
7673 if (foundkey
->storage
== REDIS_VM_MEMORY
) return 0;
7678 /* =================== Virtual Memory - Threaded I/O ======================= */
7680 static void freeIOJob(iojob
*j
) {
7681 if ((j
->type
== REDIS_IOJOB_PREPARE_SWAP
||
7682 j
->type
== REDIS_IOJOB_DO_SWAP
||
7683 j
->type
== REDIS_IOJOB_LOAD
) && j
->val
!= NULL
)
7684 decrRefCount(j
->val
);
7685 decrRefCount(j
->key
);
7689 /* Every time a thread finished a Job, it writes a byte into the write side
7690 * of an unix pipe in order to "awake" the main thread, and this function
7692 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
,
7696 int retval
, processed
= 0, toprocess
= -1, trytoswap
= 1;
7698 REDIS_NOTUSED(mask
);
7699 REDIS_NOTUSED(privdata
);
7701 /* For every byte we read in the read side of the pipe, there is one
7702 * I/O job completed to process. */
7703 while((retval
= read(fd
,buf
,1)) == 1) {
7707 struct dictEntry
*de
;
7709 redisLog(REDIS_DEBUG
,"Processing I/O completed job");
7711 /* Get the processed element (the oldest one) */
7713 assert(listLength(server
.io_processed
) != 0);
7714 if (toprocess
== -1) {
7715 toprocess
= (listLength(server
.io_processed
)*REDIS_MAX_COMPLETED_JOBS_PROCESSED
)/100;
7716 if (toprocess
<= 0) toprocess
= 1;
7718 ln
= listFirst(server
.io_processed
);
7720 listDelNode(server
.io_processed
,ln
);
7722 /* If this job is marked as canceled, just ignore it */
7727 /* Post process it in the main thread, as there are things we
7728 * can do just here to avoid race conditions and/or invasive locks */
7729 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
);
7730 de
= dictFind(j
->db
->dict
,j
->key
);
7732 key
= dictGetEntryKey(de
);
7733 if (j
->type
== REDIS_IOJOB_LOAD
) {
7736 /* Key loaded, bring it at home */
7737 key
->storage
= REDIS_VM_MEMORY
;
7738 key
->vm
.atime
= server
.unixtime
;
7739 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
7740 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk (threaded)",
7741 (unsigned char*) key
->ptr
);
7742 server
.vm_stats_swapped_objects
--;
7743 server
.vm_stats_swapins
++;
7744 dictGetEntryVal(de
) = j
->val
;
7745 incrRefCount(j
->val
);
7748 /* Handle clients waiting for this key to be loaded. */
7749 handleClientsBlockedOnSwappedKey(db
,key
);
7750 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
7751 /* Now we know the amount of pages required to swap this object.
7752 * Let's find some space for it, and queue this task again
7753 * rebranded as REDIS_IOJOB_DO_SWAP. */
7754 if (!vmCanSwapOut() ||
7755 vmFindContiguousPages(&j
->page
,j
->pages
) == REDIS_ERR
)
7757 /* Ooops... no space or we can't swap as there is
7758 * a fork()ed Redis trying to save stuff on disk. */
7760 key
->storage
= REDIS_VM_MEMORY
; /* undo operation */
7762 /* Note that we need to mark this pages as used now,
7763 * if the job will be canceled, we'll mark them as freed
7765 vmMarkPagesUsed(j
->page
,j
->pages
);
7766 j
->type
= REDIS_IOJOB_DO_SWAP
;
7771 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
7774 /* Key swapped. We can finally free some memory. */
7775 if (key
->storage
!= REDIS_VM_SWAPPING
) {
7776 printf("key->storage: %d\n",key
->storage
);
7777 printf("key->name: %s\n",(char*)key
->ptr
);
7778 printf("key->refcount: %d\n",key
->refcount
);
7779 printf("val: %p\n",(void*)j
->val
);
7780 printf("val->type: %d\n",j
->val
->type
);
7781 printf("val->ptr: %s\n",(char*)j
->val
->ptr
);
7783 redisAssert(key
->storage
== REDIS_VM_SWAPPING
);
7784 val
= dictGetEntryVal(de
);
7785 key
->vm
.page
= j
->page
;
7786 key
->vm
.usedpages
= j
->pages
;
7787 key
->storage
= REDIS_VM_SWAPPED
;
7788 key
->vtype
= j
->val
->type
;
7789 decrRefCount(val
); /* Deallocate the object from memory. */
7790 dictGetEntryVal(de
) = NULL
;
7791 redisLog(REDIS_DEBUG
,
7792 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
7793 (unsigned char*) key
->ptr
,
7794 (unsigned long long) j
->page
, (unsigned long long) j
->pages
);
7795 server
.vm_stats_swapped_objects
++;
7796 server
.vm_stats_swapouts
++;
7798 /* Put a few more swap requests in queue if we are still
7800 if (trytoswap
&& vmCanSwapOut() &&
7801 zmalloc_used_memory() > server
.vm_max_memory
)
7806 more
= listLength(server
.io_newjobs
) <
7807 (unsigned) server
.vm_max_threads
;
7809 /* Don't waste CPU time if swappable objects are rare. */
7810 if (vmSwapOneObjectThreaded() == REDIS_ERR
) {
7818 if (processed
== toprocess
) return;
7820 if (retval
< 0 && errno
!= EAGAIN
) {
7821 redisLog(REDIS_WARNING
,
7822 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
7827 static void lockThreadedIO(void) {
7828 pthread_mutex_lock(&server
.io_mutex
);
7831 static void unlockThreadedIO(void) {
7832 pthread_mutex_unlock(&server
.io_mutex
);
7835 /* Remove the specified object from the threaded I/O queue if still not
7836 * processed, otherwise make sure to flag it as canceled. */
7837 static void vmCancelThreadedIOJob(robj
*o
) {
7839 server
.io_newjobs
, /* 0 */
7840 server
.io_processing
, /* 1 */
7841 server
.io_processed
/* 2 */
7845 assert(o
->storage
== REDIS_VM_LOADING
|| o
->storage
== REDIS_VM_SWAPPING
);
7848 /* Search for a matching key in one of the queues */
7849 for (i
= 0; i
< 3; i
++) {
7853 listRewind(lists
[i
],&li
);
7854 while ((ln
= listNext(&li
)) != NULL
) {
7855 iojob
*job
= ln
->value
;
7857 if (job
->canceled
) continue; /* Skip this, already canceled. */
7858 if (compareStringObjects(job
->key
,o
) == 0) {
7859 redisLog(REDIS_DEBUG
,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
7860 (void*)job
, (char*)o
->ptr
, job
->type
, i
);
7861 /* Mark the pages as free since the swap didn't happened
7862 * or happened but is now discarded. */
7863 if (i
!= 1 && job
->type
== REDIS_IOJOB_DO_SWAP
)
7864 vmMarkPagesFree(job
->page
,job
->pages
);
7865 /* Cancel the job. It depends on the list the job is
7868 case 0: /* io_newjobs */
7869 /* If the job was yet not processed the best thing to do
7870 * is to remove it from the queue at all */
7872 listDelNode(lists
[i
],ln
);
7874 case 1: /* io_processing */
7875 /* Oh Shi- the thread is messing with the Job:
7877 * Probably it's accessing the object if this is a
7878 * PREPARE_SWAP or DO_SWAP job.
7879 * If it's a LOAD job it may be reading from disk and
7880 * if we don't wait for the job to terminate before to
7881 * cancel it, maybe in a few microseconds data can be
7882 * corrupted in this pages. So the short story is:
7884 * Better to wait for the job to move into the
7885 * next queue (processed)... */
7887 /* We try again and again until the job is completed. */
7889 /* But let's wait some time for the I/O thread
7890 * to finish with this job. After all this condition
7891 * should be very rare. */
7894 case 2: /* io_processed */
7895 /* The job was already processed, that's easy...
7896 * just mark it as canceled so that we'll ignore it
7897 * when processing completed jobs. */
7901 /* Finally we have to adjust the storage type of the object
7902 * in order to "UNDO" the operaiton. */
7903 if (o
->storage
== REDIS_VM_LOADING
)
7904 o
->storage
= REDIS_VM_SWAPPED
;
7905 else if (o
->storage
== REDIS_VM_SWAPPING
)
7906 o
->storage
= REDIS_VM_MEMORY
;
7913 assert(1 != 1); /* We should never reach this */
7916 static void *IOThreadEntryPoint(void *arg
) {
7921 pthread_detach(pthread_self());
7923 /* Get a new job to process */
7925 if (listLength(server
.io_newjobs
) == 0) {
7926 /* No new jobs in queue, exit. */
7927 redisLog(REDIS_DEBUG
,"Thread %lld exiting, nothing to do",
7928 (long long) pthread_self());
7929 server
.io_active_threads
--;
7933 ln
= listFirst(server
.io_newjobs
);
7935 listDelNode(server
.io_newjobs
,ln
);
7936 /* Add the job in the processing queue */
7937 j
->thread
= pthread_self();
7938 listAddNodeTail(server
.io_processing
,j
);
7939 ln
= listLast(server
.io_processing
); /* We use ln later to remove it */
7941 redisLog(REDIS_DEBUG
,"Thread %lld got a new job (type %d): %p about key '%s'",
7942 (long long) pthread_self(), j
->type
, (void*)j
, (char*)j
->key
->ptr
);
7944 /* Process the Job */
7945 if (j
->type
== REDIS_IOJOB_LOAD
) {
7946 j
->val
= vmReadObjectFromSwap(j
->page
,j
->key
->vtype
);
7947 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
7948 FILE *fp
= fopen("/dev/null","w+");
7949 j
->pages
= rdbSavedObjectPages(j
->val
,fp
);
7951 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
7952 if (vmWriteObjectOnSwap(j
->val
,j
->page
) == REDIS_ERR
)
7956 /* Done: insert the job into the processed queue */
7957 redisLog(REDIS_DEBUG
,"Thread %lld completed the job: %p (key %s)",
7958 (long long) pthread_self(), (void*)j
, (char*)j
->key
->ptr
);
7960 listDelNode(server
.io_processing
,ln
);
7961 listAddNodeTail(server
.io_processed
,j
);
7964 /* Signal the main thread there is new stuff to process */
7965 assert(write(server
.io_ready_pipe_write
,"x",1) == 1);
7967 return NULL
; /* never reached */
7970 static void spawnIOThread(void) {
7972 sigset_t mask
, omask
;
7975 sigaddset(&mask
,SIGCHLD
);
7976 sigaddset(&mask
,SIGHUP
);
7977 sigaddset(&mask
,SIGPIPE
);
7978 pthread_sigmask(SIG_SETMASK
, &mask
, &omask
);
7979 pthread_create(&thread
,&server
.io_threads_attr
,IOThreadEntryPoint
,NULL
);
7980 pthread_sigmask(SIG_SETMASK
, &omask
, NULL
);
7981 server
.io_active_threads
++;
7984 /* We need to wait for the last thread to exit before we are able to
7985 * fork() in order to BGSAVE or BGREWRITEAOF. */
7986 static void waitEmptyIOJobsQueue(void) {
7988 int io_processed_len
;
7991 if (listLength(server
.io_newjobs
) == 0 &&
7992 listLength(server
.io_processing
) == 0 &&
7993 server
.io_active_threads
== 0)
7998 /* While waiting for empty jobs queue condition we post-process some
7999 * finshed job, as I/O threads may be hanging trying to write against
8000 * the io_ready_pipe_write FD but there are so much pending jobs that
8002 io_processed_len
= listLength(server
.io_processed
);
8004 if (io_processed_len
) {
8005 vmThreadedIOCompletedJob(NULL
,server
.io_ready_pipe_read
,NULL
,0);
8006 usleep(1000); /* 1 millisecond */
8008 usleep(10000); /* 10 milliseconds */
8013 static void vmReopenSwapFile(void) {
8014 /* Note: we don't close the old one as we are in the child process
8015 * and don't want to mess at all with the original file object. */
8016 server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b");
8017 if (server
.vm_fp
== NULL
) {
8018 redisLog(REDIS_WARNING
,"Can't re-open the VM swap file: %s. Exiting.",
8019 server
.vm_swap_file
);
8022 server
.vm_fd
= fileno(server
.vm_fp
);
8025 /* This function must be called while with threaded IO locked */
8026 static void queueIOJob(iojob
*j
) {
8027 redisLog(REDIS_DEBUG
,"Queued IO Job %p type %d about key '%s'\n",
8028 (void*)j
, j
->type
, (char*)j
->key
->ptr
);
8029 listAddNodeTail(server
.io_newjobs
,j
);
8030 if (server
.io_active_threads
< server
.vm_max_threads
)
8034 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
) {
8037 assert(key
->storage
== REDIS_VM_MEMORY
);
8038 assert(key
->refcount
== 1);
8040 j
= zmalloc(sizeof(*j
));
8041 j
->type
= REDIS_IOJOB_PREPARE_SWAP
;
8043 j
->key
= dupStringObject(key
);
8047 j
->thread
= (pthread_t
) -1;
8048 key
->storage
= REDIS_VM_SWAPPING
;
8056 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
8058 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
8059 * If there is not already a job loading the key, it is craeted.
8060 * The key is added to the io_keys list in the client structure, and also
8061 * in the hash table mapping swapped keys to waiting clients, that is,
8062 * server.io_waited_keys. */
8063 static int waitForSwappedKey(redisClient
*c
, robj
*key
) {
8064 struct dictEntry
*de
;
8068 /* If the key does not exist or is already in RAM we don't need to
8069 * block the client at all. */
8070 de
= dictFind(c
->db
->dict
,key
);
8071 if (de
== NULL
) return 0;
8072 o
= dictGetEntryKey(de
);
8073 if (o
->storage
== REDIS_VM_MEMORY
) {
8075 } else if (o
->storage
== REDIS_VM_SWAPPING
) {
8076 /* We were swapping the key, undo it! */
8077 vmCancelThreadedIOJob(o
);
8081 /* OK: the key is either swapped, or being loaded just now. */
8083 /* Add the key to the list of keys this client is waiting for.
8084 * This maps clients to keys they are waiting for. */
8085 listAddNodeTail(c
->io_keys
,key
);
8088 /* Add the client to the swapped keys => clients waiting map. */
8089 de
= dictFind(c
->db
->io_keys
,key
);
8093 /* For every key we take a list of clients blocked for it */
8095 retval
= dictAdd(c
->db
->io_keys
,key
,l
);
8097 assert(retval
== DICT_OK
);
8099 l
= dictGetEntryVal(de
);
8101 listAddNodeTail(l
,c
);
8103 /* Are we already loading the key from disk? If not create a job */
8104 if (o
->storage
== REDIS_VM_SWAPPED
) {
8107 o
->storage
= REDIS_VM_LOADING
;
8108 j
= zmalloc(sizeof(*j
));
8109 j
->type
= REDIS_IOJOB_LOAD
;
8111 j
->key
= dupStringObject(key
);
8112 j
->key
->vtype
= o
->vtype
;
8113 j
->page
= o
->vm
.page
;
8116 j
->thread
= (pthread_t
) -1;
8124 /* Is this client attempting to run a command against swapped keys?
8125 * If so, block it ASAP, load the keys in background, then resume it.
8127 * The important idea about this function is that it can fail! If keys will
8128 * still be swapped when the client is resumed, this key lookups will
8129 * just block loading keys from disk. In practical terms this should only
8130 * happen with SORT BY command or if there is a bug in this function.
8132 * Return 1 if the client is marked as blocked, 0 if the client can
8133 * continue as the keys it is going to access appear to be in memory. */
8134 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
) {
8135 if (cmd
->proc
== getCommand
) {
8136 waitForSwappedKey(c
,c
->argv
[1]);
8138 /* If the client was blocked for at least one key, mark it as blocked. */
8139 if (listLength(c
->io_keys
)) {
8140 c
->flags
|= REDIS_IO_WAIT
;
8141 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
8142 server
.vm_blocked_clients
++;
8149 /* Remove the 'key' from the list of blocked keys for a given client.
8151 * The function returns 1 when there are no longer blocking keys after
8152 * the current one was removed (and the client can be unblocked). */
8153 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
) {
8157 struct dictEntry
*de
;
8159 /* Remove the key from the list of keys this client is waiting for. */
8160 listRewind(c
->io_keys
,&li
);
8161 while ((ln
= listNext(&li
)) != NULL
) {
8162 if (compareStringObjects(ln
->value
,key
) == 0) {
8163 listDelNode(c
->io_keys
,ln
);
8169 /* Remove the client form the key => waiting clients map. */
8170 de
= dictFind(c
->db
->io_keys
,key
);
8172 l
= dictGetEntryVal(de
);
8173 ln
= listSearchKey(l
,c
);
8176 if (listLength(l
) == 0)
8177 dictDelete(c
->db
->io_keys
,key
);
8179 return listLength(c
->io_keys
) == 0;
8182 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
) {
8183 struct dictEntry
*de
;
8188 de
= dictFind(db
->io_keys
,key
);
8191 l
= dictGetEntryVal(de
);
8192 len
= listLength(l
);
8193 /* Note: we can't use something like while(listLength(l)) as the list
8194 * can be freed by the calling function when we remove the last element. */
8197 redisClient
*c
= ln
->value
;
8199 if (dontWaitForSwappedKey(c
,key
)) {
8200 /* Put the client in the list of clients ready to go as we
8201 * loaded all the keys about it. */
8202 listAddNodeTail(server
.io_ready_clients
,c
);
8207 /* ================================= Debugging ============================== */
8209 static void debugCommand(redisClient
*c
) {
8210 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
8212 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
8213 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
8214 addReply(c
,shared
.err
);
8218 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
8219 addReply(c
,shared
.err
);
8222 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
8223 addReply(c
,shared
.ok
);
8224 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
8226 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
8227 addReply(c
,shared
.err
);
8230 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
8231 addReply(c
,shared
.ok
);
8232 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
8233 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
8237 addReply(c
,shared
.nokeyerr
);
8240 key
= dictGetEntryKey(de
);
8241 val
= dictGetEntryVal(de
);
8242 if (!server
.vm_enabled
|| (key
->storage
== REDIS_VM_MEMORY
||
8243 key
->storage
== REDIS_VM_SWAPPING
)) {
8244 addReplySds(c
,sdscatprintf(sdsempty(),
8245 "+Key at:%p refcount:%d, value at:%p refcount:%d "
8246 "encoding:%d serializedlength:%lld\r\n",
8247 (void*)key
, key
->refcount
, (void*)val
, val
->refcount
,
8248 val
->encoding
, (long long) rdbSavedObjectLen(val
,NULL
)));
8250 addReplySds(c
,sdscatprintf(sdsempty(),
8251 "+Key at:%p refcount:%d, value swapped at: page %llu "
8252 "using %llu pages\r\n",
8253 (void*)key
, key
->refcount
, (unsigned long long) key
->vm
.page
,
8254 (unsigned long long) key
->vm
.usedpages
));
8256 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
8257 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
8260 if (!server
.vm_enabled
) {
8261 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
8265 addReply(c
,shared
.nokeyerr
);
8268 key
= dictGetEntryKey(de
);
8269 val
= dictGetEntryVal(de
);
8270 /* If the key is shared we want to create a copy */
8271 if (key
->refcount
> 1) {
8272 robj
*newkey
= dupStringObject(key
);
8274 key
= dictGetEntryKey(de
) = newkey
;
8277 if (key
->storage
!= REDIS_VM_MEMORY
) {
8278 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
8279 } else if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
8280 dictGetEntryVal(de
) = NULL
;
8281 addReply(c
,shared
.ok
);
8283 addReply(c
,shared
.err
);
8286 addReplySds(c
,sdsnew(
8287 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPOUT <key>|RELOAD]\r\n"));
8291 static void _redisAssert(char *estr
, char *file
, int line
) {
8292 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
8293 redisLog(REDIS_WARNING
,"==> %s:%d '%s' is not true\n",file
,line
,estr
);
8294 #ifdef HAVE_BACKTRACE
8295 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
8300 /* =================================== Main! ================================ */
8303 int linuxOvercommitMemoryValue(void) {
8304 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
8308 if (fgets(buf
,64,fp
) == NULL
) {
8317 void linuxOvercommitMemoryWarning(void) {
8318 if (linuxOvercommitMemoryValue() == 0) {
8319 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.");
8322 #endif /* __linux__ */
8324 static void daemonize(void) {
8328 if (fork() != 0) exit(0); /* parent exits */
8329 setsid(); /* create a new session */
8331 /* Every output goes to /dev/null. If Redis is daemonized but
8332 * the 'logfile' is set to 'stdout' in the configuration file
8333 * it will not log at all. */
8334 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
8335 dup2(fd
, STDIN_FILENO
);
8336 dup2(fd
, STDOUT_FILENO
);
8337 dup2(fd
, STDERR_FILENO
);
8338 if (fd
> STDERR_FILENO
) close(fd
);
8340 /* Try to write the pid file */
8341 fp
= fopen(server
.pidfile
,"w");
8343 fprintf(fp
,"%d\n",getpid());
8348 int main(int argc
, char **argv
) {
8353 resetServerSaveParams();
8354 loadServerConfig(argv
[1]);
8355 } else if (argc
> 2) {
8356 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
8359 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'");
8361 if (server
.daemonize
) daemonize();
8363 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
8365 linuxOvercommitMemoryWarning();
8368 if (server
.appendonly
) {
8369 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
8370 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %ld seconds",time(NULL
)-start
);
8372 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
8373 redisLog(REDIS_NOTICE
,"DB loaded from disk: %ld seconds",time(NULL
)-start
);
8375 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
8376 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
8378 aeDeleteEventLoop(server
.el
);
8382 /* ============================= Backtrace support ========================= */
8384 #ifdef HAVE_BACKTRACE
8385 static char *findFuncName(void *pointer
, unsigned long *offset
);
8387 static void *getMcontextEip(ucontext_t
*uc
) {
8388 #if defined(__FreeBSD__)
8389 return (void*) uc
->uc_mcontext
.mc_eip
;
8390 #elif defined(__dietlibc__)
8391 return (void*) uc
->uc_mcontext
.eip
;
8392 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
8394 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
8396 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
8398 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
8399 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
8400 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
8402 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
8404 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
8405 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
8406 #elif defined(__ia64__) /* Linux IA64 */
8407 return (void*) uc
->uc_mcontext
.sc_ip
;
8413 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
8415 char **messages
= NULL
;
8416 int i
, trace_size
= 0;
8417 unsigned long offset
=0;
8418 ucontext_t
*uc
= (ucontext_t
*) secret
;
8420 REDIS_NOTUSED(info
);
8422 redisLog(REDIS_WARNING
,
8423 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
8424 infostring
= genRedisInfoString();
8425 redisLog(REDIS_WARNING
, "%s",infostring
);
8426 /* It's not safe to sdsfree() the returned string under memory
8427 * corruption conditions. Let it leak as we are going to abort */
8429 trace_size
= backtrace(trace
, 100);
8430 /* overwrite sigaction with caller's address */
8431 if (getMcontextEip(uc
) != NULL
) {
8432 trace
[1] = getMcontextEip(uc
);
8434 messages
= backtrace_symbols(trace
, trace_size
);
8436 for (i
=1; i
<trace_size
; ++i
) {
8437 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
8439 p
= strchr(messages
[i
],'+');
8440 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
8441 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
8443 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
8446 /* free(messages); Don't call free() with possibly corrupted memory. */
8450 static void setupSigSegvAction(void) {
8451 struct sigaction act
;
8453 sigemptyset (&act
.sa_mask
);
8454 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
8455 * is used. Otherwise, sa_handler is used */
8456 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
8457 act
.sa_sigaction
= segvHandler
;
8458 sigaction (SIGSEGV
, &act
, NULL
);
8459 sigaction (SIGBUS
, &act
, NULL
);
8460 sigaction (SIGFPE
, &act
, NULL
);
8461 sigaction (SIGILL
, &act
, NULL
);
8462 sigaction (SIGBUS
, &act
, NULL
);
8466 #include "staticsymbols.h"
8467 /* This function try to convert a pointer into a function name. It's used in
8468 * oreder to provide a backtrace under segmentation fault that's able to
8469 * display functions declared as static (otherwise the backtrace is useless). */
8470 static char *findFuncName(void *pointer
, unsigned long *offset
){
8472 unsigned long off
, minoff
= 0;
8474 /* Try to match against the Symbol with the smallest offset */
8475 for (i
=0; symsTable
[i
].pointer
; i
++) {
8476 unsigned long lp
= (unsigned long) pointer
;
8478 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
8479 off
=lp
-symsTable
[i
].pointer
;
8480 if (ret
< 0 || off
< minoff
) {
8486 if (ret
== -1) return NULL
;
8488 return symsTable
[ret
].name
;
8490 #else /* HAVE_BACKTRACE */
8491 static void setupSigSegvAction(void) {
8493 #endif /* HAVE_BACKTRACE */