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
;
429 /* What keys should be loaded in background when calling this command? */
430 int vm_firstkey
; /* The first argument that's a key (0 = no keys) */
431 int vm_lastkey
; /* THe last argument that's a key */
432 int vm_keystep
; /* The step between first and last key */
435 struct redisFunctionSym
{
437 unsigned long pointer
;
440 typedef struct _redisSortObject
{
448 typedef struct _redisSortOperation
{
451 } redisSortOperation
;
453 /* ZSETs use a specialized version of Skiplists */
455 typedef struct zskiplistNode
{
456 struct zskiplistNode
**forward
;
457 struct zskiplistNode
*backward
;
462 typedef struct zskiplist
{
463 struct zskiplistNode
*header
, *tail
;
464 unsigned long length
;
468 typedef struct zset
{
473 /* Our shared "common" objects */
475 struct sharedObjectsStruct
{
476 robj
*crlf
, *ok
, *err
, *emptybulk
, *czero
, *cone
, *pong
, *space
,
477 *colon
, *nullbulk
, *nullmultibulk
, *queued
,
478 *emptymultibulk
, *wrongtypeerr
, *nokeyerr
, *syntaxerr
, *sameobjecterr
,
479 *outofrangeerr
, *plus
,
480 *select0
, *select1
, *select2
, *select3
, *select4
,
481 *select5
, *select6
, *select7
, *select8
, *select9
;
484 /* Global vars that are actally used as constants. The following double
485 * values are used for double on-disk serialization, and are initialized
486 * at runtime to avoid strange compiler optimizations. */
488 static double R_Zero
, R_PosInf
, R_NegInf
, R_Nan
;
490 /* VM threaded I/O request message */
491 #define REDIS_IOJOB_LOAD 0 /* Load from disk to memory */
492 #define REDIS_IOJOB_PREPARE_SWAP 1 /* Compute needed pages */
493 #define REDIS_IOJOB_DO_SWAP 2 /* Swap from memory to disk */
494 typedef struct iojob
{
495 int type
; /* Request type, REDIS_IOJOB_* */
496 redisDb
*db
;/* Redis database */
497 robj
*key
; /* This I/O request is about swapping this key */
498 robj
*val
; /* the value to swap for REDIS_IOREQ_*_SWAP, otherwise this
499 * field is populated by the I/O thread for REDIS_IOREQ_LOAD. */
500 off_t page
; /* Swap page where to read/write the object */
501 off_t pages
; /* Swap pages needed to safe object. PREPARE_SWAP return val */
502 int canceled
; /* True if this command was canceled by blocking side of VM */
503 pthread_t thread
; /* ID of the thread processing this entry */
506 /*================================ Prototypes =============================== */
508 static void freeStringObject(robj
*o
);
509 static void freeListObject(robj
*o
);
510 static void freeSetObject(robj
*o
);
511 static void decrRefCount(void *o
);
512 static robj
*createObject(int type
, void *ptr
);
513 static void freeClient(redisClient
*c
);
514 static int rdbLoad(char *filename
);
515 static void addReply(redisClient
*c
, robj
*obj
);
516 static void addReplySds(redisClient
*c
, sds s
);
517 static void incrRefCount(robj
*o
);
518 static int rdbSaveBackground(char *filename
);
519 static robj
*createStringObject(char *ptr
, size_t len
);
520 static robj
*dupStringObject(robj
*o
);
521 static void replicationFeedSlaves(list
*slaves
, struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
522 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
);
523 static int syncWithMaster(void);
524 static robj
*tryObjectSharing(robj
*o
);
525 static int tryObjectEncoding(robj
*o
);
526 static robj
*getDecodedObject(robj
*o
);
527 static int removeExpire(redisDb
*db
, robj
*key
);
528 static int expireIfNeeded(redisDb
*db
, robj
*key
);
529 static int deleteIfVolatile(redisDb
*db
, robj
*key
);
530 static int deleteIfSwapped(redisDb
*db
, robj
*key
);
531 static int deleteKey(redisDb
*db
, robj
*key
);
532 static time_t getExpire(redisDb
*db
, robj
*key
);
533 static int setExpire(redisDb
*db
, robj
*key
, time_t when
);
534 static void updateSlavesWaitingBgsave(int bgsaveerr
);
535 static void freeMemoryIfNeeded(void);
536 static int processCommand(redisClient
*c
);
537 static void setupSigSegvAction(void);
538 static void rdbRemoveTempFile(pid_t childpid
);
539 static void aofRemoveTempFile(pid_t childpid
);
540 static size_t stringObjectLen(robj
*o
);
541 static void processInputBuffer(redisClient
*c
);
542 static zskiplist
*zslCreate(void);
543 static void zslFree(zskiplist
*zsl
);
544 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
);
545 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
546 static void initClientMultiState(redisClient
*c
);
547 static void freeClientMultiState(redisClient
*c
);
548 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
);
549 static void unblockClientWaitingData(redisClient
*c
);
550 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
);
551 static void vmInit(void);
552 static void vmMarkPagesFree(off_t page
, off_t count
);
553 static robj
*vmLoadObject(robj
*key
);
554 static robj
*vmPreviewObject(robj
*key
);
555 static int vmSwapOneObjectBlocking(void);
556 static int vmSwapOneObjectThreaded(void);
557 static int vmCanSwapOut(void);
558 static int tryFreeOneObjectFromFreelist(void);
559 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
560 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
561 static void vmCancelThreadedIOJob(robj
*o
);
562 static void lockThreadedIO(void);
563 static void unlockThreadedIO(void);
564 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
);
565 static void freeIOJob(iojob
*j
);
566 static void queueIOJob(iojob
*j
);
567 static int vmWriteObjectOnSwap(robj
*o
, off_t page
);
568 static robj
*vmReadObjectFromSwap(off_t page
, int type
);
569 static void waitEmptyIOJobsQueue(void);
570 static void vmReopenSwapFile(void);
571 static int vmFreePage(off_t page
);
572 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
);
573 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
);
574 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
);
575 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
);
576 static struct redisCommand
*lookupCommand(char *name
);
577 static void call(redisClient
*c
, struct redisCommand
*cmd
);
578 static void resetClient(redisClient
*c
);
580 static void authCommand(redisClient
*c
);
581 static void pingCommand(redisClient
*c
);
582 static void echoCommand(redisClient
*c
);
583 static void setCommand(redisClient
*c
);
584 static void setnxCommand(redisClient
*c
);
585 static void getCommand(redisClient
*c
);
586 static void delCommand(redisClient
*c
);
587 static void existsCommand(redisClient
*c
);
588 static void incrCommand(redisClient
*c
);
589 static void decrCommand(redisClient
*c
);
590 static void incrbyCommand(redisClient
*c
);
591 static void decrbyCommand(redisClient
*c
);
592 static void selectCommand(redisClient
*c
);
593 static void randomkeyCommand(redisClient
*c
);
594 static void keysCommand(redisClient
*c
);
595 static void dbsizeCommand(redisClient
*c
);
596 static void lastsaveCommand(redisClient
*c
);
597 static void saveCommand(redisClient
*c
);
598 static void bgsaveCommand(redisClient
*c
);
599 static void bgrewriteaofCommand(redisClient
*c
);
600 static void shutdownCommand(redisClient
*c
);
601 static void moveCommand(redisClient
*c
);
602 static void renameCommand(redisClient
*c
);
603 static void renamenxCommand(redisClient
*c
);
604 static void lpushCommand(redisClient
*c
);
605 static void rpushCommand(redisClient
*c
);
606 static void lpopCommand(redisClient
*c
);
607 static void rpopCommand(redisClient
*c
);
608 static void llenCommand(redisClient
*c
);
609 static void lindexCommand(redisClient
*c
);
610 static void lrangeCommand(redisClient
*c
);
611 static void ltrimCommand(redisClient
*c
);
612 static void typeCommand(redisClient
*c
);
613 static void lsetCommand(redisClient
*c
);
614 static void saddCommand(redisClient
*c
);
615 static void sremCommand(redisClient
*c
);
616 static void smoveCommand(redisClient
*c
);
617 static void sismemberCommand(redisClient
*c
);
618 static void scardCommand(redisClient
*c
);
619 static void spopCommand(redisClient
*c
);
620 static void srandmemberCommand(redisClient
*c
);
621 static void sinterCommand(redisClient
*c
);
622 static void sinterstoreCommand(redisClient
*c
);
623 static void sunionCommand(redisClient
*c
);
624 static void sunionstoreCommand(redisClient
*c
);
625 static void sdiffCommand(redisClient
*c
);
626 static void sdiffstoreCommand(redisClient
*c
);
627 static void syncCommand(redisClient
*c
);
628 static void flushdbCommand(redisClient
*c
);
629 static void flushallCommand(redisClient
*c
);
630 static void sortCommand(redisClient
*c
);
631 static void lremCommand(redisClient
*c
);
632 static void rpoplpushcommand(redisClient
*c
);
633 static void infoCommand(redisClient
*c
);
634 static void mgetCommand(redisClient
*c
);
635 static void monitorCommand(redisClient
*c
);
636 static void expireCommand(redisClient
*c
);
637 static void expireatCommand(redisClient
*c
);
638 static void getsetCommand(redisClient
*c
);
639 static void ttlCommand(redisClient
*c
);
640 static void slaveofCommand(redisClient
*c
);
641 static void debugCommand(redisClient
*c
);
642 static void msetCommand(redisClient
*c
);
643 static void msetnxCommand(redisClient
*c
);
644 static void zaddCommand(redisClient
*c
);
645 static void zincrbyCommand(redisClient
*c
);
646 static void zrangeCommand(redisClient
*c
);
647 static void zrangebyscoreCommand(redisClient
*c
);
648 static void zcountCommand(redisClient
*c
);
649 static void zrevrangeCommand(redisClient
*c
);
650 static void zcardCommand(redisClient
*c
);
651 static void zremCommand(redisClient
*c
);
652 static void zscoreCommand(redisClient
*c
);
653 static void zremrangebyscoreCommand(redisClient
*c
);
654 static void multiCommand(redisClient
*c
);
655 static void execCommand(redisClient
*c
);
656 static void blpopCommand(redisClient
*c
);
657 static void brpopCommand(redisClient
*c
);
658 static void appendCommand(redisClient
*c
);
660 /*================================= Globals ================================= */
663 static struct redisServer server
; /* server global state */
664 static struct redisCommand cmdTable
[] = {
665 {"get",getCommand
,2,REDIS_CMD_INLINE
,1,1,1},
666 {"set",setCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,0,0,0},
667 {"setnx",setnxCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,0,0,0},
668 {"append",appendCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
669 {"del",delCommand
,-2,REDIS_CMD_INLINE
,0,0,0},
670 {"exists",existsCommand
,2,REDIS_CMD_INLINE
,1,1,1},
671 {"incr",incrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,1,1},
672 {"decr",decrCommand
,2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,1,1},
673 {"mget",mgetCommand
,-2,REDIS_CMD_INLINE
,1,-1,1},
674 {"rpush",rpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
675 {"lpush",lpushCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
676 {"rpop",rpopCommand
,2,REDIS_CMD_INLINE
,1,1,1},
677 {"lpop",lpopCommand
,2,REDIS_CMD_INLINE
,1,1,1},
678 {"brpop",brpopCommand
,-3,REDIS_CMD_INLINE
,1,1,1},
679 {"blpop",blpopCommand
,-3,REDIS_CMD_INLINE
,1,1,1},
680 {"llen",llenCommand
,2,REDIS_CMD_INLINE
,1,1,1},
681 {"lindex",lindexCommand
,3,REDIS_CMD_INLINE
,1,1,1},
682 {"lset",lsetCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
683 {"lrange",lrangeCommand
,4,REDIS_CMD_INLINE
,1,1,1},
684 {"ltrim",ltrimCommand
,4,REDIS_CMD_INLINE
,1,1,1},
685 {"lrem",lremCommand
,4,REDIS_CMD_BULK
,1,1,1},
686 {"rpoplpush",rpoplpushcommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,2,1},
687 {"sadd",saddCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
688 {"srem",sremCommand
,3,REDIS_CMD_BULK
,1,1,1},
689 {"smove",smoveCommand
,4,REDIS_CMD_BULK
,1,2,1},
690 {"sismember",sismemberCommand
,3,REDIS_CMD_BULK
,1,1,1},
691 {"scard",scardCommand
,2,REDIS_CMD_INLINE
,1,1,1},
692 {"spop",spopCommand
,2,REDIS_CMD_INLINE
,1,1,1},
693 {"srandmember",srandmemberCommand
,2,REDIS_CMD_INLINE
,1,1,1},
694 {"sinter",sinterCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,-1,1},
695 {"sinterstore",sinterstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,2,-1,1},
696 {"sunion",sunionCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,-1,1},
697 {"sunionstore",sunionstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,2,-1,1},
698 {"sdiff",sdiffCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,-1,1},
699 {"sdiffstore",sdiffstoreCommand
,-3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,2,-1,1},
700 {"smembers",sinterCommand
,2,REDIS_CMD_INLINE
,1,1,1},
701 {"zadd",zaddCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
702 {"zincrby",zincrbyCommand
,4,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
703 {"zrem",zremCommand
,3,REDIS_CMD_BULK
,1,1,1},
704 {"zremrangebyscore",zremrangebyscoreCommand
,4,REDIS_CMD_INLINE
,1,1,1},
705 {"zrange",zrangeCommand
,-4,REDIS_CMD_INLINE
,1,1,1},
706 {"zrangebyscore",zrangebyscoreCommand
,-4,REDIS_CMD_INLINE
,1,1,1},
707 {"zcount",zcountCommand
,4,REDIS_CMD_INLINE
,1,1,1},
708 {"zrevrange",zrevrangeCommand
,-4,REDIS_CMD_INLINE
,1,1,1},
709 {"zcard",zcardCommand
,2,REDIS_CMD_INLINE
,1,1,1},
710 {"zscore",zscoreCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
711 {"incrby",incrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,1,1},
712 {"decrby",decrbyCommand
,3,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,1,1},
713 {"getset",getsetCommand
,3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,1,1},
714 {"mset",msetCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,-1,2},
715 {"msetnx",msetnxCommand
,-3,REDIS_CMD_BULK
|REDIS_CMD_DENYOOM
,1,-1,2},
716 {"randomkey",randomkeyCommand
,1,REDIS_CMD_INLINE
,0,0,0},
717 {"select",selectCommand
,2,REDIS_CMD_INLINE
,0,0,0},
718 {"move",moveCommand
,3,REDIS_CMD_INLINE
,1,1,1},
719 {"rename",renameCommand
,3,REDIS_CMD_INLINE
,1,1,1},
720 {"renamenx",renamenxCommand
,3,REDIS_CMD_INLINE
,1,1,1},
721 {"expire",expireCommand
,3,REDIS_CMD_INLINE
,0,0,0},
722 {"expireat",expireatCommand
,3,REDIS_CMD_INLINE
,0,0,0},
723 {"keys",keysCommand
,2,REDIS_CMD_INLINE
,0,0,0},
724 {"dbsize",dbsizeCommand
,1,REDIS_CMD_INLINE
,0,0,0},
725 {"auth",authCommand
,2,REDIS_CMD_INLINE
,0,0,0},
726 {"ping",pingCommand
,1,REDIS_CMD_INLINE
,0,0,0},
727 {"echo",echoCommand
,2,REDIS_CMD_BULK
,0,0,0},
728 {"save",saveCommand
,1,REDIS_CMD_INLINE
,0,0,0},
729 {"bgsave",bgsaveCommand
,1,REDIS_CMD_INLINE
,0,0,0},
730 {"bgrewriteaof",bgrewriteaofCommand
,1,REDIS_CMD_INLINE
,0,0,0},
731 {"shutdown",shutdownCommand
,1,REDIS_CMD_INLINE
,0,0,0},
732 {"lastsave",lastsaveCommand
,1,REDIS_CMD_INLINE
,0,0,0},
733 {"type",typeCommand
,2,REDIS_CMD_INLINE
,1,1,1},
734 {"multi",multiCommand
,1,REDIS_CMD_INLINE
,0,0,0},
735 {"exec",execCommand
,1,REDIS_CMD_INLINE
,0,0,0},
736 {"sync",syncCommand
,1,REDIS_CMD_INLINE
,0,0,0},
737 {"flushdb",flushdbCommand
,1,REDIS_CMD_INLINE
,0,0,0},
738 {"flushall",flushallCommand
,1,REDIS_CMD_INLINE
,0,0,0},
739 {"sort",sortCommand
,-2,REDIS_CMD_INLINE
|REDIS_CMD_DENYOOM
,1,1,1},
740 {"info",infoCommand
,1,REDIS_CMD_INLINE
,0,0,0},
741 {"monitor",monitorCommand
,1,REDIS_CMD_INLINE
,0,0,0},
742 {"ttl",ttlCommand
,2,REDIS_CMD_INLINE
,1,1,1},
743 {"slaveof",slaveofCommand
,3,REDIS_CMD_INLINE
,0,0,0},
744 {"debug",debugCommand
,-2,REDIS_CMD_INLINE
,0,0,0},
745 {NULL
,NULL
,0,0,0,0,0}
748 /*============================ Utility functions ============================ */
750 /* Glob-style pattern matching. */
751 int stringmatchlen(const char *pattern
, int patternLen
,
752 const char *string
, int stringLen
, int nocase
)
757 while (pattern
[1] == '*') {
762 return 1; /* match */
764 if (stringmatchlen(pattern
+1, patternLen
-1,
765 string
, stringLen
, nocase
))
766 return 1; /* match */
770 return 0; /* no match */
774 return 0; /* no match */
784 not = pattern
[0] == '^';
791 if (pattern
[0] == '\\') {
794 if (pattern
[0] == string
[0])
796 } else if (pattern
[0] == ']') {
798 } else if (patternLen
== 0) {
802 } else if (pattern
[1] == '-' && patternLen
>= 3) {
803 int start
= pattern
[0];
804 int end
= pattern
[2];
812 start
= tolower(start
);
818 if (c
>= start
&& c
<= end
)
822 if (pattern
[0] == string
[0])
825 if (tolower((int)pattern
[0]) == tolower((int)string
[0]))
835 return 0; /* no match */
841 if (patternLen
>= 2) {
848 if (pattern
[0] != string
[0])
849 return 0; /* no match */
851 if (tolower((int)pattern
[0]) != tolower((int)string
[0]))
852 return 0; /* no match */
860 if (stringLen
== 0) {
861 while(*pattern
== '*') {
868 if (patternLen
== 0 && stringLen
== 0)
873 static void redisLog(int level
, const char *fmt
, ...) {
877 fp
= (server
.logfile
== NULL
) ? stdout
: fopen(server
.logfile
,"a");
881 if (level
>= server
.verbosity
) {
887 strftime(buf
,64,"%d %b %H:%M:%S",localtime(&now
));
888 fprintf(fp
,"[%d] %s %c ",(int)getpid(),buf
,c
[level
]);
889 vfprintf(fp
, fmt
, ap
);
895 if (server
.logfile
) fclose(fp
);
898 /*====================== Hash table type implementation ==================== */
900 /* This is an hash table type that uses the SDS dynamic strings libary as
901 * keys and radis objects as values (objects can hold SDS strings,
904 static void dictVanillaFree(void *privdata
, void *val
)
906 DICT_NOTUSED(privdata
);
910 static void dictListDestructor(void *privdata
, void *val
)
912 DICT_NOTUSED(privdata
);
913 listRelease((list
*)val
);
916 static int sdsDictKeyCompare(void *privdata
, const void *key1
,
920 DICT_NOTUSED(privdata
);
922 l1
= sdslen((sds
)key1
);
923 l2
= sdslen((sds
)key2
);
924 if (l1
!= l2
) return 0;
925 return memcmp(key1
, key2
, l1
) == 0;
928 static void dictRedisObjectDestructor(void *privdata
, void *val
)
930 DICT_NOTUSED(privdata
);
932 if (val
== NULL
) return; /* Values of swapped out keys as set to NULL */
936 static int dictObjKeyCompare(void *privdata
, const void *key1
,
939 const robj
*o1
= key1
, *o2
= key2
;
940 return sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
943 static unsigned int dictObjHash(const void *key
) {
945 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
948 static int dictEncObjKeyCompare(void *privdata
, const void *key1
,
951 robj
*o1
= (robj
*) key1
, *o2
= (robj
*) key2
;
954 o1
= getDecodedObject(o1
);
955 o2
= getDecodedObject(o2
);
956 cmp
= sdsDictKeyCompare(privdata
,o1
->ptr
,o2
->ptr
);
962 static unsigned int dictEncObjHash(const void *key
) {
963 robj
*o
= (robj
*) key
;
965 if (o
->encoding
== REDIS_ENCODING_RAW
) {
966 return dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
968 if (o
->encoding
== REDIS_ENCODING_INT
) {
972 len
= snprintf(buf
,32,"%ld",(long)o
->ptr
);
973 return dictGenHashFunction((unsigned char*)buf
, len
);
977 o
= getDecodedObject(o
);
978 hash
= dictGenHashFunction(o
->ptr
, sdslen((sds
)o
->ptr
));
985 /* Sets type and expires */
986 static dictType setDictType
= {
987 dictEncObjHash
, /* hash function */
990 dictEncObjKeyCompare
, /* key compare */
991 dictRedisObjectDestructor
, /* key destructor */
992 NULL
/* val destructor */
995 /* Sorted sets hash (note: a skiplist is used in addition to the hash table) */
996 static dictType zsetDictType
= {
997 dictEncObjHash
, /* hash function */
1000 dictEncObjKeyCompare
, /* key compare */
1001 dictRedisObjectDestructor
, /* key destructor */
1002 dictVanillaFree
/* val destructor of malloc(sizeof(double)) */
1006 static dictType hashDictType
= {
1007 dictObjHash
, /* hash function */
1010 dictObjKeyCompare
, /* key compare */
1011 dictRedisObjectDestructor
, /* key destructor */
1012 dictRedisObjectDestructor
/* val destructor */
1016 static dictType keyptrDictType
= {
1017 dictObjHash
, /* hash function */
1020 dictObjKeyCompare
, /* key compare */
1021 dictRedisObjectDestructor
, /* key destructor */
1022 NULL
/* val destructor */
1025 /* Keylist hash table type has unencoded redis objects as keys and
1026 * lists as values. It's used for blocking operations (BLPOP) and to
1027 * map swapped keys to a list of clients waiting for this keys to be loaded. */
1028 static dictType keylistDictType
= {
1029 dictObjHash
, /* hash function */
1032 dictObjKeyCompare
, /* key compare */
1033 dictRedisObjectDestructor
, /* key destructor */
1034 dictListDestructor
/* val destructor */
1037 /* ========================= Random utility functions ======================= */
1039 /* Redis generally does not try to recover from out of memory conditions
1040 * when allocating objects or strings, it is not clear if it will be possible
1041 * to report this condition to the client since the networking layer itself
1042 * is based on heap allocation for send buffers, so we simply abort.
1043 * At least the code will be simpler to read... */
1044 static void oom(const char *msg
) {
1045 redisLog(REDIS_WARNING
, "%s: Out of memory\n",msg
);
1050 /* ====================== Redis server networking stuff ===================== */
1051 static void closeTimedoutClients(void) {
1054 time_t now
= time(NULL
);
1057 listRewind(server
.clients
,&li
);
1058 while ((ln
= listNext(&li
)) != NULL
) {
1059 c
= listNodeValue(ln
);
1060 if (server
.maxidletime
&&
1061 !(c
->flags
& REDIS_SLAVE
) && /* no timeout for slaves */
1062 !(c
->flags
& REDIS_MASTER
) && /* no timeout for masters */
1063 (now
- c
->lastinteraction
> server
.maxidletime
))
1065 redisLog(REDIS_VERBOSE
,"Closing idle client");
1067 } else if (c
->flags
& REDIS_BLOCKED
) {
1068 if (c
->blockingto
!= 0 && c
->blockingto
< now
) {
1069 addReply(c
,shared
.nullmultibulk
);
1070 unblockClientWaitingData(c
);
1076 static int htNeedsResize(dict
*dict
) {
1077 long long size
, used
;
1079 size
= dictSlots(dict
);
1080 used
= dictSize(dict
);
1081 return (size
&& used
&& size
> DICT_HT_INITIAL_SIZE
&&
1082 (used
*100/size
< REDIS_HT_MINFILL
));
1085 /* If the percentage of used slots in the HT reaches REDIS_HT_MINFILL
1086 * we resize the hash table to save memory */
1087 static void tryResizeHashTables(void) {
1090 for (j
= 0; j
< server
.dbnum
; j
++) {
1091 if (htNeedsResize(server
.db
[j
].dict
)) {
1092 redisLog(REDIS_VERBOSE
,"The hash table %d is too sparse, resize it...",j
);
1093 dictResize(server
.db
[j
].dict
);
1094 redisLog(REDIS_VERBOSE
,"Hash table %d resized.",j
);
1096 if (htNeedsResize(server
.db
[j
].expires
))
1097 dictResize(server
.db
[j
].expires
);
1101 /* A background saving child (BGSAVE) terminated its work. Handle this. */
1102 void backgroundSaveDoneHandler(int statloc
) {
1103 int exitcode
= WEXITSTATUS(statloc
);
1104 int bysignal
= WIFSIGNALED(statloc
);
1106 if (!bysignal
&& exitcode
== 0) {
1107 redisLog(REDIS_NOTICE
,
1108 "Background saving terminated with success");
1110 server
.lastsave
= time(NULL
);
1111 } else if (!bysignal
&& exitcode
!= 0) {
1112 redisLog(REDIS_WARNING
, "Background saving error");
1114 redisLog(REDIS_WARNING
,
1115 "Background saving terminated by signal");
1116 rdbRemoveTempFile(server
.bgsavechildpid
);
1118 server
.bgsavechildpid
= -1;
1119 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1120 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1121 updateSlavesWaitingBgsave(exitcode
== 0 ? REDIS_OK
: REDIS_ERR
);
1124 /* A background append only file rewriting (BGREWRITEAOF) terminated its work.
1126 void backgroundRewriteDoneHandler(int statloc
) {
1127 int exitcode
= WEXITSTATUS(statloc
);
1128 int bysignal
= WIFSIGNALED(statloc
);
1130 if (!bysignal
&& exitcode
== 0) {
1134 redisLog(REDIS_NOTICE
,
1135 "Background append only file rewriting terminated with success");
1136 /* Now it's time to flush the differences accumulated by the parent */
1137 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) server
.bgrewritechildpid
);
1138 fd
= open(tmpfile
,O_WRONLY
|O_APPEND
);
1140 redisLog(REDIS_WARNING
, "Not able to open the temp append only file produced by the child: %s", strerror(errno
));
1143 /* Flush our data... */
1144 if (write(fd
,server
.bgrewritebuf
,sdslen(server
.bgrewritebuf
)) !=
1145 (signed) sdslen(server
.bgrewritebuf
)) {
1146 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
));
1150 redisLog(REDIS_NOTICE
,"Parent diff flushed into the new append log file with success (%lu bytes)",sdslen(server
.bgrewritebuf
));
1151 /* Now our work is to rename the temp file into the stable file. And
1152 * switch the file descriptor used by the server for append only. */
1153 if (rename(tmpfile
,server
.appendfilename
) == -1) {
1154 redisLog(REDIS_WARNING
,"Can't rename the temp append only file into the stable one: %s", strerror(errno
));
1158 /* Mission completed... almost */
1159 redisLog(REDIS_NOTICE
,"Append only file successfully rewritten.");
1160 if (server
.appendfd
!= -1) {
1161 /* If append only is actually enabled... */
1162 close(server
.appendfd
);
1163 server
.appendfd
= fd
;
1165 server
.appendseldb
= -1; /* Make sure it will issue SELECT */
1166 redisLog(REDIS_NOTICE
,"The new append only file was selected for future appends.");
1168 /* If append only is disabled we just generate a dump in this
1169 * format. Why not? */
1172 } else if (!bysignal
&& exitcode
!= 0) {
1173 redisLog(REDIS_WARNING
, "Background append only file rewriting error");
1175 redisLog(REDIS_WARNING
,
1176 "Background append only file rewriting terminated by signal");
1179 sdsfree(server
.bgrewritebuf
);
1180 server
.bgrewritebuf
= sdsempty();
1181 aofRemoveTempFile(server
.bgrewritechildpid
);
1182 server
.bgrewritechildpid
= -1;
1185 static int serverCron(struct aeEventLoop
*eventLoop
, long long id
, void *clientData
) {
1186 int j
, loops
= server
.cronloops
++;
1187 REDIS_NOTUSED(eventLoop
);
1189 REDIS_NOTUSED(clientData
);
1191 /* We take a cached value of the unix time in the global state because
1192 * with virtual memory and aging there is to store the current time
1193 * in objects at every object access, and accuracy is not needed.
1194 * To access a global var is faster than calling time(NULL) */
1195 server
.unixtime
= time(NULL
);
1197 /* Show some info about non-empty databases */
1198 for (j
= 0; j
< server
.dbnum
; j
++) {
1199 long long size
, used
, vkeys
;
1201 size
= dictSlots(server
.db
[j
].dict
);
1202 used
= dictSize(server
.db
[j
].dict
);
1203 vkeys
= dictSize(server
.db
[j
].expires
);
1204 if (!(loops
% 5) && (used
|| vkeys
)) {
1205 redisLog(REDIS_VERBOSE
,"DB %d: %lld keys (%lld volatile) in %lld slots HT.",j
,used
,vkeys
,size
);
1206 /* dictPrintStats(server.dict); */
1210 /* We don't want to resize the hash tables while a bacground saving
1211 * is in progress: the saving child is created using fork() that is
1212 * implemented with a copy-on-write semantic in most modern systems, so
1213 * if we resize the HT while there is the saving child at work actually
1214 * a lot of memory movements in the parent will cause a lot of pages
1216 if (server
.bgsavechildpid
== -1) tryResizeHashTables();
1218 /* Show information about connected clients */
1220 redisLog(REDIS_VERBOSE
,"%d clients connected (%d slaves), %zu bytes in use, %d shared objects",
1221 listLength(server
.clients
)-listLength(server
.slaves
),
1222 listLength(server
.slaves
),
1223 zmalloc_used_memory(),
1224 dictSize(server
.sharingpool
));
1227 /* Close connections of timedout clients */
1228 if ((server
.maxidletime
&& !(loops
% 10)) || server
.blpop_blocked_clients
)
1229 closeTimedoutClients();
1231 /* Check if a background saving or AOF rewrite in progress terminated */
1232 if (server
.bgsavechildpid
!= -1 || server
.bgrewritechildpid
!= -1) {
1236 if ((pid
= wait3(&statloc
,WNOHANG
,NULL
)) != 0) {
1237 if (pid
== server
.bgsavechildpid
) {
1238 backgroundSaveDoneHandler(statloc
);
1240 backgroundRewriteDoneHandler(statloc
);
1244 /* If there is not a background saving in progress check if
1245 * we have to save now */
1246 time_t now
= time(NULL
);
1247 for (j
= 0; j
< server
.saveparamslen
; j
++) {
1248 struct saveparam
*sp
= server
.saveparams
+j
;
1250 if (server
.dirty
>= sp
->changes
&&
1251 now
-server
.lastsave
> sp
->seconds
) {
1252 redisLog(REDIS_NOTICE
,"%d changes in %d seconds. Saving...",
1253 sp
->changes
, sp
->seconds
);
1254 rdbSaveBackground(server
.dbfilename
);
1260 /* Try to expire a few timed out keys. The algorithm used is adaptive and
1261 * will use few CPU cycles if there are few expiring keys, otherwise
1262 * it will get more aggressive to avoid that too much memory is used by
1263 * keys that can be removed from the keyspace. */
1264 for (j
= 0; j
< server
.dbnum
; j
++) {
1266 redisDb
*db
= server
.db
+j
;
1268 /* Continue to expire if at the end of the cycle more than 25%
1269 * of the keys were expired. */
1271 long num
= dictSize(db
->expires
);
1272 time_t now
= time(NULL
);
1275 if (num
> REDIS_EXPIRELOOKUPS_PER_CRON
)
1276 num
= REDIS_EXPIRELOOKUPS_PER_CRON
;
1281 if ((de
= dictGetRandomKey(db
->expires
)) == NULL
) break;
1282 t
= (time_t) dictGetEntryVal(de
);
1284 deleteKey(db
,dictGetEntryKey(de
));
1288 } while (expired
> REDIS_EXPIRELOOKUPS_PER_CRON
/4);
1291 /* Swap a few keys on disk if we are over the memory limit and VM
1292 * is enbled. Try to free objects from the free list first. */
1293 if (vmCanSwapOut()) {
1294 while (server
.vm_enabled
&& zmalloc_used_memory() >
1295 server
.vm_max_memory
)
1299 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
1300 retval
= (server
.vm_max_threads
== 0) ?
1301 vmSwapOneObjectBlocking() :
1302 vmSwapOneObjectThreaded();
1303 if (retval
== REDIS_ERR
&& (loops
% 30) == 0 &&
1304 zmalloc_used_memory() >
1305 (server
.vm_max_memory
+server
.vm_max_memory
/10))
1307 redisLog(REDIS_WARNING
,"WARNING: vm-max-memory limit exceeded by more than 10%% but unable to swap more objects out!");
1309 /* Note that when using threade I/O we free just one object,
1310 * because anyway when the I/O thread in charge to swap this
1311 * object out will finish, the handler of completed jobs
1312 * will try to swap more objects if we are still out of memory. */
1313 if (retval
== REDIS_ERR
|| server
.vm_max_threads
> 0) break;
1317 /* Check if we should connect to a MASTER */
1318 if (server
.replstate
== REDIS_REPL_CONNECT
) {
1319 redisLog(REDIS_NOTICE
,"Connecting to MASTER...");
1320 if (syncWithMaster() == REDIS_OK
) {
1321 redisLog(REDIS_NOTICE
,"MASTER <-> SLAVE sync succeeded");
1327 /* This function gets called every time Redis is entering the
1328 * main loop of the event driven library, that is, before to sleep
1329 * for ready file descriptors. */
1330 static void beforeSleep(struct aeEventLoop
*eventLoop
) {
1331 REDIS_NOTUSED(eventLoop
);
1333 if (server
.vm_enabled
&& listLength(server
.io_ready_clients
)) {
1337 listRewind(server
.io_ready_clients
,&li
);
1338 while((ln
= listNext(&li
))) {
1339 redisClient
*c
= ln
->value
;
1340 struct redisCommand
*cmd
;
1342 /* Resume the client. */
1343 listDelNode(server
.io_ready_clients
,ln
);
1344 c
->flags
&= (~REDIS_IO_WAIT
);
1345 server
.vm_blocked_clients
--;
1346 aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
1347 readQueryFromClient
, c
);
1348 cmd
= lookupCommand(c
->argv
[0]->ptr
);
1349 assert(cmd
!= NULL
);
1352 /* There may be more data to process in the input buffer. */
1353 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0)
1354 processInputBuffer(c
);
1359 static void createSharedObjects(void) {
1360 shared
.crlf
= createObject(REDIS_STRING
,sdsnew("\r\n"));
1361 shared
.ok
= createObject(REDIS_STRING
,sdsnew("+OK\r\n"));
1362 shared
.err
= createObject(REDIS_STRING
,sdsnew("-ERR\r\n"));
1363 shared
.emptybulk
= createObject(REDIS_STRING
,sdsnew("$0\r\n\r\n"));
1364 shared
.czero
= createObject(REDIS_STRING
,sdsnew(":0\r\n"));
1365 shared
.cone
= createObject(REDIS_STRING
,sdsnew(":1\r\n"));
1366 shared
.nullbulk
= createObject(REDIS_STRING
,sdsnew("$-1\r\n"));
1367 shared
.nullmultibulk
= createObject(REDIS_STRING
,sdsnew("*-1\r\n"));
1368 shared
.emptymultibulk
= createObject(REDIS_STRING
,sdsnew("*0\r\n"));
1369 shared
.pong
= createObject(REDIS_STRING
,sdsnew("+PONG\r\n"));
1370 shared
.queued
= createObject(REDIS_STRING
,sdsnew("+QUEUED\r\n"));
1371 shared
.wrongtypeerr
= createObject(REDIS_STRING
,sdsnew(
1372 "-ERR Operation against a key holding the wrong kind of value\r\n"));
1373 shared
.nokeyerr
= createObject(REDIS_STRING
,sdsnew(
1374 "-ERR no such key\r\n"));
1375 shared
.syntaxerr
= createObject(REDIS_STRING
,sdsnew(
1376 "-ERR syntax error\r\n"));
1377 shared
.sameobjecterr
= createObject(REDIS_STRING
,sdsnew(
1378 "-ERR source and destination objects are the same\r\n"));
1379 shared
.outofrangeerr
= createObject(REDIS_STRING
,sdsnew(
1380 "-ERR index out of range\r\n"));
1381 shared
.space
= createObject(REDIS_STRING
,sdsnew(" "));
1382 shared
.colon
= createObject(REDIS_STRING
,sdsnew(":"));
1383 shared
.plus
= createObject(REDIS_STRING
,sdsnew("+"));
1384 shared
.select0
= createStringObject("select 0\r\n",10);
1385 shared
.select1
= createStringObject("select 1\r\n",10);
1386 shared
.select2
= createStringObject("select 2\r\n",10);
1387 shared
.select3
= createStringObject("select 3\r\n",10);
1388 shared
.select4
= createStringObject("select 4\r\n",10);
1389 shared
.select5
= createStringObject("select 5\r\n",10);
1390 shared
.select6
= createStringObject("select 6\r\n",10);
1391 shared
.select7
= createStringObject("select 7\r\n",10);
1392 shared
.select8
= createStringObject("select 8\r\n",10);
1393 shared
.select9
= createStringObject("select 9\r\n",10);
1396 static void appendServerSaveParams(time_t seconds
, int changes
) {
1397 server
.saveparams
= zrealloc(server
.saveparams
,sizeof(struct saveparam
)*(server
.saveparamslen
+1));
1398 server
.saveparams
[server
.saveparamslen
].seconds
= seconds
;
1399 server
.saveparams
[server
.saveparamslen
].changes
= changes
;
1400 server
.saveparamslen
++;
1403 static void resetServerSaveParams() {
1404 zfree(server
.saveparams
);
1405 server
.saveparams
= NULL
;
1406 server
.saveparamslen
= 0;
1409 static void initServerConfig() {
1410 server
.dbnum
= REDIS_DEFAULT_DBNUM
;
1411 server
.port
= REDIS_SERVERPORT
;
1412 server
.verbosity
= REDIS_VERBOSE
;
1413 server
.maxidletime
= REDIS_MAXIDLETIME
;
1414 server
.saveparams
= NULL
;
1415 server
.logfile
= NULL
; /* NULL = log on standard output */
1416 server
.bindaddr
= NULL
;
1417 server
.glueoutputbuf
= 1;
1418 server
.daemonize
= 0;
1419 server
.appendonly
= 0;
1420 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1421 server
.lastfsync
= time(NULL
);
1422 server
.appendfd
= -1;
1423 server
.appendseldb
= -1; /* Make sure the first time will not match */
1424 server
.pidfile
= "/var/run/redis.pid";
1425 server
.dbfilename
= "dump.rdb";
1426 server
.appendfilename
= "appendonly.aof";
1427 server
.requirepass
= NULL
;
1428 server
.shareobjects
= 0;
1429 server
.rdbcompression
= 1;
1430 server
.sharingpoolsize
= 1024;
1431 server
.maxclients
= 0;
1432 server
.blpop_blocked_clients
= 0;
1433 server
.maxmemory
= 0;
1434 server
.vm_enabled
= 0;
1435 server
.vm_swap_file
= zstrdup("/tmp/redis-%p.vm");
1436 server
.vm_page_size
= 256; /* 256 bytes per page */
1437 server
.vm_pages
= 1024*1024*100; /* 104 millions of pages */
1438 server
.vm_max_memory
= 1024LL*1024*1024*1; /* 1 GB of RAM */
1439 server
.vm_max_threads
= 4;
1440 server
.vm_blocked_clients
= 0;
1442 resetServerSaveParams();
1444 appendServerSaveParams(60*60,1); /* save after 1 hour and 1 change */
1445 appendServerSaveParams(300,100); /* save after 5 minutes and 100 changes */
1446 appendServerSaveParams(60,10000); /* save after 1 minute and 10000 changes */
1447 /* Replication related */
1449 server
.masterauth
= NULL
;
1450 server
.masterhost
= NULL
;
1451 server
.masterport
= 6379;
1452 server
.master
= NULL
;
1453 server
.replstate
= REDIS_REPL_NONE
;
1455 /* Double constants initialization */
1457 R_PosInf
= 1.0/R_Zero
;
1458 R_NegInf
= -1.0/R_Zero
;
1459 R_Nan
= R_Zero
/R_Zero
;
1462 static void initServer() {
1465 signal(SIGHUP
, SIG_IGN
);
1466 signal(SIGPIPE
, SIG_IGN
);
1467 setupSigSegvAction();
1469 server
.devnull
= fopen("/dev/null","w");
1470 if (server
.devnull
== NULL
) {
1471 redisLog(REDIS_WARNING
, "Can't open /dev/null: %s", server
.neterr
);
1474 server
.clients
= listCreate();
1475 server
.slaves
= listCreate();
1476 server
.monitors
= listCreate();
1477 server
.objfreelist
= listCreate();
1478 createSharedObjects();
1479 server
.el
= aeCreateEventLoop();
1480 server
.db
= zmalloc(sizeof(redisDb
)*server
.dbnum
);
1481 server
.sharingpool
= dictCreate(&setDictType
,NULL
);
1482 server
.fd
= anetTcpServer(server
.neterr
, server
.port
, server
.bindaddr
);
1483 if (server
.fd
== -1) {
1484 redisLog(REDIS_WARNING
, "Opening TCP port: %s", server
.neterr
);
1487 for (j
= 0; j
< server
.dbnum
; j
++) {
1488 server
.db
[j
].dict
= dictCreate(&hashDictType
,NULL
);
1489 server
.db
[j
].expires
= dictCreate(&keyptrDictType
,NULL
);
1490 server
.db
[j
].blockingkeys
= dictCreate(&keylistDictType
,NULL
);
1491 if (server
.vm_enabled
)
1492 server
.db
[j
].io_keys
= dictCreate(&keylistDictType
,NULL
);
1493 server
.db
[j
].id
= j
;
1495 server
.cronloops
= 0;
1496 server
.bgsavechildpid
= -1;
1497 server
.bgrewritechildpid
= -1;
1498 server
.bgrewritebuf
= sdsempty();
1499 server
.lastsave
= time(NULL
);
1501 server
.stat_numcommands
= 0;
1502 server
.stat_numconnections
= 0;
1503 server
.stat_starttime
= time(NULL
);
1504 server
.unixtime
= time(NULL
);
1505 aeCreateTimeEvent(server
.el
, 1, serverCron
, NULL
, NULL
);
1506 if (aeCreateFileEvent(server
.el
, server
.fd
, AE_READABLE
,
1507 acceptHandler
, NULL
) == AE_ERR
) oom("creating file event");
1509 if (server
.appendonly
) {
1510 server
.appendfd
= open(server
.appendfilename
,O_WRONLY
|O_APPEND
|O_CREAT
,0644);
1511 if (server
.appendfd
== -1) {
1512 redisLog(REDIS_WARNING
, "Can't open the append-only file: %s",
1518 if (server
.vm_enabled
) vmInit();
1521 /* Empty the whole database */
1522 static long long emptyDb() {
1524 long long removed
= 0;
1526 for (j
= 0; j
< server
.dbnum
; j
++) {
1527 removed
+= dictSize(server
.db
[j
].dict
);
1528 dictEmpty(server
.db
[j
].dict
);
1529 dictEmpty(server
.db
[j
].expires
);
1534 static int yesnotoi(char *s
) {
1535 if (!strcasecmp(s
,"yes")) return 1;
1536 else if (!strcasecmp(s
,"no")) return 0;
1540 /* I agree, this is a very rudimental way to load a configuration...
1541 will improve later if the config gets more complex */
1542 static void loadServerConfig(char *filename
) {
1544 char buf
[REDIS_CONFIGLINE_MAX
+1], *err
= NULL
;
1548 if (filename
[0] == '-' && filename
[1] == '\0')
1551 if ((fp
= fopen(filename
,"r")) == NULL
) {
1552 redisLog(REDIS_WARNING
,"Fatal error, can't open config file");
1557 while(fgets(buf
,REDIS_CONFIGLINE_MAX
+1,fp
) != NULL
) {
1563 line
= sdstrim(line
," \t\r\n");
1565 /* Skip comments and blank lines*/
1566 if (line
[0] == '#' || line
[0] == '\0') {
1571 /* Split into arguments */
1572 argv
= sdssplitlen(line
,sdslen(line
)," ",1,&argc
);
1573 sdstolower(argv
[0]);
1575 /* Execute config directives */
1576 if (!strcasecmp(argv
[0],"timeout") && argc
== 2) {
1577 server
.maxidletime
= atoi(argv
[1]);
1578 if (server
.maxidletime
< 0) {
1579 err
= "Invalid timeout value"; goto loaderr
;
1581 } else if (!strcasecmp(argv
[0],"port") && argc
== 2) {
1582 server
.port
= atoi(argv
[1]);
1583 if (server
.port
< 1 || server
.port
> 65535) {
1584 err
= "Invalid port"; goto loaderr
;
1586 } else if (!strcasecmp(argv
[0],"bind") && argc
== 2) {
1587 server
.bindaddr
= zstrdup(argv
[1]);
1588 } else if (!strcasecmp(argv
[0],"save") && argc
== 3) {
1589 int seconds
= atoi(argv
[1]);
1590 int changes
= atoi(argv
[2]);
1591 if (seconds
< 1 || changes
< 0) {
1592 err
= "Invalid save parameters"; goto loaderr
;
1594 appendServerSaveParams(seconds
,changes
);
1595 } else if (!strcasecmp(argv
[0],"dir") && argc
== 2) {
1596 if (chdir(argv
[1]) == -1) {
1597 redisLog(REDIS_WARNING
,"Can't chdir to '%s': %s",
1598 argv
[1], strerror(errno
));
1601 } else if (!strcasecmp(argv
[0],"loglevel") && argc
== 2) {
1602 if (!strcasecmp(argv
[1],"debug")) server
.verbosity
= REDIS_DEBUG
;
1603 else if (!strcasecmp(argv
[1],"verbose")) server
.verbosity
= REDIS_VERBOSE
;
1604 else if (!strcasecmp(argv
[1],"notice")) server
.verbosity
= REDIS_NOTICE
;
1605 else if (!strcasecmp(argv
[1],"warning")) server
.verbosity
= REDIS_WARNING
;
1607 err
= "Invalid log level. Must be one of debug, notice, warning";
1610 } else if (!strcasecmp(argv
[0],"logfile") && argc
== 2) {
1613 server
.logfile
= zstrdup(argv
[1]);
1614 if (!strcasecmp(server
.logfile
,"stdout")) {
1615 zfree(server
.logfile
);
1616 server
.logfile
= NULL
;
1618 if (server
.logfile
) {
1619 /* Test if we are able to open the file. The server will not
1620 * be able to abort just for this problem later... */
1621 logfp
= fopen(server
.logfile
,"a");
1622 if (logfp
== NULL
) {
1623 err
= sdscatprintf(sdsempty(),
1624 "Can't open the log file: %s", strerror(errno
));
1629 } else if (!strcasecmp(argv
[0],"databases") && argc
== 2) {
1630 server
.dbnum
= atoi(argv
[1]);
1631 if (server
.dbnum
< 1) {
1632 err
= "Invalid number of databases"; goto loaderr
;
1634 } else if (!strcasecmp(argv
[0],"maxclients") && argc
== 2) {
1635 server
.maxclients
= atoi(argv
[1]);
1636 } else if (!strcasecmp(argv
[0],"maxmemory") && argc
== 2) {
1637 server
.maxmemory
= strtoll(argv
[1], NULL
, 10);
1638 } else if (!strcasecmp(argv
[0],"slaveof") && argc
== 3) {
1639 server
.masterhost
= sdsnew(argv
[1]);
1640 server
.masterport
= atoi(argv
[2]);
1641 server
.replstate
= REDIS_REPL_CONNECT
;
1642 } else if (!strcasecmp(argv
[0],"masterauth") && argc
== 2) {
1643 server
.masterauth
= zstrdup(argv
[1]);
1644 } else if (!strcasecmp(argv
[0],"glueoutputbuf") && argc
== 2) {
1645 if ((server
.glueoutputbuf
= yesnotoi(argv
[1])) == -1) {
1646 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1648 } else if (!strcasecmp(argv
[0],"shareobjects") && argc
== 2) {
1649 if ((server
.shareobjects
= yesnotoi(argv
[1])) == -1) {
1650 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1652 } else if (!strcasecmp(argv
[0],"rdbcompression") && argc
== 2) {
1653 if ((server
.rdbcompression
= yesnotoi(argv
[1])) == -1) {
1654 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1656 } else if (!strcasecmp(argv
[0],"shareobjectspoolsize") && argc
== 2) {
1657 server
.sharingpoolsize
= atoi(argv
[1]);
1658 if (server
.sharingpoolsize
< 1) {
1659 err
= "invalid object sharing pool size"; goto loaderr
;
1661 } else if (!strcasecmp(argv
[0],"daemonize") && argc
== 2) {
1662 if ((server
.daemonize
= yesnotoi(argv
[1])) == -1) {
1663 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1665 } else if (!strcasecmp(argv
[0],"appendonly") && argc
== 2) {
1666 if ((server
.appendonly
= yesnotoi(argv
[1])) == -1) {
1667 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1669 } else if (!strcasecmp(argv
[0],"appendfsync") && argc
== 2) {
1670 if (!strcasecmp(argv
[1],"no")) {
1671 server
.appendfsync
= APPENDFSYNC_NO
;
1672 } else if (!strcasecmp(argv
[1],"always")) {
1673 server
.appendfsync
= APPENDFSYNC_ALWAYS
;
1674 } else if (!strcasecmp(argv
[1],"everysec")) {
1675 server
.appendfsync
= APPENDFSYNC_EVERYSEC
;
1677 err
= "argument must be 'no', 'always' or 'everysec'";
1680 } else if (!strcasecmp(argv
[0],"requirepass") && argc
== 2) {
1681 server
.requirepass
= zstrdup(argv
[1]);
1682 } else if (!strcasecmp(argv
[0],"pidfile") && argc
== 2) {
1683 server
.pidfile
= zstrdup(argv
[1]);
1684 } else if (!strcasecmp(argv
[0],"dbfilename") && argc
== 2) {
1685 server
.dbfilename
= zstrdup(argv
[1]);
1686 } else if (!strcasecmp(argv
[0],"vm-enabled") && argc
== 2) {
1687 if ((server
.vm_enabled
= yesnotoi(argv
[1])) == -1) {
1688 err
= "argument must be 'yes' or 'no'"; goto loaderr
;
1690 } else if (!strcasecmp(argv
[0],"vm-swap-file") && argc
== 2) {
1691 zfree(server
.vm_swap_file
);
1692 server
.vm_swap_file
= zstrdup(argv
[1]);
1693 } else if (!strcasecmp(argv
[0],"vm-max-memory") && argc
== 2) {
1694 server
.vm_max_memory
= strtoll(argv
[1], NULL
, 10);
1695 } else if (!strcasecmp(argv
[0],"vm-page-size") && argc
== 2) {
1696 server
.vm_page_size
= strtoll(argv
[1], NULL
, 10);
1697 } else if (!strcasecmp(argv
[0],"vm-pages") && argc
== 2) {
1698 server
.vm_pages
= strtoll(argv
[1], NULL
, 10);
1699 } else if (!strcasecmp(argv
[0],"vm-max-threads") && argc
== 2) {
1700 server
.vm_max_threads
= strtoll(argv
[1], NULL
, 10);
1702 err
= "Bad directive or wrong number of arguments"; goto loaderr
;
1704 for (j
= 0; j
< argc
; j
++)
1709 if (fp
!= stdin
) fclose(fp
);
1713 fprintf(stderr
, "\n*** FATAL CONFIG FILE ERROR ***\n");
1714 fprintf(stderr
, "Reading the configuration file, at line %d\n", linenum
);
1715 fprintf(stderr
, ">>> '%s'\n", line
);
1716 fprintf(stderr
, "%s\n", err
);
1720 static void freeClientArgv(redisClient
*c
) {
1723 for (j
= 0; j
< c
->argc
; j
++)
1724 decrRefCount(c
->argv
[j
]);
1725 for (j
= 0; j
< c
->mbargc
; j
++)
1726 decrRefCount(c
->mbargv
[j
]);
1731 static void freeClient(redisClient
*c
) {
1734 /* Note that if the client we are freeing is blocked into a blocking
1735 * call, we have to set querybuf to NULL *before* to call
1736 * unblockClientWaitingData() to avoid processInputBuffer() will get
1737 * called. Also it is important to remove the file events after
1738 * this, because this call adds the READABLE event. */
1739 sdsfree(c
->querybuf
);
1741 if (c
->flags
& REDIS_BLOCKED
)
1742 unblockClientWaitingData(c
);
1744 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
1745 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1746 listRelease(c
->reply
);
1749 /* Remove from the list of clients */
1750 ln
= listSearchKey(server
.clients
,c
);
1751 redisAssert(ln
!= NULL
);
1752 listDelNode(server
.clients
,ln
);
1753 /* Remove from the list of clients waiting for swapped keys */
1754 if (c
->flags
& REDIS_IO_WAIT
&& listLength(c
->io_keys
) == 0) {
1755 ln
= listSearchKey(server
.io_ready_clients
,c
);
1757 listDelNode(server
.io_ready_clients
,ln
);
1758 server
.vm_blocked_clients
--;
1761 while (server
.vm_enabled
&& listLength(c
->io_keys
)) {
1762 ln
= listFirst(c
->io_keys
);
1763 dontWaitForSwappedKey(c
,ln
->value
);
1765 listRelease(c
->io_keys
);
1767 if (c
->flags
& REDIS_SLAVE
) {
1768 if (c
->replstate
== REDIS_REPL_SEND_BULK
&& c
->repldbfd
!= -1)
1770 list
*l
= (c
->flags
& REDIS_MONITOR
) ? server
.monitors
: server
.slaves
;
1771 ln
= listSearchKey(l
,c
);
1772 redisAssert(ln
!= NULL
);
1775 if (c
->flags
& REDIS_MASTER
) {
1776 server
.master
= NULL
;
1777 server
.replstate
= REDIS_REPL_CONNECT
;
1781 freeClientMultiState(c
);
1785 #define GLUEREPLY_UP_TO (1024)
1786 static void glueReplyBuffersIfNeeded(redisClient
*c
) {
1788 char buf
[GLUEREPLY_UP_TO
];
1793 listRewind(c
->reply
,&li
);
1794 while((ln
= listNext(&li
))) {
1798 objlen
= sdslen(o
->ptr
);
1799 if (copylen
+ objlen
<= GLUEREPLY_UP_TO
) {
1800 memcpy(buf
+copylen
,o
->ptr
,objlen
);
1802 listDelNode(c
->reply
,ln
);
1804 if (copylen
== 0) return;
1808 /* Now the output buffer is empty, add the new single element */
1809 o
= createObject(REDIS_STRING
,sdsnewlen(buf
,copylen
));
1810 listAddNodeHead(c
->reply
,o
);
1813 static void sendReplyToClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
1814 redisClient
*c
= privdata
;
1815 int nwritten
= 0, totwritten
= 0, objlen
;
1818 REDIS_NOTUSED(mask
);
1820 /* Use writev() if we have enough buffers to send */
1821 if (!server
.glueoutputbuf
&&
1822 listLength(c
->reply
) > REDIS_WRITEV_THRESHOLD
&&
1823 !(c
->flags
& REDIS_MASTER
))
1825 sendReplyToClientWritev(el
, fd
, privdata
, mask
);
1829 while(listLength(c
->reply
)) {
1830 if (server
.glueoutputbuf
&& listLength(c
->reply
) > 1)
1831 glueReplyBuffersIfNeeded(c
);
1833 o
= listNodeValue(listFirst(c
->reply
));
1834 objlen
= sdslen(o
->ptr
);
1837 listDelNode(c
->reply
,listFirst(c
->reply
));
1841 if (c
->flags
& REDIS_MASTER
) {
1842 /* Don't reply to a master */
1843 nwritten
= objlen
- c
->sentlen
;
1845 nwritten
= write(fd
, ((char*)o
->ptr
)+c
->sentlen
, objlen
- c
->sentlen
);
1846 if (nwritten
<= 0) break;
1848 c
->sentlen
+= nwritten
;
1849 totwritten
+= nwritten
;
1850 /* If we fully sent the object on head go to the next one */
1851 if (c
->sentlen
== objlen
) {
1852 listDelNode(c
->reply
,listFirst(c
->reply
));
1855 /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
1856 * bytes, in a single threaded server it's a good idea to serve
1857 * other clients as well, even if a very large request comes from
1858 * super fast link that is always able to accept data (in real world
1859 * scenario think about 'KEYS *' against the loopback interfae) */
1860 if (totwritten
> REDIS_MAX_WRITE_PER_EVENT
) break;
1862 if (nwritten
== -1) {
1863 if (errno
== EAGAIN
) {
1866 redisLog(REDIS_VERBOSE
,
1867 "Error writing to client: %s", strerror(errno
));
1872 if (totwritten
> 0) c
->lastinteraction
= time(NULL
);
1873 if (listLength(c
->reply
) == 0) {
1875 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1879 static void sendReplyToClientWritev(aeEventLoop
*el
, int fd
, void *privdata
, int mask
)
1881 redisClient
*c
= privdata
;
1882 int nwritten
= 0, totwritten
= 0, objlen
, willwrite
;
1884 struct iovec iov
[REDIS_WRITEV_IOVEC_COUNT
];
1885 int offset
, ion
= 0;
1887 REDIS_NOTUSED(mask
);
1890 while (listLength(c
->reply
)) {
1891 offset
= c
->sentlen
;
1895 /* fill-in the iov[] array */
1896 for(node
= listFirst(c
->reply
); node
; node
= listNextNode(node
)) {
1897 o
= listNodeValue(node
);
1898 objlen
= sdslen(o
->ptr
);
1900 if (totwritten
+ objlen
- offset
> REDIS_MAX_WRITE_PER_EVENT
)
1903 if(ion
== REDIS_WRITEV_IOVEC_COUNT
)
1904 break; /* no more iovecs */
1906 iov
[ion
].iov_base
= ((char*)o
->ptr
) + offset
;
1907 iov
[ion
].iov_len
= objlen
- offset
;
1908 willwrite
+= objlen
- offset
;
1909 offset
= 0; /* just for the first item */
1916 /* write all collected blocks at once */
1917 if((nwritten
= writev(fd
, iov
, ion
)) < 0) {
1918 if (errno
!= EAGAIN
) {
1919 redisLog(REDIS_VERBOSE
,
1920 "Error writing to client: %s", strerror(errno
));
1927 totwritten
+= nwritten
;
1928 offset
= c
->sentlen
;
1930 /* remove written robjs from c->reply */
1931 while (nwritten
&& listLength(c
->reply
)) {
1932 o
= listNodeValue(listFirst(c
->reply
));
1933 objlen
= sdslen(o
->ptr
);
1935 if(nwritten
>= objlen
- offset
) {
1936 listDelNode(c
->reply
, listFirst(c
->reply
));
1937 nwritten
-= objlen
- offset
;
1941 c
->sentlen
+= nwritten
;
1949 c
->lastinteraction
= time(NULL
);
1951 if (listLength(c
->reply
) == 0) {
1953 aeDeleteFileEvent(server
.el
,c
->fd
,AE_WRITABLE
);
1957 static struct redisCommand
*lookupCommand(char *name
) {
1959 while(cmdTable
[j
].name
!= NULL
) {
1960 if (!strcasecmp(name
,cmdTable
[j
].name
)) return &cmdTable
[j
];
1966 /* resetClient prepare the client to process the next command */
1967 static void resetClient(redisClient
*c
) {
1973 /* Call() is the core of Redis execution of a command */
1974 static void call(redisClient
*c
, struct redisCommand
*cmd
) {
1977 dirty
= server
.dirty
;
1979 if (server
.appendonly
&& server
.dirty
-dirty
)
1980 feedAppendOnlyFile(cmd
,c
->db
->id
,c
->argv
,c
->argc
);
1981 if (server
.dirty
-dirty
&& listLength(server
.slaves
))
1982 replicationFeedSlaves(server
.slaves
,cmd
,c
->db
->id
,c
->argv
,c
->argc
);
1983 if (listLength(server
.monitors
))
1984 replicationFeedSlaves(server
.monitors
,cmd
,c
->db
->id
,c
->argv
,c
->argc
);
1985 server
.stat_numcommands
++;
1988 /* If this function gets called we already read a whole
1989 * command, argments are in the client argv/argc fields.
1990 * processCommand() execute the command or prepare the
1991 * server for a bulk read from the client.
1993 * If 1 is returned the client is still alive and valid and
1994 * and other operations can be performed by the caller. Otherwise
1995 * if 0 is returned the client was destroied (i.e. after QUIT). */
1996 static int processCommand(redisClient
*c
) {
1997 struct redisCommand
*cmd
;
1999 /* Free some memory if needed (maxmemory setting) */
2000 if (server
.maxmemory
) freeMemoryIfNeeded();
2002 /* Handle the multi bulk command type. This is an alternative protocol
2003 * supported by Redis in order to receive commands that are composed of
2004 * multiple binary-safe "bulk" arguments. The latency of processing is
2005 * a bit higher but this allows things like multi-sets, so if this
2006 * protocol is used only for MSET and similar commands this is a big win. */
2007 if (c
->multibulk
== 0 && c
->argc
== 1 && ((char*)(c
->argv
[0]->ptr
))[0] == '*') {
2008 c
->multibulk
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2009 if (c
->multibulk
<= 0) {
2013 decrRefCount(c
->argv
[c
->argc
-1]);
2017 } else if (c
->multibulk
) {
2018 if (c
->bulklen
== -1) {
2019 if (((char*)c
->argv
[0]->ptr
)[0] != '$') {
2020 addReplySds(c
,sdsnew("-ERR multi bulk protocol error\r\n"));
2024 int bulklen
= atoi(((char*)c
->argv
[0]->ptr
)+1);
2025 decrRefCount(c
->argv
[0]);
2026 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2028 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2033 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2037 c
->mbargv
= zrealloc(c
->mbargv
,(sizeof(robj
*))*(c
->mbargc
+1));
2038 c
->mbargv
[c
->mbargc
] = c
->argv
[0];
2042 if (c
->multibulk
== 0) {
2046 /* Here we need to swap the multi-bulk argc/argv with the
2047 * normal argc/argv of the client structure. */
2049 c
->argv
= c
->mbargv
;
2050 c
->mbargv
= auxargv
;
2053 c
->argc
= c
->mbargc
;
2054 c
->mbargc
= auxargc
;
2056 /* We need to set bulklen to something different than -1
2057 * in order for the code below to process the command without
2058 * to try to read the last argument of a bulk command as
2059 * a special argument. */
2061 /* continue below and process the command */
2068 /* -- end of multi bulk commands processing -- */
2070 /* The QUIT command is handled as a special case. Normal command
2071 * procs are unable to close the client connection safely */
2072 if (!strcasecmp(c
->argv
[0]->ptr
,"quit")) {
2077 /* Now lookup the command and check ASAP about trivial error conditions
2078 * such wrong arity, bad command name and so forth. */
2079 cmd
= lookupCommand(c
->argv
[0]->ptr
);
2082 sdscatprintf(sdsempty(), "-ERR unknown command '%s'\r\n",
2083 (char*)c
->argv
[0]->ptr
));
2086 } else if ((cmd
->arity
> 0 && cmd
->arity
!= c
->argc
) ||
2087 (c
->argc
< -cmd
->arity
)) {
2089 sdscatprintf(sdsempty(),
2090 "-ERR wrong number of arguments for '%s' command\r\n",
2094 } else if (server
.maxmemory
&& cmd
->flags
& REDIS_CMD_DENYOOM
&& zmalloc_used_memory() > server
.maxmemory
) {
2095 addReplySds(c
,sdsnew("-ERR command not allowed when used memory > 'maxmemory'\r\n"));
2098 } else if (cmd
->flags
& REDIS_CMD_BULK
&& c
->bulklen
== -1) {
2099 /* This is a bulk command, we have to read the last argument yet. */
2100 int bulklen
= atoi(c
->argv
[c
->argc
-1]->ptr
);
2102 decrRefCount(c
->argv
[c
->argc
-1]);
2103 if (bulklen
< 0 || bulklen
> 1024*1024*1024) {
2105 addReplySds(c
,sdsnew("-ERR invalid bulk write count\r\n"));
2110 c
->bulklen
= bulklen
+2; /* add two bytes for CR+LF */
2111 /* It is possible that the bulk read is already in the
2112 * buffer. Check this condition and handle it accordingly.
2113 * This is just a fast path, alternative to call processInputBuffer().
2114 * It's a good idea since the code is small and this condition
2115 * happens most of the times. */
2116 if ((signed)sdslen(c
->querybuf
) >= c
->bulklen
) {
2117 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2119 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2121 /* Otherwise return... there is to read the last argument
2122 * from the socket. */
2126 /* Let's try to share objects on the command arguments vector */
2127 if (server
.shareobjects
) {
2129 for(j
= 1; j
< c
->argc
; j
++)
2130 c
->argv
[j
] = tryObjectSharing(c
->argv
[j
]);
2132 /* Let's try to encode the bulk object to save space. */
2133 if (cmd
->flags
& REDIS_CMD_BULK
)
2134 tryObjectEncoding(c
->argv
[c
->argc
-1]);
2136 /* Check if the user is authenticated */
2137 if (server
.requirepass
&& !c
->authenticated
&& cmd
->proc
!= authCommand
) {
2138 addReplySds(c
,sdsnew("-ERR operation not permitted\r\n"));
2143 /* Exec the command */
2144 if (c
->flags
& REDIS_MULTI
&& cmd
->proc
!= execCommand
) {
2145 queueMultiCommand(c
,cmd
);
2146 addReply(c
,shared
.queued
);
2148 if (server
.vm_enabled
&& server
.vm_max_threads
> 0 &&
2149 blockClientOnSwappedKeys(cmd
,c
)) return 1;
2153 /* Prepare the client for the next command */
2158 static void replicationFeedSlaves(list
*slaves
, struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
2163 /* (args*2)+1 is enough room for args, spaces, newlines */
2164 robj
*static_outv
[REDIS_STATIC_ARGS
*2+1];
2166 if (argc
<= REDIS_STATIC_ARGS
) {
2169 outv
= zmalloc(sizeof(robj
*)*(argc
*2+1));
2172 for (j
= 0; j
< argc
; j
++) {
2173 if (j
!= 0) outv
[outc
++] = shared
.space
;
2174 if ((cmd
->flags
& REDIS_CMD_BULK
) && j
== argc
-1) {
2177 lenobj
= createObject(REDIS_STRING
,
2178 sdscatprintf(sdsempty(),"%lu\r\n",
2179 (unsigned long) stringObjectLen(argv
[j
])));
2180 lenobj
->refcount
= 0;
2181 outv
[outc
++] = lenobj
;
2183 outv
[outc
++] = argv
[j
];
2185 outv
[outc
++] = shared
.crlf
;
2187 /* Increment all the refcounts at start and decrement at end in order to
2188 * be sure to free objects if there is no slave in a replication state
2189 * able to be feed with commands */
2190 for (j
= 0; j
< outc
; j
++) incrRefCount(outv
[j
]);
2191 listRewind(slaves
,&li
);
2192 while((ln
= listNext(&li
))) {
2193 redisClient
*slave
= ln
->value
;
2195 /* Don't feed slaves that are still waiting for BGSAVE to start */
2196 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) continue;
2198 /* Feed all the other slaves, MONITORs and so on */
2199 if (slave
->slaveseldb
!= dictid
) {
2203 case 0: selectcmd
= shared
.select0
; break;
2204 case 1: selectcmd
= shared
.select1
; break;
2205 case 2: selectcmd
= shared
.select2
; break;
2206 case 3: selectcmd
= shared
.select3
; break;
2207 case 4: selectcmd
= shared
.select4
; break;
2208 case 5: selectcmd
= shared
.select5
; break;
2209 case 6: selectcmd
= shared
.select6
; break;
2210 case 7: selectcmd
= shared
.select7
; break;
2211 case 8: selectcmd
= shared
.select8
; break;
2212 case 9: selectcmd
= shared
.select9
; break;
2214 selectcmd
= createObject(REDIS_STRING
,
2215 sdscatprintf(sdsempty(),"select %d\r\n",dictid
));
2216 selectcmd
->refcount
= 0;
2219 addReply(slave
,selectcmd
);
2220 slave
->slaveseldb
= dictid
;
2222 for (j
= 0; j
< outc
; j
++) addReply(slave
,outv
[j
]);
2224 for (j
= 0; j
< outc
; j
++) decrRefCount(outv
[j
]);
2225 if (outv
!= static_outv
) zfree(outv
);
2228 static void processInputBuffer(redisClient
*c
) {
2230 /* Before to process the input buffer, make sure the client is not
2231 * waitig for a blocking operation such as BLPOP. Note that the first
2232 * iteration the client is never blocked, otherwise the processInputBuffer
2233 * would not be called at all, but after the execution of the first commands
2234 * in the input buffer the client may be blocked, and the "goto again"
2235 * will try to reiterate. The following line will make it return asap. */
2236 if (c
->flags
& REDIS_BLOCKED
|| c
->flags
& REDIS_IO_WAIT
) return;
2237 if (c
->bulklen
== -1) {
2238 /* Read the first line of the query */
2239 char *p
= strchr(c
->querybuf
,'\n');
2246 query
= c
->querybuf
;
2247 c
->querybuf
= sdsempty();
2248 querylen
= 1+(p
-(query
));
2249 if (sdslen(query
) > querylen
) {
2250 /* leave data after the first line of the query in the buffer */
2251 c
->querybuf
= sdscatlen(c
->querybuf
,query
+querylen
,sdslen(query
)-querylen
);
2253 *p
= '\0'; /* remove "\n" */
2254 if (*(p
-1) == '\r') *(p
-1) = '\0'; /* and "\r" if any */
2255 sdsupdatelen(query
);
2257 /* Now we can split the query in arguments */
2258 argv
= sdssplitlen(query
,sdslen(query
)," ",1,&argc
);
2261 if (c
->argv
) zfree(c
->argv
);
2262 c
->argv
= zmalloc(sizeof(robj
*)*argc
);
2264 for (j
= 0; j
< argc
; j
++) {
2265 if (sdslen(argv
[j
])) {
2266 c
->argv
[c
->argc
] = createObject(REDIS_STRING
,argv
[j
]);
2274 /* Execute the command. If the client is still valid
2275 * after processCommand() return and there is something
2276 * on the query buffer try to process the next command. */
2277 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2279 /* Nothing to process, argc == 0. Just process the query
2280 * buffer if it's not empty or return to the caller */
2281 if (sdslen(c
->querybuf
)) goto again
;
2284 } else if (sdslen(c
->querybuf
) >= REDIS_REQUEST_MAX_SIZE
) {
2285 redisLog(REDIS_VERBOSE
, "Client protocol error");
2290 /* Bulk read handling. Note that if we are at this point
2291 the client already sent a command terminated with a newline,
2292 we are reading the bulk data that is actually the last
2293 argument of the command. */
2294 int qbl
= sdslen(c
->querybuf
);
2296 if (c
->bulklen
<= qbl
) {
2297 /* Copy everything but the final CRLF as final argument */
2298 c
->argv
[c
->argc
] = createStringObject(c
->querybuf
,c
->bulklen
-2);
2300 c
->querybuf
= sdsrange(c
->querybuf
,c
->bulklen
,-1);
2301 /* Process the command. If the client is still valid after
2302 * the processing and there is more data in the buffer
2303 * try to parse it. */
2304 if (processCommand(c
) && sdslen(c
->querybuf
)) goto again
;
2310 static void readQueryFromClient(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2311 redisClient
*c
= (redisClient
*) privdata
;
2312 char buf
[REDIS_IOBUF_LEN
];
2315 REDIS_NOTUSED(mask
);
2317 nread
= read(fd
, buf
, REDIS_IOBUF_LEN
);
2319 if (errno
== EAGAIN
) {
2322 redisLog(REDIS_VERBOSE
, "Reading from client: %s",strerror(errno
));
2326 } else if (nread
== 0) {
2327 redisLog(REDIS_VERBOSE
, "Client closed connection");
2332 c
->querybuf
= sdscatlen(c
->querybuf
, buf
, nread
);
2333 c
->lastinteraction
= time(NULL
);
2337 processInputBuffer(c
);
2340 static int selectDb(redisClient
*c
, int id
) {
2341 if (id
< 0 || id
>= server
.dbnum
)
2343 c
->db
= &server
.db
[id
];
2347 static void *dupClientReplyValue(void *o
) {
2348 incrRefCount((robj
*)o
);
2352 static redisClient
*createClient(int fd
) {
2353 redisClient
*c
= zmalloc(sizeof(*c
));
2355 anetNonBlock(NULL
,fd
);
2356 anetTcpNoDelay(NULL
,fd
);
2357 if (!c
) return NULL
;
2360 c
->querybuf
= sdsempty();
2369 c
->lastinteraction
= time(NULL
);
2370 c
->authenticated
= 0;
2371 c
->replstate
= REDIS_REPL_NONE
;
2372 c
->reply
= listCreate();
2373 listSetFreeMethod(c
->reply
,decrRefCount
);
2374 listSetDupMethod(c
->reply
,dupClientReplyValue
);
2375 c
->blockingkeys
= NULL
;
2376 c
->blockingkeysnum
= 0;
2377 c
->io_keys
= listCreate();
2378 listSetFreeMethod(c
->io_keys
,decrRefCount
);
2379 if (aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
,
2380 readQueryFromClient
, c
) == AE_ERR
) {
2384 listAddNodeTail(server
.clients
,c
);
2385 initClientMultiState(c
);
2389 static void addReply(redisClient
*c
, robj
*obj
) {
2390 if (listLength(c
->reply
) == 0 &&
2391 (c
->replstate
== REDIS_REPL_NONE
||
2392 c
->replstate
== REDIS_REPL_ONLINE
) &&
2393 aeCreateFileEvent(server
.el
, c
->fd
, AE_WRITABLE
,
2394 sendReplyToClient
, c
) == AE_ERR
) return;
2396 if (server
.vm_enabled
&& obj
->storage
!= REDIS_VM_MEMORY
) {
2397 obj
= dupStringObject(obj
);
2398 obj
->refcount
= 0; /* getDecodedObject() will increment the refcount */
2400 listAddNodeTail(c
->reply
,getDecodedObject(obj
));
2403 static void addReplySds(redisClient
*c
, sds s
) {
2404 robj
*o
= createObject(REDIS_STRING
,s
);
2409 static void addReplyDouble(redisClient
*c
, double d
) {
2412 snprintf(buf
,sizeof(buf
),"%.17g",d
);
2413 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n%s\r\n",
2414 (unsigned long) strlen(buf
),buf
));
2417 static void addReplyLong(redisClient
*c
, long l
) {
2421 len
= snprintf(buf
,sizeof(buf
),":%ld\r\n",l
);
2422 addReplySds(c
,sdsnewlen(buf
,len
));
2425 static void addReplyBulkLen(redisClient
*c
, robj
*obj
) {
2428 if (obj
->encoding
== REDIS_ENCODING_RAW
) {
2429 len
= sdslen(obj
->ptr
);
2431 long n
= (long)obj
->ptr
;
2433 /* Compute how many bytes will take this integer as a radix 10 string */
2439 while((n
= n
/10) != 0) {
2443 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",(unsigned long)len
));
2446 static void acceptHandler(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
2451 REDIS_NOTUSED(mask
);
2452 REDIS_NOTUSED(privdata
);
2454 cfd
= anetAccept(server
.neterr
, fd
, cip
, &cport
);
2455 if (cfd
== AE_ERR
) {
2456 redisLog(REDIS_VERBOSE
,"Accepting client connection: %s", server
.neterr
);
2459 redisLog(REDIS_VERBOSE
,"Accepted %s:%d", cip
, cport
);
2460 if ((c
= createClient(cfd
)) == NULL
) {
2461 redisLog(REDIS_WARNING
,"Error allocating resoures for the client");
2462 close(cfd
); /* May be already closed, just ingore errors */
2465 /* If maxclient directive is set and this is one client more... close the
2466 * connection. Note that we create the client instead to check before
2467 * for this condition, since now the socket is already set in nonblocking
2468 * mode and we can send an error for free using the Kernel I/O */
2469 if (server
.maxclients
&& listLength(server
.clients
) > server
.maxclients
) {
2470 char *err
= "-ERR max number of clients reached\r\n";
2472 /* That's a best effort error message, don't check write errors */
2473 if (write(c
->fd
,err
,strlen(err
)) == -1) {
2474 /* Nothing to do, Just to avoid the warning... */
2479 server
.stat_numconnections
++;
2482 /* ======================= Redis objects implementation ===================== */
2484 static robj
*createObject(int type
, void *ptr
) {
2487 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2488 if (listLength(server
.objfreelist
)) {
2489 listNode
*head
= listFirst(server
.objfreelist
);
2490 o
= listNodeValue(head
);
2491 listDelNode(server
.objfreelist
,head
);
2492 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2494 if (server
.vm_enabled
) {
2495 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2496 o
= zmalloc(sizeof(*o
));
2498 o
= zmalloc(sizeof(*o
)-sizeof(struct redisObjectVM
));
2502 o
->encoding
= REDIS_ENCODING_RAW
;
2505 if (server
.vm_enabled
) {
2506 /* Note that this code may run in the context of an I/O thread
2507 * and accessing to server.unixtime in theory is an error
2508 * (no locks). But in practice this is safe, and even if we read
2509 * garbage Redis will not fail, as it's just a statistical info */
2510 o
->vm
.atime
= server
.unixtime
;
2511 o
->storage
= REDIS_VM_MEMORY
;
2516 static robj
*createStringObject(char *ptr
, size_t len
) {
2517 return createObject(REDIS_STRING
,sdsnewlen(ptr
,len
));
2520 static robj
*dupStringObject(robj
*o
) {
2521 assert(o
->encoding
== REDIS_ENCODING_RAW
);
2522 return createStringObject(o
->ptr
,sdslen(o
->ptr
));
2525 static robj
*createListObject(void) {
2526 list
*l
= listCreate();
2528 listSetFreeMethod(l
,decrRefCount
);
2529 return createObject(REDIS_LIST
,l
);
2532 static robj
*createSetObject(void) {
2533 dict
*d
= dictCreate(&setDictType
,NULL
);
2534 return createObject(REDIS_SET
,d
);
2537 static robj
*createZsetObject(void) {
2538 zset
*zs
= zmalloc(sizeof(*zs
));
2540 zs
->dict
= dictCreate(&zsetDictType
,NULL
);
2541 zs
->zsl
= zslCreate();
2542 return createObject(REDIS_ZSET
,zs
);
2545 static void freeStringObject(robj
*o
) {
2546 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2551 static void freeListObject(robj
*o
) {
2552 listRelease((list
*) o
->ptr
);
2555 static void freeSetObject(robj
*o
) {
2556 dictRelease((dict
*) o
->ptr
);
2559 static void freeZsetObject(robj
*o
) {
2562 dictRelease(zs
->dict
);
2567 static void freeHashObject(robj
*o
) {
2568 dictRelease((dict
*) o
->ptr
);
2571 static void incrRefCount(robj
*o
) {
2572 redisAssert(!server
.vm_enabled
|| o
->storage
== REDIS_VM_MEMORY
);
2576 static void decrRefCount(void *obj
) {
2579 /* Object is a key of a swapped out value, or in the process of being
2581 if (server
.vm_enabled
&&
2582 (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
))
2584 if (o
->storage
== REDIS_VM_SWAPPED
|| o
->storage
== REDIS_VM_LOADING
) {
2585 redisAssert(o
->refcount
== 1);
2587 if (o
->storage
== REDIS_VM_LOADING
) vmCancelThreadedIOJob(obj
);
2588 redisAssert(o
->type
== REDIS_STRING
);
2589 freeStringObject(o
);
2590 vmMarkPagesFree(o
->vm
.page
,o
->vm
.usedpages
);
2591 pthread_mutex_lock(&server
.obj_freelist_mutex
);
2592 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2593 !listAddNodeHead(server
.objfreelist
,o
))
2595 pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2596 server
.vm_stats_swapped_objects
--;
2599 /* Object is in memory, or in the process of being swapped out. */
2600 if (--(o
->refcount
) == 0) {
2601 if (server
.vm_enabled
&& o
->storage
== REDIS_VM_SWAPPING
)
2602 vmCancelThreadedIOJob(obj
);
2604 case REDIS_STRING
: freeStringObject(o
); break;
2605 case REDIS_LIST
: freeListObject(o
); break;
2606 case REDIS_SET
: freeSetObject(o
); break;
2607 case REDIS_ZSET
: freeZsetObject(o
); break;
2608 case REDIS_HASH
: freeHashObject(o
); break;
2609 default: redisAssert(0 != 0); break;
2611 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
2612 if (listLength(server
.objfreelist
) > REDIS_OBJFREELIST_MAX
||
2613 !listAddNodeHead(server
.objfreelist
,o
))
2615 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
2619 static robj
*lookupKey(redisDb
*db
, robj
*key
) {
2620 dictEntry
*de
= dictFind(db
->dict
,key
);
2622 robj
*key
= dictGetEntryKey(de
);
2623 robj
*val
= dictGetEntryVal(de
);
2625 if (server
.vm_enabled
) {
2626 if (key
->storage
== REDIS_VM_MEMORY
||
2627 key
->storage
== REDIS_VM_SWAPPING
)
2629 /* If we were swapping the object out, stop it, this key
2631 if (key
->storage
== REDIS_VM_SWAPPING
)
2632 vmCancelThreadedIOJob(key
);
2633 /* Update the access time of the key for the aging algorithm. */
2634 key
->vm
.atime
= server
.unixtime
;
2636 int notify
= (key
->storage
== REDIS_VM_LOADING
);
2638 /* Our value was swapped on disk. Bring it at home. */
2639 redisAssert(val
== NULL
);
2640 val
= vmLoadObject(key
);
2641 dictGetEntryVal(de
) = val
;
2643 /* Clients blocked by the VM subsystem may be waiting for
2645 if (notify
) handleClientsBlockedOnSwappedKey(db
,key
);
2654 static robj
*lookupKeyRead(redisDb
*db
, robj
*key
) {
2655 expireIfNeeded(db
,key
);
2656 return lookupKey(db
,key
);
2659 static robj
*lookupKeyWrite(redisDb
*db
, robj
*key
) {
2660 deleteIfVolatile(db
,key
);
2661 return lookupKey(db
,key
);
2664 static int deleteKey(redisDb
*db
, robj
*key
) {
2667 /* We need to protect key from destruction: after the first dictDelete()
2668 * it may happen that 'key' is no longer valid if we don't increment
2669 * it's count. This may happen when we get the object reference directly
2670 * from the hash table with dictRandomKey() or dict iterators */
2672 if (dictSize(db
->expires
)) dictDelete(db
->expires
,key
);
2673 retval
= dictDelete(db
->dict
,key
);
2676 return retval
== DICT_OK
;
2679 /* Try to share an object against the shared objects pool */
2680 static robj
*tryObjectSharing(robj
*o
) {
2681 struct dictEntry
*de
;
2684 if (o
== NULL
|| server
.shareobjects
== 0) return o
;
2686 redisAssert(o
->type
== REDIS_STRING
);
2687 de
= dictFind(server
.sharingpool
,o
);
2689 robj
*shared
= dictGetEntryKey(de
);
2691 c
= ((unsigned long) dictGetEntryVal(de
))+1;
2692 dictGetEntryVal(de
) = (void*) c
;
2693 incrRefCount(shared
);
2697 /* Here we are using a stream algorihtm: Every time an object is
2698 * shared we increment its count, everytime there is a miss we
2699 * recrement the counter of a random object. If this object reaches
2700 * zero we remove the object and put the current object instead. */
2701 if (dictSize(server
.sharingpool
) >=
2702 server
.sharingpoolsize
) {
2703 de
= dictGetRandomKey(server
.sharingpool
);
2704 redisAssert(de
!= NULL
);
2705 c
= ((unsigned long) dictGetEntryVal(de
))-1;
2706 dictGetEntryVal(de
) = (void*) c
;
2708 dictDelete(server
.sharingpool
,de
->key
);
2711 c
= 0; /* If the pool is empty we want to add this object */
2716 retval
= dictAdd(server
.sharingpool
,o
,(void*)1);
2717 redisAssert(retval
== DICT_OK
);
2724 /* Check if the nul-terminated string 's' can be represented by a long
2725 * (that is, is a number that fits into long without any other space or
2726 * character before or after the digits).
2728 * If so, the function returns REDIS_OK and *longval is set to the value
2729 * of the number. Otherwise REDIS_ERR is returned */
2730 static int isStringRepresentableAsLong(sds s
, long *longval
) {
2731 char buf
[32], *endptr
;
2735 value
= strtol(s
, &endptr
, 10);
2736 if (endptr
[0] != '\0') return REDIS_ERR
;
2737 slen
= snprintf(buf
,32,"%ld",value
);
2739 /* If the number converted back into a string is not identical
2740 * then it's not possible to encode the string as integer */
2741 if (sdslen(s
) != (unsigned)slen
|| memcmp(buf
,s
,slen
)) return REDIS_ERR
;
2742 if (longval
) *longval
= value
;
2746 /* Try to encode a string object in order to save space */
2747 static int tryObjectEncoding(robj
*o
) {
2751 if (o
->encoding
!= REDIS_ENCODING_RAW
)
2752 return REDIS_ERR
; /* Already encoded */
2754 /* It's not save to encode shared objects: shared objects can be shared
2755 * everywhere in the "object space" of Redis. Encoded objects can only
2756 * appear as "values" (and not, for instance, as keys) */
2757 if (o
->refcount
> 1) return REDIS_ERR
;
2759 /* Currently we try to encode only strings */
2760 redisAssert(o
->type
== REDIS_STRING
);
2762 /* Check if we can represent this string as a long integer */
2763 if (isStringRepresentableAsLong(s
,&value
) == REDIS_ERR
) return REDIS_ERR
;
2765 /* Ok, this object can be encoded */
2766 o
->encoding
= REDIS_ENCODING_INT
;
2768 o
->ptr
= (void*) value
;
2772 /* Get a decoded version of an encoded object (returned as a new object).
2773 * If the object is already raw-encoded just increment the ref count. */
2774 static robj
*getDecodedObject(robj
*o
) {
2777 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2781 if (o
->type
== REDIS_STRING
&& o
->encoding
== REDIS_ENCODING_INT
) {
2784 snprintf(buf
,32,"%ld",(long)o
->ptr
);
2785 dec
= createStringObject(buf
,strlen(buf
));
2788 redisAssert(1 != 1);
2792 /* Compare two string objects via strcmp() or alike.
2793 * Note that the objects may be integer-encoded. In such a case we
2794 * use snprintf() to get a string representation of the numbers on the stack
2795 * and compare the strings, it's much faster than calling getDecodedObject().
2797 * Important note: if objects are not integer encoded, but binary-safe strings,
2798 * sdscmp() from sds.c will apply memcmp() so this function ca be considered
2800 static int compareStringObjects(robj
*a
, robj
*b
) {
2801 redisAssert(a
->type
== REDIS_STRING
&& b
->type
== REDIS_STRING
);
2802 char bufa
[128], bufb
[128], *astr
, *bstr
;
2805 if (a
== b
) return 0;
2806 if (a
->encoding
!= REDIS_ENCODING_RAW
) {
2807 snprintf(bufa
,sizeof(bufa
),"%ld",(long) a
->ptr
);
2813 if (b
->encoding
!= REDIS_ENCODING_RAW
) {
2814 snprintf(bufb
,sizeof(bufb
),"%ld",(long) b
->ptr
);
2820 return bothsds
? sdscmp(astr
,bstr
) : strcmp(astr
,bstr
);
2823 static size_t stringObjectLen(robj
*o
) {
2824 redisAssert(o
->type
== REDIS_STRING
);
2825 if (o
->encoding
== REDIS_ENCODING_RAW
) {
2826 return sdslen(o
->ptr
);
2830 return snprintf(buf
,32,"%ld",(long)o
->ptr
);
2834 /*============================ RDB saving/loading =========================== */
2836 static int rdbSaveType(FILE *fp
, unsigned char type
) {
2837 if (fwrite(&type
,1,1,fp
) == 0) return -1;
2841 static int rdbSaveTime(FILE *fp
, time_t t
) {
2842 int32_t t32
= (int32_t) t
;
2843 if (fwrite(&t32
,4,1,fp
) == 0) return -1;
2847 /* check rdbLoadLen() comments for more info */
2848 static int rdbSaveLen(FILE *fp
, uint32_t len
) {
2849 unsigned char buf
[2];
2852 /* Save a 6 bit len */
2853 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
2854 if (fwrite(buf
,1,1,fp
) == 0) return -1;
2855 } else if (len
< (1<<14)) {
2856 /* Save a 14 bit len */
2857 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
2859 if (fwrite(buf
,2,1,fp
) == 0) return -1;
2861 /* Save a 32 bit len */
2862 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
2863 if (fwrite(buf
,1,1,fp
) == 0) return -1;
2865 if (fwrite(&len
,4,1,fp
) == 0) return -1;
2870 /* String objects in the form "2391" "-100" without any space and with a
2871 * range of values that can fit in an 8, 16 or 32 bit signed value can be
2872 * encoded as integers to save space */
2873 static int rdbTryIntegerEncoding(sds s
, unsigned char *enc
) {
2875 char *endptr
, buf
[32];
2877 /* Check if it's possible to encode this value as a number */
2878 value
= strtoll(s
, &endptr
, 10);
2879 if (endptr
[0] != '\0') return 0;
2880 snprintf(buf
,32,"%lld",value
);
2882 /* If the number converted back into a string is not identical
2883 * then it's not possible to encode the string as integer */
2884 if (strlen(buf
) != sdslen(s
) || memcmp(buf
,s
,sdslen(s
))) return 0;
2886 /* Finally check if it fits in our ranges */
2887 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
2888 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
2889 enc
[1] = value
&0xFF;
2891 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
2892 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
2893 enc
[1] = value
&0xFF;
2894 enc
[2] = (value
>>8)&0xFF;
2896 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
2897 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
2898 enc
[1] = value
&0xFF;
2899 enc
[2] = (value
>>8)&0xFF;
2900 enc
[3] = (value
>>16)&0xFF;
2901 enc
[4] = (value
>>24)&0xFF;
2908 static int rdbSaveLzfStringObject(FILE *fp
, robj
*obj
) {
2909 unsigned int comprlen
, outlen
;
2913 /* We require at least four bytes compression for this to be worth it */
2914 outlen
= sdslen(obj
->ptr
)-4;
2915 if (outlen
<= 0) return 0;
2916 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
2917 comprlen
= lzf_compress(obj
->ptr
, sdslen(obj
->ptr
), out
, outlen
);
2918 if (comprlen
== 0) {
2922 /* Data compressed! Let's save it on disk */
2923 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
2924 if (fwrite(&byte
,1,1,fp
) == 0) goto writeerr
;
2925 if (rdbSaveLen(fp
,comprlen
) == -1) goto writeerr
;
2926 if (rdbSaveLen(fp
,sdslen(obj
->ptr
)) == -1) goto writeerr
;
2927 if (fwrite(out
,comprlen
,1,fp
) == 0) goto writeerr
;
2936 /* Save a string objet as [len][data] on disk. If the object is a string
2937 * representation of an integer value we try to safe it in a special form */
2938 static int rdbSaveStringObjectRaw(FILE *fp
, robj
*obj
) {
2942 len
= sdslen(obj
->ptr
);
2944 /* Try integer encoding */
2946 unsigned char buf
[5];
2947 if ((enclen
= rdbTryIntegerEncoding(obj
->ptr
,buf
)) > 0) {
2948 if (fwrite(buf
,enclen
,1,fp
) == 0) return -1;
2953 /* Try LZF compression - under 20 bytes it's unable to compress even
2954 * aaaaaaaaaaaaaaaaaa so skip it */
2955 if (server
.rdbcompression
&& len
> 20) {
2958 retval
= rdbSaveLzfStringObject(fp
,obj
);
2959 if (retval
== -1) return -1;
2960 if (retval
> 0) return 0;
2961 /* retval == 0 means data can't be compressed, save the old way */
2964 /* Store verbatim */
2965 if (rdbSaveLen(fp
,len
) == -1) return -1;
2966 if (len
&& fwrite(obj
->ptr
,len
,1,fp
) == 0) return -1;
2970 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
2971 static int rdbSaveStringObject(FILE *fp
, robj
*obj
) {
2974 /* Avoid incr/decr ref count business when possible.
2975 * This plays well with copy-on-write given that we are probably
2976 * in a child process (BGSAVE). Also this makes sure key objects
2977 * of swapped objects are not incRefCount-ed (an assert does not allow
2978 * this in order to avoid bugs) */
2979 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
2980 obj
= getDecodedObject(obj
);
2981 retval
= rdbSaveStringObjectRaw(fp
,obj
);
2984 retval
= rdbSaveStringObjectRaw(fp
,obj
);
2989 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
2990 * 8 bit integer specifing the length of the representation.
2991 * This 8 bit integer has special values in order to specify the following
2997 static int rdbSaveDoubleValue(FILE *fp
, double val
) {
2998 unsigned char buf
[128];
3004 } else if (!isfinite(val
)) {
3006 buf
[0] = (val
< 0) ? 255 : 254;
3008 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
3009 buf
[0] = strlen((char*)buf
+1);
3012 if (fwrite(buf
,len
,1,fp
) == 0) return -1;
3016 /* Save a Redis object. */
3017 static int rdbSaveObject(FILE *fp
, robj
*o
) {
3018 if (o
->type
== REDIS_STRING
) {
3019 /* Save a string value */
3020 if (rdbSaveStringObject(fp
,o
) == -1) return -1;
3021 } else if (o
->type
== REDIS_LIST
) {
3022 /* Save a list value */
3023 list
*list
= o
->ptr
;
3027 if (rdbSaveLen(fp
,listLength(list
)) == -1) return -1;
3028 listRewind(list
,&li
);
3029 while((ln
= listNext(&li
))) {
3030 robj
*eleobj
= listNodeValue(ln
);
3032 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3034 } else if (o
->type
== REDIS_SET
) {
3035 /* Save a set value */
3037 dictIterator
*di
= dictGetIterator(set
);
3040 if (rdbSaveLen(fp
,dictSize(set
)) == -1) return -1;
3041 while((de
= dictNext(di
)) != NULL
) {
3042 robj
*eleobj
= dictGetEntryKey(de
);
3044 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3046 dictReleaseIterator(di
);
3047 } else if (o
->type
== REDIS_ZSET
) {
3048 /* Save a set value */
3050 dictIterator
*di
= dictGetIterator(zs
->dict
);
3053 if (rdbSaveLen(fp
,dictSize(zs
->dict
)) == -1) return -1;
3054 while((de
= dictNext(di
)) != NULL
) {
3055 robj
*eleobj
= dictGetEntryKey(de
);
3056 double *score
= dictGetEntryVal(de
);
3058 if (rdbSaveStringObject(fp
,eleobj
) == -1) return -1;
3059 if (rdbSaveDoubleValue(fp
,*score
) == -1) return -1;
3061 dictReleaseIterator(di
);
3063 redisAssert(0 != 0);
3068 /* Return the length the object will have on disk if saved with
3069 * the rdbSaveObject() function. Currently we use a trick to get
3070 * this length with very little changes to the code. In the future
3071 * we could switch to a faster solution. */
3072 static off_t
rdbSavedObjectLen(robj
*o
, FILE *fp
) {
3073 if (fp
== NULL
) fp
= server
.devnull
;
3075 assert(rdbSaveObject(fp
,o
) != 1);
3079 /* Return the number of pages required to save this object in the swap file */
3080 static off_t
rdbSavedObjectPages(robj
*o
, FILE *fp
) {
3081 off_t bytes
= rdbSavedObjectLen(o
,fp
);
3083 return (bytes
+(server
.vm_page_size
-1))/server
.vm_page_size
;
3086 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
3087 static int rdbSave(char *filename
) {
3088 dictIterator
*di
= NULL
;
3093 time_t now
= time(NULL
);
3095 /* Wait for I/O therads to terminate, just in case this is a
3096 * foreground-saving, to avoid seeking the swap file descriptor at the
3098 if (server
.vm_enabled
)
3099 waitEmptyIOJobsQueue();
3101 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
3102 fp
= fopen(tmpfile
,"w");
3104 redisLog(REDIS_WARNING
, "Failed saving the DB: %s", strerror(errno
));
3107 if (fwrite("REDIS0001",9,1,fp
) == 0) goto werr
;
3108 for (j
= 0; j
< server
.dbnum
; j
++) {
3109 redisDb
*db
= server
.db
+j
;
3111 if (dictSize(d
) == 0) continue;
3112 di
= dictGetIterator(d
);
3118 /* Write the SELECT DB opcode */
3119 if (rdbSaveType(fp
,REDIS_SELECTDB
) == -1) goto werr
;
3120 if (rdbSaveLen(fp
,j
) == -1) goto werr
;
3122 /* Iterate this DB writing every entry */
3123 while((de
= dictNext(di
)) != NULL
) {
3124 robj
*key
= dictGetEntryKey(de
);
3125 robj
*o
= dictGetEntryVal(de
);
3126 time_t expiretime
= getExpire(db
,key
);
3128 /* Save the expire time */
3129 if (expiretime
!= -1) {
3130 /* If this key is already expired skip it */
3131 if (expiretime
< now
) continue;
3132 if (rdbSaveType(fp
,REDIS_EXPIRETIME
) == -1) goto werr
;
3133 if (rdbSaveTime(fp
,expiretime
) == -1) goto werr
;
3135 /* Save the key and associated value. This requires special
3136 * handling if the value is swapped out. */
3137 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
3138 key
->storage
== REDIS_VM_SWAPPING
) {
3139 /* Save type, key, value */
3140 if (rdbSaveType(fp
,o
->type
) == -1) goto werr
;
3141 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3142 if (rdbSaveObject(fp
,o
) == -1) goto werr
;
3144 /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
3146 /* Get a preview of the object in memory */
3147 po
= vmPreviewObject(key
);
3148 /* Save type, key, value */
3149 if (rdbSaveType(fp
,key
->vtype
) == -1) goto werr
;
3150 if (rdbSaveStringObject(fp
,key
) == -1) goto werr
;
3151 if (rdbSaveObject(fp
,po
) == -1) goto werr
;
3152 /* Remove the loaded object from memory */
3156 dictReleaseIterator(di
);
3159 if (rdbSaveType(fp
,REDIS_EOF
) == -1) goto werr
;
3161 /* Make sure data will not remain on the OS's output buffers */
3166 /* Use RENAME to make sure the DB file is changed atomically only
3167 * if the generate DB file is ok. */
3168 if (rename(tmpfile
,filename
) == -1) {
3169 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
3173 redisLog(REDIS_NOTICE
,"DB saved on disk");
3175 server
.lastsave
= time(NULL
);
3181 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
3182 if (di
) dictReleaseIterator(di
);
3186 static int rdbSaveBackground(char *filename
) {
3189 if (server
.bgsavechildpid
!= -1) return REDIS_ERR
;
3190 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
3191 if ((childpid
= fork()) == 0) {
3193 if (server
.vm_enabled
) vmReopenSwapFile();
3195 if (rdbSave(filename
) == REDIS_OK
) {
3202 if (childpid
== -1) {
3203 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
3207 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
3208 server
.bgsavechildpid
= childpid
;
3211 return REDIS_OK
; /* unreached */
3214 static void rdbRemoveTempFile(pid_t childpid
) {
3217 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
3221 static int rdbLoadType(FILE *fp
) {
3223 if (fread(&type
,1,1,fp
) == 0) return -1;
3227 static time_t rdbLoadTime(FILE *fp
) {
3229 if (fread(&t32
,4,1,fp
) == 0) return -1;
3230 return (time_t) t32
;
3233 /* Load an encoded length from the DB, see the REDIS_RDB_* defines on the top
3234 * of this file for a description of how this are stored on disk.
3236 * isencoded is set to 1 if the readed length is not actually a length but
3237 * an "encoding type", check the above comments for more info */
3238 static uint32_t rdbLoadLen(FILE *fp
, int *isencoded
) {
3239 unsigned char buf
[2];
3243 if (isencoded
) *isencoded
= 0;
3244 if (fread(buf
,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3245 type
= (buf
[0]&0xC0)>>6;
3246 if (type
== REDIS_RDB_6BITLEN
) {
3247 /* Read a 6 bit len */
3249 } else if (type
== REDIS_RDB_ENCVAL
) {
3250 /* Read a 6 bit len encoding type */
3251 if (isencoded
) *isencoded
= 1;
3253 } else if (type
== REDIS_RDB_14BITLEN
) {
3254 /* Read a 14 bit len */
3255 if (fread(buf
+1,1,1,fp
) == 0) return REDIS_RDB_LENERR
;
3256 return ((buf
[0]&0x3F)<<8)|buf
[1];
3258 /* Read a 32 bit len */
3259 if (fread(&len
,4,1,fp
) == 0) return REDIS_RDB_LENERR
;
3264 static robj
*rdbLoadIntegerObject(FILE *fp
, int enctype
) {
3265 unsigned char enc
[4];
3268 if (enctype
== REDIS_RDB_ENC_INT8
) {
3269 if (fread(enc
,1,1,fp
) == 0) return NULL
;
3270 val
= (signed char)enc
[0];
3271 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
3273 if (fread(enc
,2,1,fp
) == 0) return NULL
;
3274 v
= enc
[0]|(enc
[1]<<8);
3276 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
3278 if (fread(enc
,4,1,fp
) == 0) return NULL
;
3279 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
3282 val
= 0; /* anti-warning */
3285 return createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",val
));
3288 static robj
*rdbLoadLzfStringObject(FILE*fp
) {
3289 unsigned int len
, clen
;
3290 unsigned char *c
= NULL
;
3293 if ((clen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3294 if ((len
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3295 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
3296 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
3297 if (fread(c
,clen
,1,fp
) == 0) goto err
;
3298 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
3300 return createObject(REDIS_STRING
,val
);
3307 static robj
*rdbLoadStringObject(FILE*fp
) {
3312 len
= rdbLoadLen(fp
,&isencoded
);
3315 case REDIS_RDB_ENC_INT8
:
3316 case REDIS_RDB_ENC_INT16
:
3317 case REDIS_RDB_ENC_INT32
:
3318 return tryObjectSharing(rdbLoadIntegerObject(fp
,len
));
3319 case REDIS_RDB_ENC_LZF
:
3320 return tryObjectSharing(rdbLoadLzfStringObject(fp
));
3326 if (len
== REDIS_RDB_LENERR
) return NULL
;
3327 val
= sdsnewlen(NULL
,len
);
3328 if (len
&& fread(val
,len
,1,fp
) == 0) {
3332 return tryObjectSharing(createObject(REDIS_STRING
,val
));
3335 /* For information about double serialization check rdbSaveDoubleValue() */
3336 static int rdbLoadDoubleValue(FILE *fp
, double *val
) {
3340 if (fread(&len
,1,1,fp
) == 0) return -1;
3342 case 255: *val
= R_NegInf
; return 0;
3343 case 254: *val
= R_PosInf
; return 0;
3344 case 253: *val
= R_Nan
; return 0;
3346 if (fread(buf
,len
,1,fp
) == 0) return -1;
3348 sscanf(buf
, "%lg", val
);
3353 /* Load a Redis object of the specified type from the specified file.
3354 * On success a newly allocated object is returned, otherwise NULL. */
3355 static robj
*rdbLoadObject(int type
, FILE *fp
) {
3358 if (type
== REDIS_STRING
) {
3359 /* Read string value */
3360 if ((o
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3361 tryObjectEncoding(o
);
3362 } else if (type
== REDIS_LIST
|| type
== REDIS_SET
) {
3363 /* Read list/set value */
3366 if ((listlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3367 o
= (type
== REDIS_LIST
) ? createListObject() : createSetObject();
3368 /* It's faster to expand the dict to the right size asap in order
3369 * to avoid rehashing */
3370 if (type
== REDIS_SET
&& listlen
> DICT_HT_INITIAL_SIZE
)
3371 dictExpand(o
->ptr
,listlen
);
3372 /* Load every single element of the list/set */
3376 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3377 tryObjectEncoding(ele
);
3378 if (type
== REDIS_LIST
) {
3379 listAddNodeTail((list
*)o
->ptr
,ele
);
3381 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
3384 } else if (type
== REDIS_ZSET
) {
3385 /* Read list/set value */
3389 if ((zsetlen
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
3390 o
= createZsetObject();
3392 /* Load every single element of the list/set */
3395 double *score
= zmalloc(sizeof(double));
3397 if ((ele
= rdbLoadStringObject(fp
)) == NULL
) return NULL
;
3398 tryObjectEncoding(ele
);
3399 if (rdbLoadDoubleValue(fp
,score
) == -1) return NULL
;
3400 dictAdd(zs
->dict
,ele
,score
);
3401 zslInsert(zs
->zsl
,*score
,ele
);
3402 incrRefCount(ele
); /* added to skiplist */
3405 redisAssert(0 != 0);
3410 static int rdbLoad(char *filename
) {
3412 robj
*keyobj
= NULL
;
3414 int type
, retval
, rdbver
;
3415 dict
*d
= server
.db
[0].dict
;
3416 redisDb
*db
= server
.db
+0;
3418 time_t expiretime
= -1, now
= time(NULL
);
3419 long long loadedkeys
= 0;
3421 fp
= fopen(filename
,"r");
3422 if (!fp
) return REDIS_ERR
;
3423 if (fread(buf
,9,1,fp
) == 0) goto eoferr
;
3425 if (memcmp(buf
,"REDIS",5) != 0) {
3427 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
3430 rdbver
= atoi(buf
+5);
3433 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
3440 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3441 if (type
== REDIS_EXPIRETIME
) {
3442 if ((expiretime
= rdbLoadTime(fp
)) == -1) goto eoferr
;
3443 /* We read the time so we need to read the object type again */
3444 if ((type
= rdbLoadType(fp
)) == -1) goto eoferr
;
3446 if (type
== REDIS_EOF
) break;
3447 /* Handle SELECT DB opcode as a special case */
3448 if (type
== REDIS_SELECTDB
) {
3449 if ((dbid
= rdbLoadLen(fp
,NULL
)) == REDIS_RDB_LENERR
)
3451 if (dbid
>= (unsigned)server
.dbnum
) {
3452 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
3455 db
= server
.db
+dbid
;
3460 if ((keyobj
= rdbLoadStringObject(fp
)) == NULL
) goto eoferr
;
3462 if ((o
= rdbLoadObject(type
,fp
)) == NULL
) goto eoferr
;
3463 /* Add the new object in the hash table */
3464 retval
= dictAdd(d
,keyobj
,o
);
3465 if (retval
== DICT_ERR
) {
3466 redisLog(REDIS_WARNING
,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", keyobj
->ptr
);
3469 /* Set the expire time if needed */
3470 if (expiretime
!= -1) {
3471 setExpire(db
,keyobj
,expiretime
);
3472 /* Delete this key if already expired */
3473 if (expiretime
< now
) deleteKey(db
,keyobj
);
3477 /* Handle swapping while loading big datasets when VM is on */
3479 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
3480 while (zmalloc_used_memory() > server
.vm_max_memory
) {
3481 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
3488 eoferr
: /* unexpected end of file is handled here with a fatal exit */
3489 if (keyobj
) decrRefCount(keyobj
);
3490 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
3492 return REDIS_ERR
; /* Just to avoid warning */
3495 /*================================== Commands =============================== */
3497 static void authCommand(redisClient
*c
) {
3498 if (!server
.requirepass
|| !strcmp(c
->argv
[1]->ptr
, server
.requirepass
)) {
3499 c
->authenticated
= 1;
3500 addReply(c
,shared
.ok
);
3502 c
->authenticated
= 0;
3503 addReplySds(c
,sdscatprintf(sdsempty(),"-ERR invalid password\r\n"));
3507 static void pingCommand(redisClient
*c
) {
3508 addReply(c
,shared
.pong
);
3511 static void echoCommand(redisClient
*c
) {
3512 addReplyBulkLen(c
,c
->argv
[1]);
3513 addReply(c
,c
->argv
[1]);
3514 addReply(c
,shared
.crlf
);
3517 /*=================================== Strings =============================== */
3519 static void setGenericCommand(redisClient
*c
, int nx
) {
3522 if (nx
) deleteIfVolatile(c
->db
,c
->argv
[1]);
3523 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3524 if (retval
== DICT_ERR
) {
3526 /* If the key is about a swapped value, we want a new key object
3527 * to overwrite the old. So we delete the old key in the database.
3528 * This will also make sure that swap pages about the old object
3529 * will be marked as free. */
3530 if (deleteIfSwapped(c
->db
,c
->argv
[1]))
3531 incrRefCount(c
->argv
[1]);
3532 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3533 incrRefCount(c
->argv
[2]);
3535 addReply(c
,shared
.czero
);
3539 incrRefCount(c
->argv
[1]);
3540 incrRefCount(c
->argv
[2]);
3543 removeExpire(c
->db
,c
->argv
[1]);
3544 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3547 static void setCommand(redisClient
*c
) {
3548 setGenericCommand(c
,0);
3551 static void setnxCommand(redisClient
*c
) {
3552 setGenericCommand(c
,1);
3555 static int getGenericCommand(redisClient
*c
) {
3556 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[1]);
3559 addReply(c
,shared
.nullbulk
);
3562 if (o
->type
!= REDIS_STRING
) {
3563 addReply(c
,shared
.wrongtypeerr
);
3566 addReplyBulkLen(c
,o
);
3568 addReply(c
,shared
.crlf
);
3574 static void getCommand(redisClient
*c
) {
3575 getGenericCommand(c
);
3578 static void getsetCommand(redisClient
*c
) {
3579 if (getGenericCommand(c
) == REDIS_ERR
) return;
3580 if (dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]) == DICT_ERR
) {
3581 dictReplace(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3583 incrRefCount(c
->argv
[1]);
3585 incrRefCount(c
->argv
[2]);
3587 removeExpire(c
->db
,c
->argv
[1]);
3590 static void mgetCommand(redisClient
*c
) {
3593 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->argc
-1));
3594 for (j
= 1; j
< c
->argc
; j
++) {
3595 robj
*o
= lookupKeyRead(c
->db
,c
->argv
[j
]);
3597 addReply(c
,shared
.nullbulk
);
3599 if (o
->type
!= REDIS_STRING
) {
3600 addReply(c
,shared
.nullbulk
);
3602 addReplyBulkLen(c
,o
);
3604 addReply(c
,shared
.crlf
);
3610 static void msetGenericCommand(redisClient
*c
, int nx
) {
3611 int j
, busykeys
= 0;
3613 if ((c
->argc
% 2) == 0) {
3614 addReplySds(c
,sdsnew("-ERR wrong number of arguments for MSET\r\n"));
3617 /* Handle the NX flag. The MSETNX semantic is to return zero and don't
3618 * set nothing at all if at least one already key exists. */
3620 for (j
= 1; j
< c
->argc
; j
+= 2) {
3621 if (lookupKeyWrite(c
->db
,c
->argv
[j
]) != NULL
) {
3627 addReply(c
, shared
.czero
);
3631 for (j
= 1; j
< c
->argc
; j
+= 2) {
3634 tryObjectEncoding(c
->argv
[j
+1]);
3635 retval
= dictAdd(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
3636 if (retval
== DICT_ERR
) {
3637 dictReplace(c
->db
->dict
,c
->argv
[j
],c
->argv
[j
+1]);
3638 incrRefCount(c
->argv
[j
+1]);
3640 incrRefCount(c
->argv
[j
]);
3641 incrRefCount(c
->argv
[j
+1]);
3643 removeExpire(c
->db
,c
->argv
[j
]);
3645 server
.dirty
+= (c
->argc
-1)/2;
3646 addReply(c
, nx
? shared
.cone
: shared
.ok
);
3649 static void msetCommand(redisClient
*c
) {
3650 msetGenericCommand(c
,0);
3653 static void msetnxCommand(redisClient
*c
) {
3654 msetGenericCommand(c
,1);
3657 static void incrDecrCommand(redisClient
*c
, long long incr
) {
3662 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3666 if (o
->type
!= REDIS_STRING
) {
3671 if (o
->encoding
== REDIS_ENCODING_RAW
)
3672 value
= strtoll(o
->ptr
, &eptr
, 10);
3673 else if (o
->encoding
== REDIS_ENCODING_INT
)
3674 value
= (long)o
->ptr
;
3676 redisAssert(1 != 1);
3681 o
= createObject(REDIS_STRING
,sdscatprintf(sdsempty(),"%lld",value
));
3682 tryObjectEncoding(o
);
3683 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],o
);
3684 if (retval
== DICT_ERR
) {
3685 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
3686 removeExpire(c
->db
,c
->argv
[1]);
3688 incrRefCount(c
->argv
[1]);
3691 addReply(c
,shared
.colon
);
3693 addReply(c
,shared
.crlf
);
3696 static void incrCommand(redisClient
*c
) {
3697 incrDecrCommand(c
,1);
3700 static void decrCommand(redisClient
*c
) {
3701 incrDecrCommand(c
,-1);
3704 static void incrbyCommand(redisClient
*c
) {
3705 long long incr
= strtoll(c
->argv
[2]->ptr
, NULL
, 10);
3706 incrDecrCommand(c
,incr
);
3709 static void decrbyCommand(redisClient
*c
) {
3710 long long incr
= strtoll(c
->argv
[2]->ptr
, NULL
, 10);
3711 incrDecrCommand(c
,-incr
);
3714 static void appendCommand(redisClient
*c
) {
3719 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3721 /* Create the key */
3722 retval
= dictAdd(c
->db
->dict
,c
->argv
[1],c
->argv
[2]);
3723 incrRefCount(c
->argv
[1]);
3724 incrRefCount(c
->argv
[2]);
3725 totlen
= stringObjectLen(c
->argv
[2]);
3729 de
= dictFind(c
->db
->dict
,c
->argv
[1]);
3732 o
= dictGetEntryVal(de
);
3733 if (o
->type
!= REDIS_STRING
) {
3734 addReply(c
,shared
.wrongtypeerr
);
3737 /* If the object is specially encoded or shared we have to make
3739 if (o
->refcount
!= 1 || o
->encoding
!= REDIS_ENCODING_RAW
) {
3740 robj
*decoded
= getDecodedObject(o
);
3742 o
= createStringObject(decoded
->ptr
, sdslen(decoded
->ptr
));
3743 decrRefCount(decoded
);
3744 dictReplace(c
->db
->dict
,c
->argv
[1],o
);
3747 if (c
->argv
[2]->encoding
== REDIS_ENCODING_RAW
) {
3748 o
->ptr
= sdscatlen(o
->ptr
,
3749 c
->argv
[2]->ptr
, sdslen(c
->argv
[2]->ptr
));
3751 o
->ptr
= sdscatprintf(o
->ptr
, "%ld",
3752 (unsigned long) c
->argv
[2]->ptr
);
3754 totlen
= sdslen(o
->ptr
);
3757 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",(unsigned long)totlen
));
3760 /* ========================= Type agnostic commands ========================= */
3762 static void delCommand(redisClient
*c
) {
3765 for (j
= 1; j
< c
->argc
; j
++) {
3766 if (deleteKey(c
->db
,c
->argv
[j
])) {
3773 addReply(c
,shared
.czero
);
3776 addReply(c
,shared
.cone
);
3779 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",deleted
));
3784 static void existsCommand(redisClient
*c
) {
3785 addReply(c
,lookupKeyRead(c
->db
,c
->argv
[1]) ? shared
.cone
: shared
.czero
);
3788 static void selectCommand(redisClient
*c
) {
3789 int id
= atoi(c
->argv
[1]->ptr
);
3791 if (selectDb(c
,id
) == REDIS_ERR
) {
3792 addReplySds(c
,sdsnew("-ERR invalid DB index\r\n"));
3794 addReply(c
,shared
.ok
);
3798 static void randomkeyCommand(redisClient
*c
) {
3802 de
= dictGetRandomKey(c
->db
->dict
);
3803 if (!de
|| expireIfNeeded(c
->db
,dictGetEntryKey(de
)) == 0) break;
3806 addReply(c
,shared
.plus
);
3807 addReply(c
,shared
.crlf
);
3809 addReply(c
,shared
.plus
);
3810 addReply(c
,dictGetEntryKey(de
));
3811 addReply(c
,shared
.crlf
);
3815 static void keysCommand(redisClient
*c
) {
3818 sds pattern
= c
->argv
[1]->ptr
;
3819 int plen
= sdslen(pattern
);
3820 unsigned long numkeys
= 0, keyslen
= 0;
3821 robj
*lenobj
= createObject(REDIS_STRING
,NULL
);
3823 di
= dictGetIterator(c
->db
->dict
);
3825 decrRefCount(lenobj
);
3826 while((de
= dictNext(di
)) != NULL
) {
3827 robj
*keyobj
= dictGetEntryKey(de
);
3829 sds key
= keyobj
->ptr
;
3830 if ((pattern
[0] == '*' && pattern
[1] == '\0') ||
3831 stringmatchlen(pattern
,plen
,key
,sdslen(key
),0)) {
3832 if (expireIfNeeded(c
->db
,keyobj
) == 0) {
3834 addReply(c
,shared
.space
);
3837 keyslen
+= sdslen(key
);
3841 dictReleaseIterator(di
);
3842 lenobj
->ptr
= sdscatprintf(sdsempty(),"$%lu\r\n",keyslen
+(numkeys
? (numkeys
-1) : 0));
3843 addReply(c
,shared
.crlf
);
3846 static void dbsizeCommand(redisClient
*c
) {
3848 sdscatprintf(sdsempty(),":%lu\r\n",dictSize(c
->db
->dict
)));
3851 static void lastsaveCommand(redisClient
*c
) {
3853 sdscatprintf(sdsempty(),":%lu\r\n",server
.lastsave
));
3856 static void typeCommand(redisClient
*c
) {
3860 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
3865 case REDIS_STRING
: type
= "+string"; break;
3866 case REDIS_LIST
: type
= "+list"; break;
3867 case REDIS_SET
: type
= "+set"; break;
3868 case REDIS_ZSET
: type
= "+zset"; break;
3869 default: type
= "unknown"; break;
3872 addReplySds(c
,sdsnew(type
));
3873 addReply(c
,shared
.crlf
);
3876 static void saveCommand(redisClient
*c
) {
3877 if (server
.bgsavechildpid
!= -1) {
3878 addReplySds(c
,sdsnew("-ERR background save in progress\r\n"));
3881 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
3882 addReply(c
,shared
.ok
);
3884 addReply(c
,shared
.err
);
3888 static void bgsaveCommand(redisClient
*c
) {
3889 if (server
.bgsavechildpid
!= -1) {
3890 addReplySds(c
,sdsnew("-ERR background save already in progress\r\n"));
3893 if (rdbSaveBackground(server
.dbfilename
) == REDIS_OK
) {
3894 char *status
= "+Background saving started\r\n";
3895 addReplySds(c
,sdsnew(status
));
3897 addReply(c
,shared
.err
);
3901 static void shutdownCommand(redisClient
*c
) {
3902 redisLog(REDIS_WARNING
,"User requested shutdown, saving DB...");
3903 /* Kill the saving child if there is a background saving in progress.
3904 We want to avoid race conditions, for instance our saving child may
3905 overwrite the synchronous saving did by SHUTDOWN. */
3906 if (server
.bgsavechildpid
!= -1) {
3907 redisLog(REDIS_WARNING
,"There is a live saving child. Killing it!");
3908 kill(server
.bgsavechildpid
,SIGKILL
);
3909 rdbRemoveTempFile(server
.bgsavechildpid
);
3911 if (server
.appendonly
) {
3912 /* Append only file: fsync() the AOF and exit */
3913 fsync(server
.appendfd
);
3914 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
3917 /* Snapshotting. Perform a SYNC SAVE and exit */
3918 if (rdbSave(server
.dbfilename
) == REDIS_OK
) {
3919 if (server
.daemonize
)
3920 unlink(server
.pidfile
);
3921 redisLog(REDIS_WARNING
,"%zu bytes used at exit",zmalloc_used_memory());
3922 redisLog(REDIS_WARNING
,"Server exit now, bye bye...");
3923 if (server
.vm_enabled
) unlink(server
.vm_swap_file
);
3926 /* Ooops.. error saving! The best we can do is to continue operating.
3927 * Note that if there was a background saving process, in the next
3928 * cron() Redis will be notified that the background saving aborted,
3929 * handling special stuff like slaves pending for synchronization... */
3930 redisLog(REDIS_WARNING
,"Error trying to save the DB, can't exit");
3931 addReplySds(c
,sdsnew("-ERR can't quit, problems saving the DB\r\n"));
3936 static void renameGenericCommand(redisClient
*c
, int nx
) {
3939 /* To use the same key as src and dst is probably an error */
3940 if (sdscmp(c
->argv
[1]->ptr
,c
->argv
[2]->ptr
) == 0) {
3941 addReply(c
,shared
.sameobjecterr
);
3945 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
3947 addReply(c
,shared
.nokeyerr
);
3951 deleteIfVolatile(c
->db
,c
->argv
[2]);
3952 if (dictAdd(c
->db
->dict
,c
->argv
[2],o
) == DICT_ERR
) {
3955 addReply(c
,shared
.czero
);
3958 dictReplace(c
->db
->dict
,c
->argv
[2],o
);
3960 incrRefCount(c
->argv
[2]);
3962 deleteKey(c
->db
,c
->argv
[1]);
3964 addReply(c
,nx
? shared
.cone
: shared
.ok
);
3967 static void renameCommand(redisClient
*c
) {
3968 renameGenericCommand(c
,0);
3971 static void renamenxCommand(redisClient
*c
) {
3972 renameGenericCommand(c
,1);
3975 static void moveCommand(redisClient
*c
) {
3980 /* Obtain source and target DB pointers */
3983 if (selectDb(c
,atoi(c
->argv
[2]->ptr
)) == REDIS_ERR
) {
3984 addReply(c
,shared
.outofrangeerr
);
3988 selectDb(c
,srcid
); /* Back to the source DB */
3990 /* If the user is moving using as target the same
3991 * DB as the source DB it is probably an error. */
3993 addReply(c
,shared
.sameobjecterr
);
3997 /* Check if the element exists and get a reference */
3998 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4000 addReply(c
,shared
.czero
);
4004 /* Try to add the element to the target DB */
4005 deleteIfVolatile(dst
,c
->argv
[1]);
4006 if (dictAdd(dst
->dict
,c
->argv
[1],o
) == DICT_ERR
) {
4007 addReply(c
,shared
.czero
);
4010 incrRefCount(c
->argv
[1]);
4013 /* OK! key moved, free the entry in the source DB */
4014 deleteKey(src
,c
->argv
[1]);
4016 addReply(c
,shared
.cone
);
4019 /* =================================== Lists ================================ */
4020 static void pushGenericCommand(redisClient
*c
, int where
) {
4024 lobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4026 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4027 addReply(c
,shared
.ok
);
4030 lobj
= createListObject();
4032 if (where
== REDIS_HEAD
) {
4033 listAddNodeHead(list
,c
->argv
[2]);
4035 listAddNodeTail(list
,c
->argv
[2]);
4037 dictAdd(c
->db
->dict
,c
->argv
[1],lobj
);
4038 incrRefCount(c
->argv
[1]);
4039 incrRefCount(c
->argv
[2]);
4041 if (lobj
->type
!= REDIS_LIST
) {
4042 addReply(c
,shared
.wrongtypeerr
);
4045 if (handleClientsWaitingListPush(c
,c
->argv
[1],c
->argv
[2])) {
4046 addReply(c
,shared
.ok
);
4050 if (where
== REDIS_HEAD
) {
4051 listAddNodeHead(list
,c
->argv
[2]);
4053 listAddNodeTail(list
,c
->argv
[2]);
4055 incrRefCount(c
->argv
[2]);
4058 addReply(c
,shared
.ok
);
4061 static void lpushCommand(redisClient
*c
) {
4062 pushGenericCommand(c
,REDIS_HEAD
);
4065 static void rpushCommand(redisClient
*c
) {
4066 pushGenericCommand(c
,REDIS_TAIL
);
4069 static void llenCommand(redisClient
*c
) {
4073 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4075 addReply(c
,shared
.czero
);
4078 if (o
->type
!= REDIS_LIST
) {
4079 addReply(c
,shared
.wrongtypeerr
);
4082 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",listLength(l
)));
4087 static void lindexCommand(redisClient
*c
) {
4089 int index
= atoi(c
->argv
[2]->ptr
);
4091 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4093 addReply(c
,shared
.nullbulk
);
4095 if (o
->type
!= REDIS_LIST
) {
4096 addReply(c
,shared
.wrongtypeerr
);
4098 list
*list
= o
->ptr
;
4101 ln
= listIndex(list
, index
);
4103 addReply(c
,shared
.nullbulk
);
4105 robj
*ele
= listNodeValue(ln
);
4106 addReplyBulkLen(c
,ele
);
4108 addReply(c
,shared
.crlf
);
4114 static void lsetCommand(redisClient
*c
) {
4116 int index
= atoi(c
->argv
[2]->ptr
);
4118 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4120 addReply(c
,shared
.nokeyerr
);
4122 if (o
->type
!= REDIS_LIST
) {
4123 addReply(c
,shared
.wrongtypeerr
);
4125 list
*list
= o
->ptr
;
4128 ln
= listIndex(list
, index
);
4130 addReply(c
,shared
.outofrangeerr
);
4132 robj
*ele
= listNodeValue(ln
);
4135 listNodeValue(ln
) = c
->argv
[3];
4136 incrRefCount(c
->argv
[3]);
4137 addReply(c
,shared
.ok
);
4144 static void popGenericCommand(redisClient
*c
, int where
) {
4147 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4149 addReply(c
,shared
.nullbulk
);
4151 if (o
->type
!= REDIS_LIST
) {
4152 addReply(c
,shared
.wrongtypeerr
);
4154 list
*list
= o
->ptr
;
4157 if (where
== REDIS_HEAD
)
4158 ln
= listFirst(list
);
4160 ln
= listLast(list
);
4163 addReply(c
,shared
.nullbulk
);
4165 robj
*ele
= listNodeValue(ln
);
4166 addReplyBulkLen(c
,ele
);
4168 addReply(c
,shared
.crlf
);
4169 listDelNode(list
,ln
);
4176 static void lpopCommand(redisClient
*c
) {
4177 popGenericCommand(c
,REDIS_HEAD
);
4180 static void rpopCommand(redisClient
*c
) {
4181 popGenericCommand(c
,REDIS_TAIL
);
4184 static void lrangeCommand(redisClient
*c
) {
4186 int start
= atoi(c
->argv
[2]->ptr
);
4187 int end
= atoi(c
->argv
[3]->ptr
);
4189 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4191 addReply(c
,shared
.nullmultibulk
);
4193 if (o
->type
!= REDIS_LIST
) {
4194 addReply(c
,shared
.wrongtypeerr
);
4196 list
*list
= o
->ptr
;
4198 int llen
= listLength(list
);
4202 /* convert negative indexes */
4203 if (start
< 0) start
= llen
+start
;
4204 if (end
< 0) end
= llen
+end
;
4205 if (start
< 0) start
= 0;
4206 if (end
< 0) end
= 0;
4208 /* indexes sanity checks */
4209 if (start
> end
|| start
>= llen
) {
4210 /* Out of range start or start > end result in empty list */
4211 addReply(c
,shared
.emptymultibulk
);
4214 if (end
>= llen
) end
= llen
-1;
4215 rangelen
= (end
-start
)+1;
4217 /* Return the result in form of a multi-bulk reply */
4218 ln
= listIndex(list
, start
);
4219 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",rangelen
));
4220 for (j
= 0; j
< rangelen
; j
++) {
4221 ele
= listNodeValue(ln
);
4222 addReplyBulkLen(c
,ele
);
4224 addReply(c
,shared
.crlf
);
4231 static void ltrimCommand(redisClient
*c
) {
4233 int start
= atoi(c
->argv
[2]->ptr
);
4234 int end
= atoi(c
->argv
[3]->ptr
);
4236 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4238 addReply(c
,shared
.ok
);
4240 if (o
->type
!= REDIS_LIST
) {
4241 addReply(c
,shared
.wrongtypeerr
);
4243 list
*list
= o
->ptr
;
4245 int llen
= listLength(list
);
4246 int j
, ltrim
, rtrim
;
4248 /* convert negative indexes */
4249 if (start
< 0) start
= llen
+start
;
4250 if (end
< 0) end
= llen
+end
;
4251 if (start
< 0) start
= 0;
4252 if (end
< 0) end
= 0;
4254 /* indexes sanity checks */
4255 if (start
> end
|| start
>= llen
) {
4256 /* Out of range start or start > end result in empty list */
4260 if (end
>= llen
) end
= llen
-1;
4265 /* Remove list elements to perform the trim */
4266 for (j
= 0; j
< ltrim
; j
++) {
4267 ln
= listFirst(list
);
4268 listDelNode(list
,ln
);
4270 for (j
= 0; j
< rtrim
; j
++) {
4271 ln
= listLast(list
);
4272 listDelNode(list
,ln
);
4275 addReply(c
,shared
.ok
);
4280 static void lremCommand(redisClient
*c
) {
4283 o
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4285 addReply(c
,shared
.czero
);
4287 if (o
->type
!= REDIS_LIST
) {
4288 addReply(c
,shared
.wrongtypeerr
);
4290 list
*list
= o
->ptr
;
4291 listNode
*ln
, *next
;
4292 int toremove
= atoi(c
->argv
[2]->ptr
);
4297 toremove
= -toremove
;
4300 ln
= fromtail
? list
->tail
: list
->head
;
4302 robj
*ele
= listNodeValue(ln
);
4304 next
= fromtail
? ln
->prev
: ln
->next
;
4305 if (compareStringObjects(ele
,c
->argv
[3]) == 0) {
4306 listDelNode(list
,ln
);
4309 if (toremove
&& removed
== toremove
) break;
4313 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",removed
));
4318 /* This is the semantic of this command:
4319 * RPOPLPUSH srclist dstlist:
4320 * IF LLEN(srclist) > 0
4321 * element = RPOP srclist
4322 * LPUSH dstlist element
4329 * The idea is to be able to get an element from a list in a reliable way
4330 * since the element is not just returned but pushed against another list
4331 * as well. This command was originally proposed by Ezra Zygmuntowicz.
4333 static void rpoplpushcommand(redisClient
*c
) {
4336 sobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4338 addReply(c
,shared
.nullbulk
);
4340 if (sobj
->type
!= REDIS_LIST
) {
4341 addReply(c
,shared
.wrongtypeerr
);
4343 list
*srclist
= sobj
->ptr
;
4344 listNode
*ln
= listLast(srclist
);
4347 addReply(c
,shared
.nullbulk
);
4349 robj
*dobj
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4350 robj
*ele
= listNodeValue(ln
);
4353 if (dobj
&& dobj
->type
!= REDIS_LIST
) {
4354 addReply(c
,shared
.wrongtypeerr
);
4358 /* Add the element to the target list (unless it's directly
4359 * passed to some BLPOP-ing client */
4360 if (!handleClientsWaitingListPush(c
,c
->argv
[2],ele
)) {
4362 /* Create the list if the key does not exist */
4363 dobj
= createListObject();
4364 dictAdd(c
->db
->dict
,c
->argv
[2],dobj
);
4365 incrRefCount(c
->argv
[2]);
4367 dstlist
= dobj
->ptr
;
4368 listAddNodeHead(dstlist
,ele
);
4372 /* Send the element to the client as reply as well */
4373 addReplyBulkLen(c
,ele
);
4375 addReply(c
,shared
.crlf
);
4377 /* Finally remove the element from the source list */
4378 listDelNode(srclist
,ln
);
4386 /* ==================================== Sets ================================ */
4388 static void saddCommand(redisClient
*c
) {
4391 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4393 set
= createSetObject();
4394 dictAdd(c
->db
->dict
,c
->argv
[1],set
);
4395 incrRefCount(c
->argv
[1]);
4397 if (set
->type
!= REDIS_SET
) {
4398 addReply(c
,shared
.wrongtypeerr
);
4402 if (dictAdd(set
->ptr
,c
->argv
[2],NULL
) == DICT_OK
) {
4403 incrRefCount(c
->argv
[2]);
4405 addReply(c
,shared
.cone
);
4407 addReply(c
,shared
.czero
);
4411 static void sremCommand(redisClient
*c
) {
4414 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4416 addReply(c
,shared
.czero
);
4418 if (set
->type
!= REDIS_SET
) {
4419 addReply(c
,shared
.wrongtypeerr
);
4422 if (dictDelete(set
->ptr
,c
->argv
[2]) == DICT_OK
) {
4424 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4425 addReply(c
,shared
.cone
);
4427 addReply(c
,shared
.czero
);
4432 static void smoveCommand(redisClient
*c
) {
4433 robj
*srcset
, *dstset
;
4435 srcset
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4436 dstset
= lookupKeyWrite(c
->db
,c
->argv
[2]);
4438 /* If the source key does not exist return 0, if it's of the wrong type
4440 if (srcset
== NULL
|| srcset
->type
!= REDIS_SET
) {
4441 addReply(c
, srcset
? shared
.wrongtypeerr
: shared
.czero
);
4444 /* Error if the destination key is not a set as well */
4445 if (dstset
&& dstset
->type
!= REDIS_SET
) {
4446 addReply(c
,shared
.wrongtypeerr
);
4449 /* Remove the element from the source set */
4450 if (dictDelete(srcset
->ptr
,c
->argv
[3]) == DICT_ERR
) {
4451 /* Key not found in the src set! return zero */
4452 addReply(c
,shared
.czero
);
4456 /* Add the element to the destination set */
4458 dstset
= createSetObject();
4459 dictAdd(c
->db
->dict
,c
->argv
[2],dstset
);
4460 incrRefCount(c
->argv
[2]);
4462 if (dictAdd(dstset
->ptr
,c
->argv
[3],NULL
) == DICT_OK
)
4463 incrRefCount(c
->argv
[3]);
4464 addReply(c
,shared
.cone
);
4467 static void sismemberCommand(redisClient
*c
) {
4470 set
= lookupKeyRead(c
->db
,c
->argv
[1]);
4472 addReply(c
,shared
.czero
);
4474 if (set
->type
!= REDIS_SET
) {
4475 addReply(c
,shared
.wrongtypeerr
);
4478 if (dictFind(set
->ptr
,c
->argv
[2]))
4479 addReply(c
,shared
.cone
);
4481 addReply(c
,shared
.czero
);
4485 static void scardCommand(redisClient
*c
) {
4489 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
4491 addReply(c
,shared
.czero
);
4494 if (o
->type
!= REDIS_SET
) {
4495 addReply(c
,shared
.wrongtypeerr
);
4498 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4504 static void spopCommand(redisClient
*c
) {
4508 set
= lookupKeyWrite(c
->db
,c
->argv
[1]);
4510 addReply(c
,shared
.nullbulk
);
4512 if (set
->type
!= REDIS_SET
) {
4513 addReply(c
,shared
.wrongtypeerr
);
4516 de
= dictGetRandomKey(set
->ptr
);
4518 addReply(c
,shared
.nullbulk
);
4520 robj
*ele
= dictGetEntryKey(de
);
4522 addReplyBulkLen(c
,ele
);
4524 addReply(c
,shared
.crlf
);
4525 dictDelete(set
->ptr
,ele
);
4526 if (htNeedsResize(set
->ptr
)) dictResize(set
->ptr
);
4532 static void srandmemberCommand(redisClient
*c
) {
4536 set
= lookupKeyRead(c
->db
,c
->argv
[1]);
4538 addReply(c
,shared
.nullbulk
);
4540 if (set
->type
!= REDIS_SET
) {
4541 addReply(c
,shared
.wrongtypeerr
);
4544 de
= dictGetRandomKey(set
->ptr
);
4546 addReply(c
,shared
.nullbulk
);
4548 robj
*ele
= dictGetEntryKey(de
);
4550 addReplyBulkLen(c
,ele
);
4552 addReply(c
,shared
.crlf
);
4557 static int qsortCompareSetsByCardinality(const void *s1
, const void *s2
) {
4558 dict
**d1
= (void*) s1
, **d2
= (void*) s2
;
4560 return dictSize(*d1
)-dictSize(*d2
);
4563 static void sinterGenericCommand(redisClient
*c
, robj
**setskeys
, unsigned long setsnum
, robj
*dstkey
) {
4564 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4567 robj
*lenobj
= NULL
, *dstset
= NULL
;
4568 unsigned long j
, cardinality
= 0;
4570 for (j
= 0; j
< setsnum
; j
++) {
4574 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4575 lookupKeyRead(c
->db
,setskeys
[j
]);
4579 if (deleteKey(c
->db
,dstkey
))
4581 addReply(c
,shared
.czero
);
4583 addReply(c
,shared
.nullmultibulk
);
4587 if (setobj
->type
!= REDIS_SET
) {
4589 addReply(c
,shared
.wrongtypeerr
);
4592 dv
[j
] = setobj
->ptr
;
4594 /* Sort sets from the smallest to largest, this will improve our
4595 * algorithm's performace */
4596 qsort(dv
,setsnum
,sizeof(dict
*),qsortCompareSetsByCardinality
);
4598 /* The first thing we should output is the total number of elements...
4599 * since this is a multi-bulk write, but at this stage we don't know
4600 * the intersection set size, so we use a trick, append an empty object
4601 * to the output list and save the pointer to later modify it with the
4604 lenobj
= createObject(REDIS_STRING
,NULL
);
4606 decrRefCount(lenobj
);
4608 /* If we have a target key where to store the resulting set
4609 * create this key with an empty set inside */
4610 dstset
= createSetObject();
4613 /* Iterate all the elements of the first (smallest) set, and test
4614 * the element against all the other sets, if at least one set does
4615 * not include the element it is discarded */
4616 di
= dictGetIterator(dv
[0]);
4618 while((de
= dictNext(di
)) != NULL
) {
4621 for (j
= 1; j
< setsnum
; j
++)
4622 if (dictFind(dv
[j
],dictGetEntryKey(de
)) == NULL
) break;
4624 continue; /* at least one set does not contain the member */
4625 ele
= dictGetEntryKey(de
);
4627 addReplyBulkLen(c
,ele
);
4629 addReply(c
,shared
.crlf
);
4632 dictAdd(dstset
->ptr
,ele
,NULL
);
4636 dictReleaseIterator(di
);
4639 /* Store the resulting set into the target */
4640 deleteKey(c
->db
,dstkey
);
4641 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4642 incrRefCount(dstkey
);
4646 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",cardinality
);
4648 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4649 dictSize((dict
*)dstset
->ptr
)));
4655 static void sinterCommand(redisClient
*c
) {
4656 sinterGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
);
4659 static void sinterstoreCommand(redisClient
*c
) {
4660 sinterGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1]);
4663 #define REDIS_OP_UNION 0
4664 #define REDIS_OP_DIFF 1
4666 static void sunionDiffGenericCommand(redisClient
*c
, robj
**setskeys
, int setsnum
, robj
*dstkey
, int op
) {
4667 dict
**dv
= zmalloc(sizeof(dict
*)*setsnum
);
4670 robj
*dstset
= NULL
;
4671 int j
, cardinality
= 0;
4673 for (j
= 0; j
< setsnum
; j
++) {
4677 lookupKeyWrite(c
->db
,setskeys
[j
]) :
4678 lookupKeyRead(c
->db
,setskeys
[j
]);
4683 if (setobj
->type
!= REDIS_SET
) {
4685 addReply(c
,shared
.wrongtypeerr
);
4688 dv
[j
] = setobj
->ptr
;
4691 /* We need a temp set object to store our union. If the dstkey
4692 * is not NULL (that is, we are inside an SUNIONSTORE operation) then
4693 * this set object will be the resulting object to set into the target key*/
4694 dstset
= createSetObject();
4696 /* Iterate all the elements of all the sets, add every element a single
4697 * time to the result set */
4698 for (j
= 0; j
< setsnum
; j
++) {
4699 if (op
== REDIS_OP_DIFF
&& j
== 0 && !dv
[j
]) break; /* result set is empty */
4700 if (!dv
[j
]) continue; /* non existing keys are like empty sets */
4702 di
= dictGetIterator(dv
[j
]);
4704 while((de
= dictNext(di
)) != NULL
) {
4707 /* dictAdd will not add the same element multiple times */
4708 ele
= dictGetEntryKey(de
);
4709 if (op
== REDIS_OP_UNION
|| j
== 0) {
4710 if (dictAdd(dstset
->ptr
,ele
,NULL
) == DICT_OK
) {
4714 } else if (op
== REDIS_OP_DIFF
) {
4715 if (dictDelete(dstset
->ptr
,ele
) == DICT_OK
) {
4720 dictReleaseIterator(di
);
4722 if (op
== REDIS_OP_DIFF
&& cardinality
== 0) break; /* result set is empty */
4725 /* Output the content of the resulting set, if not in STORE mode */
4727 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",cardinality
));
4728 di
= dictGetIterator(dstset
->ptr
);
4729 while((de
= dictNext(di
)) != NULL
) {
4732 ele
= dictGetEntryKey(de
);
4733 addReplyBulkLen(c
,ele
);
4735 addReply(c
,shared
.crlf
);
4737 dictReleaseIterator(di
);
4739 /* If we have a target key where to store the resulting set
4740 * create this key with the result set inside */
4741 deleteKey(c
->db
,dstkey
);
4742 dictAdd(c
->db
->dict
,dstkey
,dstset
);
4743 incrRefCount(dstkey
);
4748 decrRefCount(dstset
);
4750 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",
4751 dictSize((dict
*)dstset
->ptr
)));
4757 static void sunionCommand(redisClient
*c
) {
4758 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_UNION
);
4761 static void sunionstoreCommand(redisClient
*c
) {
4762 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_UNION
);
4765 static void sdiffCommand(redisClient
*c
) {
4766 sunionDiffGenericCommand(c
,c
->argv
+1,c
->argc
-1,NULL
,REDIS_OP_DIFF
);
4769 static void sdiffstoreCommand(redisClient
*c
) {
4770 sunionDiffGenericCommand(c
,c
->argv
+2,c
->argc
-2,c
->argv
[1],REDIS_OP_DIFF
);
4773 /* ==================================== ZSets =============================== */
4775 /* ZSETs are ordered sets using two data structures to hold the same elements
4776 * in order to get O(log(N)) INSERT and REMOVE operations into a sorted
4779 * The elements are added to an hash table mapping Redis objects to scores.
4780 * At the same time the elements are added to a skip list mapping scores
4781 * to Redis objects (so objects are sorted by scores in this "view"). */
4783 /* This skiplist implementation is almost a C translation of the original
4784 * algorithm described by William Pugh in "Skip Lists: A Probabilistic
4785 * Alternative to Balanced Trees", modified in three ways:
4786 * a) this implementation allows for repeated values.
4787 * b) the comparison is not just by key (our 'score') but by satellite data.
4788 * c) there is a back pointer, so it's a doubly linked list with the back
4789 * pointers being only at "level 1". This allows to traverse the list
4790 * from tail to head, useful for ZREVRANGE. */
4792 static zskiplistNode
*zslCreateNode(int level
, double score
, robj
*obj
) {
4793 zskiplistNode
*zn
= zmalloc(sizeof(*zn
));
4795 zn
->forward
= zmalloc(sizeof(zskiplistNode
*) * level
);
4801 static zskiplist
*zslCreate(void) {
4805 zsl
= zmalloc(sizeof(*zsl
));
4808 zsl
->header
= zslCreateNode(ZSKIPLIST_MAXLEVEL
,0,NULL
);
4809 for (j
= 0; j
< ZSKIPLIST_MAXLEVEL
; j
++)
4810 zsl
->header
->forward
[j
] = NULL
;
4811 zsl
->header
->backward
= NULL
;
4816 static void zslFreeNode(zskiplistNode
*node
) {
4817 decrRefCount(node
->obj
);
4818 zfree(node
->forward
);
4822 static void zslFree(zskiplist
*zsl
) {
4823 zskiplistNode
*node
= zsl
->header
->forward
[0], *next
;
4825 zfree(zsl
->header
->forward
);
4828 next
= node
->forward
[0];
4835 static int zslRandomLevel(void) {
4837 while ((random()&0xFFFF) < (ZSKIPLIST_P
* 0xFFFF))
4842 static void zslInsert(zskiplist
*zsl
, double score
, robj
*obj
) {
4843 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
4847 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4848 while (x
->forward
[i
] &&
4849 (x
->forward
[i
]->score
< score
||
4850 (x
->forward
[i
]->score
== score
&&
4851 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
4855 /* we assume the key is not already inside, since we allow duplicated
4856 * scores, and the re-insertion of score and redis object should never
4857 * happpen since the caller of zslInsert() should test in the hash table
4858 * if the element is already inside or not. */
4859 level
= zslRandomLevel();
4860 if (level
> zsl
->level
) {
4861 for (i
= zsl
->level
; i
< level
; i
++)
4862 update
[i
] = zsl
->header
;
4865 x
= zslCreateNode(level
,score
,obj
);
4866 for (i
= 0; i
< level
; i
++) {
4867 x
->forward
[i
] = update
[i
]->forward
[i
];
4868 update
[i
]->forward
[i
] = x
;
4870 x
->backward
= (update
[0] == zsl
->header
) ? NULL
: update
[0];
4872 x
->forward
[0]->backward
= x
;
4878 /* Delete an element with matching score/object from the skiplist. */
4879 static int zslDelete(zskiplist
*zsl
, double score
, robj
*obj
) {
4880 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
4884 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4885 while (x
->forward
[i
] &&
4886 (x
->forward
[i
]->score
< score
||
4887 (x
->forward
[i
]->score
== score
&&
4888 compareStringObjects(x
->forward
[i
]->obj
,obj
) < 0)))
4892 /* We may have multiple elements with the same score, what we need
4893 * is to find the element with both the right score and object. */
4895 if (x
&& score
== x
->score
&& compareStringObjects(x
->obj
,obj
) == 0) {
4896 for (i
= 0; i
< zsl
->level
; i
++) {
4897 if (update
[i
]->forward
[i
] != x
) break;
4898 update
[i
]->forward
[i
] = x
->forward
[i
];
4900 if (x
->forward
[0]) {
4901 x
->forward
[0]->backward
= (x
->backward
== zsl
->header
) ?
4904 zsl
->tail
= x
->backward
;
4907 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
4912 return 0; /* not found */
4914 return 0; /* not found */
4917 /* Delete all the elements with score between min and max from the skiplist.
4918 * Min and mx are inclusive, so a score >= min || score <= max is deleted.
4919 * Note that this function takes the reference to the hash table view of the
4920 * sorted set, in order to remove the elements from the hash table too. */
4921 static unsigned long zslDeleteRange(zskiplist
*zsl
, double min
, double max
, dict
*dict
) {
4922 zskiplistNode
*update
[ZSKIPLIST_MAXLEVEL
], *x
;
4923 unsigned long removed
= 0;
4927 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4928 while (x
->forward
[i
] && x
->forward
[i
]->score
< min
)
4932 /* We may have multiple elements with the same score, what we need
4933 * is to find the element with both the right score and object. */
4935 while (x
&& x
->score
<= max
) {
4936 zskiplistNode
*next
;
4938 for (i
= 0; i
< zsl
->level
; i
++) {
4939 if (update
[i
]->forward
[i
] != x
) break;
4940 update
[i
]->forward
[i
] = x
->forward
[i
];
4942 if (x
->forward
[0]) {
4943 x
->forward
[0]->backward
= (x
->backward
== zsl
->header
) ?
4946 zsl
->tail
= x
->backward
;
4948 next
= x
->forward
[0];
4949 dictDelete(dict
,x
->obj
);
4951 while(zsl
->level
> 1 && zsl
->header
->forward
[zsl
->level
-1] == NULL
)
4957 return removed
; /* not found */
4960 /* Find the first node having a score equal or greater than the specified one.
4961 * Returns NULL if there is no match. */
4962 static zskiplistNode
*zslFirstWithScore(zskiplist
*zsl
, double score
) {
4967 for (i
= zsl
->level
-1; i
>= 0; i
--) {
4968 while (x
->forward
[i
] && x
->forward
[i
]->score
< score
)
4971 /* We may have multiple elements with the same score, what we need
4972 * is to find the element with both the right score and object. */
4973 return x
->forward
[0];
4976 /* The actual Z-commands implementations */
4978 /* This generic command implements both ZADD and ZINCRBY.
4979 * scoreval is the score if the operation is a ZADD (doincrement == 0) or
4980 * the increment if the operation is a ZINCRBY (doincrement == 1). */
4981 static void zaddGenericCommand(redisClient
*c
, robj
*key
, robj
*ele
, double scoreval
, int doincrement
) {
4986 zsetobj
= lookupKeyWrite(c
->db
,key
);
4987 if (zsetobj
== NULL
) {
4988 zsetobj
= createZsetObject();
4989 dictAdd(c
->db
->dict
,key
,zsetobj
);
4992 if (zsetobj
->type
!= REDIS_ZSET
) {
4993 addReply(c
,shared
.wrongtypeerr
);
4999 /* Ok now since we implement both ZADD and ZINCRBY here the code
5000 * needs to handle the two different conditions. It's all about setting
5001 * '*score', that is, the new score to set, to the right value. */
5002 score
= zmalloc(sizeof(double));
5006 /* Read the old score. If the element was not present starts from 0 */
5007 de
= dictFind(zs
->dict
,ele
);
5009 double *oldscore
= dictGetEntryVal(de
);
5010 *score
= *oldscore
+ scoreval
;
5018 /* What follows is a simple remove and re-insert operation that is common
5019 * to both ZADD and ZINCRBY... */
5020 if (dictAdd(zs
->dict
,ele
,score
) == DICT_OK
) {
5021 /* case 1: New element */
5022 incrRefCount(ele
); /* added to hash */
5023 zslInsert(zs
->zsl
,*score
,ele
);
5024 incrRefCount(ele
); /* added to skiplist */
5027 addReplyDouble(c
,*score
);
5029 addReply(c
,shared
.cone
);
5034 /* case 2: Score update operation */
5035 de
= dictFind(zs
->dict
,ele
);
5036 redisAssert(de
!= NULL
);
5037 oldscore
= dictGetEntryVal(de
);
5038 if (*score
!= *oldscore
) {
5041 /* Remove and insert the element in the skip list with new score */
5042 deleted
= zslDelete(zs
->zsl
,*oldscore
,ele
);
5043 redisAssert(deleted
!= 0);
5044 zslInsert(zs
->zsl
,*score
,ele
);
5046 /* Update the score in the hash table */
5047 dictReplace(zs
->dict
,ele
,score
);
5053 addReplyDouble(c
,*score
);
5055 addReply(c
,shared
.czero
);
5059 static void zaddCommand(redisClient
*c
) {
5062 scoreval
= strtod(c
->argv
[2]->ptr
,NULL
);
5063 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,0);
5066 static void zincrbyCommand(redisClient
*c
) {
5069 scoreval
= strtod(c
->argv
[2]->ptr
,NULL
);
5070 zaddGenericCommand(c
,c
->argv
[1],c
->argv
[3],scoreval
,1);
5073 static void zremCommand(redisClient
*c
) {
5077 zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5078 if (zsetobj
== NULL
) {
5079 addReply(c
,shared
.czero
);
5085 if (zsetobj
->type
!= REDIS_ZSET
) {
5086 addReply(c
,shared
.wrongtypeerr
);
5090 de
= dictFind(zs
->dict
,c
->argv
[2]);
5092 addReply(c
,shared
.czero
);
5095 /* Delete from the skiplist */
5096 oldscore
= dictGetEntryVal(de
);
5097 deleted
= zslDelete(zs
->zsl
,*oldscore
,c
->argv
[2]);
5098 redisAssert(deleted
!= 0);
5100 /* Delete from the hash table */
5101 dictDelete(zs
->dict
,c
->argv
[2]);
5102 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5104 addReply(c
,shared
.cone
);
5108 static void zremrangebyscoreCommand(redisClient
*c
) {
5109 double min
= strtod(c
->argv
[2]->ptr
,NULL
);
5110 double max
= strtod(c
->argv
[3]->ptr
,NULL
);
5114 zsetobj
= lookupKeyWrite(c
->db
,c
->argv
[1]);
5115 if (zsetobj
== NULL
) {
5116 addReply(c
,shared
.czero
);
5120 if (zsetobj
->type
!= REDIS_ZSET
) {
5121 addReply(c
,shared
.wrongtypeerr
);
5125 deleted
= zslDeleteRange(zs
->zsl
,min
,max
,zs
->dict
);
5126 if (htNeedsResize(zs
->dict
)) dictResize(zs
->dict
);
5127 server
.dirty
+= deleted
;
5128 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",deleted
));
5132 static void zrangeGenericCommand(redisClient
*c
, int reverse
) {
5134 int start
= atoi(c
->argv
[2]->ptr
);
5135 int end
= atoi(c
->argv
[3]->ptr
);
5138 if (c
->argc
== 5 && !strcasecmp(c
->argv
[4]->ptr
,"withscores")) {
5140 } else if (c
->argc
>= 5) {
5141 addReply(c
,shared
.syntaxerr
);
5145 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5147 addReply(c
,shared
.nullmultibulk
);
5149 if (o
->type
!= REDIS_ZSET
) {
5150 addReply(c
,shared
.wrongtypeerr
);
5152 zset
*zsetobj
= o
->ptr
;
5153 zskiplist
*zsl
= zsetobj
->zsl
;
5156 int llen
= zsl
->length
;
5160 /* convert negative indexes */
5161 if (start
< 0) start
= llen
+start
;
5162 if (end
< 0) end
= llen
+end
;
5163 if (start
< 0) start
= 0;
5164 if (end
< 0) end
= 0;
5166 /* indexes sanity checks */
5167 if (start
> end
|| start
>= llen
) {
5168 /* Out of range start or start > end result in empty list */
5169 addReply(c
,shared
.emptymultibulk
);
5172 if (end
>= llen
) end
= llen
-1;
5173 rangelen
= (end
-start
)+1;
5175 /* Return the result in form of a multi-bulk reply */
5181 ln
= zsl
->header
->forward
[0];
5183 ln
= ln
->forward
[0];
5186 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",
5187 withscores
? (rangelen
*2) : rangelen
));
5188 for (j
= 0; j
< rangelen
; j
++) {
5190 addReplyBulkLen(c
,ele
);
5192 addReply(c
,shared
.crlf
);
5194 addReplyDouble(c
,ln
->score
);
5195 ln
= reverse
? ln
->backward
: ln
->forward
[0];
5201 static void zrangeCommand(redisClient
*c
) {
5202 zrangeGenericCommand(c
,0);
5205 static void zrevrangeCommand(redisClient
*c
) {
5206 zrangeGenericCommand(c
,1);
5209 /* This command implements both ZRANGEBYSCORE and ZCOUNT.
5210 * If justcount is non-zero, just the count is returned. */
5211 static void genericZrangebyscoreCommand(redisClient
*c
, int justcount
) {
5214 int minex
= 0, maxex
= 0; /* are min or max exclusive? */
5215 int offset
= 0, limit
= -1;
5219 /* Parse the min-max interval. If one of the values is prefixed
5220 * by the "(" character, it's considered "open". For instance
5221 * ZRANGEBYSCORE zset (1.5 (2.5 will match min < x < max
5222 * ZRANGEBYSCORE zset 1.5 2.5 will instead match min <= x <= max */
5223 if (((char*)c
->argv
[2]->ptr
)[0] == '(') {
5224 min
= strtod((char*)c
->argv
[2]->ptr
+1,NULL
);
5227 min
= strtod(c
->argv
[2]->ptr
,NULL
);
5229 if (((char*)c
->argv
[3]->ptr
)[0] == '(') {
5230 max
= strtod((char*)c
->argv
[3]->ptr
+1,NULL
);
5233 max
= strtod(c
->argv
[3]->ptr
,NULL
);
5236 /* Parse "WITHSCORES": note that if the command was called with
5237 * the name ZCOUNT then we are sure that c->argc == 4, so we'll never
5238 * enter the following paths to parse WITHSCORES and LIMIT. */
5239 if (c
->argc
== 5 || c
->argc
== 8) {
5240 if (strcasecmp(c
->argv
[c
->argc
-1]->ptr
,"withscores") == 0)
5245 if (c
->argc
!= (4 + withscores
) && c
->argc
!= (7 + withscores
))
5249 sdsnew("-ERR wrong number of arguments for ZRANGEBYSCORE\r\n"));
5254 if (c
->argc
== (7 + withscores
) && strcasecmp(c
->argv
[4]->ptr
,"limit")) {
5255 addReply(c
,shared
.syntaxerr
);
5257 } else if (c
->argc
== (7 + withscores
)) {
5258 offset
= atoi(c
->argv
[5]->ptr
);
5259 limit
= atoi(c
->argv
[6]->ptr
);
5260 if (offset
< 0) offset
= 0;
5263 /* Ok, lookup the key and get the range */
5264 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5266 addReply(c
,justcount
? shared
.czero
: shared
.nullmultibulk
);
5268 if (o
->type
!= REDIS_ZSET
) {
5269 addReply(c
,shared
.wrongtypeerr
);
5271 zset
*zsetobj
= o
->ptr
;
5272 zskiplist
*zsl
= zsetobj
->zsl
;
5274 robj
*ele
, *lenobj
= NULL
;
5275 unsigned long rangelen
= 0;
5277 /* Get the first node with the score >= min, or with
5278 * score > min if 'minex' is true. */
5279 ln
= zslFirstWithScore(zsl
,min
);
5280 while (minex
&& ln
&& ln
->score
== min
) ln
= ln
->forward
[0];
5283 /* No element matching the speciifed interval */
5284 addReply(c
,justcount
? shared
.czero
: shared
.emptymultibulk
);
5288 /* We don't know in advance how many matching elements there
5289 * are in the list, so we push this object that will represent
5290 * the multi-bulk length in the output buffer, and will "fix"
5293 lenobj
= createObject(REDIS_STRING
,NULL
);
5295 decrRefCount(lenobj
);
5298 while(ln
&& (maxex
? (ln
->score
< max
) : (ln
->score
<= max
))) {
5301 ln
= ln
->forward
[0];
5304 if (limit
== 0) break;
5307 addReplyBulkLen(c
,ele
);
5309 addReply(c
,shared
.crlf
);
5311 addReplyDouble(c
,ln
->score
);
5313 ln
= ln
->forward
[0];
5315 if (limit
> 0) limit
--;
5318 addReplyLong(c
,(long)rangelen
);
5320 lenobj
->ptr
= sdscatprintf(sdsempty(),"*%lu\r\n",
5321 withscores
? (rangelen
*2) : rangelen
);
5327 static void zrangebyscoreCommand(redisClient
*c
) {
5328 genericZrangebyscoreCommand(c
,0);
5331 static void zcountCommand(redisClient
*c
) {
5332 genericZrangebyscoreCommand(c
,1);
5335 static void zcardCommand(redisClient
*c
) {
5339 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5341 addReply(c
,shared
.czero
);
5344 if (o
->type
!= REDIS_ZSET
) {
5345 addReply(c
,shared
.wrongtypeerr
);
5348 addReplySds(c
,sdscatprintf(sdsempty(),":%lu\r\n",zs
->zsl
->length
));
5353 static void zscoreCommand(redisClient
*c
) {
5357 o
= lookupKeyRead(c
->db
,c
->argv
[1]);
5359 addReply(c
,shared
.nullbulk
);
5362 if (o
->type
!= REDIS_ZSET
) {
5363 addReply(c
,shared
.wrongtypeerr
);
5368 de
= dictFind(zs
->dict
,c
->argv
[2]);
5370 addReply(c
,shared
.nullbulk
);
5372 double *score
= dictGetEntryVal(de
);
5374 addReplyDouble(c
,*score
);
5380 /* ========================= Non type-specific commands ==================== */
5382 static void flushdbCommand(redisClient
*c
) {
5383 server
.dirty
+= dictSize(c
->db
->dict
);
5384 dictEmpty(c
->db
->dict
);
5385 dictEmpty(c
->db
->expires
);
5386 addReply(c
,shared
.ok
);
5389 static void flushallCommand(redisClient
*c
) {
5390 server
.dirty
+= emptyDb();
5391 addReply(c
,shared
.ok
);
5392 rdbSave(server
.dbfilename
);
5396 static redisSortOperation
*createSortOperation(int type
, robj
*pattern
) {
5397 redisSortOperation
*so
= zmalloc(sizeof(*so
));
5399 so
->pattern
= pattern
;
5403 /* Return the value associated to the key with a name obtained
5404 * substituting the first occurence of '*' in 'pattern' with 'subst' */
5405 static robj
*lookupKeyByPattern(redisDb
*db
, robj
*pattern
, robj
*subst
) {
5409 int prefixlen
, sublen
, postfixlen
;
5410 /* Expoit the internal sds representation to create a sds string allocated on the stack in order to make this function faster */
5414 char buf
[REDIS_SORTKEY_MAX
+1];
5417 /* If the pattern is "#" return the substitution object itself in order
5418 * to implement the "SORT ... GET #" feature. */
5419 spat
= pattern
->ptr
;
5420 if (spat
[0] == '#' && spat
[1] == '\0') {
5424 /* The substitution object may be specially encoded. If so we create
5425 * a decoded object on the fly. Otherwise getDecodedObject will just
5426 * increment the ref count, that we'll decrement later. */
5427 subst
= getDecodedObject(subst
);
5430 if (sdslen(spat
)+sdslen(ssub
)-1 > REDIS_SORTKEY_MAX
) return NULL
;
5431 p
= strchr(spat
,'*');
5433 decrRefCount(subst
);
5438 sublen
= sdslen(ssub
);
5439 postfixlen
= sdslen(spat
)-(prefixlen
+1);
5440 memcpy(keyname
.buf
,spat
,prefixlen
);
5441 memcpy(keyname
.buf
+prefixlen
,ssub
,sublen
);
5442 memcpy(keyname
.buf
+prefixlen
+sublen
,p
+1,postfixlen
);
5443 keyname
.buf
[prefixlen
+sublen
+postfixlen
] = '\0';
5444 keyname
.len
= prefixlen
+sublen
+postfixlen
;
5446 initStaticStringObject(keyobj
,((char*)&keyname
)+(sizeof(long)*2))
5447 decrRefCount(subst
);
5449 /* printf("lookup '%s' => %p\n", keyname.buf,de); */
5450 return lookupKeyRead(db
,&keyobj
);
5453 /* sortCompare() is used by qsort in sortCommand(). Given that qsort_r with
5454 * the additional parameter is not standard but a BSD-specific we have to
5455 * pass sorting parameters via the global 'server' structure */
5456 static int sortCompare(const void *s1
, const void *s2
) {
5457 const redisSortObject
*so1
= s1
, *so2
= s2
;
5460 if (!server
.sort_alpha
) {
5461 /* Numeric sorting. Here it's trivial as we precomputed scores */
5462 if (so1
->u
.score
> so2
->u
.score
) {
5464 } else if (so1
->u
.score
< so2
->u
.score
) {
5470 /* Alphanumeric sorting */
5471 if (server
.sort_bypattern
) {
5472 if (!so1
->u
.cmpobj
|| !so2
->u
.cmpobj
) {
5473 /* At least one compare object is NULL */
5474 if (so1
->u
.cmpobj
== so2
->u
.cmpobj
)
5476 else if (so1
->u
.cmpobj
== NULL
)
5481 /* We have both the objects, use strcoll */
5482 cmp
= strcoll(so1
->u
.cmpobj
->ptr
,so2
->u
.cmpobj
->ptr
);
5485 /* Compare elements directly */
5488 dec1
= getDecodedObject(so1
->obj
);
5489 dec2
= getDecodedObject(so2
->obj
);
5490 cmp
= strcoll(dec1
->ptr
,dec2
->ptr
);
5495 return server
.sort_desc
? -cmp
: cmp
;
5498 /* The SORT command is the most complex command in Redis. Warning: this code
5499 * is optimized for speed and a bit less for readability */
5500 static void sortCommand(redisClient
*c
) {
5503 int desc
= 0, alpha
= 0;
5504 int limit_start
= 0, limit_count
= -1, start
, end
;
5505 int j
, dontsort
= 0, vectorlen
;
5506 int getop
= 0; /* GET operation counter */
5507 robj
*sortval
, *sortby
= NULL
, *storekey
= NULL
;
5508 redisSortObject
*vector
; /* Resulting vector to sort */
5510 /* Lookup the key to sort. It must be of the right types */
5511 sortval
= lookupKeyRead(c
->db
,c
->argv
[1]);
5512 if (sortval
== NULL
) {
5513 addReply(c
,shared
.nullmultibulk
);
5516 if (sortval
->type
!= REDIS_SET
&& sortval
->type
!= REDIS_LIST
&&
5517 sortval
->type
!= REDIS_ZSET
)
5519 addReply(c
,shared
.wrongtypeerr
);
5523 /* Create a list of operations to perform for every sorted element.
5524 * Operations can be GET/DEL/INCR/DECR */
5525 operations
= listCreate();
5526 listSetFreeMethod(operations
,zfree
);
5529 /* Now we need to protect sortval incrementing its count, in the future
5530 * SORT may have options able to overwrite/delete keys during the sorting
5531 * and the sorted key itself may get destroied */
5532 incrRefCount(sortval
);
5534 /* The SORT command has an SQL-alike syntax, parse it */
5535 while(j
< c
->argc
) {
5536 int leftargs
= c
->argc
-j
-1;
5537 if (!strcasecmp(c
->argv
[j
]->ptr
,"asc")) {
5539 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"desc")) {
5541 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"alpha")) {
5543 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"limit") && leftargs
>= 2) {
5544 limit_start
= atoi(c
->argv
[j
+1]->ptr
);
5545 limit_count
= atoi(c
->argv
[j
+2]->ptr
);
5547 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"store") && leftargs
>= 1) {
5548 storekey
= c
->argv
[j
+1];
5550 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"by") && leftargs
>= 1) {
5551 sortby
= c
->argv
[j
+1];
5552 /* If the BY pattern does not contain '*', i.e. it is constant,
5553 * we don't need to sort nor to lookup the weight keys. */
5554 if (strchr(c
->argv
[j
+1]->ptr
,'*') == NULL
) dontsort
= 1;
5556 } else if (!strcasecmp(c
->argv
[j
]->ptr
,"get") && leftargs
>= 1) {
5557 listAddNodeTail(operations
,createSortOperation(
5558 REDIS_SORT_GET
,c
->argv
[j
+1]));
5562 decrRefCount(sortval
);
5563 listRelease(operations
);
5564 addReply(c
,shared
.syntaxerr
);
5570 /* Load the sorting vector with all the objects to sort */
5571 switch(sortval
->type
) {
5572 case REDIS_LIST
: vectorlen
= listLength((list
*)sortval
->ptr
); break;
5573 case REDIS_SET
: vectorlen
= dictSize((dict
*)sortval
->ptr
); break;
5574 case REDIS_ZSET
: vectorlen
= dictSize(((zset
*)sortval
->ptr
)->dict
); break;
5575 default: vectorlen
= 0; redisAssert(0); /* Avoid GCC warning */
5577 vector
= zmalloc(sizeof(redisSortObject
)*vectorlen
);
5580 if (sortval
->type
== REDIS_LIST
) {
5581 list
*list
= sortval
->ptr
;
5585 listRewind(list
,&li
);
5586 while((ln
= listNext(&li
))) {
5587 robj
*ele
= ln
->value
;
5588 vector
[j
].obj
= ele
;
5589 vector
[j
].u
.score
= 0;
5590 vector
[j
].u
.cmpobj
= NULL
;
5598 if (sortval
->type
== REDIS_SET
) {
5601 zset
*zs
= sortval
->ptr
;
5605 di
= dictGetIterator(set
);
5606 while((setele
= dictNext(di
)) != NULL
) {
5607 vector
[j
].obj
= dictGetEntryKey(setele
);
5608 vector
[j
].u
.score
= 0;
5609 vector
[j
].u
.cmpobj
= NULL
;
5612 dictReleaseIterator(di
);
5614 redisAssert(j
== vectorlen
);
5616 /* Now it's time to load the right scores in the sorting vector */
5617 if (dontsort
== 0) {
5618 for (j
= 0; j
< vectorlen
; j
++) {
5622 byval
= lookupKeyByPattern(c
->db
,sortby
,vector
[j
].obj
);
5623 if (!byval
|| byval
->type
!= REDIS_STRING
) continue;
5625 vector
[j
].u
.cmpobj
= getDecodedObject(byval
);
5627 if (byval
->encoding
== REDIS_ENCODING_RAW
) {
5628 vector
[j
].u
.score
= strtod(byval
->ptr
,NULL
);
5630 /* Don't need to decode the object if it's
5631 * integer-encoded (the only encoding supported) so
5632 * far. We can just cast it */
5633 if (byval
->encoding
== REDIS_ENCODING_INT
) {
5634 vector
[j
].u
.score
= (long)byval
->ptr
;
5636 redisAssert(1 != 1);
5641 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_RAW
)
5642 vector
[j
].u
.score
= strtod(vector
[j
].obj
->ptr
,NULL
);
5644 if (vector
[j
].obj
->encoding
== REDIS_ENCODING_INT
)
5645 vector
[j
].u
.score
= (long) vector
[j
].obj
->ptr
;
5647 redisAssert(1 != 1);
5654 /* We are ready to sort the vector... perform a bit of sanity check
5655 * on the LIMIT option too. We'll use a partial version of quicksort. */
5656 start
= (limit_start
< 0) ? 0 : limit_start
;
5657 end
= (limit_count
< 0) ? vectorlen
-1 : start
+limit_count
-1;
5658 if (start
>= vectorlen
) {
5659 start
= vectorlen
-1;
5662 if (end
>= vectorlen
) end
= vectorlen
-1;
5664 if (dontsort
== 0) {
5665 server
.sort_desc
= desc
;
5666 server
.sort_alpha
= alpha
;
5667 server
.sort_bypattern
= sortby
? 1 : 0;
5668 if (sortby
&& (start
!= 0 || end
!= vectorlen
-1))
5669 pqsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
, start
,end
);
5671 qsort(vector
,vectorlen
,sizeof(redisSortObject
),sortCompare
);
5674 /* Send command output to the output buffer, performing the specified
5675 * GET/DEL/INCR/DECR operations if any. */
5676 outputlen
= getop
? getop
*(end
-start
+1) : end
-start
+1;
5677 if (storekey
== NULL
) {
5678 /* STORE option not specified, sent the sorting result to client */
5679 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",outputlen
));
5680 for (j
= start
; j
<= end
; j
++) {
5685 addReplyBulkLen(c
,vector
[j
].obj
);
5686 addReply(c
,vector
[j
].obj
);
5687 addReply(c
,shared
.crlf
);
5689 listRewind(operations
,&li
);
5690 while((ln
= listNext(&li
))) {
5691 redisSortOperation
*sop
= ln
->value
;
5692 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
5695 if (sop
->type
== REDIS_SORT_GET
) {
5696 if (!val
|| val
->type
!= REDIS_STRING
) {
5697 addReply(c
,shared
.nullbulk
);
5699 addReplyBulkLen(c
,val
);
5701 addReply(c
,shared
.crlf
);
5704 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
5709 robj
*listObject
= createListObject();
5710 list
*listPtr
= (list
*) listObject
->ptr
;
5712 /* STORE option specified, set the sorting result as a List object */
5713 for (j
= start
; j
<= end
; j
++) {
5718 listAddNodeTail(listPtr
,vector
[j
].obj
);
5719 incrRefCount(vector
[j
].obj
);
5721 listRewind(operations
,&li
);
5722 while((ln
= listNext(&li
))) {
5723 redisSortOperation
*sop
= ln
->value
;
5724 robj
*val
= lookupKeyByPattern(c
->db
,sop
->pattern
,
5727 if (sop
->type
== REDIS_SORT_GET
) {
5728 if (!val
|| val
->type
!= REDIS_STRING
) {
5729 listAddNodeTail(listPtr
,createStringObject("",0));
5731 listAddNodeTail(listPtr
,val
);
5735 redisAssert(sop
->type
== REDIS_SORT_GET
); /* always fails */
5739 if (dictReplace(c
->db
->dict
,storekey
,listObject
)) {
5740 incrRefCount(storekey
);
5742 /* Note: we add 1 because the DB is dirty anyway since even if the
5743 * SORT result is empty a new key is set and maybe the old content
5745 server
.dirty
+= 1+outputlen
;
5746 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",outputlen
));
5750 decrRefCount(sortval
);
5751 listRelease(operations
);
5752 for (j
= 0; j
< vectorlen
; j
++) {
5753 if (sortby
&& alpha
&& vector
[j
].u
.cmpobj
)
5754 decrRefCount(vector
[j
].u
.cmpobj
);
5759 /* Convert an amount of bytes into a human readable string in the form
5760 * of 100B, 2G, 100M, 4K, and so forth. */
5761 static void bytesToHuman(char *s
, unsigned long long n
) {
5766 sprintf(s
,"%lluB",n
);
5768 } else if (n
< (1024*1024)) {
5769 d
= (double)n
/(1024);
5770 sprintf(s
,"%.2fK",d
);
5771 } else if (n
< (1024LL*1024*1024)) {
5772 d
= (double)n
/(1024*1024);
5773 sprintf(s
,"%.2fM",d
);
5774 } else if (n
< (1024LL*1024*1024*1024)) {
5775 d
= (double)n
/(1024LL*1024*1024);
5776 sprintf(s
,"%.2fG",d
);
5780 /* Create the string returned by the INFO command. This is decoupled
5781 * by the INFO command itself as we need to report the same information
5782 * on memory corruption problems. */
5783 static sds
genRedisInfoString(void) {
5785 time_t uptime
= time(NULL
)-server
.stat_starttime
;
5789 bytesToHuman(hmem
,zmalloc_used_memory());
5790 info
= sdscatprintf(sdsempty(),
5791 "redis_version:%s\r\n"
5793 "multiplexing_api:%s\r\n"
5794 "process_id:%ld\r\n"
5795 "uptime_in_seconds:%ld\r\n"
5796 "uptime_in_days:%ld\r\n"
5797 "connected_clients:%d\r\n"
5798 "connected_slaves:%d\r\n"
5799 "blocked_clients:%d\r\n"
5800 "used_memory:%zu\r\n"
5801 "used_memory_human:%s\r\n"
5802 "changes_since_last_save:%lld\r\n"
5803 "bgsave_in_progress:%d\r\n"
5804 "last_save_time:%ld\r\n"
5805 "bgrewriteaof_in_progress:%d\r\n"
5806 "total_connections_received:%lld\r\n"
5807 "total_commands_processed:%lld\r\n"
5811 (sizeof(long) == 8) ? "64" : "32",
5816 listLength(server
.clients
)-listLength(server
.slaves
),
5817 listLength(server
.slaves
),
5818 server
.blpop_blocked_clients
,
5819 zmalloc_used_memory(),
5822 server
.bgsavechildpid
!= -1,
5824 server
.bgrewritechildpid
!= -1,
5825 server
.stat_numconnections
,
5826 server
.stat_numcommands
,
5827 server
.vm_enabled
!= 0,
5828 server
.masterhost
== NULL
? "master" : "slave"
5830 if (server
.masterhost
) {
5831 info
= sdscatprintf(info
,
5832 "master_host:%s\r\n"
5833 "master_port:%d\r\n"
5834 "master_link_status:%s\r\n"
5835 "master_last_io_seconds_ago:%d\r\n"
5838 (server
.replstate
== REDIS_REPL_CONNECTED
) ?
5840 server
.master
? ((int)(time(NULL
)-server
.master
->lastinteraction
)) : -1
5843 if (server
.vm_enabled
) {
5845 info
= sdscatprintf(info
,
5846 "vm_conf_max_memory:%llu\r\n"
5847 "vm_conf_page_size:%llu\r\n"
5848 "vm_conf_pages:%llu\r\n"
5849 "vm_stats_used_pages:%llu\r\n"
5850 "vm_stats_swapped_objects:%llu\r\n"
5851 "vm_stats_swappin_count:%llu\r\n"
5852 "vm_stats_swappout_count:%llu\r\n"
5853 "vm_stats_io_newjobs_len:%lu\r\n"
5854 "vm_stats_io_processing_len:%lu\r\n"
5855 "vm_stats_io_processed_len:%lu\r\n"
5856 "vm_stats_io_active_threads:%lu\r\n"
5857 "vm_stats_blocked_clients:%lu\r\n"
5858 ,(unsigned long long) server
.vm_max_memory
,
5859 (unsigned long long) server
.vm_page_size
,
5860 (unsigned long long) server
.vm_pages
,
5861 (unsigned long long) server
.vm_stats_used_pages
,
5862 (unsigned long long) server
.vm_stats_swapped_objects
,
5863 (unsigned long long) server
.vm_stats_swapins
,
5864 (unsigned long long) server
.vm_stats_swapouts
,
5865 (unsigned long) listLength(server
.io_newjobs
),
5866 (unsigned long) listLength(server
.io_processing
),
5867 (unsigned long) listLength(server
.io_processed
),
5868 (unsigned long) server
.io_active_threads
,
5869 (unsigned long) server
.vm_blocked_clients
5873 for (j
= 0; j
< server
.dbnum
; j
++) {
5874 long long keys
, vkeys
;
5876 keys
= dictSize(server
.db
[j
].dict
);
5877 vkeys
= dictSize(server
.db
[j
].expires
);
5878 if (keys
|| vkeys
) {
5879 info
= sdscatprintf(info
, "db%d:keys=%lld,expires=%lld\r\n",
5886 static void infoCommand(redisClient
*c
) {
5887 sds info
= genRedisInfoString();
5888 addReplySds(c
,sdscatprintf(sdsempty(),"$%lu\r\n",
5889 (unsigned long)sdslen(info
)));
5890 addReplySds(c
,info
);
5891 addReply(c
,shared
.crlf
);
5894 static void monitorCommand(redisClient
*c
) {
5895 /* ignore MONITOR if aleady slave or in monitor mode */
5896 if (c
->flags
& REDIS_SLAVE
) return;
5898 c
->flags
|= (REDIS_SLAVE
|REDIS_MONITOR
);
5900 listAddNodeTail(server
.monitors
,c
);
5901 addReply(c
,shared
.ok
);
5904 /* ================================= Expire ================================= */
5905 static int removeExpire(redisDb
*db
, robj
*key
) {
5906 if (dictDelete(db
->expires
,key
) == DICT_OK
) {
5913 static int setExpire(redisDb
*db
, robj
*key
, time_t when
) {
5914 if (dictAdd(db
->expires
,key
,(void*)when
) == DICT_ERR
) {
5922 /* Return the expire time of the specified key, or -1 if no expire
5923 * is associated with this key (i.e. the key is non volatile) */
5924 static time_t getExpire(redisDb
*db
, robj
*key
) {
5927 /* No expire? return ASAP */
5928 if (dictSize(db
->expires
) == 0 ||
5929 (de
= dictFind(db
->expires
,key
)) == NULL
) return -1;
5931 return (time_t) dictGetEntryVal(de
);
5934 static int expireIfNeeded(redisDb
*db
, robj
*key
) {
5938 /* No expire? return ASAP */
5939 if (dictSize(db
->expires
) == 0 ||
5940 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
5942 /* Lookup the expire */
5943 when
= (time_t) dictGetEntryVal(de
);
5944 if (time(NULL
) <= when
) return 0;
5946 /* Delete the key */
5947 dictDelete(db
->expires
,key
);
5948 return dictDelete(db
->dict
,key
) == DICT_OK
;
5951 static int deleteIfVolatile(redisDb
*db
, robj
*key
) {
5954 /* No expire? return ASAP */
5955 if (dictSize(db
->expires
) == 0 ||
5956 (de
= dictFind(db
->expires
,key
)) == NULL
) return 0;
5958 /* Delete the key */
5960 dictDelete(db
->expires
,key
);
5961 return dictDelete(db
->dict
,key
) == DICT_OK
;
5964 static void expireGenericCommand(redisClient
*c
, robj
*key
, time_t seconds
) {
5967 de
= dictFind(c
->db
->dict
,key
);
5969 addReply(c
,shared
.czero
);
5973 if (deleteKey(c
->db
,key
)) server
.dirty
++;
5974 addReply(c
, shared
.cone
);
5977 time_t when
= time(NULL
)+seconds
;
5978 if (setExpire(c
->db
,key
,when
)) {
5979 addReply(c
,shared
.cone
);
5982 addReply(c
,shared
.czero
);
5988 static void expireCommand(redisClient
*c
) {
5989 expireGenericCommand(c
,c
->argv
[1],strtol(c
->argv
[2]->ptr
,NULL
,10));
5992 static void expireatCommand(redisClient
*c
) {
5993 expireGenericCommand(c
,c
->argv
[1],strtol(c
->argv
[2]->ptr
,NULL
,10)-time(NULL
));
5996 static void ttlCommand(redisClient
*c
) {
6000 expire
= getExpire(c
->db
,c
->argv
[1]);
6002 ttl
= (int) (expire
-time(NULL
));
6003 if (ttl
< 0) ttl
= -1;
6005 addReplySds(c
,sdscatprintf(sdsempty(),":%d\r\n",ttl
));
6008 /* ================================ MULTI/EXEC ============================== */
6010 /* Client state initialization for MULTI/EXEC */
6011 static void initClientMultiState(redisClient
*c
) {
6012 c
->mstate
.commands
= NULL
;
6013 c
->mstate
.count
= 0;
6016 /* Release all the resources associated with MULTI/EXEC state */
6017 static void freeClientMultiState(redisClient
*c
) {
6020 for (j
= 0; j
< c
->mstate
.count
; j
++) {
6022 multiCmd
*mc
= c
->mstate
.commands
+j
;
6024 for (i
= 0; i
< mc
->argc
; i
++)
6025 decrRefCount(mc
->argv
[i
]);
6028 zfree(c
->mstate
.commands
);
6031 /* Add a new command into the MULTI commands queue */
6032 static void queueMultiCommand(redisClient
*c
, struct redisCommand
*cmd
) {
6036 c
->mstate
.commands
= zrealloc(c
->mstate
.commands
,
6037 sizeof(multiCmd
)*(c
->mstate
.count
+1));
6038 mc
= c
->mstate
.commands
+c
->mstate
.count
;
6041 mc
->argv
= zmalloc(sizeof(robj
*)*c
->argc
);
6042 memcpy(mc
->argv
,c
->argv
,sizeof(robj
*)*c
->argc
);
6043 for (j
= 0; j
< c
->argc
; j
++)
6044 incrRefCount(mc
->argv
[j
]);
6048 static void multiCommand(redisClient
*c
) {
6049 c
->flags
|= REDIS_MULTI
;
6050 addReply(c
,shared
.ok
);
6053 static void execCommand(redisClient
*c
) {
6058 if (!(c
->flags
& REDIS_MULTI
)) {
6059 addReplySds(c
,sdsnew("-ERR EXEC without MULTI\r\n"));
6063 orig_argv
= c
->argv
;
6064 orig_argc
= c
->argc
;
6065 addReplySds(c
,sdscatprintf(sdsempty(),"*%d\r\n",c
->mstate
.count
));
6066 for (j
= 0; j
< c
->mstate
.count
; j
++) {
6067 c
->argc
= c
->mstate
.commands
[j
].argc
;
6068 c
->argv
= c
->mstate
.commands
[j
].argv
;
6069 call(c
,c
->mstate
.commands
[j
].cmd
);
6071 c
->argv
= orig_argv
;
6072 c
->argc
= orig_argc
;
6073 freeClientMultiState(c
);
6074 initClientMultiState(c
);
6075 c
->flags
&= (~REDIS_MULTI
);
6078 /* =========================== Blocking Operations ========================= */
6080 /* Currently Redis blocking operations support is limited to list POP ops,
6081 * so the current implementation is not fully generic, but it is also not
6082 * completely specific so it will not require a rewrite to support new
6083 * kind of blocking operations in the future.
6085 * Still it's important to note that list blocking operations can be already
6086 * used as a notification mechanism in order to implement other blocking
6087 * operations at application level, so there must be a very strong evidence
6088 * of usefulness and generality before new blocking operations are implemented.
6090 * This is how the current blocking POP works, we use BLPOP as example:
6091 * - If the user calls BLPOP and the key exists and contains a non empty list
6092 * then LPOP is called instead. So BLPOP is semantically the same as LPOP
6093 * if there is not to block.
6094 * - If instead BLPOP is called and the key does not exists or the list is
6095 * empty we need to block. In order to do so we remove the notification for
6096 * new data to read in the client socket (so that we'll not serve new
6097 * requests if the blocking request is not served). Also we put the client
6098 * in a dictionary (db->blockingkeys) mapping keys to a list of clients
6099 * blocking for this keys.
6100 * - If a PUSH operation against a key with blocked clients waiting is
6101 * performed, we serve the first in the list: basically instead to push
6102 * the new element inside the list we return it to the (first / oldest)
6103 * blocking client, unblock the client, and remove it form the list.
6105 * The above comment and the source code should be enough in order to understand
6106 * the implementation and modify / fix it later.
6109 /* Set a client in blocking mode for the specified key, with the specified
6111 static void blockForKeys(redisClient
*c
, robj
**keys
, int numkeys
, time_t timeout
) {
6116 c
->blockingkeys
= zmalloc(sizeof(robj
*)*numkeys
);
6117 c
->blockingkeysnum
= numkeys
;
6118 c
->blockingto
= timeout
;
6119 for (j
= 0; j
< numkeys
; j
++) {
6120 /* Add the key in the client structure, to map clients -> keys */
6121 c
->blockingkeys
[j
] = keys
[j
];
6122 incrRefCount(keys
[j
]);
6124 /* And in the other "side", to map keys -> clients */
6125 de
= dictFind(c
->db
->blockingkeys
,keys
[j
]);
6129 /* For every key we take a list of clients blocked for it */
6131 retval
= dictAdd(c
->db
->blockingkeys
,keys
[j
],l
);
6132 incrRefCount(keys
[j
]);
6133 assert(retval
== DICT_OK
);
6135 l
= dictGetEntryVal(de
);
6137 listAddNodeTail(l
,c
);
6139 /* Mark the client as a blocked client */
6140 c
->flags
|= REDIS_BLOCKED
;
6141 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
6142 server
.blpop_blocked_clients
++;
6145 /* Unblock a client that's waiting in a blocking operation such as BLPOP */
6146 static void unblockClientWaitingData(redisClient
*c
) {
6151 assert(c
->blockingkeys
!= NULL
);
6152 /* The client may wait for multiple keys, so unblock it for every key. */
6153 for (j
= 0; j
< c
->blockingkeysnum
; j
++) {
6154 /* Remove this client from the list of clients waiting for this key. */
6155 de
= dictFind(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
6157 l
= dictGetEntryVal(de
);
6158 listDelNode(l
,listSearchKey(l
,c
));
6159 /* If the list is empty we need to remove it to avoid wasting memory */
6160 if (listLength(l
) == 0)
6161 dictDelete(c
->db
->blockingkeys
,c
->blockingkeys
[j
]);
6162 decrRefCount(c
->blockingkeys
[j
]);
6164 /* Cleanup the client structure */
6165 zfree(c
->blockingkeys
);
6166 c
->blockingkeys
= NULL
;
6167 c
->flags
&= (~REDIS_BLOCKED
);
6168 server
.blpop_blocked_clients
--;
6169 /* Ok now we are ready to get read events from socket, note that we
6170 * can't trap errors here as it's possible that unblockClientWaitingDatas() is
6171 * called from freeClient() itself, and the only thing we can do
6172 * if we failed to register the READABLE event is to kill the client.
6173 * Still the following function should never fail in the real world as
6174 * we are sure the file descriptor is sane, and we exit on out of mem. */
6175 aeCreateFileEvent(server
.el
, c
->fd
, AE_READABLE
, readQueryFromClient
, c
);
6176 /* As a final step we want to process data if there is some command waiting
6177 * in the input buffer. Note that this is safe even if
6178 * unblockClientWaitingData() gets called from freeClient() because
6179 * freeClient() will be smart enough to call this function
6180 * *after* c->querybuf was set to NULL. */
6181 if (c
->querybuf
&& sdslen(c
->querybuf
) > 0) processInputBuffer(c
);
6184 /* This should be called from any function PUSHing into lists.
6185 * 'c' is the "pushing client", 'key' is the key it is pushing data against,
6186 * 'ele' is the element pushed.
6188 * If the function returns 0 there was no client waiting for a list push
6191 * If the function returns 1 there was a client waiting for a list push
6192 * against this key, the element was passed to this client thus it's not
6193 * needed to actually add it to the list and the caller should return asap. */
6194 static int handleClientsWaitingListPush(redisClient
*c
, robj
*key
, robj
*ele
) {
6195 struct dictEntry
*de
;
6196 redisClient
*receiver
;
6200 de
= dictFind(c
->db
->blockingkeys
,key
);
6201 if (de
== NULL
) return 0;
6202 l
= dictGetEntryVal(de
);
6205 receiver
= ln
->value
;
6207 addReplySds(receiver
,sdsnew("*2\r\n"));
6208 addReplyBulkLen(receiver
,key
);
6209 addReply(receiver
,key
);
6210 addReply(receiver
,shared
.crlf
);
6211 addReplyBulkLen(receiver
,ele
);
6212 addReply(receiver
,ele
);
6213 addReply(receiver
,shared
.crlf
);
6214 unblockClientWaitingData(receiver
);
6218 /* Blocking RPOP/LPOP */
6219 static void blockingPopGenericCommand(redisClient
*c
, int where
) {
6224 for (j
= 1; j
< c
->argc
-1; j
++) {
6225 o
= lookupKeyWrite(c
->db
,c
->argv
[j
]);
6227 if (o
->type
!= REDIS_LIST
) {
6228 addReply(c
,shared
.wrongtypeerr
);
6231 list
*list
= o
->ptr
;
6232 if (listLength(list
) != 0) {
6233 /* If the list contains elements fall back to the usual
6234 * non-blocking POP operation */
6235 robj
*argv
[2], **orig_argv
;
6238 /* We need to alter the command arguments before to call
6239 * popGenericCommand() as the command takes a single key. */
6240 orig_argv
= c
->argv
;
6241 orig_argc
= c
->argc
;
6242 argv
[1] = c
->argv
[j
];
6246 /* Also the return value is different, we need to output
6247 * the multi bulk reply header and the key name. The
6248 * "real" command will add the last element (the value)
6249 * for us. If this souds like an hack to you it's just
6250 * because it is... */
6251 addReplySds(c
,sdsnew("*2\r\n"));
6252 addReplyBulkLen(c
,argv
[1]);
6253 addReply(c
,argv
[1]);
6254 addReply(c
,shared
.crlf
);
6255 popGenericCommand(c
,where
);
6257 /* Fix the client structure with the original stuff */
6258 c
->argv
= orig_argv
;
6259 c
->argc
= orig_argc
;
6265 /* If the list is empty or the key does not exists we must block */
6266 timeout
= strtol(c
->argv
[c
->argc
-1]->ptr
,NULL
,10);
6267 if (timeout
> 0) timeout
+= time(NULL
);
6268 blockForKeys(c
,c
->argv
+1,c
->argc
-2,timeout
);
6271 static void blpopCommand(redisClient
*c
) {
6272 blockingPopGenericCommand(c
,REDIS_HEAD
);
6275 static void brpopCommand(redisClient
*c
) {
6276 blockingPopGenericCommand(c
,REDIS_TAIL
);
6279 /* =============================== Replication ============================= */
6281 static int syncWrite(int fd
, char *ptr
, ssize_t size
, int timeout
) {
6282 ssize_t nwritten
, ret
= size
;
6283 time_t start
= time(NULL
);
6287 if (aeWait(fd
,AE_WRITABLE
,1000) & AE_WRITABLE
) {
6288 nwritten
= write(fd
,ptr
,size
);
6289 if (nwritten
== -1) return -1;
6293 if ((time(NULL
)-start
) > timeout
) {
6301 static int syncRead(int fd
, char *ptr
, ssize_t size
, int timeout
) {
6302 ssize_t nread
, totread
= 0;
6303 time_t start
= time(NULL
);
6307 if (aeWait(fd
,AE_READABLE
,1000) & AE_READABLE
) {
6308 nread
= read(fd
,ptr
,size
);
6309 if (nread
== -1) return -1;
6314 if ((time(NULL
)-start
) > timeout
) {
6322 static int syncReadLine(int fd
, char *ptr
, ssize_t size
, int timeout
) {
6329 if (syncRead(fd
,&c
,1,timeout
) == -1) return -1;
6332 if (nread
&& *(ptr
-1) == '\r') *(ptr
-1) = '\0';
6343 static void syncCommand(redisClient
*c
) {
6344 /* ignore SYNC if aleady slave or in monitor mode */
6345 if (c
->flags
& REDIS_SLAVE
) return;
6347 /* SYNC can't be issued when the server has pending data to send to
6348 * the client about already issued commands. We need a fresh reply
6349 * buffer registering the differences between the BGSAVE and the current
6350 * dataset, so that we can copy to other slaves if needed. */
6351 if (listLength(c
->reply
) != 0) {
6352 addReplySds(c
,sdsnew("-ERR SYNC is invalid with pending input\r\n"));
6356 redisLog(REDIS_NOTICE
,"Slave ask for synchronization");
6357 /* Here we need to check if there is a background saving operation
6358 * in progress, or if it is required to start one */
6359 if (server
.bgsavechildpid
!= -1) {
6360 /* Ok a background save is in progress. Let's check if it is a good
6361 * one for replication, i.e. if there is another slave that is
6362 * registering differences since the server forked to save */
6367 listRewind(server
.slaves
,&li
);
6368 while((ln
= listNext(&li
))) {
6370 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) break;
6373 /* Perfect, the server is already registering differences for
6374 * another slave. Set the right state, and copy the buffer. */
6375 listRelease(c
->reply
);
6376 c
->reply
= listDup(slave
->reply
);
6377 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
6378 redisLog(REDIS_NOTICE
,"Waiting for end of BGSAVE for SYNC");
6380 /* No way, we need to wait for the next BGSAVE in order to
6381 * register differences */
6382 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
6383 redisLog(REDIS_NOTICE
,"Waiting for next BGSAVE for SYNC");
6386 /* Ok we don't have a BGSAVE in progress, let's start one */
6387 redisLog(REDIS_NOTICE
,"Starting BGSAVE for SYNC");
6388 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
6389 redisLog(REDIS_NOTICE
,"Replication failed, can't BGSAVE");
6390 addReplySds(c
,sdsnew("-ERR Unalbe to perform background save\r\n"));
6393 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
6396 c
->flags
|= REDIS_SLAVE
;
6398 listAddNodeTail(server
.slaves
,c
);
6402 static void sendBulkToSlave(aeEventLoop
*el
, int fd
, void *privdata
, int mask
) {
6403 redisClient
*slave
= privdata
;
6405 REDIS_NOTUSED(mask
);
6406 char buf
[REDIS_IOBUF_LEN
];
6407 ssize_t nwritten
, buflen
;
6409 if (slave
->repldboff
== 0) {
6410 /* Write the bulk write count before to transfer the DB. In theory here
6411 * we don't know how much room there is in the output buffer of the
6412 * socket, but in pratice SO_SNDLOWAT (the minimum count for output
6413 * operations) will never be smaller than the few bytes we need. */
6416 bulkcount
= sdscatprintf(sdsempty(),"$%lld\r\n",(unsigned long long)
6418 if (write(fd
,bulkcount
,sdslen(bulkcount
)) != (signed)sdslen(bulkcount
))
6426 lseek(slave
->repldbfd
,slave
->repldboff
,SEEK_SET
);
6427 buflen
= read(slave
->repldbfd
,buf
,REDIS_IOBUF_LEN
);
6429 redisLog(REDIS_WARNING
,"Read error sending DB to slave: %s",
6430 (buflen
== 0) ? "premature EOF" : strerror(errno
));
6434 if ((nwritten
= write(fd
,buf
,buflen
)) == -1) {
6435 redisLog(REDIS_VERBOSE
,"Write error sending DB to slave: %s",
6440 slave
->repldboff
+= nwritten
;
6441 if (slave
->repldboff
== slave
->repldbsize
) {
6442 close(slave
->repldbfd
);
6443 slave
->repldbfd
= -1;
6444 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
6445 slave
->replstate
= REDIS_REPL_ONLINE
;
6446 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
,
6447 sendReplyToClient
, slave
) == AE_ERR
) {
6451 addReplySds(slave
,sdsempty());
6452 redisLog(REDIS_NOTICE
,"Synchronization with slave succeeded");
6456 /* This function is called at the end of every backgrond saving.
6457 * The argument bgsaveerr is REDIS_OK if the background saving succeeded
6458 * otherwise REDIS_ERR is passed to the function.
6460 * The goal of this function is to handle slaves waiting for a successful
6461 * background saving in order to perform non-blocking synchronization. */
6462 static void updateSlavesWaitingBgsave(int bgsaveerr
) {
6464 int startbgsave
= 0;
6467 listRewind(server
.slaves
,&li
);
6468 while((ln
= listNext(&li
))) {
6469 redisClient
*slave
= ln
->value
;
6471 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
) {
6473 slave
->replstate
= REDIS_REPL_WAIT_BGSAVE_END
;
6474 } else if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_END
) {
6475 struct redis_stat buf
;
6477 if (bgsaveerr
!= REDIS_OK
) {
6479 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE child returned an error");
6482 if ((slave
->repldbfd
= open(server
.dbfilename
,O_RDONLY
)) == -1 ||
6483 redis_fstat(slave
->repldbfd
,&buf
) == -1) {
6485 redisLog(REDIS_WARNING
,"SYNC failed. Can't open/stat DB after BGSAVE: %s", strerror(errno
));
6488 slave
->repldboff
= 0;
6489 slave
->repldbsize
= buf
.st_size
;
6490 slave
->replstate
= REDIS_REPL_SEND_BULK
;
6491 aeDeleteFileEvent(server
.el
,slave
->fd
,AE_WRITABLE
);
6492 if (aeCreateFileEvent(server
.el
, slave
->fd
, AE_WRITABLE
, sendBulkToSlave
, slave
) == AE_ERR
) {
6499 if (rdbSaveBackground(server
.dbfilename
) != REDIS_OK
) {
6502 listRewind(server
.slaves
,&li
);
6503 redisLog(REDIS_WARNING
,"SYNC failed. BGSAVE failed");
6504 while((ln
= listNext(&li
))) {
6505 redisClient
*slave
= ln
->value
;
6507 if (slave
->replstate
== REDIS_REPL_WAIT_BGSAVE_START
)
6514 static int syncWithMaster(void) {
6515 char buf
[1024], tmpfile
[256], authcmd
[1024];
6517 int fd
= anetTcpConnect(NULL
,server
.masterhost
,server
.masterport
);
6521 redisLog(REDIS_WARNING
,"Unable to connect to MASTER: %s",
6526 /* AUTH with the master if required. */
6527 if(server
.masterauth
) {
6528 snprintf(authcmd
, 1024, "AUTH %s\r\n", server
.masterauth
);
6529 if (syncWrite(fd
, authcmd
, strlen(server
.masterauth
)+7, 5) == -1) {
6531 redisLog(REDIS_WARNING
,"Unable to AUTH to MASTER: %s",
6535 /* Read the AUTH result. */
6536 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
6538 redisLog(REDIS_WARNING
,"I/O error reading auth result from MASTER: %s",
6542 if (buf
[0] != '+') {
6544 redisLog(REDIS_WARNING
,"Cannot AUTH to MASTER, is the masterauth password correct?");
6549 /* Issue the SYNC command */
6550 if (syncWrite(fd
,"SYNC \r\n",7,5) == -1) {
6552 redisLog(REDIS_WARNING
,"I/O error writing to MASTER: %s",
6556 /* Read the bulk write count */
6557 if (syncReadLine(fd
,buf
,1024,3600) == -1) {
6559 redisLog(REDIS_WARNING
,"I/O error reading bulk count from MASTER: %s",
6563 if (buf
[0] != '$') {
6565 redisLog(REDIS_WARNING
,"Bad protocol from MASTER, the first byte is not '$', are you sure the host and port are right?");
6568 dumpsize
= atoi(buf
+1);
6569 redisLog(REDIS_NOTICE
,"Receiving %d bytes data dump from MASTER",dumpsize
);
6570 /* Read the bulk write data on a temp file */
6571 snprintf(tmpfile
,256,"temp-%d.%ld.rdb",(int)time(NULL
),(long int)random());
6572 dfd
= open(tmpfile
,O_CREAT
|O_WRONLY
,0644);
6575 redisLog(REDIS_WARNING
,"Opening the temp file needed for MASTER <-> SLAVE synchronization: %s",strerror(errno
));
6579 int nread
, nwritten
;
6581 nread
= read(fd
,buf
,(dumpsize
< 1024)?dumpsize
:1024);
6583 redisLog(REDIS_WARNING
,"I/O error trying to sync with MASTER: %s",
6589 nwritten
= write(dfd
,buf
,nread
);
6590 if (nwritten
== -1) {
6591 redisLog(REDIS_WARNING
,"Write error writing to the DB dump file needed for MASTER <-> SLAVE synchrnonization: %s", strerror(errno
));
6599 if (rename(tmpfile
,server
.dbfilename
) == -1) {
6600 redisLog(REDIS_WARNING
,"Failed trying to rename the temp DB into dump.rdb in MASTER <-> SLAVE synchronization: %s", strerror(errno
));
6606 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
6607 redisLog(REDIS_WARNING
,"Failed trying to load the MASTER synchronization DB from disk");
6611 server
.master
= createClient(fd
);
6612 server
.master
->flags
|= REDIS_MASTER
;
6613 server
.master
->authenticated
= 1;
6614 server
.replstate
= REDIS_REPL_CONNECTED
;
6618 static void slaveofCommand(redisClient
*c
) {
6619 if (!strcasecmp(c
->argv
[1]->ptr
,"no") &&
6620 !strcasecmp(c
->argv
[2]->ptr
,"one")) {
6621 if (server
.masterhost
) {
6622 sdsfree(server
.masterhost
);
6623 server
.masterhost
= NULL
;
6624 if (server
.master
) freeClient(server
.master
);
6625 server
.replstate
= REDIS_REPL_NONE
;
6626 redisLog(REDIS_NOTICE
,"MASTER MODE enabled (user request)");
6629 sdsfree(server
.masterhost
);
6630 server
.masterhost
= sdsdup(c
->argv
[1]->ptr
);
6631 server
.masterport
= atoi(c
->argv
[2]->ptr
);
6632 if (server
.master
) freeClient(server
.master
);
6633 server
.replstate
= REDIS_REPL_CONNECT
;
6634 redisLog(REDIS_NOTICE
,"SLAVE OF %s:%d enabled (user request)",
6635 server
.masterhost
, server
.masterport
);
6637 addReply(c
,shared
.ok
);
6640 /* ============================ Maxmemory directive ======================== */
6642 /* Try to free one object form the pre-allocated objects free list.
6643 * This is useful under low mem conditions as by default we take 1 million
6644 * free objects allocated. On success REDIS_OK is returned, otherwise
6646 static int tryFreeOneObjectFromFreelist(void) {
6649 if (server
.vm_enabled
) pthread_mutex_lock(&server
.obj_freelist_mutex
);
6650 if (listLength(server
.objfreelist
)) {
6651 listNode
*head
= listFirst(server
.objfreelist
);
6652 o
= listNodeValue(head
);
6653 listDelNode(server
.objfreelist
,head
);
6654 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
6658 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.obj_freelist_mutex
);
6663 /* This function gets called when 'maxmemory' is set on the config file to limit
6664 * the max memory used by the server, and we are out of memory.
6665 * This function will try to, in order:
6667 * - Free objects from the free list
6668 * - Try to remove keys with an EXPIRE set
6670 * It is not possible to free enough memory to reach used-memory < maxmemory
6671 * the server will start refusing commands that will enlarge even more the
6674 static void freeMemoryIfNeeded(void) {
6675 while (server
.maxmemory
&& zmalloc_used_memory() > server
.maxmemory
) {
6676 int j
, k
, freed
= 0;
6678 if (tryFreeOneObjectFromFreelist() == REDIS_OK
) continue;
6679 for (j
= 0; j
< server
.dbnum
; j
++) {
6681 robj
*minkey
= NULL
;
6682 struct dictEntry
*de
;
6684 if (dictSize(server
.db
[j
].expires
)) {
6686 /* From a sample of three keys drop the one nearest to
6687 * the natural expire */
6688 for (k
= 0; k
< 3; k
++) {
6691 de
= dictGetRandomKey(server
.db
[j
].expires
);
6692 t
= (time_t) dictGetEntryVal(de
);
6693 if (minttl
== -1 || t
< minttl
) {
6694 minkey
= dictGetEntryKey(de
);
6698 deleteKey(server
.db
+j
,minkey
);
6701 if (!freed
) return; /* nothing to free... */
6705 /* ============================== Append Only file ========================== */
6707 static void feedAppendOnlyFile(struct redisCommand
*cmd
, int dictid
, robj
**argv
, int argc
) {
6708 sds buf
= sdsempty();
6714 /* The DB this command was targetting is not the same as the last command
6715 * we appendend. To issue a SELECT command is needed. */
6716 if (dictid
!= server
.appendseldb
) {
6719 snprintf(seldb
,sizeof(seldb
),"%d",dictid
);
6720 buf
= sdscatprintf(buf
,"*2\r\n$6\r\nSELECT\r\n$%lu\r\n%s\r\n",
6721 (unsigned long)strlen(seldb
),seldb
);
6722 server
.appendseldb
= dictid
;
6725 /* "Fix" the argv vector if the command is EXPIRE. We want to translate
6726 * EXPIREs into EXPIREATs calls */
6727 if (cmd
->proc
== expireCommand
) {
6730 tmpargv
[0] = createStringObject("EXPIREAT",8);
6731 tmpargv
[1] = argv
[1];
6732 incrRefCount(argv
[1]);
6733 when
= time(NULL
)+strtol(argv
[2]->ptr
,NULL
,10);
6734 tmpargv
[2] = createObject(REDIS_STRING
,
6735 sdscatprintf(sdsempty(),"%ld",when
));
6739 /* Append the actual command */
6740 buf
= sdscatprintf(buf
,"*%d\r\n",argc
);
6741 for (j
= 0; j
< argc
; j
++) {
6744 o
= getDecodedObject(o
);
6745 buf
= sdscatprintf(buf
,"$%lu\r\n",(unsigned long)sdslen(o
->ptr
));
6746 buf
= sdscatlen(buf
,o
->ptr
,sdslen(o
->ptr
));
6747 buf
= sdscatlen(buf
,"\r\n",2);
6751 /* Free the objects from the modified argv for EXPIREAT */
6752 if (cmd
->proc
== expireCommand
) {
6753 for (j
= 0; j
< 3; j
++)
6754 decrRefCount(argv
[j
]);
6757 /* We want to perform a single write. This should be guaranteed atomic
6758 * at least if the filesystem we are writing is a real physical one.
6759 * While this will save us against the server being killed I don't think
6760 * there is much to do about the whole server stopping for power problems
6762 nwritten
= write(server
.appendfd
,buf
,sdslen(buf
));
6763 if (nwritten
!= (signed)sdslen(buf
)) {
6764 /* Ooops, we are in troubles. The best thing to do for now is
6765 * to simply exit instead to give the illusion that everything is
6766 * working as expected. */
6767 if (nwritten
== -1) {
6768 redisLog(REDIS_WARNING
,"Exiting on error writing to the append-only file: %s",strerror(errno
));
6770 redisLog(REDIS_WARNING
,"Exiting on short write while writing to the append-only file: %s",strerror(errno
));
6774 /* If a background append only file rewriting is in progress we want to
6775 * accumulate the differences between the child DB and the current one
6776 * in a buffer, so that when the child process will do its work we
6777 * can append the differences to the new append only file. */
6778 if (server
.bgrewritechildpid
!= -1)
6779 server
.bgrewritebuf
= sdscatlen(server
.bgrewritebuf
,buf
,sdslen(buf
));
6783 if (server
.appendfsync
== APPENDFSYNC_ALWAYS
||
6784 (server
.appendfsync
== APPENDFSYNC_EVERYSEC
&&
6785 now
-server
.lastfsync
> 1))
6787 fsync(server
.appendfd
); /* Let's try to get this data on the disk */
6788 server
.lastfsync
= now
;
6792 /* In Redis commands are always executed in the context of a client, so in
6793 * order to load the append only file we need to create a fake client. */
6794 static struct redisClient
*createFakeClient(void) {
6795 struct redisClient
*c
= zmalloc(sizeof(*c
));
6799 c
->querybuf
= sdsempty();
6803 /* We set the fake client as a slave waiting for the synchronization
6804 * so that Redis will not try to send replies to this client. */
6805 c
->replstate
= REDIS_REPL_WAIT_BGSAVE_START
;
6806 c
->reply
= listCreate();
6807 listSetFreeMethod(c
->reply
,decrRefCount
);
6808 listSetDupMethod(c
->reply
,dupClientReplyValue
);
6812 static void freeFakeClient(struct redisClient
*c
) {
6813 sdsfree(c
->querybuf
);
6814 listRelease(c
->reply
);
6818 /* Replay the append log file. On error REDIS_OK is returned. On non fatal
6819 * error (the append only file is zero-length) REDIS_ERR is returned. On
6820 * fatal error an error message is logged and the program exists. */
6821 int loadAppendOnlyFile(char *filename
) {
6822 struct redisClient
*fakeClient
;
6823 FILE *fp
= fopen(filename
,"r");
6824 struct redis_stat sb
;
6825 unsigned long long loadedkeys
= 0;
6827 if (redis_fstat(fileno(fp
),&sb
) != -1 && sb
.st_size
== 0)
6831 redisLog(REDIS_WARNING
,"Fatal error: can't open the append log file for reading: %s",strerror(errno
));
6835 fakeClient
= createFakeClient();
6842 struct redisCommand
*cmd
;
6844 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) {
6850 if (buf
[0] != '*') goto fmterr
;
6852 argv
= zmalloc(sizeof(robj
*)*argc
);
6853 for (j
= 0; j
< argc
; j
++) {
6854 if (fgets(buf
,sizeof(buf
),fp
) == NULL
) goto readerr
;
6855 if (buf
[0] != '$') goto fmterr
;
6856 len
= strtol(buf
+1,NULL
,10);
6857 argsds
= sdsnewlen(NULL
,len
);
6858 if (len
&& fread(argsds
,len
,1,fp
) == 0) goto fmterr
;
6859 argv
[j
] = createObject(REDIS_STRING
,argsds
);
6860 if (fread(buf
,2,1,fp
) == 0) goto fmterr
; /* discard CRLF */
6863 /* Command lookup */
6864 cmd
= lookupCommand(argv
[0]->ptr
);
6866 redisLog(REDIS_WARNING
,"Unknown command '%s' reading the append only file", argv
[0]->ptr
);
6869 /* Try object sharing and encoding */
6870 if (server
.shareobjects
) {
6872 for(j
= 1; j
< argc
; j
++)
6873 argv
[j
] = tryObjectSharing(argv
[j
]);
6875 if (cmd
->flags
& REDIS_CMD_BULK
)
6876 tryObjectEncoding(argv
[argc
-1]);
6877 /* Run the command in the context of a fake client */
6878 fakeClient
->argc
= argc
;
6879 fakeClient
->argv
= argv
;
6880 cmd
->proc(fakeClient
);
6881 /* Discard the reply objects list from the fake client */
6882 while(listLength(fakeClient
->reply
))
6883 listDelNode(fakeClient
->reply
,listFirst(fakeClient
->reply
));
6884 /* Clean up, ready for the next command */
6885 for (j
= 0; j
< argc
; j
++) decrRefCount(argv
[j
]);
6887 /* Handle swapping while loading big datasets when VM is on */
6889 if (server
.vm_enabled
&& (loadedkeys
% 5000) == 0) {
6890 while (zmalloc_used_memory() > server
.vm_max_memory
) {
6891 if (vmSwapOneObjectBlocking() == REDIS_ERR
) break;
6896 freeFakeClient(fakeClient
);
6901 redisLog(REDIS_WARNING
,"Unexpected end of file reading the append only file");
6903 redisLog(REDIS_WARNING
,"Unrecoverable error reading the append only file: %s", strerror(errno
));
6907 redisLog(REDIS_WARNING
,"Bad file format reading the append only file");
6911 /* Write an object into a file in the bulk format $<count>\r\n<payload>\r\n */
6912 static int fwriteBulk(FILE *fp
, robj
*obj
) {
6916 /* Avoid the incr/decr ref count business if possible to help
6917 * copy-on-write (we are often in a child process when this function
6919 * Also makes sure that key objects don't get incrRefCount-ed when VM
6921 if (obj
->encoding
!= REDIS_ENCODING_RAW
) {
6922 obj
= getDecodedObject(obj
);
6925 snprintf(buf
,sizeof(buf
),"$%ld\r\n",(long)sdslen(obj
->ptr
));
6926 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) goto err
;
6927 if (sdslen(obj
->ptr
) && fwrite(obj
->ptr
,sdslen(obj
->ptr
),1,fp
) == 0)
6929 if (fwrite("\r\n",2,1,fp
) == 0) goto err
;
6930 if (decrrc
) decrRefCount(obj
);
6933 if (decrrc
) decrRefCount(obj
);
6937 /* Write a double value in bulk format $<count>\r\n<payload>\r\n */
6938 static int fwriteBulkDouble(FILE *fp
, double d
) {
6939 char buf
[128], dbuf
[128];
6941 snprintf(dbuf
,sizeof(dbuf
),"%.17g\r\n",d
);
6942 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(dbuf
)-2);
6943 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
6944 if (fwrite(dbuf
,strlen(dbuf
),1,fp
) == 0) return 0;
6948 /* Write a long value in bulk format $<count>\r\n<payload>\r\n */
6949 static int fwriteBulkLong(FILE *fp
, long l
) {
6950 char buf
[128], lbuf
[128];
6952 snprintf(lbuf
,sizeof(lbuf
),"%ld\r\n",l
);
6953 snprintf(buf
,sizeof(buf
),"$%lu\r\n",(unsigned long)strlen(lbuf
)-2);
6954 if (fwrite(buf
,strlen(buf
),1,fp
) == 0) return 0;
6955 if (fwrite(lbuf
,strlen(lbuf
),1,fp
) == 0) return 0;
6959 /* Write a sequence of commands able to fully rebuild the dataset into
6960 * "filename". Used both by REWRITEAOF and BGREWRITEAOF. */
6961 static int rewriteAppendOnlyFile(char *filename
) {
6962 dictIterator
*di
= NULL
;
6967 time_t now
= time(NULL
);
6969 /* Note that we have to use a different temp name here compared to the
6970 * one used by rewriteAppendOnlyFileBackground() function. */
6971 snprintf(tmpfile
,256,"temp-rewriteaof-%d.aof", (int) getpid());
6972 fp
= fopen(tmpfile
,"w");
6974 redisLog(REDIS_WARNING
, "Failed rewriting the append only file: %s", strerror(errno
));
6977 for (j
= 0; j
< server
.dbnum
; j
++) {
6978 char selectcmd
[] = "*2\r\n$6\r\nSELECT\r\n";
6979 redisDb
*db
= server
.db
+j
;
6981 if (dictSize(d
) == 0) continue;
6982 di
= dictGetIterator(d
);
6988 /* SELECT the new DB */
6989 if (fwrite(selectcmd
,sizeof(selectcmd
)-1,1,fp
) == 0) goto werr
;
6990 if (fwriteBulkLong(fp
,j
) == 0) goto werr
;
6992 /* Iterate this DB writing every entry */
6993 while((de
= dictNext(di
)) != NULL
) {
6998 key
= dictGetEntryKey(de
);
6999 /* If the value for this key is swapped, load a preview in memory.
7000 * We use a "swapped" flag to remember if we need to free the
7001 * value object instead to just increment the ref count anyway
7002 * in order to avoid copy-on-write of pages if we are forked() */
7003 if (!server
.vm_enabled
|| key
->storage
== REDIS_VM_MEMORY
||
7004 key
->storage
== REDIS_VM_SWAPPING
) {
7005 o
= dictGetEntryVal(de
);
7008 o
= vmPreviewObject(key
);
7011 expiretime
= getExpire(db
,key
);
7013 /* Save the key and associated value */
7014 if (o
->type
== REDIS_STRING
) {
7015 /* Emit a SET command */
7016 char cmd
[]="*3\r\n$3\r\nSET\r\n";
7017 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7019 if (fwriteBulk(fp
,key
) == 0) goto werr
;
7020 if (fwriteBulk(fp
,o
) == 0) goto werr
;
7021 } else if (o
->type
== REDIS_LIST
) {
7022 /* Emit the RPUSHes needed to rebuild the list */
7023 list
*list
= o
->ptr
;
7027 listRewind(list
,&li
);
7028 while((ln
= listNext(&li
))) {
7029 char cmd
[]="*3\r\n$5\r\nRPUSH\r\n";
7030 robj
*eleobj
= listNodeValue(ln
);
7032 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7033 if (fwriteBulk(fp
,key
) == 0) goto werr
;
7034 if (fwriteBulk(fp
,eleobj
) == 0) goto werr
;
7036 } else if (o
->type
== REDIS_SET
) {
7037 /* Emit the SADDs needed to rebuild the set */
7039 dictIterator
*di
= dictGetIterator(set
);
7042 while((de
= dictNext(di
)) != NULL
) {
7043 char cmd
[]="*3\r\n$4\r\nSADD\r\n";
7044 robj
*eleobj
= dictGetEntryKey(de
);
7046 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7047 if (fwriteBulk(fp
,key
) == 0) goto werr
;
7048 if (fwriteBulk(fp
,eleobj
) == 0) goto werr
;
7050 dictReleaseIterator(di
);
7051 } else if (o
->type
== REDIS_ZSET
) {
7052 /* Emit the ZADDs needed to rebuild the sorted set */
7054 dictIterator
*di
= dictGetIterator(zs
->dict
);
7057 while((de
= dictNext(di
)) != NULL
) {
7058 char cmd
[]="*4\r\n$4\r\nZADD\r\n";
7059 robj
*eleobj
= dictGetEntryKey(de
);
7060 double *score
= dictGetEntryVal(de
);
7062 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7063 if (fwriteBulk(fp
,key
) == 0) goto werr
;
7064 if (fwriteBulkDouble(fp
,*score
) == 0) goto werr
;
7065 if (fwriteBulk(fp
,eleobj
) == 0) goto werr
;
7067 dictReleaseIterator(di
);
7069 redisAssert(0 != 0);
7071 /* Save the expire time */
7072 if (expiretime
!= -1) {
7073 char cmd
[]="*3\r\n$8\r\nEXPIREAT\r\n";
7074 /* If this key is already expired skip it */
7075 if (expiretime
< now
) continue;
7076 if (fwrite(cmd
,sizeof(cmd
)-1,1,fp
) == 0) goto werr
;
7077 if (fwriteBulk(fp
,key
) == 0) goto werr
;
7078 if (fwriteBulkLong(fp
,expiretime
) == 0) goto werr
;
7080 if (swapped
) decrRefCount(o
);
7082 dictReleaseIterator(di
);
7085 /* Make sure data will not remain on the OS's output buffers */
7090 /* Use RENAME to make sure the DB file is changed atomically only
7091 * if the generate DB file is ok. */
7092 if (rename(tmpfile
,filename
) == -1) {
7093 redisLog(REDIS_WARNING
,"Error moving temp append only file on the final destination: %s", strerror(errno
));
7097 redisLog(REDIS_NOTICE
,"SYNC append only file rewrite performed");
7103 redisLog(REDIS_WARNING
,"Write error writing append only file on disk: %s", strerror(errno
));
7104 if (di
) dictReleaseIterator(di
);
7108 /* This is how rewriting of the append only file in background works:
7110 * 1) The user calls BGREWRITEAOF
7111 * 2) Redis calls this function, that forks():
7112 * 2a) the child rewrite the append only file in a temp file.
7113 * 2b) the parent accumulates differences in server.bgrewritebuf.
7114 * 3) When the child finished '2a' exists.
7115 * 4) The parent will trap the exit code, if it's OK, will append the
7116 * data accumulated into server.bgrewritebuf into the temp file, and
7117 * finally will rename(2) the temp file in the actual file name.
7118 * The the new file is reopened as the new append only file. Profit!
7120 static int rewriteAppendOnlyFileBackground(void) {
7123 if (server
.bgrewritechildpid
!= -1) return REDIS_ERR
;
7124 if (server
.vm_enabled
) waitEmptyIOJobsQueue();
7125 if ((childpid
= fork()) == 0) {
7129 if (server
.vm_enabled
) vmReopenSwapFile();
7131 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) getpid());
7132 if (rewriteAppendOnlyFile(tmpfile
) == REDIS_OK
) {
7139 if (childpid
== -1) {
7140 redisLog(REDIS_WARNING
,
7141 "Can't rewrite append only file in background: fork: %s",
7145 redisLog(REDIS_NOTICE
,
7146 "Background append only file rewriting started by pid %d",childpid
);
7147 server
.bgrewritechildpid
= childpid
;
7148 /* We set appendseldb to -1 in order to force the next call to the
7149 * feedAppendOnlyFile() to issue a SELECT command, so the differences
7150 * accumulated by the parent into server.bgrewritebuf will start
7151 * with a SELECT statement and it will be safe to merge. */
7152 server
.appendseldb
= -1;
7155 return REDIS_OK
; /* unreached */
7158 static void bgrewriteaofCommand(redisClient
*c
) {
7159 if (server
.bgrewritechildpid
!= -1) {
7160 addReplySds(c
,sdsnew("-ERR background append only file rewriting already in progress\r\n"));
7163 if (rewriteAppendOnlyFileBackground() == REDIS_OK
) {
7164 char *status
= "+Background append only file rewriting started\r\n";
7165 addReplySds(c
,sdsnew(status
));
7167 addReply(c
,shared
.err
);
7171 static void aofRemoveTempFile(pid_t childpid
) {
7174 snprintf(tmpfile
,256,"temp-rewriteaof-bg-%d.aof", (int) childpid
);
7178 /* Virtual Memory is composed mainly of two subsystems:
7179 * - Blocking Virutal Memory
7180 * - Threaded Virtual Memory I/O
7181 * The two parts are not fully decoupled, but functions are split among two
7182 * different sections of the source code (delimited by comments) in order to
7183 * make more clear what functionality is about the blocking VM and what about
7184 * the threaded (not blocking) VM.
7188 * Redis VM is a blocking VM (one that blocks reading swapped values from
7189 * disk into memory when a value swapped out is needed in memory) that is made
7190 * unblocking by trying to examine the command argument vector in order to
7191 * load in background values that will likely be needed in order to exec
7192 * the command. The command is executed only once all the relevant keys
7193 * are loaded into memory.
7195 * This basically is almost as simple of a blocking VM, but almost as parallel
7196 * as a fully non-blocking VM.
7199 /* =================== Virtual Memory - Blocking Side ====================== */
7201 /* substitute the first occurrence of '%p' with the process pid in the
7202 * swap file name. */
7203 static void expandVmSwapFilename(void) {
7204 char *p
= strstr(server
.vm_swap_file
,"%p");
7210 new = sdscat(new,server
.vm_swap_file
);
7211 new = sdscatprintf(new,"%ld",(long) getpid());
7212 new = sdscat(new,p
+2);
7213 zfree(server
.vm_swap_file
);
7214 server
.vm_swap_file
= new;
7217 static void vmInit(void) {
7222 if (server
.vm_max_threads
!= 0)
7223 zmalloc_enable_thread_safeness(); /* we need thread safe zmalloc() */
7225 expandVmSwapFilename();
7226 redisLog(REDIS_NOTICE
,"Using '%s' as swap file",server
.vm_swap_file
);
7227 if ((server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b")) == NULL
) {
7228 server
.vm_fp
= fopen(server
.vm_swap_file
,"w+b");
7230 if (server
.vm_fp
== NULL
) {
7231 redisLog(REDIS_WARNING
,
7232 "Impossible to open the swap file: %s. Exiting.",
7236 server
.vm_fd
= fileno(server
.vm_fp
);
7237 server
.vm_next_page
= 0;
7238 server
.vm_near_pages
= 0;
7239 server
.vm_stats_used_pages
= 0;
7240 server
.vm_stats_swapped_objects
= 0;
7241 server
.vm_stats_swapouts
= 0;
7242 server
.vm_stats_swapins
= 0;
7243 totsize
= server
.vm_pages
*server
.vm_page_size
;
7244 redisLog(REDIS_NOTICE
,"Allocating %lld bytes of swap file",totsize
);
7245 if (ftruncate(server
.vm_fd
,totsize
) == -1) {
7246 redisLog(REDIS_WARNING
,"Can't ftruncate swap file: %s. Exiting.",
7250 redisLog(REDIS_NOTICE
,"Swap file allocated with success");
7252 server
.vm_bitmap
= zmalloc((server
.vm_pages
+7)/8);
7253 redisLog(REDIS_VERBOSE
,"Allocated %lld bytes page table for %lld pages",
7254 (long long) (server
.vm_pages
+7)/8, server
.vm_pages
);
7255 memset(server
.vm_bitmap
,0,(server
.vm_pages
+7)/8);
7257 /* Initialize threaded I/O (used by Virtual Memory) */
7258 server
.io_newjobs
= listCreate();
7259 server
.io_processing
= listCreate();
7260 server
.io_processed
= listCreate();
7261 server
.io_ready_clients
= listCreate();
7262 pthread_mutex_init(&server
.io_mutex
,NULL
);
7263 pthread_mutex_init(&server
.obj_freelist_mutex
,NULL
);
7264 pthread_mutex_init(&server
.io_swapfile_mutex
,NULL
);
7265 server
.io_active_threads
= 0;
7266 if (pipe(pipefds
) == -1) {
7267 redisLog(REDIS_WARNING
,"Unable to intialized VM: pipe(2): %s. Exiting."
7271 server
.io_ready_pipe_read
= pipefds
[0];
7272 server
.io_ready_pipe_write
= pipefds
[1];
7273 redisAssert(anetNonBlock(NULL
,server
.io_ready_pipe_read
) != ANET_ERR
);
7274 /* LZF requires a lot of stack */
7275 pthread_attr_init(&server
.io_threads_attr
);
7276 pthread_attr_getstacksize(&server
.io_threads_attr
, &stacksize
);
7277 while (stacksize
< REDIS_THREAD_STACK_SIZE
) stacksize
*= 2;
7278 pthread_attr_setstacksize(&server
.io_threads_attr
, stacksize
);
7279 /* Listen for events in the threaded I/O pipe */
7280 if (aeCreateFileEvent(server
.el
, server
.io_ready_pipe_read
, AE_READABLE
,
7281 vmThreadedIOCompletedJob
, NULL
) == AE_ERR
)
7282 oom("creating file event");
7285 /* Mark the page as used */
7286 static void vmMarkPageUsed(off_t page
) {
7287 off_t byte
= page
/8;
7289 redisAssert(vmFreePage(page
) == 1);
7290 server
.vm_bitmap
[byte
] |= 1<<bit
;
7293 /* Mark N contiguous pages as used, with 'page' being the first. */
7294 static void vmMarkPagesUsed(off_t page
, off_t count
) {
7297 for (j
= 0; j
< count
; j
++)
7298 vmMarkPageUsed(page
+j
);
7299 server
.vm_stats_used_pages
+= count
;
7300 redisLog(REDIS_DEBUG
,"Mark USED pages: %lld pages at %lld\n",
7301 (long long)count
, (long long)page
);
7304 /* Mark the page as free */
7305 static void vmMarkPageFree(off_t page
) {
7306 off_t byte
= page
/8;
7308 redisAssert(vmFreePage(page
) == 0);
7309 server
.vm_bitmap
[byte
] &= ~(1<<bit
);
7312 /* Mark N contiguous pages as free, with 'page' being the first. */
7313 static void vmMarkPagesFree(off_t page
, off_t count
) {
7316 for (j
= 0; j
< count
; j
++)
7317 vmMarkPageFree(page
+j
);
7318 server
.vm_stats_used_pages
-= count
;
7319 redisLog(REDIS_DEBUG
,"Mark FREE pages: %lld pages at %lld\n",
7320 (long long)count
, (long long)page
);
7323 /* Test if the page is free */
7324 static int vmFreePage(off_t page
) {
7325 off_t byte
= page
/8;
7327 return (server
.vm_bitmap
[byte
] & (1<<bit
)) == 0;
7330 /* Find N contiguous free pages storing the first page of the cluster in *first.
7331 * Returns REDIS_OK if it was able to find N contiguous pages, otherwise
7332 * REDIS_ERR is returned.
7334 * This function uses a simple algorithm: we try to allocate
7335 * REDIS_VM_MAX_NEAR_PAGES sequentially, when we reach this limit we start
7336 * again from the start of the swap file searching for free spaces.
7338 * If it looks pretty clear that there are no free pages near our offset
7339 * we try to find less populated places doing a forward jump of
7340 * REDIS_VM_MAX_RANDOM_JUMP, then we start scanning again a few pages
7341 * without hurry, and then we jump again and so forth...
7343 * This function can be improved using a free list to avoid to guess
7344 * too much, since we could collect data about freed pages.
7346 * note: I implemented this function just after watching an episode of
7347 * Battlestar Galactica, where the hybrid was continuing to say "JUMP!"
7349 static int vmFindContiguousPages(off_t
*first
, off_t n
) {
7350 off_t base
, offset
= 0, since_jump
= 0, numfree
= 0;
7352 if (server
.vm_near_pages
== REDIS_VM_MAX_NEAR_PAGES
) {
7353 server
.vm_near_pages
= 0;
7354 server
.vm_next_page
= 0;
7356 server
.vm_near_pages
++; /* Yet another try for pages near to the old ones */
7357 base
= server
.vm_next_page
;
7359 while(offset
< server
.vm_pages
) {
7360 off_t
this = base
+offset
;
7362 /* If we overflow, restart from page zero */
7363 if (this >= server
.vm_pages
) {
7364 this -= server
.vm_pages
;
7366 /* Just overflowed, what we found on tail is no longer
7367 * interesting, as it's no longer contiguous. */
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;
7378 redisLog(REDIS_DEBUG
, "FOUND CONTIGUOUS PAGES: %lld pages at %lld\n", (long long) n
, (long long) *first
);
7382 /* The current one is not a free page */
7386 /* Fast-forward if the current page is not free and we already
7387 * searched enough near this place. */
7389 if (!numfree
&& since_jump
>= REDIS_VM_MAX_RANDOM_JUMP
/4) {
7390 offset
+= random() % REDIS_VM_MAX_RANDOM_JUMP
;
7392 /* Note that even if we rewind after the jump, we are don't need
7393 * to make sure numfree is set to zero as we only jump *if* it
7394 * is set to zero. */
7396 /* Otherwise just check the next page */
7403 /* Write the specified object at the specified page of the swap file */
7404 static int vmWriteObjectOnSwap(robj
*o
, off_t page
) {
7405 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
7406 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
7407 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
7408 redisLog(REDIS_WARNING
,
7409 "Critical VM problem in vmSwapObjectBlocking(): can't seek: %s",
7413 rdbSaveObject(server
.vm_fp
,o
);
7414 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
7418 /* Swap the 'val' object relative to 'key' into disk. Store all the information
7419 * needed to later retrieve the object into the key object.
7420 * If we can't find enough contiguous empty pages to swap the object on disk
7421 * REDIS_ERR is returned. */
7422 static int vmSwapObjectBlocking(robj
*key
, robj
*val
) {
7423 off_t pages
= rdbSavedObjectPages(val
,NULL
);
7426 assert(key
->storage
== REDIS_VM_MEMORY
);
7427 assert(key
->refcount
== 1);
7428 if (vmFindContiguousPages(&page
,pages
) == REDIS_ERR
) return REDIS_ERR
;
7429 if (vmWriteObjectOnSwap(val
,page
) == REDIS_ERR
) return REDIS_ERR
;
7430 key
->vm
.page
= page
;
7431 key
->vm
.usedpages
= pages
;
7432 key
->storage
= REDIS_VM_SWAPPED
;
7433 key
->vtype
= val
->type
;
7434 decrRefCount(val
); /* Deallocate the object from memory. */
7435 vmMarkPagesUsed(page
,pages
);
7436 redisLog(REDIS_DEBUG
,"VM: object %s swapped out at %lld (%lld pages)",
7437 (unsigned char*) key
->ptr
,
7438 (unsigned long long) page
, (unsigned long long) pages
);
7439 server
.vm_stats_swapped_objects
++;
7440 server
.vm_stats_swapouts
++;
7441 fflush(server
.vm_fp
);
7445 static robj
*vmReadObjectFromSwap(off_t page
, int type
) {
7448 if (server
.vm_enabled
) pthread_mutex_lock(&server
.io_swapfile_mutex
);
7449 if (fseeko(server
.vm_fp
,page
*server
.vm_page_size
,SEEK_SET
) == -1) {
7450 redisLog(REDIS_WARNING
,
7451 "Unrecoverable VM problem in vmReadObjectFromSwap(): can't seek: %s",
7455 o
= rdbLoadObject(type
,server
.vm_fp
);
7457 redisLog(REDIS_WARNING
, "Unrecoverable VM problem in vmReadObjectFromSwap(): can't load object from swap file: %s", strerror(errno
));
7460 if (server
.vm_enabled
) pthread_mutex_unlock(&server
.io_swapfile_mutex
);
7464 /* Load the value object relative to the 'key' object from swap to memory.
7465 * The newly allocated object is returned.
7467 * If preview is true the unserialized object is returned to the caller but
7468 * no changes are made to the key object, nor the pages are marked as freed */
7469 static robj
*vmGenericLoadObject(robj
*key
, int preview
) {
7472 redisAssert(key
->storage
== REDIS_VM_SWAPPED
|| key
->storage
== REDIS_VM_LOADING
);
7473 val
= vmReadObjectFromSwap(key
->vm
.page
,key
->vtype
);
7475 key
->storage
= REDIS_VM_MEMORY
;
7476 key
->vm
.atime
= server
.unixtime
;
7477 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
7478 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk",
7479 (unsigned char*) key
->ptr
);
7480 server
.vm_stats_swapped_objects
--;
7482 redisLog(REDIS_DEBUG
, "VM: object %s previewed from disk",
7483 (unsigned char*) key
->ptr
);
7485 server
.vm_stats_swapins
++;
7489 /* Plain object loading, from swap to memory */
7490 static robj
*vmLoadObject(robj
*key
) {
7491 /* If we are loading the object in background, stop it, we
7492 * need to load this object synchronously ASAP. */
7493 if (key
->storage
== REDIS_VM_LOADING
)
7494 vmCancelThreadedIOJob(key
);
7495 return vmGenericLoadObject(key
,0);
7498 /* Just load the value on disk, without to modify the key.
7499 * This is useful when we want to perform some operation on the value
7500 * without to really bring it from swap to memory, like while saving the
7501 * dataset or rewriting the append only log. */
7502 static robj
*vmPreviewObject(robj
*key
) {
7503 return vmGenericLoadObject(key
,1);
7506 /* How a good candidate is this object for swapping?
7507 * The better candidate it is, the greater the returned value.
7509 * Currently we try to perform a fast estimation of the object size in
7510 * memory, and combine it with aging informations.
7512 * Basically swappability = idle-time * log(estimated size)
7514 * Bigger objects are preferred over smaller objects, but not
7515 * proportionally, this is why we use the logarithm. This algorithm is
7516 * just a first try and will probably be tuned later. */
7517 static double computeObjectSwappability(robj
*o
) {
7518 time_t age
= server
.unixtime
- o
->vm
.atime
;
7522 struct dictEntry
*de
;
7525 if (age
<= 0) return 0;
7528 if (o
->encoding
!= REDIS_ENCODING_RAW
) {
7531 asize
= sdslen(o
->ptr
)+sizeof(*o
)+sizeof(long)*2;
7536 listNode
*ln
= listFirst(l
);
7538 asize
= sizeof(list
);
7540 robj
*ele
= ln
->value
;
7543 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
7544 (sizeof(*o
)+sdslen(ele
->ptr
)) :
7546 asize
+= (sizeof(listNode
)+elesize
)*listLength(l
);
7551 z
= (o
->type
== REDIS_ZSET
);
7552 d
= z
? ((zset
*)o
->ptr
)->dict
: o
->ptr
;
7554 asize
= sizeof(dict
)+(sizeof(struct dictEntry
*)*dictSlots(d
));
7555 if (z
) asize
+= sizeof(zset
)-sizeof(dict
);
7560 de
= dictGetRandomKey(d
);
7561 ele
= dictGetEntryKey(de
);
7562 elesize
= (ele
->encoding
== REDIS_ENCODING_RAW
) ?
7563 (sizeof(*o
)+sdslen(ele
->ptr
)) :
7565 asize
+= (sizeof(struct dictEntry
)+elesize
)*dictSize(d
);
7566 if (z
) asize
+= sizeof(zskiplistNode
)*dictSize(d
);
7570 return (double)asize
*log(1+asize
);
7573 /* Try to swap an object that's a good candidate for swapping.
7574 * Returns REDIS_OK if the object was swapped, REDIS_ERR if it's not possible
7575 * to swap any object at all.
7577 * If 'usethreaded' is true, Redis will try to swap the object in background
7578 * using I/O threads. */
7579 static int vmSwapOneObject(int usethreads
) {
7581 struct dictEntry
*best
= NULL
;
7582 double best_swappability
= 0;
7583 redisDb
*best_db
= NULL
;
7586 for (j
= 0; j
< server
.dbnum
; j
++) {
7587 redisDb
*db
= server
.db
+j
;
7588 /* Why maxtries is set to 100?
7589 * Because this way (usually) we'll find 1 object even if just 1% - 2%
7590 * are swappable objects */
7593 if (dictSize(db
->dict
) == 0) continue;
7594 for (i
= 0; i
< 5; i
++) {
7596 double swappability
;
7598 if (maxtries
) maxtries
--;
7599 de
= dictGetRandomKey(db
->dict
);
7600 key
= dictGetEntryKey(de
);
7601 val
= dictGetEntryVal(de
);
7602 /* Only swap objects that are currently in memory.
7604 * Also don't swap shared objects if threaded VM is on, as we
7605 * try to ensure that the main thread does not touch the
7606 * object while the I/O thread is using it, but we can't
7607 * control other keys without adding additional mutex. */
7608 if (key
->storage
!= REDIS_VM_MEMORY
||
7609 (server
.vm_max_threads
!= 0 && val
->refcount
!= 1)) {
7610 if (maxtries
) i
--; /* don't count this try */
7613 swappability
= computeObjectSwappability(val
);
7614 if (!best
|| swappability
> best_swappability
) {
7616 best_swappability
= swappability
;
7621 if (best
== NULL
) return REDIS_ERR
;
7622 key
= dictGetEntryKey(best
);
7623 val
= dictGetEntryVal(best
);
7625 redisLog(REDIS_DEBUG
,"Key with best swappability: %s, %f",
7626 key
->ptr
, best_swappability
);
7628 /* Unshare the key if needed */
7629 if (key
->refcount
> 1) {
7630 robj
*newkey
= dupStringObject(key
);
7632 key
= dictGetEntryKey(best
) = newkey
;
7636 vmSwapObjectThreaded(key
,val
,best_db
);
7639 if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
7640 dictGetEntryVal(best
) = NULL
;
7648 static int vmSwapOneObjectBlocking() {
7649 return vmSwapOneObject(0);
7652 static int vmSwapOneObjectThreaded() {
7653 return vmSwapOneObject(1);
7656 /* Return true if it's safe to swap out objects in a given moment.
7657 * Basically we don't want to swap objects out while there is a BGSAVE
7658 * or a BGAEOREWRITE running in backgroud. */
7659 static int vmCanSwapOut(void) {
7660 return (server
.bgsavechildpid
== -1 && server
.bgrewritechildpid
== -1);
7663 /* Delete a key if swapped. Returns 1 if the key was found, was swapped
7664 * and was deleted. Otherwise 0 is returned. */
7665 static int deleteIfSwapped(redisDb
*db
, robj
*key
) {
7669 if ((de
= dictFind(db
->dict
,key
)) == NULL
) return 0;
7670 foundkey
= dictGetEntryKey(de
);
7671 if (foundkey
->storage
== REDIS_VM_MEMORY
) return 0;
7676 /* =================== Virtual Memory - Threaded I/O ======================= */
7678 static void freeIOJob(iojob
*j
) {
7679 if ((j
->type
== REDIS_IOJOB_PREPARE_SWAP
||
7680 j
->type
== REDIS_IOJOB_DO_SWAP
||
7681 j
->type
== REDIS_IOJOB_LOAD
) && j
->val
!= NULL
)
7682 decrRefCount(j
->val
);
7683 decrRefCount(j
->key
);
7687 /* Every time a thread finished a Job, it writes a byte into the write side
7688 * of an unix pipe in order to "awake" the main thread, and this function
7690 static void vmThreadedIOCompletedJob(aeEventLoop
*el
, int fd
, void *privdata
,
7694 int retval
, processed
= 0, toprocess
= -1, trytoswap
= 1;
7696 REDIS_NOTUSED(mask
);
7697 REDIS_NOTUSED(privdata
);
7699 /* For every byte we read in the read side of the pipe, there is one
7700 * I/O job completed to process. */
7701 while((retval
= read(fd
,buf
,1)) == 1) {
7705 struct dictEntry
*de
;
7707 redisLog(REDIS_DEBUG
,"Processing I/O completed job");
7709 /* Get the processed element (the oldest one) */
7711 assert(listLength(server
.io_processed
) != 0);
7712 if (toprocess
== -1) {
7713 toprocess
= (listLength(server
.io_processed
)*REDIS_MAX_COMPLETED_JOBS_PROCESSED
)/100;
7714 if (toprocess
<= 0) toprocess
= 1;
7716 ln
= listFirst(server
.io_processed
);
7718 listDelNode(server
.io_processed
,ln
);
7720 /* If this job is marked as canceled, just ignore it */
7725 /* Post process it in the main thread, as there are things we
7726 * can do just here to avoid race conditions and/or invasive locks */
7727 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
);
7728 de
= dictFind(j
->db
->dict
,j
->key
);
7730 key
= dictGetEntryKey(de
);
7731 if (j
->type
== REDIS_IOJOB_LOAD
) {
7734 /* Key loaded, bring it at home */
7735 key
->storage
= REDIS_VM_MEMORY
;
7736 key
->vm
.atime
= server
.unixtime
;
7737 vmMarkPagesFree(key
->vm
.page
,key
->vm
.usedpages
);
7738 redisLog(REDIS_DEBUG
, "VM: object %s loaded from disk (threaded)",
7739 (unsigned char*) key
->ptr
);
7740 server
.vm_stats_swapped_objects
--;
7741 server
.vm_stats_swapins
++;
7742 dictGetEntryVal(de
) = j
->val
;
7743 incrRefCount(j
->val
);
7746 /* Handle clients waiting for this key to be loaded. */
7747 handleClientsBlockedOnSwappedKey(db
,key
);
7748 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
7749 /* Now we know the amount of pages required to swap this object.
7750 * Let's find some space for it, and queue this task again
7751 * rebranded as REDIS_IOJOB_DO_SWAP. */
7752 if (!vmCanSwapOut() ||
7753 vmFindContiguousPages(&j
->page
,j
->pages
) == REDIS_ERR
)
7755 /* Ooops... no space or we can't swap as there is
7756 * a fork()ed Redis trying to save stuff on disk. */
7758 key
->storage
= REDIS_VM_MEMORY
; /* undo operation */
7760 /* Note that we need to mark this pages as used now,
7761 * if the job will be canceled, we'll mark them as freed
7763 vmMarkPagesUsed(j
->page
,j
->pages
);
7764 j
->type
= REDIS_IOJOB_DO_SWAP
;
7769 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
7772 /* Key swapped. We can finally free some memory. */
7773 if (key
->storage
!= REDIS_VM_SWAPPING
) {
7774 printf("key->storage: %d\n",key
->storage
);
7775 printf("key->name: %s\n",(char*)key
->ptr
);
7776 printf("key->refcount: %d\n",key
->refcount
);
7777 printf("val: %p\n",(void*)j
->val
);
7778 printf("val->type: %d\n",j
->val
->type
);
7779 printf("val->ptr: %s\n",(char*)j
->val
->ptr
);
7781 redisAssert(key
->storage
== REDIS_VM_SWAPPING
);
7782 val
= dictGetEntryVal(de
);
7783 key
->vm
.page
= j
->page
;
7784 key
->vm
.usedpages
= j
->pages
;
7785 key
->storage
= REDIS_VM_SWAPPED
;
7786 key
->vtype
= j
->val
->type
;
7787 decrRefCount(val
); /* Deallocate the object from memory. */
7788 dictGetEntryVal(de
) = NULL
;
7789 redisLog(REDIS_DEBUG
,
7790 "VM: object %s swapped out at %lld (%lld pages) (threaded)",
7791 (unsigned char*) key
->ptr
,
7792 (unsigned long long) j
->page
, (unsigned long long) j
->pages
);
7793 server
.vm_stats_swapped_objects
++;
7794 server
.vm_stats_swapouts
++;
7796 /* Put a few more swap requests in queue if we are still
7798 if (trytoswap
&& vmCanSwapOut() &&
7799 zmalloc_used_memory() > server
.vm_max_memory
)
7804 more
= listLength(server
.io_newjobs
) <
7805 (unsigned) server
.vm_max_threads
;
7807 /* Don't waste CPU time if swappable objects are rare. */
7808 if (vmSwapOneObjectThreaded() == REDIS_ERR
) {
7816 if (processed
== toprocess
) return;
7818 if (retval
< 0 && errno
!= EAGAIN
) {
7819 redisLog(REDIS_WARNING
,
7820 "WARNING: read(2) error in vmThreadedIOCompletedJob() %s",
7825 static void lockThreadedIO(void) {
7826 pthread_mutex_lock(&server
.io_mutex
);
7829 static void unlockThreadedIO(void) {
7830 pthread_mutex_unlock(&server
.io_mutex
);
7833 /* Remove the specified object from the threaded I/O queue if still not
7834 * processed, otherwise make sure to flag it as canceled. */
7835 static void vmCancelThreadedIOJob(robj
*o
) {
7837 server
.io_newjobs
, /* 0 */
7838 server
.io_processing
, /* 1 */
7839 server
.io_processed
/* 2 */
7843 assert(o
->storage
== REDIS_VM_LOADING
|| o
->storage
== REDIS_VM_SWAPPING
);
7846 /* Search for a matching key in one of the queues */
7847 for (i
= 0; i
< 3; i
++) {
7851 listRewind(lists
[i
],&li
);
7852 while ((ln
= listNext(&li
)) != NULL
) {
7853 iojob
*job
= ln
->value
;
7855 if (job
->canceled
) continue; /* Skip this, already canceled. */
7856 if (compareStringObjects(job
->key
,o
) == 0) {
7857 redisLog(REDIS_DEBUG
,"*** CANCELED %p (%s) (type %d) (LIST ID %d)\n",
7858 (void*)job
, (char*)o
->ptr
, job
->type
, i
);
7859 /* Mark the pages as free since the swap didn't happened
7860 * or happened but is now discarded. */
7861 if (i
!= 1 && job
->type
== REDIS_IOJOB_DO_SWAP
)
7862 vmMarkPagesFree(job
->page
,job
->pages
);
7863 /* Cancel the job. It depends on the list the job is
7866 case 0: /* io_newjobs */
7867 /* If the job was yet not processed the best thing to do
7868 * is to remove it from the queue at all */
7870 listDelNode(lists
[i
],ln
);
7872 case 1: /* io_processing */
7873 /* Oh Shi- the thread is messing with the Job:
7875 * Probably it's accessing the object if this is a
7876 * PREPARE_SWAP or DO_SWAP job.
7877 * If it's a LOAD job it may be reading from disk and
7878 * if we don't wait for the job to terminate before to
7879 * cancel it, maybe in a few microseconds data can be
7880 * corrupted in this pages. So the short story is:
7882 * Better to wait for the job to move into the
7883 * next queue (processed)... */
7885 /* We try again and again until the job is completed. */
7887 /* But let's wait some time for the I/O thread
7888 * to finish with this job. After all this condition
7889 * should be very rare. */
7892 case 2: /* io_processed */
7893 /* The job was already processed, that's easy...
7894 * just mark it as canceled so that we'll ignore it
7895 * when processing completed jobs. */
7899 /* Finally we have to adjust the storage type of the object
7900 * in order to "UNDO" the operaiton. */
7901 if (o
->storage
== REDIS_VM_LOADING
)
7902 o
->storage
= REDIS_VM_SWAPPED
;
7903 else if (o
->storage
== REDIS_VM_SWAPPING
)
7904 o
->storage
= REDIS_VM_MEMORY
;
7911 assert(1 != 1); /* We should never reach this */
7914 static void *IOThreadEntryPoint(void *arg
) {
7919 pthread_detach(pthread_self());
7921 /* Get a new job to process */
7923 if (listLength(server
.io_newjobs
) == 0) {
7924 /* No new jobs in queue, exit. */
7925 redisLog(REDIS_DEBUG
,"Thread %lld exiting, nothing to do",
7926 (long long) pthread_self());
7927 server
.io_active_threads
--;
7931 ln
= listFirst(server
.io_newjobs
);
7933 listDelNode(server
.io_newjobs
,ln
);
7934 /* Add the job in the processing queue */
7935 j
->thread
= pthread_self();
7936 listAddNodeTail(server
.io_processing
,j
);
7937 ln
= listLast(server
.io_processing
); /* We use ln later to remove it */
7939 redisLog(REDIS_DEBUG
,"Thread %lld got a new job (type %d): %p about key '%s'",
7940 (long long) pthread_self(), j
->type
, (void*)j
, (char*)j
->key
->ptr
);
7942 /* Process the Job */
7943 if (j
->type
== REDIS_IOJOB_LOAD
) {
7944 j
->val
= vmReadObjectFromSwap(j
->page
,j
->key
->vtype
);
7945 } else if (j
->type
== REDIS_IOJOB_PREPARE_SWAP
) {
7946 FILE *fp
= fopen("/dev/null","w+");
7947 j
->pages
= rdbSavedObjectPages(j
->val
,fp
);
7949 } else if (j
->type
== REDIS_IOJOB_DO_SWAP
) {
7950 if (vmWriteObjectOnSwap(j
->val
,j
->page
) == REDIS_ERR
)
7954 /* Done: insert the job into the processed queue */
7955 redisLog(REDIS_DEBUG
,"Thread %lld completed the job: %p (key %s)",
7956 (long long) pthread_self(), (void*)j
, (char*)j
->key
->ptr
);
7958 listDelNode(server
.io_processing
,ln
);
7959 listAddNodeTail(server
.io_processed
,j
);
7962 /* Signal the main thread there is new stuff to process */
7963 assert(write(server
.io_ready_pipe_write
,"x",1) == 1);
7965 return NULL
; /* never reached */
7968 static void spawnIOThread(void) {
7970 sigset_t mask
, omask
;
7973 sigaddset(&mask
,SIGCHLD
);
7974 sigaddset(&mask
,SIGHUP
);
7975 sigaddset(&mask
,SIGPIPE
);
7976 pthread_sigmask(SIG_SETMASK
, &mask
, &omask
);
7977 pthread_create(&thread
,&server
.io_threads_attr
,IOThreadEntryPoint
,NULL
);
7978 pthread_sigmask(SIG_SETMASK
, &omask
, NULL
);
7979 server
.io_active_threads
++;
7982 /* We need to wait for the last thread to exit before we are able to
7983 * fork() in order to BGSAVE or BGREWRITEAOF. */
7984 static void waitEmptyIOJobsQueue(void) {
7986 int io_processed_len
;
7989 if (listLength(server
.io_newjobs
) == 0 &&
7990 listLength(server
.io_processing
) == 0 &&
7991 server
.io_active_threads
== 0)
7996 /* While waiting for empty jobs queue condition we post-process some
7997 * finshed job, as I/O threads may be hanging trying to write against
7998 * the io_ready_pipe_write FD but there are so much pending jobs that
8000 io_processed_len
= listLength(server
.io_processed
);
8002 if (io_processed_len
) {
8003 vmThreadedIOCompletedJob(NULL
,server
.io_ready_pipe_read
,NULL
,0);
8004 usleep(1000); /* 1 millisecond */
8006 usleep(10000); /* 10 milliseconds */
8011 static void vmReopenSwapFile(void) {
8012 /* Note: we don't close the old one as we are in the child process
8013 * and don't want to mess at all with the original file object. */
8014 server
.vm_fp
= fopen(server
.vm_swap_file
,"r+b");
8015 if (server
.vm_fp
== NULL
) {
8016 redisLog(REDIS_WARNING
,"Can't re-open the VM swap file: %s. Exiting.",
8017 server
.vm_swap_file
);
8020 server
.vm_fd
= fileno(server
.vm_fp
);
8023 /* This function must be called while with threaded IO locked */
8024 static void queueIOJob(iojob
*j
) {
8025 redisLog(REDIS_DEBUG
,"Queued IO Job %p type %d about key '%s'\n",
8026 (void*)j
, j
->type
, (char*)j
->key
->ptr
);
8027 listAddNodeTail(server
.io_newjobs
,j
);
8028 if (server
.io_active_threads
< server
.vm_max_threads
)
8032 static int vmSwapObjectThreaded(robj
*key
, robj
*val
, redisDb
*db
) {
8035 assert(key
->storage
== REDIS_VM_MEMORY
);
8036 assert(key
->refcount
== 1);
8038 j
= zmalloc(sizeof(*j
));
8039 j
->type
= REDIS_IOJOB_PREPARE_SWAP
;
8041 j
->key
= dupStringObject(key
);
8045 j
->thread
= (pthread_t
) -1;
8046 key
->storage
= REDIS_VM_SWAPPING
;
8054 /* ============ Virtual Memory - Blocking clients on missing keys =========== */
8056 /* This function makes the clinet 'c' waiting for the key 'key' to be loaded.
8057 * If there is not already a job loading the key, it is craeted.
8058 * The key is added to the io_keys list in the client structure, and also
8059 * in the hash table mapping swapped keys to waiting clients, that is,
8060 * server.io_waited_keys. */
8061 static int waitForSwappedKey(redisClient
*c
, robj
*key
) {
8062 struct dictEntry
*de
;
8066 /* If the key does not exist or is already in RAM we don't need to
8067 * block the client at all. */
8068 de
= dictFind(c
->db
->dict
,key
);
8069 if (de
== NULL
) return 0;
8070 o
= dictGetEntryKey(de
);
8071 if (o
->storage
== REDIS_VM_MEMORY
) {
8073 } else if (o
->storage
== REDIS_VM_SWAPPING
) {
8074 /* We were swapping the key, undo it! */
8075 vmCancelThreadedIOJob(o
);
8079 /* OK: the key is either swapped, or being loaded just now. */
8081 /* Add the key to the list of keys this client is waiting for.
8082 * This maps clients to keys they are waiting for. */
8083 listAddNodeTail(c
->io_keys
,key
);
8086 /* Add the client to the swapped keys => clients waiting map. */
8087 de
= dictFind(c
->db
->io_keys
,key
);
8091 /* For every key we take a list of clients blocked for it */
8093 retval
= dictAdd(c
->db
->io_keys
,key
,l
);
8095 assert(retval
== DICT_OK
);
8097 l
= dictGetEntryVal(de
);
8099 listAddNodeTail(l
,c
);
8101 /* Are we already loading the key from disk? If not create a job */
8102 if (o
->storage
== REDIS_VM_SWAPPED
) {
8105 o
->storage
= REDIS_VM_LOADING
;
8106 j
= zmalloc(sizeof(*j
));
8107 j
->type
= REDIS_IOJOB_LOAD
;
8109 j
->key
= dupStringObject(key
);
8110 j
->key
->vtype
= o
->vtype
;
8111 j
->page
= o
->vm
.page
;
8114 j
->thread
= (pthread_t
) -1;
8122 /* Is this client attempting to run a command against swapped keys?
8123 * If so, block it ASAP, load the keys in background, then resume it.
8125 * The important idea about this function is that it can fail! If keys will
8126 * still be swapped when the client is resumed, this key lookups will
8127 * just block loading keys from disk. In practical terms this should only
8128 * happen with SORT BY command or if there is a bug in this function.
8130 * Return 1 if the client is marked as blocked, 0 if the client can
8131 * continue as the keys it is going to access appear to be in memory. */
8132 static int blockClientOnSwappedKeys(struct redisCommand
*cmd
, redisClient
*c
) {
8135 if (cmd
->vm_firstkey
== 0) return 0;
8136 last
= cmd
->vm_lastkey
;
8137 if (last
< 0) last
= c
->argc
+last
;
8138 for (j
= cmd
->vm_firstkey
; j
<= last
; j
+= cmd
->vm_keystep
)
8139 waitForSwappedKey(c
,c
->argv
[j
]);
8140 /* If the client was blocked for at least one key, mark it as blocked. */
8141 if (listLength(c
->io_keys
)) {
8142 c
->flags
|= REDIS_IO_WAIT
;
8143 aeDeleteFileEvent(server
.el
,c
->fd
,AE_READABLE
);
8144 server
.vm_blocked_clients
++;
8151 /* Remove the 'key' from the list of blocked keys for a given client.
8153 * The function returns 1 when there are no longer blocking keys after
8154 * the current one was removed (and the client can be unblocked). */
8155 static int dontWaitForSwappedKey(redisClient
*c
, robj
*key
) {
8159 struct dictEntry
*de
;
8161 /* Remove the key from the list of keys this client is waiting for. */
8162 listRewind(c
->io_keys
,&li
);
8163 while ((ln
= listNext(&li
)) != NULL
) {
8164 if (compareStringObjects(ln
->value
,key
) == 0) {
8165 listDelNode(c
->io_keys
,ln
);
8171 /* Remove the client form the key => waiting clients map. */
8172 de
= dictFind(c
->db
->io_keys
,key
);
8174 l
= dictGetEntryVal(de
);
8175 ln
= listSearchKey(l
,c
);
8178 if (listLength(l
) == 0)
8179 dictDelete(c
->db
->io_keys
,key
);
8181 return listLength(c
->io_keys
) == 0;
8184 static void handleClientsBlockedOnSwappedKey(redisDb
*db
, robj
*key
) {
8185 struct dictEntry
*de
;
8190 de
= dictFind(db
->io_keys
,key
);
8193 l
= dictGetEntryVal(de
);
8194 len
= listLength(l
);
8195 /* Note: we can't use something like while(listLength(l)) as the list
8196 * can be freed by the calling function when we remove the last element. */
8199 redisClient
*c
= ln
->value
;
8201 if (dontWaitForSwappedKey(c
,key
)) {
8202 /* Put the client in the list of clients ready to go as we
8203 * loaded all the keys about it. */
8204 listAddNodeTail(server
.io_ready_clients
,c
);
8209 /* ================================= Debugging ============================== */
8211 static void debugCommand(redisClient
*c
) {
8212 if (!strcasecmp(c
->argv
[1]->ptr
,"segfault")) {
8214 } else if (!strcasecmp(c
->argv
[1]->ptr
,"reload")) {
8215 if (rdbSave(server
.dbfilename
) != REDIS_OK
) {
8216 addReply(c
,shared
.err
);
8220 if (rdbLoad(server
.dbfilename
) != REDIS_OK
) {
8221 addReply(c
,shared
.err
);
8224 redisLog(REDIS_WARNING
,"DB reloaded by DEBUG RELOAD");
8225 addReply(c
,shared
.ok
);
8226 } else if (!strcasecmp(c
->argv
[1]->ptr
,"loadaof")) {
8228 if (loadAppendOnlyFile(server
.appendfilename
) != REDIS_OK
) {
8229 addReply(c
,shared
.err
);
8232 redisLog(REDIS_WARNING
,"Append Only File loaded by DEBUG LOADAOF");
8233 addReply(c
,shared
.ok
);
8234 } else if (!strcasecmp(c
->argv
[1]->ptr
,"object") && c
->argc
== 3) {
8235 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
8239 addReply(c
,shared
.nokeyerr
);
8242 key
= dictGetEntryKey(de
);
8243 val
= dictGetEntryVal(de
);
8244 if (!server
.vm_enabled
|| (key
->storage
== REDIS_VM_MEMORY
||
8245 key
->storage
== REDIS_VM_SWAPPING
)) {
8246 addReplySds(c
,sdscatprintf(sdsempty(),
8247 "+Key at:%p refcount:%d, value at:%p refcount:%d "
8248 "encoding:%d serializedlength:%lld\r\n",
8249 (void*)key
, key
->refcount
, (void*)val
, val
->refcount
,
8250 val
->encoding
, (long long) rdbSavedObjectLen(val
,NULL
)));
8252 addReplySds(c
,sdscatprintf(sdsempty(),
8253 "+Key at:%p refcount:%d, value swapped at: page %llu "
8254 "using %llu pages\r\n",
8255 (void*)key
, key
->refcount
, (unsigned long long) key
->vm
.page
,
8256 (unsigned long long) key
->vm
.usedpages
));
8258 } else if (!strcasecmp(c
->argv
[1]->ptr
,"swapout") && c
->argc
== 3) {
8259 dictEntry
*de
= dictFind(c
->db
->dict
,c
->argv
[2]);
8262 if (!server
.vm_enabled
) {
8263 addReplySds(c
,sdsnew("-ERR Virtual Memory is disabled\r\n"));
8267 addReply(c
,shared
.nokeyerr
);
8270 key
= dictGetEntryKey(de
);
8271 val
= dictGetEntryVal(de
);
8272 /* If the key is shared we want to create a copy */
8273 if (key
->refcount
> 1) {
8274 robj
*newkey
= dupStringObject(key
);
8276 key
= dictGetEntryKey(de
) = newkey
;
8279 if (key
->storage
!= REDIS_VM_MEMORY
) {
8280 addReplySds(c
,sdsnew("-ERR This key is not in memory\r\n"));
8281 } else if (vmSwapObjectBlocking(key
,val
) == REDIS_OK
) {
8282 dictGetEntryVal(de
) = NULL
;
8283 addReply(c
,shared
.ok
);
8285 addReply(c
,shared
.err
);
8288 addReplySds(c
,sdsnew(
8289 "-ERR Syntax error, try DEBUG [SEGFAULT|OBJECT <key>|SWAPOUT <key>|RELOAD]\r\n"));
8293 static void _redisAssert(char *estr
, char *file
, int line
) {
8294 redisLog(REDIS_WARNING
,"=== ASSERTION FAILED ===");
8295 redisLog(REDIS_WARNING
,"==> %s:%d '%s' is not true\n",file
,line
,estr
);
8296 #ifdef HAVE_BACKTRACE
8297 redisLog(REDIS_WARNING
,"(forcing SIGSEGV in order to print the stack trace)");
8302 /* =================================== Main! ================================ */
8305 int linuxOvercommitMemoryValue(void) {
8306 FILE *fp
= fopen("/proc/sys/vm/overcommit_memory","r");
8310 if (fgets(buf
,64,fp
) == NULL
) {
8319 void linuxOvercommitMemoryWarning(void) {
8320 if (linuxOvercommitMemoryValue() == 0) {
8321 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.");
8324 #endif /* __linux__ */
8326 static void daemonize(void) {
8330 if (fork() != 0) exit(0); /* parent exits */
8331 setsid(); /* create a new session */
8333 /* Every output goes to /dev/null. If Redis is daemonized but
8334 * the 'logfile' is set to 'stdout' in the configuration file
8335 * it will not log at all. */
8336 if ((fd
= open("/dev/null", O_RDWR
, 0)) != -1) {
8337 dup2(fd
, STDIN_FILENO
);
8338 dup2(fd
, STDOUT_FILENO
);
8339 dup2(fd
, STDERR_FILENO
);
8340 if (fd
> STDERR_FILENO
) close(fd
);
8342 /* Try to write the pid file */
8343 fp
= fopen(server
.pidfile
,"w");
8345 fprintf(fp
,"%d\n",getpid());
8350 int main(int argc
, char **argv
) {
8355 resetServerSaveParams();
8356 loadServerConfig(argv
[1]);
8357 } else if (argc
> 2) {
8358 fprintf(stderr
,"Usage: ./redis-server [/path/to/redis.conf]\n");
8361 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'");
8363 if (server
.daemonize
) daemonize();
8365 redisLog(REDIS_NOTICE
,"Server started, Redis version " REDIS_VERSION
);
8367 linuxOvercommitMemoryWarning();
8370 if (server
.appendonly
) {
8371 if (loadAppendOnlyFile(server
.appendfilename
) == REDIS_OK
)
8372 redisLog(REDIS_NOTICE
,"DB loaded from append only file: %ld seconds",time(NULL
)-start
);
8374 if (rdbLoad(server
.dbfilename
) == REDIS_OK
)
8375 redisLog(REDIS_NOTICE
,"DB loaded from disk: %ld seconds",time(NULL
)-start
);
8377 redisLog(REDIS_NOTICE
,"The server is now ready to accept connections on port %d", server
.port
);
8378 aeSetBeforeSleepProc(server
.el
,beforeSleep
);
8380 aeDeleteEventLoop(server
.el
);
8384 /* ============================= Backtrace support ========================= */
8386 #ifdef HAVE_BACKTRACE
8387 static char *findFuncName(void *pointer
, unsigned long *offset
);
8389 static void *getMcontextEip(ucontext_t
*uc
) {
8390 #if defined(__FreeBSD__)
8391 return (void*) uc
->uc_mcontext
.mc_eip
;
8392 #elif defined(__dietlibc__)
8393 return (void*) uc
->uc_mcontext
.eip
;
8394 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
8396 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
8398 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
8400 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6)
8401 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__)
8402 return (void*) uc
->uc_mcontext
->__ss
.__rip
;
8404 return (void*) uc
->uc_mcontext
->__ss
.__eip
;
8406 #elif defined(__i386__) || defined(__X86_64__) || defined(__x86_64__)
8407 return (void*) uc
->uc_mcontext
.gregs
[REG_EIP
]; /* Linux 32/64 bit */
8408 #elif defined(__ia64__) /* Linux IA64 */
8409 return (void*) uc
->uc_mcontext
.sc_ip
;
8415 static void segvHandler(int sig
, siginfo_t
*info
, void *secret
) {
8417 char **messages
= NULL
;
8418 int i
, trace_size
= 0;
8419 unsigned long offset
=0;
8420 ucontext_t
*uc
= (ucontext_t
*) secret
;
8422 REDIS_NOTUSED(info
);
8424 redisLog(REDIS_WARNING
,
8425 "======= Ooops! Redis %s got signal: -%d- =======", REDIS_VERSION
, sig
);
8426 infostring
= genRedisInfoString();
8427 redisLog(REDIS_WARNING
, "%s",infostring
);
8428 /* It's not safe to sdsfree() the returned string under memory
8429 * corruption conditions. Let it leak as we are going to abort */
8431 trace_size
= backtrace(trace
, 100);
8432 /* overwrite sigaction with caller's address */
8433 if (getMcontextEip(uc
) != NULL
) {
8434 trace
[1] = getMcontextEip(uc
);
8436 messages
= backtrace_symbols(trace
, trace_size
);
8438 for (i
=1; i
<trace_size
; ++i
) {
8439 char *fn
= findFuncName(trace
[i
], &offset
), *p
;
8441 p
= strchr(messages
[i
],'+');
8442 if (!fn
|| (p
&& ((unsigned long)strtol(p
+1,NULL
,10)) < offset
)) {
8443 redisLog(REDIS_WARNING
,"%s", messages
[i
]);
8445 redisLog(REDIS_WARNING
,"%d redis-server %p %s + %d", i
, trace
[i
], fn
, (unsigned int)offset
);
8448 /* free(messages); Don't call free() with possibly corrupted memory. */
8452 static void setupSigSegvAction(void) {
8453 struct sigaction act
;
8455 sigemptyset (&act
.sa_mask
);
8456 /* When the SA_SIGINFO flag is set in sa_flags then sa_sigaction
8457 * is used. Otherwise, sa_handler is used */
8458 act
.sa_flags
= SA_NODEFER
| SA_ONSTACK
| SA_RESETHAND
| SA_SIGINFO
;
8459 act
.sa_sigaction
= segvHandler
;
8460 sigaction (SIGSEGV
, &act
, NULL
);
8461 sigaction (SIGBUS
, &act
, NULL
);
8462 sigaction (SIGFPE
, &act
, NULL
);
8463 sigaction (SIGILL
, &act
, NULL
);
8464 sigaction (SIGBUS
, &act
, NULL
);
8468 #include "staticsymbols.h"
8469 /* This function try to convert a pointer into a function name. It's used in
8470 * oreder to provide a backtrace under segmentation fault that's able to
8471 * display functions declared as static (otherwise the backtrace is useless). */
8472 static char *findFuncName(void *pointer
, unsigned long *offset
){
8474 unsigned long off
, minoff
= 0;
8476 /* Try to match against the Symbol with the smallest offset */
8477 for (i
=0; symsTable
[i
].pointer
; i
++) {
8478 unsigned long lp
= (unsigned long) pointer
;
8480 if (lp
!= (unsigned long)-1 && lp
>= symsTable
[i
].pointer
) {
8481 off
=lp
-symsTable
[i
].pointer
;
8482 if (ret
< 0 || off
< minoff
) {
8488 if (ret
== -1) return NULL
;
8490 return symsTable
[ret
].name
;
8492 #else /* HAVE_BACKTRACE */
8493 static void setupSigSegvAction(void) {
8495 #endif /* HAVE_BACKTRACE */